This is python.info, produced by makeinfo version 6.5 from python.texi.

     Python 3.8.1, December 18, 2019

     unknown

     Copyright © 2001-2019, Python Software Foundation

INFO-DIR-SECTION Miscellaneous
START-INFO-DIR-ENTRY
* python: (python.info). One line description of project
END-INFO-DIR-ENTRY


   Generated by Sphinx 2.0.1.


File: python.info,  Node: Top,  Next: What’s New in Python,  Up: (dir)

Python
******

     Python 3.8.1, December 18, 2019

     unknown

     Copyright © 2001-2019, Python Software Foundation

* Menu:

* What’s New in Python::
* The Python Tutorial::
* Python Setup and Usage::
* The Python Language Reference::
* The Python Standard Library::
* Extending and Embedding the Python Interpreter::
* Python/C API Reference Manual::
* Distributing Python Modules::
* Installing Python Modules::
* Python HOWTOs::
* Python Frequently Asked Questions::
* Glossary::
* About these documents::
* Dealing with Bugs::
* Copyright::
* History and License::
* Distributing Python Modules (Legacy version): Distributing Python Modules Legacy version.
* Installing Python Modules (Legacy version): Installing Python Modules Legacy version.
* Python Module Index::
* Index::

 — The Detailed Node Listing —

What’s New in Python

* What’s New In Python 3.8: What’s New In Python 3 8.
* What’s New In Python 3.7: What’s New In Python 3 7.
* What’s New In Python 3.6: What’s New In Python 3 6.
* What’s New In Python 3.5: What’s New In Python 3 5.
* What’s New In Python 3.4: What’s New In Python 3 4.
* What’s New In Python 3.3: What’s New In Python 3 3.
* What’s New In Python 3.2: What’s New In Python 3 2.
* What’s New In Python 3.1: What’s New In Python 3 1.
* What’s New In Python 3.0: What’s New In Python 3 0.
* What’s New in Python 2.7: What’s New in Python 2 7.
* What’s New in Python 2.6: What’s New in Python 2 6.
* What’s New in Python 2.5: What’s New in Python 2 5.
* What’s New in Python 2.4: What’s New in Python 2 4.
* What’s New in Python 2.3: What’s New in Python 2 3.
* What’s New in Python 2.2: What’s New in Python 2 2.
* What’s New in Python 2.1: What’s New in Python 2 1.
* What’s New in Python 2.0: What’s New in Python 2 0.
* Changelog::

What’s New In Python 3.8

* Summary – Release highlights::
* New Features::
* Other Language Changes::
* New Modules::
* Improved Modules::
* Optimizations::
* Build and C API Changes::
* Deprecated::
* API and Feature Removals::
* Porting to Python 3.8: Porting to Python 3 8.
* Notable changes in Python 3.8.1: Notable changes in Python 3 8 1.

New Features

* Assignment expressions::
* Positional-only parameters::
* Parallel filesystem cache for compiled bytecode files::
* Debug build uses the same ABI as release build::
* f-strings support = for self-documenting expressions and debugging::
* PEP 578; Python Runtime Audit Hooks: PEP 578 Python Runtime Audit Hooks.
* PEP 587; Python Initialization Configuration: PEP 587 Python Initialization Configuration.
* Vectorcall; a fast calling protocol for CPython: Vectorcall a fast calling protocol for CPython.
* Pickle protocol 5 with out-of-band data buffers::

Improved Modules

* ast::
* asyncio::
* builtins::
* collections::
* cProfile::
* csv::
* curses::
* ctypes::
* datetime::
* functools::
* gc::
* gettext::
* gzip::
* IDLE and idlelib::
* inspect::
* io::
* itertools::
* json.tool: json tool.
* logging::
* math::
* mmap::
* multiprocessing::
* os::
* os.path: os path.
* pathlib::
* pickle::
* plistlib::
* pprint::
* py_compile::
* shlex::
* shutil::
* socket::
* ssl::
* statistics::
* sys::
* tarfile::
* threading::
* tokenize::
* tkinter::
* time::
* typing::
* unicodedata::
* unittest::
* venv::
* weakref::
* xml::
* xmlrpc::

Porting to Python 3.8

* Changes in Python behavior::
* Changes in the Python API::
* Changes in the C API::
* CPython bytecode changes::
* Demos and Tools::

What’s New In Python 3.7

* Summary – Release Highlights::
* New Features: New Features<2>.
* Other Language Changes: Other Language Changes<2>.
* New Modules: New Modules<2>.
* Improved Modules: Improved Modules<2>.
* C API Changes::
* Build Changes::
* Optimizations: Optimizations<2>.
* Other CPython Implementation Changes::
* Deprecated Python Behavior::
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods.
* Deprecated functions and types of the C API::
* Platform Support Removals::
* API and Feature Removals: API and Feature Removals<2>.
* Module Removals::
* Windows-only Changes::
* Porting to Python 3.7: Porting to Python 3 7.
* Notable changes in Python 3.7.1: Notable changes in Python 3 7 1.
* Notable changes in Python 3.7.2: Notable changes in Python 3 7 2.
* Notable changes in Python 3.7.6: Notable changes in Python 3 7 6.

New Features

* PEP 563; Postponed Evaluation of Annotations: PEP 563 Postponed Evaluation of Annotations.
* PEP 538; Legacy C Locale Coercion: PEP 538 Legacy C Locale Coercion.
* PEP 540; Forced UTF-8 Runtime Mode: PEP 540 Forced UTF-8 Runtime Mode.
* PEP 553; Built-in breakpoint(): PEP 553 Built-in breakpoint.
* PEP 539; New C API for Thread-Local Storage: PEP 539 New C API for Thread-Local Storage.
* PEP 562; Customization of Access to Module Attributes: PEP 562 Customization of Access to Module Attributes.
* PEP 564; New Time Functions With Nanosecond Resolution: PEP 564 New Time Functions With Nanosecond Resolution.
* PEP 565; Show DeprecationWarning in __main__: PEP 565 Show DeprecationWarning in __main__.
* PEP 560; Core Support for typing module and Generic Types: PEP 560 Core Support for typing module and Generic Types.
* PEP 552; Hash-based .pyc Files: PEP 552 Hash-based pyc Files.
* PEP 545; Python Documentation Translations: PEP 545 Python Documentation Translations.
* Development Runtime Mode; -X dev: Development Runtime Mode -X dev.

New Modules

* contextvars::
* dataclasses::
* importlib.resources: importlib resources.

Improved Modules

* argparse::
* asyncio: asyncio<2>.
* binascii::
* calendar::
* collections: collections<2>.
* compileall::
* concurrent.futures: concurrent futures.
* contextlib::
* cProfile: cProfile<2>.
* crypt::
* datetime: datetime<2>.
* dbm::
* decimal::
* dis::
* distutils::
* enum::
* functools: functools<2>.
* gc: gc<2>.
* hmac::
* http.client: http client.
* http.server: http server.
* idlelib and IDLE::
* importlib::
* io: io<2>.
* ipaddress::
* itertools: itertools<2>.
* locale::
* logging: logging<2>.
* math: math<2>.
* mimetypes::
* msilib::
* multiprocessing: multiprocessing<2>.
* os: os<2>.
* pathlib: pathlib<2>.
* pdb::
* py_compile: py_compile<2>.
* pydoc::
* queue::
* re::
* signal::
* socket: socket<2>.
* socketserver::
* sqlite3::
* ssl: ssl<2>.
* string::
* subprocess::
* sys: sys<2>.
* time: time<2>.
* tkinter: tkinter<2>.
* tracemalloc::
* types::
* unicodedata: unicodedata<2>.
* unittest: unittest<2>.
* unittest.mock: unittest mock.
* urllib.parse: urllib parse.
* uu::
* uuid::
* warnings::
* xml.etree: xml etree.
* xmlrpc.server: xmlrpc server.
* zipapp::
* zipfile::

Deprecated Python modules, functions and methods

* aifc::
* asyncio: asyncio<3>.
* collections: collections<3>.
* dbm: dbm<2>.
* enum: enum<2>.
* gettext: gettext<2>.
* importlib: importlib<2>.
* locale: locale<2>.
* macpath::
* threading: threading<2>.
* socket: socket<3>.
* ssl: ssl<3>.
* sunau::
* sys: sys<3>.
* wave::

Porting to Python 3.7

* Changes in Python Behavior::
* Changes in the Python API: Changes in the Python API<2>.
* Changes in the C API: Changes in the C API<2>.
* CPython bytecode changes: CPython bytecode changes<2>.
* Windows-only Changes: Windows-only Changes<2>.
* Other CPython implementation changes::

What’s New In Python 3.6

* Summary – Release highlights: Summary – Release highlights<2>.
* New Features: New Features<3>.
* Other Language Changes: Other Language Changes<3>.
* New Modules: New Modules<3>.
* Improved Modules: Improved Modules<3>.
* Optimizations: Optimizations<3>.
* Build and C API Changes: Build and C API Changes<2>.
* Other Improvements::
* Deprecated: Deprecated<2>.
* Removed::
* Porting to Python 3.6: Porting to Python 3 6.
* Notable changes in Python 3.6.2: Notable changes in Python 3 6 2.
* Notable changes in Python 3.6.4: Notable changes in Python 3 6 4.
* Notable changes in Python 3.6.5: Notable changes in Python 3 6 5.
* Notable changes in Python 3.6.7: Notable changes in Python 3 6 7.
* Notable changes in Python 3.6.10: Notable changes in Python 3 6 10.

New Features

* PEP 498; Formatted string literals: PEP 498 Formatted string literals.
* PEP 526; Syntax for variable annotations: PEP 526 Syntax for variable annotations.
* PEP 515; Underscores in Numeric Literals: PEP 515 Underscores in Numeric Literals.
* PEP 525; Asynchronous Generators: PEP 525 Asynchronous Generators.
* PEP 530; Asynchronous Comprehensions: PEP 530 Asynchronous Comprehensions.
* PEP 487; Simpler customization of class creation: PEP 487 Simpler customization of class creation.
* PEP 487; Descriptor Protocol Enhancements: PEP 487 Descriptor Protocol Enhancements.
* PEP 519; Adding a file system path protocol: PEP 519 Adding a file system path protocol.
* PEP 495; Local Time Disambiguation: PEP 495 Local Time Disambiguation.
* PEP 529; Change Windows filesystem encoding to UTF-8: PEP 529 Change Windows filesystem encoding to UTF-8.
* PEP 528; Change Windows console encoding to UTF-8: PEP 528 Change Windows console encoding to UTF-8.
* PEP 520; Preserving Class Attribute Definition Order: PEP 520 Preserving Class Attribute Definition Order.
* PEP 468; Preserving Keyword Argument Order: PEP 468 Preserving Keyword Argument Order.
* New dict implementation::
* PEP 523; Adding a frame evaluation API to CPython: PEP 523 Adding a frame evaluation API to CPython.
* PYTHONMALLOC environment variable::
* DTrace and SystemTap probing support::

New Modules

* secrets::

Improved Modules

* array::
* ast: ast<2>.
* asyncio: asyncio<4>.
* binascii: binascii<2>.
* cmath::
* collections: collections<4>.
* concurrent.futures: concurrent futures<2>.
* contextlib: contextlib<2>.
* datetime: datetime<3>.
* decimal: decimal<2>.
* distutils: distutils<2>.
* email::
* encodings::
* enum: enum<3>.
* faulthandler::
* fileinput::
* hashlib::
* http.client: http client<2>.
* idlelib and IDLE: idlelib and IDLE<2>.
* importlib: importlib<3>.
* inspect: inspect<2>.
* json::
* logging: logging<3>.
* math: math<3>.
* multiprocessing: multiprocessing<3>.
* os: os<3>.
* pathlib: pathlib<3>.
* pdb: pdb<2>.
* pickle: pickle<2>.
* pickletools::
* pydoc: pydoc<2>.
* random::
* re: re<2>.
* readline::
* rlcompleter::
* shlex: shlex<2>.
* site::
* sqlite3: sqlite3<2>.
* socket: socket<4>.
* socketserver: socketserver<2>.
* ssl: ssl<4>.
* statistics: statistics<2>.
* struct::
* subprocess: subprocess<2>.
* sys: sys<4>.
* telnetlib::
* time: time<3>.
* timeit::
* tkinter: tkinter<3>.
* traceback::
* tracemalloc: tracemalloc<2>.
* typing: typing<2>.
* unicodedata: unicodedata<3>.
* unittest.mock: unittest mock<2>.
* urllib.request: urllib request.
* urllib.robotparser: urllib robotparser.
* venv: venv<2>.
* warnings: warnings<2>.
* winreg::
* winsound::
* xmlrpc.client: xmlrpc client.
* zipfile: zipfile<2>.
* zlib::

Deprecated

* New Keywords::
* Deprecated Python behavior::
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods<2>.
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<2>.
* Deprecated Build Options::

Deprecated Python modules, functions and methods

* asynchat::
* asyncore::
* dbm: dbm<3>.
* distutils: distutils<3>.
* grp::
* importlib: importlib<4>.
* os: os<4>.
* re: re<3>.
* ssl: ssl<5>.
* tkinter: tkinter<4>.
* venv: venv<3>.

Removed

* API and Feature Removals: API and Feature Removals<3>.

Porting to Python 3.6

* Changes in ‘python’ Command Behavior::
* Changes in the Python API: Changes in the Python API<3>.
* Changes in the C API: Changes in the C API<3>.
* CPython bytecode changes: CPython bytecode changes<3>.

Notable changes in Python 3.6.2

* New make regen-all build target::
* Removal of make touch build target::

What’s New In Python 3.5

* Summary – Release highlights: Summary – Release highlights<3>.
* New Features: New Features<4>.
* Other Language Changes: Other Language Changes<4>.
* New Modules: New Modules<4>.
* Improved Modules: Improved Modules<4>.
* Other module-level changes::
* Optimizations: Optimizations<4>.
* Build and C API Changes: Build and C API Changes<3>.
* Deprecated: Deprecated<3>.
* Removed: Removed<2>.
* Porting to Python 3.5: Porting to Python 3 5.
* Notable changes in Python 3.5.4: Notable changes in Python 3 5 4.

New Features

* PEP 492 - Coroutines with async and await syntax::
* PEP 465 - A dedicated infix operator for matrix multiplication::
* PEP 448 - Additional Unpacking Generalizations::
* PEP 461 - percent formatting support for bytes and bytearray::
* PEP 484 - Type Hints::
* PEP 471 - os.scandir() function – a better and faster directory iterator: PEP 471 - os scandir function – a better and faster directory iterator.
* PEP 475; Retry system calls failing with EINTR: PEP 475 Retry system calls failing with EINTR.
* PEP 479; Change StopIteration handling inside generators: PEP 479 Change StopIteration handling inside generators.
* PEP 485; A function for testing approximate equality: PEP 485 A function for testing approximate equality.
* PEP 486; Make the Python Launcher aware of virtual environments: PEP 486 Make the Python Launcher aware of virtual environments.
* PEP 488; Elimination of PYO files: PEP 488 Elimination of PYO files.
* PEP 489; Multi-phase extension module initialization: PEP 489 Multi-phase extension module initialization.

New Modules

* typing: typing<3>.
* zipapp: zipapp<2>.

Improved Modules

* argparse: argparse<2>.
* asyncio: asyncio<5>.
* bz2::
* cgi::
* cmath: cmath<2>.
* code::
* collections: collections<5>.
* collections.abc: collections abc.
* compileall: compileall<2>.
* concurrent.futures: concurrent futures<3>.
* configparser::
* contextlib: contextlib<3>.
* csv: csv<2>.
* curses: curses<2>.
* dbm: dbm<4>.
* difflib::
* distutils: distutils<4>.
* doctest::
* email: email<2>.
* enum: enum<4>.
* faulthandler: faulthandler<2>.
* functools: functools<3>.
* glob::
* gzip: gzip<2>.
* heapq::
* http::
* http.client: http client<3>.
* idlelib and IDLE: idlelib and IDLE<3>.
* imaplib::
* imghdr::
* importlib: importlib<5>.
* inspect: inspect<3>.
* io: io<3>.
* ipaddress: ipaddress<2>.
* json: json<2>.
* linecache::
* locale: locale<3>.
* logging: logging<4>.
* lzma::
* math: math<4>.
* multiprocessing: multiprocessing<4>.
* operator::
* os: os<5>.
* pathlib: pathlib<4>.
* pickle: pickle<3>.
* poplib::
* re: re<4>.
* readline: readline<2>.
* selectors::
* shutil: shutil<2>.
* signal: signal<2>.
* smtpd::
* smtplib::
* sndhdr::
* socket: socket<5>.
* ssl: ssl<6>.
* sqlite3: sqlite3<3>.
* subprocess: subprocess<3>.
* sys: sys<5>.
* sysconfig::
* tarfile: tarfile<2>.
* threading: threading<3>.
* time: time<4>.
* timeit: timeit<2>.
* tkinter: tkinter<5>.
* traceback: traceback<2>.
* types: types<2>.
* unicodedata: unicodedata<4>.
* unittest: unittest<3>.
* unittest.mock: unittest mock<3>.
* urllib::
* wsgiref::
* xmlrpc: xmlrpc<2>.
* xml.sax: xml sax.
* zipfile: zipfile<3>.

ssl

* Memory BIO Support::
* Application-Layer Protocol Negotiation Support::
* Other Changes::

Deprecated

* New Keywords: New Keywords<2>.
* Deprecated Python Behavior: Deprecated Python Behavior<2>.
* Unsupported Operating Systems::
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods<3>.

Removed

* API and Feature Removals: API and Feature Removals<4>.

Porting to Python 3.5

* Changes in Python behavior: Changes in Python behavior<2>.
* Changes in the Python API: Changes in the Python API<4>.
* Changes in the C API: Changes in the C API<4>.

Notable changes in Python 3.5.4

* New make regen-all build target: New make regen-all build target<2>.
* Removal of make touch build target: Removal of make touch build target<2>.

What’s New In Python 3.4

* Summary – Release Highlights: Summary – Release Highlights<2>.
* New Features: New Features<5>.
* New Modules: New Modules<5>.
* Improved Modules: Improved Modules<5>.
* CPython Implementation Changes::
* Deprecated: Deprecated<4>.
* Removed: Removed<3>.
* Porting to Python 3.4: Porting to Python 3 4.
* Changed in 3.4.3: Changed in 3 4 3.

New Features

* PEP 453; Explicit Bootstrapping of PIP in Python Installations: PEP 453 Explicit Bootstrapping of PIP in Python Installations.
* PEP 446; Newly Created File Descriptors Are Non-Inheritable: PEP 446 Newly Created File Descriptors Are Non-Inheritable.
* Improvements to Codec Handling::
* PEP 451; A ModuleSpec Type for the Import System: PEP 451 A ModuleSpec Type for the Import System.
* Other Language Changes: Other Language Changes<5>.

PEP 453: Explicit Bootstrapping of PIP in Python Installations

* Bootstrapping pip By Default::
* Documentation Changes::

New Modules

* asyncio: asyncio<6>.
* ensurepip::
* enum: enum<5>.
* pathlib: pathlib<5>.
* selectors: selectors<2>.
* statistics: statistics<3>.
* tracemalloc: tracemalloc<3>.

Improved Modules

* abc::
* aifc: aifc<2>.
* argparse: argparse<3>.
* audioop::
* base64::
* collections: collections<6>.
* colorsys::
* contextlib: contextlib<4>.
* dbm: dbm<5>.
* dis: dis<2>.
* doctest: doctest<2>.
* email: email<3>.
* filecmp::
* functools: functools<4>.
* gc: gc<3>.
* glob: glob<2>.
* hashlib: hashlib<2>.
* hmac: hmac<2>.
* html::
* http: http<2>.
* idlelib and IDLE: idlelib and IDLE<4>.
* importlib: importlib<6>.
* inspect: inspect<4>.
* ipaddress: ipaddress<3>.
* logging: logging<5>.
* marshal::
* mmap: mmap<2>.
* multiprocessing: multiprocessing<5>.
* operator: operator<2>.
* os: os<6>.
* pdb: pdb<3>.
* pickle: pickle<4>.
* plistlib: plistlib<2>.
* poplib: poplib<2>.
* pprint: pprint<2>.
* pty::
* pydoc: pydoc<3>.
* re: re<5>.
* resource::
* select::
* shelve::
* shutil: shutil<3>.
* smtpd: smtpd<2>.
* smtplib: smtplib<2>.
* socket: socket<6>.
* sqlite3: sqlite3<4>.
* ssl: ssl<7>.
* stat::
* struct: struct<2>.
* subprocess: subprocess<4>.
* sunau: sunau<2>.
* sys: sys<6>.
* tarfile: tarfile<3>.
* textwrap::
* threading: threading<4>.
* traceback: traceback<3>.
* types: types<3>.
* urllib: urllib<2>.
* unittest: unittest<4>.
* venv: venv<4>.
* wave: wave<2>.
* weakref: weakref<2>.
* xml.etree: xml etree<2>.
* zipfile: zipfile<4>.

CPython Implementation Changes

* PEP 445; Customization of CPython Memory Allocators: PEP 445 Customization of CPython Memory Allocators.
* PEP 442; Safe Object Finalization: PEP 442 Safe Object Finalization.
* PEP 456; Secure and Interchangeable Hash Algorithm: PEP 456 Secure and Interchangeable Hash Algorithm.
* PEP 436; Argument Clinic: PEP 436 Argument Clinic.
* Other Build and C API Changes::
* Other Improvements: Other Improvements<2>.
* Significant Optimizations::

Deprecated

* Deprecations in the Python API::
* Deprecated Features::

Removed

* Operating Systems No Longer Supported::
* API and Feature Removals: API and Feature Removals<5>.
* Code Cleanups::

Porting to Python 3.4

* Changes in ‘python’ Command Behavior: Changes in ‘python’ Command Behavior<2>.
* Changes in the Python API: Changes in the Python API<5>.
* Changes in the C API: Changes in the C API<5>.

Changed in 3.4.3

* PEP 476; Enabling certificate verification by default for stdlib http clients: PEP 476 Enabling certificate verification by default for stdlib http clients.

What’s New In Python 3.3

* Summary – Release highlights: Summary – Release highlights<4>.
* PEP 405; Virtual Environments: PEP 405 Virtual Environments.
* PEP 420; Implicit Namespace Packages: PEP 420 Implicit Namespace Packages.
* PEP 3118; New memoryview implementation and buffer protocol documentation: PEP 3118 New memoryview implementation and buffer protocol documentation.
* PEP 393; Flexible String Representation: PEP 393 Flexible String Representation.
* PEP 397; Python Launcher for Windows: PEP 397 Python Launcher for Windows.
* PEP 3151; Reworking the OS and IO exception hierarchy: PEP 3151 Reworking the OS and IO exception hierarchy.
* PEP 380; Syntax for Delegating to a Subgenerator: PEP 380 Syntax for Delegating to a Subgenerator.
* PEP 409; Suppressing exception context: PEP 409 Suppressing exception context.
* PEP 414; Explicit Unicode literals: PEP 414 Explicit Unicode literals.
* PEP 3155; Qualified name for classes and functions: PEP 3155 Qualified name for classes and functions.
* PEP 412; Key-Sharing Dictionary: PEP 412 Key-Sharing Dictionary.
* PEP 362; Function Signature Object: PEP 362 Function Signature Object.
* PEP 421; Adding sys.implementation: PEP 421 Adding sys implementation.
* Using importlib as the Implementation of Import::
* Other Language Changes: Other Language Changes<6>.
* A Finer-Grained Import Lock::
* Builtin functions and types::
* New Modules: New Modules<6>.
* Improved Modules: Improved Modules<6>.
* Optimizations: Optimizations<5>.
* Build and C API Changes: Build and C API Changes<4>.
* Deprecated: Deprecated<5>.
* Porting to Python 3.3: Porting to Python 3 3.

PEP 3118: New memoryview implementation and buffer protocol documentation

* Features::
* API changes::

PEP 393: Flexible String Representation

* Functionality::
* Performance and resource usage::

PEP 421: Adding sys.implementation

* SimpleNamespace::

Using importlib as the Implementation of Import

* New APIs::
* Visible Changes::

New Modules

* faulthandler: faulthandler<3>.
* ipaddress: ipaddress<4>.
* lzma: lzma<2>.

Improved Modules

* abc: abc<2>.
* array: array<2>.
* base64: base64<2>.
* binascii: binascii<3>.
* bz2: bz2<2>.
* codecs::
* collections: collections<7>.
* contextlib: contextlib<5>.
* crypt: crypt<2>.
* curses: curses<3>.
* datetime: datetime<4>.
* decimal: decimal<3>.
* email: email<4>.
* ftplib::
* functools: functools<5>.
* gc: gc<4>.
* hmac: hmac<3>.
* http: http<3>.
* html: html<2>.
* imaplib: imaplib<2>.
* inspect: inspect<5>.
* io: io<4>.
* itertools: itertools<3>.
* logging: logging<6>.
* math: math<5>.
* mmap: mmap<3>.
* multiprocessing: multiprocessing<6>.
* nntplib::
* os: os<7>.
* pdb: pdb<4>.
* pickle: pickle<5>.
* pydoc: pydoc<4>.
* re: re<6>.
* sched::
* select: select<2>.
* shlex: shlex<3>.
* shutil: shutil<4>.
* signal: signal<3>.
* smtpd: smtpd<3>.
* smtplib: smtplib<3>.
* socket: socket<7>.
* socketserver: socketserver<3>.
* sqlite3: sqlite3<5>.
* ssl: ssl<8>.
* stat: stat<2>.
* struct: struct<3>.
* subprocess: subprocess<5>.
* sys: sys<7>.
* tarfile: tarfile<4>.
* tempfile::
* textwrap: textwrap<2>.
* threading: threading<5>.
* time: time<5>.
* types: types<4>.
* unittest: unittest<5>.
* urllib: urllib<3>.
* webbrowser::
* xml.etree.ElementTree: xml etree ElementTree.
* zlib: zlib<2>.

decimal

* Features: Features<2>.
* API changes: API changes<2>.

email

* Policy Framework::
* Provisional Policy with New Header API::
* Other API Changes::

Deprecated

* Unsupported Operating Systems: Unsupported Operating Systems<2>.
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods<4>.
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<3>.
* Deprecated features::

Porting to Python 3.3

* Porting Python code::
* Porting C code::
* Building C extensions::
* Command Line Switch Changes::

What’s New In Python 3.2

* PEP 384; Defining a Stable ABI: PEP 384 Defining a Stable ABI.
* PEP 389; Argparse Command Line Parsing Module: PEP 389 Argparse Command Line Parsing Module.
* PEP 391; Dictionary Based Configuration for Logging: PEP 391 Dictionary Based Configuration for Logging.
* PEP 3148; The concurrent.futures module: PEP 3148 The concurrent futures module.
* PEP 3147; PYC Repository Directories: PEP 3147 PYC Repository Directories.
* PEP 3149; ABI Version Tagged .so Files: PEP 3149 ABI Version Tagged so Files.
* PEP 3333; Python Web Server Gateway Interface v1.0.1: PEP 3333 Python Web Server Gateway Interface v1 0 1.
* Other Language Changes: Other Language Changes<7>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules.
* Multi-threading::
* Optimizations: Optimizations<6>.
* Unicode::
* Codecs::
* Documentation::
* IDLE::
* Code Repository::
* Build and C API Changes: Build and C API Changes<5>.
* Porting to Python 3.2: Porting to Python 3 2.

New, Improved, and Deprecated Modules

* email: email<5>.
* elementtree::
* functools: functools<6>.
* itertools: itertools<4>.
* collections: collections<8>.
* threading: threading<6>.
* datetime and time::
* math: math<6>.
* abc: abc<3>.
* io: io<5>.
* reprlib::
* logging: logging<7>.
* csv: csv<3>.
* contextlib: contextlib<6>.
* decimal and fractions::
* ftp::
* popen::
* select: select<3>.
* gzip and zipfile::
* tarfile: tarfile<5>.
* hashlib: hashlib<3>.
* ast: ast<3>.
* os: os<8>.
* shutil: shutil<5>.
* sqlite3: sqlite3<6>.
* html: html<3>.
* socket: socket<8>.
* ssl: ssl<9>.
* nntp::
* certificates::
* imaplib: imaplib<3>.
* http.client: http client<4>.
* unittest: unittest<6>.
* random: random<2>.
* poplib: poplib<3>.
* asyncore: asyncore<2>.
* tempfile: tempfile<2>.
* inspect: inspect<6>.
* pydoc: pydoc<5>.
* dis: dis<3>.
* dbm: dbm<6>.
* ctypes: ctypes<2>.
* site: site<2>.
* sysconfig: sysconfig<2>.
* pdb: pdb<5>.
* configparser: configparser<2>.
* urllib.parse: urllib parse<2>.
* mailbox::
* turtledemo::

What’s New In Python 3.1

* PEP 372; Ordered Dictionaries: PEP 372 Ordered Dictionaries.
* PEP 378; Format Specifier for Thousands Separator: PEP 378 Format Specifier for Thousands Separator.
* Other Language Changes: Other Language Changes<8>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules<2>.
* Optimizations: Optimizations<7>.
* IDLE: IDLE<2>.
* Build and C API Changes: Build and C API Changes<6>.
* Porting to Python 3.1: Porting to Python 3 1.

What’s New In Python 3.0

* Common Stumbling Blocks::
* Overview Of Syntax Changes::
* Changes Already Present In Python 2.6: Changes Already Present In Python 2 6.
* Library Changes::
* PEP 3101; A New Approach To String Formatting: PEP 3101 A New Approach To String Formatting.
* Changes To Exceptions::
* Miscellaneous Other Changes::
* Build and C API Changes: Build and C API Changes<7>.
* Performance::
* Porting To Python 3.0: Porting To Python 3 0.

Common Stumbling Blocks

* Print Is A Function::
* Views And Iterators Instead Of Lists::
* Ordering Comparisons::
* Integers::
* Text Vs. Data Instead Of Unicode Vs. 8-bit: Text Vs Data Instead Of Unicode Vs 8-bit.

Overview Of Syntax Changes

* New Syntax::
* Changed Syntax::
* Removed Syntax::

Miscellaneous Other Changes

* Operators And Special Methods::
* Builtins::

What’s New in Python 2.7

* The Future for Python 2.x: The Future for Python 2 x.
* Changes to the Handling of Deprecation Warnings::
* Python 3.1 Features: Python 3 1 Features.
* PEP 372; Adding an Ordered Dictionary to collections: PEP 372 Adding an Ordered Dictionary to collections.
* PEP 378; Format Specifier for Thousands Separator: PEP 378 Format Specifier for Thousands Separator<2>.
* PEP 389; The argparse Module for Parsing Command Lines: PEP 389 The argparse Module for Parsing Command Lines.
* PEP 391; Dictionary-Based Configuration For Logging: PEP 391 Dictionary-Based Configuration For Logging.
* PEP 3106; Dictionary Views: PEP 3106 Dictionary Views.
* PEP 3137; The memoryview Object: PEP 3137 The memoryview Object.
* Other Language Changes: Other Language Changes<9>.
* New and Improved Modules::
* Build and C API Changes: Build and C API Changes<8>.
* Other Changes and Fixes::
* Porting to Python 2.7: Porting to Python 2 7.
* New Features Added to Python 2.7 Maintenance Releases: New Features Added to Python 2 7 Maintenance Releases.
* Acknowledgements::

Other Language Changes

* Interpreter Changes::
* Optimizations: Optimizations<8>.

New and Improved Modules

* New module; importlib: New module importlib.
* New module; sysconfig: New module sysconfig.
* ttk; Themed Widgets for Tk: ttk Themed Widgets for Tk.
* Updated module; unittest: Updated module unittest.
* Updated module; ElementTree 1.3: Updated module ElementTree 1 3.

Build and C API Changes

* Capsules::
* Port-Specific Changes; Windows: Port-Specific Changes Windows.
* Port-Specific Changes; Mac OS X: Port-Specific Changes Mac OS X.
* Port-Specific Changes; FreeBSD: Port-Specific Changes FreeBSD.

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 434 IDLE Enhancement Exception for All Branches.
* PEP 466; Network Security Enhancements for Python 2.7: PEP 466 Network Security Enhancements for Python 2 7.
* PEP 477; Backport ensurepip (PEP 453) to 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 476 Enabling certificate verification by default for stdlib http clients<2>.
* PEP 493; HTTPS verification migration tools for Python 2.7: PEP 493 HTTPS verification migration tools for Python 2 7.
* New make regen-all build target: New make regen-all build target<3>.
* Removal of make touch build target: Removal of make touch build target<3>.

PEP 477: Backport ensurepip (PEP 453) to Python 2.7

* Bootstrapping pip By Default: Bootstrapping pip By Default<2>.
* Documentation Changes: Documentation Changes<2>.

What’s New in Python 2.6

* Python 3.0: Python 3 0.
* Changes to the Development Process::
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement.
* PEP 366; Explicit Relative Imports From a Main Module: PEP 366 Explicit Relative Imports From a Main Module.
* PEP 370; Per-user site-packages Directory: PEP 370 Per-user site-packages Directory.
* PEP 371; The multiprocessing Package: PEP 371 The multiprocessing Package.
* PEP 3101; Advanced String Formatting: PEP 3101 Advanced String Formatting.
* PEP 3105; print As a Function: PEP 3105 print As a Function.
* PEP 3110; Exception-Handling Changes: PEP 3110 Exception-Handling Changes.
* PEP 3112; Byte Literals: PEP 3112 Byte Literals.
* PEP 3116; New I/O Library: PEP 3116 New I/O Library.
* PEP 3118; Revised Buffer Protocol: PEP 3118 Revised Buffer Protocol.
* PEP 3119; Abstract Base Classes: PEP 3119 Abstract Base Classes.
* PEP 3127; Integer Literal Support and Syntax: PEP 3127 Integer Literal Support and Syntax.
* PEP 3129; Class Decorators: PEP 3129 Class Decorators.
* PEP 3141; A Type Hierarchy for Numbers: PEP 3141 A Type Hierarchy for Numbers.
* Other Language Changes: Other Language Changes<10>.
* New and Improved Modules: New and Improved Modules<2>.
* Deprecations and Removals::
* Build and C API Changes: Build and C API Changes<9>.
* Porting to Python 2.6: Porting to Python 2 6.
* Acknowledgements: Acknowledgements<2>.

Changes to the Development Process

* New Issue Tracker; Roundup: New Issue Tracker Roundup.
* New Documentation Format; reStructuredText Using Sphinx: New Documentation Format reStructuredText Using Sphinx.

PEP 343: The ‘with’ statement

* Writing Context Managers::
* The contextlib module::

PEP 3141: A Type Hierarchy for Numbers

* The fractions Module::

Other Language Changes

* Optimizations: Optimizations<9>.
* Interpreter Changes: Interpreter Changes<2>.

New and Improved Modules

* The ast module::
* The future_builtins module::
* The json module; JavaScript Object Notation: The json module JavaScript Object Notation.
* The plistlib module; A Property-List Parser: The plistlib module A Property-List Parser.
* ctypes Enhancements::
* Improved SSL Support::

Build and C API Changes

* Port-Specific Changes; Windows: Port-Specific Changes Windows<2>.
* Port-Specific Changes; Mac OS X: Port-Specific Changes Mac OS X<2>.
* Port-Specific Changes; IRIX: Port-Specific Changes IRIX.

What’s New in Python 2.5

* PEP 308; Conditional Expressions: PEP 308 Conditional Expressions.
* PEP 309; Partial Function Application: PEP 309 Partial Function Application.
* PEP 314; Metadata for Python Software Packages v1.1: PEP 314 Metadata for Python Software Packages v1 1.
* PEP 328; Absolute and Relative Imports: PEP 328 Absolute and Relative Imports.
* PEP 338; Executing Modules as Scripts: PEP 338 Executing Modules as Scripts.
* PEP 341; Unified try/except/finally: PEP 341 Unified try/except/finally.
* PEP 342; New Generator Features: PEP 342 New Generator Features.
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement<2>.
* PEP 352; Exceptions as New-Style Classes: PEP 352 Exceptions as New-Style Classes.
* PEP 353; Using ssize_t as the index type: PEP 353 Using ssize_t as the index type.
* PEP 357; The ‘__index__’ method: PEP 357 The ‘__index__’ method.
* Other Language Changes: Other Language Changes<11>.
* New, Improved, and Removed Modules: New Improved and Removed Modules.
* Build and C API Changes: Build and C API Changes<10>.
* Porting to Python 2.5: Porting to Python 2 5.
* Acknowledgements: Acknowledgements<3>.

PEP 343: The ‘with’ statement

* Writing Context Managers: Writing Context Managers<2>.
* The contextlib module: The contextlib module<2>.

Other Language Changes

* Interactive Interpreter Changes::
* Optimizations: Optimizations<10>.

New, Improved, and Removed Modules

* The ctypes package::
* The ElementTree package::
* The hashlib package::
* The sqlite3 package::
* The wsgiref package::

Build and C API Changes

* Port-Specific Changes::

What’s New in Python 2.4

* PEP 218; Built-In Set Objects: PEP 218 Built-In Set Objects.
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers.
* PEP 289; Generator Expressions: PEP 289 Generator Expressions.
* PEP 292; Simpler String Substitutions: PEP 292 Simpler String Substitutions.
* PEP 318; Decorators for Functions and Methods: PEP 318 Decorators for Functions and Methods.
* PEP 322; Reverse Iteration: PEP 322 Reverse Iteration.
* PEP 324; New subprocess Module: PEP 324 New subprocess Module.
* PEP 327; Decimal Data Type: PEP 327 Decimal Data Type.
* PEP 328; Multi-line Imports: PEP 328 Multi-line Imports.
* PEP 331; Locale-Independent Float/String Conversions: PEP 331 Locale-Independent Float/String Conversions.
* Other Language Changes: Other Language Changes<12>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules<3>.
* Build and C API Changes: Build and C API Changes<11>.
* Porting to Python 2.4: Porting to Python 2 4.
* Acknowledgements: Acknowledgements<4>.

PEP 327: Decimal Data Type

* Why is Decimal needed?::
* The Decimal type::
* The Context type::

Other Language Changes

* Optimizations: Optimizations<11>.

New, Improved, and Deprecated Modules

* cookielib::
* doctest: doctest<3>.

Build and C API Changes

* Port-Specific Changes: Port-Specific Changes<2>.

What’s New in Python 2.3

* PEP 218; A Standard Set Datatype: PEP 218 A Standard Set Datatype.
* PEP 255; Simple Generators: PEP 255 Simple Generators.
* PEP 263; Source Code Encodings: PEP 263 Source Code Encodings.
* PEP 273; Importing Modules from ZIP Archives: PEP 273 Importing Modules from ZIP Archives.
* PEP 277; Unicode file name support for Windows NT: PEP 277 Unicode file name support for Windows NT.
* PEP 278; Universal Newline Support: PEP 278 Universal Newline Support.
* PEP 279; enumerate(): PEP 279 enumerate.
* PEP 282; The logging Package: PEP 282 The logging Package.
* PEP 285; A Boolean Type: PEP 285 A Boolean Type.
* PEP 293; Codec Error Handling Callbacks: PEP 293 Codec Error Handling Callbacks.
* PEP 301; Package Index and Metadata for Distutils: PEP 301 Package Index and Metadata for Distutils.
* PEP 302; New Import Hooks: PEP 302 New Import Hooks.
* PEP 305; Comma-separated Files: PEP 305 Comma-separated Files.
* PEP 307; Pickle Enhancements: PEP 307 Pickle Enhancements.
* Extended Slices::
* Other Language Changes: Other Language Changes<13>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules<4>.
* Pymalloc; A Specialized Object Allocator: Pymalloc A Specialized Object Allocator.
* Build and C API Changes: Build and C API Changes<12>.
* Other Changes and Fixes: Other Changes and Fixes<2>.
* Porting to Python 2.3: Porting to Python 2 3.
* Acknowledgements: Acknowledgements<5>.

Other Language Changes

* String Changes::
* Optimizations: Optimizations<12>.

New, Improved, and Deprecated Modules

* Date/Time Type::
* The optparse Module::

Build and C API Changes

* Port-Specific Changes: Port-Specific Changes<3>.

What’s New in Python 2.2

* Introduction::
* PEPs 252 and 253; Type and Class Changes: PEPs 252 and 253 Type and Class Changes.
* PEP 234; Iterators: PEP 234 Iterators.
* PEP 255; Simple Generators: PEP 255 Simple Generators<2>.
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers<2>.
* PEP 238; Changing the Division Operator: PEP 238 Changing the Division Operator.
* Unicode Changes::
* PEP 227; Nested Scopes: PEP 227 Nested Scopes.
* New and Improved Modules: New and Improved Modules<3>.
* Interpreter Changes and Fixes::
* Other Changes and Fixes: Other Changes and Fixes<3>.
* Acknowledgements: Acknowledgements<6>.

PEPs 252 and 253: Type and Class Changes

* Old and New Classes::
* Descriptors::
* Multiple Inheritance; The Diamond Rule: Multiple Inheritance The Diamond Rule.
* Attribute Access::
* Related Links::

What’s New in Python 2.1

* Introduction: Introduction<2>.
* PEP 227; Nested Scopes: PEP 227 Nested Scopes<2>.
* PEP 236; __future__ Directives: PEP 236 __future__ Directives.
* PEP 207; Rich Comparisons: PEP 207 Rich Comparisons.
* PEP 230; Warning Framework: PEP 230 Warning Framework.
* PEP 229; New Build System: PEP 229 New Build System.
* PEP 205; Weak References: PEP 205 Weak References.
* PEP 232; Function Attributes: PEP 232 Function Attributes.
* PEP 235; Importing Modules on Case-Insensitive Platforms: PEP 235 Importing Modules on Case-Insensitive Platforms.
* PEP 217; Interactive Display Hook: PEP 217 Interactive Display Hook.
* PEP 208; New Coercion Model: PEP 208 New Coercion Model.
* PEP 241; Metadata in Python Packages: PEP 241 Metadata in Python Packages.
* New and Improved Modules: New and Improved Modules<4>.
* Other Changes and Fixes: Other Changes and Fixes<4>.
* Acknowledgements: Acknowledgements<7>.

What’s New in Python 2.0

* Introduction: Introduction<3>.
* What About Python 1.6?: What About Python 1 6?.
* New Development Process::
* Unicode: Unicode<2>.
* List Comprehensions::
* Augmented Assignment::
* String Methods::
* Garbage Collection of Cycles::
* Other Core Changes::
* Porting to 2.0: Porting to 2 0.
* Extending/Embedding Changes::
* Distutils; Making Modules Easy to Install: Distutils Making Modules Easy to Install.
* XML Modules::
* Module changes::
* New modules::
* IDLE Improvements::
* Deleted and Deprecated Modules::
* Acknowledgements: Acknowledgements<8>.

Other Core Changes

* Minor Language Changes::
* Changes to Built-in Functions::

XML Modules

* SAX2 Support::
* DOM Support::
* Relationship to PyXML::

Changelog

* Python 3.8.1 final: Python 3 8 1 final.
* Python 3.8.1 release candidate 1: Python 3 8 1 release candidate 1.
* Python 3.8.0 final: Python 3 8 0 final.
* Python 3.8.0 release candidate 1: Python 3 8 0 release candidate 1.
* Python 3.8.0 beta 4: Python 3 8 0 beta 4.
* Python 3.8.0 beta 3: Python 3 8 0 beta 3.
* Python 3.8.0 beta 2: Python 3 8 0 beta 2.
* Python 3.8.0 beta 1: Python 3 8 0 beta 1.
* Python 3.8.0 alpha 4: Python 3 8 0 alpha 4.
* Python 3.8.0 alpha 3: Python 3 8 0 alpha 3.
* Python 3.8.0 alpha 2: Python 3 8 0 alpha 2.
* Python 3.8.0 alpha 1: Python 3 8 0 alpha 1.
* Python 3.7.0 final: Python 3 7 0 final.
* Python 3.7.0 release candidate 1: Python 3 7 0 release candidate 1.
* Python 3.7.0 beta 5: Python 3 7 0 beta 5.
* Python 3.7.0 beta 4: Python 3 7 0 beta 4.
* Python 3.7.0 beta 3: Python 3 7 0 beta 3.
* Python 3.7.0 beta 2: Python 3 7 0 beta 2.
* Python 3.7.0 beta 1: Python 3 7 0 beta 1.
* Python 3.7.0 alpha 4: Python 3 7 0 alpha 4.
* Python 3.7.0 alpha 3: Python 3 7 0 alpha 3.
* Python 3.7.0 alpha 2: Python 3 7 0 alpha 2.
* Python 3.7.0 alpha 1: Python 3 7 0 alpha 1.
* Python 3.6.6 final: Python 3 6 6 final.
* Python 3.6.6 release candidate 1: Python 3 6 6 release candidate 1.
* Python 3.6.5 final: Python 3 6 5 final.
* Python 3.6.5 release candidate 1: Python 3 6 5 release candidate 1.
* Python 3.6.4 final: Python 3 6 4 final.
* Python 3.6.4 release candidate 1: Python 3 6 4 release candidate 1.
* Python 3.6.3 final: Python 3 6 3 final.
* Python 3.6.3 release candidate 1: Python 3 6 3 release candidate 1.
* Python 3.6.2 final: Python 3 6 2 final.
* Python 3.6.2 release candidate 2: Python 3 6 2 release candidate 2.
* Python 3.6.2 release candidate 1: Python 3 6 2 release candidate 1.
* Python 3.6.1 final: Python 3 6 1 final.
* Python 3.6.1 release candidate 1: Python 3 6 1 release candidate 1.
* Python 3.6.0 final: Python 3 6 0 final.
* Python 3.6.0 release candidate 2: Python 3 6 0 release candidate 2.
* Python 3.6.0 release candidate 1: Python 3 6 0 release candidate 1.
* Python 3.6.0 beta 4: Python 3 6 0 beta 4.
* Python 3.6.0 beta 3: Python 3 6 0 beta 3.
* Python 3.6.0 beta 2: Python 3 6 0 beta 2.
* Python 3.6.0 beta 1: Python 3 6 0 beta 1.
* Python 3.6.0 alpha 4: Python 3 6 0 alpha 4.
* Python 3.6.0 alpha 3: Python 3 6 0 alpha 3.
* Python 3.6.0 alpha 2: Python 3 6 0 alpha 2.
* Python 3.6.0 alpha 1: Python 3 6 0 alpha 1.
* Python 3.5.5 final: Python 3 5 5 final.
* Python 3.5.5 release candidate 1: Python 3 5 5 release candidate 1.
* Python 3.5.4 final: Python 3 5 4 final.
* Python 3.5.4 release candidate 1: Python 3 5 4 release candidate 1.
* Python 3.5.3 final: Python 3 5 3 final.
* Python 3.5.3 release candidate 1: Python 3 5 3 release candidate 1.
* Python 3.5.2 final: Python 3 5 2 final.
* Python 3.5.2 release candidate 1: Python 3 5 2 release candidate 1.
* Python 3.5.1 final: Python 3 5 1 final.
* Python 3.5.1 release candidate 1: Python 3 5 1 release candidate 1.
* Python 3.5.0 final: Python 3 5 0 final.
* Python 3.5.0 release candidate 4: Python 3 5 0 release candidate 4.
* Python 3.5.0 release candidate 3: Python 3 5 0 release candidate 3.
* Python 3.5.0 release candidate 2: Python 3 5 0 release candidate 2.
* Python 3.5.0 release candidate 1: Python 3 5 0 release candidate 1.
* Python 3.5.0 beta 4: Python 3 5 0 beta 4.
* Python 3.5.0 beta 3: Python 3 5 0 beta 3.
* Python 3.5.0 beta 2: Python 3 5 0 beta 2.
* Python 3.5.0 beta 1: Python 3 5 0 beta 1.
* Python 3.5.0 alpha 4: Python 3 5 0 alpha 4.
* Python 3.5.0 alpha 3: Python 3 5 0 alpha 3.
* Python 3.5.0 alpha 2: Python 3 5 0 alpha 2.
* Python 3.5.0 alpha 1: Python 3 5 0 alpha 1.

Python 3.8.1 final

* Core and Builtins::
* Library::
* Tests::
* Windows::
* macOS::
* IDLE: IDLE<3>.

Python 3.8.1 release candidate 1

* Security::
* Core and Builtins: Core and Builtins<2>.
* Library: Library<2>.
* Documentation: Documentation<2>.
* Tests: Tests<2>.
* Build::
* Windows: Windows<2>.
* macOS: macOS<2>.
* IDLE: IDLE<4>.
* C API::

Python 3.8.0 final

* Core and Builtins: Core and Builtins<3>.
* Library: Library<3>.
* Documentation: Documentation<3>.
* Tests: Tests<3>.
* Windows: Windows<3>.
* IDLE: IDLE<5>.
* Tools/Demos::
* C API: C API<2>.

Python 3.8.0 release candidate 1

* Security: Security<2>.
* Core and Builtins: Core and Builtins<4>.
* Library: Library<4>.
* Documentation: Documentation<4>.
* Tests: Tests<4>.
* Build: Build<2>.
* Windows: Windows<4>.
* macOS: macOS<3>.
* IDLE: IDLE<6>.
* Tools/Demos: Tools/Demos<2>.
* C API: C API<3>.

Python 3.8.0 beta 4

* Security: Security<3>.
* Core and Builtins: Core and Builtins<5>.
* Library: Library<5>.
* Documentation: Documentation<5>.
* Tests: Tests<5>.
* Build: Build<3>.
* Windows: Windows<5>.
* macOS: macOS<4>.
* IDLE: IDLE<7>.
* Tools/Demos: Tools/Demos<3>.
* C API: C API<4>.

Python 3.8.0 beta 3

* Security: Security<4>.
* Core and Builtins: Core and Builtins<6>.
* Library: Library<6>.
* Documentation: Documentation<6>.
* Tests: Tests<6>.
* Build: Build<4>.
* Windows: Windows<6>.
* IDLE: IDLE<8>.
* Tools/Demos: Tools/Demos<4>.

Python 3.8.0 beta 2

* Security: Security<5>.
* Core and Builtins: Core and Builtins<7>.
* Library: Library<7>.
* Documentation: Documentation<7>.
* Tests: Tests<7>.
* Build: Build<5>.
* Windows: Windows<7>.
* macOS: macOS<5>.
* IDLE: IDLE<9>.
* C API: C API<5>.

Python 3.8.0 beta 1

* Security: Security<6>.
* Core and Builtins: Core and Builtins<8>.
* Library: Library<8>.
* Documentation: Documentation<8>.
* Tests: Tests<8>.
* Build: Build<6>.
* Windows: Windows<8>.
* macOS: macOS<6>.
* IDLE: IDLE<10>.
* Tools/Demos: Tools/Demos<5>.
* C API: C API<6>.

Python 3.8.0 alpha 4

* Security: Security<7>.
* Core and Builtins: Core and Builtins<9>.
* Library: Library<9>.
* Documentation: Documentation<9>.
* Tests: Tests<9>.
* Build: Build<7>.
* Windows: Windows<9>.
* macOS: macOS<7>.
* IDLE: IDLE<11>.
* Tools/Demos: Tools/Demos<6>.
* C API: C API<7>.

Python 3.8.0 alpha 3

* Security: Security<8>.
* Core and Builtins: Core and Builtins<10>.
* Library: Library<10>.
* Documentation: Documentation<10>.
* Tests: Tests<10>.
* Build: Build<8>.
* Windows: Windows<10>.
* IDLE: IDLE<12>.
* Tools/Demos: Tools/Demos<7>.
* C API: C API<8>.

Python 3.8.0 alpha 2

* Core and Builtins: Core and Builtins<11>.
* Library: Library<11>.
* Documentation: Documentation<11>.
* Tests: Tests<11>.
* Windows: Windows<11>.
* IDLE: IDLE<13>.

Python 3.8.0 alpha 1

* Security: Security<9>.
* Core and Builtins: Core and Builtins<12>.
* Library: Library<12>.
* Documentation: Documentation<12>.
* Tests: Tests<12>.
* Build: Build<9>.
* Windows: Windows<12>.
* macOS: macOS<8>.
* IDLE: IDLE<14>.
* Tools/Demos: Tools/Demos<8>.
* C API: C API<9>.

Python 3.7.0 final

* Library: Library<13>.
* C API: C API<10>.

Python 3.7.0 release candidate 1

* Core and Builtins: Core and Builtins<13>.
* Library: Library<14>.
* Documentation: Documentation<13>.
* Build: Build<10>.
* Windows: Windows<13>.
* IDLE: IDLE<15>.

Python 3.7.0 beta 5

* Core and Builtins: Core and Builtins<14>.
* Library: Library<15>.
* Documentation: Documentation<14>.
* Tests: Tests<13>.
* Build: Build<11>.
* macOS: macOS<9>.
* IDLE: IDLE<16>.

Python 3.7.0 beta 4

* Core and Builtins: Core and Builtins<15>.
* Library: Library<16>.
* Documentation: Documentation<15>.
* Tests: Tests<14>.
* Build: Build<12>.
* Windows: Windows<14>.
* macOS: macOS<10>.
* IDLE: IDLE<17>.
* Tools/Demos: Tools/Demos<9>.

Python 3.7.0 beta 3

* Security: Security<10>.
* Core and Builtins: Core and Builtins<16>.
* Library: Library<17>.
* Documentation: Documentation<16>.
* Tests: Tests<15>.
* Build: Build<13>.
* Windows: Windows<15>.
* macOS: macOS<11>.
* IDLE: IDLE<18>.
* Tools/Demos: Tools/Demos<10>.
* C API: C API<11>.

Python 3.7.0 beta 2

* Security: Security<11>.
* Core and Builtins: Core and Builtins<17>.
* Library: Library<18>.
* Documentation: Documentation<17>.
* Tests: Tests<16>.
* Build: Build<14>.
* Windows: Windows<16>.
* macOS: macOS<12>.
* IDLE: IDLE<19>.
* Tools/Demos: Tools/Demos<11>.

Python 3.7.0 beta 1

* Core and Builtins: Core and Builtins<18>.
* Library: Library<19>.
* Documentation: Documentation<18>.
* Tests: Tests<17>.
* Build: Build<15>.
* Windows: Windows<17>.
* macOS: macOS<13>.
* C API: C API<12>.

Python 3.7.0 alpha 4

* Core and Builtins: Core and Builtins<19>.
* Library: Library<20>.
* Documentation: Documentation<19>.
* Tests: Tests<18>.
* Windows: Windows<18>.
* Tools/Demos: Tools/Demos<12>.
* C API: C API<13>.

Python 3.7.0 alpha 3

* Core and Builtins: Core and Builtins<20>.
* Library: Library<21>.
* Documentation: Documentation<20>.
* Tests: Tests<19>.
* Build: Build<16>.
* Windows: Windows<19>.
* macOS: macOS<14>.
* IDLE: IDLE<20>.
* Tools/Demos: Tools/Demos<13>.
* C API: C API<14>.

Python 3.7.0 alpha 2

* Core and Builtins: Core and Builtins<21>.
* Library: Library<22>.
* Documentation: Documentation<21>.
* Build: Build<17>.
* IDLE: IDLE<21>.
* C API: C API<15>.

Python 3.7.0 alpha 1

* Security: Security<12>.
* Core and Builtins: Core and Builtins<22>.
* Library: Library<23>.
* Documentation: Documentation<22>.
* Tests: Tests<20>.
* Build: Build<18>.
* Windows: Windows<20>.
* IDLE: IDLE<22>.
* Tools/Demos: Tools/Demos<14>.
* C API: C API<16>.

Python 3.6.6 release candidate 1

* Core and Builtins: Core and Builtins<23>.
* Library: Library<24>.
* Documentation: Documentation<23>.
* Tests: Tests<21>.
* Build: Build<19>.
* Windows: Windows<21>.
* macOS: macOS<15>.
* IDLE: IDLE<23>.
* Tools/Demos: Tools/Demos<15>.
* C API: C API<17>.

Python 3.6.5 final

* Tests: Tests<22>.
* Build: Build<20>.

Python 3.6.5 release candidate 1

* Security: Security<13>.
* Core and Builtins: Core and Builtins<24>.
* Library: Library<25>.
* Documentation: Documentation<24>.
* Tests: Tests<23>.
* Build: Build<21>.
* Windows: Windows<22>.
* macOS: macOS<16>.
* IDLE: IDLE<24>.
* Tools/Demos: Tools/Demos<16>.
* C API: C API<18>.

Python 3.6.4 release candidate 1

* Core and Builtins: Core and Builtins<25>.
* Library: Library<26>.
* Documentation: Documentation<25>.
* Tests: Tests<24>.
* Build: Build<22>.
* Windows: Windows<23>.
* macOS: macOS<17>.
* IDLE: IDLE<25>.
* Tools/Demos: Tools/Demos<17>.
* C API: C API<19>.

Python 3.6.3 final

* Library: Library<27>.
* Build: Build<23>.

Python 3.6.3 release candidate 1

* Security: Security<14>.
* Core and Builtins: Core and Builtins<26>.
* Library: Library<28>.
* Documentation: Documentation<26>.
* Tests: Tests<25>.
* Build: Build<24>.
* Windows: Windows<24>.
* IDLE: IDLE<26>.
* Tools/Demos: Tools/Demos<18>.

Python 3.6.2 release candidate 2

* Security: Security<15>.

Python 3.6.2 release candidate 1

* Core and Builtins: Core and Builtins<27>.
* Library: Library<29>.
* Security: Security<16>.
* Library: Library<30>.
* IDLE: IDLE<27>.
* C API: C API<20>.
* Build: Build<25>.
* Documentation: Documentation<27>.
* Tools/Demos: Tools/Demos<19>.
* Tests: Tests<26>.
* Windows: Windows<25>.

Python 3.6.1 final

* Core and Builtins: Core and Builtins<28>.
* Build: Build<26>.

Python 3.6.1 release candidate 1

* Core and Builtins: Core and Builtins<29>.
* Library: Library<31>.
* IDLE: IDLE<28>.
* Windows: Windows<26>.
* C API: C API<21>.
* Documentation: Documentation<28>.
* Tests: Tests<27>.
* Build: Build<27>.

Python 3.6.0 release candidate 2

* Core and Builtins: Core and Builtins<30>.
* Tools/Demos: Tools/Demos<20>.
* Windows: Windows<27>.
* Build: Build<28>.

Python 3.6.0 release candidate 1

* Core and Builtins: Core and Builtins<31>.
* Library: Library<32>.
* C API: C API<22>.
* Documentation: Documentation<29>.
* Tools/Demos: Tools/Demos<21>.

Python 3.6.0 beta 4

* Core and Builtins: Core and Builtins<32>.
* Library: Library<33>.
* Documentation: Documentation<30>.
* Tests: Tests<28>.
* Build: Build<29>.

Python 3.6.0 beta 3

* Core and Builtins: Core and Builtins<33>.
* Library: Library<34>.
* Windows: Windows<28>.
* Build: Build<30>.
* Tests: Tests<29>.

Python 3.6.0 beta 2

* Core and Builtins: Core and Builtins<34>.
* Library: Library<35>.
* Windows: Windows<29>.
* C API: C API<23>.
* Build: Build<31>.
* Tests: Tests<30>.

Python 3.6.0 beta 1

* Core and Builtins: Core and Builtins<35>.
* Library: Library<36>.
* IDLE: IDLE<29>.
* C API: C API<24>.
* Tests: Tests<31>.
* Build: Build<32>.
* Tools/Demos: Tools/Demos<22>.
* Windows: Windows<30>.

Python 3.6.0 alpha 4

* Core and Builtins: Core and Builtins<36>.
* Library: Library<37>.
* IDLE: IDLE<30>.
* Tests: Tests<32>.
* Windows: Windows<31>.
* Build: Build<33>.

Python 3.6.0 alpha 3

* Core and Builtins: Core and Builtins<37>.
* Library: Library<38>.
* Security: Security<17>.
* Library: Library<39>.
* Security: Security<18>.
* Library: Library<40>.
* IDLE: IDLE<31>.
* C API: C API<25>.
* Build: Build<34>.
* Tools/Demos: Tools/Demos<23>.
* Documentation: Documentation<31>.
* Tests: Tests<33>.

Python 3.6.0 alpha 2

* Core and Builtins: Core and Builtins<38>.
* Library: Library<41>.
* Security: Security<19>.
* Library: Library<42>.
* Security: Security<20>.
* Library: Library<43>.
* IDLE: IDLE<32>.
* Documentation: Documentation<32>.
* Tests: Tests<34>.
* Windows: Windows<32>.
* Build: Build<35>.
* Windows: Windows<33>.
* C API: C API<26>.
* Tools/Demos: Tools/Demos<24>.

Python 3.6.0 alpha 1

* Core and Builtins: Core and Builtins<39>.
* Library: Library<44>.
* Security: Security<21>.
* Library: Library<45>.
* Security: Security<22>.
* Library: Library<46>.
* Security: Security<23>.
* Library: Library<47>.
* IDLE: IDLE<33>.
* Documentation: Documentation<33>.
* Tests: Tests<35>.
* Build: Build<36>.
* Windows: Windows<34>.
* Tools/Demos: Tools/Demos<25>.
* C API: C API<27>.

Python 3.5.5 release candidate 1

* Security: Security<24>.
* Core and Builtins: Core and Builtins<40>.
* Library: Library<48>.

Python 3.5.4 final

* Library: Library<49>.

Python 3.5.4 release candidate 1

* Security: Security<25>.
* Core and Builtins: Core and Builtins<41>.
* Library: Library<50>.
* Documentation: Documentation<34>.
* Tests: Tests<36>.
* Build: Build<37>.
* Windows: Windows<35>.
* C API: C API<28>.

Python 3.5.3 release candidate 1

* Core and Builtins: Core and Builtins<42>.
* Library: Library<51>.
* Security: Security<26>.
* Library: Library<52>.
* Security: Security<27>.
* Library: Library<53>.
* IDLE: IDLE<34>.
* C API: C API<29>.
* Documentation: Documentation<35>.
* Tests: Tests<37>.
* Tools/Demos: Tools/Demos<26>.
* Windows: Windows<36>.
* Build: Build<38>.

Python 3.5.2 final

* Core and Builtins: Core and Builtins<43>.
* Tests: Tests<38>.
* IDLE: IDLE<35>.

Python 3.5.2 release candidate 1

* Core and Builtins: Core and Builtins<44>.
* Security: Security<28>.
* Library: Library<54>.
* Security: Security<29>.
* Library: Library<55>.
* Security: Security<30>.
* Library: Library<56>.
* Security: Security<31>.
* Library: Library<57>.
* Security: Security<32>.
* Library: Library<58>.
* IDLE: IDLE<36>.
* Documentation: Documentation<36>.
* Tests: Tests<39>.
* Build: Build<39>.
* Windows: Windows<37>.
* Tools/Demos: Tools/Demos<27>.
* Windows: Windows<38>.

Python 3.5.1 final

* Core and Builtins: Core and Builtins<45>.
* Windows: Windows<39>.

Python 3.5.1 release candidate 1

* Core and Builtins: Core and Builtins<46>.
* Library: Library<59>.
* IDLE: IDLE<37>.
* Documentation: Documentation<37>.
* Tests: Tests<40>.
* Build: Build<40>.
* Windows: Windows<40>.
* Tools/Demos: Tools/Demos<28>.

Python 3.5.0 final

* Build: Build<41>.

Python 3.5.0 release candidate 4

* Library: Library<60>.
* Build: Build<42>.

Python 3.5.0 release candidate 3

* Core and Builtins: Core and Builtins<47>.
* Library: Library<61>.

Python 3.5.0 release candidate 2

* Core and Builtins: Core and Builtins<48>.
* Library: Library<62>.

Python 3.5.0 release candidate 1

* Core and Builtins: Core and Builtins<49>.
* Library: Library<63>.
* IDLE: IDLE<38>.
* Documentation: Documentation<38>.
* Tests: Tests<41>.

Python 3.5.0 beta 4

* Core and Builtins: Core and Builtins<50>.
* Library: Library<64>.
* Build: Build<43>.

Python 3.5.0 beta 3

* Core and Builtins: Core and Builtins<51>.
* Library: Library<65>.
* Tests: Tests<42>.
* Documentation: Documentation<39>.
* Build: Build<44>.

Python 3.5.0 beta 2

* Core and Builtins: Core and Builtins<52>.
* Library: Library<66>.

Python 3.5.0 beta 1

* Core and Builtins: Core and Builtins<53>.
* Library: Library<67>.
* IDLE: IDLE<39>.
* Tests: Tests<43>.
* Documentation: Documentation<40>.
* Tools/Demos: Tools/Demos<29>.

Python 3.5.0 alpha 4

* Core and Builtins: Core and Builtins<54>.
* Library: Library<68>.
* Build: Build<45>.
* Tests: Tests<44>.
* Tools/Demos: Tools/Demos<30>.
* C API: C API<30>.

Python 3.5.0 alpha 3

* Core and Builtins: Core and Builtins<55>.
* Library: Library<69>.
* Build: Build<46>.
* Tests: Tests<45>.
* Tools/Demos: Tools/Demos<31>.

Python 3.5.0 alpha 2

* Core and Builtins: Core and Builtins<56>.
* Library: Library<70>.
* Build: Build<47>.
* C API: C API<31>.
* Windows: Windows<41>.

Python 3.5.0 alpha 1

* Core and Builtins: Core and Builtins<57>.
* Library: Library<71>.
* IDLE: IDLE<40>.
* Build: Build<48>.
* C API: C API<32>.
* Documentation: Documentation<41>.
* Tests: Tests<46>.
* Tools/Demos: Tools/Demos<32>.
* Windows: Windows<42>.

The Python Tutorial

* Whetting Your Appetite::
* Using the Python Interpreter::
* An Informal Introduction to Python::
* More Control Flow Tools::
* Data Structures::
* Modules::
* Input and Output::
* Errors and Exceptions::
* Classes::
* Brief Tour of the Standard Library::
* Brief Tour of the Standard Library — Part II::
* Virtual Environments and Packages::
* What Now?::
* Interactive Input Editing and History Substitution::
* Floating Point Arithmetic; Issues and Limitations: Floating Point Arithmetic Issues and Limitations.
* Appendix::

Using the Python Interpreter

* Invoking the Interpreter::
* The Interpreter and Its Environment::

Invoking the Interpreter

* Argument Passing::
* Interactive Mode::

The Interpreter and Its Environment

* Source Code Encoding::

An Informal Introduction to Python

* Using Python as a Calculator::
* First Steps Towards Programming::

Using Python as a Calculator

* Numbers::
* Strings::
* Lists::

More Control Flow Tools

* if Statements::
* for Statements::
* The range() Function: The range Function.
* break and continue Statements, and else Clauses on Loops: break and continue Statements and else Clauses on Loops.
* pass Statements::
* Defining Functions::
* More on Defining Functions::
* Intermezzo; Coding Style: Intermezzo Coding Style.

More on Defining Functions

* Default Argument Values::
* Keyword Arguments::
* Special parameters::
* Arbitrary Argument Lists::
* Unpacking Argument Lists::
* Lambda Expressions::
* Documentation Strings::
* Function Annotations::

Special parameters

* Positional-or-Keyword Arguments::
* Positional-Only Parameters::
* Keyword-Only Arguments::
* Function Examples::
* Recap::

Data Structures

* More on Lists::
* The del statement::
* Tuples and Sequences::
* Sets::
* Dictionaries::
* Looping Techniques::
* More on Conditions::
* Comparing Sequences and Other Types::

More on Lists

* Using Lists as Stacks::
* Using Lists as Queues::
* List Comprehensions: List Comprehensions<2>.
* Nested List Comprehensions::

Modules

* More on Modules::
* Standard Modules::
* The dir() Function: The dir Function.
* Packages::

More on Modules

* Executing modules as scripts::
* The Module Search Path::
* “Compiled” Python files::

Packages

* Importing * From a Package::
* Intra-package References::
* Packages in Multiple Directories::

Input and Output

* Fancier Output Formatting::
* Reading and Writing Files::

Fancier Output Formatting

* Formatted String Literals::
* The String format() Method: The String format Method.
* Manual String Formatting::
* Old string formatting::

Reading and Writing Files

* Methods of File Objects::
* Saving structured data with json::

Errors and Exceptions

* Syntax Errors::
* Exceptions::
* Handling Exceptions::
* Raising Exceptions::
* User-defined Exceptions::
* Defining Clean-up Actions::
* Predefined Clean-up Actions::

Classes

* A Word About Names and Objects::
* Python Scopes and Namespaces::
* A First Look at Classes::
* Random Remarks::
* Inheritance::
* Private Variables::
* Odds and Ends::
* Iterators::
* Generators::
* Generator Expressions::

Python Scopes and Namespaces

* Scopes and Namespaces Example::

A First Look at Classes

* Class Definition Syntax::
* Class Objects::
* Instance Objects::
* Method Objects::
* Class and Instance Variables::

Inheritance

* Multiple Inheritance::

Brief Tour of the Standard Library

* Operating System Interface::
* File Wildcards::
* Command Line Arguments::
* Error Output Redirection and Program Termination::
* String Pattern Matching::
* Mathematics::
* Internet Access::
* Dates and Times::
* Data Compression::
* Performance Measurement::
* Quality Control::
* Batteries Included::

Brief Tour of the Standard Library — Part II

* Output Formatting::
* Templating::
* Working with Binary Data Record Layouts::
* Multi-threading: Multi-threading<2>.
* Logging::
* Weak References::
* Tools for Working with Lists::
* Decimal Floating Point Arithmetic::

Virtual Environments and Packages

* Introduction: Introduction<4>.
* Creating Virtual Environments::
* Managing Packages with pip::

Interactive Input Editing and History Substitution

* Tab Completion and History Editing::
* Alternatives to the Interactive Interpreter::

Floating Point Arithmetic:  Issues and Limitations

* Representation Error::

Appendix

* Interactive Mode: Interactive Mode<2>.

Interactive Mode

* Error Handling::
* Executable Python Scripts::
* The Interactive Startup File::
* The Customization Modules::

Python Setup and Usage

* Command line and environment::
* Using Python on Unix platforms::
* Using Python on Windows::
* Using Python on a Macintosh::
* Editors and IDEs::

Command line and environment

* Command line::
* Environment variables::

Command line

* Interface options::
* Generic options::
* Miscellaneous options::
* Options you shouldn’t use::

Environment variables

* Debug-mode variables::

Using Python on Unix platforms

* Getting and installing the latest version of Python::
* Building Python::
* Python-related paths and files::
* Miscellaneous::

Getting and installing the latest version of Python

* On Linux::
* On FreeBSD and OpenBSD::
* On OpenSolaris::

Using Python on Windows

* The full installer::
* The Microsoft Store package::
* The nuget.org packages: The nuget org packages.
* The embeddable package::
* Alternative bundles::
* Configuring Python::
* Python Launcher for Windows::
* Finding modules::
* Additional modules::
* Compiling Python on Windows::
* Other Platforms::

The full installer

* Installation steps::
* Removing the MAX_PATH Limitation::
* Installing Without UI::
* Installing Without Downloading::
* Modifying an install::

The Microsoft Store package

* Known Issues::

The embeddable package

* Python Application::
* Embedding Python::

Configuring Python

* Excursus; Setting environment variables: Excursus Setting environment variables.
* Finding the Python executable::

Python Launcher for Windows

* Getting started::
* Shebang Lines::
* Arguments in shebang lines::
* Customization::
* Diagnostics::

Getting started

* From the command-line::
* Virtual environments::
* From a script::
* From file associations::

Customization

* Customization via INI files::
* Customizing default Python versions::

Additional modules

* PyWin32::
* cx_Freeze::
* WConio::

Using Python on a Macintosh

* Getting and Installing MacPython::
* The IDE::
* Installing Additional Python Packages::
* GUI Programming on the Mac::
* Distributing Python Applications on the Mac::
* Other Resources::

Getting and Installing MacPython

* How to run a Python script::
* Running scripts with a GUI::
* Configuration::

The Python Language Reference

* Introduction: Introduction<5>.
* Lexical analysis::
* Data model::
* Execution model::
* The import system::
* Expressions::
* Simple statements::
* Compound statements::
* Top-level components::
* Full Grammar specification::

Introduction

* Alternate Implementations::
* Notation::

Lexical analysis

* Line structure::
* Other tokens::
* Identifiers and keywords::
* Literals::
* Operators::
* Delimiters::

Line structure

* Logical lines::
* Physical lines::
* Comments::
* Encoding declarations::
* Explicit line joining::
* Implicit line joining::
* Blank lines::
* Indentation::
* Whitespace between tokens::

Identifiers and keywords

* Keywords::
* Reserved classes of identifiers::

Literals

* String and Bytes literals::
* String literal concatenation::
* Formatted string literals::
* Numeric literals::
* Integer literals::
* Floating point literals::
* Imaginary literals::

Data model

* Objects, values and types: Objects values and types.
* The standard type hierarchy::
* Special method names::
* Coroutines::

Special method names

* Basic customization::
* Customizing attribute access::
* Customizing class creation::
* Customizing instance and subclass checks::
* Emulating generic types::
* Emulating callable objects::
* Emulating container types::
* Emulating numeric types::
* With Statement Context Managers::
* Special method lookup::

Customizing attribute access

* Customizing module attribute access::
* Implementing Descriptors::
* Invoking Descriptors::
* __slots__::

__slots__

* Notes on using __slots__::

Customizing class creation

* Metaclasses::
* Resolving MRO entries::
* Determining the appropriate metaclass::
* Preparing the class namespace::
* Executing the class body::
* Creating the class object::
* Uses for metaclasses::

Coroutines

* Awaitable Objects::
* Coroutine Objects::
* Asynchronous Iterators::
* Asynchronous Context Managers::

Execution model

* Structure of a program::
* Naming and binding::
* Exceptions: Exceptions<2>.

Naming and binding

* Binding of names::
* Resolution of names::
* Builtins and restricted execution::
* Interaction with dynamic features::

The import system

* importlib: importlib<7>.
* Packages: Packages<2>.
* Searching::
* Loading::
* The Path Based Finder::
* Replacing the standard import system::
* Package Relative Imports::
* Special considerations for __main__::
* Open issues::
* References::

Packages

* Regular packages::
* Namespace packages::

Searching

* The module cache::
* Finders and loaders::
* Import hooks::
* The meta path::

Loading

* Loaders::
* Submodules::
* Module spec::
* Import-related module attributes::
* module.__path__: module __path__.
* Module reprs::
* Cached bytecode invalidation::

The Path Based Finder

* Path entry finders::
* Path entry finder protocol::

Special considerations for __main__

* __main__.__spec__: __main__ __spec__.

Expressions

* Arithmetic conversions::
* Atoms::
* Primaries::
* Await expression::
* The power operator::
* Unary arithmetic and bitwise operations::
* Binary arithmetic operations::
* Shifting operations::
* Binary bitwise operations::
* Comparisons::
* Boolean operations::
* Conditional expressions::
* Lambdas::
* Expression lists::
* Evaluation order::
* Operator precedence::

Atoms

* Identifiers (Names): Identifiers Names.
* Literals: Literals<2>.
* Parenthesized forms::
* Displays for lists, sets and dictionaries: Displays for lists sets and dictionaries.
* List displays::
* Set displays::
* Dictionary displays::
* Generator expressions::
* Yield expressions::

Yield expressions

* Generator-iterator methods::
* Examples::
* Asynchronous generator functions::
* Asynchronous generator-iterator methods::

Primaries

* Attribute references::
* Subscriptions::
* Slicings::
* Calls::

Comparisons

* Value comparisons::
* Membership test operations::
* Identity comparisons::

Simple statements

* Expression statements::
* Assignment statements::
* The assert statement::
* The pass statement::
* The del statement: The del statement<2>.
* The return statement::
* The yield statement::
* The raise statement::
* The break statement::
* The continue statement::
* The import statement::
* The global statement::
* The nonlocal statement::

Assignment statements

* Augmented assignment statements::
* Annotated assignment statements::

The import statement

* Future statements::

Compound statements

* The if statement::
* The while statement::
* The for statement::
* The try statement::
* The with statement::
* Function definitions::
* Class definitions::
* Coroutines: Coroutines<2>.

Coroutines

* Coroutine function definition::
* The async for statement::
* The async with statement::

Top-level components

* Complete Python programs::
* File input::
* Interactive input::
* Expression input::

The Python Standard Library

* Introduction: Introduction<6>.
* Built-in Functions::
* Built-in Constants::
* Built-in Types::
* Built-in Exceptions::
* Text Processing Services::
* Binary Data Services::
* Data Types::
* Numeric and Mathematical Modules::
* Functional Programming Modules::
* File and Directory Access::
* Data Persistence::
* Data Compression and Archiving::
* File Formats::
* Cryptographic Services::
* Generic Operating System Services::
* Concurrent Execution::
* contextvars — Context Variables::
* Networking and Interprocess Communication::
* Internet Data Handling::
* Structured Markup Processing Tools::
* Internet Protocols and Support::
* Multimedia Services::
* Internationalization::
* Program Frameworks::
* Graphical User Interfaces with Tk::
* Development Tools::
* Debugging and Profiling::
* Software Packaging and Distribution::
* Python Runtime Services::
* Custom Python Interpreters::
* Importing Modules::
* Python Language Services::
* Miscellaneous Services::
* MS Windows Specific Services::
* Unix Specific Services::
* Superseded Modules::
* Undocumented Modules::

Introduction

* Notes on availability::

Built-in Constants

* Constants added by the site module::

Built-in Types

* Truth Value Testing::
* Boolean Operations — and, or, not: Boolean Operations — and or not.
* Comparisons: Comparisons<2>.
* Numeric Types — int, float, complex: Numeric Types — int float complex.
* Iterator Types::
* Sequence Types — list, tuple, range: Sequence Types — list tuple range.
* Text Sequence Type — str::
* Binary Sequence Types — bytes, bytearray, memoryview: Binary Sequence Types — bytes bytearray memoryview.
* Set Types — set, frozenset: Set Types — set frozenset.
* Mapping Types — dict::
* Context Manager Types::
* Other Built-in Types::
* Special Attributes::

Numeric Types — int, float, complex

* Bitwise Operations on Integer Types::
* Additional Methods on Integer Types::
* Additional Methods on Float::
* Hashing of numeric types::

Iterator Types

* Generator Types::

Sequence Types — list, tuple, range

* Common Sequence Operations::
* Immutable Sequence Types::
* Mutable Sequence Types::
* Lists: Lists<2>.
* Tuples::
* Ranges::

Text Sequence Type — str

* String Methods: String Methods<2>.
* printf-style String Formatting::

Binary Sequence Types — bytes, bytearray, memoryview

* Bytes Objects::
* Bytearray Objects::
* Bytes and Bytearray Operations::
* printf-style Bytes Formatting::
* Memory Views::

Mapping Types — dict

* Dictionary view objects::

Other Built-in Types

* Modules: Modules<2>.
* Classes and Class Instances::
* Functions::
* Methods::
* Code Objects::
* Type Objects::
* The Null Object::
* The Ellipsis Object::
* The NotImplemented Object::
* Boolean Values::
* Internal Objects::

Built-in Exceptions

* Base classes::
* Concrete exceptions::
* Warnings::
* Exception hierarchy::

Concrete exceptions

* OS exceptions::

Text Processing Services

* string — Common string operations::
* re — Regular expression operations::
* difflib — Helpers for computing deltas::
* textwrap — Text wrapping and filling::
* unicodedata — Unicode Database::
* stringprep — Internet String Preparation::
* readline — GNU readline interface::
* rlcompleter — Completion function for GNU readline::

string — Common string operations

* String constants::
* Custom String Formatting::
* Format String Syntax::
* Template strings::
* Helper functions::

Format String Syntax

* Format Specification Mini-Language::
* Format examples::

re — Regular expression operations

* Regular Expression Syntax::
* Module Contents::
* Regular Expression Objects::
* Match Objects::
* Regular Expression Examples::

Regular Expression Examples

* Checking for a Pair::
* Simulating scanf(): Simulating scanf.
* search() vs. match(): search vs match.
* Making a Phonebook::
* Text Munging::
* Finding all Adverbs::
* Finding all Adverbs and their Positions::
* Raw String Notation::
* Writing a Tokenizer::

difflib — Helpers for computing deltas

* SequenceMatcher Objects::
* SequenceMatcher Examples::
* Differ Objects::
* Differ Example::
* A command-line interface to difflib::

readline — GNU readline interface

* Init file::
* Line buffer::
* History file::
* History list::
* Startup hooks::
* Completion::
* Example::

rlcompleter — Completion function for GNU readline

* Completer Objects::

Binary Data Services

* struct — Interpret bytes as packed binary data::
* codecs — Codec registry and base classes::

struct — Interpret bytes as packed binary data

* Functions and Exceptions::
* Format Strings::
* Classes: Classes<2>.

Format Strings

* Byte Order, Size, and Alignment: Byte Order Size and Alignment.
* Format Characters::
* Examples: Examples<2>.

codecs — Codec registry and base classes

* Codec Base Classes::
* Encodings and Unicode::
* Standard Encodings::
* Python Specific Encodings::
* encodings.idna — Internationalized Domain Names in Applications: encodings idna — Internationalized Domain Names in Applications.
* encodings.mbcs — Windows ANSI codepage: encodings mbcs — Windows ANSI codepage.
* encodings.utf_8_sig — UTF-8 codec with BOM signature: encodings utf_8_sig — UTF-8 codec with BOM signature.

Codec Base Classes

* Error Handlers::
* Stateless Encoding and Decoding::
* Incremental Encoding and Decoding::
* Stream Encoding and Decoding::

Incremental Encoding and Decoding

* IncrementalEncoder Objects::
* IncrementalDecoder Objects::

Stream Encoding and Decoding

* StreamWriter Objects::
* StreamReader Objects::
* StreamReaderWriter Objects::
* StreamRecoder Objects::

Python Specific Encodings

* Text Encodings::
* Binary Transforms::
* Text Transforms::

Data Types

* datetime — Basic date and time types::
* calendar — General calendar-related functions::
* collections — Container datatypes::
* collections.abc — Abstract Base Classes for Containers: collections abc — Abstract Base Classes for Containers.
* heapq — Heap queue algorithm::
* bisect — Array bisection algorithm::
* array — Efficient arrays of numeric values::
* weakref — Weak references::
* types — Dynamic type creation and names for built-in types::
* copy — Shallow and deep copy operations::
* pprint — Data pretty printer::
* reprlib — Alternate repr() implementation: reprlib — Alternate repr implementation.
* enum — Support for enumerations::

datetime — Basic date and time types

* Aware and Naive Objects::
* Constants::
* Available Types::
* timedelta Objects::
* date Objects::
* datetime Objects::
* time Objects::
* tzinfo Objects::
* timezone Objects::
* strftime() and strptime() Behavior: strftime and strptime Behavior.

Available Types

* Common Properties::
* Determining if an Object is Aware or Naive::

timedelta Objects

* Examples of usage; timedelta: Examples of usage timedelta.

date Objects

* Examples of Usage; date: Examples of Usage date.

datetime Objects

* Examples of Usage; datetime: Examples of Usage datetime.

time Objects

* Examples of Usage; time: Examples of Usage time.

strftime() and strptime() Behavior

* strftime() and strptime() Format Codes: strftime and strptime Format Codes.
* Technical Detail::

collections — Container datatypes

* ChainMap objects::
* Counter objects::
* deque objects::
* defaultdict objects::
* namedtuple() Factory Function for Tuples with Named Fields: namedtuple Factory Function for Tuples with Named Fields.
* OrderedDict objects::
* UserDict objects::
* UserList objects::
* UserString objects::

ChainMap objects

* ChainMap Examples and Recipes::

deque objects

* deque Recipes::

defaultdict objects

* defaultdict Examples::

OrderedDict objects

* OrderedDict Examples and Recipes::

collections.abc — Abstract Base Classes for Containers

* Collections Abstract Base Classes::

heapq — Heap queue algorithm

* Basic Examples::
* Priority Queue Implementation Notes::
* Theory::

bisect — Array bisection algorithm

* Searching Sorted Lists::
* Other Examples::

weakref — Weak references

* Weak Reference Objects::
* Example: Example<2>.
* Finalizer Objects::
* Comparing finalizers with __del__() methods: Comparing finalizers with __del__ methods.

types — Dynamic type creation and names for built-in types

* Dynamic Type Creation::
* Standard Interpreter Types::
* Additional Utility Classes and Functions::
* Coroutine Utility Functions::

pprint — Data pretty printer

* PrettyPrinter Objects::
* Example: Example<3>.

reprlib — Alternate repr() implementation

* Repr Objects::
* Subclassing Repr Objects::

enum — Support for enumerations

* Module Contents: Module Contents<2>.
* Creating an Enum::
* Programmatic access to enumeration members and their attributes::
* Duplicating enum members and values::
* Ensuring unique enumeration values::
* Using automatic values::
* Iteration::
* Comparisons: Comparisons<3>.
* Allowed members and attributes of enumerations::
* Restricted Enum subclassing::
* Pickling::
* Functional API::
* Derived Enumerations::
* When to use __new__() vs. __init__(): When to use __new__ vs __init__.
* Interesting examples::
* How are Enums different?::

Derived Enumerations

* IntEnum::
* IntFlag::
* Flag::
* Others::

Interesting examples

* Omitting values::
* OrderedEnum::
* DuplicateFreeEnum::
* Planet::
* TimePeriod::

Omitting values

* Using auto::
* Using object::
* Using a descriptive string::
* Using a custom __new__(): Using a custom __new__.

How are Enums different?

* Enum Classes::
* Enum Members (aka instances): Enum Members aka instances.
* Finer Points::

Finer Points

* Supported __dunder__ names::
* Supported _sunder_ names::
* Enum member type::
* Boolean value of Enum classes and members::
* Enum classes with methods::
* Combining members of Flag::

Numeric and Mathematical Modules

* numbers — Numeric abstract base classes::
* math — Mathematical functions::
* cmath — Mathematical functions for complex numbers::
* decimal — Decimal fixed point and floating point arithmetic::
* fractions — Rational numbers::
* random — Generate pseudo-random numbers::
* statistics — Mathematical statistics functions::

numbers — Numeric abstract base classes

* The numeric tower::
* Notes for type implementors::

Notes for type implementors

* Adding More Numeric ABCs::
* Implementing the arithmetic operations::

math — Mathematical functions

* Number-theoretic and representation functions::
* Power and logarithmic functions::
* Trigonometric functions::
* Angular conversion::
* Hyperbolic functions::
* Special functions::
* Constants: Constants<2>.

cmath — Mathematical functions for complex numbers

* Conversions to and from polar coordinates::
* Power and logarithmic functions: Power and logarithmic functions<2>.
* Trigonometric functions: Trigonometric functions<2>.
* Hyperbolic functions: Hyperbolic functions<2>.
* Classification functions::
* Constants: Constants<3>.

decimal — Decimal fixed point and floating point arithmetic

* Quick-start Tutorial::
* Decimal objects::
* Context objects::
* Constants: Constants<4>.
* Rounding modes::
* Signals::
* Floating Point Notes::
* Working with threads::
* Recipes::
* Decimal FAQ::

Decimal objects

* Logical operands::

Floating Point Notes

* Mitigating round-off error with increased precision::
* Special values::

random — Generate pseudo-random numbers

* Bookkeeping functions::
* Functions for integers::
* Functions for sequences::
* Real-valued distributions::
* Alternative Generator::
* Notes on Reproducibility::
* Examples and Recipes::

statistics — Mathematical statistics functions

* Averages and measures of central location::
* Measures of spread::
* Function details::
* Exceptions: Exceptions<3>.
* NormalDist objects::

NormalDist objects

* NormalDist Examples and Recipes::

Functional Programming Modules

* itertools — Functions creating iterators for efficient looping::
* functools — Higher-order functions and operations on callable objects::
* operator — Standard operators as functions::

itertools — Functions creating iterators for efficient looping

* Itertool functions::
* Itertools Recipes::

functools — Higher-order functions and operations on callable objects

* partial Objects::

operator — Standard operators as functions

* Mapping Operators to Functions::
* In-place Operators::

File and Directory Access

* pathlib — Object-oriented filesystem paths::
* os.path — Common pathname manipulations: os path — Common pathname manipulations.
* fileinput — Iterate over lines from multiple input streams::
* stat — Interpreting stat() results: stat — Interpreting stat results.
* filecmp — File and Directory Comparisons::
* tempfile — Generate temporary files and directories::
* glob — Unix style pathname pattern expansion::
* fnmatch — Unix filename pattern matching::
* linecache — Random access to text lines::
* shutil — High-level file operations::

pathlib — Object-oriented filesystem paths

* Basic use::
* Pure paths::
* Concrete paths::
* Correspondence to tools in the os module::

Pure paths

* General properties::
* Operators: Operators<2>.
* Accessing individual parts::
* Methods and properties::

Concrete paths

* Methods: Methods<2>.

filecmp — File and Directory Comparisons

* The dircmp class::

tempfile — Generate temporary files and directories

* Examples: Examples<3>.
* Deprecated functions and variables::

shutil — High-level file operations

* Directory and files operations::
* Archiving operations::
* Querying the size of the output terminal::

Directory and files operations

* Platform-dependent efficient copy operations::
* copytree example::
* rmtree example::

Archiving operations

* Archiving example::

Data Persistence

* pickle — Python object serialization::
* copyreg — Register pickle support functions::
* shelve — Python object persistence::
* marshal — Internal Python object serialization::
* dbm — Interfaces to Unix “databases”::
* sqlite3 — DB-API 2.0 interface for SQLite databases: sqlite3 — DB-API 2 0 interface for SQLite databases.

pickle — Python object serialization

* Relationship to other Python modules::
* Data stream format::
* Module Interface::
* What can be pickled and unpickled?::
* Pickling Class Instances::
* Custom Reduction for Types, Functions, and Other Objects: Custom Reduction for Types Functions and Other Objects.
* Out-of-band Buffers::
* Restricting Globals::
* Performance: Performance<2>.
* Examples: Examples<4>.

Relationship to other Python modules

* Comparison with marshal::
* Comparison with json::

Pickling Class Instances

* Persistence of External Objects::
* Dispatch Tables::
* Handling Stateful Objects::

Out-of-band Buffers

* Provider API::
* Consumer API::
* Example: Example<4>.

copyreg — Register pickle support functions

* Example: Example<5>.

shelve — Python object persistence

* Restrictions::
* Example: Example<6>.

dbm — Interfaces to Unix “databases”

* dbm.gnu — GNU’s reinterpretation of dbm: dbm gnu — GNU’s reinterpretation of dbm.
* dbm.ndbm — Interface based on ndbm: dbm ndbm — Interface based on ndbm.
* dbm.dumb — Portable DBM implementation: dbm dumb — Portable DBM implementation.

sqlite3 — DB-API 2.0 interface for SQLite databases

* Module functions and constants::
* Connection Objects::
* Cursor Objects::
* Row Objects::
* Exceptions: Exceptions<4>.
* SQLite and Python types::
* Controlling Transactions::
* Using sqlite3 efficiently::
* Common issues::

SQLite and Python types

* Introduction: Introduction<7>.
* Using adapters to store additional Python types in SQLite databases::
* Converting SQLite values to custom Python types::
* Default adapters and converters::

Using adapters to store additional Python types in SQLite databases

* Letting your object adapt itself::
* Registering an adapter callable::

Using sqlite3 efficiently

* Using shortcut methods::
* Accessing columns by name instead of by index::
* Using the connection as a context manager::

Common issues

* Multithreading::

Data Compression and Archiving

* zlib — Compression compatible with gzip::
* gzip — Support for gzip files::
* bz2 — Support for bzip2 compression::
* lzma — Compression using the LZMA algorithm::
* zipfile — Work with ZIP archives::
* tarfile — Read and write tar archive files::

gzip — Support for gzip files

* Examples of usage::
* Command Line Interface::

Command Line Interface

* Command line options::

bz2 — Support for bzip2 compression

* (De)compression of files: De compression of files.
* Incremental (de)compression: Incremental de compression.
* One-shot (de)compression: One-shot de compression.
* Examples of usage: Examples of usage<2>.

lzma — Compression using the LZMA algorithm

* Reading and writing compressed files::
* Compressing and decompressing data in memory::
* Miscellaneous: Miscellaneous<2>.
* Specifying custom filter chains::
* Examples: Examples<5>.

zipfile — Work with ZIP archives

* ZipFile Objects::
* Path Objects::
* PyZipFile Objects::
* ZipInfo Objects::
* Command-Line Interface::
* Decompression pitfalls::

Command-Line Interface

* Command-line options::

Decompression pitfalls

* From file itself::
* File System limitations::
* Resources limitations::
* Interruption::
* Default behaviors of extraction::

tarfile — Read and write tar archive files

* TarFile Objects::
* TarInfo Objects::
* Command-Line Interface: Command-Line Interface<2>.
* Examples: Examples<6>.
* Supported tar formats::
* Unicode issues::

Command-Line Interface

* Command-line options: Command-line options<2>.

File Formats

* csv — CSV File Reading and Writing::
* configparser — Configuration file parser::
* netrc — netrc file processing::
* xdrlib — Encode and decode XDR data::
* plistlib — Generate and parse Mac OS X .plist files: plistlib — Generate and parse Mac OS X plist files.

csv — CSV File Reading and Writing

* Module Contents: Module Contents<3>.
* Dialects and Formatting Parameters::
* Reader Objects::
* Writer Objects::
* Examples: Examples<7>.

configparser — Configuration file parser

* Quick Start::
* Supported Datatypes::
* Fallback Values::
* Supported INI File Structure::
* Interpolation of values::
* Mapping Protocol Access::
* Customizing Parser Behaviour::
* Legacy API Examples::
* ConfigParser Objects::
* RawConfigParser Objects::
* Exceptions: Exceptions<5>.

netrc — netrc file processing

* netrc Objects::

xdrlib — Encode and decode XDR data

* Packer Objects::
* Unpacker Objects::
* Exceptions: Exceptions<6>.

plistlib — Generate and parse Mac OS X .plist files

* Examples: Examples<8>.

Cryptographic Services

* hashlib — Secure hashes and message digests::
* hmac — Keyed-Hashing for Message Authentication::
* secrets — Generate secure random numbers for managing secrets::

hashlib — Secure hashes and message digests

* Hash algorithms::
* SHAKE variable length digests::
* Key derivation::
* BLAKE2::

BLAKE2

* Creating hash objects::
* Constants: Constants<5>.
* Examples: Examples<9>.
* Credits::

Examples

* Simple hashing::
* Using different digest sizes::
* Keyed hashing::
* Randomized hashing::
* Personalization::
* Tree mode::

secrets — Generate secure random numbers for managing secrets

* Random numbers::
* Generating tokens::
* Other functions::
* Recipes and best practices::

Generating tokens

* How many bytes should tokens use?::

Generic Operating System Services

* os — Miscellaneous operating system interfaces::
* io — Core tools for working with streams::
* time — Time access and conversions::
* argparse — Parser for command-line options, arguments and sub-commands: argparse — Parser for command-line options arguments and sub-commands.
* getopt — C-style parser for command line options::
* logging — Logging facility for Python::
* logging.config — Logging configuration: logging config — Logging configuration.
* logging.handlers — Logging handlers: logging handlers — Logging handlers.
* getpass — Portable password input::
* curses — Terminal handling for character-cell displays::
* curses.textpad — Text input widget for curses programs: curses textpad — Text input widget for curses programs.
* curses.ascii — Utilities for ASCII characters: curses ascii — Utilities for ASCII characters.
* curses.panel — A panel stack extension for curses: curses panel — A panel stack extension for curses.
* platform — Access to underlying platform’s identifying data::
* errno — Standard errno system symbols::
* ctypes — A foreign function library for Python::

os — Miscellaneous operating system interfaces

* File Names, Command Line Arguments, and Environment Variables: File Names Command Line Arguments and Environment Variables.
* Process Parameters::
* File Object Creation::
* File Descriptor Operations::
* Files and Directories::
* Process Management::
* Interface to the scheduler::
* Miscellaneous System Information::
* Random numbers: Random numbers<2>.

File Descriptor Operations

* Querying the size of a terminal::
* Inheritance of File Descriptors::

Files and Directories

* Linux extended attributes::

io — Core tools for working with streams

* Overview::
* High-level Module Interface::
* Class hierarchy::
* Performance: Performance<3>.

Overview

* Text I/O::
* Binary I/O::
* Raw I/O::

High-level Module Interface

* In-memory streams::

Class hierarchy

* I/O Base Classes::
* Raw File I/O::
* Buffered Streams::
* Text I/O: Text I/O<2>.

Performance

* Binary I/O: Binary I/O<2>.
* Text I/O: Text I/O<3>.
* Multi-threading: Multi-threading<3>.
* Reentrancy::

time — Time access and conversions

* Functions: Functions<2>.
* Clock ID Constants::
* Timezone Constants::

argparse — Parser for command-line options, arguments and sub-commands

* Example: Example<7>.
* ArgumentParser objects::
* The add_argument() method: The add_argument method.
* The parse_args() method: The parse_args method.
* Other utilities::
* Upgrading optparse code::

Example

* Creating a parser::
* Adding arguments::
* Parsing arguments::

ArgumentParser objects

* prog::
* usage::
* description::
* epilog::
* parents::
* formatter_class::
* prefix_chars::
* fromfile_prefix_chars::
* argument_default::
* allow_abbrev::
* conflict_handler::
* add_help::

The add_argument() method

* name or flags::
* action::
* nargs::
* const::
* default::
* type::
* choices::
* required::
* help::
* metavar::
* dest::
* Action classes::

The parse_args() method

* Option value syntax::
* Invalid arguments::
* Arguments containing -::
* Argument abbreviations (prefix matching): Argument abbreviations prefix matching.
* Beyond sys.argv: Beyond sys argv.
* The Namespace object::

Other utilities

* Sub-commands::
* FileType objects::
* Argument groups::
* Mutual exclusion::
* Parser defaults::
* Printing help::
* Partial parsing::
* Customizing file parsing::
* Exiting methods::
* Intermixed parsing::

logging — Logging facility for Python

* Logger Objects::
* Logging Levels::
* Handler Objects::
* Formatter Objects::
* Filter Objects::
* LogRecord Objects::
* LogRecord attributes::
* LoggerAdapter Objects::
* Thread Safety::
* Module-Level Functions::
* Module-Level Attributes::
* Integration with the warnings module::

logging.config — Logging configuration

* Configuration functions::
* Configuration dictionary schema::
* Configuration file format::

Configuration dictionary schema

* Dictionary Schema Details::
* Incremental Configuration::
* Object connections::
* User-defined objects::
* Access to external objects::
* Access to internal objects::
* Import resolution and custom importers::

logging.handlers — Logging handlers

* StreamHandler::
* FileHandler::
* NullHandler::
* WatchedFileHandler::
* BaseRotatingHandler::
* RotatingFileHandler::
* TimedRotatingFileHandler::
* SocketHandler::
* DatagramHandler::
* SysLogHandler::
* NTEventLogHandler::
* SMTPHandler::
* MemoryHandler::
* HTTPHandler::
* QueueHandler::
* QueueListener::

curses — Terminal handling for character-cell displays

* Functions: Functions<3>.
* Window Objects::
* Constants: Constants<6>.

curses.textpad — Text input widget for curses programs

* Textbox objects::

curses.panel — A panel stack extension for curses

* Functions: Functions<4>.
* Panel Objects::

platform —  Access to underlying platform’s identifying data

* Cross Platform::
* Java Platform::
* Windows Platform::
* Mac OS Platform::
* Unix Platforms::

ctypes — A foreign function library for Python

* ctypes tutorial::
* ctypes reference::

ctypes tutorial

* Loading dynamic link libraries::
* Accessing functions from loaded dlls::
* Calling functions::
* Fundamental data types::
* Calling functions, continued: Calling functions continued.
* Calling functions with your own custom data types::
* Specifying the required argument types (function prototypes): Specifying the required argument types function prototypes.
* Return types::
* Passing pointers (or; passing parameters by reference): Passing pointers or passing parameters by reference.
* Structures and unions::
* Structure/union alignment and byte order::
* Bit fields in structures and unions::
* Arrays::
* Pointers::
* Type conversions::
* Incomplete Types::
* Callback functions::
* Accessing values exported from dlls::
* Surprises::
* Variable-sized data types::

ctypes reference

* Finding shared libraries::
* Loading shared libraries::
* Foreign functions::
* Function prototypes::
* Utility functions::
* Data types::
* Fundamental data types: Fundamental data types<2>.
* Structured data types::
* Arrays and pointers::

Concurrent Execution

* threading — Thread-based parallelism::
* multiprocessing — Process-based parallelism::
* multiprocessing.shared_memory — Provides shared memory for direct access across processes: multiprocessing shared_memory — Provides shared memory for direct access across processes.
* The concurrent package::
* concurrent.futures — Launching parallel tasks: concurrent futures — Launching parallel tasks.
* subprocess — Subprocess management::
* sched — Event scheduler::
* queue — A synchronized queue class::
* _thread — Low-level threading API::
* _dummy_thread — Drop-in replacement for the _thread module::
* dummy_threading — Drop-in replacement for the threading module::

threading — Thread-based parallelism

* Thread-Local Data::
* Thread Objects::
* Lock Objects::
* RLock Objects::
* Condition Objects::
* Semaphore Objects::
* Event Objects::
* Timer Objects::
* Barrier Objects::
* Using locks, conditions, and semaphores in the with statement: Using locks conditions and semaphores in the with statement.

Semaphore Objects

* Semaphore Example::

multiprocessing — Process-based parallelism

* Introduction: Introduction<8>.
* Reference::
* Programming guidelines::
* Examples: Examples<10>.

Introduction

* The Process class::
* Contexts and start methods::
* Exchanging objects between processes::
* Synchronization between processes::
* Sharing state between processes::
* Using a pool of workers::

Reference

* Process and exceptions::
* Pipes and Queues::
* Miscellaneous: Miscellaneous<3>.
* Connection Objects: Connection Objects<2>.
* Synchronization primitives::
* Shared ctypes Objects::
* Managers::
* Proxy Objects::
* Process Pools::
* Listeners and Clients::
* Authentication keys::
* Logging: Logging<2>.
* The multiprocessing.dummy module: The multiprocessing dummy module.

Shared ctypes Objects

* The multiprocessing.sharedctypes module: The multiprocessing sharedctypes module.

Managers

* Customized managers::
* Using a remote manager::

Proxy Objects

* Cleanup::

Listeners and Clients

* Address Formats::

Programming guidelines

* All start methods::
* The spawn and forkserver start methods::

concurrent.futures — Launching parallel tasks

* Executor Objects::
* ThreadPoolExecutor::
* ProcessPoolExecutor::
* Future Objects::
* Module Functions::
* Exception classes::

ThreadPoolExecutor

* ThreadPoolExecutor Example::

ProcessPoolExecutor

* ProcessPoolExecutor Example::

subprocess — Subprocess management

* Using the subprocess Module::
* Security Considerations::
* Popen Objects::
* Windows Popen Helpers::
* Older high-level API::
* Replacing Older Functions with the subprocess Module::
* Legacy Shell Invocation Functions::
* Notes::

Using the subprocess Module

* Frequently Used Arguments::
* Popen Constructor::
* Exceptions: Exceptions<7>.

Windows Popen Helpers

* Windows Constants::

Replacing Older Functions with the subprocess Module

* Replacing /bin/sh shell command substitution::
* Replacing shell pipeline::
* Replacing os.system(): Replacing os system.
* Replacing the os.spawn family: Replacing the os spawn family.
* Replacing os.popen(), os.popen2(), os.popen3(): Replacing os popen os popen2 os popen3.
* Replacing functions from the popen2 module::

Notes

* Converting an argument sequence to a string on Windows::

sched — Event scheduler

* Scheduler Objects::

queue — A synchronized queue class

* Queue Objects::
* SimpleQueue Objects::

contextvars — Context Variables

* Context Variables::
* Manual Context Management::
* asyncio support::

Networking and Interprocess Communication

* asyncio — Asynchronous I/O::
* socket — Low-level networking interface::
* ssl — TLS/SSL wrapper for socket objects::
* select — Waiting for I/O completion::
* selectors — High-level I/O multiplexing::
* asyncore — Asynchronous socket handler::
* asynchat — Asynchronous socket command/response handler::
* signal — Set handlers for asynchronous events::
* mmap — Memory-mapped file support::

asyncio — Asynchronous I/O

* Coroutines and Tasks::
* Streams::
* Synchronization Primitives::
* Subprocesses::
* Queues::
* Exceptions: Exceptions<9>.
* Event Loop::
* Futures::
* Transports and Protocols::
* Policies::
* Platform Support::
* High-level API Index::
* Low-level API Index::
* Developing with asyncio::

Coroutines and Tasks

* Coroutines: Coroutines<3>.
* Awaitables::
* Running an asyncio Program::
* Creating Tasks::
* Sleeping::
* Running Tasks Concurrently::
* Shielding From Cancellation::
* Timeouts::
* Waiting Primitives::
* Scheduling From Other Threads::
* Introspection::
* Task Object::
* Generator-based Coroutines::

Streams

* StreamReader::
* StreamWriter::
* Examples: Examples<11>.

Examples

* TCP echo client using streams::
* TCP echo server using streams::
* Get HTTP headers::
* Register an open socket to wait for data using streams::

Synchronization Primitives

* Lock::
* Event::
* Condition::
* Semaphore::
* BoundedSemaphore::

Subprocesses

* Creating Subprocesses::
* Constants: Constants<7>.
* Interacting with Subprocesses::

Interacting with Subprocesses

* Subprocess and Threads::
* Examples: Examples<12>.

Queues

* Queue::
* Priority Queue::
* LIFO Queue::
* Exceptions: Exceptions<8>.
* Examples: Examples<13>.

Event Loop

* Event Loop Methods::
* Callback Handles::
* Server Objects::
* Event Loop Implementations::
* Examples: Examples<14>.

Event Loop Methods

* Running and stopping the loop::
* Scheduling callbacks::
* Scheduling delayed callbacks::
* Creating Futures and Tasks::
* Opening network connections::
* Creating network servers::
* Transferring files::
* TLS Upgrade::
* Watching file descriptors::
* Working with socket objects directly::
* DNS::
* Working with pipes::
* Unix signals::
* Executing code in thread or process pools::
* Error Handling API::
* Enabling debug mode::
* Running Subprocesses::

Examples

* Hello World with call_soon(): Hello World with call_soon.
* Display the current date with call_later(): Display the current date with call_later.
* Watch a file descriptor for read events::
* Set signal handlers for SIGINT and SIGTERM::

Futures

* Future Functions::
* Future Object::

Transports and Protocols

* Transports::
* Protocols::
* Examples: Examples<15>.

Transports

* Transports Hierarchy::
* Base Transport::
* Read-only Transports::
* Write-only Transports::
* Datagram Transports::
* Subprocess Transports::

Protocols

* Base Protocols::
* Base Protocol::
* Streaming Protocols::
* Buffered Streaming Protocols::
* Datagram Protocols::
* Subprocess Protocols::

Examples

* TCP Echo Server::
* TCP Echo Client::
* UDP Echo Server::
* UDP Echo Client::
* Connecting Existing Sockets::
* loop.subprocess_exec() and SubprocessProtocol: loop subprocess_exec and SubprocessProtocol.

Policies

* Getting and Setting the Policy::
* Policy Objects::
* Process Watchers::
* Custom Policies::

Platform Support

* All Platforms::
* Windows: Windows<43>.
* macOS: macOS<18>.

Windows

* Subprocess Support on Windows::

High-level API Index

* Tasks::
* Queues: Queues<2>.
* Subprocesses: Subprocesses<2>.
* Streams: Streams<2>.
* Synchronization::
* Exceptions: Exceptions<10>.

Low-level API Index

* Obtaining the Event Loop::
* Event Loop Methods: Event Loop Methods<2>.
* Transports: Transports<2>.
* Protocols: Protocols<2>.
* Event Loop Policies::

Developing with asyncio

* Debug Mode::
* Concurrency and Multithreading::
* Running Blocking Code::
* Logging: Logging<3>.
* Detect never-awaited coroutines::
* Detect never-retrieved exceptions::

socket — Low-level networking interface

* Socket families::
* Module contents::
* Socket Objects::
* Notes on socket timeouts::
* Example: Example<8>.

Module contents

* Exceptions: Exceptions<11>.
* Constants: Constants<8>.
* Functions: Functions<5>.

Functions

* Creating sockets::
* Other functions: Other functions<2>.

Notes on socket timeouts

* Timeouts and the connect method::
* Timeouts and the accept method::

ssl — TLS/SSL wrapper for socket objects

* Functions, Constants, and Exceptions: Functions Constants and Exceptions.
* SSL Sockets::
* SSL Contexts::
* Certificates::
* Examples: Examples<16>.
* Notes on non-blocking sockets::
* Memory BIO Support: Memory BIO Support<2>.
* SSL session::
* Security considerations::
* TLS 1.3: TLS 1 3.
* LibreSSL support::

Functions, Constants, and Exceptions

* Socket creation::
* Context creation::
* Exceptions: Exceptions<12>.
* Random generation::
* Certificate handling::
* Constants: Constants<9>.

Certificates

* Certificate chains::
* CA certificates::
* Combined key and certificate::
* Self-signed certificates::

Examples

* Testing for SSL support::
* Client-side operation::
* Server-side operation::

Security considerations

* Best defaults::
* Manual settings::
* Multi-processing::

Manual settings

* Verifying certificates::
* Protocol versions::
* Cipher selection::

select — Waiting for I/O completion

* /dev/poll Polling Objects::
* Edge and Level Trigger Polling (epoll) Objects: Edge and Level Trigger Polling epoll Objects.
* Polling Objects::
* Kqueue Objects::
* Kevent Objects::

selectors — High-level I/O multiplexing

* Introduction: Introduction<9>.
* Classes: Classes<3>.
* Examples: Examples<17>.

asyncore — Asynchronous socket handler

* asyncore Example basic HTTP client::
* asyncore Example basic echo server::

asynchat — Asynchronous socket command/response handler

* asynchat Example::

signal — Set handlers for asynchronous events

* General rules::
* Module contents: Module contents<2>.
* Example: Example<9>.
* Note on SIGPIPE::

General rules

* Execution of Python signal handlers::
* Signals and threads::

mmap — Memory-mapped file support

* MADV_* Constants::

Internet Data Handling

* email — An email and MIME handling package::
* json — JSON encoder and decoder::
* mailcap — Mailcap file handling::
* mailbox — Manipulate mailboxes in various formats::
* mimetypes — Map filenames to MIME types::
* base64 — Base16, Base32, Base64, Base85 Data Encodings: base64 — Base16 Base32 Base64 Base85 Data Encodings.
* binhex — Encode and decode binhex4 files::
* binascii — Convert between binary and ASCII::
* quopri — Encode and decode MIME quoted-printable data::
* uu — Encode and decode uuencode files::

email — An email and MIME handling package

* email.message; Representing an email message: email message Representing an email message.
* email.parser; Parsing email messages: email parser Parsing email messages.
* email.generator; Generating MIME documents: email generator Generating MIME documents.
* email.policy; Policy Objects: email policy Policy Objects.
* email.errors; Exception and Defect classes: email errors Exception and Defect classes.
* email.headerregistry; Custom Header Objects: email headerregistry Custom Header Objects.
* email.contentmanager; Managing MIME Content: email contentmanager Managing MIME Content.
* email; Examples: email Examples.
* email.message.Message; Representing an email message using the compat32 API: email message Message Representing an email message using the compat32 API.
* email.mime; Creating email and MIME objects from scratch: email mime Creating email and MIME objects from scratch.
* email.header; Internationalized headers: email header Internationalized headers.
* email.charset; Representing character sets: email charset Representing character sets.
* email.encoders; Encoders: email encoders Encoders.
* email.utils; Miscellaneous utilities: email utils Miscellaneous utilities.
* email.iterators; Iterators: email iterators Iterators.

email.parser: Parsing email messages

* FeedParser API::
* Parser API::
* Additional notes::

email.contentmanager: Managing MIME Content

* Content Manager Instances::

json — JSON encoder and decoder

* Basic Usage::
* Encoders and Decoders::
* Exceptions: Exceptions<13>.
* Standard Compliance and Interoperability::
* Command Line Interface: Command Line Interface<2>.

Standard Compliance and Interoperability

* Character Encodings::
* Infinite and NaN Number Values::
* Repeated Names Within an Object::
* Top-level Non-Object, Non-Array Values: Top-level Non-Object Non-Array Values.
* Implementation Limitations::

Command Line Interface

* Command line options: Command line options<2>.

mailbox — Manipulate mailboxes in various formats

* Mailbox objects::
* Message objects::
* Exceptions: Exceptions<14>.
* Examples: Examples<18>.

Mailbox objects

* Maildir::
* mbox::
* MH::
* Babyl::
* MMDF::

Message objects

* MaildirMessage::
* mboxMessage::
* MHMessage::
* BabylMessage::
* MMDFMessage::

mimetypes — Map filenames to MIME types

* MimeTypes Objects::

binhex — Encode and decode binhex4 files

* Notes: Notes<2>.

Structured Markup Processing Tools

* html — HyperText Markup Language support::
* html.parser — Simple HTML and XHTML parser: html parser — Simple HTML and XHTML parser.
* html.entities — Definitions of HTML general entities: html entities — Definitions of HTML general entities.
* XML Processing Modules::
* xml.etree.ElementTree — The ElementTree XML API: xml etree ElementTree — The ElementTree XML API.
* xml.dom — The Document Object Model API: xml dom — The Document Object Model API.
* xml.dom.minidom — Minimal DOM implementation: xml dom minidom — Minimal DOM implementation.
* xml.dom.pulldom — Support for building partial DOM trees: xml dom pulldom — Support for building partial DOM trees.
* xml.sax — Support for SAX2 parsers: xml sax — Support for SAX2 parsers.
* xml.sax.handler — Base classes for SAX handlers: xml sax handler — Base classes for SAX handlers.
* xml.sax.saxutils — SAX Utilities: xml sax saxutils — SAX Utilities.
* xml.sax.xmlreader — Interface for XML parsers: xml sax xmlreader — Interface for XML parsers.
* xml.parsers.expat — Fast XML parsing using Expat: xml parsers expat — Fast XML parsing using Expat.

html.parser — Simple HTML and XHTML parser

* Example HTML Parser Application::
* HTMLParser Methods::
* Examples: Examples<19>.

XML Processing Modules

* XML vulnerabilities::
* The defusedxml and defusedexpat Packages::

xml.etree.ElementTree — The ElementTree XML API

* Tutorial::
* XPath support::
* Reference: Reference<2>.
* XInclude support::
* Reference: Reference<3>.

Tutorial

* XML tree and elements::
* Parsing XML::
* Pull API for non-blocking parsing::
* Finding interesting elements::
* Modifying an XML File::
* Building XML documents::
* Parsing XML with Namespaces::
* Additional resources::

XPath support

* Example: Example<10>.
* Supported XPath syntax::

Reference

* Functions: Functions<6>.

XInclude support

* Example: Example<11>.

Reference

* Functions: Functions<7>.
* Element Objects::
* ElementTree Objects::
* QName Objects::
* TreeBuilder Objects::
* XMLParser Objects::
* XMLPullParser Objects::
* Exceptions: Exceptions<15>.

xml.dom — The Document Object Model API

* Module Contents: Module Contents<4>.
* Objects in the DOM::
* Conformance::

Objects in the DOM

* DOMImplementation Objects::
* Node Objects::
* NodeList Objects::
* DocumentType Objects::
* Document Objects::
* Element Objects: Element Objects<2>.
* Attr Objects::
* NamedNodeMap Objects::
* Comment Objects::
* Text and CDATASection Objects::
* ProcessingInstruction Objects::
* Exceptions: Exceptions<16>.

Conformance

* Type Mapping::
* Accessor Methods::

xml.dom.minidom — Minimal DOM implementation

* DOM Objects::
* DOM Example::
* minidom and the DOM standard::

xml.dom.pulldom — Support for building partial DOM trees

* DOMEventStream Objects::

xml.sax — Support for SAX2 parsers

* SAXException Objects::

xml.sax.handler — Base classes for SAX handlers

* ContentHandler Objects::
* DTDHandler Objects::
* EntityResolver Objects::
* ErrorHandler Objects::

xml.sax.xmlreader — Interface for XML parsers

* XMLReader Objects::
* IncrementalParser Objects::
* Locator Objects::
* InputSource Objects::
* The Attributes Interface::
* The AttributesNS Interface::

xml.parsers.expat — Fast XML parsing using Expat

* XMLParser Objects: XMLParser Objects<2>.
* ExpatError Exceptions::
* Example: Example<12>.
* Content Model Descriptions::
* Expat error constants::

Internet Protocols and Support

* webbrowser — Convenient Web-browser controller::
* cgi — Common Gateway Interface support::
* cgitb — Traceback manager for CGI scripts::
* wsgiref — WSGI Utilities and Reference Implementation::
* urllib — URL handling modules::
* urllib.request — Extensible library for opening URLs: urllib request — Extensible library for opening URLs.
* urllib.response — Response classes used by urllib: urllib response — Response classes used by urllib.
* urllib.parse — Parse URLs into components: urllib parse — Parse URLs into components.
* urllib.error — Exception classes raised by urllib.request: urllib error — Exception classes raised by urllib request.
* urllib.robotparser — Parser for robots.txt: urllib robotparser — Parser for robots txt.
* http — HTTP modules::
* http.client — HTTP protocol client: http client — HTTP protocol client.
* ftplib — FTP protocol client::
* poplib — POP3 protocol client::
* imaplib — IMAP4 protocol client::
* nntplib — NNTP protocol client::
* smtplib — SMTP protocol client::
* smtpd — SMTP Server::
* telnetlib — Telnet client::
* uuid — UUID objects according to RFC 4122::
* socketserver — A framework for network servers::
* http.server — HTTP servers: http server — HTTP servers.
* http.cookies — HTTP state management: http cookies — HTTP state management.
* http.cookiejar — Cookie handling for HTTP clients: http cookiejar — Cookie handling for HTTP clients.
* xmlrpc — XMLRPC server and client modules::
* xmlrpc.client — XML-RPC client access: xmlrpc client — XML-RPC client access.
* xmlrpc.server — Basic XML-RPC servers: xmlrpc server — Basic XML-RPC servers.
* ipaddress — IPv4/IPv6 manipulation library::

webbrowser — Convenient Web-browser controller

* Browser Controller Objects::

cgi — Common Gateway Interface support

* Introduction: Introduction<10>.
* Using the cgi module::
* Higher Level Interface::
* Functions: Functions<8>.
* Caring about security::
* Installing your CGI script on a Unix system::
* Testing your CGI script::
* Debugging CGI scripts::
* Common problems and solutions::

wsgiref — WSGI Utilities and Reference Implementation

* wsgiref.util – WSGI environment utilities: wsgiref util – WSGI environment utilities.
* wsgiref.headers – WSGI response header tools: wsgiref headers – WSGI response header tools.
* wsgiref.simple_server – a simple WSGI HTTP server: wsgiref simple_server – a simple WSGI HTTP server.
* wsgiref.validate — WSGI conformance checker: wsgiref validate — WSGI conformance checker.
* wsgiref.handlers – server/gateway base classes: wsgiref handlers – server/gateway base classes.
* Examples: Examples<20>.

urllib.request — Extensible library for opening URLs

* Request Objects::
* OpenerDirector Objects::
* BaseHandler Objects::
* HTTPRedirectHandler Objects::
* HTTPCookieProcessor Objects::
* ProxyHandler Objects::
* HTTPPasswordMgr Objects::
* HTTPPasswordMgrWithPriorAuth Objects::
* AbstractBasicAuthHandler Objects::
* HTTPBasicAuthHandler Objects::
* ProxyBasicAuthHandler Objects::
* AbstractDigestAuthHandler Objects::
* HTTPDigestAuthHandler Objects::
* ProxyDigestAuthHandler Objects::
* HTTPHandler Objects::
* HTTPSHandler Objects::
* FileHandler Objects::
* DataHandler Objects::
* FTPHandler Objects::
* CacheFTPHandler Objects::
* UnknownHandler Objects::
* HTTPErrorProcessor Objects::
* Examples: Examples<21>.
* Legacy interface::
* urllib.request Restrictions: urllib request Restrictions.

urllib.parse — Parse URLs into components

* URL Parsing::
* Parsing ASCII Encoded Bytes::
* Structured Parse Results::
* URL Quoting::

http — HTTP modules

* HTTP status codes::

http.client — HTTP protocol client

* HTTPConnection Objects::
* HTTPResponse Objects::
* Examples: Examples<22>.
* HTTPMessage Objects::

ftplib — FTP protocol client

* FTP Objects::
* FTP_TLS Objects::

poplib — POP3 protocol client

* POP3 Objects::
* POP3 Example::

imaplib — IMAP4 protocol client

* IMAP4 Objects::
* IMAP4 Example::

nntplib — NNTP protocol client

* NNTP Objects::
* Utility functions: Utility functions<2>.

NNTP Objects

* Attributes::
* Methods: Methods<3>.

smtplib — SMTP protocol client

* SMTP Objects::
* SMTP Example::

smtpd — SMTP Server

* SMTPServer Objects::
* DebuggingServer Objects::
* PureProxy Objects::
* MailmanProxy Objects::
* SMTPChannel Objects::

telnetlib — Telnet client

* Telnet Objects::
* Telnet Example::

uuid — UUID objects according to RFC 4122

* Example: Example<13>.

socketserver — A framework for network servers

* Server Creation Notes::
* Server Objects: Server Objects<2>.
* Request Handler Objects::
* Examples: Examples<23>.

Examples

* socketserver.TCPServer Example: socketserver TCPServer Example.
* socketserver.UDPServer Example: socketserver UDPServer Example.
* Asynchronous Mixins::

http.cookies — HTTP state management

* Cookie Objects::
* Morsel Objects::
* Example: Example<14>.

http.cookiejar — Cookie handling for HTTP clients

* CookieJar and FileCookieJar Objects::
* FileCookieJar subclasses and co-operation with web browsers::
* CookiePolicy Objects::
* DefaultCookiePolicy Objects::
* Cookie Objects: Cookie Objects<2>.
* Examples: Examples<24>.

xmlrpc.client — XML-RPC client access

* ServerProxy Objects::
* DateTime Objects::
* Binary Objects::
* Fault Objects::
* ProtocolError Objects::
* MultiCall Objects::
* Convenience Functions::
* Example of Client Usage::
* Example of Client and Server Usage::

xmlrpc.server — Basic XML-RPC servers

* SimpleXMLRPCServer Objects::
* CGIXMLRPCRequestHandler::
* Documenting XMLRPC server::
* DocXMLRPCServer Objects::
* DocCGIXMLRPCRequestHandler::

SimpleXMLRPCServer Objects

* SimpleXMLRPCServer Example::

ipaddress — IPv4/IPv6 manipulation library

* Convenience factory functions::
* IP Addresses::
* IP Network definitions::
* Interface objects::
* Other Module Level Functions::
* Custom Exceptions::

IP Addresses

* Address objects::
* Conversion to Strings and Integers::
* Operators: Operators<3>.

Operators

* Comparison operators::
* Arithmetic operators::

IP Network definitions

* Prefix, net mask and host mask: Prefix net mask and host mask.
* Network objects::
* Operators: Operators<4>.

Operators

* Logical operators::
* Iteration: Iteration<2>.
* Networks as containers of addresses::

Interface objects

* Operators: Operators<5>.

Operators

* Logical operators: Logical operators<2>.

Multimedia Services

* audioop — Manipulate raw audio data::
* aifc — Read and write AIFF and AIFC files::
* sunau — Read and write Sun AU files::
* wave — Read and write WAV files::
* chunk — Read IFF chunked data::
* colorsys — Conversions between color systems::
* imghdr — Determine the type of an image::
* sndhdr — Determine type of sound file::
* ossaudiodev — Access to OSS-compatible audio devices::

sunau — Read and write Sun AU files

* AU_read Objects::
* AU_write Objects::

wave — Read and write WAV files

* Wave_read Objects::
* Wave_write Objects::

ossaudiodev — Access to OSS-compatible audio devices

* Audio Device Objects::
* Mixer Device Objects::

Internationalization

* gettext — Multilingual internationalization services::
* locale — Internationalization services::

gettext — Multilingual internationalization services

* GNU gettext API::
* Class-based API::
* Internationalizing your programs and modules::
* Acknowledgements: Acknowledgements<9>.

Class-based API

* The NullTranslations class::
* The GNUTranslations class::
* Solaris message catalog support::
* The Catalog constructor::

Internationalizing your programs and modules

* Localizing your module::
* Localizing your application::
* Changing languages on the fly::
* Deferred translations::

locale — Internationalization services

* Background, details, hints, tips and caveats: Background details hints tips and caveats.
* For extension writers and programs that embed Python::
* Access to message catalogs::

Program Frameworks

* turtle — Turtle graphics::
* cmd — Support for line-oriented command interpreters::
* shlex — Simple lexical analysis::

turtle — Turtle graphics

* Introduction: Introduction<11>.
* Overview of available Turtle and Screen methods::
* Methods of RawTurtle/Turtle and corresponding functions::
* Methods of TurtleScreen/Screen and corresponding functions::
* Public classes::
* Help and configuration::
* turtledemo — Demo scripts::
* Changes since Python 2.6: Changes since Python 2 6.
* Changes since Python 3.0: Changes since Python 3 0.

Overview of available Turtle and Screen methods

* Turtle methods::
* Methods of TurtleScreen/Screen::

Methods of RawTurtle/Turtle and corresponding functions

* Turtle motion::
* Tell Turtle’s state::
* Settings for measurement::
* Pen control::
* Turtle state::
* Using events::
* Special Turtle methods::
* Compound shapes::

Pen control

* Drawing state::
* Color control::
* Filling::
* More drawing control::

Turtle state

* Visibility::
* Appearance::

Methods of TurtleScreen/Screen and corresponding functions

* Window control::
* Animation control::
* Using screen events::
* Input methods::
* Settings and special methods::
* Methods specific to Screen, not inherited from TurtleScreen: Methods specific to Screen not inherited from TurtleScreen.

Help and configuration

* How to use help::
* Translation of docstrings into different languages::
* How to configure Screen and Turtles::

cmd — Support for line-oriented command interpreters

* Cmd Objects::
* Cmd Example::

shlex — Simple lexical analysis

* shlex Objects::
* Parsing Rules::
* Improved Compatibility with Shells::

Graphical User Interfaces with Tk

* tkinter — Python interface to Tcl/Tk::
* tkinter.ttk — Tk themed widgets: tkinter ttk — Tk themed widgets.
* tkinter.tix — Extension widgets for Tk: tkinter tix — Extension widgets for Tk.
* tkinter.scrolledtext — Scrolled Text Widget: tkinter scrolledtext — Scrolled Text Widget.
* IDLE: IDLE<41>.
* Other Graphical User Interface Packages::

tkinter — Python interface to Tcl/Tk

* Tkinter Modules::
* Tkinter Life Preserver::
* A (Very) Quick Look at Tcl/Tk: A Very Quick Look at Tcl/Tk.
* Mapping Basic Tk into Tkinter::
* How Tk and Tkinter are Related::
* Handy Reference::
* File Handlers::

Tkinter Life Preserver

* How To Use This Section::
* A Simple Hello World Program::

Handy Reference

* Setting Options::
* The Packer::
* Packer Options::
* Coupling Widget Variables::
* The Window Manager::
* Tk Option Data Types::
* Bindings and Events::
* The index Parameter::
* Images::

tkinter.ttk — Tk themed widgets

* Using Ttk::
* Ttk Widgets::
* Widget::
* Combobox::
* Spinbox::
* Notebook::
* Progressbar::
* Separator::
* Sizegrip::
* Treeview::
* Ttk Styling::

Widget

* Standard Options::
* Scrollable Widget Options::
* Label Options::
* Compatibility Options::
* Widget States::
* ttk.Widget: ttk Widget.

Combobox

* Options::
* Virtual events::
* ttk.Combobox: ttk Combobox.

Spinbox

* Options: Options<2>.
* Virtual events: Virtual events<2>.
* ttk.Spinbox: ttk Spinbox.

Notebook

* Options: Options<3>.
* Tab Options::
* Tab Identifiers::
* Virtual Events::
* ttk.Notebook: ttk Notebook.

Progressbar

* Options: Options<4>.
* ttk.Progressbar: ttk Progressbar.

Separator

* Options: Options<5>.

Sizegrip

* Platform-specific notes::
* Bugs::

Treeview

* Options: Options<6>.
* Item Options::
* Tag Options::
* Column Identifiers::
* Virtual Events: Virtual Events<2>.
* ttk.Treeview: ttk Treeview.

Ttk Styling

* Layouts::

tkinter.tix — Extension widgets for Tk

* Using Tix::
* Tix Widgets::
* Tix Commands::

Tix Widgets

* Basic Widgets::
* File Selectors::
* Hierarchical ListBox::
* Tabular ListBox::
* Manager Widgets::
* Image Types::
* Miscellaneous Widgets::
* Form Geometry Manager::

IDLE

* Menus::
* Editing and navigation::
* Startup and code execution::
* Help and preferences::

Menus

* File menu (Shell and Editor): File menu Shell and Editor.
* Edit menu (Shell and Editor): Edit menu Shell and Editor.
* Format menu (Editor window only): Format menu Editor window only.
* Run menu (Editor window only): Run menu Editor window only.
* Shell menu (Shell window only): Shell menu Shell window only.
* Debug menu (Shell window only): Debug menu Shell window only.
* Options menu (Shell and Editor): Options menu Shell and Editor.
* Window menu (Shell and Editor): Window menu Shell and Editor.
* Help menu (Shell and Editor): Help menu Shell and Editor.
* Context Menus::

Editing and navigation

* Editor windows::
* Key bindings::
* Automatic indentation::
* Completions::
* Calltips::
* Code Context::
* Python Shell window::
* Text colors::

Startup and code execution

* Command line usage::
* Startup failure::
* Running user code::
* User output in Shell::
* Developing tkinter applications::
* Running without a subprocess::

Help and preferences

* Help sources::
* Setting preferences::
* IDLE on macOS::
* Extensions::

Development Tools

* typing — Support for type hints::
* pydoc — Documentation generator and online help system::
* doctest — Test interactive Python examples::
* unittest — Unit testing framework::
* unittest.mock — mock object library: unittest mock — mock object library.
* unittest.mock — getting started: unittest mock — getting started.
* 2to3 - Automated Python 2 to 3 code translation::
* test — Regression tests package for Python::
* test.support — Utilities for the Python test suite: test support — Utilities for the Python test suite.
* test.support.script_helper — Utilities for the Python execution tests: test support script_helper — Utilities for the Python execution tests.

typing — Support for type hints

* Type aliases::
* NewType::
* Callable::
* Generics::
* User-defined generic types::
* The Any type::
* Nominal vs structural subtyping::
* Classes, functions, and decorators: Classes functions and decorators.

doctest — Test interactive Python examples

* Simple Usage; Checking Examples in Docstrings: Simple Usage Checking Examples in Docstrings.
* Simple Usage; Checking Examples in a Text File: Simple Usage Checking Examples in a Text File.
* How It Works::
* Basic API::
* Unittest API::
* Advanced API::
* Debugging::
* Soapbox::

How It Works

* Which Docstrings Are Examined?::
* How are Docstring Examples Recognized?::
* What’s the Execution Context?::
* What About Exceptions?::
* Option Flags::
* Directives::
* Warnings: Warnings<2>.

Advanced API

* DocTest Objects::
* Example Objects::
* DocTestFinder objects::
* DocTestParser objects::
* DocTestRunner objects::
* OutputChecker objects::

unittest — Unit testing framework

* Basic example::
* Command-Line Interface: Command-Line Interface<3>.
* Test Discovery::
* Organizing test code::
* Re-using old test code::
* Skipping tests and expected failures::
* Distinguishing test iterations using subtests::
* Classes and functions::
* Class and Module Fixtures::
* Signal Handling::

Command-Line Interface

* Command-line options: Command-line options<3>.

Classes and functions

* Test cases::
* Grouping tests::
* Loading and running tests::

Test cases

* Deprecated aliases::

Loading and running tests

* load_tests Protocol::

Class and Module Fixtures

* setUpClass and tearDownClass::
* setUpModule and tearDownModule::

unittest.mock — mock object library

* Quick Guide::
* The Mock Class::
* The patchers::
* MagicMock and magic method support::
* Helpers::

The Mock Class

* Calling::
* Deleting Attributes::
* Mock names and the name attribute::
* Attaching Mocks as Attributes::

The patchers

* patch::
* patch.object: patch object.
* patch.dict: patch dict.
* patch.multiple: patch multiple.
* patch methods; start and stop: patch methods start and stop.
* patch builtins::
* TEST_PREFIX::
* Nesting Patch Decorators::
* Where to patch::
* Patching Descriptors and Proxy Objects::

MagicMock and magic method support

* Mocking Magic Methods::
* Magic Mock::

Helpers

* sentinel::
* DEFAULT::
* call::
* create_autospec::
* ANY::
* FILTER_DIR::
* mock_open::
* Autospeccing::
* Sealing mocks::

unittest.mock — getting started

* Using Mock::
* Patch Decorators::
* Further Examples::

Using Mock

* Mock Patching Methods::
* Mock for Method Calls on an Object::
* Mocking Classes::
* Naming your mocks::
* Tracking all Calls::
* Setting Return Values and Attributes::
* Raising exceptions with mocks::
* Side effect functions and iterables::
* Mocking asynchronous iterators::
* Mocking asynchronous context manager::
* Creating a Mock from an Existing Object::

Further Examples

* Mocking chained calls::
* Partial mocking::
* Mocking a Generator Method::
* Applying the same patch to every test method::
* Mocking Unbound Methods::
* Checking multiple calls with mock::
* Coping with mutable arguments::
* Nesting Patches::
* Mocking a dictionary with MagicMock::
* Mock subclasses and their attributes::
* Mocking imports with patch.dict: Mocking imports with patch dict.
* Tracking order of calls and less verbose call assertions::
* More complex argument matching::

2to3 - Automated Python 2 to 3 code translation

* Using 2to3::
* Fixers::
* lib2to3 - 2to3’s library::

test — Regression tests package for Python

* Writing Unit Tests for the test package::
* Running tests using the command-line interface::

Debugging and Profiling

* Audit events table::
* bdb — Debugger framework::
* faulthandler — Dump the Python traceback::
* pdb — The Python Debugger::
* The Python Profilers::
* timeit — Measure execution time of small code snippets::
* trace — Trace or track Python statement execution::
* tracemalloc — Trace memory allocations::

faulthandler — Dump the Python traceback

* Dumping the traceback::
* Fault handler state::
* Dumping the tracebacks after a timeout::
* Dumping the traceback on a user signal::
* Issue with file descriptors::
* Example: Example<15>.

pdb — The Python Debugger

* Debugger Commands::

The Python Profilers

* Introduction to the profilers::
* Instant User’s Manual::
* profile and cProfile Module Reference::
* The Stats Class::
* What Is Deterministic Profiling?::
* Limitations::
* Calibration::
* Using a custom timer::

timeit — Measure execution time of small code snippets

* Basic Examples: Basic Examples<2>.
* Python Interface::
* Command-Line Interface: Command-Line Interface<4>.
* Examples: Examples<25>.

trace — Trace or track Python statement execution

* Command-Line Usage::
* Programmatic Interface::

Command-Line Usage

* Main options::
* Modifiers::
* Filters::

tracemalloc — Trace memory allocations

* Examples: Examples<26>.
* API::

Examples

* Display the top 10::
* Compute differences::
* Get the traceback of a memory block::
* Pretty top::

API

* Functions: Functions<9>.
* DomainFilter::
* Filter::
* Frame::
* Snapshot::
* Statistic::
* StatisticDiff::
* Trace::
* Traceback::

Software Packaging and Distribution

* distutils — Building and installing Python modules::
* ensurepip — Bootstrapping the pip installer::
* venv — Creation of virtual environments::
* zipapp — Manage executable Python zip archives::

ensurepip — Bootstrapping the pip installer

* Command line interface::
* Module API::

venv — Creation of virtual environments

* Creating virtual environments::
* API: API<2>.
* An example of extending EnvBuilder::

zipapp — Manage executable Python zip archives

* Basic Example::
* Command-Line Interface: Command-Line Interface<5>.
* Python API::
* Examples: Examples<27>.
* Specifying the Interpreter::
* Creating Standalone Applications with zipapp::
* The Python Zip Application Archive Format::

Creating Standalone Applications with zipapp

* Making a Windows executable::
* Caveats::

Python Runtime Services

* sys — System-specific parameters and functions::
* sysconfig — Provide access to Python’s configuration information::
* builtins — Built-in objects::
* __main__ — Top-level script environment::
* warnings — Warning control::
* dataclasses — Data Classes::
* contextlib — Utilities for with-statement contexts::
* abc — Abstract Base Classes::
* atexit — Exit handlers::
* traceback — Print or retrieve a stack traceback::
* __future__ — Future statement definitions::
* gc — Garbage Collector interface::
* inspect — Inspect live objects::
* site — Site-specific configuration hook::

sysconfig — Provide access to Python’s configuration information

* Configuration variables::
* Installation paths::
* Other functions: Other functions<3>.
* Using sysconfig as a script::

warnings — Warning control

* Warning Categories::
* The Warnings Filter::
* Temporarily Suppressing Warnings::
* Testing Warnings::
* Updating Code For New Versions of Dependencies::
* Available Functions::
* Available Context Managers::

The Warnings Filter

* Describing Warning Filters::
* Default Warning Filter::
* Overriding the default filter::

dataclasses — Data Classes

* Module-level decorators, classes, and functions: Module-level decorators classes and functions.
* Post-init processing::
* Class variables::
* Init-only variables::
* Frozen instances::
* Inheritance: Inheritance<2>.
* Default factory functions::
* Mutable default values::
* Exceptions: Exceptions<17>.

contextlib — Utilities for with-statement contexts

* Utilities::
* Examples and Recipes: Examples and Recipes<2>.
* Single use, reusable and reentrant context managers: Single use reusable and reentrant context managers.

Examples and Recipes

* Supporting a variable number of context managers::
* Catching exceptions from __enter__ methods::
* Cleaning up in an __enter__ implementation::
* Replacing any use of try-finally and flag variables::
* Using a context manager as a function decorator::

Single use, reusable and reentrant context managers

* Reentrant context managers::
* Reusable context managers::

atexit — Exit handlers

* atexit Example::

traceback — Print or retrieve a stack traceback

* TracebackException Objects::
* StackSummary Objects::
* FrameSummary Objects::
* Traceback Examples::

inspect — Inspect live objects

* Types and members::
* Retrieving source code::
* Introspecting callables with the Signature object::
* Classes and functions: Classes and functions<2>.
* The interpreter stack::
* Fetching attributes statically::
* Current State of Generators and Coroutines::
* Code Objects Bit Flags::
* Command Line Interface: Command Line Interface<3>.

site — Site-specific configuration hook

* Readline configuration::
* Module contents: Module contents<3>.

Custom Python Interpreters

* code — Interpreter base classes::
* codeop — Compile Python code::

code — Interpreter base classes

* Interactive Interpreter Objects::
* Interactive Console Objects::

Importing Modules

* zipimport — Import modules from Zip archives::
* pkgutil — Package extension utility::
* modulefinder — Find modules used by a script::
* runpy — Locating and executing Python modules::
* importlib — The implementation of import::
* Using importlib.metadata: Using importlib metadata.

zipimport — Import modules from Zip archives

* zipimporter Objects::
* Examples: Examples<28>.

modulefinder — Find modules used by a script

* Example usage of ModuleFinder::

importlib — The implementation of import

* Introduction: Introduction<12>.
* Functions: Functions<10>.
* importlib.abc – Abstract base classes related to import: importlib abc – Abstract base classes related to import.
* importlib.resources – Resources: importlib resources – Resources.
* importlib.machinery – Importers and path hooks: importlib machinery – Importers and path hooks.
* importlib.util – Utility code for importers: importlib util – Utility code for importers.
* Examples: Examples<29>.

Examples

* Importing programmatically::
* Checking if a module can be imported::
* Importing a source file directly::
* Setting up an importer::
* Approximating importlib.import_module(): Approximating importlib import_module.

Using importlib.metadata

* Overview: Overview<2>.
* Functional API: Functional API<2>.
* Distributions::
* Extending the search algorithm::

Functional API

* Entry points::
* Distribution metadata::
* Distribution versions::
* Distribution files::
* Distribution requirements::

Python Language Services

* parser — Access Python parse trees::
* ast — Abstract Syntax Trees::
* symtable — Access to the compiler’s symbol tables::
* symbol — Constants used with Python parse trees::
* token — Constants used with Python parse trees::
* keyword — Testing for Python keywords::
* tokenize — Tokenizer for Python source::
* tabnanny — Detection of ambiguous indentation::
* pyclbr — Python class browser support::
* py_compile — Compile Python source files::
* compileall — Byte-compile Python libraries::
* dis — Disassembler for Python bytecode::
* pickletools — Tools for pickle developers::

parser — Access Python parse trees

* Creating ST Objects::
* Converting ST Objects::
* Queries on ST Objects::
* Exceptions and Error Handling::
* ST Objects::
* Example; Emulation of compile(): Example Emulation of compile.

ast — Abstract Syntax Trees

* Node classes::
* Abstract Grammar::
* ast Helpers::

symtable — Access to the compiler’s symbol tables

* Generating Symbol Tables::
* Examining Symbol Tables::

tokenize — Tokenizer for Python source

* Tokenizing Input::
* Command-Line Usage: Command-Line Usage<2>.
* Examples: Examples<30>.

pyclbr — Python class browser support

* Function Objects::
* Class Objects: Class Objects<2>.

compileall — Byte-compile Python libraries

* Command-line use::
* Public functions::

dis — Disassembler for Python bytecode

* Bytecode analysis::
* Analysis functions::
* Python Bytecode Instructions::
* Opcode collections::

pickletools — Tools for pickle developers

* Command line usage: Command line usage<2>.
* Programmatic Interface: Programmatic Interface<2>.

Command line usage

* Command line options: Command line options<3>.

Miscellaneous Services

* formatter — Generic output formatting::

formatter — Generic output formatting

* The Formatter Interface::
* Formatter Implementations::
* The Writer Interface::
* Writer Implementations::

MS Windows Specific Services

* msilib — Read and write Microsoft Installer files::
* msvcrt — Useful routines from the MS VC++ runtime::
* winreg — Windows registry access::
* winsound — Sound-playing interface for Windows::

msilib — Read and write Microsoft Installer files

* Database Objects::
* View Objects::
* Summary Information Objects::
* Record Objects::
* Errors::
* CAB Objects::
* Directory Objects::
* Features: Features<3>.
* GUI classes::
* Precomputed tables::

msvcrt — Useful routines from the MS VC++ runtime

* File Operations::
* Console I/O::
* Other Functions::

winreg — Windows registry access

* Functions: Functions<11>.
* Constants: Constants<10>.
* Registry Handle Objects::

Constants

* HKEY_* Constants::
* Access Rights::
* Value Types::

Access Rights

* 64-bit Specific::

Unix Specific Services

* posix — The most common POSIX system calls::
* pwd — The password database::
* spwd — The shadow password database::
* grp — The group database::
* crypt — Function to check Unix passwords::
* termios — POSIX style tty control::
* tty — Terminal control functions::
* pty — Pseudo-terminal utilities::
* fcntl — The fcntl and ioctl system calls::
* pipes — Interface to shell pipelines::
* resource — Resource usage information::
* nis — Interface to Sun’s NIS (Yellow Pages): nis — Interface to Sun’s NIS Yellow Pages.
* syslog — Unix syslog library routines::

posix — The most common POSIX system calls

* Large File Support::
* Notable Module Contents::

crypt — Function to check Unix passwords

* Hashing Methods::
* Module Attributes::
* Module Functions: Module Functions<2>.
* Examples: Examples<31>.

termios — POSIX style tty control

* Example: Example<16>.

pty — Pseudo-terminal utilities

* Example: Example<17>.

pipes — Interface to shell pipelines

* Template Objects::

resource — Resource usage information

* Resource Limits::
* Resource Usage::

syslog — Unix syslog library routines

* Examples: Examples<32>.

Examples

* Simple example::

Superseded Modules

* optparse — Parser for command line options::
* imp — Access the import internals::

optparse — Parser for command line options

* Background::
* Tutorial: Tutorial<2>.
* Reference Guide::
* Option Callbacks::
* Extending optparse::

Background

* Terminology::
* What are options for?::
* What are positional arguments for?::

Tutorial

* Understanding option actions::
* The store action::
* Handling boolean (flag) options: Handling boolean flag options.
* Other actions::
* Default values::
* Generating help::
* Printing a version string::
* How optparse handles errors::
* Putting it all together::

Generating help

* Grouping Options::

Reference Guide

* Creating the parser::
* Populating the parser::
* Defining options::
* Option attributes::
* Standard option actions::
* Standard option types::
* Parsing arguments: Parsing arguments<2>.
* Querying and manipulating your option parser::
* Conflicts between options::
* Cleanup: Cleanup<2>.
* Other methods::

Option Callbacks

* Defining a callback option::
* How callbacks are called::
* Raising errors in a callback::
* Callback example 1; trivial callback: Callback example 1 trivial callback.
* Callback example 2; check option order: Callback example 2 check option order.
* Callback example 3; check option order (generalized): Callback example 3 check option order generalized.
* Callback example 4; check arbitrary condition: Callback example 4 check arbitrary condition.
* Callback example 5; fixed arguments: Callback example 5 fixed arguments.
* Callback example 6; variable arguments: Callback example 6 variable arguments.

Extending optparse

* Adding new types::
* Adding new actions::

imp — Access the import internals

* Examples: Examples<33>.

Undocumented Modules

* Platform specific modules::

Extending and Embedding the Python Interpreter

* Recommended third party tools::
* Creating extensions without third party tools::
* Embedding the CPython runtime in a larger application::

Creating extensions without third party tools

* Extending Python with C or C++::
* Defining Extension Types; Tutorial: Defining Extension Types Tutorial.
* Defining Extension Types; Assorted Topics: Defining Extension Types Assorted Topics.
* Building C and C++ Extensions::
* Building C and C++ Extensions on Windows::

Extending Python with C or C++

* A Simple Example::
* Intermezzo; Errors and Exceptions: Intermezzo Errors and Exceptions.
* Back to the Example::
* The Module’s Method Table and Initialization Function::
* Compilation and Linkage::
* Calling Python Functions from C::
* Extracting Parameters in Extension Functions::
* Keyword Parameters for Extension Functions::
* Building Arbitrary Values::
* Reference Counts::
* Writing Extensions in C++::
* Providing a C API for an Extension Module::

Reference Counts

* Reference Counting in Python::
* Ownership Rules::
* Thin Ice::
* NULL Pointers::

Defining Extension Types: Tutorial

* The Basics::
* Adding data and methods to the Basic example::
* Providing finer control over data attributes::
* Supporting cyclic garbage collection::
* Subclassing other types::

Defining Extension Types: Assorted Topics

* Finalization and De-allocation::
* Object Presentation::
* Attribute Management::
* Object Comparison::
* Abstract Protocol Support::
* Weak Reference Support::
* More Suggestions::

Attribute Management

* Generic Attribute Management::
* Type-specific Attribute Management::

Building C and C++ Extensions

* Building C and C++ Extensions with distutils::
* Distributing your extension modules::

Building C and C++ Extensions on Windows

* A Cookbook Approach::
* Differences Between Unix and Windows::
* Using DLLs in Practice::

Embedding the CPython runtime in a larger application

* Embedding Python in Another Application::

Embedding Python in Another Application

* Very High Level Embedding::
* Beyond Very High Level Embedding; An overview: Beyond Very High Level Embedding An overview.
* Pure Embedding::
* Extending Embedded Python::
* Embedding Python in C++::
* Compiling and Linking under Unix-like systems::

Python/C API Reference Manual

* Introduction: Introduction<13>.
* Stable Application Binary Interface::
* The Very High Level Layer::
* Reference Counting::
* Exception Handling::
* Utilities: Utilities<2>.
* Abstract Objects Layer::
* Concrete Objects Layer::
* Initialization, Finalization, and Threads: Initialization Finalization and Threads.
* Python Initialization Configuration::
* Memory Management::
* Object Implementation Support::
* API and ABI Versioning::

Introduction

* Coding standards::
* Include Files::
* Useful macros::
* Objects, Types and Reference Counts: Objects Types and Reference Counts.
* Exceptions: Exceptions<18>.
* Embedding Python: Embedding Python<2>.
* Debugging Builds::

Objects, Types and Reference Counts

* Reference Counts: Reference Counts<2>.
* Types::

Reference Counts

* Reference Count Details::

Exception Handling

* Printing and clearing::
* Raising exceptions::
* Issuing warnings::
* Querying the error indicator::
* Signal Handling: Signal Handling<2>.
* Exception Classes::
* Exception Objects::
* Unicode Exception Objects::
* Recursion Control::
* Standard Exceptions::
* Standard Warning Categories::

Utilities

* Operating System Utilities::
* System Functions::
* Process Control::
* Importing Modules: Importing Modules<2>.
* Data marshalling support::
* Parsing arguments and building values::
* String conversion and formatting::
* Reflection::
* Codec registry and support functions::

Parsing arguments and building values

* Parsing arguments: Parsing arguments<3>.
* Building values::

Parsing arguments

* Strings and buffers::
* Numbers: Numbers<2>.
* Other objects::
* API Functions::

Codec registry and support functions

* Codec lookup API::
* Registry API for Unicode encoding error handlers::

Abstract Objects Layer

* Object Protocol::
* Number Protocol::
* Sequence Protocol::
* Mapping Protocol::
* Iterator Protocol::
* Buffer Protocol::
* Old Buffer Protocol::

Buffer Protocol

* Buffer structure::
* Buffer request types::
* Complex arrays::
* Buffer-related functions::

Buffer request types

* request-independent fields::
* readonly, format: readonly format.
* shape, strides, suboffsets: shape strides suboffsets.
* contiguity requests::
* compound requests::

Complex arrays

* NumPy-style; shape and strides: NumPy-style shape and strides.
* PIL-style; shape, strides and suboffsets: PIL-style shape strides and suboffsets.

Concrete Objects Layer

* Fundamental Objects::
* Numeric Objects::
* Sequence Objects::
* Container Objects::
* Function Objects: Function Objects<2>.
* Other Objects::

Fundamental Objects

* Type Objects: Type Objects<2>.
* The None Object::

Type Objects

* Creating Heap-Allocated Types::

Numeric Objects

* Integer Objects::
* Boolean Objects::
* Floating Point Objects::
* Complex Number Objects::

Complex Number Objects

* Complex Numbers as C Structures::
* Complex Numbers as Python Objects::

Sequence Objects

* Bytes Objects: Bytes Objects<2>.
* Byte Array Objects::
* Unicode Objects and Codecs::
* Tuple Objects::
* Struct Sequence Objects::
* List Objects::

Byte Array Objects

* Type check macros::
* Direct API functions::
* Macros::

Unicode Objects and Codecs

* Unicode Objects::
* Built-in Codecs::
* Methods and Slot Functions::

Unicode Objects

* Unicode Type::
* Unicode Character Properties::
* Creating and accessing Unicode strings::
* Deprecated Py_UNICODE APIs::
* Locale Encoding::
* File System Encoding::
* wchar_t Support::

Built-in Codecs

* Generic Codecs::
* UTF-8 Codecs::
* UTF-32 Codecs::
* UTF-16 Codecs::
* UTF-7 Codecs::
* Unicode-Escape Codecs::
* Raw-Unicode-Escape Codecs::
* Latin-1 Codecs::
* ASCII Codecs::
* Character Map Codecs::
* MBCS codecs for Windows::
* Methods & Slots::

Container Objects

* Dictionary Objects::
* Set Objects::

Function Objects

* Function Objects: Function Objects<3>.
* Instance Method Objects::
* Method Objects: Method Objects<2>.
* Cell Objects::
* Code Objects: Code Objects<2>.

Other Objects

* File Objects::
* Module Objects::
* Iterator Objects::
* Descriptor Objects::
* Slice Objects::
* Ellipsis Object::
* MemoryView objects::
* Weak Reference Objects: Weak Reference Objects<2>.
* Capsules: Capsules<2>.
* Generator Objects::
* Coroutine Objects: Coroutine Objects<2>.
* Context Variables Objects::
* DateTime Objects: DateTime Objects<2>.

Module Objects

* Initializing C modules::
* Module lookup::

Initializing C modules

* Single-phase initialization::
* Multi-phase initialization::
* Low-level module creation functions::
* Support functions::

Initialization, Finalization, and Threads

* Before Python Initialization::
* Global configuration variables::
* Initializing and finalizing the interpreter::
* Process-wide parameters::
* Thread State and the Global Interpreter Lock::
* Sub-interpreter support::
* Asynchronous Notifications::
* Profiling and Tracing::
* Advanced Debugger Support::
* Thread Local Storage Support::

Thread State and the Global Interpreter Lock

* Releasing the GIL from extension code::
* Non-Python created threads::
* Cautions about fork(): Cautions about fork.
* High-level API::
* Low-level API::

Sub-interpreter support

* Bugs and caveats::

Thread Local Storage Support

* Thread Specific Storage (TSS) API: Thread Specific Storage TSS API.
* Thread Local Storage (TLS) API: Thread Local Storage TLS API.

Thread Specific Storage (TSS) API

* Dynamic Allocation::
* Methods: Methods<4>.

Python Initialization Configuration

* PyWideStringList::
* PyStatus::
* PyPreConfig::
* Preinitialization with PyPreConfig::
* PyConfig::
* Initialization with PyConfig::
* Isolated Configuration::
* Python Configuration::
* Path Configuration::
* Py_RunMain(): Py_RunMain.
* Multi-Phase Initialization Private Provisional API::

Memory Management

* Overview: Overview<3>.
* Raw Memory Interface::
* Memory Interface::
* Object allocators::
* Default Memory Allocators::
* Customize Memory Allocators::
* The pymalloc allocator::
* tracemalloc C API::
* Examples: Examples<34>.

The pymalloc allocator

* Customize pymalloc Arena Allocator::

Object Implementation Support

* Allocating Objects on the Heap::
* Common Object Structures::
* Type Objects: Type Objects<3>.
* Number Object Structures::
* Mapping Object Structures::
* Sequence Object Structures::
* Buffer Object Structures::
* Async Object Structures::
* Slot Type typedefs::
* Examples: Examples<35>.
* Supporting Cyclic Garbage Collection::

Type Objects

* Quick Reference::
* PyTypeObject Definition::
* PyObject Slots::
* PyVarObject Slots::
* PyTypeObject Slots::
* Heap Types::

Quick Reference

* “tp slots”::
* sub-slots::
* slot typedefs::

Distributing Python Modules

* Key terms::
* Open source licensing and collaboration::
* Installing the tools::
* Reading the Python Packaging User Guide::
* How do I…?::

How do I…?

* … choose a name for my project?::
* … create and distribute binary extensions?::

Installing Python Modules

* Key terms: Key terms<2>.
* Basic usage::
* How do I …?::
* Common installation issues::

How do I …?

* … install pip in versions of Python prior to Python 3.4?: … install pip in versions of Python prior to Python 3 4?.
* … install packages just for the current user?::
* … install scientific Python packages?::
* … work with multiple versions of Python installed in parallel?::

Common installation issues

* Installing into the system Python on Linux::
* Pip not installed::
* Installing binary extensions::

Python HOWTOs

* Porting Python 2 Code to Python 3::
* Porting Extension Modules to Python 3::
* Curses Programming with Python::
* Descriptor HowTo Guide::
* Functional Programming HOWTO::
* Logging HOWTO::
* Logging Cookbook::
* Regular Expression HOWTO::
* Socket Programming HOWTO::
* Sorting HOW TO::
* Unicode HOWTO::
* HOWTO Fetch Internet Resources Using The urllib Package::
* Argparse Tutorial::
* An introduction to the ipaddress module::
* Argument Clinic How-To::
* Instrumenting CPython with DTrace and SystemTap::

Porting Python 2 Code to Python 3

* The Short Explanation::
* Details::

Details

* Drop support for Python 2.6 and older: Drop support for Python 2 6 and older.
* Make sure you specify the proper version support in your setup.py file: Make sure you specify the proper version support in your setup py file.
* 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.py file to denote Python 3 compatibility: Update your setup py file to denote Python 3 compatibility.
* Use continuous integration to stay compatible::
* Consider using optional static type checking::

Update your code

* Division::
* Text versus binary data::
* Use feature detection instead of version detection::

Curses Programming with Python

* What is curses?::
* Starting and ending a curses application::
* Windows and Pads::
* Displaying Text::
* User Input::
* For More Information::

What is curses?

* The Python curses module::

Displaying Text

* Attributes and Color::

Descriptor HowTo Guide

* Abstract::
* Definition and Introduction::
* Descriptor Protocol::
* Invoking Descriptors: Invoking Descriptors<2>.
* Descriptor Example::
* Properties::
* Functions and Methods::
* Static Methods and Class Methods::

Functional Programming HOWTO

* Introduction: Introduction<14>.
* Iterators: Iterators<2>.
* Generator expressions and list comprehensions::
* Generators: Generators<2>.
* Built-in functions::
* The itertools module::
* The functools module::
* Small functions and the lambda expression::
* Revision History and Acknowledgements::
* References: References<2>.

Introduction

* Formal provability::
* Modularity::
* Ease of debugging and testing::
* Composability::

Iterators

* Data Types That Support Iterators::

Generators

* Passing values into a generator::

The itertools module

* Creating new iterators::
* Calling functions on elements::
* Selecting elements::
* Combinatoric functions::
* Grouping elements::

The functools module

* The operator module::

References

* General::
* Python-specific::
* Python documentation::

Logging HOWTO

* Basic Logging Tutorial::
* Advanced Logging Tutorial::
* Logging Levels: Logging Levels<2>.
* Useful Handlers::
* Exceptions raised during logging::
* Using arbitrary objects as messages::
* Optimization::

Basic Logging Tutorial

* When to use logging::
* A simple example::
* Logging to a file::
* Logging from multiple modules::
* Logging variable data::
* Changing the format of displayed messages::
* Displaying the date/time in messages::
* Next Steps::

Advanced Logging Tutorial

* Logging Flow::
* Loggers::
* Handlers::
* Formatters::
* Configuring Logging::
* What happens if no configuration is provided::
* Configuring Logging for a Library::

Logging Levels

* Custom Levels::

Logging Cookbook

* Using logging in multiple modules::
* Logging from multiple threads::
* Multiple handlers and formatters::
* Logging to multiple destinations::
* Configuration server example::
* Dealing with handlers that block::
* 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::
* Use of alternative formatting styles::
* Customizing LogRecord::
* Subclassing QueueHandler - a ZeroMQ example::
* Subclassing QueueListener - a ZeroMQ example::
* An example dictionary-based configuration::
* Using a rotator and namer to customize log rotation processing::
* A more elaborate multiprocessing example::
* Inserting a BOM into messages sent to a SysLogHandler::
* Implementing structured logging::
* Customizing handlers with dictConfig(): Customizing handlers with dictConfig.
* Using particular formatting styles throughout your application::
* Configuring filters 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: Formatting times using UTC GMT via configuration.
* Using a context manager for selective logging::
* A CLI application starter template::
* A Qt GUI for logging::

Adding contextual information to your logging output

* Using LoggerAdapters to impart contextual information::
* Using Filters to impart contextual information::

Using LoggerAdapters to impart contextual information

* Using objects other than dicts to pass contextual information::

Logging to a single file from multiple processes

* Using concurrent.futures.ProcessPoolExecutor: Using concurrent futures ProcessPoolExecutor.

Using particular formatting styles throughout your application

* Using LogRecord factories::
* Using custom message objects::

Regular Expression HOWTO

* Introduction: Introduction<15>.
* Simple Patterns::
* Using Regular Expressions::
* More Pattern Power::
* Modifying Strings::
* Common Problems::
* Feedback::

Simple Patterns

* Matching Characters::
* Repeating Things::

Using Regular Expressions

* Compiling Regular Expressions::
* The Backslash Plague::
* Performing Matches::
* Module-Level Functions: Module-Level Functions<2>.
* Compilation Flags::

More Pattern Power

* More Metacharacters::
* Grouping::
* Non-capturing and Named Groups::
* Lookahead Assertions::

Modifying Strings

* Splitting Strings::
* Search and Replace::

Common Problems

* Use String Methods::
* match() versus search(): match versus search.
* Greedy versus Non-Greedy::
* Using re.VERBOSE: Using re VERBOSE.

Socket Programming HOWTO

* Sockets::
* Creating a Socket::
* Using a Socket::
* Disconnecting::
* Non-blocking Sockets::

Sockets

* History::

Creating a Socket

* IPC::

Using a Socket

* Binary Data::

Disconnecting

* When Sockets Die::

Sorting HOW TO

* Sorting Basics::
* Key Functions::
* Operator Module Functions::
* Ascending and Descending::
* Sort Stability and Complex Sorts::
* The Old Way Using Decorate-Sort-Undecorate::
* The Old Way Using the cmp Parameter::
* Odd and Ends::

Unicode HOWTO

* Introduction to Unicode::
* Python’s Unicode Support::
* Reading and Writing Unicode Data::
* Acknowledgements: Acknowledgements<10>.

Introduction to Unicode

* Definitions::
* Encodings::
* References: References<3>.

Python’s Unicode Support

* The String Type::
* Converting to Bytes::
* Unicode Literals in Python Source Code::
* Unicode Properties::
* Comparing Strings::
* Unicode Regular Expressions::
* References: References<4>.

Reading and Writing Unicode Data

* Unicode filenames::
* Tips for Writing Unicode-aware Programs::
* References: References<5>.

Tips for Writing Unicode-aware Programs

* Converting Between File Encodings::
* Files in an Unknown Encoding::

HOWTO Fetch Internet Resources Using The urllib Package

* Introduction: Introduction<16>.
* Fetching URLs::
* Handling Exceptions: Handling Exceptions<2>.
* info and geturl::
* Openers and Handlers::
* Basic Authentication::
* Proxies::
* Sockets and Layers::
* Footnotes::

Fetching URLs

* Data::
* Headers::

Handling Exceptions

* URLError::
* HTTPError::
* Wrapping it Up::

HTTPError

* Error Codes::

Wrapping it Up

* Number 1::
* Number 2::

Argparse Tutorial

* Concepts::
* The basics::
* Introducing Positional arguments::
* Introducing Optional arguments::
* Combining Positional and Optional arguments::
* Getting a little more advanced::
* Conclusion::

Introducing Optional arguments

* Short options::

Getting a little more advanced

* Conflicting options::

An introduction to the ipaddress module

* Creating Address/Network/Interface objects::
* Inspecting Address/Network/Interface Objects::
* Networks as lists of Addresses::
* Comparisons: Comparisons<4>.
* Using IP Addresses with other modules::
* Getting more detail when instance creation fails::

Creating Address/Network/Interface objects

* A Note on IP Versions::
* IP Host Addresses::
* Defining Networks::
* Host Interfaces::

Argument Clinic How-To

* The Goals Of Argument Clinic::
* Basic Concepts And Usage::
* Converting Your First Function::
* Advanced Topics::

Advanced Topics

* Symbolic default values::
* Renaming the C functions and variables generated by Argument Clinic::
* Converting functions using PyArg_UnpackTuple::
* Optional Groups::
* Using real Argument Clinic converters, instead of “legacy converters”: Using real Argument Clinic converters instead of “legacy converters”.
* Py_buffer::
* Advanced converters::
* Parameter default values::
* The NULL default value::
* Expressions specified as default values::
* Using a return converter::
* Cloning existing functions::
* Calling Python code::
* Using a “self converter”::
* Writing a custom converter::
* Writing a custom return converter::
* METH_O and METH_NOARGS::
* tp_new and tp_init functions::
* Changing and redirecting Clinic’s output::
* The #ifdef trick::
* Using Argument Clinic in Python files::

Instrumenting CPython with DTrace and SystemTap

* Enabling the static markers::
* Static DTrace probes::
* Static SystemTap markers::
* Available static markers::
* SystemTap Tapsets::
* Examples: Examples<36>.

Python Frequently Asked Questions

* General Python FAQ::
* Programming FAQ::
* Design and History FAQ::
* Library and Extension FAQ::
* Extending/Embedding FAQ::
* Python on Windows FAQ::
* Graphic User Interface FAQ::
* “Why is Python Installed on my Computer?” FAQ::

General Python FAQ

* General Information::
* Python in the real world::

General Information

* What is Python?::
* What is the Python Software Foundation?::
* Are there copyright restrictions on the use of Python?::
* Why was Python created in the first place?::
* What is Python good for?::
* How does the Python version numbering scheme work?::
* How do I obtain a copy of the Python source?::
* How do I get documentation on Python?::
* I’ve never programmed before. Is there a Python tutorial?: I’ve never programmed before Is there a Python tutorial?.
* Is there a newsgroup or mailing list devoted to Python?::
* How do I get a beta test version of Python?::
* How do I submit bug reports and patches for Python?::
* Are there any published articles about Python that I can reference?::
* Are there any books on Python?::
* Where in the world is www.python.org located?: Where in the world is www python org located?.
* Why is it called Python?::
* Do I have to like “Monty Python’s Flying Circus”?::

Python in the real world

* How stable is Python?::
* How many people are using Python?::
* Have any significant projects been done in Python?::
* What new developments are expected for Python in the future?::
* Is it reasonable to propose incompatible changes to Python?::
* Is Python a good language for beginning programmers?::

Programming FAQ

* General Questions::
* Core Language::
* Numbers and strings::
* Performance: Performance<4>.
* Sequences (Tuples/Lists): Sequences Tuples/Lists.
* Objects::
* Modules: Modules<3>.

General Questions

* Is there a source code level debugger with breakpoints, single-stepping, etc.?: Is there a source code level debugger with breakpoints single-stepping etc ?.
* Is there a tool to help find bugs or perform static analysis?::
* How can I create a stand-alone binary from a Python script?::
* Are there coding standards or a style guide for Python programs?::

Core Language

* Why am I getting an UnboundLocalError when the variable has a value?::
* What are the rules for local and global variables in Python?::
* Why do lambdas defined in a loop with different values all return the same result?::
* How do I share global variables across modules?::
* What are the “best practices” for using import in a module?::
* Why are default values shared between objects?::
* How can I pass optional or keyword parameters from one function to another?::
* What is the difference between arguments and parameters?::
* Why did changing list ‘y’ also change list ‘x’?::
* How do I write a function with output parameters (call by reference)?: How do I write a function with output parameters call by reference ?.
* How do you make a higher order function in Python?::
* How do I copy an object in Python?::
* How can I find the methods or attributes of an object?::
* How can my code discover the name of an object?::
* What’s up with the comma operator’s precedence?::
* Is there an equivalent of C’s “?;” ternary operator?: Is there an equivalent of C’s “? ” ternary operator?.
* Is it possible to write obfuscated one-liners in Python?::
* What does the slash(/) in the parameter list of a function mean?: What does the slash / in the parameter list of a function mean?.

Numbers and strings

* How do I specify hexadecimal and octal integers?::
* Why does -22 // 10 return -3?::
* How do I convert a string to a number?::
* How do I convert a number to a string?::
* How do I modify a string in place?::
* How do I use strings to call functions/methods?::
* Is there an equivalent to Perl’s chomp() for removing trailing newlines from strings?: Is there an equivalent to Perl’s chomp for removing trailing newlines from strings?.
* Is there a scanf() or sscanf() equivalent?: Is there a scanf or sscanf equivalent?.
* What does ‘UnicodeDecodeError’ or ‘UnicodeEncodeError’ error mean?::

Performance

* My program is too slow. How do I speed it up?: My program is too slow How do I speed it up?.
* What is the most efficient way to concatenate many strings together?::

Sequences (Tuples/Lists)

* How do I convert between tuples and lists?::
* What’s a negative index?::
* How do I iterate over a sequence in reverse order?::
* How do you remove duplicates from a list?::
* How do you make an array in Python?::
* How do I create a multidimensional list?::
* How do I apply a method to a sequence of objects?::
* Why does a_tuple[i] += [‘item’] raise an exception when the addition works?::
* I want to do a complicated sort; can you do a Schwartzian Transform in Python?: I want to do a complicated sort can you do a Schwartzian Transform in Python?.
* How can I sort one list by values from another list?::

Objects

* What is a class?::
* What is a method?::
* What is self?::
* How do I check if an object is an instance of a given class or of a subclass of it?::
* What is delegation?::
* How do I call a method defined in a base class from a derived class that overrides it?::
* How can I organize my code to make it easier to change the base class?::
* How do I create static class data and static class methods?::
* How can I overload constructors (or methods) in Python?: How can I overload constructors or methods in Python?.
* I try to use __spam and I get an error about _SomeClassName__spam.: I try to use __spam and I get an error about _SomeClassName__spam.
* My class defines __del__ but it is not called when I delete the object.: My class defines __del__ but it is not called when I delete the object.
* How do I get a list of all instances of a given class?::
* Why does the result of id() appear to be not unique?: Why does the result of id appear to be not unique?.

Modules

* How do I create a .pyc file?: How do I create a pyc file?.
* How do I find the current module name?::
* How can I have modules that mutually import each other?::
* __import__(‘x.y.z’) returns <module ‘x’>; how do I get z?: __import__ ‘x y z’ returns <module ‘x’>; how do I get z?.
* When I edit an imported module and reimport it, the changes don’t show up. Why does this happen?: When I edit an imported module and reimport it the changes don’t show up Why does this happen?.

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 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?: 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?: Can Python be compiled to machine code C or some other language?.
* How does Python manage memory?::
* Why doesn’t CPython use a more traditional garbage collection scheme?::
* Why isn’t all memory freed when CPython 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?: 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 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

* General Library Questions::
* Common tasks::
* Threads::
* Input and Output: Input and Output<2>.
* Network/Internet Programming::
* Databases::
* Mathematics and Numerics::

General Library Questions

* How do I find a module or application to perform task X?::
* Where is the math.py (socket.py, regex.py, etc.) source file?: Where is the math py socket py regex py etc source file?.
* How do I make a Python script executable on Unix?::
* Is there a curses/termcap package for Python?::
* Is there an equivalent to C’s onexit() in Python?: Is there an equivalent to C’s onexit in Python?.
* Why don’t my signal handlers work?::

Common tasks

* How do I test a Python program or component?::
* How do I create documentation from doc strings?::
* How do I get a single keypress at a time?::

Threads

* How do I program using threads?::
* None of my threads seem to run; why?: None of my threads seem to run why?.
* How do I parcel out work among a bunch of worker threads?::
* What kinds of global value mutation are thread-safe?::
* Can’t we get rid of the Global Interpreter Lock?::

Input and Output

* How do I delete a file? (And other file questions…): How do I delete a file? And other file questions….
* How do I copy a file?::
* How do I read (or write) binary data?: How do I read or write binary data?.
* I can’t seem to use os.read() on a pipe created with os.popen(); why?: I can’t seem to use os read on a pipe created with os popen ; why?.
* How do I access the serial (RS232) port?: How do I access the serial RS232 port?.
* Why doesn’t closing sys.stdout (stdin, stderr) really close it?: Why doesn’t closing sys stdout stdin stderr really close it?.

Network/Internet Programming

* What WWW tools are there for Python?::
* How can I mimic CGI form submission (METHOD=POST)?: How can I mimic CGI form submission METHOD=POST ?.
* What module should I use to help with generating HTML?::
* How do I send mail from a Python script?::
* How do I avoid blocking in the connect() method of a socket?: How do I avoid blocking in the connect method of a socket?.

Databases

* Are there any interfaces to database packages in Python?::
* How do you implement persistent objects in Python?::

Mathematics and Numerics

* How do I generate random numbers in Python?::

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 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 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?: I want to compile a Python module on my Linux system but some files are missing Why?.
* 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)?: Can I create an object class with some methods implemented in C and others in Python e g through inheritance ?.

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 *.pyd file the same as a DLL?: Is a * pyd file 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?::

Graphic User Interface FAQ

* General GUI Questions::
* What platform-independent GUI toolkits exist for Python?::
* What platform-specific GUI toolkits exist for Python?::
* Tkinter questions::

What platform-independent GUI toolkits exist for Python?

* Tkinter::
* wxWidgets::
* Qt::
* Gtk+::
* Kivy::
* FLTK::
* OpenGL::

Tkinter questions

* How do I freeze Tkinter applications?::
* Can I have Tk events handled while waiting for I/O?::
* I can’t get key bindings to work in Tkinter; why?: I can’t get key bindings to work in Tkinter why?.

“Why is Python Installed on my Computer?” FAQ

* What is Python?: What is Python?<2>.
* Why is Python installed on my machine?::
* Can I delete Python?::

About these documents

* Contributors to the Python Documentation::

Dealing with Bugs

* Documentation bugs::
* Using the Python issue tracker::
* Getting started contributing to Python yourself::

History and License

* History of the software::
* Terms and conditions for accessing or otherwise using Python::
* Licenses and Acknowledgements for Incorporated Software::

Terms and conditions for accessing or otherwise using Python

* PSF LICENSE AGREEMENT FOR PYTHON 3.8.1: PSF LICENSE AGREEMENT FOR PYTHON 3 8 1.
* BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0: BEOPEN COM LICENSE AGREEMENT FOR PYTHON 2 0.
* CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1: CNRI LICENSE AGREEMENT FOR PYTHON 1 6 1.
* CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2: CWI LICENSE AGREEMENT FOR PYTHON 0 9 0 THROUGH 1 2.

Licenses and Acknowledgements for Incorporated Software

* Mersenne Twister::
* Sockets: Sockets<2>.
* Asynchronous socket services::
* Cookie management::
* Execution tracing::
* UUencode and UUdecode functions::
* XML Remote Procedure Calls::
* test_epoll::
* Select kqueue::
* SipHash24::
* strtod and dtoa::
* OpenSSL::
* expat::
* libffi::
* zlib: zlib<3>.
* cfuhash::
* libmpdec::
* W3C C14N test suite::

Distributing Python Modules (Legacy version)

* An Introduction to Distutils::
* Writing the Setup Script::
* Writing the Setup Configuration File::
* Creating a Source Distribution::
* Creating Built Distributions::
* Distutils Examples::
* Extending Distutils::
* Command Reference::
* API Reference::

An Introduction to Distutils

* Concepts & Terminology::
* A Simple Example: A Simple Example<2>.
* General Python terminology::
* Distutils-specific terminology::

Writing the Setup Script

* Listing whole packages::
* Listing individual modules::
* Describing extension modules::
* Relationships between Distributions and Packages::
* Installing Scripts::
* Installing Package Data::
* Installing Additional Files::
* Additional meta-data::
* Debugging the setup script::

Describing extension modules

* Extension names and packages::
* Extension source files::
* Preprocessor options::
* Library options::
* Other options::

Creating a Source Distribution

* Specifying the files to distribute::
* Manifest-related options::

Creating Built Distributions

* Creating RPM packages::
* Creating Windows Installers::
* Cross-compiling on Windows::
* Vista User Access Control (UAC): Vista User Access Control UAC.

Cross-compiling on Windows

* The Postinstallation script::

Distutils Examples

* Pure Python distribution (by module): Pure Python distribution by module.
* Pure Python distribution (by package): Pure Python distribution by package.
* Single extension module::
* Checking a package::
* Reading the metadata::

Extending Distutils

* Integrating new commands::
* Adding new distribution types::

Command Reference

* Installing modules; the install command family: Installing modules the install command family.
* Creating a source distribution; the sdist command: Creating a source distribution the sdist command.

Installing modules: the install command family

* install_data::
* install_scripts::

API Reference

* distutils.core — Core Distutils functionality: distutils core — Core Distutils functionality.
* distutils.ccompiler — CCompiler base class: distutils ccompiler — CCompiler base class.
* distutils.unixccompiler — Unix C Compiler: distutils unixccompiler — Unix C Compiler.
* distutils.msvccompiler — Microsoft Compiler: distutils msvccompiler — Microsoft Compiler.
* distutils.bcppcompiler — Borland Compiler: distutils bcppcompiler — Borland Compiler.
* distutils.cygwincompiler — Cygwin Compiler: distutils cygwincompiler — Cygwin Compiler.
* distutils.archive_util — Archiving utilities: distutils archive_util — Archiving utilities.
* distutils.dep_util — Dependency checking: distutils dep_util — Dependency checking.
* distutils.dir_util — Directory tree operations: distutils dir_util — Directory tree operations.
* distutils.file_util — Single file operations: distutils file_util — Single file operations.
* distutils.util — Miscellaneous other utility functions: distutils util — Miscellaneous other utility functions.
* distutils.dist — The Distribution class: distutils dist — The Distribution class.
* distutils.extension — The Extension class: distutils extension — The Extension class.
* distutils.debug — Distutils debug mode: distutils debug — Distutils debug mode.
* distutils.errors — Distutils exceptions: distutils errors — Distutils exceptions.
* distutils.fancy_getopt — Wrapper around the standard getopt module: distutils fancy_getopt — Wrapper around the standard getopt module.
* distutils.filelist — The FileList class: distutils filelist — The FileList class.
* distutils.log — Simple PEP 282-style logging: distutils log — Simple PEP 282-style logging.
* distutils.spawn — Spawn a sub-process: distutils spawn — Spawn a sub-process.
* distutils.sysconfig — System configuration information: distutils sysconfig — System configuration information.
* distutils.text_file — The TextFile class: distutils text_file — The TextFile class.
* distutils.version — Version number classes: distutils version — Version number classes.
* distutils.cmd — Abstract base class for Distutils commands: distutils cmd — Abstract base class for Distutils commands.
* Creating a new Distutils command::
* distutils.command — Individual Distutils commands: distutils command — Individual Distutils commands.
* distutils.command.bdist — Build a binary installer: distutils command bdist — Build a binary installer.
* distutils.command.bdist_packager — Abstract base class for packagers: distutils command bdist_packager — Abstract base class for packagers.
* distutils.command.bdist_dumb — Build a “dumb” installer: distutils command bdist_dumb — Build a “dumb” installer.
* distutils.command.bdist_msi — Build a Microsoft Installer binary package: distutils command bdist_msi — Build a Microsoft Installer binary package.
* distutils.command.bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM: distutils command bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM.
* distutils.command.bdist_wininst — Build a Windows installer: distutils command bdist_wininst — Build a Windows installer.
* distutils.command.sdist — Build a source distribution: distutils command sdist — Build a source distribution.
* distutils.command.build — Build all files of a package: distutils command build — Build all files of a package.
* distutils.command.build_clib — Build any C libraries in a package: distutils command build_clib — Build any C libraries in a package.
* distutils.command.build_ext — Build any extensions in a package: distutils command build_ext — Build any extensions in a package.
* distutils.command.build_py — Build the .py/.pyc files of a package: distutils command build_py — Build the py/ pyc files of a package.
* distutils.command.build_scripts — Build the scripts of a package: distutils command build_scripts — Build the scripts of a package.
* distutils.command.clean — Clean a package build area: distutils command clean — Clean a package build area.
* distutils.command.config — Perform package configuration: distutils command config — Perform package configuration.
* distutils.command.install — Install a package: distutils command install — Install a package.
* distutils.command.install_data — Install data files from a package: distutils command install_data — Install data files from a package.
* distutils.command.install_headers — Install C/C++ header files from a package: distutils command install_headers — Install C/C++ header files from a package.
* distutils.command.install_lib — Install library files from a package: distutils command install_lib — Install library files from a package.
* distutils.command.install_scripts — Install script files from a package: distutils command install_scripts — Install script files from a package.
* distutils.command.register — Register a module with the Python Package Index: distutils command register — Register a module with the Python Package Index.
* distutils.command.check — Check the meta-data of a package: distutils command check — Check the meta-data of a package.

Installing Python Modules (Legacy version)

* Introduction: Introduction<17>.
* Standard Build and Install::
* Alternate Installation::
* Custom Installation::
* Distutils Configuration Files::
* Building Extensions; Tips and Tricks: Building Extensions Tips and Tricks.

Introduction

* Distutils based source distributions::

Standard Build and Install

* Platform variations::
* Splitting the job up::
* How building works::
* How installation works::

Alternate Installation

* Alternate installation; the user scheme: Alternate installation the user scheme.
* Alternate installation; the home scheme: Alternate installation the home scheme.
* Alternate installation; Unix (the prefix scheme): Alternate installation Unix the prefix scheme.
* Alternate installation; Windows (the prefix scheme): Alternate installation Windows the prefix scheme.

Custom Installation

* Modifying Python’s Search Path::

Distutils Configuration Files

* Location and names of config files::
* Syntax of config files::

Building Extensions: Tips and Tricks

* Tweaking compiler/linker flags::
* Using non-Microsoft compilers on Windows::

Using non-Microsoft compilers on Windows

* Borland/CodeGear C++::
* GNU C / Cygwin / MinGW::

GNU C / Cygwin / MinGW

* Older Versions of Python and MinGW::



File: python.info,  Node: What’s New in Python,  Next: The Python Tutorial,  Prev: Top,  Up: Top

1 What’s New in Python
**********************

The “What’s New in Python” series of essays takes tours through the most
important changes between major Python versions.  They are a “must read”
for anyone wishing to stay up-to-date after a new release.

* Menu:

* What’s New In Python 3.8: What’s New In Python 3 8.
* What’s New In Python 3.7: What’s New In Python 3 7.
* What’s New In Python 3.6: What’s New In Python 3 6.
* What’s New In Python 3.5: What’s New In Python 3 5.
* What’s New In Python 3.4: What’s New In Python 3 4.
* What’s New In Python 3.3: What’s New In Python 3 3.
* What’s New In Python 3.2: What’s New In Python 3 2.
* What’s New In Python 3.1: What’s New In Python 3 1.
* What’s New In Python 3.0: What’s New In Python 3 0.
* What’s New in Python 2.7: What’s New in Python 2 7.
* What’s New in Python 2.6: What’s New in Python 2 6.
* What’s New in Python 2.5: What’s New in Python 2 5.
* What’s New in Python 2.4: What’s New in Python 2 4.
* What’s New in Python 2.3: What’s New in Python 2 3.
* What’s New in Python 2.2: What’s New in Python 2 2.
* What’s New in Python 2.1: What’s New in Python 2 1.
* What’s New in Python 2.0: What’s New in Python 2 0.
* Changelog::


File: python.info,  Node: What’s New In Python 3 8,  Next: What’s New In Python 3 7,  Up: What’s New in Python

1.1 What’s New In Python 3.8
============================


Editor: Raymond Hettinger

This article explains the new features in Python 3.8, compared to 3.7.
For full details, see the *note changelog: 14c.

Python 3.8 was released on October 14th, 2019.

* Menu:

* Summary – Release highlights::
* New Features::
* Other Language Changes::
* New Modules::
* Improved Modules::
* Optimizations::
* Build and C API Changes::
* Deprecated::
* API and Feature Removals::
* Porting to Python 3.8: Porting to Python 3 8.
* Notable changes in Python 3.8.1: Notable changes in Python 3 8 1.


File: python.info,  Node: Summary – Release highlights,  Next: New Features,  Up: What’s New In Python 3 8

1.1.1 Summary – Release highlights
----------------------------------


File: python.info,  Node: New Features,  Next: Other Language Changes,  Prev: Summary – Release highlights,  Up: What’s New In Python 3 8

1.1.2 New Features
------------------

* Menu:

* Assignment expressions::
* Positional-only parameters::
* Parallel filesystem cache for compiled bytecode files::
* Debug build uses the same ABI as release build::
* f-strings support = for self-documenting expressions and debugging::
* PEP 578; Python Runtime Audit Hooks: PEP 578 Python Runtime Audit Hooks.
* PEP 587; Python Initialization Configuration: PEP 587 Python Initialization Configuration.
* Vectorcall; a fast calling protocol for CPython: Vectorcall a fast calling protocol for CPython.
* Pickle protocol 5 with out-of-band data buffers::


File: python.info,  Node: Assignment expressions,  Next: Positional-only parameters,  Up: New Features

1.1.2.1 Assignment expressions
..............................

There is new syntax ‘:=’ that assigns values to variables as part of a
larger expression.  It is affectionately known as “the walrus operator”
due to its resemblance to the eyes and tusks of a walrus(1).

In this example, the assignment expression helps avoid calling *note
len(): 150. twice:

     if (n := len(a)) > 10:
         print(f"List is too long ({n} elements, expected <= 10)")

A similar benefit arises during regular expression matching where match
objects are needed twice, once to test whether a match occurred and
another to extract a subgroup:

     discount = 0.0
     if (mo := re.search(r'(\d+)% discount', advertisement)):
         discount = float(mo.group(1)) / 100.0

The operator is also useful with while-loops that compute a value to
test loop termination and then need that same value again in the body of
the loop:

     # Loop over fixed length blocks
     while (block := f.read(256)) != '':
         process(block)

Another motivating use case arises in list comprehensions where a value
computed in a filtering condition is also needed in the expression body:

     [clean_name.title() for name in names
      if (clean_name := normalize('NFC', name)) in allowed_names]

Try to limit use of the walrus operator to clean cases that reduce
complexity and improve readability.

See PEP 572(2) for a full description.

(Contributed by Emily Morehouse in bpo-35224(3).)

   ---------- Footnotes ----------

   (1) 
https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg

   (2) https://www.python.org/dev/peps/pep-0572

   (3) https://bugs.python.org/issue35224


File: python.info,  Node: Positional-only parameters,  Next: Parallel filesystem cache for compiled bytecode files,  Prev: Assignment expressions,  Up: New Features

1.1.2.2 Positional-only parameters
..................................

There is a new function parameter syntax ‘/’ to indicate that some
function parameters must be specified positionally and cannot be used as
keyword arguments.  This is the same notation shown by ‘help()’ for C
functions annotated with Larry Hastings’ Argument Clinic(1) tool.

In the following example, parameters `a' and `b' are positional-only,
while `c' or `d' can be positional or keyword, and `e' or `f' are
required to be keywords:

     def f(a, b, /, c, d, *, e, f):
         print(a, b, c, d, e, f)

The following is a valid call:

     f(10, 20, 30, d=40, e=50, f=60)

However, these are invalid calls:

     f(10, b=20, c=30, d=40, e=50, f=60)   # b cannot be a keyword argument
     f(10, 20, 30, 40, 50, f=60)           # e must be a keyword argument

One use case for this notation is that it allows pure Python functions
to fully emulate behaviors of existing C coded functions.  For example,
the built-in *note pow(): 152. function does not accept keyword
arguments:

     def pow(x, y, z=None, /):
         "Emulate the built in pow() function"
         r = x ** y
         return r if z is None else r%z

Another use case is to preclude keyword arguments when the parameter
name is not helpful.  For example, the builtin *note len(): 150.
function has the signature ‘len(obj, /)’.  This precludes awkward calls
such as:

     len(obj='hello')  # The "obj" keyword argument impairs readability

A further benefit of marking a parameter as positional-only is that it
allows the parameter name to be changed in the future without risk of
breaking client code.  For example, in the *note statistics: f5. module,
the parameter name `dist' may be changed in the future.  This was made
possible with the following function specification:

     def quantiles(dist, /, *, n=4, method='exclusive')
         ...

Since the parameters to the left of ‘/’ are not exposed as possible
keywords, the parameters names remain available for use in ‘**kwargs’:

     >>> def f(a, b, /, **kwargs):
     ...     print(a, b, kwargs)
     ...
     >>> f(10, 20, a=1, b=2, c=3)         # a and b are used in two ways
     10 20 {'a': 1, 'b': 2, 'c': 3}

This greatly simplifies the implementation of functions and methods that
need to accept arbitrary keyword arguments.  For example, here is an
excerpt from code in the *note collections: 1e. module:

     class Counter(dict):

         def __init__(self, iterable=None, /, **kwds):
             # Note "iterable" is a possible keyword argument

See PEP 570(2) for a full description.

(Contributed by Pablo Galindo in bpo-36540(3).)

   ---------- Footnotes ----------

   (1) https://docs.python.org/3/howto/clinic.html

   (2) https://www.python.org/dev/peps/pep-0570

   (3) https://bugs.python.org/issue36540


File: python.info,  Node: Parallel filesystem cache for compiled bytecode files,  Next: Debug build uses the same ABI as release build,  Prev: Positional-only parameters,  Up: New Features

1.1.2.3 Parallel filesystem cache for compiled bytecode files
.............................................................

The new *note PYTHONPYCACHEPREFIX: 154. setting (also available as *note
-X: 155. ‘pycache_prefix’) configures the implicit bytecode cache to use
a separate parallel filesystem tree, rather than the default
‘__pycache__’ subdirectories within each source directory.

The location of the cache is reported in *note sys.pycache_prefix: 156.
(*note None: 157. indicates the default location in ‘__pycache__’
subdirectories).

(Contributed by Carl Meyer in bpo-33499(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33499


File: python.info,  Node: Debug build uses the same ABI as release build,  Next: f-strings support = for self-documenting expressions and debugging,  Prev: Parallel filesystem cache for compiled bytecode files,  Up: New Features

1.1.2.4 Debug build uses the same ABI as release build
......................................................

Python now uses the same ABI whether it’s built in release or debug
mode.  On Unix, when Python is built in debug mode, it is now possible
to load C extensions built in release mode and C extensions built using
the stable ABI.

Release builds and debug builds are now ABI compatible: defining the
‘Py_DEBUG’ macro no longer implies the ‘Py_TRACE_REFS’ macro, which
introduces the only ABI incompatibility.  The ‘Py_TRACE_REFS’ macro,
which adds the ‘sys.getobjects()’ function and the *note PYTHONDUMPREFS:
159. environment variable, can be set using the new ‘./configure
--with-trace-refs’ build option.  (Contributed by Victor Stinner in
bpo-36465(1).)

On Unix, C extensions are no longer linked to libpython except on
Android and Cygwin.  It is now possible for a statically linked Python
to load a C extension built using a shared library Python.  (Contributed
by Victor Stinner in bpo-21536(2).)

On Unix, when Python is built in debug mode, import now also looks for C
extensions compiled in release mode and for C extensions compiled with
the stable ABI. (Contributed by Victor Stinner in bpo-36722(3).)

To embed Python into an application, a new ‘--embed’ option must be
passed to ‘python3-config --libs --embed’ to get ‘-lpython3.8’ (link the
application to libpython).  To support both 3.8 and older, try
‘python3-config --libs --embed’ first and fallback to ‘python3-config
--libs’ (without ‘--embed’) if the previous command fails.

Add a pkg-config ‘python-3.8-embed’ module to embed Python into an
application: ‘pkg-config python-3.8-embed --libs’ includes
‘-lpython3.8’.  To support both 3.8 and older, try ‘pkg-config
python-X.Y-embed --libs’ first and fallback to ‘pkg-config python-X.Y
--libs’ (without ‘--embed’) if the previous command fails (replace ‘X.Y’
with the Python version).

On the other hand, ‘pkg-config python3.8 --libs’ no longer contains
‘-lpython3.8’.  C extensions must not be linked to libpython (except on
Android and Cygwin, whose cases are handled by the script); this change
is backward incompatible on purpose.  (Contributed by Victor Stinner in
bpo-36721(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36465

   (2) https://bugs.python.org/issue21536

   (3) https://bugs.python.org/issue36722

   (4) https://bugs.python.org/issue36721


File: python.info,  Node: f-strings support = for self-documenting expressions and debugging,  Next: PEP 578 Python Runtime Audit Hooks,  Prev: Debug build uses the same ABI as release build,  Up: New Features

1.1.2.5 f-strings support ‘=’ for self-documenting expressions and debugging
............................................................................

Added an ‘=’ specifier to *note f-string: 15b.s.  An f-string such as
‘f'{expr=}'’ will expand to the text of the expression, an equal sign,
then the representation of the evaluated expression.  For example:

     >>> user = 'eric_idle'
     >>> member_since = date(1975, 7, 31)
     >>> f'{user=} {member_since=}'
     "user='eric_idle' member_since=datetime.date(1975, 7, 31)"

The usual *note f-string format specifiers: 15c. allow more control over
how the result of the expression is displayed:

     >>> delta = date.today() - member_since
     >>> f'{user=!s}  {delta.days=:,d}'
     'user=eric_idle  delta.days=16,075'

The ‘=’ specifier will display the whole expression so that calculations
can be shown:

     >>> print(f'{theta=}  {cos(radians(theta))=:.3f}')
     theta=30  cos(radians(theta))=0.866

(Contributed by Eric V. Smith and Larry Hastings in bpo-36817(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36817


File: python.info,  Node: PEP 578 Python Runtime Audit Hooks,  Next: PEP 587 Python Initialization Configuration,  Prev: f-strings support = for self-documenting expressions and debugging,  Up: New Features

1.1.2.6 PEP 578: Python Runtime Audit Hooks
...........................................

The PEP adds an Audit Hook and Verified Open Hook.  Both are available
from Python and native code, allowing applications and frameworks
written in pure Python code to take advantage of extra notifications,
while also allowing embedders or system administrators to deploy builds
of Python where auditing is always enabled.

See PEP 578(1) for full details.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0578


File: python.info,  Node: PEP 587 Python Initialization Configuration,  Next: Vectorcall a fast calling protocol for CPython,  Prev: PEP 578 Python Runtime Audit Hooks,  Up: New Features

1.1.2.7 PEP 587: Python Initialization Configuration
....................................................

The PEP 587(1) adds a new C API to configure the Python Initialization
providing finer control on the whole configuration and better error
reporting.

New structures:

   * *note PyConfig: 15f.

   * *note PyPreConfig: 160.

   * *note PyStatus: 161.

   * *note PyWideStringList: 162.

New functions:

   * *note PyConfig_Clear(): 163.

   * *note PyConfig_InitIsolatedConfig(): 164.

   * *note PyConfig_InitPythonConfig(): 165.

   * *note PyConfig_Read(): 166.

   * *note PyConfig_SetArgv(): 167.

   * *note PyConfig_SetBytesArgv(): 168.

   * *note PyConfig_SetBytesString(): 169.

   * *note PyConfig_SetString(): 16a.

   * *note PyPreConfig_InitIsolatedConfig(): 16b.

   * *note PyPreConfig_InitPythonConfig(): 16c.

   * *note PyStatus_Error(): 16d.

   * *note PyStatus_Exception(): 16e.

   * *note PyStatus_Exit(): 16f.

   * *note PyStatus_IsError(): 170.

   * *note PyStatus_IsExit(): 171.

   * *note PyStatus_NoMemory(): 172.

   * *note PyStatus_Ok(): 173.

   * *note PyWideStringList_Append(): 174.

   * *note PyWideStringList_Insert(): 175.

   * *note Py_BytesMain(): 176.

   * *note Py_ExitStatusException(): 177.

   * *note Py_InitializeFromConfig(): 178.

   * *note Py_PreInitialize(): 179.

   * *note Py_PreInitializeFromArgs(): 17a.

   * *note Py_PreInitializeFromBytesArgs(): 17b.

   * *note Py_RunMain(): 17c.

This PEP also adds ‘_PyRuntimeState.preconfig’ (*note PyPreConfig: 160.
type) and ‘PyInterpreterState.config’ (*note PyConfig: 15f. type) fields
to these internal structures.  ‘PyInterpreterState.config’ becomes the
new reference configuration, replacing global configuration variables
and other private variables.

See *note Python Initialization Configuration: 17d. for the
documentation.

See PEP 587(2) for a full description.

(Contributed by Victor Stinner in bpo-36763(3).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0587

   (2) https://www.python.org/dev/peps/pep-0587

   (3) https://bugs.python.org/issue36763


File: python.info,  Node: Vectorcall a fast calling protocol for CPython,  Next: Pickle protocol 5 with out-of-band data buffers,  Prev: PEP 587 Python Initialization Configuration,  Up: New Features

1.1.2.8 Vectorcall: a fast calling protocol for CPython
.......................................................

The “vectorcall” protocol is added to the Python/C API. It is meant to
formalize existing optimizations which were already done for various
classes.  Any extension type implementing a callable can use this
protocol.

This is currently provisional.  The aim is to make it fully public in
Python 3.9.

See PEP 590(1) for a full description.

(Contributed by Jeroen Demeyer and Mark Shannon in bpo-36974(2).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0590

   (2) https://bugs.python.org/issue36974


File: python.info,  Node: Pickle protocol 5 with out-of-band data buffers,  Prev: Vectorcall a fast calling protocol for CPython,  Up: New Features

1.1.2.9 Pickle protocol 5 with out-of-band data buffers
.......................................................

When *note pickle: ca. is used to transfer large data between Python
processes in order to take advantage of multi-core or multi-machine
processing, it is important to optimize the transfer by reducing memory
copies, and possibly by applying custom techniques such as
data-dependent compression.

The *note pickle: ca. protocol 5 introduces support for out-of-band
buffers where PEP 3118(1)-compatible data can be transmitted separately
from the main pickle stream, at the discretion of the communication
layer.

See PEP 574(2) for a full description.

(Contributed by Antoine Pitrou in bpo-36785(3).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3118

   (2) https://www.python.org/dev/peps/pep-0574

   (3) https://bugs.python.org/issue36785


File: python.info,  Node: Other Language Changes,  Next: New Modules,  Prev: New Features,  Up: What’s New In Python 3 8

1.1.3 Other Language Changes
----------------------------

   * A *note continue: 181. statement was illegal in the *note finally:
     182. clause due to a problem with the implementation.  In Python
     3.8 this restriction was lifted.  (Contributed by Serhiy Storchaka
     in bpo-32489(1).)

   * The *note bool: 183, *note int: 184, and *note fractions.Fraction:
     185. types now have an *note as_integer_ratio(): 186. method like
     that found in *note float: 187. and *note decimal.Decimal: 188.
     This minor API extension makes it possible to write ‘numerator,
     denominator = x.as_integer_ratio()’ and have it work across
     multiple numeric types.  (Contributed by Lisa Roach in bpo-33073(2)
     and Raymond Hettinger in bpo-37819(3).)

   * Constructors of *note int: 184, *note float: 187. and *note
     complex: 189. will now use the *note __index__(): 18a. special
     method, if available and the corresponding method *note __int__():
     18b, *note __float__(): 18c. or *note __complex__(): 18d. is not
     available.  (Contributed by Serhiy Storchaka in bpo-20092(4).)

   * Added support of ‘\N{name}’ escapes in *note regular expressions:
     dd.:

          >>> notice = 'Copyright © 2019'
          >>> copyright_year_pattern = re.compile(r'\N{copyright sign}\s*(\d{4})')
          >>> int(copyright_year_pattern.search(notice).group(1))
          2019

     (Contributed by Jonathan Eunice and Serhiy Storchaka in
     bpo-30688(5).)

   * Dict and dictviews are now iterable in reversed insertion order
     using *note reversed(): 18e.  (Contributed by Rémi Lapeyre in
     bpo-33462(6).)

   * The syntax allowed for keyword names in function calls was further
     restricted.  In particular, ‘f((keyword)=arg)’ is no longer
     allowed.  It was never intended to permit more than a bare name on
     the left-hand side of a keyword argument assignment term.
     (Contributed by Benjamin Peterson in bpo-34641(7).)

   * Generalized iterable unpacking in *note yield: 18f. and *note
     return: 190. statements no longer requires enclosing parentheses.
     This brings the `yield' and `return' syntax into better agreement
     with normal assignment syntax:

          >>> def parse(family):
                  lastname, *members = family.split()
                  return lastname.upper(), *members

          >>> parse('simpsons homer marge bart lisa sally')
          ('SIMPSONS', 'homer', 'marge', 'bart', 'lisa', 'sally')

     (Contributed by David Cuthbert and Jordan Chapman in bpo-32117(8).)

   * When a comma is missed in code such as ‘[(10, 20) (30, 40)]’, the
     compiler displays a *note SyntaxWarning: 191. with a helpful
     suggestion.  This improves on just having a *note TypeError: 192.
     indicating that the first tuple was not callable.  (Contributed by
     Serhiy Storchaka in bpo-15248(9).)

   * Arithmetic operations between subclasses of *note datetime.date:
     193. or *note datetime.datetime: 194. and *note datetime.timedelta:
     195. objects now return an instance of the subclass, rather than
     the base class.  This also affects the return type of operations
     whose implementation (directly or indirectly) uses *note
     datetime.timedelta: 195. arithmetic, such as *note astimezone():
     196.  (Contributed by Paul Ganssle in bpo-32417(10).)

   * When the Python interpreter is interrupted by Ctrl-C (SIGINT) and
     the resulting *note KeyboardInterrupt: 197. exception is not
     caught, the Python process now exits via a SIGINT signal or with
     the correct exit code such that the calling process can detect that
     it died due to a Ctrl-C. Shells on POSIX and Windows use this to
     properly terminate scripts in interactive sessions.  (Contributed
     by Google via Gregory P. Smith in bpo-1054041(11).)

   * Some advanced styles of programming require updating the *note
     types.CodeType: 198. object for an existing function.  Since code
     objects are immutable, a new code object needs to be created, one
     that is modeled on the existing code object.  With 19 parameters,
     this was somewhat tedious.  Now, the new ‘replace()’ method makes
     it possible to create a clone with a few altered parameters.

     Here’s an example that alters the *note statistics.mean(): 199.
     function to prevent the `data' parameter from being used as a
     keyword argument:

          >>> from statistics import mean
          >>> mean(data=[10, 20, 90])
          40
          >>> mean.__code__ = mean.__code__.replace(co_posonlyargcount=1)
          >>> mean(data=[10, 20, 90])
          Traceback (most recent call last):
            ...
          TypeError: mean() got some positional-only arguments passed as keyword arguments: 'data'

     (Contributed by Victor Stinner in bpo-37032(12).)

   * For integers, the three-argument form of the *note pow(): 152.
     function now permits the exponent to be negative in the case where
     the base is relatively prime to the modulus.  It then computes a
     modular inverse to the base when the exponent is ‘-1’, and a
     suitable power of that inverse for other negative exponents.  For
     example, to compute the modular multiplicative inverse(13) of 38
     modulo 137, write:

          >>> pow(38, -1, 137)
          119
          >>> 119 * 38 % 137
          1

     Modular inverses arise in the solution of linear Diophantine
     equations(14).  For example, to find integer solutions for ‘4258𝑥 +
     147𝑦 = 369’, first rewrite as ‘4258𝑥 ≡ 369 (mod 147)’ then solve:

          >>> x = 369 * pow(4258, -1, 147) % 147
          >>> y = (4258 * x - 369) // -147
          >>> 4258 * x + 147 * y
          369

     (Contributed by Mark Dickinson in bpo-36027(15).)

   * Dict comprehensions have been synced-up with dict literals so that
     the key is computed first and the value second:

          >>> # Dict comprehension
          >>> cast = {input('role? '): input('actor? ') for i in range(2)}
          role? King Arthur
          actor? Chapman
          role? Black Knight
          actor? Cleese

          >>> # Dict literal
          >>> cast = {input('role? '): input('actor? ')}
          role? Sir Robin
          actor? Eric Idle

     The guaranteed execution order is helpful with assignment
     expressions because variables assigned in the key expression will
     be available in the value expression:

          >>> names = ['Martin von Löwis', 'Łukasz Langa', 'Walter Dörwald']
          >>> {(n := normalize('NFC', name)).casefold() : n for name in names}
          {'martin von löwis': 'Martin von Löwis',
           'łukasz langa': 'Łukasz Langa',
           'walter dörwald': 'Walter Dörwald'}

     (Contributed by Jörn Heissler in bpo-35224(16).)

   * The *note object.__reduce__(): 19a. method can now return a tuple
     from two to six elements long.  Formerly, five was the limit.  The
     new, optional sixth element is a callable with a ‘(obj, state)’
     signature.  This allows the direct control over the state-updating
     behavior of a specific object.  If not `None', this callable will
     have priority over the object’s *note __setstate__(): 19b. method.
     (Contributed by Pierre Glaser and Olivier Grisel in bpo-35900(17).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32489

   (2) https://bugs.python.org/issue33073

   (3) https://bugs.python.org/issue37819

   (4) https://bugs.python.org/issue20092

   (5) https://bugs.python.org/issue30688

   (6) https://bugs.python.org/issue33462

   (7) https://bugs.python.org/issue34641

   (8) https://bugs.python.org/issue32117

   (9) https://bugs.python.org/issue15248

   (10) https://bugs.python.org/issue32417

   (11) https://bugs.python.org/issue1054041

   (12) https://bugs.python.org/issue37032

   (13) https://en.wikipedia.org/wiki/Modular_multiplicative_inverse

   (14) https://en.wikipedia.org/wiki/Diophantine_equation

   (15) https://bugs.python.org/issue36027

   (16) https://bugs.python.org/issue35224

   (17) https://bugs.python.org/issue35900


File: python.info,  Node: New Modules,  Next: Improved Modules,  Prev: Other Language Changes,  Up: What’s New In Python 3 8

1.1.4 New Modules
-----------------

   * The new ‘importlib.metadata’ module provides (provisional) support
     for reading metadata from third-party packages.  For example, it
     can extract an installed package’s version number, list of entry
     points, and more:

          >>> # Note following example requires that the popular "requests"
          >>> # package has been installed.
          >>>
          >>> from importlib.metadata import version, requires, files
          >>> version('requests')
          '2.22.0'
          >>> list(requires('requests'))
          ['chardet (<3.1.0,>=3.0.2)']
          >>> list(files('requests'))[:5]
          [PackagePath('requests-2.22.0.dist-info/INSTALLER'),
           PackagePath('requests-2.22.0.dist-info/LICENSE'),
           PackagePath('requests-2.22.0.dist-info/METADATA'),
           PackagePath('requests-2.22.0.dist-info/RECORD'),
           PackagePath('requests-2.22.0.dist-info/WHEEL')]

     (Contributed by Barry Warsaw and Jason R. Coombs in bpo-34632(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34632


File: python.info,  Node: Improved Modules,  Next: Optimizations,  Prev: New Modules,  Up: What’s New In Python 3 8

1.1.5 Improved Modules
----------------------

* Menu:

* ast::
* asyncio::
* builtins::
* collections::
* cProfile::
* csv::
* curses::
* ctypes::
* datetime::
* functools::
* gc::
* gettext::
* gzip::
* IDLE and idlelib::
* inspect::
* io::
* itertools::
* json.tool: json tool.
* logging::
* math::
* mmap::
* multiprocessing::
* os::
* os.path: os path.
* pathlib::
* pickle::
* plistlib::
* pprint::
* py_compile::
* shlex::
* shutil::
* socket::
* ssl::
* statistics::
* sys::
* tarfile::
* threading::
* tokenize::
* tkinter::
* time::
* typing::
* unicodedata::
* unittest::
* venv::
* weakref::
* xml::
* xmlrpc::


File: python.info,  Node: ast,  Next: asyncio,  Up: Improved Modules

1.1.5.1 ast
...........

AST nodes now have ‘end_lineno’ and ‘end_col_offset’ attributes, which
give the precise location of the end of the node.  (This only applies to
nodes that have ‘lineno’ and ‘col_offset’ attributes.)

New function *note ast.get_source_segment(): 19f. returns the source
code for a specific AST node.

(Contributed by Ivan Levkivskyi in bpo-33416(1).)

The *note ast.parse(): 1a0. function has some new flags:

   * ‘type_comments=True’ causes it to return the text of PEP 484(2) and
     PEP 526(3) type comments associated with certain AST nodes;

   * ‘mode='func_type'’ can be used to parse PEP 484(4) “signature type
     comments” (returned for function definition AST nodes);

   * ‘feature_version=(3, N)’ allows specifying an earlier Python 3
     version.  For example, ‘feature_version=(3, 4)’ will treat *note
     async: 1a1. and *note await: 1a2. as non-reserved words.

(Contributed by Guido van Rossum in bpo-35766(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33416

   (2) https://www.python.org/dev/peps/pep-0484

   (3) https://www.python.org/dev/peps/pep-0526

   (4) https://www.python.org/dev/peps/pep-0484

   (5) https://bugs.python.org/issue35766


File: python.info,  Node: asyncio,  Next: builtins,  Prev: ast,  Up: Improved Modules

1.1.5.2 asyncio
...............

*note asyncio.run(): 1a4. has graduated from the provisional to stable
API. This function can be used to execute a *note coroutine: 1a5. and
return the result while automatically managing the event loop.  For
example:

     import asyncio

     async def main():
         await asyncio.sleep(0)
         return 42

     asyncio.run(main())

This is `roughly' equivalent to:

     import asyncio

     async def main():
         await asyncio.sleep(0)
         return 42

     loop = asyncio.new_event_loop()
     asyncio.set_event_loop(loop)
     try:
         loop.run_until_complete(main())
     finally:
         asyncio.set_event_loop(None)
         loop.close()

The actual implementation is significantly more complex.  Thus, *note
asyncio.run(): 1a4. should be the preferred way of running asyncio
programs.

(Contributed by Yury Selivanov in bpo-32314(1).)

Running ‘python -m asyncio’ launches a natively async REPL. This allows
rapid experimentation with code that has a top-level *note await: 1a2.
There is no longer a need to directly call ‘asyncio.run()’ which would
spawn a new event loop on every invocation:

     $ python -m asyncio
     asyncio REPL 3.8.0
     Use "await" directly instead of "asyncio.run()".
     Type "help", "copyright", "credits" or "license" for more information.
     >>> import asyncio
     >>> await asyncio.sleep(10, result='hello')
     hello

(Contributed by Yury Selivanov in bpo-37028(2).)

The exception *note asyncio.CancelledError: 1a6. now inherits from *note
BaseException: 1a7. rather than *note Exception: 1a8.  (Contributed by
Yury Selivanov in bpo-32528(3).)

On Windows, the default event loop is now *note ProactorEventLoop: 1a9.
(Contributed by Victor Stinner in bpo-34687(4).)

*note ProactorEventLoop: 1a9. now also supports UDP. (Contributed by
Adam Meily and Andrew Svetlov in bpo-29883(5).)

*note ProactorEventLoop: 1a9. can now be interrupted by *note
KeyboardInterrupt: 197. (“CTRL+C”).  (Contributed by Vladimir Matveev in
bpo-23057(6).)

Added *note asyncio.Task.get_coro(): 1aa. for getting the wrapped
coroutine within an *note asyncio.Task: 1ab.  (Contributed by Alex
Grönholm in bpo-36999(7).)

Asyncio tasks can now be named, either by passing the ‘name’ keyword
argument to *note asyncio.create_task(): 1ac. or the *note
create_task(): 1ad. event loop method, or by calling the *note
set_name(): 1ae. method on the task object.  The task name is visible in
the ‘repr()’ output of *note asyncio.Task: 1ab. and can also be
retrieved using the *note get_name(): 1af. method.  (Contributed by Alex
Grönholm in bpo-34270(8).)

Added support for Happy Eyeballs(9) to *note
asyncio.loop.create_connection(): 1b0.  To specify the behavior, two new
parameters have been added: `happy_eyeballs_delay' and `interleave'.
The Happy Eyeballs algorithm improves responsiveness in applications
that support IPv4 and IPv6 by attempting to simultaneously connect using
both.  (Contributed by twisteroid ambassador in bpo-33530(10).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32314

   (2) https://bugs.python.org/issue37028

   (3) https://bugs.python.org/issue32528

   (4) https://bugs.python.org/issue34687

   (5) https://bugs.python.org/issue29883

   (6) https://bugs.python.org/issue23057

   (7) https://bugs.python.org/issue36999

   (8) https://bugs.python.org/issue34270

   (9) https://en.wikipedia.org/wiki/Happy_Eyeballs

   (10) https://bugs.python.org/issue33530


File: python.info,  Node: builtins,  Next: collections,  Prev: asyncio,  Up: Improved Modules

1.1.5.3 builtins
................

The *note compile(): 1b2. built-in has been improved to accept the
‘ast.PyCF_ALLOW_TOP_LEVEL_AWAIT’ flag.  With this new flag passed, *note
compile(): 1b2. will allow top-level ‘await’, ‘async for’ and ‘async
with’ constructs that are usually considered invalid syntax.
Asynchronous code object marked with the ‘CO_COROUTINE’ flag may then be
returned.  (Contributed by Matthias Bussonnier in bpo-34616(1))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34616


File: python.info,  Node: collections,  Next: cProfile,  Prev: builtins,  Up: Improved Modules

1.1.5.4 collections
...................

The *note _asdict(): 1b4. method for *note collections.namedtuple():
1b5. now returns a *note dict: 1b6. instead of a *note
collections.OrderedDict: 1b7.  This works because regular dicts have
guaranteed ordering since Python 3.7.  If the extra features of
‘OrderedDict’ are required, the suggested remediation is to cast the
result to the desired type: ‘OrderedDict(nt._asdict())’.  (Contributed
by Raymond Hettinger in bpo-35864(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35864


File: python.info,  Node: cProfile,  Next: csv,  Prev: collections,  Up: Improved Modules

1.1.5.5 cProfile
................

The *note cProfile.Profile: 1b9. class can now be used as a context
manager.  Profile a block of code by running:

     import cProfile

     with cProfile.Profile() as profiler:
           # code to be profiled
           ...

(Contributed by Scott Sanderson in bpo-29235(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29235


File: python.info,  Node: csv,  Next: curses,  Prev: cProfile,  Up: Improved Modules

1.1.5.6 csv
...........

The *note csv.DictReader: 1bb. now returns instances of *note dict: 1b6.
instead of a *note collections.OrderedDict: 1b7.  The tool is now faster
and uses less memory while still preserving the field order.
(Contributed by Michael Seek in bpo-34003(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34003


File: python.info,  Node: curses,  Next: ctypes,  Prev: csv,  Up: Improved Modules

1.1.5.7 curses
..............

Added a new variable holding structured version information for the
underlying ncurses library: *note ncurses_version: 1bd.  (Contributed by
Serhiy Storchaka in bpo-31680(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31680


File: python.info,  Node: ctypes,  Next: datetime,  Prev: curses,  Up: Improved Modules

1.1.5.8 ctypes
..............

On Windows, *note CDLL: 1bf. and subclasses now accept a `winmode'
parameter to specify flags for the underlying ‘LoadLibraryEx’ call.  The
default flags are set to only load DLL dependencies from trusted
locations, including the path where the DLL is stored (if a full or
partial path is used to load the initial DLL) and paths added by *note
add_dll_directory(): 1c0.  (Contributed by Steve Dower in bpo-36085(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36085


File: python.info,  Node: datetime,  Next: functools,  Prev: ctypes,  Up: Improved Modules

1.1.5.9 datetime
................

Added new alternate constructors *note datetime.date.fromisocalendar():
1c2. and *note datetime.datetime.fromisocalendar(): 1c3, which construct
‘date’ and *note datetime: 31. objects respectively from ISO year, week
number, and weekday; these are the inverse of each class’s ‘isocalendar’
method.  (Contributed by Paul Ganssle in bpo-36004(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36004


File: python.info,  Node: functools,  Next: gc,  Prev: datetime,  Up: Improved Modules

1.1.5.10 functools
..................

*note functools.lru_cache(): 1c5. can now be used as a straight
decorator rather than as a function returning a decorator.  So both of
these are now supported:

     @lru_cache
     def f(x):
         ...

     @lru_cache(maxsize=256)
     def f(x):
         ...

(Contributed by Raymond Hettinger in bpo-36772(1).)

Added a new *note functools.cached_property(): 1c6. decorator, for
computed properties cached for the life of the instance.

     import functools
     import statistics

     class Dataset:
        def __init__(self, sequence_of_numbers):
           self.data = sequence_of_numbers

        @functools.cached_property
        def variance(self):
           return statistics.variance(self.data)

(Contributed by Carl Meyer in bpo-21145(2))

Added a new *note functools.singledispatchmethod(): 1c7. decorator that
converts methods into *note generic functions: 1c8. using *note single
dispatch: 1c9.:

     from functools import singledispatchmethod
     from contextlib import suppress

     class TaskManager:

         def __init__(self, tasks):
             self.tasks = list(tasks)

         @singledispatchmethod
         def discard(self, value):
             with suppress(ValueError):
                 self.tasks.remove(value)

         @discard.register(list)
         def _(self, tasks):
             targets = set(tasks)
             self.tasks = [x for x in self.tasks if x not in targets]

(Contributed by Ethan Smith in bpo-32380(3))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36772

   (2) https://bugs.python.org/issue21145

   (3) https://bugs.python.org/issue32380


File: python.info,  Node: gc,  Next: gettext,  Prev: functools,  Up: Improved Modules

1.1.5.11 gc
...........

*note get_objects(): 1cb. can now receive an optional `generation'
parameter indicating a generation to get objects from.  (Contributed by
Pablo Galindo in bpo-36016(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36016


File: python.info,  Node: gettext,  Next: gzip,  Prev: gc,  Up: Improved Modules

1.1.5.12 gettext
................

Added *note pgettext(): 1cd. and its variants.  (Contributed by Franz
Glasner, Éric Araujo, and Cheryl Sabella in bpo-2504(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2504


File: python.info,  Node: gzip,  Next: IDLE and idlelib,  Prev: gettext,  Up: Improved Modules

1.1.5.13 gzip
.............

Added the `mtime' parameter to *note gzip.compress(): 1cf. for
reproducible output.  (Contributed by Guo Ci Teo in bpo-34898(1).)

A *note BadGzipFile: 1d0. exception is now raised instead of *note
OSError: 1d1. for certain types of invalid or corrupt gzip files.
(Contributed by Filip Gruszczyński, Michele Orrù, and Zackery Spytz in
bpo-6584(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34898

   (2) https://bugs.python.org/issue6584


File: python.info,  Node: IDLE and idlelib,  Next: inspect,  Prev: gzip,  Up: Improved Modules

1.1.5.14 IDLE and idlelib
.........................

Output over N lines (50 by default) is squeezed down to a button.  N can
be changed in the PyShell section of the General page of the Settings
dialog.  Fewer, but possibly extra long, lines can be squeezed by right
clicking on the output.  Squeezed output can be expanded in place by
double-clicking the button or into the clipboard or a separate window by
right-clicking the button.  (Contributed by Tal Einat in
bpo-1529353(1).)

Add “Run Customized” to the Run menu to run a module with customized
settings.  Any command line arguments entered are added to sys.argv.
They also re-appear in the box for the next customized run.  One can
also suppress the normal Shell main module restart.  (Contributed by
Cheryl Sabella, Terry Jan Reedy, and others in bpo-5680(2) and
bpo-37627(3).)

Added optional line numbers for IDLE editor windows.  Windows open
without line numbers unless set otherwise in the General tab of the
configuration dialog.  Line numbers for an existing window are shown and
hidden in the Options menu.  (Contributed by Tal Einat and Saimadhav
Heblikar in bpo-17535(4).)

OS native encoding is now used for converting between Python strings and
Tcl objects.  This allows IDLE to work with emoji and other non-BMP
characters.  These characters can be displayed or copied and pasted to
or from the clipboard.  Converting strings from Tcl to Python and back
now never fails.  (Many people worked on this for eight years but the
problem was finally solved by Serhiy Storchaka in bpo-13153(5).)

The changes above have been backported to 3.7 maintenance releases.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1529353

   (2) https://bugs.python.org/issue5680

   (3) https://bugs.python.org/issue37627

   (4) https://bugs.python.org/issue17535

   (5) https://bugs.python.org/issue13153


File: python.info,  Node: inspect,  Next: io,  Prev: IDLE and idlelib,  Up: Improved Modules

1.1.5.15 inspect
................

The *note inspect.getdoc(): 1d4. function can now find docstrings for
‘__slots__’ if that attribute is a *note dict: 1b6. where the values are
docstrings.  This provides documentation options similar to what we
already have for *note property(): 1d5, *note classmethod(): 1d6, and
*note staticmethod(): 1d7.:

     class AudioClip:
         __slots__ = {'bit_rate': 'expressed in kilohertz to one decimal place',
                      'duration': 'in seconds, rounded up to an integer'}
         def __init__(self, bit_rate, duration):
             self.bit_rate = round(bit_rate / 1000.0, 1)
             self.duration = ceil(duration)

(Contributed by Raymond Hettinger in bpo-36326(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36326


File: python.info,  Node: io,  Next: itertools,  Prev: inspect,  Up: Improved Modules

1.1.5.16 io
...........

In development mode (*note -X: 155. ‘env’) and in debug build, the *note
io.IOBase: 1d9. finalizer now logs the exception if the ‘close()’ method
fails.  The exception is ignored silently by default in release build.
(Contributed by Victor Stinner in bpo-18748(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18748


File: python.info,  Node: itertools,  Next: json tool,  Prev: io,  Up: Improved Modules

1.1.5.17 itertools
..................

The *note itertools.accumulate(): 1db. function added an option
`initial' keyword argument to specify an initial value:

     >>> from itertools import accumulate
     >>> list(accumulate([10, 5, 30, 15], initial=1000))
     [1000, 1010, 1015, 1045, 1060]

(Contributed by Lisa Roach in bpo-34659(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34659


File: python.info,  Node: json tool,  Next: logging,  Prev: itertools,  Up: Improved Modules

1.1.5.18 json.tool
..................

Add option ‘--json-lines’ to parse every input line as a separate JSON
object.  (Contributed by Weipeng Hong in bpo-31553(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31553


File: python.info,  Node: logging,  Next: math,  Prev: json tool,  Up: Improved Modules

1.1.5.19 logging
................

Added a `force' keyword argument to *note logging.basicConfig(): 1de.
When set to true, any existing handlers attached to the root logger are
removed and closed before carrying out the configuration specified by
the other arguments.

This solves a long-standing problem.  Once a logger or `basicConfig()'
had been called, subsequent calls to `basicConfig()' were silently
ignored.  This made it difficult to update, experiment with, or teach
the various logging configuration options using the interactive prompt
or a Jupyter notebook.

(Suggested by Raymond Hettinger, implemented by Dong-hee Na, and
reviewed by Vinay Sajip in bpo-33897(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33897


File: python.info,  Node: math,  Next: mmap,  Prev: logging,  Up: Improved Modules

1.1.5.20 math
.............

Added new function *note math.dist(): 1e0. for computing Euclidean
distance between two points.  (Contributed by Raymond Hettinger in
bpo-33089(1).)

Expanded the *note math.hypot(): 1e1. function to handle multiple
dimensions.  Formerly, it only supported the 2-D case.  (Contributed by
Raymond Hettinger in bpo-33089(2).)

Added new function, *note math.prod(): 1e2, as analogous function to
*note sum(): 1e3. that returns the product of a ‘start’ value (default:
1) times an iterable of numbers:

     >>> prior = 0.8
     >>> likelihoods = [0.625, 0.84, 0.30]
     >>> math.prod(likelihoods, start=prior)
     0.126

(Contributed by Pablo Galindo in bpo-35606(3).)

Added two new combinatoric functions *note math.perm(): 1e4. and *note
math.comb(): 1e5.:

     >>> math.perm(10, 3)    # Permutations of 10 things taken 3 at a time
     720
     >>> math.comb(10, 3)    # Combinations of 10 things taken 3 at a time
     120

(Contributed by Yash Aggarwal, Keller Fuchs, Serhiy Storchaka, and
Raymond Hettinger in bpo-37128(4), bpo-37178(5), and bpo-35431(6).)

Added a new function *note math.isqrt(): 1e6. for computing accurate
integer square roots without conversion to floating point.  The new
function supports arbitrarily large integers.  It is faster than
‘floor(sqrt(n))’ but slower than *note math.sqrt(): 1e7.:

     >>> r = 650320427
     >>> s = r ** 2
     >>> isqrt(s - 1)         # correct
     650320426
     >>> floor(sqrt(s - 1))   # incorrect
     650320427

(Contributed by Mark Dickinson in bpo-36887(7).)

The function *note math.factorial(): 1e8. no longer accepts arguments
that are not int-like.  (Contributed by Pablo Galindo in bpo-33083(8).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33089

   (2) https://bugs.python.org/issue33089

   (3) https://bugs.python.org/issue35606

   (4) https://bugs.python.org/issue37128

   (5) https://bugs.python.org/issue37178

   (6) https://bugs.python.org/issue35431

   (7) https://bugs.python.org/issue36887

   (8) https://bugs.python.org/issue33083


File: python.info,  Node: mmap,  Next: multiprocessing,  Prev: math,  Up: Improved Modules

1.1.5.21 mmap
.............

The *note mmap.mmap: 1ea. class now has an *note madvise(): 1eb. method
to access the ‘madvise()’ system call.  (Contributed by Zackery Spytz in
bpo-32941(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32941


File: python.info,  Node: multiprocessing,  Next: os,  Prev: mmap,  Up: Improved Modules

1.1.5.22 multiprocessing
........................

Added new *note multiprocessing.shared_memory: bc. module.  (Contributed
by Davin Potts in bpo-35813(1).)

On macOS, the `spawn' start method is now used by default.  (Contributed
by Victor Stinner in bpo-33725(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35813

   (2) https://bugs.python.org/issue33725


File: python.info,  Node: os,  Next: os path,  Prev: multiprocessing,  Up: Improved Modules

1.1.5.23 os
...........

Added new function *note add_dll_directory(): 1c0. on Windows for
providing additional search paths for native dependencies when importing
extension modules or loading DLLs using *note ctypes: 2b.  (Contributed
by Steve Dower in bpo-36085(1).)

A new *note os.memfd_create(): 1ee. function was added to wrap the
‘memfd_create()’ syscall.  (Contributed by Zackery Spytz and Christian
Heimes in bpo-26836(2).)

On Windows, much of the manual logic for handling reparse points
(including symlinks and directory junctions) has been delegated to the
operating system.  Specifically, *note os.stat(): 1ef. will now traverse
anything supported by the operating system, while *note os.lstat(): 1f0.
will only open reparse points that identify as “name surrogates” while
others are opened as for *note os.stat(): 1ef.  In all cases,
‘stat_result.st_mode’ will only have ‘S_IFLNK’ set for symbolic links
and not other kinds of reparse points.  To identify other kinds of
reparse point, check the new ‘stat_result.st_reparse_tag’ attribute.

On Windows, *note os.readlink(): 1f1. is now able to read directory
junctions.  Note that *note islink(): 1f2. will return ‘False’ for
directory junctions, and so code that checks ‘islink’ first will
continue to treat junctions as directories, while code that handles
errors from *note os.readlink(): 1f1. may now treat junctions as links.

(Contributed by Steve Dower in bpo-37834(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36085

   (2) https://bugs.python.org/issue26836

   (3) https://bugs.python.org/issue37834


File: python.info,  Node: os path,  Next: pathlib,  Prev: os,  Up: Improved Modules

1.1.5.24 os.path
................

*note os.path: c5. functions that return a boolean result like *note
exists(): 1f4, *note lexists(): 1f5, *note isdir(): 1f6, *note isfile():
1f7, *note islink(): 1f2, and *note ismount(): 1f8. now return ‘False’
instead of raising *note ValueError: 1f9. or its subclasses *note
UnicodeEncodeError: 1fa. and *note UnicodeDecodeError: 1fb. for paths
that contain characters or bytes unrepresentable at the OS level.
(Contributed by Serhiy Storchaka in bpo-33721(1).)

*note expanduser(): 1fc. on Windows now prefers the ‘USERPROFILE’
environment variable and does not use ‘HOME’, which is not normally set
for regular user accounts.  (Contributed by Anthony Sottile in
bpo-36264(2).)

*note isdir(): 1f6. on Windows no longer returns ‘True’ for a link to a
non-existent directory.

*note realpath(): 1fd. on Windows now resolves reparse points, including
symlinks and directory junctions.

(Contributed by Steve Dower in bpo-37834(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33721

   (2) https://bugs.python.org/issue36264

   (3) https://bugs.python.org/issue37834


File: python.info,  Node: pathlib,  Next: pickle,  Prev: os path,  Up: Improved Modules

1.1.5.25 pathlib
................

*note pathlib.Path: 1ff. methods that return a boolean result like *note
exists(): 200, *note is_dir(): 201, *note is_file(): 202, *note
is_mount(): 203, *note is_symlink(): 204, *note is_block_device(): 205,
*note is_char_device(): 206, *note is_fifo(): 207, *note is_socket():
208. now return ‘False’ instead of raising *note ValueError: 1f9. or its
subclass *note UnicodeEncodeError: 1fa. for paths that contain
characters unrepresentable at the OS level.  (Contributed by Serhiy
Storchaka in bpo-33721(1).)

Added *note pathlib.Path.link_to(): 209. which creates a hard link
pointing to a path.  (Contributed by Joannah Nanjekye in bpo-26978(2))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33721

   (2) https://bugs.python.org/issue26978


File: python.info,  Node: pickle,  Next: plistlib,  Prev: pathlib,  Up: Improved Modules

1.1.5.26 pickle
...............

*note pickle: ca. extensions subclassing the C-optimized *note Pickler:
20b. can now override the pickling logic of functions and classes by
defining the special *note reducer_override(): 20c. method.
(Contributed by Pierre Glaser and Olivier Grisel in bpo-35900(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35900


File: python.info,  Node: plistlib,  Next: pprint,  Prev: pickle,  Up: Improved Modules

1.1.5.27 plistlib
.................

Added new *note plistlib.UID: 20e. and enabled support for reading and
writing NSKeyedArchiver-encoded binary plists.  (Contributed by Jon
Janzen in bpo-26707(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26707


File: python.info,  Node: pprint,  Next: py_compile,  Prev: plistlib,  Up: Improved Modules

1.1.5.28 pprint
...............

The *note pprint: d2. module added a `sort_dicts' parameter to several
functions.  By default, those functions continue to sort dictionaries
before rendering or printing.  However, if `sort_dicts' is set to false,
the dictionaries retain the order that keys were inserted.  This can be
useful for comparison to JSON inputs during debugging.

In addition, there is a convenience new function, *note pprint.pp():
210. that is like *note pprint.pprint(): 211. but with `sort_dicts'
defaulting to ‘False’:

     >>> from pprint import pprint, pp
     >>> d = dict(source='input.txt', operation='filter', destination='output.txt')
     >>> pp(d, width=40)                  # Original order
     {'source': 'input.txt',
      'operation': 'filter',
      'destination': 'output.txt'}
     >>> pprint(d, width=40)              # Keys sorted alphabetically
     {'destination': 'output.txt',
      'operation': 'filter',
      'source': 'input.txt'}

(Contributed by Rémi Lapeyre in bpo-30670(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30670


File: python.info,  Node: py_compile,  Next: shlex,  Prev: pprint,  Up: Improved Modules

1.1.5.29 py_compile
...................

*note py_compile.compile(): 213. now supports silent mode.  (Contributed
by Joannah Nanjekye in bpo-22640(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22640


File: python.info,  Node: shlex,  Next: shutil,  Prev: py_compile,  Up: Improved Modules

1.1.5.30 shlex
..............

The new *note shlex.join(): 215. function acts as the inverse of *note
shlex.split(): 216.  (Contributed by Bo Bayles in bpo-32102(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32102


File: python.info,  Node: shutil,  Next: socket,  Prev: shlex,  Up: Improved Modules

1.1.5.31 shutil
...............

*note shutil.copytree(): 218. now accepts a new ‘dirs_exist_ok’ keyword
argument.  (Contributed by Josh Bronson in bpo-20849(1).)

*note shutil.make_archive(): 219. now defaults to the modern pax
(POSIX.1-2001) format for new archives to improve portability and
standards conformance, inherited from the corresponding change to the
*note tarfile: 101. module.  (Contributed by C.A.M. Gerlach in
bpo-30661(2).)

*note shutil.rmtree(): 21a. on Windows now removes directory junctions
without recursively removing their contents first.  (Contributed by
Steve Dower in bpo-37834(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20849

   (2) https://bugs.python.org/issue30661

   (3) https://bugs.python.org/issue37834


File: python.info,  Node: socket,  Next: ssl,  Prev: shutil,  Up: Improved Modules

1.1.5.32 socket
...............

Added *note create_server(): 21c. and *note has_dualstack_ipv6(): 21d.
convenience functions to automate the necessary tasks usually involved
when creating a server socket, including accepting both IPv4 and IPv6
connections on the same socket.  (Contributed by Giampaolo Rodolà in
bpo-17561(1).)

The *note socket.if_nameindex(): 21e, *note socket.if_nametoindex():
21f, and *note socket.if_indextoname(): 220. functions have been
implemented on Windows.  (Contributed by Zackery Spytz in bpo-37007(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17561

   (2) https://bugs.python.org/issue37007


File: python.info,  Node: ssl,  Next: statistics,  Prev: socket,  Up: Improved Modules

1.1.5.33 ssl
............

Added *note post_handshake_auth: 222. to enable and *note
verify_client_post_handshake(): 223. to initiate TLS 1.3 post-handshake
authentication.  (Contributed by Christian Heimes in bpo-34670(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34670


File: python.info,  Node: statistics,  Next: sys,  Prev: ssl,  Up: Improved Modules

1.1.5.34 statistics
...................

Added *note statistics.fmean(): 225. as a faster, floating point variant
of *note statistics.mean(): 199.  (Contributed by Raymond Hettinger and
Steven D’Aprano in bpo-35904(1).)

Added *note statistics.geometric_mean(): 226. (Contributed by Raymond
Hettinger in bpo-27181(2).)

Added *note statistics.multimode(): 227. that returns a list of the most
common values.  (Contributed by Raymond Hettinger in bpo-35892(3).)

Added *note statistics.quantiles(): 228. that divides data or a
distribution in to equiprobable intervals (e.g.  quartiles, deciles, or
percentiles).  (Contributed by Raymond Hettinger in bpo-36546(4).)

Added *note statistics.NormalDist: 229, a tool for creating and
manipulating normal distributions of a random variable.  (Contributed by
Raymond Hettinger in bpo-36018(5).)

     >>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
     >>> temperature_feb.mean
     6.0
     >>> temperature_feb.stdev
     6.356099432828281

     >>> temperature_feb.cdf(3)            # Chance of being under 3 degrees
     0.3184678262814532
     >>> # Relative chance of being 7 degrees versus 10 degrees
     >>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
     1.2039930378537762

     >>> el_niño = NormalDist(4, 2.5)
     >>> temperature_feb += el_niño        # Add in a climate effect
     >>> temperature_feb
     NormalDist(mu=10.0, sigma=6.830080526611674)

     >>> temperature_feb * (9/5) + 32      # Convert to Fahrenheit
     NormalDist(mu=50.0, sigma=12.294144947901014)
     >>> temperature_feb.samples(3)        # Generate random samples
     [7.672102882379219, 12.000027119750287, 4.647488369766392]

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35904

   (2) https://bugs.python.org/issue27181

   (3) https://bugs.python.org/issue35892

   (4) https://bugs.python.org/issue36546

   (5) https://bugs.python.org/issue36018


File: python.info,  Node: sys,  Next: tarfile,  Prev: statistics,  Up: Improved Modules

1.1.5.35 sys
............

Add new *note sys.unraisablehook(): 22b. function which can be
overridden to control how “unraisable exceptions” are handled.  It is
called when an exception has occurred but there is no way for Python to
handle it.  For example, when a destructor raises an exception or during
garbage collection (*note gc.collect(): 22c.).  (Contributed by Victor
Stinner in bpo-36829(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36829


File: python.info,  Node: tarfile,  Next: threading,  Prev: sys,  Up: Improved Modules

1.1.5.36 tarfile
................

The *note tarfile: 101. module now defaults to the modern pax
(POSIX.1-2001) format for new archives, instead of the previous
GNU-specific one.  This improves cross-platform portability with a
consistent encoding (UTF-8) in a standardized and extensible format, and
offers several other benefits.  (Contributed by C.A.M. Gerlach in
bpo-36268(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36268


File: python.info,  Node: threading,  Next: tokenize,  Prev: tarfile,  Up: Improved Modules

1.1.5.37 threading
..................

Add a new *note threading.excepthook(): 22f. function which handles
uncaught *note threading.Thread.run(): 230. exception.  It can be
overridden to control how uncaught *note threading.Thread.run(): 230.
exceptions are handled.  (Contributed by Victor Stinner in
bpo-1230540(1).)

Add a new *note threading.get_native_id(): 231. function and a *note
native_id: 232. attribute to the *note threading.Thread: 233. class.
These return the native integral Thread ID of the current thread
assigned by the kernel.  This feature is only available on certain
platforms, see *note get_native_id: 231. for more information.
(Contributed by Jake Tesler in bpo-36084(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1230540

   (2) https://bugs.python.org/issue36084


File: python.info,  Node: tokenize,  Next: tkinter,  Prev: threading,  Up: Improved Modules

1.1.5.38 tokenize
.................

The *note tokenize: 111. module now implicitly emits a ‘NEWLINE’ token
when provided with input that does not have a trailing new line.  This
behavior now matches what the C tokenizer does internally.  (Contributed
by Ammar Askar in bpo-33899(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33899


File: python.info,  Node: tkinter,  Next: time,  Prev: tokenize,  Up: Improved Modules

1.1.5.39 tkinter
................

Added methods ‘selection_from()’, ‘selection_present()’,
‘selection_range()’ and ‘selection_to()’ in the ‘tkinter.Spinbox’ class.
(Contributed by Juliette Monsel in bpo-34829(1).)

Added method ‘moveto()’ in the ‘tkinter.Canvas’ class.  (Contributed by
Juliette Monsel in bpo-23831(2).)

The ‘tkinter.PhotoImage’ class now has ‘transparency_get()’ and
‘transparency_set()’ methods.  (Contributed by Zackery Spytz in
bpo-25451(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34829

   (2) https://bugs.python.org/issue23831

   (3) https://bugs.python.org/issue25451


File: python.info,  Node: time,  Next: typing,  Prev: tkinter,  Up: Improved Modules

1.1.5.40 time
.............

Added new clock *note CLOCK_UPTIME_RAW: 237. for macOS 10.12.
(Contributed by Joannah Nanjekye in bpo-35702(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35702


File: python.info,  Node: typing,  Next: unicodedata,  Prev: time,  Up: Improved Modules

1.1.5.41 typing
...............

The *note typing: 119. module incorporates several new features:

   * A dictionary type with per-key types.  See PEP 589(1) and *note
     typing.TypedDict: 239.  TypedDict uses only string keys.  By
     default, every key is required to be present.  Specify
     “total=False” to allow keys to be optional:

          class Location(TypedDict, total=False):
              lat_long: tuple
              grid_square: str
              xy_coordinate: tuple

   * Literal types.  See PEP 586(2) and *note typing.Literal: 23a.
     Literal types indicate that a parameter or return value is
     constrained to one or more specific literal values:

          def get_status(port: int) -> Literal['connected', 'disconnected']:
              ...

   * “Final” variables, functions, methods and classes.  See PEP 591(3),
     *note typing.Final: 23b. and *note typing.final(): 23c.  The final
     qualifier instructs a static type checker to restrict subclassing,
     overriding, or reassignment:

          pi: Final[float] = 3.1415926536

   * Protocol definitions.  See PEP 544(4), *note typing.Protocol: 23d.
     and *note typing.runtime_checkable(): 23e.  Simple ABCs like *note
     typing.SupportsInt: 23f. are now ‘Protocol’ subclasses.

   * New protocol class *note typing.SupportsIndex: 240.

   * New functions *note typing.get_origin(): 241. and *note
     typing.get_args(): 242.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0589

   (2) https://www.python.org/dev/peps/pep-0586

   (3) https://www.python.org/dev/peps/pep-0591

   (4) https://www.python.org/dev/peps/pep-0544


File: python.info,  Node: unicodedata,  Next: unittest,  Prev: typing,  Up: Improved Modules

1.1.5.42 unicodedata
....................

The *note unicodedata: 11a. module has been upgraded to use the Unicode
12.1.0(1) release.

New function *note is_normalized(): 244. can be used to verify a string
is in a specific normal form, often much faster than by actually
normalizing the string.  (Contributed by Max Belanger, David Euresti,
and Greg Price in bpo-32285(2) and bpo-37966(3)).

   ---------- Footnotes ----------

   (1) http://blog.unicode.org/2019/05/unicode-12-1-en.html

   (2) https://bugs.python.org/issue32285

   (3) https://bugs.python.org/issue37966


File: python.info,  Node: unittest,  Next: venv,  Prev: unicodedata,  Up: Improved Modules

1.1.5.43 unittest
.................

Added *note AsyncMock: 246. to support an asynchronous version of *note
Mock: 247.  Appropriate new assert functions for testing have been added
as well.  (Contributed by Lisa Roach in bpo-26467(1)).

Added *note addModuleCleanup(): 248. and *note addClassCleanup(): 249.
to unittest to support cleanups for ‘setUpModule()’ and *note
setUpClass(): 24a.  (Contributed by Lisa Roach in bpo-24412(2).)

Several mock assert functions now also print a list of actual calls upon
failure.  (Contributed by Petter Strandmark in bpo-35047(3).)

*note unittest: 11b. module gained support for coroutines to be used as
test cases with *note unittest.IsolatedAsyncioTestCase: 24b.
(Contributed by Andrew Svetlov in bpo-32972(4).)

Example:

     import unittest


     class TestRequest(unittest.IsolatedAsyncioTestCase):

         async def asyncSetUp(self):
             self.connection = await AsyncConnection()

         async def test_get(self):
             response = await self.connection.get("https://example.com")
             self.assertEqual(response.status_code, 200)

         async def asyncTearDown(self):
             await self.connection.close()


     if __name__ == "__main__":
         unittest.main()

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26467

   (2) https://bugs.python.org/issue24412

   (3) https://bugs.python.org/issue35047

   (4) https://bugs.python.org/issue32972


File: python.info,  Node: venv,  Next: weakref,  Prev: unittest,  Up: Improved Modules

1.1.5.44 venv
.............

*note venv: 125. now includes an ‘Activate.ps1’ script on all platforms
for activating virtual environments under PowerShell Core 6.1.
(Contributed by Brett Cannon in bpo-32718(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32718


File: python.info,  Node: weakref,  Next: xml,  Prev: venv,  Up: Improved Modules

1.1.5.45 weakref
................

The proxy objects returned by *note weakref.proxy(): 24e. now support
the matrix multiplication operators ‘@’ and ‘@=’ in addition to the
other numeric operators.  (Contributed by Mark Dickinson in
bpo-36669(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36669


File: python.info,  Node: xml,  Next: xmlrpc,  Prev: weakref,  Up: Improved Modules

1.1.5.46 xml
............

As mitigation against DTD and external entity retrieval, the *note
xml.dom.minidom: 135. and *note xml.sax: 13b. modules no longer process
external entities by default.  (Contributed by Christian Heimes in
bpo-17239(1).)

The ‘.find*()’ methods in the *note xml.etree.ElementTree: 137. module
support wildcard searches like ‘{*}tag’ which ignores the namespace and
‘{namespace}*’ which returns all tags in the given namespace.
(Contributed by Stefan Behnel in bpo-28238(2).)

The *note xml.etree.ElementTree: 137. module provides a new function
‘–xml.etree.ElementTree.canonicalize()’ that implements C14N 2.0.
(Contributed by Stefan Behnel in bpo-13611(3).)

The target object of *note xml.etree.ElementTree.XMLParser: 250. can
receive namespace declaration events through the new callback methods
‘start_ns()’ and ‘end_ns()’.  Additionally, the *note
xml.etree.ElementTree.TreeBuilder: 251. target can be configured to
process events about comments and processing instructions to include
them in the generated tree.  (Contributed by Stefan Behnel in
bpo-36676(4) and bpo-36673(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17239

   (2) https://bugs.python.org/issue28238

   (3) https://bugs.python.org/issue13611

   (4) https://bugs.python.org/issue36676

   (5) https://bugs.python.org/issue36673


File: python.info,  Node: xmlrpc,  Prev: xml,  Up: Improved Modules

1.1.5.47 xmlrpc
...............

*note xmlrpc.client.ServerProxy: 253. now supports an optional `headers'
keyword argument for a sequence of HTTP headers to be sent with each
request.  Among other things, this makes it possible to upgrade from
default basic authentication to faster session authentication.
(Contributed by Cédric Krier in bpo-35153(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35153


File: python.info,  Node: Optimizations,  Next: Build and C API Changes,  Prev: Improved Modules,  Up: What’s New In Python 3 8

1.1.6 Optimizations
-------------------

   * The *note subprocess: f9. module can now use the *note
     os.posix_spawn(): 255. function in some cases for better
     performance.  Currently, it is only used on macOS and Linux (using
     glibc 2.24 or newer) if all these conditions are met:

        * `close_fds' is false;

        * `preexec_fn', `pass_fds', `cwd' and `start_new_session'
          parameters are not set;

        * the `executable' path contains a directory.

     (Contributed by Joannah Nanjekye and Victor Stinner in
     bpo-35537(1).)

   * *note shutil.copyfile(): 256, *note shutil.copy(): 257, *note
     shutil.copy2(): 258, *note shutil.copytree(): 218. and *note
     shutil.move(): 259. use platform-specific “fast-copy” syscalls on
     Linux and macOS in order to copy the file more efficiently.
     “fast-copy” means that the copying operation occurs within the
     kernel, avoiding the use of userspace buffers in Python as in
     “‘outfd.write(infd.read())’”.  On Windows *note shutil.copyfile():
     256. uses a bigger default buffer size (1 MiB instead of 16 KiB)
     and a *note memoryview(): 25a.-based variant of *note
     shutil.copyfileobj(): 25b. is used.  The speedup for copying a 512
     MiB file within the same partition is about +26% on Linux, +50% on
     macOS and +40% on Windows.  Also, much less CPU cycles are
     consumed.  See *note Platform-dependent efficient copy operations:
     25c. section.  (Contributed by Giampaolo Rodolà in bpo-33671(2).)

   * *note shutil.copytree(): 218. uses *note os.scandir(): 25d.
     function and all copy functions depending from it use cached *note
     os.stat(): 1ef. values.  The speedup for copying a directory with
     8000 files is around +9% on Linux, +20% on Windows and +30% on a
     Windows SMB share.  Also the number of *note os.stat(): 1ef.
     syscalls is reduced by 38% making *note shutil.copytree(): 218.
     especially faster on network filesystems.  (Contributed by
     Giampaolo Rodolà in bpo-33695(3).)

   * The default protocol in the *note pickle: ca. module is now
     Protocol 4, first introduced in Python 3.4.  It offers better
     performance and smaller size compared to Protocol 3 available since
     Python 3.0.

   * Removed one ‘Py_ssize_t’ member from ‘PyGC_Head’.  All GC tracked
     objects (e.g.  tuple, list, dict) size is reduced 4 or 8 bytes.
     (Contributed by Inada Naoki in bpo-33597(4).)

   * *note uuid.UUID: 25e. now uses ‘__slots__’ to reduce its memory
     footprint.  (Contributed by Wouter Bolsterlee and Tal Einat in
     bpo-30977(5))

   * Improved performance of *note operator.itemgetter(): 25f. by 33%.
     Optimized argument handling and added a fast path for the common
     case of a single non-negative integer index into a tuple (which is
     the typical use case in the standard library).  (Contributed by
     Raymond Hettinger in bpo-35664(6).)

   * Sped-up field lookups in *note collections.namedtuple(): 1b5.  They
     are now more than two times faster, making them the fastest form of
     instance variable lookup in Python.  (Contributed by Raymond
     Hettinger, Pablo Galindo, and Joe Jevnik, Serhiy Storchaka in
     bpo-32492(7).)

   * The *note list: 260. constructor does not overallocate the internal
     item buffer if the input iterable has a known length (the input
     implements ‘__len__’).  This makes the created list 12% smaller on
     average.  (Contributed by Raymond Hettinger and Pablo Galindo in
     bpo-33234(8).)

   * Doubled the speed of class variable writes.  When a non-dunder
     attribute was updated, there was an unnecessary call to update
     slots.  (Contributed by Stefan Behnel, Pablo Galindo Salgado,
     Raymond Hettinger, Neil Schemenauer, and Serhiy Storchaka in
     bpo-36012(9).)

   * Reduced an overhead of converting arguments passed to many builtin
     functions and methods.  This sped up calling some simple builtin
     functions and methods up to 20–50%.  (Contributed by Serhiy
     Storchaka in bpo-23867(10), bpo-35582(11) and bpo-36127(12).)

   * ‘LOAD_GLOBAL’ instruction now uses new “per opcode cache”
     mechanism.  It is about 40% faster now.  (Contributed by Yury
     Selivanov and Inada Naoki in bpo-26219(13).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35537

   (2) https://bugs.python.org/issue33671

   (3) https://bugs.python.org/issue33695

   (4) https://bugs.python.org/issue33597

   (5) https://bugs.python.org/issue30977

   (6) https://bugs.python.org/issue35664

   (7) https://bugs.python.org/issue32492

   (8) https://bugs.python.org/issue33234

   (9) https://bugs.python.org/issue36012

   (10) https://bugs.python.org/issue23867

   (11) https://bugs.python.org/issue35582

   (12) https://bugs.python.org/issue36127

   (13) https://bugs.python.org/issue26219


File: python.info,  Node: Build and C API Changes,  Next: Deprecated,  Prev: Optimizations,  Up: What’s New In Python 3 8

1.1.7 Build and C API Changes
-----------------------------

   * Default *note sys.abiflags: 262. became an empty string: the ‘m’
     flag for pymalloc became useless (builds with and without pymalloc
     are ABI compatible) and so has been removed.  (Contributed by
     Victor Stinner in bpo-36707(1).)

     Example of changes:

        * Only ‘python3.8’ program is installed, ‘python3.8m’ program is
          gone.

        * Only ‘python3.8-config’ script is installed,
          ‘python3.8m-config’ script is gone.

        * The ‘m’ flag has been removed from the suffix of dynamic
          library filenames: extension modules in the standard library
          as well as those produced and installed by third-party
          packages, like those downloaded from PyPI. On Linux, for
          example, the Python 3.7 suffix
          ‘.cpython-37m-x86_64-linux-gnu.so’ became
          ‘.cpython-38-x86_64-linux-gnu.so’ in Python 3.8.

   * The header files have been reorganized to better separate the
     different kinds of APIs:

        * ‘Include/*.h’ should be the portable public stable C API.

        * ‘Include/cpython/*.h’ should be the unstable C API specific to
          CPython; public API, with some private API prefixed by ‘_Py’
          or ‘_PY’.

        * ‘Include/internal/*.h’ is the private internal C API very
          specific to CPython.  This API comes with no backward
          compatibility warranty and should not be used outside CPython.
          It is only exposed for very specific needs like debuggers and
          profiles which has to access to CPython internals without
          calling functions.  This API is now installed by ‘make
          install’.

     (Contributed by Victor Stinner in bpo-35134(2) and bpo-35081(3),
     work initiated by Eric Snow in Python 3.7.)

   * Some macros have been converted to static inline functions:
     parameter types and return type are well defined, they don’t have
     issues specific to macros, variables have a local scopes.
     Examples:

        * *note Py_INCREF(): 263, *note Py_DECREF(): 264.

        * *note Py_XINCREF(): 265, *note Py_XDECREF(): 266.

        * ‘PyObject_INIT()’, ‘PyObject_INIT_VAR()’

        * Private functions: ‘_PyObject_GC_TRACK()’,
          ‘_PyObject_GC_UNTRACK()’, ‘_Py_Dealloc()’

     (Contributed by Victor Stinner in bpo-35059(4).)

   * The ‘PyByteArray_Init()’ and ‘PyByteArray_Fini()’ functions have
     been removed.  They did nothing since Python 2.7.4 and Python
     3.2.0, were excluded from the limited API (stable ABI), and were
     not documented.  (Contributed by Victor Stinner in bpo-35713(5).)

   * The result of ‘PyExceptionClass_Name()’ is now of type ‘const char
     *’ rather of ‘char *’.  (Contributed by Serhiy Storchaka in
     bpo-33818(6).)

   * The duality of ‘Modules/Setup.dist’ and ‘Modules/Setup’ has been
     removed.  Previously, when updating the CPython source tree, one
     had to manually copy ‘Modules/Setup.dist’ (inside the source tree)
     to ‘Modules/Setup’ (inside the build tree) in order to reflect any
     changes upstream.  This was of a small benefit to packagers at the
     expense of a frequent annoyance to developers following CPython
     development, as forgetting to copy the file could produce build
     failures.

     Now the build system always reads from ‘Modules/Setup’ inside the
     source tree.  People who want to customize that file are encouraged
     to maintain their changes in a git fork of CPython or as patch
     files, as they would do for any other change to the source tree.

     (Contributed by Antoine Pitrou in bpo-32430(7).)

   * Functions that convert Python number to C integer like *note
     PyLong_AsLong(): 267. and argument parsing functions like *note
     PyArg_ParseTuple(): 268. with integer converting format units like
     ‘'i'’ will now use the *note __index__(): 18a. special method
     instead of *note __int__(): 18b, if available.  The deprecation
     warning will be emitted for objects with the ‘__int__()’ method but
     without the ‘__index__()’ method (like *note Decimal: 188. and
     *note Fraction: 185.).  *note PyNumber_Check(): 269. will now
     return ‘1’ for objects implementing ‘__index__()’.  *note
     PyNumber_Long(): 26a, *note PyNumber_Float(): 26b. and *note
     PyFloat_AsDouble(): 26c. also now use the ‘__index__()’ method if
     available.  (Contributed by Serhiy Storchaka in bpo-36048(8) and
     bpo-20092(9).)

   * Heap-allocated type objects will now increase their reference count
     in *note PyObject_Init(): 26d. (and its parallel macro
     ‘PyObject_INIT’) instead of in *note PyType_GenericAlloc(): 26e.
     Types that modify instance allocation or deallocation may need to
     be adjusted.  (Contributed by Eddie Elizondo in bpo-35810(10).)

   * The new function *note PyCode_NewWithPosOnlyArgs(): 26f. allows to
     create code objects like *note PyCode_New(): 270, but with an extra
     `posonlyargcount' parameter for indicating the number of
     positional-only arguments.  (Contributed by Pablo Galindo in
     bpo-37221(11).)

   * *note Py_SetPath(): 271. now sets *note sys.executable: 272. to the
     program full path (*note Py_GetProgramFullPath(): 273.) rather than
     to the program name (*note Py_GetProgramName(): 274.).
     (Contributed by Victor Stinner in bpo-38234(12).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36707

   (2) https://bugs.python.org/issue35134

   (3) https://bugs.python.org/issue35081

   (4) https://bugs.python.org/issue35059

   (5) https://bugs.python.org/issue35713

   (6) https://bugs.python.org/issue33818

   (7) https://bugs.python.org/issue32430

   (8) https://bugs.python.org/issue36048

   (9) https://bugs.python.org/issue20092

   (10) https://bugs.python.org/issue35810

   (11) https://bugs.python.org/issue37221

   (12) https://bugs.python.org/issue38234


File: python.info,  Node: Deprecated,  Next: API and Feature Removals,  Prev: Build and C API Changes,  Up: What’s New In Python 3 8

1.1.8 Deprecated
----------------

   * The distutils ‘bdist_wininst’ command is now deprecated, use
     ‘bdist_wheel’ (wheel packages) instead.  (Contributed by Victor
     Stinner in bpo-37481(1).)

   * Deprecated methods ‘getchildren()’ and ‘getiterator()’ in the *note
     ElementTree: 137. module now emit a *note DeprecationWarning: 276.
     instead of *note PendingDeprecationWarning: 277.  They will be
     removed in Python 3.9.  (Contributed by Serhiy Storchaka in
     bpo-29209(2).)

   * Passing an object that is not an instance of *note
     concurrent.futures.ThreadPoolExecutor: 278. to *note
     loop.set_default_executor(): 279. is deprecated and will be
     prohibited in Python 3.9.  (Contributed by Elvis Pranskevichus in
     bpo-34075(3).)

   * The *note __getitem__(): 27a. methods of *note
     xml.dom.pulldom.DOMEventStream: 27b, *note
     wsgiref.util.FileWrapper: 27c. and *note fileinput.FileInput: 27d.
     have been deprecated.

     Implementations of these methods have been ignoring their `index'
     parameter, and returning the next item instead.  (Contributed by
     Berker Peksag in bpo-9372(4).)

   * The *note typing.NamedTuple: 27e. class has deprecated the
     ‘_field_types’ attribute in favor of the ‘__annotations__’
     attribute which has the same information.  (Contributed by Raymond
     Hettinger in bpo-36320(5).)

   * *note ast: 8. classes ‘Num’, ‘Str’, ‘Bytes’, ‘NameConstant’ and
     ‘Ellipsis’ are considered deprecated and will be removed in future
     Python versions.  ‘Constant’ should be used instead.  (Contributed
     by Serhiy Storchaka in bpo-32892(6).)

   * *note ast.NodeVisitor: 27f. methods ‘visit_Num()’, ‘visit_Str()’,
     ‘visit_Bytes()’, ‘visit_NameConstant()’ and ‘visit_Ellipsis()’ are
     deprecated now and will not be called in future Python versions.
     Add the ‘visit_Constant()’ method to handle all constant nodes.
     (Contributed by Serhiy Storchaka in bpo-36917(7).)

   * The *note asyncio.coroutine(): 280. *note decorator: 281. is
     deprecated and will be removed in version 3.10.  Instead of
     ‘@asyncio.coroutine’, use *note async def: 282. instead.
     (Contributed by Andrew Svetlov in bpo-36921(8).)

   * In *note asyncio: a, the explicit passing of a `loop' argument has
     been deprecated and will be removed in version 3.10 for the
     following: *note asyncio.sleep(): 283, *note asyncio.gather(): 284,
     *note asyncio.shield(): 285, *note asyncio.wait_for(): 286, *note
     asyncio.wait(): 287, *note asyncio.as_completed(): 288, *note
     asyncio.Task: 1ab, *note asyncio.Lock: 289, *note asyncio.Event:
     28a, *note asyncio.Condition: 28b, *note asyncio.Semaphore: 28c,
     *note asyncio.BoundedSemaphore: 28d, *note asyncio.Queue: 28e,
     *note asyncio.create_subprocess_exec(): 28f, and *note
     asyncio.create_subprocess_shell(): 290.

   * The explicit passing of coroutine objects to *note asyncio.wait():
     287. has been deprecated and will be removed in version 3.11.
     (Contributed by Yury Selivanov in bpo-34790(9).)

   * The following functions and methods are deprecated in the *note
     gettext: 89. module: *note lgettext(): 291, *note ldgettext(): 292,
     *note lngettext(): 293. and *note ldngettext(): 294.  They return
     encoded bytes, and it’s possible that you will get unexpected
     Unicode-related exceptions if there are encoding problems with the
     translated strings.  It’s much better to use alternatives which
     return Unicode strings in Python 3.  These functions have been
     broken for a long time.

     Function *note bind_textdomain_codeset(): 295, methods *note
     output_charset(): 296. and *note set_output_charset(): 297, and the
     `codeset' parameter of functions *note translation(): 298. and
     *note install(): 299. are also deprecated, since they are only used
     for for the ‘l*gettext()’ functions.  (Contributed by Serhiy
     Storchaka in bpo-33710(10).)

   * The ‘isAlive()’ method of *note threading.Thread: 233. has been
     deprecated.  (Contributed by Dong-hee Na in bpo-35283(11).)

   * Many builtin and extension functions that take integer arguments
     will now emit a deprecation warning for *note Decimal: 188.s, *note
     Fraction: 185.s and any other objects that can be converted to
     integers only with a loss (e.g.  that have the *note __int__():
     18b. method but do not have the *note __index__(): 18a. method).
     In future version they will be errors.  (Contributed by Serhiy
     Storchaka in bpo-36048(12).)

   * Deprecated passing the following arguments as keyword arguments:

        - `func' in *note functools.partialmethod(): 29a, *note
          weakref.finalize(): 29b, *note profile.Profile.runcall(): 29c,
          ‘cProfile.Profile.runcall()’, *note bdb.Bdb.runcall(): 29d,
          *note trace.Trace.runfunc(): 29e. and *note curses.wrapper():
          29f.

        - `function' in *note unittest.TestCase.addCleanup(): 2a0.

        - `fn' in the *note submit(): 2a1. method of *note
          concurrent.futures.ThreadPoolExecutor: 278. and *note
          concurrent.futures.ProcessPoolExecutor: 2a2.

        - `callback' in *note contextlib.ExitStack.callback(): 2a3,
          ‘contextlib.AsyncExitStack.callback()’ and *note
          contextlib.AsyncExitStack.push_async_callback(): 2a4.

        - `c' and `typeid' in the ‘create()’ method of
          ‘multiprocessing.managers.Server’ and
          ‘multiprocessing.managers.SharedMemoryServer’.

        - `obj' in *note weakref.finalize(): 29b.

     In future releases of Python, they will be *note positional-only:
     2a5.  (Contributed by Serhiy Storchaka in bpo-36492(13).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37481

   (2) https://bugs.python.org/issue29209

   (3) https://bugs.python.org/issue34075

   (4) https://bugs.python.org/issue9372

   (5) https://bugs.python.org/issue36320

   (6) https://bugs.python.org/issue32892

   (7) https://bugs.python.org/issue36917

   (8) https://bugs.python.org/issue36921

   (9) https://bugs.python.org/issue34790

   (10) https://bugs.python.org/issue33710

   (11) https://bugs.python.org/issue35283

   (12) https://bugs.python.org/issue36048

   (13) https://bugs.python.org/issue36492


File: python.info,  Node: API and Feature Removals,  Next: Porting to Python 3 8,  Prev: Deprecated,  Up: What’s New In Python 3 8

1.1.9 API and Feature Removals
------------------------------

The following features and APIs have been removed from Python 3.8:

   * Starting with Python 3.3, importing ABCs from *note collections:
     1e. was deprecated, and importing should be done from *note
     collections.abc: 1f.  Being able to import from collections was
     marked for removal in 3.8, but has been delayed to 3.9.  (See
     bpo-36952(1).)

   * The ‘macpath’ module, deprecated in Python 3.7, has been removed.
     (Contributed by Victor Stinner in bpo-35471(2).)

   * The function ‘platform.popen()’ has been removed, after having been
     deprecated since Python 3.3: use *note os.popen(): 2a7. instead.
     (Contributed by Victor Stinner in bpo-35345(3).)

   * The function ‘time.clock()’ has been removed, after having been
     deprecated since Python 3.3: use *note time.perf_counter(): 2a8. or
     *note time.process_time(): 2a9. instead, depending on your
     requirements, to have well-defined behavior.  (Contributed by
     Matthias Bussonnier in bpo-36895(4).)

   * The ‘pyvenv’ script has been removed in favor of ‘python3.8 -m
     venv’ to help eliminate confusion as to what Python interpreter the
     ‘pyvenv’ script is tied to.  (Contributed by Brett Cannon in
     bpo-25427(5).)

   * ‘parse_qs’, ‘parse_qsl’, and ‘escape’ are removed from the *note
     cgi: 16. module.  They are deprecated in Python 3.2 or older.  They
     should be imported from the ‘urllib.parse’ and ‘html’ modules
     instead.

   * ‘filemode’ function is removed from the *note tarfile: 101. module.
     It is not documented and deprecated since Python 3.3.

   * The *note XMLParser: 250. constructor no longer accepts the `html'
     argument.  It never had an effect and was deprecated in Python 3.4.
     All other parameters are now *note keyword-only: 2aa.  (Contributed
     by Serhiy Storchaka in bpo-29209(6).)

   * Removed the ‘doctype()’ method of *note XMLParser: 250.
     (Contributed by Serhiy Storchaka in bpo-29209(7).)

   * “unicode_internal” codec is removed.  (Contributed by Inada Naoki
     in bpo-36297(8).)

   * The ‘Cache’ and ‘Statement’ objects of the *note sqlite3: f2.
     module are not exposed to the user.  (Contributed by Aviv Palivoda
     in bpo-30262(9).)

   * The ‘bufsize’ keyword argument of *note fileinput.input(): 2ab. and
     *note fileinput.FileInput(): 27d. which was ignored and deprecated
     since Python 3.6 has been removed.  bpo-36952(10) (Contributed by
     Matthias Bussonnier.)

   * The functions ‘sys.set_coroutine_wrapper()’ and
     ‘sys.get_coroutine_wrapper()’ deprecated in Python 3.7 have been
     removed; bpo-36933(11) (Contributed by Matthias Bussonnier.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36952

   (2) https://bugs.python.org/issue35471

   (3) https://bugs.python.org/issue35345

   (4) https://bugs.python.org/issue36895

   (5) https://bugs.python.org/issue25427

   (6) https://bugs.python.org/issue29209

   (7) https://bugs.python.org/issue29209

   (8) https://bugs.python.org/issue36297

   (9) https://bugs.python.org/issue30262

   (10) https://bugs.python.org/issue36952

   (11) https://bugs.python.org/issue36933


File: python.info,  Node: Porting to Python 3 8,  Next: Notable changes in Python 3 8 1,  Prev: API and Feature Removals,  Up: What’s New In Python 3 8

1.1.10 Porting to Python 3.8
----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code.

* Menu:

* Changes in Python behavior::
* Changes in the Python API::
* Changes in the C API::
* CPython bytecode changes::
* Demos and Tools::


File: python.info,  Node: Changes in Python behavior,  Next: Changes in the Python API,  Up: Porting to Python 3 8

1.1.10.1 Changes in Python behavior
...................................

   * Yield expressions (both ‘yield’ and ‘yield from’ clauses) are now
     disallowed in comprehensions and generator expressions (aside from
     the iterable expression in the leftmost ‘for’ clause).
     (Contributed by Serhiy Storchaka in bpo-10544(1).)

   * The compiler now produces a *note SyntaxWarning: 191. when identity
     checks (‘is’ and ‘is not’) are used with certain types of literals
     (e.g.  strings, numbers).  These can often work by accident in
     CPython, but are not guaranteed by the language spec.  The warning
     advises users to use equality tests (‘==’ and ‘!=’) instead.
     (Contributed by Serhiy Storchaka in bpo-34850(2).)

   * The CPython interpreter can swallow exceptions in some
     circumstances.  In Python 3.8 this happens in fewer cases.  In
     particular, exceptions raised when getting the attribute from the
     type dictionary are no longer ignored.  (Contributed by Serhiy
     Storchaka in bpo-35459(3).)

   * Removed ‘__str__’ implementations from builtin types *note bool:
     183, *note int: 184, *note float: 187, *note complex: 189. and few
     classes from the standard library.  They now inherit ‘__str__()’
     from *note object: 2ae.  As result, defining the ‘__repr__()’
     method in the subclass of these classes will affect their string
     representation.  (Contributed by Serhiy Storchaka in bpo-36793(4).)

   * On AIX, *note sys.platform: 2af. doesn’t contain the major version
     anymore.  It is always ‘'aix'’, instead of ‘'aix3'’ ..  ‘'aix7'’.
     Since older Python versions include the version number, so it is
     recommended to always use ‘sys.platform.startswith('aix')’.
     (Contributed by M. Felt in bpo-36588(5).)

   * *note PyEval_AcquireLock(): 2b0. and *note PyEval_AcquireThread():
     2b1. now terminate the current thread if called while the
     interpreter is finalizing, making them consistent with *note
     PyEval_RestoreThread(): 2b2, *note Py_END_ALLOW_THREADS(): 2b3, and
     *note PyGILState_Ensure(): 2b4.  If this behavior is not desired,
     guard the call by checking ‘_Py_IsFinalizing()’ or
     ‘sys.is_finalizing()’.  (Contributed by Joannah Nanjekye in
     bpo-36475(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10544

   (2) https://bugs.python.org/issue34850

   (3) https://bugs.python.org/issue35459

   (4) https://bugs.python.org/issue36793

   (5) https://bugs.python.org/issue36588

   (6) https://bugs.python.org/issue36475


File: python.info,  Node: Changes in the Python API,  Next: Changes in the C API,  Prev: Changes in Python behavior,  Up: Porting to Python 3 8

1.1.10.2 Changes in the Python API
..................................

   * The *note os.getcwdb(): 2b6. function now uses the UTF-8 encoding
     on Windows, rather than the ANSI code page: see PEP 529(1) for the
     rationale.  The function is no longer deprecated on Windows.
     (Contributed by Victor Stinner in bpo-37412(2).)

   * *note subprocess.Popen: 2b7. can now use *note os.posix_spawn():
     255. in some cases for better performance.  On Windows Subsystem
     for Linux and QEMU User Emulation, the ‘Popen’ constructor using
     *note os.posix_spawn(): 255. no longer raises an exception on
     errors like “missing program”.  Instead the child process fails
     with a non-zero ‘returncode’.  (Contributed by Joannah Nanjekye and
     Victor Stinner in bpo-35537(3).)

   * The `preexec_fn' argument of * *note subprocess.Popen: 2b7. is no
     longer compatible with subinterpreters.  The use of the parameter
     in a subinterpreter now raises *note RuntimeError: 2b8.
     (Contributed by Eric Snow in bpo-34651(4), modified by Christian
     Heimes in bpo-37951(5).)

   * The ‘imap.IMAP4.logout()’ method no longer silently ignores
     arbitrary exceptions.  (Contributed by Victor Stinner in
     bpo-36348(6).)

   * The function ‘platform.popen()’ has been removed, after having been
     deprecated since Python 3.3: use *note os.popen(): 2a7. instead.
     (Contributed by Victor Stinner in bpo-35345(7).)

   * The *note statistics.mode(): 2b9. function no longer raises an
     exception when given multimodal data.  Instead, it returns the
     first mode encountered in the input data.  (Contributed by Raymond
     Hettinger in bpo-35892(8).)

   * The *note selection(): 2ba. method of the *note
     tkinter.ttk.Treeview: 2bb. class no longer takes arguments.  Using
     it with arguments for changing the selection was deprecated in
     Python 3.6.  Use specialized methods like *note selection_set():
     2bc. for changing the selection.  (Contributed by Serhiy Storchaka
     in bpo-31508(9).)

   * The ‘writexml()’, ‘toxml()’ and ‘toprettyxml()’ methods of *note
     xml.dom.minidom: 135, and the ‘write()’ method of ‘xml.etree’, now
     preserve the attribute order specified by the user.  (Contributed
     by Diego Rojas and Raymond Hettinger in bpo-34160(10).)

   * A *note dbm.dumb: 33. database opened with flags ‘'r'’ is now
     read-only.  *note dbm.dumb.open(): 2bd. with flags ‘'r'’ and ‘'w'’
     no longer creates a database if it does not exist.  (Contributed by
     Serhiy Storchaka in bpo-32749(11).)

   * The ‘doctype()’ method defined in a subclass of *note XMLParser:
     250. will no longer be called and will emit a *note RuntimeWarning:
     2be. instead of a *note DeprecationWarning: 276.  Define the *note
     doctype(): 2bf. method on a target for handling an XML doctype
     declaration.  (Contributed by Serhiy Storchaka in bpo-29209(12).)

   * A *note RuntimeError: 2b8. is now raised when the custom metaclass
     doesn’t provide the ‘__classcell__’ entry in the namespace passed
     to ‘type.__new__’.  A *note DeprecationWarning: 276. was emitted in
     Python 3.6–3.7.  (Contributed by Serhiy Storchaka in
     bpo-23722(13).)

   * The ‘cProfile.Profile’ class can now be used as a context manager.
     (Contributed by Scott Sanderson in bpo-29235(14).)

   * *note shutil.copyfile(): 256, *note shutil.copy(): 257, *note
     shutil.copy2(): 258, *note shutil.copytree(): 218. and *note
     shutil.move(): 259. use platform-specific “fast-copy” syscalls (see
     *note Platform-dependent efficient copy operations: 25c. section).

   * *note shutil.copyfile(): 256. default buffer size on Windows was
     changed from 16 KiB to 1 MiB.

   * The ‘PyGC_Head’ struct has changed completely.  All code that
     touched the struct member should be rewritten.  (See
     bpo-33597(15).)

   * The *note PyInterpreterState: 2c0. struct has been moved into the
     “internal” header files (specifically
     Include/internal/pycore_pystate.h).  An opaque ‘PyInterpreterState’
     is still available as part of the public API (and stable ABI). The
     docs indicate that none of the struct’s fields are public, so we
     hope no one has been using them.  However, if you do rely on one or
     more of those private fields and have no alternative then please
     open a BPO issue.  We’ll work on helping you adjust (possibly
     including adding accessor functions to the public API). (See
     bpo-35886(16).)

   * The *note mmap.flush(): 2c1. method now returns ‘None’ on success
     and raises an exception on error under all platforms.  Previously,
     its behavior was platform-dependent: a nonzero value was returned
     on success; zero was returned on error under Windows.  A zero value
     was returned on success; an exception was raised on error under
     Unix.  (Contributed by Berker Peksag in bpo-2122(17).)

   * *note xml.dom.minidom: 135. and *note xml.sax: 13b. modules no
     longer process external entities by default.  (Contributed by
     Christian Heimes in bpo-17239(18).)

   * Deleting a key from a read-only *note dbm: 32. database (*note
     dbm.dumb: 33, *note dbm.gnu: 34. or *note dbm.ndbm: 35.) raises
     ‘error’ (*note dbm.dumb.error: 2c2, *note dbm.gnu.error: 2c3. or
     *note dbm.ndbm.error: 2c4.) instead of *note KeyError: 2c5.
     (Contributed by Xiang Zhang in bpo-33106(19).)

   * *note expanduser(): 1fc. on Windows now prefers the ‘USERPROFILE’
     environment variable and does not use ‘HOME’, which is not normally
     set for regular user accounts.  (Contributed by Anthony Sottile in
     bpo-36264(20).)

   * The exception *note asyncio.CancelledError: 1a6. now inherits from
     *note BaseException: 1a7. rather than *note Exception: 1a8.
     (Contributed by Yury Selivanov in bpo-32528(21).)

   * The function *note asyncio.wait_for(): 286. now correctly waits for
     cancellation when using an instance of *note asyncio.Task: 1ab.
     Previously, upon reaching `timeout', it was cancelled and
     immediately returned.  (Contributed by Elvis Pranskevichus in
     bpo-32751(22).)

   * The function *note asyncio.BaseTransport.get_extra_info(): 2c6. now
     returns a safe to use socket object when ‘socket’ is passed to the
     `name' parameter.  (Contributed by Yury Selivanov in
     bpo-37027(23).)

   * *note asyncio.BufferedProtocol: 2c7. has graduated to the stable
     API.

   * DLL dependencies for extension modules and DLLs loaded with *note
     ctypes: 2b. on Windows are now resolved more securely.  Only the
     system paths, the directory containing the DLL or PYD file, and
     directories added with *note add_dll_directory(): 1c0. are searched
     for load-time dependencies.  Specifically, ‘PATH’ and the current
     working directory are no longer used, and modifications to these
     will no longer have any effect on normal DLL resolution.  If your
     application relies on these mechanisms, you should check for *note
     add_dll_directory(): 1c0. and if it exists, use it to add your DLLs
     directory while loading your library.  Note that Windows 7 users
     will need to ensure that Windows Update KB2533623 has been
     installed (this is also verified by the installer).  (Contributed
     by Steve Dower in bpo-36085(24).)

   * The header files and functions related to pgen have been removed
     after its replacement by a pure Python implementation.
     (Contributed by Pablo Galindo in bpo-36623(25).)

   * *note types.CodeType: 198. has a new parameter in the second
     position of the constructor (`posonlyargcount') to support
     positional-only arguments defined in PEP 570(26).  The first
     argument (`argcount') now represents the total number of positional
     arguments (including positional-only arguments).  The new
     ‘replace()’ method of *note types.CodeType: 198. can be used to
     make the code future-proof.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0529

   (2) https://bugs.python.org/issue37412

   (3) https://bugs.python.org/issue35537

   (4) https://bugs.python.org/issue34651

   (5) https://bugs.python.org/issue37951

   (6) https://bugs.python.org/issue36348

   (7) https://bugs.python.org/issue35345

   (8) https://bugs.python.org/issue35892

   (9) https://bugs.python.org/issue31508

   (10) https://bugs.python.org/issue34160

   (11) https://bugs.python.org/issue32749

   (12) https://bugs.python.org/issue29209

   (13) https://bugs.python.org/issue23722

   (14) https://bugs.python.org/issue29235

   (15) https://bugs.python.org/issue33597

   (16) https://bugs.python.org/issue35886

   (17) https://bugs.python.org/issue2122

   (18) https://bugs.python.org/issue17239

   (19) https://bugs.python.org/issue33106

   (20) https://bugs.python.org/issue36264

   (21) https://bugs.python.org/issue32528

   (22) https://bugs.python.org/issue32751

   (23) https://bugs.python.org/issue37027

   (24) https://bugs.python.org/issue36085

   (25) https://bugs.python.org/issue36623

   (26) https://www.python.org/dev/peps/pep-0570


File: python.info,  Node: Changes in the C API,  Next: CPython bytecode changes,  Prev: Changes in the Python API,  Up: Porting to Python 3 8

1.1.10.3 Changes in the C API
.............................

   * The *note PyCompilerFlags: 2ca. structure got a new
     `cf_feature_version' field.  It should be initialized to
     ‘PY_MINOR_VERSION’.  The field is ignored by default, and is used
     if and only if ‘PyCF_ONLY_AST’ flag is set in `cf_flags'.
     (Contributed by Guido van Rossum in bpo-35766(1).)

   * The ‘PyEval_ReInitThreads()’ function has been removed from the C
     API. It should not be called explicitly: use *note
     PyOS_AfterFork_Child(): 2cb. instead.  (Contributed by Victor
     Stinner in bpo-36728(2).)

   * On Unix, C extensions are no longer linked to libpython except on
     Android and Cygwin.  When Python is embedded, ‘libpython’ must not
     be loaded with ‘RTLD_LOCAL’, but ‘RTLD_GLOBAL’ instead.
     Previously, using ‘RTLD_LOCAL’, it was already not possible to load
     C extensions which were not linked to ‘libpython’, like C
     extensions of the standard library built by the ‘*shared*’ section
     of ‘Modules/Setup’.  (Contributed by Victor Stinner in
     bpo-21536(3).)

   * Use of ‘#’ variants of formats in parsing or building value (e.g.
     *note PyArg_ParseTuple(): 268, *note Py_BuildValue(): 2cc, *note
     PyObject_CallFunction(): 2cd, etc.)  without ‘PY_SSIZE_T_CLEAN’
     defined raises ‘DeprecationWarning’ now.  It will be removed in
     3.10 or 4.0.  Read *note Parsing arguments and building values:
     2ce. for detail.  (Contributed by Inada Naoki in bpo-36381(4).)

   * Instances of heap-allocated types (such as those created with *note
     PyType_FromSpec(): 2cf.) hold a reference to their type object.
     Increasing the reference count of these type objects has been moved
     from *note PyType_GenericAlloc(): 26e. to the more low-level
     functions, *note PyObject_Init(): 26d. and ‘PyObject_INIT()’.  This
     makes types created through *note PyType_FromSpec(): 2cf. behave
     like other classes in managed code.

     Statically allocated types are not affected.

     For the vast majority of cases, there should be no side effect.
     However, types that manually increase the reference count after
     allocating an instance (perhaps to work around the bug) may now
     become immortal.  To avoid this, these classes need to call
     Py_DECREF on the type object during instance deallocation.

     To correctly port these types into 3.8, please apply the following
     changes:

        * Remove *note Py_INCREF: 263. on the type object after
          allocating an instance - if any.  This may happen after
          calling *note PyObject_New(): 2d0, *note PyObject_NewVar():
          2d1, *note PyObject_GC_New(): 2d2, *note PyObject_GC_NewVar():
          2d3, or any other custom allocator that uses *note
          PyObject_Init(): 26d. or ‘PyObject_INIT()’.

          Example:

               static foo_struct *
               foo_new(PyObject *type) {
                   foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
                   if (foo == NULL)
                       return NULL;
               #if PY_VERSION_HEX < 0x03080000
                   // Workaround for Python issue 35810; no longer necessary in Python 3.8
                   PY_INCREF(type)
               #endif
                   return foo;
               }

        * Ensure that all custom ‘tp_dealloc’ functions of
          heap-allocated types decrease the type’s reference count.

          Example:

               static void
               foo_dealloc(foo_struct *instance) {
                   PyObject *type = Py_TYPE(instance);
                   PyObject_GC_Del(instance);
               #if PY_VERSION_HEX >= 0x03080000
                   // This was not needed before Python 3.8 (Python issue 35810)
                   Py_DECREF(type);
               #endif
               }

     (Contributed by Eddie Elizondo in bpo-35810(5).)

   * The ‘Py_DEPRECATED()’ macro has been implemented for MSVC. The
     macro now must be placed before the symbol name.

     Example:

          Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);

     (Contributed by Zackery Spytz in bpo-33407(6).)

   * The interpreter does not pretend to support binary compatibility of
     extension types across feature releases, anymore.  A *note
     PyTypeObject: 2d4. exported by a third-party extension module is
     supposed to have all the slots expected in the current Python
     version, including *note tp_finalize: 2d5. (*note
     Py_TPFLAGS_HAVE_FINALIZE: 2d6. is not checked anymore before
     reading *note tp_finalize: 2d5.).

     (Contributed by Antoine Pitrou in bpo-32388(7).)

   * The *note PyCode_New(): 270. has a new parameter in the second
     position (`posonlyargcount') to support PEP 570(8), indicating the
     number of positional-only arguments.

   * The functions ‘PyNode_AddChild()’ and ‘PyParser_AddToken()’ now
     accept two additional ‘int’ arguments `end_lineno' and
     `end_col_offset'.

   * The ‘libpython38.a’ file to allow MinGW tools to link directly
     against ‘python38.dll’ is no longer included in the regular Windows
     distribution.  If you require this file, it may be generated with
     the ‘gendef’ and ‘dlltool’ tools, which are part of the MinGW
     binutils package:

          gendef python38.dll > tmp.def
          dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a

     The location of an installed ‘pythonXY.dll’ will depend on the
     installation options and the version and language of Windows.  See
     *note Using Python on Windows: 2d7. for more information.  The
     resulting library should be placed in the same directory as
     ‘pythonXY.lib’, which is generally the ‘libs’ directory under your
     Python installation.

     (Contributed by Steve Dower in bpo-37351(9).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35766

   (2) https://bugs.python.org/issue36728

   (3) https://bugs.python.org/issue21536

   (4) https://bugs.python.org/issue36381

   (5) https://bugs.python.org/issue35810

   (6) https://bugs.python.org/issue33407

   (7) https://bugs.python.org/issue32388

   (8) https://www.python.org/dev/peps/pep-0570

   (9) https://bugs.python.org/issue37351


File: python.info,  Node: CPython bytecode changes,  Next: Demos and Tools,  Prev: Changes in the C API,  Up: Porting to Python 3 8

1.1.10.4 CPython bytecode changes
.................................

   * The interpreter loop has been simplified by moving the logic of
     unrolling the stack of blocks into the compiler.  The compiler
     emits now explicit instructions for adjusting the stack of values
     and calling the cleaning-up code for *note break: 2d9, *note
     continue: 181. and *note return: 190.

     Removed opcodes ‘BREAK_LOOP’, ‘CONTINUE_LOOP’, ‘SETUP_LOOP’ and
     ‘SETUP_EXCEPT’.  Added new opcodes *note ROT_FOUR: 2da, *note
     BEGIN_FINALLY: 2db, *note CALL_FINALLY: 2dc. and *note POP_FINALLY:
     2dd.  Changed the behavior of *note END_FINALLY: 2de. and *note
     WITH_CLEANUP_START: 2df.

     (Contributed by Mark Shannon, Antoine Pitrou and Serhiy Storchaka
     in bpo-17611(1).)

   * Added new opcode *note END_ASYNC_FOR: 2e0. for handling exceptions
     raised when awaiting a next item in an *note async for: 2e1. loop.
     (Contributed by Serhiy Storchaka in bpo-33041(2).)

   * The *note MAP_ADD: 2e2. now expects the value as the first element
     in the stack and the key as the second element.  This change was
     made so the key is always evaluated before the value in dictionary
     comprehensions, as proposed by PEP 572(3).  (Contributed by Jörn
     Heissler in bpo-35224(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17611

   (2) https://bugs.python.org/issue33041

   (3) https://www.python.org/dev/peps/pep-0572

   (4) https://bugs.python.org/issue35224


File: python.info,  Node: Demos and Tools,  Prev: CPython bytecode changes,  Up: Porting to Python 3 8

1.1.10.5 Demos and Tools
........................

Added a benchmark script for timing various ways to access variables:
‘Tools/scripts/var_access_benchmark.py’.  (Contributed by Raymond
Hettinger in bpo-35884(1).)

Here’s a summary of performance improvements since Python 3.3:

     Python version                       3.3     3.4     3.5     3.6     3.7     3.8
     --------------                       ---     ---     ---     ---     ---     ---

     Variable and attribute read access:
         read_local                       4.0     7.1     7.1     5.4     5.1     3.9
         read_nonlocal                    5.3     7.1     8.1     5.8     5.4     4.4
         read_global                     13.3    15.5    19.0    14.3    13.6     7.6
         read_builtin                    20.0    21.1    21.6    18.5    19.0     7.5
         read_classvar_from_class        20.5    25.6    26.5    20.7    19.5    18.4
         read_classvar_from_instance     18.5    22.8    23.5    18.8    17.1    16.4
         read_instancevar                26.8    32.4    33.1    28.0    26.3    25.4
         read_instancevar_slots          23.7    27.8    31.3    20.8    20.8    20.2
         read_namedtuple                 68.5    73.8    57.5    45.0    46.8    18.4
         read_boundmethod                29.8    37.6    37.9    29.6    26.9    27.7

     Variable and attribute write access:
         write_local                      4.6     8.7     9.3     5.5     5.3     4.3
         write_nonlocal                   7.3    10.5    11.1     5.6     5.5     4.7
         write_global                    15.9    19.7    21.2    18.0    18.0    15.8
         write_classvar                  81.9    92.9    96.0   104.6   102.1    39.2
         write_instancevar               36.4    44.6    45.8    40.0    38.9    35.5
         write_instancevar_slots         28.7    35.6    36.1    27.3    26.6    25.7

     Data structure read access:
         read_list                       19.2    24.2    24.5    20.8    20.8    19.0
         read_deque                      19.9    24.7    25.5    20.2    20.6    19.8
         read_dict                       19.7    24.3    25.7    22.3    23.0    21.0
         read_strdict                    17.9    22.6    24.3    19.5    21.2    18.9

     Data structure write access:
         write_list                      21.2    27.1    28.5    22.5    21.6    20.0
         write_deque                     23.8    28.7    30.1    22.7    21.8    23.5
         write_dict                      25.9    31.4    33.3    29.3    29.2    24.7
         write_strdict                   22.9    28.4    29.9    27.5    25.2    23.1

     Stack (or queue) operations:
         list_append_pop                144.2    93.4   112.7    75.4    74.2    50.8
         deque_append_pop                30.4    43.5    57.0    49.4    49.2    42.5
         deque_append_popleft            30.8    43.7    57.3    49.7    49.7    42.8

     Timing loop:
         loop_overhead                    0.3     0.5     0.6     0.4     0.3     0.3

     (Measured from the macOS 64-bit builds found at python.org)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35884


File: python.info,  Node: Notable changes in Python 3 8 1,  Prev: Porting to Python 3 8,  Up: What’s New In Python 3 8

1.1.11 Notable changes in Python 3.8.1
--------------------------------------

Due to significant security concerns, the `reuse_address' parameter of
*note asyncio.loop.create_datagram_endpoint(): 2e5. is no longer
supported.  This is because of the behavior of the socket option
‘SO_REUSEADDR’ in UDP. For more details, see the documentation for
‘loop.create_datagram_endpoint()’.  (Contributed by Kyle Stanley,
Antoine Pitrou, and Yury Selivanov in bpo-37228(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37228


File: python.info,  Node: What’s New In Python 3 7,  Next: What’s New In Python 3 6,  Prev: What’s New In Python 3 8,  Up: What’s New in Python

1.2 What’s New In Python 3.7
============================


Editor: Elvis Pranskevichus <<elvis@magic.io>>

This article explains the new features in Python 3.7, compared to 3.6.
Python 3.7 was released on June 27, 2018.  For full details, see the
*note changelog: 14c.

* Menu:

* Summary – Release Highlights::
* New Features: New Features<2>.
* Other Language Changes: Other Language Changes<2>.
* New Modules: New Modules<2>.
* Improved Modules: Improved Modules<2>.
* C API Changes::
* Build Changes::
* Optimizations: Optimizations<2>.
* Other CPython Implementation Changes::
* Deprecated Python Behavior::
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods.
* Deprecated functions and types of the C API::
* Platform Support Removals::
* API and Feature Removals: API and Feature Removals<2>.
* Module Removals::
* Windows-only Changes::
* Porting to Python 3.7: Porting to Python 3 7.
* Notable changes in Python 3.7.1: Notable changes in Python 3 7 1.
* Notable changes in Python 3.7.2: Notable changes in Python 3 7 2.
* Notable changes in Python 3.7.6: Notable changes in Python 3 7 6.


File: python.info,  Node: Summary – Release Highlights,  Next: New Features<2>,  Up: What’s New In Python 3 7

1.2.1 Summary – Release Highlights
----------------------------------

New syntax features:

   * *note PEP 563: 2e9, postponed evaluation of type annotations.

Backwards incompatible syntax changes:

   * *note async: 1a1. and *note await: 1a2. are now reserved keywords.

New library modules:

   * *note contextvars: 25.: *note PEP 567 – Context Variables: 2ea.

   * *note dataclasses: 30.: *note PEP 557 – Data Classes: 2eb.

   * *note importlib.resources: 2ec.

New built-in features:

   * *note PEP 553: 2ed, the new *note breakpoint(): 2ee. function.

Python data model improvements:

   * *note PEP 562: 2ef, customization of access to module attributes.

   * *note PEP 560: 2f0, core support for typing module and generic
     types.

   * the insertion-order preservation nature of *note dict: 2f1. objects
     has been declared(1) to be an official part of the Python language
     spec.

Significant improvements in the standard library:

   * The *note asyncio: a. module has received new features, significant
     *note usability and performance improvements: 2f2.

   * The *note time: 10a. module gained support for *note functions with
     nanosecond resolution: 2f3.

CPython implementation improvements:

   * Avoiding the use of ASCII as a default text encoding:

        * *note PEP 538: 2f4, legacy C locale coercion

        * *note PEP 540: 2f5, forced UTF-8 runtime mode

   * *note PEP 552: 2f6, deterministic .pycs

   * *note the new development runtime mode: 2f7.

   * *note PEP 565: 2f8, improved *note DeprecationWarning: 276.
     handling

C API improvements:

   * *note PEP 539: 2f9, new C API for thread-local storage

Documentation improvements:

   * *note PEP 545: 2fa, Python documentation translations

   * New documentation translations: Japanese(2), French(3), and
     Korean(4).

This release features notable performance improvements in many areas.
The *note Optimizations: 2fb. section lists them in detail.

For a list of changes that may affect compatibility with previous Python
releases please refer to the *note Porting to Python 3.7: 2fc. section.

   ---------- Footnotes ----------

   (1) 
https://mail.python.org/pipermail/python-dev/2017-December/151283.html

   (2) https://docs.python.org/ja/

   (3) https://docs.python.org/fr/

   (4) https://docs.python.org/ko/


File: python.info,  Node: New Features<2>,  Next: Other Language Changes<2>,  Prev: Summary – Release Highlights,  Up: What’s New In Python 3 7

1.2.2 New Features
------------------

* Menu:

* PEP 563; Postponed Evaluation of Annotations: PEP 563 Postponed Evaluation of Annotations.
* PEP 538; Legacy C Locale Coercion: PEP 538 Legacy C Locale Coercion.
* PEP 540; Forced UTF-8 Runtime Mode: PEP 540 Forced UTF-8 Runtime Mode.
* PEP 553; Built-in breakpoint(): PEP 553 Built-in breakpoint.
* PEP 539; New C API for Thread-Local Storage: PEP 539 New C API for Thread-Local Storage.
* PEP 562; Customization of Access to Module Attributes: PEP 562 Customization of Access to Module Attributes.
* PEP 564; New Time Functions With Nanosecond Resolution: PEP 564 New Time Functions With Nanosecond Resolution.
* PEP 565; Show DeprecationWarning in __main__: PEP 565 Show DeprecationWarning in __main__.
* PEP 560; Core Support for typing module and Generic Types: PEP 560 Core Support for typing module and Generic Types.
* PEP 552; Hash-based .pyc Files: PEP 552 Hash-based pyc Files.
* PEP 545; Python Documentation Translations: PEP 545 Python Documentation Translations.
* Development Runtime Mode; -X dev: Development Runtime Mode -X dev.


File: python.info,  Node: PEP 563 Postponed Evaluation of Annotations,  Next: PEP 538 Legacy C Locale Coercion,  Up: New Features<2>

1.2.2.1 PEP 563: Postponed Evaluation of Annotations
....................................................

The advent of type hints in Python uncovered two glaring usability
issues with the functionality of annotations added in PEP 3107(1) and
refined further in PEP 526(2):

   * annotations could only use names which were already available in
     the current scope, in other words they didn’t support forward
     references of any kind; and

   * annotating source code had adverse effects on startup time of
     Python programs.

Both of these issues are fixed by postponing the evaluation of
annotations.  Instead of compiling code which executes expressions in
annotations at their definition time, the compiler stores the annotation
in a string form equivalent to the AST of the expression in question.
If needed, annotations can be resolved at runtime using *note
typing.get_type_hints(): 2ff.  In the common case where this is not
required, the annotations are cheaper to store (since short strings are
interned by the interpreter) and make startup time faster.

Usability-wise, annotations now support forward references, making the
following syntax valid:

     class C:
         @classmethod
         def from_string(cls, source: str) -> C:
             ...

         def validate_b(self, obj: B) -> bool:
             ...

     class B:
         ...

Since this change breaks compatibility, the new behavior needs to be
enabled on a per-module basis in Python 3.7 using a *note __future__: 0.
import:

     from __future__ import annotations

It will become the default in Python 4.0.

See also
........

PEP 563(3) – Postponed evaluation of annotations

     PEP written and implemented by Łukasz Langa.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3107

   (2) https://www.python.org/dev/peps/pep-0526

   (3) https://www.python.org/dev/peps/pep-0563


File: python.info,  Node: PEP 538 Legacy C Locale Coercion,  Next: PEP 540 Forced UTF-8 Runtime Mode,  Prev: PEP 563 Postponed Evaluation of Annotations,  Up: New Features<2>

1.2.2.2 PEP 538: Legacy C Locale Coercion
.........................................

An ongoing challenge within the Python 3 series has been determining a
sensible default strategy for handling the “7-bit ASCII” text encoding
assumption currently implied by the use of the default C or POSIX locale
on non-Windows platforms.

PEP 538(1) updates the default interpreter command line interface to
automatically coerce that locale to an available UTF-8 based locale as
described in the documentation of the new *note PYTHONCOERCECLOCALE:
301. environment variable.  Automatically setting ‘LC_CTYPE’ this way
means that both the core interpreter and locale-aware C extensions (such
as *note readline: de.) will assume the use of UTF-8 as the default text
encoding, rather than ASCII.

The platform support definition in PEP 11(2) has also been updated to
limit full text handling support to suitably configured non-ASCII based
locales.

As part of this change, the default error handler for *note stdin: 302.
and *note stdout: 303. is now ‘surrogateescape’ (rather than ‘strict’)
when using any of the defined coercion target locales (currently
‘C.UTF-8’, ‘C.utf8’, and ‘UTF-8’).  The default error handler for *note
stderr: 304. continues to be ‘backslashreplace’, regardless of locale.

Locale coercion is silent by default, but to assist in debugging
potentially locale related integration problems, explicit warnings
(emitted directly on *note stderr: 304.) can be requested by setting
‘PYTHONCOERCECLOCALE=warn’.  This setting will also cause the Python
runtime to emit a warning if the legacy C locale remains active when the
core interpreter is initialized.

While PEP 538(3)’s locale coercion has the benefit of also affecting
extension modules (such as GNU ‘readline’), as well as child processes
(including those running non-Python applications and older versions of
Python), it has the downside of requiring that a suitable target locale
be present on the running system.  To better handle the case where no
suitable target locale is available (as occurs on RHEL/CentOS 7, for
example), Python 3.7 also implements *note PEP 540; Forced UTF-8 Runtime
Mode: 2f5.

See also
........

PEP 538(4) – Coercing the legacy C locale to a UTF-8 based locale

     PEP written and implemented by Nick Coghlan.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0538

   (2) https://www.python.org/dev/peps/pep-0011

   (3) https://www.python.org/dev/peps/pep-0538

   (4) https://www.python.org/dev/peps/pep-0538


File: python.info,  Node: PEP 540 Forced UTF-8 Runtime Mode,  Next: PEP 553 Built-in breakpoint,  Prev: PEP 538 Legacy C Locale Coercion,  Up: New Features<2>

1.2.2.3 PEP 540: Forced UTF-8 Runtime Mode
..........................................

The new *note -X: 155. ‘utf8’ command line option and *note PYTHONUTF8:
306. environment variable can be used to enable the CPython `UTF-8
mode'.

When in UTF-8 mode, CPython ignores the locale settings, and uses the
UTF-8 encoding by default.  The error handlers for *note sys.stdin: 302.
and *note sys.stdout: 303. streams are set to ‘surrogateescape’.

The forced UTF-8 mode can be used to change the text handling behavior
in an embedded Python interpreter without changing the locale settings
of an embedding application.

While PEP 540(1)’s UTF-8 mode has the benefit of working regardless of
which locales are available on the running system, it has the downside
of having no effect on extension modules (such as GNU ‘readline’), child
processes running non-Python applications, and child processes running
older versions of Python.  To reduce the risk of corrupting text data
when communicating with such components, Python 3.7 also implements
*note PEP 540; Forced UTF-8 Runtime Mode: 2f5.).

The UTF-8 mode is enabled by default when the locale is ‘C’ or ‘POSIX’,
and the PEP 538(2) locale coercion feature fails to change it to a UTF-8
based alternative (whether that failure is due to
‘PYTHONCOERCECLOCALE=0’ being set, ‘LC_ALL’ being set, or the lack of a
suitable target locale).

See also
........

PEP 540(3) – Add a new UTF-8 mode

     PEP written and implemented by Victor Stinner

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0540

   (2) https://www.python.org/dev/peps/pep-0538

   (3) https://www.python.org/dev/peps/pep-0540


File: python.info,  Node: PEP 553 Built-in breakpoint,  Next: PEP 539 New C API for Thread-Local Storage,  Prev: PEP 540 Forced UTF-8 Runtime Mode,  Up: New Features<2>

1.2.2.4 PEP 553: Built-in ‘breakpoint()’
........................................

Python 3.7 includes the new built-in *note breakpoint(): 2ee. function
as an easy and consistent way to enter the Python debugger.

Built-in ‘breakpoint()’ calls *note sys.breakpointhook(): 308.  By
default, the latter imports *note pdb: c9. and then calls
‘pdb.set_trace()’, but by binding ‘sys.breakpointhook()’ to the function
of your choosing, ‘breakpoint()’ can enter any debugger.  Additionally,
the environment variable *note PYTHONBREAKPOINT: 309. can be set to the
callable of your debugger of choice.  Set ‘PYTHONBREAKPOINT=0’ to
completely disable built-in ‘breakpoint()’.

See also
........

PEP 553(1) – Built-in breakpoint()

     PEP written and implemented by Barry Warsaw

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0553


File: python.info,  Node: PEP 539 New C API for Thread-Local Storage,  Next: PEP 562 Customization of Access to Module Attributes,  Prev: PEP 553 Built-in breakpoint,  Up: New Features<2>

1.2.2.5 PEP 539: New C API for Thread-Local Storage
...................................................

While Python provides a C API for thread-local storage support; the
existing *note Thread Local Storage (TLS) API: 30b. has used ‘int’ to
represent TLS keys across all platforms.  This has not generally been a
problem for officially-support platforms, but that is neither
POSIX-compliant, nor portable in any practical sense.

PEP 539(1) changes this by providing a new *note Thread Specific Storage
(TSS) API: 30c. to CPython which supersedes use of the existing TLS API
within the CPython interpreter, while deprecating the existing API. The
TSS API uses a new type *note Py_tss_t: 30d. instead of ‘int’ to
represent TSS keys–an opaque type the definition of which may depend on
the underlying TLS implementation.  Therefore, this will allow to build
CPython on platforms where the native TLS key is defined in a way that
cannot be safely cast to ‘int’.

Note that on platforms where the native TLS key is defined in a way that
cannot be safely cast to ‘int’, all functions of the existing TLS API
will be no-op and immediately return failure.  This indicates clearly
that the old API is not supported on platforms where it cannot be used
reliably, and that no effort will be made to add such support.

See also
........

PEP 539(2) – A New C-API for Thread-Local Storage in CPython

     PEP written by Erik M. Bray; implementation by Masayuki Yamamoto.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0539

   (2) https://www.python.org/dev/peps/pep-0539


File: python.info,  Node: PEP 562 Customization of Access to Module Attributes,  Next: PEP 564 New Time Functions With Nanosecond Resolution,  Prev: PEP 539 New C API for Thread-Local Storage,  Up: New Features<2>

1.2.2.6 PEP 562: Customization of Access to Module Attributes
.............................................................

Python 3.7 allows defining *note __getattr__(): 30f. on modules and will
call it whenever a module attribute is otherwise not found.  Defining
*note __dir__(): 310. on modules is now also allowed.

A typical example of where this may be useful is module attribute
deprecation and lazy loading.

See also
........

PEP 562(1) – Module ‘__getattr__’ and ‘__dir__’

     PEP written and implemented by Ivan Levkivskyi

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0562


File: python.info,  Node: PEP 564 New Time Functions With Nanosecond Resolution,  Next: PEP 565 Show DeprecationWarning in __main__,  Prev: PEP 562 Customization of Access to Module Attributes,  Up: New Features<2>

1.2.2.7 PEP 564: New Time Functions With Nanosecond Resolution
..............................................................

The resolution of clocks in modern systems can exceed the limited
precision of a floating point number returned by the *note time.time():
312. function and its variants.  To avoid loss of precision, PEP 564(1)
adds six new “nanosecond” variants of the existing timer functions to
the *note time: 10a. module:

   * *note time.clock_gettime_ns(): 313.

   * *note time.clock_settime_ns(): 314.

   * *note time.monotonic_ns(): 315.

   * *note time.perf_counter_ns(): 316.

   * *note time.process_time_ns(): 317.

   * *note time.time_ns(): 318.

The new functions return the number of nanoseconds as an integer value.

Measurements(2) show that on Linux and Windows the resolution of *note
time.time_ns(): 318. is approximately 3 times better than that of *note
time.time(): 312.

See also
........

PEP 564(3) – Add new time functions with nanosecond resolution

     PEP written and implemented by Victor Stinner

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0564

   (2) 
https://www.python.org/dev/peps/pep-0564/#annex-clocks-resolution-in-python

   (3) https://www.python.org/dev/peps/pep-0564


File: python.info,  Node: PEP 565 Show DeprecationWarning in __main__,  Next: PEP 560 Core Support for typing module and Generic Types,  Prev: PEP 564 New Time Functions With Nanosecond Resolution,  Up: New Features<2>

1.2.2.8 PEP 565: Show DeprecationWarning in ‘__main__’
......................................................

The default handling of *note DeprecationWarning: 276. has been changed
such that these warnings are once more shown by default, but only when
the code triggering them is running directly in the *note __main__: 1.
module.  As a result, developers of single file scripts and those using
Python interactively should once again start seeing deprecation warnings
for the APIs they use, but deprecation warnings triggered by imported
application, library and framework modules will continue to be hidden by
default.

As a result of this change, the standard library now allows developers
to choose between three different deprecation warning behaviours:

   * *note FutureWarning: 31a.: always displayed by default, recommended
     for warnings intended to be seen by application end users (e.g.
     for deprecated application configuration settings).

   * *note DeprecationWarning: 276.: displayed by default only in *note
     __main__: 1. and when running tests, recommended for warnings
     intended to be seen by other Python developers where a version
     upgrade may result in changed behaviour or an error.

   * *note PendingDeprecationWarning: 277.: displayed by default only
     when running tests, intended for cases where a future version
     upgrade will change the warning category to *note
     DeprecationWarning: 276. or *note FutureWarning: 31a.

Previously both *note DeprecationWarning: 276. and *note
PendingDeprecationWarning: 277. were only visible when running tests,
which meant that developers primarily writing single file scripts or
using Python interactively could be surprised by breaking changes in the
APIs they used.

See also
........

PEP 565(1) – Show DeprecationWarning in ‘__main__’

     PEP written and implemented by Nick Coghlan

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0565


File: python.info,  Node: PEP 560 Core Support for typing module and Generic Types,  Next: PEP 552 Hash-based pyc Files,  Prev: PEP 565 Show DeprecationWarning in __main__,  Up: New Features<2>

1.2.2.9 PEP 560: Core Support for ‘typing’ module and Generic Types
...................................................................

Initially PEP 484(1) was designed in such way that it would not
introduce `any' changes to the core CPython interpreter.  Now type hints
and the *note typing: 119. module are extensively used by the community,
so this restriction is removed.  The PEP introduces two special methods
*note __class_getitem__(): 31c. and ‘__mro_entries__’, these methods are
now used by most classes and special constructs in *note typing: 119.
As a result, the speed of various operations with types increased up to
7 times, the generic types can be used without metaclass conflicts, and
several long standing bugs in *note typing: 119. module are fixed.

See also
........

PEP 560(2) – Core support for typing module and generic types

     PEP written and implemented by Ivan Levkivskyi

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484

   (2) https://www.python.org/dev/peps/pep-0560


File: python.info,  Node: PEP 552 Hash-based pyc Files,  Next: PEP 545 Python Documentation Translations,  Prev: PEP 560 Core Support for typing module and Generic Types,  Up: New Features<2>

1.2.2.10 PEP 552: Hash-based .pyc Files
.......................................

Python has traditionally checked the up-to-dateness of bytecode cache
files (i.e., ‘.pyc’ files) by comparing the source metadata
(last-modified timestamp and size) with source metadata saved in the
cache file header when it was generated.  While effective, this
invalidation method has its drawbacks.  When filesystem timestamps are
too coarse, Python can miss source updates, leading to user confusion.
Additionally, having a timestamp in the cache file is problematic for
build reproducibility(1) and content-based build systems.

PEP 552(2) extends the pyc format to allow the hash of the source file
to be used for invalidation instead of the source timestamp.  Such
‘.pyc’ files are called “hash-based”.  By default, Python still uses
timestamp-based invalidation and does not generate hash-based ‘.pyc’
files at runtime.  Hash-based ‘.pyc’ files may be generated with *note
py_compile: d7. or *note compileall: 21.

Hash-based ‘.pyc’ files come in two variants: checked and unchecked.
Python validates checked hash-based ‘.pyc’ files against the
corresponding source files at runtime but doesn’t do so for unchecked
hash-based pycs.  Unchecked hash-based ‘.pyc’ files are a useful
performance optimization for environments where a system external to
Python (e.g., the build system) is responsible for keeping ‘.pyc’ files
up-to-date.

See *note Cached bytecode invalidation: 31e. for more information.

See also
........

PEP 552(3) – Deterministic pycs

     PEP written and implemented by Benjamin Peterson

   ---------- Footnotes ----------

   (1) https://reproducible-builds.org/

   (2) https://www.python.org/dev/peps/pep-0552

   (3) https://www.python.org/dev/peps/pep-0552


File: python.info,  Node: PEP 545 Python Documentation Translations,  Next: Development Runtime Mode -X dev,  Prev: PEP 552 Hash-based pyc Files,  Up: New Features<2>

1.2.2.11 PEP 545: Python Documentation Translations
...................................................

PEP 545(1) describes the process of creating and maintaining Python
documentation translations.

Three new translations have been added:

   - Japanese: ‘https://docs.python.org/ja/’

   - French: ‘https://docs.python.org/fr/’

   - Korean: ‘https://docs.python.org/ko/’

See also
........

PEP 545(2) – Python Documentation Translations

     PEP written and implemented by Julien Palard, Inada Naoki, and
     Victor Stinner.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0545

   (2) https://www.python.org/dev/peps/pep-0545


File: python.info,  Node: Development Runtime Mode -X dev,  Prev: PEP 545 Python Documentation Translations,  Up: New Features<2>

1.2.2.12 Development Runtime Mode: -X dev
.........................................

The new *note -X: 155. ‘dev’ command line option or the new *note
PYTHONDEVMODE: 321. environment variable can be used to enable CPython’s
`development mode'.  When in development mode, CPython performs
additional runtime checks that are too expensive to be enabled by
default.  See *note -X: 155. ‘dev’ documentation for the full
description of the effects of this mode.


File: python.info,  Node: Other Language Changes<2>,  Next: New Modules<2>,  Prev: New Features<2>,  Up: What’s New In Python 3 7

1.2.3 Other Language Changes
----------------------------

   * More than 255 arguments can now be passed to a function, and a
     function can now have more than 255 parameters.  (Contributed by
     Serhiy Storchaka in bpo-12844(1) and bpo-18896(2).)

   * *note bytes.fromhex(): 323. and *note bytearray.fromhex(): 324. now
     ignore all ASCII whitespace, not only spaces.  (Contributed by
     Robert Xiao in bpo-28927(3).)

   * *note str: 325, *note bytes: 326, and *note bytearray: 327. gained
     support for the new *note isascii(): 328. method, which can be used
     to test if a string or bytes contain only the ASCII characters.
     (Contributed by INADA Naoki in bpo-32677(4).)

   * *note ImportError: 329. now displays module name and module
     ‘__file__’ path when ‘from ... import ...’ fails.  (Contributed by
     Matthias Bussonnier in bpo-29546(5).)

   * Circular imports involving absolute imports with binding a
     submodule to a name are now supported.  (Contributed by Serhiy
     Storchaka in bpo-30024(6).)

   * ‘object.__format__(x, '')’ is now equivalent to ‘str(x)’ rather
     than ‘format(str(self), '')’.  (Contributed by Serhiy Storchaka in
     bpo-28974(7).)

   * In order to better support dynamic creation of stack traces, *note
     types.TracebackType: 32a. can now be instantiated from Python code,
     and the ‘tb_next’ attribute on *note tracebacks: 32b. is now
     writable.  (Contributed by Nathaniel J. Smith in bpo-30579(8).)

   * When using the *note -m: 32c. switch, ‘sys.path[0]’ is now eagerly
     expanded to the full starting directory path, rather than being
     left as the empty directory (which allows imports from the
     `current' working directory at the time when an import occurs)
     (Contributed by Nick Coghlan in bpo-33053(9).)

   * The new *note -X: 155. ‘importtime’ option or the *note
     PYTHONPROFILEIMPORTTIME: 32d. environment variable can be used to
     show the timing of each module import.  (Contributed by Victor
     Stinner in bpo-31415(10).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12844

   (2) https://bugs.python.org/issue18896

   (3) https://bugs.python.org/issue28927

   (4) https://bugs.python.org/issue32677

   (5) https://bugs.python.org/issue29546

   (6) https://bugs.python.org/issue30024

   (7) https://bugs.python.org/issue28974

   (8) https://bugs.python.org/issue30579

   (9) https://bugs.python.org/issue33053

   (10) https://bugs.python.org/issue31415


File: python.info,  Node: New Modules<2>,  Next: Improved Modules<2>,  Prev: Other Language Changes<2>,  Up: What’s New In Python 3 7

1.2.4 New Modules
-----------------

* Menu:

* contextvars::
* dataclasses::
* importlib.resources: importlib resources.


File: python.info,  Node: contextvars,  Next: dataclasses,  Up: New Modules<2>

1.2.4.1 contextvars
...................

The new *note contextvars: 25. module and a set of *note new C APIs:
330. introduce support for `context variables'.  Context variables are
conceptually similar to thread-local variables.  Unlike TLS, context
variables support asynchronous code correctly.

The *note asyncio: a. and *note decimal: 36. modules have been updated
to use and support context variables out of the box.  Particularly the
active decimal context is now stored in a context variable, which allows
decimal operations to work with the correct context in asynchronous
code.

See also
........

PEP 567(1) – Context Variables

     PEP written and implemented by Yury Selivanov

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0567


File: python.info,  Node: dataclasses,  Next: importlib resources,  Prev: contextvars,  Up: New Modules<2>

1.2.4.2 dataclasses
...................

The new *note dataclass(): 332. decorator provides a way to declare
`data classes'.  A data class describes its attributes using class
variable annotations.  Its constructor and other magic methods, such as
*note __repr__(): 333, *note __eq__(): 334, and *note __hash__(): 335.
are generated automatically.

Example:

     @dataclass
     class Point:
         x: float
         y: float
         z: float = 0.0

     p = Point(1.5, 2.5)
     print(p)   # produces "Point(x=1.5, y=2.5, z=0.0)"

See also
........

PEP 557(1) – Data Classes

     PEP written and implemented by Eric V. Smith

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0557


File: python.info,  Node: importlib resources,  Prev: dataclasses,  Up: New Modules<2>

1.2.4.3 importlib.resources
...........................

The new *note importlib.resources: 9e. module provides several new APIs
and one new ABC for access to, opening, and reading `resources' inside
packages.  Resources are roughly similar to files inside packages, but
they needn’t be actual files on the physical file system.  Module
loaders can provide a ‘get_resource_reader()’ function which returns a
*note importlib.abc.ResourceReader: 337. instance to support this new
API. Built-in file path loaders and zip file loaders both support this.

Contributed by Barry Warsaw and Brett Cannon in bpo-32248(1).

See also
........

importlib_resources(2) – a PyPI backport for earlier Python versions.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32248

   (2) http://importlib-resources.readthedocs.io/en/latest/


File: python.info,  Node: Improved Modules<2>,  Next: C API Changes,  Prev: New Modules<2>,  Up: What’s New In Python 3 7

1.2.5 Improved Modules
----------------------

* Menu:

* argparse::
* asyncio: asyncio<2>.
* binascii::
* calendar::
* collections: collections<2>.
* compileall::
* concurrent.futures: concurrent futures.
* contextlib::
* cProfile: cProfile<2>.
* crypt::
* datetime: datetime<2>.
* dbm::
* decimal::
* dis::
* distutils::
* enum::
* functools: functools<2>.
* gc: gc<2>.
* hmac::
* http.client: http client.
* http.server: http server.
* idlelib and IDLE::
* importlib::
* io: io<2>.
* ipaddress::
* itertools: itertools<2>.
* locale::
* logging: logging<2>.
* math: math<2>.
* mimetypes::
* msilib::
* multiprocessing: multiprocessing<2>.
* os: os<2>.
* pathlib: pathlib<2>.
* pdb::
* py_compile: py_compile<2>.
* pydoc::
* queue::
* re::
* signal::
* socket: socket<2>.
* socketserver::
* sqlite3::
* ssl: ssl<2>.
* string::
* subprocess::
* sys: sys<2>.
* time: time<2>.
* tkinter: tkinter<2>.
* tracemalloc::
* types::
* unicodedata: unicodedata<2>.
* unittest: unittest<2>.
* unittest.mock: unittest mock.
* urllib.parse: urllib parse.
* uu::
* uuid::
* warnings::
* xml.etree: xml etree.
* xmlrpc.server: xmlrpc server.
* zipapp::
* zipfile::


File: python.info,  Node: argparse,  Next: asyncio<2>,  Up: Improved Modules<2>

1.2.5.1 argparse
................

The new *note ArgumentParser.parse_intermixed_args(): 33a. method allows
intermixing options and positional arguments.  (Contributed by paul.j3
in bpo-14191(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14191


File: python.info,  Node: asyncio<2>,  Next: binascii,  Prev: argparse,  Up: Improved Modules<2>

1.2.5.2 asyncio
...............

The *note asyncio: a. module has received many new features, usability
and *note performance improvements: 33c.  Notable changes include:

   * The new *note provisional: 33d. *note asyncio.run(): 1a4. function
     can be used to run a coroutine from synchronous code by
     automatically creating and destroying the event loop.  (Contributed
     by Yury Selivanov in bpo-32314(1).)

   * asyncio gained support for *note contextvars: 25.  *note
     loop.call_soon(): 33e, *note loop.call_soon_threadsafe(): 33f,
     *note loop.call_later(): 340, *note loop.call_at(): 341, and *note
     Future.add_done_callback(): 342. have a new optional keyword-only
     `context' parameter.  *note Tasks: 1ab. now track their context
     automatically.  See PEP 567(2) for more details.  (Contributed by
     Yury Selivanov in bpo-32436(3).)

   * The new *note asyncio.create_task(): 1ac. function has been added
     as a shortcut to ‘asyncio.get_event_loop().create_task()’.
     (Contributed by Andrew Svetlov in bpo-32311(4).)

   * The new *note loop.start_tls(): 343. method can be used to upgrade
     an existing connection to TLS. (Contributed by Yury Selivanov in
     bpo-23749(5).)

   * The new *note loop.sock_recv_into(): 344. method allows reading
     data from a socket directly into a provided buffer making it
     possible to reduce data copies.  (Contributed by Antoine Pitrou in
     bpo-31819(6).)

   * The new *note asyncio.current_task(): 345. function returns the
     currently running *note Task: 1ab. instance, and the new *note
     asyncio.all_tasks(): 346. function returns a set of all existing
     ‘Task’ instances in a given loop.  The *note Task.current_task():
     347. and *note Task.all_tasks(): 348. methods have been deprecated.
     (Contributed by Andrew Svetlov in bpo-32250(7).)

   * The new `provisional' *note BufferedProtocol: 2c7. class allows
     implementing streaming protocols with manual control over the
     receive buffer.  (Contributed by Yury Selivanov in bpo-32251(8).)

   * The new *note asyncio.get_running_loop(): 349. function returns the
     currently running loop, and raises a *note RuntimeError: 2b8. if no
     loop is running.  This is in contrast with *note
     asyncio.get_event_loop(): 34a, which will `create' a new event loop
     if none is running.  (Contributed by Yury Selivanov in
     bpo-32269(9).)

   * The new *note StreamWriter.wait_closed(): 34b. coroutine method
     allows waiting until the stream writer is closed.  The new *note
     StreamWriter.is_closing(): 34c. method can be used to determine if
     the writer is closing.  (Contributed by Andrew Svetlov in
     bpo-32391(10).)

   * The new *note loop.sock_sendfile(): 34d. coroutine method allows
     sending files using *note os.sendfile: 34e. when possible.
     (Contributed by Andrew Svetlov in bpo-32410(11).)

   * The new *note Future.get_loop(): 34f. and ‘Task.get_loop()’ methods
     return the instance of the loop on which a task or a future were
     created.  *note Server.get_loop(): 350. allows doing the same for
     *note asyncio.Server: 351. objects.  (Contributed by Yury Selivanov
     in bpo-32415(12) and Srinivas Reddy Thatiparthy in bpo-32418(13).)

   * It is now possible to control how instances of *note
     asyncio.Server: 351. begin serving.  Previously, the server would
     start serving immediately when created.  The new `start_serving'
     keyword argument to *note loop.create_server(): 352. and *note
     loop.create_unix_server(): 353, as well as *note
     Server.start_serving(): 354, and *note Server.serve_forever(): 355.
     can be used to decouple server instantiation and serving.  The new
     *note Server.is_serving(): 356. method returns ‘True’ if the server
     is serving.  *note Server: 351. objects are now asynchronous
     context managers:

          srv = await loop.create_server(...)

          async with srv:
              # some code

          # At this point, srv is closed and no longer accepts new connections.

     (Contributed by Yury Selivanov in bpo-32662(14).)

   * Callback objects returned by *note loop.call_later(): 340. gained
     the new *note when(): 357. method which returns an absolute
     scheduled callback timestamp.  (Contributed by Andrew Svetlov in
     bpo-32741(15).)

   * The *note loop.create_datagram_endpoint(): 2e5. method gained
     support for Unix sockets.  (Contributed by Quentin Dawans in
     bpo-31245(16).)

   * The *note asyncio.open_connection(): 358, *note
     asyncio.start_server(): 359. functions, *note
     loop.create_connection(): 1b0, *note loop.create_server(): 352,
     *note loop.create_accepted_socket(): 35a. methods and their
     corresponding UNIX socket variants now accept the
     `ssl_handshake_timeout' keyword argument.  (Contributed by Neil
     Aspinall in bpo-29970(17).)

   * The new *note Handle.cancelled(): 35b. method returns ‘True’ if the
     callback was cancelled.  (Contributed by Marat Sharafutdinov in
     bpo-31943(18).)

   * The asyncio source has been converted to use the *note async:
     1a1./*note await: 1a2. syntax.  (Contributed by Andrew Svetlov in
     bpo-32193(19).)

   * The new *note ReadTransport.is_reading(): 35c. method can be used
     to determine the reading state of the transport.  Additionally,
     calls to *note ReadTransport.resume_reading(): 35d. and *note
     ReadTransport.pause_reading(): 35e. are now idempotent.
     (Contributed by Yury Selivanov in bpo-32356(20).)

   * Loop methods which accept socket paths now support passing *note
     path-like objects: 35f.  (Contributed by Yury Selivanov in
     bpo-32066(21).)

   * In *note asyncio: a. TCP sockets on Linux are now created with
     ‘TCP_NODELAY’ flag set by default.  (Contributed by Yury Selivanov
     and Victor Stinner in bpo-27456(22).)

   * Exceptions occurring in cancelled tasks are no longer logged.
     (Contributed by Yury Selivanov in bpo-30508(23).)

   * New ‘WindowsSelectorEventLoopPolicy’ and
     ‘WindowsProactorEventLoopPolicy’ classes.  (Contributed by Yury
     Selivanov in bpo-33792(24).)

Several ‘asyncio’ APIs have been *note deprecated: 360.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32314

   (2) https://www.python.org/dev/peps/pep-0567

   (3) https://bugs.python.org/issue32436

   (4) https://bugs.python.org/issue32311

   (5) https://bugs.python.org/issue23749

   (6) https://bugs.python.org/issue31819

   (7) https://bugs.python.org/issue32250

   (8) https://bugs.python.org/issue32251

   (9) https://bugs.python.org/issue32269

   (10) https://bugs.python.org/issue32391

   (11) https://bugs.python.org/issue32410

   (12) https://bugs.python.org/issue32415

   (13) https://bugs.python.org/issue32418

   (14) https://bugs.python.org/issue32662

   (15) https://bugs.python.org/issue32741

   (16) https://bugs.python.org/issue31245

   (17) https://bugs.python.org/issue29970

   (18) https://bugs.python.org/issue31943

   (19) https://bugs.python.org/issue32193

   (20) https://bugs.python.org/issue32356

   (21) https://bugs.python.org/issue32066

   (22) https://bugs.python.org/issue27456

   (23) https://bugs.python.org/issue30508

   (24) https://bugs.python.org/issue33792


File: python.info,  Node: binascii,  Next: calendar,  Prev: asyncio<2>,  Up: Improved Modules<2>

1.2.5.3 binascii
................

The *note b2a_uu(): 362. function now accepts an optional `backtick'
keyword argument.  When it’s true, zeros are represented by ‘'`'’
instead of spaces.  (Contributed by Xiang Zhang in bpo-30103(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30103


File: python.info,  Node: calendar,  Next: collections<2>,  Prev: binascii,  Up: Improved Modules<2>

1.2.5.4 calendar
................

The *note HTMLCalendar: 364. class has new class attributes which ease
the customization of CSS classes in the produced HTML calendar.
(Contributed by Oz Tiram in bpo-30095(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30095


File: python.info,  Node: collections<2>,  Next: compileall,  Prev: calendar,  Up: Improved Modules<2>

1.2.5.5 collections
...................

‘collections.namedtuple()’ now supports default values.  (Contributed by
Raymond Hettinger in bpo-32320(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32320


File: python.info,  Node: compileall,  Next: concurrent futures,  Prev: collections<2>,  Up: Improved Modules<2>

1.2.5.6 compileall
..................

*note compileall.compile_dir(): 367. learned the new `invalidation_mode'
parameter, which can be used to enable *note hash-based .pyc
invalidation: 2f6.  The invalidation mode can also be specified on the
command line using the new ‘--invalidation-mode’ argument.  (Contributed
by Benjamin Peterson in bpo-31650(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31650


File: python.info,  Node: concurrent futures,  Next: contextlib,  Prev: compileall,  Up: Improved Modules<2>

1.2.5.7 concurrent.futures
..........................

*note ProcessPoolExecutor: 2a2. and *note ThreadPoolExecutor: 278. now
support the new `initializer' and `initargs' constructor arguments.
(Contributed by Antoine Pitrou in bpo-21423(1).)

The *note ProcessPoolExecutor: 2a2. can now take the multiprocessing
context via the new `mp_context' argument.  (Contributed by Thomas
Moreau in bpo-31540(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21423

   (2) https://bugs.python.org/issue31540


File: python.info,  Node: contextlib,  Next: cProfile<2>,  Prev: concurrent futures,  Up: Improved Modules<2>

1.2.5.8 contextlib
..................

The new *note nullcontext(): 36a. is a simpler and faster no-op context
manager than *note ExitStack: 36b.  (Contributed by Jesse-Bakker in
bpo-10049(1).)

The new *note asynccontextmanager(): 36c, *note
AbstractAsyncContextManager: 36d, and *note AsyncExitStack: 36e. have
been added to complement their synchronous counterparts.  (Contributed
by Jelle Zijlstra in bpo-29679(2) and bpo-30241(3), and by Alexander
Mohr and Ilya Kulakov in bpo-29302(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10049

   (2) https://bugs.python.org/issue29679

   (3) https://bugs.python.org/issue30241

   (4) https://bugs.python.org/issue29302


File: python.info,  Node: cProfile<2>,  Next: crypt,  Prev: contextlib,  Up: Improved Modules<2>

1.2.5.9 cProfile
................

The *note cProfile: 28. command line now accepts ‘-m module_name’ as an
alternative to script path.  (Contributed by Sanyam Khurana in
bpo-21862(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21862


File: python.info,  Node: crypt,  Next: datetime<2>,  Prev: cProfile<2>,  Up: Improved Modules<2>

1.2.5.10 crypt
..............

The *note crypt: 29. module now supports the Blowfish hashing method.
(Contributed by Serhiy Storchaka in bpo-31664(1).)

The *note mksalt(): 371. function now allows specifying the number of
rounds for hashing.  (Contributed by Serhiy Storchaka in bpo-31702(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31664

   (2) https://bugs.python.org/issue31702


File: python.info,  Node: datetime<2>,  Next: dbm,  Prev: crypt,  Up: Improved Modules<2>

1.2.5.11 datetime
.................

The new *note datetime.fromisoformat(): 373. method constructs a *note
datetime: 194. object from a string in one of the formats output by
*note datetime.isoformat(): 374.  (Contributed by Paul Ganssle in
bpo-15873(1).)

The *note tzinfo: 375. class now supports sub-minute offsets.
(Contributed by Alexander Belopolsky in bpo-5288(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15873

   (2) https://bugs.python.org/issue5288


File: python.info,  Node: dbm,  Next: decimal,  Prev: datetime<2>,  Up: Improved Modules<2>

1.2.5.12 dbm
............

*note dbm.dumb: 33. now supports reading read-only files and no longer
writes the index file when it is not changed.


File: python.info,  Node: decimal,  Next: dis,  Prev: dbm,  Up: Improved Modules<2>

1.2.5.13 decimal
................

The *note decimal: 36. module now uses *note context variables: 2ea. to
store the decimal context.  (Contributed by Yury Selivanov in
bpo-32630(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32630


File: python.info,  Node: dis,  Next: distutils,  Prev: decimal,  Up: Improved Modules<2>

1.2.5.14 dis
............

The *note dis(): 379. function is now able to disassemble nested code
objects (the code of comprehensions, generator expressions and nested
functions, and the code used for building nested classes).  The maximum
depth of disassembly recursion is controlled by the new `depth'
parameter.  (Contributed by Serhiy Storchaka in bpo-11822(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11822


File: python.info,  Node: distutils,  Next: enum,  Prev: dis,  Up: Improved Modules<2>

1.2.5.15 distutils
..................

‘README.rst’ is now included in the list of distutils standard READMEs
and therefore included in source distributions.  (Contributed by Ryan
Gonzalez in bpo-11913(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11913


File: python.info,  Node: enum,  Next: functools<2>,  Prev: distutils,  Up: Improved Modules<2>

1.2.5.16 enum
.............

The *note Enum: 37c. learned the new ‘_ignore_’ class property, which
allows listing the names of properties which should not become enum
members.  (Contributed by Ethan Furman in bpo-31801(1).)

In Python 3.8, attempting to check for non-Enum objects in ‘Enum’
classes will raise a *note TypeError: 192. (e.g.  ‘1 in Color’);
similarly, attempting to check for non-Flag objects in a ‘Flag’ member
will raise *note TypeError: 192. (e.g.  ‘1 in Perm.RW’); currently, both
operations return *note False: 37d. instead and are deprecated.
(Contributed by Ethan Furman in bpo-33217(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31801

   (2) https://bugs.python.org/issue33217


File: python.info,  Node: functools<2>,  Next: gc<2>,  Prev: enum,  Up: Improved Modules<2>

1.2.5.17 functools
..................

*note functools.singledispatch(): 37f. now supports registering
implementations using type annotations.  (Contributed by Łukasz Langa in
bpo-32227(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32227


File: python.info,  Node: gc<2>,  Next: hmac,  Prev: functools<2>,  Up: Improved Modules<2>

1.2.5.18 gc
...........

The new *note gc.freeze(): 381. function allows freezing all objects
tracked by the garbage collector and excluding them from future
collections.  This can be used before a POSIX ‘fork()’ call to make the
GC copy-on-write friendly or to speed up collection.  The new *note
gc.unfreeze(): 382. functions reverses this operation.  Additionally,
*note gc.get_freeze_count(): 383. can be used to obtain the number of
frozen objects.  (Contributed by Li Zekun in bpo-31558(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31558


File: python.info,  Node: hmac,  Next: http client,  Prev: gc<2>,  Up: Improved Modules<2>

1.2.5.19 hmac
.............

The *note hmac: 8f. module now has an optimized one-shot *note digest():
385. function, which is up to three times faster than ‘HMAC()’.
(Contributed by Christian Heimes in bpo-32433(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32433


File: python.info,  Node: http client,  Next: http server,  Prev: hmac,  Up: Improved Modules<2>

1.2.5.20 http.client
....................

*note HTTPConnection: 387. and *note HTTPSConnection: 388. now support
the new `blocksize' argument for improved upload throughput.
(Contributed by Nir Soffer in bpo-31945(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31945


File: python.info,  Node: http server,  Next: idlelib and IDLE,  Prev: http client,  Up: Improved Modules<2>

1.2.5.21 http.server
....................

*note SimpleHTTPRequestHandler: 38a. now supports the HTTP
‘If-Modified-Since’ header.  The server returns the 304 response status
if the target file was not modified after the time specified in the
header.  (Contributed by Pierre Quentel in bpo-29654(1).)

*note SimpleHTTPRequestHandler: 38a. accepts the new `directory'
argument, in addition to the new ‘--directory’ command line argument.
With this parameter, the server serves the specified directory, by
default it uses the current working directory.  (Contributed by Stéphane
Wirtel and Julien Palard in bpo-28707(2).)

The new *note ThreadingHTTPServer: 38b. class uses threads to handle
requests using ‘ThreadingMixin’.  It is used when ‘http.server’ is run
with ‘-m’.  (Contributed by Julien Palard in bpo-31639(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29654

   (2) https://bugs.python.org/issue28707

   (3) https://bugs.python.org/issue31639


File: python.info,  Node: idlelib and IDLE,  Next: importlib,  Prev: http server,  Up: Improved Modules<2>

1.2.5.22 idlelib and IDLE
.........................

Multiple fixes for autocompletion.  (Contributed by Louie Lu in
bpo-15786(1).)

Module Browser (on the File menu, formerly called Class Browser), now
displays nested functions and classes in addition to top-level functions
and classes.  (Contributed by Guilherme Polo, Cheryl Sabella, and Terry
Jan Reedy in bpo-1612262(2).)

The Settings dialog (Options, Configure IDLE) has been partly rewritten
to improve both appearance and function.  (Contributed by Cheryl Sabella
and Terry Jan Reedy in multiple issues.)

The font sample now includes a selection of non-Latin characters so that
users can better see the effect of selecting a particular font.
(Contributed by Terry Jan Reedy in bpo-13802(3).)  The sample can be
edited to include other characters.  (Contributed by Serhiy Storchaka in
bpo-31860(4).)

The IDLE features formerly implemented as extensions have been
reimplemented as normal features.  Their settings have been moved from
the Extensions tab to other dialog tabs.  (Contributed by Charles
Wohlganger and Terry Jan Reedy in bpo-27099(5).)

Editor code context option revised.  Box displays all context lines up
to maxlines.  Clicking on a context line jumps the editor to that line.
Context colors for custom themes is added to Highlights tab of Settings
dialog.  (Contributed by Cheryl Sabella and Terry Jan Reedy in
bpo-33642(6), bpo-33768(7), and bpo-33679(8).)

On Windows, a new API call tells Windows that tk scales for DPI. On
Windows 8.1+ or 10, with DPI compatibility properties of the Python
binary unchanged, and a monitor resolution greater than 96 DPI, this
should make text and lines sharper.  It should otherwise have no effect.
(Contributed by Terry Jan Reedy in bpo-33656(9).)

New in 3.7.1:

Output over N lines (50 by default) is squeezed down to a button.  N can
be changed in the PyShell section of the General page of the Settings
dialog.  Fewer, but possibly extra long, lines can be squeezed by right
clicking on the output.  Squeezed output can be expanded in place by
double-clicking the button or into the clipboard or a separate window by
right-clicking the button.  (Contributed by Tal Einat in
bpo-1529353(10).)

The changes above have been backported to 3.6 maintenance releases.

NEW in 3.7.4:

Add “Run Customized” to the Run menu to run a module with customized
settings.  Any command line arguments entered are added to sys.argv.
They re-appear in the box for the next customized run.  One can also
suppress the normal Shell main module restart.  (Contributed by Cheryl
Sabella, Terry Jan Reedy, and others in bpo-5680(11) and bpo-37627(12).)

New in 3.7.5:

Add optional line numbers for IDLE editor windows.  Windows open without
line numbers unless set otherwise in the General tab of the
configuration dialog.  Line numbers for an existing window are shown and
hidden in the Options menu.  (Contributed by Tal Einat and Saimadhav
Heblikar in bpo-17535(13).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15786

   (2) https://bugs.python.org/issue1612262

   (3) https://bugs.python.org/issue13802

   (4) https://bugs.python.org/issue31860

   (5) https://bugs.python.org/issue27099

   (6) https://bugs.python.org/issue33642

   (7) https://bugs.python.org/issue33768

   (8) https://bugs.python.org/issue33679

   (9) https://bugs.python.org/issue33656

   (10) https://bugs.python.org/issue1529353

   (11) https://bugs.python.org/issue5680

   (12) https://bugs.python.org/issue37627

   (13) https://bugs.python.org/issue17535


File: python.info,  Node: importlib,  Next: io<2>,  Prev: idlelib and IDLE,  Up: Improved Modules<2>

1.2.5.23 importlib
..................

The *note importlib.abc.ResourceReader: 337. ABC was introduced to
support the loading of resources from packages.  See also *note
importlib.resources: 2ec.  (Contributed by Barry Warsaw, Brett Cannon in
bpo-32248(1).)

*note importlib.reload(): 38e. now raises *note ModuleNotFoundError:
38f. if the module lacks a spec.  (Contributed by Garvit Khatri in
bpo-29851(2).)

‘importlib.find_spec()’ now raises *note ModuleNotFoundError: 38f.
instead of *note AttributeError: 390. if the specified parent module is
not a package (i.e.  lacks a ‘__path__’ attribute).  (Contributed by
Milan Oberkirch in bpo-30436(3).)

The new ‘importlib.source_hash()’ can be used to compute the hash of the
passed source.  A *note hash-based .pyc file: 2f6. embeds the value
returned by this function.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32248

   (2) https://bugs.python.org/issue29851

   (3) https://bugs.python.org/issue30436


File: python.info,  Node: io<2>,  Next: ipaddress,  Prev: importlib,  Up: Improved Modules<2>

1.2.5.24 io
...........

The new *note TextIOWrapper.reconfigure(): 392. method can be used to
reconfigure the text stream with the new settings.  (Contributed by
Antoine Pitrou in bpo-30526(1) and INADA Naoki in bpo-15216(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30526

   (2) https://bugs.python.org/issue15216


File: python.info,  Node: ipaddress,  Next: itertools<2>,  Prev: io<2>,  Up: Improved Modules<2>

1.2.5.25 ipaddress
..................

The new ‘subnet_of()’ and ‘supernet_of()’ methods of *note
ipaddress.IPv6Network: 394. and *note ipaddress.IPv4Network: 395. can be
used for network containment tests.  (Contributed by Michel Albert and
Cheryl Sabella in bpo-20825(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20825


File: python.info,  Node: itertools<2>,  Next: locale,  Prev: ipaddress,  Up: Improved Modules<2>

1.2.5.26 itertools
..................

*note itertools.islice(): 397. now accepts *note integer-like objects:
18a. as start, stop, and slice arguments.  (Contributed by Will Roberts
in bpo-30537(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30537


File: python.info,  Node: locale,  Next: logging<2>,  Prev: itertools<2>,  Up: Improved Modules<2>

1.2.5.27 locale
...............

The new `monetary' argument to *note locale.format_string(): 399. can be
used to make the conversion use monetary thousands separators and
grouping strings.  (Contributed by Garvit in bpo-10379(1).)

The *note locale.getpreferredencoding(): 39a. function now always
returns ‘'UTF-8'’ on Android or when in the *note forced UTF-8 mode:
2f5.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10379


File: python.info,  Node: logging<2>,  Next: math<2>,  Prev: locale,  Up: Improved Modules<2>

1.2.5.28 logging
................

*note Logger: 39c. instances can now be pickled.  (Contributed by Vinay
Sajip in bpo-30520(1).)

The new *note StreamHandler.setStream(): 39d. method can be used to
replace the logger stream after handler creation.  (Contributed by Vinay
Sajip in bpo-30522(2).)

It is now possible to specify keyword arguments to handler constructors
in configuration passed to *note logging.config.fileConfig(): 39e.
(Contributed by Preston Landers in bpo-31080(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30520

   (2) https://bugs.python.org/issue30522

   (3) https://bugs.python.org/issue31080


File: python.info,  Node: math<2>,  Next: mimetypes,  Prev: logging<2>,  Up: Improved Modules<2>

1.2.5.29 math
.............

The new *note math.remainder(): 3a0. function implements the IEEE
754-style remainder operation.  (Contributed by Mark Dickinson in
bpo-29962(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29962


File: python.info,  Node: mimetypes,  Next: msilib,  Prev: math<2>,  Up: Improved Modules<2>

1.2.5.30 mimetypes
..................

The MIME type of .bmp has been changed from ‘'image/x-ms-bmp'’ to
‘'image/bmp'’.  (Contributed by Nitish Chandra in bpo-22589(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22589


File: python.info,  Node: msilib,  Next: multiprocessing<2>,  Prev: mimetypes,  Up: Improved Modules<2>

1.2.5.31 msilib
...............

The new *note Database.Close(): 3a3. method can be used to close the MSI
(last-in, first-out) database.  (Contributed by Berker Peksag in
bpo-20486(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20486


File: python.info,  Node: multiprocessing<2>,  Next: os<2>,  Prev: msilib,  Up: Improved Modules<2>

1.2.5.32 multiprocessing
........................

The new *note Process.close(): 3a5. method explicitly closes the process
object and releases all resources associated with it.  *note ValueError:
1f9. is raised if the underlying process is still running.  (Contributed
by Antoine Pitrou in bpo-30596(1).)

The new *note Process.kill(): 3a6. method can be used to terminate the
process using the ‘SIGKILL’ signal on Unix.  (Contributed by Vitor
Pereira in bpo-30794(2).)

Non-daemonic threads created by *note Process: 3a7. are now joined on
process exit.  (Contributed by Antoine Pitrou in bpo-18966(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30596

   (2) https://bugs.python.org/issue30794

   (3) https://bugs.python.org/issue18966


File: python.info,  Node: os<2>,  Next: pathlib<2>,  Prev: multiprocessing<2>,  Up: Improved Modules<2>

1.2.5.33 os
...........

*note os.fwalk(): 3a9. now accepts the `path' argument as *note bytes:
326.  (Contributed by Serhiy Storchaka in bpo-28682(1).)

*note os.scandir(): 25d. gained support for *note file descriptors: 3aa.
(Contributed by Serhiy Storchaka in bpo-25996(2).)

The new *note register_at_fork(): 3ab. function allows registering
Python callbacks to be executed at process fork.  (Contributed by
Antoine Pitrou in bpo-16500(3).)

Added *note os.preadv(): 3ac. (combine the functionality of *note
os.readv(): 3ad. and *note os.pread(): 3ae.) and *note os.pwritev():
3af. functions (combine the functionality of *note os.writev(): 3b0. and
*note os.pwrite(): 3b1.).  (Contributed by Pablo Galindo in
bpo-31368(4).)

The mode argument of *note os.makedirs(): 3b2. no longer affects the
file permission bits of newly-created intermediate-level directories.
(Contributed by Serhiy Storchaka in bpo-19930(5).)

*note os.dup2(): 3b3. now returns the new file descriptor.  Previously,
‘None’ was always returned.  (Contributed by Benjamin Peterson in
bpo-32441(6).)

The structure returned by *note os.stat(): 1ef. now contains the *note
st_fstype: 3b4. attribute on Solaris and its derivatives.  (Contributed
by Jesús Cea Avión in bpo-32659(7).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28682

   (2) https://bugs.python.org/issue25996

   (3) https://bugs.python.org/issue16500

   (4) https://bugs.python.org/issue31368

   (5) https://bugs.python.org/issue19930

   (6) https://bugs.python.org/issue32441

   (7) https://bugs.python.org/issue32659


File: python.info,  Node: pathlib<2>,  Next: pdb,  Prev: os<2>,  Up: Improved Modules<2>

1.2.5.34 pathlib
................

The new *note Path.is_mount(): 203. method is now available on POSIX
systems and can be used to determine whether a path is a mount point.
(Contributed by Cooper Ry Lees in bpo-30897(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30897


File: python.info,  Node: pdb,  Next: py_compile<2>,  Prev: pathlib<2>,  Up: Improved Modules<2>

1.2.5.35 pdb
............

*note pdb.set_trace(): 3b7. now takes an optional `header' keyword-only
argument.  If given, it is printed to the console just before debugging
begins.  (Contributed by Barry Warsaw in bpo-31389(1).)

*note pdb: c9. command line now accepts ‘-m module_name’ as an
alternative to script file.  (Contributed by Mario Corchero in
bpo-32206(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31389

   (2) https://bugs.python.org/issue32206


File: python.info,  Node: py_compile<2>,  Next: pydoc,  Prev: pdb,  Up: Improved Modules<2>

1.2.5.36 py_compile
...................

*note py_compile.compile(): 213. – and by extension, *note compileall:
21. – now respects the ‘SOURCE_DATE_EPOCH’ environment variable by
unconditionally creating ‘.pyc’ files for hash-based validation.  This
allows for guaranteeing reproducible builds(1) of ‘.pyc’ files when they
are created eagerly.  (Contributed by Bernhard M. Wiedemann in
bpo-29708(2).)

   ---------- Footnotes ----------

   (1) https://reproducible-builds.org/

   (2) https://bugs.python.org/issue29708


File: python.info,  Node: pydoc,  Next: queue,  Prev: py_compile<2>,  Up: Improved Modules<2>

1.2.5.37 pydoc
..............

The pydoc server can now bind to an arbitrary hostname specified by the
new ‘-n’ command-line argument.  (Contributed by Feanil Patel in
bpo-31128(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31128


File: python.info,  Node: queue,  Next: re,  Prev: pydoc,  Up: Improved Modules<2>

1.2.5.38 queue
..............

The new *note SimpleQueue: 3bb. class is an unbounded FIFO (last-in,
first-out) queue.  (Contributed by Antoine Pitrou in bpo-14976(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14976


File: python.info,  Node: re,  Next: signal,  Prev: queue,  Up: Improved Modules<2>

1.2.5.39 re
...........

The flags *note re.ASCII: 3bd, *note re.LOCALE: 3be. and ‘re.UNICODE’
can be set within the scope of a group.  (Contributed by Serhiy
Storchaka in bpo-31690(1).)

*note re.split(): 3bf. now supports splitting on a pattern like ‘r'\b'’,
‘'^$'’ or ‘(?=-)’ that matches an empty string.  (Contributed by Serhiy
Storchaka in bpo-25054(2).)

Regular expressions compiled with the *note re.LOCALE: 3be. flag no
longer depend on the locale at compile time.  Locale settings are
applied only when the compiled regular expression is used.  (Contributed
by Serhiy Storchaka in bpo-30215(3).)

*note FutureWarning: 31a. is now emitted if a regular expression
contains character set constructs that will change semantically in the
future, such as nested sets and set operations.  (Contributed by Serhiy
Storchaka in bpo-30349(4).)

Compiled regular expression and match objects can now be copied using
*note copy.copy(): 3c0. and *note copy.deepcopy(): 3c1.  (Contributed by
Serhiy Storchaka in bpo-10076(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31690

   (2) https://bugs.python.org/issue25054

   (3) https://bugs.python.org/issue30215

   (4) https://bugs.python.org/issue30349

   (5) https://bugs.python.org/issue10076


File: python.info,  Node: signal,  Next: socket<2>,  Prev: re,  Up: Improved Modules<2>

1.2.5.40 signal
...............

The new `warn_on_full_buffer' argument to the *note
signal.set_wakeup_fd(): 3c3. function makes it possible to specify
whether Python prints a warning on stderr when the wakeup buffer
overflows.  (Contributed by Nathaniel J. Smith in bpo-30050(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30050


File: python.info,  Node: socket<2>,  Next: socketserver,  Prev: signal,  Up: Improved Modules<2>

1.2.5.41 socket
...............

The new *note socket.getblocking(): 3c5. method returns ‘True’ if the
socket is in blocking mode and ‘False’ otherwise.  (Contributed by Yury
Selivanov in bpo-32373(1).)

The new *note socket.close(): 3c6. function closes the passed socket
file descriptor.  This function should be used instead of *note
os.close(): 3c7. for better compatibility across platforms.
(Contributed by Christian Heimes in bpo-32454(2).)

The *note socket: ef. module now exposes the ‘socket.TCP_CONGESTION’
(Linux 2.6.13), ‘socket.TCP_USER_TIMEOUT’ (Linux 2.6.37), and
‘socket.TCP_NOTSENT_LOWAT’ (Linux 3.12) constants.  (Contributed by Omar
Sandoval in bpo-26273(3) and Nathaniel J. Smith in bpo-29728(4).)

Support for *note socket.AF_VSOCK: 3c8. sockets has been added to allow
communication between virtual machines and their hosts.  (Contributed by
Cathy Avery in bpo-27584(5).)

Sockets now auto-detect family, type and protocol from file descriptor
by default.  (Contributed by Christian Heimes in bpo-28134(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32373

   (2) https://bugs.python.org/issue32454

   (3) https://bugs.python.org/issue26273

   (4) https://bugs.python.org/issue29728

   (5) https://bugs.python.org/issue27584

   (6) https://bugs.python.org/issue28134


File: python.info,  Node: socketserver,  Next: sqlite3,  Prev: socket<2>,  Up: Improved Modules<2>

1.2.5.42 socketserver
.....................

‘socketserver.ThreadingMixIn.server_close()’ now waits until all
non-daemon threads complete.  ‘socketserver.ForkingMixIn.server_close()’
now waits until all child processes complete.

Add a new ‘socketserver.ForkingMixIn.block_on_close’ class attribute to
*note socketserver.ForkingMixIn: 3ca. and *note
socketserver.ThreadingMixIn: 3cb. classes.  Set the class attribute to
‘False’ to get the pre-3.7 behaviour.


File: python.info,  Node: sqlite3,  Next: ssl<2>,  Prev: socketserver,  Up: Improved Modules<2>

1.2.5.43 sqlite3
................

*note sqlite3.Connection: 3cd. now exposes the *note backup(): 3ce.
method when the underlying SQLite library is at version 3.6.11 or
higher.  (Contributed by Lele Gaifax in bpo-27645(1).)

The `database' argument of *note sqlite3.connect(): 3cf. now accepts any
*note path-like object: 35f, instead of just a string.  (Contributed by
Anders Lorentsen in bpo-31843(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27645

   (2) https://bugs.python.org/issue31843


File: python.info,  Node: ssl<2>,  Next: string,  Prev: sqlite3,  Up: Improved Modules<2>

1.2.5.44 ssl
............

The *note ssl: f3. module now uses OpenSSL’s builtin API instead of
*note match_hostname(): 3d1. to check a host name or an IP address.
Values are validated during TLS handshake.  Any certificate validation
error including failing the host name check now raises *note
SSLCertVerificationError: 3d2. and aborts the handshake with a proper
TLS Alert message.  The new exception contains additional information.
Host name validation can be customized with *note
SSLContext.hostname_checks_common_name: 3d3.  (Contributed by Christian
Heimes in bpo-31399(1).)

     Note: The improved host name check requires a `libssl'
     implementation compatible with OpenSSL 1.0.2 or 1.1.  Consequently,
     OpenSSL 0.9.8 and 1.0.1 are no longer supported (see *note Platform
     Support Removals: 3d4. for more details).  The ssl module is mostly
     compatible with LibreSSL 2.7.2 and newer.

The ‘ssl’ module no longer sends IP addresses in SNI TLS extension.
(Contributed by Christian Heimes in bpo-32185(2).)

*note match_hostname(): 3d1. no longer supports partial wildcards like
‘www*.example.org’.  (Contributed by Mandeep Singh in bpo-23033(3) and
Christian Heimes in bpo-31399(4).)

The default cipher suite selection of the ‘ssl’ module now uses a
blacklist approach rather than a hard-coded whitelist.  Python no longer
re-enables ciphers that have been blocked by OpenSSL security updates.
Default cipher suite selection can be configured at compile time.
(Contributed by Christian Heimes in bpo-31429(5).)

Validation of server certificates containing internationalized domain
names (IDNs) is now supported.  As part of this change, the *note
SSLSocket.server_hostname: 3d5. attribute now stores the expected
hostname in A-label form (‘"xn--pythn-mua.org"’), rather than the
U-label form (‘"pythön.org"’).  (Contributed by Nathaniel J. Smith and
Christian Heimes in bpo-28414(6).)

The ‘ssl’ module has preliminary and experimental support for TLS 1.3
and OpenSSL 1.1.1.  At the time of Python 3.7.0 release, OpenSSL 1.1.1
is still under development and TLS 1.3 hasn’t been finalized yet.  The
TLS 1.3 handshake and protocol behaves slightly differently than TLS 1.2
and earlier, see *note TLS 1.3: 3d6.  (Contributed by Christian Heimes
in bpo-32947(7), bpo-20995(8), bpo-29136(9), bpo-30622(10) and
bpo-33618(11))

*note SSLSocket: 3d7. and *note SSLObject: 3d8. no longer have a public
constructor.  Direct instantiation was never a documented and supported
feature.  Instances must be created with *note SSLContext: 3d9. methods
*note wrap_socket(): 3da. and *note wrap_bio(): 3db.  (Contributed by
Christian Heimes in bpo-32951(12))

OpenSSL 1.1 APIs for setting the minimum and maximum TLS protocol
version are available as *note SSLContext.minimum_version: 3dc. and
*note SSLContext.maximum_version: 3dd.  Supported protocols are
indicated by several new flags, such as *note HAS_TLSv1_1: 3de.
(Contributed by Christian Heimes in bpo-32609(13).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31399

   (2) https://bugs.python.org/issue32185

   (3) https://bugs.python.org/issue23033

   (4) https://bugs.python.org/issue31399

   (5) https://bugs.python.org/issue31429

   (6) https://bugs.python.org/issue28414

   (7) https://bugs.python.org/issue32947

   (8) https://bugs.python.org/issue20995

   (9) https://bugs.python.org/issue29136

   (10) https://bugs.python.org/issue30622

   (11) https://bugs.python.org/issue33618

   (12) https://bugs.python.org/issue32951

   (13) https://bugs.python.org/issue32609


File: python.info,  Node: string,  Next: subprocess,  Prev: ssl<2>,  Up: Improved Modules<2>

1.2.5.45 string
...............

*note string.Template: 3e0. now lets you to optionally modify the
regular expression pattern for braced placeholders and non-braced
placeholders separately.  (Contributed by Barry Warsaw in
bpo-1198569(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1198569


File: python.info,  Node: subprocess,  Next: sys<2>,  Prev: string,  Up: Improved Modules<2>

1.2.5.46 subprocess
...................

The *note subprocess.run(): 3e2. function accepts the new
`capture_output' keyword argument.  When true, stdout and stderr will be
captured.  This is equivalent to passing *note subprocess.PIPE: 3e3. as
`stdout' and `stderr' arguments.  (Contributed by Bo Bayles in
bpo-32102(1).)

The ‘subprocess.run’ function and the *note subprocess.Popen: 2b7.
constructor now accept the `text' keyword argument as an alias to
`universal_newlines'.  (Contributed by Andrew Clegg in bpo-31756(2).)

On Windows the default for `close_fds' was changed from ‘False’ to
‘True’ when redirecting the standard handles.  It’s now possible to set
`close_fds' to true when redirecting the standard handles.  See *note
subprocess.Popen: 2b7.  This means that `close_fds' now defaults to
‘True’ on all supported platforms.  (Contributed by Segev Finer in
bpo-19764(3).)

The subprocess module is now more graceful when handling *note
KeyboardInterrupt: 197. during *note subprocess.call(): 3e4, *note
subprocess.run(): 3e2, or in a *note Popen: 2b7. context manager.  It
now waits a short amount of time for the child to exit, before
continuing the handling of the ‘KeyboardInterrupt’ exception.
(Contributed by Gregory P. Smith in bpo-25942(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32102

   (2) https://bugs.python.org/issue31756

   (3) https://bugs.python.org/issue19764

   (4) https://bugs.python.org/issue25942


File: python.info,  Node: sys<2>,  Next: time<2>,  Prev: subprocess,  Up: Improved Modules<2>

1.2.5.47 sys
............

The new *note sys.breakpointhook(): 308. hook function is called by the
built-in *note breakpoint(): 2ee.  (Contributed by Barry Warsaw in
bpo-31353(1).)

On Android, the new *note sys.getandroidapilevel(): 3e6. returns the
build-time Android API version.  (Contributed by Victor Stinner in
bpo-28740(2).)

The new *note sys.get_coroutine_origin_tracking_depth(): 3e7. function
returns the current coroutine origin tracking depth, as set by the new
*note sys.set_coroutine_origin_tracking_depth(): 3e8.  *note asyncio: a.
has been converted to use this new API instead of the deprecated
‘sys.set_coroutine_wrapper()’.  (Contributed by Nathaniel J. Smith in
bpo-32591(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31353

   (2) https://bugs.python.org/issue28740

   (3) https://bugs.python.org/issue32591


File: python.info,  Node: time<2>,  Next: tkinter<2>,  Prev: sys<2>,  Up: Improved Modules<2>

1.2.5.48 time
.............

PEP 564(1) adds six new functions with nanosecond resolution to the
*note time: 10a. module:

   * *note time.clock_gettime_ns(): 313.

   * *note time.clock_settime_ns(): 314.

   * *note time.monotonic_ns(): 315.

   * *note time.perf_counter_ns(): 316.

   * *note time.process_time_ns(): 317.

   * *note time.time_ns(): 318.

New clock identifiers have been added:

   * *note time.CLOCK_BOOTTIME: 3ea. (Linux): Identical to *note
     time.CLOCK_MONOTONIC: 3eb, except it also includes any time that
     the system is suspended.

   * *note time.CLOCK_PROF: 3ec. (FreeBSD, NetBSD and OpenBSD):
     High-resolution per-process CPU timer.

   * *note time.CLOCK_UPTIME: 3ed. (FreeBSD, OpenBSD): Time whose
     absolute value is the time the system has been running and not
     suspended, providing accurate uptime measurement.

The new *note time.thread_time(): 3ee. and *note time.thread_time_ns():
3ef. functions can be used to get per-thread CPU time measurements.
(Contributed by Antoine Pitrou in bpo-32025(2).)

The new *note time.pthread_getcpuclockid(): 3f0. function returns the
clock ID of the thread-specific CPU-time clock.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0564

   (2) https://bugs.python.org/issue32025


File: python.info,  Node: tkinter<2>,  Next: tracemalloc,  Prev: time<2>,  Up: Improved Modules<2>

1.2.5.49 tkinter
................

The new *note tkinter.ttk.Spinbox: 3f2. class is now available.
(Contributed by Alan Moore in bpo-32585(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32585


File: python.info,  Node: tracemalloc,  Next: types,  Prev: tkinter<2>,  Up: Improved Modules<2>

1.2.5.50 tracemalloc
....................

*note tracemalloc.Traceback: 3f4. behaves more like regular tracebacks,
sorting the frames from oldest to most recent.  *note
Traceback.format(): 3f5. now accepts negative `limit', truncating the
result to the ‘abs(limit)’ oldest frames.  To get the old behaviour, use
the new `most_recent_first' argument to ‘Traceback.format()’.
(Contributed by Jesse Bakker in bpo-32121(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32121


File: python.info,  Node: types,  Next: unicodedata<2>,  Prev: tracemalloc,  Up: Improved Modules<2>

1.2.5.51 types
..............

The new *note WrapperDescriptorType: 3f7, *note MethodWrapperType: 3f8,
*note MethodDescriptorType: 3f9, and *note ClassMethodDescriptorType:
3fa. classes are now available.  (Contributed by Manuel Krebber and
Guido van Rossum in bpo-29377(1), and Serhiy Storchaka in bpo-32265(2).)

The new *note types.resolve_bases(): 3fb. function resolves MRO entries
dynamically as specified by PEP 560(3).  (Contributed by Ivan Levkivskyi
in bpo-32717(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29377

   (2) https://bugs.python.org/issue32265

   (3) https://www.python.org/dev/peps/pep-0560

   (4) https://bugs.python.org/issue32717


File: python.info,  Node: unicodedata<2>,  Next: unittest<2>,  Prev: types,  Up: Improved Modules<2>

1.2.5.52 unicodedata
....................

The internal *note unicodedata: 11a. database has been upgraded to use
Unicode 11(1).  (Contributed by Benjamin Peterson.)

   ---------- Footnotes ----------

   (1) http://www.unicode.org/versions/Unicode11.0.0/


File: python.info,  Node: unittest<2>,  Next: unittest mock,  Prev: unicodedata<2>,  Up: Improved Modules<2>

1.2.5.53 unittest
.................

The new ‘-k’ command-line option allows filtering tests by a name
substring or a Unix shell-like pattern.  For example, ‘python -m
unittest -k foo’ runs ‘foo_tests.SomeTest.test_something’,
‘bar_tests.SomeTest.test_foo’, but not
‘bar_tests.FooTest.test_something’.  (Contributed by Jonas Haag in
bpo-32071(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32071


File: python.info,  Node: unittest mock,  Next: urllib parse,  Prev: unittest<2>,  Up: Improved Modules<2>

1.2.5.54 unittest.mock
......................

The *note sentinel: 3ff. attributes now preserve their identity when
they are *note copied: 26. or *note pickled: ca.  (Contributed by Serhiy
Storchaka in bpo-20804(1).)

The new *note seal(): 400. function allows sealing *note Mock: 247.
instances, which will disallow further creation of attribute mocks.  The
seal is applied recursively to all attributes that are themselves mocks.
(Contributed by Mario Corchero in bpo-30541(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20804

   (2) https://bugs.python.org/issue30541


File: python.info,  Node: urllib parse,  Next: uu,  Prev: unittest mock,  Up: Improved Modules<2>

1.2.5.55 urllib.parse
.....................

*note urllib.parse.quote(): 402. has been updated from RFC 2396(1) to
RFC 3986(2), adding ‘~’ to the set of characters that are never quoted
by default.  (Contributed by Christian Theune and Ratnadeep Debnath in
bpo-16285(3).)

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2396.html

   (2) https://tools.ietf.org/html/rfc3986.html

   (3) https://bugs.python.org/issue16285


File: python.info,  Node: uu,  Next: uuid,  Prev: urllib parse,  Up: Improved Modules<2>

1.2.5.56 uu
...........

The *note uu.encode(): 404. function now accepts an optional `backtick'
keyword argument.  When it’s true, zeros are represented by ‘'`'’
instead of spaces.  (Contributed by Xiang Zhang in bpo-30103(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30103


File: python.info,  Node: uuid,  Next: warnings,  Prev: uu,  Up: Improved Modules<2>

1.2.5.57 uuid
.............

The new *note UUID.is_safe: 406. attribute relays information from the
platform about whether generated UUIDs are generated with a
multiprocessing-safe method.  (Contributed by Barry Warsaw in
bpo-22807(1).)

*note uuid.getnode(): 407. now prefers universally administered MAC
addresses over locally administered MAC addresses.  This makes a better
guarantee for global uniqueness of UUIDs returned from *note
uuid.uuid1(): 408.  If only locally administered MAC addresses are
available, the first such one found is returned.  (Contributed by Barry
Warsaw in bpo-32107(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22807

   (2) https://bugs.python.org/issue32107


File: python.info,  Node: warnings,  Next: xml etree,  Prev: uuid,  Up: Improved Modules<2>

1.2.5.58 warnings
.................

The initialization of the default warnings filters has changed as
follows:

   * warnings enabled via command line options (including those for
     *note -b: 40a. and the new CPython-specific *note -X: 155. ‘dev’
     option) are always passed to the warnings machinery via the *note
     sys.warnoptions: 40b. attribute.

   * warnings filters enabled via the command line or the environment
     now have the following order of precedence:

             * the ‘BytesWarning’ filter for *note -b: 40a. (or ‘-bb’)

             * any filters specified with the *note -W: 40c. option

             * any filters specified with the *note PYTHONWARNINGS: 40d.
               environment variable

             * any other CPython specific filters (e.g.  the ‘default’
               filter added for the new ‘-X dev’ mode)

             * any implicit filters defined directly by the warnings
               machinery

   * in CPython debug builds, all warnings are now displayed by default
     (the implicit filter list is empty)

(Contributed by Nick Coghlan and Victor Stinner in bpo-20361(1),
bpo-32043(2), and bpo-32230(3).)

Deprecation warnings are once again shown by default in single-file
scripts and at the interactive prompt.  See *note PEP 565; Show
DeprecationWarning in __main__: 2f8. for details.  (Contributed by Nick
Coghlan in bpo-31975(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20361

   (2) https://bugs.python.org/issue32043

   (3) https://bugs.python.org/issue32230

   (4) https://bugs.python.org/issue31975


File: python.info,  Node: xml etree,  Next: xmlrpc server,  Prev: warnings,  Up: Improved Modules<2>

1.2.5.59 xml.etree
..................

*note ElementPath: 40f. predicates in the ‘find()’ methods can now
compare text of the current node with ‘[. = "text"]’, not only text in
children.  Predicates also allow adding spaces for better readability.
(Contributed by Stefan Behnel in bpo-31648(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31648


File: python.info,  Node: xmlrpc server,  Next: zipapp,  Prev: xml etree,  Up: Improved Modules<2>

1.2.5.60 xmlrpc.server
......................

‘SimpleXMLRPCDispatcher.register_function’ can now be used as a
decorator.  (Contributed by Xiang Zhang in bpo-7769(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7769


File: python.info,  Node: zipapp,  Next: zipfile,  Prev: xmlrpc server,  Up: Improved Modules<2>

1.2.5.61 zipapp
...............

Function *note create_archive(): 412. now accepts an optional `filter'
argument to allow the user to select which files should be included in
the archive.  (Contributed by Irmen de Jong in bpo-31072(1).)

Function *note create_archive(): 412. now accepts an optional
`compressed' argument to generate a compressed archive.  A command line
option ‘--compress’ has also been added to support compression.
(Contributed by Zhiming Wang in bpo-31638(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31072

   (2) https://bugs.python.org/issue31638


File: python.info,  Node: zipfile,  Prev: zipapp,  Up: Improved Modules<2>

1.2.5.62 zipfile
................

*note ZipFile: 414. now accepts the new `compresslevel' parameter to
control the compression level.  (Contributed by Bo Bayles in
bpo-21417(1).)

Subdirectories in archives created by ‘ZipFile’ are now stored in
alphabetical order.  (Contributed by Bernhard M. Wiedemann in
bpo-30693(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21417

   (2) https://bugs.python.org/issue30693


File: python.info,  Node: C API Changes,  Next: Build Changes,  Prev: Improved Modules<2>,  Up: What’s New In Python 3 7

1.2.6 C API Changes
-------------------

A new API for thread-local storage has been implemented.  See *note PEP
539; New C API for Thread-Local Storage: 2f9. for an overview and *note
Thread Specific Storage (TSS) API: 30c. for a complete reference.
(Contributed by Masayuki Yamamoto in bpo-25658(1).)

The new *note context variables: 2ea. functionality exposes a number of
*note new C APIs: 330.

The new *note PyImport_GetModule(): 416. function returns the previously
imported module with the given name.  (Contributed by Eric Snow in
bpo-28411(2).)

The new *note Py_RETURN_RICHCOMPARE: 417. macro eases writing rich
comparison functions.  (Contributed by Petr Victorin in bpo-23699(3).)

The new *note Py_UNREACHABLE: 418. macro can be used to mark unreachable
code paths.  (Contributed by Barry Warsaw in bpo-31338(4).)

The *note tracemalloc: 114. now exposes a C API through the new
‘PyTraceMalloc_Track()’ and ‘PyTraceMalloc_Untrack()’ functions.
(Contributed by Victor Stinner in bpo-30054(5).)

The new *note import__find__load__start(): 419. and *note
import__find__load__done(): 41a. static markers can be used to trace
module imports.  (Contributed by Christian Heimes in bpo-31574(6).)

The fields ‘name’ and ‘doc’ of structures *note PyMemberDef: 41b, *note
PyGetSetDef: 41c, *note PyStructSequence_Field: 41d, *note
PyStructSequence_Desc: 41e, and ‘wrapperbase’ are now of type ‘const
char *’ rather of ‘char *’.  (Contributed by Serhiy Storchaka in
bpo-28761(7).)

The result of *note PyUnicode_AsUTF8AndSize(): 41f. and *note
PyUnicode_AsUTF8(): 420. is now of type ‘const char *’ rather of ‘char
*’.  (Contributed by Serhiy Storchaka in bpo-28769(8).)

The result of *note PyMapping_Keys(): 421, *note PyMapping_Values():
422. and *note PyMapping_Items(): 423. is now always a list, rather than
a list or a tuple.  (Contributed by Oren Milman in bpo-28280(9).)

Added functions *note PySlice_Unpack(): 424. and *note
PySlice_AdjustIndices(): 425.  (Contributed by Serhiy Storchaka in
bpo-27867(10).)

*note PyOS_AfterFork(): 426. is deprecated in favour of the new
functions *note PyOS_BeforeFork(): 427, *note PyOS_AfterFork_Parent():
428. and *note PyOS_AfterFork_Child(): 2cb.  (Contributed by Antoine
Pitrou in bpo-16500(11).)

The ‘PyExc_RecursionErrorInst’ singleton that was part of the public API
has been removed as its members being never cleared may cause a segfault
during finalization of the interpreter.  Contributed by Xavier de Gaye
in bpo-22898(12) and bpo-30697(13).

Added C API support for timezones with timezone constructors *note
PyTimeZone_FromOffset(): 429. and *note PyTimeZone_FromOffsetAndName():
42a, and access to the UTC singleton with *note PyDateTime_TimeZone_UTC:
42b.  Contributed by Paul Ganssle in bpo-10381(14).

The type of results of ‘PyThread_start_new_thread()’ and
‘PyThread_get_thread_ident()’, and the `id' parameter of *note
PyThreadState_SetAsyncExc(): 42c. changed from ‘long’ to ‘unsigned
long’.  (Contributed by Serhiy Storchaka in bpo-6532(15).)

*note PyUnicode_AsWideCharString(): 42d. now raises a *note ValueError:
1f9. if the second argument is ‘NULL’ and the ‘wchar_t*’ string contains
null characters.  (Contributed by Serhiy Storchaka in bpo-30708(16).)

Changes to the startup sequence and the management of dynamic memory
allocators mean that the long documented requirement to call *note
Py_Initialize(): 42e. before calling most C API functions is now relied
on more heavily, and failing to abide by it may lead to segfaults in
embedding applications.  See the *note Porting to Python 3.7: 2fc.
section in this document and the *note Before Python Initialization:
42f. section in the C API documentation for more details.

The new *note PyInterpreterState_GetID(): 430. returns the unique ID for
a given interpreter.  (Contributed by Eric Snow in bpo-29102(17).)

*note Py_DecodeLocale(): 431, *note Py_EncodeLocale(): 432. now use the
UTF-8 encoding when the *note UTF-8 mode: 2f5. is enabled.  (Contributed
by Victor Stinner in bpo-29240(18).)

*note PyUnicode_DecodeLocaleAndSize(): 433. and *note
PyUnicode_EncodeLocale(): 434. now use the current locale encoding for
‘surrogateescape’ error handler.  (Contributed by Victor Stinner in
bpo-29240(19).)

The `start' and `end' parameters of *note PyUnicode_FindChar(): 435. are
now adjusted to behave like string slices.  (Contributed by Xiang Zhang
in bpo-28822(20).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25658

   (2) https://bugs.python.org/issue28411

   (3) https://bugs.python.org/issue23699

   (4) https://bugs.python.org/issue31338

   (5) https://bugs.python.org/issue30054

   (6) https://bugs.python.org/issue31574

   (7) https://bugs.python.org/issue28761

   (8) https://bugs.python.org/issue28769

   (9) https://bugs.python.org/issue28280

   (10) https://bugs.python.org/issue27867

   (11) https://bugs.python.org/issue16500

   (12) https://bugs.python.org/issue22898

   (13) https://bugs.python.org/issue30697

   (14) https://bugs.python.org/issue10381

   (15) https://bugs.python.org/issue6532

   (16) https://bugs.python.org/issue30708

   (17) https://bugs.python.org/issue29102

   (18) https://bugs.python.org/issue29240

   (19) https://bugs.python.org/issue29240

   (20) https://bugs.python.org/issue28822


File: python.info,  Node: Build Changes,  Next: Optimizations<2>,  Prev: C API Changes,  Up: What’s New In Python 3 7

1.2.7 Build Changes
-------------------

Support for building ‘--without-threads’ has been removed.  The *note
threading: 109. module is now always available.  (Contributed by Antoine
Pitrou in bpo-31370(1).).

A full copy of libffi is no longer bundled for use when building the
*note _ctypes: 2b. module on non-OSX UNIX platforms.  An installed copy
of libffi is now required when building ‘_ctypes’ on such platforms.
(Contributed by Zachary Ware in bpo-27979(2).)

The Windows build process no longer depends on Subversion to pull in
external sources, a Python script is used to download zipfiles from
GitHub instead.  If Python 3.6 is not found on the system (via ‘py
-3.6’), NuGet is used to download a copy of 32-bit Python for this
purpose.  (Contributed by Zachary Ware in bpo-30450(3).)

The *note ssl: f3. module requires OpenSSL 1.0.2 or 1.1 compatible
libssl.  OpenSSL 1.0.1 has reached end of lifetime on 2016-12-31 and is
no longer supported.  LibreSSL is temporarily not supported as well.
LibreSSL releases up to version 2.6.4 are missing required OpenSSL 1.0.2
APIs.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31370

   (2) https://bugs.python.org/issue27979

   (3) https://bugs.python.org/issue30450


File: python.info,  Node: Optimizations<2>,  Next: Other CPython Implementation Changes,  Prev: Build Changes,  Up: What’s New In Python 3 7

1.2.8 Optimizations
-------------------

The overhead of calling many methods of various standard library classes
implemented in C has been significantly reduced by porting more code to
use the ‘METH_FASTCALL’ convention.  (Contributed by Victor Stinner in
bpo-29300(1), bpo-29507(2), bpo-29452(3), and bpo-29286(4).)

Various optimizations have reduced Python startup time by 10% on Linux
and up to 30% on macOS. (Contributed by Victor Stinner, INADA Naoki in
bpo-29585(5), and Ivan Levkivskyi in bpo-31333(6).)

Method calls are now up to 20% faster due to the bytecode changes which
avoid creating bound method instances.  (Contributed by Yury Selivanov
and INADA Naoki in bpo-26110(7).)  The *note asyncio: a. module received
a number of notable optimizations for commonly used functions:

   * The *note asyncio.get_event_loop(): 34a. function has been
     reimplemented in C to make it up to 15 times faster.  (Contributed
     by Yury Selivanov in bpo-32296(8).)

   * *note asyncio.Future: 438. callback management has been optimized.
     (Contributed by Yury Selivanov in bpo-32348(9).)

   * *note asyncio.gather(): 284. is now up to 15% faster.  (Contributed
     by Yury Selivanov in bpo-32355(10).)

   * *note asyncio.sleep(): 283. is now up to 2 times faster when the
     `delay' argument is zero or negative.  (Contributed by Andrew
     Svetlov in bpo-32351(11).)

   * The performance overhead of asyncio debug mode has been reduced.
     (Contributed by Antoine Pitrou in bpo-31970(12).)

As a result of *note PEP 560 work: 2f0, the import time of *note typing:
119. has been reduced by a factor of 7, and many typing operations are
now faster.  (Contributed by Ivan Levkivskyi in bpo-32226(13).)

*note sorted(): 439. and *note list.sort(): 43a. have been optimized for
common cases to be up to 40-75% faster.  (Contributed by Elliot
Gorokhovsky in bpo-28685(14).)

*note dict.copy(): 43b. is now up to 5.5 times faster.  (Contributed by
Yury Selivanov in bpo-31179(15).)

*note hasattr(): 43c. and *note getattr(): 43d. are now about 4 times
faster when `name' is not found and `obj' does not override *note
object.__getattr__(): 30f. or *note object.__getattribute__(): 43e.
(Contributed by INADA Naoki in bpo-32544(16).)

Searching for certain Unicode characters (like Ukrainian capital “Є”) in
a string was up to 25 times slower than searching for other characters.
It is now only 3 times slower in the worst case.  (Contributed by Serhiy
Storchaka in bpo-24821(17).)

The *note collections.namedtuple(): 1b5. factory has been reimplemented
to make the creation of named tuples 4 to 6 times faster.  (Contributed
by Jelle Zijlstra with further improvements by INADA Naoki, Serhiy
Storchaka, and Raymond Hettinger in bpo-28638(18).)

‘date.fromordinal()’ and ‘date.fromtimestamp()’ are now up to 30% faster
in the common case.  (Contributed by Paul Ganssle in bpo-32403(19).)

The *note os.fwalk(): 3a9. function is now up to 2 times faster thanks
to the use of *note os.scandir(): 25d.  (Contributed by Serhiy Storchaka
in bpo-25996(20).)

The speed of the *note shutil.rmtree(): 21a. function has been improved
by 20–40% thanks to the use of the *note os.scandir(): 25d. function.
(Contributed by Serhiy Storchaka in bpo-28564(21).)

Optimized case-insensitive matching and searching of *note regular
expressions: dd.  Searching some patterns can now be up to 20 times
faster.  (Contributed by Serhiy Storchaka in bpo-30285(22).)

*note re.compile(): 43f. now converts ‘flags’ parameter to int object if
it is ‘RegexFlag’.  It is now as fast as Python 3.5, and faster than
Python 3.6 by about 10% depending on the pattern.  (Contributed by INADA
Naoki in bpo-31671(23).)

The *note modify(): 440. methods of classes *note
selectors.EpollSelector: 441, *note selectors.PollSelector: 442. and
*note selectors.DevpollSelector: 443. may be around 10% faster under
heavy loads.  (Contributed by Giampaolo Rodola’ in bpo-30014(24))

Constant folding has been moved from the peephole optimizer to the new
AST optimizer, which is able perform optimizations more consistently.
(Contributed by Eugene Toder and INADA Naoki in bpo-29469(25) and
bpo-11549(26).)

Most functions and methods in *note abc: 4. have been rewritten in C.
This makes creation of abstract base classes, and calling *note
isinstance(): 444. and *note issubclass(): 445. on them 1.5x faster.
This also reduces Python start-up time by up to 10%.  (Contributed by
Ivan Levkivskyi and INADA Naoki in bpo-31333(27))

Significant speed improvements to alternate constructors for *note
datetime.date: 193. and *note datetime.datetime: 194. by using fast-path
constructors when not constructing subclasses.  (Contributed by Paul
Ganssle in bpo-32403(28))

The speed of comparison of *note array.array: 446. instances has been
improved considerably in certain cases.  It is now from 10x to 70x
faster when comparing arrays holding values of the same integer type.
(Contributed by Adrian Wielgosik in bpo-24700(29).)

The *note math.erf(): 447. and *note math.erfc(): 448. functions now use
the (faster) C library implementation on most platforms.  (Contributed
by Serhiy Storchaka in bpo-26121(30).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29300

   (2) https://bugs.python.org/issue29507

   (3) https://bugs.python.org/issue29452

   (4) https://bugs.python.org/issue29286

   (5) https://bugs.python.org/issue29585

   (6) https://bugs.python.org/issue31333

   (7) https://bugs.python.org/issue26110

   (8) https://bugs.python.org/issue32296

   (9) https://bugs.python.org/issue32348

   (10) https://bugs.python.org/issue32355

   (11) https://bugs.python.org/issue32351

   (12) https://bugs.python.org/issue31970

   (13) https://bugs.python.org/issue32226

   (14) https://bugs.python.org/issue28685

   (15) https://bugs.python.org/issue31179

   (16) https://bugs.python.org/issue32544

   (17) https://bugs.python.org/issue24821

   (18) https://bugs.python.org/issue28638

   (19) https://bugs.python.org/issue32403

   (20) https://bugs.python.org/issue25996

   (21) https://bugs.python.org/issue28564

   (22) https://bugs.python.org/issue30285

   (23) https://bugs.python.org/issue31671

   (24) https://bugs.python.org/issue30014

   (25) https://bugs.python.org/issue29469

   (26) https://bugs.python.org/issue11549

   (27) https://bugs.python.org/issue31333

   (28) https://bugs.python.org/issue32403

   (29) https://bugs.python.org/issue24700

   (30) https://bugs.python.org/issue26121


File: python.info,  Node: Other CPython Implementation Changes,  Next: Deprecated Python Behavior,  Prev: Optimizations<2>,  Up: What’s New In Python 3 7

1.2.9 Other CPython Implementation Changes
------------------------------------------

   * Trace hooks may now opt out of receiving the ‘line’ and opt into
     receiving the ‘opcode’ events from the interpreter by setting the
     corresponding new ‘f_trace_lines’ and ‘f_trace_opcodes’ attributes
     on the frame being traced.  (Contributed by Nick Coghlan in
     bpo-31344(1).)

   * Fixed some consistency problems with namespace package module
     attributes.  Namespace module objects now have an ‘__file__’ that
     is set to ‘None’ (previously unset), and their ‘__spec__.origin’ is
     also set to ‘None’ (previously the string ‘"namespace"’).  See
     bpo-32305(2).  Also, the namespace module object’s
     ‘__spec__.loader’ is set to the same value as ‘__loader__’
     (previously, the former was set to ‘None’).  See bpo-32303(3).

   * The *note locals(): 44a. dictionary now displays in the lexical
     order that variables were defined.  Previously, the order was
     undefined.  (Contributed by Raymond Hettinger in bpo-32690(4).)

   * The *note distutils: 39. ‘upload’ command no longer tries to change
     CR end-of-line characters to CRLF. This fixes a corruption issue
     with sdists that ended with a byte equivalent to CR. (Contributed
     by Bo Bayles in bpo-32304(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31344

   (2) https://bugs.python.org/issue32305

   (3) https://bugs.python.org/issue32303

   (4) https://bugs.python.org/issue32690

   (5) https://bugs.python.org/issue32304


File: python.info,  Node: Deprecated Python Behavior,  Next: Deprecated Python modules functions and methods,  Prev: Other CPython Implementation Changes,  Up: What’s New In Python 3 7

1.2.10 Deprecated Python Behavior
---------------------------------

Yield expressions (both ‘yield’ and ‘yield from’ clauses) are now
deprecated in comprehensions and generator expressions (aside from the
iterable expression in the leftmost ‘for’ clause).  This ensures that
comprehensions always immediately return a container of the appropriate
type (rather than potentially returning a *note generator iterator: 44c.
object), while generator expressions won’t attempt to interleave their
implicit output with the output from any explicit yield expressions.  In
Python 3.7, such expressions emit *note DeprecationWarning: 276. when
compiled, in Python 3.8 this will be a *note SyntaxError: 44d.
(Contributed by Serhiy Storchaka in bpo-10544(1).)

Returning a subclass of *note complex: 189. from *note
object.__complex__(): 18d. is deprecated and will be an error in future
Python versions.  This makes ‘__complex__()’ consistent with *note
object.__int__(): 18b. and *note object.__float__(): 18c.  (Contributed
by Serhiy Storchaka in bpo-28894(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10544

   (2) https://bugs.python.org/issue28894


File: python.info,  Node: Deprecated Python modules functions and methods,  Next: Deprecated functions and types of the C API,  Prev: Deprecated Python Behavior,  Up: What’s New In Python 3 7

1.2.11 Deprecated Python modules, functions and methods
-------------------------------------------------------

* Menu:

* aifc::
* asyncio: asyncio<3>.
* collections: collections<3>.
* dbm: dbm<2>.
* enum: enum<2>.
* gettext: gettext<2>.
* importlib: importlib<2>.
* locale: locale<2>.
* macpath::
* threading: threading<2>.
* socket: socket<3>.
* ssl: ssl<3>.
* sunau::
* sys: sys<3>.
* wave::


File: python.info,  Node: aifc,  Next: asyncio<3>,  Up: Deprecated Python modules functions and methods

1.2.11.1 aifc
.............

‘aifc.openfp()’ has been deprecated and will be removed in Python 3.9.
Use *note aifc.open(): 450. instead.  (Contributed by Brian Curtin in
bpo-31985(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31985


File: python.info,  Node: asyncio<3>,  Next: collections<3>,  Prev: aifc,  Up: Deprecated Python modules functions and methods

1.2.11.2 asyncio
................

Support for directly ‘await’-ing instances of *note asyncio.Lock: 289.
and other asyncio synchronization primitives has been deprecated.  An
asynchronous context manager must be used in order to acquire and
release the synchronization resource.  (Contributed by Andrew Svetlov in
bpo-32253(1).)

The *note asyncio.Task.current_task(): 347. and *note
asyncio.Task.all_tasks(): 348. methods have been deprecated.
(Contributed by Andrew Svetlov in bpo-32250(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32253

   (2) https://bugs.python.org/issue32250


File: python.info,  Node: collections<3>,  Next: dbm<2>,  Prev: asyncio<3>,  Up: Deprecated Python modules functions and methods

1.2.11.3 collections
....................

In Python 3.8, the abstract base classes in *note collections.abc: 1f.
will no longer be exposed in the regular *note collections: 1e. module.
This will help create a clearer distinction between the concrete classes
and the abstract base classes.  (Contributed by Serhiy Storchaka in
bpo-25988(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25988


File: python.info,  Node: dbm<2>,  Next: enum<2>,  Prev: collections<3>,  Up: Deprecated Python modules functions and methods

1.2.11.4 dbm
............

*note dbm.dumb: 33. now supports reading read-only files and no longer
writes the index file when it is not changed.  A deprecation warning is
now emitted if the index file is missing and recreated in the ‘'r'’ and
‘'w'’ modes (this will be an error in future Python releases).
(Contributed by Serhiy Storchaka in bpo-28847(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28847


File: python.info,  Node: enum<2>,  Next: gettext<2>,  Prev: dbm<2>,  Up: Deprecated Python modules functions and methods

1.2.11.5 enum
.............

In Python 3.8, attempting to check for non-Enum objects in ‘Enum’
classes will raise a *note TypeError: 192. (e.g.  ‘1 in Color’);
similarly, attempting to check for non-Flag objects in a ‘Flag’ member
will raise *note TypeError: 192. (e.g.  ‘1 in Perm.RW’); currently, both
operations return *note False: 37d. instead.  (Contributed by Ethan
Furman in bpo-33217(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33217


File: python.info,  Node: gettext<2>,  Next: importlib<2>,  Prev: enum<2>,  Up: Deprecated Python modules functions and methods

1.2.11.6 gettext
................

Using non-integer value for selecting a plural form in *note gettext:
89. is now deprecated.  It never correctly worked.  (Contributed by
Serhiy Storchaka in bpo-28692(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28692


File: python.info,  Node: importlib<2>,  Next: locale<2>,  Prev: gettext<2>,  Up: Deprecated Python modules functions and methods

1.2.11.7 importlib
..................

Methods *note MetaPathFinder.find_module(): 457. (replaced by *note
MetaPathFinder.find_spec(): 458.) and *note
PathEntryFinder.find_loader(): 459. (replaced by *note
PathEntryFinder.find_spec(): 45a.) both deprecated in Python 3.4 now
emit *note DeprecationWarning: 276.  (Contributed by Matthias Bussonnier
in bpo-29576(1))

The *note importlib.abc.ResourceLoader: 45b. ABC has been deprecated in
favour of *note importlib.abc.ResourceReader: 337.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29576


File: python.info,  Node: locale<2>,  Next: macpath,  Prev: importlib<2>,  Up: Deprecated Python modules functions and methods

1.2.11.8 locale
...............

*note locale.format(): 45d. has been deprecated, use *note
locale.format_string(): 399. instead.  (Contributed by Garvit in
bpo-10379(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10379


File: python.info,  Node: macpath,  Next: threading<2>,  Prev: locale<2>,  Up: Deprecated Python modules functions and methods

1.2.11.9 macpath
................

The ‘macpath’ is now deprecated and will be removed in Python 3.8.
(Contributed by Chi Hsuan Yen in bpo-9850(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9850


File: python.info,  Node: threading<2>,  Next: socket<3>,  Prev: macpath,  Up: Deprecated Python modules functions and methods

1.2.11.10 threading
...................

*note dummy_threading: 68. and *note _dummy_thread: 2. have been
deprecated.  It is no longer possible to build Python with threading
disabled.  Use *note threading: 109. instead.  (Contributed by Antoine
Pitrou in bpo-31370(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31370


File: python.info,  Node: socket<3>,  Next: ssl<3>,  Prev: threading<2>,  Up: Deprecated Python modules functions and methods

1.2.11.11 socket
................

The silent argument value truncation in *note socket.htons(): 461. and
*note socket.ntohs(): 462. has been deprecated.  In future versions of
Python, if the passed argument is larger than 16 bits, an exception will
be raised.  (Contributed by Oren Milman in bpo-28332(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28332


File: python.info,  Node: ssl<3>,  Next: sunau,  Prev: socket<3>,  Up: Deprecated Python modules functions and methods

1.2.11.12 ssl
.............

*note ssl.wrap_socket(): 464. is deprecated.  Use *note
ssl.SSLContext.wrap_socket(): 3da. instead.  (Contributed by Christian
Heimes in bpo-28124(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28124


File: python.info,  Node: sunau,  Next: sys<3>,  Prev: ssl<3>,  Up: Deprecated Python modules functions and methods

1.2.11.13 sunau
...............

*note sunau.openfp(): 466. has been deprecated and will be removed in
Python 3.9.  Use *note sunau.open(): 467. instead.  (Contributed by
Brian Curtin in bpo-31985(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31985


File: python.info,  Node: sys<3>,  Next: wave,  Prev: sunau,  Up: Deprecated Python modules functions and methods

1.2.11.14 sys
.............

Deprecated ‘sys.set_coroutine_wrapper()’ and
‘sys.get_coroutine_wrapper()’.

The undocumented ‘sys.callstats()’ function has been deprecated and will
be removed in a future Python version.  (Contributed by Victor Stinner
in bpo-28799(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28799


File: python.info,  Node: wave,  Prev: sys<3>,  Up: Deprecated Python modules functions and methods

1.2.11.15 wave
..............

*note wave.openfp(): 46a. has been deprecated and will be removed in
Python 3.9.  Use *note wave.open(): 46b. instead.  (Contributed by Brian
Curtin in bpo-31985(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31985


File: python.info,  Node: Deprecated functions and types of the C API,  Next: Platform Support Removals,  Prev: Deprecated Python modules functions and methods,  Up: What’s New In Python 3 7

1.2.12 Deprecated functions and types of the C API
--------------------------------------------------

Function *note PySlice_GetIndicesEx(): 46d. is deprecated and replaced
with a macro if ‘Py_LIMITED_API’ is not set or set to a value in the
range between ‘0x03050400’ and ‘0x03060000’ (not inclusive), or is
‘0x03060100’ or higher.  (Contributed by Serhiy Storchaka in
bpo-27867(1).)

*note PyOS_AfterFork(): 426. has been deprecated.  Use *note
PyOS_BeforeFork(): 427, *note PyOS_AfterFork_Parent(): 428. or *note
PyOS_AfterFork_Child(): 2cb. instead.  (Contributed by Antoine Pitrou in
bpo-16500(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27867

   (2) https://bugs.python.org/issue16500


File: python.info,  Node: Platform Support Removals,  Next: API and Feature Removals<2>,  Prev: Deprecated functions and types of the C API,  Up: What’s New In Python 3 7

1.2.13 Platform Support Removals
--------------------------------

   * FreeBSD 9 and older are no longer officially supported.

   * For full Unicode support, including within extension modules, *nix
     platforms are now expected to provide at least one of ‘C.UTF-8’
     (full locale), ‘C.utf8’ (full locale) or ‘UTF-8’ (‘LC_CTYPE’-only
     locale) as an alternative to the legacy ‘ASCII’-based ‘C’ locale.

   * OpenSSL 0.9.8 and 1.0.1 are no longer supported, which means
     building CPython 3.7 with SSL/TLS support on older platforms still
     using these versions requires custom build options that link to a
     more recent version of OpenSSL.

     Notably, this issue affects the Debian 8 (aka “jessie”) and Ubuntu
     14.04 (aka “Trusty”) LTS Linux distributions, as they still use
     OpenSSL 1.0.1 by default.

     Debian 9 (“stretch”) and Ubuntu 16.04 (“xenial”), as well as recent
     releases of other LTS Linux releases (e.g.  RHEL/CentOS 7.5, SLES
     12-SP3), use OpenSSL 1.0.2 or later, and remain supported in the
     default build configuration.

     CPython’s own CI configuration file(1) provides an example of using
     the SSL compatibility testing infrastructure(2) in CPython’s test
     suite to build and link against OpenSSL 1.1.0 rather than an
     outdated system provided OpenSSL.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/.travis.yml

   (2) 
https://github.com/python/cpython/tree/3.8/Tools/ssl/multissltests.py


File: python.info,  Node: API and Feature Removals<2>,  Next: Module Removals,  Prev: Platform Support Removals,  Up: What’s New In Python 3 7

1.2.14 API and Feature Removals
-------------------------------

The following features and APIs have been removed from Python 3.7:

   * The ‘os.stat_float_times()’ function has been removed.  It was
     introduced in Python 2.3 for backward compatibility with Python
     2.2, and was deprecated since Python 3.1.

   * Unknown escapes consisting of ‘'\'’ and an ASCII letter in
     replacement templates for *note re.sub(): 470. were deprecated in
     Python 3.5, and will now cause an error.

   * Removed support of the `exclude' argument in *note
     tarfile.TarFile.add(): 471.  It was deprecated in Python 2.7 and
     3.2.  Use the `filter' argument instead.

   * The ‘splitunc()’ function in the ‘ntpath’ module was deprecated in
     Python 3.1, and has now been removed.  Use the *note splitdrive():
     472. function instead.

   * *note collections.namedtuple(): 1b5. no longer supports the
     `verbose' parameter or ‘_source’ attribute which showed the
     generated source code for the named tuple class.  This was part of
     an optimization designed to speed-up class creation.  (Contributed
     by Jelle Zijlstra with further improvements by INADA Naoki, Serhiy
     Storchaka, and Raymond Hettinger in bpo-28638(1).)

   * Functions *note bool(): 183, *note float(): 187, *note list(): 260.
     and *note tuple(): 473. no longer take keyword arguments.  The
     first argument of *note int(): 184. can now be passed only as
     positional argument.

   * Removed previously deprecated in Python 2.4 classes ‘Plist’, ‘Dict’
     and ‘_InternalDict’ in the *note plistlib: cf. module.  Dict values
     in the result of functions *note readPlist(): 474. and *note
     readPlistFromBytes(): 475. are now normal dicts.  You no longer can
     use attribute access to access items of these dictionaries.

   * The ‘asyncio.windows_utils.socketpair()’ function has been removed.
     Use the *note socket.socketpair(): 476. function instead, it is
     available on all platforms since Python 3.5.
     ‘asyncio.windows_utils.socketpair’ was just an alias to
     ‘socket.socketpair’ on Python 3.5 and newer.

   * *note asyncio: a. no longer exports the *note selectors: e6. and
     ‘_overlapped’ modules as ‘asyncio.selectors’ and
     ‘asyncio._overlapped’.  Replace ‘from asyncio import selectors’
     with ‘import selectors’.

   * Direct instantiation of *note ssl.SSLSocket: 3d7. and *note
     ssl.SSLObject: 3d8. objects is now prohibited.  The constructors
     were never documented, tested, or designed as public constructors.
     Users were supposed to use *note ssl.wrap_socket(): 464. or *note
     ssl.SSLContext: 3d9.  (Contributed by Christian Heimes in
     bpo-32951(2).)

   * The unused *note distutils: 39. ‘install_misc’ command has been
     removed.  (Contributed by Eric N. Vander Weele in bpo-29218(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28638

   (2) https://bugs.python.org/issue32951

   (3) https://bugs.python.org/issue29218


File: python.info,  Node: Module Removals,  Next: Windows-only Changes,  Prev: API and Feature Removals<2>,  Up: What’s New In Python 3 7

1.2.15 Module Removals
----------------------

The ‘fpectl’ module has been removed.  It was never enabled by default,
never worked correctly on x86-64, and it changed the Python ABI in ways
that caused unexpected breakage of C extensions.  (Contributed by
Nathaniel J. Smith in bpo-29137(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29137


File: python.info,  Node: Windows-only Changes,  Next: Porting to Python 3 7,  Prev: Module Removals,  Up: What’s New In Python 3 7

1.2.16 Windows-only Changes
---------------------------

The python launcher, (py.exe), can accept 32 & 64 bit specifiers
`without' having to specify a minor version as well.  So ‘py -3-32’ and
‘py -3-64’ become valid as well as ‘py -3.7-32’, also the -`m'-64 and
-`m.n'-64 forms are now accepted to force 64 bit python even if 32 bit
would have otherwise been used.  If the specified version is not
available py.exe will error exit.  (Contributed by Steve Barnes in
bpo-30291(1).)

The launcher can be run as ‘py -0’ to produce a list of the installed
pythons, `with default marked with an asterisk'.  Running ‘py -0p’ will
include the paths.  If py is run with a version specifier that cannot be
matched it will also print the `short form' list of available
specifiers.  (Contributed by Steve Barnes in bpo-30362(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30291

   (2) https://bugs.python.org/issue30362


File: python.info,  Node: Porting to Python 3 7,  Next: Notable changes in Python 3 7 1,  Prev: Windows-only Changes,  Up: What’s New In Python 3 7

1.2.17 Porting to Python 3.7
----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code.

* Menu:

* Changes in Python Behavior::
* Changes in the Python API: Changes in the Python API<2>.
* Changes in the C API: Changes in the C API<2>.
* CPython bytecode changes: CPython bytecode changes<2>.
* Windows-only Changes: Windows-only Changes<2>.
* Other CPython implementation changes::


File: python.info,  Node: Changes in Python Behavior,  Next: Changes in the Python API<2>,  Up: Porting to Python 3 7

1.2.17.1 Changes in Python Behavior
...................................

   * *note async: 1a1. and *note await: 1a2. names are now reserved
     keywords.  Code using these names as identifiers will now raise a
     *note SyntaxError: 44d.  (Contributed by Jelle Zijlstra in
     bpo-30406(1).)

   * PEP 479(2) is enabled for all code in Python 3.7, meaning that
     *note StopIteration: 47b. exceptions raised directly or indirectly
     in coroutines and generators are transformed into *note
     RuntimeError: 2b8. exceptions.  (Contributed by Yury Selivanov in
     bpo-32670(3).)

   * *note object.__aiter__(): 47c. methods can no longer be declared as
     asynchronous.  (Contributed by Yury Selivanov in bpo-31709(4).)

   * Due to an oversight, earlier Python versions erroneously accepted
     the following syntax:

          f(1 for x in [1],)

          class C(1 for x in [1]):
              pass

     Python 3.7 now correctly raises a *note SyntaxError: 44d, as a
     generator expression always needs to be directly inside a set of
     parentheses and cannot have a comma on either side, and the
     duplication of the parentheses can be omitted only on calls.
     (Contributed by Serhiy Storchaka in bpo-32012(5) and bpo-32023(6).)

   * When using the *note -m: 32c. switch, the initial working directory
     is now added to *note sys.path: 47d, rather than an empty string
     (which dynamically denoted the current working directory at the
     time of each import).  Any programs that are checking for the empty
     string, or otherwise relying on the previous behaviour, will need
     to be updated accordingly (e.g.  by also checking for ‘os.getcwd()’
     or ‘os.path.dirname(__main__.__file__)’, depending on why the code
     was checking for the empty string in the first place).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30406

   (2) https://www.python.org/dev/peps/pep-0479

   (3) https://bugs.python.org/issue32670

   (4) https://bugs.python.org/issue31709

   (5) https://bugs.python.org/issue32012

   (6) https://bugs.python.org/issue32023


File: python.info,  Node: Changes in the Python API<2>,  Next: Changes in the C API<2>,  Prev: Changes in Python Behavior,  Up: Porting to Python 3 7

1.2.17.2 Changes in the Python API
..................................

   * ‘socketserver.ThreadingMixIn.server_close()’ now waits until all
     non-daemon threads complete.  Set the new
     ‘socketserver.ThreadingMixIn.block_on_close’ class attribute to
     ‘False’ to get the pre-3.7 behaviour.  (Contributed by Victor
     Stinner in bpo-31233(1) and bpo-33540(2).)

   * ‘socketserver.ForkingMixIn.server_close()’ now waits until all
     child processes complete.  Set the new
     ‘socketserver.ForkingMixIn.block_on_close’ class attribute to
     ‘False’ to get the pre-3.7 behaviour.  (Contributed by Victor
     Stinner in bpo-31151(3) and bpo-33540(4).)

   * The *note locale.localeconv(): 47f. function now temporarily sets
     the ‘LC_CTYPE’ locale to the value of ‘LC_NUMERIC’ in some cases.
     (Contributed by Victor Stinner in bpo-31900(5).)

   * *note pkgutil.walk_packages(): 480. now raises a *note ValueError:
     1f9. if `path' is a string.  Previously an empty list was returned.
     (Contributed by Sanyam Khurana in bpo-24744(6).)

   * A format string argument for *note string.Formatter.format(): 481.
     is now *note positional-only: 2a5.  Passing it as a keyword
     argument was deprecated in Python 3.5.  (Contributed by Serhiy
     Storchaka in bpo-29193(7).)

   * Attributes *note key: 482, *note value: 483. and *note coded_value:
     484. of class *note http.cookies.Morsel: 485. are now read-only.
     Assigning to them was deprecated in Python 3.5.  Use the *note
     set(): 486. method for setting them.  (Contributed by Serhiy
     Storchaka in bpo-29192(8).)

   * The `mode' argument of *note os.makedirs(): 3b2. no longer affects
     the file permission bits of newly-created intermediate-level
     directories.  To set their file permission bits you can set the
     umask before invoking ‘makedirs()’.  (Contributed by Serhiy
     Storchaka in bpo-19930(9).)

   * The *note struct.Struct.format: 487. type is now *note str: 325.
     instead of *note bytes: 326.  (Contributed by Victor Stinner in
     bpo-21071(10).)

   * *note parse_multipart(): 488. now accepts the `encoding' and
     `errors' arguments and returns the same results as ‘FieldStorage’:
     for non-file fields, the value associated to a key is a list of
     strings, not bytes.  (Contributed by Pierre Quentel in
     bpo-29979(11).)

   * Due to internal changes in *note socket: ef, calling *note
     socket.fromshare(): 489. on a socket created by *note socket.share:
     48a. in older Python versions is not supported.

   * ‘repr’ for *note BaseException: 1a7. has changed to not include the
     trailing comma.  Most exceptions are affected by this change.
     (Contributed by Serhiy Storchaka in bpo-30399(12).)

   * ‘repr’ for *note datetime.timedelta: 195. has changed to include
     the keyword arguments in the output.  (Contributed by Utkarsh
     Upadhyay in bpo-30302(13).)

   * Because *note shutil.rmtree(): 21a. is now implemented using the
     *note os.scandir(): 25d. function, the user specified handler
     `onerror' is now called with the first argument ‘os.scandir’
     instead of ‘os.listdir’ when listing the directory is failed.

   * Support for nested sets and set operations in regular expressions
     as in Unicode Technical Standard #18(14) might be added in the
     future.  This would change the syntax.  To facilitate this future
     change a *note FutureWarning: 31a. will be raised in ambiguous
     cases for the time being.  That include sets starting with a
     literal ‘'['’ or containing literal character sequences ‘'--'’,
     ‘'&&'’, ‘'~~'’, and ‘'||'’.  To avoid a warning, escape them with a
     backslash.  (Contributed by Serhiy Storchaka in bpo-30349(15).)

   * The result of splitting a string on a *note regular expression: dd.
     that could match an empty string has been changed.  For example
     splitting on ‘r'\s*'’ will now split not only on whitespaces as it
     did previously, but also on empty strings before all non-whitespace
     characters and just before the end of the string.  The previous
     behavior can be restored by changing the pattern to ‘r'\s+'’.  A
     *note FutureWarning: 31a. was emitted for such patterns since
     Python 3.5.

     For patterns that match both empty and non-empty strings, the
     result of searching for all matches may also be changed in other
     cases.  For example in the string ‘'a\n\n'’, the pattern
     ‘r'(?m)^\s*?$'’ will not only match empty strings at positions 2
     and 3, but also the string ‘'\n'’ at positions 2–3.  To match only
     blank lines, the pattern should be rewritten as
     ‘r'(?m)^[^\S\n]*$'’.

     *note re.sub(): 470. now replaces empty matches adjacent to a
     previous non-empty match.  For example ‘re.sub('x*', '-', 'abxd')’
     returns now ‘'-a-b--d-'’ instead of ‘'-a-b-d-'’ (the first minus
     between ‘b’ and ‘d’ replaces ‘x’, and the second minus replaces an
     empty string between ‘x’ and ‘d’).

     (Contributed by Serhiy Storchaka in bpo-25054(16) and
     bpo-32308(17).)

   * Change *note re.escape(): 48b. to only escape regex special
     characters instead of escaping all characters other than ASCII
     letters, numbers, and ‘'_'’.  (Contributed by Serhiy Storchaka in
     bpo-29995(18).)

   * *note tracemalloc.Traceback: 3f4. frames are now sorted from oldest
     to most recent to be more consistent with *note traceback: 113.
     (Contributed by Jesse Bakker in bpo-32121(19).)

   * On OSes that support *note socket.SOCK_NONBLOCK: 48c. or *note
     socket.SOCK_CLOEXEC: 48d. bit flags, the *note socket.type: 48e. no
     longer has them applied.  Therefore, checks like ‘if sock.type ==
     socket.SOCK_STREAM’ work as expected on all platforms.
     (Contributed by Yury Selivanov in bpo-32331(20).)

   * On Windows the default for the `close_fds' argument of *note
     subprocess.Popen: 2b7. was changed from *note False: 37d. to *note
     True: 48f. when redirecting the standard handles.  If you
     previously depended on handles being inherited when using *note
     subprocess.Popen: 2b7. with standard io redirection, you will have
     to pass ‘close_fds=False’ to preserve the previous behaviour, or
     use *note STARTUPINFO.lpAttributeList: 490.

   * *note importlib.machinery.PathFinder.invalidate_caches(): 491. –
     which implicitly affects *note importlib.invalidate_caches(): 492.
     – now deletes entries in *note sys.path_importer_cache: 493. which
     are set to ‘None’.  (Contributed by Brett Cannon in bpo-33169(21).)

   * In *note asyncio: a, *note loop.sock_recv(): 494, *note
     loop.sock_sendall(): 495, *note loop.sock_accept(): 496, *note
     loop.getaddrinfo(): 497, *note loop.getnameinfo(): 498. have been
     changed to be proper coroutine methods to match their
     documentation.  Previously, these methods returned *note
     asyncio.Future: 438. instances.  (Contributed by Yury Selivanov in
     bpo-32327(22).)

   * *note asyncio.Server.sockets: 499. now returns a copy of the
     internal list of server sockets, instead of returning it directly.
     (Contributed by Yury Selivanov in bpo-32662(23).)

   * *note Struct.format: 487. is now a *note str: 325. instance instead
     of a *note bytes: 326. instance.  (Contributed by Victor Stinner in
     bpo-21071(24).)

   * *note argparse: 6. subparsers can now be made mandatory by passing
     ‘required=True’ to *note ArgumentParser.add_subparsers(): 49a.
     (Contributed by Anthony Sottile in bpo-26510(25).)

   * *note ast.literal_eval(): 49b. is now stricter.  Addition and
     subtraction of arbitrary numbers are no longer allowed.
     (Contributed by Serhiy Storchaka in bpo-31778(26).)

   * *note Calendar.itermonthdates: 49c. will now consistently raise an
     exception when a date falls outside of the ‘0001-01-01’ through
     ‘9999-12-31’ range.  To support applications that cannot tolerate
     such exceptions, the new *note Calendar.itermonthdays3: 49d. and
     *note Calendar.itermonthdays4: 49e. can be used.  The new methods
     return tuples and are not restricted by the range supported by
     *note datetime.date: 193.  (Contributed by Alexander Belopolsky in
     bpo-28292(27).)

   * *note collections.ChainMap: 49f. now preserves the order of the
     underlying mappings.  (Contributed by Raymond Hettinger in
     bpo-32792(28).)

   * The ‘submit()’ method of *note
     concurrent.futures.ThreadPoolExecutor: 278. and *note
     concurrent.futures.ProcessPoolExecutor: 2a2. now raises a *note
     RuntimeError: 2b8. if called during interpreter shutdown.
     (Contributed by Mark Nemec in bpo-33097(29).)

   * The *note configparser.ConfigParser: 4a0. constructor now uses
     ‘read_dict()’ to process the default values, making its behavior
     consistent with the rest of the parser.  Non-string keys and values
     in the defaults dictionary are now being implicitly converted to
     strings.  (Contributed by James Tocknell in bpo-23835(30).)

   * Several undocumented internal imports were removed.  One example is
     that ‘os.errno’ is no longer available; use ‘import errno’ directly
     instead.  Note that such undocumented internal imports may be
     removed any time without notice, even in micro version releases.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31233

   (2) https://bugs.python.org/issue33540

   (3) https://bugs.python.org/issue31151

   (4) https://bugs.python.org/issue33540

   (5) https://bugs.python.org/issue31900

   (6) https://bugs.python.org/issue24744

   (7) https://bugs.python.org/issue29193

   (8) https://bugs.python.org/issue29192

   (9) https://bugs.python.org/issue19930

   (10) https://bugs.python.org/issue21071

   (11) https://bugs.python.org/issue29979

   (12) https://bugs.python.org/issue30399

   (13) https://bugs.python.org/issue30302

   (14) https://unicode.org/reports/tr18/

   (15) https://bugs.python.org/issue30349

   (16) https://bugs.python.org/issue25054

   (17) https://bugs.python.org/issue32308

   (18) https://bugs.python.org/issue29995

   (19) https://bugs.python.org/issue32121

   (20) https://bugs.python.org/issue32331

   (21) https://bugs.python.org/issue33169

   (22) https://bugs.python.org/issue32327

   (23) https://bugs.python.org/issue32662

   (24) https://bugs.python.org/issue21071

   (25) https://bugs.python.org/issue26510

   (26) https://bugs.python.org/issue31778

   (27) https://bugs.python.org/issue28292

   (28) https://bugs.python.org/issue32792

   (29) https://bugs.python.org/issue33097

   (30) https://bugs.python.org/issue23835


File: python.info,  Node: Changes in the C API<2>,  Next: CPython bytecode changes<2>,  Prev: Changes in the Python API<2>,  Up: Porting to Python 3 7

1.2.17.3 Changes in the C API
.............................

The function *note PySlice_GetIndicesEx(): 46d. is considered unsafe for
resizable sequences.  If the slice indices are not instances of *note
int: 184, but objects that implement the ‘__index__()’ method, the
sequence can be resized after passing its length to
‘PySlice_GetIndicesEx()’.  This can lead to returning indices out of the
length of the sequence.  For avoiding possible problems use new
functions *note PySlice_Unpack(): 424. and *note
PySlice_AdjustIndices(): 425.  (Contributed by Serhiy Storchaka in
bpo-27867(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27867


File: python.info,  Node: CPython bytecode changes<2>,  Next: Windows-only Changes<2>,  Prev: Changes in the C API<2>,  Up: Porting to Python 3 7

1.2.17.4 CPython bytecode changes
.................................

There are two new opcodes: *note LOAD_METHOD: 4a3. and *note
CALL_METHOD: 4a4.  (Contributed by Yury Selivanov and INADA Naoki in
bpo-26110(1).)

The ‘STORE_ANNOTATION’ opcode has been removed.  (Contributed by Mark
Shannon in bpo-32550(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26110

   (2) https://bugs.python.org/issue32550


File: python.info,  Node: Windows-only Changes<2>,  Next: Other CPython implementation changes,  Prev: CPython bytecode changes<2>,  Up: Porting to Python 3 7

1.2.17.5 Windows-only Changes
.............................

The file used to override *note sys.path: 47d. is now called
‘<python-executable>._pth’ instead of ‘'sys.path'’.  See *note Finding
modules: 4a6. for more information.  (Contributed by Steve Dower in
bpo-28137(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28137


File: python.info,  Node: Other CPython implementation changes,  Prev: Windows-only Changes<2>,  Up: Porting to Python 3 7

1.2.17.6 Other CPython implementation changes
.............................................

In preparation for potential future changes to the public CPython
runtime initialization API (see PEP 432(1) for an initial, but somewhat
outdated, draft), CPython’s internal startup and configuration
management logic has been significantly refactored.  While these updates
are intended to be entirely transparent to both embedding applications
and users of the regular CPython CLI, they’re being mentioned here as
the refactoring changes the internal order of various operations during
interpreter startup, and hence may uncover previously latent defects,
either in embedding applications, or in CPython itself.  (Initially
contributed by Nick Coghlan and Eric Snow as part of bpo-22257(2), and
further updated by Nick, Eric, and Victor Stinner in a number of other
issues).  Some known details affected:

   * *note PySys_AddWarnOptionUnicode(): 4a8. is not currently usable by
     embedding applications due to the requirement to create a Unicode
     object prior to calling ‘Py_Initialize’.  Use *note
     PySys_AddWarnOption(): 4a9. instead.

   * warnings filters added by an embedding application with *note
     PySys_AddWarnOption(): 4a9. should now more consistently take
     precedence over the default filters set by the interpreter

Due to changes in the way the default warnings filters are configured,
setting *note Py_BytesWarningFlag: 4aa. to a value greater than one is
no longer sufficient to both emit *note BytesWarning: 4ab. messages and
have them converted to exceptions.  Instead, the flag must be set (to
cause the warnings to be emitted in the first place), and an explicit
‘error::BytesWarning’ warnings filter added to convert them to
exceptions.

Due to a change in the way docstrings are handled by the compiler, the
implicit ‘return None’ in a function body consisting solely of a
docstring is now marked as occurring on the same line as the docstring,
not on the function’s header line.

The current exception state has been moved from the frame object to the
co-routine.  This simplified the interpreter and fixed a couple of
obscure bugs caused by having swap exception state when entering or
exiting a generator.  (Contributed by Mark Shannon in bpo-25612(3).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0432

   (2) https://bugs.python.org/issue22257

   (3) https://bugs.python.org/issue25612


File: python.info,  Node: Notable changes in Python 3 7 1,  Next: Notable changes in Python 3 7 2,  Prev: Porting to Python 3 7,  Up: What’s New In Python 3 7

1.2.18 Notable changes in Python 3.7.1
--------------------------------------

Starting in 3.7.1, *note Py_Initialize(): 42e. now consistently reads
and respects all of the same environment settings as *note Py_Main():
4ad. (in earlier Python versions, it respected an ill-defined subset of
those environment variables, while in Python 3.7.0 it didn’t read any of
them due to bpo-34247(1)).  If this behavior is unwanted, set *note
Py_IgnoreEnvironmentFlag: 4ae. to 1 before calling *note
Py_Initialize(): 42e.

In 3.7.1 the C API for Context Variables *note was updated: 4af. to use
*note PyObject: 4b0. pointers.  See also bpo-34762(2).

In 3.7.1 the *note tokenize: 111. module now implicitly emits a
‘NEWLINE’ token when provided with input that does not have a trailing
new line.  This behavior now matches what the C tokenizer does
internally.  (Contributed by Ammar Askar in bpo-33899(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34247

   (2) https://bugs.python.org/issue34762

   (3) https://bugs.python.org/issue33899


File: python.info,  Node: Notable changes in Python 3 7 2,  Next: Notable changes in Python 3 7 6,  Prev: Notable changes in Python 3 7 1,  Up: What’s New In Python 3 7

1.2.19 Notable changes in Python 3.7.2
--------------------------------------

In 3.7.2, *note venv: 125. on Windows no longer copies the original
binaries, but creates redirector scripts named ‘python.exe’ and
‘pythonw.exe’ instead.  This resolves a long standing issue where all
virtual environments would have to be upgraded or recreated with each
Python update.  However, note that this release will still require
recreation of virtual environments in order to get the new scripts.


File: python.info,  Node: Notable changes in Python 3 7 6,  Prev: Notable changes in Python 3 7 2,  Up: What’s New In Python 3 7

1.2.20 Notable changes in Python 3.7.6
--------------------------------------

Due to significant security concerns, the `reuse_address' parameter of
*note asyncio.loop.create_datagram_endpoint(): 2e5. is no longer
supported.  This is because of the behavior of the socket option
‘SO_REUSEADDR’ in UDP. For more details, see the documentation for
‘loop.create_datagram_endpoint()’.  (Contributed by Kyle Stanley,
Antoine Pitrou, and Yury Selivanov in bpo-37228(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37228


File: python.info,  Node: What’s New In Python 3 6,  Next: What’s New In Python 3 5,  Prev: What’s New In Python 3 7,  Up: What’s New in Python

1.3 What’s New In Python 3.6
============================


Editors: Elvis Pranskevichus <<elvis@magic.io>>, Yury Selivanov
<<yury@magic.io>>

This article explains the new features in Python 3.6, compared to 3.5.
Python 3.6 was released on December 23, 2016.   See the changelog(1) for
a full list of changes.

See also
........

PEP 494(2) - Python 3.6 Release Schedule

* Menu:

* Summary – Release highlights: Summary – Release highlights<2>.
* New Features: New Features<3>.
* Other Language Changes: Other Language Changes<3>.
* New Modules: New Modules<3>.
* Improved Modules: Improved Modules<3>.
* Optimizations: Optimizations<3>.
* Build and C API Changes: Build and C API Changes<2>.
* Other Improvements::
* Deprecated: Deprecated<2>.
* Removed::
* Porting to Python 3.6: Porting to Python 3 6.
* Notable changes in Python 3.6.2: Notable changes in Python 3 6 2.
* Notable changes in Python 3.6.4: Notable changes in Python 3 6 4.
* Notable changes in Python 3.6.5: Notable changes in Python 3 6 5.
* Notable changes in Python 3.6.7: Notable changes in Python 3 6 7.
* Notable changes in Python 3.6.10: Notable changes in Python 3 6 10.

   ---------- Footnotes ----------

   (1) https://docs.python.org/3.6/whatsnew/changelog.html

   (2) https://www.python.org/dev/peps/pep-0494


File: python.info,  Node: Summary – Release highlights<2>,  Next: New Features<3>,  Up: What’s New In Python 3 6

1.3.1 Summary – Release highlights
----------------------------------

New syntax features:

   * *note PEP 498: 4b6, formatted string literals.

   * *note PEP 515: 4b7, underscores in numeric literals.

   * *note PEP 526: 4b8, syntax for variable annotations.

   * *note PEP 525: 4b9, asynchronous generators.

   * *note PEP 530: 4ba.: asynchronous comprehensions.

New library modules:

   * *note secrets: e4.: *note PEP 506 – Adding A Secrets Module To The
     Standard Library: 4bb.

CPython implementation improvements:

   * The *note dict: 2f1. type has been reimplemented to use a *note
     more compact representation: 4bc. based on a proposal by Raymond
     Hettinger(1) and similar to the PyPy dict implementation(2).  This
     resulted in dictionaries using 20% to 25% less memory when compared
     to Python 3.5.

   * Customization of class creation has been simplified with the *note
     new protocol: 4bd.

   * The class attribute definition order is *note now preserved: 4be.

   * The order of elements in ‘**kwargs’ now *note corresponds to the
     order: 4bf. in which keyword arguments were passed to the function.

   * DTrace and SystemTap *note probing support: 4c0. has been added.

   * The new *note PYTHONMALLOC: 4c1. environment variable can now be
     used to debug the interpreter memory allocation and access errors.

Significant improvements in the standard library:

   * The *note asyncio: a. module has received new features, significant
     usability and performance improvements, and a fair amount of bug
     fixes.  Starting with Python 3.6 the ‘asyncio’ module is no longer
     provisional and its API is considered stable.

   * A new *note file system path protocol: 4c2. has been implemented to
     support *note path-like objects: 35f.  All standard library
     functions operating on paths have been updated to work with the new
     protocol.

   * The *note datetime: 31. module has gained support for *note Local
     Time Disambiguation: 4c3.

   * The *note typing: 119. module received a number of *note
     improvements: 4c4.

   * The *note tracemalloc: 114. module has been significantly reworked
     and is now used to provide better output for *note ResourceWarning:
     4c5. as well as provide better diagnostics for memory allocation
     errors.  See the *note PYTHONMALLOC section: 4c1. for more
     information.

Security improvements:

   * The new *note secrets: e4. module has been added to simplify the
     generation of cryptographically strong pseudo-random numbers
     suitable for managing secrets such as account authentication,
     tokens, and similar.

   * On Linux, *note os.urandom(): 4c6. now blocks until the system
     urandom entropy pool is initialized to increase the security.  See
     the PEP 524(3) for the rationale.

   * The *note hashlib: 8d. and *note ssl: f3. modules now support
     OpenSSL 1.1.0.

   * The default settings and feature set of the *note ssl: f3. module
     have been improved.

   * The *note hashlib: 8d. module received support for the BLAKE2,
     SHA-3 and SHAKE hash algorithms and the *note scrypt(): 4c7. key
     derivation function.

Windows improvements:

   * *note PEP 528: 4c8. and *note PEP 529: 4c9, Windows filesystem and
     console encoding changed to UTF-8.

   * The ‘py.exe’ launcher, when used interactively, no longer prefers
     Python 2 over Python 3 when the user doesn’t specify a version (via
     command line arguments or a config file).  Handling of shebang
     lines remains unchanged - “python” refers to Python 2 in that case.

   * ‘python.exe’ and ‘pythonw.exe’ have been marked as long-path aware,
     which means that the 260 character path limit may no longer apply.
     See *note removing the MAX_PATH limitation: 4ca. for details.

   * A ‘._pth’ file can be added to force isolated mode and fully
     specify all search paths to avoid registry and environment lookup.
     See *note the documentation: 4a6. for more information.

   * A ‘python36.zip’ file now works as a landmark to infer *note
     PYTHONHOME: 4cb.  See *note the documentation: 4a6. for more
     information.

   ---------- Footnotes ----------

   (1) 
https://mail.python.org/pipermail/python-dev/2012-December/123028.html

   (2) 
https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html

   (3) https://www.python.org/dev/peps/pep-0524


File: python.info,  Node: New Features<3>,  Next: Other Language Changes<3>,  Prev: Summary – Release highlights<2>,  Up: What’s New In Python 3 6

1.3.2 New Features
------------------

* Menu:

* PEP 498; Formatted string literals: PEP 498 Formatted string literals.
* PEP 526; Syntax for variable annotations: PEP 526 Syntax for variable annotations.
* PEP 515; Underscores in Numeric Literals: PEP 515 Underscores in Numeric Literals.
* PEP 525; Asynchronous Generators: PEP 525 Asynchronous Generators.
* PEP 530; Asynchronous Comprehensions: PEP 530 Asynchronous Comprehensions.
* PEP 487; Simpler customization of class creation: PEP 487 Simpler customization of class creation.
* PEP 487; Descriptor Protocol Enhancements: PEP 487 Descriptor Protocol Enhancements.
* PEP 519; Adding a file system path protocol: PEP 519 Adding a file system path protocol.
* PEP 495; Local Time Disambiguation: PEP 495 Local Time Disambiguation.
* PEP 529; Change Windows filesystem encoding to UTF-8: PEP 529 Change Windows filesystem encoding to UTF-8.
* PEP 528; Change Windows console encoding to UTF-8: PEP 528 Change Windows console encoding to UTF-8.
* PEP 520; Preserving Class Attribute Definition Order: PEP 520 Preserving Class Attribute Definition Order.
* PEP 468; Preserving Keyword Argument Order: PEP 468 Preserving Keyword Argument Order.
* New dict implementation::
* PEP 523; Adding a frame evaluation API to CPython: PEP 523 Adding a frame evaluation API to CPython.
* PYTHONMALLOC environment variable::
* DTrace and SystemTap probing support::


File: python.info,  Node: PEP 498 Formatted string literals,  Next: PEP 526 Syntax for variable annotations,  Up: New Features<3>

1.3.2.1 PEP 498: Formatted string literals
..........................................

PEP 498(1) introduces a new kind of string literals: `f-strings', or
*note formatted string literals: 15c.

Formatted string literals are prefixed with ‘'f'’ and are similar to the
format strings accepted by *note str.format(): 4cf.  They contain
replacement fields surrounded by curly braces.  The replacement fields
are expressions, which are evaluated at run time, and then formatted
using the *note format(): 4d0. protocol:

     >>> name = "Fred"
     >>> f"He said his name is {name}."
     'He said his name is Fred.'
     >>> width = 10
     >>> precision = 4
     >>> value = decimal.Decimal("12.34567")
     >>> f"result: {value:{width}.{precision}}"  # nested fields
     'result:      12.35'

See also
........

PEP 498(2) – Literal String Interpolation.

     PEP written and implemented by Eric V. Smith.

*note Feature documentation: 15c.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0498

   (2) https://www.python.org/dev/peps/pep-0498


File: python.info,  Node: PEP 526 Syntax for variable annotations,  Next: PEP 515 Underscores in Numeric Literals,  Prev: PEP 498 Formatted string literals,  Up: New Features<3>

1.3.2.2 PEP 526: Syntax for variable annotations
................................................

PEP 484(1) introduced the standard for type annotations of function
parameters, a.k.a.  type hints.  This PEP adds syntax to Python for
annotating the types of variables including class variables and instance
variables:

     primes: List[int] = []

     captain: str  # Note: no initial value!

     class Starship:
         stats: Dict[str, int] = {}

Just as for function annotations, the Python interpreter does not attach
any particular meaning to variable annotations and only stores them in
the ‘__annotations__’ attribute of a class or module.

In contrast to variable declarations in statically typed languages, the
goal of annotation syntax is to provide an easy way to specify
structured type metadata for third party tools and libraries via the
abstract syntax tree and the ‘__annotations__’ attribute.

See also
........

PEP 526(2) – Syntax for variable annotations.

     PEP written by Ryan Gonzalez, Philip House, Ivan Levkivskyi, Lisa
     Roach, and Guido van Rossum.  Implemented by Ivan Levkivskyi.

Tools that use or will use the new syntax: mypy(3), pytype(4), PyCharm,
etc.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484

   (2) https://www.python.org/dev/peps/pep-0526

   (3) http://www.mypy-lang.org/

   (4) https://github.com/google/pytype


File: python.info,  Node: PEP 515 Underscores in Numeric Literals,  Next: PEP 525 Asynchronous Generators,  Prev: PEP 526 Syntax for variable annotations,  Up: New Features<3>

1.3.2.3 PEP 515: Underscores in Numeric Literals
................................................

PEP 515(1) adds the ability to use underscores in numeric literals for
improved readability.  For example:

     >>> 1_000_000_000_000_000
     1000000000000000
     >>> 0x_FF_FF_FF_FF
     4294967295

Single underscores are allowed between digits and after any base
specifier.  Leading, trailing, or multiple underscores in a row are not
allowed.

The *note string formatting: 4d3. language also now has support for the
‘'_'’ option to signal the use of an underscore for a thousands
separator for floating point presentation types and for integer
presentation type ‘'d'’.  For integer presentation types ‘'b'’, ‘'o'’,
‘'x'’, and ‘'X'’, underscores will be inserted every 4 digits:

     >>> '{:_}'.format(1000000)
     '1_000_000'
     >>> '{:_x}'.format(0xFFFFFFFF)
     'ffff_ffff'

See also
........

PEP 515(2) – Underscores in Numeric Literals

     PEP written by Georg Brandl and Serhiy Storchaka.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0515

   (2) https://www.python.org/dev/peps/pep-0515


File: python.info,  Node: PEP 525 Asynchronous Generators,  Next: PEP 530 Asynchronous Comprehensions,  Prev: PEP 515 Underscores in Numeric Literals,  Up: New Features<3>

1.3.2.4 PEP 525: Asynchronous Generators
........................................

PEP 492(1) introduced support for native coroutines and ‘async’ /
‘await’ syntax to Python 3.5.  A notable limitation of the Python 3.5
implementation is that it was not possible to use ‘await’ and ‘yield’ in
the same function body.  In Python 3.6 this restriction has been lifted,
making it possible to define `asynchronous generators':

     async def ticker(delay, to):
         """Yield numbers from 0 to *to* every *delay* seconds."""
         for i in range(to):
             yield i
             await asyncio.sleep(delay)

The new syntax allows for faster and more concise code.

See also
........

PEP 525(2) – Asynchronous Generators

     PEP written and implemented by Yury Selivanov.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0492

   (2) https://www.python.org/dev/peps/pep-0525


File: python.info,  Node: PEP 530 Asynchronous Comprehensions,  Next: PEP 487 Simpler customization of class creation,  Prev: PEP 525 Asynchronous Generators,  Up: New Features<3>

1.3.2.5 PEP 530: Asynchronous Comprehensions
............................................

PEP 530(1) adds support for using ‘async for’ in list, set, dict
comprehensions and generator expressions:

     result = [i async for i in aiter() if i % 2]

Additionally, ‘await’ expressions are supported in all kinds of
comprehensions:

     result = [await fun() for fun in funcs if await condition()]

See also
........

PEP 530(2) – Asynchronous Comprehensions

     PEP written and implemented by Yury Selivanov.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0530

   (2) https://www.python.org/dev/peps/pep-0530


File: python.info,  Node: PEP 487 Simpler customization of class creation,  Next: PEP 487 Descriptor Protocol Enhancements,  Prev: PEP 530 Asynchronous Comprehensions,  Up: New Features<3>

1.3.2.6 PEP 487: Simpler customization of class creation
........................................................

It is now possible to customize subclass creation without using a
metaclass.  The new ‘__init_subclass__’ classmethod will be called on
the base class whenever a new subclass is created:

     class PluginBase:
         subclasses = []

         def __init_subclass__(cls, **kwargs):
             super().__init_subclass__(**kwargs)
             cls.subclasses.append(cls)

     class Plugin1(PluginBase):
         pass

     class Plugin2(PluginBase):
         pass

In order to allow zero-argument *note super(): 4d7. calls to work
correctly from *note __init_subclass__(): 4d8. implementations, custom
metaclasses must ensure that the new ‘__classcell__’ namespace entry is
propagated to ‘type.__new__’ (as described in *note Creating the class
object: 4d9.).

See also
........

PEP 487(1) – Simpler customization of class creation

     PEP written and implemented by Martin Teichmann.

*note Feature documentation: 4da.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0487


File: python.info,  Node: PEP 487 Descriptor Protocol Enhancements,  Next: PEP 519 Adding a file system path protocol,  Prev: PEP 487 Simpler customization of class creation,  Up: New Features<3>

1.3.2.7 PEP 487: Descriptor Protocol Enhancements
.................................................

PEP 487(1) extends the descriptor protocol to include the new optional
*note __set_name__(): 4dd. method.  Whenever a new class is defined, the
new method will be called on all descriptors included in the definition,
providing them with a reference to the class being defined and the name
given to the descriptor within the class namespace.  In other words,
instances of descriptors can now know the attribute name of the
descriptor in the owner class:

     class IntField:
         def __get__(self, instance, owner):
             return instance.__dict__[self.name]

         def __set__(self, instance, value):
             if not isinstance(value, int):
                 raise ValueError(f'expecting integer in {self.name}')
             instance.__dict__[self.name] = value

         # this is the new initializer:
         def __set_name__(self, owner, name):
             self.name = name

     class Model:
         int_field = IntField()

See also
........

PEP 487(2) – Simpler customization of class creation

     PEP written and implemented by Martin Teichmann.

*note Feature documentation: 4de.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0487

   (2) https://www.python.org/dev/peps/pep-0487


File: python.info,  Node: PEP 519 Adding a file system path protocol,  Next: PEP 495 Local Time Disambiguation,  Prev: PEP 487 Descriptor Protocol Enhancements,  Up: New Features<3>

1.3.2.8 PEP 519: Adding a file system path protocol
...................................................

File system paths have historically been represented as *note str: 325.
or *note bytes: 326. objects.  This has led to people who write code
which operate on file system paths to assume that such objects are only
one of those two types (an *note int: 184. representing a file
descriptor does not count as that is not a file path).  Unfortunately
that assumption prevents alternative object representations of file
system paths like *note pathlib: c8. from working with pre-existing
code, including Python’s standard library.

To fix this situation, a new interface represented by *note os.PathLike:
4e0. has been defined.  By implementing the *note __fspath__(): 4e1.
method, an object signals that it represents a path.  An object can then
provide a low-level representation of a file system path as a *note str:
325. or *note bytes: 326. object.  This means an object is considered
*note path-like: 35f. if it implements *note os.PathLike: 4e0. or is a
*note str: 325. or *note bytes: 326. object which represents a file
system path.  Code can use *note os.fspath(): 4e2, *note os.fsdecode():
4e3, or *note os.fsencode(): 4e4. to explicitly get a *note str: 325.
and/or *note bytes: 326. representation of a path-like object.

The built-in *note open(): 4e5. function has been updated to accept
*note os.PathLike: 4e0. objects, as have all relevant functions in the
*note os: c4. and *note os.path: c5. modules, and most other functions
and classes in the standard library.  The *note os.DirEntry: 4e6. class
and relevant classes in *note pathlib: c8. have also been updated to
implement *note os.PathLike: 4e0.

The hope is that updating the fundamental functions for operating on
file system paths will lead to third-party code to implicitly support
all *note path-like objects: 35f. without any code changes, or at least
very minimal ones (e.g.  calling *note os.fspath(): 4e2. at the
beginning of code before operating on a path-like object).

Here are some examples of how the new interface allows for *note
pathlib.Path: 1ff. to be used more easily and transparently with
pre-existing code:

     >>> import pathlib
     >>> with open(pathlib.Path("README")) as f:
     ...     contents = f.read()
     ...
     >>> import os.path
     >>> os.path.splitext(pathlib.Path("some_file.txt"))
     ('some_file', '.txt')
     >>> os.path.join("/a/b", pathlib.Path("c"))
     '/a/b/c'
     >>> import os
     >>> os.fspath(pathlib.Path("some_file.txt"))
     'some_file.txt'

(Implemented by Brett Cannon, Ethan Furman, Dusty Phillips, and Jelle
Zijlstra.)

See also
........

PEP 519(1) – Adding a file system path protocol

     PEP written by Brett Cannon and Koos Zevenhoven.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0519


File: python.info,  Node: PEP 495 Local Time Disambiguation,  Next: PEP 529 Change Windows filesystem encoding to UTF-8,  Prev: PEP 519 Adding a file system path protocol,  Up: New Features<3>

1.3.2.9 PEP 495: Local Time Disambiguation
..........................................

In most world locations, there have been and will be times when local
clocks are moved back.  In those times, intervals are introduced in
which local clocks show the same time twice in the same day.  In these
situations, the information displayed on a local clock (or stored in a
Python datetime instance) is insufficient to identify a particular
moment in time.

PEP 495(1) adds the new `fold' attribute to instances of *note
datetime.datetime: 194. and *note datetime.time: 4e8. classes to
differentiate between two moments in time for which local times are the
same:

     >>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
     >>> for i in range(4):
     ...     u = u0 + i*HOUR
     ...     t = u.astimezone(Eastern)
     ...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
     ...
     04:00:00 UTC = 00:00:00 EDT 0
     05:00:00 UTC = 01:00:00 EDT 0
     06:00:00 UTC = 01:00:00 EST 1
     07:00:00 UTC = 02:00:00 EST 0

The values of the *note fold: 4e9. attribute have the value ‘0’ for all
instances except those that represent the second (chronologically)
moment in time in an ambiguous case.

See also
........

PEP 495(2) – Local Time Disambiguation

     PEP written by Alexander Belopolsky and Tim Peters, implementation
     by Alexander Belopolsky.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0495

   (2) https://www.python.org/dev/peps/pep-0495


File: python.info,  Node: PEP 529 Change Windows filesystem encoding to UTF-8,  Next: PEP 528 Change Windows console encoding to UTF-8,  Prev: PEP 495 Local Time Disambiguation,  Up: New Features<3>

1.3.2.10 PEP 529: Change Windows filesystem encoding to UTF-8
.............................................................

Representing filesystem paths is best performed with str (Unicode)
rather than bytes.  However, there are some situations where using bytes
is sufficient and correct.

Prior to Python 3.6, data loss could result when using bytes paths on
Windows.  With this change, using bytes to represent paths is now
supported on Windows, provided those bytes are encoded with the encoding
returned by *note sys.getfilesystemencoding(): 4eb, which now defaults
to ‘'utf-8'’.

Applications that do not use str to represent paths should use *note
os.fsencode(): 4e4. and *note os.fsdecode(): 4e3. to ensure their bytes
are correctly encoded.  To revert to the previous behaviour, set *note
PYTHONLEGACYWINDOWSFSENCODING: 4ec. or call *note
sys._enablelegacywindowsfsencoding(): 4ed.

See PEP 529(1) for more information and discussion of code modifications
that may be required.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0529


File: python.info,  Node: PEP 528 Change Windows console encoding to UTF-8,  Next: PEP 520 Preserving Class Attribute Definition Order,  Prev: PEP 529 Change Windows filesystem encoding to UTF-8,  Up: New Features<3>

1.3.2.11 PEP 528: Change Windows console encoding to UTF-8
..........................................................

The default console on Windows will now accept all Unicode characters
and provide correctly read str objects to Python code.  ‘sys.stdin’,
‘sys.stdout’ and ‘sys.stderr’ now default to utf-8 encoding.

This change only applies when using an interactive console, and not when
redirecting files or pipes.  To revert to the previous behaviour for
interactive console use, set *note PYTHONLEGACYWINDOWSSTDIO: 4ef.

See also
........

PEP 528(1) – Change Windows console encoding to UTF-8

     PEP written and implemented by Steve Dower.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0528


File: python.info,  Node: PEP 520 Preserving Class Attribute Definition Order,  Next: PEP 468 Preserving Keyword Argument Order,  Prev: PEP 528 Change Windows console encoding to UTF-8,  Up: New Features<3>

1.3.2.12 PEP 520: Preserving Class Attribute Definition Order
.............................................................

Attributes in a class definition body have a natural ordering: the same
order in which the names appear in the source.  This order is now
preserved in the new class’s *note __dict__: 4f1. attribute.

Also, the effective default class `execution' namespace (returned from
*note type.__prepare__(): 4f2.) is now an insertion-order-preserving
mapping.

See also
........

PEP 520(1) – Preserving Class Attribute Definition Order

     PEP written and implemented by Eric Snow.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0520


File: python.info,  Node: PEP 468 Preserving Keyword Argument Order,  Next: New dict implementation,  Prev: PEP 520 Preserving Class Attribute Definition Order,  Up: New Features<3>

1.3.2.13 PEP 468: Preserving Keyword Argument Order
...................................................

‘**kwargs’ in a function signature is now guaranteed to be an
insertion-order-preserving mapping.

See also
........

PEP 468(1) – Preserving Keyword Argument Order

     PEP written and implemented by Eric Snow.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0468


File: python.info,  Node: New dict implementation,  Next: PEP 523 Adding a frame evaluation API to CPython,  Prev: PEP 468 Preserving Keyword Argument Order,  Up: New Features<3>

1.3.2.14 New dict implementation
................................

The *note dict: 2f1. type now uses a “compact” representation based on a
proposal by Raymond Hettinger(1) which was first implemented by PyPy(2).
The memory usage of the new *note dict(): 1b6. is between 20% and 25%
smaller compared to Python 3.5.

The order-preserving aspect of this new implementation is considered an
implementation detail and should not be relied upon (this may change in
the future, but it is desired to have this new dict implementation in
the language for a few releases before changing the language spec to
mandate order-preserving semantics for all current and future Python
implementations; this also helps preserve backwards-compatibility with
older versions of the language where random iteration order is still in
effect, e.g.  Python 3.5).

(Contributed by INADA Naoki in bpo-27350(3).  Idea originally suggested
by Raymond Hettinger(4).)

   ---------- Footnotes ----------

   (1) 
https://mail.python.org/pipermail/python-dev/2012-December/123028.html

   (2) 
https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html

   (3) https://bugs.python.org/issue27350

   (4) 
https://mail.python.org/pipermail/python-dev/2012-December/123028.html


File: python.info,  Node: PEP 523 Adding a frame evaluation API to CPython,  Next: PYTHONMALLOC environment variable,  Prev: New dict implementation,  Up: New Features<3>

1.3.2.15 PEP 523: Adding a frame evaluation API to CPython
..........................................................

While Python provides extensive support to customize how code executes,
one place it has not done so is in the evaluation of frame objects.  If
you wanted some way to intercept frame evaluation in Python there really
wasn’t any way without directly manipulating function pointers for
defined functions.

PEP 523(1) changes this by providing an API to make frame evaluation
pluggable at the C level.  This will allow for tools such as debuggers
and JITs to intercept frame evaluation before the execution of Python
code begins.  This enables the use of alternative evaluation
implementations for Python code, tracking frame evaluation, etc.

This API is not part of the limited C API and is marked as private to
signal that usage of this API is expected to be limited and only
applicable to very select, low-level use-cases.  Semantics of the API
will change with Python as necessary.

See also
........

PEP 523(2) – Adding a frame evaluation API to CPython

     PEP written by Brett Cannon and Dino Viehland.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0523

   (2) https://www.python.org/dev/peps/pep-0523


File: python.info,  Node: PYTHONMALLOC environment variable,  Next: DTrace and SystemTap probing support,  Prev: PEP 523 Adding a frame evaluation API to CPython,  Up: New Features<3>

1.3.2.16 PYTHONMALLOC environment variable
..........................................

The new *note PYTHONMALLOC: 4f8. environment variable allows setting the
Python memory allocators and installing debug hooks.

It is now possible to install debug hooks on Python memory allocators on
Python compiled in release mode using ‘PYTHONMALLOC=debug’.  Effects of
debug hooks:

   * Newly allocated memory is filled with the byte ‘0xCB’

   * Freed memory is filled with the byte ‘0xDB’

   * Detect violations of the Python memory allocator API. For example,
     *note PyObject_Free(): 4f9. called on a memory block allocated by
     *note PyMem_Malloc(): 4fa.

   * Detect writes before the start of a buffer (buffer underflows)

   * Detect writes after the end of a buffer (buffer overflows)

   * Check that the *note GIL: 4fb. is held when allocator functions of
     *note PYMEM_DOMAIN_OBJ: 4fc. (ex: *note PyObject_Malloc(): 4fd.)
     and *note PYMEM_DOMAIN_MEM: 4fe. (ex: *note PyMem_Malloc(): 4fa.)
     domains are called.

Checking if the GIL is held is also a new feature of Python 3.6.

See the *note PyMem_SetupDebugHooks(): 4ff. function for debug hooks on
Python memory allocators.

It is now also possible to force the usage of the ‘malloc()’ allocator
of the C library for all Python memory allocations using
‘PYTHONMALLOC=malloc’.  This is helpful when using external memory
debuggers like Valgrind on a Python compiled in release mode.

On error, the debug hooks on Python memory allocators now use the *note
tracemalloc: 114. module to get the traceback where a memory block was
allocated.

Example of fatal error on buffer overflow using ‘python3.6 -X
tracemalloc=5’ (store 5 frames in traces):

     Debug memory block at address p=0x7fbcd41666f8: API 'o'
         4 bytes originally requested
         The 7 pad bytes at p-7 are FORBIDDENBYTE, as expected.
         The 8 pad bytes at tail=0x7fbcd41666fc are not all FORBIDDENBYTE (0xfb):
             at tail+0: 0x02 *** OUCH
             at tail+1: 0xfb
             at tail+2: 0xfb
             at tail+3: 0xfb
             at tail+4: 0xfb
             at tail+5: 0xfb
             at tail+6: 0xfb
             at tail+7: 0xfb
         The block was made by call #1233329 to debug malloc/realloc.
         Data at p: 1a 2b 30 00

     Memory block allocated at (most recent call first):
       File "test/test_bytes.py", line 323
       File "unittest/case.py", line 600
       File "unittest/case.py", line 648
       File "unittest/suite.py", line 122
       File "unittest/suite.py", line 84

     Fatal Python error: bad trailing pad byte

     Current thread 0x00007fbcdbd32700 (most recent call first):
       File "test/test_bytes.py", line 323 in test_hex
       File "unittest/case.py", line 600 in run
       File "unittest/case.py", line 648 in __call__
       File "unittest/suite.py", line 122 in run
       File "unittest/suite.py", line 84 in __call__
       File "unittest/suite.py", line 122 in run
       File "unittest/suite.py", line 84 in __call__
       ...

(Contributed by Victor Stinner in bpo-26516(1) and bpo-26564(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26516

   (2) https://bugs.python.org/issue26564


File: python.info,  Node: DTrace and SystemTap probing support,  Prev: PYTHONMALLOC environment variable,  Up: New Features<3>

1.3.2.17 DTrace and SystemTap probing support
.............................................

Python can now be built ‘--with-dtrace’ which enables static markers for
the following events in the interpreter:

   * function call/return

   * garbage collection started/finished

   * line of code executed.

This can be used to instrument running interpreters in production,
without the need to recompile specific debug builds or providing
application-specific profiling/debugging code.

More details in *note Instrumenting CPython with DTrace and SystemTap:
501.

The current implementation is tested on Linux and macOS. Additional
markers may be added in the future.

(Contributed by Łukasz Langa in bpo-21590(1), based on patches by Jesús
Cea Avión, David Malcolm, and Nikhil Benesch.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21590


File: python.info,  Node: Other Language Changes<3>,  Next: New Modules<3>,  Prev: New Features<3>,  Up: What’s New In Python 3 6

1.3.3 Other Language Changes
----------------------------

Some smaller changes made to the core Python language are:

   * A ‘global’ or ‘nonlocal’ statement must now textually appear before
     the first use of the affected name in the same scope.  Previously
     this was a *note SyntaxWarning: 191.

   * It is now possible to set a *note special method: 503. to ‘None’ to
     indicate that the corresponding operation is not available.  For
     example, if a class sets *note __iter__(): 504. to ‘None’, the
     class is not iterable.  (Contributed by Andrew Barnert and Ivan
     Levkivskyi in bpo-25958(1).)

   * Long sequences of repeated traceback lines are now abbreviated as
     ‘"[Previous line repeated {count} more times]"’ (see *note
     traceback: 505. for an example).  (Contributed by Emanuel Barry in
     bpo-26823(2).)

   * Import now raises the new exception *note ModuleNotFoundError: 38f.
     (subclass of *note ImportError: 329.) when it cannot find a module.
     Code that currently checks for ImportError (in try-except) will
     still work.  (Contributed by Eric Snow in bpo-15767(3).)

   * Class methods relying on zero-argument ‘super()’ will now work
     correctly when called from metaclass methods during class creation.
     (Contributed by Martin Teichmann in bpo-23722(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25958

   (2) https://bugs.python.org/issue26823

   (3) https://bugs.python.org/issue15767

   (4) https://bugs.python.org/issue23722


File: python.info,  Node: New Modules<3>,  Next: Improved Modules<3>,  Prev: Other Language Changes<3>,  Up: What’s New In Python 3 6

1.3.4 New Modules
-----------------

* Menu:

* secrets::


File: python.info,  Node: secrets,  Up: New Modules<3>

1.3.4.1 secrets
...............

The main purpose of the new *note secrets: e4. module is to provide an
obvious way to reliably generate cryptographically strong pseudo-random
values suitable for managing secrets, such as account authentication,
tokens, and similar.

     Warning: Note that the pseudo-random generators in the *note
     random: dc. module should `NOT' be used for security purposes.  Use
     *note secrets: e4. on Python 3.6+ and *note os.urandom(): 4c6. on
     Python 3.5 and earlier.

See also
........

PEP 506(1) – Adding A Secrets Module To The Standard Library

     PEP written and implemented by Steven D’Aprano.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0506


File: python.info,  Node: Improved Modules<3>,  Next: Optimizations<3>,  Prev: New Modules<3>,  Up: What’s New In Python 3 6

1.3.5 Improved Modules
----------------------

* Menu:

* array::
* ast: ast<2>.
* asyncio: asyncio<4>.
* binascii: binascii<2>.
* cmath::
* collections: collections<4>.
* concurrent.futures: concurrent futures<2>.
* contextlib: contextlib<2>.
* datetime: datetime<3>.
* decimal: decimal<2>.
* distutils: distutils<2>.
* email::
* encodings::
* enum: enum<3>.
* faulthandler::
* fileinput::
* hashlib::
* http.client: http client<2>.
* idlelib and IDLE: idlelib and IDLE<2>.
* importlib: importlib<3>.
* inspect: inspect<2>.
* json::
* logging: logging<3>.
* math: math<3>.
* multiprocessing: multiprocessing<3>.
* os: os<3>.
* pathlib: pathlib<3>.
* pdb: pdb<2>.
* pickle: pickle<2>.
* pickletools::
* pydoc: pydoc<2>.
* random::
* re: re<2>.
* readline::
* rlcompleter::
* shlex: shlex<2>.
* site::
* sqlite3: sqlite3<2>.
* socket: socket<4>.
* socketserver: socketserver<2>.
* ssl: ssl<4>.
* statistics: statistics<2>.
* struct::
* subprocess: subprocess<2>.
* sys: sys<4>.
* telnetlib::
* time: time<3>.
* timeit::
* tkinter: tkinter<3>.
* traceback::
* tracemalloc: tracemalloc<2>.
* typing: typing<2>.
* unicodedata: unicodedata<3>.
* unittest.mock: unittest mock<2>.
* urllib.request: urllib request.
* urllib.robotparser: urllib robotparser.
* venv: venv<2>.
* warnings: warnings<2>.
* winreg::
* winsound::
* xmlrpc.client: xmlrpc client.
* zipfile: zipfile<2>.
* zlib::


File: python.info,  Node: array,  Next: ast<2>,  Up: Improved Modules<3>

1.3.5.1 array
.............

Exhausted iterators of *note array.array: 446. will now stay exhausted
even if the iterated array is extended.  This is consistent with the
behavior of other mutable sequences.

Contributed by Serhiy Storchaka in bpo-26492(1).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26492


File: python.info,  Node: ast<2>,  Next: asyncio<4>,  Prev: array,  Up: Improved Modules<3>

1.3.5.2 ast
...........

The new ‘ast.Constant’ AST node has been added.  It can be used by
external AST optimizers for the purposes of constant folding.

Contributed by Victor Stinner in bpo-26146(1).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26146


File: python.info,  Node: asyncio<4>,  Next: binascii<2>,  Prev: ast<2>,  Up: Improved Modules<3>

1.3.5.3 asyncio
...............

Starting with Python 3.6 the ‘asyncio’ module is no longer provisional
and its API is considered stable.

Notable changes in the *note asyncio: a. module since Python 3.5.0 (all
backported to 3.5.x due to the provisional status):

   * The *note get_event_loop(): 34a. function has been changed to
     always return the currently running loop when called from
     coroutines and callbacks.  (Contributed by Yury Selivanov in
     bpo-28613(1).)

   * The *note ensure_future(): 50c. function and all functions that use
     it, such as *note loop.run_until_complete(): 50d, now accept all
     kinds of *note awaitable objects: 50e.  (Contributed by Yury
     Selivanov.)

   * New *note run_coroutine_threadsafe(): 50f. function to submit
     coroutines to event loops from other threads.  (Contributed by
     Vincent Michel.)

   * New *note Transport.is_closing(): 510. method to check if the
     transport is closing or closed.  (Contributed by Yury Selivanov.)

   * The *note loop.create_server(): 352. method can now accept a list
     of hosts.  (Contributed by Yann Sionneau.)

   * New *note loop.create_future(): 511. method to create Future
     objects.  This allows alternative event loop implementations, such
     as uvloop(2), to provide a faster *note asyncio.Future: 438.
     implementation.  (Contributed by Yury Selivanov in bpo-27041(3).)

   * New *note loop.get_exception_handler(): 512. method to get the
     current exception handler.  (Contributed by Yury Selivanov in
     bpo-27040(4).)

   * New *note StreamReader.readuntil(): 513. method to read data from
     the stream until a separator bytes sequence appears.  (Contributed
     by Mark Korenberg.)

   * The performance of *note StreamReader.readexactly(): 514. has been
     improved.  (Contributed by Mark Korenberg in bpo-28370(5).)

   * The *note loop.getaddrinfo(): 497. method is optimized to avoid
     calling the system ‘getaddrinfo’ function if the address is already
     resolved.  (Contributed by A. Jesse Jiryu Davis.)

   * The *note loop.stop(): 515. method has been changed to stop the
     loop immediately after the current iteration.  Any new callbacks
     scheduled as a result of the last iteration will be discarded.
     (Contributed by Guido van Rossum in bpo-25593(6).)

   * ‘Future.set_exception’ will now raise *note TypeError: 192. when
     passed an instance of the *note StopIteration: 47b. exception.
     (Contributed by Chris Angelico in bpo-26221(7).)

   * New *note loop.connect_accepted_socket(): 35a. method to be used by
     servers that accept connections outside of asyncio, but that use
     asyncio to handle them.  (Contributed by Jim Fulton in
     bpo-27392(8).)

   * ‘TCP_NODELAY’ flag is now set for all TCP transports by default.
     (Contributed by Yury Selivanov in bpo-27456(9).)

   * New *note loop.shutdown_asyncgens(): 516. to properly close pending
     asynchronous generators before closing the loop.  (Contributed by
     Yury Selivanov in bpo-28003(10).)

   * *note Future: 438. and *note Task: 1ab. classes now have an
     optimized C implementation which makes asyncio code up to 30%
     faster.  (Contributed by Yury Selivanov and INADA Naoki in
     bpo-26081(11) and bpo-28544(12).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28613

   (2) https://github.com/MagicStack/uvloop

   (3) https://bugs.python.org/issue27041

   (4) https://bugs.python.org/issue27040

   (5) https://bugs.python.org/issue28370

   (6) https://bugs.python.org/issue25593

   (7) https://bugs.python.org/issue26221

   (8) https://bugs.python.org/issue27392

   (9) https://bugs.python.org/issue27456

   (10) https://bugs.python.org/issue28003

   (11) https://bugs.python.org/issue26081

   (12) https://bugs.python.org/issue28544


File: python.info,  Node: binascii<2>,  Next: cmath,  Prev: asyncio<4>,  Up: Improved Modules<3>

1.3.5.4 binascii
................

The *note b2a_base64(): 518. function now accepts an optional `newline'
keyword argument to control whether the newline character is appended to
the return value.  (Contributed by Victor Stinner in bpo-25357(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25357


File: python.info,  Node: cmath,  Next: collections<4>,  Prev: binascii<2>,  Up: Improved Modules<3>

1.3.5.5 cmath
.............

The new *note cmath.tau: 51a. (`τ') constant has been added.
(Contributed by Lisa Roach in bpo-12345(1), see PEP 628(2) for details.)

New constants: *note cmath.inf: 51b. and *note cmath.nan: 51c. to match
*note math.inf: 51d. and *note math.nan: 51e, and also *note cmath.infj:
51f. and *note cmath.nanj: 520. to match the format used by complex
repr.  (Contributed by Mark Dickinson in bpo-23229(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12345

   (2) https://www.python.org/dev/peps/pep-0628

   (3) https://bugs.python.org/issue23229


File: python.info,  Node: collections<4>,  Next: concurrent futures<2>,  Prev: cmath,  Up: Improved Modules<3>

1.3.5.6 collections
...................

The new *note Collection: 522. abstract base class has been added to
represent sized iterable container classes.  (Contributed by Ivan
Levkivskyi, docs by Neil Girdhar in bpo-27598(1).)

The new *note Reversible: 523. abstract base class represents iterable
classes that also provide the *note __reversed__(): 524. method.
(Contributed by Ivan Levkivskyi in bpo-25987(2).)

The new *note AsyncGenerator: 525. abstract base class represents
asynchronous generators.  (Contributed by Yury Selivanov in
bpo-28720(3).)

The *note namedtuple(): 1b5. function now accepts an optional keyword
argument `module', which, when specified, is used for the ‘__module__’
attribute of the returned named tuple class.  (Contributed by Raymond
Hettinger in bpo-17941(4).)

The `verbose' and `rename' arguments for *note namedtuple(): 1b5. are
now keyword-only.  (Contributed by Raymond Hettinger in bpo-25628(5).)

Recursive *note collections.deque: 526. instances can now be pickled.
(Contributed by Serhiy Storchaka in bpo-26482(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27598

   (2) https://bugs.python.org/issue25987

   (3) https://bugs.python.org/issue28720

   (4) https://bugs.python.org/issue17941

   (5) https://bugs.python.org/issue25628

   (6) https://bugs.python.org/issue26482


File: python.info,  Node: concurrent futures<2>,  Next: contextlib<2>,  Prev: collections<4>,  Up: Improved Modules<3>

1.3.5.7 concurrent.futures
..........................

The *note ThreadPoolExecutor: 278. class constructor now accepts an
optional `thread_name_prefix' argument to make it possible to customize
the names of the threads created by the pool.  (Contributed by Gregory
P. Smith in bpo-27664(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27664


File: python.info,  Node: contextlib<2>,  Next: datetime<3>,  Prev: concurrent futures<2>,  Up: Improved Modules<3>

1.3.5.8 contextlib
..................

The *note contextlib.AbstractContextManager: 529. class has been added
to provide an abstract base class for context managers.  It provides a
sensible default implementation for ‘__enter__()’ which returns ‘self’
and leaves ‘__exit__()’ an abstract method.  A matching class has been
added to the *note typing: 119. module as *note typing.ContextManager:
52a.  (Contributed by Brett Cannon in bpo-25609(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25609


File: python.info,  Node: datetime<3>,  Next: decimal<2>,  Prev: contextlib<2>,  Up: Improved Modules<3>

1.3.5.9 datetime
................

The *note datetime: 194. and *note time: 4e8. classes have the new
‘fold’ attribute used to disambiguate local time when necessary.  Many
functions in the *note datetime: 31. have been updated to support local
time disambiguation.  See *note Local Time Disambiguation: 4c3. section
for more information.  (Contributed by Alexander Belopolsky in
bpo-24773(1).)

The *note datetime.strftime(): 52c. and *note date.strftime(): 52d.
methods now support ISO 8601 date directives ‘%G’, ‘%u’ and ‘%V’.
(Contributed by Ashley Anderson in bpo-12006(2).)

The *note datetime.isoformat(): 374. function now accepts an optional
`timespec' argument that specifies the number of additional components
of the time value to include.  (Contributed by Alessandro Cucci and
Alexander Belopolsky in bpo-19475(3).)

The *note datetime.combine(): 52e. now accepts an optional `tzinfo'
argument.  (Contributed by Alexander Belopolsky in bpo-27661(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24773

   (2) https://bugs.python.org/issue12006

   (3) https://bugs.python.org/issue19475

   (4) https://bugs.python.org/issue27661


File: python.info,  Node: decimal<2>,  Next: distutils<2>,  Prev: datetime<3>,  Up: Improved Modules<3>

1.3.5.10 decimal
................

New *note Decimal.as_integer_ratio(): 530. method that returns a pair
‘(n, d)’ of integers that represent the given *note Decimal: 188.
instance as a fraction, in lowest terms and with a positive denominator:

     >>> Decimal('-3.14').as_integer_ratio()
     (-157, 50)

(Contributed by Stefan Krah amd Mark Dickinson in bpo-25928(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25928


File: python.info,  Node: distutils<2>,  Next: email,  Prev: decimal<2>,  Up: Improved Modules<3>

1.3.5.11 distutils
..................

The ‘default_format’ attribute has been removed from
‘distutils.command.sdist.sdist’ and the ‘formats’ attribute defaults to
‘['gztar']’.  Although not anticipated, any code relying on the presence
of ‘default_format’ may need to be adapted.  See bpo-27819(1) for more
details.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27819


File: python.info,  Node: email,  Next: encodings,  Prev: distutils<2>,  Up: Improved Modules<3>

1.3.5.12 email
..............

The new email API, enabled via the `policy' keyword to various
constructors, is no longer provisional.  The *note email: 69.
documentation has been reorganized and rewritten to focus on the new
API, while retaining the old documentation for the legacy API.
(Contributed by R. David Murray in bpo-24277(1).)

The *note email.mime: 73. classes now all accept an optional `policy'
keyword.  (Contributed by Berker Peksag in bpo-27331(2).)

The *note DecodedGenerator: 533. now supports the `policy' keyword.

There is a new *note policy: 75. attribute, *note message_factory: 534,
that controls what class is used by default when the parser creates new
message objects.  For the *note email.policy.compat32: 535. policy this
is *note Message: 536, for the new policies it is *note EmailMessage:
537.  (Contributed by R. David Murray in bpo-20476(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24277

   (2) https://bugs.python.org/issue27331

   (3) https://bugs.python.org/issue20476


File: python.info,  Node: encodings,  Next: enum<3>,  Prev: email,  Up: Improved Modules<3>

1.3.5.13 encodings
..................

On Windows, added the ‘'oem'’ encoding to use ‘CP_OEMCP’, and the
‘'ansi'’ alias for the existing ‘'mbcs'’ encoding, which uses the
‘CP_ACP’ code page.  (Contributed by Steve Dower in bpo-27959(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27959


File: python.info,  Node: enum<3>,  Next: faulthandler,  Prev: encodings,  Up: Improved Modules<3>

1.3.5.14 enum
.............

Two new enumeration base classes have been added to the *note enum: 7b.
module: *note Flag: 53a. and ‘IntFlags’.  Both are used to define
constants that can be combined using the bitwise operators.
(Contributed by Ethan Furman in bpo-23591(1).)

Many standard library modules have been updated to use the ‘IntFlags’
class for their constants.

The new *note enum.auto: 53b. value can be used to assign values to enum
members automatically:

     >>> from enum import Enum, auto
     >>> class Color(Enum):
     ...     red = auto()
     ...     blue = auto()
     ...     green = auto()
     ...
     >>> list(Color)
     [<Color.red: 1>, <Color.blue: 2>, <Color.green: 3>]

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23591


File: python.info,  Node: faulthandler,  Next: fileinput,  Prev: enum<3>,  Up: Improved Modules<3>

1.3.5.15 faulthandler
.....................

On Windows, the *note faulthandler: 7d. module now installs a handler
for Windows exceptions: see *note faulthandler.enable(): 53d.
(Contributed by Victor Stinner in bpo-23848(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23848


File: python.info,  Node: fileinput,  Next: hashlib,  Prev: faulthandler,  Up: Improved Modules<3>

1.3.5.16 fileinput
..................

*note hook_encoded(): 53f. now supports the `errors' argument.
(Contributed by Joseph Hackman in bpo-25788(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25788


File: python.info,  Node: hashlib,  Next: http client<2>,  Prev: fileinput,  Up: Improved Modules<3>

1.3.5.17 hashlib
................

*note hashlib: 8d. supports OpenSSL 1.1.0.  The minimum recommend
version is 1.0.2.  (Contributed by Christian Heimes in bpo-26470(1).)

BLAKE2 hash functions were added to the module.  *note blake2b(): 541.
and *note blake2s(): 542. are always available and support the full
feature set of BLAKE2.  (Contributed by Christian Heimes in bpo-26798(2)
based on code by Dmitry Chestnykh and Samuel Neves.  Documentation
written by Dmitry Chestnykh.)

The SHA-3 hash functions ‘sha3_224()’, ‘sha3_256()’, ‘sha3_384()’,
‘sha3_512()’, and SHAKE hash functions ‘shake_128()’ and ‘shake_256()’
were added.  (Contributed by Christian Heimes in bpo-16113(3).  Keccak
Code Package by Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van
Assche, and Ronny Van Keer.)

The password-based key derivation function *note scrypt(): 4c7. is now
available with OpenSSL 1.1.0 and newer.  (Contributed by Christian
Heimes in bpo-27928(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26470

   (2) https://bugs.python.org/issue26798

   (3) https://bugs.python.org/issue16113

   (4) https://bugs.python.org/issue27928


File: python.info,  Node: http client<2>,  Next: idlelib and IDLE<2>,  Prev: hashlib,  Up: Improved Modules<3>

1.3.5.18 http.client
....................

*note HTTPConnection.request(): 544. and *note endheaders(): 545. both
now support chunked encoding request bodies.  (Contributed by Demian
Brecht and Rolf Krahl in bpo-12319(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12319


File: python.info,  Node: idlelib and IDLE<2>,  Next: importlib<3>,  Prev: http client<2>,  Up: Improved Modules<3>

1.3.5.19 idlelib and IDLE
.........................

The idlelib package is being modernized and refactored to make IDLE look
and work better and to make the code easier to understand, test, and
improve.  Part of making IDLE look better, especially on Linux and Mac,
is using ttk widgets, mostly in the dialogs.  As a result, IDLE no
longer runs with tcl/tk 8.4.  It now requires tcl/tk 8.5 or 8.6.  We
recommend running the latest release of either.

‘Modernizing’ includes renaming and consolidation of idlelib modules.
The renaming of files with partial uppercase names is similar to the
renaming of, for instance, Tkinter and TkFont to tkinter and
tkinter.font in 3.0.  As a result, imports of idlelib files that worked
in 3.5 will usually not work in 3.6.  At least a module name change will
be needed (see idlelib/README.txt), sometimes more.  (Name changes
contributed by Al Swiegart and Terry Reedy in bpo-24225(1).  Most
idlelib patches since have been and will be part of the process.)

In compensation, the eventual result with be that some idlelib classes
will be easier to use, with better APIs and docstrings explaining them.
Additional useful information will be added to idlelib when available.

New in 3.6.2:

Multiple fixes for autocompletion.  (Contributed by Louie Lu in
bpo-15786(2).)

New in 3.6.3:

Module Browser (on the File menu, formerly called Class Browser), now
displays nested functions and classes in addition to top-level functions
and classes.  (Contributed by Guilherme Polo, Cheryl Sabella, and Terry
Jan Reedy in bpo-1612262(3).)

The IDLE features formerly implemented as extensions have been
reimplemented as normal features.  Their settings have been moved from
the Extensions tab to other dialog tabs.  (Contributed by Charles
Wohlganger and Terry Jan Reedy in bpo-27099(4).)

The Settings dialog (Options, Configure IDLE) has been partly rewritten
to improve both appearance and function.  (Contributed by Cheryl Sabella
and Terry Jan Reedy in multiple issues.)

New in 3.6.4:

The font sample now includes a selection of non-Latin characters so that
users can better see the effect of selecting a particular font.
(Contributed by Terry Jan Reedy in bpo-13802(5).)  The sample can be
edited to include other characters.  (Contributed by Serhiy Storchaka in
bpo-31860(6).)

New in 3.6.6:

Editor code context option revised.  Box displays all context lines up
to maxlines.  Clicking on a context line jumps the editor to that line.
Context colors for custom themes is added to Highlights tab of Settings
dialog.  (Contributed by Cheryl Sabella and Terry Jan Reedy in
bpo-33642(7), bpo-33768(8), and bpo-33679(9).)

On Windows, a new API call tells Windows that tk scales for DPI. On
Windows 8.1+ or 10, with DPI compatibility properties of the Python
binary unchanged, and a monitor resolution greater than 96 DPI, this
should make text and lines sharper.  It should otherwise have no effect.
(Contributed by Terry Jan Reedy in bpo-33656(10).)

New in 3.6.7:

Output over N lines (50 by default) is squeezed down to a button.  N can
be changed in the PyShell section of the General page of the Settings
dialog.  Fewer, but possibly extra long, lines can be squeezed by right
clicking on the output.  Squeezed output can be expanded in place by
double-clicking the button or into the clipboard or a separate window by
right-clicking the button.  (Contributed by Tal Einat in
bpo-1529353(11).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24225

   (2) https://bugs.python.org/issue15786

   (3) https://bugs.python.org/issue1612262

   (4) https://bugs.python.org/issue27099

   (5) https://bugs.python.org/issue13802

   (6) https://bugs.python.org/issue31860

   (7) https://bugs.python.org/issue33642

   (8) https://bugs.python.org/issue33768

   (9) https://bugs.python.org/issue33679

   (10) https://bugs.python.org/issue33656

   (11) https://bugs.python.org/issue1529353


File: python.info,  Node: importlib<3>,  Next: inspect<2>,  Prev: idlelib and IDLE<2>,  Up: Improved Modules<3>

1.3.5.20 importlib
..................

Import now raises the new exception *note ModuleNotFoundError: 38f.
(subclass of *note ImportError: 329.) when it cannot find a module.
Code that current checks for ‘ImportError’ (in try-except) will still
work.  (Contributed by Eric Snow in bpo-15767(1).)

*note importlib.util.LazyLoader: 548. now calls *note create_module():
549. on the wrapped loader, removing the restriction that *note
importlib.machinery.BuiltinImporter: 54a. and *note
importlib.machinery.ExtensionFileLoader: 54b. couldn’t be used with
*note importlib.util.LazyLoader: 548.

*note importlib.util.cache_from_source(): 54c, *note
importlib.util.source_from_cache(): 54d, and *note
importlib.util.spec_from_file_location(): 54e. now accept a *note
path-like object: 35f.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15767


File: python.info,  Node: inspect<2>,  Next: json,  Prev: importlib<3>,  Up: Improved Modules<3>

1.3.5.21 inspect
................

The *note inspect.signature(): 550. function now reports the implicit
‘.0’ parameters generated by the compiler for comprehension and
generator expression scopes as if they were positional-only parameters
called ‘implicit0’.  (Contributed by Jelle Zijlstra in bpo-19611(1).)

To reduce code churn when upgrading from Python 2.7 and the legacy *note
inspect.getargspec(): 551. API, the previously documented deprecation of
*note inspect.getfullargspec(): 552. has been reversed.  While this
function is convenient for single/source Python 2/3 code bases, the
richer *note inspect.signature(): 550. interface remains the recommended
approach for new code.  (Contributed by Nick Coghlan in bpo-27172(2))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19611

   (2) https://bugs.python.org/issue27172


File: python.info,  Node: json,  Next: logging<3>,  Prev: inspect<2>,  Up: Improved Modules<3>

1.3.5.22 json
.............

*note json.load(): 554. and *note json.loads(): 555. now support binary
input.  Encoded JSON should be represented using either UTF-8, UTF-16,
or UTF-32.  (Contributed by Serhiy Storchaka in bpo-17909(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17909


File: python.info,  Node: logging<3>,  Next: math<3>,  Prev: json,  Up: Improved Modules<3>

1.3.5.23 logging
................

The new *note WatchedFileHandler.reopenIfNeeded(): 557. method has been
added to add the ability to check if the log file needs to be reopened.
(Contributed by Marian Horban in bpo-24884(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24884


File: python.info,  Node: math<3>,  Next: multiprocessing<3>,  Prev: logging<3>,  Up: Improved Modules<3>

1.3.5.24 math
.............

The tau (`τ') constant has been added to the *note math: b1. and *note
cmath: 19. modules.  (Contributed by Lisa Roach in bpo-12345(1), see PEP
628(2) for details.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12345

   (2) https://www.python.org/dev/peps/pep-0628


File: python.info,  Node: multiprocessing<3>,  Next: os<3>,  Prev: math<3>,  Up: Improved Modules<3>

1.3.5.25 multiprocessing
........................

*note Proxy Objects: 55a. returned by ‘multiprocessing.Manager()’ can
now be nested.  (Contributed by Davin Potts in bpo-6766(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6766


File: python.info,  Node: os<3>,  Next: pathlib<3>,  Prev: multiprocessing<3>,  Up: Improved Modules<3>

1.3.5.26 os
...........

See the summary of *note PEP 519: 4c2. for details on how the *note os:
c4. and *note os.path: c5. modules now support *note path-like objects:
35f.

*note scandir(): 25d. now supports *note bytes: 326. paths on Windows.

A new *note close(): 55c. method allows explicitly closing a *note
scandir(): 25d. iterator.  The *note scandir(): 25d. iterator now
supports the *note context manager: 55d. protocol.  If a ‘scandir()’
iterator is neither exhausted nor explicitly closed a *note
ResourceWarning: 4c5. will be emitted in its destructor.  (Contributed
by Serhiy Storchaka in bpo-25994(1).)

On Linux, *note os.urandom(): 4c6. now blocks until the system urandom
entropy pool is initialized to increase the security.  See the PEP
524(2) for the rationale.

The Linux ‘getrandom()’ syscall (get random bytes) is now exposed as the
new *note os.getrandom(): 55e. function.  (Contributed by Victor
Stinner, part of the PEP 524(3))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25994

   (2) https://www.python.org/dev/peps/pep-0524

   (3) https://www.python.org/dev/peps/pep-0524


File: python.info,  Node: pathlib<3>,  Next: pdb<2>,  Prev: os<3>,  Up: Improved Modules<3>

1.3.5.27 pathlib
................

*note pathlib: c8. now supports *note path-like objects: 35f.
(Contributed by Brett Cannon in bpo-27186(1).)

See the summary of *note PEP 519: 4c2. for details.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27186


File: python.info,  Node: pdb<2>,  Next: pickle<2>,  Prev: pathlib<3>,  Up: Improved Modules<3>

1.3.5.28 pdb
............

The *note Pdb: 561. class constructor has a new optional `readrc'
argument to control whether ‘.pdbrc’ files should be read.


File: python.info,  Node: pickle<2>,  Next: pickletools,  Prev: pdb<2>,  Up: Improved Modules<3>

1.3.5.29 pickle
...............

Objects that need ‘__new__’ called with keyword arguments can now be
pickled using *note pickle protocols: 563. older than protocol version
4.  Protocol version 4 already supports this case.  (Contributed by
Serhiy Storchaka in bpo-24164(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24164


File: python.info,  Node: pickletools,  Next: pydoc<2>,  Prev: pickle<2>,  Up: Improved Modules<3>

1.3.5.30 pickletools
....................

*note pickletools.dis(): 565. now outputs the implicit memo index for
the ‘MEMOIZE’ opcode.  (Contributed by Serhiy Storchaka in
bpo-25382(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25382


File: python.info,  Node: pydoc<2>,  Next: random,  Prev: pickletools,  Up: Improved Modules<3>

1.3.5.31 pydoc
..............

The *note pydoc: d9. module has learned to respect the ‘MANPAGER’
environment variable.  (Contributed by Matthias Klose in bpo-8637(1).)

*note help(): 567. and *note pydoc: d9. can now list named tuple fields
in the order they were defined rather than alphabetically.  (Contributed
by Raymond Hettinger in bpo-24879(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8637

   (2) https://bugs.python.org/issue24879


File: python.info,  Node: random,  Next: re<2>,  Prev: pydoc<2>,  Up: Improved Modules<3>

1.3.5.32 random
...............

The new *note choices(): 569. function returns a list of elements of
specified size from the given population with optional weights.
(Contributed by Raymond Hettinger in bpo-18844(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18844


File: python.info,  Node: re<2>,  Next: readline,  Prev: random,  Up: Improved Modules<3>

1.3.5.33 re
...........

Added support of modifier spans in regular expressions.  Examples:
‘'(?i:p)ython'’ matches ‘'python'’ and ‘'Python'’, but not ‘'PYTHON'’;
‘'(?i)g(?-i:v)r'’ matches ‘'GvR'’ and ‘'gvr'’, but not ‘'GVR'’.
(Contributed by Serhiy Storchaka in bpo-433028(1).)

Match object groups can be accessed by ‘__getitem__’, which is
equivalent to ‘group()’.  So ‘mo['name']’ is now equivalent to
‘mo.group('name')’.  (Contributed by Eric Smith in bpo-24454(2).)

‘Match’ objects now support *note index-like objects: 18a. as group
indices.  (Contributed by Jeroen Demeyer and Xiang Zhang in
bpo-27177(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue433028

   (2) https://bugs.python.org/issue24454

   (3) https://bugs.python.org/issue27177


File: python.info,  Node: readline,  Next: rlcompleter,  Prev: re<2>,  Up: Improved Modules<3>

1.3.5.34 readline
.................

Added *note set_auto_history(): 56c. to enable or disable automatic
addition of input to the history list.  (Contributed by Tyler Crompton
in bpo-26870(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26870


File: python.info,  Node: rlcompleter,  Next: shlex<2>,  Prev: readline,  Up: Improved Modules<3>

1.3.5.35 rlcompleter
....................

Private and special attribute names now are omitted unless the prefix
starts with underscores.  A space or a colon is added after some
completed keywords.  (Contributed by Serhiy Storchaka in bpo-25011(1)
and bpo-25209(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25011

   (2) https://bugs.python.org/issue25209


File: python.info,  Node: shlex<2>,  Next: site,  Prev: rlcompleter,  Up: Improved Modules<3>

1.3.5.36 shlex
..............

The *note shlex: 56f. has much *note improved shell compatibility: 570.
through the new `punctuation_chars' argument to control which characters
are treated as punctuation.  (Contributed by Vinay Sajip in
bpo-1521950(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1521950


File: python.info,  Node: site,  Next: sqlite3<2>,  Prev: shlex<2>,  Up: Improved Modules<3>

1.3.5.37 site
.............

When specifying paths to add to *note sys.path: 47d. in a ‘.pth’ file,
you may now specify file paths on top of directories (e.g.  zip files).
(Contributed by Wolfgang Langner in bpo-26587(1)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26587


File: python.info,  Node: sqlite3<2>,  Next: socket<4>,  Prev: site,  Up: Improved Modules<3>

1.3.5.38 sqlite3
................

*note sqlite3.Cursor.lastrowid: 573. now supports the ‘REPLACE’
statement.  (Contributed by Alex LordThorsen in bpo-16864(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16864


File: python.info,  Node: socket<4>,  Next: socketserver<2>,  Prev: sqlite3<2>,  Up: Improved Modules<3>

1.3.5.39 socket
...............

The *note ioctl(): 575. function now supports the *note
SIO_LOOPBACK_FAST_PATH: 576. control code.  (Contributed by Daniel
Stokes in bpo-26536(1).)

The *note getsockopt(): 577. constants ‘SO_DOMAIN’, ‘SO_PROTOCOL’,
‘SO_PEERSEC’, and ‘SO_PASSSEC’ are now supported.  (Contributed by
Christian Heimes in bpo-26907(2).)

The *note setsockopt(): 578. now supports the ‘setsockopt(level,
optname, None, optlen: int)’ form.  (Contributed by Christian Heimes in
bpo-27744(3).)

The socket module now supports the address family *note AF_ALG: 579. to
interface with Linux Kernel crypto API. ‘ALG_*’, ‘SOL_ALG’ and *note
sendmsg_afalg(): 57a. were added.  (Contributed by Christian Heimes in
bpo-27744(4) with support from Victor Stinner.)

New Linux constants ‘TCP_USER_TIMEOUT’ and ‘TCP_CONGESTION’ were added.
(Contributed by Omar Sandoval, issue:‘26273’).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26536

   (2) https://bugs.python.org/issue26907

   (3) https://bugs.python.org/issue27744

   (4) https://bugs.python.org/issue27744


File: python.info,  Node: socketserver<2>,  Next: ssl<4>,  Prev: socket<4>,  Up: Improved Modules<3>

1.3.5.40 socketserver
.....................

Servers based on the *note socketserver: f0. module, including those
defined in *note http.server: 97, *note xmlrpc.server: 140. and *note
wsgiref.simple_server: 12f, now support the *note context manager: 55d.
protocol.  (Contributed by Aviv Palivoda in bpo-26404(1).)

The ‘wfile’ attribute of *note StreamRequestHandler: 57c. classes now
implements the *note io.BufferedIOBase: 57d. writable interface.  In
particular, calling *note write(): 57e. is now guaranteed to send the
data in full.  (Contributed by Martin Panter in bpo-26721(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26404

   (2) https://bugs.python.org/issue26721


File: python.info,  Node: ssl<4>,  Next: statistics<2>,  Prev: socketserver<2>,  Up: Improved Modules<3>

1.3.5.41 ssl
............

*note ssl: f3. supports OpenSSL 1.1.0.  The minimum recommend version is
1.0.2.  (Contributed by Christian Heimes in bpo-26470(1).)

3DES has been removed from the default cipher suites and ChaCha20
Poly1305 cipher suites have been added.  (Contributed by Christian
Heimes in bpo-27850(2) and bpo-27766(3).)

*note SSLContext: 3d9. has better default configuration for options and
ciphers.  (Contributed by Christian Heimes in bpo-28043(4).)

SSL session can be copied from one client-side connection to another
with the new *note SSLSession: 580. class.  TLS session resumption can
speed up the initial handshake, reduce latency and improve performance
(Contributed by Christian Heimes in bpo-19500(5) based on a draft by
Alex Warhawk.)

The new *note get_ciphers(): 581. method can be used to get a list of
enabled ciphers in order of cipher priority.

All constants and flags have been converted to *note IntEnum: 582. and
‘IntFlags’.  (Contributed by Christian Heimes in bpo-28025(6).)

Server and client-side specific TLS protocols for *note SSLContext: 3d9.
were added.  (Contributed by Christian Heimes in bpo-28085(7).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26470

   (2) https://bugs.python.org/issue27850

   (3) https://bugs.python.org/issue27766

   (4) https://bugs.python.org/issue28043

   (5) https://bugs.python.org/issue19500

   (6) https://bugs.python.org/issue28025

   (7) https://bugs.python.org/issue28085


File: python.info,  Node: statistics<2>,  Next: struct,  Prev: ssl<4>,  Up: Improved Modules<3>

1.3.5.42 statistics
...................

A new *note harmonic_mean(): 584. function has been added.  (Contributed
by Steven D’Aprano in bpo-27181(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27181


File: python.info,  Node: struct,  Next: subprocess<2>,  Prev: statistics<2>,  Up: Improved Modules<3>

1.3.5.43 struct
...............

*note struct: f8. now supports IEEE 754 half-precision floats via the
‘'e'’ format specifier.  (Contributed by Eli Stevens, Mark Dickinson in
bpo-11734(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11734


File: python.info,  Node: subprocess<2>,  Next: sys<4>,  Prev: struct,  Up: Improved Modules<3>

1.3.5.44 subprocess
...................

*note subprocess.Popen: 2b7. destructor now emits a *note
ResourceWarning: 4c5. warning if the child process is still running.
Use the context manager protocol (‘with proc: ...’) or explicitly call
the *note wait(): 587. method to read the exit status of the child
process.  (Contributed by Victor Stinner in bpo-26741(1).)

The *note subprocess.Popen: 2b7. constructor and all functions that pass
arguments through to it now accept `encoding' and `errors' arguments.
Specifying either of these will enable text mode for the `stdin',
`stdout' and `stderr' streams.  (Contributed by Steve Dower in
bpo-6135(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26741

   (2) https://bugs.python.org/issue6135


File: python.info,  Node: sys<4>,  Next: telnetlib,  Prev: subprocess<2>,  Up: Improved Modules<3>

1.3.5.45 sys
............

The new *note getfilesystemencodeerrors(): 589. function returns the
name of the error mode used to convert between Unicode filenames and
bytes filenames.  (Contributed by Steve Dower in bpo-27781(1).)

On Windows the return value of the *note getwindowsversion(): 58a.
function now includes the `platform_version' field which contains the
accurate major version, minor version and build number of the current
operating system, rather than the version that is being emulated for the
process (Contributed by Steve Dower in bpo-27932(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27781

   (2) https://bugs.python.org/issue27932


File: python.info,  Node: telnetlib,  Next: time<3>,  Prev: sys<4>,  Up: Improved Modules<3>

1.3.5.46 telnetlib
..................

*note Telnet: 58c. is now a context manager (contributed by Stéphane
Wirtel in bpo-25485(1)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25485


File: python.info,  Node: time<3>,  Next: timeit,  Prev: telnetlib,  Up: Improved Modules<3>

1.3.5.47 time
.............

The *note struct_time: 58e. attributes ‘tm_gmtoff’ and ‘tm_zone’ are now
available on all platforms.


File: python.info,  Node: timeit,  Next: tkinter<3>,  Prev: time<3>,  Up: Improved Modules<3>

1.3.5.48 timeit
...............

The new *note Timer.autorange(): 590. convenience method has been added
to call *note Timer.timeit(): 591. repeatedly so that the total run time
is greater or equal to 200 milliseconds.  (Contributed by Steven
D’Aprano in bpo-6422(1).)

*note timeit: 10b. now warns when there is substantial (4x) variance
between best and worst times.  (Contributed by Serhiy Storchaka in
bpo-23552(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6422

   (2) https://bugs.python.org/issue23552


File: python.info,  Node: tkinter<3>,  Next: traceback,  Prev: timeit,  Up: Improved Modules<3>

1.3.5.49 tkinter
................

Added methods ‘trace_add()’, ‘trace_remove()’ and ‘trace_info()’ in the
‘tkinter.Variable’ class.  They replace old methods ‘trace_variable()’,
‘trace()’, ‘trace_vdelete()’ and ‘trace_vinfo()’ that use obsolete Tcl
commands and might not work in future versions of Tcl.  (Contributed by
Serhiy Storchaka in bpo-22115(1)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22115


File: python.info,  Node: traceback,  Next: tracemalloc<2>,  Prev: tkinter<3>,  Up: Improved Modules<3>

1.3.5.50 traceback
..................

Both the traceback module and the interpreter’s builtin exception
display now abbreviate long sequences of repeated lines in tracebacks as
shown in the following example:

     >>> def f(): f()
     ...
     >>> f()
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
       File "<stdin>", line 1, in f
       File "<stdin>", line 1, in f
       File "<stdin>", line 1, in f
       [Previous line repeated 995 more times]
     RecursionError: maximum recursion depth exceeded

(Contributed by Emanuel Barry in bpo-26823(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26823


File: python.info,  Node: tracemalloc<2>,  Next: typing<2>,  Prev: traceback,  Up: Improved Modules<3>

1.3.5.51 tracemalloc
....................

The *note tracemalloc: 114. module now supports tracing memory
allocations in multiple different address spaces.

The new *note DomainFilter: 595. filter class has been added to filter
block traces by their address space (domain).

(Contributed by Victor Stinner in bpo-26588(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26588


File: python.info,  Node: typing<2>,  Next: unicodedata<3>,  Prev: tracemalloc<2>,  Up: Improved Modules<3>

1.3.5.52 typing
...............

Since the *note typing: 119. module is *note provisional: 33d, all
changes introduced in Python 3.6 have also been backported to Python
3.5.x.

The *note typing: 119. module has a much improved support for generic
type aliases.  For example ‘Dict[str, Tuple[S, T]]’ is now a valid type
annotation.  (Contributed by Guido van Rossum in Github #195(1).)

The *note typing.ContextManager: 52a. class has been added for
representing *note contextlib.AbstractContextManager: 529.  (Contributed
by Brett Cannon in bpo-25609(2).)

The *note typing.Collection: 597. class has been added for representing
*note collections.abc.Collection: 522.  (Contributed by Ivan Levkivskyi
in bpo-27598(3).)

The *note typing.ClassVar: 598. type construct has been added to mark
class variables.  As introduced in PEP 526(4), a variable annotation
wrapped in ClassVar indicates that a given attribute is intended to be
used as a class variable and should not be set on instances of that
class.  (Contributed by Ivan Levkivskyi in Github #280(5).)

A new *note TYPE_CHECKING: 599. constant that is assumed to be ‘True’ by
the static type checkers, but is ‘False’ at runtime.  (Contributed by
Guido van Rossum in Github #230(6).)

A new *note NewType(): 59a. helper function has been added to create
lightweight distinct types for annotations:

     from typing import NewType

     UserId = NewType('UserId', int)
     some_id = UserId(524313)

The static type checker will treat the new type as if it were a subclass
of the original type.  (Contributed by Ivan Levkivskyi in Github
#189(7).)

   ---------- Footnotes ----------

   (1) https://github.com/python/typing/pull/195

   (2) https://bugs.python.org/issue25609

   (3) https://bugs.python.org/issue27598

   (4) https://www.python.org/dev/peps/pep-0526

   (5) https://github.com/python/typing/pull/280

   (6) https://github.com/python/typing/issues/230

   (7) https://github.com/python/typing/issues/189


File: python.info,  Node: unicodedata<3>,  Next: unittest mock<2>,  Prev: typing<2>,  Up: Improved Modules<3>

1.3.5.53 unicodedata
....................

The *note unicodedata: 11a. module now uses data from Unicode 9.0.0(1).
(Contributed by Benjamin Peterson.)

   ---------- Footnotes ----------

   (1) http://unicode.org/versions/Unicode9.0.0/


File: python.info,  Node: unittest mock<2>,  Next: urllib request,  Prev: unicodedata<3>,  Up: Improved Modules<3>

1.3.5.54 unittest.mock
......................

The *note Mock: 247. class has the following improvements:

   * Two new methods, *note Mock.assert_called(): 59d. and *note
     Mock.assert_called_once(): 59e. to check if the mock object was
     called.  (Contributed by Amit Saha in bpo-26323(1).)

   * The *note Mock.reset_mock(): 59f. method now has two optional
     keyword only arguments: `return_value' and `side_effect'.
     (Contributed by Kushal Das in bpo-21271(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26323

   (2) https://bugs.python.org/issue21271


File: python.info,  Node: urllib request,  Next: urllib robotparser,  Prev: unittest mock<2>,  Up: Improved Modules<3>

1.3.5.55 urllib.request
.......................

If a HTTP request has a file or iterable body (other than a bytes
object) but no ‘Content-Length’ header, rather than throwing an error,
‘AbstractHTTPHandler’ now falls back to use chunked transfer encoding.
(Contributed by Demian Brecht and Rolf Krahl in bpo-12319(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12319


File: python.info,  Node: urllib robotparser,  Next: venv<2>,  Prev: urllib request,  Up: Improved Modules<3>

1.3.5.56 urllib.robotparser
...........................

*note RobotFileParser: 5a2. now supports the ‘Crawl-delay’ and
‘Request-rate’ extensions.  (Contributed by Nikolay Bogoychev in
bpo-16099(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16099


File: python.info,  Node: venv<2>,  Next: warnings<2>,  Prev: urllib robotparser,  Up: Improved Modules<3>

1.3.5.57 venv
.............

*note venv: 125. accepts a new parameter ‘--prompt’.  This parameter
provides an alternative prefix for the virtual environment.  (Proposed
by Łukasz Balcerzak and ported to 3.6 by Stéphane Wirtel in
bpo-22829(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22829


File: python.info,  Node: warnings<2>,  Next: winreg,  Prev: venv<2>,  Up: Improved Modules<3>

1.3.5.58 warnings
.................

A new optional `source' parameter has been added to the *note
warnings.warn_explicit(): 5a5. function: the destroyed object which
emitted a *note ResourceWarning: 4c5.  A `source' attribute has also
been added to ‘warnings.WarningMessage’ (contributed by Victor Stinner
in bpo-26568(1) and bpo-26567(2)).

When a *note ResourceWarning: 4c5. warning is logged, the *note
tracemalloc: 114. module is now used to try to retrieve the traceback
where the destroyed object was allocated.

Example with the script ‘example.py’:

     import warnings

     def func():
         return open(__file__)

     f = func()
     f = None

Output of the command ‘python3.6 -Wd -X tracemalloc=5 example.py’:

     example.py:7: ResourceWarning: unclosed file <_io.TextIOWrapper name='example.py' mode='r' encoding='UTF-8'>
       f = None
     Object allocated at (most recent call first):
       File "example.py", lineno 4
         return open(__file__)
       File "example.py", lineno 6
         f = func()

The “Object allocated at” traceback is new and is only displayed if
*note tracemalloc: 114. is tracing Python memory allocations and if the
*note warnings: 126. module was already imported.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26568

   (2) https://bugs.python.org/issue26567


File: python.info,  Node: winreg,  Next: winsound,  Prev: warnings<2>,  Up: Improved Modules<3>

1.3.5.59 winreg
...............

Added the 64-bit integer type *note REG_QWORD: 5a7.  (Contributed by
Clement Rouault in bpo-23026(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23026


File: python.info,  Node: winsound,  Next: xmlrpc client,  Prev: winreg,  Up: Improved Modules<3>

1.3.5.60 winsound
.................

Allowed keyword arguments to be passed to *note Beep: 5a9, *note
MessageBeep: 5aa, and *note PlaySound: 5ab. (bpo-27982(1)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27982


File: python.info,  Node: xmlrpc client,  Next: zipfile<2>,  Prev: winsound,  Up: Improved Modules<3>

1.3.5.61 xmlrpc.client
......................

The *note xmlrpc.client: 13f. module now supports unmarshalling
additional data types used by the Apache XML-RPC implementation for
numerics and ‘None’.  (Contributed by Serhiy Storchaka in bpo-26885(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26885


File: python.info,  Node: zipfile<2>,  Next: zlib,  Prev: xmlrpc client,  Up: Improved Modules<3>

1.3.5.62 zipfile
................

A new *note ZipInfo.from_file(): 5ae. class method allows making a *note
ZipInfo: 5af. instance from a filesystem file.  A new *note
ZipInfo.is_dir(): 5b0. method can be used to check if the *note ZipInfo:
5af. instance represents a directory.  (Contributed by Thomas Kluyver in
bpo-26039(1).)

The *note ZipFile.open(): 5b1. method can now be used to write data into
a ZIP file, as well as for extracting data.  (Contributed by Thomas
Kluyver in bpo-26039(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26039

   (2) https://bugs.python.org/issue26039


File: python.info,  Node: zlib,  Prev: zipfile<2>,  Up: Improved Modules<3>

1.3.5.63 zlib
.............

The *note compress(): 5b3. and *note decompress(): 5b4. functions now
accept keyword arguments.  (Contributed by Aviv Palivoda in bpo-26243(1)
and Xiang Zhang in bpo-16764(2) respectively.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26243

   (2) https://bugs.python.org/issue16764


File: python.info,  Node: Optimizations<3>,  Next: Build and C API Changes<2>,  Prev: Improved Modules<3>,  Up: What’s New In Python 3 6

1.3.6 Optimizations
-------------------

   * The Python interpreter now uses a 16-bit wordcode instead of
     bytecode which made a number of opcode optimizations possible.
     (Contributed by Demur Rumed with input and reviews from Serhiy
     Storchaka and Victor Stinner in bpo-26647(1) and bpo-28050(2).)

   * The *note asyncio.Future: 438. class now has an optimized C
     implementation.  (Contributed by Yury Selivanov and INADA Naoki in
     bpo-26081(3).)

   * The *note asyncio.Task: 1ab. class now has an optimized C
     implementation.  (Contributed by Yury Selivanov in bpo-28544(4).)

   * Various implementation improvements in the *note typing: 119.
     module (such as caching of generic types) allow up to 30 times
     performance improvements and reduced memory footprint.

   * The ASCII decoder is now up to 60 times as fast for error handlers
     ‘surrogateescape’, ‘ignore’ and ‘replace’ (Contributed by Victor
     Stinner in bpo-24870(5)).

   * The ASCII and the Latin1 encoders are now up to 3 times as fast for
     the error handler ‘surrogateescape’ (Contributed by Victor Stinner
     in bpo-25227(6)).

   * The UTF-8 encoder is now up to 75 times as fast for error handlers
     ‘ignore’, ‘replace’, ‘surrogateescape’, ‘surrogatepass’
     (Contributed by Victor Stinner in bpo-25267(7)).

   * The UTF-8 decoder is now up to 15 times as fast for error handlers
     ‘ignore’, ‘replace’ and ‘surrogateescape’ (Contributed by Victor
     Stinner in bpo-25301(8)).

   * ‘bytes % args’ is now up to 2 times faster.  (Contributed by Victor
     Stinner in bpo-25349(9)).

   * ‘bytearray % args’ is now between 2.5 and 5 times faster.
     (Contributed by Victor Stinner in bpo-25399(10)).

   * Optimize *note bytes.fromhex(): 323. and *note bytearray.fromhex():
     324.: they are now between 2x and 3.5x faster.  (Contributed by
     Victor Stinner in bpo-25401(11)).

   * Optimize ‘bytes.replace(b'', b'.')’ and ‘bytearray.replace(b'',
     b'.')’: up to 80% faster.  (Contributed by Josh Snider in
     bpo-26574(12)).

   * Allocator functions of the *note PyMem_Malloc(): 4fa. domain (*note
     PYMEM_DOMAIN_MEM: 4fe.) now use the *note pymalloc memory
     allocator: 5b6. instead of ‘malloc()’ function of the C library.
     The pymalloc allocator is optimized for objects smaller or equal to
     512 bytes with a short lifetime, and use ‘malloc()’ for larger
     memory blocks.  (Contributed by Victor Stinner in bpo-26249(13)).

   * *note pickle.load(): 5b7. and *note pickle.loads(): 5b8. are now up
     to 10% faster when deserializing many small objects (Contributed by
     Victor Stinner in bpo-27056(14)).

   * Passing *note keyword arguments: 5b9. to a function has an overhead
     in comparison with passing *note positional arguments: 5ba.  Now in
     extension functions implemented with using Argument Clinic this
     overhead is significantly decreased.  (Contributed by Serhiy
     Storchaka in bpo-27574(15)).

   * Optimized *note glob(): 5bb. and *note iglob(): 5bc. functions in
     the *note glob: 8a. module; they are now about 3–6 times faster.
     (Contributed by Serhiy Storchaka in bpo-25596(16)).

   * Optimized globbing in *note pathlib: c8. by using *note
     os.scandir(): 25d.; it is now about 1.5–4 times faster.
     (Contributed by Serhiy Storchaka in bpo-26032(17)).

   * *note xml.etree.ElementTree: 137. parsing, iteration and deepcopy
     performance has been significantly improved.  (Contributed by
     Serhiy Storchaka in bpo-25638(18), bpo-25873(19), and
     bpo-25869(20).)

   * Creation of *note fractions.Fraction: 185. instances from floats
     and decimals is now 2 to 3 times faster.  (Contributed by Serhiy
     Storchaka in bpo-25971(21).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26647

   (2) https://bugs.python.org/issue28050

   (3) https://bugs.python.org/issue26081

   (4) https://bugs.python.org/issue28544

   (5) https://bugs.python.org/issue24870

   (6) https://bugs.python.org/issue25227

   (7) https://bugs.python.org/issue25267

   (8) https://bugs.python.org/issue25301

   (9) https://bugs.python.org/issue25349

   (10) https://bugs.python.org/issue25399

   (11) https://bugs.python.org/issue25401

   (12) https://bugs.python.org/issue26574

   (13) https://bugs.python.org/issue26249

   (14) https://bugs.python.org/issue27056

   (15) https://bugs.python.org/issue27574

   (16) https://bugs.python.org/issue25596

   (17) https://bugs.python.org/issue26032

   (18) https://bugs.python.org/issue25638

   (19) https://bugs.python.org/issue25873

   (20) https://bugs.python.org/issue25869

   (21) https://bugs.python.org/issue25971


File: python.info,  Node: Build and C API Changes<2>,  Next: Other Improvements,  Prev: Optimizations<3>,  Up: What’s New In Python 3 6

1.3.7 Build and C API Changes
-----------------------------

   * Python now requires some C99 support in the toolchain to build.
     Most notably, Python now uses standard integer types and macros in
     place of custom macros like ‘PY_LONG_LONG’.  For more information,
     see PEP 7(1) and bpo-17884(2).

   * Cross-compiling CPython with the Android NDK and the Android API
     level set to 21 (Android 5.0 Lollipop) or greater runs
     successfully.  While Android is not yet a supported platform, the
     Python test suite runs on the Android emulator with only about 16
     tests failures.  See the Android meta-issue bpo-26865(3).

   * The ‘--enable-optimizations’ configure flag has been added.
     Turning it on will activate expensive optimizations like PGO.
     (Original patch by Alecsandru Patrascu of Intel in bpo-26359(4).)

   * The *note GIL: 4fb. must now be held when allocator functions of
     *note PYMEM_DOMAIN_OBJ: 4fc. (ex: *note PyObject_Malloc(): 4fd.)
     and *note PYMEM_DOMAIN_MEM: 4fe. (ex: *note PyMem_Malloc(): 4fa.)
     domains are called.

   * New *note Py_FinalizeEx(): 5be. API which indicates if flushing
     buffered data failed.  (Contributed by Martin Panter in
     bpo-5319(5).)

   * *note PyArg_ParseTupleAndKeywords(): 5bf. now supports *note
     positional-only parameters: 2a5.  Positional-only parameters are
     defined by empty names.  (Contributed by Serhiy Storchaka in
     bpo-26282(6)).

   * ‘PyTraceback_Print’ method now abbreviates long sequences of
     repeated lines as ‘"[Previous line repeated {count} more times]"’.
     (Contributed by Emanuel Barry in bpo-26823(7).)

   * The new *note PyErr_SetImportErrorSubclass(): 5c0. function allows
     for specifying a subclass of *note ImportError: 329. to raise.
     (Contributed by Eric Snow in bpo-15767(8).)

   * The new *note PyErr_ResourceWarning(): 5c1. function can be used to
     generate a *note ResourceWarning: 4c5. providing the source of the
     resource allocation.  (Contributed by Victor Stinner in
     bpo-26567(9).)

   * The new *note PyOS_FSPath(): 5c2. function returns the file system
     representation of a *note path-like object: 35f.  (Contributed by
     Brett Cannon in bpo-27186(10).)

   * The *note PyUnicode_FSConverter(): 5c3. and *note
     PyUnicode_FSDecoder(): 5c4. functions will now accept *note
     path-like objects: 35f.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0007

   (2) https://bugs.python.org/issue17884

   (3) https://bugs.python.org/issue26865

   (4) https://bugs.python.org/issue26359

   (5) https://bugs.python.org/issue5319

   (6) https://bugs.python.org/issue26282

   (7) https://bugs.python.org/issue26823

   (8) https://bugs.python.org/issue15767

   (9) https://bugs.python.org/issue26567

   (10) https://bugs.python.org/issue27186


File: python.info,  Node: Other Improvements,  Next: Deprecated<2>,  Prev: Build and C API Changes<2>,  Up: What’s New In Python 3 6

1.3.8 Other Improvements
------------------------

   * When *note –version: 5c6. (short form: *note -V: 5c7.) is supplied
     twice, Python prints *note sys.version: 5c8. for detailed
     information.

          $ ./python -VV
          Python 3.6.0b4+ (3.6:223967b49e49+, Nov 21 2016, 20:55:04)
          [GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]


File: python.info,  Node: Deprecated<2>,  Next: Removed,  Prev: Other Improvements,  Up: What’s New In Python 3 6

1.3.9 Deprecated
----------------

* Menu:

* New Keywords::
* Deprecated Python behavior::
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods<2>.
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<2>.
* Deprecated Build Options::


File: python.info,  Node: New Keywords,  Next: Deprecated Python behavior,  Up: Deprecated<2>

1.3.9.1 New Keywords
....................

‘async’ and ‘await’ are not recommended to be used as variable, class,
function or module names.  Introduced by PEP 492(1) in Python 3.5, they
will become proper keywords in Python 3.7.  Starting in Python 3.6, the
use of ‘async’ or ‘await’ as names will generate a *note
DeprecationWarning: 276.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: Deprecated Python behavior,  Next: Deprecated Python modules functions and methods<2>,  Prev: New Keywords,  Up: Deprecated<2>

1.3.9.2 Deprecated Python behavior
..................................

Raising the *note StopIteration: 47b. exception inside a generator will
now generate a *note DeprecationWarning: 276, and will trigger a *note
RuntimeError: 2b8. in Python 3.7.  See *note PEP 479; Change
StopIteration handling inside generators: 5cc. for details.

The *note __aiter__(): 47c. method is now expected to return an
asynchronous iterator directly instead of returning an awaitable as
previously.  Doing the former will trigger a *note DeprecationWarning:
276.  Backward compatibility will be removed in Python 3.7.
(Contributed by Yury Selivanov in bpo-27243(1).)

A backslash-character pair that is not a valid escape sequence now
generates a *note DeprecationWarning: 276.  Although this will
eventually become a *note SyntaxError: 44d, that will not be for several
Python releases.  (Contributed by Emanuel Barry in bpo-27364(2).)

When performing a relative import, falling back on ‘__name__’ and
‘__path__’ from the calling module when ‘__spec__’ or ‘__package__’ are
not defined now raises an *note ImportWarning: 5cd.  (Contributed by
Rose Ames in bpo-25791(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27243

   (2) https://bugs.python.org/issue27364

   (3) https://bugs.python.org/issue25791


File: python.info,  Node: Deprecated Python modules functions and methods<2>,  Next: Deprecated functions and types of the C API<2>,  Prev: Deprecated Python behavior,  Up: Deprecated<2>

1.3.9.3 Deprecated Python modules, functions and methods
........................................................

* Menu:

* asynchat::
* asyncore::
* dbm: dbm<3>.
* distutils: distutils<3>.
* grp::
* importlib: importlib<4>.
* os: os<4>.
* re: re<3>.
* ssl: ssl<5>.
* tkinter: tkinter<4>.
* venv: venv<3>.


File: python.info,  Node: asynchat,  Next: asyncore,  Up: Deprecated Python modules functions and methods<2>

1.3.9.4 asynchat
................

The *note asynchat: 9. has been deprecated in favor of *note asyncio: a.
(Contributed by Mariatta in bpo-25002(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25002


File: python.info,  Node: asyncore,  Next: dbm<3>,  Prev: asynchat,  Up: Deprecated Python modules functions and methods<2>

1.3.9.5 asyncore
................

The *note asyncore: b. has been deprecated in favor of *note asyncio: a.
(Contributed by Mariatta in bpo-25002(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25002


File: python.info,  Node: dbm<3>,  Next: distutils<3>,  Prev: asyncore,  Up: Deprecated Python modules functions and methods<2>

1.3.9.6 dbm
...........

Unlike other *note dbm: 32. implementations, the *note dbm.dumb: 33.
module creates databases with the ‘'rw'’ mode and allows modifying the
database opened with the ‘'r'’ mode.  This behavior is now deprecated
and will be removed in 3.8.  (Contributed by Serhiy Storchaka in
bpo-21708(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21708


File: python.info,  Node: distutils<3>,  Next: grp,  Prev: dbm<3>,  Up: Deprecated Python modules functions and methods<2>

1.3.9.7 distutils
.................

The undocumented ‘extra_path’ argument to the ‘Distribution’ constructor
is now considered deprecated and will raise a warning if set.  Support
for this parameter will be removed in a future Python release.  See
bpo-27919(1) for details.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27919


File: python.info,  Node: grp,  Next: importlib<4>,  Prev: distutils<3>,  Up: Deprecated Python modules functions and methods<2>

1.3.9.8 grp
...........

The support of non-integer arguments in *note getgrgid(): 5d4. has been
deprecated.  (Contributed by Serhiy Storchaka in bpo-26129(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26129


File: python.info,  Node: importlib<4>,  Next: os<4>,  Prev: grp,  Up: Deprecated Python modules functions and methods<2>

1.3.9.9 importlib
.................

The *note importlib.machinery.SourceFileLoader.load_module(): 5d6. and
*note importlib.machinery.SourcelessFileLoader.load_module(): 5d7.
methods are now deprecated.  They were the only remaining
implementations of *note importlib.abc.Loader.load_module(): 5d8. in
*note importlib: 9b. that had not been deprecated in previous versions
of Python in favour of *note importlib.abc.Loader.exec_module(): 5d9.

The *note importlib.machinery.WindowsRegistryFinder: 5da. class is now
deprecated.  As of 3.6.0, it is still added to *note sys.meta_path: 5db.
by default (on Windows), but this may change in future releases.


File: python.info,  Node: os<4>,  Next: re<3>,  Prev: importlib<4>,  Up: Deprecated Python modules functions and methods<2>

1.3.9.10 os
...........

Undocumented support of general *note bytes-like objects: 5dd. as paths
in *note os: c4. functions, *note compile(): 1b2. and similar functions
is now deprecated.  (Contributed by Serhiy Storchaka in bpo-25791(1) and
bpo-26754(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25791

   (2) https://bugs.python.org/issue26754


File: python.info,  Node: re<3>,  Next: ssl<5>,  Prev: os<4>,  Up: Deprecated Python modules functions and methods<2>

1.3.9.11 re
...........

Support for inline flags ‘(?letters)’ in the middle of the regular
expression has been deprecated and will be removed in a future Python
version.  Flags at the start of a regular expression are still allowed.
(Contributed by Serhiy Storchaka in bpo-22493(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22493


File: python.info,  Node: ssl<5>,  Next: tkinter<4>,  Prev: re<3>,  Up: Deprecated Python modules functions and methods<2>

1.3.9.12 ssl
............

OpenSSL 0.9.8, 1.0.0 and 1.0.1 are deprecated and no longer supported.
In the future the *note ssl: f3. module will require at least OpenSSL
1.0.2 or 1.1.0.

SSL-related arguments like ‘certfile’, ‘keyfile’ and ‘check_hostname’ in
*note ftplib: 84, *note http.client: 94, *note imaplib: 98, *note
poplib: d0, and *note smtplib: ed. have been deprecated in favor of
‘context’.  (Contributed by Christian Heimes in bpo-28022(1).)

A couple of protocols and functions of the *note ssl: f3. module are now
deprecated.  Some features will no longer be available in future
versions of OpenSSL. Other features are deprecated in favor of a
different API. (Contributed by Christian Heimes in bpo-28022(2) and
bpo-26470(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28022

   (2) https://bugs.python.org/issue28022

   (3) https://bugs.python.org/issue26470


File: python.info,  Node: tkinter<4>,  Next: venv<3>,  Prev: ssl<5>,  Up: Deprecated Python modules functions and methods<2>

1.3.9.13 tkinter
................

The *note tkinter.tix: 10e. module is now deprecated.  *note tkinter:
10c. users should use *note tkinter.ttk: 10f. instead.


File: python.info,  Node: venv<3>,  Prev: tkinter<4>,  Up: Deprecated Python modules functions and methods<2>

1.3.9.14 venv
.............

The ‘pyvenv’ script has been deprecated in favour of ‘python3 -m venv’.
This prevents confusion as to what Python interpreter ‘pyvenv’ is
connected to and thus what Python interpreter will be used by the
virtual environment.  (Contributed by Brett Cannon in bpo-25154(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25154


File: python.info,  Node: Deprecated functions and types of the C API<2>,  Next: Deprecated Build Options,  Prev: Deprecated Python modules functions and methods<2>,  Up: Deprecated<2>

1.3.9.15 Deprecated functions and types of the C API
....................................................

Undocumented functions ‘PyUnicode_AsEncodedObject()’,
‘PyUnicode_AsDecodedObject()’, ‘PyUnicode_AsEncodedUnicode()’ and
‘PyUnicode_AsDecodedUnicode()’ are deprecated now.  Use the *note
generic codec based API: 5e3. instead.


File: python.info,  Node: Deprecated Build Options,  Prev: Deprecated functions and types of the C API<2>,  Up: Deprecated<2>

1.3.9.16 Deprecated Build Options
.................................

The ‘--with-system-ffi’ configure flag is now on by default on non-macOS
UNIX platforms.  It may be disabled by using ‘--without-system-ffi’, but
using the flag is deprecated and will not be accepted in Python 3.7.
macOS is unaffected by this change.  Note that many OS distributors
already use the ‘--with-system-ffi’ flag when building their system
Python.


File: python.info,  Node: Removed,  Next: Porting to Python 3 6,  Prev: Deprecated<2>,  Up: What’s New In Python 3 6

1.3.10 Removed
--------------

* Menu:

* API and Feature Removals: API and Feature Removals<3>.


File: python.info,  Node: API and Feature Removals<3>,  Up: Removed

1.3.10.1 API and Feature Removals
.................................

   * Unknown escapes consisting of ‘'\'’ and an ASCII letter in regular
     expressions will now cause an error.  In replacement templates for
     *note re.sub(): 470. they are still allowed, but deprecated.  The
     *note re.LOCALE: 3be. flag can now only be used with binary
     patterns.

   * ‘inspect.getmoduleinfo()’ was removed (was deprecated since CPython
     3.3).  *note inspect.getmodulename(): 5e7. should be used for
     obtaining the module name for a given path.  (Contributed by Yury
     Selivanov in bpo-13248(1).)

   * ‘traceback.Ignore’ class and ‘traceback.usage’,
     ‘traceback.modname’, ‘traceback.fullmodname’,
     ‘traceback.find_lines_from_code’, ‘traceback.find_lines’,
     ‘traceback.find_strings’, ‘traceback.find_executable_lines’ methods
     were removed from the *note traceback: 113. module.  They were
     undocumented methods deprecated since Python 3.2 and equivalent
     functionality is available from private methods.

   * The ‘tk_menuBar()’ and ‘tk_bindForTraversal()’ dummy methods in
     *note tkinter: 10c. widget classes were removed (corresponding Tk
     commands were obsolete since Tk 4.0).

   * The *note open(): 5b1. method of the *note zipfile.ZipFile: 414.
     class no longer supports the ‘'U'’ mode (was deprecated since
     Python 3.4).  Use *note io.TextIOWrapper: 5e8. for reading
     compressed text files in *note universal newlines: 5e9. mode.

   * The undocumented ‘IN’, ‘CDROM’, ‘DLFCN’, ‘TYPES’, ‘CDIO’, and
     ‘STROPTS’ modules have been removed.  They had been available in
     the platform specific ‘Lib/plat-*/’ directories, but were
     chronically out of date, inconsistently available across platforms,
     and unmaintained.  The script that created these modules is still
     available in the source distribution at Tools/scripts/h2py.py(2).

   * The deprecated ‘asynchat.fifo’ class has been removed.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13248

   (2) https://github.com/python/cpython/tree/3.8/Tools/scripts/h2py.py


File: python.info,  Node: Porting to Python 3 6,  Next: Notable changes in Python 3 6 2,  Prev: Removed,  Up: What’s New In Python 3 6

1.3.11 Porting to Python 3.6
----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code.

* Menu:

* Changes in ‘python’ Command Behavior::
* Changes in the Python API: Changes in the Python API<3>.
* Changes in the C API: Changes in the C API<3>.
* CPython bytecode changes: CPython bytecode changes<3>.


File: python.info,  Node: Changes in ‘python’ Command Behavior,  Next: Changes in the Python API<3>,  Up: Porting to Python 3 6

1.3.11.1 Changes in ‘python’ Command Behavior
.............................................

   * The output of a special Python build with defined ‘COUNT_ALLOCS’,
     ‘SHOW_ALLOC_COUNT’ or ‘SHOW_TRACK_COUNT’ macros is now off by
     default.  It can be re-enabled using the ‘-X showalloccount’
     option.  It now outputs to ‘stderr’ instead of ‘stdout’.
     (Contributed by Serhiy Storchaka in bpo-23034(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23034


File: python.info,  Node: Changes in the Python API<3>,  Next: Changes in the C API<3>,  Prev: Changes in ‘python’ Command Behavior,  Up: Porting to Python 3 6

1.3.11.2 Changes in the Python API
..................................

   * *note open(): 4e5. will no longer allow combining the ‘'U'’ mode
     flag with ‘'+'’.  (Contributed by Jeff Balogh and John O’Connor in
     bpo-2091(1).)

   * *note sqlite3: f2. no longer implicitly commits an open transaction
     before DDL statements.

   * On Linux, *note os.urandom(): 4c6. now blocks until the system
     urandom entropy pool is initialized to increase the security.

   * When *note importlib.abc.Loader.exec_module(): 5d9. is defined,
     *note importlib.abc.Loader.create_module(): 549. must also be
     defined.

   * *note PyErr_SetImportError(): 5ed. now sets *note TypeError: 192.
     when its `msg' argument is not set.  Previously only ‘NULL’ was
     returned.

   * The format of the ‘co_lnotab’ attribute of code objects changed to
     support a negative line number delta.  By default, Python does not
     emit bytecode with a negative line number delta.  Functions using
     ‘frame.f_lineno’, ‘PyFrame_GetLineNumber()’ or ‘PyCode_Addr2Line()’
     are not affected.  Functions directly decoding ‘co_lnotab’ should
     be updated to use a signed 8-bit integer type for the line number
     delta, but this is only required to support applications using a
     negative line number delta.  See ‘Objects/lnotab_notes.txt’ for the
     ‘co_lnotab’ format and how to decode it, and see the PEP 511(2) for
     the rationale.

   * The functions in the *note compileall: 21. module now return
     booleans instead of ‘1’ or ‘0’ to represent success or failure,
     respectively.  Thanks to booleans being a subclass of integers,
     this should only be an issue if you were doing identity checks for
     ‘1’ or ‘0’.  See bpo-25768(3).

   * Reading the ‘port’ attribute of *note urllib.parse.urlsplit(): 5ee.
     and *note urlparse(): 5ef. results now raises *note ValueError:
     1f9. for out-of-range values, rather than returning *note None:
     157.  See bpo-20059(4).

   * The *note imp: 9a. module now raises a *note DeprecationWarning:
     276. instead of *note PendingDeprecationWarning: 277.

   * The following modules have had missing APIs added to their
     ‘__all__’ attributes to match the documented APIs: *note calendar:
     15, *note cgi: 16, *note csv: 2a, *note ElementTree: 137, *note
     enum: 7b, *note fileinput: 80, *note ftplib: 84, *note logging: aa,
     *note mailbox: ae, *note mimetypes: b2, *note optparse: c3, *note
     plistlib: cf, *note smtpd: ec, *note subprocess: f9, *note tarfile:
     101, *note threading: 109. and *note wave: 127.  This means they
     will export new symbols when ‘import *’ is used.  (Contributed by
     Joel Taddei and Jacek Kołodziej in bpo-23883(5).)

   * When performing a relative import, if ‘__package__’ does not
     compare equal to ‘__spec__.parent’ then *note ImportWarning: 5cd.
     is raised.  (Contributed by Brett Cannon in bpo-25791(6).)

   * When a relative import is performed and no parent package is known,
     then *note ImportError: 329. will be raised.  Previously, *note
     SystemError: 5f0. could be raised.  (Contributed by Brett Cannon in
     bpo-18018(7).)

   * Servers based on the *note socketserver: f0. module, including
     those defined in *note http.server: 97, *note xmlrpc.server: 140.
     and *note wsgiref.simple_server: 12f, now only catch exceptions
     derived from *note Exception: 1a8.  Therefore if a request handler
     raises an exception like *note SystemExit: 5f1. or *note
     KeyboardInterrupt: 197, *note handle_error(): 5f2. is no longer
     called, and the exception will stop a single-threaded server.
     (Contributed by Martin Panter in bpo-23430(8).)

   * *note spwd.getspnam(): 5f3. now raises a *note PermissionError:
     5f4. instead of *note KeyError: 2c5. if the user doesn’t have
     privileges.

   * The *note socket.socket.close(): 5f5. method now raises an
     exception if an error (e.g.  ‘EBADF’) was reported by the
     underlying system call.  (Contributed by Martin Panter in
     bpo-26685(9).)

   * The `decode_data' argument for the *note smtpd.SMTPChannel: 5f6.
     and *note smtpd.SMTPServer: 5f7. constructors is now ‘False’ by
     default.  This means that the argument passed to *note
     process_message(): 5f8. is now a bytes object by default, and
     ‘process_message()’ will be passed keyword arguments.  Code that
     has already been updated in accordance with the deprecation warning
     generated by 3.5 will not be affected.

   * All optional arguments of the *note dump(): 5f9, *note dumps():
     5fa, *note load(): 554. and *note loads(): 555. functions and *note
     JSONEncoder: 5fb. and *note JSONDecoder: 5fc. class constructors in
     the *note json: a4. module are now *note keyword-only: 2aa.
     (Contributed by Serhiy Storchaka in bpo-18726(10).)

   * Subclasses of *note type: 5fd. which don’t override ‘type.__new__’
     may no longer use the one-argument form to get the type of an
     object.

   * As part of PEP 487(11), the handling of keyword arguments passed to
     *note type: 5fd. (other than the metaclass hint, ‘metaclass’) is
     now consistently delegated to *note object.__init_subclass__():
     4d8.  This means that ‘type.__new__()’ and ‘type.__init__()’ both
     now accept arbitrary keyword arguments, but *note
     object.__init_subclass__(): 4d8. (which is called from
     ‘type.__new__()’) will reject them by default.  Custom metaclasses
     accepting additional keyword arguments will need to adjust their
     calls to ‘type.__new__()’ (whether direct or via *note super: 4d7.)
     accordingly.

   * In ‘distutils.command.sdist.sdist’, the ‘default_format’ attribute
     has been removed and is no longer honored.  Instead, the gzipped
     tarfile format is the default on all platforms and no
     platform-specific selection is made.  In environments where
     distributions are built on Windows and zip distributions are
     required, configure the project with a ‘setup.cfg’ file containing
     the following:

          [sdist]
          formats=zip

     This behavior has also been backported to earlier Python versions
     by Setuptools 26.0.0.

   * In the *note urllib.request: 120. module and the *note
     http.client.HTTPConnection.request(): 544. method, if no
     Content-Length header field has been specified and the request body
     is a file object, it is now sent with HTTP 1.1 chunked encoding.
     If a file object has to be sent to a HTTP 1.0 server, the
     Content-Length value now has to be specified by the caller.
     (Contributed by Demian Brecht and Rolf Krahl with tweaks from
     Martin Panter in bpo-12319(12).)

   * The *note DictReader: 1bb. now returns rows of type *note
     OrderedDict: 1b7.  (Contributed by Steve Holden in bpo-27842(13).)

   * The *note crypt.METHOD_CRYPT: 5fe. will no longer be added to
     ‘crypt.methods’ if unsupported by the platform.  (Contributed by
     Victor Stinner in bpo-25287(14).)

   * The `verbose' and `rename' arguments for *note namedtuple(): 1b5.
     are now keyword-only.  (Contributed by Raymond Hettinger in
     bpo-25628(15).)

   * On Linux, *note ctypes.util.find_library(): 5ff. now looks in
     ‘LD_LIBRARY_PATH’ for shared libraries.  (Contributed by Vinay
     Sajip in bpo-9998(16).)

   * The *note imaplib.IMAP4: 600. class now handles flags containing
     the ‘']'’ character in messages sent from the server to improve
     real-world compatibility.  (Contributed by Lita Cho in
     bpo-21815(17).)

   * The ‘mmap.write()’ function now returns the number of bytes written
     like other write methods.  (Contributed by Jakub Stasiak in
     bpo-26335(18).)

   * The *note pkgutil.iter_modules(): 601. and *note
     pkgutil.walk_packages(): 480. functions now return *note
     ModuleInfo: 602. named tuples.  (Contributed by Ramchandra Apte in
     bpo-17211(19).)

   * *note re.sub(): 470. now raises an error for invalid numerical
     group references in replacement templates even if the pattern is
     not found in the string.  The error message for invalid group
     references now includes the group index and the position of the
     reference.  (Contributed by SilentGhost, Serhiy Storchaka in
     bpo-25953(20).)

   * *note zipfile.ZipFile: 414. will now raise *note
     NotImplementedError: 603. for unrecognized compression values.
     Previously a plain *note RuntimeError: 2b8. was raised.
     Additionally, calling *note ZipFile: 414. methods on a closed
     ZipFile or calling the *note write(): 604. method on a ZipFile
     created with mode ‘'r'’ will raise a *note ValueError: 1f9.
     Previously, a *note RuntimeError: 2b8. was raised in those
     scenarios.

   * when custom metaclasses are combined with zero-argument *note
     super(): 4d7. or direct references from methods to the implicit
     ‘__class__’ closure variable, the implicit ‘__classcell__’
     namespace entry must now be passed up to ‘type.__new__’ for
     initialisation.  Failing to do so will result in a *note
     DeprecationWarning: 276. in Python 3.6 and a *note RuntimeError:
     2b8. in Python 3.8.

   * With the introduction of *note ModuleNotFoundError: 38f, import
     system consumers may start expecting import system replacements to
     raise that more specific exception when appropriate, rather than
     the less-specific *note ImportError: 329.  To provide future
     compatibility with such consumers, implementors of alternative
     import systems that completely replace *note __import__(): 605.
     will need to update their implementations to raise the new subclass
     when a module can’t be found at all.  Implementors of compliant
     plugins to the default import system shouldn’t need to make any
     changes, as the default import system will raise the new subclass
     when appropriate.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2091

   (2) https://www.python.org/dev/peps/pep-0511

   (3) https://bugs.python.org/issue25768

   (4) https://bugs.python.org/issue20059

   (5) https://bugs.python.org/issue23883

   (6) https://bugs.python.org/issue25791

   (7) https://bugs.python.org/issue18018

   (8) https://bugs.python.org/issue23430

   (9) https://bugs.python.org/issue26685

   (10) https://bugs.python.org/issue18726

   (11) https://www.python.org/dev/peps/pep-0487

   (12) https://bugs.python.org/issue12319

   (13) https://bugs.python.org/issue27842

   (14) https://bugs.python.org/issue25287

   (15) https://bugs.python.org/issue25628

   (16) https://bugs.python.org/issue9998

   (17) https://bugs.python.org/issue21815

   (18) https://bugs.python.org/issue26335

   (19) https://bugs.python.org/issue17211

   (20) https://bugs.python.org/issue25953


File: python.info,  Node: Changes in the C API<3>,  Next: CPython bytecode changes<3>,  Prev: Changes in the Python API<3>,  Up: Porting to Python 3 6

1.3.11.3 Changes in the C API
.............................

   * The *note PyMem_Malloc(): 4fa. allocator family now uses the *note
     pymalloc allocator: 5b6. rather than the system ‘malloc()’.
     Applications calling *note PyMem_Malloc(): 4fa. without holding the
     GIL can now crash.  Set the *note PYTHONMALLOC: 4f8. environment
     variable to ‘debug’ to validate the usage of memory allocators in
     your application.  See bpo-26249(1).

   * *note Py_Exit(): 607. (and the main interpreter) now override the
     exit status with 120 if flushing buffered data failed.  See
     bpo-5319(2).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26249

   (2) https://bugs.python.org/issue5319


File: python.info,  Node: CPython bytecode changes<3>,  Prev: Changes in the C API<3>,  Up: Porting to Python 3 6

1.3.11.4 CPython bytecode changes
.................................

There have been several major changes to the *note bytecode: 609. in
Python 3.6.

   * The Python interpreter now uses a 16-bit wordcode instead of
     bytecode.  (Contributed by Demur Rumed with input and reviews from
     Serhiy Storchaka and Victor Stinner in bpo-26647(1) and
     bpo-28050(2).)

   * The new *note FORMAT_VALUE: 60a. and *note BUILD_STRING: 60b.
     opcodes as part of the *note formatted string literal: 4b6.
     implementation.  (Contributed by Eric Smith in bpo-25483(3) and
     Serhiy Storchaka in bpo-27078(4).)

   * The new *note BUILD_CONST_KEY_MAP: 60c. opcode to optimize the
     creation of dictionaries with constant keys.  (Contributed by
     Serhiy Storchaka in bpo-27140(5).)

   * The function call opcodes have been heavily reworked for better
     performance and simpler implementation.  The *note MAKE_FUNCTION:
     60d, *note CALL_FUNCTION: 60e, *note CALL_FUNCTION_KW: 60f. and
     *note BUILD_MAP_UNPACK_WITH_CALL: 610. opcodes have been modified,
     the new *note CALL_FUNCTION_EX: 611. and *note
     BUILD_TUPLE_UNPACK_WITH_CALL: 612. have been added, and
     ‘CALL_FUNCTION_VAR’, ‘CALL_FUNCTION_VAR_KW’ and ‘MAKE_CLOSURE’
     opcodes have been removed.  (Contributed by Demur Rumed in
     bpo-27095(6), and Serhiy Storchaka in bpo-27213(7), bpo-28257(8).)

   * The new *note SETUP_ANNOTATIONS: 613. and ‘STORE_ANNOTATION’
     opcodes have been added to support the new *note variable
     annotation: 614. syntax.  (Contributed by Ivan Levkivskyi in
     bpo-27985(9).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26647

   (2) https://bugs.python.org/issue28050

   (3) https://bugs.python.org/issue25483

   (4) https://bugs.python.org/issue27078

   (5) https://bugs.python.org/issue27140

   (6) https://bugs.python.org/issue27095

   (7) https://bugs.python.org/issue27213

   (8) https://bugs.python.org/issue28257

   (9) https://bugs.python.org/issue27985


File: python.info,  Node: Notable changes in Python 3 6 2,  Next: Notable changes in Python 3 6 4,  Prev: Porting to Python 3 6,  Up: What’s New In Python 3 6

1.3.12 Notable changes in Python 3.6.2
--------------------------------------

* Menu:

* New make regen-all build target::
* Removal of make touch build target::


File: python.info,  Node: New make regen-all build target,  Next: Removal of make touch build target,  Up: Notable changes in Python 3 6 2

1.3.12.1 New ‘make regen-all’ build target
..........................................

To simplify cross-compilation, and to ensure that CPython can reliably
be compiled without requiring an existing version of Python to already
be available, the autotools-based build system no longer attempts to
implicitly recompile generated files based on file modification times.

Instead, a new ‘make regen-all’ command has been added to force
regeneration of these files when desired (e.g.  after an initial version
of Python has already been built based on the pregenerated versions).

More selective regeneration targets are also defined - see
Makefile.pre.in(1) for details.

(Contributed by Victor Stinner in bpo-23404(2).)

New in version 3.6.2.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Makefile.pre.in

   (2) https://bugs.python.org/issue23404


File: python.info,  Node: Removal of make touch build target,  Prev: New make regen-all build target,  Up: Notable changes in Python 3 6 2

1.3.12.2 Removal of ‘make touch’ build target
.............................................

The ‘make touch’ build target previously used to request implicit
regeneration of generated files by updating their modification times has
been removed.

It has been replaced by the new ‘make regen-all’ target.

(Contributed by Victor Stinner in bpo-23404(1).)

Changed in version 3.6.2.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23404


File: python.info,  Node: Notable changes in Python 3 6 4,  Next: Notable changes in Python 3 6 5,  Prev: Notable changes in Python 3 6 2,  Up: What’s New In Python 3 6

1.3.13 Notable changes in Python 3.6.4
--------------------------------------

The ‘PyExc_RecursionErrorInst’ singleton that was part of the public API
has been removed as its members being never cleared may cause a segfault
during finalization of the interpreter.  (Contributed by Xavier de Gaye
in bpo-22898(1) and bpo-30697(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22898

   (2) https://bugs.python.org/issue30697


File: python.info,  Node: Notable changes in Python 3 6 5,  Next: Notable changes in Python 3 6 7,  Prev: Notable changes in Python 3 6 4,  Up: What’s New In Python 3 6

1.3.14 Notable changes in Python 3.6.5
--------------------------------------

The *note locale.localeconv(): 47f. function now sets temporarily the
‘LC_CTYPE’ locale to the ‘LC_NUMERIC’ locale in some cases.
(Contributed by Victor Stinner in bpo-31900(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31900


File: python.info,  Node: Notable changes in Python 3 6 7,  Next: Notable changes in Python 3 6 10,  Prev: Notable changes in Python 3 6 5,  Up: What’s New In Python 3 6

1.3.15 Notable changes in Python 3.6.7
--------------------------------------

In 3.6.7 the *note tokenize: 111. module now implicitly emits a
‘NEWLINE’ token when provided with input that does not have a trailing
new line.  This behavior now matches what the C tokenizer does
internally.  (Contributed by Ammar Askar in bpo-33899(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33899


File: python.info,  Node: Notable changes in Python 3 6 10,  Prev: Notable changes in Python 3 6 7,  Up: What’s New In Python 3 6

1.3.16 Notable changes in Python 3.6.10
---------------------------------------

Due to significant security concerns, the `reuse_address' parameter of
*note asyncio.loop.create_datagram_endpoint(): 2e5. is no longer
supported.  This is because of the behavior of the socket option
‘SO_REUSEADDR’ in UDP. For more details, see the documentation for
‘loop.create_datagram_endpoint()’.  (Contributed by Kyle Stanley,
Antoine Pitrou, and Yury Selivanov in bpo-37228(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37228


File: python.info,  Node: What’s New In Python 3 5,  Next: What’s New In Python 3 4,  Prev: What’s New In Python 3 6,  Up: What’s New in Python

1.4 What’s New In Python 3.5
============================


Editors: Elvis Pranskevichus <<elvis@magic.io>>, Yury Selivanov
<<yury@magic.io>>

This article explains the new features in Python 3.5, compared to 3.4.
Python 3.5 was released on September 13, 2015.   See the changelog(1)
for a full list of changes.

See also
........

PEP 478(2) - Python 3.5 Release Schedule

* Menu:

* Summary – Release highlights: Summary – Release highlights<3>.
* New Features: New Features<4>.
* Other Language Changes: Other Language Changes<4>.
* New Modules: New Modules<4>.
* Improved Modules: Improved Modules<4>.
* Other module-level changes::
* Optimizations: Optimizations<4>.
* Build and C API Changes: Build and C API Changes<3>.
* Deprecated: Deprecated<3>.
* Removed: Removed<2>.
* Porting to Python 3.5: Porting to Python 3 5.
* Notable changes in Python 3.5.4: Notable changes in Python 3 5 4.

   ---------- Footnotes ----------

   (1) https://docs.python.org/3.5/whatsnew/changelog.html

   (2) https://www.python.org/dev/peps/pep-0478


File: python.info,  Node: Summary – Release highlights<3>,  Next: New Features<4>,  Up: What’s New In Python 3 5

1.4.1 Summary – Release highlights
----------------------------------

New syntax features:

   * *note PEP 492: 61f, coroutines with async and await syntax.

   * *note PEP 465: 620, a new matrix multiplication operator: ‘a @ b’.

   * *note PEP 448: 621, additional unpacking generalizations.

New library modules:

   * *note typing: 119.: *note PEP 484 – Type Hints: 622.

   * *note zipapp: 141.: *note PEP 441 Improving Python ZIP Application
     Support: 623.

New built-in features:

   * ‘bytes % args’, ‘bytearray % args’: *note PEP 461: 624. – Adding
     ‘%’ formatting to bytes and bytearray.

   * New *note bytes.hex(): 625, *note bytearray.hex(): 626. and *note
     memoryview.hex(): 627. methods.  (Contributed by Arnon Yaari in
     bpo-9951(1).)

   * *note memoryview: 25a. now supports tuple indexing (including
     multi-dimensional).  (Contributed by Antoine Pitrou in
     bpo-23632(2).)

   * Generators have a new ‘gi_yieldfrom’ attribute, which returns the
     object being iterated by ‘yield from’ expressions.  (Contributed by
     Benno Leslie and Yury Selivanov in bpo-24450(3).)

   * A new *note RecursionError: 628. exception is now raised when
     maximum recursion depth is reached.  (Contributed by Georg Brandl
     in bpo-19235(4).)

CPython implementation improvements:

   * When the ‘LC_TYPE’ locale is the POSIX locale (‘C’ locale), *note
     sys.stdin: 302. and *note sys.stdout: 303. now use the
     ‘surrogateescape’ error handler, instead of the ‘strict’ error
     handler.  (Contributed by Victor Stinner in bpo-19977(5).)

   * ‘.pyo’ files are no longer used and have been replaced by a more
     flexible scheme that includes the optimization level explicitly in
     ‘.pyc’ name.  (See *note PEP 488 overview: 629.)

   * Builtin and extension modules are now initialized in a multi-phase
     process, which is similar to how Python modules are loaded.  (See
     *note PEP 489 overview: 62a.)

Significant improvements in the standard library:

   * *note collections.OrderedDict: 1b7. is now *note implemented in C:
     62b, which makes it 4 to 100 times faster.

   * The *note ssl: f3. module gained *note support for Memory BIO: 62c,
     which decouples SSL protocol handling from network IO.

   * The new *note os.scandir(): 25d. function provides a *note better
     and significantly faster way: 62d. of directory traversal.

   * *note functools.lru_cache(): 1c5. has been mostly *note
     reimplemented in C: 62e, yielding much better performance.

   * The new *note subprocess.run(): 3e2. function provides a *note
     streamlined way to run subprocesses: 62f.

   * The *note traceback: 113. module has been significantly *note
     enhanced: 630. for improved performance and developer convenience.

Security improvements:

   * SSLv3 is now disabled throughout the standard library.  It can
     still be enabled by instantiating a *note ssl.SSLContext: 3d9.
     manually.  (See bpo-22638(6) for more details; this change was
     backported to CPython 3.4 and 2.7.)

   * HTTP cookie parsing is now stricter, in order to protect against
     potential injection attacks.  (Contributed by Antoine Pitrou in
     bpo-22796(7).)

Windows improvements:

   * A new installer for Windows has replaced the old MSI. See *note
     Using Python on Windows: 2d7. for more information.

   * Windows builds now use Microsoft Visual C++ 14.0, and extension
     modules should use the same.

Please read on for a comprehensive list of user-facing changes,
including many other smaller improvements, CPython optimizations,
deprecations, and potential porting issues.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9951

   (2) https://bugs.python.org/issue23632

   (3) https://bugs.python.org/issue24450

   (4) https://bugs.python.org/issue19235

   (5) https://bugs.python.org/issue19977

   (6) https://bugs.python.org/issue22638

   (7) https://bugs.python.org/issue22796


File: python.info,  Node: New Features<4>,  Next: Other Language Changes<4>,  Prev: Summary – Release highlights<3>,  Up: What’s New In Python 3 5

1.4.2 New Features
------------------

* Menu:

* PEP 492 - Coroutines with async and await syntax::
* PEP 465 - A dedicated infix operator for matrix multiplication::
* PEP 448 - Additional Unpacking Generalizations::
* PEP 461 - percent formatting support for bytes and bytearray::
* PEP 484 - Type Hints::
* PEP 471 - os.scandir() function – a better and faster directory iterator: PEP 471 - os scandir function – a better and faster directory iterator.
* PEP 475; Retry system calls failing with EINTR: PEP 475 Retry system calls failing with EINTR.
* PEP 479; Change StopIteration handling inside generators: PEP 479 Change StopIteration handling inside generators.
* PEP 485; A function for testing approximate equality: PEP 485 A function for testing approximate equality.
* PEP 486; Make the Python Launcher aware of virtual environments: PEP 486 Make the Python Launcher aware of virtual environments.
* PEP 488; Elimination of PYO files: PEP 488 Elimination of PYO files.
* PEP 489; Multi-phase extension module initialization: PEP 489 Multi-phase extension module initialization.


File: python.info,  Node: PEP 492 - Coroutines with async and await syntax,  Next: PEP 465 - A dedicated infix operator for matrix multiplication,  Up: New Features<4>

1.4.2.1 PEP 492 - Coroutines with async and await syntax
........................................................

PEP 492(1) greatly improves support for asynchronous programming in
Python by adding *note awaitable objects: 50e, *note coroutine
functions: 633, *note asynchronous iteration: 634, and *note
asynchronous context managers: 635.

Coroutine functions are declared using the new *note async def: 282.
syntax:

     >>> async def coro():
     ...     return 'spam'

Inside a coroutine function, the new *note await: 1a2. expression can be
used to suspend coroutine execution until the result is available.  Any
object can be `awaited', as long as it implements the *note awaitable:
50e. protocol by defining the *note __await__(): 636. method.

PEP 492 also adds *note async for: 2e1. statement for convenient
iteration over asynchronous iterables.

An example of a rudimentary HTTP client written using the new syntax:

     import asyncio

     async def http_get(domain):
         reader, writer = await asyncio.open_connection(domain, 80)

         writer.write(b'\r\n'.join([
             b'GET / HTTP/1.1',
             b'Host: %b' % domain.encode('latin-1'),
             b'Connection: close',
             b'', b''
         ]))

         async for line in reader:
             print('>>>', line)

         writer.close()

     loop = asyncio.get_event_loop()
     try:
         loop.run_until_complete(http_get('example.com'))
     finally:
         loop.close()

Similarly to asynchronous iteration, there is a new syntax for
asynchronous context managers.  The following script:

     import asyncio

     async def coro(name, lock):
         print('coro {}: waiting for lock'.format(name))
         async with lock:
             print('coro {}: holding the lock'.format(name))
             await asyncio.sleep(1)
             print('coro {}: releasing the lock'.format(name))

     loop = asyncio.get_event_loop()
     lock = asyncio.Lock()
     coros = asyncio.gather(coro(1, lock), coro(2, lock))
     try:
         loop.run_until_complete(coros)
     finally:
         loop.close()

will output:

     coro 2: waiting for lock
     coro 2: holding the lock
     coro 1: waiting for lock
     coro 2: releasing the lock
     coro 1: holding the lock
     coro 1: releasing the lock

Note that both *note async for: 2e1. and *note async with: 637. can only
be used inside a coroutine function declared with *note async def: 282.

Coroutine functions are intended to be run inside a compatible event
loop, such as the *note asyncio loop: 638.

     Note: 
     Changed in version 3.5.2: Starting with CPython 3.5.2, ‘__aiter__’
     can directly return *note asynchronous iterators: 639.  Returning
     an *note awaitable: 50e. object will result in a *note
     PendingDeprecationWarning: 277.

     See more details in the *note Asynchronous Iterators: 63a.
     documentation section.

See also
........

PEP 492(2) – Coroutines with async and await syntax

     PEP written and implemented by Yury Selivanov.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0492

   (2) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: PEP 465 - A dedicated infix operator for matrix multiplication,  Next: PEP 448 - Additional Unpacking Generalizations,  Prev: PEP 492 - Coroutines with async and await syntax,  Up: New Features<4>

1.4.2.2 PEP 465 - A dedicated infix operator for matrix multiplication
......................................................................

PEP 465(1) adds the ‘@’ infix operator for matrix multiplication.
Currently, no builtin Python types implement the new operator, however,
it can be implemented by defining *note __matmul__(): 63c, *note
__rmatmul__(): 63d, and *note __imatmul__(): 63e. for regular,
reflected, and in-place matrix multiplication.  The semantics of these
methods is similar to that of methods defining other infix arithmetic
operators.

Matrix multiplication is a notably common operation in many fields of
mathematics, science, engineering, and the addition of ‘@’ allows
writing cleaner code:

     S = (H @ beta - r).T @ inv(H @ V @ H.T) @ (H @ beta - r)

instead of:

     S = dot((dot(H, beta) - r).T,
             dot(inv(dot(dot(H, V), H.T)), dot(H, beta) - r))

NumPy 1.10 has support for the new operator:

     >>> import numpy

     >>> x = numpy.ones(3)
     >>> x
     array([ 1., 1., 1.])

     >>> m = numpy.eye(3)
     >>> m
     array([[ 1., 0., 0.],
            [ 0., 1., 0.],
            [ 0., 0., 1.]])

     >>> x @ m
     array([ 1., 1., 1.])

See also
........

PEP 465(2) – A dedicated infix operator for matrix multiplication

     PEP written by Nathaniel J. Smith; implemented by Benjamin
     Peterson.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0465

   (2) https://www.python.org/dev/peps/pep-0465


File: python.info,  Node: PEP 448 - Additional Unpacking Generalizations,  Next: PEP 461 - percent formatting support for bytes and bytearray,  Prev: PEP 465 - A dedicated infix operator for matrix multiplication,  Up: New Features<4>

1.4.2.3 PEP 448 - Additional Unpacking Generalizations
......................................................

PEP 448(1) extends the allowed uses of the ‘*’ iterable unpacking
operator and ‘**’ dictionary unpacking operator.  It is now possible to
use an arbitrary number of unpackings in *note function calls: 640.:

     >>> print(*[1], *[2], 3, *[4, 5])
     1 2 3 4 5

     >>> def fn(a, b, c, d):
     ...     print(a, b, c, d)
     ...

     >>> fn(**{'a': 1, 'c': 3}, **{'b': 2, 'd': 4})
     1 2 3 4

Similarly, tuple, list, set, and dictionary displays allow multiple
unpackings (see *note Expression lists: 641. and *note Dictionary
displays: 642.):

     >>> *range(4), 4
     (0, 1, 2, 3, 4)

     >>> [*range(4), 4]
     [0, 1, 2, 3, 4]

     >>> {*range(4), 4, *(5, 6, 7)}
     {0, 1, 2, 3, 4, 5, 6, 7}

     >>> {'x': 1, **{'y': 2}}
     {'x': 1, 'y': 2}

See also
........

PEP 448(2) – Additional Unpacking Generalizations

     PEP written by Joshua Landau; implemented by Neil Girdhar, Thomas
     Wouters, and Joshua Landau.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0448

   (2) https://www.python.org/dev/peps/pep-0448


File: python.info,  Node: PEP 461 - percent formatting support for bytes and bytearray,  Next: PEP 484 - Type Hints,  Prev: PEP 448 - Additional Unpacking Generalizations,  Up: New Features<4>

1.4.2.4 PEP 461 - percent formatting support for bytes and bytearray
....................................................................

PEP 461(1) adds support for the ‘%’ *note interpolation operator: 644.
to *note bytes: 326. and *note bytearray: 327.

While interpolation is usually thought of as a string operation, there
are cases where interpolation on ‘bytes’ or ‘bytearrays’ makes sense,
and the work needed to make up for this missing functionality detracts
from the overall readability of the code.  This issue is particularly
important when dealing with wire format protocols, which are often a
mixture of binary and ASCII compatible text.

Examples:

     >>> b'Hello %b!' % b'World'
     b'Hello World!'

     >>> b'x=%i y=%f' % (1, 2.5)
     b'x=1 y=2.500000'

Unicode is not allowed for ‘%b’, but it is accepted by ‘%a’ (equivalent
of ‘repr(obj).encode('ascii', 'backslashreplace')’):

     >>> b'Hello %b!' % 'World'
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: %b requires bytes, or an object that implements __bytes__, not 'str'

     >>> b'price: %a' % '10€'
     b"price: '10\\u20ac'"

Note that ‘%s’ and ‘%r’ conversion types, although supported, should
only be used in codebases that need compatibility with Python 2.

See also
........

PEP 461(2) – Adding % formatting to bytes and bytearray

     PEP written by Ethan Furman; implemented by Neil Schemenauer and
     Ethan Furman.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0461

   (2) https://www.python.org/dev/peps/pep-0461


File: python.info,  Node: PEP 484 - Type Hints,  Next: PEP 471 - os scandir function – a better and faster directory iterator,  Prev: PEP 461 - percent formatting support for bytes and bytearray,  Up: New Features<4>

1.4.2.5 PEP 484 - Type Hints
............................

Function annotation syntax has been a Python feature since version 3.0 (
PEP 3107(1)), however the semantics of annotations has been left
undefined.

Experience has shown that the majority of function annotation uses were
to provide type hints to function parameters and return values.  It
became evident that it would be beneficial for Python users, if the
standard library included the base definitions and tools for type
annotations.

PEP 484(2) introduces a *note provisional module: 33d. to provide these
standard definitions and tools, along with some conventions for
situations where annotations are not available.

For example, here is a simple function whose argument and return type
are declared in the annotations:

     def greeting(name: str) -> str:
         return 'Hello ' + name

While these annotations are available at runtime through the usual
‘__annotations__’ attribute, `no automatic type checking happens at
runtime'.  Instead, it is assumed that a separate off-line type checker
(e.g.  mypy(3)) will be used for on-demand source code analysis.

The type system supports unions, generic types, and a special type named
*note Any: 646. which is consistent with (i.e.  assignable to and from)
all types.

See also
........

   * *note typing: 119. module documentation

   * 
     PEP 484(4) – Type Hints

          PEP written by Guido van Rossum, Jukka Lehtosalo, and Łukasz
          Langa; implemented by Guido van Rossum.

   * 
     PEP 483(5) – The Theory of Type Hints

          PEP written by Guido van Rossum

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3107

   (2) https://www.python.org/dev/peps/pep-0484

   (3) http://mypy-lang.org

   (4) https://www.python.org/dev/peps/pep-0484

   (5) https://www.python.org/dev/peps/pep-0483


File: python.info,  Node: PEP 471 - os scandir function – a better and faster directory iterator,  Next: PEP 475 Retry system calls failing with EINTR,  Prev: PEP 484 - Type Hints,  Up: New Features<4>

1.4.2.6 PEP 471 - os.scandir() function – a better and faster directory iterator
................................................................................

PEP 471(1) adds a new directory iteration function, *note os.scandir():
25d, to the standard library.  Additionally, *note os.walk(): 648. is
now implemented using ‘scandir’, which makes it 3 to 5 times faster on
POSIX systems and 7 to 20 times faster on Windows systems.  This is
largely achieved by greatly reducing the number of calls to *note
os.stat(): 1ef. required to walk a directory tree.

Additionally, ‘scandir’ returns an iterator, as opposed to returning a
list of file names, which improves memory efficiency when iterating over
very large directories.

The following example shows a simple use of *note os.scandir(): 25d. to
display all the files (excluding directories) in the given `path' that
don’t start with ‘'.'’.  The *note entry.is_file(): 649. call will
generally not make an additional system call:

     for entry in os.scandir(path):
         if not entry.name.startswith('.') and entry.is_file():
             print(entry.name)

See also
........

PEP 471(2) – os.scandir() function – a better and faster directory iterator

     PEP written and implemented by Ben Hoyt with the help of Victor
     Stinner.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0471

   (2) https://www.python.org/dev/peps/pep-0471


File: python.info,  Node: PEP 475 Retry system calls failing with EINTR,  Next: PEP 479 Change StopIteration handling inside generators,  Prev: PEP 471 - os scandir function – a better and faster directory iterator,  Up: New Features<4>

1.4.2.7 PEP 475: Retry system calls failing with EINTR
......................................................

An *note errno.EINTR: 64c. error code is returned whenever a system
call, that is waiting for I/O, is interrupted by a signal.  Previously,
Python would raise *note InterruptedError: 64d. in such cases.  This
meant that, when writing a Python application, the developer had two
choices:

  1. Ignore the ‘InterruptedError’.

  2. Handle the ‘InterruptedError’ and attempt to restart the
     interrupted system call at every call site.

The first option makes an application fail intermittently.  The second
option adds a large amount of boilerplate that makes the code nearly
unreadable.  Compare:

     print("Hello World")

and:

     while True:
         try:
             print("Hello World")
             break
         except InterruptedError:
             continue

PEP 475(1) implements automatic retry of system calls on ‘EINTR’.  This
removes the burden of dealing with ‘EINTR’ or *note InterruptedError:
64d. in user code in most situations and makes Python programs,
including the standard library, more robust.  Note that the system call
is only retried if the signal handler does not raise an exception.

Below is a list of functions which are now retried when interrupted by a
signal:

   * *note open(): 4e5. and *note io.open(): 64e.;

   * functions of the *note faulthandler: 7d. module;

   * *note os: c4. functions: *note fchdir(): 64f, *note fchmod(): 650,
     *note fchown(): 651, *note fdatasync(): 652, *note fstat(): 653,
     *note fstatvfs(): 654, *note fsync(): 655, *note ftruncate(): 656,
     *note mkfifo(): 657, *note mknod(): 658, *note open(): 659, *note
     posix_fadvise(): 65a, *note posix_fallocate(): 65b, *note pread():
     3ae, *note pwrite(): 3b1, *note read(): 65c, *note readv(): 3ad,
     *note sendfile(): 34e, *note wait3(): 65d, *note wait4(): 65e,
     *note wait(): 65f, *note waitid(): 660, *note waitpid(): 661, *note
     write(): 662, *note writev(): 3b0.;

   * special cases: *note os.close(): 3c7. and *note os.dup2(): 3b3. now
     ignore *note EINTR: 64c. errors; the syscall is not retried (see
     the PEP for the rationale);

   * *note select: e5. functions: *note devpoll.poll(): 663, *note
     epoll.poll(): 664, *note kqueue.control(): 665, *note poll.poll():
     666, *note select(): 667.;

   * methods of the *note socket: 668. class: *note accept(): 669, *note
     connect(): 66a. (except for non-blocking sockets), *note recv():
     66b, *note recvfrom(): 66c, *note recvmsg(): 66d, *note send():
     66e, *note sendall(): 66f, *note sendmsg(): 670, *note sendto():
     671.;

   * *note signal.sigtimedwait(): 672. and *note signal.sigwaitinfo():
     673.;

   * *note time.sleep(): 674.

See also
........

PEP 475(2) – Retry system calls failing with EINTR

     PEP and implementation written by Charles-François Natali and
     Victor Stinner, with the help of Antoine Pitrou (the French
     connection).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475

   (2) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: PEP 479 Change StopIteration handling inside generators,  Next: PEP 485 A function for testing approximate equality,  Prev: PEP 475 Retry system calls failing with EINTR,  Up: New Features<4>

1.4.2.8 PEP 479: Change StopIteration handling inside generators
................................................................

The interaction of generators and *note StopIteration: 47b. in Python
3.4 and earlier was sometimes surprising, and could conceal obscure
bugs.  Previously, ‘StopIteration’ raised accidentally inside a
generator function was interpreted as the end of the iteration by the
loop construct driving the generator.

PEP 479(1) changes the behavior of generators: when a ‘StopIteration’
exception is raised inside a generator, it is replaced with a *note
RuntimeError: 2b8. before it exits the generator frame.  The main goal
of this change is to ease debugging in the situation where an unguarded
*note next(): 676. call raises ‘StopIteration’ and causes the iteration
controlled by the generator to terminate silently.  This is particularly
pernicious in combination with the ‘yield from’ construct.

This is a backwards incompatible change, so to enable the new behavior,
a *note __future__: 677. import is necessary:

     >>> from __future__ import generator_stop

     >>> def gen():
     ...     next(iter([]))
     ...     yield
     ...
     >>> next(gen())
     Traceback (most recent call last):
       File "<stdin>", line 2, in gen
     StopIteration

     The above exception was the direct cause of the following exception:

     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     RuntimeError: generator raised StopIteration

Without a ‘__future__’ import, a *note PendingDeprecationWarning: 277.
will be raised whenever a *note StopIteration: 47b. exception is raised
inside a generator.

See also
........

PEP 479(2) – Change StopIteration handling inside generators

     PEP written by Chris Angelico and Guido van Rossum.  Implemented by
     Chris Angelico, Yury Selivanov and Nick Coghlan.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0479

   (2) https://www.python.org/dev/peps/pep-0479


File: python.info,  Node: PEP 485 A function for testing approximate equality,  Next: PEP 486 Make the Python Launcher aware of virtual environments,  Prev: PEP 479 Change StopIteration handling inside generators,  Up: New Features<4>

1.4.2.9 PEP 485: A function for testing approximate equality
............................................................

PEP 485(1) adds the *note math.isclose(): 67a. and *note
cmath.isclose(): 67b. functions which tell whether two values are
approximately equal or “close” to each other.  Whether or not two values
are considered close is determined according to given absolute and
relative tolerances.  Relative tolerance is the maximum allowed
difference between ‘isclose’ arguments, relative to the larger absolute
value:

     >>> import math
     >>> a = 5.0
     >>> b = 4.99998
     >>> math.isclose(a, b, rel_tol=1e-5)
     True
     >>> math.isclose(a, b, rel_tol=1e-6)
     False

It is also possible to compare two values using absolute tolerance,
which must be a non-negative value:

     >>> import math
     >>> a = 5.0
     >>> b = 4.99998
     >>> math.isclose(a, b, abs_tol=0.00003)
     True
     >>> math.isclose(a, b, abs_tol=0.00001)
     False

See also
........

PEP 485(2) – A function for testing approximate equality

     PEP written by Christopher Barker; implemented by Chris Barker and
     Tal Einat.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0485

   (2) https://www.python.org/dev/peps/pep-0485


File: python.info,  Node: PEP 486 Make the Python Launcher aware of virtual environments,  Next: PEP 488 Elimination of PYO files,  Prev: PEP 485 A function for testing approximate equality,  Up: New Features<4>

1.4.2.10 PEP 486: Make the Python Launcher aware of virtual environments
........................................................................

PEP 486(1) makes the Windows launcher (see PEP 397(2)) aware of an
active virtual environment.  When the default interpreter would be used
and the ‘VIRTUAL_ENV’ environment variable is set, the interpreter in
the virtual environment will be used.

See also
........

PEP 486(3) – Make the Python Launcher aware of virtual environments

     PEP written and implemented by Paul Moore.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0486

   (2) https://www.python.org/dev/peps/pep-0397

   (3) https://www.python.org/dev/peps/pep-0486


File: python.info,  Node: PEP 488 Elimination of PYO files,  Next: PEP 489 Multi-phase extension module initialization,  Prev: PEP 486 Make the Python Launcher aware of virtual environments,  Up: New Features<4>

1.4.2.11 PEP 488: Elimination of PYO files
..........................................

PEP 488(1) does away with the concept of ‘.pyo’ files.  This means that
‘.pyc’ files represent both unoptimized and optimized bytecode.  To
prevent the need to constantly regenerate bytecode files, ‘.pyc’ files
now have an optional ‘opt-’ tag in their name when the bytecode is
optimized.  This has the side-effect of no more bytecode file name
clashes when running under either *note -O: 67f. or *note -OO: 680.
Consequently, bytecode files generated from *note -O: 67f, and *note
-OO: 680. may now exist simultaneously.  *note
importlib.util.cache_from_source(): 54c. has an updated API to help with
this change.

See also
........

PEP 488(2) – Elimination of PYO files

     PEP written and implemented by Brett Cannon.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0488

   (2) https://www.python.org/dev/peps/pep-0488


File: python.info,  Node: PEP 489 Multi-phase extension module initialization,  Prev: PEP 488 Elimination of PYO files,  Up: New Features<4>

1.4.2.12 PEP 489: Multi-phase extension module initialization
.............................................................

PEP 489(1) updates extension module initialization to take advantage of
the two step module loading mechanism introduced by PEP 451(2) in Python
3.4.

This change brings the import semantics of extension modules that opt-in
to using the new mechanism much closer to those of Python source and
bytecode modules, including the ability to use any valid identifier as a
module name, rather than being restricted to ASCII.

See also
........

PEP 489(3) – Multi-phase extension module initialization

     PEP written by Petr Viktorin, Stefan Behnel, and Nick Coghlan;
     implemented by Petr Viktorin.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0489

   (2) https://www.python.org/dev/peps/pep-0451

   (3) https://www.python.org/dev/peps/pep-0489


File: python.info,  Node: Other Language Changes<4>,  Next: New Modules<4>,  Prev: New Features<4>,  Up: What’s New In Python 3 5

1.4.3 Other Language Changes
----------------------------

Some smaller changes made to the core Python language are:

   * Added the ‘"namereplace"’ error handlers.  The ‘"backslashreplace"’
     error handlers now work with decoding and translating.
     (Contributed by Serhiy Storchaka in bpo-19676(1) and bpo-22286(2).)

   * The *note -b: 40a. option now affects comparisons of *note bytes:
     326. with *note int: 184.  (Contributed by Serhiy Storchaka in
     bpo-23681(3).)

   * New Kazakh ‘kz1048’ and Tajik ‘koi8_t’ *note codecs: 683.
     (Contributed by Serhiy Storchaka in bpo-22682(4) and bpo-22681(5).)

   * Property docstrings are now writable.  This is especially useful
     for *note collections.namedtuple(): 1b5. docstrings.  (Contributed
     by Berker Peksag in bpo-24064(6).)

   * Circular imports involving relative imports are now supported.
     (Contributed by Brett Cannon and Antoine Pitrou in bpo-17636(7).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19676

   (2) https://bugs.python.org/issue22286

   (3) https://bugs.python.org/issue23681

   (4) https://bugs.python.org/issue22682

   (5) https://bugs.python.org/issue22681

   (6) https://bugs.python.org/issue24064

   (7) https://bugs.python.org/issue17636


File: python.info,  Node: New Modules<4>,  Next: Improved Modules<4>,  Prev: Other Language Changes<4>,  Up: What’s New In Python 3 5

1.4.4 New Modules
-----------------

* Menu:

* typing: typing<3>.
* zipapp: zipapp<2>.


File: python.info,  Node: typing<3>,  Next: zipapp<2>,  Up: New Modules<4>

1.4.4.1 typing
..............

The new *note typing: 119. *note provisional: 33d. module provides
standard definitions and tools for function type annotations.  See *note
Type Hints: 622. for more information.


File: python.info,  Node: zipapp<2>,  Prev: typing<3>,  Up: New Modules<4>

1.4.4.2 zipapp
..............

The new *note zipapp: 141. module (specified in PEP 441(1)) provides an
API and command line tool for creating executable Python Zip
Applications, which were introduced in Python 2.6 in bpo-1739468(2), but
which were not well publicized, either at the time or since.

With the new module, bundling your application is as simple as putting
all the files, including a ‘__main__.py’ file, into a directory ‘myapp’
and running:

     $ python -m zipapp myapp
     $ python myapp.pyz

The module implementation has been contributed by Paul Moore in
bpo-23491(3).

See also
........

PEP 441(4) – Improving Python ZIP Application Support

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0441

   (2) https://bugs.python.org/issue1739468

   (3) https://bugs.python.org/issue23491

   (4) https://www.python.org/dev/peps/pep-0441


File: python.info,  Node: Improved Modules<4>,  Next: Other module-level changes,  Prev: New Modules<4>,  Up: What’s New In Python 3 5

1.4.5 Improved Modules
----------------------

* Menu:

* argparse: argparse<2>.
* asyncio: asyncio<5>.
* bz2::
* cgi::
* cmath: cmath<2>.
* code::
* collections: collections<5>.
* collections.abc: collections abc.
* compileall: compileall<2>.
* concurrent.futures: concurrent futures<3>.
* configparser::
* contextlib: contextlib<3>.
* csv: csv<2>.
* curses: curses<2>.
* dbm: dbm<4>.
* difflib::
* distutils: distutils<4>.
* doctest::
* email: email<2>.
* enum: enum<4>.
* faulthandler: faulthandler<2>.
* functools: functools<3>.
* glob::
* gzip: gzip<2>.
* heapq::
* http::
* http.client: http client<3>.
* idlelib and IDLE: idlelib and IDLE<3>.
* imaplib::
* imghdr::
* importlib: importlib<5>.
* inspect: inspect<3>.
* io: io<3>.
* ipaddress: ipaddress<2>.
* json: json<2>.
* linecache::
* locale: locale<3>.
* logging: logging<4>.
* lzma::
* math: math<4>.
* multiprocessing: multiprocessing<4>.
* operator::
* os: os<5>.
* pathlib: pathlib<4>.
* pickle: pickle<3>.
* poplib::
* re: re<4>.
* readline: readline<2>.
* selectors::
* shutil: shutil<2>.
* signal: signal<2>.
* smtpd::
* smtplib::
* sndhdr::
* socket: socket<5>.
* ssl: ssl<6>.
* sqlite3: sqlite3<3>.
* subprocess: subprocess<3>.
* sys: sys<5>.
* sysconfig::
* tarfile: tarfile<2>.
* threading: threading<3>.
* time: time<4>.
* timeit: timeit<2>.
* tkinter: tkinter<5>.
* traceback: traceback<2>.
* types: types<2>.
* unicodedata: unicodedata<4>.
* unittest: unittest<3>.
* unittest.mock: unittest mock<3>.
* urllib::
* wsgiref::
* xmlrpc: xmlrpc<2>.
* xml.sax: xml sax.
* zipfile: zipfile<3>.


File: python.info,  Node: argparse<2>,  Next: asyncio<5>,  Up: Improved Modules<4>

1.4.5.1 argparse
................

The *note ArgumentParser: 689. class now allows disabling *note
abbreviated usage: 68a. of long options by setting *note allow_abbrev:
68b. to ‘False’.  (Contributed by Jonathan Paugh, Steven Bethard, paul
j3 and Daniel Eriksson in bpo-14910(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14910


File: python.info,  Node: asyncio<5>,  Next: bz2,  Prev: argparse<2>,  Up: Improved Modules<4>

1.4.5.2 asyncio
...............

Since the *note asyncio: a. module is *note provisional: 33d, all
changes introduced in Python 3.5 have also been backported to Python
3.4.x.

Notable changes in the *note asyncio: a. module since Python 3.4.0:

   * New debugging APIs: *note loop.set_debug(): 68d. and *note
     loop.get_debug(): 68e. methods.  (Contributed by Victor Stinner.)

   * The proactor event loop now supports SSL. (Contributed by Antoine
     Pitrou and Victor Stinner in bpo-22560(1).)

   * A new *note loop.is_closed(): 68f. method to check if the event
     loop is closed.  (Contributed by Victor Stinner in bpo-21326(2).)

   * A new *note loop.create_task(): 1ad. to conveniently create and
     schedule a new *note Task: 1ab. for a coroutine.  The ‘create_task’
     method is also used by all asyncio functions that wrap coroutines
     into tasks, such as *note asyncio.wait(): 287, *note
     asyncio.gather(): 284, etc.  (Contributed by Victor Stinner.)

   * A new *note transport.get_write_buffer_limits(): 690. method to
     inquire for `high-' and `low-' water limits of the flow control.
     (Contributed by Victor Stinner.)

   * The ‘async()’ function is deprecated in favor of *note
     ensure_future(): 50c.  (Contributed by Yury Selivanov.)

   * New *note loop.set_task_factory(): 691. and *note
     loop.get_task_factory(): 692. methods to customize the task factory
     that *note loop.create_task(): 1ad. method uses.  (Contributed by
     Yury Selivanov.)

   * New *note Queue.join(): 693. and *note Queue.task_done(): 694.
     queue methods.  (Contributed by Victor Stinner.)

   * The ‘JoinableQueue’ class was removed, in favor of the *note
     asyncio.Queue: 28e. class.  (Contributed by Victor Stinner.)

Updates in 3.5.1:

   * The *note ensure_future(): 50c. function and all functions that use
     it, such as *note loop.run_until_complete(): 50d, now accept all
     kinds of *note awaitable objects: 50e.  (Contributed by Yury
     Selivanov.)

   * New *note run_coroutine_threadsafe(): 50f. function to submit
     coroutines to event loops from other threads.  (Contributed by
     Vincent Michel.)

   * New *note Transport.is_closing(): 510. method to check if the
     transport is closing or closed.  (Contributed by Yury Selivanov.)

   * The *note loop.create_server(): 352. method can now accept a list
     of hosts.  (Contributed by Yann Sionneau.)

Updates in 3.5.2:

   * New *note loop.create_future(): 511. method to create Future
     objects.  This allows alternative event loop implementations, such
     as uvloop(3), to provide a faster *note asyncio.Future: 438.
     implementation.  (Contributed by Yury Selivanov.)

   * New *note loop.get_exception_handler(): 512. method to get the
     current exception handler.  (Contributed by Yury Selivanov.)

   * New *note StreamReader.readuntil(): 513. method to read data from
     the stream until a separator bytes sequence appears.  (Contributed
     by Mark Korenberg.)

   * The *note loop.create_connection(): 1b0. and *note
     loop.create_server(): 352. methods are optimized to avoid calling
     the system ‘getaddrinfo’ function if the address is already
     resolved.  (Contributed by A. Jesse Jiryu Davis.)

   * The *note loop.sock_connect(sock, address): 695. no longer requires
     the `address' to be resolved prior to the call.  (Contributed by A.
     Jesse Jiryu Davis.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22560

   (2) https://bugs.python.org/issue21326

   (3) https://github.com/MagicStack/uvloop


File: python.info,  Node: bz2,  Next: cgi,  Prev: asyncio<5>,  Up: Improved Modules<4>

1.4.5.3 bz2
...........

The *note BZ2Decompressor.decompress: 697. method now accepts an
optional `max_length' argument to limit the maximum size of decompressed
data.  (Contributed by Nikolaus Rath in bpo-15955(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15955


File: python.info,  Node: cgi,  Next: cmath<2>,  Prev: bz2,  Up: Improved Modules<4>

1.4.5.4 cgi
...........

The ‘FieldStorage’ class now supports the *note context manager: 55d.
protocol.  (Contributed by Berker Peksag in bpo-20289(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20289


File: python.info,  Node: cmath<2>,  Next: code,  Prev: cgi,  Up: Improved Modules<4>

1.4.5.5 cmath
.............

A new function *note isclose(): 67b. provides a way to test for
approximate equality.  (Contributed by Chris Barker and Tal Einat in
bpo-24270(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24270


File: python.info,  Node: code,  Next: collections<5>,  Prev: cmath<2>,  Up: Improved Modules<4>

1.4.5.6 code
............

The *note InteractiveInterpreter.showtraceback(): 69b. method now prints
the full chained traceback, just like the interactive interpreter.
(Contributed by Claudiu Popa in bpo-17442(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17442


File: python.info,  Node: collections<5>,  Next: collections abc,  Prev: code,  Up: Improved Modules<4>

1.4.5.7 collections
...................

The *note OrderedDict: 1b7. class is now implemented in C, which makes
it 4 to 100 times faster.  (Contributed by Eric Snow in bpo-16991(1).)

‘OrderedDict.items()’, ‘OrderedDict.keys()’, ‘OrderedDict.values()’
views now support *note reversed(): 18e. iteration.  (Contributed by
Serhiy Storchaka in bpo-19505(2).)

The *note deque: 526. class now defines *note index(): 69d, *note
insert(): 69e, and *note copy(): 69f, and supports the ‘+’ and ‘*’
operators.  This allows deques to be recognized as a *note
MutableSequence: 6a0. and improves their substitutability for lists.
(Contributed by Raymond Hettinger in bpo-23704(3).)

Docstrings produced by *note namedtuple(): 1b5. can now be updated:

     Point = namedtuple('Point', ['x', 'y'])
     Point.__doc__ += ': Cartesian coodinate'
     Point.x.__doc__ = 'abscissa'
     Point.y.__doc__ = 'ordinate'

(Contributed by Berker Peksag in bpo-24064(4).)

The *note UserString: 6a1. class now implements the *note
__getnewargs__(): 6a2, *note __rmod__(): 6a3, *note casefold(): 6a4,
*note format_map(): 6a5, *note isprintable(): 6a6, and *note
maketrans(): 6a7. methods to match the corresponding methods of *note
str: 325.  (Contributed by Joe Jevnik in bpo-22189(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16991

   (2) https://bugs.python.org/issue19505

   (3) https://bugs.python.org/issue23704

   (4) https://bugs.python.org/issue24064

   (5) https://bugs.python.org/issue22189


File: python.info,  Node: collections abc,  Next: compileall<2>,  Prev: collections<5>,  Up: Improved Modules<4>

1.4.5.8 collections.abc
.......................

The ‘Sequence.index()’ method now accepts `start' and `stop' arguments
to match the corresponding methods of *note tuple: 473, *note list: 260,
etc.  (Contributed by Devin Jeanpierre in bpo-23086(1).)

A new *note Generator: 6a9. abstract base class.  (Contributed by Stefan
Behnel in bpo-24018(2).)

New *note Awaitable: 6aa, *note Coroutine: 6ab, *note AsyncIterator:
6ac, and *note AsyncIterable: 6ad. abstract base classes.  (Contributed
by Yury Selivanov in bpo-24184(3).)

For earlier Python versions, a backport of the new ABCs is available in
an external PyPI package(4).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23086

   (2) https://bugs.python.org/issue24018

   (3) https://bugs.python.org/issue24184

   (4) https://pypi.org/project/backports_abc


File: python.info,  Node: compileall<2>,  Next: concurrent futures<3>,  Prev: collections abc,  Up: Improved Modules<4>

1.4.5.9 compileall
..................

A new *note compileall: 21. option, ‘-j `N'’, allows running `N' workers
simultaneously to perform parallel bytecode compilation.  The *note
compile_dir(): 367. function has a corresponding ‘workers’ parameter.
(Contributed by Claudiu Popa in bpo-16104(1).)

Another new option, ‘-r’, allows controlling the maximum recursion level
for subdirectories.  (Contributed by Claudiu Popa in bpo-19628(2).)

The ‘-q’ command line option can now be specified more than once, in
which case all output, including errors, will be suppressed.  The
corresponding ‘quiet’ parameter in *note compile_dir(): 367, *note
compile_file(): 6af, and *note compile_path(): 6b0. can now accept an
integer value indicating the level of output suppression.  (Contributed
by Thomas Kluyver in bpo-21338(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16104

   (2) https://bugs.python.org/issue19628

   (3) https://bugs.python.org/issue21338


File: python.info,  Node: concurrent futures<3>,  Next: configparser,  Prev: compileall<2>,  Up: Improved Modules<4>

1.4.5.10 concurrent.futures
...........................

The *note Executor.map(): 6b2. method now accepts a `chunksize' argument
to allow batching of tasks to improve performance when *note
ProcessPoolExecutor(): 2a2. is used.  (Contributed by Dan O’Reilly in
bpo-11271(1).)

The number of workers in the *note ThreadPoolExecutor: 278. constructor
is optional now.  The default value is 5 times the number of CPUs.
(Contributed by Claudiu Popa in bpo-21527(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11271

   (2) https://bugs.python.org/issue21527


File: python.info,  Node: configparser,  Next: contextlib<3>,  Prev: concurrent futures<3>,  Up: Improved Modules<4>

1.4.5.11 configparser
.....................

*note configparser: 23. now provides a way to customize the conversion
of values by specifying a dictionary of converters in the *note
ConfigParser: 4a0. constructor, or by defining them as methods in
‘ConfigParser’ subclasses.  Converters defined in a parser instance are
inherited by its section proxies.

Example:

     >>> import configparser
     >>> conv = {}
     >>> conv['list'] = lambda v: [e.strip() for e in v.split() if e.strip()]
     >>> cfg = configparser.ConfigParser(converters=conv)
     >>> cfg.read_string("""
     ... [s]
     ... list = a b c d e f g
     ... """)
     >>> cfg.get('s', 'list')
     'a b c d e f g'
     >>> cfg.getlist('s', 'list')
     ['a', 'b', 'c', 'd', 'e', 'f', 'g']
     >>> section = cfg['s']
     >>> section.getlist('list')
     ['a', 'b', 'c', 'd', 'e', 'f', 'g']

(Contributed by Łukasz Langa in bpo-18159(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18159


File: python.info,  Node: contextlib<3>,  Next: csv<2>,  Prev: configparser,  Up: Improved Modules<4>

1.4.5.12 contextlib
...................

The new *note redirect_stderr(): 6b5. *note context manager: 55d.
(similar to *note redirect_stdout(): 6b6.) makes it easier for utility
scripts to handle inflexible APIs that write their output to *note
sys.stderr: 304. and don’t provide any options to redirect it:

     >>> import contextlib, io, logging
     >>> f = io.StringIO()
     >>> with contextlib.redirect_stderr(f):
     ...     logging.warning('warning')
     ...
     >>> f.getvalue()
     'WARNING:root:warning\n'

(Contributed by Berker Peksag in bpo-22389(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22389


File: python.info,  Node: csv<2>,  Next: curses<2>,  Prev: contextlib<3>,  Up: Improved Modules<4>

1.4.5.13 csv
............

The *note writerow(): 6b8. method now supports arbitrary iterables, not
just sequences.  (Contributed by Serhiy Storchaka in bpo-23171(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23171


File: python.info,  Node: curses<2>,  Next: dbm<4>,  Prev: csv<2>,  Up: Improved Modules<4>

1.4.5.14 curses
...............

The new *note update_lines_cols(): 6ba. function updates the ‘LINES’ and
‘COLS’ environment variables.  This is useful for detecting manual
screen resizing.  (Contributed by Arnon Yaari in bpo-4254(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4254


File: python.info,  Node: dbm<4>,  Next: difflib,  Prev: curses<2>,  Up: Improved Modules<4>

1.4.5.15 dbm
............

*note dumb.open: 2bd. always creates a new database when the flag has
the value ‘"n"’.  (Contributed by Claudiu Popa in bpo-18039(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18039


File: python.info,  Node: difflib,  Next: distutils<4>,  Prev: dbm<4>,  Up: Improved Modules<4>

1.4.5.16 difflib
................

The charset of HTML documents generated by *note HtmlDiff.make_file():
6bd. can now be customized by using a new `charset' keyword-only
argument.  The default charset of HTML document changed from
‘"ISO-8859-1"’ to ‘"utf-8"’.  (Contributed by Berker Peksag in
bpo-2052(1).)

The *note diff_bytes(): 6be. function can now compare lists of byte
strings.  This fixes a regression from Python 2.  (Contributed by Terry
J. Reedy and Greg Ward in bpo-17445(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2052

   (2) https://bugs.python.org/issue17445


File: python.info,  Node: distutils<4>,  Next: doctest,  Prev: difflib,  Up: Improved Modules<4>

1.4.5.17 distutils
..................

Both the ‘build’ and ‘build_ext’ commands now accept a ‘-j’ option to
enable parallel building of extension modules.  (Contributed by Antoine
Pitrou in bpo-5309(1).)

The *note distutils: 39. module now supports ‘xz’ compression, and can
be enabled by passing ‘xztar’ as an argument to ‘bdist --format’.
(Contributed by Serhiy Storchaka in bpo-16314(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5309

   (2) https://bugs.python.org/issue16314


File: python.info,  Node: doctest,  Next: email<2>,  Prev: distutils<4>,  Up: Improved Modules<4>

1.4.5.18 doctest
................

The *note DocTestSuite(): 6c1. function returns an empty *note
unittest.TestSuite: 6c2. if `module' contains no docstrings, instead of
raising *note ValueError: 1f9.  (Contributed by Glenn Jones in
bpo-15916(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15916


File: python.info,  Node: email<2>,  Next: enum<4>,  Prev: doctest,  Up: Improved Modules<4>

1.4.5.19 email
..............

A new policy option *note Policy.mangle_from_: 6c4. controls whether or
not lines that start with ‘"From "’ in email bodies are prefixed with a
‘">"’ character by generators.  The default is ‘True’ for *note
compat32: 535. and ‘False’ for all other policies.  (Contributed by
Milan Oberkirch in bpo-20098(1).)

A new *note Message.get_content_disposition(): 6c5. method provides easy
access to a canonical value for the ‘Content-Disposition’ header.
(Contributed by Abhilash Raj in bpo-21083(2).)

A new policy option *note EmailPolicy.utf8: 6c6. can be set to ‘True’ to
encode email headers using the UTF-8 charset instead of using encoded
words.  This allows ‘Messages’ to be formatted according to RFC 6532(3)
and used with an SMTP server that supports the RFC 6531(4) ‘SMTPUTF8’
extension.  (Contributed by R. David Murray in bpo-24211(5).)

The *note mime.text.MIMEText: 6c7. constructor now accepts a *note
charset.Charset: 6c8. instance.  (Contributed by Claude Paroz and Berker
Peksag in bpo-16324(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20098

   (2) https://bugs.python.org/issue21083

   (3) https://tools.ietf.org/html/rfc6532.html

   (4) https://tools.ietf.org/html/rfc6531.html

   (5) https://bugs.python.org/issue24211

   (6) https://bugs.python.org/issue16324


File: python.info,  Node: enum<4>,  Next: faulthandler<2>,  Prev: email<2>,  Up: Improved Modules<4>

1.4.5.20 enum
.............

The *note Enum: 37c. callable has a new parameter `start' to specify the
initial number of enum values if only `names' are provided:

     >>> Animal = enum.Enum('Animal', 'cat dog', start=10)
     >>> Animal.cat
     <Animal.cat: 10>
     >>> Animal.dog
     <Animal.dog: 11>

(Contributed by Ethan Furman in bpo-21706(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21706


File: python.info,  Node: faulthandler<2>,  Next: functools<3>,  Prev: enum<4>,  Up: Improved Modules<4>

1.4.5.21 faulthandler
.....................

The *note enable(): 53d, *note register(): 6cb, *note dump_traceback():
6cc. and *note dump_traceback_later(): 6cd. functions now accept file
descriptors in addition to file-like objects.  (Contributed by Wei Wu in
bpo-23566(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23566


File: python.info,  Node: functools<3>,  Next: glob,  Prev: faulthandler<2>,  Up: Improved Modules<4>

1.4.5.22 functools
..................

Most of the *note lru_cache(): 1c5. machinery is now implemented in C,
making it significantly faster.  (Contributed by Matt Joiner, Alexey
Kachayev, and Serhiy Storchaka in bpo-14373(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14373


File: python.info,  Node: glob,  Next: gzip<2>,  Prev: functools<3>,  Up: Improved Modules<4>

1.4.5.23 glob
.............

The *note iglob(): 5bc. and *note glob(): 5bb. functions now support
recursive search in subdirectories, using the ‘"**"’ pattern.
(Contributed by Serhiy Storchaka in bpo-13968(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13968


File: python.info,  Node: gzip<2>,  Next: heapq,  Prev: glob,  Up: Improved Modules<4>

1.4.5.24 gzip
.............

The `mode' argument of the *note GzipFile: 6d1. constructor now accepts
‘"x"’ to request exclusive creation.  (Contributed by Tim Heaney in
bpo-19222(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19222


File: python.info,  Node: heapq,  Next: http,  Prev: gzip<2>,  Up: Improved Modules<4>

1.4.5.25 heapq
..............

Element comparison in *note merge(): 6d3. can now be customized by
passing a *note key function: 6d4. in a new optional `key' keyword
argument, and a new optional `reverse' keyword argument can be used to
reverse element comparison:

     >>> import heapq
     >>> a = ['9', '777', '55555']
     >>> b = ['88', '6666']
     >>> list(heapq.merge(a, b, key=len))
     ['9', '88', '777', '6666', '55555']
     >>> list(heapq.merge(reversed(a), reversed(b), key=len, reverse=True))
     ['55555', '6666', '777', '88', '9']

(Contributed by Raymond Hettinger in bpo-13742(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13742


File: python.info,  Node: http,  Next: http client<3>,  Prev: heapq,  Up: Improved Modules<4>

1.4.5.26 http
.............

A new *note HTTPStatus: 6d6. enum that defines a set of HTTP status
codes, reason phrases and long descriptions written in English.
(Contributed by Demian Brecht in bpo-21793(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21793


File: python.info,  Node: http client<3>,  Next: idlelib and IDLE<3>,  Prev: http,  Up: Improved Modules<4>

1.4.5.27 http.client
....................

*note HTTPConnection.getresponse(): 6d8. now raises a *note
RemoteDisconnected: 6d9. exception when a remote server connection is
closed unexpectedly.  Additionally, if a *note ConnectionError: 6da. (of
which ‘RemoteDisconnected’ is a subclass) is raised, the client socket
is now closed automatically, and will reconnect on the next request:

     import http.client
     conn = http.client.HTTPConnection('www.python.org')
     for retries in range(3):
         try:
             conn.request('GET', '/')
             resp = conn.getresponse()
         except http.client.RemoteDisconnected:
             pass

(Contributed by Martin Panter in bpo-3566(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3566


File: python.info,  Node: idlelib and IDLE<3>,  Next: imaplib,  Prev: http client<3>,  Up: Improved Modules<4>

1.4.5.28 idlelib and IDLE
.........................

Since idlelib implements the IDLE shell and editor and is not intended
for import by other programs, it gets improvements with every release.
See ‘Lib/idlelib/NEWS.txt’ for a cumulative list of changes since 3.4.0,
as well as changes made in future 3.5.x releases.  This file is also
available from the IDLE Help ‣ About IDLE dialog.


File: python.info,  Node: imaplib,  Next: imghdr,  Prev: idlelib and IDLE<3>,  Up: Improved Modules<4>

1.4.5.29 imaplib
................

The *note IMAP4: 600. class now supports the *note context manager: 55d.
protocol.  When used in a *note with: 6dd. statement, the IMAP4 ‘LOGOUT’
command will be called automatically at the end of the block.
(Contributed by Tarek Ziadé and Serhiy Storchaka in bpo-4972(1).)

The *note imaplib: 98. module now supports RFC 5161(2) (ENABLE
Extension) and RFC 6855(3) (UTF-8 Support) via the *note IMAP4.enable():
6de. method.  A new *note IMAP4.utf8_enabled: 6df. attribute tracks
whether or not RFC 6855(4) support is enabled.  (Contributed by Milan
Oberkirch, R. David Murray, and Maciej Szulik in bpo-21800(5).)

The *note imaplib: 98. module now automatically encodes non-ASCII string
usernames and passwords using UTF-8, as recommended by the RFCs.
(Contributed by Milan Oberkirch in bpo-21800(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4972

   (2) https://tools.ietf.org/html/rfc5161.html

   (3) https://tools.ietf.org/html/rfc6855.html

   (4) https://tools.ietf.org/html/rfc6855.html

   (5) https://bugs.python.org/issue21800

   (6) https://bugs.python.org/issue21800


File: python.info,  Node: imghdr,  Next: importlib<5>,  Prev: imaplib,  Up: Improved Modules<4>

1.4.5.30 imghdr
...............

The *note what(): 6e1. function now recognizes the OpenEXR(1) format
(contributed by Martin Vignali and Claudiu Popa in bpo-20295(2)), and
the WebP(3) format (contributed by Fabrice Aneche and Claudiu Popa in
bpo-20197(4).)

   ---------- Footnotes ----------

   (1) http://www.openexr.com

   (2) https://bugs.python.org/issue20295

   (3) https://en.wikipedia.org/wiki/WebP

   (4) https://bugs.python.org/issue20197


File: python.info,  Node: importlib<5>,  Next: inspect<3>,  Prev: imghdr,  Up: Improved Modules<4>

1.4.5.31 importlib
..................

The *note util.LazyLoader: 548. class allows for lazy loading of modules
in applications where startup time is important.  (Contributed by Brett
Cannon in bpo-17621(1).)

The *note abc.InspectLoader.source_to_code(): 6e3. method is now a
static method.  This makes it easier to initialize a module object with
code compiled from a string by running ‘exec(code, module.__dict__)’.
(Contributed by Brett Cannon in bpo-21156(2).)

The new *note util.module_from_spec(): 6e4. function is now the
preferred way to create a new module.  As opposed to creating a *note
types.ModuleType: 6e5. instance directly, this new function will set the
various import-controlled attributes based on the passed-in spec object.
(Contributed by Brett Cannon in bpo-20383(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17621

   (2) https://bugs.python.org/issue21156

   (3) https://bugs.python.org/issue20383


File: python.info,  Node: inspect<3>,  Next: io<3>,  Prev: importlib<5>,  Up: Improved Modules<4>

1.4.5.32 inspect
................

Both the *note Signature: 6e7. and *note Parameter: 6e8. classes are now
picklable and hashable.  (Contributed by Yury Selivanov in bpo-20726(1)
and bpo-20334(2).)

A new *note BoundArguments.apply_defaults(): 6e9. method provides a way
to set default values for missing arguments:

     >>> def foo(a, b='ham', *args): pass
     >>> ba = inspect.signature(foo).bind('spam')
     >>> ba.apply_defaults()
     >>> ba.arguments
     OrderedDict([('a', 'spam'), ('b', 'ham'), ('args', ())])

(Contributed by Yury Selivanov in bpo-24190(3).)

A new class method *note Signature.from_callable(): 6ea. makes
subclassing of *note Signature: 6e7. easier.  (Contributed by Yury
Selivanov and Eric Snow in bpo-17373(4).)

The *note signature(): 550. function now accepts a `follow_wrapped'
optional keyword argument, which, when set to ‘False’, disables
automatic following of ‘__wrapped__’ links.  (Contributed by Yury
Selivanov in bpo-20691(5).)

A set of new functions to inspect *note coroutine functions: 633. and
*note coroutine objects: 1a5. has been added: *note iscoroutine(): 6eb,
*note iscoroutinefunction(): 6ec, *note isawaitable(): 6ed, *note
getcoroutinelocals(): 6ee, and *note getcoroutinestate(): 6ef.
(Contributed by Yury Selivanov in bpo-24017(6) and bpo-24400(7).)

The *note stack(): 6f0, *note trace(): 6f1, *note getouterframes(): 6f2,
and *note getinnerframes(): 6f3. functions now return a list of named
tuples.  (Contributed by Daniel Shahaf in bpo-16808(8).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20726

   (2) https://bugs.python.org/issue20334

   (3) https://bugs.python.org/issue24190

   (4) https://bugs.python.org/issue17373

   (5) https://bugs.python.org/issue20691

   (6) https://bugs.python.org/issue24017

   (7) https://bugs.python.org/issue24400

   (8) https://bugs.python.org/issue16808


File: python.info,  Node: io<3>,  Next: ipaddress<2>,  Prev: inspect<3>,  Up: Improved Modules<4>

1.4.5.33 io
...........

A new *note BufferedIOBase.readinto1(): 6f5. method, that uses at most
one call to the underlying raw stream’s *note RawIOBase.read(): 6f6. or
*note RawIOBase.readinto(): 6f7. methods.  (Contributed by Nikolaus Rath
in bpo-20578(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20578


File: python.info,  Node: ipaddress<2>,  Next: json<2>,  Prev: io<3>,  Up: Improved Modules<4>

1.4.5.34 ipaddress
..................

Both the *note IPv4Network: 395. and *note IPv6Network: 394. classes now
accept an ‘(address, netmask)’ tuple argument, so as to easily construct
network objects from existing addresses:

     >>> import ipaddress
     >>> ipaddress.IPv4Network(('127.0.0.0', 8))
     IPv4Network('127.0.0.0/8')
     >>> ipaddress.IPv4Network(('127.0.0.0', '255.0.0.0'))
     IPv4Network('127.0.0.0/8')

(Contributed by Peter Moody and Antoine Pitrou in bpo-16531(1).)

A new ‘reverse_pointer’ attribute for the *note IPv4Network: 395. and
*note IPv6Network: 394. classes returns the name of the reverse DNS PTR
record:

     >>> import ipaddress
     >>> addr = ipaddress.IPv4Address('127.0.0.1')
     >>> addr.reverse_pointer
     '1.0.0.127.in-addr.arpa'
     >>> addr6 = ipaddress.IPv6Address('::1')
     >>> addr6.reverse_pointer
     '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa'

(Contributed by Leon Weber in bpo-20480(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16531

   (2) https://bugs.python.org/issue20480


File: python.info,  Node: json<2>,  Next: linecache,  Prev: ipaddress<2>,  Up: Improved Modules<4>

1.4.5.35 json
.............

The *note json.tool: a5. command line interface now preserves the order
of keys in JSON objects passed in input.  The new ‘--sort-keys’ option
can be used to sort the keys alphabetically.  (Contributed by Berker
Peksag in bpo-21650(1).)

JSON decoder now raises *note JSONDecodeError: 6fa. instead of *note
ValueError: 1f9. to provide better context information about the error.
(Contributed by Serhiy Storchaka in bpo-19361(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21650

   (2) https://bugs.python.org/issue19361


File: python.info,  Node: linecache,  Next: locale<3>,  Prev: json<2>,  Up: Improved Modules<4>

1.4.5.36 linecache
..................

A new *note lazycache(): 6fc. function can be used to capture
information about a non-file-based module to permit getting its lines
later via *note getline(): 6fd.  This avoids doing I/O until a line is
actually needed, without having to carry the module globals around
indefinitely.  (Contributed by Robert Collins in bpo-17911(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17911


File: python.info,  Node: locale<3>,  Next: logging<4>,  Prev: linecache,  Up: Improved Modules<4>

1.4.5.37 locale
...............

A new *note delocalize(): 6ff. function can be used to convert a string
into a normalized number string, taking the ‘LC_NUMERIC’ settings into
account:

     >>> import locale
     >>> locale.setlocale(locale.LC_NUMERIC, 'de_DE.UTF-8')
     'de_DE.UTF-8'
     >>> locale.delocalize('1.234,56')
     '1234.56'
     >>> locale.setlocale(locale.LC_NUMERIC, 'en_US.UTF-8')
     'en_US.UTF-8'
     >>> locale.delocalize('1,234.56')
     '1234.56'

(Contributed by Cédric Krier in bpo-13918(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13918


File: python.info,  Node: logging<4>,  Next: lzma,  Prev: locale<3>,  Up: Improved Modules<4>

1.4.5.38 logging
................

All logging methods (*note Logger: 39c. *note log(): 701, *note
exception(): 702, *note critical(): 703, *note debug(): 704, etc.), now
accept exception instances as an `exc_info' argument, in addition to
boolean values and exception tuples:

     >>> import logging
     >>> try:
     ...     1/0
     ... except ZeroDivisionError as ex:
     ...     logging.error('exception', exc_info=ex)
     ERROR:root:exception

(Contributed by Yury Selivanov in bpo-20537(1).)

The *note handlers.HTTPHandler: 705. class now accepts an optional *note
ssl.SSLContext: 3d9. instance to configure SSL settings used in an HTTP
connection.  (Contributed by Alex Gaynor in bpo-22788(2).)

The *note handlers.QueueListener: 706. class now takes a
`respect_handler_level' keyword argument which, if set to ‘True’, will
pass messages to handlers taking handler levels into account.
(Contributed by Vinay Sajip.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20537

   (2) https://bugs.python.org/issue22788


File: python.info,  Node: lzma,  Next: math<4>,  Prev: logging<4>,  Up: Improved Modules<4>

1.4.5.39 lzma
.............

The *note LZMADecompressor.decompress(): 708. method now accepts an
optional `max_length' argument to limit the maximum size of decompressed
data.  (Contributed by Martin Panter in bpo-15955(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15955


File: python.info,  Node: math<4>,  Next: multiprocessing<4>,  Prev: lzma,  Up: Improved Modules<4>

1.4.5.40 math
.............

Two new constants have been added to the *note math: b1. module: *note
inf: 51d. and *note nan: 51e.  (Contributed by Mark Dickinson in
bpo-23185(1).)

A new function *note isclose(): 67a. provides a way to test for
approximate equality.  (Contributed by Chris Barker and Tal Einat in
bpo-24270(2).)

A new *note gcd(): 70a. function has been added.  The *note
fractions.gcd(): 70b. function is now deprecated.  (Contributed by Mark
Dickinson and Serhiy Storchaka in bpo-22486(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23185

   (2) https://bugs.python.org/issue24270

   (3) https://bugs.python.org/issue22486


File: python.info,  Node: multiprocessing<4>,  Next: operator,  Prev: math<4>,  Up: Improved Modules<4>

1.4.5.41 multiprocessing
........................

*note sharedctypes.synchronized(): 70d. objects now support the *note
context manager: 55d. protocol.  (Contributed by Charles-François Natali
in bpo-21565(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21565


File: python.info,  Node: operator,  Next: os<5>,  Prev: multiprocessing<4>,  Up: Improved Modules<4>

1.4.5.42 operator
.................

*note attrgetter(): 70f, *note itemgetter(): 25f, and *note
methodcaller(): 710. objects now support pickling.  (Contributed by Josh
Rosenberg and Serhiy Storchaka in bpo-22955(1).)

New *note matmul(): 711. and *note imatmul(): 712. functions to perform
matrix multiplication.  (Contributed by Benjamin Peterson in
bpo-21176(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22955

   (2) https://bugs.python.org/issue21176


File: python.info,  Node: os<5>,  Next: pathlib<4>,  Prev: operator,  Up: Improved Modules<4>

1.4.5.43 os
...........

The new *note scandir(): 25d. function returning an iterator of *note
DirEntry: 4e6. objects has been added.  If possible, *note scandir():
25d. extracts file attributes while scanning a directory, removing the
need to perform subsequent system calls to determine file type or
attributes, which may significantly improve performance.  (Contributed
by Ben Hoyt with the help of Victor Stinner in bpo-22524(1).)

On Windows, a new *note stat_result.st_file_attributes: 714. attribute
is now available.  It corresponds to the ‘dwFileAttributes’ member of
the ‘BY_HANDLE_FILE_INFORMATION’ structure returned by
‘GetFileInformationByHandle()’.  (Contributed by Ben Hoyt in
bpo-21719(2).)

The *note urandom(): 4c6. function now uses the ‘getrandom()’ syscall on
Linux 3.17 or newer, and ‘getentropy()’ on OpenBSD 5.6 and newer,
removing the need to use ‘/dev/urandom’ and avoiding failures due to
potential file descriptor exhaustion.  (Contributed by Victor Stinner in
bpo-22181(3).)

New *note get_blocking(): 715. and *note set_blocking(): 716. functions
allow getting and setting a file descriptor’s blocking mode (*note
O_NONBLOCK: 717.)  (Contributed by Victor Stinner in bpo-22054(4).)

The *note truncate(): 718. and *note ftruncate(): 656. functions are now
supported on Windows.  (Contributed by Steve Dower in bpo-23668(5).)

There is a new *note os.path.commonpath(): 719. function returning the
longest common sub-path of each passed pathname.  Unlike the *note
os.path.commonprefix(): 71a. function, it always returns a valid path:

     >>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
     '/usr/l'

     >>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
     '/usr'

(Contributed by Rafik Draoui and Serhiy Storchaka in bpo-10395(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22524

   (2) https://bugs.python.org/issue21719

   (3) https://bugs.python.org/issue22181

   (4) https://bugs.python.org/issue22054

   (5) https://bugs.python.org/issue23668

   (6) https://bugs.python.org/issue10395


File: python.info,  Node: pathlib<4>,  Next: pickle<3>,  Prev: os<5>,  Up: Improved Modules<4>

1.4.5.44 pathlib
................

The new *note Path.samefile(): 71c. method can be used to check whether
the path points to the same file as another path, which can be either
another *note Path: 1ff. object, or a string:

     >>> import pathlib
     >>> p1 = pathlib.Path('/etc/hosts')
     >>> p2 = pathlib.Path('/etc/../etc/hosts')
     >>> p1.samefile(p2)
     True

(Contributed by Vajrasky Kok and Antoine Pitrou in bpo-19775(1).)

The *note Path.mkdir(): 71d. method now accepts a new optional
`exist_ok' argument to match ‘mkdir -p’ and *note os.makedirs(): 3b2.
functionality.  (Contributed by Berker Peksag in bpo-21539(2).)

There is a new *note Path.expanduser(): 71e. method to expand ‘~’ and
‘~user’ prefixes.  (Contributed by Serhiy Storchaka and Claudiu Popa in
bpo-19776(3).)

A new *note Path.home(): 71f. class method can be used to get a *note
Path: 1ff. instance representing the user’s home directory.
(Contributed by Victor Salgado and Mayank Tripathi in bpo-19777(4).)

New *note Path.write_text(): 720, *note Path.read_text(): 721, *note
Path.write_bytes(): 722, *note Path.read_bytes(): 723. methods to
simplify read/write operations on files.

The following code snippet will create or rewrite existing file
‘~/spam42’:

     >>> import pathlib
     >>> p = pathlib.Path('~/spam42')
     >>> p.expanduser().write_text('ham')
     3

(Contributed by Christopher Welborn in bpo-20218(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19775

   (2) https://bugs.python.org/issue21539

   (3) https://bugs.python.org/issue19776

   (4) https://bugs.python.org/issue19777

   (5) https://bugs.python.org/issue20218


File: python.info,  Node: pickle<3>,  Next: poplib,  Prev: pathlib<4>,  Up: Improved Modules<4>

1.4.5.45 pickle
...............

Nested objects, such as unbound methods or nested classes, can now be
pickled using *note pickle protocols: 563. older than protocol version
4.  Protocol version 4 already supports these cases.  (Contributed by
Serhiy Storchaka in bpo-23611(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23611


File: python.info,  Node: poplib,  Next: re<4>,  Prev: pickle<3>,  Up: Improved Modules<4>

1.4.5.46 poplib
...............

A new *note POP3.utf8(): 726. command enables RFC 6856(1)
(Internationalized Email) support, if a POP server supports it.
(Contributed by Milan OberKirch in bpo-21804(2).)

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc6856.html

   (2) https://bugs.python.org/issue21804


File: python.info,  Node: re<4>,  Next: readline<2>,  Prev: poplib,  Up: Improved Modules<4>

1.4.5.47 re
...........

References and conditional references to groups with fixed length are
now allowed in lookbehind assertions:

     >>> import re
     >>> pat = re.compile(r'(a|b).(?<=\1)c')
     >>> pat.match('aac')
     <_sre.SRE_Match object; span=(0, 3), match='aac'>
     >>> pat.match('bbc')
     <_sre.SRE_Match object; span=(0, 3), match='bbc'>

(Contributed by Serhiy Storchaka in bpo-9179(1).)

The number of capturing groups in regular expressions is no longer
limited to 100.  (Contributed by Serhiy Storchaka in bpo-22437(2).)

The *note sub(): 470. and *note subn(): 728. functions now replace
unmatched groups with empty strings instead of raising an exception.
(Contributed by Serhiy Storchaka in bpo-1519638(3).)

The *note re.error: 729. exceptions have new attributes, *note msg: 72a,
*note pattern: 72b, *note pos: 72c, *note lineno: 72d, and *note colno:
72e, that provide better context information about the error:

     >>> re.compile("""
     ...     (?x)
     ...     .++
     ... """)
     Traceback (most recent call last):
        ...
     sre_constants.error: multiple repeat at position 16 (line 3, column 7)

(Contributed by Serhiy Storchaka in bpo-22578(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9179

   (2) https://bugs.python.org/issue22437

   (3) https://bugs.python.org/issue1519638

   (4) https://bugs.python.org/issue22578


File: python.info,  Node: readline<2>,  Next: selectors,  Prev: re<4>,  Up: Improved Modules<4>

1.4.5.48 readline
.................

A new *note append_history_file(): 730. function can be used to append
the specified number of trailing elements in history to the given file.
(Contributed by Bruno Cauet in bpo-22940(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22940


File: python.info,  Node: selectors,  Next: shutil<2>,  Prev: readline<2>,  Up: Improved Modules<4>

1.4.5.49 selectors
..................

The new *note DevpollSelector: 443. supports efficient ‘/dev/poll’
polling on Solaris.  (Contributed by Giampaolo Rodola’ in bpo-18931(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18931


File: python.info,  Node: shutil<2>,  Next: signal<2>,  Prev: selectors,  Up: Improved Modules<4>

1.4.5.50 shutil
...............

The *note move(): 259. function now accepts a `copy_function' argument,
allowing, for example, the *note copy(): 257. function to be used
instead of the default *note copy2(): 258. if there is a need to ignore
file metadata when moving.  (Contributed by Claudiu Popa in
bpo-19840(1).)

The *note make_archive(): 219. function now supports the `xztar' format.
(Contributed by Serhiy Storchaka in bpo-5411(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19840

   (2) https://bugs.python.org/issue5411


File: python.info,  Node: signal<2>,  Next: smtpd,  Prev: shutil<2>,  Up: Improved Modules<4>

1.4.5.51 signal
...............

On Windows, the *note set_wakeup_fd(): 3c3. function now also supports
socket handles.  (Contributed by Victor Stinner in bpo-22018(1).)

Various ‘SIG*’ constants in the *note signal: ea. module have been
converted into *note Enums: 7b.  This allows meaningful names to be
printed during debugging, instead of integer “magic numbers”.
(Contributed by Giampaolo Rodola’ in bpo-21076(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22018

   (2) https://bugs.python.org/issue21076


File: python.info,  Node: smtpd,  Next: smtplib,  Prev: signal<2>,  Up: Improved Modules<4>

1.4.5.52 smtpd
..............

Both the *note SMTPServer: 5f7. and *note SMTPChannel: 5f6. classes now
accept a `decode_data' keyword argument to determine if the ‘DATA’
portion of the SMTP transaction is decoded using the ‘"utf-8"’ codec or
is instead provided to the *note SMTPServer.process_message(): 5f8.
method as a byte string.  The default is ‘True’ for backward
compatibility reasons, but will change to ‘False’ in Python 3.6.  If
`decode_data' is set to ‘False’, the ‘process_message’ method must be
prepared to accept keyword arguments.  (Contributed by Maciej Szulik in
bpo-19662(1).)

The *note SMTPServer: 5f7. class now advertises the ‘8BITMIME’ extension
( RFC 6152(2)) if `decode_data' has been set ‘True’.  If the client
specifies ‘BODY=8BITMIME’ on the ‘MAIL’ command, it is passed to *note
SMTPServer.process_message(): 5f8. via the `mail_options' keyword.
(Contributed by Milan Oberkirch and R. David Murray in bpo-21795(3).)

The *note SMTPServer: 5f7. class now also supports the ‘SMTPUTF8’
extension ( RFC 6531(4): Internationalized Email).  If the client
specified ‘SMTPUTF8 BODY=8BITMIME’ on the ‘MAIL’ command, they are
passed to *note SMTPServer.process_message(): 5f8. via the
`mail_options' keyword.  It is the responsibility of the
‘process_message’ method to correctly handle the ‘SMTPUTF8’ data.
(Contributed by Milan Oberkirch in bpo-21725(5).)

It is now possible to provide, directly or via name resolution, IPv6
addresses in the *note SMTPServer: 5f7. constructor, and have it
successfully connect.  (Contributed by Milan Oberkirch in bpo-14758(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19662

   (2) https://tools.ietf.org/html/rfc6152.html

   (3) https://bugs.python.org/issue21795

   (4) https://tools.ietf.org/html/rfc6531.html

   (5) https://bugs.python.org/issue21725

   (6) https://bugs.python.org/issue14758


File: python.info,  Node: smtplib,  Next: sndhdr,  Prev: smtpd,  Up: Improved Modules<4>

1.4.5.53 smtplib
................

A new *note SMTP.auth(): 736. method provides a convenient way to
implement custom authentication mechanisms.  (Contributed by Milan
Oberkirch in bpo-15014(1).)

The *note SMTP.set_debuglevel(): 737. method now accepts an additional
debuglevel (2), which enables timestamps in debug messages.
(Contributed by Gavin Chappell and Maciej Szulik in bpo-16914(2).)

Both the *note SMTP.sendmail(): 738. and *note SMTP.send_message(): 739.
methods now support RFC 6531(3) (SMTPUTF8).  (Contributed by Milan
Oberkirch and R. David Murray in bpo-22027(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15014

   (2) https://bugs.python.org/issue16914

   (3) https://tools.ietf.org/html/rfc6531.html

   (4) https://bugs.python.org/issue22027


File: python.info,  Node: sndhdr,  Next: socket<5>,  Prev: smtplib,  Up: Improved Modules<4>

1.4.5.54 sndhdr
...............

The *note what(): 73b. and *note whathdr(): 73c. functions now return a
*note namedtuple(): 1b5.  (Contributed by Claudiu Popa in bpo-18615(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18615


File: python.info,  Node: socket<5>,  Next: ssl<6>,  Prev: sndhdr,  Up: Improved Modules<4>

1.4.5.55 socket
...............

Functions with timeouts now use a monotonic clock, instead of a system
clock.  (Contributed by Victor Stinner in bpo-22043(1).)

A new *note socket.sendfile(): 73e. method allows sending a file over a
socket by using the high-performance *note os.sendfile(): 34e. function
on UNIX, resulting in uploads being from 2 to 3 times faster than when
using plain *note socket.send(): 66e.  (Contributed by Giampaolo Rodola’
in bpo-17552(2).)

The *note socket.sendall(): 66f. method no longer resets the socket
timeout every time bytes are received or sent.  The socket timeout is
now the maximum total duration to send all data.  (Contributed by Victor
Stinner in bpo-23853(3).)

The `backlog' argument of the *note socket.listen(): 73f. method is now
optional.  By default it is set to *note SOMAXCONN: 740. or to ‘128’,
whichever is less.  (Contributed by Charles-François Natali in
bpo-21455(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22043

   (2) https://bugs.python.org/issue17552

   (3) https://bugs.python.org/issue23853

   (4) https://bugs.python.org/issue21455


File: python.info,  Node: ssl<6>,  Next: sqlite3<3>,  Prev: socket<5>,  Up: Improved Modules<4>

1.4.5.56 ssl
............

* Menu:

* Memory BIO Support::
* Application-Layer Protocol Negotiation Support::
* Other Changes::


File: python.info,  Node: Memory BIO Support,  Next: Application-Layer Protocol Negotiation Support,  Up: ssl<6>

1.4.5.57 Memory BIO Support
...........................

(Contributed by Geert Jansen in bpo-21965(1).)

The new *note SSLObject: 3d8. class has been added to provide SSL
protocol support for cases when the network I/O capabilities of *note
SSLSocket: 3d7. are not necessary or are suboptimal.  ‘SSLObject’
represents an SSL protocol instance, but does not implement any network
I/O methods, and instead provides a memory buffer interface.  The new
*note MemoryBIO: 743. class can be used to pass data between Python and
an SSL protocol instance.

The memory BIO SSL support is primarily intended to be used in
frameworks implementing asynchronous I/O for which *note SSLSocket:
3d7.’s readiness model (“select/poll”) is inefficient.

A new *note SSLContext.wrap_bio(): 3db. method can be used to create a
new ‘SSLObject’ instance.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21965


File: python.info,  Node: Application-Layer Protocol Negotiation Support,  Next: Other Changes,  Prev: Memory BIO Support,  Up: ssl<6>

1.4.5.58 Application-Layer Protocol Negotiation Support
.......................................................

(Contributed by Benjamin Peterson in bpo-20188(1).)

Where OpenSSL support is present, the *note ssl: f3. module now
implements the `Application-Layer Protocol Negotiation' TLS extension as
described in RFC 7301(2).

The new *note SSLContext.set_alpn_protocols(): 745. can be used to
specify which protocols a socket should advertise during the TLS
handshake.

The new *note SSLSocket.selected_alpn_protocol(): 746. returns the
protocol that was selected during the TLS handshake.  The *note
HAS_ALPN: 747. flag indicates whether ALPN support is present.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20188

   (2) https://tools.ietf.org/html/rfc7301.html


File: python.info,  Node: Other Changes,  Prev: Application-Layer Protocol Negotiation Support,  Up: ssl<6>

1.4.5.59 Other Changes
......................

There is a new *note SSLSocket.version(): 749. method to query the
actual protocol version in use.  (Contributed by Antoine Pitrou in
bpo-20421(1).)

The *note SSLSocket: 3d7. class now implements a ‘SSLSocket.sendfile()’
method.  (Contributed by Giampaolo Rodola’ in bpo-17552(2).)

The ‘SSLSocket.send()’ method now raises either the *note
ssl.SSLWantReadError: 74a. or *note ssl.SSLWantWriteError: 74b.
exception on a non-blocking socket if the operation would block.
Previously, it would return ‘0’.  (Contributed by Nikolaus Rath in
bpo-20951(3).)

The *note cert_time_to_seconds(): 74c. function now interprets the input
time as UTC and not as local time, per RFC 5280(4).  Additionally, the
return value is always an *note int: 184.  (Contributed by Akira Li in
bpo-19940(5).)

New ‘SSLObject.shared_ciphers()’ and *note SSLSocket.shared_ciphers():
74d. methods return the list of ciphers sent by the client during the
handshake.  (Contributed by Benjamin Peterson in bpo-23186(6).)

The *note SSLSocket.do_handshake(): 74e, *note SSLSocket.read(): 74f,
‘SSLSocket.shutdown()’, and *note SSLSocket.write(): 750. methods of the
*note SSLSocket: 3d7. class no longer reset the socket timeout every
time bytes are received or sent.  The socket timeout is now the maximum
total duration of the method.  (Contributed by Victor Stinner in
bpo-23853(7).)

The *note match_hostname(): 3d1. function now supports matching of IP
addresses.  (Contributed by Antoine Pitrou in bpo-23239(8).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20421

   (2) https://bugs.python.org/issue17552

   (3) https://bugs.python.org/issue20951

   (4) https://tools.ietf.org/html/rfc5280.html

   (5) https://bugs.python.org/issue19940

   (6) https://bugs.python.org/issue23186

   (7) https://bugs.python.org/issue23853

   (8) https://bugs.python.org/issue23239


File: python.info,  Node: sqlite3<3>,  Next: subprocess<3>,  Prev: ssl<6>,  Up: Improved Modules<4>

1.4.5.60 sqlite3
................

The *note Row: 752. class now fully supports the sequence protocol, in
particular *note reversed(): 18e. iteration and slice indexing.
(Contributed by Claudiu Popa in bpo-10203(1); by Lucas Sinclair, Jessica
McKellar, and Serhiy Storchaka in bpo-13583(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10203

   (2) https://bugs.python.org/issue13583


File: python.info,  Node: subprocess<3>,  Next: sys<5>,  Prev: sqlite3<3>,  Up: Improved Modules<4>

1.4.5.61 subprocess
...................

The new *note run(): 3e2. function has been added.  It runs the
specified command and returns a *note CompletedProcess: 754. object,
which describes a finished process.  The new API is more consistent and
is the recommended approach to invoking subprocesses in Python code that
does not need to maintain compatibility with earlier Python versions.
(Contributed by Thomas Kluyver in bpo-23342(1).)

Examples:

     >>> subprocess.run(["ls", "-l"])  # doesn't capture output
     CompletedProcess(args=['ls', '-l'], returncode=0)

     >>> subprocess.run("exit 1", shell=True, check=True)
     Traceback (most recent call last):
       ...
     subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1

     >>> subprocess.run(["ls", "-l", "/dev/null"], stdout=subprocess.PIPE)
     CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
     stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n')

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23342


File: python.info,  Node: sys<5>,  Next: sysconfig,  Prev: subprocess<3>,  Up: Improved Modules<4>

1.4.5.62 sys
............

A new ‘set_coroutine_wrapper()’ function allows setting a global hook
that will be called whenever a *note coroutine object: 1a5. is created
by an *note async def: 282. function.  A corresponding
‘get_coroutine_wrapper()’ can be used to obtain a currently set wrapper.
Both functions are *note provisional: 33d, and are intended for
debugging purposes only.  (Contributed by Yury Selivanov in
bpo-24017(1).)

A new *note is_finalizing(): 756. function can be used to check if the
Python interpreter is *note shutting down: 757.  (Contributed by Antoine
Pitrou in bpo-22696(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24017

   (2) https://bugs.python.org/issue22696


File: python.info,  Node: sysconfig,  Next: tarfile<2>,  Prev: sys<5>,  Up: Improved Modules<4>

1.4.5.63 sysconfig
..................

The name of the user scripts directory on Windows now includes the first
two components of the Python version.  (Contributed by Paul Moore in
bpo-23437(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23437


File: python.info,  Node: tarfile<2>,  Next: threading<3>,  Prev: sysconfig,  Up: Improved Modules<4>

1.4.5.64 tarfile
................

The `mode' argument of the *note open(): 75a. function now accepts ‘"x"’
to request exclusive creation.  (Contributed by Berker Peksag in
bpo-21717(1).)

The *note TarFile.extractall(): 75b. and *note TarFile.extract(): 75c.
methods now take a keyword argument `numeric_owner'.  If set to ‘True’,
the extracted files and directories will be owned by the numeric ‘uid’
and ‘gid’ from the tarfile.  If set to ‘False’ (the default, and the
behavior in versions prior to 3.5), they will be owned by the named user
and group in the tarfile.  (Contributed by Michael Vogt and Eric Smith
in bpo-23193(2).)

The *note TarFile.list(): 75d. now accepts an optional `members' keyword
argument that can be set to a subset of the list returned by *note
TarFile.getmembers(): 75e.  (Contributed by Serhiy Storchaka in
bpo-21549(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21717

   (2) https://bugs.python.org/issue23193

   (3) https://bugs.python.org/issue21549


File: python.info,  Node: threading<3>,  Next: time<4>,  Prev: tarfile<2>,  Up: Improved Modules<4>

1.4.5.65 threading
..................

Both the *note Lock.acquire(): 760. and *note RLock.acquire(): 761.
methods now use a monotonic clock for timeout management.  (Contributed
by Victor Stinner in bpo-22043(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22043


File: python.info,  Node: time<4>,  Next: timeit<2>,  Prev: threading<3>,  Up: Improved Modules<4>

1.4.5.66 time
.............

The *note monotonic(): 763. function is now always available.
(Contributed by Victor Stinner in bpo-22043(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22043


File: python.info,  Node: timeit<2>,  Next: tkinter<5>,  Prev: time<4>,  Up: Improved Modules<4>

1.4.5.67 timeit
...............

A new command line option ‘-u’ or ‘--unit=`U'’ can be used to specify
the time unit for the timer output.  Supported options are ‘usec’,
‘msec’, or ‘sec’.  (Contributed by Julian Gindi in bpo-18983(1).)

The *note timeit(): 765. function has a new `globals' parameter for
specifying the namespace in which the code will be running.
(Contributed by Ben Roberts in bpo-2527(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18983

   (2) https://bugs.python.org/issue2527


File: python.info,  Node: tkinter<5>,  Next: traceback<2>,  Prev: timeit<2>,  Up: Improved Modules<4>

1.4.5.68 tkinter
................

The ‘tkinter._fix’ module used for setting up the Tcl/Tk environment on
Windows has been replaced by a private function in the ‘_tkinter’ module
which makes no permanent changes to environment variables.  (Contributed
by Zachary Ware in bpo-20035(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20035


File: python.info,  Node: traceback<2>,  Next: types<2>,  Prev: tkinter<5>,  Up: Improved Modules<4>

1.4.5.69 traceback
..................

New *note walk_stack(): 768. and *note walk_tb(): 769. functions to
conveniently traverse frame and traceback objects.  (Contributed by
Robert Collins in bpo-17911(1).)

New lightweight classes: *note TracebackException: 76a, *note
StackSummary: 76b, and *note FrameSummary: 76c.  (Contributed by Robert
Collins in bpo-17911(2).)

Both the *note print_tb(): 76d. and *note print_stack(): 76e. functions
now support negative values for the `limit' argument.  (Contributed by
Dmitry Kazakov in bpo-22619(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17911

   (2) https://bugs.python.org/issue17911

   (3) https://bugs.python.org/issue22619


File: python.info,  Node: types<2>,  Next: unicodedata<4>,  Prev: traceback<2>,  Up: Improved Modules<4>

1.4.5.70 types
..............

A new *note coroutine(): 770. function to transform *note generator:
44c. and *note generator-like: 6a9. objects into *note awaitables: 50e.
(Contributed by Yury Selivanov in bpo-24017(1).)

A new type called *note CoroutineType: 771, which is used for *note
coroutine: 1a5. objects created by *note async def: 282. functions.
(Contributed by Yury Selivanov in bpo-24400(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24017

   (2) https://bugs.python.org/issue24400


File: python.info,  Node: unicodedata<4>,  Next: unittest<3>,  Prev: types<2>,  Up: Improved Modules<4>

1.4.5.71 unicodedata
....................

The *note unicodedata: 11a. module now uses data from Unicode 8.0.0(1).

   ---------- Footnotes ----------

   (1) http://unicode.org/versions/Unicode8.0.0/


File: python.info,  Node: unittest<3>,  Next: unittest mock<3>,  Prev: unicodedata<4>,  Up: Improved Modules<4>

1.4.5.72 unittest
.................

The *note TestLoader.loadTestsFromModule(): 774. method now accepts a
keyword-only argument `pattern' which is passed to ‘load_tests’ as the
third argument.  Found packages are now checked for ‘load_tests’
regardless of whether their path matches `pattern', because it is
impossible for a package name to match the default pattern.
(Contributed by Robert Collins and Barry A. Warsaw in bpo-16662(1).)

Unittest discovery errors now are exposed in the *note
TestLoader.errors: 775. attribute of the *note TestLoader: 776.
instance.  (Contributed by Robert Collins in bpo-19746(2).)

A new command line option ‘--locals’ to show local variables in
tracebacks.  (Contributed by Robert Collins in bpo-22936(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16662

   (2) https://bugs.python.org/issue19746

   (3) https://bugs.python.org/issue22936


File: python.info,  Node: unittest mock<3>,  Next: urllib,  Prev: unittest<3>,  Up: Improved Modules<4>

1.4.5.73 unittest.mock
......................

The *note Mock: 247. class has the following improvements:

   * The class constructor has a new `unsafe' parameter, which causes
     mock objects to raise *note AttributeError: 390. on attribute names
     starting with ‘"assert"’.  (Contributed by Kushal Das in
     bpo-21238(1).)

   * A new *note Mock.assert_not_called(): 778. method to check if the
     mock object was called.  (Contributed by Kushal Das in
     bpo-21262(2).)

The *note MagicMock: 779. class now supports *note __truediv__(): 77a,
*note __divmod__(): 77b. and *note __matmul__(): 63c. operators.
(Contributed by Johannes Baiter in bpo-20968(3), and Håkan Lövdahl in
bpo-23581(4) and bpo-23568(5).)

It is no longer necessary to explicitly pass ‘create=True’ to the *note
patch(): 77c. function when patching builtin names.  (Contributed by
Kushal Das in bpo-17660(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21238

   (2) https://bugs.python.org/issue21262

   (3) https://bugs.python.org/issue20968

   (4) https://bugs.python.org/issue23581

   (5) https://bugs.python.org/issue23568

   (6) https://bugs.python.org/issue17660


File: python.info,  Node: urllib,  Next: wsgiref,  Prev: unittest mock<3>,  Up: Improved Modules<4>

1.4.5.74 urllib
...............

A new *note request.HTTPPasswordMgrWithPriorAuth: 77e. class allows HTTP
Basic Authentication credentials to be managed so as to eliminate
unnecessary ‘401’ response handling, or to unconditionally send
credentials on the first request in order to communicate with servers
that return a ‘404’ response instead of a ‘401’ if the ‘Authorization’
header is not sent.  (Contributed by Matej Cepl in bpo-19494(1) and
Akshit Khurana in bpo-7159(2).)

A new `quote_via' argument for the *note parse.urlencode(): 77f.
function provides a way to control the encoding of query parts if
needed.  (Contributed by Samwyse and Arnon Yaari in bpo-13866(3).)

The *note request.urlopen(): 780. function accepts an *note
ssl.SSLContext: 3d9. object as a `context' argument, which will be used
for the HTTPS connection.  (Contributed by Alex Gaynor in bpo-22366(4).)

The *note parse.urljoin(): 781. was updated to use the RFC 3986(5)
semantics for the resolution of relative URLs, rather than RFC 1808(6)
and RFC 2396(7).  (Contributed by Demian Brecht and Senthil Kumaran in
bpo-22118(8).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19494

   (2) https://bugs.python.org/issue7159

   (3) https://bugs.python.org/issue13866

   (4) https://bugs.python.org/issue22366

   (5) https://tools.ietf.org/html/rfc3986.html

   (6) https://tools.ietf.org/html/rfc1808.html

   (7) https://tools.ietf.org/html/rfc2396.html

   (8) https://bugs.python.org/issue22118


File: python.info,  Node: wsgiref,  Next: xmlrpc<2>,  Prev: urllib,  Up: Improved Modules<4>

1.4.5.75 wsgiref
................

The `headers' argument of the *note headers.Headers: 783. class
constructor is now optional.  (Contributed by Pablo Torres Navarrete and
SilentGhost in bpo-5800(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5800


File: python.info,  Node: xmlrpc<2>,  Next: xml sax,  Prev: wsgiref,  Up: Improved Modules<4>

1.4.5.76 xmlrpc
...............

The *note client.ServerProxy: 253. class now supports the *note context
manager: 55d. protocol.  (Contributed by Claudiu Popa in bpo-20627(1).)

The *note client.ServerProxy: 253. constructor now accepts an optional
*note ssl.SSLContext: 3d9. instance.  (Contributed by Alex Gaynor in
bpo-22960(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20627

   (2) https://bugs.python.org/issue22960


File: python.info,  Node: xml sax,  Next: zipfile<3>,  Prev: xmlrpc<2>,  Up: Improved Modules<4>

1.4.5.77 xml.sax
................

SAX parsers now support a character stream of the *note
xmlreader.InputSource: 786. object.  (Contributed by Serhiy Storchaka in
bpo-2175(1).)

*note parseString(): 787. now accepts a *note str: 325. instance.
(Contributed by Serhiy Storchaka in bpo-10590(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2175

   (2) https://bugs.python.org/issue10590


File: python.info,  Node: zipfile<3>,  Prev: xml sax,  Up: Improved Modules<4>

1.4.5.78 zipfile
................

ZIP output can now be written to unseekable streams.  (Contributed by
Serhiy Storchaka in bpo-23252(1).)

The `mode' argument of *note ZipFile.open(): 5b1. method now accepts
‘"x"’ to request exclusive creation.  (Contributed by Serhiy Storchaka
in bpo-21717(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23252

   (2) https://bugs.python.org/issue21717


File: python.info,  Node: Other module-level changes,  Next: Optimizations<4>,  Prev: Improved Modules<4>,  Up: What’s New In Python 3 5

1.4.6 Other module-level changes
--------------------------------

Many functions in the *note mmap: b3, *note ossaudiodev: c6, *note
socket: ef, *note ssl: f3, and *note codecs: 1c. modules now accept
writable *note bytes-like objects: 5dd.  (Contributed by Serhiy
Storchaka in bpo-23001(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23001


File: python.info,  Node: Optimizations<4>,  Next: Build and C API Changes<3>,  Prev: Other module-level changes,  Up: What’s New In Python 3 5

1.4.7 Optimizations
-------------------

The *note os.walk(): 648. function has been sped up by 3 to 5 times on
POSIX systems, and by 7 to 20 times on Windows.  This was done using the
new *note os.scandir(): 25d. function, which exposes file information
from the underlying ‘readdir’ or ‘FindFirstFile’/‘FindNextFile’ system
calls.  (Contributed by Ben Hoyt with help from Victor Stinner in
bpo-23605(1).)

Construction of ‘bytes(int)’ (filled by zero bytes) is faster and uses
less memory for large objects.  ‘calloc()’ is used instead of ‘malloc()’
to allocate memory for these objects.  (Contributed by Victor Stinner in
bpo-21233(2).)

Some operations on *note ipaddress: a2. *note IPv4Network: 395. and
*note IPv6Network: 394. have been massively sped up, such as *note
subnets(): 78b, *note supernet(): 78c, *note summarize_address_range():
78d, *note collapse_addresses(): 78e.  The speed up can range from 3 to
15 times.  (Contributed by Antoine Pitrou, Michel Albert, and Markus in
bpo-21486(3), bpo-21487(4), bpo-20826(5), bpo-23266(6).)

Pickling of *note ipaddress: a2. objects was optimized to produce
significantly smaller output.  (Contributed by Serhiy Storchaka in
bpo-23133(7).)

Many operations on *note io.BytesIO: 78f. are now 50% to 100% faster.
(Contributed by Serhiy Storchaka in bpo-15381(8) and David Wilson in
bpo-22003(9).)

The *note marshal.dumps(): 790. function is now faster: 65–85% with
versions 3 and 4, 20–25% with versions 0 to 2 on typical data, and up to
5 times in best cases.  (Contributed by Serhiy Storchaka in
bpo-20416(10) and bpo-23344(11).)

The UTF-32 encoder is now 3 to 7 times faster.  (Contributed by Serhiy
Storchaka in bpo-15027(12).)

Regular expressions are now parsed up to 10% faster.  (Contributed by
Serhiy Storchaka in bpo-19380(13).)

The *note json.dumps(): 5fa. function was optimized to run with
‘ensure_ascii=False’ as fast as with ‘ensure_ascii=True’.  (Contributed
by Naoki Inada in bpo-23206(14).)

The *note PyObject_IsInstance(): 791. and *note PyObject_IsSubclass():
792. functions have been sped up in the common case that the second
argument has *note type: 5fd. as its metaclass.  (Contributed Georg
Brandl by in bpo-22540(15).)

Method caching was slightly improved, yielding up to 5% performance
improvement in some benchmarks.  (Contributed by Antoine Pitrou in
bpo-22847(16).)

Objects from the *note random: dc. module now use 50% less memory on
64-bit builds.  (Contributed by Serhiy Storchaka in bpo-23488(17).)

The *note property(): 1d5. getter calls are up to 25% faster.
(Contributed by Joe Jevnik in bpo-23910(18).)

Instantiation of *note fractions.Fraction: 185. is now up to 30% faster.
(Contributed by Stefan Behnel in bpo-22464(19).)

String methods *note find(): 793, *note rfind(): 794, *note split():
795, *note partition(): 796. and the *note in: 797. string operator are
now significantly faster for searching 1-character substrings.
(Contributed by Serhiy Storchaka in bpo-23573(20).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23605

   (2) https://bugs.python.org/issue21233

   (3) https://bugs.python.org/issue21486

   (4) https://bugs.python.org/issue21487

   (5) https://bugs.python.org/issue20826

   (6) https://bugs.python.org/issue23266

   (7) https://bugs.python.org/issue23133

   (8) https://bugs.python.org/issue15381

   (9) https://bugs.python.org/issue22003

   (10) https://bugs.python.org/issue20416

   (11) https://bugs.python.org/issue23344

   (12) https://bugs.python.org/issue15027

   (13) https://bugs.python.org/issue19380

   (14) https://bugs.python.org/issue23206

   (15) https://bugs.python.org/issue22540

   (16) https://bugs.python.org/issue22847

   (17) https://bugs.python.org/issue23488

   (18) https://bugs.python.org/issue23910

   (19) https://bugs.python.org/issue22464

   (20) https://bugs.python.org/issue23573


File: python.info,  Node: Build and C API Changes<3>,  Next: Deprecated<3>,  Prev: Optimizations<4>,  Up: What’s New In Python 3 5

1.4.8 Build and C API Changes
-----------------------------

New ‘calloc’ functions were added:

   * *note PyMem_RawCalloc(): 799,

   * *note PyMem_Calloc(): 79a,

   * *note PyObject_Calloc(): 79b.

(Contributed by Victor Stinner in bpo-21233(1).)

New encoding/decoding helper functions:

   * *note Py_DecodeLocale(): 431. (replaced ‘_Py_char2wchar()’),

   * *note Py_EncodeLocale(): 432. (replaced ‘_Py_wchar2char()’).

(Contributed by Victor Stinner in bpo-18395(2).)

A new *note PyCodec_NameReplaceErrors(): 79c. function to replace the
unicode encode error with ‘\N{...}’ escapes.  (Contributed by Serhiy
Storchaka in bpo-19676(3).)

A new *note PyErr_FormatV(): 79d. function similar to *note
PyErr_Format(): 79e, but accepts a ‘va_list’ argument.  (Contributed by
Antoine Pitrou in bpo-18711(4).)

A new ‘PyExc_RecursionError’ exception.  (Contributed by Georg Brandl in
bpo-19235(5).)

New *note PyModule_FromDefAndSpec(): 79f, *note
PyModule_FromDefAndSpec2(): 7a0, and *note PyModule_ExecDef(): 7a1.
functions introduced by PEP 489(6) – multi-phase extension module
initialization.  (Contributed by Petr Viktorin in bpo-24268(7).)

New *note PyNumber_MatrixMultiply(): 7a2. and *note
PyNumber_InPlaceMatrixMultiply(): 7a3. functions to perform matrix
multiplication.  (Contributed by Benjamin Peterson in bpo-21176(8).  See
also PEP 465(9) for details.)

The *note PyTypeObject.tp_finalize: 2d5. slot is now part of the stable
ABI.

Windows builds now require Microsoft Visual C++ 14.0, which is available
as part of Visual Studio 2015(10).

Extension modules now include a platform information tag in their
filename on some platforms (the tag is optional, and CPython will import
extensions without it, although if the tag is present and mismatched,
the extension won’t be loaded):

   * On Linux, extension module filenames end with
     ‘.cpython-<major><minor>m-<architecture>-<os>.pyd’:

        * ‘<major>’ is the major number of the Python version; for
          Python 3.5 this is ‘3’.

        * ‘<minor>’ is the minor number of the Python version; for
          Python 3.5 this is ‘5’.

        * ‘<architecture>’ is the hardware architecture the extension
          module was built to run on.  It’s most commonly either ‘i386’
          for 32-bit Intel platforms or ‘x86_64’ for 64-bit Intel (and
          AMD) platforms.

        * ‘<os>’ is always ‘linux-gnu’, except for extensions built to
          talk to the 32-bit ABI on 64-bit platforms, in which case it
          is ‘linux-gnu32’ (and ‘<architecture>’ will be ‘x86_64’).

   * On Windows, extension module filenames end with
     ‘<debug>.cp<major><minor>-<platform>.pyd’:

        * ‘<major>’ is the major number of the Python version; for
          Python 3.5 this is ‘3’.

        * ‘<minor>’ is the minor number of the Python version; for
          Python 3.5 this is ‘5’.

        * ‘<platform>’ is the platform the extension module was built
          for, either ‘win32’ for Win32, ‘win_amd64’ for Win64,
          ‘win_ia64’ for Windows Itanium 64, and ‘win_arm’ for Windows
          on ARM.

        * If built in debug mode, ‘<debug>’ will be ‘_d’, otherwise it
          will be blank.

   * On OS X platforms, extension module filenames now end with
     ‘-darwin.so’.

   * On all other platforms, extension module filenames are the same as
     they were with Python 3.4.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21233

   (2) https://bugs.python.org/issue18395

   (3) https://bugs.python.org/issue19676

   (4) https://bugs.python.org/issue18711

   (5) https://bugs.python.org/issue19235

   (6) https://www.python.org/dev/peps/pep-0489

   (7) https://bugs.python.org/issue24268

   (8) https://bugs.python.org/issue21176

   (9) https://www.python.org/dev/peps/pep-0465

   (10) https://www.visualstudio.com/


File: python.info,  Node: Deprecated<3>,  Next: Removed<2>,  Prev: Build and C API Changes<3>,  Up: What’s New In Python 3 5

1.4.9 Deprecated
----------------

* Menu:

* New Keywords: New Keywords<2>.
* Deprecated Python Behavior: Deprecated Python Behavior<2>.
* Unsupported Operating Systems::
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods<3>.


File: python.info,  Node: New Keywords<2>,  Next: Deprecated Python Behavior<2>,  Up: Deprecated<3>

1.4.9.1 New Keywords
....................

‘async’ and ‘await’ are not recommended to be used as variable, class,
function or module names.  Introduced by PEP 492(1) in Python 3.5, they
will become proper keywords in Python 3.7.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: Deprecated Python Behavior<2>,  Next: Unsupported Operating Systems,  Prev: New Keywords<2>,  Up: Deprecated<3>

1.4.9.2 Deprecated Python Behavior
..................................

Raising the *note StopIteration: 47b. exception inside a generator will
now generate a silent *note PendingDeprecationWarning: 277, which will
become a non-silent deprecation warning in Python 3.6 and will trigger a
*note RuntimeError: 2b8. in Python 3.7.  See *note PEP 479; Change
StopIteration handling inside generators: 5cc. for details.


File: python.info,  Node: Unsupported Operating Systems,  Next: Deprecated Python modules functions and methods<3>,  Prev: Deprecated Python Behavior<2>,  Up: Deprecated<3>

1.4.9.3 Unsupported Operating Systems
.....................................

Windows XP is no longer supported by Microsoft, thus, per PEP 11(1),
CPython 3.5 is no longer officially supported on this OS.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0011


File: python.info,  Node: Deprecated Python modules functions and methods<3>,  Prev: Unsupported Operating Systems,  Up: Deprecated<3>

1.4.9.4 Deprecated Python modules, functions and methods
........................................................

The *note formatter: 82. module has now graduated to full deprecation
and is still slated for removal in Python 3.6.

The ‘asyncio.async()’ function is deprecated in favor of *note
ensure_future(): 50c.

The *note smtpd: ec. module has in the past always decoded the DATA
portion of email messages using the ‘utf-8’ codec.  This can now be
controlled by the new `decode_data' keyword to *note SMTPServer: 5f7.
The default value is ‘True’, but this default is deprecated.  Specify
the `decode_data' keyword with an appropriate value to avoid the
deprecation warning.

Directly assigning values to the *note key: 482, *note value: 483. and
*note coded_value: 484. of *note http.cookies.Morsel: 485. objects is
deprecated.  Use the *note set(): 486. method instead.  In addition, the
undocumented `LegalChars' parameter of *note set(): 486. is deprecated,
and is now ignored.

Passing a format string as keyword argument `format_string' to the *note
format(): 481. method of the *note string.Formatter: 7a9. class has been
deprecated.  (Contributed by Serhiy Storchaka in bpo-23671(1).)

The ‘platform.dist()’ and ‘platform.linux_distribution()’ functions are
now deprecated.  Linux distributions use too many different ways of
describing themselves, so the functionality is left to a package.
(Contributed by Vajrasky Kok and Berker Peksag in bpo-1322(2).)

The previously undocumented ‘from_function’ and ‘from_builtin’ methods
of *note inspect.Signature: 6e7. are deprecated.  Use the new *note
Signature.from_callable(): 6ea. method instead.  (Contributed by Yury
Selivanov in bpo-24248(3).)

The *note inspect.getargspec(): 551. function is deprecated and
scheduled to be removed in Python 3.6.  (See bpo-20438(4) for details.)

The *note inspect: a0. *note getfullargspec(): 552, *note getcallargs():
7aa, and *note formatargspec(): 7ab. functions are deprecated in favor
of the *note inspect.signature(): 550. API. (Contributed by Yury
Selivanov in bpo-20438(5).)

*note getargvalues(): 7ac. and *note formatargvalues(): 7ad. functions
were inadvertently marked as deprecated with the release of Python
3.5.0.

Use of *note re.LOCALE: 3be. flag with str patterns or *note re.ASCII:
3bd. is now deprecated.  (Contributed by Serhiy Storchaka in
bpo-22407(6).)

Use of unrecognized special sequences consisting of ‘'\'’ and an ASCII
letter in regular expression patterns and replacement patterns now
raises a deprecation warning and will be forbidden in Python 3.6.
(Contributed by Serhiy Storchaka in bpo-23622(7).)

The undocumented and unofficial `use_load_tests' default argument of the
*note unittest.TestLoader.loadTestsFromModule(): 774. method now is
deprecated and ignored.  (Contributed by Robert Collins and Barry A.
Warsaw in bpo-16662(8).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23671

   (2) https://bugs.python.org/issue1322

   (3) https://bugs.python.org/issue24248

   (4) https://bugs.python.org/issue20438

   (5) https://bugs.python.org/issue20438

   (6) https://bugs.python.org/issue22407

   (7) https://bugs.python.org/issue23622

   (8) https://bugs.python.org/issue16662


File: python.info,  Node: Removed<2>,  Next: Porting to Python 3 5,  Prev: Deprecated<3>,  Up: What’s New In Python 3 5

1.4.10 Removed
--------------

* Menu:

* API and Feature Removals: API and Feature Removals<4>.


File: python.info,  Node: API and Feature Removals<4>,  Up: Removed<2>

1.4.10.1 API and Feature Removals
.................................

The following obsolete and previously deprecated APIs and features have
been removed:

   * The ‘__version__’ attribute has been dropped from the email
     package.  The email code hasn’t been shipped separately from the
     stdlib for a long time, and the ‘__version__’ string was not
     updated in the last few releases.

   * The internal ‘Netrc’ class in the *note ftplib: 84. module was
     deprecated in 3.4, and has now been removed.  (Contributed by Matt
     Chaput in bpo-6623(1).)

   * The concept of ‘.pyo’ files has been removed.

   * The JoinableQueue class in the provisional *note asyncio: a. module
     was deprecated in 3.4.4 and is now removed.  (Contributed by A.
     Jesse Jiryu Davis in bpo-23464(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6623

   (2) https://bugs.python.org/issue23464


File: python.info,  Node: Porting to Python 3 5,  Next: Notable changes in Python 3 5 4,  Prev: Removed<2>,  Up: What’s New In Python 3 5

1.4.11 Porting to Python 3.5
----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code.

* Menu:

* Changes in Python behavior: Changes in Python behavior<2>.
* Changes in the Python API: Changes in the Python API<4>.
* Changes in the C API: Changes in the C API<4>.


File: python.info,  Node: Changes in Python behavior<2>,  Next: Changes in the Python API<4>,  Up: Porting to Python 3 5

1.4.11.1 Changes in Python behavior
...................................

   * Due to an oversight, earlier Python versions erroneously accepted
     the following syntax:

          f(1 for x in [1], *args)
          f(1 for x in [1], **kwargs)

     Python 3.5 now correctly raises a *note SyntaxError: 44d, as
     generator expressions must be put in parentheses if not a sole
     argument to a function.


File: python.info,  Node: Changes in the Python API<4>,  Next: Changes in the C API<4>,  Prev: Changes in Python behavior<2>,  Up: Porting to Python 3 5

1.4.11.2 Changes in the Python API
..................................

   * PEP 475(1): System calls are now retried when interrupted by a
     signal instead of raising *note InterruptedError: 64d. if the
     Python signal handler does not raise an exception.

   * Before Python 3.5, a *note datetime.time: 4e8. object was
     considered to be false if it represented midnight in UTC. This
     behavior was considered obscure and error-prone and has been
     removed in Python 3.5.  See bpo-13936(2) for full details.

   * The ‘ssl.SSLSocket.send()’ method now raises either *note
     ssl.SSLWantReadError: 74a. or *note ssl.SSLWantWriteError: 74b. on
     a non-blocking socket if the operation would block.  Previously, it
     would return ‘0’.  (Contributed by Nikolaus Rath in bpo-20951(3).)

   * The ‘__name__’ attribute of generators is now set from the function
     name, instead of being set from the code name.  Use
     ‘gen.gi_code.co_name’ to retrieve the code name.  Generators also
     have a new ‘__qualname__’ attribute, the qualified name, which is
     now used for the representation of a generator (‘repr(gen)’).
     (Contributed by Victor Stinner in bpo-21205(4).)

   * The deprecated “strict” mode and argument of *note HTMLParser: 7b3,
     ‘HTMLParser.error()’, and the ‘HTMLParserError’ exception have been
     removed.  (Contributed by Ezio Melotti in bpo-15114(5).)  The
     `convert_charrefs' argument of *note HTMLParser: 7b3. is now ‘True’
     by default.  (Contributed by Berker Peksag in bpo-21047(6).)

   * Although it is not formally part of the API, it is worth noting for
     porting purposes (ie: fixing tests) that error messages that were
     previously of the form “‘sometype’ does not support the buffer
     protocol” are now of the form “a *note bytes-like object: 5dd. is
     required, not ‘sometype’”.  (Contributed by Ezio Melotti in
     bpo-16518(7).)

   * If the current directory is set to a directory that no longer
     exists then *note FileNotFoundError: 7b4. will no longer be raised
     and instead *note find_spec(): 7b5. will return ‘None’ `without'
     caching ‘None’ in *note sys.path_importer_cache: 493, which is
     different than the typical case (bpo-22834(8)).

   * HTTP status code and messages from *note http.client: 94. and *note
     http.server: 97. were refactored into a common *note HTTPStatus:
     6d6. enum.  The values in *note http.client: 94. and *note
     http.server: 97. remain available for backwards compatibility.
     (Contributed by Demian Brecht in bpo-21793(9).)

   * When an import loader defines
     ‘importlib.machinery.Loader.exec_module()’ it is now expected to
     also define ‘create_module()’ (raises a *note DeprecationWarning:
     276. now, will be an error in Python 3.6).  If the loader inherits
     from *note importlib.abc.Loader: 7b6. then there is nothing to do,
     else simply define ‘create_module()’ to return ‘None’.
     (Contributed by Brett Cannon in bpo-23014(10).)

   * The *note re.split(): 3bf. function always ignored empty pattern
     matches, so the ‘"x*"’ pattern worked the same as ‘"x+"’, and the
     ‘"\b"’ pattern never worked.  Now *note re.split(): 3bf. raises a
     warning if the pattern could match an empty string.  For
     compatibility, use patterns that never match an empty string (e.g.
     ‘"x+"’ instead of ‘"x*"’).  Patterns that could only match an empty
     string (such as ‘"\b"’) now raise an error.  (Contributed by Serhiy
     Storchaka in bpo-22818(11).)

   * The *note http.cookies.Morsel: 485. dict-like interface has been
     made self consistent: morsel comparison now takes the *note key:
     482. and *note value: 483. into account, *note copy(): 7b7. now
     results in a *note Morsel: 485. instance rather than a *note dict:
     1b6, and *note update(): 7b8. will now raise an exception if any of
     the keys in the update dictionary are invalid.  In addition, the
     undocumented `LegalChars' parameter of *note set(): 486. is
     deprecated and is now ignored.  (Contributed by Demian Brecht in
     bpo-2211(12).)

   * PEP 488(13) has removed ‘.pyo’ files from Python and introduced the
     optional ‘opt-’ tag in ‘.pyc’ file names.  The *note
     importlib.util.cache_from_source(): 54c. has gained an
     `optimization' parameter to help control the ‘opt-’ tag.  Because
     of this, the `debug_override' parameter of the function is now
     deprecated.  ‘.pyo’ files are also no longer supported as a file
     argument to the Python interpreter and thus serve no purpose when
     distributed on their own (i.e.  sourceless code distribution).  Due
     to the fact that the magic number for bytecode has changed in
     Python 3.5, all old ‘.pyo’ files from previous versions of Python
     are invalid regardless of this PEP.

   * The *note socket: ef. module now exports the *note
     CAN_RAW_FD_FRAMES: 7b9. constant on linux 3.6 and greater.

   * The *note ssl.cert_time_to_seconds(): 74c. function now interprets
     the input time as UTC and not as local time, per RFC 5280(14).
     Additionally, the return value is always an *note int: 184.
     (Contributed by Akira Li in bpo-19940(15).)

   * The ‘pygettext.py’ Tool now uses the standard +NNNN format for
     timezones in the POT-Creation-Date header.

   * The *note smtplib: ed. module now uses *note sys.stderr: 304.
     instead of the previous module-level ‘stderr’ variable for debug
     output.  If your (test) program depends on patching the
     module-level variable to capture the debug output, you will need to
     update it to capture sys.stderr instead.

   * The *note str.startswith(): 7ba. and *note str.endswith(): 7bb.
     methods no longer return ‘True’ when finding the empty string and
     the indexes are completely out of range.  (Contributed by Serhiy
     Storchaka in bpo-24284(16).)

   * The *note inspect.getdoc(): 1d4. function now returns documentation
     strings inherited from base classes.  Documentation strings no
     longer need to be duplicated if the inherited documentation is
     appropriate.  To suppress an inherited string, an empty string must
     be specified (or the documentation may be filled in).  This change
     affects the output of the *note pydoc: d9. module and the *note
     help(): 567. function.  (Contributed by Serhiy Storchaka in
     bpo-15582(17).)

   * Nested *note functools.partial(): 7bc. calls are now flattened.  If
     you were relying on the previous behavior, you can now either add
     an attribute to a *note functools.partial(): 7bc. object or you can
     create a subclass of *note functools.partial(): 7bc.  (Contributed
     by Alexander Belopolsky in bpo-7830(18).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475

   (2) https://bugs.python.org/issue13936

   (3) https://bugs.python.org/issue20951

   (4) https://bugs.python.org/issue21205

   (5) https://bugs.python.org/issue15114

   (6) https://bugs.python.org/issue21047

   (7) https://bugs.python.org/issue16518

   (8) https://bugs.python.org/issue22834

   (9) https://bugs.python.org/issue21793

   (10) https://bugs.python.org/issue23014

   (11) https://bugs.python.org/issue22818

   (12) https://bugs.python.org/issue2211

   (13) https://www.python.org/dev/peps/pep-0488

   (14) https://tools.ietf.org/html/rfc5280.html

   (15) https://bugs.python.org/issue19940

   (16) https://bugs.python.org/issue24284

   (17) https://bugs.python.org/issue15582

   (18) https://bugs.python.org/issue7830


File: python.info,  Node: Changes in the C API<4>,  Prev: Changes in the Python API<4>,  Up: Porting to Python 3 5

1.4.11.3 Changes in the C API
.............................

   * The undocumented ‘format’ member of the (non-public)
     ‘PyMemoryViewObject’ structure has been removed.  All extensions
     relying on the relevant parts in ‘memoryobject.h’ must be rebuilt.

   * The ‘PyMemAllocator’ structure was renamed to *note
     PyMemAllocatorEx: 7be. and a new ‘calloc’ field was added.

   * Removed non-documented macro ‘PyObject_REPR’ which leaked
     references.  Use format character ‘%R’ in *note
     PyUnicode_FromFormat(): 7bf.-like functions to format the *note
     repr(): 7c0. of the object.  (Contributed by Serhiy Storchaka in
     bpo-22453(1).)

   * Because the lack of the ‘__module__’ attribute breaks pickling and
     introspection, a deprecation warning is now raised for builtin
     types without the ‘__module__’ attribute.  This would be an
     AttributeError in the future.  (Contributed by Serhiy Storchaka in
     bpo-20204(2).)

   * As part of the PEP 492(3) implementation, the ‘tp_reserved’ slot of
     *note PyTypeObject: 2d4. was replaced with a ‘tp_as_async’ slot.
     Refer to *note Coroutine Objects: 7c1. for new types, structures
     and functions.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22453

   (2) https://bugs.python.org/issue20204

   (3) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: Notable changes in Python 3 5 4,  Prev: Porting to Python 3 5,  Up: What’s New In Python 3 5

1.4.12 Notable changes in Python 3.5.4
--------------------------------------

* Menu:

* New make regen-all build target: New make regen-all build target<2>.
* Removal of make touch build target: Removal of make touch build target<2>.


File: python.info,  Node: New make regen-all build target<2>,  Next: Removal of make touch build target<2>,  Up: Notable changes in Python 3 5 4

1.4.12.1 New ‘make regen-all’ build target
..........................................

To simplify cross-compilation, and to ensure that CPython can reliably
be compiled without requiring an existing version of Python to already
be available, the autotools-based build system no longer attempts to
implicitly recompile generated files based on file modification times.

Instead, a new ‘make regen-all’ command has been added to force
regeneration of these files when desired (e.g.  after an initial version
of Python has already been built based on the pregenerated versions).

More selective regeneration targets are also defined - see
Makefile.pre.in(1) for details.

(Contributed by Victor Stinner in bpo-23404(2).)

New in version 3.5.4.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Makefile.pre.in

   (2) https://bugs.python.org/issue23404


File: python.info,  Node: Removal of make touch build target<2>,  Prev: New make regen-all build target<2>,  Up: Notable changes in Python 3 5 4

1.4.12.2 Removal of ‘make touch’ build target
.............................................

The ‘make touch’ build target previously used to request implicit
regeneration of generated files by updating their modification times has
been removed.

It has been replaced by the new ‘make regen-all’ target.

(Contributed by Victor Stinner in bpo-23404(1).)

Changed in version 3.5.4.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23404


File: python.info,  Node: What’s New In Python 3 4,  Next: What’s New In Python 3 3,  Prev: What’s New In Python 3 5,  Up: What’s New in Python

1.5 What’s New In Python 3.4
============================


Author: R. David Murray <<rdmurray@bitdance.com>> (Editor)

This article explains the new features in Python 3.4, compared to 3.3.
Python 3.4 was released on March 16, 2014.  For full details, see the
changelog(1).

See also
........

PEP 429(2) – Python 3.4 Release Schedule

* Menu:

* Summary – Release Highlights: Summary – Release Highlights<2>.
* New Features: New Features<5>.
* New Modules: New Modules<5>.
* Improved Modules: Improved Modules<5>.
* CPython Implementation Changes::
* Deprecated: Deprecated<4>.
* Removed: Removed<3>.
* Porting to Python 3.4: Porting to Python 3 4.
* Changed in 3.4.3: Changed in 3 4 3.

   ---------- Footnotes ----------

   (1) https://docs.python.org/3.4/whatsnew/changelog.html

   (2) https://www.python.org/dev/peps/pep-0429


File: python.info,  Node: Summary – Release Highlights<2>,  Next: New Features<5>,  Up: What’s New In Python 3 4

1.5.1 Summary – Release Highlights
----------------------------------

New syntax features:

   * No new syntax features were added in Python 3.4.

Other new features:

   * *note pip should always be available: 7c8. ( PEP 453(1)).

   * *note Newly created file descriptors are non-inheritable: 7c9. (
     PEP 446(2)).

   * command line option for *note isolated mode: 7ca. (bpo-16499(3)).

   * *note improvements in the handling of codecs: 7cb. that are not
     text encodings (multiple issues).

   * *note A ModuleSpec Type: 7cc. for the Import System ( PEP 451(4)).
     (Affects importer authors.)

   * The *note marshal: b0. format has been made *note more compact and
     efficient: 7cd. (bpo-16475(5)).

New library modules:

   * *note asyncio: a.: *note New provisional API for asynchronous IO:
     7ce. ( PEP 3156(6)).

   * *note ensurepip: 7a.: *note Bootstrapping the pip installer: 7cf. (
     PEP 453(7)).

   * *note enum: 7b.: *note Support for enumeration types: 7d0. ( PEP
     435(8)).

   * *note pathlib: c8.: *note Object-oriented filesystem paths: 7d1. (
     PEP 428(9)).

   * *note selectors: e6.: *note High-level and efficient I/O
     multiplexing: 7d2, built upon the *note select: e5. module
     primitives (part of PEP 3156(10)).

   * *note statistics: f5.: A basic *note numerically stable statistics
     library: 7d3. ( PEP 450(11)).

   * *note tracemalloc: 114.: *note Trace Python memory allocations:
     7d4. ( PEP 454(12)).

Significantly improved library modules:

   * *note Single-dispatch generic functions: 7d5. in *note functools:
     85. ( PEP 443(13)).

   * New *note pickle: ca. *note protocol 4: 7d6. ( PEP 3154(14)).

   * *note multiprocessing: b7. now has *note an option to avoid using
     os.fork on Unix: 7d7. (bpo-8713(15)).

   * *note email: 69. has a new submodule, *note contentmanager: 6b, and
     a new *note Message: 536. subclass (‘EmailMessage’) that *note
     simplify MIME handling: 7d8. (bpo-18891(16)).

   * The *note inspect: a0. and *note pydoc: d9. modules are now capable
     of correct introspection of a much wider variety of callable
     objects, which improves the output of the Python *note help(): 567.
     system.

   * The *note ipaddress: a2. module API has been declared stable

Security improvements:

   * *note Secure and interchangeable hash algorithm: 7d9. ( PEP
     456(17)).

   * *note Make newly created file descriptors non-inheritable: 7c9. (
     PEP 446(18)) to avoid leaking file descriptors to child processes.

   * New command line option for *note isolated mode: 7ca,
     (bpo-16499(19)).

   * *note multiprocessing: b7. now has *note an option to avoid using
     os.fork on Unix: 7d7.  `spawn' and `forkserver' are more secure
     because they avoid sharing data with child processes.

   * *note multiprocessing: b7. child processes on Windows no longer
     inherit all of the parent’s inheritable handles, only the necessary
     ones.

   * A new *note hashlib.pbkdf2_hmac(): 7da. function provides the
     PKCS#5 password-based key derivation function 2(20).

   * *note TLSv1.1 and TLSv1.2 support: 7db. for *note ssl: f3.

   * *note Retrieving certificates from the Windows system cert store
     support: 7dc. for *note ssl: f3.

   * *note Server-side SNI (Server Name Indication) support: 7dd. for
     *note ssl: f3.

   * The *note ssl.SSLContext: 3d9. class has a *note lot of
     improvements: 7de.

   * All modules in the standard library that support SSL now support
     server certificate verification, including hostname matching (*note
     ssl.match_hostname(): 3d1.) and CRLs (Certificate Revocation lists,
     see *note ssl.SSLContext.load_verify_locations(): 7df.).

CPython implementation improvements:

   * *note Safe object finalization: 7e0. ( PEP 442(21)).

   * Leveraging PEP 442(22), in most cases *note module globals are no
     longer set to None during finalization: 7e0. (bpo-18214(23)).

   * *note Configurable memory allocators: 7e1. ( PEP 445(24)).

   * *note Argument Clinic: 7e2. ( PEP 436(25)).

Please read on for a comprehensive list of user-facing changes,
including many other smaller improvements, CPython optimizations,
deprecations, and potential porting issues.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0453

   (2) https://www.python.org/dev/peps/pep-0446

   (3) https://bugs.python.org/issue16499

   (4) https://www.python.org/dev/peps/pep-0451

   (5) https://bugs.python.org/issue16475

   (6) https://www.python.org/dev/peps/pep-3156

   (7) https://www.python.org/dev/peps/pep-0453

   (8) https://www.python.org/dev/peps/pep-0435

   (9) https://www.python.org/dev/peps/pep-0428

   (10) https://www.python.org/dev/peps/pep-3156

   (11) https://www.python.org/dev/peps/pep-0450

   (12) https://www.python.org/dev/peps/pep-0454

   (13) https://www.python.org/dev/peps/pep-0443

   (14) https://www.python.org/dev/peps/pep-3154

   (15) https://bugs.python.org/issue8713

   (16) https://bugs.python.org/issue18891

   (17) https://www.python.org/dev/peps/pep-0456

   (18) https://www.python.org/dev/peps/pep-0446

   (19) https://bugs.python.org/issue16499

   (20) https://en.wikipedia.org/wiki/PBKDF2

   (21) https://www.python.org/dev/peps/pep-0442

   (22) https://www.python.org/dev/peps/pep-0442

   (23) https://bugs.python.org/issue18214

   (24) https://www.python.org/dev/peps/pep-0445

   (25) https://www.python.org/dev/peps/pep-0436


File: python.info,  Node: New Features<5>,  Next: New Modules<5>,  Prev: Summary – Release Highlights<2>,  Up: What’s New In Python 3 4

1.5.2 New Features
------------------

* Menu:

* PEP 453; Explicit Bootstrapping of PIP in Python Installations: PEP 453 Explicit Bootstrapping of PIP in Python Installations.
* PEP 446; Newly Created File Descriptors Are Non-Inheritable: PEP 446 Newly Created File Descriptors Are Non-Inheritable.
* Improvements to Codec Handling::
* PEP 451; A ModuleSpec Type for the Import System: PEP 451 A ModuleSpec Type for the Import System.
* Other Language Changes: Other Language Changes<5>.


File: python.info,  Node: PEP 453 Explicit Bootstrapping of PIP in Python Installations,  Next: PEP 446 Newly Created File Descriptors Are Non-Inheritable,  Up: New Features<5>

1.5.2.1 PEP 453: Explicit Bootstrapping of PIP in Python Installations
......................................................................

* Menu:

* Bootstrapping pip By Default::
* Documentation Changes::


File: python.info,  Node: Bootstrapping pip By Default,  Next: Documentation Changes,  Up: PEP 453 Explicit Bootstrapping of PIP in Python Installations

1.5.2.2 Bootstrapping pip By Default
....................................

The new *note ensurepip: 7a. module (defined in PEP 453(1)) provides a
standard cross-platform mechanism to bootstrap the pip installer into
Python installations and virtual environments.  The version of ‘pip’
included with Python 3.4.0 is ‘pip’ 1.5.4, and future 3.4.x maintenance
releases will update the bundled version to the latest version of ‘pip’
that is available at the time of creating the release candidate.

By default, the commands ‘pipX’ and ‘pipX.Y’ will be installed on all
platforms (where X.Y stands for the version of the Python installation),
along with the ‘pip’ Python package and its dependencies.  On Windows
and in virtual environments on all platforms, the unversioned ‘pip’
command will also be installed.  On other platforms, the system wide
unversioned ‘pip’ command typically refers to the separately installed
Python 2 version.

The ‘pyvenv’ command line utility and the *note venv: 125. module make
use of the *note ensurepip: 7a. module to make ‘pip’ readily available
in virtual environments.  When using the command line utility, ‘pip’ is
installed by default, while when using the *note venv: 125. module *note
API: 7e6. installation of ‘pip’ must be requested explicitly.

For CPython *note source builds on POSIX systems: 7e7, the ‘make
install’ and ‘make altinstall’ commands bootstrap ‘pip’ by default.
This behaviour can be controlled through configure options, and
overridden through Makefile options.

On Windows and Mac OS X, the CPython installers now default to
installing ‘pip’ along with CPython itself (users may opt out of
installing it during the installation process).  Window users will need
to opt in to the automatic ‘PATH’ modifications to have ‘pip’ available
from the command line by default, otherwise it can still be accessed
through the Python launcher for Windows as ‘py -m pip’.

As discussed in the PEP(2), platform packagers may choose not to install
these commands by default, as long as, when invoked, they provide clear
and simple directions on how to install them on that platform (usually
using the system package manager).

     Note: To avoid conflicts between parallel Python 2 and Python 3
     installations, only the versioned ‘pip3’ and ‘pip3.4’ commands are
     bootstrapped by default when ‘ensurepip’ is invoked directly - the
     ‘--default-pip’ option is needed to also request the unversioned
     ‘pip’ command.  ‘pyvenv’ and the Windows installer ensure that the
     unqualified ‘pip’ command is made available in those environments,
     and ‘pip’ can always be invoked via the ‘-m’ switch rather than
     directly to avoid ambiguity on systems with multiple Python
     installations.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0453

   (2) 
https://www.python.org/dev/peps/pep-0453/#recommendations-for-downstream-distributors


File: python.info,  Node: Documentation Changes,  Prev: Bootstrapping pip By Default,  Up: PEP 453 Explicit Bootstrapping of PIP in Python Installations

1.5.2.3 Documentation Changes
.............................

As part of this change, the *note Installing Python Modules: 7e9. and
*note Distributing Python Modules: 7ea. sections of the documentation
have been completely redesigned as short getting started and FAQ
documents.  Most packaging documentation has now been moved out to the
Python Packaging Authority maintained Python Packaging User Guide(1) and
the documentation of the individual projects.

However, as this migration is currently still incomplete, the legacy
versions of those guides remaining available as *note Installing Python
Modules (Legacy version): 7eb. and *note Distributing Python Modules
(Legacy version): 7ec.

See also
........

PEP 453(2) – Explicit bootstrapping of pip in Python installations

     PEP written by Donald Stufft and Nick Coghlan, implemented by
     Donald Stufft, Nick Coghlan, Martin von Löwis and Ned Deily.

   ---------- Footnotes ----------

   (1) https://packaging.python.org

   (2) https://www.python.org/dev/peps/pep-0453


File: python.info,  Node: PEP 446 Newly Created File Descriptors Are Non-Inheritable,  Next: Improvements to Codec Handling,  Prev: PEP 453 Explicit Bootstrapping of PIP in Python Installations,  Up: New Features<5>

1.5.2.4 PEP 446: Newly Created File Descriptors Are Non-Inheritable
...................................................................

PEP 446(1) makes newly created file descriptors *note non-inheritable:
7ee.  In general, this is the behavior an application will want: when
launching a new process, having currently open files also open in the
new process can lead to all sorts of hard to find bugs, and potentially
to security issues.

However, there are occasions when inheritance is desired.  To support
these cases, the following new functions and methods are available:

   * *note os.get_inheritable(): 7ef, *note os.set_inheritable(): 7f0.

   * *note os.get_handle_inheritable(): 7f1, *note
     os.set_handle_inheritable(): 7f2.

   * *note socket.socket.get_inheritable(): 7f3, *note
     socket.socket.set_inheritable(): 7f4.

See also
........

PEP 446(2) – Make newly created file descriptors non-inheritable

     PEP written and implemented by Victor Stinner.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0446

   (2) https://www.python.org/dev/peps/pep-0446


File: python.info,  Node: Improvements to Codec Handling,  Next: PEP 451 A ModuleSpec Type for the Import System,  Prev: PEP 446 Newly Created File Descriptors Are Non-Inheritable,  Up: New Features<5>

1.5.2.5 Improvements to Codec Handling
......................................

Since it was first introduced, the *note codecs: 1c. module has always
been intended to operate as a type-neutral dynamic encoding and decoding
system.  However, its close coupling with the Python text model,
especially the type restricted convenience methods on the builtin *note
str: 325, *note bytes: 326. and *note bytearray: 327. types, has
historically obscured that fact.

As a key step in clarifying the situation, the *note codecs.encode():
7f6. and *note codecs.decode(): 7f7. convenience functions are now
properly documented in Python 2.7, 3.3 and 3.4.  These functions have
existed in the *note codecs: 1c. module (and have been covered by the
regression test suite) since Python 2.4, but were previously only
discoverable through runtime introspection.

Unlike the convenience methods on *note str: 325, *note bytes: 326. and
*note bytearray: 327, the *note codecs: 1c. convenience functions
support arbitrary codecs in both Python 2 and Python 3, rather than
being limited to Unicode text encodings (in Python 3) or ‘basestring’
<-> ‘basestring’ conversions (in Python 2).

In Python 3.4, the interpreter is able to identify the known non-text
encodings provided in the standard library and direct users towards
these general purpose convenience functions when appropriate:

     >>> b"abcdef".decode("hex")
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     LookupError: 'hex' is not a text encoding; use codecs.decode() to handle arbitrary codecs

     >>> "hello".encode("rot13")
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     LookupError: 'rot13' is not a text encoding; use codecs.encode() to handle arbitrary codecs

     >>> open("foo.txt", encoding="hex")
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     LookupError: 'hex' is not a text encoding; use codecs.open() to handle arbitrary codecs

In a related change, whenever it is feasible without breaking backwards
compatibility, exceptions raised during encoding and decoding operations
are wrapped in a chained exception of the same type that mentions the
name of the codec responsible for producing the error:

     >>> import codecs

     >>> codecs.decode(b"abcdefgh", "hex")
     Traceback (most recent call last):
       File "/usr/lib/python3.4/encodings/hex_codec.py", line 20, in hex_decode
         return (binascii.a2b_hex(input), len(input))
     binascii.Error: Non-hexadecimal digit found

     The above exception was the direct cause of the following exception:

     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     binascii.Error: decoding with 'hex' codec failed (Error: Non-hexadecimal digit found)

     >>> codecs.encode("hello", "bz2")
     Traceback (most recent call last):
       File "/usr/lib/python3.4/encodings/bz2_codec.py", line 17, in bz2_encode
         return (bz2.compress(input), len(input))
       File "/usr/lib/python3.4/bz2.py", line 498, in compress
         return comp.compress(data) + comp.flush()
     TypeError: 'str' does not support the buffer interface

     The above exception was the direct cause of the following exception:

     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: encoding with 'bz2' codec failed (TypeError: 'str' does not support the buffer interface)

Finally, as the examples above show, these improvements have permitted
the restoration of the convenience aliases for the non-Unicode codecs
that were themselves restored in Python 3.2.  This means that encoding
binary data to and from its hexadecimal representation (for example) can
now be written as:

     >>> from codecs import encode, decode
     >>> encode(b"hello", "hex")
     b'68656c6c6f'
     >>> decode(b"68656c6c6f", "hex")
     b'hello'

The binary and text transforms provided in the standard library are
detailed in *note Binary Transforms: 7f8. and *note Text Transforms:
7f9.

(Contributed by Nick Coghlan in bpo-7475(1), bpo-17827(2), bpo-17828(3)
and bpo-19619(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7475

   (2) https://bugs.python.org/issue17827

   (3) https://bugs.python.org/issue17828

   (4) https://bugs.python.org/issue19619


File: python.info,  Node: PEP 451 A ModuleSpec Type for the Import System,  Next: Other Language Changes<5>,  Prev: Improvements to Codec Handling,  Up: New Features<5>

1.5.2.6 PEP 451: A ModuleSpec Type for the Import System
........................................................

PEP 451(1) provides an encapsulation of the information about a module
that the import machinery will use to load it (that is, a module
specification).  This helps simplify both the import implementation and
several import-related APIs.  The change is also a stepping stone for
several future import-related improvements(2).

The public-facing changes from the PEP are entirely backward-compatible.
Furthermore, they should be transparent to everyone but importer
authors.  Key finder and loader methods have been deprecated, but they
will continue working.  New importers should use the new methods
described in the PEP. Existing importers should be updated to implement
the new methods.  See the *note Deprecated: 7fb. section for a list of
methods that should be replaced and their replacements.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0451

   (2) 
https://mail.python.org/pipermail/python-dev/2013-November/130111.html


File: python.info,  Node: Other Language Changes<5>,  Prev: PEP 451 A ModuleSpec Type for the Import System,  Up: New Features<5>

1.5.2.7 Other Language Changes
..............................

Some smaller changes made to the core Python language are:

   * Unicode database updated to UCD version 6.3.

   * *note min(): 7fd. and *note max(): 7fe. now accept a `default'
     keyword-only argument that can be used to specify the value they
     return if the iterable they are evaluating has no elements.
     (Contributed by Julian Berman in bpo-18111(1).)

   * Module objects are now *note weakref: 128.’able.

   * Module ‘__file__’ attributes (and related values) should now always
     contain absolute paths by default, with the sole exception of
     ‘__main__.__file__’ when a script has been executed directly using
     a relative path.  (Contributed by Brett Cannon in bpo-18416(2).)

   * All the UTF-* codecs (except UTF-7) now reject surrogates during
     both encoding and decoding unless the ‘surrogatepass’ error handler
     is used, with the exception of the UTF-16 decoder (which accepts
     valid surrogate pairs) and the UTF-16 encoder (which produces them
     while encoding non-BMP characters).  (Contributed by Victor
     Stinner, Kang-Hao (Kenny) Lu and Serhiy Storchaka in bpo-12892(3).)

   * New German EBCDIC *note codec: 683. ‘cp273’.  (Contributed by
     Michael Bierenfeld and Andrew Kuchling in bpo-1097797(4).)

   * New Ukrainian *note codec: 683. ‘cp1125’.  (Contributed by Serhiy
     Storchaka in bpo-19668(5).)

   * *note bytes: 326.join() and *note bytearray: 327.join() now accept
     arbitrary buffer objects as arguments.  (Contributed by Antoine
     Pitrou in bpo-15958(6).)

   * The *note int: 184. constructor now accepts any object that has an
     ‘__index__’ method for its `base' argument.  (Contributed by Mark
     Dickinson in bpo-16772(7).)

   * Frame objects now have a *note clear(): 7ff. method that clears all
     references to local variables from the frame.  (Contributed by
     Antoine Pitrou in bpo-17934(8).)

   * *note memoryview: 25a. is now registered as a *note Sequence: 1f,
     and supports the *note reversed(): 18e. builtin.  (Contributed by
     Nick Coghlan and Claudiu Popa in bpo-18690(9) and bpo-19078(10).)

   * Signatures reported by *note help(): 567. have been modified and
     improved in several cases as a result of the introduction of
     Argument Clinic and other changes to the *note inspect: a0. and
     *note pydoc: d9. modules.

   * *note __length_hint__(): 800. is now part of the formal language
     specification (see PEP 424(11)).  (Contributed by Armin Ronacher in
     bpo-16148(12).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18111

   (2) https://bugs.python.org/issue18416

   (3) https://bugs.python.org/issue12892

   (4) https://bugs.python.org/issue1097797

   (5) https://bugs.python.org/issue19668

   (6) https://bugs.python.org/issue15958

   (7) https://bugs.python.org/issue16772

   (8) https://bugs.python.org/issue17934

   (9) https://bugs.python.org/issue18690

   (10) https://bugs.python.org/issue19078

   (11) https://www.python.org/dev/peps/pep-0424

   (12) https://bugs.python.org/issue16148


File: python.info,  Node: New Modules<5>,  Next: Improved Modules<5>,  Prev: New Features<5>,  Up: What’s New In Python 3 4

1.5.3 New Modules
-----------------

* Menu:

* asyncio: asyncio<6>.
* ensurepip::
* enum: enum<5>.
* pathlib: pathlib<5>.
* selectors: selectors<2>.
* statistics: statistics<3>.
* tracemalloc: tracemalloc<3>.


File: python.info,  Node: asyncio<6>,  Next: ensurepip,  Up: New Modules<5>

1.5.3.1 asyncio
...............

The new *note asyncio: a. module (defined in PEP 3156(1)) provides a
standard pluggable event loop model for Python, providing solid
asynchronous IO support in the standard library, and making it easier
for other event loop implementations to interoperate with the standard
library and each other.

For Python 3.4, this module is considered a *note provisional API: 33d.

See also
........

PEP 3156(2) – Asynchronous IO Support Rebooted: the “asyncio” Module

     PEP written and implementation led by Guido van Rossum.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3156

   (2) https://www.python.org/dev/peps/pep-3156


File: python.info,  Node: ensurepip,  Next: enum<5>,  Prev: asyncio<6>,  Up: New Modules<5>

1.5.3.2 ensurepip
.................

The new *note ensurepip: 7a. module is the primary infrastructure for
the PEP 453(1) implementation.  In the normal course of events end users
will not need to interact with this module, but it can be used to
manually bootstrap ‘pip’ if the automated bootstrapping into an
installation or virtual environment was declined.

*note ensurepip: 7a. includes a bundled copy of ‘pip’, up-to-date as of
the first release candidate of the release of CPython with which it
ships (this applies to both maintenance releases and feature releases).
‘ensurepip’ does not access the internet.  If the installation has
Internet access, after ‘ensurepip’ is run the bundled ‘pip’ can be used
to upgrade ‘pip’ to a more recent release than the bundled one.  (Note
that such an upgraded version of ‘pip’ is considered to be a separately
installed package and will not be removed if Python is uninstalled.)

The module is named `ensure'pip because if called when ‘pip’ is already
installed, it does nothing.  It also has an ‘--upgrade’ option that will
cause it to install the bundled copy of ‘pip’ if the existing installed
version of ‘pip’ is older than the bundled copy.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0453


File: python.info,  Node: enum<5>,  Next: pathlib<5>,  Prev: ensurepip,  Up: New Modules<5>

1.5.3.3 enum
............

The new *note enum: 7b. module (defined in PEP 435(1)) provides a
standard implementation of enumeration types, allowing other modules
(such as *note socket: ef.) to provide more informative error messages
and better debugging support by replacing opaque integer constants with
backwards compatible enumeration values.

See also
........

PEP 435(2) – Adding an Enum type to the Python standard library

     PEP written by Barry Warsaw, Eli Bendersky and Ethan Furman,
     implemented by Ethan Furman.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0435

   (2) https://www.python.org/dev/peps/pep-0435


File: python.info,  Node: pathlib<5>,  Next: selectors<2>,  Prev: enum<5>,  Up: New Modules<5>

1.5.3.4 pathlib
...............

The new *note pathlib: c8. module offers classes representing filesystem
paths with semantics appropriate for different operating systems.  Path
classes are divided between `pure paths', which provide purely
computational operations without I/O, and `concrete paths', which
inherit from pure paths but also provide I/O operations.

For Python 3.4, this module is considered a *note provisional API: 33d.

See also
........

PEP 428(1) – The pathlib module – object-oriented filesystem paths

     PEP written and implemented by Antoine Pitrou.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0428


File: python.info,  Node: selectors<2>,  Next: statistics<3>,  Prev: pathlib<5>,  Up: New Modules<5>

1.5.3.5 selectors
.................

The new *note selectors: e6. module (created as part of implementing PEP
3156(1)) allows high-level and efficient I/O multiplexing, built upon
the *note select: e5. module primitives.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3156


File: python.info,  Node: statistics<3>,  Next: tracemalloc<3>,  Prev: selectors<2>,  Up: New Modules<5>

1.5.3.6 statistics
..................

The new *note statistics: f5. module (defined in PEP 450(1)) offers some
core statistics functionality directly in the standard library.  This
module supports calculation of the mean, median, mode, variance and
standard deviation of a data series.

See also
........

PEP 450(2) – Adding A Statistics Module To The Standard Library

     PEP written and implemented by Steven D’Aprano

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0450

   (2) https://www.python.org/dev/peps/pep-0450


File: python.info,  Node: tracemalloc<3>,  Prev: statistics<3>,  Up: New Modules<5>

1.5.3.7 tracemalloc
...................

The new *note tracemalloc: 114. module (defined in PEP 454(1)) is a
debug tool to trace memory blocks allocated by Python.  It provides the
following information:

   * Trace where an object was allocated

   * Statistics on allocated memory blocks per filename and per line
     number: total size, number and average size of allocated memory
     blocks

   * Compute the differences between two snapshots to detect memory
     leaks

See also
........

PEP 454(2) – Add a new tracemalloc module to trace Python memory allocations

     PEP written and implemented by Victor Stinner

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0454

   (2) https://www.python.org/dev/peps/pep-0454


File: python.info,  Node: Improved Modules<5>,  Next: CPython Implementation Changes,  Prev: New Modules<5>,  Up: What’s New In Python 3 4

1.5.4 Improved Modules
----------------------

* Menu:

* abc::
* aifc: aifc<2>.
* argparse: argparse<3>.
* audioop::
* base64::
* collections: collections<6>.
* colorsys::
* contextlib: contextlib<4>.
* dbm: dbm<5>.
* dis: dis<2>.
* doctest: doctest<2>.
* email: email<3>.
* filecmp::
* functools: functools<4>.
* gc: gc<3>.
* glob: glob<2>.
* hashlib: hashlib<2>.
* hmac: hmac<2>.
* html::
* http: http<2>.
* idlelib and IDLE: idlelib and IDLE<4>.
* importlib: importlib<6>.
* inspect: inspect<4>.
* ipaddress: ipaddress<3>.
* logging: logging<5>.
* marshal::
* mmap: mmap<2>.
* multiprocessing: multiprocessing<5>.
* operator: operator<2>.
* os: os<6>.
* pdb: pdb<3>.
* pickle: pickle<4>.
* plistlib: plistlib<2>.
* poplib: poplib<2>.
* pprint: pprint<2>.
* pty::
* pydoc: pydoc<3>.
* re: re<5>.
* resource::
* select::
* shelve::
* shutil: shutil<3>.
* smtpd: smtpd<2>.
* smtplib: smtplib<2>.
* socket: socket<6>.
* sqlite3: sqlite3<4>.
* ssl: ssl<7>.
* stat::
* struct: struct<2>.
* subprocess: subprocess<4>.
* sunau: sunau<2>.
* sys: sys<6>.
* tarfile: tarfile<3>.
* textwrap::
* threading: threading<4>.
* traceback: traceback<3>.
* types: types<3>.
* urllib: urllib<2>.
* unittest: unittest<4>.
* venv: venv<4>.
* wave: wave<2>.
* weakref: weakref<2>.
* xml.etree: xml etree<2>.
* zipfile: zipfile<4>.


File: python.info,  Node: abc,  Next: aifc<2>,  Up: Improved Modules<5>

1.5.4.1 abc
...........

New function *note abc.get_cache_token(): 80b. can be used to know when
to invalidate caches that are affected by changes in the object graph.
(Contributed by Łukasz Langa in bpo-16832(1).)

New class *note ABC: 80c. has *note ABCMeta: 80d. as its meta class.
Using ‘ABC’ as a base class has essentially the same effect as
specifying ‘metaclass=abc.ABCMeta’, but is simpler to type and easier to
read.  (Contributed by Bruno Dupuis in bpo-16049(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16832

   (2) https://bugs.python.org/issue16049


File: python.info,  Node: aifc<2>,  Next: argparse<3>,  Prev: abc,  Up: Improved Modules<5>

1.5.4.2 aifc
............

The *note getparams(): 80f. method now returns a namedtuple rather than
a plain tuple.  (Contributed by Claudiu Popa in bpo-17818(1).)

*note aifc.open(): 450. now supports the context management protocol:
when used in a *note with: 6dd. block, the *note close(): 810. method of
the returned object will be called automatically at the end of the
block.  (Contributed by Serhiy Storchacha in bpo-16486(2).)

The *note writeframesraw(): 811. and *note writeframes(): 812. methods
now accept any *note bytes-like object: 5dd.  (Contributed by Serhiy
Storchaka in bpo-8311(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17818

   (2) https://bugs.python.org/issue16486

   (3) https://bugs.python.org/issue8311


File: python.info,  Node: argparse<3>,  Next: audioop,  Prev: aifc<2>,  Up: Improved Modules<5>

1.5.4.3 argparse
................

The *note FileType: 814. class now accepts `encoding' and `errors'
arguments, which are passed through to *note open(): 4e5.  (Contributed
by Lucas Maystre in bpo-11175(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11175


File: python.info,  Node: audioop,  Next: base64,  Prev: argparse<3>,  Up: Improved Modules<5>

1.5.4.4 audioop
...............

*note audioop: d. now supports 24-bit samples.  (Contributed by Serhiy
Storchaka in bpo-12866(1).)

New *note byteswap(): 816. function converts big-endian samples to
little-endian and vice versa.  (Contributed by Serhiy Storchaka in
bpo-19641(2).)

All *note audioop: d. functions now accept any *note bytes-like object:
5dd.  Strings are not accepted: they didn’t work before, now they raise
an error right away.  (Contributed by Serhiy Storchaka in bpo-16685(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12866

   (2) https://bugs.python.org/issue19641

   (3) https://bugs.python.org/issue16685


File: python.info,  Node: base64,  Next: collections<6>,  Prev: audioop,  Up: Improved Modules<5>

1.5.4.5 base64
..............

The encoding and decoding functions in *note base64: e. now accept any
*note bytes-like object: 5dd. in cases where it previously required a
*note bytes: 326. or *note bytearray: 327. instance.  (Contributed by
Nick Coghlan in bpo-17839(1).)

New functions *note a85encode(): 818, *note a85decode(): 819, *note
b85encode(): 81a, and *note b85decode(): 81b. provide the ability to
encode and decode binary data from and to ‘Ascii85’ and the
git/mercurial ‘Base85’ formats, respectively.  The ‘a85’ functions have
options that can be used to make them compatible with the variants of
the ‘Ascii85’ encoding, including the Adobe variant.  (Contributed by
Martin Morrison, the Mercurial project, Serhiy Storchaka, and Antoine
Pitrou in bpo-17618(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17839

   (2) https://bugs.python.org/issue17618


File: python.info,  Node: collections<6>,  Next: colorsys,  Prev: base64,  Up: Improved Modules<5>

1.5.4.6 collections
...................

The *note ChainMap.new_child(): 81d. method now accepts an `m' argument
specifying the child map to add to the chain.  This allows an existing
mapping and/or a custom mapping type to be used for the child.
(Contributed by Vinay Sajip in bpo-16613(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16613


File: python.info,  Node: colorsys,  Next: contextlib<4>,  Prev: collections<6>,  Up: Improved Modules<5>

1.5.4.7 colorsys
................

The number of digits in the coefficients for the RGB — YIQ conversions
have been expanded so that they match the FCC NTSC versions.  The change
in results should be less than 1% and may better match results found
elsewhere.  (Contributed by Brian Landers and Serhiy Storchaka in
bpo-14323(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14323


File: python.info,  Node: contextlib<4>,  Next: dbm<5>,  Prev: colorsys,  Up: Improved Modules<5>

1.5.4.8 contextlib
..................

The new *note contextlib.suppress: 820. context manager helps to clarify
the intent of code that deliberately suppresses exceptions from a single
statement.  (Contributed by Raymond Hettinger in bpo-15806(1) and Zero
Piraeus in bpo-19266(2).)

The new *note contextlib.redirect_stdout(): 6b6. context manager makes
it easier for utility scripts to handle inflexible APIs that write their
output to *note sys.stdout: 303. and don’t provide any options to
redirect it.  Using the context manager, the *note sys.stdout: 303.
output can be redirected to any other stream or, in conjunction with
*note io.StringIO: 821, to a string.  The latter can be especially
useful, for example, to capture output from a function that was written
to implement a command line interface.  It is recommended only for
utility scripts because it affects the global state of *note sys.stdout:
303.  (Contributed by Raymond Hettinger in bpo-15805(3).)

The *note contextlib: 24. documentation has also been updated to include
a *note discussion: 822. of the differences between single use, reusable
and reentrant context managers.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15806

   (2) https://bugs.python.org/issue19266

   (3) https://bugs.python.org/issue15805


File: python.info,  Node: dbm<5>,  Next: dis<2>,  Prev: contextlib<4>,  Up: Improved Modules<5>

1.5.4.9 dbm
...........

*note dbm.open(): 824. objects now support the context management
protocol.  When used in a *note with: 6dd. statement, the ‘close’ method
of the database object will be called automatically at the end of the
block.  (Contributed by Claudiu Popa and Nick Coghlan in bpo-19282(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19282


File: python.info,  Node: dis<2>,  Next: doctest<2>,  Prev: dbm<5>,  Up: Improved Modules<5>

1.5.4.10 dis
............

Functions *note show_code(): 826, *note dis(): 379, *note distb(): 827,
and *note disassemble(): 828. now accept a keyword-only `file' argument
that controls where they write their output.

The *note dis: 38. module is now built around an *note Instruction: 829.
class that provides object oriented access to the details of each
individual bytecode operation.

A new method, *note get_instructions(): 82a, provides an iterator that
emits the Instruction stream for a given piece of Python code.  Thus it
is now possible to write a program that inspects and manipulates a
bytecode object in ways different from those provided by the *note dis:
38. module itself.  For example:

     >>> import dis
     >>> for instr in dis.get_instructions(lambda x: x + 1):
     ...     print(instr.opname)
     LOAD_FAST
     LOAD_CONST
     BINARY_ADD
     RETURN_VALUE

The various display tools in the *note dis: 38. module have been
rewritten to use these new components.

In addition, a new application-friendly class *note Bytecode: 82b.
provides an object-oriented API for inspecting bytecode in both in
human-readable form and for iterating over instructions.  The *note
Bytecode: 82b. constructor takes the same arguments that
‘get_instruction()’ does (plus an optional `current_offset'), and the
resulting object can be iterated to produce *note Instruction: 829.
objects.  But it also has a *note dis: 82c. method, equivalent to
calling *note dis: 379. on the constructor argument, but returned as a
multi-line string:

     >>> bytecode = dis.Bytecode(lambda x: x + 1, current_offset=3)
     >>> for instr in bytecode:
     ...     print('{} ({})'.format(instr.opname, instr.opcode))
     LOAD_FAST (124)
     LOAD_CONST (100)
     BINARY_ADD (23)
     RETURN_VALUE (83)
     >>> bytecode.dis().splitlines()
     ['  1           0 LOAD_FAST                0 (x)',
      '      -->     3 LOAD_CONST               1 (1)',
      '              6 BINARY_ADD',
      '              7 RETURN_VALUE']

*note Bytecode: 82b. also has a class method, *note from_traceback():
82d, that provides the ability to manipulate a traceback (that is,
‘print(Bytecode.from_traceback(tb).dis())’ is equivalent to
‘distb(tb)’).

(Contributed by Nick Coghlan, Ryan Kelly and Thomas Kluyver in
bpo-11816(1) and Claudiu Popa in bpo-17916(2).)

New function *note stack_effect(): 82e. computes the effect on the
Python stack of a given opcode and argument, information that is not
otherwise available.  (Contributed by Larry Hastings in bpo-19722(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11816

   (2) https://bugs.python.org/issue17916

   (3) https://bugs.python.org/issue19722


File: python.info,  Node: doctest<2>,  Next: email<3>,  Prev: dis<2>,  Up: Improved Modules<5>

1.5.4.11 doctest
................

A new *note option flag: 830, *note FAIL_FAST: 831, halts test running
as soon as the first failure is detected.  (Contributed by R. David
Murray and Daniel Urban in bpo-16522(1).)

The *note doctest: 67. command line interface now uses *note argparse:
6, and has two new options, ‘-o’ and ‘-f’.  ‘-o’ allows *note doctest
options: 830. to be specified on the command line, and ‘-f’ is a
shorthand for ‘-o FAIL_FAST’ (to parallel the similar option supported
by the *note unittest: 11b. CLI). (Contributed by R. David Murray in
bpo-11390(2).)

*note doctest: 67. will now find doctests in extension module ‘__doc__’
strings.  (Contributed by Zachary Ware in bpo-3158(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16522

   (2) https://bugs.python.org/issue11390

   (3) https://bugs.python.org/issue3158


File: python.info,  Node: email<3>,  Next: filecmp,  Prev: doctest<2>,  Up: Improved Modules<5>

1.5.4.12 email
..............

*note as_string(): 833. now accepts a `policy' argument to override the
default policy of the message when generating a string representation of
it.  This means that ‘as_string’ can now be used in more circumstances,
instead of having to create and use a *note generator: 6e. in order to
pass formatting parameters to its ‘flatten’ method.  (Contributed by R.
David Murray in bpo-18600(1).)

New method *note as_bytes(): 834. added to produce a bytes
representation of the message in a fashion similar to how ‘as_string’
produces a string representation.  It does not accept the `maxheaderlen'
argument, but does accept the `unixfrom' and `policy' arguments.  The
*note Message: 536. *note __bytes__(): 835. method calls it, meaning
that ‘bytes(mymsg)’ will now produce the intuitive result: a bytes
object containing the fully formatted message.  (Contributed by R. David
Murray in bpo-18600(2).)

The *note Message.set_param(): 836. message now accepts a `replace'
keyword argument.  When specified, the associated header will be updated
without changing its location in the list of headers.  For backward
compatibility, the default is ‘False’.  (Contributed by R. David Murray
in bpo-18891(3).)  A pair of new subclasses of *note Message: 536. have
been added (*note EmailMessage: 537. and *note MIMEPart: 837.), along
with a new sub-module, *note contentmanager: 6b. and a new *note policy:
75. attribute *note content_manager: 838.  All documentation is
currently in the new module, which is being added as part of email’s new
*note provisional API: 33d.  These classes provide a number of new
methods that make extracting content from and inserting content into
email messages much easier.  For details, see the *note contentmanager:
6b. documentation and the *note email; Examples: 839.  These API
additions complete the bulk of the work that was planned as part of the
email6 project.  The currently provisional API is scheduled to become
final in Python 3.5 (possibly with a few minor additions in the area of
error handling).  (Contributed by R. David Murray in bpo-18891(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18600

   (2) https://bugs.python.org/issue18600

   (3) https://bugs.python.org/issue18891

   (4) https://bugs.python.org/issue18891


File: python.info,  Node: filecmp,  Next: functools<4>,  Prev: email<3>,  Up: Improved Modules<5>

1.5.4.13 filecmp
................

A new *note clear_cache(): 83b. function provides the ability to clear
the *note filecmp: 7f. comparison cache, which uses *note os.stat():
1ef. information to determine if the file has changed since the last
compare.  This can be used, for example, if the file might have been
changed and re-checked in less time than the resolution of a particular
filesystem’s file modification time field.  (Contributed by Mark Levitt
in bpo-18149(1).)

New module attribute *note DEFAULT_IGNORES: 83c. provides the list of
directories that are used as the default value for the `ignore'
parameter of the *note dircmp(): 83d. function.  (Contributed by Eli
Bendersky in bpo-15442(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18149

   (2) https://bugs.python.org/issue15442


File: python.info,  Node: functools<4>,  Next: gc<3>,  Prev: filecmp,  Up: Improved Modules<5>

1.5.4.14 functools
..................

The new *note partialmethod(): 29a. descriptor brings partial argument
application to descriptors, just as *note partial(): 7bc. provides for
normal callables.  The new descriptor also makes it easier to get
arbitrary callables (including *note partial(): 7bc. instances) to
behave like normal instance methods when included in a class definition.
(Contributed by Alon Horev and Nick Coghlan in bpo-4331(1).)  The new
*note singledispatch(): 37f. decorator brings support for
single-dispatch generic functions to the Python standard library.  Where
object oriented programming focuses on grouping multiple operations on a
common set of data into a class, a generic function focuses on grouping
multiple implementations of an operation that allows it to work with
`different' kinds of data.

See also
........

PEP 443(2) – Single-dispatch generic functions

     PEP written and implemented by Łukasz Langa.

*note total_ordering(): 83f. now supports a return value of *note
NotImplemented: 840. from the underlying comparison function.
(Contributed by Katie Miller in bpo-10042(3).)

A pure-python version of the *note partial(): 7bc. function is now in
the stdlib; in CPython it is overridden by the C accelerated version,
but it is available for other implementations to use.  (Contributed by
Brian Thorne in bpo-12428(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4331

   (2) https://www.python.org/dev/peps/pep-0443

   (3) https://bugs.python.org/issue10042

   (4) https://bugs.python.org/issue12428


File: python.info,  Node: gc<3>,  Next: glob<2>,  Prev: functools<4>,  Up: Improved Modules<5>

1.5.4.15 gc
...........

New function *note get_stats(): 842. returns a list of three
per-generation dictionaries containing the collections statistics since
interpreter startup.  (Contributed by Antoine Pitrou in bpo-16351(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16351


File: python.info,  Node: glob<2>,  Next: hashlib<2>,  Prev: gc<3>,  Up: Improved Modules<5>

1.5.4.16 glob
.............

A new function *note escape(): 844. provides a way to escape special
characters in a filename so that they do not become part of the globbing
expansion but are instead matched literally.  (Contributed by Serhiy
Storchaka in bpo-8402(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8402


File: python.info,  Node: hashlib<2>,  Next: hmac<2>,  Prev: glob<2>,  Up: Improved Modules<5>

1.5.4.17 hashlib
................

A new *note hashlib.pbkdf2_hmac(): 7da. function provides the PKCS#5
password-based key derivation function 2(1).  (Contributed by Christian
Heimes in bpo-18582(2).)

The *note name: 846. attribute of *note hashlib: 8d. hash objects is now
a formally supported interface.  It has always existed in CPython’s
*note hashlib: 8d. (although it did not return lower case names for all
supported hashes), but it was not a public interface and so some other
Python implementations have not previously supported it.  (Contributed
by Jason R. Coombs in bpo-18532(3).)

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/PBKDF2

   (2) https://bugs.python.org/issue18582

   (3) https://bugs.python.org/issue18532


File: python.info,  Node: hmac<2>,  Next: html,  Prev: hashlib<2>,  Up: Improved Modules<5>

1.5.4.18 hmac
.............

*note hmac: 8f. now accepts ‘bytearray’ as well as ‘bytes’ for the `key'
argument to the *note new(): 848. function, and the `msg' parameter to
both the *note new(): 848. function and the *note update(): 849. method
now accepts any type supported by the *note hashlib: 8d. module.
(Contributed by Jonas Borgström in bpo-18240(1).)

The `digestmod' argument to the *note hmac.new(): 848. function may now
be any hash digest name recognized by *note hashlib: 8d.  In addition,
the current behavior in which the value of `digestmod' defaults to ‘MD5’
is deprecated: in a future version of Python there will be no default
value.  (Contributed by Christian Heimes in bpo-17276(2).)

With the addition of *note block_size: 84a. and *note name: 84b.
attributes (and the formal documentation of the *note digest_size: 84c.
attribute), the *note hmac: 8f. module now conforms fully to the PEP
247(3) API. (Contributed by Christian Heimes in bpo-18775(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18240

   (2) https://bugs.python.org/issue17276

   (3) https://www.python.org/dev/peps/pep-0247

   (4) https://bugs.python.org/issue18775


File: python.info,  Node: html,  Next: http<2>,  Prev: hmac<2>,  Up: Improved Modules<5>

1.5.4.19 html
.............

New function *note unescape(): 84e. function converts HTML5 character
references to the corresponding Unicode characters.  (Contributed by
Ezio Melotti in bpo-2927(1).)

*note HTMLParser: 7b3. accepts a new keyword argument `convert_charrefs'
that, when ‘True’, automatically converts all character references.  For
backward-compatibility, its value defaults to ‘False’, but it will
change to ‘True’ in a future version of Python, so you are invited to
set it explicitly and update your code to use this new feature.
(Contributed by Ezio Melotti in bpo-13633(2).)

The `strict' argument of *note HTMLParser: 7b3. is now deprecated.
(Contributed by Ezio Melotti in bpo-15114(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2927

   (2) https://bugs.python.org/issue13633

   (3) https://bugs.python.org/issue15114


File: python.info,  Node: http<2>,  Next: idlelib and IDLE<4>,  Prev: html,  Up: Improved Modules<5>

1.5.4.20 http
.............

*note send_error(): 850. now accepts an optional additional `explain'
parameter which can be used to provide an extended error description,
overriding the hardcoded default if there is one.  This extended error
description will be formatted using the ‘error_message_format’ attribute
and sent as the body of the error response.  (Contributed by Karl Cow in
bpo-12921(1).)

The *note http.server: 97. *note command line interface: 851. now has a
‘-b/--bind’ option that causes the server to listen on a specific
address.  (Contributed by Malte Swart in bpo-17764(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12921

   (2) https://bugs.python.org/issue17764


File: python.info,  Node: idlelib and IDLE<4>,  Next: importlib<6>,  Prev: http<2>,  Up: Improved Modules<5>

1.5.4.21 idlelib and IDLE
.........................

Since idlelib implements the IDLE shell and editor and is not intended
for import by other programs, it gets improvements with every release.
See ‘Lib/idlelib/NEWS.txt’ for a cumulative list of changes since 3.3.0,
as well as changes made in future 3.4.x releases.  This file is also
available from the IDLE Help ‣ About IDLE dialog.


File: python.info,  Node: importlib<6>,  Next: inspect<4>,  Prev: idlelib and IDLE<4>,  Up: Improved Modules<5>

1.5.4.22 importlib
..................

The *note InspectLoader: 854. ABC defines a new method, *note
source_to_code(): 6e3. that accepts source data and a path and returns a
code object.  The default implementation is equivalent to ‘compile(data,
path, 'exec', dont_inherit=True)’.  (Contributed by Eric Snow and Brett
Cannon in bpo-15627(1).)

*note InspectLoader: 854. also now has a default implementation for the
*note get_code(): 855. method.  However, it will normally be desirable
to override the default implementation for performance reasons.
(Contributed by Brett Cannon in bpo-18072(2).)

The *note reload(): 38e. function has been moved from *note imp: 9a. to
*note importlib: 9b. as part of the *note imp: 9a. module deprecation.
(Contributed by Berker Peksag in bpo-18193(3).)

*note importlib.util: 9f. now has a *note MAGIC_NUMBER: 856. attribute
providing access to the bytecode version number.  This replaces the
*note get_magic(): 857. function in the deprecated *note imp: 9a.
module.  (Contributed by Brett Cannon in bpo-18192(4).)

New *note importlib.util: 9f. functions *note cache_from_source(): 54c.
and *note source_from_cache(): 54d. replace the same-named functions in
the deprecated *note imp: 9a. module.  (Contributed by Brett Cannon in
bpo-18194(5).)

The *note importlib: 9b. bootstrap ‘NamespaceLoader’ now conforms to the
*note InspectLoader: 854. ABC, which means that ‘runpy’ and ‘python -m’
can now be used with namespace packages.  (Contributed by Brett Cannon
in bpo-18058(6).)

*note importlib.util: 9f. has a new function *note decode_source(): 858.
that decodes source from bytes using universal newline processing.  This
is useful for implementing *note InspectLoader.get_source(): 859.
methods.

*note importlib.machinery.ExtensionFileLoader: 54b. now has a *note
get_filename(): 85a. method.  This was inadvertently omitted in the
original implementation.  (Contributed by Eric Snow in bpo-19152(7).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15627

   (2) https://bugs.python.org/issue18072

   (3) https://bugs.python.org/issue18193

   (4) https://bugs.python.org/issue18192

   (5) https://bugs.python.org/issue18194

   (6) https://bugs.python.org/issue18058

   (7) https://bugs.python.org/issue19152


File: python.info,  Node: inspect<4>,  Next: ipaddress<3>,  Prev: importlib<6>,  Up: Improved Modules<5>

1.5.4.23 inspect
................

The *note inspect: a0. module now offers a basic *note command line
interface: 85c. to quickly display source code and other information for
modules, classes and functions.  (Contributed by Claudiu Popa and Nick
Coghlan in bpo-18626(1).)

*note unwrap(): 85d. makes it easy to unravel wrapper function chains
created by *note functools.wraps(): 85e. (and any other API that sets
the ‘__wrapped__’ attribute on a wrapper function).  (Contributed by
Daniel Urban, Aaron Iles and Nick Coghlan in bpo-13266(2).)

As part of the implementation of the new *note enum: 7b. module, the
*note inspect: a0. module now has substantially better support for
custom ‘__dir__’ methods and dynamic class attributes provided through
metaclasses.  (Contributed by Ethan Furman in bpo-18929(3) and
bpo-19030(4).)

*note getfullargspec(): 552. and *note getargspec(): 551. now use the
*note signature(): 550. API. This allows them to support a much broader
range of callables, including those with ‘__signature__’ attributes,
those with metadata provided by argument clinic, *note
functools.partial(): 7bc. objects and more.  Note that, unlike *note
signature(): 550, these functions still ignore ‘__wrapped__’ attributes,
and report the already bound first argument for bound methods, so it is
still necessary to update your code to use *note signature(): 550.
directly if those features are desired.  (Contributed by Yury Selivanov
in bpo-17481(5).)

*note signature(): 550. now supports duck types of CPython functions,
which adds support for functions compiled with Cython.  (Contributed by
Stefan Behnel and Yury Selivanov in bpo-17159(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18626

   (2) https://bugs.python.org/issue13266

   (3) https://bugs.python.org/issue18929

   (4) https://bugs.python.org/issue19030

   (5) https://bugs.python.org/issue17481

   (6) https://bugs.python.org/issue17159


File: python.info,  Node: ipaddress<3>,  Next: logging<5>,  Prev: inspect<4>,  Up: Improved Modules<5>

1.5.4.24 ipaddress
..................

*note ipaddress: a2. was added to the standard library in Python 3.3 as
a *note provisional API: 33d.  With the release of Python 3.4, this
qualification has been removed: *note ipaddress: a2. is now considered a
stable API, covered by the normal standard library requirements to
maintain backwards compatibility.

A new *note is_global: 860. property is ‘True’ if an address is globally
routeable.  (Contributed by Peter Moody in bpo-17400(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17400


File: python.info,  Node: logging<5>,  Next: marshal,  Prev: ipaddress<3>,  Up: Improved Modules<5>

1.5.4.25 logging
................

The *note TimedRotatingFileHandler: 862. has a new `atTime' parameter
that can be used to specify the time of day when rollover should happen.
(Contributed by Ronald Oussoren in bpo-9556(1).)

*note SocketHandler: 863. and *note DatagramHandler: 864. now support
Unix domain sockets (by setting `port' to ‘None’).  (Contributed by
Vinay Sajip in commit ce46195b56a9.)

*note fileConfig(): 39e. now accepts a *note
configparser.RawConfigParser: 865. subclass instance for the `fname'
parameter.  This facilitates using a configuration file when logging
configuration is just a part of the overall application configuration,
or where the application modifies the configuration before passing it to
*note fileConfig(): 39e.  (Contributed by Vinay Sajip in bpo-16110(2).)

Logging configuration data received from a socket via the *note
logging.config.listen(): 866. function can now be validated before being
processed by supplying a verification function as the argument to the
new `verify' keyword argument.  (Contributed by Vinay Sajip in
bpo-15452(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9556

   (2) https://bugs.python.org/issue16110

   (3) https://bugs.python.org/issue15452


File: python.info,  Node: marshal,  Next: mmap<2>,  Prev: logging<5>,  Up: Improved Modules<5>

1.5.4.26 marshal
................

The default *note marshal: b0. version has been bumped to 3.  The code
implementing the new version restores the Python2 behavior of recording
only one copy of interned strings and preserving the interning on
deserialization, and extends this “one copy” ability to any object type
(including handling recursive references).  This reduces both the size
of ‘.pyc’ files and the amount of memory a module occupies in memory
when it is loaded from a ‘.pyc’ (or ‘.pyo’) file.  (Contributed by
Kristján Valur Jónsson in bpo-16475(1), with additional speedups by
Antoine Pitrou in bpo-19219(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16475

   (2) https://bugs.python.org/issue19219


File: python.info,  Node: mmap<2>,  Next: multiprocessing<5>,  Prev: marshal,  Up: Improved Modules<5>

1.5.4.27 mmap
.............

mmap objects can now be *note weakref: 128.ed.  (Contributed by Valerie
Lambert in bpo-4885(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4885


File: python.info,  Node: multiprocessing<5>,  Next: operator<2>,  Prev: mmap<2>,  Up: Improved Modules<5>

1.5.4.28 multiprocessing
........................

On Unix two new *note start methods: 86a, ‘spawn’ and ‘forkserver’, have
been added for starting processes using *note multiprocessing: b7.
These make the mixing of processes with threads more robust, and the
‘spawn’ method matches the semantics that multiprocessing has always
used on Windows.  New function *note get_all_start_methods(): 86b.
reports all start methods available on the platform, *note
get_start_method(): 86c. reports the current start method, and *note
set_start_method(): 86d. sets the start method.  (Contributed by Richard
Oudkerk in bpo-8713(1).)

*note multiprocessing: b7. also now has the concept of a ‘context’,
which determines how child processes are created.  New function *note
get_context(): 86e. returns a context that uses a specified start
method.  It has the same API as the *note multiprocessing: b7. module
itself, so you can use it to create *note Pool: 86f.s and other objects
that will operate within that context.  This allows a framework and an
application or different parts of the same application to use
multiprocessing without interfering with each other.  (Contributed by
Richard Oudkerk in bpo-18999(2).)

Except when using the old `fork' start method, child processes no longer
inherit unneeded handles/file descriptors from their parents (part of
bpo-8713(3)).

*note multiprocessing: b7. now relies on *note runpy: e2. (which
implements the ‘-m’ switch) to initialise ‘__main__’ appropriately in
child processes when using the ‘spawn’ or ‘forkserver’ start methods.
This resolves some edge cases where combining multiprocessing, the ‘-m’
command line switch, and explicit relative imports could cause obscure
failures in child processes.  (Contributed by Nick Coghlan in
bpo-19946(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8713

   (2) https://bugs.python.org/issue18999

   (3) https://bugs.python.org/issue8713

   (4) https://bugs.python.org/issue19946


File: python.info,  Node: operator<2>,  Next: os<6>,  Prev: multiprocessing<5>,  Up: Improved Modules<5>

1.5.4.29 operator
.................

New function *note length_hint(): 871. provides an implementation of the
specification for how the *note __length_hint__(): 800. special method
should be used, as part of the PEP 424(1) formal specification of this
language feature.  (Contributed by Armin Ronacher in bpo-16148(2).)

There is now a pure-python version of the *note operator: c2. module
available for reference and for use by alternate implementations of
Python.  (Contributed by Zachary Ware in bpo-16694(3).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0424

   (2) https://bugs.python.org/issue16148

   (3) https://bugs.python.org/issue16694


File: python.info,  Node: os<6>,  Next: pdb<3>,  Prev: operator<2>,  Up: Improved Modules<5>

1.5.4.30 os
...........

There are new functions to get and set the *note inheritable flag: 7ee.
of a file descriptor (*note os.get_inheritable(): 7ef, *note
os.set_inheritable(): 7f0.) or a Windows handle (*note
os.get_handle_inheritable(): 7f1, *note os.set_handle_inheritable():
7f2.).

New function *note cpu_count(): 873. reports the number of CPUs
available on the platform on which Python is running (or ‘None’ if the
count can’t be determined).  The *note multiprocessing.cpu_count(): 874.
function is now implemented in terms of this function).  (Contributed by
Trent Nelson, Yogesh Chaudhari, Victor Stinner, and Charles-François
Natali in bpo-17914(1).)

*note os.path.samestat(): 875. is now available on the Windows platform
(and the *note os.path.samefile(): 876. implementation is now shared
between Unix and Windows).  (Contributed by Brian Curtin in
bpo-11939(2).)

*note os.path.ismount(): 1f8. now recognizes volumes mounted below a
drive root on Windows.  (Contributed by Tim Golden in bpo-9035(3).)

*note os.open(): 659. supports two new flags on platforms that provide
them, *note O_PATH: 877. (un-opened file descriptor), and *note
O_TMPFILE: 878. (unnamed temporary file; as of 3.4.0 release available
only on Linux systems with a kernel version of 3.11 or newer that have
uapi headers).  (Contributed by Christian Heimes in bpo-18673(4) and
Benjamin Peterson, respectively.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17914

   (2) https://bugs.python.org/issue11939

   (3) https://bugs.python.org/issue9035

   (4) https://bugs.python.org/issue18673


File: python.info,  Node: pdb<3>,  Next: pickle<4>,  Prev: os<6>,  Up: Improved Modules<5>

1.5.4.31 pdb
............

*note pdb: c9. has been enhanced to handle generators, *note yield: 18f,
and ‘yield from’ in a more useful fashion.  This is especially helpful
when debugging *note asyncio: a. based programs.  (Contributed by Andrew
Svetlov and Xavier de Gaye in bpo-16596(1).)

The ‘print’ command has been removed from *note pdb: c9, restoring
access to the Python *note print(): 87a. function from the pdb command
line.  Python2’s ‘pdb’ did not have a ‘print’ command; instead, entering
‘print’ executed the ‘print’ statement.  In Python3 ‘print’ was
mistakenly made an alias for the pdb *note p: 87b. command.  ‘p’,
however, prints the ‘repr’ of its argument, not the ‘str’ like the
Python2 ‘print’ command did.  Worse, the Python3 ‘pdb print’ command
shadowed the Python3 ‘print’ function, making it inaccessible at the
‘pdb’ prompt.  (Contributed by Connor Osborn in bpo-18764(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16596

   (2) https://bugs.python.org/issue18764


File: python.info,  Node: pickle<4>,  Next: plistlib<2>,  Prev: pdb<3>,  Up: Improved Modules<5>

1.5.4.32 pickle
...............

*note pickle: ca. now supports (but does not use by default) a new
pickle protocol, protocol 4.  This new protocol addresses a number of
issues that were present in previous protocols, such as the
serialization of nested classes, very large strings and containers, and
classes whose *note __new__(): 87d. method takes keyword-only arguments.
It also provides some efficiency improvements.

See also
........

PEP 3154(1) – Pickle protocol 4

     PEP written by Antoine Pitrou and implemented by Alexandre
     Vassalotti.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3154


File: python.info,  Node: plistlib<2>,  Next: poplib<2>,  Prev: pickle<4>,  Up: Improved Modules<5>

1.5.4.33 plistlib
.................

*note plistlib: cf. now has an API that is similar to the standard
pattern for stdlib serialization protocols, with new *note load(): 87f,
*note dump(): 880, *note loads(): 881, and *note dumps(): 882.
functions.  (The older API is now deprecated.)  In addition to the
already supported XML plist format (*note FMT_XML: 883.), it also now
supports the binary plist format (*note FMT_BINARY: 884.).  (Contributed
by Ronald Oussoren and others in bpo-14455(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14455


File: python.info,  Node: poplib<2>,  Next: pprint<2>,  Prev: plistlib<2>,  Up: Improved Modules<5>

1.5.4.34 poplib
...............

Two new methods have been added to *note poplib: d0.: *note capa(): 886,
which returns the list of capabilities advertised by the POP server, and
*note stls(): 887, which switches a clear-text POP3 session into an
encrypted POP3 session if the POP server supports it.  (Contributed by
Lorenzo Catucci in bpo-4473(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4473


File: python.info,  Node: pprint<2>,  Next: pty,  Prev: poplib<2>,  Up: Improved Modules<5>

1.5.4.35 pprint
...............

The *note pprint: d2. module’s *note PrettyPrinter: 889. class and its
*note pformat(): 88a, and *note pprint(): 211. functions have a new
option, `compact', that controls how the output is formatted.  Currently
setting `compact' to ‘True’ means that sequences will be printed with as
many sequence elements as will fit within `width' on each (indented)
line.  (Contributed by Serhiy Storchaka in bpo-19132(1).)

Long strings are now wrapped using Python’s normal line continuation
syntax.  (Contributed by Antoine Pitrou in bpo-17150(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19132

   (2) https://bugs.python.org/issue17150


File: python.info,  Node: pty,  Next: pydoc<3>,  Prev: pprint<2>,  Up: Improved Modules<5>

1.5.4.36 pty
............

*note pty.spawn(): 88c. now returns the status value from *note
os.waitpid(): 661. on the child process, instead of ‘None’.
(Contributed by Gregory P. Smith.)


File: python.info,  Node: pydoc<3>,  Next: re<5>,  Prev: pty,  Up: Improved Modules<5>

1.5.4.37 pydoc
..............

The *note pydoc: d9. module is now based directly on the *note
inspect.signature(): 550. introspection API, allowing it to provide
signature information for a wider variety of callable objects.  This
change also means that ‘__wrapped__’ attributes are now taken into
account when displaying help information.  (Contributed by Larry
Hastings in bpo-19674(1).)

The *note pydoc: d9. module no longer displays the ‘self’ parameter for
already bound methods.  Instead, it aims to always display the exact
current signature of the supplied callable.  (Contributed by Larry
Hastings in bpo-20710(2).)

In addition to the changes that have been made to *note pydoc: d9.
directly, its handling of custom ‘__dir__’ methods and various
descriptor behaviours has also been improved substantially by the
underlying changes in the *note inspect: a0. module.

As the *note help(): 567. builtin is based on *note pydoc: d9, the above
changes also affect the behaviour of *note help(): 567.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19674

   (2) https://bugs.python.org/issue20710


File: python.info,  Node: re<5>,  Next: resource,  Prev: pydoc<3>,  Up: Improved Modules<5>

1.5.4.38 re
...........

New *note fullmatch(): 88f. function and ‘regex.fullmatch()’ method
anchor the pattern at both ends of the string to match.  This provides a
way to be explicit about the goal of the match, which avoids a class of
subtle bugs where ‘$’ characters get lost during code changes or the
addition of alternatives to an existing regular expression.
(Contributed by Matthew Barnett in bpo-16203(1).)

The repr of *note regex objects: 890. now includes the pattern and the
flags; the repr of *note match objects: 891. now includes the start,
end, and the part of the string that matched.  (Contributed by Hugo
Lopes Tavares and Serhiy Storchaka in bpo-13592(2) and bpo-17087(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16203

   (2) https://bugs.python.org/issue13592

   (3) https://bugs.python.org/issue17087


File: python.info,  Node: resource,  Next: select,  Prev: re<5>,  Up: Improved Modules<5>

1.5.4.39 resource
.................

New *note prlimit(): 893. function, available on Linux platforms with a
kernel version of 2.6.36 or later and glibc of 2.13 or later, provides
the ability to query or set the resource limits for processes other than
the one making the call.  (Contributed by Christian Heimes in
bpo-16595(1).)

On Linux kernel version 2.6.36 or later, there are also some new Linux
specific constants: *note RLIMIT_MSGQUEUE: 894, *note RLIMIT_NICE: 895,
*note RLIMIT_RTPRIO: 896, *note RLIMIT_RTTIME: 897, and *note
RLIMIT_SIGPENDING: 898.  (Contributed by Christian Heimes in
bpo-19324(2).)

On FreeBSD version 9 and later, there some new FreeBSD specific
constants: *note RLIMIT_SBSIZE: 899, *note RLIMIT_SWAP: 89a, and *note
RLIMIT_NPTS: 89b.  (Contributed by Claudiu Popa in bpo-19343(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16595

   (2) https://bugs.python.org/issue19324

   (3) https://bugs.python.org/issue19343


File: python.info,  Node: select,  Next: shelve,  Prev: resource,  Up: Improved Modules<5>

1.5.4.40 select
...............

*note epoll: 89d. objects now support the context management protocol.
When used in a *note with: 6dd. statement, the *note close(): 89e.
method will be called automatically at the end of the block.
(Contributed by Serhiy Storchaka in bpo-16488(1).)

*note devpoll: 89f. objects now have *note fileno(): 8a0. and *note
close(): 8a1. methods, as well as a new attribute *note closed: 8a2.
(Contributed by Victor Stinner in bpo-18794(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16488

   (2) https://bugs.python.org/issue18794


File: python.info,  Node: shelve,  Next: shutil<3>,  Prev: select,  Up: Improved Modules<5>

1.5.4.41 shelve
...............

*note Shelf: 8a4. instances may now be used in *note with: 6dd.
statements, and will be automatically closed at the end of the ‘with’
block.  (Contributed by Filip Gruszczyński in bpo-13896(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13896


File: python.info,  Node: shutil<3>,  Next: smtpd<2>,  Prev: shelve,  Up: Improved Modules<5>

1.5.4.42 shutil
...............

*note copyfile(): 256. now raises a specific *note Error: 8a6. subclass,
*note SameFileError: 8a7, when the source and destination are the same
file, which allows an application to take appropriate action on this
specific error.  (Contributed by Atsuo Ishimoto and Hynek Schlawack in
bpo-1492704(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1492704


File: python.info,  Node: smtpd<2>,  Next: smtplib<2>,  Prev: shutil<3>,  Up: Improved Modules<5>

1.5.4.43 smtpd
..............

The *note SMTPServer: 5f7. and *note SMTPChannel: 5f6. classes now
accept a `map' keyword argument which, if specified, is passed in to
*note asynchat.async_chat: 8a9. as its `map' argument.  This allows an
application to avoid affecting the global socket map.  (Contributed by
Vinay Sajip in bpo-11959(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11959


File: python.info,  Node: smtplib<2>,  Next: socket<6>,  Prev: smtpd<2>,  Up: Improved Modules<5>

1.5.4.44 smtplib
................

*note SMTPException: 8ab. is now a subclass of *note OSError: 1d1, which
allows both socket level errors and SMTP protocol level errors to be
caught in one try/except statement by code that only cares whether or
not an error occurred.  (Contributed by Ned Jackson Lovely in
bpo-2118(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2118


File: python.info,  Node: socket<6>,  Next: sqlite3<4>,  Prev: smtplib<2>,  Up: Improved Modules<5>

1.5.4.45 socket
...............

The socket module now supports the *note CAN_BCM: 8ad. protocol on
platforms that support it.  (Contributed by Brian Thorne in
bpo-15359(1).)

Socket objects have new methods to get or set their *note inheritable
flag: 7ee, *note get_inheritable(): 7f3. and *note set_inheritable():
7f4.

The ‘socket.AF_*’ and ‘socket.SOCK_*’ constants are now enumeration
values using the new *note enum: 7b. module.  This allows meaningful
names to be printed during debugging, instead of integer “magic
numbers”.

The *note AF_LINK: 8ae. constant is now available on BSD and OSX.

*note inet_pton(): 8af. and *note inet_ntop(): 8b0. are now supported on
Windows.  (Contributed by Atsuo Ishimoto in bpo-7171(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15359

   (2) https://bugs.python.org/issue7171


File: python.info,  Node: sqlite3<4>,  Next: ssl<7>,  Prev: socket<6>,  Up: Improved Modules<5>

1.5.4.46 sqlite3
................

A new boolean parameter to the *note connect(): 3cf. function, `uri',
can be used to indicate that the `database' parameter is a ‘uri’ (see
the SQLite URI documentation(1)).  (Contributed by poq in bpo-13773(2).)

   ---------- Footnotes ----------

   (1) https://www.sqlite.org/uri.html

   (2) https://bugs.python.org/issue13773


File: python.info,  Node: ssl<7>,  Next: stat,  Prev: sqlite3<4>,  Up: Improved Modules<5>

1.5.4.47 ssl
............

*note PROTOCOL_TLSv1_1: 8b3. and *note PROTOCOL_TLSv1_2: 8b4. (TLSv1.1
and TLSv1.2 support) have been added; support for these protocols is
only available if Python is linked with OpenSSL 1.0.1 or later.
(Contributed by Michele Orrù and Antoine Pitrou in bpo-16692(1).)  New
function *note create_default_context(): 8b5. provides a standard way to
obtain an *note SSLContext: 3d9. whose settings are intended to be a
reasonable balance between compatibility and security.  These settings
are more stringent than the defaults provided by the *note SSLContext:
3d9. constructor, and may be adjusted in the future, without prior
deprecation, if best-practice security requirements change.  The new
recommended best practice for using stdlib libraries that support SSL is
to use *note create_default_context(): 8b5. to obtain an *note
SSLContext: 3d9. object, modify it if needed, and then pass it as the
`context' argument of the appropriate stdlib API. (Contributed by
Christian Heimes in bpo-19689(2).)

*note SSLContext: 3d9. method *note load_verify_locations(): 7df.
accepts a new optional argument `cadata', which can be used to provide
PEM or DER encoded certificates directly via strings or bytes,
respectively.  (Contributed by Christian Heimes in bpo-18138(3).)

New function *note get_default_verify_paths(): 8b6. returns a named
tuple of the paths and environment variables that the *note
set_default_verify_paths(): 8b7. method uses to set OpenSSL’s default
‘cafile’ and ‘capath’.  This can be an aid in debugging default
verification issues.  (Contributed by Christian Heimes in bpo-18143(4).)

*note SSLContext: 3d9. has a new method, *note cert_store_stats(): 8b8,
that reports the number of loaded ‘X.509’ certs, ‘X.509 CA’ certs, and
certificate revocation lists (‘crl’s), as well as a *note
get_ca_certs(): 8b9. method that returns a list of the loaded ‘CA’
certificates.  (Contributed by Christian Heimes in bpo-18147(5).)

If OpenSSL 0.9.8 or later is available, *note SSLContext: 3d9. has a new
attribute *note verify_flags: 8ba. that can be used to control the
certificate verification process by setting it to some combination of
the new constants *note VERIFY_DEFAULT: 8bb, *note
VERIFY_CRL_CHECK_LEAF: 8bc, *note VERIFY_CRL_CHECK_CHAIN: 8bd, or *note
VERIFY_X509_STRICT: 8be.  OpenSSL does not do any CRL verification by
default.  (Contributed by Christien Heimes in bpo-8813(6).)

New *note SSLContext: 3d9. method *note load_default_certs(): 8bf. loads
a set of default “certificate authority” (CA) certificates from default
locations, which vary according to the platform.  It can be used to load
both TLS web server authentication certificates (‘purpose=’*note
SERVER_AUTH: 8c0.) for a client to use to verify a server, and
certificates for a server to use in verifying client certificates
(‘purpose=’*note CLIENT_AUTH: 8c1.).  (Contributed by Christian Heimes
in bpo-19292(7).)  Two new windows-only functions, *note
enum_certificates(): 8c2. and *note enum_crls(): 8c3. provide the
ability to retrieve certificates, certificate information, and CRLs from
the Windows cert store.  (Contributed by Christian Heimes in
bpo-17134(8).)  Support for server-side SNI (Server Name Indication)
using the new *note ssl.SSLContext.set_servername_callback(): 8c4.
method.  (Contributed by Daniel Black in bpo-8109(9).)

The dictionary returned by *note SSLSocket.getpeercert(): 8c5. contains
additional ‘X509v3’ extension items: ‘crlDistributionPoints’,
‘calIssuers’, and ‘OCSP’ URIs.  (Contributed by Christian Heimes in
bpo-18379(10).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16692

   (2) https://bugs.python.org/issue19689

   (3) https://bugs.python.org/issue18138

   (4) https://bugs.python.org/issue18143

   (5) https://bugs.python.org/issue18147

   (6) https://bugs.python.org/issue8813

   (7) https://bugs.python.org/issue19292

   (8) https://bugs.python.org/issue17134

   (9) https://bugs.python.org/issue8109

   (10) https://bugs.python.org/issue18379


File: python.info,  Node: stat,  Next: struct<2>,  Prev: ssl<7>,  Up: Improved Modules<5>

1.5.4.48 stat
.............

The *note stat: f4. module is now backed by a C implementation in
‘_stat’.  A C implementation is required as most of the values aren’t
standardized and are platform-dependent.  (Contributed by Christian
Heimes in bpo-11016(1).)

The module supports new *note ST_MODE: 8c7. flags, *note S_IFDOOR: 8c8,
*note S_IFPORT: 8c9, and *note S_IFWHT: 8ca.  (Contributed by Christian
Hiemes in bpo-11016(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11016

   (2) https://bugs.python.org/issue11016


File: python.info,  Node: struct<2>,  Next: subprocess<4>,  Prev: stat,  Up: Improved Modules<5>

1.5.4.49 struct
...............

New function *note iter_unpack: 8cc. and a new *note
struct.Struct.iter_unpack(): 8cd. method on compiled formats provide
streamed unpacking of a buffer containing repeated instances of a given
format of data.  (Contributed by Antoine Pitrou in bpo-17804(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17804


File: python.info,  Node: subprocess<4>,  Next: sunau<2>,  Prev: struct<2>,  Up: Improved Modules<5>

1.5.4.50 subprocess
...................

*note check_output(): 8cf. now accepts an `input' argument that can be
used to provide the contents of ‘stdin’ for the command that is run.
(Contributed by Zack Weinberg in bpo-16624(1).)

‘getstatus()’ and *note getstatusoutput(): 8d0. now work on Windows.
This change was actually inadvertently made in 3.3.4.  (Contributed by
Tim Golden in bpo-10197(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16624

   (2) https://bugs.python.org/issue10197


File: python.info,  Node: sunau<2>,  Next: sys<6>,  Prev: subprocess<4>,  Up: Improved Modules<5>

1.5.4.51 sunau
..............

The ‘getparams()’ method now returns a namedtuple rather than a plain
tuple.  (Contributed by Claudiu Popa in bpo-18901(1).)

*note sunau.open(): 467. now supports the context management protocol:
when used in a *note with: 6dd. block, the ‘close’ method of the
returned object will be called automatically at the end of the block.
(Contributed by Serhiy Storchaka in bpo-18878(2).)

*note AU_write.setsampwidth(): 8d2. now supports 24 bit samples, thus
adding support for writing 24 sample using the module.  (Contributed by
Serhiy Storchaka in bpo-19261(3).)

The *note writeframesraw(): 8d3. and *note writeframes(): 8d4. methods
now accept any *note bytes-like object: 5dd.  (Contributed by Serhiy
Storchaka in bpo-8311(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18901

   (2) https://bugs.python.org/issue18878

   (3) https://bugs.python.org/issue19261

   (4) https://bugs.python.org/issue8311


File: python.info,  Node: sys<6>,  Next: tarfile<3>,  Prev: sunau<2>,  Up: Improved Modules<5>

1.5.4.52 sys
............

New function *note sys.getallocatedblocks(): 8d6. returns the current
number of blocks allocated by the interpreter.  (In CPython with the
default ‘--with-pymalloc’ setting, this is allocations made through the
*note PyObject_Malloc(): 4fd. API.) This can be useful for tracking
memory leaks, especially if automated via a test suite.  (Contributed by
Antoine Pitrou in bpo-13390(1).)

When the Python interpreter starts in *note interactive mode: 8d7, it
checks for an *note __interactivehook__: 8d8. attribute on the *note
sys: fd. module.  If the attribute exists, its value is called with no
arguments just before interactive mode is started.  The check is made
after the *note PYTHONSTARTUP: 8d9. file is read, so it can be set
there.  The *note site: eb. module *note sets it: 8da. to a function
that enables tab completion and history saving (in ‘~/.python-history’)
if the platform supports *note readline: de.  If you do not want this
(new) behavior, you can override it in *note PYTHONSTARTUP: 8d9,
‘sitecustomize’, or ‘usercustomize’ by deleting this attribute from
*note sys: fd. (or setting it to some other callable).  (Contributed by
Éric Araujo and Antoine Pitrou in bpo-5845(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13390

   (2) https://bugs.python.org/issue5845


File: python.info,  Node: tarfile<3>,  Next: textwrap,  Prev: sys<6>,  Up: Improved Modules<5>

1.5.4.53 tarfile
................

The *note tarfile: 101. module now supports a simple *note Command-Line
Interface: 8dc. when called as a script directly or via ‘-m’.  This can
be used to create and extract tarfile archives.  (Contributed by Berker
Peksag in bpo-13477(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13477


File: python.info,  Node: textwrap,  Next: threading<4>,  Prev: tarfile<3>,  Up: Improved Modules<5>

1.5.4.54 textwrap
.................

The *note TextWrapper: 8de. class has two new attributes/constructor
arguments: *note max_lines: 8df, which limits the number of lines in the
output, and *note placeholder: 8e0, which is a string that will appear
at the end of the output if it has been truncated because of
`max_lines'.  Building on these capabilities, a new convenience function
*note shorten(): 8e1. collapses all of the whitespace in the input to
single spaces and produces a single line of a given `width' that ends
with the `placeholder' (by default, ‘[...]’).  (Contributed by Antoine
Pitrou and Serhiy Storchaka in bpo-18585(1) and bpo-18725(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18585

   (2) https://bugs.python.org/issue18725


File: python.info,  Node: threading<4>,  Next: traceback<3>,  Prev: textwrap,  Up: Improved Modules<5>

1.5.4.55 threading
..................

The *note Thread: 233. object representing the main thread can be
obtained from the new *note main_thread(): 8e3. function.  In normal
conditions this will be the thread from which the Python interpreter was
started.  (Contributed by Andrew Svetlov in bpo-18882(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18882


File: python.info,  Node: traceback<3>,  Next: types<3>,  Prev: threading<4>,  Up: Improved Modules<5>

1.5.4.56 traceback
..................

A new *note traceback.clear_frames(): 8e5. function takes a traceback
object and clears the local variables in all of the frames it
references, reducing the amount of memory consumed.  (Contributed by
Andrew Kuchling in bpo-1565525(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1565525


File: python.info,  Node: types<3>,  Next: urllib<2>,  Prev: traceback<3>,  Up: Improved Modules<5>

1.5.4.57 types
..............

A new *note DynamicClassAttribute(): 8e7. descriptor provides a way to
define an attribute that acts normally when looked up through an
instance object, but which is routed to the `class' ‘__getattr__’ when
looked up through the class.  This allows one to have properties active
on a class, and have virtual attributes on the class with the same name
(see ‘Enum’ for an example).  (Contributed by Ethan Furman in
bpo-19030(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19030


File: python.info,  Node: urllib<2>,  Next: unittest<4>,  Prev: types<3>,  Up: Improved Modules<5>

1.5.4.58 urllib
...............

*note urllib.request: 120. now supports ‘data:’ URLs via the *note
DataHandler: 8e9. class.  (Contributed by Mathias Panzenböck in
bpo-16423(1).)

The http method that will be used by a *note Request: 8ea. class can now
be specified by setting a *note method: 8eb. class attribute on the
subclass.  (Contributed by Jason R Coombs in bpo-18978(2).)

*note Request: 8ea. objects are now reusable: if the *note full_url:
8ec. or *note data: 8ed. attributes are modified, all relevant internal
properties are updated.  This means, for example, that it is now
possible to use the same *note Request: 8ea. object in more than one
*note OpenerDirector.open(): 8ee. call with different `data' arguments,
or to modify a *note Request: 8ea.’s ‘url’ rather than recomputing it
from scratch.  There is also a new *note remove_header(): 8ef. method
that can be used to remove headers from a *note Request: 8ea.
(Contributed by Alexey Kachayev in bpo-16464(3), Daniel Wozniak in
bpo-17485(4), and Damien Brecht and Senthil Kumaran in bpo-17272(5).)

*note HTTPError: 8f0. objects now have a *note headers: 8f1. attribute
that provides access to the HTTP response headers associated with the
error.  (Contributed by Berker Peksag in bpo-15701(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16423

   (2) https://bugs.python.org/issue18978

   (3) https://bugs.python.org/issue16464

   (4) https://bugs.python.org/issue17485

   (5) https://bugs.python.org/issue17272

   (6) https://bugs.python.org/issue15701


File: python.info,  Node: unittest<4>,  Next: venv<4>,  Prev: urllib<2>,  Up: Improved Modules<5>

1.5.4.59 unittest
.................

The *note TestCase: 8f3. class has a new method, *note subTest(): 8f4,
that produces a context manager whose *note with: 6dd. block becomes a
“sub-test”.  This context manager allows a test method to dynamically
generate subtests by, say, calling the ‘subTest’ context manager inside
a loop.  A single test method can thereby produce an indefinite number
of separately-identified and separately-counted tests, all of which will
run even if one or more of them fail.  For example:

     class NumbersTest(unittest.TestCase):
         def test_even(self):
             for i in range(6):
                 with self.subTest(i=i):
                     self.assertEqual(i % 2, 0)

will result in six subtests, each identified in the unittest verbose
output with a label consisting of the variable name ‘i’ and a particular
value for that variable (‘i=0’, ‘i=1’, etc).  See *note Distinguishing
test iterations using subtests: 8f5. for the full version of this
example.  (Contributed by Antoine Pitrou in bpo-16997(1).)

*note unittest.main(): 8f6. now accepts an iterable of test names for
`defaultTest', where previously it only accepted a single test name as a
string.  (Contributed by Jyrki Pulliainen in bpo-15132(2).)

If *note SkipTest: 8f7. is raised during test discovery (that is, at the
module level in the test file), it is now reported as a skip instead of
an error.  (Contributed by Zach Ware in bpo-16935(3).)

*note discover(): 8f8. now sorts the discovered files to provide
consistent test ordering.  (Contributed by Martin Melin and Jeff Ramnani
in bpo-16709(4).)

*note TestSuite: 6c2. now drops references to tests as soon as the test
has been run, if the test is successful.  On Python interpreters that do
garbage collection, this allows the tests to be garbage collected if
nothing else is holding a reference to the test.  It is possible to
override this behavior by creating a *note TestSuite: 6c2. subclass that
defines a custom ‘_removeTestAtIndex’ method.  (Contributed by Tom
Wardill, Matt McClure, and Andrew Svetlov in bpo-11798(5).)

A new test assertion context-manager, *note assertLogs(): 8f9, will
ensure that a given block of code emits a log message using the *note
logging: aa. module.  By default the message can come from any logger
and have a priority of ‘INFO’ or higher, but both the logger name and an
alternative minimum logging level may be specified.  The object returned
by the context manager can be queried for the *note LogRecord: 8fa.s
and/or formatted messages that were logged.  (Contributed by Antoine
Pitrou in bpo-18937(6).)

Test discovery now works with namespace packages (Contributed by Claudiu
Popa in bpo-17457(7).)

*note unittest.mock: 11c. objects now inspect their specification
signatures when matching calls, which means an argument can now be
matched by either position or name, instead of only by position.
(Contributed by Antoine Pitrou in bpo-17015(8).)

‘mock_open()’ objects now have ‘readline’ and ‘readlines’ methods.
(Contributed by Toshio Kuratomi in bpo-17467(9).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16997

   (2) https://bugs.python.org/issue15132

   (3) https://bugs.python.org/issue16935

   (4) https://bugs.python.org/issue16709

   (5) https://bugs.python.org/issue11798

   (6) https://bugs.python.org/issue18937

   (7) https://bugs.python.org/issue17457

   (8) https://bugs.python.org/issue17015

   (9) https://bugs.python.org/issue17467


File: python.info,  Node: venv<4>,  Next: wave<2>,  Prev: unittest<4>,  Up: Improved Modules<5>

1.5.4.60 venv
.............

*note venv: 125. now includes activation scripts for the ‘csh’ and
‘fish’ shells.  (Contributed by Andrew Svetlov in bpo-15417(1).)

*note EnvBuilder: 8fc. and the *note create(): 8fd. convenience function
take a new keyword argument `with_pip', which defaults to ‘False’, that
controls whether or not *note EnvBuilder: 8fc. ensures that ‘pip’ is
installed in the virtual environment.  (Contributed by Nick Coghlan in
bpo-19552(2) as part of the PEP 453(3) implementation.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15417

   (2) https://bugs.python.org/issue19552

   (3) https://www.python.org/dev/peps/pep-0453


File: python.info,  Node: wave<2>,  Next: weakref<2>,  Prev: venv<4>,  Up: Improved Modules<5>

1.5.4.61 wave
.............

The ‘getparams()’ method now returns a namedtuple rather than a plain
tuple.  (Contributed by Claudiu Popa in bpo-17487(1).)

*note wave.open(): 46b. now supports the context management protocol.
(Contributed by Claudiu Popa in bpo-17616(2).)

*note wave: 127. can now *note write output to unseekable files: 8ff.
(Contributed by David Jones, Guilherme Polo, and Serhiy Storchaka in
bpo-5202(3).)

The *note writeframesraw(): 900. and *note writeframes(): 901. methods
now accept any *note bytes-like object: 5dd.  (Contributed by Serhiy
Storchaka in bpo-8311(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17487

   (2) https://bugs.python.org/issue17616

   (3) https://bugs.python.org/issue5202

   (4) https://bugs.python.org/issue8311


File: python.info,  Node: weakref<2>,  Next: xml etree<2>,  Prev: wave<2>,  Up: Improved Modules<5>

1.5.4.62 weakref
................

New *note WeakMethod: 903. class simulates weak references to bound
methods.  (Contributed by Antoine Pitrou in bpo-14631(1).)

New *note finalize: 29b. class makes it possible to register a callback
to be invoked when an object is garbage collected, without needing to
carefully manage the lifecycle of the weak reference itself.
(Contributed by Richard Oudkerk in bpo-15528(2).)

The callback, if any, associated with a *note ref: 904. is now exposed
via the *note __callback__: 905. attribute.  (Contributed by Mark
Dickinson in bpo-17643(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14631

   (2) https://bugs.python.org/issue15528

   (3) https://bugs.python.org/issue17643


File: python.info,  Node: xml etree<2>,  Next: zipfile<4>,  Prev: weakref<2>,  Up: Improved Modules<5>

1.5.4.63 xml.etree
..................

A new parser, *note XMLPullParser: 907, allows a non-blocking
applications to parse XML documents.  An example can be seen at *note
Pull API for non-blocking parsing: 908.  (Contributed by Antoine Pitrou
in bpo-17741(1).)

The *note xml.etree.ElementTree: 137. *note tostring(): 909. and *note
tostringlist(): 90a. functions, and the *note ElementTree: 90b. *note
write(): 90c. method, now have a `short_empty_elements' *note
keyword-only parameter: 2aa. providing control over whether elements
with no content are written in abbreviated (‘<tag />’) or expanded
(‘<tag></tag>’) form.  (Contributed by Ariel Poliak and Serhiy Storchaka
in bpo-14377(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17741

   (2) https://bugs.python.org/issue14377


File: python.info,  Node: zipfile<4>,  Prev: xml etree<2>,  Up: Improved Modules<5>

1.5.4.64 zipfile
................

The *note writepy(): 90e. method of the *note PyZipFile: 90f. class has
a new `filterfunc' option that can be used to control which directories
and files are added to the archive.  For example, this could be used to
exclude test files from the archive.  (Contributed by Christian Tismer
in bpo-19274(1).)

The `allowZip64' parameter to *note ZipFile: 414. and ‘PyZipfile’ is now
‘True’ by default.  (Contributed by William Mallard in bpo-17201(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19274

   (2) https://bugs.python.org/issue17201


File: python.info,  Node: CPython Implementation Changes,  Next: Deprecated<4>,  Prev: Improved Modules<5>,  Up: What’s New In Python 3 4

1.5.5 CPython Implementation Changes
------------------------------------

* Menu:

* PEP 445; Customization of CPython Memory Allocators: PEP 445 Customization of CPython Memory Allocators.
* PEP 442; Safe Object Finalization: PEP 442 Safe Object Finalization.
* PEP 456; Secure and Interchangeable Hash Algorithm: PEP 456 Secure and Interchangeable Hash Algorithm.
* PEP 436; Argument Clinic: PEP 436 Argument Clinic.
* Other Build and C API Changes::
* Other Improvements: Other Improvements<2>.
* Significant Optimizations::


File: python.info,  Node: PEP 445 Customization of CPython Memory Allocators,  Next: PEP 442 Safe Object Finalization,  Up: CPython Implementation Changes

1.5.5.1 PEP 445: Customization of CPython Memory Allocators
...........................................................

PEP 445(1) adds new C level interfaces to customize memory allocation in
the CPython interpreter.

See also
........

PEP 445(2) – Add new APIs to customize Python memory allocators

     PEP written and implemented by Victor Stinner.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0445

   (2) https://www.python.org/dev/peps/pep-0445


File: python.info,  Node: PEP 442 Safe Object Finalization,  Next: PEP 456 Secure and Interchangeable Hash Algorithm,  Prev: PEP 445 Customization of CPython Memory Allocators,  Up: CPython Implementation Changes

1.5.5.2 PEP 442: Safe Object Finalization
.........................................

PEP 442(1) removes the current limitations and quirks of object
finalization in CPython.  With it, objects with *note __del__(): 913.
methods, as well as generators with *note finally: 182. clauses, can be
finalized when they are part of a reference cycle.

As part of this change, module globals are no longer forcibly set to
*note None: 157. during interpreter shutdown in most cases, instead
relying on the normal operation of the cyclic garbage collector.  This
avoids a whole class of interpreter-shutdown-time errors, usually
involving ‘__del__’ methods, that have plagued Python since the cyclic
GC was first introduced.

See also
........

PEP 442(2) – Safe object finalization

     PEP written and implemented by Antoine Pitrou.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0442

   (2) https://www.python.org/dev/peps/pep-0442


File: python.info,  Node: PEP 456 Secure and Interchangeable Hash Algorithm,  Next: PEP 436 Argument Clinic,  Prev: PEP 442 Safe Object Finalization,  Up: CPython Implementation Changes

1.5.5.3 PEP 456: Secure and Interchangeable Hash Algorithm
..........................................................

PEP 456(1) follows up on earlier security fix work done on Python’s hash
algorithm to address certain DOS attacks to which public facing APIs
backed by dictionary lookups may be subject.  (See bpo-14621(2) for the
start of the current round of improvements.)  The PEP unifies CPython’s
hash code to make it easier for a packager to substitute a different
hash algorithm, and switches Python’s default implementation to a
SipHash implementation on platforms that have a 64 bit data type.  Any
performance differences in comparison with the older FNV algorithm are
trivial.

The PEP adds additional fields to the *note sys.hash_info: 915. named
tuple to describe the hash algorithm in use by the currently executing
binary.  Otherwise, the PEP does not alter any existing CPython APIs.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0456

   (2) https://bugs.python.org/issue14621


File: python.info,  Node: PEP 436 Argument Clinic,  Next: Other Build and C API Changes,  Prev: PEP 456 Secure and Interchangeable Hash Algorithm,  Up: CPython Implementation Changes

1.5.5.4 PEP 436: Argument Clinic
................................

“Argument Clinic” ( PEP 436(1)) is now part of the CPython build process
and can be used to simplify the process of defining and maintaining
accurate signatures for builtins and standard library extension modules
implemented in C.

Some standard library extension modules have been converted to use
Argument Clinic in Python 3.4, and *note pydoc: d9. and *note inspect:
a0. have been updated accordingly.

It is expected that signature metadata for programmatic introspection
will be added to additional callables implemented in C as part of Python
3.4 maintenance releases.

     Note: The Argument Clinic PEP is not fully up to date with the
     state of the implementation.  This has been deemed acceptable by
     the release manager and core development team in this case, as
     Argument Clinic will not be made available as a public API for
     third party use in Python 3.4.

See also
........

PEP 436(2) – The Argument Clinic DSL

     PEP written and implemented by Larry Hastings.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0436

   (2) https://www.python.org/dev/peps/pep-0436


File: python.info,  Node: Other Build and C API Changes,  Next: Other Improvements<2>,  Prev: PEP 436 Argument Clinic,  Up: CPython Implementation Changes

1.5.5.5 Other Build and C API Changes
.....................................

   * The new *note PyType_GetSlot(): 918. function has been added to the
     stable ABI, allowing retrieval of function pointers from named type
     slots when using the limited API. (Contributed by Martin von Löwis
     in bpo-17162(1).)

   * The new *note Py_SetStandardStreamEncoding(): 919.
     pre-initialization API allows applications embedding the CPython
     interpreter to reliably force a particular encoding and error
     handler for the standard streams.  (Contributed by Bastien Montagne
     and Nick Coghlan in bpo-16129(2).)

   * Most Python C APIs that don’t mutate string arguments are now
     correctly marked as accepting ‘const char *’ rather than ‘char *’.
     (Contributed by Serhiy Storchaka in bpo-1772673(3).)

   * A new shell version of ‘python-config’ can be used even when a
     python interpreter is not available (for example, in cross
     compilation scenarios).

   * *note PyUnicode_FromFormat(): 7bf. now supports width and precision
     specifications for ‘%s’, ‘%A’, ‘%U’, ‘%V’, ‘%S’, and ‘%R’.
     (Contributed by Ysj Ray and Victor Stinner in bpo-7330(4).)

   * New function *note PyStructSequence_InitType2(): 91a. supplements
     the existing *note PyStructSequence_InitType(): 91b. function.  The
     difference is that it returns ‘0’ on success and ‘-1’ on failure.

   * The CPython source can now be compiled using the address sanity
     checking features of recent versions of GCC and clang: the false
     alarms in the small object allocator have been silenced.
     (Contributed by Dhiru Kholia in bpo-18596(5).)

   * The Windows build now uses Address Space Layout Randomization(6)
     and Data Execution Prevention(7).  (Contributed by Christian Heimes
     in bpo-16632(8).)

   * New function *note PyObject_LengthHint(): 91c. is the C API
     equivalent of *note operator.length_hint(): 871.  (Contributed by
     Armin Ronacher in bpo-16148(9).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17162

   (2) https://bugs.python.org/issue16129

   (3) https://bugs.python.org/issue1772673

   (4) https://bugs.python.org/issue7330

   (5) https://bugs.python.org/issue18596

   (6) https://en.wikipedia.org/wiki/Address_space_layout_randomization

   (7) https://en.wikipedia.org/wiki/Data_Execution_Prevention

   (8) https://bugs.python.org/issue16632

   (9) https://bugs.python.org/issue16148


File: python.info,  Node: Other Improvements<2>,  Next: Significant Optimizations,  Prev: Other Build and C API Changes,  Up: CPython Implementation Changes

1.5.5.6 Other Improvements
..........................

   * The *note python: 91f. command has a new *note option: 920, ‘-I’,
     which causes it to run in “isolated mode”, which means that *note
     sys.path: 47d. contains neither the script’s directory nor the
     user’s ‘site-packages’ directory, and all ‘PYTHON*’ environment
     variables are ignored (it implies both ‘-s’ and ‘-E’).  Other
     restrictions may also be applied in the future, with the goal being
     to isolate the execution of a script from the user’s environment.
     This is appropriate, for example, when Python is used to run a
     system script.  On most POSIX systems it can and should be used in
     the ‘#!’ line of system scripts.  (Contributed by Christian Heimes
     in bpo-16499(1).)

   * Tab-completion is now enabled by default in the interactive
     interpreter on systems that support *note readline: de.  History is
     also enabled by default, and is written to (and read from) the file
     ‘~/.python-history’.  (Contributed by Antoine Pitrou and Éric
     Araujo in bpo-5845(2).)

   * Invoking the Python interpreter with ‘--version’ now outputs the
     version to standard output instead of standard error
     (bpo-18338(3)).  Similar changes were made to *note argparse: 6.
     (bpo-18920(4)) and other modules that have script-like invocation
     capabilities (bpo-18922(5)).

   * The CPython Windows installer now adds ‘.py’ to the ‘PATHEXT’
     variable when extensions are registered, allowing users to run a
     python script at the windows command prompt by just typing its name
     without the ‘.py’ extension.  (Contributed by Paul Moore in
     bpo-18569(6).)

   * A new ‘make’ target coverage-report(7) will build python, run the
     test suite, and generate an HTML coverage report for the C codebase
     using ‘gcov’ and lcov(8).

   * The ‘-R’ option to the *note python regression test suite: 921. now
     also checks for memory allocation leaks, using *note
     sys.getallocatedblocks(): 8d6.  (Contributed by Antoine Pitrou in
     bpo-13390(9).)

   * ‘python -m’ now works with namespace packages.

   * The *note stat: f4. module is now implemented in C, which means it
     gets the values for its constants from the C header files, instead
     of having the values hard-coded in the python module as was
     previously the case.

   * Loading multiple python modules from a single OS module (‘.so’,
     ‘.dll’) now works correctly (previously it silently returned the
     first python module in the file).  (Contributed by Václav Šmilauer
     in bpo-16421(10).)

   * A new opcode, *note LOAD_CLASSDEREF: 922, has been added to fix a
     bug in the loading of free variables in class bodies that could be
     triggered by certain uses of *note __prepare__: 4f2.  (Contributed
     by Benjamin Peterson in bpo-17853(11).)

   * A number of MemoryError-related crashes were identified and fixed
     by Victor Stinner using his PEP 445(12)-based ‘pyfailmalloc’ tool
     (bpo-18408(13), bpo-18520(14)).

   * The ‘pyvenv’ command now accepts a ‘--copies’ option to use copies
     rather than symlinks even on systems where symlinks are the
     default.  (Contributed by Vinay Sajip in bpo-18807(15).)

   * The ‘pyvenv’ command also accepts a ‘--without-pip’ option to
     suppress the otherwise-automatic bootstrapping of pip into the
     virtual environment.  (Contributed by Nick Coghlan in bpo-19552(16)
     as part of the PEP 453(17) implementation.)

   * The encoding name is now optional in the value set for the *note
     PYTHONIOENCODING: 923. environment variable.  This makes it
     possible to set just the error handler, without changing the
     default encoding.  (Contributed by Serhiy Storchaka in
     bpo-18818(18).)

   * The *note bz2: 14, *note lzma: ad, and *note gzip: 8c. module
     ‘open’ functions now support ‘x’ (exclusive creation) mode.
     (Contributed by Tim Heaney and Vajrasky Kok in bpo-19201(19),
     bpo-19222(20), and bpo-19223(21).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16499

   (2) https://bugs.python.org/issue5845

   (3) https://bugs.python.org/issue18338

   (4) https://bugs.python.org/issue18920

   (5) https://bugs.python.org/issue18922

   (6) https://bugs.python.org/issue18569

   (7) 
https://devguide.python.org/coverage/#measuring-coverage-of-c-code-with-gcov-and-lcov

   (8) http://ltp.sourceforge.net/coverage/lcov.php

   (9) https://bugs.python.org/issue13390

   (10) https://bugs.python.org/issue16421

   (11) https://bugs.python.org/issue17853

   (12) https://www.python.org/dev/peps/pep-0445

   (13) https://bugs.python.org/issue18408

   (14) https://bugs.python.org/issue18520

   (15) https://bugs.python.org/issue18807

   (16) https://bugs.python.org/issue19552

   (17) https://www.python.org/dev/peps/pep-0453

   (18) https://bugs.python.org/issue18818

   (19) https://bugs.python.org/issue19201

   (20) https://bugs.python.org/issue19222

   (21) https://bugs.python.org/issue19223


File: python.info,  Node: Significant Optimizations,  Prev: Other Improvements<2>,  Up: CPython Implementation Changes

1.5.5.7 Significant Optimizations
.................................

   * The UTF-32 decoder is now 3x to 4x faster.  (Contributed by Serhiy
     Storchaka in bpo-14625(1).)

   * The cost of hash collisions for sets is now reduced.  Each hash
     table probe now checks a series of consecutive, adjacent key/hash
     pairs before continuing to make random probes through the hash
     table.  This exploits cache locality to make collision resolution
     less expensive.  The collision resolution scheme can be described
     as a hybrid of linear probing and open addressing.  The number of
     additional linear probes defaults to nine.  This can be changed at
     compile-time by defining LINEAR_PROBES to be any value.  Set
     LINEAR_PROBES=0 to turn-off linear probing entirely.  (Contributed
     by Raymond Hettinger in bpo-18771(2).)

   * The interpreter starts about 30% faster.  A couple of measures lead
     to the speedup.  The interpreter loads fewer modules on startup,
     e.g.  the *note re: dd, *note collections: 1e. and *note locale:
     a9. modules and their dependencies are no longer imported by
     default.  The marshal module has been improved to load compiled
     Python code faster.  (Contributed by Antoine Pitrou, Christian
     Heimes and Victor Stinner in bpo-19219(3), bpo-19218(4),
     bpo-19209(5), bpo-19205(6) and bpo-9548(7).)

   * *note bz2.BZ2File: 925. is now as fast or faster than the Python2
     version for most cases.  *note lzma.LZMAFile: 926. has also been
     optimized.  (Contributed by Serhiy Storchaka and Nadeem Vawda in
     bpo-16034(8).)

   * *note random.getrandbits(): 927. is 20%-40% faster for small
     integers (the most common use case).  (Contributed by Serhiy
     Storchaka in bpo-16674(9).)

   * By taking advantage of the new storage format for strings, pickling
     of strings is now significantly faster.  (Contributed by Victor
     Stinner and Antoine Pitrou in bpo-15596(10).)

   * A performance issue in ‘io.FileIO.readall()’ has been solved.  This
     particularly affects Windows, and significantly speeds up the case
     of piping significant amounts of data through *note subprocess: f9.
     (Contributed by Richard Oudkerk in bpo-15758(11).)

   * *note html.escape(): 928. is now 10x faster.  (Contributed by Matt
     Bryant in bpo-18020(12).)

   * On Windows, the native ‘VirtualAlloc’ is now used instead of the
     CRT ‘malloc’ in ‘obmalloc’.  Artificial benchmarks show about a 3%
     memory savings.

   * *note os.urandom(): 4c6. now uses a lazily-opened persistent file
     descriptor so as to avoid using many file descriptors when run in
     parallel from multiple threads.  (Contributed by Antoine Pitrou in
     bpo-18756(13).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14625

   (2) https://bugs.python.org/issue18771

   (3) https://bugs.python.org/issue19219

   (4) https://bugs.python.org/issue19218

   (5) https://bugs.python.org/issue19209

   (6) https://bugs.python.org/issue19205

   (7) https://bugs.python.org/issue9548

   (8) https://bugs.python.org/issue16034

   (9) https://bugs.python.org/issue16674

   (10) https://bugs.python.org/issue15596

   (11) https://bugs.python.org/issue15758

   (12) https://bugs.python.org/issue18020

   (13) https://bugs.python.org/issue18756


File: python.info,  Node: Deprecated<4>,  Next: Removed<3>,  Prev: CPython Implementation Changes,  Up: What’s New In Python 3 4

1.5.6 Deprecated
----------------

This section covers various APIs and other features that have been
deprecated in Python 3.4, and will be removed in Python 3.5 or later.
In most (but not all) cases, using the deprecated APIs will produce a
*note DeprecationWarning: 276. when the interpreter is run with
deprecation warnings enabled (for example, by using ‘-Wd’).

* Menu:

* Deprecations in the Python API::
* Deprecated Features::


File: python.info,  Node: Deprecations in the Python API,  Next: Deprecated Features,  Up: Deprecated<4>

1.5.6.1 Deprecations in the Python API
......................................

   * As mentioned in *note PEP 451; A ModuleSpec Type for the Import
     System: 7cc, a number of *note importlib: 9b. methods and functions
     are deprecated: *note importlib.find_loader(): 92b. is replaced by
     *note importlib.util.find_spec(): 92c.; *note
     importlib.machinery.PathFinder.find_module(): 92d. is replaced by
     *note importlib.machinery.PathFinder.find_spec(): 92e.; *note
     importlib.abc.MetaPathFinder.find_module(): 457. is replaced by
     *note importlib.abc.MetaPathFinder.find_spec(): 458.; *note
     importlib.abc.PathEntryFinder.find_loader(): 459. and *note
     find_module(): 92f. are replaced by *note
     importlib.abc.PathEntryFinder.find_spec(): 45a.; all of the
     ‘xxxLoader’ ABC ‘load_module’ methods (*note
     importlib.abc.Loader.load_module(): 5d8, *note
     importlib.abc.InspectLoader.load_module(): 930, *note
     importlib.abc.FileLoader.load_module(): 931, *note
     importlib.abc.SourceLoader.load_module(): 932.) should no longer be
     implemented, instead loaders should implement an ‘exec_module’
     method (*note importlib.abc.Loader.exec_module(): 5d9, *note
     importlib.abc.InspectLoader.exec_module(): 933. *note
     importlib.abc.SourceLoader.exec_module(): 934.) and let the import
     system take care of the rest; and *note
     importlib.abc.Loader.module_repr(): 935, *note
     importlib.util.module_for_loader(): 936, *note
     importlib.util.set_loader(): 937, and *note
     importlib.util.set_package(): 938. are no longer needed because
     their functions are now handled automatically by the import system.

   * The *note imp: 9a. module is pending deprecation.  To keep
     compatibility with Python 2/3 code bases, the module’s removal is
     currently not scheduled.

   * The *note formatter: 82. module is pending deprecation and is
     slated for removal in Python 3.6.

   * ‘MD5’ as the default `digestmod' for the *note hmac.new(): 848.
     function is deprecated.  Python 3.6 will require an explicit digest
     name or constructor as `digestmod' argument.

   * The internal ‘Netrc’ class in the *note ftplib: 84. module has been
     documented as deprecated in its docstring for quite some time.  It
     now emits a *note DeprecationWarning: 276. and will be removed
     completely in Python 3.5.

   * The undocumented `endtime' argument to *note
     subprocess.Popen.wait(): 587. should not have been exposed and is
     hopefully not in use; it is deprecated and will mostly likely be
     removed in Python 3.5.

   * The `strict' argument of *note HTMLParser: 7b3. is deprecated.

   * The *note plistlib: cf. *note readPlist(): 474, *note writePlist():
     939, *note readPlistFromBytes(): 475, and *note
     writePlistToBytes(): 93a. functions are deprecated in favor of the
     corresponding new functions *note load(): 87f, *note dump(): 880,
     *note loads(): 881, and *note dumps(): 882.  *note Data(): 93b. is
     deprecated in favor of just using the *note bytes: 326.
     constructor.

   * The *note sysconfig: fe. key ‘SO’ is deprecated, it has been
     replaced by ‘EXT_SUFFIX’.

   * The ‘U’ mode accepted by various ‘open’ functions is deprecated.
     In Python3 it does not do anything useful, and should be replaced
     by appropriate uses of *note io.TextIOWrapper: 5e8. (if needed) and
     its `newline' argument.

   * The `parser' argument of *note xml.etree.ElementTree.iterparse():
     93c. has been deprecated, as has the `html' argument of *note
     XMLParser(): 250.  To prepare for the removal of the latter, all
     arguments to ‘XMLParser’ should be passed by keyword.


File: python.info,  Node: Deprecated Features,  Prev: Deprecations in the Python API,  Up: Deprecated<4>

1.5.6.2 Deprecated Features
...........................

   * Running *note IDLE: 93e. with the ‘-n’ flag (no subprocess) is
     deprecated.  However, the feature will not be removed until
     bpo-18823(1) is resolved.

   * The site module adding a “site-python” directory to sys.path, if it
     exists, is deprecated (bpo-19375(2)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18823

   (2) https://bugs.python.org/issue19375


File: python.info,  Node: Removed<3>,  Next: Porting to Python 3 4,  Prev: Deprecated<4>,  Up: What’s New In Python 3 4

1.5.7 Removed
-------------

* Menu:

* Operating Systems No Longer Supported::
* API and Feature Removals: API and Feature Removals<5>.
* Code Cleanups::


File: python.info,  Node: Operating Systems No Longer Supported,  Next: API and Feature Removals<5>,  Up: Removed<3>

1.5.7.1 Operating Systems No Longer Supported
.............................................

Support for the following operating systems has been removed from the
source and build tools:

   * OS/2 (bpo-16135(1)).

   * Windows 2000 (changeset e52df05b496a).

   * Windows systems where ‘COMSPEC’ points to ‘command.com’
     (bpo-14470(2)).

   * VMS (bpo-16136(3)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16135

   (2) https://bugs.python.org/issue14470

   (3) https://bugs.python.org/issue16136


File: python.info,  Node: API and Feature Removals<5>,  Next: Code Cleanups,  Prev: Operating Systems No Longer Supported,  Up: Removed<3>

1.5.7.2 API and Feature Removals
................................

The following obsolete and previously deprecated APIs and features have
been removed:

   * The unmaintained ‘Misc/TextMate’ and ‘Misc/vim’ directories have
     been removed (see the devguide(1) for suggestions on what to use
     instead).

   * The ‘SO’ makefile macro is removed (it was replaced by the
     ‘SHLIB_SUFFIX’ and ‘EXT_SUFFIX’ macros) (bpo-16754(2)).

   * The ‘PyThreadState.tick_counter’ field has been removed; its value
     has been meaningless since Python 3.2, when the “new GIL” was
     introduced (bpo-19199(3)).

   * ‘PyLoader’ and ‘PyPycLoader’ have been removed from *note
     importlib: 9b.  (Contributed by Taras Lyapun in bpo-15641(4).)

   * The `strict' argument to *note HTTPConnection: 387. and *note
     HTTPSConnection: 388. has been removed.  HTTP 0.9-style “Simple
     Responses” are no longer supported.

   * The deprecated *note urllib.request.Request: 8ea. getter and setter
     methods ‘add_data’, ‘has_data’, ‘get_data’, ‘get_type’, ‘get_host’,
     ‘get_selector’, ‘set_proxy’, ‘get_origin_req_host’, and
     ‘is_unverifiable’ have been removed (use direct attribute access
     instead).

   * Support for loading the deprecated ‘TYPE_INT64’ has been removed
     from *note marshal: b0.  (Contributed by Dan Riti in bpo-15480(5).)

   * *note inspect.Signature: 6e7.: positional-only parameters are now
     required to have a valid name.

   * *note object.__format__(): 942. no longer accepts non-empty format
     strings, it now raises a *note TypeError: 192. instead.  Using a
     non-empty string has been deprecated since Python 3.2.  This change
     has been made to prevent a situation where previously working (but
     incorrect) code would start failing if an object gained a
     __format__ method, which means that your code may now raise a *note
     TypeError: 192. if you are using an ‘'s'’ format code with objects
     that do not have a __format__ method that handles it.  See
     bpo-7994(6) for background.

   * ‘difflib.SequenceMatcher.isbjunk()’ and
     ‘difflib.SequenceMatcher.isbpopular()’ were deprecated in 3.2, and
     have now been removed: use ‘x in sm.bjunk’ and ‘x in sm.bpopular’,
     where `sm' is a *note SequenceMatcher: 943. object (bpo-13248(7)).

   ---------- Footnotes ----------

   (1) https://devguide.python.org

   (2) https://bugs.python.org/issue16754

   (3) https://bugs.python.org/issue19199

   (4) https://bugs.python.org/issue15641

   (5) https://bugs.python.org/issue15480

   (6) https://bugs.python.org/issue7994

   (7) https://bugs.python.org/issue13248


File: python.info,  Node: Code Cleanups,  Prev: API and Feature Removals<5>,  Up: Removed<3>

1.5.7.3 Code Cleanups
.....................

   * The unused and undocumented internal ‘Scanner’ class has been
     removed from the *note pydoc: d9. module.

   * The private and effectively unused ‘_gestalt’ module has been
     removed, along with the private *note platform: ce. functions
     ‘_mac_ver_lookup’, ‘_mac_ver_gstalt’, and ‘_bcd2str’, which would
     only have ever been called on badly broken OSX systems (see
     bpo-18393(1)).

   * The hardcoded copies of certain *note stat: f4. constants that were
     included in the *note tarfile: 101. module namespace have been
     removed.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18393


File: python.info,  Node: Porting to Python 3 4,  Next: Changed in 3 4 3,  Prev: Removed<3>,  Up: What’s New In Python 3 4

1.5.8 Porting to Python 3.4
---------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code.

* Menu:

* Changes in ‘python’ Command Behavior: Changes in ‘python’ Command Behavior<2>.
* Changes in the Python API: Changes in the Python API<5>.
* Changes in the C API: Changes in the C API<5>.


File: python.info,  Node: Changes in ‘python’ Command Behavior<2>,  Next: Changes in the Python API<5>,  Up: Porting to Python 3 4

1.5.8.1 Changes in ‘python’ Command Behavior
............................................

   * In a posix shell, setting the ‘PATH’ environment variable to an
     empty value is equivalent to not setting it at all.  However,
     setting *note PYTHONPATH: 947. to an empty value was `not'
     equivalent to not setting it at all: setting *note PYTHONPATH: 947.
     to an empty value was equivalent to setting it to ‘.’, which leads
     to confusion when reasoning by analogy to how ‘PATH’ works.  The
     behavior now conforms to the posix convention for ‘PATH’.

   * The [X refs, Y blocks] output of a debug (‘--with-pydebug’) build
     of the CPython interpreter is now off by default.  It can be
     re-enabled using the ‘-X showrefcount’ option.  (Contributed by
     Ezio Melotti in bpo-17323(1).)

   * The python command and most stdlib scripts (as well as *note
     argparse: 6.) now output ‘--version’ information to ‘stdout’
     instead of ‘stderr’ (for issue list see *note Other Improvements:
     91e. above).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17323


File: python.info,  Node: Changes in the Python API<5>,  Next: Changes in the C API<5>,  Prev: Changes in ‘python’ Command Behavior<2>,  Up: Porting to Python 3 4

1.5.8.2 Changes in the Python API
.................................

   * The ABCs defined in *note importlib.abc: 9c. now either raise the
     appropriate exception or return a default value instead of raising
     *note NotImplementedError: 603. blindly.  This will only affect
     code calling *note super(): 4d7. and falling through all the way to
     the ABCs.  For compatibility, catch both *note NotImplementedError:
     603. or the appropriate exception as needed.

   * The module type now initializes the *note __package__: 949. and
     *note __loader__: 94a. attributes to ‘None’ by default.  To
     determine if these attributes were set in a backwards-compatible
     fashion, use e.g.  ‘getattr(module, '__loader__', None) is not
     None’.  (bpo-17115(1).)

   * *note importlib.util.module_for_loader(): 936. now sets
     ‘__loader__’ and ‘__package__’ unconditionally to properly support
     reloading.  If this is not desired then you will need to set these
     attributes manually.  You can use ‘importlib.util.module_to_load()’
     for module management.

   * Import now resets relevant attributes (e.g.  ‘__name__’,
     ‘__loader__’, ‘__package__’, ‘__file__’, ‘__cached__’)
     unconditionally when reloading.  Note that this restores a pre-3.3
     behavior in that it means a module is re-found when re-loaded
     (bpo-19413(2)).

   * Frozen packages no longer set ‘__path__’ to a list containing the
     package name, they now set it to an empty list.  The previous
     behavior could cause the import system to do the wrong thing on
     submodule imports if there was also a directory with the same name
     as the frozen package.  The correct way to determine if a module is
     a package or not is to use ‘hasattr(module, '__path__')’
     (bpo-18065(3)).

   * Frozen modules no longer define a ‘__file__’ attribute.  It’s
     semantically incorrect for frozen modules to set the attribute as
     they are not loaded from any explicit location.  If you must know
     that a module comes from frozen code then you can see if the
     module’s ‘__spec__.location’ is set to ‘'frozen'’, check if the
     loader is a subclass of *note importlib.machinery.FrozenImporter:
     94b, or if Python 2 compatibility is necessary you can use
     ‘imp.is_frozen()’.

   * *note py_compile.compile(): 213. now raises *note FileExistsError:
     94c. if the file path it would write to is a symlink or a
     non-regular file.  This is to act as a warning that import will
     overwrite those files with a regular file regardless of what type
     of file path they were originally.

   * *note importlib.abc.SourceLoader.get_source(): 94d. no longer
     raises *note ImportError: 329. when the source code being loaded
     triggers a *note SyntaxError: 44d. or *note UnicodeDecodeError:
     1fb.  As *note ImportError: 329. is meant to be raised only when
     source code cannot be found but it should, it was felt to be
     over-reaching/overloading of that meaning when the source code is
     found but improperly structured.  If you were catching ImportError
     before and wish to continue to ignore syntax or decoding issues,
     catch all three exceptions now.

   * *note functools.update_wrapper(): 94e. and *note functools.wraps():
     85e. now correctly set the ‘__wrapped__’ attribute to the function
     being wrapped, even if that function also had its ‘__wrapped__’
     attribute set.  This means ‘__wrapped__’ attributes now correctly
     link a stack of decorated functions rather than every ‘__wrapped__’
     attribute in the chain referring to the innermost function.
     Introspection libraries that assumed the previous behaviour was
     intentional can use *note inspect.unwrap(): 85d. to access the
     first function in the chain that has no ‘__wrapped__’ attribute.

   * *note inspect.getfullargspec(): 552. has been reimplemented on top
     of *note inspect.signature(): 550. and hence handles a much wider
     variety of callable objects than it did in the past.  It is
     expected that additional builtin and extension module callables
     will gain signature metadata over the course of the Python 3.4
     series.  Code that assumes that *note inspect.getfullargspec():
     552. will fail on non-Python callables may need to be adjusted
     accordingly.

   * *note importlib.machinery.PathFinder: 94f. now passes on the
     current working directory to objects in *note sys.path_hooks: 950.
     for the empty string.  This results in *note
     sys.path_importer_cache: 493. never containing ‘''’, thus iterating
     through *note sys.path_importer_cache: 493. based on *note
     sys.path: 47d. will not find all keys.  A module’s ‘__file__’ when
     imported in the current working directory will also now have an
     absolute path, including when using ‘-m’ with the interpreter
     (except for ‘__main__.__file__’ when a script has been executed
     directly using a relative path) (Contributed by Brett Cannon in
     bpo-18416(4)).  is specified on the command-line) (bpo-18416(5)).

   * The removal of the `strict' argument to *note HTTPConnection: 387.
     and *note HTTPSConnection: 388. changes the meaning of the
     remaining arguments if you are specifying them positionally rather
     than by keyword.  If you’ve been paying attention to deprecation
     warnings your code should already be specifying any additional
     arguments via keywords.

   * Strings between ‘from __future__ import ...’ statements now
     `always' raise a *note SyntaxError: 44d.  Previously if there was
     no leading docstring, an interstitial string would sometimes be
     ignored.  This brings CPython into compliance with the language
     spec; Jython and PyPy already were.  (bpo-17434(6)).

   * *note ssl.SSLSocket.getpeercert(): 8c5. and *note
     ssl.SSLSocket.do_handshake(): 74e. now raise an *note OSError: 1d1.
     with ‘ENOTCONN’ when the ‘SSLSocket’ is not connected, instead of
     the previous behavior of raising an *note AttributeError: 390.  In
     addition, *note getpeercert(): 8c5. will raise a *note ValueError:
     1f9. if the handshake has not yet been done.

   * *note base64.b32decode(): 951. now raises a *note binascii.Error:
     952. when the input string contains non-b32-alphabet characters,
     instead of a *note TypeError: 192.  This particular *note
     TypeError: 192. was missed when the other *note TypeError: 192.s
     were converted.  (Contributed by Serhiy Storchaka in bpo-18011(7).)
     Note: this change was also inadvertently applied in Python 3.3.3.

   * The ‘file’ attribute is now automatically closed when the creating
     ‘cgi.FieldStorage’ instance is garbage collected.  If you were
     pulling the file object out separately from the ‘cgi.FieldStorage’
     instance and not keeping the instance alive, then you should either
     store the entire ‘cgi.FieldStorage’ instance or read the contents
     of the file before the ‘cgi.FieldStorage’ instance is garbage
     collected.

   * Calling ‘read’ or ‘write’ on a closed SSL socket now raises an
     informative *note ValueError: 1f9. rather than the previous more
     mysterious *note AttributeError: 390. (bpo-9177(8)).

   * *note slice.indices(): 953. no longer produces an *note
     OverflowError: 954. for huge values.  As a consequence of this fix,
     *note slice.indices(): 953. now raises a *note ValueError: 1f9. if
     given a negative length; previously it returned nonsense values
     (bpo-14794(9)).

   * The *note complex: 189. constructor, unlike the *note cmath: 19.
     functions, was incorrectly accepting *note float: 187. values if an
     object’s ‘__complex__’ special method returned one.  This now
     raises a *note TypeError: 192.  (bpo-16290(10).)

   * The *note int: 184. constructor in 3.2 and 3.3 erroneously accepts
     *note float: 187. values for the `base' parameter.  It is unlikely
     anyone was doing this, but if so, it will now raise a *note
     TypeError: 192. (bpo-16772(11)).

   * Defaults for keyword-only arguments are now evaluated `after'
     defaults for regular keyword arguments, instead of before.
     Hopefully no one wrote any code that depends on the previous buggy
     behavior (bpo-16967(12)).

   * Stale thread states are now cleared after *note fork(): 955.  This
     may cause some system resources to be released that previously were
     incorrectly kept perpetually alive (for example, database
     connections kept in thread-local storage).  (bpo-17094(13).)

   * Parameter names in ‘__annotations__’ dicts are now mangled
     properly, similarly to ‘__kwdefaults__’.  (Contributed by Yury
     Selivanov in bpo-20625(14).)

   * *note hashlib.hash.name: 846. now always returns the identifier in
     lower case.  Previously some builtin hashes had uppercase names,
     but now that it is a formal public interface the naming has been
     made consistent (bpo-18532(15)).

   * Because *note unittest.TestSuite: 6c2. now drops references to
     tests after they are run, test harnesses that re-use a *note
     TestSuite: 6c2. to re-run a set of tests may fail.  Test suites
     should not be re-used in this fashion since it means state is
     retained between test runs, breaking the test isolation that *note
     unittest: 11b. is designed to provide.  However, if the lack of
     isolation is considered acceptable, the old behavior can be
     restored by creating a *note TestSuite: 6c2. subclass that defines
     a ‘_removeTestAtIndex’ method that does nothing (see *note
     TestSuite.__iter__(): 956.) (bpo-11798(16)).

   * *note unittest: 11b. now uses *note argparse: 6. for command line
     parsing.  There are certain invalid command forms that used to work
     that are no longer allowed; in theory this should not cause
     backward compatibility issues since the disallowed command forms
     didn’t make any sense and are unlikely to be in use.

   * The *note re.split(): 3bf, *note re.findall(): 957, and *note
     re.sub(): 470. functions, and the ‘group()’ and ‘groups()’ methods
     of ‘match’ objects now always return a `bytes' object when the
     string to be matched is a *note bytes-like object: 5dd.  Previously
     the return type matched the input type, so if your code was
     depending on the return value being, say, a ‘bytearray’, you will
     need to change your code.

   * *note audioop: d. functions now raise an error immediately if
     passed string input, instead of failing randomly later on
     (bpo-16685(17)).

   * The new `convert_charrefs' argument to *note HTMLParser: 7b3.
     currently defaults to ‘False’ for backward compatibility, but will
     eventually be changed to default to ‘True’.  It is recommended that
     you add this keyword, with the appropriate value, to any *note
     HTMLParser: 7b3. calls in your code (bpo-13633(18)).

   * Since the `digestmod' argument to the *note hmac.new(): 848.
     function will in the future have no default, all calls to *note
     hmac.new(): 848. should be changed to explicitly specify a
     `digestmod' (bpo-17276(19)).

   * Calling *note sysconfig.get_config_var(): 958. with the ‘SO’ key,
     or looking ‘SO’ up in the results of a call to *note
     sysconfig.get_config_vars(): 959. is deprecated.  This key should
     be replaced by ‘EXT_SUFFIX’ or ‘SHLIB_SUFFIX’, depending on the
     context (bpo-19555(20)).

   * Any calls to ‘open’ functions that specify ‘U’ should be modified.
     ‘U’ is ineffective in Python3 and will eventually raise an error if
     used.  Depending on the function, the equivalent of its old Python2
     behavior can be achieved using either a `newline' argument, or if
     necessary by wrapping the stream in *note TextIOWrapper: 5e8. to
     use its `newline' argument (bpo-15204(21)).

   * If you use ‘pyvenv’ in a script and desire that pip `not' be
     installed, you must add ‘--without-pip’ to your command invocation.

   * The default behavior of *note json.dump(): 5f9. and *note
     json.dumps(): 5fa. when an indent is specified has changed: it no
     longer produces trailing spaces after the item separating commas at
     the ends of lines.  This will matter only if you have tests that
     are doing white-space-sensitive comparisons of such output
     (bpo-16333(22)).

   * *note doctest: 67. now looks for doctests in extension module
     ‘__doc__’ strings, so if your doctest test discovery includes
     extension modules that have things that look like doctests in them
     you may see test failures you’ve never seen before when running
     your tests (bpo-3158(23)).

   * The *note collections.abc: 1f. module has been slightly refactored
     as part of the Python startup improvements.  As a consequence of
     this, it is no longer the case that importing *note collections:
     1e. automatically imports *note collections.abc: 1f.  If your
     program depended on the (undocumented) implicit import, you will
     need to add an explicit ‘import collections.abc’ (bpo-20784(24)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17115

   (2) https://bugs.python.org/issue19413

   (3) https://bugs.python.org/issue18065

   (4) https://bugs.python.org/issue18416

   (5) https://bugs.python.org/issue18416

   (6) https://bugs.python.org/issue17434

   (7) https://bugs.python.org/issue18011

   (8) https://bugs.python.org/issue9177

   (9) https://bugs.python.org/issue14794

   (10) https://bugs.python.org/issue16290

   (11) https://bugs.python.org/issue16772

   (12) https://bugs.python.org/issue16967

   (13) https://bugs.python.org/issue17094

   (14) https://bugs.python.org/issue20625

   (15) https://bugs.python.org/issue18532

   (16) https://bugs.python.org/issue11798

   (17) https://bugs.python.org/issue16685

   (18) https://bugs.python.org/issue13633

   (19) https://bugs.python.org/issue17276

   (20) https://bugs.python.org/issue19555

   (21) https://bugs.python.org/issue15204

   (22) https://bugs.python.org/issue16333

   (23) https://bugs.python.org/issue3158

   (24) https://bugs.python.org/issue20784


File: python.info,  Node: Changes in the C API<5>,  Prev: Changes in the Python API<5>,  Up: Porting to Python 3 4

1.5.8.3 Changes in the C API
............................

   * *note PyEval_EvalFrameEx(): 95b, *note PyObject_Repr(): 95c, and
     *note PyObject_Str(): 95d, along with some other internal C APIs,
     now include a debugging assertion that ensures they are not used in
     situations where they may silently discard a currently active
     exception.  In cases where discarding the active exception is
     expected and desired (for example, because it has already been
     saved locally with *note PyErr_Fetch(): 95e. or is being
     deliberately replaced with a different exception), an explicit
     *note PyErr_Clear(): 95f. call will be needed to avoid triggering
     the assertion when invoking these operations (directly or
     indirectly) and running against a version of Python that is
     compiled with assertions enabled.

   * *note PyErr_SetImportError(): 5ed. now sets *note TypeError: 192.
     when its `msg' argument is not set.  Previously only ‘NULL’ was
     returned with no exception set.

   * The result of the *note PyOS_ReadlineFunctionPointer: 960. callback
     must now be a string allocated by *note PyMem_RawMalloc(): 961. or
     *note PyMem_RawRealloc(): 962, or ‘NULL’ if an error occurred,
     instead of a string allocated by *note PyMem_Malloc(): 4fa. or
     *note PyMem_Realloc(): 963. (bpo-16742(1))

   * *note PyThread_set_key_value(): 964. now always set the value.  In
     Python 3.3, the function did nothing if the key already exists (if
     the current value is a non-‘NULL’ pointer).

   * The ‘f_tstate’ (thread state) field of the *note PyFrameObject:
     965. structure has been removed to fix a bug: see bpo-14432(2) for
     the rationale.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16742

   (2) https://bugs.python.org/issue14432


File: python.info,  Node: Changed in 3 4 3,  Prev: Porting to Python 3 4,  Up: What’s New In Python 3 4

1.5.9 Changed in 3.4.3
----------------------

* Menu:

* PEP 476; Enabling certificate verification by default for stdlib http clients: PEP 476 Enabling certificate verification by default for stdlib http clients.


File: python.info,  Node: PEP 476 Enabling certificate verification by default for stdlib http clients,  Up: Changed in 3 4 3

1.5.9.1 PEP 476: Enabling certificate verification by default for stdlib http clients
.....................................................................................

*note http.client: 94. and modules which use it, such as *note
urllib.request: 120. and *note xmlrpc.client: 13f, will now verify that
the server presents a certificate which is signed by a CA in the
platform trust store and whose hostname matches the hostname being
requested by default, significantly improving security for many
applications.

For applications which require the old previous behavior, they can pass
an alternate context:

     import urllib.request
     import ssl

     # This disables all verification
     context = ssl._create_unverified_context()

     # This allows using a specific certificate for the host, which doesn't need
     # to be in the trust store
     context = ssl.create_default_context(cafile="/path/to/file.crt")

     urllib.request.urlopen("https://invalid-cert", context=context)


File: python.info,  Node: What’s New In Python 3 3,  Next: What’s New In Python 3 2,  Prev: What’s New In Python 3 4,  Up: What’s New in Python

1.6 What’s New In Python 3.3
============================

This article explains the new features in Python 3.3, compared to 3.2.
Python 3.3 was released on September 29, 2012.  For full details, see
the changelog(1).

See also
........

PEP 398(2) - Python 3.3 Release Schedule

* Menu:

* Summary – Release highlights: Summary – Release highlights<4>.
* PEP 405; Virtual Environments: PEP 405 Virtual Environments.
* PEP 420; Implicit Namespace Packages: PEP 420 Implicit Namespace Packages.
* PEP 3118; New memoryview implementation and buffer protocol documentation: PEP 3118 New memoryview implementation and buffer protocol documentation.
* PEP 393; Flexible String Representation: PEP 393 Flexible String Representation.
* PEP 397; Python Launcher for Windows: PEP 397 Python Launcher for Windows.
* PEP 3151; Reworking the OS and IO exception hierarchy: PEP 3151 Reworking the OS and IO exception hierarchy.
* PEP 380; Syntax for Delegating to a Subgenerator: PEP 380 Syntax for Delegating to a Subgenerator.
* PEP 409; Suppressing exception context: PEP 409 Suppressing exception context.
* PEP 414; Explicit Unicode literals: PEP 414 Explicit Unicode literals.
* PEP 3155; Qualified name for classes and functions: PEP 3155 Qualified name for classes and functions.
* PEP 412; Key-Sharing Dictionary: PEP 412 Key-Sharing Dictionary.
* PEP 362; Function Signature Object: PEP 362 Function Signature Object.
* PEP 421; Adding sys.implementation: PEP 421 Adding sys implementation.
* Using importlib as the Implementation of Import::
* Other Language Changes: Other Language Changes<6>.
* A Finer-Grained Import Lock::
* Builtin functions and types::
* New Modules: New Modules<6>.
* Improved Modules: Improved Modules<6>.
* Optimizations: Optimizations<5>.
* Build and C API Changes: Build and C API Changes<4>.
* Deprecated: Deprecated<5>.
* Porting to Python 3.3: Porting to Python 3 3.

   ---------- Footnotes ----------

   (1) https://docs.python.org/3.3/whatsnew/changelog.html

   (2) https://www.python.org/dev/peps/pep-0398


File: python.info,  Node: Summary – Release highlights<4>,  Next: PEP 405 Virtual Environments,  Up: What’s New In Python 3 3

1.6.1 Summary – Release highlights
----------------------------------

New syntax features:

   * New ‘yield from’ expression for *note generator delegation: 96c.

   * The ‘u'unicode'’ syntax is accepted again for *note str: 325.
     objects.

New library modules:

   * *note faulthandler: 7d. (helps debugging low-level crashes)

   * *note ipaddress: a2. (high-level objects representing IP addresses
     and masks)

   * *note lzma: ad. (compress data using the XZ / LZMA algorithm)

   * *note unittest.mock: 11c. (replace parts of your system under test
     with mock objects)

   * *note venv: 125. (Python *note virtual environments: 96d, as in the
     popular ‘virtualenv’ package)

New built-in features:

   * Reworked *note I/O exception hierarchy: 96e.

Implementation improvements:

   * Rewritten *note import machinery: 96f. based on *note importlib:
     9b.

   * More compact *note unicode strings: 970.

   * More compact *note attribute dictionaries: 971.

Significantly Improved Library Modules:

   * C Accelerator for the *note decimal: 972. module.

   * Better unicode handling in the *note email: 973. module (*note
     provisional: 974.).

Security improvements:

   * Hash randomization is switched on by default.

Please read on for a comprehensive list of user-facing changes.


File: python.info,  Node: PEP 405 Virtual Environments,  Next: PEP 420 Implicit Namespace Packages,  Prev: Summary – Release highlights<4>,  Up: What’s New In Python 3 3

1.6.2 PEP 405: Virtual Environments
-----------------------------------

Virtual environments help create separate Python setups while sharing a
system-wide base install, for ease of maintenance.  Virtual environments
have their own set of private site packages (i.e.  locally-installed
libraries), and are optionally segregated from the system-wide site
packages.  Their concept and implementation are inspired by the popular
‘virtualenv’ third-party package, but benefit from tighter integration
with the interpreter core.

This PEP adds the *note venv: 125. module for programmatic access, and
the ‘pyvenv’ script for command-line access and administration.  The
Python interpreter checks for a ‘pyvenv.cfg’, file whose existence
signals the base of a virtual environment’s directory tree.

See also
........

PEP 405(1) - Python Virtual Environments

     PEP written by Carl Meyer; implementation by Carl Meyer and Vinay
     Sajip

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0405


File: python.info,  Node: PEP 420 Implicit Namespace Packages,  Next: PEP 3118 New memoryview implementation and buffer protocol documentation,  Prev: PEP 405 Virtual Environments,  Up: What’s New In Python 3 3

1.6.3 PEP 420: Implicit Namespace Packages
------------------------------------------

Native support for package directories that don’t require ‘__init__.py’
marker files and can automatically span multiple path segments (inspired
by various third party approaches to namespace packages, as described in
PEP 420(1))

See also
........

PEP 420(2) - Implicit Namespace Packages

     PEP written by Eric V. Smith; implementation by Eric V. Smith and
     Barry Warsaw

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0420

   (2) https://www.python.org/dev/peps/pep-0420


File: python.info,  Node: PEP 3118 New memoryview implementation and buffer protocol documentation,  Next: PEP 393 Flexible String Representation,  Prev: PEP 420 Implicit Namespace Packages,  Up: What’s New In Python 3 3

1.6.4 PEP 3118: New memoryview implementation and buffer protocol documentation
-------------------------------------------------------------------------------

The implementation of PEP 3118(1) has been significantly improved.

The new memoryview implementation comprehensively fixes all ownership
and lifetime issues of dynamically allocated fields in the Py_buffer
struct that led to multiple crash reports.  Additionally, several
functions that crashed or returned incorrect results for non-contiguous
or multi-dimensional input have been fixed.

The memoryview object now has a PEP-3118 compliant getbufferproc() that
checks the consumer’s request type.  Many new features have been added,
most of them work in full generality for non-contiguous arrays and
arrays with suboffsets.

The documentation has been updated, clearly spelling out
responsibilities for both exporters and consumers.  Buffer request flags
are grouped into basic and compound flags.  The memory layout of
non-contiguous and multi-dimensional NumPy-style arrays is explained.

* Menu:

* Features::
* API changes::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3118


File: python.info,  Node: Features,  Next: API changes,  Up: PEP 3118 New memoryview implementation and buffer protocol documentation

1.6.4.1 Features
................

   * All native single character format specifiers in struct module
     syntax (optionally prefixed with ‘@’) are now supported.

   * With some restrictions, the cast() method allows changing of format
     and shape of C-contiguous arrays.

   * Multi-dimensional list representations are supported for any array
     type.

   * Multi-dimensional comparisons are supported for any array type.

   * One-dimensional memoryviews of hashable (read-only) types with
     formats B, b or c are now hashable.  (Contributed by Antoine Pitrou
     in bpo-13411(1).)

   * Arbitrary slicing of any 1-D arrays type is supported.  For
     example, it is now possible to reverse a memoryview in O(1) by
     using a negative step.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13411


File: python.info,  Node: API changes,  Prev: Features,  Up: PEP 3118 New memoryview implementation and buffer protocol documentation

1.6.4.2 API changes
...................

   * The maximum number of dimensions is officially limited to 64.

   * The representation of empty shape, strides and suboffsets is now an
     empty tuple instead of ‘None’.

   * Accessing a memoryview element with format ‘B’ (unsigned bytes) now
     returns an integer (in accordance with the struct module syntax).
     For returning a bytes object the view must be cast to ‘c’ first.

   * memoryview comparisons now use the logical structure of the
     operands and compare all array elements by value.  All format
     strings in struct module syntax are supported.  Views with
     unrecognised format strings are still permitted, but will always
     compare as unequal, regardless of view contents.

   * For further changes see *note Build and C API Changes: 97b. and
     *note Porting C code: 97c.

(Contributed by Stefan Krah in bpo-10181(1).)

See also
........

PEP 3118(2) - Revising the Buffer Protocol

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10181

   (2) https://www.python.org/dev/peps/pep-3118


File: python.info,  Node: PEP 393 Flexible String Representation,  Next: PEP 397 Python Launcher for Windows,  Prev: PEP 3118 New memoryview implementation and buffer protocol documentation,  Up: What’s New In Python 3 3

1.6.5 PEP 393: Flexible String Representation
---------------------------------------------

The Unicode string type is changed to support multiple internal
representations, depending on the character with the largest Unicode
ordinal (1, 2, or 4 bytes) in the represented string.  This allows a
space-efficient representation in common cases, but gives access to full
UCS-4 on all systems.  For compatibility with existing APIs, several
representations may exist in parallel; over time, this compatibility
should be phased out.

On the Python side, there should be no downside to this change.

On the C API side, PEP 393(1) is fully backward compatible.  The legacy
API should remain available at least five years.  Applications using the
legacy API will not fully benefit of the memory reduction, or - worse -
may use a bit more memory, because Python may have to maintain two
versions of each string (in the legacy format and in the new efficient
storage).

* Menu:

* Functionality::
* Performance and resource usage::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393


File: python.info,  Node: Functionality,  Next: Performance and resource usage,  Up: PEP 393 Flexible String Representation

1.6.5.1 Functionality
.....................

Changes introduced by PEP 393(1) are the following:

   * Python now always supports the full range of Unicode code points,
     including non-BMP ones (i.e.  from ‘U+0000’ to ‘U+10FFFF’).  The
     distinction between narrow and wide builds no longer exists and
     Python now behaves like a wide build, even under Windows.

   * With the death of narrow builds, the problems specific to narrow
     builds have also been fixed, for example:

        * *note len(): 150. now always returns 1 for non-BMP characters,
          so ‘len('\U0010FFFF') == 1’;

        * surrogate pairs are not recombined in string literals, so
          ‘'\uDBFF\uDFFF' != '\U0010FFFF'’;

        * indexing or slicing non-BMP characters returns the expected
          value, so ‘'\U0010FFFF'[0]’ now returns ‘'\U0010FFFF'’ and not
          ‘'\uDBFF'’;

        * all other functions in the standard library now correctly
          handle non-BMP code points.

   * The value of *note sys.maxunicode: 97f. is now always ‘1114111’
     (‘0x10FFFF’ in hexadecimal).  The ‘PyUnicode_GetMax()’ function
     still returns either ‘0xFFFF’ or ‘0x10FFFF’ for backward
     compatibility, and it should not be used with the new Unicode API
     (see bpo-13054(2)).

   * The ‘./configure’ flag ‘--with-wide-unicode’ has been removed.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393

   (2) https://bugs.python.org/issue13054


File: python.info,  Node: Performance and resource usage,  Prev: Functionality,  Up: PEP 393 Flexible String Representation

1.6.5.2 Performance and resource usage
......................................

The storage of Unicode strings now depends on the highest code point in
the string:

   * pure ASCII and Latin1 strings (‘U+0000-U+00FF’) use 1 byte per code
     point;

   * BMP strings (‘U+0000-U+FFFF’) use 2 bytes per code point;

   * non-BMP strings (‘U+10000-U+10FFFF’) use 4 bytes per code point.

The net effect is that for most applications, memory usage of string
storage should decrease significantly - especially compared to former
wide unicode builds - as, in many cases, strings will be pure ASCII even
in international contexts (because many strings store non-human language
data, such as XML fragments, HTTP headers, JSON-encoded data, etc.).  We
also hope that it will, for the same reasons, increase CPU cache
efficiency on non-trivial applications.  The memory usage of Python 3.3
is two to three times smaller than Python 3.2, and a little bit better
than Python 2.7, on a Django benchmark (see the PEP for details).

See also
........

PEP 393(1) - Flexible String Representation

     PEP written by Martin von Löwis; implementation by Torsten Becker
     and Martin von Löwis.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393


File: python.info,  Node: PEP 397 Python Launcher for Windows,  Next: PEP 3151 Reworking the OS and IO exception hierarchy,  Prev: PEP 393 Flexible String Representation,  Up: What’s New In Python 3 3

1.6.6 PEP 397: Python Launcher for Windows
------------------------------------------

The Python 3.3 Windows installer now includes a ‘py’ launcher
application that can be used to launch Python applications in a version
independent fashion.

This launcher is invoked implicitly when double-clicking ‘*.py’ files.
If only a single Python version is installed on the system, that version
will be used to run the file.  If multiple versions are installed, the
most recent version is used by default, but this can be overridden by
including a Unix-style “shebang line” in the Python script.

The launcher can also be used explicitly from the command line as the
‘py’ application.  Running ‘py’ follows the same version selection rules
as implicitly launching scripts, but a more specific version can be
selected by passing appropriate arguments (such as ‘-3’ to request
Python 3 when Python 2 is also installed, or ‘-2.6’ to specifically
request an earlier Python version when a more recent version is
installed).

In addition to the launcher, the Windows installer now includes an
option to add the newly installed Python to the system PATH.
(Contributed by Brian Curtin in bpo-3561(1).)

See also
........

PEP 397(2) - Python Launcher for Windows

     PEP written by Mark Hammond and Martin v.  Löwis; implementation by
     Vinay Sajip.

Launcher documentation: *note Python Launcher for Windows: 983.

Installer PATH modification: *note Finding the Python executable: 984.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3561

   (2) https://www.python.org/dev/peps/pep-0397


File: python.info,  Node: PEP 3151 Reworking the OS and IO exception hierarchy,  Next: PEP 380 Syntax for Delegating to a Subgenerator,  Prev: PEP 397 Python Launcher for Windows,  Up: What’s New In Python 3 3

1.6.7 PEP 3151: Reworking the OS and IO exception hierarchy
-----------------------------------------------------------

The hierarchy of exceptions raised by operating system errors is now
both simplified and finer-grained.

You don’t have to worry anymore about choosing the appropriate exception
type between *note OSError: 1d1, *note IOError: 986, *note
EnvironmentError: 987, *note WindowsError: 988, ‘mmap.error’, *note
socket.error: 989. or *note select.error: 98a.  All these exception
types are now only one: *note OSError: 1d1.  The other names are kept as
aliases for compatibility reasons.

Also, it is now easier to catch a specific error condition.  Instead of
inspecting the ‘errno’ attribute (or ‘args[0]’) for a particular
constant from the *note errno: 7c. module, you can catch the adequate
*note OSError: 1d1. subclass.  The available subclasses are the
following:

   * *note BlockingIOError: 98b.

   * *note ChildProcessError: 98c.

   * *note ConnectionError: 6da.

   * *note FileExistsError: 94c.

   * *note FileNotFoundError: 7b4.

   * *note InterruptedError: 64d.

   * *note IsADirectoryError: 98d.

   * *note NotADirectoryError: 98e.

   * *note PermissionError: 5f4.

   * *note ProcessLookupError: 98f.

   * *note TimeoutError: 990.

And the *note ConnectionError: 6da. itself has finer-grained subclasses:

   * *note BrokenPipeError: 991.

   * *note ConnectionAbortedError: 992.

   * *note ConnectionRefusedError: 993.

   * *note ConnectionResetError: 994.

Thanks to the new exceptions, common usages of the *note errno: 7c. can
now be avoided.  For example, the following code written for Python 3.2:

     from errno import ENOENT, EACCES, EPERM

     try:
         with open("document.txt") as f:
             content = f.read()
     except IOError as err:
         if err.errno == ENOENT:
             print("document.txt file is missing")
         elif err.errno in (EACCES, EPERM):
             print("You are not allowed to read document.txt")
         else:
             raise

can now be written without the *note errno: 7c. import and without
manual inspection of exception attributes:

     try:
         with open("document.txt") as f:
             content = f.read()
     except FileNotFoundError:
         print("document.txt file is missing")
     except PermissionError:
         print("You are not allowed to read document.txt")

See also
........

PEP 3151(1) - Reworking the OS and IO Exception Hierarchy

     PEP written and implemented by Antoine Pitrou

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3151


File: python.info,  Node: PEP 380 Syntax for Delegating to a Subgenerator,  Next: PEP 409 Suppressing exception context,  Prev: PEP 3151 Reworking the OS and IO exception hierarchy,  Up: What’s New In Python 3 3

1.6.8 PEP 380: Syntax for Delegating to a Subgenerator
------------------------------------------------------

PEP 380 adds the ‘yield from’ expression, allowing a *note generator:
996. to delegate part of its operations to another generator.  This
allows a section of code containing *note yield: 18f. to be factored out
and placed in another generator.  Additionally, the subgenerator is
allowed to return with a value, and the value is made available to the
delegating generator.

While designed primarily for use in delegating to a subgenerator, the
‘yield from’ expression actually allows delegation to arbitrary
subiterators.

For simple iterators, ‘yield from iterable’ is essentially just a
shortened form of ‘for item in iterable: yield item’:

     >>> def g(x):
     ...     yield from range(x, 0, -1)
     ...     yield from range(x)
     ...
     >>> list(g(5))
     [5, 4, 3, 2, 1, 0, 1, 2, 3, 4]

However, unlike an ordinary loop, ‘yield from’ allows subgenerators to
receive sent and thrown values directly from the calling scope, and
return a final value to the outer generator:

     >>> def accumulate():
     ...     tally = 0
     ...     while 1:
     ...         next = yield
     ...         if next is None:
     ...             return tally
     ...         tally += next
     ...
     >>> def gather_tallies(tallies):
     ...     while 1:
     ...         tally = yield from accumulate()
     ...         tallies.append(tally)
     ...
     >>> tallies = []
     >>> acc = gather_tallies(tallies)
     >>> next(acc)  # Ensure the accumulator is ready to accept values
     >>> for i in range(4):
     ...     acc.send(i)
     ...
     >>> acc.send(None)  # Finish the first tally
     >>> for i in range(5):
     ...     acc.send(i)
     ...
     >>> acc.send(None)  # Finish the second tally
     >>> tallies
     [6, 10]

The main principle driving this change is to allow even generators that
are designed to be used with the ‘send’ and ‘throw’ methods to be split
into multiple subgenerators as easily as a single large function can be
split into multiple subfunctions.

See also
........

PEP 380(1) - Syntax for Delegating to a Subgenerator

     PEP written by Greg Ewing; implementation by Greg Ewing, integrated
     into 3.3 by Renaud Blanch, Ryan Kelly and Nick Coghlan;
     documentation by Zbigniew Jędrzejewski-Szmek and Nick Coghlan

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0380


File: python.info,  Node: PEP 409 Suppressing exception context,  Next: PEP 414 Explicit Unicode literals,  Prev: PEP 380 Syntax for Delegating to a Subgenerator,  Up: What’s New In Python 3 3

1.6.9 PEP 409: Suppressing exception context
--------------------------------------------

PEP 409 introduces new syntax that allows the display of the chained
exception context to be disabled.  This allows cleaner error messages in
applications that convert between exception types:

     >>> class D:
     ...     def __init__(self, extra):
     ...         self._extra_attributes = extra
     ...     def __getattr__(self, attr):
     ...         try:
     ...             return self._extra_attributes[attr]
     ...         except KeyError:
     ...             raise AttributeError(attr) from None
     ...
     >>> D({}).x
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
       File "<stdin>", line 8, in __getattr__
     AttributeError: x

Without the ‘from None’ suffix to suppress the cause, the original
exception would be displayed by default:

     >>> class C:
     ...     def __init__(self, extra):
     ...         self._extra_attributes = extra
     ...     def __getattr__(self, attr):
     ...         try:
     ...             return self._extra_attributes[attr]
     ...         except KeyError:
     ...             raise AttributeError(attr)
     ...
     >>> C({}).x
     Traceback (most recent call last):
       File "<stdin>", line 6, in __getattr__
     KeyError: 'x'

     During handling of the above exception, another exception occurred:

     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
       File "<stdin>", line 8, in __getattr__
     AttributeError: x

No debugging capability is lost, as the original exception context
remains available if needed (for example, if an intervening library has
incorrectly suppressed valuable underlying details):

     >>> try:
     ...     D({}).x
     ... except AttributeError as exc:
     ...     print(repr(exc.__context__))
     ...
     KeyError('x',)

See also
........

PEP 409(1) - Suppressing exception context

     PEP written by Ethan Furman; implemented by Ethan Furman and Nick
     Coghlan.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0409


File: python.info,  Node: PEP 414 Explicit Unicode literals,  Next: PEP 3155 Qualified name for classes and functions,  Prev: PEP 409 Suppressing exception context,  Up: What’s New In Python 3 3

1.6.10 PEP 414: Explicit Unicode literals
-----------------------------------------

To ease the transition from Python 2 for Unicode aware Python
applications that make heavy use of Unicode literals, Python 3.3 once
again supports the “‘u’” prefix for string literals.  This prefix has no
semantic significance in Python 3, it is provided solely to reduce the
number of purely mechanical changes in migrating to Python 3, making it
easier for developers to focus on the more significant semantic changes
(such as the stricter default separation of binary and text data).

See also
........

PEP 414(1) - Explicit Unicode literals

     PEP written by Armin Ronacher.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0414


File: python.info,  Node: PEP 3155 Qualified name for classes and functions,  Next: PEP 412 Key-Sharing Dictionary,  Prev: PEP 414 Explicit Unicode literals,  Up: What’s New In Python 3 3

1.6.11 PEP 3155: Qualified name for classes and functions
---------------------------------------------------------

Functions and class objects have a new ‘__qualname__’ attribute
representing the “path” from the module top-level to their definition.
For global functions and classes, this is the same as ‘__name__’.  For
other functions and classes, it provides better information about where
they were actually defined, and how they might be accessible from the
global scope.

Example with (non-bound) methods:

     >>> class C:
     ...     def meth(self):
     ...         pass
     >>> C.meth.__name__
     'meth'
     >>> C.meth.__qualname__
     'C.meth'

Example with nested classes:

     >>> class C:
     ...     class D:
     ...         def meth(self):
     ...             pass
     ...
     >>> C.D.__name__
     'D'
     >>> C.D.__qualname__
     'C.D'
     >>> C.D.meth.__name__
     'meth'
     >>> C.D.meth.__qualname__
     'C.D.meth'

Example with nested functions:

     >>> def outer():
     ...     def inner():
     ...         pass
     ...     return inner
     ...
     >>> outer().__name__
     'inner'
     >>> outer().__qualname__
     'outer.<locals>.inner'

The string representation of those objects is also changed to include
the new, more precise information:

     >>> str(C.D)
     "<class '__main__.C.D'>"
     >>> str(C.D.meth)
     '<function C.D.meth at 0x7f46b9fe31e0>'

See also
........

PEP 3155(1) - Qualified name for classes and functions

     PEP written and implemented by Antoine Pitrou.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3155


File: python.info,  Node: PEP 412 Key-Sharing Dictionary,  Next: PEP 362 Function Signature Object,  Prev: PEP 3155 Qualified name for classes and functions,  Up: What’s New In Python 3 3

1.6.12 PEP 412: Key-Sharing Dictionary
--------------------------------------

Dictionaries used for the storage of objects’ attributes are now able to
share part of their internal storage between each other (namely, the
part which stores the keys and their respective hashes).  This reduces
the memory consumption of programs creating many instances of
non-builtin types.

See also
........

PEP 412(1) - Key-Sharing Dictionary

     PEP written and implemented by Mark Shannon.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0412


File: python.info,  Node: PEP 362 Function Signature Object,  Next: PEP 421 Adding sys implementation,  Prev: PEP 412 Key-Sharing Dictionary,  Up: What’s New In Python 3 3

1.6.13 PEP 362: Function Signature Object
-----------------------------------------

A new function *note inspect.signature(): 550. makes introspection of
python callables easy and straightforward.  A broad range of callables
is supported: python functions, decorated or not, classes, and *note
functools.partial(): 7bc. objects.  New classes *note inspect.Signature:
6e7, *note inspect.Parameter: 6e8. and *note inspect.BoundArguments:
99c. hold information about the call signatures, such as, annotations,
default values, parameters kinds, and bound arguments, which
considerably simplifies writing decorators and any code that validates
or amends calling signatures or arguments.

See also
........

PEP 362(1): - Function Signature Object

     PEP written by Brett Cannon, Yury Selivanov, Larry Hastings, Jiwon
     Seo; implemented by Yury Selivanov.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0362


File: python.info,  Node: PEP 421 Adding sys implementation,  Next: Using importlib as the Implementation of Import,  Prev: PEP 362 Function Signature Object,  Up: What’s New In Python 3 3

1.6.14 PEP 421: Adding sys.implementation
-----------------------------------------

A new attribute on the *note sys: fd. module exposes details specific to
the implementation of the currently running interpreter.  The initial
set of attributes on *note sys.implementation: 99e. are ‘name’,
‘version’, ‘hexversion’, and ‘cache_tag’.

The intention of ‘sys.implementation’ is to consolidate into one
namespace the implementation-specific data used by the standard library.
This allows different Python implementations to share a single standard
library code base much more easily.  In its initial state,
‘sys.implementation’ holds only a small portion of the
implementation-specific data.  Over time that ratio will shift in order
to make the standard library more portable.

One example of improved standard library portability is ‘cache_tag’.  As
of Python 3.3, ‘sys.implementation.cache_tag’ is used by *note
importlib: 9b. to support PEP 3147(1) compliance.  Any Python
implementation that uses ‘importlib’ for its built-in import system may
use ‘cache_tag’ to control the caching behavior for modules.

* Menu:

* SimpleNamespace::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: SimpleNamespace,  Up: PEP 421 Adding sys implementation

1.6.14.1 SimpleNamespace
........................

The implementation of ‘sys.implementation’ also introduces a new type to
Python: *note types.SimpleNamespace: 9a0.  In contrast to a
mapping-based namespace, like *note dict: 1b6, ‘SimpleNamespace’ is
attribute-based, like *note object: 2ae.  However, unlike ‘object’,
‘SimpleNamespace’ instances are writable.  This means that you can add,
remove, and modify the namespace through normal attribute access.

See also
........

PEP 421(1) - Adding sys.implementation

     PEP written and implemented by Eric Snow.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0421


File: python.info,  Node: Using importlib as the Implementation of Import,  Next: Other Language Changes<6>,  Prev: PEP 421 Adding sys implementation,  Up: What’s New In Python 3 3

1.6.15 Using importlib as the Implementation of Import
------------------------------------------------------

bpo-2377(1) - Replace __import__ w/ importlib.__import__ bpo-13959(2) -
Re-implement parts of *note imp: 9a. in pure Python bpo-14605(3) - Make
import machinery explicit bpo-14646(4) - Require loaders set __loader__
and __package__

The *note __import__(): 605. function is now powered by *note
importlib.__import__(): 9a2.  This work leads to the completion of
“phase 2” of PEP 302(5).  There are multiple benefits to this change.
First, it has allowed for more of the machinery powering import to be
exposed instead of being implicit and hidden within the C code.  It also
provides a single implementation for all Python VMs supporting Python
3.3 to use, helping to end any VM-specific deviations in import
semantics.  And finally it eases the maintenance of import, allowing for
future growth to occur.

For the common user, there should be no visible change in semantics.
For those whose code currently manipulates import or calls import
programmatically, the code changes that might possibly be required are
covered in the *note Porting Python code: 9a3. section of this document.

* Menu:

* New APIs::
* Visible Changes::

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2377

   (2) https://bugs.python.org/issue13959

   (3) https://bugs.python.org/issue14605

   (4) https://bugs.python.org/issue14646

   (5) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: New APIs,  Next: Visible Changes,  Up: Using importlib as the Implementation of Import

1.6.15.1 New APIs
.................

One of the large benefits of this work is the exposure of what goes into
making the import statement work.  That means the various importers that
were once implicit are now fully exposed as part of the *note importlib:
9b. package.

The abstract base classes defined in *note importlib.abc: 9c. have been
expanded to properly delineate between *note meta path finders: 9a5. and
*note path entry finders: 9a6. by introducing *note
importlib.abc.MetaPathFinder: 9a7. and *note
importlib.abc.PathEntryFinder: 9a8, respectively.  The old ABC of *note
importlib.abc.Finder: 9a9. is now only provided for
backwards-compatibility and does not enforce any method requirements.

In terms of finders, *note importlib.machinery.FileFinder: 9aa. exposes
the mechanism used to search for source and bytecode files of a module.
Previously this class was an implicit member of *note sys.path_hooks:
950.

For loaders, the new abstract base class *note importlib.abc.FileLoader:
9ab. helps write a loader that uses the file system as the storage
mechanism for a module’s code.  The loader for source files (*note
importlib.machinery.SourceFileLoader: 9ac.), sourceless bytecode files
(*note importlib.machinery.SourcelessFileLoader: 9ad.), and extension
modules (*note importlib.machinery.ExtensionFileLoader: 54b.) are now
available for direct use.

*note ImportError: 329. now has ‘name’ and ‘path’ attributes which are
set when there is relevant data to provide.  The message for failed
imports will also provide the full name of the module now instead of
just the tail end of the module’s name.

The *note importlib.invalidate_caches(): 492. function will now call the
method with the same name on all finders cached in *note
sys.path_importer_cache: 493. to help clean up any stored state as
necessary.


File: python.info,  Node: Visible Changes,  Prev: New APIs,  Up: Using importlib as the Implementation of Import

1.6.15.2 Visible Changes
........................

For potential required changes to code, see the *note Porting Python
code: 9a3. section.

Beyond the expanse of what *note importlib: 9b. now exposes, there are
other visible changes to import.  The biggest is that *note
sys.meta_path: 5db. and *note sys.path_hooks: 950. now store all of the
meta path finders and path entry hooks used by import.  Previously the
finders were implicit and hidden within the C code of import instead of
being directly exposed.  This means that one can now easily remove or
change the order of the various finders to fit one’s needs.

Another change is that all modules have a ‘__loader__’ attribute,
storing the loader used to create the module.  PEP 302(1) has been
updated to make this attribute mandatory for loaders to implement, so in
the future once 3rd-party loaders have been updated people will be able
to rely on the existence of the attribute.  Until such time, though,
import is setting the module post-load.

Loaders are also now expected to set the ‘__package__’ attribute from
PEP 366(2).  Once again, import itself is already setting this on all
loaders from *note importlib: 9b. and import itself is setting the
attribute post-load.

‘None’ is now inserted into *note sys.path_importer_cache: 493. when no
finder can be found on *note sys.path_hooks: 950.  Since *note
imp.NullImporter: 9af. is not directly exposed on *note sys.path_hooks:
950. it could no longer be relied upon to always be available to use as
a value representing no finder found.

All other changes relate to semantic changes which should be taken into
consideration when updating code for Python 3.3, and thus should be read
about in the *note Porting Python code: 9a3. section of this document.

(Implementation by Brett Cannon)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0302

   (2) https://www.python.org/dev/peps/pep-0366


File: python.info,  Node: Other Language Changes<6>,  Next: A Finer-Grained Import Lock,  Prev: Using importlib as the Implementation of Import,  Up: What’s New In Python 3 3

1.6.16 Other Language Changes
-----------------------------

Some smaller changes made to the core Python language are:

   * Added support for Unicode name aliases and named sequences.  Both
     *note unicodedata.lookup(): 9b1. and ‘'\N{...}'’ now resolve name
     aliases, and *note unicodedata.lookup(): 9b1. resolves named
     sequences too.

     (Contributed by Ezio Melotti in bpo-12753(1).)

   * Unicode database updated to UCD version 6.1.0

   * Equality comparisons on *note range(): 9b2. objects now return a
     result reflecting the equality of the underlying sequences
     generated by those range objects.  (bpo-13201(2))

   * The ‘count()’, ‘find()’, ‘rfind()’, ‘index()’ and ‘rindex()’
     methods of *note bytes: 326. and *note bytearray: 327. objects now
     accept an integer between 0 and 255 as their first argument.

     (Contributed by Petri Lehtinen in bpo-12170(3).)

   * The ‘rjust()’, ‘ljust()’, and ‘center()’ methods of *note bytes:
     326. and *note bytearray: 327. now accept a *note bytearray: 327.
     for the ‘fill’ argument.  (Contributed by Petri Lehtinen in
     bpo-12380(4).)

   * New methods have been added to *note list: 260. and *note
     bytearray: 327.: ‘copy()’ and ‘clear()’ (bpo-10516(5)).
     Consequently, *note MutableSequence: 6a0. now also defines a
     ‘clear()’ method (bpo-11388(6)).

   * Raw bytes literals can now be written ‘rb"..."’ as well as
     ‘br"..."’.

     (Contributed by Antoine Pitrou in bpo-13748(7).)

   * *note dict.setdefault(): 9b3. now does only one lookup for the
     given key, making it atomic when used with built-in types.

     (Contributed by Filip Gruszczyński in bpo-13521(8).)

   * The error messages produced when a function call does not match the
     function signature have been significantly improved.

     (Contributed by Benjamin Peterson.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12753

   (2) https://bugs.python.org/issue13201

   (3) https://bugs.python.org/issue12170

   (4) https://bugs.python.org/issue12380

   (5) https://bugs.python.org/issue10516

   (6) https://bugs.python.org/issue11388

   (7) https://bugs.python.org/issue13748

   (8) https://bugs.python.org/issue13521


File: python.info,  Node: A Finer-Grained Import Lock,  Next: Builtin functions and types,  Prev: Other Language Changes<6>,  Up: What’s New In Python 3 3

1.6.17 A Finer-Grained Import Lock
----------------------------------

Previous versions of CPython have always relied on a global import lock.
This led to unexpected annoyances, such as deadlocks when importing a
module would trigger code execution in a different thread as a
side-effect.  Clumsy workarounds were sometimes employed, such as the
*note PyImport_ImportModuleNoBlock(): 9b5. C API function.

In Python 3.3, importing a module takes a per-module lock.  This
correctly serializes importation of a given module from multiple threads
(preventing the exposure of incompletely initialized modules), while
eliminating the aforementioned annoyances.

(Contributed by Antoine Pitrou in bpo-9260(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9260


File: python.info,  Node: Builtin functions and types,  Next: New Modules<6>,  Prev: A Finer-Grained Import Lock,  Up: What’s New In Python 3 3

1.6.18 Builtin functions and types
----------------------------------

   * *note open(): 4e5. gets a new `opener' parameter: the underlying
     file descriptor for the file object is then obtained by calling
     `opener' with (`file', `flags').  It can be used to use custom
     flags like *note os.O_CLOEXEC: 9b7. for example.  The ‘'x'’ mode
     was added: open for exclusive creation, failing if the file already
     exists.

   * *note print(): 87a.: added the `flush' keyword argument.  If the
     `flush' keyword argument is true, the stream is forcibly flushed.

   * *note hash(): 9b8.: hash randomization is enabled by default, see
     *note object.__hash__(): 335. and *note PYTHONHASHSEED: 9b9.

   * The *note str: 325. type gets a new *note casefold(): 6a4. method:
     return a casefolded copy of the string, casefolded strings may be
     used for caseless matching.  For example, ‘'ß'.casefold()’ returns
     ‘'ss'’.

   * The sequence documentation has been substantially rewritten to
     better explain the binary/text sequence distinction and to provide
     specific documentation sections for the individual builtin sequence
     types (bpo-4966(1)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4966


File: python.info,  Node: New Modules<6>,  Next: Improved Modules<6>,  Prev: Builtin functions and types,  Up: What’s New In Python 3 3

1.6.19 New Modules
------------------

* Menu:

* faulthandler: faulthandler<3>.
* ipaddress: ipaddress<4>.
* lzma: lzma<2>.


File: python.info,  Node: faulthandler<3>,  Next: ipaddress<4>,  Up: New Modules<6>

1.6.19.1 faulthandler
.....................

This new debug module *note faulthandler: 7d. contains functions to dump
Python tracebacks explicitly, on a fault (a crash like a segmentation
fault), after a timeout, or on a user signal.  Call *note
faulthandler.enable(): 53d. to install fault handlers for the ‘SIGSEGV’,
‘SIGFPE’, ‘SIGABRT’, ‘SIGBUS’, and ‘SIGILL’ signals.  You can also
enable them at startup by setting the *note PYTHONFAULTHANDLER: 9bc.
environment variable or by using *note -X: 155. ‘faulthandler’ command
line option.

Example of a segmentation fault on Linux:

     $ python -q -X faulthandler
     >>> import ctypes
     >>> ctypes.string_at(0)
     Fatal Python error: Segmentation fault

     Current thread 0x00007fb899f39700:
       File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
       File "<stdin>", line 1 in <module>
     Segmentation fault


File: python.info,  Node: ipaddress<4>,  Next: lzma<2>,  Prev: faulthandler<3>,  Up: New Modules<6>

1.6.19.2 ipaddress
..................

The new *note ipaddress: a2. module provides tools for creating and
manipulating objects representing IPv4 and IPv6 addresses, networks and
interfaces (i.e.  an IP address associated with a specific IP subnet).

(Contributed by Google and Peter Moody in PEP 3144(1).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3144


File: python.info,  Node: lzma<2>,  Prev: ipaddress<4>,  Up: New Modules<6>

1.6.19.3 lzma
.............

The newly-added *note lzma: ad. module provides data compression and
decompression using the LZMA algorithm, including support for the ‘.xz’
and ‘.lzma’ file formats.

(Contributed by Nadeem Vawda and Per Øyvind Karlsen in bpo-6715(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6715


File: python.info,  Node: Improved Modules<6>,  Next: Optimizations<5>,  Prev: New Modules<6>,  Up: What’s New In Python 3 3

1.6.20 Improved Modules
-----------------------

* Menu:

* abc: abc<2>.
* array: array<2>.
* base64: base64<2>.
* binascii: binascii<3>.
* bz2: bz2<2>.
* codecs::
* collections: collections<7>.
* contextlib: contextlib<5>.
* crypt: crypt<2>.
* curses: curses<3>.
* datetime: datetime<4>.
* decimal: decimal<3>.
* email: email<4>.
* ftplib::
* functools: functools<5>.
* gc: gc<4>.
* hmac: hmac<3>.
* http: http<3>.
* html: html<2>.
* imaplib: imaplib<2>.
* inspect: inspect<5>.
* io: io<4>.
* itertools: itertools<3>.
* logging: logging<6>.
* math: math<5>.
* mmap: mmap<3>.
* multiprocessing: multiprocessing<6>.
* nntplib::
* os: os<7>.
* pdb: pdb<4>.
* pickle: pickle<5>.
* pydoc: pydoc<4>.
* re: re<6>.
* sched::
* select: select<2>.
* shlex: shlex<3>.
* shutil: shutil<4>.
* signal: signal<3>.
* smtpd: smtpd<3>.
* smtplib: smtplib<3>.
* socket: socket<7>.
* socketserver: socketserver<3>.
* sqlite3: sqlite3<5>.
* ssl: ssl<8>.
* stat: stat<2>.
* struct: struct<3>.
* subprocess: subprocess<5>.
* sys: sys<7>.
* tarfile: tarfile<4>.
* tempfile::
* textwrap: textwrap<2>.
* threading: threading<5>.
* time: time<5>.
* types: types<4>.
* unittest: unittest<5>.
* urllib: urllib<3>.
* webbrowser::
* xml.etree.ElementTree: xml etree ElementTree.
* zlib: zlib<2>.


File: python.info,  Node: abc<2>,  Next: array<2>,  Up: Improved Modules<6>

1.6.20.1 abc
............

Improved support for abstract base classes containing descriptors
composed with abstract methods.  The recommended approach to declaring
abstract descriptors is now to provide ‘__isabstractmethod__’ as a
dynamically updated property.  The built-in descriptors have been
updated accordingly.

        * *note abc.abstractproperty: 9c1. has been deprecated, use
          *note property: 1d5. with *note abc.abstractmethod(): 9c2.
          instead.

        * *note abc.abstractclassmethod: 9c3. has been deprecated, use
          *note classmethod: 1d6. with *note abc.abstractmethod(): 9c2.
          instead.

        * *note abc.abstractstaticmethod: 9c4. has been deprecated, use
          *note staticmethod: 1d7. with *note abc.abstractmethod(): 9c2.
          instead.

(Contributed by Darren Dale in bpo-11610(1).)

*note abc.ABCMeta.register(): 9c5. now returns the registered subclass,
which means it can now be used as a class decorator (bpo-10868(2)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11610

   (2) https://bugs.python.org/issue10868


File: python.info,  Node: array<2>,  Next: base64<2>,  Prev: abc<2>,  Up: Improved Modules<6>

1.6.20.2 array
..............

The *note array: 7. module supports the ‘long long’ type using ‘q’ and
‘Q’ type codes.

(Contributed by Oren Tirosh and Hirokazu Yamamoto in bpo-1172711(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1172711


File: python.info,  Node: base64<2>,  Next: binascii<3>,  Prev: array<2>,  Up: Improved Modules<6>

1.6.20.3 base64
...............

ASCII-only Unicode strings are now accepted by the decoding functions of
the *note base64: e. modern interface.  For example,
‘base64.b64decode('YWJj')’ returns ‘b'abc'’.  (Contributed by Catalin
Iacob in bpo-13641(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13641


File: python.info,  Node: binascii<3>,  Next: bz2<2>,  Prev: base64<2>,  Up: Improved Modules<6>

1.6.20.4 binascii
.................

In addition to the binary objects they normally accept, the ‘a2b_’
functions now all also accept ASCII-only strings as input.  (Contributed
by Antoine Pitrou in bpo-13637(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13637


File: python.info,  Node: bz2<2>,  Next: codecs,  Prev: binascii<3>,  Up: Improved Modules<6>

1.6.20.5 bz2
............

The *note bz2: 14. module has been rewritten from scratch.  In the
process, several new features have been added:

   * New *note bz2.open(): 9ca. function: open a bzip2-compressed file
     in binary or text mode.

   * *note bz2.BZ2File: 925. can now read from and write to arbitrary
     file-like objects, by means of its constructor’s `fileobj'
     argument.

     (Contributed by Nadeem Vawda in bpo-5863(1).)

   * *note bz2.BZ2File: 925. and *note bz2.decompress(): 9cb. can now
     decompress multi-stream inputs (such as those produced by the
     ‘pbzip2’ tool).  *note bz2.BZ2File: 925. can now also be used to
     create this type of file, using the ‘'a'’ (append) mode.

     (Contributed by Nir Aides in bpo-1625(2).)

   * *note bz2.BZ2File: 925. now implements all of the *note
     io.BufferedIOBase: 57d. API, except for the ‘detach()’ and
     ‘truncate()’ methods.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5863

   (2) https://bugs.python.org/issue1625


File: python.info,  Node: codecs,  Next: collections<7>,  Prev: bz2<2>,  Up: Improved Modules<6>

1.6.20.6 codecs
...............

The *note mbcs: 78. codec has been rewritten to handle correctly
‘replace’ and ‘ignore’ error handlers on all Windows versions.  The
*note mbcs: 78. codec now supports all error handlers, instead of only
‘replace’ to encode and ‘ignore’ to decode.

A new Windows-only codec has been added: ‘cp65001’ (bpo-13216(1)).  It
is the Windows code page 65001 (Windows UTF-8, ‘CP_UTF8’).  For example,
it is used by ‘sys.stdout’ if the console output code page is set to
cp65001 (e.g., using ‘chcp 65001’ command).

Multibyte CJK decoders now resynchronize faster.  They only ignore the
first byte of an invalid byte sequence.  For example,
‘b'\xff\n'.decode('gb2312', 'replace')’ now returns a ‘\n’ after the
replacement character.

(bpo-12016(2))

Incremental CJK codec encoders are no longer reset at each call to their
encode() methods.  For example:

     >>> import codecs
     >>> encoder = codecs.getincrementalencoder('hz')('strict')
     >>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
     b'~{NpJ)l6HK!#~} Bye.'

This example gives ‘b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.'’ with older
Python versions.

(bpo-12100(3))

The ‘unicode_internal’ codec has been deprecated.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13216

   (2) https://bugs.python.org/issue12016

   (3) https://bugs.python.org/issue12100


File: python.info,  Node: collections<7>,  Next: contextlib<5>,  Prev: codecs,  Up: Improved Modules<6>

1.6.20.7 collections
....................

Addition of a new *note ChainMap: 49f. class to allow treating a number
of mappings as a single unit.  (Written by Raymond Hettinger for
bpo-11089(1), made public in bpo-11297(2).)

The abstract base classes have been moved in a new *note
collections.abc: 1f. module, to better differentiate between the
abstract and the concrete collections classes.  Aliases for ABCs are
still present in the *note collections: 1e. module to preserve existing
imports.  (bpo-11085(3))

The *note Counter: 9ce. class now supports the unary ‘+’ and ‘-’
operators, as well as the in-place operators ‘+=’, ‘-=’, ‘|=’, and ‘&=’.
(Contributed by Raymond Hettinger in bpo-13121(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11089

   (2) https://bugs.python.org/issue11297

   (3) https://bugs.python.org/issue11085

   (4) https://bugs.python.org/issue13121


File: python.info,  Node: contextlib<5>,  Next: crypt<2>,  Prev: collections<7>,  Up: Improved Modules<6>

1.6.20.8 contextlib
...................

*note ExitStack: 36b. now provides a solid foundation for programmatic
manipulation of context managers and similar cleanup functionality.
Unlike the previous ‘contextlib.nested’ API (which was deprecated and
removed), the new API is designed to work correctly regardless of
whether context managers acquire their resources in their ‘__init__’
method (for example, file objects) or in their ‘__enter__’ method (for
example, synchronisation objects from the *note threading: 109. module).

(bpo-13585(1))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13585


File: python.info,  Node: crypt<2>,  Next: curses<3>,  Prev: contextlib<5>,  Up: Improved Modules<6>

1.6.20.9 crypt
..............

Addition of salt and modular crypt format (hashing method) and the *note
mksalt(): 371. function to the *note crypt: 29. module.

(bpo-10924(1))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10924


File: python.info,  Node: curses<3>,  Next: datetime<4>,  Prev: crypt<2>,  Up: Improved Modules<6>

1.6.20.10 curses
................

        * If the *note curses: 2c. module is linked to the ncursesw
          library, use Unicode functions when Unicode strings or
          characters are passed (e.g.  ‘waddwstr()’), and bytes
          functions otherwise (e.g.  ‘waddstr()’).

        * Use the locale encoding instead of ‘utf-8’ to encode Unicode
          strings.

        * ‘curses.window’ has a new *note curses.window.encoding: 9d2.
          attribute.

        * The ‘curses.window’ class has a new *note get_wch(): 9d3.
          method to get a wide character

        * The *note curses: 2c. module has a new *note unget_wch(): 9d4.
          function to push a wide character so the next *note get_wch():
          9d3. will return it

(Contributed by Iñigo Serna in bpo-6755(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6755


File: python.info,  Node: datetime<4>,  Next: decimal<3>,  Prev: curses<3>,  Up: Improved Modules<6>

1.6.20.11 datetime
..................

        * Equality comparisons between naive and aware *note datetime:
          194. instances now return *note False: 37d. instead of raising
          *note TypeError: 192. (bpo-15006(1)).

        * New *note datetime.datetime.timestamp(): 9d6. method: Return
          POSIX timestamp corresponding to the *note datetime: 194.
          instance.

        * The *note datetime.datetime.strftime(): 52c. method supports
          formatting years older than 1000.

        * The *note datetime.datetime.astimezone(): 196. method can now
          be called without arguments to convert datetime instance to
          the system timezone.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15006


File: python.info,  Node: decimal<3>,  Next: email<4>,  Prev: datetime<4>,  Up: Improved Modules<6>

1.6.20.12 decimal
.................

bpo-7652(1) - integrate fast native decimal arithmetic.

     C-module and libmpdec written by Stefan Krah.

The new C version of the decimal module integrates the high speed
libmpdec library for arbitrary precision correctly-rounded decimal
floating point arithmetic.  libmpdec conforms to IBM’s General Decimal
Arithmetic Specification.

Performance gains range from 10x for database applications to 100x for
numerically intensive applications.  These numbers are expected gains
for standard precisions used in decimal floating point arithmetic.
Since the precision is user configurable, the exact figures may vary.
For example, in integer bignum arithmetic the differences can be
significantly higher.

The following table is meant as an illustration.  Benchmarks are
available at ‘http://www.bytereef.org/mpdecimal/quickstart.html’.

                   decimal.py        _decimal           speedup
                                                        
     ---------------------------------------------------------------------
                                                        
     pi            42.02s            0.345s             120x
                                                        
                                                        
     telco         172.19s           5.68s              30x
                                                        
                                                        
     psycopg       3.57s             0.29s              12x
                                                        

* Menu:

* Features: Features<2>.
* API changes: API changes<2>.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7652


File: python.info,  Node: Features<2>,  Next: API changes<2>,  Up: decimal<3>

1.6.20.13 Features
..................

   * The *note FloatOperation: 9d9. signal optionally enables stricter
     semantics for mixing floats and Decimals.

   * If Python is compiled without threads, the C version automatically
     disables the expensive thread local context machinery.  In this
     case, the variable *note HAVE_THREADS: 9da. is set to ‘False’.


File: python.info,  Node: API changes<2>,  Prev: Features<2>,  Up: decimal<3>

1.6.20.14 API changes
.....................

   * The C module has the following context limits, depending on the
     machine architecture:

                                  32-bit                    64-bit
                                                            
          -------------------------------------------------------------------------------------
                                                            
          ‘MAX_PREC’              ‘425000000’               ‘999999999999999999’
                                                            
                                                            
          ‘MAX_EMAX’              ‘425000000’               ‘999999999999999999’
                                                            
                                                            
          ‘MIN_EMIN’              ‘-425000000’              ‘-999999999999999999’
                                                            

   * In the context templates (*note DefaultContext: 9dc, *note
     BasicContext: 9dd. and *note ExtendedContext: 9de.) the magnitude
     of ‘Emax’ and ‘Emin’ has changed to ‘999999’.

   * The *note Decimal: 188. constructor in decimal.py does not observe
     the context limits and converts values with arbitrary exponents or
     precision exactly.  Since the C version has internal limits, the
     following scheme is used: If possible, values are converted
     exactly, otherwise *note InvalidOperation: 9df. is raised and the
     result is NaN. In the latter case it is always possible to use
     *note create_decimal(): 9e0. in order to obtain a rounded or
     inexact value.

   * The power function in decimal.py is always correctly-rounded.  In
     the C version, it is defined in terms of the correctly-rounded
     *note exp(): 9e1. and *note ln(): 9e2. functions, but the final
     result is only “almost always correctly rounded”.

   * In the C version, the context dictionary containing the signals is
     a *note MutableMapping: 9e3.  For speed reasons, ‘flags’ and
     ‘traps’ always refer to the same *note MutableMapping: 9e3. that
     the context was initialized with.  If a new signal dictionary is
     assigned, ‘flags’ and ‘traps’ are updated with the new values, but
     they do not reference the RHS dictionary.

   * Pickling a *note Context: 9e4. produces a different output in order
     to have a common interchange format for the Python and C versions.

   * The order of arguments in the *note Context: 9e4. constructor has
     been changed to match the order displayed by *note repr(): 7c0.

   * The ‘watchexp’ parameter in the *note quantize(): 9e5. method is
     deprecated.


File: python.info,  Node: email<4>,  Next: ftplib,  Prev: decimal<3>,  Up: Improved Modules<6>

1.6.20.15 email
...............

* Menu:

* Policy Framework::
* Provisional Policy with New Header API::
* Other API Changes::


File: python.info,  Node: Policy Framework,  Next: Provisional Policy with New Header API,  Up: email<4>

1.6.20.16 Policy Framework
..........................

The email package now has a *note policy: 75. framework.  A *note
Policy: 9e8. is an object with several methods and properties that
control how the email package behaves.  The primary policy for Python
3.3 is the *note Compat32: 9e9. policy, which provides backward
compatibility with the email package in Python 3.2.  A ‘policy’ can be
specified when an email message is parsed by a *note parser: 74, or when
a *note Message: 536. object is created, or when an email is serialized
using a *note generator: 6e.  Unless overridden, a policy passed to a
‘parser’ is inherited by all the ‘Message’ object and sub-objects
created by the ‘parser’.  By default a ‘generator’ will use the policy
of the ‘Message’ object it is serializing.  The default policy is *note
compat32: 535.

The minimum set of controls implemented by all ‘policy’ objects are:

     max_line_length     The maximum length, excluding the linesep character(s),
                         individual lines may have when a ‘Message’ is serialized.
                         Defaults to 78.
                         
                         
     linesep             The character used to separate individual lines when a
                         ‘Message’ is serialized.  Defaults to ‘\n’.
                         
                         
     cte_type            ‘7bit’ or ‘8bit’.  ‘8bit’ applies only to a ‘Bytes’
                         ‘generator’, and means that non-ASCII may be used where
                         allowed by the protocol (or where it exists in the
                         original input).
                         
                         
     raise_on_defect     Causes a ‘parser’ to raise error when defects are
                         encountered instead of adding them to the ‘Message’
                         object’s ‘defects’ list.
                         

A new policy instance, with new settings, is created using the *note
clone(): 9ea. method of policy objects.  ‘clone’ takes any of the above
controls as keyword arguments.  Any control not specified in the call
retains its default value.  Thus you can create a policy that uses
‘\r\n’ linesep characters like this:

     mypolicy = compat32.clone(linesep='\r\n')

Policies can be used to make the generation of messages in the format
needed by your application simpler.  Instead of having to remember to
specify ‘linesep='\r\n'’ in all the places you call a ‘generator’, you
can specify it once, when you set the policy used by the ‘parser’ or the
‘Message’, whichever your program uses to create ‘Message’ objects.  On
the other hand, if you need to generate messages in multiple forms, you
can still specify the parameters in the appropriate ‘generator’ call.
Or you can have custom policy instances for your different cases, and
pass those in when you create the ‘generator’.


File: python.info,  Node: Provisional Policy with New Header API,  Next: Other API Changes,  Prev: Policy Framework,  Up: email<4>

1.6.20.17 Provisional Policy with New Header API
................................................

While the policy framework is worthwhile all by itself, the main
motivation for introducing it is to allow the creation of new policies
that implement new features for the email package in a way that
maintains backward compatibility for those who do not use the new
policies.  Because the new policies introduce a new API, we are
releasing them in Python 3.3 as a *note provisional policy: 974.
Backwards incompatible changes (up to and including removal of the code)
may occur if deemed necessary by the core developers.

The new policies are instances of *note EmailPolicy: 9ec, and add the
following additional controls:

     refold_source       Controls whether or not headers parsed by a
                         *note parser: 74. are refolded by the
                         *note generator: 6e.  It can be ‘none’, ‘long’, or ‘all’.
                         The default is ‘long’, which means that source headers
                         with a line longer than ‘max_line_length’ get refolded.
                         ‘none’ means no line get refolded, and ‘all’ means that
                         all lines get refolded.
                         
                         
     header_factory      A callable that take a ‘name’ and ‘value’ and produces a
                         custom header object.
                         

The ‘header_factory’ is the key to the new features provided by the new
policies.  When one of the new policies is used, any header retrieved
from a ‘Message’ object is an object produced by the ‘header_factory’,
and any time you set a header on a ‘Message’ it becomes an object
produced by ‘header_factory’.  All such header objects have a ‘name’
attribute equal to the header name.  Address and Date headers have
additional attributes that give you access to the parsed data of the
header.  This means you can now do things like this:

     >>> m = Message(policy=SMTP)
     >>> m['To'] = 'Éric <foo@example.com>'
     >>> m['to']
     'Éric <foo@example.com>'
     >>> m['to'].addresses
     (Address(display_name='Éric', username='foo', domain='example.com'),)
     >>> m['to'].addresses[0].username
     'foo'
     >>> m['to'].addresses[0].display_name
     'Éric'
     >>> m['Date'] = email.utils.localtime()
     >>> m['Date'].datetime
     datetime.datetime(2012, 5, 25, 21, 39, 24, 465484, tzinfo=datetime.timezone(datetime.timedelta(-1, 72000), 'EDT'))
     >>> m['Date']
     'Fri, 25 May 2012 21:44:27 -0400'
     >>> print(m)
     To: =?utf-8?q?=C3=89ric?= <foo@example.com>
     Date: Fri, 25 May 2012 21:44:27 -0400

You will note that the unicode display name is automatically encoded as
‘utf-8’ when the message is serialized, but that when the header is
accessed directly, you get the unicode version.  This eliminates any
need to deal with the *note email.header: 6f. *note decode_header():
9ed. or *note make_header(): 9ee. functions.

You can also create addresses from parts:

     >>> m['cc'] = [Group('pals', [Address('Bob', 'bob', 'example.com'),
     ...                           Address('Sally', 'sally', 'example.com')]),
     ...            Address('Bonzo', addr_spec='bonz@laugh.com')]
     >>> print(m)
     To: =?utf-8?q?=C3=89ric?= <foo@example.com>
     Date: Fri, 25 May 2012 21:44:27 -0400
     cc: pals: Bob <bob@example.com>, Sally <sally@example.com>;, Bonzo <bonz@laugh.com>

Decoding to unicode is done automatically:

     >>> m2 = message_from_string(str(m))
     >>> m2['to']
     'Éric <foo@example.com>'

When you parse a message, you can use the ‘addresses’ and ‘groups’
attributes of the header objects to access the groups and individual
addresses:

     >>> m2['cc'].addresses
     (Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com'), Address(display_name='Bonzo', username='bonz', domain='laugh.com'))
     >>> m2['cc'].groups
     (Group(display_name='pals', addresses=(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com')), Group(display_name=None, addresses=(Address(display_name='Bonzo', username='bonz', domain='laugh.com'),))

In summary, if you use one of the new policies, header manipulation
works the way it ought to: your application works with unicode strings,
and the email package transparently encodes and decodes the unicode to
and from the RFC standard Content Transfer Encodings.


File: python.info,  Node: Other API Changes,  Prev: Provisional Policy with New Header API,  Up: email<4>

1.6.20.18 Other API Changes
...........................

New *note BytesHeaderParser: 9f0, added to the *note parser: 74. module
to complement *note HeaderParser: 9f1. and complete the Bytes API.

New utility functions:

        * *note format_datetime(): 9f2.: given a *note datetime: 194,
          produce a string formatted for use in an email header.

        * *note parsedate_to_datetime(): 9f3.: given a date string from
          an email header, convert it into an aware *note datetime: 194,
          or a naive *note datetime: 194. if the offset is ‘-0000’.

        * *note localtime(): 9f4.: With no argument, returns the current
          local time as an aware *note datetime: 194. using the local
          *note timezone: 9f5.  Given an aware *note datetime: 194,
          converts it into an aware *note datetime: 194. using the local
          *note timezone: 9f5.


File: python.info,  Node: ftplib,  Next: functools<5>,  Prev: email<4>,  Up: Improved Modules<6>

1.6.20.19 ftplib
................

   * *note ftplib.FTP: 9f7. now accepts a ‘source_address’ keyword
     argument to specify the ‘(host, port)’ to use as the source address
     in the bind call when creating the outgoing socket.  (Contributed
     by Giampaolo Rodolà in bpo-8594(1).)

   * The *note FTP_TLS: 9f8. class now provides a new *note ccc(): 9f9.
     function to revert control channel back to plaintext.  This can be
     useful to take advantage of firewalls that know how to handle NAT
     with non-secure FTP without opening fixed ports.  (Contributed by
     Giampaolo Rodolà in bpo-12139(2).)

   * Added *note ftplib.FTP.mlsd(): 9fa. method which provides a
     parsable directory listing format and deprecates *note
     ftplib.FTP.nlst(): 9fb. and *note ftplib.FTP.dir(): 9fc.
     (Contributed by Giampaolo Rodolà in bpo-11072(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8594

   (2) https://bugs.python.org/issue12139

   (3) https://bugs.python.org/issue11072


File: python.info,  Node: functools<5>,  Next: gc<4>,  Prev: ftplib,  Up: Improved Modules<6>

1.6.20.20 functools
...................

The *note functools.lru_cache(): 1c5. decorator now accepts a ‘typed’
keyword argument (that defaults to ‘False’ to ensure that it caches
values of different types that compare equal in separate cache slots.
(Contributed by Raymond Hettinger in bpo-13227(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13227


File: python.info,  Node: gc<4>,  Next: hmac<3>,  Prev: functools<5>,  Up: Improved Modules<6>

1.6.20.21 gc
............

It is now possible to register callbacks invoked by the garbage
collector before and after collection using the new *note callbacks:
9ff. list.


File: python.info,  Node: hmac<3>,  Next: http<3>,  Prev: gc<4>,  Up: Improved Modules<6>

1.6.20.22 hmac
..............

A new *note compare_digest(): a01. function has been added to prevent
side channel attacks on digests through timing analysis.  (Contributed
by Nick Coghlan and Christian Heimes in bpo-15061(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15061


File: python.info,  Node: http<3>,  Next: html<2>,  Prev: hmac<3>,  Up: Improved Modules<6>

1.6.20.23 http
..............

*note http.server.BaseHTTPRequestHandler: a03. now buffers the headers
and writes them all at once when *note end_headers(): a04. is called.  A
new method *note flush_headers(): a05. can be used to directly manage
when the accumulated headers are sent.  (Contributed by Andrew Schaaf in
bpo-3709(1).)

*note http.server: 97. now produces valid ‘HTML 4.01 strict’ output.
(Contributed by Ezio Melotti in bpo-13295(2).)

*note http.client.HTTPResponse: a06. now has a *note readinto(): a07.
method, which means it can be used as an *note io.RawIOBase: a08. class.
(Contributed by John Kuhn in bpo-13464(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3709

   (2) https://bugs.python.org/issue13295

   (3) https://bugs.python.org/issue13464


File: python.info,  Node: html<2>,  Next: imaplib<2>,  Prev: http<3>,  Up: Improved Modules<6>

1.6.20.24 html
..............

*note html.parser.HTMLParser: 7b3. is now able to parse broken markup
without raising errors, therefore the `strict' argument of the
constructor and the ‘HTMLParseError’ exception are now deprecated.  The
ability to parse broken markup is the result of a number of bug fixes
that are also available on the latest bug fix releases of Python
2.7/3.2.  (Contributed by Ezio Melotti in bpo-15114(1), and
bpo-14538(2), bpo-13993(3), bpo-13960(4), bpo-13358(5), bpo-1745761(6),
bpo-755670(7), bpo-13357(8), bpo-12629(9), bpo-1200313(10),
bpo-670664(11), bpo-13273(12), bpo-12888(13), bpo-7311(14).)

A new *note html5: a0a. dictionary that maps HTML5 named character
references to the equivalent Unicode character(s) (e.g.  ‘html5['gt;']
== '>'’) has been added to the *note html.entities: 91. module.  The
dictionary is now also used by *note HTMLParser: 7b3.  (Contributed by
Ezio Melotti in bpo-11113(15) and bpo-15156(16).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15114

   (2) https://bugs.python.org/issue14538

   (3) https://bugs.python.org/issue13993

   (4) https://bugs.python.org/issue13960

   (5) https://bugs.python.org/issue13358

   (6) https://bugs.python.org/issue1745761

   (7) https://bugs.python.org/issue755670

   (8) https://bugs.python.org/issue13357

   (9) https://bugs.python.org/issue12629

   (10) https://bugs.python.org/issue1200313

   (11) https://bugs.python.org/issue670664

   (12) https://bugs.python.org/issue13273

   (13) https://bugs.python.org/issue12888

   (14) https://bugs.python.org/issue7311

   (15) https://bugs.python.org/issue11113

   (16) https://bugs.python.org/issue15156


File: python.info,  Node: imaplib<2>,  Next: inspect<5>,  Prev: html<2>,  Up: Improved Modules<6>

1.6.20.25 imaplib
.................

The *note IMAP4_SSL: a0c. constructor now accepts an SSLContext
parameter to control parameters of the secure channel.

(Contributed by Sijin Joseph in bpo-8808(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8808


File: python.info,  Node: inspect<5>,  Next: io<4>,  Prev: imaplib<2>,  Up: Improved Modules<6>

1.6.20.26 inspect
.................

A new *note getclosurevars(): a0e. function has been added.  This
function reports the current binding of all names referenced from the
function body and where those names were resolved, making it easier to
verify correct internal state when testing code that relies on stateful
closures.

(Contributed by Meador Inge and Nick Coghlan in bpo-13062(1).)

A new *note getgeneratorlocals(): a0f. function has been added.  This
function reports the current binding of local variables in the
generator’s stack frame, making it easier to verify correct internal
state when testing generators.

(Contributed by Meador Inge in bpo-15153(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13062

   (2) https://bugs.python.org/issue15153


File: python.info,  Node: io<4>,  Next: itertools<3>,  Prev: inspect<5>,  Up: Improved Modules<6>

1.6.20.27 io
............

The *note open(): 64e. function has a new ‘'x'’ mode that can be used to
exclusively create a new file, and raise a *note FileExistsError: 94c.
if the file already exists.  It is based on the C11 ‘x’ mode to fopen().

(Contributed by David Townshend in bpo-12760(1).)

The constructor of the *note TextIOWrapper: 5e8. class has a new
`write_through' optional argument.  If `write_through' is ‘True’, calls
to ‘write()’ are guaranteed not to be buffered: any data written on the
*note TextIOWrapper: 5e8. object is immediately handled to its
underlying binary buffer.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12760


File: python.info,  Node: itertools<3>,  Next: logging<6>,  Prev: io<4>,  Up: Improved Modules<6>

1.6.20.28 itertools
...................

*note accumulate(): 1db. now takes an optional ‘func’ argument for
providing a user-supplied binary function.


File: python.info,  Node: logging<6>,  Next: math<5>,  Prev: itertools<3>,  Up: Improved Modules<6>

1.6.20.29 logging
.................

The *note basicConfig(): 1de. function now supports an optional
‘handlers’ argument taking an iterable of handlers to be added to the
root logger.

A class level attribute ‘append_nul’ has been added to *note
SysLogHandler: a13. to allow control of the appending of the ‘NUL’
(‘\000’) byte to syslog records, since for some daemons it is required
while for others it is passed through to the log.


File: python.info,  Node: math<5>,  Next: mmap<3>,  Prev: logging<6>,  Up: Improved Modules<6>

1.6.20.30 math
..............

The *note math: b1. module has a new function, *note log2(): a15, which
returns the base-2 logarithm of `x'.

(Written by Mark Dickinson in bpo-11888(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11888


File: python.info,  Node: mmap<3>,  Next: multiprocessing<6>,  Prev: math<5>,  Up: Improved Modules<6>

1.6.20.31 mmap
..............

The *note read(): a17. method is now more compatible with other
file-like objects: if the argument is omitted or specified as ‘None’, it
returns the bytes from the current file position to the end of the
mapping.  (Contributed by Petri Lehtinen in bpo-12021(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12021


File: python.info,  Node: multiprocessing<6>,  Next: nntplib,  Prev: mmap<3>,  Up: Improved Modules<6>

1.6.20.32 multiprocessing
.........................

The new *note multiprocessing.connection.wait(): a19. function allows
polling multiple objects (such as connections, sockets and pipes) with a
timeout.  (Contributed by Richard Oudkerk in bpo-12328(1).)

‘multiprocessing.Connection’ objects can now be transferred over
multiprocessing connections.  (Contributed by Richard Oudkerk in
bpo-4892(2).)

*note multiprocessing.Process: 3a7. now accepts a ‘daemon’ keyword
argument to override the default behavior of inheriting the ‘daemon’
flag from the parent process (bpo-6064(3)).

New attribute *note multiprocessing.Process.sentinel: a1a. allows a
program to wait on multiple *note Process: 3a7. objects at one time
using the appropriate OS primitives (for example, *note select: e5. on
posix systems).

New methods *note multiprocessing.pool.Pool.starmap(): a1b. and *note
starmap_async(): a1c. provide *note itertools.starmap(): a1d.
equivalents to the existing *note multiprocessing.pool.Pool.map(): a1e.
and *note map_async(): a1f. functions.  (Contributed by Hynek Schlawack
in bpo-12708(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12328

   (2) https://bugs.python.org/issue4892

   (3) https://bugs.python.org/issue6064

   (4) https://bugs.python.org/issue12708


File: python.info,  Node: nntplib,  Next: os<7>,  Prev: multiprocessing<6>,  Up: Improved Modules<6>

1.6.20.33 nntplib
.................

The *note nntplib.NNTP: a21. class now supports the context management
protocol to unconditionally consume *note socket.error: 989. exceptions
and to close the NNTP connection when done:

     >>> from nntplib import NNTP
     >>> with NNTP('news.gmane.org') as n:
     ...     n.group('gmane.comp.python.committers')
     ...
     ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
     >>>

(Contributed by Giampaolo Rodolà in bpo-9795(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9795


File: python.info,  Node: os<7>,  Next: pdb<4>,  Prev: nntplib,  Up: Improved Modules<6>

1.6.20.34 os
............

   * The *note os: c4. module has a new *note pipe2(): a23. function
     that makes it possible to create a pipe with *note O_CLOEXEC: 9b7.
     or *note O_NONBLOCK: 717. flags set atomically.  This is especially
     useful to avoid race conditions in multi-threaded programs.

   * The *note os: c4. module has a new *note sendfile(): 34e. function
     which provides an efficient “zero-copy” way for copying data from
     one file (or socket) descriptor to another.  The phrase “zero-copy”
     refers to the fact that all of the copying of data between the two
     descriptors is done entirely by the kernel, with no copying of data
     into userspace buffers.  *note sendfile(): 34e. can be used to
     efficiently copy data from a file on disk to a network socket, e.g.
     for downloading a file.

     (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in
     bpo-10882(1).)

   * To avoid race conditions like symlink attacks and issues with
     temporary files and directories, it is more reliable (and also
     faster) to manipulate file descriptors instead of file names.
     Python 3.3 enhances existing functions and introduces new functions
     to work on file descriptors (bpo-4761(2), bpo-10755(3) and
     bpo-14626(4)).

        - The *note os: c4. module has a new *note fwalk(): 3a9.
          function similar to *note walk(): 648. except that it also
          yields file descriptors referring to the directories visited.
          This is especially useful to avoid symlink races.

        - The following functions get new optional `dir_fd' (*note paths
          relative to directory descriptors: a24.) and/or
          `follow_symlinks' (*note not following symlinks: a25.): *note
          access(): a26, *note chflags(): a27, *note chmod(): a28, *note
          chown(): a29, *note link(): a2a, *note lstat(): 1f0, *note
          mkdir(): a2b, *note mkfifo(): 657, *note mknod(): 658, *note
          open(): 659, *note readlink(): 1f1, *note remove(): a2c, *note
          rename(): a2d, *note replace(): a2e, *note rmdir(): a2f, *note
          stat(): 1ef, *note symlink(): a30, *note unlink(): a31, *note
          utime(): a32.  Platform support for using these parameters can
          be checked via the sets *note os.supports_dir_fd: a33. and
          ‘os.supports_follows_symlinks’.

        - The following functions now support a file descriptor for
          their path argument: *note chdir(): a34, *note chmod(): a28,
          *note chown(): a29, *note execve(): a35, *note listdir(): a36,
          *note pathconf(): a37, *note exists(): 1f4, *note stat(): 1ef,
          *note statvfs(): a38, *note utime(): a32.  Platform support
          for this can be checked via the *note os.supports_fd: a39.
          set.

   * *note access(): a26. accepts an ‘effective_ids’ keyword argument to
     turn on using the effective uid/gid rather than the real uid/gid in
     the access check.  Platform support for this can be checked via the
     *note supports_effective_ids: a3a. set.

   * The *note os: c4. module has two new functions: *note
     getpriority(): a3b. and *note setpriority(): a3c.  They can be used
     to get or set process niceness/priority in a fashion similar to
     *note os.nice(): a3d. but extended to all processes instead of just
     the current one.

     (Patch submitted by Giampaolo Rodolà in bpo-10784(5).)

   * The new *note os.replace(): a2e. function allows cross-platform
     renaming of a file with overwriting the destination.  With *note
     os.rename(): a2d, an existing destination file is overwritten under
     POSIX, but raises an error under Windows.  (Contributed by Antoine
     Pitrou in bpo-8828(6).)

   * The stat family of functions (*note stat(): 1ef, *note fstat():
     653, and *note lstat(): 1f0.) now support reading a file’s
     timestamps with nanosecond precision.  Symmetrically, *note
     utime(): a32. can now write file timestamps with nanosecond
     precision.  (Contributed by Larry Hastings in bpo-14127(7).)

   * The new *note os.get_terminal_size(): a3e. function queries the
     size of the terminal attached to a file descriptor.  See also *note
     shutil.get_terminal_size(): a3f.  (Contributed by Zbigniew
     Jędrzejewski-Szmek in bpo-13609(8).)

   * New functions to support Linux extended attributes (bpo-12720(9)):
     *note getxattr(): a40, *note listxattr(): a41, *note removexattr():
     a42, *note setxattr(): a43.

   * New interface to the scheduler.  These functions control how a
     process is allocated CPU time by the operating system.  New
     functions: *note sched_get_priority_max(): a44, *note
     sched_get_priority_min(): a45, *note sched_getaffinity(): a46,
     *note sched_getparam(): a47, *note sched_getscheduler(): a48, *note
     sched_rr_get_interval(): a49, *note sched_setaffinity(): a4a, *note
     sched_setparam(): a4b, *note sched_setscheduler(): a4c, *note
     sched_yield(): a4d,

   * New functions to control the file system:

        * *note posix_fadvise(): 65a.: Announces an intention to access
          data in a specific pattern thus allowing the kernel to make
          optimizations.

        * *note posix_fallocate(): 65b.: Ensures that enough disk space
          is allocated for a file.

        * *note sync(): a4e.: Force write of everything to disk.

   * Additional new posix functions:

        * *note lockf(): a4f.: Apply, test or remove a POSIX lock on an
          open file descriptor.

        * *note pread(): 3ae.: Read from a file descriptor at an offset,
          the file offset remains unchanged.

        * *note pwrite(): 3b1.: Write to a file descriptor from an
          offset, leaving the file offset unchanged.

        * *note readv(): 3ad.: Read from a file descriptor into a number
          of writable buffers.

        * *note truncate(): 718.: Truncate the file corresponding to
          `path', so that it is at most `length' bytes in size.

        * *note waitid(): 660.: Wait for the completion of one or more
          child processes.

        * *note writev(): 3b0.: Write the contents of `buffers' to a
          file descriptor, where `buffers' is an arbitrary sequence of
          buffers.

        * *note getgrouplist(): a50. (bpo-9344(10)): Return list of
          group ids that specified user belongs to.

   * *note times(): a51. and *note uname(): a52.: Return type changed
     from a tuple to a tuple-like object with named attributes.

   * Some platforms now support additional constants for the *note
     lseek(): a53. function, such as ‘os.SEEK_HOLE’ and ‘os.SEEK_DATA’.

   * New constants *note RTLD_LAZY: a54, *note RTLD_NOW: a55, *note
     RTLD_GLOBAL: a56, *note RTLD_LOCAL: a57, *note RTLD_NODELETE: a58,
     *note RTLD_NOLOAD: a59, and *note RTLD_DEEPBIND: a5a. are available
     on platforms that support them.  These are for use with the *note
     sys.setdlopenflags(): a5b. function, and supersede the similar
     constants defined in *note ctypes: 2b. and ‘DLFCN’.  (Contributed
     by Victor Stinner in bpo-13226(11).)

   * *note os.symlink(): a30. now accepts (and ignores) the
     ‘target_is_directory’ keyword argument on non-Windows platforms, to
     ease cross-platform support.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10882

   (2) https://bugs.python.org/issue4761

   (3) https://bugs.python.org/issue10755

   (4) https://bugs.python.org/issue14626

   (5) https://bugs.python.org/issue10784

   (6) https://bugs.python.org/issue8828

   (7) https://bugs.python.org/issue14127

   (8) https://bugs.python.org/issue13609

   (9) https://bugs.python.org/issue12720

   (10) https://bugs.python.org/issue9344

   (11) https://bugs.python.org/issue13226


File: python.info,  Node: pdb<4>,  Next: pickle<5>,  Prev: os<7>,  Up: Improved Modules<6>

1.6.20.35 pdb
.............

Tab-completion is now available not only for command names, but also
their arguments.  For example, for the ‘break’ command, function and
file names are completed.

(Contributed by Georg Brandl in bpo-14210(1))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14210


File: python.info,  Node: pickle<5>,  Next: pydoc<4>,  Prev: pdb<4>,  Up: Improved Modules<6>

1.6.20.36 pickle
................

*note pickle.Pickler: 20b. objects now have an optional *note
dispatch_table: a5e. attribute allowing per-pickler reduction functions
to be set.

(Contributed by Richard Oudkerk in bpo-14166(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14166


File: python.info,  Node: pydoc<4>,  Next: re<6>,  Prev: pickle<5>,  Up: Improved Modules<6>

1.6.20.37 pydoc
...............

The Tk GUI and the ‘serve()’ function have been removed from the *note
pydoc: d9. module: ‘pydoc -g’ and ‘serve()’ have been deprecated in
Python 3.2.


File: python.info,  Node: re<6>,  Next: sched,  Prev: pydoc<4>,  Up: Improved Modules<6>

1.6.20.38 re
............

*note str: 325. regular expressions now support ‘\u’ and ‘\U’ escapes.

(Contributed by Serhiy Storchaka in bpo-3665(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3665


File: python.info,  Node: sched,  Next: select<2>,  Prev: re<6>,  Up: Improved Modules<6>

1.6.20.39 sched
...............

   * *note run(): a62. now accepts a `blocking' parameter which when set
     to false makes the method execute the scheduled events due to
     expire soonest (if any) and then return immediately.  This is
     useful in case you want to use the *note scheduler: a63. in
     non-blocking applications.  (Contributed by Giampaolo Rodolà in
     bpo-13449(1).)

   * *note scheduler: a63. class can now be safely used in
     multi-threaded environments.  (Contributed by Josiah Carlson and
     Giampaolo Rodolà in bpo-8684(2).)

   * `timefunc' and `delayfunct' parameters of *note scheduler: a63.
     class constructor are now optional and defaults to *note
     time.time(): 312. and *note time.sleep(): 674. respectively.
     (Contributed by Chris Clark in bpo-13245(3).)

   * *note enter(): a64. and *note enterabs(): a65. `argument' parameter
     is now optional.  (Contributed by Chris Clark in bpo-13245(4).)

   * *note enter(): a64. and *note enterabs(): a65. now accept a
     `kwargs' parameter.  (Contributed by Chris Clark in bpo-13245(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13449

   (2) https://bugs.python.org/issue8684

   (3) https://bugs.python.org/issue13245

   (4) https://bugs.python.org/issue13245

   (5) https://bugs.python.org/issue13245


File: python.info,  Node: select<2>,  Next: shlex<3>,  Prev: sched,  Up: Improved Modules<6>

1.6.20.40 select
................

Solaris and derivative platforms have a new class *note select.devpoll:
89f. for high performance asynchronous sockets via ‘/dev/poll’.
(Contributed by Jesús Cea Avión in bpo-6397(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6397


File: python.info,  Node: shlex<3>,  Next: shutil<4>,  Prev: select<2>,  Up: Improved Modules<6>

1.6.20.41 shlex
...............

The previously undocumented helper function ‘quote’ from the *note
pipes: cc. modules has been moved to the *note shlex: e8. module and
documented.  *note quote(): a68. properly escapes all characters in a
string that might be otherwise given special meaning by the shell.


File: python.info,  Node: shutil<4>,  Next: signal<3>,  Prev: shlex<3>,  Up: Improved Modules<6>

1.6.20.42 shutil
................

   * New functions:

        * *note disk_usage(): a6a.: provides total, used and free disk
          space statistics.  (Contributed by Giampaolo Rodolà in
          bpo-12442(1).)

        * *note chown(): a6b.: allows one to change user and/or group of
          the given path also specifying the user/group names and not
          only their numeric ids.  (Contributed by Sandro Tosi in
          bpo-12191(2).)

        * *note shutil.get_terminal_size(): a3f.: returns the size of
          the terminal window to which the interpreter is attached.
          (Contributed by Zbigniew Jędrzejewski-Szmek in bpo-13609(3).)

   * *note copy2(): 258. and *note copystat(): a6c. now preserve file
     timestamps with nanosecond precision on platforms that support it.
     They also preserve file “extended attributes” on Linux.
     (Contributed by Larry Hastings in bpo-14127(4) and bpo-15238(5).)

   * Several functions now take an optional ‘symlinks’ argument: when
     that parameter is true, symlinks aren’t dereferenced and the
     operation instead acts on the symlink itself (or creates one, if
     relevant).  (Contributed by Hynek Schlawack in bpo-12715(6).)

   * When copying files to a different file system, *note move(): 259.
     now handles symlinks the way the posix ‘mv’ command does,
     recreating the symlink rather than copying the target file
     contents.  (Contributed by Jonathan Niehof in bpo-9993(7).)  *note
     move(): 259. now also returns the ‘dst’ argument as its result.

   * *note rmtree(): 21a. is now resistant to symlink attacks on
     platforms which support the new ‘dir_fd’ parameter in *note
     os.open(): 659. and *note os.unlink(): a31.  (Contributed by Martin
     von Löwis and Hynek Schlawack in bpo-4489(8).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12442

   (2) https://bugs.python.org/issue12191

   (3) https://bugs.python.org/issue13609

   (4) https://bugs.python.org/issue14127

   (5) https://bugs.python.org/issue15238

   (6) https://bugs.python.org/issue12715

   (7) https://bugs.python.org/issue9993

   (8) https://bugs.python.org/issue4489


File: python.info,  Node: signal<3>,  Next: smtpd<3>,  Prev: shutil<4>,  Up: Improved Modules<6>

1.6.20.43 signal
................

   * The *note signal: ea. module has new functions:

        * *note pthread_sigmask(): a6e.: fetch and/or change the signal
          mask of the calling thread (Contributed by Jean-Paul Calderone
          in bpo-8407(1));

        * *note pthread_kill(): a6f.: send a signal to a thread;

        * *note sigpending(): a70.: examine pending functions;

        * *note sigwait(): a71.: wait a signal;

        * *note sigwaitinfo(): 673.: wait for a signal, returning
          detailed information about it;

        * *note sigtimedwait(): 672.: like *note sigwaitinfo(): 673. but
          with a timeout.

   * The signal handler writes the signal number as a single byte
     instead of a nul byte into the wakeup file descriptor.  So it is
     possible to wait more than one signal and know which signals were
     raised.

   * *note signal.signal(): a72. and *note signal.siginterrupt(): a73.
     raise an OSError, instead of a RuntimeError: OSError has an errno
     attribute.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8407


File: python.info,  Node: smtpd<3>,  Next: smtplib<3>,  Prev: signal<3>,  Up: Improved Modules<6>

1.6.20.44 smtpd
...............

The *note smtpd: ec. module now supports RFC 5321(1) (extended SMTP) and
RFC 1870(2) (size extension).  Per the standard, these extensions are
enabled if and only if the client initiates the session with an ‘EHLO’
command.

(Initial ‘ELHO’ support by Alberto Trevino.  Size extension by Juhana
Jauhiainen.  Substantial additional work on the patch contributed by
Michele Orrù and Dan Boswell.  bpo-8739(3))

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc5321.html

   (2) https://tools.ietf.org/html/rfc1870.html

   (3) https://bugs.python.org/issue8739


File: python.info,  Node: smtplib<3>,  Next: socket<7>,  Prev: smtpd<3>,  Up: Improved Modules<6>

1.6.20.45 smtplib
.................

The *note SMTP: a76, *note SMTP_SSL: a77, and *note LMTP: a78. classes
now accept a ‘source_address’ keyword argument to specify the ‘(host,
port)’ to use as the source address in the bind call when creating the
outgoing socket.  (Contributed by Paulo Scardine in bpo-11281(1).)

*note SMTP: a76. now supports the context management protocol, allowing
an ‘SMTP’ instance to be used in a ‘with’ statement.  (Contributed by
Giampaolo Rodolà in bpo-11289(2).)

The *note SMTP_SSL: a77. constructor and the *note starttls(): a79.
method now accept an SSLContext parameter to control parameters of the
secure channel.  (Contributed by Kasun Herath in bpo-8809(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11281

   (2) https://bugs.python.org/issue11289

   (3) https://bugs.python.org/issue8809


File: python.info,  Node: socket<7>,  Next: socketserver<3>,  Prev: smtplib<3>,  Up: Improved Modules<6>

1.6.20.46 socket
................

   * The *note socket: 668. class now exposes additional methods to
     process ancillary data when supported by the underlying platform:

        * *note sendmsg(): 670.

        * *note recvmsg(): 66d.

        * *note recvmsg_into(): a7b.

     (Contributed by David Watson in bpo-6560(1), based on an earlier
     patch by Heiko Wundram)

   * The *note socket: 668. class now supports the PF_CAN protocol
     family (‘https://en.wikipedia.org/wiki/Socketcan’), on Linux
     (‘https://lwn.net/Articles/253425’).

     (Contributed by Matthias Fuchs, updated by Tiago Gonçalves in
     bpo-10141(2).)

   * The *note socket: 668. class now supports the PF_RDS protocol
     family (‘https://en.wikipedia.org/wiki/Reliable_Datagram_Sockets’
     and ‘https://oss.oracle.com/projects/rds/’).

   * The *note socket: 668. class now supports the ‘PF_SYSTEM’ protocol
     family on OS X. (Contributed by Michael Goderbauer in
     bpo-13777(3).)

   * New function *note sethostname(): a7c. allows the hostname to be
     set on unix systems if the calling process has sufficient
     privileges.  (Contributed by Ross Lagerwall in bpo-10866(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6560

   (2) https://bugs.python.org/issue10141

   (3) https://bugs.python.org/issue13777

   (4) https://bugs.python.org/issue10866


File: python.info,  Node: socketserver<3>,  Next: sqlite3<5>,  Prev: socket<7>,  Up: Improved Modules<6>

1.6.20.47 socketserver
......................

*note BaseServer: a7e. now has an overridable method *note
service_actions(): a7f. that is called by the *note serve_forever():
a80. method in the service loop.  *note ForkingMixIn: 3ca. now uses this
to clean up zombie child processes.  (Contributed by Justin Warkentin in
bpo-11109(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11109


File: python.info,  Node: sqlite3<5>,  Next: ssl<8>,  Prev: socketserver<3>,  Up: Improved Modules<6>

1.6.20.48 sqlite3
.................

New *note sqlite3.Connection: 3cd. method *note set_trace_callback():
a82. can be used to capture a trace of all sql commands processed by
sqlite.  (Contributed by Torsten Landschoff in bpo-11688(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11688


File: python.info,  Node: ssl<8>,  Next: stat<2>,  Prev: sqlite3<5>,  Up: Improved Modules<6>

1.6.20.49 ssl
.............

   * The *note ssl: f3. module has two new random generation functions:

        * *note RAND_bytes(): a84.: generate cryptographically strong
          pseudo-random bytes.

        * *note RAND_pseudo_bytes(): a85.: generate pseudo-random bytes.

     (Contributed by Victor Stinner in bpo-12049(1).)

   * The *note ssl: f3. module now exposes a finer-grained exception
     hierarchy in order to make it easier to inspect the various kinds
     of errors.  (Contributed by Antoine Pitrou in bpo-11183(2).)

   * *note load_cert_chain(): a86. now accepts a `password' argument to
     be used if the private key is encrypted.  (Contributed by Adam
     Simpkins in bpo-12803(3).)

   * Diffie-Hellman key exchange, both regular and Elliptic Curve-based,
     is now supported through the *note load_dh_params(): a87. and *note
     set_ecdh_curve(): a88. methods.  (Contributed by Antoine Pitrou in
     bpo-13626(4) and bpo-13627(5).)

   * SSL sockets have a new *note get_channel_binding(): a89. method
     allowing the implementation of certain authentication mechanisms
     such as SCRAM-SHA-1-PLUS. (Contributed by Jacek Konieczny in
     bpo-12551(6).)

   * You can query the SSL compression algorithm used by an SSL socket,
     thanks to its new *note compression(): a8a. method.  The new
     attribute *note OP_NO_COMPRESSION: a8b. can be used to disable
     compression.  (Contributed by Antoine Pitrou in bpo-13634(7).)

   * Support has been added for the Next Protocol Negotiation extension
     using the *note ssl.SSLContext.set_npn_protocols(): a8c. method.
     (Contributed by Colin Marc in bpo-14204(8).)

   * SSL errors can now be introspected more easily thanks to *note
     library: a8d. and *note reason: a8e. attributes.  (Contributed by
     Antoine Pitrou in bpo-14837(9).)

   * The *note get_server_certificate(): a8f. function now supports
     IPv6.  (Contributed by Charles-François Natali in bpo-11811(10).)

   * New attribute *note OP_CIPHER_SERVER_PREFERENCE: a90. allows
     setting SSLv3 server sockets to use the server’s cipher ordering
     preference rather than the client’s (bpo-13635(11)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12049

   (2) https://bugs.python.org/issue11183

   (3) https://bugs.python.org/issue12803

   (4) https://bugs.python.org/issue13626

   (5) https://bugs.python.org/issue13627

   (6) https://bugs.python.org/issue12551

   (7) https://bugs.python.org/issue13634

   (8) https://bugs.python.org/issue14204

   (9) https://bugs.python.org/issue14837

   (10) https://bugs.python.org/issue11811

   (11) https://bugs.python.org/issue13635


File: python.info,  Node: stat<2>,  Next: struct<3>,  Prev: ssl<8>,  Up: Improved Modules<6>

1.6.20.50 stat
..............

The undocumented tarfile.filemode function has been moved to *note
stat.filemode(): a92.  It can be used to convert a file’s mode to a
string of the form ‘-rwxrwxrwx’.

(Contributed by Giampaolo Rodolà in bpo-14807(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14807


File: python.info,  Node: struct<3>,  Next: subprocess<5>,  Prev: stat<2>,  Up: Improved Modules<6>

1.6.20.51 struct
................

The *note struct: f8. module now supports ‘ssize_t’ and ‘size_t’ via the
new codes ‘n’ and ‘N’, respectively.  (Contributed by Antoine Pitrou in
bpo-3163(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3163


File: python.info,  Node: subprocess<5>,  Next: sys<7>,  Prev: struct<3>,  Up: Improved Modules<6>

1.6.20.52 subprocess
....................

Command strings can now be bytes objects on posix platforms.
(Contributed by Victor Stinner in bpo-8513(1).)

A new constant *note DEVNULL: a95. allows suppressing output in a
platform-independent fashion.  (Contributed by Ross Lagerwall in
bpo-5870(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8513

   (2) https://bugs.python.org/issue5870


File: python.info,  Node: sys<7>,  Next: tarfile<4>,  Prev: subprocess<5>,  Up: Improved Modules<6>

1.6.20.53 sys
.............

The *note sys: fd. module has a new *note thread_info: a97. *note named
tuple: a98. holding information about the thread implementation
(bpo-11223(1)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue11223


File: python.info,  Node: tarfile<4>,  Next: tempfile,  Prev: sys<7>,  Up: Improved Modules<6>

1.6.20.54 tarfile
.................

*note tarfile: 101. now supports ‘lzma’ encoding via the *note lzma: ad.
module.  (Contributed by Lars Gustäbel in bpo-5689(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5689


File: python.info,  Node: tempfile,  Next: textwrap<2>,  Prev: tarfile<4>,  Up: Improved Modules<6>

1.6.20.55 tempfile
..................

*note tempfile.SpooledTemporaryFile: a9b.’s ‘truncate()’ method now
accepts a ‘size’ parameter.  (Contributed by Ryan Kelly in bpo-9957(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9957


File: python.info,  Node: textwrap<2>,  Next: threading<5>,  Prev: tempfile,  Up: Improved Modules<6>

1.6.20.56 textwrap
..................

The *note textwrap: 108. module has a new *note indent(): a9d. that
makes it straightforward to add a common prefix to selected lines in a
block of text (bpo-13857(1)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13857


File: python.info,  Node: threading<5>,  Next: time<5>,  Prev: textwrap<2>,  Up: Improved Modules<6>

1.6.20.57 threading
...................

*note threading.Condition: a9f, *note threading.Semaphore: aa0, *note
threading.BoundedSemaphore: aa1, *note threading.Event: aa2, and *note
threading.Timer: aa3, all of which used to be factory functions
returning a class instance, are now classes and may be subclassed.
(Contributed by Éric Araujo in bpo-10968(1).)

The *note threading.Thread: 233. constructor now accepts a ‘daemon’
keyword argument to override the default behavior of inheriting the
‘daemon’ flag value from the parent thread (bpo-6064(2)).

The formerly private function ‘_thread.get_ident’ is now available as
the public function *note threading.get_ident(): aa4.  This eliminates
several cases of direct access to the ‘_thread’ module in the stdlib.
Third party code that used ‘_thread.get_ident’ should likewise be
changed to use the new public interface.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10968

   (2) https://bugs.python.org/issue6064


File: python.info,  Node: time<5>,  Next: types<4>,  Prev: threading<5>,  Up: Improved Modules<6>

1.6.20.58 time
..............

The PEP 418(1) added new functions to the *note time: 10a. module:

   * *note get_clock_info(): aa6.: Get information on a clock.

   * *note monotonic(): 763.: Monotonic clock (cannot go backward), not
     affected by system clock updates.

   * *note perf_counter(): 2a8.: Performance counter with the highest
     available resolution to measure a short duration.

   * *note process_time(): 2a9.: Sum of the system and user CPU time of
     the current process.

Other new functions:

   * *note clock_getres(): aa7, *note clock_gettime(): aa8. and *note
     clock_settime(): aa9. functions with ‘CLOCK_xxx’ constants.
     (Contributed by Victor Stinner in bpo-10278(2).)

To improve cross platform consistency, *note sleep(): 674. now raises a
*note ValueError: 1f9. when passed a negative sleep value.  Previously
this was an error on posix, but produced an infinite sleep on Windows.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0418

   (2) https://bugs.python.org/issue10278


File: python.info,  Node: types<4>,  Next: unittest<5>,  Prev: time<5>,  Up: Improved Modules<6>

1.6.20.59 types
...............

Add a new *note types.MappingProxyType: aab. class: Read-only proxy of a
mapping.  (bpo-14386(1))

The new functions *note types.new_class(): aac. and *note
types.prepare_class(): aad. provide support for PEP 3115(2) compliant
dynamic type creation.  (bpo-14588(3))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14386

   (2) https://www.python.org/dev/peps/pep-3115

   (3) https://bugs.python.org/issue14588


File: python.info,  Node: unittest<5>,  Next: urllib<3>,  Prev: types<4>,  Up: Improved Modules<6>

1.6.20.60 unittest
..................

*note assertRaises(): aaf, *note assertRaisesRegex(): ab0, *note
assertWarns(): ab1, and *note assertWarnsRegex(): ab2. now accept a
keyword argument `msg' when used as context managers.  (Contributed by
Ezio Melotti and Winston Ewert in bpo-10775(1).)

*note unittest.TestCase.run(): ab3. now returns the *note TestResult:
ab4. object.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10775


File: python.info,  Node: urllib<3>,  Next: webbrowser,  Prev: unittest<5>,  Up: Improved Modules<6>

1.6.20.61 urllib
................

The *note Request: 8ea. class, now accepts a `method' argument used by
*note get_method(): ab6. to determine what HTTP method should be used.
For example, this will send a ‘'HEAD'’ request:

     >>> urlopen(Request('https://www.python.org', method='HEAD'))

(bpo-1673007(1))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1673007


File: python.info,  Node: webbrowser,  Next: xml etree ElementTree,  Prev: urllib<3>,  Up: Improved Modules<6>

1.6.20.62 webbrowser
....................

The *note webbrowser: 129. module supports more “browsers”: Google
Chrome (named ‘chrome’, ‘chromium’, ‘chrome-browser’ or
‘chromium-browser’ depending on the version and operating system), and
the generic launchers ‘xdg-open’, from the FreeDesktop.org project, and
‘gvfs-open’, which is the default URI handler for GNOME 3.  (The former
contributed by Arnaud Calmettes in bpo-13620(1), the latter by Matthias
Klose in bpo-14493(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13620

   (2) https://bugs.python.org/issue14493


File: python.info,  Node: xml etree ElementTree,  Next: zlib<2>,  Prev: webbrowser,  Up: Improved Modules<6>

1.6.20.63 xml.etree.ElementTree
...............................

The *note xml.etree.ElementTree: 137. module now imports its C
accelerator by default; there is no longer a need to explicitly import
‘xml.etree.cElementTree’ (this module stays for backwards compatibility,
but is now deprecated).  In addition, the ‘iter’ family of methods of
*note Element: ab9. has been optimized (rewritten in C). The module’s
documentation has also been greatly improved with added examples and a
more detailed reference.


File: python.info,  Node: zlib<2>,  Prev: xml etree ElementTree,  Up: Improved Modules<6>

1.6.20.64 zlib
..............

New attribute *note zlib.Decompress.eof: abb. makes it possible to
distinguish between a properly-formed compressed stream and an
incomplete or truncated one.  (Contributed by Nadeem Vawda in
bpo-12646(1).)

New attribute *note zlib.ZLIB_RUNTIME_VERSION: abc. reports the version
string of the underlying ‘zlib’ library that is loaded at runtime.
(Contributed by Torsten Landschoff in bpo-12306(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12646

   (2) https://bugs.python.org/issue12306


File: python.info,  Node: Optimizations<5>,  Next: Build and C API Changes<4>,  Prev: Improved Modules<6>,  Up: What’s New In Python 3 3

1.6.21 Optimizations
--------------------

Major performance enhancements have been added:

   * Thanks to PEP 393(1), some operations on Unicode strings have been
     optimized:

        * the memory footprint is divided by 2 to 4 depending on the
          text

        * encode an ASCII string to UTF-8 doesn’t need to encode
          characters anymore, the UTF-8 representation is shared with
          the ASCII representation

        * the UTF-8 encoder has been optimized

        * repeating a single ASCII letter and getting a substring of an
          ASCII string is 4 times faster

   * UTF-8 is now 2x to 4x faster.  UTF-16 encoding is now up to 10x
     faster.

     (Contributed by Serhiy Storchaka, bpo-14624(2), bpo-14738(3) and
     bpo-15026(4).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393

   (2) https://bugs.python.org/issue14624

   (3) https://bugs.python.org/issue14738

   (4) https://bugs.python.org/issue15026


File: python.info,  Node: Build and C API Changes<4>,  Next: Deprecated<5>,  Prev: Optimizations<5>,  Up: What’s New In Python 3 3

1.6.22 Build and C API Changes
------------------------------

Changes to Python’s build process and to the C API include:

   * New PEP 3118(1) related function:

        * *note PyMemoryView_FromMemory(): abe.

   * PEP 393(2) added new Unicode types, macros and functions:

        * High-level API:

             * *note PyUnicode_CopyCharacters(): abf.

             * *note PyUnicode_FindChar(): 435.

             * *note PyUnicode_GetLength(): ac0, *note
               PyUnicode_GET_LENGTH: ac1.

             * *note PyUnicode_New(): ac2.

             * *note PyUnicode_Substring(): ac3.

             * *note PyUnicode_ReadChar(): ac4, *note
               PyUnicode_WriteChar(): ac5.

        * Low-level API:

             * *note Py_UCS1: ac6, *note Py_UCS2: ac7, *note Py_UCS4:
               ac8. types

             * *note PyASCIIObject: ac9. and *note
               PyCompactUnicodeObject: aca. structures

             * *note PyUnicode_READY: acb.

             * *note PyUnicode_FromKindAndData(): acc.

             * *note PyUnicode_AsUCS4(): acd, *note
               PyUnicode_AsUCS4Copy(): ace.

             * *note PyUnicode_DATA: acf, *note PyUnicode_1BYTE_DATA:
               ad0, *note PyUnicode_2BYTE_DATA: ad1, *note
               PyUnicode_4BYTE_DATA: ad2.

             * *note PyUnicode_KIND: ad3. with ‘PyUnicode_Kind’ enum:
               *note PyUnicode_WCHAR_KIND: ad4, *note
               PyUnicode_1BYTE_KIND: ad5, *note PyUnicode_2BYTE_KIND:
               ad6, *note PyUnicode_4BYTE_KIND: ad7.

             * *note PyUnicode_READ: ad8, *note PyUnicode_READ_CHAR:
               ad9, *note PyUnicode_WRITE: ada.

             * *note PyUnicode_MAX_CHAR_VALUE: adb.

   * *note PyArg_ParseTuple: 268. now accepts a *note bytearray: 327.
     for the ‘c’ format (bpo-12380(3)).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3118

   (2) https://www.python.org/dev/peps/pep-0393

   (3) https://bugs.python.org/issue12380


File: python.info,  Node: Deprecated<5>,  Next: Porting to Python 3 3,  Prev: Build and C API Changes<4>,  Up: What’s New In Python 3 3

1.6.23 Deprecated
-----------------

* Menu:

* Unsupported Operating Systems: Unsupported Operating Systems<2>.
* Deprecated Python modules, functions and methods: Deprecated Python modules functions and methods<4>.
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<3>.
* Deprecated features::


File: python.info,  Node: Unsupported Operating Systems<2>,  Next: Deprecated Python modules functions and methods<4>,  Up: Deprecated<5>

1.6.23.1 Unsupported Operating Systems
......................................

OS/2 and VMS are no longer supported due to the lack of a maintainer.

Windows 2000 and Windows platforms which set ‘COMSPEC’ to ‘command.com’
are no longer supported due to maintenance burden.

OSF support, which was deprecated in 3.2, has been completely removed.


File: python.info,  Node: Deprecated Python modules functions and methods<4>,  Next: Deprecated functions and types of the C API<3>,  Prev: Unsupported Operating Systems<2>,  Up: Deprecated<5>

1.6.23.2 Deprecated Python modules, functions and methods
.........................................................

   * Passing a non-empty string to ‘object.__format__()’ is deprecated,
     and will produce a *note TypeError: 192. in Python 3.4
     (bpo-9856(1)).

   * The ‘unicode_internal’ codec has been deprecated because of the PEP
     393(2), use UTF-8, UTF-16 (‘utf-16-le’ or ‘utf-16-be’), or UTF-32
     (‘utf-32-le’ or ‘utf-32-be’)

   * *note ftplib.FTP.nlst(): 9fb. and *note ftplib.FTP.dir(): 9fc.: use
     *note ftplib.FTP.mlsd(): 9fa.

   * ‘platform.popen()’: use the *note subprocess: f9. module.  Check
     especially the *note Replacing Older Functions with the subprocess
     Module: adf. section (bpo-11377(3)).

   * bpo-13374(4): The Windows bytes API has been deprecated in the
     *note os: c4. module.  Use Unicode filenames, instead of bytes
     filenames, to not depend on the ANSI code page anymore and to
     support any filename.

   * bpo-13988(5): The ‘xml.etree.cElementTree’ module is deprecated.
     The accelerator is used automatically whenever available.

   * The behaviour of ‘time.clock()’ depends on the platform: use the
     new *note time.perf_counter(): 2a8. or *note time.process_time():
     2a9. function instead, depending on your requirements, to have a
     well defined behaviour.

   * The ‘os.stat_float_times()’ function is deprecated.

   * *note abc: 4. module:

        * *note abc.abstractproperty: 9c1. has been deprecated, use
          *note property: 1d5. with *note abc.abstractmethod(): 9c2.
          instead.

        * *note abc.abstractclassmethod: 9c3. has been deprecated, use
          *note classmethod: 1d6. with *note abc.abstractmethod(): 9c2.
          instead.

        * *note abc.abstractstaticmethod: 9c4. has been deprecated, use
          *note staticmethod: 1d7. with *note abc.abstractmethod(): 9c2.
          instead.

   * *note importlib: 9b. package:

        * *note importlib.abc.SourceLoader.path_mtime(): ae0. is now
          deprecated in favour of *note
          importlib.abc.SourceLoader.path_stats(): ae1. as bytecode
          files now store both the modification time and size of the
          source file the bytecode file was compiled from.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9856

   (2) https://www.python.org/dev/peps/pep-0393

   (3) https://bugs.python.org/issue11377

   (4) https://bugs.python.org/issue13374

   (5) https://bugs.python.org/issue13988


File: python.info,  Node: Deprecated functions and types of the C API<3>,  Next: Deprecated features,  Prev: Deprecated Python modules functions and methods<4>,  Up: Deprecated<5>

1.6.23.3 Deprecated functions and types of the C API
....................................................

The *note Py_UNICODE: ae3. has been deprecated by PEP 393(1) and will be
removed in Python 4.  All functions using this type are deprecated:

Unicode functions and methods using *note Py_UNICODE: ae3. and *note
Py_UNICODE*: ae3. types:

   * *note PyUnicode_FromUnicode: ae4.: use *note
     PyUnicode_FromWideChar(): ae5. or *note
     PyUnicode_FromKindAndData(): acc.

   * *note PyUnicode_AS_UNICODE: ae6, *note PyUnicode_AsUnicode(): ae7,
     *note PyUnicode_AsUnicodeAndSize(): ae8.: use *note
     PyUnicode_AsWideCharString(): 42d.

   * *note PyUnicode_AS_DATA: ae9.: use *note PyUnicode_DATA: acf. with
     *note PyUnicode_READ: ad8. and *note PyUnicode_WRITE: ada.

   * *note PyUnicode_GET_SIZE: aea, *note PyUnicode_GetSize(): aeb.: use
     *note PyUnicode_GET_LENGTH: ac1. or *note PyUnicode_GetLength():
     ac0.

   * *note PyUnicode_GET_DATA_SIZE: aec.: use ‘PyUnicode_GET_LENGTH(str)
     * PyUnicode_KIND(str)’ (only work on ready strings)

   * *note PyUnicode_AsUnicodeCopy(): aed.: use *note
     PyUnicode_AsUCS4Copy(): ace. or *note PyUnicode_AsWideCharString():
     42d.

   * ‘PyUnicode_GetMax()’

Functions and macros manipulating Py_UNICODE* strings:

   * ‘Py_UNICODE_strlen’: use *note PyUnicode_GetLength(): ac0. or *note
     PyUnicode_GET_LENGTH: ac1.

   * ‘Py_UNICODE_strcat’: use *note PyUnicode_CopyCharacters(): abf. or
     *note PyUnicode_FromFormat(): 7bf.

   * ‘Py_UNICODE_strcpy’, ‘Py_UNICODE_strncpy’, ‘Py_UNICODE_COPY’: use
     *note PyUnicode_CopyCharacters(): abf. or *note
     PyUnicode_Substring(): ac3.

   * ‘Py_UNICODE_strcmp’: use *note PyUnicode_Compare(): aee.

   * ‘Py_UNICODE_strncmp’: use *note PyUnicode_Tailmatch(): aef.

   * ‘Py_UNICODE_strchr’, ‘Py_UNICODE_strrchr’: use *note
     PyUnicode_FindChar(): 435.

   * ‘Py_UNICODE_FILL’: use *note PyUnicode_Fill(): af0.

   * ‘Py_UNICODE_MATCH’

Encoders:

   * *note PyUnicode_Encode(): af1.: use ‘PyUnicode_AsEncodedObject()’

   * *note PyUnicode_EncodeUTF7(): af2.

   * *note PyUnicode_EncodeUTF8(): af3.: use *note PyUnicode_AsUTF8():
     420. or *note PyUnicode_AsUTF8String(): af4.

   * *note PyUnicode_EncodeUTF32(): af5.

   * *note PyUnicode_EncodeUTF16(): af6.

   * ‘PyUnicode_EncodeUnicodeEscape:()’ use *note
     PyUnicode_AsUnicodeEscapeString(): af7.

   * ‘PyUnicode_EncodeRawUnicodeEscape:()’ use *note
     PyUnicode_AsRawUnicodeEscapeString(): af8.

   * *note PyUnicode_EncodeLatin1(): af9.: use *note
     PyUnicode_AsLatin1String(): afa.

   * *note PyUnicode_EncodeASCII(): afb.: use *note
     PyUnicode_AsASCIIString(): afc.

   * *note PyUnicode_EncodeCharmap(): afd.

   * *note PyUnicode_TranslateCharmap(): afe.

   * *note PyUnicode_EncodeMBCS(): aff.: use *note
     PyUnicode_AsMBCSString(): b00. or *note PyUnicode_EncodeCodePage():
     b01. (with ‘CP_ACP’ code_page)

   * ‘PyUnicode_EncodeDecimal()’, *note
     PyUnicode_TransformDecimalToASCII(): b02.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393


File: python.info,  Node: Deprecated features,  Prev: Deprecated functions and types of the C API<3>,  Up: Deprecated<5>

1.6.23.4 Deprecated features
............................

The *note array: 7. module’s ‘'u'’ format code is now deprecated and
will be removed in Python 4 together with the rest of the (*note
Py_UNICODE: ae3.) API.


File: python.info,  Node: Porting to Python 3 3,  Prev: Deprecated<5>,  Up: What’s New In Python 3 3

1.6.24 Porting to Python 3.3
----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code.

* Menu:

* Porting Python code::
* Porting C code::
* Building C extensions::
* Command Line Switch Changes::


File: python.info,  Node: Porting Python code,  Next: Porting C code,  Up: Porting to Python 3 3

1.6.24.1 Porting Python code
............................

   * Hash randomization is enabled by default.  Set the *note
     PYTHONHASHSEED: 9b9. environment variable to ‘0’ to disable hash
     randomization.  See also the *note object.__hash__(): 335. method.

   * bpo-12326(1): On Linux, sys.platform doesn’t contain the major
     version anymore.  It is now always ‘linux’, instead of ‘linux2’ or
     ‘linux3’ depending on the Linux version used to build Python.
     Replace sys.platform == ‘linux2’ with
     sys.platform.startswith(‘linux’), or directly sys.platform ==
     ‘linux’ if you don’t need to support older Python versions.

   * bpo-13847(2), bpo-14180(3): *note time: 10a. and *note datetime:
     31.: *note OverflowError: 954. is now raised instead of *note
     ValueError: 1f9. if a timestamp is out of range.  *note OSError:
     1d1. is now raised if C functions ‘gmtime()’ or ‘localtime()’
     failed.

   * The default finders used by import now utilize a cache of what is
     contained within a specific directory.  If you create a Python
     source file or sourceless bytecode file, make sure to call *note
     importlib.invalidate_caches(): 492. to clear out the cache for the
     finders to notice the new file.

   * *note ImportError: 329. now uses the full name of the module that
     was attempted to be imported.  Doctests that check ImportErrors’
     message will need to be updated to use the full name of the module
     instead of just the tail of the name.

   * The `index' argument to *note __import__(): 605. now defaults to 0
     instead of -1 and no longer support negative values.  It was an
     oversight when PEP 328(4) was implemented that the default value
     remained -1.  If you need to continue to perform a relative import
     followed by an absolute import, then perform the relative import
     using an index of 1, followed by another import using an index of
     0.  It is preferred, though, that you use *note
     importlib.import_module(): b06. rather than call *note
     __import__(): 605. directly.

   * *note __import__(): 605. no longer allows one to use an index value
     other than 0 for top-level modules.  E.g.  ‘__import__('sys',
     level=1)’ is now an error.

   * Because *note sys.meta_path: 5db. and *note sys.path_hooks: 950.
     now have finders on them by default, you will most likely want to
     use ‘list.insert()’ instead of ‘list.append()’ to add to those
     lists.

   * Because ‘None’ is now inserted into *note sys.path_importer_cache:
     493, if you are clearing out entries in the dictionary of paths
     that do not have a finder, you will need to remove keys paired with
     values of ‘None’ `and' *note imp.NullImporter: 9af. to be
     backwards-compatible.  This will lead to extra overhead on older
     versions of Python that re-insert ‘None’ into *note
     sys.path_importer_cache: 493. where it represents the use of
     implicit finders, but semantically it should not change anything.

   * *note importlib.abc.Finder: 9a9. no longer specifies a
     ‘find_module()’ abstract method that must be implemented.  If you
     were relying on subclasses to implement that method, make sure to
     check for the method’s existence first.  You will probably want to
     check for ‘find_loader()’ first, though, in the case of working
     with *note path entry finders: 9a6.

   * *note pkgutil: cd. has been converted to use *note importlib: 9b.
     internally.  This eliminates many edge cases where the old
     behaviour of the PEP 302(5) import emulation failed to match the
     behaviour of the real import system.  The import emulation itself
     is still present, but is now deprecated.  The *note
     pkgutil.iter_importers(): b07. and *note pkgutil.walk_packages():
     480. functions special case the standard import hooks so they are
     still supported even though they do not provide the non-standard
     ‘iter_modules()’ method.

   * A longstanding RFC-compliance bug (bpo-1079(6)) in the parsing done
     by *note email.header.decode_header(): 9ed. has been fixed.  Code
     that uses the standard idiom to convert encoded headers into
     unicode (‘str(make_header(decode_header(h))’) will see no change,
     but code that looks at the individual tuples returned by
     decode_header will see that whitespace that precedes or follows
     ‘ASCII’ sections is now included in the ‘ASCII’ section.  Code that
     builds headers using ‘make_header’ should also continue to work
     without change, since ‘make_header’ continues to add whitespace
     between ‘ASCII’ and non-‘ASCII’ sections if it is not already
     present in the input strings.

   * *note email.utils.formataddr(): b08. now does the correct content
     transfer encoding when passed non-‘ASCII’ display names.  Any code
     that depended on the previous buggy behavior that preserved the
     non-‘ASCII’ unicode in the formatted output string will need to be
     changed (bpo-1690608(7)).

   * *note poplib.POP3.quit(): b09. may now raise protocol errors like
     all other ‘poplib’ methods.  Code that assumes ‘quit’ does not
     raise *note poplib.error_proto: b0a. errors may need to be changed
     if errors on ‘quit’ are encountered by a particular application
     (bpo-11291(8)).

   * The ‘strict’ argument to *note email.parser.Parser: b0b, deprecated
     since Python 2.4, has finally been removed.

   * The deprecated method ‘unittest.TestCase.assertSameElements’ has
     been removed.

   * The deprecated variable ‘time.accept2dyear’ has been removed.

   * The deprecated ‘Context._clamp’ attribute has been removed from the
     *note decimal: 36. module.  It was previously replaced by the
     public attribute ‘clamp’.  (See bpo-8540(9).)

   * The undocumented internal helper class ‘SSLFakeFile’ has been
     removed from *note smtplib: ed, since its functionality has long
     been provided directly by *note socket.socket.makefile(): b0c.

   * Passing a negative value to *note time.sleep(): 674. on Windows now
     raises an error instead of sleeping forever.  It has always raised
     an error on posix.

   * The ‘ast.__version__’ constant has been removed.  If you need to
     make decisions affected by the AST version, use *note
     sys.version_info: b0d. to make the decision.

   * Code that used to work around the fact that the *note threading:
     109. module used factory functions by subclassing the private
     classes will need to change to subclass the now-public classes.

   * The undocumented debugging machinery in the threading module has
     been removed, simplifying the code.  This should have no effect on
     production code, but is mentioned here in case any application
     debug frameworks were interacting with it (bpo-13550(10)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12326

   (2) https://bugs.python.org/issue13847

   (3) https://bugs.python.org/issue14180

   (4) https://www.python.org/dev/peps/pep-0328

   (5) https://www.python.org/dev/peps/pep-0302

   (6) https://bugs.python.org/issue1079

   (7) https://bugs.python.org/issue1690608

   (8) https://bugs.python.org/issue11291

   (9) https://bugs.python.org/issue8540

   (10) https://bugs.python.org/issue13550


File: python.info,  Node: Porting C code,  Next: Building C extensions,  Prev: Porting Python code,  Up: Porting to Python 3 3

1.6.24.2 Porting C code
.......................

   * In the course of changes to the buffer API the undocumented
     ‘smalltable’ member of the *note Py_buffer: b0e. structure has been
     removed and the layout of the ‘PyMemoryViewObject’ has changed.

     All extensions relying on the relevant parts in ‘memoryobject.h’ or
     ‘object.h’ must be rebuilt.

   * Due to *note PEP 393: 970, the *note Py_UNICODE: ae3. type and all
     functions using this type are deprecated (but will stay available
     for at least five years).  If you were using low-level Unicode APIs
     to construct and access unicode objects and you want to benefit of
     the memory footprint reduction provided by PEP 393(1), you have to
     convert your code to the new *note Unicode API: b0f.

     However, if you only have been using high-level functions such as
     *note PyUnicode_Concat(): b10, *note PyUnicode_Join(): b11. or
     *note PyUnicode_FromFormat(): 7bf, your code will automatically
     take advantage of the new unicode representations.

   * *note PyImport_GetMagicNumber(): b12. now returns ‘-1’ upon
     failure.

   * As a negative value for the `level' argument to *note __import__():
     605. is no longer valid, the same now holds for *note
     PyImport_ImportModuleLevel(): b13.  This also means that the value
     of `level' used by *note PyImport_ImportModuleEx(): b14. is now ‘0’
     instead of ‘-1’.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393


File: python.info,  Node: Building C extensions,  Next: Command Line Switch Changes,  Prev: Porting C code,  Up: Porting to Python 3 3

1.6.24.3 Building C extensions
..............................

   * The range of possible file names for C extensions has been
     narrowed.  Very rarely used spellings have been suppressed: under
     POSIX, files named ‘xxxmodule.so’, ‘xxxmodule.abi3.so’ and
     ‘xxxmodule.cpython-*.so’ are no longer recognized as implementing
     the ‘xxx’ module.  If you had been generating such files, you have
     to switch to the other spellings (i.e., remove the ‘module’ string
     from the file names).

     (implemented in bpo-14040(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14040


File: python.info,  Node: Command Line Switch Changes,  Prev: Building C extensions,  Up: Porting to Python 3 3

1.6.24.4 Command Line Switch Changes
....................................

   * The -Q command-line flag and related artifacts have been removed.
     Code checking sys.flags.division_warning will need updating.

     (bpo-10998(1), contributed by Éric Araujo.)

   * When ‘python’ is started with *note -S: b17, ‘import site’ will no
     longer add site-specific paths to the module search paths.  In
     previous versions, it did.

     (bpo-11591(2), contributed by Carl Meyer with editions by Éric
     Araujo.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10998

   (2) https://bugs.python.org/issue11591


File: python.info,  Node: What’s New In Python 3 2,  Next: What’s New In Python 3 1,  Prev: What’s New In Python 3 3,  Up: What’s New in Python

1.7 What’s New In Python 3.2
============================


Author: Raymond Hettinger

This article explains the new features in Python 3.2 as compared to 3.1.
It focuses on a few highlights and gives a few examples.  For full
details, see the Misc/NEWS(1) file.

See also
........

PEP 392(2) - Python 3.2 Release Schedule

* Menu:

* PEP 384; Defining a Stable ABI: PEP 384 Defining a Stable ABI.
* PEP 389; Argparse Command Line Parsing Module: PEP 389 Argparse Command Line Parsing Module.
* PEP 391; Dictionary Based Configuration for Logging: PEP 391 Dictionary Based Configuration for Logging.
* PEP 3148; The concurrent.futures module: PEP 3148 The concurrent futures module.
* PEP 3147; PYC Repository Directories: PEP 3147 PYC Repository Directories.
* PEP 3149; ABI Version Tagged .so Files: PEP 3149 ABI Version Tagged so Files.
* PEP 3333; Python Web Server Gateway Interface v1.0.1: PEP 3333 Python Web Server Gateway Interface v1 0 1.
* Other Language Changes: Other Language Changes<7>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules.
* Multi-threading::
* Optimizations: Optimizations<6>.
* Unicode::
* Codecs::
* Documentation::
* IDLE::
* Code Repository::
* Build and C API Changes: Build and C API Changes<5>.
* Porting to Python 3.2: Porting to Python 3 2.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/blob/076ca6c3c8df3030307e548d9be792ce3c1c6eea/Misc/NEWS

   (2) https://www.python.org/dev/peps/pep-0392


File: python.info,  Node: PEP 384 Defining a Stable ABI,  Next: PEP 389 Argparse Command Line Parsing Module,  Up: What’s New In Python 3 2

1.7.1 PEP 384: Defining a Stable ABI
------------------------------------

In the past, extension modules built for one Python version were often
not usable with other Python versions.  Particularly on Windows, every
feature release of Python required rebuilding all extension modules that
one wanted to use.  This requirement was the result of the free access
to Python interpreter internals that extension modules could use.

With Python 3.2, an alternative approach becomes available: extension
modules which restrict themselves to a limited API (by defining
Py_LIMITED_API) cannot use many of the internals, but are constrained to
a set of API functions that are promised to be stable for several
releases.  As a consequence, extension modules built for 3.2 in that
mode will also work with 3.3, 3.4, and so on.  Extension modules that
make use of details of memory structures can still be built, but will
need to be recompiled for every feature release.

See also
........

PEP 384(1) - Defining a Stable ABI

     PEP written by Martin von Löwis.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0384


File: python.info,  Node: PEP 389 Argparse Command Line Parsing Module,  Next: PEP 391 Dictionary Based Configuration for Logging,  Prev: PEP 384 Defining a Stable ABI,  Up: What’s New In Python 3 2

1.7.2 PEP 389: Argparse Command Line Parsing Module
---------------------------------------------------

A new module for command line parsing, *note argparse: 6, was introduced
to overcome the limitations of *note optparse: c3. which did not provide
support for positional arguments (not just options), subcommands,
required options and other common patterns of specifying and validating
options.

This module has already had widespread success in the community as a
third-party module.  Being more fully featured than its predecessor, the
*note argparse: 6. module is now the preferred module for command-line
processing.  The older module is still being kept available because of
the substantial amount of legacy code that depends on it.

Here’s an annotated example parser showing features like limiting
results to a set of choices, specifying a `metavar' in the help screen,
validating that one or more positional arguments is present, and making
a required option:

     import argparse
     parser = argparse.ArgumentParser(
                 description = 'Manage servers',         # main description for help
                 epilog = 'Tested on Solaris and Linux') # displayed after help
     parser.add_argument('action',                       # argument name
                 choices = ['deploy', 'start', 'stop'],  # three allowed values
                 help = 'action on each target')         # help msg
     parser.add_argument('targets',
                 metavar = 'HOSTNAME',                   # var name used in help msg
                 nargs = '+',                            # require one or more targets
                 help = 'url for target machines')       # help msg explanation
     parser.add_argument('-u', '--user',                 # -u or --user option
                 required = True,                        # make it a required argument
                 help = 'login as user')

Example of calling the parser on a command string:

     >>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain'
     >>> result = parser.parse_args(cmd.split())
     >>> result.action
     'deploy'
     >>> result.targets
     ['sneezy.example.com', 'sleepy.example.com']
     >>> result.user
     'skycaptain'

Example of the parser’s automatically generated help:

     >>> parser.parse_args('-h'.split())

     usage: manage_cloud.py [-h] -u USER
                            {deploy,start,stop} HOSTNAME [HOSTNAME ...]

     Manage servers

     positional arguments:
       {deploy,start,stop}   action on each target
       HOSTNAME              url for target machines

     optional arguments:
       -h, --help            show this help message and exit
       -u USER, --user USER  login as user

     Tested on Solaris and Linux

An especially nice *note argparse: 6. feature is the ability to define
subparsers, each with their own argument patterns and help displays:

     import argparse
     parser = argparse.ArgumentParser(prog='HELM')
     subparsers = parser.add_subparsers()

     parser_l = subparsers.add_parser('launch', help='Launch Control')   # first subgroup
     parser_l.add_argument('-m', '--missiles', action='store_true')
     parser_l.add_argument('-t', '--torpedos', action='store_true')

     parser_m = subparsers.add_parser('move', help='Move Vessel',        # second subgroup
                                      aliases=('steer', 'turn'))         # equivalent names
     parser_m.add_argument('-c', '--course', type=int, required=True)
     parser_m.add_argument('-s', '--speed', type=int, default=0)

     $ ./helm.py --help                         # top level help (launch and move)
     $ ./helm.py launch --help                  # help for launch options
     $ ./helm.py launch --missiles              # set missiles=True and torpedos=False
     $ ./helm.py steer --course 180 --speed 5   # set movement parameters

See also
........

PEP 389(1) - New Command Line Parsing Module

     PEP written by Steven Bethard.

*note Upgrading optparse code: b1c. for details on the differences from
*note optparse: c3.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0389


File: python.info,  Node: PEP 391 Dictionary Based Configuration for Logging,  Next: PEP 3148 The concurrent futures module,  Prev: PEP 389 Argparse Command Line Parsing Module,  Up: What’s New In Python 3 2

1.7.3 PEP 391: Dictionary Based Configuration for Logging
---------------------------------------------------------

The *note logging: aa. module provided two kinds of configuration, one
style with function calls for each option or another style driven by an
external file saved in a ‘ConfigParser’ format.  Those options did not
provide the flexibility to create configurations from JSON or YAML
files, nor did they support incremental configuration, which is needed
for specifying logger options from a command line.

To support a more flexible style, the module now offers *note
logging.config.dictConfig(): b1e. for specifying logging configuration
with plain Python dictionaries.  The configuration options include
formatters, handlers, filters, and loggers.  Here’s a working example of
a configuration dictionary:

     {"version": 1,
      "formatters": {"brief": {"format": "%(levelname)-8s: %(name)-15s: %(message)s"},
                     "full": {"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"}
                     },
      "handlers": {"console": {
                        "class": "logging.StreamHandler",
                        "formatter": "brief",
                        "level": "INFO",
                        "stream": "ext://sys.stdout"},
                   "console_priority": {
                        "class": "logging.StreamHandler",
                        "formatter": "full",
                        "level": "ERROR",
                        "stream": "ext://sys.stderr"}
                   },
      "root": {"level": "DEBUG", "handlers": ["console", "console_priority"]}}

If that dictionary is stored in a file called ‘conf.json’, it can be
loaded and called with code like this:

     >>> import json, logging.config
     >>> with open('conf.json') as f:
     ...     conf = json.load(f)
     ...
     >>> logging.config.dictConfig(conf)
     >>> logging.info("Transaction completed normally")
     INFO    : root           : Transaction completed normally
     >>> logging.critical("Abnormal termination")
     2011-02-17 11:14:36,694 root            CRITICAL Abnormal termination

See also
........

PEP 391(1) - Dictionary Based Configuration for Logging

     PEP written by Vinay Sajip.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0391


File: python.info,  Node: PEP 3148 The concurrent futures module,  Next: PEP 3147 PYC Repository Directories,  Prev: PEP 391 Dictionary Based Configuration for Logging,  Up: What’s New In Python 3 2

1.7.4 PEP 3148: The ‘concurrent.futures’ module
-----------------------------------------------

Code for creating and managing concurrency is being collected in a new
top-level namespace, `concurrent'.  Its first member is a `futures'
package which provides a uniform high-level interface for managing
threads and processes.

The design for *note concurrent.futures: 22. was inspired by the
`java.util.concurrent' package.  In that model, a running call and its
result are represented by a *note Future: b20. object that abstracts
features common to threads, processes, and remote procedure calls.  That
object supports status checks (running or done), timeouts,
cancellations, adding callbacks, and access to results or exceptions.

The primary offering of the new module is a pair of executor classes for
launching and managing calls.  The goal of the executors is to make it
easier to use existing tools for making parallel calls.  They save the
effort needed to setup a pool of resources, launch the calls, create a
results queue, add time-out handling, and limit the total number of
threads, processes, or remote procedure calls.

Ideally, each application should share a single executor across multiple
components so that process and thread limits can be centrally managed.
This solves the design challenge that arises when each component has its
own competing strategy for resource management.

Both classes share a common interface with three methods: *note
submit(): 2a1. for scheduling a callable and returning a *note Future:
b20. object; *note map(): 6b2. for scheduling many asynchronous calls at
a time, and *note shutdown(): b21. for freeing resources.  The class is
a *note context manager: 55d. and can be used in a *note with: 6dd.
statement to assure that resources are automatically released when
currently pending futures are done executing.

A simple of example of *note ThreadPoolExecutor: 278. is a launch of
four parallel threads for copying files:

     import concurrent.futures, shutil
     with concurrent.futures.ThreadPoolExecutor(max_workers=4) as e:
         e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
         e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
         e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
         e.submit(shutil.copy, 'src3.txt', 'dest4.txt')

See also
........

PEP 3148(1) - Futures – Execute Computations Asynchronously

     PEP written by Brian Quinlan.

*note Code for Threaded Parallel URL reads: b22, an example using
threads to fetch multiple web pages in parallel.

*note Code for computing prime numbers in parallel: b23, an example
demonstrating *note ProcessPoolExecutor: 2a2.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3148


File: python.info,  Node: PEP 3147 PYC Repository Directories,  Next: PEP 3149 ABI Version Tagged so Files,  Prev: PEP 3148 The concurrent futures module,  Up: What’s New In Python 3 2

1.7.5 PEP 3147: PYC Repository Directories
------------------------------------------

Python’s scheme for caching bytecode in `.pyc' files did not work well
in environments with multiple Python interpreters.  If one interpreter
encountered a cached file created by another interpreter, it would
recompile the source and overwrite the cached file, thus losing the
benefits of caching.

The issue of “pyc fights” has become more pronounced as it has become
commonplace for Linux distributions to ship with multiple versions of
Python.  These conflicts also arise with CPython alternatives such as
Unladen Swallow.

To solve this problem, Python’s import machinery has been extended to
use distinct filenames for each interpreter.  Instead of Python 3.2 and
Python 3.3 and Unladen Swallow each competing for a file called
“mymodule.pyc”, they will now look for “mymodule.cpython-32.pyc”,
“mymodule.cpython-33.pyc”, and “mymodule.unladen10.pyc”.  And to prevent
all of these new files from cluttering source directories, the `pyc'
files are now collected in a “__pycache__” directory stored under the
package directory.

Aside from the filenames and target directories, the new scheme has a
few aspects that are visible to the programmer:

   * Imported modules now have a *note __cached__: b25. attribute which
     stores the name of the actual file that was imported:

          >>> import collections
          >>> collections.__cached__ # doctest: +SKIP
          'c:/py32/lib/__pycache__/collections.cpython-32.pyc'

   * The tag that is unique to each interpreter is accessible from the
     *note imp: 9a. module:

          >>> import imp
          >>> imp.get_tag() # doctest: +SKIP
          'cpython-32'

   * Scripts that try to deduce source filename from the imported file
     now need to be smarter.  It is no longer sufficient to simply strip
     the “c” from a “.pyc” filename.  Instead, use the new functions in
     the *note imp: 9a. module:

          >>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
          'c:/py32/lib/collections.py'
          >>> imp.cache_from_source('c:/py32/lib/collections.py') # doctest: +SKIP
          'c:/py32/lib/__pycache__/collections.cpython-32.pyc'

   * The *note py_compile: d7. and *note compileall: 21. modules have
     been updated to reflect the new naming convention and target
     directory.  The command-line invocation of `compileall' has new
     options: ‘-i’ for specifying a list of files and directories to
     compile and ‘-b’ which causes bytecode files to be written to their
     legacy location rather than `__pycache__'.

   * The *note importlib.abc: 9c. module has been updated with new *note
     abstract base classes: b26. for loading bytecode files.  The
     obsolete ABCs, ‘PyLoader’ and ‘PyPycLoader’, have been deprecated
     (instructions on how to stay Python 3.1 compatible are included
     with the documentation).

See also
........

PEP 3147(1) - PYC Repository Directories

     PEP written by Barry Warsaw.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: PEP 3149 ABI Version Tagged so Files,  Next: PEP 3333 Python Web Server Gateway Interface v1 0 1,  Prev: PEP 3147 PYC Repository Directories,  Up: What’s New In Python 3 2

1.7.6 PEP 3149: ABI Version Tagged .so Files
--------------------------------------------

The PYC repository directory allows multiple bytecode cache files to be
co-located.  This PEP implements a similar mechanism for shared object
files by giving them a common directory and distinct names for each
version.

The common directory is “pyshared” and the file names are made distinct
by identifying the Python implementation (such as CPython, PyPy, Jython,
etc.), the major and minor version numbers, and optional build flags
(such as “d” for debug, “m” for pymalloc, “u” for wide-unicode).  For an
arbitrary package “foo”, you may see these files when the distribution
package is installed:

     /usr/share/pyshared/foo.cpython-32m.so
     /usr/share/pyshared/foo.cpython-33md.so

In Python itself, the tags are accessible from functions in the *note
sysconfig: fe. module:

     >>> import sysconfig
     >>> sysconfig.get_config_var('SOABI')       # find the version tag
     'cpython-32mu'
     >>> sysconfig.get_config_var('EXT_SUFFIX')  # find the full filename extension
     '.cpython-32mu.so'

See also
........

PEP 3149(1) - ABI Version Tagged .so Files

     PEP written by Barry Warsaw.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3149


File: python.info,  Node: PEP 3333 Python Web Server Gateway Interface v1 0 1,  Next: Other Language Changes<7>,  Prev: PEP 3149 ABI Version Tagged so Files,  Up: What’s New In Python 3 2

1.7.7 PEP 3333: Python Web Server Gateway Interface v1.0.1
----------------------------------------------------------

This informational PEP clarifies how bytes/text issues are to be handled
by the WSGI protocol.  The challenge is that string handling in Python 3
is most conveniently handled with the *note str: 325. type even though
the HTTP protocol is itself bytes oriented.

The PEP differentiates so-called `native strings' that are used for
request/response headers and metadata versus `byte strings' which are
used for the bodies of requests and responses.

The `native strings' are always of type *note str: 325. but are
restricted to code points between `U+0000' through `U+00FF' which are
translatable to bytes using `Latin-1' encoding.  These strings are used
for the keys and values in the environment dictionary and for response
headers and statuses in the ‘start_response()’ function.  They must
follow RFC 2616(1) with respect to encoding.  That is, they must either
be `ISO-8859-1' characters or use RFC 2047(2) MIME encoding.

For developers porting WSGI applications from Python 2, here are the
salient points:

   * If the app already used strings for headers in Python 2, no change
     is needed.

   * If instead, the app encoded output headers or decoded input
     headers, then the headers will need to be re-encoded to Latin-1.
     For example, an output header encoded in utf-8 was using
     ‘h.encode('utf-8')’ now needs to convert from bytes to native
     strings using ‘h.encode('utf-8').decode('latin-1')’.

   * Values yielded by an application or sent using the ‘write()’ method
     must be byte strings.  The ‘start_response()’ function and environ
     must use native strings.  The two cannot be mixed.

For server implementers writing CGI-to-WSGI pathways or other CGI-style
protocols, the users must to be able access the environment using native
strings even though the underlying platform may have a different
convention.  To bridge this gap, the *note wsgiref: 12c. module has a
new function, *note wsgiref.handlers.read_environ(): b29. for
transcoding CGI variables from *note os.environ: b2a. into native
strings and returning a new dictionary.

See also
........

PEP 3333(3) - Python Web Server Gateway Interface v1.0.1

     PEP written by Phillip Eby.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2616.html

   (2) https://tools.ietf.org/html/rfc2047.html

   (3) https://www.python.org/dev/peps/pep-3333


File: python.info,  Node: Other Language Changes<7>,  Next: New Improved and Deprecated Modules,  Prev: PEP 3333 Python Web Server Gateway Interface v1 0 1,  Up: What’s New In Python 3 2

1.7.8 Other Language Changes
----------------------------

Some smaller changes made to the core Python language are:

   * String formatting for *note format(): 4d0. and *note str.format():
     4cf. gained new capabilities for the format character `#'.
     Previously, for integers in binary, octal, or hexadecimal, it
     caused the output to be prefixed with ‘0b’, ‘0o’, or ‘0x’
     respectively.  Now it can also handle floats, complex, and Decimal,
     causing the output to always have a decimal point even when no
     digits follow it.

          >>> format(20, '#o')
          '0o24'
          >>> format(12.34, '#5.0f')
          '  12.'

     (Suggested by Mark Dickinson and implemented by Eric Smith in
     bpo-7094(1).)

   * There is also a new *note str.format_map(): 6a5. method that
     extends the capabilities of the existing *note str.format(): 4cf.
     method by accepting arbitrary *note mapping: b2c. objects.  This
     new method makes it possible to use string formatting with any of
     Python’s many dictionary-like objects such as *note defaultdict:
     b2d, *note Shelf: 8a4, *note ConfigParser: 4a0, or *note dbm: 32.
     It is also useful with custom *note dict: 1b6. subclasses that
     normalize keys before look-up or that supply a *note __missing__():
     b2e. method for unknown keys:

          >>> import shelve
          >>> d = shelve.open('tmp.shl')
          >>> 'The {project_name} status is {status} as of {date}'.format_map(d)
          'The testing project status is green as of February 15, 2011'

          >>> class LowerCasedDict(dict):
          ...     def __getitem__(self, key):
          ...         return dict.__getitem__(self, key.lower())
          >>> lcd = LowerCasedDict(part='widgets', quantity=10)
          >>> 'There are {QUANTITY} {Part} in stock'.format_map(lcd)
          'There are 10 widgets in stock'

          >>> class PlaceholderDict(dict):
          ...     def __missing__(self, key):
          ...         return '<{}>'.format(key)
          >>> 'Hello {name}, welcome to {location}'.format_map(PlaceholderDict())
          'Hello <name>, welcome to <location>'

     (Suggested by Raymond Hettinger and implemented by Eric Smith in
     bpo-6081(2).)

   * The interpreter can now be started with a quiet option, ‘-q’, to
     prevent the copyright and version information from being displayed
     in the interactive mode.  The option can be introspected using the
     *note sys.flags: b2f. attribute:

          $ python -q
          >>> sys.flags
          sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
          optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
          ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)

     (Contributed by Marcin Wojdyr in bpo-1772833(3)).

   * The *note hasattr(): 43c. function works by calling *note
     getattr(): 43d. and detecting whether an exception is raised.  This
     technique allows it to detect methods created dynamically by *note
     __getattr__(): 30f. or *note __getattribute__(): 43e. which would
     otherwise be absent from the class dictionary.  Formerly, `hasattr'
     would catch any exception, possibly masking genuine errors.  Now,
     `hasattr' has been tightened to only catch *note AttributeError:
     390. and let other exceptions pass through:

          >>> class A:
          ...     @property
          ...     def f(self):
          ...         return 1 // 0
          ...
          >>> a = A()
          >>> hasattr(a, 'f')
          Traceback (most recent call last):
            ...
          ZeroDivisionError: integer division or modulo by zero

     (Discovered by Yury Selivanov and fixed by Benjamin Peterson;
     bpo-9666(4).)

   * The *note str(): 325. of a float or complex number is now the same
     as its *note repr(): 7c0.  Previously, the *note str(): 325. form
     was shorter but that just caused confusion and is no longer needed
     now that the shortest possible *note repr(): 7c0. is displayed by
     default:

          >>> import math
          >>> repr(math.pi)
          '3.141592653589793'
          >>> str(math.pi)
          '3.141592653589793'

     (Proposed and implemented by Mark Dickinson; bpo-9337(5).)

   * *note memoryview: 25a. objects now have a *note release(): b30.
     method and they also now support the context management protocol.
     This allows timely release of any resources that were acquired when
     requesting a buffer from the original object.

          >>> with memoryview(b'abcdefgh') as v:
          ...     print(v.tolist())
          [97, 98, 99, 100, 101, 102, 103, 104]

     (Added by Antoine Pitrou; bpo-9757(6).)

   * Previously it was illegal to delete a name from the local namespace
     if it occurs as a free variable in a nested block:

          def outer(x):
              def inner():
                  return x
              inner()
              del x

     This is now allowed.  Remember that the target of an *note except:
     b31. clause is cleared, so this code which used to work with Python
     2.6, raised a *note SyntaxError: 44d. with Python 3.1 and now works
     again:

          def f():
              def print_error():
                  print(e)
              try:
                  something
              except Exception as e:
                  print_error()
                  # implicit "del e" here

     (See bpo-4617(7).)

   * The internal ‘structsequence’ tool now creates subclasses of tuple.
     This means that C structures like those returned by *note
     os.stat(): 1ef, *note time.gmtime(): b32, and *note
     sys.version_info: b0d. now work like a *note named tuple: a98. and
     now work with functions and methods that expect a tuple as an
     argument.  This is a big step forward in making the C structures as
     flexible as their pure Python counterparts:

          >>> import sys
          >>> isinstance(sys.version_info, tuple)
          True
          >>> 'Version %d.%d.%d %s(%d)' % sys.version_info # doctest: +SKIP
          'Version 3.2.0 final(0)'

     (Suggested by Arfrever Frehtes Taifersar Arahesis and implemented
     by Benjamin Peterson in bpo-8413(8).)

   * Warnings are now easier to control using the *note PYTHONWARNINGS:
     40d. environment variable as an alternative to using ‘-W’ at the
     command line:

          $ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'

     (Suggested by Barry Warsaw and implemented by Philip Jenvey in
     bpo-7301(9).)

   * A new warning category, *note ResourceWarning: 4c5, has been added.
     It is emitted when potential issues with resource consumption or
     cleanup are detected.  It is silenced by default in normal release
     builds but can be enabled through the means provided by the *note
     warnings: 126. module, or on the command line.

     A *note ResourceWarning: 4c5. is issued at interpreter shutdown if
     the *note gc.garbage: b33. list isn’t empty, and if *note
     gc.DEBUG_UNCOLLECTABLE: b34. is set, all uncollectable objects are
     printed.  This is meant to make the programmer aware that their
     code contains object finalization issues.

     A *note ResourceWarning: 4c5. is also issued when a *note file
     object: b35. is destroyed without having been explicitly closed.
     While the deallocator for such object ensures it closes the
     underlying operating system resource (usually, a file descriptor),
     the delay in deallocating the object could produce various issues,
     especially under Windows.  Here is an example of enabling the
     warning from the command line:

          $ python -q -Wdefault
          >>> f = open("foo", "wb")
          >>> del f
          __main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>

     (Added by Antoine Pitrou and Georg Brandl in bpo-10093(10) and
     bpo-477863(11).)

   * *note range: 9b2. objects now support `index' and `count' methods.
     This is part of an effort to make more objects fully implement the
     ‘collections.Sequence’ *note abstract base class: b26.  As a
     result, the language will have a more uniform API. In addition,
     *note range: 9b2. objects now support slicing and negative indices,
     even with values larger than *note sys.maxsize: b36.  This makes
     `range' more interoperable with lists:

          >>> range(0, 100, 2).count(10)
          1
          >>> range(0, 100, 2).index(10)
          5
          >>> range(0, 100, 2)[5]
          10
          >>> range(0, 100, 2)[0:5]
          range(0, 10, 2)

     (Contributed by Daniel Stutzbach in bpo-9213(12), by Alexander
     Belopolsky in bpo-2690(13), and by Nick Coghlan in bpo-10889(14).)

   * The *note callable(): b37. builtin function from Py2.x was
     resurrected.  It provides a concise, readable alternative to using
     an *note abstract base class: b26. in an expression like
     ‘isinstance(x, collections.Callable)’:

          >>> callable(max)
          True
          >>> callable(20)
          False

     (See bpo-10518(15).)

   * Python’s import mechanism can now load modules installed in
     directories with non-ASCII characters in the path name.  This
     solved an aggravating problem with home directories for users with
     non-ASCII characters in their usernames.

     (Required extensive work by Victor Stinner in bpo-9425(16).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7094

   (2) https://bugs.python.org/issue6081

   (3) https://bugs.python.org/issue1772833

   (4) https://bugs.python.org/issue9666

   (5) https://bugs.python.org/issue9337

   (6) https://bugs.python.org/issue9757

   (7) https://bugs.python.org/issue4617

   (8) https://bugs.python.org/issue8413

   (9) https://bugs.python.org/issue7301

   (10) https://bugs.python.org/issue10093

   (11) https://bugs.python.org/issue477863

   (12) https://bugs.python.org/issue9213

   (13) https://bugs.python.org/issue2690

   (14) https://bugs.python.org/issue10889

   (15) https://bugs.python.org/issue10518

   (16) https://bugs.python.org/issue9425


File: python.info,  Node: New Improved and Deprecated Modules,  Next: Multi-threading,  Prev: Other Language Changes<7>,  Up: What’s New In Python 3 2

1.7.9 New, Improved, and Deprecated Modules
-------------------------------------------

Python’s standard library has undergone significant maintenance efforts
and quality improvements.

The biggest news for Python 3.2 is that the *note email: 69. package,
*note mailbox: ae. module, and *note nntplib: c0. modules now work
correctly with the bytes/text model in Python 3.  For the first time,
there is correct handling of messages with mixed encodings.

Throughout the standard library, there has been more careful attention
to encodings and text versus bytes issues.  In particular, interactions
with the operating system are now better able to exchange non-ASCII data
using the Windows MBCS encoding, locale-aware encodings, or UTF-8.

Another significant win is the addition of substantially better support
for `SSL' connections and security certificates.

In addition, more classes now implement a *note context manager: 55d. to
support convenient and reliable resource clean-up using a *note with:
6dd. statement.

* Menu:

* email: email<5>.
* elementtree::
* functools: functools<6>.
* itertools: itertools<4>.
* collections: collections<8>.
* threading: threading<6>.
* datetime and time::
* math: math<6>.
* abc: abc<3>.
* io: io<5>.
* reprlib::
* logging: logging<7>.
* csv: csv<3>.
* contextlib: contextlib<6>.
* decimal and fractions::
* ftp::
* popen::
* select: select<3>.
* gzip and zipfile::
* tarfile: tarfile<5>.
* hashlib: hashlib<3>.
* ast: ast<3>.
* os: os<8>.
* shutil: shutil<5>.
* sqlite3: sqlite3<6>.
* html: html<3>.
* socket: socket<8>.
* ssl: ssl<9>.
* nntp::
* certificates::
* imaplib: imaplib<3>.
* http.client: http client<4>.
* unittest: unittest<6>.
* random: random<2>.
* poplib: poplib<3>.
* asyncore: asyncore<2>.
* tempfile: tempfile<2>.
* inspect: inspect<6>.
* pydoc: pydoc<5>.
* dis: dis<3>.
* dbm: dbm<6>.
* ctypes: ctypes<2>.
* site: site<2>.
* sysconfig: sysconfig<2>.
* pdb: pdb<5>.
* configparser: configparser<2>.
* urllib.parse: urllib parse<2>.
* mailbox::
* turtledemo::


File: python.info,  Node: email<5>,  Next: elementtree,  Up: New Improved and Deprecated Modules

1.7.9.1 email
.............

The usability of the *note email: 69. package in Python 3 has been
mostly fixed by the extensive efforts of R. David Murray.  The problem
was that emails are typically read and stored in the form of *note
bytes: 326. rather than *note str: 325. text, and they may contain
multiple encodings within a single email.  So, the email package had to
be extended to parse and generate email messages in bytes format.

   * New functions *note message_from_bytes(): b3a. and *note
     message_from_binary_file(): b3b, and new classes *note
     BytesFeedParser: b3c. and *note BytesParser: b3d. allow binary
     message data to be parsed into model objects.

   * Given bytes input to the model, *note get_payload(): b3e. will by
     default decode a message body that has a
     ‘Content-Transfer-Encoding’ of `8bit' using the charset specified
     in the MIME headers and return the resulting string.

   * Given bytes input to the model, *note Generator: b3f. will convert
     message bodies that have a ‘Content-Transfer-Encoding’ of `8bit' to
     instead have a `7bit' ‘Content-Transfer-Encoding’.

     Headers with unencoded non-ASCII bytes are deemed to be RFC
     2047(1)-encoded using the `unknown-8bit' character set.

   * A new class *note BytesGenerator: b40. produces bytes as output,
     preserving any unchanged non-ASCII data that was present in the
     input used to build the model, including message bodies with a
     ‘Content-Transfer-Encoding’ of `8bit'.

   * The *note smtplib: ed. *note SMTP: a76. class now accepts a byte
     string for the `msg' argument to the *note sendmail(): 738. method,
     and a new method, *note send_message(): 739. accepts a *note
     Message: 536. object and can optionally obtain the `from_addr' and
     `to_addrs' addresses directly from the object.

(Proposed and implemented by R. David Murray, bpo-4661(2) and
bpo-10321(3).)

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2047.html

   (2) https://bugs.python.org/issue4661

   (3) https://bugs.python.org/issue10321


File: python.info,  Node: elementtree,  Next: functools<6>,  Prev: email<5>,  Up: New Improved and Deprecated Modules

1.7.9.2 elementtree
...................

The *note xml.etree.ElementTree: 137. package and its
‘xml.etree.cElementTree’ counterpart have been updated to version 1.3.

Several new and useful functions and methods have been added:

   * *note xml.etree.ElementTree.fromstringlist(): b42. which builds an
     XML document from a sequence of fragments

   * *note xml.etree.ElementTree.register_namespace(): b43. for
     registering a global namespace prefix

   * *note xml.etree.ElementTree.tostringlist(): 90a. for string
     representation including all sublists

   * *note xml.etree.ElementTree.Element.extend(): b44. for appending a
     sequence of zero or more elements

   * *note xml.etree.ElementTree.Element.iterfind(): b45. searches an
     element and subelements

   * *note xml.etree.ElementTree.Element.itertext(): b46. creates a text
     iterator over an element and its subelements

   * *note xml.etree.ElementTree.TreeBuilder.end(): b47. closes the
     current element

   * *note xml.etree.ElementTree.TreeBuilder.doctype(): 2bf. handles a
     doctype declaration

Two methods have been deprecated:

   * ‘xml.etree.ElementTree.getchildren()’ use ‘list(elem)’ instead.

   * ‘xml.etree.ElementTree.getiterator()’ use ‘Element.iter’ instead.

For details of the update, see Introducing ElementTree(1) on Fredrik
Lundh’s website.

(Contributed by Florent Xicluna and Fredrik Lundh, bpo-6472(2).)

   ---------- Footnotes ----------

   (1) http://effbot.org/zone/elementtree-13-intro.htm

   (2) https://bugs.python.org/issue6472


File: python.info,  Node: functools<6>,  Next: itertools<4>,  Prev: elementtree,  Up: New Improved and Deprecated Modules

1.7.9.3 functools
.................

   * The *note functools: 85. module includes a new decorator for
     caching function calls.  *note functools.lru_cache(): 1c5. can save
     repeated queries to an external resource whenever the results are
     expected to be the same.

     For example, adding a caching decorator to a database query
     function can save database accesses for popular searches:

          >>> import functools
          >>> @functools.lru_cache(maxsize=300)
          ... def get_phone_number(name):
          ...     c = conn.cursor()
          ...     c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
          ...     return c.fetchone()[0]

          >>> for name in user_requests:        # doctest: +SKIP
          ...     get_phone_number(name)        # cached lookup

     To help with choosing an effective cache size, the wrapped function
     is instrumented for tracking cache statistics:

          >>> get_phone_number.cache_info()     # doctest: +SKIP
          CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)

     If the phonelist table gets updated, the outdated contents of the
     cache can be cleared with:

          >>> get_phone_number.cache_clear()

     (Contributed by Raymond Hettinger and incorporating design ideas
     from Jim Baker, Miki Tebeka, and Nick Coghlan; see recipe
     498245(1), recipe 577479(2), bpo-10586(3), and bpo-10593(4).)

   * The *note functools.wraps(): 85e. decorator now adds a
     ‘__wrapped__’ attribute pointing to the original callable function.
     This allows wrapped functions to be introspected.  It also copies
     ‘__annotations__’ if defined.  And now it also gracefully skips
     over missing attributes such as ‘__doc__’ which might not be
     defined for the wrapped callable.

     In the above example, the cache can be removed by recovering the
     original function:

          >>> get_phone_number = get_phone_number.__wrapped__    # uncached function

     (By Nick Coghlan and Terrence Cole; bpo-9567(5), bpo-3445(6), and
     bpo-8814(7).)

   * To help write classes with rich comparison methods, a new decorator
     *note functools.total_ordering(): 83f. will use existing equality
     and inequality methods to fill in the remaining methods.

     For example, supplying `__eq__' and `__lt__' will enable *note
     total_ordering(): 83f. to fill-in `__le__', `__gt__' and `__ge__':

          @total_ordering
          class Student:
              def __eq__(self, other):
                  return ((self.lastname.lower(), self.firstname.lower()) ==
                          (other.lastname.lower(), other.firstname.lower()))

              def __lt__(self, other):
                  return ((self.lastname.lower(), self.firstname.lower()) <
                          (other.lastname.lower(), other.firstname.lower()))

     With the `total_ordering' decorator, the remaining comparison
     methods are filled in automatically.

     (Contributed by Raymond Hettinger.)

   * To aid in porting programs from Python 2, the *note
     functools.cmp_to_key(): b49. function converts an old-style
     comparison function to modern *note key function: 6d4.:

          >>> # locale-aware sort order
          >>> sorted(iterable, key=cmp_to_key(locale.strcoll)) # doctest: +SKIP

     For sorting examples and a brief sorting tutorial, see the Sorting
     HowTo(8) tutorial.

     (Contributed by Raymond Hettinger.)

   ---------- Footnotes ----------

   (1) https://code.activestate.com/recipes/498245

   (2) https://code.activestate.com/recipes/577479

   (3) https://bugs.python.org/issue10586

   (4) https://bugs.python.org/issue10593

   (5) https://bugs.python.org/issue9567

   (6) https://bugs.python.org/issue3445

   (7) https://bugs.python.org/issue8814

   (8) https://wiki.python.org/moin/HowTo/Sorting/


File: python.info,  Node: itertools<4>,  Next: collections<8>,  Prev: functools<6>,  Up: New Improved and Deprecated Modules

1.7.9.4 itertools
.................

   * The *note itertools: a3. module has a new *note accumulate(): 1db.
     function modeled on APL’s `scan' operator and Numpy’s `accumulate'
     function:

          >>> from itertools import accumulate
          >>> list(accumulate([8, 2, 50]))
          [8, 10, 60]

          >>> prob_dist = [0.1, 0.4, 0.2, 0.3]
          >>> list(accumulate(prob_dist))      # cumulative probability distribution
          [0.1, 0.5, 0.7, 1.0]

     For an example using *note accumulate(): 1db, see the *note
     examples for the random module: b4b.

     (Contributed by Raymond Hettinger and incorporating design
     suggestions from Mark Dickinson.)


File: python.info,  Node: collections<8>,  Next: threading<6>,  Prev: itertools<4>,  Up: New Improved and Deprecated Modules

1.7.9.5 collections
...................

   * The *note collections.Counter: 9ce. class now has two forms of
     in-place subtraction, the existing `-=' operator for saturating
     subtraction(1) and the new *note subtract(): b4d. method for
     regular subtraction.  The former is suitable for multisets(2) which
     only have positive counts, and the latter is more suitable for use
     cases that allow negative counts:

          >>> from collections import Counter
          >>> tally = Counter(dogs=5, cats=3)
          >>> tally -= Counter(dogs=2, cats=8)    # saturating subtraction
          >>> tally
          Counter({'dogs': 3})

          >>> tally = Counter(dogs=5, cats=3)
          >>> tally.subtract(dogs=2, cats=8)      # regular subtraction
          >>> tally
          Counter({'dogs': 3, 'cats': -5})

     (Contributed by Raymond Hettinger.)

   * The *note collections.OrderedDict: 1b7. class has a new method
     *note move_to_end(): b4e. which takes an existing key and moves it
     to either the first or last position in the ordered sequence.

     The default is to move an item to the last position.  This is
     equivalent of renewing an entry with ‘od[k] = od.pop(k)’.

     A fast move-to-end operation is useful for resequencing entries.
     For example, an ordered dictionary can be used to track order of
     access by aging entries from the oldest to the most recently
     accessed.

          >>> from collections import OrderedDict
          >>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
          >>> list(d)
          ['a', 'b', 'X', 'd', 'e']
          >>> d.move_to_end('X')
          >>> list(d)
          ['a', 'b', 'd', 'e', 'X']

     (Contributed by Raymond Hettinger.)

   * The *note collections.deque: 526. class grew two new methods *note
     count(): b4f. and *note reverse(): b50. that make them more
     substitutable for *note list: 260. objects:

          >>> from collections import deque
          >>> d = deque('simsalabim')
          >>> d.count('s')
          2
          >>> d.reverse()
          >>> d
          deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])

     (Contributed by Raymond Hettinger.)

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Saturation_arithmetic

   (2) https://en.wikipedia.org/wiki/Multiset


File: python.info,  Node: threading<6>,  Next: datetime and time,  Prev: collections<8>,  Up: New Improved and Deprecated Modules

1.7.9.6 threading
.................

The *note threading: 109. module has a new *note Barrier: b52.
synchronization class for making multiple threads wait until all of them
have reached a common barrier point.  Barriers are useful for making
sure that a task with multiple preconditions does not run until all of
the predecessor tasks are complete.

Barriers can work with an arbitrary number of threads.  This is a
generalization of a Rendezvous(1) which is defined for only two threads.

Implemented as a two-phase cyclic barrier, *note Barrier: b52. objects
are suitable for use in loops.  The separate `filling' and `draining'
phases assure that all threads get released (drained) before any one of
them can loop back and re-enter the barrier.  The barrier fully resets
after each cycle.

Example of using barriers:

     from threading import Barrier, Thread

     def get_votes(site):
         ballots = conduct_election(site)
         all_polls_closed.wait()        # do not count until all polls are closed
         totals = summarize(ballots)
         publish(site, totals)

     all_polls_closed = Barrier(len(sites))
     for site in sites:
         Thread(target=get_votes, args=(site,)).start()

In this example, the barrier enforces a rule that votes cannot be
counted at any polling site until all polls are closed.  Notice how a
solution with a barrier is similar to one with *note
threading.Thread.join(): b53, but the threads stay alive and continue to
do work (summarizing ballots) after the barrier point is crossed.

If any of the predecessor tasks can hang or be delayed, a barrier can be
created with an optional `timeout' parameter.  Then if the timeout
period elapses before all the predecessor tasks reach the barrier point,
all waiting threads are released and a *note BrokenBarrierError: b54.
exception is raised:

     def get_votes(site):
         ballots = conduct_election(site)
         try:
             all_polls_closed.wait(timeout=midnight - time.now())
         except BrokenBarrierError:
             lockbox = seal_ballots(ballots)
             queue.put(lockbox)
         else:
             totals = summarize(ballots)
             publish(site, totals)

In this example, the barrier enforces a more robust rule.  If some
election sites do not finish before midnight, the barrier times-out and
the ballots are sealed and deposited in a queue for later handling.

See Barrier Synchronization Patterns(2) for more examples of how
barriers can be used in parallel computing.  Also, there is a simple but
thorough explanation of barriers in The Little Book of Semaphores(3),
`section 3.6'.

(Contributed by Kristján Valur Jónsson with an API review by Jeffrey
Yasskin in bpo-8777(4).)

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Synchronous_rendezvous

   (2) 
http://osl.cs.illinois.edu/media/papers/karmani-2009-barrier_synchronization_pattern.pdf

   (3) https://greenteapress.com/semaphores/LittleBookOfSemaphores.pdf

   (4) https://bugs.python.org/issue8777


File: python.info,  Node: datetime and time,  Next: math<6>,  Prev: threading<6>,  Up: New Improved and Deprecated Modules

1.7.9.7 datetime and time
.........................

   * The *note datetime: 31. module has a new type *note timezone: 9f5.
     that implements the *note tzinfo: 375. interface by returning a
     fixed UTC offset and timezone name.  This makes it easier to create
     timezone-aware datetime objects:

          >>> from datetime import datetime, timezone

          >>> datetime.now(timezone.utc)
          datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)

          >>> datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
          datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)

   * Also, *note timedelta: 195. objects can now be multiplied by *note
     float: 187. and divided by *note float: 187. and *note int: 184.
     objects.  And *note timedelta: 195. objects can now divide one
     another.

   * The *note datetime.date.strftime(): 52d. method is no longer
     restricted to years after 1900.  The new supported year range is
     from 1000 to 9999 inclusive.

   * Whenever a two-digit year is used in a time tuple, the
     interpretation has been governed by ‘time.accept2dyear’.  The
     default is ‘True’ which means that for a two-digit year, the
     century is guessed according to the POSIX rules governing the ‘%y’
     strptime format.

     Starting with Py3.2, use of the century guessing heuristic will
     emit a *note DeprecationWarning: 276.  Instead, it is recommended
     that ‘time.accept2dyear’ be set to ‘False’ so that large date
     ranges can be used without guesswork:

          >>> import time, warnings
          >>> warnings.resetwarnings()      # remove the default warning filters

          >>> time.accept2dyear = True      # guess whether 11 means 11 or 2011
          >>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
          Warning (from warnings module):
            ...
          DeprecationWarning: Century info guessed for a 2-digit year.
          'Fri Jan  1 12:34:56 2011'

          >>> time.accept2dyear = False     # use the full range of allowable dates
          >>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
          'Fri Jan  1 12:34:56 11'

     Several functions now have significantly expanded date ranges.
     When ‘time.accept2dyear’ is false, the *note time.asctime(): b56.
     function will accept any year that fits in a C int, while the *note
     time.mktime(): b57. and *note time.strftime(): b58. functions will
     accept the full range supported by the corresponding operating
     system functions.

(Contributed by Alexander Belopolsky and Victor Stinner in
bpo-1289118(1), bpo-5094(2), bpo-6641(3), bpo-2706(4), bpo-1777412(5),
bpo-8013(6), and bpo-10827(7).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1289118

   (2) https://bugs.python.org/issue5094

   (3) https://bugs.python.org/issue6641

   (4) https://bugs.python.org/issue2706

   (5) https://bugs.python.org/issue1777412

   (6) https://bugs.python.org/issue8013

   (7) https://bugs.python.org/issue10827


File: python.info,  Node: math<6>,  Next: abc<3>,  Prev: datetime and time,  Up: New Improved and Deprecated Modules

1.7.9.8 math
............

The *note math: b1. module has been updated with six new functions
inspired by the C99 standard.

The *note isfinite(): b5a. function provides a reliable and fast way to
detect special values.  It returns ‘True’ for regular numbers and
‘False’ for `Nan' or `Infinity':

     >>> from math import isfinite
     >>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))]
     [True, True, False, False]

The *note expm1(): b5b. function computes ‘e**x-1’ for small values of
`x' without incurring the loss of precision that usually accompanies the
subtraction of nearly equal quantities:

     >>> from math import expm1
     >>> expm1(0.013671875)   # more accurate way to compute e**x-1 for a small x
     0.013765762467652909

The *note erf(): 447. function computes a probability integral or
Gaussian error function(1).  The complementary error function, *note
erfc(): 448, is ‘1 - erf(x)’:

     >>> from math import erf, erfc, sqrt
     >>> erf(1.0/sqrt(2.0))   # portion of normal distribution within 1 standard deviation
     0.682689492137086
     >>> erfc(1.0/sqrt(2.0))  # portion of normal distribution outside 1 standard deviation
     0.31731050786291404
     >>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
     1.0

The *note gamma(): b5c. function is a continuous extension of the
factorial function.  See ‘https://en.wikipedia.org/wiki/Gamma_function’
for details.  Because the function is related to factorials, it grows
large even for small values of `x', so there is also a *note lgamma():
b5d. function for computing the natural logarithm of the gamma function:

     >>> from math import gamma, lgamma
     >>> gamma(7.0)           # six factorial
     720.0
     >>> lgamma(801.0)        # log(800 factorial)
     4551.950730698041

(Contributed by Mark Dickinson.)

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Error_function


File: python.info,  Node: abc<3>,  Next: io<5>,  Prev: math<6>,  Up: New Improved and Deprecated Modules

1.7.9.9 abc
...........

The *note abc: 4. module now supports *note abstractclassmethod(): 9c3.
and *note abstractstaticmethod(): 9c4.

These tools make it possible to define an *note abstract base class:
b26. that requires a particular *note classmethod(): 1d6. or *note
staticmethod(): 1d7. to be implemented:

     class Temperature(metaclass=abc.ABCMeta):
         @abc.abstractclassmethod
         def from_fahrenheit(cls, t):
             ...
         @abc.abstractclassmethod
         def from_celsius(cls, t):
             ...

(Patch submitted by Daniel Urban; bpo-5867(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5867


File: python.info,  Node: io<5>,  Next: reprlib,  Prev: abc<3>,  Up: New Improved and Deprecated Modules

1.7.9.10 io
...........

The *note io.BytesIO: 78f. has a new method, *note getbuffer(): b60,
which provides functionality similar to *note memoryview(): 25a.  It
creates an editable view of the data without making a copy.  The
buffer’s random access and support for slice notation are well-suited to
in-place editing:

     >>> REC_LEN, LOC_START, LOC_LEN = 34, 7, 11

     >>> def change_location(buffer, record_number, location):
     ...     start = record_number * REC_LEN + LOC_START
     ...     buffer[start: start+LOC_LEN] = location

     >>> import io

     >>> byte_stream = io.BytesIO(
     ...     b'G3805  storeroom  Main chassis    '
     ...     b'X7899  shipping   Reserve cog     '
     ...     b'L6988  receiving  Primary sprocket'
     ... )
     >>> buffer = byte_stream.getbuffer()
     >>> change_location(buffer, 1, b'warehouse  ')
     >>> change_location(buffer, 0, b'showroom   ')
     >>> print(byte_stream.getvalue())
     b'G3805  showroom   Main chassis    '
     b'X7899  warehouse  Reserve cog     '
     b'L6988  receiving  Primary sprocket'

(Contributed by Antoine Pitrou in bpo-5506(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5506


File: python.info,  Node: reprlib,  Next: logging<7>,  Prev: io<5>,  Up: New Improved and Deprecated Modules

1.7.9.11 reprlib
................

When writing a *note __repr__(): 333. method for a custom container, it
is easy to forget to handle the case where a member refers back to the
container itself.  Python’s builtin objects such as *note list: 260. and
*note set: b62. handle self-reference by displaying “…” in the recursive
part of the representation string.

To help write such *note __repr__(): 333. methods, the *note reprlib:
df. module has a new decorator, *note recursive_repr(): b63, for
detecting recursive calls to *note __repr__(): 333. and substituting a
placeholder string instead:

     >>> class MyList(list):
     ...     @recursive_repr()
     ...     def __repr__(self):
     ...         return '<' + '|'.join(map(repr, self)) + '>'
     ...
     >>> m = MyList('abc')
     >>> m.append(m)
     >>> m.append('x')
     >>> print(m)
     <'a'|'b'|'c'|...|'x'>

(Contributed by Raymond Hettinger in bpo-9826(1) and bpo-9840(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9826

   (2) https://bugs.python.org/issue9840


File: python.info,  Node: logging<7>,  Next: csv<3>,  Prev: reprlib,  Up: New Improved and Deprecated Modules

1.7.9.12 logging
................

In addition to dictionary-based configuration described above, the *note
logging: aa. package has many other improvements.

The logging documentation has been augmented by a *note basic tutorial:
b65, an *note advanced tutorial: b66, and a *note cookbook: b67. of
logging recipes.  These documents are the fastest way to learn about
logging.

The *note logging.basicConfig(): 1de. set-up function gained a `style'
argument to support three different types of string formatting.  It
defaults to “%” for traditional %-formatting, can be set to “{” for the
new *note str.format(): 4cf. style, or can be set to “$” for the
shell-style formatting provided by *note string.Template: 3e0.  The
following three configurations are equivalent:

     >>> from logging import basicConfig
     >>> basicConfig(style='%', format="%(name)s -> %(levelname)s: %(message)s")
     >>> basicConfig(style='{', format="{name} -> {levelname} {message}")
     >>> basicConfig(style='$', format="$name -> $levelname: $message")

If no configuration is set-up before a logging event occurs, there is
now a default configuration using a *note StreamHandler: b68. directed
to *note sys.stderr: 304. for events of ‘WARNING’ level or higher.
Formerly, an event occurring before a configuration was set-up would
either raise an exception or silently drop the event depending on the
value of ‘logging.raiseExceptions’.  The new default handler is stored
in *note logging.lastResort: b69.

The use of filters has been simplified.  Instead of creating a *note
Filter: b6a. object, the predicate can be any Python callable that
returns ‘True’ or ‘False’.

There were a number of other improvements that add flexibility and
simplify configuration.  See the module documentation for a full listing
of changes in Python 3.2.


File: python.info,  Node: csv<3>,  Next: contextlib<6>,  Prev: logging<7>,  Up: New Improved and Deprecated Modules

1.7.9.13 csv
............

The *note csv: 2a. module now supports a new dialect, *note
unix_dialect: b6c, which applies quoting for all fields and a
traditional Unix style with ‘'\n'’ as the line terminator.  The
registered dialect name is ‘unix’.

The *note csv.DictWriter: b6d. has a new method, *note writeheader():
b6e. for writing-out an initial row to document the field names:

     >>> import csv, sys
     >>> w = csv.DictWriter(sys.stdout, ['name', 'dept'], dialect='unix')
     >>> w.writeheader()
     "name","dept"
     >>> w.writerows([
     ...     {'name': 'tom', 'dept': 'accounting'},
     ...     {'name': 'susan', 'dept': 'Salesl'}])
     "tom","accounting"
     "susan","sales"

(New dialect suggested by Jay Talbot in bpo-5975(1), and the new method
suggested by Ed Abraham in bpo-1537721(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5975

   (2) https://bugs.python.org/issue1537721


File: python.info,  Node: contextlib<6>,  Next: decimal and fractions,  Prev: csv<3>,  Up: New Improved and Deprecated Modules

1.7.9.14 contextlib
...................

There is a new and slightly mind-blowing tool *note ContextDecorator:
b70. that is helpful for creating a *note context manager: 55d. that
does double duty as a function decorator.

As a convenience, this new functionality is used by *note
contextmanager(): b71. so that no extra effort is needed to support both
roles.

The basic idea is that both context managers and function decorators can
be used for pre-action and post-action wrappers.  Context managers wrap
a group of statements using a *note with: 6dd. statement, and function
decorators wrap a group of statements enclosed in a function.  So,
occasionally there is a need to write a pre-action or post-action
wrapper that can be used in either role.

For example, it is sometimes useful to wrap functions or groups of
statements with a logger that can track the time of entry and time of
exit.  Rather than writing both a function decorator and a context
manager for the task, the *note contextmanager(): b71. provides both
capabilities in a single definition:

     from contextlib import contextmanager
     import logging

     logging.basicConfig(level=logging.INFO)

     @contextmanager
     def track_entry_and_exit(name):
         logging.info('Entering: %s', name)
         yield
         logging.info('Exiting: %s', name)

Formerly, this would have only been usable as a context manager:

     with track_entry_and_exit('widget loader'):
         print('Some time consuming activity goes here')
         load_widget()

Now, it can be used as a decorator as well:

     @track_entry_and_exit('widget loader')
     def activity():
         print('Some time consuming activity goes here')
         load_widget()

Trying to fulfill two roles at once places some limitations on the
technique.  Context managers normally have the flexibility to return an
argument usable by a *note with: 6dd. statement, but there is no
parallel for function decorators.

In the above example, there is not a clean way for the
`track_entry_and_exit' context manager to return a logging instance for
use in the body of enclosed statements.

(Contributed by Michael Foord in bpo-9110(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9110


File: python.info,  Node: decimal and fractions,  Next: ftp,  Prev: contextlib<6>,  Up: New Improved and Deprecated Modules

1.7.9.15 decimal and fractions
..............................

Mark Dickinson crafted an elegant and efficient scheme for assuring that
different numeric datatypes will have the same hash value whenever their
actual values are equal (bpo-8188(1)):

     assert hash(Fraction(3, 2)) == hash(1.5) == \
            hash(Decimal("1.5")) == hash(complex(1.5, 0))

Some of the hashing details are exposed through a new attribute, *note
sys.hash_info: 915, which describes the bit width of the hash value, the
prime modulus, the hash values for `infinity' and `nan', and the
multiplier used for the imaginary part of a number:

     >>> sys.hash_info # doctest: +SKIP
     sys.hash_info(width=64, modulus=2305843009213693951, inf=314159, nan=0, imag=1000003)

An early decision to limit the inter-operability of various numeric
types has been relaxed.  It is still unsupported (and ill-advised) to
have implicit mixing in arithmetic expressions such as ‘Decimal('1.1') +
float('1.1')’ because the latter loses information in the process of
constructing the binary float.  However, since existing floating point
value can be converted losslessly to either a decimal or rational
representation, it makes sense to add them to the constructor and to
support mixed-type comparisons.

   * The *note decimal.Decimal: 188. constructor now accepts *note
     float: 187. objects directly so there in no longer a need to use
     the *note from_float(): b73. method (bpo-8257(2)).

   * Mixed type comparisons are now fully supported so that *note
     Decimal: 188. objects can be directly compared with *note float:
     187. and *note fractions.Fraction: 185. (bpo-2531(3) and
     bpo-8188(4)).

Similar changes were made to *note fractions.Fraction: 185. so that the
*note from_float(): b74. and *note from_decimal(): b75. methods are no
longer needed (bpo-8294(5)):

     >>> from decimal import Decimal
     >>> from fractions import Fraction
     >>> Decimal(1.1)
     Decimal('1.100000000000000088817841970012523233890533447265625')
     >>> Fraction(1.1)
     Fraction(2476979795053773, 2251799813685248)

Another useful change for the *note decimal: 36. module is that the
‘Context.clamp’ attribute is now public.  This is useful in creating
contexts that correspond to the decimal interchange formats specified in
IEEE 754 (see bpo-8540(6)).

(Contributed by Mark Dickinson and Raymond Hettinger.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8188

   (2) https://bugs.python.org/issue8257

   (3) https://bugs.python.org/issue2531

   (4) https://bugs.python.org/issue8188

   (5) https://bugs.python.org/issue8294

   (6) https://bugs.python.org/issue8540


File: python.info,  Node: ftp,  Next: popen,  Prev: decimal and fractions,  Up: New Improved and Deprecated Modules

1.7.9.16 ftp
............

The *note ftplib.FTP: 9f7. class now supports the context management
protocol to unconditionally consume *note socket.error: 989. exceptions
and to close the FTP connection when done:

     >>> from ftplib import FTP
     >>> with FTP("ftp1.at.proftpd.org") as ftp:
             ftp.login()
             ftp.dir()

     '230 Anonymous login ok, restrictions apply.'
     dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .
     dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 ..
     dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS
     dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora

Other file-like objects such as *note mmap.mmap: 1ea. and *note
fileinput.input(): 2ab. also grew auto-closing context managers:

     with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
         for line in f:
             process(line)

(Contributed by Tarek Ziadé and Giampaolo Rodolà in bpo-4972(1), and by
Georg Brandl in bpo-8046(2) and bpo-1286(3).)

The *note FTP_TLS: 9f8. class now accepts a `context' parameter, which
is a *note ssl.SSLContext: 3d9. object allowing bundling SSL
configuration options, certificates and private keys into a single
(potentially long-lived) structure.

(Contributed by Giampaolo Rodolà; bpo-8806(4).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4972

   (2) https://bugs.python.org/issue8046

   (3) https://bugs.python.org/issue1286

   (4) https://bugs.python.org/issue8806


File: python.info,  Node: popen,  Next: select<3>,  Prev: ftp,  Up: New Improved and Deprecated Modules

1.7.9.17 popen
..............

The *note os.popen(): 2a7. and *note subprocess.Popen(): 2b7. functions
now support *note with: 6dd. statements for auto-closing of the file
descriptors.

(Contributed by Antoine Pitrou and Brian Curtin in bpo-7461(1) and
bpo-10554(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7461

   (2) https://bugs.python.org/issue10554


File: python.info,  Node: select<3>,  Next: gzip and zipfile,  Prev: popen,  Up: New Improved and Deprecated Modules

1.7.9.18 select
...............

The *note select: e5. module now exposes a new, constant attribute,
*note PIPE_BUF: b79, which gives the minimum number of bytes which are
guaranteed not to block when *note select.select(): 667. says a pipe is
ready for writing.

     >>> import select
     >>> select.PIPE_BUF  # doctest: +SKIP
     512

(Available on Unix systems.  Patch by Sébastien Sablé in bpo-9862(1))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9862


File: python.info,  Node: gzip and zipfile,  Next: tarfile<5>,  Prev: select<3>,  Up: New Improved and Deprecated Modules

1.7.9.19 gzip and zipfile
.........................

*note gzip.GzipFile: 6d1. now implements the *note io.BufferedIOBase:
57d. *note abstract base class: b26. (except for ‘truncate()’).  It also
has a *note peek(): b7b. method and supports unseekable as well as
zero-padded file objects.

The *note gzip: 8c. module also gains the *note compress(): 1cf. and
*note decompress(): b7c. functions for easier in-memory compression and
decompression.  Keep in mind that text needs to be encoded as *note
bytes: 326. before compressing and decompressing:

     >>> import gzip
     >>> s = 'Three shall be the number thou shalt count, '
     >>> s += 'and the number of the counting shall be three'
     >>> b = s.encode()                        # convert to utf-8
     >>> len(b)
     89
     >>> c = gzip.compress(b)
     >>> len(c)
     77
     >>> gzip.decompress(c).decode()[:42]      # decompress and convert to text
     'Three shall be the number thou shalt count'

(Contributed by Anand B. Pillai in bpo-3488(1); and by Antoine Pitrou,
Nir Aides and Brian Curtin in bpo-9962(2), bpo-1675951(3), bpo-7471(4)
and bpo-2846(5).)

Also, the ‘zipfile.ZipExtFile’ class was reworked internally to
represent files stored inside an archive.  The new implementation is
significantly faster and can be wrapped in an *note io.BufferedReader:
b7d. object for more speedups.  It also solves an issue where
interleaved calls to `read' and `readline' gave the wrong results.

(Patch submitted by Nir Aides in bpo-7610(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3488

   (2) https://bugs.python.org/issue9962

   (3) https://bugs.python.org/issue1675951

   (4) https://bugs.python.org/issue7471

   (5) https://bugs.python.org/issue2846

   (6) https://bugs.python.org/issue7610


File: python.info,  Node: tarfile<5>,  Next: hashlib<3>,  Prev: gzip and zipfile,  Up: New Improved and Deprecated Modules

1.7.9.20 tarfile
................

The *note TarFile: b7f. class can now be used as a context manager.  In
addition, its *note add(): 471. method has a new option, `filter', that
controls which files are added to the archive and allows the file
metadata to be edited.

The new `filter' option replaces the older, less flexible `exclude'
parameter which is now deprecated.  If specified, the optional `filter'
parameter needs to be a *note keyword argument: 5b9.  The user-supplied
filter function accepts a *note TarInfo: b80. object and returns an
updated *note TarInfo: b80. object, or if it wants the file to be
excluded, the function can return ‘None’:

     >>> import tarfile, glob

     >>> def myfilter(tarinfo):
     ...     if tarinfo.isfile():             # only save real files
     ...         tarinfo.uname = 'monty'      # redact the user name
     ...         return tarinfo

     >>> with tarfile.open(name='myarchive.tar.gz', mode='w:gz') as tf:
     ...     for filename in glob.glob('*.txt'):
     ...         tf.add(filename, filter=myfilter)
     ...     tf.list()
     -rw-r--r-- monty/501        902 2011-01-26 17:59:11 annotations.txt
     -rw-r--r-- monty/501        123 2011-01-26 17:59:11 general_questions.txt
     -rw-r--r-- monty/501       3514 2011-01-26 17:59:11 prion.txt
     -rw-r--r-- monty/501        124 2011-01-26 17:59:11 py_todo.txt
     -rw-r--r-- monty/501       1399 2011-01-26 17:59:11 semaphore_notes.txt

(Proposed by Tarek Ziadé and implemented by Lars Gustäbel in
bpo-6856(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6856


File: python.info,  Node: hashlib<3>,  Next: ast<3>,  Prev: tarfile<5>,  Up: New Improved and Deprecated Modules

1.7.9.21 hashlib
................

The *note hashlib: 8d. module has two new constant attributes listing
the hashing algorithms guaranteed to be present in all implementations
and those available on the current implementation:

     >>> import hashlib

     >>> hashlib.algorithms_guaranteed
     {'sha1', 'sha224', 'sha384', 'sha256', 'sha512', 'md5'}

     >>> hashlib.algorithms_available
     {'md2', 'SHA256', 'SHA512', 'dsaWithSHA', 'mdc2', 'SHA224', 'MD4', 'sha256',
     'sha512', 'ripemd160', 'SHA1', 'MDC2', 'SHA', 'SHA384', 'MD2',
     'ecdsa-with-SHA1','md4', 'md5', 'sha1', 'DSA-SHA', 'sha224',
     'dsaEncryption', 'DSA', 'RIPEMD160', 'sha', 'MD5', 'sha384'}

(Suggested by Carl Chenet in bpo-7418(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7418


File: python.info,  Node: ast<3>,  Next: os<8>,  Prev: hashlib<3>,  Up: New Improved and Deprecated Modules

1.7.9.22 ast
............

The *note ast: 8. module has a wonderful a general-purpose tool for
safely evaluating expression strings using the Python literal syntax.
The *note ast.literal_eval(): 49b. function serves as a secure
alternative to the builtin *note eval(): b83. function which is easily
abused.  Python 3.2 adds *note bytes: 326. and *note set: b62. literals
to the list of supported types: strings, bytes, numbers, tuples, lists,
dicts, sets, booleans, and ‘None’.

     >>> from ast import literal_eval

     >>> request = "{'req': 3, 'func': 'pow', 'args': (2, 0.5)}"
     >>> literal_eval(request)
     {'args': (2, 0.5), 'req': 3, 'func': 'pow'}

     >>> request = "os.system('do something harmful')"
     >>> literal_eval(request)
     Traceback (most recent call last):
       ...
     ValueError: malformed node or string: <_ast.Call object at 0x101739a10>

(Implemented by Benjamin Peterson and Georg Brandl.)


File: python.info,  Node: os<8>,  Next: shutil<5>,  Prev: ast<3>,  Up: New Improved and Deprecated Modules

1.7.9.23 os
...........

Different operating systems use various encodings for filenames and
environment variables.  The *note os: c4. module provides two new
functions, *note fsencode(): 4e4. and *note fsdecode(): 4e3, for
encoding and decoding filenames:

     >>> import os
     >>> filename = 'Sehenswürdigkeiten'
     >>> os.fsencode(filename)
     b'Sehensw\xc3\xbcrdigkeiten'

Some operating systems allow direct access to encoded bytes in the
environment.  If so, the *note os.supports_bytes_environ: b85. constant
will be true.

For direct access to encoded environment variables (if available), use
the new *note os.getenvb(): b86. function or use *note os.environb: b87.
which is a bytes version of *note os.environ: b2a.

(Contributed by Victor Stinner.)


File: python.info,  Node: shutil<5>,  Next: sqlite3<6>,  Prev: os<8>,  Up: New Improved and Deprecated Modules

1.7.9.24 shutil
...............

The *note shutil.copytree(): 218. function has two new options:

   * `ignore_dangling_symlinks': when ‘symlinks=False’ so that the
     function copies a file pointed to by a symlink, not the symlink
     itself.  This option will silence the error raised if the file
     doesn’t exist.

   * `copy_function': is a callable that will be used to copy files.
     *note shutil.copy2(): 258. is used by default.

(Contributed by Tarek Ziadé.)

In addition, the *note shutil: e9. module now supports *note archiving
operations: b89. for zipfiles, uncompressed tarfiles, gzipped tarfiles,
and bzipped tarfiles.  And there are functions for registering
additional archiving file formats (such as xz compressed tarfiles or
custom formats).

The principal functions are *note make_archive(): 219. and *note
unpack_archive(): b8a.  By default, both operate on the current
directory (which can be set by *note os.chdir(): a34.) and on any
sub-directories.  The archive filename needs to be specified with a full
pathname.  The archiving step is non-destructive (the original files are
left unchanged).

     >>> import shutil, pprint

     >>> os.chdir('mydata')  # change to the source directory
     >>> f = shutil.make_archive('/var/backup/mydata',
     ...                         'zip')      # archive the current directory
     >>> f                                   # show the name of archive
     '/var/backup/mydata.zip'
     >>> os.chdir('tmp')                     # change to an unpacking
     >>> shutil.unpack_archive('/var/backup/mydata.zip')  # recover the data

     >>> pprint.pprint(shutil.get_archive_formats())  # display known formats
     [('bztar', "bzip2'ed tar-file"),
      ('gztar', "gzip'ed tar-file"),
      ('tar', 'uncompressed tar file'),
      ('zip', 'ZIP file')]

     >>> shutil.register_archive_format(     # register a new archive format
     ...     name='xz',
     ...     function=xz.compress,           # callable archiving function
     ...     extra_args=[('level', 8)],      # arguments to the function
     ...     description='xz compression'
     ... )

(Contributed by Tarek Ziadé.)


File: python.info,  Node: sqlite3<6>,  Next: html<3>,  Prev: shutil<5>,  Up: New Improved and Deprecated Modules

1.7.9.25 sqlite3
................

The *note sqlite3: f2. module was updated to pysqlite version 2.6.0.  It
has two new capabilities.

   * The ‘sqlite3.Connection.in_transit’ attribute is true if there is
     an active transaction for uncommitted changes.

   * The *note sqlite3.Connection.enable_load_extension(): b8c. and
     *note sqlite3.Connection.load_extension(): b8d. methods allows you
     to load SQLite extensions from “.so” files.  One well-known
     extension is the fulltext-search extension distributed with SQLite.

(Contributed by R. David Murray and Shashwat Anand; bpo-8845(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8845


File: python.info,  Node: html<3>,  Next: socket<8>,  Prev: sqlite3<6>,  Up: New Improved and Deprecated Modules

1.7.9.26 html
.............

A new *note html: 90. module was introduced with only a single function,
*note escape(): 928, which is used for escaping reserved characters from
HTML markup:

     >>> import html
     >>> html.escape('x > 2 && x < 7')
     'x &gt; 2 &amp;&amp; x &lt; 7'


File: python.info,  Node: socket<8>,  Next: ssl<9>,  Prev: html<3>,  Up: New Improved and Deprecated Modules

1.7.9.27 socket
...............

The *note socket: ef. module has two new improvements.

   * Socket objects now have a *note detach(): b90. method which puts
     the socket into closed state without actually closing the
     underlying file descriptor.  The latter can then be reused for
     other purposes.  (Added by Antoine Pitrou; bpo-8524(1).)

   * *note socket.create_connection(): b91. now supports the context
     management protocol to unconditionally consume *note socket.error:
     989. exceptions and to close the socket when done.  (Contributed by
     Giampaolo Rodolà; bpo-9794(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8524

   (2) https://bugs.python.org/issue9794


File: python.info,  Node: ssl<9>,  Next: nntp,  Prev: socket<8>,  Up: New Improved and Deprecated Modules

1.7.9.28 ssl
............

The *note ssl: f3. module added a number of features to satisfy common
requirements for secure (encrypted, authenticated) internet connections:

   * A new class, *note SSLContext: 3d9, serves as a container for
     persistent SSL data, such as protocol settings, certificates,
     private keys, and various other options.  It includes a *note
     wrap_socket(): 3da. for creating an SSL socket from an SSL context.

   * A new function, *note ssl.match_hostname(): 3d1, supports server
     identity verification for higher-level protocols by implementing
     the rules of HTTPS (from RFC 2818(1)) which are also suitable for
     other protocols.

   * The *note ssl.wrap_socket(): 464. constructor function now takes a
     `ciphers' argument.  The `ciphers' string lists the allowed
     encryption algorithms using the format described in the OpenSSL
     documentation(2).

   * When linked against recent versions of OpenSSL, the *note ssl: f3.
     module now supports the Server Name Indication extension to the TLS
     protocol, allowing multiple “virtual hosts” using different
     certificates on a single IP port.  This extension is only supported
     in client mode, and is activated by passing the `server_hostname'
     argument to *note ssl.SSLContext.wrap_socket(): 3da.

   * Various options have been added to the *note ssl: f3. module, such
     as *note OP_NO_SSLv2: b93. which disables the insecure and obsolete
     SSLv2 protocol.

   * The extension now loads all the OpenSSL ciphers and digest
     algorithms.  If some SSL certificates cannot be verified, they are
     reported as an “unknown algorithm” error.

   * The version of OpenSSL being used is now accessible using the
     module attributes *note ssl.OPENSSL_VERSION: b94. (a string), *note
     ssl.OPENSSL_VERSION_INFO: b95. (a 5-tuple), and *note
     ssl.OPENSSL_VERSION_NUMBER: b96. (an integer).

(Contributed by Antoine Pitrou in bpo-8850(3), bpo-1589(4), bpo-8322(5),
bpo-5639(6), bpo-4870(7), bpo-8484(8), and bpo-8321(9).)

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2818.html

   (2) 
https://www.openssl.org/docs/manmaster/man1/ciphers.html#CIPHER-LIST-FORMAT

   (3) https://bugs.python.org/issue8850

   (4) https://bugs.python.org/issue1589

   (5) https://bugs.python.org/issue8322

   (6) https://bugs.python.org/issue5639

   (7) https://bugs.python.org/issue4870

   (8) https://bugs.python.org/issue8484

   (9) https://bugs.python.org/issue8321


File: python.info,  Node: nntp,  Next: certificates,  Prev: ssl<9>,  Up: New Improved and Deprecated Modules

1.7.9.29 nntp
.............

The *note nntplib: c0. module has a revamped implementation with better
bytes and text semantics as well as more practical APIs.  These
improvements break compatibility with the nntplib version in Python 3.1,
which was partly dysfunctional in itself.

Support for secure connections through both implicit (using *note
nntplib.NNTP_SSL: b98.) and explicit (using *note
nntplib.NNTP.starttls(): b99.) TLS has also been added.

(Contributed by Antoine Pitrou in bpo-9360(1) and Andrew Vant in
bpo-1926(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9360

   (2) https://bugs.python.org/issue1926


File: python.info,  Node: certificates,  Next: imaplib<3>,  Prev: nntp,  Up: New Improved and Deprecated Modules

1.7.9.30 certificates
.....................

*note http.client.HTTPSConnection: 388, *note
urllib.request.HTTPSHandler: b9b. and *note urllib.request.urlopen():
780. now take optional arguments to allow for server certificate
checking against a set of Certificate Authorities, as recommended in
public uses of HTTPS.

(Added by Antoine Pitrou, bpo-9003(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9003


File: python.info,  Node: imaplib<3>,  Next: http client<4>,  Prev: certificates,  Up: New Improved and Deprecated Modules

1.7.9.31 imaplib
................

Support for explicit TLS on standard IMAP4 connections has been added
through the new *note imaplib.IMAP4.starttls: b9d. method.

(Contributed by Lorenzo M. Catucci and Antoine Pitrou, bpo-4471(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4471


File: python.info,  Node: http client<4>,  Next: unittest<6>,  Prev: imaplib<3>,  Up: New Improved and Deprecated Modules

1.7.9.32 http.client
....................

There were a number of small API improvements in the *note http.client:
94. module.  The old-style HTTP 0.9 simple responses are no longer
supported and the `strict' parameter is deprecated in all classes.

The *note HTTPConnection: 387. and *note HTTPSConnection: 388. classes
now have a `source_address' parameter for a (host, port) tuple
indicating where the HTTP connection is made from.

Support for certificate checking and HTTPS virtual hosts were added to
*note HTTPSConnection: 388.

The *note request(): 544. method on connection objects allowed an
optional `body' argument so that a *note file object: b35. could be used
to supply the content of the request.  Conveniently, the `body' argument
now also accepts an *note iterable: b9f. object so long as it includes
an explicit ‘Content-Length’ header.  This extended interface is much
more flexible than before.

To establish an HTTPS connection through a proxy server, there is a new
*note set_tunnel(): ba0. method that sets the host and port for HTTP
Connect tunneling.

To match the behavior of *note http.server: 97, the HTTP client library
now also encodes headers with ISO-8859-1 (Latin-1) encoding.  It was
already doing that for incoming headers, so now the behavior is
consistent for both incoming and outgoing traffic.  (See work by Armin
Ronacher in bpo-10980(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10980


File: python.info,  Node: unittest<6>,  Next: random<2>,  Prev: http client<4>,  Up: New Improved and Deprecated Modules

1.7.9.33 unittest
.................

The unittest module has a number of improvements supporting test
discovery for packages, easier experimentation at the interactive
prompt, new testcase methods, improved diagnostic messages for test
failures, and better method names.

   * The command-line call ‘python -m unittest’ can now accept file
     paths instead of module names for running specific tests
     (bpo-10620(1)).  The new test discovery can find tests within
     packages, locating any test importable from the top-level
     directory.  The top-level directory can be specified with the ‘-t’
     option, a pattern for matching files with ‘-p’, and a directory to
     start discovery with ‘-s’:

          $ python -m unittest discover -s my_proj_dir -p _test.py

     (Contributed by Michael Foord.)

   * Experimentation at the interactive prompt is now easier because the
     ‘unittest.case.TestCase’ class can now be instantiated without
     arguments:

          >>> from unittest import TestCase
          >>> TestCase().assertEqual(pow(2, 3), 8)

     (Contributed by Michael Foord.)

   * The *note unittest: 11b. module has two new methods, *note
     assertWarns(): ab1. and *note assertWarnsRegex(): ab2. to verify
     that a given warning type is triggered by the code under test:

          with self.assertWarns(DeprecationWarning):
              legacy_function('XYZ')

     (Contributed by Antoine Pitrou, bpo-9754(2).)

     Another new method, *note assertCountEqual(): ba2. is used to
     compare two iterables to determine if their element counts are
     equal (whether the same elements are present with the same number
     of occurrences regardless of order):

          def test_anagram(self):
              self.assertCountEqual('algorithm', 'logarithm')

     (Contributed by Raymond Hettinger.)

   * A principal feature of the unittest module is an effort to produce
     meaningful diagnostics when a test fails.  When possible, the
     failure is recorded along with a diff of the output.  This is
     especially helpful for analyzing log files of failed test runs.
     However, since diffs can sometime be voluminous, there is a new
     *note maxDiff: ba3. attribute that sets maximum length of diffs
     displayed.

   * In addition, the method names in the module have undergone a number
     of clean-ups.

     For example, *note assertRegex(): ba4. is the new name for
     ‘assertRegexpMatches()’ which was misnamed because the test uses
     *note re.search(): ba5, not *note re.match(): ba6.  Other methods
     using regular expressions are now named using short form “Regex” in
     preference to “Regexp” – this matches the names used in other
     unittest implementations, matches Python’s old name for the *note
     re: dd. module, and it has unambiguous camel-casing.

     (Contributed by Raymond Hettinger and implemented by Ezio Melotti.)

   * To improve consistency, some long-standing method aliases are being
     deprecated in favor of the preferred names:

          Old Name                            Preferred Name
                                              
          -----------------------------------------------------------------------
                                              
          ‘assert_()’                         *note assertTrue(): ba7.
                                              
                                              
          ‘assertEquals()’                    *note assertEqual(): ba8.
                                              
                                              
          ‘assertNotEquals()’                 *note assertNotEqual(): ba9.
                                              
                                              
          ‘assertAlmostEquals()’              *note assertAlmostEqual(): baa.
                                              
                                              
          ‘assertNotAlmostEquals()’           *note assertNotAlmostEqual(): bab.
                                              

     Likewise, the ‘TestCase.fail*’ methods deprecated in Python 3.1 are
     expected to be removed in Python 3.3.  Also see the *note
     Deprecated aliases: bac. section in the *note unittest: 11b.
     documentation.

     (Contributed by Ezio Melotti; bpo-9424(3).)

   * The ‘assertDictContainsSubset()’ method was deprecated because it
     was misimplemented with the arguments in the wrong order.  This
     created hard-to-debug optical illusions where tests like
     ‘TestCase().assertDictContainsSubset({'a':1, 'b':2}, {'a':1})’
     would fail.

     (Contributed by Raymond Hettinger.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10620

   (2) https://bugs.python.org/issue9754

   (3) https://bugs.python.org/issue9424


File: python.info,  Node: random<2>,  Next: poplib<3>,  Prev: unittest<6>,  Up: New Improved and Deprecated Modules

1.7.9.34 random
...............

The integer methods in the *note random: dc. module now do a better job
of producing uniform distributions.  Previously, they computed
selections with ‘int(n*random())’ which had a slight bias whenever `n'
was not a power of two.  Now, multiple selections are made from a range
up to the next power of two and a selection is kept only when it falls
within the range ‘0 <= x < n’.  The functions and methods affected are
*note randrange(): bae, *note randint(): baf, *note choice(): bb0, *note
shuffle(): bb1. and *note sample(): bb2.

(Contributed by Raymond Hettinger; bpo-9025(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9025


File: python.info,  Node: poplib<3>,  Next: asyncore<2>,  Prev: random<2>,  Up: New Improved and Deprecated Modules

1.7.9.35 poplib
...............

*note POP3_SSL: bb4. class now accepts a `context' parameter, which is a
*note ssl.SSLContext: 3d9. object allowing bundling SSL configuration
options, certificates and private keys into a single (potentially
long-lived) structure.

(Contributed by Giampaolo Rodolà; bpo-8807(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8807


File: python.info,  Node: asyncore<2>,  Next: tempfile<2>,  Prev: poplib<3>,  Up: New Improved and Deprecated Modules

1.7.9.36 asyncore
.................

*note asyncore.dispatcher: bb6. now provides a *note handle_accepted():
bb7. method returning a ‘(sock, addr)’ pair which is called when a
connection has actually been established with a new remote endpoint.
This is supposed to be used as a replacement for old *note
handle_accept(): bb8. and avoids the user to call *note accept(): bb9.
directly.

(Contributed by Giampaolo Rodolà; bpo-6706(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6706


File: python.info,  Node: tempfile<2>,  Next: inspect<6>,  Prev: asyncore<2>,  Up: New Improved and Deprecated Modules

1.7.9.37 tempfile
.................

The *note tempfile: 103. module has a new context manager, *note
TemporaryDirectory: bbb. which provides easy deterministic cleanup of
temporary directories:

     with tempfile.TemporaryDirectory() as tmpdirname:
         print('created temporary dir:', tmpdirname)

(Contributed by Neil Schemenauer and Nick Coghlan; bpo-5178(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5178


File: python.info,  Node: inspect<6>,  Next: pydoc<5>,  Prev: tempfile<2>,  Up: New Improved and Deprecated Modules

1.7.9.38 inspect
................

   * The *note inspect: a0. module has a new function *note
     getgeneratorstate(): bbd. to easily identify the current state of a
     generator-iterator:

          >>> from inspect import getgeneratorstate
          >>> def gen():
          ...     yield 'demo'
          >>> g = gen()
          >>> getgeneratorstate(g)
          'GEN_CREATED'
          >>> next(g)
          'demo'
          >>> getgeneratorstate(g)
          'GEN_SUSPENDED'
          >>> next(g, None)
          >>> getgeneratorstate(g)
          'GEN_CLOSED'

     (Contributed by Rodolpho Eckhardt and Nick Coghlan, bpo-10220(1).)

   * To support lookups without the possibility of activating a dynamic
     attribute, the *note inspect: a0. module has a new function, *note
     getattr_static(): bbe.  Unlike *note hasattr(): 43c, this is a true
     read-only search, guaranteed not to change state while it is
     searching:

          >>> class A:
          ...     @property
          ...     def f(self):
          ...         print('Running')
          ...         return 10
          ...
          >>> a = A()
          >>> getattr(a, 'f')
          Running
          10
          >>> inspect.getattr_static(a, 'f')
          <property object at 0x1022bd788>

     (Contributed by Michael Foord.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10220


File: python.info,  Node: pydoc<5>,  Next: dis<3>,  Prev: inspect<6>,  Up: New Improved and Deprecated Modules

1.7.9.39 pydoc
..............

The *note pydoc: d9. module now provides a much-improved Web server
interface, as well as a new command-line option ‘-b’ to automatically
open a browser window to display that server:

     $ pydoc3.2 -b

(Contributed by Ron Adam; bpo-2001(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2001


File: python.info,  Node: dis<3>,  Next: dbm<6>,  Prev: pydoc<5>,  Up: New Improved and Deprecated Modules

1.7.9.40 dis
............

The *note dis: 38. module gained two new functions for inspecting code,
*note code_info(): bc1. and *note show_code(): 826.  Both provide
detailed code object information for the supplied function, method,
source code string or code object.  The former returns a string and the
latter prints it:

     >>> import dis, random
     >>> dis.show_code(random.choice)
     Name:              choice
     Filename:          /Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/random.py
     Argument count:    2
     Kw-only arguments: 0
     Number of locals:  3
     Stack size:        11
     Flags:             OPTIMIZED, NEWLOCALS, NOFREE
     Constants:
        0: 'Choose a random element from a non-empty sequence.'
        1: 'Cannot choose from an empty sequence'
     Names:
        0: _randbelow
        1: len
        2: ValueError
        3: IndexError
     Variable names:
        0: self
        1: seq
        2: i

In addition, the *note dis(): 379. function now accepts string arguments
so that the common idiom ‘dis(compile(s, '', 'eval'))’ can be shortened
to ‘dis(s)’:

     >>> dis('3*x+1 if x%2==1 else x//2')
       1           0 LOAD_NAME                0 (x)
                   3 LOAD_CONST               0 (2)
                   6 BINARY_MODULO
                   7 LOAD_CONST               1 (1)
                  10 COMPARE_OP               2 (==)
                  13 POP_JUMP_IF_FALSE       28
                  16 LOAD_CONST               2 (3)
                  19 LOAD_NAME                0 (x)
                  22 BINARY_MULTIPLY
                  23 LOAD_CONST               1 (1)
                  26 BINARY_ADD
                  27 RETURN_VALUE
             >>   28 LOAD_NAME                0 (x)
                  31 LOAD_CONST               0 (2)
                  34 BINARY_FLOOR_DIVIDE
                  35 RETURN_VALUE

Taken together, these improvements make it easier to explore how CPython
is implemented and to see for yourself what the language syntax does
under-the-hood.

(Contributed by Nick Coghlan in bpo-9147(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9147


File: python.info,  Node: dbm<6>,  Next: ctypes<2>,  Prev: dis<3>,  Up: New Improved and Deprecated Modules

1.7.9.41 dbm
............

All database modules now support the ‘get()’ and ‘setdefault()’ methods.

(Suggested by Ray Allen in bpo-9523(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9523


File: python.info,  Node: ctypes<2>,  Next: site<2>,  Prev: dbm<6>,  Up: New Improved and Deprecated Modules

1.7.9.42 ctypes
...............

A new type, *note ctypes.c_ssize_t: bc4. represents the C ‘ssize_t’
datatype.


File: python.info,  Node: site<2>,  Next: sysconfig<2>,  Prev: ctypes<2>,  Up: New Improved and Deprecated Modules

1.7.9.43 site
.............

The *note site: eb. module has three new functions useful for reporting
on the details of a given Python installation.

   * *note getsitepackages(): bc6. lists all global site-packages
     directories.

   * *note getuserbase(): bc7. reports on the user’s base directory
     where data can be stored.

   * *note getusersitepackages(): bc8. reveals the user-specific
     site-packages directory path.

     >>> import site
     >>> site.getsitepackages()
     ['/Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/site-packages',
      '/Library/Frameworks/Python.framework/Versions/3.2/lib/site-python',
      '/Library/Python/3.2/site-packages']
     >>> site.getuserbase()
     '/Users/raymondhettinger/Library/Python/3.2'
     >>> site.getusersitepackages()
     '/Users/raymondhettinger/Library/Python/3.2/lib/python/site-packages'

Conveniently, some of site’s functionality is accessible directly from
the command-line:

     $ python -m site --user-base
     /Users/raymondhettinger/.local
     $ python -m site --user-site
     /Users/raymondhettinger/.local/lib/python3.2/site-packages

(Contributed by Tarek Ziadé in bpo-6693(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6693


File: python.info,  Node: sysconfig<2>,  Next: pdb<5>,  Prev: site<2>,  Up: New Improved and Deprecated Modules

1.7.9.44 sysconfig
..................

The new *note sysconfig: fe. module makes it straightforward to discover
installation paths and configuration variables that vary across
platforms and installations.

The module offers access simple access functions for platform and
version information:

   * *note get_platform(): bca. returning values like `linux-i586' or
     `macosx-10.6-ppc'.

   * *note get_python_version(): bcb. returns a Python version string
     such as “3.2”.

It also provides access to the paths and variables corresponding to one
of seven named schemes used by *note distutils: 39.  Those include
`posix_prefix', `posix_home', `posix_user', `nt', `nt_user', `os2',
`os2_home':

   * *note get_paths(): bcc. makes a dictionary containing installation
     paths for the current installation scheme.

   * *note get_config_vars(): 959. returns a dictionary of platform
     specific variables.

There is also a convenient command-line interface:

     C:\Python32>python -m sysconfig
     Platform: "win32"
     Python version: "3.2"
     Current installation scheme: "nt"

     Paths:
             data = "C:\Python32"
             include = "C:\Python32\Include"
             platinclude = "C:\Python32\Include"
             platlib = "C:\Python32\Lib\site-packages"
             platstdlib = "C:\Python32\Lib"
             purelib = "C:\Python32\Lib\site-packages"
             scripts = "C:\Python32\Scripts"
             stdlib = "C:\Python32\Lib"

     Variables:
             BINDIR = "C:\Python32"
             BINLIBDEST = "C:\Python32\Lib"
             EXE = ".exe"
             INCLUDEPY = "C:\Python32\Include"
             LIBDEST = "C:\Python32\Lib"
             SO = ".pyd"
             VERSION = "32"
             abiflags = ""
             base = "C:\Python32"
             exec_prefix = "C:\Python32"
             platbase = "C:\Python32"
             prefix = "C:\Python32"
             projectbase = "C:\Python32"
             py_version = "3.2"
             py_version_nodot = "32"
             py_version_short = "3.2"
             srcdir = "C:\Python32"
             userbase = "C:\Documents and Settings\Raymond\Application Data\Python"

(Moved out of Distutils by Tarek Ziadé.)


File: python.info,  Node: pdb<5>,  Next: configparser<2>,  Prev: sysconfig<2>,  Up: New Improved and Deprecated Modules

1.7.9.45 pdb
............

The *note pdb: c9. debugger module gained a number of usability
improvements:

   * ‘pdb.py’ now has a ‘-c’ option that executes commands as given in a
     ‘.pdbrc’ script file.

   * A ‘.pdbrc’ script file can contain ‘continue’ and ‘next’ commands
     that continue debugging.

   * The ‘Pdb’ class constructor now accepts a `nosigint' argument.

   * New commands: ‘l(list)’, ‘ll(long list)’ and ‘source’ for listing
     source code.

   * New commands: ‘display’ and ‘undisplay’ for showing or hiding the
     value of an expression if it has changed.

   * New command: ‘interact’ for starting an interactive interpreter
     containing the global and local names found in the current scope.

   * Breakpoints can be cleared by breakpoint number.

(Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.)


File: python.info,  Node: configparser<2>,  Next: urllib parse<2>,  Prev: pdb<5>,  Up: New Improved and Deprecated Modules

1.7.9.46 configparser
.....................

The *note configparser: 23. module was modified to improve usability and
predictability of the default parser and its supported INI syntax.  The
old ‘ConfigParser’ class was removed in favor of ‘SafeConfigParser’
which has in turn been renamed to *note ConfigParser: 4a0.  Support for
inline comments is now turned off by default and section or option
duplicates are not allowed in a single configuration source.

Config parsers gained a new API based on the mapping protocol:

     >>> parser = ConfigParser()
     >>> parser.read_string("""
     ... [DEFAULT]
     ... location = upper left
     ... visible = yes
     ... editable = no
     ... color = blue
     ...
     ... [main]
     ... title = Main Menu
     ... color = green
     ...
     ... [options]
     ... title = Options
     ... """)
     >>> parser['main']['color']
     'green'
     >>> parser['main']['editable']
     'no'
     >>> section = parser['options']
     >>> section['title']
     'Options'
     >>> section['title'] = 'Options (editable: %(editable)s)'
     >>> section['title']
     'Options (editable: no)'

The new API is implemented on top of the classical API, so custom parser
subclasses should be able to use it without modifications.

The INI file structure accepted by config parsers can now be customized.
Users can specify alternative option/value delimiters and comment
prefixes, change the name of the `DEFAULT' section or switch the
interpolation syntax.

There is support for pluggable interpolation including an additional
interpolation handler *note ExtendedInterpolation: bcf.:

     >>> parser = ConfigParser(interpolation=ExtendedInterpolation())
     >>> parser.read_dict({'buildout': {'directory': '/home/ambv/zope9'},
     ...                   'custom': {'prefix': '/usr/local'}})
     >>> parser.read_string("""
     ... [buildout]
     ... parts =
     ...   zope9
     ...   instance
     ... find-links =
     ...   ${buildout:directory}/downloads/dist
     ...
     ... [zope9]
     ... recipe = plone.recipe.zope9install
     ... location = /opt/zope
     ...
     ... [instance]
     ... recipe = plone.recipe.zope9instance
     ... zope9-location = ${zope9:location}
     ... zope-conf = ${custom:prefix}/etc/zope.conf
     ... """)
     >>> parser['buildout']['find-links']
     '\n/home/ambv/zope9/downloads/dist'
     >>> parser['instance']['zope-conf']
     '/usr/local/etc/zope.conf'
     >>> instance = parser['instance']
     >>> instance['zope-conf']
     '/usr/local/etc/zope.conf'
     >>> instance['zope9-location']
     '/opt/zope'

A number of smaller features were also introduced, like support for
specifying encoding in read operations, specifying fallback values for
get-functions, or reading directly from dictionaries and strings.

(All changes contributed by Łukasz Langa.)


File: python.info,  Node: urllib parse<2>,  Next: mailbox,  Prev: configparser<2>,  Up: New Improved and Deprecated Modules

1.7.9.47 urllib.parse
.....................

A number of usability improvements were made for the *note urllib.parse:
11f. module.

The *note urlparse(): 5ef. function now supports IPv6(1) addresses as
described in RFC 2732(2):

     >>> import urllib.parse
     >>> urllib.parse.urlparse('http://[dead:beef:cafe:5417:affe:8FA3:deaf:feed]/foo/') # doctest: +NORMALIZE_WHITESPACE
     ParseResult(scheme='http',
                 netloc='[dead:beef:cafe:5417:affe:8FA3:deaf:feed]',
                 path='/foo/',
                 params='',
                 query='',
                 fragment='')

The *note urldefrag(): bd1. function now returns a *note named tuple:
a98.:

     >>> r = urllib.parse.urldefrag('http://python.org/about/#target')
     >>> r
     DefragResult(url='http://python.org/about/', fragment='target')
     >>> r[0]
     'http://python.org/about/'
     >>> r.fragment
     'target'

And, the *note urlencode(): 77f. function is now much more flexible,
accepting either a string or bytes type for the `query' argument.  If it
is a string, then the `safe', `encoding', and `error' parameters are
sent to *note quote_plus(): bd2. for encoding:

     >>> urllib.parse.urlencode([
     ...      ('type', 'telenovela'),
     ...      ('name', '¿Dónde Está Elisa?')],
     ...      encoding='latin-1')
     'type=telenovela&name=%BFD%F3nde+Est%E1+Elisa%3F'

As detailed in *note Parsing ASCII Encoded Bytes: bd3, all the *note
urllib.parse: 11f. functions now accept ASCII-encoded byte strings as
input, so long as they are not mixed with regular strings.  If
ASCII-encoded byte strings are given as parameters, the return types
will also be an ASCII-encoded byte strings:

     >>> urllib.parse.urlparse(b'http://www.python.org:80/about/') # doctest: +NORMALIZE_WHITESPACE
     ParseResultBytes(scheme=b'http', netloc=b'www.python.org:80',
                      path=b'/about/', params=b'', query=b'', fragment=b'')

(Work by Nick Coghlan, Dan Mahn, and Senthil Kumaran in bpo-2987(3),
bpo-5468(4), and bpo-9873(5).)

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/IPv6

   (2) https://tools.ietf.org/html/rfc2732.html

   (3) https://bugs.python.org/issue2987

   (4) https://bugs.python.org/issue5468

   (5) https://bugs.python.org/issue9873


File: python.info,  Node: mailbox,  Next: turtledemo,  Prev: urllib parse<2>,  Up: New Improved and Deprecated Modules

1.7.9.48 mailbox
................

Thanks to a concerted effort by R. David Murray, the *note mailbox: ae.
module has been fixed for Python 3.2.  The challenge was that mailbox
had been originally designed with a text interface, but email messages
are best represented with *note bytes: 326. because various parts of a
message may have different encodings.

The solution harnessed the *note email: 69. package’s binary support for
parsing arbitrary email messages.  In addition, the solution required a
number of API changes.

As expected, the *note add(): bd5. method for *note mailbox.Mailbox:
bd6. objects now accepts binary input.

*note StringIO: 821. and text file input are deprecated.  Also, string
input will fail early if non-ASCII characters are used.  Previously it
would fail when the email was processed in a later step.

There is also support for binary output.  The *note get_file(): bd7.
method now returns a file in the binary mode (where it used to
incorrectly set the file to text-mode).  There is also a new *note
get_bytes(): bd8. method that returns a *note bytes: 326. representation
of a message corresponding to a given `key'.

It is still possible to get non-binary output using the old API’s *note
get_string(): bd9. method, but that approach is not very useful.
Instead, it is best to extract messages from a *note Message: bda.
object or to load them from binary input.

(Contributed by R. David Murray, with efforts from Steffen Daode
Nurpmeso and an initial patch by Victor Stinner in bpo-9124(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue9124


File: python.info,  Node: turtledemo,  Prev: mailbox,  Up: New Improved and Deprecated Modules

1.7.9.49 turtledemo
...................

The demonstration code for the *note turtle: 116. module was moved from
the `Demo' directory to main library.  It includes over a dozen sample
scripts with lively displays.  Being on *note sys.path: 47d, it can now
be run directly from the command-line:

     $ python -m turtledemo

(Moved from the Demo directory by Alexander Belopolsky in bpo-10199(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10199


File: python.info,  Node: Multi-threading,  Next: Optimizations<6>,  Prev: New Improved and Deprecated Modules,  Up: What’s New In Python 3 2

1.7.10 Multi-threading
----------------------

   * The mechanism for serializing execution of concurrently running
     Python threads (generally known as the *note GIL: bdd. or *note
     Global Interpreter Lock: 4fb.) has been rewritten.  Among the
     objectives were more predictable switching intervals and reduced
     overhead due to lock contention and the number of ensuing system
     calls.  The notion of a “check interval” to allow thread switches
     has been abandoned and replaced by an absolute duration expressed
     in seconds.  This parameter is tunable through *note
     sys.setswitchinterval(): bde.  It currently defaults to 5
     milliseconds.

     Additional details about the implementation can be read from a
     python-dev mailing-list message(1) (however, “priority requests” as
     exposed in this message have not been kept for inclusion).

     (Contributed by Antoine Pitrou.)

   * Regular and recursive locks now accept an optional `timeout'
     argument to their *note acquire(): 760. method.  (Contributed by
     Antoine Pitrou; bpo-7316(2).)

   * Similarly, *note threading.Semaphore.acquire(): bdf. also gained a
     `timeout' argument.  (Contributed by Torsten Landschoff;
     bpo-850728(3).)

   * Regular and recursive lock acquisitions can now be interrupted by
     signals on platforms using Pthreads.  This means that Python
     programs that deadlock while acquiring locks can be successfully
     killed by repeatedly sending SIGINT to the process (by pressing
     ‘Ctrl+C’ in most shells).  (Contributed by Reid Kleckner;
     bpo-8844(4).)

   ---------- Footnotes ----------

   (1) 
https://mail.python.org/pipermail/python-dev/2009-October/093321.html

   (2) https://bugs.python.org/issue7316

   (3) https://bugs.python.org/issue850728

   (4) https://bugs.python.org/issue8844


File: python.info,  Node: Optimizations<6>,  Next: Unicode,  Prev: Multi-threading,  Up: What’s New In Python 3 2

1.7.11 Optimizations
--------------------

A number of small performance enhancements have been added:

   * Python’s peephole optimizer now recognizes patterns such ‘x in {1,
     2, 3}’ as being a test for membership in a set of constants.  The
     optimizer recasts the *note set: b62. as a *note frozenset: be1.
     and stores the pre-built constant.

     Now that the speed penalty is gone, it is practical to start
     writing membership tests using set-notation.  This style is both
     semantically clear and operationally fast:

          extension = name.rpartition('.')[2]
          if extension in {'xml', 'html', 'xhtml', 'css'}:
              handle(name)

     (Patch and additional tests contributed by Dave Malcolm;
     bpo-6690(1)).

   * Serializing and unserializing data using the *note pickle: ca.
     module is now several times faster.

     (Contributed by Alexandre Vassalotti, Antoine Pitrou and the
     Unladen Swallow team in bpo-9410(2) and bpo-3873(3).)

   * The Timsort algorithm(4) used in *note list.sort(): 43a. and *note
     sorted(): 439. now runs faster and uses less memory when called
     with a *note key function: 6d4.  Previously, every element of a
     list was wrapped with a temporary object that remembered the key
     value associated with each element.  Now, two arrays of keys and
     values are sorted in parallel.  This saves the memory consumed by
     the sort wrappers, and it saves time lost to delegating
     comparisons.

     (Patch by Daniel Stutzbach in bpo-9915(5).)

   * JSON decoding performance is improved and memory consumption is
     reduced whenever the same string is repeated for multiple keys.
     Also, JSON encoding now uses the C speedups when the ‘sort_keys’
     argument is true.

     (Contributed by Antoine Pitrou in bpo-7451(6) and by Raymond
     Hettinger and Antoine Pitrou in bpo-10314(7).)

   * Recursive locks (created with the *note threading.RLock(): be2.
     API) now benefit from a C implementation which makes them as fast
     as regular locks, and between 10x and 15x faster than their
     previous pure Python implementation.

     (Contributed by Antoine Pitrou; bpo-3001(8).)

   * The fast-search algorithm in stringlib is now used by the
     ‘split()’, ‘rsplit()’, ‘splitlines()’ and ‘replace()’ methods on
     *note bytes: 326, *note bytearray: 327. and *note str: 325.
     objects.  Likewise, the algorithm is also used by ‘rfind()’,
     ‘rindex()’, ‘rsplit()’ and ‘rpartition()’.

     (Patch by Florent Xicluna in bpo-7622(9) and bpo-7462(10).)

   * Integer to string conversions now work two “digits” at a time,
     reducing the number of division and modulo operations.

     (bpo-6713(11) by Gawain Bolton, Mark Dickinson, and Victor
     Stinner.)

There were several other minor optimizations.  Set differencing now runs
faster when one operand is much larger than the other (patch by Andress
Bennetts in bpo-8685(12)).  The ‘array.repeat()’ method has a faster
implementation (bpo-1569291(13) by Alexander Belopolsky).  The
‘BaseHTTPRequestHandler’ has more efficient buffering (bpo-3709(14) by
Andrew Schaaf).  The *note operator.attrgetter(): 70f. function has been
sped-up (bpo-10160(15) by Christos Georgiou).  And ‘ConfigParser’ loads
multi-line arguments a bit faster (bpo-7113(16) by Łukasz Langa).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6690

   (2) https://bugs.python.org/issue9410

   (3) https://bugs.python.org/issue3873

   (4) https://en.wikipedia.org/wiki/Timsort

   (5) https://bugs.python.org/issue9915

   (6) https://bugs.python.org/issue7451

   (7) https://bugs.python.org/issue10314

   (8) https://bugs.python.org/issue3001

   (9) https://bugs.python.org/issue7622

   (10) https://bugs.python.org/issue7462

   (11) https://bugs.python.org/issue6713

   (12) https://bugs.python.org/issue8685

   (13) https://bugs.python.org/issue1569291

   (14) https://bugs.python.org/issue3709

   (15) https://bugs.python.org/issue10160

   (16) https://bugs.python.org/issue7113


File: python.info,  Node: Unicode,  Next: Codecs,  Prev: Optimizations<6>,  Up: What’s New In Python 3 2

1.7.12 Unicode
--------------

Python has been updated to Unicode 6.0.0(1).  The update to the standard
adds over 2,000 new characters including emoji(2) symbols which are
important for mobile phones.

In addition, the updated standard has altered the character properties
for two Kannada characters (U+0CF1, U+0CF2) and one New Tai Lue numeric
character (U+19DA), making the former eligible for use in identifiers
while disqualifying the latter.  For more information, see Unicode
Character Database Changes(3).

   ---------- Footnotes ----------

   (1) http://unicode.org/versions/Unicode6.0.0/

   (2) https://en.wikipedia.org/wiki/Emoji

   (3) http://www.unicode.org/versions/Unicode6.0.0/#Database_Changes


File: python.info,  Node: Codecs,  Next: Documentation,  Prev: Unicode,  Up: What’s New In Python 3 2

1.7.13 Codecs
-------------

Support was added for `cp720' Arabic DOS encoding (bpo-1616979(1)).

MBCS encoding no longer ignores the error handler argument.  In the
default strict mode, it raises an *note UnicodeDecodeError: 1fb. when it
encounters an undecodable byte sequence and an *note UnicodeEncodeError:
1fa. for an unencodable character.

The MBCS codec supports ‘'strict'’ and ‘'ignore'’ error handlers for
decoding, and ‘'strict'’ and ‘'replace'’ for encoding.

To emulate Python3.1 MBCS encoding, select the ‘'ignore'’ handler for
decoding and the ‘'replace'’ handler for encoding.

On Mac OS X, Python decodes command line arguments with ‘'utf-8'’ rather
than the locale encoding.

By default, *note tarfile: 101. uses ‘'utf-8'’ encoding on Windows
(instead of ‘'mbcs'’) and the ‘'surrogateescape'’ error handler on all
operating systems.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1616979


File: python.info,  Node: Documentation,  Next: IDLE,  Prev: Codecs,  Up: What’s New In Python 3 2

1.7.14 Documentation
--------------------

The documentation continues to be improved.

   * A table of quick links has been added to the top of lengthy
     sections such as *note Built-in Functions: be6.  In the case of
     *note itertools: a3, the links are accompanied by tables of
     cheatsheet-style summaries to provide an overview and memory jog
     without having to read all of the docs.

   * In some cases, the pure Python source code can be a helpful adjunct
     to the documentation, so now many modules now feature quick links
     to the latest version of the source code.  For example, the *note
     functools: 85. module documentation has a quick link at the top
     labeled:

          `Source code' Lib/functools.py(1).

     (Contributed by Raymond Hettinger; see rationale(2).)

   * The docs now contain more examples and recipes.  In particular,
     *note re: dd. module has an extensive section, *note Regular
     Expression Examples: be7.  Likewise, the *note itertools: a3.
     module continues to be updated with new *note Itertools Recipes:
     be8.

   * The *note datetime: 31. module now has an auxiliary implementation
     in pure Python.  No functionality was changed.  This just provides
     an easier-to-read alternate implementation.

     (Contributed by Alexander Belopolsky in bpo-9528(3).)

   * The unmaintained ‘Demo’ directory has been removed.  Some demos
     were integrated into the documentation, some were moved to the
     ‘Tools/demo’ directory, and others were removed altogether.

     (Contributed by Georg Brandl in bpo-7962(4).)

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/functools.py

   (2) 
https://rhettinger.wordpress.com/2011/01/28/open-your-source-more/

   (3) https://bugs.python.org/issue9528

   (4) https://bugs.python.org/issue7962


File: python.info,  Node: IDLE,  Next: Code Repository,  Prev: Documentation,  Up: What’s New In Python 3 2

1.7.15 IDLE
-----------

   * The format menu now has an option to clean source files by
     stripping trailing whitespace.

     (Contributed by Raymond Hettinger; bpo-5150(1).)

   * IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa
     AquaTk.

     (Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren;
     bpo-6075(2).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5150

   (2) https://bugs.python.org/issue6075


File: python.info,  Node: Code Repository,  Next: Build and C API Changes<5>,  Prev: IDLE,  Up: What’s New In Python 3 2

1.7.16 Code Repository
----------------------

In addition to the existing Subversion code repository at
‘http://svn.python.org’ there is now a Mercurial(1) repository at
‘https://hg.python.org/’.

After the 3.2 release, there are plans to switch to Mercurial as the
primary repository.  This distributed version control system should make
it easier for members of the community to create and share external
changesets.  See PEP 385(2) for details.

To learn to use the new version control system, see the Quick Start(3)
or the Guide to Mercurial Workflows(4).

   ---------- Footnotes ----------

   (1) https://www.mercurial-scm.org/

   (2) https://www.python.org/dev/peps/pep-0385

   (3) https://www.mercurial-scm.org/wiki/QuickStart

   (4) https://www.mercurial-scm.org/guide


File: python.info,  Node: Build and C API Changes<5>,  Next: Porting to Python 3 2,  Prev: Code Repository,  Up: What’s New In Python 3 2

1.7.17 Build and C API Changes
------------------------------

Changes to Python’s build process and to the C API include:

   * The `idle', `pydoc' and `2to3' scripts are now installed with a
     version-specific suffix on ‘make altinstall’ (bpo-10679(1)).

   * The C functions that access the Unicode Database now accept and
     return characters from the full Unicode range, even on narrow
     unicode builds (Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and
     others).  A visible difference in Python is that *note
     unicodedata.numeric(): bec. now returns the correct value for large
     code points, and *note repr(): 7c0. may consider more characters as
     printable.

     (Reported by Bupjoe Lee and fixed by Amaury Forgeot D’Arc;
     bpo-5127(2).)

   * Computed gotos are now enabled by default on supported compilers
     (which are detected by the configure script).  They can still be
     disabled selectively by specifying ‘--without-computed-gotos’.

     (Contributed by Antoine Pitrou; bpo-9203(3).)

   * The option ‘--with-wctype-functions’ was removed.  The built-in
     unicode database is now used for all functions.

     (Contributed by Amaury Forgeot D’Arc; bpo-9210(4).)

   * Hash values are now values of a new type, ‘Py_hash_t’, which is
     defined to be the same size as a pointer.  Previously they were of
     type long, which on some 64-bit operating systems is still only 32
     bits long.  As a result of this fix, *note set: b62. and *note
     dict: 1b6. can now hold more than ‘2**32’ entries on builds with
     64-bit pointers (previously, they could grow to that size but their
     performance degraded catastrophically).

     (Suggested by Raymond Hettinger and implemented by Benjamin
     Peterson; bpo-9778(5).)

   * A new macro ‘Py_VA_COPY’ copies the state of the variable argument
     list.  It is equivalent to C99 `va_copy' but available on all
     Python platforms (bpo-2443(6)).

   * A new C API function *note PySys_SetArgvEx(): bed. allows an
     embedded interpreter to set *note sys.argv: bee. without also
     modifying *note sys.path: 47d. (bpo-5753(7)).

   * ‘PyEval_CallObject’ is now only available in macro form.  The
     function declaration, which was kept for backwards compatibility
     reasons, is now removed – the macro was introduced in 1997
     (bpo-8276(8)).

   * There is a new function *note PyLong_AsLongLongAndOverflow(): bef.
     which is analogous to *note PyLong_AsLongAndOverflow(): bf0.  They
     both serve to convert Python *note int: 184. into a native
     fixed-width type while providing detection of cases where the
     conversion won’t fit (bpo-7767(9)).

   * The *note PyUnicode_CompareWithASCIIString(): bf1. function now
     returns `not equal' if the Python string is `NUL' terminated.

   * There is a new function *note PyErr_NewExceptionWithDoc(): bf2.
     that is like *note PyErr_NewException(): bf3. but allows a
     docstring to be specified.  This lets C exceptions have the same
     self-documenting capabilities as their pure Python counterparts
     (bpo-7033(10)).

   * When compiled with the ‘--with-valgrind’ option, the pymalloc
     allocator will be automatically disabled when running under
     Valgrind.  This gives improved memory leak detection when running
     under Valgrind, while taking advantage of pymalloc at other times
     (bpo-2422(11)).

   * Removed the ‘O?’ format from the `PyArg_Parse' functions.  The
     format is no longer used and it had never been documented
     (bpo-8837(12)).

There were a number of other small changes to the C-API. See the
Misc/NEWS(13) file for a complete list.

Also, there were a number of updates to the Mac OS X build, see
Mac/BuildScript/README.txt(14) for details.  For users running a
32/64-bit build, there is a known problem with the default Tcl/Tk on Mac
OS X 10.6.  Accordingly, we recommend installing an updated alternative
such as ActiveState Tcl/Tk 8.5.9(15).  See
‘https://www.python.org/download/mac/tcltk/’ for additional details.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10679

   (2) https://bugs.python.org/issue5127

   (3) https://bugs.python.org/issue9203

   (4) https://bugs.python.org/issue9210

   (5) https://bugs.python.org/issue9778

   (6) https://bugs.python.org/issue2443

   (7) https://bugs.python.org/issue5753

   (8) https://bugs.python.org/issue8276

   (9) https://bugs.python.org/issue7767

   (10) https://bugs.python.org/issue7033

   (11) https://bugs.python.org/issue2422

   (12) https://bugs.python.org/issue8837

   (13) https://github.com/python/cpython/tree/3.8/Misc/NEWS

   (14) 
https://github.com/python/cpython/tree/3.8/Mac/BuildScript/README.txt

   (15) https://www.activestate.com/activetcl/downloads


File: python.info,  Node: Porting to Python 3 2,  Prev: Build and C API Changes<5>,  Up: What’s New In Python 3 2

1.7.18 Porting to Python 3.2
----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code:

   * The *note configparser: 23. module has a number of clean-ups.  The
     major change is to replace the old ‘ConfigParser’ class with
     long-standing preferred alternative ‘SafeConfigParser’.  In
     addition there are a number of smaller incompatibilities:

        * The interpolation syntax is now validated on *note get(): bf5.
          and *note set(): bf6. operations.  In the default
          interpolation scheme, only two tokens with percent signs are
          valid: ‘%(name)s’ and ‘%%’, the latter being an escaped
          percent sign.

        * The *note set(): bf6. and *note add_section(): bf7. methods
          now verify that values are actual strings.  Formerly,
          unsupported types could be introduced unintentionally.

        * Duplicate sections or options from a single source now raise
          either *note DuplicateSectionError: bf8. or *note
          DuplicateOptionError: bf9.  Formerly, duplicates would
          silently overwrite a previous entry.

        * Inline comments are now disabled by default so now the `;'
          character can be safely used in values.

        * Comments now can be indented.  Consequently, for `;' or `#' to
          appear at the start of a line in multiline values, it has to
          be interpolated.  This keeps comment prefix characters in
          values from being mistaken as comments.

        * ‘""’ is now a valid value and is no longer automatically
          converted to an empty string.  For empty strings, use ‘"option
          ="’ in a line.

   * The *note nntplib: c0. module was reworked extensively, meaning
     that its APIs are often incompatible with the 3.1 APIs.

   * *note bytearray: 327. objects can no longer be used as filenames;
     instead, they should be converted to *note bytes: 326.

   * The ‘array.tostring()’ and ‘array.fromstring()’ have been renamed
     to ‘array.tobytes()’ and ‘array.frombytes()’ for clarity.  The old
     names have been deprecated.  (See bpo-8990(1).)

   * ‘PyArg_Parse*()’ functions:

        * “t#” format has been removed: use “s#” or “s*” instead

        * “w” and “w#” formats has been removed: use “w*” instead

   * The ‘PyCObject’ type, deprecated in 3.1, has been removed.  To wrap
     opaque C pointers in Python objects, the *note PyCapsule: bfa. API
     should be used instead; the new type has a well-defined interface
     for passing typing safety information and a less complicated
     signature for calling a destructor.

   * The ‘sys.setfilesystemencoding()’ function was removed because it
     had a flawed design.

   * The *note random.seed(): bfb. function and method now salt string
     seeds with an sha512 hash function.  To access the previous version
     of `seed' in order to reproduce Python 3.1 sequences, set the
     `version' argument to `1', ‘random.seed(s, version=1)’.

   * The previously deprecated ‘string.maketrans()’ function has been
     removed in favor of the static methods *note bytes.maketrans():
     bfc. and *note bytearray.maketrans(): bfd.  This change solves the
     confusion around which types were supported by the *note string:
     f6. module.  Now, *note str: 325, *note bytes: 326, and *note
     bytearray: 327. each have their own `maketrans' and `translate'
     methods with intermediate translation tables of the appropriate
     type.

     (Contributed by Georg Brandl; bpo-5675(2).)

   * The previously deprecated ‘contextlib.nested()’ function has been
     removed in favor of a plain *note with: 6dd. statement which can
     accept multiple context managers.  The latter technique is faster
     (because it is built-in), and it does a better job finalizing
     multiple context managers when one of them raises an exception:

          with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
              for line in infile:
                  if '<critical>' in line:
                      outfile.write(line)

     (Contributed by Georg Brandl and Mattias Brändström; appspot issue
     53094(3).)

   * *note struct.pack(): bfe. now only allows bytes for the ‘s’ string
     pack code.  Formerly, it would accept text arguments and implicitly
     encode them to bytes using UTF-8.  This was problematic because it
     made assumptions about the correct encoding and because a
     variable-length encoding can fail when writing to fixed length
     segment of a structure.

     Code such as ‘struct.pack('<6sHHBBB', 'GIF87a', x, y)’ should be
     rewritten with to use bytes instead of text,
     ‘struct.pack('<6sHHBBB', b'GIF87a', x, y)’.

     (Discovered by David Beazley and fixed by Victor Stinner;
     bpo-10783(4).)

   * The *note xml.etree.ElementTree: 137. class now raises an *note
     xml.etree.ElementTree.ParseError: bff. when a parse fails.
     Previously it raised an *note xml.parsers.expat.ExpatError: c00.

   * The new, longer *note str(): 325. value on floats may break
     doctests which rely on the old output format.

   * In *note subprocess.Popen: 2b7, the default value for `close_fds'
     is now ‘True’ under Unix; under Windows, it is ‘True’ if the three
     standard streams are set to ‘None’, ‘False’ otherwise.  Previously,
     `close_fds' was always ‘False’ by default, which produced difficult
     to solve bugs or race conditions when open file descriptors would
     leak into the child process.

   * Support for legacy HTTP 0.9 has been removed from *note
     urllib.request: 120. and *note http.client: 94.  Such support is
     still present on the server side (in *note http.server: 97.).

     (Contributed by Antoine Pitrou, bpo-10711(5).)

   * SSL sockets in timeout mode now raise *note socket.timeout: c01.
     when a timeout occurs, rather than a generic *note SSLError: c02.

     (Contributed by Antoine Pitrou, bpo-10272(6).)

   * The misleading functions *note PyEval_AcquireLock(): 2b0. and *note
     PyEval_ReleaseLock(): c03. have been officially deprecated.  The
     thread-state aware APIs (such as *note PyEval_SaveThread(): c04.
     and *note PyEval_RestoreThread(): 2b2.) should be used instead.

   * Due to security risks, ‘asyncore.handle_accept()’ has been
     deprecated, and a new function, ‘asyncore.handle_accepted()’, was
     added to replace it.

     (Contributed by Giampaolo Rodola in bpo-6706(7).)

   * Due to the new *note GIL: bdd. implementation, *note
     PyEval_InitThreads(): c05. cannot be called before *note
     Py_Initialize(): 42e. anymore.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8990

   (2) https://bugs.python.org/issue5675

   (3) https://codereview.appspot.com/53094

   (4) https://bugs.python.org/issue10783

   (5) https://bugs.python.org/issue10711

   (6) https://bugs.python.org/issue10272

   (7) https://bugs.python.org/issue6706


File: python.info,  Node: What’s New In Python 3 1,  Next: What’s New In Python 3 0,  Prev: What’s New In Python 3 2,  Up: What’s New in Python

1.8 What’s New In Python 3.1
============================


Author: Raymond Hettinger

This article explains the new features in Python 3.1, compared to 3.0.

* Menu:

* PEP 372; Ordered Dictionaries: PEP 372 Ordered Dictionaries.
* PEP 378; Format Specifier for Thousands Separator: PEP 378 Format Specifier for Thousands Separator.
* Other Language Changes: Other Language Changes<8>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules<2>.
* Optimizations: Optimizations<7>.
* IDLE: IDLE<2>.
* Build and C API Changes: Build and C API Changes<6>.
* Porting to Python 3.1: Porting to Python 3 1.


File: python.info,  Node: PEP 372 Ordered Dictionaries,  Next: PEP 378 Format Specifier for Thousands Separator,  Up: What’s New In Python 3 1

1.8.1 PEP 372: Ordered Dictionaries
-----------------------------------

Regular Python dictionaries iterate over key/value pairs in arbitrary
order.  Over the years, a number of authors have written alternative
implementations that remember the order that the keys were originally
inserted.  Based on the experiences from those implementations, a new
*note collections.OrderedDict: 1b7. class has been introduced.

The OrderedDict API is substantially the same as regular dictionaries
but will iterate over keys and values in a guaranteed order depending on
when a key was first inserted.  If a new entry overwrites an existing
entry, the original insertion position is left unchanged.  Deleting an
entry and reinserting it will move it to the end.

The standard library now supports use of ordered dictionaries in several
modules.  The *note configparser: 23. module uses them by default.  This
lets configuration files be read, modified, and then written back in
their original order.  The `_asdict()' method for *note
collections.namedtuple(): 1b5. now returns an ordered dictionary with
the values appearing in the same order as the underlying tuple indices.
The *note json: a4. module is being built-out with an
`object_pairs_hook' to allow OrderedDicts to be built by the decoder.
Support was also added for third-party tools like PyYAML(1).

See also
........

PEP 372(2) - Ordered Dictionaries

     PEP written by Armin Ronacher and Raymond Hettinger.
     Implementation written by Raymond Hettinger.

   ---------- Footnotes ----------

   (1) http://pyyaml.org/

   (2) https://www.python.org/dev/peps/pep-0372


File: python.info,  Node: PEP 378 Format Specifier for Thousands Separator,  Next: Other Language Changes<8>,  Prev: PEP 372 Ordered Dictionaries,  Up: What’s New In Python 3 1

1.8.2 PEP 378: Format Specifier for Thousands Separator
-------------------------------------------------------

The built-in *note format(): 4d0. function and the *note str.format():
4cf. method use a mini-language that now includes a simple, non-locale
aware way to format a number with a thousands separator.  That provides
a way to humanize a program’s output, improving its professional
appearance and readability:

     >>> format(1234567, ',d')
     '1,234,567'
     >>> format(1234567.89, ',.2f')
     '1,234,567.89'
     >>> format(12345.6 + 8901234.12j, ',f')
     '12,345.600000+8,901,234.120000j'
     >>> format(Decimal('1234567.89'), ',f')
     '1,234,567.89'

The supported types are *note int: 184, *note float: 187, *note complex:
189. and *note decimal.Decimal: 188.

Discussions are underway about how to specify alternative separators
like dots, spaces, apostrophes, or underscores.  Locale-aware
applications should use the existing `n' format specifier which already
has some support for thousands separators.

See also
........

PEP 378(1) - Format Specifier for Thousands Separator

     PEP written by Raymond Hettinger and implemented by Eric Smith and
     Mark Dickinson.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0378


File: python.info,  Node: Other Language Changes<8>,  Next: New Improved and Deprecated Modules<2>,  Prev: PEP 378 Format Specifier for Thousands Separator,  Up: What’s New In Python 3 1

1.8.3 Other Language Changes
----------------------------

Some smaller changes made to the core Python language are:

   * Directories and zip archives containing a ‘__main__.py’ file can
     now be executed directly by passing their name to the interpreter.
     The directory/zipfile is automatically inserted as the first entry
     in sys.path.  (Suggestion and initial patch by Andy Chu; revised
     patch by Phillip J. Eby and Nick Coghlan; bpo-1739468(1).)

   * The *note int(): 184. type gained a ‘bit_length’ method that
     returns the number of bits necessary to represent its argument in
     binary:

          >>> n = 37
          >>> bin(37)
          '0b100101'
          >>> n.bit_length()
          6
          >>> n = 2**123-1
          >>> n.bit_length()
          123
          >>> (n+1).bit_length()
          124

     (Contributed by Fredrik Johansson, Victor Stinner, Raymond
     Hettinger, and Mark Dickinson; bpo-3439(2).)

   * The fields in *note format(): 4d0. strings can now be automatically
     numbered:

          >>> 'Sir {} of {}'.format('Gallahad', 'Camelot')
          'Sir Gallahad of Camelot'

     Formerly, the string would have required numbered fields such as:
     ‘'Sir {0} of {1}'’.

     (Contributed by Eric Smith; bpo-5237(3).)

   * The ‘string.maketrans()’ function is deprecated and is replaced by
     new static methods, *note bytes.maketrans(): bfc. and *note
     bytearray.maketrans(): bfd.  This change solves the confusion
     around which types were supported by the *note string: f6. module.
     Now, *note str: 325, *note bytes: 326, and *note bytearray: 327.
     each have their own `maketrans' and `translate' methods with
     intermediate translation tables of the appropriate type.

     (Contributed by Georg Brandl; bpo-5675(4).)

   * The syntax of the *note with: 6dd. statement now allows multiple
     context managers in a single statement:

          >>> with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
          ...     for line in infile:
          ...         if '<critical>' in line:
          ...             outfile.write(line)

     With the new syntax, the ‘contextlib.nested()’ function is no
     longer needed and is now deprecated.

     (Contributed by Georg Brandl and Mattias Brändström; appspot issue
     53094(5).)

   * ‘round(x, n)’ now returns an integer if `x' is an integer.
     Previously it returned a float:

          >>> round(1123, -2)
          1100

     (Contributed by Mark Dickinson; bpo-4707(6).)

   * Python now uses David Gay’s algorithm for finding the shortest
     floating point representation that doesn’t change its value.  This
     should help mitigate some of the confusion surrounding binary
     floating point numbers.

     The significance is easily seen with a number like ‘1.1’ which does
     not have an exact equivalent in binary floating point.  Since there
     is no exact equivalent, an expression like ‘float('1.1')’ evaluates
     to the nearest representable value which is ‘0x1.199999999999ap+0’
     in hex or ‘1.100000000000000088817841970012523233890533447265625’
     in decimal.  That nearest value was and still is used in subsequent
     floating point calculations.

     What is new is how the number gets displayed.  Formerly, Python
     used a simple approach.  The value of ‘repr(1.1)’ was computed as
     ‘format(1.1, '.17g')’ which evaluated to ‘'1.1000000000000001'’.
     The advantage of using 17 digits was that it relied on IEEE-754
     guarantees to assure that ‘eval(repr(1.1))’ would round-trip
     exactly to its original value.  The disadvantage is that many
     people found the output to be confusing (mistaking intrinsic
     limitations of binary floating point representation as being a
     problem with Python itself).

     The new algorithm for ‘repr(1.1)’ is smarter and returns ‘'1.1'’.
     Effectively, it searches all equivalent string representations
     (ones that get stored with the same underlying float value) and
     returns the shortest representation.

     The new algorithm tends to emit cleaner representations when
     possible, but it does not change the underlying values.  So, it is
     still the case that ‘1.1 + 2.2 != 3.3’ even though the
     representations may suggest otherwise.

     The new algorithm depends on certain features in the underlying
     floating point implementation.  If the required features are not
     found, the old algorithm will continue to be used.  Also, the text
     pickle protocols assure cross-platform portability by using the old
     algorithm.

     (Contributed by Eric Smith and Mark Dickinson; bpo-1580(7))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1739468

   (2) https://bugs.python.org/issue3439

   (3) https://bugs.python.org/issue5237

   (4) https://bugs.python.org/issue5675

   (5) https://codereview.appspot.com/53094

   (6) https://bugs.python.org/issue4707

   (7) https://bugs.python.org/issue1580


File: python.info,  Node: New Improved and Deprecated Modules<2>,  Next: Optimizations<7>,  Prev: Other Language Changes<8>,  Up: What’s New In Python 3 1

1.8.4 New, Improved, and Deprecated Modules
-------------------------------------------

   * Added a *note collections.Counter: 9ce. class to support convenient
     counting of unique items in a sequence or iterable:

          >>> Counter(['red', 'blue', 'red', 'green', 'blue', 'blue'])
          Counter({'blue': 3, 'red': 2, 'green': 1})

     (Contributed by Raymond Hettinger; bpo-1696199(1).)

   * Added a new module, *note tkinter.ttk: 10f. for access to the Tk
     themed widget set.  The basic idea of ttk is to separate, to the
     extent possible, the code implementing a widget’s behavior from the
     code implementing its appearance.

     (Contributed by Guilherme Polo; bpo-2983(2).)

   * The *note gzip.GzipFile: 6d1. and *note bz2.BZ2File: 925. classes
     now support the context management protocol:

          >>> # Automatically close file after writing
          >>> with gzip.GzipFile(filename, "wb") as f:
          ...     f.write(b"xxx")

     (Contributed by Antoine Pitrou.)

   * The *note decimal: 36. module now supports methods for creating a
     decimal object from a binary *note float: 187.  The conversion is
     exact but can sometimes be surprising:

          >>> Decimal.from_float(1.1)
          Decimal('1.100000000000000088817841970012523233890533447265625')

     The long decimal result shows the actual binary fraction being
     stored for `1.1'.  The fraction has many digits because `1.1'
     cannot be exactly represented in binary.

     (Contributed by Raymond Hettinger and Mark Dickinson.)

   * The *note itertools: a3. module grew two new functions.  The *note
     itertools.combinations_with_replacement(): c0c. function is one of
     four for generating combinatorics including permutations and
     Cartesian products.  The *note itertools.compress(): c0d. function
     mimics its namesake from APL. Also, the existing *note
     itertools.count(): c0e. function now has an optional `step'
     argument and can accept any type of counting sequence including
     *note fractions.Fraction: 185. and *note decimal.Decimal: 188.:

          >>> [p+q for p,q in combinations_with_replacement('LOVE', 2)]
          ['LL', 'LO', 'LV', 'LE', 'OO', 'OV', 'OE', 'VV', 'VE', 'EE']

          >>> list(compress(data=range(10), selectors=[0,0,1,1,0,1,0,1,0,0]))
          [2, 3, 5, 7]

          >>> c = count(start=Fraction(1,2), step=Fraction(1,6))
          >>> [next(c), next(c), next(c), next(c)]
          [Fraction(1, 2), Fraction(2, 3), Fraction(5, 6), Fraction(1, 1)]

     (Contributed by Raymond Hettinger.)

   * *note collections.namedtuple(): 1b5. now supports a keyword
     argument `rename' which lets invalid fieldnames be automatically
     converted to positional names in the form _0, _1, etc.  This is
     useful when the field names are being created by an external source
     such as a CSV header, SQL field list, or user input:

          >>> query = input()
          SELECT region, dept, count(*) FROM main GROUPBY region, dept

          >>> cursor.execute(query)
          >>> query_fields = [desc[0] for desc in cursor.description]
          >>> UserQuery = namedtuple('UserQuery', query_fields, rename=True)
          >>> pprint.pprint([UserQuery(*row) for row in cursor])
          [UserQuery(region='South', dept='Shipping', _2=185),
           UserQuery(region='North', dept='Accounting', _2=37),
           UserQuery(region='West', dept='Sales', _2=419)]

     (Contributed by Raymond Hettinger; bpo-1818(3).)

   * The *note re.sub(): 470, *note re.subn(): 728. and *note
     re.split(): 3bf. functions now accept a flags parameter.

     (Contributed by Gregory Smith.)

   * The *note logging: aa. module now implements a simple *note
     logging.NullHandler: c0f. class for applications that are not using
     logging but are calling library code that does.  Setting-up a null
     handler will suppress spurious warnings such as “No handlers could
     be found for logger foo”:

          >>> h = logging.NullHandler()
          >>> logging.getLogger("foo").addHandler(h)

     (Contributed by Vinay Sajip; bpo-4384(4)).

   * The *note runpy: e2. module which supports the ‘-m’ command line
     switch now supports the execution of packages by looking for and
     executing a ‘__main__’ submodule when a package name is supplied.

     (Contributed by Andi Vajda; bpo-4195(5).)

   * The *note pdb: c9. module can now access and display source code
     loaded via *note zipimport: 143. (or any other conformant PEP
     302(6) loader).

     (Contributed by Alexander Belopolsky; bpo-4201(7).)

   * *note functools.partial: 7bc. objects can now be pickled.

     (Suggested by Antoine Pitrou and Jesse Noller.  Implemented by Jack
     Diederich; bpo-5228(8).)

   * Add *note pydoc: d9. help topics for symbols so that ‘help('@')’
     works as expected in the interactive environment.

     (Contributed by David Laban; bpo-4739(9).)

   * The *note unittest: 11b. module now supports skipping individual
     tests or classes of tests.  And it supports marking a test as an
     expected failure, a test that is known to be broken, but shouldn’t
     be counted as a failure on a TestResult:

          class TestGizmo(unittest.TestCase):

              @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
              def test_gizmo_on_windows(self):
                  ...

              @unittest.expectedFailure
              def test_gimzo_without_required_library(self):
                  ...

     Also, tests for exceptions have been builtout to work with context
     managers using the *note with: 6dd. statement:

          def test_division_by_zero(self):
              with self.assertRaises(ZeroDivisionError):
                  x / 0

     In addition, several new assertion methods were added including
     ‘assertSetEqual()’, ‘assertDictEqual()’,
     ‘assertDictContainsSubset()’, ‘assertListEqual()’,
     ‘assertTupleEqual()’, ‘assertSequenceEqual()’,
     ‘assertRaisesRegexp()’, ‘assertIsNone()’, and ‘assertIsNotNone()’.

     (Contributed by Benjamin Peterson and Antoine Pitrou.)

   * The *note io: a1. module has three new constants for the ‘seek()’
     method ‘SEEK_SET’, ‘SEEK_CUR’, and ‘SEEK_END’.

   * The *note sys.version_info: b0d. tuple is now a named tuple:

          >>> sys.version_info
          sys.version_info(major=3, minor=1, micro=0, releaselevel='alpha', serial=2)

     (Contributed by Ross Light; bpo-4285(10).)

   * The *note nntplib: c0. and *note imaplib: 98. modules now support
     IPv6.

     (Contributed by Derek Morr; bpo-1655(11) and bpo-1664(12).)

   * The *note pickle: ca. module has been adapted for better
     interoperability with Python 2.x when used with protocol 2 or
     lower.  The reorganization of the standard library changed the
     formal reference for many objects.  For example, ‘__builtin__.set’
     in Python 2 is called ‘builtins.set’ in Python 3.  This change
     confounded efforts to share data between different versions of
     Python.  But now when protocol 2 or lower is selected, the pickler
     will automatically use the old Python 2 names for both loading and
     dumping.  This remapping is turned-on by default but can be
     disabled with the `fix_imports' option:

          >>> s = {1, 2, 3}
          >>> pickle.dumps(s, protocol=0)
          b'c__builtin__\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'
          >>> pickle.dumps(s, protocol=0, fix_imports=False)
          b'cbuiltins\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'

     An unfortunate but unavoidable side-effect of this change is that
     protocol 2 pickles produced by Python 3.1 won’t be readable with
     Python 3.0.  The latest pickle protocol, protocol 3, should be used
     when migrating data between Python 3.x implementations, as it
     doesn’t attempt to remain compatible with Python 2.x.

     (Contributed by Alexandre Vassalotti and Antoine Pitrou,
     bpo-6137(13).)

   * A new module, *note importlib: 9b. was added.  It provides a
     complete, portable, pure Python reference implementation of the
     *note import: c10. statement and its counterpart, the *note
     __import__(): 605. function.  It represents a substantial step
     forward in documenting and defining the actions that take place
     during imports.

     (Contributed by Brett Cannon.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1696199

   (2) https://bugs.python.org/issue2983

   (3) https://bugs.python.org/issue1818

   (4) https://bugs.python.org/issue4384

   (5) https://bugs.python.org/issue4195

   (6) https://www.python.org/dev/peps/pep-0302

   (7) https://bugs.python.org/issue4201

   (8) https://bugs.python.org/issue5228

   (9) https://bugs.python.org/issue4739

   (10) https://bugs.python.org/issue4285

   (11) https://bugs.python.org/issue1655

   (12) https://bugs.python.org/issue1664

   (13) https://bugs.python.org/issue6137


File: python.info,  Node: Optimizations<7>,  Next: IDLE<2>,  Prev: New Improved and Deprecated Modules<2>,  Up: What’s New In Python 3 1

1.8.5 Optimizations
-------------------

Major performance enhancements have been added:

   * The new I/O library (as defined in PEP 3116(1)) was mostly written
     in Python and quickly proved to be a problematic bottleneck in
     Python 3.0.  In Python 3.1, the I/O library has been entirely
     rewritten in C and is 2 to 20 times faster depending on the task at
     hand.  The pure Python version is still available for
     experimentation purposes through the ‘_pyio’ module.

     (Contributed by Amaury Forgeot d’Arc and Antoine Pitrou.)

   * Added a heuristic so that tuples and dicts containing only
     untrackable objects are not tracked by the garbage collector.  This
     can reduce the size of collections and therefore the garbage
     collection overhead on long-running programs, depending on their
     particular use of datatypes.

     (Contributed by Antoine Pitrou, bpo-4688(2).)

   * Enabling a configure option named ‘--with-computed-gotos’ on
     compilers that support it (notably: gcc, SunPro, icc), the bytecode
     evaluation loop is compiled with a new dispatch mechanism which
     gives speedups of up to 20%, depending on the system, the compiler,
     and the benchmark.

     (Contributed by Antoine Pitrou along with a number of other
     participants, bpo-4753(3)).

   * The decoding of UTF-8, UTF-16 and LATIN-1 is now two to four times
     faster.

     (Contributed by Antoine Pitrou and Amaury Forgeot d’Arc,
     bpo-4868(4).)

   * The *note json: a4. module now has a C extension to substantially
     improve its performance.  In addition, the API was modified so that
     json works only with *note str: 325, not with *note bytes: 326.
     That change makes the module closely match the JSON
     specification(5) which is defined in terms of Unicode.

     (Contributed by Bob Ippolito and converted to Py3.1 by Antoine
     Pitrou and Benjamin Peterson; bpo-4136(6).)

   * Unpickling now interns the attribute names of pickled objects.
     This saves memory and allows pickles to be smaller.

     (Contributed by Jake McGuire and Antoine Pitrou; bpo-5084(7).)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3116

   (2) https://bugs.python.org/issue4688

   (3) https://bugs.python.org/issue4753

   (4) https://bugs.python.org/issue4868

   (5) http://json.org/

   (6) https://bugs.python.org/issue4136

   (7) https://bugs.python.org/issue5084


File: python.info,  Node: IDLE<2>,  Next: Build and C API Changes<6>,  Prev: Optimizations<7>,  Up: What’s New In Python 3 1

1.8.6 IDLE
----------

   * IDLE’s format menu now provides an option to strip trailing
     whitespace from a source file.

     (Contributed by Roger D. Serwy; bpo-5150(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5150


File: python.info,  Node: Build and C API Changes<6>,  Next: Porting to Python 3 1,  Prev: IDLE<2>,  Up: What’s New In Python 3 1

1.8.7 Build and C API Changes
-----------------------------

Changes to Python’s build process and to the C API include:

   * Integers are now stored internally either in base 2**15 or in base
     2**30, the base being determined at build time.  Previously, they
     were always stored in base 2**15.  Using base 2**30 gives
     significant performance improvements on 64-bit machines, but
     benchmark results on 32-bit machines have been mixed.  Therefore,
     the default is to use base 2**30 on 64-bit machines and base 2**15
     on 32-bit machines; on Unix, there’s a new configure option
     ‘--enable-big-digits’ that can be used to override this default.

     Apart from the performance improvements this change should be
     invisible to end users, with one exception: for testing and
     debugging purposes there’s a new *note sys.int_info: c14. that
     provides information about the internal format, giving the number
     of bits per digit and the size in bytes of the C type used to store
     each digit:

          >>> import sys
          >>> sys.int_info
          sys.int_info(bits_per_digit=30, sizeof_digit=4)

     (Contributed by Mark Dickinson; bpo-4258(1).)

   * The *note PyLong_AsUnsignedLongLong(): c15. function now handles a
     negative `pylong' by raising *note OverflowError: 954. instead of
     *note TypeError: 192.

     (Contributed by Mark Dickinson and Lisandro Dalcrin; bpo-5175(2).)

   * Deprecated ‘PyNumber_Int()’.  Use *note PyNumber_Long(): 26a.
     instead.

     (Contributed by Mark Dickinson; bpo-4910(3).)

   * Added a new *note PyOS_string_to_double(): c16. function to replace
     the deprecated functions ‘PyOS_ascii_strtod()’ and
     ‘PyOS_ascii_atof()’.

     (Contributed by Mark Dickinson; bpo-5914(4).)

   * Added *note PyCapsule: bfa. as a replacement for the ‘PyCObject’
     API. The principal difference is that the new type has a well
     defined interface for passing typing safety information and a less
     complicated signature for calling a destructor.  The old type had a
     problematic API and is now deprecated.

     (Contributed by Larry Hastings; bpo-5630(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4258

   (2) https://bugs.python.org/issue5175

   (3) https://bugs.python.org/issue4910

   (4) https://bugs.python.org/issue5914

   (5) https://bugs.python.org/issue5630


File: python.info,  Node: Porting to Python 3 1,  Prev: Build and C API Changes<6>,  Up: What’s New In Python 3 1

1.8.8 Porting to Python 3.1
---------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code:

   * The new floating point string representations can break existing
     doctests.  For example:

          def e():
              '''Compute the base of natural logarithms.

              >>> e()
              2.7182818284590451

              '''
              return sum(1/math.factorial(x) for x in reversed(range(30)))

          doctest.testmod()

          **********************************************************************
          Failed example:
              e()
          Expected:
              2.7182818284590451
          Got:
              2.718281828459045
          **********************************************************************

   * The automatic name remapping in the pickle module for protocol 2 or
     lower can make Python 3.1 pickles unreadable in Python 3.0.  One
     solution is to use protocol 3.  Another solution is to set the
     `fix_imports' option to ‘False’.  See the discussion above for more
     details.


File: python.info,  Node: What’s New In Python 3 0,  Next: What’s New in Python 2 7,  Prev: What’s New In Python 3 1,  Up: What’s New in Python

1.9 What’s New In Python 3.0
============================


Author: Guido van Rossum

This article explains the new features in Python 3.0, compared to 2.6.
Python 3.0, also known as “Python 3000” or “Py3K”, is the first ever
`intentionally backwards incompatible' Python release.  There are more
changes than in a typical release, and more that are important for all
Python users.  Nevertheless, after digesting the changes, you’ll find
that Python really hasn’t changed all that much – by and large, we’re
mostly fixing well-known annoyances and warts, and removing a lot of old
cruft.

This article doesn’t attempt to provide a complete specification of all
new features, but instead tries to give a convenient overview.  For full
details, you should refer to the documentation for Python 3.0, and/or
the many PEPs referenced in the text.  If you want to understand the
complete implementation and design rationale for a particular feature,
PEPs usually have more details than the regular documentation; but note
that PEPs usually are not kept up-to-date once a feature has been fully
implemented.

Due to time constraints this document is not as complete as it should
have been.  As always for a new release, the ‘Misc/NEWS’ file in the
source distribution contains a wealth of detailed information about
every small thing that was changed.

* Menu:

* Common Stumbling Blocks::
* Overview Of Syntax Changes::
* Changes Already Present In Python 2.6: Changes Already Present In Python 2 6.
* Library Changes::
* PEP 3101; A New Approach To String Formatting: PEP 3101 A New Approach To String Formatting.
* Changes To Exceptions::
* Miscellaneous Other Changes::
* Build and C API Changes: Build and C API Changes<7>.
* Performance::
* Porting To Python 3.0: Porting To Python 3 0.


File: python.info,  Node: Common Stumbling Blocks,  Next: Overview Of Syntax Changes,  Up: What’s New In Python 3 0

1.9.1 Common Stumbling Blocks
-----------------------------

This section lists those few changes that are most likely to trip you up
if you’re used to Python 2.5.

* Menu:

* Print Is A Function::
* Views And Iterators Instead Of Lists::
* Ordering Comparisons::
* Integers::
* Text Vs. Data Instead Of Unicode Vs. 8-bit: Text Vs Data Instead Of Unicode Vs 8-bit.


File: python.info,  Node: Print Is A Function,  Next: Views And Iterators Instead Of Lists,  Up: Common Stumbling Blocks

1.9.1.1 Print Is A Function
...........................

The ‘print’ statement has been replaced with a *note print(): 87a.
function, with keyword arguments to replace most of the special syntax
of the old ‘print’ statement ( PEP 3105(1)).  Examples:

     Old: print "The answer is", 2*2
     New: print("The answer is", 2*2)

     Old: print x,           # Trailing comma suppresses newline
     New: print(x, end=" ")  # Appends a space instead of a newline

     Old: print              # Prints a newline
     New: print()            # You must call the function!

     Old: print >>sys.stderr, "fatal error"
     New: print("fatal error", file=sys.stderr)

     Old: print (x, y)       # prints repr((x, y))
     New: print((x, y))      # Not the same as print(x, y)!

You can also customize the separator between items, e.g.:

     print("There are <", 2**32, "> possibilities!", sep="")

which produces:

     There are <4294967296> possibilities!

Note:

   * The *note print(): 87a. function doesn’t support the “softspace”
     feature of the old ‘print’ statement.  For example, in Python 2.x,
     ‘print "A\n", "B"’ would write ‘"A\nB\n"’; but in Python 3.0,
     ‘print("A\n", "B")’ writes ‘"A\n B\n"’.

   * Initially, you’ll be finding yourself typing the old ‘print x’ a
     lot in interactive mode.  Time to retrain your fingers to type
     ‘print(x)’ instead!

   * When using the ‘2to3’ source-to-source conversion tool, all ‘print’
     statements are automatically converted to *note print(): 87a.
     function calls, so this is mostly a non-issue for larger projects.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3105


File: python.info,  Node: Views And Iterators Instead Of Lists,  Next: Ordering Comparisons,  Prev: Print Is A Function,  Up: Common Stumbling Blocks

1.9.1.2 Views And Iterators Instead Of Lists
............................................

Some well-known APIs no longer return lists:

   * *note dict: 1b6. methods *note dict.keys(): c1d, *note
     dict.items(): c1e. and *note dict.values(): c1f. return “views”
     instead of lists.  For example, this no longer works: ‘k =
     d.keys(); k.sort()’.  Use ‘k = sorted(d)’ instead (this works in
     Python 2.5 too and is just as efficient).

   * Also, the ‘dict.iterkeys()’, ‘dict.iteritems()’ and
     ‘dict.itervalues()’ methods are no longer supported.

   * *note map(): c20. and *note filter(): c21. return iterators.  If
     you really need a list and the input sequences are all of equal
     length, a quick fix is to wrap *note map(): c20. in *note list():
     260, e.g.  ‘list(map(...))’, but a better fix is often to use a
     list comprehension (especially when the original code uses *note
     lambda: c22.), or rewriting the code so it doesn’t need a list at
     all.  Particularly tricky is *note map(): c20. invoked for the side
     effects of the function; the correct transformation is to use a
     regular *note for: c23. loop (since creating a list would just be
     wasteful).

     If the input sequences are not of equal length, *note map(): c20.
     will stop at the termination of the shortest of the sequences.  For
     full compatibility with *note map(): c20. from Python 2.x, also
     wrap the sequences in *note itertools.zip_longest(): c24, e.g.
     ‘map(func, *sequences)’ becomes ‘list(map(func,
     itertools.zip_longest(*sequences)))’.

   * *note range(): 9b2. now behaves like ‘xrange()’ used to behave,
     except it works with values of arbitrary size.  The latter no
     longer exists.

   * *note zip(): c25. now returns an iterator.


File: python.info,  Node: Ordering Comparisons,  Next: Integers,  Prev: Views And Iterators Instead Of Lists,  Up: Common Stumbling Blocks

1.9.1.3 Ordering Comparisons
............................

Python 3.0 has simplified the rules for ordering comparisons:

   * The ordering comparison operators (‘<’, ‘<=’, ‘>=’, ‘>’) raise a
     TypeError exception when the operands don’t have a meaningful
     natural ordering.  Thus, expressions like ‘1 < ''’, ‘0 > None’ or
     ‘len <= len’ are no longer valid, and e.g.  ‘None < None’ raises
     *note TypeError: 192. instead of returning ‘False’.  A corollary is
     that sorting a heterogeneous list no longer makes sense – all the
     elements must be comparable to each other.  Note that this does not
     apply to the ‘==’ and ‘!=’ operators: objects of different
     incomparable types always compare unequal to each other.

   * ‘builtin.sorted()’ and *note list.sort(): 43a. no longer accept the
     `cmp' argument providing a comparison function.  Use the `key'
     argument instead.  N.B. the `key' and `reverse' arguments are now
     “keyword-only”.

   * The ‘cmp()’ function should be treated as gone, and the ‘__cmp__()’
     special method is no longer supported.  Use *note __lt__(): c27.
     for sorting, *note __eq__(): 334. with *note __hash__(): 335, and
     other rich comparisons as needed.  (If you really need the ‘cmp()’
     functionality, you could use the expression ‘(a > b) - (a < b)’ as
     the equivalent for ‘cmp(a, b)’.)


File: python.info,  Node: Integers,  Next: Text Vs Data Instead Of Unicode Vs 8-bit,  Prev: Ordering Comparisons,  Up: Common Stumbling Blocks

1.9.1.4 Integers
................

   * PEP 237(1): Essentially, ‘long’ renamed to *note int: 184.  That
     is, there is only one built-in integral type, named *note int:
     184.; but it behaves mostly like the old ‘long’ type.

   * PEP 238(2): An expression like ‘1/2’ returns a float.  Use ‘1//2’
     to get the truncating behavior.  (The latter syntax has existed for
     years, at least since Python 2.2.)

   * The ‘sys.maxint’ constant was removed, since there is no longer a
     limit to the value of integers.  However, *note sys.maxsize: b36.
     can be used as an integer larger than any practical list or string
     index.  It conforms to the implementation’s “natural” integer size
     and is typically the same as ‘sys.maxint’ in previous releases on
     the same platform (assuming the same build options).

   * The *note repr(): 7c0. of a long integer doesn’t include the
     trailing ‘L’ anymore, so code that unconditionally strips that
     character will chop off the last digit instead.  (Use *note str():
     325. instead.)

   * Octal literals are no longer of the form ‘0720’; use ‘0o720’
     instead.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0237

   (2) https://www.python.org/dev/peps/pep-0238


File: python.info,  Node: Text Vs Data Instead Of Unicode Vs 8-bit,  Prev: Integers,  Up: Common Stumbling Blocks

1.9.1.5 Text Vs. Data Instead Of Unicode Vs. 8-bit
..................................................

Everything you thought you knew about binary data and Unicode has
changed.

   * Python 3.0 uses the concepts of `text' and (binary) `data' instead
     of Unicode strings and 8-bit strings.  All text is Unicode; however
     `encoded' Unicode is represented as binary data.  The type used to
     hold text is *note str: 325, the type used to hold data is *note
     bytes: 326.  The biggest difference with the 2.x situation is that
     any attempt to mix text and data in Python 3.0 raises *note
     TypeError: 192, whereas if you were to mix Unicode and 8-bit
     strings in Python 2.x, it would work if the 8-bit string happened
     to contain only 7-bit (ASCII) bytes, but you would get *note
     UnicodeDecodeError: 1fb. if it contained non-ASCII values.  This
     value-specific behavior has caused numerous sad faces over the
     years.

   * As a consequence of this change in philosophy, pretty much all code
     that uses Unicode, encodings or binary data most likely has to
     change.  The change is for the better, as in the 2.x world there
     were numerous bugs having to do with mixing encoded and unencoded
     text.  To be prepared in Python 2.x, start using ‘unicode’ for all
     unencoded text, and *note str: 325. for binary or encoded data
     only.  Then the ‘2to3’ tool will do most of the work for you.

   * You can no longer use ‘u"..."’ literals for Unicode text.  However,
     you must use ‘b"..."’ literals for binary data.

   * As the *note str: 325. and *note bytes: 326. types cannot be mixed,
     you must always explicitly convert between them.  Use *note
     str.encode(): c2a. to go from *note str: 325. to *note bytes: 326,
     and *note bytes.decode(): c2b. to go from *note bytes: 326. to
     *note str: 325.  You can also use ‘bytes(s, encoding=...)’ and
     ‘str(b, encoding=...)’, respectively.

   * Like *note str: 325, the *note bytes: 326. type is immutable.
     There is a separate `mutable' type to hold buffered binary data,
     *note bytearray: 327.  Nearly all APIs that accept *note bytes:
     326. also accept *note bytearray: 327.  The mutable API is based on
     ‘collections.MutableSequence’.

   * All backslashes in raw string literals are interpreted literally.
     This means that ‘'\U'’ and ‘'\u'’ escapes in raw strings are not
     treated specially.  For example, ‘r'\u20ac'’ is a string of 6
     characters in Python 3.0, whereas in 2.6, ‘ur'\u20ac'’ was the
     single “euro” character.  (Of course, this change only affects raw
     string literals; the euro character is ‘'\u20ac'’ in Python 3.0.)

   * The built-in ‘basestring’ abstract type was removed.  Use *note
     str: 325. instead.  The *note str: 325. and *note bytes: 326. types
     don’t have functionality enough in common to warrant a shared base
     class.  The ‘2to3’ tool (see below) replaces every occurrence of
     ‘basestring’ with *note str: 325.

   * Files opened as text files (still the default mode for *note
     open(): 4e5.) always use an encoding to map between strings (in
     memory) and bytes (on disk).  Binary files (opened with a ‘b’ in
     the mode argument) always use bytes in memory.  This means that if
     a file is opened using an incorrect mode or encoding, I/O will
     likely fail loudly, instead of silently producing incorrect data.
     It also means that even Unix users will have to specify the correct
     mode (text or binary) when opening a file.  There is a
     platform-dependent default encoding, which on Unixy platforms can
     be set with the ‘LANG’ environment variable (and sometimes also
     with some other platform-specific locale-related environment
     variables).  In many cases, but not all, the system default is
     UTF-8; you should never count on this default.  Any application
     reading or writing more than pure ASCII text should probably have a
     way to override the encoding.  There is no longer any need for
     using the encoding-aware streams in the *note codecs: 1c. module.

   * The initial values of *note sys.stdin: 302, *note sys.stdout: 303.
     and *note sys.stderr: 304. are now unicode-only text files (i.e.,
     they are instances of *note io.TextIOBase: c2c.).  To read and
     write bytes data with these streams, you need to use their *note
     io.TextIOBase.buffer: c2d. attribute.

   * Filenames are passed to and returned from APIs as (Unicode)
     strings.  This can present platform-specific problems because on
     some platforms filenames are arbitrary byte strings.  (On the other
     hand, on Windows filenames are natively stored as Unicode.)  As a
     work-around, most APIs (e.g.  *note open(): 4e5. and many functions
     in the *note os: c4. module) that take filenames accept *note
     bytes: 326. objects as well as strings, and a few APIs have a way
     to ask for a *note bytes: 326. return value.  Thus, *note
     os.listdir(): a36. returns a list of *note bytes: 326. instances if
     the argument is a *note bytes: 326. instance, and *note
     os.getcwdb(): 2b6. returns the current working directory as a *note
     bytes: 326. instance.  Note that when *note os.listdir(): a36.
     returns a list of strings, filenames that cannot be decoded
     properly are omitted rather than raising *note UnicodeError: c2e.

   * Some system APIs like *note os.environ: b2a. and *note sys.argv:
     bee. can also present problems when the bytes made available by the
     system is not interpretable using the default encoding.  Setting
     the ‘LANG’ variable and rerunning the program is probably the best
     approach.

   * PEP 3138(1): The *note repr(): 7c0. of a string no longer escapes
     non-ASCII characters.  It still escapes control characters and code
     points with non-printable status in the Unicode standard, however.

   * PEP 3120(2): The default source encoding is now UTF-8.

   * PEP 3131(3): Non-ASCII letters are now allowed in identifiers.
     (However, the standard library remains ASCII-only with the
     exception of contributor names in comments.)

   * The ‘StringIO’ and ‘cStringIO’ modules are gone.  Instead, import
     the *note io: a1. module and use *note io.StringIO: 821. or *note
     io.BytesIO: 78f. for text and data respectively.

   * See also the *note Unicode HOWTO: c2f, which was updated for Python
     3.0.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3138

   (2) https://www.python.org/dev/peps/pep-3120

   (3) https://www.python.org/dev/peps/pep-3131


File: python.info,  Node: Overview Of Syntax Changes,  Next: Changes Already Present In Python 2 6,  Prev: Common Stumbling Blocks,  Up: What’s New In Python 3 0

1.9.2 Overview Of Syntax Changes
--------------------------------

This section gives a brief overview of every `syntactic' change in
Python 3.0.

* Menu:

* New Syntax::
* Changed Syntax::
* Removed Syntax::


File: python.info,  Node: New Syntax,  Next: Changed Syntax,  Up: Overview Of Syntax Changes

1.9.2.1 New Syntax
..................

   * PEP 3107(1): Function argument and return value annotations.  This
     provides a standardized way of annotating a function’s parameters
     and return value.  There are no semantics attached to such
     annotations except that they can be introspected at runtime using
     the ‘__annotations__’ attribute.  The intent is to encourage
     experimentation through metaclasses, decorators or frameworks.

   * PEP 3102(2): Keyword-only arguments.  Named parameters occurring
     after ‘*args’ in the parameter list `must' be specified using
     keyword syntax in the call.  You can also use a bare ‘*’ in the
     parameter list to indicate that you don’t accept a variable-length
     argument list, but you do have keyword-only arguments.

   * Keyword arguments are allowed after the list of base classes in a
     class definition.  This is used by the new convention for
     specifying a metaclass (see next section), but can be used for
     other purposes as well, as long as the metaclass supports it.

   * PEP 3104(3): *note nonlocal: c32. statement.  Using ‘nonlocal x’
     you can now assign directly to a variable in an outer (but
     non-global) scope.  ‘nonlocal’ is a new reserved word.

   * PEP 3132(4): Extended Iterable Unpacking.  You can now write things
     like ‘a, b, *rest = some_sequence’.  And even ‘*rest, a = stuff’.
     The ‘rest’ object is always a (possibly empty) list; the right-hand
     side may be any iterable.  Example:

          (a, *rest, b) = range(5)

     This sets `a' to ‘0’, `b' to ‘4’, and `rest' to ‘[1, 2, 3]’.

   * Dictionary comprehensions: ‘{k: v for k, v in stuff}’ means the
     same thing as ‘dict(stuff)’ but is more flexible.  (This is PEP
     274(5) vindicated.  :-)

   * Set literals, e.g.  ‘{1, 2}’.  Note that ‘{}’ is an empty
     dictionary; use ‘set()’ for an empty set.  Set comprehensions are
     also supported; e.g., ‘{x for x in stuff}’ means the same thing as
     ‘set(stuff)’ but is more flexible.

   * New octal literals, e.g.  ‘0o720’ (already in 2.6).  The old octal
     literals (‘0720’) are gone.

   * New binary literals, e.g.  ‘0b1010’ (already in 2.6), and there is
     a new corresponding built-in function, *note bin(): c33.

   * Bytes literals are introduced with a leading ‘b’ or ‘B’, and there
     is a new corresponding built-in function, *note bytes(): 326.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3107

   (2) https://www.python.org/dev/peps/pep-3102

   (3) https://www.python.org/dev/peps/pep-3104

   (4) https://www.python.org/dev/peps/pep-3132

   (5) https://www.python.org/dev/peps/pep-0274


File: python.info,  Node: Changed Syntax,  Next: Removed Syntax,  Prev: New Syntax,  Up: Overview Of Syntax Changes

1.9.2.2 Changed Syntax
......................

   * PEP 3109(1) and PEP 3134(2): new *note raise: c35. statement
     syntax: ‘raise [`expr' [from `expr']]’.  See below.

   * ‘as’ and *note with: 6dd. are now reserved words.  (Since 2.6,
     actually.)

   * ‘True’, ‘False’, and ‘None’ are reserved words.  (2.6 partially
     enforced the restrictions on ‘None’ already.)

   * Change from *note except: b31. `exc', `var' to ‘except’ `exc' ‘as’
     `var'.  See PEP 3110(3).

   * PEP 3115(4): New Metaclass Syntax.  Instead of:

          class C:
              __metaclass__ = M
              ...

     you must now use:

          class C(metaclass=M):
              ...

     The module-global ‘__metaclass__’ variable is no longer supported.
     (It was a crutch to make it easier to default to new-style classes
     without deriving every class from *note object: 2ae.)

   * List comprehensions no longer support the syntactic form ‘[... for
     `var' in `item1', `item2', ...]’.  Use ‘[... for `var' in (`item1',
     `item2', ...)]’ instead.  Also note that list comprehensions have
     different semantics: they are closer to syntactic sugar for a
     generator expression inside a *note list(): 260. constructor, and
     in particular the loop control variables are no longer leaked into
     the surrounding scope.

   * The `ellipsis' (‘...’) can be used as an atomic expression
     anywhere.  (Previously it was only allowed in slices.)  Also, it
     `must' now be spelled as ‘...’.  (Previously it could also be
     spelled as ‘. . .’, by a mere accident of the grammar.)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3109

   (2) https://www.python.org/dev/peps/pep-3134

   (3) https://www.python.org/dev/peps/pep-3110

   (4) https://www.python.org/dev/peps/pep-3115


File: python.info,  Node: Removed Syntax,  Prev: Changed Syntax,  Up: Overview Of Syntax Changes

1.9.2.3 Removed Syntax
......................

   * PEP 3113(1): Tuple parameter unpacking removed.  You can no longer
     write ‘def foo(a, (b, c)): ...’.  Use ‘def foo(a, b_c): b, c = b_c’
     instead.

   * Removed backticks (use *note repr(): 7c0. instead).

   * Removed ‘<>’ (use ‘!=’ instead).

   * Removed keyword: *note exec(): c37. is no longer a keyword; it
     remains as a function.  (Fortunately the function syntax was also
     accepted in 2.x.)  Also note that *note exec(): c37. no longer
     takes a stream argument; instead of ‘exec(f)’ you can use
     ‘exec(f.read())’.

   * Integer literals no longer support a trailing ‘l’ or ‘L’.

   * String literals no longer support a leading ‘u’ or ‘U’.

   * The *note from: c38. `module' *note import: c10. ‘*’ syntax is only
     allowed at the module level, no longer inside functions.

   * The only acceptable syntax for relative imports is ‘from
     .[`module'] import `name'’.  All *note import: c10. forms not
     starting with ‘.’ are interpreted as absolute imports.  ( PEP
     328(2))

   * Classic classes are gone.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3113

   (2) https://www.python.org/dev/peps/pep-0328


File: python.info,  Node: Changes Already Present In Python 2 6,  Next: Library Changes,  Prev: Overview Of Syntax Changes,  Up: What’s New In Python 3 0

1.9.3 Changes Already Present In Python 2.6
-------------------------------------------

Since many users presumably make the jump straight from Python 2.5 to
Python 3.0, this section reminds the reader of new features that were
originally designed for Python 3.0 but that were back-ported to Python
2.6.  The corresponding sections in *note What’s New in Python 2.6: c3a.
should be consulted for longer descriptions.

   * *note PEP 343; The ‘with’ statement: c3b.  The *note with: 6dd.
     statement is now a standard feature and no longer needs to be
     imported from the *note __future__: 0.  Also check out *note
     Writing Context Managers: c3c. and *note The contextlib module:
     c3d.

   * *note PEP 366; Explicit Relative Imports From a Main Module: c3e.
     This enhances the usefulness of the *note -m: 32c. option when the
     referenced module lives in a package.

   * *note PEP 370; Per-user site-packages Directory: c3f.

   * *note PEP 371; The multiprocessing Package: c40.

   * *note PEP 3101; Advanced String Formatting: c41.  Note: the 2.6
     description mentions the *note format(): 4d0. method for both 8-bit
     and Unicode strings.  In 3.0, only the *note str: 325. type (text
     strings with Unicode support) supports this method; the *note
     bytes: 326. type does not.  The plan is to eventually make this the
     only API for string formatting, and to start deprecating the ‘%’
     operator in Python 3.1.

   * *note PEP 3105; print As a Function: c42.  This is now a standard
     feature and no longer needs to be imported from *note __future__:
     0.  More details were given above.

   * *note PEP 3110; Exception-Handling Changes: c43.  The *note except:
     b31. `exc' ‘as’ `var' syntax is now standard and ‘except’ `exc',
     `var' is no longer supported.  (Of course, the ‘as’ `var' part is
     still optional.)

   * *note PEP 3112; Byte Literals: c44.  The ‘b"..."’ string literal
     notation (and its variants like ‘b'...'’, ‘b"""..."""’, and
     ‘br"..."’) now produces a literal of type *note bytes: 326.

   * *note PEP 3116; New I/O Library: c45.  The *note io: a1. module is
     now the standard way of doing file I/O. The built-in *note open():
     4e5. function is now an alias for *note io.open(): 64e. and has
     additional keyword arguments `encoding', `errors', `newline' and
     `closefd'.  Also note that an invalid `mode' argument now raises
     *note ValueError: 1f9, not *note IOError: 986.  The binary file
     object underlying a text file object can be accessed as ‘f.buffer’
     (but beware that the text object maintains a buffer of itself in
     order to speed up the encoding and decoding operations).

   * *note PEP 3118; Revised Buffer Protocol: c46.  The old builtin
     ‘buffer()’ is now really gone; the new builtin *note memoryview():
     25a. provides (mostly) similar functionality.

   * *note PEP 3119; Abstract Base Classes: c47.  The *note abc: 4.
     module and the ABCs defined in the *note collections: 1e. module
     plays a somewhat more prominent role in the language now, and
     built-in collection types like *note dict: 1b6. and *note list:
     260. conform to the ‘collections.MutableMapping’ and
     ‘collections.MutableSequence’ ABCs, respectively.

   * *note PEP 3127; Integer Literal Support and Syntax: c48.  As
     mentioned above, the new octal literal notation is the only one
     supported, and binary literals have been added.

   * *note PEP 3129; Class Decorators: c49.

   * *note PEP 3141; A Type Hierarchy for Numbers: c4a.  The *note
     numbers: c1. module is another new use of ABCs, defining Python’s
     “numeric tower”.  Also note the new *note fractions: 83. module
     which implements *note numbers.Rational: c4b.


File: python.info,  Node: Library Changes,  Next: PEP 3101 A New Approach To String Formatting,  Prev: Changes Already Present In Python 2 6,  Up: What’s New In Python 3 0

1.9.4 Library Changes
---------------------

Due to time constraints, this document does not exhaustively cover the
very extensive changes to the standard library.  PEP 3108(1) is the
reference for the major changes to the library.  Here’s a capsule
review:

   * Many old modules were removed.  Some, like ‘gopherlib’ (no longer
     used) and ‘md5’ (replaced by *note hashlib: 8d.), were already
     deprecated by PEP 4(2).  Others were removed as a result of the
     removal of support for various platforms such as Irix, BeOS and Mac
     OS 9 (see PEP 11(3)).  Some modules were also selected for removal
     in Python 3.0 due to lack of use or because a better replacement
     exists.  See PEP 3108(4) for an exhaustive list.

   * The ‘bsddb3’ package was removed because its presence in the core
     standard library has proved over time to be a particular burden for
     the core developers due to testing instability and Berkeley DB’s
     release schedule.  However, the package is alive and well,
     externally maintained at
     ‘https://www.jcea.es/programacion/pybsddb.htm’.

   * Some modules were renamed because their old name disobeyed PEP
     8(5), or for various other reasons.  Here’s the list:

     Old Name                    New Name
                                 
     --------------------------------------------------------
                                 
     _winreg                     winreg
                                 
                                 
     ConfigParser                configparser
                                 
                                 
     copy_reg                    copyreg
                                 
                                 
     Queue                       queue
                                 
                                 
     SocketServer                socketserver
                                 
                                 
     markupbase                  _markupbase
                                 
                                 
     repr                        reprlib
                                 
                                 
     test.test_support           test.support
                                 

   * A common pattern in Python 2.x is to have one version of a module
     implemented in pure Python, with an optional accelerated version
     implemented as a C extension; for example, *note pickle: ca. and
     ‘cPickle’.  This places the burden of importing the accelerated
     version and falling back on the pure Python version on each user of
     these modules.  In Python 3.0, the accelerated versions are
     considered implementation details of the pure Python versions.
     Users should always import the standard version, which attempts to
     import the accelerated version and falls back to the pure Python
     version.  The *note pickle: ca. / ‘cPickle’ pair received this
     treatment.  The *note profile: d3. module is on the list for 3.1.
     The ‘StringIO’ module has been turned into a class in the *note io:
     a1. module.

   * Some related modules have been grouped into packages, and usually
     the submodule names have been simplified.  The resulting new
     packages are:

        * *note dbm: 32. (‘anydbm’, ‘dbhash’, *note dbm: 32, ‘dumbdbm’,
          ‘gdbm’, ‘whichdb’).

        * *note html: 90. (‘HTMLParser’, ‘htmlentitydefs’).

        * *note http: 93. (‘httplib’, ‘BaseHTTPServer’, ‘CGIHTTPServer’,
          ‘SimpleHTTPServer’, ‘Cookie’, ‘cookielib’).

        * *note tkinter: 10c. (all ‘Tkinter’-related modules except
          *note turtle: 116.).  The target audience of *note turtle:
          116. doesn’t really care about *note tkinter: 10c.  Also note
          that as of Python 2.6, the functionality of *note turtle: 116.
          has been greatly enhanced.

        * *note urllib: 11d. (*note urllib: 11d, ‘urllib2’, ‘urlparse’,
          ‘robotparse’).

        * ‘xmlrpc’ (‘xmlrpclib’, ‘DocXMLRPCServer’,
          ‘SimpleXMLRPCServer’).

Some other changes to standard library modules, not covered by PEP
3108(6):

   * Killed ‘sets’.  Use the built-in *note set(): b62. class.

   * Cleanup of the *note sys: fd. module: removed ‘sys.exitfunc()’,
     ‘sys.exc_clear()’, ‘sys.exc_type’, ‘sys.exc_value’,
     ‘sys.exc_traceback’.  (Note that *note sys.last_type: c4d. etc.
     remain.)

   * Cleanup of the *note array.array: 446. type: the ‘read()’ and
     ‘write()’ methods are gone; use ‘fromfile()’ and ‘tofile()’
     instead.  Also, the ‘'c'’ typecode for array is gone – use either
     ‘'b'’ for bytes or ‘'u'’ for Unicode characters.

   * Cleanup of the *note operator: c2. module: removed
     ‘sequenceIncludes()’ and ‘isCallable()’.

   * Cleanup of the ‘thread’ module: ‘acquire_lock()’ and
     ‘release_lock()’ are gone; use ‘acquire()’ and ‘release()’ instead.

   * Cleanup of the *note random: dc. module: removed the ‘jumpahead()’
     API.

   * The ‘new’ module is gone.

   * The functions ‘os.tmpnam()’, ‘os.tempnam()’ and ‘os.tmpfile()’ have
     been removed in favor of the *note tempfile: 103. module.

   * The *note tokenize: 111. module has been changed to work with
     bytes.  The main entry point is now *note tokenize.tokenize(): c4e,
     instead of generate_tokens.

   * ‘string.letters’ and its friends (‘string.lowercase’ and
     ‘string.uppercase’) are gone.  Use *note string.ascii_letters: c4f.
     etc.  instead.  (The reason for the removal is that
     ‘string.letters’ and friends had locale-specific behavior, which is
     a bad idea for such attractively-named global “constants”.)

   * Renamed module ‘__builtin__’ to *note builtins: 13. (removing the
     underscores, adding an ‘s’).  The ‘__builtins__’ variable found in
     most global namespaces is unchanged.  To modify a builtin, you
     should use *note builtins: 13, not ‘__builtins__’!

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3108

   (2) https://www.python.org/dev/peps/pep-0004

   (3) https://www.python.org/dev/peps/pep-0011

   (4) https://www.python.org/dev/peps/pep-3108

   (5) https://www.python.org/dev/peps/pep-0008

   (6) https://www.python.org/dev/peps/pep-3108


File: python.info,  Node: PEP 3101 A New Approach To String Formatting,  Next: Changes To Exceptions,  Prev: Library Changes,  Up: What’s New In Python 3 0

`PEP 3101': A New Approach To String Formatting

   * A new system for built-in string formatting operations replaces the
     ‘%’ string formatting operator.  (However, the ‘%’ operator is
     still supported; it will be deprecated in Python 3.1 and removed
     from the language at some later time.)  Read PEP 3101(1) for the
     full scoop.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3101


File: python.info,  Node: Changes To Exceptions,  Next: Miscellaneous Other Changes,  Prev: PEP 3101 A New Approach To String Formatting,  Up: What’s New In Python 3 0

1.9.6 Changes To Exceptions
---------------------------

The APIs for raising and catching exception have been cleaned up and new
powerful features added:

   * PEP 352(1): All exceptions must be derived (directly or indirectly)
     from *note BaseException: 1a7.  This is the root of the exception
     hierarchy.  This is not new as a recommendation, but the
     `requirement' to inherit from *note BaseException: 1a7. is new.
     (Python 2.6 still allowed classic classes to be raised, and placed
     no restriction on what you can catch.)  As a consequence, string
     exceptions are finally truly and utterly dead.

   * Almost all exceptions should actually derive from *note Exception:
     1a8.; *note BaseException: 1a7. should only be used as a base class
     for exceptions that should only be handled at the top level, such
     as *note SystemExit: 5f1. or *note KeyboardInterrupt: 197.  The
     recommended idiom for handling all exceptions except for this
     latter category is to use *note except: b31. *note Exception: 1a8.

   * ‘StandardError’ was removed.

   * Exceptions no longer behave as sequences.  Use the ‘args’ attribute
     instead.

   * PEP 3109(2): Raising exceptions.  You must now use ‘raise
     `Exception'(`args')’ instead of ‘raise `Exception', `args'’.
     Additionally, you can no longer explicitly specify a traceback;
     instead, if you `have' to do this, you can assign directly to the
     ‘__traceback__’ attribute (see below).

   * PEP 3110(3): Catching exceptions.  You must now use ‘except
     `SomeException' as `variable'’ instead of ‘except `SomeException',
     `variable'’.  Moreover, the `variable' is explicitly deleted when
     the *note except: b31. block is left.

   * PEP 3134(4): Exception chaining.  There are two cases: implicit
     chaining and explicit chaining.  Implicit chaining happens when an
     exception is raised in an *note except: b31. or *note finally: 182.
     handler block.  This usually happens due to a bug in the handler
     block; we call this a `secondary' exception.  In this case, the
     original exception (that was being handled) is saved as the
     ‘__context__’ attribute of the secondary exception.  Explicit
     chaining is invoked with this syntax:

          raise SecondaryException() from primary_exception

     (where `primary_exception' is any expression that produces an
     exception object, probably an exception that was previously
     caught).  In this case, the primary exception is stored on the
     ‘__cause__’ attribute of the secondary exception.  The traceback
     printed when an unhandled exception occurs walks the chain of
     ‘__cause__’ and ‘__context__’ attributes and prints a separate
     traceback for each component of the chain, with the primary
     exception at the top.  (Java users may recognize this behavior.)

   * PEP 3134(5): Exception objects now store their traceback as the
     ‘__traceback__’ attribute.  This means that an exception object now
     contains all the information pertaining to an exception, and there
     are fewer reasons to use *note sys.exc_info(): c52. (though the
     latter is not removed).

   * A few exception messages are improved when Windows fails to load an
     extension module.  For example, ‘error code 193’ is now ‘%1 is not
     a valid Win32 application’.  Strings now deal with non-English
     locales.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0352

   (2) https://www.python.org/dev/peps/pep-3109

   (3) https://www.python.org/dev/peps/pep-3110

   (4) https://www.python.org/dev/peps/pep-3134

   (5) https://www.python.org/dev/peps/pep-3134


File: python.info,  Node: Miscellaneous Other Changes,  Next: Build and C API Changes<7>,  Prev: Changes To Exceptions,  Up: What’s New In Python 3 0

1.9.7 Miscellaneous Other Changes
---------------------------------

* Menu:

* Operators And Special Methods::
* Builtins::


File: python.info,  Node: Operators And Special Methods,  Next: Builtins,  Up: Miscellaneous Other Changes

1.9.7.1 Operators And Special Methods
.....................................

   * ‘!=’ now returns the opposite of ‘==’, unless ‘==’ returns *note
     NotImplemented: 840.

   * The concept of “unbound methods” has been removed from the
     language.  When referencing a method as a class attribute, you now
     get a plain function object.

   * ‘__getslice__()’, ‘__setslice__()’ and ‘__delslice__()’ were
     killed.  The syntax ‘a[i:j]’ now translates to
     ‘a.__getitem__(slice(i, j))’ (or *note __setitem__(): c55. or *note
     __delitem__(): c56, when used as an assignment or deletion target,
     respectively).

   * PEP 3114(1): the standard *note next(): 676. method has been
     renamed to *note __next__(): c57.

   * The ‘__oct__()’ and ‘__hex__()’ special methods are removed – *note
     oct(): c58. and *note hex(): c59. use *note __index__(): 18a. now
     to convert the argument to an integer.

   * Removed support for ‘__members__’ and ‘__methods__’.

   * The function attributes named ‘func_X’ have been renamed to use the
     ‘__X__’ form, freeing up these names in the function attribute
     namespace for user-defined attributes.  To wit, ‘func_closure’,
     ‘func_code’, ‘func_defaults’, ‘func_dict’, ‘func_doc’,
     ‘func_globals’, ‘func_name’ were renamed to ‘__closure__’,
     ‘__code__’, ‘__defaults__’, *note __dict__: 4f1, ‘__doc__’,
     ‘__globals__’, *note __name__: c5a, respectively.

   * ‘__nonzero__()’ is now *note __bool__(): c5b.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3114


File: python.info,  Node: Builtins,  Prev: Operators And Special Methods,  Up: Miscellaneous Other Changes

1.9.7.2 Builtins
................

   * PEP 3135(1): New *note super(): 4d7.  You can now invoke *note
     super(): 4d7. without arguments and (assuming this is in a regular
     instance method defined inside a *note class: c5d. statement) the
     right class and instance will automatically be chosen.  With
     arguments, the behavior of *note super(): 4d7. is unchanged.

   * PEP 3111(2): ‘raw_input()’ was renamed to *note input(): c5e.  That
     is, the new *note input(): c5e. function reads a line from *note
     sys.stdin: 302. and returns it with the trailing newline stripped.
     It raises *note EOFError: c5f. if the input is terminated
     prematurely.  To get the old behavior of *note input(): c5e, use
     ‘eval(input())’.

   * A new built-in function *note next(): 676. was added to call the
     *note __next__(): c57. method on an object.

   * The *note round(): c60. function rounding strategy and return type
     have changed.  Exact halfway cases are now rounded to the nearest
     even result instead of away from zero.  (For example, ‘round(2.5)’
     now returns ‘2’ rather than ‘3’.)  ‘round(x[, n])’ now delegates to
     ‘x.__round__([n])’ instead of always returning a float.  It
     generally returns an integer when called with a single argument and
     a value of the same type as ‘x’ when called with two arguments.

   * Moved ‘intern()’ to *note sys.intern(): c61.

   * Removed: ‘apply()’.  Instead of ‘apply(f, args)’ use ‘f(*args)’.

   * Removed *note callable(): b37.  Instead of ‘callable(f)’ you can
     use ‘isinstance(f, collections.Callable)’.  The
     ‘operator.isCallable()’ function is also gone.

   * Removed ‘coerce()’.  This function no longer serves a purpose now
     that classic classes are gone.

   * Removed ‘execfile()’.  Instead of ‘execfile(fn)’ use
     ‘exec(open(fn).read())’.

   * Removed the ‘file’ type.  Use *note open(): 4e5.  There are now
     several different kinds of streams that open can return in the
     *note io: a1. module.

   * Removed ‘reduce()’.  Use *note functools.reduce(): c62. if you
     really need it; however, 99 percent of the time an explicit *note
     for: c23. loop is more readable.

   * Removed ‘reload()’.  Use *note imp.reload(): c63.

   * Removed.  ‘dict.has_key()’ – use the *note in: 797. operator
     instead.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3135

   (2) https://www.python.org/dev/peps/pep-3111


File: python.info,  Node: Build and C API Changes<7>,  Next: Performance,  Prev: Miscellaneous Other Changes,  Up: What’s New In Python 3 0

1.9.8 Build and C API Changes
-----------------------------

Due to time constraints, here is a `very' incomplete list of changes to
the C API.

   * Support for several platforms was dropped, including but not
     limited to Mac OS 9, BeOS, RISCOS, Irix, and Tru64.

   * PEP 3118(1): New Buffer API.

   * PEP 3121(2): Extension Module Initialization & Finalization.

   * PEP 3123(3): Making *note PyObject_HEAD: c65. conform to standard
     C.

   * No more C API support for restricted execution.

   * ‘PyNumber_Coerce()’, ‘PyNumber_CoerceEx()’, ‘PyMember_Get()’, and
     ‘PyMember_Set()’ C APIs are removed.

   * New C API *note PyImport_ImportModuleNoBlock(): 9b5, works like
     *note PyImport_ImportModule(): c66. but won’t block on the import
     lock (returning an error instead).

   * Renamed the boolean conversion C-level slot and method:
     ‘nb_nonzero’ is now ‘nb_bool’.

   * Removed ‘METH_OLDARGS’ and ‘WITH_CYCLE_GC’ from the C API.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3118

   (2) https://www.python.org/dev/peps/pep-3121

   (3) https://www.python.org/dev/peps/pep-3123


File: python.info,  Node: Performance,  Next: Porting To Python 3 0,  Prev: Build and C API Changes<7>,  Up: What’s New In Python 3 0

1.9.9 Performance
-----------------

The net result of the 3.0 generalizations is that Python 3.0 runs the
pystone benchmark around 10% slower than Python 2.5.  Most likely the
biggest cause is the removal of special-casing for small integers.
There’s room for improvement, but it will happen after 3.0 is released!


File: python.info,  Node: Porting To Python 3 0,  Prev: Performance,  Up: What’s New In Python 3 0

1.9.10 Porting To Python 3.0
----------------------------

For porting existing Python 2.5 or 2.6 source code to Python 3.0, the
best strategy is the following:

  0. (Prerequisite:) Start with excellent test coverage.

  1. Port to Python 2.6.  This should be no more work than the average
     port from Python 2.x to Python 2.(x+1).  Make sure all your tests
     pass.

  2. (Still using 2.6:) Turn on the ‘-3’ command line switch.  This
     enables warnings about features that will be removed (or change) in
     3.0.  Run your test suite again, and fix code that you get warnings
     about until there are no warnings left, and all your tests still
     pass.

  3. Run the ‘2to3’ source-to-source translator over your source code
     tree.  (See *note 2to3 - Automated Python 2 to 3 code translation:
     c69. for more on this tool.)  Run the result of the translation
     under Python 3.0.  Manually fix up any remaining issues, fixing
     problems until all tests pass again.

It is not recommended to try to write source code that runs unchanged
under both Python 2.6 and 3.0; you’d have to use a very contorted coding
style, e.g.  avoiding ‘print’ statements, metaclasses, and much more.
If you are maintaining a library that needs to support both Python 2.6
and Python 3.0, the best approach is to modify step 3 above by editing
the 2.6 version of the source code and running the ‘2to3’ translator
again, rather than editing the 3.0 version of the source code.

For porting C extensions to Python 3.0, please see *note Porting
Extension Modules to Python 3: c6a.


File: python.info,  Node: What’s New in Python 2 7,  Next: What’s New in Python 2 6,  Prev: What’s New In Python 3 0,  Up: What’s New in Python

1.10 What’s New in Python 2.7
=============================


Author: A.M. Kuchling (amk at amk.ca)

This article explains the new features in Python 2.7.  Python 2.7 was
released on July 3, 2010.

Numeric handling has been improved in many ways, for both floating-point
numbers and for the *note Decimal: 188. class.  There are some useful
additions to the standard library, such as a greatly enhanced *note
unittest: 11b. module, the *note argparse: 6. module for parsing
command-line options, convenient *note OrderedDict: 1b7. and *note
Counter: 9ce. classes in the *note collections: 1e. module, and many
other improvements.

Python 2.7 is planned to be the last of the 2.x releases, so we worked
on making it a good release for the long term.  To help with porting to
Python 3, several new features from the Python 3.x series have been
included in 2.7.

This article doesn’t attempt to provide a complete specification of the
new features, but instead provides a convenient overview.  For full
details, you should refer to the documentation for Python 2.7 at
‘https://docs.python.org’.  If you want to understand the rationale for
the design and implementation, refer to the PEP for a particular new
feature or the issue on ‘https://bugs.python.org’ in which a change was
discussed.  Whenever possible, “What’s New in Python” links to the
bug/patch item for each change.

* Menu:

* The Future for Python 2.x: The Future for Python 2 x.
* Changes to the Handling of Deprecation Warnings::
* Python 3.1 Features: Python 3 1 Features.
* PEP 372; Adding an Ordered Dictionary to collections: PEP 372 Adding an Ordered Dictionary to collections.
* PEP 378; Format Specifier for Thousands Separator: PEP 378 Format Specifier for Thousands Separator<2>.
* PEP 389; The argparse Module for Parsing Command Lines: PEP 389 The argparse Module for Parsing Command Lines.
* PEP 391; Dictionary-Based Configuration For Logging: PEP 391 Dictionary-Based Configuration For Logging.
* PEP 3106; Dictionary Views: PEP 3106 Dictionary Views.
* PEP 3137; The memoryview Object: PEP 3137 The memoryview Object.
* Other Language Changes: Other Language Changes<9>.
* New and Improved Modules::
* Build and C API Changes: Build and C API Changes<8>.
* Other Changes and Fixes::
* Porting to Python 2.7: Porting to Python 2 7.
* New Features Added to Python 2.7 Maintenance Releases: New Features Added to Python 2 7 Maintenance Releases.
* Acknowledgements::


File: python.info,  Node: The Future for Python 2 x,  Next: Changes to the Handling of Deprecation Warnings,  Up: What’s New in Python 2 7

1.10.1 The Future for Python 2.x
--------------------------------

Python 2.7 is the last major release in the 2.x series, as the Python
maintainers have shifted the focus of their new feature development
efforts to the Python 3.x series.  This means that while Python 2
continues to receive bug fixes, and to be updated to build correctly on
new hardware and versions of supported operated systems, there will be
no new full feature releases for the language or standard library.

However, while there is a large common subset between Python 2.7 and
Python 3, and many of the changes involved in migrating to that common
subset, or directly to Python 3, can be safely automated, some other
changes (notably those associated with Unicode handling) may require
careful consideration, and preferably robust automated regression test
suites, to migrate effectively.

This means that Python 2.7 will remain in place for a long time,
providing a stable and supported base platform for production systems
that have not yet been ported to Python 3.  The full expected lifecycle
of the Python 2.7 series is detailed in PEP 373(1).

Some key consequences of the long-term significance of 2.7 are:

   * As noted above, the 2.7 release has a much longer period of
     maintenance when compared to earlier 2.x versions.  Python 2.7 is
     currently expected to remain supported by the core development team
     (receiving security updates and other bug fixes) until at least
     2020 (10 years after its initial release, compared to the more
     typical support period of 18–24 months).

   * As the Python 2.7 standard library ages, making effective use of
     the Python Package Index (either directly or via a redistributor)
     becomes more important for Python 2 users.  In addition to a wide
     variety of third party packages for various tasks, the available
     packages include backports of new modules and features from the
     Python 3 standard library that are compatible with Python 2, as
     well as various tools and libraries that can make it easier to
     migrate to Python 3.  The Python Packaging User Guide(2) provides
     guidance on downloading and installing software from the Python
     Package Index.

   * While the preferred approach to enhancing Python 2 is now the
     publication of new packages on the Python Package Index, this
     approach doesn’t necessarily work in all cases, especially those
     related to network security.  In exceptional cases that cannot be
     handled adequately by publishing new or updated packages on PyPI,
     the Python Enhancement Proposal process may be used to make the
     case for adding new features directly to the Python 2 standard
     library.  Any such additions, and the maintenance releases where
     they were added, will be noted in the *note New Features Added to
     Python 2.7 Maintenance Releases: c6f. section below.

For projects wishing to migrate from Python 2 to Python 3, or for
library and framework developers wishing to support users on both Python
2 and Python 3, there are a variety of tools and guides available to
help decide on a suitable approach and manage some of the technical
details involved.  The recommended starting point is the *note Porting
Python 2 Code to Python 3: c70. HOWTO guide.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0373

   (2) https://packaging.python.org


File: python.info,  Node: Changes to the Handling of Deprecation Warnings,  Next: Python 3 1 Features,  Prev: The Future for Python 2 x,  Up: What’s New in Python 2 7

1.10.2 Changes to the Handling of Deprecation Warnings
------------------------------------------------------

For Python 2.7, a policy decision was made to silence warnings only of
interest to developers by default.  *note DeprecationWarning: 276. and
its descendants are now ignored unless otherwise requested, preventing
users from seeing warnings triggered by an application.  This change was
also made in the branch that became Python 3.2.  (Discussed on
stdlib-sig and carried out in bpo-7319(1).)

In previous releases, *note DeprecationWarning: 276. messages were
enabled by default, providing Python developers with a clear indication
of where their code may break in a future major version of Python.

However, there are increasingly many users of Python-based applications
who are not directly involved in the development of those applications.
*note DeprecationWarning: 276. messages are irrelevant to such users,
making them worry about an application that’s actually working correctly
and burdening application developers with responding to these concerns.

You can re-enable display of *note DeprecationWarning: 276. messages by
running Python with the *note -Wdefault: 40c. (short form: *note -Wd:
40c.) switch, or by setting the *note PYTHONWARNINGS: 40d. environment
variable to ‘"default"’ (or ‘"d"’) before running Python.  Python code
can also re-enable them by calling ‘warnings.simplefilter('default')’.

The ‘unittest’ module also automatically reenables deprecation warnings
when running tests.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7319


File: python.info,  Node: Python 3 1 Features,  Next: PEP 372 Adding an Ordered Dictionary to collections,  Prev: Changes to the Handling of Deprecation Warnings,  Up: What’s New in Python 2 7

1.10.3 Python 3.1 Features
--------------------------

Much as Python 2.6 incorporated features from Python 3.0, version 2.7
incorporates some of the new features in Python 3.1.  The 2.x series
continues to provide tools for migrating to the 3.x series.

A partial list of 3.1 features that were backported to 2.7:

   * The syntax for set literals (‘{1,2,3}’ is a mutable set).

   * Dictionary and set comprehensions (‘{i: i*2 for i in range(3)}’).

   * Multiple context managers in a single *note with: 6dd. statement.

   * A new version of the *note io: a1. library, rewritten in C for
     performance.

   * The ordered-dictionary type described in *note PEP 372; Adding an
     Ordered Dictionary to collections: c73.

   * The new ‘","’ format specifier described in *note PEP 378; Format
     Specifier for Thousands Separator: c74.

   * The *note memoryview: 25a. object.

   * A small subset of the *note importlib: 9b. module, *note described
     below: c75.

   * The *note repr(): 7c0. of a float ‘x’ is shorter in many cases:
     it’s now based on the shortest decimal string that’s guaranteed to
     round back to ‘x’.  As in previous versions of Python, it’s
     guaranteed that ‘float(repr(x))’ recovers ‘x’.

   * Float-to-string and string-to-float conversions are correctly
     rounded.  The *note round(): c60. function is also now correctly
     rounded.

   * The *note PyCapsule: bfa. type, used to provide a C API for
     extension modules.

   * The *note PyLong_AsLongAndOverflow(): bf0. C API function.

Other new Python3-mode warnings include:

   * ‘operator.isCallable()’ and ‘operator.sequenceIncludes()’, which
     are not supported in 3.x, now trigger warnings.

   * The ‘-3’ switch now automatically enables the ‘-Qwarn’ switch that
     causes warnings about using classic division with integers and long
     integers.


File: python.info,  Node: PEP 372 Adding an Ordered Dictionary to collections,  Next: PEP 378 Format Specifier for Thousands Separator<2>,  Prev: Python 3 1 Features,  Up: What’s New in Python 2 7

1.10.4 PEP 372: Adding an Ordered Dictionary to collections
-----------------------------------------------------------

Regular Python dictionaries iterate over key/value pairs in arbitrary
order.  Over the years, a number of authors have written alternative
implementations that remember the order that the keys were originally
inserted.  Based on the experiences from those implementations, 2.7
introduces a new *note OrderedDict: 1b7. class in the *note collections:
1e. module.

The *note OrderedDict: 1b7. API provides the same interface as regular
dictionaries but iterates over keys and values in a guaranteed order
depending on when a key was first inserted:

     >>> from collections import OrderedDict
     >>> d = OrderedDict([('first', 1),
     ...                  ('second', 2),
     ...                  ('third', 3)])
     >>> d.items()
     [('first', 1), ('second', 2), ('third', 3)]

If a new entry overwrites an existing entry, the original insertion
position is left unchanged:

     >>> d['second'] = 4
     >>> d.items()
     [('first', 1), ('second', 4), ('third', 3)]

Deleting an entry and reinserting it will move it to the end:

     >>> del d['second']
     >>> d['second'] = 5
     >>> d.items()
     [('first', 1), ('third', 3), ('second', 5)]

The *note popitem(): c77. method has an optional `last' argument that
defaults to ‘True’.  If `last' is true, the most recently added key is
returned and removed; if it’s false, the oldest key is selected:

     >>> od = OrderedDict([(x,0) for x in range(20)])
     >>> od.popitem()
     (19, 0)
     >>> od.popitem()
     (18, 0)
     >>> od.popitem(last=False)
     (0, 0)
     >>> od.popitem(last=False)
     (1, 0)

Comparing two ordered dictionaries checks both the keys and values, and
requires that the insertion order was the same:

     >>> od1 = OrderedDict([('first', 1),
     ...                    ('second', 2),
     ...                    ('third', 3)])
     >>> od2 = OrderedDict([('third', 3),
     ...                    ('first', 1),
     ...                    ('second', 2)])
     >>> od1 == od2
     False
     >>> # Move 'third' key to the end
     >>> del od2['third']; od2['third'] = 3
     >>> od1 == od2
     True

Comparing an *note OrderedDict: 1b7. with a regular dictionary ignores
the insertion order and just compares the keys and values.

How does the *note OrderedDict: 1b7. work?  It maintains a doubly-linked
list of keys, appending new keys to the list as they’re inserted.  A
secondary dictionary maps keys to their corresponding list node, so
deletion doesn’t have to traverse the entire linked list and therefore
remains O(1).

The standard library now supports use of ordered dictionaries in several
modules.

   * The ‘ConfigParser’ module uses them by default, meaning that
     configuration files can now be read, modified, and then written
     back in their original order.

   * The *note _asdict(): 1b4. method for *note
     collections.namedtuple(): 1b5. now returns an ordered dictionary
     with the values appearing in the same order as the underlying tuple
     indices.

   * The *note json: a4. module’s *note JSONDecoder: 5fc. class
     constructor was extended with an `object_pairs_hook' parameter to
     allow ‘OrderedDict’ instances to be built by the decoder.  Support
     was also added for third-party tools like PyYAML(1).

See also
........

PEP 372(2) - Adding an ordered dictionary to collections

     PEP written by Armin Ronacher and Raymond Hettinger; implemented by
     Raymond Hettinger.

   ---------- Footnotes ----------

   (1) http://pyyaml.org/

   (2) https://www.python.org/dev/peps/pep-0372


File: python.info,  Node: PEP 378 Format Specifier for Thousands Separator<2>,  Next: PEP 389 The argparse Module for Parsing Command Lines,  Prev: PEP 372 Adding an Ordered Dictionary to collections,  Up: What’s New in Python 2 7

1.10.5 PEP 378: Format Specifier for Thousands Separator
--------------------------------------------------------

To make program output more readable, it can be useful to add separators
to large numbers, rendering them as 18,446,744,073,709,551,616 instead
of 18446744073709551616.

The fully general solution for doing this is the *note locale: a9.
module, which can use different separators (“,” in North America, “.” in
Europe) and different grouping sizes, but *note locale: a9. is
complicated to use and unsuitable for multi-threaded applications where
different threads are producing output for different locales.

Therefore, a simple comma-grouping mechanism has been added to the
mini-language used by the *note str.format(): 4cf. method.  When
formatting a floating-point number, simply include a comma between the
width and the precision:

     >>> '{:20,.2f}'.format(18446744073709551616.0)
     '18,446,744,073,709,551,616.00'

When formatting an integer, include the comma after the width:

     >>> '{:20,d}'.format(18446744073709551616)
     '18,446,744,073,709,551,616'

This mechanism is not adaptable at all; commas are always used as the
separator and the grouping is always into three-digit groups.  The
comma-formatting mechanism isn’t as general as the *note locale: a9.
module, but it’s easier to use.

See also
........

PEP 378(1) - Format Specifier for Thousands Separator

     PEP written by Raymond Hettinger; implemented by Eric Smith.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0378


File: python.info,  Node: PEP 389 The argparse Module for Parsing Command Lines,  Next: PEP 391 Dictionary-Based Configuration For Logging,  Prev: PEP 378 Format Specifier for Thousands Separator<2>,  Up: What’s New in Python 2 7

1.10.6 PEP 389: The argparse Module for Parsing Command Lines
-------------------------------------------------------------

The *note argparse: 6. module for parsing command-line arguments was
added as a more powerful replacement for the *note optparse: c3. module.

This means Python now supports three different modules for parsing
command-line arguments: *note getopt: 87, *note optparse: c3, and *note
argparse: 6.  The *note getopt: 87. module closely resembles the C
library’s ‘getopt()’ function, so it remains useful if you’re writing a
Python prototype that will eventually be rewritten in C. *note optparse:
c3. becomes redundant, but there are no plans to remove it because there
are many scripts still using it, and there’s no automated way to update
these scripts.  (Making the *note argparse: 6. API consistent with *note
optparse: c3.’s interface was discussed but rejected as too messy and
difficult.)

In short, if you’re writing a new script and don’t need to worry about
compatibility with earlier versions of Python, use *note argparse: 6.
instead of *note optparse: c3.

Here’s an example:

     import argparse

     parser = argparse.ArgumentParser(description='Command-line example.')

     # Add optional switches
     parser.add_argument('-v', action='store_true', dest='is_verbose',
                         help='produce verbose output')
     parser.add_argument('-o', action='store', dest='output',
                         metavar='FILE',
                         help='direct output to FILE instead of stdout')
     parser.add_argument('-C', action='store', type=int, dest='context',
                         metavar='NUM', default=0,
                         help='display NUM lines of added context')

     # Allow any number of additional arguments.
     parser.add_argument(nargs='*', action='store', dest='inputs',
                         help='input filenames (default is stdin)')

     args = parser.parse_args()
     print args.__dict__

Unless you override it, ‘-h’ and ‘--help’ switches are automatically
added, and produce neatly formatted output:

     -> ./python.exe argparse-example.py --help
     usage: argparse-example.py [-h] [-v] [-o FILE] [-C NUM] [inputs [inputs ...]]

     Command-line example.

     positional arguments:
       inputs      input filenames (default is stdin)

     optional arguments:
       -h, --help  show this help message and exit
       -v          produce verbose output
       -o FILE     direct output to FILE instead of stdout
       -C NUM      display NUM lines of added context

As with *note optparse: c3, the command-line switches and arguments are
returned as an object with attributes named by the `dest' parameters:

     -> ./python.exe argparse-example.py -v
     {'output': None,
      'is_verbose': True,
      'context': 0,
      'inputs': []}

     -> ./python.exe argparse-example.py -v -o /tmp/output -C 4 file1 file2
     {'output': '/tmp/output',
      'is_verbose': True,
      'context': 4,
      'inputs': ['file1', 'file2']}

*note argparse: 6. has much fancier validation than *note optparse: c3.;
you can specify an exact number of arguments as an integer, 0 or more
arguments by passing ‘'*'’, 1 or more by passing ‘'+'’, or an optional
argument with ‘'?'’.  A top-level parser can contain sub-parsers to
define subcommands that have different sets of switches, as in ‘svn
commit’, ‘svn checkout’, etc.  You can specify an argument’s type as
*note FileType: 814, which will automatically open files for you and
understands that ‘'-'’ means standard input or output.

See also
........

*note argparse: 6. documentation

     The documentation page of the argparse module.

*note Upgrading optparse code: b1c.

     Part of the Python documentation, describing how to convert code
     that uses *note optparse: c3.

PEP 389(1) - argparse - New Command Line Parsing Module

     PEP written and implemented by Steven Bethard.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0389


File: python.info,  Node: PEP 391 Dictionary-Based Configuration For Logging,  Next: PEP 3106 Dictionary Views,  Prev: PEP 389 The argparse Module for Parsing Command Lines,  Up: What’s New in Python 2 7

1.10.7 PEP 391: Dictionary-Based Configuration For Logging
----------------------------------------------------------

The *note logging: aa. module is very flexible; applications can define
a tree of logging subsystems, and each logger in this tree can filter
out certain messages, format them differently, and direct messages to a
varying number of handlers.

All this flexibility can require a lot of configuration.  You can write
Python statements to create objects and set their properties, but a
complex set-up requires verbose but boring code.  *note logging: aa.
also supports a ‘fileConfig()’ function that parses a file, but the file
format doesn’t support configuring filters, and it’s messier to generate
programmatically.

Python 2.7 adds a ‘dictConfig()’ function that uses a dictionary to
configure logging.  There are many ways to produce a dictionary from
different sources: construct one with code; parse a file containing
JSON; or use a YAML parsing library if one is installed.  For more
information see *note Configuration functions: c7b.

The following example configures two loggers, the root logger and a
logger named “network”.  Messages sent to the root logger will be sent
to the system log using the syslog protocol, and messages to the
“network” logger will be written to a ‘network.log’ file that will be
rotated once the log reaches 1MB.

     import logging
     import logging.config

     configdict = {
      'version': 1,    # Configuration schema in use; must be 1 for now
      'formatters': {
          'standard': {
              'format': ('%(asctime)s %(name)-15s '
                         '%(levelname)-8s %(message)s')}},

      'handlers': {'netlog': {'backupCount': 10,
                          'class': 'logging.handlers.RotatingFileHandler',
                          'filename': '/logs/network.log',
                          'formatter': 'standard',
                          'level': 'INFO',
                          'maxBytes': 1000000},
                   'syslog': {'class': 'logging.handlers.SysLogHandler',
                              'formatter': 'standard',
                              'level': 'ERROR'}},

      # Specify all the subordinate loggers
      'loggers': {
                  'network': {
                              'handlers': ['netlog']
                  }
      },
      # Specify properties of the root logger
      'root': {
               'handlers': ['syslog']
      },
     }

     # Set up configuration
     logging.config.dictConfig(configdict)

     # As an example, log two error messages
     logger = logging.getLogger('/')
     logger.error('Database not found')

     netlogger = logging.getLogger('network')
     netlogger.error('Connection failed')

Three smaller enhancements to the *note logging: aa. module, all
implemented by Vinay Sajip, are:

   * The *note SysLogHandler: a13. class now supports syslogging over
     TCP. The constructor has a `socktype' parameter giving the type of
     socket to use, either *note socket.SOCK_DGRAM: c7c. for UDP or
     *note socket.SOCK_STREAM: c7d. for TCP. The default protocol
     remains UDP.

   * *note Logger: 39c. instances gained a *note getChild(): c7e. method
     that retrieves a descendant logger using a relative path.  For
     example, once you retrieve a logger by doing ‘log =
     getLogger('app')’, calling ‘log.getChild('network.listen')’ is
     equivalent to ‘getLogger('app.network.listen')’.

   * The *note LoggerAdapter: c7f. class gained an ‘isEnabledFor()’
     method that takes a `level' and returns whether the underlying
     logger would process a message of that level of importance.

See also
........

PEP 391(1) - Dictionary-Based Configuration For Logging

     PEP written and implemented by Vinay Sajip.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0391


File: python.info,  Node: PEP 3106 Dictionary Views,  Next: PEP 3137 The memoryview Object,  Prev: PEP 391 Dictionary-Based Configuration For Logging,  Up: What’s New in Python 2 7

1.10.8 PEP 3106: Dictionary Views
---------------------------------

The dictionary methods *note keys(): c1d, *note values(): c1f, and *note
items(): c1e. are different in Python 3.x.  They return an object called
a `view' instead of a fully materialized list.

It’s not possible to change the return values of *note keys(): c1d,
*note values(): c1f, and *note items(): c1e. in Python 2.7 because too
much code would break.  Instead the 3.x versions were added under the
new names ‘viewkeys()’, ‘viewvalues()’, and ‘viewitems()’.

     >>> d = dict((i*10, chr(65+i)) for i in range(26))
     >>> d
     {0: 'A', 130: 'N', 10: 'B', 140: 'O', 20: ..., 250: 'Z'}
     >>> d.viewkeys()
     dict_keys([0, 130, 10, 140, 20, 150, 30, ..., 250])

Views can be iterated over, but the key and item views also behave like
sets.  The ‘&’ operator performs intersection, and ‘|’ performs a union:

     >>> d1 = dict((i*10, chr(65+i)) for i in range(26))
     >>> d2 = dict((i**.5, i) for i in range(1000))
     >>> d1.viewkeys() & d2.viewkeys()
     set([0.0, 10.0, 20.0, 30.0])
     >>> d1.viewkeys() | range(0, 30)
     set([0, 1, 130, 3, 4, 5, 6, ..., 120, 250])

The view keeps track of the dictionary and its contents change as the
dictionary is modified:

     >>> vk = d.viewkeys()
     >>> vk
     dict_keys([0, 130, 10, ..., 250])
     >>> d[260] = '&'
     >>> vk
     dict_keys([0, 130, 260, 10, ..., 250])

However, note that you can’t add or remove keys while you’re iterating
over the view:

     >>> for k in vk:
     ...     d[k*2] = k
     ...
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     RuntimeError: dictionary changed size during iteration

You can use the view methods in Python 2.x code, and the 2to3 converter
will change them to the standard *note keys(): c1d, *note values(): c1f,
and *note items(): c1e. methods.

See also
........

PEP 3106(1) - Revamping dict.keys(), .values() and .items()

     PEP written by Guido van Rossum.  Backported to 2.7 by Alexandre
     Vassalotti; bpo-1967(2).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3106

   (2) https://bugs.python.org/issue1967


File: python.info,  Node: PEP 3137 The memoryview Object,  Next: Other Language Changes<9>,  Prev: PEP 3106 Dictionary Views,  Up: What’s New in Python 2 7

1.10.9 PEP 3137: The memoryview Object
--------------------------------------

The *note memoryview: 25a. object provides a view of another object’s
memory content that matches the *note bytes: 326. type’s interface.

     >>> import string
     >>> m = memoryview(string.letters)
     >>> m
     <memory at 0x37f850>
     >>> len(m)           # Returns length of underlying object
     52
     >>> m[0], m[25], m[26]   # Indexing returns one byte
     ('a', 'z', 'A')
     >>> m2 = m[0:26]         # Slicing returns another memoryview
     >>> m2
     <memory at 0x37f080>

The content of the view can be converted to a string of bytes or a list
of integers:

     >>> m2.tobytes()
     'abcdefghijklmnopqrstuvwxyz'
     >>> m2.tolist()
     [97, 98, 99, 100, 101, 102, 103, ... 121, 122]
     >>>

*note memoryview: 25a. objects allow modifying the underlying object if
it’s a mutable object.

     >>> m2[0] = 75
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: cannot modify read-only memory
     >>> b = bytearray(string.letters)  # Creating a mutable object
     >>> b
     bytearray(b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
     >>> mb = memoryview(b)
     >>> mb[0] = '*'         # Assign to view, changing the bytearray.
     >>> b[0:5]              # The bytearray has been changed.
     bytearray(b'*bcde')
     >>>

See also
........

PEP 3137(1) - Immutable Bytes and Mutable Buffer

     PEP written by Guido van Rossum.  Implemented by Travis Oliphant,
     Antoine Pitrou and others.  Backported to 2.7 by Antoine Pitrou;
     bpo-2396(2).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3137

   (2) https://bugs.python.org/issue2396


File: python.info,  Node: Other Language Changes<9>,  Next: New and Improved Modules,  Prev: PEP 3137 The memoryview Object,  Up: What’s New in Python 2 7

1.10.10 Other Language Changes
------------------------------

Some smaller changes made to the core Python language are:

   * The syntax for set literals has been backported from Python 3.x.
     Curly brackets are used to surround the contents of the resulting
     mutable set; set literals are distinguished from dictionaries by
     not containing colons and values.  ‘{}’ continues to represent an
     empty dictionary; use ‘set()’ for an empty set.

          >>> {1, 2, 3, 4, 5}
          set([1, 2, 3, 4, 5])
          >>> set() # empty set
          set([])
          >>> {}    # empty dict
          {}

     Backported by Alexandre Vassalotti; bpo-2335(1).

   * Dictionary and set comprehensions are another feature backported
     from 3.x, generalizing list/generator comprehensions to use the
     literal syntax for sets and dictionaries.

          >>> {x: x*x for x in range(6)}
          {0: 0, 1: 1, 2: 4, 3: 9, 4: 16, 5: 25}
          >>> {('a'*x) for x in range(6)}
          set(['', 'a', 'aa', 'aaa', 'aaaa', 'aaaaa'])

     Backported by Alexandre Vassalotti; bpo-2333(2).

   * The *note with: 6dd. statement can now use multiple context
     managers in one statement.  Context managers are processed from
     left to right and each one is treated as beginning a new ‘with’
     statement.  This means that:

          with A() as a, B() as b:
              ... suite of statements ...

     is equivalent to:

          with A() as a:
              with B() as b:
                  ... suite of statements ...

     The ‘contextlib.nested()’ function provides a very similar
     function, so it’s no longer necessary and has been deprecated.

     (Proposed in ‘https://codereview.appspot.com/53094’; implemented by
     Georg Brandl.)

   * Conversions between floating-point numbers and strings are now
     correctly rounded on most platforms.  These conversions occur in
     many different places: *note str(): 325. on floats and complex
     numbers; the *note float: 187. and *note complex: 189.
     constructors; numeric formatting; serializing and deserializing
     floats and complex numbers using the *note marshal: b0, *note
     pickle: ca. and *note json: a4. modules; parsing of float and
     imaginary literals in Python code; and *note Decimal: 188.-to-float
     conversion.

     Related to this, the *note repr(): 7c0. of a floating-point number
     `x' now returns a result based on the shortest decimal string
     that’s guaranteed to round back to `x' under correct rounding (with
     round-half-to-even rounding mode).  Previously it gave a string
     based on rounding x to 17 decimal digits.

     The rounding library responsible for this improvement works on
     Windows and on Unix platforms using the gcc, icc, or suncc
     compilers.  There may be a small number of platforms where correct
     operation of this code cannot be guaranteed, so the code is not
     used on such systems.  You can find out which code is being used by
     checking *note sys.float_repr_style: c83, which will be ‘short’ if
     the new code is in use and ‘legacy’ if it isn’t.

     Implemented by Eric Smith and Mark Dickinson, using David Gay’s
     ‘dtoa.c’ library; bpo-7117(3).

   * Conversions from long integers and regular integers to floating
     point now round differently, returning the floating-point number
     closest to the number.  This doesn’t matter for small integers that
     can be converted exactly, but for large numbers that will
     unavoidably lose precision, Python 2.7 now approximates more
     closely.  For example, Python 2.6 computed the following:

          >>> n = 295147905179352891391
          >>> float(n)
          2.9514790517935283e+20
          >>> n - long(float(n))
          65535L

     Python 2.7’s floating-point result is larger, but much closer to
     the true value:

          >>> n = 295147905179352891391
          >>> float(n)
          2.9514790517935289e+20
          >>> n - long(float(n))
          -1L

     (Implemented by Mark Dickinson; bpo-3166(4).)

     Integer division is also more accurate in its rounding behaviours.
     (Also implemented by Mark Dickinson; bpo-1811(5).)

   * Implicit coercion for complex numbers has been removed; the
     interpreter will no longer ever attempt to call a ‘__coerce__()’
     method on complex objects.  (Removed by Meador Inge and Mark
     Dickinson; bpo-5211(6).)

   * The *note str.format(): 4cf. method now supports automatic
     numbering of the replacement fields.  This makes using *note
     str.format(): 4cf. more closely resemble using ‘%s’ formatting:

          >>> '{}:{}:{}'.format(2009, 04, 'Sunday')
          '2009:4:Sunday'
          >>> '{}:{}:{day}'.format(2009, 4, day='Sunday')
          '2009:4:Sunday'

     The auto-numbering takes the fields from left to right, so the
     first ‘{...}’ specifier will use the first argument to *note
     str.format(): 4cf, the next specifier will use the next argument,
     and so on.  You can’t mix auto-numbering and explicit numbering –
     either number all of your specifier fields or none of them – but
     you can mix auto-numbering and named fields, as in the second
     example above.  (Contributed by Eric Smith; bpo-5237(7).)

     Complex numbers now correctly support usage with *note format():
     4d0, and default to being right-aligned.  Specifying a precision or
     comma-separation applies to both the real and imaginary parts of
     the number, but a specified field width and alignment is applied to
     the whole of the resulting ‘1.5+3j’ output.  (Contributed by Eric
     Smith; bpo-1588(8) and bpo-7988(9).)

     The ‘F’ format code now always formats its output using uppercase
     characters, so it will now produce ‘INF’ and ‘NAN’.  (Contributed
     by Eric Smith; bpo-3382(10).)

     A low-level change: the *note object.__format__(): 942. method now
     triggers a *note PendingDeprecationWarning: 277. if it’s passed a
     format string, because the *note __format__(): 942. method for
     *note object: 2ae. converts the object to a string representation
     and formats that.  Previously the method silently applied the
     format string to the string representation, but that could hide
     mistakes in Python code.  If you’re supplying formatting
     information such as an alignment or precision, presumably you’re
     expecting the formatting to be applied in some object-specific way.
     (Fixed by Eric Smith; bpo-7994(11).)

   * The *note int(): 184. and ‘long()’ types gained a ‘bit_length’
     method that returns the number of bits necessary to represent its
     argument in binary:

          >>> n = 37
          >>> bin(n)
          '0b100101'
          >>> n.bit_length()
          6
          >>> n = 2**123-1
          >>> n.bit_length()
          123
          >>> (n+1).bit_length()
          124

     (Contributed by Fredrik Johansson and Victor Stinner;
     bpo-3439(12).)

   * The *note import: c10. statement will no longer try an absolute
     import if a relative import (e.g.  ‘from .os import sep’) fails.
     This fixes a bug, but could possibly break certain ‘import’
     statements that were only working by accident.  (Fixed by Meador
     Inge; bpo-7902(13).)

   * It’s now possible for a subclass of the built-in ‘unicode’ type to
     override the ‘__unicode__()’ method.  (Implemented by Victor
     Stinner; bpo-1583863(14).)

   * The *note bytearray: 327. type’s *note translate(): c84. method now
     accepts ‘None’ as its first argument.  (Fixed by Georg Brandl;
     bpo-4759(15).)

   * When using ‘@classmethod’ and ‘@staticmethod’ to wrap methods as
     class or static methods, the wrapper object now exposes the wrapped
     function as their ‘__func__’ attribute.  (Contributed by Amaury
     Forgeot d’Arc, after a suggestion by George Sakkis; bpo-5982(16).)

   * When a restricted set of attributes were set using ‘__slots__’,
     deleting an unset attribute would not raise *note AttributeError:
     390. as you would expect.  Fixed by Benjamin Peterson;
     bpo-7604(17).)

   * Two new encodings are now supported: “cp720”, used primarily for
     Arabic text; and “cp858”, a variant of CP 850 that adds the euro
     symbol.  (CP720 contributed by Alexander Belchenko and Amaury
     Forgeot d’Arc in bpo-1616979(18); CP858 contributed by Tim Hatch in
     bpo-8016(19).)

   * The ‘file’ object will now set the ‘filename’ attribute on the
     *note IOError: 986. exception when trying to open a directory on
     POSIX platforms (noted by Jan Kaliszewski; bpo-4764(20)), and now
     explicitly checks for and forbids writing to read-only file objects
     instead of trusting the C library to catch and report the error
     (fixed by Stefan Krah; bpo-5677(21)).

   * The Python tokenizer now translates line endings itself, so the
     *note compile(): 1b2. built-in function now accepts code using any
     line-ending convention.  Additionally, it no longer requires that
     the code end in a newline.

   * Extra parentheses in function definitions are illegal in Python
     3.x, meaning that you get a syntax error from ‘def f((x)): pass’.
     In Python3-warning mode, Python 2.7 will now warn about this odd
     usage.  (Noted by James Lingard; bpo-7362(22).)

   * It’s now possible to create weak references to old-style class
     objects.  New-style classes were always weak-referenceable.  (Fixed
     by Antoine Pitrou; bpo-8268(23).)

   * When a module object is garbage-collected, the module’s dictionary
     is now only cleared if no one else is holding a reference to the
     dictionary (bpo-7140(24)).

* Menu:

* Interpreter Changes::
* Optimizations: Optimizations<8>.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2335

   (2) https://bugs.python.org/issue2333

   (3) https://bugs.python.org/issue7117

   (4) https://bugs.python.org/issue3166

   (5) https://bugs.python.org/issue1811

   (6) https://bugs.python.org/issue5211

   (7) https://bugs.python.org/issue5237

   (8) https://bugs.python.org/issue1588

   (9) https://bugs.python.org/issue7988

   (10) https://bugs.python.org/issue3382

   (11) https://bugs.python.org/issue7994

   (12) https://bugs.python.org/issue3439

   (13) https://bugs.python.org/issue7902

   (14) https://bugs.python.org/issue1583863

   (15) https://bugs.python.org/issue4759

   (16) https://bugs.python.org/issue5982

   (17) https://bugs.python.org/issue7604

   (18) https://bugs.python.org/issue1616979

   (19) https://bugs.python.org/issue8016

   (20) https://bugs.python.org/issue4764

   (21) https://bugs.python.org/issue5677

   (22) https://bugs.python.org/issue7362

   (23) https://bugs.python.org/issue8268

   (24) https://bugs.python.org/issue7140


File: python.info,  Node: Interpreter Changes,  Next: Optimizations<8>,  Up: Other Language Changes<9>

1.10.10.1 Interpreter Changes
.............................

A new environment variable, *note PYTHONWARNINGS: 40d, allows
controlling warnings.  It should be set to a string containing warning
settings, equivalent to those used with the *note -W: 40c. switch,
separated by commas.  (Contributed by Brian Curtin; bpo-7301(1).)

For example, the following setting will print warnings every time they
occur, but turn warnings from the ‘Cookie’ module into an error.  (The
exact syntax for setting an environment variable varies across operating
systems and shells.)

     export PYTHONWARNINGS=all,error:::Cookie:0

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue7301


File: python.info,  Node: Optimizations<8>,  Prev: Interpreter Changes,  Up: Other Language Changes<9>

1.10.10.2 Optimizations
.......................

Several performance enhancements have been added:

   * A new opcode was added to perform the initial setup for *note with:
     6dd. statements, looking up the *note __enter__(): c88. and *note
     __exit__(): c89. methods.  (Contributed by Benjamin Peterson.)

   * The garbage collector now performs better for one common usage
     pattern: when many objects are being allocated without deallocating
     any of them.  This would previously take quadratic time for garbage
     collection, but now the number of full garbage collections is
     reduced as the number of objects on the heap grows.  The new logic
     only performs a full garbage collection pass when the middle
     generation has been collected 10 times and when the number of
     survivor objects from the middle generation exceeds 10% of the
     number of objects in the oldest generation.  (Suggested by Martin
     von Löwis and implemented by Antoine Pitrou; bpo-4074(1).)

   * The garbage collector tries to avoid tracking simple containers
     which can’t be part of a cycle.  In Python 2.7, this is now true
     for tuples and dicts containing atomic types (such as ints,
     strings, etc.).  Transitively, a dict containing tuples of atomic
     types won’t be tracked either.  This helps reduce the cost of each
     garbage collection by decreasing the number of objects to be
     considered and traversed by the collector.  (Contributed by Antoine
     Pitrou; bpo-4688(2).)

   * Long integers are now stored internally either in base 2**15 or in
     base 2**30, the base being determined at build time.  Previously,
     they were always stored in base 2**15.  Using base 2**30 gives
     significant performance improvements on 64-bit machines, but
     benchmark results on 32-bit machines have been mixed.  Therefore,
     the default is to use base 2**30 on 64-bit machines and base 2**15
     on 32-bit machines; on Unix, there’s a new configure option
     ‘--enable-big-digits’ that can be used to override this default.

     Apart from the performance improvements this change should be
     invisible to end users, with one exception: for testing and
     debugging purposes there’s a new structseq ‘sys.long_info’ that
     provides information about the internal format, giving the number
     of bits per digit and the size in bytes of the C type used to store
     each digit:

          >>> import sys
          >>> sys.long_info
          sys.long_info(bits_per_digit=30, sizeof_digit=4)

     (Contributed by Mark Dickinson; bpo-4258(3).)

     Another set of changes made long objects a few bytes smaller: 2
     bytes smaller on 32-bit systems and 6 bytes on 64-bit.
     (Contributed by Mark Dickinson; bpo-5260(4).)

   * The division algorithm for long integers has been made faster by
     tightening the inner loop, doing shifts instead of multiplications,
     and fixing an unnecessary extra iteration.  Various benchmarks show
     speedups of between 50% and 150% for long integer divisions and
     modulo operations.  (Contributed by Mark Dickinson; bpo-5512(5).)
     Bitwise operations are also significantly faster (initial patch by
     Gregory Smith; bpo-1087418(6)).

   * The implementation of ‘%’ checks for the left-side operand being a
     Python string and special-cases it; this results in a 1–3%
     performance increase for applications that frequently use ‘%’ with
     strings, such as templating libraries.  (Implemented by Collin
     Winter; bpo-5176(7).)

   * List comprehensions with an ‘if’ condition are compiled into faster
     bytecode.  (Patch by Antoine Pitrou, back-ported to 2.7 by Jeffrey
     Yasskin; bpo-4715(8).)

   * Converting an integer or long integer to a decimal string was made
     faster by special-casing base 10 instead of using a generalized
     conversion function that supports arbitrary bases.  (Patch by
     Gawain Bolton; bpo-6713(9).)

   * The ‘split()’, ‘replace()’, ‘rindex()’, ‘rpartition()’, and
     ‘rsplit()’ methods of string-like types (strings, Unicode strings,
     and *note bytearray: 327. objects) now use a fast reverse-search
     algorithm instead of a character-by-character scan.  This is
     sometimes faster by a factor of 10.  (Added by Florent Xicluna;
     bpo-7462(10) and bpo-7622(11).)

   * The *note pickle: ca. and ‘cPickle’ modules now automatically
     intern the strings used for attribute names, reducing memory usage
     of the objects resulting from unpickling.  (Contributed by Jake
     McGuire; bpo-5084(12).)

   * The ‘cPickle’ module now special-cases dictionaries, nearly halving
     the time required to pickle them.  (Contributed by Collin Winter;
     bpo-5670(13).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4074

   (2) https://bugs.python.org/issue4688

   (3) https://bugs.python.org/issue4258

   (4) https://bugs.python.org/issue5260

   (5) https://bugs.python.org/issue5512

   (6) https://bugs.python.org/issue1087418

   (7) https://bugs.python.org/issue5176

   (8) https://bugs.python.org/issue4715

   (9) https://bugs.python.org/issue6713

   (10) https://bugs.python.org/issue7462

   (11) https://bugs.python.org/issue7622

   (12) https://bugs.python.org/issue5084

   (13) https://bugs.python.org/issue5670


File: python.info,  Node: New and Improved Modules,  Next: Build and C API Changes<8>,  Prev: Other Language Changes<9>,  Up: What’s New in Python 2 7

1.10.11 New and Improved Modules
--------------------------------

As in every release, Python’s standard library received a number of
enhancements and bug fixes.  Here’s a partial list of the most notable
changes, sorted alphabetically by module name.  Consult the ‘Misc/NEWS’
file in the source tree for a more complete list of changes, or look
through the Subversion logs for all the details.

   * The *note bdb: f. module’s base debugging class *note Bdb: c8b.
     gained a feature for skipping modules.  The constructor now takes
     an iterable containing glob-style patterns such as ‘django.*’; the
     debugger will not step into stack frames from a module that matches
     one of these patterns.  (Contributed by Maru Newby after a
     suggestion by Senthil Kumaran; bpo-5142(1).)

   * The *note binascii: 10. module now supports the buffer API, so it
     can be used with *note memoryview: 25a. instances and other similar
     buffer objects.  (Backported from 3.x by Florent Xicluna;
     bpo-7703(2).)

   * Updated module: the ‘bsddb’ module has been updated from
     4.7.2devel9 to version 4.8.4 of the pybsddb package(3).  The new
     version features better Python 3.x compatibility, various bug
     fixes, and adds several new BerkeleyDB flags and methods.  (Updated
     by Jesús Cea Avión; bpo-8156(4).  The pybsddb changelog can be read
     at ‘http://hg.jcea.es/pybsddb/file/tip/ChangeLog’.)

   * The *note bz2: 14. module’s *note BZ2File: 925. now supports the
     context management protocol, so you can write ‘with
     bz2.BZ2File(...) as f:’.  (Contributed by Hagen Fürstenau;
     bpo-3860(5).)

   * New class: the *note Counter: 9ce. class in the *note collections:
     1e. module is useful for tallying data.  *note Counter: 9ce.
     instances behave mostly like dictionaries but return zero for
     missing keys instead of raising a *note KeyError: 2c5.:

          >>> from collections import Counter
          >>> c = Counter()
          >>> for letter in 'here is a sample of english text':
          ...   c[letter] += 1
          ...
          >>> c
          Counter({' ': 6, 'e': 5, 's': 3, 'a': 2, 'i': 2, 'h': 2,
          'l': 2, 't': 2, 'g': 1, 'f': 1, 'm': 1, 'o': 1, 'n': 1,
          'p': 1, 'r': 1, 'x': 1})
          >>> c['e']
          5
          >>> c['z']
          0

     There are three additional *note Counter: 9ce. methods.  *note
     most_common(): c8c. returns the N most common elements and their
     counts.  *note elements(): c8d. returns an iterator over the
     contained elements, repeating each element as many times as its
     count.  *note subtract(): b4d. takes an iterable and subtracts one
     for each element instead of adding; if the argument is a dictionary
     or another ‘Counter’, the counts are subtracted.

          >>> c.most_common(5)
          [(' ', 6), ('e', 5), ('s', 3), ('a', 2), ('i', 2)]
          >>> c.elements() ->
             'a', 'a', ' ', ' ', ' ', ' ', ' ', ' ',
             'e', 'e', 'e', 'e', 'e', 'g', 'f', 'i', 'i',
             'h', 'h', 'm', 'l', 'l', 'o', 'n', 'p', 's',
             's', 's', 'r', 't', 't', 'x'
          >>> c['e']
          5
          >>> c.subtract('very heavy on the letter e')
          >>> c['e']    # Count is now lower
          -1

     Contributed by Raymond Hettinger; bpo-1696199(6).

     New class: *note OrderedDict: 1b7. is described in the earlier
     section *note PEP 372; Adding an Ordered Dictionary to collections:
     c73.

     New method: The *note deque: 526. data type now has a *note
     count(): b4f. method that returns the number of contained elements
     equal to the supplied argument `x', and a *note reverse(): b50.
     method that reverses the elements of the deque in-place.  *note
     deque: 526. also exposes its maximum length as the read-only *note
     maxlen: c8e. attribute.  (Both features added by Raymond
     Hettinger.)

     The *note namedtuple: 1b5. class now has an optional `rename'
     parameter.  If `rename' is true, field names that are invalid
     because they’ve been repeated or aren’t legal Python identifiers
     will be renamed to legal names that are derived from the field’s
     position within the list of fields:

          >>> from collections import namedtuple
          >>> T = namedtuple('T', ['field1', '$illegal', 'for', 'field2'], rename=True)
          >>> T._fields
          ('field1', '_1', '_2', 'field2')

     (Added by Raymond Hettinger; bpo-1818(7).)

     Finally, the ‘Mapping’ abstract base class now returns *note
     NotImplemented: 840. if a mapping is compared to another type that
     isn’t a ‘Mapping’.  (Fixed by Daniel Stutzbach; bpo-8729(8).)

   * Constructors for the parsing classes in the ‘ConfigParser’ module
     now take an `allow_no_value' parameter, defaulting to false; if
     true, options without values will be allowed.  For example:

          >>> import ConfigParser, StringIO
          >>> sample_config = """
          ... [mysqld]
          ... user = mysql
          ... pid-file = /var/run/mysqld/mysqld.pid
          ... skip-bdb
          ... """
          >>> config = ConfigParser.RawConfigParser(allow_no_value=True)
          >>> config.readfp(StringIO.StringIO(sample_config))
          >>> config.get('mysqld', 'user')
          'mysql'
          >>> print config.get('mysqld', 'skip-bdb')
          None
          >>> print config.get('mysqld', 'unknown')
          Traceback (most recent call last):
            ...
          NoOptionError: No option 'unknown' in section: 'mysqld'

     (Contributed by Mats Kindahl; bpo-7005(9).)

   * Deprecated function: ‘contextlib.nested()’, which allows handling
     more than one context manager with a single *note with: 6dd.
     statement, has been deprecated, because the ‘with’ statement now
     supports multiple context managers.

   * The ‘cookielib’ module now ignores cookies that have an invalid
     version field, one that doesn’t contain an integer value.  (Fixed
     by John J. Lee; bpo-3924(10).)

   * The *note copy: 26. module’s *note deepcopy(): 3c1. function will
     now correctly copy bound instance methods.  (Implemented by Robert
     Collins; bpo-1515(11).)

   * The *note ctypes: 2b. module now always converts ‘None’ to a C
     ‘NULL’ pointer for arguments declared as pointers.  (Changed by
     Thomas Heller; bpo-4606(12).)  The underlying libffi library(13)
     has been updated to version 3.0.9, containing various fixes for
     different platforms.  (Updated by Matthias Klose; bpo-8142(14).)

   * New method: the *note datetime: 31. module’s *note timedelta: 195.
     class gained a *note total_seconds(): c8f. method that returns the
     number of seconds in the duration.  (Contributed by Brian Quinlan;
     bpo-5788(15).)

   * New method: the *note Decimal: 188. class gained a *note
     from_float(): b73. class method that performs an exact conversion
     of a floating-point number to a *note Decimal: 188.  This exact
     conversion strives for the closest decimal approximation to the
     floating-point representation’s value; the resulting decimal value
     will therefore still include the inaccuracy, if any.  For example,
     ‘Decimal.from_float(0.1)’ returns
     ‘Decimal('0.1000000000000000055511151231257827021181583404541015625')’.
     (Implemented by Raymond Hettinger; bpo-4796(16).)

     Comparing instances of *note Decimal: 188. with floating-point
     numbers now produces sensible results based on the numeric values
     of the operands.  Previously such comparisons would fall back to
     Python’s default rules for comparing objects, which produced
     arbitrary results based on their type.  Note that you still cannot
     combine ‘Decimal’ and floating-point in other operations such as
     addition, since you should be explicitly choosing how to convert
     between float and *note Decimal: 188.  (Fixed by Mark Dickinson;
     bpo-2531(17).)

     The constructor for *note Decimal: 188. now accepts floating-point
     numbers (added by Raymond Hettinger; bpo-8257(18)) and non-European
     Unicode characters such as Arabic-Indic digits (contributed by Mark
     Dickinson; bpo-6595(19)).

     Most of the methods of the *note Context: 9e4. class now accept
     integers as well as *note Decimal: 188. instances; the only
     exceptions are the *note canonical(): c90. and *note
     is_canonical(): c91. methods.  (Patch by Juan José Conti;
     bpo-7633(20).)

     When using *note Decimal: 188. instances with a string’s *note
     format(): 4cf. method, the default alignment was previously
     left-alignment.  This has been changed to right-alignment, which is
     more sensible for numeric types.  (Changed by Mark Dickinson;
     bpo-6857(21).)

     Comparisons involving a signaling NaN value (or ‘sNAN’) now signal
     ‘InvalidOperation’ instead of silently returning a true or false
     value depending on the comparison operator.  Quiet NaN values (or
     ‘NaN’) are now hashable.  (Fixed by Mark Dickinson; bpo-7279(22).)

   * The *note difflib: 37. module now produces output that is more
     compatible with modern ‘diff’/‘patch’ tools through one small
     change, using a tab character instead of spaces as a separator in
     the header giving the filename.  (Fixed by Anatoly Techtonik;
     bpo-7585(23).)

   * The Distutils ‘sdist’ command now always regenerates the ‘MANIFEST’
     file, since even if the ‘MANIFEST.in’ or ‘setup.py’ files haven’t
     been modified, the user might have created some new files that
     should be included.  (Fixed by Tarek Ziadé; bpo-8688(24).)

   * The *note doctest: 67. module’s ‘IGNORE_EXCEPTION_DETAIL’ flag will
     now ignore the name of the module containing the exception being
     tested.  (Patch by Lennart Regebro; bpo-7490(25).)

   * The *note email: 69. module’s *note Message: 536. class will now
     accept a Unicode-valued payload, automatically converting the
     payload to the encoding specified by ‘output_charset’.  (Added by
     R. David Murray; bpo-1368247(26).)

   * The *note Fraction: 185. class now accepts a single float or *note
     Decimal: 188. instance, or two rational numbers, as arguments to
     its constructor.  (Implemented by Mark Dickinson; rationals added
     in bpo-5812(27), and float/decimal in bpo-8294(28).)

     Ordering comparisons (‘<’, ‘<=’, ‘>’, ‘>=’) between fractions and
     complex numbers now raise a *note TypeError: 192.  This fixes an
     oversight, making the *note Fraction: 185. match the other numeric
     types.

   * New class: *note FTP_TLS: 9f8. in the *note ftplib: 84. module
     provides secure FTP connections using TLS encapsulation of
     authentication as well as subsequent control and data transfers.
     (Contributed by Giampaolo Rodola; bpo-2054(29).)

     The *note storbinary(): c92. method for binary uploads can now
     restart uploads thanks to an added `rest' parameter (patch by Pablo
     Mouzo; bpo-6845(30).)

   * New class decorator: *note total_ordering(): 83f. in the *note
     functools: 85. module takes a class that defines an *note __eq__():
     334. method and one of *note __lt__(): c27, *note __le__(): c93,
     *note __gt__(): c94, or *note __ge__(): c95, and generates the
     missing comparison methods.  Since the ‘__cmp__()’ method is being
     deprecated in Python 3.x, this decorator makes it easier to define
     ordered classes.  (Added by Raymond Hettinger; bpo-5479(31).)

     New function: *note cmp_to_key(): b49. will take an old-style
     comparison function that expects two arguments and return a new
     callable that can be used as the `key' parameter to functions such
     as *note sorted(): 439, *note min(): 7fd. and *note max(): 7fe,
     etc.  The primary intended use is to help with making code
     compatible with Python 3.x.  (Added by Raymond Hettinger.)

   * New function: the *note gc: 86. module’s *note is_tracked(): c96.
     returns true if a given instance is tracked by the garbage
     collector, false otherwise.  (Contributed by Antoine Pitrou;
     bpo-4688(32).)

   * The *note gzip: 8c. module’s *note GzipFile: 6d1. now supports the
     context management protocol, so you can write ‘with
     gzip.GzipFile(...) as f:’ (contributed by Hagen Fürstenau;
     bpo-3860(33)), and it now implements the *note io.BufferedIOBase:
     57d. ABC, so you can wrap it with *note io.BufferedReader: b7d. for
     faster processing (contributed by Nir Aides; bpo-7471(34)).  It’s
     also now possible to override the modification time recorded in a
     gzipped file by providing an optional timestamp to the constructor.
     (Contributed by Jacques Frechet; bpo-4272(35).)

     Files in gzip format can be padded with trailing zero bytes; the
     *note gzip: 8c. module will now consume these trailing bytes.
     (Fixed by Tadek Pietraszek and Brian Curtin; bpo-2846(36).)

   * New attribute: the *note hashlib: 8d. module now has an
     ‘algorithms’ attribute containing a tuple naming the supported
     algorithms.  In Python 2.7, ‘hashlib.algorithms’ contains ‘('md5',
     'sha1', 'sha224', 'sha256', 'sha384', 'sha512')’.  (Contributed by
     Carl Chenet; bpo-7418(37).)

   * The default ‘HTTPResponse’ class used by the ‘httplib’ module now
     supports buffering, resulting in much faster reading of HTTP
     responses.  (Contributed by Kristján Valur Jónsson; bpo-4879(38).)

     The ‘HTTPConnection’ and ‘HTTPSConnection’ classes now support a
     `source_address' parameter, a ‘(host, port)’ 2-tuple giving the
     source address that will be used for the connection.  (Contributed
     by Eldon Ziegler; bpo-3972(39).)

   * The ‘ihooks’ module now supports relative imports.  Note that
     ‘ihooks’ is an older module for customizing imports, superseded by
     the ‘imputil’ module added in Python 2.0.  (Relative import support
     added by Neil Schemenauer.)

   * The *note imaplib: 98. module now supports IPv6 addresses.
     (Contributed by Derek Morr; bpo-1655(40).)

   * New function: the *note inspect: a0. module’s *note getcallargs():
     7aa. takes a callable and its positional and keyword arguments, and
     figures out which of the callable’s parameters will receive each
     argument, returning a dictionary mapping argument names to their
     values.  For example:

          >>> from inspect import getcallargs
          >>> def f(a, b=1, *pos, **named):
          ...     pass
          >>> getcallargs(f, 1, 2, 3)
          {'a': 1, 'b': 2, 'pos': (3,), 'named': {}}
          >>> getcallargs(f, a=2, x=4)
          {'a': 2, 'b': 1, 'pos': (), 'named': {'x': 4}}
          >>> getcallargs(f)
          Traceback (most recent call last):
          ...
          TypeError: f() takes at least 1 argument (0 given)

     Contributed by George Sakkis; bpo-3135(41).

   * Updated module: The *note io: a1. library has been upgraded to the
     version shipped with Python 3.1.  For 3.1, the I/O library was
     entirely rewritten in C and is 2 to 20 times faster depending on
     the task being performed.  The original Python version was renamed
     to the ‘_pyio’ module.

     One minor resulting change: the *note io.TextIOBase: c2c. class now
     has an ‘errors’ attribute giving the error setting used for
     encoding and decoding errors (one of ‘'strict'’, ‘'replace'’,
     ‘'ignore'’).

     The *note io.FileIO: c97. class now raises an *note OSError: 1d1.
     when passed an invalid file descriptor.  (Implemented by Benjamin
     Peterson; bpo-4991(42).)  The *note truncate(): c98. method now
     preserves the file position; previously it would change the file
     position to the end of the new file.  (Fixed by Pascal Chambon;
     bpo-6939(43).)

   * New function: ‘itertools.compress(data, selectors)’ takes two
     iterators.  Elements of `data' are returned if the corresponding
     value in `selectors' is true:

          itertools.compress('ABCDEF', [1,0,1,0,1,1]) =>
            A, C, E, F

     New function: ‘itertools.combinations_with_replacement(iter, r)’
     returns all the possible `r'-length combinations of elements from
     the iterable `iter'.  Unlike *note combinations(): c99, individual
     elements can be repeated in the generated combinations:

          itertools.combinations_with_replacement('abc', 2) =>
            ('a', 'a'), ('a', 'b'), ('a', 'c'),
            ('b', 'b'), ('b', 'c'), ('c', 'c')

     Note that elements are treated as unique depending on their
     position in the input, not their actual values.

     The *note itertools.count(): c0e. function now has a `step'
     argument that allows incrementing by values other than 1.  *note
     count(): c0e. also now allows keyword arguments, and using
     non-integer values such as floats or *note Decimal: 188. instances.
     (Implemented by Raymond Hettinger; bpo-5032(44).)

     *note itertools.combinations(): c99. and *note itertools.product():
     c9a. previously raised *note ValueError: 1f9. for values of `r'
     larger than the input iterable.  This was deemed a specification
     error, so they now return an empty iterator.  (Fixed by Raymond
     Hettinger; bpo-4816(45).)

   * Updated module: The *note json: a4. module was upgraded to version
     2.0.9 of the simplejson package, which includes a C extension that
     makes encoding and decoding faster.  (Contributed by Bob Ippolito;
     bpo-4136(46).)

     To support the new *note collections.OrderedDict: 1b7. type, *note
     json.load(): 554. now has an optional `object_pairs_hook' parameter
     that will be called with any object literal that decodes to a list
     of pairs.  (Contributed by Raymond Hettinger; bpo-5381(47).)

   * The *note mailbox: ae. module’s *note Maildir: c9b. class now
     records the timestamp on the directories it reads, and only
     re-reads them if the modification time has subsequently changed.
     This improves performance by avoiding unneeded directory scans.
     (Fixed by A.M. Kuchling and Antoine Pitrou; bpo-1607951(48),
     bpo-6896(49).)

   * New functions: the *note math: b1. module gained *note erf(): 447.
     and *note erfc(): 448. for the error function and the complementary
     error function, *note expm1(): b5b. which computes ‘e**x - 1’ with
     more precision than using *note exp(): c9c. and subtracting 1,
     *note gamma(): b5c. for the Gamma function, and *note lgamma():
     b5d. for the natural log of the Gamma function.  (Contributed by
     Mark Dickinson and nirinA raseliarison; bpo-3366(50).)

   * The *note multiprocessing: b7. module’s ‘Manager*’ classes can now
     be passed a callable that will be called whenever a subprocess is
     started, along with a set of arguments that will be passed to the
     callable.  (Contributed by lekma; bpo-5585(51).)

     The ‘Pool’ class, which controls a pool of worker processes, now
     has an optional `maxtasksperchild' parameter.  Worker processes
     will perform the specified number of tasks and then exit, causing
     the ‘Pool’ to start a new worker.  This is useful if tasks may leak
     memory or other resources, or if some tasks will cause the worker
     to become very large.  (Contributed by Charles Cazabon;
     bpo-6963(52).)

   * The *note nntplib: c0. module now supports IPv6 addresses.
     (Contributed by Derek Morr; bpo-1664(53).)

   * New functions: the *note os: c4. module wraps the following POSIX
     system calls: *note getresgid(): c9d. and *note getresuid(): c9e,
     which return the real, effective, and saved GIDs and UIDs; *note
     setresgid(): c9f. and *note setresuid(): ca0, which set real,
     effective, and saved GIDs and UIDs to new values; *note
     initgroups(): ca1, which initialize the group access list for the
     current process.  (GID/UID functions contributed by Travis H.;
     bpo-6508(54).  Support for initgroups added by Jean-Paul Calderone;
     bpo-7333(55).)

     The *note os.fork(): 955. function now re-initializes the import
     lock in the child process; this fixes problems on Solaris when
     *note fork(): 955. is called from a thread.  (Fixed by Zsolt
     Cserna; bpo-7242(56).)

   * In the *note os.path: c5. module, the *note normpath(): ca2. and
     *note abspath(): ca3. functions now preserve Unicode; if their
     input path is a Unicode string, the return value is also a Unicode
     string.  (*note normpath(): ca2. fixed by Matt Giuca in
     bpo-5827(57); *note abspath(): ca3. fixed by Ezio Melotti in
     bpo-3426(58).)

   * The *note pydoc: d9. module now has help for the various symbols
     that Python uses.  You can now do ‘help('<<')’ or ‘help('@')’, for
     example.  (Contributed by David Laban; bpo-4739(59).)

   * The *note re: dd. module’s *note split(): 3bf, *note sub(): 470,
     and *note subn(): 728. now accept an optional `flags' argument, for
     consistency with the other functions in the module.  (Added by
     Gregory P. Smith.)

   * New function: *note run_path(): ca4. in the *note runpy: e2. module
     will execute the code at a provided `path' argument.  `path' can be
     the path of a Python source file (‘example.py’), a compiled
     bytecode file (‘example.pyc’), a directory (‘./package/’), or a zip
     archive (‘example.zip’).  If a directory or zip path is provided,
     it will be added to the front of ‘sys.path’ and the module *note
     __main__: 1. will be imported.  It’s expected that the directory or
     zip contains a ‘__main__.py’; if it doesn’t, some other
     ‘__main__.py’ might be imported from a location later in
     ‘sys.path’.  This makes more of the machinery of *note runpy: e2.
     available to scripts that want to mimic the way Python’s command
     line processes an explicit path name.  (Added by Nick Coghlan;
     bpo-6816(60).)

   * New function: in the *note shutil: e9. module, *note
     make_archive(): 219. takes a filename, archive type (zip or
     tar-format), and a directory path, and creates an archive
     containing the directory’s contents.  (Added by Tarek Ziadé.)

     *note shutil: e9.’s *note copyfile(): 256. and *note copytree():
     218. functions now raise a ‘SpecialFileError’ exception when asked
     to copy a named pipe.  Previously the code would treat named pipes
     like a regular file by opening them for reading, and this would
     block indefinitely.  (Fixed by Antoine Pitrou; bpo-3002(61).)

   * The *note signal: ea. module no longer re-installs the signal
     handler unless this is truly necessary, which fixes a bug that
     could make it impossible to catch the EINTR signal robustly.
     (Fixed by Charles-Francois Natali; bpo-8354(62).)

   * New functions: in the *note site: eb. module, three new functions
     return various site- and user-specific paths.  *note
     getsitepackages(): bc6. returns a list containing all global
     site-packages directories, *note getusersitepackages(): bc8.
     returns the path of the user’s site-packages directory, and *note
     getuserbase(): bc7. returns the value of the ‘USER_BASE’
     environment variable, giving the path to a directory that can be
     used to store data.  (Contributed by Tarek Ziadé; bpo-6693(63).)

     The *note site: eb. module now reports exceptions occurring when
     the ‘sitecustomize’ module is imported, and will no longer catch
     and swallow the *note KeyboardInterrupt: 197. exception.  (Fixed by
     Victor Stinner; bpo-3137(64).)

   * The *note create_connection(): b91. function gained a
     `source_address' parameter, a ‘(host, port)’ 2-tuple giving the
     source address that will be used for the connection.  (Contributed
     by Eldon Ziegler; bpo-3972(65).)

     The *note recv_into(): ca5. and *note recvfrom_into(): ca6. methods
     will now write into objects that support the buffer API, most
     usefully the *note bytearray: 327. and *note memoryview: 25a.
     objects.  (Implemented by Antoine Pitrou; bpo-8104(66).)

   * The ‘SocketServer’ module’s ‘TCPServer’ class now supports socket
     timeouts and disabling the Nagle algorithm.  The
     ‘disable_nagle_algorithm’ class attribute defaults to ‘False’; if
     overridden to be true, new request connections will have the
     TCP_NODELAY option set to prevent buffering many small sends into a
     single TCP packet.  The ‘timeout’ class attribute can hold a
     timeout in seconds that will be applied to the request socket; if
     no request is received within that time, ‘handle_timeout()’ will be
     called and ‘handle_request()’ will return.  (Contributed by
     Kristján Valur Jónsson; bpo-6192(67) and bpo-6267(68).)

   * Updated module: the *note sqlite3: f2. module has been updated to
     version 2.6.0 of the pysqlite package(69).  Version 2.6.0 includes
     a number of bugfixes, and adds the ability to load SQLite
     extensions from shared libraries.  Call the
     ‘enable_load_extension(True)’ method to enable extensions, and then
     call *note load_extension(): b8d. to load a particular shared
     library.  (Updated by Gerhard Häring.)

   * The *note ssl: f3. module’s *note SSLSocket: 3d7. objects now
     support the buffer API, which fixed a test suite failure (fix by
     Antoine Pitrou; bpo-7133(70)) and automatically set OpenSSL’s
     ‘SSL_MODE_AUTO_RETRY’, which will prevent an error code being
     returned from ‘recv()’ operations that trigger an SSL renegotiation
     (fix by Antoine Pitrou; bpo-8222(71)).

     The *note ssl.wrap_socket(): 464. constructor function now takes a
     `ciphers' argument that’s a string listing the encryption
     algorithms to be allowed; the format of the string is described in
     the OpenSSL documentation(72).  (Added by Antoine Pitrou;
     bpo-8322(73).)

     Another change makes the extension load all of OpenSSL’s ciphers
     and digest algorithms so that they’re all available.  Some SSL
     certificates couldn’t be verified, reporting an “unknown algorithm”
     error.  (Reported by Beda Kosata, and fixed by Antoine Pitrou;
     bpo-8484(74).)

     The version of OpenSSL being used is now available as the module
     attributes *note ssl.OPENSSL_VERSION: b94. (a string), *note
     ssl.OPENSSL_VERSION_INFO: b95. (a 5-tuple), and *note
     ssl.OPENSSL_VERSION_NUMBER: b96. (an integer).  (Added by Antoine
     Pitrou; bpo-8321(75).)

   * The *note struct: f8. module will no longer silently ignore
     overflow errors when a value is too large for a particular integer
     format code (one of ‘bBhHiIlLqQ’); it now always raises a *note
     struct.error: ca7. exception.  (Changed by Mark Dickinson;
     bpo-1523(76).)  The *note pack(): bfe. function will also attempt
     to use *note __index__(): 18a. to convert and pack non-integers
     before trying the *note __int__(): 18b. method or reporting an
     error.  (Changed by Mark Dickinson; bpo-8300(77).)

   * New function: the *note subprocess: f9. module’s *note
     check_output(): 8cf. runs a command with a specified set of
     arguments and returns the command’s output as a string when the
     command runs without error, or raises a *note CalledProcessError:
     ca8. exception otherwise.

          >>> subprocess.check_output(['df', '-h', '.'])
          'Filesystem     Size   Used  Avail Capacity  Mounted on\n
          /dev/disk0s2    52G    49G   3.0G    94%    /\n'

          >>> subprocess.check_output(['df', '-h', '/bogus'])
            ...
          subprocess.CalledProcessError: Command '['df', '-h', '/bogus']' returned non-zero exit status 1

     (Contributed by Gregory P. Smith.)

     The *note subprocess: f9. module will now retry its internal system
     calls on receiving an ‘EINTR’ signal.  (Reported by several people;
     final patch by Gregory P. Smith in bpo-1068268(78).)

   * New function: *note is_declared_global(): ca9. in the *note
     symtable: fc. module returns true for variables that are explicitly
     declared to be global, false for ones that are implicitly global.
     (Contributed by Jeremy Hylton.)

   * The *note syslog: ff. module will now use the value of
     ‘sys.argv[0]’ as the identifier instead of the previous default
     value of ‘'python'’.  (Changed by Sean Reifschneider;
     bpo-8451(79).)

   * The ‘sys.version_info’ value is now a named tuple, with attributes
     named ‘major’, ‘minor’, ‘micro’, ‘releaselevel’, and ‘serial’.
     (Contributed by Ross Light; bpo-4285(80).)

     *note sys.getwindowsversion(): 58a. also returns a named tuple,
     with attributes named ‘major’, ‘minor’, ‘build’, *note platform:
     ce, ‘service_pack’, ‘service_pack_major’, ‘service_pack_minor’,
     ‘suite_mask’, and ‘product_type’.  (Contributed by Brian Curtin;
     bpo-7766(81).)

   * The *note tarfile: 101. module’s default error handling has
     changed, to no longer suppress fatal errors.  The default error
     level was previously 0, which meant that errors would only result
     in a message being written to the debug log, but because the debug
     log is not activated by default, these errors go unnoticed.  The
     default error level is now 1, which raises an exception if there’s
     an error.  (Changed by Lars Gustäbel; bpo-7357(82).)

     *note tarfile: 101. now supports filtering the *note TarInfo: b80.
     objects being added to a tar file.  When you call *note add(): 471,
     you may supply an optional `filter' argument that’s a callable.
     The `filter' callable will be passed the *note TarInfo: b80. for
     every file being added, and can modify and return it.  If the
     callable returns ‘None’, the file will be excluded from the
     resulting archive.  This is more powerful than the existing
     `exclude' argument, which has therefore been deprecated.  (Added by
     Lars Gustäbel; bpo-6856(83).)  The *note TarFile: b7f. class also
     now supports the context management protocol.  (Added by Lars
     Gustäbel; bpo-7232(84).)

   * The *note wait(): caa. method of the *note threading.Event: aa2.
     class now returns the internal flag on exit.  This means the method
     will usually return true because *note wait(): caa. is supposed to
     block until the internal flag becomes true.  The return value will
     only be false if a timeout was provided and the operation timed
     out.  (Contributed by Tim Lesher; bpo-1674032(85).)

   * The Unicode database provided by the *note unicodedata: 11a. module
     is now used internally to determine which characters are numeric,
     whitespace, or represent line breaks.  The database also includes
     information from the ‘Unihan.txt’ data file (patch by Anders
     Chrigström and Amaury Forgeot d’Arc; bpo-1571184(86)) and has been
     updated to version 5.2.0 (updated by Florent Xicluna;
     bpo-8024(87)).

   * The ‘urlparse’ module’s ‘urlsplit()’ now handles unknown URL
     schemes in a fashion compliant with RFC 3986(88): if the URL is of
     the form ‘"<something>://..."’, the text before the ‘://’ is
     treated as the scheme, even if it’s a made-up scheme that the
     module doesn’t know about.  This change may break code that worked
     around the old behaviour.  For example, Python 2.6.4 or 2.5 will
     return the following:

          >>> import urlparse
          >>> urlparse.urlsplit('invented://host/filename?query')
          ('invented', '', '//host/filename?query', '', '')

     Python 2.7 (and Python 2.6.5) will return:

          >>> import urlparse
          >>> urlparse.urlsplit('invented://host/filename?query')
          ('invented', 'host', '/filename?query', '', '')

     (Python 2.7 actually produces slightly different output, since it
     returns a named tuple instead of a standard tuple.)

     The ‘urlparse’ module also supports IPv6 literal addresses as
     defined by RFC 2732(89) (contributed by Senthil Kumaran;
     bpo-2987(90)).

          >>> urlparse.urlparse('http://[1080::8:800:200C:417A]/foo')
          ParseResult(scheme='http', netloc='[1080::8:800:200C:417A]',
                      path='/foo', params='', query='', fragment='')

   * New class: the *note WeakSet: cab. class in the *note weakref: 128.
     module is a set that only holds weak references to its elements;
     elements will be removed once there are no references pointing to
     them.  (Originally implemented in Python 3.x by Raymond Hettinger,
     and backported to 2.7 by Michael Foord.)

   * The ElementTree library, ‘xml.etree’, no longer escapes ampersands
     and angle brackets when outputting an XML processing instruction
     (which looks like ‘<?xml-stylesheet href="#style1"?>’) or comment
     (which looks like ‘<!-- comment -->’).  (Patch by Neil Muller;
     bpo-2746(91).)

   * The XML-RPC client and server, provided by the ‘xmlrpclib’ and
     ‘SimpleXMLRPCServer’ modules, have improved performance by
     supporting HTTP/1.1 keep-alive and by optionally using gzip
     encoding to compress the XML being exchanged.  The gzip compression
     is controlled by the ‘encode_threshold’ attribute of
     ‘SimpleXMLRPCRequestHandler’, which contains a size in bytes;
     responses larger than this will be compressed.  (Contributed by
     Kristján Valur Jónsson; bpo-6267(92).)

   * The *note zipfile: 142. module’s *note ZipFile: 414. now supports
     the context management protocol, so you can write ‘with
     zipfile.ZipFile(...) as f:’.  (Contributed by Brian Curtin;
     bpo-5511(93).)

     *note zipfile: 142. now also supports archiving empty directories
     and extracts them correctly.  (Fixed by Kuba Wieczorek;
     bpo-4710(94).)  Reading files out of an archive is faster, and
     interleaving *note read(): cac. and ‘readline()’ now works
     correctly.  (Contributed by Nir Aides; bpo-7610(95).)

     The *note is_zipfile(): cad. function now accepts a file object, in
     addition to the path names accepted in earlier versions.
     (Contributed by Gabriel Genellina; bpo-4756(96).)

     The *note writestr(): cae. method now has an optional
     `compress_type' parameter that lets you override the default
     compression method specified in the *note ZipFile: 414.
     constructor.  (Contributed by Ronald Oussoren; bpo-6003(97).)

* Menu:

* New module; importlib: New module importlib.
* New module; sysconfig: New module sysconfig.
* ttk; Themed Widgets for Tk: ttk Themed Widgets for Tk.
* Updated module; unittest: Updated module unittest.
* Updated module; ElementTree 1.3: Updated module ElementTree 1 3.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5142

   (2) https://bugs.python.org/issue7703

   (3) https://www.jcea.es/programacion/pybsddb.htm

   (4) https://bugs.python.org/issue8156

   (5) https://bugs.python.org/issue3860

   (6) https://bugs.python.org/issue1696199

   (7) https://bugs.python.org/issue1818

   (8) https://bugs.python.org/issue8729

   (9) https://bugs.python.org/issue7005

   (10) https://bugs.python.org/issue3924

   (11) https://bugs.python.org/issue1515

   (12) https://bugs.python.org/issue4606

   (13) https://sourceware.org/libffi/

   (14) https://bugs.python.org/issue8142

   (15) https://bugs.python.org/issue5788

   (16) https://bugs.python.org/issue4796

   (17) https://bugs.python.org/issue2531

   (18) https://bugs.python.org/issue8257

   (19) https://bugs.python.org/issue6595

   (20) https://bugs.python.org/issue7633

   (21) https://bugs.python.org/issue6857

   (22) https://bugs.python.org/issue7279

   (23) https://bugs.python.org/issue7585

   (24) https://bugs.python.org/issue8688

   (25) https://bugs.python.org/issue7490

   (26) https://bugs.python.org/issue1368247

   (27) https://bugs.python.org/issue5812

   (28) https://bugs.python.org/issue8294

   (29) https://bugs.python.org/issue2054

   (30) https://bugs.python.org/issue6845

   (31) https://bugs.python.org/issue5479

   (32) https://bugs.python.org/issue4688

   (33) https://bugs.python.org/issue3860

   (34) https://bugs.python.org/issue7471

   (35) https://bugs.python.org/issue4272

   (36) https://bugs.python.org/issue2846

   (37) https://bugs.python.org/issue7418

   (38) https://bugs.python.org/issue4879

   (39) https://bugs.python.org/issue3972

   (40) https://bugs.python.org/issue1655

   (41) https://bugs.python.org/issue3135

   (42) https://bugs.python.org/issue4991

   (43) https://bugs.python.org/issue6939

   (44) https://bugs.python.org/issue5032

   (45) https://bugs.python.org/issue4816

   (46) https://bugs.python.org/issue4136

   (47) https://bugs.python.org/issue5381

   (48) https://bugs.python.org/issue1607951

   (49) https://bugs.python.org/issue6896

   (50) https://bugs.python.org/issue3366

   (51) https://bugs.python.org/issue5585

   (52) https://bugs.python.org/issue6963

   (53) https://bugs.python.org/issue1664

   (54) https://bugs.python.org/issue6508

   (55) https://bugs.python.org/issue7333

   (56) https://bugs.python.org/issue7242

   (57) https://bugs.python.org/issue5827

   (58) https://bugs.python.org/issue3426

   (59) https://bugs.python.org/issue4739

   (60) https://bugs.python.org/issue6816

   (61) https://bugs.python.org/issue3002

   (62) https://bugs.python.org/issue8354

   (63) https://bugs.python.org/issue6693

   (64) https://bugs.python.org/issue3137

   (65) https://bugs.python.org/issue3972

   (66) https://bugs.python.org/issue8104

   (67) https://bugs.python.org/issue6192

   (68) https://bugs.python.org/issue6267

   (69) https://github.com/ghaering/pysqlite

   (70) https://bugs.python.org/issue7133

   (71) https://bugs.python.org/issue8222

   (72) 
https://www.openssl.org/docs/manmaster/man1/ciphers.html#CIPHER-LIST-FORMAT

   (73) https://bugs.python.org/issue8322

   (74) https://bugs.python.org/issue8484

   (75) https://bugs.python.org/issue8321

   (76) https://bugs.python.org/issue1523

   (77) https://bugs.python.org/issue8300

   (78) https://bugs.python.org/issue1068268

   (79) https://bugs.python.org/issue8451

   (80) https://bugs.python.org/issue4285

   (81) https://bugs.python.org/issue7766

   (82) https://bugs.python.org/issue7357

   (83) https://bugs.python.org/issue6856

   (84) https://bugs.python.org/issue7232

   (85) https://bugs.python.org/issue1674032

   (86) https://bugs.python.org/issue1571184

   (87) https://bugs.python.org/issue8024

   (88) https://tools.ietf.org/html/rfc3986.html

   (89) https://tools.ietf.org/html/rfc2732.html

   (90) https://bugs.python.org/issue2987

   (91) https://bugs.python.org/issue2746

   (92) https://bugs.python.org/issue6267

   (93) https://bugs.python.org/issue5511

   (94) https://bugs.python.org/issue4710

   (95) https://bugs.python.org/issue7610

   (96) https://bugs.python.org/issue4756

   (97) https://bugs.python.org/issue6003


File: python.info,  Node: New module importlib,  Next: New module sysconfig,  Up: New and Improved Modules

1.10.11.1 New module: importlib
...............................

Python 3.1 includes the *note importlib: 9b. package, a
re-implementation of the logic underlying Python’s *note import: c10.
statement.  *note importlib: 9b. is useful for implementors of Python
interpreters and to users who wish to write new importers that can
participate in the import process.  Python 2.7 doesn’t contain the
complete *note importlib: 9b. package, but instead has a tiny subset
that contains a single function, *note import_module(): b06.

‘import_module(name, package=None)’ imports a module.  `name' is a
string containing the module or package’s name.  It’s possible to do
relative imports by providing a string that begins with a ‘.’ character,
such as ‘..utils.errors’.  For relative imports, the `package' argument
must be provided and is the name of the package that will be used as the
anchor for the relative import.  *note import_module(): b06. both
inserts the imported module into ‘sys.modules’ and returns the module
object.

Here are some examples:

     >>> from importlib import import_module
     >>> anydbm = import_module('anydbm')  # Standard absolute import
     >>> anydbm
     <module 'anydbm' from '/p/python/Lib/anydbm.py'>
     >>> # Relative import
     >>> file_util = import_module('..file_util', 'distutils.command')
     >>> file_util
     <module 'distutils.file_util' from '/python/Lib/distutils/file_util.pyc'>

*note importlib: 9b. was implemented by Brett Cannon and introduced in
Python 3.1.


File: python.info,  Node: New module sysconfig,  Next: ttk Themed Widgets for Tk,  Prev: New module importlib,  Up: New and Improved Modules

1.10.11.2 New module: sysconfig
...............................

The *note sysconfig: fe. module has been pulled out of the Distutils
package, becoming a new top-level module in its own right.  *note
sysconfig: fe. provides functions for getting information about Python’s
build process: compiler switches, installation paths, the platform name,
and whether Python is running from its source directory.

Some of the functions in the module are:

   * *note get_config_var(): 958. returns variables from Python’s
     Makefile and the ‘pyconfig.h’ file.

   * *note get_config_vars(): 959. returns a dictionary containing all
     of the configuration variables.

   * *note get_path(): cb1. returns the configured path for a particular
     type of module: the standard library, site-specific modules,
     platform-specific modules, etc.

   * *note is_python_build(): cb2. returns true if you’re running a
     binary from a Python source tree, and false otherwise.

Consult the *note sysconfig: fe. documentation for more details and for
a complete list of functions.

The Distutils package and *note sysconfig: fe. are now maintained by
Tarek Ziadé, who has also started a Distutils2 package (source
repository at ‘https://hg.python.org/distutils2/’) for developing a
next-generation version of Distutils.


File: python.info,  Node: ttk Themed Widgets for Tk,  Next: Updated module unittest,  Prev: New module sysconfig,  Up: New and Improved Modules

1.10.11.3 ttk: Themed Widgets for Tk
....................................

Tcl/Tk 8.5 includes a set of themed widgets that re-implement basic Tk
widgets but have a more customizable appearance and can therefore more
closely resemble the native platform’s widgets.  This widget set was
originally called Tile, but was renamed to Ttk (for “themed Tk”) on
being added to Tcl/Tck release 8.5.

To learn more, read the ‘ttk’ module documentation.  You may also wish
to read the Tcl/Tk manual page describing the Ttk theme engine,
available at ‘https://www.tcl.tk/man/tcl8.5/TkCmd/ttk_intro.htm’.  Some
screenshots of the Python/Ttk code in use are at
‘https://code.google.com/archive/p/python-ttk/wikis/Screenshots.wiki’.

The ‘ttk’ module was written by Guilherme Polo and added in bpo-2983(1).
An alternate version called ‘Tile.py’, written by Martin Franklin and
maintained by Kevin Walzer, was proposed for inclusion in bpo-2618(2),
but the authors argued that Guilherme Polo’s work was more
comprehensive.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2983

   (2) https://bugs.python.org/issue2618


File: python.info,  Node: Updated module unittest,  Next: Updated module ElementTree 1 3,  Prev: ttk Themed Widgets for Tk,  Up: New and Improved Modules

1.10.11.4 Updated module: unittest
..................................

The *note unittest: 11b. module was greatly enhanced; many new features
were added.  Most of these features were implemented by Michael Foord,
unless otherwise noted.  The enhanced version of the module is
downloadable separately for use with Python versions 2.4 to 2.6,
packaged as the ‘unittest2’ package, from
‘https://pypi.org/project/unittest2’.

When used from the command line, the module can automatically discover
tests.  It’s not as fancy as py.test(1) or nose(2), but provides a
simple way to run tests kept within a set of package directories.  For
example, the following command will search the ‘test/’ subdirectory for
any importable test files named ‘test*.py’:

     python -m unittest discover -s test

Consult the *note unittest: 11b. module documentation for more details.
(Developed in bpo-6001(3).)

The *note main(): 8f6. function supports some other new options:

   * *note -b: cb6. or ‘--buffer’ will buffer the standard output and
     standard error streams during each test.  If the test passes, any
     resulting output will be discarded; on failure, the buffered output
     will be displayed.

   * *note -c: cb7. or ‘--catch’ will cause the control-C interrupt to
     be handled more gracefully.  Instead of interrupting the test
     process immediately, the currently running test will be completed
     and then the partial results up to the interruption will be
     reported.  If you’re impatient, a second press of control-C will
     cause an immediate interruption.

     This control-C handler tries to avoid causing problems when the
     code being tested or the tests being run have defined a signal
     handler of their own, by noticing that a signal handler was already
     set and calling it.  If this doesn’t work for you, there’s a *note
     removeHandler(): cb8. decorator that can be used to mark tests that
     should have the control-C handling disabled.

   * *note -f: cb9. or ‘--failfast’ makes test execution stop
     immediately when a test fails instead of continuing to execute
     further tests.  (Suggested by Cliff Dyer and implemented by Michael
     Foord; bpo-8074(4).)

The progress messages now show ‘x’ for expected failures and ‘u’ for
unexpected successes when run in verbose mode.  (Contributed by Benjamin
Peterson.)

Test cases can raise the *note SkipTest: 8f7. exception to skip a test
(bpo-1034053(5)).

The error messages for *note assertEqual(): ba8, *note assertTrue():
ba7, and *note assertFalse(): cba. failures now provide more
information.  If you set the *note longMessage: cbb. attribute of your
*note TestCase: 8f3. classes to true, both the standard error message
and any additional message you provide will be printed for failures.
(Added by Michael Foord; bpo-5663(6).)

The *note assertRaises(): aaf. method now returns a context handler when
called without providing a callable object to run.  For example, you can
write this:

     with self.assertRaises(KeyError):
         {}['foo']

(Implemented by Antoine Pitrou; bpo-4444(7).)

Module- and class-level setup and teardown fixtures are now supported.
Modules can contain ‘setUpModule()’ and ‘tearDownModule()’ functions.
Classes can have *note setUpClass(): 24a. and *note tearDownClass():
cbc. methods that must be defined as class methods (using ‘@classmethod’
or equivalent).  These functions and methods are invoked when the test
runner switches to a test case in a different module or class.

The methods *note addCleanup(): 2a0. and *note doCleanups(): cbd. were
added.  *note addCleanup(): 2a0. lets you add cleanup functions that
will be called unconditionally (after *note setUp(): cbe. if *note
setUp(): cbe. fails, otherwise after *note tearDown(): cbf.).  This
allows for much simpler resource allocation and deallocation during
tests (bpo-5679(8)).

A number of new methods were added that provide more specialized tests.
Many of these methods were written by Google engineers for use in their
test suites; Gregory P. Smith, Michael Foord, and GvR worked on merging
them into Python’s version of *note unittest: 11b.

   * *note assertIsNone(): cc0. and *note assertIsNotNone(): cc1. take
     one expression and verify that the result is or is not ‘None’.

   * *note assertIs(): cc2. and *note assertIsNot(): cc3. take two
     values and check whether the two values evaluate to the same object
     or not.  (Added by Michael Foord; bpo-2578(9).)

   * *note assertIsInstance(): cc4. and *note assertNotIsInstance():
     cc5. check whether the resulting object is an instance of a
     particular class, or of one of a tuple of classes.  (Added by Georg
     Brandl; bpo-7031(10).)

   * *note assertGreater(): cc6, *note assertGreaterEqual(): cc7, *note
     assertLess(): cc8, and *note assertLessEqual(): cc9. compare two
     quantities.

   * *note assertMultiLineEqual(): cca. compares two strings, and if
     they’re not equal, displays a helpful comparison that highlights
     the differences in the two strings.  This comparison is now used by
     default when Unicode strings are compared with *note assertEqual():
     ba8.

   * ‘assertRegexpMatches()’ and ‘assertNotRegexpMatches()’ checks
     whether the first argument is a string matching or not matching the
     regular expression provided as the second argument (bpo-8038(11)).

   * ‘assertRaisesRegexp()’ checks whether a particular exception is
     raised, and then also checks that the string representation of the
     exception matches the provided regular expression.

   * *note assertIn(): ccb. and *note assertNotIn(): ccc. tests whether
     `first' is or is not in `second'.

   * ‘assertItemsEqual()’ tests whether two provided sequences contain
     the same elements.

   * *note assertSetEqual(): ccd. compares whether two sets are equal,
     and only reports the differences between the sets in case of error.

   * Similarly, *note assertListEqual(): cce. and *note
     assertTupleEqual(): ccf. compare the specified types and explain
     any differences without necessarily printing their full values;
     these methods are now used by default when comparing lists and
     tuples using *note assertEqual(): ba8.  More generally, *note
     assertSequenceEqual(): cd0. compares two sequences and can
     optionally check whether both sequences are of a particular type.

   * *note assertDictEqual(): cd1. compares two dictionaries and reports
     the differences; it’s now used by default when you compare two
     dictionaries using *note assertEqual(): ba8.
     ‘assertDictContainsSubset()’ checks whether all of the key/value
     pairs in `first' are found in `second'.

   * *note assertAlmostEqual(): baa. and *note assertNotAlmostEqual():
     bab. test whether `first' and `second' are approximately equal.
     This method can either round their difference to an
     optionally-specified number of `places' (the default is 7) and
     compare it to zero, or require the difference to be smaller than a
     supplied `delta' value.

   * *note loadTestsFromName(): cd2. properly honors the *note
     suiteClass: cd3. attribute of the *note TestLoader: 776.  (Fixed by
     Mark Roddy; bpo-6866(12).)

   * A new hook lets you extend the *note assertEqual(): ba8. method to
     handle new data types.  The *note addTypeEqualityFunc(): cd4.
     method takes a type object and a function.  The function will be
     used when both of the objects being compared are of the specified
     type.  This function should compare the two objects and raise an
     exception if they don’t match; it’s a good idea for the function to
     provide additional information about why the two objects aren’t
     matching, much as the new sequence comparison methods do.

*note unittest.main(): 8f6. now takes an optional ‘exit’ argument.  If
false, *note main(): 8f6. doesn’t call *note sys.exit(): cd5, allowing
*note main(): 8f6. to be used from the interactive interpreter.
(Contributed by J. Pablo Fernández; bpo-3379(13).)

*note TestResult: ab4. has new *note startTestRun(): cd6. and *note
stopTestRun(): cd7. methods that are called immediately before and after
a test run.  (Contributed by Robert Collins; bpo-5728(14).)

With all these changes, the ‘unittest.py’ was becoming awkwardly large,
so the module was turned into a package and the code split into several
files (by Benjamin Peterson).  This doesn’t affect how the module is
imported or used.

See also
........

‘http://www.voidspace.org.uk/python/articles/unittest2.shtml’

     Describes the new features, how to use them, and the rationale for
     various design decisions.  (By Michael Foord.)

   ---------- Footnotes ----------

   (1) http://pytest.org

   (2) https://nose.readthedocs.io/

   (3) https://bugs.python.org/issue6001

   (4) https://bugs.python.org/issue8074

   (5) https://bugs.python.org/issue1034053

   (6) https://bugs.python.org/issue5663

   (7) https://bugs.python.org/issue4444

   (8) https://bugs.python.org/issue5679

   (9) https://bugs.python.org/issue2578

   (10) https://bugs.python.org/issue7031

   (11) https://bugs.python.org/issue8038

   (12) https://bugs.python.org/issue6866

   (13) https://bugs.python.org/issue3379

   (14) https://bugs.python.org/issue5728


File: python.info,  Node: Updated module ElementTree 1 3,  Prev: Updated module unittest,  Up: New and Improved Modules

1.10.11.5 Updated module: ElementTree 1.3
.........................................

The version of the ElementTree library included with Python was updated
to version 1.3.  Some of the new features are:

   * The various parsing functions now take a `parser' keyword argument
     giving an *note XMLParser: 250. instance that will be used.  This
     makes it possible to override the file’s internal encoding:

          p = ET.XMLParser(encoding='utf-8')
          t = ET.XML("""<root/>""", parser=p)

     Errors in parsing XML now raise a ‘ParseError’ exception, whose
     instances have a ‘position’ attribute containing a (`line',
     `column') tuple giving the location of the problem.

   * ElementTree’s code for converting trees to a string has been
     significantly reworked, making it roughly twice as fast in many
     cases.  The *note ElementTree.write(): 90c. and ‘Element.write()’
     methods now have a `method' parameter that can be “xml” (the
     default), “html”, or “text”.  HTML mode will output empty elements
     as ‘<empty></empty>’ instead of ‘<empty/>’, and text mode will skip
     over elements and only output the text chunks.  If you set the
     ‘tag’ attribute of an element to ‘None’ but leave its children in
     place, the element will be omitted when the tree is written out, so
     you don’t need to do more extensive rearrangement to remove a
     single element.

     Namespace handling has also been improved.  All ‘xmlns:<whatever>’
     declarations are now output on the root element, not scattered
     throughout the resulting XML. You can set the default namespace for
     a tree by setting the ‘default_namespace’ attribute and can
     register new prefixes with *note register_namespace(): b43.  In XML
     mode, you can use the true/false `xml_declaration' parameter to
     suppress the XML declaration.

   * New *note Element: ab9. method: *note extend(): b44. appends the
     items from a sequence to the element’s children.  Elements
     themselves behave like sequences, so it’s easy to move children
     from one element to another:

          from xml.etree import ElementTree as ET

          t = ET.XML("""<list>
            <item>1</item> <item>2</item>  <item>3</item>
          </list>""")
          new = ET.XML('<root/>')
          new.extend(t)

          # Outputs <root><item>1</item>...</root>
          print ET.tostring(new)

   * New ‘Element’ method: *note iter(): cda. yields the children of the
     element as a generator.  It’s also possible to write ‘for child in
     elem:’ to loop over an element’s children.  The existing method
     ‘getiterator()’ is now deprecated, as is ‘getchildren()’ which
     constructs and returns a list of children.

   * New ‘Element’ method: *note itertext(): b46. yields all chunks of
     text that are descendants of the element.  For example:

          t = ET.XML("""<list>
            <item>1</item> <item>2</item>  <item>3</item>
          </list>""")

          # Outputs ['\n  ', '1', ' ', '2', '  ', '3', '\n']
          print list(t.itertext())

   * Deprecated: using an element as a Boolean (i.e., ‘if elem:’) would
     return true if the element had any children, or false if there were
     no children.  This behaviour is confusing – ‘None’ is false, but so
     is a childless element?  – so it will now trigger a *note
     FutureWarning: 31a.  In your code, you should be explicit: write
     ‘len(elem) != 0’ if you’re interested in the number of children, or
     ‘elem is not None’.

Fredrik Lundh develops ElementTree and produced the 1.3 version; you can
read his article describing 1.3 at
‘http://effbot.org/zone/elementtree-13-intro.htm’.  Florent Xicluna
updated the version included with Python, after discussions on
python-dev and in bpo-6472(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue6472


File: python.info,  Node: Build and C API Changes<8>,  Next: Other Changes and Fixes,  Prev: New and Improved Modules,  Up: What’s New in Python 2 7

1.10.12 Build and C API Changes
-------------------------------

Changes to Python’s build process and to the C API include:

   * The latest release of the GNU Debugger, GDB 7, can be scripted
     using Python(1).  When you begin debugging an executable program P,
     GDB will look for a file named ‘P-gdb.py’ and automatically read
     it.  Dave Malcolm contributed a ‘python-gdb.py’ that adds a number
     of commands useful when debugging Python itself.  For example,
     ‘py-up’ and ‘py-down’ go up or down one Python stack frame, which
     usually corresponds to several C stack frames.  ‘py-print’ prints
     the value of a Python variable, and ‘py-bt’ prints the Python stack
     trace.  (Added as a result of bpo-8032(2).)

   * If you use the ‘.gdbinit’ file provided with Python, the “pyo”
     macro in the 2.7 version now works correctly when the thread being
     debugged doesn’t hold the GIL; the macro now acquires it before
     printing.  (Contributed by Victor Stinner; bpo-3632(3).)

   * *note Py_AddPendingCall(): cdc. is now thread-safe, letting any
     worker thread submit notifications to the main Python thread.  This
     is particularly useful for asynchronous IO operations.
     (Contributed by Kristján Valur Jónsson; bpo-4293(4).)

   * New function: *note PyCode_NewEmpty(): cdd. creates an empty code
     object; only the filename, function name, and first line number are
     required.  This is useful for extension modules that are attempting
     to construct a more useful traceback stack.  Previously such
     extensions needed to call *note PyCode_New(): 270, which had many
     more arguments.  (Added by Jeffrey Yasskin.)

   * New function: *note PyErr_NewExceptionWithDoc(): bf2. creates a new
     exception class, just as the existing *note PyErr_NewException():
     bf3. does, but takes an extra ‘char *’ argument containing the
     docstring for the new exception class.  (Added by ‘lekma’ on the
     Python bug tracker; bpo-7033(5).)

   * New function: *note PyFrame_GetLineNumber(): cde. takes a frame
     object and returns the line number that the frame is currently
     executing.  Previously code would need to get the index of the
     bytecode instruction currently executing, and then look up the line
     number corresponding to that address.  (Added by Jeffrey Yasskin.)

   * New functions: *note PyLong_AsLongAndOverflow(): bf0. and *note
     PyLong_AsLongLongAndOverflow(): bef. approximates a Python long
     integer as a C ‘long’ or ‘long long’.  If the number is too large
     to fit into the output type, an `overflow' flag is set and returned
     to the caller.  (Contributed by Case Van Horsen; bpo-7528(6) and
     bpo-7767(7).)

   * New function: stemming from the rewrite of string-to-float
     conversion, a new *note PyOS_string_to_double(): c16. function was
     added.  The old ‘PyOS_ascii_strtod()’ and ‘PyOS_ascii_atof()’
     functions are now deprecated.

   * New function: *note PySys_SetArgvEx(): bed. sets the value of
     ‘sys.argv’ and can optionally update ‘sys.path’ to include the
     directory containing the script named by ‘sys.argv[0]’ depending on
     the value of an `updatepath' parameter.

     This function was added to close a security hole for applications
     that embed Python.  The old function, *note PySys_SetArgv(): cdf,
     would always update ‘sys.path’, and sometimes it would add the
     current directory.  This meant that, if you ran an application
     embedding Python in a directory controlled by someone else,
     attackers could put a Trojan-horse module in the directory (say, a
     file named ‘os.py’) that your application would then import and
     run.

     If you maintain a C/C++ application that embeds Python, check
     whether you’re calling *note PySys_SetArgv(): cdf. and carefully
     consider whether the application should be using *note
     PySys_SetArgvEx(): bed. with `updatepath' set to false.

     Security issue reported as CVE-2008-5983(8); discussed in
     bpo-5753(9), and fixed by Antoine Pitrou.

   * New macros: the Python header files now define the following
     macros: ‘Py_ISALNUM’, ‘Py_ISALPHA’, ‘Py_ISDIGIT’, ‘Py_ISLOWER’,
     ‘Py_ISSPACE’, ‘Py_ISUPPER’, ‘Py_ISXDIGIT’, ‘Py_TOLOWER’, and
     ‘Py_TOUPPER’.  All of these functions are analogous to the C
     standard macros for classifying characters, but ignore the current
     locale setting, because in several places Python needs to analyze
     characters in a locale-independent way.  (Added by Eric Smith;
     bpo-5793(10).)

   * Removed function: ‘PyEval_CallObject’ is now only available as a
     macro.  A function version was being kept around to preserve ABI
     linking compatibility, but that was in 1997; it can certainly be
     deleted by now.  (Removed by Antoine Pitrou; bpo-8276(11).)

   * New format codes: the ‘PyFormat_FromString()’,
     ‘PyFormat_FromStringV()’, and *note PyErr_Format(): 79e. functions
     now accept ‘%lld’ and ‘%llu’ format codes for displaying C’s ‘long
     long’ types.  (Contributed by Mark Dickinson; bpo-7228(12).)

   * The complicated interaction between threads and process forking has
     been changed.  Previously, the child process created by *note
     os.fork(): 955. might fail because the child is created with only a
     single thread running, the thread performing the *note os.fork():
     955.  If other threads were holding a lock, such as Python’s import
     lock, when the fork was performed, the lock would still be marked
     as “held” in the new process.  But in the child process nothing
     would ever release the lock, since the other threads weren’t
     replicated, and the child process would no longer be able to
     perform imports.

     Python 2.7 acquires the import lock before performing an *note
     os.fork(): 955, and will also clean up any locks created using the
     *note threading: 109. module.  C extension modules that have
     internal locks, or that call ‘fork()’ themselves, will not benefit
     from this clean-up.

     (Fixed by Thomas Wouters; bpo-1590864(13).)

   * The *note Py_Finalize(): ce0. function now calls the internal
     ‘threading._shutdown()’ function; this prevents some exceptions
     from being raised when an interpreter shuts down.  (Patch by Adam
     Olsen; bpo-1722344(14).)

   * When using the *note PyMemberDef: 41b. structure to define
     attributes of a type, Python will no longer let you try to delete
     or set a ‘T_STRING_INPLACE’ attribute.

   * Global symbols defined by the *note ctypes: 2b. module are now
     prefixed with ‘Py’, or with ‘_ctypes’.  (Implemented by Thomas
     Heller; bpo-3102(15).)

   * New configure option: the ‘--with-system-expat’ switch allows
     building the ‘pyexpat’ module to use the system Expat library.
     (Contributed by Arfrever Frehtes Taifersar Arahesis; bpo-7609(16).)

   * New configure option: the ‘--with-valgrind’ option will now disable
     the pymalloc allocator, which is difficult for the Valgrind
     memory-error detector to analyze correctly.  Valgrind will
     therefore be better at detecting memory leaks and overruns.
     (Contributed by James Henstridge; bpo-2422(17).)

   * New configure option: you can now supply an empty string to
     ‘--with-dbmliborder=’ in order to disable all of the various DBM
     modules.  (Added by Arfrever Frehtes Taifersar Arahesis;
     bpo-6491(18).)

   * The ‘configure’ script now checks for floating-point rounding bugs
     on certain 32-bit Intel chips and defines a ‘X87_DOUBLE_ROUNDING’
     preprocessor definition.  No code currently uses this definition,
     but it’s available if anyone wishes to use it.  (Added by Mark
     Dickinson; bpo-2937(19).)

     ‘configure’ also now sets a ‘LDCXXSHARED’ Makefile variable for
     supporting C++ linking.  (Contributed by Arfrever Frehtes Taifersar
     Arahesis; bpo-1222585(20).)

   * The build process now creates the necessary files for pkg-config
     support.  (Contributed by Clinton Roy; bpo-3585(21).)

   * The build process now supports Subversion 1.7.  (Contributed by
     Arfrever Frehtes Taifersar Arahesis; bpo-6094(22).)

* Menu:

* Capsules::
* Port-Specific Changes; Windows: Port-Specific Changes Windows.
* Port-Specific Changes; Mac OS X: Port-Specific Changes Mac OS X.
* Port-Specific Changes; FreeBSD: Port-Specific Changes FreeBSD.

   ---------- Footnotes ----------

   (1) https://sourceware.org/gdb/current/onlinedocs/gdb/Python.html

   (2) https://bugs.python.org/issue8032

   (3) https://bugs.python.org/issue3632

   (4) https://bugs.python.org/issue4293

   (5) https://bugs.python.org/issue7033

   (6) https://bugs.python.org/issue7528

   (7) https://bugs.python.org/issue7767

   (8) https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2008-5983

   (9) https://bugs.python.org/issue5753

   (10) https://bugs.python.org/issue5793

   (11) https://bugs.python.org/issue8276

   (12) https://bugs.python.org/issue7228

   (13) https://bugs.python.org/issue1590864

   (14) https://bugs.python.org/issue1722344

   (15) https://bugs.python.org/issue3102

   (16) https://bugs.python.org/issue7609

   (17) https://bugs.python.org/issue2422

   (18) https://bugs.python.org/issue6491

   (19) https://bugs.python.org/issue2937

   (20) https://bugs.python.org/issue1222585

   (21) https://bugs.python.org/issue3585

   (22) https://bugs.python.org/issue6094


File: python.info,  Node: Capsules,  Next: Port-Specific Changes Windows,  Up: Build and C API Changes<8>

1.10.12.1 Capsules
..................

Python 3.1 adds a new C datatype, *note PyCapsule: bfa, for providing a
C API to an extension module.  A capsule is essentially the holder of a
C ‘void *’ pointer, and is made available as a module attribute; for
example, the *note socket: ef. module’s API is exposed as ‘socket.CAPI’,
and *note unicodedata: 11a. exposes ‘ucnhash_CAPI’.  Other extensions
can import the module, access its dictionary to get the capsule object,
and then get the ‘void *’ pointer, which will usually point to an array
of pointers to the module’s various API functions.

There is an existing data type already used for this, ‘PyCObject’, but
it doesn’t provide type safety.  Evil code written in pure Python could
cause a segmentation fault by taking a ‘PyCObject’ from module A and
somehow substituting it for the ‘PyCObject’ in module B. Capsules know
their own name, and getting the pointer requires providing the name:

     void *vtable;

     if (!PyCapsule_IsValid(capsule, "mymodule.CAPI") {
             PyErr_SetString(PyExc_ValueError, "argument type invalid");
             return NULL;
     }

     vtable = PyCapsule_GetPointer(capsule, "mymodule.CAPI");

You are assured that ‘vtable’ points to whatever you’re expecting.  If a
different capsule was passed in, *note PyCapsule_IsValid(): ce3. would
detect the mismatched name and return false.  Refer to *note Providing a
C API for an Extension Module: ce4. for more information on using these
objects.

Python 2.7 now uses capsules internally to provide various
extension-module APIs, but the ‘PyCObject_AsVoidPtr()’ was modified to
handle capsules, preserving compile-time compatibility with the
‘CObject’ interface.  Use of ‘PyCObject_AsVoidPtr()’ will signal a *note
PendingDeprecationWarning: 277, which is silent by default.

Implemented in Python 3.1 and backported to 2.7 by Larry Hastings;
discussed in bpo-5630(1).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5630


File: python.info,  Node: Port-Specific Changes Windows,  Next: Port-Specific Changes Mac OS X,  Prev: Capsules,  Up: Build and C API Changes<8>

1.10.12.2 Port-Specific Changes: Windows
........................................

   * The *note msvcrt: b6. module now contains some constants from the
     ‘crtassem.h’ header file: ‘CRT_ASSEMBLY_VERSION’,
     ‘VC_ASSEMBLY_PUBLICKEYTOKEN’, and ‘LIBRARIES_ASSEMBLY_NAME_PREFIX’.
     (Contributed by David Cournapeau; bpo-4365(1).)

   * The ‘_winreg’ module for accessing the registry now implements the
     ‘CreateKeyEx()’ and ‘DeleteKeyEx()’ functions, extended versions of
     previously-supported functions that take several extra arguments.
     The ‘DisableReflectionKey()’, ‘EnableReflectionKey()’, and
     ‘QueryReflectionKey()’ were also tested and documented.
     (Implemented by Brian Curtin: bpo-7347(2).)

   * The new ‘_beginthreadex()’ API is used to start threads, and the
     native thread-local storage functions are now used.  (Contributed
     by Kristján Valur Jónsson; bpo-3582(3).)

   * The *note os.kill(): ce6. function now works on Windows.  The
     signal value can be the constants ‘CTRL_C_EVENT’,
     ‘CTRL_BREAK_EVENT’, or any integer.  The first two constants will
     send ‘Control-C’ and ‘Control-Break’ keystroke events to
     subprocesses; any other value will use the ‘TerminateProcess()’
     API. (Contributed by Miki Tebeka; bpo-1220212(4).)

   * The *note os.listdir(): a36. function now correctly fails for an
     empty path.  (Fixed by Hirokazu Yamamoto; bpo-5913(5).)

   * The ‘mimelib’ module will now read the MIME database from the
     Windows registry when initializing.  (Patch by Gabriel Genellina;
     bpo-4969(6).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4365

   (2) https://bugs.python.org/issue7347

   (3) https://bugs.python.org/issue3582

   (4) https://bugs.python.org/issue1220212

   (5) https://bugs.python.org/issue5913

   (6) https://bugs.python.org/issue4969


File: python.info,  Node: Port-Specific Changes Mac OS X,  Next: Port-Specific Changes FreeBSD,  Prev: Port-Specific Changes Windows,  Up: Build and C API Changes<8>

1.10.12.3 Port-Specific Changes: Mac OS X
.........................................

   * The path ‘/Library/Python/2.7/site-packages’ is now appended to
     ‘sys.path’, in order to share added packages between the system
     installation and a user-installed copy of the same version.
     (Changed by Ronald Oussoren; bpo-4865(1).)

          Changed in version 2.7.13: As of 2.7.13, this change was
          removed.  ‘/Library/Python/2.7/site-packages’, the
          site-packages directory used by the Apple-supplied system
          Python 2.7 is no longer appended to ‘sys.path’ for
          user-installed Pythons such as from the python.org installers.
          As of macOS 10.12, Apple changed how the system site-packages
          directory is configured, which could cause installation of pip
          components, like setuptools, to fail.  Packages installed for
          the system Python will no longer be shared with user-installed
          Pythons.  (bpo-28440(2))

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue4865

   (2) https://bugs.python.org/issue28440


File: python.info,  Node: Port-Specific Changes FreeBSD,  Prev: Port-Specific Changes Mac OS X,  Up: Build and C API Changes<8>

1.10.12.4 Port-Specific Changes: FreeBSD
........................................

   * FreeBSD 7.1’s ‘SO_SETFIB’ constant, used with
     ‘getsockopt()’/‘setsockopt()’ to select an alternate routing table,
     is now available in the *note socket: ef. module.  (Added by Kyle
     VanderBeek; bpo-8235(1).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue8235


File: python.info,  Node: Other Changes and Fixes,  Next: Porting to Python 2 7,  Prev: Build and C API Changes<8>,  Up: What’s New in Python 2 7

1.10.13 Other Changes and Fixes
-------------------------------

   * Two benchmark scripts, ‘iobench’ and ‘ccbench’, were added to the
     ‘Tools’ directory.  ‘iobench’ measures the speed of the built-in
     file I/O objects returned by *note open(): 4e5. while performing
     various operations, and ‘ccbench’ is a concurrency benchmark that
     tries to measure computing throughput, thread switching latency,
     and IO processing bandwidth when performing several tasks using a
     varying number of threads.

   * The ‘Tools/i18n/msgfmt.py’ script now understands plural forms in
     ‘.po’ files.  (Fixed by Martin von Löwis; bpo-5464(1).)

   * When importing a module from a ‘.pyc’ or ‘.pyo’ file with an
     existing ‘.py’ counterpart, the ‘co_filename’ attributes of the
     resulting code objects are overwritten when the original filename
     is obsolete.  This can happen if the file has been renamed, moved,
     or is accessed through different paths.  (Patch by Ziga Seilnacht
     and Jean-Paul Calderone; bpo-1180193(2).)

   * The ‘regrtest.py’ script now takes a ‘--randseed=’ switch that
     takes an integer that will be used as the random seed for the ‘-r’
     option that executes tests in random order.  The ‘-r’ option also
     reports the seed that was used (Added by Collin Winter.)

   * Another ‘regrtest.py’ switch is ‘-j’, which takes an integer
     specifying how many tests run in parallel.  This allows reducing
     the total runtime on multi-core machines.  This option is
     compatible with several other options, including the ‘-R’ switch
     which is known to produce long runtimes.  (Added by Antoine Pitrou,
     bpo-6152(3).)  This can also be used with a new ‘-F’ switch that
     runs selected tests in a loop until they fail.  (Added by Antoine
     Pitrou; bpo-7312(4).)

   * When executed as a script, the ‘py_compile.py’ module now accepts
     ‘'-'’ as an argument, which will read standard input for the list
     of filenames to be compiled.  (Contributed by Piotr Ożarowski;
     bpo-8233(5).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5464

   (2) https://bugs.python.org/issue1180193

   (3) https://bugs.python.org/issue6152

   (4) https://bugs.python.org/issue7312

   (5) https://bugs.python.org/issue8233


File: python.info,  Node: Porting to Python 2 7,  Next: New Features Added to Python 2 7 Maintenance Releases,  Prev: Other Changes and Fixes,  Up: What’s New in Python 2 7

1.10.14 Porting to Python 2.7
-----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code:

   * The *note range(): 9b2. function processes its arguments more
     consistently; it will now call *note __int__(): 18b. on non-float,
     non-integer arguments that are supplied to it.  (Fixed by Alexander
     Belopolsky; bpo-1533(1).)

   * The string *note format(): 4d0. method changed the default
     precision used for floating-point and complex numbers from 6
     decimal places to 12, which matches the precision used by *note
     str(): 325.  (Changed by Eric Smith; bpo-5920(2).)

   * Because of an optimization for the *note with: 6dd. statement, the
     special methods *note __enter__(): c88. and *note __exit__(): c89.
     must belong to the object’s type, and cannot be directly attached
     to the object’s instance.  This affects new-style classes (derived
     from *note object: 2ae.) and C extension types.  (bpo-6101(3).)

   * Due to a bug in Python 2.6, the `exc_value' parameter to *note
     __exit__(): c89. methods was often the string representation of the
     exception, not an instance.  This was fixed in 2.7, so `exc_value'
     will be an instance as expected.  (Fixed by Florent Xicluna;
     bpo-7853(4).)

   * When a restricted set of attributes were set using ‘__slots__’,
     deleting an unset attribute would not raise *note AttributeError:
     390. as you would expect.  Fixed by Benjamin Peterson;
     bpo-7604(5).)

In the standard library:

   * Operations with *note datetime: 194. instances that resulted in a
     year falling outside the supported range didn’t always raise *note
     OverflowError: 954.  Such errors are now checked more carefully and
     will now raise the exception.  (Reported by Mark Leander, patch by
     Anand B. Pillai and Alexander Belopolsky; bpo-7150(6).)

   * When using *note Decimal: 188. instances with a string’s *note
     format(): 4d0. method, the default alignment was previously
     left-alignment.  This has been changed to right-alignment, which
     might change the output of your programs.  (Changed by Mark
     Dickinson; bpo-6857(7).)

     Comparisons involving a signaling NaN value (or ‘sNAN’) now signal
     *note InvalidOperation: 9df. instead of silently returning a true
     or false value depending on the comparison operator.  Quiet NaN
     values (or ‘NaN’) are now hashable.  (Fixed by Mark Dickinson;
     bpo-7279(8).)

   * The ElementTree library, ‘xml.etree’, no longer escapes ampersands
     and angle brackets when outputting an XML processing instruction
     (which looks like ‘<?xml-stylesheet href=”#style1”?>’) or comment
     (which looks like ‘<!– comment –>’).  (Patch by Neil Muller;
     bpo-2746(9).)

   * The ‘readline()’ method of ‘StringIO’ objects now does nothing when
     a negative length is requested, as other file-like objects do.
     (bpo-7348(10)).

   * The *note syslog: ff. module will now use the value of
     ‘sys.argv[0]’ as the identifier instead of the previous default
     value of ‘'python'’.  (Changed by Sean Reifschneider;
     bpo-8451(11).)

   * The *note tarfile: 101. module’s default error handling has
     changed, to no longer suppress fatal errors.  The default error
     level was previously 0, which meant that errors would only result
     in a message being written to the debug log, but because the debug
     log is not activated by default, these errors go unnoticed.  The
     default error level is now 1, which raises an exception if there’s
     an error.  (Changed by Lars Gustäbel; bpo-7357(12).)

   * The ‘urlparse’ module’s ‘urlsplit()’ now handles unknown URL
     schemes in a fashion compliant with RFC 3986(13): if the URL is of
     the form ‘"<something>://..."’, the text before the ‘://’ is
     treated as the scheme, even if it’s a made-up scheme that the
     module doesn’t know about.  This change may break code that worked
     around the old behaviour.  For example, Python 2.6.4 or 2.5 will
     return the following:

          >>> import urlparse
          >>> urlparse.urlsplit('invented://host/filename?query')
          ('invented', '', '//host/filename?query', '', '')

     Python 2.7 (and Python 2.6.5) will return:

          >>> import urlparse
          >>> urlparse.urlsplit('invented://host/filename?query')
          ('invented', 'host', '/filename?query', '', '')

     (Python 2.7 actually produces slightly different output, since it
     returns a named tuple instead of a standard tuple.)

For C extensions:

   * C extensions that use integer format codes with the ‘PyArg_Parse*’
     family of functions will now raise a *note TypeError: 192.
     exception instead of triggering a *note DeprecationWarning: 276.
     (bpo-5080(14)).

   * Use the new *note PyOS_string_to_double(): c16. function instead of
     the old ‘PyOS_ascii_strtod()’ and ‘PyOS_ascii_atof()’ functions,
     which are now deprecated.

For applications that embed Python:

   * The *note PySys_SetArgvEx(): bed. function was added, letting
     applications close a security hole when the existing *note
     PySys_SetArgv(): cdf. function was used.  Check whether you’re
     calling *note PySys_SetArgv(): cdf. and carefully consider whether
     the application should be using *note PySys_SetArgvEx(): bed. with
     `updatepath' set to false.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1533

   (2) https://bugs.python.org/issue5920

   (3) https://bugs.python.org/issue6101

   (4) https://bugs.python.org/issue7853

   (5) https://bugs.python.org/issue7604

   (6) https://bugs.python.org/issue7150

   (7) https://bugs.python.org/issue6857

   (8) https://bugs.python.org/issue7279

   (9) https://bugs.python.org/issue2746

   (10) https://bugs.python.org/issue7348

   (11) https://bugs.python.org/issue8451

   (12) https://bugs.python.org/issue7357

   (13) https://tools.ietf.org/html/rfc3986.html

   (14) https://bugs.python.org/issue5080


File: python.info,  Node: New Features Added to Python 2 7 Maintenance Releases,  Next: Acknowledgements,  Prev: Porting to Python 2 7,  Up: What’s New in Python 2 7

1.10.15 New Features Added to Python 2.7 Maintenance Releases
-------------------------------------------------------------

New features may be added to Python 2.7 maintenance releases when the
situation genuinely calls for it.  Any such additions must go through
the Python Enhancement Proposal process, and make a compelling case for
why they can’t be adequately addressed by either adding the new feature
solely to Python 3, or else by publishing it on the Python Package
Index.

In addition to the specific proposals listed below, there is a general
exemption allowing new ‘-3’ warnings to be added in any Python 2.7
maintenance release.

* Menu:

* Two new environment variables for debug mode::
* PEP 434; IDLE Enhancement Exception for All Branches: PEP 434 IDLE Enhancement Exception for All Branches.
* PEP 466; Network Security Enhancements for Python 2.7: PEP 466 Network Security Enhancements for Python 2 7.
* PEP 477; Backport ensurepip (PEP 453) to 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 476 Enabling certificate verification by default for stdlib http clients<2>.
* PEP 493; HTTPS verification migration tools for Python 2.7: PEP 493 HTTPS verification migration tools for Python 2 7.
* New make regen-all build target: New make regen-all build target<3>.
* Removal of make touch build target: Removal of make touch build target<3>.


File: python.info,  Node: Two new environment variables for debug mode,  Next: PEP 434 IDLE Enhancement Exception for All Branches,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.1 Two new environment variables for debug mode
......................................................

In debug mode, the ‘[xxx refs]’ statistic is not written by default, the
‘PYTHONSHOWREFCOUNT’ environment variable now must also be set.
(Contributed by Victor Stinner; bpo-31733(1).)

When Python is compiled with ‘COUNT_ALLOC’ defined, allocation counts
are no longer dumped by default anymore: the ‘PYTHONSHOWALLOCCOUNT’
environment variable must now also be set.  Moreover, allocation counts
are now dumped into stderr, rather than stdout.  (Contributed by Victor
Stinner; bpo-31692(2).)

New in version 2.7.15.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31733

   (2) https://bugs.python.org/issue31692


File: python.info,  Node: PEP 434 IDLE Enhancement Exception for All Branches,  Next: PEP 466 Network Security Enhancements for Python 2 7,  Prev: Two new environment variables for debug mode,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.2 PEP 434: IDLE Enhancement Exception for All Branches
..............................................................

PEP 434(1) describes a general exemption for changes made to the IDLE
development environment shipped along with Python.  This exemption makes
it possible for the IDLE developers to provide a more consistent user
experience across all supported versions of Python 2 and 3.

For details of any IDLE changes, refer to the NEWS file for the specific
release.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0434


File: python.info,  Node: PEP 466 Network Security Enhancements for Python 2 7,  Next: PEP 477 Backport ensurepip PEP 453 to Python 2 7,  Prev: PEP 434 IDLE Enhancement Exception for All Branches,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.3 PEP 466: Network Security Enhancements for Python 2.7
...............................................................

PEP 466(1) describes a number of network security enhancement proposals
that have been approved for inclusion in Python 2.7 maintenance
releases, with the first of those changes appearing in the Python 2.7.7
release.

PEP 466(2) related features added in Python 2.7.7:

   * *note hmac.compare_digest(): a01. was backported from Python 3 to
     make a timing attack resistant comparison operation available to
     Python 2 applications.  (Contributed by Alex Gaynor; bpo-21306(3).)

   * OpenSSL 1.0.1g was upgraded in the official Windows installers
     published on python.org.  (Contributed by Zachary Ware;
     bpo-21462(4).)

PEP 466(5) related features added in Python 2.7.8:

   * *note hashlib.pbkdf2_hmac(): 7da. was backported from Python 3 to
     make a hashing algorithm suitable for secure password storage
     broadly available to Python 2 applications.  (Contributed by Alex
     Gaynor; bpo-21304(6).)

   * OpenSSL 1.0.1h was upgraded for the official Windows installers
     published on python.org.  (contributed by Zachary Ware in
     bpo-21671(7) for CVE-2014-0224)

PEP 466(8) related features added in Python 2.7.9:

   * Most of Python 3.4’s *note ssl: f3. module was backported.  This
     means *note ssl: f3. now supports Server Name Indication, TLS1.x
     settings, access to the platform certificate store, the *note
     SSLContext: 3d9. class, and other features.  (Contributed by Alex
     Gaynor and David Reid; bpo-21308(9).)

     Refer to the “Version added: 2.7.9” notes in the module
     documentation for specific details.

   * *note os.urandom(): 4c6. was changed to cache a file descriptor to
     ‘/dev/urandom’ instead of reopening ‘/dev/urandom’ on every call.
     (Contributed by Alex Gaynor; bpo-21305(10).)

   * *note hashlib.algorithms_guaranteed: cef. and *note
     hashlib.algorithms_available: cf0. were backported from Python 3 to
     make it easier for Python 2 applications to select the strongest
     available hash algorithm.  (Contributed by Alex Gaynor in
     bpo-21307(11))

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0466

   (2) https://www.python.org/dev/peps/pep-0466

   (3) https://bugs.python.org/issue21306

   (4) https://bugs.python.org/issue21462

   (5) https://www.python.org/dev/peps/pep-0466

   (6) https://bugs.python.org/issue21304

   (7) https://bugs.python.org/issue21671

   (8) https://www.python.org/dev/peps/pep-0466

   (9) https://bugs.python.org/issue21308

   (10) https://bugs.python.org/issue21305

   (11) https://bugs.python.org/issue21307


File: python.info,  Node: PEP 477 Backport ensurepip PEP 453 to Python 2 7,  Next: PEP 476 Enabling certificate verification by default for stdlib http clients<2>,  Prev: PEP 466 Network Security Enhancements for Python 2 7,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.4 PEP 477: Backport ensurepip (PEP 453) to Python 2.7
.............................................................

PEP 477(1) approves the inclusion of the PEP 453(2) ensurepip module and
the improved documentation that was enabled by it in the Python 2.7
maintenance releases, appearing first in the Python 2.7.9 release.

* Menu:

* Bootstrapping pip By Default: Bootstrapping pip By Default<2>.
* Documentation Changes: Documentation Changes<2>.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0477

   (2) https://www.python.org/dev/peps/pep-0453


File: python.info,  Node: Bootstrapping pip By Default<2>,  Next: Documentation Changes<2>,  Up: PEP 477 Backport ensurepip PEP 453 to Python 2 7

1.10.15.5 Bootstrapping pip By Default
......................................

The new *note ensurepip: 7a. module (defined in PEP 453(1)) provides a
standard cross-platform mechanism to bootstrap the pip installer into
Python installations.  The version of ‘pip’ included with Python 2.7.9
is ‘pip’ 1.5.6, and future 2.7.x maintenance releases will update the
bundled version to the latest version of ‘pip’ that is available at the
time of creating the release candidate.

By default, the commands ‘pip’, ‘pipX’ and ‘pipX.Y’ will be installed on
all platforms (where X.Y stands for the version of the Python
installation), along with the ‘pip’ Python package and its dependencies.

For CPython *note source builds on POSIX systems: 7e7, the ‘make
install’ and ‘make altinstall’ commands do not bootstrap ‘pip’ by
default.  This behaviour can be controlled through configure options,
and overridden through Makefile options.

On Windows and Mac OS X, the CPython installers now default to
installing ‘pip’ along with CPython itself (users may opt out of
installing it during the installation process).  Window users will need
to opt in to the automatic ‘PATH’ modifications to have ‘pip’ available
from the command line by default, otherwise it can still be accessed
through the Python launcher for Windows as ‘py -m pip’.

As discussed in the PEP(2), platform packagers may choose not to install
these commands by default, as long as, when invoked, they provide clear
and simple directions on how to install them on that platform (usually
using the system package manager).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0453

   (2) 
https://www.python.org/dev/peps/pep-0477/#disabling-ensurepip-by-downstream-distributors


File: python.info,  Node: Documentation Changes<2>,  Prev: Bootstrapping pip By Default<2>,  Up: PEP 477 Backport ensurepip PEP 453 to Python 2 7

1.10.15.6 Documentation Changes
...............................

As part of this change, the *note Installing Python Modules: 7e9. and
*note Distributing Python Modules: 7ea. sections of the documentation
have been completely redesigned as short getting started and FAQ
documents.  Most packaging documentation has now been moved out to the
Python Packaging Authority maintained Python Packaging User Guide(1) and
the documentation of the individual projects.

However, as this migration is currently still incomplete, the legacy
versions of those guides remaining available as *note Installing Python
Modules (Legacy version): 7eb. and *note Distributing Python Modules
(Legacy version): 7ec.

See also
........

PEP 453(2) – Explicit bootstrapping of pip in Python installations

     PEP written by Donald Stufft and Nick Coghlan, implemented by
     Donald Stufft, Nick Coghlan, Martin von Löwis and Ned Deily.

   ---------- Footnotes ----------

   (1) http://packaging.python.org

   (2) https://www.python.org/dev/peps/pep-0453


File: python.info,  Node: PEP 476 Enabling certificate verification by default for stdlib http clients<2>,  Next: PEP 493 HTTPS verification migration tools for Python 2 7,  Prev: PEP 477 Backport ensurepip PEP 453 to Python 2 7,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.7 PEP 476: Enabling certificate verification by default for stdlib http clients
.......................................................................................

PEP 476(1) updated ‘httplib’ and modules which use it, such as ‘urllib2’
and ‘xmlrpclib’, to now verify that the server presents a certificate
which is signed by a Certificate Authority in the platform trust store
and whose hostname matches the hostname being requested by default,
significantly improving security for many applications.  This change was
made in the Python 2.7.9 release.

For applications which require the old previous behavior, they can pass
an alternate context:

     import urllib2
     import ssl

     # This disables all verification
     context = ssl._create_unverified_context()

     # This allows using a specific certificate for the host, which doesn't need
     # to be in the trust store
     context = ssl.create_default_context(cafile="/path/to/file.crt")

     urllib2.urlopen("https://invalid-cert", context=context)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0476


File: python.info,  Node: PEP 493 HTTPS verification migration tools for Python 2 7,  Next: New make regen-all build target<3>,  Prev: PEP 476 Enabling certificate verification by default for stdlib http clients<2>,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.8 PEP 493: HTTPS verification migration tools for Python 2.7
....................................................................

PEP 493(1) provides additional migration tools to support a more
incremental infrastructure upgrade process for environments containing
applications and services relying on the historically permissive
processing of server certificates when establishing client HTTPS
connections.  These additions were made in the Python 2.7.12 release.

These tools are intended for use in cases where affected applications
and services can’t be modified to explicitly pass a more permissive SSL
context when establishing the connection.

For applications and services which can’t be modified at all, the new
‘PYTHONHTTPSVERIFY’ environment variable may be set to ‘0’ to revert an
entire Python process back to the default permissive behaviour of Python
2.7.8 and earlier.

For cases where the connection establishment code can’t be modified, but
the overall application can be, the new
‘ssl._https_verify_certificates()’ function can be used to adjust the
default behaviour at runtime.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0493


File: python.info,  Node: New make regen-all build target<3>,  Next: Removal of make touch build target<3>,  Prev: PEP 493 HTTPS verification migration tools for Python 2 7,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.9 New ‘make regen-all’ build target
...........................................

To simplify cross-compilation, and to ensure that CPython can reliably
be compiled without requiring an existing version of Python to already
be available, the autotools-based build system no longer attempts to
implicitly recompile generated files based on file modification times.

Instead, a new ‘make regen-all’ command has been added to force
regeneration of these files when desired (e.g.  after an initial version
of Python has already been built based on the pregenerated versions).

More selective regeneration targets are also defined - see
Makefile.pre.in(1) for details.

(Contributed by Victor Stinner in bpo-23404(2).)

New in version 2.7.14.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Makefile.pre.in

   (2) https://bugs.python.org/issue23404


File: python.info,  Node: Removal of make touch build target<3>,  Prev: New make regen-all build target<3>,  Up: New Features Added to Python 2 7 Maintenance Releases

1.10.15.10 Removal of ‘make touch’ build target
...............................................

The ‘make touch’ build target previously used to request implicit
regeneration of generated files by updating their modification times has
been removed.

It has been replaced by the new ‘make regen-all’ target.

(Contributed by Victor Stinner in bpo-23404(1).)

Changed in version 2.7.14.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23404


File: python.info,  Node: Acknowledgements,  Prev: New Features Added to Python 2 7 Maintenance Releases,  Up: What’s New in Python 2 7

1.10.16 Acknowledgements
------------------------

The author would like to thank the following people for offering
suggestions, corrections and assistance with various drafts of this
article: Nick Coghlan, Philip Jenvey, Ryan Lovett, R. David Murray, Hugh
Secker-Walker.


File: python.info,  Node: What’s New in Python 2 6,  Next: What’s New in Python 2 5,  Prev: What’s New in Python 2 7,  Up: What’s New in Python

1.11 What’s New in Python 2.6
=============================


Author: A.M. Kuchling (amk at amk.ca)

This article explains the new features in Python 2.6, released on
October 1 2008.  The release schedule is described in PEP 361(1).

The major theme of Python 2.6 is preparing the migration path to Python
3.0, a major redesign of the language.  Whenever possible, Python 2.6
incorporates new features and syntax from 3.0 while remaining compatible
with existing code by not removing older features or syntax.  When it’s
not possible to do that, Python 2.6 tries to do what it can, adding
compatibility functions in a ‘future_builtins’ module and a ‘-3’ switch
to warn about usages that will become unsupported in 3.0.

Some significant new packages have been added to the standard library,
such as the *note multiprocessing: b7. and *note json: a4. modules, but
there aren’t many new features that aren’t related to Python 3.0 in some
way.

Python 2.6 also sees a number of improvements and bugfixes throughout
the source.  A search through the change logs finds there were 259
patches applied and 612 bugs fixed between Python 2.5 and 2.6.  Both
figures are likely to be underestimates.

This article doesn’t attempt to provide a complete specification of the
new features, but instead provides a convenient overview.  For full
details, you should refer to the documentation for Python 2.6.  If you
want to understand the rationale for the design and implementation,
refer to the PEP for a particular new feature.  Whenever possible,
“What’s New in Python” links to the bug/patch item for each change.

* Menu:

* Python 3.0: Python 3 0.
* Changes to the Development Process::
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement.
* PEP 366; Explicit Relative Imports From a Main Module: PEP 366 Explicit Relative Imports From a Main Module.
* PEP 370; Per-user site-packages Directory: PEP 370 Per-user site-packages Directory.
* PEP 371; The multiprocessing Package: PEP 371 The multiprocessing Package.
* PEP 3101; Advanced String Formatting: PEP 3101 Advanced String Formatting.
* PEP 3105; print As a Function: PEP 3105 print As a Function.
* PEP 3110; Exception-Handling Changes: PEP 3110 Exception-Handling Changes.
* PEP 3112; Byte Literals: PEP 3112 Byte Literals.
* PEP 3116; New I/O Library: PEP 3116 New I/O Library.
* PEP 3118; Revised Buffer Protocol: PEP 3118 Revised Buffer Protocol.
* PEP 3119; Abstract Base Classes: PEP 3119 Abstract Base Classes.
* PEP 3127; Integer Literal Support and Syntax: PEP 3127 Integer Literal Support and Syntax.
* PEP 3129; Class Decorators: PEP 3129 Class Decorators.
* PEP 3141; A Type Hierarchy for Numbers: PEP 3141 A Type Hierarchy for Numbers.
* Other Language Changes: Other Language Changes<10>.
* New and Improved Modules: New and Improved Modules<2>.
* Deprecations and Removals::
* Build and C API Changes: Build and C API Changes<9>.
* Porting to Python 2.6: Porting to Python 2 6.
* Acknowledgements: Acknowledgements<2>.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0361


File: python.info,  Node: Python 3 0,  Next: Changes to the Development Process,  Up: What’s New in Python 2 6

1.11.1 Python 3.0
-----------------

The development cycle for Python versions 2.6 and 3.0 was synchronized,
with the alpha and beta releases for both versions being made on the
same days.  The development of 3.0 has influenced many features in 2.6.

Python 3.0 is a far-ranging redesign of Python that breaks compatibility
with the 2.x series.  This means that existing Python code will need
some conversion in order to run on Python 3.0.  However, not all the
changes in 3.0 necessarily break compatibility.  In cases where new
features won’t cause existing code to break, they’ve been backported to
2.6 and are described in this document in the appropriate place.  Some
of the 3.0-derived features are:

   * A *note __complex__(): 18d. method for converting objects to a
     complex number.

   * Alternate syntax for catching exceptions: ‘except TypeError as
     exc’.

   * The addition of *note functools.reduce(): c62. as a synonym for the
     built-in ‘reduce()’ function.

Python 3.0 adds several new built-in functions and changes the semantics
of some existing builtins.  Functions that are new in 3.0 such as *note
bin(): c33. have simply been added to Python 2.6, but existing builtins
haven’t been changed; instead, the ‘future_builtins’ module has versions
with the new 3.0 semantics.  Code written to be compatible with 3.0 can
do ‘from future_builtins import hex, map’ as necessary.

A new command-line switch, ‘-3’, enables warnings about features that
will be removed in Python 3.0.  You can run code with this switch to see
how much work will be necessary to port code to 3.0.  The value of this
switch is available to Python code as the boolean variable
‘sys.py3kwarning’, and to C extension code as ‘Py_Py3kWarningFlag’.

See also
........

The 3xxx series of PEPs, which contains proposals for Python 3.0.  PEP
3000(1) describes the development process for Python 3.0.  Start with
PEP 3100(2) that describes the general goals for Python 3.0, and then
explore the higher-numbered PEPS that propose specific features.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3000

   (2) https://www.python.org/dev/peps/pep-3100


File: python.info,  Node: Changes to the Development Process,  Next: PEP 343 The ‘with’ statement,  Prev: Python 3 0,  Up: What’s New in Python 2 6

1.11.2 Changes to the Development Process
-----------------------------------------

While 2.6 was being developed, the Python development process underwent
two significant changes: we switched from SourceForge’s issue tracker to
a customized Roundup installation, and the documentation was converted
from LaTeX to reStructuredText.

* Menu:

* New Issue Tracker; Roundup: New Issue Tracker Roundup.
* New Documentation Format; reStructuredText Using Sphinx: New Documentation Format reStructuredText Using Sphinx.


File: python.info,  Node: New Issue Tracker Roundup,  Next: New Documentation Format reStructuredText Using Sphinx,  Up: Changes to the Development Process

1.11.2.1 New Issue Tracker: Roundup
...................................

For a long time, the Python developers had been growing increasingly
annoyed by SourceForge’s bug tracker.  SourceForge’s hosted solution
doesn’t permit much customization; for example, it wasn’t possible to
customize the life cycle of issues.

The infrastructure committee of the Python Software Foundation therefore
posted a call for issue trackers, asking volunteers to set up different
products and import some of the bugs and patches from SourceForge.  Four
different trackers were examined: Jira(1), Launchpad(2), Roundup(3), and
Trac(4).  The committee eventually settled on Jira and Roundup as the
two candidates.  Jira is a commercial product that offers no-cost hosted
instances to free-software projects; Roundup is an open-source project
that requires volunteers to administer it and a server to host it.

After posting a call for volunteers, a new Roundup installation was set
up at ‘https://bugs.python.org’.  One installation of Roundup can host
multiple trackers, and this server now also hosts issue trackers for
Jython and for the Python web site.  It will surely find other uses in
the future.  Where possible, this edition of “What’s New in Python”
links to the bug/patch item for each change.

Hosting of the Python bug tracker is kindly provided by Upfront
Systems(5) of Stellenbosch, South Africa.  Martin von Löwis put a lot of
effort into importing existing bugs and patches from SourceForge; his
scripts for this import operation are at
‘http://svn.python.org/view/tracker/importer/’ and may be useful to
other projects wishing to move from SourceForge to Roundup.

See also
........

‘https://bugs.python.org’

     The Python bug tracker.

‘http://bugs.jython.org’:

     The Jython bug tracker.

‘http://roundup.sourceforge.net/’

     Roundup downloads and documentation.

‘http://svn.python.org/view/tracker/importer/’

     Martin von Löwis’s conversion scripts.

   ---------- Footnotes ----------

   (1) https://www.atlassian.com/software/jira/

   (2) https://launchpad.net/

   (3) http://roundup.sourceforge.net/

   (4) https://trac.edgewall.org/

   (5) http://www.upfrontsoftware.co.za


File: python.info,  Node: New Documentation Format reStructuredText Using Sphinx,  Prev: New Issue Tracker Roundup,  Up: Changes to the Development Process

1.11.2.2 New Documentation Format: reStructuredText Using Sphinx
................................................................

The Python documentation was written using LaTeX since the project
started around 1989.  In the 1980s and early 1990s, most documentation
was printed out for later study, not viewed online.  LaTeX was widely
used because it provided attractive printed output while remaining
straightforward to write once the basic rules of the markup were
learned.

Today LaTeX is still used for writing publications destined for
printing, but the landscape for programming tools has shifted.  We no
longer print out reams of documentation; instead, we browse through it
online and HTML has become the most important format to support.
Unfortunately, converting LaTeX to HTML is fairly complicated and Fred
L. Drake Jr., the long-time Python documentation editor, spent a lot of
time maintaining the conversion process.  Occasionally people would
suggest converting the documentation into SGML and later XML, but
performing a good conversion is a major task and no one ever committed
the time required to finish the job.

During the 2.6 development cycle, Georg Brandl put a lot of effort into
building a new toolchain for processing the documentation.  The
resulting package is called Sphinx, and is available from
‘http://sphinx-doc.org/’.

Sphinx concentrates on HTML output, producing attractively styled and
modern HTML; printed output is still supported through conversion to
LaTeX. The input format is reStructuredText, a markup syntax supporting
custom extensions and directives that is commonly used in the Python
community.

Sphinx is a standalone package that can be used for writing, and almost
two dozen other projects (listed on the Sphinx web site(1)) have adopted
Sphinx as their documentation tool.

See also
........

Documenting Python(2)

     Describes how to write for Python’s documentation.

Sphinx(3)

     Documentation and code for the Sphinx toolchain.

Docutils(4)

     The underlying reStructuredText parser and toolset.

   ---------- Footnotes ----------

   (1) https://www.sphinx-doc.org/en/master/examples.html

   (2) https://devguide.python.org/documenting/

   (3) http://sphinx-doc.org/

   (4) http://docutils.sourceforge.net


File: python.info,  Node: PEP 343 The ‘with’ statement,  Next: PEP 366 Explicit Relative Imports From a Main Module,  Prev: Changes to the Development Process,  Up: What’s New in Python 2 6

1.11.3 PEP 343: The ‘with’ statement
------------------------------------

The previous version, Python 2.5, added the ‘*note with: 6dd.’ statement
as an optional feature, to be enabled by a ‘from __future__ import
with_statement’ directive.  In 2.6 the statement no longer needs to be
specially enabled; this means that ‘with’ is now always a keyword.  The
rest of this section is a copy of the corresponding section from the
“What’s New in Python 2.5” document; if you’re familiar with the
‘‘with’’ statement from Python 2.5, you can skip this section.

The ‘*note with: 6dd.’ statement clarifies code that previously would
use ‘try...finally’ blocks to ensure that clean-up code is executed.  In
this section, I’ll discuss the statement as it will commonly be used.
In the next section, I’ll examine the implementation details and show
how to write objects for use with this statement.

The ‘*note with: 6dd.’ statement is a control-flow structure whose basic
structure is:

     with expression [as variable]:
         with-block

The expression is evaluated, and it should result in an object that
supports the context management protocol (that is, has *note
__enter__(): c88. and *note __exit__(): c89. methods).

The object’s *note __enter__(): c88. is called before `with-block' is
executed and therefore can run set-up code.  It also may return a value
that is bound to the name `variable', if given.  (Note carefully that
`variable' is `not' assigned the result of `expression'.)

After execution of the `with-block' is finished, the object’s *note
__exit__(): c89. method is called, even if the block raised an
exception, and can therefore run clean-up code.

Some standard Python objects now support the context management protocol
and can be used with the ‘*note with: 6dd.’ statement.  File objects are
one example:

     with open('/etc/passwd', 'r') as f:
         for line in f:
             print line
             ... more processing code ...

After this statement has executed, the file object in `f' will have been
automatically closed, even if the *note for: c23. loop raised an
exception part-way through the block.

     Note: In this case, `f' is the same object created by *note open():
     4e5, because ‘file.__enter__()’ returns `self'.

The *note threading: 109. module’s locks and condition variables also
support the ‘*note with: 6dd.’ statement:

     lock = threading.Lock()
     with lock:
         # Critical section of code
         ...

The lock is acquired before the block is executed and always released
once the block is complete.

The ‘localcontext()’ function in the *note decimal: 36. module makes it
easy to save and restore the current decimal context, which encapsulates
the desired precision and rounding characteristics for computations:

     from decimal import Decimal, Context, localcontext

     # Displays with default precision of 28 digits
     v = Decimal('578')
     print v.sqrt()

     with localcontext(Context(prec=16)):
         # All code in this block uses a precision of 16 digits.
         # The original context is restored on exiting the block.
         print v.sqrt()

* Menu:

* Writing Context Managers::
* The contextlib module::


File: python.info,  Node: Writing Context Managers,  Next: The contextlib module,  Up: PEP 343 The ‘with’ statement

1.11.3.1 Writing Context Managers
.................................

Under the hood, the ‘*note with: 6dd.’ statement is fairly complicated.
Most people will only use ‘‘with’’ in company with existing objects and
don’t need to know these details, so you can skip the rest of this
section if you like.  Authors of new objects will need to understand the
details of the underlying implementation and should keep reading.

A high-level explanation of the context management protocol is:

   * The expression is evaluated and should result in an object called a
     “context manager”.  The context manager must have *note
     __enter__(): c88. and *note __exit__(): c89. methods.

   * The context manager’s *note __enter__(): c88. method is called.
     The value returned is assigned to `VAR'. If no ‘as VAR’ clause is
     present, the value is simply discarded.

   * The code in `BLOCK' is executed.

   * If `BLOCK' raises an exception, the context manager’s *note
     __exit__(): c89. method is called with three arguments, the
     exception details (‘type, value, traceback’, the same values
     returned by *note sys.exc_info(): c52, which can also be ‘None’ if
     no exception occurred).  The method’s return value controls whether
     an exception is re-raised: any false value re-raises the exception,
     and ‘True’ will result in suppressing it.  You’ll only rarely want
     to suppress the exception, because if you do the author of the code
     containing the ‘*note with: 6dd.’ statement will never realize
     anything went wrong.

   * If `BLOCK' didn’t raise an exception, the *note __exit__(): c89.
     method is still called, but `type', `value', and `traceback' are
     all ‘None’.

Let’s think through an example.  I won’t present detailed code but will
only sketch the methods necessary for a database that supports
transactions.

(For people unfamiliar with database terminology: a set of changes to
the database are grouped into a transaction.  Transactions can be either
committed, meaning that all the changes are written into the database,
or rolled back, meaning that the changes are all discarded and the
database is unchanged.  See any database textbook for more information.)

Let’s assume there’s an object representing a database connection.  Our
goal will be to let the user write code like this:

     db_connection = DatabaseConnection()
     with db_connection as cursor:
         cursor.execute('insert into ...')
         cursor.execute('delete from ...')
         # ... more operations ...

The transaction should be committed if the code in the block runs
flawlessly or rolled back if there’s an exception.  Here’s the basic
interface for ‘DatabaseConnection’ that I’ll assume:

     class DatabaseConnection:
         # Database interface
         def cursor(self):
             "Returns a cursor object and starts a new transaction"
         def commit(self):
             "Commits current transaction"
         def rollback(self):
             "Rolls back current transaction"

The *note __enter__(): c88. method is pretty easy, having only to start
a new transaction.  For this application the resulting cursor object
would be a useful result, so the method will return it.  The user can
then add ‘as cursor’ to their ‘*note with: 6dd.’ statement to bind the
cursor to a variable name.

     class DatabaseConnection:
         ...
         def __enter__(self):
             # Code to start a new transaction
             cursor = self.cursor()
             return cursor

The *note __exit__(): c89. method is the most complicated because it’s
where most of the work has to be done.  The method has to check if an
exception occurred.  If there was no exception, the transaction is
committed.  The transaction is rolled back if there was an exception.

In the code below, execution will just fall off the end of the function,
returning the default value of ‘None’.  ‘None’ is false, so the
exception will be re-raised automatically.  If you wished, you could be
more explicit and add a *note return: 190. statement at the marked
location.

     class DatabaseConnection:
         ...
         def __exit__(self, type, value, tb):
             if tb is None:
                 # No exception, so commit
                 self.commit()
             else:
                 # Exception occurred, so rollback.
                 self.rollback()
                 # return False


File: python.info,  Node: The contextlib module,  Prev: Writing Context Managers,  Up: PEP 343 The ‘with’ statement

1.11.3.2 The contextlib module
..............................

The *note contextlib: 24. module provides some functions and a decorator
that are useful when writing objects for use with the ‘*note with: 6dd.’
statement.

The decorator is called ‘contextmanager()’, and lets you write a single
generator function instead of defining a new class.  The generator
should yield exactly one value.  The code up to the *note yield: 18f.
will be executed as the *note __enter__(): c88. method, and the value
yielded will be the method’s return value that will get bound to the
variable in the ‘*note with: 6dd.’ statement’s ‘as’ clause, if any.  The
code after the ‘yield’ will be executed in the *note __exit__(): c89.
method.  Any exception raised in the block will be raised by the ‘yield’
statement.

Using this decorator, our database example from the previous section
could be written as:

     from contextlib import contextmanager

     @contextmanager
     def db_transaction(connection):
         cursor = connection.cursor()
         try:
             yield cursor
         except:
             connection.rollback()
             raise
         else:
             connection.commit()

     db = DatabaseConnection()
     with db_transaction(db) as cursor:
         ...

The *note contextlib: 24. module also has a ‘nested(mgr1, mgr2, ...)’
function that combines a number of context managers so you don’t need to
write nested ‘*note with: 6dd.’ statements.  In this example, the single
‘‘with’’ statement both starts a database transaction and acquires a
thread lock:

     lock = threading.Lock()
     with nested (db_transaction(db), lock) as (cursor, locked):
         ...

Finally, the ‘closing()’ function returns its argument so that it can be
bound to a variable, and calls the argument’s ‘.close()’ method at the
end of the block.

     import urllib, sys
     from contextlib import closing

     with closing(urllib.urlopen('http://www.yahoo.com')) as f:
         for line in f:
             sys.stdout.write(line)

See also
........

PEP 343(1) - The “with” statement

     PEP written by Guido van Rossum and Nick Coghlan; implemented by
     Mike Bland, Guido van Rossum, and Neal Norwitz.  The PEP shows the
     code generated for a ‘*note with: 6dd.’ statement, which can be
     helpful in learning how the statement works.

The documentation for the *note contextlib: 24. module.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0343


File: python.info,  Node: PEP 366 Explicit Relative Imports From a Main Module,  Next: PEP 370 Per-user site-packages Directory,  Prev: PEP 343 The ‘with’ statement,  Up: What’s New in Python 2 6

1.11.4 PEP 366: Explicit Relative Imports From a Main Module
------------------------------------------------------------

Python’s *note -m: 32c. switch allows running a module as a script.
When you ran a module that was located inside a package, relative
imports didn’t work correctly.

The fix for Python 2.6 adds a *note __package__: 949. attribute to
modules.  When this attribute is present, relative imports will be
relative to the value of this attribute instead of the *note __name__:
d05. attribute.

PEP 302-style importers can then set *note __package__: 949. as
necessary.  The *note runpy: e2. module that implements the *note -m:
32c. switch now does this, so relative imports will now work correctly
in scripts running from inside a package.


File: python.info,  Node: PEP 370 Per-user site-packages Directory,  Next: PEP 371 The multiprocessing Package,  Prev: PEP 366 Explicit Relative Imports From a Main Module,  Up: What’s New in Python 2 6

1.11.5 PEP 370: Per-user ‘site-packages’ Directory
--------------------------------------------------

When you run Python, the module search path ‘sys.path’ usually includes
a directory whose path ends in ‘"site-packages"’.  This directory is
intended to hold locally-installed packages available to all users using
a machine or a particular site installation.

Python 2.6 introduces a convention for user-specific site directories.
The directory varies depending on the platform:

   * Unix and Mac OS X: ‘~/.local/’

   * Windows: ‘%APPDATA%/Python’

Within this directory, there will be version-specific subdirectories,
such as ‘lib/python2.6/site-packages’ on Unix/Mac OS and
‘Python26/site-packages’ on Windows.

If you don’t like the default directory, it can be overridden by an
environment variable.  *note PYTHONUSERBASE: d07. sets the root
directory used for all Python versions supporting this feature.  On
Windows, the directory for application-specific data can be changed by
setting the ‘APPDATA’ environment variable.  You can also modify the
‘site.py’ file for your Python installation.

The feature can be disabled entirely by running Python with the *note
-s: d08. option or setting the *note PYTHONNOUSERSITE: d09. environment
variable.

See also
........

PEP 370(1) - Per-user ‘site-packages’ Directory

     PEP written and implemented by Christian Heimes.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0370


File: python.info,  Node: PEP 371 The multiprocessing Package,  Next: PEP 3101 Advanced String Formatting,  Prev: PEP 370 Per-user site-packages Directory,  Up: What’s New in Python 2 6

1.11.6 PEP 371: The ‘multiprocessing’ Package
---------------------------------------------

The new *note multiprocessing: b7. package lets Python programs create
new processes that will perform a computation and return a result to the
parent.  The parent and child processes can communicate using queues and
pipes, synchronize their operations using locks and semaphores, and can
share simple arrays of data.

The *note multiprocessing: b7. module started out as an exact emulation
of the *note threading: 109. module using processes instead of threads.
That goal was discarded along the path to Python 2.6, but the general
approach of the module is still similar.  The fundamental class is the
‘Process’, which is passed a callable object and a collection of
arguments.  The ‘start()’ method sets the callable running in a
subprocess, after which you can call the ‘is_alive()’ method to check
whether the subprocess is still running and the ‘join()’ method to wait
for the process to exit.

Here’s a simple example where the subprocess will calculate a factorial.
The function doing the calculation is written strangely so that it takes
significantly longer when the input argument is a multiple of 4.

     import time
     from multiprocessing import Process, Queue


     def factorial(queue, N):
         "Compute a factorial."
         # If N is a multiple of 4, this function will take much longer.
         if (N % 4) == 0:
             time.sleep(.05 * N/4)

         # Calculate the result
         fact = 1L
         for i in range(1, N+1):
             fact = fact * i

         # Put the result on the queue
         queue.put(fact)

     if __name__ == '__main__':
         queue = Queue()

         N = 5

         p = Process(target=factorial, args=(queue, N))
         p.start()
         p.join()

         result = queue.get()
         print 'Factorial', N, '=', result

A *note Queue: d0b. is used to communicate the result of the factorial.
The *note Queue: d0b. object is stored in a global variable.  The child
process will use the value of the variable when the child was created;
because it’s a *note Queue: d0b, parent and child can use the object to
communicate.  (If the parent were to change the value of the global
variable, the child’s value would be unaffected, and vice versa.)

Two other classes, ‘Pool’ and ‘Manager’, provide higher-level
interfaces.  ‘Pool’ will create a fixed number of worker processes, and
requests can then be distributed to the workers by calling ‘apply()’ or
‘apply_async()’ to add a single request, and *note map(): c20. or
‘map_async()’ to add a number of requests.  The following code uses a
‘Pool’ to spread requests across 5 worker processes and retrieve a list
of results:

     from multiprocessing import Pool

     def factorial(N, dictionary):
         "Compute a factorial."
         ...
     p = Pool(5)
     result = p.map(factorial, range(1, 1000, 10))
     for v in result:
         print v

This produces the following output:

     1
     39916800
     51090942171709440000
     8222838654177922817725562880000000
     33452526613163807108170062053440751665152000000000
     ...

The other high-level interface, the ‘Manager’ class, creates a separate
server process that can hold master copies of Python data structures.
Other processes can then access and modify these data structures using
proxy objects.  The following example creates a shared dictionary by
calling the *note dict(): 1b6. method; the worker processes then insert
values into the dictionary.  (Locking is not done for you automatically,
which doesn’t matter in this example.  ‘Manager’’s methods also include
‘Lock()’, ‘RLock()’, and ‘Semaphore()’ to create shared locks.)

     import time
     from multiprocessing import Pool, Manager

     def factorial(N, dictionary):
         "Compute a factorial."
         # Calculate the result
         fact = 1L
         for i in range(1, N+1):
             fact = fact * i

         # Store result in dictionary
         dictionary[N] = fact

     if __name__ == '__main__':
         p = Pool(5)
         mgr = Manager()
         d = mgr.dict()         # Create shared dictionary

         # Run tasks using the pool
         for N in range(1, 1000, 10):
             p.apply_async(factorial, (N, d))

         # Mark pool as closed -- no more tasks can be added.
         p.close()

         # Wait for tasks to exit
         p.join()

         # Output results
         for k, v in sorted(d.items()):
             print k, v

This will produce the output:

     1 1
     11 39916800
     21 51090942171709440000
     31 8222838654177922817725562880000000
     41 33452526613163807108170062053440751665152000000000
     51 15511187532873822802242430164693032110632597200169861120000...

See also
........

The documentation for the *note multiprocessing: b7. module.

PEP 371(1) - Addition of the multiprocessing package

     PEP written by Jesse Noller and Richard Oudkerk; implemented by
     Richard Oudkerk and Jesse Noller.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0371


File: python.info,  Node: PEP 3101 Advanced String Formatting,  Next: PEP 3105 print As a Function,  Prev: PEP 371 The multiprocessing Package,  Up: What’s New in Python 2 6

1.11.7 PEP 3101: Advanced String Formatting
-------------------------------------------

In Python 3.0, the ‘%’ operator is supplemented by a more powerful
string formatting method, *note format(): 4d0.  Support for the *note
str.format(): 4cf. method has been backported to Python 2.6.

In 2.6, both 8-bit and Unicode strings have a ‘.format()’ method that
treats the string as a template and takes the arguments to be formatted.
The formatting template uses curly brackets (‘{’, ‘}’) as special
characters:

     >>> # Substitute positional argument 0 into the string.
     >>> "User ID: {0}".format("root")
     'User ID: root'
     >>> # Use the named keyword arguments
     >>> "User ID: {uid}   Last seen: {last_login}".format(
     ...    uid="root",
     ...    last_login = "5 Mar 2008 07:20")
     'User ID: root   Last seen: 5 Mar 2008 07:20'

Curly brackets can be escaped by doubling them:

     >>> "Empty dict: {{}}".format()
     "Empty dict: {}"

Field names can be integers indicating positional arguments, such as
‘{0}’, ‘{1}’, etc.  or names of keyword arguments.  You can also supply
compound field names that read attributes or access dictionary keys:

     >>> import sys
     >>> print 'Platform: {0.platform}\nPython version: {0.version}'.format(sys)
     Platform: darwin
     Python version: 2.6a1+ (trunk:61261M, Mar  5 2008, 20:29:41)
     [GCC 4.0.1 (Apple Computer, Inc. build 5367)]'

     >>> import mimetypes
     >>> 'Content-type: {0[.mp4]}'.format(mimetypes.types_map)
     'Content-type: video/mp4'

Note that when using dictionary-style notation such as ‘[.mp4]’, you
don’t need to put any quotation marks around the string; it will look up
the value using ‘.mp4’ as the key.  Strings beginning with a number will
be converted to an integer.  You can’t write more complicated
expressions inside a format string.

So far we’ve shown how to specify which field to substitute into the
resulting string.  The precise formatting used is also controllable by
adding a colon followed by a format specifier.  For example:

     >>> # Field 0: left justify, pad to 15 characters
     >>> # Field 1: right justify, pad to 6 characters
     >>> fmt = '{0:15} ${1:>6}'
     >>> fmt.format('Registration', 35)
     'Registration    $    35'
     >>> fmt.format('Tutorial', 50)
     'Tutorial        $    50'
     >>> fmt.format('Banquet', 125)
     'Banquet         $   125'

Format specifiers can reference other fields through nesting:

     >>> fmt = '{0:{1}}'
     >>> width = 15
     >>> fmt.format('Invoice #1234', width)
     'Invoice #1234  '
     >>> width = 35
     >>> fmt.format('Invoice #1234', width)
     'Invoice #1234                      '

The alignment of a field within the desired width can be specified:

Character            Effect
                     
----------------------------------------------------------------------
                     
< (default)          Left-align
                     
                     
>                    Right-align
                     
                     
^                    Center
                     
                     
=                    (For numeric types only) Pad after the sign.
                     

Format specifiers can also include a presentation type, which controls
how the value is formatted.  For example, floating-point numbers can be
formatted as a general number or in exponential notation:

     >>> '{0:g}'.format(3.75)
     '3.75'
     >>> '{0:e}'.format(3.75)
     '3.750000e+00'

A variety of presentation types are available.  Consult the 2.6
documentation for a *note complete list: d0d.; here’s a sample:

‘b’       Binary.  Outputs the number in base 2.
          
          
‘c’       Character.  Converts the integer to the corresponding Unicode character
          before printing.
          
          
‘d’       Decimal Integer.  Outputs the number in base 10.
          
          
‘o’       Octal format.  Outputs the number in base 8.
          
          
‘x’       Hex format.  Outputs the number in base 16, using lower-case letters for
          the digits above 9.
          
          
‘e’       Exponent notation.  Prints the number in scientific notation using the
          letter ‘e’ to indicate the exponent.
          
          
‘g’       General format.  This prints the number as a fixed-point number, unless
          the number is too large, in which case it switches to ‘e’ exponent
          notation.
          
          
‘n’       Number.  This is the same as ‘g’ (for floats) or ‘d’ (for integers),
          except that it uses the current locale setting to insert the appropriate
          number separator characters.
          
          
‘%’       Percentage.  Multiplies the number by 100 and displays in fixed (‘f’)
          format, followed by a percent sign.
          

Classes and types can define a *note __format__(): 942. method to
control how they’re formatted.  It receives a single argument, the
format specifier:

     def __format__(self, format_spec):
         if isinstance(format_spec, unicode):
             return unicode(str(self))
         else:
             return str(self)

There’s also a *note format(): 4d0. builtin that will format a single
value.  It calls the type’s *note __format__(): 942. method with the
provided specifier:

     >>> format(75.6564, '.2f')
     '75.66'

See also
........

*note Format String Syntax: d0d.

     The reference documentation for format fields.

PEP 3101(1) - Advanced String Formatting

     PEP written by Talin.  Implemented by Eric Smith.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3101


File: python.info,  Node: PEP 3105 print As a Function,  Next: PEP 3110 Exception-Handling Changes,  Prev: PEP 3101 Advanced String Formatting,  Up: What’s New in Python 2 6

1.11.8 PEP 3105: ‘print’ As a Function
--------------------------------------

The ‘print’ statement becomes the *note print(): 87a. function in Python
3.0.  Making *note print(): 87a. a function makes it possible to replace
the function by doing ‘def print(...)’ or importing a new function from
somewhere else.

Python 2.6 has a ‘__future__’ import that removes ‘print’ as language
syntax, letting you use the functional form instead.  For example:

     >>> from __future__ import print_function
     >>> print('# of entries', len(dictionary), file=sys.stderr)

The signature of the new function is:

     def print(*args, sep=' ', end='\n', file=None)

The parameters are:

        * `args': positional arguments whose values will be printed out.

        * `sep': the separator, which will be printed between arguments.

        * `end': the ending text, which will be printed after all of the
          arguments have been output.

        * `file': the file object to which the output will be sent.

See also
........

PEP 3105(1) - Make print a function

     PEP written by Georg Brandl.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3105


File: python.info,  Node: PEP 3110 Exception-Handling Changes,  Next: PEP 3112 Byte Literals,  Prev: PEP 3105 print As a Function,  Up: What’s New in Python 2 6

1.11.9 PEP 3110: Exception-Handling Changes
-------------------------------------------

One error that Python programmers occasionally make is writing the
following code:

     try:
         ...
     except TypeError, ValueError:  # Wrong!
         ...

The author is probably trying to catch both *note TypeError: 192. and
*note ValueError: 1f9. exceptions, but this code actually does something
different: it will catch *note TypeError: 192. and bind the resulting
exception object to the local name ‘"ValueError"’.  The *note
ValueError: 1f9. exception will not be caught at all.  The correct code
specifies a tuple of exceptions:

     try:
         ...
     except (TypeError, ValueError):
         ...

This error happens because the use of the comma here is ambiguous: does
it indicate two different nodes in the parse tree, or a single node
that’s a tuple?

Python 3.0 makes this unambiguous by replacing the comma with the word
“as”.  To catch an exception and store the exception object in the
variable ‘exc’, you must write:

     try:
         ...
     except TypeError as exc:
         ...

Python 3.0 will only support the use of “as”, and therefore interprets
the first example as catching two different exceptions.  Python 2.6
supports both the comma and “as”, so existing code will continue to
work.  We therefore suggest using “as” when writing new Python code that
will only be executed with 2.6.

See also
........

PEP 3110(1) - Catching Exceptions in Python 3000

     PEP written and implemented by Collin Winter.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3110


File: python.info,  Node: PEP 3112 Byte Literals,  Next: PEP 3116 New I/O Library,  Prev: PEP 3110 Exception-Handling Changes,  Up: What’s New in Python 2 6

1.11.10 PEP 3112: Byte Literals
-------------------------------

Python 3.0 adopts Unicode as the language’s fundamental string type and
denotes 8-bit literals differently, either as ‘b'string'’ or using a
*note bytes: 326. constructor.  For future compatibility, Python 2.6
adds *note bytes: 326. as a synonym for the *note str: 325. type, and it
also supports the ‘b''’ notation.

The 2.6 *note str: 325. differs from 3.0’s *note bytes: 326. type in
various ways; most notably, the constructor is completely different.  In
3.0, ‘bytes([65, 66, 67])’ is 3 elements long, containing the bytes
representing ‘ABC’; in 2.6, ‘bytes([65, 66, 67])’ returns the 12-byte
string representing the *note str(): 325. of the list.

The primary use of *note bytes: 326. in 2.6 will be to write tests of
object type such as ‘isinstance(x, bytes)’.  This will help the 2to3
converter, which can’t tell whether 2.x code intends strings to contain
either characters or 8-bit bytes; you can now use either *note bytes:
326. or *note str: 325. to represent your intention exactly, and the
resulting code will also be correct in Python 3.0.

There’s also a ‘__future__’ import that causes all string literals to
become Unicode strings.  This means that ‘\u’ escape sequences can be
used to include Unicode characters:

     from __future__ import unicode_literals

     s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
          '\u3081\u3000\u751f\u305f\u307e\u3054')

     print len(s)               # 12 Unicode characters

At the C level, Python 3.0 will rename the existing 8-bit string type,
called ‘PyStringObject’ in Python 2.x, to *note PyBytesObject: d11.
Python 2.6 uses ‘#define’ to support using the names *note
PyBytesObject(): d11, *note PyBytes_Check(): d12, *note
PyBytes_FromStringAndSize(): d13, and all the other functions and macros
used with strings.

Instances of the *note bytes: 326. type are immutable just as strings
are.  A new *note bytearray: 327. type stores a mutable sequence of
bytes:

     >>> bytearray([65, 66, 67])
     bytearray(b'ABC')
     >>> b = bytearray(u'\u21ef\u3244', 'utf-8')
     >>> b
     bytearray(b'\xe2\x87\xaf\xe3\x89\x84')
     >>> b[0] = '\xe3'
     >>> b
     bytearray(b'\xe3\x87\xaf\xe3\x89\x84')
     >>> unicode(str(b), 'utf-8')
     u'\u31ef \u3244'

Byte arrays support most of the methods of string types, such as
‘startswith()’/‘endswith()’, ‘find()’/‘rfind()’, and some of the methods
of lists, such as ‘append()’, ‘pop()’, and ‘reverse()’.

     >>> b = bytearray('ABC')
     >>> b.append('d')
     >>> b.append(ord('e'))
     >>> b
     bytearray(b'ABCde')

There’s also a corresponding C API, with *note PyByteArray_FromObject():
d14, *note PyByteArray_FromStringAndSize(): d15, and various other
functions.

See also
........

PEP 3112(1) - Bytes literals in Python 3000

     PEP written by Jason Orendorff; backported to 2.6 by Christian
     Heimes.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3112


File: python.info,  Node: PEP 3116 New I/O Library,  Next: PEP 3118 Revised Buffer Protocol,  Prev: PEP 3112 Byte Literals,  Up: What’s New in Python 2 6

1.11.11 PEP 3116: New I/O Library
---------------------------------

Python’s built-in file objects support a number of methods, but
file-like objects don’t necessarily support all of them.  Objects that
imitate files usually support ‘read()’ and ‘write()’, but they may not
support *note readline(): de, for example.  Python 3.0 introduces a
layered I/O library in the *note io: a1. module that separates buffering
and text-handling features from the fundamental read and write
operations.

There are three levels of abstract base classes provided by the *note
io: a1. module:

   * ‘RawIOBase’ defines raw I/O operations: ‘read()’, ‘readinto()’,
     ‘write()’, ‘seek()’, ‘tell()’, ‘truncate()’, and ‘close()’.  Most
     of the methods of this class will often map to a single system
     call.  There are also ‘readable()’, ‘writable()’, and ‘seekable()’
     methods for determining what operations a given object will allow.

     Python 3.0 has concrete implementations of this class for files and
     sockets, but Python 2.6 hasn’t restructured its file and socket
     objects in this way.

   * ‘BufferedIOBase’ is an abstract base class that buffers data in
     memory to reduce the number of system calls used, making I/O
     processing more efficient.  It supports all of the methods of
     ‘RawIOBase’, and adds a ‘raw’ attribute holding the underlying raw
     object.

     There are five concrete classes implementing this ABC.
     ‘BufferedWriter’ and ‘BufferedReader’ are for objects that support
     write-only or read-only usage that have a ‘seek()’ method for
     random access.  ‘BufferedRandom’ objects support read and write
     access upon the same underlying stream, and ‘BufferedRWPair’ is for
     objects such as TTYs that have both read and write operations
     acting upon unconnected streams of data.  The ‘BytesIO’ class
     supports reading, writing, and seeking over an in-memory buffer.

   * ‘TextIOBase’: Provides functions for reading and writing strings
     (remember, strings will be Unicode in Python 3.0), and supporting
     *note universal newlines: 5e9.  ‘TextIOBase’ defines the *note
     readline(): de. method and supports iteration upon objects.

     There are two concrete implementations.  ‘TextIOWrapper’ wraps a
     buffered I/O object, supporting all of the methods for text I/O and
     adding a ‘buffer’ attribute for access to the underlying object.
     ‘StringIO’ simply buffers everything in memory without ever writing
     anything to disk.

     (In Python 2.6, *note io.StringIO: 821. is implemented in pure
     Python, so it’s pretty slow.  You should therefore stick with the
     existing ‘StringIO’ module or ‘cStringIO’ for now.  At some point
     Python 3.0’s *note io: a1. module will be rewritten into C for
     speed, and perhaps the C implementation will be backported to the
     2.x releases.)

In Python 2.6, the underlying implementations haven’t been restructured
to build on top of the *note io: a1. module’s classes.  The module is
being provided to make it easier to write code that’s forward-compatible
with 3.0, and to save developers the effort of writing their own
implementations of buffering and text I/O.

See also
........

PEP 3116(1) - New I/O

     PEP written by Daniel Stutzbach, Mike Verdone, and Guido van
     Rossum.  Code by Guido van Rossum, Georg Brandl, Walter Doerwald,
     Jeremy Hylton, Martin von Löwis, Tony Lownds, and others.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3116


File: python.info,  Node: PEP 3118 Revised Buffer Protocol,  Next: PEP 3119 Abstract Base Classes,  Prev: PEP 3116 New I/O Library,  Up: What’s New in Python 2 6

1.11.12 PEP 3118: Revised Buffer Protocol
-----------------------------------------

The buffer protocol is a C-level API that lets Python types exchange
pointers into their internal representations.  A memory-mapped file can
be viewed as a buffer of characters, for example, and this lets another
module such as *note re: dd. treat memory-mapped files as a string of
characters to be searched.

The primary users of the buffer protocol are numeric-processing packages
such as NumPy, which expose the internal representation of arrays so
that callers can write data directly into an array instead of going
through a slower API. This PEP updates the buffer protocol in light of
experience from NumPy development, adding a number of new features such
as indicating the shape of an array or locking a memory region.

The most important new C API function is ‘PyObject_GetBuffer(PyObject
*obj, Py_buffer *view, int flags)’, which takes an object and a set of
flags, and fills in the ‘Py_buffer’ structure with information about the
object’s memory representation.  Objects can use this operation to lock
memory in place while an external caller could be modifying the
contents, so there’s a corresponding ‘PyBuffer_Release(Py_buffer *view)’
to indicate that the external caller is done.

The `flags' argument to *note PyObject_GetBuffer(): d18. specifies
constraints upon the memory returned.  Some examples are:

        * ‘PyBUF_WRITABLE’ indicates that the memory must be writable.

        * ‘PyBUF_LOCK’ requests a read-only or exclusive lock on the
          memory.

        * ‘PyBUF_C_CONTIGUOUS’ and ‘PyBUF_F_CONTIGUOUS’ requests a
          C-contiguous (last dimension varies the fastest) or
          Fortran-contiguous (first dimension varies the fastest) array
          layout.

Two new argument codes for *note PyArg_ParseTuple(): 268, ‘s*’ and ‘z*’,
return locked buffer objects for a parameter.

See also
........

PEP 3118(1) - Revising the buffer protocol

     PEP written by Travis Oliphant and Carl Banks; implemented by
     Travis Oliphant.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3118


File: python.info,  Node: PEP 3119 Abstract Base Classes,  Next: PEP 3127 Integer Literal Support and Syntax,  Prev: PEP 3118 Revised Buffer Protocol,  Up: What’s New in Python 2 6

1.11.13 PEP 3119: Abstract Base Classes
---------------------------------------

Some object-oriented languages such as Java support interfaces,
declaring that a class has a given set of methods or supports a given
access protocol.  Abstract Base Classes (or ABCs) are an equivalent
feature for Python.  The ABC support consists of an *note abc: 4. module
containing a metaclass called ‘ABCMeta’, special handling of this
metaclass by the *note isinstance(): 444. and *note issubclass(): 445.
builtins, and a collection of basic ABCs that the Python developers
think will be widely useful.  Future versions of Python will probably
add more ABCs.

Let’s say you have a particular class and wish to know whether it
supports dictionary-style access.  The phrase “dictionary-style” is
vague, however.  It probably means that accessing items with ‘obj[1]’
works.  Does it imply that setting items with ‘obj[2] = value’ works?
Or that the object will have ‘keys()’, ‘values()’, and ‘items()’
methods?  What about the iterative variants such as ‘iterkeys()’?  *note
copy(): 26. and ‘update()’?  Iterating over the object with *note
iter(): d1a.?

The Python 2.6 *note collections: 1e. module includes a number of
different ABCs that represent these distinctions.  ‘Iterable’ indicates
that a class defines *note __iter__(): 504, and ‘Container’ means the
class defines a *note __contains__(): d1b. method and therefore supports
‘x in y’ expressions.  The basic dictionary interface of getting items,
setting items, and ‘keys()’, ‘values()’, and ‘items()’, is defined by
the ‘MutableMapping’ ABC.

You can derive your own classes from a particular ABC to indicate they
support that ABC’s interface:

     import collections

     class Storage(collections.MutableMapping):
         ...

Alternatively, you could write the class without deriving from the
desired ABC and instead register the class by calling the ABC’s
‘register()’ method:

     import collections

     class Storage:
         ...

     collections.MutableMapping.register(Storage)

For classes that you write, deriving from the ABC is probably clearer.
The ‘register()’ method is useful when you’ve written a new ABC that can
describe an existing type or class, or if you want to declare that some
third-party class implements an ABC. For example, if you defined a
‘PrintableType’ ABC, it’s legal to do:

     # Register Python's types
     PrintableType.register(int)
     PrintableType.register(float)
     PrintableType.register(str)

Classes should obey the semantics specified by an ABC, but Python can’t
check this; it’s up to the class author to understand the ABC’s
requirements and to implement the code accordingly.

To check whether an object supports a particular interface, you can now
write:

     def func(d):
         if not isinstance(d, collections.MutableMapping):
             raise ValueError("Mapping object expected, not %r" % d)

Don’t feel that you must now begin writing lots of checks as in the
above example.  Python has a strong tradition of duck-typing, where
explicit type-checking is never done and code simply calls methods on an
object, trusting that those methods will be there and raising an
exception if they aren’t.  Be judicious in checking for ABCs and only do
it where it’s absolutely necessary.

You can write your own ABCs by using ‘abc.ABCMeta’ as the metaclass in a
class definition:

     from abc import ABCMeta, abstractmethod

     class Drawable():
         __metaclass__ = ABCMeta

         @abstractmethod
         def draw(self, x, y, scale=1.0):
             pass

         def draw_doubled(self, x, y):
             self.draw(x, y, scale=2.0)


     class Square(Drawable):
         def draw(self, x, y, scale):
             ...

In the ‘Drawable’ ABC above, the ‘draw_doubled()’ method renders the
object at twice its size and can be implemented in terms of other
methods described in ‘Drawable’.  Classes implementing this ABC
therefore don’t need to provide their own implementation of
‘draw_doubled()’, though they can do so.  An implementation of ‘draw()’
is necessary, though; the ABC can’t provide a useful generic
implementation.

You can apply the ‘@abstractmethod’ decorator to methods such as
‘draw()’ that must be implemented; Python will then raise an exception
for classes that don’t define the method.  Note that the exception is
only raised when you actually try to create an instance of a subclass
lacking the method:

     >>> class Circle(Drawable):
     ...     pass
     ...
     >>> c = Circle()
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: Can't instantiate abstract class Circle with abstract methods draw
     >>>

Abstract data attributes can be declared using the ‘@abstractproperty’
decorator:

     from abc import abstractproperty
     ...

     @abstractproperty
     def readonly(self):
        return self._x

Subclasses must then define a ‘readonly()’ property.

See also
........

PEP 3119(1) - Introducing Abstract Base Classes

     PEP written by Guido van Rossum and Talin.  Implemented by Guido
     van Rossum.  Backported to 2.6 by Benjamin Aranguren, with Alex
     Martelli.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3119


File: python.info,  Node: PEP 3127 Integer Literal Support and Syntax,  Next: PEP 3129 Class Decorators,  Prev: PEP 3119 Abstract Base Classes,  Up: What’s New in Python 2 6

1.11.14 PEP 3127: Integer Literal Support and Syntax
----------------------------------------------------

Python 3.0 changes the syntax for octal (base-8) integer literals,
prefixing them with “0o” or “0O” instead of a leading zero, and adds
support for binary (base-2) integer literals, signalled by a “0b” or
“0B” prefix.

Python 2.6 doesn’t drop support for a leading 0 signalling an octal
number, but it does add support for “0o” and “0b”:

     >>> 0o21, 2*8 + 1
     (17, 17)
     >>> 0b101111
     47

The *note oct(): c58. builtin still returns numbers prefixed with a
leading zero, and a new *note bin(): c33. builtin returns the binary
representation for a number:

     >>> oct(42)
     '052'
     >>> future_builtins.oct(42)
     '0o52'
     >>> bin(173)
     '0b10101101'

The *note int(): 184. and ‘long()’ builtins will now accept the “0o” and
“0b” prefixes when base-8 or base-2 are requested, or when the `base'
argument is zero (signalling that the base used should be determined
from the string):

     >>> int ('0o52', 0)
     42
     >>> int('1101', 2)
     13
     >>> int('0b1101', 2)
     13
     >>> int('0b1101', 0)
     13

See also
........

PEP 3127(1) - Integer Literal Support and Syntax

     PEP written by Patrick Maupin; backported to 2.6 by Eric Smith.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3127


File: python.info,  Node: PEP 3129 Class Decorators,  Next: PEP 3141 A Type Hierarchy for Numbers,  Prev: PEP 3127 Integer Literal Support and Syntax,  Up: What’s New in Python 2 6

1.11.15 PEP 3129: Class Decorators
----------------------------------

Decorators have been extended from functions to classes.  It’s now legal
to write:

     @foo
     @bar
     class A:
       pass

This is equivalent to:

     class A:
       pass

     A = foo(bar(A))

See also
........

PEP 3129(1) - Class Decorators

     PEP written by Collin Winter.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3129


File: python.info,  Node: PEP 3141 A Type Hierarchy for Numbers,  Next: Other Language Changes<10>,  Prev: PEP 3129 Class Decorators,  Up: What’s New in Python 2 6

1.11.16 PEP 3141: A Type Hierarchy for Numbers
----------------------------------------------

Python 3.0 adds several abstract base classes for numeric types inspired
by Scheme’s numeric tower.  These classes were backported to 2.6 as the
*note numbers: c1. module.

The most general ABC is ‘Number’.  It defines no operations at all, and
only exists to allow checking if an object is a number by doing
‘isinstance(obj, Number)’.

‘Complex’ is a subclass of ‘Number’.  Complex numbers can undergo the
basic operations of addition, subtraction, multiplication, division, and
exponentiation, and you can retrieve the real and imaginary parts and
obtain a number’s conjugate.  Python’s built-in complex type is an
implementation of ‘Complex’.

‘Real’ further derives from ‘Complex’, and adds operations that only
work on real numbers: ‘floor()’, ‘trunc()’, rounding, taking the
remainder mod N, floor division, and comparisons.

‘Rational’ numbers derive from ‘Real’, have ‘numerator’ and
‘denominator’ properties, and can be converted to floats.  Python 2.6
adds a simple rational-number class, ‘Fraction’, in the *note fractions:
83. module.  (It’s called ‘Fraction’ instead of ‘Rational’ to avoid a
name clash with *note numbers.Rational: c4b.)

‘Integral’ numbers derive from ‘Rational’, and can be shifted left and
right with ‘<<’ and ‘>>’, combined using bitwise operations such as ‘&’
and ‘|’, and can be used as array indexes and slice boundaries.

In Python 3.0, the PEP slightly redefines the existing builtins *note
round(): c60, *note math.floor(): d1f, *note math.ceil(): d20, and adds
a new one, *note math.trunc(): d21, that’s been backported to Python
2.6.  *note math.trunc(): d21. rounds toward zero, returning the closest
‘Integral’ that’s between the function’s argument and zero.

See also
........

PEP 3141(1) - A Type Hierarchy for Numbers

     PEP written by Jeffrey Yasskin.

Scheme’s numerical tower(2), from the Guile manual.

Scheme’s number datatypes(3) from the R5RS Scheme specification.

* Menu:

* The fractions Module::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3141

   (2) 
https://www.gnu.org/software/guile/manual/html_node/Numerical-Tower.html#Numerical-Tower

   (3) 
http://schemers.org/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2


File: python.info,  Node: The fractions Module,  Up: PEP 3141 A Type Hierarchy for Numbers

1.11.16.1 The ‘fractions’ Module
................................

To fill out the hierarchy of numeric types, the *note fractions: 83.
module provides a rational-number class.  Rational numbers store their
values as a numerator and denominator forming a fraction, and can
exactly represent numbers such as ‘2/3’ that floating-point numbers can
only approximate.

The ‘Fraction’ constructor takes two ‘Integral’ values that will be the
numerator and denominator of the resulting fraction.

     >>> from fractions import Fraction
     >>> a = Fraction(2, 3)
     >>> b = Fraction(2, 5)
     >>> float(a), float(b)
     (0.66666666666666663, 0.40000000000000002)
     >>> a+b
     Fraction(16, 15)
     >>> a/b
     Fraction(5, 3)

For converting floating-point numbers to rationals, the float type now
has an ‘as_integer_ratio()’ method that returns the numerator and
denominator for a fraction that evaluates to the same floating-point
value:

     >>> (2.5) .as_integer_ratio()
     (5, 2)
     >>> (3.1415) .as_integer_ratio()
     (7074029114692207L, 2251799813685248L)
     >>> (1./3) .as_integer_ratio()
     (6004799503160661L, 18014398509481984L)

Note that values that can only be approximated by floating-point
numbers, such as 1./3, are not simplified to the number being
approximated; the fraction attempts to match the floating-point value
`exactly'.

The *note fractions: 83. module is based upon an implementation by
Sjoerd Mullender that was in Python’s ‘Demo/classes/’ directory for a
long time.  This implementation was significantly updated by Jeffrey
Yasskin.


File: python.info,  Node: Other Language Changes<10>,  Next: New and Improved Modules<2>,  Prev: PEP 3141 A Type Hierarchy for Numbers,  Up: What’s New in Python 2 6

1.11.17 Other Language Changes
------------------------------

Some smaller changes made to the core Python language are:

   * Directories and zip archives containing a ‘__main__.py’ file can
     now be executed directly by passing their name to the interpreter.
     The directory or zip archive is automatically inserted as the first
     entry in sys.path.  (Suggestion and initial patch by Andy Chu,
     subsequently revised by Phillip J. Eby and Nick Coghlan;
     bpo-1739468(1).)

   * The *note hasattr(): 43c. function was catching and ignoring all
     errors, under the assumption that they meant a *note __getattr__():
     30f. method was failing somehow and the return value of *note
     hasattr(): 43c. would therefore be ‘False’.  This logic shouldn’t
     be applied to *note KeyboardInterrupt: 197. and *note SystemExit:
     5f1, however; Python 2.6 will no longer discard such exceptions
     when *note hasattr(): 43c. encounters them.  (Fixed by Benjamin
     Peterson; bpo-2196(2).)

   * When calling a function using the ‘**’ syntax to provide keyword
     arguments, you are no longer required to use a Python dictionary;
     any mapping will now work:

          >>> def f(**kw):
          ...    print sorted(kw)
          ...
          >>> ud=UserDict.UserDict()
          >>> ud['a'] = 1
          >>> ud['b'] = 'string'
          >>> f(**ud)
          ['a', 'b']

     (Contributed by Alexander Belopolsky; bpo-1686487(3).)

     It’s also become legal to provide keyword arguments after a ‘*args’
     argument to a function call.

          >>> def f(*args, **kw):
          ...     print args, kw
          ...
          >>> f(1,2,3, *(4,5,6), keyword=13)
          (1, 2, 3, 4, 5, 6) {'keyword': 13}

     Previously this would have been a syntax error.  (Contributed by
     Amaury Forgeot d’Arc; bpo-3473(4).)

   * A new builtin, ‘next(iterator, [default])’ returns the next item
     from the specified iterator.  If the `default' argument is
     supplied, it will be returned if `iterator' has been exhausted;
     otherwise, the *note StopIteration: 47b. exception will be raised.
     (Backported in bpo-2719(5).)

   * Tuples now have ‘index()’ and ‘count()’ methods matching the list
     type’s ‘index()’ and ‘count()’ methods:

          >>> t = (0,1,2,3,4,0,1,2)
          >>> t.index(3)
          3
          >>> t.count(0)
          2

     (Contributed by Raymond Hettinger)

   * The built-in types now have improved support for extended slicing
     syntax, accepting various combinations of ‘(start, stop, step)’.
     Previously, the support was partial and certain corner cases
     wouldn’t work.  (Implemented by Thomas Wouters.)

   * Properties now have three attributes, ‘getter’, ‘setter’ and
     ‘deleter’, that are decorators providing useful shortcuts for
     adding a getter, setter or deleter function to an existing
     property.  You would use them like this:

          class C(object):
              @property
              def x(self):
                  return self._x

              @x.setter
              def x(self, value):
                  self._x = value

              @x.deleter
              def x(self):
                  del self._x

          class D(C):
              @C.x.getter
              def x(self):
                  return self._x * 2

              @x.setter
              def x(self, value):
                  self._x = value / 2

   * Several methods of the built-in set types now accept multiple
     iterables: ‘intersection()’, ‘intersection_update()’, ‘union()’,
     ‘update()’, ‘difference()’ and ‘difference_update()’.

          >>> s=set('1234567890')
          >>> s.intersection('abc123', 'cdf246')  # Intersection between all inputs
          set(['2'])
          >>> s.difference('246', '789')
          set(['1', '0', '3', '5'])

     (Contributed by Raymond Hettinger.)

   * Many floating-point features were added.  The *note float(): 187.
     function will now turn the string ‘nan’ into an IEEE 754 Not A
     Number value, and ‘+inf’ and ‘-inf’ into positive or negative
     infinity.  This works on any platform with IEEE 754 semantics.
     (Contributed by Christian Heimes; bpo-1635(6).)

     Other functions in the *note math: b1. module, ‘isinf()’ and
     ‘isnan()’, return true if their floating-point argument is infinite
     or Not A Number.  (bpo-1640(7))

     Conversion functions were added to convert floating-point numbers
     into hexadecimal strings (bpo-3008(8)).  These functions convert
     floats to and from a string representation without introducing
     rounding errors from the conversion between decimal and binary.
     Floats have a *note hex(): c59. method that returns a string
     representation, and the ‘float.fromhex()’ method converts a string
     back into a number:

          >>> a = 3.75
          >>> a.hex()
          '0x1.e000000000000p+1'
          >>> float.fromhex('0x1.e000000000000p+1')
          3.75
          >>> b=1./3
          >>> b.hex()
          '0x1.5555555555555p-2'

   * A numerical nicety: when creating a complex number from two floats
     on systems that support signed zeros (-0 and +0), the *note
     complex(): 189. constructor will now preserve the sign of the zero.
     (Fixed by Mark T. Dickinson; bpo-1507(9).)

   * Classes that inherit a *note __hash__(): 335. method from a parent
     class can set ‘__hash__ = None’ to indicate that the class isn’t
     hashable.  This will make ‘hash(obj)’ raise a *note TypeError: 192.
     and the class will not be indicated as implementing the ‘Hashable’
     ABC.

     You should do this when you’ve defined a ‘__cmp__()’ or *note
     __eq__(): 334. method that compares objects by their value rather
     than by identity.  All objects have a default hash method that uses
     ‘id(obj)’ as the hash value.  There’s no tidy way to remove the
     *note __hash__(): 335. method inherited from a parent class, so
     assigning ‘None’ was implemented as an override.  At the C level,
     extensions can set ‘tp_hash’ to *note
     PyObject_HashNotImplemented(): d24.  (Fixed by Nick Coghlan and
     Amaury Forgeot d’Arc; bpo-2235(10).)

   * The *note GeneratorExit: d25. exception now subclasses *note
     BaseException: 1a7. instead of *note Exception: 1a8.  This means
     that an exception handler that does ‘except Exception:’ will not
     inadvertently catch *note GeneratorExit: d25.  (Contributed by Chad
     Austin; bpo-1537(11).)

   * Generator objects now have a ‘gi_code’ attribute that refers to the
     original code object backing the generator.  (Contributed by Collin
     Winter; bpo-1473257(12).)

   * The *note compile(): 1b2. built-in function now accepts keyword
     arguments as well as positional parameters.  (Contributed by Thomas
     Wouters; bpo-1444529(13).)

   * The *note complex(): 189. constructor now accepts strings
     containing parenthesized complex numbers, meaning that
     ‘complex(repr(cplx))’ will now round-trip values.  For example,
     ‘complex('(3+4j)')’ now returns the value (3+4j).
     (bpo-1491866(14))

   * The string ‘translate()’ method now accepts ‘None’ as the
     translation table parameter, which is treated as the identity
     transformation.  This makes it easier to carry out operations that
     only delete characters.  (Contributed by Bengt Richter and
     implemented by Raymond Hettinger; bpo-1193128(15).)

   * The built-in *note dir(): d26. function now checks for a *note
     __dir__(): 310. method on the objects it receives.  This method
     must return a list of strings containing the names of valid
     attributes for the object, and lets the object control the value
     that *note dir(): d26. produces.  Objects that have *note
     __getattr__(): 30f. or *note __getattribute__(): 43e. methods can
     use this to advertise pseudo-attributes they will honor.
     (bpo-1591665(16))

   * Instance method objects have new attributes for the object and
     function comprising the method; the new synonym for ‘im_self’ is
     ‘__self__’, and ‘im_func’ is also available as ‘__func__’.  The old
     names are still supported in Python 2.6, but are gone in 3.0.

   * An obscure change: when you use the *note locals(): 44a. function
     inside a *note class: c5d. statement, the resulting dictionary no
     longer returns free variables.  (Free variables, in this case, are
     variables referenced in the ‘class’ statement that aren’t
     attributes of the class.)

* Menu:

* Optimizations: Optimizations<9>.
* Interpreter Changes: Interpreter Changes<2>.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1739468

   (2) https://bugs.python.org/issue2196

   (3) https://bugs.python.org/issue1686487

   (4) https://bugs.python.org/issue3473

   (5) https://bugs.python.org/issue2719

   (6) https://bugs.python.org/issue1635

   (7) https://bugs.python.org/issue1640

   (8) https://bugs.python.org/issue3008

   (9) https://bugs.python.org/issue1507

   (10) https://bugs.python.org/issue2235

   (11) https://bugs.python.org/issue1537

   (12) https://bugs.python.org/issue1473257

   (13) https://bugs.python.org/issue1444529

   (14) https://bugs.python.org/issue1491866

   (15) https://bugs.python.org/issue1193128

   (16) https://bugs.python.org/issue1591665


File: python.info,  Node: Optimizations<9>,  Next: Interpreter Changes<2>,  Up: Other Language Changes<10>

1.11.17.1 Optimizations
.......................

   * The *note warnings: 126. module has been rewritten in C. This makes
     it possible to invoke warnings from the parser, and may also make
     the interpreter’s startup faster.  (Contributed by Neal Norwitz and
     Brett Cannon; bpo-1631171(1).)

   * Type objects now have a cache of methods that can reduce the work
     required to find the correct method implementation for a particular
     class; once cached, the interpreter doesn’t need to traverse base
     classes to figure out the right method to call.  The cache is
     cleared if a base class or the class itself is modified, so the
     cache should remain correct even in the face of Python’s dynamic
     nature.  (Original optimization implemented by Armin Rigo, updated
     for Python 2.6 by Kevin Jacobs; bpo-1700288(2).)

     By default, this change is only applied to types that are included
     with the Python core.  Extension modules may not necessarily be
     compatible with this cache, so they must explicitly add
     ‘Py_TPFLAGS_HAVE_VERSION_TAG’ to the module’s ‘tp_flags’ field to
     enable the method cache.  (To be compatible with the method cache,
     the extension module’s code must not directly access and modify the
     ‘tp_dict’ member of any of the types it implements.  Most modules
     don’t do this, but it’s impossible for the Python interpreter to
     determine that.  See bpo-1878(3) for some discussion.)

   * Function calls that use keyword arguments are significantly faster
     by doing a quick pointer comparison, usually saving the time of a
     full string comparison.  (Contributed by Raymond Hettinger, after
     an initial implementation by Antoine Pitrou; bpo-1819(4).)

   * All of the functions in the *note struct: f8. module have been
     rewritten in C, thanks to work at the Need For Speed sprint.
     (Contributed by Raymond Hettinger.)

   * Some of the standard built-in types now set a bit in their type
     objects.  This speeds up checking whether an object is a subclass
     of one of these types.  (Contributed by Neal Norwitz.)

   * Unicode strings now use faster code for detecting whitespace and
     line breaks; this speeds up the ‘split()’ method by about 25% and
     ‘splitlines()’ by 35%.  (Contributed by Antoine Pitrou.)  Memory
     usage is reduced by using pymalloc for the Unicode string’s data.

   * The ‘with’ statement now stores the *note __exit__(): c89. method
     on the stack, producing a small speedup.  (Implemented by Jeffrey
     Yasskin.)

   * To reduce memory usage, the garbage collector will now clear
     internal free lists when garbage-collecting the highest generation
     of objects.  This may return memory to the operating system sooner.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1631171

   (2) https://bugs.python.org/issue1700288

   (3) https://bugs.python.org/issue1878

   (4) https://bugs.python.org/issue1819


File: python.info,  Node: Interpreter Changes<2>,  Prev: Optimizations<9>,  Up: Other Language Changes<10>

1.11.17.2 Interpreter Changes
.............................

Two command-line options have been reserved for use by other Python
implementations.  The *note -J: d2a. switch has been reserved for use by
Jython for Jython-specific options, such as switches that are passed to
the underlying JVM. *note -X: 155. has been reserved for options
specific to a particular implementation of Python such as CPython,
Jython, or IronPython.  If either option is used with Python 2.6, the
interpreter will report that the option isn’t currently used.

Python can now be prevented from writing ‘.pyc’ or ‘.pyo’ files by
supplying the *note -B: d2b. switch to the Python interpreter, or by
setting the *note PYTHONDONTWRITEBYTECODE: d2c. environment variable
before running the interpreter.  This setting is available to Python
programs as the ‘sys.dont_write_bytecode’ variable, and Python code can
change the value to modify the interpreter’s behaviour.  (Contributed by
Neal Norwitz and Georg Brandl.)

The encoding used for standard input, output, and standard error can be
specified by setting the *note PYTHONIOENCODING: 923. environment
variable before running the interpreter.  The value should be a string
in the form ‘<encoding>’ or ‘<encoding>:<errorhandler>’.  The `encoding'
part specifies the encoding’s name, e.g.  ‘utf-8’ or ‘latin-1’; the
optional `errorhandler' part specifies what to do with characters that
can’t be handled by the encoding, and should be one of “error”,
“ignore”, or “replace”.  (Contributed by Martin von Löwis.)


File: python.info,  Node: New and Improved Modules<2>,  Next: Deprecations and Removals,  Prev: Other Language Changes<10>,  Up: What’s New in Python 2 6

1.11.18 New and Improved Modules
--------------------------------

As in every release, Python’s standard library received a number of
enhancements and bug fixes.  Here’s a partial list of the most notable
changes, sorted alphabetically by module name.  Consult the ‘Misc/NEWS’
file in the source tree for a more complete list of changes, or look
through the Subversion logs for all the details.

   * The *note asyncore: b. and *note asynchat: 9. modules are being
     actively maintained again, and a number of patches and bugfixes
     were applied.  (Maintained by Josiah Carlson; see bpo-1736190(1)
     for one patch.)

   * The ‘bsddb’ module also has a new maintainer, Jesús Cea Avión, and
     the package is now available as a standalone package.  The web page
     for the package is www.jcea.es/programacion/pybsddb.htm(2).  The
     plan is to remove the package from the standard library in Python
     3.0, because its pace of releases is much more frequent than
     Python’s.

     The ‘bsddb.dbshelve’ module now uses the highest pickling protocol
     available, instead of restricting itself to protocol 1.
     (Contributed by W. Barnes.)

   * The *note cgi: 16. module will now read variables from the query
     string of an HTTP POST request.  This makes it possible to use form
     actions with URLs that include query strings such as
     “/cgi-bin/add.py?category=1”.  (Contributed by Alexandre Fiori and
     Nubis; bpo-1817(3).)

     The ‘parse_qs()’ and ‘parse_qsl()’ functions have been relocated
     from the *note cgi: 16. module to the ‘urlparse’ module.  The
     versions still available in the *note cgi: 16. module will trigger
     *note PendingDeprecationWarning: 277. messages in 2.6
     (bpo-600362(4)).

   * The *note cmath: 19. module underwent extensive revision,
     contributed by Mark Dickinson and Christian Heimes.  Five new
     functions were added:

        * ‘polar()’ converts a complex number to polar form, returning
          the modulus and argument of the complex number.

        * ‘rect()’ does the opposite, turning a modulus, argument pair
          back into the corresponding complex number.

        * ‘phase()’ returns the argument (also called the angle) of a
          complex number.

        * ‘isnan()’ returns True if either the real or imaginary part of
          its argument is a NaN.

        * ‘isinf()’ returns True if either the real or imaginary part of
          its argument is infinite.

     The revisions also improved the numerical soundness of the *note
     cmath: 19. module.  For all functions, the real and imaginary parts
     of the results are accurate to within a few units of least
     precision (ulps) whenever possible.  See bpo-1381(5) for the
     details.  The branch cuts for ‘asinh()’, ‘atanh()’: and ‘atan()’
     have also been corrected.

     The tests for the module have been greatly expanded; nearly 2000
     new test cases exercise the algebraic functions.

     On IEEE 754 platforms, the *note cmath: 19. module now handles IEEE
     754 special values and floating-point exceptions in a manner
     consistent with Annex ‘G’ of the C99 standard.

   * A new data type in the *note collections: 1e. module:
     ‘namedtuple(typename, fieldnames)’ is a factory function that
     creates subclasses of the standard tuple whose fields are
     accessible by name as well as index.  For example:

          >>> var_type = collections.namedtuple('variable',
          ...             'id name type size')
          >>> # Names are separated by spaces or commas.
          >>> # 'id, name, type, size' would also work.
          >>> var_type._fields
          ('id', 'name', 'type', 'size')

          >>> var = var_type(1, 'frequency', 'int', 4)
          >>> print var[0], var.id    # Equivalent
          1 1
          >>> print var[2], var.type  # Equivalent
          int int
          >>> var._asdict()
          {'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'}
          >>> v2 = var._replace(name='amplitude')
          >>> v2
          variable(id=1, name='amplitude', type='int', size=4)

     Several places in the standard library that returned tuples have
     been modified to return ‘namedtuple’ instances.  For example, the
     ‘Decimal.as_tuple()’ method now returns a named tuple with ‘sign’,
     ‘digits’, and ‘exponent’ fields.

     (Contributed by Raymond Hettinger.)

   * Another change to the *note collections: 1e. module is that the
     ‘deque’ type now supports an optional `maxlen' parameter; if
     supplied, the deque’s size will be restricted to no more than
     `maxlen' items.  Adding more items to a full deque causes old items
     to be discarded.

          >>> from collections import deque
          >>> dq=deque(maxlen=3)
          >>> dq
          deque([], maxlen=3)
          >>> dq.append(1); dq.append(2); dq.append(3)
          >>> dq
          deque([1, 2, 3], maxlen=3)
          >>> dq.append(4)
          >>> dq
          deque([2, 3, 4], maxlen=3)

     (Contributed by Raymond Hettinger.)

   * The ‘Cookie’ module’s ‘Morsel’ objects now support an ‘httponly’
     attribute.  In some browsers.  cookies with this attribute set
     cannot be accessed or manipulated by JavaScript code.  (Contributed
     by Arvin Schnell; bpo-1638033(6).)

   * A new window method in the *note curses: 2c. module, ‘chgat()’,
     changes the display attributes for a certain number of characters
     on a single line.  (Contributed by Fabian Kreutz.)

          # Boldface text starting at y=0,x=21
          # and affecting the rest of the line.
          stdscr.chgat(0, 21, curses.A_BOLD)

     The ‘Textbox’ class in the *note curses.textpad: 2f. module now
     supports editing in insert mode as well as overwrite mode.  Insert
     mode is enabled by supplying a true value for the `insert_mode'
     parameter when creating the ‘Textbox’ instance.

   * The *note datetime: 31. module’s ‘strftime()’ methods now support a
     ‘%f’ format code that expands to the number of microseconds in the
     object, zero-padded on the left to six places.  (Contributed by
     Skip Montanaro; bpo-1158(7).)

   * The *note decimal: 36. module was updated to version 1.66 of the
     General Decimal Specification(8).  New features include some
     methods for some basic mathematical functions such as ‘exp()’ and
     ‘log10()’:

          >>> Decimal(1).exp()
          Decimal("2.718281828459045235360287471")
          >>> Decimal("2.7182818").ln()
          Decimal("0.9999999895305022877376682436")
          >>> Decimal(1000).log10()
          Decimal("3")

     The ‘as_tuple()’ method of ‘Decimal’ objects now returns a named
     tuple with ‘sign’, ‘digits’, and ‘exponent’ fields.

     (Implemented by Facundo Batista and Mark Dickinson.  Named tuple
     support added by Raymond Hettinger.)

   * The *note difflib: 37. module’s ‘SequenceMatcher’ class now returns
     named tuples representing matches, with ‘a’, ‘b’, and ‘size’
     attributes.  (Contributed by Raymond Hettinger.)

   * An optional ‘timeout’ parameter, specifying a timeout measured in
     seconds, was added to the *note ftplib.FTP: 9f7. class constructor
     as well as the ‘connect()’ method.  (Added by Facundo Batista.)
     Also, the ‘FTP’ class’s ‘storbinary()’ and ‘storlines()’ now take
     an optional `callback' parameter that will be called with each
     block of data after the data has been sent.  (Contributed by Phil
     Schwartz; bpo-1221598(9).)

   * The ‘reduce()’ built-in function is also available in the *note
     functools: 85. module.  In Python 3.0, the builtin has been dropped
     and ‘reduce()’ is only available from *note functools: 85.;
     currently there are no plans to drop the builtin in the 2.x series.
     (Patched by Christian Heimes; bpo-1739906(10).)

   * When possible, the *note getpass: 88. module will now use
     ‘/dev/tty’ to print a prompt message and read the password, falling
     back to standard error and standard input.  If the password may be
     echoed to the terminal, a warning is printed before the prompt is
     displayed.  (Contributed by Gregory P. Smith.)

   * The *note glob.glob(): 5bb. function can now return Unicode
     filenames if a Unicode path was used and Unicode filenames are
     matched within the directory.  (bpo-1001604(11))

   * A new function in the *note heapq: 8e. module, ‘merge(iter1, iter2,
     ...)’, takes any number of iterables returning data in sorted
     order, and returns a new generator that returns the contents of all
     the iterators, also in sorted order.  For example:

          >>> list(heapq.merge([1, 3, 5, 9], [2, 8, 16]))
          [1, 2, 3, 5, 8, 9, 16]

     Another new function, ‘heappushpop(heap, item)’, pushes `item' onto
     `heap', then pops off and returns the smallest item.  This is more
     efficient than making a call to ‘heappush()’ and then ‘heappop()’.

     *note heapq: 8e. is now implemented to only use less-than
     comparison, instead of the less-than-or-equal comparison it
     previously used.  This makes *note heapq: 8e.’s usage of a type
     match the *note list.sort(): 43a. method.  (Contributed by Raymond
     Hettinger.)

   * An optional ‘timeout’ parameter, specifying a timeout measured in
     seconds, was added to the ‘httplib.HTTPConnection’ and
     ‘HTTPSConnection’ class constructors.  (Added by Facundo Batista.)

   * Most of the *note inspect: a0. module’s functions, such as
     ‘getmoduleinfo()’ and ‘getargs()’, now return named tuples.  In
     addition to behaving like tuples, the elements of the return value
     can also be accessed as attributes.  (Contributed by Raymond
     Hettinger.)

     Some new functions in the module include ‘isgenerator()’,
     ‘isgeneratorfunction()’, and ‘isabstract()’.

   * The *note itertools: a3. module gained several new functions.

     ‘izip_longest(iter1, iter2, ...[, fillvalue])’ makes tuples from
     each of the elements; if some of the iterables are shorter than
     others, the missing values are set to `fillvalue'.  For example:

          >>> tuple(itertools.izip_longest([1,2,3], [1,2,3,4,5]))
          ((1, 1), (2, 2), (3, 3), (None, 4), (None, 5))

     ‘product(iter1, iter2, ..., [repeat=N])’ returns the Cartesian
     product of the supplied iterables, a set of tuples containing every
     possible combination of the elements returned from each iterable.

          >>> list(itertools.product([1,2,3], [4,5,6]))
          [(1, 4), (1, 5), (1, 6),
           (2, 4), (2, 5), (2, 6),
           (3, 4), (3, 5), (3, 6)]

     The optional `repeat' keyword argument is used for taking the
     product of an iterable or a set of iterables with themselves,
     repeated `N' times.  With a single iterable argument, `N'-tuples
     are returned:

          >>> list(itertools.product([1,2], repeat=3))
          [(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
           (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]

     With two iterables, `2N'-tuples are returned.

          >>> list(itertools.product([1,2], [3,4], repeat=2))
          [(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
           (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
           (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
           (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]

     ‘combinations(iterable, r)’ returns sub-sequences of length `r'
     from the elements of `iterable'.

          >>> list(itertools.combinations('123', 2))
          [('1', '2'), ('1', '3'), ('2', '3')]
          >>> list(itertools.combinations('123', 3))
          [('1', '2', '3')]
          >>> list(itertools.combinations('1234', 3))
          [('1', '2', '3'), ('1', '2', '4'),
           ('1', '3', '4'), ('2', '3', '4')]

     ‘permutations(iter[, r])’ returns all the permutations of length
     `r' of the iterable’s elements.  If `r' is not specified, it will
     default to the number of elements produced by the iterable.

          >>> list(itertools.permutations([1,2,3,4], 2))
          [(1, 2), (1, 3), (1, 4),
           (2, 1), (2, 3), (2, 4),
           (3, 1), (3, 2), (3, 4),
           (4, 1), (4, 2), (4, 3)]

     ‘itertools.chain(*iterables)’ is an existing function in *note
     itertools: a3. that gained a new constructor in Python 2.6.
     ‘itertools.chain.from_iterable(iterable)’ takes a single iterable
     that should return other iterables.  ‘chain()’ will then return all
     the elements of the first iterable, then all the elements of the
     second, and so on.

          >>> list(itertools.chain.from_iterable([[1,2,3], [4,5,6]]))
          [1, 2, 3, 4, 5, 6]

     (All contributed by Raymond Hettinger.)

   * The *note logging: aa. module’s ‘FileHandler’ class and its
     subclasses ‘WatchedFileHandler’, ‘RotatingFileHandler’, and
     ‘TimedRotatingFileHandler’ now have an optional `delay' parameter
     to their constructors.  If `delay' is true, opening of the log file
     is deferred until the first ‘emit()’ call is made.  (Contributed by
     Vinay Sajip.)

     ‘TimedRotatingFileHandler’ also has a `utc' constructor parameter.
     If the argument is true, UTC time will be used in determining when
     midnight occurs and in generating filenames; otherwise local time
     will be used.

   * Several new functions were added to the *note math: b1. module:

        * *note isinf(): d2e. and *note isnan(): d2f. determine whether
          a given float is a (positive or negative) infinity or a NaN
          (Not a Number), respectively.

        * *note copysign(): d30. copies the sign bit of an IEEE 754
          number, returning the absolute value of `x' combined with the
          sign bit of `y'.  For example, ‘math.copysign(1, -0.0)’
          returns -1.0.  (Contributed by Christian Heimes.)

        * *note factorial(): 1e8. computes the factorial of a number.
          (Contributed by Raymond Hettinger; bpo-2138(12).)

        * *note fsum(): d31. adds up the stream of numbers from an
          iterable, and is careful to avoid loss of precision through
          using partial sums.  (Contributed by Jean Brouwers, Raymond
          Hettinger, and Mark Dickinson; bpo-2819(13).)

        * *note acosh(): d32, *note asinh(): d33. and *note atanh():
          d34. compute the inverse hyperbolic functions.

        * *note log1p(): d35. returns the natural logarithm of `1+x'
          (base `e').

        * ‘trunc()’ rounds a number toward zero, returning the closest
          ‘Integral’ that’s between the function’s argument and zero.
          Added as part of the backport of *note PEP 3141’s type
          hierarchy for numbers: c4a.

   * The *note math: b1. module has been improved to give more
     consistent behaviour across platforms, especially with respect to
     handling of floating-point exceptions and IEEE 754 special values.

     Whenever possible, the module follows the recommendations of the
     C99 standard about 754’s special values.  For example, ‘sqrt(-1.)’
     should now give a *note ValueError: 1f9. across almost all
     platforms, while ‘sqrt(float('NaN'))’ should return a NaN on all
     IEEE 754 platforms.  Where Annex ‘F’ of the C99 standard recommends
     signaling ‘divide-by-zero’ or ‘invalid’, Python will raise *note
     ValueError: 1f9.  Where Annex ‘F’ of the C99 standard recommends
     signaling ‘overflow’, Python will raise *note OverflowError: 954.
     (See bpo-711019(14) and bpo-1640(15).)

     (Contributed by Christian Heimes and Mark Dickinson.)

   * *note mmap: 1ea. objects now have a ‘rfind()’ method that searches
     for a substring beginning at the end of the string and searching
     backwards.  The ‘find()’ method also gained an `end' parameter
     giving an index at which to stop searching.  (Contributed by John
     Lenton.)

   * The *note operator: c2. module gained a ‘methodcaller()’ function
     that takes a name and an optional set of arguments, returning a
     callable that will call the named function on any arguments passed
     to it.  For example:

          >>> # Equivalent to lambda s: s.replace('old', 'new')
          >>> replacer = operator.methodcaller('replace', 'old', 'new')
          >>> replacer('old wine in old bottles')
          'new wine in new bottles'

     (Contributed by Georg Brandl, after a suggestion by Gregory
     Petrosyan.)

     The ‘attrgetter()’ function now accepts dotted names and performs
     the corresponding attribute lookups:

          >>> inst_name = operator.attrgetter(
          ...        '__class__.__name__')
          >>> inst_name('')
          'str'
          >>> inst_name(help)
          '_Helper'

     (Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)

   * The *note os: c4. module now wraps several new system calls.
     ‘fchmod(fd, mode)’ and ‘fchown(fd, uid, gid)’ change the mode and
     ownership of an opened file, and ‘lchmod(path, mode)’ changes the
     mode of a symlink.  (Contributed by Georg Brandl and Christian
     Heimes.)

     ‘chflags()’ and ‘lchflags()’ are wrappers for the corresponding
     system calls (where they’re available), changing the flags set on a
     file.  Constants for the flag values are defined in the *note stat:
     f4. module; some possible values include ‘UF_IMMUTABLE’ to signal
     the file may not be changed and ‘UF_APPEND’ to indicate that data
     can only be appended to the file.  (Contributed by M. Levinson.)

     ‘os.closerange(low, high)’ efficiently closes all file descriptors
     from `low' to `high', ignoring any errors and not including `high'
     itself.  This function is now used by the *note subprocess: f9.
     module to make starting processes faster.  (Contributed by Georg
     Brandl; bpo-1663329(16).)

   * The ‘os.environ’ object’s ‘clear()’ method will now unset the
     environment variables using *note os.unsetenv(): d36. in addition
     to clearing the object’s keys.  (Contributed by Martin Horcicka;
     bpo-1181(17).)

   * The *note os.walk(): 648. function now has a ‘followlinks’
     parameter.  If set to True, it will follow symlinks pointing to
     directories and visit the directory’s contents.  For backward
     compatibility, the parameter’s default value is false.  Note that
     the function can fall into an infinite recursion if there’s a
     symlink that points to a parent directory.  (bpo-1273829(18))

   * In the *note os.path: c5. module, the ‘splitext()’ function has
     been changed to not split on leading period characters.  This
     produces better results when operating on Unix’s dot-files.  For
     example, ‘os.path.splitext('.ipython')’ now returns ‘('.ipython',
     '')’ instead of ‘('', '.ipython')’.  (bpo-1115886(19))

     A new function, ‘os.path.relpath(path, start='.')’, returns a
     relative path from the ‘start’ path, if it’s supplied, or from the
     current working directory to the destination ‘path’.  (Contributed
     by Richard Barran; bpo-1339796(20).)

     On Windows, *note os.path.expandvars(): d37. will now expand
     environment variables given in the form “%var%”, and “~user” will
     be expanded into the user’s home directory path.  (Contributed by
     Josiah Carlson; bpo-957650(21).)

   * The Python debugger provided by the *note pdb: c9. module gained a
     new command: “run” restarts the Python program being debugged and
     can optionally take new command-line arguments for the program.
     (Contributed by Rocky Bernstein; bpo-1393667(22).)

   * The *note pdb.post_mortem(): d38. function, used to begin debugging
     a traceback, will now use the traceback returned by *note
     sys.exc_info(): c52. if no traceback is supplied.  (Contributed by
     Facundo Batista; bpo-1106316(23).)

   * The *note pickletools: cb. module now has an ‘optimize()’ function
     that takes a string containing a pickle and removes some unused
     opcodes, returning a shorter pickle that contains the same data
     structure.  (Contributed by Raymond Hettinger.)

   * A ‘get_data()’ function was added to the *note pkgutil: cd. module
     that returns the contents of resource files included with an
     installed Python package.  For example:

          >>> import pkgutil
          >>> print pkgutil.get_data('test', 'exception_hierarchy.txt')
          BaseException
           +-- SystemExit
           +-- KeyboardInterrupt
           +-- GeneratorExit
           +-- Exception
                +-- StopIteration
                +-- StandardError
           ...

     (Contributed by Paul Moore; bpo-2439(24).)

   * The ‘pyexpat’ module’s ‘Parser’ objects now allow setting their
     ‘buffer_size’ attribute to change the size of the buffer used to
     hold character data.  (Contributed by Achim Gaedke; bpo-1137(25).)

   * The ‘Queue’ module now provides queue variants that retrieve
     entries in different orders.  The ‘PriorityQueue’ class stores
     queued items in a heap and retrieves them in priority order, and
     ‘LifoQueue’ retrieves the most recently added entries first,
     meaning that it behaves like a stack.  (Contributed by Raymond
     Hettinger.)

   * The *note random: dc. module’s ‘Random’ objects can now be pickled
     on a 32-bit system and unpickled on a 64-bit system, and vice
     versa.  Unfortunately, this change also means that Python 2.6’s
     ‘Random’ objects can’t be unpickled correctly on earlier versions
     of Python.  (Contributed by Shawn Ligocki; bpo-1727780(26).)

     The new ‘triangular(low, high, mode)’ function returns random
     numbers following a triangular distribution.  The returned values
     are between `low' and `high', not including `high' itself, and with
     `mode' as the most frequently occurring value in the distribution.
     (Contributed by Wladmir van der Laan and Raymond Hettinger;
     bpo-1681432(27).)

   * Long regular expression searches carried out by the *note re: dd.
     module will check for signals being delivered, so time-consuming
     searches can now be interrupted.  (Contributed by Josh Hoyt and
     Ralf Schmitt; bpo-846388(28).)

     The regular expression module is implemented by compiling bytecodes
     for a tiny regex-specific virtual machine.  Untrusted code could
     create malicious strings of bytecode directly and cause crashes, so
     Python 2.6 includes a verifier for the regex bytecode.
     (Contributed by Guido van Rossum from work for Google App Engine;
     bpo-3487(29).)

   * The *note rlcompleter: e1. module’s ‘Completer.complete()’ method
     will now ignore exceptions triggered while evaluating a name.
     (Fixed by Lorenz Quack; bpo-2250(30).)

   * The *note sched: e3. module’s ‘scheduler’ instances now have a
     read-only *note queue: da. attribute that returns the contents of
     the scheduler’s queue, represented as a list of named tuples with
     the fields ‘(time, priority, action, argument)’.  (Contributed by
     Raymond Hettinger; bpo-1861(31).)

   * The *note select: e5. module now has wrapper functions for the
     Linux ‘epoll()’ and BSD ‘kqueue()’ system calls.  ‘modify()’ method
     was added to the existing ‘poll’ objects; ‘pollobj.modify(fd,
     eventmask)’ takes a file descriptor or file object and an event
     mask, modifying the recorded event mask for that file.
     (Contributed by Christian Heimes; bpo-1657(32).)

   * The *note shutil.copytree(): 218. function now has an optional
     `ignore' argument that takes a callable object.  This callable will
     receive each directory path and a list of the directory’s contents,
     and returns a list of names that will be ignored, not copied.

     The *note shutil: e9. module also provides an ‘ignore_patterns()’
     function for use with this new parameter.  ‘ignore_patterns()’
     takes an arbitrary number of glob-style patterns and returns a
     callable that will ignore any files and directories that match any
     of these patterns.  The following example copies a directory tree,
     but skips both ‘.svn’ directories and Emacs backup files, which
     have names ending with ‘~’:

          shutil.copytree('Doc/library', '/tmp/library',
                          ignore=shutil.ignore_patterns('*~', '.svn'))

     (Contributed by Tarek Ziadé; bpo-2663(33).)

   * Integrating signal handling with GUI handling event loops like
     those used by Tkinter or GTk+ has long been a problem; most
     software ends up polling, waking up every fraction of a second to
     check if any GUI events have occurred.  The *note signal: ea.
     module can now make this more efficient.  Calling
     ‘signal.set_wakeup_fd(fd)’ sets a file descriptor to be used; when
     a signal is received, a byte is written to that file descriptor.
     There’s also a C-level function, *note PySignal_SetWakeupFd(): d39,
     for setting the descriptor.

     Event loops will use this by opening a pipe to create two
     descriptors, one for reading and one for writing.  The writable
     descriptor will be passed to ‘set_wakeup_fd()’, and the readable
     descriptor will be added to the list of descriptors monitored by
     the event loop via ‘select()’ or ‘poll()’.  On receiving a signal,
     a byte will be written and the main event loop will be woken up,
     avoiding the need to poll.

     (Contributed by Adam Olsen; bpo-1583(34).)

     The ‘siginterrupt()’ function is now available from Python code,
     and allows changing whether signals can interrupt system calls or
     not.  (Contributed by Ralf Schmitt.)

     The ‘setitimer()’ and ‘getitimer()’ functions have also been added
     (where they’re available).  ‘setitimer()’ allows setting interval
     timers that will cause a signal to be delivered to the process
     after a specified time, measured in wall-clock time, consumed
     process time, or combined process+system time.  (Contributed by
     Guilherme Polo; bpo-2240(35).)

   * The *note smtplib: ed. module now supports SMTP over SSL thanks to
     the addition of the ‘SMTP_SSL’ class.  This class supports an
     interface identical to the existing ‘SMTP’ class.  (Contributed by
     Monty Taylor.)  Both class constructors also have an optional
     ‘timeout’ parameter that specifies a timeout for the initial
     connection attempt, measured in seconds.  (Contributed by Facundo
     Batista.)

     An implementation of the LMTP protocol ( RFC 2033(36)) was also
     added to the module.  LMTP is used in place of SMTP when
     transferring e-mail between agents that don’t manage a mail queue.
     (LMTP implemented by Leif Hedstrom; bpo-957003(37).)

     ‘SMTP.starttls()’ now complies with RFC 3207(38) and forgets any
     knowledge obtained from the server not obtained from the TLS
     negotiation itself.  (Patch contributed by Bill Fenner;
     bpo-829951(39).)

   * The *note socket: ef. module now supports TIPC
     (‘http://tipc.sourceforge.net/’), a high-performance non-IP-based
     protocol designed for use in clustered environments.  TIPC
     addresses are 4- or 5-tuples.  (Contributed by Alberto Bertogli;
     bpo-1646(40).)

     A new function, ‘create_connection()’, takes an address and
     connects to it using an optional timeout value, returning the
     connected socket object.  This function also looks up the address’s
     type and connects to it using IPv4 or IPv6 as appropriate.
     Changing your code to use ‘create_connection()’ instead of
     ‘socket(socket.AF_INET, ...)’ may be all that’s required to make
     your code work with IPv6.

   * The base classes in the ‘SocketServer’ module now support calling a
     ‘handle_timeout()’ method after a span of inactivity specified by
     the server’s ‘timeout’ attribute.  (Contributed by Michael
     Pomraning.)  The ‘serve_forever()’ method now takes an optional
     poll interval measured in seconds, controlling how often the server
     will check for a shutdown request.  (Contributed by Pedro Werneck
     and Jeffrey Yasskin; bpo-742598(41), bpo-1193577(42).)

   * The *note sqlite3: f2. module, maintained by Gerhard Häring, has
     been updated from version 2.3.2 in Python 2.5 to version 2.4.1.

   * The *note struct: f8. module now supports the C99 ‘_Bool’ type,
     using the format character ‘'?'’.  (Contributed by David Remahl.)

   * The ‘Popen’ objects provided by the *note subprocess: f9. module
     now have ‘terminate()’, ‘kill()’, and ‘send_signal()’ methods.  On
     Windows, ‘send_signal()’ only supports the ‘SIGTERM’ signal, and
     all these methods are aliases for the Win32 API function
     ‘TerminateProcess()’.  (Contributed by Christian Heimes.)

   * A new variable in the *note sys: fd. module, ‘float_info’, is an
     object containing information derived from the ‘float.h’ file about
     the platform’s floating-point support.  Attributes of this object
     include ‘mant_dig’ (number of digits in the mantissa), ‘epsilon’
     (smallest difference between 1.0 and the next largest value
     representable), and several others.  (Contributed by Christian
     Heimes; bpo-1534(43).)

     Another new variable, ‘dont_write_bytecode’, controls whether
     Python writes any ‘.pyc’ or ‘.pyo’ files on importing a module.  If
     this variable is true, the compiled files are not written.  The
     variable is initially set on start-up by supplying the *note -B:
     d2b. switch to the Python interpreter, or by setting the *note
     PYTHONDONTWRITEBYTECODE: d2c. environment variable before running
     the interpreter.  Python code can subsequently change the value of
     this variable to control whether bytecode files are written or not.
     (Contributed by Neal Norwitz and Georg Brandl.)

     Information about the command-line arguments supplied to the Python
     interpreter is available by reading attributes of a named tuple
     available as ‘sys.flags’.  For example, the ‘verbose’ attribute is
     true if Python was executed in verbose mode, ‘debug’ is true in
     debugging mode, etc.  These attributes are all read-only.
     (Contributed by Christian Heimes.)

     A new function, ‘getsizeof()’, takes a Python object and returns
     the amount of memory used by the object, measured in bytes.
     Built-in objects return correct results; third-party extensions may
     not, but can define a ‘__sizeof__()’ method to return the object’s
     size.  (Contributed by Robert Schuppenies; bpo-2898(44).)

     It’s now possible to determine the current profiler and tracer
     functions by calling *note sys.getprofile(): d3a. and *note
     sys.gettrace(): d3b.  (Contributed by Georg Brandl; bpo-1648(45).)

   * The *note tarfile: 101. module now supports POSIX.1-2001 (pax)
     tarfiles in addition to the POSIX.1-1988 (ustar) and GNU tar
     formats that were already supported.  The default format is GNU
     tar; specify the ‘format’ parameter to open a file using a
     different format:

          tar = tarfile.open("output.tar", "w",
                             format=tarfile.PAX_FORMAT)

     The new ‘encoding’ and ‘errors’ parameters specify an encoding and
     an error handling scheme for character conversions.  ‘'strict'’,
     ‘'ignore'’, and ‘'replace'’ are the three standard ways Python can
     handle errors,; ‘'utf-8'’ is a special value that replaces bad
     characters with their UTF-8 representation.  (Character conversions
     occur because the PAX format supports Unicode filenames, defaulting
     to UTF-8 encoding.)

     The ‘TarFile.add()’ method now accepts an ‘exclude’ argument that’s
     a function that can be used to exclude certain filenames from an
     archive.  The function must take a filename and return true if the
     file should be excluded or false if it should be archived.  The
     function is applied to both the name initially passed to ‘add()’
     and to the names of files in recursively-added directories.

     (All changes contributed by Lars Gustäbel).

   * An optional ‘timeout’ parameter was added to the *note
     telnetlib.Telnet: 58c. class constructor, specifying a timeout
     measured in seconds.  (Added by Facundo Batista.)

   * The *note tempfile.NamedTemporaryFile: d3c. class usually deletes
     the temporary file it created when the file is closed.  This
     behaviour can now be changed by passing ‘delete=False’ to the
     constructor.  (Contributed by Damien Miller; bpo-1537850(46).)

     A new class, ‘SpooledTemporaryFile’, behaves like a temporary file
     but stores its data in memory until a maximum size is exceeded.  On
     reaching that limit, the contents will be written to an on-disk
     temporary file.  (Contributed by Dustin J. Mitchell.)

     The ‘NamedTemporaryFile’ and ‘SpooledTemporaryFile’ classes both
     work as context managers, so you can write ‘with
     tempfile.NamedTemporaryFile() as tmp: ...’.  (Contributed by
     Alexander Belopolsky; bpo-2021(47).)

   * The ‘test.test_support’ module gained a number of context managers
     useful for writing tests.  ‘EnvironmentVarGuard()’ is a context
     manager that temporarily changes environment variables and
     automatically restores them to their old values.

     Another context manager, ‘TransientResource’, can surround calls to
     resources that may or may not be available; it will catch and
     ignore a specified list of exceptions.  For example, a network test
     may ignore certain failures when connecting to an external web
     site:

          with test_support.TransientResource(IOError,
                                          errno=errno.ETIMEDOUT):
              f = urllib.urlopen('https://sf.net')
              ...

     Finally, ‘check_warnings()’ resets the ‘warning’ module’s warning
     filters and returns an object that will record all warning messages
     triggered (bpo-3781(48)):

          with test_support.check_warnings() as wrec:
              warnings.simplefilter("always")
              # ... code that triggers a warning ...
              assert str(wrec.message) == "function is outdated"
              assert len(wrec.warnings) == 1, "Multiple warnings raised"

     (Contributed by Brett Cannon.)

   * The *note textwrap: 108. module can now preserve existing
     whitespace at the beginnings and ends of the newly-created lines by
     specifying ‘drop_whitespace=False’ as an argument:

          >>> S = """This  sentence  has a bunch   of
          ...   extra   whitespace."""
          >>> print textwrap.fill(S, width=15)
          This  sentence
          has a bunch
          of    extra
          whitespace.
          >>> print textwrap.fill(S, drop_whitespace=False, width=15)
          This  sentence
            has a bunch
             of    extra
             whitespace.
          >>>

     (Contributed by Dwayne Bailey; bpo-1581073(49).)

   * The *note threading: 109. module API is being changed to use
     properties such as ‘daemon’ instead of ‘setDaemon()’ and
     ‘isDaemon()’ methods, and some methods have been renamed to use
     underscores instead of camel-case; for example, the ‘activeCount()’
     method is renamed to ‘active_count()’.  Both the 2.6 and 3.0
     versions of the module support the same properties and renamed
     methods, but don’t remove the old methods.  No date has been set
     for the deprecation of the old APIs in Python 3.x; the old APIs
     won’t be removed in any 2.x version.  (Carried out by several
     people, most notably Benjamin Peterson.)

     The *note threading: 109. module’s ‘Thread’ objects gained an
     ‘ident’ property that returns the thread’s identifier, a nonzero
     integer.  (Contributed by Gregory P. Smith; bpo-2871(50).)

   * The *note timeit: 10b. module now accepts callables as well as
     strings for the statement being timed and for the setup code.  Two
     convenience functions were added for creating ‘Timer’ instances:
     ‘repeat(stmt, setup, time, repeat, number)’ and ‘timeit(stmt,
     setup, time, number)’ create an instance and call the corresponding
     method.  (Contributed by Erik Demaine; bpo-1533909(51).)

   * The ‘Tkinter’ module now accepts lists and tuples for options,
     separating the elements by spaces before passing the resulting
     value to Tcl/Tk.  (Contributed by Guilherme Polo; bpo-2906(52).)

   * The *note turtle: 116. module for turtle graphics was greatly
     enhanced by Gregor Lingl.  New features in the module include:

        * Better animation of turtle movement and rotation.

        * Control over turtle movement using the new ‘delay()’,
          ‘tracer()’, and ‘speed()’ methods.

        * The ability to set new shapes for the turtle, and to define a
          new coordinate system.

        * Turtles now have an ‘undo()’ method that can roll back
          actions.

        * Simple support for reacting to input events such as mouse and
          keyboard activity, making it possible to write simple games.

        * A ‘turtle.cfg’ file can be used to customize the starting
          appearance of the turtle’s screen.

        * The module’s docstrings can be replaced by new docstrings that
          have been translated into another language.

     (bpo-1513695(53))

   * An optional ‘timeout’ parameter was added to the ‘urllib.urlopen()’
     function and the ‘urllib.ftpwrapper’ class constructor, as well as
     the ‘urllib2.urlopen()’ function.  The parameter specifies a
     timeout measured in seconds.  For example:

          >>> u = urllib2.urlopen("http://slow.example.com",
                                  timeout=3)
          Traceback (most recent call last):
            ...
          urllib2.URLError: <urlopen error timed out>
          >>>

     (Added by Facundo Batista.)

   * The Unicode database provided by the *note unicodedata: 11a. module
     has been updated to version 5.1.0.  (Updated by Martin von Löwis;
     bpo-3811(54).)

   * The *note warnings: 126. module’s ‘formatwarning()’ and
     ‘showwarning()’ gained an optional `line' argument that can be used
     to supply the line of source code.  (Added as part of
     bpo-1631171(55), which re-implemented part of the *note warnings:
     126. module in C code.)

     A new function, ‘catch_warnings()’, is a context manager intended
     for testing purposes that lets you temporarily modify the warning
     filters and then restore their original values (bpo-3781(56)).

   * The XML-RPC ‘SimpleXMLRPCServer’ and ‘DocXMLRPCServer’ classes can
     now be prevented from immediately opening and binding to their
     socket by passing ‘False’ as the `bind_and_activate' constructor
     parameter.  This can be used to modify the instance’s
     ‘allow_reuse_address’ attribute before calling the ‘server_bind()’
     and ‘server_activate()’ methods to open the socket and begin
     listening for connections.  (Contributed by Peter Parente;
     bpo-1599845(57).)

     ‘SimpleXMLRPCServer’ also has a ‘_send_traceback_header’ attribute;
     if true, the exception and formatted traceback are returned as HTTP
     headers “X-Exception” and “X-Traceback”.  This feature is for
     debugging purposes only and should not be used on production
     servers because the tracebacks might reveal passwords or other
     sensitive information.  (Contributed by Alan McIntyre as part of
     his project for Google’s Summer of Code 2007.)

   * The ‘xmlrpclib’ module no longer automatically converts *note
     datetime.date: 193. and *note datetime.time: 4e8. to the
     ‘xmlrpclib.DateTime’ type; the conversion semantics were not
     necessarily correct for all applications.  Code using ‘xmlrpclib’
     should convert ‘date’ and *note time: 4e8. instances.
     (bpo-1330538(58)) The code can also handle dates before 1900
     (contributed by Ralf Schmitt; bpo-2014(59)) and 64-bit integers
     represented by using ‘<i8>’ in XML-RPC responses (contributed by
     Riku Lindblad; bpo-2985(60)).

   * The *note zipfile: 142. module’s ‘ZipFile’ class now has
     ‘extract()’ and ‘extractall()’ methods that will unpack a single
     file or all the files in the archive to the current directory, or
     to a specified directory:

          z = zipfile.ZipFile('python-251.zip')

          # Unpack a single file, writing it relative
          # to the /tmp directory.
          z.extract('Python/sysmodule.c', '/tmp')

          # Unpack all the files in the archive.
          z.extractall()

     (Contributed by Alan McIntyre; bpo-467924(61).)

     The *note open(): 4e5, ‘read()’ and ‘extract()’ methods can now
     take either a filename or a ‘ZipInfo’ object.  This is useful when
     an archive accidentally contains a duplicated filename.
     (Contributed by Graham Horler; bpo-1775025(62).)

     Finally, *note zipfile: 142. now supports using Unicode filenames
     for archived files.  (Contributed by Alexey Borzenkov;
     bpo-1734346(63).)

* Menu:

* The ast module::
* The future_builtins module::
* The json module; JavaScript Object Notation: The json module JavaScript Object Notation.
* The plistlib module; A Property-List Parser: The plistlib module A Property-List Parser.
* ctypes Enhancements::
* Improved SSL Support::

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1736190

   (2) https://www.jcea.es/programacion/pybsddb.htm

   (3) https://bugs.python.org/issue1817

   (4) https://bugs.python.org/issue600362

   (5) https://bugs.python.org/issue1381

   (6) https://bugs.python.org/issue1638033

   (7) https://bugs.python.org/issue1158

   (8) http://speleotrove.com/decimal/decarith.html

   (9) https://bugs.python.org/issue1221598

   (10) https://bugs.python.org/issue1739906

   (11) https://bugs.python.org/issue1001604

   (12) https://bugs.python.org/issue2138

   (13) https://bugs.python.org/issue2819

   (14) https://bugs.python.org/issue711019

   (15) https://bugs.python.org/issue1640

   (16) https://bugs.python.org/issue1663329

   (17) https://bugs.python.org/issue1181

   (18) https://bugs.python.org/issue1273829

   (19) https://bugs.python.org/issue1115886

   (20) https://bugs.python.org/issue1339796

   (21) https://bugs.python.org/issue957650

   (22) https://bugs.python.org/issue1393667

   (23) https://bugs.python.org/issue1106316

   (24) https://bugs.python.org/issue2439

   (25) https://bugs.python.org/issue1137

   (26) https://bugs.python.org/issue1727780

   (27) https://bugs.python.org/issue1681432

   (28) https://bugs.python.org/issue846388

   (29) https://bugs.python.org/issue3487

   (30) https://bugs.python.org/issue2250

   (31) https://bugs.python.org/issue1861

   (32) https://bugs.python.org/issue1657

   (33) https://bugs.python.org/issue2663

   (34) https://bugs.python.org/issue1583

   (35) https://bugs.python.org/issue2240

   (36) https://tools.ietf.org/html/rfc2033.html

   (37) https://bugs.python.org/issue957003

   (38) https://tools.ietf.org/html/rfc3207.html

   (39) https://bugs.python.org/issue829951

   (40) https://bugs.python.org/issue1646

   (41) https://bugs.python.org/issue742598

   (42) https://bugs.python.org/issue1193577

   (43) https://bugs.python.org/issue1534

   (44) https://bugs.python.org/issue2898

   (45) https://bugs.python.org/issue1648

   (46) https://bugs.python.org/issue1537850

   (47) https://bugs.python.org/issue2021

   (48) https://bugs.python.org/issue3781

   (49) https://bugs.python.org/issue1581073

   (50) https://bugs.python.org/issue2871

   (51) https://bugs.python.org/issue1533909

   (52) https://bugs.python.org/issue2906

   (53) https://bugs.python.org/issue1513695

   (54) https://bugs.python.org/issue3811

   (55) https://bugs.python.org/issue1631171

   (56) https://bugs.python.org/issue3781

   (57) https://bugs.python.org/issue1599845

   (58) https://bugs.python.org/issue1330538

   (59) https://bugs.python.org/issue2014

   (60) https://bugs.python.org/issue2985

   (61) https://bugs.python.org/issue467924

   (62) https://bugs.python.org/issue1775025

   (63) https://bugs.python.org/issue1734346


File: python.info,  Node: The ast module,  Next: The future_builtins module,  Up: New and Improved Modules<2>

1.11.18.1 The ‘ast’ module
..........................

The *note ast: 8. module provides an Abstract Syntax Tree representation
of Python code, and Armin Ronacher contributed a set of helper functions
that perform a variety of common tasks.  These will be useful for HTML
templating packages, code analyzers, and similar tools that process
Python code.

The ‘parse()’ function takes an expression and returns an AST. The
‘dump()’ function outputs a representation of a tree, suitable for
debugging:

     import ast

     t = ast.parse("""
     d = {}
     for i in 'abcdefghijklm':
         d[i + i] = ord(i) - ord('a') + 1
     print d
     """)
     print ast.dump(t)

This outputs a deeply nested tree:

     Module(body=[
       Assign(targets=[
         Name(id='d', ctx=Store())
        ], value=Dict(keys=[], values=[]))
       For(target=Name(id='i', ctx=Store()),
           iter=Str(s='abcdefghijklm'), body=[
         Assign(targets=[
           Subscript(value=
             Name(id='d', ctx=Load()),
               slice=
               Index(value=
                 BinOp(left=Name(id='i', ctx=Load()), op=Add(),
                  right=Name(id='i', ctx=Load()))), ctx=Store())
          ], value=
          BinOp(left=
           BinOp(left=
            Call(func=
             Name(id='ord', ctx=Load()), args=[
               Name(id='i', ctx=Load())
              ], keywords=[], starargs=None, kwargs=None),
            op=Sub(), right=Call(func=
             Name(id='ord', ctx=Load()), args=[
               Str(s='a')
              ], keywords=[], starargs=None, kwargs=None)),
            op=Add(), right=Num(n=1)))
         ], orelse=[])
        Print(dest=None, values=[
          Name(id='d', ctx=Load())
        ], nl=True)
      ])

The ‘literal_eval()’ method takes a string or an AST representing a
literal expression, parses and evaluates it, and returns the resulting
value.  A literal expression is a Python expression containing only
strings, numbers, dictionaries, etc.  but no statements or function
calls.  If you need to evaluate an expression but cannot accept the
security risk of using an *note eval(): b83. call, ‘literal_eval()’ will
handle it safely:

     >>> literal = '("a", "b", {2:4, 3:8, 1:2})'
     >>> print ast.literal_eval(literal)
     ('a', 'b', {1: 2, 2: 4, 3: 8})
     >>> print ast.literal_eval('"a" + "b"')
     Traceback (most recent call last):
       ...
     ValueError: malformed string

The module also includes ‘NodeVisitor’ and ‘NodeTransformer’ classes for
traversing and modifying an AST, and functions for common
transformations such as changing line numbers.


File: python.info,  Node: The future_builtins module,  Next: The json module JavaScript Object Notation,  Prev: The ast module,  Up: New and Improved Modules<2>

1.11.18.2 The ‘future_builtins’ module
......................................

Python 3.0 makes many changes to the repertoire of built-in functions,
and most of the changes can’t be introduced in the Python 2.x series
because they would break compatibility.  The ‘future_builtins’ module
provides versions of these built-in functions that can be imported when
writing 3.0-compatible code.

The functions in this module currently include:

   * ‘ascii(obj)’: equivalent to *note repr(): 7c0.  In Python 3.0,
     *note repr(): 7c0. will return a Unicode string, while *note
     ascii(): d3f. will return a pure ASCII bytestring.

   * ‘filter(predicate, iterable)’, ‘map(func, iterable1, ...)’: the 3.0
     versions return iterators, unlike the 2.x builtins which return
     lists.

   * ‘hex(value)’, ‘oct(value)’: instead of calling the ‘__hex__()’ or
     ‘__oct__()’ methods, these versions will call the *note
     __index__(): 18a. method and convert the result to hexadecimal or
     octal.  *note oct(): c58. will use the new ‘0o’ notation for its
     result.


File: python.info,  Node: The json module JavaScript Object Notation,  Next: The plistlib module A Property-List Parser,  Prev: The future_builtins module,  Up: New and Improved Modules<2>

1.11.18.3 The ‘json’ module: JavaScript Object Notation
.......................................................

The new *note json: a4. module supports the encoding and decoding of
Python types in JSON (Javascript Object Notation).  JSON is a
lightweight interchange format often used in web applications.  For more
information about JSON, see ‘http://www.json.org’.

*note json: a4. comes with support for decoding and encoding most
built-in Python types.  The following example encodes and decodes a
dictionary:

     >>> import json
     >>> data = {"spam": "foo", "parrot": 42}
     >>> in_json = json.dumps(data) # Encode the data
     >>> in_json
     '{"parrot": 42, "spam": "foo"}'
     >>> json.loads(in_json) # Decode into a Python object
     {"spam": "foo", "parrot": 42}

It’s also possible to write your own decoders and encoders to support
more types.  Pretty-printing of the JSON strings is also supported.

*note json: a4. (originally called simplejson) was written by Bob
Ippolito.


File: python.info,  Node: The plistlib module A Property-List Parser,  Next: ctypes Enhancements,  Prev: The json module JavaScript Object Notation,  Up: New and Improved Modules<2>

1.11.18.4 The ‘plistlib’ module: A Property-List Parser
.......................................................

The ‘.plist’ format is commonly used on Mac OS X to store basic data
types (numbers, strings, lists, and dictionaries) by serializing them
into an XML-based format.  It resembles the XML-RPC serialization of
data types.

Despite being primarily used on Mac OS X, the format has nothing
Mac-specific about it and the Python implementation works on any
platform that Python supports, so the *note plistlib: cf. module has
been promoted to the standard library.

Using the module is simple:

     import sys
     import plistlib
     import datetime

     # Create data structure
     data_struct = dict(lastAccessed=datetime.datetime.now(),
                        version=1,
                        categories=('Personal','Shared','Private'))

     # Create string containing XML.
     plist_str = plistlib.writePlistToString(data_struct)
     new_struct = plistlib.readPlistFromString(plist_str)
     print data_struct
     print new_struct

     # Write data structure to a file and read it back.
     plistlib.writePlist(data_struct, '/tmp/customizations.plist')
     new_struct = plistlib.readPlist('/tmp/customizations.plist')

     # read/writePlist accepts file-like objects as well as paths.
     plistlib.writePlist(data_struct, sys.stdout)


File: python.info,  Node: ctypes Enhancements,  Next: Improved SSL Support,  Prev: The plistlib module A Property-List Parser,  Up: New and Improved Modules<2>

1.11.18.5 ctypes Enhancements
.............................

Thomas Heller continued to maintain and enhance the *note ctypes: 2b.
module.

*note ctypes: 2b. now supports a ‘c_bool’ datatype that represents the
C99 ‘bool’ type.  (Contributed by David Remahl; bpo-1649190(1).)

The *note ctypes: 2b. string, buffer and array types have improved
support for extended slicing syntax, where various combinations of
‘(start, stop, step)’ are supplied.  (Implemented by Thomas Wouters.)

All *note ctypes: 2b. data types now support ‘from_buffer()’ and
‘from_buffer_copy()’ methods that create a ctypes instance based on a
provided buffer object.  ‘from_buffer_copy()’ copies the contents of the
object, while ‘from_buffer()’ will share the same memory area.

A new calling convention tells *note ctypes: 2b. to clear the ‘errno’ or
Win32 LastError variables at the outset of each wrapped call.
(Implemented by Thomas Heller; bpo-1798(2).)

You can now retrieve the Unix ‘errno’ variable after a function call.
When creating a wrapped function, you can supply ‘use_errno=True’ as a
keyword parameter to the ‘DLL()’ function and then call the module-level
methods ‘set_errno()’ and ‘get_errno()’ to set and retrieve the error
value.

The Win32 LastError variable is similarly supported by the ‘DLL()’,
‘OleDLL()’, and ‘WinDLL()’ functions.  You supply ‘use_last_error=True’
as a keyword parameter and then call the module-level methods
‘set_last_error()’ and ‘get_last_error()’.

The ‘byref()’ function, used to retrieve a pointer to a ctypes instance,
now has an optional `offset' parameter that is a byte count that will be
added to the returned pointer.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1649190

   (2) https://bugs.python.org/issue1798


File: python.info,  Node: Improved SSL Support,  Prev: ctypes Enhancements,  Up: New and Improved Modules<2>

1.11.18.6 Improved SSL Support
..............................

Bill Janssen made extensive improvements to Python 2.6’s support for the
Secure Sockets Layer by adding a new module, *note ssl: f3, that’s built
atop the OpenSSL(1) library.  This new module provides more control over
the protocol negotiated, the X.509 certificates used, and has better
support for writing SSL servers (as opposed to clients) in Python.  The
existing SSL support in the *note socket: ef. module hasn’t been removed
and continues to work, though it will be removed in Python 3.0.

To use the new module, you must first create a TCP connection in the
usual way and then pass it to the *note ssl.wrap_socket(): 464.
function.  It’s possible to specify whether a certificate is required,
and to obtain certificate info by calling the ‘getpeercert()’ method.

See also
........

The documentation for the *note ssl: f3. module.

   ---------- Footnotes ----------

   (1) https://www.openssl.org/


File: python.info,  Node: Deprecations and Removals,  Next: Build and C API Changes<9>,  Prev: New and Improved Modules<2>,  Up: What’s New in Python 2 6

1.11.19 Deprecations and Removals
---------------------------------

   * String exceptions have been removed.  Attempting to use them raises
     a *note TypeError: 192.

   * Changes to the *note Exception: 1a8. interface as dictated by PEP
     352(1) continue to be made.  For 2.6, the ‘message’ attribute is
     being deprecated in favor of the ‘args’ attribute.

   * (3.0-warning mode) Python 3.0 will feature a reorganized standard
     library that will drop many outdated modules and rename others.
     Python 2.6 running in 3.0-warning mode will warn about these
     modules when they are imported.

     The list of deprecated modules is: ‘audiodev’, ‘bgenlocations’,
     ‘buildtools’, ‘bundlebuilder’, ‘Canvas’, ‘compiler’, ‘dircache’,
     ‘dl’, ‘fpformat’, ‘gensuitemodule’, ‘ihooks’, ‘imageop’, ‘imgfile’,
     ‘linuxaudiodev’, ‘mhlib’, ‘mimetools’, ‘multifile’, ‘new’, ‘pure’,
     ‘statvfs’, ‘sunaudiodev’, ‘test.testall’, and ‘toaiff’.

   * The ‘gopherlib’ module has been removed.

   * The ‘MimeWriter’ module and ‘mimify’ module have been deprecated;
     use the *note email: 69. package instead.

   * The ‘md5’ module has been deprecated; use the *note hashlib: 8d.
     module instead.

   * The ‘posixfile’ module has been deprecated; *note fcntl.lockf():
     d45. provides better locking.

   * The ‘popen2’ module has been deprecated; use the *note subprocess:
     f9. module.

   * The ‘rgbimg’ module has been removed.

   * The ‘sets’ module has been deprecated; it’s better to use the
     built-in *note set: b62. and *note frozenset: be1. types.

   * The ‘sha’ module has been deprecated; use the *note hashlib: 8d.
     module instead.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0352


File: python.info,  Node: Build and C API Changes<9>,  Next: Porting to Python 2 6,  Prev: Deprecations and Removals,  Up: What’s New in Python 2 6

1.11.20 Build and C API Changes
-------------------------------

Changes to Python’s build process and to the C API include:

   * Python now must be compiled with C89 compilers (after 19 years!).
     This means that the Python source tree has dropped its own
     implementations of ‘memmove()’ and ‘strerror()’, which are in the
     C89 standard library.

   * Python 2.6 can be built with Microsoft Visual Studio 2008 (version
     9.0), and this is the new default compiler.  See the ‘PCbuild’
     directory for the build files.  (Implemented by Christian Heimes.)

   * On Mac OS X, Python 2.6 can be compiled as a 4-way universal build.
     The ‘configure’ script can take a
     ‘--with-universal-archs=[32-bit|64-bit|all]’ switch, controlling
     whether the binaries are built for 32-bit architectures (x86,
     PowerPC), 64-bit (x86-64 and PPC-64), or both.  (Contributed by
     Ronald Oussoren.)

   * The BerkeleyDB module now has a C API object, available as
     ‘bsddb.db.api’.  This object can be used by other C extensions that
     wish to use the ‘bsddb’ module for their own purposes.
     (Contributed by Duncan Grisby.)

   * The new buffer interface, previously described in *note the PEP
     3118 section: d17, adds *note PyObject_GetBuffer(): d18. and *note
     PyBuffer_Release(): d47, as well as a few other functions.

   * Python’s use of the C stdio library is now thread-safe, or at least
     as thread-safe as the underlying library is.  A long-standing
     potential bug occurred if one thread closed a file object while
     another thread was reading from or writing to the object.  In 2.6
     file objects have a reference count, manipulated by the
     ‘PyFile_IncUseCount()’ and ‘PyFile_DecUseCount()’ functions.  File
     objects can’t be closed unless the reference count is zero.
     ‘PyFile_IncUseCount()’ should be called while the GIL is still
     held, before carrying out an I/O operation using the ‘FILE *’
     pointer, and ‘PyFile_DecUseCount()’ should be called immediately
     after the GIL is re-acquired.  (Contributed by Antoine Pitrou and
     Gregory P. Smith.)

   * Importing modules simultaneously in two different threads no longer
     deadlocks; it will now raise an *note ImportError: 329.  A new API
     function, *note PyImport_ImportModuleNoBlock(): 9b5, will look for
     a module in ‘sys.modules’ first, then try to import it after
     acquiring an import lock.  If the import lock is held by another
     thread, an *note ImportError: 329. is raised.  (Contributed by
     Christian Heimes.)

   * Several functions return information about the platform’s
     floating-point support.  *note PyFloat_GetMax(): d48. returns the
     maximum representable floating point value, and *note
     PyFloat_GetMin(): d49. returns the minimum positive value.  *note
     PyFloat_GetInfo(): d4a. returns an object containing more
     information from the ‘float.h’ file, such as ‘"mant_dig"’ (number
     of digits in the mantissa), ‘"epsilon"’ (smallest difference
     between 1.0 and the next largest value representable), and several
     others.  (Contributed by Christian Heimes; bpo-1534(1).)

   * C functions and methods that use *note PyComplex_AsCComplex(): d4b.
     will now accept arguments that have a *note __complex__(): 18d.
     method.  In particular, the functions in the *note cmath: 19.
     module will now accept objects with this method.  This is a
     backport of a Python 3.0 change.  (Contributed by Mark Dickinson;
     bpo-1675423(2).)

   * Python’s C API now includes two functions for case-insensitive
     string comparisons, ‘PyOS_stricmp(char*, char*)’ and
     ‘PyOS_strnicmp(char*, char*, Py_ssize_t)’.  (Contributed by
     Christian Heimes; bpo-1635(3).)

   * Many C extensions define their own little macro for adding integers
     and strings to the module’s dictionary in the ‘init*’ function.
     Python 2.6 finally defines standard macros for adding values to a
     module, *note PyModule_AddStringMacro: d4c. and
     ‘PyModule_AddIntMacro()’.  (Contributed by Christian Heimes.)

   * Some macros were renamed in both 3.0 and 2.6 to make it clearer
     that they are macros, not functions.  ‘Py_Size()’ became
     ‘Py_SIZE()’, ‘Py_Type()’ became ‘Py_TYPE()’, and ‘Py_Refcnt()’
     became ‘Py_REFCNT()’.  The mixed-case macros are still available in
     Python 2.6 for backward compatibility.  (bpo-1629(4))

   * Distutils now places C extensions it builds in a different
     directory when running on a debug version of Python.  (Contributed
     by Collin Winter; bpo-1530959(5).)

   * Several basic data types, such as integers and strings, maintain
     internal free lists of objects that can be re-used.  The data
     structures for these free lists now follow a naming convention: the
     variable is always named ‘free_list’, the counter is always named
     ‘numfree’, and a macro ‘Py<typename>_MAXFREELIST’ is always
     defined.

   * A new Makefile target, “make patchcheck”, prepares the Python
     source tree for making a patch: it fixes trailing whitespace in all
     modified ‘.py’ files, checks whether the documentation has been
     changed, and reports whether the ‘Misc/ACKS’ and ‘Misc/NEWS’ files
     have been updated.  (Contributed by Brett Cannon.)

     Another new target, “make profile-opt”, compiles a Python binary
     using GCC’s profile-guided optimization.  It compiles Python with
     profiling enabled, runs the test suite to obtain a set of profiling
     results, and then compiles using these results for optimization.
     (Contributed by Gregory P. Smith.)

* Menu:

* Port-Specific Changes; Windows: Port-Specific Changes Windows<2>.
* Port-Specific Changes; Mac OS X: Port-Specific Changes Mac OS X<2>.
* Port-Specific Changes; IRIX: Port-Specific Changes IRIX.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1534

   (2) https://bugs.python.org/issue1675423

   (3) https://bugs.python.org/issue1635

   (4) https://bugs.python.org/issue1629

   (5) https://bugs.python.org/issue1530959


File: python.info,  Node: Port-Specific Changes Windows<2>,  Next: Port-Specific Changes Mac OS X<2>,  Up: Build and C API Changes<9>

1.11.20.1 Port-Specific Changes: Windows
........................................

   * The support for Windows 95, 98, ME and NT4 has been dropped.
     Python 2.6 requires at least Windows 2000 SP4.

   * The new default compiler on Windows is Visual Studio 2008 (version
     9.0).  The build directories for Visual Studio 2003 (version 7.1)
     and 2005 (version 8.0) were moved into the PC/ directory.  The new
     ‘PCbuild’ directory supports cross compilation for X64, debug
     builds and Profile Guided Optimization (PGO). PGO builds are
     roughly 10% faster than normal builds.  (Contributed by Christian
     Heimes with help from Amaury Forgeot d’Arc and Martin von Löwis.)

   * The *note msvcrt: b6. module now supports both the normal and wide
     char variants of the console I/O API. The ‘getwch()’ function reads
     a keypress and returns a Unicode value, as does the ‘getwche()’
     function.  The ‘putwch()’ function takes a Unicode character and
     writes it to the console.  (Contributed by Christian Heimes.)

   * *note os.path.expandvars(): d37. will now expand environment
     variables in the form “%var%”, and “~user” will be expanded into
     the user’s home directory path.  (Contributed by Josiah Carlson;
     bpo-957650(1).)

   * The *note socket: ef. module’s socket objects now have an ‘ioctl()’
     method that provides a limited interface to the ‘WSAIoctl()’ system
     interface.

   * The ‘_winreg’ module now has a function,
     ‘ExpandEnvironmentStrings()’, that expands environment variable
     references such as ‘%NAME%’ in an input string.  The handle objects
     provided by this module now support the context protocol, so they
     can be used in *note with: 6dd. statements.  (Contributed by
     Christian Heimes.)

     ‘_winreg’ also has better support for x64 systems, exposing the
     ‘DisableReflectionKey()’, ‘EnableReflectionKey()’, and
     ‘QueryReflectionKey()’ functions, which enable and disable registry
     reflection for 32-bit processes running on 64-bit systems.
     (bpo-1753245(2))

   * The *note msilib: b5. module’s ‘Record’ object gained
     ‘GetInteger()’ and ‘GetString()’ methods that return field values
     as an integer or a string.  (Contributed by Floris Bruynooghe;
     bpo-2125(3).)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue957650

   (2) https://bugs.python.org/issue1753245

   (3) https://bugs.python.org/issue2125


File: python.info,  Node: Port-Specific Changes Mac OS X<2>,  Next: Port-Specific Changes IRIX,  Prev: Port-Specific Changes Windows<2>,  Up: Build and C API Changes<9>

1.11.20.2 Port-Specific Changes: Mac OS X
.........................................

   * When compiling a framework build of Python, you can now specify the
     framework name to be used by providing the ‘--with-framework-name=’
     option to the ‘configure’ script.

   * The ‘macfs’ module has been removed.  This in turn required the
     ‘macostools.touched()’ function to be removed because it depended
     on the ‘macfs’ module.  (bpo-1490190(1))

   * Many other Mac OS modules have been deprecated and will be removed
     in Python 3.0: ‘_builtinSuites’, ‘aepack’, ‘aetools’, ‘aetypes’,
     ‘applesingle’, ‘appletrawmain’, ‘appletrunner’, ‘argvemulator’,
     ‘Audio_mac’, ‘autoGIL’, ‘Carbon’, ‘cfmfile’, ‘CodeWarrior’,
     ‘ColorPicker’, ‘EasyDialogs’, ‘Explorer’, ‘Finder’, ‘FrameWork’,
     ‘findertools’, ‘ic’, ‘icglue’, ‘icopen’, ‘macerrors’, ‘MacOS’,
     ‘macfs’, ‘macostools’, ‘macresource’, ‘MiniAEFrame’, ‘Nav’,
     ‘Netscape’, ‘OSATerminology’, ‘pimp’, ‘PixMapWrapper’, ‘StdSuites’,
     ‘SystemEvents’, ‘Terminal’, and ‘terminalcommand’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1490190


File: python.info,  Node: Port-Specific Changes IRIX,  Prev: Port-Specific Changes Mac OS X<2>,  Up: Build and C API Changes<9>

1.11.20.3 Port-Specific Changes: IRIX
.....................................

A number of old IRIX-specific modules were deprecated and will be
removed in Python 3.0: ‘al’ and ‘AL’, ‘cd’, ‘cddb’, ‘cdplayer’, ‘CL’ and
‘cl’, ‘DEVICE’, ‘ERRNO’, ‘FILE’, ‘FL’ and ‘fl’, ‘flp’, ‘fm’, ‘GET’,
‘GLWS’, ‘GL’ and ‘gl’, ‘IN’, ‘IOCTL’, ‘jpeg’, ‘panelparser’, ‘readcd’,
‘SV’ and ‘sv’, ‘torgb’, ‘videoreader’, and ‘WAIT’.


File: python.info,  Node: Porting to Python 2 6,  Next: Acknowledgements<2>,  Prev: Build and C API Changes<9>,  Up: What’s New in Python 2 6

1.11.21 Porting to Python 2.6
-----------------------------

This section lists previously described changes and other bugfixes that
may require changes to your code:

   * Classes that aren’t supposed to be hashable should set ‘__hash__ =
     None’ in their definitions to indicate the fact.

   * String exceptions have been removed.  Attempting to use them raises
     a *note TypeError: 192.

   * The *note __init__(): d51. method of *note collections.deque: 526.
     now clears any existing contents of the deque before adding
     elements from the iterable.  This change makes the behavior match
     ‘list.__init__()’.

   * *note object.__init__(): d51. previously accepted arbitrary
     arguments and keyword arguments, ignoring them.  In Python 2.6,
     this is no longer allowed and will result in a *note TypeError:
     192.  This will affect *note __init__(): d51. methods that end up
     calling the corresponding method on *note object: 2ae. (perhaps
     through using *note super(): 4d7.).  See bpo-1683368(1) for
     discussion.

   * The ‘Decimal’ constructor now accepts leading and trailing
     whitespace when passed a string.  Previously it would raise an
     ‘InvalidOperation’ exception.  On the other hand, the
     ‘create_decimal()’ method of ‘Context’ objects now explicitly
     disallows extra whitespace, raising a ‘ConversionSyntax’ exception.

   * Due to an implementation accident, if you passed a file path to the
     built-in *note __import__(): 605. function, it would actually
     import the specified file.  This was never intended to work,
     however, and the implementation now explicitly checks for this case
     and raises an *note ImportError: 329.

   * C API: the *note PyImport_Import(): d52. and *note
     PyImport_ImportModule(): c66. functions now default to absolute
     imports, not relative imports.  This will affect C extensions that
     import other modules.

   * C API: extension data types that shouldn’t be hashable should
     define their ‘tp_hash’ slot to *note PyObject_HashNotImplemented():
     d24.

   * The *note socket: ef. module exception *note socket.error: 989. now
     inherits from *note IOError: 986.  Previously it wasn’t a subclass
     of ‘StandardError’ but now it is, through *note IOError: 986.
     (Implemented by Gregory P. Smith; bpo-1706815(2).)

   * The ‘xmlrpclib’ module no longer automatically converts *note
     datetime.date: 193. and *note datetime.time: 4e8. to the
     ‘xmlrpclib.DateTime’ type; the conversion semantics were not
     necessarily correct for all applications.  Code using ‘xmlrpclib’
     should convert ‘date’ and *note time: 4e8. instances.
     (bpo-1330538(3))

   * (3.0-warning mode) The *note Exception: 1a8. class now warns when
     accessed using slicing or index access; having *note Exception:
     1a8. behave like a tuple is being phased out.

   * (3.0-warning mode) inequality comparisons between two dictionaries
     or two objects that don’t implement comparison methods are reported
     as warnings.  ‘dict1 == dict2’ still works, but ‘dict1 < dict2’ is
     being phased out.

     Comparisons between cells, which are an implementation detail of
     Python’s scoping rules, also cause warnings because such
     comparisons are forbidden entirely in 3.0.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1683368

   (2) https://bugs.python.org/issue1706815

   (3) https://bugs.python.org/issue1330538


File: python.info,  Node: Acknowledgements<2>,  Prev: Porting to Python 2 6,  Up: What’s New in Python 2 6

1.11.22 Acknowledgements
------------------------

The author would like to thank the following people for offering
suggestions, corrections and assistance with various drafts of this
article: Georg Brandl, Steve Brown, Nick Coghlan, Ralph Corderoy, Jim
Jewett, Kent Johnson, Chris Lambacher, Martin Michlmayr, Antoine Pitrou,
Brian Warner.


File: python.info,  Node: What’s New in Python 2 5,  Next: What’s New in Python 2 4,  Prev: What’s New in Python 2 6,  Up: What’s New in Python

1.12 What’s New in Python 2.5
=============================


Author: A.M. Kuchling

This article explains the new features in Python 2.5.  The final release
of Python 2.5 is scheduled for August 2006; PEP 356(1) describes the
planned release schedule.

The changes in Python 2.5 are an interesting mix of language and library
improvements.  The library enhancements will be more important to
Python’s user community, I think, because several widely-useful packages
were added.  New modules include ElementTree for XML processing
(‘xml.etree’), the SQLite database module (‘sqlite’), and the *note
ctypes: 2b. module for calling C functions.

The language changes are of middling significance.  Some pleasant new
features were added, but most of them aren’t features that you’ll use
every day.  Conditional expressions were finally added to the language
using a novel syntax; see section *note PEP 308; Conditional
Expressions: d57.  The new ‘*note with: 6dd.’ statement will make
writing cleanup code easier (section *note PEP 343; The ‘with’
statement: d58.).  Values can now be passed into generators (section
*note PEP 342; New Generator Features: d59.).  Imports are now visible
as either absolute or relative (section *note PEP 328; Absolute and
Relative Imports: d5a.).  Some corner cases of exception handling are
handled better (section *note PEP 341; Unified try/except/finally:
d5b.).  All these improvements are worthwhile, but they’re improvements
to one specific language feature or another; none of them are broad
modifications to Python’s semantics.

As well as the language and library additions, other improvements and
bugfixes were made throughout the source tree.  A search through the SVN
change logs finds there were 353 patches applied and 458 bugs fixed
between Python 2.4 and 2.5.  (Both figures are likely to be
underestimates.)

This article doesn’t try to be a complete specification of the new
features; instead changes are briefly introduced using helpful examples.
For full details, you should always refer to the documentation for
Python 2.5 at ‘https://docs.python.org’.  If you want to understand the
complete implementation and design rationale, refer to the PEP for a
particular new feature.

Comments, suggestions, and error reports for this document are welcome;
please e-mail them to the author or open a bug in the Python bug
tracker.

* Menu:

* PEP 308; Conditional Expressions: PEP 308 Conditional Expressions.
* PEP 309; Partial Function Application: PEP 309 Partial Function Application.
* PEP 314; Metadata for Python Software Packages v1.1: PEP 314 Metadata for Python Software Packages v1 1.
* PEP 328; Absolute and Relative Imports: PEP 328 Absolute and Relative Imports.
* PEP 338; Executing Modules as Scripts: PEP 338 Executing Modules as Scripts.
* PEP 341; Unified try/except/finally: PEP 341 Unified try/except/finally.
* PEP 342; New Generator Features: PEP 342 New Generator Features.
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement<2>.
* PEP 352; Exceptions as New-Style Classes: PEP 352 Exceptions as New-Style Classes.
* PEP 353; Using ssize_t as the index type: PEP 353 Using ssize_t as the index type.
* PEP 357; The ‘__index__’ method: PEP 357 The ‘__index__’ method.
* Other Language Changes: Other Language Changes<11>.
* New, Improved, and Removed Modules: New Improved and Removed Modules.
* Build and C API Changes: Build and C API Changes<10>.
* Porting to Python 2.5: Porting to Python 2 5.
* Acknowledgements: Acknowledgements<3>.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0356


File: python.info,  Node: PEP 308 Conditional Expressions,  Next: PEP 309 Partial Function Application,  Up: What’s New in Python 2 5

1.12.1 PEP 308: Conditional Expressions
---------------------------------------

For a long time, people have been requesting a way to write conditional
expressions, which are expressions that return value A or value B
depending on whether a Boolean value is true or false.  A conditional
expression lets you write a single assignment statement that has the
same effect as the following:

     if condition:
         x = true_value
     else:
         x = false_value

There have been endless tedious discussions of syntax on both python-dev
and comp.lang.python.  A vote was even held that found the majority of
voters wanted conditional expressions in some form, but there was no
syntax that was preferred by a clear majority.  Candidates included C’s
‘cond ? true_v : false_v’, ‘if cond then true_v else false_v’, and 16
other variations.

Guido van Rossum eventually chose a surprising syntax:

     x = true_value if condition else false_value

Evaluation is still lazy as in existing Boolean expressions, so the
order of evaluation jumps around a bit.  The `condition' expression in
the middle is evaluated first, and the `true_value' expression is
evaluated only if the condition was true.  Similarly, the `false_value'
expression is only evaluated when the condition is false.

This syntax may seem strange and backwards; why does the condition go in
the `middle' of the expression, and not in the front as in C’s ‘c ? x :
y’?  The decision was checked by applying the new syntax to the modules
in the standard library and seeing how the resulting code read.  In many
cases where a conditional expression is used, one value seems to be the
‘common case’ and one value is an ‘exceptional case’, used only on rarer
occasions when the condition isn’t met.  The conditional syntax makes
this pattern a bit more obvious:

     contents = ((doc + '\n') if doc else '')

I read the above statement as meaning “here `contents' is usually
assigned a value of ‘doc+'\n'’; sometimes `doc' is empty, in which
special case an empty string is returned.” I doubt I will use
conditional expressions very often where there isn’t a clear common and
uncommon case.

There was some discussion of whether the language should require
surrounding conditional expressions with parentheses.  The decision was
made to `not' require parentheses in the Python language’s grammar, but
as a matter of style I think you should always use them.  Consider these
two statements:

     # First version -- no parens
     level = 1 if logging else 0

     # Second version -- with parens
     level = (1 if logging else 0)

In the first version, I think a reader’s eye might group the statement
into ‘level = 1’, ‘if logging’, ‘else 0’, and think that the condition
decides whether the assignment to `level' is performed.  The second
version reads better, in my opinion, because it makes it clear that the
assignment is always performed and the choice is being made between two
values.

Another reason for including the brackets: a few odd combinations of
list comprehensions and lambdas could look like incorrect conditional
expressions.  See PEP 308(1) for some examples.  If you put parentheses
around your conditional expressions, you won’t run into this case.

See also
........

PEP 308(2) - Conditional Expressions

     PEP written by Guido van Rossum and Raymond D. Hettinger;
     implemented by Thomas Wouters.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0308

   (2) https://www.python.org/dev/peps/pep-0308


File: python.info,  Node: PEP 309 Partial Function Application,  Next: PEP 314 Metadata for Python Software Packages v1 1,  Prev: PEP 308 Conditional Expressions,  Up: What’s New in Python 2 5

1.12.2 PEP 309: Partial Function Application
--------------------------------------------

The *note functools: 85. module is intended to contain tools for
functional-style programming.

One useful tool in this module is the ‘partial()’ function.  For
programs written in a functional style, you’ll sometimes want to
construct variants of existing functions that have some of the
parameters filled in.  Consider a Python function ‘f(a, b, c)’; you
could create a new function ‘g(b, c)’ that was equivalent to ‘f(1, b,
c)’.  This is called “partial function application”.

‘partial()’ takes the arguments ‘(function, arg1, arg2, ...
kwarg1=value1, kwarg2=value2)’.  The resulting object is callable, so
you can just call it to invoke `function' with the filled-in arguments.

Here’s a small but realistic example:

     import functools

     def log (message, subsystem):
         "Write the contents of 'message' to the specified subsystem."
         print '%s: %s' % (subsystem, message)
         ...

     server_log = functools.partial(log, subsystem='server')
     server_log('Unable to open socket')

Here’s another example, from a program that uses PyGTK. Here a
context-sensitive pop-up menu is being constructed dynamically.  The
callback provided for the menu option is a partially applied version of
the ‘open_item()’ method, where the first argument has been provided.

     ...
     class Application:
         def open_item(self, path):
            ...
         def init (self):
             open_func = functools.partial(self.open_item, item_path)
             popup_menu.append( ("Open", open_func, 1) )

Another function in the *note functools: 85. module is the
‘update_wrapper(wrapper, wrapped)’ function that helps you write
well-behaved decorators.  ‘update_wrapper()’ copies the name, module,
and docstring attribute to a wrapper function so that tracebacks inside
the wrapped function are easier to understand.  For example, you might
write:

     def my_decorator(f):
         def wrapper(*args, **kwds):
             print 'Calling decorated function'
             return f(*args, **kwds)
         functools.update_wrapper(wrapper, f)
         return wrapper

‘wraps()’ is a decorator that can be used inside your own decorators to
copy the wrapped function’s information.  An alternate version of the
previous example would be:

     def my_decorator(f):
         @functools.wraps(f)
         def wrapper(*args, **kwds):
             print 'Calling decorated function'
             return f(*args, **kwds)
         return wrapper

See also
........

PEP 309(1) - Partial Function Application

     PEP proposed and written by Peter Harris; implemented by Hye-Shik
     Chang and Nick Coghlan, with adaptations by Raymond Hettinger.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0309


File: python.info,  Node: PEP 314 Metadata for Python Software Packages v1 1,  Next: PEP 328 Absolute and Relative Imports,  Prev: PEP 309 Partial Function Application,  Up: What’s New in Python 2 5

1.12.3 PEP 314: Metadata for Python Software Packages v1.1
----------------------------------------------------------

Some simple dependency support was added to Distutils.  The ‘setup()’
function now has ‘requires’, ‘provides’, and ‘obsoletes’ keyword
parameters.  When you build a source distribution using the ‘sdist’
command, the dependency information will be recorded in the ‘PKG-INFO’
file.

Another new keyword parameter is ‘download_url’, which should be set to
a URL for the package’s source code.  This means it’s now possible to
look up an entry in the package index, determine the dependencies for a
package, and download the required packages.

     VERSION = '1.0'
     setup(name='PyPackage',
           version=VERSION,
           requires=['numarray', 'zlib (>=1.1.4)'],
           obsoletes=['OldPackage']
           download_url=('http://www.example.com/pypackage/dist/pkg-%s.tar.gz'
                         % VERSION),
          )

Another new enhancement to the Python package index at
‘https://pypi.org’ is storing source and binary archives for a package.
The new ‘upload’ Distutils command will upload a package to the
repository.

Before a package can be uploaded, you must be able to build a
distribution using the ‘sdist’ Distutils command.  Once that works, you
can run ‘python setup.py upload’ to add your package to the PyPI
archive.  Optionally you can GPG-sign the package by supplying the
‘--sign’ and ‘--identity’ options.

Package uploading was implemented by Martin von Löwis and Richard Jones.

See also
........

PEP 314(1) - Metadata for Python Software Packages v1.1

     PEP proposed and written by A.M. Kuchling, Richard Jones, and Fred
     Drake; implemented by Richard Jones and Fred Drake.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0314


File: python.info,  Node: PEP 328 Absolute and Relative Imports,  Next: PEP 338 Executing Modules as Scripts,  Prev: PEP 314 Metadata for Python Software Packages v1 1,  Up: What’s New in Python 2 5

1.12.4 PEP 328: Absolute and Relative Imports
---------------------------------------------

The simpler part of PEP 328(1) was implemented in Python 2.4:
parentheses could now be used to enclose the names imported from a
module using the ‘from ... import ...’ statement, making it easier to
import many different names.

The more complicated part has been implemented in Python 2.5: importing
a module can be specified to use absolute or package-relative imports.
The plan is to move toward making absolute imports the default in future
versions of Python.

Let’s say you have a package directory like this:

     pkg/
     pkg/__init__.py
     pkg/main.py
     pkg/string.py

This defines a package named ‘pkg’ containing the ‘pkg.main’ and
‘pkg.string’ submodules.

Consider the code in the ‘main.py’ module.  What happens if it executes
the statement ‘import string’?  In Python 2.4 and earlier, it will first
look in the package’s directory to perform a relative import, finds
‘pkg/string.py’, imports the contents of that file as the ‘pkg.string’
module, and that module is bound to the name ‘string’ in the ‘pkg.main’
module’s namespace.

That’s fine if ‘pkg.string’ was what you wanted.  But what if you wanted
Python’s standard *note string: f6. module?  There’s no clean way to
ignore ‘pkg.string’ and look for the standard module; generally you had
to look at the contents of ‘sys.modules’, which is slightly unclean.
Holger Krekel’s ‘py.std’ package provides a tidier way to perform
imports from the standard library, ‘import py; py.std.string.join()’,
but that package isn’t available on all Python installations.

Reading code which relies on relative imports is also less clear,
because a reader may be confused about which module, *note string: f6.
or ‘pkg.string’, is intended to be used.  Python users soon learned not
to duplicate the names of standard library modules in the names of their
packages’ submodules, but you can’t protect against having your
submodule’s name being used for a new module added in a future version
of Python.

In Python 2.5, you can switch *note import: c10.’s behaviour to absolute
imports using a ‘from __future__ import absolute_import’ directive.
This absolute-import behaviour will become the default in a future
version (probably Python 2.7).  Once absolute imports are the default,
‘import string’ will always find the standard library’s version.  It’s
suggested that users should begin using absolute imports as much as
possible, so it’s preferable to begin writing ‘from pkg import string’
in your code.

Relative imports are still possible by adding a leading period to the
module name when using the ‘from ... import’ form:

     # Import names from pkg.string
     from .string import name1, name2
     # Import pkg.string
     from . import string

This imports the *note string: f6. module relative to the current
package, so in ‘pkg.main’ this will import `name1' and `name2' from
‘pkg.string’.  Additional leading periods perform the relative import
starting from the parent of the current package.  For example, code in
the ‘A.B.C’ module can do:

     from . import D                 # Imports A.B.D
     from .. import E                # Imports A.E
     from ..F import G               # Imports A.F.G

Leading periods cannot be used with the ‘import modname’ form of the
import statement, only the ‘from ... import’ form.

See also
........

PEP 328(2) - Imports: Multi-Line and Absolute/Relative

     PEP written by Aahz; implemented by Thomas Wouters.

‘https://pylib.readthedocs.io/’

     The py library by Holger Krekel, which contains the ‘py.std’
     package.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0328

   (2) https://www.python.org/dev/peps/pep-0328


File: python.info,  Node: PEP 338 Executing Modules as Scripts,  Next: PEP 341 Unified try/except/finally,  Prev: PEP 328 Absolute and Relative Imports,  Up: What’s New in Python 2 5

1.12.5 PEP 338: Executing Modules as Scripts
--------------------------------------------

The *note -m: 32c. switch added in Python 2.4 to execute a module as a
script gained a few more abilities.  Instead of being implemented in C
code inside the Python interpreter, the switch now uses an
implementation in a new module, *note runpy: e2.

The *note runpy: e2. module implements a more sophisticated import
mechanism so that it’s now possible to run modules in a package such as
‘pychecker.checker’.  The module also supports alternative import
mechanisms such as the *note zipimport: 143. module.  This means you can
add a .zip archive’s path to ‘sys.path’ and then use the *note -m: 32c.
switch to execute code from the archive.

See also
........

PEP 338(1) - Executing modules as scripts

     PEP written and implemented by Nick Coghlan.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0338


File: python.info,  Node: PEP 341 Unified try/except/finally,  Next: PEP 342 New Generator Features,  Prev: PEP 338 Executing Modules as Scripts,  Up: What’s New in Python 2 5

1.12.6 PEP 341: Unified try/except/finally
------------------------------------------

Until Python 2.5, the *note try: d65. statement came in two flavours.
You could use a *note finally: 182. block to ensure that code is always
executed, or one or more *note except: b31. blocks to catch specific
exceptions.  You couldn’t combine both ‘except’ blocks and a ‘finally’
block, because generating the right bytecode for the combined version
was complicated and it wasn’t clear what the semantics of the combined
statement should be.

Guido van Rossum spent some time working with Java, which does support
the equivalent of combining *note except: b31. blocks and a *note
finally: 182. block, and this clarified what the statement should mean.
In Python 2.5, you can now write:

     try:
         block-1 ...
     except Exception1:
         handler-1 ...
     except Exception2:
         handler-2 ...
     else:
         else-block
     finally:
         final-block

The code in `block-1' is executed.  If the code raises an exception, the
various *note except: b31. blocks are tested: if the exception is of
class ‘Exception1’, `handler-1' is executed; otherwise if it’s of class
‘Exception2’, `handler-2' is executed, and so forth.  If no exception is
raised, the `else-block' is executed.

No matter what happened previously, the `final-block' is executed once
the code block is complete and any raised exceptions handled.  Even if
there’s an error in an exception handler or the `else-block' and a new
exception is raised, the code in the `final-block' is still run.

See also
........

PEP 341(1) - Unifying try-except and try-finally

     PEP written by Georg Brandl; implementation by Thomas Lee.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0341


File: python.info,  Node: PEP 342 New Generator Features,  Next: PEP 343 The ‘with’ statement<2>,  Prev: PEP 341 Unified try/except/finally,  Up: What’s New in Python 2 5

1.12.7 PEP 342: New Generator Features
--------------------------------------

Python 2.5 adds a simple way to pass values `into' a generator.  As
introduced in Python 2.3, generators only produce output; once a
generator’s code was invoked to create an iterator, there was no way to
pass any new information into the function when its execution is
resumed.  Sometimes the ability to pass in some information would be
useful.  Hackish solutions to this include making the generator’s code
look at a global variable and then changing the global variable’s value,
or passing in some mutable object that callers then modify.

To refresh your memory of basic generators, here’s a simple example:

     def counter (maximum):
         i = 0
         while i < maximum:
             yield i
             i += 1

When you call ‘counter(10)’, the result is an iterator that returns the
values from 0 up to 9.  On encountering the *note yield: 18f. statement,
the iterator returns the provided value and suspends the function’s
execution, preserving the local variables.  Execution resumes on the
following call to the iterator’s *note next(): 676. method, picking up
after the ‘yield’ statement.

In Python 2.3, *note yield: 18f. was a statement; it didn’t return any
value.  In 2.5, ‘yield’ is now an expression, returning a value that can
be assigned to a variable or otherwise operated on:

     val = (yield i)

I recommend that you always put parentheses around a *note yield: 18f.
expression when you’re doing something with the returned value, as in
the above example.  The parentheses aren’t always necessary, but it’s
easier to always add them instead of having to remember when they’re
needed.

( PEP 342(1) explains the exact rules, which are that a *note yield:
18f.-expression must always be parenthesized except when it occurs at
the top-level expression on the right-hand side of an assignment.  This
means you can write ‘val = yield i’ but have to use parentheses when
there’s an operation, as in ‘val = (yield i) + 12’.)

Values are sent into a generator by calling its ‘send(value)’ method.
The generator’s code is then resumed and the *note yield: 18f.
expression returns the specified `value'.  If the regular *note next():
676. method is called, the ‘yield’ returns *note None: 157.

Here’s the previous example, modified to allow changing the value of the
internal counter.

     def counter (maximum):
         i = 0
         while i < maximum:
             val = (yield i)
             # If value provided, change counter
             if val is not None:
                 i = val
             else:
                 i += 1

And here’s an example of changing the counter:

     >>> it = counter(10)
     >>> print it.next()
     0
     >>> print it.next()
     1
     >>> print it.send(8)
     8
     >>> print it.next()
     9
     >>> print it.next()
     Traceback (most recent call last):
       File "t.py", line 15, in ?
         print it.next()
     StopIteration

*note yield: 18f. will usually return *note None: 157, so you should
always check for this case.  Don’t just use its value in expressions
unless you’re sure that the ‘send()’ method will be the only method used
to resume your generator function.

In addition to ‘send()’, there are two other new methods on generators:

   * ‘throw(type, value=None, traceback=None)’ is used to raise an
     exception inside the generator; the exception is raised by the
     *note yield: 18f. expression where the generator’s execution is
     paused.

   * ‘close()’ raises a new *note GeneratorExit: d25. exception inside
     the generator to terminate the iteration.  On receiving this
     exception, the generator’s code must either raise *note
     GeneratorExit: d25. or *note StopIteration: 47b.  Catching the
     *note GeneratorExit: d25. exception and returning a value is
     illegal and will trigger a *note RuntimeError: 2b8.; if the
     function raises some other exception, that exception is propagated
     to the caller.  ‘close()’ will also be called by Python’s garbage
     collector when the generator is garbage-collected.

     If you need to run cleanup code when a *note GeneratorExit: d25.
     occurs, I suggest using a ‘try: ... finally:’ suite instead of
     catching *note GeneratorExit: d25.

The cumulative effect of these changes is to turn generators from
one-way producers of information into both producers and consumers.

Generators also become `coroutines', a more generalized form of
subroutines.  Subroutines are entered at one point and exited at another
point (the top of the function, and a *note return: 190. statement), but
coroutines can be entered, exited, and resumed at many different points
(the *note yield: 18f. statements).  We’ll have to figure out patterns
for using coroutines effectively in Python.

The addition of the ‘close()’ method has one side effect that isn’t
obvious.  ‘close()’ is called when a generator is garbage-collected, so
this means the generator’s code gets one last chance to run before the
generator is destroyed.  This last chance means that ‘try...finally’
statements in generators can now be guaranteed to work; the *note
finally: 182. clause will now always get a chance to run.  The syntactic
restriction that you couldn’t mix *note yield: 18f. statements with a
‘try...finally’ suite has therefore been removed.  This seems like a
minor bit of language trivia, but using generators and ‘try...finally’
is actually necessary in order to implement the *note with: 6dd.
statement described by PEP 343(2).  I’ll look at this new statement in
the following section.

Another even more esoteric effect of this change: previously, the
‘gi_frame’ attribute of a generator was always a frame object.  It’s now
possible for ‘gi_frame’ to be ‘None’ once the generator has been
exhausted.

See also
........

PEP 342(3) - Coroutines via Enhanced Generators

     PEP written by Guido van Rossum and Phillip J. Eby; implemented by
     Phillip J. Eby.  Includes examples of some fancier uses of
     generators as coroutines.

     Earlier versions of these features were proposed in PEP 288(4) by
     Raymond Hettinger and PEP 325(5) by Samuele Pedroni.

‘https://en.wikipedia.org/wiki/Coroutine’

     The Wikipedia entry for coroutines.

‘http://www.sidhe.org/~dan/blog/archives/000178.html’

     An explanation of coroutines from a Perl point of view, written by
     Dan Sugalski.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0342

   (2) https://www.python.org/dev/peps/pep-0343

   (3) https://www.python.org/dev/peps/pep-0342

   (4) https://www.python.org/dev/peps/pep-0288

   (5) https://www.python.org/dev/peps/pep-0325


File: python.info,  Node: PEP 343 The ‘with’ statement<2>,  Next: PEP 352 Exceptions as New-Style Classes,  Prev: PEP 342 New Generator Features,  Up: What’s New in Python 2 5

1.12.8 PEP 343: The ‘with’ statement
------------------------------------

The ‘*note with: 6dd.’ statement clarifies code that previously would
use ‘try...finally’ blocks to ensure that clean-up code is executed.  In
this section, I’ll discuss the statement as it will commonly be used.
In the next section, I’ll examine the implementation details and show
how to write objects for use with this statement.

The ‘*note with: 6dd.’ statement is a new control-flow structure whose
basic structure is:

     with expression [as variable]:
         with-block

The expression is evaluated, and it should result in an object that
supports the context management protocol (that is, has *note
__enter__(): c88. and *note __exit__(): c89. methods.

The object’s *note __enter__(): c88. is called before `with-block' is
executed and therefore can run set-up code.  It also may return a value
that is bound to the name `variable', if given.  (Note carefully that
`variable' is `not' assigned the result of `expression'.)

After execution of the `with-block' is finished, the object’s *note
__exit__(): c89. method is called, even if the block raised an
exception, and can therefore run clean-up code.

To enable the statement in Python 2.5, you need to add the following
directive to your module:

     from __future__ import with_statement

The statement will always be enabled in Python 2.6.

Some standard Python objects now support the context management protocol
and can be used with the ‘*note with: 6dd.’ statement.  File objects are
one example:

     with open('/etc/passwd', 'r') as f:
         for line in f:
             print line
             ... more processing code ...

After this statement has executed, the file object in `f' will have been
automatically closed, even if the *note for: c23. loop raised an
exception part-way through the block.

     Note: In this case, `f' is the same object created by *note open():
     4e5, because ‘file.__enter__()’ returns `self'.

The *note threading: 109. module’s locks and condition variables also
support the ‘*note with: 6dd.’ statement:

     lock = threading.Lock()
     with lock:
         # Critical section of code
         ...

The lock is acquired before the block is executed and always released
once the block is complete.

The new ‘localcontext()’ function in the *note decimal: 36. module makes
it easy to save and restore the current decimal context, which
encapsulates the desired precision and rounding characteristics for
computations:

     from decimal import Decimal, Context, localcontext

     # Displays with default precision of 28 digits
     v = Decimal('578')
     print v.sqrt()

     with localcontext(Context(prec=16)):
         # All code in this block uses a precision of 16 digits.
         # The original context is restored on exiting the block.
         print v.sqrt()

* Menu:

* Writing Context Managers: Writing Context Managers<2>.
* The contextlib module: The contextlib module<2>.


File: python.info,  Node: Writing Context Managers<2>,  Next: The contextlib module<2>,  Up: PEP 343 The ‘with’ statement<2>

1.12.8.1 Writing Context Managers
.................................

Under the hood, the ‘*note with: 6dd.’ statement is fairly complicated.
Most people will only use ‘‘with’’ in company with existing objects and
don’t need to know these details, so you can skip the rest of this
section if you like.  Authors of new objects will need to understand the
details of the underlying implementation and should keep reading.

A high-level explanation of the context management protocol is:

   * The expression is evaluated and should result in an object called a
     “context manager”.  The context manager must have *note
     __enter__(): c88. and *note __exit__(): c89. methods.

   * The context manager’s *note __enter__(): c88. method is called.
     The value returned is assigned to `VAR'. If no ‘'as VAR'’ clause is
     present, the value is simply discarded.

   * The code in `BLOCK' is executed.

   * If `BLOCK' raises an exception, the ‘__exit__(type, value,
     traceback)’ is called with the exception details, the same values
     returned by *note sys.exc_info(): c52.  The method’s return value
     controls whether the exception is re-raised: any false value
     re-raises the exception, and ‘True’ will result in suppressing it.
     You’ll only rarely want to suppress the exception, because if you
     do the author of the code containing the ‘*note with: 6dd.’
     statement will never realize anything went wrong.

   * If `BLOCK' didn’t raise an exception, the *note __exit__(): c89.
     method is still called, but `type', `value', and `traceback' are
     all ‘None’.

Let’s think through an example.  I won’t present detailed code but will
only sketch the methods necessary for a database that supports
transactions.

(For people unfamiliar with database terminology: a set of changes to
the database are grouped into a transaction.  Transactions can be either
committed, meaning that all the changes are written into the database,
or rolled back, meaning that the changes are all discarded and the
database is unchanged.  See any database textbook for more information.)

Let’s assume there’s an object representing a database connection.  Our
goal will be to let the user write code like this:

     db_connection = DatabaseConnection()
     with db_connection as cursor:
         cursor.execute('insert into ...')
         cursor.execute('delete from ...')
         # ... more operations ...

The transaction should be committed if the code in the block runs
flawlessly or rolled back if there’s an exception.  Here’s the basic
interface for ‘DatabaseConnection’ that I’ll assume:

     class DatabaseConnection:
         # Database interface
         def cursor (self):
             "Returns a cursor object and starts a new transaction"
         def commit (self):
             "Commits current transaction"
         def rollback (self):
             "Rolls back current transaction"

The *note __enter__(): c88. method is pretty easy, having only to start
a new transaction.  For this application the resulting cursor object
would be a useful result, so the method will return it.  The user can
then add ‘as cursor’ to their ‘*note with: 6dd.’ statement to bind the
cursor to a variable name.

     class DatabaseConnection:
         ...
         def __enter__ (self):
             # Code to start a new transaction
             cursor = self.cursor()
             return cursor

The *note __exit__(): c89. method is the most complicated because it’s
where most of the work has to be done.  The method has to check if an
exception occurred.  If there was no exception, the transaction is
committed.  The transaction is rolled back if there was an exception.

In the code below, execution will just fall off the end of the function,
returning the default value of ‘None’.  ‘None’ is false, so the
exception will be re-raised automatically.  If you wished, you could be
more explicit and add a *note return: 190. statement at the marked
location.

     class DatabaseConnection:
         ...
         def __exit__ (self, type, value, tb):
             if tb is None:
                 # No exception, so commit
                 self.commit()
             else:
                 # Exception occurred, so rollback.
                 self.rollback()
                 # return False


File: python.info,  Node: The contextlib module<2>,  Prev: Writing Context Managers<2>,  Up: PEP 343 The ‘with’ statement<2>

1.12.8.2 The contextlib module
..............................

The new *note contextlib: 24. module provides some functions and a
decorator that are useful for writing objects for use with the ‘*note
with: 6dd.’ statement.

The decorator is called ‘contextmanager()’, and lets you write a single
generator function instead of defining a new class.  The generator
should yield exactly one value.  The code up to the *note yield: 18f.
will be executed as the *note __enter__(): c88. method, and the value
yielded will be the method’s return value that will get bound to the
variable in the ‘*note with: 6dd.’ statement’s ‘as’ clause, if any.  The
code after the *note yield: 18f. will be executed in the *note
__exit__(): c89. method.  Any exception raised in the block will be
raised by the ‘yield’ statement.

Our database example from the previous section could be written using
this decorator as:

     from contextlib import contextmanager

     @contextmanager
     def db_transaction (connection):
         cursor = connection.cursor()
         try:
             yield cursor
         except:
             connection.rollback()
             raise
         else:
             connection.commit()

     db = DatabaseConnection()
     with db_transaction(db) as cursor:
         ...

The *note contextlib: 24. module also has a ‘nested(mgr1, mgr2, ...)’
function that combines a number of context managers so you don’t need to
write nested ‘*note with: 6dd.’ statements.  In this example, the single
‘‘with’’ statement both starts a database transaction and acquires a
thread lock:

     lock = threading.Lock()
     with nested (db_transaction(db), lock) as (cursor, locked):
         ...

Finally, the ‘closing(object)’ function returns `object' so that it can
be bound to a variable, and calls ‘object.close’ at the end of the
block.

     import urllib, sys
     from contextlib import closing

     with closing(urllib.urlopen('http://www.yahoo.com')) as f:
         for line in f:
             sys.stdout.write(line)

See also
........

PEP 343(1) - The “with” statement

     PEP written by Guido van Rossum and Nick Coghlan; implemented by
     Mike Bland, Guido van Rossum, and Neal Norwitz.  The PEP shows the
     code generated for a ‘*note with: 6dd.’ statement, which can be
     helpful in learning how the statement works.

The documentation for the *note contextlib: 24. module.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0343


File: python.info,  Node: PEP 352 Exceptions as New-Style Classes,  Next: PEP 353 Using ssize_t as the index type,  Prev: PEP 343 The ‘with’ statement<2>,  Up: What’s New in Python 2 5

1.12.9 PEP 352: Exceptions as New-Style Classes
-----------------------------------------------

Exception classes can now be new-style classes, not just classic
classes, and the built-in *note Exception: 1a8. class and all the
standard built-in exceptions (*note NameError: d6e, *note ValueError:
1f9, etc.)  are now new-style classes.

The inheritance hierarchy for exceptions has been rearranged a bit.  In
2.5, the inheritance relationships are:

     BaseException       # New in Python 2.5
     |- KeyboardInterrupt
     |- SystemExit
     |- Exception
        |- (all other current built-in exceptions)

This rearrangement was done because people often want to catch all
exceptions that indicate program errors.  *note KeyboardInterrupt: 197.
and *note SystemExit: 5f1. aren’t errors, though, and usually represent
an explicit action such as the user hitting ‘Control-C’ or code calling
*note sys.exit(): cd5.  A bare ‘except:’ will catch all exceptions, so
you commonly need to list *note KeyboardInterrupt: 197. and *note
SystemExit: 5f1. in order to re-raise them.  The usual pattern is:

     try:
         ...
     except (KeyboardInterrupt, SystemExit):
         raise
     except:
         # Log error...
         # Continue running program...

In Python 2.5, you can now write ‘except Exception’ to achieve the same
result, catching all the exceptions that usually indicate errors but
leaving *note KeyboardInterrupt: 197. and *note SystemExit: 5f1. alone.
As in previous versions, a bare ‘except:’ still catches all exceptions.

The goal for Python 3.0 is to require any class raised as an exception
to derive from *note BaseException: 1a7. or some descendant of *note
BaseException: 1a7, and future releases in the Python 2.x series may
begin to enforce this constraint.  Therefore, I suggest you begin making
all your exception classes derive from *note Exception: 1a8. now.  It’s
been suggested that the bare ‘except:’ form should be removed in Python
3.0, but Guido van Rossum hasn’t decided whether to do this or not.

Raising of strings as exceptions, as in the statement ‘raise "Error
occurred"’, is deprecated in Python 2.5 and will trigger a warning.  The
aim is to be able to remove the string-exception feature in a few
releases.

See also
........

PEP 352(1) - Required Superclass for Exceptions

     PEP written by Brett Cannon and Guido van Rossum; implemented by
     Brett Cannon.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0352


File: python.info,  Node: PEP 353 Using ssize_t as the index type,  Next: PEP 357 The ‘__index__’ method,  Prev: PEP 352 Exceptions as New-Style Classes,  Up: What’s New in Python 2 5

1.12.10 PEP 353: Using ssize_t as the index type
------------------------------------------------

A wide-ranging change to Python’s C API, using a new ‘Py_ssize_t’ type
definition instead of ‘int’, will permit the interpreter to handle more
data on 64-bit platforms.  This change doesn’t affect Python’s capacity
on 32-bit platforms.

Various pieces of the Python interpreter used C’s ‘int’ type to store
sizes or counts; for example, the number of items in a list or tuple
were stored in an ‘int’.  The C compilers for most 64-bit platforms
still define ‘int’ as a 32-bit type, so that meant that lists could only
hold up to ‘2**31 - 1’ = 2147483647 items.  (There are actually a few
different programming models that 64-bit C compilers can use – see
‘http://www.unix.org/version2/whatsnew/lp64_wp.html’ for a discussion –
but the most commonly available model leaves ‘int’ as 32 bits.)

A limit of 2147483647 items doesn’t really matter on a 32-bit platform
because you’ll run out of memory before hitting the length limit.  Each
list item requires space for a pointer, which is 4 bytes, plus space for
a *note PyObject: 4b0. representing the item.  2147483647*4 is already
more bytes than a 32-bit address space can contain.

It’s possible to address that much memory on a 64-bit platform, however.
The pointers for a list that size would only require 16 GiB of space, so
it’s not unreasonable that Python programmers might construct lists that
large.  Therefore, the Python interpreter had to be changed to use some
type other than ‘int’, and this will be a 64-bit type on 64-bit
platforms.  The change will cause incompatibilities on 64-bit machines,
so it was deemed worth making the transition now, while the number of
64-bit users is still relatively small.  (In 5 or 10 years, we may `all'
be on 64-bit machines, and the transition would be more painful then.)

This change most strongly affects authors of C extension modules.
Python strings and container types such as lists and tuples now use
‘Py_ssize_t’ to store their size.  Functions such as *note
PyList_Size(): d71. now return ‘Py_ssize_t’.  Code in extension modules
may therefore need to have some variables changed to ‘Py_ssize_t’.

The *note PyArg_ParseTuple(): 268. and *note Py_BuildValue(): 2cc.
functions have a new conversion code, ‘n’, for ‘Py_ssize_t’.  *note
PyArg_ParseTuple(): 268.’s ‘s#’ and ‘t#’ still output ‘int’ by default,
but you can define the macro ‘PY_SSIZE_T_CLEAN’ before including
‘Python.h’ to make them return ‘Py_ssize_t’.

PEP 353(1) has a section on conversion guidelines that extension authors
should read to learn about supporting 64-bit platforms.

See also
........

PEP 353(2) - Using ssize_t as the index type

     PEP written and implemented by Martin von Löwis.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0353

   (2) https://www.python.org/dev/peps/pep-0353


File: python.info,  Node: PEP 357 The ‘__index__’ method,  Next: Other Language Changes<11>,  Prev: PEP 353 Using ssize_t as the index type,  Up: What’s New in Python 2 5

1.12.11 PEP 357: The ‘__index__’ method
---------------------------------------

The NumPy developers had a problem that could only be solved by adding a
new special method, *note __index__(): 18a.  When using slice notation,
as in ‘[start:stop:step]’, the values of the `start', `stop', and `step'
indexes must all be either integers or long integers.  NumPy defines a
variety of specialized integer types corresponding to unsigned and
signed integers of 8, 16, 32, and 64 bits, but there was no way to
signal that these types could be used as slice indexes.

Slicing can’t just use the existing *note __int__(): 18b. method because
that method is also used to implement coercion to integers.  If slicing
used *note __int__(): 18b, floating-point numbers would also become
legal slice indexes and that’s clearly an undesirable behaviour.

Instead, a new special method called *note __index__(): 18a. was added.
It takes no arguments and returns an integer giving the slice index to
use.  For example:

     class C:
         def __index__ (self):
             return self.value

The return value must be either a Python integer or long integer.  The
interpreter will check that the type returned is correct, and raises a
*note TypeError: 192. if this requirement isn’t met.

A corresponding ‘nb_index’ slot was added to the C-level *note
PyNumberMethods: d74. structure to let C extensions implement this
protocol.  ‘PyNumber_Index(obj)’ can be used in extension code to call
the *note __index__(): 18a. function and retrieve its result.

See also
........

PEP 357(1) - Allowing Any Object to be Used for Slicing

     PEP written and implemented by Travis Oliphant.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0357


File: python.info,  Node: Other Language Changes<11>,  Next: New Improved and Removed Modules,  Prev: PEP 357 The ‘__index__’ method,  Up: What’s New in Python 2 5

1.12.12 Other Language Changes
------------------------------

Here are all of the changes that Python 2.5 makes to the core Python
language.

   * The *note dict: 1b6. type has a new hook for letting subclasses
     provide a default value when a key isn’t contained in the
     dictionary.  When a key isn’t found, the dictionary’s
     ‘__missing__(key)’ method will be called.  This hook is used to
     implement the new ‘defaultdict’ class in the *note collections: 1e.
     module.  The following example defines a dictionary that returns
     zero for any missing key:

          class zerodict (dict):
              def __missing__ (self, key):
                  return 0

          d = zerodict({1:1, 2:2})
          print d[1], d[2]   # Prints 1, 2
          print d[3], d[4]   # Prints 0, 0

   * Both 8-bit and Unicode strings have new ‘partition(sep)’ and
     ‘rpartition(sep)’ methods that simplify a common use case.

     The ‘find(S)’ method is often used to get an index which is then
     used to slice the string and obtain the pieces that are before and
     after the separator.  ‘partition(sep)’ condenses this pattern into
     a single method call that returns a 3-tuple containing the
     substring before the separator, the separator itself, and the
     substring after the separator.  If the separator isn’t found, the
     first element of the tuple is the entire string and the other two
     elements are empty.  ‘rpartition(sep)’ also returns a 3-tuple but
     starts searching from the end of the string; the ‘r’ stands for
     ‘reverse’.

     Some examples:

          >>> ('http://www.python.org').partition('://')
          ('http', '://', 'www.python.org')
          >>> ('file:/usr/share/doc/index.html').partition('://')
          ('file:/usr/share/doc/index.html', '', '')
          >>> (u'Subject: a quick question').partition(':')
          (u'Subject', u':', u' a quick question')
          >>> 'www.python.org'.rpartition('.')
          ('www.python', '.', 'org')
          >>> 'www.python.org'.rpartition(':')
          ('', '', 'www.python.org')

     (Implemented by Fredrik Lundh following a suggestion by Raymond
     Hettinger.)

   * The ‘startswith()’ and ‘endswith()’ methods of string types now
     accept tuples of strings to check for.

          def is_image_file (filename):
              return filename.endswith(('.gif', '.jpg', '.tiff'))

     (Implemented by Georg Brandl following a suggestion by Tom Lynn.)

   * The *note min(): 7fd. and *note max(): 7fe. built-in functions
     gained a ‘key’ keyword parameter analogous to the ‘key’ argument
     for ‘sort()’.  This parameter supplies a function that takes a
     single argument and is called for every value in the list; *note
     min(): 7fd./*note max(): 7fe. will return the element with the
     smallest/largest return value from this function.  For example, to
     find the longest string in a list, you can do:

          L = ['medium', 'longest', 'short']
          # Prints 'longest'
          print max(L, key=len)
          # Prints 'short', because lexicographically 'short' has the largest value
          print max(L)

     (Contributed by Steven Bethard and Raymond Hettinger.)

   * Two new built-in functions, *note any(): d77. and *note all(): d78,
     evaluate whether an iterator contains any true or false values.
     *note any(): d77. returns *note True: 48f. if any value returned by
     the iterator is true; otherwise it will return *note False: 37d.
     *note all(): d78. returns *note True: 48f. only if all of the
     values returned by the iterator evaluate as true.  (Suggested by
     Guido van Rossum, and implemented by Raymond Hettinger.)

   * The result of a class’s *note __hash__(): 335. method can now be
     either a long integer or a regular integer.  If a long integer is
     returned, the hash of that value is taken.  In earlier versions the
     hash value was required to be a regular integer, but in 2.5 the
     *note id(): d79. built-in was changed to always return non-negative
     numbers, and users often seem to use ‘id(self)’ in *note
     __hash__(): 335. methods (though this is discouraged).

   * ASCII is now the default encoding for modules.  It’s now a syntax
     error if a module contains string literals with 8-bit characters
     but doesn’t have an encoding declaration.  In Python 2.4 this
     triggered a warning, not a syntax error.  See PEP 263(1) for how to
     declare a module’s encoding; for example, you might add a line like
     this near the top of the source file:

          # -*- coding: latin1 -*-

   * A new warning, *note UnicodeWarning: d7a, is triggered when you
     attempt to compare a Unicode string and an 8-bit string that can’t
     be converted to Unicode using the default ASCII encoding.  The
     result of the comparison is false:

          >>> chr(128) == unichr(128)   # Can't convert chr(128) to Unicode
          __main__:1: UnicodeWarning: Unicode equal comparison failed
            to convert both arguments to Unicode - interpreting them
            as being unequal
          False
          >>> chr(127) == unichr(127)   # chr(127) can be converted
          True

     Previously this would raise a *note UnicodeDecodeError: 1fb.
     exception, but in 2.5 this could result in puzzling problems when
     accessing a dictionary.  If you looked up ‘unichr(128)’ and
     ‘chr(128)’ was being used as a key, you’d get a *note
     UnicodeDecodeError: 1fb. exception.  Other changes in 2.5 resulted
     in this exception being raised instead of suppressed by the code in
     ‘dictobject.c’ that implements dictionaries.

     Raising an exception for such a comparison is strictly correct, but
     the change might have broken code, so instead *note UnicodeWarning:
     d7a. was introduced.

     (Implemented by Marc-André Lemburg.)

   * One error that Python programmers sometimes make is forgetting to
     include an ‘__init__.py’ module in a package directory.  Debugging
     this mistake can be confusing, and usually requires running Python
     with the *note -v: d7b. switch to log all the paths searched.  In
     Python 2.5, a new *note ImportWarning: 5cd. warning is triggered
     when an import would have picked up a directory as a package but no
     ‘__init__.py’ was found.  This warning is silently ignored by
     default; provide the *note -Wd: 40c. option when running the Python
     executable to display the warning message.  (Implemented by Thomas
     Wouters.)

   * The list of base classes in a class definition can now be empty.
     As an example, this is now legal:

          class C():
              pass

     (Implemented by Brett Cannon.)

* Menu:

* Interactive Interpreter Changes::
* Optimizations: Optimizations<10>.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0263


File: python.info,  Node: Interactive Interpreter Changes,  Next: Optimizations<10>,  Up: Other Language Changes<11>

1.12.12.1 Interactive Interpreter Changes
.........................................

In the interactive interpreter, ‘quit’ and ‘exit’ have long been strings
so that new users get a somewhat helpful message when they try to quit:

     >>> quit
     'Use Ctrl-D (i.e. EOF) to exit.'

In Python 2.5, ‘quit’ and ‘exit’ are now objects that still produce
string representations of themselves, but are also callable.  Newbies
who try ‘quit()’ or ‘exit()’ will now exit the interpreter as they
expect.  (Implemented by Georg Brandl.)

The Python executable now accepts the standard long options *note –help:
d7e. and *note –version: 5c6.; on Windows, it also accepts the *note /?:
d7f. option for displaying a help message.  (Implemented by Georg
Brandl.)


File: python.info,  Node: Optimizations<10>,  Prev: Interactive Interpreter Changes,  Up: Other Language Changes<11>

1.12.12.2 Optimizations
.......................

Several of the optimizations were developed at the NeedForSpeed sprint,
an event held in Reykjavik, Iceland, from May 21–28 2006.  The sprint
focused on speed enhancements to the CPython implementation and was
funded by EWT LLC with local support from CCP Games.  Those
optimizations added at this sprint are specially marked in the following
list.

   * When they were introduced in Python 2.4, the built-in *note set:
     b62. and *note frozenset: be1. types were built on top of Python’s
     dictionary type.  In 2.5 the internal data structure has been
     customized for implementing sets, and as a result sets will use a
     third less memory and are somewhat faster.  (Implemented by Raymond
     Hettinger.)

   * The speed of some Unicode operations, such as finding substrings,
     string splitting, and character map encoding and decoding, has been
     improved.  (Substring search and splitting improvements were added
     by Fredrik Lundh and Andrew Dalke at the NeedForSpeed sprint.
     Character maps were improved by Walter Dörwald and Martin von
     Löwis.)

   * The ‘long(str, base)’ function is now faster on long digit strings
     because fewer intermediate results are calculated.  The peak is for
     strings of around 800–1000 digits where the function is 6 times
     faster.  (Contributed by Alan McIntyre and committed at the
     NeedForSpeed sprint.)

   * It’s now illegal to mix iterating over a file with ‘for line in
     file’ and calling the file object’s ‘read()’/*note readline():
     de./‘readlines()’ methods.  Iteration uses an internal buffer and
     the ‘read*()’ methods don’t use that buffer.  Instead they would
     return the data following the buffer, causing the data to appear
     out of order.  Mixing iteration and these methods will now trigger
     a *note ValueError: 1f9. from the ‘read*()’ method.  (Implemented
     by Thomas Wouters.)

   * The *note struct: f8. module now compiles structure format strings
     into an internal representation and caches this representation,
     yielding a 20% speedup.  (Contributed by Bob Ippolito at the
     NeedForSpeed sprint.)

   * The *note re: dd. module got a 1 or 2% speedup by switching to
     Python’s allocator functions instead of the system’s ‘malloc()’ and
     ‘free()’.  (Contributed by Jack Diederich at the NeedForSpeed
     sprint.)

   * The code generator’s peephole optimizer now performs simple
     constant folding in expressions.  If you write something like ‘a =
     2+3’, the code generator will do the arithmetic and produce code
     corresponding to ‘a = 5’.  (Proposed and implemented by Raymond
     Hettinger.)

   * Function calls are now faster because code objects now keep the
     most recently finished frame (a “zombie frame”) in an internal
     field of the code object, reusing it the next time the code object
     is invoked.  (Original patch by Michael Hudson, modified by Armin
     Rigo and Richard Jones; committed at the NeedForSpeed sprint.)
     Frame objects are also slightly smaller, which may improve cache
     locality and reduce memory usage a bit.  (Contributed by Neal
     Norwitz.)

   * Python’s built-in exceptions are now new-style classes, a change
     that speeds up instantiation considerably.  Exception handling in
     Python 2.5 is therefore about 30% faster than in 2.4.  (Contributed
     by Richard Jones, Georg Brandl and Sean Reifschneider at the
     NeedForSpeed sprint.)

   * Importing now caches the paths tried, recording whether they exist
     or not so that the interpreter makes fewer ‘open()’ and ‘stat()’
     calls on startup.  (Contributed by Martin von Löwis and Georg
     Brandl.)


File: python.info,  Node: New Improved and Removed Modules,  Next: Build and C API Changes<10>,  Prev: Other Language Changes<11>,  Up: What’s New in Python 2 5

1.12.13 New, Improved, and Removed Modules
------------------------------------------

The standard library received many enhancements and bug fixes in Python
2.5.  Here’s a partial list of the most notable changes, sorted
alphabetically by module name.  Consult the ‘Misc/NEWS’ file in the
source tree for a more complete list of changes, or look through the SVN
logs for all the details.

   * The *note audioop: d. module now supports the a-LAW encoding, and
     the code for u-LAW encoding has been improved.  (Contributed by
     Lars Immisch.)

   * The *note codecs: 1c. module gained support for incremental codecs.
     The ‘codec.lookup()’ function now returns a ‘CodecInfo’ instance
     instead of a tuple.  ‘CodecInfo’ instances behave like a 4-tuple to
     preserve backward compatibility but also have the attributes
     ‘encode’, ‘decode’, ‘incrementalencoder’, ‘incrementaldecoder’,
     ‘streamwriter’, and ‘streamreader’.  Incremental codecs can receive
     input and produce output in multiple chunks; the output is the same
     as if the entire input was fed to the non-incremental codec.  See
     the *note codecs: 1c. module documentation for details.  (Designed
     and implemented by Walter Dörwald.)

   * The *note collections: 1e. module gained a new type, ‘defaultdict’,
     that subclasses the standard *note dict: 1b6. type.  The new type
     mostly behaves like a dictionary but constructs a default value
     when a key isn’t present, automatically adding it to the dictionary
     for the requested key value.

     The first argument to ‘defaultdict’’s constructor is a factory
     function that gets called whenever a key is requested but not
     found.  This factory function receives no arguments, so you can use
     built-in type constructors such as *note list(): 260. or *note
     int(): 184.  For example, you can make an index of words based on
     their initial letter like this:

          words = """Nel mezzo del cammin di nostra vita
          mi ritrovai per una selva oscura
          che la diritta via era smarrita""".lower().split()

          index = defaultdict(list)

          for w in words:
              init_letter = w[0]
              index[init_letter].append(w)

     Printing ‘index’ results in the following output:

          defaultdict(<type 'list'>, {'c': ['cammin', 'che'], 'e': ['era'],
                  'd': ['del', 'di', 'diritta'], 'm': ['mezzo', 'mi'],
                  'l': ['la'], 'o': ['oscura'], 'n': ['nel', 'nostra'],
                  'p': ['per'], 's': ['selva', 'smarrita'],
                  'r': ['ritrovai'], 'u': ['una'], 'v': ['vita', 'via']}

     (Contributed by Guido van Rossum.)

   * The ‘deque’ double-ended queue type supplied by the *note
     collections: 1e. module now has a ‘remove(value)’ method that
     removes the first occurrence of `value' in the queue, raising *note
     ValueError: 1f9. if the value isn’t found.  (Contributed by Raymond
     Hettinger.)

   * New module: The *note contextlib: 24. module contains helper
     functions for use with the new ‘*note with: 6dd.’ statement.  See
     section *note The contextlib module: d6a. for more about this
     module.

   * New module: The *note cProfile: 28. module is a C implementation of
     the existing *note profile: d3. module that has much lower
     overhead.  The module’s interface is the same as *note profile:
     d3.: you run ‘cProfile.run('main()')’ to profile a function, can
     save profile data to a file, etc.  It’s not yet known if the
     Hotshot profiler, which is also written in C but doesn’t match the
     *note profile: d3. module’s interface, will continue to be
     maintained in future versions of Python.  (Contributed by Armin
     Rigo.)

     Also, the *note pstats: d4. module for analyzing the data measured
     by the profiler now supports directing the output to any file
     object by supplying a `stream' argument to the ‘Stats’ constructor.
     (Contributed by Skip Montanaro.)

   * The *note csv: 2a. module, which parses files in comma-separated
     value format, received several enhancements and a number of
     bugfixes.  You can now set the maximum size in bytes of a field by
     calling the ‘csv.field_size_limit(new_limit)’ function; omitting
     the `new_limit' argument will return the currently-set limit.  The
     ‘reader’ class now has a ‘line_num’ attribute that counts the
     number of physical lines read from the source; records can span
     multiple physical lines, so ‘line_num’ is not the same as the
     number of records read.

     The CSV parser is now stricter about multi-line quoted fields.
     Previously, if a line ended within a quoted field without a
     terminating newline character, a newline would be inserted into the
     returned field.  This behavior caused problems when reading files
     that contained carriage return characters within fields, so the
     code was changed to return the field without inserting newlines.
     As a consequence, if newlines embedded within fields are important,
     the input should be split into lines in a manner that preserves the
     newline characters.

     (Contributed by Skip Montanaro and Andrew McNamara.)

   * The *note datetime: 194. class in the *note datetime: 31. module
     now has a ‘strptime(string, format)’ method for parsing date
     strings, contributed by Josh Spoerri.  It uses the same format
     characters as *note time.strptime(): d84. and *note
     time.strftime(): b58.:

          from datetime import datetime

          ts = datetime.strptime('10:13:15 2006-03-07',
                                 '%H:%M:%S %Y-%m-%d')

   * The ‘SequenceMatcher.get_matching_blocks()’ method in the *note
     difflib: 37. module now guarantees to return a minimal list of
     blocks describing matching subsequences.  Previously, the algorithm
     would occasionally break a block of matching elements into two list
     entries.  (Enhancement by Tim Peters.)

   * The *note doctest: 67. module gained a ‘SKIP’ option that keeps an
     example from being executed at all.  This is intended for code
     snippets that are usage examples intended for the reader and aren’t
     actually test cases.

     An `encoding' parameter was added to the ‘testfile()’ function and
     the ‘DocFileSuite’ class to specify the file’s encoding.  This
     makes it easier to use non-ASCII characters in tests contained
     within a docstring.  (Contributed by Bjorn Tillenius.)

   * The *note email: 69. package has been updated to version 4.0.
     (Contributed by Barry Warsaw.)

   * The *note fileinput: 80. module was made more flexible.  Unicode
     filenames are now supported, and a `mode' parameter that defaults
     to ‘"r"’ was added to the *note input(): c5e. function to allow
     opening files in binary or *note universal newlines: 5e9. mode.
     Another new parameter, `openhook', lets you use a function other
     than *note open(): 4e5. to open the input files.  Once you’re
     iterating over the set of files, the ‘FileInput’ object’s new
     ‘fileno()’ returns the file descriptor for the currently opened
     file.  (Contributed by Georg Brandl.)

   * In the *note gc: 86. module, the new ‘get_count()’ function returns
     a 3-tuple containing the current collection counts for the three GC
     generations.  This is accounting information for the garbage
     collector; when these counts reach a specified threshold, a garbage
     collection sweep will be made.  The existing *note gc.collect():
     22c. function now takes an optional `generation' argument of 0, 1,
     or 2 to specify which generation to collect.  (Contributed by Barry
     Warsaw.)

   * The ‘nsmallest()’ and ‘nlargest()’ functions in the *note heapq:
     8e. module now support a ‘key’ keyword parameter similar to the one
     provided by the *note min(): 7fd./*note max(): 7fe. functions and
     the ‘sort()’ methods.  For example:

          >>> import heapq
          >>> L = ["short", 'medium', 'longest', 'longer still']
          >>> heapq.nsmallest(2, L)  # Return two lowest elements, lexicographically
          ['longer still', 'longest']
          >>> heapq.nsmallest(2, L, key=len)   # Return two shortest elements
          ['short', 'medium']

     (Contributed by Raymond Hettinger.)

   * The *note itertools.islice(): 397. function now accepts ‘None’ for
     the start and step arguments.  This makes it more compatible with
     the attributes of slice objects, so that you can now write the
     following:

          s = slice(5)     # Create slice object
          itertools.islice(iterable, s.start, s.stop, s.step)

     (Contributed by Raymond Hettinger.)

   * The *note format(): 4d0. function in the *note locale: a9. module
     has been modified and two new functions were added,
     ‘format_string()’ and ‘currency()’.

     The *note format(): 4d0. function’s `val' parameter could
     previously be a string as long as no more than one %char specifier
     appeared; now the parameter must be exactly one %char specifier
     with no surrounding text.  An optional `monetary' parameter was
     also added which, if ‘True’, will use the locale’s rules for
     formatting currency in placing a separator between groups of three
     digits.

     To format strings with multiple %char specifiers, use the new
     ‘format_string()’ function that works like *note format(): 4d0. but
     also supports mixing %char specifiers with arbitrary text.

     A new ‘currency()’ function was also added that formats a number
     according to the current locale’s settings.

     (Contributed by Georg Brandl.)

   * The *note mailbox: ae. module underwent a massive rewrite to add
     the capability to modify mailboxes in addition to reading them.  A
     new set of classes that include ‘mbox’, ‘MH’, and ‘Maildir’ are
     used to read mailboxes, and have an ‘add(message)’ method to add
     messages, ‘remove(key)’ to remove messages, and ‘lock()’/‘unlock()’
     to lock/unlock the mailbox.  The following example converts a
     maildir-format mailbox into an mbox-format one:

          import mailbox

          # 'factory=None' uses email.Message.Message as the class representing
          # individual messages.
          src = mailbox.Maildir('maildir', factory=None)
          dest = mailbox.mbox('/tmp/mbox')

          for msg in src:
              dest.add(msg)

     (Contributed by Gregory K. Johnson.  Funding was provided by
     Google’s 2005 Summer of Code.)

   * New module: the *note msilib: b5. module allows creating Microsoft
     Installer ‘.msi’ files and CAB files.  Some support for reading the
     ‘.msi’ database is also included.  (Contributed by Martin von
     Löwis.)

   * The *note nis: bf. module now supports accessing domains other than
     the system default domain by supplying a `domain' argument to the
     *note nis.match(): d85. and *note nis.maps(): d86. functions.
     (Contributed by Ben Bell.)

   * The *note operator: c2. module’s ‘itemgetter()’ and ‘attrgetter()’
     functions now support multiple fields.  A call such as
     ‘operator.attrgetter('a', 'b')’ will return a function that
     retrieves the ‘a’ and ‘b’ attributes.  Combining this new feature
     with the ‘sort()’ method’s ‘key’ parameter lets you easily sort
     lists using multiple fields.  (Contributed by Raymond Hettinger.)

   * The *note optparse: c3. module was updated to version 1.5.1 of the
     Optik library.  The ‘OptionParser’ class gained an ‘epilog’
     attribute, a string that will be printed after the help message,
     and a ‘destroy()’ method to break reference cycles created by the
     object.  (Contributed by Greg Ward.)

   * The *note os: c4. module underwent several changes.  The
     ‘stat_float_times’ variable now defaults to true, meaning that
     *note os.stat(): 1ef. will now return time values as floats.  (This
     doesn’t necessarily mean that *note os.stat(): 1ef. will return
     times that are precise to fractions of a second; not all systems
     support such precision.)

     Constants named *note os.SEEK_SET: d87, *note os.SEEK_CUR: d88, and
     *note os.SEEK_END: d89. have been added; these are the parameters
     to the *note os.lseek(): a53. function.  Two new constants for
     locking are *note os.O_SHLOCK: d8a. and *note os.O_EXLOCK: d8b.

     Two new functions, ‘wait3()’ and ‘wait4()’, were added.  They’re
     similar the ‘waitpid()’ function which waits for a child process to
     exit and returns a tuple of the process ID and its exit status, but
     ‘wait3()’ and ‘wait4()’ return additional information.  ‘wait3()’
     doesn’t take a process ID as input, so it waits for any child
     process to exit and returns a 3-tuple of `process-id',
     `exit-status', `resource-usage' as returned from the *note
     resource.getrusage(): d8c. function.  ‘wait4(pid)’ does take a
     process ID. (Contributed by Chad J. Schroeder.)

     On FreeBSD, the *note os.stat(): 1ef. function now returns times
     with nanosecond resolution, and the returned object now has
     ‘st_gen’ and ‘st_birthtime’.  The ‘st_flags’ attribute is also
     available, if the platform supports it.  (Contributed by Antti
     Louko and Diego Pettenò.)

   * The Python debugger provided by the *note pdb: c9. module can now
     store lists of commands to execute when a breakpoint is reached and
     execution stops.  Once breakpoint #1 has been created, enter
     ‘commands 1’ and enter a series of commands to be executed,
     finishing the list with ‘end’.  The command list can include
     commands that resume execution, such as ‘continue’ or ‘next’.
     (Contributed by Grégoire Dooms.)

   * The *note pickle: ca. and ‘cPickle’ modules no longer accept a
     return value of ‘None’ from the *note __reduce__(): 19a. method;
     the method must return a tuple of arguments instead.  The ability
     to return ‘None’ was deprecated in Python 2.4, so this completes
     the removal of the feature.

   * The *note pkgutil: cd. module, containing various utility functions
     for finding packages, was enhanced to support PEP 302(1)’s import
     hooks and now also works for packages stored in ZIP-format
     archives.  (Contributed by Phillip J. Eby.)

   * The pybench benchmark suite by Marc-André Lemburg is now included
     in the ‘Tools/pybench’ directory.  The pybench suite is an
     improvement on the commonly used ‘pystone.py’ program because
     pybench provides a more detailed measurement of the interpreter’s
     speed.  It times particular operations such as function calls,
     tuple slicing, method lookups, and numeric operations, instead of
     performing many different operations and reducing the result to a
     single number as ‘pystone.py’ does.

   * The ‘pyexpat’ module now uses version 2.0 of the Expat parser.
     (Contributed by Trent Mick.)

   * The *note Queue: d0b. class provided by the ‘Queue’ module gained
     two new methods.  ‘join()’ blocks until all items in the queue have
     been retrieved and all processing work on the items have been
     completed.  Worker threads call the other new method,
     ‘task_done()’, to signal that processing for an item has been
     completed.  (Contributed by Raymond Hettinger.)

   * The old ‘regex’ and ‘regsub’ modules, which have been deprecated
     ever since Python 2.0, have finally been deleted.  Other deleted
     modules: ‘statcache’, ‘tzparse’, ‘whrandom’.

   * Also deleted: the ‘lib-old’ directory, which includes ancient
     modules such as ‘dircmp’ and ‘ni’, was removed.  ‘lib-old’ wasn’t
     on the default ‘sys.path’, so unless your programs explicitly added
     the directory to ‘sys.path’, this removal shouldn’t affect your
     code.

   * The *note rlcompleter: e1. module is no longer dependent on
     importing the *note readline: de. module and therefore now works on
     non-Unix platforms.  (Patch from Robert Kiendl.)

   * The ‘SimpleXMLRPCServer’ and ‘DocXMLRPCServer’ classes now have a
     ‘rpc_paths’ attribute that constrains XML-RPC operations to a
     limited set of URL paths; the default is to allow only ‘'/'’ and
     ‘'/RPC2'’.  Setting ‘rpc_paths’ to ‘None’ or an empty tuple
     disables this path checking.

   * The *note socket: ef. module now supports ‘AF_NETLINK’ sockets on
     Linux, thanks to a patch from Philippe Biondi.  Netlink sockets are
     a Linux-specific mechanism for communications between a user-space
     process and kernel code; an introductory article about them is at
     ‘https://www.linuxjournal.com/article/7356’.  In Python code,
     netlink addresses are represented as a tuple of 2 integers, ‘(pid,
     group_mask)’.

     Two new methods on socket objects, ‘recv_into(buffer)’ and
     ‘recvfrom_into(buffer)’, store the received data in an object that
     supports the buffer protocol instead of returning the data as a
     string.  This means you can put the data directly into an array or
     a memory-mapped file.

     Socket objects also gained ‘getfamily()’, ‘gettype()’, and
     ‘getproto()’ accessor methods to retrieve the family, type, and
     protocol values for the socket.

   * New module: the *note spwd: f1. module provides functions for
     accessing the shadow password database on systems that support
     shadow passwords.

   * The *note struct: f8. is now faster because it compiles format
     strings into ‘Struct’ objects with ‘pack()’ and ‘unpack()’ methods.
     This is similar to how the *note re: dd. module lets you create
     compiled regular expression objects.  You can still use the
     module-level ‘pack()’ and ‘unpack()’ functions; they’ll create
     ‘Struct’ objects and cache them.  Or you can use ‘Struct’ instances
     directly:

          s = struct.Struct('ih3s')

          data = s.pack(1972, 187, 'abc')
          year, number, name = s.unpack(data)

     You can also pack and unpack data to and from buffer objects
     directly using the ‘pack_into(buffer, offset, v1, v2, ...)’ and
     ‘unpack_from(buffer, offset)’ methods.  This lets you store data
     directly into an array or a memory-mapped file.

     (‘Struct’ objects were implemented by Bob Ippolito at the
     NeedForSpeed sprint.  Support for buffer objects was added by
     Martin Blais, also at the NeedForSpeed sprint.)

   * The Python developers switched from CVS to Subversion during the
     2.5 development process.  Information about the exact build version
     is available as the ‘sys.subversion’ variable, a 3-tuple of
     ‘(interpreter-name, branch-name, revision-range)’.  For example, at
     the time of writing my copy of 2.5 was reporting ‘('CPython',
     'trunk', '45313:45315')’.

     This information is also available to C extensions via the *note
     Py_GetBuildInfo(): d8d. function that returns a string of build
     information like this: ‘"trunk:45355:45356M, Apr 13 2006,
     07:42:19"’.  (Contributed by Barry Warsaw.)

   * Another new function, *note sys._current_frames(): d8e, returns the
     current stack frames for all running threads as a dictionary
     mapping thread identifiers to the topmost stack frame currently
     active in that thread at the time the function is called.
     (Contributed by Tim Peters.)

   * The ‘TarFile’ class in the *note tarfile: 101. module now has an
     ‘extractall()’ method that extracts all members from the archive
     into the current working directory.  It’s also possible to set a
     different directory as the extraction target, and to unpack only a
     subset of the archive’s members.

     The compression used for a tarfile opened in stream mode can now be
     autodetected using the mode ‘'r|*'’.  (Contributed by Lars
     Gustäbel.)

   * The *note threading: 109. module now lets you set the stack size
     used when new threads are created.  The ‘stack_size([*size*])’
     function returns the currently configured stack size, and supplying
     the optional `size' parameter sets a new value.  Not all platforms
     support changing the stack size, but Windows, POSIX threading, and
     OS/2 all do.  (Contributed by Andrew MacIntyre.)

   * The *note unicodedata: 11a. module has been updated to use version
     4.1.0 of the Unicode character database.  Version 3.2.0 is required
     by some specifications, so it’s still available as *note
     unicodedata.ucd_3_2_0: d8f.

   * New module: the *note uuid: 124. module generates universally
     unique identifiers (UUIDs) according to RFC 4122(2).  The RFC
     defines several different UUID versions that are generated from a
     starting string, from system properties, or purely randomly.  This
     module contains a ‘UUID’ class and functions named ‘uuid1()’,
     ‘uuid3()’, ‘uuid4()’, and ‘uuid5()’ to generate different versions
     of UUID. (Version 2 UUIDs are not specified in RFC 4122(3) and are
     not supported by this module.)

          >>> import uuid
          >>> # make a UUID based on the host ID and current time
          >>> uuid.uuid1()
          UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')

          >>> # make a UUID using an MD5 hash of a namespace UUID and a name
          >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
          UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')

          >>> # make a random UUID
          >>> uuid.uuid4()
          UUID('16fd2706-8baf-433b-82eb-8c7fada847da')

          >>> # make a UUID using a SHA-1 hash of a namespace UUID and a name
          >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
          UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')

     (Contributed by Ka-Ping Yee.)

   * The *note weakref: 128. module’s ‘WeakKeyDictionary’ and
     ‘WeakValueDictionary’ types gained new methods for iterating over
     the weak references contained in the dictionary.  ‘iterkeyrefs()’
     and ‘keyrefs()’ methods were added to ‘WeakKeyDictionary’, and
     ‘itervaluerefs()’ and ‘valuerefs()’ were added to
     ‘WeakValueDictionary’.  (Contributed by Fred L. Drake, Jr.)

   * The *note webbrowser: 129. module received a number of
     enhancements.  It’s now usable as a script with ‘python -m
     webbrowser’, taking a URL as the argument; there are a number of
     switches to control the behaviour (‘-n’ for a new browser window,
     ‘-t’ for a new tab).  New module-level functions, ‘open_new()’ and
     ‘open_new_tab()’, were added to support this.  The module’s *note
     open(): 4e5. function supports an additional feature, an
     `autoraise' parameter that signals whether to raise the open window
     when possible.  A number of additional browsers were added to the
     supported list such as Firefox, Opera, Konqueror, and elinks.
     (Contributed by Oleg Broytmann and Georg Brandl.)

   * The ‘xmlrpclib’ module now supports returning *note datetime: 194.
     objects for the XML-RPC date type.  Supply ‘use_datetime=True’ to
     the ‘loads()’ function or the ‘Unmarshaller’ class to enable this
     feature.  (Contributed by Skip Montanaro.)

   * The *note zipfile: 142. module now supports the ZIP64 version of
     the format, meaning that a .zip archive can now be larger than 4
     GiB and can contain individual files larger than 4 GiB.
     (Contributed by Ronald Oussoren.)

   * The *note zlib: 144. module’s ‘Compress’ and ‘Decompress’ objects
     now support a *note copy(): 26. method that makes a copy of the
     object’s internal state and returns a new ‘Compress’ or
     ‘Decompress’ object.  (Contributed by Chris AtLee.)

* Menu:

* The ctypes package::
* The ElementTree package::
* The hashlib package::
* The sqlite3 package::
* The wsgiref package::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0302

   (2) https://tools.ietf.org/html/rfc4122.html

   (3) https://tools.ietf.org/html/rfc4122.html


File: python.info,  Node: The ctypes package,  Next: The ElementTree package,  Up: New Improved and Removed Modules

1.12.13.1 The ctypes package
............................

The *note ctypes: 2b. package, written by Thomas Heller, has been added
to the standard library.  *note ctypes: 2b. lets you call arbitrary
functions in shared libraries or DLLs.  Long-time users may remember the
‘dl’ module, which provides functions for loading shared libraries and
calling functions in them.  The *note ctypes: 2b. package is much
fancier.

To load a shared library or DLL, you must create an instance of the
‘CDLL’ class and provide the name or path of the shared library or DLL.
Once that’s done, you can call arbitrary functions by accessing them as
attributes of the ‘CDLL’ object.

     import ctypes

     libc = ctypes.CDLL('libc.so.6')
     result = libc.printf("Line of output\n")

Type constructors for the various C types are provided: ‘c_int()’,
‘c_float()’, ‘c_double()’, ‘c_char_p()’ (equivalent to ‘char *’), and so
forth.  Unlike Python’s types, the C versions are all mutable; you can
assign to their ‘value’ attribute to change the wrapped value.  Python
integers and strings will be automatically converted to the
corresponding C types, but for other types you must call the correct
type constructor.  (And I mean `must'; getting it wrong will often
result in the interpreter crashing with a segmentation fault.)

You shouldn’t use ‘c_char_p()’ with a Python string when the C function
will be modifying the memory area, because Python strings are supposed
to be immutable; breaking this rule will cause puzzling bugs.  When you
need a modifiable memory area, use ‘create_string_buffer()’:

     s = "this is a string"
     buf = ctypes.create_string_buffer(s)
     libc.strfry(buf)

C functions are assumed to return integers, but you can set the
‘restype’ attribute of the function object to change this:

     >>> libc.atof('2.71828')
     -1783957616
     >>> libc.atof.restype = ctypes.c_double
     >>> libc.atof('2.71828')
     2.71828

*note ctypes: 2b. also provides a wrapper for Python’s C API as the
‘ctypes.pythonapi’ object.  This object does `not' release the global
interpreter lock before calling a function, because the lock must be
held when calling into the interpreter’s code.  There’s a ‘py_object()’
type constructor that will create a *note PyObject *: 4b0. pointer.  A
simple usage:

     import ctypes

     d = {}
     ctypes.pythonapi.PyObject_SetItem(ctypes.py_object(d),
               ctypes.py_object("abc"),  ctypes.py_object(1))
     # d is now {'abc', 1}.

Don’t forget to use ‘py_object()’; if it’s omitted you end up with a
segmentation fault.

*note ctypes: 2b. has been around for a while, but people still write
and distribution hand-coded extension modules because you can’t rely on
*note ctypes: 2b. being present.  Perhaps developers will begin to write
Python wrappers atop a library accessed through *note ctypes: 2b.
instead of extension modules, now that *note ctypes: 2b. is included
with core Python.

See also
........

‘http://starship.python.net/crew/theller/ctypes/’

     The ctypes web page, with a tutorial, reference, and FAQ.

The documentation for the *note ctypes: 2b. module.


File: python.info,  Node: The ElementTree package,  Next: The hashlib package,  Prev: The ctypes package,  Up: New Improved and Removed Modules

1.12.13.2 The ElementTree package
.................................

A subset of Fredrik Lundh’s ElementTree library for processing XML has
been added to the standard library as ‘xml.etree’.  The available
modules are ‘ElementTree’, ‘ElementPath’, and ‘ElementInclude’ from
ElementTree 1.2.6.  The ‘cElementTree’ accelerator module is also
included.

The rest of this section will provide a brief overview of using
ElementTree.  Full documentation for ElementTree is available at
‘http://effbot.org/zone/element-index.htm’.

ElementTree represents an XML document as a tree of element nodes.  The
text content of the document is stored as the ‘text’ and ‘tail’
attributes of (This is one of the major differences between ElementTree
and the Document Object Model; in the DOM there are many different types
of node, including ‘TextNode’.)

The most commonly used parsing function is ‘parse()’, that takes either
a string (assumed to contain a filename) or a file-like object and
returns an ‘ElementTree’ instance:

     from xml.etree import ElementTree as ET

     tree = ET.parse('ex-1.xml')

     feed = urllib.urlopen(
               'http://planet.python.org/rss10.xml')
     tree = ET.parse(feed)

Once you have an ‘ElementTree’ instance, you can call its ‘getroot()’
method to get the root ‘Element’ node.

There’s also an ‘XML()’ function that takes a string literal and returns
an ‘Element’ node (not an ‘ElementTree’).  This function provides a tidy
way to incorporate XML fragments, approaching the convenience of an XML
literal:

     svg = ET.XML("""<svg width="10px" version="1.0">
                  </svg>""")
     svg.set('height', '320px')
     svg.append(elem1)

Each XML element supports some dictionary-like and some list-like access
methods.  Dictionary-like operations are used to access attribute
values, and list-like operations are used to access child nodes.

Operation                           Result
                                    
-------------------------------------------------------------------------------------
                                    
‘elem[n]’                           Returns n’th child element.
                                    
                                    
‘elem[m:n]’                         Returns list of m’th through n’th child
                                    elements.
                                    
                                    
‘len(elem)’                         Returns number of child elements.
                                    
                                    
‘list(elem)’                        Returns list of child elements.
                                    
                                    
‘elem.append(elem2)’                Adds `elem2' as a child.
                                    
                                    
‘elem.insert(index, elem2)’         Inserts `elem2' at the specified location.
                                    
                                    
‘del elem[n]’                       Deletes n’th child element.
                                    
                                    
‘elem.keys()’                       Returns list of attribute names.
                                    
                                    
‘elem.get(name)’                    Returns value of attribute `name'.
                                    
                                    
‘elem.set(name, value)’             Sets new value for attribute `name'.
                                    
                                    
‘elem.attrib’                       Retrieves the dictionary containing
                                    attributes.
                                    
                                    
‘del elem.attrib[name]’             Deletes attribute `name'.
                                    

Comments and processing instructions are also represented as ‘Element’
nodes.  To check if a node is a comment or processing instructions:

     if elem.tag is ET.Comment:
         ...
     elif elem.tag is ET.ProcessingInstruction:
         ...

To generate XML output, you should call the ‘ElementTree.write()’
method.  Like ‘parse()’, it can take either a string or a file-like
object:

     # Encoding is US-ASCII
     tree.write('output.xml')

     # Encoding is UTF-8
     f = open('output.xml', 'w')
     tree.write(f, encoding='utf-8')

(Caution: the default encoding used for output is ASCII. For general XML
work, where an element’s name may contain arbitrary Unicode characters,
ASCII isn’t a very useful encoding because it will raise an exception if
an element’s name contains any characters with values greater than 127.
Therefore, it’s best to specify a different encoding such as UTF-8 that
can handle any Unicode character.)

This section is only a partial description of the ElementTree
interfaces.  Please read the package’s official documentation for more
details.

See also
........

‘http://effbot.org/zone/element-index.htm’

     Official documentation for ElementTree.


File: python.info,  Node: The hashlib package,  Next: The sqlite3 package,  Prev: The ElementTree package,  Up: New Improved and Removed Modules

1.12.13.3 The hashlib package
.............................

A new *note hashlib: 8d. module, written by Gregory P. Smith, has been
added to replace the ‘md5’ and ‘sha’ modules.  *note hashlib: 8d. adds
support for additional secure hashes (SHA-224, SHA-256, SHA-384, and
SHA-512).  When available, the module uses OpenSSL for fast platform
optimized implementations of algorithms.

The old ‘md5’ and ‘sha’ modules still exist as wrappers around hashlib
to preserve backwards compatibility.  The new module’s interface is very
close to that of the old modules, but not identical.  The most
significant difference is that the constructor functions for creating
new hashing objects are named differently.

     # Old versions
     h = md5.md5()
     h = md5.new()

     # New version
     h = hashlib.md5()

     # Old versions
     h = sha.sha()
     h = sha.new()

     # New version
     h = hashlib.sha1()

     # Hash that weren't previously available
     h = hashlib.sha224()
     h = hashlib.sha256()
     h = hashlib.sha384()
     h = hashlib.sha512()

     # Alternative form
     h = hashlib.new('md5')          # Provide algorithm as a string

Once a hash object has been created, its methods are the same as before:
‘update(string)’ hashes the specified string into the current digest
state, ‘digest()’ and ‘hexdigest()’ return the digest value as a binary
string or a string of hex digits, and *note copy(): 26. returns a new
hashing object with the same digest state.

See also
........

The documentation for the *note hashlib: 8d. module.


File: python.info,  Node: The sqlite3 package,  Next: The wsgiref package,  Prev: The hashlib package,  Up: New Improved and Removed Modules

1.12.13.4 The sqlite3 package
.............................

The pysqlite module (‘http://www.pysqlite.org’), a wrapper for the
SQLite embedded database, has been added to the standard library under
the package name *note sqlite3: f2.

SQLite is a C library that provides a lightweight disk-based database
that doesn’t require a separate server process and allows accessing the
database using a nonstandard variant of the SQL query language.  Some
applications can use SQLite for internal data storage.  It’s also
possible to prototype an application using SQLite and then port the code
to a larger database such as PostgreSQL or Oracle.

pysqlite was written by Gerhard Häring and provides a SQL interface
compliant with the DB-API 2.0 specification described by PEP 249(1).

If you’re compiling the Python source yourself, note that the source
tree doesn’t include the SQLite code, only the wrapper module.  You’ll
need to have the SQLite libraries and headers installed before compiling
Python, and the build process will compile the module when the necessary
headers are available.

To use the module, you must first create a ‘Connection’ object that
represents the database.  Here the data will be stored in the
‘/tmp/example’ file:

     conn = sqlite3.connect('/tmp/example')

You can also supply the special name ‘:memory:’ to create a database in
RAM.

Once you have a ‘Connection’, you can create a ‘Cursor’ object and call
its ‘execute()’ method to perform SQL commands:

     c = conn.cursor()

     # Create table
     c.execute('''create table stocks
     (date text, trans text, symbol text,
      qty real, price real)''')

     # Insert a row of data
     c.execute("""insert into stocks
               values ('2006-01-05','BUY','RHAT',100,35.14)""")

Usually your SQL operations will need to use values from Python
variables.  You shouldn’t assemble your query using Python’s string
operations because doing so is insecure; it makes your program
vulnerable to an SQL injection attack.

Instead, use the DB-API’s parameter substitution.  Put ‘?’ as a
placeholder wherever you want to use a value, and then provide a tuple
of values as the second argument to the cursor’s ‘execute()’ method.
(Other database modules may use a different placeholder, such as ‘%s’ or
‘:1’.)  For example:

     # Never do this -- insecure!
     symbol = 'IBM'
     c.execute("... where symbol = '%s'" % symbol)

     # Do this instead
     t = (symbol,)
     c.execute('select * from stocks where symbol=?', t)

     # Larger example
     for t in (('2006-03-28', 'BUY', 'IBM', 1000, 45.00),
               ('2006-04-05', 'BUY', 'MSOFT', 1000, 72.00),
               ('2006-04-06', 'SELL', 'IBM', 500, 53.00),
              ):
         c.execute('insert into stocks values (?,?,?,?,?)', t)

To retrieve data after executing a SELECT statement, you can either
treat the cursor as an iterator, call the cursor’s ‘fetchone()’ method
to retrieve a single matching row, or call ‘fetchall()’ to get a list of
the matching rows.

This example uses the iterator form:

     >>> c = conn.cursor()
     >>> c.execute('select * from stocks order by price')
     >>> for row in c:
     ...    print row
     ...
     (u'2006-01-05', u'BUY', u'RHAT', 100, 35.140000000000001)
     (u'2006-03-28', u'BUY', u'IBM', 1000, 45.0)
     (u'2006-04-06', u'SELL', u'IBM', 500, 53.0)
     (u'2006-04-05', u'BUY', u'MSOFT', 1000, 72.0)
     >>>

For more information about the SQL dialect supported by SQLite, see
‘https://www.sqlite.org’.

See also
........

‘http://www.pysqlite.org’

     The pysqlite web page.

‘https://www.sqlite.org’

     The SQLite web page; the documentation describes the syntax and the
     available data types for the supported SQL dialect.

The documentation for the *note sqlite3: f2. module.

PEP 249(2) - Database API Specification 2.0

     PEP written by Marc-André Lemburg.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0249

   (2) https://www.python.org/dev/peps/pep-0249


File: python.info,  Node: The wsgiref package,  Prev: The sqlite3 package,  Up: New Improved and Removed Modules

1.12.13.5 The wsgiref package
.............................

The Web Server Gateway Interface (WSGI) v1.0 defines a standard
interface between web servers and Python web applications and is
described in PEP 333(1).  The *note wsgiref: 12c. package is a reference
implementation of the WSGI specification.

The package includes a basic HTTP server that will run a WSGI
application; this server is useful for debugging but isn’t intended for
production use.  Setting up a server takes only a few lines of code:

     from wsgiref import simple_server

     wsgi_app = ...

     host = ''
     port = 8000
     httpd = simple_server.make_server(host, port, wsgi_app)
     httpd.serve_forever()

See also
........

‘http://www.wsgi.org’

     A central web site for WSGI-related resources.

PEP 333(2) - Python Web Server Gateway Interface v1.0

     PEP written by Phillip J. Eby.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0333

   (2) https://www.python.org/dev/peps/pep-0333


File: python.info,  Node: Build and C API Changes<10>,  Next: Porting to Python 2 5,  Prev: New Improved and Removed Modules,  Up: What’s New in Python 2 5

1.12.14 Build and C API Changes
-------------------------------

Changes to Python’s build process and to the C API include:

   * The Python source tree was converted from CVS to Subversion, in a
     complex migration procedure that was supervised and flawlessly
     carried out by Martin von Löwis.  The procedure was developed as
     PEP 347(1).

   * Coverity, a company that markets a source code analysis tool called
     Prevent, provided the results of their examination of the Python
     source code.  The analysis found about 60 bugs that were quickly
     fixed.  Many of the bugs were refcounting problems, often occurring
     in error-handling code.  See ‘https://scan.coverity.com’ for the
     statistics.

   * The largest change to the C API came from PEP 353(2), which
     modifies the interpreter to use a ‘Py_ssize_t’ type definition
     instead of ‘int’.  See the earlier section *note PEP 353; Using
     ssize_t as the index type: d6f. for a discussion of this change.

   * The design of the bytecode compiler has changed a great deal, no
     longer generating bytecode by traversing the parse tree.  Instead
     the parse tree is converted to an abstract syntax tree (or AST),
     and it is the abstract syntax tree that’s traversed to produce the
     bytecode.

     It’s possible for Python code to obtain AST objects by using the
     *note compile(): 1b2. built-in and specifying ‘_ast.PyCF_ONLY_AST’
     as the value of the `flags' parameter:

          from _ast import PyCF_ONLY_AST
          ast = compile("""a=0
          for i in range(10):
              a += i
          """, "<string>", 'exec', PyCF_ONLY_AST)

          assignment = ast.body[0]
          for_loop = ast.body[1]

     No official documentation has been written for the AST code yet,
     but PEP 339(3) discusses the design.  To start learning about the
     code, read the definition of the various AST nodes in
     ‘Parser/Python.asdl’.  A Python script reads this file and
     generates a set of C structure definitions in
     ‘Include/Python-ast.h’.  The ‘PyParser_ASTFromString()’ and
     ‘PyParser_ASTFromFile()’, defined in ‘Include/pythonrun.h’, take
     Python source as input and return the root of an AST representing
     the contents.  This AST can then be turned into a code object by
     ‘PyAST_Compile()’.  For more information, read the source code, and
     then ask questions on python-dev.

     The AST code was developed under Jeremy Hylton’s management, and
     implemented by (in alphabetical order) Brett Cannon, Nick Coghlan,
     Grant Edwards, John Ehresman, Kurt Kaiser, Neal Norwitz, Tim
     Peters, Armin Rigo, and Neil Schemenauer, plus the participants in
     a number of AST sprints at conferences such as PyCon.

   * Evan Jones’s patch to obmalloc, first described in a talk at PyCon
     DC 2005, was applied.  Python 2.4 allocated small objects in
     256K-sized arenas, but never freed arenas.  With this patch, Python
     will free arenas when they’re empty.  The net effect is that on
     some platforms, when you allocate many objects, Python’s memory
     usage may actually drop when you delete them and the memory may be
     returned to the operating system.  (Implemented by Evan Jones, and
     reworked by Tim Peters.)

     Note that this change means extension modules must be more careful
     when allocating memory.  Python’s API has many different functions
     for allocating memory that are grouped into families.  For example,
     *note PyMem_Malloc(): 4fa, *note PyMem_Realloc(): 963, and *note
     PyMem_Free(): d9c. are one family that allocates raw memory, while
     *note PyObject_Malloc(): 4fd, *note PyObject_Realloc(): d9d, and
     *note PyObject_Free(): 4f9. are another family that’s supposed to
     be used for creating Python objects.

     Previously these different families all reduced to the platform’s
     ‘malloc()’ and ‘free()’ functions.  This meant it didn’t matter if
     you got things wrong and allocated memory with the ‘PyMem()’
     function but freed it with the *note PyObject(): 4b0. function.
     With 2.5’s changes to obmalloc, these families now do different
     things and mismatches will probably result in a segfault.  You
     should carefully test your C extension modules with Python 2.5.

   * The built-in set types now have an official C API. Call *note
     PySet_New(): d9e. and *note PyFrozenSet_New(): d9f. to create a new
     set, *note PySet_Add(): da0. and *note PySet_Discard(): da1. to add
     and remove elements, and *note PySet_Contains(): da2. and *note
     PySet_Size(): da3. to examine the set’s state.  (Contributed by
     Raymond Hettinger.)

   * C code can now obtain information about the exact revision of the
     Python interpreter by calling the *note Py_GetBuildInfo(): d8d.
     function that returns a string of build information like this:
     ‘"trunk:45355:45356M, Apr 13 2006, 07:42:19"’.  (Contributed by
     Barry Warsaw.)

   * Two new macros can be used to indicate C functions that are local
     to the current file so that a faster calling convention can be
     used.  ‘Py_LOCAL(type)’ declares the function as returning a value
     of the specified `type' and uses a fast-calling qualifier.
     ‘Py_LOCAL_INLINE(type)’ does the same thing and also requests the
     function be inlined.  If ‘PY_LOCAL_AGGRESSIVE()’ is defined before
     ‘python.h’ is included, a set of more aggressive optimizations are
     enabled for the module; you should benchmark the results to find
     out if these optimizations actually make the code faster.
     (Contributed by Fredrik Lundh at the NeedForSpeed sprint.)

   * ‘PyErr_NewException(name, base, dict)’ can now accept a tuple of
     base classes as its `base' argument.  (Contributed by Georg
     Brandl.)

   * The ‘PyErr_Warn()’ function for issuing warnings is now deprecated
     in favour of ‘PyErr_WarnEx(category, message, stacklevel)’ which
     lets you specify the number of stack frames separating this
     function and the caller.  A `stacklevel' of 1 is the function
     calling *note PyErr_WarnEx(): da4, 2 is the function above that,
     and so forth.  (Added by Neal Norwitz.)

   * The CPython interpreter is still written in C, but the code can now
     be compiled with a C++ compiler without errors.  (Implemented by
     Anthony Baxter, Martin von Löwis, Skip Montanaro.)

   * The ‘PyRange_New()’ function was removed.  It was never documented,
     never used in the core code, and had dangerously lax error
     checking.  In the unlikely case that your extensions were using it,
     you can replace it by something like the following:

          range = PyObject_CallFunction((PyObject*) &PyRange_Type, "lll",
                                        start, stop, step);

* Menu:

* Port-Specific Changes::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0347

   (2) https://www.python.org/dev/peps/pep-0353

   (3) https://www.python.org/dev/peps/pep-0339


File: python.info,  Node: Port-Specific Changes,  Up: Build and C API Changes<10>

1.12.14.1 Port-Specific Changes
...............................

   * MacOS X (10.3 and higher): dynamic loading of modules now uses the
     ‘dlopen()’ function instead of MacOS-specific functions.

   * MacOS X: an ‘--enable-universalsdk’ switch was added to the
     ‘configure’ script that compiles the interpreter as a universal
     binary able to run on both PowerPC and Intel processors.
     (Contributed by Ronald Oussoren; bpo-2573(1).)

   * Windows: ‘.dll’ is no longer supported as a filename extension for
     extension modules.  ‘.pyd’ is now the only filename extension that
     will be searched for.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue2573


File: python.info,  Node: Porting to Python 2 5,  Next: Acknowledgements<3>,  Prev: Build and C API Changes<10>,  Up: What’s New in Python 2 5

1.12.15 Porting to Python 2.5
-----------------------------

This section lists previously described changes that may require changes
to your code:

   * ASCII is now the default encoding for modules.  It’s now a syntax
     error if a module contains string literals with 8-bit characters
     but doesn’t have an encoding declaration.  In Python 2.4 this
     triggered a warning, not a syntax error.

   * Previously, the ‘gi_frame’ attribute of a generator was always a
     frame object.  Because of the PEP 342(1) changes described in
     section *note PEP 342; New Generator Features: d59, it’s now
     possible for ‘gi_frame’ to be ‘None’.

   * A new warning, *note UnicodeWarning: d7a, is triggered when you
     attempt to compare a Unicode string and an 8-bit string that can’t
     be converted to Unicode using the default ASCII encoding.
     Previously such comparisons would raise a *note UnicodeDecodeError:
     1fb. exception.

   * Library: the *note csv: 2a. module is now stricter about multi-line
     quoted fields.  If your files contain newlines embedded within
     fields, the input should be split into lines in a manner which
     preserves the newline characters.

   * Library: the *note locale: a9. module’s *note format(): 4d0.
     function’s would previously accept any string as long as no more
     than one %char specifier appeared.  In Python 2.5, the argument
     must be exactly one %char specifier with no surrounding text.

   * Library: The *note pickle: ca. and ‘cPickle’ modules no longer
     accept a return value of ‘None’ from the *note __reduce__(): 19a.
     method; the method must return a tuple of arguments instead.  The
     modules also no longer accept the deprecated `bin' keyword
     parameter.

   * Library: The ‘SimpleXMLRPCServer’ and ‘DocXMLRPCServer’ classes now
     have a ‘rpc_paths’ attribute that constrains XML-RPC operations to
     a limited set of URL paths; the default is to allow only ‘'/'’ and
     ‘'/RPC2'’.  Setting ‘rpc_paths’ to ‘None’ or an empty tuple
     disables this path checking.

   * C API: Many functions now use ‘Py_ssize_t’ instead of ‘int’ to
     allow processing more data on 64-bit machines.  Extension code may
     need to make the same change to avoid warnings and to support
     64-bit machines.  See the earlier section *note PEP 353; Using
     ssize_t as the index type: d6f. for a discussion of this change.

   * C API: The obmalloc changes mean that you must be careful to not
     mix usage of the ‘PyMem_*()’ and ‘PyObject_*()’ families of
     functions.  Memory allocated with one family’s ‘*_Malloc()’ must be
     freed with the corresponding family’s ‘*_Free()’ function.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0342


File: python.info,  Node: Acknowledgements<3>,  Prev: Porting to Python 2 5,  Up: What’s New in Python 2 5

1.12.16 Acknowledgements
------------------------

The author would like to thank the following people for offering
suggestions, corrections and assistance with various drafts of this
article: Georg Brandl, Nick Coghlan, Phillip J. Eby, Lars Gustäbel,
Raymond Hettinger, Ralf W. Grosse-Kunstleve, Kent Johnson, Iain Lowe,
Martin von Löwis, Fredrik Lundh, Andrew McNamara, Skip Montanaro,
Gustavo Niemeyer, Paul Prescod, James Pryor, Mike Rovner, Scott Weikart,
Barry Warsaw, Thomas Wouters.


File: python.info,  Node: What’s New in Python 2 4,  Next: What’s New in Python 2 3,  Prev: What’s New in Python 2 5,  Up: What’s New in Python

1.13 What’s New in Python 2.4
=============================


Author: A.M. Kuchling

This article explains the new features in Python 2.4.1, released on
March 30, 2005.

Python 2.4 is a medium-sized release.  It doesn’t introduce as many
changes as the radical Python 2.2, but introduces more features than the
conservative 2.3 release.  The most significant new language features
are function decorators and generator expressions; most other changes
are to the standard library.

According to the CVS change logs, there were 481 patches applied and 502
bugs fixed between Python 2.3 and 2.4.  Both figures are likely to be
underestimates.

This article doesn’t attempt to provide a complete specification of
every single new feature, but instead provides a brief introduction to
each feature.  For full details, you should refer to the documentation
for Python 2.4, such as the Python Library Reference and the Python
Reference Manual.  Often you will be referred to the PEP for a
particular new feature for explanations of the implementation and design
rationale.

* Menu:

* PEP 218; Built-In Set Objects: PEP 218 Built-In Set Objects.
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers.
* PEP 289; Generator Expressions: PEP 289 Generator Expressions.
* PEP 292; Simpler String Substitutions: PEP 292 Simpler String Substitutions.
* PEP 318; Decorators for Functions and Methods: PEP 318 Decorators for Functions and Methods.
* PEP 322; Reverse Iteration: PEP 322 Reverse Iteration.
* PEP 324; New subprocess Module: PEP 324 New subprocess Module.
* PEP 327; Decimal Data Type: PEP 327 Decimal Data Type.
* PEP 328; Multi-line Imports: PEP 328 Multi-line Imports.
* PEP 331; Locale-Independent Float/String Conversions: PEP 331 Locale-Independent Float/String Conversions.
* Other Language Changes: Other Language Changes<12>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules<3>.
* Build and C API Changes: Build and C API Changes<11>.
* Porting to Python 2.4: Porting to Python 2 4.
* Acknowledgements: Acknowledgements<4>.


File: python.info,  Node: PEP 218 Built-In Set Objects,  Next: PEP 237 Unifying Long Integers and Integers,  Up: What’s New in Python 2 4

1.13.1 PEP 218: Built-In Set Objects
------------------------------------

Python 2.3 introduced the ‘sets’ module.  C implementations of set data
types have now been added to the Python core as two new built-in types,
‘set(iterable)’ and ‘frozenset(iterable)’.  They provide high speed
operations for membership testing, for eliminating duplicates from
sequences, and for mathematical operations like unions, intersections,
differences, and symmetric differences.

     >>> a = set('abracadabra')              # form a set from a string
     >>> 'z' in a                            # fast membership testing
     False
     >>> a                                   # unique letters in a
     set(['a', 'r', 'b', 'c', 'd'])
     >>> ''.join(a)                          # convert back into a string
     'arbcd'

     >>> b = set('alacazam')                 # form a second set
     >>> a - b                               # letters in a but not in b
     set(['r', 'd', 'b'])
     >>> a | b                               # letters in either a or b
     set(['a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'])
     >>> a & b                               # letters in both a and b
     set(['a', 'c'])
     >>> a ^ b                               # letters in a or b but not both
     set(['r', 'd', 'b', 'm', 'z', 'l'])

     >>> a.add('z')                          # add a new element
     >>> a.update('wxy')                     # add multiple new elements
     >>> a
     set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'x', 'z'])
     >>> a.remove('x')                       # take one element out
     >>> a
     set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'z'])

The *note frozenset(): be1. type is an immutable version of *note set():
b62.  Since it is immutable and hashable, it may be used as a dictionary
key or as a member of another set.

The ‘sets’ module remains in the standard library, and may be useful if
you wish to subclass the ‘Set’ or ‘ImmutableSet’ classes.  There are
currently no plans to deprecate the module.

See also
........

PEP 218(1) - Adding a Built-In Set Object Type

     Originally proposed by Greg Wilson and ultimately implemented by
     Raymond Hettinger.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0218


File: python.info,  Node: PEP 237 Unifying Long Integers and Integers,  Next: PEP 289 Generator Expressions,  Prev: PEP 218 Built-In Set Objects,  Up: What’s New in Python 2 4

1.13.2 PEP 237: Unifying Long Integers and Integers
---------------------------------------------------

The lengthy transition process for this PEP, begun in Python 2.2, takes
another step forward in Python 2.4.  In 2.3, certain integer operations
that would behave differently after int/long unification triggered *note
FutureWarning: 31a. warnings and returned values limited to 32 or 64
bits (depending on your platform).  In 2.4, these expressions no longer
produce a warning and instead produce a different result that’s usually
a long integer.

The problematic expressions are primarily left shifts and lengthy
hexadecimal and octal constants.  For example, ‘2 << 32’ results in a
warning in 2.3, evaluating to 0 on 32-bit platforms.  In Python 2.4,
this expression now returns the correct answer, 8589934592.

See also
........

PEP 237(1) - Unifying Long Integers and Integers

     Original PEP written by Moshe Zadka and GvR. The changes for 2.4
     were implemented by Kalle Svensson.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0237


File: python.info,  Node: PEP 289 Generator Expressions,  Next: PEP 292 Simpler String Substitutions,  Prev: PEP 237 Unifying Long Integers and Integers,  Up: What’s New in Python 2 4

1.13.3 PEP 289: Generator Expressions
-------------------------------------

The iterator feature introduced in Python 2.2 and the *note itertools:
a3. module make it easier to write programs that loop through large data
sets without having the entire data set in memory at one time.  List
comprehensions don’t fit into this picture very well because they
produce a Python list object containing all of the items.  This
unavoidably pulls all of the objects into memory, which can be a problem
if your data set is very large.  When trying to write a
functionally-styled program, it would be natural to write something
like:

     links = [link for link in get_all_links() if not link.followed]
     for link in links:
         ...

instead of

     for link in get_all_links():
         if link.followed:
             continue
         ...

The first form is more concise and perhaps more readable, but if you’re
dealing with a large number of link objects you’d have to write the
second form to avoid having all link objects in memory at the same time.

Generator expressions work similarly to list comprehensions but don’t
materialize the entire list; instead they create a generator that will
return elements one by one.  The above example could be written as:

     links = (link for link in get_all_links() if not link.followed)
     for link in links:
         ...

Generator expressions always have to be written inside parentheses, as
in the above example.  The parentheses signalling a function call also
count, so if you want to create an iterator that will be immediately
passed to a function you could write:

     print sum(obj.count for obj in list_all_objects())

Generator expressions differ from list comprehensions in various small
ways.  Most notably, the loop variable (`obj' in the above example) is
not accessible outside of the generator expression.  List comprehensions
leave the variable assigned to its last value; future versions of Python
will change this, making list comprehensions match generator expressions
in this respect.

See also
........

PEP 289(1) - Generator Expressions

     Proposed by Raymond Hettinger and implemented by Jiwon Seo with
     early efforts steered by Hye-Shik Chang.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0289


File: python.info,  Node: PEP 292 Simpler String Substitutions,  Next: PEP 318 Decorators for Functions and Methods,  Prev: PEP 289 Generator Expressions,  Up: What’s New in Python 2 4

1.13.4 PEP 292: Simpler String Substitutions
--------------------------------------------

Some new classes in the standard library provide an alternative
mechanism for substituting variables into strings; this style of
substitution may be better for applications where untrained users need
to edit templates.

The usual way of substituting variables by name is the ‘%’ operator:

     >>> '%(page)i: %(title)s' % {'page':2, 'title': 'The Best of Times'}
     '2: The Best of Times'

When writing the template string, it can be easy to forget the ‘i’ or
‘s’ after the closing parenthesis.  This isn’t a big problem if the
template is in a Python module, because you run the code, get an
“Unsupported format character” *note ValueError: 1f9, and fix the
problem.  However, consider an application such as Mailman where
template strings or translations are being edited by users who aren’t
aware of the Python language.  The format string’s syntax is complicated
to explain to such users, and if they make a mistake, it’s difficult to
provide helpful feedback to them.

PEP 292 adds a ‘Template’ class to the *note string: f6. module that
uses ‘$’ to indicate a substitution:

     >>> import string
     >>> t = string.Template('$page: $title')
     >>> t.substitute({'page':2, 'title': 'The Best of Times'})
     '2: The Best of Times'

If a key is missing from the dictionary, the ‘substitute()’ method will
raise a *note KeyError: 2c5.  There’s also a ‘safe_substitute()’ method
that ignores missing keys:

     >>> t = string.Template('$page: $title')
     >>> t.safe_substitute({'page':3})
     '3: $title'

See also
........

PEP 292(1) - Simpler String Substitutions

     Written and implemented by Barry Warsaw.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0292


File: python.info,  Node: PEP 318 Decorators for Functions and Methods,  Next: PEP 322 Reverse Iteration,  Prev: PEP 292 Simpler String Substitutions,  Up: What’s New in Python 2 4

1.13.5 PEP 318: Decorators for Functions and Methods
----------------------------------------------------

Python 2.2 extended Python’s object model by adding static methods and
class methods, but it didn’t extend Python’s syntax to provide any new
way of defining static or class methods.  Instead, you had to write a
*note def: db1. statement in the usual way, and pass the resulting
method to a *note staticmethod(): 1d7. or *note classmethod(): 1d6.
function that would wrap up the function as a method of the new type.
Your code would look like this:

     class C:
        def meth (cls):
            ...

        meth = classmethod(meth)   # Rebind name to wrapped-up class method

If the method was very long, it would be easy to miss or forget the
*note classmethod(): 1d6. invocation after the function body.

The intention was always to add some syntax to make such definitions
more readable, but at the time of 2.2’s release a good syntax was not
obvious.  Today a good syntax `still' isn’t obvious but users are asking
for easier access to the feature; a new syntactic feature has been added
to meet this need.

The new feature is called “function decorators”.  The name comes from
the idea that *note classmethod(): 1d6, *note staticmethod(): 1d7, and
friends are storing additional information on a function object; they’re
`decorating' functions with more details.

The notation borrows from Java and uses the ‘'@'’ character as an
indicator.  Using the new syntax, the example above would be written:

     class C:

        @classmethod
        def meth (cls):
            ...

The ‘@classmethod’ is shorthand for the ‘meth=classmethod(meth)’
assignment.  More generally, if you have the following:

     @A
     @B
     @C
     def f ():
         ...

It’s equivalent to the following pre-decorator code:

     def f(): ...
     f = A(B(C(f)))

Decorators must come on the line before a function definition, one
decorator per line, and can’t be on the same line as the def statement,
meaning that ‘@A def f(): ...’ is illegal.  You can only decorate
function definitions, either at the module level or inside a class; you
can’t decorate class definitions.

A decorator is just a function that takes the function to be decorated
as an argument and returns either the same function or some new object.
The return value of the decorator need not be callable (though it
typically is), unless further decorators will be applied to the result.
It’s easy to write your own decorators.  The following simple example
just sets an attribute on the function object:

     >>> def deco(func):
     ...    func.attr = 'decorated'
     ...    return func
     ...
     >>> @deco
     ... def f(): pass
     ...
     >>> f
     <function f at 0x402ef0d4>
     >>> f.attr
     'decorated'
     >>>

As a slightly more realistic example, the following decorator checks
that the supplied argument is an integer:

     def require_int (func):
         def wrapper (arg):
             assert isinstance(arg, int)
             return func(arg)

         return wrapper

     @require_int
     def p1 (arg):
         print arg

     @require_int
     def p2(arg):
         print arg*2

An example in PEP 318(1) contains a fancier version of this idea that
lets you both specify the required type and check the returned type.

Decorator functions can take arguments.  If arguments are supplied, your
decorator function is called with only those arguments and must return a
new decorator function; this function must take a single function and
return a function, as previously described.  In other words, ‘@A @B
@C(args)’ becomes:

     def f(): ...
     _deco = C(args)
     f = A(B(_deco(f)))

Getting this right can be slightly brain-bending, but it’s not too
difficult.

A small related change makes the ‘func_name’ attribute of functions
writable.  This attribute is used to display function names in
tracebacks, so decorators should change the name of any new function
that’s constructed and returned.

See also
........

PEP 318(2) - Decorators for Functions, Methods and Classes

     Written by Kevin D. Smith, Jim Jewett, and Skip Montanaro.  Several
     people wrote patches implementing function decorators, but the one
     that was actually checked in was patch #979728, written by Mark
     Russell.

‘https://wiki.python.org/moin/PythonDecoratorLibrary’

     This Wiki page contains several examples of decorators.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0318

   (2) https://www.python.org/dev/peps/pep-0318


File: python.info,  Node: PEP 322 Reverse Iteration,  Next: PEP 324 New subprocess Module,  Prev: PEP 318 Decorators for Functions and Methods,  Up: What’s New in Python 2 4

1.13.6 PEP 322: Reverse Iteration
---------------------------------

A new built-in function, ‘reversed(seq)’, takes a sequence and returns
an iterator that loops over the elements of the sequence in reverse
order.

     >>> for i in reversed(xrange(1,4)):
     ...    print i
     ...
     3
     2
     1

Compared to extended slicing, such as ‘range(1,4)[::-1]’, *note
reversed(): 18e. is easier to read, runs faster, and uses substantially
less memory.

Note that *note reversed(): 18e. only accepts sequences, not arbitrary
iterators.  If you want to reverse an iterator, first convert it to a
list with *note list(): 260.

     >>> input = open('/etc/passwd', 'r')
     >>> for line in reversed(list(input)):
     ...   print line
     ...
     root:*:0:0:System Administrator:/var/root:/bin/tcsh
       ...

See also
........

PEP 322(1) - Reverse Iteration

     Written and implemented by Raymond Hettinger.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0322


File: python.info,  Node: PEP 324 New subprocess Module,  Next: PEP 327 Decimal Data Type,  Prev: PEP 322 Reverse Iteration,  Up: What’s New in Python 2 4

1.13.7 PEP 324: New subprocess Module
-------------------------------------

The standard library provides a number of ways to execute a subprocess,
offering different features and different levels of complexity.
‘os.system(command)’ is easy to use, but slow (it runs a shell process
which executes the command) and dangerous (you have to be careful about
escaping the shell’s metacharacters).  The ‘popen2’ module offers
classes that can capture standard output and standard error from the
subprocess, but the naming is confusing.  The *note subprocess: f9.
module cleans this up, providing a unified interface that offers all the
features you might need.

Instead of ‘popen2’’s collection of classes, *note subprocess: f9.
contains a single class called ‘Popen’ whose constructor supports a
number of different keyword arguments.

     class Popen(args, bufsize=0, executable=None,
                 stdin=None, stdout=None, stderr=None,
                 preexec_fn=None, close_fds=False, shell=False,
                 cwd=None, env=None, universal_newlines=False,
                 startupinfo=None, creationflags=0):

`args' is commonly a sequence of strings that will be the arguments to
the program executed as the subprocess.  (If the `shell' argument is
true, `args' can be a string which will then be passed on to the shell
for interpretation, just as *note os.system(): db4. does.)

`stdin', `stdout', and `stderr' specify what the subprocess’s input,
output, and error streams will be.  You can provide a file object or a
file descriptor, or you can use the constant ‘subprocess.PIPE’ to create
a pipe between the subprocess and the parent.

The constructor has a number of handy options:

   * `close_fds' requests that all file descriptors be closed before
     running the subprocess.

   * `cwd' specifies the working directory in which the subprocess will
     be executed (defaulting to whatever the parent’s working directory
     is).

   * `env' is a dictionary specifying environment variables.

   * `preexec_fn' is a function that gets called before the child is
     started.

   * `universal_newlines' opens the child’s input and output using
     Python’s *note universal newlines: 5e9. feature.

Once you’ve created the ‘Popen’ instance, you can call its ‘wait()’
method to pause until the subprocess has exited, ‘poll()’ to check if
it’s exited without pausing, or ‘communicate(data)’ to send the string
`data' to the subprocess’s standard input.  ‘communicate(data)’ then
reads any data that the subprocess has sent to its standard output or
standard error, returning a tuple ‘(stdout_data, stderr_data)’.

‘call()’ is a shortcut that passes its arguments along to the ‘Popen’
constructor, waits for the command to complete, and returns the status
code of the subprocess.  It can serve as a safer analog to *note
os.system(): db4.:

     sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
     if sts == 0:
         # Success
         ...
     else:
         # dpkg returned an error
         ...

The command is invoked without use of the shell.  If you really do want
to use the shell, you can add ‘shell=True’ as a keyword argument and
provide a string instead of a sequence:

     sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)

The PEP takes various examples of shell and Python code and shows how
they’d be translated into Python code that uses *note subprocess: f9.
Reading this section of the PEP is highly recommended.

See also
........

PEP 324(1) - subprocess - New process module

     Written and implemented by Peter Åstrand, with assistance from
     Fredrik Lundh and others.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0324


File: python.info,  Node: PEP 327 Decimal Data Type,  Next: PEP 328 Multi-line Imports,  Prev: PEP 324 New subprocess Module,  Up: What’s New in Python 2 4

1.13.8 PEP 327: Decimal Data Type
---------------------------------

Python has always supported floating-point (FP) numbers, based on the
underlying C ‘double’ type, as a data type.  However, while most
programming languages provide a floating-point type, many people (even
programmers) are unaware that floating-point numbers don’t represent
certain decimal fractions accurately.  The new ‘Decimal’ type can
represent these fractions accurately, up to a user-specified precision
limit.

* Menu:

* Why is Decimal needed?::
* The Decimal type::
* The Context type::


File: python.info,  Node: Why is Decimal needed?,  Next: The Decimal type,  Up: PEP 327 Decimal Data Type

1.13.8.1 Why is Decimal needed?
...............................

The limitations arise from the representation used for floating-point
numbers.  FP numbers are made up of three components:

   * The sign, which is positive or negative.

   * The mantissa, which is a single-digit binary number followed by a
     fractional part.  For example, ‘1.01’ in base-2 notation is ‘1 +
     0/2 + 1/4’, or 1.25 in decimal notation.

   * The exponent, which tells where the decimal point is located in the
     number represented.

For example, the number 1.25 has positive sign, a mantissa value of 1.01
(in binary), and an exponent of 0 (the decimal point doesn’t need to be
shifted).  The number 5 has the same sign and mantissa, but the exponent
is 2 because the mantissa is multiplied by 4 (2 to the power of the
exponent 2); 1.25 * 4 equals 5.

Modern systems usually provide floating-point support that conforms to a
standard called IEEE 754.  C’s ‘double’ type is usually implemented as a
64-bit IEEE 754 number, which uses 52 bits of space for the mantissa.
This means that numbers can only be specified to 52 bits of precision.
If you’re trying to represent numbers whose expansion repeats endlessly,
the expansion is cut off after 52 bits.  Unfortunately, most software
needs to produce output in base 10, and common fractions in base 10 are
often repeating decimals in binary.  For example, 1.1 decimal is binary
‘1.0001100110011 ...’; .1 = 1/16 + 1/32 + 1/256 plus an infinite number
of additional terms.  IEEE 754 has to chop off that infinitely repeated
decimal after 52 digits, so the representation is slightly inaccurate.

Sometimes you can see this inaccuracy when the number is printed:

     >>> 1.1
     1.1000000000000001

The inaccuracy isn’t always visible when you print the number because
the FP-to-decimal-string conversion is provided by the C library, and
most C libraries try to produce sensible output.  Even if it’s not
displayed, however, the inaccuracy is still there and subsequent
operations can magnify the error.

For many applications this doesn’t matter.  If I’m plotting points and
displaying them on my monitor, the difference between 1.1 and
1.1000000000000001 is too small to be visible.  Reports often limit
output to a certain number of decimal places, and if you round the
number to two or three or even eight decimal places, the error is never
apparent.  However, for applications where it does matter, it’s a lot of
work to implement your own custom arithmetic routines.

Hence, the ‘Decimal’ type was created.


File: python.info,  Node: The Decimal type,  Next: The Context type,  Prev: Why is Decimal needed?,  Up: PEP 327 Decimal Data Type

1.13.8.2 The ‘Decimal’ type
...........................

A new module, *note decimal: 36, was added to Python’s standard library.
It contains two classes, ‘Decimal’ and ‘Context’.  ‘Decimal’ instances
represent numbers, and ‘Context’ instances are used to wrap up various
settings such as the precision and default rounding mode.

‘Decimal’ instances are immutable, like regular Python integers and FP
numbers; once it’s been created, you can’t change the value an instance
represents.  ‘Decimal’ instances can be created from integers or
strings:

     >>> import decimal
     >>> decimal.Decimal(1972)
     Decimal("1972")
     >>> decimal.Decimal("1.1")
     Decimal("1.1")

You can also provide tuples containing the sign, the mantissa
represented as a tuple of decimal digits, and the exponent:

     >>> decimal.Decimal((1, (1, 4, 7, 5), -2))
     Decimal("-14.75")

Cautionary note: the sign bit is a Boolean value, so 0 is positive and 1
is negative.

Converting from floating-point numbers poses a bit of a problem: should
the FP number representing 1.1 turn into the decimal number for exactly
1.1, or for 1.1 plus whatever inaccuracies are introduced?  The decision
was to dodge the issue and leave such a conversion out of the API.
Instead, you should convert the floating-point number into a string
using the desired precision and pass the string to the ‘Decimal’
constructor:

     >>> f = 1.1
     >>> decimal.Decimal(str(f))
     Decimal("1.1")
     >>> decimal.Decimal('%.12f' % f)
     Decimal("1.100000000000")

Once you have ‘Decimal’ instances, you can perform the usual
mathematical operations on them.  One limitation: exponentiation
requires an integer exponent:

     >>> a = decimal.Decimal('35.72')
     >>> b = decimal.Decimal('1.73')
     >>> a+b
     Decimal("37.45")
     >>> a-b
     Decimal("33.99")
     >>> a*b
     Decimal("61.7956")
     >>> a/b
     Decimal("20.64739884393063583815028902")
     >>> a ** 2
     Decimal("1275.9184")
     >>> a**b
     Traceback (most recent call last):
       ...
     decimal.InvalidOperation: x ** (non-integer)

You can combine ‘Decimal’ instances with integers, but not with
floating-point numbers:

     >>> a + 4
     Decimal("39.72")
     >>> a + 4.5
     Traceback (most recent call last):
       ...
     TypeError: You can interact Decimal only with int, long or Decimal data types.
     >>>

‘Decimal’ numbers can be used with the *note math: b1. and *note cmath:
19. modules, but note that they’ll be immediately converted to
floating-point numbers before the operation is performed, resulting in a
possible loss of precision and accuracy.  You’ll also get back a regular
floating-point number and not a ‘Decimal’.

     >>> import math, cmath
     >>> d = decimal.Decimal('123456789012.345')
     >>> math.sqrt(d)
     351364.18288201344
     >>> cmath.sqrt(-d)
     351364.18288201344j

‘Decimal’ instances have a ‘sqrt()’ method that returns a ‘Decimal’, but
if you need other things such as trigonometric functions you’ll have to
implement them.

     >>> d.sqrt()
     Decimal("351364.1828820134592177245001")


File: python.info,  Node: The Context type,  Prev: The Decimal type,  Up: PEP 327 Decimal Data Type

1.13.8.3 The ‘Context’ type
...........................

Instances of the ‘Context’ class encapsulate several settings for
decimal operations:

   * ‘prec’ is the precision, the number of decimal places.

   * ‘rounding’ specifies the rounding mode.  The *note decimal: 36.
     module has constants for the various possibilities: ‘ROUND_DOWN’,
     ‘ROUND_CEILING’, ‘ROUND_HALF_EVEN’, and various others.

   * ‘traps’ is a dictionary specifying what happens on encountering
     certain error conditions: either an exception is raised or a value
     is returned.  Some examples of error conditions are division by
     zero, loss of precision, and overflow.

There’s a thread-local default context available by calling
‘getcontext()’; you can change the properties of this context to alter
the default precision, rounding, or trap handling.  The following
example shows the effect of changing the precision of the default
context:

     >>> decimal.getcontext().prec
     28
     >>> decimal.Decimal(1) / decimal.Decimal(7)
     Decimal("0.1428571428571428571428571429")
     >>> decimal.getcontext().prec = 9
     >>> decimal.Decimal(1) / decimal.Decimal(7)
     Decimal("0.142857143")

The default action for error conditions is selectable; the module can
either return a special value such as infinity or not-a-number, or
exceptions can be raised:

     >>> decimal.Decimal(1) / decimal.Decimal(0)
     Traceback (most recent call last):
       ...
     decimal.DivisionByZero: x / 0
     >>> decimal.getcontext().traps[decimal.DivisionByZero] = False
     >>> decimal.Decimal(1) / decimal.Decimal(0)
     Decimal("Infinity")
     >>>

The ‘Context’ instance also has various methods for formatting numbers
such as ‘to_eng_string()’ and ‘to_sci_string()’.

For more information, see the documentation for the *note decimal: 36.
module, which includes a quick-start tutorial and a reference.

See also
........

PEP 327(1) - Decimal Data Type

     Written by Facundo Batista and implemented by Facundo Batista, Eric
     Price, Raymond Hettinger, Aahz, and Tim Peters.

‘http://www.lahey.com/float.htm’

     The article uses Fortran code to illustrate many of the problems
     that floating-point inaccuracy can cause.

‘http://speleotrove.com/decimal/’

     A description of a decimal-based representation.  This
     representation is being proposed as a standard, and underlies the
     new Python decimal type.  Much of this material was written by Mike
     Cowlishaw, designer of the Rexx language.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0327


File: python.info,  Node: PEP 328 Multi-line Imports,  Next: PEP 331 Locale-Independent Float/String Conversions,  Prev: PEP 327 Decimal Data Type,  Up: What’s New in Python 2 4

1.13.9 PEP 328: Multi-line Imports
----------------------------------

One language change is a small syntactic tweak aimed at making it easier
to import many names from a module.  In a ‘from module import names’
statement, `names' is a sequence of names separated by commas.  If the
sequence is very long, you can either write multiple imports from the
same module, or you can use backslashes to escape the line endings like
this:

     from SimpleXMLRPCServer import SimpleXMLRPCServer,\
                 SimpleXMLRPCRequestHandler,\
                 CGIXMLRPCRequestHandler,\
                 resolve_dotted_attribute

The syntactic change in Python 2.4 simply allows putting the names
within parentheses.  Python ignores newlines within a parenthesized
expression, so the backslashes are no longer needed:

     from SimpleXMLRPCServer import (SimpleXMLRPCServer,
                                     SimpleXMLRPCRequestHandler,
                                     CGIXMLRPCRequestHandler,
                                     resolve_dotted_attribute)

The PEP also proposes that all *note import: c10. statements be absolute
imports, with a leading ‘.’ character to indicate a relative import.
This part of the PEP was not implemented for Python 2.4, but was
completed for Python 2.5.

See also
........

PEP 328(1) - Imports: Multi-Line and Absolute/Relative

     Written by Aahz.  Multi-line imports were implemented by Dima
     Dorfman.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0328


File: python.info,  Node: PEP 331 Locale-Independent Float/String Conversions,  Next: Other Language Changes<12>,  Prev: PEP 328 Multi-line Imports,  Up: What’s New in Python 2 4

1.13.10 PEP 331: Locale-Independent Float/String Conversions
------------------------------------------------------------

The *note locale: a9. modules lets Python software select various
conversions and display conventions that are localized to a particular
country or language.  However, the module was careful to not change the
numeric locale because various functions in Python’s implementation
required that the numeric locale remain set to the ‘'C'’ locale.  Often
this was because the code was using the C library’s ‘atof()’ function.

Not setting the numeric locale caused trouble for extensions that used
third-party C libraries, however, because they wouldn’t have the correct
locale set.  The motivating example was GTK+, whose user interface
widgets weren’t displaying numbers in the current locale.

The solution described in the PEP is to add three new functions to the
Python API that perform ASCII-only conversions, ignoring the locale
setting:

   * ‘PyOS_ascii_strtod(str, ptr)’ and ‘PyOS_ascii_atof(str, ptr)’ both
     convert a string to a C ‘double’.

   * ‘PyOS_ascii_formatd(buffer, buf_len, format, d)’ converts a
     ‘double’ to an ASCII string.

The code for these functions came from the GLib library
(‘https://developer.gnome.org/glib/stable/’), whose developers kindly
relicensed the relevant functions and donated them to the Python
Software Foundation.  The *note locale: a9. module can now change the
numeric locale, letting extensions such as GTK+ produce the correct
results.

See also
........

PEP 331(1) - Locale-Independent Float/String Conversions

     Written by Christian R. Reis, and implemented by Gustavo Carneiro.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0331


File: python.info,  Node: Other Language Changes<12>,  Next: New Improved and Deprecated Modules<3>,  Prev: PEP 331 Locale-Independent Float/String Conversions,  Up: What’s New in Python 2 4

1.13.11 Other Language Changes
------------------------------

Here are all of the changes that Python 2.4 makes to the core Python
language.

   * Decorators for functions and methods were added ( PEP 318(1)).

   * Built-in *note set(): b62. and *note frozenset(): be1. types were
     added ( PEP 218(2)).  Other new built-ins include the
     ‘reversed(seq)’ function ( PEP 322(3)).

   * Generator expressions were added ( PEP 289(4)).

   * Certain numeric expressions no longer return values restricted to
     32 or 64 bits ( PEP 237(5)).

   * You can now put parentheses around the list of names in a ‘from
     module import names’ statement ( PEP 328(6)).

   * The *note dict.update(): dbc. method now accepts the same argument
     forms as the *note dict: 1b6. constructor.  This includes any
     mapping, any iterable of key/value pairs, and keyword arguments.
     (Contributed by Raymond Hettinger.)

   * The string methods ‘ljust()’, ‘rjust()’, and ‘center()’ now take an
     optional argument for specifying a fill character other than a
     space.  (Contributed by Raymond Hettinger.)

   * Strings also gained an ‘rsplit()’ method that works like the
     ‘split()’ method but splits from the end of the string.
     (Contributed by Sean Reifschneider.)

          >>> 'www.python.org'.split('.', 1)
          ['www', 'python.org']
          'www.python.org'.rsplit('.', 1)
          ['www.python', 'org']

   * Three keyword parameters, `cmp', `key', and `reverse', were added
     to the ‘sort()’ method of lists.  These parameters make some common
     usages of ‘sort()’ simpler.  All of these parameters are optional.

     For the `cmp' parameter, the value should be a comparison function
     that takes two parameters and returns -1, 0, or +1 depending on how
     the parameters compare.  This function will then be used to sort
     the list.  Previously this was the only parameter that could be
     provided to ‘sort()’.

     `key' should be a single-parameter function that takes a list
     element and returns a comparison key for the element.  The list is
     then sorted using the comparison keys.  The following example sorts
     a list case-insensitively:

          >>> L = ['A', 'b', 'c', 'D']
          >>> L.sort()                 # Case-sensitive sort
          >>> L
          ['A', 'D', 'b', 'c']
          >>> # Using 'key' parameter to sort list
          >>> L.sort(key=lambda x: x.lower())
          >>> L
          ['A', 'b', 'c', 'D']
          >>> # Old-fashioned way
          >>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
          >>> L
          ['A', 'b', 'c', 'D']

     The last example, which uses the `cmp' parameter, is the old way to
     perform a case-insensitive sort.  It works but is slower than using
     a `key' parameter.  Using `key' calls ‘lower()’ method once for
     each element in the list while using `cmp' will call it twice for
     each comparison, so using `key' saves on invocations of the
     ‘lower()’ method.

     For simple key functions and comparison functions, it is often
     possible to avoid a *note lambda: c22. expression by using an
     unbound method instead.  For example, the above case-insensitive
     sort is best written as:

          >>> L.sort(key=str.lower)
          >>> L
          ['A', 'b', 'c', 'D']

     Finally, the `reverse' parameter takes a Boolean value.  If the
     value is true, the list will be sorted into reverse order.  Instead
     of ‘L.sort(); L.reverse()’, you can now write
     ‘L.sort(reverse=True)’.

     The results of sorting are now guaranteed to be stable.  This means
     that two entries with equal keys will be returned in the same order
     as they were input.  For example, you can sort a list of people by
     name, and then sort the list by age, resulting in a list sorted by
     age where people with the same age are in name-sorted order.

     (All changes to ‘sort()’ contributed by Raymond Hettinger.)

   * There is a new built-in function ‘sorted(iterable)’ that works like
     the in-place *note list.sort(): 43a. method but can be used in
     expressions.  The differences are:

   * the input may be any iterable;

   * a newly formed copy is sorted, leaving the original intact; and

   * the expression returns the new sorted copy

          >>> L = [9,7,8,3,2,4,1,6,5]
          >>> [10+i for i in sorted(L)]       # usable in a list comprehension
          [11, 12, 13, 14, 15, 16, 17, 18, 19]
          >>> L                               # original is left unchanged
          [9,7,8,3,2,4,1,6,5]
          >>> sorted('Monty Python')          # any iterable may be an input
          [' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']

          >>> # List the contents of a dict sorted by key values
          >>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
          >>> for k, v in sorted(colormap.iteritems()):
          ...     print k, v
          ...
          black 4
          blue 2
          green 3
          red 1
          yellow 5

     (Contributed by Raymond Hettinger.)

   * Integer operations will no longer trigger an ‘OverflowWarning’.
     The ‘OverflowWarning’ warning will disappear in Python 2.5.

   * The interpreter gained a new switch, *note -m: 32c, that takes a
     name, searches for the corresponding module on ‘sys.path’, and runs
     the module as a script.  For example, you can now run the Python
     profiler with ‘python -m profile’.  (Contributed by Nick Coghlan.)

   * The ‘eval(expr, globals, locals)’ and ‘execfile(filename, globals,
     locals)’ functions and the ‘exec’ statement now accept any mapping
     type for the `locals' parameter.  Previously this had to be a
     regular Python dictionary.  (Contributed by Raymond Hettinger.)

   * The *note zip(): c25. built-in function and ‘itertools.izip()’ now
     return an empty list if called with no arguments.  Previously they
     raised a *note TypeError: 192. exception.  This makes them more
     suitable for use with variable length argument lists:

          >>> def transpose(array):
          ...    return zip(*array)
          ...
          >>> transpose([(1,2,3), (4,5,6)])
          [(1, 4), (2, 5), (3, 6)]
          >>> transpose([])
          []

     (Contributed by Raymond Hettinger.)

   * Encountering a failure while importing a module no longer leaves a
     partially-initialized module object in ‘sys.modules’.  The
     incomplete module object left behind would fool further imports of
     the same module into succeeding, leading to confusing errors.
     (Fixed by Tim Peters.)

   * *note None: 157. is now a constant; code that binds a new value to
     the name ‘None’ is now a syntax error.  (Contributed by Raymond
     Hettinger.)

* Menu:

* Optimizations: Optimizations<11>.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0318

   (2) https://www.python.org/dev/peps/pep-0218

   (3) https://www.python.org/dev/peps/pep-0322

   (4) https://www.python.org/dev/peps/pep-0289

   (5) https://www.python.org/dev/peps/pep-0237

   (6) https://www.python.org/dev/peps/pep-0328


File: python.info,  Node: Optimizations<11>,  Up: Other Language Changes<12>

1.13.11.1 Optimizations
.......................

   * The inner loops for list and tuple slicing were optimized and now
     run about one-third faster.  The inner loops for dictionaries were
     also optimized, resulting in performance boosts for ‘keys()’,
     ‘values()’, ‘items()’, ‘iterkeys()’, ‘itervalues()’, and
     ‘iteritems()’.  (Contributed by Raymond Hettinger.)

   * The machinery for growing and shrinking lists was optimized for
     speed and for space efficiency.  Appending and popping from lists
     now runs faster due to more efficient code paths and less frequent
     use of the underlying system ‘realloc()’.  List comprehensions also
     benefit.  ‘list.extend()’ was also optimized and no longer converts
     its argument into a temporary list before extending the base list.
     (Contributed by Raymond Hettinger.)

   * *note list(): 260, *note tuple(): 473, *note map(): c20, *note
     filter(): c21, and *note zip(): c25. now run several times faster
     with non-sequence arguments that supply a *note __len__(): dbe.
     method.  (Contributed by Raymond Hettinger.)

   * The methods ‘list.__getitem__()’, ‘dict.__getitem__()’, and
     ‘dict.__contains__()’ are now implemented as ‘method_descriptor’
     objects rather than ‘wrapper_descriptor’ objects.  This form of
     access doubles their performance and makes them more suitable for
     use as arguments to functionals: ‘map(mydict.__getitem__,
     keylist)’.  (Contributed by Raymond Hettinger.)

   * Added a new opcode, ‘LIST_APPEND’, that simplifies the generated
     bytecode for list comprehensions and speeds them up by about a
     third.  (Contributed by Raymond Hettinger.)

   * The peephole bytecode optimizer has been improved to produce
     shorter, faster bytecode; remarkably, the resulting bytecode is
     more readable.  (Enhanced by Raymond Hettinger.)

   * String concatenations in statements of the form ‘s = s + "abc"’ and
     ‘s += "abc"’ are now performed more efficiently in certain
     circumstances.  This optimization won’t be present in other Python
     implementations such as Jython, so you shouldn’t rely on it; using
     the ‘join()’ method of strings is still recommended when you want
     to efficiently glue a large number of strings together.
     (Contributed by Armin Rigo.)

The net result of the 2.4 optimizations is that Python 2.4 runs the
pystone benchmark around 5% faster than Python 2.3 and 35% faster than
Python 2.2.  (pystone is not a particularly good benchmark, but it’s the
most commonly used measurement of Python’s performance.  Your own
applications may show greater or smaller benefits from Python 2.4.)


File: python.info,  Node: New Improved and Deprecated Modules<3>,  Next: Build and C API Changes<11>,  Prev: Other Language Changes<12>,  Up: What’s New in Python 2 4

1.13.12 New, Improved, and Deprecated Modules
---------------------------------------------

As usual, Python’s standard library received a number of enhancements
and bug fixes.  Here’s a partial list of the most notable changes,
sorted alphabetically by module name.  Consult the ‘Misc/NEWS’ file in
the source tree for a more complete list of changes, or look through the
CVS logs for all the details.

   * The *note asyncore: b. module’s ‘loop()’ function now has a `count'
     parameter that lets you perform a limited number of passes through
     the polling loop.  The default is still to loop forever.

   * The *note base64: e. module now has more complete RFC 3548(1)
     support for Base64, Base32, and Base16 encoding and decoding,
     including optional case folding and optional alternative alphabets.
     (Contributed by Barry Warsaw.)

   * The *note bisect: 12. module now has an underlying C implementation
     for improved performance.  (Contributed by Dmitry Vasiliev.)

   * The CJKCodecs collections of East Asian codecs, maintained by
     Hye-Shik Chang, was integrated into 2.4.  The new encodings are:

   * Chinese (PRC): gb2312, gbk, gb18030, big5hkscs, hz

   * Chinese (ROC): big5, cp950

   * 
     Japanese: cp932, euc-jis-2004, euc-jp, euc-jisx0213, iso-2022-jp,

          iso-2022-jp-1, iso-2022-jp-2, iso-2022-jp-3, iso-2022-jp-ext,
          iso-2022-jp-2004, shift-jis, shift-jisx0213, shift-jis-2004

   * Korean: cp949, euc-kr, johab, iso-2022-kr

   * Some other new encodings were added: HP Roman8, ISO_8859-11,
     ISO_8859-16, PCTP-154, and TIS-620.

   * The UTF-8 and UTF-16 codecs now cope better with receiving partial
     input.  Previously the ‘StreamReader’ class would try to read more
     data, making it impossible to resume decoding from the stream.  The
     ‘read()’ method will now return as much data as it can and future
     calls will resume decoding where previous ones left off.
     (Implemented by Walter Dörwald.)

   * There is a new *note collections: 1e. module for various
     specialized collection datatypes.  Currently it contains just one
     type, ‘deque’, a double-ended queue that supports efficiently
     adding and removing elements from either end:

          >>> from collections import deque
          >>> d = deque('ghi')        # make a new deque with three items
          >>> d.append('j')           # add a new entry to the right side
          >>> d.appendleft('f')       # add a new entry to the left side
          >>> d                       # show the representation of the deque
          deque(['f', 'g', 'h', 'i', 'j'])
          >>> d.pop()                 # return and remove the rightmost item
          'j'
          >>> d.popleft()             # return and remove the leftmost item
          'f'
          >>> list(d)                 # list the contents of the deque
          ['g', 'h', 'i']
          >>> 'h' in d                # search the deque
          True

     Several modules, such as the ‘Queue’ and *note threading: 109.
     modules, now take advantage of *note collections.deque: 526. for
     improved performance.  (Contributed by Raymond Hettinger.)

   * The ‘ConfigParser’ classes have been enhanced slightly.  The
     ‘read()’ method now returns a list of the files that were
     successfully parsed, and the *note set(): b62. method raises *note
     TypeError: 192. if passed a `value' argument that isn’t a string.
     (Contributed by John Belmonte and David Goodger.)

   * The *note curses: 2c. module now supports the ncurses extension
     ‘use_default_colors()’.  On platforms where the terminal supports
     transparency, this makes it possible to use a transparent
     background.  (Contributed by Jörg Lehmann.)

   * The *note difflib: 37. module now includes an ‘HtmlDiff’ class that
     creates an HTML table showing a side by side comparison of two
     versions of a text.  (Contributed by Dan Gass.)

   * The *note email: 69. package was updated to version 3.0, which
     dropped various deprecated APIs and removes support for Python
     versions earlier than 2.3.  The 3.0 version of the package uses a
     new incremental parser for MIME messages, available in the
     ‘email.FeedParser’ module.  The new parser doesn’t require reading
     the entire message into memory, and doesn’t raise exceptions if a
     message is malformed; instead it records any problems in the
     ‘defect’ attribute of the message.  (Developed by Anthony Baxter,
     Barry Warsaw, Thomas Wouters, and others.)

   * The *note heapq: 8e. module has been converted to C. The resulting
     tenfold improvement in speed makes the module suitable for handling
     high volumes of data.  In addition, the module has two new
     functions ‘nlargest()’ and ‘nsmallest()’ that use heaps to find the
     N largest or smallest values in a dataset without the expense of a
     full sort.  (Contributed by Raymond Hettinger.)

   * The ‘httplib’ module now contains constants for HTTP status codes
     defined in various HTTP-related RFC documents.  Constants have
     names such as ‘OK’, ‘CREATED’, ‘CONTINUE’, and ‘MOVED_PERMANENTLY’;
     use pydoc to get a full list.  (Contributed by Andrew Eland.)

   * The *note imaplib: 98. module now supports IMAP’s THREAD command
     (contributed by Yves Dionne) and new ‘deleteacl()’ and ‘myrights()’
     methods (contributed by Arnaud Mazin).

   * The *note itertools: a3. module gained a ‘groupby(iterable[,
     *func*])’ function.  `iterable' is something that can be iterated
     over to return a stream of elements, and the optional `func'
     parameter is a function that takes an element and returns a key
     value; if omitted, the key is simply the element itself.
     ‘groupby()’ then groups the elements into subsequences which have
     matching values of the key, and returns a series of 2-tuples
     containing the key value and an iterator over the subsequence.

     Here’s an example to make this clearer.  The `key' function simply
     returns whether a number is even or odd, so the result of
     ‘groupby()’ is to return consecutive runs of odd or even numbers.

          >>> import itertools
          >>> L = [2, 4, 6, 7, 8, 9, 11, 12, 14]
          >>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
          ...    print key_val, list(it)
          ...
          0 [2, 4, 6]
          1 [7]
          0 [8]
          1 [9, 11]
          0 [12, 14]
          >>>

     ‘groupby()’ is typically used with sorted input.  The logic for
     ‘groupby()’ is similar to the Unix ‘uniq’ filter which makes it
     handy for eliminating, counting, or identifying duplicate elements:

          >>> word = 'abracadabra'
          >>> letters = sorted(word)   # Turn string into a sorted list of letters
          >>> letters
          ['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
          >>> for k, g in itertools.groupby(letters):
          ...    print k, list(g)
          ...
          a ['a', 'a', 'a', 'a', 'a']
          b ['b', 'b']
          c ['c']
          d ['d']
          r ['r', 'r']
          >>> # List unique letters
          >>> [k for k, g in groupby(letters)]
          ['a', 'b', 'c', 'd', 'r']
          >>> # Count letter occurrences
          >>> [(k, len(list(g))) for k, g in groupby(letters)]
          [('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]

     (Contributed by Hye-Shik Chang.)

   * *note itertools: a3. also gained a function named ‘tee(iterator,
     N)’ that returns `N' independent iterators that replicate
     `iterator'.  If `N' is omitted, the default is 2.

          >>> L = [1,2,3]
          >>> i1, i2 = itertools.tee(L)
          >>> i1,i2
          (<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
          >>> list(i1)               # Run the first iterator to exhaustion
          [1, 2, 3]
          >>> list(i2)               # Run the second iterator to exhaustion
          [1, 2, 3]

     Note that ‘tee()’ has to keep copies of the values returned by the
     iterator; in the worst case, it may need to keep all of them.  This
     should therefore be used carefully if the leading iterator can run
     far ahead of the trailing iterator in a long stream of inputs.  If
     the separation is large, then you might as well use *note list():
     260. instead.  When the iterators track closely with one another,
     ‘tee()’ is ideal.  Possible applications include bookmarking,
     windowing, or lookahead iterators.  (Contributed by Raymond
     Hettinger.)

   * A number of functions were added to the *note locale: a9. module,
     such as ‘bind_textdomain_codeset()’ to specify a particular
     encoding and a family of ‘l*gettext()’ functions that return
     messages in the chosen encoding.  (Contributed by Gustavo
     Niemeyer.)

   * Some keyword arguments were added to the *note logging: aa.
     package’s ‘basicConfig()’ function to simplify log configuration.
     The default behavior is to log messages to standard error, but
     various keyword arguments can be specified to log to a particular
     file, change the logging format, or set the logging level.  For
     example:

          import logging
          logging.basicConfig(filename='/var/log/application.log',
              level=0,  # Log all messages
              format='%(levelname):%(process):%(thread):%(message)')

     Other additions to the *note logging: aa. package include a
     ‘log(level, msg)’ convenience method, as well as a
     ‘TimedRotatingFileHandler’ class that rotates its log files at a
     timed interval.  The module already had ‘RotatingFileHandler’,
     which rotated logs once the file exceeded a certain size.  Both
     classes derive from a new ‘BaseRotatingHandler’ class that can be
     used to implement other rotating handlers.

     (Changes implemented by Vinay Sajip.)

   * The *note marshal: b0. module now shares interned strings on
     unpacking a data structure.  This may shrink the size of certain
     pickle strings, but the primary effect is to make ‘.pyc’ files
     significantly smaller.  (Contributed by Martin von Löwis.)

   * The *note nntplib: c0. module’s ‘NNTP’ class gained ‘description()’
     and ‘descriptions()’ methods to retrieve newsgroup descriptions for
     a single group or for a range of groups.  (Contributed by Jürgen A.
     Erhard.)

   * Two new functions were added to the *note operator: c2. module,
     ‘attrgetter(attr)’ and ‘itemgetter(index)’.  Both functions return
     callables that take a single argument and return the corresponding
     attribute or item; these callables make excellent data extractors
     when used with *note map(): c20. or *note sorted(): 439.  For
     example:

          >>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
          >>> map(operator.itemgetter(0), L)
          ['c', 'd', 'a', 'b']
          >>> map(operator.itemgetter(1), L)
          [2, 1, 4, 3]
          >>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
          [('d', 1), ('c', 2), ('b', 3), ('a', 4)]

     (Contributed by Raymond Hettinger.)

   * The *note optparse: c3. module was updated in various ways.  The
     module now passes its messages through *note gettext.gettext():
     dc0, making it possible to internationalize Optik’s help and error
     messages.  Help messages for options can now include the string
     ‘'%default'’, which will be replaced by the option’s default value.
     (Contributed by Greg Ward.)

   * The long-term plan is to deprecate the ‘rfc822’ module in some
     future Python release in favor of the *note email: 69. package.  To
     this end, the ‘email.Utils.formatdate()’ function has been changed
     to make it usable as a replacement for ‘rfc822.formatdate()’.  You
     may want to write new e-mail processing code with this in mind.
     (Change implemented by Anthony Baxter.)

   * A new ‘urandom(n)’ function was added to the *note os: c4. module,
     returning a string containing `n' bytes of random data.  This
     function provides access to platform-specific sources of randomness
     such as ‘/dev/urandom’ on Linux or the Windows CryptoAPI.
     (Contributed by Trevor Perrin.)

   * Another new function: ‘os.path.lexists(path)’ returns true if the
     file specified by `path' exists, whether or not it’s a symbolic
     link.  This differs from the existing ‘os.path.exists(path)’
     function, which returns false if `path' is a symlink that points to
     a destination that doesn’t exist.  (Contributed by Beni
     Cherniavsky.)

   * A new ‘getsid()’ function was added to the *note posix: d1. module
     that underlies the *note os: c4. module.  (Contributed by J.
     Raynor.)

   * The *note poplib: d0. module now supports POP over SSL.
     (Contributed by Hector Urtubia.)

   * The *note profile: d3. module can now profile C extension
     functions.  (Contributed by Nick Bastin.)

   * The *note random: dc. module has a new method called
     ‘getrandbits(N)’ that returns a long integer `N' bits in length.
     The existing ‘randrange()’ method now uses ‘getrandbits()’ where
     appropriate, making generation of arbitrarily large random numbers
     more efficient.  (Contributed by Raymond Hettinger.)

   * The regular expression language accepted by the *note re: dd.
     module was extended with simple conditional expressions, written as
     ‘(?(group)A|B)’.  `group' is either a numeric group ID or a group
     name defined with ‘(?P<group>...)’ earlier in the expression.  If
     the specified group matched, the regular expression pattern `A'
     will be tested against the string; if the group didn’t match, the
     pattern `B' will be used instead.  (Contributed by Gustavo
     Niemeyer.)

   * The *note re: dd. module is also no longer recursive, thanks to a
     massive amount of work by Gustavo Niemeyer.  In a recursive regular
     expression engine, certain patterns result in a large amount of C
     stack space being consumed, and it was possible to overflow the
     stack.  For example, if you matched a 30000-byte string of ‘a’
     characters against the expression ‘(a|b)+’, one stack frame was
     consumed per character.  Python 2.3 tried to check for stack
     overflow and raise a *note RuntimeError: 2b8. exception, but
     certain patterns could sidestep the checking and if you were
     unlucky Python could segfault.  Python 2.4’s regular expression
     engine can match this pattern without problems.

   * The *note signal: ea. module now performs tighter error-checking on
     the parameters to the *note signal.signal(): a72. function.  For
     example, you can’t set a handler on the ‘SIGKILL’ signal; previous
     versions of Python would quietly accept this, but 2.4 will raise a
     *note RuntimeError: 2b8. exception.

   * Two new functions were added to the *note socket: ef. module.
     ‘socketpair()’ returns a pair of connected sockets and
     ‘getservbyport(port)’ looks up the service name for a given port
     number.  (Contributed by Dave Cole and Barry Warsaw.)

   * The ‘sys.exitfunc()’ function has been deprecated.  Code should be
     using the existing *note atexit: c. module, which correctly handles
     calling multiple exit functions.  Eventually ‘sys.exitfunc()’ will
     become a purely internal interface, accessed only by *note atexit:
     c.

   * The *note tarfile: 101. module now generates GNU-format tar files
     by default.  (Contributed by Lars Gustäbel.)

   * The *note threading: 109. module now has an elegantly simple way to
     support thread-local data.  The module contains a ‘local’ class
     whose attribute values are local to different threads.

          import threading

          data = threading.local()
          data.number = 42
          data.url = ('www.python.org', 80)

     Other threads can assign and retrieve their own values for the
     ‘number’ and ‘url’ attributes.  You can subclass ‘local’ to
     initialize attributes or to add methods.  (Contributed by Jim
     Fulton.)

   * The *note timeit: 10b. module now automatically disables periodic
     garbage collection during the timing loop.  This change makes
     consecutive timings more comparable.  (Contributed by Raymond
     Hettinger.)

   * The *note weakref: 128. module now supports a wider variety of
     objects including Python functions, class instances, sets,
     frozensets, deques, arrays, files, sockets, and regular expression
     pattern objects.  (Contributed by Raymond Hettinger.)

   * The ‘xmlrpclib’ module now supports a multi-call extension for
     transmitting multiple XML-RPC calls in a single HTTP operation.
     (Contributed by Brian Quinlan.)

   * The ‘mpz’, ‘rotor’, and ‘xreadlines’ modules have been removed.

* Menu:

* cookielib::
* doctest: doctest<3>.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3548.html


File: python.info,  Node: cookielib,  Next: doctest<3>,  Up: New Improved and Deprecated Modules<3>

1.13.12.1 cookielib
...................

The ‘cookielib’ library supports client-side handling for HTTP cookies,
mirroring the ‘Cookie’ module’s server-side cookie support.  Cookies are
stored in cookie jars; the library transparently stores cookies offered
by the web server in the cookie jar, and fetches the cookie from the jar
when connecting to the server.  As in web browsers, policy objects
control whether cookies are accepted or not.

In order to store cookies across sessions, two implementations of cookie
jars are provided: one that stores cookies in the Netscape format so
applications can use the Mozilla or Lynx cookie files, and one that
stores cookies in the same format as the Perl libwww library.

‘urllib2’ has been changed to interact with ‘cookielib’:
‘HTTPCookieProcessor’ manages a cookie jar that is used when accessing
URLs.

This module was contributed by John J. Lee.


File: python.info,  Node: doctest<3>,  Prev: cookielib,  Up: New Improved and Deprecated Modules<3>

1.13.12.2 doctest
.................

The *note doctest: 67. module underwent considerable refactoring thanks
to Edward Loper and Tim Peters.  Testing can still be as simple as
running *note doctest.testmod(): dc3, but the refactorings allow
customizing the module’s operation in various ways

The new ‘DocTestFinder’ class extracts the tests from a given object’s
docstrings:

     def f (x, y):
         """>>> f(2,2)
     4
     >>> f(3,2)
     6
         """
         return x*y

     finder = doctest.DocTestFinder()

     # Get list of DocTest instances
     tests = finder.find(f)

The new ‘DocTestRunner’ class then runs individual tests and can produce
a summary of the results:

     runner = doctest.DocTestRunner()
     for t in tests:
         tried, failed = runner.run(t)

     runner.summarize(verbose=1)

The above example produces the following output:

     1 items passed all tests:
        2 tests in f
     2 tests in 1 items.
     2 passed and 0 failed.
     Test passed.

‘DocTestRunner’ uses an instance of the ‘OutputChecker’ class to compare
the expected output with the actual output.  This class takes a number
of different flags that customize its behaviour; ambitious users can
also write a completely new subclass of ‘OutputChecker’.

The default output checker provides a number of handy features.  For
example, with the *note doctest.ELLIPSIS: dc4. option flag, an ellipsis
(‘...’) in the expected output matches any substring, making it easier
to accommodate outputs that vary in minor ways:

     def o (n):
         """>>> o(1)
     <__main__.C instance at 0x...>
     >>>
     """

Another special string, ‘<BLANKLINE>’, matches a blank line:

     def p (n):
         """>>> p(1)
     <BLANKLINE>
     >>>
     """

Another new capability is producing a diff-style display of the output
by specifying the *note doctest.REPORT_UDIFF: dc5. (unified diffs),
*note doctest.REPORT_CDIFF: dc6. (context diffs), or *note
doctest.REPORT_NDIFF: dc7. (delta-style) option flags.  For example:

     def g (n):
         """>>> g(4)
     here
     is
     a
     lengthy
     >>>"""
         L = 'here is a rather lengthy list of words'.split()
         for word in L[:n]:
             print word

Running the above function’s tests with *note doctest.REPORT_UDIFF: dc5.
specified, you get the following output:

     **********************************************************************
     File "t.py", line 15, in g
     Failed example:
         g(4)
     Differences (unified diff with -expected +actual):
         @@ -2,3 +2,3 @@
          is
          a
         -lengthy
         +rather
     **********************************************************************


File: python.info,  Node: Build and C API Changes<11>,  Next: Porting to Python 2 4,  Prev: New Improved and Deprecated Modules<3>,  Up: What’s New in Python 2 4

1.13.13 Build and C API Changes
-------------------------------

Some of the changes to Python’s build process and to the C API are:

   * Three new convenience macros were added for common return values
     from extension functions: *note Py_RETURN_NONE: dc9, *note
     Py_RETURN_TRUE: dca, and *note Py_RETURN_FALSE: dcb.  (Contributed
     by Brett Cannon.)

   * Another new macro, ‘Py_CLEAR(obj)’, decreases the reference count
     of `obj' and sets `obj' to the null pointer.  (Contributed by Jim
     Fulton.)

   * A new function, ‘PyTuple_Pack(N, obj1, obj2, ..., objN)’,
     constructs tuples from a variable length argument list of Python
     objects.  (Contributed by Raymond Hettinger.)

   * A new function, ‘PyDict_Contains(d, k)’, implements fast dictionary
     lookups without masking exceptions raised during the look-up
     process.  (Contributed by Raymond Hettinger.)

   * The ‘Py_IS_NAN(X)’ macro returns 1 if its float or double argument
     `X' is a NaN. (Contributed by Tim Peters.)

   * C code can avoid unnecessary locking by using the new *note
     PyEval_ThreadsInitialized(): dcc. function to tell if any thread
     operations have been performed.  If this function returns false, no
     lock operations are needed.  (Contributed by Nick Coghlan.)

   * A new function, *note PyArg_VaParseTupleAndKeywords(): dcd, is the
     same as *note PyArg_ParseTupleAndKeywords(): 5bf. but takes a
     ‘va_list’ instead of a number of arguments.  (Contributed by Greg
     Chapman.)

   * A new method flag, ‘METH_COEXISTS’, allows a function defined in
     slots to co-exist with a *note PyCFunction: dce. having the same
     name.  This can halve the access time for a method such as
     ‘set.__contains__()’.  (Contributed by Raymond Hettinger.)

   * Python can now be built with additional profiling for the
     interpreter itself, intended as an aid to people developing the
     Python core.  Providing ‘--enable-profiling’ to the ‘configure’
     script will let you profile the interpreter with ‘gprof’, and
     providing the ‘--with-tsc’ switch enables profiling using the
     Pentium’s Time-Stamp-Counter register.  Note that the ‘--with-tsc’
     switch is slightly misnamed, because the profiling feature also
     works on the PowerPC platform, though that processor architecture
     doesn’t call that register “the TSC register”.  (Contributed by
     Jeremy Hylton.)

   * The ‘tracebackobject’ type has been renamed to ‘PyTracebackObject’.

* Menu:

* Port-Specific Changes: Port-Specific Changes<2>.


File: python.info,  Node: Port-Specific Changes<2>,  Up: Build and C API Changes<11>

1.13.13.1 Port-Specific Changes
...............................

   * The Windows port now builds under MSVC++ 7.1 as well as version 6.
     (Contributed by Martin von Löwis.)


File: python.info,  Node: Porting to Python 2 4,  Next: Acknowledgements<4>,  Prev: Build and C API Changes<11>,  Up: What’s New in Python 2 4

1.13.14 Porting to Python 2.4
-----------------------------

This section lists previously described changes that may require changes
to your code:

   * Left shifts and hexadecimal/octal constants that are too large no
     longer trigger a *note FutureWarning: 31a. and return a value
     limited to 32 or 64 bits; instead they return a long integer.

   * Integer operations will no longer trigger an ‘OverflowWarning’.
     The ‘OverflowWarning’ warning will disappear in Python 2.5.

   * The *note zip(): c25. built-in function and ‘itertools.izip()’ now
     return an empty list instead of raising a *note TypeError: 192.
     exception if called with no arguments.

   * You can no longer compare the ‘date’ and *note datetime: 194.
     instances provided by the *note datetime: 31. module.  Two
     instances of different classes will now always be unequal, and
     relative comparisons (‘<’, ‘>’) will raise a *note TypeError: 192.

   * ‘dircache.listdir()’ now passes exceptions to the caller instead of
     returning empty lists.

   * ‘LexicalHandler.startDTD()’ used to receive the public and system
     IDs in the wrong order.  This has been corrected; applications
     relying on the wrong order need to be fixed.

   * *note fcntl.ioctl(): dd1. now warns if the `mutate' argument is
     omitted and relevant.

   * The *note tarfile: 101. module now generates GNU-format tar files
     by default.

   * Encountering a failure while importing a module no longer leaves a
     partially-initialized module object in ‘sys.modules’.

   * *note None: 157. is now a constant; code that binds a new value to
     the name ‘None’ is now a syntax error.

   * The ‘signals.signal()’ function now raises a *note RuntimeError:
     2b8. exception for certain illegal values; previously these errors
     would pass silently.  For example, you can no longer set a handler
     on the ‘SIGKILL’ signal.


File: python.info,  Node: Acknowledgements<4>,  Prev: Porting to Python 2 4,  Up: What’s New in Python 2 4

1.13.15 Acknowledgements
------------------------

The author would like to thank the following people for offering
suggestions, corrections and assistance with various drafts of this
article: Koray Can, Hye-Shik Chang, Michael Dyck, Raymond Hettinger,
Brian Hurt, Hamish Lawson, Fredrik Lundh, Sean Reifschneider, Sadruddin
Rejeb.


File: python.info,  Node: What’s New in Python 2 3,  Next: What’s New in Python 2 2,  Prev: What’s New in Python 2 4,  Up: What’s New in Python

1.14 What’s New in Python 2.3
=============================


Author: A.M. Kuchling

This article explains the new features in Python 2.3.  Python 2.3 was
released on July 29, 2003.

The main themes for Python 2.3 are polishing some of the features added
in 2.2, adding various small but useful enhancements to the core
language, and expanding the standard library.  The new object model
introduced in the previous version has benefited from 18 months of
bugfixes and from optimization efforts that have improved the
performance of new-style classes.  A few new built-in functions have
been added such as *note sum(): 1e3. and *note enumerate(): dd6.  The
*note in: 797. operator can now be used for substring searches (e.g.
‘"ab" in "abc"’ returns *note True: 48f.).

Some of the many new library features include Boolean, set, heap, and
date/time data types, the ability to import modules from ZIP-format
archives, metadata support for the long-awaited Python catalog, an
updated version of IDLE, and modules for logging messages, wrapping
text, parsing CSV files, processing command-line options, using
BerkeleyDB databases… the list of new and enhanced modules is lengthy.

This article doesn’t attempt to provide a complete specification of the
new features, but instead provides a convenient overview.  For full
details, you should refer to the documentation for Python 2.3, such as
the Python Library Reference and the Python Reference Manual.  If you
want to understand the complete implementation and design rationale,
refer to the PEP for a particular new feature.

* Menu:

* PEP 218; A Standard Set Datatype: PEP 218 A Standard Set Datatype.
* PEP 255; Simple Generators: PEP 255 Simple Generators.
* PEP 263; Source Code Encodings: PEP 263 Source Code Encodings.
* PEP 273; Importing Modules from ZIP Archives: PEP 273 Importing Modules from ZIP Archives.
* PEP 277; Unicode file name support for Windows NT: PEP 277 Unicode file name support for Windows NT.
* PEP 278; Universal Newline Support: PEP 278 Universal Newline Support.
* PEP 279; enumerate(): PEP 279 enumerate.
* PEP 282; The logging Package: PEP 282 The logging Package.
* PEP 285; A Boolean Type: PEP 285 A Boolean Type.
* PEP 293; Codec Error Handling Callbacks: PEP 293 Codec Error Handling Callbacks.
* PEP 301; Package Index and Metadata for Distutils: PEP 301 Package Index and Metadata for Distutils.
* PEP 302; New Import Hooks: PEP 302 New Import Hooks.
* PEP 305; Comma-separated Files: PEP 305 Comma-separated Files.
* PEP 307; Pickle Enhancements: PEP 307 Pickle Enhancements.
* Extended Slices::
* Other Language Changes: Other Language Changes<13>.
* New, Improved, and Deprecated Modules: New Improved and Deprecated Modules<4>.
* Pymalloc; A Specialized Object Allocator: Pymalloc A Specialized Object Allocator.
* Build and C API Changes: Build and C API Changes<12>.
* Other Changes and Fixes: Other Changes and Fixes<2>.
* Porting to Python 2.3: Porting to Python 2 3.
* Acknowledgements: Acknowledgements<5>.


File: python.info,  Node: PEP 218 A Standard Set Datatype,  Next: PEP 255 Simple Generators,  Up: What’s New in Python 2 3

1.14.1 PEP 218: A Standard Set Datatype
---------------------------------------

The new ‘sets’ module contains an implementation of a set datatype.  The
‘Set’ class is for mutable sets, sets that can have members added and
removed.  The ‘ImmutableSet’ class is for sets that can’t be modified,
and instances of ‘ImmutableSet’ can therefore be used as dictionary
keys.  Sets are built on top of dictionaries, so the elements within a
set must be hashable.

Here’s a simple example:

     >>> import sets
     >>> S = sets.Set([1,2,3])
     >>> S
     Set([1, 2, 3])
     >>> 1 in S
     True
     >>> 0 in S
     False
     >>> S.add(5)
     >>> S.remove(3)
     >>> S
     Set([1, 2, 5])
     >>>

The union and intersection of sets can be computed with the ‘union()’
and ‘intersection()’ methods; an alternative notation uses the bitwise
operators ‘&’ and ‘|’.  Mutable sets also have in-place versions of
these methods, ‘union_update()’ and ‘intersection_update()’.

     >>> S1 = sets.Set([1,2,3])
     >>> S2 = sets.Set([4,5,6])
     >>> S1.union(S2)
     Set([1, 2, 3, 4, 5, 6])
     >>> S1 | S2                  # Alternative notation
     Set([1, 2, 3, 4, 5, 6])
     >>> S1.intersection(S2)
     Set([])
     >>> S1 & S2                  # Alternative notation
     Set([])
     >>> S1.union_update(S2)
     >>> S1
     Set([1, 2, 3, 4, 5, 6])
     >>>

It’s also possible to take the symmetric difference of two sets.  This
is the set of all elements in the union that aren’t in the intersection.
Another way of putting it is that the symmetric difference contains all
elements that are in exactly one set.  Again, there’s an alternative
notation (‘^’), and an in-place version with the ungainly name
‘symmetric_difference_update()’.

     >>> S1 = sets.Set([1,2,3,4])
     >>> S2 = sets.Set([3,4,5,6])
     >>> S1.symmetric_difference(S2)
     Set([1, 2, 5, 6])
     >>> S1 ^ S2
     Set([1, 2, 5, 6])
     >>>

There are also ‘issubset()’ and ‘issuperset()’ methods for checking
whether one set is a subset or superset of another:

     >>> S1 = sets.Set([1,2,3])
     >>> S2 = sets.Set([2,3])
     >>> S2.issubset(S1)
     True
     >>> S1.issubset(S2)
     False
     >>> S1.issuperset(S2)
     True
     >>>

See also
........

PEP 218(1) - Adding a Built-In Set Object Type

     PEP written by Greg V. Wilson.  Implemented by Greg V. Wilson, Alex
     Martelli, and GvR.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0218


File: python.info,  Node: PEP 255 Simple Generators,  Next: PEP 263 Source Code Encodings,  Prev: PEP 218 A Standard Set Datatype,  Up: What’s New in Python 2 3

1.14.2 PEP 255: Simple Generators
---------------------------------

In Python 2.2, generators were added as an optional feature, to be
enabled by a ‘from __future__ import generators’ directive.  In 2.3
generators no longer need to be specially enabled, and are now always
present; this means that *note yield: 18f. is now always a keyword.  The
rest of this section is a copy of the description of generators from the
“What’s New in Python 2.2” document; if you read it back when Python 2.2
came out, you can skip the rest of this section.

You’re doubtless familiar with how function calls work in Python or C.
When you call a function, it gets a private namespace where its local
variables are created.  When the function reaches a *note return: 190.
statement, the local variables are destroyed and the resulting value is
returned to the caller.  A later call to the same function will get a
fresh new set of local variables.  But, what if the local variables
weren’t thrown away on exiting a function?  What if you could later
resume the function where it left off?  This is what generators provide;
they can be thought of as resumable functions.

Here’s the simplest example of a generator function:

     def generate_ints(N):
         for i in range(N):
             yield i

A new keyword, *note yield: 18f, was introduced for generators.  Any
function containing a ‘yield’ statement is a generator function; this is
detected by Python’s bytecode compiler which compiles the function
specially as a result.

When you call a generator function, it doesn’t return a single value;
instead it returns a generator object that supports the iterator
protocol.  On executing the *note yield: 18f. statement, the generator
outputs the value of ‘i’, similar to a *note return: 190. statement.
The big difference between ‘yield’ and a ‘return’ statement is that on
reaching a ‘yield’ the generator’s state of execution is suspended and
local variables are preserved.  On the next call to the generator’s
‘.next()’ method, the function will resume executing immediately after
the ‘yield’ statement.  (For complicated reasons, the ‘yield’ statement
isn’t allowed inside the *note try: d65. block of a ‘try’…‘finally’
statement; read PEP 255(1) for a full explanation of the interaction
between ‘yield’ and exceptions.)

Here’s a sample usage of the ‘generate_ints()’ generator:

     >>> gen = generate_ints(3)
     >>> gen
     <generator object at 0x8117f90>
     >>> gen.next()
     0
     >>> gen.next()
     1
     >>> gen.next()
     2
     >>> gen.next()
     Traceback (most recent call last):
       File "stdin", line 1, in ?
       File "stdin", line 2, in generate_ints
     StopIteration

You could equally write ‘for i in generate_ints(5)’, or ‘a,b,c =
generate_ints(3)’.

Inside a generator function, the *note return: 190. statement can only
be used without a value, and signals the end of the procession of
values; afterwards the generator cannot return any further values.
‘return’ with a value, such as ‘return 5’, is a syntax error inside a
generator function.  The end of the generator’s results can also be
indicated by raising *note StopIteration: 47b. manually, or by just
letting the flow of execution fall off the bottom of the function.

You could achieve the effect of generators manually by writing your own
class and storing all the local variables of the generator as instance
variables.  For example, returning a list of integers could be done by
setting ‘self.count’ to 0, and having the *note next(): 676. method
increment ‘self.count’ and return it.  However, for a moderately
complicated generator, writing a corresponding class would be much
messier.  ‘Lib/test/test_generators.py’ contains a number of more
interesting examples.  The simplest one implements an in-order traversal
of a tree using generators recursively.

     # A recursive generator that generates Tree leaves in in-order.
     def inorder(t):
         if t:
             for x in inorder(t.left):
                 yield x
             yield t.label
             for x in inorder(t.right):
                 yield x

Two other examples in ‘Lib/test/test_generators.py’ produce solutions
for the N-Queens problem (placing $N$ queens on an $NxN$ chess board so
that no queen threatens another) and the Knight’s Tour (a route that
takes a knight to every square of an $NxN$ chessboard without visiting
any square twice).

The idea of generators comes from other programming languages,
especially Icon (‘https://www.cs.arizona.edu/icon/’), where the idea of
generators is central.  In Icon, every expression and function call
behaves like a generator.  One example from “An Overview of the Icon
Programming Language” at
‘https://www.cs.arizona.edu/icon/docs/ipd266.htm’ gives an idea of what
this looks like:

     sentence := "Store it in the neighboring harbor"
     if (i := find("or", sentence)) > 5 then write(i)

In Icon the ‘find()’ function returns the indexes at which the substring
“or” is found: 3, 23, 33.  In the *note if: dda. statement, ‘i’ is first
assigned a value of 3, but 3 is less than 5, so the comparison fails,
and Icon retries it with the second value of 23.  23 is greater than 5,
so the comparison now succeeds, and the code prints the value 23 to the
screen.

Python doesn’t go nearly as far as Icon in adopting generators as a
central concept.  Generators are considered part of the core Python
language, but learning or using them isn’t compulsory; if they don’t
solve any problems that you have, feel free to ignore them.  One novel
feature of Python’s interface as compared to Icon’s is that a
generator’s state is represented as a concrete object (the iterator)
that can be passed around to other functions or stored in a data
structure.

See also
........

PEP 255(2) - Simple Generators

     Written by Neil Schemenauer, Tim Peters, Magnus Lie Hetland.
     Implemented mostly by Neil Schemenauer and Tim Peters, with other
     fixes from the Python Labs crew.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0255

   (2) https://www.python.org/dev/peps/pep-0255


File: python.info,  Node: PEP 263 Source Code Encodings,  Next: PEP 273 Importing Modules from ZIP Archives,  Prev: PEP 255 Simple Generators,  Up: What’s New in Python 2 3

1.14.3 PEP 263: Source Code Encodings
-------------------------------------

Python source files can now be declared as being in different character
set encodings.  Encodings are declared by including a specially
formatted comment in the first or second line of the source file.  For
example, a UTF-8 file can be declared with:

     #!/usr/bin/env python
     # -*- coding: UTF-8 -*-

Without such an encoding declaration, the default encoding used is 7-bit
ASCII. Executing or importing modules that contain string literals with
8-bit characters and have no encoding declaration will result in a *note
DeprecationWarning: 276. being signalled by Python 2.3; in 2.4 this will
be a syntax error.

The encoding declaration only affects Unicode string literals, which
will be converted to Unicode using the specified encoding.  Note that
Python identifiers are still restricted to ASCII characters, so you
can’t have variable names that use characters outside of the usual
alphanumerics.

See also
........

PEP 263(1) - Defining Python Source Code Encodings

     Written by Marc-André Lemburg and Martin von Löwis; implemented by
     Suzuki Hisao and Martin von Löwis.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0263


File: python.info,  Node: PEP 273 Importing Modules from ZIP Archives,  Next: PEP 277 Unicode file name support for Windows NT,  Prev: PEP 263 Source Code Encodings,  Up: What’s New in Python 2 3

1.14.4 PEP 273: Importing Modules from ZIP Archives
---------------------------------------------------

The new *note zipimport: 143. module adds support for importing modules
from a ZIP-format archive.  You don’t need to import the module
explicitly; it will be automatically imported if a ZIP archive’s
filename is added to ‘sys.path’.  For example:

     amk@nyman:~/src/python$ unzip -l /tmp/example.zip
     Archive:  /tmp/example.zip
       Length     Date   Time    Name
      --------    ----   ----    ----
          8467  11-26-02 22:30   jwzthreading.py
      --------                   -------
          8467                   1 file
     amk@nyman:~/src/python$ ./python
     Python 2.3 (#1, Aug 1 2003, 19:54:32)
     >>> import sys
     >>> sys.path.insert(0, '/tmp/example.zip')  # Add .zip file to front of path
     >>> import jwzthreading
     >>> jwzthreading.__file__
     '/tmp/example.zip/jwzthreading.py'
     >>>

An entry in ‘sys.path’ can now be the filename of a ZIP archive.  The
ZIP archive can contain any kind of files, but only files named ‘*.py’,
‘*.pyc’, or ‘*.pyo’ can be imported.  If an archive only contains ‘*.py’
files, Python will not attempt to modify the archive by adding the
corresponding ‘*.pyc’ file, meaning that if a ZIP archive doesn’t
contain ‘*.pyc’ files, importing may be rather slow.

A path within the archive can also be specified to only import from a
subdirectory; for example, the path ‘/tmp/example.zip/lib/’ would only
import from the ‘lib/’ subdirectory within the archive.

See also
........

PEP 273(1) - Import Modules from Zip Archives

     Written by James C. Ahlstrom, who also provided an implementation.
     Python 2.3 follows the specification in PEP 273(2), but uses an
     implementation written by Just van Rossum that uses the import
     hooks described in PEP 302(3).  See section *note PEP 302; New
     Import Hooks: dde. for a description of the new import hooks.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0273

   (2) https://www.python.org/dev/peps/pep-0273

   (3) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: PEP 277 Unicode file name support for Windows NT,  Next: PEP 278 Universal Newline Support,  Prev: PEP 273 Importing Modules from ZIP Archives,  Up: What’s New in Python 2 3

1.14.5 PEP 277: Unicode file name support for Windows NT
--------------------------------------------------------

On Windows NT, 2000, and XP, the system stores file names as Unicode
strings.  Traditionally, Python has represented file names as byte
strings, which is inadequate because it renders some file names
inaccessible.

Python now allows using arbitrary Unicode strings (within the
limitations of the file system) for all functions that expect file
names, most notably the *note open(): 4e5. built-in function.  If a
Unicode string is passed to *note os.listdir(): a36, Python now returns
a list of Unicode strings.  A new function, ‘os.getcwdu()’, returns the
current directory as a Unicode string.

Byte strings still work as file names, and on Windows Python will
transparently convert them to Unicode using the ‘mbcs’ encoding.

Other systems also allow Unicode strings as file names but convert them
to byte strings before passing them to the system, which can cause a
*note UnicodeError: c2e. to be raised.  Applications can test whether
arbitrary Unicode strings are supported as file names by checking *note
os.path.supports_unicode_filenames: de0, a Boolean value.

Under MacOS, *note os.listdir(): a36. may now return Unicode filenames.

See also
........

PEP 277(1) - Unicode file name support for Windows NT

     Written by Neil Hodgson; implemented by Neil Hodgson, Martin von
     Löwis, and Mark Hammond.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0277


File: python.info,  Node: PEP 278 Universal Newline Support,  Next: PEP 279 enumerate,  Prev: PEP 277 Unicode file name support for Windows NT,  Up: What’s New in Python 2 3

1.14.6 PEP 278: Universal Newline Support
-----------------------------------------

The three major operating systems used today are Microsoft Windows,
Apple’s Macintosh OS, and the various Unix derivatives.  A minor
irritation of cross-platform work is that these three platforms all use
different characters to mark the ends of lines in text files.  Unix uses
the linefeed (ASCII character 10), MacOS uses the carriage return (ASCII
character 13), and Windows uses a two-character sequence of a carriage
return plus a newline.

Python’s file objects can now support end of line conventions other than
the one followed by the platform on which Python is running.  Opening a
file with the mode ‘'U'’ or ‘'rU'’ will open a file for reading in *note
universal newlines: 5e9. mode.  All three line ending conventions will
be translated to a ‘'\n'’ in the strings returned by the various file
methods such as ‘read()’ and *note readline(): de.

Universal newline support is also used when importing modules and when
executing a file with the ‘execfile()’ function.  This means that Python
modules can be shared between all three operating systems without
needing to convert the line-endings.

This feature can be disabled when compiling Python by specifying the
‘--without-universal-newlines’ switch when running Python’s ‘configure’
script.

See also
........

PEP 278(1) - Universal Newline Support

     Written and implemented by Jack Jansen.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0278


File: python.info,  Node: PEP 279 enumerate,  Next: PEP 282 The logging Package,  Prev: PEP 278 Universal Newline Support,  Up: What’s New in Python 2 3

1.14.7 PEP 279: enumerate()
---------------------------

A new built-in function, *note enumerate(): dd6, will make certain loops
a bit clearer.  ‘enumerate(thing)’, where `thing' is either an iterator
or a sequence, returns an iterator that will return ‘(0, thing[0])’,
‘(1, thing[1])’, ‘(2, thing[2])’, and so forth.

A common idiom to change every element of a list looks like this:

     for i in range(len(L)):
         item = L[i]
         # ... compute some result based on item ...
         L[i] = result

This can be rewritten using *note enumerate(): dd6. as:

     for i, item in enumerate(L):
         # ... compute some result based on item ...
         L[i] = result

See also
........

PEP 279(1) - The enumerate() built-in function

     Written and implemented by Raymond D. Hettinger.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0279


File: python.info,  Node: PEP 282 The logging Package,  Next: PEP 285 A Boolean Type,  Prev: PEP 279 enumerate,  Up: What’s New in Python 2 3

1.14.8 PEP 282: The logging Package
-----------------------------------

A standard package for writing logs, *note logging: aa, has been added
to Python 2.3.  It provides a powerful and flexible mechanism for
generating logging output which can then be filtered and processed in
various ways.  A configuration file written in a standard format can be
used to control the logging behavior of a program.  Python includes
handlers that will write log records to standard error or to a file or
socket, send them to the system log, or even e-mail them to a particular
address; of course, it’s also possible to write your own handler
classes.

The ‘Logger’ class is the primary class.  Most application code will
deal with one or more ‘Logger’ objects, each one used by a particular
subsystem of the application.  Each ‘Logger’ is identified by a name,
and names are organized into a hierarchy using ‘.’ as the component
separator.  For example, you might have ‘Logger’ instances named
‘server’, ‘server.auth’ and ‘server.network’.  The latter two instances
are below ‘server’ in the hierarchy.  This means that if you turn up the
verbosity for ‘server’ or direct ‘server’ messages to a different
handler, the changes will also apply to records logged to ‘server.auth’
and ‘server.network’.  There’s also a root ‘Logger’ that’s the parent of
all other loggers.

For simple uses, the *note logging: aa. package contains some
convenience functions that always use the root log:

     import logging

     logging.debug('Debugging information')
     logging.info('Informational message')
     logging.warning('Warning:config file %s not found', 'server.conf')
     logging.error('Error occurred')
     logging.critical('Critical error -- shutting down')

This produces the following output:

     WARNING:root:Warning:config file server.conf not found
     ERROR:root:Error occurred
     CRITICAL:root:Critical error -- shutting down

In the default configuration, informational and debugging messages are
suppressed and the output is sent to standard error.  You can enable the
display of informational and debugging messages by calling the
‘setLevel()’ method on the root logger.

Notice the ‘warning()’ call’s use of string formatting operators; all of
the functions for logging messages take the arguments ‘(msg, arg1, arg2,
...)’ and log the string resulting from ‘msg % (arg1, arg2, ...)’.

There’s also an ‘exception()’ function that records the most recent
traceback.  Any of the other functions will also record the traceback if
you specify a true value for the keyword argument `exc_info'.

     def f():
         try:    1/0
         except: logging.exception('Problem recorded')

     f()

This produces the following output:

     ERROR:root:Problem recorded
     Traceback (most recent call last):
       File "t.py", line 6, in f
         1/0
     ZeroDivisionError: integer division or modulo by zero

Slightly more advanced programs will use a logger other than the root
logger.  The ‘getLogger(name)’ function is used to get a particular log,
creating it if it doesn’t exist yet.  ‘getLogger(None)’ returns the root
logger.

     log = logging.getLogger('server')
      ...
     log.info('Listening on port %i', port)
      ...
     log.critical('Disk full')
      ...

Log records are usually propagated up the hierarchy, so a message logged
to ‘server.auth’ is also seen by ‘server’ and ‘root’, but a ‘Logger’ can
prevent this by setting its ‘propagate’ attribute to *note False: 37d.

There are more classes provided by the *note logging: aa. package that
can be customized.  When a ‘Logger’ instance is told to log a message,
it creates a ‘LogRecord’ instance that is sent to any number of
different ‘Handler’ instances.  Loggers and handlers can also have an
attached list of filters, and each filter can cause the ‘LogRecord’ to
be ignored or can modify the record before passing it along.  When
they’re finally output, ‘LogRecord’ instances are converted to text by a
‘Formatter’ class.  All of these classes can be replaced by your own
specially-written classes.

With all of these features the *note logging: aa. package should provide
enough flexibility for even the most complicated applications.  This is
only an incomplete overview of its features, so please see the package’s
reference documentation for all of the details.  Reading PEP 282(1) will
also be helpful.

See also
........

PEP 282(2) - A Logging System

     Written by Vinay Sajip and Trent Mick; implemented by Vinay Sajip.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0282

   (2) https://www.python.org/dev/peps/pep-0282


File: python.info,  Node: PEP 285 A Boolean Type,  Next: PEP 293 Codec Error Handling Callbacks,  Prev: PEP 282 The logging Package,  Up: What’s New in Python 2 3

1.14.9 PEP 285: A Boolean Type
------------------------------

A Boolean type was added to Python 2.3.  Two new constants were added to
the ‘__builtin__’ module, *note True: 48f. and *note False: 37d.  (*note
True: 48f. and *note False: 37d. constants were added to the built-ins
in Python 2.2.1, but the 2.2.1 versions are simply set to integer values
of 1 and 0 and aren’t a different type.)

The type object for this new type is named *note bool: 183.; the
constructor for it takes any Python value and converts it to *note True:
48f. or *note False: 37d.

     >>> bool(1)
     True
     >>> bool(0)
     False
     >>> bool([])
     False
     >>> bool( (1,) )
     True

Most of the standard library modules and built-in functions have been
changed to return Booleans.

     >>> obj = []
     >>> hasattr(obj, 'append')
     True
     >>> isinstance(obj, list)
     True
     >>> isinstance(obj, tuple)
     False

Python’s Booleans were added with the primary goal of making code
clearer.  For example, if you’re reading a function and encounter the
statement ‘return 1’, you might wonder whether the ‘1’ represents a
Boolean truth value, an index, or a coefficient that multiplies some
other quantity.  If the statement is ‘return True’, however, the meaning
of the return value is quite clear.

Python’s Booleans were `not' added for the sake of strict type-checking.
A very strict language such as Pascal would also prevent you performing
arithmetic with Booleans, and would require that the expression in an
*note if: dda. statement always evaluate to a Boolean result.  Python is
not this strict and never will be, as PEP 285(1) explicitly says.  This
means you can still use any expression in an ‘if’ statement, even ones
that evaluate to a list or tuple or some random object.  The Boolean
type is a subclass of the *note int: 184. class so that arithmetic using
a Boolean still works.

     >>> True + 1
     2
     >>> False + 1
     1
     >>> False * 75
     0
     >>> True * 75
     75

To sum up *note True: 48f. and *note False: 37d. in a sentence: they’re
alternative ways to spell the integer values 1 and 0, with the single
difference that *note str(): 325. and *note repr(): 7c0. return the
strings ‘'True'’ and ‘'False'’ instead of ‘'1'’ and ‘'0'’.

See also
........

PEP 285(2) - Adding a bool type

     Written and implemented by GvR.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0285

   (2) https://www.python.org/dev/peps/pep-0285


File: python.info,  Node: PEP 293 Codec Error Handling Callbacks,  Next: PEP 301 Package Index and Metadata for Distutils,  Prev: PEP 285 A Boolean Type,  Up: What’s New in Python 2 3

1.14.10 PEP 293: Codec Error Handling Callbacks
-----------------------------------------------

When encoding a Unicode string into a byte string, unencodable
characters may be encountered.  So far, Python has allowed specifying
the error processing as either “strict” (raising *note UnicodeError:
c2e.), “ignore” (skipping the character), or “replace” (using a question
mark in the output string), with “strict” being the default behavior.
It may be desirable to specify alternative processing of such errors,
such as inserting an XML character reference or HTML entity reference
into the converted string.

Python now has a flexible framework to add different processing
strategies.  New error handlers can be added with *note
codecs.register_error(): de8, and codecs then can access the error
handler with *note codecs.lookup_error(): de9.  An equivalent C API has
been added for codecs written in C. The error handler gets the necessary
state information such as the string being converted, the position in
the string where the error was detected, and the target encoding.  The
handler can then either raise an exception or return a replacement
string.

Two additional error handlers have been implemented using this
framework: “backslashreplace” uses Python backslash quoting to represent
unencodable characters and “xmlcharrefreplace” emits XML character
references.

See also
........

PEP 293(1) - Codec Error Handling Callbacks

     Written and implemented by Walter Dörwald.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0293


File: python.info,  Node: PEP 301 Package Index and Metadata for Distutils,  Next: PEP 302 New Import Hooks,  Prev: PEP 293 Codec Error Handling Callbacks,  Up: What’s New in Python 2 3

1.14.11 PEP 301: Package Index and Metadata for Distutils
---------------------------------------------------------

Support for the long-requested Python catalog makes its first appearance
in 2.3.

The heart of the catalog is the new Distutils ‘register’ command.
Running ‘python setup.py register’ will collect the metadata describing
a package, such as its name, version, maintainer, description, &c., and
send it to a central catalog server.  The resulting catalog is available
from ‘https://pypi.org’.

To make the catalog a bit more useful, a new optional `classifiers'
keyword argument has been added to the Distutils ‘setup()’ function.  A
list of Trove(1)-style strings can be supplied to help classify the
software.

Here’s an example ‘setup.py’ with classifiers, written to be compatible
with older versions of the Distutils:

     from distutils import core
     kw = {'name': "Quixote",
           'version': "0.5.1",
           'description': "A highly Pythonic Web application framework",
           # ...
           }

     if (hasattr(core, 'setup_keywords') and
         'classifiers' in core.setup_keywords):
         kw['classifiers'] = \
             ['Topic :: Internet :: WWW/HTTP :: Dynamic Content',
              'Environment :: No Input/Output (Daemon)',
              'Intended Audience :: Developers'],

     core.setup(**kw)

The full list of classifiers can be obtained by running ‘python setup.py
register --list-classifiers’.

See also
........

PEP 301(2) - Package Index and Metadata for Distutils

     Written and implemented by Richard Jones.

   ---------- Footnotes ----------

   (1) http://catb.org/~esr/trove/

   (2) https://www.python.org/dev/peps/pep-0301


File: python.info,  Node: PEP 302 New Import Hooks,  Next: PEP 305 Comma-separated Files,  Prev: PEP 301 Package Index and Metadata for Distutils,  Up: What’s New in Python 2 3

1.14.12 PEP 302: New Import Hooks
---------------------------------

While it’s been possible to write custom import hooks ever since the
‘ihooks’ module was introduced in Python 1.3, no one has ever been
really happy with it because writing new import hooks is difficult and
messy.  There have been various proposed alternatives such as the
‘imputil’ and ‘iu’ modules, but none of them has ever gained much
acceptance, and none of them were easily usable from C code.

PEP 302(1) borrows ideas from its predecessors, especially from Gordon
McMillan’s ‘iu’ module.  Three new items are added to the *note sys: fd.
module:

   * ‘sys.path_hooks’ is a list of callable objects; most often they’ll
     be classes.  Each callable takes a string containing a path and
     either returns an importer object that will handle imports from
     this path or raises an *note ImportError: 329. exception if it
     can’t handle this path.

   * ‘sys.path_importer_cache’ caches importer objects for each path, so
     ‘sys.path_hooks’ will only need to be traversed once for each path.

   * ‘sys.meta_path’ is a list of importer objects that will be
     traversed before ‘sys.path’ is checked.  This list is initially
     empty, but user code can add objects to it.  Additional built-in
     and frozen modules can be imported by an object added to this list.

Importer objects must have a single method, ‘find_module(fullname,
path=None)’.  `fullname' will be a module or package name, e.g.
‘string’ or ‘distutils.core’.  ‘find_module()’ must return a loader
object that has a single method, ‘load_module(fullname)’, that creates
and returns the corresponding module object.

Pseudo-code for Python’s new import logic, therefore, looks something
like this (simplified a bit; see PEP 302(2) for the full details):

     for mp in sys.meta_path:
         loader = mp(fullname)
         if loader is not None:
             <module> = loader.load_module(fullname)

     for path in sys.path:
         for hook in sys.path_hooks:
             try:
                 importer = hook(path)
             except ImportError:
                 # ImportError, so try the other path hooks
                 pass
             else:
                 loader = importer.find_module(fullname)
                 <module> = loader.load_module(fullname)

     # Not found!
     raise ImportError

See also
........

PEP 302(3) - New Import Hooks

     Written by Just van Rossum and Paul Moore.  Implemented by Just van
     Rossum.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0302

   (2) https://www.python.org/dev/peps/pep-0302

   (3) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: PEP 305 Comma-separated Files,  Next: PEP 307 Pickle Enhancements,  Prev: PEP 302 New Import Hooks,  Up: What’s New in Python 2 3

1.14.13 PEP 305: Comma-separated Files
--------------------------------------

Comma-separated files are a format frequently used for exporting data
from databases and spreadsheets.  Python 2.3 adds a parser for
comma-separated files.

Comma-separated format is deceptively simple at first glance:

     Costs,150,200,3.95

Read a line and call ‘line.split(',')’: what could be simpler?  But toss
in string data that can contain commas, and things get more complicated:

     "Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"

A big ugly regular expression can parse this, but using the new *note
csv: 2a. package is much simpler:

     import csv

     input = open('datafile', 'rb')
     reader = csv.reader(input)
     for line in reader:
         print line

The ‘reader()’ function takes a number of different options.  The field
separator isn’t limited to the comma and can be changed to any
character, and so can the quoting and line-ending characters.

Different dialects of comma-separated files can be defined and
registered; currently there are two dialects, both used by Microsoft
Excel.  A separate *note csv.writer: def. class will generate
comma-separated files from a succession of tuples or lists, quoting
strings that contain the delimiter.

See also
........

PEP 305(1) - CSV File API

     Written and implemented by Kevin Altis, Dave Cole, Andrew McNamara,
     Skip Montanaro, Cliff Wells.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0305


File: python.info,  Node: PEP 307 Pickle Enhancements,  Next: Extended Slices,  Prev: PEP 305 Comma-separated Files,  Up: What’s New in Python 2 3

1.14.14 PEP 307: Pickle Enhancements
------------------------------------

The *note pickle: ca. and ‘cPickle’ modules received some attention
during the 2.3 development cycle.  In 2.2, new-style classes could be
pickled without difficulty, but they weren’t pickled very compactly; PEP
307(1) quotes a trivial example where a new-style class results in a
pickled string three times longer than that for a classic class.

The solution was to invent a new pickle protocol.  The *note
pickle.dumps(): df2. function has supported a text-or-binary flag for a
long time.  In 2.3, this flag is redefined from a Boolean to an integer:
0 is the old text-mode pickle format, 1 is the old binary format, and
now 2 is a new 2.3-specific format.  A new constant, *note
pickle.HIGHEST_PROTOCOL: df3, can be used to select the fanciest
protocol available.

Unpickling is no longer considered a safe operation.  2.2’s *note
pickle: ca. provided hooks for trying to prevent unsafe classes from
being unpickled (specifically, a ‘__safe_for_unpickling__’ attribute),
but none of this code was ever audited and therefore it’s all been
ripped out in 2.3.  You should not unpickle untrusted data in any
version of Python.

To reduce the pickling overhead for new-style classes, a new interface
for customizing pickling was added using three special methods: *note
__getstate__(): df4, *note __setstate__(): 19b, and *note
__getnewargs__(): 6a2.  Consult PEP 307(2) for the full semantics of
these methods.

As a way to compress pickles yet further, it’s now possible to use
integer codes instead of long strings to identify pickled classes.  The
Python Software Foundation will maintain a list of standardized codes;
there’s also a range of codes for private use.  Currently no codes have
been specified.

See also
........

PEP 307(3) - Extensions to the pickle protocol

     Written and implemented by Guido van Rossum and Tim Peters.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0307

   (2) https://www.python.org/dev/peps/pep-0307

   (3) https://www.python.org/dev/peps/pep-0307


File: python.info,  Node: Extended Slices,  Next: Other Language Changes<13>,  Prev: PEP 307 Pickle Enhancements,  Up: What’s New in Python 2 3

1.14.15 Extended Slices
-----------------------

Ever since Python 1.4, the slicing syntax has supported an optional
third “step” or “stride” argument.  For example, these are all legal
Python syntax: ‘L[1:10:2]’, ‘L[:-1:1]’, ‘L[::-1]’.  This was added to
Python at the request of the developers of Numerical Python, which uses
the third argument extensively.  However, Python’s built-in list, tuple,
and string sequence types have never supported this feature, raising a
*note TypeError: 192. if you tried it.  Michael Hudson contributed a
patch to fix this shortcoming.

For example, you can now easily extract the elements of a list that have
even indexes:

     >>> L = range(10)
     >>> L[::2]
     [0, 2, 4, 6, 8]

Negative values also work to make a copy of the same list in reverse
order:

     >>> L[::-1]
     [9, 8, 7, 6, 5, 4, 3, 2, 1, 0]

This also works for tuples, arrays, and strings:

     >>> s='abcd'
     >>> s[::2]
     'ac'
     >>> s[::-1]
     'dcba'

If you have a mutable sequence such as a list or an array you can assign
to or delete an extended slice, but there are some differences between
assignment to extended and regular slices.  Assignment to a regular
slice can be used to change the length of the sequence:

     >>> a = range(3)
     >>> a
     [0, 1, 2]
     >>> a[1:3] = [4, 5, 6]
     >>> a
     [0, 4, 5, 6]

Extended slices aren’t this flexible.  When assigning to an extended
slice, the list on the right hand side of the statement must contain the
same number of items as the slice it is replacing:

     >>> a = range(4)
     >>> a
     [0, 1, 2, 3]
     >>> a[::2]
     [0, 2]
     >>> a[::2] = [0, -1]
     >>> a
     [0, 1, -1, 3]
     >>> a[::2] = [0,1,2]
     Traceback (most recent call last):
       File "<stdin>", line 1, in ?
     ValueError: attempt to assign sequence of size 3 to extended slice of size 2

Deletion is more straightforward:

     >>> a = range(4)
     >>> a
     [0, 1, 2, 3]
     >>> a[::2]
     [0, 2]
     >>> del a[::2]
     >>> a
     [1, 3]

One can also now pass slice objects to the *note __getitem__(): 27a.
methods of the built-in sequences:

     >>> range(10).__getitem__(slice(0, 5, 2))
     [0, 2, 4]

Or use slice objects directly in subscripts:

     >>> range(10)[slice(0, 5, 2)]
     [0, 2, 4]

To simplify implementing sequences that support extended slicing, slice
objects now have a method ‘indices(length)’ which, given the length of a
sequence, returns a ‘(start, stop, step)’ tuple that can be passed
directly to *note range(): 9b2.  ‘indices()’ handles omitted and
out-of-bounds indices in a manner consistent with regular slices (and
this innocuous phrase hides a welter of confusing details!).  The method
is intended to be used like this:

     class FakeSeq:
         ...
         def calc_item(self, i):
             ...
         def __getitem__(self, item):
             if isinstance(item, slice):
                 indices = item.indices(len(self))
                 return FakeSeq([self.calc_item(i) for i in range(*indices)])
             else:
                 return self.calc_item(i)

From this example you can also see that the built-in *note slice: df7.
object is now the type object for the slice type, and is no longer a
function.  This is consistent with Python 2.2, where *note int: 184,
*note str: 325, etc., underwent the same change.


File: python.info,  Node: Other Language Changes<13>,  Next: New Improved and Deprecated Modules<4>,  Prev: Extended Slices,  Up: What’s New in Python 2 3

1.14.16 Other Language Changes
------------------------------

Here are all of the changes that Python 2.3 makes to the core Python
language.

   * The *note yield: 18f. statement is now always a keyword, as
     described in section *note PEP 255; Simple Generators: dd9. of this
     document.

   * A new built-in function *note enumerate(): dd6. was added, as
     described in section *note PEP 279; enumerate(): de3. of this
     document.

   * Two new constants, *note True: 48f. and *note False: 37d. were
     added along with the built-in *note bool: 183. type, as described
     in section *note PEP 285; A Boolean Type: de6. of this document.

   * The *note int(): 184. type constructor will now return a long
     integer instead of raising an *note OverflowError: 954. when a
     string or floating-point number is too large to fit into an
     integer.  This can lead to the paradoxical result that
     ‘isinstance(int(expression), int)’ is false, but that seems
     unlikely to cause problems in practice.

   * Built-in types now support the extended slicing syntax, as
     described in section *note Extended Slices: df6. of this document.

   * A new built-in function, ‘sum(iterable, start=0)’, adds up the
     numeric items in the iterable object and returns their sum.  *note
     sum(): 1e3. only accepts numbers, meaning that you can’t use it to
     concatenate a bunch of strings.  (Contributed by Alex Martelli.)

   * ‘list.insert(pos, value)’ used to insert `value' at the front of
     the list when `pos' was negative.  The behaviour has now been
     changed to be consistent with slice indexing, so when `pos' is -1
     the value will be inserted before the last element, and so forth.

   * ‘list.index(value)’, which searches for `value' within the list and
     returns its index, now takes optional `start' and `stop' arguments
     to limit the search to only part of the list.

   * Dictionaries have a new method, ‘pop(key[, *default*])’, that
     returns the value corresponding to `key' and removes that key/value
     pair from the dictionary.  If the requested key isn’t present in
     the dictionary, `default' is returned if it’s specified and *note
     KeyError: 2c5. raised if it isn’t.

          >>> d = {1:2}
          >>> d
          {1: 2}
          >>> d.pop(4)
          Traceback (most recent call last):
            File "stdin", line 1, in ?
          KeyError: 4
          >>> d.pop(1)
          2
          >>> d.pop(1)
          Traceback (most recent call last):
            File "stdin", line 1, in ?
          KeyError: 'pop(): dictionary is empty'
          >>> d
          {}
          >>>

     There’s also a new class method, ‘dict.fromkeys(iterable, value)’,
     that creates a dictionary with keys taken from the supplied
     iterator `iterable' and all values set to `value', defaulting to
     ‘None’.

     (Patches contributed by Raymond Hettinger.)

     Also, the *note dict(): 1b6. constructor now accepts keyword
     arguments to simplify creating small dictionaries:

          >>> dict(red=1, blue=2, green=3, black=4)
          {'blue': 2, 'black': 4, 'green': 3, 'red': 1}

     (Contributed by Just van Rossum.)

   * The *note assert: df9. statement no longer checks the ‘__debug__’
     flag, so you can no longer disable assertions by assigning to
     ‘__debug__’.  Running Python with the *note -O: 67f. switch will
     still generate code that doesn’t execute any assertions.

   * Most type objects are now callable, so you can use them to create
     new objects such as functions, classes, and modules.  (This means
     that the ‘new’ module can be deprecated in a future Python version,
     because you can now use the type objects available in the *note
     types: 118. module.)  For example, you can create a new module
     object with the following code:

          >>> import types
          >>> m = types.ModuleType('abc','docstring')
          >>> m
          <module 'abc' (built-in)>
          >>> m.__doc__
          'docstring'

   * A new warning, *note PendingDeprecationWarning: 277. was added to
     indicate features which are in the process of being deprecated.
     The warning will `not' be printed by default.  To check for use of
     features that will be deprecated in the future, supply *note
     -Walways;;PendingDeprecationWarning;;: 40c. on the command line or
     use *note warnings.filterwarnings(): dfa.

   * The process of deprecating string-based exceptions, as in ‘raise
     "Error occurred"’, has begun.  Raising a string will now trigger
     *note PendingDeprecationWarning: 277.

   * Using ‘None’ as a variable name will now result in a *note
     SyntaxWarning: 191. warning.  In a future version of Python, ‘None’
     may finally become a keyword.

   * The ‘xreadlines()’ method of file objects, introduced in Python
     2.1, is no longer necessary because files now behave as their own
     iterator.  ‘xreadlines()’ was originally introduced as a faster way
     to loop over all the lines in a file, but now you can simply write
     ‘for line in file_obj’.  File objects also have a new read-only
     ‘encoding’ attribute that gives the encoding used by the file;
     Unicode strings written to the file will be automatically converted
     to bytes using the given encoding.

   * The method resolution order used by new-style classes has changed,
     though you’ll only notice the difference if you have a really
     complicated inheritance hierarchy.  Classic classes are unaffected
     by this change.  Python 2.2 originally used a topological sort of a
     class’s ancestors, but 2.3 now uses the C3 algorithm as described
     in the paper "A Monotonic Superclass Linearization for Dylan"(1).
     To understand the motivation for this change, read Michele
     Simionato’s article "Python 2.3 Method Resolution Order"(2), or
     read the thread on python-dev starting with the message at
     ‘https://mail.python.org/pipermail/python-dev/2002-October/029035.html’.
     Samuele Pedroni first pointed out the problem and also implemented
     the fix by coding the C3 algorithm.

   * Python runs multithreaded programs by switching between threads
     after executing N bytecodes.  The default value for N has been
     increased from 10 to 100 bytecodes, speeding up single-threaded
     applications by reducing the switching overhead.  Some
     multithreaded applications may suffer slower response time, but
     that’s easily fixed by setting the limit back to a lower number
     using ‘sys.setcheckinterval(N)’.  The limit can be retrieved with
     the new *note sys.getcheckinterval(): dfb. function.

   * One minor but far-reaching change is that the names of extension
     types defined by the modules included with Python now contain the
     module and a ‘'.'’ in front of the type name.  For example, in
     Python 2.2, if you created a socket and printed its ‘__class__’,
     you’d get this output:

          >>> s = socket.socket()
          >>> s.__class__
          <type 'socket'>

     In 2.3, you get this:

          >>> s.__class__
          <type '_socket.socket'>

   * One of the noted incompatibilities between old- and new-style
     classes has been removed: you can now assign to the *note __name__:
     c5a. and *note __bases__: dfc. attributes of new-style classes.
     There are some restrictions on what can be assigned to *note
     __bases__: dfc. along the lines of those relating to assigning to
     an instance’s *note __class__: dfd. attribute.

* Menu:

* String Changes::
* Optimizations: Optimizations<12>.

   ---------- Footnotes ----------

   (1) http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.19.3910

   (2) http://www.phyast.pitt.edu/~micheles/mro.html


File: python.info,  Node: String Changes,  Next: Optimizations<12>,  Up: Other Language Changes<13>

1.14.16.1 String Changes
........................

   * The *note in: 797. operator now works differently for strings.
     Previously, when evaluating ‘X in Y’ where `X' and `Y' are strings,
     `X' could only be a single character.  That’s now changed; `X' can
     be a string of any length, and ‘X in Y’ will return *note True:
     48f. if `X' is a substring of `Y'. If `X' is the empty string, the
     result is always *note True: 48f.

          >>> 'ab' in 'abcd'
          True
          >>> 'ad' in 'abcd'
          False
          >>> '' in 'abcd'
          True

     Note that this doesn’t tell you where the substring starts; if you
     need that information, use the ‘find()’ string method.

   * The ‘strip()’, ‘lstrip()’, and ‘rstrip()’ string methods now have
     an optional argument for specifying the characters to strip.  The
     default is still to remove all whitespace characters:

          >>> '   abc '.strip()
          'abc'
          >>> '><><abc<><><>'.strip('<>')
          'abc'
          >>> '><><abc<><><>\n'.strip('<>')
          'abc<><><>\n'
          >>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
          u'\u4001abc'
          >>>

     (Suggested by Simon Brunning and implemented by Walter Dörwald.)

   * The ‘startswith()’ and ‘endswith()’ string methods now accept
     negative numbers for the `start' and `end' parameters.

   * Another new string method is ‘zfill()’, originally a function in
     the *note string: f6. module.  ‘zfill()’ pads a numeric string with
     zeros on the left until it’s the specified width.  Note that the
     ‘%’ operator is still more flexible and powerful than ‘zfill()’.

          >>> '45'.zfill(4)
          '0045'
          >>> '12345'.zfill(4)
          '12345'
          >>> 'goofy'.zfill(6)
          '0goofy'

     (Contributed by Walter Dörwald.)

   * A new type object, ‘basestring’, has been added.  Both 8-bit
     strings and Unicode strings inherit from this type, so
     ‘isinstance(obj, basestring)’ will return *note True: 48f. for
     either kind of string.  It’s a completely abstract type, so you
     can’t create ‘basestring’ instances.

   * Interned strings are no longer immortal and will now be
     garbage-collected in the usual way when the only reference to them
     is from the internal dictionary of interned strings.  (Implemented
     by Oren Tirosh.)


File: python.info,  Node: Optimizations<12>,  Prev: String Changes,  Up: Other Language Changes<13>

1.14.16.2 Optimizations
.......................

   * The creation of new-style class instances has been made much
     faster; they’re now faster than classic classes!

   * The ‘sort()’ method of list objects has been extensively rewritten
     by Tim Peters, and the implementation is significantly faster.

   * Multiplication of large long integers is now much faster thanks to
     an implementation of Karatsuba multiplication, an algorithm that
     scales better than the O(n*n) required for the grade-school
     multiplication algorithm.  (Original patch by Christopher A. Craig,
     and significantly reworked by Tim Peters.)

   * The ‘SET_LINENO’ opcode is now gone.  This may provide a small
     speed increase, depending on your compiler’s idiosyncrasies.  See
     section *note Other Changes and Fixes: e00. for a longer
     explanation.  (Removed by Michael Hudson.)

   * ‘xrange()’ objects now have their own iterator, making ‘for i in
     xrange(n)’ slightly faster than ‘for i in range(n)’.  (Patch by
     Raymond Hettinger.)

   * A number of small rearrangements have been made in various hotspots
     to improve performance, such as inlining a function or removing
     some code.  (Implemented mostly by GvR, but lots of people have
     contributed single changes.)

The net result of the 2.3 optimizations is that Python 2.3 runs the
pystone benchmark around 25% faster than Python 2.2.


File: python.info,  Node: New Improved and Deprecated Modules<4>,  Next: Pymalloc A Specialized Object Allocator,  Prev: Other Language Changes<13>,  Up: What’s New in Python 2 3

1.14.17 New, Improved, and Deprecated Modules
---------------------------------------------

As usual, Python’s standard library received a number of enhancements
and bug fixes.  Here’s a partial list of the most notable changes,
sorted alphabetically by module name.  Consult the ‘Misc/NEWS’ file in
the source tree for a more complete list of changes, or look through the
CVS logs for all the details.

   * The *note array: 7. module now supports arrays of Unicode
     characters using the ‘'u'’ format character.  Arrays also now
     support using the ‘+=’ assignment operator to add another array’s
     contents, and the ‘*=’ assignment operator to repeat an array.
     (Contributed by Jason Orendorff.)

   * The ‘bsddb’ module has been replaced by version 4.1.6 of the
     PyBSDDB(1) package, providing a more complete interface to the
     transactional features of the BerkeleyDB library.

     The old version of the module has been renamed to ‘bsddb185’ and is
     no longer built automatically; you’ll have to edit ‘Modules/Setup’
     to enable it.  Note that the new ‘bsddb’ package is intended to be
     compatible with the old module, so be sure to file bugs if you
     discover any incompatibilities.  When upgrading to Python 2.3, if
     the new interpreter is compiled with a new version of the
     underlying BerkeleyDB library, you will almost certainly have to
     convert your database files to the new version.  You can do this
     fairly easily with the new scripts ‘db2pickle.py’ and
     ‘pickle2db.py’ which you will find in the distribution’s
     ‘Tools/scripts’ directory.  If you’ve already been using the
     PyBSDDB package and importing it as ‘bsddb3’, you will have to
     change your ‘import’ statements to import it as ‘bsddb’.

   * The new *note bz2: 14. module is an interface to the bz2 data
     compression library.  bz2-compressed data is usually smaller than
     corresponding *note zlib: 144.-compressed data.  (Contributed by
     Gustavo Niemeyer.)

   * A set of standard date/time types has been added in the new *note
     datetime: 31. module.  See the following section for more details.

   * The Distutils ‘Extension’ class now supports an extra constructor
     argument named `depends' for listing additional source files that
     an extension depends on.  This lets Distutils recompile the module
     if any of the dependency files are modified.  For example, if
     ‘sampmodule.c’ includes the header file ‘sample.h’, you would
     create the ‘Extension’ object like this:

          ext = Extension("samp",
                          sources=["sampmodule.c"],
                          depends=["sample.h"])

     Modifying ‘sample.h’ would then cause the module to be recompiled.
     (Contributed by Jeremy Hylton.)

   * Other minor changes to Distutils: it now checks for the ‘CC’,
     ‘CFLAGS’, ‘CPP’, ‘LDFLAGS’, and ‘CPPFLAGS’ environment variables,
     using them to override the settings in Python’s configuration
     (contributed by Robert Weber).

   * Previously the *note doctest: 67. module would only search the
     docstrings of public methods and functions for test cases, but it
     now also examines private ones as well.  The ‘DocTestSuite()’
     function creates a *note unittest.TestSuite: 6c2. object from a set
     of *note doctest: 67. tests.

   * The new ‘gc.get_referents(object)’ function returns a list of all
     the objects referenced by `object'.

   * The *note getopt: 87. module gained a new function, ‘gnu_getopt()’,
     that supports the same arguments as the existing *note getopt():
     87. function but uses GNU-style scanning mode.  The existing *note
     getopt(): 87. stops processing options as soon as a non-option
     argument is encountered, but in GNU-style mode processing
     continues, meaning that options and arguments can be mixed.  For
     example:

          >>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
          ([('-f', 'filename')], ['output', '-v'])
          >>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
          ([('-f', 'filename'), ('-v', '')], ['output'])

     (Contributed by Peter Åstrand.)

   * The *note grp: 8b, *note pwd: d6, and *note resource: e0. modules
     now return enhanced tuples:

          >>> import grp
          >>> g = grp.getgrnam('amk')
          >>> g.gr_name, g.gr_gid
          ('amk', 500)

   * The *note gzip: 8c. module can now handle files exceeding 2 GiB.

   * The new *note heapq: 8e. module contains an implementation of a
     heap queue algorithm.  A heap is an array-like data structure that
     keeps items in a partially sorted order such that, for every index
     `k', ‘heap[k] <= heap[2*k+1]’ and ‘heap[k] <= heap[2*k+2]’.  This
     makes it quick to remove the smallest item, and inserting a new
     item while maintaining the heap property is O(lg n).  (See
     ‘https://xlinux.nist.gov/dads//HTML/priorityque.html’ for more
     information about the priority queue data structure.)

     The *note heapq: 8e. module provides ‘heappush()’ and ‘heappop()’
     functions for adding and removing items while maintaining the heap
     property on top of some other mutable Python sequence type.  Here’s
     an example that uses a Python list:

          >>> import heapq
          >>> heap = []
          >>> for item in [3, 7, 5, 11, 1]:
          ...    heapq.heappush(heap, item)
          ...
          >>> heap
          [1, 3, 5, 11, 7]
          >>> heapq.heappop(heap)
          1
          >>> heapq.heappop(heap)
          3
          >>> heap
          [5, 7, 11]

     (Contributed by Kevin O’Connor.)

   * The IDLE integrated development environment has been updated using
     the code from the IDLEfork project
     (‘http://idlefork.sourceforge.net’).  The most notable feature is
     that the code being developed is now executed in a subprocess,
     meaning that there’s no longer any need for manual ‘reload()’
     operations.  IDLE’s core code has been incorporated into the
     standard library as the ‘idlelib’ package.

   * The *note imaplib: 98. module now supports IMAP over SSL.
     (Contributed by Piers Lauder and Tino Lange.)

   * The *note itertools: a3. contains a number of useful functions for
     use with iterators, inspired by various functions provided by the
     ML and Haskell languages.  For example,
     ‘itertools.ifilter(predicate, iterator)’ returns all elements in
     the iterator for which the function ‘predicate()’ returns *note
     True: 48f, and ‘itertools.repeat(obj, N)’ returns ‘obj’ `N' times.
     There are a number of other functions in the module; see the
     package’s reference documentation for details.  (Contributed by
     Raymond Hettinger.)

   * Two new functions in the *note math: b1. module, ‘degrees(rads)’
     and ‘radians(degs)’, convert between radians and degrees.  Other
     functions in the *note math: b1. module such as *note math.sin():
     e02. and *note math.cos(): e03. have always required input values
     measured in radians.  Also, an optional `base' argument was added
     to *note math.log(): e04. to make it easier to compute logarithms
     for bases other than ‘e’ and ‘10’.  (Contributed by Raymond
     Hettinger.)

   * Several new POSIX functions (‘getpgid()’, ‘killpg()’, ‘lchown()’,
     ‘loadavg()’, ‘major()’, ‘makedev()’, ‘minor()’, and ‘mknod()’) were
     added to the *note posix: d1. module that underlies the *note os:
     c4. module.  (Contributed by Gustavo Niemeyer, Geert Jansen, and
     Denis S. Otkidach.)

   * In the *note os: c4. module, the ‘*stat()’ family of functions can
     now report fractions of a second in a timestamp.  Such time stamps
     are represented as floats, similar to the value returned by *note
     time.time(): 312.

     During testing, it was found that some applications will break if
     time stamps are floats.  For compatibility, when using the tuple
     interface of the ‘stat_result’ time stamps will be represented as
     integers.  When using named fields (a feature first introduced in
     Python 2.2), time stamps are still represented as integers, unless
     ‘os.stat_float_times()’ is invoked to enable float return values:

          >>> os.stat("/tmp").st_mtime
          1034791200
          >>> os.stat_float_times(True)
          >>> os.stat("/tmp").st_mtime
          1034791200.6335014

     In Python 2.4, the default will change to always returning floats.

     Application developers should enable this feature only if all their
     libraries work properly when confronted with floating point time
     stamps, or if they use the tuple API. If used, the feature should
     be activated on an application level instead of trying to enable it
     on a per-use basis.

   * The *note optparse: c3. module contains a new parser for
     command-line arguments that can convert option values to a
     particular Python type and will automatically generate a usage
     message.  See the following section for more details.

   * The old and never-documented ‘linuxaudiodev’ module has been
     deprecated, and a new version named *note ossaudiodev: c6. has been
     added.  The module was renamed because the OSS sound drivers can be
     used on platforms other than Linux, and the interface has also been
     tidied and brought up to date in various ways.  (Contributed by
     Greg Ward and Nicholas FitzRoy-Dale.)

   * The new *note platform: ce. module contains a number of functions
     that try to determine various properties of the platform you’re
     running on.  There are functions for getting the architecture, CPU
     type, the Windows OS version, and even the Linux distribution
     version.  (Contributed by Marc-André Lemburg.)

   * The parser objects provided by the ‘pyexpat’ module can now
     optionally buffer character data, resulting in fewer calls to your
     character data handler and therefore faster performance.  Setting
     the parser object’s ‘buffer_text’ attribute to *note True: 48f.
     will enable buffering.

   * The ‘sample(population, k)’ function was added to the *note random:
     dc. module.  `population' is a sequence or ‘xrange’ object
     containing the elements of a population, and ‘sample()’ chooses `k'
     elements from the population without replacing chosen elements.
     `k' can be any value up to ‘len(population)’.  For example:

          >>> days = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'St', 'Sn']
          >>> random.sample(days, 3)      # Choose 3 elements
          ['St', 'Sn', 'Th']
          >>> random.sample(days, 7)      # Choose 7 elements
          ['Tu', 'Th', 'Mo', 'We', 'St', 'Fr', 'Sn']
          >>> random.sample(days, 7)      # Choose 7 again
          ['We', 'Mo', 'Sn', 'Fr', 'Tu', 'St', 'Th']
          >>> random.sample(days, 8)      # Can't choose eight
          Traceback (most recent call last):
            File "<stdin>", line 1, in ?
            File "random.py", line 414, in sample
                raise ValueError, "sample larger than population"
          ValueError: sample larger than population
          >>> random.sample(xrange(1,10000,2), 10)   # Choose ten odd nos. under 10000
          [3407, 3805, 1505, 7023, 2401, 2267, 9733, 3151, 8083, 9195]

     The *note random: dc. module now uses a new algorithm, the Mersenne
     Twister, implemented in C. It’s faster and more extensively studied
     than the previous algorithm.

     (All changes contributed by Raymond Hettinger.)

   * The *note readline: de. module also gained a number of new
     functions: ‘get_history_item()’, ‘get_current_history_length()’,
     and ‘redisplay()’.

   * The ‘rexec’ and ‘Bastion’ modules have been declared dead, and
     attempts to import them will fail with a *note RuntimeError: 2b8.
     New-style classes provide new ways to break out of the restricted
     execution environment provided by ‘rexec’, and no one has interest
     in fixing them or time to do so.  If you have applications using
     ‘rexec’, rewrite them to use something else.

     (Sticking with Python 2.2 or 2.1 will not make your applications
     any safer because there are known bugs in the ‘rexec’ module in
     those versions.  To repeat: if you’re using ‘rexec’, stop using it
     immediately.)

   * The ‘rotor’ module has been deprecated because the algorithm it
     uses for encryption is not believed to be secure.  If you need
     encryption, use one of the several AES Python modules that are
     available separately.

   * The *note shutil: e9. module gained a ‘move(src, dest)’ function
     that recursively moves a file or directory to a new location.

   * Support for more advanced POSIX signal handling was added to the
     *note signal: ea. but then removed again as it proved impossible to
     make it work reliably across platforms.

   * The *note socket: ef. module now supports timeouts.  You can call
     the ‘settimeout(t)’ method on a socket object to set a timeout of
     `t' seconds.  Subsequent socket operations that take longer than
     `t' seconds to complete will abort and raise a *note
     socket.timeout: c01. exception.

     The original timeout implementation was by Tim O’Malley.  Michael
     Gilfix integrated it into the Python *note socket: ef. module and
     shepherded it through a lengthy review.  After the code was checked
     in, Guido van Rossum rewrote parts of it.  (This is a good example
     of a collaborative development process in action.)

   * On Windows, the *note socket: ef. module now ships with Secure
     Sockets Layer (SSL) support.

   * The value of the C ‘PYTHON_API_VERSION’ macro is now exposed at the
     Python level as ‘sys.api_version’.  The current exception can be
     cleared by calling the new ‘sys.exc_clear()’ function.

   * The new *note tarfile: 101. module allows reading from and writing
     to ‘tar’-format archive files.  (Contributed by Lars Gustäbel.)

   * The new *note textwrap: 108. module contains functions for wrapping
     strings containing paragraphs of text.  The ‘wrap(text, width)’
     function takes a string and returns a list containing the text
     split into lines of no more than the chosen width.  The ‘fill(text,
     width)’ function returns a single string, reformatted to fit into
     lines no longer than the chosen width.  (As you can guess, ‘fill()’
     is built on top of ‘wrap()’.  For example:

          >>> import textwrap
          >>> paragraph = "Not a whit, we defy augury: ... more text ..."
          >>> textwrap.wrap(paragraph, 60)
          ["Not a whit, we defy augury: there's a special providence in",
           "the fall of a sparrow. If it be now, 'tis not to come; if it",
           ...]
          >>> print textwrap.fill(paragraph, 35)
          Not a whit, we defy augury: there's
          a special providence in the fall of
          a sparrow. If it be now, 'tis not
          to come; if it be not to come, it
          will be now; if it be not now, yet
          it will come: the readiness is all.
          >>>

     The module also contains a ‘TextWrapper’ class that actually
     implements the text wrapping strategy.  Both the ‘TextWrapper’
     class and the ‘wrap()’ and ‘fill()’ functions support a number of
     additional keyword arguments for fine-tuning the formatting;
     consult the module’s documentation for details.  (Contributed by
     Greg Ward.)

   * The ‘thread’ and *note threading: 109. modules now have companion
     modules, ‘dummy_thread’ and *note dummy_threading: 68, that provide
     a do-nothing implementation of the ‘thread’ module’s interface for
     platforms where threads are not supported.  The intention is to
     simplify thread-aware modules (ones that `don’t' rely on threads to
     run) by putting the following code at the top:

          try:
              import threading as _threading
          except ImportError:
              import dummy_threading as _threading

     In this example, ‘_threading’ is used as the module name to make it
     clear that the module being used is not necessarily the actual
     *note threading: 109. module.  Code can call functions and use
     classes in ‘_threading’ whether or not threads are supported,
     avoiding an *note if: dda. statement and making the code slightly
     clearer.  This module will not magically make multithreaded code
     run without threads; code that waits for another thread to return
     or to do something will simply hang forever.

   * The *note time: 10a. module’s ‘strptime()’ function has long been
     an annoyance because it uses the platform C library’s ‘strptime()’
     implementation, and different platforms sometimes have odd bugs.
     Brett Cannon contributed a portable implementation that’s written
     in pure Python and should behave identically on all platforms.

   * The new *note timeit: 10b. module helps measure how long snippets
     of Python code take to execute.  The ‘timeit.py’ file can be run
     directly from the command line, or the module’s ‘Timer’ class can
     be imported and used directly.  Here’s a short example that figures
     out whether it’s faster to convert an 8-bit string to Unicode by
     appending an empty Unicode string to it or by using the ‘unicode()’
     function:

          import timeit

          timer1 = timeit.Timer('unicode("abc")')
          timer2 = timeit.Timer('"abc" + u""')

          # Run three trials
          print timer1.repeat(repeat=3, number=100000)
          print timer2.repeat(repeat=3, number=100000)

          # On my laptop this outputs:
          # [0.36831796169281006, 0.37441694736480713, 0.35304892063140869]
          # [0.17574405670166016, 0.18193507194519043, 0.17565798759460449]

   * The ‘Tix’ module has received various bug fixes and updates for the
     current version of the Tix package.

   * The ‘Tkinter’ module now works with a thread-enabled version of
     Tcl.  Tcl’s threading model requires that widgets only be accessed
     from the thread in which they’re created; accesses from another
     thread can cause Tcl to panic.  For certain Tcl interfaces,
     ‘Tkinter’ will now automatically avoid this when a widget is
     accessed from a different thread by marshalling a command, passing
     it to the correct thread, and waiting for the results.  Other
     interfaces can’t be handled automatically but ‘Tkinter’ will now
     raise an exception on such an access so that you can at least find
     out about the problem.  See
     ‘https://mail.python.org/pipermail/python-dev/2002-December/031107.html’
     for a more detailed explanation of this change.  (Implemented by
     Martin von Löwis.)

   * Calling Tcl methods through ‘_tkinter’ no longer returns only
     strings.  Instead, if Tcl returns other objects those objects are
     converted to their Python equivalent, if one exists, or wrapped
     with a ‘_tkinter.Tcl_Obj’ object if no Python equivalent exists.
     This behavior can be controlled through the ‘wantobjects()’ method
     of ‘tkapp’ objects.

     When using ‘_tkinter’ through the ‘Tkinter’ module (as most Tkinter
     applications will), this feature is always activated.  It should
     not cause compatibility problems, since Tkinter would always
     convert string results to Python types where possible.

     If any incompatibilities are found, the old behavior can be
     restored by setting the ‘wantobjects’ variable in the ‘Tkinter’
     module to false before creating the first ‘tkapp’ object.

          import Tkinter
          Tkinter.wantobjects = 0

     Any breakage caused by this change should be reported as a bug.

   * The ‘UserDict’ module has a new ‘DictMixin’ class which defines all
     dictionary methods for classes that already have a minimum mapping
     interface.  This greatly simplifies writing classes that need to be
     substitutable for dictionaries, such as the classes in the *note
     shelve: e7. module.

     Adding the mix-in as a superclass provides the full dictionary
     interface whenever the class defines *note __getitem__(): 27a,
     *note __setitem__(): c55, *note __delitem__(): c56, and ‘keys()’.
     For example:

          >>> import UserDict
          >>> class SeqDict(UserDict.DictMixin):
          ...     """Dictionary lookalike implemented with lists."""
          ...     def __init__(self):
          ...         self.keylist = []
          ...         self.valuelist = []
          ...     def __getitem__(self, key):
          ...         try:
          ...             i = self.keylist.index(key)
          ...         except ValueError:
          ...             raise KeyError
          ...         return self.valuelist[i]
          ...     def __setitem__(self, key, value):
          ...         try:
          ...             i = self.keylist.index(key)
          ...             self.valuelist[i] = value
          ...         except ValueError:
          ...             self.keylist.append(key)
          ...             self.valuelist.append(value)
          ...     def __delitem__(self, key):
          ...         try:
          ...             i = self.keylist.index(key)
          ...         except ValueError:
          ...             raise KeyError
          ...         self.keylist.pop(i)
          ...         self.valuelist.pop(i)
          ...     def keys(self):
          ...         return list(self.keylist)
          ...
          >>> s = SeqDict()
          >>> dir(s)      # See that other dictionary methods are implemented
          ['__cmp__', '__contains__', '__delitem__', '__doc__', '__getitem__',
           '__init__', '__iter__', '__len__', '__module__', '__repr__',
           '__setitem__', 'clear', 'get', 'has_key', 'items', 'iteritems',
           'iterkeys', 'itervalues', 'keylist', 'keys', 'pop', 'popitem',
           'setdefault', 'update', 'valuelist', 'values']

     (Contributed by Raymond Hettinger.)

   * The DOM implementation in *note xml.dom.minidom: 135. can now
     generate XML output in a particular encoding by providing an
     optional encoding argument to the ‘toxml()’ and ‘toprettyxml()’
     methods of DOM nodes.

   * The ‘xmlrpclib’ module now supports an XML-RPC extension for
     handling nil data values such as Python’s ‘None’.  Nil values are
     always supported on unmarshalling an XML-RPC response.  To generate
     requests containing ‘None’, you must supply a true value for the
     `allow_none' parameter when creating a ‘Marshaller’ instance.

   * The new ‘DocXMLRPCServer’ module allows writing self-documenting
     XML-RPC servers.  Run it in demo mode (as a program) to see it in
     action.  Pointing the Web browser to the RPC server produces
     pydoc-style documentation; pointing xmlrpclib to the server allows
     invoking the actual methods.  (Contributed by Brian Quinlan.)

   * Support for internationalized domain names (RFCs 3454, 3490, 3491,
     and 3492) has been added.  The “idna” encoding can be used to
     convert between a Unicode domain name and the ASCII-compatible
     encoding (ACE) of that name.

          >{}>{}> u"www.Alliancefrançaise.nu".encode("idna")
          'www.xn--alliancefranaise-npb.nu'

     The *note socket: ef. module has also been extended to
     transparently convert Unicode hostnames to the ACE version before
     passing them to the C library.  Modules that deal with hostnames
     such as ‘httplib’ and *note ftplib: 84.) also support Unicode host
     names; ‘httplib’ also sends HTTP ‘Host’ headers using the ACE
     version of the domain name.  *note urllib: 11d. supports Unicode
     URLs with non-ASCII host names as long as the ‘path’ part of the
     URL is ASCII only.

     To implement this change, the *note stringprep: f7. module, the
     ‘mkstringprep’ tool and the ‘punycode’ encoding have been added.

* Menu:

* Date/Time Type::
* The optparse Module::

   ---------- Footnotes ----------

   (1) http://pybsddb.sourceforge.net


File: python.info,  Node: Date/Time Type,  Next: The optparse Module,  Up: New Improved and Deprecated Modules<4>

1.14.17.1 Date/Time Type
........................

Date and time types suitable for expressing timestamps were added as the
*note datetime: 31. module.  The types don’t support different calendars
or many fancy features, and just stick to the basics of representing
time.

The three primary types are: ‘date’, representing a day, month, and
year; *note time: 4e8, consisting of hour, minute, and second; and *note
datetime: 194, which contains all the attributes of both ‘date’ and
*note time: 4e8.  There’s also a ‘timedelta’ class representing
differences between two points in time, and time zone logic is
implemented by classes inheriting from the abstract ‘tzinfo’ class.

You can create instances of ‘date’ and *note time: 4e8. by either
supplying keyword arguments to the appropriate constructor, e.g.
‘datetime.date(year=1972, month=10, day=15)’, or by using one of a
number of class methods.  For example, the ‘date.today()’ class method
returns the current local date.

Once created, instances of the date/time classes are all immutable.
There are a number of methods for producing formatted strings from
objects:

     >>> import datetime
     >>> now = datetime.datetime.now()
     >>> now.isoformat()
     '2002-12-30T21:27:03.994956'
     >>> now.ctime()  # Only available on date, datetime
     'Mon Dec 30 21:27:03 2002'
     >>> now.strftime('%Y %d %b')
     '2002 30 Dec'

The ‘replace()’ method allows modifying one or more fields of a ‘date’
or *note datetime: 194. instance, returning a new instance:

     >>> d = datetime.datetime.now()
     >>> d
     datetime.datetime(2002, 12, 30, 22, 15, 38, 827738)
     >>> d.replace(year=2001, hour = 12)
     datetime.datetime(2001, 12, 30, 12, 15, 38, 827738)
     >>>

Instances can be compared, hashed, and converted to strings (the result
is the same as that of ‘isoformat()’).  ‘date’ and *note datetime: 194.
instances can be subtracted from each other, and added to ‘timedelta’
instances.  The largest missing feature is that there’s no standard
library support for parsing strings and getting back a ‘date’ or *note
datetime: 194.

For more information, refer to the module’s reference documentation.
(Contributed by Tim Peters.)


File: python.info,  Node: The optparse Module,  Prev: Date/Time Type,  Up: New Improved and Deprecated Modules<4>

1.14.17.2 The optparse Module
.............................

The *note getopt: 87. module provides simple parsing of command-line
arguments.  The new *note optparse: c3. module (originally named Optik)
provides more elaborate command-line parsing that follows the Unix
conventions, automatically creates the output for ‘--help’, and can
perform different actions for different options.

You start by creating an instance of ‘OptionParser’ and telling it what
your program’s options are.

     import sys
     from optparse import OptionParser

     op = OptionParser()
     op.add_option('-i', '--input',
                   action='store', type='string', dest='input',
                   help='set input filename')
     op.add_option('-l', '--length',
                   action='store', type='int', dest='length',
                   help='set maximum length of output')

Parsing a command line is then done by calling the ‘parse_args()’
method.

     options, args = op.parse_args(sys.argv[1:])
     print options
     print args

This returns an object containing all of the option values, and a list
of strings containing the remaining arguments.

Invoking the script with the various arguments now works as you’d expect
it to.  Note that the length argument is automatically converted to an
integer.

     $ ./python opt.py -i data arg1
     <Values at 0x400cad4c: {'input': 'data', 'length': None}>
     ['arg1']
     $ ./python opt.py --input=data --length=4
     <Values at 0x400cad2c: {'input': 'data', 'length': 4}>
     []
     $

The help message is automatically generated for you:

     $ ./python opt.py --help
     usage: opt.py [options]

     options:
       -h, --help            show this help message and exit
       -iINPUT, --input=INPUT
                             set input filename
       -lLENGTH, --length=LENGTH
                             set maximum length of output
     $

See the module’s documentation for more details.

Optik was written by Greg Ward, with suggestions from the readers of the
Getopt SIG.


File: python.info,  Node: Pymalloc A Specialized Object Allocator,  Next: Build and C API Changes<12>,  Prev: New Improved and Deprecated Modules<4>,  Up: What’s New in Python 2 3

1.14.18 Pymalloc: A Specialized Object Allocator
------------------------------------------------

Pymalloc, a specialized object allocator written by Vladimir Marangozov,
was a feature added to Python 2.1.  Pymalloc is intended to be faster
than the system ‘malloc()’ and to have less memory overhead for
allocation patterns typical of Python programs.  The allocator uses C’s
‘malloc()’ function to get large pools of memory and then fulfills
smaller memory requests from these pools.

In 2.1 and 2.2, pymalloc was an experimental feature and wasn’t enabled
by default; you had to explicitly enable it when compiling Python by
providing the ‘--with-pymalloc’ option to the ‘configure’ script.  In
2.3, pymalloc has had further enhancements and is now enabled by
default; you’ll have to supply ‘--without-pymalloc’ to disable it.

This change is transparent to code written in Python; however, pymalloc
may expose bugs in C extensions.  Authors of C extension modules should
test their code with pymalloc enabled, because some incorrect code may
cause core dumps at runtime.

There’s one particularly common error that causes problems.  There are a
number of memory allocation functions in Python’s C API that have
previously just been aliases for the C library’s ‘malloc()’ and
‘free()’, meaning that if you accidentally called mismatched functions
the error wouldn’t be noticeable.  When the object allocator is enabled,
these functions aren’t aliases of ‘malloc()’ and ‘free()’ any more, and
calling the wrong function to free memory may get you a core dump.  For
example, if memory was allocated using *note PyObject_Malloc(): 4fd, it
has to be freed using *note PyObject_Free(): 4f9, not ‘free()’.  A few
modules included with Python fell afoul of this and had to be fixed;
doubtless there are more third-party modules that will have the same
problem.

As part of this change, the confusing multiple interfaces for allocating
memory have been consolidated down into two API families.  Memory
allocated with one family must not be manipulated with functions from
the other family.  There is one family for allocating chunks of memory
and another family of functions specifically for allocating Python
objects.

   * To allocate and free an undistinguished chunk of memory use the
     “raw memory” family: *note PyMem_Malloc(): 4fa, *note
     PyMem_Realloc(): 963, and *note PyMem_Free(): d9c.

   * The “object memory” family is the interface to the pymalloc
     facility described above and is biased towards a large number of
     “small” allocations: *note PyObject_Malloc(): 4fd, *note
     PyObject_Realloc(): d9d, and *note PyObject_Free(): 4f9.

   * To allocate and free Python objects, use the “object” family *note
     PyObject_New(): 2d0, *note PyObject_NewVar(): 2d1, and *note
     PyObject_Del(): e09.

Thanks to lots of work by Tim Peters, pymalloc in 2.3 also provides
debugging features to catch memory overwrites and doubled frees in both
extension modules and in the interpreter itself.  To enable this
support, compile a debugging version of the Python interpreter by
running ‘configure’ with ‘--with-pydebug’.

To aid extension writers, a header file ‘Misc/pymemcompat.h’ is
distributed with the source to Python 2.3 that allows Python extensions
to use the 2.3 interfaces to memory allocation while compiling against
any version of Python since 1.5.2.  You would copy the file from
Python’s source distribution and bundle it with the source of your
extension.

See also
........

‘https://hg.python.org/cpython/file/default/Objects/obmalloc.c’

     For the full details of the pymalloc implementation, see the
     comments at the top of the file ‘Objects/obmalloc.c’ in the Python
     source code.  The above link points to the file within the
     python.org SVN browser.


File: python.info,  Node: Build and C API Changes<12>,  Next: Other Changes and Fixes<2>,  Prev: Pymalloc A Specialized Object Allocator,  Up: What’s New in Python 2 3

1.14.19 Build and C API Changes
-------------------------------

Changes to Python’s build process and to the C API include:

   * The cycle detection implementation used by the garbage collection
     has proven to be stable, so it’s now been made mandatory.  You can
     no longer compile Python without it, and the ‘--with-cycle-gc’
     switch to ‘configure’ has been removed.

   * Python can now optionally be built as a shared library
     (‘libpython2.3.so’) by supplying ‘--enable-shared’ when running
     Python’s ‘configure’ script.  (Contributed by Ondrej Palkovsky.)

   * The ‘DL_EXPORT’ and ‘DL_IMPORT’ macros are now deprecated.
     Initialization functions for Python extension modules should now be
     declared using the new macro ‘PyMODINIT_FUNC’, while the Python
     core will generally use the ‘PyAPI_FUNC’ and ‘PyAPI_DATA’ macros.

   * The interpreter can be compiled without any docstrings for the
     built-in functions and modules by supplying ‘--without-doc-strings’
     to the ‘configure’ script.  This makes the Python executable about
     10% smaller, but will also mean that you can’t get help for
     Python’s built-ins.  (Contributed by Gustavo Niemeyer.)

   * The ‘PyArg_NoArgs()’ macro is now deprecated, and code that uses it
     should be changed.  For Python 2.2 and later, the method definition
     table can specify the *note METH_NOARGS: e0b. flag, signalling that
     there are no arguments, and the argument checking can then be
     removed.  If compatibility with pre-2.2 versions of Python is
     important, the code could use ‘PyArg_ParseTuple(args, "")’ instead,
     but this will be slower than using *note METH_NOARGS: e0b.

   * *note PyArg_ParseTuple(): 268. accepts new format characters for
     various sizes of unsigned integers: ‘B’ for ‘unsigned char’, ‘H’
     for ‘unsigned short int’, ‘I’ for ‘unsigned int’, and ‘K’ for
     ‘unsigned long long’.

   * A new function, ‘PyObject_DelItemString(mapping, char *key)’ was
     added as shorthand for ‘PyObject_DelItem(mapping,
     PyString_New(key))’.

   * File objects now manage their internal string buffer differently,
     increasing it exponentially when needed.  This results in the
     benchmark tests in ‘Lib/test/test_bufio.py’ speeding up
     considerably (from 57 seconds to 1.7 seconds, according to one
     measurement).

   * It’s now possible to define class and static methods for a C
     extension type by setting either the *note METH_CLASS: e0c. or
     *note METH_STATIC: e0d. flags in a method’s *note PyMethodDef: e0e.
     structure.

   * Python now includes a copy of the Expat XML parser’s source code,
     removing any dependence on a system version or local installation
     of Expat.

   * If you dynamically allocate type objects in your extension, you
     should be aware of a change in the rules relating to the
     ‘__module__’ and *note __name__: c5a. attributes.  In summary, you
     will want to ensure the type’s dictionary contains a ‘'__module__'’
     key; making the module name the part of the type name leading up to
     the final period will no longer have the desired effect.  For more
     detail, read the API reference documentation or the source.

* Menu:

* Port-Specific Changes: Port-Specific Changes<3>.


File: python.info,  Node: Port-Specific Changes<3>,  Up: Build and C API Changes<12>

1.14.19.1 Port-Specific Changes
...............................

Support for a port to IBM’s OS/2 using the EMX runtime environment was
merged into the main Python source tree.  EMX is a POSIX emulation layer
over the OS/2 system APIs.  The Python port for EMX tries to support all
the POSIX-like capability exposed by the EMX runtime, and mostly
succeeds; ‘fork()’ and *note fcntl(): 7e. are restricted by the
limitations of the underlying emulation layer.  The standard OS/2 port,
which uses IBM’s Visual Age compiler, also gained support for
case-sensitive import semantics as part of the integration of the EMX
port into CVS. (Contributed by Andrew MacIntyre.)

On MacOS, most toolbox modules have been weaklinked to improve backward
compatibility.  This means that modules will no longer fail to load if a
single routine is missing on the current OS version.  Instead calling
the missing routine will raise an exception.  (Contributed by Jack
Jansen.)

The RPM spec files, found in the ‘Misc/RPM/’ directory in the Python
source distribution, were updated for 2.3.  (Contributed by Sean
Reifschneider.)

Other new platforms now supported by Python include AtheOS
(‘http://www.atheos.cx/’), GNU/Hurd, and OpenVMS.


File: python.info,  Node: Other Changes and Fixes<2>,  Next: Porting to Python 2 3,  Prev: Build and C API Changes<12>,  Up: What’s New in Python 2 3

1.14.20 Other Changes and Fixes
-------------------------------

As usual, there were a bunch of other improvements and bugfixes
scattered throughout the source tree.  A search through the CVS change
logs finds there were 523 patches applied and 514 bugs fixed between
Python 2.2 and 2.3.  Both figures are likely to be underestimates.

Some of the more notable changes are:

   * If the *note PYTHONINSPECT: e11. environment variable is set, the
     Python interpreter will enter the interactive prompt after running
     a Python program, as if Python had been invoked with the *note -i:
     e12. option.  The environment variable can be set before running
     the Python interpreter, or it can be set by the Python program as
     part of its execution.

   * The ‘regrtest.py’ script now provides a way to allow “all resources
     except `foo'.” A resource name passed to the ‘-u’ option can now be
     prefixed with a hyphen (‘'-'’) to mean “remove this resource.” For
     example, the option ‘‘-uall,-bsddb’’ could be used to enable the
     use of all resources except ‘bsddb’.

   * The tools used to build the documentation now work under Cygwin as
     well as Unix.

   * The ‘SET_LINENO’ opcode has been removed.  Back in the mists of
     time, this opcode was needed to produce line numbers in tracebacks
     and support trace functions (for, e.g., *note pdb: c9.).  Since
     Python 1.5, the line numbers in tracebacks have been computed using
     a different mechanism that works with “python -O”.  For Python 2.3
     Michael Hudson implemented a similar scheme to determine when to
     call the trace function, removing the need for ‘SET_LINENO’
     entirely.

     It would be difficult to detect any resulting difference from
     Python code, apart from a slight speed up when Python is run
     without *note -O: 67f.

     C extensions that access the ‘f_lineno’ field of frame objects
     should instead call ‘PyCode_Addr2Line(f->f_code, f->f_lasti)’.
     This will have the added effect of making the code work as desired
     under “python -O” in earlier versions of Python.

     A nifty new feature is that trace functions can now assign to the
     ‘f_lineno’ attribute of frame objects, changing the line that will
     be executed next.  A ‘jump’ command has been added to the *note
     pdb: c9. debugger taking advantage of this new feature.
     (Implemented by Richie Hindle.)


File: python.info,  Node: Porting to Python 2 3,  Next: Acknowledgements<5>,  Prev: Other Changes and Fixes<2>,  Up: What’s New in Python 2 3

1.14.21 Porting to Python 2.3
-----------------------------

This section lists previously described changes that may require changes
to your code:

   * *note yield: 18f. is now always a keyword; if it’s used as a
     variable name in your code, a different name must be chosen.

   * For strings `X' and `Y', ‘X in Y’ now works if `X' is more than one
     character long.

   * The *note int(): 184. type constructor will now return a long
     integer instead of raising an *note OverflowError: 954. when a
     string or floating-point number is too large to fit into an
     integer.

   * If you have Unicode strings that contain 8-bit characters, you must
     declare the file’s encoding (UTF-8, Latin-1, or whatever) by adding
     a comment to the top of the file.  See section *note PEP 263;
     Source Code Encodings: ddc. for more information.

   * Calling Tcl methods through ‘_tkinter’ no longer returns only
     strings.  Instead, if Tcl returns other objects those objects are
     converted to their Python equivalent, if one exists, or wrapped
     with a ‘_tkinter.Tcl_Obj’ object if no Python equivalent exists.

   * Large octal and hex literals such as ‘0xffffffff’ now trigger a
     *note FutureWarning: 31a.  Currently they’re stored as 32-bit
     numbers and result in a negative value, but in Python 2.4 they’ll
     become positive long integers.

     There are a few ways to fix this warning.  If you really need a
     positive number, just add an ‘L’ to the end of the literal.  If
     you’re trying to get a 32-bit integer with low bits set and have
     previously used an expression such as ‘~(1 << 31)’, it’s probably
     clearest to start with all bits set and clear the desired upper
     bits.  For example, to clear just the top bit (bit 31), you could
     write ‘0xffffffffL &~(1L<<31)’.

   * You can no longer disable assertions by assigning to ‘__debug__’.

   * The Distutils ‘setup()’ function has gained various new keyword
     arguments such as `depends'.  Old versions of the Distutils will
     abort if passed unknown keywords.  A solution is to check for the
     presence of the new ‘get_distutil_options()’ function in your
     ‘setup.py’ and only uses the new keywords with a version of the
     Distutils that supports them:

          from distutils import core

          kw = {'sources': 'foo.c', ...}
          if hasattr(core, 'get_distutil_options'):
              kw['depends'] = ['foo.h']
          ext = Extension(**kw)

   * Using ‘None’ as a variable name will now result in a *note
     SyntaxWarning: 191. warning.

   * Names of extension types defined by the modules included with
     Python now contain the module and a ‘'.'’ in front of the type
     name.


File: python.info,  Node: Acknowledgements<5>,  Prev: Porting to Python 2 3,  Up: What’s New in Python 2 3

1.14.22 Acknowledgements
------------------------

The author would like to thank the following people for offering
suggestions, corrections and assistance with various drafts of this
article: Jeff Bauer, Simon Brunning, Brett Cannon, Michael Chermside,
Andrew Dalke, Scott David Daniels, Fred L. Drake, Jr., David Fraser,
Kelly Gerber, Raymond Hettinger, Michael Hudson, Chris Lambert, Detlef
Lannert, Martin von Löwis, Andrew MacIntyre, Lalo Martins, Chad Netzer,
Gustavo Niemeyer, Neal Norwitz, Hans Nowak, Chris Reedy, Francesco
Ricciardi, Vinay Sajip, Neil Schemenauer, Roman Suzi, Jason Tishler,
Just van Rossum.


File: python.info,  Node: What’s New in Python 2 2,  Next: What’s New in Python 2 1,  Prev: What’s New in Python 2 3,  Up: What’s New in Python

1.15 What’s New in Python 2.2
=============================


Author: A.M. Kuchling

* Menu:

* Introduction::
* PEPs 252 and 253; Type and Class Changes: PEPs 252 and 253 Type and Class Changes.
* PEP 234; Iterators: PEP 234 Iterators.
* PEP 255; Simple Generators: PEP 255 Simple Generators<2>.
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers<2>.
* PEP 238; Changing the Division Operator: PEP 238 Changing the Division Operator.
* Unicode Changes::
* PEP 227; Nested Scopes: PEP 227 Nested Scopes.
* New and Improved Modules: New and Improved Modules<3>.
* Interpreter Changes and Fixes::
* Other Changes and Fixes: Other Changes and Fixes<3>.
* Acknowledgements: Acknowledgements<6>.


File: python.info,  Node: Introduction,  Next: PEPs 252 and 253 Type and Class Changes,  Up: What’s New in Python 2 2

1.15.1 Introduction
-------------------

This article explains the new features in Python 2.2.2, released on
October 14, 2002.  Python 2.2.2 is a bugfix release of Python 2.2,
originally released on December 21, 2001.

Python 2.2 can be thought of as the “cleanup release”.  There are some
features such as generators and iterators that are completely new, but
most of the changes, significant and far-reaching though they may be,
are aimed at cleaning up irregularities and dark corners of the language
design.

This article doesn’t attempt to provide a complete specification of the
new features, but instead provides a convenient overview.  For full
details, you should refer to the documentation for Python 2.2, such as
the Python Library Reference(1) and the Python Reference Manual(2).  If
you want to understand the complete implementation and design rationale
for a change, refer to the PEP for a particular new feature.

   ---------- Footnotes ----------

   (1) https://docs.python.org/2.2/lib/lib.html

   (2) https://docs.python.org/2.2/ref/ref.html


File: python.info,  Node: PEPs 252 and 253 Type and Class Changes,  Next: PEP 234 Iterators,  Prev: Introduction,  Up: What’s New in Python 2 2

1.15.2 PEPs 252 and 253: Type and Class Changes
-----------------------------------------------

The largest and most far-reaching changes in Python 2.2 are to Python’s
model of objects and classes.  The changes should be backward
compatible, so it’s likely that your code will continue to run
unchanged, but the changes provide some amazing new capabilities.
Before beginning this, the longest and most complicated section of this
article, I’ll provide an overview of the changes and offer some
comments.

A long time ago I wrote a Web page listing flaws in Python’s design.
One of the most significant flaws was that it’s impossible to subclass
Python types implemented in C. In particular, it’s not possible to
subclass built-in types, so you can’t just subclass, say, lists in order
to add a single useful method to them.  The ‘UserList’ module provides a
class that supports all of the methods of lists and that can be
subclassed further, but there’s lots of C code that expects a regular
Python list and won’t accept a ‘UserList’ instance.

Python 2.2 fixes this, and in the process adds some exciting new
capabilities.  A brief summary:

   * You can subclass built-in types such as lists and even integers,
     and your subclasses should work in every place that requires the
     original type.

   * It’s now possible to define static and class methods, in addition
     to the instance methods available in previous versions of Python.

   * It’s also possible to automatically call methods on accessing or
     setting an instance attribute by using a new mechanism called
     `properties'.  Many uses of *note __getattr__(): 30f. can be
     rewritten to use properties instead, making the resulting code
     simpler and faster.  As a small side benefit, attributes can now
     have docstrings, too.

   * The list of legal attributes for an instance can be limited to a
     particular set using `slots', making it possible to safeguard
     against typos and perhaps make more optimizations possible in
     future versions of Python.

Some users have voiced concern about all these changes.  Sure, they say,
the new features are neat and lend themselves to all sorts of tricks
that weren’t possible in previous versions of Python, but they also make
the language more complicated.  Some people have said that they’ve
always recommended Python for its simplicity, and feel that its
simplicity is being lost.

Personally, I think there’s no need to worry.  Many of the new features
are quite esoteric, and you can write a lot of Python code without ever
needed to be aware of them.  Writing a simple class is no more difficult
than it ever was, so you don’t need to bother learning or teaching them
unless they’re actually needed.  Some very complicated tasks that were
previously only possible from C will now be possible in pure Python, and
to my mind that’s all for the better.

I’m not going to attempt to cover every single corner case and small
change that were required to make the new features work.  Instead this
section will paint only the broad strokes.  See section *note Related
Links: e1a, “Related Links”, for further sources of information about
Python 2.2’s new object model.

* Menu:

* Old and New Classes::
* Descriptors::
* Multiple Inheritance; The Diamond Rule: Multiple Inheritance The Diamond Rule.
* Attribute Access::
* Related Links::


File: python.info,  Node: Old and New Classes,  Next: Descriptors,  Up: PEPs 252 and 253 Type and Class Changes

1.15.2.1 Old and New Classes
............................

First, you should know that Python 2.2 really has two kinds of classes:
classic or old-style classes, and new-style classes.  The old-style
class model is exactly the same as the class model in earlier versions
of Python.  All the new features described in this section apply only to
new-style classes.  This divergence isn’t intended to last forever;
eventually old-style classes will be dropped, possibly in Python 3.0.

So how do you define a new-style class?  You do it by subclassing an
existing new-style class.  Most of Python’s built-in types, such as
integers, lists, dictionaries, and even files, are new-style classes
now.  A new-style class named *note object: 2ae, the base class for all
built-in types, has also been added so if no built-in type is suitable,
you can just subclass *note object: 2ae.:

     class C(object):
         def __init__ (self):
             ...
         ...

This means that *note class: c5d. statements that don’t have any base
classes are always classic classes in Python 2.2.  (Actually you can
also change this by setting a module-level variable named
‘__metaclass__’ — see PEP 253(1) for the details — but it’s easier to
just subclass *note object: 2ae.)

The type objects for the built-in types are available as built-ins,
named using a clever trick.  Python has always had built-in functions
named *note int(): 184, *note float(): 187, and *note str(): 325.  In
2.2, they aren’t functions any more, but type objects that behave as
factories when called.

     >>> int
     <type 'int'>
     >>> int('123')
     123

To make the set of types complete, new type objects such as *note
dict(): 1b6. and ‘file()’ have been added.  Here’s a more interesting
example, adding a ‘lock()’ method to file objects:

     class LockableFile(file):
         def lock (self, operation, length=0, start=0, whence=0):
             import fcntl
             return fcntl.lockf(self.fileno(), operation,
                                length, start, whence)

The now-obsolete ‘posixfile’ module contained a class that emulated all
of a file object’s methods and also added a ‘lock()’ method, but this
class couldn’t be passed to internal functions that expected a built-in
file, something which is possible with our new ‘LockableFile’.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0253


File: python.info,  Node: Descriptors,  Next: Multiple Inheritance The Diamond Rule,  Prev: Old and New Classes,  Up: PEPs 252 and 253 Type and Class Changes

1.15.2.2 Descriptors
....................

In previous versions of Python, there was no consistent way to discover
what attributes and methods were supported by an object.  There were
some informal conventions, such as defining ‘__members__’ and
‘__methods__’ attributes that were lists of names, but often the author
of an extension type or a class wouldn’t bother to define them.  You
could fall back on inspecting the *note __dict__: 4f1. of an object, but
when class inheritance or an arbitrary *note __getattr__(): 30f. hook
were in use this could still be inaccurate.

The one big idea underlying the new class model is that an API for
describing the attributes of an object using `descriptors' has been
formalized.  Descriptors specify the value of an attribute, stating
whether it’s a method or a field.  With the descriptor API, static
methods and class methods become possible, as well as more exotic
constructs.

Attribute descriptors are objects that live inside class objects, and
have a few attributes of their own:

   * *note __name__: c5a. is the attribute’s name.

   * ‘__doc__’ is the attribute’s docstring.

   * ‘__get__(object)’ is a method that retrieves the attribute value
     from `object'.

   * ‘__set__(object, value)’ sets the attribute on `object' to `value'.

   * ‘__delete__(object, value)’ deletes the `value' attribute of
     `object'.

For example, when you write ‘obj.x’, the steps that Python actually
performs are:

     descriptor = obj.__class__.x
     descriptor.__get__(obj)

For methods, ‘descriptor.__get__()’ returns a temporary object that’s
callable, and wraps up the instance and the method to be called on it.
This is also why static methods and class methods are now possible; they
have descriptors that wrap up just the method, or the method and the
class.  As a brief explanation of these new kinds of methods, static
methods aren’t passed the instance, and therefore resemble regular
functions.  Class methods are passed the class of the object, but not
the object itself.  Static and class methods are defined like this:

     class C(object):
         def f(arg1, arg2):
             ...
         f = staticmethod(f)

         def g(cls, arg1, arg2):
             ...
         g = classmethod(g)

The *note staticmethod(): 1d7. function takes the function ‘f()’, and
returns it wrapped up in a descriptor so it can be stored in the class
object.  You might expect there to be special syntax for creating such
methods (‘def static f’, ‘defstatic f()’, or something like that) but no
such syntax has been defined yet; that’s been left for future versions
of Python.

More new features, such as slots and properties, are also implemented as
new kinds of descriptors, and it’s not difficult to write a descriptor
class that does something novel.  For example, it would be possible to
write a descriptor class that made it possible to write Eiffel-style
preconditions and postconditions for a method.  A class that used this
feature might be defined like this:

     from eiffel import eiffelmethod

     class C(object):
         def f(self, arg1, arg2):
             # The actual function
             ...
         def pre_f(self):
             # Check preconditions
             ...
         def post_f(self):
             # Check postconditions
             ...

         f = eiffelmethod(f, pre_f, post_f)

Note that a person using the new ‘eiffelmethod()’ doesn’t have to
understand anything about descriptors.  This is why I think the new
features don’t increase the basic complexity of the language.  There
will be a few wizards who need to know about it in order to write
‘eiffelmethod()’ or the ZODB or whatever, but most users will just write
code on top of the resulting libraries and ignore the implementation
details.


File: python.info,  Node: Multiple Inheritance The Diamond Rule,  Next: Attribute Access,  Prev: Descriptors,  Up: PEPs 252 and 253 Type and Class Changes

1.15.2.3 Multiple Inheritance: The Diamond Rule
...............................................

Multiple inheritance has also been made more useful through changing the
rules under which names are resolved.  Consider this set of classes
(diagram taken from PEP 253(1) by Guido van Rossum):

           class A:
             ^ ^  def save(self): ...
            /   \
           /     \
          /       \
         /         \
     class B     class C:
         ^         ^  def save(self): ...
          \       /
           \     /
            \   /
             \ /
           class D

The lookup rule for classic classes is simple but not very smart; the
base classes are searched depth-first, going from left to right.  A
reference to ‘D.save()’ will search the classes ‘D’, ‘B’, and then ‘A’,
where ‘save()’ would be found and returned.  ‘C.save()’ would never be
found at all.  This is bad, because if ‘C’’s ‘save()’ method is saving
some internal state specific to ‘C’, not calling it will result in that
state never getting saved.

New-style classes follow a different algorithm that’s a bit more
complicated to explain, but does the right thing in this situation.
(Note that Python 2.3 changes this algorithm to one that produces the
same results in most cases, but produces more useful results for really
complicated inheritance graphs.)

  1. List all the base classes, following the classic lookup rule and
     include a class multiple times if it’s visited repeatedly.  In the
     above example, the list of visited classes is [‘D’, ‘B’, ‘A’, ‘C’,
     ‘A’].

  2. Scan the list for duplicated classes.  If any are found, remove all
     but one occurrence, leaving the `last' one in the list.  In the
     above example, the list becomes [‘D’, ‘B’, ‘C’, ‘A’] after dropping
     duplicates.

Following this rule, referring to ‘D.save()’ will return ‘C.save()’,
which is the behaviour we’re after.  This lookup rule is the same as the
one followed by Common Lisp.  A new built-in function, *note super():
4d7, provides a way to get at a class’s superclasses without having to
reimplement Python’s algorithm.  The most commonly used form will be
‘super(class, obj)’, which returns a bound superclass object (not the
actual class object).  This form will be used in methods to call a
method in the superclass; for example, ‘D’’s ‘save()’ method would look
like this:

     class D (B,C):
         def save (self):
             # Call superclass .save()
             super(D, self).save()
             # Save D's private information here
             ...

*note super(): 4d7. can also return unbound superclass objects when
called as ‘super(class)’ or ‘super(class1, class2)’, but this probably
won’t often be useful.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0253


File: python.info,  Node: Attribute Access,  Next: Related Links,  Prev: Multiple Inheritance The Diamond Rule,  Up: PEPs 252 and 253 Type and Class Changes

1.15.2.4 Attribute Access
.........................

A fair number of sophisticated Python classes define hooks for attribute
access using *note __getattr__(): 30f.; most commonly this is done for
convenience, to make code more readable by automatically mapping an
attribute access such as ‘obj.parent’ into a method call such as
‘obj.get_parent’.  Python 2.2 adds some new ways of controlling
attribute access.

First, ‘__getattr__(attr_name)’ is still supported by new-style classes,
and nothing about it has changed.  As before, it will be called when an
attempt is made to access ‘obj.foo’ and no attribute named ‘foo’ is
found in the instance’s dictionary.

New-style classes also support a new method,
‘__getattribute__(attr_name)’.  The difference between the two methods
is that *note __getattribute__(): 43e. is `always' called whenever any
attribute is accessed, while the old *note __getattr__(): 30f. is only
called if ‘foo’ isn’t found in the instance’s dictionary.

However, Python 2.2’s support for `properties' will often be a simpler
way to trap attribute references.  Writing a *note __getattr__(): 30f.
method is complicated because to avoid recursion you can’t use regular
attribute accesses inside them, and instead have to mess around with the
contents of *note __dict__: 4f1.  *note __getattr__(): 30f. methods also
end up being called by Python when it checks for other methods such as
*note __repr__(): 333. or ‘__coerce__()’, and so have to be written with
this in mind.  Finally, calling a function on every attribute access
results in a sizable performance loss.

*note property: 1d5. is a new built-in type that packages up three
functions that get, set, or delete an attribute, and a docstring.  For
example, if you want to define a ‘size’ attribute that’s computed, but
also settable, you could write:

     class C(object):
         def get_size (self):
             result = ... computation ...
             return result
         def set_size (self, size):
             ... compute something based on the size
             and set internal state appropriately ...

         # Define a property.  The 'delete this attribute'
         # method is defined as None, so the attribute
         # can't be deleted.
         size = property(get_size, set_size,
                         None,
                         "Storage size of this instance")

That is certainly clearer and easier to write than a pair of *note
__getattr__(): 30f./*note __setattr__(): e1f. methods that check for the
‘size’ attribute and handle it specially while retrieving all other
attributes from the instance’s *note __dict__: 4f1.  Accesses to ‘size’
are also the only ones which have to perform the work of calling a
function, so references to other attributes run at their usual speed.

Finally, it’s possible to constrain the list of attributes that can be
referenced on an object using the new *note __slots__: e20. class
attribute.  Python objects are usually very dynamic; at any time it’s
possible to define a new attribute on an instance by just doing
‘obj.new_attr=1’.  A new-style class can define a class attribute named
*note __slots__: e20. to limit the legal attributes to a particular set
of names.  An example will make this clear:

     >>> class C(object):
     ...     __slots__ = ('template', 'name')
     ...
     >>> obj = C()
     >>> print obj.template
     None
     >>> obj.template = 'Test'
     >>> print obj.template
     Test
     >>> obj.newattr = None
     Traceback (most recent call last):
       File "<stdin>", line 1, in ?
     AttributeError: 'C' object has no attribute 'newattr'

Note how you get an *note AttributeError: 390. on the attempt to assign
to an attribute not listed in *note __slots__: e20.


File: python.info,  Node: Related Links,  Prev: Attribute Access,  Up: PEPs 252 and 253 Type and Class Changes

1.15.2.5 Related Links
......................

This section has just been a quick overview of the new features, giving
enough of an explanation to start you programming, but many details have
been simplified or ignored.  Where should you go to get a more complete
picture?

‘https://docs.python.org/dev/howto/descriptor.html’ is a lengthy
tutorial introduction to the descriptor features, written by Guido van
Rossum.  If my description has whetted your appetite, go read this
tutorial next, because it goes into much more detail about the new
features while still remaining quite easy to read.

Next, there are two relevant PEPs, PEP 252(1) and PEP 253(2).  PEP
252(3) is titled “Making Types Look More Like Classes”, and covers the
descriptor API. PEP 253(4) is titled “Subtyping Built-in Types”, and
describes the changes to type objects that make it possible to subtype
built-in objects.  PEP 253(5) is the more complicated PEP of the two,
and at a few points the necessary explanations of types and meta-types
may cause your head to explode.  Both PEPs were written and implemented
by Guido van Rossum, with substantial assistance from the rest of the
Zope Corp.  team.

Finally, there’s the ultimate authority: the source code.  Most of the
machinery for the type handling is in ‘Objects/typeobject.c’, but you
should only resort to it after all other avenues have been exhausted,
including posting a question to python-list or python-dev.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0252

   (2) https://www.python.org/dev/peps/pep-0253

   (3) https://www.python.org/dev/peps/pep-0252

   (4) https://www.python.org/dev/peps/pep-0253

   (5) https://www.python.org/dev/peps/pep-0253


File: python.info,  Node: PEP 234 Iterators,  Next: PEP 255 Simple Generators<2>,  Prev: PEPs 252 and 253 Type and Class Changes,  Up: What’s New in Python 2 2

1.15.3 PEP 234: Iterators
-------------------------

Another significant addition to 2.2 is an iteration interface at both
the C and Python levels.  Objects can define how they can be looped over
by callers.

In Python versions up to 2.1, the usual way to make ‘for item in obj’
work is to define a *note __getitem__(): 27a. method that looks
something like this:

     def __getitem__(self, index):
         return <next item>

*note __getitem__(): 27a. is more properly used to define an indexing
operation on an object so that you can write ‘obj[5]’ to retrieve the
sixth element.  It’s a bit misleading when you’re using this only to
support *note for: c23. loops.  Consider some file-like object that
wants to be looped over; the `index' parameter is essentially
meaningless, as the class probably assumes that a series of *note
__getitem__(): 27a. calls will be made with `index' incrementing by one
each time.  In other words, the presence of the *note __getitem__():
27a. method doesn’t mean that using ‘file[5]’ to randomly access the
sixth element will work, though it really should.

In Python 2.2, iteration can be implemented separately, and *note
__getitem__(): 27a. methods can be limited to classes that really do
support random access.  The basic idea of iterators is simple.  A new
built-in function, ‘iter(obj)’ or ‘iter(C, sentinel)’, is used to get an
iterator.  ‘iter(obj)’ returns an iterator for the object `obj', while
‘iter(C, sentinel)’ returns an iterator that will invoke the callable
object `C' until it returns `sentinel' to signal that the iterator is
done.

Python classes can define an *note __iter__(): 504. method, which should
create and return a new iterator for the object; if the object is its
own iterator, this method can just return ‘self’.  In particular,
iterators will usually be their own iterators.  Extension types
implemented in C can implement a *note tp_iter: e23. function in order
to return an iterator, and extension types that want to behave as
iterators can define a *note tp_iternext: e24. function.

So, after all this, what do iterators actually do?  They have one
required method, *note next(): 676, which takes no arguments and returns
the next value.  When there are no more values to be returned, calling
*note next(): 676. should raise the *note StopIteration: 47b. exception.

     >>> L = [1,2,3]
     >>> i = iter(L)
     >>> print i
     <iterator object at 0x8116870>
     >>> i.next()
     1
     >>> i.next()
     2
     >>> i.next()
     3
     >>> i.next()
     Traceback (most recent call last):
       File "<stdin>", line 1, in ?
     StopIteration
     >>>

In 2.2, Python’s *note for: c23. statement no longer expects a sequence;
it expects something for which *note iter(): d1a. will return an
iterator.  For backward compatibility and convenience, an iterator is
automatically constructed for sequences that don’t implement *note
__iter__(): 504. or a *note tp_iter: e23. slot, so ‘for i in [1,2,3]’
will still work.  Wherever the Python interpreter loops over a sequence,
it’s been changed to use the iterator protocol.  This means you can do
things like this:

     >>> L = [1,2,3]
     >>> i = iter(L)
     >>> a,b,c = i
     >>> a,b,c
     (1, 2, 3)

Iterator support has been added to some of Python’s basic types.
Calling *note iter(): d1a. on a dictionary will return an iterator which
loops over its keys:

     >>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
     ...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
     >>> for key in m: print key, m[key]
     ...
     Mar 3
     Feb 2
     Aug 8
     Sep 9
     May 5
     Jun 6
     Jul 7
     Jan 1
     Apr 4
     Nov 11
     Dec 12
     Oct 10

That’s just the default behaviour.  If you want to iterate over keys,
values, or key/value pairs, you can explicitly call the ‘iterkeys()’,
‘itervalues()’, or ‘iteritems()’ methods to get an appropriate iterator.
In a minor related change, the *note in: 797. operator now works on
dictionaries, so ‘key in dict’ is now equivalent to ‘dict.has_key(key)’.

Files also provide an iterator, which calls the *note readline(): de.
method until there are no more lines in the file.  This means you can
now read each line of a file using code like this:

     for line in file:
         # do something for each line
         ...

Note that you can only go forward in an iterator; there’s no way to get
the previous element, reset the iterator, or make a copy of it.  An
iterator object could provide such additional capabilities, but the
iterator protocol only requires a *note next(): 676. method.

See also
........

PEP 234(1) - Iterators

     Written by Ka-Ping Yee and GvR; implemented by the Python Labs
     crew, mostly by GvR and Tim Peters.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0234


File: python.info,  Node: PEP 255 Simple Generators<2>,  Next: PEP 237 Unifying Long Integers and Integers<2>,  Prev: PEP 234 Iterators,  Up: What’s New in Python 2 2

1.15.4 PEP 255: Simple Generators
---------------------------------

Generators are another new feature, one that interacts with the
introduction of iterators.

You’re doubtless familiar with how function calls work in Python or C.
When you call a function, it gets a private namespace where its local
variables are created.  When the function reaches a *note return: 190.
statement, the local variables are destroyed and the resulting value is
returned to the caller.  A later call to the same function will get a
fresh new set of local variables.  But, what if the local variables
weren’t thrown away on exiting a function?  What if you could later
resume the function where it left off?  This is what generators provide;
they can be thought of as resumable functions.

Here’s the simplest example of a generator function:

     def generate_ints(N):
         for i in range(N):
             yield i

A new keyword, *note yield: 18f, was introduced for generators.  Any
function containing a ‘yield’ statement is a generator function; this is
detected by Python’s bytecode compiler which compiles the function
specially as a result.  Because a new keyword was introduced, generators
must be explicitly enabled in a module by including a ‘from __future__
import generators’ statement near the top of the module’s source code.
In Python 2.3 this statement will become unnecessary.

When you call a generator function, it doesn’t return a single value;
instead it returns a generator object that supports the iterator
protocol.  On executing the *note yield: 18f. statement, the generator
outputs the value of ‘i’, similar to a *note return: 190. statement.
The big difference between ‘yield’ and a ‘return’ statement is that on
reaching a ‘yield’ the generator’s state of execution is suspended and
local variables are preserved.  On the next call to the generator’s
‘next()’ method, the function will resume executing immediately after
the ‘yield’ statement.  (For complicated reasons, the ‘yield’ statement
isn’t allowed inside the ‘try’ block of a *note try: d65.…*note finally:
182. statement; read PEP 255(1) for a full explanation of the
interaction between ‘yield’ and exceptions.)

Here’s a sample usage of the ‘generate_ints()’ generator:

     >>> gen = generate_ints(3)
     >>> gen
     <generator object at 0x8117f90>
     >>> gen.next()
     0
     >>> gen.next()
     1
     >>> gen.next()
     2
     >>> gen.next()
     Traceback (most recent call last):
       File "<stdin>", line 1, in ?
       File "<stdin>", line 2, in generate_ints
     StopIteration

You could equally write ‘for i in generate_ints(5)’, or ‘a,b,c =
generate_ints(3)’.

Inside a generator function, the *note return: 190. statement can only
be used without a value, and signals the end of the procession of
values; afterwards the generator cannot return any further values.
‘return’ with a value, such as ‘return 5’, is a syntax error inside a
generator function.  The end of the generator’s results can also be
indicated by raising *note StopIteration: 47b. manually, or by just
letting the flow of execution fall off the bottom of the function.

You could achieve the effect of generators manually by writing your own
class and storing all the local variables of the generator as instance
variables.  For example, returning a list of integers could be done by
setting ‘self.count’ to 0, and having the *note next(): 676. method
increment ‘self.count’ and return it.  However, for a moderately
complicated generator, writing a corresponding class would be much
messier.  ‘Lib/test/test_generators.py’ contains a number of more
interesting examples.  The simplest one implements an in-order traversal
of a tree using generators recursively.

     # A recursive generator that generates Tree leaves in in-order.
     def inorder(t):
         if t:
             for x in inorder(t.left):
                 yield x
             yield t.label
             for x in inorder(t.right):
                 yield x

Two other examples in ‘Lib/test/test_generators.py’ produce solutions
for the N-Queens problem (placing $N$ queens on an $NxN$ chess board so
that no queen threatens another) and the Knight’s Tour (a route that
takes a knight to every square of an $NxN$ chessboard without visiting
any square twice).

The idea of generators comes from other programming languages,
especially Icon (‘https://www.cs.arizona.edu/icon/’), where the idea of
generators is central.  In Icon, every expression and function call
behaves like a generator.  One example from “An Overview of the Icon
Programming Language” at
‘https://www.cs.arizona.edu/icon/docs/ipd266.htm’ gives an idea of what
this looks like:

     sentence := "Store it in the neighboring harbor"
     if (i := find("or", sentence)) > 5 then write(i)

In Icon the ‘find()’ function returns the indexes at which the substring
“or” is found: 3, 23, 33.  In the *note if: dda. statement, ‘i’ is first
assigned a value of 3, but 3 is less than 5, so the comparison fails,
and Icon retries it with the second value of 23.  23 is greater than 5,
so the comparison now succeeds, and the code prints the value 23 to the
screen.

Python doesn’t go nearly as far as Icon in adopting generators as a
central concept.  Generators are considered a new part of the core
Python language, but learning or using them isn’t compulsory; if they
don’t solve any problems that you have, feel free to ignore them.  One
novel feature of Python’s interface as compared to Icon’s is that a
generator’s state is represented as a concrete object (the iterator)
that can be passed around to other functions or stored in a data
structure.

See also
........

PEP 255(2) - Simple Generators

     Written by Neil Schemenauer, Tim Peters, Magnus Lie Hetland.
     Implemented mostly by Neil Schemenauer and Tim Peters, with other
     fixes from the Python Labs crew.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0255

   (2) https://www.python.org/dev/peps/pep-0255


File: python.info,  Node: PEP 237 Unifying Long Integers and Integers<2>,  Next: PEP 238 Changing the Division Operator,  Prev: PEP 255 Simple Generators<2>,  Up: What’s New in Python 2 2

1.15.5 PEP 237: Unifying Long Integers and Integers
---------------------------------------------------

In recent versions, the distinction between regular integers, which are
32-bit values on most machines, and long integers, which can be of
arbitrary size, was becoming an annoyance.  For example, on platforms
that support files larger than ‘2**32’ bytes, the ‘tell()’ method of
file objects has to return a long integer.  However, there were various
bits of Python that expected plain integers and would raise an error if
a long integer was provided instead.  For example, in Python 1.5, only
regular integers could be used as a slice index, and ‘'abc'[1L:]’ would
raise a *note TypeError: 192. exception with the message ‘slice index
must be int’.

Python 2.2 will shift values from short to long integers as required.
The ‘L’ suffix is no longer needed to indicate a long integer literal,
as now the compiler will choose the appropriate type.  (Using the ‘L’
suffix will be discouraged in future 2.x versions of Python, triggering
a warning in Python 2.4, and probably dropped in Python 3.0.)  Many
operations that used to raise an *note OverflowError: 954. will now
return a long integer as their result.  For example:

     >>> 1234567890123
     1234567890123L
     >>> 2 ** 64
     18446744073709551616L

In most cases, integers and long integers will now be treated
identically.  You can still distinguish them with the *note type(): 5fd.
built-in function, but that’s rarely needed.

See also
........

PEP 237(1) - Unifying Long Integers and Integers

     Written by Moshe Zadka and Guido van Rossum.  Implemented mostly by
     Guido van Rossum.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0237


File: python.info,  Node: PEP 238 Changing the Division Operator,  Next: Unicode Changes,  Prev: PEP 237 Unifying Long Integers and Integers<2>,  Up: What’s New in Python 2 2

1.15.6 PEP 238: Changing the Division Operator
----------------------------------------------

The most controversial change in Python 2.2 heralds the start of an
effort to fix an old design flaw that’s been in Python from the
beginning.  Currently Python’s division operator, ‘/’, behaves like C’s
division operator when presented with two integer arguments: it returns
an integer result that’s truncated down when there would be a fractional
part.  For example, ‘3/2’ is 1, not 1.5, and ‘(-1)/2’ is -1, not -0.5.
This means that the results of division can vary unexpectedly depending
on the type of the two operands and because Python is dynamically typed,
it can be difficult to determine the possible types of the operands.

(The controversy is over whether this is `really' a design flaw, and
whether it’s worth breaking existing code to fix this.  It’s caused
endless discussions on python-dev, and in July 2001 erupted into a storm
of acidly sarcastic postings on ‘comp.lang.python’.  I won’t argue for
either side here and will stick to describing what’s implemented in 2.2.
Read PEP 238(1) for a summary of arguments and counter-arguments.)

Because this change might break code, it’s being introduced very
gradually.  Python 2.2 begins the transition, but the switch won’t be
complete until Python 3.0.

First, I’ll borrow some terminology from PEP 238(2).  “True division” is
the division that most non-programmers are familiar with: 3/2 is 1.5,
1/4 is 0.25, and so forth.  “Floor division” is what Python’s ‘/’
operator currently does when given integer operands; the result is the
floor of the value returned by true division.  “Classic division” is the
current mixed behaviour of ‘/’; it returns the result of floor division
when the operands are integers, and returns the result of true division
when one of the operands is a floating-point number.

Here are the changes 2.2 introduces:

   * A new operator, ‘//’, is the floor division operator.  (Yes, we
     know it looks like C++’s comment symbol.)  ‘//’ `always' performs
     floor division no matter what the types of its operands are, so ‘1
     // 2’ is 0 and ‘1.0 // 2.0’ is also 0.0.

     ‘//’ is always available in Python 2.2; you don’t need to enable it
     using a ‘__future__’ statement.

   * By including a ‘from __future__ import division’ in a module, the
     ‘/’ operator will be changed to return the result of true division,
     so ‘1/2’ is 0.5.  Without the ‘__future__’ statement, ‘/’ still
     means classic division.  The default meaning of ‘/’ will not change
     until Python 3.0.

   * Classes can define methods called *note __truediv__(): 77a. and
     *note __floordiv__(): e28. to overload the two division operators.
     At the C level, there are also slots in the *note PyNumberMethods:
     d74. structure so extension types can define the two operators.

   * Python 2.2 supports some command-line arguments for testing whether
     code will work with the changed division semantics.  Running python
     with ‘-Q warn’ will cause a warning to be issued whenever division
     is applied to two integers.  You can use this to find code that’s
     affected by the change and fix it.  By default, Python 2.2 will
     simply perform classic division without a warning; the warning will
     be turned on by default in Python 2.3.

See also
........

PEP 238(3) - Changing the Division Operator

     Written by Moshe Zadka and Guido van Rossum.  Implemented by Guido
     van Rossum..

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0238

   (2) https://www.python.org/dev/peps/pep-0238

   (3) https://www.python.org/dev/peps/pep-0238


File: python.info,  Node: Unicode Changes,  Next: PEP 227 Nested Scopes,  Prev: PEP 238 Changing the Division Operator,  Up: What’s New in Python 2 2

1.15.7 Unicode Changes
----------------------

Python’s Unicode support has been enhanced a bit in 2.2.  Unicode
strings are usually stored as UCS-2, as 16-bit unsigned integers.
Python 2.2 can also be compiled to use UCS-4, 32-bit unsigned integers,
as its internal encoding by supplying ‘--enable-unicode=ucs4’ to the
configure script.  (It’s also possible to specify ‘--disable-unicode’ to
completely disable Unicode support.)

When built to use UCS-4 (a “wide Python”), the interpreter can natively
handle Unicode characters from U+000000 to U+110000, so the range of
legal values for the ‘unichr()’ function is expanded accordingly.  Using
an interpreter compiled to use UCS-2 (a “narrow Python”), values greater
than 65535 will still cause ‘unichr()’ to raise a *note ValueError: 1f9.
exception.  This is all described in PEP 261(1), “Support for ‘wide’
Unicode characters”; consult it for further details.

Another change is simpler to explain.  Since their introduction, Unicode
strings have supported an ‘encode()’ method to convert the string to a
selected encoding such as UTF-8 or Latin-1.  A symmetric
‘decode([*encoding*])’ method has been added to 8-bit strings (though
not to Unicode strings) in 2.2.  ‘decode()’ assumes that the string is
in the specified encoding and decodes it, returning whatever is returned
by the codec.

Using this new feature, codecs have been added for tasks not directly
related to Unicode.  For example, codecs have been added for
uu-encoding, MIME’s base64 encoding, and compression with the *note
zlib: 144. module:

     >>> s = """Here is a lengthy piece of redundant, overly verbose,
     ... and repetitive text.
     ... """
     >>> data = s.encode('zlib')
     >>> data
     'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
     >>> data.decode('zlib')
     'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
     >>> print s.encode('uu')
     begin 666 <data>
     M2&5R92!I<R!A(&QE;F=T:'D@<&EE8V4@;V8@<F5D=6YD86YT+"!O=F5R;'D@
     >=F5R8F]S92P*86YD(')E<&5T:71I=F4@=&5X="X*

     end
     >>> "sheesh".encode('rot-13')
     'furrfu'

To convert a class instance to Unicode, a ‘__unicode__()’ method can be
defined by a class, analogous to *note __str__(): e2a.

‘encode()’, ‘decode()’, and ‘__unicode__()’ were implemented by
Marc-André Lemburg.  The changes to support using UCS-4 internally were
implemented by Fredrik Lundh and Martin von Löwis.

See also
........

PEP 261(2) - Support for ‘wide’ Unicode characters

     Written by Paul Prescod.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0261

   (2) https://www.python.org/dev/peps/pep-0261


File: python.info,  Node: PEP 227 Nested Scopes,  Next: New and Improved Modules<3>,  Prev: Unicode Changes,  Up: What’s New in Python 2 2

1.15.8 PEP 227: Nested Scopes
-----------------------------

In Python 2.1, statically nested scopes were added as an optional
feature, to be enabled by a ‘from __future__ import nested_scopes’
directive.  In 2.2 nested scopes no longer need to be specially enabled,
and are now always present.  The rest of this section is a copy of the
description of nested scopes from my “What’s New in Python 2.1”
document; if you read it when 2.1 came out, you can skip the rest of
this section.

The largest change introduced in Python 2.1, and made complete in 2.2,
is to Python’s scoping rules.  In Python 2.0, at any given time there
are at most three namespaces used to look up variable names: local,
module-level, and the built-in namespace.  This often surprised people
because it didn’t match their intuitive expectations.  For example, a
nested recursive function definition doesn’t work:

     def f():
         ...
         def g(value):
             ...
             return g(value-1) + 1
         ...

The function ‘g()’ will always raise a *note NameError: d6e. exception,
because the binding of the name ‘g’ isn’t in either its local namespace
or in the module-level namespace.  This isn’t much of a problem in
practice (how often do you recursively define interior functions like
this?), but this also made using the *note lambda: c22. expression
clumsier, and this was a problem in practice.  In code which uses
‘lambda’ you can often find local variables being copied by passing them
as the default values of arguments.

     def find(self, name):
         "Return list of any entries equal to 'name'"
         L = filter(lambda x, name=name: x == name,
                    self.list_attribute)
         return L

The readability of Python code written in a strongly functional style
suffers greatly as a result.

The most significant change to Python 2.2 is that static scoping has
been added to the language to fix this problem.  As a first effect, the
‘name=name’ default argument is now unnecessary in the above example.
Put simply, when a given variable name is not assigned a value within a
function (by an assignment, or the *note def: db1, *note class: c5d, or
*note import: c10. statements), references to the variable will be
looked up in the local namespace of the enclosing scope.  A more
detailed explanation of the rules, and a dissection of the
implementation, can be found in the PEP.

This change may cause some compatibility problems for code where the
same variable name is used both at the module level and as a local
variable within a function that contains further function definitions.
This seems rather unlikely though, since such code would have been
pretty confusing to read in the first place.

One side effect of the change is that the ‘from module import *’ and
‘exec’ statements have been made illegal inside a function scope under
certain conditions.  The Python reference manual has said all along that
‘from module import *’ is only legal at the top level of a module, but
the CPython interpreter has never enforced this before.  As part of the
implementation of nested scopes, the compiler which turns Python source
into bytecodes has to generate different code to access variables in a
containing scope.  ‘from module import *’ and ‘exec’ make it impossible
for the compiler to figure this out, because they add names to the local
namespace that are unknowable at compile time.  Therefore, if a function
contains function definitions or *note lambda: c22. expressions with
free variables, the compiler will flag this by raising a *note
SyntaxError: 44d. exception.

To make the preceding explanation a bit clearer, here’s an example:

     x = 1
     def f():
         # The next line is a syntax error
         exec 'x=2'
         def g():
             return x

Line 4 containing the ‘exec’ statement is a syntax error, since ‘exec’
would define a new local variable named ‘x’ whose value should be
accessed by ‘g()’.

This shouldn’t be much of a limitation, since ‘exec’ is rarely used in
most Python code (and when it is used, it’s often a sign of a poor
design anyway).

See also
........

PEP 227(1) - Statically Nested Scopes

     Written and implemented by Jeremy Hylton.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0227


File: python.info,  Node: New and Improved Modules<3>,  Next: Interpreter Changes and Fixes,  Prev: PEP 227 Nested Scopes,  Up: What’s New in Python 2 2

1.15.9 New and Improved Modules
-------------------------------

   * The ‘xmlrpclib’ module was contributed to the standard library by
     Fredrik Lundh, providing support for writing XML-RPC clients.
     XML-RPC is a simple remote procedure call protocol built on top of
     HTTP and XML. For example, the following snippet retrieves a list
     of RSS channels from the O’Reilly Network, and then lists the
     recent headlines for one channel:

          import xmlrpclib
          s = xmlrpclib.Server(
                'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
          channels = s.meerkat.getChannels()
          # channels is a list of dictionaries, like this:
          # [{'id': 4, 'title': 'Freshmeat Daily News'}
          #  {'id': 190, 'title': '32Bits Online'},
          #  {'id': 4549, 'title': '3DGamers'}, ... ]

          # Get the items for one channel
          items = s.meerkat.getItems( {'channel': 4} )

          # 'items' is another list of dictionaries, like this:
          # [{'link': 'http://freshmeat.net/releases/52719/',
          #   'description': 'A utility which converts HTML to XSL FO.',
          #   'title': 'html2fo 0.3 (Default)'}, ... ]

     The ‘SimpleXMLRPCServer’ module makes it easy to create
     straightforward XML-RPC servers.  See
     ‘http://xmlrpc.scripting.com/’ for more information about XML-RPC.

   * The new *note hmac: 8f. module implements the HMAC algorithm
     described by RFC 2104(1).  (Contributed by Gerhard Häring.)

   * Several functions that originally returned lengthy tuples now
     return pseudo-sequences that still behave like tuples but also have
     mnemonic attributes such as memberst_mtime or ‘tm_year’.  The
     enhanced functions include *note stat(): f4, ‘fstat()’,
     ‘statvfs()’, and ‘fstatvfs()’ in the *note os: c4. module, and
     ‘localtime()’, ‘gmtime()’, and ‘strptime()’ in the *note time: 10a.
     module.

     For example, to obtain a file’s size using the old tuples, you’d
     end up writing something like ‘file_size =
     os.stat(filename)[stat.ST_SIZE]’, but now this can be written more
     clearly as ‘file_size = os.stat(filename).st_size’.

     The original patch for this feature was contributed by Nick
     Mathewson.

   * The Python profiler has been extensively reworked and various
     errors in its output have been corrected.  (Contributed by Fred L.
     Drake, Jr.  and Tim Peters.)

   * The *note socket: ef. module can be compiled to support IPv6;
     specify the ‘--enable-ipv6’ option to Python’s configure script.
     (Contributed by Jun-ichiro “itojun” Hagino.)

   * Two new format characters were added to the *note struct: f8.
     module for 64-bit integers on platforms that support the C ‘long
     long’ type.  ‘q’ is for a signed 64-bit integer, and ‘Q’ is for an
     unsigned one.  The value is returned in Python’s long integer type.
     (Contributed by Tim Peters.)

   * In the interpreter’s interactive mode, there’s a new built-in
     function *note help(): 567. that uses the *note pydoc: d9. module
     introduced in Python 2.1 to provide interactive help.
     ‘help(object)’ displays any available help text about `object'.
     *note help(): 567. with no argument puts you in an online help
     utility, where you can enter the names of functions, classes, or
     modules to read their help text.  (Contributed by Guido van Rossum,
     using Ka-Ping Yee’s *note pydoc: d9. module.)

   * Various bugfixes and performance improvements have been made to the
     SRE engine underlying the *note re: dd. module.  For example, the
     *note re.sub(): 470. and *note re.split(): 3bf. functions have been
     rewritten in C. Another contributed patch speeds up certain Unicode
     character ranges by a factor of two, and a new ‘finditer()’ method
     that returns an iterator over all the non-overlapping matches in a
     given string.  (SRE is maintained by Fredrik Lundh.  The BIGCHARSET
     patch was contributed by Martin von Löwis.)

   * The *note smtplib: ed. module now supports RFC 2487(2), “Secure
     SMTP over TLS”, so it’s now possible to encrypt the SMTP traffic
     between a Python program and the mail transport agent being handed
     a message.  *note smtplib: ed. also supports SMTP authentication.
     (Contributed by Gerhard Häring.)

   * The *note imaplib: 98. module, maintained by Piers Lauder, has
     support for several new extensions: the NAMESPACE extension defined
     in RFC 2342(3), SORT, GETACL and SETACL. (Contributed by Anthony
     Baxter and Michel Pelletier.)

   * The ‘rfc822’ module’s parsing of email addresses is now compliant
     with RFC 2822(4), an update to RFC 822(5).  (The module’s name is
     `not' going to be changed to ‘rfc2822’.)  A new package, *note
     email: 69, has also been added for parsing and generating e-mail
     messages.  (Contributed by Barry Warsaw, and arising out of his
     work on Mailman.)

   * The *note difflib: 37. module now contains a new ‘Differ’ class for
     producing human-readable lists of changes (a “delta”) between two
     sequences of lines of text.  There are also two generator
     functions, ‘ndiff()’ and ‘restore()’, which respectively return a
     delta from two sequences, or one of the original sequences from a
     delta.  (Grunt work contributed by David Goodger, from ndiff.py
     code by Tim Peters who then did the generatorization.)

   * New constants ‘ascii_letters’, ‘ascii_lowercase’, and
     ‘ascii_uppercase’ were added to the *note string: f6. module.
     There were several modules in the standard library that used
     ‘string.letters’ to mean the ranges A-Za-z, but that assumption is
     incorrect when locales are in use, because ‘string.letters’ varies
     depending on the set of legal characters defined by the current
     locale.  The buggy modules have all been fixed to use
     ‘ascii_letters’ instead.  (Reported by an unknown person; fixed by
     Fred L. Drake, Jr.)

   * The *note mimetypes: b2. module now makes it easier to use
     alternative MIME-type databases by the addition of a ‘MimeTypes’
     class, which takes a list of filenames to be parsed.  (Contributed
     by Fred L. Drake, Jr.)

   * A ‘Timer’ class was added to the *note threading: 109. module that
     allows scheduling an activity to happen at some future time.
     (Contributed by Itamar Shtull-Trauring.)

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2104.html

   (2) https://tools.ietf.org/html/rfc2487.html

   (3) https://tools.ietf.org/html/rfc2342.html

   (4) https://tools.ietf.org/html/rfc2822.html

   (5) https://tools.ietf.org/html/rfc822.html


File: python.info,  Node: Interpreter Changes and Fixes,  Next: Other Changes and Fixes<3>,  Prev: New and Improved Modules<3>,  Up: What’s New in Python 2 2

1.15.10 Interpreter Changes and Fixes
-------------------------------------

Some of the changes only affect people who deal with the Python
interpreter at the C level because they’re writing Python extension
modules, embedding the interpreter, or just hacking on the interpreter
itself.  If you only write Python code, none of the changes described
here will affect you very much.

   * Profiling and tracing functions can now be implemented in C, which
     can operate at much higher speeds than Python-based functions and
     should reduce the overhead of profiling and tracing.  This will be
     of interest to authors of development environments for Python.  Two
     new C functions were added to Python’s API, *note
     PyEval_SetProfile(): e2e. and *note PyEval_SetTrace(): e2f.  The
     existing *note sys.setprofile(): e30. and *note sys.settrace():
     e31. functions still exist, and have simply been changed to use the
     new C-level interface.  (Contributed by Fred L. Drake, Jr.)

   * Another low-level API, primarily of interest to implementors of
     Python debuggers and development tools, was added.  *note
     PyInterpreterState_Head(): e32. and *note
     PyInterpreterState_Next(): e33. let a caller walk through all the
     existing interpreter objects; *note
     PyInterpreterState_ThreadHead(): e34. and *note
     PyThreadState_Next(): e35. allow looping over all the thread states
     for a given interpreter.  (Contributed by David Beazley.)

   * The C-level interface to the garbage collector has been changed to
     make it easier to write extension types that support garbage
     collection and to debug misuses of the functions.  Various
     functions have slightly different semantics, so a bunch of
     functions had to be renamed.  Extensions that use the old API will
     still compile but will `not' participate in garbage collection, so
     updating them for 2.2 should be considered fairly high priority.

     To upgrade an extension module to the new API, perform the
     following steps:

   * Rename ‘Py_TPFLAGS_GC()’ to ‘PyTPFLAGS_HAVE_GC()’.

   * 
     Use *note PyObject_GC_New(): 2d2. or *note PyObject_GC_NewVar(): 2d3. to allocate

          objects, and *note PyObject_GC_Del(): e36. to deallocate them.

   * 
     Rename ‘PyObject_GC_Init()’ to *note PyObject_GC_Track(): e37. and

          ‘PyObject_GC_Fini()’ to *note PyObject_GC_UnTrack(): e38.

   * Remove ‘PyGC_HEAD_SIZE()’ from object size calculations.

   * Remove calls to ‘PyObject_AS_GC()’ and ‘PyObject_FROM_GC()’.

   * A new ‘et’ format sequence was added to *note PyArg_ParseTuple():
     268.; ‘et’ takes both a parameter and an encoding name, and
     converts the parameter to the given encoding if the parameter turns
     out to be a Unicode string, or leaves it alone if it’s an 8-bit
     string, assuming it to already be in the desired encoding.  This
     differs from the ‘es’ format character, which assumes that 8-bit
     strings are in Python’s default ASCII encoding and converts them to
     the specified new encoding.  (Contributed by M.-A. Lemburg, and
     used for the MBCS support on Windows described in the following
     section.)

   * A different argument parsing function, *note PyArg_UnpackTuple():
     e39, has been added that’s simpler and presumably faster.  Instead
     of specifying a format string, the caller simply gives the minimum
     and maximum number of arguments expected, and a set of pointers to
     *note PyObject*: 4b0. variables that will be filled in with
     argument values.

   * Two new flags *note METH_NOARGS: e0b. and *note METH_O: e3a. are
     available in method definition tables to simplify implementation of
     methods with no arguments or a single untyped argument.  Calling
     such methods is more efficient than calling a corresponding method
     that uses *note METH_VARARGS: e3b.  Also, the old ‘METH_OLDARGS’
     style of writing C methods is now officially deprecated.

   * Two new wrapper functions, *note PyOS_snprintf(): e3c. and *note
     PyOS_vsnprintf(): e3d. were added to provide cross-platform
     implementations for the relatively new ‘snprintf()’ and
     ‘vsnprintf()’ C lib APIs.  In contrast to the standard ‘sprintf()’
     and ‘vsprintf()’ functions, the Python versions check the bounds of
     the buffer used to protect against buffer overruns.  (Contributed
     by M.-A. Lemburg.)

   * The *note _PyTuple_Resize(): e3e. function has lost an unused
     parameter, so now it takes 2 parameters instead of 3.  The third
     argument was never used, and can simply be discarded when porting
     code from earlier versions to Python 2.2.


File: python.info,  Node: Other Changes and Fixes<3>,  Next: Acknowledgements<6>,  Prev: Interpreter Changes and Fixes,  Up: What’s New in Python 2 2

1.15.11 Other Changes and Fixes
-------------------------------

As usual there were a bunch of other improvements and bugfixes scattered
throughout the source tree.  A search through the CVS change logs finds
there were 527 patches applied and 683 bugs fixed between Python 2.1 and
2.2; 2.2.1 applied 139 patches and fixed 143 bugs; 2.2.2 applied 106
patches and fixed 82 bugs.  These figures are likely to be
underestimates.

Some of the more notable changes are:

   * The code for the MacOS port for Python, maintained by Jack Jansen,
     is now kept in the main Python CVS tree, and many changes have been
     made to support MacOS X.

     The most significant change is the ability to build Python as a
     framework, enabled by supplying the ‘--enable-framework’ option to
     the configure script when compiling Python.  According to Jack
     Jansen, “This installs a self-contained Python installation plus
     the OS X framework “glue” into
     ‘/Library/Frameworks/Python.framework’ (or another location of
     choice).  For now there is little immediate added benefit to this
     (actually, there is the disadvantage that you have to change your
     PATH to be able to find Python), but it is the basis for creating a
     full-blown Python application, porting the MacPython IDE, possibly
     using Python as a standard OSA scripting language and much more.”

     Most of the MacPython toolbox modules, which interface to MacOS
     APIs such as windowing, QuickTime, scripting, etc.  have been
     ported to OS X, but they’ve been left commented out in ‘setup.py’.
     People who want to experiment with these modules can uncomment them
     manually.

   * Keyword arguments passed to built-in functions that don’t take them
     now cause a *note TypeError: 192. exception to be raised, with the
     message “`function' takes no keyword arguments”.

   * Weak references, added in Python 2.1 as an extension module, are
     now part of the core because they’re used in the implementation of
     new-style classes.  The *note ReferenceError: e40. exception has
     therefore moved from the *note weakref: 128. module to become a
     built-in exception.

   * A new script, ‘Tools/scripts/cleanfuture.py’ by Tim Peters,
     automatically removes obsolete ‘__future__’ statements from Python
     source code.

   * An additional `flags' argument has been added to the built-in
     function *note compile(): 1b2, so the behaviour of ‘__future__’
     statements can now be correctly observed in simulated shells, such
     as those presented by IDLE and other development environments.
     This is described in PEP 264(1).  (Contributed by Michael Hudson.)

   * The new license introduced with Python 1.6 wasn’t GPL-compatible.
     This is fixed by some minor textual changes to the 2.2 license, so
     it’s now legal to embed Python inside a GPLed program again.  Note
     that Python itself is not GPLed, but instead is under a license
     that’s essentially equivalent to the BSD license, same as it always
     was.  The license changes were also applied to the Python 2.0.1 and
     2.1.1 releases.

   * When presented with a Unicode filename on Windows, Python will now
     convert it to an MBCS encoded string, as used by the Microsoft file
     APIs.  As MBCS is explicitly used by the file APIs, Python’s choice
     of ASCII as the default encoding turns out to be an annoyance.  On
     Unix, the locale’s character set is used if
     ‘locale.nl_langinfo(CODESET)’ is available.  (Windows support was
     contributed by Mark Hammond with assistance from Marc-André
     Lemburg.  Unix support was added by Martin von Löwis.)

   * Large file support is now enabled on Windows.  (Contributed by Tim
     Peters.)

   * The ‘Tools/scripts/ftpmirror.py’ script now parses a ‘.netrc’ file,
     if you have one.  (Contributed by Mike Romberg.)

   * Some features of the object returned by the ‘xrange()’ function are
     now deprecated, and trigger warnings when they’re accessed; they’ll
     disappear in Python 2.3.  ‘xrange’ objects tried to pretend they
     were full sequence types by supporting slicing, sequence
     multiplication, and the *note in: 797. operator, but these features
     were rarely used and therefore buggy.  The ‘tolist()’ method and
     the ‘start’, ‘stop’, and ‘step’ attributes are also being
     deprecated.  At the C level, the fourth argument to the
     ‘PyRange_New()’ function, ‘repeat’, has also been deprecated.

   * There were a bunch of patches to the dictionary implementation,
     mostly to fix potential core dumps if a dictionary contains objects
     that sneakily changed their hash value, or mutated the dictionary
     they were contained in.  For a while python-dev fell into a gentle
     rhythm of Michael Hudson finding a case that dumped core, Tim
     Peters fixing the bug, Michael finding another case, and round and
     round it went.

   * On Windows, Python can now be compiled with Borland C thanks to a
     number of patches contributed by Stephen Hansen, though the result
     isn’t fully functional yet.  (But this `is' progress…)

   * Another Windows enhancement: Wise Solutions generously offered
     PythonLabs use of their InstallerMaster 8.1 system.  Earlier
     PythonLabs Windows installers used Wise 5.0a, which was beginning
     to show its age.  (Packaged up by Tim Peters.)

   * Files ending in ‘.pyw’ can now be imported on Windows.  ‘.pyw’ is a
     Windows-only thing, used to indicate that a script needs to be run
     using PYTHONW.EXE instead of PYTHON.EXE in order to prevent a DOS
     console from popping up to display the output.  This patch makes it
     possible to import such scripts, in case they’re also usable as
     modules.  (Implemented by David Bolen.)

   * On platforms where Python uses the C ‘dlopen()’ function to load
     extension modules, it’s now possible to set the flags used by
     ‘dlopen()’ using the *note sys.getdlopenflags(): e41. and *note
     sys.setdlopenflags(): a5b. functions.  (Contributed by Bram Stolk.)

   * The *note pow(): 152. built-in function no longer supports 3
     arguments when floating-point numbers are supplied.  ‘pow(x, y, z)’
     returns ‘(x**y) % z’, but this is never useful for floating point
     numbers, and the final result varies unpredictably depending on the
     platform.  A call such as ‘pow(2.0, 8.0, 7.0)’ will now raise a
     *note TypeError: 192. exception.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0264


File: python.info,  Node: Acknowledgements<6>,  Prev: Other Changes and Fixes<3>,  Up: What’s New in Python 2 2

1.15.12 Acknowledgements
------------------------

The author would like to thank the following people for offering
suggestions, corrections and assistance with various drafts of this
article: Fred Bremmer, Keith Briggs, Andrew Dalke, Fred L. Drake, Jr.,
Carel Fellinger, David Goodger, Mark Hammond, Stephen Hansen, Michael
Hudson, Jack Jansen, Marc-André Lemburg, Martin von Löwis, Fredrik
Lundh, Michael McLay, Nick Mathewson, Paul Moore, Gustavo Niemeyer, Don
O’Donnell, Joonas Paalasma, Tim Peters, Jens Quade, Tom Reinhardt, Neil
Schemenauer, Guido van Rossum, Greg Ward, Edward Welbourne.


File: python.info,  Node: What’s New in Python 2 1,  Next: What’s New in Python 2 0,  Prev: What’s New in Python 2 2,  Up: What’s New in Python

1.16 What’s New in Python 2.1
=============================


Author: A.M. Kuchling

* Menu:

* Introduction: Introduction<2>.
* PEP 227; Nested Scopes: PEP 227 Nested Scopes<2>.
* PEP 236; __future__ Directives: PEP 236 __future__ Directives.
* PEP 207; Rich Comparisons: PEP 207 Rich Comparisons.
* PEP 230; Warning Framework: PEP 230 Warning Framework.
* PEP 229; New Build System: PEP 229 New Build System.
* PEP 205; Weak References: PEP 205 Weak References.
* PEP 232; Function Attributes: PEP 232 Function Attributes.
* PEP 235; Importing Modules on Case-Insensitive Platforms: PEP 235 Importing Modules on Case-Insensitive Platforms.
* PEP 217; Interactive Display Hook: PEP 217 Interactive Display Hook.
* PEP 208; New Coercion Model: PEP 208 New Coercion Model.
* PEP 241; Metadata in Python Packages: PEP 241 Metadata in Python Packages.
* New and Improved Modules: New and Improved Modules<4>.
* Other Changes and Fixes: Other Changes and Fixes<4>.
* Acknowledgements: Acknowledgements<7>.


File: python.info,  Node: Introduction<2>,  Next: PEP 227 Nested Scopes<2>,  Up: What’s New in Python 2 1

1.16.1 Introduction
-------------------

This article explains the new features in Python 2.1.  While there
aren’t as many changes in 2.1 as there were in Python 2.0, there are
still some pleasant surprises in store.  2.1 is the first release to be
steered through the use of Python Enhancement Proposals, or PEPs, so
most of the sizable changes have accompanying PEPs that provide more
complete documentation and a design rationale for the change.  This
article doesn’t attempt to document the new features completely, but
simply provides an overview of the new features for Python programmers.
Refer to the Python 2.1 documentation, or to the specific PEP, for more
details about any new feature that particularly interests you.

One recent goal of the Python development team has been to accelerate
the pace of new releases, with a new release coming every 6 to 9 months.
2.1 is the first release to come out at this faster pace, with the first
alpha appearing in January, 3 months after the final version of 2.0 was
released.

The final release of Python 2.1 was made on April 17, 2001.


File: python.info,  Node: PEP 227 Nested Scopes<2>,  Next: PEP 236 __future__ Directives,  Prev: Introduction<2>,  Up: What’s New in Python 2 1

1.16.2 PEP 227: Nested Scopes
-----------------------------

The largest change in Python 2.1 is to Python’s scoping rules.  In
Python 2.0, at any given time there are at most three namespaces used to
look up variable names: local, module-level, and the built-in namespace.
This often surprised people because it didn’t match their intuitive
expectations.  For example, a nested recursive function definition
doesn’t work:

     def f():
         ...
         def g(value):
             ...
             return g(value-1) + 1
         ...

The function ‘g()’ will always raise a *note NameError: d6e. exception,
because the binding of the name ‘g’ isn’t in either its local namespace
or in the module-level namespace.  This isn’t much of a problem in
practice (how often do you recursively define interior functions like
this?), but this also made using the *note lambda: c22. expression
clumsier, and this was a problem in practice.  In code which uses *note
lambda: c22. you can often find local variables being copied by passing
them as the default values of arguments.

     def find(self, name):
         "Return list of any entries equal to 'name'"
         L = filter(lambda x, name=name: x == name,
                    self.list_attribute)
         return L

The readability of Python code written in a strongly functional style
suffers greatly as a result.

The most significant change to Python 2.1 is that static scoping has
been added to the language to fix this problem.  As a first effect, the
‘name=name’ default argument is now unnecessary in the above example.
Put simply, when a given variable name is not assigned a value within a
function (by an assignment, or the *note def: db1, *note class: c5d, or
*note import: c10. statements), references to the variable will be
looked up in the local namespace of the enclosing scope.  A more
detailed explanation of the rules, and a dissection of the
implementation, can be found in the PEP.

This change may cause some compatibility problems for code where the
same variable name is used both at the module level and as a local
variable within a function that contains further function definitions.
This seems rather unlikely though, since such code would have been
pretty confusing to read in the first place.

One side effect of the change is that the ‘from module import *’ and
‘exec’ statements have been made illegal inside a function scope under
certain conditions.  The Python reference manual has said all along that
‘from module import *’ is only legal at the top level of a module, but
the CPython interpreter has never enforced this before.  As part of the
implementation of nested scopes, the compiler which turns Python source
into bytecodes has to generate different code to access variables in a
containing scope.  ‘from module import *’ and ‘exec’ make it impossible
for the compiler to figure this out, because they add names to the local
namespace that are unknowable at compile time.  Therefore, if a function
contains function definitions or *note lambda: c22. expressions with
free variables, the compiler will flag this by raising a *note
SyntaxError: 44d. exception.

To make the preceding explanation a bit clearer, here’s an example:

     x = 1
     def f():
         # The next line is a syntax error
         exec 'x=2'
         def g():
             return x

Line 4 containing the ‘exec’ statement is a syntax error, since ‘exec’
would define a new local variable named ‘x’ whose value should be
accessed by ‘g()’.

This shouldn’t be much of a limitation, since ‘exec’ is rarely used in
most Python code (and when it is used, it’s often a sign of a poor
design anyway).

Compatibility concerns have led to nested scopes being introduced
gradually; in Python 2.1, they aren’t enabled by default, but can be
turned on within a module by using a future statement as described in
PEP 236(1).  (See the following section for further discussion of PEP
236(2).)  In Python 2.2, nested scopes will become the default and there
will be no way to turn them off, but users will have had all of 2.1’s
lifetime to fix any breakage resulting from their introduction.

See also
........

PEP 227(3) - Statically Nested Scopes

     Written and implemented by Jeremy Hylton.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0236

   (2) https://www.python.org/dev/peps/pep-0236

   (3) https://www.python.org/dev/peps/pep-0227


File: python.info,  Node: PEP 236 __future__ Directives,  Next: PEP 207 Rich Comparisons,  Prev: PEP 227 Nested Scopes<2>,  Up: What’s New in Python 2 1

1.16.3 PEP 236: __future__ Directives
-------------------------------------

The reaction to nested scopes was widespread concern about the dangers
of breaking code with the 2.1 release, and it was strong enough to make
the Pythoneers take a more conservative approach.  This approach
consists of introducing a convention for enabling optional functionality
in release N that will become compulsory in release N+1.

The syntax uses a ‘from...import’ statement using the reserved module
name *note __future__: 0.  Nested scopes can be enabled by the following
statement:

     from __future__ import nested_scopes

While it looks like a normal *note import: c10. statement, it’s not;
there are strict rules on where such a future statement can be put.
They can only be at the top of a module, and must precede any Python
code or regular ‘import’ statements.  This is because such statements
can affect how the Python bytecode compiler parses code and generates
bytecode, so they must precede any statement that will result in
bytecodes being produced.

See also
........

PEP 236(1) - Back to the *note __future__: 0.

     Written by Tim Peters, and primarily implemented by Jeremy Hylton.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0236


File: python.info,  Node: PEP 207 Rich Comparisons,  Next: PEP 230 Warning Framework,  Prev: PEP 236 __future__ Directives,  Up: What’s New in Python 2 1

1.16.4 PEP 207: Rich Comparisons
--------------------------------

In earlier versions, Python’s support for implementing comparisons on
user-defined classes and extension types was quite simple.  Classes
could implement a ‘__cmp__()’ method that was given two instances of a
class, and could only return 0 if they were equal or +1 or -1 if they
weren’t; the method couldn’t raise an exception or return anything other
than a Boolean value.  Users of Numeric Python often found this model
too weak and restrictive, because in the number-crunching programs that
numeric Python is used for, it would be more useful to be able to
perform elementwise comparisons of two matrices, returning a matrix
containing the results of a given comparison for each element.  If the
two matrices are of different sizes, then the compare has to be able to
raise an exception to signal the error.

In Python 2.1, rich comparisons were added in order to support this
need.  Python classes can now individually overload each of the ‘<’,
‘<=’, ‘>’, ‘>=’, ‘==’, and ‘!=’ operations.  The new magic method names
are:

Operation       Method name
                
-------------------------------------
                
‘<’             *note __lt__(): c27.
                
                
‘<=’            *note __le__(): c93.
                
                
‘>’             *note __gt__(): c94.
                
                
‘>=’            *note __ge__(): c95.
                
                
‘==’            *note __eq__(): 334.
                
                
‘!=’            *note __ne__(): e49.
                

(The magic methods are named after the corresponding Fortran operators
‘.LT.’.  ‘.LE.’, &c.  Numeric programmers are almost certainly quite
familiar with these names and will find them easy to remember.)

Each of these magic methods is of the form ‘method(self, other)’, where
‘self’ will be the object on the left-hand side of the operator, while
‘other’ will be the object on the right-hand side.  For example, the
expression ‘A < B’ will cause ‘A.__lt__(B)’ to be called.

Each of these magic methods can return anything at all: a Boolean, a
matrix, a list, or any other Python object.  Alternatively they can
raise an exception if the comparison is impossible, inconsistent, or
otherwise meaningless.

The built-in ‘cmp(A,B)’ function can use the rich comparison machinery,
and now accepts an optional argument specifying which comparison
operation to use; this is given as one of the strings ‘"<"’, ‘"<="’,
‘">"’, ‘">="’, ‘"=="’, or ‘"!="’.  If called without the optional third
argument, ‘cmp()’ will only return -1, 0, or +1 as in previous versions
of Python; otherwise it will call the appropriate method and can return
any Python object.

There are also corresponding changes of interest to C programmers;
there’s a new slot ‘tp_richcmp’ in type objects and an API for
performing a given rich comparison.  I won’t cover the C API here, but
will refer you to PEP 207(1), or to 2.1’s C API documentation, for the
full list of related functions.

See also
........

PEP 207(2) - Rich Comparisons

     Written by Guido van Rossum, heavily based on earlier work by David
     Ascher, and implemented by Guido van Rossum.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0207

   (2) https://www.python.org/dev/peps/pep-0207


File: python.info,  Node: PEP 230 Warning Framework,  Next: PEP 229 New Build System,  Prev: PEP 207 Rich Comparisons,  Up: What’s New in Python 2 1

1.16.5 PEP 230: Warning Framework
---------------------------------

Over its 10 years of existence, Python has accumulated a certain number
of obsolete modules and features along the way.  It’s difficult to know
when a feature is safe to remove, since there’s no way of knowing how
much code uses it — perhaps no programs depend on the feature, or
perhaps many do.  To enable removing old features in a more structured
way, a warning framework was added.  When the Python developers want to
get rid of a feature, it will first trigger a warning in the next
version of Python.  The following Python version can then drop the
feature, and users will have had a full release cycle to remove uses of
the old feature.

Python 2.1 adds the warning framework to be used in this scheme.  It
adds a *note warnings: 126. module that provide functions to issue
warnings, and to filter out warnings that you don’t want to be
displayed.  Third-party modules can also use this framework to deprecate
old features that they no longer wish to support.

For example, in Python 2.1 the ‘regex’ module is deprecated, so
importing it causes a warning to be printed:

     >>> import regex
     __main__:1: DeprecationWarning: the regex module
              is deprecated; please use the re module
     >>>

Warnings can be issued by calling the *note warnings.warn(): e4b.
function:

     warnings.warn("feature X no longer supported")

The first parameter is the warning message; an additional optional
parameters can be used to specify a particular warning category.

Filters can be added to disable certain warnings; a regular expression
pattern can be applied to the message or to the module name in order to
suppress a warning.  For example, you may have a program that uses the
‘regex’ module and not want to spare the time to convert it to use the
*note re: dd. module right now.  The warning can be suppressed by
calling

     import warnings
     warnings.filterwarnings(action = 'ignore',
                             message='.*regex module is deprecated',
                             category=DeprecationWarning,
                             module = '__main__')

This adds a filter that will apply only to warnings of the class *note
DeprecationWarning: 276. triggered in the *note __main__: 1. module, and
applies a regular expression to only match the message about the ‘regex’
module being deprecated, and will cause such warnings to be ignored.
Warnings can also be printed only once, printed every time the offending
code is executed, or turned into exceptions that will cause the program
to stop (unless the exceptions are caught in the usual way, of course).

Functions were also added to Python’s C API for issuing warnings; refer
to PEP 230 or to Python’s API documentation for the details.

See also
........

PEP 5(1) - Guidelines for Language Evolution

     Written by Paul Prescod, to specify procedures to be followed when
     removing old features from Python.  The policy described in this
     PEP hasn’t been officially adopted, but the eventual policy
     probably won’t be too different from Prescod’s proposal.

PEP 230(2) - Warning Framework

     Written and implemented by Guido van Rossum.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0005

   (2) https://www.python.org/dev/peps/pep-0230


File: python.info,  Node: PEP 229 New Build System,  Next: PEP 205 Weak References,  Prev: PEP 230 Warning Framework,  Up: What’s New in Python 2 1

1.16.6 PEP 229: New Build System
--------------------------------

When compiling Python, the user had to go in and edit the
‘Modules/Setup’ file in order to enable various additional modules; the
default set is relatively small and limited to modules that compile on
most Unix platforms.  This means that on Unix platforms with many more
features, most notably Linux, Python installations often don’t contain
all useful modules they could.

Python 2.0 added the Distutils, a set of modules for distributing and
installing extensions.  In Python 2.1, the Distutils are used to compile
much of the standard library of extension modules, autodetecting which
ones are supported on the current machine.  It’s hoped that this will
make Python installations easier and more featureful.

Instead of having to edit the ‘Modules/Setup’ file in order to enable
modules, a ‘setup.py’ script in the top directory of the Python source
distribution is run at build time, and attempts to discover which
modules can be enabled by examining the modules and header files on the
system.  If a module is configured in ‘Modules/Setup’, the ‘setup.py’
script won’t attempt to compile that module and will defer to the
‘Modules/Setup’ file’s contents.  This provides a way to specific any
strange command-line flags or libraries that are required for a specific
platform.

In another far-reaching change to the build mechanism, Neil Schemenauer
restructured things so Python now uses a single makefile that isn’t
recursive, instead of makefiles in the top directory and in each of the
‘Python/’, ‘Parser/’, ‘Objects/’, and ‘Modules/’ subdirectories.  This
makes building Python faster and also makes hacking the Makefiles
clearer and simpler.

See also
........

PEP 229(1) - Using Distutils to Build Python

     Written and implemented by A.M. Kuchling.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0229


File: python.info,  Node: PEP 205 Weak References,  Next: PEP 232 Function Attributes,  Prev: PEP 229 New Build System,  Up: What’s New in Python 2 1

1.16.7 PEP 205: Weak References
-------------------------------

Weak references, available through the *note weakref: 128. module, are a
minor but useful new data type in the Python programmer’s toolbox.

Storing a reference to an object (say, in a dictionary or a list) has
the side effect of keeping that object alive forever.  There are a few
specific cases where this behaviour is undesirable, object caches being
the most common one, and another being circular references in data
structures such as trees.

For example, consider a memoizing function that caches the results of
another function ‘f(x)’ by storing the function’s argument and its
result in a dictionary:

     _cache = {}
     def memoize(x):
         if _cache.has_key(x):
             return _cache[x]

         retval = f(x)

         # Cache the returned object
         _cache[x] = retval

         return retval

This version works for simple things such as integers, but it has a side
effect; the ‘_cache’ dictionary holds a reference to the return values,
so they’ll never be deallocated until the Python process exits and
cleans up.  This isn’t very noticeable for integers, but if ‘f()’
returns an object, or a data structure that takes up a lot of memory,
this can be a problem.

Weak references provide a way to implement a cache that won’t keep
objects alive beyond their time.  If an object is only accessible
through weak references, the object will be deallocated and the weak
references will now indicate that the object it referred to no longer
exists.  A weak reference to an object `obj' is created by calling ‘wr =
weakref.ref(obj)’.  The object being referred to is returned by calling
the weak reference as if it were a function: ‘wr()’.  It will return the
referenced object, or ‘None’ if the object no longer exists.

This makes it possible to write a ‘memoize()’ function whose cache
doesn’t keep objects alive, by storing weak references in the cache.

     _cache = {}
     def memoize(x):
         if _cache.has_key(x):
             obj = _cache[x]()
             # If weak reference object still exists,
             # return it
             if obj is not None: return obj

         retval = f(x)

         # Cache a weak reference
         _cache[x] = weakref.ref(retval)

         return retval

The *note weakref: 128. module also allows creating proxy objects which
behave like weak references — an object referenced only by proxy objects
is deallocated – but instead of requiring an explicit call to retrieve
the object, the proxy transparently forwards all operations to the
object as long as the object still exists.  If the object is
deallocated, attempting to use a proxy will cause a *note
weakref.ReferenceError: e4e. exception to be raised.

     proxy = weakref.proxy(obj)
     proxy.attr   # Equivalent to obj.attr
     proxy.meth() # Equivalent to obj.meth()
     del obj
     proxy.attr   # raises weakref.ReferenceError

See also
........

PEP 205(1) - Weak References

     Written and implemented by Fred L. Drake, Jr.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0205


File: python.info,  Node: PEP 232 Function Attributes,  Next: PEP 235 Importing Modules on Case-Insensitive Platforms,  Prev: PEP 205 Weak References,  Up: What’s New in Python 2 1

1.16.8 PEP 232: Function Attributes
-----------------------------------

In Python 2.1, functions can now have arbitrary information attached to
them.  People were often using docstrings to hold information about
functions and methods, because the ‘__doc__’ attribute was the only way
of attaching any information to a function.  For example, in the Zope
Web application server, functions are marked as safe for public access
by having a docstring, and in John Aycock’s SPARK parsing framework,
docstrings hold parts of the BNF grammar to be parsed.  This overloading
is unfortunate, since docstrings are really intended to hold a
function’s documentation; for example, it means you can’t properly
document functions intended for private use in Zope.

Arbitrary attributes can now be set and retrieved on functions using the
regular Python syntax:

     def f(): pass

     f.publish = 1
     f.secure = 1
     f.grammar = "A ::= B (C D)*"

The dictionary containing attributes can be accessed as the function’s
*note __dict__: 4f1.  Unlike the *note __dict__: 4f1. attribute of class
instances, in functions you can actually assign a new dictionary to
*note __dict__: 4f1, though the new value is restricted to a regular
Python dictionary; you `can’t' be tricky and set it to a ‘UserDict’
instance, or any other random object that behaves like a mapping.

See also
........

PEP 232(1) - Function Attributes

     Written and implemented by Barry Warsaw.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0232


File: python.info,  Node: PEP 235 Importing Modules on Case-Insensitive Platforms,  Next: PEP 217 Interactive Display Hook,  Prev: PEP 232 Function Attributes,  Up: What’s New in Python 2 1

1.16.9 PEP 235: Importing Modules on Case-Insensitive Platforms
---------------------------------------------------------------

Some operating systems have filesystems that are case-insensitive, MacOS
and Windows being the primary examples; on these systems, it’s
impossible to distinguish the filenames ‘FILE.PY’ and ‘file.py’, even
though they do store the file’s name in its original case (they’re
case-preserving, too).

In Python 2.1, the *note import: c10. statement will work to simulate
case-sensitivity on case-insensitive platforms.  Python will now search
for the first case-sensitive match by default, raising an *note
ImportError: 329. if no such file is found, so ‘import file’ will not
import a module named ‘FILE.PY’.  Case-insensitive matching can be
requested by setting the *note PYTHONCASEOK: e51. environment variable
before starting the Python interpreter.


File: python.info,  Node: PEP 217 Interactive Display Hook,  Next: PEP 208 New Coercion Model,  Prev: PEP 235 Importing Modules on Case-Insensitive Platforms,  Up: What’s New in Python 2 1

1.16.10 PEP 217: Interactive Display Hook
-----------------------------------------

When using the Python interpreter interactively, the output of commands
is displayed using the built-in *note repr(): 7c0. function.  In Python
2.1, the variable *note sys.displayhook(): e53. can be set to a callable
object which will be called instead of *note repr(): 7c0.  For example,
you can set it to a special pretty-printing function:

     >>> # Create a recursive data structure
     ... L = [1,2,3]
     >>> L.append(L)
     >>> L # Show Python's default output
     [1, 2, 3, [...]]
     >>> # Use pprint.pprint() as the display function
     ... import sys, pprint
     >>> sys.displayhook = pprint.pprint
     >>> L
     [1, 2, 3,  <Recursion on list with id=135143996>]
     >>>

See also
........

PEP 217(1) - Display Hook for Interactive Use

     Written and implemented by Moshe Zadka.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0217


File: python.info,  Node: PEP 208 New Coercion Model,  Next: PEP 241 Metadata in Python Packages,  Prev: PEP 217 Interactive Display Hook,  Up: What’s New in Python 2 1

1.16.11 PEP 208: New Coercion Model
-----------------------------------

How numeric coercion is done at the C level was significantly modified.
This will only affect the authors of C extensions to Python, allowing
them more flexibility in writing extension types that support numeric
operations.

Extension types can now set the type flag ‘Py_TPFLAGS_CHECKTYPES’ in
their ‘PyTypeObject’ structure to indicate that they support the new
coercion model.  In such extension types, the numeric slot functions can
no longer assume that they’ll be passed two arguments of the same type;
instead they may be passed two arguments of differing types, and can
then perform their own internal coercion.  If the slot function is
passed a type it can’t handle, it can indicate the failure by returning
a reference to the ‘Py_NotImplemented’ singleton value.  The numeric
functions of the other type will then be tried, and perhaps they can
handle the operation; if the other type also returns
‘Py_NotImplemented’, then a *note TypeError: 192. will be raised.
Numeric methods written in Python can also return ‘Py_NotImplemented’,
causing the interpreter to act as if the method did not exist (perhaps
raising a *note TypeError: 192, perhaps trying another object’s numeric
methods).

See also
........

PEP 208(1) - Reworking the Coercion Model

     Written and implemented by Neil Schemenauer, heavily based upon
     earlier work by Marc-André Lemburg.  Read this to understand the
     fine points of how numeric operations will now be processed at the
     C level.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0208


File: python.info,  Node: PEP 241 Metadata in Python Packages,  Next: New and Improved Modules<4>,  Prev: PEP 208 New Coercion Model,  Up: What’s New in Python 2 1

1.16.12 PEP 241: Metadata in Python Packages
--------------------------------------------

A common complaint from Python users is that there’s no single catalog
of all the Python modules in existence.  T. Middleton’s Vaults of
Parnassus at ‘http://www.vex.net/parnassus/’ are the largest catalog of
Python modules, but registering software at the Vaults is optional, and
many people don’t bother.

As a first small step toward fixing the problem, Python software
packaged using the Distutils ‘sdist’ command will include a file named
‘PKG-INFO’ containing information about the package such as its name,
version, and author (metadata, in cataloguing terminology).  PEP 241(1)
contains the full list of fields that can be present in the ‘PKG-INFO’
file.  As people began to package their software using Python 2.1, more
and more packages will include metadata, making it possible to build
automated cataloguing systems and experiment with them.  With the result
experience, perhaps it’ll be possible to design a really good catalog
and then build support for it into Python 2.2.  For example, the
Distutils ‘sdist’ and ‘bdist_*’ commands could support an ‘upload’
option that would automatically upload your package to a catalog server.

You can start creating packages containing ‘PKG-INFO’ even if you’re not
using Python 2.1, since a new release of the Distutils will be made for
users of earlier Python versions.  Version 1.0.2 of the Distutils
includes the changes described in PEP 241(2), as well as various
bugfixes and enhancements.  It will be available from the Distutils SIG
at ‘https://www.python.org/community/sigs/current/distutils-sig/’.

See also
........

PEP 241(3) - Metadata for Python Software Packages

     Written and implemented by A.M. Kuchling.

PEP 243(4) - Module Repository Upload Mechanism

     Written by Sean Reifschneider, this draft PEP describes a proposed
     mechanism for uploading Python packages to a central server.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0241

   (2) https://www.python.org/dev/peps/pep-0241

   (3) https://www.python.org/dev/peps/pep-0241

   (4) https://www.python.org/dev/peps/pep-0243


File: python.info,  Node: New and Improved Modules<4>,  Next: Other Changes and Fixes<4>,  Prev: PEP 241 Metadata in Python Packages,  Up: What’s New in Python 2 1

1.16.13 New and Improved Modules
--------------------------------

   * Ka-Ping Yee contributed two new modules: ‘inspect.py’, a module for
     getting information about live Python code, and ‘pydoc.py’, a
     module for interactively converting docstrings to HTML or text.  As
     a bonus, ‘Tools/scripts/pydoc’, which is now automatically
     installed, uses ‘pydoc.py’ to display documentation given a Python
     module, package, or class name.  For example, ‘pydoc xml.dom’
     displays the following:

          Python Library Documentation: package xml.dom in xml

          NAME
              xml.dom - W3C Document Object Model implementation for Python.

          FILE
              /usr/local/lib/python2.1/xml/dom/__init__.pyc

          DESCRIPTION
              The Python mapping of the Document Object Model is documented in the
              Python Library Reference in the section on the xml.dom package.

              This package contains the following modules:
                ...

     ‘pydoc’ also includes a Tk-based interactive help browser.  ‘pydoc’
     quickly becomes addictive; try it out!

   * Two different modules for unit testing were added to the standard
     library.  The *note doctest: 67. module, contributed by Tim Peters,
     provides a testing framework based on running embedded examples in
     docstrings and comparing the results against the expected output.
     PyUnit, contributed by Steve Purcell, is a unit testing framework
     inspired by JUnit, which was in turn an adaptation of Kent Beck’s
     Smalltalk testing framework.  See ‘http://pyunit.sourceforge.net/’
     for more information about PyUnit.

   * The *note difflib: 37. module contains a class, ‘SequenceMatcher’,
     which compares two sequences and computes the changes required to
     transform one sequence into the other.  For example, this module
     can be used to write a tool similar to the Unix ‘diff’ program, and
     in fact the sample program ‘Tools/scripts/ndiff.py’ demonstrates
     how to write such a script.

   * *note curses.panel: 2e, a wrapper for the panel library, part of
     ncurses and of SYSV curses, was contributed by Thomas Gellekum.
     The panel library provides windows with the additional feature of
     depth.  Windows can be moved higher or lower in the depth ordering,
     and the panel library figures out where panels overlap and which
     sections are visible.

   * The PyXML package has gone through a few releases since Python 2.0,
     and Python 2.1 includes an updated version of the *note xml: 133.
     package.  Some of the noteworthy changes include support for Expat
     1.2 and later versions, the ability for Expat parsers to handle
     files in any encoding supported by Python, and various bugfixes for
     SAX, DOM, and the ‘minidom’ module.

   * Ping also contributed another hook for handling uncaught
     exceptions.  *note sys.excepthook(): e57. can be set to a callable
     object.  When an exception isn’t caught by any *note try:
     d65.…*note except: b31. blocks, the exception will be passed to
     *note sys.excepthook(): e57, which can then do whatever it likes.
     At the Ninth Python Conference, Ping demonstrated an application
     for this hook: printing an extended traceback that not only lists
     the stack frames, but also lists the function arguments and the
     local variables for each frame.

   * Various functions in the *note time: 10a. module, such as
     ‘asctime()’ and ‘localtime()’, require a floating point argument
     containing the time in seconds since the epoch.  The most common
     use of these functions is to work with the current time, so the
     floating point argument has been made optional; when a value isn’t
     provided, the current time will be used.  For example, log file
     entries usually need a string containing the current time; in
     Python 2.1, ‘time.asctime()’ can be used, instead of the lengthier
     ‘time.asctime(time.localtime(time.time()))’ that was previously
     required.

     This change was proposed and implemented by Thomas Wouters.

   * The *note ftplib: 84. module now defaults to retrieving files in
     passive mode, because passive mode is more likely to work from
     behind a firewall.  This request came from the Debian bug tracking
     system, since other Debian packages use *note ftplib: 84. to
     retrieve files and then don’t work from behind a firewall.  It’s
     deemed unlikely that this will cause problems for anyone, because
     Netscape defaults to passive mode and few people complain, but if
     passive mode is unsuitable for your application or network setup,
     call ‘set_pasv(0)’ on FTP objects to disable passive mode.

   * Support for raw socket access has been added to the *note socket:
     ef. module, contributed by Grant Edwards.

   * The *note pstats: d4. module now contains a simple interactive
     statistics browser for displaying timing profiles for Python
     programs, invoked when the module is run as a script.  Contributed
     by Eric S. Raymond.

   * A new implementation-dependent function, ‘sys._getframe([depth])’,
     has been added to return a given frame object from the current call
     stack.  *note sys._getframe(): e58. returns the frame at the top of
     the call stack; if the optional integer argument `depth' is
     supplied, the function returns the frame that is `depth' calls
     below the top of the stack.  For example, ‘sys._getframe(1)’
     returns the caller’s frame object.

     This function is only present in CPython, not in Jython or the .NET
     implementation.  Use it for debugging, and resist the temptation to
     put it into production code.


File: python.info,  Node: Other Changes and Fixes<4>,  Next: Acknowledgements<7>,  Prev: New and Improved Modules<4>,  Up: What’s New in Python 2 1

1.16.14 Other Changes and Fixes
-------------------------------

There were relatively few smaller changes made in Python 2.1 due to the
shorter release cycle.  A search through the CVS change logs turns up
117 patches applied, and 136 bugs fixed; both figures are likely to be
underestimates.  Some of the more notable changes are:

   * A specialized object allocator is now optionally available, that
     should be faster than the system ‘malloc()’ and have less memory
     overhead.  The allocator uses C’s ‘malloc()’ function to get large
     pools of memory, and then fulfills smaller memory requests from
     these pools.  It can be enabled by providing the ‘--with-pymalloc’
     option to the ‘configure’ script; see ‘Objects/obmalloc.c’ for the
     implementation details.

     Authors of C extension modules should test their code with the
     object allocator enabled, because some incorrect code may break,
     causing core dumps at runtime.  There are a bunch of memory
     allocation functions in Python’s C API that have previously been
     just aliases for the C library’s ‘malloc()’ and ‘free()’, meaning
     that if you accidentally called mismatched functions, the error
     wouldn’t be noticeable.  When the object allocator is enabled,
     these functions aren’t aliases of ‘malloc()’ and ‘free()’ any more,
     and calling the wrong function to free memory will get you a core
     dump.  For example, if memory was allocated using ‘PyMem_New()’, it
     has to be freed using ‘PyMem_Del()’, not ‘free()’.  A few modules
     included with Python fell afoul of this and had to be fixed;
     doubtless there are more third-party modules that will have the
     same problem.

     The object allocator was contributed by Vladimir Marangozov.

   * The speed of line-oriented file I/O has been improved because
     people often complain about its lack of speed, and because it’s
     often been used as a naïve benchmark.  The *note readline(): de.
     method of file objects has therefore been rewritten to be much
     faster.  The exact amount of the speedup will vary from platform to
     platform depending on how slow the C library’s ‘getc()’ was, but is
     around 66%, and potentially much faster on some particular
     operating systems.  Tim Peters did much of the benchmarking and
     coding for this change, motivated by a discussion in
     comp.lang.python.

     A new module and method for file objects was also added,
     contributed by Jeff Epler.  The new method, ‘xreadlines()’, is
     similar to the existing ‘xrange()’ built-in.  ‘xreadlines()’
     returns an opaque sequence object that only supports being iterated
     over, reading a line on every iteration but not reading the entire
     file into memory as the existing ‘readlines()’ method does.  You’d
     use it like this:

          for line in sys.stdin.xreadlines():
              # ... do something for each line ...
              ...

     For a fuller discussion of the line I/O changes, see the python-dev
     summary for January 1–15, 2001 at
     ‘https://mail.python.org/pipermail/python-dev/2001-January/’.

   * A new method, ‘popitem()’, was added to dictionaries to enable
     destructively iterating through the contents of a dictionary; this
     can be faster for large dictionaries because there’s no need to
     construct a list containing all the keys or values.  ‘D.popitem()’
     removes a random ‘(key, value)’ pair from the dictionary ‘D’ and
     returns it as a 2-tuple.  This was implemented mostly by Tim Peters
     and Guido van Rossum, after a suggestion and preliminary patch by
     Moshe Zadka.

   * Modules can now control which names are imported when ‘from module
     import *’ is used, by defining an ‘__all__’ attribute containing a
     list of names that will be imported.  One common complaint is that
     if the module imports other modules such as *note sys: fd. or *note
     string: f6, ‘from module import *’ will add them to the importing
     module’s namespace.  To fix this, simply list the public names in
     ‘__all__’:

          # List public names
          __all__ = ['Database', 'open']

     A stricter version of this patch was first suggested and
     implemented by Ben Wolfson, but after some python-dev discussion, a
     weaker final version was checked in.

   * Applying *note repr(): 7c0. to strings previously used octal
     escapes for non-printable characters; for example, a newline was
     ‘'\012'’.  This was a vestigial trace of Python’s C ancestry, but
     today octal is of very little practical use.  Ka-Ping Yee suggested
     using hex escapes instead of octal ones, and using the ‘\n’, ‘\t’,
     ‘\r’ escapes for the appropriate characters, and implemented this
     new formatting.

   * Syntax errors detected at compile-time can now raise exceptions
     containing the filename and line number of the error, a pleasant
     side effect of the compiler reorganization done by Jeremy Hylton.

   * C extensions which import other modules have been changed to use
     ‘PyImport_ImportModule()’, which means that they will use any
     import hooks that have been installed.  This is also encouraged for
     third-party extensions that need to import some other module from C
     code.

   * The size of the Unicode character database was shrunk by another
     340K thanks to Fredrik Lundh.

   * Some new ports were contributed: MacOS X (by Steven Majewski),
     Cygwin (by Jason Tishler); RISCOS (by Dietmar Schwertberger);
     Unixware 7 (by Billy G. Allie).

And there’s the usual list of minor bugfixes, minor memory leaks,
docstring edits, and other tweaks, too lengthy to be worth itemizing;
see the CVS logs for the full details if you want them.


File: python.info,  Node: Acknowledgements<7>,  Prev: Other Changes and Fixes<4>,  Up: What’s New in Python 2 1

1.16.15 Acknowledgements
------------------------

The author would like to thank the following people for offering
suggestions on various drafts of this article: Graeme Cross, David
Goodger, Jay Graves, Michael Hudson, Marc-André Lemburg, Fredrik Lundh,
Neil Schemenauer, Thomas Wouters.


File: python.info,  Node: What’s New in Python 2 0,  Next: Changelog,  Prev: What’s New in Python 2 1,  Up: What’s New in Python

1.17 What’s New in Python 2.0
=============================


Author: A.M. Kuchling and Moshe Zadka

* Menu:

* Introduction: Introduction<3>.
* What About Python 1.6?: What About Python 1 6?.
* New Development Process::
* Unicode: Unicode<2>.
* List Comprehensions::
* Augmented Assignment::
* String Methods::
* Garbage Collection of Cycles::
* Other Core Changes::
* Porting to 2.0: Porting to 2 0.
* Extending/Embedding Changes::
* Distutils; Making Modules Easy to Install: Distutils Making Modules Easy to Install.
* XML Modules::
* Module changes::
* New modules::
* IDLE Improvements::
* Deleted and Deprecated Modules::
* Acknowledgements: Acknowledgements<8>.


File: python.info,  Node: Introduction<3>,  Next: What About Python 1 6?,  Up: What’s New in Python 2 0

1.17.1 Introduction
-------------------

A new release of Python, version 2.0, was released on October 16, 2000.
This article covers the exciting new features in 2.0, highlights some
other useful changes, and points out a few incompatible changes that may
require rewriting code.

Python’s development never completely stops between releases, and a
steady flow of bug fixes and improvements are always being submitted.  A
host of minor fixes, a few optimizations, additional docstrings, and
better error messages went into 2.0; to list them all would be
impossible, but they’re certainly significant.  Consult the
publicly-available CVS logs if you want to see the full list.  This
progress is due to the five developers working for PythonLabs are now
getting paid to spend their days fixing bugs, and also due to the
improved communication resulting from moving to SourceForge.


File: python.info,  Node: What About Python 1 6?,  Next: New Development Process,  Prev: Introduction<3>,  Up: What’s New in Python 2 0

1.17.2 What About Python 1.6?
-----------------------------

Python 1.6 can be thought of as the Contractual Obligations Python
release.  After the core development team left CNRI in May 2000, CNRI
requested that a 1.6 release be created, containing all the work on
Python that had been performed at CNRI. Python 1.6 therefore represents
the state of the CVS tree as of May 2000, with the most significant new
feature being Unicode support.  Development continued after May, of
course, so the 1.6 tree received a few fixes to ensure that it’s
forward-compatible with Python 2.0.  1.6 is therefore part of Python’s
evolution, and not a side branch.

So, should you take much interest in Python 1.6?  Probably not.  The
1.6final and 2.0beta1 releases were made on the same day (September 5,
2000), the plan being to finalize Python 2.0 within a month or so.  If
you have applications to maintain, there seems little point in breaking
things by moving to 1.6, fixing them, and then having another round of
breakage within a month by moving to 2.0; you’re better off just going
straight to 2.0.  Most of the really interesting features described in
this document are only in 2.0, because a lot of work was done between
May and September.


File: python.info,  Node: New Development Process,  Next: Unicode<2>,  Prev: What About Python 1 6?,  Up: What’s New in Python 2 0

1.17.3 New Development Process
------------------------------

The most important change in Python 2.0 may not be to the code at all,
but to how Python is developed: in May 2000 the Python developers began
using the tools made available by SourceForge for storing source code,
tracking bug reports, and managing the queue of patch submissions.  To
report bugs or submit patches for Python 2.0, use the bug tracking and
patch manager tools available from Python’s project page, located at
‘https://sourceforge.net/projects/python/’.

The most important of the services now hosted at SourceForge is the
Python CVS tree, the version-controlled repository containing the source
code for Python.  Previously, there were roughly 7 or so people who had
write access to the CVS tree, and all patches had to be inspected and
checked in by one of the people on this short list.  Obviously, this
wasn’t very scalable.  By moving the CVS tree to SourceForge, it became
possible to grant write access to more people; as of September 2000
there were 27 people able to check in changes, a fourfold increase.
This makes possible large-scale changes that wouldn’t be attempted if
they’d have to be filtered through the small group of core developers.
For example, one day Peter Schneider-Kamp took it into his head to drop
K&R C compatibility and convert the C source for Python to ANSI C. After
getting approval on the python-dev mailing list, he launched into a
flurry of checkins that lasted about a week, other developers joined in
to help, and the job was done.  If there were only 5 people with write
access, probably that task would have been viewed as “nice, but not
worth the time and effort needed” and it would never have gotten done.

The shift to using SourceForge’s services has resulted in a remarkable
increase in the speed of development.  Patches now get submitted,
commented on, revised by people other than the original submitter, and
bounced back and forth between people until the patch is deemed worth
checking in.  Bugs are tracked in one central location and can be
assigned to a specific person for fixing, and we can count the number of
open bugs to measure progress.  This didn’t come without a cost:
developers now have more e-mail to deal with, more mailing lists to
follow, and special tools had to be written for the new environment.
For example, SourceForge sends default patch and bug notification e-mail
messages that are completely unhelpful, so Ka-Ping Yee wrote an HTML
screen-scraper that sends more useful messages.

The ease of adding code caused a few initial growing pains, such as code
was checked in before it was ready or without getting clear agreement
from the developer group.  The approval process that has emerged is
somewhat similar to that used by the Apache group.  Developers can vote
+1, +0, -0, or -1 on a patch; +1 and -1 denote acceptance or rejection,
while +0 and -0 mean the developer is mostly indifferent to the change,
though with a slight positive or negative slant.  The most significant
change from the Apache model is that the voting is essentially advisory,
letting Guido van Rossum, who has Benevolent Dictator For Life status,
know what the general opinion is.  He can still ignore the result of a
vote, and approve or reject a change even if the community disagrees
with him.

Producing an actual patch is the last step in adding a new feature, and
is usually easy compared to the earlier task of coming up with a good
design.  Discussions of new features can often explode into lengthy
mailing list threads, making the discussion hard to follow, and no one
can read every posting to python-dev.  Therefore, a relatively formal
process has been set up to write Python Enhancement Proposals (PEPs),
modelled on the Internet RFC process.  PEPs are draft documents that
describe a proposed new feature, and are continually revised until the
community reaches a consensus, either accepting or rejecting the
proposal.  Quoting from the introduction to PEP 1(1), “PEP Purpose and
Guidelines”:

     PEP stands for Python Enhancement Proposal.  A PEP is a design
     document providing information to the Python community, or
     describing a new feature for Python.  The PEP should provide a
     concise technical specification of the feature and a rationale for
     the feature.

     We intend PEPs to be the primary mechanisms for proposing new
     features, for collecting community input on an issue, and for
     documenting the design decisions that have gone into Python.  The
     PEP author is responsible for building consensus within the
     community and documenting dissenting opinions.

Read the rest of PEP 1(2) for the details of the PEP editorial process,
style, and format.  PEPs are kept in the Python CVS tree on SourceForge,
though they’re not part of the Python 2.0 distribution, and are also
available in HTML form from ‘https://www.python.org/dev/peps/’.  As of
September 2000, there are 25 PEPS, ranging from PEP 201(3), “Lockstep
Iteration”, to PEP 225, “Elementwise/Objectwise Operators”.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0001

   (2) https://www.python.org/dev/peps/pep-0001

   (3) https://www.python.org/dev/peps/pep-0201


File: python.info,  Node: Unicode<2>,  Next: List Comprehensions,  Prev: New Development Process,  Up: What’s New in Python 2 0

1.17.4 Unicode
--------------

The largest new feature in Python 2.0 is a new fundamental data type:
Unicode strings.  Unicode uses 16-bit numbers to represent characters
instead of the 8-bit number used by ASCII, meaning that 65,536 distinct
characters can be supported.

The final interface for Unicode support was arrived at through countless
often-stormy discussions on the python-dev mailing list, and mostly
implemented by Marc-André Lemburg, based on a Unicode string type
implementation by Fredrik Lundh.  A detailed explanation of the
interface was written up as PEP 100(1), “Python Unicode Integration”.
This article will simply cover the most significant points about the
Unicode interfaces.

In Python source code, Unicode strings are written as ‘u"string"’.
Arbitrary Unicode characters can be written using a new escape sequence,
‘\uHHHH’, where `HHHH' is a 4-digit hexadecimal number from 0000 to
FFFF. The existing ‘\xHHHH’ escape sequence can also be used, and octal
escapes can be used for characters up to U+01FF, which is represented by
‘\777’.

Unicode strings, just like regular strings, are an immutable sequence
type.  They can be indexed and sliced, but not modified in place.
Unicode strings have an ‘encode( [encoding] )’ method that returns an
8-bit string in the desired encoding.  Encodings are named by strings,
such as ‘'ascii'’, ‘'utf-8'’, ‘'iso-8859-1'’, or whatever.  A codec API
is defined for implementing and registering new encodings that are then
available throughout a Python program.  If an encoding isn’t specified,
the default encoding is usually 7-bit ASCII, though it can be changed
for your Python installation by calling the
‘sys.setdefaultencoding(encoding)’ function in a customized version of
‘site.py’.

Combining 8-bit and Unicode strings always coerces to Unicode, using the
default ASCII encoding; the result of ‘'a' + u'bc'’ is ‘u'abc'’.

New built-in functions have been added, and existing built-ins modified
to support Unicode:

   * ‘unichr(ch)’ returns a Unicode string 1 character long, containing
     the character `ch'.

   * ‘ord(u)’, where `u' is a 1-character regular or Unicode string,
     returns the number of the character as an integer.

   * ‘unicode(string [, encoding] [, errors] )’ creates a Unicode string
     from an 8-bit string.  ‘encoding’ is a string naming the encoding
     to use.  The ‘errors’ parameter specifies the treatment of
     characters that are invalid for the current encoding; passing
     ‘'strict'’ as the value causes an exception to be raised on any
     encoding error, while ‘'ignore'’ causes errors to be silently
     ignored and ‘'replace'’ uses U+FFFD, the official replacement
     character, in case of any problems.

   * The ‘exec’ statement, and various built-ins such as ‘eval()’,
     ‘getattr()’, and ‘setattr()’ will also accept Unicode strings as
     well as regular strings.  (It’s possible that the process of fixing
     this missed some built-ins; if you find a built-in function that
     accepts strings but doesn’t accept Unicode strings at all, please
     report it as a bug.)

A new module, *note unicodedata: 11a, provides an interface to Unicode
character properties.  For example, ‘unicodedata.category(u'A')’ returns
the 2-character string ‘Lu’, the ‘L’ denoting it’s a letter, and ‘u’
meaning that it’s uppercase.  ‘unicodedata.bidirectional(u'\u0660')’
returns ‘AN’, meaning that U+0660 is an Arabic number.

The *note codecs: 1c. module contains functions to look up existing
encodings and register new ones.  Unless you want to implement a new
encoding, you’ll most often use the ‘codecs.lookup(encoding)’ function,
which returns a 4-element tuple: ‘(encode_func, decode_func,
stream_reader, stream_writer)’.

   * `encode_func' is a function that takes a Unicode string, and
     returns a 2-tuple ‘(string, length)’.  `string' is an 8-bit string
     containing a portion (perhaps all) of the Unicode string converted
     into the given encoding, and `length' tells you how much of the
     Unicode string was converted.

   * `decode_func' is the opposite of `encode_func', taking an 8-bit
     string and returning a 2-tuple ‘(ustring, length)’, consisting of
     the resulting Unicode string `ustring' and the integer `length'
     telling how much of the 8-bit string was consumed.

   * `stream_reader' is a class that supports decoding input from a
     stream.  `stream_reader(file_obj)' returns an object that supports
     the ‘read()’, *note readline(): de, and ‘readlines()’ methods.
     These methods will all translate from the given encoding and return
     Unicode strings.

   * `stream_writer', similarly, is a class that supports encoding
     output to a stream.  `stream_writer(file_obj)' returns an object
     that supports the ‘write()’ and ‘writelines()’ methods.  These
     methods expect Unicode strings, translating them to the given
     encoding on output.

For example, the following code writes a Unicode string into a file,
encoding it as UTF-8:

     import codecs

     unistr = u'\u0660\u2000ab ...'

     (UTF8_encode, UTF8_decode,
      UTF8_streamreader, UTF8_streamwriter) = codecs.lookup('UTF-8')

     output = UTF8_streamwriter( open( '/tmp/output', 'wb') )
     output.write( unistr )
     output.close()

The following code would then read UTF-8 input from the file:

     input = UTF8_streamreader( open( '/tmp/output', 'rb') )
     print repr(input.read())
     input.close()

Unicode-aware regular expressions are available through the *note re:
dd. module, which has a new underlying implementation called SRE written
by Fredrik Lundh of Secret Labs AB.

A ‘-U’ command line option was added which causes the Python compiler to
interpret all string literals as Unicode string literals.  This is
intended to be used in testing and future-proofing your Python code,
since some future version of Python may drop support for 8-bit strings
and provide only Unicode strings.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0100


File: python.info,  Node: List Comprehensions,  Next: Augmented Assignment,  Prev: Unicode<2>,  Up: What’s New in Python 2 0

1.17.5 List Comprehensions
--------------------------

Lists are a workhorse data type in Python, and many programs manipulate
a list at some point.  Two common operations on lists are to loop over
them, and either pick out the elements that meet a certain criterion, or
apply some function to each element.  For example, given a list of
strings, you might want to pull out all the strings containing a given
substring, or strip off trailing whitespace from each line.

The existing *note map(): c20. and *note filter(): c21. functions can be
used for this purpose, but they require a function as one of their
arguments.  This is fine if there’s an existing built-in function that
can be passed directly, but if there isn’t, you have to create a little
function to do the required work, and Python’s scoping rules make the
result ugly if the little function needs additional information.  Take
the first example in the previous paragraph, finding all the strings in
the list containing a given substring.  You could write the following to
do it:

     # Given the list L, make a list of all strings
     # containing the substring S.
     sublist = filter( lambda s, substring=S:
                          string.find(s, substring) != -1,
                       L)

Because of Python’s scoping rules, a default argument is used so that
the anonymous function created by the *note lambda: c22. expression
knows what substring is being searched for.  List comprehensions make
this cleaner:

     sublist = [ s for s in L if string.find(s, S) != -1 ]

List comprehensions have the form:

     [ expression for expr in sequence1
                  for expr2 in sequence2 ...
                  for exprN in sequenceN
                  if condition ]

The ‘for’…‘in’ clauses contain the sequences to be iterated over.  The
sequences do not have to be the same length, because they are `not'
iterated over in parallel, but from left to right; this is explained
more clearly in the following paragraphs.  The elements of the generated
list will be the successive values of `expression'.  The final ‘if’
clause is optional; if present, `expression' is only evaluated and added
to the result if `condition' is true.

To make the semantics very clear, a list comprehension is equivalent to
the following Python code:

     for expr1 in sequence1:
         for expr2 in sequence2:
         ...
             for exprN in sequenceN:
                  if (condition):
                       # Append the value of
                       # the expression to the
                       # resulting list.

This means that when there are multiple ‘for’…‘in’ clauses, the
resulting list will be equal to the product of the lengths of all the
sequences.  If you have two lists of length 3, the output list is 9
elements long:

     seq1 = 'abc'
     seq2 = (1,2,3)
     >>> [ (x,y) for x in seq1 for y in seq2]
     [('a', 1), ('a', 2), ('a', 3), ('b', 1), ('b', 2), ('b', 3), ('c', 1),
     ('c', 2), ('c', 3)]

To avoid introducing an ambiguity into Python’s grammar, if `expression'
is creating a tuple, it must be surrounded with parentheses.  The first
list comprehension below is a syntax error, while the second one is
correct:

     # Syntax error
     [ x,y for x in seq1 for y in seq2]
     # Correct
     [ (x,y) for x in seq1 for y in seq2]

The idea of list comprehensions originally comes from the functional
programming language Haskell (‘https://www.haskell.org’).  Greg Ewing
argued most effectively for adding them to Python and wrote the initial
list comprehension patch, which was then discussed for a seemingly
endless time on the python-dev mailing list and kept up-to-date by Skip
Montanaro.


File: python.info,  Node: Augmented Assignment,  Next: String Methods,  Prev: List Comprehensions,  Up: What’s New in Python 2 0

1.17.6 Augmented Assignment
---------------------------

Augmented assignment operators, another long-requested feature, have
been added to Python 2.0.  Augmented assignment operators include ‘+=’,
‘-=’, ‘*=’, and so forth.  For example, the statement ‘a += 2’
increments the value of the variable ‘a’ by 2, equivalent to the
slightly lengthier ‘a = a + 2’.

The full list of supported assignment operators is ‘+=’, ‘-=’, ‘*=’,
‘/=’, ‘%=’, ‘**=’, ‘&=’, ‘|=’, ‘^=’, ‘>>=’, and ‘<<=’.  Python classes
can override the augmented assignment operators by defining methods
named *note __iadd__(): e63, *note __isub__(): e64, etc.  For example,
the following ‘Number’ class stores a number and supports using += to
create a new instance with an incremented value.

     class Number:
         def __init__(self, value):
             self.value = value
         def __iadd__(self, increment):
             return Number( self.value + increment)

     n = Number(5)
     n += 3
     print n.value

The *note __iadd__(): e63. special method is called with the value of
the increment, and should return a new instance with an appropriately
modified value; this return value is bound as the new value of the
variable on the left-hand side.

Augmented assignment operators were first introduced in the C
programming language, and most C-derived languages, such as ‘awk’, C++,
Java, Perl, and PHP also support them.  The augmented assignment patch
was implemented by Thomas Wouters.


File: python.info,  Node: String Methods,  Next: Garbage Collection of Cycles,  Prev: Augmented Assignment,  Up: What’s New in Python 2 0

1.17.7 String Methods
---------------------

Until now string-manipulation functionality was in the *note string: f6.
module, which was usually a front-end for the ‘strop’ module written in
C. The addition of Unicode posed a difficulty for the ‘strop’ module,
because the functions would all need to be rewritten in order to accept
either 8-bit or Unicode strings.  For functions such as
‘string.replace()’, which takes 3 string arguments, that means eight
possible permutations, and correspondingly complicated code.

Instead, Python 2.0 pushes the problem onto the string type, making
string manipulation functionality available through methods on both
8-bit strings and Unicode strings.

     >>> 'andrew'.capitalize()
     'Andrew'
     >>> 'hostname'.replace('os', 'linux')
     'hlinuxtname'
     >>> 'moshe'.find('sh')
     2

One thing that hasn’t changed, a noteworthy April Fools’ joke
notwithstanding, is that Python strings are immutable.  Thus, the string
methods return new strings, and do not modify the string on which they
operate.

The old *note string: f6. module is still around for backwards
compatibility, but it mostly acts as a front-end to the new string
methods.

Two methods which have no parallel in pre-2.0 versions, although they
did exist in JPython for quite some time, are ‘startswith()’ and
‘endswith()’.  ‘s.startswith(t)’ is equivalent to ‘s[:len(t)] == t’,
while ‘s.endswith(t)’ is equivalent to ‘s[-len(t):] == t’.

One other method which deserves special mention is ‘join()’.  The
‘join()’ method of a string receives one parameter, a sequence of
strings, and is equivalent to the ‘string.join()’ function from the old
*note string: f6. module, with the arguments reversed.  In other words,
‘s.join(seq)’ is equivalent to the old ‘string.join(seq, s)’.


File: python.info,  Node: Garbage Collection of Cycles,  Next: Other Core Changes,  Prev: String Methods,  Up: What’s New in Python 2 0

1.17.8 Garbage Collection of Cycles
-----------------------------------

The C implementation of Python uses reference counting to implement
garbage collection.  Every Python object maintains a count of the number
of references pointing to itself, and adjusts the count as references
are created or destroyed.  Once the reference count reaches zero, the
object is no longer accessible, since you need to have a reference to an
object to access it, and if the count is zero, no references exist any
longer.

Reference counting has some pleasant properties: it’s easy to understand
and implement, and the resulting implementation is portable, fairly
fast, and reacts well with other libraries that implement their own
memory handling schemes.  The major problem with reference counting is
that it sometimes doesn’t realise that objects are no longer accessible,
resulting in a memory leak.  This happens when there are cycles of
references.

Consider the simplest possible cycle, a class instance which has a
reference to itself:

     instance = SomeClass()
     instance.myself = instance

After the above two lines of code have been executed, the reference
count of ‘instance’ is 2; one reference is from the variable named
‘'instance'’, and the other is from the ‘myself’ attribute of the
instance.

If the next line of code is ‘del instance’, what happens?  The reference
count of ‘instance’ is decreased by 1, so it has a reference count of 1;
the reference in the ‘myself’ attribute still exists.  Yet the instance
is no longer accessible through Python code, and it could be deleted.
Several objects can participate in a cycle if they have references to
each other, causing all of the objects to be leaked.

Python 2.0 fixes this problem by periodically executing a cycle
detection algorithm which looks for inaccessible cycles and deletes the
objects involved.  A new *note gc: 86. module provides functions to
perform a garbage collection, obtain debugging statistics, and tuning
the collector’s parameters.

Running the cycle detection algorithm takes some time, and therefore
will result in some additional overhead.  It is hoped that after we’ve
gotten experience with the cycle collection from using 2.0, Python 2.1
will be able to minimize the overhead with careful tuning.  It’s not yet
obvious how much performance is lost, because benchmarking this is
tricky and depends crucially on how often the program creates and
destroys objects.  The detection of cycles can be disabled when Python
is compiled, if you can’t afford even a tiny speed penalty or suspect
that the cycle collection is buggy, by specifying the
‘--without-cycle-gc’ switch when running the ‘configure’ script.

Several people tackled this problem and contributed to a solution.  An
early implementation of the cycle detection approach was written by Toby
Kelsey.  The current algorithm was suggested by Eric Tiedemann during a
visit to CNRI, and Guido van Rossum and Neil Schemenauer wrote two
different implementations, which were later integrated by Neil.  Lots of
other people offered suggestions along the way; the March 2000 archives
of the python-dev mailing list contain most of the relevant discussion,
especially in the threads titled “Reference cycle collection for Python”
and “Finalization again”.


File: python.info,  Node: Other Core Changes,  Next: Porting to 2 0,  Prev: Garbage Collection of Cycles,  Up: What’s New in Python 2 0

1.17.9 Other Core Changes
-------------------------

Various minor changes have been made to Python’s syntax and built-in
functions.  None of the changes are very far-reaching, but they’re handy
conveniences.

* Menu:

* Minor Language Changes::
* Changes to Built-in Functions::


File: python.info,  Node: Minor Language Changes,  Next: Changes to Built-in Functions,  Up: Other Core Changes

1.17.9.1 Minor Language Changes
...............................

A new syntax makes it more convenient to call a given function with a
tuple of arguments and/or a dictionary of keyword arguments.  In Python
1.5 and earlier, you’d use the ‘apply()’ built-in function: ‘apply(f,
args, kw)’ calls the function ‘f()’ with the argument tuple `args' and
the keyword arguments in the dictionary `kw'.  ‘apply()’ is the same in
2.0, but thanks to a patch from Greg Ewing, ‘f(*args, **kw)’ is a
shorter and clearer way to achieve the same effect.  This syntax is
symmetrical with the syntax for defining functions:

     def f(*args, **kw):
         # args is a tuple of positional args,
         # kw is a dictionary of keyword args
         ...

The ‘print’ statement can now have its output directed to a file-like
object by following the ‘print’ with ‘>> file’, similar to the
redirection operator in Unix shells.  Previously you’d either have to
use the ‘write()’ method of the file-like object, which lacks the
convenience and simplicity of ‘print’, or you could assign a new value
to ‘sys.stdout’ and then restore the old value.  For sending output to
standard error, it’s much easier to write this:

     print >> sys.stderr, "Warning: action field not supplied"

Modules can now be renamed on importing them, using the syntax ‘import
module as name’ or ‘from module import name as othername’.  The patch
was submitted by Thomas Wouters.

A new format style is available when using the ‘%’ operator; ‘%r’ will
insert the *note repr(): 7c0. of its argument.  This was also added from
symmetry considerations, this time for symmetry with the existing ‘%s’
format style, which inserts the *note str(): 325. of its argument.  For
example, ‘'%r %s' % ('abc', 'abc')’ returns a string containing ‘'abc'
abc’.

Previously there was no way to implement a class that overrode Python’s
built-in *note in: 797. operator and implemented a custom version.  ‘obj
in seq’ returns true if `obj' is present in the sequence `seq'; Python
computes this by simply trying every index of the sequence until either
`obj' is found or an *note IndexError: e69. is encountered.  Moshe Zadka
contributed a patch which adds a *note __contains__(): d1b. magic method
for providing a custom implementation for ‘in’.  Additionally, new
built-in objects written in C can define what ‘in’ means for them via a
new slot in the sequence protocol.

Earlier versions of Python used a recursive algorithm for deleting
objects.  Deeply nested data structures could cause the interpreter to
fill up the C stack and crash; Christian Tismer rewrote the deletion
logic to fix this problem.  On a related note, comparing recursive
objects recursed infinitely and crashed; Jeremy Hylton rewrote the code
to no longer crash, producing a useful result instead.  For example,
after this code:

     a = []
     b = []
     a.append(a)
     b.append(b)

The comparison ‘a==b’ returns true, because the two recursive data
structures are isomorphic.  See the thread “trashcan and PR#7” in the
April 2000 archives of the python-dev mailing list for the discussion
leading up to this implementation, and some useful relevant links.  Note
that comparisons can now also raise exceptions.  In earlier versions of
Python, a comparison operation such as ‘cmp(a,b)’ would always produce
an answer, even if a user-defined ‘__cmp__()’ method encountered an
error, since the resulting exception would simply be silently swallowed.

Work has been done on porting Python to 64-bit Windows on the Itanium
processor, mostly by Trent Mick of ActiveState.  (Confusingly,
‘sys.platform’ is still ‘'win32'’ on Win64 because it seems that for
ease of porting, MS Visual C++ treats code as 32 bit on Itanium.)
PythonWin also supports Windows CE; see the Python CE page at
‘http://pythonce.sourceforge.net/’ for more information.

Another new platform is Darwin/MacOS X; initial support for it is in
Python 2.0.  Dynamic loading works, if you specify “configure –with-dyld
–with-suffix=.x”.  Consult the README in the Python source distribution
for more instructions.

An attempt has been made to alleviate one of Python’s warts, the
often-confusing *note NameError: d6e. exception when code refers to a
local variable before the variable has been assigned a value.  For
example, the following code raises an exception on the ‘print’ statement
in both 1.5.2 and 2.0; in 1.5.2 a *note NameError: d6e. exception is
raised, while 2.0 raises a new *note UnboundLocalError: e6a. exception.
*note UnboundLocalError: e6a. is a subclass of *note NameError: d6e, so
any existing code that expects *note NameError: d6e. to be raised should
still work.

     def f():
         print "i=",i
         i = i + 1
     f()

Two new exceptions, *note TabError: e6b. and *note IndentationError:
e6c, have been introduced.  They’re both subclasses of *note
SyntaxError: 44d, and are raised when Python code is found to be
improperly indented.


File: python.info,  Node: Changes to Built-in Functions,  Prev: Minor Language Changes,  Up: Other Core Changes

1.17.9.2 Changes to Built-in Functions
......................................

A new built-in, ‘zip(seq1, seq2, ...)’, has been added.  *note zip():
c25. returns a list of tuples where each tuple contains the i-th element
from each of the argument sequences.  The difference between *note
zip(): c25. and ‘map(None, seq1, seq2)’ is that *note map(): c20. pads
the sequences with ‘None’ if the sequences aren’t all of the same
length, while *note zip(): c25. truncates the returned list to the
length of the shortest argument sequence.

The *note int(): 184. and ‘long()’ functions now accept an optional
“base” parameter when the first argument is a string.  ‘int('123', 10)’
returns 123, while ‘int('123', 16)’ returns 291.  ‘int(123, 16)’ raises
a *note TypeError: 192. exception with the message “can’t convert
non-string with explicit base”.

A new variable holding more detailed version information has been added
to the *note sys: fd. module.  ‘sys.version_info’ is a tuple ‘(major,
minor, micro, level, serial)’ For example, in a hypothetical 2.0.1beta1,
‘sys.version_info’ would be ‘(2, 0, 1, 'beta', 1)’.  `level' is a string
such as ‘"alpha"’, ‘"beta"’, or ‘"final"’ for a final release.

Dictionaries have an odd new method, ‘setdefault(key, default)’, which
behaves similarly to the existing ‘get()’ method.  However, if the key
is missing, ‘setdefault()’ both returns the value of `default' as
‘get()’ would do, and also inserts it into the dictionary as the value
for `key'.  Thus, the following lines of code:

     if dict.has_key( key ): return dict[key]
     else:
         dict[key] = []
         return dict[key]

can be reduced to a single ‘return dict.setdefault(key, [])’ statement.

The interpreter sets a maximum recursion depth in order to catch runaway
recursion before filling the C stack and causing a core dump or GPF..
Previously this limit was fixed when you compiled Python, but in 2.0 the
maximum recursion depth can be read and modified using *note
sys.getrecursionlimit(): e6e. and *note sys.setrecursionlimit(): e6f.
The default value is 1000, and a rough maximum value for a given
platform can be found by running a new script,
‘Misc/find_recursionlimit.py’.


File: python.info,  Node: Porting to 2 0,  Next: Extending/Embedding Changes,  Prev: Other Core Changes,  Up: What’s New in Python 2 0

1.17.10 Porting to 2.0
----------------------

New Python releases try hard to be compatible with previous releases,
and the record has been pretty good.  However, some changes are
considered useful enough, usually because they fix initial design
decisions that turned out to be actively mistaken, that breaking
backward compatibility can’t always be avoided.  This section lists the
changes in Python 2.0 that may cause old Python code to break.

The change which will probably break the most code is tightening up the
arguments accepted by some methods.  Some methods would take multiple
arguments and treat them as a tuple, particularly various list methods
such as ‘append()’ and ‘insert()’.  In earlier versions of Python, if
‘L’ is a list, ‘L.append( 1,2 )’ appends the tuple ‘(1,2)’ to the list.
In Python 2.0 this causes a *note TypeError: 192. exception to be
raised, with the message: ‘append requires exactly 1 argument; 2 given’.
The fix is to simply add an extra set of parentheses to pass both values
as a tuple: ‘L.append( (1,2) )’.

The earlier versions of these methods were more forgiving because they
used an old function in Python’s C interface to parse their arguments;
2.0 modernizes them to use ‘PyArg_ParseTuple()’, the current argument
parsing function, which provides more helpful error messages and treats
multi-argument calls as errors.  If you absolutely must use 2.0 but
can’t fix your code, you can edit ‘Objects/listobject.c’ and define the
preprocessor symbol ‘NO_STRICT_LIST_APPEND’ to preserve the old
behaviour; this isn’t recommended.

Some of the functions in the *note socket: ef. module are still
forgiving in this way.  For example, ‘socket.connect( ('hostname', 25)
)()’ is the correct form, passing a tuple representing an IP address,
but ‘socket.connect( 'hostname', 25 )()’ also works.
‘socket.connect_ex()’ and ‘socket.bind()’ are similarly easy-going.
2.0alpha1 tightened these functions up, but because the documentation
actually used the erroneous multiple argument form, many people wrote
code which would break with the stricter checking.  GvR backed out the
changes in the face of public reaction, so for the *note socket: ef.
module, the documentation was fixed and the multiple argument form is
simply marked as deprecated; it `will' be tightened up again in a future
Python version.

The ‘\x’ escape in string literals now takes exactly 2 hex digits.
Previously it would consume all the hex digits following the ‘x’ and
take the lowest 8 bits of the result, so ‘\x123456’ was equivalent to
‘\x56’.

The *note AttributeError: 390. and *note NameError: d6e. exceptions have
a more friendly error message, whose text will be something like ‘'Spam'
instance has no attribute 'eggs'’ or ‘name 'eggs' is not defined’.
Previously the error message was just the missing attribute name ‘eggs’,
and code written to take advantage of this fact will break in 2.0.

Some work has been done to make integers and long integers a bit more
interchangeable.  In 1.5.2, large-file support was added for Solaris, to
allow reading files larger than 2 GiB; this made the ‘tell()’ method of
file objects return a long integer instead of a regular integer.  Some
code would subtract two file offsets and attempt to use the result to
multiply a sequence or slice a string, but this raised a *note
TypeError: 192.  In 2.0, long integers can be used to multiply or slice
a sequence, and it’ll behave as you’d intuitively expect it to; ‘3L *
'abc'’ produces ‘abcabcabc’, and ‘(0,1,2,3)[2L:4L]’ produces (2,3).
Long integers can also be used in various contexts where previously only
integers were accepted, such as in the ‘seek()’ method of file objects,
and in the formats supported by the ‘%’ operator (‘%d’, ‘%i’, ‘%x’,
etc.).  For example, ‘"%d" % 2L**64’ will produce the string
‘18446744073709551616’.

The subtlest long integer change of all is that the *note str(): 325. of
a long integer no longer has a trailing ‘L’ character, though *note
repr(): 7c0. still includes it.  The ‘L’ annoyed many people who wanted
to print long integers that looked just like regular integers, since
they had to go out of their way to chop off the character.  This is no
longer a problem in 2.0, but code which does ‘str(longval)[:-1]’ and
assumes the ‘L’ is there, will now lose the final digit.

Taking the *note repr(): 7c0. of a float now uses a different formatting
precision than *note str(): 325.  *note repr(): 7c0. uses ‘%.17g’ format
string for C’s ‘sprintf()’, while *note str(): 325. uses ‘%.12g’ as
before.  The effect is that *note repr(): 7c0. may occasionally show
more decimal places than *note str(): 325, for certain numbers.  For
example, the number 8.1 can’t be represented exactly in binary, so
‘repr(8.1)’ is ‘'8.0999999999999996'’, while str(8.1) is ‘'8.1'’.

The ‘-X’ command-line option, which turned all standard exceptions into
strings instead of classes, has been removed; the standard exceptions
will now always be classes.  The ‘exceptions’ module containing the
standard exceptions was translated from Python to a built-in C module,
written by Barry Warsaw and Fredrik Lundh.


File: python.info,  Node: Extending/Embedding Changes,  Next: Distutils Making Modules Easy to Install,  Prev: Porting to 2 0,  Up: What’s New in Python 2 0

1.17.11 Extending/Embedding Changes
-----------------------------------

Some of the changes are under the covers, and will only be apparent to
people writing C extension modules or embedding a Python interpreter in
a larger application.  If you aren’t dealing with Python’s C API, you
can safely skip this section.

The version number of the Python C API was incremented, so C extensions
compiled for 1.5.2 must be recompiled in order to work with 2.0.  On
Windows, it’s not possible for Python 2.0 to import a third party
extension built for Python 1.5.x due to how Windows DLLs work, so Python
will raise an exception and the import will fail.

Users of Jim Fulton’s ExtensionClass module will be pleased to find out
that hooks have been added so that ExtensionClasses are now supported by
*note isinstance(): 444. and *note issubclass(): 445.  This means you no
longer have to remember to write code such as ‘if type(obj) ==
myExtensionClass’, but can use the more natural ‘if isinstance(obj,
myExtensionClass)’.

The ‘Python/importdl.c’ file, which was a mass of #ifdefs to support
dynamic loading on many different platforms, was cleaned up and
reorganised by Greg Stein.  ‘importdl.c’ is now quite small, and
platform-specific code has been moved into a bunch of
‘Python/dynload_*.c’ files.  Another cleanup: there were also a number
of ‘my*.h’ files in the Include/ directory that held various portability
hacks; they’ve been merged into a single file, ‘Include/pyport.h’.

Vladimir Marangozov’s long-awaited malloc restructuring was completed,
to make it easy to have the Python interpreter use a custom allocator
instead of C’s standard ‘malloc()’.  For documentation, read the
comments in ‘Include/pymem.h’ and ‘Include/objimpl.h’.  For the lengthy
discussions during which the interface was hammered out, see the Web
archives of the ‘patches’ and ‘python-dev’ lists at python.org.

Recent versions of the GUSI development environment for MacOS support
POSIX threads.  Therefore, Python’s POSIX threading support now works on
the Macintosh.  Threading support using the user-space GNU ‘pth’ library
was also contributed.

Threading support on Windows was enhanced, too.  Windows supports thread
locks that use kernel objects only in case of contention; in the common
case when there’s no contention, they use simpler functions which are an
order of magnitude faster.  A threaded version of Python 1.5.2 on NT is
twice as slow as an unthreaded version; with the 2.0 changes, the
difference is only 10%.  These improvements were contributed by Yakov
Markovitch.

Python 2.0’s source now uses only ANSI C prototypes, so compiling Python
now requires an ANSI C compiler, and can no longer be done using a
compiler that only supports K&R C.

Previously the Python virtual machine used 16-bit numbers in its
bytecode, limiting the size of source files.  In particular, this
affected the maximum size of literal lists and dictionaries in Python
source; occasionally people who are generating Python code would run
into this limit.  A patch by Charles G. Waldman raises the limit from
‘2^16’ to ‘2^{32}’.

Three new convenience functions intended for adding constants to a
module’s dictionary at module initialization time were added:
‘PyModule_AddObject()’, ‘PyModule_AddIntConstant()’, and
‘PyModule_AddStringConstant()’.  Each of these functions takes a module
object, a null-terminated C string containing the name to be added, and
a third argument for the value to be assigned to the name.  This third
argument is, respectively, a Python object, a C long, or a C string.

A wrapper API was added for Unix-style signal handlers.  ‘PyOS_getsig()’
gets a signal handler and ‘PyOS_setsig()’ will set a new handler.


File: python.info,  Node: Distutils Making Modules Easy to Install,  Next: XML Modules,  Prev: Extending/Embedding Changes,  Up: What’s New in Python 2 0

1.17.12 Distutils: Making Modules Easy to Install
-------------------------------------------------

Before Python 2.0, installing modules was a tedious affair – there was
no way to figure out automatically where Python is installed, or what
compiler options to use for extension modules.  Software authors had to
go through an arduous ritual of editing Makefiles and configuration
files, which only really work on Unix and leave Windows and MacOS
unsupported.  Python users faced wildly differing installation
instructions which varied between different extension packages, which
made administering a Python installation something of a chore.

The SIG for distribution utilities, shepherded by Greg Ward, has created
the Distutils, a system to make package installation much easier.  They
form the *note distutils: 39. package, a new part of Python’s standard
library.  In the best case, installing a Python module from source will
require the same steps: first you simply mean unpack the tarball or zip
archive, and the run “‘python setup.py install’”.  The platform will be
automatically detected, the compiler will be recognized, C extension
modules will be compiled, and the distribution installed into the proper
directory.  Optional command-line arguments provide more control over
the installation process, the distutils package offers many places to
override defaults – separating the build from the install, building or
installing in non-default directories, and more.

In order to use the Distutils, you need to write a ‘setup.py’ script.
For the simple case, when the software contains only .py files, a
minimal ‘setup.py’ can be just a few lines long:

     from distutils.core import setup
     setup (name = "foo", version = "1.0",
            py_modules = ["module1", "module2"])

The ‘setup.py’ file isn’t much more complicated if the software consists
of a few packages:

     from distutils.core import setup
     setup (name = "foo", version = "1.0",
            packages = ["package", "package.subpackage"])

A C extension can be the most complicated case; here’s an example taken
from the PyXML package:

     from distutils.core import setup, Extension

     expat_extension = Extension('xml.parsers.pyexpat',
          define_macros = [('XML_NS', None)],
          include_dirs = [ 'extensions/expat/xmltok',
                           'extensions/expat/xmlparse' ],
          sources = [ 'extensions/pyexpat.c',
                      'extensions/expat/xmltok/xmltok.c',
                      'extensions/expat/xmltok/xmlrole.c', ]
            )
     setup (name = "PyXML", version = "0.5.4",
            ext_modules =[ expat_extension ] )

The Distutils can also take care of creating source and binary
distributions.  The “sdist” command, run by “‘python setup.py sdist’’,
builds a source distribution such as ‘foo-1.0.tar.gz’.  Adding new
commands isn’t difficult, “bdist_rpm” and “bdist_wininst” commands have
already been contributed to create an RPM distribution and a Windows
installer for the software, respectively.  Commands to create other
distribution formats such as Debian packages and Solaris ‘.pkg’ files
are in various stages of development.

All this is documented in a new manual, `Distributing Python Modules',
that joins the basic set of Python documentation.


File: python.info,  Node: XML Modules,  Next: Module changes,  Prev: Distutils Making Modules Easy to Install,  Up: What’s New in Python 2 0

1.17.13 XML Modules
-------------------

Python 1.5.2 included a simple XML parser in the form of the ‘xmllib’
module, contributed by Sjoerd Mullender.  Since 1.5.2’s release, two
different interfaces for processing XML have become common: SAX2
(version 2 of the Simple API for XML) provides an event-driven interface
with some similarities to ‘xmllib’, and the DOM (Document Object Model)
provides a tree-based interface, transforming an XML document into a
tree of nodes that can be traversed and modified.  Python 2.0 includes a
SAX2 interface and a stripped-down DOM interface as part of the *note
xml: 133. package.  Here we will give a brief overview of these new
interfaces; consult the Python documentation or the source code for
complete details.  The Python XML SIG is also working on improved
documentation.

* Menu:

* SAX2 Support::
* DOM Support::
* Relationship to PyXML::


File: python.info,  Node: SAX2 Support,  Next: DOM Support,  Up: XML Modules

1.17.13.1 SAX2 Support
......................

SAX defines an event-driven interface for parsing XML. To use SAX, you
must write a SAX handler class.  Handler classes inherit from various
classes provided by SAX, and override various methods that will then be
called by the XML parser.  For example, the ‘startElement()’ and
‘endElement()’ methods are called for every starting and end tag
encountered by the parser, the ‘characters()’ method is called for every
chunk of character data, and so forth.

The advantage of the event-driven approach is that the whole document
doesn’t have to be resident in memory at any one time, which matters if
you are processing really huge documents.  However, writing the SAX
handler class can get very complicated if you’re trying to modify the
document structure in some elaborate way.

For example, this little example program defines a handler that prints a
message for every starting and ending tag, and then parses the file
‘hamlet.xml’ using it:

     from xml import sax

     class SimpleHandler(sax.ContentHandler):
         def startElement(self, name, attrs):
             print 'Start of element:', name, attrs.keys()

         def endElement(self, name):
             print 'End of element:', name

     # Create a parser object
     parser = sax.make_parser()

     # Tell it what handler to use
     handler = SimpleHandler()
     parser.setContentHandler( handler )

     # Parse a file!
     parser.parse( 'hamlet.xml' )

For more information, consult the Python documentation, or the XML HOWTO
at ‘http://pyxml.sourceforge.net/topics/howto/xml-howto.html’.


File: python.info,  Node: DOM Support,  Next: Relationship to PyXML,  Prev: SAX2 Support,  Up: XML Modules

1.17.13.2 DOM Support
.....................

The Document Object Model is a tree-based representation for an XML
document.  A top-level ‘Document’ instance is the root of the tree, and
has a single child which is the top-level ‘Element’ instance.  This
‘Element’ has children nodes representing character data and any
sub-elements, which may have further children of their own, and so
forth.  Using the DOM you can traverse the resulting tree any way you
like, access element and attribute values, insert and delete nodes, and
convert the tree back into XML.

The DOM is useful for modifying XML documents, because you can create a
DOM tree, modify it by adding new nodes or rearranging subtrees, and
then produce a new XML document as output.  You can also construct a DOM
tree manually and convert it to XML, which can be a more flexible way of
producing XML output than simply writing ‘<tag1>’…‘</tag1>’ to a file.

The DOM implementation included with Python lives in the *note
xml.dom.minidom: 135. module.  It’s a lightweight implementation of the
Level 1 DOM with support for XML namespaces.  The ‘parse()’ and
‘parseString()’ convenience functions are provided for generating a DOM
tree:

     from xml.dom import minidom
     doc = minidom.parse('hamlet.xml')

‘doc’ is a ‘Document’ instance.  ‘Document’, like all the other DOM
classes such as ‘Element’ and ‘Text’, is a subclass of the ‘Node’ base
class.  All the nodes in a DOM tree therefore support certain common
methods, such as ‘toxml()’ which returns a string containing the XML
representation of the node and its children.  Each class also has
special methods of its own; for example, ‘Element’ and ‘Document’
instances have a method to find all child elements with a given tag
name.  Continuing from the previous 2-line example:

     perslist = doc.getElementsByTagName( 'PERSONA' )
     print perslist[0].toxml()
     print perslist[1].toxml()

For the `Hamlet' XML file, the above few lines output:

     <PERSONA>CLAUDIUS, king of Denmark. </PERSONA>
     <PERSONA>HAMLET, son to the late, and nephew to the present king.</PERSONA>

The root element of the document is available as ‘doc.documentElement’,
and its children can be easily modified by deleting, adding, or removing
nodes:

     root = doc.documentElement

     # Remove the first child
     root.removeChild( root.childNodes[0] )

     # Move the new first child to the end
     root.appendChild( root.childNodes[0] )

     # Insert the new first child (originally,
     # the third child) before the 20th child.
     root.insertBefore( root.childNodes[0], root.childNodes[20] )

Again, I will refer you to the Python documentation for a complete
listing of the different ‘Node’ classes and their various methods.


File: python.info,  Node: Relationship to PyXML,  Prev: DOM Support,  Up: XML Modules

1.17.13.3 Relationship to PyXML
...............................

The XML Special Interest Group has been working on XML-related Python
code for a while.  Its code distribution, called PyXML, is available
from the SIG’s Web pages at
‘https://www.python.org/community/sigs/current/xml-sig’.  The PyXML
distribution also used the package name ‘xml’.  If you’ve written
programs that used PyXML, you’re probably wondering about its
compatibility with the 2.0 *note xml: 133. package.

The answer is that Python 2.0’s *note xml: 133. package isn’t compatible
with PyXML, but can be made compatible by installing a recent version
PyXML. Many applications can get by with the XML support that is
included with Python 2.0, but more complicated applications will require
that the full PyXML package will be installed.  When installed, PyXML
versions 0.6.0 or greater will replace the *note xml: 133. package
shipped with Python, and will be a strict superset of the standard
package, adding a bunch of additional features.  Some of the additional
features in PyXML include:

   * 4DOM, a full DOM implementation from FourThought, Inc.

   * The xmlproc validating parser, written by Lars Marius Garshol.

   * The ‘sgmlop’ parser accelerator module, written by Fredrik Lundh.


File: python.info,  Node: Module changes,  Next: New modules,  Prev: XML Modules,  Up: What’s New in Python 2 0

1.17.14 Module changes
----------------------

Lots of improvements and bugfixes were made to Python’s extensive
standard library; some of the affected modules include *note readline:
de, ‘ConfigParser’, *note cgi: 16, *note calendar: 15, *note posix: d1,
*note readline: de, ‘xmllib’, *note aifc: 5, ‘chunk, wave’, *note
random: dc, *note shelve: e7, and *note nntplib: c0.  Consult the CVS
logs for the exact patch-by-patch details.

Brian Gallew contributed OpenSSL support for the *note socket: ef.
module.  OpenSSL is an implementation of the Secure Socket Layer, which
encrypts the data being sent over a socket.  When compiling Python, you
can edit ‘Modules/Setup’ to include SSL support, which adds an
additional function to the *note socket: ef. module: ‘socket.ssl(socket,
keyfile, certfile)’, which takes a socket object and returns an SSL
socket.  The ‘httplib’ and *note urllib: 11d. modules were also changed
to support ‘https://’ URLs, though no one has implemented FTP or SMTP
over SSL.

The ‘httplib’ module has been rewritten by Greg Stein to support
HTTP/1.1.  Backward compatibility with the 1.5 version of ‘httplib’ is
provided, though using HTTP/1.1 features such as pipelining will require
rewriting code to use a different set of interfaces.

The ‘Tkinter’ module now supports Tcl/Tk version 8.1, 8.2, or 8.3, and
support for the older 7.x versions has been dropped.  The Tkinter module
now supports displaying Unicode strings in Tk widgets.  Also, Fredrik
Lundh contributed an optimization which makes operations like
‘create_line’ and ‘create_polygon’ much faster, especially when using
lots of coordinates.

The *note curses: 2c. module has been greatly extended, starting from
Oliver Andrich’s enhanced version, to provide many additional functions
from ncurses and SYSV curses, such as colour, alternative character set
support, pads, and mouse support.  This means the module is no longer
compatible with operating systems that only have BSD curses, but there
don’t seem to be any currently maintained OSes that fall into this
category.

As mentioned in the earlier discussion of 2.0’s Unicode support, the
underlying implementation of the regular expressions provided by the
*note re: dd. module has been changed.  SRE, a new regular expression
engine written by Fredrik Lundh and partially funded by Hewlett Packard,
supports matching against both 8-bit strings and Unicode strings.


File: python.info,  Node: New modules,  Next: IDLE Improvements,  Prev: Module changes,  Up: What’s New in Python 2 0

1.17.15 New modules
-------------------

A number of new modules were added.  We’ll simply list them with brief
descriptions; consult the 2.0 documentation for the details of a
particular module.

   * *note atexit: c.: For registering functions to be called before the
     Python interpreter exits.  Code that currently sets ‘sys.exitfunc’
     directly should be changed to use the *note atexit: c. module
     instead, importing *note atexit: c. and calling *note
     atexit.register(): e79. with the function to be called on exit.
     (Contributed by Skip Montanaro.)

   * *note codecs: 1c, ‘encodings’, *note unicodedata: 11a.: Added as
     part of the new Unicode support.

   * *note filecmp: 7f.: Supersedes the old ‘cmp’, ‘cmpcache’ and
     ‘dircmp’ modules, which have now become deprecated.  (Contributed
     by Gordon MacMillan and Moshe Zadka.)

   * *note gettext: 89.: This module provides internationalization
     (I18N) and localization (L10N) support for Python programs by
     providing an interface to the GNU gettext message catalog library.
     (Integrated by Barry Warsaw, from separate contributions by Martin
     von Löwis, Peter Funk, and James Henstridge.)

   * ‘linuxaudiodev’: Support for the ‘/dev/audio’ device on Linux, a
     twin to the existing ‘sunaudiodev’ module.  (Contributed by Peter
     Bosch, with fixes by Jeremy Hylton.)

   * *note mmap: b3.: An interface to memory-mapped files on both
     Windows and Unix.  A file’s contents can be mapped directly into
     memory, at which point it behaves like a mutable string, so its
     contents can be read and modified.  They can even be passed to
     functions that expect ordinary strings, such as the *note re: dd.
     module.  (Contributed by Sam Rushing, with some extensions by A.M.
     Kuchling.)

   * ‘pyexpat’: An interface to the Expat XML parser.  (Contributed by
     Paul Prescod.)

   * ‘robotparser’: Parse a ‘robots.txt’ file, which is used for writing
     Web spiders that politely avoid certain areas of a Web site.  The
     parser accepts the contents of a ‘robots.txt’ file, builds a set of
     rules from it, and can then answer questions about the fetchability
     of a given URL. (Contributed by Skip Montanaro.)

   * *note tabnanny: 100.: A module/script to check Python source code
     for ambiguous indentation.  (Contributed by Tim Peters.)

   * ‘UserString’: A base class useful for deriving objects that behave
     like strings.

   * *note webbrowser: 129.: A module that provides a platform
     independent way to launch a web browser on a specific URL. For each
     platform, various browsers are tried in a specific order.  The user
     can alter which browser is launched by setting the `BROWSER'
     environment variable.  (Originally inspired by Eric S. Raymond’s
     patch to *note urllib: 11d. which added similar functionality, but
     the final module comes from code originally implemented by Fred
     Drake as ‘Tools/idle/BrowserControl.py’, and adapted for the
     standard library by Fred.)

   * ‘_winreg’: An interface to the Windows registry.  ‘_winreg’ is an
     adaptation of functions that have been part of PythonWin since
     1995, but has now been added to the core distribution, and enhanced
     to support Unicode.  ‘_winreg’ was written by Bill Tutt and Mark
     Hammond.

   * *note zipfile: 142.: A module for reading and writing ZIP-format
     archives.  These are archives produced by ‘PKZIP’ on DOS/Windows or
     ‘zip’ on Unix, not to be confused with ‘gzip’-format files (which
     are supported by the *note gzip: 8c. module) (Contributed by James
     C. Ahlstrom.)

   * ‘imputil’: A module that provides a simpler way for writing
     customized import hooks, in comparison to the existing ‘ihooks’
     module.  (Implemented by Greg Stein, with much discussion on
     python-dev along the way.)


File: python.info,  Node: IDLE Improvements,  Next: Deleted and Deprecated Modules,  Prev: New modules,  Up: What’s New in Python 2 0

1.17.16 IDLE Improvements
-------------------------

IDLE is the official Python cross-platform IDE, written using Tkinter.
Python 2.0 includes IDLE 0.6, which adds a number of new features and
improvements.  A partial list:

   * UI improvements and optimizations, especially in the area of syntax
     highlighting and auto-indentation.

   * The class browser now shows more information, such as the top level
     functions in a module.

   * Tab width is now a user settable option.  When opening an existing
     Python file, IDLE automatically detects the indentation
     conventions, and adapts.

   * There is now support for calling browsers on various platforms,
     used to open the Python documentation in a browser.

   * IDLE now has a command line, which is largely similar to the
     vanilla Python interpreter.

   * Call tips were added in many places.

   * IDLE can now be installed as a package.

   * In the editor window, there is now a line/column bar at the bottom.

   * Three new keystroke commands: Check module (‘Alt-F5’), Import
     module (‘F5’) and Run script (‘Ctrl-F5’).


File: python.info,  Node: Deleted and Deprecated Modules,  Next: Acknowledgements<8>,  Prev: IDLE Improvements,  Up: What’s New in Python 2 0

1.17.17 Deleted and Deprecated Modules
--------------------------------------

A few modules have been dropped because they’re obsolete, or because
there are now better ways to do the same thing.  The ‘stdwin’ module is
gone; it was for a platform-independent windowing toolkit that’s no
longer developed.

A number of modules have been moved to the ‘lib-old’ subdirectory:
‘cmp’, ‘cmpcache’, ‘dircmp’, ‘dump’, ‘find’, ‘grep’, ‘packmail’, ‘poly’,
‘util’, ‘whatsound’, ‘zmod’.  If you have code which relies on a module
that’s been moved to ‘lib-old’, you can simply add that directory to
‘sys.path’ to get them back, but you’re encouraged to update any code
that uses these modules.


File: python.info,  Node: Acknowledgements<8>,  Prev: Deleted and Deprecated Modules,  Up: What’s New in Python 2 0

1.17.18 Acknowledgements
------------------------

The authors would like to thank the following people for offering
suggestions on various drafts of this article: David Bolen, Mark
Hammond, Gregg Hauser, Jeremy Hylton, Fredrik Lundh, Detlef Lannert,
Aahz Maruch, Skip Montanaro, Vladimir Marangozov, Tobias Polzin, Guido
van Rossum, Neil Schemenauer, and Russ Schmidt.

The “Changelog” is an HTML version of the file built(1) from the
contents of the Misc/NEWS.d(2) directory tree, which contains `all'
nontrivial changes to Python for the current version.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/blurb

   (2) https://github.com/python/cpython/tree/3.8/Misc/NEWS.d


File: python.info,  Node: Changelog,  Prev: What’s New in Python 2 0,  Up: What’s New in Python

1.18 Changelog
==============

* Menu:

* Python 3.8.1 final: Python 3 8 1 final.
* Python 3.8.1 release candidate 1: Python 3 8 1 release candidate 1.
* Python 3.8.0 final: Python 3 8 0 final.
* Python 3.8.0 release candidate 1: Python 3 8 0 release candidate 1.
* Python 3.8.0 beta 4: Python 3 8 0 beta 4.
* Python 3.8.0 beta 3: Python 3 8 0 beta 3.
* Python 3.8.0 beta 2: Python 3 8 0 beta 2.
* Python 3.8.0 beta 1: Python 3 8 0 beta 1.
* Python 3.8.0 alpha 4: Python 3 8 0 alpha 4.
* Python 3.8.0 alpha 3: Python 3 8 0 alpha 3.
* Python 3.8.0 alpha 2: Python 3 8 0 alpha 2.
* Python 3.8.0 alpha 1: Python 3 8 0 alpha 1.
* Python 3.7.0 final: Python 3 7 0 final.
* Python 3.7.0 release candidate 1: Python 3 7 0 release candidate 1.
* Python 3.7.0 beta 5: Python 3 7 0 beta 5.
* Python 3.7.0 beta 4: Python 3 7 0 beta 4.
* Python 3.7.0 beta 3: Python 3 7 0 beta 3.
* Python 3.7.0 beta 2: Python 3 7 0 beta 2.
* Python 3.7.0 beta 1: Python 3 7 0 beta 1.
* Python 3.7.0 alpha 4: Python 3 7 0 alpha 4.
* Python 3.7.0 alpha 3: Python 3 7 0 alpha 3.
* Python 3.7.0 alpha 2: Python 3 7 0 alpha 2.
* Python 3.7.0 alpha 1: Python 3 7 0 alpha 1.
* Python 3.6.6 final: Python 3 6 6 final.
* Python 3.6.6 release candidate 1: Python 3 6 6 release candidate 1.
* Python 3.6.5 final: Python 3 6 5 final.
* Python 3.6.5 release candidate 1: Python 3 6 5 release candidate 1.
* Python 3.6.4 final: Python 3 6 4 final.
* Python 3.6.4 release candidate 1: Python 3 6 4 release candidate 1.
* Python 3.6.3 final: Python 3 6 3 final.
* Python 3.6.3 release candidate 1: Python 3 6 3 release candidate 1.
* Python 3.6.2 final: Python 3 6 2 final.
* Python 3.6.2 release candidate 2: Python 3 6 2 release candidate 2.
* Python 3.6.2 release candidate 1: Python 3 6 2 release candidate 1.
* Python 3.6.1 final: Python 3 6 1 final.
* Python 3.6.1 release candidate 1: Python 3 6 1 release candidate 1.
* Python 3.6.0 final: Python 3 6 0 final.
* Python 3.6.0 release candidate 2: Python 3 6 0 release candidate 2.
* Python 3.6.0 release candidate 1: Python 3 6 0 release candidate 1.
* Python 3.6.0 beta 4: Python 3 6 0 beta 4.
* Python 3.6.0 beta 3: Python 3 6 0 beta 3.
* Python 3.6.0 beta 2: Python 3 6 0 beta 2.
* Python 3.6.0 beta 1: Python 3 6 0 beta 1.
* Python 3.6.0 alpha 4: Python 3 6 0 alpha 4.
* Python 3.6.0 alpha 3: Python 3 6 0 alpha 3.
* Python 3.6.0 alpha 2: Python 3 6 0 alpha 2.
* Python 3.6.0 alpha 1: Python 3 6 0 alpha 1.
* Python 3.5.5 final: Python 3 5 5 final.
* Python 3.5.5 release candidate 1: Python 3 5 5 release candidate 1.
* Python 3.5.4 final: Python 3 5 4 final.
* Python 3.5.4 release candidate 1: Python 3 5 4 release candidate 1.
* Python 3.5.3 final: Python 3 5 3 final.
* Python 3.5.3 release candidate 1: Python 3 5 3 release candidate 1.
* Python 3.5.2 final: Python 3 5 2 final.
* Python 3.5.2 release candidate 1: Python 3 5 2 release candidate 1.
* Python 3.5.1 final: Python 3 5 1 final.
* Python 3.5.1 release candidate 1: Python 3 5 1 release candidate 1.
* Python 3.5.0 final: Python 3 5 0 final.
* Python 3.5.0 release candidate 4: Python 3 5 0 release candidate 4.
* Python 3.5.0 release candidate 3: Python 3 5 0 release candidate 3.
* Python 3.5.0 release candidate 2: Python 3 5 0 release candidate 2.
* Python 3.5.0 release candidate 1: Python 3 5 0 release candidate 1.
* Python 3.5.0 beta 4: Python 3 5 0 beta 4.
* Python 3.5.0 beta 3: Python 3 5 0 beta 3.
* Python 3.5.0 beta 2: Python 3 5 0 beta 2.
* Python 3.5.0 beta 1: Python 3 5 0 beta 1.
* Python 3.5.0 alpha 4: Python 3 5 0 alpha 4.
* Python 3.5.0 alpha 3: Python 3 5 0 alpha 3.
* Python 3.5.0 alpha 2: Python 3 5 0 alpha 2.
* Python 3.5.0 alpha 1: Python 3 5 0 alpha 1.


File: python.info,  Node: Python 3 8 1 final,  Next: Python 3 8 1 release candidate 1,  Up: Changelog

1.18.1 Python 3.8.1 final
-------------------------

`Release date: 2019-12-18'

* Menu:

* Core and Builtins::
* Library::
* Tests::
* Windows::
* macOS::
* IDLE: IDLE<3>.


File: python.info,  Node: Core and Builtins,  Next: Library,  Up: Python 3 8 1 final

1.18.1.1 Core and Builtins
..........................

   - bpo-39080(1): Fix the value of `end_col_offset' for Starred
     Expression AST nodes when they are among the elements in the `args'
     attribute of Call AST nodes.

   - bpo-39031(2): When parsing an “elif” node, lineno and col_offset of
     the node now point to the “elif” keyword and not to its condition,
     making it consistent with the “if” node.  Patch by Lysandros
     Nikolaou.

   - bpo-39008(3): *note PySys_Audit(): e81. now requires ‘Py_ssize_t’
     to be used for size arguments in the format string, regardless of
     whethen ‘PY_SSIZE_T_CLEAN’ was defined at include time.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue39080

   (2) https://bugs.python.org/issue39031

   (3) https://bugs.python.org/issue39008


File: python.info,  Node: Library,  Next: Tests,  Prev: Core and Builtins,  Up: Python 3 8 1 final

1.18.1.2 Library
................

   - bpo-39022(1): Update importliib.metadata to include improvements
     from importlib_metadata 1.3 including better serialization of
     EntryPoints and improved documentation for custom finders.

   - bpo-38811(2): Fix an unhandled exception in *note pathlib: c8. when
     *note os.link(): a2a. is missing.  Patch by Toke Høiland-Jørgensen.

   - bpo-36406(3): Handle namespace packages in *note doctest: 67.
     Patch by Karthikeyan Singaravelan.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue39022

   (2) https://bugs.python.org/issue38811

   (3) https://bugs.python.org/issue36406


File: python.info,  Node: Tests,  Next: Windows,  Prev: Library,  Up: Python 3 8 1 final

1.18.1.3 Tests
..............

   - bpo-38546(1): Multiprocessing and concurrent.futures tests now stop
     the resource tracker process when tests complete.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38546


File: python.info,  Node: Windows,  Next: macOS,  Prev: Tests,  Up: Python 3 8 1 final

1.18.1.4 Windows
................

   - bpo-39007(1): Add auditing events to functions in *note winreg:
     12a.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue39007


File: python.info,  Node: macOS,  Next: IDLE<3>,  Prev: Windows,  Up: Python 3 8 1 final

1.18.1.5 macOS
..............

   - bpo-38295(1): Prevent failure of test_relative_path in
     test_py_compile on macOS Catalina.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38295


File: python.info,  Node: IDLE<3>,  Prev: macOS,  Up: Python 3 8 1 final

1.18.1.6 IDLE
.............

   - bpo-38944(1): Excape key now closes IDLE completion windows.  Patch
     by Johnny Najera.

   - bpo-38943(2): Fix IDLE autocomplete windows not always appearing on
     some systems.  Patch by Johnny Najera.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38944

   (2) https://bugs.python.org/issue38943


File: python.info,  Node: Python 3 8 1 release candidate 1,  Next: Python 3 8 0 final,  Prev: Python 3 8 1 final,  Up: Changelog

1.18.2 Python 3.8.1 release candidate 1
---------------------------------------

`Release date: 2019-12-09'

* Menu:

* Security::
* Core and Builtins: Core and Builtins<2>.
* Library: Library<2>.
* Documentation: Documentation<2>.
* Tests: Tests<2>.
* Build::
* Windows: Windows<2>.
* macOS: macOS<2>.
* IDLE: IDLE<4>.
* C API::


File: python.info,  Node: Security,  Next: Core and Builtins<2>,  Up: Python 3 8 1 release candidate 1

1.18.2.1 Security
.................

   - bpo-38945(1): Newline characters have been escaped when performing
     uu encoding to prevent them from overflowing into to content
     section of the encoded file.  This prevents malicious or accidental
     modification of data during the decoding process.

   - bpo-37228(2): Due to significant security concerns, the
     `reuse_address' parameter of *note
     asyncio.loop.create_datagram_endpoint(): 2e5. is no longer
     supported.  This is because of the behavior of ‘SO_REUSEADDR’ in
     UDP. For more details, see the documentation for
     ‘loop.create_datagram_endpoint()’.  (Contributed by Kyle Stanley,
     Antoine Pitrou, and Yury Selivanov in bpo-37228(3).)

   - bpo-38722(4): *note runpy: e2. now uses *note io.open_code(): e89.
     to open code files.  Patch by Jason Killen.

   - bpo-38804(5): Fixes a ReDoS vulnerability in *note http.cookiejar:
     95.  Patch by Ben Caller.

   - bpo-38622(6): Add additional audit events for the *note ctypes: 2b.
     module.

   - bpo-38418(7): Fixes audit event for *note os.system(): db4. to be
     named ‘os.system’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38945

   (2) https://bugs.python.org/issue37228

   (3) https://bugs.python.org/issue37228

   (4) https://bugs.python.org/issue38722

   (5) https://bugs.python.org/issue38804

   (6) https://bugs.python.org/issue38622

   (7) https://bugs.python.org/issue38418


File: python.info,  Node: Core and Builtins<2>,  Next: Library<2>,  Prev: Security,  Up: Python 3 8 1 release candidate 1

1.18.2.2 Core and Builtins
..........................

   - bpo-38673(1): In REPL mode, don’t switch to PS2 if the line starts
     with comment or whitespace.  Based on work by Batuhan Taşkaya.

   - bpo-38922(2): Calling ‘replace’ on a code object now raises the
     ‘code.__new__’ audit event.

   - bpo-38920(3): Add audit hooks for when *note sys.excepthook(): e57.
     and *note sys.unraisablehook(): 22b. are invoked

   - bpo-38892(4): Improve documentation for audit events table and
     functions.

   - bpo-38707(5): ‘MainThread.native_id’ is now correctly reset in
     child processes spawned using *note multiprocessing.Process: 3a7,
     instead of retaining the parent’s value.

   - bpo-38640(6): Fixed a bug in the compiler that was causing to raise
     in the presence of break statements and continue statements inside
     always false while loops.  Patch by Pablo Galindo.

   - bpo-38535(7): Fixed line numbers and column offsets for AST nodes
     for calls without arguments in decorators.

   - bpo-38525(8): Fix a segmentation fault when using reverse iterators
     of empty ‘dict’ objects.  Patch by Dong-hee Na and Inada Naoki.

   - bpo-35409(9): Ignore GeneratorExit exceptions when throwing an
     exception into the aclose coroutine of an asynchronous generator.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38673

   (2) https://bugs.python.org/issue38922

   (3) https://bugs.python.org/issue38920

   (4) https://bugs.python.org/issue38892

   (5) https://bugs.python.org/issue38707

   (6) https://bugs.python.org/issue38640

   (7) https://bugs.python.org/issue38535

   (8) https://bugs.python.org/issue38525

   (9) https://bugs.python.org/issue35409


File: python.info,  Node: Library<2>,  Next: Documentation<2>,  Prev: Core and Builtins<2>,  Up: Python 3 8 1 release candidate 1

1.18.2.3 Library
................

   - bpo-39006(1): Fix asyncio when the ssl module is missing: only
     check for ssl.SSLSocket instance if the ssl module is available.

   - bpo-38708(2): Fix a potential IndexError in email parser when
     parsing an empty msg-id.

   - bpo-38698(3): Add a new ‘InvalidMessageID’ token to email parser to
     represent invalid Message-ID headers.  Also, add defects when there
     is remaining value after parsing the header.

   - bpo-38979(4): Return class from ‘ContextVar.__class_getitem__’ to
     simplify subclassing.

   - bpo-38986(5): Make repr of C accelerated TaskWakeupMethWrapper the
     same as of pure Python version.

   - bpo-38529(6): Drop too noisy asyncio warning about deletion of a
     stream without explicit ‘.close()’ call.

   - bpo-38634(7): The *note readline: de. module now detects if Python
     is linked to libedit at runtime on all platforms.  Previously, the
     check was only done on macOS.

   - bpo-33684(8): Fix ‘json.tool’ failed to read a JSON file with
     non-ASCII characters when locale encoding is not UTF-8.

   - bpo-38698(9): Prevent UnboundLocalError to pop up in
     parse_message_id

     parse_message_id() was improperly using a token defined inside an
     exception handler, which was raising *note UnboundLocalError: e6a.
     on parsing an invalid value.  Patch by Claudiu Popa.

   - bpo-26730(10): Fix ‘SpooledTemporaryFile.rollover()’ might corrupt
     the file when it is in text mode.  Patch by Serhiy Storchaka.

   - bpo-38668(11): Calling func:*note shutil.copytree: 218. to copy a
     directory tree from one directory to another subdirectory resulted
     in an endless loop and a RecursionError.  A fix was added to
     consume an iterator and create the list of the entries to be
     copied, avoiding the recursion for newly created directories.
     Patch by Bruno P. Kinoshita.

   - bpo-37838(12): *note typing.get_type_hints(): 2ff. properly handles
     functions decorated with *note functools.wraps(): 85e.

   - bpo-38859(13): AsyncMock now returns StopAsyncIteration on the
     exaustion of a side_effects iterable.  Since PEP-479 its Impossible
     to raise a StopIteration exception from a coroutine.

   - bpo-38857(14): AsyncMock fix for return values that are awaitable
     types.  This also covers side_effect iterable values that happend
     to be awaitable, and wraps callables that return an awaitable type.
     Before these awaitables were being awaited instead of being
     returned as is.

   - bpo-38821(15): Fix unhandled exceptions in *note argparse: 6. when
     internationalizing error messages for arguments with ‘nargs’ set to
     special (non-integer) values.  Patch by Federico Bond.

   - bpo-38820(16): Make Python compatible with OpenSSL 3.0.0.  *note
     ssl.SSLSocket.getpeercert(): 8c5. no longer returns IPv6 addresses
     with a trailing new line.

   - bpo-38807(17): Update *note TypeError: 192. messages for *note
     os.path.join(): e8c. to include *note os.PathLike: 4e0. objects as
     acceptable input types.

   - bpo-38785(18): Prevent asyncio from crashing if parent ‘__init__’
     is not called from a constructor of object derived from
     ‘asyncio.Future’.

   - bpo-38723(19): *note pdb: c9. now uses *note io.open_code(): e89.
     to trigger auditing events.

   - bpo-27805(20): Allow opening pipes and other non-seekable files in
     append mode with *note open(): 4e5.

   - bpo-38686(21): Added support for multiple ‘qop’ values in *note
     urllib.request.AbstractDigestAuthHandler: e8d.

   - bpo-38334(22): Fixed seeking backward on an encrypted
     ‘zipfile.ZipExtFile’.

   - bpo-34679(23): asynci.ProactorEventLoop.close() now only calls
     signal.set_wakeup_fd() in the main thread.

   - bpo-31202(24): The case the result of ‘pathlib.WindowsPath.glob()’
     matches now the case of the pattern for literal parts.

   - bpo-38521(25): Fixed erroneous equality comparison in
     statistics.NormalDist().

   - bpo-38478(26): Fixed a bug in ‘inspect.signature.bind()’ that was
     causing it to fail when handling a keyword argument with same name
     as positional-only parameter.  Patch by Pablo Galindo.

   - bpo-33604(27): Fixed *note hmac.new: 848. and ‘hmac.HMAC’ to raise
     TypeError instead of ValueError when the digestmod parameter, now
     required in 3.8, is omitted.  Also clarified the hmac module
     documentation and docstrings.

   - bpo-38422(28): Clarify docstrings of pathlib suffix(es)

   - bpo-36993(29): Improve error reporting for corrupt zip files with
     bad zip64 extra data.  Patch by Daniel Hillier.

   - bpo-36820(30): Break cycle generated when saving an exception in
     socket.py, codeop.py and dyld.py as they keep alive not only the
     exception but user objects through the ‘__traceback__’ attribute.
     Patch by Mario Corchero.

   - bpo-34776(31): Fix dataclasses to support forward references in
     type annotations

   - bpo-33348(32): lib2to3 now recognizes expressions after ‘*’ and
     ‘**’ like in ‘f(*[] or [])’.

   - bpo-27657(33): Fix urllib.parse.urlparse() with numeric paths.  A
     string like “path:80” is no longer parsed as a path but as a scheme
     (“path”) and a path (“80”).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue39006

   (2) https://bugs.python.org/issue38708

   (3) https://bugs.python.org/issue38698

   (4) https://bugs.python.org/issue38979

   (5) https://bugs.python.org/issue38986

   (6) https://bugs.python.org/issue38529

   (7) https://bugs.python.org/issue38634

   (8) https://bugs.python.org/issue33684

   (9) https://bugs.python.org/issue38698

   (10) https://bugs.python.org/issue26730

   (11) https://bugs.python.org/issue38668

   (12) https://bugs.python.org/issue37838

   (13) https://bugs.python.org/issue38859

   (14) https://bugs.python.org/issue38857

   (15) https://bugs.python.org/issue38821

   (16) https://bugs.python.org/issue38820

   (17) https://bugs.python.org/issue38807

   (18) https://bugs.python.org/issue38785

   (19) https://bugs.python.org/issue38723

   (20) https://bugs.python.org/issue27805

   (21) https://bugs.python.org/issue38686

   (22) https://bugs.python.org/issue38334

   (23) https://bugs.python.org/issue34679

   (24) https://bugs.python.org/issue31202

   (25) https://bugs.python.org/issue38521

   (26) https://bugs.python.org/issue38478

   (27) https://bugs.python.org/issue33604

   (28) https://bugs.python.org/issue38422

   (29) https://bugs.python.org/issue36993

   (30) https://bugs.python.org/issue36820

   (31) https://bugs.python.org/issue34776

   (32) https://bugs.python.org/issue33348

   (33) https://bugs.python.org/issue27657


File: python.info,  Node: Documentation<2>,  Next: Tests<2>,  Prev: Library<2>,  Up: Python 3 8 1 release candidate 1

1.18.2.4 Documentation
......................

   - bpo-38816(1): Provides more details about the interaction between
     ‘fork()’ and CPython’s runtime, focusing just on the C-API. This
     includes cautions about where ‘fork()’ should and shouldn’t be
     called.

   - bpo-38351(2): Modernize *note email: 69. examples from %-formatting
     to f-strings.

   - bpo-38778(3): Document the fact that *note RuntimeError: 2b8. is
     raised if *note os.fork(): 955. is called in a subinterpreter.

   - bpo-38592(4): Add Brazilian Portuguese to the language switcher at
     Python Documentation website.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38816

   (2) https://bugs.python.org/issue38351

   (3) https://bugs.python.org/issue38778

   (4) https://bugs.python.org/issue38592


File: python.info,  Node: Tests<2>,  Next: Build,  Prev: Documentation<2>,  Up: Python 3 8 1 release candidate 1

1.18.2.5 Tests
..............

   - bpo-38547(1): Fix test_pty: if the process is the session leader,
     closing the master file descriptor raises a SIGHUP signal: simply
     ignore SIGHUP when running the tests.

   - bpo-38992(2): Fix a test for *note math.fsum(): d31. that was
     failing due to constant folding.

   - bpo-38965(3): Fix test_faulthandler on GCC 10.  Use the “volatile”
     keyword in ‘faulthandler._stack_overflow()’ to prevent tail call
     optimization on any compiler, rather than relying on compiler
     specific pragma.

   - bpo-38875(4): test_capi: trashcan tests now require the test “cpu”
     resource.

   - bpo-38841(5): Skip asyncio
     test_create_datagram_endpoint_existing_sock_unix on platforms
     lacking a functional bind() for named unix domain sockets.

   - bpo-38669(6): Raise *note TypeError: 192. when passing target as a
     string with *note unittest.mock.patch.object(): e90.

   - bpo-35998(7): Fix a race condition in
     test_asyncio.test_start_tls_server_1().  Previously, there was a
     race condition between the test main() function which replaces the
     protocol and the test ServerProto protocol which sends ANSWER once
     it gets HELLO. Now, only the test main() function is responsible to
     send data, ServerProto no longer sends data.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38547

   (2) https://bugs.python.org/issue38992

   (3) https://bugs.python.org/issue38965

   (4) https://bugs.python.org/issue38875

   (5) https://bugs.python.org/issue38841

   (6) https://bugs.python.org/issue38669

   (7) https://bugs.python.org/issue35998


File: python.info,  Node: Build,  Next: Windows<2>,  Prev: Tests<2>,  Up: Python 3 8 1 release candidate 1

1.18.2.6 Build
..............

   - bpo-37404(1): *note asyncio: a. now raises ‘TyperError’ when
     calling incompatible methods with an *note ssl.SSLSocket: 3d7.
     socket.  Patch by Ido Michael.

   - bpo-38809(2): On Windows, build scripts will now recognize and use
     python.exe from an active virtual env.

   - bpo-38684(3): Fix _hashlib build when Blake2 is disabled, but
     OpenSSL supports it.

   - bpo-37415(4): Fix stdatomic.h header check for ICC compiler: the
     ICC implementation lacks atomic_uintptr_t type which is needed by
     Python.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37404

   (2) https://bugs.python.org/issue38809

   (3) https://bugs.python.org/issue38684

   (4) https://bugs.python.org/issue37415


File: python.info,  Node: Windows<2>,  Next: macOS<2>,  Prev: Build,  Up: Python 3 8 1 release candidate 1

1.18.2.7 Windows
................

   - bpo-33125(1): Add support for building and releasing Windows ARM64
     packages.

   - bpo-38589(2): Fixes HTML Help shortcut when Windows is not
     installed to C drive

   - bpo-38453(3): Ensure ntpath.realpath() correctly resolves relative
     paths.

   - bpo-38519(4): Restores the internal C headers that were missing
     from the nuget.org and Microsoft Store packages.

   - bpo-38492(5): Remove ‘pythonw.exe’ dependency on the Microsoft C++
     runtime.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33125

   (2) https://bugs.python.org/issue38589

   (3) https://bugs.python.org/issue38453

   (4) https://bugs.python.org/issue38519

   (5) https://bugs.python.org/issue38492


File: python.info,  Node: macOS<2>,  Next: IDLE<4>,  Prev: Windows<2>,  Up: Python 3 8 1 release candidate 1

1.18.2.8 macOS
..............

   - bpo-37931(1): Fixed a crash on OSX dynamic builds that occurred
     when re-initializing the posix module after a Py_Finalize if the
     environment had changed since the previous ‘import posix’.  Patch
     by Benoît Hudson.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37931


File: python.info,  Node: IDLE<4>,  Next: C API,  Prev: macOS<2>,  Up: Python 3 8 1 release candidate 1

1.18.2.9 IDLE
.............

   - bpo-38862(1): ‘Strip Trailing Whitespace’ on the Format menu
     removes extra newlines at the end of non-shell files.

   - bpo-26353(2): Stop adding newline when saving an IDLE shell window.

   - bpo-38636(3): Fix IDLE Format menu tab toggle and file indent
     width.  These functions (default shortcuts Alt-T and Alt-U) were
     mistakenly disabled in 3.7.5 and 3.8.0.

   - bpo-4630(4): Add an option to toggle IDLE’s cursor blink for shell,
     editor, and output windows.  See Settings, General, Window
     Preferences, Cursor Blink.  Patch by Zachary Spytz.

   - bpo-38598(5): Do not try to compile IDLE shell or output windows

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38862

   (2) https://bugs.python.org/issue26353

   (3) https://bugs.python.org/issue38636

   (4) https://bugs.python.org/issue4630

   (5) https://bugs.python.org/issue38598


File: python.info,  Node: C API,  Prev: IDLE<4>,  Up: Python 3 8 1 release candidate 1

1.18.2.10 C API
...............

   - bpo-37633(1): Re-export some function compatibility wrappers for
     macros in ‘pythonrun.h’.

   - bpo-38540(2): Fixed possible leak in *note PyArg_Parse(): e96. and
     similar functions for format units ‘"es#"’ and ‘"et#"’ when the
     macro ‘PY_SSIZE_T_CLEAN’ is not defined.

   - bpo-36389(3): The ‘_PyObject_CheckConsistency()’ function is now
     also available in release mode.  For example, it can be used to
     debug a crash in the ‘visit_decref()’ function of the GC.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37633

   (2) https://bugs.python.org/issue38540

   (3) https://bugs.python.org/issue36389


File: python.info,  Node: Python 3 8 0 final,  Next: Python 3 8 0 release candidate 1,  Prev: Python 3 8 1 release candidate 1,  Up: Changelog

1.18.3 Python 3.8.0 final
-------------------------

`Release date: 2019-10-14'

* Menu:

* Core and Builtins: Core and Builtins<3>.
* Library: Library<3>.
* Documentation: Documentation<3>.
* Tests: Tests<3>.
* Windows: Windows<3>.
* IDLE: IDLE<5>.
* Tools/Demos::
* C API: C API<2>.


File: python.info,  Node: Core and Builtins<3>,  Next: Library<3>,  Up: Python 3 8 0 final

1.18.3.1 Core and Builtins
..........................

   - bpo-38469(1): Fixed a bug where the scope of named expressions was
     not being resolved correctly in the presence of the `global'
     keyword.  Patch by Pablo Galindo.

   - bpo-38379(2): When cyclic garbage collection (gc) runs finalizers
     that resurrect unreachable objects, the current gc run ends,
     without collecting any cyclic trash.  However, the statistics
     reported by ‘collect()’ and ‘get_stats()’ claimed that all cyclic
     trash found was collected, and that the resurrected objects were
     collected.  Changed the stats to report that none were collected.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38469

   (2) https://bugs.python.org/issue38379


File: python.info,  Node: Library<3>,  Next: Documentation<3>,  Prev: Core and Builtins<3>,  Up: Python 3 8 0 final

1.18.3.2 Library
................

   - bpo-38449(1): Revert GH-15522, which introduces a regression in
     *note mimetypes.guess_type(): e9a. due to improper handling of
     filenames as urls.

   - bpo-38431(2): Fix ‘__repr__’ method for ‘dataclasses.InitVar’ to
     support typing objects, patch by Samuel Colvin.

   - bpo-38109(3): Add missing *note stat.S_IFDOOR: 8c8, *note
     stat.S_IFPORT: 8c9, *note stat.S_IFWHT: 8ca, *note stat.S_ISDOOR():
     e9b, *note stat.S_ISPORT(): e9c, and *note stat.S_ISWHT(): e9d.
     values to the Python implementation of *note stat: f4.

   - bpo-38405(4): Nested subclasses of *note typing.NamedTuple: 27e.
     are now pickleable.

   - bpo-38332(5): Prevent *note KeyError: 2c5. thrown by
     ‘_encoded_words.decode()’ when given an encoded-word with invalid
     content-type encoding from propagating all the way to
     ‘email.message.get()’.

   - bpo-38341(6): Add *note smtplib.SMTPNotSupportedError: e9e. to the
     *note smtplib: ed. exported names.

   - bpo-13153(7): OS native encoding is now used for converting between
     Python strings and Tcl objects.  This allows to display, copy and
     paste to clipboard emoji and other non-BMP characters.  Converting
     strings from Tcl to Python and back now never fails (except
     MemoryError).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38449

   (2) https://bugs.python.org/issue38431

   (3) https://bugs.python.org/issue38109

   (4) https://bugs.python.org/issue38405

   (5) https://bugs.python.org/issue38332

   (6) https://bugs.python.org/issue38341

   (7) https://bugs.python.org/issue13153


File: python.info,  Node: Documentation<3>,  Next: Tests<3>,  Prev: Library<3>,  Up: Python 3 8 0 final

1.18.3.3 Documentation
......................

   - bpo-38294(1): Add list of no-longer-escaped chars to re.escape
     documentation

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38294


File: python.info,  Node: Tests<3>,  Next: Windows<3>,  Prev: Documentation<3>,  Up: Python 3 8 0 final

1.18.3.4 Tests
..............

   - bpo-37531(1): On timeout, regrtest no longer attempts to call
     ‘popen.communicate()’ again: it can hang until all child processes
     using stdout and stderr pipes completes.  Kill the worker process
     and ignores its output.  Change also the faulthandler timeout of
     the main process from 1 minute to 5 minutes, for Python slowest
     buildbots.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37531


File: python.info,  Node: Windows<3>,  Next: IDLE<5>,  Prev: Tests<3>,  Up: Python 3 8 0 final

1.18.3.5 Windows
................

   - bpo-38344(1): Fix error message in activate.bat

   - bpo-38359(2): Ensures ‘pyw.exe’ launcher reads correct registry
     key.

   - bpo-38355(3): Fixes ‘ntpath.realpath’ failing on ‘sys.executable’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38344

   (2) https://bugs.python.org/issue38359

   (3) https://bugs.python.org/issue38355


File: python.info,  Node: IDLE<5>,  Next: Tools/Demos,  Prev: Windows<3>,  Up: Python 3 8 0 final

1.18.3.6 IDLE
.............

   - bpo-36698(1): IDLE no longer fails when write non-encodable
     characters to stderr.  It now escapes them with a backslash, as the
     regular Python interpreter.  Added the ‘errors’ field to the
     standard streams.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36698


File: python.info,  Node: Tools/Demos,  Next: C API<2>,  Prev: IDLE<5>,  Up: Python 3 8 0 final

1.18.3.7 Tools/Demos
....................

   - bpo-38118(1): Update Valgrind suppression file to ignore a false
     alarm in *note PyUnicode_Decode(): ea4. when using GCC builtin
     strcmp().

   - bpo-38347(2): pathfix.py: Assume all files that end on ‘.py’ are
     Python scripts when working recursively.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38118

   (2) https://bugs.python.org/issue38347


File: python.info,  Node: C API<2>,  Prev: Tools/Demos,  Up: Python 3 8 0 final

1.18.3.8 C API
..............

   - bpo-38395(1): Fix a crash in *note weakref.proxy: 24e. objects due
     to incorrect lifetime management when calling some associated
     methods that may delete the last reference to object being
     referenced by the proxy.  Patch by Pablo Galindo.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38395


File: python.info,  Node: Python 3 8 0 release candidate 1,  Next: Python 3 8 0 beta 4,  Prev: Python 3 8 0 final,  Up: Changelog

1.18.4 Python 3.8.0 release candidate 1
---------------------------------------

`Release date: 2019-10-01'

* Menu:

* Security: Security<2>.
* Core and Builtins: Core and Builtins<4>.
* Library: Library<4>.
* Documentation: Documentation<4>.
* Tests: Tests<4>.
* Build: Build<2>.
* Windows: Windows<4>.
* macOS: macOS<3>.
* IDLE: IDLE<6>.
* Tools/Demos: Tools/Demos<2>.
* C API: C API<3>.


File: python.info,  Node: Security<2>,  Next: Core and Builtins<4>,  Up: Python 3 8 0 release candidate 1

1.18.4.1 Security
.................

   - bpo-38243(1): Escape the server title of *note
     xmlrpc.server.DocXMLRPCServer: ea8. when rendering the document
     page as HTML. (Contributed by Dong-hee Na in bpo-38243(2).)

   - bpo-38174(3): Update vendorized expat library version to 2.2.8,
     which resolves CVE-2019-15903.

   - bpo-37764(4): Fixes email._header_value_parser.get_unstructured
     going into an infinite loop for a specific case in which the email
     header does not have trailing whitespace, and the case in which it
     contains an invalid encoded word.  Patch by Ashwin Ramaswami.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38243

   (2) https://bugs.python.org/issue38243

   (3) https://bugs.python.org/issue38174

   (4) https://bugs.python.org/issue37764


File: python.info,  Node: Core and Builtins<4>,  Next: Library<4>,  Prev: Security<2>,  Up: Python 3 8 0 release candidate 1

1.18.4.2 Core and Builtins
..........................

   - bpo-38006(1): Fix a bug due to the interaction of weakrefs and the
     cyclic garbage collector.  We must clear any weakrefs in garbage in
     order to prevent their callbacks from executing and causing a
     crash.

   - bpo-38317(2): Fix warnings options priority: ‘PyConfig.warnoptions’
     has the highest priority, as stated in the PEP 587(3).

   - bpo-36871(4): Improve error handling for the assert_has_calls and
     assert_has_awaits methods of mocks.  Fixed a bug where any errors
     encountered while binding the expected calls to the mock’s spec
     were silently swallowed, leading to misleading error output.

   - bpo-38236(5): Python now dumps path configuration if it fails to
     import the Python codecs of the filesystem and stdio encodings.

   - bpo-38013(6): Allow to call ‘async_generator_athrow().throw(...)’
     even for non-started async generator helper.  It fixes annoying
     warning at the end of *note asyncio.run(): 1a4. call.

   - bpo-38124(7): Fix an off-by-one error in PyState_AddModule that
     could cause out-of-bounds memory access.

   - bpo-38005(8): Fixed comparing and creating of InterpreterID and
     ChannelID.

   - bpo-37994(9): Fixed silencing arbitrary errors if an attribute
     lookup fails in several sites.  Only AttributeError should be
     silenced.

   - bpo-37990(10): Fix elapsed time in gc stats was not printed
     correctly.  This bug was a regression in 3.8b4.

   - bpo-37966(11): The implementation of *note is_normalized(): 244.
     has been greatly sped up on strings that aren’t normalized, by
     implementing the full normalization-quick-check algorithm from the
     Unicode standard.

   - bpo-20490(12): Improve import error message for partially
     initialized module on circular ‘from’ imports - by Anthony Sottile.

   - bpo-37409(13): Ensure explicit relative imports from interactive
     sessions and scripts (having no parent package) always raise
     ImportError, rather than treating the current module as the
     package.  Patch by Ben Lewis.

   - bpo-37619(14): When adding a wrapper descriptor from one class to a
     different class (for example, setting ‘__add__ = str.__add__’ on an
     ‘int’ subclass), an exception is correctly raised when the operator
     is called.

   - bpo-30773(15): Prohibit parallel running of aclose() / asend() /
     athrow().  Fix ag_running to reflect the actual running status of
     the AG.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38006

   (2) https://bugs.python.org/issue38317

   (3) https://www.python.org/dev/peps/pep-0587

   (4) https://bugs.python.org/issue36871

   (5) https://bugs.python.org/issue38236

   (6) https://bugs.python.org/issue38013

   (7) https://bugs.python.org/issue38124

   (8) https://bugs.python.org/issue38005

   (9) https://bugs.python.org/issue37994

   (10) https://bugs.python.org/issue37990

   (11) https://bugs.python.org/issue37966

   (12) https://bugs.python.org/issue20490

   (13) https://bugs.python.org/issue37409

   (14) https://bugs.python.org/issue37619

   (15) https://bugs.python.org/issue30773


File: python.info,  Node: Library<4>,  Next: Documentation<4>,  Prev: Core and Builtins<4>,  Up: Python 3 8 0 release candidate 1

1.18.4.3 Library
................

   - bpo-38319(1): sendfile() used in socket and shutil modules was
     raising OverflowError for files >= 2GiB on 32-bit architectures.
     (patch by Giampaolo Rodola)

   - bpo-38242(2): Revert the new asyncio Streams API

   - bpo-38019(3): Correctly handle pause/resume reading of closed
     asyncio unix pipe.

   - bpo-38163(4): Child mocks will now detect their type as either
     synchronous or asynchronous, asynchronous child mocks will be
     AsyncMocks and synchronous child mocks will be either MagicMock or
     Mock (depending on their parent type).

   - bpo-38161(5): Removes _AwaitEvent from AsyncMock.

   - bpo-38216(6): Allow the rare code that wants to send invalid http
     requests from the *note http.client: 94. library a way to do so.
     The fixes for bpo-30458(7) led to breakage for some projects that
     were relying on this ability to test their own behavior in the face
     of bad requests.

   - bpo-38108(8): Any synchronous magic methods on an AsyncMock now
     return a MagicMock.  Any asynchronous magic methods on a MagicMock
     now return an AsyncMock.

   - bpo-38248(9): asyncio: Fix inconsistent immediate Task cancellation

   - bpo-38237(10): The arguments for the builtin pow function are more
     descriptive.  They can now also be passed in as keywords.

   - bpo-38191(11): Constructors of *note NamedTuple: 27e. and *note
     TypedDict: 239. types now accept arbitrary keyword argument names,
     including “cls”, “self”, “typename”, “_typename”, “fields” and
     “_fields”.  Passing positional arguments by keyword is deprecated.

   - bpo-38185(12): Fixed case-insensitive string comparison in *note
     sqlite3.Row: 752. indexing.

   - bpo-38136(13): Changes AsyncMock call count and await count to be
     two different counters.  Now await count only counts when a
     coroutine has been awaited, not when it has been called, and
     vice-versa.  Update the documentation around this.

   - bpo-37828(14): Fix default mock name in *note
     unittest.mock.Mock.assert_called(): 59d. exceptions.  Patch by
     Abraham Toriz Cruz.

   - bpo-38175(15): Fix a memory leak in comparison of *note
     sqlite3.Row: 752. objects.

   - bpo-33936(16): _hashlib no longer calls obsolete OpenSSL
     initialization function with OpenSSL 1.1.0+.

   - bpo-34706(17): Preserve subclassing in
     inspect.Signature.from_callable.

   - bpo-38153(18): Names of hashing algorithms frome OpenSSL are now
     normalized to follow Python’s naming conventions.  For example
     OpenSSL uses sha3-512 instead of sha3_512 or blake2b512 instead of
     blake2b.

   - bpo-38115(19): Fix a bug in dis.findlinestarts() where it would
     return invalid bytecode offsets.  Document that a code object’s
     co_lnotab can contain invalid bytecode offsets.

   - bpo-38148(20): Add slots to *note asyncio: a. transport classes,
     which can reduce memory usage.

   - bpo-36991(21): Fixes a potential incorrect AttributeError exception
     escaping ZipFile.extract() in some unsupported input error
     situations.

   - bpo-38134(22): Remove obsolete copy of PBKDF2_HMAC_fast.  All
     supported OpenSSL versions contain a fast implementation.

   - bpo-38132(23): The OpenSSL hashlib wrapper uses a simpler
     implementation.  Several Macros and pointless caches are gone.  The
     hash name now comes from OpenSSL’s EVP. The algorithm name stays
     the same, except it is now always lower case.

   - bpo-38008(24): Fix parent class check in protocols to correctly
     identify the module that provides a builtin protocol, instead of
     assuming they all come from the *note collections.abc: 1f. module

   - bpo-37405(25): Fixed regression bug for socket.getsockname() for
     non-CAN_ISOTP AF_CAN address family sockets by returning a 1-tuple
     instead of string.

   - bpo-38121(26): Update parameter names on functions in
     importlib.metadata matching the changes in the 0.22 release of
     importlib_metadata.

   - bpo-38110(27): The os.closewalk() implementation now uses the libc
     fdwalk() API on platforms where it is available.

   - bpo-38093(28): Fixes AsyncMock so it doesn’t crash when used with
     AsyncContextManagers or AsyncIterators.

   - bpo-37488(29): Add warning to ‘datetime.utctimetuple()’,
     ‘datetime.utcnow()’ and ‘datetime.utcfromtimestamp()’ .

   - bpo-38086(30): Update importlib.metadata with changes from
     importlib_metadata 0.21(31).

   - bpo-37251(32): Remove ‘__code__’ check in AsyncMock that
     incorrectly evaluated function specs as async objects but failed to
     evaluate classes with ‘__await__’ but no ‘__code__’ attribute
     defined as async objects.

   - bpo-38037(33): Fix reference counters in the *note signal: ea.
     module.

   - bpo-38066(34): Hide internal asyncio.Stream methods: feed_eof(),
     feed_data(), set_exception() and set_transport().

   - bpo-38059(35): inspect.py now uses sys.exit() instead of exit()

   - bpo-37953(36): In *note typing: 119, improved the ‘__hash__’ and
     ‘__eq__’ methods for ‘ForwardReferences’.

   - bpo-38026(37): Fixed *note inspect.getattr_static(): bbe. used
     ‘isinstance’ while it should avoid dynamic lookup.

   - bpo-38010(38): In ‘importlib.metadata’ sync with
     ‘importlib_metadata’ 0.20, clarifying behavior of ‘files()’ and
     fixing issue where only one requirement was returned for
     ‘requires()’ on ‘dist-info’ packages.

   - bpo-38006(39): weakref.WeakValueDictionary defines a local remove()
     function used as callback for weak references.  This function was
     created with a closure.  Modify the implementation to avoid the
     closure.

   - bpo-34410(40): Fixed a crash in the ‘tee()’ iterator when re-enter
     it.  RuntimeError is now raised in this case.

   - bpo-37140(41): Fix a ctypes regression of Python 3.8.  When a
     ctypes.Structure is passed by copy to a function, ctypes internals
     created a temporary object which had the side effect of calling the
     structure finalizer (__del__) twice.  The Python semantics requires
     a finalizer to be called exactly once.  Fix ctypes internals to no
     longer call the finalizer twice.

   - bpo-37972(42): Subscripts to the *note unittest.mock.call: eab.
     objects now receive the same chaining mechanism as any other custom
     attributes, so that the following usage no longer raises a *note
     TypeError: 192.:

     call().foo().__getitem__(‘bar’)

     Patch by blhsing

   - bpo-22347(43): Update mimetypes.guess_type to allow proper parsing
     of URLs with only a host name.  Patch by Dong-hee Na.

   - bpo-37885(44): venv: Don’t generate unset variable warning on
     deactivate.

   - bpo-37785(45): Fix xgettext warnings in *note argparse: 6.

   - bpo-11953(46): Completing WSA* error codes in *note socket: ef.

   - bpo-37424(47): Fixes a possible hang when using a timeout on *note
     subprocess.run(): 3e2. while capturing output.  If the child
     process spawned its own children or otherwise connected its stdout
     or stderr handles with another process, we could hang after the
     timeout was reached and our child was killed when attempting to
     read final output from the pipes.

   - bpo-37212(48): *note unittest.mock.call(): eab. now preserves the
     order of keyword arguments in repr output.  Patch by Karthikeyan
     Singaravelan.

   - bpo-37305(49): Add .webmanifest -> application/manifest+json to
     list of recognized file types and content type headers

   - bpo-21872(50): Fix *note lzma: ad.: module decompresses data
     incompletely.  When decompressing a FORMAT_ALONE format file, and
     it doesn’t have the end marker, sometimes the last one to dozens
     bytes can’t be output.  Patch by Ma Lin.

   - bpo-37206(51): Default values which cannot be represented as Python
     objects no longer improperly represented as ‘None’ in function
     signatures.

   - bpo-12144(52): Ensure cookies with ‘expires’ attribute are handled
     in ‘CookieJar.make_cookies()’.

   - bpo-31163(53): pathlib.Path instance’s rename and replace methods
     now return the new Path instance.

   - bpo-25068(54): *note urllib.request.ProxyHandler: eac. now
     lowercases the keys of the passed dictionary.

   - bpo-21315(55): Email headers containing RFC2047 encoded words are
     parsed despite the missing whitespace, and a defect registered.
     Also missing trailing whitespace after encoded words is now
     registered as a defect.

   - bpo-36250(56): Ignore ‘ValueError’ from ‘signal’ with ‘interaction’
     in non-main thread.

   - bpo-35168(57): *note shlex.shlex.punctuation_chars: ead. is now a
     read-only property.

   - bpo-20504(58): Fixes a bug in *note cgi: 16. module when a
     multipart/form-data request has no ‘Content-Length’ header.

   - bpo-34519(59): Add additional aliases for HP Roman 8.  Patch by
     Michael Osipov.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38319

   (2) https://bugs.python.org/issue38242

   (3) https://bugs.python.org/issue38019

   (4) https://bugs.python.org/issue38163

   (5) https://bugs.python.org/issue38161

   (6) https://bugs.python.org/issue38216

   (7) https://bugs.python.org/issue30458

   (8) https://bugs.python.org/issue38108

   (9) https://bugs.python.org/issue38248

   (10) https://bugs.python.org/issue38237

   (11) https://bugs.python.org/issue38191

   (12) https://bugs.python.org/issue38185

   (13) https://bugs.python.org/issue38136

   (14) https://bugs.python.org/issue37828

   (15) https://bugs.python.org/issue38175

   (16) https://bugs.python.org/issue33936

   (17) https://bugs.python.org/issue34706

   (18) https://bugs.python.org/issue38153

   (19) https://bugs.python.org/issue38115

   (20) https://bugs.python.org/issue38148

   (21) https://bugs.python.org/issue36991

   (22) https://bugs.python.org/issue38134

   (23) https://bugs.python.org/issue38132

   (24) https://bugs.python.org/issue38008

   (25) https://bugs.python.org/issue37405

   (26) https://bugs.python.org/issue38121

   (27) https://bugs.python.org/issue38110

   (28) https://bugs.python.org/issue38093

   (29) https://bugs.python.org/issue37488

   (30) https://bugs.python.org/issue38086

   (31) 
https://gitlab.com/python-devs/importlib_metadata/blob/0.21/importlib_metadata/docs/changelog.rst

   (32) https://bugs.python.org/issue37251

   (33) https://bugs.python.org/issue38037

   (34) https://bugs.python.org/issue38066

   (35) https://bugs.python.org/issue38059

   (36) https://bugs.python.org/issue37953

   (37) https://bugs.python.org/issue38026

   (38) https://bugs.python.org/issue38010

   (39) https://bugs.python.org/issue38006

   (40) https://bugs.python.org/issue34410

   (41) https://bugs.python.org/issue37140

   (42) https://bugs.python.org/issue37972

   (43) https://bugs.python.org/issue22347

   (44) https://bugs.python.org/issue37885

   (45) https://bugs.python.org/issue37785

   (46) https://bugs.python.org/issue11953

   (47) https://bugs.python.org/issue37424

   (48) https://bugs.python.org/issue37212

   (49) https://bugs.python.org/issue37305

   (50) https://bugs.python.org/issue21872

   (51) https://bugs.python.org/issue37206

   (52) https://bugs.python.org/issue12144

   (53) https://bugs.python.org/issue31163

   (54) https://bugs.python.org/issue25068

   (55) https://bugs.python.org/issue21315

   (56) https://bugs.python.org/issue36250

   (57) https://bugs.python.org/issue35168

   (58) https://bugs.python.org/issue20504

   (59) https://bugs.python.org/issue34519


File: python.info,  Node: Documentation<4>,  Next: Tests<4>,  Prev: Library<4>,  Up: Python 3 8 0 release candidate 1

1.18.4.4 Documentation
......................

   - bpo-26868(1): Fix example usage of *note PyModule_AddObject(): eaf.
     to properly handle errors.

   - bpo-36797(2): Fix a dead link in the distutils API Reference.

   - bpo-37977(3): Warn more strongly and clearly about pickle
     insecurity

   - bpo-37937(4): Mention ‘frame.f_trace’ in *note sys.settrace(): e31.
     docs.

   - bpo-36260(5): Add decompression pitfalls to zipfile module
     documentation.

   - bpo-36960(6): Restructured the *note datetime: 31. docs in the
     interest of making them more user-friendly and improving
     readability.  Patch by Brad Solomon.

   - bpo-23460(7): The documentation for decimal string formatting using
     the ‘:g’ specifier has been updated to reflect the correct
     exponential notation cutoff point.  Original patch contributed by
     Tuomas Suutari.

   - bpo-35803(8): Document and test that ‘tempfile’ functions may
     accept a *note path-like object: 35f. for the ‘dir’ argument.
     Patch by Anthony Sottile.

   - bpo-33944(9): Added a note about the intended use of code in .pth
     files.

   - bpo-34293(10): Fix the Doc/Makefile regarding PAPER environment
     variable and PDF builds

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26868

   (2) https://bugs.python.org/issue36797

   (3) https://bugs.python.org/issue37977

   (4) https://bugs.python.org/issue37937

   (5) https://bugs.python.org/issue36260

   (6) https://bugs.python.org/issue36960

   (7) https://bugs.python.org/issue23460

   (8) https://bugs.python.org/issue35803

   (9) https://bugs.python.org/issue33944

   (10) https://bugs.python.org/issue34293


File: python.info,  Node: Tests<4>,  Next: Build<2>,  Prev: Documentation<4>,  Up: Python 3 8 0 release candidate 1

1.18.4.5 Tests
..............

   - bpo-38239(1): Fix test_gdb for Link Time Optimization (LTO) builds.

   - bpo-38275(2): test_ssl now handles disabled TLS/SSL versions
     better.  OpenSSL’s crypto policy and run-time settings are
     recognized and tests for disabled versions are skipped.  Tests also
     accept more TLS minimum_versions for platforms that override
     OpenSSL’s default with strict settings.

   - bpo-38271(3): The private keys for test_ssl were encrypted with
     3DES in traditional PKCS#5 format.  3DES and the digest algorithm
     of PKCS#5 are blocked by some strict crypto policies.  Use PKCS#8
     format with AES256 encryption instead.

   - bpo-38270(4): test.support now has a helper function to check for
     availibility of a hash digest function.  Several tests are
     refactored avoid MD5 and use SHA256 instead.  Other tests are
     marked to use MD5 and skipped when MD5 is disabled.

   - bpo-37123(5): Multiprocessing test test_mymanager() now also
     expects -SIGTERM, not only exitcode 0.
     BaseManager._finalize_manager() sends SIGTERM to the manager
     process if it takes longer than 1 second to stop, which happens on
     slow buildbots.

   - bpo-38212(6): Multiprocessing tests: increase
     test_queue_feeder_donot_stop_onexc() timeout from 1 to 60 seconds.

   - bpo-38117(7): Test with OpenSSL 1.1.1d

   - bpo-37531(8): Enhance regrtest multiprocess timeout: write a
     message when killing a worker process, catch popen.kill() and
     popen.wait() exceptions, put a timeout on the second call to
     popen.communicate().

   - bpo-37876(9): Add tests for ROT-13 codec.

   - bpo-37252(10): Fix assertions in ‘test_close’ and
     ‘test_events_mask_overflow’ devpoll tests.

   - bpo-34001(11): Make test_ssl pass with LibreSSL. LibreSSL handles
     minimum and maximum TLS version differently than OpenSSL.

   - bpo-36919(12): Make ‘test_source_encoding.test_issue2301’
     implementation independent.  The test will work now for both
     CPython and IronPython.

   - bpo-34596(13): Fallback to a default reason when *note
     unittest.skip(): eb1. is uncalled.  Patch by Naitree Zhu.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38239

   (2) https://bugs.python.org/issue38275

   (3) https://bugs.python.org/issue38271

   (4) https://bugs.python.org/issue38270

   (5) https://bugs.python.org/issue37123

   (6) https://bugs.python.org/issue38212

   (7) https://bugs.python.org/issue38117

   (8) https://bugs.python.org/issue37531

   (9) https://bugs.python.org/issue37876

   (10) https://bugs.python.org/issue37252

   (11) https://bugs.python.org/issue34001

   (12) https://bugs.python.org/issue36919

   (13) https://bugs.python.org/issue34596


File: python.info,  Node: Build<2>,  Next: Windows<4>,  Prev: Tests<4>,  Up: Python 3 8 0 release candidate 1

1.18.4.6 Build
..............

   - bpo-38301(1): In Solaris family, we must be sure to use
     ‘-D_REENTRANT’.  Patch by Jesús Cea Avión.

   - bpo-36210(2): Update optional extension module detection for AIX.
     ossaudiodev and spwd are not applicable for AIX, and are no longer
     reported as missing.  3rd-party packaging of ncurses (with ASIS
     support) conflicts with officially supported AIX curses library, so
     configure AIX to use libcurses.a.  However, skip trying to build
     _curses_panel.

     patch by M Felt

   - bpo-36002(3): Locate ‘llvm-profdata’ and ‘llvm-ar’ binaries using
     ‘AC_PATH_TOOL’ rather than ‘AC_PATH_TARGET_TOOL’.

   - bpo-37936(4): The ‘.gitignore’ file systematically keeps “rooted”,
     with a non-trailing slash, all the rules that are meant to apply to
     files in a specific place in the repo.  Previously, when the
     intended file to ignore happened to be at the root of the repo,
     we’d most often accidentally also ignore files and directories with
     the same name anywhere in the tree.

   - bpo-37936(5): The ‘.gitignore’ file no longer applies to any files
     that are in fact tracked in the Git repository.  Patch by Greg
     Price.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38301

   (2) https://bugs.python.org/issue36210

   (3) https://bugs.python.org/issue36002

   (4) https://bugs.python.org/issue37936

   (5) https://bugs.python.org/issue37936


File: python.info,  Node: Windows<4>,  Next: macOS<3>,  Prev: Build<2>,  Up: Python 3 8 0 release candidate 1

1.18.4.7 Windows
................

   - bpo-38117(1): Update bundled OpenSSL to 1.1.1d

   - bpo-38092(2): Reduce overhead when using multiprocessing in a
     Windows virtual environment.

   - bpo-38133(3): Allow py.exe launcher to locate installations from
     the Microsoft Store and improve display of active virtual
     environments.

   - bpo-38114(4): The ‘pip.ini’ is no longer included in the Nuget
     package.

   - bpo-36634(5): *note os.cpu_count(): 873. now returns active
     processors rather than maximum processors.

   - bpo-36634(6): venv activate.bat now works when the existing
     variables contain double quote characters.

   - bpo-38081(7): Prevent error calling *note os.path.realpath(): 1fd.
     on ‘'NUL'’.

   - bpo-38087(8): Fix case sensitivity in test_pathlib and test_ntpath.

   - bpo-38088(9): Fixes distutils not finding vcruntime140.dll with
     only the v142 toolset installed.

   - bpo-37283(10): Ensure command-line and unattend.xml setting
     override previously detected states in Windows installer.

   - bpo-38030(11): Fixes *note os.stat(): 1ef. failing for block
     devices on Windows

   - bpo-38020(12): Fixes potential crash when calling *note
     os.readlink(): 1f1. (or indirectly through *note realpath(): 1fd.)
     on a file that is not a supported link.

   - bpo-37705(13): Improve the implementation of ‘winerror_to_errno()’.

   - bpo-37702(14): Fix memory leak on Windows in creating an SSLContext
     object or running urllib.request.urlopen(‘‘https://’…’).

   - bpo-37445(15): Include the ‘FORMAT_MESSAGE_IGNORE_INSERTS’ flag in
     ‘FormatMessageW()’ calls.

   - bpo-37380(16): Don’t collect unfinished processes with
     ‘subprocess._active’ on Windows to cleanup later.  Patch by Ruslan
     Kuprieiev.

   - bpo-32587(17): Make *note winreg.REG_MULTI_SZ: eb4. support
     zero-length strings.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38117

   (2) https://bugs.python.org/issue38092

   (3) https://bugs.python.org/issue38133

   (4) https://bugs.python.org/issue38114

   (5) https://bugs.python.org/issue36634

   (6) https://bugs.python.org/issue36634

   (7) https://bugs.python.org/issue38081

   (8) https://bugs.python.org/issue38087

   (9) https://bugs.python.org/issue38088

   (10) https://bugs.python.org/issue37283

   (11) https://bugs.python.org/issue38030

   (12) https://bugs.python.org/issue38020

   (13) https://bugs.python.org/issue37705

   (14) https://bugs.python.org/issue37702

   (15) https://bugs.python.org/issue37445

   (16) https://bugs.python.org/issue37380

   (17) https://bugs.python.org/issue32587


File: python.info,  Node: macOS<3>,  Next: IDLE<6>,  Prev: Windows<4>,  Up: Python 3 8 0 release candidate 1

1.18.4.8 macOS
..............

   - bpo-38117(1): Updated OpenSSL to 1.1.1d in macOS installer.

   - bpo-38089(2): Move Azure Pipelines to latest VM versions and make
     macOS tests optional

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38117

   (2) https://bugs.python.org/issue38089


File: python.info,  Node: IDLE<6>,  Next: Tools/Demos<2>,  Prev: macOS<3>,  Up: Python 3 8 0 release candidate 1

1.18.4.9 IDLE
.............

   - bpo-35379(1): When exiting IDLE, catch any AttributeError.  One
     happens when EditorWindow.close is called twice.  Printing a
     traceback, when IDLE is run from a terminal, is useless and
     annoying.

   - bpo-38183(2): To avoid problems, test_idle ignores the user config
     directory.  It no longer tries to create or access .idlerc or any
     files within.  Users must run IDLE to discover problems with saving
     settings.

   - bpo-38077(3): IDLE no longer adds ‘argv’ to the user namespace when
     initializing it.  This bug only affected 3.7.4 and 3.8.0b2 to
     3.8.0b4.

   - bpo-38041(4): Shell restart lines now fill the window width, always
     start with ‘=’, and avoid wrapping unnecessarily.  The line will
     still wrap if the included file name is long relative to the width.

   - bpo-35771(5): To avoid occasional spurious test_idle failures on
     slower machines, increase the ‘hover_delay’ in test_tooltip.

   - bpo-37902(6): Add mousewheel scrolling for IDLE module, path, and
     stack browsers.  Patch by George Zhang.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35379

   (2) https://bugs.python.org/issue38183

   (3) https://bugs.python.org/issue38077

   (4) https://bugs.python.org/issue38041

   (5) https://bugs.python.org/issue35771

   (6) https://bugs.python.org/issue37902


File: python.info,  Node: Tools/Demos<2>,  Next: C API<3>,  Prev: IDLE<6>,  Up: Python 3 8 0 release candidate 1

1.18.4.10 Tools/Demos
.....................

   - bpo-37803(1): pdb’s ‘--help’ and ‘--version’ long options now work.

   - bpo-37064(2): Add option -k to pathscript.py script: preserve
     shebang flags.  Add option -a to pathscript.py script: add flags.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37803

   (2) https://bugs.python.org/issue37064


File: python.info,  Node: C API<3>,  Prev: Tools/Demos<2>,  Up: Python 3 8 0 release candidate 1

1.18.4.11 C API
...............

   - bpo-38234(1): *note Py_SetPath(): 271. now sets *note
     sys.executable: 272. to the program full path (*note
     Py_GetProgramFullPath(): 273.) rather than to the program name
     (*note Py_GetProgramName(): 274.).

   - bpo-38234(2): Python ignored arguments passed to *note
     Py_SetPath(): 271, *note Py_SetPythonHome(): eb9. and *note
     Py_SetProgramName(): eba.: fix Python initialization to use
     specified arguments.

   - bpo-38205(3): The *note Py_UNREACHABLE(): 418. macro now calls
     *note Py_FatalError(): ebb.

   - bpo-37879(4): Fix subtype_dealloc to suppress the type decref when
     the base type is a C heap type

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue38234

   (2) https://bugs.python.org/issue38234

   (3) https://bugs.python.org/issue38205

   (4) https://bugs.python.org/issue37879


File: python.info,  Node: Python 3 8 0 beta 4,  Next: Python 3 8 0 beta 3,  Prev: Python 3 8 0 release candidate 1,  Up: Changelog

1.18.5 Python 3.8.0 beta 4
--------------------------

`Release date: 2019-08-29'

* Menu:

* Security: Security<3>.
* Core and Builtins: Core and Builtins<5>.
* Library: Library<5>.
* Documentation: Documentation<5>.
* Tests: Tests<5>.
* Build: Build<3>.
* Windows: Windows<5>.
* macOS: macOS<4>.
* IDLE: IDLE<7>.
* Tools/Demos: Tools/Demos<3>.
* C API: C API<4>.


File: python.info,  Node: Security<3>,  Next: Core and Builtins<5>,  Up: Python 3 8 0 beta 4

1.18.5.1 Security
.................

   - bpo-34155(1): Fix parsing of invalid email addresses with more than
     one ‘@’ (e.g.  a@b@c.com.)  to not return the part before 2nd ‘@’
     as valid email address.  Patch by maxking & jpic.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34155


File: python.info,  Node: Core and Builtins<5>,  Next: Library<5>,  Prev: Security<3>,  Up: Python 3 8 0 beta 4

1.18.5.2 Core and Builtins
..........................

   - bpo-37947(1): Adjust correctly the recursion level in the symtable
     generation for named expressions.  Patch by Pablo Galindo.

   - bpo-37830(2): Fixed compilation of *note break: 2d9. and *note
     continue: 181. in the *note finally: 182. block when the
     corresponding *note try: d65. block contains *note return: 190.
     with a non-constant value.

   - bpo-32912(3): Reverted bpo-32912(4): emitting *note SyntaxWarning:
     191. instead of *note DeprecationWarning: 276. for invalid escape
     sequences in string and bytes literals.

   - bpo-37757(5): PEP 572(6): As described in the PEP, assignment
     expressions now raise *note SyntaxError: 44d. when their
     interaction with comprehension scoping results in an ambiguous
     target scope.

     The ‘TargetScopeError’ subclass originally proposed by the PEP has
     been removed in favour of just raising regular syntax errors for
     the disallowed cases.

   - bpo-36311(7): Decoding bytes objects larger than 2GiB is faster and
     no longer fails when a multibyte characters spans a chunk boundary.

   - bpo-37433(8): Fix ‘SyntaxError’ indicator printing too many spaces
     for multi-line strings - by Anthony Sottile.

   - bpo-20523(9): ‘pdb.Pdb’ supports ~/.pdbrc in Windows 7.  Patch by
     Tim Hopper and Dan Lidral-Porter.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37947

   (2) https://bugs.python.org/issue37830

   (3) https://bugs.python.org/issue32912

   (4) https://bugs.python.org/issue32912

   (5) https://bugs.python.org/issue37757

   (6) https://www.python.org/dev/peps/pep-0572

   (7) https://bugs.python.org/issue36311

   (8) https://bugs.python.org/issue37433

   (9) https://bugs.python.org/issue20523


File: python.info,  Node: Library<5>,  Next: Documentation<5>,  Prev: Core and Builtins<5>,  Up: Python 3 8 0 beta 4

1.18.5.3 Library
................

   - bpo-37834(1): Prevent shutil.rmtree exception when built on
     non-Windows system without fd system call support, like older
     versions of macOS.

   - bpo-37965(2): Fix C compiler warning caused by
     distutils.ccompiler.CCompiler.has_function.

   - bpo-37960(3): ‘repr()’ of buffered and text streams now silences
     only expected exceptions when get the value of “name” and “mode”
     attributes.

   - bpo-37951(4): Most features of the subprocess module now work again
     in subinterpreters.  Only `preexec_fn' is restricted in
     subinterpreters.

   - bpo-36205(5): Fix the rusage implementation of time.process_time()
     to correctly report the sum of the system and user CPU time.

   - bpo-37950(6): Fix *note ast.dump(): ec0. when call with
     incompletely initialized node.

   - bpo-34679(7): Restores instantiation of Windows IOCP event loops
     from the non-main thread.

   - bpo-36917(8): Add default implementation of the
     ‘ast.NodeVisitor.visit_Constant()’ method which emits a deprecation
     warning and calls corresponding methody ‘visit_Num()’,
     ‘visit_Str()’, etc.

   - bpo-37798(9): Update test_statistics.py to verify that the
     statistics module works well for both C and Python implementations.
     Patch by Dong-hee Na

   - bpo-26589(10): Added a new status code to the http module: 451
     UNAVAILABLE_FOR_LEGAL_REASONS

   - bpo-37915(11): Fix a segmentation fault that appeared when
     comparing instances of ‘datetime.timezone’ and ‘datetime.tzinfo’
     objects.  Patch by Pablo Galindo.

   - bpo-37868(12): Fix dataclasses.is_dataclass when given an instance
     that never raises AttributeError in __getattr__.  That is, an
     object that returns something for __dataclass_fields__ even if it’s
     not a dataclass.

   - bpo-37811(13): Fix ‘socket’ module’s ‘socket.connect(address)’
     function being unable to establish connection in case of
     interrupted system call.  The problem was observed on all OSes
     which ‘poll(2)’ system call can take only non-negative integers and
     -1 as a timeout value.

   - bpo-21131(14): Fix ‘faulthandler.register(chain=True)’ stack.
     faulthandler now allocates a dedicated stack of ‘SIGSTKSZ*2’ bytes,
     instead of just ‘SIGSTKSZ’ bytes.  Calling the previous signal
     handler in faulthandler signal handler uses more than ‘SIGSTKSZ’
     bytes of stack memory on some platforms.

   - bpo-37798(15): Add C fastpath for statistics.NormalDist.inv_cdf()
     Patch by Dong-hee Na

   - bpo-37819(16): Add Fraction.as_integer_ratio() to match the
     corresponding methods in bool, int, float, and decimal.

   - bpo-37810(17): Fix *note difflib: 37. ‘?’ hint in diff output when
     dealing with tabs.  Patch by Anthony Sottile.

   - bpo-37772(18): In ‘zipfile.Path’, when adding implicit dirs, ensure
     that ancestral directories are added and that duplicates are
     excluded.

   - bpo-28292(19): Mark calendar.py helper functions as being private.
     The follows PEP 8 guidance to maintain the style conventions in the
     module and it addresses a known case of user confusion.

   - bpo-18049(20): Add definition of THREAD_STACK_SIZE for AIX in
     Python/thread_pthread.h The default thread stacksize caused crashes
     with the default recursion limit Patch by M Felt

   - bpo-37738(21): Fix the implementation of curses ‘addch(str,
     color_pair)’: pass the color pair to ‘setcchar()’, instead of
     always passing 0 as the color pair.

   - bpo-37723(22): Fix performance regression on regular expression
     parsing with huge character sets.  Patch by Yann Vaginay.

   - bpo-32178(23): Fix IndexError in *note email: 69. package when
     trying to parse invalid address fields starting with ‘:’.

   - bpo-37685(24): Fixed comparisons of *note datetime.timedelta: 195.
     and *note datetime.timezone: 9f5.

   - bpo-37695(25): Correct *note curses.unget_wch(): 9d4. error
     message.  Patch by Anthony Sottile.

   - bpo-37354(26): Make Activate.ps1 Powershell script static to allow
     for signing it.

   - bpo-37664(27): Update wheels bundled with ensurepip (pip 19.2.3 and
     setuptools 41.2.0)

   - bpo-37642(28): Allowed the pure Python implementation of *note
     datetime.timezone: 9f5. to represent sub-minute offsets close to
     minimum and maximum boundaries, specifically in the ranges (23:59,
     24:00) and (-23:59, 24:00).  Patch by Ngalim Siregar

   - bpo-16970(29): Adding a value error when an invalid value in passed
     to nargs Patch by Robert Leenders

   - bpo-37587(30): Make json.loads faster for long strings.  (Patch by
     Marco Paolini)

   - bpo-18378(31): Recognize “UTF-8” as a valid value for LC_CTYPE in
     locale._parse_localename.

   - bpo-37531(32): “python3 -m test -jN –timeout=TIMEOUT” now kills a
     worker process if it runs longer than `TIMEOUT' seconds.

   - bpo-37482(33): Fix serialization of display name in originator or
     destination address fields with both encoded words and special
     chars.

   - bpo-37372(34): Fix error unpickling datetime.time objects from
     Python 2 with seconds>=24.  Patch by Justin Blanchard.

   - bpo-37085(35): Add the optional Linux SocketCAN Broadcast Manager
     constants, used as flags to configure the BCM behaviour, in the
     socket module.  Patch by Karl Ding.

   - bpo-36871(36): Ensure method signature is used instead of
     constructor signature of a class while asserting mock object
     against method calls.  Patch by Karthikeyan Singaravelan.

   - bpo-36582(37): Fix ‘UserString.encode()’ to correctly return
     ‘bytes’ rather than a ‘UserString’ instance.

   - bpo-34775(38): Division handling of PurePath now returns
     NotImplemented instead of raising a TypeError when passed something
     other than an instance of str or PurePath.  Patch by Roger Aiudi.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37834

   (2) https://bugs.python.org/issue37965

   (3) https://bugs.python.org/issue37960

   (4) https://bugs.python.org/issue37951

   (5) https://bugs.python.org/issue36205

   (6) https://bugs.python.org/issue37950

   (7) https://bugs.python.org/issue34679

   (8) https://bugs.python.org/issue36917

   (9) https://bugs.python.org/issue37798

   (10) https://bugs.python.org/issue26589

   (11) https://bugs.python.org/issue37915

   (12) https://bugs.python.org/issue37868

   (13) https://bugs.python.org/issue37811

   (14) https://bugs.python.org/issue21131

   (15) https://bugs.python.org/issue37798

   (16) https://bugs.python.org/issue37819

   (17) https://bugs.python.org/issue37810

   (18) https://bugs.python.org/issue37772

   (19) https://bugs.python.org/issue28292

   (20) https://bugs.python.org/issue18049

   (21) https://bugs.python.org/issue37738

   (22) https://bugs.python.org/issue37723

   (23) https://bugs.python.org/issue32178

   (24) https://bugs.python.org/issue37685

   (25) https://bugs.python.org/issue37695

   (26) https://bugs.python.org/issue37354

   (27) https://bugs.python.org/issue37664

   (28) https://bugs.python.org/issue37642

   (29) https://bugs.python.org/issue16970

   (30) https://bugs.python.org/issue37587

   (31) https://bugs.python.org/issue18378

   (32) https://bugs.python.org/issue37531

   (33) https://bugs.python.org/issue37482

   (34) https://bugs.python.org/issue37372

   (35) https://bugs.python.org/issue37085

   (36) https://bugs.python.org/issue36871

   (37) https://bugs.python.org/issue36582

   (38) https://bugs.python.org/issue34775


File: python.info,  Node: Documentation<5>,  Next: Tests<5>,  Prev: Library<5>,  Up: Python 3 8 0 beta 4

1.18.5.4 Documentation
......................

   - bpo-37979(1): Added a link to dateutil.parser.isoparse in the
     datetime.fromisoformat documentation.  Patch by Paul Ganssle

   - bpo-37759(2): Beginning edits to Whatsnew 3.8

   - bpo-37726(3): Stop recommending getopt in the tutorial for command
     line argument parsing and promote argparse.

   - bpo-37256(4): Fix wording of arguments for ‘Request’ in *note
     urllib.request: 120.

   - bpo-37004(5): In the documentation for difflib, a note was added
     explicitly warning that the results of SequenceMatcher’s ratio
     method may depend on the order of the input strings.

   - bpo-36487(6): Make C-API docs clear about what the “main”
     interpreter is.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37979

   (2) https://bugs.python.org/issue37759

   (3) https://bugs.python.org/issue37726

   (4) https://bugs.python.org/issue37256

   (5) https://bugs.python.org/issue37004

   (6) https://bugs.python.org/issue36487


File: python.info,  Node: Tests<5>,  Next: Build<3>,  Prev: Documentation<5>,  Up: Python 3 8 0 beta 4

1.18.5.5 Tests
..............

   - bpo-37805(1): Add tests for json.dump(…, skipkeys=True).  Patch by
     Dong-hee Na.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37805


File: python.info,  Node: Build<3>,  Next: Windows<5>,  Prev: Tests<5>,  Up: Python 3 8 0 beta 4

1.18.5.6 Build
..............

   - bpo-37707(1): Mark some individual tests to skip when –pgo is used.
     The tests marked increase the PGO task time significantly and
     likely don’t help improve optimization of the final executable.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37707


File: python.info,  Node: Windows<5>,  Next: macOS<4>,  Prev: Build<3>,  Up: Python 3 8 0 beta 4

1.18.5.7 Windows
................

   - bpo-37549(1): *note os.dup(): ec5. no longer fails for standard
     streams on Windows 7.

   - bpo-1311(2): The ‘nul’ file on Windows now returns True from *note
     exists(): 1f4. and a valid result from *note os.stat(): 1ef. with
     ‘S_IFCHR’ set.

   - bpo-9949(3): Enable support for following symlinks in
     ‘os.realpath()’.

   - bpo-37834(4): Treat all name surrogate reparse points on Windows in
     *note os.lstat(): 1f0. and other reparse points as regular files in
     *note os.stat(): 1ef.

   - bpo-36266(5): Add the module name in the formatted error message
     when DLL load fail happens during module import in
     ‘_PyImport_FindSharedFuncptrWindows()’.  Patch by Srinivas
     Nyayapati.

   - bpo-25172(6): Trying to import the *note crypt: 29. module on
     Windows will result in an *note ImportError: 329. with a message
     explaining that the module isn’t supported on Windows.  On other
     platforms, if the underlying ‘_crypt’ module is not available, the
     ImportError will include a message explaining the problem.

   - bpo-37778(7): Fixes the icons used for file associations to the
     Microsoft Store package.

   - bpo-37734(8): Fix use of registry values to launch Python from
     Microsoft Store app.

   - bpo-28269(9): Replace use of ‘strcasecmp()’ for the system function
     ‘_stricmp()’.  Patch by Minmin Gong.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37549

   (2) https://bugs.python.org/issue1311

   (3) https://bugs.python.org/issue9949

   (4) https://bugs.python.org/issue37834

   (5) https://bugs.python.org/issue36266

   (6) https://bugs.python.org/issue25172

   (7) https://bugs.python.org/issue37778

   (8) https://bugs.python.org/issue37734

   (9) https://bugs.python.org/issue28269


File: python.info,  Node: macOS<4>,  Next: IDLE<7>,  Prev: Windows<5>,  Up: Python 3 8 0 beta 4

1.18.5.8 macOS
..............

   - bpo-18049(1): Increase the default stack size of threads from 5MB
     to 16MB on macOS, to match the stack size of the main thread.  This
     avoids crashes on deep recursion in threads.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18049


File: python.info,  Node: IDLE<7>,  Next: Tools/Demos<3>,  Prev: macOS<4>,  Up: Python 3 8 0 beta 4

1.18.5.9 IDLE
.............

   - bpo-37824(1): Properly handle user input warnings in IDLE shell.
     Cease turning SyntaxWarnings into SyntaxErrors.

   - bpo-37929(2): IDLE Settings dialog now closes properly when there
     is no shell window.

   - bpo-37849(3): Fixed completions list appearing too high or low when
     shown above the current line.

   - bpo-36419(4): Refactor IDLE autocomplete and improve testing.

   - bpo-37748(5): Reorder the Run menu.  Put the most common choice,
     Run Module, at the top.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37824

   (2) https://bugs.python.org/issue37929

   (3) https://bugs.python.org/issue37849

   (4) https://bugs.python.org/issue36419

   (5) https://bugs.python.org/issue37748


File: python.info,  Node: Tools/Demos<3>,  Next: C API<4>,  Prev: IDLE<7>,  Up: Python 3 8 0 beta 4

1.18.5.10 Tools/Demos
.....................

   - bpo-37942(1): Improve ArgumentClinic converter for floats.

   - bpo-37034(2): Argument Clinic now uses the argument name on errors
     with keyword-only argument instead of their position.  Patch
     contributed by Rémi Lapeyre.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37942

   (2) https://bugs.python.org/issue37034


File: python.info,  Node: C API<4>,  Prev: Tools/Demos<3>,  Up: Python 3 8 0 beta 4

1.18.5.11 C API
...............

   - bpo-36763(1): Options added by ‘PySys_AddXOption()’ are now handled
     the same way than ‘PyConfig.xoptions’ and command line ‘-X’
     options.

   - bpo-37926(2): Fix a crash in ‘PySys_SetArgvEx(0, NULL, 0)’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36763

   (2) https://bugs.python.org/issue37926


File: python.info,  Node: Python 3 8 0 beta 3,  Next: Python 3 8 0 beta 2,  Prev: Python 3 8 0 beta 4,  Up: Changelog

1.18.6 Python 3.8.0 beta 3
--------------------------

`Release date: 2019-07-29'

* Menu:

* Security: Security<4>.
* Core and Builtins: Core and Builtins<6>.
* Library: Library<6>.
* Documentation: Documentation<6>.
* Tests: Tests<6>.
* Build: Build<4>.
* Windows: Windows<6>.
* IDLE: IDLE<8>.
* Tools/Demos: Tools/Demos<4>.


File: python.info,  Node: Security<4>,  Next: Core and Builtins<6>,  Up: Python 3 8 0 beta 3

1.18.6.1 Security
.................

   - bpo-37461(1): Fix an infinite loop when parsing specially crafted
     email headers.  Patch by Abhilash Raj.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37461


File: python.info,  Node: Core and Builtins<6>,  Next: Library<6>,  Prev: Security<4>,  Up: Python 3 8 0 beta 3

1.18.6.2 Core and Builtins
..........................

   - bpo-37593(1): Swap the positions of the `posonlyargs' and `args'
     parameters in the constructor of ‘ast.parameters’ nodes.

   - bpo-36974(2): Implemented separate vectorcall functions for every
     calling convention of builtin functions and methods.  This improves
     performance for calls.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37593

   (2) https://bugs.python.org/issue36974


File: python.info,  Node: Library<6>,  Next: Documentation<6>,  Prev: Core and Builtins<6>,  Up: Python 3 8 0 beta 3

1.18.6.3 Library
................

   - bpo-37697(1): Syncronize ‘importlib.metadata’ with
     importlib_metadata 0.19(2), improving handling of EGG-INFO files
     and fixing a crash when entry point names contained colons.

   - bpo-37691(3): Let math.dist() accept coordinates as sequences (or
     iterables) rather than just tuples.

   - bpo-37664(4): Update wheels bundled with ensurepip (pip 19.2.1 and
     setuptools 41.0.1)

   - bpo-36324(5): Make internal attributes for statistics.NormalDist()
     private.

   - bpo-37491(6): Fix ‘IndexError’ when parsing email headers with
     unexpectedly ending bare-quoted string value.  Patch by Abhilash
     Raj.

   - bpo-37579(7): Return *note NotImplemented: 840. in Python
     implementation of ‘__eq__’ for *note timedelta: 195. and *note
     time: 4e8. when the other object being compared is not of the same
     type to match C implementation.  Patch by Karthikeyan Singaravelan.

   - bpo-21478(8): Record calls to parent when autospecced object is
     attached to a mock using ‘unittest.mock.attach_mock()’.  Patch by
     Karthikeyan Singaravelan.

   - bpo-37502(9): pickle.loads() no longer raises TypeError when the
     buffers argument is set to None

   - bpo-37520(10): Correct behavior for zipfile.Path.parent when the
     path object identifies a subdirectory.

   - bpo-18374(11): Fix the ‘.col_offset’ attribute of nested
     ‘ast.BinOp’ instances which had a too large value in some
     situations.

   - bpo-37421(12): Fix ‘multiprocessing.util.get_temp_dir()’ finalizer:
     clear also the ‘tempdir’ configuration of the current process, so
     next call to ‘get_temp_dir()’ will create a new temporary
     directory, rather than reusing the removed temporary directory.

   - bpo-37481(13): The distutils ‘bdist_wininst’ command is deprecated
     in Python 3.8, use ‘bdist_wheel’ (wheel packages) instead.

   - bpo-26967(14): An *note ArgumentParser: 689. with
     ‘allow_abbrev=False’ no longer disables grouping of short flags,
     such as ‘-vv’, but only disables abbreviation of long flags as
     documented.  Patch by Zac Hatfield-Dodds.

   - bpo-37347(15): *note sqlite3.Connection.create_aggregate(): ece,
     *note sqlite3.Connection.create_function(): ecf, *note
     sqlite3.Connection.set_authorizer(): ed0, *note
     sqlite3.Connection.set_progress_handler(): ed1. *note
     sqlite3.Connection.set_trace_callback(): a82. methods lead to
     segfaults if some of these methods are called twice with an equal
     object but not the same.  Now callbacks are stored more carefully.
     Patch by Aleksandr Balezin.

   - bpo-36564(16): Fix infinite loop in email header folding logic that
     would be triggered when an email policy’s max_line_length is not
     long enough to include the required markup and any values in the
     message.  Patch by Paul Ganssle

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37697

   (2) https://gitlab.com/python-devs/importlib_metadata/-/milestones/20

   (3) https://bugs.python.org/issue37691

   (4) https://bugs.python.org/issue37664

   (5) https://bugs.python.org/issue36324

   (6) https://bugs.python.org/issue37491

   (7) https://bugs.python.org/issue37579

   (8) https://bugs.python.org/issue21478

   (9) https://bugs.python.org/issue37502

   (10) https://bugs.python.org/issue37520

   (11) https://bugs.python.org/issue18374

   (12) https://bugs.python.org/issue37421

   (13) https://bugs.python.org/issue37481

   (14) https://bugs.python.org/issue26967

   (15) https://bugs.python.org/issue37347

   (16) https://bugs.python.org/issue36564


File: python.info,  Node: Documentation<6>,  Next: Tests<6>,  Prev: Library<6>,  Up: Python 3 8 0 beta 3

1.18.6.4 Documentation
......................

   - bpo-32910(1): Remove implementation-specific behaviour of how
     venv’s Deactivate works.

   - bpo-37284(2): Add a brief note to indicate that any new
     ‘sys.implementation’ required attributes must go through the PEP
     process.

   - bpo-30088(3): Documented that *note mailbox.Maildir: c9b.
     constructor doesn’t attempt to verify the maildir folder layout
     correctness.  Patch by Sviatoslav Sydorenko.

   - bpo-37521(4): Fix *note importlib: 9b. examples to insert any newly
     created modules via importlib.util.module_from_spec() immediately
     into sys.modules instead of after calling loader.exec_module().

     Thanks to Benjamin Mintz for finding the bug.

   - bpo-37456(5): Slash (‘/’) is now part of syntax.

   - bpo-37487(6): Fix PyList_GetItem index description to include 0.

   - bpo-37149(7): Replace the dead link to the Tkinter 8.5 reference by
     John Shipman, New Mexico Tech, with a link to the archive.org copy.

   - bpo-37478(8): Added possible exceptions to the description of
     os.chdir().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32910

   (2) https://bugs.python.org/issue37284

   (3) https://bugs.python.org/issue30088

   (4) https://bugs.python.org/issue37521

   (5) https://bugs.python.org/issue37456

   (6) https://bugs.python.org/issue37487

   (7) https://bugs.python.org/issue37149

   (8) https://bugs.python.org/issue37478


File: python.info,  Node: Tests<6>,  Next: Build<4>,  Prev: Documentation<6>,  Up: Python 3 8 0 beta 3

1.18.6.5 Tests
..............

   - bpo-37558(1): Fix
     test_shared_memory_cleaned_after_process_termination name handling

   - bpo-37526(2): Add *note test.support.catch_threading_exception():
     ed4.: context manager catching *note threading.Thread: 233.
     exception using *note threading.excepthook(): 22f.

   - bpo-37421(3): test_concurrent_futures now explicitly stops the
     ForkServer instance if it’s running.

   - bpo-37421(4): multiprocessing tests now stop the ForkServer
     instance if it’s running: close the “alive” file descriptor to ask
     the server to stop and then remove its UNIX address.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37558

   (2) https://bugs.python.org/issue37526

   (3) https://bugs.python.org/issue37421

   (4) https://bugs.python.org/issue37421


File: python.info,  Node: Build<4>,  Next: Windows<6>,  Prev: Tests<6>,  Up: Python 3 8 0 beta 3

1.18.6.6 Build
..............

   - bpo-36044(1): Reduce the number of unit tests run for the PGO
     generation task.  This speeds up the task by a factor of about 15x.
     Running the full unit test suite is slow.  This change may result
     in a slightly less optimized build since not as many code branches
     will be executed.  If you are willing to wait for the much slower
     build, the old behavior can be restored using ‘./configure [..]
     PROFILE_TASK=”-m test –pgo-extended”’.  We make no guarantees as to
     which PGO task set produces a faster build.  Users who care should
     run their own relevant benchmarks as results can depend on the
     environment, workload, and compiler tool chain.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36044


File: python.info,  Node: Windows<6>,  Next: IDLE<8>,  Prev: Build<4>,  Up: Python 3 8 0 beta 3

1.18.6.7 Windows
................

   - bpo-37672(1): Switch Windows Store package’s pip to use bundled
     ‘pip.ini’ instead of ‘PIP_USER’ variable.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37672


File: python.info,  Node: IDLE<8>,  Next: Tools/Demos<4>,  Prev: Windows<6>,  Up: Python 3 8 0 beta 3

1.18.6.8 IDLE
.............

   - bpo-37692(1): Improve highlight config sample with example shell
     interaction and better labels for shell elements.

   - bpo-37628(2): Settings dialog no longer expands with font size.

   - bpo-37627(3): Initialize the Customize Run dialog with the command
     line arguments most recently entered before.  The user can
     optionally edit before submitting them.

   - bpo-33610(4): Fix code context not showing the correct context when
     first toggled on.

   - bpo-37530(5): Optimize code context to reduce unneeded background
     activity.  Font and highlight changes now occur along with text
     changes instead of after a random delay.

   - bpo-27452(6): Cleanup ‘config.py’ by inlining ‘RemoveFile’ and
     simplifying the handling of ‘file’ in ‘CreateConfigHandlers’.

   - bpo-17535(7): Add optional line numbers for IDLE editor windows.
     Windows open without line numbers unless set otherwise in the
     General tab of the configuration dialog.

   - bpo-26806(8): To compensate for stack frames added by IDLE and
     avoid possible problems with low recursion limits, add 30 to limits
     in the user code execution process.  Subtract 30 when reporting
     recursion limits to make this addition mostly transparent.

   - bpo-36390(9): Gather Format menu functions into format.py.  Combine
     paragraph.py, rstrip.py, and format methods from editor.py.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37692

   (2) https://bugs.python.org/issue37628

   (3) https://bugs.python.org/issue37627

   (4) https://bugs.python.org/issue33610

   (5) https://bugs.python.org/issue37530

   (6) https://bugs.python.org/issue27452

   (7) https://bugs.python.org/issue17535

   (8) https://bugs.python.org/issue26806

   (9) https://bugs.python.org/issue36390


File: python.info,  Node: Tools/Demos<4>,  Prev: IDLE<8>,  Up: Python 3 8 0 beta 3

1.18.6.9 Tools/Demos
....................

   - bpo-37675(1): 2to3 now works when run from a zipped standard
     library.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37675


File: python.info,  Node: Python 3 8 0 beta 2,  Next: Python 3 8 0 beta 1,  Prev: Python 3 8 0 beta 3,  Up: Changelog

1.18.7 Python 3.8.0 beta 2
--------------------------

`Release date: 2019-07-04'

* Menu:

* Security: Security<5>.
* Core and Builtins: Core and Builtins<7>.
* Library: Library<7>.
* Documentation: Documentation<7>.
* Tests: Tests<7>.
* Build: Build<5>.
* Windows: Windows<7>.
* macOS: macOS<5>.
* IDLE: IDLE<9>.
* C API: C API<5>.


File: python.info,  Node: Security<5>,  Next: Core and Builtins<7>,  Up: Python 3 8 0 beta 2

1.18.7.1 Security
.................

   - bpo-37363(1): Adds audit events for the range of supported run
     commands (see *note Command line and environment: edb.).

   - bpo-37463(2): ssl.match_hostname() no longer accepts IPv4 addresses
     with additional text after the address and only quad-dotted
     notation without trailing whitespaces.  Some inet_aton()
     implementations ignore whitespace and all data after whitespace,
     e.g.  ‘127.0.0.1 whatever’.

   - bpo-37363(3): Adds audit events for *note ensurepip: 7a, *note
     ftplib: 84, *note glob: 8a, *note imaplib: 98, *note nntplib: c0,
     *note pdb: c9, *note poplib: d0, *note shutil: e9, *note smtplib:
     ed, *note sqlite3: f2, *note subprocess: f9, *note telnetlib: 102,
     *note tempfile: 103. and *note webbrowser: 129, as well as *note
     os.listdir(): a36, *note os.scandir(): 25d. and *note breakpoint():
     2ee.

   - bpo-37364(4): *note io.open_code(): e89. is now used when reading
     ‘.pth’ files.

   - bpo-34631(5): Updated OpenSSL to 1.1.1c in Windows installer

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37363

   (2) https://bugs.python.org/issue37463

   (3) https://bugs.python.org/issue37363

   (4) https://bugs.python.org/issue37364

   (5) https://bugs.python.org/issue34631


File: python.info,  Node: Core and Builtins<7>,  Next: Library<7>,  Prev: Security<5>,  Up: Python 3 8 0 beta 2

1.18.7.2 Core and Builtins
..........................

   - bpo-37467(1): Fix *note sys.excepthook(): e57. and
     ‘PyErr_Display()’ if a filename is a bytes string.  For example,
     for a SyntaxError exception where the filename attribute is a bytes
     string.

   - bpo-37417(2): ‘bytearray.extend()’ now correctly handles errors
     that arise during iteration.  Patch by Brandt Bucher.

   - bpo-24214(3): Improved support of the surrogatepass error handler
     in the UTF-8 and UTF-16 incremental decoders.

   - bpo-35224(4): Reverse evaluation order of key: value in dict
     comprehensions as proposed in PEP 572.  I.e.  in ‘{k: v for ...}’,
     ‘k’ will be evaluated before ‘v’.

   - bpo-37316(5): Fix the *note PySys_Audit(): e81. call in *note
     mmap.mmap: 1ea.

   - bpo-37269(6): Fix a bug in the peephole optimizer that was not
     treating correctly constant conditions with binary operators.
     Patch by Pablo Galindo.

   - bpo-37213(7): Handle correctly negative line offsets in the
     peephole optimizer.  Patch by Pablo Galindo.

   - bpo-37219(8): Remove errorneous optimization for empty set
     differences.

   - bpo-36922(9): Slot functions optimize any callable with
     ‘Py_TPFLAGS_METHOD_DESCRIPTOR’ instead of only instances of
     ‘function’.

   - bpo-36974(10): The slot ‘tp_vectorcall_offset’ is inherited
     unconditionally to support ‘super().__call__()’ when the base class
     uses vectorcall.

   - bpo-37160(11): *note threading.get_native_id(): 231. now also
     supports NetBSD.

   - bpo-37077(12): Add *note threading.get_native_id(): 231. support
     for AIX. Patch by M. Felt

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37467

   (2) https://bugs.python.org/issue37417

   (3) https://bugs.python.org/issue24214

   (4) https://bugs.python.org/issue35224

   (5) https://bugs.python.org/issue37316

   (6) https://bugs.python.org/issue37269

   (7) https://bugs.python.org/issue37213

   (8) https://bugs.python.org/issue37219

   (9) https://bugs.python.org/issue36922

   (10) https://bugs.python.org/issue36974

   (11) https://bugs.python.org/issue37160

   (12) https://bugs.python.org/issue37077


File: python.info,  Node: Library<7>,  Next: Documentation<7>,  Prev: Core and Builtins<7>,  Up: Python 3 8 0 beta 2

1.18.7.3 Library
................

   - bpo-37440(1): http.client now enables TLS 1.3 post-handshake
     authentication for default context or if a cert_file is passed to
     HTTPSConnection.

   - bpo-37437(2): Update vendorized expat version to 2.2.7.

   - bpo-37428(3): SSLContext.post_handshake_auth = True no longer sets
     SSL_VERIFY_POST_HANDSHAKE verify flag for client connections.
     Although the option is documented as ignored for clients, OpenSSL
     implicitly enables cert chain validation when the flag is set.

   - bpo-37420(4): *note os.sched_setaffinity(): a4a. now correctly
     handles errors that arise during iteration over its ‘mask’
     argument.  Patch by Brandt Bucher.

   - bpo-37412(5): The *note os.getcwdb(): 2b6. function now uses the
     UTF-8 encoding on Windows, rather than the ANSI code page: see PEP
     529(6) for the rationale.  The function is no longer deprecated on
     Windows.

   - bpo-29412(7): Fix IndexError in parsing a header value ending
     unexpectedly.  Patch by Abhilash Raj.

   - bpo-36546(8): The `dist' argument for statistics.quantiles() is now
     positional only.  The current name doesn’t reflect that the
     argument can be either a dataset or a distribution.  Marking the
     parameter as positional avoids confusion and makes it possible to
     change the name later.

   - bpo-37394(9): Fix a bug that was causing the *note queue: da.
     module to fail if the accelerator module was not available.  Patch
     by Pablo Galindo.

   - bpo-33972(10): Email with single part but content-type set to
     ‘multipart/*’ doesn’t raise AttributeError anymore.

   - bpo-37280(11): Use threadpool for reading from file for sendfile
     fallback mode.

   - bpo-37279(12): Fix asyncio sendfile support when sendfile sends
     extra data in fallback mode.

   - bpo-19865(13): *note ctypes.create_unicode_buffer(): ede. now also
     supports non-BMP characters on platforms with 16-bit ‘wchar_t’ (for
     example, Windows and AIX).

   - bpo-37210(14): Allow pure Python implementation of *note pickle:
     ca. to work even when the C ‘_pickle’ module is unavailable.

   - bpo-35922(15): Fix ‘RobotFileParser.crawl_delay()’ and
     ‘RobotFileParser.request_rate()’ to return ‘None’ rather than raise
     *note AttributeError: 390. when no relevant rule is defined in the
     robots.txt file.  Patch by Rémi Lapeyre.

   - bpo-35766(16): Change the format of feature_version to be a (major,
     minor) tuple.

   - bpo-36607(17): Eliminate *note RuntimeError: 2b8. raised by *note
     asyncio.all_tasks(): 346. if internal tasks weak set is changed by
     another thread during iteration.

   - bpo-18748(18): ‘_pyio.IOBase’ destructor now does nothing if
     getting the ‘closed’ attribute fails to better mimick ‘_io.IOBase’
     finalizer.

   - bpo-36402(19): Fix a race condition at Python shutdown when waiting
     for threads.  Wait until the Python thread state of all non-daemon
     threads get deleted (join all non-daemon threads), rather than just
     wait until non-daemon Python threads complete.

   - bpo-34886(20): Fix an unintended ValueError from *note
     subprocess.run(): 3e2. when checking for conflicting *note input:
     c5e. and ‘stdin’ or ‘capture_output’ and ‘stdout’ or ‘stderr’ args
     when they were explicitly provided but with *note None: 157. values
     within a passed in ‘**kwargs’ dict rather than as passed directly
     by name.  Patch contributed by Rémi Lapeyre.

   - bpo-37173(21): The exception message for ‘inspect.getfile()’ now
     correctly reports the passed class rather than the builtins module.

   - bpo-37178(22): Give math.perm() a one argument form that means the
     same as math.factorial().

   - bpo-37178(23): For math.perm(n, k), let k default to n, giving the
     same result as factorial.

   - bpo-37163(24): Deprecated passing ‘obj’ argument of *note
     dataclasses.replace(): edf. as keyword argument.

   - bpo-37165(25): Converted _collections._count_elements to use the
     Argument Clinic.

   - bpo-34767(26): Do not always create a *note collections.deque: 526.
     in *note asyncio.Lock: 289.

   - bpo-37158(27): Speed-up statistics.fmean() by switching from a
     function to a generator.

   - bpo-37150(28): ‘argparse._ActionsContainer.add_argument’ now throws
     error, if someone accidentally pass FileType class object instead
     of instance of FileType as *note type: 5fd. argument

   - bpo-35621(29): Support running asyncio subprocesses when execution
     event loop in a thread on UNIX.

   - bpo-36520(30): Lengthy email headers with UTF-8 characters are now
     properly encoded when they are folded.  Patch by Jeffrey Kintscher.

   - bpo-30835(31): Fixed a bug in email parsing where a message with
     invalid bytes in content-transfer-encoding of a multipart message
     can cause an AttributeError.  Patch by Andrew Donnellan.

   - bpo-35805(32): Add parser for Message-ID header and add it to
     default HeaderRegistry.  This should prevent folding of Message-ID
     using RFC 2048 encoded words.

   - bpo-35070(33): posix.getgrouplist() now works correctly when the
     user belongs to NGROUPS_MAX supplemental groups.  Patch by Jeffrey
     Kintscher.

   - bpo-32627(34): Fix compile error when ‘_uuid’ headers conflicting
     included.

   - bpo-11122(35): Distutils won’t check for rpmbuild in specified
     paths only.

   - bpo-4963(36): Fixed non-deterministic behavior related to mimetypes
     extension mapping and module reinitialization.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37440

   (2) https://bugs.python.org/issue37437

   (3) https://bugs.python.org/issue37428

   (4) https://bugs.python.org/issue37420

   (5) https://bugs.python.org/issue37412

   (6) https://www.python.org/dev/peps/pep-0529

   (7) https://bugs.python.org/issue29412

   (8) https://bugs.python.org/issue36546

   (9) https://bugs.python.org/issue37394

   (10) https://bugs.python.org/issue33972

   (11) https://bugs.python.org/issue37280

   (12) https://bugs.python.org/issue37279

   (13) https://bugs.python.org/issue19865

   (14) https://bugs.python.org/issue37210

   (15) https://bugs.python.org/issue35922

   (16) https://bugs.python.org/issue35766

   (17) https://bugs.python.org/issue36607

   (18) https://bugs.python.org/issue18748

   (19) https://bugs.python.org/issue36402

   (20) https://bugs.python.org/issue34886

   (21) https://bugs.python.org/issue37173

   (22) https://bugs.python.org/issue37178

   (23) https://bugs.python.org/issue37178

   (24) https://bugs.python.org/issue37163

   (25) https://bugs.python.org/issue37165

   (26) https://bugs.python.org/issue34767

   (27) https://bugs.python.org/issue37158

   (28) https://bugs.python.org/issue37150

   (29) https://bugs.python.org/issue35621

   (30) https://bugs.python.org/issue36520

   (31) https://bugs.python.org/issue30835

   (32) https://bugs.python.org/issue35805

   (33) https://bugs.python.org/issue35070

   (34) https://bugs.python.org/issue32627

   (35) https://bugs.python.org/issue11122

   (36) https://bugs.python.org/issue4963


File: python.info,  Node: Documentation<7>,  Next: Tests<7>,  Prev: Library<7>,  Up: Python 3 8 0 beta 2

1.18.7.4 Documentation
......................

   - bpo-34903(1): Documented that in *note
     datetime.datetime.strptime(): ee1, the leading zero in some
     two-digit formats is optional.  Patch by Mike Gleen.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34903


File: python.info,  Node: Tests<7>,  Next: Build<5>,  Prev: Documentation<7>,  Up: Python 3 8 0 beta 2

1.18.7.5 Tests
..............

   - bpo-37421(1): test_distutils.test_build_ext() is now able to remove
     the temporary directory on Windows: don’t import the newly built C
     extension (“xx”) in the current process, but test it in a separated
     process.

   - bpo-37421(2): test_concurrent_futures now cleans up multiprocessing
     to remove immediately temporary directories created by
     multiprocessing.util.get_temp_dir().

   - bpo-37421(3): test_winconsoleio doesn’t leak a temporary file
     anymore: use tempfile.TemporaryFile() to remove it when the test
     completes.

   - bpo-37421(4): multiprocessing tests now explicitly call
     ‘_run_finalizers()’ to immediately remove temporary directories
     created by tests.

   - bpo-37199(5): Fix test failures when IPv6 is unavailable or
     disabled.

   - bpo-37335(6): Remove no longer necessary code from c locale
     coercion tests

   - bpo-37421(7): Fix test_shutil to no longer leak temporary files.

   - bpo-37411(8): Fix test_wsgiref.testEnviron() to no longer depend on
     the environment variables (don’t fail if “X” variable is set).

   - bpo-37400(9): Fix test_os.test_chown(): use os.getgroups() rather
     than grp.getgrall() to get groups.  Rename also the test to
     test_chown_gid().

   - bpo-37359(10): Add –cleanup option to python3 -m test to remove
     ‘test_python_*’ directories of previous failed jobs.  Add “make
     cleantest” to run ‘python3 -m test --cleanup’.

   - bpo-37362(11): test_gdb no longer fails if it gets an “unexpected”
     message on stderr: it now ignores stderr.  The purpose of test_gdb
     is to test that python-gdb.py commands work as expected, not to
     test gdb.

   - bpo-35998(12): Avoid TimeoutError in test_asyncio:
     test_start_tls_server_1()

   - bpo-37278(13): Fix test_asyncio ProactorLoopCtrlC: join the thread
     to prevent leaking a running thread and leaking a reference.

   - bpo-37261(14): Fix *note test.support.catch_unraisable_exception():
     ee3.: its __exit__() method now ignores unraisable exception raised
     when clearing its ‘unraisable’ attribute.

   - bpo-37169(15): Rewrite ‘_PyObject_IsFreed()’ unit tests.

   - bpo-37153(16): ‘test_venv.test_mutiprocessing()’ now explicitly
     calls ‘pool.terminate()’ to wait until the pool completes.

   - bpo-28009(17): Modify the test_uuid logic to test when a program is
     available AND can be used to obtain a MACADDR as basis for an UUID.
     Patch by M. Felt

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37421

   (2) https://bugs.python.org/issue37421

   (3) https://bugs.python.org/issue37421

   (4) https://bugs.python.org/issue37421

   (5) https://bugs.python.org/issue37199

   (6) https://bugs.python.org/issue37335

   (7) https://bugs.python.org/issue37421

   (8) https://bugs.python.org/issue37411

   (9) https://bugs.python.org/issue37400

   (10) https://bugs.python.org/issue37359

   (11) https://bugs.python.org/issue37362

   (12) https://bugs.python.org/issue35998

   (13) https://bugs.python.org/issue37278

   (14) https://bugs.python.org/issue37261

   (15) https://bugs.python.org/issue37169

   (16) https://bugs.python.org/issue37153

   (17) https://bugs.python.org/issue28009


File: python.info,  Node: Build<5>,  Next: Windows<7>,  Prev: Tests<7>,  Up: Python 3 8 0 beta 2

1.18.7.6 Build
..............

   - bpo-37189(1): Many ‘PyRun_XXX()’ functions like *note
     PyRun_String(): ee5. were no longer exported in ‘libpython38.dll’
     by mistake.  Export them again to fix the ABI compatibiliy.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37189


File: python.info,  Node: Windows<7>,  Next: macOS<5>,  Prev: Build<5>,  Up: Python 3 8 0 beta 2

1.18.7.7 Windows
................

   - bpo-10945(1): Officially drop support for creating bdist_wininst
     installers on non-Windows systems.

   - bpo-37369(2): Fixes path for *note sys.executable: 272. when
     running from the Microsoft Store.

   - bpo-37351(3): Removes libpython38.a from standard Windows
     distribution.

   - bpo-35360(4): Update Windows builds to use SQLite 3.28.0.

   - bpo-37267(5): On Windows, *note os.dup(): ec5. no longer creates an
     inheritable fd when handling a character file.

   - bpo-36779(6): Ensure ‘time.tzname’ is correct on Windows when the
     active code page is set to CP_UTF7 or CP_UTF8.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10945

   (2) https://bugs.python.org/issue37369

   (3) https://bugs.python.org/issue37351

   (4) https://bugs.python.org/issue35360

   (5) https://bugs.python.org/issue37267

   (6) https://bugs.python.org/issue36779


File: python.info,  Node: macOS<5>,  Next: IDLE<9>,  Prev: Windows<7>,  Up: Python 3 8 0 beta 2

1.18.7.8 macOS
..............

   - bpo-34602(1): Avoid test suite failures on macOS by no longer
     calling resource.setrlimit to increase the process stack size limit
     at runtime.  The runtime change is no longer needed since the
     interpreter is being built with a larger default stack size.

   - bpo-35360(2): Update macOS installer to use SQLite 3.28.0.

   - bpo-34631(3): Updated OpenSSL to 1.1.1c in macOS installer.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34602

   (2) https://bugs.python.org/issue35360

   (3) https://bugs.python.org/issue34631


File: python.info,  Node: IDLE<9>,  Next: C API<5>,  Prev: macOS<5>,  Up: Python 3 8 0 beta 2

1.18.7.9 IDLE
.............

   - bpo-37325(1): Fix tab focus traversal order for help source and
     custom run dialogs.

   - bpo-37321(2): Both subprocess connection error messages now refer
     to the ‘Startup failure’ section of the IDLE doc.

   - bpo-37177(3): Properly ‘attach’ search dialogs to their main window
     so that they behave like other dialogs and do not get hidden behind
     their main window.

   - bpo-37039(4): Adjust “Zoom Height” to individual screens by
     momemtarily maximizing the window on first use with a particular
     screen.  Changing screen settings may invalidate the saved height.
     While a window is maximized, “Zoom Height” has no effect.

   - bpo-35763(5): Make calltip reminder about ‘/’ meaning
     positional-only less obtrusive by only adding it when there is room
     on the first line.

   - bpo-5680(6): Add ‘Run… Customized’ to the Run menu to run a module
     with customized settings.  Any ‘command line arguments’ entered are
     added to sys.argv.  One can suppress the normal Shell main module
     restart.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37325

   (2) https://bugs.python.org/issue37321

   (3) https://bugs.python.org/issue37177

   (4) https://bugs.python.org/issue37039

   (5) https://bugs.python.org/issue35763

   (6) https://bugs.python.org/issue5680


File: python.info,  Node: C API<5>,  Prev: IDLE<9>,  Up: Python 3 8 0 beta 2

1.18.7.10 C API
...............

   - bpo-36763(1): Add ‘PyConfig_SetWideStringList()’ function.

   - bpo-28805(2): The *note METH_FASTCALL: eea. calling convention has
     been documented.

   - bpo-37221(3): ‘tp_print’ is put back at the end of the
     ‘PyTypeObject’ structure to restore support for old code (in
     particular generated by Cython) setting ‘tp_print = 0’.  Note that
     ‘tp_print’ will be removed entirely in Python 3.9.

   - bpo-37221(4): The new function *note PyCode_NewWithPosOnlyArgs():
     26f. allows to create code objects like *note PyCode_New(): 270,
     but with an extra `posonlyargcount' parameter for indicating the
     number of positonal-only arguments.

   - bpo-37215(5): Fix dtrace issue introduce by bpo-36842(6)

   - bpo-37191(7): Python.h does not need compiler support for
     intermingled declarations (GCC’s ‘-Wdeclaration-after-statement’),
     which were added in 3.8.0 Beta 1.  Note that in Python 3.9,
     intermingled declarations will be needed again.

   - bpo-37170(8): Fix the cast on error in *note
     PyLong_AsUnsignedLongLongMask(): eeb.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36763

   (2) https://bugs.python.org/issue28805

   (3) https://bugs.python.org/issue37221

   (4) https://bugs.python.org/issue37221

   (5) https://bugs.python.org/issue37215

   (6) https://bugs.python.org/issue36842

   (7) https://bugs.python.org/issue37191

   (8) https://bugs.python.org/issue37170


File: python.info,  Node: Python 3 8 0 beta 1,  Next: Python 3 8 0 alpha 4,  Prev: Python 3 8 0 beta 2,  Up: Changelog

1.18.8 Python 3.8.0 beta 1
--------------------------

`Release date: 2019-06-04'

* Menu:

* Security: Security<6>.
* Core and Builtins: Core and Builtins<8>.
* Library: Library<8>.
* Documentation: Documentation<8>.
* Tests: Tests<8>.
* Build: Build<6>.
* Windows: Windows<8>.
* macOS: macOS<6>.
* IDLE: IDLE<10>.
* Tools/Demos: Tools/Demos<5>.
* C API: C API<6>.


File: python.info,  Node: Security<6>,  Next: Core and Builtins<8>,  Up: Python 3 8 0 beta 1

1.18.8.1 Security
.................

   - bpo-35907(1): CVE-2019-9948: Avoid file reading by disallowing
     ‘local-file://’ and ‘local_file://’ URL schemes in
     ‘URLopener().open()’ and ‘URLopener().retrieve()’ of *note
     urllib.request: 120.

   - bpo-33529(2): Prevent fold function used in email header encoding
     from entering infinite loop when there are too many non-ASCII
     characters in a header.

   - bpo-33164(3): Updated blake2 implementation which uses secure
     memset implementation provided by platform.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35907

   (2) https://bugs.python.org/issue33529

   (3) https://bugs.python.org/issue33164


File: python.info,  Node: Core and Builtins<8>,  Next: Library<8>,  Prev: Security<6>,  Up: Python 3 8 0 beta 1

1.18.8.2 Core and Builtins
..........................

   - bpo-35814(1): Allow unpacking in the right hand side of annotated
     assignments.  In particular, ‘t: Tuple[int, ...] = x, y, *z’ is now
     allowed.

   - bpo-37126(2): All structseq objects are now tracked by the garbage
     collector.  Patch by Pablo Galindo.

   - bpo-37122(3): Make the `co_argcount' attribute of code objects
     represent the total number of positional arguments (including
     positional-only arguments).  The value of `co_posonlyargcount' can
     be used to distinguish which arguments are positional only, and the
     difference (`co_argcount' - `co_posonlyargcount') is the number of
     positional-or-keyword arguments.  Patch by Pablo Galindo.

   - bpo-20092(4): Constructors of *note int: 184, *note float: 187. and
     *note complex: 189. will now use the *note __index__(): 18a.
     special method, if available and the corresponding method *note
     __int__(): 18b, *note __float__(): 18c. or *note __complex__():
     18d. is not available.

   - bpo-37087(5): Add native thread ID (TID) support to OpenBSD.

   - bpo-26219(6): Implemented per opcode cache mechanism and
     ‘LOAD_GLOBAL’ instruction use it.  ‘LOAD_GLOBAL’ is now about 40%
     faster.  Contributed by Yury Selivanov, and Inada Naoki.

   - bpo-37072(7): Fix crash in PyAST_FromNodeObject() when flags is
     NULL.

   - bpo-37029(8): Freeing a great many small objects could take time
     quadratic in the number of arenas, due to using linear search to
     keep ‘obmalloc.c’’s list of usable arenas sorted by order of number
     of free memory pools.  This is accomplished without search now,
     leaving the worst-case time linear in the number of arenas.  For
     programs where this quite visibly matters (typically with more than
     100 thousand small objects alive simultaneously), this can greatly
     reduce the time needed to release their memory.

   - bpo-26423(9): Fix possible overflow in ‘wrap_lenfunc()’ when
     ‘sizeof(long) < sizeof(Py_ssize_t)’ (e.g., 64-bit Windows).

   - bpo-37050(10): Improve the AST for “debug” f-strings, which use ‘=’
     to print out the source of the expression being evaluated.  Delete
     expr_text from the FormattedValue node, and instead use a Constant
     string node (possibly merged with adjacent constant expressions
     inside the f-string).

   - bpo-22385(11): The *note bytes.hex: 625, *note bytearray.hex: 626,
     and *note memoryview.hex: 627. methods as well as the *note
     binascii.hexlify: eef. and ‘b2a_hex’ functions now have the ability
     to include an optional separator between hex bytes.  This
     functionality was inspired by MicroPython’s hexlify implementation.

   - bpo-26836(12): Add *note os.memfd_create(): 1ee.

   - bpo-37032(13): Added new ‘replace()’ method to the code type (*note
     types.CodeType: 198.).

   - bpo-37007(14): Implement *note socket.if_nameindex(): 21e, *note
     socket.if_nametoindex(): 21f, and *note socket.if_indextoname():
     220. on Windows.

   - bpo-36829(15): *note PyErr_WriteUnraisable(): ef0. now creates a
     traceback object if there is no current traceback.  Moreover, call
     *note PyErr_NormalizeException(): ef1. and *note
     PyException_SetTraceback(): ef2. to normalize the exception value.
     Ignore any error.

   - bpo-36878(16): Only accept text after ‘# type: ignore’ if the first
     character is ASCII. This is to disallow things like ‘# type:
     ignoreé’.

   - bpo-36878(17): Store text appearing after a ‘# type: ignore’
     comment in the AST. For example a type ignore like ‘# type:
     ignore[E1000]’ will have the string ‘"[E1000]"’ stored in its AST
     node.

   - bpo-2180(18): Treat line continuation at EOF as a ‘SyntaxError’ by
     Anthony Sottile.

   - bpo-36907(19): Fix a crash when calling a C function with a keyword
     dict (‘f(**kwargs)’) and changing the dict ‘kwargs’ while that
     function is running.

   - bpo-36946(20): Fix possible signed integer overflow when handling
     slices.

   - bpo-36826(21): Add NamedExpression kind support to ast_unparse.c

   - bpo-1875(22): A *note SyntaxError: 44d. is now raised if a code
     blocks that will be optimized away (e.g.  if conditions that are
     always false) contains syntax errors.  Patch by Pablo Galindo.

   - bpo-36027(23): Allow computation of modular inverses via
     three-argument ‘pow’: the second argument is now permitted to be
     negative in the case where the first and third arguments are
     relatively prime.

   - bpo-36861(24): Update the Unicode database to version 12.1.0.

   - bpo-28866(25): Avoid caching attributes of classes which type
     defines mro() to avoid a hard cache invalidation problem.

   - bpo-36851(26): The ‘FrameType’ stack is now correctly cleaned up if
     the execution ends with a return and the stack is not empty.

   - bpo-34616(27): The ‘compile()’ builtin functions now support the
     ‘ast.PyCF_ALLOW_TOP_LEVEL_AWAIT’ flag, which allow to compile
     sources that contains top-level ‘await’, ‘async with’ or ‘async
     for’.  This is useful to evaluate async-code from with an already
     async functions; for example in a custom REPL.

   - bpo-36842(28): Implement PEP 578, adding sys.audit, io.open_code
     and related APIs.

   - bpo-27639(29): Correct return type for UserList slicing operations.
     Patch by Michael Blahay, Erick Cervantes, and vaultah

   - bpo-36737(30): Move PyRuntimeState.warnings into per-interpreter
     state (via “module state”).

   - bpo-36793(31): Removed ‘__str__’ implementations from builtin types
     *note bool: 183, *note int: 184, *note float: 187, *note complex:
     189. and few classes from the standard library.  They now inherit
     ‘__str__()’ from *note object: 2ae.

   - bpo-36817(32): Add a ‘=’ feature f-strings for debugging.  This can
     precede ‘!s’, ‘!r’, or ‘!a’.  It produces the text of the
     expression, followed by an equal sign, followed by the repr of the
     value of the expression.  So ‘f'{3*9+15=}'’ would be equal to the
     string ‘'3*9+15=42'’.  If ‘=’ is specified, the default conversion
     is set to ‘!r’, unless a format spec is given, in which case the
     formatting behavior is unchanged, and __format__ will be used.

   - bpo-24048(33): Save the live exception during import.c’s
     ‘remove_module()’.

   - bpo-27987(34): pymalloc returns memory blocks aligned by 16 bytes,
     instead of 8 bytes, on 64-bit platforms to conform x86-64 ABI.
     Recent compilers assume this alignment more often.  Patch by Inada
     Naoki.

   - bpo-36601(35): A long-since-meaningless check for ‘getpid() ==
     main_pid’ was removed from Python’s internal C signal handler.

   - bpo-36594(36): Fix incorrect use of ‘%p’ in format strings.  Patch
     by Zackery Spytz.

   - bpo-36045(37): builtins.help() now prefixes ‘async’ for async
     functions

   - bpo-36084(38): Add native thread ID (TID) to threading.Thread
     objects (supported platforms: Windows, FreeBSD, Linux, macOS)

   - bpo-36035(39): Added fix for broken symlinks in combination with
     pathlib

   - bpo-35983(40): Added new trashcan macros to deal with a double
     deallocation that could occur when the ‘tp_dealloc’ of a subclass
     calls the ‘tp_dealloc’ of a base class and that base class uses the
     trashcan mechanism.  Patch by Jeroen Demeyer.

   - bpo-20602(41): Do not clear *note sys.flags: b2f. and *note
     sys.float_info: ef3. during shutdown.  Patch by Zackery Spytz.

   - bpo-26826(42): Expose ‘copy_file_range()’ as a low level API in the
     *note os: c4. module.

   - bpo-32388(43): Remove cross-version binary compatibility
     requirement in tp_flags.

   - bpo-31862(44): Port binascii to PEP 489 multiphase initialization.
     Patch by Marcel Plch.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35814

   (2) https://bugs.python.org/issue37126

   (3) https://bugs.python.org/issue37122

   (4) https://bugs.python.org/issue20092

   (5) https://bugs.python.org/issue37087

   (6) https://bugs.python.org/issue26219

   (7) https://bugs.python.org/issue37072

   (8) https://bugs.python.org/issue37029

   (9) https://bugs.python.org/issue26423

   (10) https://bugs.python.org/issue37050

   (11) https://bugs.python.org/issue22385

   (12) https://bugs.python.org/issue26836

   (13) https://bugs.python.org/issue37032

   (14) https://bugs.python.org/issue37007

   (15) https://bugs.python.org/issue36829

   (16) https://bugs.python.org/issue36878

   (17) https://bugs.python.org/issue36878

   (18) https://bugs.python.org/issue2180

   (19) https://bugs.python.org/issue36907

   (20) https://bugs.python.org/issue36946

   (21) https://bugs.python.org/issue36826

   (22) https://bugs.python.org/issue1875

   (23) https://bugs.python.org/issue36027

   (24) https://bugs.python.org/issue36861

   (25) https://bugs.python.org/issue28866

   (26) https://bugs.python.org/issue36851

   (27) https://bugs.python.org/issue34616

   (28) https://bugs.python.org/issue36842

   (29) https://bugs.python.org/issue27639

   (30) https://bugs.python.org/issue36737

   (31) https://bugs.python.org/issue36793

   (32) https://bugs.python.org/issue36817

   (33) https://bugs.python.org/issue24048

   (34) https://bugs.python.org/issue27987

   (35) https://bugs.python.org/issue36601

   (36) https://bugs.python.org/issue36594

   (37) https://bugs.python.org/issue36045

   (38) https://bugs.python.org/issue36084

   (39) https://bugs.python.org/issue36035

   (40) https://bugs.python.org/issue35983

   (41) https://bugs.python.org/issue20602

   (42) https://bugs.python.org/issue26826

   (43) https://bugs.python.org/issue32388

   (44) https://bugs.python.org/issue31862


File: python.info,  Node: Library<8>,  Next: Documentation<8>,  Prev: Core and Builtins<8>,  Up: Python 3 8 0 beta 1

1.18.8.3 Library
................

   - bpo-37128(1): Added *note math.perm(): 1e4.

   - bpo-37120(2): Add SSLContext.num_tickets to control the number of
     TLSv1.3 session tickets.

   - bpo-12202(3): Fix the error handling in *note
     msilib.SummaryInformation.GetProperty(): ef5.  Patch by Zackery
     Spytz.

   - bpo-26835(4): The fcntl module now contains file sealing constants
     for sealing of memfds.

   - bpo-29262(5): Add ‘get_origin()’ and ‘get_args()’ introspection
     helpers to ‘typing’ module.

   - bpo-12639(6): *note msilib.Directory.start_component(): ef6. no
     longer fails if `keyfile' is not ‘None’.

   - bpo-36999(7): Add the ‘asyncio.Task.get_coro()’ method to publicly
     expose the tasks’s coroutine object.

   - bpo-35246(8): Make *note asyncio.create_subprocess_exec(): 28f.
     accept path-like arguments.

   - bpo-35279(9): Change default `max_workers' of ‘ThreadPoolExecutor’
     from ‘cpu_count() * 5’ to ‘min(32, cpu_count() + 4))’.  Previous
     value was unreasonably large on many cores machines.

   - bpo-37076(10): *note _thread.start_new_thread(): ef7. now logs
     uncaught exception raised by the function using *note
     sys.unraisablehook(): 22b, rather than *note sys.excepthook(): e57,
     so the hook gets access to the function which raised the exception.

   - bpo-33725(11): On macOS, the *note multiprocessing: b7. module now
     uses `spawn' start method by default.

   - bpo-37054(12): Fix destructor ‘_pyio.BytesIO’ and
     ‘_pyio.TextIOWrapper’: initialize their ‘_buffer’ attribute as soon
     as possible (in the class body), because it’s used by ‘__del__()’
     which calls ‘close()’.

   - bpo-37058(13): PEP 544: Add ‘Protocol’ and ‘@runtime_checkable’ to
     the ‘typing’ module.

   - bpo-36933(14): The functions ‘sys.set_coroutine_wrapper’ and
     ‘sys.get_coroutine_wrapper’ that were deprecated and marked for
     removal in 3.8 have been removed.

   - bpo-37047(15): Handle late binding and attribute access in *note
     unittest.mock.AsyncMock: 246. setup for autospeccing.  Document
     newly implemented async methods in *note unittest.mock.MagicMock:
     779.

   - bpo-37049(16): PEP 589: Add ‘TypedDict’ to the ‘typing’ module.

   - bpo-37046(17): PEP 586: Add ‘Literal’ to the ‘typing’ module.

   - bpo-37045(18): PEP 591: Add ‘Final’ qualifier and ‘@final’
     decorator to the ‘typing’ module.

   - bpo-37035(19): Don’t log OSError based exceptions if a fatal error
     has occurred in asyncio transport.  Peer can generate almost any
     OSError, user cannot avoid these exceptions by fixing own code.
     Errors are still propagated to user code, it’s just logging them is
     pointless and pollute asyncio logs.

   - bpo-37001(20): *note symtable.symtable(): ef8. now accepts the same
     input types for source code as the built-in *note compile(): 1b2.
     function.  Patch by Dino Viehland.

   - bpo-37028(21): Implement asyncio REPL

   - bpo-37027(22): Return safe to use proxy socket object from
     transport.get_extra_info(‘socket’)

   - bpo-32528(23): Make asyncio.CancelledError a BaseException.

     This will address the common mistake many asyncio users make: an
     “except Exception” clause breaking Tasks cancellation.

     In addition to this change, we stop inheriting asyncio.TimeoutError
     and asyncio.InvalidStateError from their concurrent.futures.*
     counterparts.  There’s no point for these exceptions to share the
     inheritance chain.

   - bpo-1230540(24): Add a new *note threading.excepthook(): 22f.
     function which handles uncaught *note threading.Thread.run(): 230.
     exception.  It can be overridden to control how uncaught *note
     threading.Thread.run(): 230. exceptions are handled.

   - bpo-36996(25): Handle *note unittest.mock.patch(): 77c. used as a
     decorator on async functions.

   - bpo-37008(26): Add support for calling *note next(): 676. with the
     mock resulting from *note unittest.mock.mock_open(): ef9.

   - bpo-27737(27): Allow whitespace only header encoding in
     ‘email.header’ - by Batuhan Taskaya

   - bpo-36969(28): PDB command ‘args’ now display positional only
     arguments.  Patch contributed by Rémi Lapeyre.

   - bpo-36969(29): PDB command ‘args’ now display keyword only
     arguments.  Patch contributed by Rémi Lapeyre.

   - bpo-36983(30): Add missing names to ‘typing.__all__’: ‘ChainMap’,
     ‘ForwardRef’, ‘OrderedDict’ - by Anthony Sottile.

   - bpo-36972(31): Add SupportsIndex protocol to the typing module to
     allow type checking to detect classes that can be passed to *note
     hex(): c59, *note oct(): c58. and *note bin(): c33.

   - bpo-32972(32): Implement ‘unittest.IsolatedAsyncioTestCase’ to help
     testing asyncio-based code.

   - bpo-36952(33): *note fileinput.input(): 2ab. and *note
     fileinput.FileInput: 27d. `bufsize' argument has been removed (was
     deprecated and ignored since Python 3.6), and as a result the
     `mode' and `openhook' arguments have been made keyword-only.

   - bpo-36952(34): Starting with Python 3.3, importing ABCs from *note
     collections: 1e. is deprecated, and import should be done from
     *note collections.abc: 1f.  Still being able to import from *note
     collections: 1e. was marked for removal in 3.8, but has been
     delayed to 3.9; documentation and ‘DeprecationWarning’ clarified.

   - bpo-36949(35): Implement __repr__ for WeakSet objects.

   - bpo-36948(36): Fix *note NameError: d6e. in *note
     urllib.request.URLopener.retrieve(): efa.  Patch by Karthikeyan
     Singaravelan.

   - bpo-33524(37): Fix the folding of email header when the
     max_line_length is 0 or None and the header contains non-ascii
     characters.  Contributed by Licht Takeuchi (@Licht-T).

   - bpo-24564(38): *note shutil.copystat(): a6c. now ignores *note
     errno.EINVAL: efb. on *note os.setxattr(): a43. which may occur
     when copying files on filesystems without extended attributes
     support.

     Original patch by Giampaolo Rodola, updated by Ying Wang.

   - bpo-36888(39): Python child processes can now access the status of
     their parent process using multiprocessing.process.parent_process

   - bpo-36921(40): Deprecate ‘@coroutine’ for sake of ‘async def’.

   - bpo-25652(41): Fix bug in ‘__rmod__’ of ‘UserString’ - by Batuhan
     Taskaya.

   - bpo-36916(42): Remove a message about an unhandled exception in a
     task when writer.write() is used without await and writer.drain()
     fails with an exception.

   - bpo-36889(43): Introduce ‘asyncio.Stream’ class that merges *note
     asyncio.StreamReader: efc. and *note asyncio.StreamWriter: efd.
     functionality.  ‘asyncio.Stream’ can work in readonly, writeonly
     and readwrite modes.  Provide ‘asyncio.connect()’,
     ‘asyncio.connect_unix()’, ‘asyncio.connect_read_pipe()’ and
     ‘asyncio.connect_write_pipe()’ factories to open ‘asyncio.Stream’
     connections.  Provide ‘asyncio.StreamServer’ and ‘UnixStreamServer’
     to serve servers with asyncio.Stream API. Modify *note
     asyncio.create_subprocess_shell(): 290. and *note
     asyncio.create_subprocess_exec(): 28f. to use ‘asyncio.Stream’
     instead of deprecated ‘StreamReader’ and ‘StreamWriter’.  Deprecate
     *note asyncio.StreamReader: efc. and *note asyncio.StreamWriter:
     efd.  Deprecate usage of private classes, e.g.
     ‘asyncio.FlowControlMixing’ and ‘asyncio.StreamReaderProtocol’
     outside of asyncio package.

   - bpo-36845(44): Added validation of integer prefixes to the
     construction of IP networks and interfaces in the ipaddress module.

   - bpo-23378(45): Add an extend action to argparser.

   - bpo-36867(46): Fix a bug making a SharedMemoryManager instance and
     its parent process use two separate resource_tracker processes.

   - bpo-23896(47): Adds a grammar to lib2to3.pygram that contains exec
     as a function not as statement.

   - bpo-36895(48): The function ‘time.clock()’ was deprecated in 3.3 in
     favor of ‘time.perf_counter()’ and marked for removal in 3.8, it
     has removed.

   - bpo-35545(49): Fix asyncio discarding IPv6 scopes when ensuring
     hostname resolutions internally

   - bpo-36887(50): Add new function *note math.isqrt(): 1e6. to compute
     integer square roots.

   - bpo-34632(51): Introduce the ‘importlib.metadata’ module with
     (provisional) support for reading metadata from third-party
     packages.

   - bpo-36878(52): When using ‘type_comments=True’ in *note ast.parse:
     1a0, treat ‘# type: ignore’ followed by a non-alphanumeric
     character and then arbitrary text as a type ignore, instead of
     requiring nothing but whitespace or another comment.  This is to
     permit formations such as ‘# type: ignore[E1000]’.

   - bpo-36778(53): ‘cp65001’ encoding (Windows code page 65001) becomes
     an alias to ‘utf_8’ encoding.

   - bpo-36867(54): The multiprocessing.resource_tracker replaces the
     multiprocessing.semaphore_tracker module.  Other than semaphores,
     resource_tracker also tracks shared_memory segments.

   - bpo-30262(55): The ‘Cache’ and ‘Statement’ objects of the *note
     sqlite3: f2. module are not exposed to the user.  Patch by Aviv
     Palivoda.

   - bpo-24538(56): In *note shutil.copystat(): a6c, first copy extended
     file attributes and then file permissions, since extended
     attributes can only be set on the destination while it is still
     writeable.

   - bpo-36829(57): Add new *note sys.unraisablehook(): 22b. function
     which can be overridden to control how “unraisable exceptions” are
     handled.  It is called when an exception has occurred but there is
     no way for Python to handle it.  For example, when a destructor
     raises an exception or during garbage collection (*note
     gc.collect(): 22c.).

   - bpo-36832(58): Introducing ‘zipfile.Path’, a pathlib-compatible
     wrapper for traversing zip files.

   - bpo-36814(59): Fix an issue where os.posix_spawnp() would
     incorrectly raise a TypeError when file_actions is None.

   - bpo-33110(60): Handle exceptions raised by functions added by
     concurrent.futures add_done_callback correctly when the Future has
     already completed.

   - bpo-26903(61): Limit ‘max_workers’ in ‘ProcessPoolExecutor’ to 61
     to work around a WaitForMultipleObjects limitation.

   - bpo-36813(62): Fix *note QueueListener: 706. to call
     ‘queue.task_done()’ upon stopping.  Patch by Bar Harel.

   - bpo-36806(63): Forbid creation of asyncio stream objects like
     StreamReader, StreamWriter, Process, and their protocols outside of
     asyncio package.

   - bpo-36802(64): Provide both sync and async calls for
     StreamWriter.write() and StreamWriter.close()

   - bpo-36801(65): Properly handle SSL connection closing in asyncio
     StreamWriter.drain() call.

   - bpo-36785(66): Implement PEP 574 (pickle protocol 5 with
     out-of-band buffers).

   - bpo-36772(67): functools.lru_cache() can now be used as a straight
     decorator in addition to its existing usage as a function that
     returns a decorator.

   - bpo-6584(68): Add a *note BadGzipFile: 1d0. exception to the *note
     gzip: 8c. module.

   - bpo-36748(69): Optimized write buffering in C implementation of
     ‘TextIOWrapper’.  Writing ASCII string to ‘TextIOWrapper’ with
     ascii, latin1, or utf-8 encoding is about 20% faster.  Patch by
     Inada Naoki.

   - bpo-8138(70): Don’t mark ‘wsgiref.simple_server.SimpleServer’ as
     multi-threaded since ‘wsgiref.simple_server.WSGIServer’ is
     single-threaded.

   - bpo-22640(71): *note py_compile.compile(): 213. now supports silent
     mode.  Patch by Joannah Nanjekye

   - bpo-29183(72): Fix double exceptions in *note
     wsgiref.handlers.BaseHandler: efe. by calling its ‘close()’ method
     only when no exception is raised.

   - bpo-36548(73): Improved the repr of regular expression flags.

   - bpo-36542(74): The signature of Python functions can now be
     overridden by specifying the ‘__text_signature__’ attribute.

   - bpo-36533(75): Reinitialize logging.Handler locks in forked child
     processes instead of attempting to acquire them all in the parent
     before forking only to be released in the child process.  The
     acquire/release pattern was leading to deadlocks in code that has
     implemented any form of chained logging handlers that depend upon
     one another as the lock acquisition order cannot be guaranteed.

   - bpo-35252(76): Throw a TypeError instead of an AssertionError when
     using an invalid type annotation with singledispatch.

   - bpo-35900(77): Allow reduction methods to return a 6-item tuple
     where the 6th item specifies a custom state-setting method that’s
     called instead of the regular ‘__setstate__’ method.

   - bpo-35900(78): enable custom reduction callback registration for
     functions and classes in _pickle.c, using the new Pickler’s
     attribute ‘reducer_override’

   - bpo-36368(79): Fix a bug crashing SharedMemoryManager instances in
     interactive sessions after a ctrl-c (KeyboardInterrupt) was sent

   - bpo-31904(80): Fix mmap fail for VxWorks

   - bpo-27497(81): *note csv.DictWriter.writeheader(): b6e. now returns
     the return value of the underlying ‘csv.Writer.writerow()’ method.
     Patch contributed by Ashish Nitin Patil.

   - bpo-36239(82): Parsing .mo files now ignores comments starting and
     ending with #-#-#-#-#.

   - bpo-26707(83): Enable plistlib to read and write binary plist files
     that were created as a KeyedArchive file.  Specifically, this
     allows the plistlib to process 0x80 tokens as UID objects.

   - bpo-31904(84): Add posix module support for VxWorks.

   - bpo-35125(85): Asyncio: Remove inner callback on outer cancellation
     in shield

   - bpo-35721(86): Fix ‘asyncio.SelectorEventLoop.subprocess_exec()’
     leaks file descriptors if ‘Popen’ fails and called with
     ‘stdin=subprocess.PIPE’.  Patch by Niklas Fiekas.

   - bpo-31855(87): *note unittest.mock.mock_open(): ef9. results now
     respects the argument of read([size]).  Patch contributed by Rémi
     Lapeyre.

   - bpo-35431(88): Implement *note math.comb(): 1e5. that returns
     binomial coefficient, that computes the number of ways to choose k
     items from n items without repetition and without order.  Patch by
     Yash Aggarwal and Keller Fuchs.

   - bpo-26660(89): Fixed permission errors in *note TemporaryDirectory:
     bbb. clean up.  Previously ‘TemporaryDirectory.cleanup()’ failed
     when non-writeable or non-searchable files or directories were
     created inside a temporary directory.

   - bpo-34271(90): Add debugging helpers to ssl module.  It’s now
     possible to dump key material and to trace TLS protocol.  The
     default and stdlib contexts also support SSLKEYLOGFILE env var.

   - bpo-26467(91): Added AsyncMock to support using unittest to mock
     asyncio coroutines.  Patch by Lisa Roach.

   - bpo-33569(92): dataclasses.InitVar: Exposes the type used to create
     the init var.

   - bpo-34424(93): Fix serialization of messages containing encoded
     strings when the policy.linesep is set to a multi-character string.
     Patch by Jens Troeger.

   - bpo-34303(94): Performance of *note functools.reduce(): c62. is
     slightly improved.  Patch by Sergey Fedoseev.

   - bpo-33361(95): Fix a bug in *note codecs.StreamRecoder: eff. where
     seeking might leave old data in a buffer and break subsequent read
     calls.  Patch by Ammar Askar.

   - bpo-22454(96): The *note shlex: e8. module now exposes *note
     shlex.join(): 215, the inverse of *note shlex.split(): 216.  Patch
     by Bo Bayles.

   - bpo-31922(97):
     ‘asyncio.AbstractEventLoop.create_datagram_endpoint()’: Do not
     connect UDP socket when broadcast is allowed.  This allows to
     receive replies after a UDP broadcast.

   - bpo-24882(98): Change ThreadPoolExecutor to use existing idle
     threads before spinning up new ones.

   - bpo-31961(99): Added support for bytes and path-like objects in
     *note subprocess.Popen(): 2b7. on Windows.  The `args' parameter
     now accepts a *note path-like object: 35f. if `shell' is ‘False’
     and a sequence containing bytes and path-like objects.  The
     `executable' parameter now accepts a bytes and *note path-like
     object: 35f.  The `cwd' parameter now accepts a bytes object.
     Based on patch by Anders Lorentsen.

   - bpo-33123(100): *note pathlib.Path.unlink: f00. now accepts a
     `missing_ok' parameter to avoid a *note FileNotFoundError: 7b4.
     from being raised.  Patch by Robert Buchholz.

   - bpo-32941(101): Allow *note mmap.mmap: 1ea. objects to access the
     madvise() system call (through *note mmap.mmap.madvise(): 1eb.).

   - bpo-22102(102): Added support for ZIP files with disks set to 0.
     Such files are commonly created by builtin tools on Windows when
     use ZIP64 extension.  Patch by Francisco Facioni.

   - bpo-32515(103): trace.py can now run modules via python3 -m trace
     -t –module module_name

   - bpo-32299(104): Changed *note unittest.mock.patch.dict(): f01. to
     return the patched dictionary when used as context manager.  Patch
     by Vadim Tsander.

   - bpo-27141(105): Added a ‘__copy__()’ to ‘collections.UserList’ and
     ‘collections.UserDict’ in order to correctly implement shallow
     copying of the objects.  Patch by Bar Harel.

   - bpo-31829(106): ‘\r’, ‘\0’ and ‘\x1a’ (end-of-file on Windows) are
     now escaped in protocol 0 pickles of Unicode strings.  This allows
     to load them without loss from files open in text mode in Python 2.

   - bpo-23395(107): ‘_thread.interrupt_main()’ now avoids setting the
     Python error status if the ‘SIGINT’ signal is ignored or not
     handled by Python.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37128

   (2) https://bugs.python.org/issue37120

   (3) https://bugs.python.org/issue12202

   (4) https://bugs.python.org/issue26835

   (5) https://bugs.python.org/issue29262

   (6) https://bugs.python.org/issue12639

   (7) https://bugs.python.org/issue36999

   (8) https://bugs.python.org/issue35246

   (9) https://bugs.python.org/issue35279

   (10) https://bugs.python.org/issue37076

   (11) https://bugs.python.org/issue33725

   (12) https://bugs.python.org/issue37054

   (13) https://bugs.python.org/issue37058

   (14) https://bugs.python.org/issue36933

   (15) https://bugs.python.org/issue37047

   (16) https://bugs.python.org/issue37049

   (17) https://bugs.python.org/issue37046

   (18) https://bugs.python.org/issue37045

   (19) https://bugs.python.org/issue37035

   (20) https://bugs.python.org/issue37001

   (21) https://bugs.python.org/issue37028

   (22) https://bugs.python.org/issue37027

   (23) https://bugs.python.org/issue32528

   (24) https://bugs.python.org/issue1230540

   (25) https://bugs.python.org/issue36996

   (26) https://bugs.python.org/issue37008

   (27) https://bugs.python.org/issue27737

   (28) https://bugs.python.org/issue36969

   (29) https://bugs.python.org/issue36969

   (30) https://bugs.python.org/issue36983

   (31) https://bugs.python.org/issue36972

   (32) https://bugs.python.org/issue32972

   (33) https://bugs.python.org/issue36952

   (34) https://bugs.python.org/issue36952

   (35) https://bugs.python.org/issue36949

   (36) https://bugs.python.org/issue36948

   (37) https://bugs.python.org/issue33524

   (38) https://bugs.python.org/issue24564

   (39) https://bugs.python.org/issue36888

   (40) https://bugs.python.org/issue36921

   (41) https://bugs.python.org/issue25652

   (42) https://bugs.python.org/issue36916

   (43) https://bugs.python.org/issue36889

   (44) https://bugs.python.org/issue36845

   (45) https://bugs.python.org/issue23378

   (46) https://bugs.python.org/issue36867

   (47) https://bugs.python.org/issue23896

   (48) https://bugs.python.org/issue36895

   (49) https://bugs.python.org/issue35545

   (50) https://bugs.python.org/issue36887

   (51) https://bugs.python.org/issue34632

   (52) https://bugs.python.org/issue36878

   (53) https://bugs.python.org/issue36778

   (54) https://bugs.python.org/issue36867

   (55) https://bugs.python.org/issue30262

   (56) https://bugs.python.org/issue24538

   (57) https://bugs.python.org/issue36829

   (58) https://bugs.python.org/issue36832

   (59) https://bugs.python.org/issue36814

   (60) https://bugs.python.org/issue33110

   (61) https://bugs.python.org/issue26903

   (62) https://bugs.python.org/issue36813

   (63) https://bugs.python.org/issue36806

   (64) https://bugs.python.org/issue36802

   (65) https://bugs.python.org/issue36801

   (66) https://bugs.python.org/issue36785

   (67) https://bugs.python.org/issue36772

   (68) https://bugs.python.org/issue6584

   (69) https://bugs.python.org/issue36748

   (70) https://bugs.python.org/issue8138

   (71) https://bugs.python.org/issue22640

   (72) https://bugs.python.org/issue29183

   (73) https://bugs.python.org/issue36548

   (74) https://bugs.python.org/issue36542

   (75) https://bugs.python.org/issue36533

   (76) https://bugs.python.org/issue35252

   (77) https://bugs.python.org/issue35900

   (78) https://bugs.python.org/issue35900

   (79) https://bugs.python.org/issue36368

   (80) https://bugs.python.org/issue31904

   (81) https://bugs.python.org/issue27497

   (82) https://bugs.python.org/issue36239

   (83) https://bugs.python.org/issue26707

   (84) https://bugs.python.org/issue31904

   (85) https://bugs.python.org/issue35125

   (86) https://bugs.python.org/issue35721

   (87) https://bugs.python.org/issue31855

   (88) https://bugs.python.org/issue35431

   (89) https://bugs.python.org/issue26660

   (90) https://bugs.python.org/issue34271

   (91) https://bugs.python.org/issue26467

   (92) https://bugs.python.org/issue33569

   (93) https://bugs.python.org/issue34424

   (94) https://bugs.python.org/issue34303

   (95) https://bugs.python.org/issue33361

   (96) https://bugs.python.org/issue22454

   (97) https://bugs.python.org/issue31922

   (98) https://bugs.python.org/issue24882

   (99) https://bugs.python.org/issue31961

   (100) https://bugs.python.org/issue33123

   (101) https://bugs.python.org/issue32941

   (102) https://bugs.python.org/issue22102

   (103) https://bugs.python.org/issue32515

   (104) https://bugs.python.org/issue32299

   (105) https://bugs.python.org/issue27141

   (106) https://bugs.python.org/issue31829

   (107) https://bugs.python.org/issue23395


File: python.info,  Node: Documentation<8>,  Next: Tests<8>,  Prev: Library<8>,  Up: Python 3 8 0 beta 1

1.18.8.4 Documentation
......................

   - bpo-36896(1): Clarify that some types have unstable constructor
     signature between Python versions.

   - bpo-36686(2): Improve documentation of the stdin, stdout, and
     stderr arguments of of the ‘asyncio.subprocess_exec’ function to
     specify which values are supported.  Also mention that decoding as
     text is not supported.

     Add a few tests to verify that the various values passed to the
     std* arguments actually work.

   - bpo-36984(3): Improve version added references in ‘typing’ module -
     by Anthony Sottile.

   - bpo-36868(4): What’s new now mentions
     SSLContext.hostname_checks_common_name instead of
     SSLContext.host_flags.

   - bpo-35924(5): Add a note to the ‘curses.addstr()’ documentation to
     warn that multiline strings can cause segfaults because of an
     ncurses bug.

   - bpo-36783(6): Added C API Documentation for Time_FromTimeAndFold
     and PyDateTime_FromDateAndTimeAndFold as per PEP 495.  Patch by
     Edison Abahurire.

   - bpo-36797(7): More of the legacy distutils documentation has been
     either pruned, or else more clearly marked as being retained solely
     until the setuptools documentation covers it independently.

   - bpo-22865(8): Add detail to the documentation on the *note
     pty.spawn: 88c. function.

   - bpo-35397(9): Remove deprecation and document
     urllib.parse.unwrap().  Patch contributed by Rémi Lapeyre.

   - bpo-32995(10): Added the context variable in glossary.

   - bpo-33519(11): Clarify that *note copy(): 26. is not part of the
     ‘MutableSequence’ ABC.

   - bpo-33482(12): Make ‘codecs.StreamRecoder.writelines’ take a list
     of bytes.

   - bpo-25735(13): Added documentation for func factorial to indicate
     that returns integer values

   - bpo-20285(14): Expand object.__doc__ (docstring) to make it
     clearer.  Modify pydoc.py so that help(object) lists object methods
     (for other classes, help omits methods of the object base class.)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36896

   (2) https://bugs.python.org/issue36686

   (3) https://bugs.python.org/issue36984

   (4) https://bugs.python.org/issue36868

   (5) https://bugs.python.org/issue35924

   (6) https://bugs.python.org/issue36783

   (7) https://bugs.python.org/issue36797

   (8) https://bugs.python.org/issue22865

   (9) https://bugs.python.org/issue35397

   (10) https://bugs.python.org/issue32995

   (11) https://bugs.python.org/issue33519

   (12) https://bugs.python.org/issue33482

   (13) https://bugs.python.org/issue25735

   (14) https://bugs.python.org/issue20285


File: python.info,  Node: Tests<8>,  Next: Build<6>,  Prev: Documentation<8>,  Up: Python 3 8 0 beta 1

1.18.8.5 Tests
..............

   - bpo-37069(1): Modify test_coroutines, test_cprofile,
     test_generators, test_raise, test_ssl and test_yield_from to use
     *note test.support.catch_unraisable_exception(): ee3. rather than
     *note test.support.captured_stderr(): f04.

   - bpo-37098(2): Fix test_memfd_create on older Linux Kernels.

   - bpo-37081(3): Test with OpenSSL 1.1.1c

   - bpo-36829(4): Add *note test.support.catch_unraisable_exception():
     ee3.: context manager catching unraisable exception using *note
     sys.unraisablehook(): 22b.

   - bpo-36915(5): The main regrtest process now always removes all
     temporary directories of worker processes even if they crash or if
     they are killed on KeyboardInterrupt (CTRL+c).

   - bpo-36719(6): “python3 -m test -jN …” now continues the execution
     of next tests when a worker process crash (CHILD_ERROR state).
     Previously, the test suite stopped immediately.  Use –failfast to
     stop at the first error.

   - bpo-36816(7): Update Lib/test/selfsigned_pythontestdotnet.pem to
     match self-signed.pythontest.net’s new TLS certificate.

   - bpo-35925(8): Skip httplib and nntplib networking tests when they
     would otherwise fail due to a modern OS or distro with a default
     OpenSSL policy of rejecting connections to servers with weak
     certificates.

   - bpo-36782(9): Add tests for several C API functions in the *note
     datetime: 31. module.  Patch by Edison Abahurire.

   - bpo-36342(10): Fix test_multiprocessing in test_venv if platform
     lacks functioning sem_open.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37069

   (2) https://bugs.python.org/issue37098

   (3) https://bugs.python.org/issue37081

   (4) https://bugs.python.org/issue36829

   (5) https://bugs.python.org/issue36915

   (6) https://bugs.python.org/issue36719

   (7) https://bugs.python.org/issue36816

   (8) https://bugs.python.org/issue35925

   (9) https://bugs.python.org/issue36782

   (10) https://bugs.python.org/issue36342


File: python.info,  Node: Build<6>,  Next: Windows<8>,  Prev: Tests<8>,  Up: Python 3 8 0 beta 1

1.18.8.6 Build
..............

   - bpo-36721(1): To embed Python into an application, a new ‘--embed’
     option must be passed to ‘python3-config --libs --embed’ to get
     ‘-lpython3.8’ (link the application to libpython).  To support both
     3.8 and older, try ‘python3-config --libs --embed’ first and
     fallback to ‘python3-config --libs’ (without ‘--embed’) if the
     previous command fails.

     Add a pkg-config ‘python-3.8-embed’ module to embed Python into an
     application: ‘pkg-config python-3.8-embed --libs’ includes
     ‘-lpython3.8’.  To support both 3.8 and older, try ‘pkg-config
     python-X.Y-embed --libs’ first and fallback to ‘pkg-config
     python-X.Y --libs’ (without ‘--embed’) if the previous command
     fails (replace ‘X.Y’ with the Python version).

     On the other hand, ‘pkg-config python3.8 --libs’ no longer contains
     ‘-lpython3.8’.  C extensions must not be linked to libpython
     (except on Android, case handled by the script); this change is
     backward incompatible on purpose.

   - bpo-36786(2): “make install” now runs compileall in parallel.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36721

   (2) https://bugs.python.org/issue36786


File: python.info,  Node: Windows<8>,  Next: macOS<6>,  Prev: Build<6>,  Up: Python 3 8 0 beta 1

1.18.8.7 Windows
................

   - bpo-36965(1): include of STATUS_CONTROL_C_EXIT without depending on
     MSC compiler

   - bpo-35926(2): Update to OpenSSL 1.1.1b for Windows.

   - bpo-29883(3): Add Windows support for UDP transports for the
     Proactor Event Loop.  Patch by Adam Meily.

   - bpo-33407(4): The ‘Py_DEPRECATED()’ macro has been implemented for
     MSVC.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36965

   (2) https://bugs.python.org/issue35926

   (3) https://bugs.python.org/issue29883

   (4) https://bugs.python.org/issue33407


File: python.info,  Node: macOS<6>,  Next: IDLE<10>,  Prev: Windows<8>,  Up: Python 3 8 0 beta 1

1.18.8.8 macOS
..............

   - bpo-36231(1): Support building Python on macOS without /usr/include
     installed.  As of macOS 10.14, system header files are only
     available within an SDK provided by either the Command Line Tools
     or the Xcode app.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36231


File: python.info,  Node: IDLE<10>,  Next: Tools/Demos<5>,  Prev: macOS<6>,  Up: Python 3 8 0 beta 1

1.18.8.9 IDLE
.............

   - bpo-35610(1): Replace now redundant .context_use_ps1 with
     .prompt_last_line.  This finishes change started in bpo-31858(2).

   - bpo-37038(3): Make idlelib.run runnable; add test clause.

   - bpo-36958(4): Print any argument other than None or int passed to
     SystemExit or sys.exit().

   - bpo-36807(5): When saving a file, call os.fsync() so bits are
     flushed to e.g.  USB drive.

   - bpo-32411(6): In browser.py, remove extraneous sorting by line
     number since dictionary was created in line number order.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35610

   (2) https://bugs.python.org/issue31858

   (3) https://bugs.python.org/issue37038

   (4) https://bugs.python.org/issue36958

   (5) https://bugs.python.org/issue36807

   (6) https://bugs.python.org/issue32411


File: python.info,  Node: Tools/Demos<5>,  Next: C API<6>,  Prev: IDLE<10>,  Up: Python 3 8 0 beta 1

1.18.8.10 Tools/Demos
.....................

   - bpo-37053(1): Handle strings like u”bar” correctly in
     Tools/parser/unparse.py.  Patch by Chih-Hsuan Yen.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue37053


File: python.info,  Node: C API<6>,  Prev: Tools/Demos<5>,  Up: Python 3 8 0 beta 1

1.18.8.11 C API
...............

   - bpo-36763(1): Implement the PEP 587(2) “Python Initialization
     Configuration”.

   - bpo-36379(3): Fix crashes when attempting to use the `modulo'
     parameter when ‘__ipow__’ is implemented in C.

   - bpo-37107(4): Update *note PyObject_CallMethodObjArgs(): f0b. and
     ‘_PyObject_CallMethodIdObjArgs’ to use ‘_PyObject_GetMethod’ to
     avoid creating a bound method object in many cases.  Patch by
     Michael J. Sullivan.

   - bpo-36974(5): Implement PEP 590(6): Vectorcall: a fast calling
     protocol for CPython.  This is a new protocol to optimize calls of
     custom callable objects.

   - bpo-36763(7): ‘Py_Main()’ now returns the exitcode rather than
     calling ‘Py_Exit(exitcode)’ when calling ‘PyErr_Print()’ if the
     current exception type is ‘SystemExit’.

   - bpo-36922(8): Add new type flag ‘Py_TPFLAGS_METHOD_DESCRIPTOR’ for
     objects behaving like unbound methods.  These are objects
     supporting the optimization given by the
     ‘LOAD_METHOD’/‘CALL_METHOD’ opcodes.  See PEP 590.

   - bpo-36728(9): The ‘PyEval_ReInitThreads()’ function has been
     removed from the C API. It should not be called explicitly: use
     *note PyOS_AfterFork_Child(): 2cb. instead.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36763

   (2) https://www.python.org/dev/peps/pep-0587

   (3) https://bugs.python.org/issue36379

   (4) https://bugs.python.org/issue37107

   (5) https://bugs.python.org/issue36974

   (6) https://www.python.org/dev/peps/pep-0590

   (7) https://bugs.python.org/issue36763

   (8) https://bugs.python.org/issue36922

   (9) https://bugs.python.org/issue36728


File: python.info,  Node: Python 3 8 0 alpha 4,  Next: Python 3 8 0 alpha 3,  Prev: Python 3 8 0 beta 1,  Up: Changelog

1.18.9 Python 3.8.0 alpha 4
---------------------------

`Release date: 2019-05-06'

* Menu:

* Security: Security<7>.
* Core and Builtins: Core and Builtins<9>.
* Library: Library<9>.
* Documentation: Documentation<9>.
* Tests: Tests<9>.
* Build: Build<7>.
* Windows: Windows<9>.
* macOS: macOS<7>.
* IDLE: IDLE<11>.
* Tools/Demos: Tools/Demos<6>.
* C API: C API<7>.


File: python.info,  Node: Security<7>,  Next: Core and Builtins<9>,  Up: Python 3 8 0 alpha 4

1.18.9.1 Security
.................

   - bpo-36742(1): Fixes mishandling of pre-normalization characters in
     urlsplit().

   - bpo-30458(2): Address CVE-2019-9740 by disallowing URL paths with
     embedded whitespace or control characters through into the
     underlying http client request.  Such potentially malicious header
     injection URLs now cause an http.client.InvalidURL exception to be
     raised.

   - bpo-35755(3): *note shutil.which(): f0e. now uses
     ‘os.confstr("CS_PATH")’ if available and if the ‘PATH’ environment
     variable is not set.  Remove also the current directory from
     ‘posixpath.defpath’.  On Unix, *note shutil.which(): f0e. and the
     *note subprocess: f9. module no longer search the executable in the
     current directory if the ‘PATH’ environment variable is not set.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36742

   (2) https://bugs.python.org/issue30458

   (3) https://bugs.python.org/issue35755


File: python.info,  Node: Core and Builtins<9>,  Next: Library<9>,  Prev: Security<7>,  Up: Python 3 8 0 alpha 4

1.18.9.2 Core and Builtins
..........................

   - bpo-36722(1): In debug build, import now also looks for C
     extensions compiled in release mode and for C extensions compiled
     in the stable ABI.

   - bpo-32849(2): Fix Python Initialization code on FreeBSD to detect
     properly when stdin file descriptor (fd 0) is invalid.

   - bpo-36623(3): Remove parser headers and related function
     declarations that lack implementations after the removal of pgen.

   - bpo-20180(4): ‘dict.pop()’ is now up to 33% faster thanks to
     Argument Clinic.  Patch by Inada Naoki.

   - bpo-36611(5): Debug memory allocators: disable serialno field by
     default from debug hooks on Python memory allocators to reduce the
     memory footprint by 5%.  Enable *note tracemalloc: 114. to get the
     traceback where a memory block has been allocated when a fatal
     memory error is logged to decide where to put a breakpoint.
     Compile Python with ‘PYMEM_DEBUG_SERIALNO’ defined to get back the
     field.

   - bpo-36588(6): On AIX, *note sys.platform: 2af. doesn’t contain the
     major version anymore.  Always return ‘'aix'’, instead of ‘'aix3'’
     ..  ‘'aix7'’.  Since older Python versions include the version
     number, it is recommended to always use
     ‘sys.platform.startswith('aix')’.  Contributed by M. Felt.

   - bpo-36549(7): Change str.capitalize to use titlecase for the first
     character instead of uppercase.

   - bpo-36540(8): Implement PEP 570(9) (Python positional-only
     parameters).  Patch by Pablo Galindo.

   - bpo-36475(10): *note PyEval_AcquireLock(): 2b0. and *note
     PyEval_AcquireThread(): 2b1. now terminate the current thread if
     called while the interpreter is finalizing, making them consistent
     with *note PyEval_RestoreThread(): 2b2, *note
     Py_END_ALLOW_THREADS(): 2b3, and *note PyGILState_Ensure(): 2b4.

   - bpo-36504(11): Fix signed integer overflow in _ctypes.c’s
     ‘PyCArrayType_new()’.

   - bpo-20844(12): Fix running script with encoding cookie and LF line
     ending may fail on Windows.

   - bpo-24214(13): Fixed support of the surrogatepass error handler in
     the UTF-8 incremental decoder.

   - bpo-36452(14): Changing ‘dict’ keys during iteration of the dict
     itself, ‘keys()’, ‘values()’, or ‘items()’ will now be detected in
     certain corner cases where keys are deleted/added so that the
     number of keys isn’t changed.  A *note RuntimeError: 2b8. will be
     raised after ‘len(dict)’ iterations.  Contributed by Thomas Perl.

   - bpo-36459(15): Fix a possible double ‘PyMem_FREE()’ due to
     tokenizer.c’s ‘tok_nextc()’.

   - bpo-36433(16): Fixed TypeError message in classmethoddescr_call.

   - bpo-36430(17): Fix a possible reference leak in *note
     itertools.count(): c0e.

   - bpo-36440(18): Include node names in ‘ParserError’ messages,
     instead of numeric IDs.  Patch by A. Skrobov.

   - bpo-36143(19): Regenerate *note keyword: a6. from the Grammar and
     Tokens file using pgen.  Patch by Pablo Galindo.

   - bpo-18372(20): Add missing *note PyObject_GC_Track(): e37. calls in
     the *note pickle: ca. module.  Patch by Zackery Spytz.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36722

   (2) https://bugs.python.org/issue32849

   (3) https://bugs.python.org/issue36623

   (4) https://bugs.python.org/issue20180

   (5) https://bugs.python.org/issue36611

   (6) https://bugs.python.org/issue36588

   (7) https://bugs.python.org/issue36549

   (8) https://bugs.python.org/issue36540

   (9) https://www.python.org/dev/peps/pep-0570

   (10) https://bugs.python.org/issue36475

   (11) https://bugs.python.org/issue36504

   (12) https://bugs.python.org/issue20844

   (13) https://bugs.python.org/issue24214

   (14) https://bugs.python.org/issue36452

   (15) https://bugs.python.org/issue36459

   (16) https://bugs.python.org/issue36433

   (17) https://bugs.python.org/issue36430

   (18) https://bugs.python.org/issue36440

   (19) https://bugs.python.org/issue36143

   (20) https://bugs.python.org/issue18372


File: python.info,  Node: Library<9>,  Next: Documentation<9>,  Prev: Core and Builtins<9>,  Up: Python 3 8 0 alpha 4

1.18.9.3 Library
................

   - bpo-35952(1): Fix pythoninfo when the compiler is missing.

   - bpo-28238(2): The ‘.find*()’ methods of xml.etree.ElementTree can
     now search for wildcards like ‘{*}tag’ and ‘{ns}*’ that match a tag
     in any namespace or all tags in a namespace.  Patch by Stefan
     Behnel.

   - bpo-26978(3): ‘pathlib.path.link_to()’ is now implemented.  It
     creates a hard link pointing to a path.

   - bpo-1613500(4): *note fileinput.FileInput: 27d. now uses the input
     file mode to correctly set the output file mode (previously it was
     hardcoded to ‘'w'’) when ‘inplace=True’ is passed to its
     constructor.

   - bpo-36734(5): Fix compilation of ‘faulthandler.c’ on HP-UX.
     Initialize ‘stack_t current_stack’ to zero using ‘memset()’.

   - bpo-13611(6): The xml.etree.ElementTree packages gained support for
     C14N 2.0 serialisation.  Patch by Stefan Behnel.

   - bpo-36669(7): Add missing matrix multiplication operator support to
     weakref.proxy.

   - bpo-36676(8): The XMLParser() in xml.etree.ElementTree provides
     namespace prefix context to the parser target if it defines the
     callback methods “start_ns()” and/or “end_ns()”.  Patch by Stefan
     Behnel.

   - bpo-36673(9): The TreeBuilder and XMLPullParser in
     xml.etree.ElementTree gained support for parsing comments and
     processing instructions.  Patch by Stefan Behnel.

   - bpo-36650(10): The C version of functools.lru_cache() was treating
     calls with an empty ‘**kwargs’ dictionary as being distinct from
     calls with no keywords at all.  This did not result in an incorrect
     answer, but it did trigger an unexpected cache miss.

   - bpo-28552(11): Fix *note distutils.sysconfig: 62. if *note
     sys.executable: 272. is ‘None’ or an empty string: use *note
     os.getcwd(): f11. to initialize ‘project_base’.  Fix also the
     distutils build command: don’t use *note sys.executable: 272. if it
     is ‘None’ or an empty string.

   - bpo-35755(12): *note shutil.which(): f0e. and
     ‘distutils.spawn.find_executable()’ now use ‘os.confstr("CS_PATH")’
     if available instead of *note os.defpath: f12, if the ‘PATH’
     environment variable is not set.  Moreover, don’t use
     ‘os.confstr("CS_PATH")’ nor *note os.defpath: f12. if the ‘PATH’
     environment variable is set to an empty string.

   - bpo-25430(13): improve performance of ‘IPNetwork.__contains__()’

   - bpo-30485(14): Path expressions in xml.etree.ElementTree can now
     avoid explicit namespace prefixes for tags (or the “{namespace}tag”
     notation) by passing a default namespace with an empty string
     prefix.

   - bpo-36613(15): Fix *note asyncio: a. wait() not removing callback
     if exception

   - bpo-36598(16): Fix ‘isinstance’ check for Mock objects with spec
     when the code is executed under tracing.  Patch by Karthikeyan
     Singaravelan.

   - bpo-18748(17): In development mode (*note -X: 155. ‘dev’) and in
     debug build, the *note io.IOBase: 1d9. destructor now logs
     ‘close()’ exceptions.  These exceptions are silent by default in
     release mode.

   - bpo-36575(18): The ‘_lsprof’ module now uses internal timer same to
     ‘time.perf_counter()’ by default.  ‘gettimeofday(2)’ was used on
     Unix.  New timer has better resolution on most Unix platforms and
     timings are no longer impacted by system clock updates since
     ‘perf_counter()’ is monotonic.  Patch by Inada Naoki.

   - bpo-33461(19): ‘json.loads’ now emits ‘DeprecationWarning’ when
     ‘encoding’ option is specified.  Patch by Matthias Bussonnier.

   - bpo-36559(20): The random module now prefers the lean internal
     _sha512 module over hashlib for seed(version=2) to optimize import
     time.

   - bpo-17561(21): Set backlog=None as the default for
     socket.create_server.

   - bpo-34373(22): Fix *note time.mktime(): b57. error handling on AIX
     for year before 1970.

   - bpo-36232(23): Improve error message when trying to open existing
     DBM database that actually doesn’t exist.  Patch by Marco Rougeth.

   - bpo-36546(24): Add statistics.quantiles()

   - bpo-36050(25): Optimized ‘http.client.HTTPResponse.read()’ for
     large response.  Patch by Inada Naoki.

   - bpo-36522(26): If `debuglevel' is set to >0 in *note http.client:
     94, print all values for headers with multiple values for the same
     header name.  Patch by Matt Houglum.

   - bpo-36492(27): Deprecated passing required arguments like `func' as
     keyword arguments in functions which should accept arbitrary
     keyword arguments and pass them to other function.  Arbitrary
     keyword arguments (even with names “self” and “func”) can now be
     passed to these functions if the required arguments are passed as
     positional arguments.

   - bpo-27181(28): Add statistics.geometric_mean().

   - bpo-30427(29): ‘os.path.normcase()’ relies on ‘os.fspath()’ to
     check the type of its argument.  Redundant checks have been removed
     from its ‘posixpath.normcase()’ and ‘ntpath.normcase()’
     implementations.  Patch by Wolfgang Maier.

   - bpo-36385(30): Stop rejecting IPv4 octets for being ambiguously
     octal.  Leading zeros are ignored, and no longer are assumed to
     specify octal octets.  Octets are always decimal numbers.  Octets
     must still be no more than three digits, including leading zeroes.

   - bpo-36434(31): Errors during writing to a ZIP file no longer
     prevent to properly close it.

   - bpo-36407(32): Fixed wrong indentation writing for CDATA section in
     xml.dom.minidom.  Patch by Vladimir Surjaninov.

   - bpo-36326(33): inspect.getdoc() can now find docstrings for member
     objects when __slots__ is a dictionary.

   - bpo-36366(34): Calling ‘stop()’ on an unstarted or stopped *note
     unittest.mock.patch(): 77c. object will now return *note None: 157.
     instead of raising *note RuntimeError: 2b8, making the method
     idempotent.  Patch by Karthikeyan Singaravelan.

   - bpo-36348(35): The ‘imap.IMAP4.logout()’ method no longer ignores
     silently arbitrary exceptions.

   - bpo-31904(36): Add time module support and fix test_time faiures
     for VxWorks.

   - bpo-36227(37): Added support for keyword arguments
     ‘default_namespace’ and ‘xml_declaration’ in functions
     ElementTree.tostring() and ElementTree.tostringlist().

   - bpo-36004(38): Added new alternate constructors *note
     datetime.date.fromisocalendar(): 1c2. and *note
     datetime.datetime.fromisocalendar(): 1c3, which construct date
     objects from ISO year, week number and weekday; these are the
     inverse of each class’s ‘isocalendar’ method.  Patch by Paul
     Ganssle.

   - bpo-35936(39): *note modulefinder: b4. no longer depends on the
     deprecated *note imp: 9a. module, and the initializer for *note
     modulefinder.ModuleFinder: f13. now has immutable default
     arguments.  Patch by Brandt Bucher.

   - bpo-35376(40): *note modulefinder: b4. correctly handles modules
     that have the same name as a bad package.  Patch by Brandt Bucher.

   - bpo-17396(41): *note modulefinder: b4. no longer crashes when
     encountering syntax errors in followed imports.  Patch by Brandt
     Bucher.

   - bpo-35934(42): Added *note create_server(): 21c. and *note
     has_dualstack_ipv6(): 21d. convenience functions to automate the
     necessary tasks usually involved when creating a server socket,
     including accepting both IPv4 and IPv6 connections on the same
     socket.  (Contributed by Giampaolo Rodola in bpo-17561(43).)

   - bpo-23078(44): Add support for *note classmethod(): 1d6. and *note
     staticmethod(): 1d7. to *note unittest.mock.create_autospec(): f14.
     Initial patch by Felipe Ochoa.

   - bpo-35416(45): Fix potential resource warnings in distutils.  Patch
     by Mickaël Schoentgen.

   - bpo-25451(46): Add transparency methods to ‘tkinter.PhotoImage’.
     Patch by Zackery Spytz.

   - bpo-35082(47): Don’t return deleted attributes when calling dir on
     a *note unittest.mock.Mock: 247.

   - bpo-34547(48): *note wsgiref.handlers.BaseHandler: efe. now handles
     abrupt client connection terminations gracefully.  Patch by Petter
     Strandmark.

   - bpo-31658(49): *note xml.sax.parse(): f15. now supports *note
     path-like: 35f.  Patch by Mickaël Schoentgen.

   - bpo-34139(50): Remove stale unix datagram socket before binding

   - bpo-33530(51): Implemented Happy Eyeballs in
     ‘asyncio.create_connection()’.  Added two new arguments,
     `happy_eyeballs_delay' and `interleave', to specify Happy Eyeballs
     behavior.

   - bpo-33291(52): Do not raise AttributeError when calling the inspect
     functions isgeneratorfunction, iscoroutinefunction,
     isasyncgenfunction on a method created from an arbitrary callable.
     Instead, return False.

   - bpo-31310(53): Fix the multiprocessing.semaphore_tracker so it is
     reused by child processes

   - bpo-31292(54): Fix ‘setup.py check --restructuredtext’ for files
     containing ‘include’ directives.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35952

   (2) https://bugs.python.org/issue28238

   (3) https://bugs.python.org/issue26978

   (4) https://bugs.python.org/issue1613500

   (5) https://bugs.python.org/issue36734

   (6) https://bugs.python.org/issue13611

   (7) https://bugs.python.org/issue36669

   (8) https://bugs.python.org/issue36676

   (9) https://bugs.python.org/issue36673

   (10) https://bugs.python.org/issue36650

   (11) https://bugs.python.org/issue28552

   (12) https://bugs.python.org/issue35755

   (13) https://bugs.python.org/issue25430

   (14) https://bugs.python.org/issue30485

   (15) https://bugs.python.org/issue36613

   (16) https://bugs.python.org/issue36598

   (17) https://bugs.python.org/issue18748

   (18) https://bugs.python.org/issue36575

   (19) https://bugs.python.org/issue33461

   (20) https://bugs.python.org/issue36559

   (21) https://bugs.python.org/issue17561

   (22) https://bugs.python.org/issue34373

   (23) https://bugs.python.org/issue36232

   (24) https://bugs.python.org/issue36546

   (25) https://bugs.python.org/issue36050

   (26) https://bugs.python.org/issue36522

   (27) https://bugs.python.org/issue36492

   (28) https://bugs.python.org/issue27181

   (29) https://bugs.python.org/issue30427

   (30) https://bugs.python.org/issue36385

   (31) https://bugs.python.org/issue36434

   (32) https://bugs.python.org/issue36407

   (33) https://bugs.python.org/issue36326

   (34) https://bugs.python.org/issue36366

   (35) https://bugs.python.org/issue36348

   (36) https://bugs.python.org/issue31904

   (37) https://bugs.python.org/issue36227

   (38) https://bugs.python.org/issue36004

   (39) https://bugs.python.org/issue35936

   (40) https://bugs.python.org/issue35376

   (41) https://bugs.python.org/issue17396

   (42) https://bugs.python.org/issue35934

   (43) https://bugs.python.org/issue17561

   (44) https://bugs.python.org/issue23078

   (45) https://bugs.python.org/issue35416

   (46) https://bugs.python.org/issue25451

   (47) https://bugs.python.org/issue35082

   (48) https://bugs.python.org/issue34547

   (49) https://bugs.python.org/issue31658

   (50) https://bugs.python.org/issue34139

   (51) https://bugs.python.org/issue33530

   (52) https://bugs.python.org/issue33291

   (53) https://bugs.python.org/issue31310

   (54) https://bugs.python.org/issue31292


File: python.info,  Node: Documentation<9>,  Next: Tests<9>,  Prev: Library<9>,  Up: Python 3 8 0 alpha 4

1.18.9.4 Documentation
......................

   - bpo-36625(1): Remove obsolete comments from docstrings in
     fractions.Fraction

   - bpo-30840(2): Document relative imports

   - bpo-36523(3): Add docstring for io.IOBase.writelines().

   - bpo-36425(4): New documentation translation: Simplified Chinese(5).

   - bpo-36345(6): Avoid the duplication of code from
     ‘Tools/scripts/serve.py’ in using the ‘literalinclude’ directive
     for the basic wsgiref-based web server in the documentation of
     *note wsgiref: 12c.  Contributed by Stéphane Wirtel.

   - bpo-36345(7): Using the code of the ‘Tools/scripts/serve.py’ script
     as an example in the *note wsgiref: 12c. documentation.
     Contributed by Stéphane Wirtel.

   - bpo-36157(8): Added Documention for PyInterpreterState_Main().

   - bpo-33043(9): Updates the docs.python.org page with the addition of
     a ‘Contributing to Docs’ link at the end of the page (between
     ‘Reporting Bugs’ and ‘About Documentation’).  Updates the ‘Found a
     Bug’ page with additional links and information in the
     Documentation Bugs section.

   - bpo-35581(10): @typing.type_check_only now allows type stubs to
     mark functions and classes not available during runtime.

   - bpo-33832(11): Add glossary entry for ‘magic method’.

   - bpo-32913(12): Added re.Match.groupdict example to regex HOWTO.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36625

   (2) https://bugs.python.org/issue30840

   (3) https://bugs.python.org/issue36523

   (4) https://bugs.python.org/issue36425

   (5) https://docs.python.org/zh-cn/

   (6) https://bugs.python.org/issue36345

   (7) https://bugs.python.org/issue36345

   (8) https://bugs.python.org/issue36157

   (9) https://bugs.python.org/issue33043

   (10) https://bugs.python.org/issue35581

   (11) https://bugs.python.org/issue33832

   (12) https://bugs.python.org/issue32913


File: python.info,  Node: Tests<9>,  Next: Build<7>,  Prev: Documentation<9>,  Up: Python 3 8 0 alpha 4

1.18.9.5 Tests
..............

   - bpo-36719(1): regrtest now always detects uncollectable objects.
     Previously, the check was only enabled by ‘--findleaks’.  The check
     now also works with ‘-jN/--multiprocess N’.  ‘--findleaks’ becomes
     a deprecated alias to ‘--fail-env-changed’.

   - bpo-36725(2): When using mulitprocessing mode (-jN), regrtest now
     better reports errors if a worker process fails, and it exits
     immediately on a worker thread failure or when interrupted.

   - bpo-36454(3): Change test_time.test_monotonic() to test only the
     lower bound of elapsed time after a sleep command rather than the
     upper bound.  This prevents unnecessary test failures on slow
     buildbots.  Patch by Victor Stinner.

   - bpo-32424(4): Improve test coverage for xml.etree.ElementTree.
     Patch by Gordon P. Hemsley.

   - bpo-32424(5): Fix typo in test_cyclic_gc() test for
     xml.etree.ElementTree.  Patch by Gordon P. Hemsley.

   - bpo-36635(6): Add a new ‘_testinternalcapi’ module to test the
     internal C API.

   - bpo-36629(7): Fix ‘test_imap4_host_default_value()’ of
     ‘test_imaplib’: catch also *note errno.ENETUNREACH: f18. error.

   - bpo-36611(8): Fix ‘test_sys.test_getallocatedblocks()’ when *note
     tracemalloc: 114. is enabled.

   - bpo-36560(9): Fix reference leak hunting in regrtest: compute also
     deltas (of reference count, allocated memory blocks, file
     descriptor count) during warmup, to ensure that everything is
     initialized before starting to hunt reference leaks.

   - bpo-36565(10): Fix reference hunting (‘python3 -m test -R 3:3’)
     when Python has no built-in abc module.

   - bpo-31904(11): Port test_resource to VxWorks: skip tests cases
     setting RLIMIT_FSIZE and RLIMIT_CPU.

   - bpo-31904(12): Fix test_tabnanny on VxWorks: adjust ENOENT error
     message.

   - bpo-36436(13): Fix ‘_testcapi.pymem_buffer_overflow()’: handle
     memory allocation failure.

   - bpo-31904(14): Fix test_utf8_mode on VxWorks: Python always use
     UTF-8 on VxWorks.

   - bpo-36341(15): Fix tests that may fail with PermissionError upon
     calling bind() on AF_UNIX sockets.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36719

   (2) https://bugs.python.org/issue36725

   (3) https://bugs.python.org/issue36454

   (4) https://bugs.python.org/issue32424

   (5) https://bugs.python.org/issue32424

   (6) https://bugs.python.org/issue36635

   (7) https://bugs.python.org/issue36629

   (8) https://bugs.python.org/issue36611

   (9) https://bugs.python.org/issue36560

   (10) https://bugs.python.org/issue36565

   (11) https://bugs.python.org/issue31904

   (12) https://bugs.python.org/issue31904

   (13) https://bugs.python.org/issue36436

   (14) https://bugs.python.org/issue31904

   (15) https://bugs.python.org/issue36341


File: python.info,  Node: Build<7>,  Next: Windows<9>,  Prev: Tests<9>,  Up: Python 3 8 0 alpha 4

1.18.9.6 Build
..............

   - bpo-36747(1): Remove the stale scriptsinstall Makefile target.

   - bpo-21536(2): On Unix, C extensions are no longer linked to
     libpython except on Android and Cygwin.

     It is now possible for a statically linked Python to load a C
     extension built using a shared library Python.

     When Python is embedded, ‘libpython’ must not be loaded with
     ‘RTLD_LOCAL’, but ‘RTLD_GLOBAL’ instead.  Previously, using
     ‘RTLD_LOCAL’, it was already not possible to load C extensions
     which were not linked to ‘libpython’, such as C extensions of the
     standard library built by the ‘*shared*’ section of
     ‘Modules/Setup’.

     distutils, python-config and python-config.py have been modified.

   - bpo-36707(3): ‘./configure --with-pymalloc’ no longer adds the ‘m’
     flag to SOABI (sys.implementation.cache_tag).  Enabling or
     disabling pymalloc has no impact on the ABI.

   - bpo-36635(4): Change ‘PyAPI_FUNC(type)’, ‘PyAPI_DATA(type)’ and
     ‘PyMODINIT_FUNC’ macros of ‘pyport.h’ when ‘Py_BUILD_CORE_MODULE’
     is defined.  The ‘Py_BUILD_CORE_MODULE’ define must be now be used
     to build a C extension as a dynamic library accessing Python
     internals: export the PyInit_xxx() function in DLL exports on
     Windows.

   - bpo-31904(5): Don’t build the ‘_crypt’ extension on VxWorks.

   - bpo-36618(6): Add ‘-fmax-type-align=8’ to CFLAGS when clang
     compiler is detected.  The pymalloc memory allocator aligns memory
     on 8 bytes.  On x86-64, clang expects alignment on 16 bytes by
     default and so uses MOVAPS instruction which can lead to
     segmentation fault.  Instruct clang that Python is limited to
     alignment on 8 bytes to use MOVUPS instruction instead: slower but
     don’t trigger a SIGSEGV if the memory is not aligned on 16 bytes.
     Sadly, the flag must be added to ‘CFLAGS’ and not just
     ‘CFLAGS_NODIST’, since third party C extensions can have the same
     issue.

   - bpo-36605(7): ‘make tags’ and ‘make TAGS’ now also parse
     ‘Modules/_io/*.c’ and ‘Modules/_io/*.h’.

   - bpo-36465(8): Release builds and debug builds are now ABI
     compatible: defining the ‘Py_DEBUG’ macro no longer implies the
     ‘Py_TRACE_REFS’ macro, which introduces the only ABI
     incompatibility.  The ‘Py_TRACE_REFS’ macro, which adds the
     ‘sys.getobjects()’ function and the *note PYTHONDUMPREFS: 159.
     environment variable, can be set using the new ‘./configure
     --with-trace-refs’ build option.

   - bpo-36577(9): setup.py now correctly reports missing OpenSSL
     headers and libraries again.

   - bpo-36544(10): Fix regression introduced in bpo-36146(11)
     refactoring setup.py

   - bpo-36508(12): ‘python-config --ldflags’ no longer includes flags
     of the ‘LINKFORSHARED’ variable.  The ‘LINKFORSHARED’ variable must
     only be used to build executables.

   - bpo-36503(13): Remove references to “aix3” and “aix4”.  Patch by M.
     Felt.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36747

   (2) https://bugs.python.org/issue21536

   (3) https://bugs.python.org/issue36707

   (4) https://bugs.python.org/issue36635

   (5) https://bugs.python.org/issue31904

   (6) https://bugs.python.org/issue36618

   (7) https://bugs.python.org/issue36605

   (8) https://bugs.python.org/issue36465

   (9) https://bugs.python.org/issue36577

   (10) https://bugs.python.org/issue36544

   (11) https://bugs.python.org/issue36146

   (12) https://bugs.python.org/issue36508

   (13) https://bugs.python.org/issue36503


File: python.info,  Node: Windows<9>,  Next: macOS<7>,  Prev: Build<7>,  Up: Python 3 8 0 alpha 4

1.18.9.7 Windows
................

   - bpo-35920(1): Added platform.win32_edition() and
     platform.win32_is_iot().  Added support for cross-compiling
     packages for Windows ARM32.  Skip tests that are not expected to
     work on Windows IoT Core ARM32.

   - bpo-36649(2): Remove trailing spaces for registry keys when
     installed via the Store.

   - bpo-34144(3): Fixed activate.bat to correctly update codepage when
     chcp.com returns dots in output.  Patch by Lorenz Mende.

   - bpo-36509(4): Added preset-iot layout for Windows IoT ARM
     containers.  This layout doesn’t contain UI components like tkinter
     or IDLE. It also doesn’t contain files to support on-target builds
     since Windows ARM32 builds must be cross-compiled when using MSVC.

   - bpo-35941(5): enum_certificates function of the ssl module now
     returns certificates from all available certificate stores inside
     windows in a query instead of returning only certificates from the
     system wide certificate store.  This includes certificates from
     these certificate stores: local machine, local machine enterprise,
     local machine group policy, current user, current user group
     policy, services, users.  ssl.enum_crls() function is changed in
     the same way to return all certificate revocation lists inside the
     windows certificate revocation list stores.

   - bpo-36441(6): Fixes creating a venv when debug binaries are
     installed.

   - bpo-36085(7): Enable better DLL resolution on Windows by using safe
     DLL search paths and adding *note os.add_dll_directory(): 1c0.

   - bpo-36010(8): Add the venv standard library module to the nuget
     distribution for Windows.

   - bpo-29515(9): Add the following socket module constants on Windows:
     IPPROTO_AH IPPROTO_CBT IPPROTO_DSTOPTS IPPROTO_EGP IPPROTO_ESP
     IPPROTO_FRAGMENT IPPROTO_GGP IPPROTO_HOPOPTS IPPROTO_ICLFXBM
     IPPROTO_ICMPV6 IPPROTO_IDP IPPROTO_IGMP IPPROTO_IGP IPPROTO_IPV4
     IPPROTO_IPV6 IPPROTO_L2TP IPPROTO_MAX IPPROTO_ND IPPROTO_NONE
     IPPROTO_PGM IPPROTO_PIM IPPROTO_PUP IPPROTO_RDP IPPROTO_ROUTING
     IPPROTO_SCTP IPPROTO_ST

   - bpo-35947(10): Added current version of libffi to
     cpython-source-deps.  Change _ctypes to use current version of
     libffi on Windows.

   - bpo-34060(11): Report system load when running test suite on
     Windows.  Patch by Ammar Askar.  Based on prior work by Jeremy
     Kloth.

   - bpo-31512(12): With the Windows 10 Creators Update, non-elevated
     users can now create symlinks as long as the computer has Developer
     Mode enabled.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35920

   (2) https://bugs.python.org/issue36649

   (3) https://bugs.python.org/issue34144

   (4) https://bugs.python.org/issue36509

   (5) https://bugs.python.org/issue35941

   (6) https://bugs.python.org/issue36441

   (7) https://bugs.python.org/issue36085

   (8) https://bugs.python.org/issue36010

   (9) https://bugs.python.org/issue29515

   (10) https://bugs.python.org/issue35947

   (11) https://bugs.python.org/issue34060

   (12) https://bugs.python.org/issue31512


File: python.info,  Node: macOS<7>,  Next: IDLE<11>,  Prev: Windows<9>,  Up: Python 3 8 0 alpha 4

1.18.9.8 macOS
..............

   - bpo-34602(1): Avoid failures setting macOS stack resource limit
     with resource.setrlimit.  This reverts an earlier fix for
     bpo-18075(2) which forced a non-default stack size when building
     the interpreter executable on macOS.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34602

   (2) https://bugs.python.org/issue18075


File: python.info,  Node: IDLE<11>,  Next: Tools/Demos<6>,  Prev: macOS<7>,  Up: Python 3 8 0 alpha 4

1.18.9.9 IDLE
.............

   - bpo-36429(1): Fix starting IDLE with pyshell.  Add idlelib.pyshell
     alias at top; remove pyshell alias at bottom.  Remove obsolete
     __name__==’__main__’ command.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36429


File: python.info,  Node: Tools/Demos<6>,  Next: C API<7>,  Prev: IDLE<11>,  Up: Python 3 8 0 alpha 4

1.18.9.10 Tools/Demos
.....................

   - bpo-14546(1): Fix the argument handling in Tools/scripts/lll.py.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14546


File: python.info,  Node: C API<7>,  Prev: Tools/Demos<6>,  Up: Python 3 8 0 alpha 4

1.18.9.11 C API
...............

   - bpo-36763(1): Fix memory leak in *note
     Py_SetStandardStreamEncoding(): 919.: release memory if the
     function is called twice.

   - bpo-36641(2): ‘PyDoc_VAR(name)’ and ‘PyDoc_STRVAR(name,str)’ now
     create ‘static const char name[]’ instead of ‘static char name[]’.
     Patch by Inada Naoki.

   - bpo-36389(3): Change the value of ‘CLEANBYTE’, ‘DEADDYTE’ and
     ‘FORBIDDENBYTE’ internal constants used by debug hooks on Python
     memory allocators (*note PyMem_SetupDebugHooks(): 4ff. function).
     Byte patterns ‘0xCB’, ‘0xDB’ and ‘0xFB’ have been replaced with
     ‘0xCD’, ‘0xDD’ and ‘0xFD’ to use the same values than Windows CRT
     debug ‘malloc()’ and ‘free()’.

   - bpo-36443(4): Since Python 3.7.0, calling *note Py_DecodeLocale():
     431. before *note Py_Initialize(): 42e. produces mojibake if the
     ‘LC_CTYPE’ locale is coerced and/or if the UTF-8 Mode is enabled by
     the user configuration.  The LC_CTYPE coercion and UTF-8 Mode are
     now disabled by default to fix the mojibake issue.  They must now
     be enabled explicitly (opt-in) using the new ‘_Py_PreInitialize()’
     API with ‘_PyPreConfig’.

   - bpo-36025(5): Fixed an accidental change to the datetime C API
     where the arguments to the *note PyDate_FromTimestamp(): f1f.
     function were incorrectly interpreted as a single timestamp rather
     than an arguments tuple, which causes existing code to start
     raising *note TypeError: 192.  The backwards-incompatible change
     was only present in alpha releases of Python 3.8.  Patch by Paul
     Ganssle.

   - bpo-35810(6): Modify ‘PyObject_Init’ to correctly increase the
     refcount of heap- allocated Type objects.  Also fix the refcounts
     of the heap-allocated types that were either doing this manually or
     not decreasing the type’s refcount in tp_dealloc

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36763

   (2) https://bugs.python.org/issue36641

   (3) https://bugs.python.org/issue36389

   (4) https://bugs.python.org/issue36443

   (5) https://bugs.python.org/issue36025

   (6) https://bugs.python.org/issue35810


File: python.info,  Node: Python 3 8 0 alpha 3,  Next: Python 3 8 0 alpha 2,  Prev: Python 3 8 0 alpha 4,  Up: Changelog

1.18.10 Python 3.8.0 alpha 3
----------------------------

`Release date: 2019-03-25'

* Menu:

* Security: Security<8>.
* Core and Builtins: Core and Builtins<10>.
* Library: Library<10>.
* Documentation: Documentation<10>.
* Tests: Tests<10>.
* Build: Build<8>.
* Windows: Windows<10>.
* IDLE: IDLE<12>.
* Tools/Demos: Tools/Demos<7>.
* C API: C API<8>.


File: python.info,  Node: Security<8>,  Next: Core and Builtins<10>,  Up: Python 3 8 0 alpha 3

1.18.10.1 Security
..................

   - bpo-36216(1): Changes urlsplit() to raise ValueError when the URL
     contains characters that decompose under IDNA encoding
     (NFKC-normalization) into characters that affect how the URL is
     parsed.

   - bpo-35121(2): Don’t send cookies of domain A without Domain
     attribute to domain B when domain A is a suffix match of domain B
     while using a cookiejar with *note
     http.cookiejar.DefaultCookiePolicy: f22. policy.  Patch by
     Karthikeyan Singaravelan.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36216

   (2) https://bugs.python.org/issue35121


File: python.info,  Node: Core and Builtins<10>,  Next: Library<10>,  Prev: Security<8>,  Up: Python 3 8 0 alpha 3

1.18.10.2 Core and Builtins
...........................

   - bpo-36421(1): Fix a possible double decref in _ctypes.c’s
     ‘PyCArrayType_new()’.

   - bpo-36412(2): Fix a possible crash when creating a new dictionary.

   - bpo-36398(3): Fix a possible crash in ‘structseq_repr()’.

   - bpo-36256(4): Fix bug in parsermodule when parsing a state in a DFA
     that has two or more arcs with labels of the same type.  Patch by
     Pablo Galindo.

   - bpo-36365(5): repr(structseq) is no longer limited to 512 bytes.

   - bpo-36374(6): Fix a possible null pointer dereference in
     ‘merge_consts_recursive()’.  Patch by Zackery Spytz.

   - bpo-36236(7): At Python initialization, the current directory is no
     longer prepended to *note sys.path: 47d. if it has been removed.

   - bpo-36352(8): Python initialization now fails with an error, rather
     than silently truncating paths, if a path is too long.

   - bpo-36301(9): Python initialization now fails if decoding
     ‘pybuilddir.txt’ configuration file fails at startup.

   - bpo-36333(10): Fix leak in _PyRuntimeState_Fini.  Contributed by
     Stéphane Wirtel.

   - bpo-36332(11): The builtin *note compile(): 1b2. can now handle AST
     objects that contain assignment expressions.  Patch by Pablo
     Galindo.

   - bpo-36282(12): Improved error message for too much positional
     arguments in some builtin functions.

   - bpo-30040(13): New empty dict uses fewer memory for now.  It used
     more memory than empty dict created by ‘dict.clear()’.  And empty
     dict creation and deletion is about 2x faster.  Patch by Inada
     Naoki.

   - bpo-36262(14): Fix an unlikely memory leak on conversion from
     string to float in the function ‘_Py_dg_strtod()’ used by
     ‘float(str)’, ‘complex(str)’, *note pickle.load(): 5b7, *note
     marshal.load(): f24, etc.

   - bpo-36252(15): Update Unicode databases to version 12.0.0.

   - bpo-36218(16): Fix a segfault occurring when sorting a list of
     heterogeneous values.  Patch contributed by Rémi Lapeyre and Elliot
     Gorokhovsky.

   - bpo-36188(17): Cleaned up left-over vestiges of Python 2 unbound
     method handling in method objects and documentation.  Patch by
     Martijn Pieters

   - bpo-36124(18): Add a new interpreter-specific dict and expose it in
     the C-API via PyInterpreterState_GetDict().  This parallels
     PyThreadState_GetDict().  However, extension modules should
     continue using PyModule_GetState() for their own internal
     per-interpreter state.

   - bpo-35975(19): Add a ‘feature_version’ flag to ‘ast.parse()’
     (documented) and ‘compile()’ (hidden) that allows tweaking the
     parser to support older versions of the grammar.  In particular, if
     ‘feature_version’ is 5 or 6, the hacks for the ‘async’ and ‘await’
     keyword from PEP 492 are reinstated.  (For 7 or higher, these are
     unconditionally treated as keywords, but they are still special
     tokens rather than ‘NAME’ tokens that the parser driver
     recognizes.)

   - bpo-31904(20): Use UTF-8 as the system encoding on VxWorks.

   - bpo-36048(21): The *note __index__(): 18a. special method will be
     used instead of *note __int__(): 18b. for implicit conversion of
     Python numbers to C integers.  Using the ‘__int__()’ method in
     implicit conversions has been deprecated.

   - bpo-35808(22): Retire pgen and use a modified version of pgen2 to
     generate the parser.  Patch by Pablo Galindo.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36421

   (2) https://bugs.python.org/issue36412

   (3) https://bugs.python.org/issue36398

   (4) https://bugs.python.org/issue36256

   (5) https://bugs.python.org/issue36365

   (6) https://bugs.python.org/issue36374

   (7) https://bugs.python.org/issue36236

   (8) https://bugs.python.org/issue36352

   (9) https://bugs.python.org/issue36301

   (10) https://bugs.python.org/issue36333

   (11) https://bugs.python.org/issue36332

   (12) https://bugs.python.org/issue36282

   (13) https://bugs.python.org/issue30040

   (14) https://bugs.python.org/issue36262

   (15) https://bugs.python.org/issue36252

   (16) https://bugs.python.org/issue36218

   (17) https://bugs.python.org/issue36188

   (18) https://bugs.python.org/issue36124

   (19) https://bugs.python.org/issue35975

   (20) https://bugs.python.org/issue31904

   (21) https://bugs.python.org/issue36048

   (22) https://bugs.python.org/issue35808


File: python.info,  Node: Library<10>,  Next: Documentation<10>,  Prev: Core and Builtins<10>,  Up: Python 3 8 0 alpha 3

1.18.10.3 Library
.................

   - bpo-36401(1): The class documentation created by pydoc now has a
     separate section for readonly properties.

   - bpo-36320(2): The typing.NamedTuple() class has deprecated the
     _field_types attribute in favor of the __annotations__ attribute
     which carried the same information.  Also, both attributes were
     converted from OrderedDict to a regular dict.

   - bpo-34745(3): Fix *note asyncio: a. ssl memory issues caused by
     circular references

   - bpo-36324(4): Add method to statistics.NormalDist for computing the
     inverse cumulative normal distribution.

   - bpo-36321(5): collections.namedtuple() misspelled the name of an
     attribute.  To be consistent with typing.NamedTuple, the attribute
     name should have been “_field_defaults” instead of
     “_fields_defaults”.  For backwards compatibility, both spellings
     are now created.  The misspelled version may be removed in the
     future.

   - bpo-36297(6): “unicode_internal” codec is removed.  It was
     deprecated since Python 3.3.  Patch by Inada Naoki.

   - bpo-36298(7): Raise ModuleNotFoundError in pyclbr when a module
     can’t be found.  Thanks to ‘mental’ for the bug report.

   - bpo-36268(8): Switch the default format used for writing tars with
     mod:*note tarfile: 101. to the modern POSIX.1-2001 pax standard,
     from the vendor-specific GNU. Contributed by C.A.M. Gerlach.

   - bpo-36285(9): Fix integer overflows in the array module.  Patch by
     Stephan Hohe.

   - bpo-31904(10): Add _signal module support for VxWorks.

   - bpo-36272(11): *note logging: aa. does not silently ignore
     RecursionError anymore.  Patch contributed by Rémi Lapeyre.

   - bpo-36280(12): Add a kind field to ast.Constant.  It is ‘u’ if the
     literal has a ‘u’ prefix (i.e.  a Python 2 style unicode literal),
     else None.

   - bpo-35931(13): The *note pdb: c9. ‘debug’ command now gracefully
     handles all exceptions.

   - bpo-36251(14): Fix format strings used for stderrprinter and
     re.Match reprs.  Patch by Stephan Hohe.

   - bpo-36235(15): Fix ‘CFLAGS’ in ‘customize_compiler()’ of
     ‘distutils.sysconfig’: when the ‘CFLAGS’ environment variable is
     defined, don’t override ‘CFLAGS’ variable with the ‘OPT’ variable
     anymore.  Initial patch written by David Malcolm.

   - bpo-35807(16): Update ensurepip to install pip 19.0.3 and
     setuptools 40.8.0.

   - bpo-36139(17): Release GIL when closing *note mmap: 1ea. objects.

   - bpo-36179(18): Fix two unlikely reference leaks in _hashopenssl.
     The leaks only occur in out-of-memory cases.

   - bpo-36169(19): Add overlap() method to statistics.NormalDist.
     Computes the overlapping coefficient for two normal distributions.

   - bpo-36103(20): Default buffer size used by ‘shutil.copyfileobj()’
     is changed from 16 KiB to 64 KiB on non-Windows platform to reduce
     system call overhead.  Contributed by Inada Naoki.

   - bpo-36130(21): Fix ‘pdb’ with ‘skip=...’ when stepping into a frame
     without a ‘__name__’ global.  Patch by Anthony Sottile.

   - bpo-35652(22): shutil.copytree(copy_function=…) erroneously pass
     DirEntry instead of a path string.

   - bpo-35178(23): Ensure custom *note warnings.formatwarning(): f26.
     function can receive ‘line’ as positional argument.  Based on patch
     by Tashrif Billah.

   - bpo-36106(24): Resolve potential name clash with libm’s sinpi().
     Patch by Dmitrii Pasechnik.

   - bpo-36091(25): Clean up reference to async generator in Lib/types.
     Patch by Henry Chen.

   - bpo-36043(26): ‘FileCookieJar’ supports *note path-like object:
     35f.  Contributed by Stéphane Wirtel

   - bpo-35899(27): Enum has been fixed to correctly handle empty
     strings and strings with non-Latin characters (ie.  ‘α’, ‘א’)
     without crashing.  Original patch contributed by Maxwell.  Assisted
     by Stéphane Wirtel.

   - bpo-21269(28): Add ‘args’ and ‘kwargs’ properties to mock call
     objects.  Contributed by Kumar Akshay.

   - bpo-30670(29): *note pprint.pp: 210. has been added to pretty-print
     objects with dictionary keys being sorted with their insertion
     order by default.  Parameter `sort_dicts' has been added to *note
     pprint.pprint: 211, *note pprint.pformat: 88a. and *note
     pprint.PrettyPrinter: 889.  Contributed by Rémi Lapeyre.

   - bpo-35843(30): Implement ‘__getitem__’ for ‘_NamespacePath’.  Patch
     by Anthony Sottile.

   - bpo-35802(31): Clean up code which checked presence of ‘os.stat’ /
     ‘os.lstat’ / ‘os.chmod’ which are always present.  Patch by Anthony
     Sottile.

   - bpo-35715(32): Librates the return value of a ProcessPoolExecutor
     _process_worker after it’s no longer needed to free memory

   - bpo-35493(33): Use *note multiprocessing.connection.wait(): a19.
     instead of polling each 0.2 seconds for worker updates in
     ‘multiprocessing.Pool’.  Patch by Pablo Galindo.

   - bpo-35661(34): Store the venv prompt in pyvenv.cfg.

   - bpo-35121(35): Don’t set cookie for a request when the request path
     is a prefix match of the cookie’s path attribute but doesn’t end
     with “/”.  Patch by Karthikeyan Singaravelan.

   - bpo-21478(36): Calls to a child function created with *note
     unittest.mock.create_autospec(): f14. should propagate to the
     parent.  Patch by Karthikeyan Singaravelan.

   - bpo-35198(37): Fix C++ extension compilation on AIX

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36401

   (2) https://bugs.python.org/issue36320

   (3) https://bugs.python.org/issue34745

   (4) https://bugs.python.org/issue36324

   (5) https://bugs.python.org/issue36321

   (6) https://bugs.python.org/issue36297

   (7) https://bugs.python.org/issue36298

   (8) https://bugs.python.org/issue36268

   (9) https://bugs.python.org/issue36285

   (10) https://bugs.python.org/issue31904

   (11) https://bugs.python.org/issue36272

   (12) https://bugs.python.org/issue36280

   (13) https://bugs.python.org/issue35931

   (14) https://bugs.python.org/issue36251

   (15) https://bugs.python.org/issue36235

   (16) https://bugs.python.org/issue35807

   (17) https://bugs.python.org/issue36139

   (18) https://bugs.python.org/issue36179

   (19) https://bugs.python.org/issue36169

   (20) https://bugs.python.org/issue36103

   (21) https://bugs.python.org/issue36130

   (22) https://bugs.python.org/issue35652

   (23) https://bugs.python.org/issue35178

   (24) https://bugs.python.org/issue36106

   (25) https://bugs.python.org/issue36091

   (26) https://bugs.python.org/issue36043

   (27) https://bugs.python.org/issue35899

   (28) https://bugs.python.org/issue21269

   (29) https://bugs.python.org/issue30670

   (30) https://bugs.python.org/issue35843

   (31) https://bugs.python.org/issue35802

   (32) https://bugs.python.org/issue35715

   (33) https://bugs.python.org/issue35493

   (34) https://bugs.python.org/issue35661

   (35) https://bugs.python.org/issue35121

   (36) https://bugs.python.org/issue21478

   (37) https://bugs.python.org/issue35198


File: python.info,  Node: Documentation<10>,  Next: Tests<10>,  Prev: Library<10>,  Up: Python 3 8 0 alpha 3

1.18.10.4 Documentation
.......................

   - bpo-36329(1): Declare the path of the Python binary for the usage
     of ‘Tools/scripts/serve.py’ when executing ‘make -C Doc/ serve’.
     Contributed by Stéphane Wirtel

   - bpo-36138(2): Improve documentation about converting
     datetime.timedelta to scalars.

   - bpo-21314(3): A new entry was added to the Core Language Section of
     the Programming FAQ, which explaines the usage of slash(/) in the
     signature of a function.  Patch by Lysandros Nikolaou

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36329

   (2) https://bugs.python.org/issue36138

   (3) https://bugs.python.org/issue21314


File: python.info,  Node: Tests<10>,  Next: Build<8>,  Prev: Documentation<10>,  Up: Python 3 8 0 alpha 3

1.18.10.5 Tests
...............

   - bpo-36234(1): test_posix.PosixUidGidTests: add tests for invalid
     uid/gid type (str).  Initial patch written by David Malcolm.

   - bpo-29571(2): Fix ‘test_re.test_locale_flag()’: use
     ‘locale.getpreferredencoding()’ rather than ‘locale.getlocale()’ to
     get the locale encoding.  With some locales, ‘locale.getlocale()’
     returns the wrong encoding.

   - bpo-36123(3): Fix race condition in test_socket.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36234

   (2) https://bugs.python.org/issue29571

   (3) https://bugs.python.org/issue36123


File: python.info,  Node: Build<8>,  Next: Windows<10>,  Prev: Tests<10>,  Up: Python 3 8 0 alpha 3

1.18.10.6 Build
...............

   - bpo-36356(1): Fix leaks that led to build failure when configured
     with address sanitizer.

   - bpo-36146(2): Add ‘TEST_EXTENSIONS’ constant to ‘setup.py’ to allow
     to not build test extensions like ‘_testcapi’.

   - bpo-36146(3): Fix setup.py on macOS: only add ‘/usr/include/ffi’ to
     include directories of _ctypes, not for all extensions.

   - bpo-31904(4): Enable build system to cross-build for VxWorks RTOS.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36356

   (2) https://bugs.python.org/issue36146

   (3) https://bugs.python.org/issue36146

   (4) https://bugs.python.org/issue31904


File: python.info,  Node: Windows<10>,  Next: IDLE<12>,  Prev: Build<8>,  Up: Python 3 8 0 alpha 3

1.18.10.7 Windows
.................

   - bpo-36312(1): Fixed decoders for the following code pages: 50220,
     50221, 50222, 50225, 50227, 50229, 57002 through 57011, 65000 and
     42.

   - bpo-36264(2): Don’t honor POSIX ‘HOME’ in ‘os.path.expanduser’ on
     windows.  Patch by Anthony Sottile.

   - bpo-24643(3): Fix name collisions due to ‘#define timezone
     _timezone’ in PC/pyconfig.h.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36312

   (2) https://bugs.python.org/issue36264

   (3) https://bugs.python.org/issue24643


File: python.info,  Node: IDLE<12>,  Next: Tools/Demos<7>,  Prev: Windows<10>,  Up: Python 3 8 0 alpha 3

1.18.10.8 IDLE
..............

   - bpo-36405(1): Use dict unpacking in idlelib.

   - bpo-36396(2): Remove fgBg param of idlelib.config.GetHighlight().
     This param was only used twice and changed the return type.

   - bpo-36176(3): Fix IDLE autocomplete & calltip popup colors.
     Prevent conflicts with Linux dark themes (and slightly darken
     calltip background).

   - bpo-23205(4): For the grep module, add tests for findfiles,
     refactor findfiles to be a module-level function, and refactor
     findfiles to use os.walk.

   - bpo-23216(5): Add docstrings to IDLE search modules.

   - bpo-36152(6): Remove colorizer.ColorDelegator.close_when_done and
     the corresponding argument of .close().  In IDLE, both have always
     been None or False since 2007.

   - bpo-32129(7): Avoid blurry IDLE application icon on macOS with Tk
     8.6.  Patch by Kevin Walzer.

   - bpo-36096(8): Refactor class variables to instance variables in
     colorizer.

   - bpo-30348(9): Increase test coverage of idlelib.autocomplete by
     30%.  Patch by Louie Lu

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36405

   (2) https://bugs.python.org/issue36396

   (3) https://bugs.python.org/issue36176

   (4) https://bugs.python.org/issue23205

   (5) https://bugs.python.org/issue23216

   (6) https://bugs.python.org/issue36152

   (7) https://bugs.python.org/issue32129

   (8) https://bugs.python.org/issue36096

   (9) https://bugs.python.org/issue30348


File: python.info,  Node: Tools/Demos<7>,  Next: C API<8>,  Prev: IDLE<12>,  Up: Python 3 8 0 alpha 3

1.18.10.9 Tools/Demos
.....................

   - bpo-35132(1): Fix py-list and py-bt commands of python-gdb.py on
     gdb7.

   - bpo-32217(2): Fix freeze script on Windows.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35132

   (2) https://bugs.python.org/issue32217


File: python.info,  Node: C API<8>,  Prev: Tools/Demos<7>,  Up: Python 3 8 0 alpha 3

1.18.10.10 C API
................

   - bpo-36381(1): Raise ‘DeprecationWarning’ when ‘#’ formats are used
     for building or parsing values without ‘PY_SSIZE_T_CLEAN’.

   - bpo-36142(2): The whole coreconfig.h header is now excluded from
     Py_LIMITED_API. Move functions definitions into a new internal
     pycore_coreconfig.h header.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36381

   (2) https://bugs.python.org/issue36142


File: python.info,  Node: Python 3 8 0 alpha 2,  Next: Python 3 8 0 alpha 1,  Prev: Python 3 8 0 alpha 3,  Up: Changelog

1.18.11 Python 3.8.0 alpha 2
----------------------------

`Release date: 2019-02-25'

* Menu:

* Core and Builtins: Core and Builtins<11>.
* Library: Library<11>.
* Documentation: Documentation<11>.
* Tests: Tests<11>.
* Windows: Windows<11>.
* IDLE: IDLE<13>.


File: python.info,  Node: Core and Builtins<11>,  Next: Library<11>,  Up: Python 3 8 0 alpha 2

1.18.11.1 Core and Builtins
...........................

   - bpo-36052(1): Raise a *note SyntaxError: 44d. when assigning a
     value to *note __debug__: f30. with the Assignment Operator.
     Contributed by Stéphane Wirtel and Pablo Galindo.

   - bpo-36012(2): Doubled the speed of class variable writes.  When a
     non-dunder attribute was updated, there was an unnecessary call to
     update slots.

   - bpo-35942(3): The error message emitted when returning invalid
     types from ‘__fspath__’ in interfaces that allow passing *note
     PathLike: 4e0. objects has been improved and now it does explain
     the origin of the error.

   - bpo-36016(4): ‘gc.get_objects’ can now receive an optional
     parameter indicating a generation to get objects from.  Patch by
     Pablo Galindo.

   - bpo-1054041(5): When the main interpreter exits due to an uncaught
     KeyboardInterrupt, the process now exits in the appropriate manner
     for its parent process to detect that a SIGINT or ^C terminated the
     process.  This allows shells and batch scripts to understand that
     the user has asked them to stop.

   - bpo-35992(6): Fix ‘__class_getitem__()’ not being called on a class
     with a custom non-subscriptable metaclass.

   - bpo-35993(7): Fix a crash on fork when using subinterpreters.
     Contributed by Stéphane Wirtel

   - bpo-35991(8): Fix a potential double free in
     Modules/_randommodule.c.

   - bpo-35961(9): Fix a crash in slice_richcompare(): use strong
     references rather than stolen references for the two temporary
     internal tuples.

   - bpo-35911(10): Enable the creation of cell objects by adding a
     ‘cell.__new__’ method, and expose the type ‘cell’ in ‘Lib/types.py’
     under the name CellType.  Patch by Pierre Glaser.

   - bpo-12822(11): Use monotonic clock for ‘pthread_cond_timedwait’
     when ‘pthread_condattr_setclock’ and ‘CLOCK_MONOTONIC’ are
     available.

   - bpo-15248(12): The compiler emits now syntax warnings in the case
     when a comma is likely missed before tuple or list.

   - bpo-35886(13): The implementation of PyInterpreterState has been
     moved into the internal header files (guarded by Py_BUILD_CORE).

   - bpo-31506(14): Clarify the errors reported when ‘object.__new__’
     and ‘object.__init__’ receive more than one argument.  Contributed
     by Sanyam Khurana.

   - bpo-35724(15): Signal-handling is now guaranteed to happen relative
     to the main interpreter.

   - bpo-33608(16): We added a new internal _Py_AddPendingCall() that
     operates relative to the provided interpreter.  This allows us to
     use the existing implementation to ask another interpreter to do
     work that cannot be done in the current interpreter, like decref an
     object the other interpreter owns.  The existing
     Py_AddPendingCall() only operates relative to the main interpreter.

   - bpo-33989(17): Fix a possible crash in *note list.sort(): 43a. when
     sorting objects with ‘ob_type->tp_richcompare == NULL’.  Patch by
     Zackery Spytz.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36052

   (2) https://bugs.python.org/issue36012

   (3) https://bugs.python.org/issue35942

   (4) https://bugs.python.org/issue36016

   (5) https://bugs.python.org/issue1054041

   (6) https://bugs.python.org/issue35992

   (7) https://bugs.python.org/issue35993

   (8) https://bugs.python.org/issue35991

   (9) https://bugs.python.org/issue35961

   (10) https://bugs.python.org/issue35911

   (11) https://bugs.python.org/issue12822

   (12) https://bugs.python.org/issue15248

   (13) https://bugs.python.org/issue35886

   (14) https://bugs.python.org/issue31506

   (15) https://bugs.python.org/issue35724

   (16) https://bugs.python.org/issue33608

   (17) https://bugs.python.org/issue33989


File: python.info,  Node: Library<11>,  Next: Documentation<11>,  Prev: Core and Builtins<11>,  Up: Python 3 8 0 alpha 2

1.18.11.2 Library
.................

   - bpo-35512(1): *note unittest.mock.patch.dict(): f01. used as a
     decorator with string target resolves the target during function
     call instead of during decorator construction.  Patch by
     Karthikeyan Singaravelan.

   - bpo-36018(2): Add statistics.NormalDist, a tool for creating and
     manipulating normal distributions of random variable.  Features a
     composite class that treats the mean and standard deviation of
     measurement data as single entity.

   - bpo-35904(3): Added statistics.fmean() as a faster, floating point
     variant of the existing mean() function.

   - bpo-35918(4): Removed broken ‘has_key’ method from
     multiprocessing.managers.SyncManager.dict.  Contributed by Rémi
     Lapeyre.

   - bpo-18283(5): Add support for bytes to *note shutil.which(): f0e.

   - bpo-35960(6): Fix *note dataclasses.field(): f32. throwing away
     empty mapping objects passed as metadata.

   - bpo-35500(7): Write expected and actual call parameters on separate
     lines in *note unittest.mock.Mock.assert_called_with(): f33.
     assertion errors.  Contributed by Susan Su.

   - bpo-35931(8): The *note pdb: c9. ‘debug’ command now gracefully
     handles syntax errors.

   - bpo-24209(9): In http.server script, rely on getaddrinfo to bind to
     preferred address based on the bind parameter.  Now default bind or
     binding to a name may bind to IPv6 or dual-stack, depending on the
     environment.

   - bpo-35321(10): Set ‘__spec__.origin’ of ‘_frozen_importlib’ to
     frozen so that it matches the behavior of
     ‘_frozen_importlib_external’.  Patch by Nina Zakharenko.

   - bpo-35378(11): Fix a reference issue inside ‘multiprocessing.Pool’
     that caused the pool to remain alive if it was deleted without
     being closed or terminated explicitly.  A new strong reference is
     added to the pool iterators to link the lifetime of the pool to the
     lifetime of its iterators so the pool does not get destroyed if a
     pool iterator is still alive.

   - bpo-34294(12): re module, fix wrong capturing groups in rare cases.
     *note re.search(): ba5, *note re.findall(): 957, *note re.sub():
     470. and other functions that scan through string looking for a
     match, should reset capturing groups between two match attempts.
     Patch by Ma Lin.

   - bpo-35615(13): *note weakref: 128.: Fix a RuntimeError when copying
     a WeakKeyDictionary or a WeakValueDictionary, due to some keys or
     values disappearing while iterating.

   - bpo-35606(14): Implement *note math.prod(): 1e2. as analogous
     function to *note sum(): 1e3. that returns the product of a ‘start’
     value (default: 1) times an iterable of numbers.  Patch by Pablo
     Galindo.

   - bpo-32417(15): Performing arithmetic between *note
     datetime.datetime: 194. subclasses and *note datetime.timedelta:
     195. now returns an object of the same type as the *note
     datetime.datetime: 194. subclass.  As a result, *note
     datetime.datetime.astimezone(): 196. and alternate constructors
     like *note datetime.datetime.now(): f34. and
     ‘datetime.fromtimestamp()’ called with a ‘tz’ argument now `also'
     retain their subclass.

   - bpo-35153(16): Add `headers' optional keyword-only parameter to
     *note xmlrpc.client.ServerProxy: 253, ‘xmlrpc.client.Transport’ and
     ‘xmlrpc.client.SafeTransport’.  Patch by Cédric Krier.

   - bpo-34572(17): Fix C implementation of pickle.loads to use
     importlib’s locking mechanisms, and thereby avoid using
     partially-loaded modules.  Patch by Tim Burgess.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35512

   (2) https://bugs.python.org/issue36018

   (3) https://bugs.python.org/issue35904

   (4) https://bugs.python.org/issue35918

   (5) https://bugs.python.org/issue18283

   (6) https://bugs.python.org/issue35960

   (7) https://bugs.python.org/issue35500

   (8) https://bugs.python.org/issue35931

   (9) https://bugs.python.org/issue24209

   (10) https://bugs.python.org/issue35321

   (11) https://bugs.python.org/issue35378

   (12) https://bugs.python.org/issue34294

   (13) https://bugs.python.org/issue35615

   (14) https://bugs.python.org/issue35606

   (15) https://bugs.python.org/issue32417

   (16) https://bugs.python.org/issue35153

   (17) https://bugs.python.org/issue34572


File: python.info,  Node: Documentation<11>,  Next: Tests<11>,  Prev: Library<11>,  Up: Python 3 8 0 alpha 2

1.18.11.3 Documentation
.......................

   - bpo-36083(1): Fix formatting of –check-hash-based-pycs options in
     the manpage Synopsis.

   - bpo-36007(2): Bump minimum sphinx version to 1.8.  Patch by Anthony
     Sottile.

   - bpo-22062(3): Update documentation and docstrings for pathlib.
     Original patch by Mike Short.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue36083

   (2) https://bugs.python.org/issue36007

   (3) https://bugs.python.org/issue22062


File: python.info,  Node: Tests<11>,  Next: Windows<11>,  Prev: Documentation<11>,  Up: Python 3 8 0 alpha 2

1.18.11.4 Tests
...............

   - bpo-27313(1): Avoid test_ttk_guionly ComboboxTest failure with
     macOS Cocoa Tk.

   - bpo-36019(2): Add test.support.TEST_HTTP_URL and replace references
     of ‘http://www.example.com’ by this new constant.  Contributed by
     Stéphane Wirtel.

   - bpo-36037(3): Fix test_ssl for strict OpenSSL configuration like
     RHEL8 strict crypto policy.  Use older TLS version for minimum TLS
     version of the server SSL context if needed, to test TLS version
     older than default minimum TLS version.

   - bpo-35798(4): Added *note test.support.check_syntax_warning(): f37.

   - bpo-35505(5): Make test_imap4_host_default_value independent on
     whether the local IMAP server is running.

   - bpo-35917(6): multiprocessing: provide unit tests for SyncManager
     and SharedMemoryManager classes + all the shareable types which are
     supposed to be supported by them.  (patch by Giampaolo Rodola)

   - bpo-35704(7): Skip ‘test_shutil.test_unpack_archive_xztar’ to
     prevent a MemoryError on 32-bit AIX when MAXDATA setting is less
     than 0x20000000.

     Patch by Michael Felt (aixtools)

   - bpo-34720(8): Assert m_state != NULL to mimic GC traversal
     functions that do not correctly handle module creation when the
     module state has not been created.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27313

   (2) https://bugs.python.org/issue36019

   (3) https://bugs.python.org/issue36037

   (4) https://bugs.python.org/issue35798

   (5) https://bugs.python.org/issue35505

   (6) https://bugs.python.org/issue35917

   (7) https://bugs.python.org/issue35704

   (8) https://bugs.python.org/issue34720


File: python.info,  Node: Windows<11>,  Next: IDLE<13>,  Prev: Tests<11>,  Up: Python 3 8 0 alpha 2

1.18.11.5 Windows
.................

   - bpo-35976(1): Added ARM build support to Windows build files in
     PCBuild.

   - bpo-35692(2): ‘pathlib’ no longer raises when checking file and
     directory existence on drives that are not ready

   - bpo-35872(3): Uses the base Python executable when invoking venv in
     a virtual environment

   - bpo-35873(4): Prevents venv paths being inherited by child
     processes

   - bpo-35299(5): Fix sysconfig detection of the source directory and
     distutils handling of pyconfig.h during PGO profiling

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35976

   (2) https://bugs.python.org/issue35692

   (3) https://bugs.python.org/issue35872

   (4) https://bugs.python.org/issue35873

   (5) https://bugs.python.org/issue35299


File: python.info,  Node: IDLE<13>,  Prev: Windows<11>,  Up: Python 3 8 0 alpha 2

1.18.11.6 IDLE
..............

   - bpo-24310(1): IDLE – Document settings dialog font tab sample.

   - bpo-35833(2): Revise IDLE doc for control codes sent to Shell.  Add
     a code example block.

   - bpo-35689(3): Add docstrings and unittests for colorizer.py.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24310

   (2) https://bugs.python.org/issue35833

   (3) https://bugs.python.org/issue35689


File: python.info,  Node: Python 3 8 0 alpha 1,  Next: Python 3 7 0 final,  Prev: Python 3 8 0 alpha 2,  Up: Changelog

1.18.12 Python 3.8.0 alpha 1
----------------------------

`Release date: 2019-02-03'

* Menu:

* Security: Security<9>.
* Core and Builtins: Core and Builtins<12>.
* Library: Library<12>.
* Documentation: Documentation<12>.
* Tests: Tests<12>.
* Build: Build<9>.
* Windows: Windows<12>.
* macOS: macOS<8>.
* IDLE: IDLE<14>.
* Tools/Demos: Tools/Demos<8>.
* C API: C API<9>.


File: python.info,  Node: Security<9>,  Next: Core and Builtins<12>,  Up: Python 3 8 0 alpha 1

1.18.12.1 Security
..................

   - bpo-35746(1): [CVE-2019-5010] Fix a NULL pointer deref in ssl
     module.  The cert parser did not handle CRL distribution points
     with empty DP or URI correctly.  A malicious or buggy certificate
     can result into segfault.  Vulnerability (TALOS-2018-0758) reported
     by Colin Read and Nicolas Edet of Cisco.

   - bpo-34812(2): The *note -I: f3c. command line option (run Python in
     isolated mode) is now also copied by the *note multiprocessing: b7.
     and *note distutils: 39. modules when spawning child processes.
     Previously, only *note -E: f3d. and *note -s: d08. options (enabled
     by *note -I: f3c.) were copied.

   - bpo-34791(3): The xml.sax and xml.dom.domreg no longer use
     environment variables to override parser implementations when
     sys.flags.ignore_environment is set by -E or -I arguments.

   - bpo-17239(4): The xml.sax and xml.dom.minidom parsers no longer
     processes external entities by default.  External DTD and ENTITY
     declarations no longer load files or create network connections.

   - bpo-34623(5): CVE-2018-14647: The C accelerated _elementtree module
     now initializes hash randomization salt from _Py_HashSecret instead
     of libexpat’s default CSPRNG.

   - bpo-34405(6): Updated to OpenSSL 1.1.0i for Windows builds.

   - bpo-33871(7): Fixed sending the part of the file in *note
     os.sendfile(): 34e. on macOS. Using the `trailers' argument could
     cause sending more bytes from the input file than was specified.

   - bpo-32533(8): Fixed thread-safety of error handling in _ssl.

   - bpo-33136(9): Harden ssl module against LibreSSL CVE-2018-8970.
     X509_VERIFY_PARAM_set1_host() is called with an explicit namelen.
     A new test ensures that NULL bytes are not allowed.

   - bpo-33001(10): Minimal fix to prevent buffer overrun in os.symlink
     on Windows

   - bpo-32981(11): Regexes in difflib and poplib were vulnerable to
     catastrophic backtracking.  These regexes formed potential DOS
     vectors (REDOS). They have been refactored.  This resolves
     CVE-2018-1060 and CVE-2018-1061.  Patch by Jamie Davis.

   - bpo-28414(12): The ssl module now allows users to perform their own
     IDN en/decoding when using SNI.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35746

   (2) https://bugs.python.org/issue34812

   (3) https://bugs.python.org/issue34791

   (4) https://bugs.python.org/issue17239

   (5) https://bugs.python.org/issue34623

   (6) https://bugs.python.org/issue34405

   (7) https://bugs.python.org/issue33871

   (8) https://bugs.python.org/issue32533

   (9) https://bugs.python.org/issue33136

   (10) https://bugs.python.org/issue33001

   (11) https://bugs.python.org/issue32981

   (12) https://bugs.python.org/issue28414


File: python.info,  Node: Core and Builtins<12>,  Next: Library<12>,  Prev: Security<9>,  Up: Python 3 8 0 alpha 1

1.18.12.2 Core and Builtins
...........................

   - bpo-35877(1): Make parenthesis optional for named expressions in
     while statement.  Patch by Karthikeyan Singaravelan.

   - bpo-35814(2): Allow same right hand side expressions in annotated
     assignments as in normal ones.  In particular, ‘x: Tuple[int, int]
     = 1, 2’ (without parentheses on the right) is now allowed.

   - bpo-35766(3): Add the option to parse PEP 484 type comments in the
     ast module.  (Off by default.)  This is merging the key
     functionality of the third party fork thereof,
     [typed_ast](‘https://github.com/python/typed_ast’).

   - bpo-35713(4): Reorganize Python initialization to get working
     exceptions and sys.stderr earlier.

   - bpo-33416(5): Add end line and end column position information to
     the Python AST nodes.  This is a C-level backwards incompatible
     change.

   - bpo-35720(6): Fixed a minor memory leak in
     pymain_parse_cmdline_impl function in Modules/main.c

   - bpo-35634(7): ‘func(**kwargs)’ will now raise an error when
     ‘kwargs’ is a mapping containing multiple entries with the same
     key.  An error was already raised when other keyword arguments are
     passed before ‘**kwargs’ since Python 3.6.

   - bpo-35623(8): Fix a crash when sorting very long lists.  Patch by
     Stephan Hohe.

   - bpo-35214(9): clang Memory Sanitizer build instrumentation was
     added to work around false positives from posix, socket, time,
     test_io, and test_faulthandler.

   - bpo-35560(10): Fix an assertion error in *note format(): 4d0. in
     debug build for floating point formatting with “n” format, zero
     padding and small width.  Release build is not impacted.  Patch by
     Karthikeyan Singaravelan.

   - bpo-35552(11): Format characters ‘%s’ and ‘%V’ in *note
     PyUnicode_FromFormat(): 7bf. and ‘%s’ in *note
     PyBytes_FromFormat(): f3f. no longer read memory past the limit if
     `precision' is specified.

   - bpo-35504(12): Fix segfaults and *note SystemError: 5f0.s when
     deleting certain attributes.  Patch by Zackery Spytz.

   - bpo-35504(13): Fixed a SystemError when delete the
     characters_written attribute of an OSError.

   - bpo-35494(14): Improved syntax error messages for unbalanced
     parentheses in f-string.

   - bpo-35444(15): Fixed error handling in pickling methods when fail
     to look up builtin “getattr”.  Sped up pickling iterators.

   - bpo-35436(16): Fix various issues with memory allocation error
     handling.  Patch by Zackery Spytz.

   - bpo-35423(17): Separate the signal handling trigger in the eval
     loop from the “pending calls” machinery.  There is no semantic
     change and the difference in performance is insignificant.

   - bpo-35357(18): Internal attributes’ names of unittest.mock._Call
     and unittest.mock.MagicProxy (name, parent & from_kall) are now
     prefixed with _mock_ in order to prevent clashes with widely used
     object attributes.  Fixed minor typo in test function name.

   - bpo-35372(19): Fixed the code page decoder for input longer than 2
     GiB containing undecodable bytes.

   - bpo-35336(20): Fix PYTHONCOERCECLOCALE=1 environment variable: only
     coerce the C locale if the LC_CTYPE locale is “C”.

   - bpo-31241(21): The `lineno' and `col_offset' attributes of AST
     nodes for list comprehensions, generator expressions and tuples are
     now point to the opening parenthesis or square brace.  For tuples
     without parenthesis they point to the position of the first item.

   - bpo-33954(22): For *note str.format(): 4cf, ‘float.__format__()’
     and ‘complex.__format__()’ methods for non-ASCII decimal point when
     using the “n” formatter.

   - bpo-35269(23): Fix a possible segfault involving a newly-created
     coroutine.  Patch by Zackery Spytz.

   - bpo-35224(24): Implement PEP 572(25) (assignment expressions).
     Patch by Emily Morehouse.

   - bpo-32492(26): Speed up ‘namedtuple’ attribute access by 1.6x using
     a C fast-path for the name descriptors.  Patch by Pablo Galindo.

   - bpo-35214(27): Fixed an out of bounds memory access when parsing a
     truncated unicode escape sequence at the end of a string such as
     ‘'\N'’.  It would read one byte beyond the end of the memory
     allocation.

   - bpo-35214(28): The interpreter and extension modules have had
     annotations added so that they work properly under clang’s Memory
     Sanitizer.  A new configure flag –with-memory-sanitizer has been
     added to make test builds of this nature easier to perform.

   - bpo-35193(29): Fix an off by one error in the bytecode peephole
     optimizer where it could read bytes beyond the end of bounds of an
     array when removing unreachable code.  This bug was present in
     every release of Python 3.6 and 3.7 until now.

   - bpo-35169(30): Improved error messages for forbidden assignments.

   - bpo-34022(31): Fix handling of hash-based bytecode files in *note
     zipimport: 143.  Patch by Elvis Pranskevichus.

   - bpo-28401(32): Debug builds will no longer to attempt to import
     extension modules built for the ABI as they were never compatible
     to begin with.  Patch by Stefano Rivera.

   - bpo-29341(33): Clarify in the docstrings of *note os: c4. methods
     that path-like objects are also accepted as input parameters.

   - bpo-35050(34): *note socket: ef.: Fix off-by-one bug in length
     check for ‘AF_ALG’ name and type.

   - bpo-29743(35): Raise *note ValueError: 1f9. instead of *note
     OverflowError: 954. in case of a negative ‘_length_’ in a *note
     ctypes.Array: f40. subclass.  Also raise *note TypeError: 192.
     instead of *note AttributeError: 390. for non-integer ‘_length_’.
     Original patch by Oren Milman.

   - bpo-16806(36): Fix ‘lineno’ and ‘col_offset’ for multi-line string
     tokens.

   - bpo-35029(37): *note SyntaxWarning: 191. raised as an exception at
     code generation time will be now replaced with a *note SyntaxError:
     44d. for better error reporting.

   - bpo-34983(38): Expose *note symtable.Symbol.is_nonlocal(): f41. in
     the symtable module.  Patch by Pablo Galindo.

   - bpo-34974(39): *note bytes: 326. and *note bytearray: 327.
     constructors no longer convert unexpected exceptions (e.g.  *note
     MemoryError: f42. and *note KeyboardInterrupt: 197.) to *note
     TypeError: 192.

   - bpo-34939(40): Allow annotated names in module namespace that are
     declared global before the annotation happens.  Patch by Pablo
     Galindo.

   - bpo-34973(41): Fixed crash in *note bytes(): 326. when the *note
     list: 260. argument is mutated while it is iterated.

   - bpo-34876(42): The `lineno' and `col_offset' attributes of the AST
     for decorated function and class refer now to the position of the
     corresponding ‘def’, ‘async def’ and ‘class’ instead of the
     position of the first decorator.  This leads to more correct line
     reporting in tracing.  This is the only case when the position of
     child AST nodes can precede the position of the parent AST node.

   - bpo-34879(43): Fix a possible null pointer dereference in
     bytesobject.c.  Patch by Zackery Spytz.

   - bpo-34784(44): Fix the implementation of PyStructSequence_NewType
     in order to create heap allocated StructSequences.

   - bpo-32912(45): A *note SyntaxWarning: 191. is now emitted instead
     of a *note DeprecationWarning: 276. for invalid escape sequences in
     string and bytes literals.

   - bpo-34854(46): Fixed a crash in compiling string annotations
     containing a lambda with a keyword-only argument that doesn’t have
     a default value.

   - bpo-34850(47): The compiler now produces a *note SyntaxWarning:
     191. when identity checks (‘is’ and ‘is not’) are used with certain
     types of literals (e.g.  strings, ints).  These can often work by
     accident in CPython, but are not guaranteed by the language spec.
     The warning advises users to use equality tests (‘==’ and ‘!=’)
     instead.

   - bpo-34824(48): Fix a possible null pointer dereference in
     Modules/_ssl.c.  Patch by Zackery Spytz.

   - bpo-30156(49): The C function ‘property_descr_get()’ uses a
     “cached” tuple to optimize function calls.  But this tuple can be
     discovered in debug mode with ‘sys.getobjects()’.  Remove the
     optimization, it’s not really worth it and it causes 3 different
     crashes last years.

   - bpo-34762(50): Fix contextvars C API to use PyObject* pointer
     types.

   - bpo-34751(51): The hash function for tuples is now based on xxHash
     which gives better collision results on (formerly) pathological
     cases.  Additionally, on 64-bit systems it improves tuple hashes in
     general.  Patch by Jeroen Demeyer with substantial contributions by
     Tim Peters.

   - bpo-34735(52): Fix a memory leak in Modules/timemodule.c.  Patch by
     Zackery Spytz.

   - bpo-34683(53): Fixed a bug where some SyntaxError error pointed to
     locations that were off-by-one.

   - bpo-34651(54): Only allow the main interpreter to fork.  The avoids
     the possibility of affecting the main interpreter, which is
     critical to operation of the runtime.

   - bpo-34653(55): Remove unused function
     PyParser_SimpleParseStringFilename.

   - bpo-32236(56): Warn that line buffering is not supported if *note
     open(): 4e5. is called with binary mode and ‘buffering=1’.

   - bpo-34641(57): Further restrict the syntax of the left-hand side of
     keyword arguments in function calls.  In particular,
     ‘f((keyword)=arg)’ is now disallowed.

   - bpo-34637(58): Make the `start' argument to `sum()' visible as a
     keyword argument.

   - bpo-1621(59): Do not assume signed integer overflow behavior (C
     undefined behavior) when performing set hash table resizing.

   - bpo-34588(60): Fix an off-by-one in the recursive call pruning
     feature of traceback formatting.

   - bpo-34485(61): On Windows, the LC_CTYPE is now set to the user
     preferred locale at startup.  Previously, the LC_CTYPE locale was
     “C” at startup, but changed when calling setlocale(LC_CTYPE, “”) or
     setlocale(LC_ALL, “”).

   - bpo-34485(62): Standard streams like sys.stdout now use the
     “surrogateescape” error handler, instead of “strict”, on the POSIX
     locale (when the C locale is not coerced and the UTF-8 Mode is
     disabled).

   - bpo-34485(63): Fix the error handler of standard streams like
     sys.stdout: PYTHONIOENCODING=”:” is now ignored instead of setting
     the error handler to “strict”.

   - bpo-34485(64): Python now gets the locale encoding with C code to
     initialize the encoding of standard streams like sys.stdout.
     Moreover, the encoding is now initialized to the Python codec name
     to get a normalized encoding name and to ensure that the codec is
     loaded.  The change avoids importing _bootlocale and _locale
     modules at startup by default.

   - bpo-34527(65): On FreeBSD, Py_DecodeLocale() and Py_EncodeLocale()
     now also forces the ASCII encoding if the LC_CTYPE locale is
     “POSIX”, not only if the LC_CTYPE locale is “C”.

   - bpo-34527(66): The UTF-8 Mode is now also enabled by the “POSIX”
     locale, not only by the “C” locale.

   - bpo-34403(67): On HP-UX with C or POSIX locale,
     sys.getfilesystemencoding() now returns “ascii” instead of “roman8”
     (when the UTF-8 Mode is disabled and the C locale is not coerced).

   - bpo-34523(68): The Python filesystem encoding is now read earlier
     during the Python initialization.

   - bpo-12458(69): Tracebacks show now correct line number for
     subexpressions in multiline expressions.  Tracebacks show now the
     line number of the first line for multiline expressions instead of
     the line number of the last subexpression.

   - bpo-34408(70): Prevent a null pointer dereference and resource
     leakage in ‘PyInterpreterState_New()’.

   - bpo-34400(71): Fix undefined behavior in parsetok.c.  Patch by
     Zackery Spytz.

   - bpo-33073(72): Added as_integer_ratio to ints to make them more
     interoperable with floats.

   - bpo-34377(73): Update valgrind suppression list to use
     ‘_PyObject_Free’/‘_PyObject_Realloc’ instead of
     ‘PyObject_Free’/‘PyObject_Realloc’.

   - bpo-34353(74): Added the “socket” option in the *note
     stat.filemode(): a92. Python implementation to match the C
     implementation.

   - bpo-34320(75): Fix ‘dict(od)’ didn’t copy iteration order of
     OrderedDict.

   - bpo-34113(76): Fixed crash on debug builds when opcode stack was
     adjusted with negative numbers.  Patch by Constantin Petrisor.

   - bpo-34100(77): Compiler now merges constants in tuples and
     frozensets recursively.  Code attributes like ‘co_names’ are merged
     too.

   - bpo-34151(78): Performance of list concatenation, repetition and
     slicing operations is slightly improved.  Patch by Sergey Fedoseev.

   - bpo-34170(79): -X dev: it is now possible to override the memory
     allocator using PYTHONMALLOC even if the developer mode is enabled.

   - bpo-33237(80): Improved *note AttributeError: 390. message for
     partially initialized module.

   - bpo-34149(81): Fix min and max functions to get default behavior
     when key is None.

   - bpo-34125(82): Profiling of unbound built-in methods now works when
     ‘**kwargs’ is given.

   - bpo-34141(83): Optimized pickling atomic types (None, bool, int,
     float, bytes, str).

   - bpo-34126(84): Fix crashes when profiling certain invalid calls of
     unbound methods.  Patch by Jeroen Demeyer.

   - bpo-24618(85): Fixed reading invalid memory when create the code
     object with too small varnames tuple or too large argument counts.

   - bpo-34068(86): In *note io.IOBase.close(): f43, ensure that the
     *note closed: f44. attribute is not set with a live exception.
     Patch by Zackery Spytz and Serhiy Storchaka.

   - bpo-34087(87): Fix buffer overflow while converting unicode to
     numeric values.

   - bpo-34080(88): Fixed a memory leak in the compiler when it raised
     some uncommon errors during tokenizing.

   - bpo-34066(89): Disabled interruption by Ctrl-C between calling
     ‘open()’ and entering a `with' block in ‘with open()’.

   - bpo-34042(90): Fix dict.copy() to maintain correct total refcount
     (as reported by sys.gettotalrefcount()).

   - bpo-33418(91): Fix potential memory leak in function object when it
     creates reference cycle.

   - bpo-33985(92): Implement contextvars.ContextVar.name attribute.

   - bpo-33956(93): Update vendored Expat library copy to version 2.2.5.

   - bpo-24596(94): Decref the module object in *note
     PyRun_SimpleFileExFlags(): f45. before calling *note PyErr_Print():
     f46.  Patch by Zackery Spytz.

   - bpo-33451(95): Close directly executed pyc files before calling
     ‘PyEval_EvalCode()’.

   - bpo-1617161(96): The hash of ‘BuiltinMethodType’ instances (methods
     of built-in classes) now depends on the hash of the identity of
     `__self__' instead of its value.  The hash and equality of
     ‘ModuleType’ and ‘MethodWrapperType’ instances (methods of
     user-defined classes and some methods of built-in classes like
     ‘str.__add__’) now depend on the hash and equality of the identity
     of `__self__' instead of its value.  ‘MethodWrapperType’ instances
     no longer support ordering.

   - bpo-33824(97): Fix “LC_ALL=C python3.7 -V”: reset properly the
     command line parser when the encoding changes after reading the
     Python configuration.

   - bpo-33803(98): Fix a crash in hamt.c caused by enabling GC tracking
     for an object that hadn’t all of its fields set to NULL.

   - bpo-33738(99): Seven macro incompatibilities with the Limited API
     were fixed, and the macros *note PyIter_Check(): f47, *note
     PyIndex_Check(): f48. and ‘PyExceptionClass_Name()’ were added as
     functions.  A script for automatic macro checks was added.

   - bpo-33786(100): Fix asynchronous generators to handle GeneratorExit
     in athrow() correctly

   - bpo-30167(101): ‘PyRun_SimpleFileExFlags’ removes ‘__cached__’ from
     module in addition to ‘__file__’.

   - bpo-33706(102): Fix a crash in Python initialization when parsing
     the command line options.  Thanks Christoph Gohlke for the bug
     report and the fix!

   - bpo-33597(103): Reduce ‘PyGC_Head’ size from 3 words to 2 words.

   - bpo-30654(104): Fixed reset of the SIGINT handler to SIG_DFL on
     interpreter shutdown even when there was a custom handler set
     previously.  Patch by Philipp Kerling.

   - bpo-33622(105): Fixed a leak when the garbage collector fails to
     add an object with the ‘__del__’ method or referenced by it into
     the *note gc.garbage: b33. list.  ‘PyGC_Collect()’ can now be
     called when an exception is set and preserves it.

   - bpo-33462(106): Make dict and dict views reversible.  Patch by Rémi
     Lapeyre.

   - bpo-23722(107): A *note RuntimeError: 2b8. is now raised when the
     custom metaclass doesn’t provide the ‘__classcell__’ entry in the
     namespace passed to ‘type.__new__’.  A *note DeprecationWarning:
     276. was emitted in Python 3.6–3.7.

   - bpo-33499(108): Add *note PYTHONPYCACHEPREFIX: 154. environment
     variable and *note -X: 155. ‘pycache_prefix’ command-line option to
     set an alternate root directory for writing module bytecode cache
     files.

   - bpo-25711(109): The *note zipimport: 143. module has been rewritten
     in pure Python.

   - bpo-33509(110): Fix module_globals parameter of
     warnings.warn_explicit(): don’t crash if module_globals is not a
     dict.

   - bpo-31849(111): Fix signed/unsigned comparison warning in pyhash.c.

   - bpo-33475(112): Fixed miscellaneous bugs in converting annotations
     to strings and optimized parentheses in the string representation.

   - bpo-20104(113): Added support for the ‘setpgroup’, ‘resetids’,
     ‘setsigmask’, ‘setsigdef’ and ‘scheduler’ parameters of
     ‘posix_spawn’.  Patch by Pablo Galindo.

   - bpo-33391(114): Fix a leak in set_symmetric_difference().

   - bpo-33363(115): Raise a SyntaxError for ‘async with’ and ‘async
     for’ statements outside of async functions.

   - bpo-28055(116): Fix unaligned accesses in siphash24().  Patch by
     Rolf Eike Beer.

   - bpo-33128(117): Fix a bug that causes PathFinder to appear twice on
     sys.meta_path.  Patch by Pablo Galindo Salgado.

   - bpo-33331(118): Modules imported last are now cleared first at
     interpreter shutdown.

   - bpo-33312(119): Fixed clang ubsan (undefined behavior sanitizer)
     warnings in dictobject.c by adjusting how the internal struct
     _dictkeysobject shared keys structure is declared.

   - bpo-33305(120): Improved syntax error messages for invalid
     numerical literals.

   - bpo-33306(121): Improved syntax error messages for unbalanced
     parentheses.

   - bpo-33234(122): The list constructor will pre-size and not
     over-allocate when the input length is known.

   - bpo-33270(123): Intern the names for all anonymous code objects.
     Patch by Zackery Spytz.

   - bpo-30455(124): The C and Python code and the documentation related
     to tokens are now generated from a single source file
     ‘Grammar/Tokens’.

   - bpo-33176(125): Add a ‘toreadonly()’ method to memoryviews.

   - bpo-33231(126): Fix potential memory leak in ‘normalizestring()’.

   - bpo-33205(127): Change dict growth function from
     ‘round_up_to_power_2(used*2+hashtable_size/2)’ to
     ‘round_up_to_power_2(used*3)’.  Previously, dict is shrinked only
     when ‘used == 0’.  Now dict has more chance to be shrinked.

   - bpo-29922(128): Improved error messages in ‘async with’ when
     ‘__aenter__()’ or ‘__aexit__()’ return non-awaitable object.

   - bpo-33199(129): Fix ‘ma_version_tag’ in dict implementation is
     uninitialized when copying from key-sharing dict.

   - bpo-33053(130): When using the -m switch, sys.path[0] is now
     explicitly expanded as the `starting' working directory, rather
     than being left as the empty path (which allows imports from the
     current working directory at the time of the import)

   - bpo-33138(131): Changed standard error message for non-pickleable
     and non-copyable types.  It now says “cannot pickle” instead of
     “can’t pickle” or “cannot serialize”.

   - bpo-33018(132): Improve consistency of errors raised by
     ‘issubclass()’ when called with a non-class and an abstract base
     class as the first and second arguments, respectively.  Patch by
     Josh Bronson.

   - bpo-33083(133): ‘math.factorial’ no longer accepts arguments that
     are not int-like.  Patch by Pablo Galindo.

   - bpo-33041(134): Added new opcode *note END_ASYNC_FOR: 2e0. and
     fixes the following issues:

        * Setting global *note StopAsyncIteration: f49. no longer breaks
          ‘async for’ loops.

        * Jumping into an ‘async for’ loop is now disabled.

        * Jumping out of an ‘async for’ loop no longer corrupts the
          stack.

   - bpo-25750(135): Fix rare Python crash due to bad refcounting in
     ‘type_getattro()’ if a descriptor deletes itself from the class.
     Patch by Jeroen Demeyer.

   - bpo-33041(136): Fixed bytecode generation for “async for” with a
     complex target.  A StopAsyncIteration raised on assigning or
     unpacking will be now propagated instead of stopping the iteration.

   - bpo-33026(137): Fixed jumping out of “with” block by setting
     f_lineno.

   - bpo-33005(138): Fix a crash on fork when using a custom memory
     allocator (ex: using PYTHONMALLOC env var).  _PyGILState_Reinit()
     and _PyInterpreterState_Enable() now use the default RAW memory
     allocator to allocate a new interpreters mutex on fork.

   - bpo-32911(139): Due to unexpected compatibility issues discovered
     during downstream beta testing, reverted bpo-29463(140).
     ‘docstring’ field is removed from Module, ClassDef, FunctionDef,
     and AsyncFunctionDef ast nodes which was added in 3.7a1.  Docstring
     expression is restored as a first statement in their body.  Based
     on patch by Inada Naoki.

   - bpo-17288(141): Prevent jumps from ‘return’ and ‘exception’ trace
     events.

   - bpo-32946(142): Importing names from already imported module with
     “from … import …” is now 30% faster if the module is not a package.

   - bpo-32932(143): Make error message more revealing when there are
     non-str objects in ‘__all__’.

   - bpo-32925(144): Optimized iterating and containing test for literal
     lists consisting of non-constants: ‘x in [a, b]’ and ‘for x in [a,
     b]’.  The case of all constant elements already was optimized.

   - bpo-32889(145): Update Valgrind suppression list to account for the
     rename of ‘Py_ADDRESS_IN_RANG’ to ‘address_in_range’.

   - bpo-32836(146): Don’t use temporary variables in cases of
     list/dict/set comprehensions

   - bpo-31356(147): Remove the new API added in bpo-31356(148)
     (gc.ensure_disabled() context manager).

   - bpo-32305(149): For namespace packages, ensure that both ‘__file__’
     and ‘__spec__.origin’ are set to None.

   - bpo-32303(150): Make sure ‘__spec__.loader’ matches ‘__loader__’
     for namespace packages.

   - bpo-32711(151): Fix the warning messages for Python/ast_unparse.c.
     Patch by Stéphane Wirtel

   - bpo-32583(152): Fix possible crashing in builtin Unicode decoders
     caused by write out-of-bound errors when using customized decode
     error handlers.

   - bpo-32489(153): A *note continue: 181. statement is now allowed in
     the *note finally: 182. clause.

   - bpo-17611(154): Simplified the interpreter loop by moving the logic
     of unrolling the stack of blocks into the compiler.  The compiler
     emits now explicit instructions for adjusting the stack of values
     and calling the cleaning up code for *note break: 2d9, *note
     continue: 181. and *note return: 190.

     Removed opcodes ‘BREAK_LOOP’, ‘CONTINUE_LOOP’, ‘SETUP_LOOP’ and
     ‘SETUP_EXCEPT’.  Added new opcodes *note ROT_FOUR: 2da, *note
     BEGIN_FINALLY: 2db. and *note CALL_FINALLY: 2dc. and *note
     POP_FINALLY: 2dd.  Changed the behavior of *note END_FINALLY: 2de.
     and *note WITH_CLEANUP_START: 2df.

   - bpo-32285(155): New function unicodedata.is_normalized, which can
     check whether a string is in a specific normal form.

   - bpo-10544(156): Yield expressions are now disallowed in
     comprehensions and generator expressions except the expression for
     the outermost iterable.

   - bpo-32117(157): Iterable unpacking is now allowed without
     parentheses in yield and return statements, e.g.  ‘yield 1, 2, 3,
     *rest’.  Thanks to David Cuthbert for the change and Jordan Chapman
     for added tests.

   - bpo-31902(158): Fix the ‘col_offset’ attribute for ast nodes
     ‘ast.AsyncFor’, ‘ast.AsyncFunctionDef’, and ‘ast.AsyncWith’.
     Previously, ‘col_offset’ pointed to the keyword after ‘async’.

   - bpo-25862(159): Fix assertion failures in the ‘tell()’ method of
     ‘io.TextIOWrapper’.  Patch by Zackery Spytz.

   - bpo-21983(160): Fix a crash in *note ctypes.cast(): f4a. in case
     the type argument is a ctypes structured data type.  Patch by Eryk
     Sun and Oren Milman.

   - bpo-31577(161): Fix a crash in *note os.utime(): a32. in case of a
     bad ns argument.  Patch by Oren Milman.

   - bpo-29832(162): Remove references to ‘getsockaddrarg’ from various
     socket error messages.  Patch by Oren Milman.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35877

   (2) https://bugs.python.org/issue35814

   (3) https://bugs.python.org/issue35766

   (4) https://bugs.python.org/issue35713

   (5) https://bugs.python.org/issue33416

   (6) https://bugs.python.org/issue35720

   (7) https://bugs.python.org/issue35634

   (8) https://bugs.python.org/issue35623

   (9) https://bugs.python.org/issue35214

   (10) https://bugs.python.org/issue35560

   (11) https://bugs.python.org/issue35552

   (12) https://bugs.python.org/issue35504

   (13) https://bugs.python.org/issue35504

   (14) https://bugs.python.org/issue35494

   (15) https://bugs.python.org/issue35444

   (16) https://bugs.python.org/issue35436

   (17) https://bugs.python.org/issue35423

   (18) https://bugs.python.org/issue35357

   (19) https://bugs.python.org/issue35372

   (20) https://bugs.python.org/issue35336

   (21) https://bugs.python.org/issue31241

   (22) https://bugs.python.org/issue33954

   (23) https://bugs.python.org/issue35269

   (24) https://bugs.python.org/issue35224

   (25) https://www.python.org/dev/peps/pep-0572

   (26) https://bugs.python.org/issue32492

   (27) https://bugs.python.org/issue35214

   (28) https://bugs.python.org/issue35214

   (29) https://bugs.python.org/issue35193

   (30) https://bugs.python.org/issue35169

   (31) https://bugs.python.org/issue34022

   (32) https://bugs.python.org/issue28401

   (33) https://bugs.python.org/issue29341

   (34) https://bugs.python.org/issue35050

   (35) https://bugs.python.org/issue29743

   (36) https://bugs.python.org/issue16806

   (37) https://bugs.python.org/issue35029

   (38) https://bugs.python.org/issue34983

   (39) https://bugs.python.org/issue34974

   (40) https://bugs.python.org/issue34939

   (41) https://bugs.python.org/issue34973

   (42) https://bugs.python.org/issue34876

   (43) https://bugs.python.org/issue34879

   (44) https://bugs.python.org/issue34784

   (45) https://bugs.python.org/issue32912

   (46) https://bugs.python.org/issue34854

   (47) https://bugs.python.org/issue34850

   (48) https://bugs.python.org/issue34824

   (49) https://bugs.python.org/issue30156

   (50) https://bugs.python.org/issue34762

   (51) https://bugs.python.org/issue34751

   (52) https://bugs.python.org/issue34735

   (53) https://bugs.python.org/issue34683

   (54) https://bugs.python.org/issue34651

   (55) https://bugs.python.org/issue34653

   (56) https://bugs.python.org/issue32236

   (57) https://bugs.python.org/issue34641

   (58) https://bugs.python.org/issue34637

   (59) https://bugs.python.org/issue1621

   (60) https://bugs.python.org/issue34588

   (61) https://bugs.python.org/issue34485

   (62) https://bugs.python.org/issue34485

   (63) https://bugs.python.org/issue34485

   (64) https://bugs.python.org/issue34485

   (65) https://bugs.python.org/issue34527

   (66) https://bugs.python.org/issue34527

   (67) https://bugs.python.org/issue34403

   (68) https://bugs.python.org/issue34523

   (69) https://bugs.python.org/issue12458

   (70) https://bugs.python.org/issue34408

   (71) https://bugs.python.org/issue34400

   (72) https://bugs.python.org/issue33073

   (73) https://bugs.python.org/issue34377

   (74) https://bugs.python.org/issue34353

   (75) https://bugs.python.org/issue34320

   (76) https://bugs.python.org/issue34113

   (77) https://bugs.python.org/issue34100

   (78) https://bugs.python.org/issue34151

   (79) https://bugs.python.org/issue34170

   (80) https://bugs.python.org/issue33237

   (81) https://bugs.python.org/issue34149

   (82) https://bugs.python.org/issue34125

   (83) https://bugs.python.org/issue34141

   (84) https://bugs.python.org/issue34126

   (85) https://bugs.python.org/issue24618

   (86) https://bugs.python.org/issue34068

   (87) https://bugs.python.org/issue34087

   (88) https://bugs.python.org/issue34080

   (89) https://bugs.python.org/issue34066

   (90) https://bugs.python.org/issue34042

   (91) https://bugs.python.org/issue33418

   (92) https://bugs.python.org/issue33985

   (93) https://bugs.python.org/issue33956

   (94) https://bugs.python.org/issue24596

   (95) https://bugs.python.org/issue33451

   (96) https://bugs.python.org/issue1617161

   (97) https://bugs.python.org/issue33824

   (98) https://bugs.python.org/issue33803

   (99) https://bugs.python.org/issue33738

   (100) https://bugs.python.org/issue33786

   (101) https://bugs.python.org/issue30167

   (102) https://bugs.python.org/issue33706

   (103) https://bugs.python.org/issue33597

   (104) https://bugs.python.org/issue30654

   (105) https://bugs.python.org/issue33622

   (106) https://bugs.python.org/issue33462

   (107) https://bugs.python.org/issue23722

   (108) https://bugs.python.org/issue33499

   (109) https://bugs.python.org/issue25711

   (110) https://bugs.python.org/issue33509

   (111) https://bugs.python.org/issue31849

   (112) https://bugs.python.org/issue33475

   (113) https://bugs.python.org/issue20104

   (114) https://bugs.python.org/issue33391

   (115) https://bugs.python.org/issue33363

   (116) https://bugs.python.org/issue28055

   (117) https://bugs.python.org/issue33128

   (118) https://bugs.python.org/issue33331

   (119) https://bugs.python.org/issue33312

   (120) https://bugs.python.org/issue33305

   (121) https://bugs.python.org/issue33306

   (122) https://bugs.python.org/issue33234

   (123) https://bugs.python.org/issue33270

   (124) https://bugs.python.org/issue30455

   (125) https://bugs.python.org/issue33176

   (126) https://bugs.python.org/issue33231

   (127) https://bugs.python.org/issue33205

   (128) https://bugs.python.org/issue29922

   (129) https://bugs.python.org/issue33199

   (130) https://bugs.python.org/issue33053

   (131) https://bugs.python.org/issue33138

   (132) https://bugs.python.org/issue33018

   (133) https://bugs.python.org/issue33083

   (134) https://bugs.python.org/issue33041

   (135) https://bugs.python.org/issue25750

   (136) https://bugs.python.org/issue33041

   (137) https://bugs.python.org/issue33026

   (138) https://bugs.python.org/issue33005

   (139) https://bugs.python.org/issue32911

   (140) https://bugs.python.org/issue29463

   (141) https://bugs.python.org/issue17288

   (142) https://bugs.python.org/issue32946

   (143) https://bugs.python.org/issue32932

   (144) https://bugs.python.org/issue32925

   (145) https://bugs.python.org/issue32889

   (146) https://bugs.python.org/issue32836

   (147) https://bugs.python.org/issue31356

   (148) https://bugs.python.org/issue31356

   (149) https://bugs.python.org/issue32305

   (150) https://bugs.python.org/issue32303

   (151) https://bugs.python.org/issue32711

   (152) https://bugs.python.org/issue32583

   (153) https://bugs.python.org/issue32489

   (154) https://bugs.python.org/issue17611

   (155) https://bugs.python.org/issue32285

   (156) https://bugs.python.org/issue10544

   (157) https://bugs.python.org/issue32117

   (158) https://bugs.python.org/issue31902

   (159) https://bugs.python.org/issue25862

   (160) https://bugs.python.org/issue21983

   (161) https://bugs.python.org/issue31577

   (162) https://bugs.python.org/issue29832


File: python.info,  Node: Library<12>,  Next: Documentation<12>,  Prev: Core and Builtins<12>,  Up: Python 3 8 0 alpha 1

1.18.12.3 Library
.................

   - bpo-35845(1): Add ‘order’ parameter to memoryview.tobytes().

   - bpo-35864(2): The _asdict() method for collections.namedtuple now
     returns a regular dict instead of an OrderedDict.

   - bpo-35537(3): An ExitStack is now used internally within
     subprocess.POpen to clean up pipe file handles.  No behavior change
     in normal operation.  But if closing one handle were ever to cause
     an exception, the others will now be closed instead of leaked.
     (patch by Giampaolo Rodola)

   - bpo-35847(4): RISC-V needed the CTYPES_PASS_BY_REF_HACK. Fixes
     ctypes Structure test_pass_by_value.

   - bpo-35813(5): Shared memory submodule added to multiprocessing to
     avoid need for serialization between processes

   - bpo-35780(6): Fix lru_cache() errors arising in recursive,
     reentrant, or multi-threaded code.  These errors could result in
     orphan links and in the cache being trapped in a state with fewer
     than the specified maximum number of links.  Fix handling of
     negative maxsize which should have been treated as zero.  Fix
     errors in toggling the “full” status flag.  Fix misordering of
     links when errors are encountered.  Sync-up the C code and pure
     Python code for the space saving path in functions with a single
     positional argument.  In this common case, the space overhead of an
     lru cache entry is reduced by almost half.  Fix counting of cache
     misses.  In error cases, the miss count was out of sync with the
     actual number of times the underlying user function was called.

   - bpo-35537(7): *note os.posix_spawn(): 255. and *note
     os.posix_spawnp(): f4c. now have a `setsid' parameter.

   - bpo-23846(8): *note asyncio.ProactorEventLoop: 1a9. now catches and
     logs send errors when the self-pipe is full.

   - bpo-34323(9): *note asyncio: a.: Enhance ‘IocpProactor.close()’
     log: wait 1 second before the first log, then log every second.
     Log also the number of seconds since ‘close()’ was called.

   - bpo-35674(10): Add a new *note os.posix_spawnp(): f4c. function.
     Patch by Joannah Nanjekye.

   - bpo-35733(11): ‘ast.Constant(boolean)’ no longer an instance of
     ‘ast.Num’.  Patch by Anthony Sottile.

   - bpo-35726(12): QueueHandler.prepare() now makes a copy of the
     record before modifying and enqueueing it, to avoid affecting other
     handlers in the chain.

   - bpo-35719(13): Sped up multi-argument *note math: b1. functions
     atan2(), copysign(), remainder() and hypot() by 1.3–2.5 times.

   - bpo-35717(14): Fix KeyError exception raised when using enums and
     compile.  Patch contributed by Rémi Lapeyre.

   - bpo-35699(15): Fixed detection of Visual Studio Build Tools 2017 in
     distutils

   - bpo-32710(16): Fix memory leaks in asyncio ProactorEventLoop on
     overlapped operation failure.

   - bpo-35702(17): The *note time.CLOCK_UPTIME_RAW: 237. constant is
     now available for macOS 10.12.

   - bpo-32710(18): Fix a memory leak in asyncio in the
     ProactorEventLoop when ‘ReadFile()’ or ‘WSASend()’ overlapped
     operation fail immediately: release the internal buffer.

   - bpo-35682(19): Fix ‘asyncio.ProactorEventLoop.sendfile()’: don’t
     attempt to set the result of an internal future if it’s already
     done.

   - bpo-35283(20): Add a deprecated warning for the
     ‘threading.Thread.isAlive()’ method.  Patch by Dong-hee Na.

   - bpo-35664(21): Improve operator.itemgetter() performance by 33%
     with optimized argument handling and with adding a fast path for
     the common case of a single non-negative integer index into a tuple
     (which is the typical use case in the standard library).

   - bpo-35643(22): Fixed a SyntaxWarning: invalid escape sequence in
     Modules/_sha3/cleanup.py.  Patch by Mickaël Schoentgen.

   - bpo-35619(23): Improved support of custom data descriptors in *note
     help(): 567. and *note pydoc: d9.

   - bpo-28503(24): The *note crypt: 29. module now internally uses the
     ‘crypt_r()’ library function instead of *note crypt(): 29. when
     available.

   - bpo-35614(25): Fixed help() on metaclasses.  Patch by Sanyam
     Khurana.

   - bpo-35568(26): Expose ‘raise(signum)’ as ‘raise_signal’

   - bpo-35588(27): The floor division and modulo operations and the
     *note divmod(): f4d. function on *note fractions.Fraction: 185.
     types are 2–4x faster.  Patch by Stefan Behnel.

   - bpo-35585(28): Speed-up building enums by value, e.g.
     http.HTTPStatus(200).

   - bpo-30561(29): random.gammavariate(1.0, beta) now computes the same
     result as random.expovariate(1.0 / beta).  This synchonizes the two
     algorithms and eliminates some idiosyncrasies in the old
     implementation.  It does however produce a difference stream of
     random variables than it used to.

   - bpo-35537(30): The *note subprocess: f9. module can now use the
     *note os.posix_spawn(): 255. function in some cases for better
     performance.

   - bpo-35526(31): Delaying the ‘joke’ of barry_as_FLUFL.mandatory to
     Python version 4.0

   - bpo-35523(32): Remove *note ctypes: 2b. callback workaround: no
     longer create a callback at startup.  Avoid SELinux alert on
     ‘import ctypes’ and ‘import uuid’.

   - bpo-31784(33): *note uuid.uuid1(): 408. now calls *note
     time.time_ns(): 318. rather than ‘int(time.time() * 1e9)’.

   - bpo-35513(34): ‘TextTestRunner’ of ‘unittest.runner’ now uses *note
     time.perf_counter(): 2a8. rather than *note time.time(): 312. to
     measure the execution time of a test: *note time.time(): 312. can
     go backwards, whereas *note time.perf_counter(): 2a8. is monotonic.

   - bpo-35502(35): Fixed reference leaks in *note
     xml.etree.ElementTree.TreeBuilder: 251. in case of unfinished
     building of the tree (in particular when an error was raised during
     parsing XML).

   - bpo-35348(36): Make *note platform.architecture(): f4e. parsing of
     ‘file’ command output more reliable: add the ‘-b’ option to the
     ‘file’ command to omit the filename, force the usage of the C
     locale, and search also the “shared object” pattern.

   - bpo-35491(37): *note multiprocessing: b7.: Add ‘Pool.__repr__()’
     and enhance ‘BaseProcess.__repr__()’ (add pid and parent pid) to
     ease debugging.  Pool state constant values are now strings instead
     of integers, for example ‘RUN’ value becomes ‘'RUN'’ instead of
     ‘0’.

   - bpo-35477(38): ‘multiprocessing.Pool.__enter__()’ now fails if the
     pool is not running: ‘with pool:’ fails if used more than once.

   - bpo-31446(39): Copy command line that was passed to CreateProcessW
     since this function can change the content of the input buffer.

   - bpo-35471(40): Python 2.4 dropped MacOS 9 support.  The macpath
     module was deprecated in Python 3.7.  The module is now removed.

   - bpo-23057(41): Unblock Proactor event loop when keyboard interrupt
     is received on Windows

   - bpo-35052(42): Fix xml.dom.minidom cloneNode() on a document with
     an entity: pass the correct arguments to the user data handler of
     an entity.

   - bpo-20239(43): Allow repeated assignment deletion of *note
     unittest.mock.Mock: 247. attributes.  Patch by Pablo Galindo.

   - bpo-17185(44): Set ‘__signature__’ on mock for *note inspect: a0.
     to get signature.  Patch by Karthikeyan Singaravelan.

   - bpo-35445(45): Memory errors during creating posix.environ no
     longer ignored.

   - bpo-35415(46): Validate fileno= argument to socket.socket().

   - bpo-35424(47): ‘multiprocessing.Pool’ destructor now emits *note
     ResourceWarning: 4c5. if the pool is still running.

   - bpo-35330(48): When a ‘Mock’ instance was used to wrap an object,
     if ‘side_effect’ is used in one of the mocks of it methods, don’t
     call the original implementation and return the result of using the
     side effect the same way that it is done with return_value.

   - bpo-35346(49): Drop Mac OS 9 and Rhapsody support from the *note
     platform: ce. module.  Rhapsody last release was in 2000.  Mac OS 9
     last release was in 2001.

   - bpo-10496(50): ‘check_environ()’ of ‘distutils.utils’ now catches
     *note KeyError: 2c5. on calling *note pwd.getpwuid(): f4f.: don’t
     create the ‘HOME’ environment variable in this case.

   - bpo-10496(51): ‘posixpath.expanduser()’ now returns the input
     `path' unchanged if the ‘HOME’ environment variable is not set and
     the current user has no home directory (if the current user
     identifier doesn’t exist in the password database).  This change
     fix the *note site: eb. module if the current user doesn’t exist in
     the password database (if the user has no home directory).

   - bpo-35389(52): *note platform.libc_ver(): f50. now uses
     ‘os.confstr('CS_GNU_LIBC_VERSION')’ if available and the
     `executable' parameter is not set.

   - bpo-35394(53): Add empty slots to asyncio abstract protocols.

   - bpo-35310(54): Fix a bug in *note select.select(): 667. where, in
     some cases, the file descriptor sequences were returned unmodified
     after a signal interruption, even though the file descriptors might
     not be ready yet.  *note select.select(): 667. will now always
     return empty lists if a timeout has occurred.  Patch by Oran
     Avraham.

   - bpo-35380(55): Enable TCP_NODELAY on Windows for proactor asyncio
     event loop.

   - bpo-35341(56): Add generic version of ‘collections.OrderedDict’ to
     the ‘typing’ module.  Patch by Ismo Toijala.

   - bpo-35371(57): Fixed possible crash in ‘os.utime()’ on Windows when
     pass incorrect arguments.

   - bpo-35346(58): *note platform.uname(): f51. now redirects ‘stderr’
     to *note os.devnull: f52. when running external programs like ‘cmd
     /c ver’.

   - bpo-35066(59): Previously, calling the strftime() method on a
     datetime object with a trailing ‘%’ in the format string would
     result in an exception.  However, this only occurred when the
     datetime C module was being used; the python implementation did not
     match this behavior.  Datetime is now PEP-399 compliant, and will
     not throw an exception on a trailing ‘%’.

   - bpo-35345(60): The function ‘platform.popen’ has been removed, it
     was deprecated since Python 3.3: use *note os.popen(): 2a7.
     instead.

   - bpo-35344(61): On macOS, *note platform.platform(): f53. now uses
     *note platform.mac_ver(): f54, if it returns a non-empty release
     string, to get the macOS version rather than the darwin version.

   - bpo-35312(62): Make ‘lib2to3.pgen2.parse.ParseError’ round-trip
     pickle-able.  Patch by Anthony Sottile.

   - bpo-35308(63): Fix regression in ‘webbrowser’ where default
     browsers may be preferred over browsers in the ‘BROWSER’
     environment variable.

   - bpo-24746(64): Avoid stripping trailing whitespace in doctest fancy
     diff.  Original patch by R. David Murray & Jairo Trad.  Enhanced by
     Sanyam Khurana.

   - bpo-28604(65): *note locale.localeconv(): 47f. now sets temporarily
     the ‘LC_CTYPE’ locale to the ‘LC_MONETARY’ locale if the two
     locales are different and monetary strings are non-ASCII. This
     temporary change affects other threads.

   - bpo-35277(66): Update ensurepip to install pip 18.1 and setuptools
     40.6.2.

   - bpo-24209(67): Adds IPv6 support when invoking http.server
     directly.

   - bpo-35226(68): Recursively check arguments when testing for
     equality of *note unittest.mock.call: eab. objects and add note
     that tracking of parameters used to create ancestors of mocks in
     ‘mock_calls’ is not possible.

   - bpo-29564(69): The warnings module now suggests to enable
     tracemalloc if the source is specified, the tracemalloc module is
     available, but tracemalloc is not tracing memory allocations.

   - bpo-35189(70): Modify the following fnctl function to retry if
     interrupted by a signal (EINTR): flock, lockf, fnctl

   - bpo-30064(71): Use add_done_callback() in sock_* asyncio API to
     unsubscribe reader/writer early on calcellation.

   - bpo-35186(72): Removed the “built with” comment added when
     ‘setup.py upload’ is used with either ‘bdist_rpm’ or ‘bdist_dumb’.

   - bpo-35152(73): Allow sending more than 2 GB at once on a
     multiprocessing connection on non-Windows systems.

   - bpo-35062(74): Fix incorrect parsing of
     ‘_io.IncrementalNewlineDecoder’’s `translate' argument.

   - bpo-35065(75): Remove ‘StreamReaderProtocol._untrack_reader’.  The
     call to ‘_untrack_reader’ is currently performed too soon, causing
     the protocol to forget about the reader before ‘connection_lost’
     can run and feed the EOF to the reader.

   - bpo-34160(76): ElementTree and minidom now preserve the attribute
     order specified by the user.

   - bpo-35079(77): Improve difflib.SequenceManager.get_matching_blocks
     doc by adding ‘non-overlapping’ and changing ‘!=’ to ‘<’.

   - bpo-33710(78): Deprecated ‘l*gettext()’ functions and methods in
     the *note gettext: 89. module.  They return encoded bytes instead
     of Unicode strings and are artifacts from Python 2 times.  Also
     deprecated functions and methods related to setting the charset for
     ‘l*gettext()’ functions and methods.

   - bpo-35017(79): *note socketserver.BaseServer.serve_forever(): a80.
     now exits immediately if it’s *note shutdown(): f55. method is
     called while it is polling for new events.

   - bpo-35024(80): *note importlib: 9b. no longer logs ‘wrote’
     redundantly after ‘(created|could not create)’ is already logged.
     Patch by Quentin Agren.

   - bpo-35047(81): ‘unittest.mock’ now includes mock calls in exception
     messages if ‘assert_not_called’, ‘assert_called_once’, or
     ‘assert_called_once_with’ fails.  Patch by Petter Strandmark.

   - bpo-31047(82): Fix ‘ntpath.abspath’ regression where it didn’t
     remove a trailing separator on Windows.  Patch by Tim Graham.

   - bpo-35053(83): tracemalloc now tries to update the traceback when
     an object is reused from a “free list” (optimization for faster
     object creation, used by the builtin list type for example).

   - bpo-31553(84): Add the –json-lines option to json.tool.  Patch by
     hongweipeng.

   - bpo-34794(85): Fixed a leak in Tkinter when pass the Python wrapper
     around Tcl_Obj back to Tcl/Tk.

   - bpo-34909(86): Enum: fix grandchildren subclassing when parent
     mixed with concrete data types.

   - bpo-35022(87): *note unittest.mock.MagicMock: 779. now supports the
     ‘__fspath__’ method (from *note os.PathLike: 4e0.).

   - bpo-35008(88): Fixed references leaks when call the
     ‘__setstate__()’ method of *note xml.etree.ElementTree.Element:
     ab9. in the C implementation for already initialized element.

   - bpo-23420(89): Verify the value for the parameter ‘-s’ of the
     cProfile CLI. Patch by Robert Kuska

   - bpo-33947(90): dataclasses now handle recursive reprs without
     raising RecursionError.

   - bpo-34890(91): Make *note inspect.iscoroutinefunction(): 6ec, *note
     inspect.isgeneratorfunction(): f56. and *note
     inspect.isasyncgenfunction(): f57. work with *note
     functools.partial(): 7bc.  Patch by Pablo Galindo.

   - bpo-34521(92): Use *note socket.CMSG_SPACE(): f58. to calculate
     ancillary data size instead of *note socket.CMSG_LEN(): f59. in
     ‘multiprocessing.reduction.recvfds()’ as RFC 3542(93) requires the
     use of the former for portable applications.

   - bpo-31522(94): The ‘mailbox.mbox.get_string’ function `from_'
     parameter can now successfully be set to a non-default value.

   - bpo-34970(95): Protect tasks weak set manipulation in
     ‘asyncio.all_tasks()’

   - bpo-34969(96): gzip: Add –fast, –best on the gzip CLI, these
     parameters will be used for the fast compression method (quick) or
     the best method compress (slower, but smaller file).  Also, change
     the default compression level to 6 (tradeoff).

   - bpo-16965(97): The *note 2to3: f5a. *note execfile: f5b. fixer now
     opens the file with mode ‘'rb'’.  Patch by Zackery Spytz.

   - bpo-34966(98): *note pydoc: d9. now supports aliases not only to
     methods defined in the end class, but also to inherited methods.
     The docstring is not duplicated for aliases.

   - bpo-34926(99): *note mimetypes.MimeTypes.guess_type(): f5c. now
     accepts *note path-like object: 35f. in addition to url strings.
     Patch by Mayank Asthana.

   - bpo-23831(100): Add ‘moveto()’ method to the ‘tkinter.Canvas’
     widget.  Patch by Juliette Monsel.

   - bpo-34941(101): Methods ‘find()’, ‘findtext()’ and ‘findall()’ of
     the ‘Element’ class in the *note xml.etree.ElementTree: 137. module
     are now able to find children which are instances of ‘Element’
     subclasses.

   - bpo-32680(102): *note smtplib.SMTP: a76. objects now always have a
     ‘sock’ attribute present

   - bpo-34769(103): Fix for async generators not finalizing when event
     loop is in debug mode and garbage collector runs in another thread.

   - bpo-34936(104): Fix ‘TclError’ in
     ‘tkinter.Spinbox.selection_element()’.  Patch by Juliette Monsel.

   - bpo-34829(105): Add methods ‘selection_from’, ‘selection_range’,
     ‘selection_present’ and ‘selection_to’ to the ‘tkinter.Spinbox’ for
     consistency with the ‘tkinter.Entry’ widget.  Patch by Juliette
     Monsel.

   - bpo-34911(106): Added `secure_protocols' argument to
     `http.cookiejar.DefaultCookiePolicy' to allow for tweaking of
     protocols and also to add support by default for `wss', the secure
     websocket protocol.

   - bpo-34922(107): Fixed integer overflow in the *note digest(): f5d.
     and *note hexdigest(): f5e. methods for the SHAKE algorithm in the
     *note hashlib: 8d. module.

   - bpo-34925(108): 25% speedup in argument parsing for the functions
     in the bisect module.

   - bpo-34900(109): Fixed *note unittest.TestCase.debug(): f5f. when
     used to call test methods with subtests.  Patch by Bruno Oliveira.

   - bpo-34844(110): logging.Formatter enhancement - Ensure styles and
     fmt matches in logging.Formatter - Added validate method in each
     format style class: StrFormatStyle, PercentStyle,
     StringTemplateStyle.  - This method is called in the constructor of
     logging.Formatter class - Also re-raise the KeyError in the format
     method of each style class, so it would a bit clear that it’s an
     error with the invalid format fields.

   - bpo-34897(111): Adjust test.support.missing_compiler_executable
     check so that a nominal command name of “” is ignored.  Patch by
     Michael Felt.

   - bpo-34871(112): Fix inspect module polluted ‘sys.modules’ when
     parsing ‘__text_signature__’ of callable.

   - bpo-34898(113): Add ‘mtime’ argument to *note gzip.compress: 1cf.
     for reproducible output.  Patch by Guo Ci Teo.

   - bpo-28441(114): On Cygwin and MinGW, ensure that ‘sys.executable’
     always includes the full filename in the path, including the ‘.exe’
     suffix (unless it is a symbolic link).

   - bpo-34866(115): Adding ‘max_num_fields’ to ‘cgi.FieldStorage’ to
     make DOS attacks harder by limiting the number of
     ‘MiniFieldStorage’ objects created by ‘FieldStorage’.

   - bpo-34711(116): http.server ensures it reports HTTPStatus.NOT_FOUND
     when the local path ends with “/” and is not a directory, even if
     the underlying OS (e.g.  AIX) accepts such paths as a valid file
     reference.  Patch by Michael Felt.

   - bpo-34872(117): Fix self-cancellation in C implementation of
     asyncio.Task

   - bpo-34849(118): Don’t log waiting for ‘selector.select’ in asyncio
     loop iteration.  The waiting is pretty normal for any asyncio
     program, logging its time just adds a noise to logs without any
     useful information provided.

   - bpo-34022(119): The ‘SOURCE_DATE_EPOCH’ environment variable no
     longer overrides the value of the `invalidation_mode' argument to
     *note py_compile.compile(): 213, and determines its default value
     instead.

   - bpo-34819(120): Use a monotonic clock to compute timeouts in
     ‘Executor.map()’ and ‘as_completed()’, in order to prevent timeouts
     from deviating when the system clock is adjusted.

   - bpo-34758(121): Add .wasm -> application/wasm to list of recognized
     file types and content type headers

   - bpo-34789(122): *note xml.sax.make_parser(): f60. now accepts any
     iterable as its `parser_list' argument.  Patch by Andrés Delfino.

   - bpo-34334(123): In ‘QueueHandler’, clear ‘exc_text’ from
     ‘LogRecord’ to prevent traceback from being written twice.

   - bpo-34687(124): On Windows, asyncio now uses ProactorEventLoop,
     instead of SelectorEventLoop, by default.

   - bpo-5950(125): Support reading zip files with archive comments in
     *note zipimport: 143.

   - bpo-32892(126): The parser now represents all constants as
     ‘ast.Constant’ instead of using specific constant AST types (‘Num’,
     ‘Str’, ‘Bytes’, ‘NameConstant’ and ‘Ellipsis’).  These classes are
     considered deprecated and will be removed in future Python
     versions.

   - bpo-34728(127): Add deprecation warning when ‘loop’ is used in
     methods: *note asyncio.sleep: 283, *note asyncio.wait: 287. and
     *note asyncio.wait_for: 286.

   - bpo-34738(128): ZIP files created by *note distutils: 39. will now
     include entries for directories.

   - bpo-34659(129): Add an optional `initial' argument to
     itertools.accumulate().

   - bpo-29577(130): Support multiple mixin classes when creating Enums.

   - bpo-34670(131): Add SSLContext.post_handshake_auth and
     SSLSocket.verify_client_post_handshake for TLS 1.3’s post handshake
     authentication feature.

   - bpo-32718(132): The Activate.ps1 script from venv works with
     PowerShell Core 6.1 and is now available under all operating
     systems.

   - bpo-31177(133): Fix bug that prevented using *note reset_mock: 59f.
     on mock instances with deleted attributes

   - bpo-34672(134): Add a workaround, so the ‘'Z'’ *note
     time.strftime(): b58. specifier on the musl C library can work in
     some cases.

   - bpo-34666(135): Implement ‘asyncio.StreamWriter.awrite’ and
     ‘asyncio.StreamWriter.aclose()’ coroutines.  Methods are needed for
     providing a consistent stream API with control flow switched on by
     default.

   - bpo-6721(136): Acquire the logging module’s commonly used internal
     locks while fork()ing to avoid deadlocks in the child process.

   - bpo-34658(137): Fix a rare interpreter unhandled exception state
     SystemError only seen when using subprocess with a preexec_fn while
     an after_parent handler has been registered with
     os.register_at_fork and the fork system call fails.

   - bpo-34652(138): Ensure *note os.lchmod(): f61. is never defined on
     Linux.

   - bpo-34638(139): Store a weak reference to stream reader to break
     strong references loop between reader and protocol.  It allows to
     detect and close the socket if the stream is deleted (garbage
     collected) without ‘close()’ call.

   - bpo-34536(140): ‘Enum._missing_’: raise *note ValueError: 1f9. if
     None returned and *note TypeError: 192. if non-member is returned.

   - bpo-34636(141): Speed up re scanning of many non-matching
     characters for s w and d within bytes objects.  (microoptimization)

   - bpo-24412(142): Add *note addModuleCleanup(): 248. and *note
     addClassCleanup(): 249. to unittest to support cleanups for
     ‘setUpModule()’ and *note setUpClass(): 24a.  Patch by Lisa Roach.

   - bpo-34630(143): Don’t log SSL certificate errors in asyncio code
     (connection error logging is skipped already).

   - bpo-32490(144): Prevent filename duplication in *note subprocess:
     f9. exception messages.  Patch by Zackery Spytz.

   - bpo-34363(145): dataclasses.asdict() and .astuple() now handle
     namedtuples correctly.

   - bpo-34625(146): Update vendorized expat library version to 2.2.6.

   - bpo-32270(147): The subprocess module no longer mistakenly closes
     redirected fds even when they were in pass_fds when outside of the
     default {0, 1, 2} set.

   - bpo-34622(148): Create a dedicated ‘asyncio.CancelledError’,
     ‘asyncio.InvalidStateError’ and ‘asyncio.TimeoutError’ exception
     classes.  Inherit them from corresponding exceptions from
     ‘concurrent.futures’ package.  Extract ‘asyncio’ exceptions into a
     separate file.

   - bpo-34610(149): Fixed iterator of
     ‘multiprocessing.managers.DictProxy’.

   - bpo-34421(150): Fix distutils logging for non-ASCII strings.  This
     caused installation issues on Windows.

   - bpo-34604(151): Fix possible mojibake in the error message of *note
     pwd.getpwnam: f62. and *note grp.getgrnam: f63. using string
     representation because of invisible characters or trailing
     whitespaces.  Patch by William Grzybowski.

   - bpo-30977(152): Make uuid.UUID use ‘__slots__’ to reduce its memory
     footprint.  Based on original patch by Wouter Bolsterlee.

   - bpo-34574(153): OrderedDict iterators are not exhausted during
     pickling anymore.  Patch by Sergey Fedoseev.

   - bpo-8110(154): Refactored *note subprocess: f9. to check for
     Windows-specific modules rather than ‘sys.platform == 'win32'’.

   - bpo-34530(155): ‘distutils.spawn.find_executable()’ now falls back
     on *note os.defpath: f12. if the ‘PATH’ environment variable is not
     set.

   - bpo-34563(156): On Windows, fix multiprocessing.Connection for very
     large read: fix _winapi.PeekNamedPipe() and _winapi.ReadFile() for
     read larger than INT_MAX (usually 2^31-1).

   - bpo-34558(157): Correct typo in Lib/ctypes/_aix.py

   - bpo-34282(158): Move ‘Enum._convert’ to ‘EnumMeta._convert_’ and
     fix enum members getting shadowed by parent attributes.

   - bpo-22872(159): When the queue is closed, *note ValueError: 1f9. is
     now raised by *note multiprocessing.Queue.put(): f64. and *note
     multiprocessing.Queue.get(): f65. instead of *note AssertionError:
     f66. and *note OSError: 1d1, respectively.  Patch by Zackery Spytz.

   - bpo-34515(160): Fix parsing non-ASCII identifiers in
     ‘lib2to3.pgen2.tokenize’ (PEP 3131).

   - bpo-13312(161): Avoids a possible integer underflow (undefined
     behavior) in the time module’s year handling code when passed a
     very low negative year value.

   - bpo-34472(162): Improved compatibility for streamed files in *note
     zipfile: 142.  Previously an optional signature was not being
     written and certain ZIP applications were not supported.  Patch by
     Silas Sewell.

   - bpo-34454(163): Fix the .fromisoformat() methods of datetime types
     crashing when given unicode with non-UTF-8-encodable code points.
     Specifically, datetime.fromisoformat() now accepts surrogate
     unicode code points used as the separator.  Report and tests by
     Alexey Izbyshev, patch by Paul Ganssle.

   - bpo-6700(164): Fix inspect.getsourcelines for module level
     frames/tracebacks.  Patch by Vladimir Matveev.

   - bpo-34171(165): Running the *note trace: 112. module no longer
     creates the ‘trace.cover’ file.

   - bpo-34441(166): Fix crash when an ‘ABC’-derived class with invalid
     ‘__subclasses__’ is passed as the second argument to *note
     issubclass(): 445.  Patch by Alexey Izbyshev.

   - bpo-34427(167): Fix infinite loop in ‘a.extend(a)’ for
     ‘MutableSequence’ subclasses.

   - bpo-34412(168): Make *note signal.strsignal(): f67. work on HP-UX.
     Patch by Michael Osipov.

   - bpo-20849(169): shutil.copytree now accepts a new ‘dirs_exist_ok’
     keyword argument.  Patch by Josh Bronson.

   - bpo-31715(170): Associate ‘.mjs’ file extension with
     ‘application/javascript’ MIME Type.

   - bpo-34384(171): *note os.readlink(): 1f1. now accepts *note
     path-like: 35f. and *note bytes: 326. objects on Windows.

   - bpo-22602(172): The UTF-7 decoder now raises *note
     UnicodeDecodeError: 1fb. for ill-formed sequences starting with “+”
     (as specified in RFC 2152).  Patch by Zackery Spytz.

   - bpo-2122(173): The *note mmap.flush(): 2c1. method now returns
     ‘None’ on success, raises an exception on error under all
     platforms.

   - bpo-34341(174): Appending to the ZIP archive with the ZIP64
     extension no longer grows the size of extra fields of existing
     entries.

   - bpo-34333(175): Fix %-formatting in *note
     pathlib.PurePath.with_suffix(): f68. when formatting an error
     message.

   - bpo-18540(176): The *note imaplib.IMAP4: 600. and *note
     imaplib.IMAP4_SSL: a0c. classes now resolve to the local host IP
     correctly when the default value of `host' parameter (‘''’) is
     used.

   - bpo-26502(177): Implement ‘traceback.FrameSummary.__len__()’ method
     to preserve compatibility with the old tuple API.

   - bpo-34318(178): *note assertRaises(): aaf, *note
     assertRaisesRegex(): ab0, *note assertWarns(): ab1. and *note
     assertWarnsRegex(): ab2. no longer success if the passed callable
     is None.  They no longer ignore unknown keyword arguments in the
     context manager mode.  A DeprecationWarning was raised in these
     cases since Python 3.5.

   - bpo-9372(179): Deprecate *note __getitem__(): 27a. methods of *note
     xml.dom.pulldom.DOMEventStream: 27b, *note
     wsgiref.util.FileWrapper: 27c. and *note fileinput.FileInput: 27d.

   - bpo-33613(180): Fix a race condition in
     ‘multiprocessing.semaphore_tracker’ when the tracker receives
     SIGINT before it can register signal handlers for ignoring it.

   - bpo-34248(181): Report filename in the exception raised when the
     database file cannot be opened by *note dbm.gnu.open(): f69. and
     *note dbm.ndbm.open(): f6a. due to OS-related error.  Patch by
     Zsolt Cserna.

   - bpo-33089(182): Add math.dist() to compute the Euclidean distance
     between two points.

   - bpo-34246(183): *note smtplib.SMTP.send_message(): 739. no longer
     modifies the content of the `mail_options' argument.  Patch by
     Pablo S. Blum de Aguiar.

   - bpo-31047(184): Fix ‘ntpath.abspath’ for invalid paths on windows.
     Patch by Franz Woellert.

   - bpo-32321(185): Add pure Python fallback for functools.reduce.
     Patch by Robert Wright.

   - bpo-34270(186): The default asyncio task class now always has a
     name which can be get or set using two new methods (*note
     get_name(): 1af. and *note set_name(): 1ae.) and is visible in the
     *note repr(): 7c0. output.  An initial name can also be set using
     the new ‘name’ keyword argument to *note asyncio.create_task():
     1ac. or the ‘create_task()’ method of the event loop.  If no
     initial name is set, the default Task implementation generates a
     name like ‘Task-1’ using a monotonic counter.

   - bpo-34263(187): asyncio’s event loop will not pass timeouts longer
     than one day to epoll/select etc.

   - bpo-34035(188): Fix several AttributeError in zipfile seek()
     methods.  Patch by Mickaël Schoentgen.

   - bpo-32215(189): Fix performance regression in *note sqlite3: f2.
     when a DML statement appeared in a different line than the rest of
     the SQL query.

   - bpo-34075(190): Deprecate passing non-ThreadPoolExecutor instances
     to ‘AbstractEventLoop.set_default_executor()’.

   - bpo-34251(191): Restore ‘msilib.Win64’ to preserve backwards
     compatibility since it’s already used by *note distutils: 39.’
     ‘bdist_msi’ command.

   - bpo-19891(192): Ignore errors caused by missing / non-writable
     homedir while writing history during exit of an interactive
     session.  Patch by Anthony Sottile.

   - bpo-33089(193): Enhanced math.hypot() to support more than two
     dimensions.

   - bpo-34228(194): tracemalloc: PYTHONTRACEMALLOC=0 environment
     variable and -X tracemalloc=0 command line option are now allowed
     to disable explicitly tracemalloc at startup.

   - bpo-13041(195): Use *note shutil.get_terminal_size(): a3f. to
     calculate the terminal width correctly in the
     ‘argparse.HelpFormatter’ class.  Initial patch by Zbyszek
     Jędrzejewski-Szmek.

   - bpo-34213(196): Allow frozen dataclasses to have a field named
     “object”.  Previously this conflicted with an internal use of
     “object”.

   - bpo-34052(197): *note sqlite3.Connection.create_aggregate(): ece,
     *note sqlite3.Connection.create_function(): ecf, *note
     sqlite3.Connection.set_authorizer(): ed0, *note
     sqlite3.Connection.set_progress_handler(): ed1. methods raises
     TypeError when unhashable objects are passed as callable.  These
     methods now don’t pass such objects to SQLite API. Previous
     behavior could lead to segfaults.  Patch by Sergey Fedoseev.

   - bpo-34197(198): Attributes `skipinitialspace', `doublequote' and
     `strict' of the `dialect' attribute of the *note csv: 2a. reader
     are now *note bool: 183. instances instead of integers 0 or 1.

   - bpo-32788(199): Errors other than *note TypeError: 192. raised in
     methods ‘__adapt__()’ and ‘__conform__()’ in the *note sqlite3: f2.
     module are now propagated to the user.

   - bpo-21446(200): The *note reload: f6b. fixer now uses *note
     importlib.reload(): 38e. instead of deprecated *note imp.reload():
     c63.

   - bpo-940286(201): pydoc’s ‘Helper.showtopic()’ method now prints the
     cross references of a topic correctly.

   - bpo-34164(202): *note base64.b32decode(): 951. could raise
     UnboundLocalError or OverflowError for incorrect padding.  Now it
     always raises ‘base64.Error’ in these cases.

   - bpo-33729(203): Fixed issues with arguments parsing in *note
     hashlib: 8d.

   - bpo-34097(204): ZipFile can zip files older than 1980-01-01 and
     newer than 2107-12-31 using a new ‘strict_timestamps’ parameter at
     the cost of setting the timestamp to the limit.

   - bpo-34108(205): Remove extraneous CR in 2to3 refactor.

   - bpo-34070(206): Make sure to only check if the handle is a tty,
     when opening a file with ‘buffering=-1’.

   - bpo-27494(207): Reverted bpo-27494(208).  2to3 rejects now a
     trailing comma in generator expressions.

   - bpo-33967(209): functools.singledispatch now raises TypeError
     instead of IndexError when no positional arguments are passed.

   - bpo-34041(210): Add the parameter `deterministic' to the *note
     sqlite3.Connection.create_function(): ecf. method.  Patch by Sergey
     Fedoseev.

   - bpo-34056(211): Ensure the loader shim created by ‘imp.load_module’
     always returns bytes from its ‘get_data()’ function.  This fixes
     using ‘imp.load_module’ with PEP 552(212) hash-based pycs.

   - bpo-34054(213): The multiprocessing module now uses the monotonic
     clock *note time.monotonic(): 763. instead of the system clock
     *note time.time(): 312. to implement timeout.

   - bpo-34043(214): Optimize tarfile uncompress performance about 15%
     when gzip is used.

   - bpo-34044(215): ‘subprocess.Popen’ now copies the `startupinfo'
     argument to leave it unchanged: it will modify the copy, so that
     the same ‘STARTUPINFO’ object can be used multiple times.

   - bpo-34010(216): Fixed a performance regression for reading streams
     with tarfile.  The buffered read should use a list, instead of
     appending to a bytes object.

   - bpo-34019(217): webbrowser: Correct the arguments passed to Opera
     Browser when opening a new URL using the ‘webbrowser’ module.
     Patch by Bumsik Kim.

   - bpo-34003(218): csv.DictReader now creates dicts instead of
     OrderedDicts.  Patch by Michael Selik.

   - bpo-33978(219): Closed existing logging handlers before
     reconfiguration via fileConfig and dictConfig.  Patch by
     Karthikeyan Singaravelan.

   - bpo-14117(220): Make minor tweaks to turtledemo.  The ‘wikipedia’
     example is now ‘rosette’, describing what it draws.  The ‘penrose’
     print output is reduced.  The’1024’ output of ‘tree’ is eliminated.

   - bpo-33974(221): Fixed passing lists and tuples of strings
     containing special characters ‘"’, ‘\’, ‘{’, ‘}’ and ‘\n’ as
     options to *note ttk: 10f. widgets.

   - bpo-27500(222): Fix getaddrinfo to resolve IPv6 addresses
     correctly.

   - bpo-24567(223): Improve random.choices() to handle subnormal input
     weights that could occasionally trigger an IndexError.

   - bpo-33871(224): Fixed integer overflow in *note os.readv(): 3ad,
     *note os.writev(): 3b0, *note os.preadv(): 3ac. and *note
     os.pwritev(): 3af. and in *note os.sendfile(): 34e. with `headers'
     or `trailers' arguments (on BSD-based OSes and macOS).

   - bpo-25007(225): Add *note copy.copy(): 3c0. and *note
     copy.deepcopy(): 3c1. support to zlib compressors and
     decompressors.  Patch by Zackery Spytz.

   - bpo-33929(226): multiprocessing: Fix a race condition in Popen of
     multiprocessing.popen_spawn_win32.  The child process now
     duplicates the read end of pipe instead of “stealing” it.
     Previously, the read end of pipe was “stolen” by the child process,
     but it leaked a handle if the child process had been terminated
     before it could steal the handle from the parent process.

   - bpo-33899(227): Tokenize module now implicitly emits a NEWLINE when
     provided with input that does not have a trailing new line.  This
     behavior now matches what the C tokenizer does internally.
     Contributed by Ammar Askar.

   - bpo-33897(228): Added a ‘force’ keyword argument to
     logging.basicConfig().

   - bpo-33695(229): *note shutil.copytree(): 218. uses *note
     os.scandir(): 25d. function and all copy functions depending from
     it use cached *note os.stat(): 1ef. values.  The speedup for
     copying a directory with 8000 files is around +9% on Linux, +20% on
     Windows and + 30% on a Windows SMB share.  Also the number of *note
     os.stat(): 1ef. syscalls is reduced by 38% making *note
     shutil.copytree(): 218. especially faster on network filesystems.
     (Contributed by Giampaolo Rodola’ in bpo-33695(230).)

   - bpo-33916(231): bz2 and lzma: When Decompressor.__init__() is
     called twice, free the old lock to not leak memory.

   - bpo-32568(232): Make select.epoll() and its documentation
     consistent regarding `sizehint' and `flags'.

   - bpo-33833(233): Fixed bug in asyncio where ProactorSocketTransport
     logs AssertionError if force closed during write.

   - bpo-33663(234): Convert content length to string before putting to
     header.

   - bpo-33721(235): *note os.path: c5. functions that return a boolean
     result like *note exists(): 1f4, *note lexists(): 1f5, *note
     isdir(): 1f6, *note isfile(): 1f7, *note islink(): 1f2, and *note
     ismount(): 1f8, and *note pathlib.Path: 1ff. methods that return a
     boolean result like *note exists(): 200, *note is_dir(): 201, *note
     is_file(): 202, *note is_mount(): 203, *note is_symlink(): 204,
     *note is_block_device(): 205, *note is_char_device(): 206, *note
     is_fifo(): 207, *note is_socket(): 208. now return ‘False’ instead
     of raising *note ValueError: 1f9. or its subclasses *note
     UnicodeEncodeError: 1fa. and *note UnicodeDecodeError: 1fb. for
     paths that contain characters or bytes unrepresentable at the OS
     level.

   - bpo-26544(236): Fixed implementation of *note platform.libc_ver():
     f50.  It almost always returned version ‘2.9’ for glibc.

   - bpo-33843(237): Remove deprecated ‘cgi.escape’, ‘cgi.parse_qs’ and
     ‘cgi.parse_qsl’.

   - bpo-33842(238): Remove ‘tarfile.filemode’ which is deprecated since
     Python 3.3.

   - bpo-30167(239): Prevent site.main() exception if PYTHONSTARTUP is
     set.  Patch by Steve Weber.

   - bpo-33805(240): Improve error message of dataclasses.replace() when
     an InitVar is not specified

   - bpo-33687(241): Fix the call to ‘os.chmod()’ for ‘uu.decode()’ if a
     mode is given or decoded.  Patch by Timo Furrer.

   - bpo-33812(242): Datetime instance d with non-None tzinfo, but with
     d.tzinfo.utcoffset(d) returning None is now treated as naive by the
     astimezone() method.

   - bpo-32108(243): In configparser, don’t clear section when it is
     assigned to itself.

   - bpo-27397(244): Make email module properly handle invalid-length
     base64 strings.

   - bpo-33578(245): Implement multibyte encoder/decoder state methods

   - bpo-30805(246): Avoid race condition with debug logging

   - bpo-33476(247): Fix _header_value_parser.py when address group is
     missing final ‘;’.  Contributed by Enrique Perez-Terron

   - bpo-33694(248): asyncio: Fix a race condition causing data loss on
     pause_reading()/resume_reading() when using the ProactorEventLoop.

   - bpo-32493(249): Correct test for ‘uuid_enc_be’ availability in
     ‘configure.ac’.  Patch by Michael Felt.

   - bpo-33792(250): Add asyncio.WindowsSelectorEventLoopPolicy and
     asyncio.WindowsProactorEventLoopPolicy.

   - bpo-33274(251): W3C DOM Level 1 specifies return value of
     Element.removeAttributeNode() as “The Attr node that was removed.”
     xml.dom.minidom now complies with this requirement.

   - bpo-33778(252): Update ‘unicodedata’’s database to Unicode version
     11.0.0.

   - bpo-33165(253): Added a stacklevel parameter to logging calls to
     allow use of wrapper/helper functions for logging APIs.

   - bpo-33770(254): improve base64 exception message for encoded inputs
     of invalid length

   - bpo-33769(255): asyncio/start_tls: Fix error message; cancel
     callbacks in case of an unhandled error; mark SSLTransport as
     closed if it is aborted.

   - bpo-33767(256): The concatenation (‘+’) and repetition (‘*’)
     sequence operations now raise *note TypeError: 192. instead of
     *note SystemError: 5f0. when performed on *note mmap.mmap: 1ea.
     objects.  Patch by Zackery Spytz.

   - bpo-33734(257): asyncio/ssl: Fix AttributeError, increase default
     handshake timeout

   - bpo-31014(258): Fixed creating a controller for *note webbrowser:
     129. when a user specifies a path to an entry in the BROWSER
     environment variable.  Based on patch by John Still.

   - bpo-2504(259): Add gettext.pgettext() and variants.

   - bpo-33197(260): Add description property for _ParameterKind

   - bpo-32751(261): When cancelling the task due to a timeout, *note
     asyncio.wait_for(): 286. will now wait until the cancellation is
     complete.

   - bpo-32684(262): Fix gather to propagate cancellation of itself even
     with return_exceptions.

   - bpo-33654(263): Support protocol type switching in
     SSLTransport.set_protocol().

   - bpo-33674(264): Pause the transport as early as possible to further
     reduce the risk of data_received() being called before
     connection_made().

   - bpo-33671(265): *note shutil.copyfile(): 256, *note shutil.copy():
     257, *note shutil.copy2(): 258, *note shutil.copytree(): 218. and
     *note shutil.move(): 259. use platform-specific fast-copy syscalls
     on Linux and macOS in order to copy the file more efficiently.  On
     Windows *note shutil.copyfile(): 256. uses a bigger default buffer
     size (1 MiB instead of 16 KiB) and a *note memoryview(): 25a.-based
     variant of *note shutil.copyfileobj(): 25b. is used.  The speedup
     for copying a 512MiB file is about +26% on Linux, +50% on macOS and
     +40% on Windows.  Also, much less CPU cycles are consumed.
     (Contributed by Giampaolo Rodola’ in bpo-25427(266).)

   - bpo-33674(267): Fix a race condition in
     SSLProtocol.connection_made() of asyncio.sslproto: start
     immediately the handshake instead of using call_soon().
     Previously, data_received() could be called before the handshake
     started, causing the handshake to hang or fail.

   - bpo-31647(268): Fixed bug where calling write_eof() on a
     _SelectorSocketTransport after it’s already closed raises
     AttributeError.

   - bpo-32610(269): Make asyncio.all_tasks() return only pending tasks.

   - bpo-32410(270): Avoid blocking on file IO in sendfile fallback code

   - bpo-33469(271): Fix RuntimeError after closing loop that used
     run_in_executor

   - bpo-33672(272): Fix Task.__repr__ crash with Cython’s bogus
     coroutines

   - bpo-33654(273): Fix transport.set_protocol() to support switching
     between asyncio.Protocol and asyncio.BufferedProtocol.  Fix
     loop.start_tls() to work with asyncio.BufferedProtocols.

   - bpo-33652(274): Pickles of type variables and subscripted generics
     are now future-proof and compatible with older Python versions.

   - bpo-32493(275): Fixed *note uuid.uuid1(): 408. on FreeBSD.

   - bpo-33238(276): Add ‘InvalidStateError’ to *note
     concurrent.futures: 22.  ‘Future.set_result’ and
     ‘Future.set_exception’ now raise ‘InvalidStateError’ if the futures
     are not pending or running.  Patch by Jason Haydaman.

   - bpo-33618(277): Finalize and document preliminary and experimental
     TLS 1.3 support with OpenSSL 1.1.1

   - bpo-33625(278): Release GIL on *note grp.getgrnam: f63, *note
     grp.getgrgid: 5d4, *note pwd.getpwnam: f62. and *note pwd.getpwuid:
     f4f. if reentrant variants of these functions are available.  Patch
     by William Grzybowski.

   - bpo-33623(279): Fix possible SIGSGV when asyncio.Future is created
     in __del__

   - bpo-11874(280): Use a better regex when breaking usage into
     wrappable parts.  Avoids bogus assertion errors from custom metavar
     strings.

   - bpo-30877(281): Fixed a bug in the Python implementation of the
     JSON decoder that prevented the cache of parsed strings from
     clearing after finishing the decoding.  Based on patch by c-fos.

   - bpo-33604(282): Remove HMAC default to md5 marked for removal in
     3.8 (removal originally planned in 3.6, bump to 3.8 in gh-7062).

   - bpo-33582(283): Emit a deprecation warning for
     inspect.formatargspec

   - bpo-21145(284): Add ‘functools.cached_property’ decorator, for
     computed properties cached for the life of the instance.

   - bpo-33570(285): Change TLS 1.3 cipher suite settings for
     compatibility with OpenSSL 1.1.1-pre6 and newer.  OpenSSL 1.1.1
     will have TLS 1.3 ciphers enabled by default.

   - bpo-28556(286): Do not simplify arguments to *note typing.Union:
     f6c.  Now ‘Union[Manager, Employee]’ is not simplified to
     ‘Employee’ at runtime.  Such simplification previously caused
     several bugs and limited possibilities for introspection.

   - bpo-12486(287): *note tokenize.generate_tokens(): f6d. is now
     documented as a public API to tokenize unicode strings.  It was
     previously present but undocumented.

   - bpo-33540(288): Add a new ‘block_on_close’ class attribute to
     ‘ForkingMixIn’ and ‘ThreadingMixIn’ classes of *note socketserver:
     f0.

   - bpo-33548(289): tempfile._candidate_tempdir_list should consider
     common TEMP locations

   - bpo-33109(290): argparse subparsers are once again not required by
     default, reverting the change in behavior introduced by
     bpo-26510(291) in 3.7.0a2.

   - bpo-33541(292): Remove unused private method
     ‘_strptime.LocaleTime.__pad’ (a.k.a.  ‘_LocaleTime__pad’).

   - bpo-33536(293): dataclasses.make_dataclass now checks for invalid
     field names and duplicate fields.  Also, added a check for invalid
     field specifications.

   - bpo-33542(294): Prevent ‘uuid.get_node’ from using a DUID instead
     of a MAC on Windows.  Patch by Zvi Effron

   - bpo-26819(295): Fix race condition with
     ‘ReadTransport.resume_reading’ in Windows proactor event loop.

   - Fix failure in *note typing.get_type_hints(): 2ff. when ClassVar
     was provided as a string forward reference.

   - bpo-33516(296): *note unittest.mock.MagicMock: 779. now supports
     the ‘__round__’ magic method.

   - bpo-28612(297): Added support for Site Maps to urllib’s
     ‘RobotFileParser’ as *note RobotFileParser.site_maps(): f6e.  Patch
     by Lady Red, based on patch by Peter Wirtz.

   - bpo-28167(298): Remove platform.linux_distribution, which was
     deprecated since 3.5.

   - bpo-33504(299): Switch the default dictionary implementation for
     *note configparser: 23. from *note collections.OrderedDict: 1b7. to
     the standard *note dict: 1b6. type.

   - bpo-33505(300): Optimize asyncio.ensure_future() by reordering if
     checks: 1.17x faster.

   - bpo-33497(301): Add errors param to cgi.parse_multipart and make an
     encoding in FieldStorage use the given errors (needed for Twisted).
     Patch by Amber Brown.

   - bpo-29235(302): The ‘cProfile.Profile’ class can now be used as a
     context manager.  Patch by Scott Sanderson.

   - bpo-33495(303): Change dataclasses.Fields repr to use the repr of
     each of its members, instead of str.  This makes it more clear what
     each field actually represents.  This is especially true for the
     ‘type’ member.

   - bpo-26103(304): Correct ‘inspect.isdatadescriptor’ to look for
     ‘__set__’ or ‘__delete__’.  Patch by Aaron Hall.

   - bpo-29209(305): Removed the ‘doctype()’ method and the `html'
     parameter of the constructor of *note XMLParser: 250.  The
     ‘doctype()’ method defined in a subclass will no longer be called.
     Deprecated methods ‘getchildren()’ and ‘getiterator()’ in the *note
     ElementTree: 137. module emit now a *note DeprecationWarning: 276.
     instead of *note PendingDeprecationWarning: 277.

   - bpo-33453(306): Fix dataclasses to work if using literal string
     type annotations or if using PEP 563 “Postponed Evaluation of
     Annotations”.  Only specific string prefixes are detected for both
     ClassVar (“ClassVar” and “typing.ClassVar”) and InitVar (“InitVar”
     and “dataclasses.InitVar”).

   - bpo-28556(307): Minor fixes in typing module: add annotations to
     ‘NamedTuple.__new__’, pass ‘*args’ and ‘**kwds’ in
     ‘Generic.__new__’.  Original PRs by Paulius Šarka and Chad
     Dombrova.

   - bpo-33365(308): Print the header values besides the header keys
     instead just the header keys if `debuglevel' is set to >0 in *note
     http.client: 94.  Patch by Marco Strigl.

   - bpo-20087(309): Updated alias mapping with glibc 2.27 supported
     locales.

   - bpo-33422(310): Fix trailing quotation marks getting deleted when
     looking up byte/string literals on pydoc.  Patch by Andrés Delfino.

   - bpo-28167(311): The function ‘platform.linux_distribution’ and
     ‘platform.dist’ now trigger a ‘DeprecationWarning’ and have been
     marked for removal in Python 3.8

   - bpo-33281(312): Fix ctypes.util.find_library regression on macOS.

   - bpo-33311(313): Text and html output generated by cgitb does not
     display parentheses if the current call is done directly in the
     module.  Patch by Stéphane Blondon.

   - bpo-27300(314): The file classes in `tempfile' now accept an
     `errors' parameter that complements the already existing
     `encoding'.  Patch by Stephan Hohe.

   - bpo-32933(315): *note unittest.mock.mock_open(): ef9. now supports
     iteration over the file contents.  Patch by Tony Flury.

   - bpo-33217(316): Raise *note TypeError: 192. when looking up
     non-Enum objects in Enum classes and Enum members.

   - bpo-33197(317): Update error message when constructing invalid
     inspect.Parameters Patch by Dong-hee Na.

   - bpo-33383(318): Fixed crash in the get() method of the *note
     dbm.ndbm: 35. database object when it is called with a single
     argument.

   - bpo-33375(319): The warnings module now finds the Python file
     associated with a warning from the code object, rather than the
     frame’s global namespace.  This is consistent with how tracebacks
     and pdb find filenames, and should work better for dynamically
     executed code.

   - bpo-33336(320): ‘imaplib’ now allows ‘MOVE’ command in
     ‘IMAP4.uid()’ (RFC 6851: IMAP MOVE Extension) and potentially as a
     name of supported method of ‘IMAP4’ object.

   - bpo-32455(321): Added `jump' parameter to *note dis.stack_effect():
     82e.

   - bpo-27485(322): Rename and deprecate undocumented functions in
     *note urllib.parse(): 11f.

   - bpo-33332(323): Add ‘signal.valid_signals()’ to expose the POSIX
     sigfillset() functionality.

   - bpo-33251(324): ‘ConfigParser.items()’ was fixed so that key-value
     pairs passed in via *note vars: f6f. are not included in the
     resulting output.

   - bpo-33329(325): Fix multiprocessing regression on newer glibcs

   - bpo-33334(326): *note dis.stack_effect(): 82e. now supports all
     defined opcodes including NOP and EXTENDED_ARG.

   - bpo-991266(327): Fix quoting of the ‘Comment’ attribute of *note
     http.cookies.SimpleCookie: f70.

   - bpo-33131(328): Upgrade bundled version of pip to 10.0.1.

   - bpo-33308(329): Fixed a crash in the *note parser: c7. module when
     converting an ST object to a tree of tuples or lists with
     ‘line_info=False’ and ‘col_info=True’.

   - bpo-23403(330): lib2to3 now uses pickle protocol 4 for pre-computed
     grammars.

   - bpo-33266(331): lib2to3 now recognizes ‘rf'...'’ strings.

   - bpo-11594(332): Ensure line-endings are respected when using
     lib2to3.

   - bpo-33254(333): Have *note importlib.resources.contents(): f71. and
     *note importlib.abc.ResourceReader.contents(): f72. return an *note
     iterable: b9f. instead of an *note iterator: f73.

   - bpo-33265(334): ‘contextlib.ExitStack’ and
     ‘contextlib.AsyncExitStack’ now use a method instead of a wrapper
     function for exit callbacks.

   - bpo-33263(335): Fix FD leak in ‘_SelectorSocketTransport’ Patch by
     Vlad Starostin.

   - bpo-33256(336): Fix display of ‘<module>’ call in the html produced
     by ‘cgitb.html()’.  Patch by Stéphane Blondon.

   - bpo-33144(337): ‘random.Random()’ and its subclassing mechanism got
     optimized to check only once at class/subclass instantiation time
     whether its ‘getrandbits()’ method can be relied on by other
     methods, including ‘randrange()’, for the generation of arbitrarily
     large random integers.  Patch by Wolfgang Maier.

   - bpo-33185(338): Fixed regression when running pydoc with the *note
     -m: 32c. switch.  (The regression was introduced in 3.7.0b3 by the
     resolution of bpo-33053(339))

     This fix also changed pydoc to add ‘os.getcwd()’ to *note sys.path:
     47d. when necessary, rather than adding ‘"."’.

   - bpo-29613(340): Added support for the ‘SameSite’ cookie flag to the
     ‘http.cookies’ module.

   - bpo-33169(341): Delete entries of ‘None’ in *note
     sys.path_importer_cache: 493. when
     ‘importlib.machinery.invalidate_caches()’ is called.

   - bpo-33203(342): ‘random.Random.choice()’ now raises ‘IndexError’
     for empty sequences consistently even when called from subclasses
     without a ‘getrandbits()’ implementation.

   - bpo-33224(343): Update difflib.mdiff() for PEP 479(344).  Convert
     an uncaught StopIteration in a generator into a return-statement.

   - bpo-33209(345): End framing at the end of C implementation of *note
     pickle.Pickler.dump(): f74.

   - bpo-32861(346): The urllib.robotparser’s ‘__str__’ representation
     now includes wildcard entries and the “Crawl-delay” and
     “Request-rate” fields.  Also removes extra newlines that were being
     appended to the end of the string.  Patch by Michael Lazar.

   - bpo-23403(347): ‘DEFAULT_PROTOCOL’ in *note pickle: ca. was bumped
     to 4.  Protocol 4 is described in PEP 3154(348) and available since
     Python 3.4.  It offers better performance and smaller size compared
     to protocol 3 introduced in Python 3.0.

   - bpo-20104(349): Improved error handling and fixed a reference leak
     in *note os.posix_spawn(): 255.

   - bpo-33106(350): Deleting a key from a read-only dbm database raises
     module specific error instead of KeyError.

   - bpo-33175(351): In dataclasses, Field.__set_name__ now looks up the
     __set_name__ special method on the class, not the instance, of the
     default value.

   - bpo-32380(352): Create functools.singledispatchmethod to support
     generic single dispatch on descriptors and methods.

   - bpo-33141(353): Have Field objects pass through __set_name__ to
     their default values, if they have their own __set_name__.

   - bpo-33096(354): Allow ttk.Treeview.insert to insert iid that has a
     false boolean value.  Note iid=0 and iid=False would be same.
     Patch by Garvit Khatri.

   - bpo-32873(355): Treat type variables and special typing forms as
     immutable by copy and pickle.  This fixes several minor issues and
     inconsistencies, and improves backwards compatibility with Python
     3.6.

   - bpo-33134(356): When computing dataclass’s __hash__, use the lookup
     table to contain the function which returns the __hash__ value.
     This is an improvement over looking up a string, and then testing
     that string to see what to do.

   - bpo-33127(357): The ssl module now compiles with LibreSSL 2.7.1.

   - bpo-32505(358): Raise TypeError if a member variable of a dataclass
     is of type Field, but doesn’t have a type annotation.

   - bpo-33078(359): Fix the failure on OSX caused by the tests relying
     on sem_getvalue

   - bpo-33116(360): Add ‘Field’ to dataclasses.__all__.

   - bpo-32896(361): Fix an error where subclassing a dataclass with a
     field that uses a default_factory would generate an incorrect
     class.

   - bpo-33100(362): Dataclasses: If a field has a default value that’s
     a MemberDescriptorType, then it’s from that field being in
     __slots__, not an actual default value.

   - bpo-32953(363): If a non-dataclass inherits from a frozen
     dataclass, allow attributes to be added to the derived class.  Only
     attributes from the frozen dataclass cannot be assigned to.
     Require all dataclasses in a hierarchy to be either all frozen or
     all non-frozen.

   - bpo-33097(364): Raise RuntimeError when ‘executor.submit’ is called
     during interpreter shutdown.

   - bpo-32968(365): Modulo and floor division involving Fraction and
     float should return float.

   - bpo-33061(366): Add missing ‘NoReturn’ to ‘__all__’ in typing.py

   - bpo-33078(367): Fix the size handling in multiprocessing.Queue when
     a pickling error occurs.

   - bpo-33064(368): lib2to3 now properly supports trailing commas after
     ‘*args’ and ‘**kwargs’ in function signatures.

   - bpo-33056(369): FIX properly close leaking fds in
     concurrent.futures.ProcessPoolExecutor.

   - bpo-33021(370): Release the GIL during fstat() calls, avoiding hang
     of all threads when calling mmap.mmap(), os.urandom(), and
     random.seed().  Patch by Nir Soffer.

   - bpo-31804(371): Avoid failing in multiprocessing.Process if the
     standard streams are closed or None at exit.

   - bpo-33034(372): Providing an explicit error message when casting
     the port property to anything that is not an integer value using
     ‘urlparse()’ and ‘urlsplit()’.  Patch by Matt Eaton.

   - bpo-30249(373): Improve struct.unpack_from() exception messages for
     problems with the buffer size and offset.

   - bpo-33037(374): Skip sending/receiving data after SSL transport
     closing.

   - bpo-27683(375): Fix a regression in *note ipaddress: a2. that
     result of ‘hosts()’ is empty when the network is constructed by a
     tuple containing an integer mask and only 1 bit left for addresses.

   - bpo-22674(376): Add the strsignal() function in the signal module
     that returns the system description of the given signal, as
     returned by strsignal(3).

   - bpo-32999(377): Fix C implementation of ‘ABC.__subclasscheck__(cls,
     subclass)’ crashed when ‘subclass’ is not a type object.

   - bpo-33009(378): Fix inspect.signature() for single-parameter
     partialmethods.

   - bpo-32969(379): Expose several missing constants in zlib and fix
     corresponding documentation.

   - bpo-32056(380): Improved exceptions raised for invalid number of
     channels and sample width when read an audio file in modules *note
     aifc: 5, *note wave: 127. and *note sunau: fa.

   - bpo-32970(381): Improved disassembly of the MAKE_FUNCTION
     instruction.

   - bpo-32844(382): Fix wrong redirection of a low descriptor (0 or 1)
     to stderr in subprocess if another low descriptor is closed.

   - bpo-32960(383): For dataclasses, disallow inheriting frozen from
     non-frozen classes, and also disallow inheriting non-frozen from
     frozen classes.  This restriction will be relaxed at a future date.

   - bpo-32713(384): Fixed tarfile.itn handling of out-of-bounds float
     values.  Patch by Joffrey Fuhrer.

   - bpo-32257(385): The ssl module now contains OP_NO_RENEGOTIATION
     constant, available with OpenSSL 1.1.0h or 1.1.1.

   - bpo-32951(386): Direct instantiation of SSLSocket and SSLObject
     objects is now prohibited.  The constructors were never documented,
     tested, or designed as public constructors.  Users were suppose to
     use ssl.wrap_socket() or SSLContext.

   - bpo-32929(387): Remove the tri-state parameter “hash”, and add the
     boolean “unsafe_hash”.  If unsafe_hash is True, add a __hash__
     function, but if a __hash__ exists, raise TypeError.  If
     unsafe_hash is False, add a __hash__ based on the values of eq= and
     frozen=.  The unsafe_hash=False behavior is the same as the old
     hash=None behavior.  unsafe_hash=False is the default, just as
     hash=None used to be.

   - bpo-32947(388): Add OP_ENABLE_MIDDLEBOX_COMPAT and test workaround
     for TLSv1.3 for future compatibility with OpenSSL 1.1.1.

   - bpo-32146(389): Document the interaction between frozen executables
     and the spawn and forkserver start methods in multiprocessing.

   - bpo-30622(390): The ssl module now detects missing NPN support in
     LibreSSL.

   - bpo-32922(391): dbm.open() now encodes filename with the filesystem
     encoding rather than default encoding.

   - bpo-32759(392): Free unused arenas in multiprocessing.heap.

   - bpo-32859(393): In ‘os.dup2’, don’t check every call whether the
     ‘dup3’ syscall exists or not.

   - bpo-32556(394): nt._getfinalpathname, nt._getvolumepathname and
     nt._getdiskusage now correctly convert from bytes.

   - bpo-21060(395): Rewrite confusing message from setup.py upload from
     “No dist file created in earlier command” to the more helpful “Must
     create and upload files in one command”.

   - bpo-32857(396): In *note tkinter: 10c, ‘after_cancel(None)’ now
     raises a *note ValueError: 1f9. instead of canceling the first
     scheduled function.  Patch by Cheryl Sabella.

   - bpo-32852(397): Make sure sys.argv remains as a list when running
     trace.

   - bpo-31333(398): ‘_abc’ module is added.  It is a speedup module
     with C implementations for various functions and methods in ‘abc’.
     Creating an ABC subclass and calling ‘isinstance’ or ‘issubclass’
     with an ABC subclass are up to 1.5x faster.  In addition, this
     makes Python start-up up to 10% faster.

     Note that the new implementation hides internal registry and
     caches, previously accessible via private attributes
     ‘_abc_registry’, ‘_abc_cache’, and ‘_abc_negative_cache’.  There
     are three debugging helper methods that can be used instead
     ‘_dump_registry’, ‘_abc_registry_clear’, and ‘_abc_caches_clear’.

   - bpo-32841(399): Fixed *note asyncio.Condition: 28b. issue which
     silently ignored cancellation after notifying and cancelling a
     conditional lock.  Patch by Bar Harel.

   - bpo-32819(400): ssl.match_hostname() has been simplified and no
     longer depends on re and ipaddress module for wildcard and IP
     addresses.  Error reporting for invalid wildcards has been
     improved.

   - bpo-19675(401): ‘multiprocessing.Pool’ no longer leaks processes if
     its initialization fails.

   - bpo-32394(402): socket: Remove
     TCP_FASTOPEN,TCP_KEEPCNT,TCP_KEEPIDLE,TCP_KEEPINTVL flags on older
     version Windows during run-time.

   - bpo-31787(403): Fixed refleaks of ‘__init__()’ methods in various
     modules.  (Contributed by Oren Milman)

   - bpo-30157(404): Fixed guessing quote and delimiter in
     csv.Sniffer.sniff() when only the last field is quoted.  Patch by
     Jake Davis.

   - bpo-30688(405): Added support of ‘\N{name}’ escapes in regular
     expressions.  Based on patch by Jonathan Eunice.

   - bpo-32792(406): collections.ChainMap() preserves the order of the
     underlying mappings.

   - bpo-32775(407): *note fnmatch.translate(): f75. no longer produces
     patterns which contain set operations.  Sets starting with ‘[‘ or
     containing ‘–’, ‘&&’, ‘~~’ or ‘||’ will be interpreted differently
     in regular expressions in future versions.  Currently they emit
     warnings.  fnmatch.translate() now avoids producing patterns
     containing such sets by accident.

   - bpo-32622(408): Implement native fast sendfile for Windows proactor
     event loop.

   - bpo-32777(409): Fix a rare but potential pre-exec child process
     deadlock in subprocess on POSIX systems when marking file
     descriptors inheritable on exec in the child process.  This bug
     appears to have been introduced in 3.4.

   - bpo-32647(410): The ctypes module used to depend on indirect
     linking for dlopen.  The shared extension is now explicitly linked
     against libdl on platforms with dl.

   - bpo-32749(411): A *note dbm.dumb: 33. database opened with flags
     ‘r’ is now read-only.  *note dbm.dumb.open(): 2bd. with flags ‘r’
     and ‘w’ no longer creates a database if it does not exist.

   - bpo-32741(412): Implement ‘asyncio.TimerHandle.when()’ method.

   - bpo-32691(413): Use mod_spec.parent when running modules with pdb

   - bpo-32734(414): Fixed ‘asyncio.Lock()’ safety issue which allowed
     acquiring and locking the same lock multiple times, without it
     being free.  Patch by Bar Harel.

   - bpo-32727(415): Do not include name field in SMTP envelope from
     address.  Patch by Stéphane Wirtel

   - bpo-31453(416): Add TLSVersion constants and
     SSLContext.maximum_version / minimum_version attributes.  The new
     API wraps OpenSSL 1.1
     ‘https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html’
     feature.

   - bpo-24334(417): Internal implementation details of ssl module were
     cleaned up.  The SSLSocket has one less layer of indirection.
     Owner and session information are now handled by the SSLSocket and
     SSLObject constructor.  Channel binding implementation has been
     simplified.

   - bpo-31848(418): Fix the error handling in Aifc_read.initfp() when
     the SSND chunk is not found.  Patch by Zackery Spytz.

   - bpo-32585(419): Add Ttk spinbox widget to *note tkinter.ttk: 10f.
     Patch by Alan D Moore.

   - bpo-32512(420): *note profile: d3. CLI accepts ‘-m module_name’ as
     an alternative to script path.

   - bpo-8525(421): help() on a type now displays builtin subclasses.
     This is intended primarily to help with notification of more
     specific exception subclasses.

     Patch by Sanyam Khurana.

   - bpo-31639(422): http.server now exposes a ThreadingHTTPServer class
     and uses it when the module is run with ‘-m’ to cope with web
     browsers pre-opening sockets.

   - bpo-29877(423): compileall: import ProcessPoolExecutor only when
     needed, preventing hangs on low resource platforms

   - bpo-32221(424): Various functions returning tuple containing IPv6
     addresses now omit ‘%scope’ part since the same information is
     already encoded in `scopeid' tuple item.  Especially this speeds up
     ‘socket.recvfrom()’ when it receives multicast packet since useless
     resolving of network interface name is omitted.

   - bpo-32147(425): *note binascii.unhexlify(): f76. is now up to 2
     times faster.  Patch by Sergey Fedoseev.

   - bpo-30693(426): The TarFile class now recurses directories in a
     reproducible way.

   - bpo-30693(427): The ZipFile class now recurses directories in a
     reproducible way.

   - bpo-31680(428): Added *note curses.ncurses_version: 1bd.

   - bpo-31908(429): Fix output of cover files for ‘trace’ module
     command-line tool.  Previously emitted cover files only when
     ‘--missing’ option was used.  Patch by Michael Selik.

   - bpo-31608(430): Raise a ‘TypeError’ instead of crashing if a
     ‘collections.deque’ subclass returns a non-deque from ‘__new__’.
     Patch by Oren Milman.

   - bpo-31425(431): Add support for sockets of the AF_QIPCRTR address
     family, supported by the Linux kernel.  This is used to communicate
     with services, such as GPS or radio, running on Qualcomm devices.
     Patch by Bjorn Andersson.

   - bpo-22005(432): Implemented unpickling instances of *note datetime:
     194, *note date: 193. and *note time: 4e8. pickled by Python 2.
     ‘encoding='latin1'’ should be used for successful decoding.

   - bpo-27645(433): *note sqlite3.Connection: 3cd. now exposes a *note
     backup: 3ce. method, if the underlying SQLite library is at version
     3.6.11 or higher.  Patch by Lele Gaifax.

   - bpo-16865(434): Support arrays >=2GiB in *note ctypes: 2b.  Patch
     by Segev Finer.

   - bpo-31508(435): Removed support of arguments in *note
     tkinter.ttk.Treeview.selection: 2ba.  It was deprecated in 3.6.
     Use specialized methods like ‘selection_set’ for changing the
     selection.

   - bpo-29456(436): Fix bugs in hangul normalization: u1176, u11a7 and
     u11c3

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35845

   (2) https://bugs.python.org/issue35864

   (3) https://bugs.python.org/issue35537

   (4) https://bugs.python.org/issue35847

   (5) https://bugs.python.org/issue35813

   (6) https://bugs.python.org/issue35780

   (7) https://bugs.python.org/issue35537

   (8) https://bugs.python.org/issue23846

   (9) https://bugs.python.org/issue34323

   (10) https://bugs.python.org/issue35674

   (11) https://bugs.python.org/issue35733

   (12) https://bugs.python.org/issue35726

   (13) https://bugs.python.org/issue35719

   (14) https://bugs.python.org/issue35717

   (15) https://bugs.python.org/issue35699

   (16) https://bugs.python.org/issue32710

   (17) https://bugs.python.org/issue35702

   (18) https://bugs.python.org/issue32710

   (19) https://bugs.python.org/issue35682

   (20) https://bugs.python.org/issue35283

   (21) https://bugs.python.org/issue35664

   (22) https://bugs.python.org/issue35643

   (23) https://bugs.python.org/issue35619

   (24) https://bugs.python.org/issue28503

   (25) https://bugs.python.org/issue35614

   (26) https://bugs.python.org/issue35568

   (27) https://bugs.python.org/issue35588

   (28) https://bugs.python.org/issue35585

   (29) https://bugs.python.org/issue30561

   (30) https://bugs.python.org/issue35537

   (31) https://bugs.python.org/issue35526

   (32) https://bugs.python.org/issue35523

   (33) https://bugs.python.org/issue31784

   (34) https://bugs.python.org/issue35513

   (35) https://bugs.python.org/issue35502

   (36) https://bugs.python.org/issue35348

   (37) https://bugs.python.org/issue35491

   (38) https://bugs.python.org/issue35477

   (39) https://bugs.python.org/issue31446

   (40) https://bugs.python.org/issue35471

   (41) https://bugs.python.org/issue23057

   (42) https://bugs.python.org/issue35052

   (43) https://bugs.python.org/issue20239

   (44) https://bugs.python.org/issue17185

   (45) https://bugs.python.org/issue35445

   (46) https://bugs.python.org/issue35415

   (47) https://bugs.python.org/issue35424

   (48) https://bugs.python.org/issue35330

   (49) https://bugs.python.org/issue35346

   (50) https://bugs.python.org/issue10496

   (51) https://bugs.python.org/issue10496

   (52) https://bugs.python.org/issue35389

   (53) https://bugs.python.org/issue35394

   (54) https://bugs.python.org/issue35310

   (55) https://bugs.python.org/issue35380

   (56) https://bugs.python.org/issue35341

   (57) https://bugs.python.org/issue35371

   (58) https://bugs.python.org/issue35346

   (59) https://bugs.python.org/issue35066

   (60) https://bugs.python.org/issue35345

   (61) https://bugs.python.org/issue35344

   (62) https://bugs.python.org/issue35312

   (63) https://bugs.python.org/issue35308

   (64) https://bugs.python.org/issue24746

   (65) https://bugs.python.org/issue28604

   (66) https://bugs.python.org/issue35277

   (67) https://bugs.python.org/issue24209

   (68) https://bugs.python.org/issue35226

   (69) https://bugs.python.org/issue29564

   (70) https://bugs.python.org/issue35189

   (71) https://bugs.python.org/issue30064

   (72) https://bugs.python.org/issue35186

   (73) https://bugs.python.org/issue35152

   (74) https://bugs.python.org/issue35062

   (75) https://bugs.python.org/issue35065

   (76) https://bugs.python.org/issue34160

   (77) https://bugs.python.org/issue35079

   (78) https://bugs.python.org/issue33710

   (79) https://bugs.python.org/issue35017

   (80) https://bugs.python.org/issue35024

   (81) https://bugs.python.org/issue35047

   (82) https://bugs.python.org/issue31047

   (83) https://bugs.python.org/issue35053

   (84) https://bugs.python.org/issue31553

   (85) https://bugs.python.org/issue34794

   (86) https://bugs.python.org/issue34909

   (87) https://bugs.python.org/issue35022

   (88) https://bugs.python.org/issue35008

   (89) https://bugs.python.org/issue23420

   (90) https://bugs.python.org/issue33947

   (91) https://bugs.python.org/issue34890

   (92) https://bugs.python.org/issue34521

   (93) https://tools.ietf.org/html/rfc3542.html

   (94) https://bugs.python.org/issue31522

   (95) https://bugs.python.org/issue34970

   (96) https://bugs.python.org/issue34969

   (97) https://bugs.python.org/issue16965

   (98) https://bugs.python.org/issue34966

   (99) https://bugs.python.org/issue34926

   (100) https://bugs.python.org/issue23831

   (101) https://bugs.python.org/issue34941

   (102) https://bugs.python.org/issue32680

   (103) https://bugs.python.org/issue34769

   (104) https://bugs.python.org/issue34936

   (105) https://bugs.python.org/issue34829

   (106) https://bugs.python.org/issue34911

   (107) https://bugs.python.org/issue34922

   (108) https://bugs.python.org/issue34925

   (109) https://bugs.python.org/issue34900

   (110) https://bugs.python.org/issue34844

   (111) https://bugs.python.org/issue34897

   (112) https://bugs.python.org/issue34871

   (113) https://bugs.python.org/issue34898

   (114) https://bugs.python.org/issue28441

   (115) https://bugs.python.org/issue34866

   (116) https://bugs.python.org/issue34711

   (117) https://bugs.python.org/issue34872

   (118) https://bugs.python.org/issue34849

   (119) https://bugs.python.org/issue34022

   (120) https://bugs.python.org/issue34819

   (121) https://bugs.python.org/issue34758

   (122) https://bugs.python.org/issue34789

   (123) https://bugs.python.org/issue34334

   (124) https://bugs.python.org/issue34687

   (125) https://bugs.python.org/issue5950

   (126) https://bugs.python.org/issue32892

   (127) https://bugs.python.org/issue34728

   (128) https://bugs.python.org/issue34738

   (129) https://bugs.python.org/issue34659

   (130) https://bugs.python.org/issue29577

   (131) https://bugs.python.org/issue34670

   (132) https://bugs.python.org/issue32718

   (133) https://bugs.python.org/issue31177

   (134) https://bugs.python.org/issue34672

   (135) https://bugs.python.org/issue34666

   (136) https://bugs.python.org/issue6721

   (137) https://bugs.python.org/issue34658

   (138) https://bugs.python.org/issue34652

   (139) https://bugs.python.org/issue34638

   (140) https://bugs.python.org/issue34536

   (141) https://bugs.python.org/issue34636

   (142) https://bugs.python.org/issue24412

   (143) https://bugs.python.org/issue34630

   (144) https://bugs.python.org/issue32490

   (145) https://bugs.python.org/issue34363

   (146) https://bugs.python.org/issue34625

   (147) https://bugs.python.org/issue32270

   (148) https://bugs.python.org/issue34622

   (149) https://bugs.python.org/issue34610

   (150) https://bugs.python.org/issue34421

   (151) https://bugs.python.org/issue34604

   (152) https://bugs.python.org/issue30977

   (153) https://bugs.python.org/issue34574

   (154) https://bugs.python.org/issue8110

   (155) https://bugs.python.org/issue34530

   (156) https://bugs.python.org/issue34563

   (157) https://bugs.python.org/issue34558

   (158) https://bugs.python.org/issue34282

   (159) https://bugs.python.org/issue22872

   (160) https://bugs.python.org/issue34515

   (161) https://bugs.python.org/issue13312

   (162) https://bugs.python.org/issue34472

   (163) https://bugs.python.org/issue34454

   (164) https://bugs.python.org/issue6700

   (165) https://bugs.python.org/issue34171

   (166) https://bugs.python.org/issue34441

   (167) https://bugs.python.org/issue34427

   (168) https://bugs.python.org/issue34412

   (169) https://bugs.python.org/issue20849

   (170) https://bugs.python.org/issue31715

   (171) https://bugs.python.org/issue34384

   (172) https://bugs.python.org/issue22602

   (173) https://bugs.python.org/issue2122

   (174) https://bugs.python.org/issue34341

   (175) https://bugs.python.org/issue34333

   (176) https://bugs.python.org/issue18540

   (177) https://bugs.python.org/issue26502

   (178) https://bugs.python.org/issue34318

   (179) https://bugs.python.org/issue9372

   (180) https://bugs.python.org/issue33613

   (181) https://bugs.python.org/issue34248

   (182) https://bugs.python.org/issue33089

   (183) https://bugs.python.org/issue34246

   (184) https://bugs.python.org/issue31047

   (185) https://bugs.python.org/issue32321

   (186) https://bugs.python.org/issue34270

   (187) https://bugs.python.org/issue34263

   (188) https://bugs.python.org/issue34035

   (189) https://bugs.python.org/issue32215

   (190) https://bugs.python.org/issue34075

   (191) https://bugs.python.org/issue34251

   (192) https://bugs.python.org/issue19891

   (193) https://bugs.python.org/issue33089

   (194) https://bugs.python.org/issue34228

   (195) https://bugs.python.org/issue13041

   (196) https://bugs.python.org/issue34213

   (197) https://bugs.python.org/issue34052

   (198) https://bugs.python.org/issue34197

   (199) https://bugs.python.org/issue32788

   (200) https://bugs.python.org/issue21446

   (201) https://bugs.python.org/issue940286

   (202) https://bugs.python.org/issue34164

   (203) https://bugs.python.org/issue33729

   (204) https://bugs.python.org/issue34097

   (205) https://bugs.python.org/issue34108

   (206) https://bugs.python.org/issue34070

   (207) https://bugs.python.org/issue27494

   (208) https://bugs.python.org/issue27494

   (209) https://bugs.python.org/issue33967

   (210) https://bugs.python.org/issue34041

   (211) https://bugs.python.org/issue34056

   (212) https://www.python.org/dev/peps/pep-0552

   (213) https://bugs.python.org/issue34054

   (214) https://bugs.python.org/issue34043

   (215) https://bugs.python.org/issue34044

   (216) https://bugs.python.org/issue34010

   (217) https://bugs.python.org/issue34019

   (218) https://bugs.python.org/issue34003

   (219) https://bugs.python.org/issue33978

   (220) https://bugs.python.org/issue14117

   (221) https://bugs.python.org/issue33974

   (222) https://bugs.python.org/issue27500

   (223) https://bugs.python.org/issue24567

   (224) https://bugs.python.org/issue33871

   (225) https://bugs.python.org/issue25007

   (226) https://bugs.python.org/issue33929

   (227) https://bugs.python.org/issue33899

   (228) https://bugs.python.org/issue33897

   (229) https://bugs.python.org/issue33695

   (230) https://bugs.python.org/issue33695

   (231) https://bugs.python.org/issue33916

   (232) https://bugs.python.org/issue32568

   (233) https://bugs.python.org/issue33833

   (234) https://bugs.python.org/issue33663

   (235) https://bugs.python.org/issue33721

   (236) https://bugs.python.org/issue26544

   (237) https://bugs.python.org/issue33843

   (238) https://bugs.python.org/issue33842

   (239) https://bugs.python.org/issue30167

   (240) https://bugs.python.org/issue33805

   (241) https://bugs.python.org/issue33687

   (242) https://bugs.python.org/issue33812

   (243) https://bugs.python.org/issue32108

   (244) https://bugs.python.org/issue27397

   (245) https://bugs.python.org/issue33578

   (246) https://bugs.python.org/issue30805

   (247) https://bugs.python.org/issue33476

   (248) https://bugs.python.org/issue33694

   (249) https://bugs.python.org/issue32493

   (250) https://bugs.python.org/issue33792

   (251) https://bugs.python.org/issue33274

   (252) https://bugs.python.org/issue33778

   (253) https://bugs.python.org/issue33165

   (254) https://bugs.python.org/issue33770

   (255) https://bugs.python.org/issue33769

   (256) https://bugs.python.org/issue33767

   (257) https://bugs.python.org/issue33734

   (258) https://bugs.python.org/issue31014

   (259) https://bugs.python.org/issue2504

   (260) https://bugs.python.org/issue33197

   (261) https://bugs.python.org/issue32751

   (262) https://bugs.python.org/issue32684

   (263) https://bugs.python.org/issue33654

   (264) https://bugs.python.org/issue33674

   (265) https://bugs.python.org/issue33671

   (266) https://bugs.python.org/issue25427

   (267) https://bugs.python.org/issue33674

   (268) https://bugs.python.org/issue31647

   (269) https://bugs.python.org/issue32610

   (270) https://bugs.python.org/issue32410

   (271) https://bugs.python.org/issue33469

   (272) https://bugs.python.org/issue33672

   (273) https://bugs.python.org/issue33654

   (274) https://bugs.python.org/issue33652

   (275) https://bugs.python.org/issue32493

   (276) https://bugs.python.org/issue33238

   (277) https://bugs.python.org/issue33618

   (278) https://bugs.python.org/issue33625

   (279) https://bugs.python.org/issue33623

   (280) https://bugs.python.org/issue11874

   (281) https://bugs.python.org/issue30877

   (282) https://bugs.python.org/issue33604

   (283) https://bugs.python.org/issue33582

   (284) https://bugs.python.org/issue21145

   (285) https://bugs.python.org/issue33570

   (286) https://bugs.python.org/issue28556

   (287) https://bugs.python.org/issue12486

   (288) https://bugs.python.org/issue33540

   (289) https://bugs.python.org/issue33548

   (290) https://bugs.python.org/issue33109

   (291) https://bugs.python.org/issue26510

   (292) https://bugs.python.org/issue33541

   (293) https://bugs.python.org/issue33536

   (294) https://bugs.python.org/issue33542

   (295) https://bugs.python.org/issue26819

   (296) https://bugs.python.org/issue33516

   (297) https://bugs.python.org/issue28612

   (298) https://bugs.python.org/issue28167

   (299) https://bugs.python.org/issue33504

   (300) https://bugs.python.org/issue33505

   (301) https://bugs.python.org/issue33497

   (302) https://bugs.python.org/issue29235

   (303) https://bugs.python.org/issue33495

   (304) https://bugs.python.org/issue26103

   (305) https://bugs.python.org/issue29209

   (306) https://bugs.python.org/issue33453

   (307) https://bugs.python.org/issue28556

   (308) https://bugs.python.org/issue33365

   (309) https://bugs.python.org/issue20087

   (310) https://bugs.python.org/issue33422

   (311) https://bugs.python.org/issue28167

   (312) https://bugs.python.org/issue33281

   (313) https://bugs.python.org/issue33311

   (314) https://bugs.python.org/issue27300

   (315) https://bugs.python.org/issue32933

   (316) https://bugs.python.org/issue33217

   (317) https://bugs.python.org/issue33197

   (318) https://bugs.python.org/issue33383

   (319) https://bugs.python.org/issue33375

   (320) https://bugs.python.org/issue33336

   (321) https://bugs.python.org/issue32455

   (322) https://bugs.python.org/issue27485

   (323) https://bugs.python.org/issue33332

   (324) https://bugs.python.org/issue33251

   (325) https://bugs.python.org/issue33329

   (326) https://bugs.python.org/issue33334

   (327) https://bugs.python.org/issue991266

   (328) https://bugs.python.org/issue33131

   (329) https://bugs.python.org/issue33308

   (330) https://bugs.python.org/issue23403

   (331) https://bugs.python.org/issue33266

   (332) https://bugs.python.org/issue11594

   (333) https://bugs.python.org/issue33254

   (334) https://bugs.python.org/issue33265

   (335) https://bugs.python.org/issue33263

   (336) https://bugs.python.org/issue33256

   (337) https://bugs.python.org/issue33144

   (338) https://bugs.python.org/issue33185

   (339) https://bugs.python.org/issue33053

   (340) https://bugs.python.org/issue29613

   (341) https://bugs.python.org/issue33169

   (342) https://bugs.python.org/issue33203

   (343) https://bugs.python.org/issue33224

   (344) https://www.python.org/dev/peps/pep-0479

   (345) https://bugs.python.org/issue33209

   (346) https://bugs.python.org/issue32861

   (347) https://bugs.python.org/issue23403

   (348) https://www.python.org/dev/peps/pep-3154

   (349) https://bugs.python.org/issue20104

   (350) https://bugs.python.org/issue33106

   (351) https://bugs.python.org/issue33175

   (352) https://bugs.python.org/issue32380

   (353) https://bugs.python.org/issue33141

   (354) https://bugs.python.org/issue33096

   (355) https://bugs.python.org/issue32873

   (356) https://bugs.python.org/issue33134

   (357) https://bugs.python.org/issue33127

   (358) https://bugs.python.org/issue32505

   (359) https://bugs.python.org/issue33078

   (360) https://bugs.python.org/issue33116

   (361) https://bugs.python.org/issue32896

   (362) https://bugs.python.org/issue33100

   (363) https://bugs.python.org/issue32953

   (364) https://bugs.python.org/issue33097

   (365) https://bugs.python.org/issue32968

   (366) https://bugs.python.org/issue33061

   (367) https://bugs.python.org/issue33078

   (368) https://bugs.python.org/issue33064

   (369) https://bugs.python.org/issue33056

   (370) https://bugs.python.org/issue33021

   (371) https://bugs.python.org/issue31804

   (372) https://bugs.python.org/issue33034

   (373) https://bugs.python.org/issue30249

   (374) https://bugs.python.org/issue33037

   (375) https://bugs.python.org/issue27683

   (376) https://bugs.python.org/issue22674

   (377) https://bugs.python.org/issue32999

   (378) https://bugs.python.org/issue33009

   (379) https://bugs.python.org/issue32969

   (380) https://bugs.python.org/issue32056

   (381) https://bugs.python.org/issue32970

   (382) https://bugs.python.org/issue32844

   (383) https://bugs.python.org/issue32960

   (384) https://bugs.python.org/issue32713

   (385) https://bugs.python.org/issue32257

   (386) https://bugs.python.org/issue32951

   (387) https://bugs.python.org/issue32929

   (388) https://bugs.python.org/issue32947

   (389) https://bugs.python.org/issue32146

   (390) https://bugs.python.org/issue30622

   (391) https://bugs.python.org/issue32922

   (392) https://bugs.python.org/issue32759

   (393) https://bugs.python.org/issue32859

   (394) https://bugs.python.org/issue32556

   (395) https://bugs.python.org/issue21060

   (396) https://bugs.python.org/issue32857

   (397) https://bugs.python.org/issue32852

   (398) https://bugs.python.org/issue31333

   (399) https://bugs.python.org/issue32841

   (400) https://bugs.python.org/issue32819

   (401) https://bugs.python.org/issue19675

   (402) https://bugs.python.org/issue32394

   (403) https://bugs.python.org/issue31787

   (404) https://bugs.python.org/issue30157

   (405) https://bugs.python.org/issue30688

   (406) https://bugs.python.org/issue32792

   (407) https://bugs.python.org/issue32775

   (408) https://bugs.python.org/issue32622

   (409) https://bugs.python.org/issue32777

   (410) https://bugs.python.org/issue32647

   (411) https://bugs.python.org/issue32749

   (412) https://bugs.python.org/issue32741

   (413) https://bugs.python.org/issue32691

   (414) https://bugs.python.org/issue32734

   (415) https://bugs.python.org/issue32727

   (416) https://bugs.python.org/issue31453

   (417) https://bugs.python.org/issue24334

   (418) https://bugs.python.org/issue31848

   (419) https://bugs.python.org/issue32585

   (420) https://bugs.python.org/issue32512

   (421) https://bugs.python.org/issue8525

   (422) https://bugs.python.org/issue31639

   (423) https://bugs.python.org/issue29877

   (424) https://bugs.python.org/issue32221

   (425) https://bugs.python.org/issue32147

   (426) https://bugs.python.org/issue30693

   (427) https://bugs.python.org/issue30693

   (428) https://bugs.python.org/issue31680

   (429) https://bugs.python.org/issue31908

   (430) https://bugs.python.org/issue31608

   (431) https://bugs.python.org/issue31425

   (432) https://bugs.python.org/issue22005

   (433) https://bugs.python.org/issue27645

   (434) https://bugs.python.org/issue16865

   (435) https://bugs.python.org/issue31508

   (436) https://bugs.python.org/issue29456


File: python.info,  Node: Documentation<12>,  Next: Tests<12>,  Prev: Library<12>,  Up: Python 3 8 0 alpha 1

1.18.12.4 Documentation
.......................

   - bpo-21257(1): Document *note http.client.parse_headers(): f78.

   - bpo-34764(2): Improve example of iter() with 2nd sentinel argument.

   - bpo-35564(3): Explicitly set master_doc variable in conf.py for
     compliance with Sphinx 2.0

   - bpo-35511(4): Specified that profile.Profile class doesn’t not
     support enable or disable methods.  Also, elaborated that Profile
     object as a context manager is only supported in cProfile module.

   - bpo-10536(5): Enhance the gettext docs.  Patch by Éric Araujo

   - bpo-35089(6): Remove mention of ‘typing.io’ and ‘typing.re’.  Their
     types should be imported from ‘typing’ directly.

   - bpo-35038(7): Fix the documentation about an unexisting
     ‘f_restricted’ attribute in the frame object.  Patch by Stéphane
     Wirtel

   - bpo-35042(8): Replace PEP XYZ by the pep role and allow to use the
     direct links to the PEPs.

   - bpo-35044(9): Fix the documentation with the role ‘exc’ for the
     appropriated exception.  Patch by Stéphane Wirtel

   - bpo-35035(10): Rename documentation for *note email.utils: 76. to
     ‘email.utils.rst’.

   - bpo-34967(11): Use app.add_object_type() instead of the deprecated
     Sphinx function app.description_unit()

   - bpo-34913(12): Add documentation about the new command line
     interface of the gzip module.

   - bpo-32174(13): chm document displays non-ASCII charaters properly
     on some MBCS Windows systems.

   - bpo-11233(14): Create availability directive for documentation.
     Original patch by Georg Brandl.

   - bpo-34790(15): Document how passing coroutines to asyncio.wait()
     can be confusing.

   - bpo-34552(16): Make clear that ‘==’ operator sometimes is
     equivalent to ‘is’.  The ‘<’, ‘<=’, ‘>’ and ‘>=’ operators are only
     defined where they make sense.

   - bpo-28617(17): Fixed info in the stdtypes docs concerning the types
     that support membership tests.

   - bpo-20177(18): Migrate datetime.date.fromtimestamp to Argument
     Clinic.  Patch by Tim Hoffmann.

   - bpo-34065(19): Fix wrongly written basicConfig documentation markup
     syntax

   - bpo-33460(20): replaced ellipsis with correct error codes in
     tutorial chapter 3.

   - bpo-33847(21): Add ‘@’ operator entry to index.

   - bpo-33409(22): Clarified the relationship between PEP 538(23)’s
     PYTHONCOERCECLOCALE and PEP 540’s PYTHONUTF8 mode.

   - bpo-33197(24): Add versionadded tag to the documentation of
     ParameterKind.description

   - bpo-17045(25): Improve the C-API doc for PyTypeObject.  This
     includes adding several quick-reference tables and a lot of missing
     slot/typedef entries.  The existing entries were also cleaned up
     with a slightly more consistent format.

   - bpo-33736(26): Improve the documentation of *note
     asyncio.open_connection(): 358, *note asyncio.start_server(): 359.
     and their UNIX socket counterparts.

   - bpo-23859(27): Document that *note asyncio.wait(): 287. does not
     cancel its futures on timeout.

   - bpo-32436(28): Document PEP 567(29) changes to asyncio.

   - bpo-33604(30): Update HMAC md5 default to a DeprecationWarning,
     bump removal to 3.8.

   - bpo-33594(31): Document ‘getargspec’, ‘from_function’ and
     ‘from_builtin’ as deprecated in their respective docstring, and
     include version since deprecation in DeprecationWarning message.

   - bpo-33503(32): Fix broken pypi link

   - bpo-33421(33): Add missing documentation for
     ‘typing.AsyncContextManager’.

   - bpo-33487(34): BZ2file now emit a DeprecationWarning when
     buffering=None is passed, the deprecation message and documentation
     also now explicitly state it is deprecated since 3.0.

   - bpo-33378(35): Add Korean language switcher for
     ‘https://docs.python.org/3/’

   - bpo-33276(36): Clarify that the ‘__path__’ attribute on modules
     cannot be just any value.

   - bpo-33201(37): Modernize documentation for writing C extension
     types.

   - bpo-33195(38): Deprecate ‘Py_UNICODE’ usage in ‘c-api/arg’
     document.  ‘Py_UNICODE’ related APIs are deprecated since Python
     3.3, but it is missed in the document.

   - bpo-33126(39): Document PyBuffer_ToContiguous().

   - bpo-27212(40): Modify documentation for the ‘islice()’ recipe to
     consume initial values up to the start index.

   - bpo-28247(41): Update *note zipapp: 141. documentation to describe
     how to make standalone applications.

   - bpo-18802(42): Documentation changes for ipaddress.  Patch by Jon
     Foster and Berker Peksag.

   - bpo-27428(43): Update documentation to clarify that
     ‘WindowsRegistryFinder’ implements ‘MetaPathFinder’.  (Patch by
     Himanshu Lakhara)

   - bpo-28124(44): The ssl module function ssl.wrap_socket() has been
     de-emphasized and deprecated in favor of the more secure and
     efficient SSLContext.wrap_socket() method.

   - bpo-17232(45): Clarify docs for -O and -OO. Patch by Terry Reedy.

   - bpo-32436(46): Add documentation for the contextvars module (PEP
     567).

   - bpo-32800(47): Update link to w3c doc for xml default namespaces.

   - bpo-11015(48): Update *note test.support: 106. documentation.

   - bpo-32613(49): Update the faq/windows.html to use the py command
     from PEP 397 instead of python.

   - bpo-8722(50): Document *note __getattr__(): 30f. behavior when
     property ‘get()’ method raises *note AttributeError: 390.

   - bpo-32614(51): Modify RE examples in documentation to use raw
     strings to prevent *note DeprecationWarning: 276. and add text to
     REGEX HOWTO to highlight the deprecation.

   - bpo-20709(52): Remove the paragraph where we explain that
     os.utime() does not support a directory as path under Windows.
     Patch by Jan-Philip Gehrcke

   - bpo-32722(53): Remove the bad example in the tutorial of the
     Generator Expression.  Patch by Stéphane Wirtel

   - bpo-31972(54): Improve docstrings for *note pathlib.PurePath: f79.
     subclasses.

   - bpo-30607(55): Use the externalized ‘python-docs-theme’ package
     when building the documentation.

   - bpo-8243(56): Add a note about curses.addch and curses.addstr
     exception behavior when writing outside a window, or pad.

   - bpo-32337(57): Update documentation related with ‘dict’ order.

   - bpo-25041(58): Document ‘AF_PACKET’ in the *note socket: ef.
     module.

   - bpo-31432(59): Clarify meaning of CERT_NONE, CERT_OPTIONAL, and
     CERT_REQUIRED flags for ssl.SSLContext.verify_mode.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21257

   (2) https://bugs.python.org/issue34764

   (3) https://bugs.python.org/issue35564

   (4) https://bugs.python.org/issue35511

   (5) https://bugs.python.org/issue10536

   (6) https://bugs.python.org/issue35089

   (7) https://bugs.python.org/issue35038

   (8) https://bugs.python.org/issue35042

   (9) https://bugs.python.org/issue35044

   (10) https://bugs.python.org/issue35035

   (11) https://bugs.python.org/issue34967

   (12) https://bugs.python.org/issue34913

   (13) https://bugs.python.org/issue32174

   (14) https://bugs.python.org/issue11233

   (15) https://bugs.python.org/issue34790

   (16) https://bugs.python.org/issue34552

   (17) https://bugs.python.org/issue28617

   (18) https://bugs.python.org/issue20177

   (19) https://bugs.python.org/issue34065

   (20) https://bugs.python.org/issue33460

   (21) https://bugs.python.org/issue33847

   (22) https://bugs.python.org/issue33409

   (23) https://www.python.org/dev/peps/pep-0538

   (24) https://bugs.python.org/issue33197

   (25) https://bugs.python.org/issue17045

   (26) https://bugs.python.org/issue33736

   (27) https://bugs.python.org/issue23859

   (28) https://bugs.python.org/issue32436

   (29) https://www.python.org/dev/peps/pep-0567

   (30) https://bugs.python.org/issue33604

   (31) https://bugs.python.org/issue33594

   (32) https://bugs.python.org/issue33503

   (33) https://bugs.python.org/issue33421

   (34) https://bugs.python.org/issue33487

   (35) https://bugs.python.org/issue33378

   (36) https://bugs.python.org/issue33276

   (37) https://bugs.python.org/issue33201

   (38) https://bugs.python.org/issue33195

   (39) https://bugs.python.org/issue33126

   (40) https://bugs.python.org/issue27212

   (41) https://bugs.python.org/issue28247

   (42) https://bugs.python.org/issue18802

   (43) https://bugs.python.org/issue27428

   (44) https://bugs.python.org/issue28124

   (45) https://bugs.python.org/issue17232

   (46) https://bugs.python.org/issue32436

   (47) https://bugs.python.org/issue32800

   (48) https://bugs.python.org/issue11015

   (49) https://bugs.python.org/issue32613

   (50) https://bugs.python.org/issue8722

   (51) https://bugs.python.org/issue32614

   (52) https://bugs.python.org/issue20709

   (53) https://bugs.python.org/issue32722

   (54) https://bugs.python.org/issue31972

   (55) https://bugs.python.org/issue30607

   (56) https://bugs.python.org/issue8243

   (57) https://bugs.python.org/issue32337

   (58) https://bugs.python.org/issue25041

   (59) https://bugs.python.org/issue31432


File: python.info,  Node: Tests<12>,  Next: Build<9>,  Prev: Documentation<12>,  Up: Python 3 8 0 alpha 1

1.18.12.5 Tests
...............

   - bpo-35772(1): Fix sparse file tests of test_tarfile on ppc64 with
     the tmpfs filesystem.  Fix the function testing if the filesystem
     supports sparse files: create a file which contains data and
     “holes”, instead of creating a file which contains no data.  tmpfs
     effective block size is a page size (tmpfs lives in the page
     cache).  RHEL uses 64 KiB pages on aarch64, ppc64, ppc64le, only
     s390x and x86_64 use 4 KiB pages, whereas the test punch holes of 4
     KiB.

   - bpo-35045(2): Make ssl tests less strict and also accept TLSv1 as
     system default.  The changes unbreaks test_min_max_version on
     Fedora 29.

   - bpo-32710(3): ‘test_asyncio/test_sendfile.py’ now resets the event
     loop policy using ‘tearDownModule()’ as done in other tests, to
     prevent a warning when running tests on Windows.

   - bpo-33717(4): test.pythoninfo now logs information of all clocks,
     not only time.time() and time.perf_counter().

   - bpo-35488(5): Add a test to pathlib’s Path.match() to verify it
     does not support glob-style ** recursive pattern matching.

   - bpo-31731(6): Fix a race condition in ‘check_interrupted_write()’
     of test_io: create directly the thread with SIGALRM signal blocked,
     rather than blocking the signal later from the thread.  Previously,
     it was possible that the thread gets the signal before the signal
     is blocked.

   - bpo-35424(7): Fix test_multiprocessing_main_handling: use
     ‘multiprocessing.Pool’ with a context manager and then explicitly
     join the pool.

   - bpo-35519(8): Rename ‘test.bisect’ module to ‘test.bisect_cmd’ to
     avoid conflict with *note bisect: 12. module when running directly
     a test like ‘./python Lib/test/test_xmlrpc.py’.

   - bpo-35513(9): Replace *note time.time(): 312. with *note
     time.monotonic(): 763. in tests to measure time delta.

   - bpo-34279(10): *note test.support.run_unittest(): f7b. no longer
     raise ‘TestDidNotRun’ if the test result contains skipped tests.
     The exception is now only raised if no test have been run and no
     test have been skipped.

   - bpo-35412(11): Add testcase to ‘test_future4’: check unicode
     literal.

   - bpo-26704(12): Added test demonstrating double-patching of an
     instance method.  Patch by Anthony Sottile.

   - bpo-33725(13): test_multiprocessing_fork may crash on recent
     versions of macOS. Until the issue is resolved, skip the test on
     macOS.

   - bpo-35352(14): Modify test_asyncio to use the certificate set from
     the test directory.

   - bpo-35317(15): Fix ‘mktime()’ overflow error in ‘test_email’: run
     ‘test_localtime_daylight_true_dst_true()’ and
     ‘test_localtime_daylight_false_dst_true()’ with a specific
     timezone.

   - bpo-21263(16): After several reports that test_gdb does not work
     properly on macOS and since gdb is not shipped by default anymore,
     test_gdb is now skipped on macOS when LLVM Clang has been used to
     compile Python.  Patch by Lysandros Nikolaou

   - bpo-34279(17): regrtest issue a warning when no tests have been
     executed in a particular test file.  Also, a new final result state
     is issued if no test have been executed across all test files.
     Patch by Pablo Galindo.

   - bpo-34962(18): make docstest in Doc now passes., and is enforced in
     CI

   - bpo-23596(19): Use argparse for the command line of the gzip
     module.  Patch by Antony Lee

   - bpo-34537(20): Fix ‘test_gdb.test_strings()’ when ‘LC_ALL=C’ and
     GDB was compiled with Python 3.6 or earlier.

   - bpo-34587(21): test_socket: Remove RDSTest.testCongestion().  The
     test tries to fill the receiver’s socket buffer and expects an
     error.  But the RDS protocol doesn’t require that.  Moreover, the
     Linux implementation of RDS expects that the producer of the
     messages reduces its rate, it’s not the role of the receiver to
     trigger an error.  The test fails on Fedora 28 by design, so just
     remove it.

   - bpo-34661(22): Fix test_shutil if unzip doesn’t support -t.

   - bpo-34200(23): Fixed non-deterministic flakiness of test_pkg by not
     using the scary test.support.module_cleanup() logic to save and
     restore sys.modules contents between test cases.

   - bpo-34569(24): The experimental PEP 554 data channels now correctly
     pass negative PyLong objects between subinterpreters on 32-bit
     systems.  Patch by Michael Felt.

   - bpo-34594(25): Fix usage of hardcoded ‘errno’ values in the tests.

   - bpo-34579(26): Fix test_embed for AIX Patch by Michael Felt

   - bpo-34542(27): Use 3072 RSA keys and SHA-256 signature for test
     certs and keys.

   - bpo-11193(28): Remove special condition for AIX in
     ‘test_subprocess.test_undecodable_env’

   - bpo-34347(29): Fix ‘test_utf8_mode.test_cmd_line’ for AIX

   - bpo-34490(30): On AIX with AF_UNIX family sockets getsockname()
     does not provide ‘sockname’, so skip calls to
     transport.get_extra_info(‘sockname’)

   - bpo-34391(31): Fix ftplib test for TLS 1.3 by reading from data
     socket.

   - bpo-11192(32): Fix ‘test_socket’ on AIX AIX 6.1 and later IPv6 zone
     id supports only supported by inet_pton6_zone() Switch to
     runtime-based platform.system() to establish current platform
     rather than build-time based sys.platform()

   - bpo-34399(33): Update all RSA keys and DH params to use at least
     2048 bits.

   - bpo-34373(34): Fix ‘test_mktime’ and ‘test_pthread_getcpuclickid’
     tests for AIX Add range checking for ‘_PyTime_localtime’ for AIX
     Patch by Michael Felt

   - bpo-11191(35): Skip the distutils test ‘test_search_cpp’ when using
     XLC as compiler patch by aixtools (Michael Felt)

   - Improved an error message when mock assert_has_calls fails.

   - bpo-33746(36): Fix test_unittest when run in verbose mode.

   - bpo-33901(37): Fix test_dbm_gnu on macOS with gdbm 1.15: add a
     larger value to make sure that the file size changes.

   - bpo-33873(38): Fix a bug in ‘regrtest’ that caused an extra test to
     run if –huntrleaks/-R was used.  Exit with error in case that
     invalid parameters are specified to –huntrleaks/-R (at least one
     warmup run and one repetition must be used).

   - bpo-33562(39): Check that a global asyncio event loop policy is not
     left behind by any tests.

   - bpo-33655(40): Ignore test_posix_fallocate failures on BSD
     platforms that might be due to running on ZFS.

   - bpo-32962(41): Fixed test_gdb when Python is compiled with flags
     -mcet -fcf-protection -O0.

   - bpo-33358(42): Fix
     ‘test_embed.test_pre_initialization_sys_options()’ when the
     interpreter is built with ‘--enable-shared’.

   - bpo-32872(43): Avoid regrtest compatibility issue with namespace
     packages.

   - bpo-32517(44): Fix failing ‘test_asyncio’ on macOS 10.12.2+ due to
     transport of ‘KqueueSelector’ loop was not being closed.

   - bpo-32663(45): Making sure the ‘SMTPUTF8SimTests’ class of tests
     gets run in test_smtplib.py.

   - bpo-27643(46): Test_C test case needs “signed short” bitfields, but
     the IBM XLC compiler (on AIX) does not support this Skip the code
     and test when AIX and XLC are used

     Applicable to Python2-2.7 and later

   - bpo-19417(47): Add test_bdb.py.

   - bpo-31809(48): Add tests to verify connection with secp ECDH
     curves.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35772

   (2) https://bugs.python.org/issue35045

   (3) https://bugs.python.org/issue32710

   (4) https://bugs.python.org/issue33717

   (5) https://bugs.python.org/issue35488

   (6) https://bugs.python.org/issue31731

   (7) https://bugs.python.org/issue35424

   (8) https://bugs.python.org/issue35519

   (9) https://bugs.python.org/issue35513

   (10) https://bugs.python.org/issue34279

   (11) https://bugs.python.org/issue35412

   (12) https://bugs.python.org/issue26704

   (13) https://bugs.python.org/issue33725

   (14) https://bugs.python.org/issue35352

   (15) https://bugs.python.org/issue35317

   (16) https://bugs.python.org/issue21263

   (17) https://bugs.python.org/issue34279

   (18) https://bugs.python.org/issue34962

   (19) https://bugs.python.org/issue23596

   (20) https://bugs.python.org/issue34537

   (21) https://bugs.python.org/issue34587

   (22) https://bugs.python.org/issue34661

   (23) https://bugs.python.org/issue34200

   (24) https://bugs.python.org/issue34569

   (25) https://bugs.python.org/issue34594

   (26) https://bugs.python.org/issue34579

   (27) https://bugs.python.org/issue34542

   (28) https://bugs.python.org/issue11193

   (29) https://bugs.python.org/issue34347

   (30) https://bugs.python.org/issue34490

   (31) https://bugs.python.org/issue34391

   (32) https://bugs.python.org/issue11192

   (33) https://bugs.python.org/issue34399

   (34) https://bugs.python.org/issue34373

   (35) https://bugs.python.org/issue11191

   (36) https://bugs.python.org/issue33746

   (37) https://bugs.python.org/issue33901

   (38) https://bugs.python.org/issue33873

   (39) https://bugs.python.org/issue33562

   (40) https://bugs.python.org/issue33655

   (41) https://bugs.python.org/issue32962

   (42) https://bugs.python.org/issue33358

   (43) https://bugs.python.org/issue32872

   (44) https://bugs.python.org/issue32517

   (45) https://bugs.python.org/issue32663

   (46) https://bugs.python.org/issue27643

   (47) https://bugs.python.org/issue19417

   (48) https://bugs.python.org/issue31809


File: python.info,  Node: Build<9>,  Next: Windows<12>,  Prev: Tests<12>,  Up: Python 3 8 0 alpha 1

1.18.12.6 Build
...............

   - bpo-34691(1): The _contextvars module is now built into the core
     Python library on Windows.

   - bpo-35683(2): Improved Azure Pipelines build steps and now
     verifying layouts correctly

   - bpo-35642(3): Remove asynciomodule.c from pythoncore.vcxproj

   - bpo-35550(4): Fix incorrect Solaris #ifdef checks to look for __sun
     && __SVR4 instead of sun when compiling.

   - bpo-35499(5): ‘make profile-opt’ no longer replaces ‘CFLAGS_NODIST’
     with ‘CFLAGS’.  It now adds profile-guided optimization (PGO) flags
     to ‘CFLAGS_NODIST’: existing ‘CFLAGS_NODIST’ flags are kept.

   - bpo-35257(6): Avoid leaking the linker flags from Link Time
     Optimizations (LTO) into distutils when compiling C extensions.

   - bpo-35351(7): When building Python with clang and LTO, LTO flags
     are no longer passed into CFLAGS to build third-party C extensions
     through distutils.

   - bpo-35139(8): Fix a compiler error when statically linking
     ‘pyexpat’ in ‘Modules/Setup’.

   - bpo-35059(9): PCbuild: Set InlineFunctionExpansion to
     OnlyExplicitInline (“/Ob1” option) in pyproject.props in Debug mode
     to expand functions marked as inline.  This change should make
     Python compiled in Debug mode a little bit faster on Windows.

   - bpo-35011(10): Restores the use of pyexpatns.h to isolate our
     embedded copy of the expat C library so that its symbols do not
     conflict at link or dynamic loading time with an embedding
     application or other extension modules with their own version of
     libexpat.

   - bpo-28015(11): Have –with-lto works correctly with clang.

   - bpo-34765(12): Update the outdated install-sh file to the latest
     revision from automake v1.16.1

   - bpo-34585(13): Check for floating-point byte order in configure.ac
     using compilation tests instead of executing code, so that these
     checks work in cross-compiled builds.

   - bpo-34710(14): Fixed SSL module build with OpenSSL & pedantic
     CFLAGS.

   - bpo-34582(15): Add JUnit XML output for regression tests and update
     Azure DevOps builds.

   - bpo-34081(16): Make Sphinx warnings as errors in the Docs Makefile.

   - bpo-34555(17): Fix for case where it was not possible to have both
     ‘HAVE_LINUX_VM_SOCKETS_H’ and ‘HAVE_SOCKADDR_ALG’ be undefined.

   - bpo-33015(18): Fix an undefined behaviour in the pthread
     implementation of ‘PyThread_start_new_thread()’: add a function
     wrapper to always return ‘NULL’.

   - bpo-34245(19): The Python shared library is now installed with
     write permission (mode 0755), which is the standard way of
     installing such libraries.

   - bpo-34121(20): Fix detection of C11 atomic support on clang.

   - bpo-32430(21): Rename Modules/Setup.dist to Modules/Setup, and
     remove the necessity to copy the former manually to the latter when
     updating the local source tree.

   - bpo-30345(22): Add -g to LDFLAGS when compiling with LTO to get
     debug symbols.

   - bpo-5755(23): Move ‘-Wstrict-prototypes’ option to ‘CFLAGS_NODIST’
     from ‘OPT’.  This option emitted annoying warnings when building
     extension modules written in C++.

   - bpo-33614(24): Ensures module definition files for the stable ABI
     on Windows are correctly regenerated.

   - bpo-33648(25): The –with-c-locale-warning configuration flag has
     been removed.  It has had no effect for about a year.

   - bpo-33522(26): Enable CI builds on Visual Studio Team Services at
     ‘https://python.visualstudio.com/cpython’

   - bpo-33512(27): configure’s check for “long double” has been
     simplified

   - bpo-33483(28): C compiler is now correctly detected from the
     standard environment variables.  –without-gcc and –with-icc options
     have been removed.

   - bpo-33394(29): Enable the verbose build for extension modules, when
     GNU make is passed macros on the command line.

   - bpo-33393(30): Update config.guess and config.sub files.

   - bpo-33377(31): Add new triplets for mips r6 and riscv variants
     (used in extension suffixes).

   - bpo-32232(32): By default, modules configured in ‘Modules/Setup’
     are no longer built with ‘-DPy_BUILD_CORE’.  Instead, modules that
     specifically need that preprocessor definition include it in their
     individual entries.

   - bpo-33182(33): The embedding tests can once again be built with
     clang 6.0

   - bpo-33163(34): Upgrade pip to 9.0.3 and setuptools to v39.0.1.

   - bpo-33012(35): gcc 8 has added a new warning heuristic to detect
     invalid function casts and a stock python build seems to hit that
     warning quite often.  The most common is the cast of a METH_NOARGS
     function (that uses just one argument) to a PyCFunction.  Fix this
     by adding a dummy argument to all functions that implement
     METH_NOARGS.

   - bpo-32898(36): Fix the python debug build when using COUNT_ALLOCS.

   - bpo-29442(37): Replace optparse with argparse in setup.py

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34691

   (2) https://bugs.python.org/issue35683

   (3) https://bugs.python.org/issue35642

   (4) https://bugs.python.org/issue35550

   (5) https://bugs.python.org/issue35499

   (6) https://bugs.python.org/issue35257

   (7) https://bugs.python.org/issue35351

   (8) https://bugs.python.org/issue35139

   (9) https://bugs.python.org/issue35059

   (10) https://bugs.python.org/issue35011

   (11) https://bugs.python.org/issue28015

   (12) https://bugs.python.org/issue34765

   (13) https://bugs.python.org/issue34585

   (14) https://bugs.python.org/issue34710

   (15) https://bugs.python.org/issue34582

   (16) https://bugs.python.org/issue34081

   (17) https://bugs.python.org/issue34555

   (18) https://bugs.python.org/issue33015

   (19) https://bugs.python.org/issue34245

   (20) https://bugs.python.org/issue34121

   (21) https://bugs.python.org/issue32430

   (22) https://bugs.python.org/issue30345

   (23) https://bugs.python.org/issue5755

   (24) https://bugs.python.org/issue33614

   (25) https://bugs.python.org/issue33648

   (26) https://bugs.python.org/issue33522

   (27) https://bugs.python.org/issue33512

   (28) https://bugs.python.org/issue33483

   (29) https://bugs.python.org/issue33394

   (30) https://bugs.python.org/issue33393

   (31) https://bugs.python.org/issue33377

   (32) https://bugs.python.org/issue32232

   (33) https://bugs.python.org/issue33182

   (34) https://bugs.python.org/issue33163

   (35) https://bugs.python.org/issue33012

   (36) https://bugs.python.org/issue32898

   (37) https://bugs.python.org/issue29442


File: python.info,  Node: Windows<12>,  Next: macOS<8>,  Prev: Build<9>,  Up: Python 3 8 0 alpha 1

1.18.12.7 Windows
.................

   - bpo-35890(1): Fix API calling consistency of GetVersionEx and
     wcstok.

   - bpo-32560(2): The ‘py’ launcher now forwards its ‘STARTUPINFO’
     structure to child processes.

   - bpo-35854(3): Fix EnvBuilder and –symlinks in venv on Windows

   - bpo-35811(4): Avoid propagating venv settings when launching via
     py.exe

   - bpo-35797(5): Fix default executable used by the multiprocessing
     module

   - bpo-35758(6): Allow building on ARM with MSVC.

   - bpo-29734(7): Fix handle leaks in os.stat on Windows.

   - bpo-35596(8): Use unchecked PYCs for the embeddable distro to avoid
     zipimport restrictions.

   - bpo-35596(9): Fix vcruntime140.dll being added to embeddable distro
     multiple times.

   - bpo-35402(10): Update Windows build to use Tcl and Tk 8.6.9

   - bpo-35401(11): Updates Windows build to OpenSSL 1.1.0j

   - bpo-34977(12): venv on Windows will now use a python.exe redirector
     rather than copying the actual binaries from the base environment.

   - bpo-34977(13): Adds support for building a Windows App Store
     package

   - bpo-35067(14): Remove _distutils_findvs module and use vswhere.exe
     instead.

   - bpo-32557(15): Allow shutil.disk_usage to take a file path on
     Windows

   - bpo-34770(16): Fix a possible null pointer dereference in
     pyshellext.cpp.

   - bpo-34603(17): Fix returning structs from functions produced by
     MSVC

   - bpo-34581(18): Guard MSVC-specific code in socketmodule.c with
     ‘#ifdef _MSC_VER’.

   - bpo-34532(19): Fixes exit code of list version arguments for
     py.exe.

   - bpo-34062(20): Fixed the ‘–list’ and ‘–list-paths’ arguments for
     the py.exe launcher

   - bpo-34225(21): Ensure INCLUDE and LIB directories do not end with a
     backslash.

   - bpo-34011(22): A suite of code has been changed which copied across
     DLLs and init.tcl from the running Python location into a venv
     being created.  These copies are needed only when running from a
     Python source build, and the copying code is now only run when that
     is the case, rather than whenever a venv is created.

   - bpo-34006(23): Revert line length limit for Windows help docs.  The
     line-length limit is not needed because the pages appear in a
     separate app rather than on a browser tab.  It can also interact
     badly with the DPI setting.

   - bpo-31546(24): Restore running PyOS_InputHook while waiting for
     user input at the prompt.  The restores integration of interactive
     GUI windows (such as Matplotlib figures) with the prompt on
     Windows.

   - bpo-30237(25): Output error when ReadConsole is canceled by
     CancelSynchronousIo instead of crashing.

   - bpo-33895(26): GIL is released while calling functions that acquire
     Windows loader lock.

   - bpo-33720(27): Reduces maximum marshal recursion depth on release
     builds.

   - bpo-29097(28): Fix bug where ‘datetime.fromtimestamp()’ erroneously
     throws an *note OSError: 1d1. on Windows for values between 0 and
     86400.  Patch by Ammar Askar.

   - bpo-33316(29): PyThread_release_lock always fails

   - bpo-33184(30): Update Windows installer to use OpenSSL 1.1.0h.

   - bpo-32890(31): Fix usage of GetLastError() instead of errno in
     os.execve() and os.truncate().

   - bpo-33016(32): Fix potential use of uninitialized memory in
     nt._getfinalpathname

   - bpo-32903(33): Fix a memory leak in os.chdir() on Windows if the
     current directory is set to a UNC path.

   - bpo-32901(34): Update Tcl and Tk versions to 8.6.8

   - bpo-31966(35): Fixed WindowsConsoleIO.write() for writing empty
     data.

   - bpo-32409(36): Ensures activate.bat can handle Unicode contents.

   - bpo-32457(37): Improves handling of denormalized executable path
     when launching Python.

   - bpo-32370(38): Use the correct encoding for ipconfig output in the
     uuid module.  Patch by Segev Finer.

   - bpo-29248(39): Fix *note os.readlink(): 1f1. on Windows, which was
     mistakenly treating the ‘PrintNameOffset’ field of the reparse data
     buffer as a number of characters instead of bytes.  Patch by Craig
     Holmquist and SSE4.

   - bpo-1104(40): Correctly handle string length in
     ‘msilib.SummaryInfo.GetProperty()’ to prevent it from truncating
     the last character.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35890

   (2) https://bugs.python.org/issue32560

   (3) https://bugs.python.org/issue35854

   (4) https://bugs.python.org/issue35811

   (5) https://bugs.python.org/issue35797

   (6) https://bugs.python.org/issue35758

   (7) https://bugs.python.org/issue29734

   (8) https://bugs.python.org/issue35596

   (9) https://bugs.python.org/issue35596

   (10) https://bugs.python.org/issue35402

   (11) https://bugs.python.org/issue35401

   (12) https://bugs.python.org/issue34977

   (13) https://bugs.python.org/issue34977

   (14) https://bugs.python.org/issue35067

   (15) https://bugs.python.org/issue32557

   (16) https://bugs.python.org/issue34770

   (17) https://bugs.python.org/issue34603

   (18) https://bugs.python.org/issue34581

   (19) https://bugs.python.org/issue34532

   (20) https://bugs.python.org/issue34062

   (21) https://bugs.python.org/issue34225

   (22) https://bugs.python.org/issue34011

   (23) https://bugs.python.org/issue34006

   (24) https://bugs.python.org/issue31546

   (25) https://bugs.python.org/issue30237

   (26) https://bugs.python.org/issue33895

   (27) https://bugs.python.org/issue33720

   (28) https://bugs.python.org/issue29097

   (29) https://bugs.python.org/issue33316

   (30) https://bugs.python.org/issue33184

   (31) https://bugs.python.org/issue32890

   (32) https://bugs.python.org/issue33016

   (33) https://bugs.python.org/issue32903

   (34) https://bugs.python.org/issue32901

   (35) https://bugs.python.org/issue31966

   (36) https://bugs.python.org/issue32409

   (37) https://bugs.python.org/issue32457

   (38) https://bugs.python.org/issue32370

   (39) https://bugs.python.org/issue29248

   (40) https://bugs.python.org/issue1104


File: python.info,  Node: macOS<8>,  Next: IDLE<14>,  Prev: Windows<12>,  Up: Python 3 8 0 alpha 1

1.18.12.8 macOS
...............

   - bpo-35401(1): Update macOS installer to use OpenSSL 1.1.0j.

   - bpo-35025(2): Properly guard the use of the ‘CLOCK_GETTIME’ et al.
     macros in ‘timemodule’ on macOS.

   - bpo-24658(3): On macOS, fix reading from and writing into a file
     with a size larger than 2 GiB.

   - bpo-34405(4): Update to OpenSSL 1.1.0i for macOS installer builds.

   - bpo-33635(5): In macOS stat on some file descriptors (/dev/fd/3
     f.e) will result in bad file descriptor OSError.  Guard against
     this exception was added in is_dir, is_file and similar methods.
     DirEntry.is_dir can also throw this exception so
     _RecursiveWildcardSelector._iterate_directories was also extended
     with the same error ignoring pattern.

   - bpo-13631(6): The .editrc file in user’s home directory is now
     processed correctly during the readline initialization through
     editline emulation on macOS.

   - bpo-33184(7): Update macOS installer build to use OpenSSL 1.1.0h.

   - bpo-32726(8): Build and link with private copy of Tcl/Tk 8.6 for
     the macOS 10.6+ installer.  The 10.9+ installer variant already
     does this.  This means that the Python 3.7 provided by the
     python.org macOS installers no longer need or use any external
     versions of Tcl/Tk, either system-provided or user-installed, such
     as ActiveTcl.

   - bpo-32901(9): Update macOS 10.9+ installer to Tcl/Tk 8.6.8.

   - bpo-31903(10): In ‘_scproxy’, drop the GIL when calling into
     ‘SystemConfiguration’ to avoid deadlocks.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35401

   (2) https://bugs.python.org/issue35025

   (3) https://bugs.python.org/issue24658

   (4) https://bugs.python.org/issue34405

   (5) https://bugs.python.org/issue33635

   (6) https://bugs.python.org/issue13631

   (7) https://bugs.python.org/issue33184

   (8) https://bugs.python.org/issue32726

   (9) https://bugs.python.org/issue32901

   (10) https://bugs.python.org/issue31903


File: python.info,  Node: IDLE<14>,  Next: Tools/Demos<8>,  Prev: macOS<8>,  Up: Python 3 8 0 alpha 1

1.18.12.9 IDLE
..............

   - bpo-35770(1): IDLE macosx deletes Options => Configure IDLE. It
     previously deleted Window => Zoom Height by mistake.  (Zoom Height
     is now on the Options menu).  On Mac, the settings dialog is
     accessed via Preferences on the IDLE menu.

   - bpo-35769(2): Change IDLE’s new file name from ‘Untitled’ to
     ‘untitled’

   - bpo-35660(3): Fix imports in idlelib.window.

   - bpo-35641(4): Proper format ‘calltip’ when the function has no
     docstring.

   - bpo-33987(5): Use ttk Frame for ttk widgets.

   - bpo-34055(6): Fix erroneous ‘smart’ indents and newlines in IDLE
     Shell.

   - bpo-35591(7): Find Selection now works when selection not found.

   - bpo-35196(8): Speed up squeezer line counting.

   - bpo-35598(9): Update config_key: use PEP 8 names and ttk widgets,
     make some objects global, and add tests.

   - bpo-28097(10): Add Previous/Next History entries to Shell menu.

   - bpo-35208(11): Squeezer now properly counts wrapped lines before
     newlines.

   - bpo-35555(12): Gray out Code Context menu entry when it’s not
     applicable.

   - bpo-35521(13): Document the IDLE editor code context feature.  Add
     some internal references within the IDLE doc.

   - bpo-22703(14): The Code Context menu label now toggles between
     Show/Hide Code Context.  The Zoom Height menu now toggles between
     Zoom/Restore Height.  Zoom Height has moved from the Window menu to
     the Options menu.

   - bpo-35213(15): Where appropriate, use ‘macOS’ in idlelib.

   - bpo-34864(16): On macOS, warn if the system preference “Prefer tabs
     when opening documents” is set to “Always”.

   - bpo-34864(17): Document two IDLE on MacOS issues.  The System
     Preferences Dock “prefer tabs always” setting disables some IDLE
     features.  Menus are a bit different than as described for Windows
     and Linux.

   - bpo-35202(18): Remove unused imports from lib/idlelib

   - bpo-33000(19): Document that IDLE’s shell has no line limit.  A
     program that runs indefinitely can overfill memory.

   - bpo-23220(20): Explain how IDLE’s Shell displays output.

   - bpo-35099(21): Improve the doc about IDLE running user code.  The
     section is renamed from “IDLE – console differences” is renamed
     “Running user code”.  It mostly covers the implications of using
     custom sys.stdxxx objects.

   - bpo-35097(22): Add IDLE doc subsection explaining editor windows.
     Topics include opening, title and status bar, .py* extension, and
     running.

   - bpo-35093(23): Document the IDLE document viewer in the IDLE doc.
     Add a paragraph in “Help and preferences”, “Help sources”
     subsection.

   - bpo-35088(24): Update idlelib.help.copy_string docstring.  We now
     use git and backporting instead of hg and forward merging.

   - bpo-35087(25): Update idlelib help files for the current doc build.
     The main change is the elimination of chapter-section numbers.

   - bpo-34548(26): Use configured color theme for read-only text views.

   - bpo-1529353(27): Enable “squeezing” of long outputs in the shell,
     to avoid performance degradation and to clean up the history
     without losing it.  Squeezed outputs may be copied, viewed in a
     separate window, and “unsqueezed”.

   - bpo-34047(28): Fixed mousewheel scrolling direction on macOS.

   - bpo-34275(29): Make IDLE calltips always visible on Mac.  Some
     MacOS-tk combinations need .update_idletasks().  Patch by Kevin
     Walzer.

   - bpo-34120(30): Fix unresponsiveness after closing certain windows
     and dialogs.

   - bpo-33975(31): Avoid small type when running htests.  Since part of
     the purpose of human-viewed tests is to determine that widgets look
     right, it is important that they look the same for testing as when
     running IDLE.

   - bpo-33905(32): Add test for idlelib.stackview.StackBrowser.

   - bpo-33924(33): Change mainmenu.menudefs key ‘windows’ to ‘window’.
     Every other menudef key is lowercase version of main menu entry.

   - bpo-33906(34): Rename idlelib.windows as window Match Window on the
     main menu and remove last plural module name.

   - bpo-33917(35): Fix and document idlelib/idle_test/template.py.  The
     revised file compiles, runs, and tests OK. idle_test/README.txt
     explains how to use it to create new IDLE test files.

   - bpo-33904(36): IDLE: In rstrip, rename class RstripExtension as
     Rstrip

   - bpo-33907(37): For consistency and clarity, rename an IDLE module
     and classes.  Module calltips and its class CallTips are now
     calltip and Calltip.  In module calltip_w, class CallTip is now
     CalltipWindow.

   - bpo-33856(38): Add “help” in the welcome message of IDLE

   - bpo-33839(39): IDLE: refactor ToolTip and CallTip and add
     documentation and tests

   - bpo-33855(40): Minimally test all IDLE modules.  Add missing files,
     import module, instantiate classes, and check coverage.  Check
     existing files.

   - bpo-33656(41): On Windows, add API call saying that tk scales for
     DPI. On Windows 8.1+ or 10, with DPI compatibility properties of
     the Python binary unchanged, and a monitor resolution greater than
     96 DPI, this should make text and lines sharper.  It should
     otherwise have no effect.

   - bpo-33768(42): Clicking on a context line moves that line to the
     top of the editor window.

   - bpo-33763(43): IDLE: Use read-only text widget for code context
     instead of label widget.

   - bpo-33664(44): Scroll IDLE editor text by lines.  Previously, the
     mouse wheel and scrollbar slider moved text by a fixed number of
     pixels, resulting in partial lines at the top of the editor box.
     The change also applies to the shell and grep output windows, but
     not to read-only text views.

   - bpo-33679(45): Enable theme-specific color configuration for Code
     Context.  Use the Highlights tab to see the setting for built-in
     themes or add settings to custom themes.

   - bpo-33642(46): Display up to maxlines non-blank lines for Code
     Context.  If there is no current context, show a single blank line.

   - bpo-33628(47): IDLE: Cleanup codecontext.py and its test.

   - bpo-33564(48): IDLE’s code context now recognizes async as a block
     opener.

   - bpo-21474(49): Update word/identifier definition from ascii to
     unicode.  In text and entry boxes, this affects selection by
     double-click, movement left/right by control-left/right, and
     deletion left/right by control-BACKSPACE/DEL.

   - bpo-33204(50): IDLE: consistently color invalid string prefixes.  A
     ‘u’ string prefix cannot be paired with either ‘r’ or ‘f’.
     Consistently color as much of the prefix, starting at the right, as
     is valid.  Revise and extend colorizer test.

   - bpo-32984(51): Set ‘__file__’ while running a startup file.  Like
     Python, IDLE optionally runs one startup file in the Shell window
     before presenting the first interactive input prompt.  For IDLE,
     ‘-s’ runs a file named in environmental variable ‘IDLESTARTUP’ or
     *note PYTHONSTARTUP: 8d9.; ‘-r file’ runs ‘file’.  Python sets
     ‘__file__’ to the startup file name before running the file and
     unsets it before the first prompt.  IDLE now does the same when run
     normally, without the ‘-n’ option.

   - bpo-32940(52): Simplify and rename StringTranslatePseudoMapping in
     pyparse.

   - bpo-32916(53): Change ‘str’ to ‘code’ in pyparse.

   - bpo-32905(54): Remove unused code in pyparse module.

   - bpo-32874(55): Add tests for pyparse.

   - bpo-32837(56): Using the system and place-dependent default
     encoding for open() is a bad idea for IDLE’s system and
     location-independent files.

   - bpo-32826(57): Add “encoding=utf-8” to open() in IDLE’s
     test_help_about.  GUI test test_file_buttons() only looks at
     initial ascii-only lines, but failed on systems where open()
     defaults to ‘ascii’ because readline() internally reads and decodes
     far enough ahead to encounter a non-ascii character in CREDITS.txt.

   - bpo-32831(58): Add docstrings and tests for codecontext.

   - bpo-32765(59): Update configdialog General tab docstring to add new
     widgets to the widget list.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35770

   (2) https://bugs.python.org/issue35769

   (3) https://bugs.python.org/issue35660

   (4) https://bugs.python.org/issue35641

   (5) https://bugs.python.org/issue33987

   (6) https://bugs.python.org/issue34055

   (7) https://bugs.python.org/issue35591

   (8) https://bugs.python.org/issue35196

   (9) https://bugs.python.org/issue35598

   (10) https://bugs.python.org/issue28097

   (11) https://bugs.python.org/issue35208

   (12) https://bugs.python.org/issue35555

   (13) https://bugs.python.org/issue35521

   (14) https://bugs.python.org/issue22703

   (15) https://bugs.python.org/issue35213

   (16) https://bugs.python.org/issue34864

   (17) https://bugs.python.org/issue34864

   (18) https://bugs.python.org/issue35202

   (19) https://bugs.python.org/issue33000

   (20) https://bugs.python.org/issue23220

   (21) https://bugs.python.org/issue35099

   (22) https://bugs.python.org/issue35097

   (23) https://bugs.python.org/issue35093

   (24) https://bugs.python.org/issue35088

   (25) https://bugs.python.org/issue35087

   (26) https://bugs.python.org/issue34548

   (27) https://bugs.python.org/issue1529353

   (28) https://bugs.python.org/issue34047

   (29) https://bugs.python.org/issue34275

   (30) https://bugs.python.org/issue34120

   (31) https://bugs.python.org/issue33975

   (32) https://bugs.python.org/issue33905

   (33) https://bugs.python.org/issue33924

   (34) https://bugs.python.org/issue33906

   (35) https://bugs.python.org/issue33917

   (36) https://bugs.python.org/issue33904

   (37) https://bugs.python.org/issue33907

   (38) https://bugs.python.org/issue33856

   (39) https://bugs.python.org/issue33839

   (40) https://bugs.python.org/issue33855

   (41) https://bugs.python.org/issue33656

   (42) https://bugs.python.org/issue33768

   (43) https://bugs.python.org/issue33763

   (44) https://bugs.python.org/issue33664

   (45) https://bugs.python.org/issue33679

   (46) https://bugs.python.org/issue33642

   (47) https://bugs.python.org/issue33628

   (48) https://bugs.python.org/issue33564

   (49) https://bugs.python.org/issue21474

   (50) https://bugs.python.org/issue33204

   (51) https://bugs.python.org/issue32984

   (52) https://bugs.python.org/issue32940

   (53) https://bugs.python.org/issue32916

   (54) https://bugs.python.org/issue32905

   (55) https://bugs.python.org/issue32874

   (56) https://bugs.python.org/issue32837

   (57) https://bugs.python.org/issue32826

   (58) https://bugs.python.org/issue32831

   (59) https://bugs.python.org/issue32765


File: python.info,  Node: Tools/Demos<8>,  Next: C API<9>,  Prev: IDLE<14>,  Up: Python 3 8 0 alpha 1

1.18.12.10 Tools/Demos
......................

   - bpo-35884(1): Add a benchmark script for timing various ways to
     access variables: ‘Tools/scripts/var_access_benchmark.py’.

   - bpo-34989(2): python-gdb.py now handles errors on computing the
     line number of a Python frame.

   - bpo-20260(3): Argument Clinic now has non-bitwise unsigned int
     converters.

   - bpo-32962(4): python-gdb now catches ‘UnicodeDecodeError’
     exceptions when calling ‘string()’.

   - bpo-32962(5): python-gdb now catches ValueError on read_var(): when
     Python has no debug symbols for example.

   - bpo-33189(6): ‘pygettext.py’ now recognizes only literal strings as
     docstrings and translatable strings, and rejects bytes literals and
     f-string expressions.

   - bpo-31920(7): Fixed handling directories as arguments in the
     ‘pygettext’ script.  Based on patch by Oleg Krasnikov.

   - bpo-29673(8): Fix pystackv and pystack gdbinit macros.

   - bpo-25427(9): Remove the pyvenv script in favor of ‘python3 -m
     venv’ in order to lower confusion as to what Python interpreter a
     virtual environment will be created for.

   - bpo-32885(10): Add an ‘-n’ flag for ‘Tools/scripts/pathfix.py’ to
     disable automatic backup creation (files with ‘~’ suffix).

   - bpo-32222(11): Fix pygettext not extracting docstrings for
     functions with type annotated arguments.  Patch by Toby Harradine.

   - bpo-31583(12): Fix 2to3 for using with –add-suffix option but
     without –output-dir option for relative path to files in current
     directory.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35884

   (2) https://bugs.python.org/issue34989

   (3) https://bugs.python.org/issue20260

   (4) https://bugs.python.org/issue32962

   (5) https://bugs.python.org/issue32962

   (6) https://bugs.python.org/issue33189

   (7) https://bugs.python.org/issue31920

   (8) https://bugs.python.org/issue29673

   (9) https://bugs.python.org/issue25427

   (10) https://bugs.python.org/issue32885

   (11) https://bugs.python.org/issue32222

   (12) https://bugs.python.org/issue31583


File: python.info,  Node: C API<9>,  Prev: Tools/Demos<8>,  Up: Python 3 8 0 alpha 1

1.18.12.11 C API
................

   - bpo-35713(1): The ‘PyByteArray_Init()’ and ‘PyByteArray_Fini()’
     functions have been removed.  They did nothing since Python 2.7.4
     and Python 3.2.0, were excluded from the limited API (stable ABI),
     and were not documented.

   - bpo-33817(2): Fixed *note _PyBytes_Resize(): f82. for empty bytes
     objects.

   - bpo-35322(3): Fix memory leak in *note PyUnicode_EncodeLocale():
     434. and *note PyUnicode_EncodeFSDefault(): f83. on error handling.

   - bpo-35059(4): The following C macros have been converted to static
     inline functions: *note Py_INCREF(): 263, *note Py_DECREF(): 264,
     *note Py_XINCREF(): 265, *note Py_XDECREF(): 266,
     ‘PyObject_INIT()’, ‘PyObject_INIT_VAR()’.

   - bpo-35296(5): ‘make install’ now also installs the internal API:
     ‘Include/internal/*.h’ header files.

   - bpo-35081(6): Internal APIs surrounded by ‘#ifdef Py_BUILD_CORE’
     have been moved from ‘Include/*.h’ headers to new header files
     ‘Include/internal/pycore_*.h’.

   - bpo-35259(7): Conditionally declare *note Py_FinalizeEx(): 5be.
     (new in 3.6) based on Py_LIMITED_API. Patch by Arthur Neufeld.

   - bpo-35081(8): The ‘_PyObject_GC_TRACK()’ and
     ‘_PyObject_GC_UNTRACK()’ macros have been removed from the public C
     API.

   - bpo-35134(9): Creation of a new ‘Include/cpython/’ subdirectory.

   - bpo-34725(10): Adds _Py_SetProgramFullPath so embedders may
     override sys.executable

   - bpo-34910(11): Ensure that *note PyObject_Print(): f84. always
     returns ‘-1’ on error.  Patch by Zackery Spytz.

   - bpo-34523(12): Py_DecodeLocale() and Py_EncodeLocale() now use the
     UTF-8 encoding on Windows if Py_LegacyWindowsFSEncodingFlag is
     zero.

   - bpo-34193(13): Fix pluralization in TypeError messages in getargs.c
     and typeobject.c: ‘1 argument’ instead of ‘1 arguments’ and ‘1
     element’ instead of ‘1 elements’.

   - bpo-34127(14): Return grammatically correct error message based on
     argument count.  Patch by Karthikeyan Singaravelan.

   - bpo-23927(15): Fixed *note SystemError: 5f0. in *note
     PyArg_ParseTupleAndKeywords(): 5bf. when the ‘w*’ format unit is
     used for optional parameter.

   - bpo-32455(16): Added ‘PyCompile_OpcodeStackEffectWithJump()’.

   - bpo-34008(17): Py_Main() can again be called after Py_Initialize(),
     as in Python 3.6.

   - bpo-32500(18): Fixed error messages for *note PySequence_Size():
     f85, *note PySequence_GetItem(): f86, *note PySequence_SetItem():
     f87. and *note PySequence_DelItem(): f88. called with a mapping and
     *note PyMapping_Size(): f89. called with a sequence.

   - bpo-33818(19): ‘PyExceptionClass_Name()’ will now return ‘const
     char *’ instead of ‘char *’.

   - bpo-33042(20): Embedding applications may once again call
     PySys_ResetWarnOptions, PySys_AddWarnOption, and PySys_AddXOption
     prior to calling Py_Initialize.

   - bpo-32374(21): Document that m_traverse for multi-phase initialized
     modules can be called with m_state=NULL, and add a sanity check

   - bpo-30863(22): *note PyUnicode_AsWideChar(): f8a. and *note
     PyUnicode_AsWideCharString(): 42d. no longer cache the ‘wchar_t*’
     representation of string objects.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35713

   (2) https://bugs.python.org/issue33817

   (3) https://bugs.python.org/issue35322

   (4) https://bugs.python.org/issue35059

   (5) https://bugs.python.org/issue35296

   (6) https://bugs.python.org/issue35081

   (7) https://bugs.python.org/issue35259

   (8) https://bugs.python.org/issue35081

   (9) https://bugs.python.org/issue35134

   (10) https://bugs.python.org/issue34725

   (11) https://bugs.python.org/issue34910

   (12) https://bugs.python.org/issue34523

   (13) https://bugs.python.org/issue34193

   (14) https://bugs.python.org/issue34127

   (15) https://bugs.python.org/issue23927

   (16) https://bugs.python.org/issue32455

   (17) https://bugs.python.org/issue34008

   (18) https://bugs.python.org/issue32500

   (19) https://bugs.python.org/issue33818

   (20) https://bugs.python.org/issue33042

   (21) https://bugs.python.org/issue32374

   (22) https://bugs.python.org/issue30863


File: python.info,  Node: Python 3 7 0 final,  Next: Python 3 7 0 release candidate 1,  Prev: Python 3 8 0 alpha 1,  Up: Changelog

1.18.13 Python 3.7.0 final
--------------------------

`Release date: 2018-06-27'

* Menu:

* Library: Library<13>.
* C API: C API<10>.


File: python.info,  Node: Library<13>,  Next: C API<10>,  Up: Python 3 7 0 final

1.18.13.1 Library
.................

   - bpo-33851(1): Fix *note ast.get_docstring(): f8d. for a node that
     lacks a docstring.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33851


File: python.info,  Node: C API<10>,  Prev: Library<13>,  Up: Python 3 7 0 final

1.18.13.2 C API
...............

   - bpo-33932(1): Calling Py_Initialize() twice does nothing, instead
     of failing with a fatal error: restore the Python 3.6 behaviour.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33932


File: python.info,  Node: Python 3 7 0 release candidate 1,  Next: Python 3 7 0 beta 5,  Prev: Python 3 7 0 final,  Up: Changelog

1.18.14 Python 3.7.0 release candidate 1
----------------------------------------

`Release date: 2018-06-12'

* Menu:

* Core and Builtins: Core and Builtins<13>.
* Library: Library<14>.
* Documentation: Documentation<13>.
* Build: Build<10>.
* Windows: Windows<13>.
* IDLE: IDLE<15>.


File: python.info,  Node: Core and Builtins<13>,  Next: Library<14>,  Up: Python 3 7 0 release candidate 1

1.18.14.1 Core and Builtins
...........................

   - bpo-33803(1): Fix a crash in hamt.c caused by enabling GC tracking
     for an object that hadn’t all of its fields set to NULL.

   - bpo-33706(2): Fix a crash in Python initialization when parsing the
     command line options.  Thanks Christoph Gohlke for the bug report
     and the fix!

   - bpo-30654(3): Fixed reset of the SIGINT handler to SIG_DFL on
     interpreter shutdown even when there was a custom handler set
     previously.  Patch by Philipp Kerling.

   - bpo-31849(4): Fix signed/unsigned comparison warning in pyhash.c.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33803

   (2) https://bugs.python.org/issue33706

   (3) https://bugs.python.org/issue30654

   (4) https://bugs.python.org/issue31849


File: python.info,  Node: Library<14>,  Next: Documentation<13>,  Prev: Core and Builtins<13>,  Up: Python 3 7 0 release candidate 1

1.18.14.2 Library
.................

   - bpo-30167(1): Prevent site.main() exception if PYTHONSTARTUP is
     set.  Patch by Steve Weber.

   - bpo-33812(2): Datetime instance d with non-None tzinfo, but with
     d.tzinfo.utcoffset(d) returning None is now treated as naive by the
     astimezone() method.

   - bpo-30805(3): Avoid race condition with debug logging

   - bpo-33694(4): asyncio: Fix a race condition causing data loss on
     pause_reading()/resume_reading() when using the ProactorEventLoop.

   - bpo-32493(5): Correct test for ‘uuid_enc_be’ availability in
     ‘configure.ac’.  Patch by Michael Felt.

   - bpo-33792(6): Add asyncio.WindowsSelectorEventLoopPolicy and
     asyncio.WindowsProactorEventLoopPolicy.

   - bpo-33778(7): Update ‘unicodedata’’s database to Unicode version
     11.0.0.

   - bpo-33770(8): improve base64 exception message for encoded inputs
     of invalid length

   - bpo-33769(9): asyncio/start_tls: Fix error message; cancel
     callbacks in case of an unhandled error; mark SSLTransport as
     closed if it is aborted.

   - bpo-33767(10): The concatenation (‘+’) and repetition (‘*’)
     sequence operations now raise *note TypeError: 192. instead of
     *note SystemError: 5f0. when performed on *note mmap.mmap: 1ea.
     objects.  Patch by Zackery Spytz.

   - bpo-33734(11): asyncio/ssl: Fix AttributeError, increase default
     handshake timeout

   - bpo-11874(12): Use a better regex when breaking usage into
     wrappable parts.  Avoids bogus assertion errors from custom metavar
     strings.

   - bpo-33582(13): Emit a deprecation warning for inspect.formatargspec

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30167

   (2) https://bugs.python.org/issue33812

   (3) https://bugs.python.org/issue30805

   (4) https://bugs.python.org/issue33694

   (5) https://bugs.python.org/issue32493

   (6) https://bugs.python.org/issue33792

   (7) https://bugs.python.org/issue33778

   (8) https://bugs.python.org/issue33770

   (9) https://bugs.python.org/issue33769

   (10) https://bugs.python.org/issue33767

   (11) https://bugs.python.org/issue33734

   (12) https://bugs.python.org/issue11874

   (13) https://bugs.python.org/issue33582


File: python.info,  Node: Documentation<13>,  Next: Build<10>,  Prev: Library<14>,  Up: Python 3 7 0 release candidate 1

1.18.14.3 Documentation
.......................

   - bpo-33409(1): Clarified the relationship between PEP 538(2)’s
     PYTHONCOERCECLOCALE and PEP 540’s PYTHONUTF8 mode.

   - bpo-33736(3): Improve the documentation of *note
     asyncio.open_connection(): 358, *note asyncio.start_server(): 359.
     and their UNIX socket counterparts.

   - bpo-31432(4): Clarify meaning of CERT_NONE, CERT_OPTIONAL, and
     CERT_REQUIRED flags for ssl.SSLContext.verify_mode.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33409

   (2) https://www.python.org/dev/peps/pep-0538

   (3) https://bugs.python.org/issue33736

   (4) https://bugs.python.org/issue31432


File: python.info,  Node: Build<10>,  Next: Windows<13>,  Prev: Documentation<13>,  Up: Python 3 7 0 release candidate 1

1.18.14.4 Build
...............

   - bpo-5755(1): Move ‘-Wstrict-prototypes’ option to ‘CFLAGS_NODIST’
     from ‘OPT’.  This option emitted annoying warnings when building
     extension modules written in C++.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5755


File: python.info,  Node: Windows<13>,  Next: IDLE<15>,  Prev: Build<10>,  Up: Python 3 7 0 release candidate 1

1.18.14.5 Windows
.................

   - bpo-33720(1): Reduces maximum marshal recursion depth on release
     builds.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33720


File: python.info,  Node: IDLE<15>,  Prev: Windows<13>,  Up: Python 3 7 0 release candidate 1

1.18.14.6 IDLE
..............

   - bpo-33656(1): On Windows, add API call saying that tk scales for
     DPI. On Windows 8.1+ or 10, with DPI compatibility properties of
     the Python binary unchanged, and a monitor resolution greater than
     96 DPI, this should make text and lines sharper.  It should
     otherwise have no effect.

   - bpo-33768(2): Clicking on a context line moves that line to the top
     of the editor window.

   - bpo-33763(3): IDLE: Use read-only text widget for code context
     instead of label widget.

   - bpo-33664(4): Scroll IDLE editor text by lines.  Previously, the
     mouse wheel and scrollbar slider moved text by a fixed number of
     pixels, resulting in partial lines at the top of the editor box.
     The change also applies to the shell and grep output windows, but
     not to read-only text views.

   - bpo-33679(5): Enable theme-specific color configuration for Code
     Context.  Use the Highlights tab to see the setting for built-in
     themes or add settings to custom themes.

   - bpo-33642(6): Display up to maxlines non-blank lines for Code
     Context.  If there is no current context, show a single blank line.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33656

   (2) https://bugs.python.org/issue33768

   (3) https://bugs.python.org/issue33763

   (4) https://bugs.python.org/issue33664

   (5) https://bugs.python.org/issue33679

   (6) https://bugs.python.org/issue33642


File: python.info,  Node: Python 3 7 0 beta 5,  Next: Python 3 7 0 beta 4,  Prev: Python 3 7 0 release candidate 1,  Up: Changelog

1.18.15 Python 3.7.0 beta 5
---------------------------

`Release date: 2018-05-30'

* Menu:

* Core and Builtins: Core and Builtins<14>.
* Library: Library<15>.
* Documentation: Documentation<14>.
* Tests: Tests<13>.
* Build: Build<11>.
* macOS: macOS<9>.
* IDLE: IDLE<16>.


File: python.info,  Node: Core and Builtins<14>,  Next: Library<15>,  Up: Python 3 7 0 beta 5

1.18.15.1 Core and Builtins
...........................

   - bpo-33622(1): Fixed a leak when the garbage collector fails to add
     an object with the ‘__del__’ method or referenced by it into the
     *note gc.garbage: b33. list.  ‘PyGC_Collect()’ can now be called
     when an exception is set and preserves it.

   - bpo-33509(2): Fix module_globals parameter of
     warnings.warn_explicit(): don’t crash if module_globals is not a
     dict.

   - bpo-20104(3): The new *note os.posix_spawn: 255. added in 3.7.0b1
     was removed as we are still working on what the API should look
     like.  Expect this in 3.8 instead.

   - bpo-33475(4): Fixed miscellaneous bugs in converting annotations to
     strings and optimized parentheses in the string representation.

   - bpo-33391(5): Fix a leak in set_symmetric_difference().

   - bpo-28055(6): Fix unaligned accesses in siphash24().  Patch by Rolf
     Eike Beer.

   - bpo-32911(7): Due to unexpected compatibility issues discovered
     during downstream beta testing, reverted bpo-29463(8).  ‘docstring’
     field is removed from Module, ClassDef, FunctionDef, and
     AsyncFunctionDef ast nodes which was added in 3.7a1.  Docstring
     expression is restored as a first statement in their body.  Based
     on patch by Inada Naoki.

   - bpo-21983(9): Fix a crash in *note ctypes.cast(): f4a. in case the
     type argument is a ctypes structured data type.  Patch by Eryk Sun
     and Oren Milman.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33622

   (2) https://bugs.python.org/issue33509

   (3) https://bugs.python.org/issue20104

   (4) https://bugs.python.org/issue33475

   (5) https://bugs.python.org/issue33391

   (6) https://bugs.python.org/issue28055

   (7) https://bugs.python.org/issue32911

   (8) https://bugs.python.org/issue29463

   (9) https://bugs.python.org/issue21983


File: python.info,  Node: Library<15>,  Next: Documentation<14>,  Prev: Core and Builtins<14>,  Up: Python 3 7 0 beta 5

1.18.15.2 Library
.................

   - bpo-32751(1): When cancelling the task due to a timeout, *note
     asyncio.wait_for(): 286. will now wait until the cancellation is
     complete.

   - bpo-32684(2): Fix gather to propagate cancellation of itself even
     with return_exceptions.

   - bpo-33654(3): Support protocol type switching in
     SSLTransport.set_protocol().

   - bpo-33674(4): Pause the transport as early as possible to further
     reduce the risk of data_received() being called before
     connection_made().

   - bpo-33674(5): Fix a race condition in SSLProtocol.connection_made()
     of asyncio.sslproto: start immediately the handshake instead of
     using call_soon().  Previously, data_received() could be called
     before the handshake started, causing the handshake to hang or
     fail.

   - bpo-31647(6): Fixed bug where calling write_eof() on a
     _SelectorSocketTransport after it’s already closed raises
     AttributeError.

   - bpo-32610(7): Make asyncio.all_tasks() return only pending tasks.

   - bpo-32410(8): Avoid blocking on file IO in sendfile fallback code

   - bpo-33469(9): Fix RuntimeError after closing loop that used
     run_in_executor

   - bpo-33672(10): Fix Task.__repr__ crash with Cython’s bogus
     coroutines

   - bpo-33654(11): Fix transport.set_protocol() to support switching
     between asyncio.Protocol and asyncio.BufferedProtocol.  Fix
     loop.start_tls() to work with asyncio.BufferedProtocols.

   - bpo-33652(12): Pickles of type variables and subscripted generics
     are now future-proof and compatible with older Python versions.

   - bpo-32493(13): Fixed *note uuid.uuid1(): 408. on FreeBSD.

   - bpo-33618(14): Finalize and document preliminary and experimental
     TLS 1.3 support with OpenSSL 1.1.1

   - bpo-33623(15): Fix possible SIGSGV when asyncio.Future is created
     in __del__

   - bpo-30877(16): Fixed a bug in the Python implementation of the JSON
     decoder that prevented the cache of parsed strings from clearing
     after finishing the decoding.  Based on patch by c-fos.

   - bpo-33570(17): Change TLS 1.3 cipher suite settings for
     compatibility with OpenSSL 1.1.1-pre6 and newer.  OpenSSL 1.1.1
     will have TLS 1.3 ciphers enabled by default.

   - bpo-28556(18): Do not simplify arguments to *note typing.Union:
     f6c.  Now ‘Union[Manager, Employee]’ is not simplified to
     ‘Employee’ at runtime.  Such simplification previously caused
     several bugs and limited possibilities for introspection.

   - bpo-33540(19): Add a new ‘block_on_close’ class attribute to
     ‘ForkingMixIn’ and ‘ThreadingMixIn’ classes of *note socketserver:
     f0.

   - bpo-33548(20): tempfile._candidate_tempdir_list should consider
     common TEMP locations

   - bpo-33109(21): argparse subparsers are once again not required by
     default, reverting the change in behavior introduced by
     bpo-26510(22) in 3.7.0a2.

   - bpo-33536(23): dataclasses.make_dataclass now checks for invalid
     field names and duplicate fields.  Also, added a check for invalid
     field specifications.

   - bpo-33542(24): Prevent ‘uuid.get_node’ from using a DUID instead of
     a MAC on Windows.  Patch by Zvi Effron

   - bpo-26819(25): Fix race condition with
     ‘ReadTransport.resume_reading’ in Windows proactor event loop.

   - Fix failure in *note typing.get_type_hints(): 2ff. when ClassVar
     was provided as a string forward reference.

   - bpo-33505(26): Optimize asyncio.ensure_future() by reordering if
     checks: 1.17x faster.

   - bpo-33497(27): Add errors param to cgi.parse_multipart and make an
     encoding in FieldStorage use the given errors (needed for Twisted).
     Patch by Amber Brown.

   - bpo-33495(28): Change dataclasses.Fields repr to use the repr of
     each of its members, instead of str.  This makes it more clear what
     each field actually represents.  This is especially true for the
     ‘type’ member.

   - bpo-33453(29): Fix dataclasses to work if using literal string type
     annotations or if using PEP 563 “Postponed Evaluation of
     Annotations”.  Only specific string prefixes are detected for both
     ClassVar (“ClassVar” and “typing.ClassVar”) and InitVar (“InitVar”
     and “dataclasses.InitVar”).

   - bpo-28556(30): Minor fixes in typing module: add annotations to
     ‘NamedTuple.__new__’, pass ‘*args’ and ‘**kwds’ in
     ‘Generic.__new__’.  Original PRs by Paulius Šarka and Chad
     Dombrova.

   - bpo-20087(31): Updated alias mapping with glibc 2.27 supported
     locales.

   - bpo-33422(32): Fix trailing quotation marks getting deleted when
     looking up byte/string literals on pydoc.  Patch by Andrés Delfino.

   - bpo-28167(33): The function ‘platform.linux_distribution’ and
     ‘platform.dist’ now trigger a ‘DeprecationWarning’ and have been
     marked for removal in Python 3.8

   - bpo-33197(34): Update error message when constructing invalid
     inspect.Parameters Patch by Dong-hee Na.

   - bpo-33263(35): Fix FD leak in ‘_SelectorSocketTransport’ Patch by
     Vlad Starostin.

   - bpo-32861(36): The urllib.robotparser’s ‘__str__’ representation
     now includes wildcard entries and the “Crawl-delay” and
     “Request-rate” fields.  Patch by Michael Lazar.

   - bpo-32257(37): The ssl module now contains OP_NO_RENEGOTIATION
     constant, available with OpenSSL 1.1.0h or 1.1.1.

   - bpo-16865(38): Support arrays >=2GiB in *note ctypes: 2b.  Patch by
     Segev Finer.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32751

   (2) https://bugs.python.org/issue32684

   (3) https://bugs.python.org/issue33654

   (4) https://bugs.python.org/issue33674

   (5) https://bugs.python.org/issue33674

   (6) https://bugs.python.org/issue31647

   (7) https://bugs.python.org/issue32610

   (8) https://bugs.python.org/issue32410

   (9) https://bugs.python.org/issue33469

   (10) https://bugs.python.org/issue33672

   (11) https://bugs.python.org/issue33654

   (12) https://bugs.python.org/issue33652

   (13) https://bugs.python.org/issue32493

   (14) https://bugs.python.org/issue33618

   (15) https://bugs.python.org/issue33623

   (16) https://bugs.python.org/issue30877

   (17) https://bugs.python.org/issue33570

   (18) https://bugs.python.org/issue28556

   (19) https://bugs.python.org/issue33540

   (20) https://bugs.python.org/issue33548

   (21) https://bugs.python.org/issue33109

   (22) https://bugs.python.org/issue26510

   (23) https://bugs.python.org/issue33536

   (24) https://bugs.python.org/issue33542

   (25) https://bugs.python.org/issue26819

   (26) https://bugs.python.org/issue33505

   (27) https://bugs.python.org/issue33497

   (28) https://bugs.python.org/issue33495

   (29) https://bugs.python.org/issue33453

   (30) https://bugs.python.org/issue28556

   (31) https://bugs.python.org/issue20087

   (32) https://bugs.python.org/issue33422

   (33) https://bugs.python.org/issue28167

   (34) https://bugs.python.org/issue33197

   (35) https://bugs.python.org/issue33263

   (36) https://bugs.python.org/issue32861

   (37) https://bugs.python.org/issue32257

   (38) https://bugs.python.org/issue16865


File: python.info,  Node: Documentation<14>,  Next: Tests<13>,  Prev: Library<15>,  Up: Python 3 7 0 beta 5

1.18.15.3 Documentation
.......................

   - bpo-23859(1): Document that *note asyncio.wait(): 287. does not
     cancel its futures on timeout.

   - bpo-32436(2): Document PEP 567(3) changes to asyncio.

   - bpo-33604(4): Update HMAC md5 default to a DeprecationWarning, bump
     removal to 3.8.

   - bpo-33503(5): Fix broken pypi link

   - bpo-33421(6): Add missing documentation for
     ‘typing.AsyncContextManager’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23859

   (2) https://bugs.python.org/issue32436

   (3) https://www.python.org/dev/peps/pep-0567

   (4) https://bugs.python.org/issue33604

   (5) https://bugs.python.org/issue33503

   (6) https://bugs.python.org/issue33421


File: python.info,  Node: Tests<13>,  Next: Build<11>,  Prev: Documentation<14>,  Up: Python 3 7 0 beta 5

1.18.15.4 Tests
...............

   - bpo-33655(1): Ignore test_posix_fallocate failures on BSD platforms
     that might be due to running on ZFS.

   - bpo-32604(2): Remove the _xxsubinterpreters module (meant for
     testing) and associated helpers.  This module was originally added
     recently in 3.7b1.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33655

   (2) https://bugs.python.org/issue32604


File: python.info,  Node: Build<11>,  Next: macOS<9>,  Prev: Tests<13>,  Up: Python 3 7 0 beta 5

1.18.15.5 Build
...............

   - bpo-33614(1): Ensures module definition files for the stable ABI on
     Windows are correctly regenerated.

   - bpo-33522(2): Enable CI builds on Visual Studio Team Services at
     ‘https://python.visualstudio.com/cpython’

   - bpo-33012(3): Add ‘-Wno-cast-function-type’ for gcc 8 for silencing
     warnings about function casts like casting to PyCFunction in method
     definition lists.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33614

   (2) https://bugs.python.org/issue33522

   (3) https://bugs.python.org/issue33012


File: python.info,  Node: macOS<9>,  Next: IDLE<16>,  Prev: Build<11>,  Up: Python 3 7 0 beta 5

1.18.15.6 macOS
...............

   - bpo-13631(1): The .editrc file in user’s home directory is now
     processed correctly during the readline initialization through
     editline emulation on macOS.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13631


File: python.info,  Node: IDLE<16>,  Prev: macOS<9>,  Up: Python 3 7 0 beta 5

1.18.15.7 IDLE
..............

   - bpo-33628(1): IDLE: Cleanup codecontext.py and its test.

   - bpo-33564(2): IDLE’s code context now recognizes async as a block
     opener.

   - bpo-32831(3): Add docstrings and tests for codecontext.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33628

   (2) https://bugs.python.org/issue33564

   (3) https://bugs.python.org/issue32831


File: python.info,  Node: Python 3 7 0 beta 4,  Next: Python 3 7 0 beta 3,  Prev: Python 3 7 0 beta 5,  Up: Changelog

1.18.16 Python 3.7.0 beta 4
---------------------------

`Release date: 2018-05-02'

* Menu:

* Core and Builtins: Core and Builtins<15>.
* Library: Library<16>.
* Documentation: Documentation<15>.
* Tests: Tests<14>.
* Build: Build<12>.
* Windows: Windows<14>.
* macOS: macOS<10>.
* IDLE: IDLE<17>.
* Tools/Demos: Tools/Demos<9>.


File: python.info,  Node: Core and Builtins<15>,  Next: Library<16>,  Up: Python 3 7 0 beta 4

1.18.16.1 Core and Builtins
...........................

   - bpo-33363(1): Raise a SyntaxError for ‘async with’ and ‘async for’
     statements outside of async functions.

   - bpo-33128(2): Fix a bug that causes PathFinder to appear twice on
     sys.meta_path.  Patch by Pablo Galindo Salgado.

   - bpo-33312(3): Fixed clang ubsan (undefined behavior sanitizer)
     warnings in dictobject.c by adjusting how the internal struct
     _dictkeysobject shared keys structure is declared.

   - bpo-33231(4): Fix potential memory leak in ‘normalizestring()’.

   - bpo-33205(5): Change dict growth function from
     ‘round_up_to_power_2(used*2+hashtable_size/2)’ to
     ‘round_up_to_power_2(used*3)’.  Previously, dict is shrinked only
     when ‘used == 0’.  Now dict has more chance to be shrinked.

   - bpo-29922(6): Improved error messages in ‘async with’ when
     ‘__aenter__()’ or ‘__aexit__()’ return non-awaitable object.

   - bpo-33199(7): Fix ‘ma_version_tag’ in dict implementation is
     uninitialized when copying from key-sharing dict.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33363

   (2) https://bugs.python.org/issue33128

   (3) https://bugs.python.org/issue33312

   (4) https://bugs.python.org/issue33231

   (5) https://bugs.python.org/issue33205

   (6) https://bugs.python.org/issue29922

   (7) https://bugs.python.org/issue33199


File: python.info,  Node: Library<16>,  Next: Documentation<15>,  Prev: Core and Builtins<15>,  Up: Python 3 7 0 beta 4

1.18.16.2 Library
.................

   - bpo-33281(1): Fix ctypes.util.find_library regression on macOS.

   - bpo-33383(2): Fixed crash in the get() method of the *note
     dbm.ndbm: 35. database object when it is called with a single
     argument.

   - bpo-33329(3): Fix multiprocessing regression on newer glibcs

   - bpo-991266(4): Fix quoting of the ‘Comment’ attribute of *note
     http.cookies.SimpleCookie: f70.

   - bpo-33131(5): Upgrade bundled version of pip to 10.0.1.

   - bpo-33308(6): Fixed a crash in the *note parser: c7. module when
     converting an ST object to a tree of tuples or lists with
     ‘line_info=False’ and ‘col_info=True’.

   - bpo-33266(7): lib2to3 now recognizes ‘rf'...'’ strings.

   - bpo-11594(8): Ensure line-endings are respected when using lib2to3.

   - bpo-33254(9): Have *note importlib.resources.contents(): f71. and
     *note importlib.abc.ResourceReader.contents(): f72. return an *note
     iterable: b9f. instead of an *note iterator: f73.

   - bpo-33256(10): Fix display of ‘<module>’ call in the html produced
     by ‘cgitb.html()’.  Patch by Stéphane Blondon.

   - bpo-33185(11): Fixed regression when running pydoc with the *note
     -m: 32c. switch.  (The regression was introduced in 3.7.0b3 by the
     resolution of bpo-33053(12)) This fix also changed pydoc to add
     ‘os.getcwd()’ to *note sys.path: 47d. when necessary, rather than
     adding ‘"."’.

   - bpo-33169(13): Delete entries of ‘None’ in *note
     sys.path_importer_cache: 493. when
     ‘importlib.machinery.invalidate_caches()’ is called.

   - bpo-33217(14): Deprecate looking up non-Enum objects in Enum
     classes and Enum members (will raise *note TypeError: 192. in
     3.8+).

   - bpo-33203(15): ‘random.Random.choice()’ now raises ‘IndexError’ for
     empty sequences consistently even when called from subclasses
     without a ‘getrandbits()’ implementation.

   - bpo-33224(16): Update difflib.mdiff() for PEP 479(17).  Convert an
     uncaught StopIteration in a generator into a return-statement.

   - bpo-33209(18): End framing at the end of C implementation of *note
     pickle.Pickler.dump(): f74.

   - bpo-20104(19): Improved error handling and fixed a reference leak
     in *note os.posix_spawn(): 255.

   - bpo-33175(20): In dataclasses, Field.__set_name__ now looks up the
     __set_name__ special method on the class, not the instance, of the
     default value.

   - bpo-33097(21): Raise RuntimeError when ‘executor.submit’ is called
     during interpreter shutdown.

   - bpo-31908(22): Fix output of cover files for ‘trace’ module
     command-line tool.  Previously emitted cover files only when
     ‘--missing’ option was used.  Patch by Michael Selik.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33281

   (2) https://bugs.python.org/issue33383

   (3) https://bugs.python.org/issue33329

   (4) https://bugs.python.org/issue991266

   (5) https://bugs.python.org/issue33131

   (6) https://bugs.python.org/issue33308

   (7) https://bugs.python.org/issue33266

   (8) https://bugs.python.org/issue11594

   (9) https://bugs.python.org/issue33254

   (10) https://bugs.python.org/issue33256

   (11) https://bugs.python.org/issue33185

   (12) https://bugs.python.org/issue33053

   (13) https://bugs.python.org/issue33169

   (14) https://bugs.python.org/issue33217

   (15) https://bugs.python.org/issue33203

   (16) https://bugs.python.org/issue33224

   (17) https://www.python.org/dev/peps/pep-0479

   (18) https://bugs.python.org/issue33209

   (19) https://bugs.python.org/issue20104

   (20) https://bugs.python.org/issue33175

   (21) https://bugs.python.org/issue33097

   (22) https://bugs.python.org/issue31908


File: python.info,  Node: Documentation<15>,  Next: Tests<14>,  Prev: Library<16>,  Up: Python 3 7 0 beta 4

1.18.16.3 Documentation
.......................

   - bpo-33378(1): Add Korean language switcher for
     ‘https://docs.python.org/3/’

   - bpo-33276(2): Clarify that the ‘__path__’ attribute on modules
     cannot be just any value.

   - bpo-33201(3): Modernize documentation for writing C extension
     types.

   - bpo-33195(4): Deprecate ‘Py_UNICODE’ usage in ‘c-api/arg’ document.
     ‘Py_UNICODE’ related APIs are deprecated since Python 3.3, but it
     is missed in the document.

   - bpo-8243(5): Add a note about curses.addch and curses.addstr
     exception behavior when writing outside a window, or pad.

   - bpo-32337(6): Update documentation related with ‘dict’ order.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33378

   (2) https://bugs.python.org/issue33276

   (3) https://bugs.python.org/issue33201

   (4) https://bugs.python.org/issue33195

   (5) https://bugs.python.org/issue8243

   (6) https://bugs.python.org/issue32337


File: python.info,  Node: Tests<14>,  Next: Build<12>,  Prev: Documentation<15>,  Up: Python 3 7 0 beta 4

1.18.16.4 Tests
...............

   - bpo-33358(1): Fix
     ‘test_embed.test_pre_initialization_sys_options()’ when the
     interpreter is built with ‘--enable-shared’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33358


File: python.info,  Node: Build<12>,  Next: Windows<14>,  Prev: Tests<14>,  Up: Python 3 7 0 beta 4

1.18.16.5 Build
...............

   - bpo-33394(1): Enable the verbose build for extension modules, when
     GNU make is passed macros on the command line.

   - bpo-33393(2): Update config.guess and config.sub files.

   - bpo-33377(3): Add new triplets for mips r6 and riscv variants (used
     in extension suffixes).

   - bpo-32232(4): By default, modules configured in ‘Modules/Setup’ are
     no longer built with ‘-DPy_BUILD_CORE’.  Instead, modules that
     specifically need that preprocessor definition include it in their
     individual entries.

   - bpo-33182(5): The embedding tests can once again be built with
     clang 6.0

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33394

   (2) https://bugs.python.org/issue33393

   (3) https://bugs.python.org/issue33377

   (4) https://bugs.python.org/issue32232

   (5) https://bugs.python.org/issue33182


File: python.info,  Node: Windows<14>,  Next: macOS<10>,  Prev: Build<12>,  Up: Python 3 7 0 beta 4

1.18.16.6 Windows
.................

   - bpo-33184(1): Update Windows installer to use OpenSSL 1.1.0h.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33184


File: python.info,  Node: macOS<10>,  Next: IDLE<17>,  Prev: Windows<14>,  Up: Python 3 7 0 beta 4

1.18.16.7 macOS
...............

   - bpo-33184(1): Update macOS installer build to use OpenSSL 1.1.0h.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33184


File: python.info,  Node: IDLE<17>,  Next: Tools/Demos<9>,  Prev: macOS<10>,  Up: Python 3 7 0 beta 4

1.18.16.8 IDLE
..............

   - bpo-21474(1): Update word/identifier definition from ascii to
     unicode.  In text and entry boxes, this affects selection by
     double-click, movement left/right by control-left/right, and
     deletion left/right by control-BACKSPACE/DEL.

   - bpo-33204(2): IDLE: consistently color invalid string prefixes.  A
     ‘u’ string prefix cannot be paired with either ‘r’ or ‘f’.
     Consistently color as much of the prefix, starting at the right, as
     is valid.  Revise and extend colorizer test.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21474

   (2) https://bugs.python.org/issue33204


File: python.info,  Node: Tools/Demos<9>,  Prev: IDLE<17>,  Up: Python 3 7 0 beta 4

1.18.16.9 Tools/Demos
.....................

   - bpo-33189(1): ‘pygettext.py’ now recognizes only literal strings as
     docstrings and translatable strings, and rejects bytes literals and
     f-string expressions.

   - bpo-31920(2): Fixed handling directories as arguments in the
     ‘pygettext’ script.  Based on patch by Oleg Krasnikov.

   - bpo-29673(3): Fix pystackv and pystack gdbinit macros.

   - bpo-31583(4): Fix 2to3 for using with –add-suffix option but
     without –output-dir option for relative path to files in current
     directory.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33189

   (2) https://bugs.python.org/issue31920

   (3) https://bugs.python.org/issue29673

   (4) https://bugs.python.org/issue31583


File: python.info,  Node: Python 3 7 0 beta 3,  Next: Python 3 7 0 beta 2,  Prev: Python 3 7 0 beta 4,  Up: Changelog

1.18.17 Python 3.7.0 beta 3
---------------------------

`Release date: 2018-03-29'

* Menu:

* Security: Security<10>.
* Core and Builtins: Core and Builtins<16>.
* Library: Library<17>.
* Documentation: Documentation<16>.
* Tests: Tests<15>.
* Build: Build<13>.
* Windows: Windows<15>.
* macOS: macOS<11>.
* IDLE: IDLE<18>.
* Tools/Demos: Tools/Demos<10>.
* C API: C API<11>.


File: python.info,  Node: Security<10>,  Next: Core and Builtins<16>,  Up: Python 3 7 0 beta 3

1.18.17.1 Security
..................

   - bpo-33136(1): Harden ssl module against LibreSSL CVE-2018-8970.
     X509_VERIFY_PARAM_set1_host() is called with an explicit namelen.
     A new test ensures that NULL bytes are not allowed.

   - bpo-33001(2): Minimal fix to prevent buffer overrun in os.symlink
     on Windows

   - bpo-32981(3): Regexes in difflib and poplib were vulnerable to
     catastrophic backtracking.  These regexes formed potential DOS
     vectors (REDOS). They have been refactored.  This resolves
     CVE-2018-1060 and CVE-2018-1061.  Patch by Jamie Davis.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33136

   (2) https://bugs.python.org/issue33001

   (3) https://bugs.python.org/issue32981


File: python.info,  Node: Core and Builtins<16>,  Next: Library<17>,  Prev: Security<10>,  Up: Python 3 7 0 beta 3

1.18.17.2 Core and Builtins
...........................

   - bpo-33053(1): When using the -m switch, sys.path[0] is now
     explicitly expanded as the `starting' working directory, rather
     than being left as the empty path (which allows imports from the
     current working directory at the time of the import)

   - bpo-33018(2): Improve consistency of errors raised by
     ‘issubclass()’ when called with a non-class and an abstract base
     class as the first and second arguments, respectively.  Patch by
     Josh Bronson.

   - bpo-33041(3): Fixed jumping when the function contains an ‘async
     for’ loop.

   - bpo-33026(4): Fixed jumping out of “with” block by setting
     f_lineno.

   - bpo-33005(5): Fix a crash on fork when using a custom memory
     allocator (ex: using PYTHONMALLOC env var).  _PyGILState_Reinit()
     and _PyInterpreterState_Enable() now use the default RAW memory
     allocator to allocate a new interpreters mutex on fork.

   - bpo-17288(6): Prevent jumps from ‘return’ and ‘exception’ trace
     events.

   - bpo-32836(7): Don’t use temporary variables in cases of
     list/dict/set comprehensions

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33053

   (2) https://bugs.python.org/issue33018

   (3) https://bugs.python.org/issue33041

   (4) https://bugs.python.org/issue33026

   (5) https://bugs.python.org/issue33005

   (6) https://bugs.python.org/issue17288

   (7) https://bugs.python.org/issue32836


File: python.info,  Node: Library<17>,  Next: Documentation<16>,  Prev: Core and Builtins<16>,  Up: Python 3 7 0 beta 3

1.18.17.3 Library
.................

   - bpo-33141(1): Have Field objects pass through __set_name__ to their
     default values, if they have their own __set_name__.

   - bpo-33096(2): Allow ttk.Treeview.insert to insert iid that has a
     false boolean value.  Note iid=0 and iid=False would be same.
     Patch by Garvit Khatri.

   - bpo-32873(3): Treat type variables and special typing forms as
     immutable by copy and pickle.  This fixes several minor issues and
     inconsistencies, and improves backwards compatibility with Python
     3.6.

   - bpo-33134(4): When computing dataclass’s __hash__, use the lookup
     table to contain the function which returns the __hash__ value.
     This is an improvement over looking up a string, and then testing
     that string to see what to do.

   - bpo-33127(5): The ssl module now compiles with LibreSSL 2.7.1.

   - bpo-32505(6): Raise TypeError if a member variable of a dataclass
     is of type Field, but doesn’t have a type annotation.

   - bpo-33078(7): Fix the failure on OSX caused by the tests relying on
     sem_getvalue

   - bpo-33116(8): Add ‘Field’ to dataclasses.__all__.

   - bpo-32896(9): Fix an error where subclassing a dataclass with a
     field that uses a default_factory would generate an incorrect
     class.

   - bpo-33100(10): Dataclasses: If a field has a default value that’s a
     MemberDescriptorType, then it’s from that field being in __slots__,
     not an actual default value.

   - bpo-32953(11): If a non-dataclass inherits from a frozen dataclass,
     allow attributes to be added to the derived class.  Only attributes
     from the frozen dataclass cannot be assigned to.  Require all
     dataclasses in a hierarchy to be either all frozen or all
     non-frozen.

   - bpo-33061(12): Add missing ‘NoReturn’ to ‘__all__’ in typing.py

   - bpo-33078(13): Fix the size handling in multiprocessing.Queue when
     a pickling error occurs.

   - bpo-33064(14): lib2to3 now properly supports trailing commas after
     ‘*args’ and ‘**kwargs’ in function signatures.

   - bpo-33056(15): FIX properly close leaking fds in
     concurrent.futures.ProcessPoolExecutor.

   - bpo-33021(16): Release the GIL during fstat() calls, avoiding hang
     of all threads when calling mmap.mmap(), os.urandom(), and
     random.seed().  Patch by Nir Soffer.

   - bpo-31804(17): Avoid failing in multiprocessing.Process if the
     standard streams are closed or None at exit.

   - bpo-33037(18): Skip sending/receiving data after SSL transport
     closing.

   - bpo-27683(19): Fix a regression in *note ipaddress: a2. that result
     of ‘hosts()’ is empty when the network is constructed by a tuple
     containing an integer mask and only 1 bit left for addresses.

   - bpo-32999(20): Fix C implementation of ‘ABC.__subclasscheck__(cls,
     subclass)’ crashed when ‘subclass’ is not a type object.

   - bpo-33009(21): Fix inspect.signature() for single-parameter
     partialmethods.

   - bpo-32969(22): Expose several missing constants in zlib and fix
     corresponding documentation.

   - bpo-32056(23): Improved exceptions raised for invalid number of
     channels and sample width when read an audio file in modules *note
     aifc: 5, *note wave: 127. and *note sunau: fa.

   - bpo-32844(24): Fix wrong redirection of a low descriptor (0 or 1)
     to stderr in subprocess if another low descriptor is closed.

   - bpo-32857(25): In *note tkinter: 10c, ‘after_cancel(None)’ now
     raises a *note ValueError: 1f9. instead of canceling the first
     scheduled function.  Patch by Cheryl Sabella.

   - bpo-31639(26): http.server now exposes a ThreadedHTTPServer class
     and uses it when the module is run with ‘-m’ to cope with web
     browsers pre-opening sockets.

   - bpo-27645(27): *note sqlite3.Connection: 3cd. now exposes a *note
     backup: 3ce. method, if the underlying SQLite library is at version
     3.6.11 or higher.  Patch by Lele Gaifax.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33141

   (2) https://bugs.python.org/issue33096

   (3) https://bugs.python.org/issue32873

   (4) https://bugs.python.org/issue33134

   (5) https://bugs.python.org/issue33127

   (6) https://bugs.python.org/issue32505

   (7) https://bugs.python.org/issue33078

   (8) https://bugs.python.org/issue33116

   (9) https://bugs.python.org/issue32896

   (10) https://bugs.python.org/issue33100

   (11) https://bugs.python.org/issue32953

   (12) https://bugs.python.org/issue33061

   (13) https://bugs.python.org/issue33078

   (14) https://bugs.python.org/issue33064

   (15) https://bugs.python.org/issue33056

   (16) https://bugs.python.org/issue33021

   (17) https://bugs.python.org/issue31804

   (18) https://bugs.python.org/issue33037

   (19) https://bugs.python.org/issue27683

   (20) https://bugs.python.org/issue32999

   (21) https://bugs.python.org/issue33009

   (22) https://bugs.python.org/issue32969

   (23) https://bugs.python.org/issue32056

   (24) https://bugs.python.org/issue32844

   (25) https://bugs.python.org/issue32857

   (26) https://bugs.python.org/issue31639

   (27) https://bugs.python.org/issue27645


File: python.info,  Node: Documentation<16>,  Next: Tests<15>,  Prev: Library<17>,  Up: Python 3 7 0 beta 3

1.18.17.4 Documentation
.......................

   - bpo-33126(1): Document PyBuffer_ToContiguous().

   - bpo-27212(2): Modify documentation for the ‘islice()’ recipe to
     consume initial values up to the start index.

   - bpo-28247(3): Update *note zipapp: 141. documentation to describe
     how to make standalone applications.

   - bpo-18802(4): Documentation changes for ipaddress.  Patch by Jon
     Foster and Berker Peksag.

   - bpo-27428(5): Update documentation to clarify that
     ‘WindowsRegistryFinder’ implements ‘MetaPathFinder’.  (Patch by
     Himanshu Lakhara)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33126

   (2) https://bugs.python.org/issue27212

   (3) https://bugs.python.org/issue28247

   (4) https://bugs.python.org/issue18802

   (5) https://bugs.python.org/issue27428


File: python.info,  Node: Tests<15>,  Next: Build<13>,  Prev: Documentation<16>,  Up: Python 3 7 0 beta 3

1.18.17.5 Tests
...............

   - bpo-32872(1): Avoid regrtest compatibility issue with namespace
     packages.

   - bpo-32517(2): Fix failing ‘test_asyncio’ on macOS 10.12.2+ due to
     transport of ‘KqueueSelector’ loop was not being closed.

   - bpo-19417(3): Add test_bdb.py.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32872

   (2) https://bugs.python.org/issue32517

   (3) https://bugs.python.org/issue19417


File: python.info,  Node: Build<13>,  Next: Windows<15>,  Prev: Tests<15>,  Up: Python 3 7 0 beta 3

1.18.17.6 Build
...............

   - bpo-33163(1): Upgrade pip to 9.0.3 and setuptools to v39.0.1.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33163


File: python.info,  Node: Windows<15>,  Next: macOS<11>,  Prev: Build<13>,  Up: Python 3 7 0 beta 3

1.18.17.7 Windows
.................

   - bpo-33016(1): Fix potential use of uninitialized memory in
     nt._getfinalpathname

   - bpo-32903(2): Fix a memory leak in os.chdir() on Windows if the
     current directory is set to a UNC path.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33016

   (2) https://bugs.python.org/issue32903


File: python.info,  Node: macOS<11>,  Next: IDLE<18>,  Prev: Windows<15>,  Up: Python 3 7 0 beta 3

1.18.17.8 macOS
...............

   - bpo-32726(1): Build and link with private copy of Tcl/Tk 8.6 for
     the macOS 10.6+ installer.  The 10.9+ installer variant already
     does this.  This means that the Python 3.7 provided by the
     python.org macOS installers no longer need or use any external
     versions of Tcl/Tk, either system-provided or user-installed, such
     as ActiveTcl.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32726


File: python.info,  Node: IDLE<18>,  Next: Tools/Demos<10>,  Prev: macOS<11>,  Up: Python 3 7 0 beta 3

1.18.17.9 IDLE
..............

   - bpo-32984(1): Set ‘__file__’ while running a startup file.  Like
     Python, IDLE optionally runs one startup file in the Shell window
     before presenting the first interactive input prompt.  For IDLE,
     ‘-s’ runs a file named in environmental variable ‘IDLESTARTUP’ or
     *note PYTHONSTARTUP: 8d9.; ‘-r file’ runs ‘file’.  Python sets
     ‘__file__’ to the startup file name before running the file and
     unsets it before the first prompt.  IDLE now does the same when run
     normally, without the ‘-n’ option.

   - bpo-32940(2): Simplify and rename StringTranslatePseudoMapping in
     pyparse.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32984

   (2) https://bugs.python.org/issue32940


File: python.info,  Node: Tools/Demos<10>,  Next: C API<11>,  Prev: IDLE<18>,  Up: Python 3 7 0 beta 3

1.18.17.10 Tools/Demos
......................

   - bpo-32885(1): Add an ‘-n’ flag for ‘Tools/scripts/pathfix.py’ to
     disable automatic backup creation (files with ‘~’ suffix).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32885


File: python.info,  Node: C API<11>,  Prev: Tools/Demos<10>,  Up: Python 3 7 0 beta 3

1.18.17.11 C API
................

   - bpo-33042(1): Embedding applications may once again call
     PySys_ResetWarnOptions, PySys_AddWarnOption, and PySys_AddXOption
     prior to calling Py_Initialize.

   - bpo-32374(2): Document that m_traverse for multi-phase initialized
     modules can be called with m_state=NULL, and add a sanity check

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33042

   (2) https://bugs.python.org/issue32374


File: python.info,  Node: Python 3 7 0 beta 2,  Next: Python 3 7 0 beta 1,  Prev: Python 3 7 0 beta 3,  Up: Changelog

1.18.18 Python 3.7.0 beta 2
---------------------------

`Release date: 2018-02-27'

* Menu:

* Security: Security<11>.
* Core and Builtins: Core and Builtins<17>.
* Library: Library<18>.
* Documentation: Documentation<17>.
* Tests: Tests<16>.
* Build: Build<14>.
* Windows: Windows<16>.
* macOS: macOS<12>.
* IDLE: IDLE<19>.
* Tools/Demos: Tools/Demos<11>.


File: python.info,  Node: Security<11>,  Next: Core and Builtins<17>,  Up: Python 3 7 0 beta 2

1.18.18.1 Security
..................

   - bpo-28414(1): The ssl module now allows users to perform their own
     IDN en/decoding when using SNI.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28414


File: python.info,  Node: Core and Builtins<17>,  Next: Library<18>,  Prev: Security<11>,  Up: Python 3 7 0 beta 2

1.18.18.2 Core and Builtins
...........................

   - bpo-32889(1): Update Valgrind suppression list to account for the
     rename of ‘Py_ADDRESS_IN_RANG’ to ‘address_in_range’.

   - bpo-31356(2): Remove the new API added in bpo-31356(3)
     (gc.ensure_disabled() context manager).

   - bpo-32305(4): For namespace packages, ensure that both ‘__file__’
     and ‘__spec__.origin’ are set to None.

   - bpo-32303(5): Make sure ‘__spec__.loader’ matches ‘__loader__’ for
     namespace packages.

   - bpo-32711(6): Fix the warning messages for Python/ast_unparse.c.
     Patch by Stéphane Wirtel

   - bpo-32583(7): Fix possible crashing in builtin Unicode decoders
     caused by write out-of-bound errors when using customized decode
     error handlers.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32889

   (2) https://bugs.python.org/issue31356

   (3) https://bugs.python.org/issue31356

   (4) https://bugs.python.org/issue32305

   (5) https://bugs.python.org/issue32303

   (6) https://bugs.python.org/issue32711

   (7) https://bugs.python.org/issue32583


File: python.info,  Node: Library<18>,  Next: Documentation<17>,  Prev: Core and Builtins<17>,  Up: Python 3 7 0 beta 2

1.18.18.3 Library
.................

   - bpo-32960(1): For dataclasses, disallow inheriting frozen from
     non-frozen classes, and also disallow inheriting non-frozen from
     frozen classes.  This restriction will be relaxed at a future date.

   - bpo-32713(2): Fixed tarfile.itn handling of out-of-bounds float
     values.  Patch by Joffrey Fuhrer.

   - bpo-32951(3): Direct instantiation of SSLSocket and SSLObject
     objects is now prohibited.  The constructors were never documented,
     tested, or designed as public constructors.  Users were suppose to
     use ssl.wrap_socket() or SSLContext.

   - bpo-32929(4): Remove the tri-state parameter “hash”, and add the
     boolean “unsafe_hash”.  If unsafe_hash is True, add a __hash__
     function, but if a __hash__ exists, raise TypeError.  If
     unsafe_hash is False, add a __hash__ based on the values of eq= and
     frozen=.  The unsafe_hash=False behavior is the same as the old
     hash=None behavior.  unsafe_hash=False is the default, just as
     hash=None used to be.

   - bpo-32947(5): Add OP_ENABLE_MIDDLEBOX_COMPAT and test workaround
     for TLSv1.3 for future compatibility with OpenSSL 1.1.1.

   - bpo-30622(6): The ssl module now detects missing NPN support in
     LibreSSL.

   - bpo-32922(7): dbm.open() now encodes filename with the filesystem
     encoding rather than default encoding.

   - bpo-32859(8): In ‘os.dup2’, don’t check every call whether the
     ‘dup3’ syscall exists or not.

   - bpo-32556(9): nt._getfinalpathname, nt._getvolumepathname and
     nt._getdiskusage now correctly convert from bytes.

   - bpo-25988(10): Emit a *note DeprecationWarning: 276. when using or
     importing an ABC directly from *note collections: 1e. rather than
     from *note collections.abc: 1f.

   - bpo-21060(11): Rewrite confusing message from setup.py upload from
     “No dist file created in earlier command” to the more helpful “Must
     create and upload files in one command”.

   - bpo-32852(12): Make sure sys.argv remains as a list when running
     trace.

   - bpo-31333(13): ‘_abc’ module is added.  It is a speedup module with
     C implementations for various functions and methods in ‘abc’.
     Creating an ABC subclass and calling ‘isinstance’ or ‘issubclass’
     with an ABC subclass are up to 1.5x faster.  In addition, this
     makes Python start-up up to 10% faster.  Note that the new
     implementation hides internal registry and caches, previously
     accessible via private attributes ‘_abc_registry’, ‘_abc_cache’,
     and ‘_abc_negative_cache’.  There are three debugging helper
     methods that can be used instead ‘_dump_registry’,
     ‘_abc_registry_clear’, and ‘_abc_caches_clear’.

   - bpo-32841(14): Fixed *note asyncio.Condition: 28b. issue which
     silently ignored cancellation after notifying and cancelling a
     conditional lock.  Patch by Bar Harel.

   - bpo-32819(15): ssl.match_hostname() has been simplified and no
     longer depends on re and ipaddress module for wildcard and IP
     addresses.  Error reporting for invalid wildcards has been
     improved.

   - bpo-32394(16): socket: Remove
     TCP_FASTOPEN,TCP_KEEPCNT,TCP_KEEPIDLE,TCP_KEEPINTVL flags on older
     version Windows during run-time.

   - bpo-31787(17): Fixed refleaks of ‘__init__()’ methods in various
     modules.  (Contributed by Oren Milman)

   - bpo-30157(18): Fixed guessing quote and delimiter in
     csv.Sniffer.sniff() when only the last field is quoted.  Patch by
     Jake Davis.

   - bpo-32792(19): collections.ChainMap() preserves the order of the
     underlying mappings.

   - bpo-32775(20): *note fnmatch.translate(): f75. no longer produces
     patterns which contain set operations.  Sets starting with ‘[‘ or
     containing ‘–’, ‘&&’, ‘~~’ or ‘||’ will be interpreted differently
     in regular expressions in future versions.  Currently they emit
     warnings.  fnmatch.translate() now avoids producing patterns
     containing such sets by accident.

   - bpo-32622(21): Implement native fast sendfile for Windows proactor
     event loop.

   - bpo-32777(22): Fix a rare but potential pre-exec child process
     deadlock in subprocess on POSIX systems when marking file
     descriptors inheritable on exec in the child process.  This bug
     appears to have been introduced in 3.4.

   - bpo-32647(23): The ctypes module used to depend on indirect linking
     for dlopen.  The shared extension is now explicitly linked against
     libdl on platforms with dl.

   - bpo-32741(24): Implement ‘asyncio.TimerHandle.when()’ method.

   - bpo-32691(25): Use mod_spec.parent when running modules with pdb

   - bpo-32734(26): Fixed ‘asyncio.Lock()’ safety issue which allowed
     acquiring and locking the same lock multiple times, without it
     being free.  Patch by Bar Harel.

   - bpo-32727(27): Do not include name field in SMTP envelope from
     address.  Patch by Stéphane Wirtel

   - bpo-31453(28): Add TLSVersion constants and
     SSLContext.maximum_version / minimum_version attributes.  The new
     API wraps OpenSSL 1.1
     ‘https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html’
     feature.

   - bpo-24334(29): Internal implementation details of ssl module were
     cleaned up.  The SSLSocket has one less layer of indirection.
     Owner and session information are now handled by the SSLSocket and
     SSLObject constructor.  Channel binding implementation has been
     simplified.

   - bpo-31848(30): Fix the error handling in Aifc_read.initfp() when
     the SSND chunk is not found.  Patch by Zackery Spytz.

   - bpo-32585(31): Add Ttk spinbox widget to *note tkinter.ttk: 10f.
     Patch by Alan D Moore.

   - bpo-32221(32): Various functions returning tuple containing IPv6
     addresses now omit ‘%scope’ part since the same information is
     already encoded in `scopeid' tuple item.  Especially this speeds up
     ‘socket.recvfrom()’ when it receives multicast packet since useless
     resolving of network interface name is omitted.

   - bpo-30693(33): The TarFile class now recurses directories in a
     reproducible way.

   - bpo-30693(34): The ZipFile class now recurses directories in a
     reproducible way.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32960

   (2) https://bugs.python.org/issue32713

   (3) https://bugs.python.org/issue32951

   (4) https://bugs.python.org/issue32929

   (5) https://bugs.python.org/issue32947

   (6) https://bugs.python.org/issue30622

   (7) https://bugs.python.org/issue32922

   (8) https://bugs.python.org/issue32859

   (9) https://bugs.python.org/issue32556

   (10) https://bugs.python.org/issue25988

   (11) https://bugs.python.org/issue21060

   (12) https://bugs.python.org/issue32852

   (13) https://bugs.python.org/issue31333

   (14) https://bugs.python.org/issue32841

   (15) https://bugs.python.org/issue32819

   (16) https://bugs.python.org/issue32394

   (17) https://bugs.python.org/issue31787

   (18) https://bugs.python.org/issue30157

   (19) https://bugs.python.org/issue32792

   (20) https://bugs.python.org/issue32775

   (21) https://bugs.python.org/issue32622

   (22) https://bugs.python.org/issue32777

   (23) https://bugs.python.org/issue32647

   (24) https://bugs.python.org/issue32741

   (25) https://bugs.python.org/issue32691

   (26) https://bugs.python.org/issue32734

   (27) https://bugs.python.org/issue32727

   (28) https://bugs.python.org/issue31453

   (29) https://bugs.python.org/issue24334

   (30) https://bugs.python.org/issue31848

   (31) https://bugs.python.org/issue32585

   (32) https://bugs.python.org/issue32221

   (33) https://bugs.python.org/issue30693

   (34) https://bugs.python.org/issue30693


File: python.info,  Node: Documentation<17>,  Next: Tests<16>,  Prev: Library<18>,  Up: Python 3 7 0 beta 2

1.18.18.4 Documentation
.......................

   - bpo-28124(1): The ssl module function ssl.wrap_socket() has been
     de-emphasized and deprecated in favor of the more secure and
     efficient SSLContext.wrap_socket() method.

   - bpo-17232(2): Clarify docs for -O and -OO. Patch by Terry Reedy.

   - bpo-32436(3): Add documentation for the contextvars module (PEP
     567).

   - bpo-32800(4): Update link to w3c doc for xml default namespaces.

   - bpo-11015(5): Update *note test.support: 106. documentation.

   - bpo-8722(6): Document *note __getattr__(): 30f. behavior when
     property ‘get()’ method raises *note AttributeError: 390.

   - bpo-32614(7): Modify RE examples in documentation to use raw
     strings to prevent *note DeprecationWarning: 276. and add text to
     REGEX HOWTO to highlight the deprecation.

   - bpo-31972(8): Improve docstrings for *note pathlib.PurePath: f79.
     subclasses.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28124

   (2) https://bugs.python.org/issue17232

   (3) https://bugs.python.org/issue32436

   (4) https://bugs.python.org/issue32800

   (5) https://bugs.python.org/issue11015

   (6) https://bugs.python.org/issue8722

   (7) https://bugs.python.org/issue32614

   (8) https://bugs.python.org/issue31972


File: python.info,  Node: Tests<16>,  Next: Build<14>,  Prev: Documentation<17>,  Up: Python 3 7 0 beta 2

1.18.18.5 Tests
...............

   - bpo-31809(1): Add tests to verify connection with secp ECDH curves.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31809


File: python.info,  Node: Build<14>,  Next: Windows<16>,  Prev: Tests<16>,  Up: Python 3 7 0 beta 2

1.18.18.6 Build
...............

   - bpo-32898(1): Fix the python debug build when using COUNT_ALLOCS.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32898


File: python.info,  Node: Windows<16>,  Next: macOS<12>,  Prev: Build<14>,  Up: Python 3 7 0 beta 2

1.18.18.7 Windows
.................

   - bpo-32901(1): Update Tcl and Tk versions to 8.6.8

   - bpo-31966(2): Fixed WindowsConsoleIO.write() for writing empty
     data.

   - bpo-32409(3): Ensures activate.bat can handle Unicode contents.

   - bpo-32457(4): Improves handling of denormalized executable path
     when launching Python.

   - bpo-32370(5): Use the correct encoding for ipconfig output in the
     uuid module.  Patch by Segev Finer.

   - bpo-29248(6): Fix *note os.readlink(): 1f1. on Windows, which was
     mistakenly treating the ‘PrintNameOffset’ field of the reparse data
     buffer as a number of characters instead of bytes.  Patch by Craig
     Holmquist and SSE4.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32901

   (2) https://bugs.python.org/issue31966

   (3) https://bugs.python.org/issue32409

   (4) https://bugs.python.org/issue32457

   (5) https://bugs.python.org/issue32370

   (6) https://bugs.python.org/issue29248


File: python.info,  Node: macOS<12>,  Next: IDLE<19>,  Prev: Windows<16>,  Up: Python 3 7 0 beta 2

1.18.18.8 macOS
...............

   - bpo-32901(1): Update macOS 10.9+ installer to Tcl/Tk 8.6.8.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32901


File: python.info,  Node: IDLE<19>,  Next: Tools/Demos<11>,  Prev: macOS<12>,  Up: Python 3 7 0 beta 2

1.18.18.9 IDLE
..............

   - bpo-32916(1): Change ‘str’ to ‘code’ in pyparse.

   - bpo-32905(2): Remove unused code in pyparse module.

   - bpo-32874(3): Add tests for pyparse.

   - bpo-32837(4): Using the system and place-dependent default encoding
     for open() is a bad idea for IDLE’s system and location-independent
     files.

   - bpo-32826(5): Add “encoding=utf-8” to open() in IDLE’s
     test_help_about.  GUI test test_file_buttons() only looks at
     initial ascii-only lines, but failed on systems where open()
     defaults to ‘ascii’ because readline() internally reads and decodes
     far enough ahead to encounter a non-ascii character in CREDITS.txt.

   - bpo-32765(6): Update configdialog General tab docstring to add new
     widgets to the widget list.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32916

   (2) https://bugs.python.org/issue32905

   (3) https://bugs.python.org/issue32874

   (4) https://bugs.python.org/issue32837

   (5) https://bugs.python.org/issue32826

   (6) https://bugs.python.org/issue32765


File: python.info,  Node: Tools/Demos<11>,  Prev: IDLE<19>,  Up: Python 3 7 0 beta 2

1.18.18.10 Tools/Demos
......................

   - bpo-32222(1): Fix pygettext not extracting docstrings for functions
     with type annotated arguments.  Patch by Toby Harradine.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32222


File: python.info,  Node: Python 3 7 0 beta 1,  Next: Python 3 7 0 alpha 4,  Prev: Python 3 7 0 beta 2,  Up: Changelog

1.18.19 Python 3.7.0 beta 1
---------------------------

`Release date: 2018-01-30'

* Menu:

* Core and Builtins: Core and Builtins<18>.
* Library: Library<19>.
* Documentation: Documentation<18>.
* Tests: Tests<17>.
* Build: Build<15>.
* Windows: Windows<17>.
* macOS: macOS<13>.
* C API: C API<12>.


File: python.info,  Node: Core and Builtins<18>,  Next: Library<19>,  Up: Python 3 7 0 beta 1

1.18.19.1 Core and Builtins
...........................

   - bpo-32703(1): Fix coroutine’s ResourceWarning when there’s an
     active error set when it’s being finalized.

   - bpo-32650(2): Pdb and other debuggers dependent on bdb.py will
     correctly step over (next command) native coroutines.  Patch by
     Pablo Galindo.

   - bpo-28685(3): Optimize list.sort() and sorted() by using type
     specialized comparisons when possible.

   - bpo-32685(4): Improve suggestion when the Python 2 form of print
     statement is either present on the same line as the header of a
     compound statement or else terminated by a semi-colon instead of a
     newline.  Patch by Nitish Chandra.

   - bpo-32697(5): Python now explicitly preserves the definition order
     of keyword-only parameters.  It’s always preserved their order, but
     this behavior was never guaranteed before; this behavior is now
     guaranteed and tested.

   - bpo-32690(6): The locals() dictionary now displays in the lexical
     order that variables were defined.  Previously, the order was
     reversed.

   - bpo-32677(7): Add ‘.isascii()’ method to ‘str’, ‘bytes’ and
     ‘bytearray’.  It can be used to test that string contains only
     ASCII characters.

   - bpo-32670(8): Enforce PEP 479(9) for all code.  This means that
     manually raising a StopIteration exception from a generator is
     prohibited for all code, regardless of whether ‘from __future__
     import generator_stop’ was used or not.

   - bpo-32591(10): Added built-in support for tracking the origin of
     coroutine objects; see sys.set_coroutine_origin_tracking_depth and
     CoroutineType.cr_origin.  This replaces the asyncio debug mode’s
     use of coroutine wrapping for native coroutine objects.

   - bpo-31368(11): Expose preadv and pwritev system calls in the os
     module.  Patch by Pablo Galindo

   - bpo-32544(12): ‘hasattr(obj, name)’ and ‘getattr(obj, name,
     default)’ are about 4 times faster than before when ‘name’ is not
     found and ‘obj’ doesn’t override ‘__getattr__’ or
     ‘__getattribute__’.

   - bpo-26163(13): Improved frozenset() hash to create more distinct
     hash values when faced with datasets containing many similar
     values.

   - bpo-32550(14): Remove the STORE_ANNOTATION bytecode.

   - bpo-20104(15): Expose posix_spawn as a low level API in the os
     module.  (removed before 3.7.0rc1)

   - bpo-24340(16): Fixed estimation of the code stack size.

   - bpo-32436(17): Implement PEP 567(18) Context Variables.

   - bpo-18533(19): ‘repr()’ on a dict containing its own ‘values()’ or
     ‘items()’ no longer raises ‘RecursionError’; OrderedDict similarly.
     Instead, use ‘...’, as for other recursive structures.  Patch by
     Ben North.

   - bpo-20891(20): Py_Initialize() now creates the GIL. The GIL is no
     longer created “on demand” to fix a race condition when
     PyGILState_Ensure() is called in a non-Python thread.

   - bpo-32028(21): Leading whitespace is now correctly ignored when
     generating suggestions for converting Py2 print statements to Py3
     builtin print function calls.  Patch by Sanyam Khurana.

   - bpo-31179(22): Make dict.copy() up to 5.5 times faster.

   - bpo-31113(23): Get rid of recursion in the compiler for normal
     control flow.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32703

   (2) https://bugs.python.org/issue32650

   (3) https://bugs.python.org/issue28685

   (4) https://bugs.python.org/issue32685

   (5) https://bugs.python.org/issue32697

   (6) https://bugs.python.org/issue32690

   (7) https://bugs.python.org/issue32677

   (8) https://bugs.python.org/issue32670

   (9) https://www.python.org/dev/peps/pep-0479

   (10) https://bugs.python.org/issue32591

   (11) https://bugs.python.org/issue31368

   (12) https://bugs.python.org/issue32544

   (13) https://bugs.python.org/issue26163

   (14) https://bugs.python.org/issue32550

   (15) https://bugs.python.org/issue20104

   (16) https://bugs.python.org/issue24340

   (17) https://bugs.python.org/issue32436

   (18) https://www.python.org/dev/peps/pep-0567

   (19) https://bugs.python.org/issue18533

   (20) https://bugs.python.org/issue20891

   (21) https://bugs.python.org/issue32028

   (22) https://bugs.python.org/issue31179

   (23) https://bugs.python.org/issue31113


File: python.info,  Node: Library<19>,  Next: Documentation<18>,  Prev: Core and Builtins<18>,  Up: Python 3 7 0 beta 1

1.18.19.2 Library
.................

   - bpo-25988(1): Deprecate exposing the contents of collections.abc in
     the regular collections module.

   - bpo-31429(2): The default cipher suite selection of the ssl module
     now uses a blacklist approach rather than a hard-coded whitelist.
     Python no longer re-enables ciphers that have been blocked by
     OpenSSL security update.  Default cipher suite selection can be
     configured on compile time.

   - bpo-30306(3): contextlib.contextmanager now releases the arguments
     passed to the underlying generator as soon as the context manager
     is entered.  Previously it would keep them alive for as long as the
     context manager was alive, even when not being used as a function
     decorator.  Patch by Martin Teichmann.

   - bpo-21417(4): Added support for setting the compression level for
     zipfile.ZipFile.

   - bpo-32251(5): Implement asyncio.BufferedProtocol (provisional API).

   - bpo-32513(6): In dataclasses, allow easier overriding of dunder
     methods without specifying decorator parameters.

   - bpo-32660(7): *note termios: 104. makes available ‘FIONREAD’,
     ‘FIONCLEX’, ‘FIOCLEX’, ‘FIOASYNC’ and ‘FIONBIO’ also under
     Solaris/derivatives.

   - bpo-27931(8): Fix email address header parsing error when the
     username is an empty quoted string.  Patch by Xiang Zhang.

   - bpo-32659(9): Under Solaris and derivatives, *note os.stat_result:
     fc2. provides a st_fstype attribute.

   - bpo-32662(10): Implement Server.start_serving(),
     Server.serve_forever(), and Server.is_serving() methods.  Add
     ‘start_serving’ keyword parameter to loop.create_server() and
     loop.create_unix_server().

   - bpo-32391(11): Implement *note asyncio.StreamWriter.wait_closed():
     34b. and *note asyncio.StreamWriter.is_closing(): 34c. methods

   - bpo-32643(12): Make Task._step, Task._wakeup and
     Future._schedule_callbacks methods private.

   - bpo-32630(13): Refactor decimal module to use contextvars to store
     decimal context.

   - bpo-32622(14): Add ‘asyncio.AbstractEventLoop.sendfile()’ method.

   - bpo-32304(15): distutils’ upload command no longer corrupts tar
     files ending with a CR byte, and no longer tries to convert CR to
     CRLF in any of the upload text fields.

   - bpo-32502(16): uuid.uuid1 no longer raises an exception if a 64-bit
     hardware address is encountered.

   - bpo-32596(17): ‘concurrent.futures’ imports ‘ThreadPoolExecutor’
     and ‘ProcessPoolExecutor’ lazily (using PEP 562(18)).  It makes
     ‘import asyncio’ about 15% faster because asyncio uses only
     ‘ThreadPoolExecutor’ by default.

   - bpo-31801(19): Add ‘_ignore_’ to ‘Enum’ so temporary variables can
     be used during class construction without being turned into
     members.

   - bpo-32576(20): Use queue.SimpleQueue() in places where it can be
     invoked from a weakref callback.

   - bpo-32574(21): Fix memory leak in asyncio.Queue, when the queue has
     limited size and it is full, the cancelation of queue.put() can
     cause a memory leak.  Patch by: José Melero.

   - bpo-32521(22): The nis module is now compatible with new libnsl and
     headers location.

   - bpo-32467(23): collections.abc.ValuesView now inherits from
     collections.abc.Collection.

   - bpo-32473(24): Improve ABCMeta._dump_registry() output readability

   - bpo-32102(25): New argument ‘capture_output’ for subprocess.run

   - bpo-32521(26): glibc has removed Sun RPC. Use replacement libtirpc
     headers and library in nis module.

   - bpo-32493(27): UUID module fixes build for FreeBSD/OpenBSD

   - bpo-32503(28): Pickling with protocol 4 no longer creates too small
     frames.

   - bpo-29237(29): Create enum for pstats sorting options

   - bpo-32454(30): Add close(fd) function to the socket module.

   - bpo-25942(31): The subprocess module is now more graceful when
     handling a Ctrl-C KeyboardInterrupt during subprocess.call,
     subprocess.run, or a Popen context manager.  It now waits a short
     amount of time for the child (presumed to have also gotten the
     SIGINT) to exit, before continuing the KeyboardInterrupt exception
     handling.  This still includes a SIGKILL in the call() and run()
     APIs, but at least the child had a chance first.

   - bpo-32433(32): The hmac module now has hmac.digest(), which
     provides an optimized HMAC digest.

   - bpo-28134(33): Sockets now auto-detect family, type and protocol
     from file descriptor by default.

   - bpo-32404(34): Fix bug where *note
     datetime.datetime.fromtimestamp(): fc3. did not call __new__ in
     *note datetime.datetime: 194. subclasses.

   - bpo-32403(35): Improved speed of *note datetime.date: 193. and
     *note datetime.datetime: 194. alternate constructors.

   - bpo-32228(36): Ensure that ‘truncate()’ preserves the file position
     (as reported by ‘tell()’) after writes longer than the buffer size.

   - bpo-32410(37): Implement ‘loop.sock_sendfile’ for asyncio event
     loop.

   - bpo-22908(38): Added seek and tell to the ZipExtFile class.  This
     only works if the file object used to open the zipfile is seekable.

   - bpo-32373(39): Add socket.getblocking() method.

   - bpo-32248(40): Add *note importlib.resources: 9e. and *note
     importlib.abc.ResourceReader: 337. as the unified API for reading
     resources contained within packages.  Loaders wishing to support
     resource reading must implement the ‘get_resource_reader()’ method.
     File-based and zipimport-based loaders both implement these APIs.
     *note importlib.abc.ResourceLoader: 45b. is deprecated in favor of
     these new APIs.

   - bpo-32320(41): collections.namedtuple() now supports default
     values.

   - bpo-29302(42): Add contextlib.AsyncExitStack.  Patch by Alexander
     Mohr and Ilya Kulakov.

   - bpo-31961(43): `Removed in Python 3.7.0b2.'  The `args' argument of
     subprocess.Popen can now be a *note path-like object: 35f.  If
     `args' is given as a sequence, it’s first element can now be a
     *note path-like object: 35f. as well.

   - bpo-31900(44): The *note locale.localeconv(): 47f. function now
     sets temporarily the ‘LC_CTYPE’ locale to the ‘LC_NUMERIC’ locale
     to decode ‘decimal_point’ and ‘thousands_sep’ byte strings if they
     are non-ASCII or longer than 1 byte, and the ‘LC_NUMERIC’ locale is
     different than the ‘LC_CTYPE’ locale.  This temporary change
     affects other threads.  Same change for the *note str.format():
     4cf. method when formatting a number (*note int: 184, *note float:
     187, *note float: 187. and subclasses) with the ‘n’ type (ex:
     ‘'{:n}'.format(1234)’).

   - bpo-31853(45): Use super().method instead of socket.method in
     SSLSocket.  They were there most likely for legacy reasons.

   - bpo-31399(46): The ssl module now uses OpenSSL’s
     X509_VERIFY_PARAM_set1_host() and X509_VERIFY_PARAM_set1_ip() API
     to verify hostname and IP addresses.  Subject common name fallback
     can be disabled with SSLContext.hostname_checks_common_name.

   - bpo-14976(47): Add a queue.SimpleQueue class, an unbounded FIFO
     queue with a reentrant C implementation of put().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25988

   (2) https://bugs.python.org/issue31429

   (3) https://bugs.python.org/issue30306

   (4) https://bugs.python.org/issue21417

   (5) https://bugs.python.org/issue32251

   (6) https://bugs.python.org/issue32513

   (7) https://bugs.python.org/issue32660

   (8) https://bugs.python.org/issue27931

   (9) https://bugs.python.org/issue32659

   (10) https://bugs.python.org/issue32662

   (11) https://bugs.python.org/issue32391

   (12) https://bugs.python.org/issue32643

   (13) https://bugs.python.org/issue32630

   (14) https://bugs.python.org/issue32622

   (15) https://bugs.python.org/issue32304

   (16) https://bugs.python.org/issue32502

   (17) https://bugs.python.org/issue32596

   (18) https://www.python.org/dev/peps/pep-0562

   (19) https://bugs.python.org/issue31801

   (20) https://bugs.python.org/issue32576

   (21) https://bugs.python.org/issue32574

   (22) https://bugs.python.org/issue32521

   (23) https://bugs.python.org/issue32467

   (24) https://bugs.python.org/issue32473

   (25) https://bugs.python.org/issue32102

   (26) https://bugs.python.org/issue32521

   (27) https://bugs.python.org/issue32493

   (28) https://bugs.python.org/issue32503

   (29) https://bugs.python.org/issue29237

   (30) https://bugs.python.org/issue32454

   (31) https://bugs.python.org/issue25942

   (32) https://bugs.python.org/issue32433

   (33) https://bugs.python.org/issue28134

   (34) https://bugs.python.org/issue32404

   (35) https://bugs.python.org/issue32403

   (36) https://bugs.python.org/issue32228

   (37) https://bugs.python.org/issue32410

   (38) https://bugs.python.org/issue22908

   (39) https://bugs.python.org/issue32373

   (40) https://bugs.python.org/issue32248

   (41) https://bugs.python.org/issue32320

   (42) https://bugs.python.org/issue29302

   (43) https://bugs.python.org/issue31961

   (44) https://bugs.python.org/issue31900

   (45) https://bugs.python.org/issue31853

   (46) https://bugs.python.org/issue31399

   (47) https://bugs.python.org/issue14976


File: python.info,  Node: Documentation<18>,  Next: Tests<17>,  Prev: Library<19>,  Up: Python 3 7 0 beta 1

1.18.19.3 Documentation
.......................

   - bpo-32724(1): Add references to some commands in the documentation
     of Pdb.  Patch by Stéphane Wirtel

   - bpo-32649(2): Complete the C API documentation, profiling and
     tracing part with the newly added per-opcode events.

   - bpo-17799(3): Explain real behaviour of sys.settrace and
     sys.setprofile and their C-API counterparts regarding which type of
     events are received in each function.  Patch by Pablo Galindo
     Salgado.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32724

   (2) https://bugs.python.org/issue32649

   (3) https://bugs.python.org/issue17799


File: python.info,  Node: Tests<17>,  Next: Build<15>,  Prev: Documentation<18>,  Up: Python 3 7 0 beta 1

1.18.19.4 Tests
...............

   - bpo-32721(1): Fix test_hashlib to not fail if the _md5 module is
     not built.

   - bpo-28414(2): Add test cases for IDNA 2003 and 2008 host names.
     IDNA 2003 internationalized host names are working since
     bpo-31399(3) has landed.  IDNA 2008 are still broken.

   - bpo-32604(4): Add a new “_xxsubinterpreters” extension module that
     exposes the existing subinterpreter C-API and a new
     cross-interpreter data sharing mechanism.  The module is primarily
     intended for more thorough testing of the existing subinterpreter
     support.  Note that the _xxsubinterpreters module has been removed
     in 3.7.0rc1.

   - bpo-32602(5): Add test certs and test for ECDSA cert and EC/RSA
     dual mode.

   - bpo-32549(6): On Travis CI, Python now Compiles and uses a local
     copy of OpenSSL 1.1.0g for testing.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32721

   (2) https://bugs.python.org/issue28414

   (3) https://bugs.python.org/issue31399

   (4) https://bugs.python.org/issue32604

   (5) https://bugs.python.org/issue32602

   (6) https://bugs.python.org/issue32549


File: python.info,  Node: Build<15>,  Next: Windows<17>,  Prev: Tests<17>,  Up: Python 3 7 0 beta 1

1.18.19.5 Build
...............

   - bpo-32635(1): Fix segfault of the crypt module when libxcrypt is
     provided instead of libcrypt at the system.

   - bpo-32598(2): Use autoconf to detect OpenSSL libs, headers and
     supported features.  The ax_check_openssl M4 macro uses pkg-config
     to locate OpenSSL and falls back to manual search.

   - bpo-32593(3): Drop support of FreeBSD 9 and older.

   - bpo-29708(4): If the ‘SOURCE_DATE_EPOCH’ environment variable is
     set, *note py_compile: d7. will always create hash-based ‘.pyc’
     files.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32635

   (2) https://bugs.python.org/issue32598

   (3) https://bugs.python.org/issue32593

   (4) https://bugs.python.org/issue29708


File: python.info,  Node: Windows<17>,  Next: macOS<13>,  Prev: Build<15>,  Up: Python 3 7 0 beta 1

1.18.19.6 Windows
.................

   - bpo-32588(1): Create standalone _distutils_findvs module and add
     missing _queue module to installer.

   - bpo-29911(2): Ensure separate Modify and Uninstall buttons are
     displayed.

   - bpo-32507(3): Use app-local UCRT install rather than the proper
     update for old versions of Windows.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32588

   (2) https://bugs.python.org/issue29911

   (3) https://bugs.python.org/issue32507


File: python.info,  Node: macOS<13>,  Next: C API<12>,  Prev: Windows<17>,  Up: Python 3 7 0 beta 1

1.18.19.7 macOS
...............

   - bpo-32726(1): Provide an additional, more modern macOS installer
     variant that supports macOS 10.9+ systems in 64-bit mode only.
     Upgrade the supplied third-party libraries to OpenSSL 1.1.0g and to
     SQLite 3.22.0.  The 10.9+ installer now links with and supplies its
     own copy of Tcl/Tk 8.6.

   - bpo-28440(2): No longer add /Library/Python/3.x/site-packages to
     sys.path for macOS framework builds to avoid future conflicts.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32726

   (2) https://bugs.python.org/issue28440


File: python.info,  Node: C API<12>,  Prev: macOS<13>,  Up: Python 3 7 0 beta 1

1.18.19.8 C API
...............

   - bpo-32681(1): Fix uninitialized variable ‘res’ in the C
     implementation of os.dup2.  Patch by Stéphane Wirtel

   - bpo-10381(2): Add C API access to the ‘datetime.timezone’
     constructor and ‘datetime.timzone.UTC’ singleton.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32681

   (2) https://bugs.python.org/issue10381


File: python.info,  Node: Python 3 7 0 alpha 4,  Next: Python 3 7 0 alpha 3,  Prev: Python 3 7 0 beta 1,  Up: Changelog

1.18.20 Python 3.7.0 alpha 4
----------------------------

`Release date: 2018-01-08'

* Menu:

* Core and Builtins: Core and Builtins<19>.
* Library: Library<20>.
* Documentation: Documentation<19>.
* Tests: Tests<18>.
* Windows: Windows<18>.
* Tools/Demos: Tools/Demos<12>.
* C API: C API<13>.


File: python.info,  Node: Core and Builtins<19>,  Next: Library<20>,  Up: Python 3 7 0 alpha 4

1.18.20.1 Core and Builtins
...........................

   - bpo-31975(1): The default warning filter list now starts with a
     “default::DeprecationWarning:__main__” entry, so deprecation
     warnings are once again shown by default in single-file scripts and
     at the interactive prompt.

   - bpo-32226(2): ‘__class_getitem__’ is now an automatic class method.

   - bpo-32399(3): Add AIX uuid library support for RFC4122 using
     uuid_create() in libc.a

   - bpo-32390(4): Fix the compilation failure on AIX after the f_fsid
     field has been added to the object returned by os.statvfs()
     (bpo-32143(5)).  Original patch by Michael Felt.

   - bpo-32379(6): Make MRO computation faster when a class inherits
     from a single base.

   - bpo-32259(7): The error message of a TypeError raised when unpack
     non-iterable is now more specific.

   - bpo-27169(8): The ‘__debug__’ constant is now optimized out at
     compile time.  This fixes also bpo-22091(9).

   - bpo-32329(10): The *note -R: fcc. option now turns on hash
     randomization when the *note PYTHONHASHSEED: 9b9. environment
     variable is set to ‘0’.  Previously, the option was ignored.
     Moreover, ‘sys.flags.hash_randomization’ is now properly set to 0
     when hash randomization is turned off by ‘PYTHONHASHSEED=0’.

   - bpo-30416(11): The optimizer is now protected from spending much
     time doing complex calculations and consuming much memory for
     creating large constants in constant folding.  Increased limits for
     constants that can be produced in constant folding.

   - bpo-32282(12): Fix an unnecessary ifdef in the include of
     VersionHelpers.h in socketmodule on Windows.

   - bpo-30579(13): Implement TracebackType.__new__ to allow
     Python-level creation of traceback objects, and make
     TracebackType.tb_next mutable.

   - bpo-32260(14): Don’t byte swap the input keys to the SipHash
     algorithm on big-endian platforms.  This should ensure siphash
     gives consistent results across platforms.

   - bpo-31506(15): Improve the error message logic for object.__new__
     and object.__init__.  Patch by Sanyam Khurana.

   - bpo-20361(16): ‘-b’ and ‘-bb’ now inject ‘'default::BytesWarning'’
     and ‘error::BytesWarning’ entries into ‘sys.warnoptions’, ensuring
     that they take precedence over any other warning filters configured
     via the ‘-W’ option or the ‘PYTHONWARNINGS’ environment variable.

   - bpo-32230(17): ‘-X dev’ now injects a ‘'default'’ entry into
     sys.warnoptions, ensuring that it behaves identically to actually
     passing ‘-Wdefault’ at the command line.

   - bpo-29240(18): Add a new UTF-8 mode: implementation of the PEP
     540(19).

   - bpo-32226(20): PEP 560(21): Add support for ‘__mro_entries__’ and
     ‘__class_getitem__’.  Implemented by Ivan Levkivskyi.

   - bpo-32225(22): PEP 562(23): Add support for module ‘__getattr__’
     and ‘__dir__’.  Implemented by Ivan Levkivskyi.

   - bpo-31901(24): The *note atexit: c. module now has its callback
     stored per interpreter.

   - bpo-31650(25): Implement PEP 552(26) (Deterministic pycs).  Python
     now supports invalidating bytecode cache files bashed on a source
     content hash rather than source last-modified time.

   - bpo-29469(27): Move constant folding from bytecode layer to AST
     layer.  Original patch by Eugene Toder.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31975

   (2) https://bugs.python.org/issue32226

   (3) https://bugs.python.org/issue32399

   (4) https://bugs.python.org/issue32390

   (5) https://bugs.python.org/issue32143

   (6) https://bugs.python.org/issue32379

   (7) https://bugs.python.org/issue32259

   (8) https://bugs.python.org/issue27169

   (9) https://bugs.python.org/issue22091

   (10) https://bugs.python.org/issue32329

   (11) https://bugs.python.org/issue30416

   (12) https://bugs.python.org/issue32282

   (13) https://bugs.python.org/issue30579

   (14) https://bugs.python.org/issue32260

   (15) https://bugs.python.org/issue31506

   (16) https://bugs.python.org/issue20361

   (17) https://bugs.python.org/issue32230

   (18) https://bugs.python.org/issue29240

   (19) https://www.python.org/dev/peps/pep-0540

   (20) https://bugs.python.org/issue32226

   (21) https://www.python.org/dev/peps/pep-0560

   (22) https://bugs.python.org/issue32225

   (23) https://www.python.org/dev/peps/pep-0562

   (24) https://bugs.python.org/issue31901

   (25) https://bugs.python.org/issue31650

   (26) https://www.python.org/dev/peps/pep-0552

   (27) https://bugs.python.org/issue29469


File: python.info,  Node: Library<20>,  Next: Documentation<19>,  Prev: Core and Builtins<19>,  Up: Python 3 7 0 alpha 4

1.18.20.2 Library
.................

   - bpo-32506(1): Now that dict is defined as keeping insertion order,
     drop OrderedDict and just use plain dict.

   - bpo-32279(2): Add params to dataclasses.make_dataclasses(): init,
     repr, eq, order, hash, and frozen.  Pass them through to
     dataclass().

   - bpo-32278(3): Make type information optional on
     dataclasses.make_dataclass().  If omitted, the string ‘typing.Any’
     is used.

   - bpo-32499(4): Add dataclasses.is_dataclass(obj), which returns True
     if obj is a dataclass or an instance of one.

   - bpo-32468(5): Improve frame repr() to mention filename, code name
     and current line number.

   - bpo-23749(6): asyncio: Implement loop.start_tls()

   - bpo-32441(7): Return the new file descriptor (i.e., the second
     argument) from ‘os.dup2’.  Previously, ‘None’ was always returned.

   - bpo-32422(8): ‘functools.lru_cache’ uses less memory (3 words for
     each cached key) and takes about 1/3 time for cyclic GC.

   - bpo-31721(9): Prevent Python crash from happening when
     Future._log_traceback is set to True manually.  Now it can only be
     set to False, or a ValueError is raised.

   - bpo-32415(10): asyncio: Add Task.get_loop() and Future.get_loop()

   - bpo-26133(11): Don’t unsubscribe signals in asyncio UNIX event loop
     on interpreter shutdown.

   - bpo-32363(12): Make asyncio.Task.set_exception() and set_result()
     raise NotImplementedError.  Task._step() and Future.__await__()
     raise proper exceptions when they are in an invalid state, instead
     of raising an AssertionError.

   - bpo-32357(13): Optimize asyncio.iscoroutine() and
     loop.create_task() for non-native coroutines (e.g.  async/await
     compiled with Cython).  ‘loop.create_task(python_coroutine)’ used
     to be 20% faster than ‘loop.create_task(cython_coroutine)’.  Now,
     the latter is as fast.

   - bpo-32356(14): asyncio.transport.resume_reading() and
     pause_reading() are now idempotent.  New transport.is_reading()
     method is added.

   - bpo-32355(15): Optimize asyncio.gather(); now up to 15% faster.

   - bpo-32351(16): Use fastpath in asyncio.sleep if delay<0 (2x boost)

   - bpo-32348(17): Optimize asyncio.Future schedule/add/remove
     callback.  The optimization shows 3-6% performance improvements of
     async/await code.

   - bpo-32331(18): Fix socket.settimeout() and socket.setblocking() to
     keep socket.type as is.  Fix socket.socket() constructor to reset
     any bit flags applied to socket’s type.  This change only affects
     OSes that have SOCK_NONBLOCK and/or SOCK_CLOEXEC.

   - bpo-32248(19): Add *note importlib.abc.ResourceReader: 337. as an
     ABC for loaders to provide a unified API for reading resources
     contained within packages.  Also add *note importlib.resources: 9e.
     as the port of ‘importlib_resources’.

   - bpo-32311(20): Implement asyncio.create_task(coro) shortcut

   - bpo-32327(21): Convert asyncio functions that were documented as
     coroutines to coroutines.  Affected functions: loop.sock_sendall,
     loop.sock_recv, loop.sock_accept, loop.getaddrinfo,
     loop.getnameinfo.

   - bpo-32323(22): *note urllib.parse.urlsplit(): 5ee. does not convert
     zone-id (scope) to lower case for scoped IPv6 addresses in
     hostnames now.

   - bpo-32302(23): Fix bdist_wininst of distutils for CRT v142: it
     binary compatible with CRT v140.

   - bpo-29711(24): Fix ‘stop_serving’ in asyncio proactor loop kill all
     listening servers

   - bpo-32308(25): *note re.sub(): 470. now replaces empty matches
     adjacent to a previous non-empty match.

   - bpo-29970(26): Abort asyncio SSLProtocol connection if handshake
     not complete within 10s

   - bpo-32314(27): Implement asyncio.run().

   - bpo-17852(28): Revert incorrect fix based on misunderstanding of
     _Py_PyAtExit() semantics.

   - bpo-32296(29): Implement asyncio._get_running_loop() and
     get_event_loop() in C. This makes them 4x faster.

   - bpo-32250(30): Implement ‘asyncio.current_task()’ and
     ‘asyncio.all_tasks()’.  Add helpers intended to be used by
     alternative task implementations: ‘asyncio._register_task’,
     ‘asyncio._enter_task’, ‘asyncio._leave_task’ and
     ‘asyncio._unregister_task’.  Deprecate
     ‘asyncio.Task.current_task()’ and ‘asyncio.Task.all_tasks()’.

   - bpo-32255(31): A single empty field is now always quoted when
     written into a CSV file.  This allows to distinguish an empty row
     from a row consisting of a single empty field.  Patch by Licht
     Takeuchi.

   - bpo-32277(32): Raise ‘NotImplementedError’ instead of ‘SystemError’
     on platforms where ‘chmod(..., follow_symlinks=False)’ is not
     supported.  Patch by Anthony Sottile.

   - bpo-30050(33): New argument warn_on_full_buffer to
     signal.set_wakeup_fd lets you control whether Python prints a
     warning on stderr when the wakeup fd buffer overflows.

   - bpo-29137(34): The ‘fpectl’ library has been removed.  It was never
     enabled by default, never worked correctly on x86-64, and it
     changed the Python ABI in ways that caused unexpected breakage of C
     extensions.

   - bpo-32273(35): Move asyncio.test_utils to test.test_asyncio.

   - bpo-32272(36): Remove asyncio.async() function.

   - bpo-32269(37): Add asyncio.get_running_loop() function.

   - bpo-32265(38): All class and static methods of builtin types now
     are correctly classified by inspect.classify_class_attrs() and
     grouped in pydoc ouput.  Added types.ClassMethodDescriptorType for
     unbound class methods of builtin types.

   - bpo-32253(39): Deprecate ‘yield from lock’, ‘await lock’, ‘with
     (yield from lock)’ and ‘with await lock’ for asyncio
     synchronization primitives.

   - bpo-22589(40): Changed MIME type of .bmp from ‘image/x-ms-bmp’ to
     ‘image/bmp’

   - bpo-32193(41): Convert asyncio to use `async/await' syntax.  Old
     styled ‘yield from’ is still supported too.

   - bpo-32206(42): Add support to run modules with pdb

   - bpo-32227(43): ‘functools.singledispatch’ now supports registering
     implementations using type annotations.

   - bpo-15873(44): Added new alternate constructors *note
     datetime.datetime.fromisoformat(): 373, *note
     datetime.time.fromisoformat(): fce. and *note
     datetime.date.fromisoformat(): fcf. as the inverse operation of
     each classes’s respective ‘isoformat’ methods.

   - bpo-32199(45): The getnode() ip getter now uses ‘ip link’ instead
     of ‘ip link list’.

   - bpo-32143(46): os.statvfs() includes the f_fsid field from
     statvfs(2)

   - bpo-26439(47): Fix ctypes.util.find_library() for AIX by
     implementing ctypes._aix.find_library() Patch by: Michael Felt

   - bpo-31993(48): The pickler now uses less memory when serializing
     large bytes and str objects into a file.  Pickles created with
     protocol 4 will require less memory for unpickling large bytes and
     str objects.

   - bpo-27456(49): Ensure TCP_NODELAY is set on Linux.  Tests by Victor
     Stinner.

   - bpo-31778(50): ast.literal_eval() is now more strict.  Addition and
     subtraction of arbitrary numbers no longer allowed.

   - bpo-31802(51): Importing native path module (‘posixpath’, ‘ntpath’)
     now works even if the ‘os’ module still is not imported.

   - bpo-30241(52): Add contextlib.AbstractAsyncContextManager.  Patch
     by Jelle Zijlstra.

   - bpo-31699(53): Fix deadlocks in *note
     concurrent.futures.ProcessPoolExecutor: 2a2. when task arguments or
     results cause pickling or unpickling errors.  This should make sure
     that calls to the ‘ProcessPoolExecutor’ API always eventually
     return.

   - bpo-15216(54): ‘TextIOWrapper.reconfigure()’ supports changing
     `encoding', `errors', and `newline'.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32506

   (2) https://bugs.python.org/issue32279

   (3) https://bugs.python.org/issue32278

   (4) https://bugs.python.org/issue32499

   (5) https://bugs.python.org/issue32468

   (6) https://bugs.python.org/issue23749

   (7) https://bugs.python.org/issue32441

   (8) https://bugs.python.org/issue32422

   (9) https://bugs.python.org/issue31721

   (10) https://bugs.python.org/issue32415

   (11) https://bugs.python.org/issue26133

   (12) https://bugs.python.org/issue32363

   (13) https://bugs.python.org/issue32357

   (14) https://bugs.python.org/issue32356

   (15) https://bugs.python.org/issue32355

   (16) https://bugs.python.org/issue32351

   (17) https://bugs.python.org/issue32348

   (18) https://bugs.python.org/issue32331

   (19) https://bugs.python.org/issue32248

   (20) https://bugs.python.org/issue32311

   (21) https://bugs.python.org/issue32327

   (22) https://bugs.python.org/issue32323

   (23) https://bugs.python.org/issue32302

   (24) https://bugs.python.org/issue29711

   (25) https://bugs.python.org/issue32308

   (26) https://bugs.python.org/issue29970

   (27) https://bugs.python.org/issue32314

   (28) https://bugs.python.org/issue17852

   (29) https://bugs.python.org/issue32296

   (30) https://bugs.python.org/issue32250

   (31) https://bugs.python.org/issue32255

   (32) https://bugs.python.org/issue32277

   (33) https://bugs.python.org/issue30050

   (34) https://bugs.python.org/issue29137

   (35) https://bugs.python.org/issue32273

   (36) https://bugs.python.org/issue32272

   (37) https://bugs.python.org/issue32269

   (38) https://bugs.python.org/issue32265

   (39) https://bugs.python.org/issue32253

   (40) https://bugs.python.org/issue22589

   (41) https://bugs.python.org/issue32193

   (42) https://bugs.python.org/issue32206

   (43) https://bugs.python.org/issue32227

   (44) https://bugs.python.org/issue15873

   (45) https://bugs.python.org/issue32199

   (46) https://bugs.python.org/issue32143

   (47) https://bugs.python.org/issue26439

   (48) https://bugs.python.org/issue31993

   (49) https://bugs.python.org/issue27456

   (50) https://bugs.python.org/issue31778

   (51) https://bugs.python.org/issue31802

   (52) https://bugs.python.org/issue30241

   (53) https://bugs.python.org/issue31699

   (54) https://bugs.python.org/issue15216


File: python.info,  Node: Documentation<19>,  Next: Tests<18>,  Prev: Library<20>,  Up: Python 3 7 0 alpha 4

1.18.20.3 Documentation
.......................

   - bpo-32418(1): Add get_loop() method to Server and AbstractServer
     classes.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32418


File: python.info,  Node: Tests<18>,  Next: Windows<18>,  Prev: Documentation<19>,  Up: Python 3 7 0 alpha 4

1.18.20.4 Tests
...............

   - bpo-32252(1): Fix faulthandler_suppress_crash_report() used to
     prevent core dump files when testing crashes.  getrlimit() returns
     zero on success.

   - bpo-32002(2): Adjust C locale coercion testing for the empty locale
     and POSIX locale cases to more readily adjust to platform dependent
     behaviour.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32252

   (2) https://bugs.python.org/issue32002


File: python.info,  Node: Windows<18>,  Next: Tools/Demos<12>,  Prev: Tests<18>,  Up: Python 3 7 0 alpha 4

1.18.20.5 Windows
.................

   - bpo-19764(1): Implement support for
     ‘subprocess.Popen(close_fds=True)’ on Windows.  Patch by Segev
     Finer.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19764


File: python.info,  Node: Tools/Demos<12>,  Next: C API<13>,  Prev: Windows<18>,  Up: Python 3 7 0 alpha 4

1.18.20.6 Tools/Demos
.....................

   - bpo-24960(1): 2to3 and lib2to3 can now read pickled grammar files
     using pkgutil.get_data() rather than probing the filesystem.  This
     lets 2to3 and lib2to3 work when run from a zipfile.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24960


File: python.info,  Node: C API<13>,  Prev: Tools/Demos<12>,  Up: Python 3 7 0 alpha 4

1.18.20.7 C API
...............

   - bpo-32030(1): Py_Initialize() doesn’t reset the memory allocators
     to default if the ‘PYTHONMALLOC’ environment variable is not set.

   - bpo-29084(2): Undocumented C API for OrderedDict has been excluded
     from the limited C API. It was added by mistake and actually never
     worked in the limited C API.

   - bpo-32264(3): Moved the pygetopt.h header into internal/, since it
     has no public APIs.

   - bpo-32241(4): *note Py_SetProgramName(): eba. and *note
     Py_SetPythonHome(): eb9. now take the ‘const wchar *’ arguments
     instead of ‘wchar *’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32030

   (2) https://bugs.python.org/issue29084

   (3) https://bugs.python.org/issue32264

   (4) https://bugs.python.org/issue32241


File: python.info,  Node: Python 3 7 0 alpha 3,  Next: Python 3 7 0 alpha 2,  Prev: Python 3 7 0 alpha 4,  Up: Changelog

1.18.21 Python 3.7.0 alpha 3
----------------------------

`Release date: 2017-12-05'

* Menu:

* Core and Builtins: Core and Builtins<20>.
* Library: Library<21>.
* Documentation: Documentation<20>.
* Tests: Tests<19>.
* Build: Build<16>.
* Windows: Windows<19>.
* macOS: macOS<14>.
* IDLE: IDLE<20>.
* Tools/Demos: Tools/Demos<13>.
* C API: C API<14>.


File: python.info,  Node: Core and Builtins<20>,  Next: Library<21>,  Up: Python 3 7 0 alpha 3

1.18.21.1 Core and Builtins
...........................

   - bpo-32176(1): co_flags.CO_NOFREE is now always set correctly by the
     code object constructor based on freevars and cellvars, rather than
     needing to be set correctly by the caller.  This ensures it will be
     cleared automatically when additional cell references are injected
     into a modified code object and function.

   - bpo-10544(2): Yield expressions are now deprecated in
     comprehensions and generator expressions.  They are still permitted
     in the definition of the outermost iterable, as that is evaluated
     directly in the enclosing scope.

   - bpo-32137(3): The repr of deeply nested dict now raises a
     RecursionError instead of crashing due to a stack overflow.

   - bpo-32096(4): Revert memory allocator changes in the C API: move
     structures back from _PyRuntime to Objects/obmalloc.c.  The memory
     allocators are once again initialized statically, and so
     PyMem_RawMalloc() and Py_DecodeLocale() can be called before
     _PyRuntime_Initialize().

   - bpo-32043(5): Add a new “developer mode”: new “-X dev” command line
     option to enable debug checks at runtime.

   - bpo-32023(6): SyntaxError is now correctly raised when a generator
     expression without parenthesis is used instead of an inheritance
     list in a class definition.  The duplication of the parentheses can
     be omitted only on calls.

   - bpo-32012(7): SyntaxError is now correctly raised when a generator
     expression without parenthesis is passed as an argument, but
     followed by a trailing comma.  A generator expression always needs
     to be directly inside a set of parentheses and cannot have a comma
     on either side.

   - bpo-28180(8): A new internal ‘_Py_SetLocaleFromEnv(category)’
     helper function has been added in order to improve the consistency
     of behaviour across different ‘libc’ implementations (e.g.  Android
     doesn’t support setting the locale from the environment by
     default).

   - bpo-31949(9): Fixed several issues in printing tracebacks
     (PyTraceBack_Print()).  Setting sys.tracebacklimit to 0 or less now
     suppresses printing tracebacks.  Setting sys.tracebacklimit to None
     now causes using the default limit.  Setting sys.tracebacklimit to
     an integer larger than LONG_MAX now means using the limit LONG_MAX
     rather than the default limit.  Fixed integer overflows in the case
     of more than 2**31 traceback items on Windows.  Fixed output errors
     handling.

   - bpo-30696(10): Fix the interactive interpreter looping endlessly
     when no memory.

   - bpo-20047(11): Bytearray methods partition() and rpartition() now
     accept only bytes-like objects as separator, as documented.  In
     particular they now raise TypeError rather of returning a bogus
     result when an integer is passed as a separator.

   - bpo-21720(12): BytesWarning no longer emitted when the `fromlist'
     argument of ‘__import__()’ or the ‘__all__’ attribute of the module
     contain bytes instances.

   - bpo-31845(13): Environment variables are once more read correctly
     at interpreter startup.

   - bpo-28936(14): Ensure that lexically first syntax error involving a
     parameter and ‘global’ or ‘nonlocal’ is detected first at a given
     scope.  Patch by Ivan Levkivskyi.

   - bpo-31825(15): Fixed OverflowError in the ‘unicode-escape’ codec
     and in codecs.escape_decode() when decode an escaped non-ascii
     byte.

   - bpo-31618(16): The per-frame tracing logic added in 3.7a1 has been
     altered so that ‘frame->f_lineno’ is updated before either ‘"line"’
     or ‘"opcode"’ events are emitted.  Previously, opcode events were
     emitted first, and therefore would occasionally see stale line
     numbers on the frame.  The behavior of this feature has changed
     slightly as a result: when both ‘f_trace_lines’ and
     ‘f_trace_opcodes’ are enabled, line events now occur first.

   - bpo-28603(17): Print the full context/cause chain of exceptions on
     interpreter exit, even if an exception in the chain is unhashable
     or compares equal to later ones.  Patch by Zane Bitter.

   - bpo-31786(18): Fix timeout rounding in the select module to round
     correctly negative timeouts between -1.0 and 0.0.  The functions
     now block waiting for events as expected.  Previously, the call was
     incorrectly non-blocking.  Patch by Pablo Galindo.

   - bpo-31781(19): Prevent crashes when calling methods of an
     uninitialized ‘zipimport.zipimporter’ object.  Patch by Oren
     Milman.

   - bpo-30399(20): Standard repr() of BaseException with a single
     argument no longer contains redundant trailing comma.

   - bpo-31626(21): Fixed a bug in debug memory allocator.  There was a
     write to freed memory after shrinking a memory block.

   - bpo-30817(22): ‘PyErr_PrintEx()’ clears now the ignored exception
     that may be raised by ‘_PySys_SetObjectId()’, for example when no
     memory.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32176

   (2) https://bugs.python.org/issue10544

   (3) https://bugs.python.org/issue32137

   (4) https://bugs.python.org/issue32096

   (5) https://bugs.python.org/issue32043

   (6) https://bugs.python.org/issue32023

   (7) https://bugs.python.org/issue32012

   (8) https://bugs.python.org/issue28180

   (9) https://bugs.python.org/issue31949

   (10) https://bugs.python.org/issue30696

   (11) https://bugs.python.org/issue20047

   (12) https://bugs.python.org/issue21720

   (13) https://bugs.python.org/issue31845

   (14) https://bugs.python.org/issue28936

   (15) https://bugs.python.org/issue31825

   (16) https://bugs.python.org/issue31618

   (17) https://bugs.python.org/issue28603

   (18) https://bugs.python.org/issue31786

   (19) https://bugs.python.org/issue31781

   (20) https://bugs.python.org/issue30399

   (21) https://bugs.python.org/issue31626

   (22) https://bugs.python.org/issue30817


File: python.info,  Node: Library<21>,  Next: Documentation<20>,  Prev: Core and Builtins<20>,  Up: Python 3 7 0 alpha 3

1.18.21.2 Library
.................

   - bpo-28556(1): Two minor fixes for ‘typing’ module: allow shallow
     copying instances of generic classes, improve interaction of
     ‘__init_subclass__’ with generics.  Original PRs by Ivan
     Levkivskyi.

   - bpo-32214(2): PEP 557, Data Classes.  Provides a decorator which
     adds boilerplate methods to classes which use type annotations so
     specify fields.

   - bpo-27240(3): The header folding algorithm for the new email
     policies has been rewritten, which also fixes bpo-30788(4),
     bpo-31831(5), and bpo-32182(6).  In particular, RFC2231 folding is
     now done correctly.

   - bpo-32186(7): io.FileIO.readall() and io.FileIO.read() now release
     the GIL when getting the file size.  Fixed hang of all threads with
     inaccessible NFS server.  Patch by Nir Soffer.

   - bpo-321010(8): Add ‘sys.flags.dev_mode’ flag

   - bpo-32154(9): The ‘asyncio.windows_utils.socketpair()’ function has
     been removed: use directly *note socket.socketpair(): 476. which is
     available on all platforms since Python 3.5 (before, it wasn’t
     available on Windows).  ‘asyncio.windows_utils.socketpair()’ was
     just an alias to ‘socket.socketpair’ on Python 3.5 and newer.

   - bpo-32089(10): warnings: In development (-X dev) and debug mode
     (pydebug build), use the “default” action for ResourceWarning,
     rather than the “always” action, in the default warnings filters.

   - bpo-32107(11): ‘uuid.getnode()’ now preferentially returns
     universally administered MAC addresses if available, over locally
     administered MAC addresses.  This makes a better guarantee for
     global uniqueness of UUIDs returned from ‘uuid.uuid1()’.  If only
     locally administered MAC addresses are available, the first such
     one found is returned.

   - bpo-23033(12): Wildcard is now supported in hostname when it is one
     and only character in the left most segment of hostname in second
     argument of *note ssl.match_hostname(): 3d1.  Patch by Mandeep
     Singh.

   - bpo-12239(13): Make *note msilib.SummaryInformation.GetProperty():
     ef5. return ‘None’ when the value of property is ‘VT_EMPTY’.
     Initial patch by Mark Mc Mahon.

   - bpo-28334(14): Use *note os.path.expanduser(): 1fc. to find the
     ‘~/.netrc’ file in *note netrc.netrc: fd8.  If it does not exist,
     *note FileNotFoundError: 7b4. is raised.  Patch by Dimitri
     Merejkowsky.

   - bpo-32121(15): Made ‘tracemalloc.Traceback’ behave more like the
     traceback module, sorting the frames from oldest to most recent.
     ‘Traceback.format()’ now accepts negative `limit', truncating the
     result to the ‘abs(limit)’ oldest frames.  To get the old
     behaviour, one can use the new `most_recent_first' argument to
     ‘Traceback.format()’.  (Patch by Jesse Bakker.)

   - bpo-31325(16): Fix wrong usage of *note collections.namedtuple():
     1b5. in the *note RobotFileParser.parse(): fd9. method.  Initial
     patch by Robin Wellner.

   - bpo-12382(17): *note msilib.OpenDatabase(): fda. now raises a
     better exception message when it couldn’t open or create an MSI
     file.  Initial patch by William Tisäter.

   - bpo-19610(18): ‘setup()’ now warns about invalid types for some
     fields.  The ‘distutils.dist.Distribution’ class now warns when
     ‘classifiers’, ‘keywords’ and ‘platforms’ fields are not specified
     as a list or a string.

   - bpo-32071(19): Added the ‘-k’ command-line option to ‘python -m
     unittest’ to run only tests that match the given pattern(s).

   - bpo-10049(20): Added `nullcontext' no-op context manager to
     contextlib.  This provides a simpler and faster alternative to
     ExitStack() when handling optional context managers.

   - bpo-28684(21): The new test.support.skip_unless_bind_unix_socket()
     decorator is used here to skip asyncio tests that fail because the
     platform lacks a functional bind() function for unix domain sockets
     (as it is the case for non root users on the recent Android
     versions that run now SELinux in enforcing mode).

   - bpo-32110(22): ‘codecs.StreamReader.read(n)’ now returns not more
     than `n' characters/bytes for non-negative `n'.  This makes it
     compatible with ‘read()’ methods of other file-like objects.

   - bpo-27535(23): The warnings module doesn’t leak memory anymore in
     the hidden warnings registry for the “ignore” action of warnings
     filters.  warn_explicit() function doesn’t add the warning key to
     the registry anymore for the “ignore” action.

   - bpo-32088(24): warnings: When Python is build is debug mode
     (‘Py_DEBUG’), *note DeprecationWarning: 276, *note
     PendingDeprecationWarning: 277. and *note ImportWarning: 5cd.
     warnings are now displayed by default.

   - bpo-1647489(25): Fixed searching regular expression patterns that
     could match an empty string.  Non-empty string can now be correctly
     found after matching an empty string.

   - bpo-25054(26): Added support of splitting on a pattern that could
     match an empty string.

   - bpo-32072(27): Fixed issues with binary plists: Fixed saving
     bytearrays.  Identical objects will be saved only once.  Equal
     references will be load as identical objects.  Added support for
     saving and loading recursive data structures.

   - bpo-32069(28): Drop legacy SSL transport from asyncio,
     ssl.MemoryBIO is always used anyway.

   - bpo-32066(29): asyncio: Support pathlib.Path in
     create_unix_connection; sock arg should be optional

   - bpo-32046(30): Updates 2to3 to convert from
     operator.isCallable(obj) to callable(obj).  Patch by Dong-hee Na.

   - bpo-32018(31): inspect.signature should follow PEP 8(32), if the
     parameter has an annotation and a default value.  Patch by Dong-hee
     Na.

   - bpo-32025(33): Add time.thread_time() and time.thread_time_ns()

   - bpo-32037(34): Integers that fit in a signed 32-bit integer will be
     now pickled with protocol 0 using the INT opcode.  This will
     decrease the size of a pickle, speed up pickling and unpickling,
     and make these integers be unpickled as int instances in Python 2.

   - bpo-32034(35): Make asyncio.IncompleteReadError and
     LimitOverrunError pickleable.

   - bpo-32015(36): Fixed the looping of asyncio in the case of
     reconnection the socket during waiting async read/write from/to the
     socket.

   - bpo-32011(37): Restored support of loading marshal files with the
     TYPE_INT64 code.  These files can be produced in Python 2.7.

   - bpo-28369(38): Enhance add_reader/writer check that socket is not
     used by some transport.  Before, only cases when add_reader/writer
     were called with an int FD were supported.  Now the check is
     implemented correctly for all file-like objects.

   - bpo-31976(39): Fix race condition when flushing a file is slow,
     which can cause a segfault if closing the file from another thread.

   - bpo-31985(40): Formally deprecated aifc.openfp, sunau.openfp, and
     wave.openfp.  Since change 7bc817d5ba917528e8bd07ec461c635291e7b06a
     in 1993, openfp in each of the three modules had been pointing to
     that module’s open function as a matter of backwards compatibility,
     though it had been both untested and undocumented.

   - bpo-21862(41): cProfile command line now accepts ‘-m module_name’
     as an alternative to script path.  Patch by Sanyam Khurana.

   - bpo-31970(42): Reduce performance overhead of asyncio debug mode.

   - bpo-31843(43): `database' argument of sqlite3.connect() now accepts
     a *note path-like object: 35f, instead of just a string.

   - bpo-31945(44): Add Configurable `blocksize' to ‘HTTPConnection’ and
     ‘HTTPSConnection’ for improved upload throughput.  Patch by Nir
     Soffer.

   - bpo-31943(45): Add a ‘cancelled()’ method to *note asyncio.Handle:
     fdb.  Patch by Marat Sharafutdinov.

   - bpo-9678(46): Fixed determining the MAC address in the uuid module:
     Using ifconfig on NetBSD and OpenBSD. Using arp on Linux, FreeBSD,
     NetBSD and OpenBSD. Based on patch by Takayuki Shimizukawa.

   - bpo-30057(47): Fix potential missed signal in signal.signal().

   - bpo-31933(48): Fix Blake2 params leaf_size and node_offset on big
     endian platforms.  Patch by Jack O’Connor.

   - bpo-21423(49): Add an initializer argument to
     {Process,Thread}PoolExecutor

   - bpo-31927(50): Fixed compilation of the socket module on NetBSD 8.
     Fixed assertion failure or reading arbitrary data when parse a
     AF_BLUETOOTH address on NetBSD and DragonFly BSD.

   - bpo-27666(51): Fixed stack corruption in curses.box() and
     curses.ungetmouse() when the size of types chtype or mmask_t is
     less than the size of C long.  curses.box() now accepts characters
     as arguments.  Based on patch by Steve Fink.

   - bpo-31917(52): Add 3 new clock identifiers: *note
     time.CLOCK_BOOTTIME: 3ea, *note time.CLOCK_PROF: 3ec. and *note
     time.CLOCK_UPTIME: 3ed.

   - bpo-31897(53): plistlib now catches more errors when read binary
     plists and raises InvalidFileException instead of unexpected
     exceptions.

   - bpo-25720(54): Fix the method for checking pad state of curses
     WINDOW. Patch by Masayuki Yamamoto.

   - bpo-31893(55): Fixed the layout of the kqueue_event structure on
     OpenBSD and NetBSD. Fixed the comparison of the kqueue_event
     objects.

   - bpo-31891(56): Fixed building the curses module on NetBSD.

   - bpo-31884(57): added required constants to subprocess module for
     setting priority on windows

   - bpo-28281(58): Remove year (1-9999) limits on the
     Calendar.weekday() function.  Patch by Mark Gollahon.

   - bpo-31702(59): crypt.mksalt() now allows to specify the number of
     rounds for SHA-256 and SHA-512 hashing.

   - bpo-30639(60): *note inspect.getfile(): fdc. no longer computes the
     repr of unknown objects to display in an error message, to protect
     against badly behaved custom reprs.

   - bpo-30768(61): Fix the pthread+semaphore implementation of
     PyThread_acquire_lock_timed() when called with timeout > 0 and
     intr_flag=0: recompute the timeout if sem_timedwait() is
     interrupted by a signal (EINTR). See also the PEP 475(62).

   - bpo-31854(63): Add ‘mmap.ACCESS_DEFAULT’ constant.

   - bpo-31834(64): Use optimized code for BLAKE2 only with SSSE3+.  The
     pure SSE2 implementation is slower than the pure C reference
     implementation.

   - bpo-28292(65): Calendar.itermonthdates() will now consistently
     raise an exception when a date falls outside of the 0001-01-01
     through 9999-12-31 range.  To support applications that cannot
     tolerate such exceptions, the new methods itermonthdays3() and
     itermonthdays4() are added.  The new methods return tuples and are
     not restricted by the range supported by datetime.date.

   - bpo-28564(66): The shutil.rmtree() function has been sped up to
     20–40%.  This was done using the os.scandir() function.

   - bpo-28416(67): Instances of pickle.Pickler subclass with the
     persistent_id() method and pickle.Unpickler subclass with the
     persistent_load() method no longer create reference cycles.

   - bpo-31653(68): Don’t release the GIL if we can acquire a
     multiprocessing semaphore immediately.

   - bpo-28326(69): Fix multiprocessing.Process when stdout and/or
     stderr is closed or None.

   - bpo-20825(70): Add ‘subnet_of’ and ‘superset_of’ containment tests
     to *note ipaddress.IPv6Network: 394. and *note
     ipaddress.IPv4Network: 395.  Patch by Michel Albert and Cheryl
     Sabella.

   - bpo-31827(71): Remove the os.stat_float_times() function.  It was
     introduced in Python 2.3 for backward compatibility with Python
     2.2, and was deprecated since Python 3.1.

   - bpo-31756(72): Add a ‘subprocess.Popen(text=False)’ keyword
     argument to *note subprocess: f9. functions to be more explicit
     about when the library should attempt to decode outputs into text.
     Patch by Andrew Clegg.

   - bpo-31819(73): Add AbstractEventLoop.sock_recv_into().

   - bpo-31457(74): If nested log adapters are used, the inner
     ‘process()’ methods are no longer omitted.

   - bpo-31457(75): The ‘manager’ property on LoggerAdapter objects is
     now properly settable.

   - bpo-31806(76): Fix timeout rounding in time.sleep(),
     threading.Lock.acquire() and socket.socket.settimeout() to round
     correctly negative timeouts between -1.0 and 0.0.  The functions
     now block waiting for events as expected.  Previously, the call was
     incorrectly non-blocking.  Patch by Pablo Galindo.

   - bpo-31803(77): time.clock() and time.get_clock_info(‘clock’) now
     emit a DeprecationWarning warning.

   - bpo-31800(78): Extended support for parsing UTC offsets.  strptime
     ‘%z’ can now parse the output generated by datetime.isoformat,
     including seconds and microseconds.

   - bpo-28603(79): traceback: Fix a TypeError that occurred during
     printing of exception tracebacks when either the current exception
     or an exception in its context/cause chain is unhashable.  Patch by
     Zane Bitter.

   - bpo-30541(80): Add new function to seal a mock and prevent the
     automatically creation of child mocks.  Patch by Mario Corchero.

   - bpo-31784(81): Implement the PEP 564(82), add new 6 new functions
     with nanosecond resolution to the *note time: 10a. module: *note
     clock_gettime_ns(): 313, *note clock_settime_ns(): 314, *note
     monotonic_ns(): 315, *note perf_counter_ns(): 316, *note
     process_time_ns(): 317, *note time_ns(): 318.

   - bpo-30143(83): 2to3 now generates a code that uses abstract
     collection classes from collections.abc rather than collections.

   - bpo-31770(84): Prevent a crash when calling the ‘__init__()’ method
     of a ‘sqlite3.Cursor’ object more than once.  Patch by Oren Milman.

   - bpo-31764(85): Prevent a crash in ‘sqlite3.Cursor.close()’ in case
     the ‘Cursor’ object is uninitialized.  Patch by Oren Milman.

   - bpo-31752(86): Fix possible crash in timedelta constructor called
     with custom integers.

   - bpo-31620(87): an empty asyncio.Queue now doesn’t leak memory when
     queue.get pollers timeout

   - bpo-31690(88): Allow the flags re.ASCII, re.LOCALE, and re.UNICODE
     to be used as group flags for regular expressions.

   - bpo-30349(89): FutureWarning is now emitted if a regular expression
     contains character set constructs that will change semantically in
     the future (nested sets and set operations).

   - bpo-31664(90): Added support for the Blowfish hashing in the crypt
     module.

   - bpo-31632(91): Fix method set_protocol() of class
     _SSLProtocolTransport in asyncio module.  This method was
     previously modifying a wrong reference to the protocol.

   - bpo-15037(92): Added a workaround for getkey() in curses for
     ncurses 5.7 and earlier.

   - bpo-31307(93): Allow use of bytes objects for arguments to *note
     configparser.ConfigParser.read(): fdd.  Patch by Vincent Michel.

   - bpo-31334(94): Fix ‘poll.poll([timeout])’ in the ‘select’ module
     for arbitrary negative timeouts on all OSes where it can only be a
     non-negative integer or -1.  Patch by Riccardo Coccioli.

   - bpo-31310(95): multiprocessing’s semaphore tracker should be
     launched again if crashed.

   - bpo-31308(96): Make multiprocessing’s forkserver process immune to
     Ctrl-C and other user interruptions.  If it crashes, restart it
     when necessary.

   - bpo-31245(97): Added support for AF_UNIX socket in asyncio
     ‘create_datagram_endpoint’.

   - bpo-30553(98): Add HTTP/2 status code 421 (Misdirected Request) to
     *note http.HTTPStatus: 6d6.  Patch by Vitor Pereira.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28556

   (2) https://bugs.python.org/issue32214

   (3) https://bugs.python.org/issue27240

   (4) https://bugs.python.org/issue30788

   (5) https://bugs.python.org/issue31831

   (6) https://bugs.python.org/issue32182

   (7) https://bugs.python.org/issue32186

   (8) https://bugs.python.org/issue321010

   (9) https://bugs.python.org/issue32154

   (10) https://bugs.python.org/issue32089

   (11) https://bugs.python.org/issue32107

   (12) https://bugs.python.org/issue23033

   (13) https://bugs.python.org/issue12239

   (14) https://bugs.python.org/issue28334

   (15) https://bugs.python.org/issue32121

   (16) https://bugs.python.org/issue31325

   (17) https://bugs.python.org/issue12382

   (18) https://bugs.python.org/issue19610

   (19) https://bugs.python.org/issue32071

   (20) https://bugs.python.org/issue10049

   (21) https://bugs.python.org/issue28684

   (22) https://bugs.python.org/issue32110

   (23) https://bugs.python.org/issue27535

   (24) https://bugs.python.org/issue32088

   (25) https://bugs.python.org/issue1647489

   (26) https://bugs.python.org/issue25054

   (27) https://bugs.python.org/issue32072

   (28) https://bugs.python.org/issue32069

   (29) https://bugs.python.org/issue32066

   (30) https://bugs.python.org/issue32046

   (31) https://bugs.python.org/issue32018

   (32) https://www.python.org/dev/peps/pep-0008

   (33) https://bugs.python.org/issue32025

   (34) https://bugs.python.org/issue32037

   (35) https://bugs.python.org/issue32034

   (36) https://bugs.python.org/issue32015

   (37) https://bugs.python.org/issue32011

   (38) https://bugs.python.org/issue28369

   (39) https://bugs.python.org/issue31976

   (40) https://bugs.python.org/issue31985

   (41) https://bugs.python.org/issue21862

   (42) https://bugs.python.org/issue31970

   (43) https://bugs.python.org/issue31843

   (44) https://bugs.python.org/issue31945

   (45) https://bugs.python.org/issue31943

   (46) https://bugs.python.org/issue9678

   (47) https://bugs.python.org/issue30057

   (48) https://bugs.python.org/issue31933

   (49) https://bugs.python.org/issue21423

   (50) https://bugs.python.org/issue31927

   (51) https://bugs.python.org/issue27666

   (52) https://bugs.python.org/issue31917

   (53) https://bugs.python.org/issue31897

   (54) https://bugs.python.org/issue25720

   (55) https://bugs.python.org/issue31893

   (56) https://bugs.python.org/issue31891

   (57) https://bugs.python.org/issue31884

   (58) https://bugs.python.org/issue28281

   (59) https://bugs.python.org/issue31702

   (60) https://bugs.python.org/issue30639

   (61) https://bugs.python.org/issue30768

   (62) https://www.python.org/dev/peps/pep-0475

   (63) https://bugs.python.org/issue31854

   (64) https://bugs.python.org/issue31834

   (65) https://bugs.python.org/issue28292

   (66) https://bugs.python.org/issue28564

   (67) https://bugs.python.org/issue28416

   (68) https://bugs.python.org/issue31653

   (69) https://bugs.python.org/issue28326

   (70) https://bugs.python.org/issue20825

   (71) https://bugs.python.org/issue31827

   (72) https://bugs.python.org/issue31756

   (73) https://bugs.python.org/issue31819

   (74) https://bugs.python.org/issue31457

   (75) https://bugs.python.org/issue31457

   (76) https://bugs.python.org/issue31806

   (77) https://bugs.python.org/issue31803

   (78) https://bugs.python.org/issue31800

   (79) https://bugs.python.org/issue28603

   (80) https://bugs.python.org/issue30541

   (81) https://bugs.python.org/issue31784

   (82) https://www.python.org/dev/peps/pep-0564

   (83) https://bugs.python.org/issue30143

   (84) https://bugs.python.org/issue31770

   (85) https://bugs.python.org/issue31764

   (86) https://bugs.python.org/issue31752

   (87) https://bugs.python.org/issue31620

   (88) https://bugs.python.org/issue31690

   (89) https://bugs.python.org/issue30349

   (90) https://bugs.python.org/issue31664

   (91) https://bugs.python.org/issue31632

   (92) https://bugs.python.org/issue15037

   (93) https://bugs.python.org/issue31307

   (94) https://bugs.python.org/issue31334

   (95) https://bugs.python.org/issue31310

   (96) https://bugs.python.org/issue31308

   (97) https://bugs.python.org/issue31245

   (98) https://bugs.python.org/issue30553


File: python.info,  Node: Documentation<20>,  Next: Tests<19>,  Prev: Library<21>,  Up: Python 3 7 0 alpha 3

1.18.21.3 Documentation
.......................

   - bpo-32105(1): Added asyncio.BaseEventLoop.connect_accepted_socket
     versionadded marker.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32105


File: python.info,  Node: Tests<19>,  Next: Build<16>,  Prev: Documentation<20>,  Up: Python 3 7 0 alpha 3

1.18.21.4 Tests
...............

   - bpo-31380(1): Skip test_httpservers test_undecodable_file on macOS:
     fails on APFS.

   - bpo-31705(2): Skip test_socket.test_sha256() on Linux kernel older
     than 4.5.  The test fails with ENOKEY on kernel 3.10 (on ppc64le).
     A fix was merged into the kernel 4.5.

   - bpo-32138(3): Skip on Android test_faulthandler tests that raise
     SIGSEGV and remove the test.support.requires_android_level
     decorator.

   - bpo-32136(4): The runtime embedding tests have been split out from
     ‘Lib/test/test_capi.py’ into a new ‘Lib/test/test_embed.py’ file.

   - bpo-28668(5): test.support.requires_multiprocessing_queue is
     removed.  Skip tests with
     test.support.import_module(‘multiprocessing.synchronize’) instead
     when the semaphore implementation is broken or missing.

   - bpo-32126(6): Skip test_get_event_loop_new_process in
     test.test_asyncio.test_events when sem_open() is not functional.

   - bpo-31174(7): Fix test_tools.test_unparse: DirectoryTestCase now
     stores the names sample to always test the same files.  It prevents
     false alarms when hunting reference leaks.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31380

   (2) https://bugs.python.org/issue31705

   (3) https://bugs.python.org/issue32138

   (4) https://bugs.python.org/issue32136

   (5) https://bugs.python.org/issue28668

   (6) https://bugs.python.org/issue32126

   (7) https://bugs.python.org/issue31174


File: python.info,  Node: Build<16>,  Next: Windows<19>,  Prev: Tests<19>,  Up: Python 3 7 0 alpha 3

1.18.21.5 Build
...............

   - bpo-28538(1): Revert the previous changes, the if_nameindex
     structure is defined by Unified Headers.

   - bpo-28762(2): Revert the last commit, the F_LOCK macro is defined
     by Android Unified Headers.

   - bpo-29040(3): Support building Android with Unified Headers.  The
     first NDK release to support Unified Headers is android-ndk-r14.

   - bpo-32059(4): ‘detect_modules()’ in ‘setup.py’ now also searches
     the sysroot paths when cross-compiling.

   - bpo-31957(5): Fixes Windows SDK version detection when building for
     Windows.

   - bpo-31609(6): Fixes quotes in PCbuild/clean.bat

   - bpo-31934(7): Abort the build when building out of a not clean
     source tree.

   - bpo-31926(8): Fixed Argument Clinic sometimes causing compilation
     errors when there was more than one function and/or method in a .c
     file with the same name.

   - bpo-28791(9): Update Windows builds to use SQLite 3.21.0.

   - bpo-28791(10): Update OS X installer to use SQLite 3.21.0.

   - bpo-28643(11): Record profile-opt build progress with stamp files.

   - bpo-31866(12): Finish removing support for AtheOS.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28538

   (2) https://bugs.python.org/issue28762

   (3) https://bugs.python.org/issue29040

   (4) https://bugs.python.org/issue32059

   (5) https://bugs.python.org/issue31957

   (6) https://bugs.python.org/issue31609

   (7) https://bugs.python.org/issue31934

   (8) https://bugs.python.org/issue31926

   (9) https://bugs.python.org/issue28791

   (10) https://bugs.python.org/issue28791

   (11) https://bugs.python.org/issue28643

   (12) https://bugs.python.org/issue31866


File: python.info,  Node: Windows<19>,  Next: macOS<14>,  Prev: Build<16>,  Up: Python 3 7 0 alpha 3

1.18.21.6 Windows
.................

   - bpo-1102(1): Return ‘None’ when ‘View.Fetch()’ returns
     ‘ERROR_NO_MORE_ITEMS’ instead of raising ‘MSIError’.  Initial patch
     by Anthony Tuininga.

   - bpo-31944(2): Fixes Modify button in Apps and Features dialog.

   - bpo-20486(3): Implement the ‘Database.Close()’ method to help
     closing MSI database objects.

   - bpo-31857(4): Make the behavior of USE_STACKCHECK deterministic in
     a multi-threaded environment.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1102

   (2) https://bugs.python.org/issue31944

   (3) https://bugs.python.org/issue20486

   (4) https://bugs.python.org/issue31857


File: python.info,  Node: macOS<14>,  Next: IDLE<20>,  Prev: Windows<19>,  Up: Python 3 7 0 alpha 3

1.18.21.7 macOS
...............

   - bpo-31392(1): Update macOS installer to use OpenSSL 1.0.2m

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31392


File: python.info,  Node: IDLE<20>,  Next: Tools/Demos<13>,  Prev: macOS<14>,  Up: Python 3 7 0 alpha 3

1.18.21.8 IDLE
..............

   - bpo-32207(1): Improve tk event exception tracebacks in IDLE. When
     tk event handling is driven by IDLE’s run loop, a confusing and
     distracting queue.EMPTY traceback context is no longer added to tk
     event exception tracebacks.  The traceback is now the same as when
     event handling is driven by user code.  Patch based on a suggestion
     by Serhiy Storchaka.

   - bpo-32164(2): Delete unused file idlelib/tabbedpages.py.  Use of
     TabbedPageSet in configdialog was replaced by ttk.Notebook.

   - bpo-32100(3): IDLE: Fix old and new bugs in pathbrowser; improve
     tests.  Patch mostly by Cheryl Sabella.

   - bpo-31858(4): IDLE – Restrict shell prompt manipulation to the
     shell.  Editor and output windows only see an empty last prompt
     line.  This simplifies the code and fixes a minor bug when newline
     is inserted.  Sys.ps1, if present, is read on Shell start-up, but
     is not set or changed.

   - bpo-31860(5): The font sample in the IDLE configuration dialog is
     now editable.  Changes persist while IDLE remains open

   - bpo-31836(6): Test_code_module now passes if run after test_idle,
     which sets ps1.  The code module uses sys.ps1 if present or sets it
     to ‘>>> ‘ if not.  Test_code_module now properly tests both
     behaviors.  Ditto for ps2.

   - bpo-28603(7): Fix a TypeError that caused a shell restart when
     printing a traceback that includes an exception that is unhashable.
     Patch by Zane Bitter.

   - bpo-13802(8): Use non-Latin characters in the IDLE’s Font settings
     sample.  Even if one selects a font that defines a limited subset
     of the unicode Basic Multilingual Plane, tcl/tk will use other
     fonts that define a character.  The expanded example give users of
     non-Latin characters a better idea of what they might see in IDLE’s
     shell and editors.  To make room for the expanded sample, frames on
     the Font tab are re-arranged.  The Font/Tabs help explains a bit
     about the additions.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32207

   (2) https://bugs.python.org/issue32164

   (3) https://bugs.python.org/issue32100

   (4) https://bugs.python.org/issue31858

   (5) https://bugs.python.org/issue31860

   (6) https://bugs.python.org/issue31836

   (7) https://bugs.python.org/issue28603

   (8) https://bugs.python.org/issue13802


File: python.info,  Node: Tools/Demos<13>,  Next: C API<14>,  Prev: IDLE<20>,  Up: Python 3 7 0 alpha 3

1.18.21.9 Tools/Demos
.....................

   - bpo-32159(1): Remove CVS and Subversion tools: remove svneol.py and
     treesync.py scripts.  CPython migrated from CVS to Subversion, to
     Mercurial, and then to Git.  CVS and Subversion are no longer used
     to develop CPython.

   - bpo-30722(2): Make redemo work with Python 3.6 and newer versions.
     Also, remove the ‘LOCALE’ option since it doesn’t work with string
     patterns in Python 3.  Patch by Christoph Sarnowski.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32159

   (2) https://bugs.python.org/issue30722


File: python.info,  Node: C API<14>,  Prev: Tools/Demos<13>,  Up: Python 3 7 0 alpha 3

1.18.21.10 C API
................

   - bpo-20891(1): Fix PyGILState_Ensure().  When PyGILState_Ensure() is
     called in a non-Python thread before PyEval_InitThreads(), only
     call PyEval_InitThreads() after calling PyThreadState_New() to fix
     a crash.

   - bpo-32125(2): The ‘Py_UseClassExceptionsFlag’ flag has been
     removed.  It was deprecated and wasn’t used anymore since Python
     2.0.

   - bpo-25612(3): Move the current exception state from the frame
     object to the co-routine.  This simplifies the interpreter and
     fixes a couple of obscure bugs caused by having swap exception
     state when entering or exiting a generator.

   - bpo-23699(4): Add Py_RETURN_RICHCOMPARE macro to reduce boilerplate
     code in rich comparison functions.

   - bpo-30697(5): The ‘PyExc_RecursionErrorInst’ singleton is removed
     and ‘PyErr_NormalizeException()’ does not use it anymore.  This
     singleton is persistent and its members being never cleared may
     cause a segfault during finalization of the interpreter.  See also
     bpo-22898(6).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20891

   (2) https://bugs.python.org/issue32125

   (3) https://bugs.python.org/issue25612

   (4) https://bugs.python.org/issue23699

   (5) https://bugs.python.org/issue30697

   (6) https://bugs.python.org/issue22898


File: python.info,  Node: Python 3 7 0 alpha 2,  Next: Python 3 7 0 alpha 1,  Prev: Python 3 7 0 alpha 3,  Up: Changelog

1.18.22 Python 3.7.0 alpha 2
----------------------------

`Release date: 2017-10-16'

* Menu:

* Core and Builtins: Core and Builtins<21>.
* Library: Library<22>.
* Documentation: Documentation<21>.
* Build: Build<17>.
* IDLE: IDLE<21>.
* C API: C API<15>.


File: python.info,  Node: Core and Builtins<21>,  Next: Library<22>,  Up: Python 3 7 0 alpha 2

1.18.22.1 Core and Builtins
...........................

   - bpo-31558(1): ‘gc.freeze()’ is a new API that allows for moving all
     objects currently tracked by the garbage collector to a permanent
     generation, effectively removing them from future collection
     events.  This can be used to protect those objects from having
     their PyGC_Head mutated.  In effect, this enables great
     copy-on-write stability at fork().

   - bpo-31642(2): Restored blocking “from package import module” by
     setting sys.modules[“package.module”] to None.

   - bpo-31708(3): Allow use of asynchronous generator expressions in
     synchronous functions.

   - bpo-31709(4): Drop support of asynchronous __aiter__.

   - bpo-30404(5): The -u option now makes the stdout and stderr streams
     unbuffered rather than line-buffered.

   - bpo-31619(6): Fixed a ValueError when convert a string with large
     number of underscores to integer with binary base.

   - bpo-31602(7): Fix an assertion failure in
     ‘zipimporter.get_source()’ in case of a bad *note
     zlib.decompress(): 5b4.  Patch by Oren Milman.

   - bpo-31592(8): Fixed an assertion failure in Python parser in case
     of a bad *note unicodedata.normalize(): fe8.  Patch by Oren Milman.

   - bpo-31588(9): Raise a *note TypeError: 192. with a helpful error
     message when class creation fails due to a metaclass with a bad
     ‘__prepare__()’ method.  Patch by Oren Milman.

   - bpo-31574(10): Importlib was instrumented with two dtrace probes to
     profile import timing.

   - bpo-31566(11): Fix an assertion failure in ‘_warnings.warn()’ in
     case of a bad ‘__name__’ global.  Patch by Oren Milman.

   - bpo-31506(12): Improved the error message logic for object.__new__
     and object.__init__.

   - bpo-31505(13): Fix an assertion failure in *note json: a4, in case
     ‘_json.make_encoder()’ received a bad ‘encoder()’ argument.  Patch
     by Oren Milman.

   - bpo-31492(14): Fix assertion failures in case of failing to import
     from a module with a bad ‘__name__’ attribute, and in case of
     failing to access an attribute of such a module.  Patch by Oren
     Milman.

   - bpo-31478(15): Fix an assertion failure in ‘_random.Random.seed()’
     in case the argument has a bad ‘__abs__()’ method.  Patch by Oren
     Milman.

   - bpo-31336(16): Speed up class creation by 10-20% by reducing the
     overhead in the necessary special method lookups.  Patch by Stefan
     Behnel.

   - bpo-31415(17): Add ‘-X importtime’ option to show how long each
     import takes.  It can be used to optimize application’s startup
     time.  Support the *note PYTHONPROFILEIMPORTTIME: 32d. as an
     equivalent way to enable this.

   - bpo-31410(18): Optimized calling wrapper and classmethod
     descriptors.

   - bpo-31353(19): PEP 553(20) - Add a new built-in called
     ‘breakpoint()’ which calls ‘sys.breakpointhook()’.  By default this
     imports ‘pdb’ and calls ‘pdb.set_trace()’, but users may override
     ‘sys.breakpointhook()’ to call whatever debugger they want.  The
     original value of the hook is saved in ‘sys.__breakpointhook__’.

   - bpo-17852(21): Maintain a list of open buffered files, flush them
     before exiting the interpreter.  Based on a patch from Armin Rigo.

   - bpo-31315(22): Fix an assertion failure in imp.create_dynamic(),
     when spec.name is not a string.  Patch by Oren Milman.

   - bpo-31311(23): Fix a crash in the ‘__setstate__()’ method of *note
     ctypes._CData: fe9, in case of a bad ‘__dict__’.  Patch by Oren
     Milman.

   - bpo-31293(24): Fix crashes in true division and multiplication of a
     timedelta object by a float with a bad as_integer_ratio() method.
     Patch by Oren Milman.

   - bpo-31285(25): Fix an assertion failure in *note
     warnings.warn_explicit: 5a5, when the return value of the received
     loader’s get_source() has a bad splitlines() method.  Patch by Oren
     Milman.

   - bpo-30406(26): Make ‘async’ and ‘await’ proper keywords, as
     specified in PEP 492(27).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31558

   (2) https://bugs.python.org/issue31642

   (3) https://bugs.python.org/issue31708

   (4) https://bugs.python.org/issue31709

   (5) https://bugs.python.org/issue30404

   (6) https://bugs.python.org/issue31619

   (7) https://bugs.python.org/issue31602

   (8) https://bugs.python.org/issue31592

   (9) https://bugs.python.org/issue31588

   (10) https://bugs.python.org/issue31574

   (11) https://bugs.python.org/issue31566

   (12) https://bugs.python.org/issue31506

   (13) https://bugs.python.org/issue31505

   (14) https://bugs.python.org/issue31492

   (15) https://bugs.python.org/issue31478

   (16) https://bugs.python.org/issue31336

   (17) https://bugs.python.org/issue31415

   (18) https://bugs.python.org/issue31410

   (19) https://bugs.python.org/issue31353

   (20) https://www.python.org/dev/peps/pep-0553

   (21) https://bugs.python.org/issue17852

   (22) https://bugs.python.org/issue31315

   (23) https://bugs.python.org/issue31311

   (24) https://bugs.python.org/issue31293

   (25) https://bugs.python.org/issue31285

   (26) https://bugs.python.org/issue30406

   (27) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: Library<22>,  Next: Documentation<21>,  Prev: Core and Builtins<21>,  Up: Python 3 7 0 alpha 2

1.18.22.2 Library
.................

   - bpo-30058(1): Fixed buffer overflow in select.kqueue.control().

   - bpo-31672(2): ‘idpattern’ in ‘string.Template’ matched some
     non-ASCII characters.  Now it uses ‘-i’ regular expression local
     flag to avoid non-ASCII characters.

   - bpo-31701(3): On Windows, faulthandler.enable() now ignores MSC and
     COM exceptions.

   - bpo-31728(4): Prevent crashes in ‘_elementtree’ due to unsafe
     cleanup of ‘Element.text’ and ‘Element.tail’.  Patch by Oren
     Milman.

   - bpo-31671(5): Now ‘re.compile()’ converts passed RegexFlag to
     normal int object before compiling.  bm_regex_compile benchmark
     shows 14% performance improvements.

   - bpo-30397(6): The types of compiled regular objects and match
     objects are now exposed as ‘re.Pattern’ and ‘re.Match’.  This adds
     information in pydoc output for the re module.

   - bpo-31675(7): Fixed memory leaks in Tkinter’s methods splitlist()
     and split() when pass a string larger than 2 GiB.

   - bpo-31673(8): Fixed typo in the name of Tkinter’s method
     adderrorinfo().

   - bpo-31648(9): Improvements to path predicates in ElementTree: Allow
     whitespace around predicate parts, i.e.  “[a = ‘text’]” instead of
     requiring the less readable “[a=’text’]”.  Add support for text
     comparison of the current node, like “[.=’text’]”.  Patch by Stefan
     Behnel.

   - bpo-30806(10): Fix the string representation of a netrc object.

   - bpo-31638(11): Add optional argument ‘compressed’ to
     ‘zipapp.create_archive’, and add option ‘--compress’ to the command
     line interface of ‘zipapp’.

   - bpo-25351(12): Avoid venv activate failures with undefined
     variables

   - bpo-20519(13): Avoid ctypes use (if possible) and improve import
     time for uuid.

   - bpo-28293(14): The regular expression cache is no longer completely
     dumped when it is full.

   - bpo-31596(15): Added pthread_getcpuclockid() to the time module

   - bpo-27494(16): Make 2to3 accept a trailing comma in generator
     expressions.  For example, ‘set(x for x in [],)’ is now allowed.

   - bpo-30347(17): Stop crashes when concurrently iterate over
     itertools.groupby() iterators.

   - bpo-30346(18): An iterator produced by itertools.groupby() iterator
     now becomes exhausted after advancing the groupby iterator.

   - bpo-31556(19): Cancel asyncio.wait_for future faster if timeout <=
     0

   - bpo-31540(20): Allow passing a context object in *note
     concurrent.futures.ProcessPoolExecutor: 2a2. constructor.  Also,
     free job resources in *note concurrent.futures.ProcessPoolExecutor:
     2a2. earlier to improve memory usage when a worker waits for new
     jobs.

   - bpo-31516(21): ‘threading.current_thread()’ should not return a
     dummy thread at shutdown.

   - bpo-31525(22): In the sqlite module, require the sqlite3_prepare_v2
     API. Thus, the sqlite module now requires sqlite version at least
     3.3.9.

   - bpo-26510(23): argparse subparsers are now required by default.
     This matches behaviour in Python 2.  For optional subparsers, use
     the new parameter ‘add_subparsers(required=False)’.  Patch by
     Anthony Sottile.  (As of 3.7.0rc1, the default was changed to not
     required as had been the case since Python 3.3.)

   - bpo-27541(24): Reprs of subclasses of some collection and iterator
     classes (*note bytearray: 327, *note array.array: 446, *note
     collections.deque: 526, *note collections.defaultdict: b2d, *note
     itertools.count: c0e, *note itertools.repeat: feb.) now contain
     actual type name insteads of hardcoded name of the base class.

   - bpo-31351(25): python -m ensurepip now exits with non-zero exit
     code if pip bootstrapping has failed.

   - bpo-31389(26): ‘pdb.set_trace()’ now takes an optional keyword-only
     argument ‘header’.  If given, this is printed to the console just
     before debugging begins.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30058

   (2) https://bugs.python.org/issue31672

   (3) https://bugs.python.org/issue31701

   (4) https://bugs.python.org/issue31728

   (5) https://bugs.python.org/issue31671

   (6) https://bugs.python.org/issue30397

   (7) https://bugs.python.org/issue31675

   (8) https://bugs.python.org/issue31673

   (9) https://bugs.python.org/issue31648

   (10) https://bugs.python.org/issue30806

   (11) https://bugs.python.org/issue31638

   (12) https://bugs.python.org/issue25351

   (13) https://bugs.python.org/issue20519

   (14) https://bugs.python.org/issue28293

   (15) https://bugs.python.org/issue31596

   (16) https://bugs.python.org/issue27494

   (17) https://bugs.python.org/issue30347

   (18) https://bugs.python.org/issue30346

   (19) https://bugs.python.org/issue31556

   (20) https://bugs.python.org/issue31540

   (21) https://bugs.python.org/issue31516

   (22) https://bugs.python.org/issue31525

   (23) https://bugs.python.org/issue26510

   (24) https://bugs.python.org/issue27541

   (25) https://bugs.python.org/issue31351

   (26) https://bugs.python.org/issue31389


File: python.info,  Node: Documentation<21>,  Next: Build<17>,  Prev: Library<22>,  Up: Python 3 7 0 alpha 2

1.18.22.3 Documentation
.......................

   - bpo-31537(1): Fix incorrect usage of ‘get_history_length’ in
     readline documentation example code.  Patch by Brad Smith.

   - bpo-30085(2): The operator functions without double underscores are
     preferred for clarity.  The one with underscores are only kept for
     back-compatibility.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31537

   (2) https://bugs.python.org/issue30085


File: python.info,  Node: Build<17>,  Next: IDLE<21>,  Prev: Documentation<21>,  Up: Python 3 7 0 alpha 2

1.18.22.4 Build
...............

   - bpo-31696(1): Improve compiler version information in *note
     sys.version: 5c8. when Python is built with Clang.

   - bpo-31625(2): Stop using ranlib on static libraries.  Instead, we
     assume ar supports the ‘s’ flag.

   - bpo-31624(3): Remove support for BSD/OS.

   - bpo-22140(4): Prevent double substitution of prefix in
     python-config.sh.

   - bpo-31569(5): Correct PCBuild/ case to PCbuild/ in build scripts
     and documentation.

   - bpo-31536(6): Avoid wholesale rebuild after ‘make regen-all’ if
     nothing changed.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31696

   (2) https://bugs.python.org/issue31625

   (3) https://bugs.python.org/issue31624

   (4) https://bugs.python.org/issue22140

   (5) https://bugs.python.org/issue31569

   (6) https://bugs.python.org/issue31536


File: python.info,  Node: IDLE<21>,  Next: C API<15>,  Prev: Build<17>,  Up: Python 3 7 0 alpha 2

1.18.22.5 IDLE
..............

   - bpo-31460(1): Simplify the API of IDLE’s Module Browser.  Passing a
     widget instead of an flist with a root widget opens the option of
     creating a browser frame that is only part of a window.  Passing a
     full file name instead of pieces assumed to come from a .py file
     opens the possibility of browsing python files that do not end in
     .py.

   - bpo-31649(2): IDLE - Make _htest, _utest parameters keyword only.

   - bpo-31559(3): Remove test order dependence in
     idle_test.test_browser.

   - bpo-31459(4): Rename IDLE’s module browser from Class Browser to
     Module Browser.  The original module-level class and method browser
     became a module browser, with the addition of module-level
     functions, years ago.  Nested classes and functions were added
     yesterday.  For back-compatibility, the virtual event
     <<open-class-browser>>, which appears on the Keys tab of the
     Settings dialog, is not changed.  Patch by Cheryl Sabella.

   - bpo-31500(5): Default fonts now are scaled on HiDPI displays.

   - bpo-1612262(6): IDLE module browser now shows nested classes and
     functions.  Original patches for code and tests by Guilherme Polo
     and Cheryl Sabella, respectively.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31460

   (2) https://bugs.python.org/issue31649

   (3) https://bugs.python.org/issue31559

   (4) https://bugs.python.org/issue31459

   (5) https://bugs.python.org/issue31500

   (6) https://bugs.python.org/issue1612262


File: python.info,  Node: C API<15>,  Prev: IDLE<21>,  Up: Python 3 7 0 alpha 2

1.18.22.6 C API
...............

   - bpo-28280(1): Make ‘PyMapping_Keys()’, ‘PyMapping_Values()’ and
     ‘PyMapping_Items()’ always return a *note list: 260. (rather than a
     *note list: 260. or a *note tuple: 473.).  Patch by Oren Milman.

   - bpo-31532(2): Fix memory corruption due to allocator mix in
     getpath.c between Py_GetPath() and Py_SetPath()

   - bpo-25658(3): Implement PEP 539(4) for Thread Specific Storage
     (TSS) API: it is a new Thread Local Storage (TLS) API to CPython
     which would supersede use of the existing TLS API within the
     CPython interpreter, while deprecating the existing API. PEP
     written by Erik M. Bray, patch by Masayuki Yamamoto.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28280

   (2) https://bugs.python.org/issue31532

   (3) https://bugs.python.org/issue25658

   (4) https://www.python.org/dev/peps/pep-0539


File: python.info,  Node: Python 3 7 0 alpha 1,  Next: Python 3 6 6 final,  Prev: Python 3 7 0 alpha 2,  Up: Changelog

1.18.23 Python 3.7.0 alpha 1
----------------------------

`Release date: 2017-09-19'

* Menu:

* Security: Security<12>.
* Core and Builtins: Core and Builtins<22>.
* Library: Library<23>.
* Documentation: Documentation<22>.
* Tests: Tests<20>.
* Build: Build<18>.
* Windows: Windows<20>.
* IDLE: IDLE<22>.
* Tools/Demos: Tools/Demos<14>.
* C API: C API<16>.


File: python.info,  Node: Security<12>,  Next: Core and Builtins<22>,  Up: Python 3 7 0 alpha 1

1.18.23.1 Security
..................

   - bpo-29781(1): SSLObject.version() now correctly returns None when
     handshake over BIO has not been performed yet.

   - bpo-29505(2): Add fuzz tests for float(str), int(str),
     unicode(str); for oss-fuzz.

   - bpo-30947(3): Upgrade libexpat embedded copy from version 2.2.1 to
     2.2.3 to get security fixes.

   - bpo-30730(4): Prevent environment variables injection in subprocess
     on Windows.  Prevent passing other environment variables and
     command arguments.

   - bpo-30694(5): Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes
     of multiple security vulnerabilities including: CVE-2017-9233
     (External entity infinite loop DoS), CVE-2016-9063 (Integer
     overflow, re-fix), CVE-2016-0718 (Fix regression bugs from 2.2.0’s
     fix to CVE-2016-0718) and CVE-2012-0876 (Counter hash flooding with
     SipHash).  Note: the CVE-2016-5300 (Use os-specific entropy sources
     like getrandom) doesn’t impact Python, since Python already gets
     entropy from the OS to set the expat secret using
     ‘XML_SetHashSalt()’.

   - bpo-30500(6): Fix urllib.parse.splithost() to correctly parse
     fragments.  For example, ‘splithost('//127.0.0.1#@evil.com/')’ now
     correctly returns the ‘127.0.0.1’ host, instead of treating
     ‘@evil.com’ as the host in an authentication (‘login@host’).

   - bpo-29591(7): Update expat copy from 2.1.1 to 2.2.0 to get fixes of
     CVE-2016-0718 and CVE-2016-4472.  See
     ‘https://sourceforge.net/p/expat/bugs/537/’ for more information.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29781

   (2) https://bugs.python.org/issue29505

   (3) https://bugs.python.org/issue30947

   (4) https://bugs.python.org/issue30730

   (5) https://bugs.python.org/issue30694

   (6) https://bugs.python.org/issue30500

   (7) https://bugs.python.org/issue29591


File: python.info,  Node: Core and Builtins<22>,  Next: Library<23>,  Prev: Security<12>,  Up: Python 3 7 0 alpha 1

1.18.23.2 Core and Builtins
...........................

   - bpo-31490(1): Fix an assertion failure in *note ctypes: 2b. class
     definition, in case the class has an attribute whose name is
     specified in ‘_anonymous_’ but not in ‘_fields_’.  Patch by Oren
     Milman.

   - bpo-31471(2): Fix an assertion failure in *note subprocess.Popen():
     2b7. on Windows, in case the env argument has a bad keys() method.
     Patch by Oren Milman.

   - bpo-31418(3): Fix an assertion failure in ‘PyErr_WriteUnraisable()’
     in case of an exception with a bad ‘__module__’ attribute.  Patch
     by Oren Milman.

   - bpo-31416(4): Fix assertion failures in case of a bad
     warnings.filters or warnings.defaultaction.  Patch by Oren Milman.

   - bpo-28411(5): Change direct usage of PyInterpreterState.modules to
     PyImport_GetModuleDict().  Also introduce more uniformity in other
     code that deals with sys.modules.  This helps reduce complications
     when working on sys.modules.

   - bpo-28411(6): Switch to the abstract API when dealing with
     ‘PyInterpreterState.modules’.  This allows later support for all
     dict subclasses and other Mapping implementations.  Also add a
     ‘PyImport_GetModule()’ function to reduce a bunch of duplicated
     code.

   - bpo-31411(7): Raise a TypeError instead of SystemError in case
     warnings.onceregistry is not a dictionary.  Patch by Oren Milman.

   - bpo-31344(8): For finer control of tracing behaviour when testing
     the interpreter, two new frame attributes have been added to
     control the emission of particular trace events: ‘f_trace_lines’
     (‘True’ by default) to turn off per-line trace events; and
     ‘f_trace_opcodes’ (‘False’ by default) to turn on per-opcode trace
     events.

   - bpo-31373(9): Fix several possible instances of undefined behavior
     due to floating-point demotions.

   - bpo-30465(10): Location information (‘lineno’ and ‘col_offset’) in
     f-strings is now (mostly) correct.  This fixes tools like flake8
     from showing warnings on the wrong line (typically the first line
     of the file).

   - bpo-30860(11): Consolidate CPython’s global runtime state under a
     single struct.  This improves discoverability of the runtime state.

   - bpo-31347(12): Fix possible undefined behavior in
     _PyObject_FastCall_Prepend.

   - bpo-31343(13): Include sys/sysmacros.h for major(), minor(), and
     makedev().  GNU C libray plans to remove the functions from
     sys/types.h.

   - bpo-31291(14): Fix an assertion failure in *note
     zipimport.zipimporter.get_data: ff3. on Windows, when the return
     value of ‘pathname.replace('/','\\')’ isn’t a string.  Patch by
     Oren Milman.

   - bpo-31271(15): Fix an assertion failure in the write() method of
     *note io.TextIOWrapper: 5e8, when the encoder doesn’t return a
     bytes object.  Patch by Oren Milman.

   - bpo-31243(16): Fix a crash in some methods of *note
     io.TextIOWrapper: 5e8, when the decoder’s state is invalid.  Patch
     by Oren Milman.

   - bpo-30721(17): ‘print’ now shows correct usage hint for using
     Python 2 redirection syntax.  Patch by Sanyam Khurana.

   - bpo-31070(18): Fix a race condition in importlib
     _get_module_lock().

   - bpo-30747(19): Add a non-dummy implementation of _Py_atomic_store
     and _Py_atomic_load on MSVC.

   - bpo-31095(20): Fix potential crash during GC caused by ‘tp_dealloc’
     which doesn’t call ‘PyObject_GC_UnTrack()’.

   - bpo-31071(21): Avoid masking original TypeError in call with *
     unpacking when other arguments are passed.

   - bpo-30978(22): str.format_map() now passes key lookup exceptions
     through.  Previously any exception was replaced with a KeyError
     exception.

   - bpo-30808(23): Use _Py_atomic API for concurrency-sensitive signal
     state.

   - bpo-30876(24): Relative import from unloaded package now reimports
     the package instead of failing with SystemError.  Relative import
     from non-package now fails with ImportError rather than
     SystemError.

   - bpo-30703(25): Improve signal delivery.  Avoid using
     Py_AddPendingCall from signal handler, to avoid calling
     signal-unsafe functions.  The tests I’m adding here fail without
     the rest of the patch, on Linux and OS X. This means our signal
     delivery logic had defects (some signals could be lost).

   - bpo-30765(26): Avoid blocking in pthread_mutex_lock() when
     PyThread_acquire_lock() is asked not to block.

   - bpo-31161(27): Make sure the ‘Missing parentheses’ syntax error
     message is only applied to SyntaxError, not to subclasses.  Patch
     by Martijn Pieters.

   - bpo-30814(28): Fixed a race condition when import a submodule from
     a package.

   - bpo-30736(29): The internal unicodedata database has been upgraded
     to Unicode 10.0.

   - bpo-30604(30): Move co_extra_freefuncs from per-thread to
     per-interpreter to avoid crashes.

   - bpo-30597(31): ‘print’ now shows expected input in custom error
     message when used as a Python 2 statement.  Patch by Sanyam
     Khurana.

   - bpo-30682(32): Removed a too-strict assertion that failed for
     certain f-strings, such as eval(“f’\n’”) and eval(“f’\r’”).

   - bpo-30501(33): The compiler now produces more optimal code for
     complex condition expressions in the “if”, “while” and “assert”
     statement, the “if” expression, and generator expressions and
     comprehensions.

   - bpo-28180(34): Implement PEP 538(35) (legacy C locale coercion).
     This means that when a suitable coercion target locale is
     available, both the core interpreter and locale-aware C extensions
     will assume the use of UTF-8 as the default text encoding, rather
     than ASCII.

   - bpo-30486(36): Allows setting cell values for __closure__.  Patch
     by Lisa Roach.

   - bpo-30537(37): itertools.islice now accepts integer-like objects
     (having an __index__ method) as start, stop, and slice arguments

   - bpo-25324(38): Tokens needed for parsing in Python moved to C.
     ‘COMMENT’, ‘NL’ and ‘ENCODING’.  This way the tokens and tok_names
     in the token module don’t get changed when you import the tokenize
     module.

   - bpo-29104(39): Fixed parsing backslashes in f-strings.

   - bpo-27945(40): Fixed various segfaults with dict when input
     collections are mutated during searching, inserting or comparing.
     Based on patches by Duane Griffin and Tim Mitchell.

   - bpo-25794(41): Fixed type.__setattr__() and type.__delattr__() for
     non-interned attribute names.  Based on patch by Eryk Sun.

   - bpo-30039(42): If a KeyboardInterrupt happens when the interpreter
     is in the middle of resuming a chain of nested ‘yield from’ or
     ‘await’ calls, it’s now correctly delivered to the innermost frame.

   - bpo-28974(43): ‘object.__format__(x, '')’ is now equivalent to
     ‘str(x)’ rather than ‘format(str(self), '')’.

   - bpo-30024(44): Circular imports involving absolute imports with
     binding a submodule to a name are now supported.

   - bpo-12414(45): sys.getsizeof() on a code object now returns the
     sizes which includes the code struct and sizes of objects which it
     references.  Patch by Dong-hee Na.

   - bpo-29839(46): len() now raises ValueError rather than
     OverflowError if __len__() returned a large negative integer.

   - bpo-11913(47): README.rst is now included in the list of distutils
     standard READMEs and therefore included in source distributions.

   - bpo-29914(48): Fixed default implementations of __reduce__ and
     __reduce_ex__().  object.__reduce__() no longer takes arguments,
     object.__reduce_ex__() now requires one argument.

   - bpo-29949(49): Fix memory usage regression of set and frozenset
     object.

   - bpo-29935(50): Fixed error messages in the index() method of tuple,
     list and deque when pass indices of wrong type.

   - bpo-29816(51): Shift operation now has less opportunity to raise
     OverflowError.  ValueError always is raised rather than
     OverflowError for negative counts.  Shifting zero with non-negative
     count always returns zero.

   - bpo-24821(52): Fixed the slowing down to 25 times in the searching
     of some unlucky Unicode characters.

   - bpo-29102(53): Add a unique ID to PyInterpreterState.  This makes
     it easier to identify each subinterpreter.

   - bpo-29894(54): The deprecation warning is emitted if __complex__
     returns an instance of a strict subclass of complex.  In a future
     versions of Python this can be an error.

   - bpo-29859(55): Show correct error messages when any of the
     pthread_* calls in thread_pthread.h fails.

   - bpo-29849(56): Fix a memory leak when an ImportError is raised
     during from import.

   - bpo-28856(57): Fix an oversight that %b format for bytes should
     support objects follow the buffer protocol.

   - bpo-29723(58): The ‘sys.path[0]’ initialization change for
     bpo-29139(59) caused a regression by revealing an inconsistency in
     how sys.path is initialized when executing ‘__main__’ from a
     zipfile, directory, or other import location.  The interpreter now
     consistently avoids ever adding the import location’s parent
     directory to ‘sys.path’, and ensures no other ‘sys.path’ entries
     are inadvertently modified when inserting the import location named
     on the command line.

   - bpo-29568(60): Escaped percent “%%” in the format string for
     classic string formatting no longer allows any characters between
     two percents.

   - bpo-29714(61): Fix a regression that bytes format may fail when
     containing zero bytes inside.

   - bpo-29695(62): bool(), float(), list() and tuple() no longer take
     keyword arguments.  The first argument of int() can now be passes
     only as positional argument.

   - bpo-28893(63): Set correct __cause__ for errors about invalid
     awaitables returned from __aiter__ and __anext__.

   - bpo-28876(64): ‘bool(range)’ works even if ‘len(range)’ raises
     *note OverflowError: 954.

   - bpo-29683(65): Fixes to memory allocation in _PyCode_SetExtra.
     Patch by Brian Coleman.

   - bpo-29684(66): Fix minor regression of
     PyEval_CallObjectWithKeywords.  It should raise TypeError when
     kwargs is not a dict.  But it might cause segv when args=NULL and
     kwargs is not a dict.

   - bpo-28598(67): Support __rmod__ for subclasses of str being called
     before str.__mod__.  Patch by Martijn Pieters.

   - bpo-29607(68): Fix stack_effect computation for CALL_FUNCTION_EX.
     Patch by Matthieu Dartiailh.

   - bpo-29602(69): Fix incorrect handling of signed zeros in complex
     constructor for complex subclasses and for inputs having a
     __complex__ method.  Patch by Serhiy Storchaka.

   - bpo-29347(70): Fixed possibly dereferencing undefined pointers when
     creating weakref objects.

   - bpo-29463(71): Add ‘docstring’ field to Module, ClassDef,
     FunctionDef, and AsyncFunctionDef ast nodes.  docstring is not
     first stmt in their body anymore.  It affects ‘co_firstlineno’ and
     ‘co_lnotab’ of code object for module and class.  (Reverted in
     bpo-32911(72).)

   - bpo-29438(73): Fixed use-after-free problem in key sharing dict.

   - bpo-29546(74): Set the ‘path’ and ‘name’ attribute on ImportError
     for ‘from ... import ...’.

   - bpo-29546(75): Improve from-import error message with location

   - bpo-29478(76): If max_line_length=None is specified while using the
     Compat32 policy, it is no longer ignored.  Patch by Mircea Cosbuc.

   - bpo-29319(77): Prevent RunMainFromImporter overwriting sys.path[0].

   - bpo-29337(78): Fixed possible BytesWarning when compare the code
     objects.  Warnings could be emitted at compile time.

   - bpo-29327(79): Fixed a crash when pass the iterable keyword
     argument to sorted().

   - bpo-29034(80): Fix memory leak and use-after-free in os module
     (path_converter).

   - bpo-29159(81): Fix regression in bytes(x) when x.__index__() raises
     Exception.

   - bpo-29049(82): Call _PyObject_GC_TRACK() lazily when calling Python
     function.  Calling function is up to 5% faster.

   - bpo-28927(83): bytes.fromhex() and bytearray.fromhex() now ignore
     all ASCII whitespace, not only spaces.  Patch by Robert Xiao.

   - bpo-28932(84): Do not include <sys/random.h> if it does not exist.

   - bpo-25677(85): Correct the positioning of the syntax error caret
     for indented blocks.  Based on patch by Michael Layzell.

   - bpo-29000(86): Fixed bytes formatting of octals with zero padding
     in alternate form.

   - bpo-18896(87): Python function can now have more than 255
     parameters.  collections.namedtuple() now supports tuples with more
     than 255 elements.

   - bpo-28596(88): The preferred encoding is UTF-8 on Android.  Patch
     written by Chi Hsuan Yen.

   - bpo-22257(89): Clean up interpreter startup (see PEP 432(90)).

   - bpo-26919(91): On Android, operating system data is now always
     encoded/decoded to/from UTF-8, instead of the locale encoding to
     avoid inconsistencies with os.fsencode() and os.fsdecode() which
     are already using UTF-8.

   - bpo-28991(92): functools.lru_cache() was susceptible to an obscure
     reentrancy bug triggerable by a monkey-patched len() function.

   - bpo-28147(93): Fix a memory leak in split-table dictionaries:
     setattr() must not convert combined table into split table.  Patch
     written by INADA Naoki.

   - bpo-28739(94): f-string expressions are no longer accepted as
     docstrings and by ast.literal_eval() even if they do not include
     expressions.

   - bpo-28512(95): Fixed setting the offset attribute of SyntaxError by
     PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

   - bpo-28918(96): Fix the cross compilation of xxlimited when Python
     has been built with Py_DEBUG defined.

   - bpo-23722(97): Rather than silently producing a class that doesn’t
     support zero-argument ‘super()’ in methods, failing to pass the new
     ‘__classcell__’ namespace entry up to ‘type.__new__’ now results in
     a ‘DeprecationWarning’ and a class that supports zero-argument
     ‘super()’.

   - bpo-28797(98): Modifying the class __dict__ inside the __set_name__
     method of a descriptor that is used inside that class no longer
     prevents calling the __set_name__ method of other descriptors.

   - bpo-28799(99): Remove the ‘PyEval_GetCallStats()’ function and
     deprecate the untested and undocumented ‘sys.callstats()’ function.
     Remove the ‘CALL_PROFILE’ special build: use the *note
     sys.setprofile(): e30. function, *note cProfile: 28. or *note
     profile: d3. to profile function calls.

   - bpo-12844(100): More than 255 arguments can now be passed to a
     function.

   - bpo-28782(101): Fix a bug in the implementation ‘yield from’ when
     checking if the next instruction is YIELD_FROM. Regression
     introduced by WORDCODE (bpo-26647(102)).

   - bpo-28774(103): Fix error position of the unicode error in ASCII
     and Latin1 encoders when a string returned by the error handler
     contains multiple non-encodable characters (non-ASCII for the ASCII
     codec, characters out of the U+0000-U+00FF range for Latin1).

   - bpo-28731(104): Optimize _PyDict_NewPresized() to create correct
     size dict.  Improve speed of dict literal with constant keys up to
     30%.

   - bpo-28532(105): Show sys.version when -V option is supplied twice.

   - bpo-27100(106): The with-statement now checks for __enter__ before
     it checks for __exit__.  This gives less confusing error messages
     when both methods are missing.  Patch by Jonathan Ellington.

   - bpo-28746(107): Fix the set_inheritable() file descriptor method on
     platforms that do not have the ioctl FIOCLEX and FIONCLEX commands.

   - bpo-26920(108): Fix not getting the locale’s charset upon
     initializing the interpreter, on platforms that do not have
     langinfo.

   - bpo-28648(109): Fixed crash in Py_DecodeLocale() in debug build on
     Mac OS X when decode astral characters.  Patch by Xiang Zhang.

   - bpo-28665(110): Improve speed of the STORE_DEREF opcode by 40%.

   - bpo-19398(111): Extra slash no longer added to sys.path components
     in case of empty compile-time PYTHONPATH components.

   - bpo-28621(112): Sped up converting int to float by reusing faster
     bits counting implementation.  Patch by Adrian Wielgosik.

   - bpo-28580(113): Optimize iterating split table values.  Patch by
     Xiang Zhang.

   - bpo-28583(114): PyDict_SetDefault didn’t combine split table when
     needed.  Patch by Xiang Zhang.

   - bpo-28128(115): Deprecation warning for invalid str and byte escape
     sequences now prints better information about where the error
     occurs.  Patch by Serhiy Storchaka and Eric Smith.

   - bpo-28509(116): dict.update() no longer allocate unnecessary large
     memory.

   - bpo-28426(117): Fixed potential crash in
     PyUnicode_AsDecodedObject() in debug build.

   - bpo-28517(118): Fixed of-by-one error in the peephole optimizer
     that caused keeping unreachable code.

   - bpo-28214(119): Improved exception reporting for problematic
     __set_name__ attributes.

   - bpo-23782(120): Fixed possible memory leak in _PyTraceback_Add()
     and exception loss in PyTraceBack_Here().

   - bpo-28183(121): Optimize and cleanup dict iteration.

   - bpo-26081(122): Added C implementation of asyncio.Future.  Original
     patch by Yury Selivanov.

   - bpo-28379(123): Added sanity checks and tests for
     PyUnicode_CopyCharacters().  Patch by Xiang Zhang.

   - bpo-28376(124): The type of long range iterator is now registered
     as Iterator.  Patch by Oren Milman.

   - bpo-28376(125): Creating instances of range_iterator by calling
     range_iterator type now is disallowed.  Calling iter() on range
     instance is the only way.  Patch by Oren Milman.

   - bpo-26906(126): Resolving special methods of uninitialized type now
     causes implicit initialization of the type instead of a fail.

   - bpo-18287(127): PyType_Ready() now checks that tp_name is not NULL.
     Original patch by Niklas Koep.

   - bpo-24098(128): Fixed possible crash when AST is changed in process
     of compiling it.

   - bpo-28201(129): Dict reduces possibility of 2nd conflict in hash
     table when hashes have same lower bits.

   - bpo-28350(130): String constants with null character no longer
     interned.

   - bpo-26617(131): Fix crash when GC runs during weakref callbacks.

   - bpo-27942(132): String constants now interned recursively in tuples
     and frozensets.

   - bpo-28289(133): ImportError.__init__ now resets not specified
     attributes.

   - bpo-21578(134): Fixed misleading error message when ImportError
     called with invalid keyword args.

   - bpo-28203(135): Fix incorrect type in complex(1.0, {2:3}) error
     message.  Patch by Soumya Sharma.

   - bpo-28086(136): Single var-positional argument of tuple subtype was
     passed unscathed to the C-defined function.  Now it is converted to
     exact tuple.

   - bpo-28214(137): Now __set_name__ is looked up on the class instead
     of the instance.

   - bpo-27955(138): Fallback on reading /dev/urandom device when the
     getrandom() syscall fails with EPERM, for example when blocked by
     SECCOMP.

   - bpo-28192(139): Don’t import readline in isolated mode.

   - bpo-27441(140): Remove some redundant assignments to ob_size in
     longobject.c.  Thanks Oren Milman.

   - bpo-27222(141): Clean up redundant code in long_rshift function.
     Thanks Oren Milman.

   - Upgrade internal unicode databases to Unicode version 9.0.0.

   - bpo-28131(142): Fix a regression in zipimport’s compile_source().
     zipimport should use the same optimization level as the
     interpreter.

   - bpo-28126(143): Replace Py_MEMCPY with memcpy().  Visual Studio can
     properly optimize memcpy().

   - bpo-28120(144): Fix dict.pop() for splitted dictionary when trying
     to remove a “pending key” (Not yet inserted in split-table).  Patch
     by Xiang Zhang.

   - bpo-26182(145): Raise DeprecationWarning when async and await
     keywords are used as variable/attribute/class/function name.

   - bpo-26182(146): Fix a refleak in code that raises
     DeprecationWarning.

   - bpo-28721(147): Fix asynchronous generators aclose() and athrow()
     to handle StopAsyncIteration propagation properly.

   - bpo-26110(148): Speed-up method calls: add LOAD_METHOD and
     CALL_METHOD opcodes.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31490

   (2) https://bugs.python.org/issue31471

   (3) https://bugs.python.org/issue31418

   (4) https://bugs.python.org/issue31416

   (5) https://bugs.python.org/issue28411

   (6) https://bugs.python.org/issue28411

   (7) https://bugs.python.org/issue31411

   (8) https://bugs.python.org/issue31344

   (9) https://bugs.python.org/issue31373

   (10) https://bugs.python.org/issue30465

   (11) https://bugs.python.org/issue30860

   (12) https://bugs.python.org/issue31347

   (13) https://bugs.python.org/issue31343

   (14) https://bugs.python.org/issue31291

   (15) https://bugs.python.org/issue31271

   (16) https://bugs.python.org/issue31243

   (17) https://bugs.python.org/issue30721

   (18) https://bugs.python.org/issue31070

   (19) https://bugs.python.org/issue30747

   (20) https://bugs.python.org/issue31095

   (21) https://bugs.python.org/issue31071

   (22) https://bugs.python.org/issue30978

   (23) https://bugs.python.org/issue30808

   (24) https://bugs.python.org/issue30876

   (25) https://bugs.python.org/issue30703

   (26) https://bugs.python.org/issue30765

   (27) https://bugs.python.org/issue31161

   (28) https://bugs.python.org/issue30814

   (29) https://bugs.python.org/issue30736

   (30) https://bugs.python.org/issue30604

   (31) https://bugs.python.org/issue30597

   (32) https://bugs.python.org/issue30682

   (33) https://bugs.python.org/issue30501

   (34) https://bugs.python.org/issue28180

   (35) https://www.python.org/dev/peps/pep-0538

   (36) https://bugs.python.org/issue30486

   (37) https://bugs.python.org/issue30537

   (38) https://bugs.python.org/issue25324

   (39) https://bugs.python.org/issue29104

   (40) https://bugs.python.org/issue27945

   (41) https://bugs.python.org/issue25794

   (42) https://bugs.python.org/issue30039

   (43) https://bugs.python.org/issue28974

   (44) https://bugs.python.org/issue30024

   (45) https://bugs.python.org/issue12414

   (46) https://bugs.python.org/issue29839

   (47) https://bugs.python.org/issue11913

   (48) https://bugs.python.org/issue29914

   (49) https://bugs.python.org/issue29949

   (50) https://bugs.python.org/issue29935

   (51) https://bugs.python.org/issue29816

   (52) https://bugs.python.org/issue24821

   (53) https://bugs.python.org/issue29102

   (54) https://bugs.python.org/issue29894

   (55) https://bugs.python.org/issue29859

   (56) https://bugs.python.org/issue29849

   (57) https://bugs.python.org/issue28856

   (58) https://bugs.python.org/issue29723

   (59) https://bugs.python.org/issue29139

   (60) https://bugs.python.org/issue29568

   (61) https://bugs.python.org/issue29714

   (62) https://bugs.python.org/issue29695

   (63) https://bugs.python.org/issue28893

   (64) https://bugs.python.org/issue28876

   (65) https://bugs.python.org/issue29683

   (66) https://bugs.python.org/issue29684

   (67) https://bugs.python.org/issue28598

   (68) https://bugs.python.org/issue29607

   (69) https://bugs.python.org/issue29602

   (70) https://bugs.python.org/issue29347

   (71) https://bugs.python.org/issue29463

   (72) https://bugs.python.org/issue32911

   (73) https://bugs.python.org/issue29438

   (74) https://bugs.python.org/issue29546

   (75) https://bugs.python.org/issue29546

   (76) https://bugs.python.org/issue29478

   (77) https://bugs.python.org/issue29319

   (78) https://bugs.python.org/issue29337

   (79) https://bugs.python.org/issue29327

   (80) https://bugs.python.org/issue29034

   (81) https://bugs.python.org/issue29159

   (82) https://bugs.python.org/issue29049

   (83) https://bugs.python.org/issue28927

   (84) https://bugs.python.org/issue28932

   (85) https://bugs.python.org/issue25677

   (86) https://bugs.python.org/issue29000

   (87) https://bugs.python.org/issue18896

   (88) https://bugs.python.org/issue28596

   (89) https://bugs.python.org/issue22257

   (90) https://www.python.org/dev/peps/pep-0432

   (91) https://bugs.python.org/issue26919

   (92) https://bugs.python.org/issue28991

   (93) https://bugs.python.org/issue28147

   (94) https://bugs.python.org/issue28739

   (95) https://bugs.python.org/issue28512

   (96) https://bugs.python.org/issue28918

   (97) https://bugs.python.org/issue23722

   (98) https://bugs.python.org/issue28797

   (99) https://bugs.python.org/issue28799

   (100) https://bugs.python.org/issue12844

   (101) https://bugs.python.org/issue28782

   (102) https://bugs.python.org/issue26647

   (103) https://bugs.python.org/issue28774

   (104) https://bugs.python.org/issue28731

   (105) https://bugs.python.org/issue28532

   (106) https://bugs.python.org/issue27100

   (107) https://bugs.python.org/issue28746

   (108) https://bugs.python.org/issue26920

   (109) https://bugs.python.org/issue28648

   (110) https://bugs.python.org/issue28665

   (111) https://bugs.python.org/issue19398

   (112) https://bugs.python.org/issue28621

   (113) https://bugs.python.org/issue28580

   (114) https://bugs.python.org/issue28583

   (115) https://bugs.python.org/issue28128

   (116) https://bugs.python.org/issue28509

   (117) https://bugs.python.org/issue28426

   (118) https://bugs.python.org/issue28517

   (119) https://bugs.python.org/issue28214

   (120) https://bugs.python.org/issue23782

   (121) https://bugs.python.org/issue28183

   (122) https://bugs.python.org/issue26081

   (123) https://bugs.python.org/issue28379

   (124) https://bugs.python.org/issue28376

   (125) https://bugs.python.org/issue28376

   (126) https://bugs.python.org/issue26906

   (127) https://bugs.python.org/issue18287

   (128) https://bugs.python.org/issue24098

   (129) https://bugs.python.org/issue28201

   (130) https://bugs.python.org/issue28350

   (131) https://bugs.python.org/issue26617

   (132) https://bugs.python.org/issue27942

   (133) https://bugs.python.org/issue28289

   (134) https://bugs.python.org/issue21578

   (135) https://bugs.python.org/issue28203

   (136) https://bugs.python.org/issue28086

   (137) https://bugs.python.org/issue28214

   (138) https://bugs.python.org/issue27955

   (139) https://bugs.python.org/issue28192

   (140) https://bugs.python.org/issue27441

   (141) https://bugs.python.org/issue27222

   (142) https://bugs.python.org/issue28131

   (143) https://bugs.python.org/issue28126

   (144) https://bugs.python.org/issue28120

   (145) https://bugs.python.org/issue26182

   (146) https://bugs.python.org/issue26182

   (147) https://bugs.python.org/issue28721

   (148) https://bugs.python.org/issue26110


File: python.info,  Node: Library<23>,  Next: Documentation<22>,  Prev: Core and Builtins<22>,  Up: Python 3 7 0 alpha 1

1.18.23.3 Library
.................

   - bpo-31499(1): xml.etree: Fix a crash when a parser is part of a
     reference cycle.

   - bpo-31482(2): ‘random.seed()’ now works with bytes in version=1

   - bpo-28556(3): typing.get_type_hints now finds the right globalns
     for classes and modules by default (when no ‘globalns’ was
     specified by the caller).

   - bpo-28556(4): Speed improvements to the ‘typing’ module.  Original
     PRs by Ivan Levkivskyi and Mitar.

   - bpo-31544(5): The C accelerator module of ElementTree ignored
     exceptions raised when looking up TreeBuilder target methods in
     XMLParser().

   - bpo-31234(6): socket.create_connection() now fixes manually a
     reference cycle: clear the variable storing the last exception on
     success.

   - bpo-31457(7): LoggerAdapter objects can now be nested.

   - bpo-31431(8): SSLContext.check_hostname now automatically sets
     SSLContext.verify_mode to ssl.CERT_REQUIRED instead of failing with
     a ValueError.

   - bpo-31233(9): socketserver.ThreadingMixIn now keeps a list of
     non-daemonic threads to wait until all these threads complete in
     server_close().

   - bpo-28638(10): Changed the implementation strategy for
     collections.namedtuple() to substantially reduce the use of exec()
     in favor of precomputed methods.  As a result, the `verbose'
     parameter and `_source' attribute are no longer supported.  The
     benefits include 1) having a smaller memory footprint for
     applications using multiple named tuples, 2) faster creation of the
     named tuple class (approx 4x to 6x depending on how it is
     measured), and 3) minor speed-ups for instance creation using
     __new__, _make, and _replace.  (The primary patch contributor is
     Jelle Zijlstra with further improvements by INADA Naoki, Serhiy
     Storchaka, and Raymond Hettinger.)

   - bpo-31400(11): Improves SSL error handling to avoid losing error
     numbers.

   - bpo-27629(12): Make return types of SSLContext.wrap_bio() and
     SSLContext.wrap_socket() customizable.

   - bpo-28958(13): ssl.SSLContext() now uses OpenSSL error information
     when a context cannot be instantiated.

   - bpo-28182(14): The SSL module now raises SSLCertVerificationError
     when OpenSSL fails to verify the peer’s certificate.  The exception
     contains more information about the error.

   - bpo-27340(15): SSLSocket.sendall() now uses memoryview to create
     slices of data.  This fixes support for all bytes-like object.  It
     is also more efficient and avoids costly copies.

   - bpo-14191(16): A new function
     ‘argparse.ArgumentParser.parse_intermixed_args’ provides the
     ability to parse command lines where there user intermixes options
     and positional arguments.

   - bpo-31178(17): Fix string concatenation bug in rare error path in
     the subprocess module

   - bpo-31350(18): Micro-optimize ‘asyncio._get_running_loop()’ to
     become up to 10% faster.

   - bpo-31170(19): expat: Update libexpat from 2.2.3 to 2.2.4.  Fix
     copying of partial characters for UTF-8 input (libexpat bug 115):
     ‘https://github.com/libexpat/libexpat/issues/115’

   - bpo-29136(20): Add TLS 1.3 cipher suites and OP_NO_TLSv1_3.

   - bpo-1198569(21): ‘string.Template’ subclasses can optionally define
     ‘braceidpattern’ if they want to specify different placeholder
     patterns inside and outside the braces.  If None (the default) it
     falls back to ‘idpattern’.

   - bpo-31326(22): concurrent.futures.ProcessPoolExecutor.shutdown()
     now explicitly closes the call queue.  Moreover,
     shutdown(wait=True) now also join the call queue thread, to prevent
     leaking a dangling thread.

   - bpo-27144(23): The ‘map()’ and ‘as_completed()’ iterators in
     ‘concurrent.futures’ now avoid keeping a reference to yielded
     objects.

   - bpo-31281(24): Fix ‘fileinput.FileInput(files, inplace=True)’ when
     ‘files’ contain ‘pathlib.Path’ objects.

   - bpo-10746(25): Fix ctypes producing wrong PEP 3118(26) type codes
     for integer types.

   - bpo-27584(27): ‘AF_VSOCK’ has been added to the socket interface
     which allows communication between virtual machines and their host.

   - bpo-22536(28): The subprocess module now sets the filename when
     FileNotFoundError is raised on POSIX systems due to the executable
     or cwd not being found.

   - bpo-29741(29): Update some methods in the _pyio module to also
     accept integer types.  Patch by Oren Milman.

   - bpo-31249(30): concurrent.futures: WorkItem.run() used by
     ThreadPoolExecutor now breaks a reference cycle between an
     exception object and the WorkItem object.

   - bpo-31247(31): xmlrpc.server now explicitly breaks reference cycles
     when using sys.exc_info() in code handling exceptions.

   - bpo-23835(32): configparser: reading defaults in the
     ‘ConfigParser()’ constructor is now using ‘read_dict()’, making its
     behavior consistent with the rest of the parser.  Non-string keys
     and values in the defaults dictionary are now being implicitly
     converted to strings.  Patch by James Tocknell.

   - bpo-31238(33): pydoc: the stop() method of the private ServerThread
     class now waits until DocServer.serve_until_quit() completes and
     then explicitly sets its docserver attribute to None to break a
     reference cycle.

   - bpo-5001(34): Many asserts in *note multiprocessing: b7. are now
     more informative, and some error types have been changed to more
     specific ones.

   - bpo-31109(35): Convert zipimport to use Argument Clinic.

   - bpo-30102(36): The ssl and hashlib modules now call
     OPENSSL_add_all_algorithms_noconf() on OpenSSL < 1.1.0.  The
     function detects CPU features and enables optimizations on some CPU
     architectures such as POWER8.  Patch is based on research from
     Gustavo Serra Scalet.

   - bpo-18966(37): Non-daemonic threads created by a
     multiprocessing.Process are now joined on child exit.

   - bpo-31183(38): *note dis: 38. now works with asynchronous generator
     and coroutine objects.  Patch by George Collins based on diagnosis
     by Luciano Ramalho.

   - bpo-5001(39): There are a number of uninformative asserts in the
     *note multiprocessing: b7. module, as noted in issue 5001.  This
     change fixes two of the most potentially problematic ones, since
     they are in error-reporting code, in the
     ‘multiprocessing.managers.convert_to_error’ function.  (It also
     makes more informative a ValueError message.)  The only potentially
     problematic change is that the AssertionError is now a TypeError;
     however, this should also help distinguish it from an
     AssertionError being `reported' by the function/its caller (such as
     in issue 31169).  - Patch by Allen W. Smith (drallensmith on
     github).

   - bpo-31185(40): Fixed miscellaneous errors in asyncio speedup
     module.

   - bpo-31151(41): socketserver.ForkingMixIn.server_close() now waits
     until all child processes completed to prevent leaking zombie
     processes.

   - bpo-31072(42): Add an ‘include_file’ parameter to
     ‘zipapp.create_archive()’

   - bpo-24700(43): Optimize array.array comparison.  It is now from 10x
     up to 70x faster when comparing arrays holding values of the same
     integer type.

   - bpo-31135(44): ttk: fix the destroy() method of LabeledScale and
     OptionMenu classes.  Call the parent destroy() method even if the
     used attribute doesn’t exist.  The LabeledScale.destroy() method
     now also explicitly clears label and scale attributes to help the
     garbage collector to destroy all widgets.

   - bpo-31107(45): Fix ‘copyreg._slotnames()’ mangled attribute
     calculation for classes whose name begins with an underscore.
     Patch by Shane Harvey.

   - bpo-31080(46): Allow *note logging.config.fileConfig: 39e. to
     accept kwargs and/or args.

   - bpo-30897(47): ‘pathlib.Path’ objects now include an ‘is_mount()’
     method (only implemented on POSIX). This is similar to
     ‘os.path.ismount(p)’.  Patch by Cooper Ry Lees.

   - bpo-31061(48): Fixed a crash when using asyncio and threads.

   - bpo-30987(49): Added support for CAN ISO-TP protocol in the socket
     module.

   - bpo-30522(50): Added a ‘setStream’ method to
     ‘logging.StreamHandler’ to allow the stream to be set after
     creation.

   - bpo-30502(51): Fix handling of long oids in ssl.  Based on patch by
     Christian Heimes.

   - bpo-5288(52): Support tzinfo objects with sub-minute offsets.

   - bpo-30919(53): Fix shared memory performance regression in
     multiprocessing in 3.x.  Shared memory used anonymous memory
     mappings in 2.x, while 3.x mmaps actual files.  Try to be careful
     to do as little disk I/O as possible.

   - bpo-26732(54): Fix too many fds in processes started with the
     “forkserver” method.  A child process would inherit as many fds as
     the number of still-running children.

   - bpo-29403(55): Fix ‘unittest.mock’’s autospec to not fail on
     method-bound builtin functions.  Patch by Aaron Gallagher.

   - bpo-30961(56): Fix decrementing a borrowed reference in
     tracemalloc.

   - bpo-19896(57): Fix multiprocessing.sharedctypes to recognize
     typecodes ‘'q'’ and ‘'Q'’.

   - bpo-30946(58): Remove obsolete code in readline module for
     platforms where GNU readline is older than 2.1 or where select() is
     not available.

   - bpo-25684(59): Change ‘ttk.OptionMenu’ radiobuttons to be unique
     across instances of ‘OptionMenu’.

   - bpo-30886(60): Fix multiprocessing.Queue.join_thread(): it now
     waits until the thread completes, even if the thread was started by
     the same process which created the queue.

   - bpo-29854(61): Fix segfault in readline when using readline’s
     history-size option.  Patch by Nir Soffer.

   - bpo-30794(62): Added multiprocessing.Process.kill method to
     terminate using the SIGKILL signal on Unix.

   - bpo-30319(63): socket.close() now ignores ECONNRESET error.

   - bpo-30828(64): Fix out of bounds write in
     ‘asyncio.CFuture.remove_done_callback()’.

   - bpo-30302(65): Use keywords in the ‘repr’ of ‘datetime.timedelta’.

   - bpo-30807(66): signal.setitimer() may disable the timer when passed
     a tiny value.  Tiny values (such as 1e-6) are valid non-zero values
     for setitimer(), which is specified as taking
     microsecond-resolution intervals.  However, on some platform, our
     conversion routine could convert 1e-6 into a zero interval,
     therefore disabling the timer instead of (re-)scheduling it.

   - bpo-30441(67): Fix bug when modifying os.environ while iterating
     over it

   - bpo-29585(68): Avoid importing ‘sysconfig’ from ‘site’ to improve
     startup speed.  Python startup is about 5% faster on Linux and 30%
     faster on macOS.

   - bpo-29293(69): Add missing parameter “n” on
     multiprocessing.Condition.notify().  The doc claims
     multiprocessing.Condition behaves like threading.Condition, but its
     notify() method lacked the optional “n” argument (to specify the
     number of sleepers to wake up) that threading.Condition.notify()
     accepts.

   - bpo-30532(70): Fix email header value parser dropping folding white
     space in certain cases.

   - bpo-30596(71): Add a ‘close()’ method to ‘multiprocessing.Process’.

   - bpo-9146(72): Fix a segmentation fault in _hashopenssl when
     standard hash functions such as md5 are not available in the linked
     OpenSSL library.  As in some special FIPS-140 build environments.

   - bpo-29169(73): Update zlib to 1.2.11.

   - bpo-30119(74): ftplib.FTP.putline() now throws ValueError on
     commands that contains CR or LF. Patch by Dong-hee Na.

   - bpo-30879(75): os.listdir() and os.scandir() now emit bytes names
     when called with bytes-like argument.

   - bpo-30746(76): Prohibited the ‘=’ character in environment variable
     names in ‘os.putenv()’ and ‘os.spawn*()’.

   - bpo-30664(77): The description of a unittest subtest now preserves
     the order of keyword arguments of TestCase.subTest().

   - bpo-21071(78): struct.Struct.format type is now *note str: 325.
     instead of *note bytes: 326.

   - bpo-29212(79): Fix concurrent.futures.thread.ThreadPoolExecutor
     threads to have a non repr() based thread name by default when no
     thread_name_prefix is supplied.  They will now identify themselves
     as “ThreadPoolExecutor-y_n”.

   - bpo-29755(80): Fixed the lgettext() family of functions in the
     gettext module.  They now always return bytes.

   - bpo-30616(81): Functional API of enum allows to create empty enums.
     Patched by Dong-hee Na

   - bpo-30038(82): Fix race condition between signal delivery and
     wakeup file descriptor.  Patch by Nathaniel Smith.

   - bpo-23894(83): lib2to3 now recognizes ‘rb'...'’ and ‘f'...'’
     strings.

   - bpo-24744(84): pkgutil.walk_packages function now raises ValueError
     if `path' is a string.  Patch by Sanyam Khurana.

   - bpo-24484(85): Avoid race condition in multiprocessing cleanup.

   - bpo-30589(86): Fix multiprocessing.Process.exitcode to return the
     opposite of the signal number when the process is killed by a
     signal (instead of 255) when using the “forkserver” method.

   - bpo-28994(87): The traceback no longer displayed for SystemExit
     raised in a callback registered by atexit.

   - bpo-30508(88): Don’t log exceptions if Task/Future “cancel()”
     method was called.

   - bpo-30645(89): Fix path calculation in ‘imp.load_package()’, fixing
     it for cases when a package is only shipped with bytecodes.  Patch
     by Alexandru Ardelean.

   - bpo-11822(90): The dis.dis() function now is able to disassemble
     nested code objects.

   - bpo-30624(91): selectors does not take KeyboardInterrupt and
     SystemExit into account, leaving a fd in a bad state in case of
     error.  Patch by Giampaolo Rodola’.

   - bpo-30595(92): multiprocessing.Queue.get() with a timeout now polls
     its reader in non-blocking mode if it succeeded to acquire the lock
     but the acquire took longer than the timeout.

   - bpo-28556(93): Updates to typing module: Add generic
     AsyncContextManager, add support for ContextManager on all
     versions.  Original PRs by Jelle Zijlstra and Ivan Levkivskyi

   - bpo-30605(94): re.compile() no longer raises a BytesWarning when
     compiling a bytes instance with misplaced inline modifier.  Patch
     by Roy Williams.

   - bpo-29870(95): Fix ssl sockets leaks when connection is aborted in
     asyncio/ssl implementation.  Patch by Michaël Sghaïer.

   - bpo-29743(96): Closing transport during handshake process leaks
     open socket.  Patch by Nikolay Kim

   - bpo-27585(97): Fix waiter cancellation in asyncio.Lock.  Patch by
     Mathieu Sornay.

   - bpo-30014(98): modify() method of poll(), epoll() and devpoll()
     based classes of selectors module is around 10% faster.  Patch by
     Giampaolo Rodola’.

   - bpo-30418(99): On Windows, subprocess.Popen.communicate() now also
     ignore EINVAL on stdin.write() if the child process is still
     running but closed the pipe.

   - bpo-30463(100): Addded empty __slots__ to abc.ABC. This allows
     subclassers to deny __dict__ and __weakref__ creation.  Patch by
     Aaron Hall.

   - bpo-30520(101): Loggers are now pickleable.

   - bpo-30557(102): faulthandler now correctly filters and displays
     exception codes on Windows

   - bpo-30526(103): Add TextIOWrapper.reconfigure() and a
     TextIOWrapper.write_through attribute.

   - bpo-30245(104): Fix possible overflow when organize
     struct.pack_into error message.  Patch by Yuan Liu.

   - bpo-30378(105): Fix the problem that logging.handlers.SysLogHandler
     cannot handle IPv6 addresses.

   - bpo-16500(106): Allow registering at-fork handlers.

   - bpo-30470(107): Deprecate invalid ctypes call protection on
     Windows.  Patch by Mariatta Wijaya.

   - bpo-30414(108): multiprocessing.Queue._feed background running
     thread do not break from main loop on exception.

   - bpo-30003(109): Fix handling escape characters in HZ codec.  Based
     on patch by Ma Lin.

   - bpo-30149(110): inspect.signature() now supports callables with
     variable-argument parameters wrapped with partialmethod.  Patch by
     Dong-hee Na.

   - bpo-30436(111): importlib.find_spec() raises ModuleNotFoundError
     instead of AttributeError if the specified parent module is not a
     package (i.e.  lacks a __path__ attribute).

   - bpo-30301(112): Fix AttributeError when using SimpleQueue.empty()
     under `spawn' and `forkserver' start methods.

   - bpo-30375(113): Warnings emitted when compile a regular expression
     now always point to the line in the user code.  Previously they
     could point into inners of the re module if emitted from inside of
     groups or conditionals.

   - bpo-30329(114): imaplib and poplib now catch the Windows socket
     WSAEINVAL error (code 10022) on shutdown(SHUT_RDWR): An invalid
     operation was attempted.  This error occurs sometimes on SSL
     connections.

   - bpo-29196(115): Removed previously deprecated in Python 2.4 classes
     Plist, Dict and _InternalDict in the plistlib module.  Dict values
     in the result of functions readPlist() and readPlistFromBytes() are
     now normal dicts.  You no longer can use attribute access to access
     items of these dictionaries.

   - bpo-9850(116): The ‘macpath’ is now deprecated and will be removed
     in Python 3.8.

   - bpo-30299(117): Compiling regular expression in debug mode on
     CPython now displays the compiled bytecode in human readable form.

   - bpo-30048(118): Fixed ‘Task.cancel()’ can be ignored when the task
     is running coroutine and the coroutine returned without any more
     ‘await’.

   - bpo-30266(119): contextlib.AbstractContextManager now supports
     anti-registration by setting __enter__ = None or __exit__ = None,
     following the pattern introduced in bpo-25958(120).  Patch by Jelle
     Zijlstra.

   - bpo-30340(121): Enhanced regular expressions optimization.  This
     increased the performance of matching some patterns up to 25 times.

   - bpo-30298(122): Weaken the condition of deprecation warnings for
     inline modifiers.  Now allowed several subsequential inline
     modifiers at the start of the pattern (e.g.  ‘'(?i)(?s)...'’).  In
     verbose mode whitespaces and comments now are allowed before and
     between inline modifiers (e.g.  ‘'(?x) (?i) (?s)...'’).

   - bpo-30285(123): Optimized case-insensitive matching and searching
     of regular expressions.

   - bpo-29990(124): Fix range checking in GB18030 decoder.  Original
     patch by Ma Lin.

   - bpo-29979(125): rewrite cgi.parse_multipart, reusing the
     FieldStorage class and making its results consistent with those of
     FieldStorage for multipart/form-data requests.  Patch by Pierre
     Quentel.

   - bpo-30243(126): Removed the __init__ methods of _json’s scanner and
     encoder.  Misusing them could cause memory leaks or crashes.  Now
     scanner and encoder objects are completely initialized in the
     __new__ methods.

   - bpo-30215(127): Compiled regular expression objects with the
     re.LOCALE flag no longer depend on the locale at compile time.
     Only the locale at matching time affects the result of matching.

   - bpo-30185(128): Avoid KeyboardInterrupt tracebacks in forkserver
     helper process when Ctrl-C is received.

   - bpo-30103(129): binascii.b2a_uu() and uu.encode() now support using
     ‘'`'’ as zero instead of space.

   - bpo-28556(130): Various updates to typing module: add
     typing.NoReturn type, use WrapperDescriptorType, minor bug-fixes.
     Original PRs by Jim Fasarakis-Hilliard and Ivan Levkivskyi.

   - bpo-30205(131): Fix getsockname() for unbound AF_UNIX sockets on
     Linux.

   - bpo-30228(132): The seek() and tell() methods of io.FileIO now set
     the internal seekable attribute to avoid one syscall on open() (in
     buffered or text mode).

   - bpo-30190(133): unittest’s assertAlmostEqual and
     assertNotAlmostEqual provide a better message in case of failure
     which includes the difference between left and right arguments.
     (patch by Giampaolo Rodola’)

   - bpo-30101(134): Add support for curses.A_ITALIC.

   - bpo-29822(135): inspect.isabstract() now works during
     __init_subclass__.  Patch by Nate Soares.

   - bpo-29960(136): Preserve generator state when
     _random.Random.setstate() raises an exception.  Patch by Bryan
     Olson.

   - bpo-30070(137): Fixed leaks and crashes in errors handling in the
     parser module.

   - bpo-22352(138): Column widths in the output of dis.dis() are now
     adjusted for large line numbers and instruction offsets.

   - bpo-30061(139): Fixed crashes in IOBase methods __next__() and
     readlines() when readline() or __next__() respectively return
     non-sizeable object.  Fixed possible other errors caused by not
     checking results of PyObject_Size(), PySequence_Size(), or
     PyMapping_Size().

   - bpo-30218(140): Fix PathLike support for shutil.unpack_archive.
     Patch by Jelle Zijlstra.

   - bpo-10076(141): Compiled regular expression and match objects in
     the re module now support copy.copy() and copy.deepcopy() (they are
     considered atomic).

   - bpo-30068(142): _io._IOBase.readlines will check if it’s closed
     first when hint is present.

   - bpo-29694(143): Fixed race condition in pathlib mkdir with flags
     parents=True.  Patch by Armin Rigo.

   - bpo-29692(144): Fixed arbitrary unchaining of RuntimeError
     exceptions in contextlib.contextmanager.  Patch by Siddharth
     Velankar.

   - bpo-26187(145): Test that sqlite3 trace callback is not called
     multiple times when schema is changing.  Indirectly fixed by
     switching to use sqlite3_prepare_v2() in bpo-9303(146).  Patch by
     Aviv Palivoda.

   - bpo-30017(147): Allowed calling the close() method of the zip entry
     writer object multiple times.  Writing to a closed writer now
     always produces a ValueError.

   - bpo-29998(148): Pickling and copying ImportError now preserves name
     and path attributes.

   - bpo-29995(149): re.escape() now escapes only regex special
     characters.

   - bpo-29962(150): Add math.remainder operation, implementing
     remainder as specified in IEEE 754.

   - bpo-29649(151): Improve struct.pack_into() exception messages for
     problems with the buffer size and offset.  Patch by Andrew Nester.

   - bpo-29654(152): Support If-Modified-Since HTTP header (browser
     cache).  Patch by Pierre Quentel.

   - bpo-29931(153): Fixed comparison check for ipaddress.ip_interface
     objects.  Patch by Sanjay Sundaresan.

   - bpo-29953(154): Fixed memory leaks in the replace() method of
     datetime and time objects when pass out of bound fold argument.

   - bpo-29942(155): Fix a crash in itertools.chain.from_iterable when
     encountering long runs of empty iterables.

   - bpo-10030(156): Sped up reading encrypted ZIP files by 2 times.

   - bpo-29204(157): Element.getiterator() and the html parameter of
     XMLParser() were deprecated only in the documentation (since Python
     3.2 and 3.4 correspondintly).  Now using them emits a deprecation
     warning.

   - bpo-27863(158): Fixed multiple crashes in ElementTree caused by
     race conditions and wrong types.

   - bpo-25996(159): Added support of file descriptors in os.scandir()
     on Unix.  os.fwalk() is sped up by 2 times by using os.scandir().

   - bpo-28699(160): Fixed a bug in pools in multiprocessing.pool that
     raising an exception at the very first of an iterable may swallow
     the exception or make the program hang.  Patch by Davin Potts and
     Xiang Zhang.

   - bpo-23890(161): unittest.TestCase.assertRaises() now manually
     breaks a reference cycle to not keep objects alive longer than
     expected.

   - bpo-29901(162): The zipapp module now supports general path-like
     objects, not just pathlib.Path.

   - bpo-25803(163): Avoid incorrect errors raised by
     Path.mkdir(exist_ok=True) when the OS gives priority to errors such
     as EACCES over EEXIST.

   - bpo-29861(164): Release references to tasks, their arguments and
     their results as soon as they are finished in multiprocessing.Pool.

   - bpo-19930(165): The mode argument of os.makedirs() no longer
     affects the file permission bits of newly-created
     intermediate-level directories.

   - bpo-29884(166): faulthandler: Restore the old sigaltstack during
     teardown.  Patch by Christophe Zeitouny.

   - bpo-25455(167): Fixed crashes in repr of recursive buffered
     file-like objects.

   - bpo-29800(168): Fix crashes in partial.__repr__ if the keys of
     partial.keywords are not strings.  Patch by Michael Seifert.

   - bpo-8256(169): Fixed possible failing or crashing input() if
     attributes “encoding” or “errors” of sys.stdin or sys.stdout are
     not set or are not strings.

   - bpo-28692(170): Using non-integer value for selecting a plural form
     in gettext is now deprecated.

   - bpo-26121(171): Use C library implementation for math functions
     erf() and erfc().

   - bpo-29619(172): os.stat() and os.DirEntry.inode() now convert inode
     (st_ino) using unsigned integers.

   - bpo-28298(173): Fix a bug that prevented array ‘Q’, ‘L’ and ‘I’
     from accepting big intables (objects that have __int__) as
     elements.

   - bpo-29645(174): Speed up importing the webbrowser module.
     webbrowser.register() is now thread-safe.

   - bpo-28231(175): The zipfile module now accepts path-like objects
     for external paths.

   - bpo-26915(176): index() and count() methods of
     collections.abc.Sequence now check identity before checking
     equality when do comparisons.

   - bpo-28682(177): Added support for bytes paths in os.fwalk().

   - bpo-29728(178): Add new ‘socket.TCP_NOTSENT_LOWAT’ (Linux 3.12)
     constant.  Patch by Nathaniel J. Smith.

   - bpo-29623(179): Allow use of path-like object as a single argument
     in ConfigParser.read().  Patch by David Ellis.

   - bpo-9303(180): Migrate sqlite3 module to _v2 API. Patch by Aviv
     Palivoda.

   - bpo-28963(181): Fix out of bound iteration in
     asyncio.Future.remove_done_callback implemented in C.

   - bpo-29704(182): asyncio.subprocess.SubprocessStreamProtocol no
     longer closes before all pipes are closed.

   - bpo-29271(183): Fix Task.current_task and Task.all_tasks
     implemented in C to accept None argument as their pure Python
     implementation.

   - bpo-29703(184): Fix asyncio to support instantiation of new event
     loops in child processes.

   - bpo-29615(185): SimpleXMLRPCDispatcher no longer chains KeyError
     (or any other exception) to exception(s) raised in the dispatched
     methods.  Patch by Petr Motejlek.

   - bpo-7769(186): Method register_function() of
     xmlrpc.server.SimpleXMLRPCDispatcher and its subclasses can now be
     used as a decorator.

   - bpo-29376(187): Fix assertion error in
     threading._DummyThread.is_alive().

   - bpo-28624(188): Add a test that checks that cwd parameter of
     Popen() accepts PathLike objects.  Patch by Sayan Chowdhury.

   - bpo-28518(189): Start a transaction implicitly before a DML
     statement.  Patch by Aviv Palivoda.

   - bpo-29742(190): get_extra_info() raises exception if get called on
     closed ssl transport.  Patch by Nikolay Kim.

   - bpo-16285(191): urllib.parse.quote is now based on RFC 3986 and
     hence includes ‘~’ in the set of characters that is not quoted by
     default.  Patch by Christian Theune and Ratnadeep Debnath.

   - bpo-29532(192): Altering a kwarg dictionary passed to
     functools.partial() no longer affects a partial object after
     creation.

   - bpo-29110(193): Fix file object leak in aifc.open() when file is
     given as a filesystem path and is not in valid AIFF format.  Patch
     by Anthony Zhang.

   - bpo-22807(194): Add uuid.SafeUUID and uuid.UUID.is_safe to relay
     information from the platform about whether generated UUIDs are
     generated with a multiprocessing safe method.

   - bpo-29576(195): Improve some deprecations in importlib.  Some
     deprecated methods now emit DeprecationWarnings and have better
     descriptive messages.

   - bpo-29534(196): Fixed different behaviour of Decimal.from_float()
     for _decimal and _pydecimal.  Thanks Andrew Nester.

   - bpo-10379(197): locale.format_string now supports the ‘monetary’
     keyword argument, and locale.format is deprecated.

   - bpo-29851(198): importlib.reload() now raises ModuleNotFoundError
     if the module lacks a spec.

   - bpo-28556(199): Various updates to typing module: typing.Counter,
     typing.ChainMap, improved ABC caching, etc.  Original PRs by Jelle
     Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

   - bpo-29100(200): Fix datetime.fromtimestamp() regression introduced
     in Python 3.6.0: check minimum and maximum years.

   - bpo-29416(201): Prevent infinite loop in pathlib.Path.mkdir

   - bpo-29444(202): Fixed out-of-bounds buffer access in the group()
     method of the match object.  Based on patch by WGH.

   - bpo-29377(203): Add WrapperDescriptorType, MethodWrapperType, and
     MethodDescriptorType built-in types to types module.  Original
     patch by Manuel Krebber.

   - bpo-29218(204): Unused install_misc command is now removed.  It has
     been documented as unused since 2000.  Patch by Eric N. Vander
     Weele.

   - bpo-29368(205): The extend() method is now called instead of the
     append() method when unpickle collections.deque and other list-like
     objects.  This can speed up unpickling to 2 times.

   - bpo-29338(206): The help of a builtin or extension class now
     includes the constructor signature if __text_signature__ is
     provided for the class.

   - bpo-29335(207): Fix subprocess.Popen.wait() when the child process
     has exited to a stopped instead of terminated state (ex: when under
     ptrace).

   - bpo-29290(208): Fix a regression in argparse that help messages
     would wrap at non-breaking spaces.

   - bpo-28735(209): Fixed the comparison of mock.MagickMock with
     mock.ANY.

   - bpo-29197(210): Removed deprecated function ntpath.splitunc().

   - bpo-29210(211): Removed support of deprecated argument “exclude” in
     tarfile.TarFile.add().

   - bpo-29219(212): Fixed infinite recursion in the repr of
     uninitialized ctypes.CDLL instances.

   - bpo-29192(213): Removed deprecated features in the http.cookies
     module.

   - bpo-29193(214): A format string argument for
     string.Formatter.format() is now positional-only.

   - bpo-29195(215): Removed support of deprecated undocumented keyword
     arguments in methods of regular expression objects.

   - bpo-28969(216): Fixed race condition in C implementation of
     functools.lru_cache.  KeyError could be raised when cached function
     with full cache was simultaneously called from different threads
     with the same uncached arguments.

   - bpo-20804(217): The unittest.mock.sentinel attributes now preserve
     their identity when they are copied or pickled.

   - bpo-29142(218): In urllib.request, suffixes in no_proxy environment
     variable with leading dots could match related hostnames again
     (e.g.  .b.c matches a.b.c).  Patch by Milan Oberkirch.

   - bpo-28961(219): Fix unittest.mock._Call helper: don’t ignore the
     name parameter anymore.  Patch written by Jiajun Huang.

   - bpo-15812(220): inspect.getframeinfo() now correctly shows the
     first line of a context.  Patch by Sam Breese.

   - bpo-28985(221): Update authorizer constants in sqlite3 module.
     Patch by Dingyuan Wang.

   - bpo-29079(222): Prevent infinite loop in pathlib.resolve() on
     Windows

   - bpo-13051(223): Fixed recursion errors in large or resized
     curses.textpad.Textbox.  Based on patch by Tycho Andersen.

   - bpo-9770(224): curses.ascii predicates now work correctly with
     negative integers.

   - bpo-28427(225): old keys should not remove new values from
     WeakValueDictionary when collecting from another thread.

   - bpo-28923(226): Remove editor artifacts from Tix.py.

   - bpo-28871(227): Fixed a crash when deallocate deep ElementTree.

   - bpo-19542(228): Fix bugs in WeakValueDictionary.setdefault() and
     WeakValueDictionary.pop() when a GC collection happens in another
     thread.

   - bpo-20191(229): Fixed a crash in resource.prlimit() when passing a
     sequence that doesn’t own its elements as limits.

   - bpo-16255(230): subprocess.Popen uses /system/bin/sh on Android as
     the shell, instead of /bin/sh.

   - bpo-28779(231): multiprocessing.set_forkserver_preload() would
     crash the forkserver process if a preloaded module instantiated
     some multiprocessing objects such as locks.

   - bpo-26937(232): The chown() method of the tarfile.TarFile class
     does not fail now when the grp module cannot be imported, as for
     example on Android platforms.

   - bpo-28847(233): dbm.dumb now supports reading read-only files and
     no longer writes the index file when it is not changed.  A
     deprecation warning is now emitted if the index file is missed and
     recreated in the ‘r’ and ‘w’ modes (will be an error in future
     Python releases).

   - bpo-27030(234): Unknown escapes consisting of ‘'\'’ and an ASCII
     letter in re.sub() replacement templates regular expressions now
     are errors.

   - bpo-28835(235): Fix a regression introduced in
     warnings.catch_warnings(): call warnings.showwarning() if it was
     overridden inside the context manager.

   - bpo-27172(236): To assist with upgrades from 2.7, the previously
     documented deprecation of ‘inspect.getfullargspec()’ has been
     reversed.  This decision may be revisited again after the Python
     2.7 branch is no longer officially supported.

   - bpo-28740(237): Add sys.getandroidapilevel(): return the build time
     API version of Android as an integer.  Function only available on
     Android.

   - bpo-26273(238): Add new ‘socket.TCP_CONGESTION’ (Linux 2.6.13) and
     ‘socket.TCP_USER_TIMEOUT’ (Linux 2.6.37) constants.  Patch written
     by Omar Sandoval.

   - bpo-28752(239): Restored the __reduce__() methods of datetime
     objects.

   - bpo-28727(240): Regular expression patterns, _sre.SRE_Pattern
     objects created by re.compile(), become comparable (only x==y and
     x!=y operators).  This change should fix the bpo-18383(241): don’t
     duplicate warning filters when the warnings module is reloaded
     (thing usually only done in unit tests).

   - bpo-20572(242): Remove the subprocess.Popen.wait endtime parameter.
     It was deprecated in 3.4 and undocumented prior to that.

   - bpo-25659(243): In ctypes, prevent a crash calling the
     from_buffer() and from_buffer_copy() methods on abstract classes
     like Array.

   - bpo-28548(244): In the “http.server” module, parse the protocol
     version if possible, to avoid using HTTP 0.9 in some error
     responses.

   - bpo-19717(245): Makes Path.resolve() succeed on paths that do not
     exist.  Patch by Vajrasky Kok

   - bpo-28563(246): Fixed possible DoS and arbitrary code execution
     when handle plural form selections in the gettext module.  The
     expression parser now supports exact syntax supported by GNU
     gettext.

   - bpo-28387(247): Fixed possible crash in _io.TextIOWrapper
     deallocator when the garbage collector is invoked in other thread.
     Based on patch by Sebastian Cufre.

   - bpo-27517(248): LZMA compressor and decompressor no longer raise
     exceptions if given empty data twice.  Patch by Benjamin Fogle.

   - bpo-28549(249): Fixed segfault in curses’s addch() with ncurses6.

   - bpo-28449(250): tarfile.open() with mode “r” or “r:” now tries to
     open a tar file with compression before trying to open it without
     compression.  Otherwise it had 50% chance failed with
     ignore_zeros=True.

   - bpo-23262(251): The webbrowser module now supports Firefox 36+ and
     derived browsers.  Based on patch by Oleg Broytman.

   - bpo-24241(252): The webbrowser in an X environment now prefers
     using the default browser directly.  Also, the webbrowser
     register() function now has a documented ‘preferred’ argument, to
     specify browsers to be returned by get() with no arguments.  Patch
     by David Steele

   - bpo-27939(253): Fixed bugs in tkinter.ttk.LabeledScale and
     tkinter.Scale caused by representing the scale as float value
     internally in Tk.  tkinter.IntVar now works if float value is set
     to underlying Tk variable.

   - bpo-28255(254): calendar.TextCalendar.prweek() no longer prints a
     space after a weeks’s calendar.  calendar.TextCalendar.pryear() no
     longer prints redundant newline after a year’s calendar.  Based on
     patch by Xiang Zhang.

   - bpo-28255(255): calendar.TextCalendar.prmonth() no longer prints a
     space at the start of new line after printing a month’s calendar.
     Patch by Xiang Zhang.

   - bpo-20491(256): The textwrap.TextWrapper class now honors
     non-breaking spaces.  Based on patch by Kaarle Ritvanen.

   - bpo-28353(257): os.fwalk() no longer fails on broken links.

   - bpo-28430(258): Fix iterator of C implemented asyncio.Future
     doesn’t accept non-None value is passed to it.send(val).

   - bpo-27025(259): Generated names for Tkinter widgets now start by
     the “!” prefix for readability.

   - bpo-25464(260): Fixed HList.header_exists() in tkinter.tix module
     by addin a workaround to Tix library bug.

   - bpo-28488(261): shutil.make_archive() no longer adds entry “./” to
     ZIP archive.

   - bpo-25953(262): re.sub() now raises an error for invalid numerical
     group reference in replacement template even if the pattern is not
     found in the string.  Error message for invalid group reference now
     includes the group index and the position of the reference.  Based
     on patch by SilentGhost.

   - bpo-28469(263): timeit now uses the sequence 1, 2, 5, 10, 20, 50,…
     instead of 1, 10, 100,… for autoranging.

   - bpo-28115(264): Command-line interface of the zipfile module now
     uses argparse.  Added support of long options.

   - bpo-18219(265): Optimize csv.DictWriter for large number of
     columns.  Patch by Mariatta Wijaya.

   - bpo-28448(266): Fix C implemented asyncio.Future didn’t work on
     Windows.

   - bpo-23214(267): In the “io” module, the argument to BufferedReader
     and BytesIO’s read1() methods is now optional and can be -1,
     matching the BufferedIOBase specification.

   - bpo-28480(268): Fix error building socket module when
     multithreading is disabled.

   - bpo-28240(269): timeit: remove ‘-c/--clock’ and ‘-t/--time’ command
     line options which were deprecated since Python 3.3.

   - bpo-28240(270): timeit now repeats the benchmarks 5 times instead
     of only 3 to make benchmarks more reliable.

   - bpo-28240(271): timeit autorange now uses a single loop iteration
     if the benchmark takes less than 10 seconds, instead of 10
     iterations.  “python3 -m timeit -s ‘import time’ ‘time.sleep(1)’”
     now takes 4 seconds instead of 40 seconds.

   - Distutils.sdist now looks for README and setup.py files with case
     sensitivity.  This behavior matches that found in Setuptools 6.0
     and later.  See setuptools 100(272) for rationale.

   - bpo-24452(273): Make webbrowser support Chrome on Mac OS X. Patch
     by Ned Batchelder.

   - bpo-20766(274): Fix references leaked by pdb in the handling of
     SIGINT handlers.

   - bpo-27998(275): Fixed bytes path support in os.scandir() on
     Windows.  Patch by Eryk Sun.

   - bpo-28317(276): The disassembler now decodes FORMAT_VALUE argument.

   - bpo-28380(277): unittest.mock Mock autospec functions now properly
     support assert_called, assert_not_called, and assert_called_once.

   - bpo-28229(278): lzma module now supports pathlib.

   - bpo-28321(279): Fixed writing non-BMP characters with binary format
     in plistlib.

   - bpo-28225(280): bz2 module now supports pathlib.  Initial patch by
     Ethan Furman.

   - bpo-28227(281): gzip now supports pathlib.  Patch by Ethan Furman.

   - bpo-28332(282): Deprecated silent truncations in socket.htons and
     socket.ntohs.  Original patch by Oren Milman.

   - bpo-27358(283): Optimized merging var-keyword arguments and
     improved error message when passing a non-mapping as a var-keyword
     argument.

   - bpo-28257(284): Improved error message when passing a non-iterable
     as a var-positional argument.  Added opcode
     BUILD_TUPLE_UNPACK_WITH_CALL.

   - bpo-28322(285): Fixed possible crashes when unpickle itertools
     objects from incorrect pickle data.  Based on patch by John Leitch.

   - bpo-28228(286): imghdr now supports pathlib.

   - bpo-28226(287): compileall now supports pathlib.

   - bpo-28314(288): Fix function declaration (C flags) for the
     getiterator() method of xml.etree.ElementTree.Element.

   - bpo-28148(289): Stop using localtime() and gmtime() in the time
     module.  Introduced platform independent _PyTime_localtime API that
     is similar to POSIX localtime_r, but available on all platforms.
     Patch by Ed Schouten.

   - bpo-28253(290): Fixed calendar functions for extreme months:
     0001-01 and 9999-12.  Methods itermonthdays() and itermonthdays2()
     are reimplemented so that they don’t call itermonthdates() which
     can cause datetime.date under/overflow.

   - bpo-28275(291): Fixed possible use after free in the decompress()
     methods of the LZMADecompressor and BZ2Decompressor classes.
     Original patch by John Leitch.

   - bpo-27897(292): Fixed possible crash in
     sqlite3.Connection.create_collation() if pass invalid string-like
     object as a name.  Patch by Xiang Zhang.

   - bpo-18844(293): random.choices() now has k as a keyword-only
     argument to improve the readability of common cases and come into
     line with the signature used in other languages.

   - bpo-18893(294): Fix invalid exception handling in
     Lib/ctypes/macholib/dyld.py.  Patch by Madison May.

   - bpo-27611(295): Fixed support of default root window in the
     tkinter.tix module.  Added the master parameter in the DisplayStyle
     constructor.

   - bpo-27348(296): In the traceback module, restore the formatting of
     exception messages like “Exception: None”.  This fixes a regression
     introduced in 3.5a2.

   - bpo-25651(297): Allow falsy values to be used for msg parameter of
     subTest().

   - bpo-27778(298): Fix a memory leak in os.getrandom() when the
     getrandom() is interrupted by a signal and a signal handler raises
     a Python exception.

   - bpo-28200(299): Fix memory leak on Windows in the os module (fix
     path_converter() function).

   - bpo-25400(300): RobotFileParser now correctly returns default
     values for crawl_delay and request_rate.  Initial patch by Peter
     Wirtz.

   - bpo-27932(301): Prevent memory leak in win32_ver().

   - Fix UnboundLocalError in socket._sendfile_use_sendfile.

   - bpo-28075(302): Check for ERROR_ACCESS_DENIED in Windows
     implementation of os.stat().  Patch by Eryk Sun.

   - bpo-22493(303): Warning message emitted by using inline flags in
     the middle of regular expression now contains a (truncated) regex
     pattern.  Patch by Tim Graham.

   - bpo-25270(304): Prevent codecs.escape_encode() from raising
     SystemError when an empty bytestring is passed.

   - bpo-28181(305): Get antigravity over HTTPS. Patch by Kaartic
     Sivaraam.

   - bpo-25895(306): Enable WebSocket URL schemes in
     urllib.parse.urljoin.  Patch by Gergely Imreh and Markus
     Holtermann.

   - bpo-28114(307): Fix a crash in parse_envlist() when env contains
     byte strings.  Patch by Eryk Sun.

   - bpo-27599(308): Fixed buffer overrun in binascii.b2a_qp() and
     binascii.a2b_qp().

   - bpo-27906(309): Fix socket accept exhaustion during high TCP
     traffic.  Patch by Kevin Conway.

   - bpo-28174(310): Handle when SO_REUSEPORT isn’t properly supported.
     Patch by Seth Michael Larson.

   - bpo-26654(311): Inspect functools.partial in
     asyncio.Handle.__repr__.  Patch by iceboy.

   - bpo-26909(312): Fix slow pipes IO in asyncio.  Patch by INADA
     Naoki.

   - bpo-28176(313): Fix callbacks race in
     asyncio.SelectorLoop.sock_connect.

   - bpo-27759(314): Fix selectors incorrectly retain invalid file
     descriptors.  Patch by Mark Williams.

   - bpo-28325(315): Remove vestigial MacOS 9 macurl2path module and its
     tests.

   - bpo-28368(316): Refuse monitoring processes if the child watcher
     has no loop attached.  Patch by Vincent Michel.

   - bpo-28369(317): Raise RuntimeError when transport’s FD is used with
     add_reader, add_writer, etc.

   - bpo-28370(318): Speedup asyncio.StreamReader.readexactly.  Patch by
     Коренберг Марк.

   - bpo-28371(319): Deprecate passing asyncio.Handles to
     run_in_executor.

   - bpo-28372(320): Fix asyncio to support formatting of non-python
     coroutines.

   - bpo-28399(321): Remove UNIX socket from FS before binding.  Patch
     by Коренберг Марк.

   - bpo-27972(322): Prohibit Tasks to await on themselves.

   - bpo-24142(323): Reading a corrupt config file left configparser in
     an invalid state.  Original patch by Florian Höch.

   - bpo-29581(324): ABCMeta.__new__ now accepts ‘**kwargs’, allowing
     abstract base classes to use keyword parameters in
     __init_subclass__.  Patch by Nate Soares.

   - bpo-25532(325): inspect.unwrap() will now only try to unwrap an
     object sys.getrecursionlimit() times, to protect against objects
     which create a new object on every attribute access.

   - bpo-30177(326): path.resolve(strict=False) no longer cuts the path
     after the first element not present in the filesystem.  Patch by
     Antoine Pietri.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31499

   (2) https://bugs.python.org/issue31482

   (3) https://bugs.python.org/issue28556

   (4) https://bugs.python.org/issue28556

   (5) https://bugs.python.org/issue31544

   (6) https://bugs.python.org/issue31234

   (7) https://bugs.python.org/issue31457

   (8) https://bugs.python.org/issue31431

   (9) https://bugs.python.org/issue31233

   (10) https://bugs.python.org/issue28638

   (11) https://bugs.python.org/issue31400

   (12) https://bugs.python.org/issue27629

   (13) https://bugs.python.org/issue28958

   (14) https://bugs.python.org/issue28182

   (15) https://bugs.python.org/issue27340

   (16) https://bugs.python.org/issue14191

   (17) https://bugs.python.org/issue31178

   (18) https://bugs.python.org/issue31350

   (19) https://bugs.python.org/issue31170

   (20) https://bugs.python.org/issue29136

   (21) https://bugs.python.org/issue1198569

   (22) https://bugs.python.org/issue31326

   (23) https://bugs.python.org/issue27144

   (24) https://bugs.python.org/issue31281

   (25) https://bugs.python.org/issue10746

   (26) https://www.python.org/dev/peps/pep-3118

   (27) https://bugs.python.org/issue27584

   (28) https://bugs.python.org/issue22536

   (29) https://bugs.python.org/issue29741

   (30) https://bugs.python.org/issue31249

   (31) https://bugs.python.org/issue31247

   (32) https://bugs.python.org/issue23835

   (33) https://bugs.python.org/issue31238

   (34) https://bugs.python.org/issue5001

   (35) https://bugs.python.org/issue31109

   (36) https://bugs.python.org/issue30102

   (37) https://bugs.python.org/issue18966

   (38) https://bugs.python.org/issue31183

   (39) https://bugs.python.org/issue5001

   (40) https://bugs.python.org/issue31185

   (41) https://bugs.python.org/issue31151

   (42) https://bugs.python.org/issue31072

   (43) https://bugs.python.org/issue24700

   (44) https://bugs.python.org/issue31135

   (45) https://bugs.python.org/issue31107

   (46) https://bugs.python.org/issue31080

   (47) https://bugs.python.org/issue30897

   (48) https://bugs.python.org/issue31061

   (49) https://bugs.python.org/issue30987

   (50) https://bugs.python.org/issue30522

   (51) https://bugs.python.org/issue30502

   (52) https://bugs.python.org/issue5288

   (53) https://bugs.python.org/issue30919

   (54) https://bugs.python.org/issue26732

   (55) https://bugs.python.org/issue29403

   (56) https://bugs.python.org/issue30961

   (57) https://bugs.python.org/issue19896

   (58) https://bugs.python.org/issue30946

   (59) https://bugs.python.org/issue25684

   (60) https://bugs.python.org/issue30886

   (61) https://bugs.python.org/issue29854

   (62) https://bugs.python.org/issue30794

   (63) https://bugs.python.org/issue30319

   (64) https://bugs.python.org/issue30828

   (65) https://bugs.python.org/issue30302

   (66) https://bugs.python.org/issue30807

   (67) https://bugs.python.org/issue30441

   (68) https://bugs.python.org/issue29585

   (69) https://bugs.python.org/issue29293

   (70) https://bugs.python.org/issue30532

   (71) https://bugs.python.org/issue30596

   (72) https://bugs.python.org/issue9146

   (73) https://bugs.python.org/issue29169

   (74) https://bugs.python.org/issue30119

   (75) https://bugs.python.org/issue30879

   (76) https://bugs.python.org/issue30746

   (77) https://bugs.python.org/issue30664

   (78) https://bugs.python.org/issue21071

   (79) https://bugs.python.org/issue29212

   (80) https://bugs.python.org/issue29755

   (81) https://bugs.python.org/issue30616

   (82) https://bugs.python.org/issue30038

   (83) https://bugs.python.org/issue23894

   (84) https://bugs.python.org/issue24744

   (85) https://bugs.python.org/issue24484

   (86) https://bugs.python.org/issue30589

   (87) https://bugs.python.org/issue28994

   (88) https://bugs.python.org/issue30508

   (89) https://bugs.python.org/issue30645

   (90) https://bugs.python.org/issue11822

   (91) https://bugs.python.org/issue30624

   (92) https://bugs.python.org/issue30595

   (93) https://bugs.python.org/issue28556

   (94) https://bugs.python.org/issue30605

   (95) https://bugs.python.org/issue29870

   (96) https://bugs.python.org/issue29743

   (97) https://bugs.python.org/issue27585

   (98) https://bugs.python.org/issue30014

   (99) https://bugs.python.org/issue30418

   (100) https://bugs.python.org/issue30463

   (101) https://bugs.python.org/issue30520

   (102) https://bugs.python.org/issue30557

   (103) https://bugs.python.org/issue30526

   (104) https://bugs.python.org/issue30245

   (105) https://bugs.python.org/issue30378

   (106) https://bugs.python.org/issue16500

   (107) https://bugs.python.org/issue30470

   (108) https://bugs.python.org/issue30414

   (109) https://bugs.python.org/issue30003

   (110) https://bugs.python.org/issue30149

   (111) https://bugs.python.org/issue30436

   (112) https://bugs.python.org/issue30301

   (113) https://bugs.python.org/issue30375

   (114) https://bugs.python.org/issue30329

   (115) https://bugs.python.org/issue29196

   (116) https://bugs.python.org/issue9850

   (117) https://bugs.python.org/issue30299

   (118) https://bugs.python.org/issue30048

   (119) https://bugs.python.org/issue30266

   (120) https://bugs.python.org/issue25958

   (121) https://bugs.python.org/issue30340

   (122) https://bugs.python.org/issue30298

   (123) https://bugs.python.org/issue30285

   (124) https://bugs.python.org/issue29990

   (125) https://bugs.python.org/issue29979

   (126) https://bugs.python.org/issue30243

   (127) https://bugs.python.org/issue30215

   (128) https://bugs.python.org/issue30185

   (129) https://bugs.python.org/issue30103

   (130) https://bugs.python.org/issue28556

   (131) https://bugs.python.org/issue30205

   (132) https://bugs.python.org/issue30228

   (133) https://bugs.python.org/issue30190

   (134) https://bugs.python.org/issue30101

   (135) https://bugs.python.org/issue29822

   (136) https://bugs.python.org/issue29960

   (137) https://bugs.python.org/issue30070

   (138) https://bugs.python.org/issue22352

   (139) https://bugs.python.org/issue30061

   (140) https://bugs.python.org/issue30218

   (141) https://bugs.python.org/issue10076

   (142) https://bugs.python.org/issue30068

   (143) https://bugs.python.org/issue29694

   (144) https://bugs.python.org/issue29692

   (145) https://bugs.python.org/issue26187

   (146) https://bugs.python.org/issue9303

   (147) https://bugs.python.org/issue30017

   (148) https://bugs.python.org/issue29998

   (149) https://bugs.python.org/issue29995

   (150) https://bugs.python.org/issue29962

   (151) https://bugs.python.org/issue29649

   (152) https://bugs.python.org/issue29654

   (153) https://bugs.python.org/issue29931

   (154) https://bugs.python.org/issue29953

   (155) https://bugs.python.org/issue29942

   (156) https://bugs.python.org/issue10030

   (157) https://bugs.python.org/issue29204

   (158) https://bugs.python.org/issue27863

   (159) https://bugs.python.org/issue25996

   (160) https://bugs.python.org/issue28699

   (161) https://bugs.python.org/issue23890

   (162) https://bugs.python.org/issue29901

   (163) https://bugs.python.org/issue25803

   (164) https://bugs.python.org/issue29861

   (165) https://bugs.python.org/issue19930

   (166) https://bugs.python.org/issue29884

   (167) https://bugs.python.org/issue25455

   (168) https://bugs.python.org/issue29800

   (169) https://bugs.python.org/issue8256

   (170) https://bugs.python.org/issue28692

   (171) https://bugs.python.org/issue26121

   (172) https://bugs.python.org/issue29619

   (173) https://bugs.python.org/issue28298

   (174) https://bugs.python.org/issue29645

   (175) https://bugs.python.org/issue28231

   (176) https://bugs.python.org/issue26915

   (177) https://bugs.python.org/issue28682

   (178) https://bugs.python.org/issue29728

   (179) https://bugs.python.org/issue29623

   (180) https://bugs.python.org/issue9303

   (181) https://bugs.python.org/issue28963

   (182) https://bugs.python.org/issue29704

   (183) https://bugs.python.org/issue29271

   (184) https://bugs.python.org/issue29703

   (185) https://bugs.python.org/issue29615

   (186) https://bugs.python.org/issue7769

   (187) https://bugs.python.org/issue29376

   (188) https://bugs.python.org/issue28624

   (189) https://bugs.python.org/issue28518

   (190) https://bugs.python.org/issue29742

   (191) https://bugs.python.org/issue16285

   (192) https://bugs.python.org/issue29532

   (193) https://bugs.python.org/issue29110

   (194) https://bugs.python.org/issue22807

   (195) https://bugs.python.org/issue29576

   (196) https://bugs.python.org/issue29534

   (197) https://bugs.python.org/issue10379

   (198) https://bugs.python.org/issue29851

   (199) https://bugs.python.org/issue28556

   (200) https://bugs.python.org/issue29100

   (201) https://bugs.python.org/issue29416

   (202) https://bugs.python.org/issue29444

   (203) https://bugs.python.org/issue29377

   (204) https://bugs.python.org/issue29218

   (205) https://bugs.python.org/issue29368

   (206) https://bugs.python.org/issue29338

   (207) https://bugs.python.org/issue29335

   (208) https://bugs.python.org/issue29290

   (209) https://bugs.python.org/issue28735

   (210) https://bugs.python.org/issue29197

   (211) https://bugs.python.org/issue29210

   (212) https://bugs.python.org/issue29219

   (213) https://bugs.python.org/issue29192

   (214) https://bugs.python.org/issue29193

   (215) https://bugs.python.org/issue29195

   (216) https://bugs.python.org/issue28969

   (217) https://bugs.python.org/issue20804

   (218) https://bugs.python.org/issue29142

   (219) https://bugs.python.org/issue28961

   (220) https://bugs.python.org/issue15812

   (221) https://bugs.python.org/issue28985

   (222) https://bugs.python.org/issue29079

   (223) https://bugs.python.org/issue13051

   (224) https://bugs.python.org/issue9770

   (225) https://bugs.python.org/issue28427

   (226) https://bugs.python.org/issue28923

   (227) https://bugs.python.org/issue28871

   (228) https://bugs.python.org/issue19542

   (229) https://bugs.python.org/issue20191

   (230) https://bugs.python.org/issue16255

   (231) https://bugs.python.org/issue28779

   (232) https://bugs.python.org/issue26937

   (233) https://bugs.python.org/issue28847

   (234) https://bugs.python.org/issue27030

   (235) https://bugs.python.org/issue28835

   (236) https://bugs.python.org/issue27172

   (237) https://bugs.python.org/issue28740

   (238) https://bugs.python.org/issue26273

   (239) https://bugs.python.org/issue28752

   (240) https://bugs.python.org/issue28727

   (241) https://bugs.python.org/issue18383

   (242) https://bugs.python.org/issue20572

   (243) https://bugs.python.org/issue25659

   (244) https://bugs.python.org/issue28548

   (245) https://bugs.python.org/issue19717

   (246) https://bugs.python.org/issue28563

   (247) https://bugs.python.org/issue28387

   (248) https://bugs.python.org/issue27517

   (249) https://bugs.python.org/issue28549

   (250) https://bugs.python.org/issue28449

   (251) https://bugs.python.org/issue23262

   (252) https://bugs.python.org/issue24241

   (253) https://bugs.python.org/issue27939

   (254) https://bugs.python.org/issue28255

   (255) https://bugs.python.org/issue28255

   (256) https://bugs.python.org/issue20491

   (257) https://bugs.python.org/issue28353

   (258) https://bugs.python.org/issue28430

   (259) https://bugs.python.org/issue27025

   (260) https://bugs.python.org/issue25464

   (261) https://bugs.python.org/issue28488

   (262) https://bugs.python.org/issue25953

   (263) https://bugs.python.org/issue28469

   (264) https://bugs.python.org/issue28115

   (265) https://bugs.python.org/issue18219

   (266) https://bugs.python.org/issue28448

   (267) https://bugs.python.org/issue23214

   (268) https://bugs.python.org/issue28480

   (269) https://bugs.python.org/issue28240

   (270) https://bugs.python.org/issue28240

   (271) https://bugs.python.org/issue28240

   (272) https://github.com/pypa/setuptools/issues/100

   (273) https://bugs.python.org/issue24452

   (274) https://bugs.python.org/issue20766

   (275) https://bugs.python.org/issue27998

   (276) https://bugs.python.org/issue28317

   (277) https://bugs.python.org/issue28380

   (278) https://bugs.python.org/issue28229

   (279) https://bugs.python.org/issue28321

   (280) https://bugs.python.org/issue28225

   (281) https://bugs.python.org/issue28227

   (282) https://bugs.python.org/issue28332

   (283) https://bugs.python.org/issue27358

   (284) https://bugs.python.org/issue28257

   (285) https://bugs.python.org/issue28322

   (286) https://bugs.python.org/issue28228

   (287) https://bugs.python.org/issue28226

   (288) https://bugs.python.org/issue28314

   (289) https://bugs.python.org/issue28148

   (290) https://bugs.python.org/issue28253

   (291) https://bugs.python.org/issue28275

   (292) https://bugs.python.org/issue27897

   (293) https://bugs.python.org/issue18844

   (294) https://bugs.python.org/issue18893

   (295) https://bugs.python.org/issue27611

   (296) https://bugs.python.org/issue27348

   (297) https://bugs.python.org/issue25651

   (298) https://bugs.python.org/issue27778

   (299) https://bugs.python.org/issue28200

   (300) https://bugs.python.org/issue25400

   (301) https://bugs.python.org/issue27932

   (302) https://bugs.python.org/issue28075

   (303) https://bugs.python.org/issue22493

   (304) https://bugs.python.org/issue25270

   (305) https://bugs.python.org/issue28181

   (306) https://bugs.python.org/issue25895

   (307) https://bugs.python.org/issue28114

   (308) https://bugs.python.org/issue27599

   (309) https://bugs.python.org/issue27906

   (310) https://bugs.python.org/issue28174

   (311) https://bugs.python.org/issue26654

   (312) https://bugs.python.org/issue26909

   (313) https://bugs.python.org/issue28176

   (314) https://bugs.python.org/issue27759

   (315) https://bugs.python.org/issue28325

   (316) https://bugs.python.org/issue28368

   (317) https://bugs.python.org/issue28369

   (318) https://bugs.python.org/issue28370

   (319) https://bugs.python.org/issue28371

   (320) https://bugs.python.org/issue28372

   (321) https://bugs.python.org/issue28399

   (322) https://bugs.python.org/issue27972

   (323) https://bugs.python.org/issue24142

   (324) https://bugs.python.org/issue29581

   (325) https://bugs.python.org/issue25532

   (326) https://bugs.python.org/issue30177


File: python.info,  Node: Documentation<22>,  Next: Tests<20>,  Prev: Library<23>,  Up: Python 3 7 0 alpha 1

1.18.23.4 Documentation
.......................

   - bpo-31294(1): Fix incomplete code snippet in the
     ZeroMQSocketListener and ZeroMQSocketHandler examples and adapt
     them to Python 3.

   - bpo-21649(2): Add RFC 7525 and Mozilla server side TLS links to SSL
     documentation.

   - bpo-31128(3): Allow the pydoc server to bind to arbitrary
     hostnames.

   - bpo-30803(4): Clarify doc on truth value testing.  Original patch
     by Peter Thomassen.

   - bpo-30176(5): Add missing attribute related constants in curses
     documentation.

   - bpo-30052(6): the link targets for *note bytes(): 326. and *note
     bytearray(): 327. are now their respective type definitions, rather
     than the corresponding builtin function entries.  Use *note bytes:
     ff6. and *note bytearray: ff7. to reference the latter.  In order
     to ensure this and future cross-reference updates are applied
     automatically, the daily documentation builds now disable the
     default output caching features in Sphinx.

   - bpo-26985(7): Add missing info of code object in inspect
     documentation.

   - bpo-19824(8): Improve the documentation for, and links to, template
     strings by emphasizing their utility for internationalization, and
     by clarifying some usage constraints.  (See also: bpo-20314(9),
     bpo-12518(10))

   - bpo-28929(11): Link the documentation to its source file on GitHub.

   - bpo-25008(12): Document smtpd.py as effectively deprecated and add
     a pointer to aiosmtpd, a third-party asyncio-based replacement.

   - bpo-26355(13): Add canonical header link on each page to
     corresponding major version of the documentation.  Patch by
     Matthias Bussonnier.

   - bpo-29349(14): Fix Python 2 syntax in code for building the
     documentation.

   - bpo-23722(15): The data model reference and the porting section in
     the 3.6 What’s New guide now cover the additional ‘__classcell__’
     handling needed for custom metaclasses to fully support PEP 487(16)
     and zero-argument ‘super()’.

   - bpo-28513(17): Documented command-line interface of zipfile.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31294

   (2) https://bugs.python.org/issue21649

   (3) https://bugs.python.org/issue31128

   (4) https://bugs.python.org/issue30803

   (5) https://bugs.python.org/issue30176

   (6) https://bugs.python.org/issue30052

   (7) https://bugs.python.org/issue26985

   (8) https://bugs.python.org/issue19824

   (9) https://bugs.python.org/issue20314

   (10) https://bugs.python.org/issue12518

   (11) https://bugs.python.org/issue28929

   (12) https://bugs.python.org/issue25008

   (13) https://bugs.python.org/issue26355

   (14) https://bugs.python.org/issue29349

   (15) https://bugs.python.org/issue23722

   (16) https://www.python.org/dev/peps/pep-0487

   (17) https://bugs.python.org/issue28513


File: python.info,  Node: Tests<20>,  Next: Build<18>,  Prev: Documentation<22>,  Up: Python 3 7 0 alpha 1

1.18.23.5 Tests
...............

   - bpo-29639(1): test.support.HOST is now “localhost”, a new HOSTv4
     constant has been added for your ‘127.0.0.1’ needs, similar to the
     existing HOSTv6 constant.

   - bpo-31320(2): Silence traceback in test_ssl

   - bpo-31346(3): Prefer PROTOCOL_TLS_CLIENT and PROTOCOL_TLS_SERVER
     protocols for SSLContext.

   - bpo-25674(4): Remove sha256.tbs-internet.com ssl test

   - bpo-30715(5): Address ALPN callback changes for OpenSSL 1.1.0f.
     The latest version behaves like OpenSSL 1.0.2 and no longer aborts
     handshake.

   - bpo-30822(6): regrtest: Exclude tzdata from regrtest –all.  When
     running the test suite using –use=all / -u all, exclude tzdata
     since it makes test_datetime too slow (15-20 min on some buildbots)
     which then times out on some buildbots.  Fix also regrtest command
     line parser to allow passing -u extralargefile to run
     test_zipfile64.

   - bpo-30695(7): Add the ‘set_nomemory(start, stop)’ and
     ‘remove_mem_hooks()’ functions to the _testcapi module.

   - bpo-30357(8): test_thread: setUp() now uses
     support.threading_setup() and support.threading_cleanup() to wait
     until threads complete to avoid random side effects on following
     tests.  Initial patch written by Grzegorz Grzywacz.

   - bpo-30197(9): Enhanced functions swap_attr() and swap_item() in the
     test.support module.  They now work when delete replaced attribute
     or item inside the with statement.  The old value of the attribute
     or item (or None if it doesn’t exist) now will be assigned to the
     target of the “as” clause, if there is one.

   - bpo-24932(10): Use proper command line parsing in _testembed

   - bpo-28950(11): Disallow -j0 to be combined with -T/-l in regrtest
     command line arguments.

   - bpo-28683(12): Fix the tests that bind() a unix socket and raise
     PermissionError on Android for a non-root user.

   - bpo-26936(13): Fix the test_socket failures on Android -
     getservbyname(), getservbyport() and getaddrinfo() are broken on
     some Android API levels.

   - bpo-28666(14): Now test.support.rmtree is able to remove unwritable
     or unreadable directories.

   - bpo-23839(15): Various caches now are cleared before running every
     test file.

   - bpo-26944(16): Fix test_posix for Android where ‘id -G’ is entirely
     wrong or missing the effective gid.

   - bpo-28409(17): regrtest: fix the parser of command line arguments.

   - bpo-28217(18): Adds _testconsole module to test console input.

   - bpo-26939(19): Add the support.setswitchinterval() function to fix
     test_functools hanging on the Android armv7 qemu emulator.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29639

   (2) https://bugs.python.org/issue31320

   (3) https://bugs.python.org/issue31346

   (4) https://bugs.python.org/issue25674

   (5) https://bugs.python.org/issue30715

   (6) https://bugs.python.org/issue30822

   (7) https://bugs.python.org/issue30695

   (8) https://bugs.python.org/issue30357

   (9) https://bugs.python.org/issue30197

   (10) https://bugs.python.org/issue24932

   (11) https://bugs.python.org/issue28950

   (12) https://bugs.python.org/issue28683

   (13) https://bugs.python.org/issue26936

   (14) https://bugs.python.org/issue28666

   (15) https://bugs.python.org/issue23839

   (16) https://bugs.python.org/issue26944

   (17) https://bugs.python.org/issue28409

   (18) https://bugs.python.org/issue28217

   (19) https://bugs.python.org/issue26939


File: python.info,  Node: Build<18>,  Next: Windows<20>,  Prev: Tests<20>,  Up: Python 3 7 0 alpha 1

1.18.23.6 Build
...............

   - bpo-31354(1): Allow –with-lto to be used on all builds, not just
     ‘make profile-opt’.

   - bpo-31370(2): Remove support for building –without-threads.  This
     option is not really useful anymore in the 21st century.  Removing
     lots of conditional paths allows us to simplify the code base,
     including in difficult to maintain low-level internal code.

   - bpo-31341(3): Per PEP 11(4), support for the IRIX operating system
     was removed.

   - bpo-30854(5): Fix compile error when compiling –without-threads.
     Patch by Masayuki Yamamoto.

   - bpo-30687(6): Locate msbuild.exe on Windows when building rather
     than vcvarsall.bat

   - bpo-20210(7): Support the `disabled' marker in Setup files.
     Extension modules listed after this marker are not built at all,
     neither by the Makefile nor by setup.py.

   - bpo-29941(8): Add ‘--with-assertions’ configure flag to explicitly
     enable C ‘assert()’ checks.  Defaults to off.  ‘--with-pydebug’
     implies ‘--with-assertions’.

   - bpo-28787(9): Fix out-of-tree builds of Python when configured with
     ‘--with--dtrace’.

   - bpo-29243(10): Prevent unnecessary rebuilding of Python during
     ‘make test’, ‘make install’ and some other make targets when
     configured with ‘--enable-optimizations’.

   - bpo-23404(11): Don’t regenerate generated files based on file
     modification time anymore: the action is now explicit.  Replace
     ‘make touch’ with ‘make regen-all’.

   - bpo-29643(12): Fix ‘--enable-optimization’ didn’t work.

   - bpo-27593(13): sys.version and the platform module python_build(),
     python_branch(), and python_revision() functions now use git
     information rather than hg when building from a repo.

   - bpo-29572(14): Update Windows build and OS X installers to use
     OpenSSL 1.0.2k.

   - bpo-27659(15): Prohibit implicit C function declarations: use
     ‘-Werror=implicit-function-declaration’ when possible (GCC and
     Clang, but it depends on the compiler version).  Patch written by
     Chi Hsuan Yen.

   - bpo-29384(16): Remove old Be OS helper scripts.

   - bpo-26851(17): Set Android compilation and link flags.

   - bpo-28768(18): Fix implicit declaration of function _setmode.
     Patch by Masayuki Yamamoto

   - bpo-29080(19): Removes hard dependency on hg.exe from
     PCBuild/build.bat

   - bpo-23903(20): Added missed names to PC/python3.def.

   - bpo-28762(21): lockf() is available on Android API level 24, but
     the F_LOCK macro is not defined in android-ndk-r13.

   - bpo-28538(22): Fix the compilation error that occurs because
     if_nameindex() is available on Android API level 24, but the
     if_nameindex structure is not defined.

   - bpo-20211(23): Do not add the directory for installing C header
     files and the directory for installing object code libraries to the
     cross compilation search paths.  Original patch by Thomas
     Petazzoni.

   - bpo-28849(24): Do not define sys.implementation._multiarch on
     Android.

   - bpo-10656(25): Fix out-of-tree building on AIX. Patch by Tristan
     Carel and Michael Haubenwallner.

   - bpo-26359(26): Rename –with-optimiations to –enable-optimizations.

   - bpo-28444(27): Fix missing extensions modules when cross compiling.

   - bpo-28208(28): Update Windows build and OS X installers to use
     SQLite 3.14.2.

   - bpo-28248(29): Update Windows build and OS X installers to use
     OpenSSL 1.0.2j.

   - bpo-21124(30): Fix building the _struct module on Cygwin by passing
     ‘NULL’ instead of ‘&PyType_Type’ to PyVarObject_HEAD_INIT. Patch by
     Masayuki Yamamoto.

   - bpo-13756(31): Fix building extensions modules on Cygwin.  Patch by
     Roumen Petrov, based on original patch by Jason Tishler.

   - bpo-21085(32): Add configure check for siginfo_t.si_band, which
     Cygwin does not provide.  Patch by Masayuki Yamamoto with review
     and rebase by Erik Bray.

   - bpo-28258(33): Fixed build with Estonian locale (python-config and
     distclean targets in Makefile).  Patch by Arfrever Frehtes
     Taifersar Arahesis.

   - bpo-26661(34): setup.py now detects system libffi with multiarch
     wrapper.

   - bpo-27979(35): A full copy of libffi is no longer bundled for use
     when building _ctypes on non-OSX UNIX platforms.  An installed copy
     of libffi is now required when building _ctypes on such platforms.

   - bpo-15819(36): Remove redundant include search directory option for
     building outside the source tree.

   - bpo-28676(37): Prevent missing ‘getentropy’ declaration warning on
     macOS. Patch by Gareth Rees.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31354

   (2) https://bugs.python.org/issue31370

   (3) https://bugs.python.org/issue31341

   (4) https://www.python.org/dev/peps/pep-0011

   (5) https://bugs.python.org/issue30854

   (6) https://bugs.python.org/issue30687

   (7) https://bugs.python.org/issue20210

   (8) https://bugs.python.org/issue29941

   (9) https://bugs.python.org/issue28787

   (10) https://bugs.python.org/issue29243

   (11) https://bugs.python.org/issue23404

   (12) https://bugs.python.org/issue29643

   (13) https://bugs.python.org/issue27593

   (14) https://bugs.python.org/issue29572

   (15) https://bugs.python.org/issue27659

   (16) https://bugs.python.org/issue29384

   (17) https://bugs.python.org/issue26851

   (18) https://bugs.python.org/issue28768

   (19) https://bugs.python.org/issue29080

   (20) https://bugs.python.org/issue23903

   (21) https://bugs.python.org/issue28762

   (22) https://bugs.python.org/issue28538

   (23) https://bugs.python.org/issue20211

   (24) https://bugs.python.org/issue28849

   (25) https://bugs.python.org/issue10656

   (26) https://bugs.python.org/issue26359

   (27) https://bugs.python.org/issue28444

   (28) https://bugs.python.org/issue28208

   (29) https://bugs.python.org/issue28248

   (30) https://bugs.python.org/issue21124

   (31) https://bugs.python.org/issue13756

   (32) https://bugs.python.org/issue21085

   (33) https://bugs.python.org/issue28258

   (34) https://bugs.python.org/issue26661

   (35) https://bugs.python.org/issue27979

   (36) https://bugs.python.org/issue15819

   (37) https://bugs.python.org/issue28676


File: python.info,  Node: Windows<20>,  Next: IDLE<22>,  Prev: Build<18>,  Up: Python 3 7 0 alpha 1

1.18.23.7 Windows
.................

   - bpo-31392(1): Update Windows build to use OpenSSL 1.1.0f

   - bpo-30389(2): Adds detection of Visual Studio 2017 to distutils on
     Windows.

   - bpo-31358(3): zlib is no longer bundled in the CPython source,
     instead it is downloaded on demand just like bz2, lzma, OpenSSL,
     Tcl/Tk, and SQLite.

   - bpo-31340(4): Change to building with MSVC v141 (included with
     Visual Studio 2017)

   - bpo-30581(5): os.cpu_count() now returns the correct number of
     processors on Windows when the number of logical processors is
     greater than 64.

   - bpo-30916(6): Pre-build OpenSSL, Tcl and Tk and include the
     binaries in the build.

   - bpo-30731(7): Add a missing xmlns to python.manifest so that it
     matches the schema.

   - bpo-30291(8): Allow requiring 64-bit interpreters from py.exe using
     -64 suffix.  Contributed by Steve (Gadget) Barnes.

   - bpo-30362(9): Adds list options (-0, -0p) to py.exe launcher.
     Contributed by Steve Barnes.

   - bpo-23451(10): Fix socket deprecation warnings in socketmodule.c.
     Patch by Segev Finer.

   - bpo-30450(11): The build process on Windows no longer depends on
     Subversion, instead pulling external code from GitHub via a Python
     script.  If Python 3.6 is not found on the system (via ‘py -3.6’),
     NuGet is used to download a copy of 32-bit Python.

   - bpo-29579(12): Removes readme.txt from the installer.

   - bpo-25778(13): winreg does not truncate string correctly (Patch by
     Eryk Sun)

   - bpo-28896(14): Deprecate WindowsRegistryFinder and disable it by
     default

   - bpo-28522(15): Fixes mishandled buffer reallocation in getpathp.c

   - bpo-28402(16): Adds signed catalog files for stdlib on Windows.

   - bpo-28333(17): Enables Unicode for ps1/ps2 and input() prompts.
     (Patch by Eryk Sun)

   - bpo-28251(18): Improvements to help manuals on Windows.

   - bpo-28110(19): launcher.msi has different product codes between
     32-bit and 64-bit

   - bpo-28161(20): Opening CON for write access fails

   - bpo-28162(21): WindowsConsoleIO readall() fails if first line
     starts with Ctrl+Z

   - bpo-28163(22): WindowsConsoleIO fileno() passes wrong flags to
     _open_osfhandle

   - bpo-28164(23): _PyIO_get_console_type fails for various paths

   - bpo-28137(24): Renames Windows path file to ._pth

   - bpo-28138(25): Windows ._pth file should allow import site

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31392

   (2) https://bugs.python.org/issue30389

   (3) https://bugs.python.org/issue31358

   (4) https://bugs.python.org/issue31340

   (5) https://bugs.python.org/issue30581

   (6) https://bugs.python.org/issue30916

   (7) https://bugs.python.org/issue30731

   (8) https://bugs.python.org/issue30291

   (9) https://bugs.python.org/issue30362

   (10) https://bugs.python.org/issue23451

   (11) https://bugs.python.org/issue30450

   (12) https://bugs.python.org/issue29579

   (13) https://bugs.python.org/issue25778

   (14) https://bugs.python.org/issue28896

   (15) https://bugs.python.org/issue28522

   (16) https://bugs.python.org/issue28402

   (17) https://bugs.python.org/issue28333

   (18) https://bugs.python.org/issue28251

   (19) https://bugs.python.org/issue28110

   (20) https://bugs.python.org/issue28161

   (21) https://bugs.python.org/issue28162

   (22) https://bugs.python.org/issue28163

   (23) https://bugs.python.org/issue28164

   (24) https://bugs.python.org/issue28137

   (25) https://bugs.python.org/issue28138


File: python.info,  Node: IDLE<22>,  Next: Tools/Demos<14>,  Prev: Windows<20>,  Up: Python 3 7 0 alpha 1

1.18.23.8 IDLE
..............

   - bpo-31493(1): IDLE code context – fix code update and font update
     timers.  Canceling timers prevents a warning message when test_idle
     completes.

   - bpo-31488(2): IDLE - Update non-key options in former extension
     classes.  When applying configdialog changes, call .reload for each
     feature class.  Change ParenMatch so updated options affect
     existing instances attached to existing editor windows.

   - bpo-31477(3): IDLE - Improve rstrip entry in doc.  Strip trailing
     whitespace strips more than blank spaces.  Multiline string
     literals are not skipped.

   - bpo-31480(4): IDLE - make tests pass with zzdummy extension
     disabled by default.

   - bpo-31421(5): Document how IDLE runs tkinter programs.  IDLE calls
     tcl/tk update in the background in order to make live interaction
     and experimentation with tkinter applications much easier.

   - bpo-31414(6): IDLE – fix tk entry box tests by deleting first.
     Adding to an int entry is not the same as deleting and inserting
     because int(‘’) will fail.

   - bpo-31051(7): Rearrange IDLE configdialog GenPage into Window,
     Editor, and Help sections.

   - bpo-30617(8): IDLE - Add docstrings and tests for outwin subclass
     of editor.  Move some data and functions from the class to module
     level.  Patch by Cheryl Sabella.

   - bpo-31287(9): IDLE - Do not modify tkinter.message in
     test_configdialog.

   - bpo-27099(10): Convert IDLE’s built-in ‘extensions’ to regular
     features.  About 10 IDLE features were implemented as supposedly
     optional extensions.  Their different behavior could be confusing
     or worse for users and not good for maintenance.  Hence the
     conversion.  The main difference for users is that user
     configurable key bindings for builtin features are now handled
     uniformly.  Now, editing a binding in a keyset only affects its
     value in the keyset.  All bindings are defined together in the
     system-specific default keysets in config-extensions.def.  All
     custom keysets are saved as a whole in config-extension.cfg.  All
     take effect as soon as one clicks Apply or Ok.  The affected events
     are ‘<<force-open-completions>>’, ‘<<expand-word>>’,
     ‘<<force-open-calltip>>’, ‘<<flash-paren>>’,
     ‘<<format-paragraph>>’, ‘<<run-module>>’, ‘<<check-module>>’, and
     ‘<<zoom-height>>’.  Any (global) customizations made before 3.6.3
     will not affect their keyset-specific customization after 3.6.3.
     and vice versa.  Initial patch by Charles Wohlganger.

   - bpo-31206(11): IDLE: Factor HighPage(Frame) class from
     ConfigDialog.  Patch by Cheryl Sabella.

   - bpo-31001(12): Add tests for configdialog highlight tab.  Patch by
     Cheryl Sabella.

   - bpo-31205(13): IDLE: Factor KeysPage(Frame) class from
     ConfigDialog.  The slightly modified tests continue to pass.  Patch
     by Cheryl Sabella.

   - bpo-31130(14): IDLE – stop leaks in test_configdialog.  Initial
     patch by Victor Stinner.

   - bpo-31002(15): Add tests for configdialog keys tab.  Patch by
     Cheryl Sabella.

   - bpo-19903(16): IDLE: Calltips use *note inspect.signature: 550.
     instead of *note inspect.getfullargspec: 552.  This improves
     calltips for builtins converted to use Argument Clinic.  Patch by
     Louie Lu.

   - bpo-31083(17): IDLE - Add an outline of a TabPage class in
     configdialog.  Update existing classes to match outline.  Initial
     patch by Cheryl Sabella.

   - bpo-31050(18): Factor GenPage(Frame) class from ConfigDialog.  The
     slightly modified tests continue to pass.  Patch by Cheryl Sabella.

   - bpo-31004(19): IDLE - Factor FontPage(Frame) class from
     ConfigDialog.  Slightly modified tests continue to pass.  Fix
     General tests.  Patch mostly by Cheryl Sabella.

   - bpo-30781(20): IDLE - Use ttk widgets in ConfigDialog.  Patches by
     Terry Jan Reedy and Cheryl Sabella.

   - bpo-31060(21): IDLE - Finish rearranging methods of ConfigDialog
     Grouping methods pertaining to each tab and the buttons will aid
     writing tests and improving the tabs and will enable splitting the
     groups into classes.

   - bpo-30853(22): IDLE – Factor a VarTrace class out of ConfigDialog.
     Instance tracers manages pairs consisting of a tk variable and a
     callback function.  When tracing is turned on, setting the variable
     calls the function.  Test coverage for the new class is 100%.

   - bpo-31003(23): IDLE: Add more tests for General tab.

   - bpo-30993(24): IDLE - Improve configdialog font page and tests.  In
     configdialog: Document causal pathways in create_font_tab
     docstring.  Simplify some attribute names.  Move set_samples calls
     to var_changed_font (idea from Cheryl Sabella).  Move related
     functions to positions after the create widgets function.  In
     test_configdialog: Fix test_font_set so not order dependent.  Fix
     renamed test_indent_scale so it tests the widget.  Adjust tests for
     movement of set_samples call.  Add tests for load functions.  Put
     all font tests in one class and tab indent tests in another.
     Except for two lines, these tests completely cover the related
     functions.

   - bpo-30981(25): IDLE – Add more configdialog font page tests.

   - bpo-28523(26): IDLE: replace ‘colour’ with ‘color’ in configdialog.

   - bpo-30917(27): Add tests for idlelib.config.IdleConf.  Increase
     coverage from 46% to 96%.  Patch by Louie Lu.

   - bpo-30934(28): Document coverage details for idlelib tests.  Add
     section to idlelib/idle-test/README.txt.  Include check that
     branches are taken both ways.  Exclude IDLE-specific code that does
     not run during unit tests.

   - bpo-30913(29): IDLE: Document ConfigDialog tk Vars, methods, and
     widgets in docstrings This will facilitate improving the dialog and
     splitting up the class.  Original patch by Cheryl Sabella.

   - bpo-30899(30): IDLE: Add tests for ConfigParser subclasses in
     config.  Patch by Louie Lu.

   - bpo-30881(31): IDLE: Add docstrings to browser.py.  Patch by Cheryl
     Sabella.

   - bpo-30851(32): IDLE: Remove unused variables in configdialog.  One
     is a duplicate, one is set but cannot be altered by users.  Patch
     by Cheryl Sabella.

   - bpo-30870(33): IDLE: In Settings dialog, select font with Up, Down
     keys as well as mouse.  Initial patch by Louie Lu.

   - bpo-8231(34): IDLE: call config.IdleConf.GetUserCfgDir only once.

   - bpo-30779(35): IDLE: Factor ConfigChanges class from configdialog,
     put in config; test.  * In config, put dump test code in a
     function; run it and unittest in ‘if __name__ == ‘__main__’.  * Add
     class config.ConfigChanges based on changes_class_v4.py on bpo
     issue.  * Add class test_config.ChangesTest, partly using
     configdialog_tests_v1.py.  * Revise configdialog to use
     ConfigChanges; see tracker msg297804.  * Revise test_configdialog
     to match configdialog changes.  * Remove configdialog functions
     unused or moved to ConfigChanges.  Cheryl Sabella contributed parts
     of the patch.

   - bpo-30777(36): IDLE: configdialog - Add docstrings and fix
     comments.  Patch by Cheryl Sabella.

   - bpo-30495(37): IDLE: Improve textview with docstrings, PEP8 names,
     and more tests.  Patch by Cheryl Sabella.

   - bpo-30723(38): IDLE: Make several improvements to parenmatch.  Add
     ‘parens’ style to highlight both opener and closer.  Make ‘default’
     style, which is not default, a synonym for ‘opener’.  Make
     time-delay work the same with all styles.  Add help for config
     dialog extensions tab, including help for parenmatch.  Add new
     tests.  Original patch by Charles Wohlganger.

   - bpo-30674(39): IDLE: add docstrings to grep module.  Patch by
     Cheryl Sabella

   - bpo-21519(40): IDLE’s basic custom key entry dialog now detects
     duplicates properly.  Original patch by Saimadhav Heblikar.

   - bpo-29910(41): IDLE no longer deletes a character after commenting
     out a region by a key shortcut.  Add ‘return 'break'’ for this and
     other potential conflicts between IDLE and default key bindings.

   - bpo-30728(42): Review and change idlelib.configdialog names.
     Lowercase method and attribute names.  Replace ‘colour’ with
     ‘color’, expand overly cryptic names, delete unneeded underscores.
     Replace ‘import *’ with specific imports.  Patches by Cheryl
     Sabella.

   - bpo-6739(43): IDLE: Verify user-entered key sequences by trying to
     bind them with tk.  Add tests for all 3 validation functions.
     Original patch by G Polo.  Tests added by Cheryl Sabella.

   - bpo-15786(44): Fix several problems with IDLE’s autocompletion box.
     The following should now work: clicking on selection box items;
     using the scrollbar; selecting an item by hitting Return.  Hangs on
     MacOSX should no longer happen.  Patch by Louie Lu.

   - bpo-25514(45): Add doc subsubsection about IDLE failure to start.
     Popup no-connection message directs users to this section.

   - bpo-30642(46): Fix reference leaks in IDLE tests.  Patches by Louie
     Lu and Terry Jan Reedy.

   - bpo-30495(47): Add docstrings for textview.py and use PEP8 names.
     Patches by Cheryl Sabella and Terry Jan Reedy.

   - bpo-30290(48): Help-about: use pep8 names and add tests.  Increase
     coverage to 100%.  Patches by Louie Lu, Cheryl Sabella, and Terry
     Jan Reedy.

   - bpo-30303(49): Add _utest option to textview; add new tests.
     Increase coverage to 100%.  Patches by Louie Lu and Terry Jan
     Reedy.

   - bpo-29071(50): IDLE colors f-string prefixes (but not invalid ur
     prefixes).

   - bpo-28572(51): Add 10% to coverage of IDLE’s test_configdialog.
     Update and augment description of the configuration system.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31493

   (2) https://bugs.python.org/issue31488

   (3) https://bugs.python.org/issue31477

   (4) https://bugs.python.org/issue31480

   (5) https://bugs.python.org/issue31421

   (6) https://bugs.python.org/issue31414

   (7) https://bugs.python.org/issue31051

   (8) https://bugs.python.org/issue30617

   (9) https://bugs.python.org/issue31287

   (10) https://bugs.python.org/issue27099

   (11) https://bugs.python.org/issue31206

   (12) https://bugs.python.org/issue31001

   (13) https://bugs.python.org/issue31205

   (14) https://bugs.python.org/issue31130

   (15) https://bugs.python.org/issue31002

   (16) https://bugs.python.org/issue19903

   (17) https://bugs.python.org/issue31083

   (18) https://bugs.python.org/issue31050

   (19) https://bugs.python.org/issue31004

   (20) https://bugs.python.org/issue30781

   (21) https://bugs.python.org/issue31060

   (22) https://bugs.python.org/issue30853

   (23) https://bugs.python.org/issue31003

   (24) https://bugs.python.org/issue30993

   (25) https://bugs.python.org/issue30981

   (26) https://bugs.python.org/issue28523

   (27) https://bugs.python.org/issue30917

   (28) https://bugs.python.org/issue30934

   (29) https://bugs.python.org/issue30913

   (30) https://bugs.python.org/issue30899

   (31) https://bugs.python.org/issue30881

   (32) https://bugs.python.org/issue30851

   (33) https://bugs.python.org/issue30870

   (34) https://bugs.python.org/issue8231

   (35) https://bugs.python.org/issue30779

   (36) https://bugs.python.org/issue30777

   (37) https://bugs.python.org/issue30495

   (38) https://bugs.python.org/issue30723

   (39) https://bugs.python.org/issue30674

   (40) https://bugs.python.org/issue21519

   (41) https://bugs.python.org/issue29910

   (42) https://bugs.python.org/issue30728

   (43) https://bugs.python.org/issue6739

   (44) https://bugs.python.org/issue15786

   (45) https://bugs.python.org/issue25514

   (46) https://bugs.python.org/issue30642

   (47) https://bugs.python.org/issue30495

   (48) https://bugs.python.org/issue30290

   (49) https://bugs.python.org/issue30303

   (50) https://bugs.python.org/issue29071

   (51) https://bugs.python.org/issue28572


File: python.info,  Node: Tools/Demos<14>,  Next: C API<16>,  Prev: IDLE<22>,  Up: Python 3 7 0 alpha 1

1.18.23.9 Tools/Demos
.....................

   - bpo-30983(1): gdb integration commands (py-bt, etc.)  work on
     optimized shared builds now, too.  PEP 523(2) introduced
     _PyEval_EvalFrameDefault which inlines PyEval_EvalFrameEx on
     non-debug shared builds.  This broke the ability to use py-bt,
     py-up, and a few other Python-specific gdb integrations.  The
     problem is fixed by only looking for _PyEval_EvalFrameDefault
     frames in python-gdb.py.  Original patch by Bruno “Polaco”
     Penteado.

   - bpo-29748(3): Added the slice index converter in Argument Clinic.

   - bpo-24037(4): Argument Clinic now uses the converter
     ‘bool(accept={int})’ rather than *note int: 184. for semantical
     booleans.  This avoids repeating the default value for Python and C
     and will help in converting to *note bool: 183. in future.

   - bpo-29367(5): python-gdb.py now supports also ‘method-wrapper’
     (‘wrapperobject’) objects.

   - bpo-28023(6): Fix python-gdb.py didn’t support new dict
     implementation.

   - bpo-15369(7): The pybench and pystone microbenchmark have been
     removed from Tools.  Please use the new Python benchmark suite
     ‘https://github.com/python/performance’ which is more reliable and
     includes a portable version of pybench working on Python 2 and
     Python 3.

   - bpo-28102(8): The zipfile module CLI now prints usage to stderr.
     Patch by Stephen J. Turnbull.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30983

   (2) https://www.python.org/dev/peps/pep-0523

   (3) https://bugs.python.org/issue29748

   (4) https://bugs.python.org/issue24037

   (5) https://bugs.python.org/issue29367

   (6) https://bugs.python.org/issue28023

   (7) https://bugs.python.org/issue15369

   (8) https://bugs.python.org/issue28102


File: python.info,  Node: C API<16>,  Prev: Tools/Demos<14>,  Up: Python 3 7 0 alpha 1

1.18.23.10 C API
................

   - bpo-31338(1): Added the ‘Py_UNREACHABLE()’ macro for code paths
     which are never expected to be reached.  This and a few other
     useful macros are now documented in the C API manual.

   - bpo-30832(2): Remove own implementation for thread-local storage.
     CPython has provided the own implementation for thread-local
     storage (TLS) on Python/thread.c, it’s used in the case which a
     platform has not supplied native TLS. However, currently all
     supported platforms (Windows and pthreads) have provided native TLS
     and defined the Py_HAVE_NATIVE_TLS macro with unconditional in any
     case.

   - bpo-30708(3): PyUnicode_AsWideCharString() now raises a ValueError
     if the second argument is NULL and the wchar_t* string contains
     null characters.

   - bpo-16500(4): Deprecate PyOS_AfterFork() and add PyOS_BeforeFork(),
     PyOS_AfterFork_Parent() and PyOS_AfterFork_Child().

   - bpo-6532(5): The type of results of PyThread_start_new_thread() and
     PyThread_get_thread_ident(), and the id parameter of
     PyThreadState_SetAsyncExc() changed from “long” to “unsigned long”.

   - bpo-27867(6): Function PySlice_GetIndicesEx() is deprecated and
     replaced with a macro if Py_LIMITED_API is not set or set to the
     value between 0x03050400 and 0x03060000 (not including) or
     0x03060100 or higher.  Added functions PySlice_Unpack() and
     PySlice_AdjustIndices().

   - bpo-29083(7): Fixed the declaration of some public API functions.
     PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not
     available in limited API. PyArg_ValidateKeywordArguments(),
     PyArg_UnpackTuple() and Py_BuildValue() were not available in
     limited API of version < 3.3 when PY_SSIZE_T_CLEAN is defined.

   - bpo-28769(8): The result of PyUnicode_AsUTF8AndSize() and
     PyUnicode_AsUTF8() is now of type ‘const char *’ rather of ‘char
     *’.

   - bpo-29058(9): All stable API extensions added after Python 3.2 are
     now available only when Py_LIMITED_API is set to the PY_VERSION_HEX
     value of the minimum Python version supporting this API.

   - bpo-28822(10): The index parameters `start' and `end' of
     PyUnicode_FindChar() are now adjusted to behave like
     ‘str[start:end]’.

   - bpo-28808(11): PyUnicode_CompareWithASCIIString() now never raises
     exceptions.

   - bpo-28761(12): The fields name and doc of structures PyMemberDef,
     PyGetSetDef, PyStructSequence_Field, PyStructSequence_Desc, and
     wrapperbase are now of type ‘const char *’ rather of ‘char *’.

   - bpo-28748(13): Private variable _Py_PackageContext is now of type
     ‘const char *’ rather of ‘char *’.

   - bpo-19569(14): Compiler warnings are now emitted if use most of
     deprecated functions.

   - bpo-28426(15): Deprecated undocumented functions
     PyUnicode_AsEncodedObject(), PyUnicode_AsDecodedObject(),
     PyUnicode_AsDecodedUnicode() and PyUnicode_AsEncodedUnicode().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31338

   (2) https://bugs.python.org/issue30832

   (3) https://bugs.python.org/issue30708

   (4) https://bugs.python.org/issue16500

   (5) https://bugs.python.org/issue6532

   (6) https://bugs.python.org/issue27867

   (7) https://bugs.python.org/issue29083

   (8) https://bugs.python.org/issue28769

   (9) https://bugs.python.org/issue29058

   (10) https://bugs.python.org/issue28822

   (11) https://bugs.python.org/issue28808

   (12) https://bugs.python.org/issue28761

   (13) https://bugs.python.org/issue28748

   (14) https://bugs.python.org/issue19569

   (15) https://bugs.python.org/issue28426


File: python.info,  Node: Python 3 6 6 final,  Next: Python 3 6 6 release candidate 1,  Prev: Python 3 7 0 alpha 1,  Up: Changelog

1.18.24 Python 3.6.6 final
--------------------------

`Release date: 2018-06-27'

There were no new changes in version 3.6.6.


File: python.info,  Node: Python 3 6 6 release candidate 1,  Next: Python 3 6 5 final,  Prev: Python 3 6 6 final,  Up: Changelog

1.18.25 Python 3.6.6 release candidate 1
----------------------------------------

`Release date: 2018-06-11'

* Menu:

* Core and Builtins: Core and Builtins<23>.
* Library: Library<24>.
* Documentation: Documentation<23>.
* Tests: Tests<21>.
* Build: Build<19>.
* Windows: Windows<21>.
* macOS: macOS<15>.
* IDLE: IDLE<23>.
* Tools/Demos: Tools/Demos<15>.
* C API: C API<17>.


File: python.info,  Node: Core and Builtins<23>,  Next: Library<24>,  Up: Python 3 6 6 release candidate 1

1.18.25.1 Core and Builtins
...........................

   - bpo-33786(1): Fix asynchronous generators to handle GeneratorExit
     in athrow() correctly

   - bpo-30654(2): Fixed reset of the SIGINT handler to SIG_DFL on
     interpreter shutdown even when there was a custom handler set
     previously.  Patch by Philipp Kerling.

   - bpo-33622(3): Fixed a leak when the garbage collector fails to add
     an object with the ‘__del__’ method or referenced by it into the
     *note gc.garbage: b33. list.  ‘PyGC_Collect()’ can now be called
     when an exception is set and preserves it.

   - bpo-31849(4): Fix signed/unsigned comparison warning in pyhash.c.

   - bpo-33391(5): Fix a leak in set_symmetric_difference().

   - bpo-28055(6): Fix unaligned accesses in siphash24().  Patch by Rolf
     Eike Beer.

   - bpo-33231(7): Fix potential memory leak in ‘normalizestring()’.

   - bpo-29922(8): Improved error messages in ‘async with’ when
     ‘__aenter__()’ or ‘__aexit__()’ return non-awaitable object.

   - bpo-33199(9): Fix ‘ma_version_tag’ in dict implementation is
     uninitialized when copying from key-sharing dict.

   - bpo-33041(10): Fixed jumping when the function contains an ‘async
     for’ loop.

   - bpo-32282(11): Fix an unnecessary ifdef in the include of
     VersionHelpers.h in socketmodule on Windows.

   - bpo-21983(12): Fix a crash in *note ctypes.cast(): f4a. in case the
     type argument is a ctypes structured data type.  Patch by Eryk Sun
     and Oren Milman.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33786

   (2) https://bugs.python.org/issue30654

   (3) https://bugs.python.org/issue33622

   (4) https://bugs.python.org/issue31849

   (5) https://bugs.python.org/issue33391

   (6) https://bugs.python.org/issue28055

   (7) https://bugs.python.org/issue33231

   (8) https://bugs.python.org/issue29922

   (9) https://bugs.python.org/issue33199

   (10) https://bugs.python.org/issue33041

   (11) https://bugs.python.org/issue32282

   (12) https://bugs.python.org/issue21983


File: python.info,  Node: Library<24>,  Next: Documentation<23>,  Prev: Core and Builtins<23>,  Up: Python 3 6 6 release candidate 1

1.18.25.2 Library
.................

   - bpo-30167(1): Prevent site.main() exception if PYTHONSTARTUP is
     set.  Patch by Steve Weber.

   - bpo-33812(2): Datetime instance d with non-None tzinfo, but with
     d.tzinfo.utcoffset(d) returning None is now treated as naive by the
     astimezone() method.

   - bpo-30805(3): Avoid race condition with debug logging

   - bpo-33767(4): The concatenation (‘+’) and repetition (‘*’) sequence
     operations now raise *note TypeError: 192. instead of *note
     SystemError: 5f0. when performed on *note mmap.mmap: 1ea. objects.
     Patch by Zackery Spytz.

   - bpo-32684(5): Fix gather to propagate cancellation of itself even
     with return_exceptions.

   - bpo-33674(6): Fix a race condition in SSLProtocol.connection_made()
     of asyncio.sslproto: start immediately the handshake instead of
     using call_soon().  Previously, data_received() could be called
     before the handshake started, causing the handshake to hang or
     fail.

   - bpo-31647(7): Fixed bug where calling write_eof() on a
     _SelectorSocketTransport after it’s already closed raises
     AttributeError.

   - bpo-33672(8): Fix Task.__repr__ crash with Cython’s bogus
     coroutines

   - bpo-33469(9): Fix RuntimeError after closing loop that used
     run_in_executor

   - bpo-11874(10): Use a better regex when breaking usage into
     wrappable parts.  Avoids bogus assertion errors from custom metavar
     strings.

   - bpo-30877(11): Fixed a bug in the Python implementation of the JSON
     decoder that prevented the cache of parsed strings from clearing
     after finishing the decoding.  Based on patch by c-fos.

   - bpo-33548(12): tempfile._candidate_tempdir_list should consider
     common TEMP locations

   - bpo-33542(13): Prevent ‘uuid.get_node’ from using a DUID instead of
     a MAC on Windows.  Patch by Zvi Effron

   - bpo-26819(14): Fix race condition with
     ‘ReadTransport.resume_reading’ in Windows proactor event loop.

   - bpo-28556(15): Minor fixes in typing module: add annotations to
     ‘NamedTuple.__new__’, pass ‘*args’ and ‘**kwds’ in
     ‘Generic.__new__’.  Original PRs by Paulius Šarka and Chad
     Dombrova.

   - bpo-20087(16): Updated alias mapping with glibc 2.27 supported
     locales.

   - bpo-33422(17): Fix trailing quotation marks getting deleted when
     looking up byte/string literals on pydoc.  Patch by Andrés Delfino.

   - bpo-33197(18): Update error message when constructing invalid
     inspect.Parameters Patch by Dong-hee Na.

   - bpo-33383(19): Fixed crash in the get() method of the *note
     dbm.ndbm: 35. database object when it is called with a single
     argument.

   - bpo-33329(20): Fix multiprocessing regression on newer glibcs

   - bpo-991266(21): Fix quoting of the ‘Comment’ attribute of *note
     http.cookies.SimpleCookie: f70.

   - bpo-33131(22): Upgrade bundled version of pip to 10.0.1.

   - bpo-33308(23): Fixed a crash in the *note parser: c7. module when
     converting an ST object to a tree of tuples or lists with
     ‘line_info=False’ and ‘col_info=True’.

   - bpo-33263(24): Fix FD leak in ‘_SelectorSocketTransport’ Patch by
     Vlad Starostin.

   - bpo-33256(25): Fix display of ‘<module>’ call in the html produced
     by ‘cgitb.html()’.  Patch by Stéphane Blondon.

   - bpo-33203(26): ‘random.Random.choice()’ now raises ‘IndexError’ for
     empty sequences consistently even when called from subclasses
     without a ‘getrandbits()’ implementation.

   - bpo-33224(27): Update difflib.mdiff() for PEP 479(28).  Convert an
     uncaught StopIteration in a generator into a return-statement.

   - bpo-33209(29): End framing at the end of C implementation of *note
     pickle.Pickler.dump(): f74.

   - bpo-32861(30): The urllib.robotparser’s ‘__str__’ representation
     now includes wildcard entries and the “Crawl-delay” and
     “Request-rate” fields.  Patch by Michael Lazar.

   - bpo-33096(31): Allow ttk.Treeview.insert to insert iid that has a
     false boolean value.  Note iid=0 and iid=False would be same.
     Patch by Garvit Khatri.

   - bpo-33127(32): The ssl module now compiles with LibreSSL 2.7.1.

   - bpo-33021(33): Release the GIL during fstat() calls, avoiding hang
     of all threads when calling mmap.mmap(), os.urandom(), and
     random.seed().  Patch by Nir Soffer.

   - bpo-27683(34): Fix a regression in *note ipaddress: a2. that result
     of ‘hosts()’ is empty when the network is constructed by a tuple
     containing an integer mask and only 1 bit left for addresses.

   - bpo-32844(35): Fix wrong redirection of a low descriptor (0 or 1)
     to stderr in subprocess if another low descriptor is closed.

   - bpo-31908(36): Fix output of cover files for ‘trace’ module
     command-line tool.  Previously emitted cover files only when
     ‘--missing’ option was used.  Patch by Michael Selik.

   - bpo-31457(37): If nested log adapters are used, the inner
     ‘process()’ methods are no longer omitted.

   - bpo-16865(38): Support arrays >=2GiB in *note ctypes: 2b.  Patch by
     Segev Finer.

   - bpo-31238(39): pydoc: the stop() method of the private ServerThread
     class now waits until DocServer.serve_until_quit() completes and
     then explicitly sets its docserver attribute to None to break a
     reference cycle.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30167

   (2) https://bugs.python.org/issue33812

   (3) https://bugs.python.org/issue30805

   (4) https://bugs.python.org/issue33767

   (5) https://bugs.python.org/issue32684

   (6) https://bugs.python.org/issue33674

   (7) https://bugs.python.org/issue31647

   (8) https://bugs.python.org/issue33672

   (9) https://bugs.python.org/issue33469

   (10) https://bugs.python.org/issue11874

   (11) https://bugs.python.org/issue30877

   (12) https://bugs.python.org/issue33548

   (13) https://bugs.python.org/issue33542

   (14) https://bugs.python.org/issue26819

   (15) https://bugs.python.org/issue28556

   (16) https://bugs.python.org/issue20087

   (17) https://bugs.python.org/issue33422

   (18) https://bugs.python.org/issue33197

   (19) https://bugs.python.org/issue33383

   (20) https://bugs.python.org/issue33329

   (21) https://bugs.python.org/issue991266

   (22) https://bugs.python.org/issue33131

   (23) https://bugs.python.org/issue33308

   (24) https://bugs.python.org/issue33263

   (25) https://bugs.python.org/issue33256

   (26) https://bugs.python.org/issue33203

   (27) https://bugs.python.org/issue33224

   (28) https://www.python.org/dev/peps/pep-0479

   (29) https://bugs.python.org/issue33209

   (30) https://bugs.python.org/issue32861

   (31) https://bugs.python.org/issue33096

   (32) https://bugs.python.org/issue33127

   (33) https://bugs.python.org/issue33021

   (34) https://bugs.python.org/issue27683

   (35) https://bugs.python.org/issue32844

   (36) https://bugs.python.org/issue31908

   (37) https://bugs.python.org/issue31457

   (38) https://bugs.python.org/issue16865

   (39) https://bugs.python.org/issue31238


File: python.info,  Node: Documentation<23>,  Next: Tests<21>,  Prev: Library<24>,  Up: Python 3 6 6 release candidate 1

1.18.25.3 Documentation
.......................

   - bpo-33503(1): Fix broken pypi link

   - bpo-33421(2): Add missing documentation for
     ‘typing.AsyncContextManager’.

   - bpo-33378(3): Add Korean language switcher for
     ‘https://docs.python.org/3/’

   - bpo-33276(4): Clarify that the ‘__path__’ attribute on modules
     cannot be just any value.

   - bpo-33201(5): Modernize documentation for writing C extension
     types.

   - bpo-33195(6): Deprecate ‘Py_UNICODE’ usage in ‘c-api/arg’ document.
     ‘Py_UNICODE’ related APIs are deprecated since Python 3.3, but it
     is missed in the document.

   - bpo-33126(7): Document PyBuffer_ToContiguous().

   - bpo-27212(8): Modify documentation for the ‘islice()’ recipe to
     consume initial values up to the start index.

   - bpo-28247(9): Update *note zipapp: 141. documentation to describe
     how to make standalone applications.

   - bpo-18802(10): Documentation changes for ipaddress.  Patch by Jon
     Foster and Berker Peksag.

   - bpo-27428(11): Update documentation to clarify that
     ‘WindowsRegistryFinder’ implements ‘MetaPathFinder’.  (Patch by
     Himanshu Lakhara)

   - bpo-8243(12): Add a note about curses.addch and curses.addstr
     exception behavior when writing outside a window, or pad.

   - bpo-31432(13): Clarify meaning of CERT_NONE, CERT_OPTIONAL, and
     CERT_REQUIRED flags for ssl.SSLContext.verify_mode.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33503

   (2) https://bugs.python.org/issue33421

   (3) https://bugs.python.org/issue33378

   (4) https://bugs.python.org/issue33276

   (5) https://bugs.python.org/issue33201

   (6) https://bugs.python.org/issue33195

   (7) https://bugs.python.org/issue33126

   (8) https://bugs.python.org/issue27212

   (9) https://bugs.python.org/issue28247

   (10) https://bugs.python.org/issue18802

   (11) https://bugs.python.org/issue27428

   (12) https://bugs.python.org/issue8243

   (13) https://bugs.python.org/issue31432


File: python.info,  Node: Tests<21>,  Next: Build<19>,  Prev: Documentation<23>,  Up: Python 3 6 6 release candidate 1

1.18.25.4 Tests
...............

   - bpo-33655(1): Ignore test_posix_fallocate failures on BSD platforms
     that might be due to running on ZFS.

   - bpo-19417(2): Add test_bdb.py.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33655

   (2) https://bugs.python.org/issue19417


File: python.info,  Node: Build<19>,  Next: Windows<21>,  Prev: Tests<21>,  Up: Python 3 6 6 release candidate 1

1.18.25.5 Build
...............

   - bpo-5755(1): Move ‘-Wstrict-prototypes’ option to ‘CFLAGS_NODIST’
     from ‘OPT’.  This option emitted annoying warnings when building
     extension modules written in C++.

   - bpo-33614(2): Ensures module definition files for the stable ABI on
     Windows are correctly regenerated.

   - bpo-33522(3): Enable CI builds on Visual Studio Team Services at
     ‘https://python.visualstudio.com/cpython’

   - bpo-33012(4): Add ‘-Wno-cast-function-type’ for gcc 8 for silencing
     warnings about function casts like casting to PyCFunction in method
     definition lists.

   - bpo-33394(5): Enable the verbose build for extension modules, when
     GNU make is passed macros on the command line.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5755

   (2) https://bugs.python.org/issue33614

   (3) https://bugs.python.org/issue33522

   (4) https://bugs.python.org/issue33012

   (5) https://bugs.python.org/issue33394


File: python.info,  Node: Windows<21>,  Next: macOS<15>,  Prev: Build<19>,  Up: Python 3 6 6 release candidate 1

1.18.25.6 Windows
.................

   - bpo-33184(1): Update Windows installer to OpenSSL 1.0.2o.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33184


File: python.info,  Node: macOS<15>,  Next: IDLE<23>,  Prev: Windows<21>,  Up: Python 3 6 6 release candidate 1

1.18.25.7 macOS
...............

   - bpo-33184(1): Update macOS installer build to use OpenSSL 1.0.2o.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33184


File: python.info,  Node: IDLE<23>,  Next: Tools/Demos<15>,  Prev: macOS<15>,  Up: Python 3 6 6 release candidate 1

1.18.25.8 IDLE
..............

   - bpo-33656(1): On Windows, add API call saying that tk scales for
     DPI. On Windows 8.1+ or 10, with DPI compatibility properties of
     the Python binary unchanged, and a monitor resolution greater than
     96 DPI, this should make text and lines sharper.  It should
     otherwise have no effect.

   - bpo-33768(2): Clicking on a context line moves that line to the top
     of the editor window.

   - bpo-33763(3): IDLE: Use read-only text widget for code context
     instead of label widget.

   - bpo-33664(4): Scroll IDLE editor text by lines.  Previously, the
     mouse wheel and scrollbar slider moved text by a fixed number of
     pixels, resulting in partial lines at the top of the editor box.
     The change also applies to the shell and grep output windows, but
     not to read-only text views.

   - bpo-33679(5): Enable theme-specific color configuration for Code
     Context.  Use the Highlights tab to see the setting for built-in
     themes or add settings to custom themes.

   - bpo-33642(6): Display up to maxlines non-blank lines for Code
     Context.  If there is no current context, show a single blank line.

   - bpo-33628(7): IDLE: Cleanup codecontext.py and its test.

   - bpo-33564(8): IDLE’s code context now recognizes async as a block
     opener.

   - bpo-29706(9): IDLE now colors async and await as keywords in 3.6.
     They become full keywords in 3.7.

   - bpo-21474(10): Update word/identifier definition from ascii to
     unicode.  In text and entry boxes, this affects selection by
     double-click, movement left/right by control-left/right, and
     deletion left/right by control-BACKSPACE/DEL.

   - bpo-33204(11): IDLE: consistently color invalid string prefixes.  A
     ‘u’ string prefix cannot be paired with either ‘r’ or ‘f’.
     Consistently color as much of the prefix, starting at the right, as
     is valid.  Revise and extend colorizer test.

   - bpo-32831(12): Add docstrings and tests for codecontext.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33656

   (2) https://bugs.python.org/issue33768

   (3) https://bugs.python.org/issue33763

   (4) https://bugs.python.org/issue33664

   (5) https://bugs.python.org/issue33679

   (6) https://bugs.python.org/issue33642

   (7) https://bugs.python.org/issue33628

   (8) https://bugs.python.org/issue33564

   (9) https://bugs.python.org/issue29706

   (10) https://bugs.python.org/issue21474

   (11) https://bugs.python.org/issue33204

   (12) https://bugs.python.org/issue32831


File: python.info,  Node: Tools/Demos<15>,  Next: C API<17>,  Prev: IDLE<23>,  Up: Python 3 6 6 release candidate 1

1.18.25.9 Tools/Demos
.....................

   - bpo-33189(1): ‘pygettext.py’ now recognizes only literal strings as
     docstrings and translatable strings, and rejects bytes literals and
     f-string expressions.

   - bpo-31920(2): Fixed handling directories as arguments in the
     ‘pygettext’ script.  Based on patch by Oleg Krasnikov.

   - bpo-29673(3): Fix pystackv and pystack gdbinit macros.

   - bpo-32885(4): Add an ‘-n’ flag for ‘Tools/scripts/pathfix.py’ to
     disable automatic backup creation (files with ‘~’ suffix).

   - bpo-31583(5): Fix 2to3 for using with –add-suffix option but
     without –output-dir option for relative path to files in current
     directory.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33189

   (2) https://bugs.python.org/issue31920

   (3) https://bugs.python.org/issue29673

   (4) https://bugs.python.org/issue32885

   (5) https://bugs.python.org/issue31583


File: python.info,  Node: C API<17>,  Prev: Tools/Demos<15>,  Up: Python 3 6 6 release candidate 1

1.18.25.10 C API
................

   - bpo-32374(1): Document that m_traverse for multi-phase initialized
     modules can be called with m_state=NULL, and add a sanity check

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32374


File: python.info,  Node: Python 3 6 5 final,  Next: Python 3 6 5 release candidate 1,  Prev: Python 3 6 6 release candidate 1,  Up: Changelog

1.18.26 Python 3.6.5 final
--------------------------

`Release date: 2018-03-28'

* Menu:

* Tests: Tests<22>.
* Build: Build<20>.


File: python.info,  Node: Tests<22>,  Next: Build<20>,  Up: Python 3 6 5 final

1.18.26.1 Tests
...............

   - bpo-32872(1): Avoid regrtest compatibility issue with namespace
     packages.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32872


File: python.info,  Node: Build<20>,  Prev: Tests<22>,  Up: Python 3 6 5 final

1.18.26.2 Build
...............

   - bpo-33163(1): Upgrade pip to 9.0.3 and setuptools to v39.0.1.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33163


File: python.info,  Node: Python 3 6 5 release candidate 1,  Next: Python 3 6 4 final,  Prev: Python 3 6 5 final,  Up: Changelog

1.18.27 Python 3.6.5 release candidate 1
----------------------------------------

`Release date: 2018-03-13'

* Menu:

* Security: Security<13>.
* Core and Builtins: Core and Builtins<24>.
* Library: Library<25>.
* Documentation: Documentation<24>.
* Tests: Tests<23>.
* Build: Build<21>.
* Windows: Windows<22>.
* macOS: macOS<16>.
* IDLE: IDLE<24>.
* Tools/Demos: Tools/Demos<16>.
* C API: C API<18>.


File: python.info,  Node: Security<13>,  Next: Core and Builtins<24>,  Up: Python 3 6 5 release candidate 1

1.18.27.1 Security
..................

   - bpo-33001(1): Minimal fix to prevent buffer overrun in os.symlink
     on Windows

   - bpo-32981(2): Regexes in difflib and poplib were vulnerable to
     catastrophic backtracking.  These regexes formed potential DOS
     vectors (REDOS). They have been refactored.  This resolves
     CVE-2018-1060 and CVE-2018-1061.  Patch by Jamie Davis.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33001

   (2) https://bugs.python.org/issue32981


File: python.info,  Node: Core and Builtins<24>,  Next: Library<25>,  Prev: Security<13>,  Up: Python 3 6 5 release candidate 1

1.18.27.2 Core and Builtins
...........................

   - bpo-33026(1): Fixed jumping out of “with” block by setting
     f_lineno.

   - bpo-17288(2): Prevent jumps from ‘return’ and ‘exception’ trace
     events.

   - bpo-32889(3): Update Valgrind suppression list to account for the
     rename of ‘Py_ADDRESS_IN_RANG’ to ‘address_in_range’.

   - bpo-32650(4): Pdb and other debuggers dependent on bdb.py will
     correctly step over (next command) native coroutines.  Patch by
     Pablo Galindo.

   - bpo-32685(5): Improve suggestion when the Python 2 form of print
     statement is either present on the same line as the header of a
     compound statement or else terminated by a semi-colon instead of a
     newline.  Patch by Nitish Chandra.

   - bpo-32583(6): Fix possible crashing in builtin Unicode decoders
     caused by write out-of-bound errors when using customized decode
     error handlers.

   - bpo-26163(7): Improved frozenset() hash to create more distinct
     hash values when faced with datasets containing many similar
     values.

   - bpo-27169(8): The ‘__debug__’ constant is now optimized out at
     compile time.  This fixes also bpo-22091(9).

   - bpo-32329(10): ‘sys.flags.hash_randomization’ is now properly set
     to 0 when hash randomization is turned off by ‘PYTHONHASHSEED=0’.

   - bpo-30416(11): The optimizer is now protected from spending much
     time doing complex calculations and consuming much memory for
     creating large constants in constant folding.

   - bpo-18533(12): ‘repr()’ on a dict containing its own ‘values()’ or
     ‘items()’ no longer raises ‘RecursionError’; OrderedDict similarly.
     Instead, use ‘...’, as for other recursive structures.  Patch by
     Ben North.

   - bpo-32028(13): Leading whitespace is now correctly ignored when
     generating suggestions for converting Py2 print statements to Py3
     builtin print function calls.  Patch by Sanyam Khurana.

   - bpo-32137(14): The repr of deeply nested dict now raises a
     RecursionError instead of crashing due to a stack overflow.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33026

   (2) https://bugs.python.org/issue17288

   (3) https://bugs.python.org/issue32889

   (4) https://bugs.python.org/issue32650

   (5) https://bugs.python.org/issue32685

   (6) https://bugs.python.org/issue32583

   (7) https://bugs.python.org/issue26163

   (8) https://bugs.python.org/issue27169

   (9) https://bugs.python.org/issue22091

   (10) https://bugs.python.org/issue32329

   (11) https://bugs.python.org/issue30416

   (12) https://bugs.python.org/issue18533

   (13) https://bugs.python.org/issue32028

   (14) https://bugs.python.org/issue32137


File: python.info,  Node: Library<25>,  Next: Documentation<24>,  Prev: Core and Builtins<24>,  Up: Python 3 6 5 release candidate 1

1.18.27.3 Library
.................

   - bpo-33064(1): lib2to3 now properly supports trailing commas after
     ‘*args’ and ‘**kwargs’ in function signatures.

   - bpo-31804(2): Avoid failing in multiprocessing.Process if the
     standard streams are closed or None at exit.

   - bpo-33037(3): Skip sending/receiving data after SSL transport
     closing.

   - bpo-30353(4): Fix ctypes pass-by-value for structs on 64-bit
     Cygwin/MinGW.

   - bpo-33009(5): Fix inspect.signature() for single-parameter
     partialmethods.

   - bpo-32969(6): Expose several missing constants in zlib and fix
     corresponding documentation.

   - bpo-32713(7): Fixed tarfile.itn handling of out-of-bounds float
     values.  Patch by Joffrey Fuhrer.

   - bpo-30622(8): The ssl module now detects missing NPN support in
     LibreSSL.

   - bpo-32922(9): dbm.open() now encodes filename with the filesystem
     encoding rather than default encoding.

   - bpo-32859(10): In ‘os.dup2’, don’t check every call whether the
     ‘dup3’ syscall exists or not.

   - bpo-21060(11): Rewrite confusing message from setup.py upload from
     “No dist file created in earlier command” to the more helpful “Must
     create and upload files in one command”.

   - bpo-32857(12): In *note tkinter: 10c, ‘after_cancel(None)’ now
     raises a *note ValueError: 1f9. instead of canceling the first
     scheduled function.  Patch by Cheryl Sabella.

   - bpo-32852(13): Make sure sys.argv remains as a list when running
     trace.

   - bpo-32841(14): Fixed *note asyncio.Condition: 28b. issue which
     silently ignored cancellation after notifying and cancelling a
     conditional lock.  Patch by Bar Harel.

   - bpo-31787(15): Fixed refleaks of ‘__init__()’ methods in various
     modules.  (Contributed by Oren Milman)

   - bpo-30157(16): Fixed guessing quote and delimiter in
     csv.Sniffer.sniff() when only the last field is quoted.  Patch by
     Jake Davis.

   - bpo-32394(17): socket: Remove TCP_FASTOPEN, TCP_KEEPCNT flags on
     older version Windows during run-time.

   - bpo-32777(18): Fix a rare but potential pre-exec child process
     deadlock in subprocess on POSIX systems when marking file
     descriptors inheritable on exec in the child process.  This bug
     appears to have been introduced in 3.4.

   - bpo-32647(19): The ctypes module used to depend on indirect linking
     for dlopen.  The shared extension is now explicitly linked against
     libdl on platforms with dl.

   - bpo-32734(20): Fixed ‘asyncio.Lock()’ safety issue which allowed
     acquiring and locking the same lock multiple times, without it
     being free.  Patch by Bar Harel.

   - bpo-32727(21): Do not include name field in SMTP envelope from
     address.  Patch by Stéphane Wirtel

   - bpo-27931(22): Fix email address header parsing error when the
     username is an empty quoted string.  Patch by Xiang Zhang.

   - bpo-32304(23): distutils’ upload command no longer corrupts tar
     files ending with a CR byte, and no longer tries to convert CR to
     CRLF in any of the upload text fields.

   - bpo-32502(24): uuid.uuid1 no longer raises an exception if a 64-bit
     hardware address is encountered.

   - bpo-31848(25): Fix the error handling in Aifc_read.initfp() when
     the SSND chunk is not found.  Patch by Zackery Spytz.

   - bpo-32555(26): On FreeBSD and Solaris, os.strerror() now always
     decode the byte string from the current locale encoding, rather
     than using ASCII/surrogateescape in some cases.

   - bpo-32521(27): The nis module is now compatible with new libnsl and
     headers location.

   - bpo-32473(28): Improve ABCMeta._dump_registry() output readability

   - bpo-32521(29): glibc has removed Sun RPC. Use replacement libtirpc
     headers and library in nis module.

   - bpo-32228(30): Ensure that ‘truncate()’ preserves the file position
     (as reported by ‘tell()’) after writes longer than the buffer size.

   - bpo-26133(31): Don’t unsubscribe signals in asyncio UNIX event loop
     on interpreter shutdown.

   - bpo-32185(32): The SSL module no longer sends IP addresses in SNI
     TLS extension on platforms with OpenSSL 1.0.2+ or inet_pton.

   - bpo-32323(33): *note urllib.parse.urlsplit(): 5ee. does not convert
     zone-id (scope) to lower case for scoped IPv6 addresses in
     hostnames now.

   - bpo-32302(34): Fix bdist_wininst of distutils for CRT v142: it
     binary compatible with CRT v140.

   - bpo-32255(35): A single empty field is now always quoted when
     written into a CSV file.  This allows to distinguish an empty row
     from a row consisting of a single empty field.  Patch by Licht
     Takeuchi.

   - bpo-32277(36): Raise ‘NotImplementedError’ instead of ‘SystemError’
     on platforms where ‘chmod(..., follow_symlinks=False)’ is not
     supported.  Patch by Anthony Sottile.

   - bpo-32199(37): The getnode() ip getter now uses ‘ip link’ instead
     of ‘ip link list’.

   - bpo-27456(38): Ensure TCP_NODELAY is set on Linux.  Tests by Victor
     Stinner.

   - bpo-31900(39): The *note locale.localeconv(): 47f. function now
     sets temporarily the ‘LC_CTYPE’ locale to the ‘LC_NUMERIC’ locale
     to decode ‘decimal_point’ and ‘thousands_sep’ byte strings if they
     are non-ASCII or longer than 1 byte, and the ‘LC_NUMERIC’ locale is
     different than the ‘LC_CTYPE’ locale.  This temporary change
     affects other threads.  Same change for the *note str.format():
     4cf. method when formatting a number (*note int: 184, *note float:
     187, *note float: 187. and subclasses) with the ‘n’ type (ex:
     ‘'{:n}'.format(1234)’).

   - bpo-31802(40): Importing native path module (‘posixpath’, ‘ntpath’)
     now works even if the ‘os’ module still is not imported.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33064

   (2) https://bugs.python.org/issue31804

   (3) https://bugs.python.org/issue33037

   (4) https://bugs.python.org/issue30353

   (5) https://bugs.python.org/issue33009

   (6) https://bugs.python.org/issue32969

   (7) https://bugs.python.org/issue32713

   (8) https://bugs.python.org/issue30622

   (9) https://bugs.python.org/issue32922

   (10) https://bugs.python.org/issue32859

   (11) https://bugs.python.org/issue21060

   (12) https://bugs.python.org/issue32857

   (13) https://bugs.python.org/issue32852

   (14) https://bugs.python.org/issue32841

   (15) https://bugs.python.org/issue31787

   (16) https://bugs.python.org/issue30157

   (17) https://bugs.python.org/issue32394

   (18) https://bugs.python.org/issue32777

   (19) https://bugs.python.org/issue32647

   (20) https://bugs.python.org/issue32734

   (21) https://bugs.python.org/issue32727

   (22) https://bugs.python.org/issue27931

   (23) https://bugs.python.org/issue32304

   (24) https://bugs.python.org/issue32502

   (25) https://bugs.python.org/issue31848

   (26) https://bugs.python.org/issue32555

   (27) https://bugs.python.org/issue32521

   (28) https://bugs.python.org/issue32473

   (29) https://bugs.python.org/issue32521

   (30) https://bugs.python.org/issue32228

   (31) https://bugs.python.org/issue26133

   (32) https://bugs.python.org/issue32185

   (33) https://bugs.python.org/issue32323

   (34) https://bugs.python.org/issue32302

   (35) https://bugs.python.org/issue32255

   (36) https://bugs.python.org/issue32277

   (37) https://bugs.python.org/issue32199

   (38) https://bugs.python.org/issue27456

   (39) https://bugs.python.org/issue31900

   (40) https://bugs.python.org/issue31802


File: python.info,  Node: Documentation<24>,  Next: Tests<23>,  Prev: Library<25>,  Up: Python 3 6 5 release candidate 1

1.18.27.4 Documentation
.......................

   - bpo-17232(1): Clarify docs for -O and -OO. Patch by Terry Reedy.

   - bpo-32800(2): Update link to w3c doc for xml default namespaces.

   - bpo-8722(3): Document *note __getattr__(): 30f. behavior when
     property ‘get()’ method raises *note AttributeError: 390.

   - bpo-32614(4): Modify RE examples in documentation to use raw
     strings to prevent *note DeprecationWarning: 276. and add text to
     REGEX HOWTO to highlight the deprecation.

   - bpo-31972(5): Improve docstrings for *note pathlib.PurePath: f79.
     subclasses.

   - bpo-17799(6): Explain real behaviour of sys.settrace and
     sys.setprofile and their C-API counterparts regarding which type of
     events are received in each function.  Patch by Pablo Galindo
     Salgado.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17232

   (2) https://bugs.python.org/issue32800

   (3) https://bugs.python.org/issue8722

   (4) https://bugs.python.org/issue32614

   (5) https://bugs.python.org/issue31972

   (6) https://bugs.python.org/issue17799


File: python.info,  Node: Tests<23>,  Next: Build<21>,  Prev: Documentation<24>,  Up: Python 3 6 5 release candidate 1

1.18.27.5 Tests
...............

   - bpo-32517(1): Fix failing ‘test_asyncio’ on macOS 10.12.2+ due to
     transport of ‘KqueueSelector’ loop was not being closed.

   - bpo-32721(2): Fix test_hashlib to not fail if the _md5 module is
     not built.

   - bpo-32252(3): Fix faulthandler_suppress_crash_report() used to
     prevent core dump files when testing crashes.  getrlimit() returns
     zero on success.

   - bpo-31518(4): Debian Unstable has disabled TLS 1.0 and 1.1 for
     SSLv23_METHOD().  Change TLS/SSL protocol of some tests to
     PROTOCOL_TLS or PROTOCOL_TLSv1_2 to make them pass on Debian.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32517

   (2) https://bugs.python.org/issue32721

   (3) https://bugs.python.org/issue32252

   (4) https://bugs.python.org/issue31518


File: python.info,  Node: Build<21>,  Next: Windows<22>,  Prev: Tests<23>,  Up: Python 3 6 5 release candidate 1

1.18.27.6 Build
...............

   - bpo-32635(1): Fix segfault of the crypt module when libxcrypt is
     provided instead of libcrypt at the system.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32635


File: python.info,  Node: Windows<22>,  Next: macOS<16>,  Prev: Build<21>,  Up: Python 3 6 5 release candidate 1

1.18.27.7 Windows
.................

   - bpo-33016(1): Fix potential use of uninitialized memory in
     nt._getfinalpathname

   - bpo-32903(2): Fix a memory leak in os.chdir() on Windows if the
     current directory is set to a UNC path.

   - bpo-31966(3): Fixed WindowsConsoleIO.write() for writing empty
     data.

   - bpo-32409(4): Ensures activate.bat can handle Unicode contents.

   - bpo-32457(5): Improves handling of denormalized executable path
     when launching Python.

   - bpo-32370(6): Use the correct encoding for ipconfig output in the
     uuid module.  Patch by Segev Finer.

   - bpo-29248(7): Fix *note os.readlink(): 1f1. on Windows, which was
     mistakenly treating the ‘PrintNameOffset’ field of the reparse data
     buffer as a number of characters instead of bytes.  Patch by Craig
     Holmquist and SSE4.

   - bpo-32588(8): Create standalone _distutils_findvs module.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33016

   (2) https://bugs.python.org/issue32903

   (3) https://bugs.python.org/issue31966

   (4) https://bugs.python.org/issue32409

   (5) https://bugs.python.org/issue32457

   (6) https://bugs.python.org/issue32370

   (7) https://bugs.python.org/issue29248

   (8) https://bugs.python.org/issue32588


File: python.info,  Node: macOS<16>,  Next: IDLE<24>,  Prev: Windows<22>,  Up: Python 3 6 5 release candidate 1

1.18.27.8 macOS
...............

   - bpo-32726(1): Provide an additional, more modern macOS installer
     variant that supports macOS 10.9+ systems in 64-bit mode only.
     Upgrade the supplied third-party libraries to OpenSSL 1.0.2n, XZ
     5.2.3, and SQLite 3.22.0.  The 10.9+ installer now links with and
     supplies its own copy of Tcl/Tk 8.6.8.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32726


File: python.info,  Node: IDLE<24>,  Next: Tools/Demos<16>,  Prev: macOS<16>,  Up: Python 3 6 5 release candidate 1

1.18.27.9 IDLE
..............

   - bpo-32984(1): Set ‘__file__’ while running a startup file.  Like
     Python, IDLE optionally runs one startup file in the Shell window
     before presenting the first interactive input prompt.  For IDLE,
     ‘-s’ runs a file named in environmental variable ‘IDLESTARTUP’ or
     *note PYTHONSTARTUP: 8d9.; ‘-r file’ runs ‘file’.  Python sets
     ‘__file__’ to the startup file name before running the file and
     unsets it before the first prompt.  IDLE now does the same when run
     normally, without the ‘-n’ option.

   - bpo-32940(2): Simplify and rename StringTranslatePseudoMapping in
     pyparse.

   - bpo-32916(3): Change ‘str’ to ‘code’ in pyparse.

   - bpo-32905(4): Remove unused code in pyparse module.

   - bpo-32874(5): Add tests for pyparse.

   - bpo-32837(6): Using the system and place-dependent default encoding
     for open() is a bad idea for IDLE’s system and location-independent
     files.

   - bpo-32826(7): Add “encoding=utf-8” to open() in IDLE’s
     test_help_about.  GUI test test_file_buttons() only looks at
     initial ascii-only lines, but failed on systems where open()
     defaults to ‘ascii’ because readline() internally reads and decodes
     far enough ahead to encounter a non-ascii character in CREDITS.txt.

   - bpo-32765(8): Update configdialog General tab docstring to add new
     widgets to the widget list.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32984

   (2) https://bugs.python.org/issue32940

   (3) https://bugs.python.org/issue32916

   (4) https://bugs.python.org/issue32905

   (5) https://bugs.python.org/issue32874

   (6) https://bugs.python.org/issue32837

   (7) https://bugs.python.org/issue32826

   (8) https://bugs.python.org/issue32765


File: python.info,  Node: Tools/Demos<16>,  Next: C API<18>,  Prev: IDLE<24>,  Up: Python 3 6 5 release candidate 1

1.18.27.10 Tools/Demos
......................

   - bpo-24960(1): 2to3 and lib2to3 can now read pickled grammar files
     using pkgutil.get_data() rather than probing the filesystem.  This
     lets 2to3 and lib2to3 work when run from a zipfile.

   - bpo-32222(2): Fix pygettext not extracting docstrings for functions
     with type annotated arguments.  Patch by Toby Harradine.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24960

   (2) https://bugs.python.org/issue32222


File: python.info,  Node: C API<18>,  Prev: Tools/Demos<16>,  Up: Python 3 6 5 release candidate 1

1.18.27.11 C API
................

   - bpo-29084(1): Undocumented C API for OrderedDict has been excluded
     from the limited C API. It was added by mistake and actually never
     worked in the limited C API.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29084


File: python.info,  Node: Python 3 6 4 final,  Next: Python 3 6 4 release candidate 1,  Prev: Python 3 6 5 release candidate 1,  Up: Changelog

1.18.28 Python 3.6.4 final
--------------------------

`Release date: 2017-12-18'

There were no new code changes in version 3.6.4 since v3.6.4rc1.


File: python.info,  Node: Python 3 6 4 release candidate 1,  Next: Python 3 6 3 final,  Prev: Python 3 6 4 final,  Up: Changelog

1.18.29 Python 3.6.4 release candidate 1
----------------------------------------

`Release date: 2017-12-05'

* Menu:

* Core and Builtins: Core and Builtins<25>.
* Library: Library<26>.
* Documentation: Documentation<25>.
* Tests: Tests<24>.
* Build: Build<22>.
* Windows: Windows<23>.
* macOS: macOS<17>.
* IDLE: IDLE<25>.
* Tools/Demos: Tools/Demos<17>.
* C API: C API<19>.


File: python.info,  Node: Core and Builtins<25>,  Next: Library<26>,  Up: Python 3 6 4 release candidate 1

1.18.29.1 Core and Builtins
...........................

   - bpo-32176(1): co_flags.CO_NOFREE is now always set correctly by the
     code object constructor based on freevars and cellvars, rather than
     needing to be set correctly by the caller.  This ensures it will be
     cleared automatically when additional cell references are injected
     into a modified code object and function.

   - bpo-31949(2): Fixed several issues in printing tracebacks
     (PyTraceBack_Print()).  Setting sys.tracebacklimit to 0 or less now
     suppresses printing tracebacks.  Setting sys.tracebacklimit to None
     now causes using the default limit.  Setting sys.tracebacklimit to
     an integer larger than LONG_MAX now means using the limit LONG_MAX
     rather than the default limit.  Fixed integer overflows in the case
     of more than 2**31 traceback items on Windows.  Fixed output errors
     handling.

   - bpo-30696(3): Fix the interactive interpreter looping endlessly
     when no memory.

   - bpo-20047(4): Bytearray methods partition() and rpartition() now
     accept only bytes-like objects as separator, as documented.  In
     particular they now raise TypeError rather of returning a bogus
     result when an integer is passed as a separator.

   - bpo-31852(5): Fix a segmentation fault caused by a combination of
     the async soft keyword and continuation lines.

   - bpo-21720(6): BytesWarning no longer emitted when the `fromlist'
     argument of ‘__import__()’ or the ‘__all__’ attribute of the module
     contain bytes instances.

   - bpo-31825(7): Fixed OverflowError in the ‘unicode-escape’ codec and
     in codecs.escape_decode() when decode an escaped non-ascii byte.

   - bpo-28603(8): Print the full context/cause chain of exceptions on
     interpreter exit, even if an exception in the chain is unhashable
     or compares equal to later ones.  Patch by Zane Bitter.

   - bpo-31786(9): Fix timeout rounding in the select module to round
     correctly negative timeouts between -1.0 and 0.0.  The functions
     now block waiting for events as expected.  Previously, the call was
     incorrectly non-blocking.  Patch by Pablo Galindo.

   - bpo-31642(10): Restored blocking “from package import module” by
     setting sys.modules[“package.module”] to None.

   - bpo-31626(11): Fixed a bug in debug memory allocator.  There was a
     write to freed memory after shrinking a memory block.

   - bpo-31619(12): Fixed a ValueError when convert a string with large
     number of underscores to integer with binary base.

   - bpo-31592(13): Fixed an assertion failure in Python parser in case
     of a bad *note unicodedata.normalize(): fe8.  Patch by Oren Milman.

   - bpo-31588(14): Raise a *note TypeError: 192. with a helpful error
     message when class creation fails due to a metaclass with a bad
     ‘__prepare__()’ method.  Patch by Oren Milman.

   - bpo-31566(15): Fix an assertion failure in ‘_warnings.warn()’ in
     case of a bad ‘__name__’ global.  Patch by Oren Milman.

   - bpo-31505(16): Fix an assertion failure in *note json: a4, in case
     ‘_json.make_encoder()’ received a bad ‘encoder()’ argument.  Patch
     by Oren Milman.

   - bpo-31492(17): Fix assertion failures in case of failing to import
     from a module with a bad ‘__name__’ attribute, and in case of
     failing to access an attribute of such a module.  Patch by Oren
     Milman.

   - bpo-31490(18): Fix an assertion failure in *note ctypes: 2b. class
     definition, in case the class has an attribute whose name is
     specified in ‘_anonymous_’ but not in ‘_fields_’.  Patch by Oren
     Milman.

   - bpo-31478(19): Fix an assertion failure in ‘_random.Random.seed()’
     in case the argument has a bad ‘__abs__()’ method.  Patch by Oren
     Milman.

   - bpo-31315(20): Fix an assertion failure in imp.create_dynamic(),
     when spec.name is not a string.  Patch by Oren Milman.

   - bpo-31311(21): Fix a crash in the ‘__setstate__()’ method of *note
     ctypes._CData: fe9, in case of a bad ‘__dict__’.  Patch by Oren
     Milman.

   - bpo-31293(22): Fix crashes in true division and multiplication of a
     timedelta object by a float with a bad as_integer_ratio() method.
     Patch by Oren Milman.

   - bpo-31285(23): Fix an assertion failure in *note
     warnings.warn_explicit: 5a5, when the return value of the received
     loader’s get_source() has a bad splitlines() method.  Patch by Oren
     Milman.

   - bpo-30817(24): ‘PyErr_PrintEx()’ clears now the ignored exception
     that may be raised by ‘_PySys_SetObjectId()’, for example when no
     memory.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32176

   (2) https://bugs.python.org/issue31949

   (3) https://bugs.python.org/issue30696

   (4) https://bugs.python.org/issue20047

   (5) https://bugs.python.org/issue31852

   (6) https://bugs.python.org/issue21720

   (7) https://bugs.python.org/issue31825

   (8) https://bugs.python.org/issue28603

   (9) https://bugs.python.org/issue31786

   (10) https://bugs.python.org/issue31642

   (11) https://bugs.python.org/issue31626

   (12) https://bugs.python.org/issue31619

   (13) https://bugs.python.org/issue31592

   (14) https://bugs.python.org/issue31588

   (15) https://bugs.python.org/issue31566

   (16) https://bugs.python.org/issue31505

   (17) https://bugs.python.org/issue31492

   (18) https://bugs.python.org/issue31490

   (19) https://bugs.python.org/issue31478

   (20) https://bugs.python.org/issue31315

   (21) https://bugs.python.org/issue31311

   (22) https://bugs.python.org/issue31293

   (23) https://bugs.python.org/issue31285

   (24) https://bugs.python.org/issue30817


File: python.info,  Node: Library<26>,  Next: Documentation<25>,  Prev: Core and Builtins<25>,  Up: Python 3 6 4 release candidate 1

1.18.29.2 Library
.................

   - bpo-28556(1): Two minor fixes for ‘typing’ module: allow shallow
     copying instances of generic classes, improve interaction of
     ‘__init_subclass__’ with generics.  Original PRs by Ivan
     Levkivskyi.

   - bpo-27240(2): The header folding algorithm for the new email
     policies has been rewritten, which also fixes bpo-30788(3),
     bpo-31831(4), and bpo-32182(5).  In particular, RFC2231 folding is
     now done correctly.

   - bpo-32186(6): io.FileIO.readall() and io.FileIO.read() now release
     the GIL when getting the file size.  Fixed hang of all threads with
     inaccessible NFS server.  Patch by Nir Soffer.

   - bpo-12239(7): Make *note msilib.SummaryInformation.GetProperty():
     ef5. return ‘None’ when the value of property is ‘VT_EMPTY’.
     Initial patch by Mark Mc Mahon.

   - bpo-31325(8): Fix wrong usage of *note collections.namedtuple():
     1b5. in the *note RobotFileParser.parse(): fd9. method.  Initial
     patch by Robin Wellner.

   - bpo-12382(9): *note msilib.OpenDatabase(): fda. now raises a better
     exception message when it couldn’t open or create an MSI file.
     Initial patch by William Tisäter.

   - bpo-32110(10): ‘codecs.StreamReader.read(n)’ now returns not more
     than `n' characters/bytes for non-negative `n'.  This makes it
     compatible with ‘read()’ methods of other file-like objects.

   - bpo-32072(11): Fixed issues with binary plists: Fixed saving
     bytearrays.  Identical objects will be saved only once.  Equal
     references will be load as identical objects.  Added support for
     saving and loading recursive data structures.

   - bpo-32034(12): Make asyncio.IncompleteReadError and
     LimitOverrunError pickleable.

   - bpo-32015(13): Fixed the looping of asyncio in the case of
     reconnection the socket during waiting async read/write from/to the
     socket.

   - bpo-32011(14): Restored support of loading marshal files with the
     TYPE_INT64 code.  These files can be produced in Python 2.7.

   - bpo-31970(15): Reduce performance overhead of asyncio debug mode.

   - bpo-9678(16): Fixed determining the MAC address in the uuid module:
     Using ifconfig on NetBSD and OpenBSD. Using arp on Linux, FreeBSD,
     NetBSD and OpenBSD. Based on patch by Takayuki Shimizukawa.

   - bpo-30057(17): Fix potential missed signal in signal.signal().

   - bpo-31933(18): Fix Blake2 params leaf_size and node_offset on big
     endian platforms.  Patch by Jack O’Connor.

   - bpo-31927(19): Fixed compilation of the socket module on NetBSD 8.
     Fixed assertion failure or reading arbitrary data when parse a
     AF_BLUETOOTH address on NetBSD and DragonFly BSD.

   - bpo-27666(20): Fixed stack corruption in curses.box() and
     curses.ungetmouse() when the size of types chtype or mmask_t is
     less than the size of C long.  curses.box() now accepts characters
     as arguments.  Based on patch by Steve Fink.

   - bpo-31897(21): plistlib now catches more errors when read binary
     plists and raises InvalidFileException instead of unexpected
     exceptions.

   - bpo-25720(22): Fix the method for checking pad state of curses
     WINDOW. Patch by Masayuki Yamamoto.

   - bpo-31893(23): Fixed the layout of the kqueue_event structure on
     OpenBSD and NetBSD. Fixed the comparison of the kqueue_event
     objects.

   - bpo-31891(24): Fixed building the curses module on NetBSD.

   - bpo-28416(25): Instances of pickle.Pickler subclass with the
     persistent_id() method and pickle.Unpickler subclass with the
     persistent_load() method no longer create reference cycles.

   - bpo-28326(26): Fix multiprocessing.Process when stdout and/or
     stderr is closed or None.

   - bpo-31457(27): If nested log adapters are used, the inner
     ‘process()’ methods are no longer omitted.

   - bpo-31457(28): The ‘manager’ property on LoggerAdapter objects is
     now properly settable.

   - bpo-31806(29): Fix timeout rounding in time.sleep(),
     threading.Lock.acquire() and socket.socket.settimeout() to round
     correctly negative timeouts between -1.0 and 0.0.  The functions
     now block waiting for events as expected.  Previously, the call was
     incorrectly non-blocking.  Patch by Pablo Galindo.

   - bpo-28603(30): traceback: Fix a TypeError that occurred during
     printing of exception tracebacks when either the current exception
     or an exception in its context/cause chain is unhashable.  Patch by
     Zane Bitter.

   - bpo-30058(31): Fixed buffer overflow in select.kqueue.control().

   - bpo-31770(32): Prevent a crash when calling the ‘__init__()’ method
     of a ‘sqlite3.Cursor’ object more than once.  Patch by Oren Milman.

   - bpo-31672(33): ‘idpattern’ in ‘string.Template’ matched some
     non-ASCII characters.  Now it uses ‘-i’ regular expression local
     flag to avoid non-ASCII characters.

   - bpo-31764(34): Prevent a crash in ‘sqlite3.Cursor.close()’ in case
     the ‘Cursor’ object is uninitialized.  Patch by Oren Milman.

   - bpo-31752(35): Fix possible crash in timedelta constructor called
     with custom integers.

   - bpo-31701(36): On Windows, faulthandler.enable() now ignores MSC
     and COM exceptions.

   - bpo-31728(37): Prevent crashes in ‘_elementtree’ due to unsafe
     cleanup of ‘Element.text’ and ‘Element.tail’.  Patch by Oren
     Milman.

   - bpo-31620(38): an empty asyncio.Queue now doesn’t leak memory when
     queue.get pollers timeout

   - bpo-31632(39): Fix method set_protocol() of class
     _SSLProtocolTransport in asyncio module.  This method was
     previously modifying a wrong reference to the protocol.

   - bpo-31675(40): Fixed memory leaks in Tkinter’s methods splitlist()
     and split() when pass a string larger than 2 GiB.

   - bpo-31673(41): Fixed typo in the name of Tkinter’s method
     adderrorinfo().

   - bpo-30806(42): Fix the string representation of a netrc object.

   - bpo-15037(43): Added a workaround for getkey() in curses for
     ncurses 5.7 and earlier.

   - bpo-25351(44): Avoid venv activate failures with undefined
     variables

   - bpo-25532(45): inspect.unwrap() will now only try to unwrap an
     object sys.getrecursionlimit() times, to protect against objects
     which create a new object on every attribute access.

   - bpo-30347(46): Stop crashes when concurrently iterate over
     itertools.groupby() iterators.

   - bpo-31516(47): ‘threading.current_thread()’ should not return a
     dummy thread at shutdown.

   - bpo-31351(48): python -m ensurepip now exits with non-zero exit
     code if pip bootstrapping has failed.

   - bpo-31482(49): ‘random.seed()’ now works with bytes in version=1

   - bpo-31334(50): Fix ‘poll.poll([timeout])’ in the ‘select’ module
     for arbitrary negative timeouts on all OSes where it can only be a
     non-negative integer or -1.  Patch by Riccardo Coccioli.

   - bpo-31310(51): multiprocessing’s semaphore tracker should be
     launched again if crashed.

   - bpo-31308(52): Make multiprocessing’s forkserver process immune to
     Ctrl-C and other user interruptions.  If it crashes, restart it
     when necessary.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28556

   (2) https://bugs.python.org/issue27240

   (3) https://bugs.python.org/issue30788

   (4) https://bugs.python.org/issue31831

   (5) https://bugs.python.org/issue32182

   (6) https://bugs.python.org/issue32186

   (7) https://bugs.python.org/issue12239

   (8) https://bugs.python.org/issue31325

   (9) https://bugs.python.org/issue12382

   (10) https://bugs.python.org/issue32110

   (11) https://bugs.python.org/issue32072

   (12) https://bugs.python.org/issue32034

   (13) https://bugs.python.org/issue32015

   (14) https://bugs.python.org/issue32011

   (15) https://bugs.python.org/issue31970

   (16) https://bugs.python.org/issue9678

   (17) https://bugs.python.org/issue30057

   (18) https://bugs.python.org/issue31933

   (19) https://bugs.python.org/issue31927

   (20) https://bugs.python.org/issue27666

   (21) https://bugs.python.org/issue31897

   (22) https://bugs.python.org/issue25720

   (23) https://bugs.python.org/issue31893

   (24) https://bugs.python.org/issue31891

   (25) https://bugs.python.org/issue28416

   (26) https://bugs.python.org/issue28326

   (27) https://bugs.python.org/issue31457

   (28) https://bugs.python.org/issue31457

   (29) https://bugs.python.org/issue31806

   (30) https://bugs.python.org/issue28603

   (31) https://bugs.python.org/issue30058

   (32) https://bugs.python.org/issue31770

   (33) https://bugs.python.org/issue31672

   (34) https://bugs.python.org/issue31764

   (35) https://bugs.python.org/issue31752

   (36) https://bugs.python.org/issue31701

   (37) https://bugs.python.org/issue31728

   (38) https://bugs.python.org/issue31620

   (39) https://bugs.python.org/issue31632

   (40) https://bugs.python.org/issue31675

   (41) https://bugs.python.org/issue31673

   (42) https://bugs.python.org/issue30806

   (43) https://bugs.python.org/issue15037

   (44) https://bugs.python.org/issue25351

   (45) https://bugs.python.org/issue25532

   (46) https://bugs.python.org/issue30347

   (47) https://bugs.python.org/issue31516

   (48) https://bugs.python.org/issue31351

   (49) https://bugs.python.org/issue31482

   (50) https://bugs.python.org/issue31334

   (51) https://bugs.python.org/issue31310

   (52) https://bugs.python.org/issue31308


File: python.info,  Node: Documentation<25>,  Next: Tests<24>,  Prev: Library<26>,  Up: Python 3 6 4 release candidate 1

1.18.29.3 Documentation
.......................

   - bpo-32105(1): Added asyncio.BaseEventLoop.connect_accepted_socket
     versionadded marker.

   - bpo-31537(2): Fix incorrect usage of ‘get_history_length’ in
     readline documentation example code.  Patch by Brad Smith.

   - bpo-30085(3): The operator functions without double underscores are
     preferred for clarity.  The one with underscores are only kept for
     back-compatibility.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32105

   (2) https://bugs.python.org/issue31537

   (3) https://bugs.python.org/issue30085


File: python.info,  Node: Tests<24>,  Next: Build<22>,  Prev: Documentation<25>,  Up: Python 3 6 4 release candidate 1

1.18.29.4 Tests
...............

   - bpo-31380(1): Skip test_httpservers test_undecodable_file on macOS:
     fails on APFS.

   - bpo-31705(2): Skip test_socket.test_sha256() on Linux kernel older
     than 4.5.  The test fails with ENOKEY on kernel 3.10 (on ppc64le).
     A fix was merged into the kernel 4.5.

   - bpo-31174(3): Fix test_tools.test_unparse: DirectoryTestCase now
     stores the names sample to always test the same files.  It prevents
     false alarms when hunting reference leaks.

   - bpo-30695(4): Add the ‘set_nomemory(start, stop)’ and
     ‘remove_mem_hooks()’ functions to the _testcapi module.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31380

   (2) https://bugs.python.org/issue31705

   (3) https://bugs.python.org/issue31174

   (4) https://bugs.python.org/issue30695


File: python.info,  Node: Build<22>,  Next: Windows<23>,  Prev: Tests<24>,  Up: Python 3 6 4 release candidate 1

1.18.29.5 Build
...............

   - bpo-32059(1): ‘detect_modules()’ in ‘setup.py’ now also searches
     the sysroot paths when cross-compiling.

   - bpo-31957(2): Fixes Windows SDK version detection when building for
     Windows.

   - bpo-31609(3): Fixes quotes in PCbuild/clean.bat

   - bpo-31934(4): Abort the build when building out of a not clean
     source tree.

   - bpo-31926(5): Fixed Argument Clinic sometimes causing compilation
     errors when there was more than one function and/or method in a .c
     file with the same name.

   - bpo-28791(6): Update Windows builds to use SQLite 3.21.0.

   - bpo-28791(7): Update OS X installer to use SQLite 3.21.0.

   - bpo-22140(8): Prevent double substitution of prefix in
     python-config.sh.

   - bpo-31536(9): Avoid wholesale rebuild after ‘make regen-all’ if
     nothing changed.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32059

   (2) https://bugs.python.org/issue31957

   (3) https://bugs.python.org/issue31609

   (4) https://bugs.python.org/issue31934

   (5) https://bugs.python.org/issue31926

   (6) https://bugs.python.org/issue28791

   (7) https://bugs.python.org/issue28791

   (8) https://bugs.python.org/issue22140

   (9) https://bugs.python.org/issue31536


File: python.info,  Node: Windows<23>,  Next: macOS<17>,  Prev: Build<22>,  Up: Python 3 6 4 release candidate 1

1.18.29.6 Windows
.................

   - bpo-1102(1): Return ‘None’ when ‘View.Fetch()’ returns
     ‘ERROR_NO_MORE_ITEMS’ instead of raising ‘MSIError’.  Initial patch
     by Anthony Tuininga.

   - bpo-31944(2): Fixes Modify button in Apps and Features dialog.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue1102

   (2) https://bugs.python.org/issue31944


File: python.info,  Node: macOS<17>,  Next: IDLE<25>,  Prev: Windows<23>,  Up: Python 3 6 4 release candidate 1

1.18.29.7 macOS
...............

   - bpo-31392(1): Update macOS installer to use OpenSSL 1.0.2m

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31392


File: python.info,  Node: IDLE<25>,  Next: Tools/Demos<17>,  Prev: macOS<17>,  Up: Python 3 6 4 release candidate 1

1.18.29.8 IDLE
..............

   - bpo-32207(1): Improve tk event exception tracebacks in IDLE. When
     tk event handling is driven by IDLE’s run loop, a confusing and
     distracting queue.EMPTY traceback context is no longer added to tk
     event exception tracebacks.  The traceback is now the same as when
     event handling is driven by user code.  Patch based on a suggestion
     by Serhiy Storchaka.

   - bpo-32164(2): Delete unused file idlelib/tabbedpages.py.  Use of
     TabbedPageSet in configdialog was replaced by ttk.Notebook.

   - bpo-32100(3): IDLE: Fix old and new bugs in pathbrowser; improve
     tests.  Patch mostly by Cheryl Sabella.

   - bpo-31858(4): IDLE – Restrict shell prompt manipulation to the
     shell.  Editor and output windows only see an empty last prompt
     line.  This simplifies the code and fixes a minor bug when newline
     is inserted.  Sys.ps1, if present, is read on Shell start-up, but
     is not set or changed.

   - bpo-31860(5): The font sample in the IDLE configuration dialog is
     now editable.  Changes persist while IDLE remains open

   - bpo-31836(6): Test_code_module now passes if run after test_idle,
     which sets ps1.  The code module uses sys.ps1 if present or sets it
     to ‘>>> ‘ if not.  Test_code_module now properly tests both
     behaviors.  Ditto for ps2.

   - bpo-28603(7): Fix a TypeError that caused a shell restart when
     printing a traceback that includes an exception that is unhashable.
     Patch by Zane Bitter.

   - bpo-13802(8): Use non-Latin characters in the IDLE’s Font settings
     sample.  Even if one selects a font that defines a limited subset
     of the unicode Basic Multilingual Plane, tcl/tk will use other
     fonts that define a character.  The expanded example give users of
     non-Latin characters a better idea of what they might see in IDLE’s
     shell and editors.  To make room for the expanded sample, frames on
     the Font tab are re-arranged.  The Font/Tabs help explains a bit
     about the additions.

   - bpo-31460(9): Simplify the API of IDLE’s Module Browser.  Passing a
     widget instead of an flist with a root widget opens the option of
     creating a browser frame that is only part of a window.  Passing a
     full file name instead of pieces assumed to come from a .py file
     opens the possibility of browsing python files that do not end in
     .py.

   - bpo-31649(10): IDLE - Make _htest, _utest parameters keyword only.

   - bpo-31559(11): Remove test order dependence in
     idle_test.test_browser.

   - bpo-31459(12): Rename IDLE’s module browser from Class Browser to
     Module Browser.  The original module-level class and method browser
     became a module browser, with the addition of module-level
     functions, years ago.  Nested classes and functions were added
     yesterday.  For back-compatibility, the virtual event
     <<open-class-browser>>, which appears on the Keys tab of the
     Settings dialog, is not changed.  Patch by Cheryl Sabella.

   - bpo-31500(13): Default fonts now are scaled on HiDPI displays.

   - bpo-1612262(14): IDLE module browser now shows nested classes and
     functions.  Original patches for code and tests by Guilherme Polo
     and Cheryl Sabella, respectively.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32207

   (2) https://bugs.python.org/issue32164

   (3) https://bugs.python.org/issue32100

   (4) https://bugs.python.org/issue31858

   (5) https://bugs.python.org/issue31860

   (6) https://bugs.python.org/issue31836

   (7) https://bugs.python.org/issue28603

   (8) https://bugs.python.org/issue13802

   (9) https://bugs.python.org/issue31460

   (10) https://bugs.python.org/issue31649

   (11) https://bugs.python.org/issue31559

   (12) https://bugs.python.org/issue31459

   (13) https://bugs.python.org/issue31500

   (14) https://bugs.python.org/issue1612262


File: python.info,  Node: Tools/Demos<17>,  Next: C API<19>,  Prev: IDLE<25>,  Up: Python 3 6 4 release candidate 1

1.18.29.9 Tools/Demos
.....................

   - bpo-30722(1): Make redemo work with Python 3.6 and newer versions.
     Also, remove the ‘LOCALE’ option since it doesn’t work with string
     patterns in Python 3.  Patch by Christoph Sarnowski.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30722


File: python.info,  Node: C API<19>,  Prev: Tools/Demos<17>,  Up: Python 3 6 4 release candidate 1

1.18.29.10 C API
................

   - bpo-20891(1): Fix PyGILState_Ensure().  When PyGILState_Ensure() is
     called in a non-Python thread before PyEval_InitThreads(), only
     call PyEval_InitThreads() after calling PyThreadState_New() to fix
     a crash.

   - bpo-31532(2): Fix memory corruption due to allocator mix in
     getpath.c between Py_GetPath() and Py_SetPath()

   - bpo-30697(3): The ‘PyExc_RecursionErrorInst’ singleton is removed
     and ‘PyErr_NormalizeException()’ does not use it anymore.  This
     singleton is persistent and its members being never cleared may
     cause a segfault during finalization of the interpreter.  See also
     bpo-22898(4).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20891

   (2) https://bugs.python.org/issue31532

   (3) https://bugs.python.org/issue30697

   (4) https://bugs.python.org/issue22898


File: python.info,  Node: Python 3 6 3 final,  Next: Python 3 6 3 release candidate 1,  Prev: Python 3 6 4 release candidate 1,  Up: Changelog

1.18.30 Python 3.6.3 final
--------------------------

`Release date: 2017-10-03'

* Menu:

* Library: Library<27>.
* Build: Build<23>.


File: python.info,  Node: Library<27>,  Next: Build<23>,  Up: Python 3 6 3 final

1.18.30.1 Library
.................

   - bpo-31641(1): Re-allow arbitrary iterables in *note
     concurrent.futures.as_completed(): 1027.  Fixes regression in
     3.6.3rc1.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31641


File: python.info,  Node: Build<23>,  Prev: Library<27>,  Up: Python 3 6 3 final

1.18.30.2 Build
...............

   - bpo-31662(1): Fix typos in Windows ‘uploadrelease.bat’ script.  Fix
     Windows Doc build issues in ‘Doc/make.bat’.

   - bpo-31423(2): Fix building the PDF documentation with newer
     versions of Sphinx.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31662

   (2) https://bugs.python.org/issue31423


File: python.info,  Node: Python 3 6 3 release candidate 1,  Next: Python 3 6 2 final,  Prev: Python 3 6 3 final,  Up: Changelog

1.18.31 Python 3.6.3 release candidate 1
----------------------------------------

`Release date: 2017-09-18'

* Menu:

* Security: Security<14>.
* Core and Builtins: Core and Builtins<26>.
* Library: Library<28>.
* Documentation: Documentation<26>.
* Tests: Tests<25>.
* Build: Build<24>.
* Windows: Windows<24>.
* IDLE: IDLE<26>.
* Tools/Demos: Tools/Demos<18>.


File: python.info,  Node: Security<14>,  Next: Core and Builtins<26>,  Up: Python 3 6 3 release candidate 1

1.18.31.1 Security
..................

   - bpo-29781(1): SSLObject.version() now correctly returns None when
     handshake over BIO has not been performed yet.

   - bpo-30947(2): Upgrade libexpat embedded copy from version 2.2.1 to
     2.2.3 to get security fixes.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29781

   (2) https://bugs.python.org/issue30947


File: python.info,  Node: Core and Builtins<26>,  Next: Library<28>,  Prev: Security<14>,  Up: Python 3 6 3 release candidate 1

1.18.31.2 Core and Builtins
...........................

   - bpo-31471(1): Fix an assertion failure in *note subprocess.Popen():
     2b7. on Windows, in case the env argument has a bad keys() method.
     Patch by Oren Milman.

   - bpo-31418(2): Fix an assertion failure in ‘PyErr_WriteUnraisable()’
     in case of an exception with a bad ‘__module__’ attribute.  Patch
     by Oren Milman.

   - bpo-31416(3): Fix assertion failures in case of a bad
     warnings.filters or warnings.defaultaction.  Patch by Oren Milman.

   - bpo-31411(4): Raise a TypeError instead of SystemError in case
     warnings.onceregistry is not a dictionary.  Patch by Oren Milman.

   - bpo-31373(5): Fix several possible instances of undefined behavior
     due to floating-point demotions.

   - bpo-30465(6): Location information (‘lineno’ and ‘col_offset’) in
     f-strings is now (mostly) correct.  This fixes tools like flake8
     from showing warnings on the wrong line (typically the first line
     of the file).

   - bpo-31343(7): Include sys/sysmacros.h for major(), minor(), and
     makedev().  GNU C libray plans to remove the functions from
     sys/types.h.

   - bpo-31291(8): Fix an assertion failure in *note
     zipimport.zipimporter.get_data: ff3. on Windows, when the return
     value of ‘pathname.replace('/','\\')’ isn’t a string.  Patch by
     Oren Milman.

   - bpo-31271(9): Fix an assertion failure in the write() method of
     *note io.TextIOWrapper: 5e8, when the encoder doesn’t return a
     bytes object.  Patch by Oren Milman.

   - bpo-31243(10): Fix a crash in some methods of *note
     io.TextIOWrapper: 5e8, when the decoder’s state is invalid.  Patch
     by Oren Milman.

   - bpo-30721(11): ‘print’ now shows correct usage hint for using
     Python 2 redirection syntax.  Patch by Sanyam Khurana.

   - bpo-31070(12): Fix a race condition in importlib
     _get_module_lock().

   - bpo-31095(13): Fix potential crash during GC caused by ‘tp_dealloc’
     which doesn’t call ‘PyObject_GC_UnTrack()’.

   - bpo-31071(14): Avoid masking original TypeError in call with *
     unpacking when other arguments are passed.

   - bpo-30978(15): str.format_map() now passes key lookup exceptions
     through.  Previously any exception was replaced with a KeyError
     exception.

   - bpo-30808(16): Use _Py_atomic API for concurrency-sensitive signal
     state.

   - bpo-30876(17): Relative import from unloaded package now reimports
     the package instead of failing with SystemError.  Relative import
     from non-package now fails with ImportError rather than
     SystemError.

   - bpo-30703(18): Improve signal delivery.  Avoid using
     Py_AddPendingCall from signal handler, to avoid calling
     signal-unsafe functions.  The tests I’m adding here fail without
     the rest of the patch, on Linux and OS X. This means our signal
     delivery logic had defects (some signals could be lost).

   - bpo-30765(19): Avoid blocking in pthread_mutex_lock() when
     PyThread_acquire_lock() is asked not to block.

   - bpo-31161(20): Make sure the ‘Missing parentheses’ syntax error
     message is only applied to SyntaxError, not to subclasses.  Patch
     by Martijn Pieters.

   - bpo-30814(21): Fixed a race condition when import a submodule from
     a package.

   - bpo-30597(22): ‘print’ now shows expected input in custom error
     message when used as a Python 2 statement.  Patch by Sanyam
     Khurana.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31471

   (2) https://bugs.python.org/issue31418

   (3) https://bugs.python.org/issue31416

   (4) https://bugs.python.org/issue31411

   (5) https://bugs.python.org/issue31373

   (6) https://bugs.python.org/issue30465

   (7) https://bugs.python.org/issue31343

   (8) https://bugs.python.org/issue31291

   (9) https://bugs.python.org/issue31271

   (10) https://bugs.python.org/issue31243

   (11) https://bugs.python.org/issue30721

   (12) https://bugs.python.org/issue31070

   (13) https://bugs.python.org/issue31095

   (14) https://bugs.python.org/issue31071

   (15) https://bugs.python.org/issue30978

   (16) https://bugs.python.org/issue30808

   (17) https://bugs.python.org/issue30876

   (18) https://bugs.python.org/issue30703

   (19) https://bugs.python.org/issue30765

   (20) https://bugs.python.org/issue31161

   (21) https://bugs.python.org/issue30814

   (22) https://bugs.python.org/issue30597


File: python.info,  Node: Library<28>,  Next: Documentation<26>,  Prev: Core and Builtins<26>,  Up: Python 3 6 3 release candidate 1

1.18.31.3 Library
.................

   - bpo-31499(1): xml.etree: Fix a crash when a parser is part of a
     reference cycle.

   - bpo-28556(2): typing.get_type_hints now finds the right globalns
     for classes and modules by default (when no ‘globalns’ was
     specified by the caller).

   - bpo-28556(3): Speed improvements to the ‘typing’ module.  Original
     PRs by Ivan Levkivskyi and Mitar.

   - bpo-31544(4): The C accelerator module of ElementTree ignored
     exceptions raised when looking up TreeBuilder target methods in
     XMLParser().

   - bpo-31234(5): socket.create_connection() now fixes manually a
     reference cycle: clear the variable storing the last exception on
     success.

   - bpo-31457(6): LoggerAdapter objects can now be nested.

   - bpo-31400(7): Improves SSL error handling to avoid losing error
     numbers.

   - bpo-28958(8): ssl.SSLContext() now uses OpenSSL error information
     when a context cannot be instantiated.

   - bpo-27340(9): SSLSocket.sendall() now uses memoryview to create
     slices of data.  This fixes support for all bytes-like object.  It
     is also more efficient and avoids costly copies.

   - bpo-31178(10): Fix string concatenation bug in rare error path in
     the subprocess module

   - bpo-31350(11): Micro-optimize ‘asyncio._get_running_loop()’ to
     become up to 10% faster.

   - bpo-31170(12): expat: Update libexpat from 2.2.3 to 2.2.4.  Fix
     copying of partial characters for UTF-8 input (libexpat bug 115):
     ‘https://github.com/libexpat/libexpat/issues/115’

   - bpo-29136(13): Add TLS 1.3 cipher suites and OP_NO_TLSv1_3.

   - bpo-29212(14): Fix concurrent.futures.thread.ThreadPoolExecutor
     threads to have a non repr() based thread name by default when no
     thread_name_prefix is supplied.  They will now identify themselves
     as “ThreadPoolExecutor-y_n”.

   - bpo-9146(15): Fix a segmentation fault in _hashopenssl when
     standard hash functions such as md5 are not available in the linked
     OpenSSL library.  As in some special FIPS-140 build environments.

   - bpo-27144(16): The ‘map()’ and ‘as_completed()’ iterators in
     ‘concurrent.futures’ now avoid keeping a reference to yielded
     objects.

   - bpo-10746(17): Fix ctypes producing wrong PEP 3118(18) type codes
     for integer types.

   - bpo-22536(19): The subprocess module now sets the filename when
     FileNotFoundError is raised on POSIX systems due to the executable
     or cwd not being found.

   - bpo-31249(20): concurrent.futures: WorkItem.run() used by
     ThreadPoolExecutor now breaks a reference cycle between an
     exception object and the WorkItem object.

   - bpo-31247(21): xmlrpc.server now explicitly breaks reference cycles
     when using sys.exc_info() in code handling exceptions.

   - bpo-30102(22): The ssl and hashlib modules now call
     OPENSSL_add_all_algorithms_noconf() on OpenSSL < 1.1.0.  The
     function detects CPU features and enables optimizations on some CPU
     architectures such as POWER8.  Patch is based on research from
     Gustavo Serra Scalet.

   - bpo-31185(23): Fixed miscellaneous errors in asyncio speedup
     module.

   - bpo-31135(24): ttk: fix the destroy() method of LabeledScale and
     OptionMenu classes.  Call the parent destroy() method even if the
     used attribute doesn’t exist.  The LabeledScale.destroy() method
     now also explicitly clears label and scale attributes to help the
     garbage collector to destroy all widgets.

   - bpo-31107(25): Fix ‘copyreg._slotnames()’ mangled attribute
     calculation for classes whose name begins with an underscore.
     Patch by Shane Harvey.

   - bpo-31061(26): Fixed a crash when using asyncio and threads.

   - bpo-30502(27): Fix handling of long oids in ssl.  Based on patch by
     Christian Heimes.

   - bpo-30119(28): ftplib.FTP.putline() now throws ValueError on
     commands that contains CR or LF. Patch by Dong-hee Na.

   - bpo-30595(29): multiprocessing.Queue.get() with a timeout now polls
     its reader in non-blocking mode if it succeeded to acquire the lock
     but the acquire took longer than the timeout.

   - bpo-29403(30): Fix ‘unittest.mock’’s autospec to not fail on
     method-bound builtin functions.  Patch by Aaron Gallagher.

   - bpo-30961(31): Fix decrementing a borrowed reference in
     tracemalloc.

   - bpo-25684(32): Change ‘ttk.OptionMenu’ radiobuttons to be unique
     across instances of ‘OptionMenu’.

   - bpo-30886(33): Fix multiprocessing.Queue.join_thread(): it now
     waits until the thread completes, even if the thread was started by
     the same process which created the queue.

   - bpo-29854(34): Fix segfault in readline when using readline’s
     history-size option.  Patch by Nir Soffer.

   - bpo-30319(35): socket.close() now ignores ECONNRESET error.

   - bpo-30828(36): Fix out of bounds write in
     ‘asyncio.CFuture.remove_done_callback()’.

   - bpo-30807(37): signal.setitimer() may disable the timer when passed
     a tiny value.  Tiny values (such as 1e-6) are valid non-zero values
     for setitimer(), which is specified as taking
     microsecond-resolution intervals.  However, on some platform, our
     conversion routine could convert 1e-6 into a zero interval,
     therefore disabling the timer instead of (re-)scheduling it.

   - bpo-30441(38): Fix bug when modifying os.environ while iterating
     over it

   - bpo-30532(39): Fix email header value parser dropping folding white
     space in certain cases.

   - bpo-30879(40): os.listdir() and os.scandir() now emit bytes names
     when called with bytes-like argument.

   - bpo-30746(41): Prohibited the ‘=’ character in environment variable
     names in ‘os.putenv()’ and ‘os.spawn*()’.

   - bpo-29755(42): Fixed the lgettext() family of functions in the
     gettext module.  They now always return bytes.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31499

   (2) https://bugs.python.org/issue28556

   (3) https://bugs.python.org/issue28556

   (4) https://bugs.python.org/issue31544

   (5) https://bugs.python.org/issue31234

   (6) https://bugs.python.org/issue31457

   (7) https://bugs.python.org/issue31400

   (8) https://bugs.python.org/issue28958

   (9) https://bugs.python.org/issue27340

   (10) https://bugs.python.org/issue31178

   (11) https://bugs.python.org/issue31350

   (12) https://bugs.python.org/issue31170

   (13) https://bugs.python.org/issue29136

   (14) https://bugs.python.org/issue29212

   (15) https://bugs.python.org/issue9146

   (16) https://bugs.python.org/issue27144

   (17) https://bugs.python.org/issue10746

   (18) https://www.python.org/dev/peps/pep-3118

   (19) https://bugs.python.org/issue22536

   (20) https://bugs.python.org/issue31249

   (21) https://bugs.python.org/issue31247

   (22) https://bugs.python.org/issue30102

   (23) https://bugs.python.org/issue31185

   (24) https://bugs.python.org/issue31135

   (25) https://bugs.python.org/issue31107

   (26) https://bugs.python.org/issue31061

   (27) https://bugs.python.org/issue30502

   (28) https://bugs.python.org/issue30119

   (29) https://bugs.python.org/issue30595

   (30) https://bugs.python.org/issue29403

   (31) https://bugs.python.org/issue30961

   (32) https://bugs.python.org/issue25684

   (33) https://bugs.python.org/issue30886

   (34) https://bugs.python.org/issue29854

   (35) https://bugs.python.org/issue30319

   (36) https://bugs.python.org/issue30828

   (37) https://bugs.python.org/issue30807

   (38) https://bugs.python.org/issue30441

   (39) https://bugs.python.org/issue30532

   (40) https://bugs.python.org/issue30879

   (41) https://bugs.python.org/issue30746

   (42) https://bugs.python.org/issue29755


File: python.info,  Node: Documentation<26>,  Next: Tests<25>,  Prev: Library<28>,  Up: Python 3 6 3 release candidate 1

1.18.31.4 Documentation
.......................

   - bpo-31294(1): Fix incomplete code snippet in the
     ZeroMQSocketListener and ZeroMQSocketHandler examples and adapt
     them to Python 3.

   - bpo-21649(2): Add RFC 7525 and Mozilla server side TLS links to SSL
     documentation.

   - bpo-30803(3): Clarify doc on truth value testing.  Original patch
     by Peter Thomassen.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31294

   (2) https://bugs.python.org/issue21649

   (3) https://bugs.python.org/issue30803


File: python.info,  Node: Tests<25>,  Next: Build<24>,  Prev: Documentation<26>,  Up: Python 3 6 3 release candidate 1

1.18.31.5 Tests
...............

   - bpo-31320(1): Silence traceback in test_ssl

   - bpo-25674(2): Remove sha256.tbs-internet.com ssl test

   - bpo-30715(3): Address ALPN callback changes for OpenSSL 1.1.0f.
     The latest version behaves like OpenSSL 1.0.2 and no longer aborts
     handshake.

   - bpo-30822(4): regrtest: Exclude tzdata from regrtest –all.  When
     running the test suite using –use=all / -u all, exclude tzdata
     since it makes test_datetime too slow (15-20 min on some buildbots)
     which then times out on some buildbots.  Fix also regrtest command
     line parser to allow passing -u extralargefile to run
     test_zipfile64.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31320

   (2) https://bugs.python.org/issue25674

   (3) https://bugs.python.org/issue30715

   (4) https://bugs.python.org/issue30822


File: python.info,  Node: Build<24>,  Next: Windows<24>,  Prev: Tests<25>,  Up: Python 3 6 3 release candidate 1

1.18.31.6 Build
...............

   - bpo-30854(1): Fix compile error when compiling –without-threads.
     Patch by Masayuki Yamamoto.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30854


File: python.info,  Node: Windows<24>,  Next: IDLE<26>,  Prev: Build<24>,  Up: Python 3 6 3 release candidate 1

1.18.31.7 Windows
.................

   - bpo-30389(1): Adds detection of Visual Studio 2017 to distutils on
     Windows.

   - bpo-31340(2): Change to building with MSVC v141 (included with
     Visual Studio 2017)

   - bpo-30581(3): os.cpu_count() now returns the correct number of
     processors on Windows when the number of logical processors is
     greater than 64.

   - bpo-30731(4): Add a missing xmlns to python.manifest so that it
     matches the schema.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30389

   (2) https://bugs.python.org/issue31340

   (3) https://bugs.python.org/issue30581

   (4) https://bugs.python.org/issue30731


File: python.info,  Node: IDLE<26>,  Next: Tools/Demos<18>,  Prev: Windows<24>,  Up: Python 3 6 3 release candidate 1

1.18.31.8 IDLE
..............

   - bpo-31493(1): IDLE code context – fix code update and font update
     timers.  Canceling timers prevents a warning message when test_idle
     completes.

   - bpo-31488(2): IDLE - Update non-key options in former extension
     classes.  When applying configdialog changes, call .reload for each
     feature class.  Change ParenMatch so updated options affect
     existing instances attached to existing editor windows.

   - bpo-31477(3): IDLE - Improve rstrip entry in doc.  Strip trailing
     whitespace strips more than blank spaces.  Multiline string
     literals are not skipped.

   - bpo-31480(4): IDLE - make tests pass with zzdummy extension
     disabled by default.

   - bpo-31421(5): Document how IDLE runs tkinter programs.  IDLE calls
     tcl/tk update in the background in order to make live interaction
     and experimentation with tkinter applications much easier.

   - bpo-31414(6): IDLE – fix tk entry box tests by deleting first.
     Adding to an int entry is not the same as deleting and inserting
     because int(‘’) will fail.

   - bpo-31051(7): Rearrange IDLE configdialog GenPage into Window,
     Editor, and Help sections.

   - bpo-30617(8): IDLE - Add docstrings and tests for outwin subclass
     of editor.  Move some data and functions from the class to module
     level.  Patch by Cheryl Sabella.

   - bpo-31287(9): IDLE - Do not modify tkinter.message in
     test_configdialog.

   - bpo-27099(10): Convert IDLE’s built-in ‘extensions’ to regular
     features.  About 10 IDLE features were implemented as supposedly
     optional extensions.  Their different behavior could be confusing
     or worse for users and not good for maintenance.  Hence the
     conversion.  The main difference for users is that user
     configurable key bindings for builtin features are now handled
     uniformly.  Now, editing a binding in a keyset only affects its
     value in the keyset.  All bindings are defined together in the
     system-specific default keysets in config-extensions.def.  All
     custom keysets are saved as a whole in config-extension.cfg.  All
     take effect as soon as one clicks Apply or Ok.  The affected events
     are ‘<<force-open-completions>>’, ‘<<expand-word>>’,
     ‘<<force-open-calltip>>’, ‘<<flash-paren>>’,
     ‘<<format-paragraph>>’, ‘<<run-module>>’, ‘<<check-module>>’, and
     ‘<<zoom-height>>’.  Any (global) customizations made before 3.6.3
     will not affect their keyset-specific customization after 3.6.3.
     and vice versa.  Initial patch by Charles Wohlganger.

   - bpo-31206(11): IDLE: Factor HighPage(Frame) class from
     ConfigDialog.  Patch by Cheryl Sabella.

   - bpo-31001(12): Add tests for configdialog highlight tab.  Patch by
     Cheryl Sabella.

   - bpo-31205(13): IDLE: Factor KeysPage(Frame) class from
     ConfigDialog.  The slightly modified tests continue to pass.  Patch
     by Cheryl Sabella.

   - bpo-31130(14): IDLE – stop leaks in test_configdialog.  Initial
     patch by Victor Stinner.

   - bpo-31002(15): Add tests for configdialog keys tab.  Patch by
     Cheryl Sabella.

   - bpo-19903(16): IDLE: Calltips use *note inspect.signature: 550.
     instead of *note inspect.getfullargspec: 552.  This improves
     calltips for builtins converted to use Argument Clinic.  Patch by
     Louie Lu.

   - bpo-31083(17): IDLE - Add an outline of a TabPage class in
     configdialog.  Update existing classes to match outline.  Initial
     patch by Cheryl Sabella.

   - bpo-31050(18): Factor GenPage(Frame) class from ConfigDialog.  The
     slightly modified tests continue to pass.  Patch by Cheryl Sabella.

   - bpo-31004(19): IDLE - Factor FontPage(Frame) class from
     ConfigDialog.  Slightly modified tests continue to pass.  Fix
     General tests.  Patch mostly by Cheryl Sabella.

   - bpo-30781(20): IDLE - Use ttk widgets in ConfigDialog.  Patches by
     Terry Jan Reedy and Cheryl Sabella.

   - bpo-31060(21): IDLE - Finish rearranging methods of ConfigDialog
     Grouping methods pertaining to each tab and the buttons will aid
     writing tests and improving the tabs and will enable splitting the
     groups into classes.

   - bpo-30853(22): IDLE – Factor a VarTrace class out of ConfigDialog.
     Instance tracers manages pairs consisting of a tk variable and a
     callback function.  When tracing is turned on, setting the variable
     calls the function.  Test coverage for the new class is 100%.

   - bpo-31003(23): IDLE: Add more tests for General tab.

   - bpo-30993(24): IDLE - Improve configdialog font page and tests.  In
     configdialog: Document causal pathways in create_font_tab
     docstring.  Simplify some attribute names.  Move set_samples calls
     to var_changed_font (idea from Cheryl Sabella).  Move related
     functions to positions after the create widgets function.  In
     test_configdialog: Fix test_font_set so not order dependent.  Fix
     renamed test_indent_scale so it tests the widget.  Adjust tests for
     movement of set_samples call.  Add tests for load functions.  Put
     all font tests in one class and tab indent tests in another.
     Except for two lines, these tests completely cover the related
     functions.

   - bpo-30981(25): IDLE – Add more configdialog font page tests.

   - bpo-28523(26): IDLE: replace ‘colour’ with ‘color’ in configdialog.

   - bpo-30917(27): Add tests for idlelib.config.IdleConf.  Increase
     coverage from 46% to 96%.  Patch by Louie Lu.

   - bpo-30934(28): Document coverage details for idlelib tests.  Add
     section to idlelib/idle-test/README.txt.  Include check that
     branches are taken both ways.  Exclude IDLE-specific code that does
     not run during unit tests.

   - bpo-30913(29): IDLE: Document ConfigDialog tk Vars, methods, and
     widgets in docstrings This will facilitate improving the dialog and
     splitting up the class.  Original patch by Cheryl Sabella.

   - bpo-30899(30): IDLE: Add tests for ConfigParser subclasses in
     config.  Patch by Louie Lu.

   - bpo-30881(31): IDLE: Add docstrings to browser.py.  Patch by Cheryl
     Sabella.

   - bpo-30851(32): IDLE: Remove unused variables in configdialog.  One
     is a duplicate, one is set but cannot be altered by users.  Patch
     by Cheryl Sabella.

   - bpo-30870(33): IDLE: In Settings dialog, select font with Up, Down
     keys as well as mouse.  Initial patch by Louie Lu.

   - bpo-8231(34): IDLE: call config.IdleConf.GetUserCfgDir only once.

   - bpo-30779(35): IDLE: Factor ConfigChanges class from configdialog,
     put in config; test.  * In config, put dump test code in a
     function; run it and unittest in ‘if __name__ == ‘__main__’.  * Add
     class config.ConfigChanges based on changes_class_v4.py on bpo
     issue.  * Add class test_config.ChangesTest, partly using
     configdialog_tests_v1.py.  * Revise configdialog to use
     ConfigChanges; see tracker msg297804.  * Revise test_configdialog
     to match configdialog changes.  * Remove configdialog functions
     unused or moved to ConfigChanges.  Cheryl Sabella contributed parts
     of the patch.

   - bpo-30777(36): IDLE: configdialog - Add docstrings and fix
     comments.  Patch by Cheryl Sabella.

   - bpo-30495(37): IDLE: Improve textview with docstrings, PEP8 names,
     and more tests.  Patch by Cheryl Sabella.

   - bpo-30723(38): IDLE: Make several improvements to parenmatch.  Add
     ‘parens’ style to highlight both opener and closer.  Make ‘default’
     style, which is not default, a synonym for ‘opener’.  Make
     time-delay work the same with all styles.  Add help for config
     dialog extensions tab, including help for parenmatch.  Add new
     tests.  Original patch by Charles Wohlganger.

   - bpo-30674(39): IDLE: add docstrings to grep module.  Patch by
     Cheryl Sabella

   - bpo-21519(40): IDLE’s basic custom key entry dialog now detects
     duplicates properly.  Original patch by Saimadhav Heblikar.

   - bpo-29910(41): IDLE no longer deletes a character after commenting
     out a region by a key shortcut.  Add ‘return 'break'’ for this and
     other potential conflicts between IDLE and default key bindings.

   - bpo-30728(42): Review and change idlelib.configdialog names.
     Lowercase method and attribute names.  Replace ‘colour’ with
     ‘color’, expand overly cryptic names, delete unneeded underscores.
     Replace ‘import *’ with specific imports.  Patches by Cheryl
     Sabella.

   - bpo-6739(43): IDLE: Verify user-entered key sequences by trying to
     bind them with tk.  Add tests for all 3 validation functions.
     Original patch by G Polo.  Tests added by Cheryl Sabella.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31493

   (2) https://bugs.python.org/issue31488

   (3) https://bugs.python.org/issue31477

   (4) https://bugs.python.org/issue31480

   (5) https://bugs.python.org/issue31421

   (6) https://bugs.python.org/issue31414

   (7) https://bugs.python.org/issue31051

   (8) https://bugs.python.org/issue30617

   (9) https://bugs.python.org/issue31287

   (10) https://bugs.python.org/issue27099

   (11) https://bugs.python.org/issue31206

   (12) https://bugs.python.org/issue31001

   (13) https://bugs.python.org/issue31205

   (14) https://bugs.python.org/issue31130

   (15) https://bugs.python.org/issue31002

   (16) https://bugs.python.org/issue19903

   (17) https://bugs.python.org/issue31083

   (18) https://bugs.python.org/issue31050

   (19) https://bugs.python.org/issue31004

   (20) https://bugs.python.org/issue30781

   (21) https://bugs.python.org/issue31060

   (22) https://bugs.python.org/issue30853

   (23) https://bugs.python.org/issue31003

   (24) https://bugs.python.org/issue30993

   (25) https://bugs.python.org/issue30981

   (26) https://bugs.python.org/issue28523

   (27) https://bugs.python.org/issue30917

   (28) https://bugs.python.org/issue30934

   (29) https://bugs.python.org/issue30913

   (30) https://bugs.python.org/issue30899

   (31) https://bugs.python.org/issue30881

   (32) https://bugs.python.org/issue30851

   (33) https://bugs.python.org/issue30870

   (34) https://bugs.python.org/issue8231

   (35) https://bugs.python.org/issue30779

   (36) https://bugs.python.org/issue30777

   (37) https://bugs.python.org/issue30495

   (38) https://bugs.python.org/issue30723

   (39) https://bugs.python.org/issue30674

   (40) https://bugs.python.org/issue21519

   (41) https://bugs.python.org/issue29910

   (42) https://bugs.python.org/issue30728

   (43) https://bugs.python.org/issue6739


File: python.info,  Node: Tools/Demos<18>,  Prev: IDLE<26>,  Up: Python 3 6 3 release candidate 1

1.18.31.9 Tools/Demos
.....................

   - bpo-30983(1): gdb integration commands (py-bt, etc.)  work on
     optimized shared builds now, too.  PEP 523(2) introduced
     _PyEval_EvalFrameDefault which inlines PyEval_EvalFrameEx on
     non-debug shared builds.  This broke the ability to use py-bt,
     py-up, and a few other Python-specific gdb integrations.  The
     problem is fixed by only looking for _PyEval_EvalFrameDefault
     frames in python-gdb.py.  Original patch by Bruno “Polaco”
     Penteado.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30983

   (2) https://www.python.org/dev/peps/pep-0523


File: python.info,  Node: Python 3 6 2 final,  Next: Python 3 6 2 release candidate 2,  Prev: Python 3 6 3 release candidate 1,  Up: Changelog

1.18.32 Python 3.6.2 final
--------------------------

`Release date: 2017-07-17'

No changes since release candidate 2


File: python.info,  Node: Python 3 6 2 release candidate 2,  Next: Python 3 6 2 release candidate 1,  Prev: Python 3 6 2 final,  Up: Changelog

1.18.33 Python 3.6.2 release candidate 2
----------------------------------------

`Release date: 2017-07-07'

* Menu:

* Security: Security<15>.


File: python.info,  Node: Security<15>,  Up: Python 3 6 2 release candidate 2

1.18.33.1 Security
..................

   - bpo-30730(1): Prevent environment variables injection in subprocess
     on Windows.  Prevent passing other environment variables and
     command arguments.

   - bpo-30694(2): Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes
     of multiple security vulnerabilities including: CVE-2017-9233
     (External entity infinite loop DoS), CVE-2016-9063 (Integer
     overflow, re-fix), CVE-2016-0718 (Fix regression bugs from 2.2.0’s
     fix to CVE-2016-0718) and CVE-2012-0876 (Counter hash flooding with
     SipHash).  Note: the CVE-2016-5300 (Use os-specific entropy sources
     like getrandom) doesn’t impact Python, since Python already gets
     entropy from the OS to set the expat secret using
     ‘XML_SetHashSalt()’.

   - bpo-30500(3): Fix urllib.parse.splithost() to correctly parse
     fragments.  For example, ‘splithost('//127.0.0.1#@evil.com/')’ now
     correctly returns the ‘127.0.0.1’ host, instead of treating
     ‘@evil.com’ as the host in an authentication (‘login@host’).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30730

   (2) https://bugs.python.org/issue30694

   (3) https://bugs.python.org/issue30500


File: python.info,  Node: Python 3 6 2 release candidate 1,  Next: Python 3 6 1 final,  Prev: Python 3 6 2 release candidate 2,  Up: Changelog

1.18.34 Python 3.6.2 release candidate 1
----------------------------------------

`Release date: 2017-06-17'

* Menu:

* Core and Builtins: Core and Builtins<27>.
* Library: Library<29>.
* Security: Security<16>.
* Library: Library<30>.
* IDLE: IDLE<27>.
* C API: C API<20>.
* Build: Build<25>.
* Documentation: Documentation<27>.
* Tools/Demos: Tools/Demos<19>.
* Tests: Tests<26>.
* Windows: Windows<25>.


File: python.info,  Node: Core and Builtins<27>,  Next: Library<29>,  Up: Python 3 6 2 release candidate 1

1.18.34.1 Core and Builtins
...........................

   - bpo-30682(1): Removed a too-strict assertion that failed for
     certain f-strings, such as eval(“f’\n’”) and eval(“f’\r’”).

   - bpo-30604(2): Move co_extra_freefuncs to not be per-thread to avoid
     crashes

   - bpo-29104(3): Fixed parsing backslashes in f-strings.

   - bpo-27945(4): Fixed various segfaults with dict when input
     collections are mutated during searching, inserting or comparing.
     Based on patches by Duane Griffin and Tim Mitchell.

   - bpo-25794(5): Fixed type.__setattr__() and type.__delattr__() for
     non-interned attribute names.  Based on patch by Eryk Sun.

   - bpo-30039(6): If a KeyboardInterrupt happens when the interpreter
     is in the middle of resuming a chain of nested ‘yield from’ or
     ‘await’ calls, it’s now correctly delivered to the innermost frame.

   - bpo-12414(7): sys.getsizeof() on a code object now returns the
     sizes which includes the code struct and sizes of objects which it
     references.  Patch by Dong-hee Na.

   - bpo-29949(8): Fix memory usage regression of set and frozenset
     object.

   - bpo-29935(9): Fixed error messages in the index() method of tuple,
     list and deque when pass indices of wrong type.

   - bpo-29859(10): Show correct error messages when any of the
     pthread_* calls in thread_pthread.h fails.

   - bpo-28876(11): ‘bool(range)’ works even if ‘len(range)’ raises
     *note OverflowError: 954.

   - bpo-29600(12): Fix wrapping coroutine return values in
     StopIteration.

   - bpo-28856(13): Fix an oversight that %b format for bytes should
     support objects follow the buffer protocol.

   - bpo-29714(14): Fix a regression that bytes format may fail when
     containing zero bytes inside.

   - bpo-29478(15): If max_line_length=None is specified while using the
     Compat32 policy, it is no longer ignored.  Patch by Mircea Cosbuc.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30682

   (2) https://bugs.python.org/issue30604

   (3) https://bugs.python.org/issue29104

   (4) https://bugs.python.org/issue27945

   (5) https://bugs.python.org/issue25794

   (6) https://bugs.python.org/issue30039

   (7) https://bugs.python.org/issue12414

   (8) https://bugs.python.org/issue29949

   (9) https://bugs.python.org/issue29935

   (10) https://bugs.python.org/issue29859

   (11) https://bugs.python.org/issue28876

   (12) https://bugs.python.org/issue29600

   (13) https://bugs.python.org/issue28856

   (14) https://bugs.python.org/issue29714

   (15) https://bugs.python.org/issue29478


File: python.info,  Node: Library<29>,  Next: Security<16>,  Prev: Core and Builtins<27>,  Up: Python 3 6 2 release candidate 1

1.18.34.2 Library
.................

   - bpo-30616(1): Functional API of enum allows to create empty enums.
     Patched by Dong-hee Na

   - bpo-30038(2): Fix race condition between signal delivery and wakeup
     file descriptor.  Patch by Nathaniel Smith.

   - bpo-23894(3): lib2to3 now recognizes ‘rb'...'’ and ‘f'...'’
     strings.

   - bpo-23890(4): unittest.TestCase.assertRaises() now manually breaks
     a reference cycle to not keep objects alive longer than expected.

   - bpo-30149(5): inspect.signature() now supports callables with
     variable-argument parameters wrapped with partialmethod.  Patch by
     Dong-hee Na.

   - bpo-30645(6): Fix path calculation in imp.load_package(), fixing it
     for cases when a package is only shipped with bytecodes.  Patch by
     Alexandru Ardelean.

   - bpo-29931(7): Fixed comparison check for ipaddress.ip_interface
     objects.  Patch by Sanjay Sundaresan.

   - bpo-30605(8): re.compile() no longer raises a BytesWarning when
     compiling a bytes instance with misplaced inline modifier.  Patch
     by Roy Williams.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30616

   (2) https://bugs.python.org/issue30038

   (3) https://bugs.python.org/issue23894

   (4) https://bugs.python.org/issue23890

   (5) https://bugs.python.org/issue30149

   (6) https://bugs.python.org/issue30645

   (7) https://bugs.python.org/issue29931

   (8) https://bugs.python.org/issue30605


File: python.info,  Node: Security<16>,  Next: Library<30>,  Prev: Library<29>,  Up: Python 3 6 2 release candidate 1

1.18.34.3 Security
..................

   - bpo-29591(1): Update expat copy from 2.1.1 to 2.2.0 to get fixes of
     CVE-2016-0718 and CVE-2016-4472.  See
     ‘https://sourceforge.net/p/expat/bugs/537/’ for more information.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29591


File: python.info,  Node: Library<30>,  Next: IDLE<27>,  Prev: Security<16>,  Up: Python 3 6 2 release candidate 1

1.18.34.4 Library
.................

   - bpo-24484(1): Avoid race condition in multiprocessing cleanup
     (#2159)

   - bpo-28994(2): The traceback no longer displayed for SystemExit
     raised in a callback registered by atexit.

   - bpo-30508(3): Don’t log exceptions if Task/Future “cancel()” method
     was called.

   - bpo-28556(4): Updates to typing module: Add generic
     AsyncContextManager, add support for ContextManager on all
     versions.  Original PRs by Jelle Zijlstra and Ivan Levkivskyi

   - bpo-29870(5): Fix ssl sockets leaks when connection is aborted in
     asyncio/ssl implementation.  Patch by Michaël Sghaïer.

   - bpo-29743(6): Closing transport during handshake process leaks open
     socket.  Patch by Nikolay Kim

   - bpo-27585(7): Fix waiter cancellation in asyncio.Lock.  Patch by
     Mathieu Sornay.

   - bpo-30418(8): On Windows, subprocess.Popen.communicate() now also
     ignore EINVAL on stdin.write() if the child process is still
     running but closed the pipe.

   - bpo-29822(9): inspect.isabstract() now works during
     __init_subclass__.  Patch by Nate Soares.

   - bpo-29581(10): ABCMeta.__new__ now accepts ‘**kwargs’, allowing
     abstract base classes to use keyword parameters in
     __init_subclass__.  Patch by Nate Soares.

   - bpo-30557(11): faulthandler now correctly filters and displays
     exception codes on Windows

   - bpo-30378(12): Fix the problem that logging.handlers.SysLogHandler
     cannot handle IPv6 addresses.

   - bpo-29960(13): Preserve generator state when
     _random.Random.setstate() raises an exception.  Patch by Bryan
     Olson.

   - bpo-30414(14): multiprocessing.Queue._feed background running
     thread do not break from main loop on exception.

   - bpo-30003(15): Fix handling escape characters in HZ codec.  Based
     on patch by Ma Lin.

   - bpo-30301(16): Fix AttributeError when using SimpleQueue.empty()
     under `spawn' and `forkserver' start methods.

   - bpo-30329(17): imaplib and poplib now catch the Windows socket
     WSAEINVAL error (code 10022) on shutdown(SHUT_RDWR): An invalid
     operation was attempted.  This error occurs sometimes on SSL
     connections.

   - bpo-30375(18): Warnings emitted when compile a regular expression
     now always point to the line in the user code.  Previously they
     could point into inners of the re module if emitted from inside of
     groups or conditionals.

   - bpo-30048(19): Fixed ‘Task.cancel()’ can be ignored when the task
     is running coroutine and the coroutine returned without any more
     ‘await’.

   - bpo-30266(20): contextlib.AbstractContextManager now supports
     anti-registration by setting __enter__ = None or __exit__ = None,
     following the pattern introduced in bpo-25958(21).  Patch by Jelle
     Zijlstra.

   - bpo-30298(22): Weaken the condition of deprecation warnings for
     inline modifiers.  Now allowed several subsequential inline
     modifiers at the start of the pattern (e.g.  ‘'(?i)(?s)...'’).  In
     verbose mode whitespaces and comments now are allowed before and
     between inline modifiers (e.g.  ‘'(?x) (?i) (?s)...'’).

   - bpo-29990(23): Fix range checking in GB18030 decoder.  Original
     patch by Ma Lin.

   - bpo-26293(24): Change resulted because of zipfile breakage.  (See
     also: bpo-29094(25))

   - bpo-30243(26): Removed the __init__ methods of _json’s scanner and
     encoder.  Misusing them could cause memory leaks or crashes.  Now
     scanner and encoder objects are completely initialized in the
     __new__ methods.

   - bpo-30185(27): Avoid KeyboardInterrupt tracebacks in forkserver
     helper process when Ctrl-C is received.

   - bpo-28556(28): Various updates to typing module: add
     typing.NoReturn type, use WrapperDescriptorType, minor bug-fixes.
     Original PRs by Jim Fasarakis-Hilliard and Ivan Levkivskyi.

   - bpo-30205(29): Fix getsockname() for unbound AF_UNIX sockets on
     Linux.

   - bpo-30070(30): Fixed leaks and crashes in errors handling in the
     parser module.

   - bpo-30061(31): Fixed crashes in IOBase methods __next__() and
     readlines() when readline() or __next__() respectively return
     non-sizeable object.  Fixed possible other errors caused by not
     checking results of PyObject_Size(), PySequence_Size(), or
     PyMapping_Size().

   - bpo-30017(32): Allowed calling the close() method of the zip entry
     writer object multiple times.  Writing to a closed writer now
     always produces a ValueError.

   - bpo-30068(33): _io._IOBase.readlines will check if it’s closed
     first when hint is present.

   - bpo-29694(34): Fixed race condition in pathlib mkdir with flags
     parents=True.  Patch by Armin Rigo.

   - bpo-29692(35): Fixed arbitrary unchaining of RuntimeError
     exceptions in contextlib.contextmanager.  Patch by Siddharth
     Velankar.

   - bpo-29998(36): Pickling and copying ImportError now preserves name
     and path attributes.

   - bpo-29953(37): Fixed memory leaks in the replace() method of
     datetime and time objects when pass out of bound fold argument.

   - bpo-29942(38): Fix a crash in itertools.chain.from_iterable when
     encountering long runs of empty iterables.

   - bpo-27863(39): Fixed multiple crashes in ElementTree caused by race
     conditions and wrong types.

   - bpo-28699(40): Fixed a bug in pools in multiprocessing.pool that
     raising an exception at the very first of an iterable may swallow
     the exception or make the program hang.  Patch by Davin Potts and
     Xiang Zhang.

   - bpo-25803(41): Avoid incorrect errors raised by
     Path.mkdir(exist_ok=True) when the OS gives priority to errors such
     as EACCES over EEXIST.

   - bpo-29861(42): Release references to tasks, their arguments and
     their results as soon as they are finished in multiprocessing.Pool.

   - bpo-29884(43): faulthandler: Restore the old sigaltstack during
     teardown.  Patch by Christophe Zeitouny.

   - bpo-25455(44): Fixed crashes in repr of recursive buffered
     file-like objects.

   - bpo-29800(45): Fix crashes in partial.__repr__ if the keys of
     partial.keywords are not strings.  Patch by Michael Seifert.

   - bpo-29742(46): get_extra_info() raises exception if get called on
     closed ssl transport.  Patch by Nikolay Kim.

   - bpo-8256(47): Fixed possible failing or crashing input() if
     attributes “encoding” or “errors” of sys.stdin or sys.stdout are
     not set or are not strings.

   - bpo-28298(48): Fix a bug that prevented array ‘Q’, ‘L’ and ‘I’ from
     accepting big intables (objects that have __int__) as elements.
     Patch by Oren Milman.

   - bpo-28231(49): The zipfile module now accepts path-like objects for
     external paths.

   - bpo-26915(50): index() and count() methods of
     collections.abc.Sequence now check identity before checking
     equality when do comparisons.

   - bpo-29615(51): SimpleXMLRPCDispatcher no longer chains KeyError (or
     any other exception) to exception(s) raised in the dispatched
     methods.  Patch by Petr Motejlek.

   - bpo-30177(52): path.resolve(strict=False) no longer cuts the path
     after the first element not present in the filesystem.  Patch by
     Antoine Pietri.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24484

   (2) https://bugs.python.org/issue28994

   (3) https://bugs.python.org/issue30508

   (4) https://bugs.python.org/issue28556

   (5) https://bugs.python.org/issue29870

   (6) https://bugs.python.org/issue29743

   (7) https://bugs.python.org/issue27585

   (8) https://bugs.python.org/issue30418

   (9) https://bugs.python.org/issue29822

   (10) https://bugs.python.org/issue29581

   (11) https://bugs.python.org/issue30557

   (12) https://bugs.python.org/issue30378

   (13) https://bugs.python.org/issue29960

   (14) https://bugs.python.org/issue30414

   (15) https://bugs.python.org/issue30003

   (16) https://bugs.python.org/issue30301

   (17) https://bugs.python.org/issue30329

   (18) https://bugs.python.org/issue30375

   (19) https://bugs.python.org/issue30048

   (20) https://bugs.python.org/issue30266

   (21) https://bugs.python.org/issue25958

   (22) https://bugs.python.org/issue30298

   (23) https://bugs.python.org/issue29990

   (24) https://bugs.python.org/issue26293

   (25) https://bugs.python.org/issue29094

   (26) https://bugs.python.org/issue30243

   (27) https://bugs.python.org/issue30185

   (28) https://bugs.python.org/issue28556

   (29) https://bugs.python.org/issue30205

   (30) https://bugs.python.org/issue30070

   (31) https://bugs.python.org/issue30061

   (32) https://bugs.python.org/issue30017

   (33) https://bugs.python.org/issue30068

   (34) https://bugs.python.org/issue29694

   (35) https://bugs.python.org/issue29692

   (36) https://bugs.python.org/issue29998

   (37) https://bugs.python.org/issue29953

   (38) https://bugs.python.org/issue29942

   (39) https://bugs.python.org/issue27863

   (40) https://bugs.python.org/issue28699

   (41) https://bugs.python.org/issue25803

   (42) https://bugs.python.org/issue29861

   (43) https://bugs.python.org/issue29884

   (44) https://bugs.python.org/issue25455

   (45) https://bugs.python.org/issue29800

   (46) https://bugs.python.org/issue29742

   (47) https://bugs.python.org/issue8256

   (48) https://bugs.python.org/issue28298

   (49) https://bugs.python.org/issue28231

   (50) https://bugs.python.org/issue26915

   (51) https://bugs.python.org/issue29615

   (52) https://bugs.python.org/issue30177


File: python.info,  Node: IDLE<27>,  Next: C API<20>,  Prev: Library<30>,  Up: Python 3 6 2 release candidate 1

1.18.34.5 IDLE
..............

   - bpo-15786(1): Fix several problems with IDLE’s autocompletion box.
     The following should now work: clicking on selection box items;
     using the scrollbar; selecting an item by hitting Return.  Hangs on
     MacOSX should no longer happen.  Patch by Louie Lu.

   - bpo-25514(2): Add doc subsubsection about IDLE failure to start.
     Popup no-connection message directs users to this section.

   - bpo-30642(3): Fix reference leaks in IDLE tests.  Patches by Louie
     Lu and Terry Jan Reedy.

   - bpo-30495(4): Add docstrings for textview.py and use PEP8 names.
     Patches by Cheryl Sabella and Terry Jan Reedy.

   - bpo-30290(5): Help-about: use pep8 names and add tests.  Increase
     coverage to 100%.  Patches by Louie Lu, Cheryl Sabella, and Terry
     Jan Reedy.

   - bpo-30303(6): Add _utest option to textview; add new tests.
     Increase coverage to 100%.  Patches by Louie Lu and Terry Jan
     Reedy.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15786

   (2) https://bugs.python.org/issue25514

   (3) https://bugs.python.org/issue30642

   (4) https://bugs.python.org/issue30495

   (5) https://bugs.python.org/issue30290

   (6) https://bugs.python.org/issue30303


File: python.info,  Node: C API<20>,  Next: Build<25>,  Prev: IDLE<27>,  Up: Python 3 6 2 release candidate 1

1.18.34.6 C API
...............

   - bpo-27867(1): Function PySlice_GetIndicesEx() no longer replaced
     with a macro if Py_LIMITED_API is not set.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27867


File: python.info,  Node: Build<25>,  Next: Documentation<27>,  Prev: C API<20>,  Up: Python 3 6 2 release candidate 1

1.18.34.7 Build
...............

   - bpo-29941(1): Add ‘--with-assertions’ configure flag to explicitly
     enable C ‘assert()’ checks.  Defaults to off.  ‘--with-pydebug’
     implies ‘--with-assertions’.

   - bpo-28787(2): Fix out-of-tree builds of Python when configured with
     ‘--with--dtrace’.

   - bpo-29243(3): Prevent unnecessary rebuilding of Python during ‘make
     test’, ‘make install’ and some other make targets when configured
     with ‘--enable-optimizations’.

   - bpo-23404(4): Don’t regenerate generated files based on file
     modification time anymore: the action is now explicit.  Replace
     ‘make touch’ with ‘make regen-all’.

   - bpo-29643(5): Fix ‘--enable-optimization’ didn’t work.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29941

   (2) https://bugs.python.org/issue28787

   (3) https://bugs.python.org/issue29243

   (4) https://bugs.python.org/issue23404

   (5) https://bugs.python.org/issue29643


File: python.info,  Node: Documentation<27>,  Next: Tools/Demos<19>,  Prev: Build<25>,  Up: Python 3 6 2 release candidate 1

1.18.34.8 Documentation
.......................

   - bpo-30176(1): Add missing attribute related constants in curses
     documentation.

   - bpo-30052(2): the link targets for *note bytes(): 326. and *note
     bytearray(): 327. are now their respective type definitions, rather
     than the corresponding builtin function entries.  Use *note bytes:
     ff6. and *note bytearray: ff7. to reference the latter.  In order
     to ensure this and future cross-reference updates are applied
     automatically, the daily documentation builds now disable the
     default output caching features in Sphinx.

   - bpo-26985(3): Add missing info of code object in inspect
     documentation.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30176

   (2) https://bugs.python.org/issue30052

   (3) https://bugs.python.org/issue26985


File: python.info,  Node: Tools/Demos<19>,  Next: Tests<26>,  Prev: Documentation<27>,  Up: Python 3 6 2 release candidate 1

1.18.34.9 Tools/Demos
.....................

   - bpo-29367(1): python-gdb.py now supports also ‘method-wrapper’
     (‘wrapperobject’) objects.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29367


File: python.info,  Node: Tests<26>,  Next: Windows<25>,  Prev: Tools/Demos<19>,  Up: Python 3 6 2 release candidate 1

1.18.34.10 Tests
................

   - bpo-30357(1): test_thread: setUp() now uses
     support.threading_setup() and support.threading_cleanup() to wait
     until threads complete to avoid random side effects on following
     tests.  Initial patch written by Grzegorz Grzywacz.

   - bpo-30197(2): Enhanced functions swap_attr() and swap_item() in the
     test.support module.  They now work when delete replaced attribute
     or item inside the with statement.  The old value of the attribute
     or item (or None if it doesn’t exist) now will be assigned to the
     target of the “as” clause, if there is one.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30357

   (2) https://bugs.python.org/issue30197


File: python.info,  Node: Windows<25>,  Prev: Tests<26>,  Up: Python 3 6 2 release candidate 1

1.18.34.11 Windows
..................

   - bpo-30687(1): Locate msbuild.exe on Windows when building rather
     than vcvarsall.bat

   - bpo-30450(2): The build process on Windows no longer depends on
     Subversion, instead pulling external code from GitHub via a Python
     script.  If Python 3.6 is not found on the system (via ‘py -3.6’),
     NuGet is used to download a copy of 32-bit Python.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30687

   (2) https://bugs.python.org/issue30450


File: python.info,  Node: Python 3 6 1 final,  Next: Python 3 6 1 release candidate 1,  Prev: Python 3 6 2 release candidate 1,  Up: Changelog

1.18.35 Python 3.6.1 final
--------------------------

`Release date: 2017-03-21'

* Menu:

* Core and Builtins: Core and Builtins<28>.
* Build: Build<26>.


File: python.info,  Node: Core and Builtins<28>,  Next: Build<26>,  Up: Python 3 6 1 final

1.18.35.1 Core and Builtins
...........................

   - bpo-29723(1): The ‘sys.path[0]’ initialization change for
     bpo-29139(2) caused a regression by revealing an inconsistency in
     how sys.path is initialized when executing ‘__main__’ from a
     zipfile, directory, or other import location.  The interpreter now
     consistently avoids ever adding the import location’s parent
     directory to ‘sys.path’, and ensures no other ‘sys.path’ entries
     are inadvertently modified when inserting the import location named
     on the command line.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29723

   (2) https://bugs.python.org/issue29139


File: python.info,  Node: Build<26>,  Prev: Core and Builtins<28>,  Up: Python 3 6 1 final

1.18.35.2 Build
...............

   - bpo-27593(1): fix format of git information used in sys.version

   - Fix incompatible comment in python.h

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27593


File: python.info,  Node: Python 3 6 1 release candidate 1,  Next: Python 3 6 0 final,  Prev: Python 3 6 1 final,  Up: Changelog

1.18.36 Python 3.6.1 release candidate 1
----------------------------------------

`Release date: 2017-03-04'

* Menu:

* Core and Builtins: Core and Builtins<29>.
* Library: Library<31>.
* IDLE: IDLE<28>.
* Windows: Windows<26>.
* C API: C API<21>.
* Documentation: Documentation<28>.
* Tests: Tests<27>.
* Build: Build<27>.


File: python.info,  Node: Core and Builtins<29>,  Next: Library<31>,  Up: Python 3 6 1 release candidate 1

1.18.36.1 Core and Builtins
...........................

   - bpo-28893(1): Set correct __cause__ for errors about invalid
     awaitables returned from __aiter__ and __anext__.

   - bpo-29683(2): Fixes to memory allocation in _PyCode_SetExtra.
     Patch by Brian Coleman.

   - bpo-29684(3): Fix minor regression of
     PyEval_CallObjectWithKeywords.  It should raise TypeError when
     kwargs is not a dict.  But it might cause segv when args=NULL and
     kwargs is not a dict.

   - bpo-28598(4): Support __rmod__ for subclasses of str being called
     before str.__mod__.  Patch by Martijn Pieters.

   - bpo-29607(5): Fix stack_effect computation for CALL_FUNCTION_EX.
     Patch by Matthieu Dartiailh.

   - bpo-29602(6): Fix incorrect handling of signed zeros in complex
     constructor for complex subclasses and for inputs having a
     __complex__ method.  Patch by Serhiy Storchaka.

   - bpo-29347(7): Fixed possibly dereferencing undefined pointers when
     creating weakref objects.

   - bpo-29438(8): Fixed use-after-free problem in key sharing dict.

   - bpo-29319(9): Prevent RunMainFromImporter overwriting sys.path[0].

   - bpo-29337(10): Fixed possible BytesWarning when compare the code
     objects.  Warnings could be emitted at compile time.

   - bpo-29327(11): Fixed a crash when pass the iterable keyword
     argument to sorted().

   - bpo-29034(12): Fix memory leak and use-after-free in os module
     (path_converter).

   - bpo-29159(13): Fix regression in bytes(x) when x.__index__() raises
     Exception.

   - bpo-28932(14): Do not include <sys/random.h> if it does not exist.

   - bpo-25677(15): Correct the positioning of the syntax error caret
     for indented blocks.  Based on patch by Michael Layzell.

   - bpo-29000(16): Fixed bytes formatting of octals with zero padding
     in alternate form.

   - bpo-26919(17): On Android, operating system data is now always
     encoded/decoded to/from UTF-8, instead of the locale encoding to
     avoid inconsistencies with os.fsencode() and os.fsdecode() which
     are already using UTF-8.

   - bpo-28991(18): functools.lru_cache() was susceptible to an obscure
     reentrancy bug triggerable by a monkey-patched len() function.

   - bpo-28739(19): f-string expressions are no longer accepted as
     docstrings and by ast.literal_eval() even if they do not include
     expressions.

   - bpo-28512(20): Fixed setting the offset attribute of SyntaxError by
     PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

   - bpo-28918(21): Fix the cross compilation of xxlimited when Python
     has been built with Py_DEBUG defined.

   - bpo-28731(22): Optimize _PyDict_NewPresized() to create correct
     size dict.  Improve speed of dict literal with constant keys up to
     30%.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28893

   (2) https://bugs.python.org/issue29683

   (3) https://bugs.python.org/issue29684

   (4) https://bugs.python.org/issue28598

   (5) https://bugs.python.org/issue29607

   (6) https://bugs.python.org/issue29602

   (7) https://bugs.python.org/issue29347

   (8) https://bugs.python.org/issue29438

   (9) https://bugs.python.org/issue29319

   (10) https://bugs.python.org/issue29337

   (11) https://bugs.python.org/issue29327

   (12) https://bugs.python.org/issue29034

   (13) https://bugs.python.org/issue29159

   (14) https://bugs.python.org/issue28932

   (15) https://bugs.python.org/issue25677

   (16) https://bugs.python.org/issue29000

   (17) https://bugs.python.org/issue26919

   (18) https://bugs.python.org/issue28991

   (19) https://bugs.python.org/issue28739

   (20) https://bugs.python.org/issue28512

   (21) https://bugs.python.org/issue28918

   (22) https://bugs.python.org/issue28731


File: python.info,  Node: Library<31>,  Next: IDLE<28>,  Prev: Core and Builtins<29>,  Up: Python 3 6 1 release candidate 1

1.18.36.2 Library
.................

   - bpo-29169(1): Update zlib to 1.2.11.

   - bpo-29623(2): Allow use of path-like object as a single argument in
     ConfigParser.read().  Patch by David Ellis.

   - bpo-28963(3): Fix out of bound iteration in
     asyncio.Future.remove_done_callback implemented in C.

   - bpo-29704(4): asyncio.subprocess.SubprocessStreamProtocol no longer
     closes before all pipes are closed.

   - bpo-29271(5): Fix Task.current_task and Task.all_tasks implemented
     in C to accept None argument as their pure Python implementation.

   - bpo-29703(6): Fix asyncio to support instantiation of new event
     loops in child processes.

   - bpo-29376(7): Fix assertion error in
     threading._DummyThread.is_alive().

   - bpo-28624(8): Add a test that checks that cwd parameter of Popen()
     accepts PathLike objects.  Patch by Sayan Chowdhury.

   - bpo-28518(9): Start a transaction implicitly before a DML
     statement.  Patch by Aviv Palivoda.

   - bpo-29532(10): Altering a kwarg dictionary passed to
     functools.partial() no longer affects a partial object after
     creation.

   - bpo-29110(11): Fix file object leak in aifc.open() when file is
     given as a filesystem path and is not in valid AIFF format.  Patch
     by Anthony Zhang.

   - bpo-28556(12): Various updates to typing module: typing.Counter,
     typing.ChainMap, improved ABC caching, etc.  Original PRs by Jelle
     Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

   - bpo-29100(13): Fix datetime.fromtimestamp() regression introduced
     in Python 3.6.0: check minimum and maximum years.

   - bpo-29519(14): Fix weakref spewing exceptions during interpreter
     shutdown when used with a rare combination of multiprocessing and
     custom codecs.

   - bpo-29416(15): Prevent infinite loop in pathlib.Path.mkdir

   - bpo-29444(16): Fixed out-of-bounds buffer access in the group()
     method of the match object.  Based on patch by WGH.

   - bpo-29335(17): Fix subprocess.Popen.wait() when the child process
     has exited to a stopped instead of terminated state (ex: when under
     ptrace).

   - bpo-29290(18): Fix a regression in argparse that help messages
     would wrap at non-breaking spaces.

   - bpo-28735(19): Fixed the comparison of mock.MagickMock with
     mock.ANY.

   - bpo-29316(20): Restore the provisional status of typing module, add
     corresponding note to documentation.  Patch by Ivan L.

   - bpo-29219(21): Fixed infinite recursion in the repr of
     uninitialized ctypes.CDLL instances.

   - bpo-29011(22): Fix an important omission by adding Deque to the
     typing module.

   - bpo-28969(23): Fixed race condition in C implementation of
     functools.lru_cache.  KeyError could be raised when cached function
     with full cache was simultaneously called from different threads
     with the same uncached arguments.

   - bpo-29142(24): In urllib.request, suffixes in no_proxy environment
     variable with leading dots could match related hostnames again
     (e.g.  .b.c matches a.b.c).  Patch by Milan Oberkirch.

   - bpo-28961(25): Fix unittest.mock._Call helper: don’t ignore the
     name parameter anymore.  Patch written by Jiajun Huang.

   - bpo-29203(26): functools.lru_cache() now respects PEP 468(27) and
     preserves the order of keyword arguments.  f(a=1, b=2) is now
     cached separately from f(b=2, a=1) since both calls could
     potentially give different results.

   - bpo-15812(28): inspect.getframeinfo() now correctly shows the first
     line of a context.  Patch by Sam Breese.

   - bpo-29094(29): Offsets in a ZIP file created with extern file
     object and modes “w” and “x” now are relative to the start of the
     file.

   - bpo-29085(30): Allow random.Random.seed() to use high quality OS
     randomness rather than the pid and time.

   - bpo-29061(31): Fixed bug in secrets.randbelow() which would hang
     when given a negative input.  Patch by Brendan Donegan.

   - bpo-29079(32): Prevent infinite loop in pathlib.resolve() on
     Windows

   - bpo-13051(33): Fixed recursion errors in large or resized
     curses.textpad.Textbox.  Based on patch by Tycho Andersen.

   - bpo-29119(34): Fix weakrefs in the pure python version of
     collections.OrderedDict move_to_end() method.  Contributed by Andra
     Bogildea.

   - bpo-9770(35): curses.ascii predicates now work correctly with
     negative integers.

   - bpo-28427(36): old keys should not remove new values from
     WeakValueDictionary when collecting from another thread.

   - bpo-28923(37): Remove editor artifacts from Tix.py.

   - bpo-29055(38): Neaten-up empty population error on random.choice()
     by suppressing the upstream exception.

   - bpo-28871(39): Fixed a crash when deallocate deep ElementTree.

   - bpo-19542(40): Fix bugs in WeakValueDictionary.setdefault() and
     WeakValueDictionary.pop() when a GC collection happens in another
     thread.

   - bpo-20191(41): Fixed a crash in resource.prlimit() when passing a
     sequence that doesn’t own its elements as limits.

   - bpo-28779(42): multiprocessing.set_forkserver_preload() would crash
     the forkserver process if a preloaded module instantiated some
     multiprocessing objects such as locks.

   - bpo-28847(43): dbm.dumb now supports reading read-only files and no
     longer writes the index file when it is not changed.

   - bpo-26937(44): The chown() method of the tarfile.TarFile class does
     not fail now when the grp module cannot be imported, as for example
     on Android platforms.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29169

   (2) https://bugs.python.org/issue29623

   (3) https://bugs.python.org/issue28963

   (4) https://bugs.python.org/issue29704

   (5) https://bugs.python.org/issue29271

   (6) https://bugs.python.org/issue29703

   (7) https://bugs.python.org/issue29376

   (8) https://bugs.python.org/issue28624

   (9) https://bugs.python.org/issue28518

   (10) https://bugs.python.org/issue29532

   (11) https://bugs.python.org/issue29110

   (12) https://bugs.python.org/issue28556

   (13) https://bugs.python.org/issue29100

   (14) https://bugs.python.org/issue29519

   (15) https://bugs.python.org/issue29416

   (16) https://bugs.python.org/issue29444

   (17) https://bugs.python.org/issue29335

   (18) https://bugs.python.org/issue29290

   (19) https://bugs.python.org/issue28735

   (20) https://bugs.python.org/issue29316

   (21) https://bugs.python.org/issue29219

   (22) https://bugs.python.org/issue29011

   (23) https://bugs.python.org/issue28969

   (24) https://bugs.python.org/issue29142

   (25) https://bugs.python.org/issue28961

   (26) https://bugs.python.org/issue29203

   (27) https://www.python.org/dev/peps/pep-0468

   (28) https://bugs.python.org/issue15812

   (29) https://bugs.python.org/issue29094

   (30) https://bugs.python.org/issue29085

   (31) https://bugs.python.org/issue29061

   (32) https://bugs.python.org/issue29079

   (33) https://bugs.python.org/issue13051

   (34) https://bugs.python.org/issue29119

   (35) https://bugs.python.org/issue9770

   (36) https://bugs.python.org/issue28427

   (37) https://bugs.python.org/issue28923

   (38) https://bugs.python.org/issue29055

   (39) https://bugs.python.org/issue28871

   (40) https://bugs.python.org/issue19542

   (41) https://bugs.python.org/issue20191

   (42) https://bugs.python.org/issue28779

   (43) https://bugs.python.org/issue28847

   (44) https://bugs.python.org/issue26937


File: python.info,  Node: IDLE<28>,  Next: Windows<26>,  Prev: Library<31>,  Up: Python 3 6 1 release candidate 1

1.18.36.3 IDLE
..............

   - bpo-29071(1): IDLE colors f-string prefixes (but not invalid ur
     prefixes).

   - bpo-28572(2): Add 10% to coverage of IDLE’s test_configdialog.
     Update and augment description of the configuration system.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29071

   (2) https://bugs.python.org/issue28572


File: python.info,  Node: Windows<26>,  Next: C API<21>,  Prev: IDLE<28>,  Up: Python 3 6 1 release candidate 1

1.18.36.4 Windows
.................

   - bpo-29579(1): Removes readme.txt from the installer

   - bpo-29326(2): Ignores blank lines in ._pth files (Patch by Alexey
     Izbyshev)

   - bpo-28164(3): Correctly handle special console filenames (patch by
     Eryk Sun)

   - bpo-29409(4): Implement PEP 529(5) for io.FileIO (Patch by Eryk
     Sun)

   - bpo-29392(6): Prevent crash when passing invalid arguments into
     msvcrt module.

   - bpo-25778(7): winreg does not truncate string correctly (Patch by
     Eryk Sun)

   - bpo-28896(8): Deprecate WindowsRegistryFinder and disable it by
     default.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29579

   (2) https://bugs.python.org/issue29326

   (3) https://bugs.python.org/issue28164

   (4) https://bugs.python.org/issue29409

   (5) https://www.python.org/dev/peps/pep-0529

   (6) https://bugs.python.org/issue29392

   (7) https://bugs.python.org/issue25778

   (8) https://bugs.python.org/issue28896


File: python.info,  Node: C API<21>,  Next: Documentation<28>,  Prev: Windows<26>,  Up: Python 3 6 1 release candidate 1

1.18.36.5 C API
...............

   - bpo-27867(1): Function PySlice_GetIndicesEx() is replaced with a
     macro if Py_LIMITED_API is not set or set to the value between
     0x03050400 and 0x03060000 (not including) or 0x03060100 or higher.

   - bpo-29083(2): Fixed the declaration of some public API functions.
     PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not
     available in limited API. PyArg_ValidateKeywordArguments(),
     PyArg_UnpackTuple() and Py_BuildValue() were not available in
     limited API of version < 3.3 when PY_SSIZE_T_CLEAN is defined.

   - bpo-29058(3): All stable API extensions added after Python 3.2 are
     now available only when Py_LIMITED_API is set to the PY_VERSION_HEX
     value of the minimum Python version supporting this API.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27867

   (2) https://bugs.python.org/issue29083

   (3) https://bugs.python.org/issue29058


File: python.info,  Node: Documentation<28>,  Next: Tests<27>,  Prev: C API<21>,  Up: Python 3 6 1 release candidate 1

1.18.36.6 Documentation
.......................

   - bpo-28929(1): Link the documentation to its source file on GitHub.

   - bpo-25008(2): Document smtpd.py as effectively deprecated and add a
     pointer to aiosmtpd, a third-party asyncio-based replacement.

   - bpo-26355(3): Add canonical header link on each page to
     corresponding major version of the documentation.  Patch by
     Matthias Bussonnier.

   - bpo-29349(4): Fix Python 2 syntax in code for building the
     documentation.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28929

   (2) https://bugs.python.org/issue25008

   (3) https://bugs.python.org/issue26355

   (4) https://bugs.python.org/issue29349


File: python.info,  Node: Tests<27>,  Next: Build<27>,  Prev: Documentation<28>,  Up: Python 3 6 1 release candidate 1

1.18.36.7 Tests
...............

   - bpo-28087(1): Skip test_asyncore and test_eintr poll failures on
     macOS. Skip some tests of select.poll when running on macOS due to
     unresolved issues with the underlying system poll function on some
     macOS versions.

   - bpo-29571(2): to match the behaviour of the ‘re.LOCALE’ flag,
     test_re.test_locale_flag now uses
     ‘locale.getpreferredencoding(False)’ to determine the candidate
     encoding for the test regex (allowing it to correctly skip the test
     when the default locale encoding is a multi-byte encoding)

   - bpo-28950(3): Disallow -j0 to be combined with -T/-l in regrtest
     command line arguments.

   - bpo-28683(4): Fix the tests that bind() a unix socket and raise
     PermissionError on Android for a non-root user.

   - bpo-26939(5): Add the support.setswitchinterval() function to fix
     test_functools hanging on the Android armv7 qemu emulator.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28087

   (2) https://bugs.python.org/issue29571

   (3) https://bugs.python.org/issue28950

   (4) https://bugs.python.org/issue28683

   (5) https://bugs.python.org/issue26939


File: python.info,  Node: Build<27>,  Prev: Tests<27>,  Up: Python 3 6 1 release candidate 1

1.18.36.8 Build
...............

   - bpo-27593(1): sys.version and the platform module python_build(),
     python_branch(), and python_revision() functions now use git
     information rather than hg when building from a repo.

   - bpo-29572(2): Update Windows build and OS X installers to use
     OpenSSL 1.0.2k.

   - bpo-26851(3): Set Android compilation and link flags.

   - bpo-28768(4): Fix implicit declaration of function _setmode.  Patch
     by Masayuki Yamamoto

   - bpo-29080(5): Removes hard dependency on hg.exe from
     PCBuild/build.bat

   - bpo-23903(6): Added missed names to PC/python3.def.

   - bpo-28762(7): lockf() is available on Android API level 24, but the
     F_LOCK macro is not defined in android-ndk-r13.

   - bpo-28538(8): Fix the compilation error that occurs because
     if_nameindex() is available on Android API level 24, but the
     if_nameindex structure is not defined.

   - bpo-20211(9): Do not add the directory for installing C header
     files and the directory for installing object code libraries to the
     cross compilation search paths.  Original patch by Thomas
     Petazzoni.

   - bpo-28849(10): Do not define sys.implementation._multiarch on
     Android.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27593

   (2) https://bugs.python.org/issue29572

   (3) https://bugs.python.org/issue26851

   (4) https://bugs.python.org/issue28768

   (5) https://bugs.python.org/issue29080

   (6) https://bugs.python.org/issue23903

   (7) https://bugs.python.org/issue28762

   (8) https://bugs.python.org/issue28538

   (9) https://bugs.python.org/issue20211

   (10) https://bugs.python.org/issue28849


File: python.info,  Node: Python 3 6 0 final,  Next: Python 3 6 0 release candidate 2,  Prev: Python 3 6 1 release candidate 1,  Up: Changelog

1.18.37 Python 3.6.0 final
--------------------------

`Release date: 2016-12-23'

No changes since release candidate 2


File: python.info,  Node: Python 3 6 0 release candidate 2,  Next: Python 3 6 0 release candidate 1,  Prev: Python 3 6 0 final,  Up: Changelog

1.18.38 Python 3.6.0 release candidate 2
----------------------------------------

`Release date: 2016-12-16'

* Menu:

* Core and Builtins: Core and Builtins<30>.
* Tools/Demos: Tools/Demos<20>.
* Windows: Windows<27>.
* Build: Build<28>.


File: python.info,  Node: Core and Builtins<30>,  Next: Tools/Demos<20>,  Up: Python 3 6 0 release candidate 2

1.18.38.1 Core and Builtins
...........................

   - bpo-28147(1): Fix a memory leak in split-table dictionaries:
     setattr() must not convert combined table into split table.  Patch
     written by INADA Naoki.

   - bpo-28990(2): Fix asyncio SSL hanging if connection is closed
     before handshake is completed.  (Patch by HoHo-Ho)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28147

   (2) https://bugs.python.org/issue28990


File: python.info,  Node: Tools/Demos<20>,  Next: Windows<27>,  Prev: Core and Builtins<30>,  Up: Python 3 6 0 release candidate 2

1.18.38.2 Tools/Demos
.....................

   - bpo-28770(1): Fix python-gdb.py for fastcalls.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28770


File: python.info,  Node: Windows<27>,  Next: Build<28>,  Prev: Tools/Demos<20>,  Up: Python 3 6 0 release candidate 2

1.18.38.3 Windows
.................

   - bpo-28896(1): Deprecate WindowsRegistryFinder.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28896


File: python.info,  Node: Build<28>,  Prev: Windows<27>,  Up: Python 3 6 0 release candidate 2

1.18.38.4 Build
...............

   - bpo-28898(1): Prevent gdb build errors due to HAVE_LONG_LONG
     redefinition.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28898


File: python.info,  Node: Python 3 6 0 release candidate 1,  Next: Python 3 6 0 beta 4,  Prev: Python 3 6 0 release candidate 2,  Up: Changelog

1.18.39 Python 3.6.0 release candidate 1
----------------------------------------

`Release date: 2016-12-06'

* Menu:

* Core and Builtins: Core and Builtins<31>.
* Library: Library<32>.
* C API: C API<22>.
* Documentation: Documentation<29>.
* Tools/Demos: Tools/Demos<21>.


File: python.info,  Node: Core and Builtins<31>,  Next: Library<32>,  Up: Python 3 6 0 release candidate 1

1.18.39.1 Core and Builtins
...........................

   - bpo-23722(1): Rather than silently producing a class that doesn’t
     support zero-argument ‘super()’ in methods, failing to pass the new
     ‘__classcell__’ namespace entry up to ‘type.__new__’ now results in
     a ‘DeprecationWarning’ and a class that supports zero-argument
     ‘super()’.

   - bpo-28797(2): Modifying the class __dict__ inside the __set_name__
     method of a descriptor that is used inside that class no longer
     prevents calling the __set_name__ method of other descriptors.

   - bpo-28782(3): Fix a bug in the implementation ‘yield from’ when
     checking if the next instruction is YIELD_FROM. Regression
     introduced by WORDCODE (bpo-26647(4)).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23722

   (2) https://bugs.python.org/issue28797

   (3) https://bugs.python.org/issue28782

   (4) https://bugs.python.org/issue26647


File: python.info,  Node: Library<32>,  Next: C API<22>,  Prev: Core and Builtins<31>,  Up: Python 3 6 0 release candidate 1

1.18.39.2 Library
.................

   - bpo-27030(1): Unknown escapes in re.sub() replacement template are
     allowed again.  But they still are deprecated and will be disabled
     in 3.7.

   - bpo-28835(2): Fix a regression introduced in
     warnings.catch_warnings(): call warnings.showwarning() if it was
     overridden inside the context manager.

   - bpo-27172(3): To assist with upgrades from 2.7, the previously
     documented deprecation of ‘inspect.getfullargspec()’ has been
     reversed.  This decision may be revisited again after the Python
     2.7 branch is no longer officially supported.

   - bpo-26273(4): Add new ‘socket.TCP_CONGESTION’ (Linux 2.6.13) and
     ‘socket.TCP_USER_TIMEOUT’ (Linux 2.6.37) constants.  Patch written
     by Omar Sandoval.

   - bpo-24142(5): Reading a corrupt config file left configparser in an
     invalid state.  Original patch by Florian Höch.

   - bpo-28843(6): Fix asyncio C Task to handle exceptions
     __traceback__.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27030

   (2) https://bugs.python.org/issue28835

   (3) https://bugs.python.org/issue27172

   (4) https://bugs.python.org/issue26273

   (5) https://bugs.python.org/issue24142

   (6) https://bugs.python.org/issue28843


File: python.info,  Node: C API<22>,  Next: Documentation<29>,  Prev: Library<32>,  Up: Python 3 6 0 release candidate 1

1.18.39.3 C API
...............

   - bpo-28808(1): PyUnicode_CompareWithASCIIString() now never raises
     exceptions.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28808


File: python.info,  Node: Documentation<29>,  Next: Tools/Demos<21>,  Prev: C API<22>,  Up: Python 3 6 0 release candidate 1

1.18.39.4 Documentation
.......................

   - bpo-23722(1): The data model reference and the porting section in
     the What’s New guide now cover the additional ‘__classcell__’
     handling needed for custom metaclasses to fully support PEP 487(2)
     and zero-argument ‘super()’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23722

   (2) https://www.python.org/dev/peps/pep-0487


File: python.info,  Node: Tools/Demos<21>,  Prev: Documentation<29>,  Up: Python 3 6 0 release candidate 1

1.18.39.5 Tools/Demos
.....................

   - bpo-28023(1): Fix python-gdb.py didn’t support new dict
     implementation.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28023


File: python.info,  Node: Python 3 6 0 beta 4,  Next: Python 3 6 0 beta 3,  Prev: Python 3 6 0 release candidate 1,  Up: Changelog

1.18.40 Python 3.6.0 beta 4
---------------------------

`Release date: 2016-11-21'

* Menu:

* Core and Builtins: Core and Builtins<32>.
* Library: Library<33>.
* Documentation: Documentation<30>.
* Tests: Tests<28>.
* Build: Build<29>.


File: python.info,  Node: Core and Builtins<32>,  Next: Library<33>,  Up: Python 3 6 0 beta 4

1.18.40.1 Core and Builtins
...........................

   - bpo-28532(1): Show sys.version when -V option is supplied twice.

   - bpo-27100(2): The with-statement now checks for __enter__ before it
     checks for __exit__.  This gives less confusing error messages when
     both methods are missing.  Patch by Jonathan Ellington.

   - bpo-28746(3): Fix the set_inheritable() file descriptor method on
     platforms that do not have the ioctl FIOCLEX and FIONCLEX commands.

   - bpo-26920(4): Fix not getting the locale’s charset upon
     initializing the interpreter, on platforms that do not have
     langinfo.

   - bpo-28648(5): Fixed crash in Py_DecodeLocale() in debug build on
     Mac OS X when decode astral characters.  Patch by Xiang Zhang.

   - bpo-19398(6): Extra slash no longer added to sys.path components in
     case of empty compile-time PYTHONPATH components.

   - bpo-28665(7): Improve speed of the STORE_DEREF opcode by 40%.

   - bpo-28583(8): PyDict_SetDefault didn’t combine split table when
     needed.  Patch by Xiang Zhang.

   - bpo-27243(9): Change PendingDeprecationWarning ->
     DeprecationWarning.  As it was agreed in the issue, __aiter__
     returning an awaitable should result in PendingDeprecationWarning
     in 3.5 and in DeprecationWarning in 3.6.

   - bpo-26182(10): Fix a refleak in code that raises
     DeprecationWarning.

   - bpo-28721(11): Fix asynchronous generators aclose() and athrow() to
     handle StopAsyncIteration propagation properly.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28532

   (2) https://bugs.python.org/issue27100

   (3) https://bugs.python.org/issue28746

   (4) https://bugs.python.org/issue26920

   (5) https://bugs.python.org/issue28648

   (6) https://bugs.python.org/issue19398

   (7) https://bugs.python.org/issue28665

   (8) https://bugs.python.org/issue28583

   (9) https://bugs.python.org/issue27243

   (10) https://bugs.python.org/issue26182

   (11) https://bugs.python.org/issue28721


File: python.info,  Node: Library<33>,  Next: Documentation<30>,  Prev: Core and Builtins<32>,  Up: Python 3 6 0 beta 4

1.18.40.2 Library
.................

   - bpo-28752(1): Restored the __reduce__() methods of datetime
     objects.

   - bpo-28727(2): Regular expression patterns, _sre.SRE_Pattern objects
     created by re.compile(), become comparable (only x==y and x!=y
     operators).  This change should fix the bpo-18383(3): don’t
     duplicate warning filters when the warnings module is reloaded
     (thing usually only done in unit tests).

   - bpo-20572(4): The subprocess.Popen.wait method’s undocumented
     endtime parameter now raises a DeprecationWarning.

   - bpo-25659(5): In ctypes, prevent a crash calling the from_buffer()
     and from_buffer_copy() methods on abstract classes like Array.

   - bpo-19717(6): Makes Path.resolve() succeed on paths that do not
     exist.  Patch by Vajrasky Kok

   - bpo-28563(7): Fixed possible DoS and arbitrary code execution when
     handle plural form selections in the gettext module.  The
     expression parser now supports exact syntax supported by GNU
     gettext.

   - bpo-28387(8): Fixed possible crash in _io.TextIOWrapper deallocator
     when the garbage collector is invoked in other thread.  Based on
     patch by Sebastian Cufre.

   - bpo-28600(9): Optimize loop.call_soon.

   - bpo-28613(10): Fix get_event_loop() return the current loop if
     called from coroutines/callbacks.

   - bpo-28634(11): Fix asyncio.isfuture() to support unittest.Mock.

   - bpo-26081(12): Fix refleak in _asyncio.Future.__iter__().throw.

   - bpo-28639(13): Fix inspect.isawaitable to always return bool Patch
     by Justin Mayfield.

   - bpo-28652(14): Make loop methods reject socket kinds they do not
     support.

   - bpo-28653(15): Fix a refleak in functools.lru_cache.

   - bpo-28703(16): Fix asyncio.iscoroutinefunction to handle Mock
     objects.

   - bpo-28704(17): Fix create_unix_server to support Path-like objects
     (PEP 519).

   - bpo-28720(18): Add collections.abc.AsyncGenerator.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28752

   (2) https://bugs.python.org/issue28727

   (3) https://bugs.python.org/issue18383

   (4) https://bugs.python.org/issue20572

   (5) https://bugs.python.org/issue25659

   (6) https://bugs.python.org/issue19717

   (7) https://bugs.python.org/issue28563

   (8) https://bugs.python.org/issue28387

   (9) https://bugs.python.org/issue28600

   (10) https://bugs.python.org/issue28613

   (11) https://bugs.python.org/issue28634

   (12) https://bugs.python.org/issue26081

   (13) https://bugs.python.org/issue28639

   (14) https://bugs.python.org/issue28652

   (15) https://bugs.python.org/issue28653

   (16) https://bugs.python.org/issue28703

   (17) https://bugs.python.org/issue28704

   (18) https://bugs.python.org/issue28720


File: python.info,  Node: Documentation<30>,  Next: Tests<28>,  Prev: Library<33>,  Up: Python 3 6 0 beta 4

1.18.40.3 Documentation
.......................

   - bpo-28513(1): Documented command-line interface of zipfile.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28513


File: python.info,  Node: Tests<28>,  Next: Build<29>,  Prev: Documentation<30>,  Up: Python 3 6 0 beta 4

1.18.40.4 Tests
...............

   - bpo-28666(1): Now test.support.rmtree is able to remove unwritable
     or unreadable directories.

   - bpo-23839(2): Various caches now are cleared before running every
     test file.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28666

   (2) https://bugs.python.org/issue23839


File: python.info,  Node: Build<29>,  Prev: Tests<28>,  Up: Python 3 6 0 beta 4

1.18.40.5 Build
...............

   - bpo-10656(1): Fix out-of-tree building on AIX. Patch by Tristan
     Carel and Michael Haubenwallner.

   - bpo-26359(2): Rename –with-optimiations to –enable-optimizations.

   - bpo-28676(3): Prevent missing ‘getentropy’ declaration warning on
     macOS. Patch by Gareth Rees.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue10656

   (2) https://bugs.python.org/issue26359

   (3) https://bugs.python.org/issue28676


File: python.info,  Node: Python 3 6 0 beta 3,  Next: Python 3 6 0 beta 2,  Prev: Python 3 6 0 beta 4,  Up: Changelog

1.18.41 Python 3.6.0 beta 3
---------------------------

`Release date: 2016-10-31'

* Menu:

* Core and Builtins: Core and Builtins<33>.
* Library: Library<34>.
* Windows: Windows<28>.
* Build: Build<30>.
* Tests: Tests<29>.


File: python.info,  Node: Core and Builtins<33>,  Next: Library<34>,  Up: Python 3 6 0 beta 3

1.18.41.1 Core and Builtins
...........................

   - bpo-28128(1): Deprecation warning for invalid str and byte escape
     sequences now prints better information about where the error
     occurs.  Patch by Serhiy Storchaka and Eric Smith.

   - bpo-28509(2): dict.update() no longer allocate unnecessary large
     memory.

   - bpo-28426(3): Fixed potential crash in PyUnicode_AsDecodedObject()
     in debug build.

   - bpo-28517(4): Fixed of-by-one error in the peephole optimizer that
     caused keeping unreachable code.

   - bpo-28214(5): Improved exception reporting for problematic
     __set_name__ attributes.

   - bpo-23782(6): Fixed possible memory leak in _PyTraceback_Add() and
     exception loss in PyTraceBack_Here().

   - bpo-28471(7): Fix “Python memory allocator called without holding
     the GIL” crash in socket.setblocking.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28128

   (2) https://bugs.python.org/issue28509

   (3) https://bugs.python.org/issue28426

   (4) https://bugs.python.org/issue28517

   (5) https://bugs.python.org/issue28214

   (6) https://bugs.python.org/issue23782

   (7) https://bugs.python.org/issue28471


File: python.info,  Node: Library<34>,  Next: Windows<28>,  Prev: Core and Builtins<33>,  Up: Python 3 6 0 beta 3

1.18.41.2 Library
.................

   - bpo-27517(1): LZMA compressor and decompressor no longer raise
     exceptions if given empty data twice.  Patch by Benjamin Fogle.

   - bpo-28549(2): Fixed segfault in curses’s addch() with ncurses6.

   - bpo-28449(3): tarfile.open() with mode “r” or “r:” now tries to
     open a tar file with compression before trying to open it without
     compression.  Otherwise it had 50% chance failed with
     ignore_zeros=True.

   - bpo-23262(4): The webbrowser module now supports Firefox 36+ and
     derived browsers.  Based on patch by Oleg Broytman.

   - bpo-27939(5): Fixed bugs in tkinter.ttk.LabeledScale and
     tkinter.Scale caused by representing the scale as float value
     internally in Tk.  tkinter.IntVar now works if float value is set
     to underlying Tk variable.

   - bpo-18844(6): The various ways of specifying weights for
     random.choices() now produce the same result sequences.

   - bpo-28255(7): calendar.TextCalendar().prmonth() no longer prints a
     space at the start of new line after printing a month’s calendar.
     Patch by Xiang Zhang.

   - bpo-20491(8): The textwrap.TextWrapper class now honors
     non-breaking spaces.  Based on patch by Kaarle Ritvanen.

   - bpo-28353(9): os.fwalk() no longer fails on broken links.

   - bpo-28430(10): Fix iterator of C implemented asyncio.Future doesn’t
     accept non-None value is passed to it.send(val).

   - bpo-27025(11): Generated names for Tkinter widgets now start by the
     “!” prefix for readability.

   - bpo-25464(12): Fixed HList.header_exists() in tkinter.tix module by
     addin a workaround to Tix library bug.

   - bpo-28488(13): shutil.make_archive() no longer adds entry “./” to
     ZIP archive.

   - bpo-25953(14): re.sub() now raises an error for invalid numerical
     group reference in replacement template even if the pattern is not
     found in the string.  Error message for invalid group reference now
     includes the group index and the position of the reference.  Based
     on patch by SilentGhost.

   - bpo-18219(15): Optimize csv.DictWriter for large number of columns.
     Patch by Mariatta Wijaya.

   - bpo-28448(16): Fix C implemented asyncio.Future didn’t work on
     Windows.

   - bpo-28480(17): Fix error building socket module when multithreading
     is disabled.

   - bpo-24452(18): Make webbrowser support Chrome on Mac OS X.

   - bpo-20766(19): Fix references leaked by pdb in the handling of
     SIGINT handlers.

   - bpo-28492(20): Fix how StopIteration exception is raised in
     _asyncio.Future.

   - bpo-28500(21): Fix asyncio to handle async gens GC from another
     thread.

   - bpo-26923(22): Fix asyncio.Gather to refuse being cancelled once
     all children are done.  Patch by Johannes Ebke.

   - bpo-26796(23): Don’t configure the number of workers for default
     threadpool executor.  Initial patch by Hans Lawrenz.

   - bpo-28544(24): Implement asyncio.Task in C.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27517

   (2) https://bugs.python.org/issue28549

   (3) https://bugs.python.org/issue28449

   (4) https://bugs.python.org/issue23262

   (5) https://bugs.python.org/issue27939

   (6) https://bugs.python.org/issue18844

   (7) https://bugs.python.org/issue28255

   (8) https://bugs.python.org/issue20491

   (9) https://bugs.python.org/issue28353

   (10) https://bugs.python.org/issue28430

   (11) https://bugs.python.org/issue27025

   (12) https://bugs.python.org/issue25464

   (13) https://bugs.python.org/issue28488

   (14) https://bugs.python.org/issue25953

   (15) https://bugs.python.org/issue18219

   (16) https://bugs.python.org/issue28448

   (17) https://bugs.python.org/issue28480

   (18) https://bugs.python.org/issue24452

   (19) https://bugs.python.org/issue20766

   (20) https://bugs.python.org/issue28492

   (21) https://bugs.python.org/issue28500

   (22) https://bugs.python.org/issue26923

   (23) https://bugs.python.org/issue26796

   (24) https://bugs.python.org/issue28544


File: python.info,  Node: Windows<28>,  Next: Build<30>,  Prev: Library<34>,  Up: Python 3 6 0 beta 3

1.18.41.3 Windows
.................

   - bpo-28522(1): Fixes mishandled buffer reallocation in getpathp.c

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28522


File: python.info,  Node: Build<30>,  Next: Tests<29>,  Prev: Windows<28>,  Up: Python 3 6 0 beta 3

1.18.41.4 Build
...............

   - bpo-28444(1): Fix missing extensions modules when cross compiling.

   - bpo-28208(2): Update Windows build and OS X installers to use
     SQLite 3.14.2.

   - bpo-28248(3): Update Windows build and OS X installers to use
     OpenSSL 1.0.2j.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28444

   (2) https://bugs.python.org/issue28208

   (3) https://bugs.python.org/issue28248


File: python.info,  Node: Tests<29>,  Prev: Build<30>,  Up: Python 3 6 0 beta 3

1.18.41.5 Tests
...............

   - bpo-26944(1): Fix test_posix for Android where ‘id -G’ is entirely
     wrong or missing the effective gid.

   - bpo-28409(2): regrtest: fix the parser of command line arguments.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26944

   (2) https://bugs.python.org/issue28409


File: python.info,  Node: Python 3 6 0 beta 2,  Next: Python 3 6 0 beta 1,  Prev: Python 3 6 0 beta 3,  Up: Changelog

1.18.42 Python 3.6.0 beta 2
---------------------------

`Release date: 2016-10-10'

* Menu:

* Core and Builtins: Core and Builtins<34>.
* Library: Library<35>.
* Windows: Windows<29>.
* C API: C API<23>.
* Build: Build<31>.
* Tests: Tests<30>.


File: python.info,  Node: Core and Builtins<34>,  Next: Library<35>,  Up: Python 3 6 0 beta 2

1.18.42.1 Core and Builtins
...........................

   - bpo-28183(1): Optimize and cleanup dict iteration.

   - bpo-26081(2): Added C implementation of asyncio.Future.  Original
     patch by Yury Selivanov.

   - bpo-28379(3): Added sanity checks and tests for
     PyUnicode_CopyCharacters().  Patch by Xiang Zhang.

   - bpo-28376(4): The type of long range iterator is now registered as
     Iterator.  Patch by Oren Milman.

   - bpo-28376(5): Creating instances of range_iterator by calling
     range_iterator type now is deprecated.  Patch by Oren Milman.

   - bpo-28376(6): The constructor of range_iterator now checks that
     step is not 0.  Patch by Oren Milman.

   - bpo-26906(7): Resolving special methods of uninitialized type now
     causes implicit initialization of the type instead of a fail.

   - bpo-18287(8): PyType_Ready() now checks that tp_name is not NULL.
     Original patch by Niklas Koep.

   - bpo-24098(9): Fixed possible crash when AST is changed in process
     of compiling it.

   - bpo-28201(10): Dict reduces possibility of 2nd conflict in hash
     table when hashes have same lower bits.

   - bpo-28350(11): String constants with null character no longer
     interned.

   - bpo-26617(12): Fix crash when GC runs during weakref callbacks.

   - bpo-27942(13): String constants now interned recursively in tuples
     and frozensets.

   - bpo-21578(14): Fixed misleading error message when ImportError
     called with invalid keyword args.

   - bpo-28203(15): Fix incorrect type in complex(1.0, {2:3}) error
     message.  Patch by Soumya Sharma.

   - bpo-28086(16): Single var-positional argument of tuple subtype was
     passed unscathed to the C-defined function.  Now it is converted to
     exact tuple.

   - bpo-28214(17): Now __set_name__ is looked up on the class instead
     of the instance.

   - bpo-27955(18): Fallback on reading /dev/urandom device when the
     getrandom() syscall fails with EPERM, for example when blocked by
     SECCOMP.

   - bpo-28192(19): Don’t import readline in isolated mode.

   - Upgrade internal unicode databases to Unicode version 9.0.0.

   - bpo-28131(20): Fix a regression in zipimport’s compile_source().
     zipimport should use the same optimization level as the
     interpreter.

   - bpo-28126(21): Replace Py_MEMCPY with memcpy().  Visual Studio can
     properly optimize memcpy().

   - bpo-28120(22): Fix dict.pop() for splitted dictionary when trying
     to remove a “pending key” (Not yet inserted in split-table).  Patch
     by Xiang Zhang.

   - bpo-26182(23): Raise DeprecationWarning when async and await
     keywords are used as variable/attribute/class/function name.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28183

   (2) https://bugs.python.org/issue26081

   (3) https://bugs.python.org/issue28379

   (4) https://bugs.python.org/issue28376

   (5) https://bugs.python.org/issue28376

   (6) https://bugs.python.org/issue28376

   (7) https://bugs.python.org/issue26906

   (8) https://bugs.python.org/issue18287

   (9) https://bugs.python.org/issue24098

   (10) https://bugs.python.org/issue28201

   (11) https://bugs.python.org/issue28350

   (12) https://bugs.python.org/issue26617

   (13) https://bugs.python.org/issue27942

   (14) https://bugs.python.org/issue21578

   (15) https://bugs.python.org/issue28203

   (16) https://bugs.python.org/issue28086

   (17) https://bugs.python.org/issue28214

   (18) https://bugs.python.org/issue27955

   (19) https://bugs.python.org/issue28192

   (20) https://bugs.python.org/issue28131

   (21) https://bugs.python.org/issue28126

   (22) https://bugs.python.org/issue28120

   (23) https://bugs.python.org/issue26182


File: python.info,  Node: Library<35>,  Next: Windows<29>,  Prev: Core and Builtins<34>,  Up: Python 3 6 0 beta 2

1.18.42.2 Library
.................

   - bpo-27998(1): Fixed bytes path support in os.scandir() on Windows.
     Patch by Eryk Sun.

   - bpo-28317(2): The disassembler now decodes FORMAT_VALUE argument.

   - bpo-26293(3): Fixed writing ZIP files that starts not from the
     start of the file.  Offsets in ZIP file now are relative to the
     start of the archive in conforming to the specification.

   - bpo-28380(4): unittest.mock Mock autospec functions now properly
     support assert_called, assert_not_called, and assert_called_once.

   - bpo-27181(5): remove statistics.geometric_mean and defer until 3.7.

   - bpo-28229(6): lzma module now supports pathlib.

   - bpo-28321(7): Fixed writing non-BMP characters with binary format
     in plistlib.

   - bpo-28225(8): bz2 module now supports pathlib.  Initial patch by
     Ethan Furman.

   - bpo-28227(9): gzip now supports pathlib.  Patch by Ethan Furman.

   - bpo-27358(10): Optimized merging var-keyword arguments and improved
     error message when passing a non-mapping as a var-keyword argument.

   - bpo-28257(11): Improved error message when passing a non-iterable
     as a var-positional argument.  Added opcode
     BUILD_TUPLE_UNPACK_WITH_CALL.

   - bpo-28322(12): Fixed possible crashes when unpickle itertools
     objects from incorrect pickle data.  Based on patch by John Leitch.

   - bpo-28228(13): imghdr now supports pathlib.

   - bpo-28226(14): compileall now supports pathlib.

   - bpo-28314(15): Fix function declaration (C flags) for the
     getiterator() method of xml.etree.ElementTree.Element.

   - bpo-28148(16): Stop using localtime() and gmtime() in the time
     module.  Introduced platform independent _PyTime_localtime API that
     is similar to POSIX localtime_r, but available on all platforms.
     Patch by Ed Schouten.

   - bpo-28253(17): Fixed calendar functions for extreme months: 0001-01
     and 9999-12.  Methods itermonthdays() and itermonthdays2() are
     reimplemented so that they don’t call itermonthdates() which can
     cause datetime.date under/overflow.

   - bpo-28275(18): Fixed possible use after free in the decompress()
     methods of the LZMADecompressor and BZ2Decompressor classes.
     Original patch by John Leitch.

   - bpo-27897(19): Fixed possible crash in
     sqlite3.Connection.create_collation() if pass invalid string-like
     object as a name.  Patch by Xiang Zhang.

   - bpo-18844(20): random.choices() now has k as a keyword-only
     argument to improve the readability of common cases and come into
     line with the signature used in other languages.

   - bpo-18893(21): Fix invalid exception handling in
     Lib/ctypes/macholib/dyld.py.  Patch by Madison May.

   - bpo-27611(22): Fixed support of default root window in the
     tkinter.tix module.  Added the master parameter in the DisplayStyle
     constructor.

   - bpo-27348(23): In the traceback module, restore the formatting of
     exception messages like “Exception: None”.  This fixes a regression
     introduced in 3.5a2.

   - bpo-25651(24): Allow falsy values to be used for msg parameter of
     subTest().

   - bpo-27778(25): Fix a memory leak in os.getrandom() when the
     getrandom() is interrupted by a signal and a signal handler raises
     a Python exception.

   - bpo-28200(26): Fix memory leak on Windows in the os module (fix
     path_converter() function).

   - bpo-25400(27): RobotFileParser now correctly returns default values
     for crawl_delay and request_rate.  Initial patch by Peter Wirtz.

   - bpo-27932(28): Prevent memory leak in win32_ver().

   - Fix UnboundLocalError in socket._sendfile_use_sendfile.

   - bpo-28075(29): Check for ERROR_ACCESS_DENIED in Windows
     implementation of os.stat().  Patch by Eryk Sun.

   - bpo-22493(30): Warning message emitted by using inline flags in the
     middle of regular expression now contains a (truncated) regex
     pattern.  Patch by Tim Graham.

   - bpo-25270(31): Prevent codecs.escape_encode() from raising
     SystemError when an empty bytestring is passed.

   - bpo-28181(32): Get antigravity over HTTPS. Patch by Kaartic
     Sivaraam.

   - bpo-25895(33): Enable WebSocket URL schemes in
     urllib.parse.urljoin.  Patch by Gergely Imreh and Markus
     Holtermann.

   - bpo-28114(34): Fix a crash in parse_envlist() when env contains
     byte strings.  Patch by Eryk Sun.

   - bpo-27599(35): Fixed buffer overrun in binascii.b2a_qp() and
     binascii.a2b_qp().

   - bpo-27906(36): Fix socket accept exhaustion during high TCP
     traffic.  Patch by Kevin Conway.

   - bpo-28174(37): Handle when SO_REUSEPORT isn’t properly supported.
     Patch by Seth Michael Larson.

   - bpo-26654(38): Inspect functools.partial in
     asyncio.Handle.__repr__.  Patch by iceboy.

   - bpo-26909(39): Fix slow pipes IO in asyncio.  Patch by INADA Naoki.

   - bpo-28176(40): Fix callbacks race in
     asyncio.SelectorLoop.sock_connect.

   - bpo-27759(41): Fix selectors incorrectly retain invalid file
     descriptors.  Patch by Mark Williams.

   - bpo-28368(42): Refuse monitoring processes if the child watcher has
     no loop attached.  Patch by Vincent Michel.

   - bpo-28369(43): Raise RuntimeError when transport’s FD is used with
     add_reader, add_writer, etc.

   - bpo-28370(44): Speedup asyncio.StreamReader.readexactly.  Patch by
     Коренберг Марк.

   - bpo-28371(45): Deprecate passing asyncio.Handles to
     run_in_executor.

   - bpo-28372(46): Fix asyncio to support formatting of non-python
     coroutines.

   - bpo-28399(47): Remove UNIX socket from FS before binding.  Patch by
     Коренберг Марк.

   - bpo-27972(48): Prohibit Tasks to await on themselves.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27998

   (2) https://bugs.python.org/issue28317

   (3) https://bugs.python.org/issue26293

   (4) https://bugs.python.org/issue28380

   (5) https://bugs.python.org/issue27181

   (6) https://bugs.python.org/issue28229

   (7) https://bugs.python.org/issue28321

   (8) https://bugs.python.org/issue28225

   (9) https://bugs.python.org/issue28227

   (10) https://bugs.python.org/issue27358

   (11) https://bugs.python.org/issue28257

   (12) https://bugs.python.org/issue28322

   (13) https://bugs.python.org/issue28228

   (14) https://bugs.python.org/issue28226

   (15) https://bugs.python.org/issue28314

   (16) https://bugs.python.org/issue28148

   (17) https://bugs.python.org/issue28253

   (18) https://bugs.python.org/issue28275

   (19) https://bugs.python.org/issue27897

   (20) https://bugs.python.org/issue18844

   (21) https://bugs.python.org/issue18893

   (22) https://bugs.python.org/issue27611

   (23) https://bugs.python.org/issue27348

   (24) https://bugs.python.org/issue25651

   (25) https://bugs.python.org/issue27778

   (26) https://bugs.python.org/issue28200

   (27) https://bugs.python.org/issue25400

   (28) https://bugs.python.org/issue27932

   (29) https://bugs.python.org/issue28075

   (30) https://bugs.python.org/issue22493

   (31) https://bugs.python.org/issue25270

   (32) https://bugs.python.org/issue28181

   (33) https://bugs.python.org/issue25895

   (34) https://bugs.python.org/issue28114

   (35) https://bugs.python.org/issue27599

   (36) https://bugs.python.org/issue27906

   (37) https://bugs.python.org/issue28174

   (38) https://bugs.python.org/issue26654

   (39) https://bugs.python.org/issue26909

   (40) https://bugs.python.org/issue28176

   (41) https://bugs.python.org/issue27759

   (42) https://bugs.python.org/issue28368

   (43) https://bugs.python.org/issue28369

   (44) https://bugs.python.org/issue28370

   (45) https://bugs.python.org/issue28371

   (46) https://bugs.python.org/issue28372

   (47) https://bugs.python.org/issue28399

   (48) https://bugs.python.org/issue27972


File: python.info,  Node: Windows<29>,  Next: C API<23>,  Prev: Library<35>,  Up: Python 3 6 0 beta 2

1.18.42.3 Windows
.................

   - bpo-28402(1): Adds signed catalog files for stdlib on Windows.

   - bpo-28333(2): Enables Unicode for ps1/ps2 and input() prompts.
     (Patch by Eryk Sun)

   - bpo-28251(3): Improvements to help manuals on Windows.

   - bpo-28110(4): launcher.msi has different product codes between
     32-bit and 64-bit

   - bpo-28161(5): Opening CON for write access fails

   - bpo-28162(6): WindowsConsoleIO readall() fails if first line starts
     with Ctrl+Z

   - bpo-28163(7): WindowsConsoleIO fileno() passes wrong flags to
     _open_osfhandle

   - bpo-28164(8): _PyIO_get_console_type fails for various paths

   - bpo-28137(9): Renames Windows path file to ._pth

   - bpo-28138(10): Windows ._pth file should allow import site

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28402

   (2) https://bugs.python.org/issue28333

   (3) https://bugs.python.org/issue28251

   (4) https://bugs.python.org/issue28110

   (5) https://bugs.python.org/issue28161

   (6) https://bugs.python.org/issue28162

   (7) https://bugs.python.org/issue28163

   (8) https://bugs.python.org/issue28164

   (9) https://bugs.python.org/issue28137

   (10) https://bugs.python.org/issue28138


File: python.info,  Node: C API<23>,  Next: Build<31>,  Prev: Windows<29>,  Up: Python 3 6 0 beta 2

1.18.42.4 C API
...............

   - bpo-28426(1): Deprecated undocumented functions
     PyUnicode_AsEncodedObject(), PyUnicode_AsDecodedObject(),
     PyUnicode_AsDecodedUnicode() and PyUnicode_AsEncodedUnicode().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28426


File: python.info,  Node: Build<31>,  Next: Tests<30>,  Prev: C API<23>,  Up: Python 3 6 0 beta 2

1.18.42.5 Build
...............

   - bpo-28258(1): Fixed build with Estonian locale (python-config and
     distclean targets in Makefile).  Patch by Arfrever Frehtes
     Taifersar Arahesis.

   - bpo-26661(2): setup.py now detects system libffi with multiarch
     wrapper.

   - bpo-15819(3): Remove redundant include search directory option for
     building outside the source tree.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28258

   (2) https://bugs.python.org/issue26661

   (3) https://bugs.python.org/issue15819


File: python.info,  Node: Tests<30>,  Prev: Build<31>,  Up: Python 3 6 0 beta 2

1.18.42.6 Tests
...............

   - bpo-28217(1): Adds _testconsole module to test console input.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28217


File: python.info,  Node: Python 3 6 0 beta 1,  Next: Python 3 6 0 alpha 4,  Prev: Python 3 6 0 beta 2,  Up: Changelog

1.18.43 Python 3.6.0 beta 1
---------------------------

`Release date: 2016-09-12'

* Menu:

* Core and Builtins: Core and Builtins<35>.
* Library: Library<36>.
* IDLE: IDLE<29>.
* C API: C API<24>.
* Tests: Tests<31>.
* Build: Build<32>.
* Tools/Demos: Tools/Demos<22>.
* Windows: Windows<30>.


File: python.info,  Node: Core and Builtins<35>,  Next: Library<36>,  Up: Python 3 6 0 beta 1

1.18.43.1 Core and Builtins
...........................

   - bpo-23722(1): The __class__ cell used by zero-argument super() is
     now initialized from type.__new__ rather than __build_class__, so
     class methods relying on that will now work correctly when called
     from metaclass methods during class creation.  Patch by Martin
     Teichmann.

   - bpo-25221(2): Fix corrupted result from PyLong_FromLong(0) when
     Python is compiled with NSMALLPOSINTS = 0.

   - bpo-27080(3): Implement formatting support for PEP 515(4).  Initial
     patch by Chris Angelico.

   - bpo-27199(5): In tarfile, expose copyfileobj bufsize to improve
     throughput.  Patch by Jason Fried.

   - bpo-27948(6): In f-strings, only allow backslashes inside the
     braces (where the expressions are).  This is a breaking change from
     the 3.6 alpha releases, where backslashes are allowed anywhere in
     an f-string.  Also, require that expressions inside f-strings be
     enclosed within literal braces, and not escapes like
     ‘f'\x7b"hi"\x7d'’.

   - bpo-28046(7): Remove platform-specific directories from sys.path.

   - bpo-28071(8): Add early-out for differencing from an empty set.

   - bpo-25758(9): Prevents zipimport from unnecessarily encoding a
     filename (patch by Eryk Sun)

   - bpo-25856(10): The __module__ attribute of extension classes and
     functions now is interned.  This leads to more compact pickle data
     with protocol 4.

   - bpo-27213(11): Rework CALL_FUNCTION* opcodes to produce shorter and
     more efficient bytecode.  Patch by Demur Rumed, design by Serhiy
     Storchaka, reviewed by Serhiy Storchaka and Victor Stinner.

   - bpo-26331(12): Implement tokenizing support for PEP 515(13).  Patch
     by Georg Brandl.

   - bpo-27999(14): Make “global after use” a SyntaxError, and ditto for
     nonlocal.  Patch by Ivan Levkivskyi.

   - bpo-28003(15): Implement PEP 525(16) – Asynchronous Generators.

   - bpo-27985(17): Implement PEP 526(18) – Syntax for Variable
     Annotations.  Patch by Ivan Levkivskyi.

   - bpo-26058(19): Add a new private version to the builtin dict type,
     incremented at each dictionary creation and at each dictionary
     change.  Implementation of the PEP 509.

   - bpo-27364(20): A backslash-character pair that is not a valid
     escape sequence now generates a DeprecationWarning.  Patch by
     Emanuel Barry.

   - bpo-27350(21): *note dict: 1b6. implementation is changed like
     PyPy.  It is more compact and preserves insertion order.  (Concept
     developed by Raymond Hettinger and patch by Inada Naoki.)

   - bpo-27911(22): Remove unnecessary error checks in
     ‘exec_builtin_or_dynamic()’.

   - bpo-27078(23): Added BUILD_STRING opcode.  Optimized f-strings
     evaluation.

   - bpo-17884(24): Python now requires systems with inttypes.h and
     stdint.h

   - bpo-27961(25): Require platforms to support ‘long long’.  Python
     hasn’t compiled without ‘long long’ for years, so this is basically
     a formality.

   - bpo-27355(26): Removed support for Windows CE. It was never
     finished, and Windows CE is no longer a relevant platform for
     Python.

   - Implement PEP 523(27).

   - bpo-27870(28): A left shift of zero by a large integer no longer
     attempts to allocate large amounts of memory.

   - bpo-25402(29): In int-to-decimal-string conversion, improve the
     estimate of the intermediate memory required, and remove an
     unnecessarily strict overflow check.  Patch by Serhiy Storchaka.

   - bpo-27214(30): In long_invert, be more careful about modifying
     object returned by long_add, and remove an unnecessary check for
     small longs.  Thanks Oren Milman for analysis and patch.

   - bpo-27506(31): Support passing the bytes/bytearray.translate()
     “delete” argument by keyword.

   - bpo-27812(32): Properly clear out a generator’s frame’s
     backreference to the generator to prevent crashes in frame.clear().

   - bpo-27811(33): Fix a crash when a coroutine that has not been
     awaited is finalized with warnings-as-errors enabled.

   - bpo-27587(34): Fix another issue found by PVS-Studio: Null pointer
     check after use of ‘def’ in _PyState_AddModule().  Initial patch by
     Christian Heimes.

   - bpo-27792(35): The modulo operation applied to ‘bool’ and other
     ‘int’ subclasses now always returns an ‘int’.  Previously the
     return type depended on the input values.  Patch by Xiang Zhang.

   - bpo-26984(36): int() now always returns an instance of exact int.

   - bpo-25604(37): Fix a minor bug in integer true division; this bug
     could potentially have caused off-by-one-ulp results on platforms
     with unreliable ldexp implementations.

   - bpo-24254(38): Make class definition namespace ordered by default.

   - bpo-27662(39): Fix an overflow check in ‘List_New’: the original
     code was checking against ‘Py_SIZE_MAX’ instead of the correct
     upper bound of ‘Py_SSIZE_T_MAX’.  Patch by Xiang Zhang.

   - bpo-27782(40): Multi-phase extension module import now correctly
     allows the ‘m_methods’ field to be used to add module level
     functions to instances of non-module types returned from
     ‘Py_create_mod’.  Patch by Xiang Zhang.

   - bpo-27936(41): The round() function accepted a second None argument
     for some types but not for others.  Fixed the inconsistency by
     accepting None for all numeric types.

   - bpo-27487(42): Warn if a submodule argument to “python -m” or
     runpy.run_module() is found in sys.modules after parent packages
     are imported, but before the submodule is executed.

   - bpo-27157(43): Make only type() itself accept the one-argument
     form.  Patch by Eryk Sun and Emanuel Barry.

   - bpo-27558(44): Fix a SystemError in the implementation of “raise”
     statement.  In a brand new thread, raise a RuntimeError since there
     is no active exception to reraise.  Patch written by Xiang Zhang.

   - bpo-28008(45): Implement PEP 530(46) – asynchronous comprehensions.

   - bpo-27942(47): Fix memory leak in codeobject.c

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23722

   (2) https://bugs.python.org/issue25221

   (3) https://bugs.python.org/issue27080

   (4) https://www.python.org/dev/peps/pep-0515

   (5) https://bugs.python.org/issue27199

   (6) https://bugs.python.org/issue27948

   (7) https://bugs.python.org/issue28046

   (8) https://bugs.python.org/issue28071

   (9) https://bugs.python.org/issue25758

   (10) https://bugs.python.org/issue25856

   (11) https://bugs.python.org/issue27213

   (12) https://bugs.python.org/issue26331

   (13) https://www.python.org/dev/peps/pep-0515

   (14) https://bugs.python.org/issue27999

   (15) https://bugs.python.org/issue28003

   (16) https://www.python.org/dev/peps/pep-0525

   (17) https://bugs.python.org/issue27985

   (18) https://www.python.org/dev/peps/pep-0526

   (19) https://bugs.python.org/issue26058

   (20) https://bugs.python.org/issue27364

   (21) https://bugs.python.org/issue27350

   (22) https://bugs.python.org/issue27911

   (23) https://bugs.python.org/issue27078

   (24) https://bugs.python.org/issue17884

   (25) https://bugs.python.org/issue27961

   (26) https://bugs.python.org/issue27355

   (27) https://www.python.org/dev/peps/pep-0523

   (28) https://bugs.python.org/issue27870

   (29) https://bugs.python.org/issue25402

   (30) https://bugs.python.org/issue27214

   (31) https://bugs.python.org/issue27506

   (32) https://bugs.python.org/issue27812

   (33) https://bugs.python.org/issue27811

   (34) https://bugs.python.org/issue27587

   (35) https://bugs.python.org/issue27792

   (36) https://bugs.python.org/issue26984

   (37) https://bugs.python.org/issue25604

   (38) https://bugs.python.org/issue24254

   (39) https://bugs.python.org/issue27662

   (40) https://bugs.python.org/issue27782

   (41) https://bugs.python.org/issue27936

   (42) https://bugs.python.org/issue27487

   (43) https://bugs.python.org/issue27157

   (44) https://bugs.python.org/issue27558

   (45) https://bugs.python.org/issue28008

   (46) https://www.python.org/dev/peps/pep-0530

   (47) https://bugs.python.org/issue27942


File: python.info,  Node: Library<36>,  Next: IDLE<29>,  Prev: Core and Builtins<35>,  Up: Python 3 6 0 beta 1

1.18.43.2 Library
.................

   - bpo-28732(1): Fix crash in os.spawnv() with no elements in args

   - bpo-28485(2): Always raise ValueError for negative
     compileall.compile_dir(workers=…) parameter, even when
     multithreading is unavailable.

   - bpo-28037(3): Use sqlite3_get_autocommit() instead of setting
     Connection->inTransaction manually.

   - bpo-25283(4): Attributes tm_gmtoff and tm_zone are now available on
     all platforms in the return values of time.localtime() and
     time.gmtime().

   - bpo-24454(5): Regular expression match object groups are now
     accessible using __getitem__.  “mo[x]” is equivalent to
     “mo.group(x)”.

   - bpo-10740(6): sqlite3 no longer implicitly commit an open
     transaction before DDL statements.

   - bpo-17941(7): Add a `module' parameter to collections.namedtuple().

   - bpo-22493(8): Inline flags now should be used only at the start of
     the regular expression.  Deprecation warning is emitted if uses
     them in the middle of the regular expression.

   - bpo-26885(9): xmlrpc now supports unmarshalling additional data
     types used by Apache XML-RPC implementation for numerics and None.

   - bpo-28070(10): Fixed parsing inline verbose flag in regular
     expressions.

   - bpo-19500(11): Add client-side SSL session resumption to the ssl
     module.

   - bpo-28022(12): Deprecate ssl-related arguments in favor of
     SSLContext.  The deprecation include manual creation of SSLSocket
     and certfile/keyfile (or similar) in ftplib, httplib, imaplib,
     smtplib, poplib and urllib.

   - bpo-28043(13): SSLContext has improved default settings:
     OP_NO_SSLv2, OP_NO_SSLv3, OP_NO_COMPRESSION,
     OP_CIPHER_SERVER_PREFERENCE, OP_SINGLE_DH_USE, OP_SINGLE_ECDH_USE
     and HIGH ciphers without MD5.

   - bpo-24693(14): Changed some RuntimeError’s in the zipfile module to
     more appropriate types.  Improved some error messages and debugging
     output.

   - bpo-17909(15): ‘json.load’ and ‘json.loads’ now support binary
     input encoded as UTF-8, UTF-16 or UTF-32.  Patch by Serhiy
     Storchaka.

   - bpo-27137(16): the pure Python fallback implementation of
     ‘functools.partial’ now matches the behaviour of its accelerated C
     counterpart for subclassing, pickling and text representation
     purposes.  Patch by Emanuel Barry and Serhiy Storchaka.

   - Fix possible integer overflows and crashes in the mmap module with
     unusual usage patterns.

   - bpo-1703178(17): Fix the ability to pass the –link-objects option
     to the distutils build_ext command.

   - bpo-28019(18): itertools.count() no longer rounds non-integer step
     in range between 1.0 and 2.0 to 1.

   - bpo-18401(19): Pdb now supports the ‘readrc’ keyword argument to
     control whether .pdbrc files should be read.  Patch by Martin
     Matusiak and Sam Kimbrel.

   - bpo-25969(20): Update the lib2to3 grammar to handle the unpacking
     generalizations added in 3.5.

   - bpo-14977(21): mailcap now respects the order of the lines in the
     mailcap files (“first match”), as required by RFC 1542.  Patch by
     Michael Lazar.

   - bpo-28082(22): Convert re flag constants to IntFlag.

   - bpo-28025(23): Convert all ssl module constants to IntEnum and
     IntFlags.  SSLContext properties now return flags and enums.

   - bpo-23591(24): Add Flag, IntFlag, and auto() to enum module.

   - bpo-433028(25): Added support of modifier spans in regular
     expressions.

   - bpo-24594(26): Validates persist parameter when opening MSI
     database

   - bpo-17582(27): xml.etree.ElementTree nows preserves whitespaces in
     attributes (Patch by Duane Griffin.  Reviewed and approved by
     Stefan Behnel.)

   - bpo-28047(28): Fixed calculation of line length used for the base64
     CTE in the new email policies.

   - bpo-27576(29): Fix call order in OrderedDict.__init__().

   - email.generator.DecodedGenerator now supports the policy keyword.

   - bpo-28027(30): Remove undocumented modules from ‘Lib/plat-*’: IN,
     CDROM, DLFCN, TYPES, CDIO, and STROPTS.

   - bpo-27445(31): Don’t pass str(_charset) to MIMEText.set_payload().
     Patch by Claude Paroz.

   - bpo-24277(32): The new email API is no longer provisional, and the
     docs have been reorganized and rewritten to emphasize the new API.

   - bpo-22450(33): urllib now includes an ‘Accept: */*’ header among
     the default headers.  This makes the results of REST API requests
     more consistent and predictable especially when proxy servers are
     involved.

   - lib2to3.pgen3.driver.load_grammar() now creates a stable cache file
     between runs given the same Grammar.txt input regardless of the
     hash randomization setting.

   - bpo-28005(34): Allow ImportErrors in encoding implementation to
     propagate.

   - bpo-26667(35): Support path-like objects in importlib.util.

   - bpo-27570(36): Avoid zero-length memcpy() etc calls with null
     source pointers in the “ctypes” and “array” modules.

   - bpo-22233(37): Break email header lines `only' on the RFC specified
     CR and LF characters, not on arbitrary unicode line breaks.  This
     also fixes a bug in HTTP header parsing.

   - bpo-27331(38): The email.mime classes now all accept an optional
     policy keyword.

   - bpo-27988(39): Fix email iter_attachments incorrect mutation of
     payload list.

   - bpo-16113(40): Add SHA-3 and SHAKE support to hashlib module.

   - Eliminate a tautological-pointer-compare warning in _scproxy.c.

   - bpo-27776(41): The *note os.urandom(): 4c6. function does now block
     on Linux 3.17 and newer until the system urandom entropy pool is
     initialized to increase the security.  This change is part of the
     PEP 524(42).

   - bpo-27778(43): Expose the Linux ‘getrandom()’ syscall as a new
     *note os.getrandom(): 55e. function.  This change is part of the
     PEP 524(44).

   - bpo-27691(45): Fix ssl module’s parsing of GEN_RID subject
     alternative name fields in X.509 certs.

   - bpo-18844(46): Add random.choices().

   - bpo-25761(47): Improved error reporting about truncated pickle data
     in C implementation of unpickler.  UnpicklingError is now raised
     instead of AttributeError and ValueError in some cases.

   - bpo-26798(48): Add BLAKE2 (blake2b and blake2s) to hashlib.

   - bpo-26032(49): Optimized globbing in pathlib by using os.scandir();
     it is now about 1.5–4 times faster.

   - bpo-25596(50): Optimized glob() and iglob() functions in the glob
     module; they are now about 3–6 times faster.

   - bpo-27928(51): Add scrypt (password-based key derivation function)
     to hashlib module (requires OpenSSL 1.1.0).

   - bpo-27850(52): Remove 3DES from ssl module’s default cipher list to
     counter measure sweet32 attack (CVE-2016-2183).

   - bpo-27766(53): Add ChaCha20 Poly1305 to ssl module’s default cipher
     list.  (Required OpenSSL 1.1.0 or LibreSSL).

   - bpo-25387(54): Check return value of winsound.MessageBeep.

   - bpo-27866(55): Add SSLContext.get_ciphers() method to get a list of
     all enabled ciphers.

   - bpo-27744(56): Add AF_ALG (Linux Kernel crypto) to socket module.

   - bpo-26470(57): Port ssl and hashlib module to OpenSSL 1.1.0.

   - bpo-11620(58): Fix support for SND_MEMORY in winsound.PlaySound.
     Based on a patch by Tim Lesher.

   - bpo-11734(59): Add support for IEEE 754 half-precision floats to
     the struct module.  Based on a patch by Eli Stevens.

   - bpo-27919(60): Deprecated ‘extra_path’ distribution option in
     distutils packaging.

   - bpo-23229(61): Add new ‘cmath’ constants: ‘cmath.inf’ and
     ‘cmath.nan’ to match ‘math.inf’ and ‘math.nan’, and also
     ‘cmath.infj’ and ‘cmath.nanj’ to match the format used by complex
     repr.

   - bpo-27842(62): The csv.DictReader now returns rows of type
     OrderedDict.  (Contributed by Steve Holden.)

   - Remove support for passing a file descriptor to os.access.  It
     never worked but previously didn’t raise.

   - bpo-12885(63): Fix error when distutils encounters symlink.

   - bpo-27881(64): Fixed possible bugs when setting
     sqlite3.Connection.isolation_level.  Based on patch by Xiang Zhang.

   - bpo-27861(65): Fixed a crash in sqlite3.Connection.cursor() when a
     factory creates not a cursor.  Patch by Xiang Zhang.

   - bpo-19884(66): Avoid spurious output on OS X with Gnu Readline.

   - bpo-27706(67): Restore deterministic behavior of
     random.Random().seed() for string seeds using seeding version 1.
     Allows sequences of calls to random() to exactly match those
     obtained in Python 2.  Patch by Nofar Schnider.

   - bpo-10513(68): Fix a regression in Connection.commit().  Statements
     should not be reset after a commit.

   - bpo-12319(69): Chunked transfer encoding support added to
     http.client.HTTPConnection requests.  The
     urllib.request.AbstractHTTPHandler class does not enforce a
     Content-Length header any more.  If a HTTP request has a file or
     iterable body, but no Content-Length header, the library now falls
     back to use chunked transfer-encoding.

   - A new version of typing.py from ‘https://github.com/python/typing’:
     - Collection (only for 3.6) (bpo-27598(70)) - Add FrozenSet to
     __all__ (upstream #261) - fix crash in _get_type_vars() (upstream
     #259) - Remove the dict constraint in ForwardRef._eval_type
     (upstream #252)

   - bpo-27832(71): Make ‘_normalize’ parameter to ‘Fraction’
     constructor keyword-only, so that ‘Fraction(2, 3, 4)’ now raises
     ‘TypeError’.

   - bpo-27539(72): Fix unnormalised ‘Fraction.__pow__’ result in the
     case of negative exponent and negative base.

   - bpo-21718(73): cursor.description is now available for queries
     using CTEs.

   - bpo-27819(74): In distutils sdists, simply produce the “gztar”
     (gzipped tar format) distributions on all platforms unless
     “formats” is supplied.

   - bpo-2466(75): posixpath.ismount now correctly recognizes mount
     points which the user does not have permission to access.

   - bpo-9998(76): On Linux, ctypes.util.find_library now looks in
     LD_LIBRARY_PATH for shared libraries.

   - bpo-27573(77): exit message for code.interact is now configurable.

   - bpo-27930(78): Improved behaviour of
     logging.handlers.QueueListener.  Thanks to Paulo Andrade and Petr
     Viktorin for the analysis and patch.

   - bpo-6766(79): Distributed reference counting added to
     multiprocessing to support nesting of shared values / proxy
     objects.

   - bpo-21201(80): Improves readability of multiprocessing error
     message.  Thanks to Wojciech Walczak for patch.

   - asyncio: Add set_protocol / get_protocol to Transports.

   - bpo-27456(81): asyncio: Set TCP_NODELAY by default.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28732

   (2) https://bugs.python.org/issue28485

   (3) https://bugs.python.org/issue28037

   (4) https://bugs.python.org/issue25283

   (5) https://bugs.python.org/issue24454

   (6) https://bugs.python.org/issue10740

   (7) https://bugs.python.org/issue17941

   (8) https://bugs.python.org/issue22493

   (9) https://bugs.python.org/issue26885

   (10) https://bugs.python.org/issue28070

   (11) https://bugs.python.org/issue19500

   (12) https://bugs.python.org/issue28022

   (13) https://bugs.python.org/issue28043

   (14) https://bugs.python.org/issue24693

   (15) https://bugs.python.org/issue17909

   (16) https://bugs.python.org/issue27137

   (17) https://bugs.python.org/issue1703178

   (18) https://bugs.python.org/issue28019

   (19) https://bugs.python.org/issue18401

   (20) https://bugs.python.org/issue25969

   (21) https://bugs.python.org/issue14977

   (22) https://bugs.python.org/issue28082

   (23) https://bugs.python.org/issue28025

   (24) https://bugs.python.org/issue23591

   (25) https://bugs.python.org/issue433028

   (26) https://bugs.python.org/issue24594

   (27) https://bugs.python.org/issue17582

   (28) https://bugs.python.org/issue28047

   (29) https://bugs.python.org/issue27576

   (30) https://bugs.python.org/issue28027

   (31) https://bugs.python.org/issue27445

   (32) https://bugs.python.org/issue24277

   (33) https://bugs.python.org/issue22450

   (34) https://bugs.python.org/issue28005

   (35) https://bugs.python.org/issue26667

   (36) https://bugs.python.org/issue27570

   (37) https://bugs.python.org/issue22233

   (38) https://bugs.python.org/issue27331

   (39) https://bugs.python.org/issue27988

   (40) https://bugs.python.org/issue16113

   (41) https://bugs.python.org/issue27776

   (42) https://www.python.org/dev/peps/pep-0524

   (43) https://bugs.python.org/issue27778

   (44) https://www.python.org/dev/peps/pep-0524

   (45) https://bugs.python.org/issue27691

   (46) https://bugs.python.org/issue18844

   (47) https://bugs.python.org/issue25761

   (48) https://bugs.python.org/issue26798

   (49) https://bugs.python.org/issue26032

   (50) https://bugs.python.org/issue25596

   (51) https://bugs.python.org/issue27928

   (52) https://bugs.python.org/issue27850

   (53) https://bugs.python.org/issue27766

   (54) https://bugs.python.org/issue25387

   (55) https://bugs.python.org/issue27866

   (56) https://bugs.python.org/issue27744

   (57) https://bugs.python.org/issue26470

   (58) https://bugs.python.org/issue11620

   (59) https://bugs.python.org/issue11734

   (60) https://bugs.python.org/issue27919

   (61) https://bugs.python.org/issue23229

   (62) https://bugs.python.org/issue27842

   (63) https://bugs.python.org/issue12885

   (64) https://bugs.python.org/issue27881

   (65) https://bugs.python.org/issue27861

   (66) https://bugs.python.org/issue19884

   (67) https://bugs.python.org/issue27706

   (68) https://bugs.python.org/issue10513

   (69) https://bugs.python.org/issue12319

   (70) https://bugs.python.org/issue27598

   (71) https://bugs.python.org/issue27832

   (72) https://bugs.python.org/issue27539

   (73) https://bugs.python.org/issue21718

   (74) https://bugs.python.org/issue27819

   (75) https://bugs.python.org/issue2466

   (76) https://bugs.python.org/issue9998

   (77) https://bugs.python.org/issue27573

   (78) https://bugs.python.org/issue27930

   (79) https://bugs.python.org/issue6766

   (80) https://bugs.python.org/issue21201

   (81) https://bugs.python.org/issue27456


File: python.info,  Node: IDLE<29>,  Next: C API<24>,  Prev: Library<36>,  Up: Python 3 6 0 beta 1

1.18.43.3 IDLE
..............

   - bpo-15308(1): Add ‘interrupt execution’ (^C) to Shell menu.  Patch
     by Roger Serwy, updated by Bayard Randel.

   - bpo-27922(2): Stop IDLE tests from ‘flashing’ gui widgets on the
     screen.

   - bpo-27891(3): Consistently group and sort imports within idlelib
     modules.

   - bpo-17642(4): add larger font sizes for classroom projection.

   - Add version to title of IDLE help window.

   - bpo-25564(5): In section on IDLE – console differences, mention
     that using exec means that __builtins__ is defined for each
     statement.

   - bpo-27821(6): Fix 3.6.0a3 regression that prevented custom key sets
     from being selected when no custom theme was defined.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15308

   (2) https://bugs.python.org/issue27922

   (3) https://bugs.python.org/issue27891

   (4) https://bugs.python.org/issue17642

   (5) https://bugs.python.org/issue25564

   (6) https://bugs.python.org/issue27821


File: python.info,  Node: C API<24>,  Next: Tests<31>,  Prev: IDLE<29>,  Up: Python 3 6 0 beta 1

1.18.43.4 C API
...............

   - bpo-26900(1): Excluded underscored names and other private API from
     limited API.

   - bpo-26027(2): Add support for path-like objects in
     PyUnicode_FSConverter() & PyUnicode_FSDecoder().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26900

   (2) https://bugs.python.org/issue26027


File: python.info,  Node: Tests<31>,  Next: Build<32>,  Prev: C API<24>,  Up: Python 3 6 0 beta 1

1.18.43.5 Tests
...............

   - bpo-27427(1): Additional tests for the math module.  Patch by
     Francisco Couzo.

   - bpo-27953(2): Skip math and cmath tests that fail on OS X 10.4 due
     to a poor libm implementation of tan.

   - bpo-26040(3): Improve test_math and test_cmath coverage and rigour.
     Patch by Jeff Allen.

   - bpo-27787(4): Call gc.collect() before checking each test for
     “dangling threads”, since the dangling threads are weak references.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27427

   (2) https://bugs.python.org/issue27953

   (3) https://bugs.python.org/issue26040

   (4) https://bugs.python.org/issue27787


File: python.info,  Node: Build<32>,  Next: Tools/Demos<22>,  Prev: Tests<31>,  Up: Python 3 6 0 beta 1

1.18.43.6 Build
...............

   - bpo-27566(1): Fix clean target in freeze makefile (patch by Lisa
     Roach)

   - bpo-27705(2): Update message in validate_ucrtbase.py

   - bpo-27976(3): Deprecate building _ctypes with the bundled copy of
     libffi on non-OSX UNIX platforms.

   - bpo-27983(4): Cause lack of llvm-profdata tool when using clang as
     required for PGO linking to be a configure time error rather than
     make time when ‘--with-optimizations’ is enabled.  Also improve our
     ability to find the llvm-profdata tool on MacOS and some Linuxes.

   - bpo-21590(5): Support for DTrace and SystemTap probes.

   - bpo-26307(6): The profile-opt build now applies PGO to the built-in
     modules.

   - bpo-26359(7): Add the –with-optimizations flag to turn on LTO and
     PGO build support when available.

   - bpo-27917(8): Set platform triplets for Android builds.

   - bpo-25825(9): Update references to the $(LIBPL) installation path
     on AIX. This path was changed in 3.2a4.

   - Update OS X installer to use SQLite 3.14.1 and XZ 5.2.2.

   - bpo-21122(10): Fix LTO builds on OS X.

   - bpo-17128(11): Build OS X installer with a private copy of OpenSSL.
     Also provide a sample Install Certificates command script to
     install a set of root certificates from the third-party certifi
     module.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27566

   (2) https://bugs.python.org/issue27705

   (3) https://bugs.python.org/issue27976

   (4) https://bugs.python.org/issue27983

   (5) https://bugs.python.org/issue21590

   (6) https://bugs.python.org/issue26307

   (7) https://bugs.python.org/issue26359

   (8) https://bugs.python.org/issue27917

   (9) https://bugs.python.org/issue25825

   (10) https://bugs.python.org/issue21122

   (11) https://bugs.python.org/issue17128


File: python.info,  Node: Tools/Demos<22>,  Next: Windows<30>,  Prev: Build<32>,  Up: Python 3 6 0 beta 1

1.18.43.7 Tools/Demos
.....................

   - bpo-27952(1): Get Tools/scripts/fixcid.py working with Python 3 and
     the current “re” module, avoid invalid Python backslash escapes,
     and fix a bug parsing escaped C quote signs.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27952


File: python.info,  Node: Windows<30>,  Prev: Tools/Demos<22>,  Up: Python 3 6 0 beta 1

1.18.43.8 Windows
.................

   - bpo-28065(1): Update xz dependency to 5.2.2 and build it from
     source.

   - bpo-25144(2): Ensures TargetDir is set before continuing with
     custom install.

   - bpo-1602(3): Windows console doesn’t input or print Unicode (PEP
     528)

   - bpo-27781(4): Change file system encoding on Windows to UTF-8 (PEP
     529)

   - bpo-27731(5): Opt-out of MAX_PATH on Windows 10

   - bpo-6135(6): Adds encoding and errors parameters to subprocess.

   - bpo-27959(7): Adds oem encoding, alias ansi to mbcs, move aliasmbcs
     to codec lookup.

   - bpo-27982(8): The functions of the winsound module now accept
     keyword arguments.

   - bpo-20366(9): Build full text search support into SQLite on
     Windows.

   - bpo-27756(10): Adds new icons for Python files and processes on
     Windows.  Designs by Cherry Wang.

   - bpo-27883(11): Update sqlite to 3.14.1.0 on Windows.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28065

   (2) https://bugs.python.org/issue25144

   (3) https://bugs.python.org/issue1602

   (4) https://bugs.python.org/issue27781

   (5) https://bugs.python.org/issue27731

   (6) https://bugs.python.org/issue6135

   (7) https://bugs.python.org/issue27959

   (8) https://bugs.python.org/issue27982

   (9) https://bugs.python.org/issue20366

   (10) https://bugs.python.org/issue27756

   (11) https://bugs.python.org/issue27883


File: python.info,  Node: Python 3 6 0 alpha 4,  Next: Python 3 6 0 alpha 3,  Prev: Python 3 6 0 beta 1,  Up: Changelog

1.18.44 Python 3.6.0 alpha 4
----------------------------

`Release date: 2016-08-15'

* Menu:

* Core and Builtins: Core and Builtins<36>.
* Library: Library<37>.
* IDLE: IDLE<30>.
* Tests: Tests<32>.
* Windows: Windows<31>.
* Build: Build<33>.


File: python.info,  Node: Core and Builtins<36>,  Next: Library<37>,  Up: Python 3 6 0 alpha 4

1.18.44.1 Core and Builtins
...........................

   - bpo-27704(1): Optimized creating bytes and bytearray from byte-like
     objects and iterables.  Speed up to 3 times for short objects.
     Original patch by Naoki Inada.

   - bpo-26823(2): Large sections of repeated lines in tracebacks are
     now abbreviated as “[Previous line repeated {count} more times]” by
     the builtin traceback rendering.  Patch by Emanuel Barry.

   - bpo-27574(3): Decreased an overhead of parsing keyword arguments in
     functions implemented with using Argument Clinic.

   - bpo-22557(4): Now importing already imported modules is up to 2.5
     times faster.

   - bpo-17596(5): Include <wincrypt.h> to help with Min GW building.

   - bpo-17599(6): On Windows, rename the privately defined
     REPARSE_DATA_BUFFER structure to avoid conflicting with the
     definition from Min GW.

   - bpo-27507(7): Add integer overflow check in bytearray.extend().
     Patch by Xiang Zhang.

   - bpo-27581(8): Don’t rely on wrapping for overflow check in
     PySequence_Tuple().  Patch by Xiang Zhang.

   - bpo-1621(9): Avoid signed integer overflow in list and tuple
     operations.  Patch by Xiang Zhang.

   - bpo-27419(10): Standard __import__() no longer look up “__import__”
     in globals or builtins for importing submodules or “from import”.
     Fixed a crash if raise a warning about unabling to resolve package
     from __spec__ or __package__.

   - bpo-27083(11): Respect the PYTHONCASEOK environment variable under
     Windows.

   - bpo-27514(12): Make having too many statically nested blocks a
     SyntaxError instead of SystemError.

   - bpo-27366(13): Implemented PEP 487(14) (Simpler customization of
     class creation).  Upon subclassing, the __init_subclass__
     classmethod is called on the base class.  Descriptors are
     initialized with __set_name__ after class creation.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27704

   (2) https://bugs.python.org/issue26823

   (3) https://bugs.python.org/issue27574

   (4) https://bugs.python.org/issue22557

   (5) https://bugs.python.org/issue17596

   (6) https://bugs.python.org/issue17599

   (7) https://bugs.python.org/issue27507

   (8) https://bugs.python.org/issue27581

   (9) https://bugs.python.org/issue1621

   (10) https://bugs.python.org/issue27419

   (11) https://bugs.python.org/issue27083

   (12) https://bugs.python.org/issue27514

   (13) https://bugs.python.org/issue27366

   (14) https://www.python.org/dev/peps/pep-0487


File: python.info,  Node: Library<37>,  Next: IDLE<30>,  Prev: Core and Builtins<36>,  Up: Python 3 6 0 alpha 4

1.18.44.2 Library
.................

   - bpo-26027(1): Add PEP 519(2)/__fspath__() support to the os and
     os.path modules.  Includes code from Jelle Zijlstra.  (See also:
     bpo-27524(3))

   - bpo-27598(4): Add Collections to collections.abc.  Patch by Ivan
     Levkivskyi, docs by Neil Girdhar.

   - bpo-25958(5): Support “anti-registration” of special methods from
     various ABCs, like __hash__, __iter__ or __len__.  All these (and
     several more) can be set to None in an implementation class and the
     behavior will be as if the method is not defined at all.
     (Previously, this mechanism existed only for __hash__, to make
     mutable classes unhashable.)  Code contributed by Andrew Barnert
     and Ivan Levkivskyi.

   - bpo-16764(6): Support keyword arguments to zlib.decompress().
     Patch by Xiang Zhang.

   - bpo-27736(7): Prevent segfault after interpreter re-initialization
     due to ref count problem introduced in code for bpo-27038(8) in
     3.6.0a3.  Patch by Xiang Zhang.

   - bpo-25628(9): The `verbose' and `rename' parameters for
     collections.namedtuple are now keyword-only.

   - bpo-12345(10): Add mathematical constant tau to math and cmath.
     See also PEP 628(11).

   - bpo-26823(12): traceback.StackSummary.format now abbreviates large
     sections of repeated lines as “[Previous line repeated {count} more
     times]” (this change then further affects other traceback display
     operations in the module).  Patch by Emanuel Barry.

   - bpo-27664(13): Add to
     concurrent.futures.thread.ThreadPoolExecutor() the ability to
     specify a thread name prefix.

   - bpo-27181(14): Add geometric_mean and harmonic_mean to statistics
     module.

   - bpo-27573(15): code.interact now prints an message when exiting.

   - bpo-6422(16): Add autorange method to timeit.Timer objects.

   - bpo-27773(17): Correct some memory management errors
     server_hostname in _ssl.wrap_socket().

   - bpo-26750(18): unittest.mock.create_autospec() now works properly
     for subclasses of property() and other data descriptors.  Removes
     the never publicly used, never documented
     unittest.mock.DescriptorTypes tuple.

   - bpo-26754(19): Undocumented support of general bytes-like objects
     as path in compile() and similar functions is now deprecated.

   - bpo-26800(20): Undocumented support of general bytes-like objects
     as paths in os functions is now deprecated.

   - bpo-26981(21): Add _order_ compatibility shim to enum.Enum for
     Python 2/3 code bases.

   - bpo-27661(22): Added tzinfo keyword argument to datetime.combine.

   - In the curses module, raise an error if window.getstr() or
     window.instr() is passed a negative value.

   - bpo-27783(23): Fix possible usage of uninitialized memory in
     operator.methodcaller.

   - bpo-27774(24): Fix possible Py_DECREF on unowned object in _sre.

   - bpo-27760(25): Fix possible integer overflow in binascii.b2a_qp.

   - bpo-27758(26): Fix possible integer overflow in the _csv module for
     large record lengths.

   - bpo-27568(27): Prevent HTTPoxy attack (CVE-2016-1000110).  Ignore
     the HTTP_PROXY variable when REQUEST_METHOD environment is set,
     which indicates that the script is in CGI mode.

   - bpo-7063(28): Remove dead code from the “array” module’s slice
     handling.  Patch by Chuck.

   - bpo-27656(29): Do not assume sched.h defines any SCHED_* constants.

   - bpo-27130(30): In the “zlib” module, fix handling of large buffers
     (typically 4 GiB) when compressing and decompressing.  Previously,
     inputs were limited to 4 GiB, and compression and decompression
     operations did not properly handle results of 4 GiB.

   - bpo-24773(31): Implemented PEP 495(32) (Local Time Disambiguation).

   - Expose the EPOLLEXCLUSIVE constant (when it is defined) in the
     select module.

   - bpo-27567(33): Expose the EPOLLRDHUP and POLLRDHUP constants in the
     select module.

   - bpo-1621(34): Avoid signed int negation overflow in the “audioop”
     module.

   - bpo-27533(35): Release GIL in nt._isdir

   - bpo-17711(36): Fixed unpickling by the persistent ID with protocol
     0.  Original patch by Alexandre Vassalotti.

   - bpo-27522(37): Avoid an unintentional reference cycle in
     email.feedparser.

   - bpo-27512(38): Fix a segfault when os.fspath() called an
     __fspath__() method that raised an exception.  Patch by Xiang
     Zhang.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26027

   (2) https://www.python.org/dev/peps/pep-0519

   (3) https://bugs.python.org/issue27524

   (4) https://bugs.python.org/issue27598

   (5) https://bugs.python.org/issue25958

   (6) https://bugs.python.org/issue16764

   (7) https://bugs.python.org/issue27736

   (8) https://bugs.python.org/issue27038

   (9) https://bugs.python.org/issue25628

   (10) https://bugs.python.org/issue12345

   (11) https://www.python.org/dev/peps/pep-0628

   (12) https://bugs.python.org/issue26823

   (13) https://bugs.python.org/issue27664

   (14) https://bugs.python.org/issue27181

   (15) https://bugs.python.org/issue27573

   (16) https://bugs.python.org/issue6422

   (17) https://bugs.python.org/issue27773

   (18) https://bugs.python.org/issue26750

   (19) https://bugs.python.org/issue26754

   (20) https://bugs.python.org/issue26800

   (21) https://bugs.python.org/issue26981

   (22) https://bugs.python.org/issue27661

   (23) https://bugs.python.org/issue27783

   (24) https://bugs.python.org/issue27774

   (25) https://bugs.python.org/issue27760

   (26) https://bugs.python.org/issue27758

   (27) https://bugs.python.org/issue27568

   (28) https://bugs.python.org/issue7063

   (29) https://bugs.python.org/issue27656

   (30) https://bugs.python.org/issue27130

   (31) https://bugs.python.org/issue24773

   (32) https://www.python.org/dev/peps/pep-0495

   (33) https://bugs.python.org/issue27567

   (34) https://bugs.python.org/issue1621

   (35) https://bugs.python.org/issue27533

   (36) https://bugs.python.org/issue17711

   (37) https://bugs.python.org/issue27522

   (38) https://bugs.python.org/issue27512


File: python.info,  Node: IDLE<30>,  Next: Tests<32>,  Prev: Library<37>,  Up: Python 3 6 0 alpha 4

1.18.44.3 IDLE
..............

   - bpo-27714(1): text_textview and test_autocomplete now pass when
     re-run in the same process.  This occurs when test_idle fails when
     run with the -w option but without -jn.  Fix warning from
     test_config.

   - bpo-27621(2): Put query response validation error messages in the
     query box itself instead of in a separate messagebox.  Redo tests
     to match.  Add Mac OSX refinements.  Original patch by Mark
     Roseman.

   - bpo-27620(3): Escape key now closes Query box as cancelled.

   - bpo-27609(4): IDLE: tab after initial whitespace should tab, not
     autocomplete.  This fixes problem with writing docstrings at least
     twice indented.

   - bpo-27609(5): Explicitly return None when there are also non-None
     returns.  In a few cases, reverse a condition and eliminate a
     return.

   - bpo-25507(6): IDLE no longer runs buggy code because of its tkinter
     imports.  Users must include the same imports required to run
     directly in Python.

   - bpo-27173(7): Add ‘IDLE Modern Unix’ to the built-in key sets.
     Make the default key set depend on the platform.  Add tests for the
     changes to the config module.

   - bpo-27452(8): add line counter and crc to IDLE configHandler test
     dump.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27714

   (2) https://bugs.python.org/issue27621

   (3) https://bugs.python.org/issue27620

   (4) https://bugs.python.org/issue27609

   (5) https://bugs.python.org/issue27609

   (6) https://bugs.python.org/issue25507

   (7) https://bugs.python.org/issue27173

   (8) https://bugs.python.org/issue27452


File: python.info,  Node: Tests<32>,  Next: Windows<31>,  Prev: IDLE<30>,  Up: Python 3 6 0 alpha 4

1.18.44.4 Tests
...............

   - bpo-25805(1): Skip a test in test_pkgutil as needed that doesn’t
     work when ‘__name__ == __main__’.  Patch by SilentGhost.

   - bpo-27472(2): Add test.support.unix_shell as the path to the
     default shell.

   - bpo-27369(3): In test_pyexpat, avoid testing an error message
     detail that changed in Expat 2.2.0.

   - bpo-27594(4): Prevent assertion error when running test_ast with
     coverage enabled: ensure code object has a valid first line number.
     Patch suggested by Ivan Levkivskyi.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25805

   (2) https://bugs.python.org/issue27472

   (3) https://bugs.python.org/issue27369

   (4) https://bugs.python.org/issue27594


File: python.info,  Node: Windows<31>,  Next: Build<33>,  Prev: Tests<32>,  Up: Python 3 6 0 alpha 4

1.18.44.5 Windows
.................

   - bpo-27647(1): Update bundled Tcl/Tk to 8.6.6.

   - bpo-27610(2): Adds PEP 514(3) metadata to Windows installer

   - bpo-27469(4): Adds a shell extension to the launcher so that drag
     and drop works correctly.

   - bpo-27309(5): Enables proper Windows styles in python[w].exe
     manifest.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27647

   (2) https://bugs.python.org/issue27610

   (3) https://www.python.org/dev/peps/pep-0514

   (4) https://bugs.python.org/issue27469

   (5) https://bugs.python.org/issue27309


File: python.info,  Node: Build<33>,  Prev: Windows<31>,  Up: Python 3 6 0 alpha 4

1.18.44.6 Build
...............

   - bpo-27713(1): Suppress spurious build warnings when updating
     importlib’s bootstrap files.  Patch by Xiang Zhang

   - bpo-25825(2): Correct the references to Modules/python.exp, which
     is required on AIX. The references were accidentally changed in
     3.5.0a1.

   - bpo-27453(3): CPP invocation in configure must use CPPFLAGS. Patch
     by Chi Hsuan Yen.

   - bpo-27641(4): The configure script now inserts comments into the
     makefile to prevent the pgen and _freeze_importlib executables from
     being cross-compiled.

   - bpo-26662(5): Set PYTHON_FOR_GEN in configure as the Python program
     to be used for file generation during the build.

   - bpo-10910(6): Avoid C++ compilation errors on FreeBSD and OS X.
     Also update FreedBSD version checks for the original ctype UTF-8
     workaround.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27713

   (2) https://bugs.python.org/issue25825

   (3) https://bugs.python.org/issue27453

   (4) https://bugs.python.org/issue27641

   (5) https://bugs.python.org/issue26662

   (6) https://bugs.python.org/issue10910


File: python.info,  Node: Python 3 6 0 alpha 3,  Next: Python 3 6 0 alpha 2,  Prev: Python 3 6 0 alpha 4,  Up: Changelog

1.18.45 Python 3.6.0 alpha 3
----------------------------

`Release date: 2016-07-11'

* Menu:

* Core and Builtins: Core and Builtins<37>.
* Library: Library<38>.
* Security: Security<17>.
* Library: Library<39>.
* Security: Security<18>.
* Library: Library<40>.
* IDLE: IDLE<31>.
* C API: C API<25>.
* Build: Build<34>.
* Tools/Demos: Tools/Demos<23>.
* Documentation: Documentation<31>.
* Tests: Tests<33>.


File: python.info,  Node: Core and Builtins<37>,  Next: Library<38>,  Up: Python 3 6 0 alpha 3

1.18.45.1 Core and Builtins
...........................

   - bpo-27473(1): Fixed possible integer overflow in bytes and
     bytearray concatenations.  Patch by Xiang Zhang.

   - bpo-23034(2): The output of a special Python build with defined
     COUNT_ALLOCS, SHOW_ALLOC_COUNT or SHOW_TRACK_COUNT macros is now
     off by default.  It can be re-enabled using the “-X showalloccount”
     option.  It now outputs to stderr instead of stdout.

   - bpo-27443(3): __length_hint__() of bytearray iterators no longer
     return a negative integer for a resized bytearray.

   - bpo-27007(4): The fromhex() class methods of bytes and bytearray
     subclasses now return an instance of corresponding subclass.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27473

   (2) https://bugs.python.org/issue23034

   (3) https://bugs.python.org/issue27443

   (4) https://bugs.python.org/issue27007


File: python.info,  Node: Library<38>,  Next: Security<17>,  Prev: Core and Builtins<37>,  Up: Python 3 6 0 alpha 3

1.18.45.2 Library
.................

   - bpo-26844(1): Fix error message for imp.find_module() to refer to
     ‘path’ instead of ‘name’.  Patch by Lev Maximov.

   - bpo-23804(2): Fix SSL zero-length recv() calls to not block and not
     raise an error about unclean EOF.

   - bpo-27466(3): Change time format returned by
     http.cookie.time2netscape, confirming the netscape cookie format
     and making it consistent with documentation.

   - bpo-21708(4): Deprecated dbm.dumb behavior that differs from common
     dbm behavior: creating a database in ‘r’ and ‘w’ modes and
     modifying a database in ‘r’ mode.

   - bpo-26721(5): Change the socketserver.StreamRequestHandler.wfile
     attribute to implement BufferedIOBase.  In particular, the write()
     method no longer does partial writes.

   - bpo-22115(6): Added methods trace_add, trace_remove and trace_info
     in the tkinter.Variable class.  They replace old methods
     trace_variable, trace, trace_vdelete and trace_vinfo that use
     obsolete Tcl commands and might not work in future versions of Tcl.
     Fixed old tracing methods: trace_vdelete() with wrong mode no
     longer break tracing, trace_vinfo() now always returns a list of
     pairs of strings, tracing in the “u” mode now works.

   - bpo-26243(7): Only the level argument to zlib.compress() is keyword
     argument now.  The first argument is positional-only.

   - bpo-27038(8): Expose the DirEntry type as os.DirEntry.  Code patch
     by Jelle Zijlstra.

   - bpo-27186(9): Update os.fspath()/PyOS_FSPath() to check the return
     value of __fspath__() to be either str or bytes.

   - bpo-18726(10): All optional parameters of the dump(), dumps(),
     load() and loads() functions and JSONEncoder and JSONDecoder class
     constructors in the json module are now keyword-only.

   - bpo-27319(11): Methods selection_set(), selection_add(),
     selection_remove() and selection_toggle() of ttk.TreeView now allow
     passing multiple items as multiple arguments instead of passing
     them as a tuple.  Deprecated undocumented ability of calling the
     selection() method with arguments.

   - bpo-27079(12): Fixed curses.ascii functions isblank(), iscntrl()
     and ispunct().

   - bpo-27294(13): Numerical state in the repr for Tkinter event
     objects is now represented as a combination of known flags.

   - bpo-27177(14): Match objects in the re module now support
     index-like objects as group indices.  Based on patches by Jeroen
     Demeyer and Xiang Zhang.

   - bpo-26754(15): Some functions (compile() etc) accepted a filename
     argument encoded as an iterable of integers.  Now only strings and
     byte-like objects are accepted.

   - bpo-26536(16): socket.ioctl now supports SIO_LOOPBACK_FAST_PATH.
     Patch by Daniel Stokes.

   - bpo-27048(17): Prevents distutils failing on Windows when
     environment variables contain non-ASCII characters

   - bpo-27330(18): Fixed possible leaks in the ctypes module.

   - bpo-27238(19): Got rid of bare excepts in the turtle module.
     Original patch by Jelle Zijlstra.

   - bpo-27122(20): When an exception is raised within the context being
     managed by a contextlib.ExitStack() and one of the exit stack
     generators catches and raises it in a chain, do not re-raise the
     original exception when exiting, let the new chained one through.
     This avoids the PEP 479(21) bug described in issue25782.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26844

   (2) https://bugs.python.org/issue23804

   (3) https://bugs.python.org/issue27466

   (4) https://bugs.python.org/issue21708

   (5) https://bugs.python.org/issue26721

   (6) https://bugs.python.org/issue22115

   (7) https://bugs.python.org/issue26243

   (8) https://bugs.python.org/issue27038

   (9) https://bugs.python.org/issue27186

   (10) https://bugs.python.org/issue18726

   (11) https://bugs.python.org/issue27319

   (12) https://bugs.python.org/issue27079

   (13) https://bugs.python.org/issue27294

   (14) https://bugs.python.org/issue27177

   (15) https://bugs.python.org/issue26754

   (16) https://bugs.python.org/issue26536

   (17) https://bugs.python.org/issue27048

   (18) https://bugs.python.org/issue27330

   (19) https://bugs.python.org/issue27238

   (20) https://bugs.python.org/issue27122

   (21) https://www.python.org/dev/peps/pep-0479


File: python.info,  Node: Security<17>,  Next: Library<39>,  Prev: Library<38>,  Up: Python 3 6 0 alpha 3

1.18.45.3 Security
..................

   - bpo-27278(1): Fix os.urandom() implementation using getrandom() on
     Linux.  Truncate size to INT_MAX and loop until we collected enough
     random bytes, instead of casting a directly Py_ssize_t to int.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27278


File: python.info,  Node: Library<39>,  Next: Security<18>,  Prev: Security<17>,  Up: Python 3 6 0 alpha 3

1.18.45.4 Library
.................

   - bpo-16864(1): sqlite3.Cursor.lastrowid now supports REPLACE
     statement.  Initial patch by Alex LordThorsen.

   - bpo-26386(2): Fixed ttk.TreeView selection operations with item
     id’s containing spaces.

   - bpo-8637(3): Honor a pager set by the env var MANPAGER (in
     preference to one set by the env var PAGER).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16864

   (2) https://bugs.python.org/issue26386

   (3) https://bugs.python.org/issue8637


File: python.info,  Node: Security<18>,  Next: Library<40>,  Prev: Library<39>,  Up: Python 3 6 0 alpha 3

1.18.45.5 Security
..................

   - bpo-22636(1): Avoid shell injection problems with
     ctypes.util.find_library().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22636


File: python.info,  Node: Library<40>,  Next: IDLE<31>,  Prev: Security<18>,  Up: Python 3 6 0 alpha 3

1.18.45.6 Library
.................

   - bpo-16182(1): Fix various functions in the “readline” module to use
     the locale encoding, and fix get_begidx() and get_endidx() to
     return code point indexes.

   - bpo-27392(2): Add loop.connect_accepted_socket().  Patch by Jim
     Fulton.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16182

   (2) https://bugs.python.org/issue27392


File: python.info,  Node: IDLE<31>,  Next: C API<25>,  Prev: Library<40>,  Up: Python 3 6 0 alpha 3

1.18.45.7 IDLE
..............

   - bpo-27477(1): IDLE search dialogs now use ttk widgets.

   - bpo-27173(2): Add ‘IDLE Modern Unix’ to the built-in key sets.
     Make the default key set depend on the platform.  Add tests for the
     changes to the config module.

   - bpo-27452(3): make command line “idle-test> python test_help.py”
     work.  __file__ is relative when python is started in the file’s
     directory.

   - bpo-27452(4): add line counter and crc to IDLE configHandler test
     dump.

   - bpo-27380(5): IDLE: add query.py with base Query dialog and ttk
     widgets.  Module had subclasses SectionName, ModuleName, and
     HelpSource, which are used to get information from users by
     configdialog and file =>Load Module.  Each subclass has itw own
     validity checks.  Using ModuleName allows users to edit bad module
     names instead of starting over.  Add tests and delete the two files
     combined into the new one.

   - bpo-27372(6): Test_idle no longer changes the locale.

   - bpo-27365(7): Allow non-ascii chars in IDLE NEWS.txt, for
     contributor names.

   - bpo-27245(8): IDLE: Cleanly delete custom themes and key bindings.
     Previously, when IDLE was started from a console or by import, a
     cascade of warnings was emitted.  Patch by Serhiy Storchaka.

   - bpo-24137(9): Run IDLE, test_idle, and htest with tkinter default
     root disabled.  Fix code and tests that fail with this restriction.
     Fix htests to not create a second and redundant root and mainloop.

   - bpo-27310(10): Fix IDLE.app failure to launch on OS X due to
     vestigial import.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27477

   (2) https://bugs.python.org/issue27173

   (3) https://bugs.python.org/issue27452

   (4) https://bugs.python.org/issue27452

   (5) https://bugs.python.org/issue27380

   (6) https://bugs.python.org/issue27372

   (7) https://bugs.python.org/issue27365

   (8) https://bugs.python.org/issue27245

   (9) https://bugs.python.org/issue24137

   (10) https://bugs.python.org/issue27310


File: python.info,  Node: C API<25>,  Next: Build<34>,  Prev: IDLE<31>,  Up: Python 3 6 0 alpha 3

1.18.45.8 C API
...............

   - bpo-26754(1): PyUnicode_FSDecoder() accepted a filename argument
     encoded as an iterable of integers.  Now only strings and byte-like
     objects are accepted.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26754


File: python.info,  Node: Build<34>,  Next: Tools/Demos<23>,  Prev: C API<25>,  Up: Python 3 6 0 alpha 3

1.18.45.9 Build
...............

   - bpo-28066(1): Fix the logic that searches build directories for
     generated include files when building outside the source tree.

   - bpo-27442(2): Expose the Android API level that python was built
     against, in sysconfig.get_config_vars() as ‘ANDROID_API_LEVEL’.

   - bpo-27434(3): The interpreter that runs the cross-build, found in
     PATH, must now be of the same feature version (e.g.  3.6) as the
     source being built.

   - bpo-26930(4): Update Windows builds to use OpenSSL 1.0.2h.

   - bpo-23968(5): Rename the platform directory from plat-$(MACHDEP) to
     plat-$(PLATFORM_TRIPLET). Rename the config directory (LIBPL) from
     config-$(LDVERSION) to config-$(LDVERSION)-$(PLATFORM_TRIPLET).
     Install the platform specific _sysconfigdata module into the
     platform directory and rename it to include the ABIFLAGS.

   - Don’t use largefile support for GNU/Hurd.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28066

   (2) https://bugs.python.org/issue27442

   (3) https://bugs.python.org/issue27434

   (4) https://bugs.python.org/issue26930

   (5) https://bugs.python.org/issue23968


File: python.info,  Node: Tools/Demos<23>,  Next: Documentation<31>,  Prev: Build<34>,  Up: Python 3 6 0 alpha 3

1.18.45.10 Tools/Demos
......................

   - bpo-27332(1): Fixed the type of the first argument of module-level
     functions generated by Argument Clinic.  Patch by Petr Viktorin.

   - bpo-27418(2): Fixed Tools/importbench/importbench.py.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27332

   (2) https://bugs.python.org/issue27418


File: python.info,  Node: Documentation<31>,  Next: Tests<33>,  Prev: Tools/Demos<23>,  Up: Python 3 6 0 alpha 3

1.18.45.11 Documentation
........................

   - bpo-19489(1): Moved the search box from the sidebar to the header
     and footer of each page.  Patch by Ammar Askar.

   - bpo-27285(2): Update documentation to reflect the deprecation of
     ‘pyvenv’ and normalize on the term “virtual environment”.  Patch by
     Steve Piercy.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19489

   (2) https://bugs.python.org/issue27285


File: python.info,  Node: Tests<33>,  Prev: Documentation<31>,  Up: Python 3 6 0 alpha 3

1.18.45.12 Tests
................

   - bpo-27027(1): Added test.support.is_android that is True when this
     is an Android build.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27027


File: python.info,  Node: Python 3 6 0 alpha 2,  Next: Python 3 6 0 alpha 1,  Prev: Python 3 6 0 alpha 3,  Up: Changelog

1.18.46 Python 3.6.0 alpha 2
----------------------------

`Release date: 2016-06-13'

* Menu:

* Core and Builtins: Core and Builtins<38>.
* Library: Library<41>.
* Security: Security<19>.
* Library: Library<42>.
* Security: Security<20>.
* Library: Library<43>.
* IDLE: IDLE<32>.
* Documentation: Documentation<32>.
* Tests: Tests<34>.
* Windows: Windows<32>.
* Build: Build<35>.
* Windows: Windows<33>.
* C API: C API<26>.
* Tools/Demos: Tools/Demos<24>.


File: python.info,  Node: Core and Builtins<38>,  Next: Library<41>,  Up: Python 3 6 0 alpha 2

1.18.46.1 Core and Builtins
...........................

   - bpo-27095(1): Simplified MAKE_FUNCTION and removed MAKE_CLOSURE
     opcodes.  Patch by Demur Rumed.

   - bpo-27190(2): Raise NotSupportedError if sqlite3 is older than
     3.3.1.  Patch by Dave Sawyer.

   - bpo-27286(3): Fixed compiling BUILD_MAP_UNPACK_WITH_CALL opcode.
     Calling function with generalized unpacking (PEP 448) and
     conflicting keyword names could cause undefined behavior.

   - bpo-27140(4): Added BUILD_CONST_KEY_MAP opcode.

   - bpo-27186(5): Add support for os.PathLike objects to open() (part
     of PEP 519(6)).

   - bpo-27066(7): Fixed SystemError if a custom opener (for open())
     returns a negative number without setting an exception.

   - bpo-26983(8): float() now always return an instance of exact float.
     The deprecation warning is emitted if __float__ returns an instance
     of a strict subclass of float.  In a future versions of Python this
     can be an error.

   - bpo-27097(9): Python interpreter is now about 7% faster due to
     optimized instruction decoding.  Based on patch by Demur Rumed.

   - bpo-26647(10): Python interpreter now uses 16-bit wordcode instead
     of bytecode.  Patch by Demur Rumed.

   - bpo-23275(11): Allow assigning to an empty target list in round
     brackets: () = iterable.

   - bpo-27243(12): Update the __aiter__ protocol: instead of returning
     an awaitable that resolves to an asynchronous iterator, the
     asynchronous iterator should be returned directly.  Doing the
     former will trigger a PendingDeprecationWarning.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27095

   (2) https://bugs.python.org/issue27190

   (3) https://bugs.python.org/issue27286

   (4) https://bugs.python.org/issue27140

   (5) https://bugs.python.org/issue27186

   (6) https://www.python.org/dev/peps/pep-0519

   (7) https://bugs.python.org/issue27066

   (8) https://bugs.python.org/issue26983

   (9) https://bugs.python.org/issue27097

   (10) https://bugs.python.org/issue26647

   (11) https://bugs.python.org/issue23275

   (12) https://bugs.python.org/issue27243


File: python.info,  Node: Library<41>,  Next: Security<19>,  Prev: Core and Builtins<38>,  Up: Python 3 6 0 alpha 2

1.18.46.2 Library
.................

   - Comment out socket (SO_REUSEPORT) and posix (O_SHLOCK, O_EXLOCK)
     constants exposed on the API which are not implemented on GNU/Hurd.
     They would not work at runtime anyway.

   - bpo-27025(1): Generated names for Tkinter widgets are now more
     meaningful and recognizable.

   - bpo-25455(2): Fixed crashes in repr of recursive
     ElementTree.Element and functools.partial objects.

   - bpo-27294(3): Improved repr for Tkinter event objects.

   - bpo-20508(4): Improve exception message of
     IPv{4,6}Network.__getitem__.  Patch by Gareth Rees.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27025

   (2) https://bugs.python.org/issue25455

   (3) https://bugs.python.org/issue27294

   (4) https://bugs.python.org/issue20508


File: python.info,  Node: Security<19>,  Next: Library<42>,  Prev: Library<41>,  Up: Python 3 6 0 alpha 2

1.18.46.3 Security
..................

   - bpo-26556(1): Update expat to 2.1.1, fixes CVE-2015-1283.

   - Fix TLS stripping vulnerability in smtplib, CVE-2016-0772.
     Reported by Team Oststrom.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26556


File: python.info,  Node: Library<42>,  Next: Security<20>,  Prev: Security<19>,  Up: Python 3 6 0 alpha 2

1.18.46.4 Library
.................

   - bpo-21386(1): Implement missing IPv4Address.is_global property.  It
     was documented since 07a5610bae9d.  Initial patch by Roger Luethi.

   - bpo-27029(2): Removed deprecated support of universal newlines mode
     from ZipFile.open().

   - bpo-27030(3): Unknown escapes consisting of ‘'\'’ and an ASCII
     letter in regular expressions now are errors.  The re.LOCALE flag
     now can be used only with bytes patterns.

   - bpo-27186(4): Add os.PathLike support to DirEntry (part of PEP
     519(5)).  Initial patch by Jelle Zijlstra.

   - bpo-20900(6): distutils register command now decodes HTTP responses
     correctly.  Initial patch by ingrid.

   - bpo-27186(7): Add os.PathLike support to pathlib, removing its
     provisional status (part of PEP 519).  Initial patch by Dusty
     Phillips.

   - bpo-27186(8): Add support for os.PathLike objects to os.fsencode()
     and os.fsdecode() (part of PEP 519(9)).

   - bpo-27186(10): Introduce os.PathLike and os.fspath() (part of PEP
     519(11)).

   - A new version of typing.py provides several new classes and
     features: @overload outside stubs, Reversible, DefaultDict, Text,
     ContextManager, Type[], NewType(), TYPE_CHECKING, and numerous bug
     fixes (note that some of the new features are not yet implemented
     in mypy or other static analyzers).  Also classes for PEP 492(12)
     (Awaitable, AsyncIterable, AsyncIterator) have been added (in fact
     they made it into 3.5.1 but were never mentioned).

   - bpo-25738(13): Stop http.server.BaseHTTPRequestHandler.send_error()
     from sending a message body for 205 Reset Content.  Also, don’t
     send Content header fields in responses that don’t have a body.
     Patch by Susumu Koshiba.

   - bpo-21313(14): Fix the “platform” module to tolerate when
     sys.version contains truncated build information.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21386

   (2) https://bugs.python.org/issue27029

   (3) https://bugs.python.org/issue27030

   (4) https://bugs.python.org/issue27186

   (5) https://www.python.org/dev/peps/pep-0519

   (6) https://bugs.python.org/issue20900

   (7) https://bugs.python.org/issue27186

   (8) https://bugs.python.org/issue27186

   (9) https://www.python.org/dev/peps/pep-0519

   (10) https://bugs.python.org/issue27186

   (11) https://www.python.org/dev/peps/pep-0519

   (12) https://www.python.org/dev/peps/pep-0492

   (13) https://bugs.python.org/issue25738

   (14) https://bugs.python.org/issue21313


File: python.info,  Node: Security<20>,  Next: Library<43>,  Prev: Library<42>,  Up: Python 3 6 0 alpha 2

1.18.46.5 Security
..................

   - bpo-26839(1): On Linux, *note os.urandom(): 4c6. now calls
     ‘getrandom()’ with ‘GRND_NONBLOCK’ to fall back on reading
     ‘/dev/urandom’ if the urandom entropy pool is not initialized yet.
     Patch written by Colm Buckley.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26839


File: python.info,  Node: Library<43>,  Next: IDLE<32>,  Prev: Security<20>,  Up: Python 3 6 0 alpha 2

1.18.46.6 Library
.................

   - bpo-23883(1): Added missing APIs to __all__ to match the documented
     APIs for the following modules: cgi, mailbox, mimetypes, plistlib
     and smtpd.  Patches by Jacek Kołodziej.

   - bpo-27164(2): In the zlib module, allow decompressing raw Deflate
     streams with a predefined zdict.  Based on patch by Xiang Zhang.

   - bpo-24291(3): Fix wsgiref.simple_server.WSGIRequestHandler to
     completely write data to the client.  Previously it could do
     partial writes and truncate data.  Also,
     wsgiref.handler.ServerHandler can now handle stdout doing partial
     writes, but this is deprecated.

   - bpo-21272(4): Use _sysconfigdata.py to initialize
     distutils.sysconfig.

   - bpo-19611(5): *note inspect: a0. now reports the implicit ‘.0’
     parameters generated by the compiler for comprehension and
     generator expression scopes as if they were positional-only
     parameters called ‘implicit0’.  Patch by Jelle Zijlstra.

   - bpo-26809(6): Add ‘__all__’ to *note string: f6.  Patch by Emanuel
     Barry.

   - bpo-26373(7): subprocess.Popen.communicate now correctly ignores
     BrokenPipeError when the child process dies before .communicate()
     is called in more/all circumstances.

   - signal, socket, and ssl module IntEnum constant name lookups now
     return a consistent name for values having multiple names.  Ex:
     signal.Signals(6) now refers to itself as signal.SIGALRM rather
     than flipping between that and signal.SIGIOT based on the
     interpreter’s hash randomization seed.

   - bpo-27167(8): Clarify the subprocess.CalledProcessError error
     message text when the child process died due to a signal.

   - bpo-25931(9): Don’t define socketserver.Forking* names on platforms
     such as Windows that do not support os.fork().

   - bpo-21776(10): distutils.upload now correctly handles HTTPError.
     Initial patch by Claudiu Popa.

   - bpo-26526(11): Replace custom parse tree validation in the parser
     module with a simple DFA validator.

   - bpo-27114(12): Fix SSLContext._load_windows_store_certs fails with
     PermissionError

   - bpo-18383(13): Avoid creating duplicate filters when using
     filterwarnings and simplefilter.  Based on patch by Alex Shkop.

   - bpo-23026(14): winreg.QueryValueEx() now return an integer for
     REG_QWORD type.

   - bpo-26741(15): subprocess.Popen destructor now emits a
     ResourceWarning warning if the child process is still running.

   - bpo-27056(16): Optimize pickle.load() and pickle.loads(), up to 10%
     faster to deserialize a lot of small objects.

   - bpo-21271(17): New keyword only parameters in reset_mock call.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23883

   (2) https://bugs.python.org/issue27164

   (3) https://bugs.python.org/issue24291

   (4) https://bugs.python.org/issue21272

   (5) https://bugs.python.org/issue19611

   (6) https://bugs.python.org/issue26809

   (7) https://bugs.python.org/issue26373

   (8) https://bugs.python.org/issue27167

   (9) https://bugs.python.org/issue25931

   (10) https://bugs.python.org/issue21776

   (11) https://bugs.python.org/issue26526

   (12) https://bugs.python.org/issue27114

   (13) https://bugs.python.org/issue18383

   (14) https://bugs.python.org/issue23026

   (15) https://bugs.python.org/issue26741

   (16) https://bugs.python.org/issue27056

   (17) https://bugs.python.org/issue21271


File: python.info,  Node: IDLE<32>,  Next: Documentation<32>,  Prev: Library<43>,  Up: Python 3 6 0 alpha 2

1.18.46.7 IDLE
..............

   - bpo-5124(1): Paste with text selected now replaces the selection on
     X11.  This matches how paste works on Windows, Mac, most modern
     Linux apps, and ttk widgets.  Original patch by Serhiy Storchaka.

   - bpo-24750(2): Switch all scrollbars in IDLE to ttk versions.  Where
     needed, minimal tests are added to cover changes.

   - bpo-24759(3): IDLE requires tk 8.5 and availability ttk widgets.
     Delete now unneeded tk version tests and code for older versions.
     Add test for IDLE syntax colorizer.

   - bpo-27239(4): idlelib.macosx.isXyzTk functions initialize as
     needed.

   - bpo-27262(5): move Aqua unbinding code, which enable context menus,
     to macosx.

   - bpo-24759(6): Make clear in idlelib.idle_test.__init__ that the
     directory is a private implementation of test.test_idle and tool
     for maintainers.

   - bpo-27196(7): Stop ‘ThemeChanged’ warnings when running IDLE tests.
     These persisted after other warnings were suppressed in #20567.
     Apply Serhiy Storchaka’s update_idletasks solution to four test
     files.  Record this additional advice in idle_test/README.txt

   - bpo-20567(8): Revise idle_test/README.txt with advice about
     avoiding tk warning messages from tests.  Apply advice to several
     IDLE tests.

   - bpo-24225(9): Update idlelib/README.txt with new file names and
     event handlers.

   - bpo-27156(10): Remove obsolete code not used by IDLE.

   - bpo-27117(11): Make colorizer htest and turtledemo work with dark
     themes.  Move code for configuring text widget colors to a new
     function.

   - bpo-24225(12): Rename many ‘idlelib/*.py’ and ‘idle_test/test_*.py’
     files.  Edit files to replace old names with new names when the old
     name referred to the module rather than the class it contained.
     See the issue and IDLE section in What’s New in 3.6 for more.

   - bpo-26673(13): When tk reports font size as 0, change to size 10.
     Such fonts on Linux prevented the configuration dialog from
     opening.

   - bpo-21939(14): Add test for IDLE’s percolator.  Original patch by
     Saimadhav Heblikar.

   - bpo-21676(15): Add test for IDLE’s replace dialog.  Original patch
     by Saimadhav Heblikar.

   - bpo-18410(16): Add test for IDLE’s search dialog.  Original patch
     by Westley Martínez.

   - bpo-21703(17): Add test for undo delegator.  Patch mostly by
     Saimadhav Heblikar .

   - bpo-27044(18): Add ConfigDialog.remove_var_callbacks to stop memory
     leaks.

   - bpo-23977(19): Add more asserts to test_delegator.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5124

   (2) https://bugs.python.org/issue24750

   (3) https://bugs.python.org/issue24759

   (4) https://bugs.python.org/issue27239

   (5) https://bugs.python.org/issue27262

   (6) https://bugs.python.org/issue24759

   (7) https://bugs.python.org/issue27196

   (8) https://bugs.python.org/issue20567

   (9) https://bugs.python.org/issue24225

   (10) https://bugs.python.org/issue27156

   (11) https://bugs.python.org/issue27117

   (12) https://bugs.python.org/issue24225

   (13) https://bugs.python.org/issue26673

   (14) https://bugs.python.org/issue21939

   (15) https://bugs.python.org/issue21676

   (16) https://bugs.python.org/issue18410

   (17) https://bugs.python.org/issue21703

   (18) https://bugs.python.org/issue27044

   (19) https://bugs.python.org/issue23977


File: python.info,  Node: Documentation<32>,  Next: Tests<34>,  Prev: IDLE<32>,  Up: Python 3 6 0 alpha 2

1.18.46.8 Documentation
.......................

   - bpo-16484(1): Change the default PYTHONDOCS URL to “https:”, and
     fix the resulting links to use lowercase.  Patch by Sean Rodman,
     test by Kaushik Nadikuditi.

   - bpo-24136(2): Document the new PEP 448(3) unpacking syntax of 3.5.

   - bpo-22558(4): Add remaining doc links to source code for
     Python-coded modules.  Patch by Yoni Lavi.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16484

   (2) https://bugs.python.org/issue24136

   (3) https://www.python.org/dev/peps/pep-0448

   (4) https://bugs.python.org/issue22558


File: python.info,  Node: Tests<34>,  Next: Windows<32>,  Prev: Documentation<32>,  Up: Python 3 6 0 alpha 2

1.18.46.9 Tests
...............

   - bpo-25285(1): regrtest now uses subprocesses when the -j1 command
     line option is used: each test file runs in a fresh child process.
     Before, the -j1 option was ignored.

   - bpo-25285(2): Tools/buildbot/test.bat script now uses -j1 by
     default to run each test file in fresh child process.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25285

   (2) https://bugs.python.org/issue25285


File: python.info,  Node: Windows<32>,  Next: Build<35>,  Prev: Tests<34>,  Up: Python 3 6 0 alpha 2

1.18.46.10 Windows
..................

   - bpo-27064(1): The py.exe launcher now defaults to Python 3.  The
     Windows launcher ‘py.exe’ no longer prefers an installed Python 2
     version over Python 3 by default when used interactively.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27064


File: python.info,  Node: Build<35>,  Next: Windows<33>,  Prev: Windows<32>,  Up: Python 3 6 0 alpha 2

1.18.46.11 Build
................

   - bpo-27229(1): Fix the cross-compiling pgen rule for in-tree builds.
     Patch by Xavier de Gaye.

   - bpo-26930(2): Update OS X 10.5+ 32-bit-only installer to build and
     link with OpenSSL 1.0.2h.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27229

   (2) https://bugs.python.org/issue26930


File: python.info,  Node: Windows<33>,  Next: C API<26>,  Prev: Build<35>,  Up: Python 3 6 0 alpha 2

1.18.46.12 Windows
..................

   - bpo-17500(1): Remove unused and outdated icons.  (See also:
     ‘https://github.com/python/pythondotorg/issues/945’)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17500


File: python.info,  Node: C API<26>,  Next: Tools/Demos<24>,  Prev: Windows<33>,  Up: Python 3 6 0 alpha 2

1.18.46.13 C API
................

   - bpo-27186(1): Add the PyOS_FSPath() function (part of PEP 519(2)).

   - bpo-26282(3): PyArg_ParseTupleAndKeywords() now supports
     positional-only parameters.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27186

   (2) https://www.python.org/dev/peps/pep-0519

   (3) https://bugs.python.org/issue26282


File: python.info,  Node: Tools/Demos<24>,  Prev: C API<26>,  Up: Python 3 6 0 alpha 2

1.18.46.14 Tools/Demos
......................

   - bpo-26282(1): Argument Clinic now supports positional-only and
     keyword parameters in the same function.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26282


File: python.info,  Node: Python 3 6 0 alpha 1,  Next: Python 3 5 5 final,  Prev: Python 3 6 0 alpha 2,  Up: Changelog

1.18.47 Python 3.6.0 alpha 1
----------------------------

`Release date: 2016-05-16'

* Menu:

* Core and Builtins: Core and Builtins<39>.
* Library: Library<44>.
* Security: Security<21>.
* Library: Library<45>.
* Security: Security<22>.
* Library: Library<46>.
* Security: Security<23>.
* Library: Library<47>.
* IDLE: IDLE<33>.
* Documentation: Documentation<33>.
* Tests: Tests<35>.
* Build: Build<36>.
* Windows: Windows<34>.
* Tools/Demos: Tools/Demos<25>.
* C API: C API<27>.


File: python.info,  Node: Core and Builtins<39>,  Next: Library<44>,  Up: Python 3 6 0 alpha 1

1.18.47.1 Core and Builtins
...........................

   - bpo-20041(1): Fixed TypeError when frame.f_trace is set to None.
     Patch by Xavier de Gaye.

   - bpo-26168(2): Fixed possible refleaks in failing Py_BuildValue()
     with the “N” format unit.

   - bpo-26991(3): Fix possible refleak when creating a function with
     annotations.

   - bpo-27039(4): Fixed bytearray.remove() for values greater than 127.
     Based on patch by Joe Jevnik.

   - bpo-23640(5): int.from_bytes() no longer bypasses constructors for
     subclasses.

   - bpo-27005(6): Optimized the float.fromhex() class method for exact
     float.  It is now 2 times faster.

   - bpo-18531(7): Single var-keyword argument of dict subtype was
     passed unscathed to the C-defined function.  Now it is converted to
     exact dict.

   - bpo-26811(8): gc.get_objects() no longer contains a broken tuple
     with NULL pointer.

   - bpo-20120(9): Use RawConfigParser for .pypirc parsing, removing
     support for interpolation unintentionally added with move to Python
     3.  Behavior no longer does any interpolation in .pypirc files,
     matching behavior in Python 2.7 and Setuptools 19.0.

   - bpo-26249(10): Memory functions of the *note PyMem_Malloc(): 4fa.
     domain (*note PYMEM_DOMAIN_MEM: 4fe.) now use the *note pymalloc
     allocator: 5b6. rather than system ‘malloc()’.  Applications
     calling *note PyMem_Malloc(): 4fa. without holding the GIL can now
     crash: use ‘PYTHONMALLOC=debug’ environment variable to validate
     the usage of memory allocators in your application.

   - bpo-26802(11): Optimize function calls only using unpacking like
     ‘func(*tuple)’ (no other positional argument, no keyword): avoid
     copying the tuple.  Patch written by Joe Jevnik.

   - bpo-26659(12): Make the builtin slice type support cycle
     collection.

   - bpo-26718(13): super.__init__ no longer leaks memory if called
     multiple times.  NOTE: A direct call of super.__init__ is not
     endorsed!

   - bpo-27138(14): Fix the doc comment for FileFinder.find_spec().

   - bpo-27147(15): Mention PEP 420(16) in the importlib docs.

   - bpo-25339(17): PYTHONIOENCODING now has priority over locale in
     setting the error handler for stdin and stdout.

   - bpo-26494(18): Fixed crash on iterating exhausting iterators.
     Affected classes are generic sequence iterators, iterators of str,
     bytes, bytearray, list, tuple, set, frozenset, dict, OrderedDict,
     corresponding views and os.scandir() iterator.

   - bpo-26574(19): Optimize ‘bytes.replace(b'', b'.')’ and
     ‘bytearray.replace(b'', b'.')’.  Patch written by Josh Snider.

   - bpo-26581(20): If coding cookie is specified multiple times on a
     line in Python source code file, only the first one is taken to
     account.

   - bpo-19711(21): Add tests for reloading namespace packages.

   - bpo-21099(22): Switch applicable importlib tests to use PEP 451(23)
     API.

   - bpo-26563(24): Debug hooks on Python memory allocators now raise a
     fatal error if functions of the *note PyMem_Malloc(): 4fa. family
     are called without holding the GIL.

   - bpo-26564(25): On error, the debug hooks on Python memory
     allocators now use the *note tracemalloc: 114. module to get the
     traceback where a memory block was allocated.

   - bpo-26558(26): The debug hooks on Python memory allocator *note
     PyObject_Malloc(): 4fd. now detect when functions are called
     without holding the GIL.

   - bpo-26516(27): Add *note PYTHONMALLOC: 4f8. environment variable to
     set the Python memory allocators and/or install debug hooks.

   - bpo-26516(28): The *note PyMem_SetupDebugHooks(): 4ff. function can
     now also be used on Python compiled in release mode.

   - bpo-26516(29): The *note PYTHONMALLOCSTATS: 109b. environment
     variable can now also be used on Python compiled in release mode.
     It now has no effect if set to an empty string.

   - bpo-26516(30): In debug mode, debug hooks are now also installed on
     Python memory allocators when Python is configured without
     pymalloc.

   - bpo-26464(31): Fix str.translate() when string is ASCII and first
     replacements removes character, but next replacement uses a
     non-ASCII character or a string longer than 1 character.
     Regression introduced in Python 3.5.0.

   - bpo-22836(32): Ensure exception reports from PyErr_Display() and
     PyErr_WriteUnraisable() are sensible even when formatting them
     produces secondary errors.  This affects the reports produced by
     sys.__excepthook__() and when __del__() raises an exception.

   - bpo-26302(33): Correct behavior to reject comma as a legal
     character for cookie names.

   - bpo-26136(34): Upgrade the warning when a generator raises
     StopIteration from PendingDeprecationWarning to DeprecationWarning.
     Patch by Anish Shah.

   - bpo-26204(35): The compiler now ignores all constant statements:
     bytes, str, int, float, complex, name constants (None, False,
     True), Ellipsis and ast.Constant; not only str and int.  For
     example, ‘1.0’ is now ignored in ‘def f(): 1.0’.

   - bpo-4806(36): Avoid masking the original TypeError exception when
     using star (‘*’) unpacking in function calls.  Based on patch by
     Hagen Fürstenau and Daniel Urban.

   - bpo-26146(37): Add a new kind of AST node: ‘ast.Constant’.  It can
     be used by external AST optimizers, but the compiler does not emit
     directly such node.

   - bpo-23601(38): Sped-up allocation of dict key objects by using
     Python’s small object allocator.  (Contributed by Julian Taylor.)

   - bpo-18018(39): Import raises ImportError instead of SystemError if
     a relative import is attempted without a known parent package.

   - bpo-25843(40): When compiling code, don’t merge constants if they
     are equal but have a different types.  For example, ‘f1, f2 =
     lambda: 1, lambda: 1.0’ is now correctly compiled to two different
     functions: ‘f1()’ returns ‘1’ (‘int’) and ‘f2()’ returns ‘1.0’
     (‘float’), even if ‘1’ and ‘1.0’ are equal.

   - bpo-26107(41): The format of the ‘co_lnotab’ attribute of code
     objects changes to support negative line number delta.

   - bpo-26154(42): Add a new private _PyThreadState_UncheckedGet()
     function to get the current Python thread state, but don’t issue a
     fatal error if it is NULL. This new function must be used instead
     of accessing directly the _PyThreadState_Current variable.  The
     variable is no more exposed since Python 3.5.1 to hide the exact
     implementation of atomic C types, to avoid compiler issues.

   - bpo-25791(43): If __package__ != __spec__.parent or if neither
     __package__ or __spec__ are defined then ImportWarning is raised.

   - bpo-22995(44): [UPDATE] Comment out the one of the pickleability
     tests in _PyObject_GetState() due to regressions observed in
     Cython-based projects.

   - bpo-25961(45): Disallowed null characters in the type name.

   - bpo-25973(46): Fix segfault when an invalid nonlocal statement
     binds a name starting with two underscores.

   - bpo-22995(47): Instances of extension types with a state that
     aren’t subclasses of list or dict and haven’t implemented any
     pickle-related methods (__reduce__, __reduce_ex__, __getnewargs__,
     __getnewargs_ex__, or __getstate__), can no longer be pickled.
     Including memoryview.

   - bpo-20440(48): Massive replacing unsafe attribute setting code with
     special macro Py_SETREF.

   - bpo-25766(49): Special method __bytes__() now works in str
     subclasses.

   - bpo-25421(50): __sizeof__ methods of builtin types now use dynamic
     basic size.  This allows sys.getsize() to work correctly with their
     subclasses with __slots__ defined.

   - bpo-25709(51): Fixed problem with in-place string concatenation and
     utf-8 cache.

   - bpo-5319(52): New Py_FinalizeEx() API allowing Python to set an
     exit status of 120 on failure to flush buffered streams.

   - bpo-25485(53): telnetlib.Telnet is now a context manager.

   - bpo-24097(54): Fixed crash in object.__reduce__() if slot name is
     freed inside __getattr__.

   - bpo-24731(55): Fixed crash on converting objects with special
     methods __bytes__, __trunc__, and __float__ returning instances of
     subclasses of bytes, int, and float to subclasses of bytes, int,
     and float correspondingly.

   - bpo-25630(56): Fix a possible segfault during argument parsing in
     functions that accept filesystem paths.

   - bpo-23564(57): Fixed a partially broken sanity check in the
     _posixsubprocess internals regarding how fds_to_pass were passed to
     the child.  The bug had no actual impact as subprocess.py already
     avoided it.

   - bpo-25388(58): Fixed tokenizer crash when processing undecodable
     source code with a null byte.

   - bpo-25462(59): The hash of the key now is calculated only once in
     most operations in C implementation of OrderedDict.

   - bpo-22995(60): Default implementation of __reduce__ and
     __reduce_ex__ now rejects builtin types with not defined __new__.

   - bpo-24802(61): Avoid buffer overreads when int(), float(),
     compile(), exec() and eval() are passed bytes-like objects.  These
     objects are not necessarily terminated by a null byte, but the
     functions assumed they were.

   - bpo-25555(62): Fix parser and AST: fill lineno and col_offset of
     “arg” node when compiling AST from Python objects.

   - bpo-24726(63): Fixed a crash and leaking NULL in repr() of
     OrderedDict that was mutated by direct calls of dict methods.

   - bpo-25449(64): Iterating OrderedDict with keys with unstable hash
     now raises KeyError in C implementations as well as in Python
     implementation.

   - bpo-25395(65): Fixed crash when highly nested OrderedDict
     structures were garbage collected.

   - bpo-25401(66): Optimize bytes.fromhex() and bytearray.fromhex():
     they are now between 2x and 3.5x faster.

   - bpo-25399(67): Optimize bytearray % args using the new private
     _PyBytesWriter API. Formatting is now between 2.5 and 5 times
     faster.

   - bpo-25274(68): sys.setrecursionlimit() now raises a RecursionError
     if the new recursion limit is too low depending at the current
     recursion depth.  Modify also the “lower-water mark” formula to
     make it monotonic.  This mark is used to decide when the overflowed
     flag of the thread state is reset.

   - bpo-24402(69): Fix input() to prompt to the redirected stdout when
     sys.stdout.fileno() fails.

   - bpo-25349(70): Optimize bytes % args using the new private
     _PyBytesWriter API. Formatting is now up to 2 times faster.

   - bpo-24806(71): Prevent builtin types that are not allowed to be
     subclassed from being subclassed through multiple inheritance.

   - bpo-25301(72): The UTF-8 decoder is now up to 15 times as fast for
     error handlers: ‘ignore’, ‘replace’ and ‘surrogateescape’.

   - bpo-24848(73): Fixed a number of bugs in UTF-7 decoding of
     misformed data.

   - bpo-25267(74): The UTF-8 encoder is now up to 75 times as fast for
     error handlers: ‘ignore’, ‘replace’, ‘surrogateescape’,
     ‘surrogatepass’.  Patch co-written with Serhiy Storchaka.

   - bpo-25280(75): Import trace messages emitted in verbose (-v) mode
     are no longer formatted twice.

   - bpo-25227(76): Optimize ASCII and latin1 encoders with the
     ‘surrogateescape’ error handler: the encoders are now up to 3 times
     as fast.  Initial patch written by Serhiy Storchaka.

   - bpo-25003(77): On Solaris 11.3 or newer, os.urandom() now uses the
     getrandom() function instead of the getentropy() function.  The
     getentropy() function is blocking to generate very good quality
     entropy, os.urandom() doesn’t need such high-quality entropy.

   - bpo-9232(78): Modify Python’s grammar to allow trailing commas in
     the argument list of a function declaration.  For example, “def
     f(*, a = 3,): pass” is now legal.  Patch from Mark Dickinson.

   - bpo-24965(79): Implement PEP 498(80) “Literal String
     Interpolation”.  This allows you to embed expressions inside
     f-strings, which are converted to normal strings at run time.
     Given x=3, then f’value={x}’ == ‘value=3’.  Patch by Eric V. Smith.

   - bpo-26478(81): Fix semantic bugs when using binary operators with
     dictionary views and tuples.

   - bpo-26171(82): Fix possible integer overflow and heap corruption in
     zipimporter.get_data().

   - bpo-25660(83): Fix TAB key behaviour in REPL with readline.

   - bpo-26288(84): Optimize PyLong_AsDouble.

   - bpo-26289(85): Optimize floor and modulo division for single-digit
     longs.  Microbenchmarks show 2-2.5x improvement.  Built-in ‘divmod’
     function is now also ~10% faster.  (See also: bpo-26315(86))

   - bpo-25887(87): Raise a RuntimeError when a coroutine object is
     awaited more than once.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20041

   (2) https://bugs.python.org/issue26168

   (3) https://bugs.python.org/issue26991

   (4) https://bugs.python.org/issue27039

   (5) https://bugs.python.org/issue23640

   (6) https://bugs.python.org/issue27005

   (7) https://bugs.python.org/issue18531

   (8) https://bugs.python.org/issue26811

   (9) https://bugs.python.org/issue20120

   (10) https://bugs.python.org/issue26249

   (11) https://bugs.python.org/issue26802

   (12) https://bugs.python.org/issue26659

   (13) https://bugs.python.org/issue26718

   (14) https://bugs.python.org/issue27138

   (15) https://bugs.python.org/issue27147

   (16) https://www.python.org/dev/peps/pep-0420

   (17) https://bugs.python.org/issue25339

   (18) https://bugs.python.org/issue26494

   (19) https://bugs.python.org/issue26574

   (20) https://bugs.python.org/issue26581

   (21) https://bugs.python.org/issue19711

   (22) https://bugs.python.org/issue21099

   (23) https://www.python.org/dev/peps/pep-0451

   (24) https://bugs.python.org/issue26563

   (25) https://bugs.python.org/issue26564

   (26) https://bugs.python.org/issue26558

   (27) https://bugs.python.org/issue26516

   (28) https://bugs.python.org/issue26516

   (29) https://bugs.python.org/issue26516

   (30) https://bugs.python.org/issue26516

   (31) https://bugs.python.org/issue26464

   (32) https://bugs.python.org/issue22836

   (33) https://bugs.python.org/issue26302

   (34) https://bugs.python.org/issue26136

   (35) https://bugs.python.org/issue26204

   (36) https://bugs.python.org/issue4806

   (37) https://bugs.python.org/issue26146

   (38) https://bugs.python.org/issue23601

   (39) https://bugs.python.org/issue18018

   (40) https://bugs.python.org/issue25843

   (41) https://bugs.python.org/issue26107

   (42) https://bugs.python.org/issue26154

   (43) https://bugs.python.org/issue25791

   (44) https://bugs.python.org/issue22995

   (45) https://bugs.python.org/issue25961

   (46) https://bugs.python.org/issue25973

   (47) https://bugs.python.org/issue22995

   (48) https://bugs.python.org/issue20440

   (49) https://bugs.python.org/issue25766

   (50) https://bugs.python.org/issue25421

   (51) https://bugs.python.org/issue25709

   (52) https://bugs.python.org/issue5319

   (53) https://bugs.python.org/issue25485

   (54) https://bugs.python.org/issue24097

   (55) https://bugs.python.org/issue24731

   (56) https://bugs.python.org/issue25630

   (57) https://bugs.python.org/issue23564

   (58) https://bugs.python.org/issue25388

   (59) https://bugs.python.org/issue25462

   (60) https://bugs.python.org/issue22995

   (61) https://bugs.python.org/issue24802

   (62) https://bugs.python.org/issue25555

   (63) https://bugs.python.org/issue24726

   (64) https://bugs.python.org/issue25449

   (65) https://bugs.python.org/issue25395

   (66) https://bugs.python.org/issue25401

   (67) https://bugs.python.org/issue25399

   (68) https://bugs.python.org/issue25274

   (69) https://bugs.python.org/issue24402

   (70) https://bugs.python.org/issue25349

   (71) https://bugs.python.org/issue24806

   (72) https://bugs.python.org/issue25301

   (73) https://bugs.python.org/issue24848

   (74) https://bugs.python.org/issue25267

   (75) https://bugs.python.org/issue25280

   (76) https://bugs.python.org/issue25227

   (77) https://bugs.python.org/issue25003

   (78) https://bugs.python.org/issue9232

   (79) https://bugs.python.org/issue24965

   (80) https://www.python.org/dev/peps/pep-0498

   (81) https://bugs.python.org/issue26478

   (82) https://bugs.python.org/issue26171

   (83) https://bugs.python.org/issue25660

   (84) https://bugs.python.org/issue26288

   (85) https://bugs.python.org/issue26289

   (86) https://bugs.python.org/issue26315

   (87) https://bugs.python.org/issue25887


File: python.info,  Node: Library<44>,  Next: Security<21>,  Prev: Core and Builtins<39>,  Up: Python 3 6 0 alpha 1

1.18.47.2 Library
.................

   - bpo-27057(1): Fix os.set_inheritable() on Android, ioctl() is
     blocked by SELinux and fails with EACCESS. The function now falls
     back to fcntl().  Patch written by Michał Bednarski.

   - bpo-27014(2): Fix infinite recursion using typing.py.  Thanks to
     Kalle Tuure!

   - bpo-27031(3): Removed dummy methods in Tkinter widget classes:
     tk_menuBar() and tk_bindForTraversal().

   - bpo-14132(4): Fix urllib.request redirect handling when the target
     only has a query string.  Original fix by Ján Janech.

   - bpo-17214(5): The “urllib.request” module now percent-encodes
     non-ASCII bytes found in redirect target URLs.  Some servers send
     Location header fields with non-ASCII bytes, but “http.client”
     requires the request target to be ASCII-encodable, otherwise a
     UnicodeEncodeError is raised.  Based on patch by Christian Heimes.

   - bpo-27033(6): The default value of the decode_data parameter for
     smtpd.SMTPChannel and smtpd.SMTPServer constructors is changed to
     False.

   - bpo-27034(7): Removed deprecated class asynchat.fifo.

   - bpo-26870(8): Added readline.set_auto_history(), which can stop
     entries being automatically added to the history list.  Based on
     patch by Tyler Crompton.

   - bpo-26039(9): zipfile.ZipFile.open() can now be used to write data
     into a ZIP file, as well as for extracting data.  Patch by Thomas
     Kluyver.

   - bpo-26892(10): Honor debuglevel flag in urllib.request.HTTPHandler.
     Patch contributed by Chi Hsuan Yen.

   - bpo-22274(11): In the subprocess module, allow stderr to be
     redirected to stdout even when stdout is not redirected.  Patch by
     Akira Li.

   - bpo-26807(12): mock_open ‘files’ no longer error on readline at end
     of file.  Patch from Yolanda Robla.

   - bpo-25745(13): Fixed leaking a userptr in curses panel destructor.

   - bpo-26977(14): Removed unnecessary, and ignored, call to sum of
     squares helper in statistics.pvariance.

   - bpo-26002(15): Use bisect in statistics.median instead of a linear
     search.  Patch by Upendra Kuma.

   - bpo-25974(16): Make use of new Decimal.as_integer_ratio() method in
     statistics module.  Patch by Stefan Krah.

   - bpo-26996(17): Add secrets module as described in PEP 506(18).

   - bpo-26881(19): The modulefinder module now supports extended opcode
     arguments.

   - bpo-23815(20): Fixed crashes related to directly created instances
     of types in _tkinter and curses.panel modules.

   - bpo-17765(21): weakref.ref() no longer silently ignores keyword
     arguments.  Patch by Georg Brandl.

   - bpo-26873(22): xmlrpc now raises ResponseError on unsupported type
     tags instead of silently return incorrect result.

   - bpo-26915(23): The __contains__ methods in the collections ABCs now
     check for identity before checking equality.  This better matches
     the behavior of the concrete classes, allows sensible handling of
     NaNs, and makes it easier to reason about container invariants.

   - bpo-26711(24): Fixed the comparison of plistlib.Data with other
     types.

   - bpo-24114(25): Fix an uninitialized variable in ‘ctypes.util’.  The
     bug only occurs on SunOS when the ctypes implementation searches
     for the ‘crle’ program.  Patch by Xiang Zhang.  Tested on SunOS by
     Kees Bos.

   - bpo-26864(26): In urllib.request, change the proxy bypass host
     checking against no_proxy to be case-insensitive, and to not match
     unrelated host names that happen to have a bypassed hostname as a
     suffix.  Patch by Xiang Zhang.

   - bpo-24902(27): Print server URL on http.server startup.  Initial
     patch by Felix Kaiser.

   - bpo-25788(28): fileinput.hook_encoded() now supports an “errors”
     argument for passing to open.  Original patch by Joseph Hackman.

   - bpo-26634(29): recursive_repr() now sets __qualname__ of wrapper.
     Patch by Xiang Zhang.

   - bpo-26804(30): urllib.request will prefer lower_case proxy
     environment variables over UPPER_CASE or Mixed_Case ones.  Patch
     contributed by Hans-Peter Jansen.

   - bpo-26837(31): assertSequenceEqual() now correctly outputs
     non-stringified differing items (like bytes in the -b mode).  This
     affects assertListEqual() and assertTupleEqual().

   - bpo-26041(32): Remove “will be removed in Python 3.7” from
     deprecation messages of platform.dist() and
     platform.linux_distribution().  Patch by Kumaripaba Miyurusara
     Athukorala.

   - bpo-26822(33): itemgetter, attrgetter and methodcaller objects no
     longer silently ignore keyword arguments.

   - bpo-26733(34): Disassembling a class now disassembles class and
     static methods.  Patch by Xiang Zhang.

   - bpo-26801(35): Fix error handling in *note
     shutil.get_terminal_size(): a3f, catch *note AttributeError: 390.
     instead of *note NameError: d6e.  Patch written by Emanuel Barry.

   - bpo-24838(36): tarfile’s ustar and gnu formats now correctly
     calculate name and link field limits for multibyte character
     encodings like utf-8.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27057

   (2) https://bugs.python.org/issue27014

   (3) https://bugs.python.org/issue27031

   (4) https://bugs.python.org/issue14132

   (5) https://bugs.python.org/issue17214

   (6) https://bugs.python.org/issue27033

   (7) https://bugs.python.org/issue27034

   (8) https://bugs.python.org/issue26870

   (9) https://bugs.python.org/issue26039

   (10) https://bugs.python.org/issue26892

   (11) https://bugs.python.org/issue22274

   (12) https://bugs.python.org/issue26807

   (13) https://bugs.python.org/issue25745

   (14) https://bugs.python.org/issue26977

   (15) https://bugs.python.org/issue26002

   (16) https://bugs.python.org/issue25974

   (17) https://bugs.python.org/issue26996

   (18) https://www.python.org/dev/peps/pep-0506

   (19) https://bugs.python.org/issue26881

   (20) https://bugs.python.org/issue23815

   (21) https://bugs.python.org/issue17765

   (22) https://bugs.python.org/issue26873

   (23) https://bugs.python.org/issue26915

   (24) https://bugs.python.org/issue26711

   (25) https://bugs.python.org/issue24114

   (26) https://bugs.python.org/issue26864

   (27) https://bugs.python.org/issue24902

   (28) https://bugs.python.org/issue25788

   (29) https://bugs.python.org/issue26634

   (30) https://bugs.python.org/issue26804

   (31) https://bugs.python.org/issue26837

   (32) https://bugs.python.org/issue26041

   (33) https://bugs.python.org/issue26822

   (34) https://bugs.python.org/issue26733

   (35) https://bugs.python.org/issue26801

   (36) https://bugs.python.org/issue24838


File: python.info,  Node: Security<21>,  Next: Library<45>,  Prev: Library<44>,  Up: Python 3 6 0 alpha 1

1.18.47.3 Security
..................

   - bpo-26657(1): Fix directory traversal vulnerability with
     http.server on Windows.  This fixes a regression that was
     introduced in 3.3.4rc1 and 3.4.0rc1.  Based on patch by Philipp
     Hagemeister.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26657


File: python.info,  Node: Library<45>,  Next: Security<22>,  Prev: Security<21>,  Up: Python 3 6 0 alpha 1

1.18.47.4 Library
.................

   - bpo-26717(1): Stop encoding Latin-1-ized WSGI paths with UTF-8.
     Patch by Anthony Sottile.

   - bpo-26782(2): Add STARTUPINFO to subprocess.__all__ on Windows.

   - bpo-26404(3): Add context manager to socketserver.  Patch by Aviv
     Palivoda.

   - bpo-26735(4): Fix *note os.urandom(): 4c6. on Solaris 11.3 and
     newer when reading more than 1,024 bytes: call ‘getrandom()’
     multiple times with a limit of 1024 bytes per call.

   - bpo-26585(5): Eliminate http.server._quote_html() and use
     html.escape(quote=False).  Patch by Xiang Zhang.

   - bpo-26685(6): Raise OSError if closing a socket fails.

   - bpo-16329(7): Add .webm to mimetypes.types_map.  Patch by Giampaolo
     Rodola’.

   - bpo-13952(8): Add .csv to mimetypes.types_map.  Patch by Geoff
     Wilson.

   - bpo-26587(9): the site module now allows .pth files to specify
     files to be added to sys.path (e.g.  zip files).

   - bpo-25609(10): Introduce contextlib.AbstractContextManager and
     typing.ContextManager.

   - bpo-26709(11): Fixed Y2038 problem in loading binary PLists.

   - bpo-23735(12): Handle terminal resizing with Readline 6.3+ by
     installing our own SIGWINCH handler.  Patch by Eric Price.

   - bpo-25951(13): Change SSLSocket.sendall() to return None, as
     explicitly documented for plain socket objects.  Patch by Aviv
     Palivoda.

   - bpo-26586(14): In http.server, respond with “413 Request header
     fields too large” if there are too many header fields to parse,
     rather than killing the connection and raising an unhandled
     exception.  Patch by Xiang Zhang.

   - bpo-26676(15): Added missing XMLPullParser to ElementTree.__all__.

   - bpo-22854(16): Change BufferedReader.writable() and
     BufferedWriter.readable() to always return False.

   - bpo-26492(17): Exhausted iterator of array.array now conforms with
     the behavior of iterators of other mutable sequences: it lefts
     exhausted even if iterated array is extended.

   - bpo-26641(18): doctest.DocFileTest and doctest.testfile() now
     support packages (module splitted into multiple directories) for
     the package parameter.

   - bpo-25195(19): Fix a regression in mock.MagicMock.  _Call is a
     subclass of tuple (changeset 3603bae63c13 only works for classes)
     so we need to implement __ne__ ourselves.  Patch by Andrew Plummer.

   - bpo-26644(20): Raise ValueError rather than SystemError when a
     negative length is passed to SSLSocket.recv() or read().

   - bpo-23804(21): Fix SSL recv(0) and read(0) methods to return zero
     bytes instead of up to 1024.

   - bpo-26616(22): Fixed a bug in datetime.astimezone() method.

   - bpo-26637(23): The *note importlib: 9b. module now emits an *note
     ImportError: 329. rather than a *note TypeError: 192. if *note
     __import__(): 605. is tried during the Python shutdown process but
     *note sys.path: 47d. is already cleared (set to ‘None’).

   - bpo-21925(24): *note warnings.formatwarning(): f26. now catches
     exceptions when calling *note linecache.getline(): 6fd. and *note
     tracemalloc.get_object_traceback(): 109f. to be able to log *note
     ResourceWarning: 4c5. emitted late during the Python shutdown
     process.

   - bpo-23848(25): On Windows, faulthandler.enable() now also installs
     an exception handler to dump the traceback of all Python threads on
     any Windows exception, not only on UNIX signals (SIGSEGV, SIGFPE,
     SIGABRT).

   - bpo-26530(26): Add C functions ‘_PyTraceMalloc_Track()’ and
     ‘_PyTraceMalloc_Untrack()’ to track memory blocks using the *note
     tracemalloc: 114. module.  Add ‘_PyTraceMalloc_GetTraceback()’ to
     get the traceback of an object.

   - bpo-26588(27): The _tracemalloc now supports tracing memory
     allocations of multiple address spaces (domains).

   - bpo-24266(28): Ctrl+C during Readline history search now cancels
     the search mode when compiled with Readline 7.

   - bpo-26590(29): Implement a safe finalizer for the _socket.socket
     type.  It now releases the GIL to close the socket.

   - bpo-18787(30): spwd.getspnam() now raises a PermissionError if the
     user doesn’t have privileges.

   - bpo-26560(31): Avoid potential ValueError in
     BaseHandler.start_response.  Initial patch by Peter Inglesby.

   - bpo-26567(32): Add a new function *note PyErr_ResourceWarning():
     5c1. function to pass the destroyed object.  Add a `source'
     attribute to ‘warnings.WarningMessage’.  Add
     warnings._showwarnmsg() which uses tracemalloc to get the traceback
     where source object was allocated.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26717

   (2) https://bugs.python.org/issue26782

   (3) https://bugs.python.org/issue26404

   (4) https://bugs.python.org/issue26735

   (5) https://bugs.python.org/issue26585

   (6) https://bugs.python.org/issue26685

   (7) https://bugs.python.org/issue16329

   (8) https://bugs.python.org/issue13952

   (9) https://bugs.python.org/issue26587

   (10) https://bugs.python.org/issue25609

   (11) https://bugs.python.org/issue26709

   (12) https://bugs.python.org/issue23735

   (13) https://bugs.python.org/issue25951

   (14) https://bugs.python.org/issue26586

   (15) https://bugs.python.org/issue26676

   (16) https://bugs.python.org/issue22854

   (17) https://bugs.python.org/issue26492

   (18) https://bugs.python.org/issue26641

   (19) https://bugs.python.org/issue25195

   (20) https://bugs.python.org/issue26644

   (21) https://bugs.python.org/issue23804

   (22) https://bugs.python.org/issue26616

   (23) https://bugs.python.org/issue26637

   (24) https://bugs.python.org/issue21925

   (25) https://bugs.python.org/issue23848

   (26) https://bugs.python.org/issue26530

   (27) https://bugs.python.org/issue26588

   (28) https://bugs.python.org/issue24266

   (29) https://bugs.python.org/issue26590

   (30) https://bugs.python.org/issue18787

   (31) https://bugs.python.org/issue26560

   (32) https://bugs.python.org/issue26567


File: python.info,  Node: Security<22>,  Next: Library<46>,  Prev: Library<45>,  Up: Python 3 6 0 alpha 1

1.18.47.5 Security
..................

   - bpo-26313(1): ssl.py _load_windows_store_certs fails if windows
     cert store is empty.  Patch by Baji.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26313


File: python.info,  Node: Library<46>,  Next: Security<23>,  Prev: Security<22>,  Up: Python 3 6 0 alpha 1

1.18.47.6 Library
.................

   - bpo-26569(1): Fix *note pyclbr.readmodule(): 10a2. and *note
     pyclbr.readmodule_ex(): 10a3. to support importing packages.

   - bpo-26499(2): Account for remaining Content-Length in
     HTTPResponse.readline() and read1().  Based on patch by Silent
     Ghost.  Also document that HTTPResponse now supports these methods.

   - bpo-25320(3): Handle sockets in directories unittest discovery is
     scanning.  Patch from Victor van den Elzen.

   - bpo-16181(4): cookiejar.http2time() now returns None if year is
     higher than datetime.MAXYEAR.

   - bpo-26513(5): Fixes platform module detection of Windows Server

   - bpo-23718(6): Fixed parsing time in week 0 before Jan 1.  Original
     patch by Tamás Bence Gedai.

   - bpo-26323(7): Add Mock.assert_called() and
     Mock.assert_called_once() methods to unittest.mock.  Patch written
     by Amit Saha.

   - bpo-20589(8): Invoking Path.owner() and Path.group() on Windows now
     raise NotImplementedError instead of ImportError.

   - bpo-26177(9): Fixed the keys() method for Canvas and Scrollbar
     widgets.

   - bpo-15068(10): Got rid of excessive buffering in fileinput.  The
     bufsize parameter is now deprecated and ignored.

   - bpo-19475(11): Added an optional argument timespec to the datetime
     isoformat() method to choose the precision of the time component.

   - bpo-2202(12): Fix UnboundLocalError in
     AbstractDigestAuthHandler.get_algorithm_impls.  Initial patch by
     Mathieu Dupuy.

   - bpo-26167(13): Minimized overhead in copy.copy() and
     copy.deepcopy().  Optimized copying and deepcopying bytearrays,
     NotImplemented, slices, short lists, tuples, dicts, sets.

   - bpo-25718(14): Fixed pickling and copying the accumulate() iterator
     with total is None.

   - bpo-26475(15): Fixed debugging output for regular expressions with
     the (?x) flag.

   - bpo-26482(16): Allowed pickling recursive dequeues.

   - bpo-26335(17): Make mmap.write() return the number of bytes written
     like other write methods.  Patch by Jakub Stasiak.

   - bpo-26457(18): Fixed the subnets() methods in IP network classes
     for the case when resulting prefix length is equal to maximal
     prefix length.  Based on patch by Xiang Zhang.

   - bpo-26385(19): Remove the file if the internal open() call in
     NamedTemporaryFile() fails.  Patch by Silent Ghost.

   - bpo-26402(20): Fix XML-RPC client to retry when the server shuts
     down a persistent connection.  This was a regression related to the
     new http.client.RemoteDisconnected exception in 3.5.0a4.

   - bpo-25913(21): Leading ‘<~’ is optional now in base64.a85decode()
     with adobe=True.  Patch by Swati Jaiswal.

   - bpo-26186(22): Remove an invalid type check in
     importlib.util.LazyLoader.

   - bpo-26367(23): importlib.__import__() raises ImportError like
     builtins.__import__() when ‘level’ is specified but without an
     accompanying package specified.

   - bpo-26309(24): In the “socketserver” module, shut down the request
     (closing the connected socket) when verify_request() returns false.
     Patch by Aviv Palivoda.

   - bpo-23430(25): Change the socketserver module to only catch
     exceptions raised from a request handler that are derived from
     Exception (instead of BaseException).  Therefore SystemExit and
     KeyboardInterrupt no longer trigger the handle_error() method, and
     will now to stop a single-threaded server.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26569

   (2) https://bugs.python.org/issue26499

   (3) https://bugs.python.org/issue25320

   (4) https://bugs.python.org/issue16181

   (5) https://bugs.python.org/issue26513

   (6) https://bugs.python.org/issue23718

   (7) https://bugs.python.org/issue26323

   (8) https://bugs.python.org/issue20589

   (9) https://bugs.python.org/issue26177

   (10) https://bugs.python.org/issue15068

   (11) https://bugs.python.org/issue19475

   (12) https://bugs.python.org/issue2202

   (13) https://bugs.python.org/issue26167

   (14) https://bugs.python.org/issue25718

   (15) https://bugs.python.org/issue26475

   (16) https://bugs.python.org/issue26482

   (17) https://bugs.python.org/issue26335

   (18) https://bugs.python.org/issue26457

   (19) https://bugs.python.org/issue26385

   (20) https://bugs.python.org/issue26402

   (21) https://bugs.python.org/issue25913

   (22) https://bugs.python.org/issue26186

   (23) https://bugs.python.org/issue26367

   (24) https://bugs.python.org/issue26309

   (25) https://bugs.python.org/issue23430


File: python.info,  Node: Security<23>,  Next: Library<47>,  Prev: Library<46>,  Up: Python 3 6 0 alpha 1

1.18.47.7 Security
..................

   - bpo-25939(1): On Windows open the cert store readonly in
     ssl.enum_certificates.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25939


File: python.info,  Node: Library<47>,  Next: IDLE<33>,  Prev: Security<23>,  Up: Python 3 6 0 alpha 1

1.18.47.8 Library
.................

   - bpo-25995(1): os.walk() no longer uses FDs proportional to the tree
     depth.

   - bpo-25994(2): Added the close() method and the support of the
     context manager protocol for the os.scandir() iterator.

   - bpo-23992(3): multiprocessing: make MapResult not fail-fast upon
     exception.

   - bpo-26243(4): Support keyword arguments to zlib.compress().  Patch
     by Aviv Palivoda.

   - bpo-26117(5): The os.scandir() iterator now closes file descriptor
     not only when the iteration is finished, but when it was failed
     with error.

   - bpo-25949(6): __dict__ for an OrderedDict instance is now created
     only when needed.

   - bpo-25911(7): Restored support of bytes paths in os.walk() on
     Windows.

   - bpo-26045(8): Add UTF-8 suggestion to error message when posting a
     non-Latin-1 string with http.client.

   - bpo-26039(9): Added zipfile.ZipInfo.from_file() and
     zipinfo.ZipInfo.is_dir().  Patch by Thomas Kluyver.

   - bpo-12923(10): Reset FancyURLopener’s redirect counter even if
     there is an exception.  Based on patches by Brian Brazil and Daniel
     Rocco.

   - bpo-25945(11): Fixed a crash when unpickle the functools.partial
     object with wrong state.  Fixed a leak in failed functools.partial
     constructor.  “args” and “keywords” attributes of functools.partial
     have now always types tuple and dict correspondingly.

   - bpo-26202(12): copy.deepcopy() now correctly copies range() objects
     with non-atomic attributes.

   - bpo-23076(13): Path.glob() now raises a ValueError if it’s called
     with an invalid pattern.  Patch by Thomas Nyberg.

   - bpo-19883(14): Fixed possible integer overflows in zipimport.

   - bpo-26227(15): On Windows, getnameinfo(), gethostbyaddr() and
     gethostbyname_ex() functions of the socket module now decode the
     hostname from the ANSI code page rather than UTF-8.

   - bpo-26099(16): The site module now writes an error into stderr if
     sitecustomize module can be imported but executing the module raise
     an ImportError.  Same change for usercustomize.

   - bpo-26147(17): xmlrpc now works with strings not encodable with
     used non-UTF-8 encoding.

   - bpo-25935(18): Garbage collector now breaks reference loops with
     OrderedDict.

   - bpo-16620(19): Fixed AttributeError in msilib.Directory.glob().

   - bpo-26013(20): Added compatibility with broken protocol 2 pickles
     created in old Python 3 versions (3.4.3 and lower).

   - bpo-26129(21): Deprecated accepting non-integers in grp.getgrgid().

   - bpo-25850(22): Use cross-compilation by default for 64-bit Windows.

   - bpo-25822(23): Add docstrings to the fields of urllib.parse
     results.  Patch contributed by Swati Jaiswal.

   - bpo-22642(24): Convert trace module option parsing mechanism to
     argparse.  Patch contributed by SilentGhost.

   - bpo-24705(25): Fix sysconfig._parse_makefile not expanding ${} vars
     appearing before $() vars.

   - bpo-26069(26): Remove the deprecated apis in the trace module.

   - bpo-22138(27): Fix mock.patch behavior when patching descriptors.
     Restore original values after patching.  Patch contributed by Sean
     McCully.

   - bpo-25672(28): In the ssl module, enable the
     SSL_MODE_RELEASE_BUFFERS mode option if it is safe to do so.

   - bpo-26012(29): Don’t traverse into symlinks for ‘**’ pattern in
     pathlib.Path.[r]glob().

   - bpo-24120(30): Ignore PermissionError when traversing a tree with
     pathlib.Path.[r]glob().  Patch by Ulrich Petri.

   - bpo-21815(31): Accept ] characters in the data portion of imap
     responses, in order to handle the flags with square brackets
     accepted and produced by servers such as gmail.

   - bpo-25447(32): fileinput now uses sys.stdin as-is if it does not
     have a buffer attribute (restores backward compatibility).

   - bpo-25971(33): Optimized creating Fractions from floats by 2 times
     and from Decimals by 3 times.

   - bpo-25802(34): Document as deprecated the remaining implementations
     of importlib.abc.Loader.load_module().

   - bpo-25928(35): Add Decimal.as_integer_ratio().

   - bpo-25447(36): Copying the lru_cache() wrapper object now always
     works, independently from the type of the wrapped object (by
     returning the original object unchanged).

   - bpo-25768(37): Have the functions in compileall return booleans
     instead of ints and add proper documentation and tests for the
     return values.

   - bpo-24103(38): Fixed possible use after free in
     ElementTree.XMLPullParser.

   - bpo-25860(39): os.fwalk() no longer skips remaining directories
     when error occurs.  Original patch by Samson Lee.

   - bpo-25914(40): Fixed and simplified OrderedDict.__sizeof__.

   - bpo-25869(41): Optimized deepcopying ElementTree; it is now 20
     times faster.

   - bpo-25873(42): Optimized iterating ElementTree.  Iterating elements
     Element.iter() is now 40% faster, iterating text Element.itertext()
     is now up to 2.5 times faster.

   - bpo-25902(43): Fixed various refcount issues in ElementTree
     iteration.

   - bpo-22227(44): The TarFile iterator is reimplemented using
     generator.  This implementation is simpler that using class.

   - bpo-25638(45): Optimized ElementTree.iterparse(); it is now 2x
     faster.  Optimized ElementTree parsing; it is now 10% faster.

   - bpo-25761(46): Improved detecting errors in broken pickle data.

   - bpo-25717(47): Restore the previous behaviour of tolerating most
     fstat() errors when opening files.  This was a regression in 3.5a1,
     and stopped anonymous temporary files from working in special
     cases.

   - bpo-24903(48): Fix regression in number of arguments compileall
     accepts when ‘-d’ is specified.  The check on the number of
     arguments has been dropped completely as it never worked correctly
     anyway.

   - bpo-25764(49): In the subprocess module, preserve any exception
     caused by fork() failure when preexec_fn is used.

   - bpo-25771(50): Tweak the exception message for
     importlib.util.resolve_name() when ‘package’ isn’t specified but
     necessary.

   - bpo-6478(51): _strptime’s regexp cache now is reset after changing
     timezone with time.tzset().

   - bpo-14285(52): When executing a package with the “python -m
     package” option, and package initialization fails, a proper
     traceback is now reported.  The “runpy” module now lets exceptions
     from package initialization pass back to the caller, rather than
     raising ImportError.

   - bpo-19771(53): Also in runpy and the “-m” option, omit the
     irrelevant message “… is a package and cannot be directly executed”
     if the package could not even be initialized (e.g.  due to a bad
     ‘*.pyc’ file).

   - bpo-25177(54): Fixed problem with the mean of very small and very
     large numbers.  As a side effect, statistics.mean and
     statistics.variance should be significantly faster.

   - bpo-25718(55): Fixed copying object with state with boolean value
     is false.

   - bpo-10131(56): Fixed deep copying of minidom documents.  Based on
     patch by Marian Ganisin.

   - bpo-7990(57): dir() on ElementTree.Element now lists properties:
     “tag”, “text”, “tail” and “attrib”.  Original patch by Santoso
     Wijaya.

   - bpo-25725(58): Fixed a reference leak in pickle.loads() when
     unpickling invalid data including tuple instructions.

   - bpo-25663(59): In the Readline completer, avoid listing duplicate
     global names, and search the global namespace before searching
     builtins.

   - bpo-25688(60): Fixed file leak in ElementTree.iterparse() raising
     an error.

   - bpo-23914(61): Fixed SystemError raised by unpickler on broken
     pickle data.

   - bpo-25691(62): Fixed crash on deleting ElementTree.Element
     attributes.

   - bpo-25624(63): ZipFile now always writes a ZIP_STORED header for
     directory entries.  Patch by Dingyuan Wang.

   - bpo-25626(64): Change three zlib functions to accept sizes that fit
     in Py_ssize_t, but internally cap those sizes to UINT_MAX. This
     resolves a regression in 3.5 where GzipFile.read() failed to read
     chunks larger than 2 or 4 GiB. The change affects the
     zlib.Decompress.decompress() max_length parameter, the
     zlib.decompress() bufsize parameter, and the
     zlib.Decompress.flush() length parameter.

   - bpo-25583(65): Avoid incorrect errors raised by
     os.makedirs(exist_ok=True) when the OS gives priority to errors
     such as EACCES over EEXIST.

   - bpo-25593(66): Change semantics of EventLoop.stop() in asyncio.

   - bpo-6973(67): When we know a subprocess.Popen process has died, do
     not allow the send_signal(), terminate(), or kill() methods to do
     anything as they could potentially signal a different process.

   - bpo-23883(68): Added missing APIs to __all__ to match the
     documented APIs for the following modules: calendar, csv, enum,
     fileinput, ftplib, logging, optparse, tarfile, threading and wave.
     Also added a test.support.check__all__() helper.  Patches by Jacek
     Kołodziej, Mauro S. M. Rodrigues and Joel Taddei.

   - bpo-25590(69): In the Readline completer, only call getattr() once
     per attribute.  Also complete names of attributes such as
     properties and slots which are listed by dir() but not yet created
     on an instance.

   - bpo-25498(70): Fix a crash when garbage-collecting ctypes objects
     created by wrapping a memoryview.  This was a regression made in
     3.5a1.  Based on patch by Eryksun.

   - bpo-25584(71): Added “escape” to the __all__ list in the glob
     module.

   - bpo-25584(72): Fixed recursive glob() with patterns starting with
     ‘**’.

   - bpo-25446(73): Fix regression in smtplib’s AUTH LOGIN support.

   - bpo-18010(74): Fix the pydoc web server’s module search function to
     handle exceptions from importing packages.

   - bpo-25554(75): Got rid of circular references in regular expression
     parsing.

   - bpo-18973(76): Command-line interface of the calendar module now
     uses argparse instead of optparse.

   - bpo-25510(77): fileinput.FileInput.readline() now returns b’’
     instead of ‘’ at the end if the FileInput was opened with binary
     mode.  Patch by Ryosuke Ito.

   - bpo-25503(78): Fixed inspect.getdoc() for inherited docstrings of
     properties.  Original patch by John Mark Vandenberg.

   - bpo-25515(79): Always use os.urandom as a source of randomness in
     uuid.uuid4.

   - bpo-21827(80): Fixed textwrap.dedent() for the case when largest
     common whitespace is a substring of smallest leading whitespace.
     Based on patch by Robert Li.

   - bpo-25447(81): The lru_cache() wrapper objects now can be copied
     and pickled (by returning the original object unchanged).

   - bpo-25390(82): typing: Don’t crash on Union[str, Pattern].

   - bpo-25441(83): asyncio: Raise error from drain() when socket is
     closed.

   - bpo-25410(84): Cleaned up and fixed minor bugs in C implementation
     of OrderedDict.

   - bpo-25411(85): Improved Unicode support in SMTPHandler through
     better use of the email package.  Thanks to user simon04 for the
     patch.

   - Move the imp module from a PendingDeprecationWarning to
     DeprecationWarning.

   - bpo-25407(86): Remove mentions of the formatter module being
     removed in Python 3.6.

   - bpo-25406(87): Fixed a bug in C implementation of
     OrderedDict.move_to_end() that caused segmentation fault or hang in
     iterating after moving several items to the start of ordered dict.

   - bpo-25382(88): pickletools.dis() now outputs implicit memo index
     for the MEMOIZE opcode.

   - bpo-25357(89): Add an optional newline parameter to
     binascii.b2a_base64().  base64.b64encode() uses it to avoid a
     memory copy.

   - bpo-24164(90): Objects that need calling ‘__new__’ with keyword
     arguments, can now be pickled using pickle protocols older than
     protocol version 4.

   - bpo-25364(91): zipfile now works in threads disabled builds.

   - bpo-25328(92): smtpd’s SMTPChannel now correctly raises a
     ValueError if both decode_data and enable_SMTPUTF8 are set to true.

   - bpo-16099(93): RobotFileParser now supports Crawl-delay and
     Request-rate extensions.  Patch by Nikolay Bogoychev.

   - bpo-25316(94): distutils raises OSError instead of
     DistutilsPlatformError when MSVC is not installed.

   - bpo-25380(95): Fixed protocol for the STACK_GLOBAL opcode in
     pickletools.opcodes.

   - bpo-23972(96): Updates asyncio datagram create method allowing
     reuseport and reuseaddr socket options to be set prior to binding
     the socket.  Mirroring the existing asyncio create_server method
     the reuseaddr option for datagram sockets defaults to True if the
     O/S is ‘posix’ (except if the platform is Cygwin).  Patch by Chris
     Laws.

   - bpo-25304(97): Add asyncio.run_coroutine_threadsafe().  This lets
     you submit a coroutine to a loop from another thread, returning a
     concurrent.futures.Future.  By Vincent Michel.

   - bpo-25232(98): Fix CGIRequestHandler to split the query from the
     URL at the first question mark (?)  rather than the last.  Patch
     from Xiang Zhang.

   - bpo-24657(99): Prevent CGIRequestHandler from collapsing slashes in
     the query part of the URL as if it were a path.  Patch from Xiang
     Zhang.

   - bpo-25287(100): Don’t add crypt.METHOD_CRYPT to crypt.methods if
     it’s not supported.  Check if it is supported, it may not be
     supported on OpenBSD for example.

   - bpo-23600(101): Default implementation of tzinfo.fromutc() was
     returning wrong results in some cases.

   - bpo-25203(102): Failed readline.set_completer_delims() no longer
     left the module in inconsistent state.

   - bpo-25011(103): rlcompleter now omits private and special attribute
     names unless the prefix starts with underscores.

   - bpo-25209(104): rlcompleter now can add a space or a colon after
     completed keyword.

   - bpo-22241(105): timezone.utc name is now plain ‘UTC’, not
     ‘UTC-00:00’.

   - bpo-23517(106): fromtimestamp() and utcfromtimestamp() methods of
     datetime.datetime now round microseconds to nearest with ties going
     to nearest even integer (ROUND_HALF_EVEN), as round(float), instead
     of rounding towards -Infinity (ROUND_FLOOR).

   - bpo-23552(107): Timeit now warns when there is substantial (4x)
     variance between best and worst times.  Patch from Serhiy
     Storchaka.

   - bpo-24633(108): site-packages/README -> README.txt.

   - bpo-24879(109): help() and pydoc can now list named tuple fields in
     the order they were defined rather than alphabetically.  The
     ordering is determined by the _fields attribute if present.

   - bpo-24874(110): Improve speed of itertools.cycle() and make its
     pickle more compact.

   - Fix crash in itertools.cycle.__setstate__() when the first argument
     wasn’t a list.

   - bpo-20059(111): urllib.parse raises ValueError on all invalid
     ports.  Patch by Martin Panter.

   - bpo-24360(112): Improve __repr__ of argparse.Namespace() for
     invalid identifiers.  Patch by Matthias Bussonnier.

   - bpo-23426(113): run_setup was broken in distutils.  Patch from
     Alexander Belopolsky.

   - bpo-13938(114): 2to3 converts StringTypes to a tuple.  Patch from
     Mark Hammond.

   - bpo-2091(115): open() accepted a ‘U’ mode string containing ‘+’,
     but ‘U’ can only be used with ‘r’.  Patch from Jeff Balogh and John
     O’Connor.

   - bpo-8585(116): improved tests for zipimporter2.  Patch from Mark
     Lawrence.

   - bpo-18622(117): unittest.mock.mock_open().reset_mock would recurse
     infinitely.  Patch from Nicola Palumbo and Laurent De Buyst.

   - bpo-24426(118): Fast searching optimization in regular expressions
     now works for patterns that starts with capturing groups.  Fast
     searching optimization now can’t be disabled at compile time.

   - bpo-23661(119): unittest.mock side_effects can now be exceptions
     again.  This was a regression vs Python 3.4.  Patch from Ignacio
     Rossi

   - bpo-13248(120): Remove deprecated inspect.getmoduleinfo function.

   - bpo-25578(121): Fix (another) memory leak in
     SSLSocket.getpeercer().

   - bpo-25530(122): Disable the vulnerable SSLv3 protocol by default
     when creating ssl.SSLContext.

   - bpo-25569(123): Fix memory leak in SSLSocket.getpeercert().

   - bpo-25471(124): Sockets returned from accept() shouldn’t appear to
     be nonblocking.

   - bpo-25319(125): When threading.Event is reinitialized, the
     underlying condition should use a regular lock rather than a
     recursive lock.

   - Skip getaddrinfo if host is already resolved.  Patch by A. Jesse
     Jiryu Davis.

   - bpo-26050(126): Add asyncio.StreamReader.readuntil() method.  Patch
     by Марк Коренберг.

   - bpo-25924(127): Avoid unnecessary serialization of getaddrinfo(3)
     calls on OS X versions 10.5 or higher.  Original patch by A. Jesse
     Jiryu Davis.

   - bpo-26406(128): Avoid unnecessary serialization of getaddrinfo(3)
     calls on current versions of OpenBSD and NetBSD. Patch by A. Jesse
     Jiryu Davis.

   - bpo-26848(129): Fix asyncio/subprocess.communicate() to handle
     empty input.  Patch by Jack O’Connor.

   - bpo-27040(130): Add loop.get_exception_handler method

   - bpo-27041(131): asyncio: Add loop.create_future method

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25995

   (2) https://bugs.python.org/issue25994

   (3) https://bugs.python.org/issue23992

   (4) https://bugs.python.org/issue26243

   (5) https://bugs.python.org/issue26117

   (6) https://bugs.python.org/issue25949

   (7) https://bugs.python.org/issue25911

   (8) https://bugs.python.org/issue26045

   (9) https://bugs.python.org/issue26039

   (10) https://bugs.python.org/issue12923

   (11) https://bugs.python.org/issue25945

   (12) https://bugs.python.org/issue26202

   (13) https://bugs.python.org/issue23076

   (14) https://bugs.python.org/issue19883

   (15) https://bugs.python.org/issue26227

   (16) https://bugs.python.org/issue26099

   (17) https://bugs.python.org/issue26147

   (18) https://bugs.python.org/issue25935

   (19) https://bugs.python.org/issue16620

   (20) https://bugs.python.org/issue26013

   (21) https://bugs.python.org/issue26129

   (22) https://bugs.python.org/issue25850

   (23) https://bugs.python.org/issue25822

   (24) https://bugs.python.org/issue22642

   (25) https://bugs.python.org/issue24705

   (26) https://bugs.python.org/issue26069

   (27) https://bugs.python.org/issue22138

   (28) https://bugs.python.org/issue25672

   (29) https://bugs.python.org/issue26012

   (30) https://bugs.python.org/issue24120

   (31) https://bugs.python.org/issue21815

   (32) https://bugs.python.org/issue25447

   (33) https://bugs.python.org/issue25971

   (34) https://bugs.python.org/issue25802

   (35) https://bugs.python.org/issue25928

   (36) https://bugs.python.org/issue25447

   (37) https://bugs.python.org/issue25768

   (38) https://bugs.python.org/issue24103

   (39) https://bugs.python.org/issue25860

   (40) https://bugs.python.org/issue25914

   (41) https://bugs.python.org/issue25869

   (42) https://bugs.python.org/issue25873

   (43) https://bugs.python.org/issue25902

   (44) https://bugs.python.org/issue22227

   (45) https://bugs.python.org/issue25638

   (46) https://bugs.python.org/issue25761

   (47) https://bugs.python.org/issue25717

   (48) https://bugs.python.org/issue24903

   (49) https://bugs.python.org/issue25764

   (50) https://bugs.python.org/issue25771

   (51) https://bugs.python.org/issue6478

   (52) https://bugs.python.org/issue14285

   (53) https://bugs.python.org/issue19771

   (54) https://bugs.python.org/issue25177

   (55) https://bugs.python.org/issue25718

   (56) https://bugs.python.org/issue10131

   (57) https://bugs.python.org/issue7990

   (58) https://bugs.python.org/issue25725

   (59) https://bugs.python.org/issue25663

   (60) https://bugs.python.org/issue25688

   (61) https://bugs.python.org/issue23914

   (62) https://bugs.python.org/issue25691

   (63) https://bugs.python.org/issue25624

   (64) https://bugs.python.org/issue25626

   (65) https://bugs.python.org/issue25583

   (66) https://bugs.python.org/issue25593

   (67) https://bugs.python.org/issue6973

   (68) https://bugs.python.org/issue23883

   (69) https://bugs.python.org/issue25590

   (70) https://bugs.python.org/issue25498

   (71) https://bugs.python.org/issue25584

   (72) https://bugs.python.org/issue25584

   (73) https://bugs.python.org/issue25446

   (74) https://bugs.python.org/issue18010

   (75) https://bugs.python.org/issue25554

   (76) https://bugs.python.org/issue18973

   (77) https://bugs.python.org/issue25510

   (78) https://bugs.python.org/issue25503

   (79) https://bugs.python.org/issue25515

   (80) https://bugs.python.org/issue21827

   (81) https://bugs.python.org/issue25447

   (82) https://bugs.python.org/issue25390

   (83) https://bugs.python.org/issue25441

   (84) https://bugs.python.org/issue25410

   (85) https://bugs.python.org/issue25411

   (86) https://bugs.python.org/issue25407

   (87) https://bugs.python.org/issue25406

   (88) https://bugs.python.org/issue25382

   (89) https://bugs.python.org/issue25357

   (90) https://bugs.python.org/issue24164

   (91) https://bugs.python.org/issue25364

   (92) https://bugs.python.org/issue25328

   (93) https://bugs.python.org/issue16099

   (94) https://bugs.python.org/issue25316

   (95) https://bugs.python.org/issue25380

   (96) https://bugs.python.org/issue23972

   (97) https://bugs.python.org/issue25304

   (98) https://bugs.python.org/issue25232

   (99) https://bugs.python.org/issue24657

   (100) https://bugs.python.org/issue25287

   (101) https://bugs.python.org/issue23600

   (102) https://bugs.python.org/issue25203

   (103) https://bugs.python.org/issue25011

   (104) https://bugs.python.org/issue25209

   (105) https://bugs.python.org/issue22241

   (106) https://bugs.python.org/issue23517

   (107) https://bugs.python.org/issue23552

   (108) https://bugs.python.org/issue24633

   (109) https://bugs.python.org/issue24879

   (110) https://bugs.python.org/issue24874

   (111) https://bugs.python.org/issue20059

   (112) https://bugs.python.org/issue24360

   (113) https://bugs.python.org/issue23426

   (114) https://bugs.python.org/issue13938

   (115) https://bugs.python.org/issue2091

   (116) https://bugs.python.org/issue8585

   (117) https://bugs.python.org/issue18622

   (118) https://bugs.python.org/issue24426

   (119) https://bugs.python.org/issue23661

   (120) https://bugs.python.org/issue13248

   (121) https://bugs.python.org/issue25578

   (122) https://bugs.python.org/issue25530

   (123) https://bugs.python.org/issue25569

   (124) https://bugs.python.org/issue25471

   (125) https://bugs.python.org/issue25319

   (126) https://bugs.python.org/issue26050

   (127) https://bugs.python.org/issue25924

   (128) https://bugs.python.org/issue26406

   (129) https://bugs.python.org/issue26848

   (130) https://bugs.python.org/issue27040

   (131) https://bugs.python.org/issue27041


File: python.info,  Node: IDLE<33>,  Next: Documentation<33>,  Prev: Library<47>,  Up: Python 3 6 0 alpha 1

1.18.47.9 IDLE
..............

   - bpo-20640(1): Add tests for idlelib.configHelpSourceEdit.  Patch by
     Saimadhav Heblikar.

   - In the ‘IDLE-console differences’ section of the IDLE doc, clarify
     how running with IDLE affects sys.modules and the standard streams.

   - bpo-25507(2): fix incorrect change in IOBinding that prevented
     printing.  Augment IOBinding htest to include all major IOBinding
     functions.

   - bpo-25905(3): Revert unwanted conversion of ‘ to ’ RIGHT SINGLE
     QUOTATION MARK in README.txt and open this and NEWS.txt with
     ‘ascii’.  Re-encode CREDITS.txt to utf-8 and open it with ‘utf-8’.

   - bpo-15348(4): Stop the debugger engine (normally in a user process)
     before closing the debugger window (running in the IDLE process).
     This prevents the RuntimeErrors that were being caught and ignored.

   - bpo-24455(5): Prevent IDLE from hanging when a) closing the shell
     while the debugger is active (15347); b) closing the debugger with
     the [X] button (15348); and c) activating the debugger when already
     active (24455).  The patch by Mark Roseman does this by making two
     changes.  1.  Suspend and resume the gui.interaction method with
     the tcl vwait mechanism intended for this purpose (instead of
     root.mainloop & .quit).  2.  In gui.run, allow any existing
     interaction to terminate first.

   - Change ‘The program’ to ‘Your program’ in an IDLE ‘kill program?’
     message to make it clearer that the program referred to is the
     currently running user program, not IDLE itself.

   - bpo-24750(6): Improve the appearance of the IDLE editor window
     status bar.  Patch by Mark Roseman.

   - bpo-25313(7): Change the handling of new built-in text color themes
     to better address the compatibility problem introduced by the
     addition of IDLE Dark.  Consistently use the revised
     idleConf.CurrentTheme everywhere in idlelib.

   - bpo-24782(8): Extension configuration is now a tab in the IDLE
     Preferences dialog rather than a separate dialog.  The former tabs
     are now a sorted list.  Patch by Mark Roseman.

   - bpo-22726(9): Re-activate the config dialog help button with some
     content about the other buttons and the new IDLE Dark theme.

   - bpo-24820(10): IDLE now has an ‘IDLE Dark’ built-in text color
     theme.  It is more or less IDLE Classic inverted, with a cobalt
     blue background.  Strings, comments, keywords, … are still green,
     red, orange, … .  To use it with IDLEs released before November
     2015, hit the ‘Save as New Custom Theme’ button and enter a new
     name, such as ‘Custom Dark’.  The custom theme will work with any
     IDLE release, and can be modified.

   - bpo-25224(11): README.txt is now an idlelib index for IDLE
     developers and curious users.  The previous user content is now in
     the IDLE doc chapter.  ‘IDLE’ now means ‘Integrated Development and
     Learning Environment’.

   - bpo-24820(12): Users can now set breakpoint colors in Settings ->
     Custom Highlighting.  Original patch by Mark Roseman.

   - bpo-24972(13): Inactive selection background now matches active
     selection background, as configured by users, on all systems.
     Found items are now always highlighted on Windows.  Initial patch
     by Mark Roseman.

   - bpo-24570(14): Idle: make calltip and completion boxes appear on
     Macs affected by a tk regression.  Initial patch by Mark Roseman.

   - bpo-24988(15): Idle ScrolledList context menus (used in debugger)
     now work on Mac Aqua.  Patch by Mark Roseman.

   - bpo-24801(16): Make right-click for context menu work on Mac Aqua.
     Patch by Mark Roseman.

   - bpo-25173(17): Associate tkinter messageboxes with a specific
     widget.  For Mac OSX, make them a ‘sheet’.  Patch by Mark Roseman.

   - bpo-25198(18): Enhance the initial html viewer now used for Idle
     Help.  Properly indent fixed-pitch text (patch by Mark Roseman).
     Give code snippet a very Sphinx-like light blueish-gray background.
     Re-use initial width and height set by users for shell and editor.
     When the Table of Contents (TOC) menu is used, put the section
     header at the top of the screen.

   - bpo-25225(19): Condense and rewrite Idle doc section on text
     colors.

   - bpo-21995(20): Explain some differences between IDLE and console
     Python.

   - bpo-22820(21): Explain need for `print' when running file from Idle
     editor.

   - bpo-25224(22): Doc: augment Idle feature list and no-subprocess
     section.

   - bpo-25219(23): Update doc for Idle command line options.  Some were
     missing and notes were not correct.

   - bpo-24861(24): Most of idlelib is private and subject to change.
     Use idleib.idle.* to start Idle.  See idlelib.__init__.__doc__.

   - bpo-25199(25): Idle: add synchronization comments for future
     maintainers.

   - bpo-16893(26): Replace help.txt with help.html for Idle doc
     display.  The new idlelib/help.html is rstripped
     Doc/build/html/library/idle.html.  It looks better than help.txt
     and will better document Idle as released.  The tkinter html viewer
     that works for this file was written by Rose Roseman.  The now
     unused EditorWindow.HelpDialog class and helt.txt file are
     deprecated.

   - bpo-24199(27): Deprecate unused idlelib.idlever with possible
     removal in 3.6.

   - bpo-24790(28): Remove extraneous code (which also create 2 & 3
     conflicts).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20640

   (2) https://bugs.python.org/issue25507

   (3) https://bugs.python.org/issue25905

   (4) https://bugs.python.org/issue15348

   (5) https://bugs.python.org/issue24455

   (6) https://bugs.python.org/issue24750

   (7) https://bugs.python.org/issue25313

   (8) https://bugs.python.org/issue24782

   (9) https://bugs.python.org/issue22726

   (10) https://bugs.python.org/issue24820

   (11) https://bugs.python.org/issue25224

   (12) https://bugs.python.org/issue24820

   (13) https://bugs.python.org/issue24972

   (14) https://bugs.python.org/issue24570

   (15) https://bugs.python.org/issue24988

   (16) https://bugs.python.org/issue24801

   (17) https://bugs.python.org/issue25173

   (18) https://bugs.python.org/issue25198

   (19) https://bugs.python.org/issue25225

   (20) https://bugs.python.org/issue21995

   (21) https://bugs.python.org/issue22820

   (22) https://bugs.python.org/issue25224

   (23) https://bugs.python.org/issue25219

   (24) https://bugs.python.org/issue24861

   (25) https://bugs.python.org/issue25199

   (26) https://bugs.python.org/issue16893

   (27) https://bugs.python.org/issue24199

   (28) https://bugs.python.org/issue24790


File: python.info,  Node: Documentation<33>,  Next: Tests<35>,  Prev: IDLE<33>,  Up: Python 3 6 0 alpha 1

1.18.47.10 Documentation
........................

   - bpo-26736(1): Used HTTPS for external links in the documentation if
     possible.

   - bpo-6953(2): Rework the Readline module documentation to group
     related functions together, and add more details such as what
     underlying Readline functions and variables are accessed.

   - bpo-23606(3): Adds note to ctypes documentation regarding
     cdll.msvcrt.

   - bpo-24952(4): Clarify the default size argument of stack_size() in
     the “threading” and “_thread” modules.  Patch from Mattip.

   - bpo-26014(5): Update 3.x packaging documentation: * “See also”
     links to the new docs are now provided in the legacy pages * links
     to setuptools documentation have been updated

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26736

   (2) https://bugs.python.org/issue6953

   (3) https://bugs.python.org/issue23606

   (4) https://bugs.python.org/issue24952

   (5) https://bugs.python.org/issue26014


File: python.info,  Node: Tests<35>,  Next: Build<36>,  Prev: Documentation<33>,  Up: Python 3 6 0 alpha 1

1.18.47.11 Tests
................

   - bpo-21916(1): Added tests for the turtle module.  Patch by ingrid,
     Gregory Loyse and Jelle Zijlstra.

   - bpo-26295(2): When using “python3 -m test –testdir=TESTDIR”,
     regrtest doesn’t add “test.” prefix to test module names.

   - bpo-26523(3): The multiprocessing thread pool
     (multiprocessing.dummy.Pool) was untested.

   - bpo-26015(4): Added new tests for pickling iterators of mutable
     sequences.

   - bpo-26325(5): Added test.support.check_no_resource_warning() to
     check that no ResourceWarning is emitted.

   - bpo-25940(6): Changed test_ssl to use its internal local server
     more.  This avoids relying on svn.python.org, which recently
     changed root certificate.

   - bpo-25616(7): Tests for OrderedDict are extracted from
     test_collections into separate file test_ordered_dict.

   - bpo-25449(8): Added tests for OrderedDict subclasses.

   - bpo-25188(9): Add -P/–pgo to test.regrtest to suppress error output
     when running the test suite for the purposes of a PGO build.
     Initial patch by Alecsandru Patrascu.

   - bpo-22806(10): Add ‘python -m test --list-tests’ command to list
     tests.

   - bpo-18174(11): ‘python -m test --huntrleaks ...’ now also checks
     for leak of file descriptors.  Patch written by Richard Oudkerk.

   - bpo-25260(12): Fix ‘python -m test --coverage’ on Windows.  Remove
     the list of ignored directories.

   - ‘PCbuild\rt.bat’ now accepts an unlimited number of arguments to
     pass along to regrtest.py.  Previously there was a limit of 9.

   - bpo-26583(13): Skip test_timestamp_overflow in test_import if
     bytecode files cannot be written.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21916

   (2) https://bugs.python.org/issue26295

   (3) https://bugs.python.org/issue26523

   (4) https://bugs.python.org/issue26015

   (5) https://bugs.python.org/issue26325

   (6) https://bugs.python.org/issue25940

   (7) https://bugs.python.org/issue25616

   (8) https://bugs.python.org/issue25449

   (9) https://bugs.python.org/issue25188

   (10) https://bugs.python.org/issue22806

   (11) https://bugs.python.org/issue18174

   (12) https://bugs.python.org/issue25260

   (13) https://bugs.python.org/issue26583


File: python.info,  Node: Build<36>,  Next: Windows<34>,  Prev: Tests<35>,  Up: Python 3 6 0 alpha 1

1.18.47.12 Build
................

   - bpo-21277(1): Don’t try to link _ctypes with a ffi_convenience
     library.

   - bpo-26884(2): Fix linking extension modules for cross builds.
     Patch by Xavier de Gaye.

   - bpo-26932(3): Fixed support of RTLD_* constants defined as enum
     values, not via macros (in particular on Android).  Patch by Chi
     Hsuan Yen.

   - bpo-22359(4): Disable the rules for running _freeze_importlib and
     pgen when cross-compiling.  The output of these programs is
     normally saved with the source code anyway, and is still
     regenerated when doing a native build.  Patch by Xavier de Gaye.

   - bpo-21668(5): Link audioop, _datetime, _ctypes_test modules to
     libm, except on Mac OS X. Patch written by Chi Hsuan Yen.

   - bpo-25702(6): A –with-lto configure option has been added that will
     enable link time optimizations at build time during a make
     profile-opt.  Some compilers and toolchains are known to not
     produce stable code when using LTO, be sure to test things
     thoroughly before relying on it.  It can provide a few % speed up
     over profile-opt alone.

   - bpo-26624(7): Adds validation of ucrtbase[d].dll version with
     warning for old versions.

   - bpo-17603(8): Avoid error about nonexistent fileblocks.o file by
     using a lower-level check for st_blocks in struct stat.

   - bpo-26079(9): Fixing the build output folder for tix-8.4.3.6.
     Patch by Bjoern Thiel.

   - bpo-26465(10): Update Windows builds to use OpenSSL 1.0.2g.

   - bpo-25348(11): Added ‘--pgo’ and ‘--pgo-job’ arguments to
     ‘PCbuild\build.bat’ for building with Profile-Guided Optimization.
     The old ‘PCbuild\build_pgo.bat’ script is removed.

   - bpo-25827(12): Add support for building with ICC to ‘configure’,
     including a new ‘--with-icc’ flag.

   - bpo-25696(13): Fix installation of Python on UNIX with make -j9.

   - bpo-24986(14): It is now possible to build Python on Windows
     without errors when external libraries are not available.

   - bpo-24421(15): Compile Modules/_math.c once, before building
     extensions.  Previously it could fail to compile properly if the
     math and cmath builds were concurrent.

   - bpo-26465(16): Update OS X 10.5+ 32-bit-only installer to build and
     link with OpenSSL 1.0.2g.

   - bpo-26268(17): Update Windows builds to use OpenSSL 1.0.2f.

   - bpo-25136(18): Support Apple Xcode 7’s new textual SDK stub
     libraries.

   - bpo-24324(19): Do not enable unreachable code warnings when using
     gcc as the option does not work correctly in older versions of gcc
     and has been silently removed as of gcc-4.5.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21277

   (2) https://bugs.python.org/issue26884

   (3) https://bugs.python.org/issue26932

   (4) https://bugs.python.org/issue22359

   (5) https://bugs.python.org/issue21668

   (6) https://bugs.python.org/issue25702

   (7) https://bugs.python.org/issue26624

   (8) https://bugs.python.org/issue17603

   (9) https://bugs.python.org/issue26079

   (10) https://bugs.python.org/issue26465

   (11) https://bugs.python.org/issue25348

   (12) https://bugs.python.org/issue25827

   (13) https://bugs.python.org/issue25696

   (14) https://bugs.python.org/issue24986

   (15) https://bugs.python.org/issue24421

   (16) https://bugs.python.org/issue26465

   (17) https://bugs.python.org/issue26268

   (18) https://bugs.python.org/issue25136

   (19) https://bugs.python.org/issue24324


File: python.info,  Node: Windows<34>,  Next: Tools/Demos<25>,  Prev: Build<36>,  Up: Python 3 6 0 alpha 1

1.18.47.13 Windows
..................

   - bpo-27053(1): Updates make_zip.py to correctly generate library ZIP
     file.

   - bpo-26268(2): Update the prepare_ssl.py script to handle OpenSSL
     releases that don’t include the contents of the include directory
     (that is, 1.0.2e and later).

   - bpo-26071(3): bdist_wininst created binaries fail to start and find
     32bit Python

   - bpo-26073(4): Update the list of magic numbers in launcher

   - bpo-26065(5): Excludes venv from library when generating embeddable
     distro.

   - bpo-25022(6): Removed very outdated PC/example_nt/ directory.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27053

   (2) https://bugs.python.org/issue26268

   (3) https://bugs.python.org/issue26071

   (4) https://bugs.python.org/issue26073

   (5) https://bugs.python.org/issue26065

   (6) https://bugs.python.org/issue25022


File: python.info,  Node: Tools/Demos<25>,  Next: C API<27>,  Prev: Windows<34>,  Up: Python 3 6 0 alpha 1

1.18.47.14 Tools/Demos
......................

   - bpo-26799(1): Fix python-gdb.py: don’t get C types once when the
     Python code is loaded, but get C types on demand.  The C types can
     change if python-gdb.py is loaded before the Python executable.
     Patch written by Thomas Ilsche.

   - bpo-26271(2): Fix the Freeze tool to properly use flags passed
     through configure.  Patch by Daniel Shaulov.

   - bpo-26489(3): Add dictionary unpacking support to
     Tools/parser/unparse.py.  Patch by Guo Ci Teo.

   - bpo-26316(4): Fix variable name typo in Argument Clinic.

   - bpo-25440(5): Fix output of python-config –extension-suffix.

   - bpo-25154(6): The pyvenv script has been deprecated in favour of
     ‘python3 -m venv’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26799

   (2) https://bugs.python.org/issue26271

   (3) https://bugs.python.org/issue26489

   (4) https://bugs.python.org/issue26316

   (5) https://bugs.python.org/issue25440

   (6) https://bugs.python.org/issue25154


File: python.info,  Node: C API<27>,  Prev: Tools/Demos<25>,  Up: Python 3 6 0 alpha 1

1.18.47.15 C API
................

   - bpo-26312(1): SystemError is now raised in all programming bugs
     with using PyArg_ParseTupleAndKeywords().  RuntimeError did raised
     before in some programming bugs.

   - bpo-26198(2): ValueError is now raised instead of TypeError on
     buffer overflow in parsing “es#” and “et#” format units.
     SystemError is now raised instead of TypeError on programmatical
     error in parsing format string.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26312

   (2) https://bugs.python.org/issue26198


File: python.info,  Node: Python 3 5 5 final,  Next: Python 3 5 5 release candidate 1,  Prev: Python 3 6 0 alpha 1,  Up: Changelog

1.18.48 Python 3.5.5 final
--------------------------

`Release date: 2018-02-04'

There were no new changes in version 3.5.5.


File: python.info,  Node: Python 3 5 5 release candidate 1,  Next: Python 3 5 4 final,  Prev: Python 3 5 5 final,  Up: Changelog

1.18.49 Python 3.5.5 release candidate 1
----------------------------------------

`Release date: 2018-01-23'

* Menu:

* Security: Security<24>.
* Core and Builtins: Core and Builtins<40>.
* Library: Library<48>.


File: python.info,  Node: Security<24>,  Next: Core and Builtins<40>,  Up: Python 3 5 5 release candidate 1

1.18.49.1 Security
..................

   - bpo-32551(1): The ‘sys.path[0]’ initialization change for
     bpo-29139(2) caused a regression by revealing an inconsistency in
     how sys.path is initialized when executing ‘__main__’ from a
     zipfile, directory, or other import location.  This is considered a
     potential security issue, as it may lead to privileged processes
     unexpectedly loading code from user controlled directories in
     situations where that was not previously the case.  The interpreter
     now consistently avoids ever adding the import location’s parent
     directory to ‘sys.path’, and ensures no other ‘sys.path’ entries
     are inadvertently modified when inserting the import location named
     on the command line.  (Originally reported as bpo-29723(3) against
     Python 3.6rc1, but it was missed at the time that the then upcoming
     Python 3.5.4 release would also be affected)

   - bpo-30657(4): Fixed possible integer overflow in
     PyBytes_DecodeEscape, CVE-2017-1000158.  Original patch by Jay
     Bosamiya; rebased to Python 3 by Miro Hrončok.

   - bpo-30947(5): Upgrade libexpat embedded copy from version 2.2.1 to
     2.2.3 to get security fixes.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32551

   (2) https://bugs.python.org/issue29139

   (3) https://bugs.python.org/issue29723

   (4) https://bugs.python.org/issue30657

   (5) https://bugs.python.org/issue30947


File: python.info,  Node: Core and Builtins<40>,  Next: Library<48>,  Prev: Security<24>,  Up: Python 3 5 5 release candidate 1

1.18.49.2 Core and Builtins
...........................

   - bpo-31095(1): Fix potential crash during GC caused by ‘tp_dealloc’
     which doesn’t call ‘PyObject_GC_UnTrack()’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue31095


File: python.info,  Node: Library<48>,  Prev: Core and Builtins<40>,  Up: Python 3 5 5 release candidate 1

1.18.49.3 Library
.................

   - bpo-32072(1): Fixed issues with binary plists: Fixed saving
     bytearrays.  Identical objects will be saved only once.  Equal
     references will be load as identical objects.  Added support for
     saving and loading recursive data structures.

   - bpo-31170(2): expat: Update libexpat from 2.2.3 to 2.2.4.  Fix
     copying of partial characters for UTF-8 input (libexpat bug 115):
     ‘https://github.com/libexpat/libexpat/issues/115’

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue32072

   (2) https://bugs.python.org/issue31170


File: python.info,  Node: Python 3 5 4 final,  Next: Python 3 5 4 release candidate 1,  Prev: Python 3 5 5 release candidate 1,  Up: Changelog

1.18.50 Python 3.5.4 final
--------------------------

`Release date: 2017-08-07'

* Menu:

* Library: Library<49>.


File: python.info,  Node: Library<49>,  Up: Python 3 5 4 final

1.18.50.1 Library
.................

   - bpo-30119(1): ftplib.FTP.putline() now throws ValueError on
     commands that contains CR or LF. Patch by Dong-hee Na.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30119


File: python.info,  Node: Python 3 5 4 release candidate 1,  Next: Python 3 5 3 final,  Prev: Python 3 5 4 final,  Up: Changelog

1.18.51 Python 3.5.4 release candidate 1
----------------------------------------

`Release date: 2017-07-23'

* Menu:

* Security: Security<25>.
* Core and Builtins: Core and Builtins<41>.
* Library: Library<50>.
* Documentation: Documentation<34>.
* Tests: Tests<36>.
* Build: Build<37>.
* Windows: Windows<35>.
* C API: C API<28>.


File: python.info,  Node: Security<25>,  Next: Core and Builtins<41>,  Up: Python 3 5 4 release candidate 1

1.18.51.1 Security
..................

   - bpo-30730(1): Prevent environment variables injection in subprocess
     on Windows.  Prevent passing other environment variables and
     command arguments.

   - bpo-30694(2): Upgrade expat copy from 2.2.0 to 2.2.1 to get fixes
     of multiple security vulnerabilities including: CVE-2017-9233
     (External entity infinite loop DoS), CVE-2016-9063 (Integer
     overflow, re-fix), CVE-2016-0718 (Fix regression bugs from 2.2.0’s
     fix to CVE-2016-0718) and CVE-2012-0876 (Counter hash flooding with
     SipHash).  Note: the CVE-2016-5300 (Use os-specific entropy sources
     like getrandom) doesn’t impact Python, since Python already gets
     entropy from the OS to set the expat secret using
     ‘XML_SetHashSalt()’.

   - bpo-30500(3): Fix urllib.parse.splithost() to correctly parse
     fragments.  For example, ‘splithost('//127.0.0.1#@evil.com/')’ now
     correctly returns the ‘127.0.0.1’ host, instead of treating
     ‘@evil.com’ as the host in an authentication (‘login@host’).

   - bpo-29591(4): Update expat copy from 2.1.1 to 2.2.0 to get fixes of
     CVE-2016-0718 and CVE-2016-4472.  See
     ‘https://sourceforge.net/p/expat/bugs/537/’ for more information.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30730

   (2) https://bugs.python.org/issue30694

   (3) https://bugs.python.org/issue30500

   (4) https://bugs.python.org/issue29591


File: python.info,  Node: Core and Builtins<41>,  Next: Library<50>,  Prev: Security<25>,  Up: Python 3 5 4 release candidate 1

1.18.51.2 Core and Builtins
...........................

   - bpo-30876(1): Relative import from unloaded package now reimports
     the package instead of failing with SystemError.  Relative import
     from non-package now fails with ImportError rather than
     SystemError.

   - bpo-30765(2): Avoid blocking in pthread_mutex_lock() when
     PyThread_acquire_lock() is asked not to block.

   - bpo-27945(3): Fixed various segfaults with dict when input
     collections are mutated during searching, inserting or comparing.
     Based on patches by Duane Griffin and Tim Mitchell.

   - bpo-25794(4): Fixed type.__setattr__() and type.__delattr__() for
     non-interned attribute names.  Based on patch by Eryk Sun.

   - bpo-29935(5): Fixed error messages in the index() method of tuple,
     list and deque when pass indices of wrong type.

   - bpo-28876(6): ‘bool(range)’ works even if ‘len(range)’ raises *note
     OverflowError: 954.

   - bpo-29600(7): Fix wrapping coroutine return values in
     StopIteration.

   - bpo-29537(8): Restore runtime compatibility with bytecode files
     generated by CPython 3.5.0 to 3.5.2, and adjust the eval loop to
     avoid the problems that could be caused by the malformed variant of
     the BUILD_MAP_UNPACK_WITH_CALL opcode that they may contain.  Patch
     by Petr Viktorin, Serhiy Storchaka, and Nick Coghlan.

   - bpo-28598(9): Support __rmod__ for subclasses of str being called
     before str.__mod__.  Patch by Martijn Pieters.

   - bpo-29602(10): Fix incorrect handling of signed zeros in complex
     constructor for complex subclasses and for inputs having a
     __complex__ method.  Patch by Serhiy Storchaka.

   - bpo-29347(11): Fixed possibly dereferencing undefined pointers when
     creating weakref objects.

   - bpo-29438(12): Fixed use-after-free problem in key sharing dict.

   - bpo-29319(13): Prevent RunMainFromImporter overwriting sys.path[0].

   - bpo-29337(14): Fixed possible BytesWarning when compare the code
     objects.  Warnings could be emitted at compile time.

   - bpo-29478(15): If max_line_length=None is specified while using the
     Compat32 policy, it is no longer ignored.  Patch by Mircea Cosbuc.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30876

   (2) https://bugs.python.org/issue30765

   (3) https://bugs.python.org/issue27945

   (4) https://bugs.python.org/issue25794

   (5) https://bugs.python.org/issue29935

   (6) https://bugs.python.org/issue28876

   (7) https://bugs.python.org/issue29600

   (8) https://bugs.python.org/issue29537

   (9) https://bugs.python.org/issue28598

   (10) https://bugs.python.org/issue29602

   (11) https://bugs.python.org/issue29347

   (12) https://bugs.python.org/issue29438

   (13) https://bugs.python.org/issue29319

   (14) https://bugs.python.org/issue29337

   (15) https://bugs.python.org/issue29478


File: python.info,  Node: Library<50>,  Next: Documentation<34>,  Prev: Core and Builtins<41>,  Up: Python 3 5 4 release candidate 1

1.18.51.3 Library
.................

   - bpo-29403(1): Fix ‘unittest.mock’’s autospec to not fail on
     method-bound builtin functions.  Patch by Aaron Gallagher.

   - bpo-30961(2): Fix decrementing a borrowed reference in tracemalloc.

   - bpo-30886(3): Fix multiprocessing.Queue.join_thread(): it now waits
     until the thread completes, even if the thread was started by the
     same process which created the queue.

   - bpo-29854(4): Fix segfault in readline when using readline’s
     history-size option.  Patch by Nir Soffer.

   - bpo-30807(5): signal.setitimer() may disable the timer when passed
     a tiny value.  Tiny values (such as 1e-6) are valid non-zero values
     for setitimer(), which is specified as taking
     microsecond-resolution intervals.  However, on some platform, our
     conversion routine could convert 1e-6 into a zero interval,
     therefore disabling the timer instead of (re-)scheduling it.

   - bpo-30441(6): Fix bug when modifying os.environ while iterating
     over it

   - bpo-30532(7): Fix email header value parser dropping folding white
     space in certain cases.

   - bpo-29169(8): Update zlib to 1.2.11.

   - bpo-30879(9): os.listdir() and os.scandir() now emit bytes names
     when called with bytes-like argument.

   - bpo-30746(10): Prohibited the ‘=’ character in environment variable
     names in ‘os.putenv()’ and ‘os.spawn*()’.

   - bpo-29755(11): Fixed the lgettext() family of functions in the
     gettext module.  They now always return bytes.

   - bpo-30645(12): Fix path calculation in imp.load_package(), fixing
     it for cases when a package is only shipped with bytecodes.  Patch
     by Alexandru Ardelean.

   - bpo-23890(13): unittest.TestCase.assertRaises() now manually breaks
     a reference cycle to not keep objects alive longer than expected.

   - bpo-30149(14): inspect.signature() now supports callables with
     variable-argument parameters wrapped with partialmethod.  Patch by
     Dong-hee Na.

   - bpo-29931(15): Fixed comparison check for ipaddress.ip_interface
     objects.  Patch by Sanjay Sundaresan.

   - bpo-24484(16): Avoid race condition in multiprocessing cleanup.

   - bpo-28994(17): The traceback no longer displayed for SystemExit
     raised in a callback registered by atexit.

   - bpo-30508(18): Don’t log exceptions if Task/Future “cancel()”
     method was called.

   - bpo-28556(19): Updates to typing module: Add generic
     AsyncContextManager, add support for ContextManager on all
     versions.  Original PRs by Jelle Zijlstra and Ivan Levkivskyi

   - bpo-29870(20): Fix ssl sockets leaks when connection is aborted in
     asyncio/ssl implementation.  Patch by Michaël Sghaïer.

   - bpo-29743(21): Closing transport during handshake process leaks
     open socket.  Patch by Nikolay Kim

   - bpo-27585(22): Fix waiter cancellation in asyncio.Lock.  Patch by
     Mathieu Sornay.

   - bpo-30418(23): On Windows, subprocess.Popen.communicate() now also
     ignore EINVAL on stdin.write() if the child process is still
     running but closed the pipe.

   - bpo-30378(24): Fix the problem that logging.handlers.SysLogHandler
     cannot handle IPv6 addresses.

   - bpo-29960(25): Preserve generator state when
     _random.Random.setstate() raises an exception.  Patch by Bryan
     Olson.

   - bpo-30414(26): multiprocessing.Queue._feed background running
     thread do not break from main loop on exception.

   - bpo-30003(27): Fix handling escape characters in HZ codec.  Based
     on patch by Ma Lin.

   - bpo-30301(28): Fix AttributeError when using SimpleQueue.empty()
     under `spawn' and `forkserver' start methods.

   - bpo-30329(29): imaplib and poplib now catch the Windows socket
     WSAEINVAL error (code 10022) on shutdown(SHUT_RDWR): An invalid
     operation was attempted.  This error occurs sometimes on SSL
     connections.

   - bpo-30375(30): Warnings emitted when compile a regular expression
     now always point to the line in the user code.  Previously they
     could point into inners of the re module if emitted from inside of
     groups or conditionals.

   - bpo-30048(31): Fixed ‘Task.cancel()’ can be ignored when the task
     is running coroutine and the coroutine returned without any more
     ‘await’.

   - bpo-29990(32): Fix range checking in GB18030 decoder.  Original
     patch by Ma Lin.

   - bpo-26293(33): Change resulted because of zipfile breakage.  (See
     also: bpo-29094(34))

   - bpo-30243(35): Removed the __init__ methods of _json’s scanner and
     encoder.  Misusing them could cause memory leaks or crashes.  Now
     scanner and encoder objects are completely initialized in the
     __new__ methods.

   - bpo-30185(36): Avoid KeyboardInterrupt tracebacks in forkserver
     helper process when Ctrl-C is received.

   - bpo-28556(37): Various updates to typing module: add
     typing.NoReturn type, use WrapperDescriptorType, minor bug-fixes.
     Original PRs by Jim Fasarakis-Hilliard and Ivan Levkivskyi.

   - bpo-30205(38): Fix getsockname() for unbound AF_UNIX sockets on
     Linux.

   - bpo-30070(39): Fixed leaks and crashes in errors handling in the
     parser module.

   - bpo-30061(40): Fixed crashes in IOBase methods __next__() and
     readlines() when readline() or __next__() respectively return
     non-sizeable object.  Fixed possible other errors caused by not
     checking results of PyObject_Size(), PySequence_Size(), or
     PyMapping_Size().

   - bpo-30068(41): _io._IOBase.readlines will check if it’s closed
     first when hint is present.

   - bpo-29694(42): Fixed race condition in pathlib mkdir with flags
     parents=True.  Patch by Armin Rigo.

   - bpo-29692(43): Fixed arbitrary unchaining of RuntimeError
     exceptions in contextlib.contextmanager.  Patch by Siddharth
     Velankar.

   - bpo-29998(44): Pickling and copying ImportError now preserves name
     and path attributes.

   - bpo-29942(45): Fix a crash in itertools.chain.from_iterable when
     encountering long runs of empty iterables.

   - bpo-27863(46): Fixed multiple crashes in ElementTree caused by race
     conditions and wrong types.

   - bpo-28699(47): Fixed a bug in pools in multiprocessing.pool that
     raising an exception at the very first of an iterable may swallow
     the exception or make the program hang.  Patch by Davin Potts and
     Xiang Zhang.

   - bpo-25803(48): Avoid incorrect errors raised by
     Path.mkdir(exist_ok=True) when the OS gives priority to errors such
     as EACCES over EEXIST.

   - bpo-29861(49): Release references to tasks, their arguments and
     their results as soon as they are finished in multiprocessing.Pool.

   - bpo-29884(50): faulthandler: Restore the old sigaltstack during
     teardown.  Patch by Christophe Zeitouny.

   - bpo-25455(51): Fixed crashes in repr of recursive buffered
     file-like objects.

   - bpo-29800(52): Fix crashes in partial.__repr__ if the keys of
     partial.keywords are not strings.  Patch by Michael Seifert.

   - bpo-29742(53): get_extra_info() raises exception if get called on
     closed ssl transport.  Patch by Nikolay Kim.

   - bpo-8256(54): Fixed possible failing or crashing input() if
     attributes “encoding” or “errors” of sys.stdin or sys.stdout are
     not set or are not strings.

   - bpo-28298(55): Fix a bug that prevented array ‘Q’, ‘L’ and ‘I’ from
     accepting big intables (objects that have __int__) as elements.
     Patch by Oren Milman.

   - bpo-29615(56): SimpleXMLRPCDispatcher no longer chains KeyError (or
     any other exception) to exception(s) raised in the dispatched
     methods.  Patch by Petr Motejlek.

   - bpo-29704(57): asyncio.subprocess.SubprocessStreamProtocol no
     longer closes before all pipes are closed.

   - bpo-29703(58): Fix asyncio to support instantiation of new event
     loops in child processes.

   - bpo-29376(59): Fix assertion error in
     threading._DummyThread.is_alive().

   - bpo-29110(60): Fix file object leak in aifc.open() when file is
     given as a filesystem path and is not in valid AIFF format.  Patch
     by Anthony Zhang.

   - bpo-28961(61): Fix unittest.mock._Call helper: don’t ignore the
     name parameter anymore.  Patch written by Jiajun Huang.

   - bpo-29532(62): Altering a kwarg dictionary passed to
     functools.partial() no longer affects a partial object after
     creation.

   - bpo-28556(63): Various updates to typing module: typing.Counter,
     typing.ChainMap, improved ABC caching, etc.  Original PRs by Jelle
     Zijlstra, Ivan Levkivskyi, Manuel Krebber, and Łukasz Langa.

   - bpo-29100(64): Fix datetime.fromtimestamp() regression introduced
     in Python 3.6.0: check minimum and maximum years.

   - bpo-29519(65): Fix weakref spewing exceptions during interpreter
     shutdown when used with a rare combination of multiprocessing and
     custom codecs.

   - bpo-29416(66): Prevent infinite loop in pathlib.Path.mkdir

   - bpo-29444(67): Fixed out-of-bounds buffer access in the group()
     method of the match object.  Based on patch by WGH.

   - bpo-29335(68): Fix subprocess.Popen.wait() when the child process
     has exited to a stopped instead of terminated state (ex: when under
     ptrace).

   - bpo-29290(69): Fix a regression in argparse that help messages
     would wrap at non-breaking spaces.

   - bpo-28735(70): Fixed the comparison of mock.MagickMock with
     mock.ANY.

   - bpo-29011(71): Fix an important omission by adding Deque to the
     typing module.

   - bpo-29219(72): Fixed infinite recursion in the repr of
     uninitialized ctypes.CDLL instances.

   - bpo-28969(73): Fixed race condition in C implementation of
     functools.lru_cache.  KeyError could be raised when cached function
     with full cache was simultaneously called from different threads
     with the same uncached arguments.

   - bpo-29142(74): In urllib.request, suffixes in no_proxy environment
     variable with leading dots could match related hostnames again
     (e.g.  .b.c matches a.b.c).  Patch by Milan Oberkirch.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29403

   (2) https://bugs.python.org/issue30961

   (3) https://bugs.python.org/issue30886

   (4) https://bugs.python.org/issue29854

   (5) https://bugs.python.org/issue30807

   (6) https://bugs.python.org/issue30441

   (7) https://bugs.python.org/issue30532

   (8) https://bugs.python.org/issue29169

   (9) https://bugs.python.org/issue30879

   (10) https://bugs.python.org/issue30746

   (11) https://bugs.python.org/issue29755

   (12) https://bugs.python.org/issue30645

   (13) https://bugs.python.org/issue23890

   (14) https://bugs.python.org/issue30149

   (15) https://bugs.python.org/issue29931

   (16) https://bugs.python.org/issue24484

   (17) https://bugs.python.org/issue28994

   (18) https://bugs.python.org/issue30508

   (19) https://bugs.python.org/issue28556

   (20) https://bugs.python.org/issue29870

   (21) https://bugs.python.org/issue29743

   (22) https://bugs.python.org/issue27585

   (23) https://bugs.python.org/issue30418

   (24) https://bugs.python.org/issue30378

   (25) https://bugs.python.org/issue29960

   (26) https://bugs.python.org/issue30414

   (27) https://bugs.python.org/issue30003

   (28) https://bugs.python.org/issue30301

   (29) https://bugs.python.org/issue30329

   (30) https://bugs.python.org/issue30375

   (31) https://bugs.python.org/issue30048

   (32) https://bugs.python.org/issue29990

   (33) https://bugs.python.org/issue26293

   (34) https://bugs.python.org/issue29094

   (35) https://bugs.python.org/issue30243

   (36) https://bugs.python.org/issue30185

   (37) https://bugs.python.org/issue28556

   (38) https://bugs.python.org/issue30205

   (39) https://bugs.python.org/issue30070

   (40) https://bugs.python.org/issue30061

   (41) https://bugs.python.org/issue30068

   (42) https://bugs.python.org/issue29694

   (43) https://bugs.python.org/issue29692

   (44) https://bugs.python.org/issue29998

   (45) https://bugs.python.org/issue29942

   (46) https://bugs.python.org/issue27863

   (47) https://bugs.python.org/issue28699

   (48) https://bugs.python.org/issue25803

   (49) https://bugs.python.org/issue29861

   (50) https://bugs.python.org/issue29884

   (51) https://bugs.python.org/issue25455

   (52) https://bugs.python.org/issue29800

   (53) https://bugs.python.org/issue29742

   (54) https://bugs.python.org/issue8256

   (55) https://bugs.python.org/issue28298

   (56) https://bugs.python.org/issue29615

   (57) https://bugs.python.org/issue29704

   (58) https://bugs.python.org/issue29703

   (59) https://bugs.python.org/issue29376

   (60) https://bugs.python.org/issue29110

   (61) https://bugs.python.org/issue28961

   (62) https://bugs.python.org/issue29532

   (63) https://bugs.python.org/issue28556

   (64) https://bugs.python.org/issue29100

   (65) https://bugs.python.org/issue29519

   (66) https://bugs.python.org/issue29416

   (67) https://bugs.python.org/issue29444

   (68) https://bugs.python.org/issue29335

   (69) https://bugs.python.org/issue29290

   (70) https://bugs.python.org/issue28735

   (71) https://bugs.python.org/issue29011

   (72) https://bugs.python.org/issue29219

   (73) https://bugs.python.org/issue28969

   (74) https://bugs.python.org/issue29142


File: python.info,  Node: Documentation<34>,  Next: Tests<36>,  Prev: Library<50>,  Up: Python 3 5 4 release candidate 1

1.18.51.4 Documentation
.......................

   - bpo-30176(1): Add missing attribute related constants in curses
     documentation.

   - bpo-26985(2): Add missing info of code object in inspect
     documentation.

   - bpo-28929(3): Link the documentation to its source file on GitHub.

   - bpo-25008(4): Document smtpd.py as effectively deprecated and add a
     pointer to aiosmtpd, a third-party asyncio-based replacement.

   - bpo-26355(5): Add canonical header link on each page to
     corresponding major version of the documentation.  Patch by
     Matthias Bussonnier.

   - bpo-29349(6): Fix Python 2 syntax in code for building the
     documentation.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30176

   (2) https://bugs.python.org/issue26985

   (3) https://bugs.python.org/issue28929

   (4) https://bugs.python.org/issue25008

   (5) https://bugs.python.org/issue26355

   (6) https://bugs.python.org/issue29349


File: python.info,  Node: Tests<36>,  Next: Build<37>,  Prev: Documentation<34>,  Up: Python 3 5 4 release candidate 1

1.18.51.5 Tests
...............

   - bpo-30822(1): Fix regrtest command line parser to allow passing -u
     extralargefile to run test_zipfile64.

   - bpo-30383(2): regrtest: Enhance regrtest and backport features from
     the master branch.  Add options: –coverage, –testdir, –list-tests
     (list test files, don’t run them), –list-cases (list test
     identifiers, don’t run them, bpo-30523(3)), –matchfile (load a list
     of test filters from a text file, bpo-30540(4)), –slowest (alias to
     –slow).  Enhance output: add timestamp, test result, currently
     running tests, “Tests result: xxx” summary with total duration,
     etc.  Fix reference leak hunting in regrtest, –huntrleaks: regrtest
     now warms up caches, create explicitly all internal singletons
     which are created on demand to prevent false positives when
     checking for reference leaks.  (bpo-30675(5)).

   - bpo-30357(6): test_thread: setUp() now uses
     support.threading_setup() and support.threading_cleanup() to wait
     until threads complete to avoid random side effects on following
     tests.  Initial patch written by Grzegorz Grzywacz.

   - bpo-28087(7): Skip test_asyncore and test_eintr poll failures on
     macOS. Skip some tests of select.poll when running on macOS due to
     unresolved issues with the underlying system poll function on some
     macOS versions.

   - bpo-30197(8): Enhanced functions swap_attr() and swap_item() in the
     test.support module.  They now work when delete replaced attribute
     or item inside the with statement.  The old value of the attribute
     or item (or None if it doesn’t exist) now will be assigned to the
     target of the “as” clause, if there is one.

   - bpo-29571(9): to match the behaviour of the ‘re.LOCALE’ flag,
     test_re.test_locale_flag now uses
     ‘locale.getpreferredencoding(False)’ to determine the candidate
     encoding for the test regex (allowing it to correctly skip the test
     when the default locale encoding is a multi-byte encoding)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30822

   (2) https://bugs.python.org/issue30383

   (3) https://bugs.python.org/issue30523

   (4) https://bugs.python.org/issue30540

   (5) https://bugs.python.org/issue30675

   (6) https://bugs.python.org/issue30357

   (7) https://bugs.python.org/issue28087

   (8) https://bugs.python.org/issue30197

   (9) https://bugs.python.org/issue29571


File: python.info,  Node: Build<37>,  Next: Windows<35>,  Prev: Tests<36>,  Up: Python 3 5 4 release candidate 1

1.18.51.6 Build
...............

   - bpo-29243(1): Prevent unnecessary rebuilding of Python during ‘make
     test’, ‘make install’ and some other make targets when configured
     with ‘--enable-optimizations’.

   - bpo-23404(2): Don’t regenerate generated files based on file
     modification time anymore: the action is now explicit.  Replace
     ‘make touch’ with ‘make regen-all’.

   - bpo-29643(3): Fix ‘--enable-optimization’ didn’t work.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29243

   (2) https://bugs.python.org/issue23404

   (3) https://bugs.python.org/issue29643


File: python.info,  Node: Windows<35>,  Next: C API<28>,  Prev: Build<37>,  Up: Python 3 5 4 release candidate 1

1.18.51.7 Windows
.................

   - bpo-30687(1): Locate msbuild.exe on Windows when building rather
     than vcvarsall.bat

   - bpo-29392(2): Prevent crash when passing invalid arguments into
     msvcrt module.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue30687

   (2) https://bugs.python.org/issue29392


File: python.info,  Node: C API<28>,  Prev: Windows<35>,  Up: Python 3 5 4 release candidate 1

1.18.51.8 C API
...............

   - bpo-27867(1): Function PySlice_GetIndicesEx() is replaced with a
     macro if Py_LIMITED_API is set to the value between 0x03050400 and
     0x03060000 (not including) or 0x03060100 or higher.

   - bpo-29083(2): Fixed the declaration of some public API functions.
     PyArg_VaParse() and PyArg_VaParseTupleAndKeywords() were not
     available in limited API. PyArg_ValidateKeywordArguments(),
     PyArg_UnpackTuple() and Py_BuildValue() were not available in
     limited API of version < 3.3 when PY_SSIZE_T_CLEAN is defined.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27867

   (2) https://bugs.python.org/issue29083


File: python.info,  Node: Python 3 5 3 final,  Next: Python 3 5 3 release candidate 1,  Prev: Python 3 5 4 release candidate 1,  Up: Changelog

1.18.52 Python 3.5.3 final
--------------------------

`Release date: 2017-01-17'

There were no code changes between 3.5.3rc1 and 3.5.3 final.


File: python.info,  Node: Python 3 5 3 release candidate 1,  Next: Python 3 5 2 final,  Prev: Python 3 5 3 final,  Up: Changelog

1.18.53 Python 3.5.3 release candidate 1
----------------------------------------

`Release date: 2017-01-02'

* Menu:

* Core and Builtins: Core and Builtins<42>.
* Library: Library<51>.
* Security: Security<26>.
* Library: Library<52>.
* Security: Security<27>.
* Library: Library<53>.
* IDLE: IDLE<34>.
* C API: C API<29>.
* Documentation: Documentation<35>.
* Tests: Tests<37>.
* Tools/Demos: Tools/Demos<26>.
* Windows: Windows<36>.
* Build: Build<38>.


File: python.info,  Node: Core and Builtins<42>,  Next: Library<51>,  Up: Python 3 5 3 release candidate 1

1.18.53.1 Core and Builtins
...........................

   - bpo-29073(1): bytearray formatting no longer truncates on first
     null byte.

   - bpo-28932(2): Do not include <sys/random.h> if it does not exist.

   - bpo-28147(3): Fix a memory leak in split-table dictionaries:
     setattr() must not convert combined table into split table.

   - bpo-25677(4): Correct the positioning of the syntax error caret for
     indented blocks.  Based on patch by Michael Layzell.

   - bpo-29000(5): Fixed bytes formatting of octals with zero padding in
     alternate form.

   - bpo-28512(6): Fixed setting the offset attribute of SyntaxError by
     PyErr_SyntaxLocationEx() and PyErr_SyntaxLocationObject().

   - bpo-28991(7): functools.lru_cache() was susceptible to an obscure
     reentrancy bug caused by a monkey-patched len() function.

   - bpo-28648(8): Fixed crash in Py_DecodeLocale() in debug build on
     Mac OS X when decode astral characters.  Patch by Xiang Zhang.

   - bpo-19398(9): Extra slash no longer added to sys.path components in
     case of empty compile-time PYTHONPATH components.

   - bpo-28426(10): Fixed potential crash in PyUnicode_AsDecodedObject()
     in debug build.

   - bpo-23782(11): Fixed possible memory leak in _PyTraceback_Add() and
     exception loss in PyTraceBack_Here().

   - bpo-28379(12): Added sanity checks and tests for
     PyUnicode_CopyCharacters().  Patch by Xiang Zhang.

   - bpo-28376(13): The type of long range iterator is now registered as
     Iterator.  Patch by Oren Milman.

   - bpo-28376(14): The constructor of range_iterator now checks that
     step is not 0.  Patch by Oren Milman.

   - bpo-26906(15): Resolving special methods of uninitialized type now
     causes implicit initialization of the type instead of a fail.

   - bpo-18287(16): PyType_Ready() now checks that tp_name is not NULL.
     Original patch by Niklas Koep.

   - bpo-24098(17): Fixed possible crash when AST is changed in process
     of compiling it.

   - bpo-28350(18): String constants with null character no longer
     interned.

   - bpo-26617(19): Fix crash when GC runs during weakref callbacks.

   - bpo-27942(20): String constants now interned recursively in tuples
     and frozensets.

   - bpo-21578(21): Fixed misleading error message when ImportError
     called with invalid keyword args.

   - bpo-28203(22): Fix incorrect type in error message from
     ‘complex(1.0, {2:3})’.  Patch by Soumya Sharma.

   - bpo-27955(23): Fallback on reading /dev/urandom device when the
     getrandom() syscall fails with EPERM, for example when blocked by
     SECCOMP.

   - bpo-28131(24): Fix a regression in zipimport’s compile_source().
     zipimport should use the same optimization level as the
     interpreter.

   - bpo-25221(25): Fix corrupted result from PyLong_FromLong(0) when
     Python is compiled with NSMALLPOSINTS = 0.

   - bpo-25758(26): Prevents zipimport from unnecessarily encoding a
     filename (patch by Eryk Sun)

   - bpo-28189(27): dictitems_contains no longer swallows compare
     errors.  (Patch by Xiang Zhang)

   - bpo-27812(28): Properly clear out a generator’s frame’s
     backreference to the generator to prevent crashes in frame.clear().

   - bpo-27811(29): Fix a crash when a coroutine that has not been
     awaited is finalized with warnings-as-errors enabled.

   - bpo-27587(30): Fix another issue found by PVS-Studio: Null pointer
     check after use of ‘def’ in _PyState_AddModule().  Initial patch by
     Christian Heimes.

   - bpo-26020(31): set literal evaluation order did not match
     documented behaviour.

   - bpo-27782(32): Multi-phase extension module import now correctly
     allows the ‘m_methods’ field to be used to add module level
     functions to instances of non-module types returned from
     ‘Py_create_mod’.  Patch by Xiang Zhang.

   - bpo-27936(33): The round() function accepted a second None argument
     for some types but not for others.  Fixed the inconsistency by
     accepting None for all numeric types.

   - bpo-27487(34): Warn if a submodule argument to “python -m” or
     runpy.run_module() is found in sys.modules after parent packages
     are imported, but before the submodule is executed.

   - bpo-27558(35): Fix a SystemError in the implementation of “raise”
     statement.  In a brand new thread, raise a RuntimeError since there
     is no active exception to reraise.  Patch written by Xiang Zhang.

   - bpo-27419(36): Standard __import__() no longer look up “__import__”
     in globals or builtins for importing submodules or “from import”.
     Fixed handling an error of non-string package name.

   - bpo-27083(37): Respect the PYTHONCASEOK environment variable under
     Windows.

   - bpo-27514(38): Make having too many statically nested blocks a
     SyntaxError instead of SystemError.

   - bpo-27473(39): Fixed possible integer overflow in bytes and
     bytearray concatenations.  Patch by Xiang Zhang.

   - bpo-27507(40): Add integer overflow check in bytearray.extend().
     Patch by Xiang Zhang.

   - bpo-27581(41): Don’t rely on wrapping for overflow check in
     PySequence_Tuple().  Patch by Xiang Zhang.

   - bpo-27443(42): __length_hint__() of bytearray iterators no longer
     return a negative integer for a resized bytearray.

   - bpo-27942(43): Fix memory leak in codeobject.c

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29073

   (2) https://bugs.python.org/issue28932

   (3) https://bugs.python.org/issue28147

   (4) https://bugs.python.org/issue25677

   (5) https://bugs.python.org/issue29000

   (6) https://bugs.python.org/issue28512

   (7) https://bugs.python.org/issue28991

   (8) https://bugs.python.org/issue28648

   (9) https://bugs.python.org/issue19398

   (10) https://bugs.python.org/issue28426

   (11) https://bugs.python.org/issue23782

   (12) https://bugs.python.org/issue28379

   (13) https://bugs.python.org/issue28376

   (14) https://bugs.python.org/issue28376

   (15) https://bugs.python.org/issue26906

   (16) https://bugs.python.org/issue18287

   (17) https://bugs.python.org/issue24098

   (18) https://bugs.python.org/issue28350

   (19) https://bugs.python.org/issue26617

   (20) https://bugs.python.org/issue27942

   (21) https://bugs.python.org/issue21578

   (22) https://bugs.python.org/issue28203

   (23) https://bugs.python.org/issue27955

   (24) https://bugs.python.org/issue28131

   (25) https://bugs.python.org/issue25221

   (26) https://bugs.python.org/issue25758

   (27) https://bugs.python.org/issue28189

   (28) https://bugs.python.org/issue27812

   (29) https://bugs.python.org/issue27811

   (30) https://bugs.python.org/issue27587

   (31) https://bugs.python.org/issue26020

   (32) https://bugs.python.org/issue27782

   (33) https://bugs.python.org/issue27936

   (34) https://bugs.python.org/issue27487

   (35) https://bugs.python.org/issue27558

   (36) https://bugs.python.org/issue27419

   (37) https://bugs.python.org/issue27083

   (38) https://bugs.python.org/issue27514

   (39) https://bugs.python.org/issue27473

   (40) https://bugs.python.org/issue27507

   (41) https://bugs.python.org/issue27581

   (42) https://bugs.python.org/issue27443

   (43) https://bugs.python.org/issue27942


File: python.info,  Node: Library<51>,  Next: Security<26>,  Prev: Core and Builtins<42>,  Up: Python 3 5 3 release candidate 1

1.18.53.2 Library
.................

   - bpo-15812(1): inspect.getframeinfo() now correctly shows the first
     line of a context.  Patch by Sam Breese.

   - bpo-29094(2): Offsets in a ZIP file created with extern file object
     and modes “w” and “x” now are relative to the start of the file.

   - bpo-13051(3): Fixed recursion errors in large or resized
     curses.textpad.Textbox.  Based on patch by Tycho Andersen.

   - bpo-29119(4): Fix weakrefs in the pure python version of
     collections.OrderedDict move_to_end() method.  Contributed by Andra
     Bogildea.

   - bpo-9770(5): curses.ascii predicates now work correctly with
     negative integers.

   - bpo-28427(6): old keys should not remove new values from
     WeakValueDictionary when collecting from another thread.

   - bpo-28923(7): Remove editor artifacts from Tix.py.

   - bpo-28871(8): Fixed a crash when deallocate deep ElementTree.

   - bpo-19542(9): Fix bugs in WeakValueDictionary.setdefault() and
     WeakValueDictionary.pop() when a GC collection happens in another
     thread.

   - bpo-20191(10): Fixed a crash in resource.prlimit() when pass a
     sequence that doesn’t own its elements as limits.

   - bpo-28779(11): multiprocessing.set_forkserver_preload() would crash
     the forkserver process if a preloaded module instantiated some
     multiprocessing objects such as locks.

   - bpo-28847(12): dbm.dumb now supports reading read-only files and no
     longer writes the index file when it is not changed.

   - bpo-25659(13): In ctypes, prevent a crash calling the from_buffer()
     and from_buffer_copy() methods on abstract classes like Array.

   - bpo-28732(14): Fix crash in os.spawnv() with no elements in args

   - bpo-28485(15): Always raise ValueError for negative
     compileall.compile_dir(workers=…) parameter, even when
     multithreading is unavailable.

   - bpo-28387(16): Fixed possible crash in _io.TextIOWrapper
     deallocator when the garbage collector is invoked in other thread.
     Based on patch by Sebastian Cufre.

   - bpo-27517(17): LZMA compressor and decompressor no longer raise
     exceptions if given empty data twice.  Patch by Benjamin Fogle.

   - bpo-28549(18): Fixed segfault in curses’s addch() with ncurses6.

   - bpo-28449(19): tarfile.open() with mode “r” or “r:” now tries to
     open a tar file with compression before trying to open it without
     compression.  Otherwise it had 50% chance failed with
     ignore_zeros=True.

   - bpo-23262(20): The webbrowser module now supports Firefox 36+ and
     derived browsers.  Based on patch by Oleg Broytman.

   - bpo-27939(21): Fixed bugs in tkinter.ttk.LabeledScale and
     tkinter.Scale caused by representing the scale as float value
     internally in Tk.  tkinter.IntVar now works if float value is set
     to underlying Tk variable.

   - bpo-28255(22): calendar.TextCalendar().prmonth() no longer prints a
     space at the start of new line after printing a month’s calendar.
     Patch by Xiang Zhang.

   - bpo-20491(23): The textwrap.TextWrapper class now honors
     non-breaking spaces.  Based on patch by Kaarle Ritvanen.

   - bpo-28353(24): os.fwalk() no longer fails on broken links.

   - bpo-25464(25): Fixed HList.header_exists() in tkinter.tix module by
     addin a workaround to Tix library bug.

   - bpo-28488(26): shutil.make_archive() no longer add entry “./” to
     ZIP archive.

   - bpo-24452(27): Make webbrowser support Chrome on Mac OS X.

   - bpo-20766(28): Fix references leaked by pdb in the handling of
     SIGINT handlers.

   - bpo-26293(29): Fixed writing ZIP files that starts not from the
     start of the file.  Offsets in ZIP file now are relative to the
     start of the archive in conforming to the specification.

   - bpo-28321(30): Fixed writing non-BMP characters with binary format
     in plistlib.

   - bpo-28322(31): Fixed possible crashes when unpickle itertools
     objects from incorrect pickle data.  Based on patch by John Leitch.

   - Fix possible integer overflows and crashes in the mmap module with
     unusual usage patterns.

   - bpo-1703178(32): Fix the ability to pass the –link-objects option
     to the distutils build_ext command.

   - bpo-28253(33): Fixed calendar functions for extreme months: 0001-01
     and 9999-12.  Methods itermonthdays() and itermonthdays2() are
     reimplemented so that they don’t call itermonthdates() which can
     cause datetime.date under/overflow.

   - bpo-28275(34): Fixed possible use after free in the decompress()
     methods of the LZMADecompressor and BZ2Decompressor classes.
     Original patch by John Leitch.

   - bpo-27897(35): Fixed possible crash in
     sqlite3.Connection.create_collation() if pass invalid string-like
     object as a name.  Patch by Xiang Zhang.

   - bpo-18893(36): Fix invalid exception handling in
     Lib/ctypes/macholib/dyld.py.  Patch by Madison May.

   - bpo-27611(37): Fixed support of default root window in the
     tkinter.tix module.

   - bpo-27348(38): In the traceback module, restore the formatting of
     exception messages like “Exception: None”.  This fixes a regression
     introduced in 3.5a2.

   - bpo-25651(39): Allow falsy values to be used for msg parameter of
     subTest().

   - bpo-27932(40): Prevent memory leak in win32_ver().

   - Fix UnboundLocalError in socket._sendfile_use_sendfile.

   - bpo-28075(41): Check for ERROR_ACCESS_DENIED in Windows
     implementation of os.stat().  Patch by Eryk Sun.

   - bpo-25270(42): Prevent codecs.escape_encode() from raising
     SystemError when an empty bytestring is passed.

   - bpo-28181(43): Get antigravity over HTTPS. Patch by Kaartic
     Sivaraam.

   - bpo-25895(44): Enable WebSocket URL schemes in
     urllib.parse.urljoin.  Patch by Gergely Imreh and Markus
     Holtermann.

   - bpo-27599(45): Fixed buffer overrun in binascii.b2a_qp() and
     binascii.a2b_qp().

   - bpo-19003(46): m email.generator now replaces only ‘\r’ and/or ‘\n’
     line endings, per the RFC, instead of all unicode line endings.

   - bpo-28019(47): itertools.count() no longer rounds non-integer step
     in range between 1.0 and 2.0 to 1.

   - bpo-25969(48): Update the lib2to3 grammar to handle the unpacking
     generalizations added in 3.5.

   - bpo-14977(49): mailcap now respects the order of the lines in the
     mailcap files (“first match”), as required by RFC 1542.  Patch by
     Michael Lazar.

   - bpo-24594(50): Validates persist parameter when opening MSI
     database

   - bpo-17582(51): xml.etree.ElementTree nows preserves whitespaces in
     attributes (Patch by Duane Griffin.  Reviewed and approved by
     Stefan Behnel.)

   - bpo-28047(52): Fixed calculation of line length used for the base64
     CTE in the new email policies.

   - bpo-27445(53): Don’t pass str(_charset) to MIMEText.set_payload().
     Patch by Claude Paroz.

   - bpo-22450(54): urllib now includes an ‘Accept: */*’ header among
     the default headers.  This makes the results of REST API requests
     more consistent and predictable especially when proxy servers are
     involved.

   - lib2to3.pgen3.driver.load_grammar() now creates a stable cache file
     between runs given the same Grammar.txt input regardless of the
     hash randomization setting.

   - bpo-27570(55): Avoid zero-length memcpy() etc calls with null
     source pointers in the “ctypes” and “array” modules.

   - bpo-22233(56): Break email header lines `only' on the RFC specified
     CR and LF characters, not on arbitrary unicode line breaks.  This
     also fixes a bug in HTTP header parsing.

   - bpo-27988(57): Fix email iter_attachments incorrect mutation of
     payload list.

   - bpo-27691(58): Fix ssl module’s parsing of GEN_RID subject
     alternative name fields in X.509 certs.

   - bpo-27850(59): Remove 3DES from ssl module’s default cipher list to
     counter measure sweet32 attack (CVE-2016-2183).

   - bpo-27766(60): Add ChaCha20 Poly1305 to ssl module’s default cipher
     list.  (Required OpenSSL 1.1.0 or LibreSSL).

   - bpo-26470(61): Port ssl and hashlib module to OpenSSL 1.1.0.

   - Remove support for passing a file descriptor to os.access.  It
     never worked but previously didn’t raise.

   - bpo-12885(62): Fix error when distutils encounters symlink.

   - bpo-27881(63): Fixed possible bugs when setting
     sqlite3.Connection.isolation_level.  Based on patch by Xiang Zhang.

   - bpo-27861(64): Fixed a crash in sqlite3.Connection.cursor() when a
     factory creates not a cursor.  Patch by Xiang Zhang.

   - bpo-19884(65): Avoid spurious output on OS X with Gnu Readline.

   - bpo-27706(66): Restore deterministic behavior of
     random.Random().seed() for string seeds using seeding version 1.
     Allows sequences of calls to random() to exactly match those
     obtained in Python 2.  Patch by Nofar Schnider.

   - bpo-10513(67): Fix a regression in Connection.commit().  Statements
     should not be reset after a commit.

   - A new version of typing.py from ‘https://github.com/python/typing’:
     Collection (only for 3.6) (bpo-27598(68)).  Add FrozenSet to
     __all__ (upstream #261).  Fix crash in _get_type_vars() (upstream
     #259).  Remove the dict constraint in ForwardRef._eval_type
     (upstream #252).

   - bpo-27539(69): Fix unnormalised ‘Fraction.__pow__’ result in the
     case of negative exponent and negative base.

   - bpo-21718(70): cursor.description is now available for queries
     using CTEs.

   - bpo-2466(71): posixpath.ismount now correctly recognizes mount
     points which the user does not have permission to access.

   - bpo-27773(72): Correct some memory management errors
     server_hostname in _ssl.wrap_socket().

   - bpo-26750(73): unittest.mock.create_autospec() now works properly
     for subclasses of property() and other data descriptors.

   - In the curses module, raise an error if window.getstr() or
     window.instr() is passed a negative value.

   - bpo-27783(74): Fix possible usage of uninitialized memory in
     operator.methodcaller.

   - bpo-27774(75): Fix possible Py_DECREF on unowned object in _sre.

   - bpo-27760(76): Fix possible integer overflow in binascii.b2a_qp.

   - bpo-27758(77): Fix possible integer overflow in the _csv module for
     large record lengths.

   - bpo-27568(78): Prevent HTTPoxy attack (CVE-2016-1000110).  Ignore
     the HTTP_PROXY variable when REQUEST_METHOD environment is set,
     which indicates that the script is in CGI mode.

   - bpo-27656(79): Do not assume sched.h defines any SCHED_* constants.

   - bpo-27130(80): In the “zlib” module, fix handling of large buffers
     (typically 4 GiB) when compressing and decompressing.  Previously,
     inputs were limited to 4 GiB, and compression and decompression
     operations did not properly handle results of 4 GiB.

   - bpo-27533(81): Release GIL in nt._isdir

   - bpo-17711(82): Fixed unpickling by the persistent ID with protocol
     0.  Original patch by Alexandre Vassalotti.

   - bpo-27522(83): Avoid an unintentional reference cycle in
     email.feedparser.

   - bpo-26844(84): Fix error message for imp.find_module() to refer to
     ‘path’ instead of ‘name’.  Patch by Lev Maximov.

   - bpo-23804(85): Fix SSL zero-length recv() calls to not block and
     not raise an error about unclean EOF.

   - bpo-27466(86): Change time format returned by
     http.cookie.time2netscape, confirming the netscape cookie format
     and making it consistent with documentation.

   - bpo-26664(87): Fix activate.fish by removing mis-use of ‘$’.

   - bpo-22115(88): Fixed tracing Tkinter variables: trace_vdelete()
     with wrong mode no longer break tracing, trace_vinfo() now always
     returns a list of pairs of strings, tracing in the “u” mode now
     works.

   - Fix a scoping issue in importlib.util.LazyLoader which triggered an
     UnboundLocalError when lazy-loading a module that was already put
     into sys.modules.

   - bpo-27079(89): Fixed curses.ascii functions isblank(), iscntrl()
     and ispunct().

   - bpo-26754(90): Some functions (compile() etc) accepted a filename
     argument encoded as an iterable of integers.  Now only strings and
     byte-like objects are accepted.

   - bpo-27048(91): Prevents distutils failing on Windows when
     environment variables contain non-ASCII characters

   - bpo-27330(92): Fixed possible leaks in the ctypes module.

   - bpo-27238(93): Got rid of bare excepts in the turtle module.
     Original patch by Jelle Zijlstra.

   - bpo-27122(94): When an exception is raised within the context being
     managed by a contextlib.ExitStack() and one of the exit stack
     generators catches and raises it in a chain, do not re-raise the
     original exception when exiting, let the new chained one through.
     This avoids the PEP 479(95) bug described in issue25782.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15812

   (2) https://bugs.python.org/issue29094

   (3) https://bugs.python.org/issue13051

   (4) https://bugs.python.org/issue29119

   (5) https://bugs.python.org/issue9770

   (6) https://bugs.python.org/issue28427

   (7) https://bugs.python.org/issue28923

   (8) https://bugs.python.org/issue28871

   (9) https://bugs.python.org/issue19542

   (10) https://bugs.python.org/issue20191

   (11) https://bugs.python.org/issue28779

   (12) https://bugs.python.org/issue28847

   (13) https://bugs.python.org/issue25659

   (14) https://bugs.python.org/issue28732

   (15) https://bugs.python.org/issue28485

   (16) https://bugs.python.org/issue28387

   (17) https://bugs.python.org/issue27517

   (18) https://bugs.python.org/issue28549

   (19) https://bugs.python.org/issue28449

   (20) https://bugs.python.org/issue23262

   (21) https://bugs.python.org/issue27939

   (22) https://bugs.python.org/issue28255

   (23) https://bugs.python.org/issue20491

   (24) https://bugs.python.org/issue28353

   (25) https://bugs.python.org/issue25464

   (26) https://bugs.python.org/issue28488

   (27) https://bugs.python.org/issue24452

   (28) https://bugs.python.org/issue20766

   (29) https://bugs.python.org/issue26293

   (30) https://bugs.python.org/issue28321

   (31) https://bugs.python.org/issue28322

   (32) https://bugs.python.org/issue1703178

   (33) https://bugs.python.org/issue28253

   (34) https://bugs.python.org/issue28275

   (35) https://bugs.python.org/issue27897

   (36) https://bugs.python.org/issue18893

   (37) https://bugs.python.org/issue27611

   (38) https://bugs.python.org/issue27348

   (39) https://bugs.python.org/issue25651

   (40) https://bugs.python.org/issue27932

   (41) https://bugs.python.org/issue28075

   (42) https://bugs.python.org/issue25270

   (43) https://bugs.python.org/issue28181

   (44) https://bugs.python.org/issue25895

   (45) https://bugs.python.org/issue27599

   (46) https://bugs.python.org/issue19003

   (47) https://bugs.python.org/issue28019

   (48) https://bugs.python.org/issue25969

   (49) https://bugs.python.org/issue14977

   (50) https://bugs.python.org/issue24594

   (51) https://bugs.python.org/issue17582

   (52) https://bugs.python.org/issue28047

   (53) https://bugs.python.org/issue27445

   (54) https://bugs.python.org/issue22450

   (55) https://bugs.python.org/issue27570

   (56) https://bugs.python.org/issue22233

   (57) https://bugs.python.org/issue27988

   (58) https://bugs.python.org/issue27691

   (59) https://bugs.python.org/issue27850

   (60) https://bugs.python.org/issue27766

   (61) https://bugs.python.org/issue26470

   (62) https://bugs.python.org/issue12885

   (63) https://bugs.python.org/issue27881

   (64) https://bugs.python.org/issue27861

   (65) https://bugs.python.org/issue19884

   (66) https://bugs.python.org/issue27706

   (67) https://bugs.python.org/issue10513

   (68) https://bugs.python.org/issue27598

   (69) https://bugs.python.org/issue27539

   (70) https://bugs.python.org/issue21718

   (71) https://bugs.python.org/issue2466

   (72) https://bugs.python.org/issue27773

   (73) https://bugs.python.org/issue26750

   (74) https://bugs.python.org/issue27783

   (75) https://bugs.python.org/issue27774

   (76) https://bugs.python.org/issue27760

   (77) https://bugs.python.org/issue27758

   (78) https://bugs.python.org/issue27568

   (79) https://bugs.python.org/issue27656

   (80) https://bugs.python.org/issue27130

   (81) https://bugs.python.org/issue27533

   (82) https://bugs.python.org/issue17711

   (83) https://bugs.python.org/issue27522

   (84) https://bugs.python.org/issue26844

   (85) https://bugs.python.org/issue23804

   (86) https://bugs.python.org/issue27466

   (87) https://bugs.python.org/issue26664

   (88) https://bugs.python.org/issue22115

   (89) https://bugs.python.org/issue27079

   (90) https://bugs.python.org/issue26754

   (91) https://bugs.python.org/issue27048

   (92) https://bugs.python.org/issue27330

   (93) https://bugs.python.org/issue27238

   (94) https://bugs.python.org/issue27122

   (95) https://www.python.org/dev/peps/pep-0479


File: python.info,  Node: Security<26>,  Next: Library<52>,  Prev: Library<51>,  Up: Python 3 5 3 release candidate 1

1.18.53.3 Security
..................

   - bpo-27278(1): Fix os.urandom() implementation using getrandom() on
     Linux.  Truncate size to INT_MAX and loop until we collected enough
     random bytes, instead of casting a directly Py_ssize_t to int.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27278


File: python.info,  Node: Library<52>,  Next: Security<27>,  Prev: Security<26>,  Up: Python 3 5 3 release candidate 1

1.18.53.4 Library
.................

   - bpo-26386(1): Fixed ttk.TreeView selection operations with item
     id’s containing spaces.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26386


File: python.info,  Node: Security<27>,  Next: Library<53>,  Prev: Library<52>,  Up: Python 3 5 3 release candidate 1

1.18.53.5 Security
..................

   - bpo-22636(1): Avoid shell injection problems with
     ctypes.util.find_library().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22636


File: python.info,  Node: Library<53>,  Next: IDLE<34>,  Prev: Security<27>,  Up: Python 3 5 3 release candidate 1

1.18.53.6 Library
.................

   - bpo-16182(1): Fix various functions in the “readline” module to use
     the locale encoding, and fix get_begidx() and get_endidx() to
     return code point indexes.

   - bpo-27392(2): Add loop.connect_accepted_socket().  Patch by Jim
     Fulton.

   - bpo-27930(3): Improved behaviour of logging.handlers.QueueListener.
     Thanks to Paulo Andrade and Petr Viktorin for the analysis and
     patch.

   - bpo-21201(4): Improves readability of multiprocessing error
     message.  Thanks to Wojciech Walczak for patch.

   - bpo-27456(5): asyncio: Set TCP_NODELAY by default.

   - bpo-27906(6): Fix socket accept exhaustion during high TCP traffic.
     Patch by Kevin Conway.

   - bpo-28174(7): Handle when SO_REUSEPORT isn’t properly supported.
     Patch by Seth Michael Larson.

   - bpo-26654(8): Inspect functools.partial in asyncio.Handle.__repr__.
     Patch by iceboy.

   - bpo-26909(9): Fix slow pipes IO in asyncio.  Patch by INADA Naoki.

   - bpo-28176(10): Fix callbacks race in
     asyncio.SelectorLoop.sock_connect.

   - bpo-27759(11): Fix selectors incorrectly retain invalid file
     descriptors.  Patch by Mark Williams.

   - bpo-28368(12): Refuse monitoring processes if the child watcher has
     no loop attached.  Patch by Vincent Michel.

   - bpo-28369(13): Raise RuntimeError when transport’s FD is used with
     add_reader, add_writer, etc.

   - bpo-28370(14): Speedup asyncio.StreamReader.readexactly.  Patch by
     Коренберг Марк.

   - bpo-28371(15): Deprecate passing asyncio.Handles to
     run_in_executor.

   - bpo-28372(16): Fix asyncio to support formatting of non-python
     coroutines.

   - bpo-28399(17): Remove UNIX socket from FS before binding.  Patch by
     Коренберг Марк.

   - bpo-27972(18): Prohibit Tasks to await on themselves.

   - bpo-26923(19): Fix asyncio.Gather to refuse being cancelled once
     all children are done.  Patch by Johannes Ebke.

   - bpo-26796(20): Don’t configure the number of workers for default
     threadpool executor.  Initial patch by Hans Lawrenz.

   - bpo-28600(21): Optimize loop.call_soon().

   - bpo-28613(22): Fix get_event_loop() return the current loop if
     called from coroutines/callbacks.

   - bpo-28639(23): Fix inspect.isawaitable to always return bool Patch
     by Justin Mayfield.

   - bpo-28652(24): Make loop methods reject socket kinds they do not
     support.

   - bpo-28653(25): Fix a refleak in functools.lru_cache.

   - bpo-28703(26): Fix asyncio.iscoroutinefunction to handle Mock
     objects.

   - bpo-24142(27): Reading a corrupt config file left the parser in an
     invalid state.  Original patch by Florian Höch.

   - bpo-28990(28): Fix SSL hanging if connection is closed before
     handshake completed.  (Patch by HoHo-Ho)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue16182

   (2) https://bugs.python.org/issue27392

   (3) https://bugs.python.org/issue27930

   (4) https://bugs.python.org/issue21201

   (5) https://bugs.python.org/issue27456

   (6) https://bugs.python.org/issue27906

   (7) https://bugs.python.org/issue28174

   (8) https://bugs.python.org/issue26654

   (9) https://bugs.python.org/issue26909

   (10) https://bugs.python.org/issue28176

   (11) https://bugs.python.org/issue27759

   (12) https://bugs.python.org/issue28368

   (13) https://bugs.python.org/issue28369

   (14) https://bugs.python.org/issue28370

   (15) https://bugs.python.org/issue28371

   (16) https://bugs.python.org/issue28372

   (17) https://bugs.python.org/issue28399

   (18) https://bugs.python.org/issue27972

   (19) https://bugs.python.org/issue26923

   (20) https://bugs.python.org/issue26796

   (21) https://bugs.python.org/issue28600

   (22) https://bugs.python.org/issue28613

   (23) https://bugs.python.org/issue28639

   (24) https://bugs.python.org/issue28652

   (25) https://bugs.python.org/issue28653

   (26) https://bugs.python.org/issue28703

   (27) https://bugs.python.org/issue24142

   (28) https://bugs.python.org/issue28990


File: python.info,  Node: IDLE<34>,  Next: C API<29>,  Prev: Library<53>,  Up: Python 3 5 3 release candidate 1

1.18.53.7 IDLE
..............

   - bpo-15308(1): Add ‘interrupt execution’ (^C) to Shell menu.  Patch
     by Roger Serwy, updated by Bayard Randel.

   - bpo-27922(2): Stop IDLE tests from ‘flashing’ gui widgets on the
     screen.

   - Add version to title of IDLE help window.

   - bpo-25564(3): In section on IDLE – console differences, mention
     that using exec means that __builtins__ is defined for each
     statement.

   - bpo-27714(4): text_textview and test_autocomplete now pass when
     re-run in the same process.  This occurs when test_idle fails when
     run with the -w option but without -jn.  Fix warning from
     test_config.

   - bpo-25507(5): IDLE no longer runs buggy code because of its tkinter
     imports.  Users must include the same imports required to run
     directly in Python.

   - bpo-27452(6): add line counter and crc to IDLE configHandler test
     dump.

   - bpo-27365(7): Allow non-ascii chars in IDLE NEWS.txt, for
     contributor names.

   - bpo-27245(8): IDLE: Cleanly delete custom themes and key bindings.
     Previously, when IDLE was started from a console or by import, a
     cascade of warnings was emitted.  Patch by Serhiy Storchaka.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15308

   (2) https://bugs.python.org/issue27922

   (3) https://bugs.python.org/issue25564

   (4) https://bugs.python.org/issue27714

   (5) https://bugs.python.org/issue25507

   (6) https://bugs.python.org/issue27452

   (7) https://bugs.python.org/issue27365

   (8) https://bugs.python.org/issue27245


File: python.info,  Node: C API<29>,  Next: Documentation<35>,  Prev: IDLE<34>,  Up: Python 3 5 3 release candidate 1

1.18.53.8 C API
...............

   - bpo-28808(1): PyUnicode_CompareWithASCIIString() now never raises
     exceptions.

   - bpo-26754(2): PyUnicode_FSDecoder() accepted a filename argument
     encoded as an iterable of integers.  Now only strings and
     bytes-like objects are accepted.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28808

   (2) https://bugs.python.org/issue26754


File: python.info,  Node: Documentation<35>,  Next: Tests<37>,  Prev: C API<29>,  Up: Python 3 5 3 release candidate 1

1.18.53.9 Documentation
.......................

   - bpo-28513(1): Documented command-line interface of zipfile.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28513


File: python.info,  Node: Tests<37>,  Next: Tools/Demos<26>,  Prev: Documentation<35>,  Up: Python 3 5 3 release candidate 1

1.18.53.10 Tests
................

   - bpo-28950(1): Disallow -j0 to be combined with -T/-l/-M in regrtest
     command line arguments.

   - bpo-28666(2): Now test.support.rmtree is able to remove unwritable
     or unreadable directories.

   - bpo-23839(3): Various caches now are cleared before running every
     test file.

   - bpo-28409(4): regrtest: fix the parser of command line arguments.

   - bpo-27787(5): Call gc.collect() before checking each test for
     “dangling threads”, since the dangling threads are weak references.

   - bpo-27369(6): In test_pyexpat, avoid testing an error message
     detail that changed in Expat 2.2.0.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28950

   (2) https://bugs.python.org/issue28666

   (3) https://bugs.python.org/issue23839

   (4) https://bugs.python.org/issue28409

   (5) https://bugs.python.org/issue27787

   (6) https://bugs.python.org/issue27369


File: python.info,  Node: Tools/Demos<26>,  Next: Windows<36>,  Prev: Tests<37>,  Up: Python 3 5 3 release candidate 1

1.18.53.11 Tools/Demos
......................

   - bpo-27952(1): Get Tools/scripts/fixcid.py working with Python 3 and
     the current “re” module, avoid invalid Python backslash escapes,
     and fix a bug parsing escaped C quote signs.

   - bpo-27332(2): Fixed the type of the first argument of module-level
     functions generated by Argument Clinic.  Patch by Petr Viktorin.

   - bpo-27418(3): Fixed Tools/importbench/importbench.py.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27952

   (2) https://bugs.python.org/issue27332

   (3) https://bugs.python.org/issue27418


File: python.info,  Node: Windows<36>,  Next: Build<38>,  Prev: Tools/Demos<26>,  Up: Python 3 5 3 release candidate 1

1.18.53.12 Windows
..................

   - bpo-28251(1): Improvements to help manuals on Windows.

   - bpo-28110(2): launcher.msi has different product codes between
     32-bit and 64-bit

   - bpo-25144(3): Ensures TargetDir is set before continuing with
     custom install.

   - bpo-27469(4): Adds a shell extension to the launcher so that drag
     and drop works correctly.

   - bpo-27309(5): Enabled proper Windows styles in python[w].exe
     manifest.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue28251

   (2) https://bugs.python.org/issue28110

   (3) https://bugs.python.org/issue25144

   (4) https://bugs.python.org/issue27469

   (5) https://bugs.python.org/issue27309


File: python.info,  Node: Build<38>,  Prev: Windows<36>,  Up: Python 3 5 3 release candidate 1

1.18.53.13 Build
................

   - bpo-29080(1): Removes hard dependency on hg.exe from
     PCBuild/build.bat

   - bpo-23903(2): Added missed names to PC/python3.def.

   - bpo-10656(3): Fix out-of-tree building on AIX. Patch by Tristan
     Carel and Michael Haubenwallner.

   - bpo-26359(4): Rename –with-optimiations to –enable-optimizations.

   - bpo-28444(5): Fix missing extensions modules when cross compiling.

   - bpo-28248(6): Update Windows build and OS X installers to use
     OpenSSL 1.0.2j.

   - bpo-28258(7): Fixed build with Estonian locale (python-config and
     distclean targets in Makefile).  Patch by Arfrever Frehtes
     Taifersar Arahesis.

   - bpo-26661(8): setup.py now detects system libffi with multiarch
     wrapper.

   - bpo-28066(9): Fix the logic that searches build directories for
     generated include files when building outside the source tree.

   - bpo-15819(10): Remove redundant include search directory option for
     building outside the source tree.

   - bpo-27566(11): Fix clean target in freeze makefile (patch by Lisa
     Roach)

   - bpo-27705(12): Update message in validate_ucrtbase.py

   - bpo-27983(13): Cause lack of llvm-profdata tool when using clang as
     required for PGO linking to be a configure time error rather than
     make time when –with-optimizations is enabled.  Also improve our
     ability to find the llvm-profdata tool on MacOS and some Linuxes.

   - bpo-26307(14): The profile-opt build now applies PGO to the
     built-in modules.

   - bpo-26359(15): Add the –with-optimizations configure flag.

   - bpo-27713(16): Suppress spurious build warnings when updating
     importlib’s bootstrap files.  Patch by Xiang Zhang

   - bpo-25825(17): Correct the references to Modules/python.exp and
     ld_so_aix, which are required on AIX. This updates references to an
     installation path that was changed in 3.2a4, and undoes changed
     references to the build tree that were made in 3.5.0a1.

   - bpo-27453(18): CPP invocation in configure must use CPPFLAGS. Patch
     by Chi Hsuan Yen.

   - bpo-27641(19): The configure script now inserts comments into the
     makefile to prevent the pgen and _freeze_importlib executables from
     being cross-compiled.

   - bpo-26662(20): Set PYTHON_FOR_GEN in configure as the Python
     program to be used for file generation during the build.

   - bpo-10910(21): Avoid C++ compilation errors on FreeBSD and OS X.
     Also update FreedBSD version checks for the original ctype UTF-8
     workaround.

   - bpo-28676(22): Prevent missing ‘getentropy’ declaration warning on
     macOS. Patch by Gareth Rees.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue29080

   (2) https://bugs.python.org/issue23903

   (3) https://bugs.python.org/issue10656

   (4) https://bugs.python.org/issue26359

   (5) https://bugs.python.org/issue28444

   (6) https://bugs.python.org/issue28248

   (7) https://bugs.python.org/issue28258

   (8) https://bugs.python.org/issue26661

   (9) https://bugs.python.org/issue28066

   (10) https://bugs.python.org/issue15819

   (11) https://bugs.python.org/issue27566

   (12) https://bugs.python.org/issue27705

   (13) https://bugs.python.org/issue27983

   (14) https://bugs.python.org/issue26307

   (15) https://bugs.python.org/issue26359

   (16) https://bugs.python.org/issue27713

   (17) https://bugs.python.org/issue25825

   (18) https://bugs.python.org/issue27453

   (19) https://bugs.python.org/issue27641

   (20) https://bugs.python.org/issue26662

   (21) https://bugs.python.org/issue10910

   (22) https://bugs.python.org/issue28676


File: python.info,  Node: Python 3 5 2 final,  Next: Python 3 5 2 release candidate 1,  Prev: Python 3 5 3 release candidate 1,  Up: Changelog

1.18.54 Python 3.5.2 final
--------------------------

`Release date: 2016-06-26'

* Menu:

* Core and Builtins: Core and Builtins<43>.
* Tests: Tests<38>.
* IDLE: IDLE<35>.


File: python.info,  Node: Core and Builtins<43>,  Next: Tests<38>,  Up: Python 3 5 2 final

1.18.54.1 Core and Builtins
...........................

   - bpo-26930(1): Update Windows builds to use OpenSSL 1.0.2h.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26930


File: python.info,  Node: Tests<38>,  Next: IDLE<35>,  Prev: Core and Builtins<43>,  Up: Python 3 5 2 final

1.18.54.2 Tests
...............

   - bpo-26867(1): Ubuntu’s openssl OP_NO_SSLv3 is forced on by default;
     fix test.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26867


File: python.info,  Node: IDLE<35>,  Prev: Tests<38>,  Up: Python 3 5 2 final

1.18.54.3 IDLE
..............

   - bpo-27365(1): Allow non-ascii in idlelib/NEWS.txt - minimal part
     for 3.5.2.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27365


File: python.info,  Node: Python 3 5 2 release candidate 1,  Next: Python 3 5 1 final,  Prev: Python 3 5 2 final,  Up: Changelog

1.18.55 Python 3.5.2 release candidate 1
----------------------------------------

`Release date: 2016-06-12'

* Menu:

* Core and Builtins: Core and Builtins<44>.
* Security: Security<28>.
* Library: Library<54>.
* Security: Security<29>.
* Library: Library<55>.
* Security: Security<30>.
* Library: Library<56>.
* Security: Security<31>.
* Library: Library<57>.
* Security: Security<32>.
* Library: Library<58>.
* IDLE: IDLE<36>.
* Documentation: Documentation<36>.
* Tests: Tests<39>.
* Build: Build<39>.
* Windows: Windows<37>.
* Tools/Demos: Tools/Demos<27>.
* Windows: Windows<38>.


File: python.info,  Node: Core and Builtins<44>,  Next: Security<28>,  Up: Python 3 5 2 release candidate 1

1.18.55.1 Core and Builtins
...........................

   - bpo-27066(1): Fixed SystemError if a custom opener (for open())
     returns a negative number without setting an exception.

   - bpo-20041(2): Fixed TypeError when frame.f_trace is set to None.
     Patch by Xavier de Gaye.

   - bpo-26168(3): Fixed possible refleaks in failing Py_BuildValue()
     with the “N” format unit.

   - bpo-26991(4): Fix possible refleak when creating a function with
     annotations.

   - bpo-27039(5): Fixed bytearray.remove() for values greater than 127.
     Patch by Joe Jevnik.

   - bpo-23640(6): int.from_bytes() no longer bypasses constructors for
     subclasses.

   - bpo-26811(7): gc.get_objects() no longer contains a broken tuple
     with NULL pointer.

   - bpo-20120(8): Use RawConfigParser for .pypirc parsing, removing
     support for interpolation unintentionally added with move to Python
     3.  Behavior no longer does any interpolation in .pypirc files,
     matching behavior in Python 2.7 and Setuptools 19.0.

   - bpo-26659(9): Make the builtin slice type support cycle collection.

   - bpo-26718(10): super.__init__ no longer leaks memory if called
     multiple times.  NOTE: A direct call of super.__init__ is not
     endorsed!

   - bpo-25339(11): PYTHONIOENCODING now has priority over locale in
     setting the error handler for stdin and stdout.

   - bpo-26494(12): Fixed crash on iterating exhausting iterators.
     Affected classes are generic sequence iterators, iterators of str,
     bytes, bytearray, list, tuple, set, frozenset, dict, OrderedDict,
     corresponding views and os.scandir() iterator.

   - bpo-26581(13): If coding cookie is specified multiple times on a
     line in Python source code file, only the first one is taken to
     account.

   - bpo-26464(14): Fix str.translate() when string is ASCII and first
     replacements removes character, but next replacement uses a
     non-ASCII character or a string longer than 1 character.
     Regression introduced in Python 3.5.0.

   - bpo-22836(15): Ensure exception reports from PyErr_Display() and
     PyErr_WriteUnraisable() are sensible even when formatting them
     produces secondary errors.  This affects the reports produced by
     sys.__excepthook__() and when __del__() raises an exception.

   - bpo-26302(16): Correct behavior to reject comma as a legal
     character for cookie names.

   - bpo-4806(17): Avoid masking the original TypeError exception when
     using star (‘*’) unpacking in function calls.  Based on patch by
     Hagen Fürstenau and Daniel Urban.

   - bpo-27138(18): Fix the doc comment for FileFinder.find_spec().

   - bpo-26154(19): Add a new private _PyThreadState_UncheckedGet()
     function to get the current Python thread state, but don’t issue a
     fatal error if it is NULL. This new function must be used instead
     of accessing directly the _PyThreadState_Current variable.  The
     variable is no more exposed since Python 3.5.1 to hide the exact
     implementation of atomic C types, to avoid compiler issues.

   - bpo-26194(20): Deque.insert() gave odd results for bounded deques
     that had reached their maximum size.  Now an IndexError will be
     raised when attempting to insert into a full deque.

   - bpo-25843(21): When compiling code, don’t merge constants if they
     are equal but have a different types.  For example, ‘f1, f2 =
     lambda: 1, lambda: 1.0’ is now correctly compiled to two different
     functions: ‘f1()’ returns ‘1’ (‘int’) and ‘f2()’ returns ‘1.0’
     (‘int’), even if ‘1’ and ‘1.0’ are equal.

   - bpo-22995(22): [UPDATE] Comment out the one of the pickleability
     tests in _PyObject_GetState() due to regressions observed in
     Cython-based projects.

   - bpo-25961(23): Disallowed null characters in the type name.

   - bpo-25973(24): Fix segfault when an invalid nonlocal statement
     binds a name starting with two underscores.

   - bpo-22995(25): Instances of extension types with a state that
     aren’t subclasses of list or dict and haven’t implemented any
     pickle-related methods (__reduce__, __reduce_ex__, __getnewargs__,
     __getnewargs_ex__, or __getstate__), can no longer be pickled.
     Including memoryview.

   - bpo-20440(26): Massive replacing unsafe attribute setting code with
     special macro Py_SETREF.

   - bpo-25766(27): Special method __bytes__() now works in str
     subclasses.

   - bpo-25421(28): __sizeof__ methods of builtin types now use dynamic
     basic size.  This allows sys.getsize() to work correctly with their
     subclasses with __slots__ defined.

   - bpo-25709(29): Fixed problem with in-place string concatenation and
     utf-8 cache.

   - bpo-27147(30): Mention PEP 420(31) in the importlib docs.

   - bpo-24097(32): Fixed crash in object.__reduce__() if slot name is
     freed inside __getattr__.

   - bpo-24731(33): Fixed crash on converting objects with special
     methods __bytes__, __trunc__, and __float__ returning instances of
     subclasses of bytes, int, and float to subclasses of bytes, int,
     and float correspondingly.

   - bpo-26478(34): Fix semantic bugs when using binary operators with
     dictionary views and tuples.

   - bpo-26171(35): Fix possible integer overflow and heap corruption in
     zipimporter.get_data().

   - bpo-25660(36): Fix TAB key behaviour in REPL with readline.

   - bpo-25887(37): Raise a RuntimeError when a coroutine object is
     awaited more than once.

   - bpo-27243(38): Update the __aiter__ protocol: instead of returning
     an awaitable that resolves to an asynchronous iterator, the
     asynchronous iterator should be returned directly.  Doing the
     former will trigger a PendingDeprecationWarning.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27066

   (2) https://bugs.python.org/issue20041

   (3) https://bugs.python.org/issue26168

   (4) https://bugs.python.org/issue26991

   (5) https://bugs.python.org/issue27039

   (6) https://bugs.python.org/issue23640

   (7) https://bugs.python.org/issue26811

   (8) https://bugs.python.org/issue20120

   (9) https://bugs.python.org/issue26659

   (10) https://bugs.python.org/issue26718

   (11) https://bugs.python.org/issue25339

   (12) https://bugs.python.org/issue26494

   (13) https://bugs.python.org/issue26581

   (14) https://bugs.python.org/issue26464

   (15) https://bugs.python.org/issue22836

   (16) https://bugs.python.org/issue26302

   (17) https://bugs.python.org/issue4806

   (18) https://bugs.python.org/issue27138

   (19) https://bugs.python.org/issue26154

   (20) https://bugs.python.org/issue26194

   (21) https://bugs.python.org/issue25843

   (22) https://bugs.python.org/issue22995

   (23) https://bugs.python.org/issue25961

   (24) https://bugs.python.org/issue25973

   (25) https://bugs.python.org/issue22995

   (26) https://bugs.python.org/issue20440

   (27) https://bugs.python.org/issue25766

   (28) https://bugs.python.org/issue25421

   (29) https://bugs.python.org/issue25709

   (30) https://bugs.python.org/issue27147

   (31) https://www.python.org/dev/peps/pep-0420

   (32) https://bugs.python.org/issue24097

   (33) https://bugs.python.org/issue24731

   (34) https://bugs.python.org/issue26478

   (35) https://bugs.python.org/issue26171

   (36) https://bugs.python.org/issue25660

   (37) https://bugs.python.org/issue25887

   (38) https://bugs.python.org/issue27243


File: python.info,  Node: Security<28>,  Next: Library<54>,  Prev: Core and Builtins<44>,  Up: Python 3 5 2 release candidate 1

1.18.55.2 Security
..................

   - bpo-26556(1): Update expat to 2.1.1, fixes CVE-2015-1283.

   - Fix TLS stripping vulnerability in smtplib, CVE-2016-0772.
     Reported by Team Oststrom

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26556


File: python.info,  Node: Library<54>,  Next: Security<29>,  Prev: Security<28>,  Up: Python 3 5 2 release candidate 1

1.18.55.3 Library
.................

   - bpo-21386(1): Implement missing IPv4Address.is_global property.  It
     was documented since 07a5610bae9d.  Initial patch by Roger Luethi.

   - bpo-20900(2): distutils register command now decodes HTTP responses
     correctly.  Initial patch by ingrid.

   - A new version of typing.py provides several new classes and
     features: @overload outside stubs, Reversible, DefaultDict, Text,
     ContextManager, Type[], NewType(), TYPE_CHECKING, and numerous bug
     fixes (note that some of the new features are not yet implemented
     in mypy or other static analyzers).  Also classes for PEP 492(3)
     (Awaitable, AsyncIterable, AsyncIterator) have been added (in fact
     they made it into 3.5.1 but were never mentioned).

   - bpo-25738(4): Stop http.server.BaseHTTPRequestHandler.send_error()
     from sending a message body for 205 Reset Content.  Also, don’t
     send Content header fields in responses that don’t have a body.
     Patch by Susumu Koshiba.

   - bpo-21313(5): Fix the “platform” module to tolerate when
     sys.version contains truncated build information.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21386

   (2) https://bugs.python.org/issue20900

   (3) https://www.python.org/dev/peps/pep-0492

   (4) https://bugs.python.org/issue25738

   (5) https://bugs.python.org/issue21313


File: python.info,  Node: Security<29>,  Next: Library<55>,  Prev: Library<54>,  Up: Python 3 5 2 release candidate 1

1.18.55.4 Security
..................

   - bpo-26839(1): On Linux, *note os.urandom(): 4c6. now calls
     ‘getrandom()’ with ‘GRND_NONBLOCK’ to fall back on reading
     ‘/dev/urandom’ if the urandom entropy pool is not initialized yet.
     Patch written by Colm Buckley.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26839


File: python.info,  Node: Library<55>,  Next: Security<30>,  Prev: Security<29>,  Up: Python 3 5 2 release candidate 1

1.18.55.5 Library
.................

   - bpo-27164(1): In the zlib module, allow decompressing raw Deflate
     streams with a predefined zdict.  Based on patch by Xiang Zhang.

   - bpo-24291(2): Fix wsgiref.simple_server.WSGIRequestHandler to
     completely write data to the client.  Previously it could do
     partial writes and truncate data.  Also,
     wsgiref.handler.ServerHandler can now handle stdout doing partial
     writes, but this is deprecated.

   - bpo-26809(3): Add ‘__all__’ to *note string: f6.  Patch by Emanuel
     Barry.

   - bpo-26373(4): subprocess.Popen.communicate now correctly ignores
     BrokenPipeError when the child process dies before .communicate()
     is called in more/all circumstances.

   - bpo-21776(5): distutils.upload now correctly handles HTTPError.
     Initial patch by Claudiu Popa.

   - bpo-27114(6): Fix SSLContext._load_windows_store_certs fails with
     PermissionError

   - bpo-18383(7): Avoid creating duplicate filters when using
     filterwarnings and simplefilter.  Based on patch by Alex Shkop.

   - bpo-27057(8): Fix os.set_inheritable() on Android, ioctl() is
     blocked by SELinux and fails with EACCESS. The function now falls
     back to fcntl().  Patch written by Michał Bednarski.

   - bpo-27014(9): Fix infinite recursion using typing.py.  Thanks to
     Kalle Tuure!

   - bpo-14132(10): Fix urllib.request redirect handling when the target
     only has a query string.  Original fix by Ján Janech.

   - bpo-17214(11): The “urllib.request” module now percent-encodes
     non-ASCII bytes found in redirect target URLs.  Some servers send
     Location header fields with non-ASCII bytes, but “http.client”
     requires the request target to be ASCII-encodable, otherwise a
     UnicodeEncodeError is raised.  Based on patch by Christian Heimes.

   - bpo-26892(12): Honor debuglevel flag in urllib.request.HTTPHandler.
     Patch contributed by Chi Hsuan Yen.

   - bpo-22274(13): In the subprocess module, allow stderr to be
     redirected to stdout even when stdout is not redirected.  Patch by
     Akira Li.

   - bpo-26807(14): mock_open ‘files’ no longer error on readline at end
     of file.  Patch from Yolanda Robla.

   - bpo-25745(15): Fixed leaking a userptr in curses panel destructor.

   - bpo-26977(16): Removed unnecessary, and ignored, call to sum of
     squares helper in statistics.pvariance.

   - bpo-26881(17): The modulefinder module now supports extended opcode
     arguments.

   - bpo-23815(18): Fixed crashes related to directly created instances
     of types in _tkinter and curses.panel modules.

   - bpo-17765(19): weakref.ref() no longer silently ignores keyword
     arguments.  Patch by Georg Brandl.

   - bpo-26873(20): xmlrpc now raises ResponseError on unsupported type
     tags instead of silently return incorrect result.

   - bpo-26711(21): Fixed the comparison of plistlib.Data with other
     types.

   - bpo-24114(22): Fix an uninitialized variable in ‘ctypes.util’.  The
     bug only occurs on SunOS when the ctypes implementation searches
     for the ‘crle’ program.  Patch by Xiang Zhang.  Tested on SunOS by
     Kees Bos.

   - bpo-26864(23): In urllib.request, change the proxy bypass host
     checking against no_proxy to be case-insensitive, and to not match
     unrelated host names that happen to have a bypassed hostname as a
     suffix.  Patch by Xiang Zhang.

   - bpo-26634(24): recursive_repr() now sets __qualname__ of wrapper.
     Patch by Xiang Zhang.

   - bpo-26804(25): urllib.request will prefer lower_case proxy
     environment variables over UPPER_CASE or Mixed_Case ones.  Patch
     contributed by Hans-Peter Jansen.

   - bpo-26837(26): assertSequenceEqual() now correctly outputs
     non-stringified differing items (like bytes in the -b mode).  This
     affects assertListEqual() and assertTupleEqual().

   - bpo-26041(27): Remove “will be removed in Python 3.7” from
     deprecation messages of platform.dist() and
     platform.linux_distribution().  Patch by Kumaripaba Miyurusara
     Athukorala.

   - bpo-26822(28): itemgetter, attrgetter and methodcaller objects no
     longer silently ignore keyword arguments.

   - bpo-26733(29): Disassembling a class now disassembles class and
     static methods.  Patch by Xiang Zhang.

   - bpo-26801(30): Fix error handling in *note
     shutil.get_terminal_size(): a3f, catch *note AttributeError: 390.
     instead of *note NameError: d6e.  Patch written by Emanuel Barry.

   - bpo-24838(31): tarfile’s ustar and gnu formats now correctly
     calculate name and link field limits for multibyte character
     encodings like utf-8.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27164

   (2) https://bugs.python.org/issue24291

   (3) https://bugs.python.org/issue26809

   (4) https://bugs.python.org/issue26373

   (5) https://bugs.python.org/issue21776

   (6) https://bugs.python.org/issue27114

   (7) https://bugs.python.org/issue18383

   (8) https://bugs.python.org/issue27057

   (9) https://bugs.python.org/issue27014

   (10) https://bugs.python.org/issue14132

   (11) https://bugs.python.org/issue17214

   (12) https://bugs.python.org/issue26892

   (13) https://bugs.python.org/issue22274

   (14) https://bugs.python.org/issue26807

   (15) https://bugs.python.org/issue25745

   (16) https://bugs.python.org/issue26977

   (17) https://bugs.python.org/issue26881

   (18) https://bugs.python.org/issue23815

   (19) https://bugs.python.org/issue17765

   (20) https://bugs.python.org/issue26873

   (21) https://bugs.python.org/issue26711

   (22) https://bugs.python.org/issue24114

   (23) https://bugs.python.org/issue26864

   (24) https://bugs.python.org/issue26634

   (25) https://bugs.python.org/issue26804

   (26) https://bugs.python.org/issue26837

   (27) https://bugs.python.org/issue26041

   (28) https://bugs.python.org/issue26822

   (29) https://bugs.python.org/issue26733

   (30) https://bugs.python.org/issue26801

   (31) https://bugs.python.org/issue24838


File: python.info,  Node: Security<30>,  Next: Library<56>,  Prev: Library<55>,  Up: Python 3 5 2 release candidate 1

1.18.55.6 Security
..................

   - bpo-26657(1): Fix directory traversal vulnerability with
     http.server on Windows.  This fixes a regression that was
     introduced in 3.3.4rc1 and 3.4.0rc1.  Based on patch by Philipp
     Hagemeister.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26657


File: python.info,  Node: Library<56>,  Next: Security<31>,  Prev: Security<30>,  Up: Python 3 5 2 release candidate 1

1.18.55.7 Library
.................

   - bpo-26717(1): Stop encoding Latin-1-ized WSGI paths with UTF-8.
     Patch by Anthony Sottile.

   - bpo-26735(2): Fix *note os.urandom(): 4c6. on Solaris 11.3 and
     newer when reading more than 1,024 bytes: call ‘getrandom()’
     multiple times with a limit of 1024 bytes per call.

   - bpo-16329(3): Add .webm to mimetypes.types_map.  Patch by Giampaolo
     Rodola’.

   - bpo-13952(4): Add .csv to mimetypes.types_map.  Patch by Geoff
     Wilson.

   - bpo-26709(5): Fixed Y2038 problem in loading binary PLists.

   - bpo-23735(6): Handle terminal resizing with Readline 6.3+ by
     installing our own SIGWINCH handler.  Patch by Eric Price.

   - bpo-26586(7): In http.server, respond with “413 Request header
     fields too large” if there are too many header fields to parse,
     rather than killing the connection and raising an unhandled
     exception.  Patch by Xiang Zhang.

   - bpo-22854(8): Change BufferedReader.writable() and
     BufferedWriter.readable() to always return False.

   - bpo-25195(9): Fix a regression in mock.MagicMock.  _Call is a
     subclass of tuple (changeset 3603bae63c13 only works for classes)
     so we need to implement __ne__ ourselves.  Patch by Andrew Plummer.

   - bpo-26644(10): Raise ValueError rather than SystemError when a
     negative length is passed to SSLSocket.recv() or read().

   - bpo-23804(11): Fix SSL recv(0) and read(0) methods to return zero
     bytes instead of up to 1024.

   - bpo-26616(12): Fixed a bug in datetime.astimezone() method.

   - bpo-21925(13): *note warnings.formatwarning(): f26. now catches
     exceptions on ‘linecache.getline(...)’ to be able to log *note
     ResourceWarning: 4c5. emitted late during the Python shutdown
     process.

   - bpo-24266(14): Ctrl+C during Readline history search now cancels
     the search mode when compiled with Readline 7.

   - bpo-26560(15): Avoid potential ValueError in
     BaseHandler.start_response.  Initial patch by Peter Inglesby.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26717

   (2) https://bugs.python.org/issue26735

   (3) https://bugs.python.org/issue16329

   (4) https://bugs.python.org/issue13952

   (5) https://bugs.python.org/issue26709

   (6) https://bugs.python.org/issue23735

   (7) https://bugs.python.org/issue26586

   (8) https://bugs.python.org/issue22854

   (9) https://bugs.python.org/issue25195

   (10) https://bugs.python.org/issue26644

   (11) https://bugs.python.org/issue23804

   (12) https://bugs.python.org/issue26616

   (13) https://bugs.python.org/issue21925

   (14) https://bugs.python.org/issue24266

   (15) https://bugs.python.org/issue26560


File: python.info,  Node: Security<31>,  Next: Library<57>,  Prev: Library<56>,  Up: Python 3 5 2 release candidate 1

1.18.55.8 Security
..................

   - bpo-26313(1): ssl.py _load_windows_store_certs fails if windows
     cert store is empty.  Patch by Baji.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26313


File: python.info,  Node: Library<57>,  Next: Security<32>,  Prev: Security<31>,  Up: Python 3 5 2 release candidate 1

1.18.55.9 Library
.................

   - bpo-26569(1): Fix *note pyclbr.readmodule(): 10a2. and *note
     pyclbr.readmodule_ex(): 10a3. to support importing packages.

   - bpo-26499(2): Account for remaining Content-Length in
     HTTPResponse.readline() and read1().  Based on patch by Silent
     Ghost.  Also document that HTTPResponse now supports these methods.

   - bpo-25320(3): Handle sockets in directories unittest discovery is
     scanning.  Patch from Victor van den Elzen.

   - bpo-16181(4): cookiejar.http2time() now returns None if year is
     higher than datetime.MAXYEAR.

   - bpo-26513(5): Fixes platform module detection of Windows Server

   - bpo-23718(6): Fixed parsing time in week 0 before Jan 1.  Original
     patch by Tamás Bence Gedai.

   - bpo-20589(7): Invoking Path.owner() and Path.group() on Windows now
     raise NotImplementedError instead of ImportError.

   - bpo-26177(8): Fixed the keys() method for Canvas and Scrollbar
     widgets.

   - bpo-15068(9): Got rid of excessive buffering in the fileinput
     module.  The bufsize parameter is no longer used.

   - bpo-2202(10): Fix UnboundLocalError in
     AbstractDigestAuthHandler.get_algorithm_impls.  Initial patch by
     Mathieu Dupuy.

   - bpo-25718(11): Fixed pickling and copying the accumulate() iterator
     with total is None.

   - bpo-26475(12): Fixed debugging output for regular expressions with
     the (?x) flag.

   - bpo-26457(13): Fixed the subnets() methods in IP network classes
     for the case when resulting prefix length is equal to maximal
     prefix length.  Based on patch by Xiang Zhang.

   - bpo-26385(14): Remove the file if the internal open() call in
     NamedTemporaryFile() fails.  Patch by Silent Ghost.

   - bpo-26402(15): Fix XML-RPC client to retry when the server shuts
     down a persistent connection.  This was a regression related to the
     new http.client.RemoteDisconnected exception in 3.5.0a4.

   - bpo-25913(16): Leading ‘<~’ is optional now in base64.a85decode()
     with adobe=True.  Patch by Swati Jaiswal.

   - bpo-26186(17): Remove an invalid type check in
     importlib.util.LazyLoader.

   - bpo-26367(18): importlib.__import__() raises SystemError like
     builtins.__import__() when ‘level’ is specified but without an
     accompanying package specified.

   - bpo-26309(19): In the “socketserver” module, shut down the request
     (closing the connected socket) when verify_request() returns false.
     Patch by Aviv Palivoda.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26569

   (2) https://bugs.python.org/issue26499

   (3) https://bugs.python.org/issue25320

   (4) https://bugs.python.org/issue16181

   (5) https://bugs.python.org/issue26513

   (6) https://bugs.python.org/issue23718

   (7) https://bugs.python.org/issue20589

   (8) https://bugs.python.org/issue26177

   (9) https://bugs.python.org/issue15068

   (10) https://bugs.python.org/issue2202

   (11) https://bugs.python.org/issue25718

   (12) https://bugs.python.org/issue26475

   (13) https://bugs.python.org/issue26457

   (14) https://bugs.python.org/issue26385

   (15) https://bugs.python.org/issue26402

   (16) https://bugs.python.org/issue25913

   (17) https://bugs.python.org/issue26186

   (18) https://bugs.python.org/issue26367

   (19) https://bugs.python.org/issue26309


File: python.info,  Node: Security<32>,  Next: Library<58>,  Prev: Library<57>,  Up: Python 3 5 2 release candidate 1

1.18.55.10 Security
...................

   - bpo-25939(1): On Windows open the cert store readonly in
     ssl.enum_certificates.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25939


File: python.info,  Node: Library<58>,  Next: IDLE<36>,  Prev: Security<32>,  Up: Python 3 5 2 release candidate 1

1.18.55.11 Library
..................

   - bpo-25995(1): os.walk() no longer uses FDs proportional to the tree
     depth.

   - bpo-26117(2): The os.scandir() iterator now closes file descriptor
     not only when the iteration is finished, but when it was failed
     with error.

   - bpo-25911(3): Restored support of bytes paths in os.walk() on
     Windows.

   - bpo-26045(4): Add UTF-8 suggestion to error message when posting a
     non-Latin-1 string with http.client.

   - bpo-12923(5): Reset FancyURLopener’s redirect counter even if there
     is an exception.  Based on patches by Brian Brazil and Daniel
     Rocco.

   - bpo-25945(6): Fixed a crash when unpickle the functools.partial
     object with wrong state.  Fixed a leak in failed functools.partial
     constructor.  “args” and “keywords” attributes of functools.partial
     have now always types tuple and dict correspondingly.

   - bpo-26202(7): copy.deepcopy() now correctly copies range() objects
     with non-atomic attributes.

   - bpo-23076(8): Path.glob() now raises a ValueError if it’s called
     with an invalid pattern.  Patch by Thomas Nyberg.

   - bpo-19883(9): Fixed possible integer overflows in zipimport.

   - bpo-26227(10): On Windows, getnameinfo(), gethostbyaddr() and
     gethostbyname_ex() functions of the socket module now decode the
     hostname from the ANSI code page rather than UTF-8.

   - bpo-26147(11): xmlrpc now works with strings not encodable with
     used non-UTF-8 encoding.

   - bpo-25935(12): Garbage collector now breaks reference loops with
     OrderedDict.

   - bpo-16620(13): Fixed AttributeError in msilib.Directory.glob().

   - bpo-26013(14): Added compatibility with broken protocol 2 pickles
     created in old Python 3 versions (3.4.3 and lower).

   - bpo-25850(15): Use cross-compilation by default for 64-bit Windows.

   - bpo-17633(16): Improve zipimport’s support for namespace packages.

   - bpo-24705(17): Fix sysconfig._parse_makefile not expanding ${} vars
     appearing before $() vars.

   - bpo-22138(18): Fix mock.patch behavior when patching descriptors.
     Restore original values after patching.  Patch contributed by Sean
     McCully.

   - bpo-25672(19): In the ssl module, enable the
     SSL_MODE_RELEASE_BUFFERS mode option if it is safe to do so.

   - bpo-26012(20): Don’t traverse into symlinks for ‘**’ pattern in
     pathlib.Path.[r]glob().

   - bpo-24120(21): Ignore PermissionError when traversing a tree with
     pathlib.Path.[r]glob().  Patch by Ulrich Petri.

   - bpo-25447(22): fileinput now uses sys.stdin as-is if it does not
     have a buffer attribute (restores backward compatibility).

   - bpo-25447(23): Copying the lru_cache() wrapper object now always
     works, independently from the type of the wrapped object (by
     returning the original object unchanged).

   - bpo-24103(24): Fixed possible use after free in
     ElementTree.XMLPullParser.

   - bpo-25860(25): os.fwalk() no longer skips remaining directories
     when error occurs.  Original patch by Samson Lee.

   - bpo-25914(26): Fixed and simplified OrderedDict.__sizeof__.

   - bpo-25902(27): Fixed various refcount issues in ElementTree
     iteration.

   - bpo-25717(28): Restore the previous behaviour of tolerating most
     fstat() errors when opening files.  This was a regression in 3.5a1,
     and stopped anonymous temporary files from working in special
     cases.

   - bpo-24903(29): Fix regression in number of arguments compileall
     accepts when ‘-d’ is specified.  The check on the number of
     arguments has been dropped completely as it never worked correctly
     anyway.

   - bpo-25764(30): In the subprocess module, preserve any exception
     caused by fork() failure when preexec_fn is used.

   - bpo-6478(31): _strptime’s regexp cache now is reset after changing
     timezone with time.tzset().

   - bpo-14285(32): When executing a package with the “python -m
     package” option, and package initialization fails, a proper
     traceback is now reported.  The “runpy” module now lets exceptions
     from package initialization pass back to the caller, rather than
     raising ImportError.

   - bpo-19771(33): Also in runpy and the “-m” option, omit the
     irrelevant message “… is a package and cannot be directly executed”
     if the package could not even be initialized (e.g.  due to a bad
     ‘*.pyc’ file).

   - bpo-25177(34): Fixed problem with the mean of very small and very
     large numbers.  As a side effect, statistics.mean and
     statistics.variance should be significantly faster.

   - bpo-25718(35): Fixed copying object with state with boolean value
     is false.

   - bpo-10131(36): Fixed deep copying of minidom documents.  Based on
     patch by Marian Ganisin.

   - bpo-25725(37): Fixed a reference leak in pickle.loads() when
     unpickling invalid data including tuple instructions.

   - bpo-25663(38): In the Readline completer, avoid listing duplicate
     global names, and search the global namespace before searching
     builtins.

   - bpo-25688(39): Fixed file leak in ElementTree.iterparse() raising
     an error.

   - bpo-23914(40): Fixed SystemError raised by unpickler on broken
     pickle data.

   - bpo-25691(41): Fixed crash on deleting ElementTree.Element
     attributes.

   - bpo-25624(42): ZipFile now always writes a ZIP_STORED header for
     directory entries.  Patch by Dingyuan Wang.

   - Skip getaddrinfo if host is already resolved.  Patch by A. Jesse
     Jiryu Davis.

   - bpo-26050(43): Add asyncio.StreamReader.readuntil() method.  Patch
     by Марк Коренберг.

   - bpo-25924(44): Avoid unnecessary serialization of getaddrinfo(3)
     calls on OS X versions 10.5 or higher.  Original patch by A. Jesse
     Jiryu Davis.

   - bpo-26406(45): Avoid unnecessary serialization of getaddrinfo(3)
     calls on current versions of OpenBSD and NetBSD. Patch by A. Jesse
     Jiryu Davis.

   - bpo-26848(46): Fix asyncio/subprocess.communicate() to handle empty
     input.  Patch by Jack O’Connor.

   - bpo-27040(47): Add loop.get_exception_handler method

   - bpo-27041(48): asyncio: Add loop.create_future method

   - bpo-27223(49): asyncio: Fix _read_ready and _write_ready to respect
     _conn_lost.  Patch by Łukasz Langa.

   - bpo-22970(50): asyncio: Fix inconsistency cancelling
     Condition.wait.  Patch by David Coles.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25995

   (2) https://bugs.python.org/issue26117

   (3) https://bugs.python.org/issue25911

   (4) https://bugs.python.org/issue26045

   (5) https://bugs.python.org/issue12923

   (6) https://bugs.python.org/issue25945

   (7) https://bugs.python.org/issue26202

   (8) https://bugs.python.org/issue23076

   (9) https://bugs.python.org/issue19883

   (10) https://bugs.python.org/issue26227

   (11) https://bugs.python.org/issue26147

   (12) https://bugs.python.org/issue25935

   (13) https://bugs.python.org/issue16620

   (14) https://bugs.python.org/issue26013

   (15) https://bugs.python.org/issue25850

   (16) https://bugs.python.org/issue17633

   (17) https://bugs.python.org/issue24705

   (18) https://bugs.python.org/issue22138

   (19) https://bugs.python.org/issue25672

   (20) https://bugs.python.org/issue26012

   (21) https://bugs.python.org/issue24120

   (22) https://bugs.python.org/issue25447

   (23) https://bugs.python.org/issue25447

   (24) https://bugs.python.org/issue24103

   (25) https://bugs.python.org/issue25860

   (26) https://bugs.python.org/issue25914

   (27) https://bugs.python.org/issue25902

   (28) https://bugs.python.org/issue25717

   (29) https://bugs.python.org/issue24903

   (30) https://bugs.python.org/issue25764

   (31) https://bugs.python.org/issue6478

   (32) https://bugs.python.org/issue14285

   (33) https://bugs.python.org/issue19771

   (34) https://bugs.python.org/issue25177

   (35) https://bugs.python.org/issue25718

   (36) https://bugs.python.org/issue10131

   (37) https://bugs.python.org/issue25725

   (38) https://bugs.python.org/issue25663

   (39) https://bugs.python.org/issue25688

   (40) https://bugs.python.org/issue23914

   (41) https://bugs.python.org/issue25691

   (42) https://bugs.python.org/issue25624

   (43) https://bugs.python.org/issue26050

   (44) https://bugs.python.org/issue25924

   (45) https://bugs.python.org/issue26406

   (46) https://bugs.python.org/issue26848

   (47) https://bugs.python.org/issue27040

   (48) https://bugs.python.org/issue27041

   (49) https://bugs.python.org/issue27223

   (50) https://bugs.python.org/issue22970


File: python.info,  Node: IDLE<36>,  Next: Documentation<36>,  Prev: Library<58>,  Up: Python 3 5 2 release candidate 1

1.18.55.12 IDLE
...............

   - bpo-5124(1): Paste with text selected now replaces the selection on
     X11.  This matches how paste works on Windows, Mac, most modern
     Linux apps, and ttk widgets.  Original patch by Serhiy Storchaka.

   - bpo-24759(2): Make clear in idlelib.idle_test.__init__ that the
     directory is a private implementation of test.test_idle and tool
     for maintainers.

   - bpo-27196(3): Stop ‘ThemeChanged’ warnings when running IDLE tests.
     These persisted after other warnings were suppressed in #20567.
     Apply Serhiy Storchaka’s update_idletasks solution to four test
     files.  Record this additional advice in idle_test/README.txt

   - bpo-20567(4): Revise idle_test/README.txt with advice about
     avoiding tk warning messages from tests.  Apply advice to several
     IDLE tests.

   - bpo-27117(5): Make colorizer htest and turtledemo work with dark
     themes.  Move code for configuring text widget colors to a new
     function.

   - bpo-26673(6): When tk reports font size as 0, change to size 10.
     Such fonts on Linux prevented the configuration dialog from
     opening.

   - bpo-21939(7): Add test for IDLE’s percolator.  Original patch by
     Saimadhav Heblikar.

   - bpo-21676(8): Add test for IDLE’s replace dialog.  Original patch
     by Saimadhav Heblikar.

   - bpo-18410(9): Add test for IDLE’s search dialog.  Original patch by
     Westley Martínez.

   - bpo-21703(10): Add test for IDLE’s undo delegator.  Original patch
     by Saimadhav Heblikar .

   - bpo-27044(11): Add ConfigDialog.remove_var_callbacks to stop memory
     leaks.

   - bpo-23977(12): Add more asserts to test_delegator.

   - bpo-20640(13): Add tests for idlelib.configHelpSourceEdit.  Patch
     by Saimadhav Heblikar.

   - In the ‘IDLE-console differences’ section of the IDLE doc, clarify
     how running with IDLE affects sys.modules and the standard streams.

   - bpo-25507(14): fix incorrect change in IOBinding that prevented
     printing.  Augment IOBinding htest to include all major IOBinding
     functions.

   - bpo-25905(15): Revert unwanted conversion of ‘ to ’ RIGHT SINGLE
     QUOTATION MARK in README.txt and open this and NEWS.txt with
     ‘ascii’.  Re-encode CREDITS.txt to utf-8 and open it with ‘utf-8’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5124

   (2) https://bugs.python.org/issue24759

   (3) https://bugs.python.org/issue27196

   (4) https://bugs.python.org/issue20567

   (5) https://bugs.python.org/issue27117

   (6) https://bugs.python.org/issue26673

   (7) https://bugs.python.org/issue21939

   (8) https://bugs.python.org/issue21676

   (9) https://bugs.python.org/issue18410

   (10) https://bugs.python.org/issue21703

   (11) https://bugs.python.org/issue27044

   (12) https://bugs.python.org/issue23977

   (13) https://bugs.python.org/issue20640

   (14) https://bugs.python.org/issue25507

   (15) https://bugs.python.org/issue25905


File: python.info,  Node: Documentation<36>,  Next: Tests<39>,  Prev: IDLE<36>,  Up: Python 3 5 2 release candidate 1

1.18.55.13 Documentation
........................

   - bpo-19489(1): Moved the search box from the sidebar to the header
     and footer of each page.  Patch by Ammar Askar.

   - bpo-24136(2): Document the new PEP 448(3) unpacking syntax of 3.5.

   - bpo-26736(4): Used HTTPS for external links in the documentation if
     possible.

   - bpo-6953(5): Rework the Readline module documentation to group
     related functions together, and add more details such as what
     underlying Readline functions and variables are accessed.

   - bpo-23606(6): Adds note to ctypes documentation regarding
     cdll.msvcrt.

   - bpo-25500(7): Fix documentation to not claim that __import__ is
     searched for in the global scope.

   - bpo-26014(8): Update 3.x packaging documentation: * “See also”
     links to the new docs are now provided in the legacy pages * links
     to setuptools documentation have been updated

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19489

   (2) https://bugs.python.org/issue24136

   (3) https://www.python.org/dev/peps/pep-0448

   (4) https://bugs.python.org/issue26736

   (5) https://bugs.python.org/issue6953

   (6) https://bugs.python.org/issue23606

   (7) https://bugs.python.org/issue25500

   (8) https://bugs.python.org/issue26014


File: python.info,  Node: Tests<39>,  Next: Build<39>,  Prev: Documentation<36>,  Up: Python 3 5 2 release candidate 1

1.18.55.14 Tests
................

   - bpo-21916(1): Added tests for the turtle module.  Patch by ingrid,
     Gregory Loyse and Jelle Zijlstra.

   - bpo-26523(2): The multiprocessing thread pool
     (multiprocessing.dummy.Pool) was untested.

   - bpo-26015(3): Added new tests for pickling iterators of mutable
     sequences.

   - bpo-26325(4): Added test.support.check_no_resource_warning() to
     check that no ResourceWarning is emitted.

   - bpo-25940(5): Changed test_ssl to use self-signed.pythontest.net.
     This avoids relying on svn.python.org, which recently changed root
     certificate.

   - bpo-25616(6): Tests for OrderedDict are extracted from
     test_collections into separate file test_ordered_dict.

   - bpo-26583(7): Skip test_timestamp_overflow in test_import if
     bytecode files cannot be written.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21916

   (2) https://bugs.python.org/issue26523

   (3) https://bugs.python.org/issue26015

   (4) https://bugs.python.org/issue26325

   (5) https://bugs.python.org/issue25940

   (6) https://bugs.python.org/issue25616

   (7) https://bugs.python.org/issue26583


File: python.info,  Node: Build<39>,  Next: Windows<37>,  Prev: Tests<39>,  Up: Python 3 5 2 release candidate 1

1.18.55.15 Build
................

   - bpo-26884(1): Fix linking extension modules for cross builds.
     Patch by Xavier de Gaye.

   - bpo-22359(2): Disable the rules for running _freeze_importlib and
     pgen when cross-compiling.  The output of these programs is
     normally saved with the source code anyway, and is still
     regenerated when doing a native build.  Patch by Xavier de Gaye.

   - bpo-27229(3): Fix the cross-compiling pgen rule for in-tree builds.
     Patch by Xavier de Gaye.

   - bpo-21668(4): Link audioop, _datetime, _ctypes_test modules to
     libm, except on Mac OS X. Patch written by Xavier de Gaye.

   - bpo-25702(5): A –with-lto configure option has been added that will
     enable link time optimizations at build time during a make
     profile-opt.  Some compilers and toolchains are known to not
     produce stable code when using LTO, be sure to test things
     thoroughly before relying on it.  It can provide a few % speed up
     over profile-opt alone.

   - bpo-26624(6): Adds validation of ucrtbase[d].dll version with
     warning for old versions.

   - bpo-17603(7): Avoid error about nonexistent fileblocks.o file by
     using a lower-level check for st_blocks in struct stat.

   - bpo-26079(8): Fixing the build output folder for tix-8.4.3.6.
     Patch by Bjoern Thiel.

   - bpo-26465(9): Update Windows builds to use OpenSSL 1.0.2g.

   - bpo-24421(10): Compile Modules/_math.c once, before building
     extensions.  Previously it could fail to compile properly if the
     math and cmath builds were concurrent.

   - bpo-25348(11): Added ‘--pgo’ and ‘--pgo-job’ arguments to
     ‘PCbuild\build.bat’ for building with Profile-Guided Optimization.
     The old ‘PCbuild\build_pgo.bat’ script is now deprecated, and
     simply calls ‘PCbuild\build.bat --pgo %*’.

   - bpo-25827(12): Add support for building with ICC to ‘configure’,
     including a new ‘--with-icc’ flag.

   - bpo-25696(13): Fix installation of Python on UNIX with make -j9.

   - bpo-26930(14): Update OS X 10.5+ 32-bit-only installer to build and
     link with OpenSSL 1.0.2h.

   - bpo-26268(15): Update Windows builds to use OpenSSL 1.0.2f.

   - bpo-25136(16): Support Apple Xcode 7’s new textual SDK stub
     libraries.

   - bpo-24324(17): Do not enable unreachable code warnings when using
     gcc as the option does not work correctly in older versions of gcc
     and has been silently removed as of gcc-4.5.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26884

   (2) https://bugs.python.org/issue22359

   (3) https://bugs.python.org/issue27229

   (4) https://bugs.python.org/issue21668

   (5) https://bugs.python.org/issue25702

   (6) https://bugs.python.org/issue26624

   (7) https://bugs.python.org/issue17603

   (8) https://bugs.python.org/issue26079

   (9) https://bugs.python.org/issue26465

   (10) https://bugs.python.org/issue24421

   (11) https://bugs.python.org/issue25348

   (12) https://bugs.python.org/issue25827

   (13) https://bugs.python.org/issue25696

   (14) https://bugs.python.org/issue26930

   (15) https://bugs.python.org/issue26268

   (16) https://bugs.python.org/issue25136

   (17) https://bugs.python.org/issue24324


File: python.info,  Node: Windows<37>,  Next: Tools/Demos<27>,  Prev: Build<39>,  Up: Python 3 5 2 release candidate 1

1.18.55.16 Windows
..................

   - bpo-27053(1): Updates make_zip.py to correctly generate library ZIP
     file.

   - bpo-26268(2): Update the prepare_ssl.py script to handle OpenSSL
     releases that don’t include the contents of the include directory
     (that is, 1.0.2e and later).

   - bpo-26071(3): bdist_wininst created binaries fail to start and find
     32bit Python

   - bpo-26073(4): Update the list of magic numbers in launcher

   - bpo-26065(5): Excludes venv from library when generating embeddable
     distro.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue27053

   (2) https://bugs.python.org/issue26268

   (3) https://bugs.python.org/issue26071

   (4) https://bugs.python.org/issue26073

   (5) https://bugs.python.org/issue26065


File: python.info,  Node: Tools/Demos<27>,  Next: Windows<38>,  Prev: Windows<37>,  Up: Python 3 5 2 release candidate 1

1.18.55.17 Tools/Demos
......................

   - bpo-26799(1): Fix python-gdb.py: don’t get C types once when the
     Python code is loaded, but get C types on demand.  The C types can
     change if python-gdb.py is loaded before the Python executable.
     Patch written by Thomas Ilsche.

   - bpo-26271(2): Fix the Freeze tool to properly use flags passed
     through configure.  Patch by Daniel Shaulov.

   - bpo-26489(3): Add dictionary unpacking support to
     Tools/parser/unparse.py.  Patch by Guo Ci Teo.

   - bpo-26316(4): Fix variable name typo in Argument Clinic.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue26799

   (2) https://bugs.python.org/issue26271

   (3) https://bugs.python.org/issue26489

   (4) https://bugs.python.org/issue26316


File: python.info,  Node: Windows<38>,  Prev: Tools/Demos<27>,  Up: Python 3 5 2 release candidate 1

1.18.55.18 Windows
..................

   - bpo-17500(1): Remove unused and outdated icons.  (See also:
     ‘https://github.com/python/pythondotorg/issues/945’)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue17500


File: python.info,  Node: Python 3 5 1 final,  Next: Python 3 5 1 release candidate 1,  Prev: Python 3 5 2 release candidate 1,  Up: Changelog

1.18.56 Python 3.5.1 final
--------------------------

`Release date: 2015-12-06'

* Menu:

* Core and Builtins: Core and Builtins<45>.
* Windows: Windows<39>.


File: python.info,  Node: Core and Builtins<45>,  Next: Windows<39>,  Up: Python 3 5 1 final

1.18.56.1 Core and Builtins
...........................

   - bpo-25709(1): Fixed problem with in-place string concatenation and
     utf-8 cache.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25709


File: python.info,  Node: Windows<39>,  Prev: Core and Builtins<45>,  Up: Python 3 5 1 final

1.18.56.2 Windows
.................

   - bpo-25715(1): Python 3.5.1 installer shows wrong upgrade path and
     incorrect logic for launcher detection.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25715


File: python.info,  Node: Python 3 5 1 release candidate 1,  Next: Python 3 5 0 final,  Prev: Python 3 5 1 final,  Up: Changelog

1.18.57 Python 3.5.1 release candidate 1
----------------------------------------

`Release date: 2015-11-22'

* Menu:

* Core and Builtins: Core and Builtins<46>.
* Library: Library<59>.
* IDLE: IDLE<37>.
* Documentation: Documentation<37>.
* Tests: Tests<40>.
* Build: Build<40>.
* Windows: Windows<40>.
* Tools/Demos: Tools/Demos<28>.


File: python.info,  Node: Core and Builtins<46>,  Next: Library<59>,  Up: Python 3 5 1 release candidate 1

1.18.57.1 Core and Builtins
...........................

   - bpo-25630(1): Fix a possible segfault during argument parsing in
     functions that accept filesystem paths.

   - bpo-23564(2): Fixed a partially broken sanity check in the
     _posixsubprocess internals regarding how fds_to_pass were passed to
     the child.  The bug had no actual impact as subprocess.py already
     avoided it.

   - bpo-25388(3): Fixed tokenizer crash when processing undecodable
     source code with a null byte.

   - bpo-25462(4): The hash of the key now is calculated only once in
     most operations in C implementation of OrderedDict.

   - bpo-22995(5): Default implementation of __reduce__ and
     __reduce_ex__ now rejects builtin types with not defined __new__.

   - bpo-25555(6): Fix parser and AST: fill lineno and col_offset of
     “arg” node when compiling AST from Python objects.

   - bpo-24802(7): Avoid buffer overreads when int(), float(),
     compile(), exec() and eval() are passed bytes-like objects.  These
     objects are not necessarily terminated by a null byte, but the
     functions assumed they were.

   - bpo-24726(8): Fixed a crash and leaking NULL in repr() of
     OrderedDict that was mutated by direct calls of dict methods.

   - bpo-25449(9): Iterating OrderedDict with keys with unstable hash
     now raises KeyError in C implementations as well as in Python
     implementation.

   - bpo-25395(10): Fixed crash when highly nested OrderedDict
     structures were garbage collected.

   - bpo-25274(11): sys.setrecursionlimit() now raises a RecursionError
     if the new recursion limit is too low depending at the current
     recursion depth.  Modify also the “lower-water mark” formula to
     make it monotonic.  This mark is used to decide when the overflowed
     flag of the thread state is reset.

   - bpo-24402(12): Fix input() to prompt to the redirected stdout when
     sys.stdout.fileno() fails.

   - bpo-24806(13): Prevent builtin types that are not allowed to be
     subclassed from being subclassed through multiple inheritance.

   - bpo-24848(14): Fixed a number of bugs in UTF-7 decoding of
     misformed data.

   - bpo-25280(15): Import trace messages emitted in verbose (-v) mode
     are no longer formatted twice.

   - bpo-25003(16): On Solaris 11.3 or newer, os.urandom() now uses the
     getrandom() function instead of the getentropy() function.  The
     getentropy() function is blocking to generate very good quality
     entropy, os.urandom() doesn’t need such high-quality entropy.

   - bpo-25182(17): The stdprinter (used as sys.stderr before the io
     module is imported at startup) now uses the backslashreplace error
     handler.

   - bpo-25131(18): Make the line number and column offset of set/dict
     literals and comprehensions correspond to the opening brace.

   - bpo-25150(19): Hide the private _Py_atomic_xxx symbols from the
     public Python.h header to fix a compilation error with OpenMP.
     PyThreadState_GET() becomes an alias to PyThreadState_Get() to
     avoid ABI incompatibilities.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25630

   (2) https://bugs.python.org/issue23564

   (3) https://bugs.python.org/issue25388

   (4) https://bugs.python.org/issue25462

   (5) https://bugs.python.org/issue22995

   (6) https://bugs.python.org/issue25555

   (7) https://bugs.python.org/issue24802

   (8) https://bugs.python.org/issue24726

   (9) https://bugs.python.org/issue25449

   (10) https://bugs.python.org/issue25395

   (11) https://bugs.python.org/issue25274

   (12) https://bugs.python.org/issue24402

   (13) https://bugs.python.org/issue24806

   (14) https://bugs.python.org/issue24848

   (15) https://bugs.python.org/issue25280

   (16) https://bugs.python.org/issue25003

   (17) https://bugs.python.org/issue25182

   (18) https://bugs.python.org/issue25131

   (19) https://bugs.python.org/issue25150


File: python.info,  Node: Library<59>,  Next: IDLE<37>,  Prev: Core and Builtins<46>,  Up: Python 3 5 1 release candidate 1

1.18.57.2 Library
.................

   - bpo-25626(1): Change three zlib functions to accept sizes that fit
     in Py_ssize_t, but internally cap those sizes to UINT_MAX. This
     resolves a regression in 3.5 where GzipFile.read() failed to read
     chunks larger than 2 or 4 GiB. The change affects the
     zlib.Decompress.decompress() max_length parameter, the
     zlib.decompress() bufsize parameter, and the
     zlib.Decompress.flush() length parameter.

   - bpo-25583(2): Avoid incorrect errors raised by
     os.makedirs(exist_ok=True) when the OS gives priority to errors
     such as EACCES over EEXIST.

   - bpo-25593(3): Change semantics of EventLoop.stop() in asyncio.

   - bpo-6973(4): When we know a subprocess.Popen process has died, do
     not allow the send_signal(), terminate(), or kill() methods to do
     anything as they could potentially signal a different process.

   - bpo-25590(5): In the Readline completer, only call getattr() once
     per attribute.

   - bpo-25498(6): Fix a crash when garbage-collecting ctypes objects
     created by wrapping a memoryview.  This was a regression made in
     3.5a1.  Based on patch by Eryksun.

   - bpo-25584(7): Added “escape” to the __all__ list in the glob
     module.

   - bpo-25584(8): Fixed recursive glob() with patterns starting with
     ‘**’.

   - bpo-25446(9): Fix regression in smtplib’s AUTH LOGIN support.

   - bpo-18010(10): Fix the pydoc web server’s module search function to
     handle exceptions from importing packages.

   - bpo-25554(11): Got rid of circular references in regular expression
     parsing.

   - bpo-25510(12): fileinput.FileInput.readline() now returns b’’
     instead of ‘’ at the end if the FileInput was opened with binary
     mode.  Patch by Ryosuke Ito.

   - bpo-25503(13): Fixed inspect.getdoc() for inherited docstrings of
     properties.  Original patch by John Mark Vandenberg.

   - bpo-25515(14): Always use os.urandom as a source of randomness in
     uuid.uuid4.

   - bpo-21827(15): Fixed textwrap.dedent() for the case when largest
     common whitespace is a substring of smallest leading whitespace.
     Based on patch by Robert Li.

   - bpo-25447(16): The lru_cache() wrapper objects now can be copied
     and pickled (by returning the original object unchanged).

   - bpo-25390(17): typing: Don’t crash on Union[str, Pattern].

   - bpo-25441(18): asyncio: Raise error from drain() when socket is
     closed.

   - bpo-25410(19): Cleaned up and fixed minor bugs in C implementation
     of OrderedDict.

   - bpo-25411(20): Improved Unicode support in SMTPHandler through
     better use of the email package.  Thanks to user simon04 for the
     patch.

   - bpo-25407(21): Remove mentions of the formatter module being
     removed in Python 3.6.

   - bpo-25406(22): Fixed a bug in C implementation of
     OrderedDict.move_to_end() that caused segmentation fault or hang in
     iterating after moving several items to the start of ordered dict.

   - bpo-25364(23): zipfile now works in threads disabled builds.

   - bpo-25328(24): smtpd’s SMTPChannel now correctly raises a
     ValueError if both decode_data and enable_SMTPUTF8 are set to true.

   - bpo-25316(25): distutils raises OSError instead of
     DistutilsPlatformError when MSVC is not installed.

   - bpo-25380(26): Fixed protocol for the STACK_GLOBAL opcode in
     pickletools.opcodes.

   - bpo-23972(27): Updates asyncio datagram create method allowing
     reuseport and reuseaddr socket options to be set prior to binding
     the socket.  Mirroring the existing asyncio create_server method
     the reuseaddr option for datagram sockets defaults to True if the
     O/S is ‘posix’ (except if the platform is Cygwin).  Patch by Chris
     Laws.

   - bpo-25304(28): Add asyncio.run_coroutine_threadsafe().  This lets
     you submit a coroutine to a loop from another thread, returning a
     concurrent.futures.Future.  By Vincent Michel.

   - bpo-25232(29): Fix CGIRequestHandler to split the query from the
     URL at the first question mark (?)  rather than the last.  Patch
     from Xiang Zhang.

   - bpo-24657(30): Prevent CGIRequestHandler from collapsing slashes in
     the query part of the URL as if it were a path.  Patch from Xiang
     Zhang.

   - bpo-24483(31): C implementation of functools.lru_cache() now
     calculates key’s hash only once.

   - bpo-22958(32): Constructor and update method of
     weakref.WeakValueDictionary now accept the self and the dict
     keyword arguments.

   - bpo-22609(33): Constructor of collections.UserDict now accepts the
     self keyword argument.

   - bpo-25111(34): Fixed comparison of traceback.FrameSummary.

   - bpo-25262(35): Added support for BINBYTES8 opcode in Python
     implementation of unpickler.  Highest 32 bits of 64-bit size for
     BINUNICODE8 and BINBYTES8 opcodes no longer silently ignored on
     32-bit platforms in C implementation.

   - bpo-25034(36): Fix string.Formatter problem with auto-numbering and
     nested format_specs.  Patch by Anthon van der Neut.

   - bpo-25233(37): Rewrite the guts of asyncio.Queue and
     asyncio.Semaphore to be more understandable and correct.

   - bpo-25203(38): Failed readline.set_completer_delims() no longer
     left the module in inconsistent state.

   - bpo-23600(39): Default implementation of tzinfo.fromutc() was
     returning wrong results in some cases.

   - bpo-23329(40): Allow the ssl module to be built with older versions
     of LibreSSL.

   - Prevent overflow in _Unpickler_Read.

   - bpo-25047(41): The XML encoding declaration written by Element Tree
     now respects the letter case given by the user.  This restores the
     ability to write encoding names in uppercase like “UTF-8”, which
     worked in Python 2.

   - bpo-25135(42): Make deque_clear() safer by emptying the deque
     before clearing.  This helps avoid possible reentrancy issues.

   - bpo-19143(43): platform module now reads Windows version from
     kernel32.dll to avoid compatibility shims.

   - bpo-25092(44): Fix datetime.strftime() failure when errno was
     already set to EINVAL.

   - bpo-23517(45): Fix rounding in fromtimestamp() and
     utcfromtimestamp() methods of datetime.datetime: microseconds are
     now rounded to nearest with ties going to nearest even integer
     (ROUND_HALF_EVEN), instead of being rounding towards minus infinity
     (ROUND_FLOOR). It’s important that these methods use the same
     rounding mode than datetime.timedelta to keep the property:
     (datetime(1970,1,1) + timedelta(seconds=t)) ==
     datetime.utcfromtimestamp(t).  It also the rounding mode used by
     round(float) for example.

   - bpo-25155(46): Fix datetime.datetime.now() and
     datetime.datetime.utcnow() on Windows to support date after year
     2038.  It was a regression introduced in Python 3.5.0.

   - bpo-25108(47): Omitted internal frames in traceback functions
     print_stack(), format_stack(), and extract_stack() called without
     arguments.

   - bpo-25118(48): Fix a regression of Python 3.5.0 in os.waitpid() on
     Windows.

   - bpo-24684(49): socket.socket.getaddrinfo() now calls
     PyUnicode_AsEncodedString() instead of calling the encode() method
     of the host, to handle correctly custom string with an encode()
     method which doesn’t return a byte string.  The encoder of the IDNA
     codec is now called directly instead of calling the encode() method
     of the string.

   - bpo-25060(50): Correctly compute stack usage of the BUILD_MAP
     opcode.

   - bpo-24857(51): Comparing call_args to a long sequence now correctly
     returns a boolean result instead of raising an exception.  Patch by
     A Kaptur.

   - bpo-23144(52): Make sure that HTMLParser.feed() returns all the
     data, even when convert_charrefs is True.

   - bpo-24982(53): shutil.make_archive() with the “zip” format now adds
     entries for directories (including empty directories) in ZIP file.

   - bpo-25019(54): Fixed a crash caused by setting non-string key of
     expat parser.  Based on patch by John Leitch.

   - bpo-16180(55): Exit pdb if file has syntax error, instead of
     trapping user in an infinite loop.  Patch by Xavier de Gaye.

   - bpo-24891(56): Fix a race condition at Python startup if the file
     descriptor of stdin (0), stdout (1) or stderr (2) is closed while
     Python is creating sys.stdin, sys.stdout and sys.stderr objects.
     These attributes are now set to None if the creation of the object
     failed, instead of raising an OSError exception.  Initial patch
     written by Marco Paolini.

   - bpo-24992(57): Fix error handling and a race condition (related to
     garbage collection) in collections.OrderedDict constructor.

   - bpo-24881(58): Fixed setting binary mode in Python implementation
     of FileIO on Windows and Cygwin.  Patch from Akira Li.

   - bpo-25578(59): Fix (another) memory leak in SSLSocket.getpeercer().

   - bpo-25530(60): Disable the vulnerable SSLv3 protocol by default
     when creating ssl.SSLContext.

   - bpo-25569(61): Fix memory leak in SSLSocket.getpeercert().

   - bpo-25471(62): Sockets returned from accept() shouldn’t appear to
     be nonblocking.

   - bpo-25319(63): When threading.Event is reinitialized, the
     underlying condition should use a regular lock rather than a
     recursive lock.

   - bpo-21112(64): Fix regression in unittest.expectedFailure on
     subclasses.  Patch from Berker Peksag.

   - bpo-24764(65): cgi.FieldStorage.read_multi() now ignores the
     Content-Length header in part headers.  Patch written by Peter
     Landry and reviewed by Pierre Quentel.

   - bpo-24913(66): Fix overrun error in deque.index().  Found by John
     Leitch and Bryce Darling.

   - bpo-24774(67): Fix docstring in http.server.test.  Patch from
     Chiu-Hsiang Hsu.

   - bpo-21159(68): Improve message in
     configparser.InterpolationMissingOptionError.  Patch from Łukasz
     Langa.

   - bpo-20362(69): Honour TestCase.longMessage correctly in
     assertRegex.  Patch from Ilia Kurenkov.

   - bpo-23572(70): Fixed functools.singledispatch on classes with falsy
     metaclasses.  Patch by Ethan Furman.

   - asyncio: ensure_future() now accepts awaitable objects.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25626

   (2) https://bugs.python.org/issue25583

   (3) https://bugs.python.org/issue25593

   (4) https://bugs.python.org/issue6973

   (5) https://bugs.python.org/issue25590

   (6) https://bugs.python.org/issue25498

   (7) https://bugs.python.org/issue25584

   (8) https://bugs.python.org/issue25584

   (9) https://bugs.python.org/issue25446

   (10) https://bugs.python.org/issue18010

   (11) https://bugs.python.org/issue25554

   (12) https://bugs.python.org/issue25510

   (13) https://bugs.python.org/issue25503

   (14) https://bugs.python.org/issue25515

   (15) https://bugs.python.org/issue21827

   (16) https://bugs.python.org/issue25447

   (17) https://bugs.python.org/issue25390

   (18) https://bugs.python.org/issue25441

   (19) https://bugs.python.org/issue25410

   (20) https://bugs.python.org/issue25411

   (21) https://bugs.python.org/issue25407

   (22) https://bugs.python.org/issue25406

   (23) https://bugs.python.org/issue25364

   (24) https://bugs.python.org/issue25328

   (25) https://bugs.python.org/issue25316

   (26) https://bugs.python.org/issue25380

   (27) https://bugs.python.org/issue23972

   (28) https://bugs.python.org/issue25304

   (29) https://bugs.python.org/issue25232

   (30) https://bugs.python.org/issue24657

   (31) https://bugs.python.org/issue24483

   (32) https://bugs.python.org/issue22958

   (33) https://bugs.python.org/issue22609

   (34) https://bugs.python.org/issue25111

   (35) https://bugs.python.org/issue25262

   (36) https://bugs.python.org/issue25034

   (37) https://bugs.python.org/issue25233

   (38) https://bugs.python.org/issue25203

   (39) https://bugs.python.org/issue23600

   (40) https://bugs.python.org/issue23329

   (41) https://bugs.python.org/issue25047

   (42) https://bugs.python.org/issue25135

   (43) https://bugs.python.org/issue19143

   (44) https://bugs.python.org/issue25092

   (45) https://bugs.python.org/issue23517

   (46) https://bugs.python.org/issue25155

   (47) https://bugs.python.org/issue25108

   (48) https://bugs.python.org/issue25118

   (49) https://bugs.python.org/issue24684

   (50) https://bugs.python.org/issue25060

   (51) https://bugs.python.org/issue24857

   (52) https://bugs.python.org/issue23144

   (53) https://bugs.python.org/issue24982

   (54) https://bugs.python.org/issue25019

   (55) https://bugs.python.org/issue16180

   (56) https://bugs.python.org/issue24891

   (57) https://bugs.python.org/issue24992

   (58) https://bugs.python.org/issue24881

   (59) https://bugs.python.org/issue25578

   (60) https://bugs.python.org/issue25530

   (61) https://bugs.python.org/issue25569

   (62) https://bugs.python.org/issue25471

   (63) https://bugs.python.org/issue25319

   (64) https://bugs.python.org/issue21112

   (65) https://bugs.python.org/issue24764

   (66) https://bugs.python.org/issue24913

   (67) https://bugs.python.org/issue24774

   (68) https://bugs.python.org/issue21159

   (69) https://bugs.python.org/issue20362

   (70) https://bugs.python.org/issue23572


File: python.info,  Node: IDLE<37>,  Next: Documentation<37>,  Prev: Library<59>,  Up: Python 3 5 1 release candidate 1

1.18.57.3 IDLE
..............

   - bpo-15348(1): Stop the debugger engine (normally in a user process)
     before closing the debugger window (running in the IDLE process).
     This prevents the RuntimeErrors that were being caught and ignored.

   - bpo-24455(2): Prevent IDLE from hanging when a) closing the shell
     while the debugger is active (15347); b) closing the debugger with
     the [X] button (15348); and c) activating the debugger when already
     active (24455).  The patch by Mark Roseman does this by making two
     changes.  1.  Suspend and resume the gui.interaction method with
     the tcl vwait mechanism intended for this purpose (instead of
     root.mainloop & .quit).  2.  In gui.run, allow any existing
     interaction to terminate first.

   - Change ‘The program’ to ‘Your program’ in an IDLE ‘kill program?’
     message to make it clearer that the program referred to is the
     currently running user program, not IDLE itself.

   - bpo-24750(3): Improve the appearance of the IDLE editor window
     status bar.  Patch by Mark Roseman.

   - bpo-25313(4): Change the handling of new built-in text color themes
     to better address the compatibility problem introduced by the
     addition of IDLE Dark.  Consistently use the revised
     idleConf.CurrentTheme everywhere in idlelib.

   - bpo-24782(5): Extension configuration is now a tab in the IDLE
     Preferences dialog rather than a separate dialog.  The former tabs
     are now a sorted list.  Patch by Mark Roseman.

   - bpo-22726(6): Re-activate the config dialog help button with some
     content about the other buttons and the new IDLE Dark theme.

   - bpo-24820(7): IDLE now has an ‘IDLE Dark’ built-in text color
     theme.  It is more or less IDLE Classic inverted, with a cobalt
     blue background.  Strings, comments, keywords, … are still green,
     red, orange, … .  To use it with IDLEs released before November
     2015, hit the ‘Save as New Custom Theme’ button and enter a new
     name, such as ‘Custom Dark’.  The custom theme will work with any
     IDLE release, and can be modified.

   - bpo-25224(8): README.txt is now an idlelib index for IDLE
     developers and curious users.  The previous user content is now in
     the IDLE doc chapter.  ‘IDLE’ now means ‘Integrated Development and
     Learning Environment’.

   - bpo-24820(9): Users can now set breakpoint colors in Settings ->
     Custom Highlighting.  Original patch by Mark Roseman.

   - bpo-24972(10): Inactive selection background now matches active
     selection background, as configured by users, on all systems.
     Found items are now always highlighted on Windows.  Initial patch
     by Mark Roseman.

   - bpo-24570(11): Idle: make calltip and completion boxes appear on
     Macs affected by a tk regression.  Initial patch by Mark Roseman.

   - bpo-24988(12): Idle ScrolledList context menus (used in debugger)
     now work on Mac Aqua.  Patch by Mark Roseman.

   - bpo-24801(13): Make right-click for context menu work on Mac Aqua.
     Patch by Mark Roseman.

   - bpo-25173(14): Associate tkinter messageboxes with a specific
     widget.  For Mac OSX, make them a ‘sheet’.  Patch by Mark Roseman.

   - bpo-25198(15): Enhance the initial html viewer now used for Idle
     Help.  Properly indent fixed-pitch text (patch by Mark Roseman).
     Give code snippet a very Sphinx-like light blueish-gray background.
     Re-use initial width and height set by users for shell and editor.
     When the Table of Contents (TOC) menu is used, put the section
     header at the top of the screen.

   - bpo-25225(16): Condense and rewrite Idle doc section on text
     colors.

   - bpo-21995(17): Explain some differences between IDLE and console
     Python.

   - bpo-22820(18): Explain need for `print' when running file from Idle
     editor.

   - bpo-25224(19): Doc: augment Idle feature list and no-subprocess
     section.

   - bpo-25219(20): Update doc for Idle command line options.  Some were
     missing and notes were not correct.

   - bpo-24861(21): Most of idlelib is private and subject to change.
     Use idleib.idle.* to start Idle.  See idlelib.__init__.__doc__.

   - bpo-25199(22): Idle: add synchronization comments for future
     maintainers.

   - bpo-16893(23): Replace help.txt with help.html for Idle doc
     display.  The new idlelib/help.html is rstripped
     Doc/build/html/library/idle.html.  It looks better than help.txt
     and will better document Idle as released.  The tkinter html viewer
     that works for this file was written by Mark Roseman.  The now
     unused EditorWindow.HelpDialog class and helt.txt file are
     deprecated.

   - bpo-24199(24): Deprecate unused idlelib.idlever with possible
     removal in 3.6.

   - bpo-24790(25): Remove extraneous code (which also create 2 & 3
     conflicts).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15348

   (2) https://bugs.python.org/issue24455

   (3) https://bugs.python.org/issue24750

   (4) https://bugs.python.org/issue25313

   (5) https://bugs.python.org/issue24782

   (6) https://bugs.python.org/issue22726

   (7) https://bugs.python.org/issue24820

   (8) https://bugs.python.org/issue25224

   (9) https://bugs.python.org/issue24820

   (10) https://bugs.python.org/issue24972

   (11) https://bugs.python.org/issue24570

   (12) https://bugs.python.org/issue24988

   (13) https://bugs.python.org/issue24801

   (14) https://bugs.python.org/issue25173

   (15) https://bugs.python.org/issue25198

   (16) https://bugs.python.org/issue25225

   (17) https://bugs.python.org/issue21995

   (18) https://bugs.python.org/issue22820

   (19) https://bugs.python.org/issue25224

   (20) https://bugs.python.org/issue25219

   (21) https://bugs.python.org/issue24861

   (22) https://bugs.python.org/issue25199

   (23) https://bugs.python.org/issue16893

   (24) https://bugs.python.org/issue24199

   (25) https://bugs.python.org/issue24790


File: python.info,  Node: Documentation<37>,  Next: Tests<40>,  Prev: IDLE<37>,  Up: Python 3 5 1 release candidate 1

1.18.57.4 Documentation
.......................

   - bpo-22558(1): Add remaining doc links to source code for
     Python-coded modules.  Patch by Yoni Lavi.

   - bpo-12067(2): Rewrite Comparisons section in the Expressions
     chapter of the language reference.  Some of the details of
     comparing mixed types were incorrect or ambiguous.  NotImplemented
     is only relevant at a lower level than the Expressions chapter.
     Added details of comparing range() objects, and default behaviour
     and consistency suggestions for user-defined classes.  Patch from
     Andy Maier.

   - bpo-24952(3): Clarify the default size argument of stack_size() in
     the “threading” and “_thread” modules.  Patch from Mattip.

   - bpo-23725(4): Overhaul tempfile docs.  Note deprecated status of
     mktemp.  Patch from Zbigniew Jędrzejewski-Szmek.

   - bpo-24808(5): Update the types of some PyTypeObject fields.  Patch
     by Joseph Weston.

   - bpo-22812(6): Fix unittest discovery examples.  Patch from Pam
     McA’Nulty.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22558

   (2) https://bugs.python.org/issue12067

   (3) https://bugs.python.org/issue24952

   (4) https://bugs.python.org/issue23725

   (5) https://bugs.python.org/issue24808

   (6) https://bugs.python.org/issue22812


File: python.info,  Node: Tests<40>,  Next: Build<40>,  Prev: Documentation<37>,  Up: Python 3 5 1 release candidate 1

1.18.57.5 Tests
...............

   - bpo-25449(1): Added tests for OrderedDict subclasses.

   - bpo-25099(2): Make test_compileall not fail when an entry on
     sys.path cannot be written to (commonly seen in administrative
     installs on Windows).

   - bpo-23919(3): Prevents assert dialogs appearing in the test suite.

   - ‘PCbuild\rt.bat’ now accepts an unlimited number of arguments to
     pass along to regrtest.py.  Previously there was a limit of 9.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25449

   (2) https://bugs.python.org/issue25099

   (3) https://bugs.python.org/issue23919


File: python.info,  Node: Build<40>,  Next: Windows<40>,  Prev: Tests<40>,  Up: Python 3 5 1 release candidate 1

1.18.57.6 Build
...............

   - bpo-24915(1): Add LLVM support for PGO builds and use the test
     suite to generate the profile data.  Initial patch by Alecsandru
     Patrascu of Intel.

   - bpo-24910(2): Windows MSIs now have unique display names.

   - bpo-24986(3): It is now possible to build Python on Windows without
     errors when external libraries are not available.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24915

   (2) https://bugs.python.org/issue24910

   (3) https://bugs.python.org/issue24986


File: python.info,  Node: Windows<40>,  Next: Tools/Demos<28>,  Prev: Build<40>,  Up: Python 3 5 1 release candidate 1

1.18.57.7 Windows
.................

   - bpo-25450(1): Updates shortcuts to start Python in installation
     directory.

   - bpo-25164(2): Changes default all-users install directory to match
     per-user directory.

   - bpo-25143(3): Improves installer error messages for unsupported
     platforms.

   - bpo-25163(4): Display correct directory in installer when using
     non-default settings.

   - bpo-25361(5): Disables use of SSE2 instructions in Windows 32-bit
     build

   - bpo-25089(6): Adds logging to installer for case where launcher is
     not selected on upgrade.

   - bpo-25165(7): Windows uninstallation should not remove launcher if
     other versions remain

   - bpo-25112(8): py.exe launcher is missing icons

   - bpo-25102(9): Windows installer does not precompile for -O or -OO.

   - bpo-25081(10): Makes Back button in installer go back to upgrade
     page when upgrading.

   - bpo-25091(11): Increases font size of the installer.

   - bpo-25126(12): Clarifies that the non-web installer will download
     some components.

   - bpo-25213(13): Restores requestedExecutionLevel to manifest to
     disable UAC virtualization.

   - bpo-25022(14): Removed very outdated PC/example_nt/ directory.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25450

   (2) https://bugs.python.org/issue25164

   (3) https://bugs.python.org/issue25143

   (4) https://bugs.python.org/issue25163

   (5) https://bugs.python.org/issue25361

   (6) https://bugs.python.org/issue25089

   (7) https://bugs.python.org/issue25165

   (8) https://bugs.python.org/issue25112

   (9) https://bugs.python.org/issue25102

   (10) https://bugs.python.org/issue25081

   (11) https://bugs.python.org/issue25091

   (12) https://bugs.python.org/issue25126

   (13) https://bugs.python.org/issue25213

   (14) https://bugs.python.org/issue25022


File: python.info,  Node: Tools/Demos<28>,  Prev: Windows<40>,  Up: Python 3 5 1 release candidate 1

1.18.57.8 Tools/Demos
.....................

   - bpo-25440(1): Fix output of python-config –extension-suffix.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25440


File: python.info,  Node: Python 3 5 0 final,  Next: Python 3 5 0 release candidate 4,  Prev: Python 3 5 1 release candidate 1,  Up: Changelog

1.18.58 Python 3.5.0 final
--------------------------

`Release date: 2015-09-13'

* Menu:

* Build: Build<41>.


File: python.info,  Node: Build<41>,  Up: Python 3 5 0 final

1.18.58.1 Build
...............

   - bpo-25071(1): Windows installer should not require TargetDir
     parameter when installing quietly.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25071


File: python.info,  Node: Python 3 5 0 release candidate 4,  Next: Python 3 5 0 release candidate 3,  Prev: Python 3 5 0 final,  Up: Changelog

1.18.59 Python 3.5.0 release candidate 4
----------------------------------------

`Release date: 2015-09-09'

* Menu:

* Library: Library<60>.
* Build: Build<42>.


File: python.info,  Node: Library<60>,  Next: Build<42>,  Up: Python 3 5 0 release candidate 4

1.18.59.1 Library
.................

   - bpo-25029(1): Fixes MemoryError in test_strptime.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25029


File: python.info,  Node: Build<42>,  Prev: Library<60>,  Up: Python 3 5 0 release candidate 4

1.18.59.2 Build
...............

   - bpo-25027(1): Reverts partial-static build options and adds
     vcruntime140.dll to Windows installation.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue25027


File: python.info,  Node: Python 3 5 0 release candidate 3,  Next: Python 3 5 0 release candidate 2,  Prev: Python 3 5 0 release candidate 4,  Up: Changelog

1.18.60 Python 3.5.0 release candidate 3
----------------------------------------

`Release date: 2015-09-07'

* Menu:

* Core and Builtins: Core and Builtins<47>.
* Library: Library<61>.


File: python.info,  Node: Core and Builtins<47>,  Next: Library<61>,  Up: Python 3 5 0 release candidate 3

1.18.60.1 Core and Builtins
...........................

   - bpo-24305(1): Prevent import subsystem stack frames from being
     counted by the warnings.warn(stacklevel=) parameter.

   - bpo-24912(2): Prevent __class__ assignment to immutable built-in
     objects.

   - bpo-24975(3): Fix AST compilation for PEP 448(4) syntax.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24305

   (2) https://bugs.python.org/issue24912

   (3) https://bugs.python.org/issue24975

   (4) https://www.python.org/dev/peps/pep-0448


File: python.info,  Node: Library<61>,  Prev: Core and Builtins<47>,  Up: Python 3 5 0 release candidate 3

1.18.60.2 Library
.................

   - bpo-24917(1): time_strftime() buffer over-read.

   - bpo-24748(2): To resolve a compatibility problem found with py2exe
     and pywin32, imp.load_dynamic() once again ignores previously
     loaded modules to support Python modules replacing themselves with
     extension modules.  Patch by Petr Viktorin.

   - bpo-24635(3): Fixed a bug in typing.py where isinstance([],
     typing.Iterable) would return True once, then False on subsequent
     calls.

   - bpo-24989(4): Fixed buffer overread in BytesIO.readline() if a
     position is set beyond size.  Based on patch by John Leitch.

   - bpo-24913(5): Fix overrun error in deque.index().  Found by John
     Leitch and Bryce Darling.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24917

   (2) https://bugs.python.org/issue24748

   (3) https://bugs.python.org/issue24635

   (4) https://bugs.python.org/issue24989

   (5) https://bugs.python.org/issue24913


File: python.info,  Node: Python 3 5 0 release candidate 2,  Next: Python 3 5 0 release candidate 1,  Prev: Python 3 5 0 release candidate 3,  Up: Changelog

1.18.61 Python 3.5.0 release candidate 2
----------------------------------------

`Release date: 2015-08-25'

* Menu:

* Core and Builtins: Core and Builtins<48>.
* Library: Library<62>.


File: python.info,  Node: Core and Builtins<48>,  Next: Library<62>,  Up: Python 3 5 0 release candidate 2

1.18.61.1 Core and Builtins
...........................

   - bpo-24769(1): Interpreter now starts properly when dynamic loading
     is disabled.  Patch by Petr Viktorin.

   - bpo-21167(2): NAN operations are now handled correctly when python
     is compiled with ICC even if -fp-model strict is not specified.

   - bpo-24492(3): A “package” lacking a __name__ attribute when trying
     to perform a ‘from .. import ...’ statement will trigger an
     ImportError instead of an AttributeError.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24769

   (2) https://bugs.python.org/issue21167

   (3) https://bugs.python.org/issue24492


File: python.info,  Node: Library<62>,  Prev: Core and Builtins<48>,  Up: Python 3 5 0 release candidate 2

1.18.61.2 Library
.................

   - bpo-24847(1): Removes vcruntime140.dll dependency from Tcl/Tk.

   - bpo-24839(2): platform._syscmd_ver raises DeprecationWarning

   - bpo-24867(3): Fix Task.get_stack() for ‘async def’ coroutines

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24847

   (2) https://bugs.python.org/issue24839

   (3) https://bugs.python.org/issue24867


File: python.info,  Node: Python 3 5 0 release candidate 1,  Next: Python 3 5 0 beta 4,  Prev: Python 3 5 0 release candidate 2,  Up: Changelog

1.18.62 Python 3.5.0 release candidate 1
----------------------------------------

`Release date: 2015-08-09'

* Menu:

* Core and Builtins: Core and Builtins<49>.
* Library: Library<63>.
* IDLE: IDLE<38>.
* Documentation: Documentation<38>.
* Tests: Tests<41>.


File: python.info,  Node: Core and Builtins<49>,  Next: Library<63>,  Up: Python 3 5 0 release candidate 1

1.18.62.1 Core and Builtins
...........................

   - bpo-24667(1): Resize odict in all cases that the underlying dict
     resizes.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24667


File: python.info,  Node: Library<63>,  Next: IDLE<38>,  Prev: Core and Builtins<49>,  Up: Python 3 5 0 release candidate 1

1.18.62.2 Library
.................

   - bpo-24824(1): Signatures of codecs.encode() and codecs.decode() now
     are compatible with pydoc.

   - bpo-24634(2): Importing uuid should not try to load libc on Windows

   - bpo-24798(3): _msvccompiler.py doesn’t properly support manifests

   - bpo-4395(4): Better testing and documentation of binary operators.
     Patch by Martin Panter.

   - bpo-23973(5): Update typing.py from GitHub repo.

   - bpo-23004(6): mock_open() now reads binary data correctly when the
     type of read_data is bytes.  Initial patch by Aaron Hill.

   - bpo-23888(7): Handle fractional time in cookie expiry.  Patch by
     ssh.

   - bpo-23652(8): Make it possible to compile the select module against
     the libc headers from the Linux Standard Base, which do not include
     some EPOLL macros.  Patch by Matt Frank.

   - bpo-22932(9): Fix timezones in email.utils.formatdate.  Patch from
     Dmitry Shachnev.

   - bpo-23779(10): imaplib raises TypeError if authenticator tries to
     abort.  Patch from Craig Holmquist.

   - bpo-23319(11): Fix ctypes.BigEndianStructure, swap correctly bytes.
     Patch written by Matthieu Gautier.

   - bpo-23254(12): Document how to close the TCPServer listening
     socket.  Patch from Martin Panter.

   - bpo-19450(13): Update Windows and OS X installer builds to use
     SQLite 3.8.11.

   - bpo-17527(14): Add PATCH to wsgiref.validator.  Patch from Luca
     Sbardella.

   - bpo-24791(15): Fix grammar regression for call syntax: ‘g(*a or
     b)’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24824

   (2) https://bugs.python.org/issue24634

   (3) https://bugs.python.org/issue24798

   (4) https://bugs.python.org/issue4395

   (5) https://bugs.python.org/issue23973

   (6) https://bugs.python.org/issue23004

   (7) https://bugs.python.org/issue23888

   (8) https://bugs.python.org/issue23652

   (9) https://bugs.python.org/issue22932

   (10) https://bugs.python.org/issue23779

   (11) https://bugs.python.org/issue23319

   (12) https://bugs.python.org/issue23254

   (13) https://bugs.python.org/issue19450

   (14) https://bugs.python.org/issue17527

   (15) https://bugs.python.org/issue24791


File: python.info,  Node: IDLE<38>,  Next: Documentation<38>,  Prev: Library<63>,  Up: Python 3 5 0 release candidate 1

1.18.62.3 IDLE
..............

   - bpo-23672(1): Allow Idle to edit and run files with astral chars in
     name.  Patch by Mohd Sanad Zaki Rizvi.

   - bpo-24745(2): Idle editor default font.  Switch from Courier to
     platform-sensitive TkFixedFont.  This should not affect current
     customized font selections.  If there is a problem, edit
     $HOME/.idlerc/config-main.cfg and remove ‘fontxxx’ entries from
     [Editor Window].  Patch by Mark Roseman.

   - bpo-21192(3): Idle editor.  When a file is run, put its name in the
     restart bar.  Do not print false prompts.  Original patch by Adnan
     Umer.

   - bpo-13884(4): Idle menus.  Remove tearoff lines.  Patch by Roger
     Serwy.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23672

   (2) https://bugs.python.org/issue24745

   (3) https://bugs.python.org/issue21192

   (4) https://bugs.python.org/issue13884


File: python.info,  Node: Documentation<38>,  Next: Tests<41>,  Prev: IDLE<38>,  Up: Python 3 5 0 release candidate 1

1.18.62.4 Documentation
.......................

   - bpo-24129(1): Clarify the reference documentation for name
     resolution.  This includes removing the assumption that readers
     will be familiar with the name resolution scheme Python used prior
     to the introduction of lexical scoping for function namespaces.
     Patch by Ivan Levkivskyi.

   - bpo-20769(2): Improve reload() docs.  Patch by Dorian Pula.

   - bpo-23589(3): Remove duplicate sentence from the FAQ. Patch by
     Yongzhi Pan.

   - bpo-24729(4): Correct IO tutorial to match implementation regarding
     encoding parameter to open function.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24129

   (2) https://bugs.python.org/issue20769

   (3) https://bugs.python.org/issue23589

   (4) https://bugs.python.org/issue24729


File: python.info,  Node: Tests<41>,  Prev: Documentation<38>,  Up: Python 3 5 0 release candidate 1

1.18.62.5 Tests
...............

   - bpo-24751(1): When running regrtest with the ‘-w’ command line
     option, a test run is no longer marked as a failure if all tests
     succeed when re-run.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24751


File: python.info,  Node: Python 3 5 0 beta 4,  Next: Python 3 5 0 beta 3,  Prev: Python 3 5 0 release candidate 1,  Up: Changelog

1.18.63 Python 3.5.0 beta 4
---------------------------

`Release date: 2015-07-26'

* Menu:

* Core and Builtins: Core and Builtins<50>.
* Library: Library<64>.
* Build: Build<43>.


File: python.info,  Node: Core and Builtins<50>,  Next: Library<64>,  Up: Python 3 5 0 beta 4

1.18.63.1 Core and Builtins
...........................

   - bpo-23573(1): Restored optimization of bytes.rfind() and
     bytearray.rfind() for single-byte argument on Linux.

   - bpo-24569(2): Make PEP 448(3) dictionary evaluation more
     consistent.

   - bpo-24583(4): Fix crash when set is mutated while being updated.

   - bpo-24407(5): Fix crash when dict is mutated while being updated.

   - bpo-24619(6): New approach for tokenizing async/await.  As a
     consequence, it is now possible to have one-line ‘async def foo():
     await ..’ functions.

   - bpo-24687(7): Plug refleak on SyntaxError in function parameters
     annotations.

   - bpo-15944(8): memoryview: Allow arbitrary formats when casting to
     bytes.  Patch by Martin Panter.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23573

   (2) https://bugs.python.org/issue24569

   (3) https://www.python.org/dev/peps/pep-0448

   (4) https://bugs.python.org/issue24583

   (5) https://bugs.python.org/issue24407

   (6) https://bugs.python.org/issue24619

   (7) https://bugs.python.org/issue24687

   (8) https://bugs.python.org/issue15944


File: python.info,  Node: Library<64>,  Next: Build<43>,  Prev: Core and Builtins<50>,  Up: Python 3 5 0 beta 4

1.18.63.2 Library
.................

   - bpo-23441(1): rcompleter now prints a tab character instead of
     displaying possible completions for an empty word.  Initial patch
     by Martin Sekera.

   - bpo-24683(2): Fixed crashes in _json functions called with
     arguments of inappropriate type.

   - bpo-21697(3): shutil.copytree() now correctly handles symbolic
     links that point to directories.  Patch by Eduardo Seabra and
     Thomas Kluyver.

   - bpo-14373(4): Fixed segmentation fault when gc.collect() is called
     during constructing lru_cache (C implementation).

   - bpo-24695(5): Fix a regression in traceback.print_exception().  If
     exc_traceback is None we shouldn’t print a traceback header like
     described in the documentation.

   - bpo-24620(6): Random.setstate() now validates the value of state
     last element.

   - bpo-22485(7): Fixed an issue that caused *note inspect.getsource:
     1103. to return incorrect results on nested functions.

   - bpo-22153(8): Improve unittest docs.  Patch from Martin Panter and
     evilzero.

   - bpo-24580(9): Symbolic group references to open group in re
     patterns now are explicitly forbidden as well as numeric group
     references.

   - bpo-24206(10): Fixed __eq__ and __ne__ methods of inspect classes.

   - bpo-24631(11): Fixed regression in the timeit module with multiline
     setup.

   - bpo-18622(12): unittest.mock.mock_open().reset_mock would recurse
     infinitely.  Patch from Nicola Palumbo and Laurent De Buyst.

   - bpo-23661(13): unittest.mock side_effects can now be exceptions
     again.  This was a regression vs Python 3.4.  Patch from Ignacio
     Rossi

   - bpo-24608(14): chunk.Chunk.read() now always returns bytes, not
     str.

   - bpo-18684(15): Fixed reading out of the buffer in the re module.

   - bpo-24259(16): tarfile now raises a ReadError if an archive is
     truncated inside a data segment.

   - bpo-15014(17): SMTP.auth() and SMTP.login() now support RFC 4954’s
     optional initial-response argument to the SMTP AUTH command.

   - bpo-24669(18): Fix inspect.getsource() for ‘async def’ functions.
     Patch by Kai Groner.

   - bpo-24688(19): ast.get_docstring() for ‘async def’ functions.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23441

   (2) https://bugs.python.org/issue24683

   (3) https://bugs.python.org/issue21697

   (4) https://bugs.python.org/issue14373

   (5) https://bugs.python.org/issue24695

   (6) https://bugs.python.org/issue24620

   (7) https://bugs.python.org/issue22485

   (8) https://bugs.python.org/issue22153

   (9) https://bugs.python.org/issue24580

   (10) https://bugs.python.org/issue24206

   (11) https://bugs.python.org/issue24631

   (12) https://bugs.python.org/issue18622

   (13) https://bugs.python.org/issue23661

   (14) https://bugs.python.org/issue24608

   (15) https://bugs.python.org/issue18684

   (16) https://bugs.python.org/issue24259

   (17) https://bugs.python.org/issue15014

   (18) https://bugs.python.org/issue24669

   (19) https://bugs.python.org/issue24688


File: python.info,  Node: Build<43>,  Prev: Library<64>,  Up: Python 3 5 0 beta 4

1.18.63.3 Build
...............

   - bpo-24603(1): Update Windows builds and OS X 10.5 installer to use
     OpenSSL 1.0.2d.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24603


File: python.info,  Node: Python 3 5 0 beta 3,  Next: Python 3 5 0 beta 2,  Prev: Python 3 5 0 beta 4,  Up: Changelog

1.18.64 Python 3.5.0 beta 3
---------------------------

`Release date: 2015-07-05'

* Menu:

* Core and Builtins: Core and Builtins<51>.
* Library: Library<65>.
* Tests: Tests<42>.
* Documentation: Documentation<39>.
* Build: Build<44>.


File: python.info,  Node: Core and Builtins<51>,  Next: Library<65>,  Up: Python 3 5 0 beta 3

1.18.64.1 Core and Builtins
...........................

   - bpo-24467(1): Fixed possible buffer over-read in bytearray.  The
     bytearray object now always allocates place for trailing null byte
     and it’s buffer now is always null-terminated.

   - Upgrade to Unicode 8.0.0.

   - bpo-24345(2): Add Py_tp_finalize slot for the stable ABI.

   - bpo-24400(3): Introduce a distinct type for PEP 492(4) coroutines;
     add types.CoroutineType, inspect.getcoroutinestate,
     inspect.getcoroutinelocals; coroutines no longer use CO_GENERATOR
     flag; sys.set_coroutine_wrapper works only for ‘async def’
     coroutines; inspect.iscoroutine no longer uses
     collections.abc.Coroutine, it’s intended to test for pure ‘async
     def’ coroutines only; add new opcode: GET_YIELD_FROM_ITER; fix
     generators wrapper used in types.coroutine to be instance of
     collections.abc.Generator; collections.abc.Awaitable and
     collections.abc.Coroutine can no longer be used to detect
     generator-based coroutines–use inspect.isawaitable instead.

   - bpo-24450(5): Add gi_yieldfrom to generators and cr_await to
     coroutines.  Contributed by Benno Leslie and Yury Selivanov.

   - bpo-19235(6): Add new RecursionError exception.  Patch by Georg
     Brandl.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24467

   (2) https://bugs.python.org/issue24345

   (3) https://bugs.python.org/issue24400

   (4) https://www.python.org/dev/peps/pep-0492

   (5) https://bugs.python.org/issue24450

   (6) https://bugs.python.org/issue19235


File: python.info,  Node: Library<65>,  Next: Tests<42>,  Prev: Core and Builtins<51>,  Up: Python 3 5 0 beta 3

1.18.64.2 Library
.................

   - bpo-21750(1): mock_open.read_data can now be read from each
     instance, as it could in Python 3.3.

   - bpo-24552(2): Fix use after free in an error case of the _pickle
     module.

   - bpo-24514(3): tarfile now tolerates number fields consisting of
     only whitespace.

   - bpo-19176(4): Fixed doctype() related bugs in C implementation of
     ElementTree.  A deprecation warning no longer issued by XMLParser
     subclass with default doctype() method.  Direct call of doctype()
     now issues a warning.  Parser’s doctype() now is not called if
     target’s doctype() is called.  Based on patch by Martin Panter.

   - bpo-20387(5): Restore semantic round-trip correctness in
     tokenize/untokenize for tab-indented blocks.

   - bpo-24456(6): Fixed possible buffer over-read in adpcm2lin() and
     lin2adpcm() functions of the audioop module.

   - bpo-24336(7): The contextmanager decorator now works with functions
     with keyword arguments called “func” and “self”.  Patch by Martin
     Panter.

   - bpo-24522(8): Fix possible integer overflow in json accelerator
     module.

   - bpo-24489(9): ensure a previously set C errno doesn’t disturb
     cmath.polar().

   - bpo-24408(10): Fixed AttributeError in measure() and metrics()
     methods of tkinter.Font.

   - bpo-14373(11): C implementation of functools.lru_cache() now can be
     used with methods.

   - bpo-24347(12): Set KeyError if PyDict_GetItemWithError returns
     NULL.

   - bpo-24348(13): Drop superfluous incref/decref.

   - bpo-24359(14): Check for changed OrderedDict size during iteration.

   - bpo-24368(15): Support keyword arguments in OrderedDict methods.

   - bpo-24362(16): Simplify the C OrderedDict fast nodes resize logic.

   - bpo-24377(17): Fix a ref leak in OrderedDict.__repr__.

   - bpo-24369(18): Defend against key-changes during iteration.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21750

   (2) https://bugs.python.org/issue24552

   (3) https://bugs.python.org/issue24514

   (4) https://bugs.python.org/issue19176

   (5) https://bugs.python.org/issue20387

   (6) https://bugs.python.org/issue24456

   (7) https://bugs.python.org/issue24336

   (8) https://bugs.python.org/issue24522

   (9) https://bugs.python.org/issue24489

   (10) https://bugs.python.org/issue24408

   (11) https://bugs.python.org/issue14373

   (12) https://bugs.python.org/issue24347

   (13) https://bugs.python.org/issue24348

   (14) https://bugs.python.org/issue24359

   (15) https://bugs.python.org/issue24368

   (16) https://bugs.python.org/issue24362

   (17) https://bugs.python.org/issue24377

   (18) https://bugs.python.org/issue24369


File: python.info,  Node: Tests<42>,  Next: Documentation<39>,  Prev: Library<65>,  Up: Python 3 5 0 beta 3

1.18.64.3 Tests
...............

   - bpo-24373(1): _testmultiphase and xxlimited now use tp_traverse and
     tp_finalize to avoid reference leaks encountered when combining
     tp_dealloc with PyType_FromSpec (see bpo-16690(2) for details)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24373

   (2) https://bugs.python.org/issue16690


File: python.info,  Node: Documentation<39>,  Next: Build<44>,  Prev: Tests<42>,  Up: Python 3 5 0 beta 3

1.18.64.4 Documentation
.......................

   - bpo-24458(1): Update documentation to cover multi-phase
     initialization for extension modules (PEP 489).  Patch by Petr
     Viktorin.

   - bpo-24351(2): Clarify what is meant by “identifier” in the context
     of string.Template instances.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24458

   (2) https://bugs.python.org/issue24351


File: python.info,  Node: Build<44>,  Prev: Documentation<39>,  Up: Python 3 5 0 beta 3

1.18.64.5 Build
...............

   - bpo-24432(1): Update Windows builds and OS X 10.5 installer to use
     OpenSSL 1.0.2c.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24432


File: python.info,  Node: Python 3 5 0 beta 2,  Next: Python 3 5 0 beta 1,  Prev: Python 3 5 0 beta 3,  Up: Changelog

1.18.65 Python 3.5.0 beta 2
---------------------------

`Release date: 2015-05-31'

* Menu:

* Core and Builtins: Core and Builtins<52>.
* Library: Library<66>.


File: python.info,  Node: Core and Builtins<52>,  Next: Library<66>,  Up: Python 3 5 0 beta 2

1.18.65.1 Core and Builtins
...........................

   - bpo-24284(1): The startswith and endswith methods of the str class
     no longer return True when finding the empty string and the indexes
     are completely out of range.

   - bpo-24115(2): Update uses of PyObject_IsTrue(), PyObject_Not(),
     PyObject_IsInstance(), PyObject_RichCompareBool() and
     _PyDict_Contains() to check for and handle errors correctly.

   - bpo-24328(3): Fix importing one character extension modules.

   - bpo-11205(4): In dictionary displays, evaluate the key before the
     value.

   - bpo-24285(5): Fixed regression that prevented importing extension
     modules from inside packages.  Patch by Petr Viktorin.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24284

   (2) https://bugs.python.org/issue24115

   (3) https://bugs.python.org/issue24328

   (4) https://bugs.python.org/issue11205

   (5) https://bugs.python.org/issue24285


File: python.info,  Node: Library<66>,  Prev: Core and Builtins<52>,  Up: Python 3 5 0 beta 2

1.18.65.2 Library
.................

   - bpo-23247(1): Fix a crash in the StreamWriter.reset() of CJK
     codecs.

   - bpo-24270(2): Add math.isclose() and cmath.isclose() functions as
     per PEP 485(3).  Contributed by Chris Barker and Tal Einat.

   - bpo-5633(4): Fixed timeit when the statement is a string and the
     setup is not.

   - bpo-24326(5): Fixed audioop.ratecv() with non-default weightB
     argument.  Original patch by David Moore.

   - bpo-16991(6): Add a C implementation of OrderedDict.

   - bpo-23934(7): Fix inspect.signature to fail correctly for builtin
     types lacking signature information.  Initial patch by James
     Powell.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23247

   (2) https://bugs.python.org/issue24270

   (3) https://www.python.org/dev/peps/pep-0485

   (4) https://bugs.python.org/issue5633

   (5) https://bugs.python.org/issue24326

   (6) https://bugs.python.org/issue16991

   (7) https://bugs.python.org/issue23934


File: python.info,  Node: Python 3 5 0 beta 1,  Next: Python 3 5 0 alpha 4,  Prev: Python 3 5 0 beta 2,  Up: Changelog

1.18.66 Python 3.5.0 beta 1
---------------------------

`Release date: 2015-05-24'

* Menu:

* Core and Builtins: Core and Builtins<53>.
* Library: Library<67>.
* IDLE: IDLE<39>.
* Tests: Tests<43>.
* Documentation: Documentation<40>.
* Tools/Demos: Tools/Demos<29>.


File: python.info,  Node: Core and Builtins<53>,  Next: Library<67>,  Up: Python 3 5 0 beta 1

1.18.66.1 Core and Builtins
...........................

   - bpo-24276(1): Fixed optimization of property descriptor getter.

   - bpo-24268(2): PEP 489: Multi-phase extension module initialization.
     Patch by Petr Viktorin.

   - bpo-23955(3): Add pyvenv.cfg option to suppress
     registry/environment lookup for generating sys.path on Windows.

   - bpo-24257(4): Fixed system error in the comparison of faked
     types.SimpleNamespace.

   - bpo-22939(5): Fixed integer overflow in iterator object.  Patch by
     Clement Rouault.

   - bpo-23985(6): Fix a possible buffer overrun when deleting a slice
     from the front of a bytearray and then appending some other bytes
     data.

   - bpo-24102(7): Fixed exception type checking in standard error
     handlers.

   - bpo-15027(8): The UTF-32 encoder is now 3x to 7x faster.

   - bpo-23290(9): Optimize set_merge() for cases where the target is
     empty.  (Contributed by Serhiy Storchaka.)

   - bpo-2292(10): PEP 448: Additional Unpacking Generalizations.

   - bpo-24096(11): Make warnings.warn_explicit more robust against
     mutation of the warnings.filters list.

   - bpo-23996(12): Avoid a crash when a delegated generator raises an
     unnormalized StopIteration exception.  Patch by Stefan Behnel.

   - bpo-23910(13): Optimize property() getter calls.  Patch by Joe
     Jevnik.

   - bpo-23911(14): Move path-based importlib bootstrap code to a
     separate frozen module.

   - bpo-24192(15): Fix namespace package imports.

   - bpo-24022(16): Fix tokenizer crash when processing undecodable
     source code.

   - bpo-9951(17): Added a hex() method to bytes, bytearray, and
     memoryview.

   - bpo-22906(18): PEP 479: Change StopIteration handling inside
     generators.

   - bpo-24017(19): PEP 492: Coroutines with async and await syntax.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24276

   (2) https://bugs.python.org/issue24268

   (3) https://bugs.python.org/issue23955

   (4) https://bugs.python.org/issue24257

   (5) https://bugs.python.org/issue22939

   (6) https://bugs.python.org/issue23985

   (7) https://bugs.python.org/issue24102

   (8) https://bugs.python.org/issue15027

   (9) https://bugs.python.org/issue23290

   (10) https://bugs.python.org/issue2292

   (11) https://bugs.python.org/issue24096

   (12) https://bugs.python.org/issue23996

   (13) https://bugs.python.org/issue23910

   (14) https://bugs.python.org/issue23911

   (15) https://bugs.python.org/issue24192

   (16) https://bugs.python.org/issue24022

   (17) https://bugs.python.org/issue9951

   (18) https://bugs.python.org/issue22906

   (19) https://bugs.python.org/issue24017


File: python.info,  Node: Library<67>,  Next: IDLE<39>,  Prev: Core and Builtins<53>,  Up: Python 3 5 0 beta 1

1.18.66.2 Library
.................

   - bpo-14373(1): Added C implementation of functools.lru_cache().
     Based on patches by Matt Joiner and Alexey Kachayev.

   - bpo-24230(2): The tempfile module now accepts bytes for prefix,
     suffix and dir parameters and returns bytes in such situations
     (matching the os module APIs).

   - bpo-22189(3): collections.UserString now supports __getnewargs__(),
     __rmod__(), casefold(), format_map(), isprintable(), and
     maketrans().  Patch by Joe Jevnik.

   - bpo-24244(4): Prevents termination when an invalid format string is
     encountered on Windows in strftime.

   - bpo-23973(5): PEP 484: Add the typing module.

   - bpo-23086(6): The collections.abc.Sequence() abstract base class
     added `start' and `stop' parameters to the index() mixin.  Patch by
     Devin Jeanpierre.

   - bpo-20035(7): Replaced the ‘tkinter._fix’ module used for setting
     up the Tcl/Tk environment on Windows with a private function in the
     ‘_tkinter’ module that makes no permanent changes to the
     environment.

   - bpo-24257(8): Fixed segmentation fault in sqlite3.Row constructor
     with faked cursor type.

   - bpo-15836(9): assertRaises(), assertRaisesRegex(), assertWarns()
     and assertWarnsRegex() assertments now check the type of the first
     argument to prevent possible user error.  Based on patch by Daniel
     Wagner-Hall.

   - bpo-9858(10): Add missing method stubs to _io.RawIOBase.  Patch by
     Laura Rupprecht.

   - bpo-22955(11): attrgetter, itemgetter and methodcaller objects in
     the operator module now support pickling.  Added readable and
     evaluable repr for these objects.  Based on patch by Josh
     Rosenberg.

   - bpo-22107(12): tempfile.gettempdir() and tempfile.mkdtemp() now try
     again when a directory with the chosen name already exists on
     Windows as well as on Unix.  tempfile.mkstemp() now fails early if
     parent directory is not valid (not exists or is a file) on Windows.

   - bpo-23780(13): Improved error message in os.path.join() with single
     argument.

   - bpo-6598(14): Increased time precision and random number range in
     email.utils.make_msgid() to strengthen the uniqueness of the
     message ID.

   - bpo-24091(15): Fixed various crashes in corner cases in C
     implementation of ElementTree.

   - bpo-21931(16): msilib.FCICreate() now raises TypeError in the case
     of a bad argument instead of a ValueError with a bogus FCI error
     number.  Patch by Jeffrey Armstrong.

   - bpo-13866(17): `quote_via' argument added to
     urllib.parse.urlencode.

   - bpo-20098(18): New mangle_from policy option for email, default
     True for compat32, but False for all other policies.

   - bpo-24211(19): The email library now supports RFC 6532: it can
     generate headers using utf-8 instead of encoded words.

   - bpo-16314(20): Added support for the LZMA compression in distutils.

   - bpo-21804(21): poplib now supports RFC 6856 (UTF8).

   - bpo-18682(22): Optimized pprint functions for builtin scalar types.

   - bpo-22027(23): smtplib now supports RFC 6531 (SMTPUTF8).

   - bpo-23488(24): Random generator objects now consume 2x less memory
     on 64-bit.

   - bpo-1322(25): platform.dist() and platform.linux_distribution()
     functions are now deprecated.  Initial patch by Vajrasky Kok.

   - bpo-22486(26): Added the math.gcd() function.  The fractions.gcd()
     function now is deprecated.  Based on patch by Mark Dickinson.

   - bpo-24064(27): Property() docstrings are now writeable.  (Patch by
     Berker Peksag.)

   - bpo-22681(28): Added support for the koi8_t encoding.

   - bpo-22682(29): Added support for the kz1048 encoding.

   - bpo-23796(30): peek and read1 methods of BufferedReader now raise
     ValueError if they called on a closed object.  Patch by John
     Hergenroeder.

   - bpo-21795(31): smtpd now supports the 8BITMIME extension whenever
     the new `decode_data' constructor argument is set to False.

   - bpo-24155(32): optimize heapq.heapify() for better cache
     performance when heapifying large lists.

   - bpo-21800(33): imaplib now supports RFC 5161 (enable), RFC 6855
     (utf8/internationalized email) and automatically encodes non-ASCII
     usernames and passwords to UTF8.

   - bpo-20274(34): When calling a _sqlite.Connection, it now complains
     if passed any keyword arguments.  Previously it silently ignored
     them.

   - bpo-20274(35): Remove ignored and erroneous “kwargs” parameters
     from three METH_VARARGS methods on _sqlite.Connection.

   - bpo-24134(36): assertRaises(), assertRaisesRegex(), assertWarns()
     and assertWarnsRegex() checks now emits a deprecation warning when
     callable is None or keyword arguments except msg is passed in the
     context manager mode.

   - bpo-24018(37): Add a collections.abc.Generator abstract base class.
     Contributed by Stefan Behnel.

   - bpo-23880(38): Tkinter’s getint() and getdouble() now support
     Tcl_Obj.  Tkinter’s getdouble() now supports any numbers (in
     particular int).

   - bpo-22619(39): Added negative limit support in the traceback
     module.  Based on patch by Dmitry Kazakov.

   - bpo-24094(40): Fix possible crash in json.encode with poorly
     behaved dict subclasses.

   - bpo-9246(41): On POSIX, os.getcwd() now supports paths longer than
     1025 bytes.  Patch written by William Orr.

   - bpo-17445(42): add difflib.diff_bytes() to support comparison of
     byte strings (fixes a regression from Python 2).

   - bpo-23917(43): Fall back to sequential compilation when
     ProcessPoolExecutor doesn’t exist.  Patch by Claudiu Popa.

   - bpo-23008(44): Fixed resolving attributes with boolean value is
     False in pydoc.

   - Fix asyncio issue 235: LifoQueue and PriorityQueue’s put didn’t
     increment unfinished tasks (this bug was introduced when
     JoinableQueue was merged with Queue).

   - bpo-23908(45): os functions now reject paths with embedded null
     character on Windows instead of silently truncating them.

   - bpo-23728(46): binascii.crc_hqx() could return an integer outside
     of the range 0-0xffff for empty data.

   - bpo-23887(47): urllib.error.HTTPError now has a proper repr()
     representation.  Patch by Berker Peksag.

   - asyncio: New event loop APIs: set_task_factory() and
     get_task_factory().

   - asyncio: async() function is deprecated in favour of
     ensure_future().

   - bpo-24178(48): asyncio.Lock, Condition, Semaphore, and
     BoundedSemaphore support new ‘async with’ syntax.  Contributed by
     Yury Selivanov.

   - bpo-24179(49): Support ‘async for’ for asyncio.StreamReader.
     Contributed by Yury Selivanov.

   - bpo-24184(50): Add AsyncIterator and AsyncIterable ABCs to
     collections.abc.  Contributed by Yury Selivanov.

   - bpo-22547(51): Implement informative __repr__ for
     inspect.BoundArguments.  Contributed by Yury Selivanov.

   - bpo-24190(52): Implement inspect.BoundArgument.apply_defaults()
     method.  Contributed by Yury Selivanov.

   - bpo-20691(53): Add ‘follow_wrapped’ argument to
     inspect.Signature.from_callable() and inspect.signature().
     Contributed by Yury Selivanov.

   - bpo-24248(54): Deprecate inspect.Signature.from_function() and
     inspect.Signature.from_builtin().

   - bpo-23898(55): Fix inspect.classify_class_attrs() to support
     attributes with overloaded __eq__ and __bool__.  Patch by Mike
     Bayer.

   - bpo-24298(56): Fix inspect.signature() to correctly unwrap wrappers
     around bound methods.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14373

   (2) https://bugs.python.org/issue24230

   (3) https://bugs.python.org/issue22189

   (4) https://bugs.python.org/issue24244

   (5) https://bugs.python.org/issue23973

   (6) https://bugs.python.org/issue23086

   (7) https://bugs.python.org/issue20035

   (8) https://bugs.python.org/issue24257

   (9) https://bugs.python.org/issue15836

   (10) https://bugs.python.org/issue9858

   (11) https://bugs.python.org/issue22955

   (12) https://bugs.python.org/issue22107

   (13) https://bugs.python.org/issue23780

   (14) https://bugs.python.org/issue6598

   (15) https://bugs.python.org/issue24091

   (16) https://bugs.python.org/issue21931

   (17) https://bugs.python.org/issue13866

   (18) https://bugs.python.org/issue20098

   (19) https://bugs.python.org/issue24211

   (20) https://bugs.python.org/issue16314

   (21) https://bugs.python.org/issue21804

   (22) https://bugs.python.org/issue18682

   (23) https://bugs.python.org/issue22027

   (24) https://bugs.python.org/issue23488

   (25) https://bugs.python.org/issue1322

   (26) https://bugs.python.org/issue22486

   (27) https://bugs.python.org/issue24064

   (28) https://bugs.python.org/issue22681

   (29) https://bugs.python.org/issue22682

   (30) https://bugs.python.org/issue23796

   (31) https://bugs.python.org/issue21795

   (32) https://bugs.python.org/issue24155

   (33) https://bugs.python.org/issue21800

   (34) https://bugs.python.org/issue20274

   (35) https://bugs.python.org/issue20274

   (36) https://bugs.python.org/issue24134

   (37) https://bugs.python.org/issue24018

   (38) https://bugs.python.org/issue23880

   (39) https://bugs.python.org/issue22619

   (40) https://bugs.python.org/issue24094

   (41) https://bugs.python.org/issue9246

   (42) https://bugs.python.org/issue17445

   (43) https://bugs.python.org/issue23917

   (44) https://bugs.python.org/issue23008

   (45) https://bugs.python.org/issue23908

   (46) https://bugs.python.org/issue23728

   (47) https://bugs.python.org/issue23887

   (48) https://bugs.python.org/issue24178

   (49) https://bugs.python.org/issue24179

   (50) https://bugs.python.org/issue24184

   (51) https://bugs.python.org/issue22547

   (52) https://bugs.python.org/issue24190

   (53) https://bugs.python.org/issue20691

   (54) https://bugs.python.org/issue24248

   (55) https://bugs.python.org/issue23898

   (56) https://bugs.python.org/issue24298


File: python.info,  Node: IDLE<39>,  Next: Tests<43>,  Prev: Library<67>,  Up: Python 3 5 0 beta 1

1.18.66.3 IDLE
..............

   - bpo-23184(1): remove unused names and imports in idlelib.  Initial
     patch by Al Sweigart.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23184


File: python.info,  Node: Tests<43>,  Next: Documentation<40>,  Prev: IDLE<39>,  Up: Python 3 5 0 beta 1

1.18.66.4 Tests
...............

   - bpo-21520(1): test_zipfile no longer fails if the word ‘bad’
     appears anywhere in the name of the current directory.

   - bpo-9517(2): Move script_helper into the support package.  Patch by
     Christie Wilson.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue21520

   (2) https://bugs.python.org/issue9517


File: python.info,  Node: Documentation<40>,  Next: Tools/Demos<29>,  Prev: Tests<43>,  Up: Python 3 5 0 beta 1

1.18.66.5 Documentation
.......................

   - bpo-22155(1): Add File Handlers subsection with createfilehandler
     to tkinter doc.  Remove obsolete example from FAQ. Patch by Martin
     Panter.

   - bpo-24029(2): Document the name binding behavior for submodule
     imports.

   - bpo-24077(3): Fix typo in man page for -I command option: -s, not
     -S

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22155

   (2) https://bugs.python.org/issue24029

   (3) https://bugs.python.org/issue24077


File: python.info,  Node: Tools/Demos<29>,  Prev: Documentation<40>,  Up: Python 3 5 0 beta 1

1.18.66.6 Tools/Demos
.....................

   - bpo-24000(1): Improved Argument Clinic’s mapping of converters to
     legacy “format units”.  Updated the documentation to match.

   - bpo-24001(2): Argument Clinic converters now use accept={type}
     instead of types={‘type’} to specify the types the converter
     accepts.

   - bpo-23330(3): h2py now supports arbitrary filenames in #include.

   - bpo-24031(4): make patchcheck now supports git checkouts, too.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue24000

   (2) https://bugs.python.org/issue24001

   (3) https://bugs.python.org/issue23330

   (4) https://bugs.python.org/issue24031


File: python.info,  Node: Python 3 5 0 alpha 4,  Next: Python 3 5 0 alpha 3,  Prev: Python 3 5 0 beta 1,  Up: Changelog

1.18.67 Python 3.5.0 alpha 4
----------------------------

`Release date: 2015-04-19'

* Menu:

* Core and Builtins: Core and Builtins<54>.
* Library: Library<68>.
* Build: Build<45>.
* Tests: Tests<44>.
* Tools/Demos: Tools/Demos<30>.
* C API: C API<30>.


File: python.info,  Node: Core and Builtins<54>,  Next: Library<68>,  Up: Python 3 5 0 alpha 4

1.18.67.1 Core and Builtins
...........................

   - bpo-22980(1): Under Linux, GNU/KFreeBSD and the Hurd, C extensions
     now include the architecture triplet in the extension name, to make
     it easy to test builds for different ABIs in the same working tree.
     Under OS X, the extension name now includes PEP 3149(2)-style
     information.

   - bpo-22631(3): Added Linux-specific socket constant
     CAN_RAW_FD_FRAMES. Patch courtesy of Joe Jevnik.

   - bpo-23731(4): Implement PEP 488(5): removal of .pyo files.

   - bpo-23726(6): Don’t enable GC for user subclasses of non-GC types
     that don’t add any new fields.  Patch by Eugene Toder.

   - bpo-23309(7): Avoid a deadlock at shutdown if a daemon thread is
     aborted while it is holding a lock to a buffered I/O object, and
     the main thread tries to use the same I/O object (typically stdout
     or stderr).  A fatal error is emitted instead.

   - bpo-22977(8): Fixed formatting Windows error messages on Wine.
     Patch by Martin Panter.

   - bpo-23466(9): %c, %o, %x, and %X in bytes formatting now raise
     TypeError on non-integer input.

   - bpo-24044(10): Fix possible null pointer dereference in list.sort
     in out of memory conditions.

   - bpo-21354(11): PyCFunction_New function is exposed by python DLL
     again.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22980

   (2) https://www.python.org/dev/peps/pep-3149

   (3) https://bugs.python.org/issue22631

   (4) https://bugs.python.org/issue23731

   (5) https://www.python.org/dev/peps/pep-0488

   (6) https://bugs.python.org/issue23726

   (7) https://bugs.python.org/issue23309

   (8) https://bugs.python.org/issue22977

   (9) https://bugs.python.org/issue23466

   (10) https://bugs.python.org/issue24044

   (11) https://bugs.python.org/issue21354


File: python.info,  Node: Library<68>,  Next: Build<45>,  Prev: Core and Builtins<54>,  Up: Python 3 5 0 alpha 4

1.18.67.2 Library
.................

   - bpo-23840(1): tokenize.open() now closes the temporary binary file
     on error to fix a resource warning.

   - bpo-16914(2): new debuglevel 2 in smtplib adds timestamps to debug
     output.

   - bpo-7159(3): urllib.request now supports sending auth credentials
     automatically after the first 401.  This enhancement is a superset
     of the enhancement from bpo-19494(4) and supersedes that change.

   - bpo-23703(5): Fix a regression in urljoin() introduced in
     901e4e52b20a.  Patch by Demian Brecht.

   - bpo-4254(6): Adds _curses.update_lines_cols().  Patch by Arnon
     Yaari

   - bpo-19933(7): Provide default argument for ndigits in round.  Patch
     by Vajrasky Kok.

   - bpo-23193(8): Add a numeric_owner parameter to
     tarfile.TarFile.extract and tarfile.TarFile.extractall.  Patch by
     Michael Vogt and Eric Smith.

   - bpo-23342(9): Add a subprocess.run() function than returns a
     CalledProcess instance for a more consistent API than the existing
     call* functions.

   - bpo-21217(10): inspect.getsourcelines() now tries to compute the
     start and end lines from the code object, fixing an issue when a
     lambda function is used as decorator argument.  Patch by Thomas
     Ballinger and Allison Kaptur.

   - bpo-24521(11): Fix possible integer overflows in the pickle module.

   - bpo-22931(12): Allow ‘[‘ and ‘]’ in cookie values.

   - The keywords attribute of functools.partial is now always a
     dictionary.

   - bpo-23811(13): Add missing newline to the PyCompileError error
     message.  Patch by Alex Shkop.

   - bpo-21116(14): Avoid blowing memory when allocating a
     multiprocessing shared array that’s larger than 50% of the
     available RAM. Patch by Médéric Boquien.

   - bpo-22982(15): Improve BOM handling when seeking to multiple
     positions of a writable text file.

   - bpo-23464(16): Removed deprecated asyncio JoinableQueue.

   - bpo-23529(17): Limit the size of decompressed data when reading
     from GzipFile, BZ2File or LZMAFile.  This defeats denial of service
     attacks using compressed bombs (i.e.  compressed payloads which
     decompress to a huge size).  Patch by Martin Panter and Nikolaus
     Rath.

   - bpo-21859(18): Added Python implementation of io.FileIO.

   - bpo-23865(19): close() methods in multiple modules now are
     idempotent and more robust at shutdown.  If they need to release
     multiple resources, all are released even if errors occur.

   - bpo-23400(20): Raise same exception on both Python 2 and 3 if
     sem_open is not available.  Patch by Davin Potts.

   - bpo-10838(21): The subprocess now module includes SubprocessError
     and TimeoutError in its list of exported names for the users wild
     enough to use ‘from subprocess import *’.

   - bpo-23411(22): Added DefragResult, ParseResult, SplitResult,
     DefragResultBytes, ParseResultBytes, and SplitResultBytes to
     urllib.parse.__all__.  Patch by Martin Panter.

   - bpo-23881(23): urllib.request.ftpwrapper constructor now closes the
     socket if the FTP connection failed to fix a ResourceWarning.

   - bpo-23853(24): *note socket.socket.sendall(): 66f. does no more
     reset the socket timeout each time data is sent successfully.  The
     socket timeout is now the maximum total duration to send all data.

   - bpo-22721(25): An order of multiline pprint output of set or dict
     containing orderable and non-orderable elements no longer depends
     on iteration order of set or dict.

   - bpo-15133(26): _tkinter.tkapp.getboolean() now supports Tcl_Obj and
     always returns bool.  tkinter.BooleanVar now validates input values
     (accepted bool, int, str, and Tcl_Obj).  tkinter.BooleanVar.get()
     now always returns bool.

   - bpo-10590(27): xml.sax.parseString() now supports string argument.

   - bpo-23338(28): Fixed formatting ctypes error messages on Cygwin.
     Patch by Makoto Kato.

   - bpo-15582(29): inspect.getdoc() now follows inheritance chains.

   - bpo-2175(30): SAX parsers now support a character stream of
     InputSource object.

   - bpo-16840(31): Tkinter now supports 64-bit integers added in Tcl
     8.4 and arbitrary precision integers added in Tcl 8.5.

   - bpo-23834(32): Fix socket.sendto(), use the C Py_ssize_t type to
     store the result of sendto() instead of the C int type.

   - bpo-23618(33): *note socket.socket.connect(): 66a. now waits until
     the connection completes instead of raising *note InterruptedError:
     64d. if the connection is interrupted by signals, signal handlers
     don’t raise an exception and the socket is blocking or has a
     timeout.  *note socket.socket.connect(): 66a. still raise *note
     InterruptedError: 64d. for non-blocking sockets.

   - bpo-21526(34): Tkinter now supports new boolean type in Tcl 8.5.

   - bpo-23836(35): Fix the faulthandler module to handle reentrant
     calls to its signal handlers.

   - bpo-23838(36): linecache now clears the cache and returns an empty
     result on MemoryError.

   - bpo-10395(37): Added os.path.commonpath().  Implemented in
     posixpath and ntpath.  Based on patch by Rafik Draoui.

   - bpo-23611(38): Serializing more “lookupable” objects (such as
     unbound methods or nested classes) now are supported with pickle
     protocols < 4.

   - bpo-13583(39): sqlite3.Row now supports slice indexing.

   - bpo-18473(40): Fixed 2to3 and 3to2 compatible pickle mappings.
     Fixed ambiguous reverse mappings.  Added many new mappings.  Import
     mapping is no longer applied to modules already mapped with full
     name mapping.

   - bpo-23485(41): select.select() is now retried automatically with
     the recomputed timeout when interrupted by a signal, except if the
     signal handler raises an exception.  This change is part of the PEP
     475(42).

   - bpo-23752(43): When built from an existing file descriptor,
     io.FileIO() now only calls fstat() once.  Before fstat() was called
     twice, which was not necessary.

   - bpo-23704(44): collections.deque() objects now support __add__,
     __mul__, and __imul__().

   - bpo-23171(45): csv.Writer.writerow() now supports arbitrary
     iterables.

   - bpo-23745(46): The new email header parser now handles duplicate
     MIME parameter names without error, similar to how get_param
     behaves.

   - bpo-22117(47): Fix os.utime(), it now rounds the timestamp towards
     minus infinity (-inf) instead of rounding towards zero.

   - bpo-23310(48): Fix MagicMock’s initializer to work with
     __methods__, just like configure_mock().  Patch by Kasia Jachim.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23840

   (2) https://bugs.python.org/issue16914

   (3) https://bugs.python.org/issue7159

   (4) https://bugs.python.org/issue19494

   (5) https://bugs.python.org/issue23703

   (6) https://bugs.python.org/issue4254

   (7) https://bugs.python.org/issue19933

   (8) https://bugs.python.org/issue23193

   (9) https://bugs.python.org/issue23342

   (10) https://bugs.python.org/issue21217

   (11) https://bugs.python.org/issue24521

   (12) https://bugs.python.org/issue22931

   (13) https://bugs.python.org/issue23811

   (14) https://bugs.python.org/issue21116

   (15) https://bugs.python.org/issue22982

   (16) https://bugs.python.org/issue23464

   (17) https://bugs.python.org/issue23529

   (18) https://bugs.python.org/issue21859

   (19) https://bugs.python.org/issue23865

   (20) https://bugs.python.org/issue23400

   (21) https://bugs.python.org/issue10838

   (22) https://bugs.python.org/issue23411

   (23) https://bugs.python.org/issue23881

   (24) https://bugs.python.org/issue23853

   (25) https://bugs.python.org/issue22721

   (26) https://bugs.python.org/issue15133

   (27) https://bugs.python.org/issue10590

   (28) https://bugs.python.org/issue23338

   (29) https://bugs.python.org/issue15582

   (30) https://bugs.python.org/issue2175

   (31) https://bugs.python.org/issue16840

   (32) https://bugs.python.org/issue23834

   (33) https://bugs.python.org/issue23618

   (34) https://bugs.python.org/issue21526

   (35) https://bugs.python.org/issue23836

   (36) https://bugs.python.org/issue23838

   (37) https://bugs.python.org/issue10395

   (38) https://bugs.python.org/issue23611

   (39) https://bugs.python.org/issue13583

   (40) https://bugs.python.org/issue18473

   (41) https://bugs.python.org/issue23485

   (42) https://www.python.org/dev/peps/pep-0475

   (43) https://bugs.python.org/issue23752

   (44) https://bugs.python.org/issue23704

   (45) https://bugs.python.org/issue23171

   (46) https://bugs.python.org/issue23745

   (47) https://bugs.python.org/issue22117

   (48) https://bugs.python.org/issue23310


File: python.info,  Node: Build<45>,  Next: Tests<44>,  Prev: Library<68>,  Up: Python 3 5 0 alpha 4

1.18.67.3 Build
...............

   - bpo-23817(1): FreeBSD now uses “1.0” in the SOVERSION as other
     operating systems, instead of just “1”.

   - bpo-23501(2): Argument Clinic now generates code into separate
     files by default.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23817

   (2) https://bugs.python.org/issue23501


File: python.info,  Node: Tests<44>,  Next: Tools/Demos<30>,  Prev: Build<45>,  Up: Python 3 5 0 alpha 4

1.18.67.4 Tests
...............

   - bpo-23799(1): Added test.support.start_threads() for running and
     cleaning up multiple threads.

   - bpo-22390(2): test.regrtest now emits a warning if temporary files
     or directories are left after running a test.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23799

   (2) https://bugs.python.org/issue22390


File: python.info,  Node: Tools/Demos<30>,  Next: C API<30>,  Prev: Tests<44>,  Up: Python 3 5 0 alpha 4

1.18.67.5 Tools/Demos
.....................

   - bpo-18128(1): pygettext now uses standard +NNNN format in the
     POT-Creation-Date header.

   - bpo-23935(2): Argument Clinic’s understanding of format units
     accepting bytes, bytearrays, and buffers is now consistent with
     both the documentation and the implementation.

   - bpo-23944(3): Argument Clinic now wraps long impl prototypes at
     column 78.

   - bpo-20586(4): Argument Clinic now ensures that functions without
     docstrings have signatures.

   - bpo-23492(5): Argument Clinic now generates argument parsing code
     with PyArg_Parse instead of PyArg_ParseTuple if possible.

   - bpo-23500(6): Argument Clinic is now smarter about generating the
     “#ifndef” (empty) definition of the methoddef macro: it’s only
     generated once, even if Argument Clinic processes the same symbol
     multiple times, and it’s emitted at the end of all processing
     rather than immediately after the first use.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18128

   (2) https://bugs.python.org/issue23935

   (3) https://bugs.python.org/issue23944

   (4) https://bugs.python.org/issue20586

   (5) https://bugs.python.org/issue23492

   (6) https://bugs.python.org/issue23500


File: python.info,  Node: C API<30>,  Prev: Tools/Demos<30>,  Up: Python 3 5 0 alpha 4

1.18.67.6 C API
...............

   - bpo-23998(1): PyImport_ReInitLock() now checks for lock allocation
     error

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23998


File: python.info,  Node: Python 3 5 0 alpha 3,  Next: Python 3 5 0 alpha 2,  Prev: Python 3 5 0 alpha 4,  Up: Changelog

1.18.68 Python 3.5.0 alpha 3
----------------------------

`Release date: 2015-03-28'

* Menu:

* Core and Builtins: Core and Builtins<55>.
* Library: Library<69>.
* Build: Build<46>.
* Tests: Tests<45>.
* Tools/Demos: Tools/Demos<31>.


File: python.info,  Node: Core and Builtins<55>,  Next: Library<69>,  Up: Python 3 5 0 alpha 3

1.18.68.1 Core and Builtins
...........................

   - bpo-23573(1): Increased performance of string search operations
     (str.find, str.index, str.count, the in operator, str.split,
     str.partition) with arguments of different kinds (UCS1, UCS2,
     UCS4).

   - bpo-23753(2): Python doesn’t support anymore platforms without
     stat() or fstat(), these functions are always required.

   - bpo-23681(3): The -b option now affects comparisons of bytes with
     int.

   - bpo-23632(4): Memoryviews now allow tuple indexing (including for
     multi-dimensional memoryviews).

   - bpo-23192(5): Fixed generator lambdas.  Patch by Bruno Cauet.

   - bpo-23629(6): Fix the default __sizeof__ implementation for
     variable-sized objects.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23573

   (2) https://bugs.python.org/issue23753

   (3) https://bugs.python.org/issue23681

   (4) https://bugs.python.org/issue23632

   (5) https://bugs.python.org/issue23192

   (6) https://bugs.python.org/issue23629


File: python.info,  Node: Library<69>,  Next: Build<46>,  Prev: Core and Builtins<55>,  Up: Python 3 5 0 alpha 3

1.18.68.2 Library
.................

   - bpo-14260(1): The groupindex attribute of regular expression
     pattern object now is non-modifiable mapping.

   - bpo-23792(2): Ignore KeyboardInterrupt when the pydoc pager is
     active.  This mimics the behavior of the standard unix pagers, and
     prevents pipepager from shutting down while the pager itself is
     still running.

   - bpo-23775(3): pprint() of OrderedDict now outputs the same
     representation as repr().

   - bpo-23765(4): Removed IsBadStringPtr calls in ctypes

   - bpo-22364(5): Improved some re error messages using regex for
     hints.

   - bpo-23742(6): ntpath.expandvars() no longer loses unbalanced single
     quotes.

   - bpo-21717(7): The zipfile.ZipFile.open function now supports ‘x’
     (exclusive creation) mode.

   - bpo-21802(8): The reader in BufferedRWPair now is closed even when
     closing writer failed in BufferedRWPair.close().

   - bpo-23622(9): Unknown escapes in regular expressions that consist
     of ‘'\'’ and ASCII letter now raise a deprecation warning and will
     be forbidden in Python 3.6.

   - bpo-23671(10): string.Template now allows specifying the “self”
     parameter as a keyword argument.  string.Formatter now allows
     specifying the “self” and the “format_string” parameters as keyword
     arguments.

   - bpo-23502(11): The pprint module now supports mapping proxies.

   - bpo-17530(12): pprint now wraps long bytes objects and bytearrays.

   - bpo-22687(13): Fixed some corner cases in breaking words in
     tetxtwrap.  Got rid of quadratic complexity in breaking long words.

   - bpo-4727(14): The copy module now uses pickle protocol 4 (PEP 3154)
     and supports copying of instances of classes whose __new__ method
     takes keyword-only arguments.

   - bpo-23491(15): Added a zipapp module to support creating executable
     zip file archives of Python code.  Registered “.pyz” and “.pyzw”
     extensions on Windows for these archives (PEP 441).

   - bpo-23657(16): Avoid explicit checks for str in zipapp, adding
     support for pathlib.Path objects as arguments.

   - bpo-23688(17): Added support of arbitrary bytes-like objects and
     avoided unnecessary copying of memoryview in gzip.GzipFile.write().
     Original patch by Wolfgang Maier.

   - bpo-23252(18): Added support for writing ZIP files to unseekable
     streams.

   - bpo-23647(19): Increase imaplib’s MAXLINE to accommodate modern
     mailbox sizes.

   - bpo-23539(20): If body is None, http.client.HTTPConnection.request
     now sets Content-Length to 0 for PUT, POST, and PATCH headers to
     avoid 411 errors from some web servers.

   - bpo-22351(21): The nntplib.NNTP constructor no longer leaves the
     connection and socket open until the garbage collector cleans them
     up.  Patch by Martin Panter.

   - bpo-23704(22): collections.deque() objects now support methods for
     index(), insert(), and copy().  This allows deques to be registered
     as a MutableSequence and it improves their substitutability for
     lists.

   - bpo-23715(23): *note signal.sigwaitinfo(): 673. and *note
     signal.sigtimedwait(): 672. are now retried when interrupted by a
     signal not in the `sigset' parameter, if the signal handler does
     not raise an exception.  signal.sigtimedwait() recomputes the
     timeout with a monotonic clock when it is retried.

   - bpo-23001(24): Few functions in modules mmap, ossaudiodev, socket,
     ssl, and codecs, that accepted only read-only bytes-like object now
     accept writable bytes-like object too.

   - bpo-23646(25): If time.sleep() is interrupted by a signal, the
     sleep is now retried with the recomputed delay, except if the
     signal handler raises an exception (PEP 475).

   - bpo-23136(26): _strptime now uniformly handles all days in week 0,
     including Dec 30 of previous year.  Based on patch by Jim Carroll.

   - bpo-23700(27): Iterator of NamedTemporaryFile now keeps a reference
     to NamedTemporaryFile instance.  Patch by Bohuslav Kabrda.

   - bpo-22903(28): The fake test case created by unittest.loader when
     it fails importing a test module is now picklable.

   - bpo-22181(29): On Linux, os.urandom() now uses the new getrandom()
     syscall if available, syscall introduced in the Linux kernel 3.17.
     It is more reliable and more secure, because it avoids the need of
     a file descriptor and waits until the kernel has enough entropy.

   - bpo-2211(30): Updated the implementation of the http.cookies.Morsel
     class.  Setting attributes key, value and coded_value directly now
     is deprecated.  update() and setdefault() now transform and check
     keys.  Comparing for equality now takes into account attributes
     key, value and coded_value.  copy() now returns a Morsel, not a
     dict.  repr() now contains all attributes.  Optimized checking keys
     and quoting values.  Added new tests.  Original patch by Demian
     Brecht.

   - bpo-18983(31): Allow selection of output units in timeit.  Patch by
     Julian Gindi.

   - bpo-23631(32): Fix traceback.format_list when a traceback has been
     mutated.

   - bpo-23568(33): Add rdivmod support to MagicMock() objects.  Patch
     by Håkan Lövdahl.

   - bpo-2052(34): Add charset parameter to HtmlDiff.make_file().

   - bpo-23668(35): Support os.truncate and os.ftruncate on Windows.

   - bpo-23138(36): Fixed parsing cookies with absent keys or values in
     cookiejar.  Patch by Demian Brecht.

   - bpo-23051(37): multiprocessing.Pool methods imap() and
     imap_unordered() now handle exceptions raised by an iterator.
     Patch by Alon Diamant and Davin Potts.

   - bpo-23581(38): Add matmul support to MagicMock.  Patch by Håkan
     Lövdahl.

   - bpo-23566(39): enable(), register(), dump_traceback() and
     dump_traceback_later() functions of faulthandler now accept file
     descriptors.  Patch by Wei Wu.

   - bpo-22928(40): Disabled HTTP header injections in http.client.
     Original patch by Demian Brecht.

   - bpo-23615(41): Modules bz2, tarfile and tokenize now can be
     reloaded with imp.reload().  Patch by Thomas Kluyver.

   - bpo-23605(42): os.walk() now calls os.scandir() instead of
     os.listdir().  The usage of os.scandir() reduces the number of
     calls to os.stat().  Initial patch written by Ben Hoyt.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14260

   (2) https://bugs.python.org/issue23792

   (3) https://bugs.python.org/issue23775

   (4) https://bugs.python.org/issue23765

   (5) https://bugs.python.org/issue22364

   (6) https://bugs.python.org/issue23742

   (7) https://bugs.python.org/issue21717

   (8) https://bugs.python.org/issue21802

   (9) https://bugs.python.org/issue23622

   (10) https://bugs.python.org/issue23671

   (11) https://bugs.python.org/issue23502

   (12) https://bugs.python.org/issue17530

   (13) https://bugs.python.org/issue22687

   (14) https://bugs.python.org/issue4727

   (15) https://bugs.python.org/issue23491

   (16) https://bugs.python.org/issue23657

   (17) https://bugs.python.org/issue23688

   (18) https://bugs.python.org/issue23252

   (19) https://bugs.python.org/issue23647

   (20) https://bugs.python.org/issue23539

   (21) https://bugs.python.org/issue22351

   (22) https://bugs.python.org/issue23704

   (23) https://bugs.python.org/issue23715

   (24) https://bugs.python.org/issue23001

   (25) https://bugs.python.org/issue23646

   (26) https://bugs.python.org/issue23136

   (27) https://bugs.python.org/issue23700

   (28) https://bugs.python.org/issue22903

   (29) https://bugs.python.org/issue22181

   (30) https://bugs.python.org/issue2211

   (31) https://bugs.python.org/issue18983

   (32) https://bugs.python.org/issue23631

   (33) https://bugs.python.org/issue23568

   (34) https://bugs.python.org/issue2052

   (35) https://bugs.python.org/issue23668

   (36) https://bugs.python.org/issue23138

   (37) https://bugs.python.org/issue23051

   (38) https://bugs.python.org/issue23581

   (39) https://bugs.python.org/issue23566

   (40) https://bugs.python.org/issue22928

   (41) https://bugs.python.org/issue23615

   (42) https://bugs.python.org/issue23605


File: python.info,  Node: Build<46>,  Next: Tests<45>,  Prev: Library<69>,  Up: Python 3 5 0 alpha 3

1.18.68.3 Build
...............

   - bpo-23585(1): make patchcheck will ensure the interpreter is built.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23585


File: python.info,  Node: Tests<45>,  Next: Tools/Demos<31>,  Prev: Build<46>,  Up: Python 3 5 0 alpha 3

1.18.68.4 Tests
...............

   - bpo-23583(1): Added tests for standard IO streams in IDLE.

   - bpo-22289(2): Prevent test_urllib2net failures due to ftp
     connection timeout.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23583

   (2) https://bugs.python.org/issue22289


File: python.info,  Node: Tools/Demos<31>,  Prev: Tests<45>,  Up: Python 3 5 0 alpha 3

1.18.68.5 Tools/Demos
.....................

   - bpo-22826(1): The result of open() in Tools/freeze/bkfile.py is now
     better compatible with regular files (in particular it now supports
     the context management protocol).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22826


File: python.info,  Node: Python 3 5 0 alpha 2,  Next: Python 3 5 0 alpha 1,  Prev: Python 3 5 0 alpha 3,  Up: Changelog

1.18.69 Python 3.5.0 alpha 2
----------------------------

`Release date: 2015-03-09'

* Menu:

* Core and Builtins: Core and Builtins<56>.
* Library: Library<70>.
* Build: Build<47>.
* C API: C API<31>.
* Windows: Windows<41>.


File: python.info,  Node: Core and Builtins<56>,  Next: Library<70>,  Up: Python 3 5 0 alpha 2

1.18.69.1 Core and Builtins
...........................

   - bpo-23571(1): PyObject_Call() and PyCFunction_Call() now raise a
     SystemError if a function returns a result and raises an exception.
     The SystemError is chained to the previous exception.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23571


File: python.info,  Node: Library<70>,  Next: Build<47>,  Prev: Core and Builtins<56>,  Up: Python 3 5 0 alpha 2

1.18.69.2 Library
.................

   - bpo-22524(1): New os.scandir() function, part of the PEP 471(2):
     “os.scandir() function – a better and faster directory iterator”.
     Patch written by Ben Hoyt.

   - bpo-23103(3): Reduced the memory consumption of IPv4Address and
     IPv6Address.

   - bpo-21793(4): BaseHTTPRequestHandler again logs response code as
     numeric, not as stringified enum.  Patch by Demian Brecht.

   - bpo-23476(5): In the ssl module, enable OpenSSL’s
     X509_V_FLAG_TRUSTED_FIRST flag on certificate stores when it is
     available.

   - bpo-23576(6): Avoid stalling in SSL reads when EOF has been reached
     in the SSL layer but the underlying connection hasn’t been closed.

   - bpo-23504(7): Added an __all__ to the types module.

   - bpo-23563(8): Optimized utility functions in urllib.parse.

   - bpo-7830(9): Flatten nested functools.partial.

   - bpo-20204(10): Added the __module__ attribute to _tkinter classes.

   - bpo-19980(11): Improved help() for non-recognized strings.
     help(‘’) now shows the help on str.  help(‘help’) now shows the
     help on help().  Original patch by Mark Lawrence.

   - bpo-23521(12): Corrected pure python implementation of timedelta
     division.  Eliminated OverflowError from ‘timedelta * float’ for
     some floats; Corrected rounding in timedelta true division.

   - bpo-21619(13): Popen objects no longer leave a zombie after exit in
     the with statement if the pipe was broken.  Patch by Martin Panter.

   - bpo-22936(14): Make it possible to show local variables in
     tracebacks for both the traceback module and unittest.

   - bpo-15955(15): Add an option to limit the output size in
     bz2.decompress().  Patch by Nikolaus Rath.

   - bpo-6639(16): Module-level turtle functions no longer raise
     TclError after closing the window.

   - bpo-814253(17): Group references and conditional group references
     now work in lookbehind assertions in regular expressions.  (See
     also: bpo-9179(18))

   - bpo-23215(19): Multibyte codecs with custom error handlers that
     ignores errors consumed too much memory and raised SystemError or
     MemoryError.  Original patch by Aleksi Torhamo.

   - bpo-5700(20): io.FileIO() called flush() after closing the file.
     flush() was not called in close() if closefd=False.

   - bpo-23374(21): Fixed pydoc failure with non-ASCII files when stdout
     encoding differs from file system encoding (e.g.  on Mac OS).

   - bpo-23481(22): Remove RC4 from the SSL module’s default cipher
     list.

   - bpo-21548(23): Fix pydoc.synopsis() and pydoc.apropos() on modules
     with empty docstrings.

   - bpo-22885(24): Fixed arbitrary code execution vulnerability in the
     dbm.dumb module.  Original patch by Claudiu Popa.

   - bpo-23239(25): ssl.match_hostname() now supports matching of IP
     addresses.

   - bpo-23146(26): Fix mishandling of absolute Windows paths with
     forward slashes in pathlib.

   - bpo-23096(27): Pickle representation of floats with protocol 0 now
     is the same for both Python and C implementations.

   - bpo-19105(28): pprint now more efficiently uses free space at the
     right.

   - bpo-14910(29): Add allow_abbrev parameter to
     argparse.ArgumentParser.  Patch by Jonathan Paugh, Steven Bethard,
     paul j3 and Daniel Eriksson.

   - bpo-21717(30): tarfile.open() now supports ‘x’ (exclusive creation)
     mode.

   - bpo-23344(31): marshal.dumps() is now 20-25% faster on average.

   - bpo-20416(32): marshal.dumps() with protocols 3 and 4 is now 40-50%
     faster on average.

   - bpo-23421(33): Fixed compression in tarfile CLI. Patch by wdv4758h.

   - bpo-23367(34): Fix possible overflows in the unicodedata module.

   - bpo-23361(35): Fix possible overflow in Windows subprocess creation
     code.

   - logging.handlers.QueueListener now takes a respect_handler_level
     keyword argument which, if set to True, will pass messages to
     handlers taking handler levels into account.

   - bpo-19705(36): turtledemo now has a visual sorting algorithm demo.
     Original patch from Jason Yeo.

   - bpo-23801(37): Fix issue where cgi.FieldStorage did not always
     ignore the entire preamble to a multipart body.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22524

   (2) https://www.python.org/dev/peps/pep-0471

   (3) https://bugs.python.org/issue23103

   (4) https://bugs.python.org/issue21793

   (5) https://bugs.python.org/issue23476

   (6) https://bugs.python.org/issue23576

   (7) https://bugs.python.org/issue23504

   (8) https://bugs.python.org/issue23563

   (9) https://bugs.python.org/issue7830

   (10) https://bugs.python.org/issue20204

   (11) https://bugs.python.org/issue19980

   (12) https://bugs.python.org/issue23521

   (13) https://bugs.python.org/issue21619

   (14) https://bugs.python.org/issue22936

   (15) https://bugs.python.org/issue15955

   (16) https://bugs.python.org/issue6639

   (17) https://bugs.python.org/issue814253

   (18) https://bugs.python.org/issue9179

   (19) https://bugs.python.org/issue23215

   (20) https://bugs.python.org/issue5700

   (21) https://bugs.python.org/issue23374

   (22) https://bugs.python.org/issue23481

   (23) https://bugs.python.org/issue21548

   (24) https://bugs.python.org/issue22885

   (25) https://bugs.python.org/issue23239

   (26) https://bugs.python.org/issue23146

   (27) https://bugs.python.org/issue23096

   (28) https://bugs.python.org/issue19105

   (29) https://bugs.python.org/issue14910

   (30) https://bugs.python.org/issue21717

   (31) https://bugs.python.org/issue23344

   (32) https://bugs.python.org/issue20416

   (33) https://bugs.python.org/issue23421

   (34) https://bugs.python.org/issue23367

   (35) https://bugs.python.org/issue23361

   (36) https://bugs.python.org/issue19705

   (37) https://bugs.python.org/issue23801


File: python.info,  Node: Build<47>,  Next: C API<31>,  Prev: Library<70>,  Up: Python 3 5 0 alpha 2

1.18.69.3 Build
...............

   - bpo-23445(1): pydebug builds now use “gcc -Og” where possible, to
     make the resulting executable faster.

   - bpo-23686(2): Update OS X 10.5 installer build to use OpenSSL
     1.0.2a.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23445

   (2) https://bugs.python.org/issue23686


File: python.info,  Node: C API<31>,  Next: Windows<41>,  Prev: Build<47>,  Up: Python 3 5 0 alpha 2

1.18.69.4 C API
...............

   - bpo-20204(1): Deprecation warning is now raised for builtin types
     without the __module__ attribute.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20204


File: python.info,  Node: Windows<41>,  Prev: C API<31>,  Up: Python 3 5 0 alpha 2

1.18.69.5 Windows
.................

   - bpo-23465(1): Implement PEP 486(2) - Make the Python Launcher aware
     of virtual environments.  Patch by Paul Moore.

   - bpo-23437(3): Make user scripts directory versioned on Windows.
     Patch by Paul Moore.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23465

   (2) https://www.python.org/dev/peps/pep-0486

   (3) https://bugs.python.org/issue23437


File: python.info,  Node: Python 3 5 0 alpha 1,  Prev: Python 3 5 0 alpha 2,  Up: Changelog

1.18.70 Python 3.5.0 alpha 1
----------------------------

`Release date: 2015-02-08'

* Menu:

* Core and Builtins: Core and Builtins<57>.
* Library: Library<71>.
* IDLE: IDLE<40>.
* Build: Build<48>.
* C API: C API<32>.
* Documentation: Documentation<41>.
* Tests: Tests<46>.
* Tools/Demos: Tools/Demos<32>.
* Windows: Windows<42>.


File: python.info,  Node: Core and Builtins<57>,  Next: Library<71>,  Up: Python 3 5 0 alpha 1

1.18.70.1 Core and Builtins
...........................

   - bpo-23285(1): PEP 475 - EINTR handling.

   - bpo-22735(2): Fix many edge cases (including crashes) involving
     custom mro() implementations.

   - bpo-22896(3): Avoid using PyObject_AsCharBuffer(),
     PyObject_AsReadBuffer() and PyObject_AsWriteBuffer().

   - bpo-21295(4): Revert some changes (bpo-16795(5)) to AST line
     numbers and column offsets that constituted a regression.

   - bpo-22986(6): Allow changing an object’s __class__ between a
     dynamic type and static type in some cases.

   - bpo-15859(7): PyUnicode_EncodeFSDefault(), PyUnicode_EncodeMBCS()
     and PyUnicode_EncodeCodePage() now raise an exception if the object
     is not a Unicode object.  For PyUnicode_EncodeFSDefault(), it was
     already the case on platforms other than Windows.  Patch written by
     Campbell Barton.

   - bpo-21408(8): The default __ne__() now returns NotImplemented if
     __eq__() returned NotImplemented.  Original patch by Martin Panter.

   - bpo-23321(9): Fixed a crash in str.decode() when error handler
     returned replacement string longer than malformed input data.

   - bpo-22286(10): The “backslashreplace” error handlers now works with
     decoding and translating.

   - bpo-23253(11): Delay-load ShellExecute[AW] in os.startfile for
     reduced startup overhead on Windows.

   - bpo-22038(12): pyatomic.h now uses stdatomic.h or GCC built-in
     functions for atomic memory access if available.  Patch written by
     Vitor de Lima and Gustavo Temple.

   - bpo-20284(13): %-interpolation (aka printf) formatting added for
     bytes and bytearray.

   - bpo-23048(14): Fix jumping out of an infinite while loop in the
     pdb.

   - bpo-20335(15): bytes constructor now raises TypeError when encoding
     or errors is specified with non-string argument.  Based on patch by
     Renaud Blanch.

   - bpo-22834(16): If the current working directory ends up being set
     to a non-existent directory then import will no longer raise
     FileNotFoundError.

   - bpo-22869(17): Move the interpreter startup & shutdown code to a
     new dedicated pylifecycle.c module

   - bpo-22847(18): Improve method cache efficiency.

   - bpo-22335(19): Fix crash when trying to enlarge a bytearray to
     0x7fffffff bytes on a 32-bit platform.

   - bpo-22653(20): Fix an assertion failure in debug mode when doing a
     reentrant dict insertion in debug mode.

   - bpo-22643(21): Fix integer overflow in Unicode case operations
     (upper, lower, title, swapcase, casefold).

   - bpo-17636(22): Circular imports involving relative imports are now
     supported.

   - bpo-22604(23): Fix assertion error in debug mode when dividing a
     complex number by (nan+0j).

   - bpo-21052(24): Do not raise ImportWarning when sys.path_hooks or
     sys.meta_path are set to None.

   - bpo-16518(25): Use ‘bytes-like object required’ in error messages
     that previously used the far more cryptic “‘x’ does not support the
     buffer protocol.

   - bpo-22470(26): Fixed integer overflow issues in “backslashreplace”,
     “xmlcharrefreplace”, and “surrogatepass” error handlers.

   - bpo-22540(27): speed up ‘PyObject_IsInstance’ and
     ‘PyObject_IsSubclass’ in the common case that the second argument
     has metaclass *note type: 5fd.

   - bpo-18711(28): Add a new ‘PyErr_FormatV’ function, similar to
     ‘PyErr_Format’ but accepting a ‘va_list’ argument.

   - bpo-22520(29): Fix overflow checking when generating the repr of a
     unicode object.

   - bpo-22519(30): Fix overflow checking in PyBytes_Repr.

   - bpo-22518(31): Fix integer overflow issues in latin-1 encoding.

   - bpo-16324(32): _charset parameter of MIMEText now also accepts
     email.charset.Charset instances.  Initial patch by Claude Paroz.

   - bpo-1764286(33): Fix inspect.getsource() to support decorated
     functions.  Patch by Claudiu Popa.

   - bpo-18554(34): os.__all__ includes posix functions.

   - bpo-21391(35): Use os.path.abspath in the shutil module.

   - bpo-11471(36): avoid generating a JUMP_FORWARD instruction at the
     end of an if-block if there is no else-clause.  Original patch by
     Eugene Toder.

   - bpo-22215(37): Now ValueError is raised instead of TypeError when
     str or bytes argument contains not permitted null character or
     byte.

   - bpo-22258(38): Fix the internal function set_inheritable() on
     Illumos.  This platform exposes the function ‘ioctl(FIOCLEX)’, but
     calling it fails with errno is ENOTTY: “Inappropriate ioctl for
     device”.  set_inheritable() now falls back to the slower ‘fcntl()’
     (‘F_GETFD’ and then ‘F_SETFD’).

   - bpo-21389(39): Displaying the __qualname__ of the underlying
     function in the repr of a bound method.

   - bpo-22206(40): Using pthread, PyThread_create_key() now sets errno
     to ENOMEM and returns -1 (error) on integer overflow.

   - bpo-20184(41): Argument Clinic based signature introspection added
     for 30 of the builtin functions.

   - bpo-22116(42): C functions and methods (of the
     ‘builtin_function_or_method’ type) can now be weakref’ed.  Patch by
     Wei Wu.

   - bpo-22077(43): Improve index error messages for bytearrays, bytes,
     lists, and tuples by adding ‘or slices’.  Added ‘, not <typename>’
     for bytearrays.  Original patch by Claudiu Popa.

   - bpo-20179(44): Apply Argument Clinic to bytes and bytearray.  Patch
     by Tal Einat.

   - bpo-22082(45): Clear interned strings in slotdefs.

   - Upgrade Unicode database to Unicode 7.0.0.

   - bpo-21897(46): Fix a crash with the f_locals attribute with closure
     variables when frame.clear() has been called.

   - bpo-21205(47): Add a new ‘__qualname__’ attribute to generator, the
     qualified name, and use it in the representation of a generator
     (‘repr(gen)’).  The default name of the generator (‘__name__’
     attribute) is now get from the function instead of the code.  Use
     ‘gen.gi_code.co_name’ to get the name of the code.

   - bpo-21669(48): With the aid of heuristics in SyntaxError.__init__,
     the parser now attempts to generate more meaningful (or at least
     more search engine friendly) error messages when “exec” and “print”
     are used as statements.

   - bpo-21642(49): In the conditional if-else expression, allow an
     integer written with no space between itself and the ‘else’ keyword
     (e.g.  ‘True if 42else False’) to be valid syntax.

   - bpo-21523(50): Fix over-pessimistic computation of the stack effect
     of some opcodes in the compiler.  This also fixes a quadratic
     compilation time issue noticeable when compiling code with a large
     number of “and” and “or” operators.

   - bpo-21418(51): Fix a crash in the builtin function super() when
     called without argument and without current frame (ex: embedded
     Python).

   - bpo-21425(52): Fix flushing of standard streams in the interactive
     interpreter.

   - bpo-21435(53): In rare cases, when running finalizers on objects in
     cyclic trash a bad pointer dereference could occur due to a subtle
     flaw in internal iteration logic.

   - bpo-21377(54): PyBytes_Concat() now tries to concatenate in-place
     when the first argument has a reference count of 1.  Patch by
     Nikolaus Rath.

   - bpo-20355(55): -W command line options now have higher priority
     than the PYTHONWARNINGS environment variable.  Patch by Arfrever.

   - bpo-21274(56): Define PATH_MAX for GNU/Hurd in Python/pythonrun.c.

   - bpo-20904(57): Support setting FPU precision on m68k.

   - bpo-21209(58): Fix sending tuples to custom generator objects with
     the yield from syntax.

   - bpo-21193(59): pow(a, b, c) now raises ValueError rather than
     TypeError when b is negative.  Patch by Josh Rosenberg.

   - bpo-21176(60): PEP 465: Add the ‘@’ operator for matrix
     multiplication.

   - bpo-21134(61): Fix segfault when str is called on an uninitialized
     UnicodeEncodeError, UnicodeDecodeError, or UnicodeTranslateError
     object.

   - bpo-19537(62): Fix PyUnicode_DATA() alignment under m68k.  Patch by
     Andreas Schwab.

   - bpo-20929(63): Add a type cast to avoid shifting a negative number.

   - bpo-20731(64): Properly position in source code files even if they
     are opened in text mode.  Patch by Serhiy Storchaka.

   - bpo-20637(65): Key-sharing now also works for instance dictionaries
     of subclasses.  Patch by Peter Ingebretson.

   - bpo-8297(66): Attributes missing from modules now include the
     module name in the error text.  Original patch by ysj.ray.

   - bpo-19995(67): %c, %o, %x, and %X now raise TypeError on
     non-integer input.

   - bpo-19655(68): The ASDL parser - used by the build process to
     generate code for managing the Python AST in C - was rewritten.
     The new parser is self contained and does not require to carry long
     the spark.py parser-generator library; spark.py was removed from
     the source base.

   - bpo-12546(69): Allow ‘\x00’ to be used as a fill character when
     using str, int, float, and complex __format__ methods.

   - bpo-20480(70): Add ipaddress.reverse_pointer.  Patch by Leon Weber.

   - bpo-13598(71): Modify string.Formatter to support auto-numbering of
     replacement fields.  It now matches the behavior of str.format() in
     this regard.  Patches by Phil Elson and Ramchandra Apte.

   - bpo-8931(72): Make alternate formatting (‘#’) for type ‘c’ raise an
     exception.  In versions prior to 3.5, ‘#’ with ‘c’ had no effect.
     Now specifying it is an error.  Patch by Torsten Landschoff.

   - bpo-23165(73): Perform overflow checks before allocating memory in
     the _Py_char2wchar function.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23285

   (2) https://bugs.python.org/issue22735

   (3) https://bugs.python.org/issue22896

   (4) https://bugs.python.org/issue21295

   (5) https://bugs.python.org/issue16795

   (6) https://bugs.python.org/issue22986

   (7) https://bugs.python.org/issue15859

   (8) https://bugs.python.org/issue21408

   (9) https://bugs.python.org/issue23321

   (10) https://bugs.python.org/issue22286

   (11) https://bugs.python.org/issue23253

   (12) https://bugs.python.org/issue22038

   (13) https://bugs.python.org/issue20284

   (14) https://bugs.python.org/issue23048

   (15) https://bugs.python.org/issue20335

   (16) https://bugs.python.org/issue22834

   (17) https://bugs.python.org/issue22869

   (18) https://bugs.python.org/issue22847

   (19) https://bugs.python.org/issue22335

   (20) https://bugs.python.org/issue22653

   (21) https://bugs.python.org/issue22643

   (22) https://bugs.python.org/issue17636

   (23) https://bugs.python.org/issue22604

   (24) https://bugs.python.org/issue21052

   (25) https://bugs.python.org/issue16518

   (26) https://bugs.python.org/issue22470

   (27) https://bugs.python.org/issue22540

   (28) https://bugs.python.org/issue18711

   (29) https://bugs.python.org/issue22520

   (30) https://bugs.python.org/issue22519

   (31) https://bugs.python.org/issue22518

   (32) https://bugs.python.org/issue16324

   (33) https://bugs.python.org/issue1764286

   (34) https://bugs.python.org/issue18554

   (35) https://bugs.python.org/issue21391

   (36) https://bugs.python.org/issue11471

   (37) https://bugs.python.org/issue22215

   (38) https://bugs.python.org/issue22258

   (39) https://bugs.python.org/issue21389

   (40) https://bugs.python.org/issue22206

   (41) https://bugs.python.org/issue20184

   (42) https://bugs.python.org/issue22116

   (43) https://bugs.python.org/issue22077

   (44) https://bugs.python.org/issue20179

   (45) https://bugs.python.org/issue22082

   (46) https://bugs.python.org/issue21897

   (47) https://bugs.python.org/issue21205

   (48) https://bugs.python.org/issue21669

   (49) https://bugs.python.org/issue21642

   (50) https://bugs.python.org/issue21523

   (51) https://bugs.python.org/issue21418

   (52) https://bugs.python.org/issue21425

   (53) https://bugs.python.org/issue21435

   (54) https://bugs.python.org/issue21377

   (55) https://bugs.python.org/issue20355

   (56) https://bugs.python.org/issue21274

   (57) https://bugs.python.org/issue20904

   (58) https://bugs.python.org/issue21209

   (59) https://bugs.python.org/issue21193

   (60) https://bugs.python.org/issue21176

   (61) https://bugs.python.org/issue21134

   (62) https://bugs.python.org/issue19537

   (63) https://bugs.python.org/issue20929

   (64) https://bugs.python.org/issue20731

   (65) https://bugs.python.org/issue20637

   (66) https://bugs.python.org/issue8297

   (67) https://bugs.python.org/issue19995

   (68) https://bugs.python.org/issue19655

   (69) https://bugs.python.org/issue12546

   (70) https://bugs.python.org/issue20480

   (71) https://bugs.python.org/issue13598

   (72) https://bugs.python.org/issue8931

   (73) https://bugs.python.org/issue23165


File: python.info,  Node: Library<71>,  Next: IDLE<40>,  Prev: Core and Builtins<57>,  Up: Python 3 5 0 alpha 1

1.18.70.2 Library
.................

   - bpo-23399(1): pyvenv creates relative symlinks where possible.

   - bpo-20289(2): cgi.FieldStorage() now supports the context
     management protocol.

   - bpo-13128(3): Print response headers for CONNECT requests when
     debuglevel > 0.  Patch by Demian Brecht.

   - bpo-15381(4): Optimized io.BytesIO to make less allocations and
     copyings.

   - bpo-22818(5): Splitting on a pattern that could match an empty
     string now raises a warning.  Patterns that can only match empty
     strings are now rejected.

   - bpo-23099(6): Closing io.BytesIO with exported buffer is rejected
     now to prevent corrupting exported buffer.

   - bpo-23326(7): Removed __ne__ implementations.  Since fixing default
     __ne__ implementation in bpo-21408(8) they are redundant.

   - bpo-23363(9): Fix possible overflow in itertools.permutations.

   - bpo-23364(10): Fix possible overflow in itertools.product.

   - bpo-23366(11): Fixed possible integer overflow in
     itertools.combinations.

   - bpo-23369(12): Fixed possible integer overflow in
     _json.encode_basestring_ascii.

   - bpo-23353(13): Fix the exception handling of generators in
     PyEval_EvalFrameEx().  At entry, save or swap the exception state
     even if PyEval_EvalFrameEx() is called with throwflag=0.  At exit,
     the exception state is now always restored or swapped, not only if
     why is WHY_YIELD or WHY_RETURN. Patch co-written with Antoine
     Pitrou.

   - bpo-14099(14): Restored support of writing ZIP files to tellable
     but non-seekable streams.

   - bpo-14099(15): Writing to ZipFile and reading multiple ZipExtFiles
     is threadsafe now.

   - bpo-19361(16): JSON decoder now raises JSONDecodeError instead of
     ValueError.

   - bpo-18518(17): timeit now rejects statements which can’t be
     compiled outside a function or a loop (e.g.  “return” or “break”).

   - bpo-23094(18): Fixed readline with frames in Python implementation
     of pickle.

   - bpo-23268(19): Fixed bugs in the comparison of ipaddress classes.

   - bpo-21408(20): Removed incorrect implementations of __ne__() which
     didn’t returned NotImplemented if __eq__() returned NotImplemented.
     The default __ne__() now works correctly.

   - bpo-19996(21): ‘email.feedparser.FeedParser’ now handles
     (malformed) headers with no key rather than assuming the body has
     started.

   - bpo-20188(22): Support Application-Layer Protocol Negotiation
     (ALPN) in the ssl module.

   - bpo-23133(23): Pickling of ipaddress objects now produces more
     compact and portable representation.

   - bpo-23248(24): Update ssl error codes from latest OpenSSL git
     master.

   - bpo-23266(25): Much faster implementation of
     ipaddress.collapse_addresses() when there are many non-consecutive
     addresses.

   - bpo-23098(26): 64-bit dev_t is now supported in the os module.

   - bpo-21817(27): When an exception is raised in a task submitted to a
     ProcessPoolExecutor, the remote traceback is now displayed in the
     parent process.  Patch by Claudiu Popa.

   - bpo-15955(28): Add an option to limit output size when
     decompressing LZMA data.  Patch by Nikolaus Rath and Martin Panter.

   - bpo-23250(29): In the http.cookies module, capitalize “HttpOnly”
     and “Secure” as they are written in the standard.

   - bpo-23063(30): In the distutils’ check command, fix parsing of reST
     with code or code-block directives.

   - bpo-23209(31): selectors.BaseSelector.get_key() now raises a
     RuntimeError if the selector is closed.  And
     selectors.BaseSelector.close() now clears its internal reference to
     the selector mapping to break a reference cycle.  Initial patch
     written by Martin Richard.  (See also: bpo-23225(32))

   - bpo-17911(33): Provide a way to seed the linecache for a PEP-302
     module without actually loading the code.

   - bpo-17911(34): Provide a new object API for traceback, including
     the ability to not lookup lines at all until the traceback is
     actually rendered, without any trace of the original objects being
     kept alive.

   - bpo-19777(35): Provide a home() classmethod on Path objects.
     Contributed by Victor Salgado and Mayank Tripathi.

   - bpo-23206(36): Make ‘json.dumps(..., ensure_ascii=False)’ as fast
     as the default case of ‘ensure_ascii=True’.  Patch by Naoki Inada.

   - bpo-23185(37): Add math.inf and math.nan constants.

   - bpo-23186(38): Add ssl.SSLObject.shared_ciphers() and
     ssl.SSLSocket.shared_ciphers() to fetch the client’s list ciphers
     sent at handshake.

   - bpo-23143(39): Remove compatibility with OpenSSLs older than 0.9.8.

   - bpo-23132(40): Improve performance and introspection support of
     comparison methods created by functool.total_ordering.

   - bpo-19776(41): Add an expanduser() method on Path objects.

   - bpo-23112(42): Fix SimpleHTTPServer to correctly carry the query
     string and fragment when it redirects to add a trailing slash.

   - bpo-21793(43): Added http.HTTPStatus enums (i.e.  HTTPStatus.OK,
     HTTPStatus.NOT_FOUND). Patch by Demian Brecht.

   - bpo-23093(44): In the io, module allow more operations to work on
     detached streams.

   - bpo-23111(45): In the ftplib, make ssl.PROTOCOL_SSLv23 the default
     protocol version.

   - bpo-22585(46): On OpenBSD 5.6 and newer, os.urandom() now calls
     getentropy(), instead of reading /dev/urandom, to get pseudo-random
     bytes.

   - bpo-19104(47): pprint now produces evaluable output for wrapped
     strings.

   - bpo-23071(48): Added missing names to codecs.__all__.  Patch by
     Martin Panter.

   - bpo-22783(49): Pickling now uses the NEWOBJ opcode instead of the
     NEWOBJ_EX opcode if possible.

   - bpo-15513(50): Added a __sizeof__ implementation for pickle
     classes.

   - bpo-19858(51): pickletools.optimize() now aware of the MEMOIZE
     opcode, can produce more compact result and no longer produces
     invalid output if input data contains MEMOIZE opcodes together with
     PUT or BINPUT opcodes.

   - bpo-22095(52): Fixed HTTPConnection.set_tunnel with default port.
     The port value in the host header was set to “None”.  Patch by
     Demian Brecht.

   - bpo-23016(53): A warning no longer produces an AttributeError when
     the program is run with pythonw.exe.

   - bpo-21775(54): shutil.copytree(): fix crash when copying to VFAT.
     An exception handler assumed that OSError objects always have a
     ‘winerror’ attribute.  That is not the case, so the exception
     handler itself raised AttributeError when run on Linux (and,
     presumably, any other non-Windows OS). Patch by Greg Ward.

   - bpo-1218234(55): Fix inspect.getsource() to load updated source of
     reloaded module.  Initial patch by Berker Peksag.

   - bpo-21740(56): Support wrapped callables in doctest.  Patch by
     Claudiu Popa.

   - bpo-23009(57): Make sure selectors.EpollSelector.select() works
     when no FD is registered.

   - bpo-22959(58): In the constructor of http.client.HTTPSConnection,
     prefer the context’s check_hostname attribute over the
     `check_hostname' parameter.

   - bpo-22696(59): Add function *note sys.is_finalizing(): 756. to know
     about interpreter shutdown.

   - bpo-16043(60): Add a default limit for the amount of data
     xmlrpclib.gzip_decode will return.  This resolves CVE-2013-1753.

   - bpo-14099(61): ZipFile.open() no longer reopen the underlying file.
     Objects returned by ZipFile.open() can now operate independently of
     the ZipFile even if the ZipFile was created by passing in a
     file-like object as the first argument to the constructor.

   - bpo-22966(62): Fix __pycache__ pyc file name clobber when
     pyc_compile is asked to compile a source file containing multiple
     dots in the source file name.

   - bpo-21971(63): Update turtledemo doc and add module to the index.

   - bpo-21032(64): Fixed socket leak if HTTPConnection.getresponse()
     fails.  Original patch by Martin Panter.

   - bpo-22407(65): Deprecated the use of re.LOCALE flag with str
     patterns or re.ASCII. It was newer worked.

   - bpo-22902(66): The “ip” command is now used on Linux to determine
     MAC address in uuid.getnode().  Pach by Bruno Cauet.

   - bpo-22960(67): Add a context argument to xmlrpclib.ServerProxy
     constructor.

   - bpo-22389(68): Add contextlib.redirect_stderr().

   - bpo-21356(69): Make ssl.RAND_egd() optional to support LibreSSL.
     The availability of the function is checked during the compilation.
     Patch written by Bernard Spil.

   - bpo-22915(70): SAX parser now supports files opened with file
     descriptor or bytes path.

   - bpo-22609(71): Constructors and update methods of mapping classes
     in the collections module now accept the self keyword argument.

   - bpo-22940(72): Add readline.append_history_file.

   - bpo-19676(73): Added the “namereplace” error handler.

   - bpo-22788(74): Add `context' parameter to
     logging.handlers.HTTPHandler.

   - bpo-22921(75): Allow SSLContext to take the `hostname' parameter
     even if OpenSSL doesn’t support SNI.

   - bpo-22894(76): TestCase.subTest() would cause the test suite to be
     stopped when in failfast mode, even in the absence of failures.

   - bpo-22796(77): HTTP cookie parsing is now stricter, in order to
     protect against potential injection attacks.

   - bpo-22370(78): Windows detection in pathlib is now more robust.

   - bpo-22841(79): Reject coroutines in asyncio add_signal_handler().
     Patch by Ludovic.Gasc.

   - bpo-19494(80): Added urllib.request.HTTPBasicPriorAuthHandler.
     Patch by Matej Cepl.

   - bpo-22578(81): Added attributes to the re.error class.

   - bpo-22849(82): Fix possible double free in the io.TextIOWrapper
     constructor.

   - bpo-12728(83): Different Unicode characters having the same
     uppercase but different lowercase are now matched in
     case-insensitive regular expressions.

   - bpo-22821(84): Fixed fcntl() with integer argument on 64-bit
     big-endian platforms.

   - bpo-21650(85): Add an ‘--sort-keys’ option to json.tool CLI.

   - bpo-22824(86): Updated reprlib output format for sets to use set
     literals.  Patch contributed by Berker Peksag.

   - bpo-22824(87): Updated reprlib output format for arrays to display
     empty arrays without an unnecessary empty list.  Suggested by
     Serhiy Storchaka.

   - bpo-22406(88): Fixed the uu_codec codec incorrectly ported to 3.x.
     Based on patch by Martin Panter.

   - bpo-17293(89): uuid.getnode() now determines MAC address on AIX
     using netstat.  Based on patch by Aivars Kalvāns.

   - bpo-22769(90): Fixed ttk.Treeview.tag_has() when called without
     arguments.

   - bpo-22417(91): Verify certificates by default in httplib (PEP 476).

   - bpo-22775(92): Fixed unpickling of http.cookies.SimpleCookie with
     protocol 2 and above.  Patch by Tim Graham.

   - bpo-22776(93): Brought excluded code into the scope of a try block
     in SysLogHandler.emit().

   - bpo-22665(94): Add missing get_terminal_size and SameFileError to
     shutil.__all__.

   - bpo-6623(95): Remove deprecated Netrc class in the ftplib module.
     Patch by Matt Chaput.

   - bpo-17381(96): Fixed handling of case-insensitive ranges in regular
     expressions.

   - bpo-22410(97): Module level functions in the re module now cache
     compiled locale-dependent regular expressions taking into account
     the locale.

   - bpo-22759(98): Query methods on pathlib.Path() (exists(), is_dir(),
     etc.)  now return False when the underlying stat call raises
     NotADirectoryError.

   - bpo-8876(99): distutils now falls back to copying files when hard
     linking doesn’t work.  This allows use with special filesystems
     such as VirtualBox shared folders.

   - bpo-22217(100): Implemented reprs of classes in the zipfile module.

   - bpo-22457(101): Honour load_tests in the start_dir of discovery.

   - bpo-18216(102): gettext now raises an error when a .mo file has an
     unsupported major version number.  Patch by Aaron Hill.

   - bpo-13918(103): Provide a locale.delocalize() function which can
     remove locale-specific number formatting from a string representing
     a number, without then converting it to a specific type.  Patch by
     Cédric Krier.

   - bpo-22676(104): Make the pickling of global objects which don’t
     have a __module__ attribute less slow.

   - bpo-18853(105): Fixed ResourceWarning in shlex.__nain__.

   - bpo-9351(106): Defaults set with set_defaults on an argparse
     subparser are no longer ignored when also set on the parent parser.

   - bpo-7559(107): unittest test loading ImportErrors are reported as
     import errors with their import exception rather than as attribute
     errors after the import has already failed.

   - bpo-19746(108): Make it possible to examine the errors from
     unittest discovery without executing the test suite.  The new
     ‘errors’ attribute on TestLoader exposes these non-fatal errors
     encountered during discovery.

   - bpo-21991(109): Make email.headerregistry’s header ‘params’
     attributes be read-only (MappingProxyType).  Previously the
     dictionary was modifiable but a new one was created on each access
     of the attribute.

   - bpo-22638(110): SSLv3 is now disabled throughout the standard
     library.  It can still be enabled by instantiating a SSLContext
     manually.

   - bpo-22641(111): In asyncio, the default SSL context for client
     connections is now created using ssl.create_default_context(), for
     stronger security.

   - bpo-17401(112): Include closefd in io.FileIO repr.

   - bpo-21338(113): Add silent mode for compileall.  quiet parameters
     of compile_{dir, file, path} functions now have a multilevel value.
     Also, -q option of the CLI now have a multilevel value.  Patch by
     Thomas Kluyver.

   - bpo-20152(114): Convert the array and cmath modules to Argument
     Clinic.

   - bpo-18643(115): Add socket.socketpair() on Windows.

   - bpo-22435(116): Fix a file descriptor leak when socketserver bind
     fails.

   - bpo-13096(117): Fixed segfault in CTypes POINTER handling of large
     values.

   - bpo-11694(118): Raise ConversionError in xdrlib as documented.
     Patch by Filip Gruszczyński and Claudiu Popa.

   - bpo-19380(119): Optimized parsing of regular expressions.

   - bpo-1519638(120): Now unmatched groups are replaced with empty
     strings in re.sub() and re.subn().

   - bpo-18615(121): sndhdr.what/whathdr now return a namedtuple.

   - bpo-22462(122): Fix pyexpat’s creation of a dummy frame to make it
     appear in exception tracebacks.

   - bpo-21965(123): Add support for in-memory SSL to the ssl module.
     Patch by Geert Jansen.

   - bpo-21173(124): Fix len() on a WeakKeyDictionary when .clear() was
     called with an iterator alive.

   - bpo-11866(125): Eliminated race condition in the computation of
     names for new threads.

   - bpo-21905(126): Avoid RuntimeError in pickle.whichmodule() when
     sys.modules is mutated while iterating.  Patch by Olivier Grisel.

   - bpo-11271(127): concurrent.futures.Executor.map() now takes a
     `chunksize' argument to allow batching of tasks in child processes
     and improve performance of ProcessPoolExecutor.  Patch by Dan
     O’Reilly.

   - bpo-21883(128): os.path.join() and os.path.relpath() now raise a
     TypeError with more helpful error message for unsupported or
     mismatched types of arguments.

   - bpo-22219(129): The zipfile module CLI now adds entries for
     directories (including empty directories) in ZIP file.

   - bpo-22449(130): In the ssl.SSLContext.load_default_certs, consult
     the environmental variables SSL_CERT_DIR and SSL_CERT_FILE on
     Windows.

   - bpo-22508(131): The email.__version__ variable has been removed;
     the email code is no longer shipped separately from the stdlib, and
     __version__ hasn’t been updated in several releases.

   - bpo-20076(132): Added non derived UTF-8 aliases to locale aliases
     table.

   - bpo-20079(133): Added locales supported in glibc 2.18 to locale
     alias table.

   - bpo-20218(134): Added convenience methods read_text/write_text and
     read_bytes/ write_bytes to pathlib.Path objects.

   - bpo-22396(135): On 32-bit AIX platform, don’t expose
     os.posix_fadvise() nor os.posix_fallocate() because their
     prototypes in system headers are wrong.

   - bpo-22517(136): When an io.BufferedRWPair object is deallocated,
     clear its weakrefs.

   - bpo-22437(137): Number of capturing groups in regular expression is
     no longer limited by 100.

   - bpo-17442(138): InteractiveInterpreter now displays the full
     chained traceback in its showtraceback method, to match the built
     in interactive interpreter.

   - bpo-23392(139): Added tests for marshal C API that works with
     FILE*.

   - bpo-10510(140): distutils register and upload methods now use HTML
     standards compliant CRLF line endings.

   - bpo-9850(141): Fixed macpath.join() for empty first component.
     Patch by Oleg Oshmyan.

   - bpo-5309(142): distutils’ build and build_ext commands now accept a
     ‘-j’ option to enable parallel building of extension modules.

   - bpo-22448(143): Improve canceled timer handles cleanup to prevent
     unbound memory usage.  Patch by Joshua Moore-Oliva.

   - bpo-22427(144): TemporaryDirectory no longer attempts to clean up
     twice when used in the with statement in generator.

   - bpo-22362(145): Forbidden ambiguous octal escapes out of range
     0-0o377 in regular expressions.

   - bpo-20912(146): Now directories added to ZIP file have correct Unix
     and MS-DOS directory attributes.

   - bpo-21866(147): ZipFile.close() no longer writes ZIP64 central
     directory records if allowZip64 is false.

   - bpo-22278(148): Fix urljoin problem with relative urls, a
     regression observed after changes to issue22118 were submitted.

   - bpo-22415(149): Fixed debugging output of the GROUPREF_EXISTS
     opcode in the re module.  Removed trailing spaces in debugging
     output.

   - bpo-22423(150): Unhandled exception in thread no longer causes
     unhandled AttributeError when sys.stderr is None.

   - bpo-21332(151): Ensure that ‘bufsize=1’ in subprocess.Popen()
     selects line buffering, rather than block buffering.  Patch by
     Akira Li.

   - bpo-21091(152): Fix API bug:
     email.message.EmailMessage.is_attachment is now a method.

   - bpo-21079(153): Fix email.message.EmailMessage.is_attachment to
     return the correct result when the header has parameters as well as
     a value.

   - bpo-22247(154): Add NNTPError to nntplib.__all__.

   - bpo-22366(155): urllib.request.urlopen will accept a context object
     (SSLContext) as an argument which will then be used for HTTPS
     connection.  Patch by Alex Gaynor.

   - bpo-4180(156): The warnings registries are now reset when the
     filters are modified.

   - bpo-22419(157): Limit the length of incoming HTTP request in
     wsgiref server to 65536 bytes and send a 414 error code for higher
     lengths.  Patch contributed by Devin Cook.

   - Lax cookie parsing in http.cookies could be a security issue when
     combined with non-standard cookie handling in some Web browsers.
     Reported by Sergey Bobrov.

   - bpo-20537(158): logging methods now accept an exception instance as
     well as a Boolean value or exception tuple.  Thanks to Yury
     Selivanov for the patch.

   - bpo-22384(159): An exception in Tkinter callback no longer crashes
     the program when it is run with pythonw.exe.

   - bpo-22168(160): Prevent turtle AttributeError with non-default
     Canvas on OS X.

   - bpo-21147(161): sqlite3 now raises an exception if the request
     contains a null character instead of truncating it.  Based on patch
     by Victor Stinner.

   - bpo-13968(162): The glob module now supports recursive search in
     subdirectories using the ‘**’ pattern.

   - bpo-21951(163): Fixed a crash in Tkinter on AIX when called Tcl
     command with empty string or tuple argument.

   - bpo-21951(164): Tkinter now most likely raises MemoryError instead
     of crash if the memory allocation fails.

   - bpo-22338(165): Fix a crash in the json module on memory allocation
     failure.

   - bpo-12410(166): imaplib.IMAP4 now supports the context management
     protocol.  Original patch by Tarek Ziadé.

   - bpo-21270(167): We now override tuple methods in mock.call objects
     so that they can be used as normal call attributes.

   - bpo-16662(168): load_tests() is now unconditionally run when it is
     present in a package’s __init__.py.
     TestLoader.loadTestsFromModule() still accepts use_load_tests, but
     it is deprecated and ignored.  A new keyword-only attribute
     ‘pattern’ is added and documented.  Patch given by Robert Collins,
     tweaked by Barry Warsaw.

   - bpo-22226(169): First letter no longer is stripped from the
     “status” key in the result of Treeview.heading().

   - bpo-19524(170): Fixed resource leak in the HTTP connection when an
     invalid response is received.  Patch by Martin Panter.

   - bpo-20421(171): Add a .version() method to SSL sockets exposing the
     actual protocol version in use.

   - bpo-19546(172): configparser exceptions no longer expose
     implementation details.  Chained KeyErrors are removed, which leads
     to cleaner tracebacks.  Patch by Claudiu Popa.

   - bpo-22051(173): turtledemo no longer reloads examples to re-run
     them.  Initialization of variables and gui setup should be done in
     main(), which is called each time a demo is run, but not on import.

   - bpo-21933(174): Turtledemo users can change the code font size with
     a menu selection or control(command) ‘-‘ or ‘+’ or
     control-mousewheel.  Original patch by Lita Cho.

   - bpo-21597(175): The separator between the turtledemo text pane and
     the drawing canvas can now be grabbed and dragged with a mouse.
     The code text pane can be widened to easily view or copy the full
     width of the text.  The canvas can be widened on small screens.
     Original patches by Jan Kanis and Lita Cho.

   - bpo-18132(176): Turtledemo buttons no longer disappear when the
     window is shrunk.  Original patches by Jan Kanis and Lita Cho.

   - bpo-22043(177): time.monotonic() is now always available.
     ‘threading.Lock.acquire()’, ‘threading.RLock.acquire()’ and socket
     operations now use a monotonic clock, instead of the system clock,
     when a timeout is used.

   - bpo-21527(178): Add a default number of workers to
     ThreadPoolExecutor equal to 5 times the number of CPUs.  Patch by
     Claudiu Popa.

   - bpo-22216(179): smtplib now resets its state more completely after
     a quit.  The most obvious consequence of the previous behavior was
     a STARTTLS failure during a connect/starttls/quit/connect/starttls
     sequence.

   - bpo-22098(180): ctypes’ BigEndianStructure and
     LittleEndianStructure now define an empty __slots__ so that
     subclasses don’t always get an instance dict.  Patch by Claudiu
     Popa.

   - bpo-22185(181): Fix an occasional RuntimeError in
     threading.Condition.wait() caused by mutation of the waiters queue
     without holding the lock.  Patch by Doug Zongker.

   - bpo-22287(182): On UNIX, _PyTime_gettimeofday() now uses
     clock_gettime(CLOCK_REALTIME) if available.  As a side effect,
     Python now depends on the librt library on Solaris and on Linux
     (only with glibc older than 2.17).

   - bpo-22182(183): Use e.args to unpack exceptions correctly in
     distutils.file_util.move_file.  Patch by Claudiu Popa.

   - The webbrowser module now uses subprocess’s start_new_session=True
     rather than a potentially risky preexec_fn=os.setsid call.

   - bpo-22042(184): signal.set_wakeup_fd(fd) now raises an exception if
     the file descriptor is in blocking mode.

   - bpo-16808(185): inspect.stack() now returns a named tuple instead
     of a tuple.  Patch by Daniel Shahaf.

   - bpo-22236(186): Fixed Tkinter images copying operations in
     NoDefaultRoot mode.

   - bpo-2527(187): Add a `globals' argument to timeit functions, in
     order to override the globals namespace in which the timed code is
     executed.  Patch by Ben Roberts.

   - bpo-22118(188): Switch urllib.parse to use RFC 3986 semantics for
     the resolution of relative URLs, rather than RFCs 1808 and 2396.
     Patch by Demian Brecht.

   - bpo-21549(189): Added the “members” parameter to TarFile.list().

   - bpo-19628(190): Allow compileall recursion depth to be specified
     with a -r option.

   - bpo-15696(191): Add a __sizeof__ implementation for mmap objects on
     Windows.

   - bpo-22068(192): Avoided reference loops with Variables and Fonts in
     Tkinter.

   - bpo-22165(193): SimpleHTTPRequestHandler now supports undecodable
     file names.

   - bpo-15381(194): Optimized line reading in io.BytesIO.

   - bpo-8797(195): Raise HTTPError on failed Basic Authentication
     immediately.  Initial patch by Sam Bull.

   - bpo-20729(196): Restored the use of lazy
     iterkeys()/itervalues()/iteritems() in the mailbox module.

   - bpo-21448(197): Changed FeedParser feed() to avoid O(N**2) behavior
     when parsing long line.  Original patch by Raymond Hettinger.

   - bpo-22184(198): The functools LRU Cache decorator factory now gives
     an earlier and clearer error message when the user forgets the
     required parameters.

   - bpo-17923(199): glob() patterns ending with a slash no longer match
     non-dirs on AIX. Based on patch by Delhallt.

   - bpo-21725(200): Added support for RFC 6531 (SMTPUTF8) in smtpd.

   - bpo-22176(201): Update the ctypes module’s libffi to v3.1.  This
     release adds support for the Linux AArch64 and POWERPC ELF ABIv2
     little endian architectures.

   - bpo-5411(202): Added support for the “xztar” format in the shutil
     module.

   - bpo-21121(203): Don’t force 3rd party C extensions to be built with
     -Werror=declaration-after-statement.

   - bpo-21975(204): Fixed crash when using uninitialized sqlite3.Row
     (in particular when unpickling pickled sqlite3.Row).  sqlite3.Row
     is now initialized in the __new__() method.

   - bpo-20170(205): Convert posixmodule to use Argument Clinic.

   - bpo-21539(206): Add an `exists_ok' argument to ‘Pathlib.mkdir()’ to
     mimic ‘mkdir -p’ and *note os.makedirs(): 3b2. functionality.  When
     true, ignore FileExistsErrors.  Patch by Berker Peksag.

   - bpo-22127(207): Bypass IDNA for pure-ASCII host names in the socket
     module (in particular for numeric IPs).

   - bpo-21047(208): set the default value for the `convert_charrefs'
     argument of HTMLParser to True.  Patch by Berker Peksag.

   - Add an __all__ to html.entities.

   - bpo-15114(209): the strict mode and argument of HTMLParser,
     HTMLParser.error, and the HTMLParserError exception have been
     removed.

   - bpo-22085(210): Dropped support of Tk 8.3 in Tkinter.

   - bpo-21580(211): Now Tkinter correctly handles bytes arguments
     passed to Tk.  In particular this allows initializing images from
     binary data.

   - bpo-22003(212): When initialized from a bytes object, io.BytesIO()
     now defers making a copy until it is mutated, improving performance
     and memory use on some use cases.  Patch by David Wilson.

   - bpo-22018(213): On Windows, signal.set_wakeup_fd() now also
     supports sockets.  A side effect is that Python depends to the
     WinSock library.

   - bpo-22054(214): Add os.get_blocking() and os.set_blocking()
     functions to get and set the blocking mode of a file descriptor
     (False if the O_NONBLOCK flag is set, True otherwise).  These
     functions are not available on Windows.

   - bpo-17172(215): Make turtledemo start as active on OS X even when
     run with subprocess.  Patch by Lita Cho.

   - bpo-21704(216): Fix build error for _multiprocessing when
     semaphores are not available.  Patch by Arfrever Frehtes Taifersar
     Arahesis.

   - bpo-20173(217): Convert sha1, sha256, sha512 and md5 to
     ArgumentClinic.  Patch by Vajrasky Kok.

   - Fix repr(_socket.socket) on Windows 64-bit: don’t fail with
     OverflowError on closed socket.  repr(socket.socket) already works
     fine.

   - bpo-22033(218): Reprs of most Python implemented classes now
     contain actual class name instead of hardcoded one.

   - bpo-21947(219): The dis module can now disassemble
     generator-iterator objects based on their gi_code attribute.  Patch
     by Clement Rouault.

   - bpo-16133(220): The asynchat.async_chat.handle_read() method now
     ignores BlockingIOError exceptions.

   - bpo-22044(221): Fixed premature DECREF in call_tzinfo_method.
     Patch by Tom Flanagan.

   - bpo-19884(222): readline: Disable the meta modifier key if stdout
     is not a terminal to not write the ANSI sequence ‘"\033[1034h"’
     into stdout.  This sequence is used on some terminal (ex:
     TERM=xterm-256color”) to enable support of 8 bit characters.

   - bpo-4350(223): Removed a number of out-of-dated and non-working for
     a long time Tkinter methods.

   - bpo-6167(224): Scrollbar.activate() now returns the name of active
     element if the argument is not specified.  Scrollbar.set() now
     always accepts only 2 arguments.

   - bpo-15275(225): Clean up and speed up the ntpath module.

   - bpo-21888(226): plistlib’s load() and loads() now work if the fmt
     parameter is specified.

   - bpo-22032(227): __qualname__ instead of __name__ is now always used
     to format fully qualified class names of Python implemented
     classes.

   - bpo-22031(228): Reprs now always use hexadecimal format with the
     “0x” prefix when contain an id in form ” at 0x…”.

   - bpo-22018(229): signal.set_wakeup_fd() now raises an OSError
     instead of a ValueError on ‘fstat()’ failure.

   - bpo-21044(230): tarfile.open() now handles fileobj with an integer
     ‘name’ attribute.  Based on patch by Antoine Pietri.

   - bpo-21966(231): Respect -q command-line option when code module is
     ran.

   - bpo-19076(232): Don’t pass the redundant ‘file’ argument to
     self.error().

   - bpo-16382(233): Improve exception message of warnings.warn() for
     bad category.  Initial patch by Phil Elson.

   - bpo-21932(234): os.read() now uses a ‘Py_ssize_t()’ type instead of
     ‘int’ for the size to support reading more than 2 GB at once.  On
     Windows, the size is truncated to INT_MAX. As any call to
     os.read(), the OS may read less bytes than the number of requested
     bytes.

   - bpo-21942(235): Fixed source file viewing in pydoc’s server mode on
     Windows.

   - bpo-11259(236): asynchat.async_chat().set_terminator() now raises a
     ValueError if the number of received bytes is negative.

   - bpo-12523(237): asynchat.async_chat.push() now raises a TypeError
     if it doesn’t get a bytes string

   - bpo-21707(238): Add missing kwonlyargcount argument to
     ModuleFinder.replace_paths_in_code().

   - bpo-20639(239): calling Path.with_suffix(‘’) allows removing the
     suffix again.  Patch by July Tikhonov.

   - bpo-21714(240): Disallow the construction of invalid paths using
     Path.with_name().  Original patch by Antony Lee.

   - bpo-15014(241): Added ‘auth’ method to smtplib to make implementing
     auth mechanisms simpler, and used it internally in the login
     method.

   - bpo-21151(242): Fixed a segfault in the winreg module when ‘None’
     is passed as a ‘REG_BINARY’ value to SetValueEx.  Patch by John
     Ehresman.

   - bpo-21090(243): io.FileIO.readall() does not ignore I/O errors
     anymore.  Before, it ignored I/O errors if at least the first C
     call read() succeed.

   - bpo-5800(244): headers parameter of wsgiref.headers.Headers is now
     optional.  Initial patch by Pablo Torres Navarrete and SilentGhost.

   - bpo-21781(245): ssl.RAND_add() now supports strings longer than 2
     GB.

   - bpo-21679(246): Prevent extraneous fstat() calls during open().
     Patch by Bohuslav Kabrda.

   - bpo-21863(247): cProfile now displays the module name of C
     extension functions, in addition to their own name.

   - bpo-11453(248): asyncore: emit a ResourceWarning when an unclosed
     file_wrapper object is destroyed.  The destructor now closes the
     file if needed.  The close() method can now be called twice: the
     second call does nothing.

   - bpo-21858(249): Better handling of Python exceptions in the sqlite3
     module.

   - bpo-21476(250): Make sure the email.parser.BytesParser
     TextIOWrapper is discarded after parsing, so the input file isn’t
     unexpectedly closed.

   - bpo-20295(251): imghdr now recognizes OpenEXR format images.

   - bpo-21729(252): Used the “with” statement in the dbm.dumb module to
     ensure files closing.  Patch by Claudiu Popa.

   - bpo-21491(253): socketserver: Fix a race condition in child
     processes reaping.

   - bpo-21719(254): Added the ‘st_file_attributes’ field to
     os.stat_result on Windows.

   - bpo-21832(255): Require named tuple inputs to be exact strings.

   - bpo-21722(256): The distutils “upload” command now exits with a
     non-zero return code when uploading fails.  Patch by Martin
     Dengler.

   - bpo-21723(257): asyncio.Queue: support any type of number (ex:
     float) for the maximum size.  Patch written by Vajrasky Kok.

   - bpo-21711(258): support for “site-python” directories has now been
     removed from the site module (it was deprecated in 3.4).

   - bpo-17552(259): new socket.sendfile() method allowing a file to be
     sent over a socket by using high-performance os.sendfile() on UNIX.
     Patch by Giampaolo Rodola’.

   - bpo-18039(260): dbm.dump.open() now always creates a new database
     when the flag has the value ‘n’.  Patch by Claudiu Popa.

   - bpo-21326(261): Add a new is_closed() method to
     asyncio.BaseEventLoop.  run_forever() and run_until_complete()
     methods of asyncio.BaseEventLoop now raise an exception if the
     event loop was closed.

   - bpo-21766(262): Prevent a security hole in CGIHTTPServer by URL
     unquoting paths before checking for a CGI script at that path.

   - bpo-21310(263): Fixed possible resource leak in failed open().

   - bpo-21256(264): Printout of keyword args should be in deterministic
     order in a mock function call.  This will help to write better
     doctests.

   - bpo-21677(265): Fixed chaining nonnormalized exceptions in io
     close() methods.

   - bpo-11709(266): Fix the pydoc.help function to not fail when
     sys.stdin is not a valid file.

   - bpo-21515(267): tempfile.TemporaryFile now uses os.O_TMPFILE flag
     is available.

   - bpo-13223(268): Fix pydoc.writedoc so that the HTML documentation
     for methods that use ‘self’ in the example code is generated
     correctly.

   - bpo-21463(269): In urllib.request, fix pruning of the FTP cache.

   - bpo-21618(270): The subprocess module could fail to close open fds
     that were inherited by the calling process and already higher than
     POSIX resource limits would otherwise allow.  On systems with a
     functioning /proc/self/fd or /dev/fd interface the max is now
     ignored and all fds are closed.

   - bpo-20383(271): Introduce importlib.util.module_from_spec() as the
     preferred way to create a new module.

   - bpo-21552(272): Fixed possible integer overflow of too long string
     lengths in the tkinter module on 64-bit platforms.

   - bpo-14315(273): The zipfile module now ignores extra fields in the
     central directory that are too short to be parsed instead of
     letting a struct.unpack error bubble up as this “bad data” appears
     in many real world zip files in the wild and is ignored by other
     zip tools.

   - bpo-13742(274): Added “key” and “reverse” parameters to
     heapq.merge().  (First draft of patch contributed by Simon Sapin.)

   - bpo-21402(275): tkinter.ttk now works when default root window is
     not set.

   - bpo-3015(276): _tkinter.create() now creates tkapp object with
     wantobject=1 by default.

   - bpo-10203(277): sqlite3.Row now truly supports sequence protocol.
     In particular it supports reverse() and negative indices.  Original
     patch by Claudiu Popa.

   - bpo-18807(278): If copying (no symlinks) specified for a venv, then
     the python interpreter aliases (python, python3) are now created by
     copying rather than symlinking.

   - bpo-20197(279): Added support for the WebP image type in the imghdr
     module.  Patch by Fabrice Aneche and Claudiu Popa.

   - bpo-21513(280): Speedup some properties of IP addresses
     (IPv4Address, IPv6Address) such as .is_private or .is_multicast.

   - bpo-21137(281): Improve the repr for threading.Lock() and its
     variants by showing the “locked” or “unlocked” status.  Patch by
     Berker Peksag.

   - bpo-21538(282): The plistlib module now supports loading of binary
     plist files when reference or offset size is not a power of two.

   - bpo-21455(283): Add a default backlog to socket.listen().

   - bpo-21525(284): Most Tkinter methods which accepted tuples now
     accept lists too.

   - bpo-22166(285): With the assistance of a new internal
     _codecs._forget_codec helping function, test_codecs now clears the
     encoding caches to avoid the appearance of a reference leak

   - bpo-22236(286): Tkinter tests now don’t reuse default root window.
     New root window is created for every test class.

   - bpo-10744(287): Fix PEP 3118(288) format strings on ctypes objects
     with a nontrivial shape.

   - bpo-20826(289): Optimize ipaddress.collapse_addresses().

   - bpo-21487(290): Optimize ipaddress.summarize_address_range() and
     ipaddress.{IPv4Network,IPv6Network}.subnets().

   - bpo-21486(291): Optimize parsing of netmasks in
     ipaddress.IPv4Network and ipaddress.IPv6Network.

   - bpo-13916(292): Disallowed the surrogatepass error handler for non
     UTF-* encodings.

   - bpo-20998(293): Fixed re.fullmatch() of repeated single character
     pattern with ignore case.  Original patch by Matthew Barnett.

   - bpo-21075(294): fileinput.FileInput now reads bytes from standard
     stream if binary mode is specified.  Patch by Sam Kimbrel.

   - bpo-19775(295): Add a samefile() method to pathlib Path objects.
     Initial patch by Vajrasky Kok.

   - bpo-21226(296): Set up modules properly in
     PyImport_ExecCodeModuleObject (and friends).

   - bpo-21398(297): Fix a unicode error in the pydoc pager when the
     documentation contains characters not encodable to the stdout
     encoding.

   - bpo-16531(298): ipaddress.IPv4Network and ipaddress.IPv6Network now
     accept an (address, netmask) tuple argument, so as to easily
     construct network objects from existing addresses.

   - bpo-21156(299): importlib.abc.InspectLoader.source_to_code() is now
     a staticmethod.

   - bpo-21424(300): Simplified and optimized heaqp.nlargest() and
     nmsmallest() to make fewer tuple comparisons.

   - bpo-21396(301): Fix TextIOWrapper(…, write_through=True) to not
     force a flush() on the underlying binary stream.  Patch by akira.

   - bpo-18314(302): Unlink now removes junctions on Windows.  Patch by
     Kim Gräsman

   - bpo-21088(303): Bugfix for curses.window.addch() regression in
     3.4.0.  In porting to Argument Clinic, the first two arguments were
     reversed.

   - bpo-21407(304): _decimal: The module now supports function
     signatures.

   - bpo-10650(305): Remove the non-standard ‘watchexp’ parameter from
     the Decimal.quantize() method in the Python version.  It had never
     been present in the C version.

   - bpo-21469(306): Reduced the risk of false positives in robotparser
     by checking to make sure that robots.txt has been read or does not
     exist prior to returning True in can_fetch().

   - bpo-19414(307): Have the OrderedDict mark deleted links as
     unusable.  This gives an early failure if the link is deleted
     during iteration.

   - bpo-21421(308): Add __slots__ to the MappingViews ABC. Patch by
     Josh Rosenberg.

   - bpo-21101(309): Eliminate double hashing in the C speed-up code for
     collections.Counter().

   - bpo-21321(310): itertools.islice() now releases the reference to
     the source iterator when the slice is exhausted.  Patch by Anton
     Afanasyev.

   - bpo-21057(311): TextIOWrapper now allows the underlying binary
     stream’s read() or read1() method to return an arbitrary bytes-like
     object (such as a memoryview).  Patch by Nikolaus Rath.

   - bpo-20951(312): SSLSocket.send() now raises either SSLWantReadError
     or SSLWantWriteError on a non-blocking socket if the operation
     would block.  Previously, it would return 0.  Patch by Nikolaus
     Rath.

   - bpo-13248(313): removed previously deprecated asyncore.dispatcher
     __getattr__ cheap inheritance hack.

   - bpo-9815(314): assertRaises now tries to clear references to local
     variables in the exception’s traceback.

   - bpo-19940(315): ssl.cert_time_to_seconds() now interprets the given
     time string in the UTC timezone (as specified in RFC 5280), not the
     local timezone.

   - bpo-13204(316): Calling sys.flags.__new__ would crash the
     interpreter, now it raises a TypeError.

   - bpo-19385(317): Make operations on a closed dbm.dumb database
     always raise the same exception.

   - bpo-21207(318): Detect when the os.urandom cached fd has been
     closed or replaced, and open it anew.

   - bpo-21291(319): subprocess’s Popen.wait() is now thread safe so
     that multiple threads may be calling wait() or poll() on a Popen
     instance at the same time without losing the Popen.returncode
     value.

   - bpo-21127(320): Path objects can now be instantiated from str
     subclass instances (such as ‘numpy.str_’).

   - bpo-15002(321): urllib.response object to use _TemporaryFileWrapper
     (and _TemporaryFileCloser) facility.  Provides a better way to
     handle file descriptor close.  Patch contributed by Christian
     Theune.

   - bpo-12220(322): mindom now raises a custom ValueError indicating it
     doesn’t support spaces in URIs instead of letting a ‘split’
     ValueError bubble up.

   - bpo-21068(323): The ssl.PROTOCOL* constants are now enum members.

   - bpo-21276(324): posixmodule: Don’t define USE_XATTRS on KFreeBSD
     and the Hurd.

   - bpo-21262(325): New method assert_not_called for Mock.  It raises
     AssertionError if the mock has been called.

   - bpo-21238(326): New keyword argument ‘unsafe’ to Mock.  It raises
     *note AttributeError: 390. incase of an attribute startswith assert
     or assret.

   - bpo-20896(327): ssl.get_server_certificate() now uses
     PROTOCOL_SSLv23, not PROTOCOL_SSLv3, for maximum compatibility.

   - bpo-21239(328): patch.stopall() didn’t work deterministically when
     the same name was patched more than once.

   - bpo-21203(329): Updated fileConfig and dictConfig to remove
     inconsistencies.  Thanks to Jure Koren for the patch.

   - bpo-21222(330): Passing name keyword argument to
     mock.create_autospec now works.

   - bpo-21197(331): Add lib64 -> lib symlink in venvs on 64-bit non-OS
     X POSIX.

   - bpo-17498(332): Some SMTP servers disconnect after certain errors,
     violating strict RFC conformance.  Instead of losing the error code
     when we issue the subsequent RSET, smtplib now returns the error
     code and defers raising the SMTPServerDisconnected error until the
     next command is issued.

   - bpo-17826(333): setting an iterable side_effect on a mock function
     created by create_autospec now works.  Patch by Kushal Das.

   - bpo-7776(334): Fix ‘Host:’ header and reconnection when using
     http.client.HTTPConnection.set_tunnel().  Patch by Nikolaus Rath.

   - bpo-20968(335): unittest.mock.MagicMock now supports division.
     Patch by Johannes Baiter.

   - bpo-21529(336): Fix arbitrary memory access in
     JSONDecoder.raw_decode with a negative second parameter.  Bug
     reported by Guido Vranken.  (See also: CVE-2014-4616)

   - bpo-21169(337): getpass now handles non-ascii characters that the
     input stream encoding cannot encode by re-encoding using the
     replace error handler.

   - bpo-21171(338): Fixed undocumented filter API of the rot13 codec.
     Patch by Berker Peksag.

   - bpo-20539(339): Improved math.factorial error message for large
     positive inputs and changed exception type (OverflowError ->
     ValueError) for large negative inputs.

   - bpo-21172(340): isinstance check relaxed from dict to
     collections.Mapping.

   - bpo-21155(341): asyncio.EventLoop.create_unix_server() now raises a
     ValueError if path and sock are specified at the same time.

   - bpo-21136(342): Avoid unnecessary normalization of Fractions
     resulting from power and other operations.  Patch by Raymond
     Hettinger.

   - bpo-17621(343): Introduce importlib.util.LazyLoader.

   - bpo-21076(344): signal module constants were turned into enums.
     Patch by Giampaolo Rodola’.

   - bpo-20636(345): Improved the repr of Tkinter widgets.

   - bpo-19505(346): The items, keys, and values views of OrderedDict
     now support reverse iteration using reversed().

   - bpo-21149(347): Improved thread-safety in logging cleanup during
     interpreter shutdown.  Thanks to Devin Jeanpierre for the patch.

   - bpo-21058(348): Fix a leak of file descriptor in *note
     tempfile.NamedTemporaryFile(): d3c, close the file descriptor if
     *note io.open(): 64e. fails

   - bpo-21200(349): Return None from pkgutil.get_loader() when __spec__
     is missing.

   - bpo-21013(350): Enhance ssl.create_default_context() when used for
     server side sockets to provide better security by default.

   - bpo-20145(351): ‘assertRaisesRegex’ and ‘assertWarnsRegex’ now
     raise a TypeError if the second argument is not a string or
     compiled regex.

   - bpo-20633(352): Replace relative import by absolute import.

   - bpo-20980(353): Stop wrapping exception when using ThreadPool.

   - bpo-21082(354): In os.makedirs, do not set the process-wide umask.
     Note this changes behavior of makedirs when exist_ok=True.

   - bpo-20990(355): Fix issues found by pyflakes for multiprocessing.

   - bpo-21015(356): SSL contexts will now automatically select an
     elliptic curve for ECDH key exchange on OpenSSL 1.0.2 and later,
     and otherwise default to “prime256v1”.

   - bpo-21000(357): Improve the command-line interface of json.tool.

   - bpo-20995(358): Enhance default ciphers used by the ssl module to
     enable better security and prioritize perfect forward secrecy.

   - bpo-20884(359): Don’t assume that __file__ is defined on
     importlib.__init__.

   - bpo-21499(360): Ignore __builtins__ in several
     test_importlib.test_api tests.

   - bpo-20627(361): xmlrpc.client.ServerProxy is now a context manager.

   - bpo-19165(362): The formatter module now raises DeprecationWarning
     instead of PendingDeprecationWarning.

   - bpo-13936(363): Remove the ability of datetime.time instances to be
     considered false in boolean contexts.

   - bpo-18931(364): selectors module now supports /dev/poll on Solaris.
     Patch by Giampaolo Rodola’.

   - bpo-19977(365): When the ‘LC_TYPE’ locale is the POSIX locale (‘C’
     locale), *note sys.stdin: 302. and *note sys.stdout: 303. are now
     using the ‘surrogateescape’ error handler, instead of the ‘strict’
     error handler.

   - bpo-20574(366): Implement incremental decoder for cp65001 code
     (Windows code page 65001, Microsoft UTF-8).

   - bpo-20879(367): Delay the initialization of encoding and decoding
     tables for base32, ascii85 and base85 codecs in the base64 module,
     and delay the initialization of the unquote_to_bytes() table of the
     urllib.parse module, to not waste memory if these modules are not
     used.

   - bpo-19157(368): Include the broadcast address in the usuable hosts
     for IPv6 in ipaddress.

   - bpo-11599(369): When an external command (e.g.  compiler) fails,
     distutils now prints out the whole command line (instead of just
     the command name) if the environment variable DISTUTILS_DEBUG is
     set.

   - bpo-4931(370): distutils should not produce unhelpful “error: None”
     messages anymore.  distutils.util.grok_environment_error is kept
     but doc-deprecated.

   - bpo-20875(371): Prevent possible gzip “‘read’ is not defined”
     NameError.  Patch by Claudiu Popa.

   - bpo-11558(372): ‘email.message.Message.attach’ now returns a more
     useful error message if ‘attach’ is called on a message for which
     ‘is_multipart’ is False.

   - bpo-20283(373): RE pattern methods now accept the string keyword
     parameters as documented.  The pattern and source keyword
     parameters are left as deprecated aliases.

   - bpo-20778(374): Fix modulefinder to work with bytecode-only
     modules.

   - bpo-20791(375): copy.copy() now doesn’t make a copy when the input
     is a bytes object.  Initial patch by Peter Otten.

   - bpo-19748(376): On AIX, time.mktime() now raises an OverflowError
     for year outsize range [1902; 2037].

   - bpo-19573(377): inspect.signature: Use enum for parameter kind
     constants.

   - bpo-20726(378): inspect.signature: Make Signature and Parameter
     picklable.

   - bpo-17373(379): Add inspect.Signature.from_callable method.

   - bpo-20378(380): Improve repr of inspect.Signature and
     inspect.Parameter.

   - bpo-20816(381): Fix inspect.getcallargs() to raise correct
     TypeError for missing keyword-only arguments.  Patch by Jeremiah
     Lowin.

   - bpo-20817(382): Fix inspect.getcallargs() to fail correctly if more
     than 3 arguments are missing.  Patch by Jeremiah Lowin.

   - bpo-6676(383): Ensure a meaningful exception is raised when
     attempting to parse more than one XML document per pyexpat
     xmlparser instance.  (Original patches by Hirokazu Yamamoto and
     Amaury Forgeot d’Arc, with suggested wording by David Gutteridge)

   - bpo-21117(384): Fix inspect.signature to better support
     functools.partial.  Due to the specifics of functools.partial
     implementation, positional-or-keyword arguments passed as keyword
     arguments become keyword-only.

   - bpo-20334(385): inspect.Signature and inspect.Parameter are now
     hashable.  Thanks to Antony Lee for bug reports and suggestions.

   - bpo-15916(386): doctest.DocTestSuite returns an empty
     unittest.TestSuite instead of raising ValueError if it finds no
     tests

   - bpo-21209(387): Fix asyncio.tasks.CoroWrapper to workaround a bug
     in yield-from implementation in CPythons prior to 3.4.1.

   - asyncio: Add gi_{frame,running,code} properties to CoroWrapper
     (upstream bpo-163(388)).

   - bpo-21311(389): Avoid exception in _osx_support with non-standard
     compiler configurations.  Patch by John Szakmeister.

   - bpo-11571(390): Ensure that the turtle window becomes the topmost
     window when launched on OS X.

   - bpo-21801(391): Validate that __signature__ is None or an instance
     of Signature.

   - bpo-21923(392): Prevent AttributeError in
     distutils.sysconfig.customize_compiler due to possible
     uninitialized _config_vars.

   - bpo-21323(393): Fix http.server to again handle scripts in CGI
     subdirectories, broken by the fix for security bpo-19435(394).
     Patch by Zach Byrne.

   - bpo-22733(395): Fix ffi_prep_args not zero-extending argument
     values correctly on 64-bit Windows.

   - bpo-23302(396): Default to TCP_NODELAY=1 upon establishing an
     HTTPConnection.  Removed use of hard-coded MSS as it’s an
     optimization that’s no longer needed with Nagle disabled.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23399

   (2) https://bugs.python.org/issue20289

   (3) https://bugs.python.org/issue13128

   (4) https://bugs.python.org/issue15381

   (5) https://bugs.python.org/issue22818

   (6) https://bugs.python.org/issue23099

   (7) https://bugs.python.org/issue23326

   (8) https://bugs.python.org/issue21408

   (9) https://bugs.python.org/issue23363

   (10) https://bugs.python.org/issue23364

   (11) https://bugs.python.org/issue23366

   (12) https://bugs.python.org/issue23369

   (13) https://bugs.python.org/issue23353

   (14) https://bugs.python.org/issue14099

   (15) https://bugs.python.org/issue14099

   (16) https://bugs.python.org/issue19361

   (17) https://bugs.python.org/issue18518

   (18) https://bugs.python.org/issue23094

   (19) https://bugs.python.org/issue23268

   (20) https://bugs.python.org/issue21408

   (21) https://bugs.python.org/issue19996

   (22) https://bugs.python.org/issue20188

   (23) https://bugs.python.org/issue23133

   (24) https://bugs.python.org/issue23248

   (25) https://bugs.python.org/issue23266

   (26) https://bugs.python.org/issue23098

   (27) https://bugs.python.org/issue21817

   (28) https://bugs.python.org/issue15955

   (29) https://bugs.python.org/issue23250

   (30) https://bugs.python.org/issue23063

   (31) https://bugs.python.org/issue23209

   (32) https://bugs.python.org/issue23225

   (33) https://bugs.python.org/issue17911

   (34) https://bugs.python.org/issue17911

   (35) https://bugs.python.org/issue19777

   (36) https://bugs.python.org/issue23206

   (37) https://bugs.python.org/issue23185

   (38) https://bugs.python.org/issue23186

   (39) https://bugs.python.org/issue23143

   (40) https://bugs.python.org/issue23132

   (41) https://bugs.python.org/issue19776

   (42) https://bugs.python.org/issue23112

   (43) https://bugs.python.org/issue21793

   (44) https://bugs.python.org/issue23093

   (45) https://bugs.python.org/issue23111

   (46) https://bugs.python.org/issue22585

   (47) https://bugs.python.org/issue19104

   (48) https://bugs.python.org/issue23071

   (49) https://bugs.python.org/issue22783

   (50) https://bugs.python.org/issue15513

   (51) https://bugs.python.org/issue19858

   (52) https://bugs.python.org/issue22095

   (53) https://bugs.python.org/issue23016

   (54) https://bugs.python.org/issue21775

   (55) https://bugs.python.org/issue1218234

   (56) https://bugs.python.org/issue21740

   (57) https://bugs.python.org/issue23009

   (58) https://bugs.python.org/issue22959

   (59) https://bugs.python.org/issue22696

   (60) https://bugs.python.org/issue16043

   (61) https://bugs.python.org/issue14099

   (62) https://bugs.python.org/issue22966

   (63) https://bugs.python.org/issue21971

   (64) https://bugs.python.org/issue21032

   (65) https://bugs.python.org/issue22407

   (66) https://bugs.python.org/issue22902

   (67) https://bugs.python.org/issue22960

   (68) https://bugs.python.org/issue22389

   (69) https://bugs.python.org/issue21356

   (70) https://bugs.python.org/issue22915

   (71) https://bugs.python.org/issue22609

   (72) https://bugs.python.org/issue22940

   (73) https://bugs.python.org/issue19676

   (74) https://bugs.python.org/issue22788

   (75) https://bugs.python.org/issue22921

   (76) https://bugs.python.org/issue22894

   (77) https://bugs.python.org/issue22796

   (78) https://bugs.python.org/issue22370

   (79) https://bugs.python.org/issue22841

   (80) https://bugs.python.org/issue19494

   (81) https://bugs.python.org/issue22578

   (82) https://bugs.python.org/issue22849

   (83) https://bugs.python.org/issue12728

   (84) https://bugs.python.org/issue22821

   (85) https://bugs.python.org/issue21650

   (86) https://bugs.python.org/issue22824

   (87) https://bugs.python.org/issue22824

   (88) https://bugs.python.org/issue22406

   (89) https://bugs.python.org/issue17293

   (90) https://bugs.python.org/issue22769

   (91) https://bugs.python.org/issue22417

   (92) https://bugs.python.org/issue22775

   (93) https://bugs.python.org/issue22776

   (94) https://bugs.python.org/issue22665

   (95) https://bugs.python.org/issue6623

   (96) https://bugs.python.org/issue17381

   (97) https://bugs.python.org/issue22410

   (98) https://bugs.python.org/issue22759

   (99) https://bugs.python.org/issue8876

   (100) https://bugs.python.org/issue22217

   (101) https://bugs.python.org/issue22457

   (102) https://bugs.python.org/issue18216

   (103) https://bugs.python.org/issue13918

   (104) https://bugs.python.org/issue22676

   (105) https://bugs.python.org/issue18853

   (106) https://bugs.python.org/issue9351

   (107) https://bugs.python.org/issue7559

   (108) https://bugs.python.org/issue19746

   (109) https://bugs.python.org/issue21991

   (110) https://bugs.python.org/issue22638

   (111) https://bugs.python.org/issue22641

   (112) https://bugs.python.org/issue17401

   (113) https://bugs.python.org/issue21338

   (114) https://bugs.python.org/issue20152

   (115) https://bugs.python.org/issue18643

   (116) https://bugs.python.org/issue22435

   (117) https://bugs.python.org/issue13096

   (118) https://bugs.python.org/issue11694

   (119) https://bugs.python.org/issue19380

   (120) https://bugs.python.org/issue1519638

   (121) https://bugs.python.org/issue18615

   (122) https://bugs.python.org/issue22462

   (123) https://bugs.python.org/issue21965

   (124) https://bugs.python.org/issue21173

   (125) https://bugs.python.org/issue11866

   (126) https://bugs.python.org/issue21905

   (127) https://bugs.python.org/issue11271

   (128) https://bugs.python.org/issue21883

   (129) https://bugs.python.org/issue22219

   (130) https://bugs.python.org/issue22449

   (131) https://bugs.python.org/issue22508

   (132) https://bugs.python.org/issue20076

   (133) https://bugs.python.org/issue20079

   (134) https://bugs.python.org/issue20218

   (135) https://bugs.python.org/issue22396

   (136) https://bugs.python.org/issue22517

   (137) https://bugs.python.org/issue22437

   (138) https://bugs.python.org/issue17442

   (139) https://bugs.python.org/issue23392

   (140) https://bugs.python.org/issue10510

   (141) https://bugs.python.org/issue9850

   (142) https://bugs.python.org/issue5309

   (143) https://bugs.python.org/issue22448

   (144) https://bugs.python.org/issue22427

   (145) https://bugs.python.org/issue22362

   (146) https://bugs.python.org/issue20912

   (147) https://bugs.python.org/issue21866

   (148) https://bugs.python.org/issue22278

   (149) https://bugs.python.org/issue22415

   (150) https://bugs.python.org/issue22423

   (151) https://bugs.python.org/issue21332

   (152) https://bugs.python.org/issue21091

   (153) https://bugs.python.org/issue21079

   (154) https://bugs.python.org/issue22247

   (155) https://bugs.python.org/issue22366

   (156) https://bugs.python.org/issue4180

   (157) https://bugs.python.org/issue22419

   (158) https://bugs.python.org/issue20537

   (159) https://bugs.python.org/issue22384

   (160) https://bugs.python.org/issue22168

   (161) https://bugs.python.org/issue21147

   (162) https://bugs.python.org/issue13968

   (163) https://bugs.python.org/issue21951

   (164) https://bugs.python.org/issue21951

   (165) https://bugs.python.org/issue22338

   (166) https://bugs.python.org/issue12410

   (167) https://bugs.python.org/issue21270

   (168) https://bugs.python.org/issue16662

   (169) https://bugs.python.org/issue22226

   (170) https://bugs.python.org/issue19524

   (171) https://bugs.python.org/issue20421

   (172) https://bugs.python.org/issue19546

   (173) https://bugs.python.org/issue22051

   (174) https://bugs.python.org/issue21933

   (175) https://bugs.python.org/issue21597

   (176) https://bugs.python.org/issue18132

   (177) https://bugs.python.org/issue22043

   (178) https://bugs.python.org/issue21527

   (179) https://bugs.python.org/issue22216

   (180) https://bugs.python.org/issue22098

   (181) https://bugs.python.org/issue22185

   (182) https://bugs.python.org/issue22287

   (183) https://bugs.python.org/issue22182

   (184) https://bugs.python.org/issue22042

   (185) https://bugs.python.org/issue16808

   (186) https://bugs.python.org/issue22236

   (187) https://bugs.python.org/issue2527

   (188) https://bugs.python.org/issue22118

   (189) https://bugs.python.org/issue21549

   (190) https://bugs.python.org/issue19628

   (191) https://bugs.python.org/issue15696

   (192) https://bugs.python.org/issue22068

   (193) https://bugs.python.org/issue22165

   (194) https://bugs.python.org/issue15381

   (195) https://bugs.python.org/issue8797

   (196) https://bugs.python.org/issue20729

   (197) https://bugs.python.org/issue21448

   (198) https://bugs.python.org/issue22184

   (199) https://bugs.python.org/issue17923

   (200) https://bugs.python.org/issue21725

   (201) https://bugs.python.org/issue22176

   (202) https://bugs.python.org/issue5411

   (203) https://bugs.python.org/issue21121

   (204) https://bugs.python.org/issue21975

   (205) https://bugs.python.org/issue20170

   (206) https://bugs.python.org/issue21539

   (207) https://bugs.python.org/issue22127

   (208) https://bugs.python.org/issue21047

   (209) https://bugs.python.org/issue15114

   (210) https://bugs.python.org/issue22085

   (211) https://bugs.python.org/issue21580

   (212) https://bugs.python.org/issue22003

   (213) https://bugs.python.org/issue22018

   (214) https://bugs.python.org/issue22054

   (215) https://bugs.python.org/issue17172

   (216) https://bugs.python.org/issue21704

   (217) https://bugs.python.org/issue20173

   (218) https://bugs.python.org/issue22033

   (219) https://bugs.python.org/issue21947

   (220) https://bugs.python.org/issue16133

   (221) https://bugs.python.org/issue22044

   (222) https://bugs.python.org/issue19884

   (223) https://bugs.python.org/issue4350

   (224) https://bugs.python.org/issue6167

   (225) https://bugs.python.org/issue15275

   (226) https://bugs.python.org/issue21888

   (227) https://bugs.python.org/issue22032

   (228) https://bugs.python.org/issue22031

   (229) https://bugs.python.org/issue22018

   (230) https://bugs.python.org/issue21044

   (231) https://bugs.python.org/issue21966

   (232) https://bugs.python.org/issue19076

   (233) https://bugs.python.org/issue16382

   (234) https://bugs.python.org/issue21932

   (235) https://bugs.python.org/issue21942

   (236) https://bugs.python.org/issue11259

   (237) https://bugs.python.org/issue12523

   (238) https://bugs.python.org/issue21707

   (239) https://bugs.python.org/issue20639

   (240) https://bugs.python.org/issue21714

   (241) https://bugs.python.org/issue15014

   (242) https://bugs.python.org/issue21151

   (243) https://bugs.python.org/issue21090

   (244) https://bugs.python.org/issue5800

   (245) https://bugs.python.org/issue21781

   (246) https://bugs.python.org/issue21679

   (247) https://bugs.python.org/issue21863

   (248) https://bugs.python.org/issue11453

   (249) https://bugs.python.org/issue21858

   (250) https://bugs.python.org/issue21476

   (251) https://bugs.python.org/issue20295

   (252) https://bugs.python.org/issue21729

   (253) https://bugs.python.org/issue21491

   (254) https://bugs.python.org/issue21719

   (255) https://bugs.python.org/issue21832

   (256) https://bugs.python.org/issue21722

   (257) https://bugs.python.org/issue21723

   (258) https://bugs.python.org/issue21711

   (259) https://bugs.python.org/issue17552

   (260) https://bugs.python.org/issue18039

   (261) https://bugs.python.org/issue21326

   (262) https://bugs.python.org/issue21766

   (263) https://bugs.python.org/issue21310

   (264) https://bugs.python.org/issue21256

   (265) https://bugs.python.org/issue21677

   (266) https://bugs.python.org/issue11709

   (267) https://bugs.python.org/issue21515

   (268) https://bugs.python.org/issue13223

   (269) https://bugs.python.org/issue21463

   (270) https://bugs.python.org/issue21618

   (271) https://bugs.python.org/issue20383

   (272) https://bugs.python.org/issue21552

   (273) https://bugs.python.org/issue14315

   (274) https://bugs.python.org/issue13742

   (275) https://bugs.python.org/issue21402

   (276) https://bugs.python.org/issue3015

   (277) https://bugs.python.org/issue10203

   (278) https://bugs.python.org/issue18807

   (279) https://bugs.python.org/issue20197

   (280) https://bugs.python.org/issue21513

   (281) https://bugs.python.org/issue21137

   (282) https://bugs.python.org/issue21538

   (283) https://bugs.python.org/issue21455

   (284) https://bugs.python.org/issue21525

   (285) https://bugs.python.org/issue22166

   (286) https://bugs.python.org/issue22236

   (287) https://bugs.python.org/issue10744

   (288) https://www.python.org/dev/peps/pep-3118

   (289) https://bugs.python.org/issue20826

   (290) https://bugs.python.org/issue21487

   (291) https://bugs.python.org/issue21486

   (292) https://bugs.python.org/issue13916

   (293) https://bugs.python.org/issue20998

   (294) https://bugs.python.org/issue21075

   (295) https://bugs.python.org/issue19775

   (296) https://bugs.python.org/issue21226

   (297) https://bugs.python.org/issue21398

   (298) https://bugs.python.org/issue16531

   (299) https://bugs.python.org/issue21156

   (300) https://bugs.python.org/issue21424

   (301) https://bugs.python.org/issue21396

   (302) https://bugs.python.org/issue18314

   (303) https://bugs.python.org/issue21088

   (304) https://bugs.python.org/issue21407

   (305) https://bugs.python.org/issue10650

   (306) https://bugs.python.org/issue21469

   (307) https://bugs.python.org/issue19414

   (308) https://bugs.python.org/issue21421

   (309) https://bugs.python.org/issue21101

   (310) https://bugs.python.org/issue21321

   (311) https://bugs.python.org/issue21057

   (312) https://bugs.python.org/issue20951

   (313) https://bugs.python.org/issue13248

   (314) https://bugs.python.org/issue9815

   (315) https://bugs.python.org/issue19940

   (316) https://bugs.python.org/issue13204

   (317) https://bugs.python.org/issue19385

   (318) https://bugs.python.org/issue21207

   (319) https://bugs.python.org/issue21291

   (320) https://bugs.python.org/issue21127

   (321) https://bugs.python.org/issue15002

   (322) https://bugs.python.org/issue12220

   (323) https://bugs.python.org/issue21068

   (324) https://bugs.python.org/issue21276

   (325) https://bugs.python.org/issue21262

   (326) https://bugs.python.org/issue21238

   (327) https://bugs.python.org/issue20896

   (328) https://bugs.python.org/issue21239

   (329) https://bugs.python.org/issue21203

   (330) https://bugs.python.org/issue21222

   (331) https://bugs.python.org/issue21197

   (332) https://bugs.python.org/issue17498

   (333) https://bugs.python.org/issue17826

   (334) https://bugs.python.org/issue7776

   (335) https://bugs.python.org/issue20968

   (336) https://bugs.python.org/issue21529

   (337) https://bugs.python.org/issue21169

   (338) https://bugs.python.org/issue21171

   (339) https://bugs.python.org/issue20539

   (340) https://bugs.python.org/issue21172

   (341) https://bugs.python.org/issue21155

   (342) https://bugs.python.org/issue21136

   (343) https://bugs.python.org/issue17621

   (344) https://bugs.python.org/issue21076

   (345) https://bugs.python.org/issue20636

   (346) https://bugs.python.org/issue19505

   (347) https://bugs.python.org/issue21149

   (348) https://bugs.python.org/issue21058

   (349) https://bugs.python.org/issue21200

   (350) https://bugs.python.org/issue21013

   (351) https://bugs.python.org/issue20145

   (352) https://bugs.python.org/issue20633

   (353) https://bugs.python.org/issue20980

   (354) https://bugs.python.org/issue21082

   (355) https://bugs.python.org/issue20990

   (356) https://bugs.python.org/issue21015

   (357) https://bugs.python.org/issue21000

   (358) https://bugs.python.org/issue20995

   (359) https://bugs.python.org/issue20884

   (360) https://bugs.python.org/issue21499

   (361) https://bugs.python.org/issue20627

   (362) https://bugs.python.org/issue19165

   (363) https://bugs.python.org/issue13936

   (364) https://bugs.python.org/issue18931

   (365) https://bugs.python.org/issue19977

   (366) https://bugs.python.org/issue20574

   (367) https://bugs.python.org/issue20879

   (368) https://bugs.python.org/issue19157

   (369) https://bugs.python.org/issue11599

   (370) https://bugs.python.org/issue4931

   (371) https://bugs.python.org/issue20875

   (372) https://bugs.python.org/issue11558

   (373) https://bugs.python.org/issue20283

   (374) https://bugs.python.org/issue20778

   (375) https://bugs.python.org/issue20791

   (376) https://bugs.python.org/issue19748

   (377) https://bugs.python.org/issue19573

   (378) https://bugs.python.org/issue20726

   (379) https://bugs.python.org/issue17373

   (380) https://bugs.python.org/issue20378

   (381) https://bugs.python.org/issue20816

   (382) https://bugs.python.org/issue20817

   (383) https://bugs.python.org/issue6676

   (384) https://bugs.python.org/issue21117

   (385) https://bugs.python.org/issue20334

   (386) https://bugs.python.org/issue15916

   (387) https://bugs.python.org/issue21209

   (388) https://bugs.python.org/issue163

   (389) https://bugs.python.org/issue21311

   (390) https://bugs.python.org/issue11571

   (391) https://bugs.python.org/issue21801

   (392) https://bugs.python.org/issue21923

   (393) https://bugs.python.org/issue21323

   (394) https://bugs.python.org/issue19435

   (395) https://bugs.python.org/issue22733

   (396) https://bugs.python.org/issue23302


File: python.info,  Node: IDLE<40>,  Next: Build<48>,  Prev: Library<71>,  Up: Python 3 5 0 alpha 1

1.18.70.3 IDLE
..............

   - bpo-20577(1): Configuration of the max line length for the
     FormatParagraph extension has been moved from the General tab of
     the Idle preferences dialog to the FormatParagraph tab of the
     Config Extensions dialog.  Patch by Tal Einat.

   - bpo-16893(2): Update Idle doc chapter to match current Idle and add
     new information.

   - bpo-3068(3): Add Idle extension configuration dialog to Options
     menu.  Changes are written to HOME/.idlerc/config-extensions.cfg.
     Original patch by Tal Einat.

   - bpo-16233(4): A module browser (File : Class Browser, Alt+C)
     requires an editor window with a filename.  When Class Browser is
     requested otherwise, from a shell, output window, or ‘Untitled’
     editor, Idle no longer displays an error box.  It now pops up an
     Open Module box (Alt+M). If a valid name is entered and a module is
     opened, a corresponding browser is also opened.

   - bpo-4832(5): Save As to type Python files automatically adds .py to
     the name you enter (even if your system does not display it).  Some
     systems automatically add .txt when type is Text files.

   - bpo-21986(6): Code objects are not normally pickled by the pickle
     module.  To match this, they are no longer pickled when running
     under Idle.

   - bpo-17390(7): Adjust Editor window title; remove ‘Python’, move
     version to end.

   - bpo-14105(8): Idle debugger breakpoints no longer disappear when
     inserting or deleting lines.

   - bpo-17172(9): Turtledemo can now be run from Idle.  Currently, the
     entry is on the Help menu, but it may move to Run.  Patch by
     Ramchandra Apt and Lita Cho.

   - bpo-21765(10): Add support for non-ascii identifiers to
     HyperParser.

   - bpo-21940(11): Add unittest for WidgetRedirector.  Initial patch by
     Saimadhav Heblikar.

   - bpo-18592(12): Add unittest for SearchDialogBase.  Patch by Phil
     Webster.

   - bpo-21694(13): Add unittest for ParenMatch.  Patch by Saimadhav
     Heblikar.

   - bpo-21686(14): add unittest for HyperParser.  Original patch by
     Saimadhav Heblikar.

   - bpo-12387(15): Add missing upper(lower)case versions of default
     Windows key bindings for Idle so Caps Lock does not disable them.
     Patch by Roger Serwy.

   - bpo-21695(16): Closing a Find-in-files output window while the
     search is still in progress no longer closes Idle.

   - bpo-18910(17): Add unittest for textView.  Patch by Phil Webster.

   - bpo-18292(18): Add unittest for AutoExpand.  Patch by Saihadhav
     Heblikar.

   - bpo-18409(19): Add unittest for AutoComplete.  Patch by Phil
     Webster.

   - bpo-21477(20): htest.py - Improve framework, complete set of tests.
     Patches by Saimadhav Heblikar

   - bpo-18104(21): Add idlelib/idle_test/htest.py with a few sample
     tests to begin consolidating and improving human-validated tests of
     Idle.  Change other files as needed to work with htest.  Running
     the module as __main__ runs all tests.

   - bpo-21139(22): Change default paragraph width to 72, the PEP 8(23)
     recommendation.

   - bpo-21284(24): Paragraph reformat test passes after user changes
     reformat width.

   - bpo-17654(25): Ensure IDLE menus are customized properly on OS X
     for non-framework builds and for all variants of Tk.

   - bpo-23180(26): Rename IDLE “Windows” menu item to “Window”.  Patch
     by Al Sweigart.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue20577

   (2) https://bugs.python.org/issue16893

   (3) https://bugs.python.org/issue3068

   (4) https://bugs.python.org/issue16233

   (5) https://bugs.python.org/issue4832

   (6) https://bugs.python.org/issue21986

   (7) https://bugs.python.org/issue17390

   (8) https://bugs.python.org/issue14105

   (9) https://bugs.python.org/issue17172

   (10) https://bugs.python.org/issue21765

   (11) https://bugs.python.org/issue21940

   (12) https://bugs.python.org/issue18592

   (13) https://bugs.python.org/issue21694

   (14) https://bugs.python.org/issue21686

   (15) https://bugs.python.org/issue12387

   (16) https://bugs.python.org/issue21695

   (17) https://bugs.python.org/issue18910

   (18) https://bugs.python.org/issue18292

   (19) https://bugs.python.org/issue18409

   (20) https://bugs.python.org/issue21477

   (21) https://bugs.python.org/issue18104

   (22) https://bugs.python.org/issue21139

   (23) https://www.python.org/dev/peps/pep-0008

   (24) https://bugs.python.org/issue21284

   (25) https://bugs.python.org/issue17654

   (26) https://bugs.python.org/issue23180


File: python.info,  Node: Build<48>,  Next: C API<32>,  Prev: IDLE<40>,  Up: Python 3 5 0 alpha 1

1.18.70.4 Build
...............

   - bpo-15506(1): Use standard PKG_PROG_PKG_CONFIG autoconf macro in
     the configure script.

   - bpo-22935(2): Allow the ssl module to be compiled if openssl
     doesn’t support SSL 3.

   - bpo-22592(3): Drop support of the Borland C compiler to build
     Python.  The distutils module still supports it to build
     extensions.

   - bpo-22591(4): Drop support of MS-DOS, especially of the DJGPP
     compiler (MS-DOS port of GCC).

   - bpo-16537(5): Check whether self.extensions is empty in setup.py.
     Patch by Jonathan Hosmer.

   - bpo-22359(6): Remove incorrect uses of recursive make.  Patch by
     Jonas Wagner.

   - bpo-21958(7): Define HAVE_ROUND when building with Visual Studio
     2013 and above.  Patch by Zachary Turner.

   - bpo-18093(8): the programs that embed the CPython runtime are now
     in a separate “Programs” directory, rather than being kept in the
     Modules directory.

   - bpo-15759(9): “make suspicious”, “make linkcheck” and “make
     doctest” in Doc/ now display special message when and only when
     there are failures.

   - bpo-21141(10): The Windows build process no longer attempts to find
     Perl, instead relying on OpenSSL source being configured and ready
     to build.  The ‘PCbuild\build_ssl.py’ script has been re-written
     and re-named to ‘PCbuild\prepare_ssl.py’, and takes care of
     configuring OpenSSL source for both 32 and 64 bit platforms.
     OpenSSL sources obtained from svn.python.org will always be
     pre-configured and ready to build.

   - bpo-21037(11): Add a build option to enable AddressSanitizer
     support.

   - bpo-19962(12): The Windows build process now creates “python.bat”
     in the root of the source tree, which passes all arguments through
     to the most recently built interpreter.

   - bpo-21285(13): Refactor and fix curses configure check to always
     search in a ncursesw directory.

   - bpo-15234(14): For BerkelyDB and Sqlite, only add the found library
     and include directories if they aren’t already being searched.
     This avoids an explicit runtime library dependency.

   - bpo-17861(15): Tools/scripts/generate_opcode_h.py automatically
     regenerates Include/opcode.h from Lib/opcode.py if the latter gets
     any change.

   - bpo-20644(16): OS X installer build support for documentation build
     changes in 3.4.1: assume externally supplied sphinx-build is
     available in /usr/bin.

   - bpo-20022(17): Eliminate use of deprecated bundlebuilder in OS X
     builds.

   - bpo-15968(18): Incorporated Tcl, Tk, and Tix builds into the
     Windows build solution.

   - bpo-17095(19): Fix Modules/Setup `shared' support.

   - bpo-21811(20): Anticipated fixes to support OS X versions > 10.9.

   - bpo-21166(21): Prevent possible segfaults and other random failures
     of python –generate-posix-vars in pybuilddir.txt build target.

   - bpo-18096(22): Fix library order returned by python-config.

   - bpo-17219(23): Add library build dir for Python extension
     cross-builds.

   - bpo-22919(24): Windows build updated to support VC 14.0 (Visual
     Studio 2015), which will be used for the official release.

   - bpo-21236(25): Build _msi.pyd with cabinet.lib instead of fci.lib

   - bpo-17128(26): Use private version of OpenSSL for OS X 10.5+
     installer.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue15506

   (2) https://bugs.python.org/issue22935

   (3) https://bugs.python.org/issue22592

   (4) https://bugs.python.org/issue22591

   (5) https://bugs.python.org/issue16537

   (6) https://bugs.python.org/issue22359

   (7) https://bugs.python.org/issue21958

   (8) https://bugs.python.org/issue18093

   (9) https://bugs.python.org/issue15759

   (10) https://bugs.python.org/issue21141

   (11) https://bugs.python.org/issue21037

   (12) https://bugs.python.org/issue19962

   (13) https://bugs.python.org/issue21285

   (14) https://bugs.python.org/issue15234

   (15) https://bugs.python.org/issue17861

   (16) https://bugs.python.org/issue20644

   (17) https://bugs.python.org/issue20022

   (18) https://bugs.python.org/issue15968

   (19) https://bugs.python.org/issue17095

   (20) https://bugs.python.org/issue21811

   (21) https://bugs.python.org/issue21166

   (22) https://bugs.python.org/issue18096

   (23) https://bugs.python.org/issue17219

   (24) https://bugs.python.org/issue22919

   (25) https://bugs.python.org/issue21236

   (26) https://bugs.python.org/issue17128


File: python.info,  Node: C API<32>,  Next: Documentation<41>,  Prev: Build<48>,  Up: Python 3 5 0 alpha 1

1.18.70.5 C API
...............

   - bpo-14203(1): Remove obsolete support for view==NULL in
     PyBuffer_FillInfo(), bytearray_getbuffer(), bytesiobuf_getbuffer()
     and array_buffer_getbuf().  All functions now raise BufferError in
     that case.

   - bpo-22445(2): PyBuffer_IsContiguous() now implements precise
     contiguity tests, compatible with NumPy’s
     NPY_RELAXED_STRIDES_CHECKING compilation flag.  Previously the
     function reported false negatives for corner cases.

   - bpo-22079(3): PyType_Ready() now checks that statically allocated
     type has no dynamically allocated bases.

   - bpo-22453(4): Removed non-documented macro PyObject_REPR().

   - bpo-18395(5): Rename ‘_Py_char2wchar()’ to *note Py_DecodeLocale():
     431, rename ‘_Py_wchar2char()’ to *note Py_EncodeLocale(): 432, and
     document these functions.

   - bpo-21233(6): Add new C functions: PyMem_RawCalloc(),
     PyMem_Calloc(), PyObject_Calloc(), _PyObject_GC_Calloc().
     bytes(int) is now using ‘calloc()’ instead of ‘malloc()’ for large
     objects which is faster and use less memory.

   - bpo-20942(7): PyImport_ImportFrozenModuleObject() no longer sets
     __file__ to match what importlib does; this affects
     _frozen_importlib as well as any module loaded using
     imp.init_frozen().

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue14203

   (2) https://bugs.python.org/issue22445

   (3) https://bugs.python.org/issue22079

   (4) https://bugs.python.org/issue22453

   (5) https://bugs.python.org/issue18395

   (6) https://bugs.python.org/issue21233

   (7) https://bugs.python.org/issue20942


File: python.info,  Node: Documentation<41>,  Next: Tests<46>,  Prev: C API<32>,  Up: Python 3 5 0 alpha 1

1.18.70.6 Documentation
.......................

   - bpo-19548(1): Update the codecs module documentation to better
     cover the distinction between text encodings and other codecs,
     together with other clarifications.  Patch by Martin Panter.

   - bpo-22394(2): Doc/Makefile now supports ‘make venv
     PYTHON=../python’ to create a venv for generating the
     documentation, e.g., ‘make html PYTHON=venv/bin/python3’.

   - bpo-21514(3): The documentation of the json module now refers to
     new JSON RFC 7159 instead of obsoleted RFC 4627.

   - bpo-21777(4): The binary sequence methods on bytes and bytearray
     are now documented explicitly, rather than assuming users will be
     able to derive the expected behaviour from the behaviour of the
     corresponding str methods.

   - bpo-6916(5): undocument deprecated asynchat.fifo class.

   - bpo-17386(6): Expanded functionality of the ‘Doc/make.bat’ script
     to make it much more comparable to ‘Doc/Makefile’.

   - bpo-21312(7): Update the thread_foobar.h template file to include
     newer threading APIs.  Patch by Jack McCracken.

   - bpo-21043(8): Remove the recommendation for specific CA
     organizations and to mention the ability to load the OS
     certificates.

   - bpo-20765(9): Add missing documentation for PurePath.with_name()
     and PurePath.with_suffix().

   - bpo-19407(10): New package installation and distribution guides
     based on the Python Packaging Authority tools.  Existing guides
     have been retained as legacy links from the distutils docs, as they
     still contain some required reference material for tool developers
     that isn’t recorded anywhere else.

   - bpo-19697(11): Document cases where __main__.__spec__ is None.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue19548

   (2) https://bugs.python.org/issue22394

   (3) https://bugs.python.org/issue21514

   (4) https://bugs.python.org/issue21777

   (5) https://bugs.python.org/issue6916

   (6) https://bugs.python.org/issue17386

   (7) https://bugs.python.org/issue21312

   (8) https://bugs.python.org/issue21043

   (9) https://bugs.python.org/issue20765

   (10) https://bugs.python.org/issue19407

   (11) https://bugs.python.org/issue19697


File: python.info,  Node: Tests<46>,  Next: Tools/Demos<32>,  Prev: Documentation<41>,  Up: Python 3 5 0 alpha 1

1.18.70.7 Tests
...............

   - bpo-18982(1): Add tests for CLI of the calendar module.

   - bpo-19548(2): Added some additional checks to test_codecs to ensure
     that statements in the updated documentation remain accurate.
     Patch by Martin Panter.

   - bpo-22838(3): All test_re tests now work with unittest test
     discovery.

   - bpo-22173(4): Update lib2to3 tests to use unittest test discovery.

   - bpo-16000(5): Convert test_curses to use unittest.

   - bpo-21456(6): Skip two tests in test_urllib2net.py if _ssl module
     not present.  Patch by Remi Pointel.

   - bpo-20746(7): Fix test_pdb to run in refleak mode (-R). Patch by
     Xavier de Gaye.

   - bpo-22060(8): test_ctypes has been somewhat cleaned up and
     simplified; it now uses unittest test discovery to find its tests.

   - bpo-22104(9): regrtest.py no longer holds a reference to the suite
     of tests loaded from test modules that don’t define test_main().

   - bpo-22111(10): Assorted cleanups in test_imaplib.  Patch by Milan
     Oberkirch.

   - bpo-22002(11): Added ‘load_package_tests’ function to test.support
     and used it to implement/augment test discovery in test_asyncio,
     test_email, test_importlib, test_json, and test_tools.

   - bpo-21976(12): Fix test_ssl to accept LibreSSL version strings.
     Thanks to William Orr.

   - bpo-21918(13): Converted test_tools from a module to a package
     containing separate test files for each tested script.

   - bpo-9554(14): Use modern unittest features in test_argparse.
     Initial patch by Denver Coneybeare and Radu Voicilas.

   - bpo-20155(15): Changed HTTP method names in failing tests in
     test_httpservers so that packet filtering software (specifically
     Windows Base Filtering Engine) does not interfere with the
     transaction semantics expected by the tests.

   - bpo-19493(16): Refactored the ctypes test package to skip tests
     explicitly rather than silently.

   - bpo-18492(17): All resources are now allowed when tests are not run
     by regrtest.py.

   - bpo-21634(18): Fix pystone micro-benchmark: use floor division
     instead of true division to benchmark integers instead of floating
     point numbers.  Set pystone version to 1.2.  Patch written by
     Lennart Regebro.

   - bpo-21605(19): Added tests for Tkinter images.

   - bpo-21493(20): Added test for ntpath.expanduser().  Original patch
     by Claudiu Popa.

   - bpo-19925(21): Added tests for the spwd module.  Original patch by
     Vajrasky Kok.

   - bpo-21522(22): Added Tkinter tests for Listbox.itemconfigure(),
     PanedWindow.paneconfigure(), and Menu.entryconfigure().

   - bpo-17756(23): Fix test_code test when run from the installed
     location.

   - bpo-17752(24): Fix distutils tests when run from the installed
     location.

   - bpo-18604(25): Consolidated checks for GUI availability.  All
     platforms now at least check whether Tk can be instantiated when
     the GUI resource is requested.

   - bpo-21275(26): Fix a socket test on KFreeBSD.

   - bpo-21223(27): Pass test_site/test_startup_imports when some of the
     extensions are built as builtins.

   - bpo-20635(28): Added tests for Tk geometry managers.

   - Add test case for freeze.

   - bpo-20743(29): Fix a reference leak in test_tcl.

   - bpo-21097(30): Move test_namespace_pkgs into test_importlib.

   - bpo-21503(31): Use test_both() consistently in test_importlib.

   - bpo-20939(32): Avoid various network test failures due to new
     redirect of ‘http://www.python.org/’ to ‘https://www.python.org’:
     use ‘http://www.example.com’ instead.

   - bpo-20668(33): asyncio tests no longer rely on tests.txt file.
     (Patch by Vajrasky Kok)

   - bpo-21093(34): Prevent failures of ctypes test_macholib on OS X if
     a copy of libz exists in $HOME/lib or /usr/local/lib.

   - bpo-22770(35): Prevent some Tk segfaults on OS X when running gui
     tests.

   - bpo-23211(36): Workaround test_logging failure on some OS X 10.6
     systems.

   - bpo-23345(37): Prevent test_ssl failures with large OpenSSL patch
     level values (like 0.9.8zc).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue18982

   (2) https://bugs.python.org/issue19548

   (3) https://bugs.python.org/issue22838

   (4) https://bugs.python.org/issue22173

   (5) https://bugs.python.org/issue16000

   (6) https://bugs.python.org/issue21456

   (7) https://bugs.python.org/issue20746

   (8) https://bugs.python.org/issue22060

   (9) https://bugs.python.org/issue22104

   (10) https://bugs.python.org/issue22111

   (11) https://bugs.python.org/issue22002

   (12) https://bugs.python.org/issue21976

   (13) https://bugs.python.org/issue21918

   (14) https://bugs.python.org/issue9554

   (15) https://bugs.python.org/issue20155

   (16) https://bugs.python.org/issue19493

   (17) https://bugs.python.org/issue18492

   (18) https://bugs.python.org/issue21634

   (19) https://bugs.python.org/issue21605

   (20) https://bugs.python.org/issue21493

   (21) https://bugs.python.org/issue19925

   (22) https://bugs.python.org/issue21522

   (23) https://bugs.python.org/issue17756

   (24) https://bugs.python.org/issue17752

   (25) https://bugs.python.org/issue18604

   (26) https://bugs.python.org/issue21275

   (27) https://bugs.python.org/issue21223

   (28) https://bugs.python.org/issue20635

   (29) https://bugs.python.org/issue20743

   (30) https://bugs.python.org/issue21097

   (31) https://bugs.python.org/issue21503

   (32) https://bugs.python.org/issue20939

   (33) https://bugs.python.org/issue20668

   (34) https://bugs.python.org/issue21093

   (35) https://bugs.python.org/issue22770

   (36) https://bugs.python.org/issue23211

   (37) https://bugs.python.org/issue23345


File: python.info,  Node: Tools/Demos<32>,  Next: Windows<42>,  Prev: Tests<46>,  Up: Python 3 5 0 alpha 1

1.18.70.8 Tools/Demos
.....................

   - bpo-22314(1): pydoc now works when the LINES environment variable
     is set.

   - bpo-22615(2): Argument Clinic now supports the “type” argument for
     the int converter.  This permits using the int converter with enums
     and typedefs.

   - bpo-20076(3): The makelocalealias.py script no longer ignores UTF-8
     mapping.

   - bpo-20079(4): The makelocalealias.py script now can parse the
     SUPPORTED file from glibc sources and supports command line options
     for source paths.

   - bpo-22201(5): Command-line interface of the zipfile module now
     correctly extracts ZIP files with directory entries.  Patch by Ryan
     Wilson.

   - bpo-22120(6): For functions using an unsigned integer return
     converter, Argument Clinic now generates a cast to that type for
     the comparison to -1 in the generated code.  (This suppresses a
     compilation warning.)

   - bpo-18974(7): Tools/scripts/diff.py now uses argparse instead of
     optparse.

   - bpo-21906(8): Make Tools/scripts/md5sum.py work in Python 3.  Patch
     by Zachary Ware.

   - bpo-21629(9): Fix Argument Clinic’s “–converters” feature.

   - Add support for ‘yield from’ to 2to3.

   - Add support for the PEP 465(10) matrix multiplication operator to
     2to3.

   - bpo-16047(11): Fix module exception list and __file__ handling in
     freeze.  Patch by Meador Inge.

   - bpo-11824(12): Consider ABI tags in freeze.  Patch by Meador Inge.

   - bpo-20535(13): PYTHONWARNING no longer affects the run_tests.py
     script.  Patch by Arfrever Frehtes Taifersar Arahesis.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue22314

   (2) https://bugs.python.org/issue22615

   (3) https://bugs.python.org/issue20076

   (4) https://bugs.python.org/issue20079

   (5) https://bugs.python.org/issue22201

   (6) https://bugs.python.org/issue22120

   (7) https://bugs.python.org/issue18974

   (8) https://bugs.python.org/issue21906

   (9) https://bugs.python.org/issue21629

   (10) https://www.python.org/dev/peps/pep-0465

   (11) https://bugs.python.org/issue16047

   (12) https://bugs.python.org/issue11824

   (13) https://bugs.python.org/issue20535


File: python.info,  Node: Windows<42>,  Prev: Tools/Demos<32>,  Up: Python 3 5 0 alpha 1

1.18.70.9 Windows
.................

   - bpo-23260(1): Update Windows installer

   - The bundled version of Tcl/Tk has been updated to 8.6.3.  The most
     visible result of this change is the addition of new native file
     dialogs when running on Windows Vista or newer.  See Tcl/Tk’s TIP
     432 for more information.  Also, this version of Tcl/Tk includes
     support for Windows 10.

   - bpo-17896(2): The Windows build scripts now expect external library
     sources to be in ‘PCbuild\..\externals’ rather than
     ‘PCbuild\..\..’.

   - bpo-17717(3): The Windows build scripts now use a copy of NASM
     pulled from svn.python.org to build OpenSSL.

   - bpo-21907(4): Improved the batch scripts provided for building
     Python.

   - bpo-22644(5): The bundled version of OpenSSL has been updated to
     1.0.1j.

   - bpo-10747(6): Use versioned labels in the Windows start menu.
     Patch by Olive Kilburn.

   - bpo-22980(7): .pyd files with a version and platform tag (for
     example, “.cp35-win32.pyd”) will now be loaded in preference to
     those without tags.

`(For information about older versions, consult the HISTORY file.)'

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue23260

   (2) https://bugs.python.org/issue17896

   (3) https://bugs.python.org/issue17717

   (4) https://bugs.python.org/issue21907

   (5) https://bugs.python.org/issue22644

   (6) https://bugs.python.org/issue10747

   (7) https://bugs.python.org/issue22980


File: python.info,  Node: The Python Tutorial,  Next: Python Setup and Usage,  Prev: What’s New in Python,  Up: Top

2 The Python Tutorial
*********************

Python is an easy to learn, powerful programming language.  It has
efficient high-level data structures and a simple but effective approach
to object-oriented programming.  Python’s elegant syntax and dynamic
typing, together with its interpreted nature, make it an ideal language
for scripting and rapid application development in many areas on most
platforms.

The Python interpreter and the extensive standard library are freely
available in source or binary form for all major platforms from the
Python Web site, ‘https://www.python.org/’, and may be freely
distributed.  The same site also contains distributions of and pointers
to many free third party Python modules, programs and tools, and
additional documentation.

The Python interpreter is easily extended with new functions and data
types implemented in C or C++ (or other languages callable from C).
Python is also suitable as an extension language for customizable
applications.

This tutorial introduces the reader informally to the basic concepts and
features of the Python language and system.  It helps to have a Python
interpreter handy for hands-on experience, but all examples are
self-contained, so the tutorial can be read off-line as well.

For a description of standard objects and modules, see *note The Python
Standard Library: 1135.  *note The Python Language Reference: 1136.
gives a more formal definition of the language.  To write extensions in
C or C++, read *note Extending and Embedding the Python Interpreter:
1137. and *note Python/C API Reference Manual: 1138.  There are also
several books covering Python in depth.

This tutorial does not attempt to be comprehensive and cover every
single feature, or even every commonly used feature.  Instead, it
introduces many of Python’s most noteworthy features, and will give you
a good idea of the language’s flavor and style.  After reading it, you
will be able to read and write Python modules and programs, and you will
be ready to learn more about the various Python library modules
described in *note The Python Standard Library: 1135.

The *note Glossary: 1139. is also worth going through.

* Menu:

* Whetting Your Appetite::
* Using the Python Interpreter::
* An Informal Introduction to Python::
* More Control Flow Tools::
* Data Structures::
* Modules::
* Input and Output::
* Errors and Exceptions::
* Classes::
* Brief Tour of the Standard Library::
* Brief Tour of the Standard Library — Part II::
* Virtual Environments and Packages::
* What Now?::
* Interactive Input Editing and History Substitution::
* Floating Point Arithmetic; Issues and Limitations: Floating Point Arithmetic Issues and Limitations.
* Appendix::


File: python.info,  Node: Whetting Your Appetite,  Next: Using the Python Interpreter,  Up: The Python Tutorial

2.1 Whetting Your Appetite
==========================

If you do much work on computers, eventually you find that there’s some
task you’d like to automate.  For example, you may wish to perform a
search-and-replace over a large number of text files, or rename and
rearrange a bunch of photo files in a complicated way.  Perhaps you’d
like to write a small custom database, or a specialized GUI application,
or a simple game.

If you’re a professional software developer, you may have to work with
several C/C++/Java libraries but find the usual
write/compile/test/re-compile cycle is too slow.  Perhaps you’re writing
a test suite for such a library and find writing the testing code a
tedious task.  Or maybe you’ve written a program that could use an
extension language, and you don’t want to design and implement a whole
new language for your application.

Python is just the language for you.

You could write a Unix shell script or Windows batch files for some of
these tasks, but shell scripts are best at moving around files and
changing text data, not well-suited for GUI applications or games.  You
could write a C/C++/Java program, but it can take a lot of development
time to get even a first-draft program.  Python is simpler to use,
available on Windows, Mac OS X, and Unix operating systems, and will
help you get the job done more quickly.

Python is simple to use, but it is a real programming language, offering
much more structure and support for large programs than shell scripts or
batch files can offer.  On the other hand, Python also offers much more
error checking than C, and, being a `very-high-level language', it has
high-level data types built in, such as flexible arrays and
dictionaries.  Because of its more general data types Python is
applicable to a much larger problem domain than Awk or even Perl, yet
many things are at least as easy in Python as in those languages.

Python allows you to split your program into modules that can be reused
in other Python programs.  It comes with a large collection of standard
modules that you can use as the basis of your programs — or as examples
to start learning to program in Python.  Some of these modules provide
things like file I/O, system calls, sockets, and even interfaces to
graphical user interface toolkits like Tk.

Python is an interpreted language, which can save you considerable time
during program development because no compilation and linking is
necessary.  The interpreter can be used interactively, which makes it
easy to experiment with features of the language, to write throw-away
programs, or to test functions during bottom-up program development.  It
is also a handy desk calculator.

Python enables programs to be written compactly and readably.  Programs
written in Python are typically much shorter than equivalent C, C++, or
Java programs, for several reasons:

   * the high-level data types allow you to express complex operations
     in a single statement;

   * statement grouping is done by indentation instead of beginning and
     ending brackets;

   * no variable or argument declarations are necessary.

Python is `extensible': if you know how to program in C it is easy to
add a new built-in function or module to the interpreter, either to
perform critical operations at maximum speed, or to link Python programs
to libraries that may only be available in binary form (such as a
vendor-specific graphics library).  Once you are really hooked, you can
link the Python interpreter into an application written in C and use it
as an extension or command language for that application.

By the way, the language is named after the BBC show “Monty Python’s
Flying Circus” and has nothing to do with reptiles.  Making references
to Monty Python skits in documentation is not only allowed, it is
encouraged!

Now that you are all excited about Python, you’ll want to examine it in
some more detail.  Since the best way to learn a language is to use it,
the tutorial invites you to play with the Python interpreter as you
read.

In the next chapter, the mechanics of using the interpreter are
explained.  This is rather mundane information, but essential for trying
out the examples shown later.

The rest of the tutorial introduces various features of the Python
language and system through examples, beginning with simple expressions,
statements and data types, through functions and modules, and finally
touching upon advanced concepts like exceptions and user-defined
classes.


File: python.info,  Node: Using the Python Interpreter,  Next: An Informal Introduction to Python,  Prev: Whetting Your Appetite,  Up: The Python Tutorial

2.2 Using the Python Interpreter
================================

* Menu:

* Invoking the Interpreter::
* The Interpreter and Its Environment::


File: python.info,  Node: Invoking the Interpreter,  Next: The Interpreter and Its Environment,  Up: Using the Python Interpreter

2.2.1 Invoking the Interpreter
------------------------------

The Python interpreter is usually installed as
‘/usr/local/bin/python3.8’ on those machines where it is available;
putting ‘/usr/local/bin’ in your Unix shell’s search path makes it
possible to start it by typing the command:

     python3.8

to the shell.  (1) Since the choice of the directory where the
interpreter lives is an installation option, other places are possible;
check with your local Python guru or system administrator.  (E.g.,
‘/usr/local/python’ is a popular alternative location.)

On Windows machines where you have installed Python from the *note
Microsoft Store: 1142, the ‘python3.8’ command will be available.  If
you have the *note py.exe launcher: 983. installed, you can use the ‘py’
command.  See *note Excursus; Setting environment variables: 1143. for
other ways to launch Python.

Typing an end-of-file character (‘Control-D’ on Unix, ‘Control-Z’ on
Windows) at the primary prompt causes the interpreter to exit with a
zero exit status.  If that doesn’t work, you can exit the interpreter by
typing the following command: ‘quit()’.

The interpreter’s line-editing features include interactive editing,
history substitution and code completion on systems that support the GNU
Readline(2) library.  Perhaps the quickest check to see whether command
line editing is supported is typing ‘Control-P’ to the first Python
prompt you get.  If it beeps, you have command line editing; see
Appendix *note Interactive Input Editing and History Substitution: 1144.
for an introduction to the keys.  If nothing appears to happen, or if
‘^P’ is echoed, command line editing isn’t available; you’ll only be
able to use backspace to remove characters from the current line.

The interpreter operates somewhat like the Unix shell: when called with
standard input connected to a tty device, it reads and executes commands
interactively; when called with a file name argument or with a file as
standard input, it reads and executes a `script' from that file.

A second way of starting the interpreter is ‘python -c command [arg]
...’, which executes the statement(s) in `command', analogous to the
shell’s *note -c: 1145. option.  Since Python statements often contain
spaces or other characters that are special to the shell, it is usually
advised to quote `command' in its entirety with single quotes.

Some Python modules are also useful as scripts.  These can be invoked
using ‘python -m module [arg] ...’, which executes the source file for
`module' as if you had spelled out its full name on the command line.

When a script file is used, it is sometimes useful to be able to run the
script and enter interactive mode afterwards.  This can be done by
passing *note -i: e12. before the script.

All command line options are described in *note Command line and
environment: edb.

* Menu:

* Argument Passing::
* Interactive Mode::

   ---------- Footnotes ----------

   (1) (1) On Unix, the Python 3.x interpreter is by default not
installed with the executable named ‘python’, so that it does not
conflict with a simultaneously installed Python 2.x executable.

   (2) https://tiswww.case.edu/php/chet/readline/rltop.html


File: python.info,  Node: Argument Passing,  Next: Interactive Mode,  Up: Invoking the Interpreter

2.2.1.1 Argument Passing
........................

When known to the interpreter, the script name and additional arguments
thereafter are turned into a list of strings and assigned to the ‘argv’
variable in the ‘sys’ module.  You can access this list by executing
‘import sys’.  The length of the list is at least one; when no script
and no arguments are given, ‘sys.argv[0]’ is an empty string.  When the
script name is given as ‘'-'’ (meaning standard input), ‘sys.argv[0]’ is
set to ‘'-'’.  When *note -c: 1145. `command' is used, ‘sys.argv[0]’ is
set to ‘'-c'’.  When *note -m: 32c. `module' is used, ‘sys.argv[0]’ is
set to the full name of the located module.  Options found after *note
-c: 1145. `command' or *note -m: 32c. `module' are not consumed by the
Python interpreter’s option processing but left in ‘sys.argv’ for the
command or module to handle.


File: python.info,  Node: Interactive Mode,  Prev: Argument Passing,  Up: Invoking the Interpreter

2.2.1.2 Interactive Mode
........................

When commands are read from a tty, the interpreter is said to be in
`interactive mode'.  In this mode it prompts for the next command with
the `primary prompt', usually three greater-than signs (‘>>>’); for
continuation lines it prompts with the `secondary prompt', by default
three dots (‘...’).  The interpreter prints a welcome message stating
its version number and a copyright notice before printing the first
prompt:

     $ python3.8
     Python 3.8 (default, Sep 16 2015, 09:25:04)
     [GCC 4.8.2] on linux
     Type "help", "copyright", "credits" or "license" for more information.
     >>>

Continuation lines are needed when entering a multi-line construct.  As
an example, take a look at this *note if: dda. statement:

     >>> the_world_is_flat = True
     >>> if the_world_is_flat:
     ...     print("Be careful not to fall off!")
     ...
     Be careful not to fall off!

For more on interactive mode, see *note Interactive Mode: 1149.


File: python.info,  Node: The Interpreter and Its Environment,  Prev: Invoking the Interpreter,  Up: Using the Python Interpreter

2.2.2 The Interpreter and Its Environment
-----------------------------------------

* Menu:

* Source Code Encoding::


File: python.info,  Node: Source Code Encoding,  Up: The Interpreter and Its Environment

2.2.2.1 Source Code Encoding
............................

By default, Python source files are treated as encoded in UTF-8.  In
that encoding, characters of most languages in the world can be used
simultaneously in string literals, identifiers and comments — although
the standard library only uses ASCII characters for identifiers, a
convention that any portable code should follow.  To display all these
characters properly, your editor must recognize that the file is UTF-8,
and it must use a font that supports all the characters in the file.

To declare an encoding other than the default one, a special comment
line should be added as the `first' line of the file.  The syntax is as
follows:

     # -*- coding: encoding -*-

where `encoding' is one of the valid *note codecs: 1c. supported by
Python.

For example, to declare that Windows-1252 encoding is to be used, the
first line of your source code file should be:

     # -*- coding: cp1252 -*-

One exception to the `first line' rule is when the source code starts
with a *note UNIX “shebang” line: 114e.  In this case, the encoding
declaration should be added as the second line of the file.  For
example:

     #!/usr/bin/env python3
     # -*- coding: cp1252 -*-


File: python.info,  Node: An Informal Introduction to Python,  Next: More Control Flow Tools,  Prev: Using the Python Interpreter,  Up: The Python Tutorial

2.3 An Informal Introduction to Python
======================================

In the following examples, input and output are distinguished by the
presence or absence of prompts (*note >>>: 1152. and *note …: 1153.): to
repeat the example, you must type everything after the prompt, when the
prompt appears; lines that do not begin with a prompt are output from
the interpreter.  Note that a secondary prompt on a line by itself in an
example means you must type a blank line; this is used to end a
multi-line command.

Many of the examples in this manual, even those entered at the
interactive prompt, include comments.  Comments in Python start with the
hash character, ‘#’, and extend to the end of the physical line.  A
comment may appear at the start of a line or following whitespace or
code, but not within a string literal.  A hash character within a string
literal is just a hash character.  Since comments are to clarify code
and are not interpreted by Python, they may be omitted when typing in
examples.

Some examples:

     # this is the first comment
     spam = 1  # and this is the second comment
               # ... and now a third!
     text = "# This is not a comment because it's inside quotes."

* Menu:

* Using Python as a Calculator::
* First Steps Towards Programming::


File: python.info,  Node: Using Python as a Calculator,  Next: First Steps Towards Programming,  Up: An Informal Introduction to Python

2.3.1 Using Python as a Calculator
----------------------------------

Let’s try some simple Python commands.  Start the interpreter and wait
for the primary prompt, ‘>>>’.  (It shouldn’t take long.)

* Menu:

* Numbers::
* Strings::
* Lists::


File: python.info,  Node: Numbers,  Next: Strings,  Up: Using Python as a Calculator

2.3.1.1 Numbers
...............

The interpreter acts as a simple calculator: you can type an expression
at it and it will write the value.  Expression syntax is
straightforward: the operators ‘+’, ‘-’, ‘*’ and ‘/’ work just like in
most other languages (for example, Pascal or C); parentheses (‘()’) can
be used for grouping.  For example:

     >>> 2 + 2
     4
     >>> 50 - 5*6
     20
     >>> (50 - 5*6) / 4
     5.0
     >>> 8 / 5  # division always returns a floating point number
     1.6

The integer numbers (e.g.  ‘2’, ‘4’, ‘20’) have type *note int: 184, the
ones with a fractional part (e.g.  ‘5.0’, ‘1.6’) have type *note float:
187.  We will see more about numeric types later in the tutorial.

Division (‘/’) always returns a float.  To do *note floor division:
1158. and get an integer result (discarding any fractional result) you
can use the ‘//’ operator; to calculate the remainder you can use ‘%’:

     >>> 17 / 3  # classic division returns a float
     5.666666666666667
     >>>
     >>> 17 // 3  # floor division discards the fractional part
     5
     >>> 17 % 3  # the % operator returns the remainder of the division
     2
     >>> 5 * 3 + 2  # result * divisor + remainder
     17

With Python, it is possible to use the ‘**’ operator to calculate powers
(1):

     >>> 5 ** 2  # 5 squared
     25
     >>> 2 ** 7  # 2 to the power of 7
     128

The equal sign (‘=’) is used to assign a value to a variable.
Afterwards, no result is displayed before the next interactive prompt:

     >>> width = 20
     >>> height = 5 * 9
     >>> width * height
     900

If a variable is not “defined” (assigned a value), trying to use it will
give you an error:

     >>> n  # try to access an undefined variable
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     NameError: name 'n' is not defined

There is full support for floating point; operators with mixed type
operands convert the integer operand to floating point:

     >>> 4 * 3.75 - 1
     14.0

In interactive mode, the last printed expression is assigned to the
variable ‘_’.  This means that when you are using Python as a desk
calculator, it is somewhat easier to continue calculations, for example:

     >>> tax = 12.5 / 100
     >>> price = 100.50
     >>> price * tax
     12.5625
     >>> price + _
     113.0625
     >>> round(_, 2)
     113.06

This variable should be treated as read-only by the user.  Don’t
explicitly assign a value to it — you would create an independent local
variable with the same name masking the built-in variable with its magic
behavior.

In addition to *note int: 184. and *note float: 187, Python supports
other types of numbers, such as *note Decimal: 188. and *note Fraction:
185.  Python also has built-in support for *note complex numbers: 1159,
and uses the ‘j’ or ‘J’ suffix to indicate the imaginary part (e.g.
‘3+5j’).

   ---------- Footnotes ----------

   (1) (1) Since ‘**’ has higher precedence than ‘-’, ‘-3**2’ will be
interpreted as ‘-(3**2)’ and thus result in ‘-9’.  To avoid this and get
‘9’, you can use ‘(-3)**2’.


File: python.info,  Node: Strings,  Next: Lists,  Prev: Numbers,  Up: Using Python as a Calculator

2.3.1.2 Strings
...............

Besides numbers, Python can also manipulate strings, which can be
expressed in several ways.  They can be enclosed in single quotes
(‘'...'’) or double quotes (‘"..."’) with the same result (1).  ‘\’ can
be used to escape quotes:

     >>> 'spam eggs'  # single quotes
     'spam eggs'
     >>> 'doesn\'t'  # use \' to escape the single quote...
     "doesn't"
     >>> "doesn't"  # ...or use double quotes instead
     "doesn't"
     >>> '"Yes," they said.'
     '"Yes," they said.'
     >>> "\"Yes,\" they said."
     '"Yes," they said.'
     >>> '"Isn\'t," they said.'
     '"Isn\'t," they said.'

In the interactive interpreter, the output string is enclosed in quotes
and special characters are escaped with backslashes.  While this might
sometimes look different from the input (the enclosing quotes could
change), the two strings are equivalent.  The string is enclosed in
double quotes if the string contains a single quote and no double
quotes, otherwise it is enclosed in single quotes.  The *note print():
87a. function produces a more readable output, by omitting the enclosing
quotes and by printing escaped and special characters:

     >>> '"Isn\'t," they said.'
     '"Isn\'t," they said.'
     >>> print('"Isn\'t," they said.')
     "Isn't," they said.
     >>> s = 'First line.\nSecond line.'  # \n means newline
     >>> s  # without print(), \n is included in the output
     'First line.\nSecond line.'
     >>> print(s)  # with print(), \n produces a new line
     First line.
     Second line.

If you don’t want characters prefaced by ‘\’ to be interpreted as
special characters, you can use `raw strings' by adding an ‘r’ before
the first quote:

     >>> print('C:\some\name')  # here \n means newline!
     C:\some
     ame
     >>> print(r'C:\some\name')  # note the r before the quote
     C:\some\name

String literals can span multiple lines.  One way is using
triple-quotes: ‘"""..."""’ or ‘'''...'''’.  End of lines are
automatically included in the string, but it’s possible to prevent this
by adding a ‘\’ at the end of the line.  The following example:

     print("""\
     Usage: thingy [OPTIONS]
          -h                        Display this usage message
          -H hostname               Hostname to connect to
     """)

produces the following output (note that the initial newline is not
included):

     Usage: thingy [OPTIONS]
          -h                        Display this usage message
          -H hostname               Hostname to connect to

Strings can be concatenated (glued together) with the ‘+’ operator, and
repeated with ‘*’:

     >>> # 3 times 'un', followed by 'ium'
     >>> 3 * 'un' + 'ium'
     'unununium'

Two or more `string literals' (i.e.  the ones enclosed between quotes)
next to each other are automatically concatenated.

     >>> 'Py' 'thon'
     'Python'

This feature is particularly useful when you want to break long strings:

     >>> text = ('Put several strings within parentheses '
     ...         'to have them joined together.')
     >>> text
     'Put several strings within parentheses to have them joined together.'

This only works with two literals though, not with variables or
expressions:

     >>> prefix = 'Py'
     >>> prefix 'thon'  # can't concatenate a variable and a string literal
       File "<stdin>", line 1
         prefix 'thon'
                     ^
     SyntaxError: invalid syntax
     >>> ('un' * 3) 'ium'
       File "<stdin>", line 1
         ('un' * 3) 'ium'
                        ^
     SyntaxError: invalid syntax

If you want to concatenate variables or a variable and a literal, use
‘+’:

     >>> prefix + 'thon'
     'Python'

Strings can be `indexed' (subscripted), with the first character having
index 0.  There is no separate character type; a character is simply a
string of size one:

     >>> word = 'Python'
     >>> word[0]  # character in position 0
     'P'
     >>> word[5]  # character in position 5
     'n'

Indices may also be negative numbers, to start counting from the right:

     >>> word[-1]  # last character
     'n'
     >>> word[-2]  # second-last character
     'o'
     >>> word[-6]
     'P'

Note that since -0 is the same as 0, negative indices start from -1.

In addition to indexing, `slicing' is also supported.  While indexing is
used to obtain individual characters, `slicing' allows you to obtain
substring:

     >>> word[0:2]  # characters from position 0 (included) to 2 (excluded)
     'Py'
     >>> word[2:5]  # characters from position 2 (included) to 5 (excluded)
     'tho'

Note how the start is always included, and the end always excluded.
This makes sure that ‘s[:i] + s[i:]’ is always equal to ‘s’:

     >>> word[:2] + word[2:]
     'Python'
     >>> word[:4] + word[4:]
     'Python'

Slice indices have useful defaults; an omitted first index defaults to
zero, an omitted second index defaults to the size of the string being
sliced.

     >>> word[:2]   # character from the beginning to position 2 (excluded)
     'Py'
     >>> word[4:]   # characters from position 4 (included) to the end
     'on'
     >>> word[-2:]  # characters from the second-last (included) to the end
     'on'

One way to remember how slices work is to think of the indices as
pointing `between' characters, with the left edge of the first character
numbered 0.  Then the right edge of the last character of a string of
`n' characters has index `n', for example:

      +---+---+---+---+---+---+
      | P | y | t | h | o | n |
      +---+---+---+---+---+---+
      0   1   2   3   4   5   6
     -6  -5  -4  -3  -2  -1

The first row of numbers gives the position of the indices 0…6 in the
string; the second row gives the corresponding negative indices.  The
slice from `i' to `j' consists of all characters between the edges
labeled `i' and `j', respectively.

For non-negative indices, the length of a slice is the difference of the
indices, if both are within bounds.  For example, the length of
‘word[1:3]’ is 2.

Attempting to use an index that is too large will result in an error:

     >>> word[42]  # the word only has 6 characters
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     IndexError: string index out of range

However, out of range slice indexes are handled gracefully when used for
slicing:

     >>> word[4:42]
     'on'
     >>> word[42:]
     ''

Python strings cannot be changed — they are *note immutable: 115c.
Therefore, assigning to an indexed position in the string results in an
error:

     >>> word[0] = 'J'
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: 'str' object does not support item assignment
     >>> word[2:] = 'py'
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: 'str' object does not support item assignment

If you need a different string, you should create a new one:

     >>> 'J' + word[1:]
     'Jython'
     >>> word[:2] + 'py'
     'Pypy'

The built-in function *note len(): 150. returns the length of a string:

     >>> s = 'supercalifragilisticexpialidocious'
     >>> len(s)
     34

See also
........

*note Text Sequence Type — str: 115d.

     Strings are examples of `sequence types', and support the common
     operations supported by such types.

*note String Methods: 115e.

     Strings support a large number of methods for basic transformations
     and searching.

*note Formatted string literals: 15c.

     String literals that have embedded expressions.

*note Format String Syntax: d0d.

     Information about string formatting with *note str.format(): 4cf.

*note printf-style String Formatting: 115f.

     The old formatting operations invoked when strings are the left
     operand of the ‘%’ operator are described in more detail here.

   ---------- Footnotes ----------

   (1) (2) Unlike other languages, special characters such as ‘\n’ have
the same meaning with both single (‘'...'’) and double (‘"..."’) quotes.
The only difference between the two is that within single quotes you
don’t need to escape ‘"’ (but you have to escape ‘\'’) and vice versa.


File: python.info,  Node: Lists,  Prev: Strings,  Up: Using Python as a Calculator

2.3.1.3 Lists
.............

Python knows a number of `compound' data types, used to group together
other values.  The most versatile is the `list', which can be written as
a list of comma-separated values (items) between square brackets.  Lists
might contain items of different types, but usually the items all have
the same type.

     >>> squares = [1, 4, 9, 16, 25]
     >>> squares
     [1, 4, 9, 16, 25]

Like strings (and all other built-in *note sequence: 1162. types), lists
can be indexed and sliced:

     >>> squares[0]  # indexing returns the item
     1
     >>> squares[-1]
     25
     >>> squares[-3:]  # slicing returns a new list
     [9, 16, 25]

All slice operations return a new list containing the requested
elements.  This means that the following slice returns a *note shallow
copy: 1163. of the list:

     >>> squares[:]
     [1, 4, 9, 16, 25]

Lists also support operations like concatenation:

     >>> squares + [36, 49, 64, 81, 100]
     [1, 4, 9, 16, 25, 36, 49, 64, 81, 100]

Unlike strings, which are *note immutable: 115c, lists are a *note
mutable: 1164. type, i.e.  it is possible to change their content:

     >>> cubes = [1, 8, 27, 65, 125]  # something's wrong here
     >>> 4 ** 3  # the cube of 4 is 64, not 65!
     64
     >>> cubes[3] = 64  # replace the wrong value
     >>> cubes
     [1, 8, 27, 64, 125]

You can also add new items at the end of the list, by using the
‘append()’ `method' (we will see more about methods later):

     >>> cubes.append(216)  # add the cube of 6
     >>> cubes.append(7 ** 3)  # and the cube of 7
     >>> cubes
     [1, 8, 27, 64, 125, 216, 343]

Assignment to slices is also possible, and this can even change the size
of the list or clear it entirely:

     >>> letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
     >>> letters
     ['a', 'b', 'c', 'd', 'e', 'f', 'g']
     >>> # replace some values
     >>> letters[2:5] = ['C', 'D', 'E']
     >>> letters
     ['a', 'b', 'C', 'D', 'E', 'f', 'g']
     >>> # now remove them
     >>> letters[2:5] = []
     >>> letters
     ['a', 'b', 'f', 'g']
     >>> # clear the list by replacing all the elements with an empty list
     >>> letters[:] = []
     >>> letters
     []

The built-in function *note len(): 150. also applies to lists:

     >>> letters = ['a', 'b', 'c', 'd']
     >>> len(letters)
     4

It is possible to nest lists (create lists containing other lists), for
example:

     >>> a = ['a', 'b', 'c']
     >>> n = [1, 2, 3]
     >>> x = [a, n]
     >>> x
     [['a', 'b', 'c'], [1, 2, 3]]
     >>> x[0]
     ['a', 'b', 'c']
     >>> x[0][1]
     'b'


File: python.info,  Node: First Steps Towards Programming,  Prev: Using Python as a Calculator,  Up: An Informal Introduction to Python

2.3.2 First Steps Towards Programming
-------------------------------------

Of course, we can use Python for more complicated tasks than adding two
and two together.  For instance, we can write an initial sub-sequence of
the Fibonacci series(1) as follows:

     >>> # Fibonacci series:
     ... # the sum of two elements defines the next
     ... a, b = 0, 1
     >>> while a < 10:
     ...     print(a)
     ...     a, b = b, a+b
     ...
     0
     1
     1
     2
     3
     5
     8

This example introduces several new features.

   * The first line contains a `multiple assignment': the variables ‘a’
     and ‘b’ simultaneously get the new values 0 and 1.  On the last
     line this is used again, demonstrating that the expressions on the
     right-hand side are all evaluated first before any of the
     assignments take place.  The right-hand side expressions are
     evaluated from the left to the right.

   * The *note while: 1167. loop executes as long as the condition
     (here: ‘a < 10’) remains true.  In Python, like in C, any non-zero
     integer value is true; zero is false.  The condition may also be a
     string or list value, in fact any sequence; anything with a
     non-zero length is true, empty sequences are false.  The test used
     in the example is a simple comparison.  The standard comparison
     operators are written the same as in C: ‘<’ (less than), ‘>’
     (greater than), ‘==’ (equal to), ‘<=’ (less than or equal to), ‘>=’
     (greater than or equal to) and ‘!=’ (not equal to).

   * The `body' of the loop is `indented': indentation is Python’s way
     of grouping statements.  At the interactive prompt, you have to
     type a tab or space(s) for each indented line.  In practice you
     will prepare more complicated input for Python with a text editor;
     all decent text editors have an auto-indent facility.  When a
     compound statement is entered interactively, it must be followed by
     a blank line to indicate completion (since the parser cannot guess
     when you have typed the last line).  Note that each line within a
     basic block must be indented by the same amount.

   * The *note print(): 87a. function writes the value of the
     argument(s) it is given.  It differs from just writing the
     expression you want to write (as we did earlier in the calculator
     examples) in the way it handles multiple arguments, floating point
     quantities, and strings.  Strings are printed without quotes, and a
     space is inserted between items, so you can format things nicely,
     like this:

          >>> i = 256*256
          >>> print('The value of i is', i)
          The value of i is 65536

     The keyword argument `end' can be used to avoid the newline after
     the output, or end the output with a different string:

          >>> a, b = 0, 1
          >>> while a < 1000:
          ...     print(a, end=',')
          ...     a, b = b, a+b
          ...
          0,1,1,2,3,5,8,13,21,34,55,89,144,233,377,610,987,

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Fibonacci_number


File: python.info,  Node: More Control Flow Tools,  Next: Data Structures,  Prev: An Informal Introduction to Python,  Up: The Python Tutorial

2.4 More Control Flow Tools
===========================

Besides the *note while: 1167. statement just introduced, Python uses
the usual flow control statements known from other languages, with some
twists.

* Menu:

* if Statements::
* for Statements::
* The range() Function: The range Function.
* break and continue Statements, and else Clauses on Loops: break and continue Statements and else Clauses on Loops.
* pass Statements::
* Defining Functions::
* More on Defining Functions::
* Intermezzo; Coding Style: Intermezzo Coding Style.


File: python.info,  Node: if Statements,  Next: for Statements,  Up: More Control Flow Tools

2.4.1 ‘if’ Statements
---------------------

Perhaps the most well-known statement type is the *note if: dda.
statement.  For example:

     >>> x = int(input("Please enter an integer: "))
     Please enter an integer: 42
     >>> if x < 0:
     ...     x = 0
     ...     print('Negative changed to zero')
     ... elif x == 0:
     ...     print('Zero')
     ... elif x == 1:
     ...     print('Single')
     ... else:
     ...     print('More')
     ...
     More

There can be zero or more *note elif: 116d. parts, and the *note else:
116e. part is optional.  The keyword ‘‘elif’’ is short for ‘else if’,
and is useful to avoid excessive indentation.  An ‘if’ … ‘elif’ … ‘elif’
… sequence is a substitute for the ‘switch’ or ‘case’ statements found
in other languages.


File: python.info,  Node: for Statements,  Next: The range Function,  Prev: if Statements,  Up: More Control Flow Tools

2.4.2 ‘for’ Statements
----------------------

The *note for: c23. statement in Python differs a bit from what you may
be used to in C or Pascal.  Rather than always iterating over an
arithmetic progression of numbers (like in Pascal), or giving the user
the ability to define both the iteration step and halting condition (as
C), Python’s ‘for’ statement iterates over the items of any sequence (a
list or a string), in the order that they appear in the sequence.  For
example (no pun intended):

     >>> # Measure some strings:
     ... words = ['cat', 'window', 'defenestrate']
     >>> for w in words:
     ...     print(w, len(w))
     ...
     cat 3
     window 6
     defenestrate 12

Code that modifies a collection while iterating over that same
collection can be tricky to get right.  Instead, it is usually more
straight-forward to loop over a copy of the collection or to create a
new collection:

     # Strategy:  Iterate over a copy
     for user, status in users.copy().items():
         if status == 'inactive':
             del users[user]

     # Strategy:  Create a new collection
     active_users = {}
     for user, status in users.items():
         if status == 'active':
             active_users[user] = status


File: python.info,  Node: The range Function,  Next: break and continue Statements and else Clauses on Loops,  Prev: for Statements,  Up: More Control Flow Tools

2.4.3 The ‘range()’ Function
----------------------------

If you do need to iterate over a sequence of numbers, the built-in
function *note range(): 9b2. comes in handy.  It generates arithmetic
progressions:

     >>> for i in range(5):
     ...     print(i)
     ...
     0
     1
     2
     3
     4

The given end point is never part of the generated sequence; ‘range(10)’
generates 10 values, the legal indices for items of a sequence of length
10.  It is possible to let the range start at another number, or to
specify a different increment (even negative; sometimes this is called
the ‘step’):

     range(5, 10)
        5, 6, 7, 8, 9

     range(0, 10, 3)
        0, 3, 6, 9

     range(-10, -100, -30)
       -10, -40, -70

To iterate over the indices of a sequence, you can combine *note
range(): 9b2. and *note len(): 150. as follows:

     >>> a = ['Mary', 'had', 'a', 'little', 'lamb']
     >>> for i in range(len(a)):
     ...     print(i, a[i])
     ...
     0 Mary
     1 had
     2 a
     3 little
     4 lamb

In most such cases, however, it is convenient to use the *note
enumerate(): dd6. function, see *note Looping Techniques: 1173.

A strange thing happens if you just print a range:

     >>> print(range(10))
     range(0, 10)

In many ways the object returned by *note range(): 9b2. behaves as if it
is a list, but in fact it isn’t.  It is an object which returns the
successive items of the desired sequence when you iterate over it, but
it doesn’t really make the list, thus saving space.

We say such an object is *note iterable: b9f, that is, suitable as a
target for functions and constructs that expect something from which
they can obtain successive items until the supply is exhausted.  We have
seen that the *note for: c23. statement is such a construct, while an
example of function that takes an iterable is *note sum(): 1e3.:

     >>> sum(range(4))  # 0 + 1 + 2 + 3
     6

Later we will see more functions that return iterables and take
iterables as arguments.  Lastly, maybe you are curious about how to get
a list from a range.  Here is the solution:

     >>> list(range(4))
     [0, 1, 2, 3]

In chapter *note Data Structures: 1174, we will discuss in more detail
about *note list(): 260.


File: python.info,  Node: break and continue Statements and else Clauses on Loops,  Next: pass Statements,  Prev: The range Function,  Up: More Control Flow Tools

2.4.4 ‘break’ and ‘continue’ Statements, and ‘else’ Clauses on Loops
--------------------------------------------------------------------

The *note break: 2d9. statement, like in C, breaks out of the innermost
enclosing *note for: c23. or *note while: 1167. loop.

Loop statements may have an ‘else’ clause; it is executed when the loop
terminates through exhaustion of the iterable (with *note for: c23.) or
when the condition becomes false (with *note while: 1167.), but not when
the loop is terminated by a *note break: 2d9. statement.  This is
exemplified by the following loop, which searches for prime numbers:

     >>> for n in range(2, 10):
     ...     for x in range(2, n):
     ...         if n % x == 0:
     ...             print(n, 'equals', x, '*', n//x)
     ...             break
     ...     else:
     ...         # loop fell through without finding a factor
     ...         print(n, 'is a prime number')
     ...
     2 is a prime number
     3 is a prime number
     4 equals 2 * 2
     5 is a prime number
     6 equals 2 * 3
     7 is a prime number
     8 equals 2 * 4
     9 equals 3 * 3

(Yes, this is the correct code.  Look closely: the ‘else’ clause belongs
to the *note for: c23. loop, `not' the *note if: dda. statement.)

When used with a loop, the ‘else’ clause has more in common with the
‘else’ clause of a *note try: d65. statement than it does with that of
*note if: dda. statements: a *note try: d65. statement’s ‘else’ clause
runs when no exception occurs, and a loop’s ‘else’ clause runs when no
‘break’ occurs.  For more on the ‘try’ statement and exceptions, see
*note Handling Exceptions: 1177.

The *note continue: 181. statement, also borrowed from C, continues with
the next iteration of the loop:

     >>> for num in range(2, 10):
     ...     if num % 2 == 0:
     ...         print("Found an even number", num)
     ...         continue
     ...     print("Found a number", num)
     Found an even number 2
     Found a number 3
     Found an even number 4
     Found a number 5
     Found an even number 6
     Found a number 7
     Found an even number 8
     Found a number 9


File: python.info,  Node: pass Statements,  Next: Defining Functions,  Prev: break and continue Statements and else Clauses on Loops,  Up: More Control Flow Tools

2.4.5 ‘pass’ Statements
-----------------------

The *note pass: 117a. statement does nothing.  It can be used when a
statement is required syntactically but the program requires no action.
For example:

     >>> while True:
     ...     pass  # Busy-wait for keyboard interrupt (Ctrl+C)
     ...

This is commonly used for creating minimal classes:

     >>> class MyEmptyClass:
     ...     pass
     ...

Another place *note pass: 117a. can be used is as a place-holder for a
function or conditional body when you are working on new code, allowing
you to keep thinking at a more abstract level.  The ‘pass’ is silently
ignored:

     >>> def initlog(*args):
     ...     pass   # Remember to implement this!
     ...


File: python.info,  Node: Defining Functions,  Next: More on Defining Functions,  Prev: pass Statements,  Up: More Control Flow Tools

2.4.6 Defining Functions
------------------------

We can create a function that writes the Fibonacci series to an
arbitrary boundary:

     >>> def fib(n):    # write Fibonacci series up to n
     ...     """Print a Fibonacci series up to n."""
     ...     a, b = 0, 1
     ...     while a < n:
     ...         print(a, end=' ')
     ...         a, b = b, a+b
     ...     print()
     ...
     >>> # Now call the function we just defined:
     ... fib(2000)
     0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597

The keyword *note def: db1. introduces a function `definition'.  It must
be followed by the function name and the parenthesized list of formal
parameters.  The statements that form the body of the function start at
the next line, and must be indented.

The first statement of the function body can optionally be a string
literal; this string literal is the function’s documentation string, or
`docstring'.  (More about docstrings can be found in the section *note
Documentation Strings: 117d.)  There are tools which use docstrings to
automatically produce online or printed documentation, or to let the
user interactively browse through code; it’s good practice to include
docstrings in code that you write, so make a habit of it.

The `execution' of a function introduces a new symbol table used for the
local variables of the function.  More precisely, all variable
assignments in a function store the value in the local symbol table;
whereas variable references first look in the local symbol table, then
in the local symbol tables of enclosing functions, then in the global
symbol table, and finally in the table of built-in names.  Thus, global
variables and variables of enclosing functions cannot be directly
assigned a value within a function (unless, for global variables, named
in a *note global: 117e. statement, or, for variables of enclosing
functions, named in a *note nonlocal: c32. statement), although they may
be referenced.

The actual parameters (arguments) to a function call are introduced in
the local symbol table of the called function when it is called; thus,
arguments are passed using `call by value' (where the `value' is always
an object `reference', not the value of the object).  (1) When a
function calls another function, a new local symbol table is created for
that call.

A function definition introduces the function name in the current symbol
table.  The value of the function name has a type that is recognized by
the interpreter as a user-defined function.  This value can be assigned
to another name which can then also be used as a function.  This serves
as a general renaming mechanism:

     >>> fib
     <function fib at 10042ed0>
     >>> f = fib
     >>> f(100)
     0 1 1 2 3 5 8 13 21 34 55 89

Coming from other languages, you might object that ‘fib’ is not a
function but a procedure since it doesn’t return a value.  In fact, even
functions without a *note return: 190. statement do return a value,
albeit a rather boring one.  This value is called ‘None’ (it’s a
built-in name).  Writing the value ‘None’ is normally suppressed by the
interpreter if it would be the only value written.  You can see it if
you really want to using *note print(): 87a.:

     >>> fib(0)
     >>> print(fib(0))
     None

It is simple to write a function that returns a list of the numbers of
the Fibonacci series, instead of printing it:

     >>> def fib2(n):  # return Fibonacci series up to n
     ...     """Return a list containing the Fibonacci series up to n."""
     ...     result = []
     ...     a, b = 0, 1
     ...     while a < n:
     ...         result.append(a)    # see below
     ...         a, b = b, a+b
     ...     return result
     ...
     >>> f100 = fib2(100)    # call it
     >>> f100                # write the result
     [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]

This example, as usual, demonstrates some new Python features:

   * The *note return: 190. statement returns with a value from a
     function.  ‘return’ without an expression argument returns ‘None’.
     Falling off the end of a function also returns ‘None’.

   * The statement ‘result.append(a)’ calls a `method' of the list
     object ‘result’.  A method is a function that ‘belongs’ to an
     object and is named ‘obj.methodname’, where ‘obj’ is some object
     (this may be an expression), and ‘methodname’ is the name of a
     method that is defined by the object’s type.  Different types
     define different methods.  Methods of different types may have the
     same name without causing ambiguity.  (It is possible to define
     your own object types and methods, using `classes', see *note
     Classes: 117f.) The method ‘append()’ shown in the example is
     defined for list objects; it adds a new element at the end of the
     list.  In this example it is equivalent to ‘result = result + [a]’,
     but more efficient.

   ---------- Footnotes ----------

   (1) (1) Actually, `call by object reference' would be a better
description, since if a mutable object is passed, the caller will see
any changes the callee makes to it (items inserted into a list).


File: python.info,  Node: More on Defining Functions,  Next: Intermezzo Coding Style,  Prev: Defining Functions,  Up: More Control Flow Tools

2.4.7 More on Defining Functions
--------------------------------

It is also possible to define functions with a variable number of
arguments.  There are three forms, which can be combined.

* Menu:

* Default Argument Values::
* Keyword Arguments::
* Special parameters::
* Arbitrary Argument Lists::
* Unpacking Argument Lists::
* Lambda Expressions::
* Documentation Strings::
* Function Annotations::


File: python.info,  Node: Default Argument Values,  Next: Keyword Arguments,  Up: More on Defining Functions

2.4.7.1 Default Argument Values
...............................

The most useful form is to specify a default value for one or more
arguments.  This creates a function that can be called with fewer
arguments than it is defined to allow.  For example:

     def ask_ok(prompt, retries=4, reminder='Please try again!'):
         while True:
             ok = input(prompt)
             if ok in ('y', 'ye', 'yes'):
                 return True
             if ok in ('n', 'no', 'nop', 'nope'):
                 return False
             retries = retries - 1
             if retries < 0:
                 raise ValueError('invalid user response')
             print(reminder)

This function can be called in several ways:

   * giving only the mandatory argument: ‘ask_ok('Do you really want to
     quit?')’

   * giving one of the optional arguments: ‘ask_ok('OK to overwrite the
     file?', 2)’

   * or even giving all arguments: ‘ask_ok('OK to overwrite the file?',
     2, 'Come on, only yes or no!')’

This example also introduces the *note in: 797. keyword.  This tests
whether or not a sequence contains a certain value.

The default values are evaluated at the point of function definition in
the `defining' scope, so that

     i = 5

     def f(arg=i):
         print(arg)

     i = 6
     f()

will print ‘5’.

`Important warning:' The default value is evaluated only once.  This
makes a difference when the default is a mutable object such as a list,
dictionary, or instances of most classes.  For example, the following
function accumulates the arguments passed to it on subsequent calls:

     def f(a, L=[]):
         L.append(a)
         return L

     print(f(1))
     print(f(2))
     print(f(3))

This will print

     [1]
     [1, 2]
     [1, 2, 3]

If you don’t want the default to be shared between subsequent calls, you
can write the function like this instead:

     def f(a, L=None):
         if L is None:
             L = []
         L.append(a)
         return L


File: python.info,  Node: Keyword Arguments,  Next: Special parameters,  Prev: Default Argument Values,  Up: More on Defining Functions

2.4.7.2 Keyword Arguments
.........................

Functions can also be called using *note keyword arguments: 5b9. of the
form ‘kwarg=value’.  For instance, the following function:

     def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):
         print("-- This parrot wouldn't", action, end=' ')
         print("if you put", voltage, "volts through it.")
         print("-- Lovely plumage, the", type)
         print("-- It's", state, "!")

accepts one required argument (‘voltage’) and three optional arguments
(‘state’, ‘action’, and ‘type’).  This function can be called in any of
the following ways:

     parrot(1000)                                          # 1 positional argument
     parrot(voltage=1000)                                  # 1 keyword argument
     parrot(voltage=1000000, action='VOOOOOM')             # 2 keyword arguments
     parrot(action='VOOOOOM', voltage=1000000)             # 2 keyword arguments
     parrot('a million', 'bereft of life', 'jump')         # 3 positional arguments
     parrot('a thousand', state='pushing up the daisies')  # 1 positional, 1 keyword

but all the following calls would be invalid:

     parrot()                     # required argument missing
     parrot(voltage=5.0, 'dead')  # non-keyword argument after a keyword argument
     parrot(110, voltage=220)     # duplicate value for the same argument
     parrot(actor='John Cleese')  # unknown keyword argument

In a function call, keyword arguments must follow positional arguments.
All the keyword arguments passed must match one of the arguments
accepted by the function (e.g.  ‘actor’ is not a valid argument for the
‘parrot’ function), and their order is not important.  This also
includes non-optional arguments (e.g.  ‘parrot(voltage=1000)’ is valid
too).  No argument may receive a value more than once.  Here’s an
example that fails due to this restriction:

     >>> def function(a):
     ...     pass
     ...
     >>> function(0, a=0)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: function() got multiple values for keyword argument 'a'

When a final formal parameter of the form ‘**name’ is present, it
receives a dictionary (see *note Mapping Types — dict: 2f1.) containing
all keyword arguments except for those corresponding to a formal
parameter.  This may be combined with a formal parameter of the form
‘*name’ (described in the next subsection) which receives a *note tuple:
1186. containing the positional arguments beyond the formal parameter
list.  (‘*name’ must occur before ‘**name’.)  For example, if we define
a function like this:

     def cheeseshop(kind, *arguments, **keywords):
         print("-- Do you have any", kind, "?")
         print("-- I'm sorry, we're all out of", kind)
         for arg in arguments:
             print(arg)
         print("-" * 40)
         for kw in keywords:
             print(kw, ":", keywords[kw])

It could be called like this:

     cheeseshop("Limburger", "It's very runny, sir.",
                "It's really very, VERY runny, sir.",
                shopkeeper="Michael Palin",
                client="John Cleese",
                sketch="Cheese Shop Sketch")

and of course it would print:

     -- Do you have any Limburger ?
     -- I'm sorry, we're all out of Limburger
     It's very runny, sir.
     It's really very, VERY runny, sir.
     ----------------------------------------
     shopkeeper : Michael Palin
     client : John Cleese
     sketch : Cheese Shop Sketch

Note that the order in which the keyword arguments are printed is
guaranteed to match the order in which they were provided in the
function call.


File: python.info,  Node: Special parameters,  Next: Arbitrary Argument Lists,  Prev: Keyword Arguments,  Up: More on Defining Functions

2.4.7.3 Special parameters
..........................

By default, arguments may be passed to a Python function either by
position or explicitly by keyword.  For readability and performance, it
makes sense to restrict the way arguments can be passed so that a
developer need only look at the function definition to determine if
items are passed by position, by position or keyword, or by keyword.

A function definition may look like:

     def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
           -----------    ----------     ----------
             |             |                  |
             |        Positional or keyword   |
             |                                - Keyword only
              -- Positional only

where ‘/’ and ‘*’ are optional.  If used, these symbols indicate the
kind of parameter by how the arguments may be passed to the function:
positional-only, positional-or-keyword, and keyword-only.  Keyword
parameters are also referred to as named parameters.

* Menu:

* Positional-or-Keyword Arguments::
* Positional-Only Parameters::
* Keyword-Only Arguments::
* Function Examples::
* Recap::


File: python.info,  Node: Positional-or-Keyword Arguments,  Next: Positional-Only Parameters,  Up: Special parameters

2.4.7.4 Positional-or-Keyword Arguments
.......................................

If ‘/’ and ‘*’ are not present in the function definition, arguments may
be passed to a function by position or by keyword.


File: python.info,  Node: Positional-Only Parameters,  Next: Keyword-Only Arguments,  Prev: Positional-or-Keyword Arguments,  Up: Special parameters

2.4.7.5 Positional-Only Parameters
..................................

Looking at this in a bit more detail, it is possible to mark certain
parameters as `positional-only'.  If `positional-only', the parameters’
order matters, and the parameters cannot be passed by keyword.
Positional-only parameters are placed before a ‘/’ (forward-slash).  The
‘/’ is used to logically separate the positional-only parameters from
the rest of the parameters.  If there is no ‘/’ in the function
definition, there are no positional-only parameters.

Parameters following the ‘/’ may be `positional-or-keyword' or
`keyword-only'.


File: python.info,  Node: Keyword-Only Arguments,  Next: Function Examples,  Prev: Positional-Only Parameters,  Up: Special parameters

2.4.7.6 Keyword-Only Arguments
..............................

To mark parameters as `keyword-only', indicating the parameters must be
passed by keyword argument, place an ‘*’ in the arguments list just
before the first `keyword-only' parameter.


File: python.info,  Node: Function Examples,  Next: Recap,  Prev: Keyword-Only Arguments,  Up: Special parameters

2.4.7.7 Function Examples
.........................

Consider the following example function definitions paying close
attention to the markers ‘/’ and ‘*’:

     >>> def standard_arg(arg):
     ...     print(arg)
     ...
     >>> def pos_only_arg(arg, /):
     ...     print(arg)
     ...
     >>> def kwd_only_arg(*, arg):
     ...     print(arg)
     ...
     >>> def combined_example(pos_only, /, standard, *, kwd_only):
     ...     print(pos_only, standard, kwd_only)

The first function definition, ‘standard_arg’, the most familiar form,
places no restrictions on the calling convention and arguments may be
passed by position or keyword:

     >>> standard_arg(2)
     2

     >>> standard_arg(arg=2)
     2

The second function ‘pos_only_arg’ is restricted to only use positional
parameters as there is a ‘/’ in the function definition:

     >>> pos_only_arg(1)
     1

     >>> pos_only_arg(arg=1)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: pos_only_arg() got an unexpected keyword argument 'arg'

The third function ‘kwd_only_args’ only allows keyword arguments as
indicated by a ‘*’ in the function definition:

     >>> kwd_only_arg(3)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: kwd_only_arg() takes 0 positional arguments but 1 was given

     >>> kwd_only_arg(arg=3)
     3

And the last uses all three calling conventions in the same function
definition:

     >>> combined_example(1, 2, 3)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: combined_example() takes 2 positional arguments but 3 were given

     >>> combined_example(1, 2, kwd_only=3)
     1 2 3

     >>> combined_example(1, standard=2, kwd_only=3)
     1 2 3

     >>> combined_example(pos_only=1, standard=2, kwd_only=3)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: combined_example() got an unexpected keyword argument 'pos_only'

Finally, consider this function definition which has a potential
collision between the positional argument ‘name’ and ‘**kwds’ which has
‘name’ as a key:

     def foo(name, **kwds):
         return 'name' in kwds

There is no possible call that will make it return ‘True’ as the keyword
‘'name'’ will always to bind to the first parameter.  For example:

     >>> foo(1, **{'name': 2})
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: foo() got multiple values for argument 'name'
     >>>

But using ‘/’ (positional only arguments), it is possible since it
allows ‘name’ as a positional argument and ‘'name'’ as a key in the
keyword arguments:

     def foo(name, /, **kwds):
         return 'name' in kwds
     >>> foo(1, **{'name': 2})
     True

In other words, the names of positional-only parameters can be used in
‘**kwds’ without ambiguity.


File: python.info,  Node: Recap,  Prev: Function Examples,  Up: Special parameters

2.4.7.8 Recap
.............

The use case will determine which parameters to use in the function
definition:

     def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):

As guidance:

   * Use positional-only if you want the name of the parameters to not
     be available to the user.  This is useful when parameter names have
     no real meaning, if you want to enforce the order of the arguments
     when the function is called or if you need to take some positional
     parameters and arbitrary keywords.

   * Use keyword-only when names have meaning and the function
     definition is more understandable by being explicit with names or
     you want to prevent users relying on the position of the argument
     being passed.

   * For an API, use positional-only to prevent breaking API changes if
     the parameter’s name is modified in the future.


File: python.info,  Node: Arbitrary Argument Lists,  Next: Unpacking Argument Lists,  Prev: Special parameters,  Up: More on Defining Functions

2.4.7.9 Arbitrary Argument Lists
................................

Finally, the least frequently used option is to specify that a function
can be called with an arbitrary number of arguments.  These arguments
will be wrapped up in a tuple (see *note Tuples and Sequences: 1186.).
Before the variable number of arguments, zero or more normal arguments
may occur.

     def write_multiple_items(file, separator, *args):
         file.write(separator.join(args))

Normally, these ‘variadic’ arguments will be last in the list of formal
parameters, because they scoop up all remaining input arguments that are
passed to the function.  Any formal parameters which occur after the
‘*args’ parameter are ‘keyword-only’ arguments, meaning that they can
only be used as keywords rather than positional arguments.

     >>> def concat(*args, sep="/"):
     ...     return sep.join(args)
     ...
     >>> concat("earth", "mars", "venus")
     'earth/mars/venus'
     >>> concat("earth", "mars", "venus", sep=".")
     'earth.mars.venus'


File: python.info,  Node: Unpacking Argument Lists,  Next: Lambda Expressions,  Prev: Arbitrary Argument Lists,  Up: More on Defining Functions

2.4.7.10 Unpacking Argument Lists
.................................

The reverse situation occurs when the arguments are already in a list or
tuple but need to be unpacked for a function call requiring separate
positional arguments.  For instance, the built-in *note range(): 9b2.
function expects separate `start' and `stop' arguments.  If they are not
available separately, write the function call with the ‘*’-operator to
unpack the arguments out of a list or tuple:

     >>> list(range(3, 6))            # normal call with separate arguments
     [3, 4, 5]
     >>> args = [3, 6]
     >>> list(range(*args))            # call with arguments unpacked from a list
     [3, 4, 5]

In the same fashion, dictionaries can deliver keyword arguments with the
‘**’-operator:

     >>> def parrot(voltage, state='a stiff', action='voom'):
     ...     print("-- This parrot wouldn't", action, end=' ')
     ...     print("if you put", voltage, "volts through it.", end=' ')
     ...     print("E's", state, "!")
     ...
     >>> d = {"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"}
     >>> parrot(**d)
     -- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !


File: python.info,  Node: Lambda Expressions,  Next: Documentation Strings,  Prev: Unpacking Argument Lists,  Up: More on Defining Functions

2.4.7.11 Lambda Expressions
...........................

Small anonymous functions can be created with the *note lambda: c22.
keyword.  This function returns the sum of its two arguments: ‘lambda a,
b: a+b’.  Lambda functions can be used wherever function objects are
required.  They are syntactically restricted to a single expression.
Semantically, they are just syntactic sugar for a normal function
definition.  Like nested function definitions, lambda functions can
reference variables from the containing scope:

     >>> def make_incrementor(n):
     ...     return lambda x: x + n
     ...
     >>> f = make_incrementor(42)
     >>> f(0)
     42
     >>> f(1)
     43

The above example uses a lambda expression to return a function.
Another use is to pass a small function as an argument:

     >>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
     >>> pairs.sort(key=lambda pair: pair[1])
     >>> pairs
     [(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]


File: python.info,  Node: Documentation Strings,  Next: Function Annotations,  Prev: Lambda Expressions,  Up: More on Defining Functions

2.4.7.12 Documentation Strings
..............................

Here are some conventions about the content and formatting of
documentation strings.

The first line should always be a short, concise summary of the object’s
purpose.  For brevity, it should not explicitly state the object’s name
or type, since these are available by other means (except if the name
happens to be a verb describing a function’s operation).  This line
should begin with a capital letter and end with a period.

If there are more lines in the documentation string, the second line
should be blank, visually separating the summary from the rest of the
description.  The following lines should be one or more paragraphs
describing the object’s calling conventions, its side effects, etc.

The Python parser does not strip indentation from multi-line string
literals in Python, so tools that process documentation have to strip
indentation if desired.  This is done using the following convention.
The first non-blank line `after' the first line of the string determines
the amount of indentation for the entire documentation string.  (We
can’t use the first line since it is generally adjacent to the string’s
opening quotes so its indentation is not apparent in the string
literal.)  Whitespace “equivalent” to this indentation is then stripped
from the start of all lines of the string.  Lines that are indented less
should not occur, but if they occur all their leading whitespace should
be stripped.  Equivalence of whitespace should be tested after expansion
of tabs (to 8 spaces, normally).

Here is an example of a multi-line docstring:

     >>> def my_function():
     ...     """Do nothing, but document it.
     ...
     ...     No, really, it doesn't do anything.
     ...     """
     ...     pass
     ...
     >>> print(my_function.__doc__)
     Do nothing, but document it.

         No, really, it doesn't do anything.


File: python.info,  Node: Function Annotations,  Prev: Documentation Strings,  Up: More on Defining Functions

2.4.7.13 Function Annotations
.............................

*note Function annotations: 1196. are completely optional metadata
information about the types used by user-defined functions (see PEP
3107(1) and PEP 484(2) for more information).

*note Annotations: 1197. are stored in the ‘__annotations__’ attribute
of the function as a dictionary and have no effect on any other part of
the function.  Parameter annotations are defined by a colon after the
parameter name, followed by an expression evaluating to the value of the
annotation.  Return annotations are defined by a literal ‘->’, followed
by an expression, between the parameter list and the colon denoting the
end of the *note def: db1. statement.  The following example has a
positional argument, a keyword argument, and the return value annotated:

     >>> def f(ham: str, eggs: str = 'eggs') -> str:
     ...     print("Annotations:", f.__annotations__)
     ...     print("Arguments:", ham, eggs)
     ...     return ham + ' and ' + eggs
     ...
     >>> f('spam')
     Annotations: {'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>}
     Arguments: spam eggs
     'spam and eggs'

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3107

   (2) https://www.python.org/dev/peps/pep-0484


File: python.info,  Node: Intermezzo Coding Style,  Prev: More on Defining Functions,  Up: More Control Flow Tools

2.4.8 Intermezzo: Coding Style
------------------------------

Now that you are about to write longer, more complex pieces of Python,
it is a good time to talk about `coding style'.  Most languages can be
written (or more concise, `formatted') in different styles; some are
more readable than others.  Making it easy for others to read your code
is always a good idea, and adopting a nice coding style helps
tremendously for that.

For Python, PEP 8(1) has emerged as the style guide that most projects
adhere to; it promotes a very readable and eye-pleasing coding style.
Every Python developer should read it at some point; here are the most
important points extracted for you:

   * Use 4-space indentation, and no tabs.

     4 spaces are a good compromise between small indentation (allows
     greater nesting depth) and large indentation (easier to read).
     Tabs introduce confusion, and are best left out.

   * Wrap lines so that they don’t exceed 79 characters.

     This helps users with small displays and makes it possible to have
     several code files side-by-side on larger displays.

   * Use blank lines to separate functions and classes, and larger
     blocks of code inside functions.

   * When possible, put comments on a line of their own.

   * Use docstrings.

   * Use spaces around operators and after commas, but not directly
     inside bracketing constructs: ‘a = f(1, 2) + g(3, 4)’.

   * Name your classes and functions consistently; the convention is to
     use ‘UpperCamelCase’ for classes and ‘lowercase_with_underscores’
     for functions and methods.  Always use ‘self’ as the name for the
     first method argument (see *note A First Look at Classes: 119a. for
     more on classes and methods).

   * Don’t use fancy encodings if your code is meant to be used in
     international environments.  Python’s default, UTF-8, or even plain
     ASCII work best in any case.

   * Likewise, don’t use non-ASCII characters in identifiers if there is
     only the slightest chance people speaking a different language will
     read or maintain the code.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0008


File: python.info,  Node: Data Structures,  Next: Modules,  Prev: More Control Flow Tools,  Up: The Python Tutorial

2.5 Data Structures
===================

This chapter describes some things you’ve learned about already in more
detail, and adds some new things as well.

* Menu:

* More on Lists::
* The del statement::
* Tuples and Sequences::
* Sets::
* Dictionaries::
* Looping Techniques::
* More on Conditions::
* Comparing Sequences and Other Types::


File: python.info,  Node: More on Lists,  Next: The del statement,  Up: Data Structures

2.5.1 More on Lists
-------------------

The list data type has some more methods.  Here are all of the methods
of list objects:

 -- Method: list.append (x)

     Add an item to the end of the list.  Equivalent to ‘a[len(a):] =
     [x]’.

 -- Method: list.extend (iterable)

     Extend the list by appending all the items from the iterable.
     Equivalent to ‘a[len(a):] = iterable’.

 -- Method: list.insert (i, x)

     Insert an item at a given position.  The first argument is the
     index of the element before which to insert, so ‘a.insert(0, x)’
     inserts at the front of the list, and ‘a.insert(len(a), x)’ is
     equivalent to ‘a.append(x)’.

 -- Method: list.remove (x)

     Remove the first item from the list whose value is equal to `x'.
     It raises a *note ValueError: 1f9. if there is no such item.

 -- Method: list.pop ([i])

     Remove the item at the given position in the list, and return it.
     If no index is specified, ‘a.pop()’ removes and returns the last
     item in the list.  (The square brackets around the `i' in the
     method signature denote that the parameter is optional, not that
     you should type square brackets at that position.  You will see
     this notation frequently in the Python Library Reference.)

 -- Method: list.clear ()

     Remove all items from the list.  Equivalent to ‘del a[:]’.

 -- Method: list.index (x[, start[, end]])

     Return zero-based index in the list of the first item whose value
     is equal to `x'.  Raises a *note ValueError: 1f9. if there is no
     such item.

     The optional arguments `start' and `end' are interpreted as in the
     slice notation and are used to limit the search to a particular
     subsequence of the list.  The returned index is computed relative
     to the beginning of the full sequence rather than the `start'
     argument.

 -- Method: list.count (x)

     Return the number of times `x' appears in the list.

 -- Method: list.sort (key=None, reverse=False)

     Sort the items of the list in place (the arguments can be used for
     sort customization, see *note sorted(): 439. for their
     explanation).

 -- Method: list.reverse ()

     Reverse the elements of the list in place.

 -- Method: list.copy ()

     Return a shallow copy of the list.  Equivalent to ‘a[:]’.

An example that uses most of the list methods:

     >>> fruits = ['orange', 'apple', 'pear', 'banana', 'kiwi', 'apple', 'banana']
     >>> fruits.count('apple')
     2
     >>> fruits.count('tangerine')
     0
     >>> fruits.index('banana')
     3
     >>> fruits.index('banana', 4)  # Find next banana starting a position 4
     6
     >>> fruits.reverse()
     >>> fruits
     ['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange']
     >>> fruits.append('grape')
     >>> fruits
     ['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange', 'grape']
     >>> fruits.sort()
     >>> fruits
     ['apple', 'apple', 'banana', 'banana', 'grape', 'kiwi', 'orange', 'pear']
     >>> fruits.pop()
     'pear'

You might have noticed that methods like ‘insert’, ‘remove’ or ‘sort’
that only modify the list have no return value printed – they return the
default ‘None’.  (1) This is a design principle for all mutable data
structures in Python.

Another thing you might notice is that not all data can be sorted or
compared.  For instance, ‘[None, 'hello', 10]’ doesn’t sort because
integers can’t be compared to strings and `None' can’t be compared to
other types.  Also, there are some types that don’t have a defined
ordering relation.  For example, ‘3+4j < 5+7j’ isn’t a valid comparison.

* Menu:

* Using Lists as Stacks::
* Using Lists as Queues::
* List Comprehensions: List Comprehensions<2>.
* Nested List Comprehensions::

   ---------- Footnotes ----------

   (1) (1) Other languages may return the mutated object, which allows
method chaining, such as ‘d->insert("a")->remove("b")->sort();’.


File: python.info,  Node: Using Lists as Stacks,  Next: Using Lists as Queues,  Up: More on Lists

2.5.1.1 Using Lists as Stacks
.............................

The list methods make it very easy to use a list as a stack, where the
last element added is the first element retrieved (“last-in,
first-out”).  To add an item to the top of the stack, use ‘append()’.
To retrieve an item from the top of the stack, use ‘pop()’ without an
explicit index.  For example:

     >>> stack = [3, 4, 5]
     >>> stack.append(6)
     >>> stack.append(7)
     >>> stack
     [3, 4, 5, 6, 7]
     >>> stack.pop()
     7
     >>> stack
     [3, 4, 5, 6]
     >>> stack.pop()
     6
     >>> stack.pop()
     5
     >>> stack
     [3, 4]


File: python.info,  Node: Using Lists as Queues,  Next: List Comprehensions<2>,  Prev: Using Lists as Stacks,  Up: More on Lists

2.5.1.2 Using Lists as Queues
.............................

It is also possible to use a list as a queue, where the first element
added is the first element retrieved (“first-in, first-out”); however,
lists are not efficient for this purpose.  While appends and pops from
the end of list are fast, doing inserts or pops from the beginning of a
list is slow (because all of the other elements have to be shifted by
one).

To implement a queue, use *note collections.deque: 526. which was
designed to have fast appends and pops from both ends.  For example:

     >>> from collections import deque
     >>> queue = deque(["Eric", "John", "Michael"])
     >>> queue.append("Terry")           # Terry arrives
     >>> queue.append("Graham")          # Graham arrives
     >>> queue.popleft()                 # The first to arrive now leaves
     'Eric'
     >>> queue.popleft()                 # The second to arrive now leaves
     'John'
     >>> queue                           # Remaining queue in order of arrival
     deque(['Michael', 'Terry', 'Graham'])


File: python.info,  Node: List Comprehensions<2>,  Next: Nested List Comprehensions,  Prev: Using Lists as Queues,  Up: More on Lists

2.5.1.3 List Comprehensions
...........................

List comprehensions provide a concise way to create lists.  Common
applications are to make new lists where each element is the result of
some operations applied to each member of another sequence or iterable,
or to create a subsequence of those elements that satisfy a certain
condition.

For example, assume we want to create a list of squares, like:

     >>> squares = []
     >>> for x in range(10):
     ...     squares.append(x**2)
     ...
     >>> squares
     [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]

Note that this creates (or overwrites) a variable named ‘x’ that still
exists after the loop completes.  We can calculate the list of squares
without any side effects using:

     squares = list(map(lambda x: x**2, range(10)))

or, equivalently:

     squares = [x**2 for x in range(10)]

which is more concise and readable.

A list comprehension consists of brackets containing an expression
followed by a ‘for’ clause, then zero or more ‘for’ or ‘if’ clauses.
The result will be a new list resulting from evaluating the expression
in the context of the ‘for’ and ‘if’ clauses which follow it.  For
example, this listcomp combines the elements of two lists if they are
not equal:

     >>> [(x, y) for x in [1,2,3] for y in [3,1,4] if x != y]
     [(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]

and it’s equivalent to:

     >>> combs = []
     >>> for x in [1,2,3]:
     ...     for y in [3,1,4]:
     ...         if x != y:
     ...             combs.append((x, y))
     ...
     >>> combs
     [(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]

Note how the order of the *note for: c23. and *note if: dda. statements
is the same in both these snippets.

If the expression is a tuple (e.g.  the ‘(x, y)’ in the previous
example), it must be parenthesized.

     >>> vec = [-4, -2, 0, 2, 4]
     >>> # create a new list with the values doubled
     >>> [x*2 for x in vec]
     [-8, -4, 0, 4, 8]
     >>> # filter the list to exclude negative numbers
     >>> [x for x in vec if x >= 0]
     [0, 2, 4]
     >>> # apply a function to all the elements
     >>> [abs(x) for x in vec]
     [4, 2, 0, 2, 4]
     >>> # call a method on each element
     >>> freshfruit = ['  banana', '  loganberry ', 'passion fruit  ']
     >>> [weapon.strip() for weapon in freshfruit]
     ['banana', 'loganberry', 'passion fruit']
     >>> # create a list of 2-tuples like (number, square)
     >>> [(x, x**2) for x in range(6)]
     [(0, 0), (1, 1), (2, 4), (3, 9), (4, 16), (5, 25)]
     >>> # the tuple must be parenthesized, otherwise an error is raised
     >>> [x, x**2 for x in range(6)]
       File "<stdin>", line 1, in <module>
         [x, x**2 for x in range(6)]
                    ^
     SyntaxError: invalid syntax
     >>> # flatten a list using a listcomp with two 'for'
     >>> vec = [[1,2,3], [4,5,6], [7,8,9]]
     >>> [num for elem in vec for num in elem]
     [1, 2, 3, 4, 5, 6, 7, 8, 9]

List comprehensions can contain complex expressions and nested
functions:

     >>> from math import pi
     >>> [str(round(pi, i)) for i in range(1, 6)]
     ['3.1', '3.14', '3.142', '3.1416', '3.14159']


File: python.info,  Node: Nested List Comprehensions,  Prev: List Comprehensions<2>,  Up: More on Lists

2.5.1.4 Nested List Comprehensions
..................................

The initial expression in a list comprehension can be any arbitrary
expression, including another list comprehension.

Consider the following example of a 3x4 matrix implemented as a list of
3 lists of length 4:

     >>> matrix = [
     ...     [1, 2, 3, 4],
     ...     [5, 6, 7, 8],
     ...     [9, 10, 11, 12],
     ... ]

The following list comprehension will transpose rows and columns:

     >>> [[row[i] for row in matrix] for i in range(4)]
     [[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]

As we saw in the previous section, the nested listcomp is evaluated in
the context of the *note for: c23. that follows it, so this example is
equivalent to:

     >>> transposed = []
     >>> for i in range(4):
     ...     transposed.append([row[i] for row in matrix])
     ...
     >>> transposed
     [[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]

which, in turn, is the same as:

     >>> transposed = []
     >>> for i in range(4):
     ...     # the following 3 lines implement the nested listcomp
     ...     transposed_row = []
     ...     for row in matrix:
     ...         transposed_row.append(row[i])
     ...     transposed.append(transposed_row)
     ...
     >>> transposed
     [[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]

In the real world, you should prefer built-in functions to complex flow
statements.  The *note zip(): c25. function would do a great job for
this use case:

     >>> list(zip(*matrix))
     [(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)]

See *note Unpacking Argument Lists: 118f. for details on the asterisk in
this line.


File: python.info,  Node: The del statement,  Next: Tuples and Sequences,  Prev: More on Lists,  Up: Data Structures

2.5.2 The ‘del’ statement
-------------------------

There is a way to remove an item from a list given its index instead of
its value: the *note del: 11a8. statement.  This differs from the
‘pop()’ method which returns a value.  The ‘del’ statement can also be
used to remove slices from a list or clear the entire list (which we did
earlier by assignment of an empty list to the slice).  For example:

     >>> a = [-1, 1, 66.25, 333, 333, 1234.5]
     >>> del a[0]
     >>> a
     [1, 66.25, 333, 333, 1234.5]
     >>> del a[2:4]
     >>> a
     [1, 66.25, 1234.5]
     >>> del a[:]
     >>> a
     []

*note del: 11a8. can also be used to delete entire variables:

     >>> del a

Referencing the name ‘a’ hereafter is an error (at least until another
value is assigned to it).  We’ll find other uses for *note del: 11a8.
later.


File: python.info,  Node: Tuples and Sequences,  Next: Sets,  Prev: The del statement,  Up: Data Structures

2.5.3 Tuples and Sequences
--------------------------

We saw that lists and strings have many common properties, such as
indexing and slicing operations.  They are two examples of `sequence'
data types (see *note Sequence Types — list, tuple, range: 11aa.).
Since Python is an evolving language, other sequence data types may be
added.  There is also another standard sequence data type: the `tuple'.

A tuple consists of a number of values separated by commas, for
instance:

     >>> t = 12345, 54321, 'hello!'
     >>> t[0]
     12345
     >>> t
     (12345, 54321, 'hello!')
     >>> # Tuples may be nested:
     ... u = t, (1, 2, 3, 4, 5)
     >>> u
     ((12345, 54321, 'hello!'), (1, 2, 3, 4, 5))
     >>> # Tuples are immutable:
     ... t[0] = 88888
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: 'tuple' object does not support item assignment
     >>> # but they can contain mutable objects:
     ... v = ([1, 2, 3], [3, 2, 1])
     >>> v
     ([1, 2, 3], [3, 2, 1])

As you see, on output tuples are always enclosed in parentheses, so that
nested tuples are interpreted correctly; they may be input with or
without surrounding parentheses, although often parentheses are
necessary anyway (if the tuple is part of a larger expression).  It is
not possible to assign to the individual items of a tuple, however it is
possible to create tuples which contain mutable objects, such as lists.

Though tuples may seem similar to lists, they are often used in
different situations and for different purposes.  Tuples are *note
immutable: 115c, and usually contain a heterogeneous sequence of
elements that are accessed via unpacking (see later in this section) or
indexing (or even by attribute in the case of *note namedtuples: 1b5.).
Lists are *note mutable: 1164, and their elements are usually
homogeneous and are accessed by iterating over the list.

A special problem is the construction of tuples containing 0 or 1 items:
the syntax has some extra quirks to accommodate these.  Empty tuples are
constructed by an empty pair of parentheses; a tuple with one item is
constructed by following a value with a comma (it is not sufficient to
enclose a single value in parentheses).  Ugly, but effective.  For
example:

     >>> empty = ()
     >>> singleton = 'hello',    # <-- note trailing comma
     >>> len(empty)
     0
     >>> len(singleton)
     1
     >>> singleton
     ('hello',)

The statement ‘t = 12345, 54321, 'hello!'’ is an example of `tuple
packing': the values ‘12345’, ‘54321’ and ‘'hello!'’ are packed together
in a tuple.  The reverse operation is also possible:

     >>> x, y, z = t

This is called, appropriately enough, `sequence unpacking' and works for
any sequence on the right-hand side.  Sequence unpacking requires that
there are as many variables on the left side of the equals sign as there
are elements in the sequence.  Note that multiple assignment is really
just a combination of tuple packing and sequence unpacking.


File: python.info,  Node: Sets,  Next: Dictionaries,  Prev: Tuples and Sequences,  Up: Data Structures

2.5.4 Sets
----------

Python also includes a data type for `sets'.  A set is an unordered
collection with no duplicate elements.  Basic uses include membership
testing and eliminating duplicate entries.  Set objects also support
mathematical operations like union, intersection, difference, and
symmetric difference.

Curly braces or the *note set(): b62. function can be used to create
sets.  Note: to create an empty set you have to use ‘set()’, not ‘{}’;
the latter creates an empty dictionary, a data structure that we discuss
in the next section.

Here is a brief demonstration:

     >>> basket = {'apple', 'orange', 'apple', 'pear', 'orange', 'banana'}
     >>> print(basket)                      # show that duplicates have been removed
     {'orange', 'banana', 'pear', 'apple'}
     >>> 'orange' in basket                 # fast membership testing
     True
     >>> 'crabgrass' in basket
     False

     >>> # Demonstrate set operations on unique letters from two words
     ...
     >>> a = set('abracadabra')
     >>> b = set('alacazam')
     >>> a                                  # unique letters in a
     {'a', 'r', 'b', 'c', 'd'}
     >>> a - b                              # letters in a but not in b
     {'r', 'd', 'b'}
     >>> a | b                              # letters in a or b or both
     {'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'}
     >>> a & b                              # letters in both a and b
     {'a', 'c'}
     >>> a ^ b                              # letters in a or b but not both
     {'r', 'd', 'b', 'm', 'z', 'l'}

Similarly to *note list comprehensions: 11a4, set comprehensions are
also supported:

     >>> a = {x for x in 'abracadabra' if x not in 'abc'}
     >>> a
     {'r', 'd'}


File: python.info,  Node: Dictionaries,  Next: Looping Techniques,  Prev: Sets,  Up: Data Structures

2.5.5 Dictionaries
------------------

Another useful data type built into Python is the `dictionary' (see
*note Mapping Types — dict: 2f1.).  Dictionaries are sometimes found in
other languages as “associative memories” or “associative arrays”.
Unlike sequences, which are indexed by a range of numbers, dictionaries
are indexed by `keys', which can be any immutable type; strings and
numbers can always be keys.  Tuples can be used as keys if they contain
only strings, numbers, or tuples; if a tuple contains any mutable object
either directly or indirectly, it cannot be used as a key.  You can’t
use lists as keys, since lists can be modified in place using index
assignments, slice assignments, or methods like ‘append()’ and
‘extend()’.

It is best to think of a dictionary as a set of `key: value' pairs, with
the requirement that the keys are unique (within one dictionary).  A
pair of braces creates an empty dictionary: ‘{}’.  Placing a
comma-separated list of key:value pairs within the braces adds initial
key:value pairs to the dictionary; this is also the way dictionaries are
written on output.

The main operations on a dictionary are storing a value with some key
and extracting the value given the key.  It is also possible to delete a
key:value pair with ‘del’.  If you store using a key that is already in
use, the old value associated with that key is forgotten.  It is an
error to extract a value using a non-existent key.

Performing ‘list(d)’ on a dictionary returns a list of all the keys used
in the dictionary, in insertion order (if you want it sorted, just use
‘sorted(d)’ instead).  To check whether a single key is in the
dictionary, use the *note in: 797. keyword.

Here is a small example using a dictionary:

     >>> tel = {'jack': 4098, 'sape': 4139}
     >>> tel['guido'] = 4127
     >>> tel
     {'jack': 4098, 'sape': 4139, 'guido': 4127}
     >>> tel['jack']
     4098
     >>> del tel['sape']
     >>> tel['irv'] = 4127
     >>> tel
     {'jack': 4098, 'guido': 4127, 'irv': 4127}
     >>> list(tel)
     ['jack', 'guido', 'irv']
     >>> sorted(tel)
     ['guido', 'irv', 'jack']
     >>> 'guido' in tel
     True
     >>> 'jack' not in tel
     False

The *note dict(): 1b6. constructor builds dictionaries directly from
sequences of key-value pairs:

     >>> dict([('sape', 4139), ('guido', 4127), ('jack', 4098)])
     {'sape': 4139, 'guido': 4127, 'jack': 4098}

In addition, dict comprehensions can be used to create dictionaries from
arbitrary key and value expressions:

     >>> {x: x**2 for x in (2, 4, 6)}
     {2: 4, 4: 16, 6: 36}

When the keys are simple strings, it is sometimes easier to specify
pairs using keyword arguments:

     >>> dict(sape=4139, guido=4127, jack=4098)
     {'sape': 4139, 'guido': 4127, 'jack': 4098}


File: python.info,  Node: Looping Techniques,  Next: More on Conditions,  Prev: Dictionaries,  Up: Data Structures

2.5.6 Looping Techniques
------------------------

When looping through dictionaries, the key and corresponding value can
be retrieved at the same time using the ‘items()’ method.

     >>> knights = {'gallahad': 'the pure', 'robin': 'the brave'}
     >>> for k, v in knights.items():
     ...     print(k, v)
     ...
     gallahad the pure
     robin the brave

When looping through a sequence, the position index and corresponding
value can be retrieved at the same time using the *note enumerate():
dd6. function.

     >>> for i, v in enumerate(['tic', 'tac', 'toe']):
     ...     print(i, v)
     ...
     0 tic
     1 tac
     2 toe

To loop over two or more sequences at the same time, the entries can be
paired with the *note zip(): c25. function.

     >>> questions = ['name', 'quest', 'favorite color']
     >>> answers = ['lancelot', 'the holy grail', 'blue']
     >>> for q, a in zip(questions, answers):
     ...     print('What is your {0}?  It is {1}.'.format(q, a))
     ...
     What is your name?  It is lancelot.
     What is your quest?  It is the holy grail.
     What is your favorite color?  It is blue.

To loop over a sequence in reverse, first specify the sequence in a
forward direction and then call the *note reversed(): 18e. function.

     >>> for i in reversed(range(1, 10, 2)):
     ...     print(i)
     ...
     9
     7
     5
     3
     1

To loop over a sequence in sorted order, use the *note sorted(): 439.
function which returns a new sorted list while leaving the source
unaltered.

     >>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
     >>> for f in sorted(set(basket)):
     ...     print(f)
     ...
     apple
     banana
     orange
     pear

It is sometimes tempting to change a list while you are looping over it;
however, it is often simpler and safer to create a new list instead.

     >>> import math
     >>> raw_data = [56.2, float('NaN'), 51.7, 55.3, 52.5, float('NaN'), 47.8]
     >>> filtered_data = []
     >>> for value in raw_data:
     ...     if not math.isnan(value):
     ...         filtered_data.append(value)
     ...
     >>> filtered_data
     [56.2, 51.7, 55.3, 52.5, 47.8]


File: python.info,  Node: More on Conditions,  Next: Comparing Sequences and Other Types,  Prev: Looping Techniques,  Up: Data Structures

2.5.7 More on Conditions
------------------------

The conditions used in ‘while’ and ‘if’ statements can contain any
operators, not just comparisons.

The comparison operators ‘in’ and ‘not in’ check whether a value occurs
(does not occur) in a sequence.  The operators ‘is’ and ‘is not’ compare
whether two objects are really the same object; this only matters for
mutable objects like lists.  All comparison operators have the same
priority, which is lower than that of all numerical operators.

Comparisons can be chained.  For example, ‘a < b == c’ tests whether ‘a’
is less than ‘b’ and moreover ‘b’ equals ‘c’.

Comparisons may be combined using the Boolean operators ‘and’ and ‘or’,
and the outcome of a comparison (or of any other Boolean expression) may
be negated with ‘not’.  These have lower priorities than comparison
operators; between them, ‘not’ has the highest priority and ‘or’ the
lowest, so that ‘A and not B or C’ is equivalent to ‘(A and (not B)) or
C’.  As always, parentheses can be used to express the desired
composition.

The Boolean operators ‘and’ and ‘or’ are so-called `short-circuit'
operators: their arguments are evaluated from left to right, and
evaluation stops as soon as the outcome is determined.  For example, if
‘A’ and ‘C’ are true but ‘B’ is false, ‘A and B and C’ does not evaluate
the expression ‘C’.  When used as a general value and not as a Boolean,
the return value of a short-circuit operator is the last evaluated
argument.

It is possible to assign the result of a comparison or other Boolean
expression to a variable.  For example,

     >>> string1, string2, string3 = '', 'Trondheim', 'Hammer Dance'
     >>> non_null = string1 or string2 or string3
     >>> non_null
     'Trondheim'

Note that in Python, unlike C, assignment inside expressions must be
done explicitly with the walrus operator ‘:=’.  This avoids a common
class of problems encountered in C programs: typing ‘=’ in an expression
when ‘==’ was intended.


File: python.info,  Node: Comparing Sequences and Other Types,  Prev: More on Conditions,  Up: Data Structures

2.5.8 Comparing Sequences and Other Types
-----------------------------------------

Sequence objects typically may be compared to other objects with the
same sequence type.  The comparison uses `lexicographical' ordering:
first the first two items are compared, and if they differ this
determines the outcome of the comparison; if they are equal, the next
two items are compared, and so on, until either sequence is exhausted.
If two items to be compared are themselves sequences of the same type,
the lexicographical comparison is carried out recursively.  If all items
of two sequences compare equal, the sequences are considered equal.  If
one sequence is an initial sub-sequence of the other, the shorter
sequence is the smaller (lesser) one.  Lexicographical ordering for
strings uses the Unicode code point number to order individual
characters.  Some examples of comparisons between sequences of the same
type:

     (1, 2, 3)              < (1, 2, 4)
     [1, 2, 3]              < [1, 2, 4]
     'ABC' < 'C' < 'Pascal' < 'Python'
     (1, 2, 3, 4)           < (1, 2, 4)
     (1, 2)                 < (1, 2, -1)
     (1, 2, 3)             == (1.0, 2.0, 3.0)
     (1, 2, ('aa', 'ab'))   < (1, 2, ('abc', 'a'), 4)

Note that comparing objects of different types with ‘<’ or ‘>’ is legal
provided that the objects have appropriate comparison methods.  For
example, mixed numeric types are compared according to their numeric
value, so 0 equals 0.0, etc.  Otherwise, rather than providing an
arbitrary ordering, the interpreter will raise a *note TypeError: 192.
exception.


File: python.info,  Node: Modules,  Next: Input and Output,  Prev: Data Structures,  Up: The Python Tutorial

2.6 Modules
===========

If you quit from the Python interpreter and enter it again, the
definitions you have made (functions and variables) are lost.
Therefore, if you want to write a somewhat longer program, you are
better off using a text editor to prepare the input for the interpreter
and running it with that file as input instead.  This is known as
creating a `script'.  As your program gets longer, you may want to split
it into several files for easier maintenance.  You may also want to use
a handy function that you’ve written in several programs without copying
its definition into each program.

To support this, Python has a way to put definitions in a file and use
them in a script or in an interactive instance of the interpreter.  Such
a file is called a `module'; definitions from a module can be `imported'
into other modules or into the `main' module (the collection of
variables that you have access to in a script executed at the top level
and in calculator mode).

A module is a file containing Python definitions and statements.  The
file name is the module name with the suffix ‘.py’ appended.  Within a
module, the module’s name (as a string) is available as the value of the
global variable ‘__name__’.  For instance, use your favorite text editor
to create a file called ‘fibo.py’ in the current directory with the
following contents:

     # Fibonacci numbers module

     def fib(n):    # write Fibonacci series up to n
         a, b = 0, 1
         while a < n:
             print(a, end=' ')
             a, b = b, a+b
         print()

     def fib2(n):   # return Fibonacci series up to n
         result = []
         a, b = 0, 1
         while a < n:
             result.append(a)
             a, b = b, a+b
         return result

Now enter the Python interpreter and import this module with the
following command:

     >>> import fibo

This does not enter the names of the functions defined in ‘fibo’
directly in the current symbol table; it only enters the module name
‘fibo’ there.  Using the module name you can access the functions:

     >>> fibo.fib(1000)
     0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987
     >>> fibo.fib2(100)
     [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
     >>> fibo.__name__
     'fibo'

If you intend to use a function often you can assign it to a local name:

     >>> fib = fibo.fib
     >>> fib(500)
     0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

* Menu:

* More on Modules::
* Standard Modules::
* The dir() Function: The dir Function.
* Packages::


File: python.info,  Node: More on Modules,  Next: Standard Modules,  Up: Modules

2.6.1 More on Modules
---------------------

A module can contain executable statements as well as function
definitions.  These statements are intended to initialize the module.
They are executed only the `first' time the module name is encountered
in an import statement.  (1) (They are also run if the file is executed
as a script.)

Each module has its own private symbol table, which is used as the
global symbol table by all functions defined in the module.  Thus, the
author of a module can use global variables in the module without
worrying about accidental clashes with a user’s global variables.  On
the other hand, if you know what you are doing you can touch a module’s
global variables with the same notation used to refer to its functions,
‘modname.itemname’.

Modules can import other modules.  It is customary but not required to
place all *note import: c10. statements at the beginning of a module (or
script, for that matter).  The imported module names are placed in the
importing module’s global symbol table.

There is a variant of the *note import: c10. statement that imports
names from a module directly into the importing module’s symbol table.
For example:

     >>> from fibo import fib, fib2
     >>> fib(500)
     0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

This does not introduce the module name from which the imports are taken
in the local symbol table (so in the example, ‘fibo’ is not defined).

There is even a variant to import all names that a module defines:

     >>> from fibo import *
     >>> fib(500)
     0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

This imports all names except those beginning with an underscore (‘_’).
In most cases Python programmers do not use this facility since it
introduces an unknown set of names into the interpreter, possibly hiding
some things you have already defined.

Note that in general the practice of importing ‘*’ from a module or
package is frowned upon, since it often causes poorly readable code.
However, it is okay to use it to save typing in interactive sessions.

If the module name is followed by ‘as’, then the name following ‘as’ is
bound directly to the imported module.

     >>> import fibo as fib
     >>> fib.fib(500)
     0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

This is effectively importing the module in the same way that ‘import
fibo’ will do, with the only difference of it being available as ‘fib’.

It can also be used when utilising *note from: c38. with similar
effects:

     >>> from fibo import fib as fibonacci
     >>> fibonacci(500)
     0 1 1 2 3 5 8 13 21 34 55 89 144 233 377

     Note: For efficiency reasons, each module is only imported once per
     interpreter session.  Therefore, if you change your modules, you
     must restart the interpreter – or, if it’s just one module you want
     to test interactively, use *note importlib.reload(): 38e, e.g.
     ‘import importlib; importlib.reload(modulename)’.

* Menu:

* Executing modules as scripts::
* The Module Search Path::
* “Compiled” Python files::

   ---------- Footnotes ----------

   (1) (1) In fact function definitions are also ‘statements’ that are
‘executed’; the execution of a module-level function definition enters
the function name in the module’s global symbol table.


File: python.info,  Node: Executing modules as scripts,  Next: The Module Search Path,  Up: More on Modules

2.6.1.1 Executing modules as scripts
....................................

When you run a Python module with

     python fibo.py <arguments>

the code in the module will be executed, just as if you imported it, but
with the ‘__name__’ set to ‘"__main__"’.  That means that by adding this
code at the end of your module:

     if __name__ == "__main__":
         import sys
         fib(int(sys.argv[1]))

you can make the file usable as a script as well as an importable
module, because the code that parses the command line only runs if the
module is executed as the “main” file:

     $ python fibo.py 50
     0 1 1 2 3 5 8 13 21 34

If the module is imported, the code is not run:

     >>> import fibo
     >>>

This is often used either to provide a convenient user interface to a
module, or for testing purposes (running the module as a script executes
a test suite).


File: python.info,  Node: The Module Search Path,  Next: “Compiled” Python files,  Prev: Executing modules as scripts,  Up: More on Modules

2.6.1.2 The Module Search Path
..............................

When a module named ‘spam’ is imported, the interpreter first searches
for a built-in module with that name.  If not found, it then searches
for a file named ‘spam.py’ in a list of directories given by the
variable *note sys.path: 47d.  *note sys.path: 47d. is initialized from
these locations:

   * The directory containing the input script (or the current directory
     when no file is specified).

   * *note PYTHONPATH: 947. (a list of directory names, with the same
     syntax as the shell variable ‘PATH’).

   * The installation-dependent default.

     Note: On file systems which support symlinks, the directory
     containing the input script is calculated after the symlink is
     followed.  In other words the directory containing the symlink is
     `not' added to the module search path.

After initialization, Python programs can modify *note sys.path: 47d.
The directory containing the script being run is placed at the beginning
of the search path, ahead of the standard library path.  This means that
scripts in that directory will be loaded instead of modules of the same
name in the library directory.  This is an error unless the replacement
is intended.  See section *note Standard Modules: 11bd. for more
information.


File: python.info,  Node: “Compiled” Python files,  Prev: The Module Search Path,  Up: More on Modules

2.6.1.3 “Compiled” Python files
...............................

To speed up loading modules, Python caches the compiled version of each
module in the ‘__pycache__’ directory under the name
‘module.`version'.pyc’, where the version encodes the format of the
compiled file; it generally contains the Python version number.  For
example, in CPython release 3.3 the compiled version of spam.py would be
cached as ‘__pycache__/spam.cpython-33.pyc’.  This naming convention
allows compiled modules from different releases and different versions
of Python to coexist.

Python checks the modification date of the source against the compiled
version to see if it’s out of date and needs to be recompiled.  This is
a completely automatic process.  Also, the compiled modules are
platform-independent, so the same library can be shared among systems
with different architectures.

Python does not check the cache in two circumstances.  First, it always
recompiles and does not store the result for the module that’s loaded
directly from the command line.  Second, it does not check the cache if
there is no source module.  To support a non-source (compiled only)
distribution, the compiled module must be in the source directory, and
there must not be a source module.

Some tips for experts:

   * You can use the *note -O: 67f. or *note -OO: 680. switches on the
     Python command to reduce the size of a compiled module.  The ‘-O’
     switch removes assert statements, the ‘-OO’ switch removes both
     assert statements and __doc__ strings.  Since some programs may
     rely on having these available, you should only use this option if
     you know what you’re doing.  “Optimized” modules have an ‘opt-’ tag
     and are usually smaller.  Future releases may change the effects of
     optimization.

   * A program doesn’t run any faster when it is read from a ‘.pyc’ file
     than when it is read from a ‘.py’ file; the only thing that’s
     faster about ‘.pyc’ files is the speed with which they are loaded.

   * The module *note compileall: 21. can create .pyc files for all
     modules in a directory.

   * There is more detail on this process, including a flow chart of the
     decisions, in PEP 3147(1).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: Standard Modules,  Next: The dir Function,  Prev: More on Modules,  Up: Modules

2.6.2 Standard Modules
----------------------

Python comes with a library of standard modules, described in a separate
document, the Python Library Reference (“Library Reference” hereafter).
Some modules are built into the interpreter; these provide access to
operations that are not part of the core of the language but are
nevertheless built in, either for efficiency or to provide access to
operating system primitives such as system calls.  The set of such
modules is a configuration option which also depends on the underlying
platform.  For example, the *note winreg: 12a. module is only provided
on Windows systems.  One particular module deserves some attention:
*note sys: fd, which is built into every Python interpreter.  The
variables ‘sys.ps1’ and ‘sys.ps2’ define the strings used as primary and
secondary prompts:

     >>> import sys
     >>> sys.ps1
     '>>> '
     >>> sys.ps2
     '... '
     >>> sys.ps1 = 'C> '
     C> print('Yuck!')
     Yuck!
     C>

These two variables are only defined if the interpreter is in
interactive mode.

The variable ‘sys.path’ is a list of strings that determines the
interpreter’s search path for modules.  It is initialized to a default
path taken from the environment variable *note PYTHONPATH: 947, or from
a built-in default if *note PYTHONPATH: 947. is not set.  You can modify
it using standard list operations:

     >>> import sys
     >>> sys.path.append('/ufs/guido/lib/python')


File: python.info,  Node: The dir Function,  Next: Packages,  Prev: Standard Modules,  Up: Modules

2.6.3 The ‘dir()’ Function
--------------------------

The built-in function *note dir(): d26. is used to find out which names
a module defines.  It returns a sorted list of strings:

     >>> import fibo, sys
     >>> dir(fibo)
     ['__name__', 'fib', 'fib2']
     >>> dir(sys)
     ['__displayhook__', '__doc__', '__excepthook__', '__loader__', '__name__',
      '__package__', '__stderr__', '__stdin__', '__stdout__',
      '_clear_type_cache', '_current_frames', '_debugmallocstats', '_getframe',
      '_home', '_mercurial', '_xoptions', 'abiflags', 'api_version', 'argv',
      'base_exec_prefix', 'base_prefix', 'builtin_module_names', 'byteorder',
      'call_tracing', 'callstats', 'copyright', 'displayhook',
      'dont_write_bytecode', 'exc_info', 'excepthook', 'exec_prefix',
      'executable', 'exit', 'flags', 'float_info', 'float_repr_style',
      'getcheckinterval', 'getdefaultencoding', 'getdlopenflags',
      'getfilesystemencoding', 'getobjects', 'getprofile', 'getrecursionlimit',
      'getrefcount', 'getsizeof', 'getswitchinterval', 'gettotalrefcount',
      'gettrace', 'hash_info', 'hexversion', 'implementation', 'int_info',
      'intern', 'maxsize', 'maxunicode', 'meta_path', 'modules', 'path',
      'path_hooks', 'path_importer_cache', 'platform', 'prefix', 'ps1',
      'setcheckinterval', 'setdlopenflags', 'setprofile', 'setrecursionlimit',
      'setswitchinterval', 'settrace', 'stderr', 'stdin', 'stdout',
      'thread_info', 'version', 'version_info', 'warnoptions']

Without arguments, *note dir(): d26. lists the names you have defined
currently:

     >>> a = [1, 2, 3, 4, 5]
     >>> import fibo
     >>> fib = fibo.fib
     >>> dir()
     ['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys']

Note that it lists all types of names: variables, modules, functions,
etc.

*note dir(): d26. does not list the names of built-in functions and
variables.  If you want a list of those, they are defined in the
standard module *note builtins: 13.:

     >>> import builtins
     >>> dir(builtins)
     ['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException',
      'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning',
      'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError',
      'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning',
      'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False',
      'FileExistsError', 'FileNotFoundError', 'FloatingPointError',
      'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError',
      'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError',
      'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError',
      'MemoryError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented',
      'NotImplementedError', 'OSError', 'OverflowError',
      'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError',
      'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning',
      'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError',
      'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError',
      'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError',
      'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning',
      'ValueError', 'Warning', 'ZeroDivisionError', '_', '__build_class__',
      '__debug__', '__doc__', '__import__', '__name__', '__package__', 'abs',
      'all', 'any', 'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable',
      'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits',
      'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit',
      'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr',
      'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass',
      'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview',
      'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property',
      'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice',
      'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars',
      'zip']


File: python.info,  Node: Packages,  Prev: The dir Function,  Up: Modules

2.6.4 Packages
--------------

Packages are a way of structuring Python’s module namespace by using
“dotted module names”.  For example, the module name ‘A.B’ designates a
submodule named ‘B’ in a package named ‘A’.  Just like the use of
modules saves the authors of different modules from having to worry
about each other’s global variable names, the use of dotted module names
saves the authors of multi-module packages like NumPy or Pillow from
having to worry about each other’s module names.

Suppose you want to design a collection of modules (a “package”) for the
uniform handling of sound files and sound data.  There are many
different sound file formats (usually recognized by their extension, for
example: ‘.wav’, ‘.aiff’, ‘.au’), so you may need to create and maintain
a growing collection of modules for the conversion between the various
file formats.  There are also many different operations you might want
to perform on sound data (such as mixing, adding echo, applying an
equalizer function, creating an artificial stereo effect), so in
addition you will be writing a never-ending stream of modules to perform
these operations.  Here’s a possible structure for your package
(expressed in terms of a hierarchical filesystem):

     sound/                          Top-level package
           __init__.py               Initialize the sound package
           formats/                  Subpackage for file format conversions
                   __init__.py
                   wavread.py
                   wavwrite.py
                   aiffread.py
                   aiffwrite.py
                   auread.py
                   auwrite.py
                   ...
           effects/                  Subpackage for sound effects
                   __init__.py
                   echo.py
                   surround.py
                   reverse.py
                   ...
           filters/                  Subpackage for filters
                   __init__.py
                   equalizer.py
                   vocoder.py
                   karaoke.py
                   ...

When importing the package, Python searches through the directories on
‘sys.path’ looking for the package subdirectory.

The ‘__init__.py’ files are required to make Python treat directories
containing the file as packages.  This prevents directories with a
common name, such as ‘string’, unintentionally hiding valid modules that
occur later on the module search path.  In the simplest case,
‘__init__.py’ can just be an empty file, but it can also execute
initialization code for the package or set the ‘__all__’ variable,
described later.

Users of the package can import individual modules from the package, for
example:

     import sound.effects.echo

This loads the submodule ‘sound.effects.echo’.  It must be referenced
with its full name.

     sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)

An alternative way of importing the submodule is:

     from sound.effects import echo

This also loads the submodule ‘echo’, and makes it available without its
package prefix, so it can be used as follows:

     echo.echofilter(input, output, delay=0.7, atten=4)

Yet another variation is to import the desired function or variable
directly:

     from sound.effects.echo import echofilter

Again, this loads the submodule ‘echo’, but this makes its function
‘echofilter()’ directly available:

     echofilter(input, output, delay=0.7, atten=4)

Note that when using ‘from package import item’, the item can be either
a submodule (or subpackage) of the package, or some other name defined
in the package, like a function, class or variable.  The ‘import’
statement first tests whether the item is defined in the package; if
not, it assumes it is a module and attempts to load it.  If it fails to
find it, an *note ImportError: 329. exception is raised.

Contrarily, when using syntax like ‘import item.subitem.subsubitem’,
each item except for the last must be a package; the last item can be a
module or a package but can’t be a class or function or variable defined
in the previous item.

* Menu:

* Importing * From a Package::
* Intra-package References::
* Packages in Multiple Directories::


File: python.info,  Node: Importing * From a Package,  Next: Intra-package References,  Up: Packages

2.6.4.1 Importing * From a Package
..................................

Now what happens when the user writes ‘from sound.effects import *’?
Ideally, one would hope that this somehow goes out to the filesystem,
finds which submodules are present in the package, and imports them all.
This could take a long time and importing sub-modules might have
unwanted side-effects that should only happen when the sub-module is
explicitly imported.

The only solution is for the package author to provide an explicit index
of the package.  The *note import: c10. statement uses the following
convention: if a package’s ‘__init__.py’ code defines a list named
‘__all__’, it is taken to be the list of module names that should be
imported when ‘from package import *’ is encountered.  It is up to the
package author to keep this list up-to-date when a new version of the
package is released.  Package authors may also decide not to support it,
if they don’t see a use for importing * from their package.  For
example, the file ‘sound/effects/__init__.py’ could contain the
following code:

     __all__ = ["echo", "surround", "reverse"]

This would mean that ‘from sound.effects import *’ would import the
three named submodules of the ‘sound’ package.

If ‘__all__’ is not defined, the statement ‘from sound.effects import *’
does `not' import all submodules from the package ‘sound.effects’ into
the current namespace; it only ensures that the package ‘sound.effects’
has been imported (possibly running any initialization code in
‘__init__.py’) and then imports whatever names are defined in the
package.  This includes any names defined (and submodules explicitly
loaded) by ‘__init__.py’.  It also includes any submodules of the
package that were explicitly loaded by previous *note import: c10.
statements.  Consider this code:

     import sound.effects.echo
     import sound.effects.surround
     from sound.effects import *

In this example, the ‘echo’ and ‘surround’ modules are imported in the
current namespace because they are defined in the ‘sound.effects’
package when the ‘from...import’ statement is executed.  (This also
works when ‘__all__’ is defined.)

Although certain modules are designed to export only names that follow
certain patterns when you use ‘import *’, it is still considered bad
practice in production code.

Remember, there is nothing wrong with using ‘from package import
specific_submodule’!  In fact, this is the recommended notation unless
the importing module needs to use submodules with the same name from
different packages.


File: python.info,  Node: Intra-package References,  Next: Packages in Multiple Directories,  Prev: Importing * From a Package,  Up: Packages

2.6.4.2 Intra-package References
................................

When packages are structured into subpackages (as with the ‘sound’
package in the example), you can use absolute imports to refer to
submodules of siblings packages.  For example, if the module
‘sound.filters.vocoder’ needs to use the ‘echo’ module in the
‘sound.effects’ package, it can use ‘from sound.effects import echo’.

You can also write relative imports, with the ‘from module import name’
form of import statement.  These imports use leading dots to indicate
the current and parent packages involved in the relative import.  From
the ‘surround’ module for example, you might use:

     from . import echo
     from .. import formats
     from ..filters import equalizer

Note that relative imports are based on the name of the current module.
Since the name of the main module is always ‘"__main__"’, modules
intended for use as the main module of a Python application must always
use absolute imports.


File: python.info,  Node: Packages in Multiple Directories,  Prev: Intra-package References,  Up: Packages

2.6.4.3 Packages in Multiple Directories
........................................

Packages support one more special attribute, *note __path__: 11c8.  This
is initialized to be a list containing the name of the directory holding
the package’s ‘__init__.py’ before the code in that file is executed.
This variable can be modified; doing so affects future searches for
modules and subpackages contained in the package.

While this feature is not often needed, it can be used to extend the set
of modules found in a package.


File: python.info,  Node: Input and Output,  Next: Errors and Exceptions,  Prev: Modules,  Up: The Python Tutorial

2.7 Input and Output
====================

There are several ways to present the output of a program; data can be
printed in a human-readable form, or written to a file for future use.
This chapter will discuss some of the possibilities.

* Menu:

* Fancier Output Formatting::
* Reading and Writing Files::


File: python.info,  Node: Fancier Output Formatting,  Next: Reading and Writing Files,  Up: Input and Output

2.7.1 Fancier Output Formatting
-------------------------------

So far we’ve encountered two ways of writing values: `expression
statements' and the *note print(): 87a. function.  (A third way is using
the ‘write()’ method of file objects; the standard output file can be
referenced as ‘sys.stdout’.  See the Library Reference for more
information on this.)

Often you’ll want more control over the formatting of your output than
simply printing space-separated values.  There are several ways to
format output.

   * To use *note formatted string literals: 11ce, begin a string with
     ‘f’ or ‘F’ before the opening quotation mark or triple quotation
     mark.  Inside this string, you can write a Python expression
     between ‘{’ and ‘}’ characters that can refer to variables or
     literal values.

          >>> year = 2016
          >>> event = 'Referendum'
          >>> f'Results of the {year} {event}'
          'Results of the 2016 Referendum'

   * The *note str.format(): 4cf. method of strings requires more manual
     effort.  You’ll still use ‘{’ and ‘}’ to mark where a variable will
     be substituted and can provide detailed formatting directives, but
     you’ll also need to provide the information to be formatted.

          >>> yes_votes = 42_572_654
          >>> no_votes = 43_132_495
          >>> percentage = yes_votes / (yes_votes + no_votes)
          >>> '{:-9} YES votes  {:2.2%}'.format(yes_votes, percentage)
          ' 42572654 YES votes  49.67%'

   * Finally, you can do all the string handling yourself by using
     string slicing and concatenation operations to create any layout
     you can imagine.  The string type has some methods that perform
     useful operations for padding strings to a given column width.

When you don’t need fancy output but just want a quick display of some
variables for debugging purposes, you can convert any value to a string
with the *note repr(): 7c0. or *note str(): 325. functions.

The *note str(): 325. function is meant to return representations of
values which are fairly human-readable, while *note repr(): 7c0. is
meant to generate representations which can be read by the interpreter
(or will force a *note SyntaxError: 44d. if there is no equivalent
syntax).  For objects which don’t have a particular representation for
human consumption, *note str(): 325. will return the same value as *note
repr(): 7c0.  Many values, such as numbers or structures like lists and
dictionaries, have the same representation using either function.
Strings, in particular, have two distinct representations.

Some examples:

     >>> s = 'Hello, world.'
     >>> str(s)
     'Hello, world.'
     >>> repr(s)
     "'Hello, world.'"
     >>> str(1/7)
     '0.14285714285714285'
     >>> x = 10 * 3.25
     >>> y = 200 * 200
     >>> s = 'The value of x is ' + repr(x) + ', and y is ' + repr(y) + '...'
     >>> print(s)
     The value of x is 32.5, and y is 40000...
     >>> # The repr() of a string adds string quotes and backslashes:
     ... hello = 'hello, world\n'
     >>> hellos = repr(hello)
     >>> print(hellos)
     'hello, world\n'
     >>> # The argument to repr() may be any Python object:
     ... repr((x, y, ('spam', 'eggs')))
     "(32.5, 40000, ('spam', 'eggs'))"

The *note string: f6. module contains a *note Template: 3e0. class that
offers yet another way to substitute values into strings, using
placeholders like ‘$x’ and replacing them with values from a dictionary,
but offers much less control of the formatting.

* Menu:

* Formatted String Literals::
* The String format() Method: The String format Method.
* Manual String Formatting::
* Old string formatting::


File: python.info,  Node: Formatted String Literals,  Next: The String format Method,  Up: Fancier Output Formatting

2.7.1.1 Formatted String Literals
.................................

*note Formatted string literals: 15c. (also called f-strings for short)
let you include the value of Python expressions inside a string by
prefixing the string with ‘f’ or ‘F’ and writing expressions as
‘{expression}’.

An optional format specifier can follow the expression.  This allows
greater control over how the value is formatted.  The following example
rounds pi to three places after the decimal:

     >>> import math
     >>> print(f'The value of pi is approximately {math.pi:.3f}.')
     The value of pi is approximately 3.142.

Passing an integer after the ‘':'’ will cause that field to be a minimum
number of characters wide.  This is useful for making columns line up.

     >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678}
     >>> for name, phone in table.items():
     ...     print(f'{name:10} ==> {phone:10d}')
     ...
     Sjoerd     ==>       4127
     Jack       ==>       4098
     Dcab       ==>       7678

Other modifiers can be used to convert the value before it is formatted.
‘'!a'’ applies *note ascii(): d3f, ‘'!s'’ applies *note str(): 325, and
‘'!r'’ applies *note repr(): 7c0.:

     >>> animals = 'eels'
     >>> print(f'My hovercraft is full of {animals}.')
     My hovercraft is full of eels.
     >>> print(f'My hovercraft is full of {animals!r}.')
     My hovercraft is full of 'eels'.

For a reference on these format specifications, see the reference guide
for the *note Format Specification Mini-Language: 4d3.


File: python.info,  Node: The String format Method,  Next: Manual String Formatting,  Prev: Formatted String Literals,  Up: Fancier Output Formatting

2.7.1.2 The String format() Method
..................................

Basic usage of the *note str.format(): 4cf. method looks like this:

     >>> print('We are the {} who say "{}!"'.format('knights', 'Ni'))
     We are the knights who say "Ni!"

The brackets and characters within them (called format fields) are
replaced with the objects passed into the *note str.format(): 4cf.
method.  A number in the brackets can be used to refer to the position
of the object passed into the *note str.format(): 4cf. method.

     >>> print('{0} and {1}'.format('spam', 'eggs'))
     spam and eggs
     >>> print('{1} and {0}'.format('spam', 'eggs'))
     eggs and spam

If keyword arguments are used in the *note str.format(): 4cf. method,
their values are referred to by using the name of the argument.

     >>> print('This {food} is {adjective}.'.format(
     ...       food='spam', adjective='absolutely horrible'))
     This spam is absolutely horrible.

Positional and keyword arguments can be arbitrarily combined:

     >>> print('The story of {0}, {1}, and {other}.'.format('Bill', 'Manfred',
                                                            other='Georg'))
     The story of Bill, Manfred, and Georg.

If you have a really long format string that you don’t want to split up,
it would be nice if you could reference the variables to be formatted by
name instead of by position.  This can be done by simply passing the
dict and using square brackets ‘'[]'’ to access the keys

     >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
     >>> print('Jack: {0[Jack]:d}; Sjoerd: {0[Sjoerd]:d}; '
     ...       'Dcab: {0[Dcab]:d}'.format(table))
     Jack: 4098; Sjoerd: 4127; Dcab: 8637678

This could also be done by passing the table as keyword arguments with
the ‘**’ notation.

     >>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
     >>> print('Jack: {Jack:d}; Sjoerd: {Sjoerd:d}; Dcab: {Dcab:d}'.format(**table))
     Jack: 4098; Sjoerd: 4127; Dcab: 8637678

This is particularly useful in combination with the built-in function
*note vars(): f6f, which returns a dictionary containing all local
variables.

As an example, the following lines produce a tidily-aligned set of
columns giving integers and their squares and cubes:

     >>> for x in range(1, 11):
     ...     print('{0:2d} {1:3d} {2:4d}'.format(x, x*x, x*x*x))
     ...
      1   1    1
      2   4    8
      3   9   27
      4  16   64
      5  25  125
      6  36  216
      7  49  343
      8  64  512
      9  81  729
     10 100 1000

For a complete overview of string formatting with *note str.format():
4cf, see *note Format String Syntax: d0d.


File: python.info,  Node: Manual String Formatting,  Next: Old string formatting,  Prev: The String format Method,  Up: Fancier Output Formatting

2.7.1.3 Manual String Formatting
................................

Here’s the same table of squares and cubes, formatted manually:

     >>> for x in range(1, 11):
     ...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
     ...     # Note use of 'end' on previous line
     ...     print(repr(x*x*x).rjust(4))
     ...
      1   1    1
      2   4    8
      3   9   27
      4  16   64
      5  25  125
      6  36  216
      7  49  343
      8  64  512
      9  81  729
     10 100 1000

(Note that the one space between each column was added by the way *note
print(): 87a. works: it always adds spaces between its arguments.)

The *note str.rjust(): 11d3. method of string objects right-justifies a
string in a field of a given width by padding it with spaces on the
left.  There are similar methods *note str.ljust(): 11d4. and *note
str.center(): 11d5.  These methods do not write anything, they just
return a new string.  If the input string is too long, they don’t
truncate it, but return it unchanged; this will mess up your column
lay-out but that’s usually better than the alternative, which would be
lying about a value.  (If you really want truncation you can always add
a slice operation, as in ‘x.ljust(n)[:n]’.)

There is another method, *note str.zfill(): 11d6, which pads a numeric
string on the left with zeros.  It understands about plus and minus
signs:

     >>> '12'.zfill(5)
     '00012'
     >>> '-3.14'.zfill(7)
     '-003.14'
     >>> '3.14159265359'.zfill(5)
     '3.14159265359'


File: python.info,  Node: Old string formatting,  Prev: Manual String Formatting,  Up: Fancier Output Formatting

2.7.1.4 Old string formatting
.............................

The ‘%’ operator can also be used for string formatting.  It interprets
the left argument much like a ‘sprintf()’-style format string to be
applied to the right argument, and returns the string resulting from
this formatting operation.  For example:

     >>> import math
     >>> print('The value of pi is approximately %5.3f.' % math.pi)
     The value of pi is approximately 3.142.

More information can be found in the *note printf-style String
Formatting: 115f. section.


File: python.info,  Node: Reading and Writing Files,  Prev: Fancier Output Formatting,  Up: Input and Output

2.7.2 Reading and Writing Files
-------------------------------

*note open(): 4e5. returns a *note file object: b35, and is most
commonly used with two arguments: ‘open(filename, mode)’.

     >>> f = open('workfile', 'w')

The first argument is a string containing the filename.  The second
argument is another string containing a few characters describing the
way in which the file will be used.  `mode' can be ‘'r'’ when the file
will only be read, ‘'w'’ for only writing (an existing file with the
same name will be erased), and ‘'a'’ opens the file for appending; any
data written to the file is automatically added to the end.  ‘'r+'’
opens the file for both reading and writing.  The `mode' argument is
optional; ‘'r'’ will be assumed if it’s omitted.

Normally, files are opened in `text mode', that means, you read and
write strings from and to the file, which are encoded in a specific
encoding.  If encoding is not specified, the default is platform
dependent (see *note open(): 4e5.).  ‘'b'’ appended to the mode opens
the file in `binary mode': now the data is read and written in the form
of bytes objects.  This mode should be used for all files that don’t
contain text.

In text mode, the default when reading is to convert platform-specific
line endings (‘\n’ on Unix, ‘\r\n’ on Windows) to just ‘\n’.  When
writing in text mode, the default is to convert occurrences of ‘\n’ back
to platform-specific line endings.  This behind-the-scenes modification
to file data is fine for text files, but will corrupt binary data like
that in ‘JPEG’ or ‘EXE’ files.  Be very careful to use binary mode when
reading and writing such files.

It is good practice to use the *note with: 6dd. keyword when dealing
with file objects.  The advantage is that the file is properly closed
after its suite finishes, even if an exception is raised at some point.
Using ‘with’ is also much shorter than writing equivalent *note try:
d65.-*note finally: 182. blocks:

     >>> with open('workfile') as f:
     ...     read_data = f.read()

     >>> # We can check that the file has been automatically closed.
     >>> f.closed
     True

If you’re not using the *note with: 6dd. keyword, then you should call
‘f.close()’ to close the file and immediately free up any system
resources used by it.  If you don’t explicitly close a file, Python’s
garbage collector will eventually destroy the object and close the open
file for you, but the file may stay open for a while.  Another risk is
that different Python implementations will do this clean-up at different
times.

After a file object is closed, either by a *note with: 6dd. statement or
by calling ‘f.close()’, attempts to use the file object will
automatically fail.

     >>> f.close()
     >>> f.read()
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     ValueError: I/O operation on closed file.

* Menu:

* Methods of File Objects::
* Saving structured data with json::


File: python.info,  Node: Methods of File Objects,  Next: Saving structured data with json,  Up: Reading and Writing Files

2.7.2.1 Methods of File Objects
...............................

The rest of the examples in this section will assume that a file object
called ‘f’ has already been created.

To read a file’s contents, call ‘f.read(size)’, which reads some
quantity of data and returns it as a string (in text mode) or bytes
object (in binary mode).  `size' is an optional numeric argument.  When
`size' is omitted or negative, the entire contents of the file will be
read and returned; it’s your problem if the file is twice as large as
your machine’s memory.  Otherwise, at most `size' characters (in text
mode) or `size' bytes (in binary mode) are read and returned.  If the
end of the file has been reached, ‘f.read()’ will return an empty string
(‘''’).

     >>> f.read()
     'This is the entire file.\n'
     >>> f.read()
     ''

‘f.readline()’ reads a single line from the file; a newline character
(‘\n’) is left at the end of the string, and is only omitted on the last
line of the file if the file doesn’t end in a newline.  This makes the
return value unambiguous; if ‘f.readline()’ returns an empty string, the
end of the file has been reached, while a blank line is represented by
‘'\n'’, a string containing only a single newline.

     >>> f.readline()
     'This is the first line of the file.\n'
     >>> f.readline()
     'Second line of the file\n'
     >>> f.readline()
     ''

For reading lines from a file, you can loop over the file object.  This
is memory efficient, fast, and leads to simple code:

     >>> for line in f:
     ...     print(line, end='')
     ...
     This is the first line of the file.
     Second line of the file

If you want to read all the lines of a file in a list you can also use
‘list(f)’ or ‘f.readlines()’.

‘f.write(string)’ writes the contents of `string' to the file, returning
the number of characters written.

     >>> f.write('This is a test\n')
     15

Other types of objects need to be converted – either to a string (in
text mode) or a bytes object (in binary mode) – before writing them:

     >>> value = ('the answer', 42)
     >>> s = str(value)  # convert the tuple to string
     >>> f.write(s)
     18

‘f.tell()’ returns an integer giving the file object’s current position
in the file represented as number of bytes from the beginning of the
file when in binary mode and an opaque number when in text mode.

To change the file object’s position, use ‘f.seek(offset, whence)’.  The
position is computed from adding `offset' to a reference point; the
reference point is selected by the `whence' argument.  A `whence' value
of 0 measures from the beginning of the file, 1 uses the current file
position, and 2 uses the end of the file as the reference point.
`whence' can be omitted and defaults to 0, using the beginning of the
file as the reference point.

     >>> f = open('workfile', 'rb+')
     >>> f.write(b'0123456789abcdef')
     16
     >>> f.seek(5)      # Go to the 6th byte in the file
     5
     >>> f.read(1)
     b'5'
     >>> f.seek(-3, 2)  # Go to the 3rd byte before the end
     13
     >>> f.read(1)
     b'd'

In text files (those opened without a ‘b’ in the mode string), only
seeks relative to the beginning of the file are allowed (the exception
being seeking to the very file end with ‘seek(0, 2)’) and the only valid
`offset' values are those returned from the ‘f.tell()’, or zero.  Any
other `offset' value produces undefined behaviour.

File objects have some additional methods, such as ‘isatty()’ and
‘truncate()’ which are less frequently used; consult the Library
Reference for a complete guide to file objects.


File: python.info,  Node: Saving structured data with json,  Prev: Methods of File Objects,  Up: Reading and Writing Files

2.7.2.2 Saving structured data with ‘json’
..........................................

Strings can easily be written to and read from a file.  Numbers take a
bit more effort, since the ‘read()’ method only returns strings, which
will have to be passed to a function like *note int(): 184, which takes
a string like ‘'123'’ and returns its numeric value 123.  When you want
to save more complex data types like nested lists and dictionaries,
parsing and serializing by hand becomes complicated.

Rather than having users constantly writing and debugging code to save
complicated data types to files, Python allows you to use the popular
data interchange format called JSON (JavaScript Object Notation)(1).
The standard module called *note json: a4. can take Python data
hierarchies, and convert them to string representations; this process is
called `serializing'.  Reconstructing the data from the string
representation is called `deserializing'.  Between serializing and
deserializing, the string representing the object may have been stored
in a file or data, or sent over a network connection to some distant
machine.

     Note: The JSON format is commonly used by modern applications to
     allow for data exchange.  Many programmers are already familiar
     with it, which makes it a good choice for interoperability.

If you have an object ‘x’, you can view its JSON string representation
with a simple line of code:

     >>> import json
     >>> json.dumps([1, 'simple', 'list'])
     '[1, "simple", "list"]'

Another variant of the *note dumps(): 5fa. function, called *note
dump(): 5f9, simply serializes the object to a *note text file: 11de.
So if ‘f’ is a *note text file: 11de. object opened for writing, we can
do this:

     json.dump(x, f)

To decode the object again, if ‘f’ is a *note text file: 11de. object
which has been opened for reading:

     x = json.load(f)

This simple serialization technique can handle lists and dictionaries,
but serializing arbitrary class instances in JSON requires a bit of
extra effort.  The reference for the *note json: a4. module contains an
explanation of this.

See also
........

*note pickle: ca. - the pickle module

Contrary to *note JSON: 11dd, `pickle' is a protocol which allows the
serialization of arbitrarily complex Python objects.  As such, it is
specific to Python and cannot be used to communicate with applications
written in other languages.  It is also insecure by default:
deserializing pickle data coming from an untrusted source can execute
arbitrary code, if the data was crafted by a skilled attacker.

   ---------- Footnotes ----------

   (1) http://json.org


File: python.info,  Node: Errors and Exceptions,  Next: Classes,  Prev: Input and Output,  Up: The Python Tutorial

2.8 Errors and Exceptions
=========================

Until now error messages haven’t been more than mentioned, but if you
have tried out the examples you have probably seen some.  There are (at
least) two distinguishable kinds of errors: `syntax errors' and
`exceptions'.

* Menu:

* Syntax Errors::
* Exceptions::
* Handling Exceptions::
* Raising Exceptions::
* User-defined Exceptions::
* Defining Clean-up Actions::
* Predefined Clean-up Actions::


File: python.info,  Node: Syntax Errors,  Next: Exceptions,  Up: Errors and Exceptions

2.8.1 Syntax Errors
-------------------

Syntax errors, also known as parsing errors, are perhaps the most common
kind of complaint you get while you are still learning Python:

     >>> while True print('Hello world')
       File "<stdin>", line 1
         while True print('Hello world')
                        ^
     SyntaxError: invalid syntax

The parser repeats the offending line and displays a little ‘arrow’
pointing at the earliest point in the line where the error was detected.
The error is caused by (or at least detected at) the token `preceding'
the arrow: in the example, the error is detected at the function *note
print(): 87a, since a colon (‘':'’) is missing before it.  File name and
line number are printed so you know where to look in case the input came
from a script.


File: python.info,  Node: Exceptions,  Next: Handling Exceptions,  Prev: Syntax Errors,  Up: Errors and Exceptions

2.8.2 Exceptions
----------------

Even if a statement or expression is syntactically correct, it may cause
an error when an attempt is made to execute it.  Errors detected during
execution are called `exceptions' and are not unconditionally fatal: you
will soon learn how to handle them in Python programs.  Most exceptions
are not handled by programs, however, and result in error messages as
shown here:

     >>> 10 * (1/0)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     ZeroDivisionError: division by zero
     >>> 4 + spam*3
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     NameError: name 'spam' is not defined
     >>> '2' + 2
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: Can't convert 'int' object to str implicitly

The last line of the error message indicates what happened.  Exceptions
come in different types, and the type is printed as part of the message:
the types in the example are *note ZeroDivisionError: 11e6, *note
NameError: d6e. and *note TypeError: 192.  The string printed as the
exception type is the name of the built-in exception that occurred.
This is true for all built-in exceptions, but need not be true for
user-defined exceptions (although it is a useful convention).  Standard
exception names are built-in identifiers (not reserved keywords).

The rest of the line provides detail based on the type of exception and
what caused it.

The preceding part of the error message shows the context where the
exception happened, in the form of a stack traceback.  In general it
contains a stack traceback listing source lines; however, it will not
display lines read from standard input.

*note Built-in Exceptions: 11e7. lists the built-in exceptions and their
meanings.


File: python.info,  Node: Handling Exceptions,  Next: Raising Exceptions,  Prev: Exceptions,  Up: Errors and Exceptions

2.8.3 Handling Exceptions
-------------------------

It is possible to write programs that handle selected exceptions.  Look
at the following example, which asks the user for input until a valid
integer has been entered, but allows the user to interrupt the program
(using ‘Control-C’ or whatever the operating system supports); note that
a user-generated interruption is signalled by raising the *note
KeyboardInterrupt: 197. exception.

     >>> while True:
     ...     try:
     ...         x = int(input("Please enter a number: "))
     ...         break
     ...     except ValueError:
     ...         print("Oops!  That was no valid number.  Try again...")
     ...

The *note try: d65. statement works as follows.

   * First, the `try clause' (the statement(s) between the *note try:
     d65. and *note except: b31. keywords) is executed.

   * If no exception occurs, the `except clause' is skipped and
     execution of the *note try: d65. statement is finished.

   * If an exception occurs during execution of the try clause, the rest
     of the clause is skipped.  Then if its type matches the exception
     named after the *note except: b31. keyword, the except clause is
     executed, and then execution continues after the *note try: d65.
     statement.

   * If an exception occurs which does not match the exception named in
     the except clause, it is passed on to outer *note try: d65.
     statements; if no handler is found, it is an `unhandled exception'
     and execution stops with a message as shown above.

A *note try: d65. statement may have more than one except clause, to
specify handlers for different exceptions.  At most one handler will be
executed.  Handlers only handle exceptions that occur in the
corresponding try clause, not in other handlers of the same ‘try’
statement.  An except clause may name multiple exceptions as a
parenthesized tuple, for example:

     ... except (RuntimeError, TypeError, NameError):
     ...     pass

A class in an *note except: b31. clause is compatible with an exception
if it is the same class or a base class thereof (but not the other way
around — an except clause listing a derived class is not compatible with
a base class).  For example, the following code will print B, C, D in
that order:

     class B(Exception):
         pass

     class C(B):
         pass

     class D(C):
         pass

     for cls in [B, C, D]:
         try:
             raise cls()
         except D:
             print("D")
         except C:
             print("C")
         except B:
             print("B")

Note that if the except clauses were reversed (with ‘except B’ first),
it would have printed B, B, B — the first matching except clause is
triggered.

The last except clause may omit the exception name(s), to serve as a
wildcard.  Use this with extreme caution, since it is easy to mask a
real programming error in this way!  It can also be used to print an
error message and then re-raise the exception (allowing a caller to
handle the exception as well):

     import sys

     try:
         f = open('myfile.txt')
         s = f.readline()
         i = int(s.strip())
     except OSError as err:
         print("OS error: {0}".format(err))
     except ValueError:
         print("Could not convert data to an integer.")
     except:
         print("Unexpected error:", sys.exc_info()[0])
         raise

The *note try: d65. … *note except: b31. statement has an optional `else
clause', which, when present, must follow all except clauses.  It is
useful for code that must be executed if the try clause does not raise
an exception.  For example:

     for arg in sys.argv[1:]:
         try:
             f = open(arg, 'r')
         except OSError:
             print('cannot open', arg)
         else:
             print(arg, 'has', len(f.readlines()), 'lines')
             f.close()

The use of the ‘else’ clause is better than adding additional code to
the *note try: d65. clause because it avoids accidentally catching an
exception that wasn’t raised by the code being protected by the ‘try’ …
‘except’ statement.

When an exception occurs, it may have an associated value, also known as
the exception’s `argument'.  The presence and type of the argument
depend on the exception type.

The except clause may specify a variable after the exception name.  The
variable is bound to an exception instance with the arguments stored in
‘instance.args’.  For convenience, the exception instance defines *note
__str__(): e2a. so the arguments can be printed directly without having
to reference ‘.args’.  One may also instantiate an exception first
before raising it and add any attributes to it as desired.

     >>> try:
     ...     raise Exception('spam', 'eggs')
     ... except Exception as inst:
     ...     print(type(inst))    # the exception instance
     ...     print(inst.args)     # arguments stored in .args
     ...     print(inst)          # __str__ allows args to be printed directly,
     ...                          # but may be overridden in exception subclasses
     ...     x, y = inst.args     # unpack args
     ...     print('x =', x)
     ...     print('y =', y)
     ...
     <class 'Exception'>
     ('spam', 'eggs')
     ('spam', 'eggs')
     x = spam
     y = eggs

If an exception has arguments, they are printed as the last part
(‘detail’) of the message for unhandled exceptions.

Exception handlers don’t just handle exceptions if they occur
immediately in the try clause, but also if they occur inside functions
that are called (even indirectly) in the try clause.  For example:

     >>> def this_fails():
     ...     x = 1/0
     ...
     >>> try:
     ...     this_fails()
     ... except ZeroDivisionError as err:
     ...     print('Handling run-time error:', err)
     ...
     Handling run-time error: division by zero


File: python.info,  Node: Raising Exceptions,  Next: User-defined Exceptions,  Prev: Handling Exceptions,  Up: Errors and Exceptions

2.8.4 Raising Exceptions
------------------------

The *note raise: c35. statement allows the programmer to force a
specified exception to occur.  For example:

     >>> raise NameError('HiThere')
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     NameError: HiThere

The sole argument to *note raise: c35. indicates the exception to be
raised.  This must be either an exception instance or an exception class
(a class that derives from *note Exception: 1a8.).  If an exception
class is passed, it will be implicitly instantiated by calling its
constructor with no arguments:

     raise ValueError  # shorthand for 'raise ValueError()'

If you need to determine whether an exception was raised but don’t
intend to handle it, a simpler form of the *note raise: c35. statement
allows you to re-raise the exception:

     >>> try:
     ...     raise NameError('HiThere')
     ... except NameError:
     ...     print('An exception flew by!')
     ...     raise
     ...
     An exception flew by!
     Traceback (most recent call last):
       File "<stdin>", line 2, in <module>
     NameError: HiThere


File: python.info,  Node: User-defined Exceptions,  Next: Defining Clean-up Actions,  Prev: Raising Exceptions,  Up: Errors and Exceptions

2.8.5 User-defined Exceptions
-----------------------------

Programs may name their own exceptions by creating a new exception class
(see *note Classes: 117f. for more about Python classes).  Exceptions
should typically be derived from the *note Exception: 1a8. class, either
directly or indirectly.

Exception classes can be defined which do anything any other class can
do, but are usually kept simple, often only offering a number of
attributes that allow information about the error to be extracted by
handlers for the exception.  When creating a module that can raise
several distinct errors, a common practice is to create a base class for
exceptions defined by that module, and subclass that to create specific
exception classes for different error conditions:

     class Error(Exception):
         """Base class for exceptions in this module."""
         pass

     class InputError(Error):
         """Exception raised for errors in the input.

         Attributes:
             expression -- input expression in which the error occurred
             message -- explanation of the error
         """

         def __init__(self, expression, message):
             self.expression = expression
             self.message = message

     class TransitionError(Error):
         """Raised when an operation attempts a state transition that's not
         allowed.

         Attributes:
             previous -- state at beginning of transition
             next -- attempted new state
             message -- explanation of why the specific transition is not allowed
         """

         def __init__(self, previous, next, message):
             self.previous = previous
             self.next = next
             self.message = message

Most exceptions are defined with names that end in “Error”, similar to
the naming of the standard exceptions.

Many standard modules define their own exceptions to report errors that
may occur in functions they define.  More information on classes is
presented in chapter *note Classes: 117f.


File: python.info,  Node: Defining Clean-up Actions,  Next: Predefined Clean-up Actions,  Prev: User-defined Exceptions,  Up: Errors and Exceptions

2.8.6 Defining Clean-up Actions
-------------------------------

The *note try: d65. statement has another optional clause which is
intended to define clean-up actions that must be executed under all
circumstances.  For example:

     >>> try:
     ...     raise KeyboardInterrupt
     ... finally:
     ...     print('Goodbye, world!')
     ...
     Goodbye, world!
     Traceback (most recent call last):
       File "<stdin>", line 2, in <module>
     KeyboardInterrupt

If a *note finally: 182. clause is present, the *note finally: 182.
clause will execute as the last task before the *note try: d65.
statement completes.  The *note finally: 182. clause runs whether or not
the *note try: d65. statement produces an exception.  The following
points discuss more complex cases when an exception occurs:

   * If an exception occurs during execution of the ‘try’ clause, the
     exception may be handled by an *note except: b31. clause.  If the
     exception is not handled by an *note except: b31. clause, the
     exception is re-raised after the ‘finally’ clause has been
     executed.

   * An exception could occur during execution of an ‘except’ or ‘else’
     clause.  Again, the exception is re-raised after the ‘finally’
     clause has been executed.

   * If the ‘try’ statement reaches a *note break: 2d9, *note continue:
     181. or *note return: 190. statement, the *note finally: 182.
     clause will execute just prior to the *note break: 2d9, *note
     continue: 181. or *note return: 190. statement’s execution.

   * If a *note finally: 182. clause includes a *note return: 190.
     statement, the *note finally: 182. clause’s *note return: 190.
     statement will execute before, and instead of, the *note return:
     190. statement in a *note try: d65. clause.

For example:

     >>> def bool_return():
     ...     try:
     ...         return True
     ...     finally:
     ...         return False
     ...
     >>> bool_return()
     False

A more complicated example:

     >>> def divide(x, y):
     ...     try:
     ...         result = x / y
     ...     except ZeroDivisionError:
     ...         print("division by zero!")
     ...     else:
     ...         print("result is", result)
     ...     finally:
     ...         print("executing finally clause")
     ...
     >>> divide(2, 1)
     result is 2.0
     executing finally clause
     >>> divide(2, 0)
     division by zero!
     executing finally clause
     >>> divide("2", "1")
     executing finally clause
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
       File "<stdin>", line 3, in divide
     TypeError: unsupported operand type(s) for /: 'str' and 'str'

As you can see, the *note finally: 182. clause is executed in any event.
The *note TypeError: 192. raised by dividing two strings is not handled
by the *note except: b31. clause and therefore re-raised after the
‘finally’ clause has been executed.

In real world applications, the *note finally: 182. clause is useful for
releasing external resources (such as files or network connections),
regardless of whether the use of the resource was successful.


File: python.info,  Node: Predefined Clean-up Actions,  Prev: Defining Clean-up Actions,  Up: Errors and Exceptions

2.8.7 Predefined Clean-up Actions
---------------------------------

Some objects define standard clean-up actions to be undertaken when the
object is no longer needed, regardless of whether or not the operation
using the object succeeded or failed.  Look at the following example,
which tries to open a file and print its contents to the screen.

     for line in open("myfile.txt"):
         print(line, end="")

The problem with this code is that it leaves the file open for an
indeterminate amount of time after this part of the code has finished
executing.  This is not an issue in simple scripts, but can be a problem
for larger applications.  The *note with: 6dd. statement allows objects
like files to be used in a way that ensures they are always cleaned up
promptly and correctly.

     with open("myfile.txt") as f:
         for line in f:
             print(line, end="")

After the statement is executed, the file `f' is always closed, even if
a problem was encountered while processing the lines.  Objects which,
like files, provide predefined clean-up actions will indicate this in
their documentation.


File: python.info,  Node: Classes,  Next: Brief Tour of the Standard Library,  Prev: Errors and Exceptions,  Up: The Python Tutorial

2.9 Classes
===========

Classes provide a means of bundling data and functionality together.
Creating a new class creates a new `type' of object, allowing new
`instances' of that type to be made.  Each class instance can have
attributes attached to it for maintaining its state.  Class instances
can also have methods (defined by its class) for modifying its state.

Compared with other programming languages, Python’s class mechanism adds
classes with a minimum of new syntax and semantics.  It is a mixture of
the class mechanisms found in C++ and Modula-3.  Python classes provide
all the standard features of Object Oriented Programming: the class
inheritance mechanism allows multiple base classes, a derived class can
override any methods of its base class or classes, and a method can call
the method of a base class with the same name.  Objects can contain
arbitrary amounts and kinds of data.  As is true for modules, classes
partake of the dynamic nature of Python: they are created at runtime,
and can be modified further after creation.

In C++ terminology, normally class members (including the data members)
are `public' (except see below *note Private Variables: 11f3.), and all
member functions are `virtual'.  As in Modula-3, there are no shorthands
for referencing the object’s members from its methods: the method
function is declared with an explicit first argument representing the
object, which is provided implicitly by the call.  As in Smalltalk,
classes themselves are objects.  This provides semantics for importing
and renaming.  Unlike C++ and Modula-3, built-in types can be used as
base classes for extension by the user.  Also, like in C++, most
built-in operators with special syntax (arithmetic operators,
subscripting etc.)  can be redefined for class instances.

(Lacking universally accepted terminology to talk about classes, I will
make occasional use of Smalltalk and C++ terms.  I would use Modula-3
terms, since its object-oriented semantics are closer to those of Python
than C++, but I expect that few readers have heard of it.)

* Menu:

* A Word About Names and Objects::
* Python Scopes and Namespaces::
* A First Look at Classes::
* Random Remarks::
* Inheritance::
* Private Variables::
* Odds and Ends::
* Iterators::
* Generators::
* Generator Expressions::


File: python.info,  Node: A Word About Names and Objects,  Next: Python Scopes and Namespaces,  Up: Classes

2.9.1 A Word About Names and Objects
------------------------------------

Objects have individuality, and multiple names (in multiple scopes) can
be bound to the same object.  This is known as aliasing in other
languages.  This is usually not appreciated on a first glance at Python,
and can be safely ignored when dealing with immutable basic types
(numbers, strings, tuples).  However, aliasing has a possibly surprising
effect on the semantics of Python code involving mutable objects such as
lists, dictionaries, and most other types.  This is usually used to the
benefit of the program, since aliases behave like pointers in some
respects.  For example, passing an object is cheap since only a pointer
is passed by the implementation; and if a function modifies an object
passed as an argument, the caller will see the change — this eliminates
the need for two different argument passing mechanisms as in Pascal.


File: python.info,  Node: Python Scopes and Namespaces,  Next: A First Look at Classes,  Prev: A Word About Names and Objects,  Up: Classes

2.9.2 Python Scopes and Namespaces
----------------------------------

Before introducing classes, I first have to tell you something about
Python’s scope rules.  Class definitions play some neat tricks with
namespaces, and you need to know how scopes and namespaces work to fully
understand what’s going on.  Incidentally, knowledge about this subject
is useful for any advanced Python programmer.

Let’s begin with some definitions.

A `namespace' is a mapping from names to objects.  Most namespaces are
currently implemented as Python dictionaries, but that’s normally not
noticeable in any way (except for performance), and it may change in the
future.  Examples of namespaces are: the set of built-in names
(containing functions such as *note abs(): 11f8, and built-in exception
names); the global names in a module; and the local names in a function
invocation.  In a sense the set of attributes of an object also form a
namespace.  The important thing to know about namespaces is that there
is absolutely no relation between names in different namespaces; for
instance, two different modules may both define a function ‘maximize’
without confusion — users of the modules must prefix it with the module
name.

By the way, I use the word `attribute' for any name following a dot —
for example, in the expression ‘z.real’, ‘real’ is an attribute of the
object ‘z’.  Strictly speaking, references to names in modules are
attribute references: in the expression ‘modname.funcname’, ‘modname’ is
a module object and ‘funcname’ is an attribute of it.  In this case
there happens to be a straightforward mapping between the module’s
attributes and the global names defined in the module: they share the
same namespace!  (1)

Attributes may be read-only or writable.  In the latter case, assignment
to attributes is possible.  Module attributes are writable: you can
write ‘modname.the_answer = 42’.  Writable attributes may also be
deleted with the *note del: 11a8. statement.  For example, ‘del
modname.the_answer’ will remove the attribute ‘the_answer’ from the
object named by ‘modname’.

Namespaces are created at different moments and have different
lifetimes.  The namespace containing the built-in names is created when
the Python interpreter starts up, and is never deleted.  The global
namespace for a module is created when the module definition is read in;
normally, module namespaces also last until the interpreter quits.  The
statements executed by the top-level invocation of the interpreter,
either read from a script file or interactively, are considered part of
a module called *note __main__: 1, so they have their own global
namespace.  (The built-in names actually also live in a module; this is
called *note builtins: 13.)

The local namespace for a function is created when the function is
called, and deleted when the function returns or raises an exception
that is not handled within the function.  (Actually, forgetting would be
a better way to describe what actually happens.)  Of course, recursive
invocations each have their own local namespace.

A `scope' is a textual region of a Python program where a namespace is
directly accessible.  “Directly accessible” here means that an
unqualified reference to a name attempts to find the name in the
namespace.

Although scopes are determined statically, they are used dynamically.
At any time during execution, there are at least three nested scopes
whose namespaces are directly accessible:

   * the innermost scope, which is searched first, contains the local
     names

   * the scopes of any enclosing functions, which are searched starting
     with the nearest enclosing scope, contains non-local, but also
     non-global names

   * the next-to-last scope contains the current module’s global names

   * the outermost scope (searched last) is the namespace containing
     built-in names

If a name is declared global, then all references and assignments go
directly to the middle scope containing the module’s global names.  To
rebind variables found outside of the innermost scope, the *note
nonlocal: c32. statement can be used; if not declared nonlocal, those
variables are read-only (an attempt to write to such a variable will
simply create a `new' local variable in the innermost scope, leaving the
identically named outer variable unchanged).

Usually, the local scope references the local names of the (textually)
current function.  Outside functions, the local scope references the
same namespace as the global scope: the module’s namespace.  Class
definitions place yet another namespace in the local scope.

It is important to realize that scopes are determined textually: the
global scope of a function defined in a module is that module’s
namespace, no matter from where or by what alias the function is called.
On the other hand, the actual search for names is done dynamically, at
run time — however, the language definition is evolving towards static
name resolution, at “compile” time, so don’t rely on dynamic name
resolution!  (In fact, local variables are already determined
statically.)

A special quirk of Python is that – if no *note global: 117e. statement
is in effect – assignments to names always go into the innermost scope.
Assignments do not copy data — they just bind names to objects.  The
same is true for deletions: the statement ‘del x’ removes the binding of
‘x’ from the namespace referenced by the local scope.  In fact, all
operations that introduce new names use the local scope: in particular,
*note import: c10. statements and function definitions bind the module
or function name in the local scope.

The *note global: 117e. statement can be used to indicate that
particular variables live in the global scope and should be rebound
there; the *note nonlocal: c32. statement indicates that particular
variables live in an enclosing scope and should be rebound there.

* Menu:

* Scopes and Namespaces Example::

   ---------- Footnotes ----------

   (1) (1) Except for one thing.  Module objects have a secret read-only
attribute called *note __dict__: 4f1. which returns the dictionary used
to implement the module’s namespace; the name *note __dict__: 4f1. is an
attribute but not a global name.  Obviously, using this violates the
abstraction of namespace implementation, and should be restricted to
things like post-mortem debuggers.


File: python.info,  Node: Scopes and Namespaces Example,  Up: Python Scopes and Namespaces

2.9.2.1 Scopes and Namespaces Example
.....................................

This is an example demonstrating how to reference the different scopes
and namespaces, and how *note global: 117e. and *note nonlocal: c32.
affect variable binding:

     def scope_test():
         def do_local():
             spam = "local spam"

         def do_nonlocal():
             nonlocal spam
             spam = "nonlocal spam"

         def do_global():
             global spam
             spam = "global spam"

         spam = "test spam"
         do_local()
         print("After local assignment:", spam)
         do_nonlocal()
         print("After nonlocal assignment:", spam)
         do_global()
         print("After global assignment:", spam)

     scope_test()
     print("In global scope:", spam)

The output of the example code is:

     After local assignment: test spam
     After nonlocal assignment: nonlocal spam
     After global assignment: nonlocal spam
     In global scope: global spam

Note how the `local' assignment (which is default) didn’t change
`scope_test'’s binding of `spam'.  The *note nonlocal: c32. assignment
changed `scope_test'’s binding of `spam', and the *note global: 117e.
assignment changed the module-level binding.

You can also see that there was no previous binding for `spam' before
the *note global: 117e. assignment.


File: python.info,  Node: A First Look at Classes,  Next: Random Remarks,  Prev: Python Scopes and Namespaces,  Up: Classes

2.9.3 A First Look at Classes
-----------------------------

Classes introduce a little bit of new syntax, three new object types,
and some new semantics.

* Menu:

* Class Definition Syntax::
* Class Objects::
* Instance Objects::
* Method Objects::
* Class and Instance Variables::


File: python.info,  Node: Class Definition Syntax,  Next: Class Objects,  Up: A First Look at Classes

2.9.3.1 Class Definition Syntax
...............................

The simplest form of class definition looks like this:

     class ClassName:
         <statement-1>
         .
         .
         .
         <statement-N>

Class definitions, like function definitions (*note def: db1.
statements) must be executed before they have any effect.  (You could
conceivably place a class definition in a branch of an *note if: dda.
statement, or inside a function.)

In practice, the statements inside a class definition will usually be
function definitions, but other statements are allowed, and sometimes
useful — we’ll come back to this later.  The function definitions inside
a class normally have a peculiar form of argument list, dictated by the
calling conventions for methods — again, this is explained later.

When a class definition is entered, a new namespace is created, and used
as the local scope — thus, all assignments to local variables go into
this new namespace.  In particular, function definitions bind the name
of the new function here.

When a class definition is left normally (via the end), a `class object'
is created.  This is basically a wrapper around the contents of the
namespace created by the class definition; we’ll learn more about class
objects in the next section.  The original local scope (the one in
effect just before the class definition was entered) is reinstated, and
the class object is bound here to the class name given in the class
definition header (‘ClassName’ in the example).


File: python.info,  Node: Class Objects,  Next: Instance Objects,  Prev: Class Definition Syntax,  Up: A First Look at Classes

2.9.3.2 Class Objects
.....................

Class objects support two kinds of operations: attribute references and
instantiation.

`Attribute references' use the standard syntax used for all attribute
references in Python: ‘obj.name’.  Valid attribute names are all the
names that were in the class’s namespace when the class object was
created.  So, if the class definition looked like this:

     class MyClass:
         """A simple example class"""
         i = 12345

         def f(self):
             return 'hello world'

then ‘MyClass.i’ and ‘MyClass.f’ are valid attribute references,
returning an integer and a function object, respectively.  Class
attributes can also be assigned to, so you can change the value of
‘MyClass.i’ by assignment.  ‘__doc__’ is also a valid attribute,
returning the docstring belonging to the class: ‘"A simple example
class"’.

Class `instantiation' uses function notation.  Just pretend that the
class object is a parameterless function that returns a new instance of
the class.  For example (assuming the above class):

     x = MyClass()

creates a new `instance' of the class and assigns this object to the
local variable ‘x’.

The instantiation operation (“calling” a class object) creates an empty
object.  Many classes like to create objects with instances customized
to a specific initial state.  Therefore a class may define a special
method named *note __init__(): d51, like this:

     def __init__(self):
         self.data = []

When a class defines an *note __init__(): d51. method, class
instantiation automatically invokes *note __init__(): d51. for the
newly-created class instance.  So in this example, a new, initialized
instance can be obtained by:

     x = MyClass()

Of course, the *note __init__(): d51. method may have arguments for
greater flexibility.  In that case, arguments given to the class
instantiation operator are passed on to *note __init__(): d51.  For
example,

     >>> class Complex:
     ...     def __init__(self, realpart, imagpart):
     ...         self.r = realpart
     ...         self.i = imagpart
     ...
     >>> x = Complex(3.0, -4.5)
     >>> x.r, x.i
     (3.0, -4.5)


File: python.info,  Node: Instance Objects,  Next: Method Objects,  Prev: Class Objects,  Up: A First Look at Classes

2.9.3.3 Instance Objects
........................

Now what can we do with instance objects?  The only operations
understood by instance objects are attribute references.  There are two
kinds of valid attribute names, data attributes and methods.

`data attributes' correspond to “instance variables” in Smalltalk, and
to “data members” in C++.  Data attributes need not be declared; like
local variables, they spring into existence when they are first assigned
to.  For example, if ‘x’ is the instance of ‘MyClass’ created above, the
following piece of code will print the value ‘16’, without leaving a
trace:

     x.counter = 1
     while x.counter < 10:
         x.counter = x.counter * 2
     print(x.counter)
     del x.counter

The other kind of instance attribute reference is a `method'.  A method
is a function that “belongs to” an object.  (In Python, the term method
is not unique to class instances: other object types can have methods as
well.  For example, list objects have methods called append, insert,
remove, sort, and so on.  However, in the following discussion, we’ll
use the term method exclusively to mean methods of class instance
objects, unless explicitly stated otherwise.)

Valid method names of an instance object depend on its class.  By
definition, all attributes of a class that are function objects define
corresponding methods of its instances.  So in our example, ‘x.f’ is a
valid method reference, since ‘MyClass.f’ is a function, but ‘x.i’ is
not, since ‘MyClass.i’ is not.  But ‘x.f’ is not the same thing as
‘MyClass.f’ — it is a `method object', not a function object.


File: python.info,  Node: Method Objects,  Next: Class and Instance Variables,  Prev: Instance Objects,  Up: A First Look at Classes

2.9.3.4 Method Objects
......................

Usually, a method is called right after it is bound:

     x.f()

In the ‘MyClass’ example, this will return the string ‘'hello world'’.
However, it is not necessary to call a method right away: ‘x.f’ is a
method object, and can be stored away and called at a later time.  For
example:

     xf = x.f
     while True:
         print(xf())

will continue to print ‘hello world’ until the end of time.

What exactly happens when a method is called?  You may have noticed that
‘x.f()’ was called without an argument above, even though the function
definition for ‘f()’ specified an argument.  What happened to the
argument?  Surely Python raises an exception when a function that
requires an argument is called without any — even if the argument isn’t
actually used…

Actually, you may have guessed the answer: the special thing about
methods is that the instance object is passed as the first argument of
the function.  In our example, the call ‘x.f()’ is exactly equivalent to
‘MyClass.f(x)’.  In general, calling a method with a list of `n'
arguments is equivalent to calling the corresponding function with an
argument list that is created by inserting the method’s instance object
before the first argument.

If you still don’t understand how methods work, a look at the
implementation can perhaps clarify matters.  When a non-data attribute
of an instance is referenced, the instance’s class is searched.  If the
name denotes a valid class attribute that is a function object, a method
object is created by packing (pointers to) the instance object and the
function object just found together in an abstract object: this is the
method object.  When the method object is called with an argument list,
a new argument list is constructed from the instance object and the
argument list, and the function object is called with this new argument
list.


File: python.info,  Node: Class and Instance Variables,  Prev: Method Objects,  Up: A First Look at Classes

2.9.3.5 Class and Instance Variables
....................................

Generally speaking, instance variables are for data unique to each
instance and class variables are for attributes and methods shared by
all instances of the class:

     class Dog:

         kind = 'canine'         # class variable shared by all instances

         def __init__(self, name):
             self.name = name    # instance variable unique to each instance

     >>> d = Dog('Fido')
     >>> e = Dog('Buddy')
     >>> d.kind                  # shared by all dogs
     'canine'
     >>> e.kind                  # shared by all dogs
     'canine'
     >>> d.name                  # unique to d
     'Fido'
     >>> e.name                  # unique to e
     'Buddy'

As discussed in *note A Word About Names and Objects: 11f5, shared data
can have possibly surprising effects with involving *note mutable: 1164.
objects such as lists and dictionaries.  For example, the `tricks' list
in the following code should not be used as a class variable because
just a single list would be shared by all `Dog' instances:

     class Dog:

         tricks = []             # mistaken use of a class variable

         def __init__(self, name):
             self.name = name

         def add_trick(self, trick):
             self.tricks.append(trick)

     >>> d = Dog('Fido')
     >>> e = Dog('Buddy')
     >>> d.add_trick('roll over')
     >>> e.add_trick('play dead')
     >>> d.tricks                # unexpectedly shared by all dogs
     ['roll over', 'play dead']

Correct design of the class should use an instance variable instead:

     class Dog:

         def __init__(self, name):
             self.name = name
             self.tricks = []    # creates a new empty list for each dog

         def add_trick(self, trick):
             self.tricks.append(trick)

     >>> d = Dog('Fido')
     >>> e = Dog('Buddy')
     >>> d.add_trick('roll over')
     >>> e.add_trick('play dead')
     >>> d.tricks
     ['roll over']
     >>> e.tricks
     ['play dead']


File: python.info,  Node: Random Remarks,  Next: Inheritance,  Prev: A First Look at Classes,  Up: Classes

2.9.4 Random Remarks
--------------------

If the same attribute name occurs in both an instance and in a class,
then attribute lookup prioritizes the instance:

     >>> class Warehouse:
             purpose = 'storage'
             region = 'west'

     >>> w1 = Warehouse()
     >>> print(w1.purpose, w1.region)
     storage west
     >>> w2 = Warehouse()
     >>> w2.region = 'east'
     >>> print(w2.purpose, w2.region)
     storage east

Data attributes may be referenced by methods as well as by ordinary
users (“clients”) of an object.  In other words, classes are not usable
to implement pure abstract data types.  In fact, nothing in Python makes
it possible to enforce data hiding — it is all based upon convention.
(On the other hand, the Python implementation, written in C, can
completely hide implementation details and control access to an object
if necessary; this can be used by extensions to Python written in C.)

Clients should use data attributes with care — clients may mess up
invariants maintained by the methods by stamping on their data
attributes.  Note that clients may add data attributes of their own to
an instance object without affecting the validity of the methods, as
long as name conflicts are avoided — again, a naming convention can save
a lot of headaches here.

There is no shorthand for referencing data attributes (or other
methods!)  from within methods.  I find that this actually increases the
readability of methods: there is no chance of confusing local variables
and instance variables when glancing through a method.

Often, the first argument of a method is called ‘self’.  This is nothing
more than a convention: the name ‘self’ has absolutely no special
meaning to Python.  Note, however, that by not following the convention
your code may be less readable to other Python programmers, and it is
also conceivable that a `class browser' program might be written that
relies upon such a convention.

Any function object that is a class attribute defines a method for
instances of that class.  It is not necessary that the function
definition is textually enclosed in the class definition: assigning a
function object to a local variable in the class is also ok.  For
example:

     # Function defined outside the class
     def f1(self, x, y):
         return min(x, x+y)

     class C:
         f = f1

         def g(self):
             return 'hello world'

         h = g

Now ‘f’, ‘g’ and ‘h’ are all attributes of class ‘C’ that refer to
function objects, and consequently they are all methods of instances of
‘C’ — ‘h’ being exactly equivalent to ‘g’.  Note that this practice
usually only serves to confuse the reader of a program.

Methods may call other methods by using method attributes of the ‘self’
argument:

     class Bag:
         def __init__(self):
             self.data = []

         def add(self, x):
             self.data.append(x)

         def addtwice(self, x):
             self.add(x)
             self.add(x)

Methods may reference global names in the same way as ordinary
functions.  The global scope associated with a method is the module
containing its definition.  (A class is never used as a global scope.)
While one rarely encounters a good reason for using global data in a
method, there are many legitimate uses of the global scope: for one
thing, functions and modules imported into the global scope can be used
by methods, as well as functions and classes defined in it.  Usually,
the class containing the method is itself defined in this global scope,
and in the next section we’ll find some good reasons why a method would
want to reference its own class.

Each value is an object, and therefore has a `class' (also called its
`type').  It is stored as ‘object.__class__’.


File: python.info,  Node: Inheritance,  Next: Private Variables,  Prev: Random Remarks,  Up: Classes

2.9.5 Inheritance
-----------------

Of course, a language feature would not be worthy of the name “class”
without supporting inheritance.  The syntax for a derived class
definition looks like this:

     class DerivedClassName(BaseClassName):
         <statement-1>
         .
         .
         .
         <statement-N>

The name ‘BaseClassName’ must be defined in a scope containing the
derived class definition.  In place of a base class name, other
arbitrary expressions are also allowed.  This can be useful, for
example, when the base class is defined in another module:

     class DerivedClassName(modname.BaseClassName):

Execution of a derived class definition proceeds the same as for a base
class.  When the class object is constructed, the base class is
remembered.  This is used for resolving attribute references: if a
requested attribute is not found in the class, the search proceeds to
look in the base class.  This rule is applied recursively if the base
class itself is derived from some other class.

There’s nothing special about instantiation of derived classes:
‘DerivedClassName()’ creates a new instance of the class.  Method
references are resolved as follows: the corresponding class attribute is
searched, descending down the chain of base classes if necessary, and
the method reference is valid if this yields a function object.

Derived classes may override methods of their base classes.  Because
methods have no special privileges when calling other methods of the
same object, a method of a base class that calls another method defined
in the same base class may end up calling a method of a derived class
that overrides it.  (For C++ programmers: all methods in Python are
effectively ‘virtual’.)

An overriding method in a derived class may in fact want to extend
rather than simply replace the base class method of the same name.
There is a simple way to call the base class method directly: just call
‘BaseClassName.methodname(self, arguments)’.  This is occasionally
useful to clients as well.  (Note that this only works if the base class
is accessible as ‘BaseClassName’ in the global scope.)

Python has two built-in functions that work with inheritance:

   * Use *note isinstance(): 444. to check an instance’s type:
     ‘isinstance(obj, int)’ will be ‘True’ only if ‘obj.__class__’ is
     *note int: 184. or some class derived from *note int: 184.

   * Use *note issubclass(): 445. to check class inheritance:
     ‘issubclass(bool, int)’ is ‘True’ since *note bool: 183. is a
     subclass of *note int: 184.  However, ‘issubclass(float, int)’ is
     ‘False’ since *note float: 187. is not a subclass of *note int:
     184.

* Menu:

* Multiple Inheritance::


File: python.info,  Node: Multiple Inheritance,  Up: Inheritance

2.9.5.1 Multiple Inheritance
............................

Python supports a form of multiple inheritance as well.  A class
definition with multiple base classes looks like this:

     class DerivedClassName(Base1, Base2, Base3):
         <statement-1>
         .
         .
         .
         <statement-N>

For most purposes, in the simplest cases, you can think of the search
for attributes inherited from a parent class as depth-first,
left-to-right, not searching twice in the same class where there is an
overlap in the hierarchy.  Thus, if an attribute is not found in
‘DerivedClassName’, it is searched for in ‘Base1’, then (recursively) in
the base classes of ‘Base1’, and if it was not found there, it was
searched for in ‘Base2’, and so on.

In fact, it is slightly more complex than that; the method resolution
order changes dynamically to support cooperative calls to *note super():
4d7.  This approach is known in some other multiple-inheritance
languages as call-next-method and is more powerful than the super call
found in single-inheritance languages.

Dynamic ordering is necessary because all cases of multiple inheritance
exhibit one or more diamond relationships (where at least one of the
parent classes can be accessed through multiple paths from the
bottommost class).  For example, all classes inherit from *note object:
2ae, so any case of multiple inheritance provides more than one path to
reach *note object: 2ae.  To keep the base classes from being accessed
more than once, the dynamic algorithm linearizes the search order in a
way that preserves the left-to-right ordering specified in each class,
that calls each parent only once, and that is monotonic (meaning that a
class can be subclassed without affecting the precedence order of its
parents).  Taken together, these properties make it possible to design
reliable and extensible classes with multiple inheritance.  For more
detail, see ‘https://www.python.org/download/releases/2.3/mro/’.


File: python.info,  Node: Private Variables,  Next: Odds and Ends,  Prev: Inheritance,  Up: Classes

2.9.6 Private Variables
-----------------------

“Private” instance variables that cannot be accessed except from inside
an object don’t exist in Python.  However, there is a convention that is
followed by most Python code: a name prefixed with an underscore (e.g.
‘_spam’) should be treated as a non-public part of the API (whether it
is a function, a method or a data member).  It should be considered an
implementation detail and subject to change without notice.

Since there is a valid use-case for class-private members (namely to
avoid name clashes of names with names defined by subclasses), there is
limited support for such a mechanism, called `name mangling'.  Any
identifier of the form ‘__spam’ (at least two leading underscores, at
most one trailing underscore) is textually replaced with
‘_classname__spam’, where ‘classname’ is the current class name with
leading underscore(s) stripped.  This mangling is done without regard to
the syntactic position of the identifier, as long as it occurs within
the definition of a class.

Name mangling is helpful for letting subclasses override methods without
breaking intraclass method calls.  For example:

     class Mapping:
         def __init__(self, iterable):
             self.items_list = []
             self.__update(iterable)

         def update(self, iterable):
             for item in iterable:
                 self.items_list.append(item)

         __update = update   # private copy of original update() method

     class MappingSubclass(Mapping):

         def update(self, keys, values):
             # provides new signature for update()
             # but does not break __init__()
             for item in zip(keys, values):
                 self.items_list.append(item)

The above example would work even if ‘MappingSubclass’ were to introduce
a ‘__update’ identifier since it is replaced with ‘_Mapping__update’ in
the ‘Mapping’ class and ‘_MappingSubclass__update’ in the
‘MappingSubclass’ class respectively.

Note that the mangling rules are designed mostly to avoid accidents; it
still is possible to access or modify a variable that is considered
private.  This can even be useful in special circumstances, such as in
the debugger.

Notice that code passed to ‘exec()’ or ‘eval()’ does not consider the
classname of the invoking class to be the current class; this is similar
to the effect of the ‘global’ statement, the effect of which is likewise
restricted to code that is byte-compiled together.  The same restriction
applies to ‘getattr()’, ‘setattr()’ and ‘delattr()’, as well as when
referencing ‘__dict__’ directly.


File: python.info,  Node: Odds and Ends,  Next: Iterators,  Prev: Private Variables,  Up: Classes

2.9.7 Odds and Ends
-------------------

Sometimes it is useful to have a data type similar to the Pascal
“record” or C “struct”, bundling together a few named data items.  An
empty class definition will do nicely:

     class Employee:
         pass

     john = Employee()  # Create an empty employee record

     # Fill the fields of the record
     john.name = 'John Doe'
     john.dept = 'computer lab'
     john.salary = 1000

A piece of Python code that expects a particular abstract data type can
often be passed a class that emulates the methods of that data type
instead.  For instance, if you have a function that formats some data
from a file object, you can define a class with methods ‘read()’ and
‘readline()’ that get the data from a string buffer instead, and pass it
as an argument.

Instance method objects have attributes, too: ‘m.__self__’ is the
instance object with the method ‘m()’, and ‘m.__func__’ is the function
object corresponding to the method.


File: python.info,  Node: Iterators,  Next: Generators,  Prev: Odds and Ends,  Up: Classes

2.9.8 Iterators
---------------

By now you have probably noticed that most container objects can be
looped over using a *note for: c23. statement:

     for element in [1, 2, 3]:
         print(element)
     for element in (1, 2, 3):
         print(element)
     for key in {'one':1, 'two':2}:
         print(key)
     for char in "123":
         print(char)
     for line in open("myfile.txt"):
         print(line, end='')

This style of access is clear, concise, and convenient.  The use of
iterators pervades and unifies Python.  Behind the scenes, the *note
for: c23. statement calls *note iter(): d1a. on the container object.
The function returns an iterator object that defines the method *note
__next__(): c57. which accesses elements in the container one at a time.
When there are no more elements, *note __next__(): c57. raises a *note
StopIteration: 47b. exception which tells the ‘for’ loop to terminate.
You can call the *note __next__(): c57. method using the *note next():
676. built-in function; this example shows how it all works:

     >>> s = 'abc'
     >>> it = iter(s)
     >>> it
     <iterator object at 0x00A1DB50>
     >>> next(it)
     'a'
     >>> next(it)
     'b'
     >>> next(it)
     'c'
     >>> next(it)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
         next(it)
     StopIteration

Having seen the mechanics behind the iterator protocol, it is easy to
add iterator behavior to your classes.  Define an *note __iter__(): 504.
method which returns an object with a *note __next__(): c57. method.  If
the class defines ‘__next__()’, then *note __iter__(): 504. can just
return ‘self’:

     class Reverse:
         """Iterator for looping over a sequence backwards."""
         def __init__(self, data):
             self.data = data
             self.index = len(data)

         def __iter__(self):
             return self

         def __next__(self):
             if self.index == 0:
                 raise StopIteration
             self.index = self.index - 1
             return self.data[self.index]

     >>> rev = Reverse('spam')
     >>> iter(rev)
     <__main__.Reverse object at 0x00A1DB50>
     >>> for char in rev:
     ...     print(char)
     ...
     m
     a
     p
     s


File: python.info,  Node: Generators,  Next: Generator Expressions,  Prev: Iterators,  Up: Classes

2.9.9 Generators
----------------

*note Generator: 996.s are a simple and powerful tool for creating
iterators.  They are written like regular functions but use the *note
yield: 18f. statement whenever they want to return data.  Each time
*note next(): 676. is called on it, the generator resumes where it left
off (it remembers all the data values and which statement was last
executed).  An example shows that generators can be trivially easy to
create:

     def reverse(data):
         for index in range(len(data)-1, -1, -1):
             yield data[index]

     >>> for char in reverse('golf'):
     ...     print(char)
     ...
     f
     l
     o
     g

Anything that can be done with generators can also be done with
class-based iterators as described in the previous section.  What makes
generators so compact is that the *note __iter__(): 504. and *note
__next__(): 1213. methods are created automatically.

Another key feature is that the local variables and execution state are
automatically saved between calls.  This made the function easier to
write and much more clear than an approach using instance variables like
‘self.index’ and ‘self.data’.

In addition to automatic method creation and saving program state, when
generators terminate, they automatically raise *note StopIteration: 47b.
In combination, these features make it easy to create iterators with no
more effort than writing a regular function.


File: python.info,  Node: Generator Expressions,  Prev: Generators,  Up: Classes

2.9.10 Generator Expressions
----------------------------

Some simple generators can be coded succinctly as expressions using a
syntax similar to list comprehensions but with parentheses instead of
square brackets.  These expressions are designed for situations where
the generator is used right away by an enclosing function.  Generator
expressions are more compact but less versatile than full generator
definitions and tend to be more memory friendly than equivalent list
comprehensions.

Examples:

     >>> sum(i*i for i in range(10))                 # sum of squares
     285

     >>> xvec = [10, 20, 30]
     >>> yvec = [7, 5, 3]
     >>> sum(x*y for x,y in zip(xvec, yvec))         # dot product
     260

     >>> unique_words = set(word for line in page  for word in line.split())

     >>> valedictorian = max((student.gpa, student.name) for student in graduates)

     >>> data = 'golf'
     >>> list(data[i] for i in range(len(data)-1, -1, -1))
     ['f', 'l', 'o', 'g']


File: python.info,  Node: Brief Tour of the Standard Library,  Next: Brief Tour of the Standard Library — Part II,  Prev: Classes,  Up: The Python Tutorial

2.10 Brief Tour of the Standard Library
=======================================

* Menu:

* Operating System Interface::
* File Wildcards::
* Command Line Arguments::
* Error Output Redirection and Program Termination::
* String Pattern Matching::
* Mathematics::
* Internet Access::
* Dates and Times::
* Data Compression::
* Performance Measurement::
* Quality Control::
* Batteries Included::


File: python.info,  Node: Operating System Interface,  Next: File Wildcards,  Up: Brief Tour of the Standard Library

2.10.1 Operating System Interface
---------------------------------

The *note os: c4. module provides dozens of functions for interacting
with the operating system:

     >>> import os
     >>> os.getcwd()      # Return the current working directory
     'C:\\Python38'
     >>> os.chdir('/server/accesslogs')   # Change current working directory
     >>> os.system('mkdir today')   # Run the command mkdir in the system shell
     0

Be sure to use the ‘import os’ style instead of ‘from os import *’.
This will keep *note os.open(): 659. from shadowing the built-in *note
open(): 4e5. function which operates much differently.

The built-in *note dir(): d26. and *note help(): 567. functions are
useful as interactive aids for working with large modules like *note os:
c4.:

     >>> import os
     >>> dir(os)
     <returns a list of all module functions>
     >>> help(os)
     <returns an extensive manual page created from the module's docstrings>

For daily file and directory management tasks, the *note shutil: e9.
module provides a higher level interface that is easier to use:

     >>> import shutil
     >>> shutil.copyfile('data.db', 'archive.db')
     'archive.db'
     >>> shutil.move('/build/executables', 'installdir')
     'installdir'


File: python.info,  Node: File Wildcards,  Next: Command Line Arguments,  Prev: Operating System Interface,  Up: Brief Tour of the Standard Library

2.10.2 File Wildcards
---------------------

The *note glob: 8a. module provides a function for making file lists
from directory wildcard searches:

     >>> import glob
     >>> glob.glob('*.py')
     ['primes.py', 'random.py', 'quote.py']


File: python.info,  Node: Command Line Arguments,  Next: Error Output Redirection and Program Termination,  Prev: File Wildcards,  Up: Brief Tour of the Standard Library

2.10.3 Command Line Arguments
-----------------------------

Common utility scripts often need to process command line arguments.
These arguments are stored in the *note sys: fd. module’s `argv'
attribute as a list.  For instance the following output results from
running ‘python demo.py one two three’ at the command line:

     >>> import sys
     >>> print(sys.argv)
     ['demo.py', 'one', 'two', 'three']

The *note argparse: 6. module provides a more sophisticated mechanism to
process command line arguments.  The following script extracts one or
more filenames and an optional number of lines to be displayed:

     import argparse

     parser = argparse.ArgumentParser(prog = 'top',
         description = 'Show top lines from each file')
     parser.add_argument('filenames', nargs='+')
     parser.add_argument('-l', '--lines', type=int, default=10)
     args = parser.parse_args()
     print(args)

When run at the command line with ‘python top.py --lines=5 alpha.txt
beta.txt’, the script sets ‘args.lines’ to ‘5’ and ‘args.filenames’ to
‘['alpha.txt', 'beta.txt']’.


File: python.info,  Node: Error Output Redirection and Program Termination,  Next: String Pattern Matching,  Prev: Command Line Arguments,  Up: Brief Tour of the Standard Library

2.10.4 Error Output Redirection and Program Termination
-------------------------------------------------------

The *note sys: fd. module also has attributes for `stdin', `stdout', and
`stderr'.  The latter is useful for emitting warnings and error messages
to make them visible even when `stdout' has been redirected:

     >>> sys.stderr.write('Warning, log file not found starting a new one\n')
     Warning, log file not found starting a new one

The most direct way to terminate a script is to use ‘sys.exit()’.


File: python.info,  Node: String Pattern Matching,  Next: Mathematics,  Prev: Error Output Redirection and Program Termination,  Up: Brief Tour of the Standard Library

2.10.5 String Pattern Matching
------------------------------

The *note re: dd. module provides regular expression tools for advanced
string processing.  For complex matching and manipulation, regular
expressions offer succinct, optimized solutions:

     >>> import re
     >>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest')
     ['foot', 'fell', 'fastest']
     >>> re.sub(r'(\b[a-z]+) \1', r'\1', 'cat in the the hat')
     'cat in the hat'

When only simple capabilities are needed, string methods are preferred
because they are easier to read and debug:

     >>> 'tea for too'.replace('too', 'two')
     'tea for two'


File: python.info,  Node: Mathematics,  Next: Internet Access,  Prev: String Pattern Matching,  Up: Brief Tour of the Standard Library

2.10.6 Mathematics
------------------

The *note math: b1. module gives access to the underlying C library
functions for floating point math:

     >>> import math
     >>> math.cos(math.pi / 4)
     0.70710678118654757
     >>> math.log(1024, 2)
     10.0

The *note random: dc. module provides tools for making random
selections:

     >>> import random
     >>> random.choice(['apple', 'pear', 'banana'])
     'apple'
     >>> random.sample(range(100), 10)   # sampling without replacement
     [30, 83, 16, 4, 8, 81, 41, 50, 18, 33]
     >>> random.random()    # random float
     0.17970987693706186
     >>> random.randrange(6)    # random integer chosen from range(6)
     4

The *note statistics: f5. module calculates basic statistical properties
(the mean, median, variance, etc.)  of numeric data:

     >>> import statistics
     >>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
     >>> statistics.mean(data)
     1.6071428571428572
     >>> statistics.median(data)
     1.25
     >>> statistics.variance(data)
     1.3720238095238095

The SciPy project <‘https://scipy.org’> has many other modules for
numerical computations.


File: python.info,  Node: Internet Access,  Next: Dates and Times,  Prev: Mathematics,  Up: Brief Tour of the Standard Library

2.10.7 Internet Access
----------------------

There are a number of modules for accessing the internet and processing
internet protocols.  Two of the simplest are *note urllib.request: 120.
for retrieving data from URLs and *note smtplib: ed. for sending mail:

     >>> from urllib.request import urlopen
     >>> with urlopen('http://tycho.usno.navy.mil/cgi-bin/timer.pl') as response:
     ...     for line in response:
     ...         line = line.decode('utf-8')  # Decoding the binary data to text.
     ...         if 'EST' in line or 'EDT' in line:  # look for Eastern Time
     ...             print(line)

     <BR>Nov. 25, 09:43:32 PM EST

     >>> import smtplib
     >>> server = smtplib.SMTP('localhost')
     >>> server.sendmail('soothsayer@example.org', 'jcaesar@example.org',
     ... """To: jcaesar@example.org
     ... From: soothsayer@example.org
     ...
     ... Beware the Ides of March.
     ... """)
     >>> server.quit()

(Note that the second example needs a mailserver running on localhost.)


File: python.info,  Node: Dates and Times,  Next: Data Compression,  Prev: Internet Access,  Up: Brief Tour of the Standard Library

2.10.8 Dates and Times
----------------------

The *note datetime: 31. module supplies classes for manipulating dates
and times in both simple and complex ways.  While date and time
arithmetic is supported, the focus of the implementation is on efficient
member extraction for output formatting and manipulation.  The module
also supports objects that are timezone aware.

     >>> # dates are easily constructed and formatted
     >>> from datetime import date
     >>> now = date.today()
     >>> now
     datetime.date(2003, 12, 2)
     >>> now.strftime("%m-%d-%y. %d %b %Y is a %A on the %d day of %B.")
     '12-02-03. 02 Dec 2003 is a Tuesday on the 02 day of December.'

     >>> # dates support calendar arithmetic
     >>> birthday = date(1964, 7, 31)
     >>> age = now - birthday
     >>> age.days
     14368


File: python.info,  Node: Data Compression,  Next: Performance Measurement,  Prev: Dates and Times,  Up: Brief Tour of the Standard Library

2.10.9 Data Compression
-----------------------

Common data archiving and compression formats are directly supported by
modules including: *note zlib: 144, *note gzip: 8c, *note bz2: 14, *note
lzma: ad, *note zipfile: 142. and *note tarfile: 101.

     >>> import zlib
     >>> s = b'witch which has which witches wrist watch'
     >>> len(s)
     41
     >>> t = zlib.compress(s)
     >>> len(t)
     37
     >>> zlib.decompress(t)
     b'witch which has which witches wrist watch'
     >>> zlib.crc32(s)
     226805979


File: python.info,  Node: Performance Measurement,  Next: Quality Control,  Prev: Data Compression,  Up: Brief Tour of the Standard Library

2.10.10 Performance Measurement
-------------------------------

Some Python users develop a deep interest in knowing the relative
performance of different approaches to the same problem.  Python
provides a measurement tool that answers those questions immediately.

For example, it may be tempting to use the tuple packing and unpacking
feature instead of the traditional approach to swapping arguments.  The
*note timeit: 10b. module quickly demonstrates a modest performance
advantage:

     >>> from timeit import Timer
     >>> Timer('t=a; a=b; b=t', 'a=1; b=2').timeit()
     0.57535828626024577
     >>> Timer('a,b = b,a', 'a=1; b=2').timeit()
     0.54962537085770791

In contrast to *note timeit: 10b.’s fine level of granularity, the *note
profile: d3. and *note pstats: d4. modules provide tools for identifying
time critical sections in larger blocks of code.


File: python.info,  Node: Quality Control,  Next: Batteries Included,  Prev: Performance Measurement,  Up: Brief Tour of the Standard Library

2.10.11 Quality Control
-----------------------

One approach for developing high quality software is to write tests for
each function as it is developed and to run those tests frequently
during the development process.

The *note doctest: 67. module provides a tool for scanning a module and
validating tests embedded in a program’s docstrings.  Test construction
is as simple as cutting-and-pasting a typical call along with its
results into the docstring.  This improves the documentation by
providing the user with an example and it allows the doctest module to
make sure the code remains true to the documentation:

     def average(values):
         """Computes the arithmetic mean of a list of numbers.

         >>> print(average([20, 30, 70]))
         40.0
         """
         return sum(values) / len(values)

     import doctest
     doctest.testmod()   # automatically validate the embedded tests

The *note unittest: 11b. module is not as effortless as the *note
doctest: 67. module, but it allows a more comprehensive set of tests to
be maintained in a separate file:

     import unittest

     class TestStatisticalFunctions(unittest.TestCase):

         def test_average(self):
             self.assertEqual(average([20, 30, 70]), 40.0)
             self.assertEqual(round(average([1, 5, 7]), 1), 4.3)
             with self.assertRaises(ZeroDivisionError):
                 average([])
             with self.assertRaises(TypeError):
                 average(20, 30, 70)

     unittest.main()  # Calling from the command line invokes all tests


File: python.info,  Node: Batteries Included,  Prev: Quality Control,  Up: Brief Tour of the Standard Library

2.10.12 Batteries Included
--------------------------

Python has a “batteries included” philosophy.  This is best seen through
the sophisticated and robust capabilities of its larger packages.  For
example:

   * The *note xmlrpc.client: 13f. and *note xmlrpc.server: 140. modules
     make implementing remote procedure calls into an almost trivial
     task.  Despite the modules names, no direct knowledge or handling
     of XML is needed.

   * The *note email: 69. package is a library for managing email
     messages, including MIME and other RFC 2822(1)-based message
     documents.  Unlike *note smtplib: ed. and *note poplib: d0. which
     actually send and receive messages, the email package has a
     complete toolset for building or decoding complex message
     structures (including attachments) and for implementing internet
     encoding and header protocols.

   * The *note json: a4. package provides robust support for parsing
     this popular data interchange format.  The *note csv: 2a. module
     supports direct reading and writing of files in Comma-Separated
     Value format, commonly supported by databases and spreadsheets.
     XML processing is supported by the *note xml.etree.ElementTree:
     137, *note xml.dom: 134. and *note xml.sax: 13b. packages.
     Together, these modules and packages greatly simplify data
     interchange between Python applications and other tools.

   * The *note sqlite3: f2. module is a wrapper for the SQLite database
     library, providing a persistent database that can be updated and
     accessed using slightly nonstandard SQL syntax.

   * Internationalization is supported by a number of modules including
     *note gettext: 89, *note locale: a9, and the *note codecs: 1c.
     package.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2822.html


File: python.info,  Node: Brief Tour of the Standard Library — Part II,  Next: Virtual Environments and Packages,  Prev: Brief Tour of the Standard Library,  Up: The Python Tutorial

2.11 Brief Tour of the Standard Library — Part II
=================================================

This second tour covers more advanced modules that support professional
programming needs.  These modules rarely occur in small scripts.

* Menu:

* Output Formatting::
* Templating::
* Working with Binary Data Record Layouts::
* Multi-threading: Multi-threading<2>.
* Logging::
* Weak References::
* Tools for Working with Lists::
* Decimal Floating Point Arithmetic::


File: python.info,  Node: Output Formatting,  Next: Templating,  Up: Brief Tour of the Standard Library — Part II

2.11.1 Output Formatting
------------------------

The *note reprlib: df. module provides a version of *note repr(): 7c0.
customized for abbreviated displays of large or deeply nested
containers:

     >>> import reprlib
     >>> reprlib.repr(set('supercalifragilisticexpialidocious'))
     "{'a', 'c', 'd', 'e', 'f', 'g', ...}"

The *note pprint: d2. module offers more sophisticated control over
printing both built-in and user defined objects in a way that is
readable by the interpreter.  When the result is longer than one line,
the “pretty printer” adds line breaks and indentation to more clearly
reveal data structure:

     >>> import pprint
     >>> t = [[[['black', 'cyan'], 'white', ['green', 'red']], [['magenta',
     ...     'yellow'], 'blue']]]
     ...
     >>> pprint.pprint(t, width=30)
     [[[['black', 'cyan'],
        'white',
        ['green', 'red']],
       [['magenta', 'yellow'],
        'blue']]]

The *note textwrap: 108. module formats paragraphs of text to fit a
given screen width:

     >>> import textwrap
     >>> doc = """The wrap() method is just like fill() except that it returns
     ... a list of strings instead of one big string with newlines to separate
     ... the wrapped lines."""
     ...
     >>> print(textwrap.fill(doc, width=40))
     The wrap() method is just like fill()
     except that it returns a list of strings
     instead of one big string with newlines
     to separate the wrapped lines.

The *note locale: a9. module accesses a database of culture specific
data formats.  The grouping attribute of locale’s format function
provides a direct way of formatting numbers with group separators:

     >>> import locale
     >>> locale.setlocale(locale.LC_ALL, 'English_United States.1252')
     'English_United States.1252'
     >>> conv = locale.localeconv()          # get a mapping of conventions
     >>> x = 1234567.8
     >>> locale.format("%d", x, grouping=True)
     '1,234,567'
     >>> locale.format_string("%s%.*f", (conv['currency_symbol'],
     ...                      conv['frac_digits'], x), grouping=True)
     '$1,234,567.80'


File: python.info,  Node: Templating,  Next: Working with Binary Data Record Layouts,  Prev: Output Formatting,  Up: Brief Tour of the Standard Library — Part II

2.11.2 Templating
-----------------

The *note string: f6. module includes a versatile *note Template: 3e0.
class with a simplified syntax suitable for editing by end-users.  This
allows users to customize their applications without having to alter the
application.

The format uses placeholder names formed by ‘$’ with valid Python
identifiers (alphanumeric characters and underscores).  Surrounding the
placeholder with braces allows it to be followed by more alphanumeric
letters with no intervening spaces.  Writing ‘$$’ creates a single
escaped ‘$’:

     >>> from string import Template
     >>> t = Template('${village}folk send $$10 to $cause.')
     >>> t.substitute(village='Nottingham', cause='the ditch fund')
     'Nottinghamfolk send $10 to the ditch fund.'

The *note substitute(): 1238. method raises a *note KeyError: 2c5. when
a placeholder is not supplied in a dictionary or a keyword argument.
For mail-merge style applications, user supplied data may be incomplete
and the *note safe_substitute(): 1239. method may be more appropriate —
it will leave placeholders unchanged if data is missing:

     >>> t = Template('Return the $item to $owner.')
     >>> d = dict(item='unladen swallow')
     >>> t.substitute(d)
     Traceback (most recent call last):
       ...
     KeyError: 'owner'
     >>> t.safe_substitute(d)
     'Return the unladen swallow to $owner.'

Template subclasses can specify a custom delimiter.  For example, a
batch renaming utility for a photo browser may elect to use percent
signs for placeholders such as the current date, image sequence number,
or file format:

     >>> import time, os.path
     >>> photofiles = ['img_1074.jpg', 'img_1076.jpg', 'img_1077.jpg']
     >>> class BatchRename(Template):
     ...     delimiter = '%'
     >>> fmt = input('Enter rename style (%d-date %n-seqnum %f-format):  ')
     Enter rename style (%d-date %n-seqnum %f-format):  Ashley_%n%f

     >>> t = BatchRename(fmt)
     >>> date = time.strftime('%d%b%y')
     >>> for i, filename in enumerate(photofiles):
     ...     base, ext = os.path.splitext(filename)
     ...     newname = t.substitute(d=date, n=i, f=ext)
     ...     print('{0} --> {1}'.format(filename, newname))

     img_1074.jpg --> Ashley_0.jpg
     img_1076.jpg --> Ashley_1.jpg
     img_1077.jpg --> Ashley_2.jpg

Another application for templating is separating program logic from the
details of multiple output formats.  This makes it possible to
substitute custom templates for XML files, plain text reports, and HTML
web reports.


File: python.info,  Node: Working with Binary Data Record Layouts,  Next: Multi-threading<2>,  Prev: Templating,  Up: Brief Tour of the Standard Library — Part II

2.11.3 Working with Binary Data Record Layouts
----------------------------------------------

The *note struct: f8. module provides *note pack(): bfe. and *note
unpack(): 123c. functions for working with variable length binary record
formats.  The following example shows how to loop through header
information in a ZIP file without using the *note zipfile: 142. module.
Pack codes ‘"H"’ and ‘"I"’ represent two and four byte unsigned numbers
respectively.  The ‘"<"’ indicates that they are standard size and in
little-endian byte order:

     import struct

     with open('myfile.zip', 'rb') as f:
         data = f.read()

     start = 0
     for i in range(3):                      # show the first 3 file headers
         start += 14
         fields = struct.unpack('<IIIHH', data[start:start+16])
         crc32, comp_size, uncomp_size, filenamesize, extra_size = fields

         start += 16
         filename = data[start:start+filenamesize]
         start += filenamesize
         extra = data[start:start+extra_size]
         print(filename, hex(crc32), comp_size, uncomp_size)

         start += extra_size + comp_size     # skip to the next header


File: python.info,  Node: Multi-threading<2>,  Next: Logging,  Prev: Working with Binary Data Record Layouts,  Up: Brief Tour of the Standard Library — Part II

2.11.4 Multi-threading
----------------------

Threading is a technique for decoupling tasks which are not sequentially
dependent.  Threads can be used to improve the responsiveness of
applications that accept user input while other tasks run in the
background.  A related use case is running I/O in parallel with
computations in another thread.

The following code shows how the high level *note threading: 109. module
can run tasks in background while the main program continues to run:

     import threading, zipfile

     class AsyncZip(threading.Thread):
         def __init__(self, infile, outfile):
             threading.Thread.__init__(self)
             self.infile = infile
             self.outfile = outfile

         def run(self):
             f = zipfile.ZipFile(self.outfile, 'w', zipfile.ZIP_DEFLATED)
             f.write(self.infile)
             f.close()
             print('Finished background zip of:', self.infile)

     background = AsyncZip('mydata.txt', 'myarchive.zip')
     background.start()
     print('The main program continues to run in foreground.')

     background.join()    # Wait for the background task to finish
     print('Main program waited until background was done.')

The principal challenge of multi-threaded applications is coordinating
threads that share data or other resources.  To that end, the threading
module provides a number of synchronization primitives including locks,
events, condition variables, and semaphores.

While those tools are powerful, minor design errors can result in
problems that are difficult to reproduce.  So, the preferred approach to
task coordination is to concentrate all access to a resource in a single
thread and then use the *note queue: da. module to feed that thread with
requests from other threads.  Applications using *note Queue: d0b.
objects for inter-thread communication and coordination are easier to
design, more readable, and more reliable.


File: python.info,  Node: Logging,  Next: Weak References,  Prev: Multi-threading<2>,  Up: Brief Tour of the Standard Library — Part II

2.11.5 Logging
--------------

The *note logging: aa. module offers a full featured and flexible
logging system.  At its simplest, log messages are sent to a file or to
‘sys.stderr’:

     import logging
     logging.debug('Debugging information')
     logging.info('Informational message')
     logging.warning('Warning:config file %s not found', 'server.conf')
     logging.error('Error occurred')
     logging.critical('Critical error -- shutting down')

This produces the following output:

     WARNING:root:Warning:config file server.conf not found
     ERROR:root:Error occurred
     CRITICAL:root:Critical error -- shutting down

By default, informational and debugging messages are suppressed and the
output is sent to standard error.  Other output options include routing
messages through email, datagrams, sockets, or to an HTTP Server.  New
filters can select different routing based on message priority: ‘DEBUG’,
‘INFO’, ‘WARNING’, ‘ERROR’, and ‘CRITICAL’.

The logging system can be configured directly from Python or can be
loaded from a user editable configuration file for customized logging
without altering the application.


File: python.info,  Node: Weak References,  Next: Tools for Working with Lists,  Prev: Logging,  Up: Brief Tour of the Standard Library — Part II

2.11.6 Weak References
----------------------

Python does automatic memory management (reference counting for most
objects and *note garbage collection: 1243. to eliminate cycles).  The
memory is freed shortly after the last reference to it has been
eliminated.

This approach works fine for most applications but occasionally there is
a need to track objects only as long as they are being used by something
else.  Unfortunately, just tracking them creates a reference that makes
them permanent.  The *note weakref: 128. module provides tools for
tracking objects without creating a reference.  When the object is no
longer needed, it is automatically removed from a weakref table and a
callback is triggered for weakref objects.  Typical applications include
caching objects that are expensive to create:

     >>> import weakref, gc
     >>> class A:
     ...     def __init__(self, value):
     ...         self.value = value
     ...     def __repr__(self):
     ...         return str(self.value)
     ...
     >>> a = A(10)                   # create a reference
     >>> d = weakref.WeakValueDictionary()
     >>> d['primary'] = a            # does not create a reference
     >>> d['primary']                # fetch the object if it is still alive
     10
     >>> del a                       # remove the one reference
     >>> gc.collect()                # run garbage collection right away
     0
     >>> d['primary']                # entry was automatically removed
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
         d['primary']                # entry was automatically removed
       File "C:/python38/lib/weakref.py", line 46, in __getitem__
         o = self.data[key]()
     KeyError: 'primary'


File: python.info,  Node: Tools for Working with Lists,  Next: Decimal Floating Point Arithmetic,  Prev: Weak References,  Up: Brief Tour of the Standard Library — Part II

2.11.7 Tools for Working with Lists
-----------------------------------

Many data structure needs can be met with the built-in list type.
However, sometimes there is a need for alternative implementations with
different performance trade-offs.

The *note array: 7. module provides an *note array(): 446. object that
is like a list that stores only homogeneous data and stores it more
compactly.  The following example shows an array of numbers stored as
two byte unsigned binary numbers (typecode ‘"H"’) rather than the usual
16 bytes per entry for regular lists of Python int objects:

     >>> from array import array
     >>> a = array('H', [4000, 10, 700, 22222])
     >>> sum(a)
     26932
     >>> a[1:3]
     array('H', [10, 700])

The *note collections: 1e. module provides a *note deque(): 526. object
that is like a list with faster appends and pops from the left side but
slower lookups in the middle.  These objects are well suited for
implementing queues and breadth first tree searches:

     >>> from collections import deque
     >>> d = deque(["task1", "task2", "task3"])
     >>> d.append("task4")
     >>> print("Handling", d.popleft())
     Handling task1

     unsearched = deque([starting_node])
     def breadth_first_search(unsearched):
         node = unsearched.popleft()
         for m in gen_moves(node):
             if is_goal(m):
                 return m
             unsearched.append(m)

In addition to alternative list implementations, the library also offers
other tools such as the *note bisect: 12. module with functions for
manipulating sorted lists:

     >>> import bisect
     >>> scores = [(100, 'perl'), (200, 'tcl'), (400, 'lua'), (500, 'python')]
     >>> bisect.insort(scores, (300, 'ruby'))
     >>> scores
     [(100, 'perl'), (200, 'tcl'), (300, 'ruby'), (400, 'lua'), (500, 'python')]

The *note heapq: 8e. module provides functions for implementing heaps
based on regular lists.  The lowest valued entry is always kept at
position zero.  This is useful for applications which repeatedly access
the smallest element but do not want to run a full list sort:

     >>> from heapq import heapify, heappop, heappush
     >>> data = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0]
     >>> heapify(data)                      # rearrange the list into heap order
     >>> heappush(data, -5)                 # add a new entry
     >>> [heappop(data) for i in range(3)]  # fetch the three smallest entries
     [-5, 0, 1]


File: python.info,  Node: Decimal Floating Point Arithmetic,  Prev: Tools for Working with Lists,  Up: Brief Tour of the Standard Library — Part II

2.11.8 Decimal Floating Point Arithmetic
----------------------------------------

The *note decimal: 36. module offers a *note Decimal: 188. datatype for
decimal floating point arithmetic.  Compared to the built-in *note
float: 187. implementation of binary floating point, the class is
especially helpful for

   * financial applications and other uses which require exact decimal
     representation,

   * control over precision,

   * control over rounding to meet legal or regulatory requirements,

   * tracking of significant decimal places, or

   * applications where the user expects the results to match
     calculations done by hand.

For example, calculating a 5% tax on a 70 cent phone charge gives
different results in decimal floating point and binary floating point.
The difference becomes significant if the results are rounded to the
nearest cent:

     >>> from decimal import *
     >>> round(Decimal('0.70') * Decimal('1.05'), 2)
     Decimal('0.74')
     >>> round(.70 * 1.05, 2)
     0.73

The *note Decimal: 188. result keeps a trailing zero, automatically
inferring four place significance from multiplicands with two place
significance.  Decimal reproduces mathematics as done by hand and avoids
issues that can arise when binary floating point cannot exactly
represent decimal quantities.

Exact representation enables the *note Decimal: 188. class to perform
modulo calculations and equality tests that are unsuitable for binary
floating point:

     >>> Decimal('1.00') % Decimal('.10')
     Decimal('0.00')
     >>> 1.00 % 0.10
     0.09999999999999995

     >>> sum([Decimal('0.1')]*10) == Decimal('1.0')
     True
     >>> sum([0.1]*10) == 1.0
     False

The *note decimal: 36. module provides arithmetic with as much precision
as needed:

     >>> getcontext().prec = 36
     >>> Decimal(1) / Decimal(7)
     Decimal('0.142857142857142857142857142857142857')


File: python.info,  Node: Virtual Environments and Packages,  Next: What Now?,  Prev: Brief Tour of the Standard Library — Part II,  Up: The Python Tutorial

2.12 Virtual Environments and Packages
======================================

* Menu:

* Introduction: Introduction<4>.
* Creating Virtual Environments::
* Managing Packages with pip::


File: python.info,  Node: Introduction<4>,  Next: Creating Virtual Environments,  Up: Virtual Environments and Packages

2.12.1 Introduction
-------------------

Python applications will often use packages and modules that don’t come
as part of the standard library.  Applications will sometimes need a
specific version of a library, because the application may require that
a particular bug has been fixed or the application may be written using
an obsolete version of the library’s interface.

This means it may not be possible for one Python installation to meet
the requirements of every application.  If application A needs version
1.0 of a particular module but application B needs version 2.0, then the
requirements are in conflict and installing either version 1.0 or 2.0
will leave one application unable to run.

The solution for this problem is to create a *note virtual environment:
124c, a self-contained directory tree that contains a Python
installation for a particular version of Python, plus a number of
additional packages.

Different applications can then use different virtual environments.  To
resolve the earlier example of conflicting requirements, application A
can have its own virtual environment with version 1.0 installed while
application B has another virtual environment with version 2.0.  If
application B requires a library be upgraded to version 3.0, this will
not affect application A’s environment.


File: python.info,  Node: Creating Virtual Environments,  Next: Managing Packages with pip,  Prev: Introduction<4>,  Up: Virtual Environments and Packages

2.12.2 Creating Virtual Environments
------------------------------------

The module used to create and manage virtual environments is called
*note venv: 125.  *note venv: 125. will usually install the most recent
version of Python that you have available.  If you have multiple
versions of Python on your system, you can select a specific Python
version by running ‘python3’ or whichever version you want.

To create a virtual environment, decide upon a directory where you want
to place it, and run the *note venv: 125. module as a script with the
directory path:

     python3 -m venv tutorial-env

This will create the ‘tutorial-env’ directory if it doesn’t exist, and
also create directories inside it containing a copy of the Python
interpreter, the standard library, and various supporting files.

A common directory location for a virtual environment is ‘.venv’.  This
name keeps the directory typically hidden in your shell and thus out of
the way while giving it a name that explains why the directory exists.
It also prevents clashing with ‘.env’ environment variable definition
files that some tooling supports.

Once you’ve created a virtual environment, you may activate it.

On Windows, run:

     tutorial-env\Scripts\activate.bat

On Unix or MacOS, run:

     source tutorial-env/bin/activate

(This script is written for the bash shell.  If you use the ‘csh’ or
‘fish’ shells, there are alternate ‘activate.csh’ and ‘activate.fish’
scripts you should use instead.)

Activating the virtual environment will change your shell’s prompt to
show what virtual environment you’re using, and modify the environment
so that running ‘python’ will get you that particular version and
installation of Python.  For example:

     $ source ~/envs/tutorial-env/bin/activate
     (tutorial-env) $ python
     Python 3.5.1 (default, May  6 2016, 10:59:36)
       ...
     >>> import sys
     >>> sys.path
     ['', '/usr/local/lib/python35.zip', ...,
     '~/envs/tutorial-env/lib/python3.5/site-packages']
     >>>


File: python.info,  Node: Managing Packages with pip,  Prev: Creating Virtual Environments,  Up: Virtual Environments and Packages

2.12.3 Managing Packages with pip
---------------------------------

You can install, upgrade, and remove packages using a program called
‘pip’.  By default ‘pip’ will install packages from the Python Package
Index, <‘https://pypi.org’>.  You can browse the Python Package Index by
going to it in your web browser, or you can use ‘pip’’s limited search
feature:

     (tutorial-env) $ pip search astronomy
     skyfield               - Elegant astronomy for Python
     gary                   - Galactic astronomy and gravitational dynamics.
     novas                  - The United States Naval Observatory NOVAS astronomy library
     astroobs               - Provides astronomy ephemeris to plan telescope observations
     PyAstronomy            - A collection of astronomy related tools for Python.
     ...

‘pip’ has a number of subcommands: “search”, “install”, “uninstall”,
“freeze”, etc.  (Consult the *note Installing Python Modules: 7e9. guide
for complete documentation for ‘pip’.)

You can install the latest version of a package by specifying a
package’s name:

     (tutorial-env) $ pip install novas
     Collecting novas
       Downloading novas-3.1.1.3.tar.gz (136kB)
     Installing collected packages: novas
       Running setup.py install for novas
     Successfully installed novas-3.1.1.3

You can also install a specific version of a package by giving the
package name followed by ‘==’ and the version number:

     (tutorial-env) $ pip install requests==2.6.0
     Collecting requests==2.6.0
       Using cached requests-2.6.0-py2.py3-none-any.whl
     Installing collected packages: requests
     Successfully installed requests-2.6.0

If you re-run this command, ‘pip’ will notice that the requested version
is already installed and do nothing.  You can supply a different version
number to get that version, or you can run ‘pip install --upgrade’ to
upgrade the package to the latest version:

     (tutorial-env) $ pip install --upgrade requests
     Collecting requests
     Installing collected packages: requests
       Found existing installation: requests 2.6.0
         Uninstalling requests-2.6.0:
           Successfully uninstalled requests-2.6.0
     Successfully installed requests-2.7.0

‘pip uninstall’ followed by one or more package names will remove the
packages from the virtual environment.

‘pip show’ will display information about a particular package:

     (tutorial-env) $ pip show requests
     ---
     Metadata-Version: 2.0
     Name: requests
     Version: 2.7.0
     Summary: Python HTTP for Humans.
     Home-page: http://python-requests.org
     Author: Kenneth Reitz
     Author-email: me@kennethreitz.com
     License: Apache 2.0
     Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages
     Requires:

‘pip list’ will display all of the packages installed in the virtual
environment:

     (tutorial-env) $ pip list
     novas (3.1.1.3)
     numpy (1.9.2)
     pip (7.0.3)
     requests (2.7.0)
     setuptools (16.0)

‘pip freeze’ will produce a similar list of the installed packages, but
the output uses the format that ‘pip install’ expects.  A common
convention is to put this list in a ‘requirements.txt’ file:

     (tutorial-env) $ pip freeze > requirements.txt
     (tutorial-env) $ cat requirements.txt
     novas==3.1.1.3
     numpy==1.9.2
     requests==2.7.0

The ‘requirements.txt’ can then be committed to version control and
shipped as part of an application.  Users can then install all the
necessary packages with ‘install -r’:

     (tutorial-env) $ pip install -r requirements.txt
     Collecting novas==3.1.1.3 (from -r requirements.txt (line 1))
       ...
     Collecting numpy==1.9.2 (from -r requirements.txt (line 2))
       ...
     Collecting requests==2.7.0 (from -r requirements.txt (line 3))
       ...
     Installing collected packages: novas, numpy, requests
       Running setup.py install for novas
     Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0

‘pip’ has many more options.  Consult the *note Installing Python
Modules: 7e9. guide for complete documentation for ‘pip’.  When you’ve
written a package and want to make it available on the Python Package
Index, consult the *note Distributing Python Modules: 7ea. guide.


File: python.info,  Node: What Now?,  Next: Interactive Input Editing and History Substitution,  Prev: Virtual Environments and Packages,  Up: The Python Tutorial

2.13 What Now?
==============

Reading this tutorial has probably reinforced your interest in using
Python — you should be eager to apply Python to solving your real-world
problems.  Where should you go to learn more?

This tutorial is part of Python’s documentation set.  Some other
documents in the set are:

   * *note The Python Standard Library: 1135.:

     You should browse through this manual, which gives complete (though
     terse) reference material about types, functions, and the modules
     in the standard library.  The standard Python distribution includes
     a `lot' of additional code.  There are modules to read Unix
     mailboxes, retrieve documents via HTTP, generate random numbers,
     parse command-line options, write CGI programs, compress data, and
     many other tasks.  Skimming through the Library Reference will give
     you an idea of what’s available.

   * *note Installing Python Modules: 7e9. explains how to install
     additional modules written by other Python users.

   * *note The Python Language Reference: 1136.: A detailed explanation
     of Python’s syntax and semantics.  It’s heavy reading, but is
     useful as a complete guide to the language itself.

More Python resources:

   * ‘https://www.python.org’: The major Python Web site.  It contains
     code, documentation, and pointers to Python-related pages around
     the Web.  This Web site is mirrored in various places around the
     world, such as Europe, Japan, and Australia; a mirror may be faster
     than the main site, depending on your geographical location.

   * ‘https://docs.python.org’: Fast access to Python’s documentation.

   * ‘https://pypi.org’: The Python Package Index, previously also
     nicknamed the Cheese Shop (1), is an index of user-created Python
     modules that are available for download.  Once you begin releasing
     code, you can register it here so that others can find it.

   * ‘https://code.activestate.com/recipes/langs/python/’: The Python
     Cookbook is a sizable collection of code examples, larger modules,
     and useful scripts.  Particularly notable contributions are
     collected in a book also titled Python Cookbook (O’Reilly &
     Associates, ISBN 0-596-00797-3.)

   * ‘http://www.pyvideo.org’ collects links to Python-related videos
     from conferences and user-group meetings.

   * ‘https://scipy.org’: The Scientific Python project includes modules
     for fast array computations and manipulations plus a host of
     packages for such things as linear algebra, Fourier transforms,
     non-linear solvers, random number distributions, statistical
     analysis and the like.

For Python-related questions and problem reports, you can post to the
newsgroup ‘comp.lang.python’, or send them to the mailing list at
<python-list@python.org>.  The newsgroup and mailing list are gatewayed,
so messages posted to one will automatically be forwarded to the other.
There are hundreds of postings a day, asking (and answering) questions,
suggesting new features, and announcing new modules.  Mailing list
archives are available at ‘https://mail.python.org/pipermail/’.

Before posting, be sure to check the list of *note Frequently Asked
Questions: 1252. (also called the FAQ). The FAQ answers many of the
questions that come up again and again, and may already contain the
solution for your problem.

   ---------- Footnotes ----------

   (1) (1) “Cheese Shop” is a Monty Python’s sketch: a customer enters a
cheese shop, but whatever cheese he asks for, the clerk says it’s
missing.


File: python.info,  Node: Interactive Input Editing and History Substitution,  Next: Floating Point Arithmetic Issues and Limitations,  Prev: What Now?,  Up: The Python Tutorial

2.14 Interactive Input Editing and History Substitution
=======================================================

Some versions of the Python interpreter support editing of the current
input line and history substitution, similar to facilities found in the
Korn shell and the GNU Bash shell.  This is implemented using the GNU
Readline(1) library, which supports various styles of editing.  This
library has its own documentation which we won’t duplicate here.

* Menu:

* Tab Completion and History Editing::
* Alternatives to the Interactive Interpreter::

   ---------- Footnotes ----------

   (1) https://tiswww.case.edu/php/chet/readline/rltop.html


File: python.info,  Node: Tab Completion and History Editing,  Next: Alternatives to the Interactive Interpreter,  Up: Interactive Input Editing and History Substitution

2.14.1 Tab Completion and History Editing
-----------------------------------------

Completion of variable and module names is *note automatically enabled:
8da. at interpreter startup so that the ‘Tab’ key invokes the completion
function; it looks at Python statement names, the current local
variables, and the available module names.  For dotted expressions such
as ‘string.a’, it will evaluate the expression up to the final ‘'.'’ and
then suggest completions from the attributes of the resulting object.
Note that this may execute application-defined code if an object with a
*note __getattr__(): 30f. method is part of the expression.  The default
configuration also saves your history into a file named
‘.python_history’ in your user directory.  The history will be available
again during the next interactive interpreter session.


File: python.info,  Node: Alternatives to the Interactive Interpreter,  Prev: Tab Completion and History Editing,  Up: Interactive Input Editing and History Substitution

2.14.2 Alternatives to the Interactive Interpreter
--------------------------------------------------

This facility is an enormous step forward compared to earlier versions
of the interpreter; however, some wishes are left: It would be nice if
the proper indentation were suggested on continuation lines (the parser
knows if an indent token is required next).  The completion mechanism
might use the interpreter’s symbol table.  A command to check (or even
suggest) matching parentheses, quotes, etc., would also be useful.

One alternative enhanced interactive interpreter that has been around
for quite some time is IPython(1), which features tab completion, object
exploration and advanced history management.  It can also be thoroughly
customized and embedded into other applications.  Another similar
enhanced interactive environment is bpython(2).

   ---------- Footnotes ----------

   (1) https://ipython.org/

   (2) https://www.bpython-interpreter.org/


File: python.info,  Node: Floating Point Arithmetic Issues and Limitations,  Next: Appendix,  Prev: Interactive Input Editing and History Substitution,  Up: The Python Tutorial

2.15 Floating Point Arithmetic: Issues and Limitations
======================================================

Floating-point numbers are represented in computer hardware as base 2
(binary) fractions.  For example, the decimal fraction

     0.125

has value 1/10 + 2/100 + 5/1000, and in the same way the binary fraction

     0.001

has value 0/2 + 0/4 + 1/8.  These two fractions have identical values,
the only real difference being that the first is written in base 10
fractional notation, and the second in base 2.

Unfortunately, most decimal fractions cannot be represented exactly as
binary fractions.  A consequence is that, in general, the decimal
floating-point numbers you enter are only approximated by the binary
floating-point numbers actually stored in the machine.

The problem is easier to understand at first in base 10.  Consider the
fraction 1/3.  You can approximate that as a base 10 fraction:

     0.3

or, better,

     0.33

or, better,

     0.333

and so on.  No matter how many digits you’re willing to write down, the
result will never be exactly 1/3, but will be an increasingly better
approximation of 1/3.

In the same way, no matter how many base 2 digits you’re willing to use,
the decimal value 0.1 cannot be represented exactly as a base 2
fraction.  In base 2, 1/10 is the infinitely repeating fraction

     0.0001100110011001100110011001100110011001100110011...

Stop at any finite number of bits, and you get an approximation.  On
most machines today, floats are approximated using a binary fraction
with the numerator using the first 53 bits starting with the most
significant bit and with the denominator as a power of two.  In the case
of 1/10, the binary fraction is ‘3602879701896397 / 2 ** 55’ which is
close to but not exactly equal to the true value of 1/10.

Many users are not aware of the approximation because of the way values
are displayed.  Python only prints a decimal approximation to the true
decimal value of the binary approximation stored by the machine.  On
most machines, if Python were to print the true decimal value of the
binary approximation stored for 0.1, it would have to display

     >>> 0.1
     0.1000000000000000055511151231257827021181583404541015625

That is more digits than most people find useful, so Python keeps the
number of digits manageable by displaying a rounded value instead

     >>> 1 / 10
     0.1

Just remember, even though the printed result looks like the exact value
of 1/10, the actual stored value is the nearest representable binary
fraction.

Interestingly, there are many different decimal numbers that share the
same nearest approximate binary fraction.  For example, the numbers
‘0.1’ and ‘0.10000000000000001’ and
‘0.1000000000000000055511151231257827021181583404541015625’ are all
approximated by ‘3602879701896397 / 2 ** 55’.  Since all of these
decimal values share the same approximation, any one of them could be
displayed while still preserving the invariant ‘eval(repr(x)) == x’.

Historically, the Python prompt and built-in *note repr(): 7c0. function
would choose the one with 17 significant digits, ‘0.10000000000000001’.
Starting with Python 3.1, Python (on most systems) is now able to choose
the shortest of these and simply display ‘0.1’.

Note that this is in the very nature of binary floating-point: this is
not a bug in Python, and it is not a bug in your code either.  You’ll
see the same kind of thing in all languages that support your hardware’s
floating-point arithmetic (although some languages may not `display' the
difference by default, or in all output modes).

For more pleasant output, you may wish to use string formatting to
produce a limited number of significant digits:

     >>> format(math.pi, '.12g')  # give 12 significant digits
     '3.14159265359'

     >>> format(math.pi, '.2f')   # give 2 digits after the point
     '3.14'

     >>> repr(math.pi)
     '3.141592653589793'

It’s important to realize that this is, in a real sense, an illusion:
you’re simply rounding the `display' of the true machine value.

One illusion may beget another.  For example, since 0.1 is not exactly
1/10, summing three values of 0.1 may not yield exactly 0.3, either:

     >>> .1 + .1 + .1 == .3
     False

Also, since the 0.1 cannot get any closer to the exact value of 1/10 and
0.3 cannot get any closer to the exact value of 3/10, then pre-rounding
with *note round(): c60. function cannot help:

     >>> round(.1, 1) + round(.1, 1) + round(.1, 1) == round(.3, 1)
     False

Though the numbers cannot be made closer to their intended exact values,
the *note round(): c60. function can be useful for post-rounding so that
results with inexact values become comparable to one another:

     >>> round(.1 + .1 + .1, 10) == round(.3, 10)
     True

Binary floating-point arithmetic holds many surprises like this.  The
problem with “0.1” is explained in precise detail below, in the
“Representation Error” section.  See The Perils of Floating Point(1) for
a more complete account of other common surprises.

As that says near the end, “there are no easy answers.” Still, don’t be
unduly wary of floating-point!  The errors in Python float operations
are inherited from the floating-point hardware, and on most machines are
on the order of no more than 1 part in 2**53 per operation.  That’s more
than adequate for most tasks, but you do need to keep in mind that it’s
not decimal arithmetic and that every float operation can suffer a new
rounding error.

While pathological cases do exist, for most casual use of floating-point
arithmetic you’ll see the result you expect in the end if you simply
round the display of your final results to the number of decimal digits
you expect.  *note str(): 325. usually suffices, and for finer control
see the *note str.format(): 4cf. method’s format specifiers in *note
Format String Syntax: d0d.

For use cases which require exact decimal representation, try using the
*note decimal: 36. module which implements decimal arithmetic suitable
for accounting applications and high-precision applications.

Another form of exact arithmetic is supported by the *note fractions:
83. module which implements arithmetic based on rational numbers (so the
numbers like 1/3 can be represented exactly).

If you are a heavy user of floating point operations you should take a
look at the Numerical Python package and many other packages for
mathematical and statistical operations supplied by the SciPy project.
See <‘https://scipy.org’>.

Python provides tools that may help on those rare occasions when you
really `do' want to know the exact value of a float.  The *note
float.as_integer_ratio(): 125d. method expresses the value of a float as
a fraction:

     >>> x = 3.14159
     >>> x.as_integer_ratio()
     (3537115888337719, 1125899906842624)

Since the ratio is exact, it can be used to losslessly recreate the
original value:

     >>> x == 3537115888337719 / 1125899906842624
     True

The *note float.hex(): 125e. method expresses a float in hexadecimal
(base 16), again giving the exact value stored by your computer:

     >>> x.hex()
     '0x1.921f9f01b866ep+1'

This precise hexadecimal representation can be used to reconstruct the
float value exactly:

     >>> x == float.fromhex('0x1.921f9f01b866ep+1')
     True

Since the representation is exact, it is useful for reliably porting
values across different versions of Python (platform independence) and
exchanging data with other languages that support the same format (such
as Java and C99).

Another helpful tool is the *note math.fsum(): d31. function which helps
mitigate loss-of-precision during summation.  It tracks “lost digits” as
values are added onto a running total.  That can make a difference in
overall accuracy so that the errors do not accumulate to the point where
they affect the final total:

     >>> sum([0.1] * 10) == 1.0
     False
     >>> math.fsum([0.1] * 10) == 1.0
     True

* Menu:

* Representation Error::

   ---------- Footnotes ----------

   (1) http://www.lahey.com/float.htm


File: python.info,  Node: Representation Error,  Up: Floating Point Arithmetic Issues and Limitations

2.15.1 Representation Error
---------------------------

This section explains the “0.1” example in detail, and shows how you can
perform an exact analysis of cases like this yourself.  Basic
familiarity with binary floating-point representation is assumed.

`Representation error' refers to the fact that some (most, actually)
decimal fractions cannot be represented exactly as binary (base 2)
fractions.  This is the chief reason why Python (or Perl, C, C++, Java,
Fortran, and many others) often won’t display the exact decimal number
you expect.

Why is that?  1/10 is not exactly representable as a binary fraction.
Almost all machines today (November 2000) use IEEE-754 floating point
arithmetic, and almost all platforms map Python floats to IEEE-754
“double precision”.  754 doubles contain 53 bits of precision, so on
input the computer strives to convert 0.1 to the closest fraction it can
of the form `J'/2**`N' where `J' is an integer containing exactly 53
bits.  Rewriting

     1 / 10 ~= J / (2**N)

as

     J ~= 2**N / 10

and recalling that `J' has exactly 53 bits (is ‘>= 2**52’ but ‘<
2**53’), the best value for `N' is 56:

     >>> 2**52 <=  2**56 // 10  < 2**53
     True

That is, 56 is the only value for `N' that leaves `J' with exactly 53
bits.  The best possible value for `J' is then that quotient rounded:

     >>> q, r = divmod(2**56, 10)
     >>> r
     6

Since the remainder is more than half of 10, the best approximation is
obtained by rounding up:

     >>> q+1
     7205759403792794

Therefore the best possible approximation to 1/10 in 754 double
precision is:

     7205759403792794 / 2 ** 56

Dividing both the numerator and denominator by two reduces the fraction
to:

     3602879701896397 / 2 ** 55

Note that since we rounded up, this is actually a little bit larger than
1/10; if we had not rounded up, the quotient would have been a little
bit smaller than 1/10.  But in no case can it be `exactly' 1/10!

So the computer never “sees” 1/10: what it sees is the exact fraction
given above, the best 754 double approximation it can get:

     >>> 0.1 * 2 ** 55
     3602879701896397.0

If we multiply that fraction by 10**55, we can see the value out to 55
decimal digits:

     >>> 3602879701896397 * 10 ** 55 // 2 ** 55
     1000000000000000055511151231257827021181583404541015625

meaning that the exact number stored in the computer is equal to the
decimal value 0.1000000000000000055511151231257827021181583404541015625.
Instead of displaying the full decimal value, many languages (including
older versions of Python), round the result to 17 significant digits:

     >>> format(0.1, '.17f')
     '0.10000000000000001'

The *note fractions: 83. and *note decimal: 36. modules make these
calculations easy:

     >>> from decimal import Decimal
     >>> from fractions import Fraction

     >>> Fraction.from_float(0.1)
     Fraction(3602879701896397, 36028797018963968)

     >>> (0.1).as_integer_ratio()
     (3602879701896397, 36028797018963968)

     >>> Decimal.from_float(0.1)
     Decimal('0.1000000000000000055511151231257827021181583404541015625')

     >>> format(Decimal.from_float(0.1), '.17')
     '0.10000000000000001'


File: python.info,  Node: Appendix,  Prev: Floating Point Arithmetic Issues and Limitations,  Up: The Python Tutorial

2.16 Appendix
=============

* Menu:

* Interactive Mode: Interactive Mode<2>.


File: python.info,  Node: Interactive Mode<2>,  Up: Appendix

2.16.1 Interactive Mode
-----------------------

* Menu:

* Error Handling::
* Executable Python Scripts::
* The Interactive Startup File::
* The Customization Modules::


File: python.info,  Node: Error Handling,  Next: Executable Python Scripts,  Up: Interactive Mode<2>

2.16.1.1 Error Handling
.......................

When an error occurs, the interpreter prints an error message and a
stack trace.  In interactive mode, it then returns to the primary
prompt; when input came from a file, it exits with a nonzero exit status
after printing the stack trace.  (Exceptions handled by an *note except:
b31. clause in a *note try: d65. statement are not errors in this
context.)  Some errors are unconditionally fatal and cause an exit with
a nonzero exit; this applies to internal inconsistencies and some cases
of running out of memory.  All error messages are written to the
standard error stream; normal output from executed commands is written
to standard output.

Typing the interrupt character (usually ‘Control-C’ or ‘Delete’) to the
primary or secondary prompt cancels the input and returns to the primary
prompt.  (1) Typing an interrupt while a command is executing raises the
*note KeyboardInterrupt: 197. exception, which may be handled by a *note
try: d65. statement.

   ---------- Footnotes ----------

   (1) (1) A problem with the GNU Readline package may prevent this.


File: python.info,  Node: Executable Python Scripts,  Next: The Interactive Startup File,  Prev: Error Handling,  Up: Interactive Mode<2>

2.16.1.2 Executable Python Scripts
..................................

On BSD’ish Unix systems, Python scripts can be made directly executable,
like shell scripts, by putting the line

     #!/usr/bin/env python3.5

(assuming that the interpreter is on the user’s ‘PATH’) at the beginning
of the script and giving the file an executable mode.  The ‘#!’ must be
the first two characters of the file.  On some platforms, this first
line must end with a Unix-style line ending (‘'\n'’), not a Windows
(‘'\r\n'’) line ending.  Note that the hash, or pound, character, ‘'#'’,
is used to start a comment in Python.

The script can be given an executable mode, or permission, using the
‘chmod’ command.

     $ chmod +x myscript.py

On Windows systems, there is no notion of an “executable mode”.  The
Python installer automatically associates ‘.py’ files with ‘python.exe’
so that a double-click on a Python file will run it as a script.  The
extension can also be ‘.pyw’, in that case, the console window that
normally appears is suppressed.


File: python.info,  Node: The Interactive Startup File,  Next: The Customization Modules,  Prev: Executable Python Scripts,  Up: Interactive Mode<2>

2.16.1.3 The Interactive Startup File
.....................................

When you use Python interactively, it is frequently handy to have some
standard commands executed every time the interpreter is started.  You
can do this by setting an environment variable named *note
PYTHONSTARTUP: 8d9. to the name of a file containing your start-up
commands.  This is similar to the ‘.profile’ feature of the Unix shells.

This file is only read in interactive sessions, not when Python reads
commands from a script, and not when ‘/dev/tty’ is given as the explicit
source of commands (which otherwise behaves like an interactive
session).  It is executed in the same namespace where interactive
commands are executed, so that objects that it defines or imports can be
used without qualification in the interactive session.  You can also
change the prompts ‘sys.ps1’ and ‘sys.ps2’ in this file.

If you want to read an additional start-up file from the current
directory, you can program this in the global start-up file using code
like ‘if os.path.isfile('.pythonrc.py'):
exec(open('.pythonrc.py').read())’.  If you want to use the startup file
in a script, you must do this explicitly in the script:

     import os
     filename = os.environ.get('PYTHONSTARTUP')
     if filename and os.path.isfile(filename):
         with open(filename) as fobj:
             startup_file = fobj.read()
         exec(startup_file)


File: python.info,  Node: The Customization Modules,  Prev: The Interactive Startup File,  Up: Interactive Mode<2>

2.16.1.4 The Customization Modules
..................................

Python provides two hooks to let you customize it: ‘sitecustomize’ and
‘usercustomize’.  To see how it works, you need first to find the
location of your user site-packages directory.  Start Python and run
this code:

     >>> import site
     >>> site.getusersitepackages()
     '/home/user/.local/lib/python3.5/site-packages'

Now you can create a file named ‘usercustomize.py’ in that directory and
put anything you want in it.  It will affect every invocation of Python,
unless it is started with the *note -s: d08. option to disable the
automatic import.

‘sitecustomize’ works in the same way, but is typically created by an
administrator of the computer in the global site-packages directory, and
is imported before ‘usercustomize’.  See the documentation of the *note
site: eb. module for more details.


File: python.info,  Node: Python Setup and Usage,  Next: The Python Language Reference,  Prev: The Python Tutorial,  Up: Top

3 Python Setup and Usage
************************

This part of the documentation is devoted to general information on the
setup of the Python environment on different platforms, the invocation
of the interpreter and things that make working with Python easier.

* Menu:

* Command line and environment::
* Using Python on Unix platforms::
* Using Python on Windows::
* Using Python on a Macintosh::
* Editors and IDEs::


File: python.info,  Node: Command line and environment,  Next: Using Python on Unix platforms,  Up: Python Setup and Usage

3.1 Command line and environment
================================

The CPython interpreter scans the command line and the environment for
various settings.

`CPython implementation detail:' Other implementations’ command line
schemes may differ.  See *note Alternate Implementations: 1271. for
further resources.

* Menu:

* Command line::
* Environment variables::


File: python.info,  Node: Command line,  Next: Environment variables,  Up: Command line and environment

3.1.1 Command line
------------------

When invoking Python, you may specify any of these options:

     python [-bBdEhiIOqsSuvVWx?] [-c command | -m module-name | script | - ] [args]

The most common use case is, of course, a simple invocation of a script:

     python myscript.py

* Menu:

* Interface options::
* Generic options::
* Miscellaneous options::
* Options you shouldn’t use::


File: python.info,  Node: Interface options,  Next: Generic options,  Up: Command line

3.1.1.1 Interface options
.........................

The interpreter interface resembles that of the UNIX shell, but provides
some additional methods of invocation:

   * When called with standard input connected to a tty device, it
     prompts for commands and executes them until an EOF (an end-of-file
     character, you can produce that with ‘Ctrl-D’ on UNIX or ‘Ctrl-Z,
     Enter’ on Windows) is read.

   * When called with a file name argument or with a file as standard
     input, it reads and executes a script from that file.

   * When called with a directory name argument, it reads and executes
     an appropriately named script from that directory.

   * When called with ‘-c command’, it executes the Python statement(s)
     given as `command'.  Here `command' may contain multiple statements
     separated by newlines.  Leading whitespace is significant in Python
     statements!

   * When called with ‘-m module-name’, the given module is located on
     the Python module path and executed as a script.

In non-interactive mode, the entire input is parsed before it is
executed.

An interface option terminates the list of options consumed by the
interpreter, all consecutive arguments will end up in *note sys.argv:
bee. – note that the first element, subscript zero (‘sys.argv[0]’), is a
string reflecting the program’s source.

 -- Program Option: -c <command>

     Execute the Python code in `command'.  `command' can be one or more
     statements separated by newlines, with significant leading
     whitespace as in normal module code.

     If this option is given, the first element of *note sys.argv: bee.
     will be ‘"-c"’ and the current directory will be added to the start
     of *note sys.path: 47d. (allowing modules in that directory to be
     imported as top level modules).

     Raises an *note auditing event: 1275. ‘cpython.run_command’ with
     argument ‘command’.

 -- Program Option: -m <module-name>

     Search *note sys.path: 47d. for the named module and execute its
     contents as the *note __main__: 1. module.

     Since the argument is a `module' name, you must not give a file
     extension (‘.py’).  The module name should be a valid absolute
     Python module name, but the implementation may not always enforce
     this (e.g.  it may allow you to use a name that includes a hyphen).

     Package names (including namespace packages) are also permitted.
     When a package name is supplied instead of a normal module, the
     interpreter will execute ‘<pkg>.__main__’ as the main module.  This
     behaviour is deliberately similar to the handling of directories
     and zipfiles that are passed to the interpreter as the script
     argument.

          Note: This option cannot be used with built-in modules and
          extension modules written in C, since they do not have Python
          module files.  However, it can still be used for precompiled
          modules, even if the original source file is not available.

     If this option is given, the first element of *note sys.argv: bee.
     will be the full path to the module file (while the module file is
     being located, the first element will be set to ‘"-m"’).  As with
     the *note -c: 1145. option, the current directory will be added to
     the start of *note sys.path: 47d.

     *note -I: f3c. option can be used to run the script in isolated
     mode where *note sys.path: 47d. contains neither the current
     directory nor the user’s site-packages directory.  All ‘PYTHON*’
     environment variables are ignored, too.

     Many standard library modules contain code that is invoked on their
     execution as a script.  An example is the *note timeit: 10b.
     module:

          python -mtimeit -s 'setup here' 'benchmarked code here'
          python -mtimeit -h # for details

     Raises an *note auditing event: 1275. ‘cpython.run_module’ with
     argument ‘module-name’.

     See also
     ........

     *note runpy.run_module(): 1276.

          Equivalent functionality directly available to Python code

     PEP 338(1) – Executing modules as scripts

     Changed in version 3.1: Supply the package name to run a ‘__main__’
     submodule.

     Changed in version 3.4: namespace packages are also supported

 -- Describe: -

     Read commands from standard input (*note sys.stdin: 302.).  If
     standard input is a terminal, *note -i: e12. is implied.

     If this option is given, the first element of *note sys.argv: bee.
     will be ‘"-"’ and the current directory will be added to the start
     of *note sys.path: 47d.

     Raises an *note auditing event: 1275. ‘cpython.run_stdin’ with no
     arguments.

 -- Describe: <script>

     Execute the Python code contained in `script', which must be a
     filesystem path (absolute or relative) referring to either a Python
     file, a directory containing a ‘__main__.py’ file, or a zipfile
     containing a ‘__main__.py’ file.

     If this option is given, the first element of *note sys.argv: bee.
     will be the script name as given on the command line.

     If the script name refers directly to a Python file, the directory
     containing that file is added to the start of *note sys.path: 47d,
     and the file is executed as the *note __main__: 1. module.

     If the script name refers to a directory or zipfile, the script
     name is added to the start of *note sys.path: 47d. and the
     ‘__main__.py’ file in that location is executed as the *note
     __main__: 1. module.

     *note -I: f3c. option can be used to run the script in isolated
     mode where *note sys.path: 47d. contains neither the script’s
     directory nor the user’s site-packages directory.  All ‘PYTHON*’
     environment variables are ignored, too.

     Raises an *note auditing event: 1275. ‘cpython.run_file’ with
     argument ‘filename’.

     See also
     ........

     *note runpy.run_path(): ca4.

          Equivalent functionality directly available to Python code

If no interface option is given, *note -i: e12. is implied,
‘sys.argv[0]’ is an empty string (‘""’) and the current directory will
be added to the start of *note sys.path: 47d.  Also, tab-completion and
history editing is automatically enabled, if available on your platform
(see *note Readline configuration: 8da.).

See also
........

*note Invoking the Interpreter: 1141.

Changed in version 3.4: Automatic enabling of tab-completion and history
editing.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0338


File: python.info,  Node: Generic options,  Next: Miscellaneous options,  Prev: Interface options,  Up: Command line

3.1.1.2 Generic options
.......................

 -- Program Option: -?
 -- Program Option: -h
 -- Program Option: --help

     Print a short description of all command line options.

 -- Program Option: -V
 -- Program Option: --version

     Print the Python version number and exit.  Example output could be:

          Python 3.8.0b2+

     When given twice, print more information about the build, like:

          Python 3.8.0b2+ (3.8:0c076caaa8, Apr 20 2019, 21:55:00)
          [GCC 6.2.0 20161005]

     New in version 3.6: The ‘-VV’ option.


File: python.info,  Node: Miscellaneous options,  Next: Options you shouldn’t use,  Prev: Generic options,  Up: Command line

3.1.1.3 Miscellaneous options
.............................

 -- Program Option: -b

     Issue a warning when comparing *note bytes: 326. or *note
     bytearray: 327. with *note str: 325. or *note bytes: 326. with
     *note int: 184.  Issue an error when the option is given twice
     (‘-bb’).

     Changed in version 3.5: Affects comparisons of *note bytes: 326.
     with *note int: 184.

 -- Program Option: -B

     If given, Python won’t try to write ‘.pyc’ files on the import of
     source modules.  See also *note PYTHONDONTWRITEBYTECODE: d2c.

 -- Program Option: --check-hash-based-pycs default|always|never

     Control the validation behavior of hash-based ‘.pyc’ files.  See
     *note Cached bytecode invalidation: 31e.  When set to ‘default’,
     checked and unchecked hash-based bytecode cache files are validated
     according to their default semantics.  When set to ‘always’, all
     hash-based ‘.pyc’ files, whether checked or unchecked, are
     validated against their corresponding source file.  When set to
     ‘never’, hash-based ‘.pyc’ files are not validated against their
     corresponding source files.

     The semantics of timestamp-based ‘.pyc’ files are unaffected by
     this option.

 -- Program Option: -d

     Turn on parser debugging output (for expert only, depending on
     compilation options).  See also *note PYTHONDEBUG: 127e.

 -- Program Option: -E

     Ignore all ‘PYTHON*’ environment variables, e.g.  *note PYTHONPATH:
     947. and *note PYTHONHOME: 4cb, that might be set.

 -- Program Option: -i

     When a script is passed as first argument or the *note -c: 1145.
     option is used, enter interactive mode after executing the script
     or the command, even when *note sys.stdin: 302. does not appear to
     be a terminal.  The *note PYTHONSTARTUP: 8d9. file is not read.

     This can be useful to inspect global variables or a stack trace
     when a script raises an exception.  See also *note PYTHONINSPECT:
     e11.

 -- Program Option: -I

     Run Python in isolated mode.  This also implies -E and -s.  In
     isolated mode *note sys.path: 47d. contains neither the script’s
     directory nor the user’s site-packages directory.  All ‘PYTHON*’
     environment variables are ignored, too.  Further restrictions may
     be imposed to prevent the user from injecting malicious code.

     New in version 3.4.

 -- Program Option: -O

     Remove assert statements and any code conditional on the value of
     *note __debug__: f30.  Augment the filename for compiled (*note
     bytecode: 609.) files by adding ‘.opt-1’ before the ‘.pyc’
     extension (see PEP 488(1)).  See also *note PYTHONOPTIMIZE: 127f.

     Changed in version 3.5: Modify ‘.pyc’ filenames according to PEP
     488(2).

 -- Program Option: -OO

     Do *note -O: 67f. and also discard docstrings.  Augment the
     filename for compiled (*note bytecode: 609.) files by adding
     ‘.opt-2’ before the ‘.pyc’ extension (see PEP 488(3)).

     Changed in version 3.5: Modify ‘.pyc’ filenames according to PEP
     488(4).

 -- Program Option: -q

     Don’t display the copyright and version messages even in
     interactive mode.

     New in version 3.2.

 -- Program Option: -R

     Turn on hash randomization.  This option only has an effect if the
     *note PYTHONHASHSEED: 9b9. environment variable is set to ‘0’,
     since hash randomization is enabled by default.

     On previous versions of Python, this option turns on hash
     randomization, so that the *note __hash__(): 335. values of str and
     bytes objects are “salted” with an unpredictable random value.
     Although they remain constant within an individual Python process,
     they are not predictable between repeated invocations of Python.

     Hash randomization is intended to provide protection against a
     denial-of-service caused by carefully-chosen inputs that exploit
     the worst case performance of a dict construction, O(n^2)
     complexity.  See
     ‘http://www.ocert.org/advisories/ocert-2011-003.html’ for details.

     *note PYTHONHASHSEED: 9b9. allows you to set a fixed value for the
     hash seed secret.

     Changed in version 3.7: The option is no longer ignored.

     New in version 3.2.3.

 -- Program Option: -s

     Don’t add the *note user site-packages directory: 1281. to *note
     sys.path: 47d.

     See also
     ........

     PEP 370(5) – Per user site-packages directory

 -- Program Option: -S

     Disable the import of the module *note site: eb. and the
     site-dependent manipulations of *note sys.path: 47d. that it
     entails.  Also disable these manipulations if *note site: eb. is
     explicitly imported later (call *note site.main(): 1282. if you
     want them to be triggered).

 -- Program Option: -u

     Force the stdout and stderr streams to be unbuffered.  This option
     has no effect on the stdin stream.

     See also *note PYTHONUNBUFFERED: 1284.

     Changed in version 3.7: The text layer of the stdout and stderr
     streams now is unbuffered.

 -- Program Option: -v

     Print a message each time a module is initialized, showing the
     place (filename or built-in module) from which it is loaded.  When
     given twice (‘-vv’), print a message for each file that is checked
     for when searching for a module.  Also provides information on
     module cleanup at exit.  See also *note PYTHONVERBOSE: 1285.
 -- Program Option: -W arg

     Warning control.  Python’s warning machinery by default prints
     warning messages to *note sys.stderr: 304.  A typical warning
     message has the following form:

          file:line: category: message

     By default, each warning is printed once for each source line where
     it occurs.  This option controls how often warnings are printed.

     Multiple *note -W: 40c. options may be given; when a warning
     matches more than one option, the action for the last matching
     option is performed.  Invalid *note -W: 40c. options are ignored
     (though, a warning message is printed about invalid options when
     the first warning is issued).

     Warnings can also be controlled using the *note PYTHONWARNINGS:
     40d. environment variable and from within a Python program using
     the *note warnings: 126. module.

     The simplest settings apply a particular action unconditionally to
     all warnings emitted by a process (even those that are otherwise
     ignored by default):

          -Wdefault  # Warn once per call location
          -Werror    # Convert to exceptions
          -Walways   # Warn every time
          -Wmodule   # Warn once per calling module
          -Wonce     # Warn once per Python process
          -Wignore   # Never warn

     The action names can be abbreviated as desired (e.g.  ‘-Wi’, ‘-Wd’,
     ‘-Wa’, ‘-We’) and the interpreter will resolve them to the
     appropriate action name.

     See *note The Warnings Filter: 1287. and *note Describing Warning
     Filters: 1288. for more details.

 -- Program Option: -x

     Skip the first line of the source, allowing use of non-Unix forms
     of ‘#!cmd’.  This is intended for a DOS specific hack only.

 -- Program Option: -X

     Reserved for various implementation-specific options.  CPython
     currently defines the following possible values:

        * ‘-X faulthandler’ to enable *note faulthandler: 7d.;

        * ‘-X showrefcount’ to output the total reference count and
          number of used memory blocks when the program finishes or
          after each statement in the interactive interpreter.  This
          only works on debug builds.

        * ‘-X tracemalloc’ to start tracing Python memory allocations
          using the *note tracemalloc: 114. module.  By default, only
          the most recent frame is stored in a traceback of a trace.
          Use ‘-X tracemalloc=NFRAME’ to start tracing with a traceback
          limit of `NFRAME' frames.  See the *note tracemalloc.start():
          128a. for more information.

        * ‘-X showalloccount’ to output the total count of allocated
          objects for each type when the program finishes.  This only
          works when Python was built with ‘COUNT_ALLOCS’ defined.

        * ‘-X importtime’ to show how long each import takes.  It shows
          module name, cumulative time (including nested imports) and
          self time (excluding nested imports).  Note that its output
          may be broken in multi-threaded application.  Typical usage is
          ‘python3 -X importtime -c 'import asyncio'’.  See also *note
          PYTHONPROFILEIMPORTTIME: 32d.

        * ‘-X dev’: enable CPython’s “development mode”, introducing
          additional runtime checks which are too expensive to be
          enabled by default.  It should not be more verbose than the
          default if the code is correct: new warnings are only emitted
          when an issue is detected.  Effect of the developer mode:

             * Add ‘default’ warning filter, as *note -W: 40c.
               ‘default’.

             * Install debug hooks on memory allocators: see the *note
               PyMem_SetupDebugHooks(): 4ff. C function.

             * Enable the *note faulthandler: 7d. module to dump the
               Python traceback on a crash.

             * Enable *note asyncio debug mode: 128b.

             * Set the ‘dev_mode’ attribute of *note sys.flags: b2f. to
               ‘True’.

             * *note io.IOBase: 1d9. destructor logs ‘close()’
               exceptions.

        * ‘-X utf8’ enables UTF-8 mode for operating system interfaces,
          overriding the default locale-aware mode.  ‘-X utf8=0’
          explicitly disables UTF-8 mode (even when it would otherwise
          activate automatically).  See *note PYTHONUTF8: 306. for more
          details.

        * ‘-X pycache_prefix=PATH’ enables writing ‘.pyc’ files to a
          parallel tree rooted at the given directory instead of to the
          code tree.  See also *note PYTHONPYCACHEPREFIX: 154.

     It also allows passing arbitrary values and retrieving them through
     the *note sys._xoptions: 128c. dictionary.

     Changed in version 3.2: The *note -X: 155. option was added.

     New in version 3.3: The ‘-X faulthandler’ option.

     New in version 3.4: The ‘-X showrefcount’ and ‘-X tracemalloc’
     options.

     New in version 3.6: The ‘-X showalloccount’ option.

     New in version 3.7: The ‘-X importtime’, ‘-X dev’ and ‘-X utf8’
     options.

     New in version 3.8: The ‘-X pycache_prefix’ option.  The ‘-X dev’
     option now logs ‘close()’ exceptions in *note io.IOBase: 1d9.
     destructor.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0488

   (2) https://www.python.org/dev/peps/pep-0488

   (3) https://www.python.org/dev/peps/pep-0488

   (4) https://www.python.org/dev/peps/pep-0488

   (5) https://www.python.org/dev/peps/pep-0370


File: python.info,  Node: Options you shouldn’t use,  Prev: Miscellaneous options,  Up: Command line

3.1.1.4 Options you shouldn’t use
.................................

 -- Program Option: -J

     Reserved for use by Jython(1).

   ---------- Footnotes ----------

   (1) http://www.jython.org/


File: python.info,  Node: Environment variables,  Prev: Command line,  Up: Command line and environment

3.1.2 Environment variables
---------------------------

These environment variables influence Python’s behavior, they are
processed before the command-line switches other than -E or -I. It is
customary that command-line switches override environmental variables
where there is a conflict.

 -- Environment Variable: PYTHONHOME

     Change the location of the standard Python libraries.  By default,
     the libraries are searched in ‘`prefix'/lib/python`version'’ and
     ‘`exec_prefix'/lib/python`version'’, where ‘`prefix'’ and
     ‘`exec_prefix'’ are installation-dependent directories, both
     defaulting to ‘/usr/local’.

     When *note PYTHONHOME: 4cb. is set to a single directory, its value
     replaces both ‘`prefix'’ and ‘`exec_prefix'’.  To specify different
     values for these, set *note PYTHONHOME: 4cb. to
     ‘`prefix':`exec_prefix'’.

 -- Environment Variable: PYTHONPATH

     Augment the default search path for module files.  The format is
     the same as the shell’s ‘PATH’: one or more directory pathnames
     separated by *note os.pathsep: 1290. (e.g.  colons on Unix or
     semicolons on Windows).  Non-existent directories are silently
     ignored.

     In addition to normal directories, individual *note PYTHONPATH:
     947. entries may refer to zipfiles containing pure Python modules
     (in either source or compiled form).  Extension modules cannot be
     imported from zipfiles.

     The default search path is installation dependent, but generally
     begins with ‘`prefix'/lib/python`version'’ (see *note PYTHONHOME:
     4cb. above).  It is `always' appended to *note PYTHONPATH: 947.

     An additional directory will be inserted in the search path in
     front of *note PYTHONPATH: 947. as described above under *note
     Interface options: 1274.  The search path can be manipulated from
     within a Python program as the variable *note sys.path: 47d.

 -- Environment Variable: PYTHONSTARTUP

     If this is the name of a readable file, the Python commands in that
     file are executed before the first prompt is displayed in
     interactive mode.  The file is executed in the same namespace where
     interactive commands are executed so that objects defined or
     imported in it can be used without qualification in the interactive
     session.  You can also change the prompts *note sys.ps1: 1291. and
     *note sys.ps2: 1292. and the hook *note sys.__interactivehook__:
     8d8. in this file.

     Raises an *note auditing event: 1275. ‘cpython.run_startup’ with
     the filename as the argument when called on startup.

 -- Environment Variable: PYTHONOPTIMIZE

     If this is set to a non-empty string it is equivalent to specifying
     the *note -O: 67f. option.  If set to an integer, it is equivalent
     to specifying *note -O: 67f. multiple times.

 -- Environment Variable: PYTHONBREAKPOINT

     If this is set, it names a callable using dotted-path notation.
     The module containing the callable will be imported and then the
     callable will be run by the default implementation of *note
     sys.breakpointhook(): 308. which itself is called by built-in *note
     breakpoint(): 2ee.  If not set, or set to the empty string, it is
     equivalent to the value “pdb.set_trace”.  Setting this to the
     string “0” causes the default implementation of *note
     sys.breakpointhook(): 308. to do nothing but return immediately.

     New in version 3.7.

 -- Environment Variable: PYTHONDEBUG

     If this is set to a non-empty string it is equivalent to specifying
     the *note -d: 127d. option.  If set to an integer, it is equivalent
     to specifying *note -d: 127d. multiple times.

 -- Environment Variable: PYTHONINSPECT

     If this is set to a non-empty string it is equivalent to specifying
     the *note -i: e12. option.

     This variable can also be modified by Python code using *note
     os.environ: b2a. to force inspect mode on program termination.

 -- Environment Variable: PYTHONUNBUFFERED

     If this is set to a non-empty string it is equivalent to specifying
     the *note -u: 1283. option.

 -- Environment Variable: PYTHONVERBOSE

     If this is set to a non-empty string it is equivalent to specifying
     the *note -v: d7b. option.  If set to an integer, it is equivalent
     to specifying *note -v: d7b. multiple times.

 -- Environment Variable: PYTHONCASEOK

     If this is set, Python ignores case in *note import: c10.
     statements.  This only works on Windows and OS X.

 -- Environment Variable: PYTHONDONTWRITEBYTECODE

     If this is set to a non-empty string, Python won’t try to write
     ‘.pyc’ files on the import of source modules.  This is equivalent
     to specifying the *note -B: d2b. option.

 -- Environment Variable: PYTHONPYCACHEPREFIX

     If this is set, Python will write ‘.pyc’ files in a mirror
     directory tree at this path, instead of in ‘__pycache__’
     directories within the source tree.  This is equivalent to
     specifying the *note -X: 155. ‘pycache_prefix=PATH’ option.

     New in version 3.8.

 -- Environment Variable: PYTHONHASHSEED

     If this variable is not set or set to ‘random’, a random value is
     used to seed the hashes of str and bytes objects.

     If *note PYTHONHASHSEED: 9b9. is set to an integer value, it is
     used as a fixed seed for generating the hash() of the types covered
     by the hash randomization.

     Its purpose is to allow repeatable hashing, such as for selftests
     for the interpreter itself, or to allow a cluster of python
     processes to share hash values.

     The integer must be a decimal number in the range [0,4294967295].
     Specifying the value 0 will disable hash randomization.

     New in version 3.2.3.

 -- Environment Variable: PYTHONIOENCODING

     If this is set before running the interpreter, it overrides the
     encoding used for stdin/stdout/stderr, in the syntax
     ‘encodingname:errorhandler’.  Both the ‘encodingname’ and the
     ‘:errorhandler’ parts are optional and have the same meaning as in
     *note str.encode(): c2a.

     For stderr, the ‘:errorhandler’ part is ignored; the handler will
     always be ‘'backslashreplace'’.

     Changed in version 3.4: The ‘encodingname’ part is now optional.

     Changed in version 3.6: On Windows, the encoding specified by this
     variable is ignored for interactive console buffers unless *note
     PYTHONLEGACYWINDOWSSTDIO: 4ef. is also specified.  Files and pipes
     redirected through the standard streams are not affected.

 -- Environment Variable: PYTHONNOUSERSITE

     If this is set, Python won’t add the *note user site-packages
     directory: 1281. to *note sys.path: 47d.

     See also
     ........

     PEP 370(1) – Per user site-packages directory

 -- Environment Variable: PYTHONUSERBASE

     Defines the *note user base directory: 1293, which is used to
     compute the path of the *note user site-packages directory: 1281.
     and *note Distutils installation paths: 1294. for ‘python setup.py
     install --user’.

     See also
     ........

     PEP 370(2) – Per user site-packages directory

 -- Environment Variable: PYTHONEXECUTABLE

     If this environment variable is set, ‘sys.argv[0]’ will be set to
     its value instead of the value got through the C runtime.  Only
     works on Mac OS X.

 -- Environment Variable: PYTHONWARNINGS

     This is equivalent to the *note -W: 40c. option.  If set to a comma
     separated string, it is equivalent to specifying *note -W: 40c.
     multiple times, with filters later in the list taking precedence
     over those earlier in the list.

     The simplest settings apply a particular action unconditionally to
     all warnings emitted by a process (even those that are otherwise
     ignored by default):

          PYTHONWARNINGS=default  # Warn once per call location
          PYTHONWARNINGS=error    # Convert to exceptions
          PYTHONWARNINGS=always   # Warn every time
          PYTHONWARNINGS=module   # Warn once per calling module
          PYTHONWARNINGS=once     # Warn once per Python process
          PYTHONWARNINGS=ignore   # Never warn

     See *note The Warnings Filter: 1287. and *note Describing Warning
     Filters: 1288. for more details.

 -- Environment Variable: PYTHONFAULTHANDLER

     If this environment variable is set to a non-empty string, *note
     faulthandler.enable(): 53d. is called at startup: install a handler
     for ‘SIGSEGV’, ‘SIGFPE’, ‘SIGABRT’, ‘SIGBUS’ and ‘SIGILL’ signals
     to dump the Python traceback.  This is equivalent to *note -X: 155.
     ‘faulthandler’ option.

     New in version 3.3.

 -- Environment Variable: PYTHONTRACEMALLOC

     If this environment variable is set to a non-empty string, start
     tracing Python memory allocations using the *note tracemalloc: 114.
     module.  The value of the variable is the maximum number of frames
     stored in a traceback of a trace.  For example,
     ‘PYTHONTRACEMALLOC=1’ stores only the most recent frame.  See the
     *note tracemalloc.start(): 128a. for more information.

     New in version 3.4.

 -- Environment Variable: PYTHONPROFILEIMPORTTIME

     If this environment variable is set to a non-empty string, Python
     will show how long each import takes.  This is exactly equivalent
     to setting ‘-X importtime’ on the command line.

     New in version 3.7.

 -- Environment Variable: PYTHONASYNCIODEBUG

     If this environment variable is set to a non-empty string, enable
     the *note debug mode: 128b. of the *note asyncio: a. module.

     New in version 3.4.

 -- Environment Variable: PYTHONMALLOC

     Set the Python memory allocators and/or install debug hooks.

     Set the family of memory allocators used by Python:

        * ‘default’: use the *note default memory allocators: 1298.

        * ‘malloc’: use the ‘malloc()’ function of the C library for all
          domains (*note PYMEM_DOMAIN_RAW: 1299, *note PYMEM_DOMAIN_MEM:
          4fe, *note PYMEM_DOMAIN_OBJ: 4fc.).

        * ‘pymalloc’: use the *note pymalloc allocator: 5b6. for *note
          PYMEM_DOMAIN_MEM: 4fe. and *note PYMEM_DOMAIN_OBJ: 4fc.
          domains and use the ‘malloc()’ function for the *note
          PYMEM_DOMAIN_RAW: 1299. domain.

     Install debug hooks:

        * ‘debug’: install debug hooks on top of the *note default
          memory allocators: 1298.

        * ‘malloc_debug’: same as ‘malloc’ but also install debug hooks.

        * ‘pymalloc_debug’: same as ‘pymalloc’ but also install debug
          hooks.

     See the *note default memory allocators: 1298. and the *note
     PyMem_SetupDebugHooks(): 4ff. function (install debug hooks on
     Python memory allocators).

     Changed in version 3.7: Added the ‘"default"’ allocator.

     New in version 3.6.

 -- Environment Variable: PYTHONMALLOCSTATS

     If set to a non-empty string, Python will print statistics of the
     *note pymalloc memory allocator: 5b6. every time a new pymalloc
     object arena is created, and on shutdown.

     This variable is ignored if the *note PYTHONMALLOC: 4f8.
     environment variable is used to force the ‘malloc()’ allocator of
     the C library, or if Python is configured without ‘pymalloc’
     support.

     Changed in version 3.6: This variable can now also be used on
     Python compiled in release mode.  It now has no effect if set to an
     empty string.

 -- Environment Variable: PYTHONLEGACYWINDOWSFSENCODING

     If set to a non-empty string, the default filesystem encoding and
     errors mode will revert to their pre-3.6 values of ‘mbcs’ and
     ‘replace’, respectively.  Otherwise, the new defaults ‘utf-8’ and
     ‘surrogatepass’ are used.

     This may also be enabled at runtime with *note
     sys._enablelegacywindowsfsencoding(): 4ed.

     *note Availability: 129a.: Windows.

     New in version 3.6: See PEP 529(3) for more details.

 -- Environment Variable: PYTHONLEGACYWINDOWSSTDIO

     If set to a non-empty string, does not use the new console reader
     and writer.  This means that Unicode characters will be encoded
     according to the active console code page, rather than using utf-8.

     This variable is ignored if the standard streams are redirected (to
     files or pipes) rather than referring to console buffers.

     *note Availability: 129a.: Windows.

     New in version 3.6.

 -- Environment Variable: PYTHONCOERCECLOCALE

     If set to the value ‘0’, causes the main Python command line
     application to skip coercing the legacy ASCII-based C and POSIX
     locales to a more capable UTF-8 based alternative.

     If this variable is `not' set (or is set to a value other than
     ‘0’), the ‘LC_ALL’ locale override environment variable is also not
     set, and the current locale reported for the ‘LC_CTYPE’ category is
     either the default ‘C’ locale, or else the explicitly ASCII-based
     ‘POSIX’ locale, then the Python CLI will attempt to configure the
     following locales for the ‘LC_CTYPE’ category in the order listed
     before loading the interpreter runtime:

        * ‘C.UTF-8’

        * ‘C.utf8’

        * ‘UTF-8’

     If setting one of these locale categories succeeds, then the
     ‘LC_CTYPE’ environment variable will also be set accordingly in the
     current process environment before the Python runtime is
     initialized.  This ensures that in addition to being seen by both
     the interpreter itself and other locale-aware components running in
     the same process (such as the GNU ‘readline’ library), the updated
     setting is also seen in subprocesses (regardless of whether or not
     those processes are running a Python interpreter), as well as in
     operations that query the environment rather than the current C
     locale (such as Python’s own *note locale.getdefaultlocale():
     129b.).

     Configuring one of these locales (either explicitly or via the
     above implicit locale coercion) automatically enables the
     ‘surrogateescape’ *note error handler: 129c. for *note sys.stdin:
     302. and *note sys.stdout: 303. (*note sys.stderr: 304. continues
     to use ‘backslashreplace’ as it does in any other locale).  This
     stream handling behavior can be overridden using *note
     PYTHONIOENCODING: 923. as usual.

     For debugging purposes, setting ‘PYTHONCOERCECLOCALE=warn’ will
     cause Python to emit warning messages on ‘stderr’ if either the
     locale coercion activates, or else if a locale that `would' have
     triggered coercion is still active when the Python runtime is
     initialized.

     Also note that even when locale coercion is disabled, or when it
     fails to find a suitable target locale, *note PYTHONUTF8: 306. will
     still activate by default in legacy ASCII-based locales.  Both
     features must be disabled in order to force the interpreter to use
     ‘ASCII’ instead of ‘UTF-8’ for system interfaces.

     *note Availability: 129a.: *nix.

     New in version 3.7: See PEP 538(4) for more details.

 -- Environment Variable: PYTHONDEVMODE

     If this environment variable is set to a non-empty string, enable
     the CPython “development mode”.  See the *note -X: 155. ‘dev’
     option.

     New in version 3.7.

 -- Environment Variable: PYTHONUTF8

     If set to ‘1’, enables the interpreter’s UTF-8 mode, where ‘UTF-8’
     is used as the text encoding for system interfaces, regardless of
     the current locale setting.

     This means that:

             * *note sys.getfilesystemencoding(): 4eb. returns ‘'UTF-8'’
               (the locale encoding is ignored).

             * *note locale.getpreferredencoding(): 39a. returns
               ‘'UTF-8'’ (the locale encoding is ignored, and the
               function’s ‘do_setlocale’ parameter has no effect).

             * *note sys.stdin: 302, *note sys.stdout: 303, and *note
               sys.stderr: 304. all use UTF-8 as their text encoding,
               with the ‘surrogateescape’ *note error handler: 129c.
               being enabled for *note sys.stdin: 302. and *note
               sys.stdout: 303. (*note sys.stderr: 304. continues to use
               ‘backslashreplace’ as it does in the default locale-aware
               mode)

     As a consequence of the changes in those lower level APIs, other
     higher level APIs also exhibit different default behaviours:

             * Command line arguments, environment variables and
               filenames are decoded to text using the UTF-8 encoding.

             * *note os.fsdecode(): 4e3. and *note os.fsencode(): 4e4.
               use the UTF-8 encoding.

             * *note open(): 4e5, *note io.open(): 64e, and *note
               codecs.open(): 129d. use the UTF-8 encoding by default.
               However, they still use the strict error handler by
               default so that attempting to open a binary file in text
               mode is likely to raise an exception rather than
               producing nonsense data.

     Note that the standard stream settings in UTF-8 mode can be
     overridden by *note PYTHONIOENCODING: 923. (just as they can be in
     the default locale-aware mode).

     If set to ‘0’, the interpreter runs in its default locale-aware
     mode.

     Setting any other non-empty string causes an error during
     interpreter initialisation.

     If this environment variable is not set at all, then the
     interpreter defaults to using the current locale settings, `unless'
     the current locale is identified as a legacy ASCII-based locale (as
     described for *note PYTHONCOERCECLOCALE: 301.), and locale coercion
     is either disabled or fails.  In such legacy locales, the
     interpreter will default to enabling UTF-8 mode unless explicitly
     instructed not to do so.

     Also available as the *note -X: 155. ‘utf8’ option.

     *note Availability: 129a.: *nix.

     New in version 3.7: See PEP 540(5) for more details.

* Menu:

* Debug-mode variables::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0370

   (2) https://www.python.org/dev/peps/pep-0370

   (3) https://www.python.org/dev/peps/pep-0529

   (4) https://www.python.org/dev/peps/pep-0538

   (5) https://www.python.org/dev/peps/pep-0540


File: python.info,  Node: Debug-mode variables,  Up: Environment variables

3.1.2.1 Debug-mode variables
............................

Setting these variables only has an effect in a debug build of Python.

 -- Environment Variable: PYTHONTHREADDEBUG

     If set, Python will print threading debug info.

     Need Python configured with the ‘--with-pydebug’ build option.

 -- Environment Variable: PYTHONDUMPREFS

     If set, Python will dump objects and reference counts still alive
     after shutting down the interpreter.

     Need Python configured with the ‘--with-trace-refs’ build option.


File: python.info,  Node: Using Python on Unix platforms,  Next: Using Python on Windows,  Prev: Command line and environment,  Up: Python Setup and Usage

3.2 Using Python on Unix platforms
==================================

* Menu:

* Getting and installing the latest version of Python::
* Building Python::
* Python-related paths and files::
* Miscellaneous::


File: python.info,  Node: Getting and installing the latest version of Python,  Next: Building Python,  Up: Using Python on Unix platforms

3.2.1 Getting and installing the latest version of Python
---------------------------------------------------------

* Menu:

* On Linux::
* On FreeBSD and OpenBSD::
* On OpenSolaris::


File: python.info,  Node: On Linux,  Next: On FreeBSD and OpenBSD,  Up: Getting and installing the latest version of Python

3.2.1.1 On Linux
................

Python comes preinstalled on most Linux distributions, and is available
as a package on all others.  However there are certain features you
might want to use that are not available on your distro’s package.  You
can easily compile the latest version of Python from source.

In the event that Python doesn’t come preinstalled and isn’t in the
repositories as well, you can easily make packages for your own distro.
Have a look at the following links:

See also
........

‘https://www.debian.org/doc/manuals/maint-guide/first.en.html’

     for Debian users

‘https://en.opensuse.org/Portal:Packaging’

     for OpenSuse users

‘https://docs-old.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch-creating-rpms.html’

     for Fedora users

‘http://www.slackbook.org/html/package-management-making-packages.html’

     for Slackware users


File: python.info,  Node: On FreeBSD and OpenBSD,  Next: On OpenSolaris,  Prev: On Linux,  Up: Getting and installing the latest version of Python

3.2.1.2 On FreeBSD and OpenBSD
..............................

   * FreeBSD users, to add the package use:

          pkg install python3

   * OpenBSD users, to add the package use:

          pkg_add -r python

          pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/<insert your architecture here>/python-<version>.tgz

     For example i386 users get the 2.5.1 version of Python using:

          pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/i386/python-2.5.1p2.tgz


File: python.info,  Node: On OpenSolaris,  Prev: On FreeBSD and OpenBSD,  Up: Getting and installing the latest version of Python

3.2.1.3 On OpenSolaris
......................

You can get Python from OpenCSW(1). Various versions of Python are
available and can be installed with e.g.  ‘pkgutil -i python27’.

   ---------- Footnotes ----------

   (1) https://www.opencsw.org/


File: python.info,  Node: Building Python,  Next: Python-related paths and files,  Prev: Getting and installing the latest version of Python,  Up: Using Python on Unix platforms

3.2.2 Building Python
---------------------

If you want to compile CPython yourself, first thing you should do is
get the source(1).  You can download either the latest release’s source
or just grab a fresh clone(2).  (If you want to contribute patches, you
will need a clone.)

The build process consists of the usual commands:

     ./configure
     make
     make install

Configuration options and caveats for specific Unix platforms are
extensively documented in the README.rst(3) file in the root of the
Python source tree.

     Warning: ‘make install’ can overwrite or masquerade the ‘python3’
     binary.  ‘make altinstall’ is therefore recommended instead of
     ‘make install’ since it only installs
     ‘`exec_prefix'/bin/python`version'’.

   ---------- Footnotes ----------

   (1) https://www.python.org/downloads/source/

   (2) https://devguide.python.org/setup/#getting-the-source-code

   (3) https://github.com/python/cpython/tree/3.8/README.rst


File: python.info,  Node: Python-related paths and files,  Next: Miscellaneous,  Prev: Building Python,  Up: Using Python on Unix platforms

3.2.3 Python-related paths and files
------------------------------------

These are subject to difference depending on local installation
conventions; ‘prefix’ (‘${prefix}’) and ‘exec_prefix’ (‘${exec_prefix}’)
are installation-dependent and should be interpreted as for GNU
software; they may be the same.

For example, on most Linux systems, the default for both is ‘/usr’.

File/directory                                      Meaning
                                                    
---------------------------------------------------------------------------------------------------
                                                    
‘`exec_prefix'/bin/python3’                         Recommended location of the interpreter.
                                                    
                                                    
‘`prefix'/lib/python`version'’,                     Recommended locations of the directories
‘`exec_prefix'/lib/python`version'’                 containing the standard modules.
                                                    
                                                    
‘`prefix'/include/python`version'’,                 Recommended locations of the directories
‘`exec_prefix'/include/python`version'’             containing the include files needed for
                                                    developing Python extensions and embedding
                                                    the interpreter.
                                                    


File: python.info,  Node: Miscellaneous,  Prev: Python-related paths and files,  Up: Using Python on Unix platforms

3.2.4 Miscellaneous
-------------------

To easily use Python scripts on Unix, you need to make them executable,
e.g.  with

     $ chmod +x script

and put an appropriate Shebang line at the top of the script.  A good
choice is usually

     #!/usr/bin/env python3

which searches for the Python interpreter in the whole ‘PATH’.  However,
some Unices may not have the ‘env’ command, so you may need to hardcode
‘/usr/bin/python3’ as the interpreter path.

To use shell commands in your Python scripts, look at the *note
subprocess: f9. module.


File: python.info,  Node: Using Python on Windows,  Next: Using Python on a Macintosh,  Prev: Using Python on Unix platforms,  Up: Python Setup and Usage

3.3 Using Python on Windows
===========================

This document aims to give an overview of Windows-specific behaviour you
should know about when using Python on Microsoft Windows.

Unlike most Unix systems and services, Windows does not include a system
supported installation of Python.  To make Python available, the CPython
team has compiled Windows installers (MSI packages) with every
release(1) for many years.  These installers are primarily intended to
add a per-user installation of Python, with the core interpreter and
library being used by a single user.  The installer is also able to
install for all users of a single machine, and a separate ZIP file is
available for application-local distributions.

As specified in PEP 11(2), a Python release only supports a Windows
platform while Microsoft considers the platform under extended support.
This means that Python 3.8 supports Windows Vista and newer.  If you
require Windows XP support then please install Python 3.4.

There are a number of different installers available for Windows, each
with certain benefits and downsides.

*note The full installer: 12ac. contains all components and is the best
option for developers using Python for any kind of project.

*note The Microsoft Store package: 1142. is a simple installation of
Python that is suitable for running scripts and packages, and using IDLE
or other development environments.  It requires Windows 10, but can be
safely installed without corrupting other programs.  It also provides
many convenient commands for launching Python and its tools.

*note The nuget.org packages: 12ad. are lightweight installations
intended for continuous integration systems.  It can be used to build
Python packages or run scripts, but is not updateable and has no user
interface tools.

*note The embeddable package: 12ae. is a minimal package of Python
suitable for embedding into a larger application.

* Menu:

* The full installer::
* The Microsoft Store package::
* The nuget.org packages: The nuget org packages.
* The embeddable package::
* Alternative bundles::
* Configuring Python::
* Python Launcher for Windows::
* Finding modules::
* Additional modules::
* Compiling Python on Windows::
* Other Platforms::

   ---------- Footnotes ----------

   (1) https://www.python.org/download/releases/

   (2) https://www.python.org/dev/peps/pep-0011


File: python.info,  Node: The full installer,  Next: The Microsoft Store package,  Up: Using Python on Windows

3.3.1 The full installer
------------------------

* Menu:

* Installation steps::
* Removing the MAX_PATH Limitation::
* Installing Without UI::
* Installing Without Downloading::
* Modifying an install::


File: python.info,  Node: Installation steps,  Next: Removing the MAX_PATH Limitation,  Up: The full installer

3.3.1.1 Installation steps
..........................

Four Python 3.8 installers are available for download - two each for the
32-bit and 64-bit versions of the interpreter.  The `web installer' is a
small initial download, and it will automatically download the required
components as necessary.  The `offline installer' includes the
components necessary for a default installation and only requires an
internet connection for optional features.  See *note Installing Without
Downloading: 12b1. for other ways to avoid downloading during
installation.

After starting the installer, one of two options may be selected:

[python-figures/win_installer]
If you select “Install Now”:

   * You will `not' need to be an administrator (unless a system update
     for the C Runtime Library is required or you install the *note
     Python Launcher for Windows: 983. for all users)

   * Python will be installed into your user directory

   * The *note Python Launcher for Windows: 983. will be installed
     according to the option at the bottom of the first page

   * The standard library, test suite, launcher and pip will be
     installed

   * If selected, the install directory will be added to your ‘PATH’

   * Shortcuts will only be visible for the current user

Selecting “Customize installation” will allow you to select the features
to install, the installation location and other options or post-install
actions.  To install debugging symbols or binaries, you will need to use
this option.

To perform an all-users installation, you should select “Customize
installation”.  In this case:

   * You may be required to provide administrative credentials or
     approval

   * Python will be installed into the Program Files directory

   * The *note Python Launcher for Windows: 983. will be installed into
     the Windows directory

   * Optional features may be selected during installation

   * The standard library can be pre-compiled to bytecode

   * If selected, the install directory will be added to the system
     ‘PATH’

   * Shortcuts are available for all users


File: python.info,  Node: Removing the MAX_PATH Limitation,  Next: Installing Without UI,  Prev: Installation steps,  Up: The full installer

3.3.1.2 Removing the MAX_PATH Limitation
........................................

Windows historically has limited path lengths to 260 characters.  This
meant that paths longer than this would not resolve and errors would
result.

In the latest versions of Windows, this limitation can be expanded to
approximately 32,000 characters.  Your administrator will need to
activate the “Enable Win32 long paths” group policy, or set the registry
value
‘HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem@LongPathsEnabled’
to ‘1’.

This allows the *note open(): 4e5. function, the *note os: c4. module
and most other path functionality to accept and return paths longer than
260 characters when using strings.  (Use of bytes as paths is deprecated
on Windows, and this feature is not available when using bytes.)

After changing the above option, no further configuration is required.

Changed in version 3.6: Support for long paths was enabled in Python.


File: python.info,  Node: Installing Without UI,  Next: Installing Without Downloading,  Prev: Removing the MAX_PATH Limitation,  Up: The full installer

3.3.1.3 Installing Without UI
.............................

All of the options available in the installer UI can also be specified
from the command line, allowing scripted installers to replicate an
installation on many machines without user interaction.  These options
may also be set without suppressing the UI in order to change some of
the defaults.

To completely hide the installer UI and install Python silently, pass
the ‘/quiet’ option.  To skip past the user interaction but still
display progress and errors, pass the ‘/passive’ option.  The
‘/uninstall’ option may be passed to immediately begin removing Python -
no prompt will be displayed.

All other options are passed as ‘name=value’, where the value is usually
‘0’ to disable a feature, ‘1’ to enable a feature, or a path.  The full
list of available options is shown below.

Name                            Description                                Default
                                                                           
----------------------------------------------------------------------------------------------------------
                                                                           
InstallAllUsers                 Perform a system-wide installation.        0
                                                                           
                                                                           
TargetDir                       The installation directory                 Selected based on
                                                                           InstallAllUsers
                                                                           
                                                                           
DefaultAllUsersTargetDir        The default installation directory for     ‘%ProgramFiles%\Python X.Y’
                                all-user installs                          or
                                                                           ‘%ProgramFiles(x86)%\Python
                                                                           X.Y’
                                                                           
                                                                           
DefaultJustForMeTargetDir       The default install directory for          ‘%LocalAppData%\Programs\PythonXY’
                                just-for-me installs                       or
                                                                           ‘%LocalAppData%\Programs\PythonXY-32’
                                                                           or
                                                                           ‘%LocalAppData%\Programs\PythonXY-64’
                                                                           
                                                                           
DefaultCustomTargetDir          The default custom install directory       (empty)
                                displayed in the UI                        
                                
                                                                           
AssociateFiles                  Create file associations if the launcher   1
                                is also installed.                         
                                
                                                                           
CompileAll                      Compile all ‘.py’ files to ‘.pyc’.         0
                                                                           
                                                                           
PrependPath                     Add install and Scripts directories to     0
                                ‘PATH’ and ‘.PY’ to ‘PATHEXT’              
                                
                                                                           
Shortcuts                       Create shortcuts for the interpreter,      1
                                documentation and IDLE if installed.       
                                
                                                                           
Include_doc                     Install Python manual                      1
                                                                           
                                                                           
Include_debug                   Install debug binaries                     0
                                                                           
                                                                           
Include_dev                     Install developer headers and libraries    1
                                                                           
                                                                           
Include_exe                     Install ‘python.exe’ and related files     1
                                                                           
                                                                           
Include_launcher                Install                                    1
                                *note Python Launcher for Windows: 983.    
                                
                                                                           
InstallLauncherAllUsers         Installs                                   1
                                *note Python Launcher for Windows: 983.    
                                for all users.
                                
                                                                           
Include_lib                     Install standard library and extension     1
                                modules                                    
                                
                                                                           
Include_pip                     Install bundled pip and setuptools         1
                                                                           
                                                                           
Include_symbols                 Install debugging symbols (‘*’.pdb)        0
                                                                           
                                                                           
Include_tcltk                   Install Tcl/Tk support and IDLE            1
                                                                           
                                                                           
Include_test                    Install standard library test suite        1
                                                                           
                                                                           
Include_tools                   Install utility scripts                    1
                                                                           
                                                                           
LauncherOnly                    Only installs the launcher.  This will     0
                                override most other options.               
                                
                                                                           
SimpleInstall                   Disable most install UI                    0
                                                                           
                                                                           
SimpleInstallDescription        A custom message to display when the       (empty)
                                simplified install UI is used.             
                                

For example, to silently install a default, system-wide Python
installation, you could use the following command (from an elevated
command prompt):

     python-3.8.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0

To allow users to easily install a personal copy of Python without the
test suite, you could provide a shortcut with the following command.
This will display a simplified initial page and disallow customization:

     python-3.8.0.exe InstallAllUsers=0 Include_launcher=0 Include_test=0
         SimpleInstall=1 SimpleInstallDescription="Just for me, no test suite."

(Note that omitting the launcher also omits file associations, and is
only recommended for per-user installs when there is also a system-wide
installation that included the launcher.)

The options listed above can also be provided in a file named
‘unattend.xml’ alongside the executable.  This file specifies a list of
options and values.  When a value is provided as an attribute, it will
be converted to a number if possible.  Values provided as element text
are always left as strings.  This example file sets the same options as
the previous example:

     <Options>
         <Option Name="InstallAllUsers" Value="no" />
         <Option Name="Include_launcher" Value="0" />
         <Option Name="Include_test" Value="no" />
         <Option Name="SimpleInstall" Value="yes" />
         <Option Name="SimpleInstallDescription">Just for me, no test suite</Option>
     </Options>


File: python.info,  Node: Installing Without Downloading,  Next: Modifying an install,  Prev: Installing Without UI,  Up: The full installer

3.3.1.4 Installing Without Downloading
......................................

As some features of Python are not included in the initial installer
download, selecting those features may require an internet connection.
To avoid this need, all possible components may be downloaded on-demand
to create a complete `layout' that will no longer require an internet
connection regardless of the selected features.  Note that this download
may be bigger than required, but where a large number of installations
are going to be performed it is very useful to have a locally cached
copy.

Execute the following command from Command Prompt to download all
possible required files.  Remember to substitute ‘python-3.8.0.exe’ for
the actual name of your installer, and to create layouts in their own
directories to avoid collisions between files with the same name.

     python-3.8.0.exe /layout [optional target directory]

You may also specify the ‘/quiet’ option to hide the progress display.


File: python.info,  Node: Modifying an install,  Prev: Installing Without Downloading,  Up: The full installer

3.3.1.5 Modifying an install
............................

Once Python has been installed, you can add or remove features through
the Programs and Features tool that is part of Windows.  Select the
Python entry and choose “Uninstall/Change” to open the installer in
maintenance mode.

“Modify” allows you to add or remove features by modifying the
checkboxes - unchanged checkboxes will not install or remove anything.
Some options cannot be changed in this mode, such as the install
directory; to modify these, you will need to remove and then reinstall
Python completely.

“Repair” will verify all the files that should be installed using the
current settings and replace any that have been removed or modified.

“Uninstall” will remove Python entirely, with the exception of the *note
Python Launcher for Windows: 983, which has its own entry in Programs
and Features.


File: python.info,  Node: The Microsoft Store package,  Next: The nuget org packages,  Prev: The full installer,  Up: Using Python on Windows

3.3.2 The Microsoft Store package
---------------------------------

New in version 3.7.2.

The Microsoft Store package is an easily installable Python interpreter
that is intended mainly for interactive use, for example, by students.

To install the package, ensure you have the latest Windows 10 updates
and search the Microsoft Store app for “Python 3.8”.  Ensure that the
app you select is published by the Python Software Foundation, and
install it.

     Warning: Python will always be available for free on the Microsoft
     Store.  If you are asked to pay for it, you have not selected the
     correct package.

After installation, Python may be launched by finding it in Start.
Alternatively, it will be available from any Command Prompt or
PowerShell session by typing ‘python’.  Further, pip and IDLE may be
used by typing ‘pip’ or ‘idle’.  IDLE can also be found in Start.

All three commands are also available with version number suffixes, for
example, as ‘python3.exe’ and ‘python3.x.exe’ as well as ‘python.exe’
(where ‘3.x’ is the specific version you want to launch, such as 3.8).
Open “Manage App Execution Aliases” through Start to select which
version of Python is associated with each command.  It is recommended to
make sure that ‘pip’ and ‘idle’ are consistent with whichever version of
‘python’ is selected.

Virtual environments can be created with ‘python -m venv’ and activated
and used as normal.

If you have installed another version of Python and added it to your
‘PATH’ variable, it will be available as ‘python.exe’ rather than the
one from the Microsoft Store.  To access the new installation, use
‘python3.exe’ or ‘python3.x.exe’.

The ‘py.exe’ launcher will detect this Python installation, but will
prefer installations from the traditional installer.

To remove Python, open Settings and use Apps and Features, or else find
Python in Start and right-click to select Uninstall.  Uninstalling will
remove all packages you installed directly into this Python
installation, but will not remove any virtual environments

* Menu:

* Known Issues::


File: python.info,  Node: Known Issues,  Up: The Microsoft Store package

3.3.2.1 Known Issues
....................

Because of restrictions on Microsoft Store apps, Python scripts may not
have full write access to shared locations such as ‘TEMP’ and the
registry.  Instead, it will write to a private copy.  If your scripts
must modify the shared locations, you will need to install the full
installer.


File: python.info,  Node: The nuget org packages,  Next: The embeddable package,  Prev: The Microsoft Store package,  Up: Using Python on Windows

3.3.3 The nuget.org packages
----------------------------

New in version 3.5.2.

The nuget.org package is a reduced size Python environment intended for
use on continuous integration and build systems that do not have a
system-wide install of Python.  While nuget is “the package manager for
.NET”, it also works perfectly fine for packages containing build-time
tools.

Visit nuget.org(1) for the most up-to-date information on using nuget.
What follows is a summary that is sufficient for Python developers.

The ‘nuget.exe’ command line tool may be downloaded directly from
‘https://aka.ms/nugetclidl’, for example, using curl or PowerShell.
With the tool, the latest version of Python for 64-bit or 32-bit
machines is installed using:

     nuget.exe install python -ExcludeVersion -OutputDirectory .
     nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .

To select a particular version, add a ‘-Version 3.x.y’.  The output
directory may be changed from ‘.’, and the package will be installed
into a subdirectory.  By default, the subdirectory is named the same as
the package, and without the ‘-ExcludeVersion’ option this name will
include the specific version installed.  Inside the subdirectory is a
‘tools’ directory that contains the Python installation:

     # Without -ExcludeVersion
     > .\python.3.5.2\tools\python.exe -V
     Python 3.5.2

     # With -ExcludeVersion
     > .\python\tools\python.exe -V
     Python 3.5.2

In general, nuget packages are not upgradeable, and newer versions
should be installed side-by-side and referenced using the full path.
Alternatively, delete the package directory manually and install it
again.  Many CI systems will do this automatically if they do not
preserve files between builds.

Alongside the ‘tools’ directory is a ‘build\native’ directory.  This
contains a MSBuild properties file ‘python.props’ that can be used in a
C++ project to reference the Python install.  Including the settings
will automatically use the headers and import libraries in your build.

The package information pages on nuget.org are
www.nuget.org/packages/python(2) for the 64-bit version and
www.nuget.org/packages/pythonx86(3) for the 32-bit version.

   ---------- Footnotes ----------

   (1) https://www.nuget.org/

   (2) https://www.nuget.org/packages/python

   (3) https://www.nuget.org/packages/pythonx86


File: python.info,  Node: The embeddable package,  Next: Alternative bundles,  Prev: The nuget org packages,  Up: Using Python on Windows

3.3.4 The embeddable package
----------------------------

New in version 3.5.

The embedded distribution is a ZIP file containing a minimal Python
environment.  It is intended for acting as part of another application,
rather than being directly accessed by end-users.

When extracted, the embedded distribution is (almost) fully isolated
from the user’s system, including environment variables, system registry
settings, and installed packages.  The standard library is included as
pre-compiled and optimized ‘.pyc’ files in a ZIP, and ‘python3.dll’,
‘python37.dll’, ‘python.exe’ and ‘pythonw.exe’ are all provided.  Tcl/tk
(including all dependants, such as Idle), pip and the Python
documentation are not included.

     Note: The embedded distribution does not include the Microsoft C
     Runtime(1) and it is the responsibility of the application
     installer to provide this.  The runtime may have already been
     installed on a user’s system previously or automatically via
     Windows Update, and can be detected by finding ‘ucrtbase.dll’ in
     the system directory.

Third-party packages should be installed by the application installer
alongside the embedded distribution.  Using pip to manage dependencies
as for a regular Python installation is not supported with this
distribution, though with some care it may be possible to include and
use pip for automatic updates.  In general, third-party packages should
be treated as part of the application (“vendoring”) so that the
developer can ensure compatibility with newer versions before providing
updates to users.

The two recommended use cases for this distribution are described below.

* Menu:

* Python Application::
* Embedding Python::

   ---------- Footnotes ----------

   (1) https://www.microsoft.com/en-us/download/details.aspx?id=48145


File: python.info,  Node: Python Application,  Next: Embedding Python,  Up: The embeddable package

3.3.4.1 Python Application
..........................

An application written in Python does not necessarily require users to
be aware of that fact.  The embedded distribution may be used in this
case to include a private version of Python in an install package.
Depending on how transparent it should be (or conversely, how
professional it should appear), there are two options.

Using a specialized executable as a launcher requires some coding, but
provides the most transparent experience for users.  With a customized
launcher, there are no obvious indications that the program is running
on Python: icons can be customized, company and version information can
be specified, and file associations behave properly.  In most cases, a
custom launcher should simply be able to call ‘Py_Main’ with a
hard-coded command line.

The simpler approach is to provide a batch file or generated shortcut
that directly calls the ‘python.exe’ or ‘pythonw.exe’ with the required
command-line arguments.  In this case, the application will appear to be
Python and not its actual name, and users may have trouble
distinguishing it from other running Python processes or file
associations.

With the latter approach, packages should be installed as directories
alongside the Python executable to ensure they are available on the
path.  With the specialized launcher, packages can be located in other
locations as there is an opportunity to specify the search path before
launching the application.


File: python.info,  Node: Embedding Python,  Prev: Python Application,  Up: The embeddable package

3.3.4.2 Embedding Python
........................

Applications written in native code often require some form of scripting
language, and the embedded Python distribution can be used for this
purpose.  In general, the majority of the application is in native code,
and some part will either invoke ‘python.exe’ or directly use
‘python3.dll’.  For either case, extracting the embedded distribution to
a subdirectory of the application installation is sufficient to provide
a loadable Python interpreter.

As with the application use, packages can be installed to any location
as there is an opportunity to specify search paths before initializing
the interpreter.  Otherwise, there is no fundamental differences between
using the embedded distribution and a regular installation.


File: python.info,  Node: Alternative bundles,  Next: Configuring Python,  Prev: The embeddable package,  Up: Using Python on Windows

3.3.5 Alternative bundles
-------------------------

Besides the standard CPython distribution, there are modified packages
including additional functionality.  The following is a list of popular
versions and their key features:

ActivePython(1)

     Installer with multi-platform compatibility, documentation, PyWin32

Anaconda(2)

     Popular scientific modules (such as numpy, scipy and pandas) and
     the ‘conda’ package manager.

Canopy(3)

     A “comprehensive Python analysis environment” with editors and
     other development tools.

WinPython(4)

     Windows-specific distribution with prebuilt scientific packages and
     tools for building packages.

Note that these packages may not include the latest versions of Python
or other libraries, and are not maintained or supported by the core
Python team.

   ---------- Footnotes ----------

   (1) https://www.activestate.com/activepython/

   (2) https://www.anaconda.com/download/

   (3) https://www.enthought.com/product/canopy/

   (4) https://winpython.github.io/


File: python.info,  Node: Configuring Python,  Next: Python Launcher for Windows,  Prev: Alternative bundles,  Up: Using Python on Windows

3.3.6 Configuring Python
------------------------

To run Python conveniently from a command prompt, you might consider
changing some default environment variables in Windows.  While the
installer provides an option to configure the PATH and PATHEXT variables
for you, this is only reliable for a single, system-wide installation.
If you regularly use multiple versions of Python, consider using the
*note Python Launcher for Windows: 983.

* Menu:

* Excursus; Setting environment variables: Excursus Setting environment variables.
* Finding the Python executable::


File: python.info,  Node: Excursus Setting environment variables,  Next: Finding the Python executable,  Up: Configuring Python

3.3.6.1 Excursus: Setting environment variables
...............................................

Windows allows environment variables to be configured permanently at
both the User level and the System level, or temporarily in a command
prompt.

To temporarily set environment variables, open Command Prompt and use
the ‘set’ command:

     C:\>set PATH=C:\Program Files\Python 3.8;%PATH%
     C:\>set PYTHONPATH=%PYTHONPATH%;C:\My_python_lib
     C:\>python

These changes will apply to any further commands executed in that
console, and will be inherited by any applications started from the
console.

Including the variable name within percent signs will expand to the
existing value, allowing you to add your new value at either the start
or the end.  Modifying ‘PATH’ by adding the directory containing
‘python.exe’ to the start is a common way to ensure the correct version
of Python is launched.

To permanently modify the default environment variables, click Start and
search for ‘edit environment variables’, or open System properties,
Advanced system settings and click the Environment Variables button.  In
this dialog, you can add or modify User and System variables.  To change
System variables, you need non-restricted access to your machine (i.e.
Administrator rights).

     Note: Windows will concatenate User variables `after' System
     variables, which may cause unexpected results when modifying
     ‘PATH’.

     The *note PYTHONPATH: 947. variable is used by all versions of
     Python 2 and Python 3, so you should not permanently configure this
     variable unless it only includes code that is compatible with all
     of your installed Python versions.

See also
........

‘https://www.microsoft.com/en-us/wdsi/help/folder-variables’

     Environment variables in Windows NT

‘https://technet.microsoft.com/en-us/library/cc754250.aspx’

     The SET command, for temporarily modifying environment variables

‘https://technet.microsoft.com/en-us/library/cc755104.aspx’

     The SETX command, for permanently modifying environment variables

‘https://support.microsoft.com/en-us/help/310519/how-to-manage-environment-variables-in-windows-xp’

     How To Manage Environment Variables in Windows XP

‘https://www.chem.gla.ac.uk/~louis/software/faq/q1.html’

     Setting Environment variables, Louis J. Farrugia


File: python.info,  Node: Finding the Python executable,  Prev: Excursus Setting environment variables,  Up: Configuring Python

3.3.6.2 Finding the Python executable
.....................................

Changed in version 3.5.

Besides using the automatically created start menu entry for the Python
interpreter, you might want to start Python in the command prompt.  The
installer has an option to set that up for you.

On the first page of the installer, an option labelled “Add Python to
PATH” may be selected to have the installer add the install location
into the ‘PATH’.  The location of the ‘Scripts\’ folder is also added.
This allows you to type ‘python’ to run the interpreter, and ‘pip’ for
the package installer.  Thus, you can also execute your scripts with
command line options, see *note Command line: 91f. documentation.

If you don’t enable this option at install time, you can always re-run
the installer, select Modify, and enable it.  Alternatively, you can
manually modify the ‘PATH’ using the directions in *note Excursus;
Setting environment variables: 1143.  You need to set your ‘PATH’
environment variable to include the directory of your Python
installation, delimited by a semicolon from other entries.  An example
variable could look like this (assuming the first two entries already
existed):

     C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.8


File: python.info,  Node: Python Launcher for Windows,  Next: Finding modules,  Prev: Configuring Python,  Up: Using Python on Windows

3.3.7 Python Launcher for Windows
---------------------------------

New in version 3.3.

The Python launcher for Windows is a utility which aids in locating and
executing of different Python versions.  It allows scripts (or the
command-line) to indicate a preference for a specific Python version,
and will locate and execute that version.

Unlike the ‘PATH’ variable, the launcher will correctly select the most
appropriate version of Python.  It will prefer per-user installations
over system-wide ones, and orders by language version rather than using
the most recently installed version.

The launcher was originally specified in PEP 397(1).

* Menu:

* Getting started::
* Shebang Lines::
* Arguments in shebang lines::
* Customization::
* Diagnostics::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0397


File: python.info,  Node: Getting started,  Next: Shebang Lines,  Up: Python Launcher for Windows

3.3.7.1 Getting started
.......................

* Menu:

* From the command-line::
* Virtual environments::
* From a script::
* From file associations::


File: python.info,  Node: From the command-line,  Next: Virtual environments,  Up: Getting started

3.3.7.2 From the command-line
.............................

Changed in version 3.6.

System-wide installations of Python 3.3 and later will put the launcher
on your ‘PATH’.  The launcher is compatible with all available versions
of Python, so it does not matter which version is installed.  To check
that the launcher is available, execute the following command in Command
Prompt:

     py

You should find that the latest version of Python you have installed is
started - it can be exited as normal, and any additional command-line
arguments specified will be sent directly to Python.

If you have multiple versions of Python installed (e.g., 2.7 and 3.8)
you will have noticed that Python 3.8 was started - to launch Python
2.7, try the command:

     py -2.7

If you want the latest version of Python 2.x you have installed, try the
command:

     py -2

You should find the latest version of Python 2.x starts.

If you see the following error, you do not have the launcher installed:

     'py' is not recognized as an internal or external command,
     operable program or batch file.

Per-user installations of Python do not add the launcher to ‘PATH’
unless the option was selected on installation.


File: python.info,  Node: Virtual environments,  Next: From a script,  Prev: From the command-line,  Up: Getting started

3.3.7.3 Virtual environments
............................

New in version 3.5.

If the launcher is run with no explicit Python version specification,
and a virtual environment (created with the standard library *note venv:
125. module or the external ‘virtualenv’ tool) active, the launcher will
run the virtual environment’s interpreter rather than the global one.
To run the global interpreter, either deactivate the virtual
environment, or explicitly specify the global Python version.


File: python.info,  Node: From a script,  Next: From file associations,  Prev: Virtual environments,  Up: Getting started

3.3.7.4 From a script
.....................

Let’s create a test Python script - create a file called ‘hello.py’ with
the following contents

     #! python
     import sys
     sys.stdout.write("hello from Python %s\n" % (sys.version,))

From the directory in which hello.py lives, execute the command:

     py hello.py

You should notice the version number of your latest Python 2.x
installation is printed.  Now try changing the first line to be:

     #! python3

Re-executing the command should now print the latest Python 3.x
information.  As with the above command-line examples, you can specify a
more explicit version qualifier.  Assuming you have Python 2.6
installed, try changing the first line to ‘#! python2.6’ and you should
find the 2.6 version information printed.

Note that unlike interactive use, a bare “python” will use the latest
version of Python 2.x that you have installed.  This is for backward
compatibility and for compatibility with Unix, where the command
‘python’ typically refers to Python 2.


File: python.info,  Node: From file associations,  Prev: From a script,  Up: Getting started

3.3.7.5 From file associations
..............................

The launcher should have been associated with Python files (i.e.  ‘.py’,
‘.pyw’, ‘.pyc’ files) when it was installed.  This means that when you
double-click on one of these files from Windows explorer the launcher
will be used, and therefore you can use the same facilities described
above to have the script specify the version which should be used.

The key benefit of this is that a single launcher can support multiple
Python versions at the same time depending on the contents of the first
line.


File: python.info,  Node: Shebang Lines,  Next: Arguments in shebang lines,  Prev: Getting started,  Up: Python Launcher for Windows

3.3.7.6 Shebang Lines
.....................

If the first line of a script file starts with ‘#!’, it is known as a
“shebang” line.  Linux and other Unix like operating systems have native
support for such lines and they are commonly used on such systems to
indicate how a script should be executed.  This launcher allows the same
facilities to be used with Python scripts on Windows and the examples
above demonstrate their use.

To allow shebang lines in Python scripts to be portable between Unix and
Windows, this launcher supports a number of ‘virtual’ commands to
specify which interpreter to use.  The supported virtual commands are:

   * ‘/usr/bin/env python’

   * ‘/usr/bin/python’

   * ‘/usr/local/bin/python’

   * ‘python’

For example, if the first line of your script starts with

     #! /usr/bin/python

The default Python will be located and used.  As many Python scripts
written to work on Unix will already have this line, you should find
these scripts can be used by the launcher without modification.  If you
are writing a new script on Windows which you hope will be useful on
Unix, you should use one of the shebang lines starting with ‘/usr’.

Any of the above virtual commands can be suffixed with an explicit
version (either just the major version, or the major and minor version).
Furthermore the 32-bit version can be requested by adding “-32” after
the minor version.  I.e.  ‘/usr/bin/python2.7-32’ will request usage of
the 32-bit python 2.7.

New in version 3.7: Beginning with python launcher 3.7 it is possible to
request 64-bit version by the “-64” suffix.  Furthermore it is possible
to specify a major and architecture without minor (i.e.
‘/usr/bin/python3-64’).

The ‘/usr/bin/env’ form of shebang line has one further special
property.  Before looking for installed Python interpreters, this form
will search the executable ‘PATH’ for a Python executable.  This
corresponds to the behaviour of the Unix ‘env’ program, which performs a
‘PATH’ search.


File: python.info,  Node: Arguments in shebang lines,  Next: Customization,  Prev: Shebang Lines,  Up: Python Launcher for Windows

3.3.7.7 Arguments in shebang lines
..................................

The shebang lines can also specify additional options to be passed to
the Python interpreter.  For example, if you have a shebang line:

     #! /usr/bin/python -v

Then Python will be started with the ‘-v’ option


File: python.info,  Node: Customization,  Next: Diagnostics,  Prev: Arguments in shebang lines,  Up: Python Launcher for Windows

3.3.7.8 Customization
.....................

* Menu:

* Customization via INI files::
* Customizing default Python versions::


File: python.info,  Node: Customization via INI files,  Next: Customizing default Python versions,  Up: Customization

3.3.7.9 Customization via INI files
...................................

Two .ini files will be searched by the launcher - ‘py.ini’ in the
current user’s “application data” directory (i.e.  the directory
returned by calling the Windows function ‘SHGetFolderPath’ with
‘CSIDL_LOCAL_APPDATA’) and ‘py.ini’ in the same directory as the
launcher.  The same .ini files are used for both the ‘console’ version
of the launcher (i.e.  py.exe) and for the ‘windows’ version (i.e.
pyw.exe).

Customization specified in the “application directory” will have
precedence over the one next to the executable, so a user, who may not
have write access to the .ini file next to the launcher, can override
commands in that global .ini file.


File: python.info,  Node: Customizing default Python versions,  Prev: Customization via INI files,  Up: Customization

3.3.7.10 Customizing default Python versions
............................................

In some cases, a version qualifier can be included in a command to
dictate which version of Python will be used by the command.  A version
qualifier starts with a major version number and can optionally be
followed by a period (‘.’) and a minor version specifier.  Furthermore
it is possible to specify if a 32 or 64 bit implementation shall be
requested by adding “-32” or “-64”.

For example, a shebang line of ‘#!python’ has no version qualifier,
while ‘#!python3’ has a version qualifier which specifies only a major
version.

If no version qualifiers are found in a command, the environment
variable ‘PY_PYTHON’ can be set to specify the default version
qualifier.  If it is not set, the default is “3”.  The variable can
specify any value that may be passed on the command line, such as “3”,
“3.7”, “3.7-32” or “3.7-64”.  (Note that the “-64” option is only
available with the launcher included with Python 3.7 or newer.)

If no minor version qualifiers are found, the environment variable
‘PY_PYTHON{major}’ (where ‘{major}’ is the current major version
qualifier as determined above) can be set to specify the full version.
If no such option is found, the launcher will enumerate the installed
Python versions and use the latest minor release found for the major
version, which is likely, although not guaranteed, to be the most
recently installed version in that family.

On 64-bit Windows with both 32-bit and 64-bit implementations of the
same (major.minor) Python version installed, the 64-bit version will
always be preferred.  This will be true for both 32-bit and 64-bit
implementations of the launcher - a 32-bit launcher will prefer to
execute a 64-bit Python installation of the specified version if
available.  This is so the behavior of the launcher can be predicted
knowing only what versions are installed on the PC and without regard to
the order in which they were installed (i.e., without knowing whether a
32 or 64-bit version of Python and corresponding launcher was installed
last).  As noted above, an optional “-32” or “-64” suffix can be used on
a version specifier to change this behaviour.

Examples:

   * If no relevant options are set, the commands ‘python’ and ‘python2’
     will use the latest Python 2.x version installed and the command
     ‘python3’ will use the latest Python 3.x installed.

   * The commands ‘python3.1’ and ‘python2.7’ will not consult any
     options at all as the versions are fully specified.

   * If ‘PY_PYTHON=3’, the commands ‘python’ and ‘python3’ will both use
     the latest installed Python 3 version.

   * If ‘PY_PYTHON=3.1-32’, the command ‘python’ will use the 32-bit
     implementation of 3.1 whereas the command ‘python3’ will use the
     latest installed Python (PY_PYTHON was not considered at all as a
     major version was specified.)

   * If ‘PY_PYTHON=3’ and ‘PY_PYTHON3=3.1’, the commands ‘python’ and
     ‘python3’ will both use specifically 3.1

In addition to environment variables, the same settings can be
configured in the .INI file used by the launcher.  The section in the
INI file is called ‘[defaults]’ and the key name will be the same as the
environment variables without the leading ‘PY_’ prefix (and note that
the key names in the INI file are case insensitive.)  The contents of an
environment variable will override things specified in the INI file.

For example:

   * Setting ‘PY_PYTHON=3.1’ is equivalent to the INI file containing:

     [defaults]
     python=3.1

   * Setting ‘PY_PYTHON=3’ and ‘PY_PYTHON3=3.1’ is equivalent to the INI
     file containing:

     [defaults]
     python=3
     python3=3.1


File: python.info,  Node: Diagnostics,  Prev: Customization,  Up: Python Launcher for Windows

3.3.7.11 Diagnostics
....................

If an environment variable ‘PYLAUNCH_DEBUG’ is set (to any value), the
launcher will print diagnostic information to stderr (i.e.  to the
console).  While this information manages to be simultaneously verbose
`and' terse, it should allow you to see what versions of Python were
located, why a particular version was chosen and the exact command-line
used to execute the target Python.


File: python.info,  Node: Finding modules,  Next: Additional modules,  Prev: Python Launcher for Windows,  Up: Using Python on Windows

3.3.8 Finding modules
---------------------

Python usually stores its library (and thereby your site-packages
folder) in the installation directory.  So, if you had installed Python
to ‘C:\Python\’, the default library would reside in ‘C:\Python\Lib\’
and third-party modules should be stored in
‘C:\Python\Lib\site-packages\’.

To completely override *note sys.path: 47d, create a ‘._pth’ file with
the same name as the DLL (‘python37._pth’) or the executable
(‘python._pth’) and specify one line for each path to add to *note
sys.path: 47d.  The file based on the DLL name overrides the one based
on the executable, which allows paths to be restricted for any program
loading the runtime if desired.

When the file exists, all registry and environment variables are
ignored, isolated mode is enabled, and *note site: eb. is not imported
unless one line in the file specifies ‘import site’.  Blank paths and
lines starting with ‘#’ are ignored.  Each path may be absolute or
relative to the location of the file.  Import statements other than to
‘site’ are not permitted, and arbitrary code cannot be specified.

Note that ‘.pth’ files (without leading underscore) will be processed
normally by the *note site: eb. module when ‘import site’ has been
specified.

When no ‘._pth’ file is found, this is how *note sys.path: 47d. is
populated on Windows:

   * An empty entry is added at the start, which corresponds to the
     current directory.

   * If the environment variable *note PYTHONPATH: 947. exists, as
     described in *note Environment variables: 128f, its entries are
     added next.  Note that on Windows, paths in this variable must be
     separated by semicolons, to distinguish them from the colon used in
     drive identifiers (‘C:\’ etc.).

   * Additional “application paths” can be added in the registry as
     subkeys of ‘\SOFTWARE\Python\PythonCore{version}\PythonPath’ under
     both the ‘HKEY_CURRENT_USER’ and ‘HKEY_LOCAL_MACHINE’ hives.
     Subkeys which have semicolon-delimited path strings as their
     default value will cause each path to be added to *note sys.path:
     47d.  (Note that all known installers only use HKLM, so HKCU is
     typically empty.)

   * If the environment variable *note PYTHONHOME: 4cb. is set, it is
     assumed as “Python Home”.  Otherwise, the path of the main Python
     executable is used to locate a “landmark file” (either ‘Lib\os.py’
     or ‘pythonXY.zip’) to deduce the “Python Home”.  If a Python home
     is found, the relevant sub-directories added to *note sys.path:
     47d. (‘Lib’, ‘plat-win’, etc) are based on that folder.  Otherwise,
     the core Python path is constructed from the PythonPath stored in
     the registry.

   * If the Python Home cannot be located, no *note PYTHONPATH: 947. is
     specified in the environment, and no registry entries can be found,
     a default path with relative entries is used (e.g.
     ‘.\Lib;.\plat-win’, etc).

If a ‘pyvenv.cfg’ file is found alongside the main executable or in the
directory one level above the executable, the following variations
apply:

   * If ‘home’ is an absolute path and *note PYTHONHOME: 4cb. is not
     set, this path is used instead of the path to the main executable
     when deducing the home location.

The end result of all this is:

   * When running ‘python.exe’, or any other .exe in the main Python
     directory (either an installed version, or directly from the
     PCbuild directory), the core path is deduced, and the core paths in
     the registry are ignored.  Other “application paths” in the
     registry are always read.

   * When Python is hosted in another .exe (different directory,
     embedded via COM, etc), the “Python Home” will not be deduced, so
     the core path from the registry is used.  Other “application paths”
     in the registry are always read.

   * If Python can’t find its home and there are no registry value
     (frozen .exe, some very strange installation setup) you get a path
     with some default, but relative, paths.

For those who want to bundle Python into their application or
distribution, the following advice will prevent conflicts with other
installations:

   * Include a ‘._pth’ file alongside your executable containing the
     directories to include.  This will ignore paths listed in the
     registry and environment variables, and also ignore *note site: eb.
     unless ‘import site’ is listed.

   * If you are loading ‘python3.dll’ or ‘python37.dll’ in your own
     executable, explicitly call *note Py_SetPath(): 271. or (at least)
     *note Py_SetProgramName(): eba. before *note Py_Initialize(): 42e.

   * Clear and/or overwrite *note PYTHONPATH: 947. and set *note
     PYTHONHOME: 4cb. before launching ‘python.exe’ from your
     application.

   * If you cannot use the previous suggestions (for example, you are a
     distribution that allows people to run ‘python.exe’ directly),
     ensure that the landmark file (‘Lib\os.py’) exists in your install
     directory.  (Note that it will not be detected inside a ZIP file,
     but a correctly named ZIP file will be detected instead.)

These will ensure that the files in a system-wide installation will not
take precedence over the copy of the standard library bundled with your
application.  Otherwise, your users may experience problems using your
application.  Note that the first suggestion is the best, as the others
may still be susceptible to non-standard paths in the registry and user
site-packages.

     Changed in version 3.6:

        * Adds ‘._pth’ file support and removes ‘applocal’ option from
          ‘pyvenv.cfg’.

        * Adds ‘pythonXX.zip’ as a potential landmark when directly
          adjacent to the executable.

     Deprecated since version 3.6: Modules specified in the registry
     under ‘Modules’ (not ‘PythonPath’) may be imported by *note
     importlib.machinery.WindowsRegistryFinder: 5da.  This finder is
     enabled on Windows in 3.6.0 and earlier, but may need to be
     explicitly added to *note sys.meta_path: 5db. in the future.


File: python.info,  Node: Additional modules,  Next: Compiling Python on Windows,  Prev: Finding modules,  Up: Using Python on Windows

3.3.9 Additional modules
------------------------

Even though Python aims to be portable among all platforms, there are
features that are unique to Windows.  A couple of modules, both in the
standard library and external, and snippets exist to use these features.

The Windows-specific standard modules are documented in *note MS Windows
Specific Services: 12cf.

* Menu:

* PyWin32::
* cx_Freeze::
* WConio::


File: python.info,  Node: PyWin32,  Next: cx_Freeze,  Up: Additional modules

3.3.9.1 PyWin32
...............

The PyWin32(1) module by Mark Hammond is a collection of modules for
advanced Windows-specific support.  This includes utilities for:

   * Component Object Model(2) (COM)

   * Win32 API calls

   * Registry

   * Event log

   * Microsoft Foundation Classes(3) (MFC) user interfaces

PythonWin(4) is a sample MFC application shipped with PyWin32.  It is an
embeddable IDE with a built-in debugger.

See also
........

Win32 How Do I...?(5)

     by Tim Golden

Python and COM(6)

     by David and Paul Boddie

   ---------- Footnotes ----------

   (1) https://pypi.org/project/pywin32

   (2) 
https://docs.microsoft.com/en-us/windows/desktop/com/component-object-model–com–portal

   (3) https://msdn.microsoft.com/en-us/library/fe1cf721%28VS.80%29.aspx

   (4) 
https://web.archive.org/web/20060524042422/https://www.python.org/windows/pythonwin/

   (5) http://timgolden.me.uk/python/win32_how_do_i.html

   (6) http://www.boddie.org.uk/python/COM.html


File: python.info,  Node: cx_Freeze,  Next: WConio,  Prev: PyWin32,  Up: Additional modules

3.3.9.2 cx_Freeze
.................

cx_Freeze(1) is a *note distutils: 39. extension (see *note Extending
Distutils: 12d2.) which wraps Python scripts into executable Windows
programs (‘`*'.exe’ files).  When you have done this, you can distribute
your application without requiring your users to install Python.

   ---------- Footnotes ----------

   (1) https://anthony-tuininga.github.io/cx_Freeze/


File: python.info,  Node: WConio,  Prev: cx_Freeze,  Up: Additional modules

3.3.9.3 WConio
..............

Since Python’s advanced terminal handling layer, *note curses: 2c, is
restricted to Unix-like systems, there is a library exclusive to Windows
as well: Windows Console I/O for Python.

WConio(1) is a wrapper for Turbo-C’s ‘CONIO.H’, used to create text user
interfaces.

   ---------- Footnotes ----------

   (1) http://newcenturycomputers.net/projects/wconio.html


File: python.info,  Node: Compiling Python on Windows,  Next: Other Platforms,  Prev: Additional modules,  Up: Using Python on Windows

3.3.10 Compiling Python on Windows
----------------------------------

If you want to compile CPython yourself, first thing you should do is
get the source(1).  You can download either the latest release’s source
or just grab a fresh checkout(2).

The source tree contains a build solution and project files for
Microsoft Visual Studio 2015, which is the compiler used to build the
official Python releases.  These files are in the ‘PCbuild’ directory.

Check ‘PCbuild/readme.txt’ for general information on the build process.

For extension modules, consult *note Building C and C++ Extensions on
Windows: 12d5.

See also
........

Python + Windows + distutils + SWIG + gcc MinGW(3)

     or “Creating Python extensions in C/C++ with SWIG and compiling
     them with MinGW gcc under Windows” or “Installing Python extension
     with distutils and without Microsoft Visual C++” by Sébastien
     Sauvage, 2003

MingW – Python extensions(4)

   ---------- Footnotes ----------

   (1) https://www.python.org/downloads/source/

   (2) https://devguide.python.org/setup/#getting-the-source-code

   (3) http://sebsauvage.net/python/mingw.html

   (4) http://www.mingw.org/wiki/FAQ#toc14


File: python.info,  Node: Other Platforms,  Prev: Compiling Python on Windows,  Up: Using Python on Windows

3.3.11 Other Platforms
----------------------

With ongoing development of Python, some platforms that used to be
supported earlier are no longer supported (due to the lack of users or
developers).  Check PEP 11(1) for details on all unsupported platforms.

   * Windows CE(2) is still supported.

   * The Cygwin(3) installer offers to install the Python interpreter as
     well (cf.  Cygwin package source(4), Maintainer releases(5))

See Python for Windows(6) for detailed information about platforms with
pre-compiled installers.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0011

   (2) http://pythonce.sourceforge.net/

   (3) https://cygwin.com/

   (4) 
ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/mirrors/cygnus/release/python

   (5) http://www.tishler.net/jason/software/python/

   (6) https://www.python.org/downloads/windows/


File: python.info,  Node: Using Python on a Macintosh,  Next: Editors and IDEs,  Prev: Using Python on Windows,  Up: Python Setup and Usage

3.4 Using Python on a Macintosh
===============================


Author: Bob Savage <<bobsavage@mac.com>>

Python on a Macintosh running Mac OS X is in principle very similar to
Python on any other Unix platform, but there are a number of additional
features such as the IDE and the Package Manager that are worth pointing
out.

* Menu:

* Getting and Installing MacPython::
* The IDE::
* Installing Additional Python Packages::
* GUI Programming on the Mac::
* Distributing Python Applications on the Mac::
* Other Resources::


File: python.info,  Node: Getting and Installing MacPython,  Next: The IDE,  Up: Using Python on a Macintosh

3.4.1 Getting and Installing MacPython
--------------------------------------

Mac OS X 10.8 comes with Python 2.7 pre-installed by Apple.  If you
wish, you are invited to install the most recent version of Python 3
from the Python website (‘https://www.python.org’).  A current
“universal binary” build of Python, which runs natively on the Mac’s new
Intel and legacy PPC CPU’s, is available there.

What you get after installing is a number of things:

   * A ‘Python 3.8’ folder in your ‘Applications’ folder.  In here you
     find IDLE, the development environment that is a standard part of
     official Python distributions; PythonLauncher, which handles
     double-clicking Python scripts from the Finder; and the “Build
     Applet” tool, which allows you to package Python scripts as
     standalone applications on your system.

   * A framework ‘/Library/Frameworks/Python.framework’, which includes
     the Python executable and libraries.  The installer adds this
     location to your shell path.  To uninstall MacPython, you can
     simply remove these three things.  A symlink to the Python
     executable is placed in /usr/local/bin/.

The Apple-provided build of Python is installed in
‘/System/Library/Frameworks/Python.framework’ and ‘/usr/bin/python’,
respectively.  You should never modify or delete these, as they are
Apple-controlled and are used by Apple- or third-party software.
Remember that if you choose to install a newer Python version from
python.org, you will have two different but functional Python
installations on your computer, so it will be important that your paths
and usages are consistent with what you want to do.

IDLE includes a help menu that allows you to access Python
documentation.  If you are completely new to Python you should start
reading the tutorial introduction in that document.

If you are familiar with Python on other Unix platforms you should read
the section on running Python scripts from the Unix shell.

* Menu:

* How to run a Python script::
* Running scripts with a GUI::
* Configuration::


File: python.info,  Node: How to run a Python script,  Next: Running scripts with a GUI,  Up: Getting and Installing MacPython

3.4.1.1 How to run a Python script
..................................

Your best way to get started with Python on Mac OS X is through the IDLE
integrated development environment, see section *note The IDE: 12dd. and
use the Help menu when the IDE is running.

If you want to run Python scripts from the Terminal window command line
or from the Finder you first need an editor to create your script.  Mac
OS X comes with a number of standard Unix command line editors, ‘vim’
and ‘emacs’ among them.  If you want a more Mac-like editor, ‘BBEdit’ or
‘TextWrangler’ from Bare Bones Software (see
‘http://www.barebones.com/products/bbedit/index.html’) are good choices,
as is ‘TextMate’ (see ‘https://macromates.com/’).  Other editors include
‘Gvim’ (‘http://macvim-dev.github.io/macvim/’) and ‘Aquamacs’
(‘http://aquamacs.org/’).

To run your script from the Terminal window you must make sure that
‘/usr/local/bin’ is in your shell search path.

To run your script from the Finder you have two options:

   * Drag it to ‘PythonLauncher’

   * Select ‘PythonLauncher’ as the default application to open your
     script (or any .py script) through the finder Info window and
     double-click it.  ‘PythonLauncher’ has various preferences to
     control how your script is launched.  Option-dragging allows you to
     change these for one invocation, or use its Preferences menu to
     change things globally.


File: python.info,  Node: Running scripts with a GUI,  Next: Configuration,  Prev: How to run a Python script,  Up: Getting and Installing MacPython

3.4.1.2 Running scripts with a GUI
..................................

With older versions of Python, there is one Mac OS X quirk that you need
to be aware of: programs that talk to the Aqua window manager (in other
words, anything that has a GUI) need to be run in a special way.  Use
‘pythonw’ instead of ‘python’ to start such scripts.

With Python 3.8, you can use either ‘python’ or ‘pythonw’.


File: python.info,  Node: Configuration,  Prev: Running scripts with a GUI,  Up: Getting and Installing MacPython

3.4.1.3 Configuration
.....................

Python on OS X honors all standard Unix environment variables such as
*note PYTHONPATH: 947, but setting these variables for programs started
from the Finder is non-standard as the Finder does not read your
‘.profile’ or ‘.cshrc’ at startup.  You need to create a file
‘~/.MacOSX/environment.plist’.  See Apple’s Technical Document QA1067
for details.

For more information on installation Python packages in MacPython, see
section *note Installing Additional Python Packages: 12e1.


File: python.info,  Node: The IDE,  Next: Installing Additional Python Packages,  Prev: Getting and Installing MacPython,  Up: Using Python on a Macintosh

3.4.2 The IDE
-------------

MacPython ships with the standard IDLE development environment.  A good
introduction to using IDLE can be found at
‘http://www.hashcollision.org/hkn/python/idle_intro/index.html’.


File: python.info,  Node: Installing Additional Python Packages,  Next: GUI Programming on the Mac,  Prev: The IDE,  Up: Using Python on a Macintosh

3.4.3 Installing Additional Python Packages
-------------------------------------------

There are several methods to install additional Python packages:

   * Packages can be installed via the standard Python distutils mode
     (‘python setup.py install’).

   * Many packages can also be installed via the ‘setuptools’ extension
     or ‘pip’ wrapper, see ‘https://pip.pypa.io/’.


File: python.info,  Node: GUI Programming on the Mac,  Next: Distributing Python Applications on the Mac,  Prev: Installing Additional Python Packages,  Up: Using Python on a Macintosh

3.4.4 GUI Programming on the Mac
--------------------------------

There are several options for building GUI applications on the Mac with
Python.

`PyObjC' is a Python binding to Apple’s Objective-C/Cocoa framework,
which is the foundation of most modern Mac development.  Information on
PyObjC is available from ‘https://pypi.org/project/pyobjc/’.

The standard Python GUI toolkit is *note tkinter: 10c, based on the
cross-platform Tk toolkit (‘https://www.tcl.tk’).  An Aqua-native
version of Tk is bundled with OS X by Apple, and the latest version can
be downloaded and installed from ‘https://www.activestate.com’; it can
also be built from source.

`wxPython' is another popular cross-platform GUI toolkit that runs
natively on Mac OS X. Packages and documentation are available from
‘https://www.wxpython.org’.

`PyQt' is another popular cross-platform GUI toolkit that runs natively
on Mac OS X. More information can be found at
‘https://riverbankcomputing.com/software/pyqt/intro’.


File: python.info,  Node: Distributing Python Applications on the Mac,  Next: Other Resources,  Prev: GUI Programming on the Mac,  Up: Using Python on a Macintosh

3.4.5 Distributing Python Applications on the Mac
-------------------------------------------------

The “Build Applet” tool that is placed in the MacPython 3.6 folder is
fine for packaging small Python scripts on your own machine to run as a
standard Mac application.  This tool, however, is not robust enough to
distribute Python applications to other users.

The standard tool for deploying standalone Python applications on the
Mac is ‘py2app’.  More information on installing and using py2app can be
found at ‘http://undefined.org/python/#py2app’.


File: python.info,  Node: Other Resources,  Prev: Distributing Python Applications on the Mac,  Up: Using Python on a Macintosh

3.4.6 Other Resources
---------------------

The MacPython mailing list is an excellent support resource for Python
users and developers on the Mac:

‘https://www.python.org/community/sigs/current/pythonmac-sig/’

Another useful resource is the MacPython wiki:

‘https://wiki.python.org/moin/MacPython’


File: python.info,  Node: Editors and IDEs,  Prev: Using Python on a Macintosh,  Up: Python Setup and Usage

3.5 Editors and IDEs
====================

There are a number of IDEs that support Python programming language.
Many editors and IDEs provide syntax highlighting, debugging tools, and
PEP 8(1) checks.

Please go to Python Editors(2) and Integrated Development
Environments(3) for a comprehensive list.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0008

   (2) https://wiki.python.org/moin/PythonEditors

   (3) https://wiki.python.org/moin/IntegratedDevelopmentEnvironments


File: python.info,  Node: The Python Language Reference,  Next: The Python Standard Library,  Prev: Python Setup and Usage,  Up: Top

4 The Python Language Reference
*******************************

This reference manual describes the syntax and “core semantics” of the
language.  It is terse, but attempts to be exact and complete.  The
semantics of non-essential built-in object types and of the built-in
functions and modules are described in *note The Python Standard
Library: 1135.  For an informal introduction to the language, see *note
The Python Tutorial: 1134.  For C or C++ programmers, two additional
manuals exist: *note Extending and Embedding the Python Interpreter:
1137. describes the high-level picture of how to write a Python
extension module, and the *note Python/C API Reference Manual: 1138.
describes the interfaces available to C/C++ programmers in detail.

* Menu:

* Introduction: Introduction<5>.
* Lexical analysis::
* Data model::
* Execution model::
* The import system::
* Expressions::
* Simple statements::
* Compound statements::
* Top-level components::
* Full Grammar specification::


File: python.info,  Node: Introduction<5>,  Next: Lexical analysis,  Up: The Python Language Reference

4.1 Introduction
================

This reference manual describes the Python programming language.  It is
not intended as a tutorial.

While I am trying to be as precise as possible, I chose to use English
rather than formal specifications for everything except syntax and
lexical analysis.  This should make the document more understandable to
the average reader, but will leave room for ambiguities.  Consequently,
if you were coming from Mars and tried to re-implement Python from this
document alone, you might have to guess things and in fact you would
probably end up implementing quite a different language.  On the other
hand, if you are using Python and wonder what the precise rules about a
particular area of the language are, you should definitely be able to
find them here.  If you would like to see a more formal definition of
the language, maybe you could volunteer your time — or invent a cloning
machine :-).

It is dangerous to add too many implementation details to a language
reference document — the implementation may change, and other
implementations of the same language may work differently.  On the other
hand, CPython is the one Python implementation in widespread use
(although alternate implementations continue to gain support), and its
particular quirks are sometimes worth being mentioned, especially where
the implementation imposes additional limitations.  Therefore, you’ll
find short “implementation notes” sprinkled throughout the text.

Every Python implementation comes with a number of built-in and standard
modules.  These are documented in *note The Python Standard Library:
1135.  A few built-in modules are mentioned when they interact in a
significant way with the language definition.

* Menu:

* Alternate Implementations::
* Notation::


File: python.info,  Node: Alternate Implementations,  Next: Notation,  Up: Introduction<5>

4.1.1 Alternate Implementations
-------------------------------

Though there is one Python implementation which is by far the most
popular, there are some alternate implementations which are of
particular interest to different audiences.

Known implementations include:

CPython

     This is the original and most-maintained implementation of Python,
     written in C. New language features generally appear here first.

Jython

     Python implemented in Java.  This implementation can be used as a
     scripting language for Java applications, or can be used to create
     applications using the Java class libraries.  It is also often used
     to create tests for Java libraries.  More information can be found
     at the Jython website(1).

Python for .NET

     This implementation actually uses the CPython implementation, but
     is a managed .NET application and makes .NET libraries available.
     It was created by Brian Lloyd.  For more information, see the
     Python for .NET home page(2).

IronPython

     An alternate Python for .NET. Unlike Python.NET, this is a complete
     Python implementation that generates IL, and compiles Python code
     directly to .NET assemblies.  It was created by Jim Hugunin, the
     original creator of Jython.  For more information, see the
     IronPython website(3).

PyPy

     An implementation of Python written completely in Python.  It
     supports several advanced features not found in other
     implementations like stackless support and a Just in Time compiler.
     One of the goals of the project is to encourage experimentation
     with the language itself by making it easier to modify the
     interpreter (since it is written in Python).  Additional
     information is available on the PyPy project’s home page(4).

Each of these implementations varies in some way from the language as
documented in this manual, or introduces specific information beyond
what’s covered in the standard Python documentation.  Please refer to
the implementation-specific documentation to determine what else you
need to know about the specific implementation you’re using.

   ---------- Footnotes ----------

   (1) http://www.jython.org/

   (2) https://pythonnet.github.io/

   (3) http://ironpython.net/

   (4) http://pypy.org/


File: python.info,  Node: Notation,  Prev: Alternate Implementations,  Up: Introduction<5>

4.1.2 Notation
--------------

The descriptions of lexical analysis and syntax use a modified BNF
grammar notation.  This uses the following style of definition:

     name      ::= lc_letter (lc_letter | "_")*
     lc_letter ::= "a"..."z"

The first line says that a ‘name’ is an ‘lc_letter’ followed by a
sequence of zero or more ‘lc_letter’s and underscores.  An ‘lc_letter’
in turn is any of the single characters ‘'a'’ through ‘'z'’.  (This rule
is actually adhered to for the names defined in lexical and grammar
rules in this document.)

Each rule begins with a name (which is the name defined by the rule) and
‘::=’.  A vertical bar (‘|’) is used to separate alternatives; it is the
least binding operator in this notation.  A star (‘*’) means zero or
more repetitions of the preceding item; likewise, a plus (‘+’) means one
or more repetitions, and a phrase enclosed in square brackets (‘[ ]’)
means zero or one occurrences (in other words, the enclosed phrase is
optional).  The ‘*’ and ‘+’ operators bind as tightly as possible;
parentheses are used for grouping.  Literal strings are enclosed in
quotes.  White space is only meaningful to separate tokens.  Rules are
normally contained on a single line; rules with many alternatives may be
formatted alternatively with each line after the first beginning with a
vertical bar.

In lexical definitions (as the example above), two more conventions are
used: Two literal characters separated by three dots mean a choice of
any single character in the given (inclusive) range of ASCII characters.
A phrase between angular brackets (‘<...>’) gives an informal
description of the symbol defined; e.g., this could be used to describe
the notion of ‘control character’ if needed.

Even though the notation used is almost the same, there is a big
difference between the meaning of lexical and syntactic definitions: a
lexical definition operates on the individual characters of the input
source, while a syntax definition operates on the stream of tokens
generated by the lexical analysis.  All uses of BNF in the next chapter
(“Lexical Analysis”) are lexical definitions; uses in subsequent
chapters are syntactic definitions.


File: python.info,  Node: Lexical analysis,  Next: Data model,  Prev: Introduction<5>,  Up: The Python Language Reference

4.2 Lexical analysis
====================

A Python program is read by a `parser'.  Input to the parser is a stream
of `tokens', generated by the `lexical analyzer'.  This chapter
describes how the lexical analyzer breaks a file into tokens.

Python reads program text as Unicode code points; the encoding of a
source file can be given by an encoding declaration and defaults to
UTF-8, see PEP 3120(1) for details.  If the source file cannot be
decoded, a *note SyntaxError: 44d. is raised.

* Menu:

* Line structure::
* Other tokens::
* Identifiers and keywords::
* Literals::
* Operators::
* Delimiters::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3120


File: python.info,  Node: Line structure,  Next: Other tokens,  Up: Lexical analysis

4.2.1 Line structure
--------------------

A Python program is divided into a number of `logical lines'.

* Menu:

* Logical lines::
* Physical lines::
* Comments::
* Encoding declarations::
* Explicit line joining::
* Implicit line joining::
* Blank lines::
* Indentation::
* Whitespace between tokens::


File: python.info,  Node: Logical lines,  Next: Physical lines,  Up: Line structure

4.2.1.1 Logical lines
.....................

The end of a logical line is represented by the token NEWLINE.
Statements cannot cross logical line boundaries except where NEWLINE is
allowed by the syntax (e.g., between statements in compound statements).
A logical line is constructed from one or more `physical lines' by
following the explicit or implicit `line joining' rules.


File: python.info,  Node: Physical lines,  Next: Comments,  Prev: Logical lines,  Up: Line structure

4.2.1.2 Physical lines
......................

A physical line is a sequence of characters terminated by an end-of-line
sequence.  In source files and strings, any of the standard platform
line termination sequences can be used - the Unix form using ASCII LF
(linefeed), the Windows form using the ASCII sequence CR LF (return
followed by linefeed), or the old Macintosh form using the ASCII CR
(return) character.  All of these forms can be used equally, regardless
of platform.  The end of input also serves as an implicit terminator for
the final physical line.

When embedding Python, source code strings should be passed to Python
APIs using the standard C conventions for newline characters (the ‘\n’
character, representing ASCII LF, is the line terminator).


File: python.info,  Node: Comments,  Next: Encoding declarations,  Prev: Physical lines,  Up: Line structure

4.2.1.3 Comments
................

A comment starts with a hash character (‘#’) that is not part of a
string literal, and ends at the end of the physical line.  A comment
signifies the end of the logical line unless the implicit line joining
rules are invoked.  Comments are ignored by the syntax.


File: python.info,  Node: Encoding declarations,  Next: Explicit line joining,  Prev: Comments,  Up: Line structure

4.2.1.4 Encoding declarations
.............................

If a comment in the first or second line of the Python script matches
the regular expression ‘coding[=:]\s*([-\w.]+)’, this comment is
processed as an encoding declaration; the first group of this expression
names the encoding of the source code file.  The encoding declaration
must appear on a line of its own.  If it is the second line, the first
line must also be a comment-only line.  The recommended forms of an
encoding expression are

     # -*- coding: <encoding-name> -*-

which is recognized also by GNU Emacs, and

     # vim:fileencoding=<encoding-name>

which is recognized by Bram Moolenaar’s VIM.

If no encoding declaration is found, the default encoding is UTF-8.  In
addition, if the first bytes of the file are the UTF-8 byte-order mark
(‘b'\xef\xbb\xbf'’), the declared file encoding is UTF-8 (this is
supported, among others, by Microsoft’s ‘notepad’).

If an encoding is declared, the encoding name must be recognized by
Python.  The encoding is used for all lexical analysis, including string
literals, comments and identifiers.


File: python.info,  Node: Explicit line joining,  Next: Implicit line joining,  Prev: Encoding declarations,  Up: Line structure

4.2.1.5 Explicit line joining
.............................

Two or more physical lines may be joined into logical lines using
backslash characters (‘\’), as follows: when a physical line ends in a
backslash that is not part of a string literal or comment, it is joined
with the following forming a single logical line, deleting the backslash
and the following end-of-line character.  For example:

     if 1900 < year < 2100 and 1 <= month <= 12 \
        and 1 <= day <= 31 and 0 <= hour < 24 \
        and 0 <= minute < 60 and 0 <= second < 60:   # Looks like a valid date
             return 1

A line ending in a backslash cannot carry a comment.  A backslash does
not continue a comment.  A backslash does not continue a token except
for string literals (i.e., tokens other than string literals cannot be
split across physical lines using a backslash).  A backslash is illegal
elsewhere on a line outside a string literal.


File: python.info,  Node: Implicit line joining,  Next: Blank lines,  Prev: Explicit line joining,  Up: Line structure

4.2.1.6 Implicit line joining
.............................

Expressions in parentheses, square brackets or curly braces can be split
over more than one physical line without using backslashes.  For
example:

     month_names = ['Januari', 'Februari', 'Maart',      # These are the
                    'April',   'Mei',      'Juni',       # Dutch names
                    'Juli',    'Augustus', 'September',  # for the months
                    'Oktober', 'November', 'December']   # of the year

Implicitly continued lines can carry comments.  The indentation of the
continuation lines is not important.  Blank continuation lines are
allowed.  There is no NEWLINE token between implicit continuation lines.
Implicitly continued lines can also occur within triple-quoted strings
(see below); in that case they cannot carry comments.


File: python.info,  Node: Blank lines,  Next: Indentation,  Prev: Implicit line joining,  Up: Line structure

4.2.1.7 Blank lines
...................

A logical line that contains only spaces, tabs, formfeeds and possibly a
comment, is ignored (i.e., no NEWLINE token is generated).  During
interactive input of statements, handling of a blank line may differ
depending on the implementation of the read-eval-print loop.  In the
standard interactive interpreter, an entirely blank logical line (i.e.
one containing not even whitespace or a comment) terminates a multi-line
statement.


File: python.info,  Node: Indentation,  Next: Whitespace between tokens,  Prev: Blank lines,  Up: Line structure

4.2.1.8 Indentation
...................

Leading whitespace (spaces and tabs) at the beginning of a logical line
is used to compute the indentation level of the line, which in turn is
used to determine the grouping of statements.

Tabs are replaced (from left to right) by one to eight spaces such that
the total number of characters up to and including the replacement is a
multiple of eight (this is intended to be the same rule as used by
Unix).  The total number of spaces preceding the first non-blank
character then determines the line’s indentation.  Indentation cannot be
split over multiple physical lines using backslashes; the whitespace up
to the first backslash determines the indentation.

Indentation is rejected as inconsistent if a source file mixes tabs and
spaces in a way that makes the meaning dependent on the worth of a tab
in spaces; a *note TabError: e6b. is raised in that case.

`Cross-platform compatibility note:' because of the nature of text
editors on non-UNIX platforms, it is unwise to use a mixture of spaces
and tabs for the indentation in a single source file.  It should also be
noted that different platforms may explicitly limit the maximum
indentation level.

A formfeed character may be present at the start of the line; it will be
ignored for the indentation calculations above.  Formfeed characters
occurring elsewhere in the leading whitespace have an undefined effect
(for instance, they may reset the space count to zero).

The indentation levels of consecutive lines are used to generate INDENT
and DEDENT tokens, using a stack, as follows.

Before the first line of the file is read, a single zero is pushed on
the stack; this will never be popped off again.  The numbers pushed on
the stack will always be strictly increasing from bottom to top.  At the
beginning of each logical line, the line’s indentation level is compared
to the top of the stack.  If it is equal, nothing happens.  If it is
larger, it is pushed on the stack, and one INDENT token is generated.
If it is smaller, it `must' be one of the numbers occurring on the
stack; all numbers on the stack that are larger are popped off, and for
each number popped off a DEDENT token is generated.  At the end of the
file, a DEDENT token is generated for each number remaining on the stack
that is larger than zero.

Here is an example of a correctly (though confusingly) indented piece of
Python code:

     def perm(l):
             # Compute the list of all permutations of l
         if len(l) <= 1:
                       return [l]
         r = []
         for i in range(len(l)):
                  s = l[:i] + l[i+1:]
                  p = perm(s)
                  for x in p:
                   r.append(l[i:i+1] + x)
         return r

The following example shows various indentation errors:

      def perm(l):                       # error: first line indented
     for i in range(len(l)):             # error: not indented
         s = l[:i] + l[i+1:]
             p = perm(l[:i] + l[i+1:])   # error: unexpected indent
             for x in p:
                     r.append(l[i:i+1] + x)
                 return r                # error: inconsistent dedent

(Actually, the first three errors are detected by the parser; only the
last error is found by the lexical analyzer — the indentation of ‘return
r’ does not match a level popped off the stack.)


File: python.info,  Node: Whitespace between tokens,  Prev: Indentation,  Up: Line structure

4.2.1.9 Whitespace between tokens
.................................

Except at the beginning of a logical line or in string literals, the
whitespace characters space, tab and formfeed can be used
interchangeably to separate tokens.  Whitespace is needed between two
tokens only if their concatenation could otherwise be interpreted as a
different token (e.g., ab is one token, but a b is two tokens).


File: python.info,  Node: Other tokens,  Next: Identifiers and keywords,  Prev: Line structure,  Up: Lexical analysis

4.2.2 Other tokens
------------------

Besides NEWLINE, INDENT and DEDENT, the following categories of tokens
exist: `identifiers', `keywords', `literals', `operators', and
`delimiters'.  Whitespace characters (other than line terminators,
discussed earlier) are not tokens, but serve to delimit tokens.  Where
ambiguity exists, a token comprises the longest possible string that
forms a legal token, when read from left to right.


File: python.info,  Node: Identifiers and keywords,  Next: Literals,  Prev: Other tokens,  Up: Lexical analysis

4.2.3 Identifiers and keywords
------------------------------

Identifiers (also referred to as `names') are described by the following
lexical definitions.

The syntax of identifiers in Python is based on the Unicode standard
annex UAX-31, with elaboration and changes as defined below; see also
PEP 3131(1) for further details.

Within the ASCII range (U+0001..U+007F), the valid characters for
identifiers are the same as in Python 2.x: the uppercase and lowercase
letters ‘A’ through ‘Z’, the underscore ‘_’ and, except for the first
character, the digits ‘0’ through ‘9’.

Python 3.0 introduces additional characters from outside the ASCII range
(see PEP 3131(2)).  For these characters, the classification uses the
version of the Unicode Character Database as included in the *note
unicodedata: 11a. module.

Identifiers are unlimited in length.  Case is significant.

     identifier   ::= xid_start xid_continue*
     id_start     ::= <all characters in general categories Lu, Ll, Lt, Lm, Lo, Nl, the underscore, and characters with the Other_ID_Start property>
     id_continue  ::= <all characters in id_start, plus characters in the categories Mn, Mc, Nd, Pc and others with the Other_ID_Continue property>
     xid_start    ::= <all characters in id_start whose NFKC normalization is in "id_start xid_continue*">
     xid_continue ::= <all characters in id_continue whose NFKC normalization is in "id_continue*">

The Unicode category codes mentioned above stand for:

   * `Lu' - uppercase letters

   * `Ll' - lowercase letters

   * `Lt' - titlecase letters

   * `Lm' - modifier letters

   * `Lo' - other letters

   * `Nl' - letter numbers

   * `Mn' - nonspacing marks

   * `Mc' - spacing combining marks

   * `Nd' - decimal numbers

   * `Pc' - connector punctuations

   * `Other_ID_Start' - explicit list of characters in PropList.txt(3)
     to support backwards compatibility

   * `Other_ID_Continue' - likewise

All identifiers are converted into the normal form NFKC while parsing;
comparison of identifiers is based on NFKC.

A non-normative HTML file listing all valid identifier characters for
Unicode 4.1 can be found at
‘https://www.dcl.hpi.uni-potsdam.de/home/loewis/table-3131.html’.

* Menu:

* Keywords::
* Reserved classes of identifiers::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3131

   (2) https://www.python.org/dev/peps/pep-3131

   (3) http://www.unicode.org/Public/12.1.0/ucd/PropList.txt


File: python.info,  Node: Keywords,  Next: Reserved classes of identifiers,  Up: Identifiers and keywords

4.2.3.1 Keywords
................

The following identifiers are used as reserved words, or `keywords' of
the language, and cannot be used as ordinary identifiers.  They must be
spelled exactly as written here:

     False      await      else       import     pass
     None       break      except     in         raise
     True       class      finally    is         return
     and        continue   for        lambda     try
     as         def        from       nonlocal   while
     assert     del        global     not        with
     async      elif       if         or         yield


File: python.info,  Node: Reserved classes of identifiers,  Prev: Keywords,  Up: Identifiers and keywords

4.2.3.2 Reserved classes of identifiers
.......................................

Certain classes of identifiers (besides keywords) have special meanings.
These classes are identified by the patterns of leading and trailing
underscore characters:

‘_*’

     Not imported by ‘from module import *’.  The special identifier ‘_’
     is used in the interactive interpreter to store the result of the
     last evaluation; it is stored in the *note builtins: 13. module.
     When not in interactive mode, ‘_’ has no special meaning and is not
     defined.  See section *note The import statement: c10.

          Note: The name ‘_’ is often used in conjunction with
          internationalization; refer to the documentation for the *note
          gettext: 89. module for more information on this convention.

‘__*__’

     System-defined names.  These names are defined by the interpreter
     and its implementation (including the standard library).  Current
     system names are discussed in the *note Special method names: 503.
     section and elsewhere.  More will likely be defined in future
     versions of Python.  `Any' use of ‘__*__’ names, in any context,
     that does not follow explicitly documented use, is subject to
     breakage without warning.

‘__*’

     Class-private names.  Names in this category, when used within the
     context of a class definition, are re-written to use a mangled form
     to help avoid name clashes between “private” attributes of base and
     derived classes.  See section *note Identifiers (Names): 1318.


File: python.info,  Node: Literals,  Next: Operators,  Prev: Identifiers and keywords,  Up: Lexical analysis

4.2.4 Literals
--------------

Literals are notations for constant values of some built-in types.

* Menu:

* String and Bytes literals::
* String literal concatenation::
* Formatted string literals::
* Numeric literals::
* Integer literals::
* Floating point literals::
* Imaginary literals::


File: python.info,  Node: String and Bytes literals,  Next: String literal concatenation,  Up: Literals

4.2.4.1 String and Bytes literals
.................................

String literals are described by the following lexical definitions:

     stringliteral   ::= [stringprefix](shortstring | longstring)
     stringprefix    ::= "r" | "u" | "R" | "U" | "f" | "F"
                         | "fr" | "Fr" | "fR" | "FR" | "rf" | "rF" | "Rf" | "RF"
     shortstring     ::= "'" shortstringitem* "'" | '"' shortstringitem* '"'
     longstring      ::= "'''" longstringitem* "'''" | '"""' longstringitem* '"""'
     shortstringitem ::= shortstringchar | stringescapeseq
     longstringitem  ::= longstringchar | stringescapeseq
     shortstringchar ::= <any source character except "\" or newline or the quote>
     longstringchar  ::= <any source character except "\">
     stringescapeseq ::= "\" <any source character>

     bytesliteral   ::= bytesprefix(shortbytes | longbytes)
     bytesprefix    ::= "b" | "B" | "br" | "Br" | "bR" | "BR" | "rb" | "rB" | "Rb" | "RB"
     shortbytes     ::= "'" shortbytesitem* "'" | '"' shortbytesitem* '"'
     longbytes      ::= "'''" longbytesitem* "'''" | '"""' longbytesitem* '"""'
     shortbytesitem ::= shortbyteschar | bytesescapeseq
     longbytesitem  ::= longbyteschar | bytesescapeseq
     shortbyteschar ::= <any ASCII character except "\" or newline or the quote>
     longbyteschar  ::= <any ASCII character except "\">
     bytesescapeseq ::= "\" <any ASCII character>

One syntactic restriction not indicated by these productions is that
whitespace is not allowed between the *note stringprefix: 131e. or *note
bytesprefix: 1327. and the rest of the literal.  The source character
set is defined by the encoding declaration; it is UTF-8 if no encoding
declaration is given in the source file; see section *note Encoding
declarations: 1300.

In plain English: Both types of literals can be enclosed in matching
single quotes (‘'’) or double quotes (‘"’).  They can also be enclosed
in matching groups of three single or double quotes (these are generally
referred to as `triple-quoted strings').  The backslash (‘\’) character
is used to escape characters that otherwise have a special meaning, such
as newline, backslash itself, or the quote character.

Bytes literals are always prefixed with ‘'b'’ or ‘'B'’; they produce an
instance of the *note bytes: 326. type instead of the *note str: 325.
type.  They may only contain ASCII characters; bytes with a numeric
value of 128 or greater must be expressed with escapes.

Both string and bytes literals may optionally be prefixed with a letter
‘'r'’ or ‘'R'’; such strings are called `raw strings' and treat
backslashes as literal characters.  As a result, in string literals,
‘'\U'’ and ‘'\u'’ escapes in raw strings are not treated specially.
Given that Python 2.x’s raw unicode literals behave differently than
Python 3.x’s the ‘'ur'’ syntax is not supported.

New in version 3.3: The ‘'rb'’ prefix of raw bytes literals has been
added as a synonym of ‘'br'’.

New in version 3.3: Support for the unicode legacy literal (‘u'value'’)
was reintroduced to simplify the maintenance of dual Python 2.x and 3.x
codebases.  See PEP 414(1) for more information.

A string literal with ‘'f'’ or ‘'F'’ in its prefix is a `formatted
string literal'; see *note Formatted string literals: 15c.  The ‘'f'’
may be combined with ‘'r'’, but not with ‘'b'’ or ‘'u'’, therefore raw
formatted strings are possible, but formatted bytes literals are not.

In triple-quoted literals, unescaped newlines and quotes are allowed
(and are retained), except that three unescaped quotes in a row
terminate the literal.  (A “quote” is the character used to open the
literal, i.e.  either ‘'’ or ‘"’.)

Unless an ‘'r'’ or ‘'R'’ prefix is present, escape sequences in string
and bytes literals are interpreted according to rules similar to those
used by Standard C. The recognized escape sequences are:

Escape Sequence       Meaning                               Notes
                                                            
------------------------------------------------------------------------
                                                            
‘\newline’            Backslash and newline ignored
                      
                                                            
‘\\’                  Backslash (‘\’)
                      
                                                            
‘\'’                  Single quote (‘'’)
                      
                                                            
‘\"’                  Double quote (‘"’)
                      
                                                            
‘\a’                  ASCII Bell (BEL)
                      
                                                            
‘\b’                  ASCII Backspace (BS)
                      
                                                            
‘\f’                  ASCII Formfeed (FF)
                      
                                                            
‘\n’                  ASCII Linefeed (LF)
                      
                                                            
‘\r’                  ASCII Carriage Return (CR)
                      
                                                            
‘\t’                  ASCII Horizontal Tab (TAB)
                      
                                                            
‘\v’                  ASCII Vertical Tab (VT)
                      
                                                            
‘\ooo’                Character with octal value `ooo'      (1,3)
                                                            
                                                            
‘\xhh’                Character with hex value `hh'         (2,3)
                                                            

Escape sequences only recognized in string literals are:

Escape Sequence       Meaning                               Notes
                                                            
------------------------------------------------------------------------
                                                            
‘\N{name}’            Character named `name' in the         (4)
                      Unicode database                      
                      
                                                            
‘\uxxxx’              Character with 16-bit hex value       (5)
                      `xxxx'                                
                      
                                                            
‘\Uxxxxxxxx’          Character with 32-bit hex value       (6)
                      `xxxxxxxx'                            
                      

Notes:

  1. As in Standard C, up to three octal digits are accepted.

  2. Unlike in Standard C, exactly two hex digits are required.

  3. In a bytes literal, hexadecimal and octal escapes denote the byte
     with the given value.  In a string literal, these escapes denote a
     Unicode character with the given value.

  4. 
     Changed in version 3.3: Support for name aliases (2) has been
     added.

  5. Exactly four hex digits are required.

  6. Any Unicode character can be encoded this way.  Exactly eight hex
     digits are required.

Unlike Standard C, all unrecognized escape sequences are left in the
string unchanged, i.e., `the backslash is left in the result'.  (This
behavior is useful when debugging: if an escape sequence is mistyped,
the resulting output is more easily recognized as broken.)  It is also
important to note that the escape sequences only recognized in string
literals fall into the category of unrecognized escapes for bytes
literals.

     Changed in version 3.6: Unrecognized escape sequences produce a
     *note DeprecationWarning: 276.  In a future Python version they
     will be a *note SyntaxWarning: 191. and eventually a *note
     SyntaxError: 44d.

Even in a raw literal, quotes can be escaped with a backslash, but the
backslash remains in the result; for example, ‘r"\""’ is a valid string
literal consisting of two characters: a backslash and a double quote;
‘r"\"’ is not a valid string literal (even a raw string cannot end in an
odd number of backslashes).  Specifically, `a raw literal cannot end in
a single backslash' (since the backslash would escape the following
quote character).  Note also that a single backslash followed by a
newline is interpreted as those two characters as part of the literal,
`not' as a line continuation.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0414

   (2) (1) ‘http://www.unicode.org/Public/11.0.0/ucd/NameAliases.txt’


File: python.info,  Node: String literal concatenation,  Next: Formatted string literals,  Prev: String and Bytes literals,  Up: Literals

4.2.4.2 String literal concatenation
....................................

Multiple adjacent string or bytes literals (delimited by whitespace),
possibly using different quoting conventions, are allowed, and their
meaning is the same as their concatenation.  Thus, ‘"hello" 'world'’ is
equivalent to ‘"helloworld"’.  This feature can be used to reduce the
number of backslashes needed, to split long strings conveniently across
long lines, or even to add comments to parts of strings, for example:

     re.compile("[A-Za-z_]"       # letter or underscore
                "[A-Za-z0-9_]*"   # letter, digit or underscore
               )

Note that this feature is defined at the syntactical level, but
implemented at compile time.  The ‘+’ operator must be used to
concatenate string expressions at run time.  Also note that literal
concatenation can use different quoting styles for each component (even
mixing raw strings and triple quoted strings), and formatted string
literals may be concatenated with plain string literals.


File: python.info,  Node: Formatted string literals,  Next: Numeric literals,  Prev: String literal concatenation,  Up: Literals

4.2.4.3 Formatted string literals
.................................

New in version 3.6.

A `formatted string literal' or `f-string' is a string literal that is
prefixed with ‘'f'’ or ‘'F'’.  These strings may contain replacement
fields, which are expressions delimited by curly braces ‘{}’.  While
other string literals always have a constant value, formatted strings
are really expressions evaluated at run time.

Escape sequences are decoded like in ordinary string literals (except
when a literal is also marked as a raw string).  After decoding, the
grammar for the contents of the string is:

     f_string          ::= (literal_char | "{{" | "}}" | replacement_field)*
     replacement_field ::= "{" f_expression ["!" conversion] [":" format_spec] "}"
     f_expression      ::= (conditional_expression | "*" or_expr)
                             ("," conditional_expression | "," "*" or_expr)* [","]
                           | yield_expression
     conversion        ::= "s" | "r" | "a"
     format_spec       ::= (literal_char | NULL | replacement_field)*
     literal_char      ::= <any code point except "{", "}" or NULL>

The parts of the string outside curly braces are treated literally,
except that any doubled curly braces ‘'{{'’ or ‘'}}'’ are replaced with
the corresponding single curly brace.  A single opening curly bracket
‘'{'’ marks a replacement field, which starts with a Python expression.
After the expression, there may be a conversion field, introduced by an
exclamation point ‘'!'’.  A format specifier may also be appended,
introduced by a colon ‘':'’.  A replacement field ends with a closing
curly bracket ‘'}'’.

Expressions in formatted string literals are treated like regular Python
expressions surrounded by parentheses, with a few exceptions.  An empty
expression is not allowed, and both *note lambda: c22. and assignment
expressions ‘:=’ must be surrounded by explicit parentheses.
Replacement expressions can contain line breaks (e.g.  in triple-quoted
strings), but they cannot contain comments.  Each expression is
evaluated in the context where the formatted string literal appears, in
order from left to right.

If a conversion is specified, the result of evaluating the expression is
converted before formatting.  Conversion ‘'!s'’ calls *note str(): 325.
on the result, ‘'!r'’ calls *note repr(): 7c0, and ‘'!a'’ calls *note
ascii(): d3f.

The result is then formatted using the *note format(): 4d0. protocol.
The format specifier is passed to the *note __format__(): 942. method of
the expression or conversion result.  An empty string is passed when the
format specifier is omitted.  The formatted result is then included in
the final value of the whole string.

Top-level format specifiers may include nested replacement fields.
These nested fields may include their own conversion fields and *note
format specifiers: 4d3, but may not include more deeply-nested
replacement fields.  The *note format specifier mini-language: 4d3. is
the same as that used by the string .format() method.

Formatted string literals may be concatenated, but replacement fields
cannot be split across literals.

Some examples of formatted string literals:

     >>> name = "Fred"
     >>> f"He said his name is {name!r}."
     "He said his name is 'Fred'."
     >>> f"He said his name is {repr(name)}."  # repr() is equivalent to !r
     "He said his name is 'Fred'."
     >>> width = 10
     >>> precision = 4
     >>> value = decimal.Decimal("12.34567")
     >>> f"result: {value:{width}.{precision}}"  # nested fields
     'result:      12.35'
     >>> today = datetime(year=2017, month=1, day=27)
     >>> f"{today:%B %d, %Y}"  # using date format specifier
     'January 27, 2017'
     >>> number = 1024
     >>> f"{number:#0x}"  # using integer format specifier
     '0x400'

A consequence of sharing the same syntax as regular string literals is
that characters in the replacement fields must not conflict with the
quoting used in the outer formatted string literal:

     f"abc {a["x"]} def"    # error: outer string literal ended prematurely
     f"abc {a['x']} def"    # workaround: use different quoting

Backslashes are not allowed in format expressions and will raise an
error:

     f"newline: {ord('\n')}"  # raises SyntaxError

To include a value in which a backslash escape is required, create a
temporary variable.

     >>> newline = ord('\n')
     >>> f"newline: {newline}"
     'newline: 10'

Formatted string literals cannot be used as docstrings, even if they do
not include expressions.

     >>> def foo():
     ...     f"Not a docstring"
     ...
     >>> foo.__doc__ is None
     True

See also PEP 498(1) for the proposal that added formatted string
literals, and *note str.format(): 4cf, which uses a related format
string mechanism.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0498


File: python.info,  Node: Numeric literals,  Next: Integer literals,  Prev: Formatted string literals,  Up: Literals

4.2.4.4 Numeric literals
........................

There are three types of numeric literals: integers, floating point
numbers, and imaginary numbers.  There are no complex literals (complex
numbers can be formed by adding a real number and an imaginary number).

Note that numeric literals do not include a sign; a phrase like ‘-1’ is
actually an expression composed of the unary operator ‘‘-’‘ and the
literal ‘1’.


File: python.info,  Node: Integer literals,  Next: Floating point literals,  Prev: Numeric literals,  Up: Literals

4.2.4.5 Integer literals
........................

Integer literals are described by the following lexical definitions:

     integer      ::= decinteger | bininteger | octinteger | hexinteger
     decinteger   ::= nonzerodigit (["_"] digit)* | "0"+ (["_"] "0")*
     bininteger   ::= "0" ("b" | "B") (["_"] bindigit)+
     octinteger   ::= "0" ("o" | "O") (["_"] octdigit)+
     hexinteger   ::= "0" ("x" | "X") (["_"] hexdigit)+
     nonzerodigit ::= "1"..."9"
     digit        ::= "0"..."9"
     bindigit     ::= "0" | "1"
     octdigit     ::= "0"..."7"
     hexdigit     ::= digit | "a"..."f" | "A"..."F"

There is no limit for the length of integer literals apart from what can
be stored in available memory.

Underscores are ignored for determining the numeric value of the
literal.  They can be used to group digits for enhanced readability.
One underscore can occur between digits, and after base specifiers like
‘0x’.

Note that leading zeros in a non-zero decimal number are not allowed.
This is for disambiguation with C-style octal literals, which Python
used before version 3.0.

Some examples of integer literals:

     7     2147483647                        0o177    0b100110111
     3     79228162514264337593543950336     0o377    0xdeadbeef
           100_000_000_000                   0b_1110_0101

Changed in version 3.6: Underscores are now allowed for grouping
purposes in literals.


File: python.info,  Node: Floating point literals,  Next: Imaginary literals,  Prev: Integer literals,  Up: Literals

4.2.4.6 Floating point literals
...............................

Floating point literals are described by the following lexical
definitions:

     floatnumber   ::= pointfloat | exponentfloat
     pointfloat    ::= [digitpart] fraction | digitpart "."
     exponentfloat ::= (digitpart | pointfloat) exponent
     digitpart     ::= digit (["_"] digit)*
     fraction      ::= "." digitpart
     exponent      ::= ("e" | "E") ["+" | "-"] digitpart

Note that the integer and exponent parts are always interpreted using
radix 10.  For example, ‘077e010’ is legal, and denotes the same number
as ‘77e10’.  The allowed range of floating point literals is
implementation-dependent.  As in integer literals, underscores are
supported for digit grouping.

Some examples of floating point literals:

     3.14    10.    .001    1e100    3.14e-10    0e0    3.14_15_93

Changed in version 3.6: Underscores are now allowed for grouping
purposes in literals.


File: python.info,  Node: Imaginary literals,  Prev: Floating point literals,  Up: Literals

4.2.4.7 Imaginary literals
..........................

Imaginary literals are described by the following lexical definitions:

     imagnumber ::= (floatnumber | digitpart) ("j" | "J")

An imaginary literal yields a complex number with a real part of 0.0.
Complex numbers are represented as a pair of floating point numbers and
have the same restrictions on their range.  To create a complex number
with a nonzero real part, add a floating point number to it, e.g.,
‘(3+4j)’.  Some examples of imaginary literals:

     3.14j   10.j    10j     .001j   1e100j   3.14e-10j   3.14_15_93j


File: python.info,  Node: Operators,  Next: Delimiters,  Prev: Literals,  Up: Lexical analysis

4.2.5 Operators
---------------

The following tokens are operators:

     +       -       *       **      /       //      %      @
     <<      >>      &       |       ^       ~       :=
     <       >       <=      >=      ==      !=


File: python.info,  Node: Delimiters,  Prev: Operators,  Up: Lexical analysis

4.2.6 Delimiters
----------------

The following tokens serve as delimiters in the grammar:

     (       )       [       ]       {       }
     ,       :       .       ;       @       =       ->
     +=      -=      *=      /=      //=     %=      @=
     &=      |=      ^=      >>=     <<=     **=

The period can also occur in floating-point and imaginary literals.  A
sequence of three periods has a special meaning as an ellipsis literal.
The second half of the list, the augmented assignment operators, serve
lexically as delimiters, but also perform an operation.

The following printing ASCII characters have special meaning as part of
other tokens or are otherwise significant to the lexical analyzer:

     '       "       #       \

The following printing ASCII characters are not used in Python.  Their
occurrence outside string literals and comments is an unconditional
error:

     $       ?       `


File: python.info,  Node: Data model,  Next: Execution model,  Prev: Lexical analysis,  Up: The Python Language Reference

4.3 Data model
==============

* Menu:

* Objects, values and types: Objects values and types.
* The standard type hierarchy::
* Special method names::
* Coroutines::


File: python.info,  Node: Objects values and types,  Next: The standard type hierarchy,  Up: Data model

4.3.1 Objects, values and types
-------------------------------

`Objects' are Python’s abstraction for data.  All data in a Python
program is represented by objects or by relations between objects.  (In
a sense, and in conformance to Von Neumann’s model of a “stored program
computer,” code is also represented by objects.)

Every object has an identity, a type and a value.  An object’s
`identity' never changes once it has been created; you may think of it
as the object’s address in memory.  The ‘*note is: 135a.’ operator
compares the identity of two objects; the *note id(): d79. function
returns an integer representing its identity.

`CPython implementation detail:' For CPython, ‘id(x)’ is the memory
address where ‘x’ is stored.

An object’s type determines the operations that the object supports
(e.g., “does it have a length?”) and also defines the possible values
for objects of that type.  The *note type(): 5fd. function returns an
object’s type (which is an object itself).  Like its identity, an
object’s `type' is also unchangeable.  (1)

The `value' of some objects can change.  Objects whose value can change
are said to be `mutable'; objects whose value is unchangeable once they
are created are called `immutable'.  (The value of an immutable
container object that contains a reference to a mutable object can
change when the latter’s value is changed; however the container is
still considered immutable, because the collection of objects it
contains cannot be changed.  So, immutability is not strictly the same
as having an unchangeable value, it is more subtle.)  An object’s
mutability is determined by its type; for instance, numbers, strings and
tuples are immutable, while dictionaries and lists are mutable.

Objects are never explicitly destroyed; however, when they become
unreachable they may be garbage-collected.  An implementation is allowed
to postpone garbage collection or omit it altogether — it is a matter of
implementation quality how garbage collection is implemented, as long as
no objects are collected that are still reachable.

`CPython implementation detail:' CPython currently uses a
reference-counting scheme with (optional) delayed detection of
cyclically linked garbage, which collects most objects as soon as they
become unreachable, but is not guaranteed to collect garbage containing
circular references.  See the documentation of the *note gc: 86. module
for information on controlling the collection of cyclic garbage.  Other
implementations act differently and CPython may change.  Do not depend
on immediate finalization of objects when they become unreachable (so
you should always close files explicitly).

Note that the use of the implementation’s tracing or debugging
facilities may keep objects alive that would normally be collectable.
Also note that catching an exception with a ‘*note try: d65.…*note
except: b31.’ statement may keep objects alive.

Some objects contain references to “external” resources such as open
files or windows.  It is understood that these resources are freed when
the object is garbage-collected, but since garbage collection is not
guaranteed to happen, such objects also provide an explicit way to
release the external resource, usually a ‘close()’ method.  Programs are
strongly recommended to explicitly close such objects.  The ‘*note try:
d65.…*note finally: 182.’ statement and the ‘*note with: 6dd.’ statement
provide convenient ways to do this.

Some objects contain references to other objects; these are called
`containers'.  Examples of containers are tuples, lists and
dictionaries.  The references are part of a container’s value.  In most
cases, when we talk about the value of a container, we imply the values,
not the identities of the contained objects; however, when we talk about
the mutability of a container, only the identities of the immediately
contained objects are implied.  So, if an immutable container (like a
tuple) contains a reference to a mutable object, its value changes if
that mutable object is changed.

Types affect almost all aspects of object behavior.  Even the importance
of object identity is affected in some sense: for immutable types,
operations that compute new values may actually return a reference to
any existing object with the same type and value, while for mutable
objects this is not allowed.  E.g., after ‘a = 1; b = 1’, ‘a’ and ‘b’
may or may not refer to the same object with the value one, depending on
the implementation, but after ‘c = []; d = []’, ‘c’ and ‘d’ are
guaranteed to refer to two different, unique, newly created empty lists.
(Note that ‘c = d = []’ assigns the same object to both ‘c’ and ‘d’.)

   ---------- Footnotes ----------

   (1) (1) It `is' possible in some cases to change an object’s type,
under certain controlled conditions.  It generally isn’t a good idea
though, since it can lead to some very strange behaviour if it is
handled incorrectly.


File: python.info,  Node: The standard type hierarchy,  Next: Special method names,  Prev: Objects values and types,  Up: Data model

4.3.2 The standard type hierarchy
---------------------------------

Below is a list of the types that are built into Python.  Extension
modules (written in C, Java, or other languages, depending on the
implementation) can define additional types.  Future versions of Python
may add types to the type hierarchy (e.g., rational numbers, efficiently
stored arrays of integers, etc.), although such additions will often be
provided via the standard library instead.

Some of the type descriptions below contain a paragraph listing ‘special
attributes.’ These are attributes that provide access to the
implementation and are not intended for general use.  Their definition
may change in the future.

None

     This type has a single value.  There is a single object with this
     value.  This object is accessed through the built-in name ‘None’.
     It is used to signify the absence of a value in many situations,
     e.g., it is returned from functions that don’t explicitly return
     anything.  Its truth value is false.

NotImplemented

     This type has a single value.  There is a single object with this
     value.  This object is accessed through the built-in name
     ‘NotImplemented’.  Numeric methods and rich comparison methods
     should return this value if they do not implement the operation for
     the operands provided.  (The interpreter will then try the
     reflected operation, or some other fallback, depending on the
     operator.)  Its truth value is true.

     See *note Implementing the arithmetic operations: 135d. for more
     details.

Ellipsis

     This type has a single value.  There is a single object with this
     value.  This object is accessed through the literal ‘...’ or the
     built-in name ‘Ellipsis’.  Its truth value is true.

*note numbers.Number: 135e.

     These are created by numeric literals and returned as results by
     arithmetic operators and arithmetic built-in functions.  Numeric
     objects are immutable; once created their value never changes.
     Python numbers are of course strongly related to mathematical
     numbers, but subject to the limitations of numerical representation
     in computers.

     Python distinguishes between integers, floating point numbers, and
     complex numbers:

     *note numbers.Integral: 135f.

          These represent elements from the mathematical set of integers
          (positive and negative).

          There are two types of integers:

          Integers (*note int: 184.)

               These represent numbers in an unlimited range, subject to
               available (virtual) memory only.  For the purpose of
               shift and mask operations, a binary representation is
               assumed, and negative numbers are represented in a
               variant of 2’s complement which gives the illusion of an
               infinite string of sign bits extending to the left.

          Booleans (*note bool: 183.)

               These represent the truth values False and True.  The two
               objects representing the values ‘False’ and ‘True’ are
               the only Boolean objects.  The Boolean type is a subtype
               of the integer type, and Boolean values behave like the
               values 0 and 1, respectively, in almost all contexts, the
               exception being that when converted to a string, the
               strings ‘"False"’ or ‘"True"’ are returned, respectively.

          The rules for integer representation are intended to give the
          most meaningful interpretation of shift and mask operations
          involving negative integers.

     *note numbers.Real: 1360. (*note float: 187.)

          These represent machine-level double precision floating point
          numbers.  You are at the mercy of the underlying machine
          architecture (and C or Java implementation) for the accepted
          range and handling of overflow.  Python does not support
          single-precision floating point numbers; the savings in
          processor and memory usage that are usually the reason for
          using these are dwarfed by the overhead of using objects in
          Python, so there is no reason to complicate the language with
          two kinds of floating point numbers.

     *note numbers.Complex: 1361. (*note complex: 189.)

          These represent complex numbers as a pair of machine-level
          double precision floating point numbers.  The same caveats
          apply as for floating point numbers.  The real and imaginary
          parts of a complex number ‘z’ can be retrieved through the
          read-only attributes ‘z.real’ and ‘z.imag’.

Sequences

     These represent finite ordered sets indexed by non-negative
     numbers.  The built-in function *note len(): 150. returns the
     number of items of a sequence.  When the length of a sequence is
     `n', the index set contains the numbers 0, 1, …, `n'-1.  Item `i'
     of sequence `a' is selected by ‘a[i]’.

     Sequences also support slicing: ‘a[i:j]’ selects all items with
     index `k' such that `i' ‘<=’ `k' ‘<’ `j'.  When used as an
     expression, a slice is a sequence of the same type.  This implies
     that the index set is renumbered so that it starts at 0.

     Some sequences also support “extended slicing” with a third “step”
     parameter: ‘a[i:j:k]’ selects all items of `a' with index `x' where
     ‘x = i + n*k’, `n' ‘>=’ ‘0’ and `i' ‘<=’ `x' ‘<’ `j'.

     Sequences are distinguished according to their mutability:

     Immutable sequences

          An object of an immutable sequence type cannot change once it
          is created.  (If the object contains references to other
          objects, these other objects may be mutable and may be
          changed; however, the collection of objects directly
          referenced by an immutable object cannot change.)

          The following types are immutable sequences:

          Strings

               A string is a sequence of values that represent Unicode
               code points.  All the code points in the range ‘U+0000 -
               U+10FFFF’ can be represented in a string.  Python doesn’t
               have a ‘char’ type; instead, every code point in the
               string is represented as a string object with length ‘1’.
               The built-in function *note ord(): 1362. converts a code
               point from its string form to an integer in the range ‘0
               - 10FFFF’; *note chr(): 1363. converts an integer in the
               range ‘0 - 10FFFF’ to the corresponding length ‘1’ string
               object.  *note str.encode(): c2a. can be used to convert
               a *note str: 325. to *note bytes: 326. using the given
               text encoding, and *note bytes.decode(): c2b. can be used
               to achieve the opposite.

          Tuples

               The items of a tuple are arbitrary Python objects.
               Tuples of two or more items are formed by comma-separated
               lists of expressions.  A tuple of one item (a
               ‘singleton’) can be formed by affixing a comma to an
               expression (an expression by itself does not create a
               tuple, since parentheses must be usable for grouping of
               expressions).  An empty tuple can be formed by an empty
               pair of parentheses.

          Bytes

               A bytes object is an immutable array.  The items are
               8-bit bytes, represented by integers in the range 0 <= x
               < 256.  Bytes literals (like ‘b'abc'’) and the built-in
               *note bytes(): 326. constructor can be used to create
               bytes objects.  Also, bytes objects can be decoded to
               strings via the *note decode(): c2b. method.

     Mutable sequences

          Mutable sequences can be changed after they are created.  The
          subscription and slicing notations can be used as the target
          of assignment and *note del: 11a8. (delete) statements.

          There are currently two intrinsic mutable sequence types:

          Lists

               The items of a list are arbitrary Python objects.  Lists
               are formed by placing a comma-separated list of
               expressions in square brackets.  (Note that there are no
               special cases needed to form lists of length 0 or 1.)

          Byte Arrays

               A bytearray object is a mutable array.  They are created
               by the built-in *note bytearray(): 327. constructor.
               Aside from being mutable (and hence unhashable), byte
               arrays otherwise provide the same interface and
               functionality as immutable *note bytes: 326. objects.

          The extension module *note array: 7. provides an additional
          example of a mutable sequence type, as does the *note
          collections: 1e. module.

Set types

     These represent unordered, finite sets of unique, immutable
     objects.  As such, they cannot be indexed by any subscript.
     However, they can be iterated over, and the built-in function *note
     len(): 150. returns the number of items in a set.  Common uses for
     sets are fast membership testing, removing duplicates from a
     sequence, and computing mathematical operations such as
     intersection, union, difference, and symmetric difference.

     For set elements, the same immutability rules apply as for
     dictionary keys.  Note that numeric types obey the normal rules for
     numeric comparison: if two numbers compare equal (e.g., ‘1’ and
     ‘1.0’), only one of them can be contained in a set.

     There are currently two intrinsic set types:

     Sets

          These represent a mutable set.  They are created by the
          built-in *note set(): b62. constructor and can be modified
          afterwards by several methods, such as ‘add()’.

     Frozen sets

          These represent an immutable set.  They are created by the
          built-in *note frozenset(): be1. constructor.  As a frozenset
          is immutable and *note hashable: 1364, it can be used again as
          an element of another set, or as a dictionary key.

Mappings

     These represent finite sets of objects indexed by arbitrary index
     sets.  The subscript notation ‘a[k]’ selects the item indexed by
     ‘k’ from the mapping ‘a’; this can be used in expressions and as
     the target of assignments or *note del: 11a8. statements.  The
     built-in function *note len(): 150. returns the number of items in
     a mapping.

     There is currently a single intrinsic mapping type:

     Dictionaries

          These represent finite sets of objects indexed by nearly
          arbitrary values.  The only types of values not acceptable as
          keys are values containing lists or dictionaries or other
          mutable types that are compared by value rather than by object
          identity, the reason being that the efficient implementation
          of dictionaries requires a key’s hash value to remain
          constant.  Numeric types used for keys obey the normal rules
          for numeric comparison: if two numbers compare equal (e.g.,
          ‘1’ and ‘1.0’) then they can be used interchangeably to index
          the same dictionary entry.

          Dictionaries are mutable; they can be created by the ‘{...}’
          notation (see section *note Dictionary displays: 642.).

          The extension modules *note dbm.ndbm: 35. and *note dbm.gnu:
          34. provide additional examples of mapping types, as does the
          *note collections: 1e. module.

Callable types

     These are the types to which the function call operation (see
     section *note Calls: 640.) can be applied:

     User-defined functions

          A user-defined function object is created by a function
          definition (see section *note Function definitions: 1196.).
          It should be called with an argument list containing the same
          number of items as the function’s formal parameter list.

          Special attributes:

          Attribute                     Meaning
                                        
          ----------------------------------------------------------------------------------
                                                                            
          ‘__doc__’                     The function’s documentation        Writable
                                        string, or ‘None’ if unavailable;   
                                        not inherited by subclasses.
                                        
                                                                            
          *note __name__: c5a.          The function’s name.                Writable
                                                                            
                                                                            
          *note __qualname__: 1365.     The function’s                      Writable
                                        *note qualified name: 1366.         
                                        
                                        New in version 3.3.
                                        
                                                                            
          ‘__module__’                  The name of the module the          Writable
                                        function was defined in, or         
                                        ‘None’ if unavailable.
                                        
                                                                            
          ‘__defaults__’                A tuple containing default          Writable
                                        argument values for those           
                                        arguments that have defaults, or
                                        ‘None’ if no arguments have a
                                        default value.
                                        
                                                                            
          ‘__code__’                    The code object representing the    Writable
                                        compiled function body.             
                                        
                                                                            
          ‘__globals__’                 A reference to the dictionary       Read-only
                                        that holds the function’s global    
                                        variables — the global namespace
                                        of the module in which the
                                        function was defined.
                                        
                                                                            
          *note __dict__: 4f1.          The namespace supporting            Writable
                                        arbitrary function attributes.      
                                        
                                                                            
          ‘__closure__’                 ‘None’ or a tuple of cells that     Read-only
                                        contain bindings for the            
                                        function’s free variables.  See
                                        below for information on the
                                        ‘cell_contents’ attribute.
                                        
                                                                            
          ‘__annotations__’             A dict containing annotations of    Writable
                                        parameters.  The keys of the dict   
                                        are the parameter names, and
                                        ‘'return'’ for the return
                                        annotation, if provided.
                                        
                                                                            
          ‘__kwdefaults__’              A dict containing defaults for      Writable
                                        keyword-only parameters.            
                                        

          Most of the attributes labelled “Writable” check the type of
          the assigned value.

          Function objects also support getting and setting arbitrary
          attributes, which can be used, for example, to attach metadata
          to functions.  Regular attribute dot-notation is used to get
          and set such attributes.  `Note that the current
          implementation only supports function attributes on
          user-defined functions.  Function attributes on built-in
          functions may be supported in the future.'

          A cell object has the attribute ‘cell_contents’.  This can be
          used to get the value of the cell, as well as set the value.

          Additional information about a function’s definition can be
          retrieved from its code object; see the description of
          internal types below.  The *note cell: 1367. type can be
          accessed in the *note types: 118. module.

     Instance methods

          An instance method object combines a class, a class instance
          and any callable object (normally a user-defined function).

          Special read-only attributes: ‘__self__’ is the class instance
          object, ‘__func__’ is the function object; ‘__doc__’ is the
          method’s documentation (same as ‘__func__.__doc__’); *note
          __name__: c5a. is the method name (same as
          ‘__func__.__name__’); ‘__module__’ is the name of the module
          the method was defined in, or ‘None’ if unavailable.

          Methods also support accessing (but not setting) the arbitrary
          function attributes on the underlying function object.

          User-defined method objects may be created when getting an
          attribute of a class (perhaps via an instance of that class),
          if that attribute is a user-defined function object or a class
          method object.

          When an instance method object is created by retrieving a
          user-defined function object from a class via one of its
          instances, its ‘__self__’ attribute is the instance, and the
          method object is said to be bound.  The new method’s
          ‘__func__’ attribute is the original function object.

          When an instance method object is created by retrieving a
          class method object from a class or instance, its ‘__self__’
          attribute is the class itself, and its ‘__func__’ attribute is
          the function object underlying the class method.

          When an instance method object is called, the underlying
          function (‘__func__’) is called, inserting the class instance
          (‘__self__’) in front of the argument list.  For instance,
          when ‘C’ is a class which contains a definition for a function
          ‘f()’, and ‘x’ is an instance of ‘C’, calling ‘x.f(1)’ is
          equivalent to calling ‘C.f(x, 1)’.

          When an instance method object is derived from a class method
          object, the “class instance” stored in ‘__self__’ will
          actually be the class itself, so that calling either ‘x.f(1)’
          or ‘C.f(1)’ is equivalent to calling ‘f(C,1)’ where ‘f’ is the
          underlying function.

          Note that the transformation from function object to instance
          method object happens each time the attribute is retrieved
          from the instance.  In some cases, a fruitful optimization is
          to assign the attribute to a local variable and call that
          local variable.  Also notice that this transformation only
          happens for user-defined functions; other callable objects
          (and all non-callable objects) are retrieved without
          transformation.  It is also important to note that
          user-defined functions which are attributes of a class
          instance are not converted to bound methods; this `only'
          happens when the function is an attribute of the class.

     Generator functions

          A function or method which uses the *note yield: 18f.
          statement (see section *note The yield statement: 18f.) is
          called a `generator function'.  Such a function, when called,
          always returns an iterator object which can be used to execute
          the body of the function: calling the iterator’s *note
          iterator.__next__(): c57. method will cause the function to
          execute until it provides a value using the ‘yield’ statement.
          When the function executes a *note return: 190. statement or
          falls off the end, a *note StopIteration: 47b. exception is
          raised and the iterator will have reached the end of the set
          of values to be returned.

     Coroutine functions

          A function or method which is defined using *note async def:
          282. is called a `coroutine function'.  Such a function, when
          called, returns a *note coroutine: 1a5. object.  It may
          contain *note await: 1a2. expressions, as well as *note async
          with: 637. and *note async for: 2e1. statements.  See also the
          *note Coroutine Objects: 1368. section.

     Asynchronous generator functions

          A function or method which is defined using *note async def:
          282. and which uses the *note yield: 18f. statement is called
          a `asynchronous generator function'.  Such a function, when
          called, returns an asynchronous iterator object which can be
          used in an *note async for: 2e1. statement to execute the body
          of the function.

          Calling the asynchronous iterator’s ‘aiterator.__anext__()’
          method will return an *note awaitable: 50e. which when awaited
          will execute until it provides a value using the *note yield:
          18f. expression.  When the function executes an empty *note
          return: 190. statement or falls off the end, a *note
          StopAsyncIteration: f49. exception is raised and the
          asynchronous iterator will have reached the end of the set of
          values to be yielded.

     Built-in functions

          A built-in function object is a wrapper around a C function.
          Examples of built-in functions are *note len(): 150. and *note
          math.sin(): e02. (*note math: b1. is a standard built-in
          module).  The number and type of the arguments are determined
          by the C function.  Special read-only attributes: ‘__doc__’ is
          the function’s documentation string, or ‘None’ if unavailable;
          *note __name__: c5a. is the function’s name; ‘__self__’ is set
          to ‘None’ (but see the next item); ‘__module__’ is the name of
          the module the function was defined in or ‘None’ if
          unavailable.

     Built-in methods

          This is really a different disguise of a built-in function,
          this time containing an object passed to the C function as an
          implicit extra argument.  An example of a built-in method is
          ‘alist.append()’, assuming `alist' is a list object.  In this
          case, the special read-only attribute ‘__self__’ is set to the
          object denoted by `alist'.

     Classes

          Classes are callable.  These objects normally act as factories
          for new instances of themselves, but variations are possible
          for class types that override *note __new__(): 87d.  The
          arguments of the call are passed to *note __new__(): 87d. and,
          in the typical case, to *note __init__(): d51. to initialize
          the new instance.

     Class Instances

          Instances of arbitrary classes can be made callable by
          defining a *note __call__(): 1369. method in their class.

Modules

     Modules are a basic organizational unit of Python code, and are
     created by the *note import system: 136a. as invoked either by the
     *note import: c10. statement, or by calling functions such as *note
     importlib.import_module(): b06. and built-in *note __import__():
     605.  A module object has a namespace implemented by a dictionary
     object (this is the dictionary referenced by the ‘__globals__’
     attribute of functions defined in the module).  Attribute
     references are translated to lookups in this dictionary, e.g.,
     ‘m.x’ is equivalent to ‘m.__dict__["x"]’.  A module object does not
     contain the code object used to initialize the module (since it
     isn’t needed once the initialization is done).

     Attribute assignment updates the module’s namespace dictionary,
     e.g., ‘m.x = 1’ is equivalent to ‘m.__dict__["x"] = 1’.

     Predefined (writable) attributes: *note __name__: d05. is the
     module’s name; ‘__doc__’ is the module’s documentation string, or
     ‘None’ if unavailable; ‘__annotations__’ (optional) is a dictionary
     containing *note variable annotations: 614. collected during module
     body execution; *note __file__: 136b. is the pathname of the file
     from which the module was loaded, if it was loaded from a file.
     The *note __file__: 136b. attribute may be missing for certain
     types of modules, such as C modules that are statically linked into
     the interpreter; for extension modules loaded dynamically from a
     shared library, it is the pathname of the shared library file.

     Special read-only attribute: *note __dict__: 4f1. is the module’s
     namespace as a dictionary object.

     `CPython implementation detail:' Because of the way CPython clears
     module dictionaries, the module dictionary will be cleared when the
     module falls out of scope even if the dictionary still has live
     references.  To avoid this, copy the dictionary or keep the module
     around while using its dictionary directly.

Custom classes

     Custom class types are typically created by class definitions (see
     section *note Class definitions: c5d.).  A class has a namespace
     implemented by a dictionary object.  Class attribute references are
     translated to lookups in this dictionary, e.g., ‘C.x’ is translated
     to ‘C.__dict__["x"]’ (although there are a number of hooks which
     allow for other means of locating attributes).  When the attribute
     name is not found there, the attribute search continues in the base
     classes.  This search of the base classes uses the C3 method
     resolution order which behaves correctly even in the presence of
     ‘diamond’ inheritance structures where there are multiple
     inheritance paths leading back to a common ancestor.  Additional
     details on the C3 MRO used by Python can be found in the
     documentation accompanying the 2.3 release at
     ‘https://www.python.org/download/releases/2.3/mro/’.

     When a class attribute reference (for class ‘C’, say) would yield a
     class method object, it is transformed into an instance method
     object whose ‘__self__’ attribute is ‘C’.  When it would yield a
     static method object, it is transformed into the object wrapped by
     the static method object.  See section *note Implementing
     Descriptors: 4de. for another way in which attributes retrieved
     from a class may differ from those actually contained in its *note
     __dict__: 4f1.

     Class attribute assignments update the class’s dictionary, never
     the dictionary of a base class.

     A class object can be called (see above) to yield a class instance
     (see below).

     Special attributes: *note __name__: c5a. is the class name;
     ‘__module__’ is the module name in which the class was defined;
     *note __dict__: 4f1. is the dictionary containing the class’s
     namespace; *note __bases__: dfc. is a tuple containing the base
     classes, in the order of their occurrence in the base class list;
     ‘__doc__’ is the class’s documentation string, or ‘None’ if
     undefined; ‘__annotations__’ (optional) is a dictionary containing
     *note variable annotations: 614. collected during class body
     execution.

Class instances

     A class instance is created by calling a class object (see above).
     A class instance has a namespace implemented as a dictionary which
     is the first place in which attribute references are searched.
     When an attribute is not found there, and the instance’s class has
     an attribute by that name, the search continues with the class
     attributes.  If a class attribute is found that is a user-defined
     function object, it is transformed into an instance method object
     whose ‘__self__’ attribute is the instance.  Static method and
     class method objects are also transformed; see above under
     “Classes”.  See section *note Implementing Descriptors: 4de. for
     another way in which attributes of a class retrieved via its
     instances may differ from the objects actually stored in the
     class’s *note __dict__: 4f1.  If no class attribute is found, and
     the object’s class has a *note __getattr__(): 30f. method, that is
     called to satisfy the lookup.

     Attribute assignments and deletions update the instance’s
     dictionary, never a class’s dictionary.  If the class has a *note
     __setattr__(): e1f. or *note __delattr__(): 136c. method, this is
     called instead of updating the instance dictionary directly.

     Class instances can pretend to be numbers, sequences, or mappings
     if they have methods with certain special names.  See section *note
     Special method names: 503.

     Special attributes: *note __dict__: 4f1. is the attribute
     dictionary; *note __class__: dfd. is the instance’s class.

I/O objects (also known as file objects)

     A *note file object: b35. represents an open file.  Various
     shortcuts are available to create file objects: the *note open():
     4e5. built-in function, and also *note os.popen(): 2a7, *note
     os.fdopen(): 136d, and the *note makefile(): b0c. method of socket
     objects (and perhaps by other functions or methods provided by
     extension modules).

     The objects ‘sys.stdin’, ‘sys.stdout’ and ‘sys.stderr’ are
     initialized to file objects corresponding to the interpreter’s
     standard input, output and error streams; they are all open in text
     mode and therefore follow the interface defined by the *note
     io.TextIOBase: c2c. abstract class.

Internal types

     A few types used internally by the interpreter are exposed to the
     user.  Their definitions may change with future versions of the
     interpreter, but they are mentioned here for completeness.

     Code objects

          Code objects represent `byte-compiled' executable Python code,
          or *note bytecode: 609.  The difference between a code object
          and a function object is that the function object contains an
          explicit reference to the function’s globals (the module in
          which it was defined), while a code object contains no
          context; also the default argument values are stored in the
          function object, not in the code object (because they
          represent values calculated at run-time).  Unlike function
          objects, code objects are immutable and contain no references
          (directly or indirectly) to mutable objects.

          Special read-only attributes: ‘co_name’ gives the function
          name; ‘co_argcount’ is the total number of positional
          arguments (including positional-only arguments and arguments
          with default values); ‘co_posonlyargcount’ is the number of
          positional-only arguments (including arguments with default
          values); ‘co_kwonlyargcount’ is the number of keyword-only
          arguments (including arguments with default values);
          ‘co_nlocals’ is the number of local variables used by the
          function (including arguments); ‘co_varnames’ is a tuple
          containing the names of the local variables (starting with the
          argument names); ‘co_cellvars’ is a tuple containing the names
          of local variables that are referenced by nested functions;
          ‘co_freevars’ is a tuple containing the names of free
          variables; ‘co_code’ is a string representing the sequence of
          bytecode instructions; ‘co_consts’ is a tuple containing the
          literals used by the bytecode; ‘co_names’ is a tuple
          containing the names used by the bytecode; ‘co_filename’ is
          the filename from which the code was compiled;
          ‘co_firstlineno’ is the first line number of the function;
          ‘co_lnotab’ is a string encoding the mapping from bytecode
          offsets to line numbers (for details see the source code of
          the interpreter); ‘co_stacksize’ is the required stack size
          (including local variables); ‘co_flags’ is an integer encoding
          a number of flags for the interpreter.

          The following flag bits are defined for ‘co_flags’: bit ‘0x04’
          is set if the function uses the ‘*arguments’ syntax to accept
          an arbitrary number of positional arguments; bit ‘0x08’ is set
          if the function uses the ‘**keywords’ syntax to accept
          arbitrary keyword arguments; bit ‘0x20’ is set if the function
          is a generator.

          Future feature declarations (‘from __future__ import
          division’) also use bits in ‘co_flags’ to indicate whether a
          code object was compiled with a particular feature enabled:
          bit ‘0x2000’ is set if the function was compiled with future
          division enabled; bits ‘0x10’ and ‘0x1000’ were used in
          earlier versions of Python.

          Other bits in ‘co_flags’ are reserved for internal use.

          If a code object represents a function, the first item in
          ‘co_consts’ is the documentation string of the function, or
          ‘None’ if undefined.

     Frame objects

          Frame objects represent execution frames.  They may occur in
          traceback objects (see below), and are also passed to
          registered trace functions.

          Special read-only attributes: ‘f_back’ is to the previous
          stack frame (towards the caller), or ‘None’ if this is the
          bottom stack frame; ‘f_code’ is the code object being executed
          in this frame; ‘f_locals’ is the dictionary used to look up
          local variables; ‘f_globals’ is used for global variables;
          ‘f_builtins’ is used for built-in (intrinsic) names; ‘f_lasti’
          gives the precise instruction (this is an index into the
          bytecode string of the code object).

          Special writable attributes: ‘f_trace’, if not ‘None’, is a
          function called for various events during code execution (this
          is used by the debugger).  Normally an event is triggered for
          each new source line - this can be disabled by setting
          ‘f_trace_lines’ to *note False: 37d.

          Implementations `may' allow per-opcode events to be requested
          by setting ‘f_trace_opcodes’ to *note True: 48f.  Note that
          this may lead to undefined interpreter behaviour if exceptions
          raised by the trace function escape to the function being
          traced.

          ‘f_lineno’ is the current line number of the frame — writing
          to this from within a trace function jumps to the given line
          (only for the bottom-most frame).  A debugger can implement a
          Jump command (aka Set Next Statement) by writing to f_lineno.

          Frame objects support one method:

           -- Method: frame.clear ()

               This method clears all references to local variables held
               by the frame.  Also, if the frame belonged to a
               generator, the generator is finalized.  This helps break
               reference cycles involving frame objects (for example
               when catching an exception and storing its traceback for
               later use).

               *note RuntimeError: 2b8. is raised if the frame is
               currently executing.

               New in version 3.4.

     Traceback objects

          Traceback objects represent a stack trace of an exception.  A
          traceback object is implicitly created when an exception
          occurs, and may also be explicitly created by calling *note
          types.TracebackType: 32a.

          For implicitly created tracebacks, when the search for an
          exception handler unwinds the execution stack, at each unwound
          level a traceback object is inserted in front of the current
          traceback.  When an exception handler is entered, the stack
          trace is made available to the program.  (See section *note
          The try statement: d65.)  It is accessible as the third item
          of the tuple returned by ‘sys.exc_info()’, and as the
          ‘__traceback__’ attribute of the caught exception.

          When the program contains no suitable handler, the stack trace
          is written (nicely formatted) to the standard error stream; if
          the interpreter is interactive, it is also made available to
          the user as ‘sys.last_traceback’.

          For explicitly created tracebacks, it is up to the creator of
          the traceback to determine how the ‘tb_next’ attributes should
          be linked to form a full stack trace.

          Special read-only attributes: ‘tb_frame’ points to the
          execution frame of the current level; ‘tb_lineno’ gives the
          line number where the exception occurred; ‘tb_lasti’ indicates
          the precise instruction.  The line number and last instruction
          in the traceback may differ from the line number of its frame
          object if the exception occurred in a *note try: d65.
          statement with no matching except clause or with a finally
          clause.

          Special writable attribute: ‘tb_next’ is the next level in the
          stack trace (towards the frame where the exception occurred),
          or ‘None’ if there is no next level.

          Changed in version 3.7: Traceback objects can now be
          explicitly instantiated from Python code, and the ‘tb_next’
          attribute of existing instances can be updated.

     Slice objects

          Slice objects are used to represent slices for *note
          __getitem__(): 27a. methods.  They are also created by the
          built-in *note slice(): df7. function.

          Special read-only attributes: ‘start’ is the lower bound;
          ‘stop’ is the upper bound; ‘step’ is the step value; each is
          ‘None’ if omitted.  These attributes can have any type.

          Slice objects support one method:

           -- Method: slice.indices (self, length)

               This method takes a single integer argument `length' and
               computes information about the slice that the slice
               object would describe if applied to a sequence of
               `length' items.  It returns a tuple of three integers;
               respectively these are the `start' and `stop' indices and
               the `step' or stride length of the slice.  Missing or
               out-of-bounds indices are handled in a manner consistent
               with regular slices.

     Static method objects

          Static method objects provide a way of defeating the
          transformation of function objects to method objects described
          above.  A static method object is a wrapper around any other
          object, usually a user-defined method object.  When a static
          method object is retrieved from a class or a class instance,
          the object actually returned is the wrapped object, which is
          not subject to any further transformation.  Static method
          objects are not themselves callable, although the objects they
          wrap usually are.  Static method objects are created by the
          built-in *note staticmethod(): 1d7. constructor.

     Class method objects

          A class method object, like a static method object, is a
          wrapper around another object that alters the way in which
          that object is retrieved from classes and class instances.
          The behaviour of class method objects upon such retrieval is
          described above, under “User-defined methods”.  Class method
          objects are created by the built-in *note classmethod(): 1d6.
          constructor.


File: python.info,  Node: Special method names,  Next: Coroutines,  Prev: The standard type hierarchy,  Up: Data model

4.3.3 Special method names
--------------------------

A class can implement certain operations that are invoked by special
syntax (such as arithmetic operations or subscripting and slicing) by
defining methods with special names.  This is Python’s approach to
`operator overloading', allowing classes to define their own behavior
with respect to language operators.  For instance, if a class defines a
method named *note __getitem__(): 27a, and ‘x’ is an instance of this
class, then ‘x[i]’ is roughly equivalent to ‘type(x).__getitem__(x, i)’.
Except where mentioned, attempts to execute an operation raise an
exception when no appropriate method is defined (typically *note
AttributeError: 390. or *note TypeError: 192.).

Setting a special method to ‘None’ indicates that the corresponding
operation is not available.  For example, if a class sets *note
__iter__(): 504. to ‘None’, the class is not iterable, so calling *note
iter(): d1a. on its instances will raise a *note TypeError: 192.
(without falling back to *note __getitem__(): 27a.).  (1)

When implementing a class that emulates any built-in type, it is
important that the emulation only be implemented to the degree that it
makes sense for the object being modelled.  For example, some sequences
may work well with retrieval of individual elements, but extracting a
slice may not make sense.  (One example of this is the ‘NodeList’
interface in the W3C’s Document Object Model.)

* Menu:

* Basic customization::
* Customizing attribute access::
* Customizing class creation::
* Customizing instance and subclass checks::
* Emulating generic types::
* Emulating callable objects::
* Emulating container types::
* Emulating numeric types::
* With Statement Context Managers::
* Special method lookup::

   ---------- Footnotes ----------

   (1) (2) The *note __hash__(): 335, *note __iter__(): 504, *note
__reversed__(): 524, and *note __contains__(): d1b. methods have special
handling for this; others will still raise a *note TypeError: 192, but
may do so by relying on the behavior that ‘None’ is not callable.


File: python.info,  Node: Basic customization,  Next: Customizing attribute access,  Up: Special method names

4.3.3.1 Basic customization
...........................

 -- Method: object.__new__ (cls[, ...])

     Called to create a new instance of class `cls'.  *note __new__():
     87d. is a static method (special-cased so you need not declare it
     as such) that takes the class of which an instance was requested as
     its first argument.  The remaining arguments are those passed to
     the object constructor expression (the call to the class).  The
     return value of *note __new__(): 87d. should be the new object
     instance (usually an instance of `cls').

     Typical implementations create a new instance of the class by
     invoking the superclass’s *note __new__(): 87d. method using
     ‘super().__new__(cls[, ...])’ with appropriate arguments and then
     modifying the newly-created instance as necessary before returning
     it.

     If *note __new__(): 87d. is invoked during object construction and
     it returns an instance or subclass of `cls', then the new
     instance’s *note __init__(): d51. method will be invoked like
     ‘__init__(self[, ...])’, where `self' is the new instance and the
     remaining arguments are the same as were passed to the object
     constructor.

     If *note __new__(): 87d. does not return an instance of `cls', then
     the new instance’s *note __init__(): d51. method will not be
     invoked.

     *note __new__(): 87d. is intended mainly to allow subclasses of
     immutable types (like int, str, or tuple) to customize instance
     creation.  It is also commonly overridden in custom metaclasses in
     order to customize class creation.

 -- Method: object.__init__ (self[, ...])

     Called after the instance has been created (by *note __new__():
     87d.), but before it is returned to the caller.  The arguments are
     those passed to the class constructor expression.  If a base class
     has an *note __init__(): d51. method, the derived class’s *note
     __init__(): d51. method, if any, must explicitly call it to ensure
     proper initialization of the base class part of the instance; for
     example: ‘super().__init__([args...])’.

     Because *note __new__(): 87d. and *note __init__(): d51. work
     together in constructing objects (*note __new__(): 87d. to create
     it, and *note __init__(): d51. to customize it), no non-‘None’
     value may be returned by *note __init__(): d51.; doing so will
     cause a *note TypeError: 192. to be raised at runtime.

 -- Method: object.__del__ (self)

     Called when the instance is about to be destroyed.  This is also
     called a finalizer or (improperly) a destructor.  If a base class
     has a *note __del__(): 913. method, the derived class’s *note
     __del__(): 913. method, if any, must explicitly call it to ensure
     proper deletion of the base class part of the instance.

     It is possible (though not recommended!)  for the *note __del__():
     913. method to postpone destruction of the instance by creating a
     new reference to it.  This is called object `resurrection'.  It is
     implementation-dependent whether *note __del__(): 913. is called a
     second time when a resurrected object is about to be destroyed; the
     current *note CPython: 1372. implementation only calls it once.

     It is not guaranteed that *note __del__(): 913. methods are called
     for objects that still exist when the interpreter exits.

          Note: ‘del x’ doesn’t directly call ‘x.__del__()’ — the former
          decrements the reference count for ‘x’ by one, and the latter
          is only called when ‘x’’s reference count reaches zero.

     `CPython implementation detail:' It is possible for a reference
     cycle to prevent the reference count of an object from going to
     zero.  In this case, the cycle will be later detected and deleted
     by the *note cyclic garbage collector: 1243.  A common cause of
     reference cycles is when an exception has been caught in a local
     variable.  The frame’s locals then reference the exception, which
     references its own traceback, which references the locals of all
     frames caught in the traceback.

     See also
     ........

     Documentation for the *note gc: 86. module.

          Warning: Due to the precarious circumstances under which *note
          __del__(): 913. methods are invoked, exceptions that occur
          during their execution are ignored, and a warning is printed
          to ‘sys.stderr’ instead.  In particular:

             * *note __del__(): 913. can be invoked when arbitrary code
               is being executed, including from any arbitrary thread.
               If *note __del__(): 913. needs to take a lock or invoke
               any other blocking resource, it may deadlock as the
               resource may already be taken by the code that gets
               interrupted to execute *note __del__(): 913.

             * *note __del__(): 913. can be executed during interpreter
               shutdown.  As a consequence, the global variables it
               needs to access (including other modules) may already
               have been deleted or set to ‘None’.  Python guarantees
               that globals whose name begins with a single underscore
               are deleted from their module before other globals are
               deleted; if no other references to such globals exist,
               this may help in assuring that imported modules are still
               available at the time when the *note __del__(): 913.
               method is called.

 -- Method: object.__repr__ (self)

     Called by the *note repr(): 7c0. built-in function to compute the
     “official” string representation of an object.  If at all possible,
     this should look like a valid Python expression that could be used
     to recreate an object with the same value (given an appropriate
     environment).  If this is not possible, a string of the form
     ‘<...some useful description...>’ should be returned.  The return
     value must be a string object.  If a class defines *note
     __repr__(): 333. but not *note __str__(): e2a, then *note
     __repr__(): 333. is also used when an “informal” string
     representation of instances of that class is required.

     This is typically used for debugging, so it is important that the
     representation is information-rich and unambiguous.

 -- Method: object.__str__ (self)

     Called by *note str(object): 325. and the built-in functions *note
     format(): 4d0. and *note print(): 87a. to compute the “informal” or
     nicely printable string representation of an object.  The return
     value must be a *note string: 115d. object.

     This method differs from *note object.__repr__(): 333. in that
     there is no expectation that *note __str__(): e2a. return a valid
     Python expression: a more convenient or concise representation can
     be used.

     The default implementation defined by the built-in type *note
     object: 2ae. calls *note object.__repr__(): 333.

 -- Method: object.__bytes__ (self)

     Called by *note bytes: ff6. to compute a byte-string representation
     of an object.  This should return a *note bytes: 326. object.

 -- Method: object.__format__ (self, format_spec)

     Called by the *note format(): 4d0. built-in function, and by
     extension, evaluation of *note formatted string literals: 15c. and
     the *note str.format(): 4cf. method, to produce a “formatted”
     string representation of an object.  The `format_spec' argument is
     a string that contains a description of the formatting options
     desired.  The interpretation of the `format_spec' argument is up to
     the type implementing *note __format__(): 942, however most classes
     will either delegate formatting to one of the built-in types, or
     use a similar formatting option syntax.

     See *note Format Specification Mini-Language: 4d3. for a
     description of the standard formatting syntax.

     The return value must be a string object.

     Changed in version 3.4: The __format__ method of ‘object’ itself
     raises a *note TypeError: 192. if passed any non-empty string.

     Changed in version 3.7: ‘object.__format__(x, '')’ is now
     equivalent to ‘str(x)’ rather than ‘format(str(self), '')’.

 -- Method: object.__lt__ (self, other)
 -- Method: object.__le__ (self, other)
 -- Method: object.__eq__ (self, other)
 -- Method: object.__ne__ (self, other)
 -- Method: object.__gt__ (self, other)
 -- Method: object.__ge__ (self, other)

     These are the so-called “rich comparison” methods.  The
     correspondence between operator symbols and method names is as
     follows: ‘x<y’ calls ‘x.__lt__(y)’, ‘x<=y’ calls ‘x.__le__(y)’,
     ‘x==y’ calls ‘x.__eq__(y)’, ‘x!=y’ calls ‘x.__ne__(y)’, ‘x>y’ calls
     ‘x.__gt__(y)’, and ‘x>=y’ calls ‘x.__ge__(y)’.

     A rich comparison method may return the singleton ‘NotImplemented’
     if it does not implement the operation for a given pair of
     arguments.  By convention, ‘False’ and ‘True’ are returned for a
     successful comparison.  However, these methods can return any
     value, so if the comparison operator is used in a Boolean context
     (e.g., in the condition of an ‘if’ statement), Python will call
     *note bool(): 183. on the value to determine if the result is true
     or false.

     By default, *note __ne__(): e49. delegates to *note __eq__(): 334.
     and inverts the result unless it is ‘NotImplemented’.  There are no
     other implied relationships among the comparison operators, for
     example, the truth of ‘(x<y or x==y)’ does not imply ‘x<=y’.  To
     automatically generate ordering operations from a single root
     operation, see *note functools.total_ordering(): 83f.

     See the paragraph on *note __hash__(): 335. for some important
     notes on creating *note hashable: 1364. objects which support
     custom comparison operations and are usable as dictionary keys.

     There are no swapped-argument versions of these methods (to be used
     when the left argument does not support the operation but the right
     argument does); rather, *note __lt__(): c27. and *note __gt__():
     c94. are each other’s reflection, *note __le__(): c93. and *note
     __ge__(): c95. are each other’s reflection, and *note __eq__():
     334. and *note __ne__(): e49. are their own reflection.  If the
     operands are of different types, and right operand’s type is a
     direct or indirect subclass of the left operand’s type, the
     reflected method of the right operand has priority, otherwise the
     left operand’s method has priority.  Virtual subclassing is not
     considered.

 -- Method: object.__hash__ (self)

     Called by built-in function *note hash(): 9b8. and for operations
     on members of hashed collections including *note set: b62, *note
     frozenset: be1, and *note dict: 1b6.  *note __hash__(): 335. should
     return an integer.  The only required property is that objects
     which compare equal have the same hash value; it is advised to mix
     together the hash values of the components of the object that also
     play a part in comparison of objects by packing them into a tuple
     and hashing the tuple.  Example:

          def __hash__(self):
              return hash((self.name, self.nick, self.color))

          Note: *note hash(): 9b8. truncates the value returned from an
          object’s custom *note __hash__(): 335. method to the size of a
          ‘Py_ssize_t’.  This is typically 8 bytes on 64-bit builds and
          4 bytes on 32-bit builds.  If an object’s *note __hash__():
          335. must interoperate on builds of different bit sizes, be
          sure to check the width on all supported builds.  An easy way
          to do this is with ‘python -c "import sys;
          print(sys.hash_info.width)"’.

     If a class does not define an *note __eq__(): 334. method it should
     not define a *note __hash__(): 335. operation either; if it defines
     *note __eq__(): 334. but not *note __hash__(): 335, its instances
     will not be usable as items in hashable collections.  If a class
     defines mutable objects and implements an *note __eq__(): 334.
     method, it should not implement *note __hash__(): 335, since the
     implementation of hashable collections requires that a key’s hash
     value is immutable (if the object’s hash value changes, it will be
     in the wrong hash bucket).

     User-defined classes have *note __eq__(): 334. and *note
     __hash__(): 335. methods by default; with them, all objects compare
     unequal (except with themselves) and ‘x.__hash__()’ returns an
     appropriate value such that ‘x == y’ implies both that ‘x is y’ and
     ‘hash(x) == hash(y)’.

     A class that overrides *note __eq__(): 334. and does not define
     *note __hash__(): 335. will have its *note __hash__(): 335.
     implicitly set to ‘None’.  When the *note __hash__(): 335. method
     of a class is ‘None’, instances of the class will raise an
     appropriate *note TypeError: 192. when a program attempts to
     retrieve their hash value, and will also be correctly identified as
     unhashable when checking ‘isinstance(obj,
     collections.abc.Hashable)’.

     If a class that overrides *note __eq__(): 334. needs to retain the
     implementation of *note __hash__(): 335. from a parent class, the
     interpreter must be told this explicitly by setting ‘__hash__ =
     <ParentClass>.__hash__’.

     If a class that does not override *note __eq__(): 334. wishes to
     suppress hash support, it should include ‘__hash__ = None’ in the
     class definition.  A class which defines its own *note __hash__():
     335. that explicitly raises a *note TypeError: 192. would be
     incorrectly identified as hashable by an ‘isinstance(obj,
     collections.abc.Hashable)’ call.

          Note: By default, the *note __hash__(): 335. values of str and
          bytes objects are “salted” with an unpredictable random value.
          Although they remain constant within an individual Python
          process, they are not predictable between repeated invocations
          of Python.

          This is intended to provide protection against a
          denial-of-service caused by carefully-chosen inputs that
          exploit the worst case performance of a dict insertion, O(n^2)
          complexity.  See
          ‘http://www.ocert.org/advisories/ocert-2011-003.html’ for
          details.

          Changing hash values affects the iteration order of sets.
          Python has never made guarantees about this ordering (and it
          typically varies between 32-bit and 64-bit builds).

          See also *note PYTHONHASHSEED: 9b9.

     Changed in version 3.3: Hash randomization is enabled by default.

 -- Method: object.__bool__ (self)

     Called to implement truth value testing and the built-in operation
     ‘bool()’; should return ‘False’ or ‘True’.  When this method is not
     defined, *note __len__(): dbe. is called, if it is defined, and the
     object is considered true if its result is nonzero.  If a class
     defines neither *note __len__(): dbe. nor *note __bool__(): c5b,
     all its instances are considered true.


File: python.info,  Node: Customizing attribute access,  Next: Customizing class creation,  Prev: Basic customization,  Up: Special method names

4.3.3.2 Customizing attribute access
....................................

The following methods can be defined to customize the meaning of
attribute access (use of, assignment to, or deletion of ‘x.name’) for
class instances.

 -- Method: object.__getattr__ (self, name)

     Called when the default attribute access fails with an *note
     AttributeError: 390. (either *note __getattribute__(): 43e. raises
     an *note AttributeError: 390. because `name' is not an instance
     attribute or an attribute in the class tree for ‘self’; or *note
     __get__(): 1377. of a `name' property raises *note AttributeError:
     390.).  This method should either return the (computed) attribute
     value or raise an *note AttributeError: 390. exception.

     Note that if the attribute is found through the normal mechanism,
     *note __getattr__(): 30f. is not called.  (This is an intentional
     asymmetry between *note __getattr__(): 30f. and *note
     __setattr__(): e1f.)  This is done both for efficiency reasons and
     because otherwise *note __getattr__(): 30f. would have no way to
     access other attributes of the instance.  Note that at least for
     instance variables, you can fake total control by not inserting any
     values in the instance attribute dictionary (but instead inserting
     them in another object).  See the *note __getattribute__(): 43e.
     method below for a way to actually get total control over attribute
     access.

 -- Method: object.__getattribute__ (self, name)

     Called unconditionally to implement attribute accesses for
     instances of the class.  If the class also defines *note
     __getattr__(): 30f, the latter will not be called unless *note
     __getattribute__(): 43e. either calls it explicitly or raises an
     *note AttributeError: 390.  This method should return the
     (computed) attribute value or raise an *note AttributeError: 390.
     exception.  In order to avoid infinite recursion in this method,
     its implementation should always call the base class method with
     the same name to access any attributes it needs, for example,
     ‘object.__getattribute__(self, name)’.

          Note: This method may still be bypassed when looking up
          special methods as the result of implicit invocation via
          language syntax or built-in functions.  See *note Special
          method lookup: 1378.

 -- Method: object.__setattr__ (self, name, value)

     Called when an attribute assignment is attempted.  This is called
     instead of the normal mechanism (i.e.  store the value in the
     instance dictionary).  `name' is the attribute name, `value' is the
     value to be assigned to it.

     If *note __setattr__(): e1f. wants to assign to an instance
     attribute, it should call the base class method with the same name,
     for example, ‘object.__setattr__(self, name, value)’.

 -- Method: object.__delattr__ (self, name)

     Like *note __setattr__(): e1f. but for attribute deletion instead
     of assignment.  This should only be implemented if ‘del obj.name’
     is meaningful for the object.

 -- Method: object.__dir__ (self)

     Called when *note dir(): d26. is called on the object.  A sequence
     must be returned.  *note dir(): d26. converts the returned sequence
     to a list and sorts it.

* Menu:

* Customizing module attribute access::
* Implementing Descriptors::
* Invoking Descriptors::
* __slots__::


File: python.info,  Node: Customizing module attribute access,  Next: Implementing Descriptors,  Up: Customizing attribute access

4.3.3.3 Customizing module attribute access
...........................................

Special names ‘__getattr__’ and ‘__dir__’ can be also used to customize
access to module attributes.  The ‘__getattr__’ function at the module
level should accept one argument which is the name of an attribute and
return the computed value or raise an *note AttributeError: 390.  If an
attribute is not found on a module object through the normal lookup,
i.e.  *note object.__getattribute__(): 43e, then ‘__getattr__’ is
searched in the module ‘__dict__’ before raising an *note
AttributeError: 390.  If found, it is called with the attribute name and
the result is returned.

The ‘__dir__’ function should accept no arguments, and return a sequence
of strings that represents the names accessible on module.  If present,
this function overrides the standard *note dir(): d26. search on a
module.

For a more fine grained customization of the module behavior (setting
attributes, properties, etc.), one can set the ‘__class__’ attribute of
a module object to a subclass of *note types.ModuleType: 6e5.  For
example:

     import sys
     from types import ModuleType

     class VerboseModule(ModuleType):
         def __repr__(self):
             return f'Verbose {self.__name__}'

         def __setattr__(self, attr, value):
             print(f'Setting {attr}...')
             super().__setattr__(attr, value)

     sys.modules[__name__].__class__ = VerboseModule

     Note: Defining module ‘__getattr__’ and setting module ‘__class__’
     only affect lookups made using the attribute access syntax –
     directly accessing the module globals (whether by code within the
     module, or via a reference to the module’s globals dictionary) is
     unaffected.

Changed in version 3.5: ‘__class__’ module attribute is now writable.

New in version 3.7: ‘__getattr__’ and ‘__dir__’ module attributes.

See also
........

PEP 562(1) - Module __getattr__ and __dir__

     Describes the ‘__getattr__’ and ‘__dir__’ functions on modules.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0562


File: python.info,  Node: Implementing Descriptors,  Next: Invoking Descriptors,  Prev: Customizing module attribute access,  Up: Customizing attribute access

4.3.3.4 Implementing Descriptors
................................

The following methods only apply when an instance of the class
containing the method (a so-called `descriptor' class) appears in an
`owner' class (the descriptor must be in either the owner’s class
dictionary or in the class dictionary for one of its parents).  In the
examples below, “the attribute” refers to the attribute whose name is
the key of the property in the owner class’ *note __dict__: 4f1.

 -- Method: object.__get__ (self, instance, owner=None)

     Called to get the attribute of the owner class (class attribute
     access) or of an instance of that class (instance attribute
     access).  The optional `owner' argument is the owner class, while
     `instance' is the instance that the attribute was accessed through,
     or ‘None’ when the attribute is accessed through the `owner'.

     This method should return the computed attribute value or raise an
     *note AttributeError: 390. exception.

     PEP 252(1) specifies that *note __get__(): 1377. is callable with
     one or two arguments.  Python’s own built-in descriptors support
     this specification; however, it is likely that some third-party
     tools have descriptors that require both arguments.  Python’s own
     *note __getattribute__(): 43e. implementation always passes in both
     arguments whether they are required or not.

 -- Method: object.__set__ (self, instance, value)

     Called to set the attribute on an instance `instance' of the owner
     class to a new value, `value'.

     Note, adding *note __set__(): 137b. or *note __delete__(): 137c.
     changes the kind of descriptor to a “data descriptor”.  See *note
     Invoking Descriptors: 137d. for more details.

 -- Method: object.__delete__ (self, instance)

     Called to delete the attribute on an instance `instance' of the
     owner class.

 -- Method: object.__set_name__ (self, owner, name)

     Called at the time the owning class `owner' is created.  The
     descriptor has been assigned to `name'.

          Note: *note __set_name__(): 4dd. is only called implicitly as
          part of the *note type: 5fd. constructor, so it will need to
          be called explicitly with the appropriate parameters when a
          descriptor is added to a class after initial creation:

               class A:
                  pass
               descr = custom_descriptor()
               A.attr = descr
               descr.__set_name__(A, 'attr')

          See *note Creating the class object: 4d9. for more details.

     New in version 3.6.

The attribute ‘__objclass__’ is interpreted by the *note inspect: a0.
module as specifying the class where this object was defined (setting
this appropriately can assist in runtime introspection of dynamic class
attributes).  For callables, it may indicate that an instance of the
given type (or a subclass) is expected or required as the first
positional argument (for example, CPython sets this attribute for
unbound methods that are implemented in C).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0252


File: python.info,  Node: Invoking Descriptors,  Next: __slots__,  Prev: Implementing Descriptors,  Up: Customizing attribute access

4.3.3.5 Invoking Descriptors
............................

In general, a descriptor is an object attribute with “binding behavior”,
one whose attribute access has been overridden by methods in the
descriptor protocol: *note __get__(): 1377, *note __set__(): 137b, and
*note __delete__(): 137c.  If any of those methods are defined for an
object, it is said to be a descriptor.

The default behavior for attribute access is to get, set, or delete the
attribute from an object’s dictionary.  For instance, ‘a.x’ has a lookup
chain starting with ‘a.__dict__['x']’, then ‘type(a).__dict__['x']’, and
continuing through the base classes of ‘type(a)’ excluding metaclasses.

However, if the looked-up value is an object defining one of the
descriptor methods, then Python may override the default behavior and
invoke the descriptor method instead.  Where this occurs in the
precedence chain depends on which descriptor methods were defined and
how they were called.

The starting point for descriptor invocation is a binding, ‘a.x’.  How
the arguments are assembled depends on ‘a’:

Direct Call

     The simplest and least common call is when user code directly
     invokes a descriptor method: ‘x.__get__(a)’.

Instance Binding

     If binding to an object instance, ‘a.x’ is transformed into the
     call: ‘type(a).__dict__['x'].__get__(a, type(a))’.

Class Binding

     If binding to a class, ‘A.x’ is transformed into the call:
     ‘A.__dict__['x'].__get__(None, A)’.

Super Binding

     If ‘a’ is an instance of *note super: 4d7, then the binding
     ‘super(B, obj).m()’ searches ‘obj.__class__.__mro__’ for the base
     class ‘A’ immediately preceding ‘B’ and then invokes the descriptor
     with the call: ‘A.__dict__['m'].__get__(obj, obj.__class__)’.

For instance bindings, the precedence of descriptor invocation depends
on the which descriptor methods are defined.  A descriptor can define
any combination of *note __get__(): 1377, *note __set__(): 137b. and
*note __delete__(): 137c.  If it does not define *note __get__(): 1377,
then accessing the attribute will return the descriptor object itself
unless there is a value in the object’s instance dictionary.  If the
descriptor defines *note __set__(): 137b. and/or *note __delete__():
137c, it is a data descriptor; if it defines neither, it is a non-data
descriptor.  Normally, data descriptors define both *note __get__():
1377. and *note __set__(): 137b, while non-data descriptors have just
the *note __get__(): 1377. method.  Data descriptors with *note
__set__(): 137b. and *note __get__(): 1377. defined always override a
redefinition in an instance dictionary.  In contrast, non-data
descriptors can be overridden by instances.

Python methods (including *note staticmethod(): 1d7. and *note
classmethod(): 1d6.) are implemented as non-data descriptors.
Accordingly, instances can redefine and override methods.  This allows
individual instances to acquire behaviors that differ from other
instances of the same class.

The *note property(): 1d5. function is implemented as a data descriptor.
Accordingly, instances cannot override the behavior of a property.


File: python.info,  Node: __slots__,  Prev: Invoking Descriptors,  Up: Customizing attribute access

4.3.3.6 __slots__
.................

`__slots__' allow us to explicitly declare data members (like
properties) and deny the creation of `__dict__' and `__weakref__'
(unless explicitly declared in `__slots__' or available in a parent.)

The space saved over using `__dict__' can be significant.  Attribute
lookup speed can be significantly improved as well.

 -- Data: object.__slots__

     This class variable can be assigned a string, iterable, or sequence
     of strings with variable names used by instances.  `__slots__'
     reserves space for the declared variables and prevents the
     automatic creation of `__dict__' and `__weakref__' for each
     instance.

* Menu:

* Notes on using __slots__::


File: python.info,  Node: Notes on using __slots__,  Up: __slots__

4.3.3.7 Notes on using `__slots__'
..................................

   * When inheriting from a class without `__slots__', the `__dict__'
     and `__weakref__' attribute of the instances will always be
     accessible.

   * Without a `__dict__' variable, instances cannot be assigned new
     variables not listed in the `__slots__' definition.  Attempts to
     assign to an unlisted variable name raises *note AttributeError:
     390.  If dynamic assignment of new variables is desired, then add
     ‘'__dict__'’ to the sequence of strings in the `__slots__'
     declaration.

   * Without a `__weakref__' variable for each instance, classes
     defining `__slots__' do not support weak references to its
     instances.  If weak reference support is needed, then add
     ‘'__weakref__'’ to the sequence of strings in the `__slots__'
     declaration.

   * `__slots__' are implemented at the class level by creating
     descriptors (*note Implementing Descriptors: 4de.) for each
     variable name.  As a result, class attributes cannot be used to set
     default values for instance variables defined by `__slots__';
     otherwise, the class attribute would overwrite the descriptor
     assignment.

   * The action of a `__slots__' declaration is not limited to the class
     where it is defined.  `__slots__' declared in parents are available
     in child classes.  However, child subclasses will get a `__dict__'
     and `__weakref__' unless they also define `__slots__' (which should
     only contain names of any `additional' slots).

   * If a class defines a slot also defined in a base class, the
     instance variable defined by the base class slot is inaccessible
     (except by retrieving its descriptor directly from the base class).
     This renders the meaning of the program undefined.  In the future,
     a check may be added to prevent this.

   * Nonempty `__slots__' does not work for classes derived from
     “variable-length” built-in types such as *note int: 184, *note
     bytes: 326. and *note tuple: 473.

   * Any non-string iterable may be assigned to `__slots__'.  Mappings
     may also be used; however, in the future, special meaning may be
     assigned to the values corresponding to each key.

   * `__class__' assignment works only if both classes have the same
     `__slots__'.

   * Multiple inheritance with multiple slotted parent classes can be
     used, but only one parent is allowed to have attributes created by
     slots (the other bases must have empty slot layouts) - violations
     raise *note TypeError: 192.

   * If an iterator is used for `__slots__' then a descriptor is created
     for each of the iterator’s values.  However, the `__slots__'
     attribute will be an empty iterator.


File: python.info,  Node: Customizing class creation,  Next: Customizing instance and subclass checks,  Prev: Customizing attribute access,  Up: Special method names

4.3.3.8 Customizing class creation
..................................

Whenever a class inherits from another class, `__init_subclass__' is
called on that class.  This way, it is possible to write classes which
change the behavior of subclasses.  This is closely related to class
decorators, but where class decorators only affect the specific class
they’re applied to, ‘__init_subclass__’ solely applies to future
subclasses of the class defining the method.

 -- Class Method: object.__init_subclass__ (cls)

     This method is called whenever the containing class is subclassed.
     `cls' is then the new subclass.  If defined as a normal instance
     method, this method is implicitly converted to a class method.

     Keyword arguments which are given to a new class are passed to the
     parent’s class ‘__init_subclass__’.  For compatibility with other
     classes using ‘__init_subclass__’, one should take out the needed
     keyword arguments and pass the others over to the base class, as
     in:

          class Philosopher:
              def __init_subclass__(cls, /, default_name, **kwargs):
                  super().__init_subclass__(**kwargs)
                  cls.default_name = default_name

          class AustralianPhilosopher(Philosopher, default_name="Bruce"):
              pass

     The default implementation ‘object.__init_subclass__’ does nothing,
     but raises an error if it is called with any arguments.

          Note: The metaclass hint ‘metaclass’ is consumed by the rest
          of the type machinery, and is never passed to
          ‘__init_subclass__’ implementations.  The actual metaclass
          (rather than the explicit hint) can be accessed as
          ‘type(cls)’.

     New in version 3.6.

* Menu:

* Metaclasses::
* Resolving MRO entries::
* Determining the appropriate metaclass::
* Preparing the class namespace::
* Executing the class body::
* Creating the class object::
* Uses for metaclasses::


File: python.info,  Node: Metaclasses,  Next: Resolving MRO entries,  Up: Customizing class creation

4.3.3.9 Metaclasses
...................

By default, classes are constructed using *note type(): 5fd.  The class
body is executed in a new namespace and the class name is bound locally
to the result of ‘type(name, bases, namespace)’.

The class creation process can be customized by passing the ‘metaclass’
keyword argument in the class definition line, or by inheriting from an
existing class that included such an argument.  In the following
example, both ‘MyClass’ and ‘MySubclass’ are instances of ‘Meta’:

     class Meta(type):
         pass

     class MyClass(metaclass=Meta):
         pass

     class MySubclass(MyClass):
         pass

Any other keyword arguments that are specified in the class definition
are passed through to all metaclass operations described below.

When a class definition is executed, the following steps occur:

   * MRO entries are resolved;

   * the appropriate metaclass is determined;

   * the class namespace is prepared;

   * the class body is executed;

   * the class object is created.


File: python.info,  Node: Resolving MRO entries,  Next: Determining the appropriate metaclass,  Prev: Metaclasses,  Up: Customizing class creation

4.3.3.10 Resolving MRO entries
..............................

If a base that appears in class definition is not an instance of *note
type: 5fd, then an ‘__mro_entries__’ method is searched on it.  If
found, it is called with the original bases tuple.  This method must
return a tuple of classes that will be used instead of this base.  The
tuple may be empty, in such case the original base is ignored.

See also
........

PEP 560(1) - Core support for typing module and generic types

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0560


File: python.info,  Node: Determining the appropriate metaclass,  Next: Preparing the class namespace,  Prev: Resolving MRO entries,  Up: Customizing class creation

4.3.3.11 Determining the appropriate metaclass
..............................................

The appropriate metaclass for a class definition is determined as
follows:

   * if no bases and no explicit metaclass are given, then *note type():
     5fd. is used;

   * if an explicit metaclass is given and it is `not' an instance of
     *note type(): 5fd, then it is used directly as the metaclass;

   * if an instance of *note type(): 5fd. is given as the explicit
     metaclass, or bases are defined, then the most derived metaclass is
     used.

The most derived metaclass is selected from the explicitly specified
metaclass (if any) and the metaclasses (i.e.  ‘type(cls)’) of all
specified base classes.  The most derived metaclass is one which is a
subtype of `all' of these candidate metaclasses.  If none of the
candidate metaclasses meets that criterion, then the class definition
will fail with ‘TypeError’.


File: python.info,  Node: Preparing the class namespace,  Next: Executing the class body,  Prev: Determining the appropriate metaclass,  Up: Customizing class creation

4.3.3.12 Preparing the class namespace
......................................

Once the appropriate metaclass has been identified, then the class
namespace is prepared.  If the metaclass has a ‘__prepare__’ attribute,
it is called as ‘namespace = metaclass.__prepare__(name, bases, **kwds)’
(where the additional keyword arguments, if any, come from the class
definition).

If the metaclass has no ‘__prepare__’ attribute, then the class
namespace is initialised as an empty ordered mapping.

See also
........

PEP 3115(1) - Metaclasses in Python 3000

     Introduced the ‘__prepare__’ namespace hook

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3115


File: python.info,  Node: Executing the class body,  Next: Creating the class object,  Prev: Preparing the class namespace,  Up: Customizing class creation

4.3.3.13 Executing the class body
.................................

The class body is executed (approximately) as ‘exec(body, globals(),
namespace)’.  The key difference from a normal call to *note exec():
c37. is that lexical scoping allows the class body (including any
methods) to reference names from the current and outer scopes when the
class definition occurs inside a function.

However, even when the class definition occurs inside the function,
methods defined inside the class still cannot see names defined at the
class scope.  Class variables must be accessed through the first
parameter of instance or class methods, or through the implicit
lexically scoped ‘__class__’ reference described in the next section.


File: python.info,  Node: Creating the class object,  Next: Uses for metaclasses,  Prev: Executing the class body,  Up: Customizing class creation

4.3.3.14 Creating the class object
..................................

Once the class namespace has been populated by executing the class body,
the class object is created by calling ‘metaclass(name, bases,
namespace, **kwds)’ (the additional keywords passed here are the same as
those passed to ‘__prepare__’).

This class object is the one that will be referenced by the
zero-argument form of *note super(): 4d7.  ‘__class__’ is an implicit
closure reference created by the compiler if any methods in a class body
refer to either ‘__class__’ or ‘super’.  This allows the zero argument
form of *note super(): 4d7. to correctly identify the class being
defined based on lexical scoping, while the class or instance that was
used to make the current call is identified based on the first argument
passed to the method.

`CPython implementation detail:' In CPython 3.6 and later, the
‘__class__’ cell is passed to the metaclass as a ‘__classcell__’ entry
in the class namespace.  If present, this must be propagated up to the
‘type.__new__’ call in order for the class to be initialised correctly.
Failing to do so will result in a *note RuntimeError: 2b8. in Python
3.8.

When using the default metaclass *note type: 5fd, or any metaclass that
ultimately calls ‘type.__new__’, the following additional customisation
steps are invoked after creating the class object:

   * first, ‘type.__new__’ collects all of the descriptors in the class
     namespace that define a *note __set_name__(): 4dd. method;

   * second, all of these ‘__set_name__’ methods are called with the
     class being defined and the assigned name of that particular
     descriptor;

   * finally, the *note __init_subclass__(): 4d8. hook is called on the
     immediate parent of the new class in its method resolution order.

After the class object is created, it is passed to the class decorators
included in the class definition (if any) and the resulting object is
bound in the local namespace as the defined class.

When a new class is created by ‘type.__new__’, the object provided as
the namespace parameter is copied to a new ordered mapping and the
original object is discarded.  The new copy is wrapped in a read-only
proxy, which becomes the *note __dict__: 4f1. attribute of the class
object.

See also
........

PEP 3135(1) - New super

     Describes the implicit ‘__class__’ closure reference

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3135


File: python.info,  Node: Uses for metaclasses,  Prev: Creating the class object,  Up: Customizing class creation

4.3.3.15 Uses for metaclasses
.............................

The potential uses for metaclasses are boundless.  Some ideas that have
been explored include enum, logging, interface checking, automatic
delegation, automatic property creation, proxies, frameworks, and
automatic resource locking/synchronization.


File: python.info,  Node: Customizing instance and subclass checks,  Next: Emulating generic types,  Prev: Customizing class creation,  Up: Special method names

4.3.3.16 Customizing instance and subclass checks
.................................................

The following methods are used to override the default behavior of the
*note isinstance(): 444. and *note issubclass(): 445. built-in
functions.

In particular, the metaclass *note abc.ABCMeta: 80d. implements these
methods in order to allow the addition of Abstract Base Classes (ABCs)
as “virtual base classes” to any class or type (including built-in
types), including other ABCs.

 -- Method: class.__instancecheck__ (self, instance)

     Return true if `instance' should be considered a (direct or
     indirect) instance of `class'.  If defined, called to implement
     ‘isinstance(instance, class)’.

 -- Method: class.__subclasscheck__ (self, subclass)

     Return true if `subclass' should be considered a (direct or
     indirect) subclass of `class'.  If defined, called to implement
     ‘issubclass(subclass, class)’.

Note that these methods are looked up on the type (metaclass) of a
class.  They cannot be defined as class methods in the actual class.
This is consistent with the lookup of special methods that are called on
instances, only in this case the instance is itself a class.

See also
........

PEP 3119(1) - Introducing Abstract Base Classes

     Includes the specification for customizing *note isinstance(): 444.
     and *note issubclass(): 445. behavior through *note
     __instancecheck__(): 138c. and *note __subclasscheck__(): 138d,
     with motivation for this functionality in the context of adding
     Abstract Base Classes (see the *note abc: 4. module) to the
     language.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3119


File: python.info,  Node: Emulating generic types,  Next: Emulating callable objects,  Prev: Customizing instance and subclass checks,  Up: Special method names

4.3.3.17 Emulating generic types
................................

One can implement the generic class syntax as specified by PEP 484(1)
(for example ‘List[int]’) by defining a special method:

 -- Class Method: object.__class_getitem__ (cls, key)

     Return an object representing the specialization of a generic class
     by type arguments found in `key'.

This method is looked up on the class object itself, and when defined in
the class body, this method is implicitly a class method.  Note, this
mechanism is primarily reserved for use with static type hints, other
usage is discouraged.

See also
........

PEP 560(2) - Core support for typing module and generic types

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484

   (2) https://www.python.org/dev/peps/pep-0560


File: python.info,  Node: Emulating callable objects,  Next: Emulating container types,  Prev: Emulating generic types,  Up: Special method names

4.3.3.18 Emulating callable objects
...................................

 -- Method: object.__call__ (self[, args...])

     Called when the instance is “called” as a function; if this method
     is defined, ‘x(arg1, arg2, ...)’ is a shorthand for
     ‘x.__call__(arg1, arg2, ...)’.


File: python.info,  Node: Emulating container types,  Next: Emulating numeric types,  Prev: Emulating callable objects,  Up: Special method names

4.3.3.19 Emulating container types
..................................

The following methods can be defined to implement container objects.
Containers usually are sequences (such as lists or tuples) or mappings
(like dictionaries), but can represent other containers as well.  The
first set of methods is used either to emulate a sequence or to emulate
a mapping; the difference is that for a sequence, the allowable keys
should be the integers `k' for which ‘0 <= k < N’ where `N' is the
length of the sequence, or slice objects, which define a range of items.
It is also recommended that mappings provide the methods ‘keys()’,
‘values()’, ‘items()’, ‘get()’, ‘clear()’, ‘setdefault()’, ‘pop()’,
‘popitem()’, ‘copy()’, and ‘update()’ behaving similar to those for
Python’s standard dictionary objects.  The *note collections.abc: 1f.
module provides a *note MutableMapping: 9e3. abstract base class to help
create those methods from a base set of *note __getitem__(): 27a, *note
__setitem__(): c55, *note __delitem__(): c56, and ‘keys()’.  Mutable
sequences should provide methods ‘append()’, ‘count()’, ‘index()’,
‘extend()’, ‘insert()’, ‘pop()’, ‘remove()’, ‘reverse()’ and ‘sort()’,
like Python standard list objects.  Finally, sequence types should
implement addition (meaning concatenation) and multiplication (meaning
repetition) by defining the methods *note __add__(): 1393, *note
__radd__(): 1394, *note __iadd__(): e63, *note __mul__(): 1395, *note
__rmul__(): 1396. and *note __imul__(): 1397. described below; they
should not define other numerical operators.  It is recommended that
both mappings and sequences implement the *note __contains__(): d1b.
method to allow efficient use of the ‘in’ operator; for mappings, ‘in’
should search the mapping’s keys; for sequences, it should search
through the values.  It is further recommended that both mappings and
sequences implement the *note __iter__(): 504. method to allow efficient
iteration through the container; for mappings, *note __iter__(): 504.
should iterate through the object’s keys; for sequences, it should
iterate through the values.

 -- Method: object.__len__ (self)

     Called to implement the built-in function *note len(): 150.  Should
     return the length of the object, an integer ‘>=’ 0.  Also, an
     object that doesn’t define a *note __bool__(): c5b. method and
     whose *note __len__(): dbe. method returns zero is considered to be
     false in a Boolean context.

     `CPython implementation detail:' In CPython, the length is required
     to be at most *note sys.maxsize: b36.  If the length is larger than
     ‘sys.maxsize’ some features (such as *note len(): 150.) may raise
     *note OverflowError: 954.  To prevent raising ‘OverflowError’ by
     truth value testing, an object must define a *note __bool__(): c5b.
     method.

 -- Method: object.__length_hint__ (self)

     Called to implement *note operator.length_hint(): 871.  Should
     return an estimated length for the object (which may be greater or
     less than the actual length).  The length must be an integer ‘>=’
     0.  The return value may also be *note NotImplemented: 840, which
     is treated the same as if the ‘__length_hint__’ method didn’t exist
     at all.  This method is purely an optimization and is never
     required for correctness.

     New in version 3.4.

     Note: Slicing is done exclusively with the following three methods.
     A call like

          a[1:2] = b

     is translated to

          a[slice(1, 2, None)] = b

     and so forth.  Missing slice items are always filled in with
     ‘None’.

 -- Method: object.__getitem__ (self, key)

     Called to implement evaluation of ‘self[key]’.  For sequence types,
     the accepted keys should be integers and slice objects.  Note that
     the special interpretation of negative indexes (if the class wishes
     to emulate a sequence type) is up to the *note __getitem__(): 27a.
     method.  If `key' is of an inappropriate type, *note TypeError:
     192. may be raised; if of a value outside the set of indexes for
     the sequence (after any special interpretation of negative values),
     *note IndexError: e69. should be raised.  For mapping types, if
     `key' is missing (not in the container), *note KeyError: 2c5.
     should be raised.

          Note: *note for: c23. loops expect that an *note IndexError:
          e69. will be raised for illegal indexes to allow proper
          detection of the end of the sequence.

 -- Method: object.__setitem__ (self, key, value)

     Called to implement assignment to ‘self[key]’.  Same note as for
     *note __getitem__(): 27a.  This should only be implemented for
     mappings if the objects support changes to the values for keys, or
     if new keys can be added, or for sequences if elements can be
     replaced.  The same exceptions should be raised for improper `key'
     values as for the *note __getitem__(): 27a. method.

 -- Method: object.__delitem__ (self, key)

     Called to implement deletion of ‘self[key]’.  Same note as for
     *note __getitem__(): 27a.  This should only be implemented for
     mappings if the objects support removal of keys, or for sequences
     if elements can be removed from the sequence.  The same exceptions
     should be raised for improper `key' values as for the *note
     __getitem__(): 27a. method.

 -- Method: object.__missing__ (self, key)

     Called by *note dict: 1b6.*note __getitem__(): 27a. to implement
     ‘self[key]’ for dict subclasses when key is not in the dictionary.

 -- Method: object.__iter__ (self)

     This method is called when an iterator is required for a container.
     This method should return a new iterator object that can iterate
     over all the objects in the container.  For mappings, it should
     iterate over the keys of the container.

     Iterator objects also need to implement this method; they are
     required to return themselves.  For more information on iterator
     objects, see *note Iterator Types: 1398.

 -- Method: object.__reversed__ (self)

     Called (if present) by the *note reversed(): 18e. built-in to
     implement reverse iteration.  It should return a new iterator
     object that iterates over all the objects in the container in
     reverse order.

     If the *note __reversed__(): 524. method is not provided, the *note
     reversed(): 18e. built-in will fall back to using the sequence
     protocol (*note __len__(): dbe. and *note __getitem__(): 27a.).
     Objects that support the sequence protocol should only provide
     *note __reversed__(): 524. if they can provide an implementation
     that is more efficient than the one provided by *note reversed():
     18e.

The membership test operators (*note in: 797. and *note not in: 1399.)
are normally implemented as an iteration through a container.  However,
container objects can supply the following special method with a more
efficient implementation, which also does not require the object be
iterable.

 -- Method: object.__contains__ (self, item)

     Called to implement membership test operators.  Should return true
     if `item' is in `self', false otherwise.  For mapping objects, this
     should consider the keys of the mapping rather than the values or
     the key-item pairs.

     For objects that don’t define *note __contains__(): d1b, the
     membership test first tries iteration via *note __iter__(): 504,
     then the old sequence iteration protocol via *note __getitem__():
     27a, see *note this section in the language reference: 139a.


File: python.info,  Node: Emulating numeric types,  Next: With Statement Context Managers,  Prev: Emulating container types,  Up: Special method names

4.3.3.20 Emulating numeric types
................................

The following methods can be defined to emulate numeric objects.
Methods corresponding to operations that are not supported by the
particular kind of number implemented (e.g., bitwise operations for
non-integral numbers) should be left undefined.

 -- Method: object.__add__ (self, other)
 -- Method: object.__sub__ (self, other)
 -- Method: object.__mul__ (self, other)
 -- Method: object.__matmul__ (self, other)
 -- Method: object.__truediv__ (self, other)
 -- Method: object.__floordiv__ (self, other)
 -- Method: object.__mod__ (self, other)
 -- Method: object.__divmod__ (self, other)
 -- Method: object.__pow__ (self, other[, modulo])
 -- Method: object.__lshift__ (self, other)
 -- Method: object.__rshift__ (self, other)
 -- Method: object.__and__ (self, other)
 -- Method: object.__xor__ (self, other)
 -- Method: object.__or__ (self, other)

     These methods are called to implement the binary arithmetic
     operations (‘+’, ‘-’, ‘*’, ‘@’, ‘/’, ‘//’, ‘%’, *note divmod():
     f4d, *note pow(): 152, ‘**’, ‘<<’, ‘>>’, ‘&’, ‘^’, ‘|’).  For
     instance, to evaluate the expression ‘x + y’, where `x' is an
     instance of a class that has an *note __add__(): 1393. method,
     ‘x.__add__(y)’ is called.  The *note __divmod__(): 77b. method
     should be the equivalent to using *note __floordiv__(): e28. and
     *note __mod__(): 139e.; it should not be related to *note
     __truediv__(): 77a.  Note that *note __pow__(): 139f. should be
     defined to accept an optional third argument if the ternary version
     of the built-in *note pow(): 152. function is to be supported.

     If one of those methods does not support the operation with the
     supplied arguments, it should return ‘NotImplemented’.

 -- Method: object.__radd__ (self, other)
 -- Method: object.__rsub__ (self, other)
 -- Method: object.__rmul__ (self, other)
 -- Method: object.__rmatmul__ (self, other)
 -- Method: object.__rtruediv__ (self, other)
 -- Method: object.__rfloordiv__ (self, other)
 -- Method: object.__rmod__ (self, other)
 -- Method: object.__rdivmod__ (self, other)
 -- Method: object.__rpow__ (self, other)
 -- Method: object.__rlshift__ (self, other)
 -- Method: object.__rrshift__ (self, other)
 -- Method: object.__rand__ (self, other)
 -- Method: object.__rxor__ (self, other)
 -- Method: object.__ror__ (self, other)

     These methods are called to implement the binary arithmetic
     operations (‘+’, ‘-’, ‘*’, ‘@’, ‘/’, ‘//’, ‘%’, *note divmod():
     f4d, *note pow(): 152, ‘**’, ‘<<’, ‘>>’, ‘&’, ‘^’, ‘|’) with
     reflected (swapped) operands.  These functions are only called if
     the left operand does not support the corresponding operation (1)
     and the operands are of different types.  (2) For instance, to
     evaluate the expression ‘x - y’, where `y' is an instance of a
     class that has an *note __rsub__(): 13a5. method, ‘y.__rsub__(x)’
     is called if ‘x.__sub__(y)’ returns `NotImplemented'.

     Note that ternary *note pow(): 152. will not try calling *note
     __rpow__(): 13a9. (the coercion rules would become too
     complicated).

          Note: If the right operand’s type is a subclass of the left
          operand’s type and that subclass provides the reflected method
          for the operation, this method will be called before the left
          operand’s non-reflected method.  This behavior allows
          subclasses to override their ancestors’ operations.

 -- Method: object.__iadd__ (self, other)
 -- Method: object.__isub__ (self, other)
 -- Method: object.__imul__ (self, other)
 -- Method: object.__imatmul__ (self, other)
 -- Method: object.__itruediv__ (self, other)
 -- Method: object.__ifloordiv__ (self, other)
 -- Method: object.__imod__ (self, other)
 -- Method: object.__ipow__ (self, other[, modulo])
 -- Method: object.__ilshift__ (self, other)
 -- Method: object.__irshift__ (self, other)
 -- Method: object.__iand__ (self, other)
 -- Method: object.__ixor__ (self, other)
 -- Method: object.__ior__ (self, other)

     These methods are called to implement the augmented arithmetic
     assignments (‘+=’, ‘-=’, ‘*=’, ‘@=’, ‘/=’, ‘//=’, ‘%=’, ‘**=’,
     ‘<<=’, ‘>>=’, ‘&=’, ‘^=’, ‘|=’).  These methods should attempt to
     do the operation in-place (modifying `self') and return the result
     (which could be, but does not have to be, `self').  If a specific
     method is not defined, the augmented assignment falls back to the
     normal methods.  For instance, if `x' is an instance of a class
     with an *note __iadd__(): e63. method, ‘x += y’ is equivalent to ‘x
     = x.__iadd__(y)’ .  Otherwise, ‘x.__add__(y)’ and ‘y.__radd__(x)’
     are considered, as with the evaluation of ‘x + y’.  In certain
     situations, augmented assignment can result in unexpected errors
     (see *note Why does a_tuple[i] += [‘item’] raise an exception when
     the addition works?: 13b8.), but this behavior is in fact part of
     the data model.

 -- Method: object.__neg__ (self)
 -- Method: object.__pos__ (self)
 -- Method: object.__abs__ (self)
 -- Method: object.__invert__ (self)

     Called to implement the unary arithmetic operations (‘-’, ‘+’,
     *note abs(): 11f8. and ‘~’).

 -- Method: object.__complex__ (self)
 -- Method: object.__int__ (self)
 -- Method: object.__float__ (self)

     Called to implement the built-in functions *note complex(): 189,
     *note int(): 184. and *note float(): 187.  Should return a value of
     the appropriate type.

 -- Method: object.__index__ (self)

     Called to implement *note operator.index(): 13bd, and whenever
     Python needs to losslessly convert the numeric object to an integer
     object (such as in slicing, or in the built-in *note bin(): c33,
     *note hex(): c59. and *note oct(): c58. functions).  Presence of
     this method indicates that the numeric object is an integer type.
     Must return an integer.

     If *note __int__(): 18b, *note __float__(): 18c. and *note
     __complex__(): 18d. are not defined then corresponding built-in
     functions *note int(): 184, *note float(): 187. and *note
     complex(): 189. fall back to *note __index__(): 18a.

 -- Method: object.__round__ (self[, ndigits])
 -- Method: object.__trunc__ (self)
 -- Method: object.__floor__ (self)
 -- Method: object.__ceil__ (self)

     Called to implement the built-in function *note round(): c60. and
     *note math: b1. functions *note trunc(): d21, *note floor(): d1f.
     and *note ceil(): d20.  Unless `ndigits' is passed to ‘__round__()’
     all these methods should return the value of the object truncated
     to an *note Integral: 135f. (typically an *note int: 184.).

     If *note __int__(): 18b. is not defined then the built-in function
     *note int(): 184. falls back to *note __trunc__(): 13bf.

   ---------- Footnotes ----------

   (1) (3) “Does not support” here means that the class has no such
method, or the method returns ‘NotImplemented’.  Do not set the method
to ‘None’ if you want to force fallback to the right operand’s reflected
method—that will instead have the opposite effect of explicitly
`blocking' such fallback.

   (2) (4) For operands of the same type, it is assumed that if the
non-reflected method (such as *note __add__(): 1393.) fails the
operation is not supported, which is why the reflected method is not
called.


File: python.info,  Node: With Statement Context Managers,  Next: Special method lookup,  Prev: Emulating numeric types,  Up: Special method names

4.3.3.21 With Statement Context Managers
........................................

A `context manager' is an object that defines the runtime context to be
established when executing a *note with: 6dd. statement.  The context
manager handles the entry into, and the exit from, the desired runtime
context for the execution of the block of code.  Context managers are
normally invoked using the ‘with’ statement (described in section *note
The with statement: 6dd.), but can also be used by directly invoking
their methods.

Typical uses of context managers include saving and restoring various
kinds of global state, locking and unlocking resources, closing opened
files, etc.

For more information on context managers, see *note Context Manager
Types: 13c4.

 -- Method: object.__enter__ (self)

     Enter the runtime context related to this object.  The *note with:
     6dd. statement will bind this method’s return value to the
     target(s) specified in the ‘as’ clause of the statement, if any.

 -- Method: object.__exit__ (self, exc_type, exc_value, traceback)

     Exit the runtime context related to this object.  The parameters
     describe the exception that caused the context to be exited.  If
     the context was exited without an exception, all three arguments
     will be *note None: 157.

     If an exception is supplied, and the method wishes to suppress the
     exception (i.e., prevent it from being propagated), it should
     return a true value.  Otherwise, the exception will be processed
     normally upon exit from this method.

     Note that *note __exit__(): c89. methods should not reraise the
     passed-in exception; this is the caller’s responsibility.

See also
........

PEP 343(1) - The “with” statement

     The specification, background, and examples for the Python *note
     with: 6dd. statement.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0343


File: python.info,  Node: Special method lookup,  Prev: With Statement Context Managers,  Up: Special method names

4.3.3.22 Special method lookup
..............................

For custom classes, implicit invocations of special methods are only
guaranteed to work correctly if defined on an object’s type, not in the
object’s instance dictionary.  That behaviour is the reason why the
following code raises an exception:

     >>> class C:
     ...     pass
     ...
     >>> c = C()
     >>> c.__len__ = lambda: 5
     >>> len(c)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: object of type 'C' has no len()

The rationale behind this behaviour lies with a number of special
methods such as *note __hash__(): 335. and *note __repr__(): 333. that
are implemented by all objects, including type objects.  If the implicit
lookup of these methods used the conventional lookup process, they would
fail when invoked on the type object itself:

     >>> 1 .__hash__() == hash(1)
     True
     >>> int.__hash__() == hash(int)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: descriptor '__hash__' of 'int' object needs an argument

Incorrectly attempting to invoke an unbound method of a class in this
way is sometimes referred to as ‘metaclass confusion’, and is avoided by
bypassing the instance when looking up special methods:

     >>> type(1).__hash__(1) == hash(1)
     True
     >>> type(int).__hash__(int) == hash(int)
     True

In addition to bypassing any instance attributes in the interest of
correctness, implicit special method lookup generally also bypasses the
*note __getattribute__(): 43e. method even of the object’s metaclass:

     >>> class Meta(type):
     ...     def __getattribute__(*args):
     ...         print("Metaclass getattribute invoked")
     ...         return type.__getattribute__(*args)
     ...
     >>> class C(object, metaclass=Meta):
     ...     def __len__(self):
     ...         return 10
     ...     def __getattribute__(*args):
     ...         print("Class getattribute invoked")
     ...         return object.__getattribute__(*args)
     ...
     >>> c = C()
     >>> c.__len__()                 # Explicit lookup via instance
     Class getattribute invoked
     10
     >>> type(c).__len__(c)          # Explicit lookup via type
     Metaclass getattribute invoked
     10
     >>> len(c)                      # Implicit lookup
     10

Bypassing the *note __getattribute__(): 43e. machinery in this fashion
provides significant scope for speed optimisations within the
interpreter, at the cost of some flexibility in the handling of special
methods (the special method `must' be set on the class object itself in
order to be consistently invoked by the interpreter).


File: python.info,  Node: Coroutines,  Prev: Special method names,  Up: Data model

4.3.4 Coroutines
----------------

* Menu:

* Awaitable Objects::
* Coroutine Objects::
* Asynchronous Iterators::
* Asynchronous Context Managers::


File: python.info,  Node: Awaitable Objects,  Next: Coroutine Objects,  Up: Coroutines

4.3.4.1 Awaitable Objects
.........................

An *note awaitable: 50e. object generally implements an *note
__await__(): 636. method.  *note Coroutine: 1a5. objects returned from
*note async def: 282. functions are awaitable.

     Note: The *note generator iterator: 44c. objects returned from
     generators decorated with *note types.coroutine(): 770. or *note
     asyncio.coroutine(): 280. are also awaitable, but they do not
     implement *note __await__(): 636.

 -- Method: object.__await__ (self)

     Must return an *note iterator: f73.  Should be used to implement
     *note awaitable: 50e. objects.  For instance, *note asyncio.Future:
     438. implements this method to be compatible with the *note await:
     1a2. expression.

New in version 3.5.

See also
........

PEP 492(1) for additional information about awaitable objects.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: Coroutine Objects,  Next: Asynchronous Iterators,  Prev: Awaitable Objects,  Up: Coroutines

4.3.4.2 Coroutine Objects
.........................

*note Coroutine: 1a5. objects are *note awaitable: 50e. objects.  A
coroutine’s execution can be controlled by calling *note __await__():
636. and iterating over the result.  When the coroutine has finished
executing and returns, the iterator raises *note StopIteration: 47b, and
the exception’s ‘value’ attribute holds the return value.  If the
coroutine raises an exception, it is propagated by the iterator.
Coroutines should not directly raise unhandled *note StopIteration: 47b.
exceptions.

Coroutines also have the methods listed below, which are analogous to
those of generators (see *note Generator-iterator methods: 13c9.).
However, unlike generators, coroutines do not directly support
iteration.

Changed in version 3.5.2: It is a *note RuntimeError: 2b8. to await on a
coroutine more than once.

 -- Method: coroutine.send (value)

     Starts or resumes execution of the coroutine.  If `value' is
     ‘None’, this is equivalent to advancing the iterator returned by
     *note __await__(): 636.  If `value' is not ‘None’, this method
     delegates to the *note send(): 13cb. method of the iterator that
     caused the coroutine to suspend.  The result (return value, *note
     StopIteration: 47b, or other exception) is the same as when
     iterating over the *note __await__(): 636. return value, described
     above.

 -- Method: coroutine.throw (type[, value[, traceback]])

     Raises the specified exception in the coroutine.  This method
     delegates to the *note throw(): 13cd. method of the iterator that
     caused the coroutine to suspend, if it has such a method.
     Otherwise, the exception is raised at the suspension point.  The
     result (return value, *note StopIteration: 47b, or other exception)
     is the same as when iterating over the *note __await__(): 636.
     return value, described above.  If the exception is not caught in
     the coroutine, it propagates back to the caller.

 -- Method: coroutine.close ()

     Causes the coroutine to clean itself up and exit.  If the coroutine
     is suspended, this method first delegates to the *note close():
     13cf. method of the iterator that caused the coroutine to suspend,
     if it has such a method.  Then it raises *note GeneratorExit: d25.
     at the suspension point, causing the coroutine to immediately clean
     itself up.  Finally, the coroutine is marked as having finished
     executing, even if it was never started.

     Coroutine objects are automatically closed using the above process
     when they are about to be destroyed.


File: python.info,  Node: Asynchronous Iterators,  Next: Asynchronous Context Managers,  Prev: Coroutine Objects,  Up: Coroutines

4.3.4.3 Asynchronous Iterators
..............................

An `asynchronous iterator' can call asynchronous code in its ‘__anext__’
method.

Asynchronous iterators can be used in an *note async for: 2e1.
statement.

 -- Method: object.__aiter__ (self)

     Must return an `asynchronous iterator' object.

 -- Method: object.__anext__ (self)

     Must return an `awaitable' resulting in a next value of the
     iterator.  Should raise a *note StopAsyncIteration: f49. error when
     the iteration is over.

An example of an asynchronous iterable object:

     class Reader:
         async def readline(self):
             ...

         def __aiter__(self):
             return self

         async def __anext__(self):
             val = await self.readline()
             if val == b'':
                 raise StopAsyncIteration
             return val

New in version 3.5.

Changed in version 3.7: Prior to Python 3.7, ‘__aiter__’ could return an
`awaitable' that would resolve to an *note asynchronous iterator: 639.

Starting with Python 3.7, ‘__aiter__’ must return an asynchronous
iterator object.  Returning anything else will result in a *note
TypeError: 192. error.


File: python.info,  Node: Asynchronous Context Managers,  Prev: Asynchronous Iterators,  Up: Coroutines

4.3.4.4 Asynchronous Context Managers
.....................................

An `asynchronous context manager' is a `context manager' that is able to
suspend execution in its ‘__aenter__’ and ‘__aexit__’ methods.

Asynchronous context managers can be used in an *note async with: 637.
statement.

 -- Method: object.__aenter__ (self)

     Semantically similar to *note __enter__(): c88, the only difference
     being that it must return an `awaitable'.

 -- Method: object.__aexit__ (self, exc_type, exc_value, traceback)

     Semantically similar to *note __exit__(): c89, the only difference
     being that it must return an `awaitable'.

An example of an asynchronous context manager class:

     class AsyncContextManager:
         async def __aenter__(self):
             await log('entering context')

         async def __aexit__(self, exc_type, exc, tb):
             await log('exiting context')

New in version 3.5.


File: python.info,  Node: Execution model,  Next: The import system,  Prev: Data model,  Up: The Python Language Reference

4.4 Execution model
===================

* Menu:

* Structure of a program::
* Naming and binding::
* Exceptions: Exceptions<2>.


File: python.info,  Node: Structure of a program,  Next: Naming and binding,  Up: Execution model

4.4.1 Structure of a program
----------------------------

A Python program is constructed from code blocks.  A `block' is a piece
of Python program text that is executed as a unit.  The following are
blocks: a module, a function body, and a class definition.  Each command
typed interactively is a block.  A script file (a file given as standard
input to the interpreter or specified as a command line argument to the
interpreter) is a code block.  A script command (a command specified on
the interpreter command line with the *note -c: 1145. option) is a code
block.  The string argument passed to the built-in functions *note
eval(): b83. and *note exec(): c37. is a code block.

A code block is executed in an `execution frame'.  A frame contains some
administrative information (used for debugging) and determines where and
how execution continues after the code block’s execution has completed.


File: python.info,  Node: Naming and binding,  Next: Exceptions<2>,  Prev: Structure of a program,  Up: Execution model

4.4.2 Naming and binding
------------------------

* Menu:

* Binding of names::
* Resolution of names::
* Builtins and restricted execution::
* Interaction with dynamic features::


File: python.info,  Node: Binding of names,  Next: Resolution of names,  Up: Naming and binding

4.4.2.1 Binding of names
........................

`Names' refer to objects.  Names are introduced by name binding
operations.

The following constructs bind names: formal parameters to functions,
*note import: c10. statements, class and function definitions (these
bind the class or function name in the defining block), and targets that
are identifiers if occurring in an assignment, *note for: c23. loop
header, or after ‘as’ in a *note with: 6dd. statement or *note except:
b31. clause.  The ‘import’ statement of the form ‘from ... import *’
binds all names defined in the imported module, except those beginning
with an underscore.  This form may only be used at the module level.

A target occurring in a *note del: 11a8. statement is also considered
bound for this purpose (though the actual semantics are to unbind the
name).

Each assignment or import statement occurs within a block defined by a
class or function definition or at the module level (the top-level code
block).

If a name is bound in a block, it is a local variable of that block,
unless declared as *note nonlocal: c32. or *note global: 117e.  If a
name is bound at the module level, it is a global variable.  (The
variables of the module code block are local and global.)  If a variable
is used in a code block but not defined there, it is a `free variable'.

Each occurrence of a name in the program text refers to the `binding' of
that name established by the following name resolution rules.


File: python.info,  Node: Resolution of names,  Next: Builtins and restricted execution,  Prev: Binding of names,  Up: Naming and binding

4.4.2.2 Resolution of names
...........................

A `scope' defines the visibility of a name within a block.  If a local
variable is defined in a block, its scope includes that block.  If the
definition occurs in a function block, the scope extends to any blocks
contained within the defining one, unless a contained block introduces a
different binding for the name.

When a name is used in a code block, it is resolved using the nearest
enclosing scope.  The set of all such scopes visible to a code block is
called the block’s `environment'.

When a name is not found at all, a *note NameError: d6e. exception is
raised.  If the current scope is a function scope, and the name refers
to a local variable that has not yet been bound to a value at the point
where the name is used, an *note UnboundLocalError: e6a. exception is
raised.  *note UnboundLocalError: e6a. is a subclass of *note NameError:
d6e.

If a name binding operation occurs anywhere within a code block, all
uses of the name within the block are treated as references to the
current block.  This can lead to errors when a name is used within a
block before it is bound.  This rule is subtle.  Python lacks
declarations and allows name binding operations to occur anywhere within
a code block.  The local variables of a code block can be determined by
scanning the entire text of the block for name binding operations.

If the *note global: 117e. statement occurs within a block, all uses of
the name specified in the statement refer to the binding of that name in
the top-level namespace.  Names are resolved in the top-level namespace
by searching the global namespace, i.e.  the namespace of the module
containing the code block, and the builtins namespace, the namespace of
the module *note builtins: 13.  The global namespace is searched first.
If the name is not found there, the builtins namespace is searched.  The
‘global’ statement must precede all uses of the name.

The *note global: 117e. statement has the same scope as a name binding
operation in the same block.  If the nearest enclosing scope for a free
variable contains a global statement, the free variable is treated as a
global.

The *note nonlocal: c32. statement causes corresponding names to refer
to previously bound variables in the nearest enclosing function scope.
*note SyntaxError: 44d. is raised at compile time if the given name does
not exist in any enclosing function scope.

The namespace for a module is automatically created the first time a
module is imported.  The main module for a script is always called *note
__main__: 1.

Class definition blocks and arguments to *note exec(): c37. and *note
eval(): b83. are special in the context of name resolution.  A class
definition is an executable statement that may use and define names.
These references follow the normal rules for name resolution with an
exception that unbound local variables are looked up in the global
namespace.  The namespace of the class definition becomes the attribute
dictionary of the class.  The scope of names defined in a class block is
limited to the class block; it does not extend to the code blocks of
methods – this includes comprehensions and generator expressions since
they are implemented using a function scope.  This means that the
following will fail:

     class A:
         a = 42
         b = list(a + i for i in range(10))


File: python.info,  Node: Builtins and restricted execution,  Next: Interaction with dynamic features,  Prev: Resolution of names,  Up: Naming and binding

4.4.2.3 Builtins and restricted execution
.........................................

`CPython implementation detail:' Users should not touch ‘__builtins__’;
it is strictly an implementation detail.  Users wanting to override
values in the builtins namespace should *note import: c10. the *note
builtins: 13. module and modify its attributes appropriately.

The builtins namespace associated with the execution of a code block is
actually found by looking up the name ‘__builtins__’ in its global
namespace; this should be a dictionary or a module (in the latter case
the module’s dictionary is used).  By default, when in the *note
__main__: 1. module, ‘__builtins__’ is the built-in module *note
builtins: 13.; when in any other module, ‘__builtins__’ is an alias for
the dictionary of the *note builtins: 13. module itself.


File: python.info,  Node: Interaction with dynamic features,  Prev: Builtins and restricted execution,  Up: Naming and binding

4.4.2.4 Interaction with dynamic features
.........................................

Name resolution of free variables occurs at runtime, not at compile
time.  This means that the following code will print 42:

     i = 10
     def f():
         print(i)
     i = 42
     f()

The *note eval(): b83. and *note exec(): c37. functions do not have
access to the full environment for resolving names.  Names may be
resolved in the local and global namespaces of the caller.  Free
variables are not resolved in the nearest enclosing namespace, but in
the global namespace.  (1) The *note exec(): c37. and *note eval(): b83.
functions have optional arguments to override the global and local
namespace.  If only one namespace is specified, it is used for both.

   ---------- Footnotes ----------

   (1) (1) This limitation occurs because the code that is executed by
these operations is not available at the time the module is compiled.


File: python.info,  Node: Exceptions<2>,  Prev: Naming and binding,  Up: Execution model

4.4.3 Exceptions
----------------

Exceptions are a means of breaking out of the normal flow of control of
a code block in order to handle errors or other exceptional conditions.
An exception is `raised' at the point where the error is detected; it
may be `handled' by the surrounding code block or by any code block that
directly or indirectly invoked the code block where the error occurred.

The Python interpreter raises an exception when it detects a run-time
error (such as division by zero).  A Python program can also explicitly
raise an exception with the *note raise: c35. statement.  Exception
handlers are specified with the *note try: d65. … *note except: b31.
statement.  The *note finally: 182. clause of such a statement can be
used to specify cleanup code which does not handle the exception, but is
executed whether an exception occurred or not in the preceding code.

Python uses the “termination” model of error handling: an exception
handler can find out what happened and continue execution at an outer
level, but it cannot repair the cause of the error and retry the failing
operation (except by re-entering the offending piece of code from the
top).

When an exception is not handled at all, the interpreter terminates
execution of the program, or returns to its interactive main loop.  In
either case, it prints a stack traceback, except when the exception is
*note SystemExit: 5f1.

Exceptions are identified by class instances.  The *note except: b31.
clause is selected depending on the class of the instance: it must
reference the class of the instance or a base class thereof.  The
instance can be received by the handler and can carry additional
information about the exceptional condition.

     Note: Exception messages are not part of the Python API. Their
     contents may change from one version of Python to the next without
     warning and should not be relied on by code which will run under
     multiple versions of the interpreter.

See also the description of the *note try: d65. statement in section
*note The try statement: d65. and *note raise: c35. statement in section
*note The raise statement: c35.


File: python.info,  Node: The import system,  Next: Expressions,  Prev: Execution model,  Up: The Python Language Reference

4.5 The import system
=====================

Python code in one *note module: 13e9. gains access to the code in
another module by the process of *note importing: 13ea. it.  The *note
import: c10. statement is the most common way of invoking the import
machinery, but it is not the only way.  Functions such as *note
importlib.import_module(): b06. and built-in *note __import__(): 605.
can also be used to invoke the import machinery.

The *note import: c10. statement combines two operations; it searches
for the named module, then it binds the results of that search to a name
in the local scope.  The search operation of the ‘import’ statement is
defined as a call to the *note __import__(): 605. function, with the
appropriate arguments.  The return value of *note __import__(): 605. is
used to perform the name binding operation of the ‘import’ statement.
See the ‘import’ statement for the exact details of that name binding
operation.

A direct call to *note __import__(): 605. performs only the module
search and, if found, the module creation operation.  While certain
side-effects may occur, such as the importing of parent packages, and
the updating of various caches (including *note sys.modules: 13eb.),
only the *note import: c10. statement performs a name binding operation.

When an *note import: c10. statement is executed, the standard builtin
*note __import__(): 605. function is called.  Other mechanisms for
invoking the import system (such as *note importlib.import_module():
b06.) may choose to bypass *note __import__(): 605. and use their own
solutions to implement import semantics.

When a module is first imported, Python searches for the module and if
found, it creates a module object (1), initializing it.  If the named
module cannot be found, a *note ModuleNotFoundError: 38f. is raised.
Python implements various strategies to search for the named module when
the import machinery is invoked.  These strategies can be modified and
extended by using various hooks described in the sections below.

Changed in version 3.3: The import system has been updated to fully
implement the second phase of PEP 302(2).  There is no longer any
implicit import machinery - the full import system is exposed through
*note sys.meta_path: 5db.  In addition, native namespace package support
has been implemented (see PEP 420(3)).

* Menu:

* importlib: importlib<7>.
* Packages: Packages<2>.
* Searching::
* Loading::
* The Path Based Finder::
* Replacing the standard import system::
* Package Relative Imports::
* Special considerations for __main__::
* Open issues::
* References::

   ---------- Footnotes ----------

   (1) (1) See *note types.ModuleType: 6e5.

   (2) https://www.python.org/dev/peps/pep-0302

   (3) https://www.python.org/dev/peps/pep-0420


File: python.info,  Node: importlib<7>,  Next: Packages<2>,  Up: The import system

4.5.1 ‘importlib’
-----------------

The *note importlib: 9b. module provides a rich API for interacting with
the import system.  For example *note importlib.import_module(): b06.
provides a recommended, simpler API than built-in *note __import__():
605. for invoking the import machinery.  Refer to the *note importlib:
9b. library documentation for additional detail.


File: python.info,  Node: Packages<2>,  Next: Searching,  Prev: importlib<7>,  Up: The import system

4.5.2 Packages
--------------

Python has only one type of module object, and all modules are of this
type, regardless of whether the module is implemented in Python, C, or
something else.  To help organize modules and provide a naming
hierarchy, Python has a concept of *note packages: 13ee.

You can think of packages as the directories on a file system and
modules as files within directories, but don’t take this analogy too
literally since packages and modules need not originate from the file
system.  For the purposes of this documentation, we’ll use this
convenient analogy of directories and files.  Like file system
directories, packages are organized hierarchically, and packages may
themselves contain subpackages, as well as regular modules.

It’s important to keep in mind that all packages are modules, but not
all modules are packages.  Or put another way, packages are just a
special kind of module.  Specifically, any module that contains a
‘__path__’ attribute is considered a package.

All modules have a name.  Subpackage names are separated from their
parent package name by dots, akin to Python’s standard attribute access
syntax.  Thus you might have a module called *note sys: fd. and a
package called *note email: 69, which in turn has a subpackage called
*note email.mime: 73. and a module within that subpackage called
‘email.mime.text’.

* Menu:

* Regular packages::
* Namespace packages::


File: python.info,  Node: Regular packages,  Next: Namespace packages,  Up: Packages<2>

4.5.2.1 Regular packages
........................

Python defines two types of packages, *note regular packages: 13f0. and
*note namespace packages: 13f1.  Regular packages are traditional
packages as they existed in Python 3.2 and earlier.  A regular package
is typically implemented as a directory containing an ‘__init__.py’
file.  When a regular package is imported, this ‘__init__.py’ file is
implicitly executed, and the objects it defines are bound to names in
the package’s namespace.  The ‘__init__.py’ file can contain the same
Python code that any other module can contain, and Python will add some
additional attributes to the module when it is imported.

For example, the following file system layout defines a top level
‘parent’ package with three subpackages:

     parent/
         __init__.py
         one/
             __init__.py
         two/
             __init__.py
         three/
             __init__.py

Importing ‘parent.one’ will implicitly execute ‘parent/__init__.py’ and
‘parent/one/__init__.py’.  Subsequent imports of ‘parent.two’ or
‘parent.three’ will execute ‘parent/two/__init__.py’ and
‘parent/three/__init__.py’ respectively.


File: python.info,  Node: Namespace packages,  Prev: Regular packages,  Up: Packages<2>

4.5.2.2 Namespace packages
..........................

A namespace package is a composite of various *note portions: 13f3,
where each portion contributes a subpackage to the parent package.
Portions may reside in different locations on the file system.  Portions
may also be found in zip files, on the network, or anywhere else that
Python searches during import.  Namespace packages may or may not
correspond directly to objects on the file system; they may be virtual
modules that have no concrete representation.

Namespace packages do not use an ordinary list for their ‘__path__’
attribute.  They instead use a custom iterable type which will
automatically perform a new search for package portions on the next
import attempt within that package if the path of their parent package
(or *note sys.path: 47d. for a top level package) changes.

With namespace packages, there is no ‘parent/__init__.py’ file.  In
fact, there may be multiple ‘parent’ directories found during import
search, where each one is provided by a different portion.  Thus
‘parent/one’ may not be physically located next to ‘parent/two’.  In
this case, Python will create a namespace package for the top-level
‘parent’ package whenever it or one of its subpackages is imported.

See also PEP 420(1) for the namespace package specification.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0420


File: python.info,  Node: Searching,  Next: Loading,  Prev: Packages<2>,  Up: The import system

4.5.3 Searching
---------------

To begin the search, Python needs the *note fully qualified: 1366. name
of the module (or package, but for the purposes of this discussion, the
difference is immaterial) being imported.  This name may come from
various arguments to the *note import: c10. statement, or from the
parameters to the *note importlib.import_module(): b06. or *note
__import__(): 605. functions.

This name will be used in various phases of the import search, and it
may be the dotted path to a submodule, e.g.  ‘foo.bar.baz’.  In this
case, Python first tries to import ‘foo’, then ‘foo.bar’, and finally
‘foo.bar.baz’.  If any of the intermediate imports fail, a *note
ModuleNotFoundError: 38f. is raised.

* Menu:

* The module cache::
* Finders and loaders::
* Import hooks::
* The meta path::


File: python.info,  Node: The module cache,  Next: Finders and loaders,  Up: Searching

4.5.3.1 The module cache
........................

The first place checked during import search is *note sys.modules: 13eb.
This mapping serves as a cache of all modules that have been previously
imported, including the intermediate paths.  So if ‘foo.bar.baz’ was
previously imported, *note sys.modules: 13eb. will contain entries for
‘foo’, ‘foo.bar’, and ‘foo.bar.baz’.  Each key will have as its value
the corresponding module object.

During import, the module name is looked up in *note sys.modules: 13eb.
and if present, the associated value is the module satisfying the
import, and the process completes.  However, if the value is ‘None’,
then a *note ModuleNotFoundError: 38f. is raised.  If the module name is
missing, Python will continue searching for the module.

*note sys.modules: 13eb. is writable.  Deleting a key may not destroy
the associated module (as other modules may hold references to it), but
it will invalidate the cache entry for the named module, causing Python
to search anew for the named module upon its next import.  The key can
also be assigned to ‘None’, forcing the next import of the module to
result in a *note ModuleNotFoundError: 38f.

Beware though, as if you keep a reference to the module object,
invalidate its cache entry in *note sys.modules: 13eb, and then
re-import the named module, the two module objects will `not' be the
same.  By contrast, *note importlib.reload(): 38e. will reuse the `same'
module object, and simply reinitialise the module contents by rerunning
the module’s code.


File: python.info,  Node: Finders and loaders,  Next: Import hooks,  Prev: The module cache,  Up: Searching

4.5.3.2 Finders and loaders
...........................

If the named module is not found in *note sys.modules: 13eb, then
Python’s import protocol is invoked to find and load the module.  This
protocol consists of two conceptual objects, *note finders: 13f7. and
*note loaders: 13f8.  A finder’s job is to determine whether it can find
the named module using whatever strategy it knows about.  Objects that
implement both of these interfaces are referred to as *note importers:
13f9. - they return themselves when they find that they can load the
requested module.

Python includes a number of default finders and importers.  The first
one knows how to locate built-in modules, and the second knows how to
locate frozen modules.  A third default finder searches an *note import
path: 13fa. for modules.  The *note import path: 13fa. is a list of
locations that may name file system paths or zip files.  It can also be
extended to search for any locatable resource, such as those identified
by URLs.

The import machinery is extensible, so new finders can be added to
extend the range and scope of module searching.

Finders do not actually load modules.  If they can find the named
module, they return a `module spec', an encapsulation of the module’s
import-related information, which the import machinery then uses when
loading the module.

The following sections describe the protocol for finders and loaders in
more detail, including how you can create and register new ones to
extend the import machinery.

Changed in version 3.4: In previous versions of Python, finders returned
*note loaders: 13f8. directly, whereas now they return module specs
which `contain' loaders.  Loaders are still used during import but have
fewer responsibilities.


File: python.info,  Node: Import hooks,  Next: The meta path,  Prev: Finders and loaders,  Up: Searching

4.5.3.3 Import hooks
....................

The import machinery is designed to be extensible; the primary mechanism
for this are the `import hooks'.  There are two types of import hooks:
`meta hooks' and `import path hooks'.

Meta hooks are called at the start of import processing, before any
other import processing has occurred, other than *note sys.modules:
13eb. cache look up.  This allows meta hooks to override *note sys.path:
47d. processing, frozen modules, or even built-in modules.  Meta hooks
are registered by adding new finder objects to *note sys.meta_path: 5db,
as described below.

Import path hooks are called as part of *note sys.path: 47d. (or
‘package.__path__’) processing, at the point where their associated path
item is encountered.  Import path hooks are registered by adding new
callables to *note sys.path_hooks: 950. as described below.


File: python.info,  Node: The meta path,  Prev: Import hooks,  Up: Searching

4.5.3.4 The meta path
.....................

When the named module is not found in *note sys.modules: 13eb, Python
next searches *note sys.meta_path: 5db, which contains a list of meta
path finder objects.  These finders are queried in order to see if they
know how to handle the named module.  Meta path finders must implement a
method called *note find_spec(): 458. which takes three arguments: a
name, an import path, and (optionally) a target module.  The meta path
finder can use any strategy it wants to determine whether it can handle
the named module or not.

If the meta path finder knows how to handle the named module, it returns
a spec object.  If it cannot handle the named module, it returns ‘None’.
If *note sys.meta_path: 5db. processing reaches the end of its list
without returning a spec, then a *note ModuleNotFoundError: 38f. is
raised.  Any other exceptions raised are simply propagated up, aborting
the import process.

The *note find_spec(): 458. method of meta path finders is called with
two or three arguments.  The first is the fully qualified name of the
module being imported, for example ‘foo.bar.baz’.  The second argument
is the path entries to use for the module search.  For top-level
modules, the second argument is ‘None’, but for submodules or
subpackages, the second argument is the value of the parent package’s
‘__path__’ attribute.  If the appropriate ‘__path__’ attribute cannot be
accessed, a *note ModuleNotFoundError: 38f. is raised.  The third
argument is an existing module object that will be the target of loading
later.  The import system passes in a target module only during reload.

The meta path may be traversed multiple times for a single import
request.  For example, assuming none of the modules involved has already
been cached, importing ‘foo.bar.baz’ will first perform a top level
import, calling ‘mpf.find_spec("foo", None, None)’ on each meta path
finder (‘mpf’).  After ‘foo’ has been imported, ‘foo.bar’ will be
imported by traversing the meta path a second time, calling
‘mpf.find_spec("foo.bar", foo.__path__, None)’.  Once ‘foo.bar’ has been
imported, the final traversal will call ‘mpf.find_spec("foo.bar.baz",
foo.bar.__path__, None)’.

Some meta path finders only support top level imports.  These importers
will always return ‘None’ when anything other than ‘None’ is passed as
the second argument.

Python’s default *note sys.meta_path: 5db. has three meta path finders,
one that knows how to import built-in modules, one that knows how to
import frozen modules, and one that knows how to import modules from an
*note import path: 13fa. (i.e.  the *note path based finder: 13fd.).

Changed in version 3.4: The *note find_spec(): 458. method of meta path
finders replaced *note find_module(): 457, which is now deprecated.
While it will continue to work without change, the import machinery will
try it only if the finder does not implement ‘find_spec()’.


File: python.info,  Node: Loading,  Next: The Path Based Finder,  Prev: Searching,  Up: The import system

4.5.4 Loading
-------------

If and when a module spec is found, the import machinery will use it
(and the loader it contains) when loading the module.  Here is an
approximation of what happens during the loading portion of import:

     module = None
     if spec.loader is not None and hasattr(spec.loader, 'create_module'):
         # It is assumed 'exec_module' will also be defined on the loader.
         module = spec.loader.create_module(spec)
     if module is None:
         module = ModuleType(spec.name)
     # The import-related module attributes get set here:
     _init_module_attrs(spec, module)

     if spec.loader is None:
         # unsupported
         raise ImportError
     if spec.origin is None and spec.submodule_search_locations is not None:
         # namespace package
         sys.modules[spec.name] = module
     elif not hasattr(spec.loader, 'exec_module'):
         module = spec.loader.load_module(spec.name)
         # Set __loader__ and __package__ if missing.
     else:
         sys.modules[spec.name] = module
         try:
             spec.loader.exec_module(module)
         except BaseException:
             try:
                 del sys.modules[spec.name]
             except KeyError:
                 pass
             raise
     return sys.modules[spec.name]

Note the following details:

        * If there is an existing module object with the given name in
          *note sys.modules: 13eb, import will have already returned it.

        * The module will exist in *note sys.modules: 13eb. before the
          loader executes the module code.  This is crucial because the
          module code may (directly or indirectly) import itself; adding
          it to *note sys.modules: 13eb. beforehand prevents unbounded
          recursion in the worst case and multiple loading in the best.

        * If loading fails, the failing module – and only the failing
          module – gets removed from *note sys.modules: 13eb.  Any
          module already in the *note sys.modules: 13eb. cache, and any
          module that was successfully loaded as a side-effect, must
          remain in the cache.  This contrasts with reloading where even
          the failing module is left in *note sys.modules: 13eb.

        * After the module is created but before execution, the import
          machinery sets the import-related module attributes
          (“_init_module_attrs” in the pseudo-code example above), as
          summarized in a *note later section: 13ff.

        * Module execution is the key moment of loading in which the
          module’s namespace gets populated.  Execution is entirely
          delegated to the loader, which gets to decide what gets
          populated and how.

        * The module created during loading and passed to exec_module()
          may not be the one returned at the end of import (1).

Changed in version 3.4: The import system has taken over the boilerplate
responsibilities of loaders.  These were previously performed by the
*note importlib.abc.Loader.load_module(): 5d8. method.

* Menu:

* Loaders::
* Submodules::
* Module spec::
* Import-related module attributes::
* module.__path__: module __path__.
* Module reprs::
* Cached bytecode invalidation::

   ---------- Footnotes ----------

   (1) (2) The importlib implementation avoids using the return value
directly.  Instead, it gets the module object by looking the module name
up in *note sys.modules: 13eb.  The indirect effect of this is that an
imported module may replace itself in *note sys.modules: 13eb.  This is
implementation-specific behavior that is not guaranteed to work in other
Python implementations.


File: python.info,  Node: Loaders,  Next: Submodules,  Up: Loading

4.5.4.1 Loaders
...............

Module loaders provide the critical function of loading: module
execution.  The import machinery calls the *note
importlib.abc.Loader.exec_module(): 5d9. method with a single argument,
the module object to execute.  Any value returned from *note
exec_module(): 5d9. is ignored.

Loaders must satisfy the following requirements:

        * If the module is a Python module (as opposed to a built-in
          module or a dynamically loaded extension), the loader should
          execute the module’s code in the module’s global name space
          (‘module.__dict__’).

        * If the loader cannot execute the module, it should raise an
          *note ImportError: 329, although any other exception raised
          during *note exec_module(): 5d9. will be propagated.

In many cases, the finder and loader can be the same object; in such
cases the *note find_spec(): 458. method would just return a spec with
the loader set to ‘self’.

Module loaders may opt in to creating the module object during loading
by implementing a *note create_module(): 549. method.  It takes one
argument, the module spec, and returns the new module object to use
during loading.  ‘create_module()’ does not need to set any attributes
on the module object.  If the method returns ‘None’, the import
machinery will create the new module itself.

New in version 3.4: The *note create_module(): 549. method of loaders.

Changed in version 3.4: The *note load_module(): 5d8. method was
replaced by *note exec_module(): 5d9. and the import machinery assumed
all the boilerplate responsibilities of loading.

For compatibility with existing loaders, the import machinery will use
the ‘load_module()’ method of loaders if it exists and the loader does
not also implement ‘exec_module()’.  However, ‘load_module()’ has been
deprecated and loaders should implement ‘exec_module()’ instead.

The ‘load_module()’ method must implement all the boilerplate loading
functionality described above in addition to executing the module.  All
the same constraints apply, with some additional clarification:

        * If there is an existing module object with the given name in
          *note sys.modules: 13eb, the loader must use that existing
          module.  (Otherwise, *note importlib.reload(): 38e. will not
          work correctly.)  If the named module does not exist in *note
          sys.modules: 13eb, the loader must create a new module object
          and add it to *note sys.modules: 13eb.

        * The module `must' exist in *note sys.modules: 13eb. before the
          loader executes the module code, to prevent unbounded
          recursion or multiple loading.

        * If loading fails, the loader must remove any modules it has
          inserted into *note sys.modules: 13eb, but it must remove
          `only' the failing module(s), and only if the loader itself
          has loaded the module(s) explicitly.

Changed in version 3.5: A *note DeprecationWarning: 276. is raised when
‘exec_module()’ is defined but ‘create_module()’ is not.

Changed in version 3.6: An *note ImportError: 329. is raised when
‘exec_module()’ is defined but ‘create_module()’ is not.


File: python.info,  Node: Submodules,  Next: Module spec,  Prev: Loaders,  Up: Loading

4.5.4.2 Submodules
..................

When a submodule is loaded using any mechanism (e.g.  ‘importlib’ APIs,
the ‘import’ or ‘import-from’ statements, or built-in ‘__import__()’) a
binding is placed in the parent module’s namespace to the submodule
object.  For example, if package ‘spam’ has a submodule ‘foo’, after
importing ‘spam.foo’, ‘spam’ will have an attribute ‘foo’ which is bound
to the submodule.  Let’s say you have the following directory structure:

     spam/
         __init__.py
         foo.py
         bar.py

and ‘spam/__init__.py’ has the following lines in it:

     from .foo import Foo
     from .bar import Bar

then executing the following puts a name binding to ‘foo’ and ‘bar’ in
the ‘spam’ module:

     >>> import spam
     >>> spam.foo
     <module 'spam.foo' from '/tmp/imports/spam/foo.py'>
     >>> spam.bar
     <module 'spam.bar' from '/tmp/imports/spam/bar.py'>

Given Python’s familiar name binding rules this might seem surprising,
but it’s actually a fundamental feature of the import system.  The
invariant holding is that if you have ‘sys.modules['spam']’ and
‘sys.modules['spam.foo']’ (as you would after the above import), the
latter must appear as the ‘foo’ attribute of the former.


File: python.info,  Node: Module spec,  Next: Import-related module attributes,  Prev: Submodules,  Up: Loading

4.5.4.3 Module spec
...................

The import machinery uses a variety of information about each module
during import, especially before loading.  Most of the information is
common to all modules.  The purpose of a module’s spec is to encapsulate
this import-related information on a per-module basis.

Using a spec during import allows state to be transferred between import
system components, e.g.  between the finder that creates the module spec
and the loader that executes it.  Most importantly, it allows the import
machinery to perform the boilerplate operations of loading, whereas
without a module spec the loader had that responsibility.

The module’s spec is exposed as the ‘__spec__’ attribute on a module
object.  See *note ModuleSpec: 1403. for details on the contents of the
module spec.

New in version 3.4.


File: python.info,  Node: Import-related module attributes,  Next: module __path__,  Prev: Module spec,  Up: Loading

4.5.4.4 Import-related module attributes
........................................

The import machinery fills in these attributes on each module object
during loading, based on the module’s spec, before the loader executes
the module.

 -- Attribute: __name__

     The ‘__name__’ attribute must be set to the fully-qualified name of
     the module.  This name is used to uniquely identify the module in
     the import system.

 -- Attribute: __loader__

     The ‘__loader__’ attribute must be set to the loader object that
     the import machinery used when loading the module.  This is mostly
     for introspection, but can be used for additional loader-specific
     functionality, for example getting data associated with a loader.

 -- Attribute: __package__

     The module’s ‘__package__’ attribute must be set.  Its value must
     be a string, but it can be the same value as its ‘__name__’.  When
     the module is a package, its ‘__package__’ value should be set to
     its ‘__name__’.  When the module is not a package, ‘__package__’
     should be set to the empty string for top-level modules, or for
     submodules, to the parent package’s name.  See PEP 366(1) for
     further details.

     This attribute is used instead of ‘__name__’ to calculate explicit
     relative imports for main modules, as defined in PEP 366(2).  It is
     expected to have the same value as ‘__spec__.parent’.

     Changed in version 3.6: The value of ‘__package__’ is expected to
     be the same as ‘__spec__.parent’.

 -- Attribute: __spec__

     The ‘__spec__’ attribute must be set to the module spec that was
     used when importing the module.  Setting ‘__spec__’ appropriately
     applies equally to *note modules initialized during interpreter
     startup: 1406.  The one exception is ‘__main__’, where ‘__spec__’
     is *note set to None in some cases: 1407.

     When ‘__package__’ is not defined, ‘__spec__.parent’ is used as a
     fallback.

     New in version 3.4.

     Changed in version 3.6: ‘__spec__.parent’ is used as a fallback
     when ‘__package__’ is not defined.

 -- Attribute: __path__

     If the module is a package (either regular or namespace), the
     module object’s ‘__path__’ attribute must be set.  The value must
     be iterable, but may be empty if ‘__path__’ has no further
     significance.  If ‘__path__’ is not empty, it must produce strings
     when iterated over.  More details on the semantics of ‘__path__’
     are given *note below: 1408.

     Non-package modules should not have a ‘__path__’ attribute.

 -- Attribute: __file__

 -- Attribute: __cached__

     ‘__file__’ is optional.  If set, this attribute’s value must be a
     string.  The import system may opt to leave ‘__file__’ unset if it
     has no semantic meaning (e.g.  a module loaded from a database).

     If ‘__file__’ is set, it may also be appropriate to set the
     ‘__cached__’ attribute which is the path to any compiled version of
     the code (e.g.  byte-compiled file).  The file does not need to
     exist to set this attribute; the path can simply point to where the
     compiled file would exist (see PEP 3147(3)).

     It is also appropriate to set ‘__cached__’ when ‘__file__’ is not
     set.  However, that scenario is quite atypical.  Ultimately, the
     loader is what makes use of ‘__file__’ and/or ‘__cached__’.  So if
     a loader can load from a cached module but otherwise does not load
     from a file, that atypical scenario may be appropriate.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0366

   (2) https://www.python.org/dev/peps/pep-0366

   (3) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: module __path__,  Next: Module reprs,  Prev: Import-related module attributes,  Up: Loading

4.5.4.5 module.__path__
.......................

By definition, if a module has a ‘__path__’ attribute, it is a package.

A package’s ‘__path__’ attribute is used during imports of its
subpackages.  Within the import machinery, it functions much the same as
*note sys.path: 47d, i.e.  providing a list of locations to search for
modules during import.  However, ‘__path__’ is typically much more
constrained than *note sys.path: 47d.

‘__path__’ must be an iterable of strings, but it may be empty.  The
same rules used for *note sys.path: 47d. also apply to a package’s
‘__path__’, and *note sys.path_hooks: 950. (described below) are
consulted when traversing a package’s ‘__path__’.

A package’s ‘__init__.py’ file may set or alter the package’s ‘__path__’
attribute, and this was typically the way namespace packages were
implemented prior to PEP 420(1).  With the adoption of PEP 420(2),
namespace packages no longer need to supply ‘__init__.py’ files
containing only ‘__path__’ manipulation code; the import machinery
automatically sets ‘__path__’ correctly for the namespace package.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0420

   (2) https://www.python.org/dev/peps/pep-0420


File: python.info,  Node: Module reprs,  Next: Cached bytecode invalidation,  Prev: module __path__,  Up: Loading

4.5.4.6 Module reprs
....................

By default, all modules have a usable repr, however depending on the
attributes set above, and in the module’s spec, you can more explicitly
control the repr of module objects.

If the module has a spec (‘__spec__’), the import machinery will try to
generate a repr from it.  If that fails or there is no spec, the import
system will craft a default repr using whatever information is available
on the module.  It will try to use the ‘module.__name__’,
‘module.__file__’, and ‘module.__loader__’ as input into the repr, with
defaults for whatever information is missing.

Here are the exact rules used:

        * If the module has a ‘__spec__’ attribute, the information in
          the spec is used to generate the repr.  The “name”, “loader”,
          “origin”, and “has_location” attributes are consulted.

        * If the module has a ‘__file__’ attribute, this is used as part
          of the module’s repr.

        * If the module has no ‘__file__’ but does have a ‘__loader__’
          that is not ‘None’, then the loader’s repr is used as part of
          the module’s repr.

        * Otherwise, just use the module’s ‘__name__’ in the repr.

Changed in version 3.4: Use of *note loader.module_repr(): 935. has been
deprecated and the module spec is now used by the import machinery to
generate a module repr.

For backward compatibility with Python 3.3, the module repr will be
generated by calling the loader’s *note module_repr(): 935. method, if
defined, before trying either approach described above.  However, the
method is deprecated.


File: python.info,  Node: Cached bytecode invalidation,  Prev: Module reprs,  Up: Loading

4.5.4.7 Cached bytecode invalidation
....................................

Before Python loads cached bytecode from ‘.pyc’ file, it checks whether
the cache is up-to-date with the source ‘.py’ file.  By default, Python
does this by storing the source’s last-modified timestamp and size in
the cache file when writing it.  At runtime, the import system then
validates the cache file by checking the stored metadata in the cache
file against the source’s metadata.

Python also supports “hash-based” cache files, which store a hash of the
source file’s contents rather than its metadata.  There are two variants
of hash-based ‘.pyc’ files: checked and unchecked.  For checked
hash-based ‘.pyc’ files, Python validates the cache file by hashing the
source file and comparing the resulting hash with the hash in the cache
file.  If a checked hash-based cache file is found to be invalid, Python
regenerates it and writes a new checked hash-based cache file.  For
unchecked hash-based ‘.pyc’ files, Python simply assumes the cache file
is valid if it exists.  Hash-based ‘.pyc’ files validation behavior may
be overridden with the *note –check-hash-based-pycs: 127c. flag.

Changed in version 3.7: Added hash-based ‘.pyc’ files.  Previously,
Python only supported timestamp-based invalidation of bytecode caches.


File: python.info,  Node: The Path Based Finder,  Next: Replacing the standard import system,  Prev: Loading,  Up: The import system

4.5.5 The Path Based Finder
---------------------------

As mentioned previously, Python comes with several default meta path
finders.  One of these, called the *note path based finder: 13fd. (*note
PathFinder: 94f.), searches an *note import path: 13fa, which contains a
list of *note path entries: 140d.  Each path entry names a location to
search for modules.

The path based finder itself doesn’t know how to import anything.
Instead, it traverses the individual path entries, associating each of
them with a path entry finder that knows how to handle that particular
kind of path.

The default set of path entry finders implement all the semantics for
finding modules on the file system, handling special file types such as
Python source code (‘.py’ files), Python byte code (‘.pyc’ files) and
shared libraries (e.g.  ‘.so’ files).  When supported by the *note
zipimport: 143. module in the standard library, the default path entry
finders also handle loading all of these file types (other than shared
libraries) from zipfiles.

Path entries need not be limited to file system locations.  They can
refer to URLs, database queries, or any other location that can be
specified as a string.

The path based finder provides additional hooks and protocols so that
you can extend and customize the types of searchable path entries.  For
example, if you wanted to support path entries as network URLs, you
could write a hook that implements HTTP semantics to find modules on the
web.  This hook (a callable) would return a *note path entry finder:
9a6. supporting the protocol described below, which was then used to get
a loader for the module from the web.

A word of warning: this section and the previous both use the term
`finder', distinguishing between them by using the terms *note meta path
finder: 9a5. and *note path entry finder: 9a6.  These two types of
finders are very similar, support similar protocols, and function in
similar ways during the import process, but it’s important to keep in
mind that they are subtly different.  In particular, meta path finders
operate at the beginning of the import process, as keyed off the *note
sys.meta_path: 5db. traversal.

By contrast, path entry finders are in a sense an implementation detail
of the path based finder, and in fact, if the path based finder were to
be removed from *note sys.meta_path: 5db, none of the path entry finder
semantics would be invoked.

* Menu:

* Path entry finders::
* Path entry finder protocol::


File: python.info,  Node: Path entry finders,  Next: Path entry finder protocol,  Up: The Path Based Finder

4.5.5.1 Path entry finders
..........................

The *note path based finder: 13fd. is responsible for finding and
loading Python modules and packages whose location is specified with a
string *note path entry: 140d.  Most path entries name locations in the
file system, but they need not be limited to this.

As a meta path finder, the *note path based finder: 13fd. implements the
*note find_spec(): 458. protocol previously described, however it
exposes additional hooks that can be used to customize how modules are
found and loaded from the *note import path: 13fa.

Three variables are used by the *note path based finder: 13fd, *note
sys.path: 47d, *note sys.path_hooks: 950. and *note
sys.path_importer_cache: 493.  The ‘__path__’ attributes on package
objects are also used.  These provide additional ways that the import
machinery can be customized.

*note sys.path: 47d. contains a list of strings providing search
locations for modules and packages.  It is initialized from the
‘PYTHONPATH’ environment variable and various other installation- and
implementation-specific defaults.  Entries in *note sys.path: 47d. can
name directories on the file system, zip files, and potentially other
“locations” (see the *note site: eb. module) that should be searched for
modules, such as URLs, or database queries.  Only strings and bytes
should be present on *note sys.path: 47d.; all other data types are
ignored.  The encoding of bytes entries is determined by the individual
*note path entry finders: 9a6.

The *note path based finder: 13fd. is a *note meta path finder: 9a5, so
the import machinery begins the *note import path: 13fa. search by
calling the path based finder’s *note find_spec(): 92e. method as
described previously.  When the ‘path’ argument to *note find_spec():
92e. is given, it will be a list of string paths to traverse - typically
a package’s ‘__path__’ attribute for an import within that package.  If
the ‘path’ argument is ‘None’, this indicates a top level import and
*note sys.path: 47d. is used.

The path based finder iterates over every entry in the search path, and
for each of these, looks for an appropriate *note path entry finder:
9a6. (*note PathEntryFinder: 9a8.) for the path entry.  Because this can
be an expensive operation (e.g.  there may be ‘stat()’ call overheads
for this search), the path based finder maintains a cache mapping path
entries to path entry finders.  This cache is maintained in *note
sys.path_importer_cache: 493. (despite the name, this cache actually
stores finder objects rather than being limited to *note importer: 13f9.
objects).  In this way, the expensive search for a particular *note path
entry: 140d. location’s *note path entry finder: 9a6. need only be done
once.  User code is free to remove cache entries from *note
sys.path_importer_cache: 493. forcing the path based finder to perform
the path entry search again (1).

If the path entry is not present in the cache, the path based finder
iterates over every callable in *note sys.path_hooks: 950.  Each of the
*note path entry hooks: 140f. in this list is called with a single
argument, the path entry to be searched.  This callable may either
return a *note path entry finder: 9a6. that can handle the path entry,
or it may raise *note ImportError: 329.  An *note ImportError: 329. is
used by the path based finder to signal that the hook cannot find a
*note path entry finder: 9a6. for that *note path entry: 140d.  The
exception is ignored and *note import path: 13fa. iteration continues.
The hook should expect either a string or bytes object; the encoding of
bytes objects is up to the hook (e.g.  it may be a file system encoding,
UTF-8, or something else), and if the hook cannot decode the argument,
it should raise *note ImportError: 329.

If *note sys.path_hooks: 950. iteration ends with no *note path entry
finder: 9a6. being returned, then the path based finder’s *note
find_spec(): 92e. method will store ‘None’ in *note
sys.path_importer_cache: 493. (to indicate that there is no finder for
this path entry) and return ‘None’, indicating that this *note meta path
finder: 9a5. could not find the module.

If a *note path entry finder: 9a6. `is' returned by one of the *note
path entry hook: 140f. callables on *note sys.path_hooks: 950, then the
following protocol is used to ask the finder for a module spec, which is
then used when loading the module.

The current working directory – denoted by an empty string – is handled
slightly differently from other entries on *note sys.path: 47d.  First,
if the current working directory is found to not exist, no value is
stored in *note sys.path_importer_cache: 493.  Second, the value for the
current working directory is looked up fresh for each module lookup.
Third, the path used for *note sys.path_importer_cache: 493. and
returned by *note importlib.machinery.PathFinder.find_spec(): 92e. will
be the actual current working directory and not the empty string.

   ---------- Footnotes ----------

   (1) (3) In legacy code, it is possible to find instances of *note
imp.NullImporter: 9af. in the *note sys.path_importer_cache: 493.  It is
recommended that code be changed to use ‘None’ instead.  See *note
Porting Python code: b05. for more details.


File: python.info,  Node: Path entry finder protocol,  Prev: Path entry finders,  Up: The Path Based Finder

4.5.5.2 Path entry finder protocol
..................................

In order to support imports of modules and initialized packages and also
to contribute portions to namespace packages, path entry finders must
implement the *note find_spec(): 45a. method.

*note find_spec(): 45a. takes two arguments: the fully qualified name of
the module being imported, and the (optional) target module.
‘find_spec()’ returns a fully populated spec for the module.  This spec
will always have “loader” set (with one exception).

To indicate to the import machinery that the spec represents a namespace
*note portion: 13f3.  the path entry finder sets “loader” on the spec to
‘None’ and “submodule_search_locations” to a list containing the
portion.

Changed in version 3.4: *note find_spec(): 45a. replaced *note
find_loader(): 459. and *note find_module(): 92f, both of which are now
deprecated, but will be used if ‘find_spec()’ is not defined.

Older path entry finders may implement one of these two deprecated
methods instead of ‘find_spec()’.  The methods are still respected for
the sake of backward compatibility.  However, if ‘find_spec()’ is
implemented on the path entry finder, the legacy methods are ignored.

*note find_loader(): 459. takes one argument, the fully qualified name
of the module being imported.  ‘find_loader()’ returns a 2-tuple where
the first item is the loader and the second item is a namespace *note
portion: 13f3.  When the first item (i.e.  the loader) is ‘None’, this
means that while the path entry finder does not have a loader for the
named module, it knows that the path entry contributes to a namespace
portion for the named module.  This will almost always be the case where
Python is asked to import a namespace package that has no physical
presence on the file system.  When a path entry finder returns ‘None’
for the loader, the second item of the 2-tuple return value must be a
sequence, although it can be empty.

If ‘find_loader()’ returns a non-‘None’ loader value, the portion is
ignored and the loader is returned from the path based finder,
terminating the search through the path entries.

For backwards compatibility with other implementations of the import
protocol, many path entry finders also support the same, traditional
‘find_module()’ method that meta path finders support.  However path
entry finder ‘find_module()’ methods are never called with a ‘path’
argument (they are expected to record the appropriate path information
from the initial call to the path hook).

The ‘find_module()’ method on path entry finders is deprecated, as it
does not allow the path entry finder to contribute portions to namespace
packages.  If both ‘find_loader()’ and ‘find_module()’ exist on a path
entry finder, the import system will always call ‘find_loader()’ in
preference to ‘find_module()’.


File: python.info,  Node: Replacing the standard import system,  Next: Package Relative Imports,  Prev: The Path Based Finder,  Up: The import system

4.5.6 Replacing the standard import system
------------------------------------------

The most reliable mechanism for replacing the entire import system is to
delete the default contents of *note sys.meta_path: 5db, replacing them
entirely with a custom meta path hook.

If it is acceptable to only alter the behaviour of import statements
without affecting other APIs that access the import system, then
replacing the builtin *note __import__(): 605. function may be
sufficient.  This technique may also be employed at the module level to
only alter the behaviour of import statements within that module.

To selectively prevent the import of some modules from a hook early on
the meta path (rather than disabling the standard import system
entirely), it is sufficient to raise *note ModuleNotFoundError: 38f.
directly from *note find_spec(): 458. instead of returning ‘None’.  The
latter indicates that the meta path search should continue, while
raising an exception terminates it immediately.


File: python.info,  Node: Package Relative Imports,  Next: Special considerations for __main__,  Prev: Replacing the standard import system,  Up: The import system

4.5.7 Package Relative Imports
------------------------------

Relative imports use leading dots.  A single leading dot indicates a
relative import, starting with the current package.  Two or more leading
dots indicate a relative import to the parent(s) of the current package,
one level per dot after the first.  For example, given the following
package layout:

     package/
         __init__.py
         subpackage1/
             __init__.py
             moduleX.py
             moduleY.py
         subpackage2/
             __init__.py
             moduleZ.py
         moduleA.py

In either ‘subpackage1/moduleX.py’ or ‘subpackage1/__init__.py’, the
following are valid relative imports:

     from .moduleY import spam
     from .moduleY import spam as ham
     from . import moduleY
     from ..subpackage1 import moduleY
     from ..subpackage2.moduleZ import eggs
     from ..moduleA import foo

Absolute imports may use either the ‘import <>’ or ‘from <> import <>’
syntax, but relative imports may only use the second form; the reason
for this is that:

     import XXX.YYY.ZZZ

should expose ‘XXX.YYY.ZZZ’ as a usable expression, but .moduleY is not
a valid expression.


File: python.info,  Node: Special considerations for __main__,  Next: Open issues,  Prev: Package Relative Imports,  Up: The import system

4.5.8 Special considerations for __main__
-----------------------------------------

The *note __main__: 1. module is a special case relative to Python’s
import system.  As noted *note elsewhere: 1406, the ‘__main__’ module is
directly initialized at interpreter startup, much like *note sys: fd.
and *note builtins: 13.  However, unlike those two, it doesn’t strictly
qualify as a built-in module.  This is because the manner in which
‘__main__’ is initialized depends on the flags and other options with
which the interpreter is invoked.

* Menu:

* __main__.__spec__: __main__ __spec__.


File: python.info,  Node: __main__ __spec__,  Up: Special considerations for __main__

4.5.8.1 __main__.__spec__
.........................

Depending on how *note __main__: 1. is initialized, ‘__main__.__spec__’
gets set appropriately or to ‘None’.

When Python is started with the *note -m: 32c. option, ‘__spec__’ is set
to the module spec of the corresponding module or package.  ‘__spec__’
is also populated when the ‘__main__’ module is loaded as part of
executing a directory, zipfile or other *note sys.path: 47d. entry.

In *note the remaining cases: 1274. ‘__main__.__spec__’ is set to
‘None’, as the code used to populate the *note __main__: 1. does not
correspond directly with an importable module:

   - interactive prompt

   - *note -c: 1145. option

   - running from stdin

   - running directly from a source or bytecode file

Note that ‘__main__.__spec__’ is always ‘None’ in the last case, `even
if' the file could technically be imported directly as a module instead.
Use the *note -m: 32c. switch if valid module metadata is desired in
*note __main__: 1.

Note also that even when ‘__main__’ corresponds with an importable
module and ‘__main__.__spec__’ is set accordingly, they’re still
considered `distinct' modules.  This is due to the fact that blocks
guarded by ‘if __name__ == "__main__":’ checks only execute when the
module is used to populate the ‘__main__’ namespace, and not during
normal import.


File: python.info,  Node: Open issues,  Next: References,  Prev: Special considerations for __main__,  Up: The import system

4.5.9 Open issues
-----------------

XXX It would be really nice to have a diagram.

XXX * (import_machinery.rst) how about a section devoted just to the
attributes of modules and packages, perhaps expanding upon or
supplanting the related entries in the data model reference page?

XXX runpy, pkgutil, et al in the library manual should all get “See
Also” links at the top pointing to the new import system section.

XXX Add more explanation regarding the different ways in which
‘__main__’ is initialized?

XXX Add more info on ‘__main__’ quirks/pitfalls (i.e.  copy from PEP
395(1)).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0395


File: python.info,  Node: References,  Prev: Open issues,  Up: The import system

4.5.10 References
-----------------

The import machinery has evolved considerably since Python’s early days.
The original specification for packages(1) is still available to read,
although some details have changed since the writing of that document.

The original specification for *note sys.meta_path: 5db. was PEP 302(2),
with subsequent extension in PEP 420(3).

PEP 420(4) introduced *note namespace packages: 13f1. for Python 3.3.
PEP 420(5) also introduced the ‘find_loader()’ protocol as an
alternative to ‘find_module()’.

PEP 366(6) describes the addition of the ‘__package__’ attribute for
explicit relative imports in main modules.

PEP 328(7) introduced absolute and explicit relative imports and
initially proposed ‘__name__’ for semantics PEP 366(8) would eventually
specify for ‘__package__’.

PEP 338(9) defines executing modules as scripts.

PEP 451(10) adds the encapsulation of per-module import state in spec
objects.  It also off-loads most of the boilerplate responsibilities of
loaders back onto the import machinery.  These changes allow the
deprecation of several APIs in the import system and also addition of
new methods to finders and loaders.

   ---------- Footnotes ----------

   (1) https://www.python.org/doc/essays/packages/

   (2) https://www.python.org/dev/peps/pep-0302

   (3) https://www.python.org/dev/peps/pep-0420

   (4) https://www.python.org/dev/peps/pep-0420

   (5) https://www.python.org/dev/peps/pep-0420

   (6) https://www.python.org/dev/peps/pep-0366

   (7) https://www.python.org/dev/peps/pep-0328

   (8) https://www.python.org/dev/peps/pep-0366

   (9) https://www.python.org/dev/peps/pep-0338

   (10) https://www.python.org/dev/peps/pep-0451


File: python.info,  Node: Expressions,  Next: Simple statements,  Prev: The import system,  Up: The Python Language Reference

4.6 Expressions
===============

This chapter explains the meaning of the elements of expressions in
Python.

`Syntax Notes:' In this and the following chapters, extended BNF
notation will be used to describe syntax, not lexical analysis.  When
(one alternative of) a syntax rule has the form

     name ::= othername

and no semantics are given, the semantics of this form of ‘name’ are the
same as for ‘othername’.

* Menu:

* Arithmetic conversions::
* Atoms::
* Primaries::
* Await expression::
* The power operator::
* Unary arithmetic and bitwise operations::
* Binary arithmetic operations::
* Shifting operations::
* Binary bitwise operations::
* Comparisons::
* Boolean operations::
* Conditional expressions::
* Lambdas::
* Expression lists::
* Evaluation order::
* Operator precedence::


File: python.info,  Node: Arithmetic conversions,  Next: Atoms,  Up: Expressions

4.6.1 Arithmetic conversions
----------------------------

When a description of an arithmetic operator below uses the phrase “the
numeric arguments are converted to a common type,” this means that the
operator implementation for built-in types works as follows:

   * If either argument is a complex number, the other is converted to
     complex;

   * otherwise, if either argument is a floating point number, the other
     is converted to floating point;

   * otherwise, both must be integers and no conversion is necessary.

Some additional rules apply for certain operators (e.g., a string as a
left argument to the ‘%’ operator).  Extensions must define their own
conversion behavior.


File: python.info,  Node: Atoms,  Next: Primaries,  Prev: Arithmetic conversions,  Up: Expressions

4.6.2 Atoms
-----------

Atoms are the most basic elements of expressions.  The simplest atoms
are identifiers or literals.  Forms enclosed in parentheses, brackets or
braces are also categorized syntactically as atoms.  The syntax for
atoms is:

     atom      ::= identifier | literal | enclosure
     enclosure ::= parenth_form | list_display | dict_display | set_display
                   | generator_expression | yield_atom

* Menu:

* Identifiers (Names): Identifiers Names.
* Literals: Literals<2>.
* Parenthesized forms::
* Displays for lists, sets and dictionaries: Displays for lists sets and dictionaries.
* List displays::
* Set displays::
* Dictionary displays::
* Generator expressions::
* Yield expressions::


File: python.info,  Node: Identifiers Names,  Next: Literals<2>,  Up: Atoms

4.6.2.1 Identifiers (Names)
...........................

An identifier occurring as an atom is a name.  See section *note
Identifiers and keywords: 130d. for lexical definition and section *note
Naming and binding: 13db. for documentation of naming and binding.

When the name is bound to an object, evaluation of the atom yields that
object.  When a name is not bound, an attempt to evaluate it raises a
*note NameError: d6e. exception.

`Private name mangling:' When an identifier that textually occurs in a
class definition begins with two or more underscore characters and does
not end in two or more underscores, it is considered a `private name' of
that class.  Private names are transformed to a longer form before code
is generated for them.  The transformation inserts the class name, with
leading underscores removed and a single underscore inserted, in front
of the name.  For example, the identifier ‘__spam’ occurring in a class
named ‘Ham’ will be transformed to ‘_Ham__spam’.  This transformation is
independent of the syntactical context in which the identifier is used.
If the transformed name is extremely long (longer than 255 characters),
implementation defined truncation may happen.  If the class name
consists only of underscores, no transformation is done.


File: python.info,  Node: Literals<2>,  Next: Parenthesized forms,  Prev: Identifiers Names,  Up: Atoms

4.6.2.2 Literals
................

Python supports string and bytes literals and various numeric literals:

     literal ::= stringliteral | bytesliteral
                 | integer | floatnumber | imagnumber

Evaluation of a literal yields an object of the given type (string,
bytes, integer, floating point number, complex number) with the given
value.  The value may be approximated in the case of floating point and
imaginary (complex) literals.  See section *note Literals: 131a. for
details.

All literals correspond to immutable data types, and hence the object’s
identity is less important than its value.  Multiple evaluations of
literals with the same value (either the same occurrence in the program
text or a different occurrence) may obtain the same object or a
different object with the same value.


File: python.info,  Node: Parenthesized forms,  Next: Displays for lists sets and dictionaries,  Prev: Literals<2>,  Up: Atoms

4.6.2.3 Parenthesized forms
...........................

A parenthesized form is an optional expression list enclosed in
parentheses:

     parenth_form ::= "(" [starred_expression] ")"

A parenthesized expression list yields whatever that expression list
yields: if the list contains at least one comma, it yields a tuple;
otherwise, it yields the single expression that makes up the expression
list.

An empty pair of parentheses yields an empty tuple object.  Since tuples
are immutable, the same rules as for literals apply (i.e., two
occurrences of the empty tuple may or may not yield the same object).

Note that tuples are not formed by the parentheses, but rather by use of
the comma operator.  The exception is the empty tuple, for which
parentheses `are' required — allowing unparenthesized “nothing” in
expressions would cause ambiguities and allow common typos to pass
uncaught.


File: python.info,  Node: Displays for lists sets and dictionaries,  Next: List displays,  Prev: Parenthesized forms,  Up: Atoms

4.6.2.4 Displays for lists, sets and dictionaries
.................................................

For constructing a list, a set or a dictionary Python provides special
syntax called “displays”, each of them in two flavors:

   * either the container contents are listed explicitly, or

   * they are computed via a set of looping and filtering instructions,
     called a `comprehension'.

Common syntax elements for comprehensions are:

     comprehension ::= expression comp_for
     comp_for      ::= ["async"] "for" target_list "in" or_test [comp_iter]
     comp_iter     ::= comp_for | comp_if
     comp_if       ::= "if" expression_nocond [comp_iter]

The comprehension consists of a single expression followed by at least
one ‘for’ clause and zero or more ‘for’ or ‘if’ clauses.  In this case,
the elements of the new container are those that would be produced by
considering each of the ‘for’ or ‘if’ clauses a block, nesting from left
to right, and evaluating the expression to produce an element each time
the innermost block is reached.

However, aside from the iterable expression in the leftmost ‘for’
clause, the comprehension is executed in a separate implicitly nested
scope.  This ensures that names assigned to in the target list don’t
“leak” into the enclosing scope.

The iterable expression in the leftmost ‘for’ clause is evaluated
directly in the enclosing scope and then passed as an argument to the
implicitly nested scope.  Subsequent ‘for’ clauses and any filter
condition in the leftmost ‘for’ clause cannot be evaluated in the
enclosing scope as they may depend on the values obtained from the
leftmost iterable.  For example: ‘[x*y for x in range(10) for y in
range(x, x+10)]’.

To ensure the comprehension always results in a container of the
appropriate type, ‘yield’ and ‘yield from’ expressions are prohibited in
the implicitly nested scope.

Since Python 3.6, in an *note async def: 282. function, an ‘async for’
clause may be used to iterate over a *note asynchronous iterator: 639.
A comprehension in an ‘async def’ function may consist of either a ‘for’
or ‘async for’ clause following the leading expression, may contain
additional ‘for’ or ‘async for’ clauses, and may also use *note await:
1a2. expressions.  If a comprehension contains either ‘async for’
clauses or ‘await’ expressions it is called an `asynchronous
comprehension'.  An asynchronous comprehension may suspend the execution
of the coroutine function in which it appears.  See also PEP 530(1).

New in version 3.6: Asynchronous comprehensions were introduced.

Changed in version 3.8: ‘yield’ and ‘yield from’ prohibited in the
implicitly nested scope.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0530


File: python.info,  Node: List displays,  Next: Set displays,  Prev: Displays for lists sets and dictionaries,  Up: Atoms

4.6.2.5 List displays
.....................

A list display is a possibly empty series of expressions enclosed in
square brackets:

     list_display ::= "[" [starred_list | comprehension] "]"

A list display yields a new list object, the contents being specified by
either a list of expressions or a comprehension.  When a comma-separated
list of expressions is supplied, its elements are evaluated from left to
right and placed into the list object in that order.  When a
comprehension is supplied, the list is constructed from the elements
resulting from the comprehension.


File: python.info,  Node: Set displays,  Next: Dictionary displays,  Prev: List displays,  Up: Atoms

4.6.2.6 Set displays
....................

A set display is denoted by curly braces and distinguishable from
dictionary displays by the lack of colons separating keys and values:

     set_display ::= "{" (starred_list | comprehension) "}"

A set display yields a new mutable set object, the contents being
specified by either a sequence of expressions or a comprehension.  When
a comma-separated list of expressions is supplied, its elements are
evaluated from left to right and added to the set object.  When a
comprehension is supplied, the set is constructed from the elements
resulting from the comprehension.

An empty set cannot be constructed with ‘{}’; this literal constructs an
empty dictionary.


File: python.info,  Node: Dictionary displays,  Next: Generator expressions,  Prev: Set displays,  Up: Atoms

4.6.2.7 Dictionary displays
...........................

A dictionary display is a possibly empty series of key/datum pairs
enclosed in curly braces:

     dict_display       ::= "{" [key_datum_list | dict_comprehension] "}"
     key_datum_list     ::= key_datum ("," key_datum)* [","]
     key_datum          ::= expression ":" expression | "**" or_expr
     dict_comprehension ::= expression ":" expression comp_for

A dictionary display yields a new dictionary object.

If a comma-separated sequence of key/datum pairs is given, they are
evaluated from left to right to define the entries of the dictionary:
each key object is used as a key into the dictionary to store the
corresponding datum.  This means that you can specify the same key
multiple times in the key/datum list, and the final dictionary’s value
for that key will be the last one given.

A double asterisk ‘**’ denotes `dictionary unpacking'.  Its operand must
be a *note mapping: b2c.  Each mapping item is added to the new
dictionary.  Later values replace values already set by earlier
key/datum pairs and earlier dictionary unpackings.

New in version 3.5: Unpacking into dictionary displays, originally
proposed by PEP 448(1).

A dict comprehension, in contrast to list and set comprehensions, needs
two expressions separated with a colon followed by the usual “for” and
“if” clauses.  When the comprehension is run, the resulting key and
value elements are inserted in the new dictionary in the order they are
produced.

Restrictions on the types of the key values are listed earlier in
section *note The standard type hierarchy: 135c.  (To summarize, the key
type should be *note hashable: 1364, which excludes all mutable
objects.)  Clashes between duplicate keys are not detected; the last
datum (textually rightmost in the display) stored for a given key value
prevails.

Changed in version 3.8: Prior to Python 3.8, in dict comprehensions, the
evaluation order of key and value was not well-defined.  In CPython, the
value was evaluated before the key.  Starting with 3.8, the key is
evaluated before the value, as proposed by PEP 572(2).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0448

   (2) https://www.python.org/dev/peps/pep-0572


File: python.info,  Node: Generator expressions,  Next: Yield expressions,  Prev: Dictionary displays,  Up: Atoms

4.6.2.8 Generator expressions
.............................

A generator expression is a compact generator notation in parentheses:

     generator_expression ::= "(" expression comp_for ")"

A generator expression yields a new generator object.  Its syntax is the
same as for comprehensions, except that it is enclosed in parentheses
instead of brackets or curly braces.

Variables used in the generator expression are evaluated lazily when the
*note __next__(): 1213. method is called for the generator object (in
the same fashion as normal generators).  However, the iterable
expression in the leftmost ‘for’ clause is immediately evaluated, so
that an error produced by it will be emitted at the point where the
generator expression is defined, rather than at the point where the
first value is retrieved.  Subsequent ‘for’ clauses and any filter
condition in the leftmost ‘for’ clause cannot be evaluated in the
enclosing scope as they may depend on the values obtained from the
leftmost iterable.  For example: ‘(x*y for x in range(10) for y in
range(x, x+10))’.

The parentheses can be omitted on calls with only one argument.  See
section *note Calls: 640. for details.

To avoid interfering with the expected operation of the generator
expression itself, ‘yield’ and ‘yield from’ expressions are prohibited
in the implicitly defined generator.

If a generator expression contains either ‘async for’ clauses or *note
await: 1a2. expressions it is called an `asynchronous generator
expression'.  An asynchronous generator expression returns a new
asynchronous generator object, which is an asynchronous iterator (see
*note Asynchronous Iterators: 63a.).

New in version 3.6: Asynchronous generator expressions were introduced.

Changed in version 3.7: Prior to Python 3.7, asynchronous generator
expressions could only appear in *note async def: 282. coroutines.
Starting with 3.7, any function can use asynchronous generator
expressions.

Changed in version 3.8: ‘yield’ and ‘yield from’ prohibited in the
implicitly nested scope.


File: python.info,  Node: Yield expressions,  Prev: Generator expressions,  Up: Atoms

4.6.2.9 Yield expressions
.........................

     yield_atom       ::= "(" yield_expression ")"
     yield_expression ::= "yield" [expression_list | "from" expression]

The yield expression is used when defining a *note generator: 996.
function or an *note asynchronous generator: 1441. function and thus can
only be used in the body of a function definition.  Using a yield
expression in a function’s body causes that function to be a generator,
and using it in an *note async def: 282. function’s body causes that
coroutine function to be an asynchronous generator.  For example:

     def gen():  # defines a generator function
         yield 123

     async def agen(): # defines an asynchronous generator function
         yield 123

Due to their side effects on the containing scope, ‘yield’ expressions
are not permitted as part of the implicitly defined scopes used to
implement comprehensions and generator expressions.

Changed in version 3.8: Yield expressions prohibited in the implicitly
nested scopes used to implement comprehensions and generator
expressions.

Generator functions are described below, while asynchronous generator
functions are described separately in section *note Asynchronous
generator functions: 1442.

When a generator function is called, it returns an iterator known as a
generator.  That generator then controls the execution of the generator
function.  The execution starts when one of the generator’s methods is
called.  At that time, the execution proceeds to the first yield
expression, where it is suspended again, returning the value of *note
expression_list: 1443. to the generator’s caller.  By suspended, we mean
that all local state is retained, including the current bindings of
local variables, the instruction pointer, the internal evaluation stack,
and the state of any exception handling.  When the execution is resumed
by calling one of the generator’s methods, the function can proceed
exactly as if the yield expression were just another external call.  The
value of the yield expression after resuming depends on the method which
resumed the execution.  If *note __next__(): 1213. is used (typically
via either a *note for: c23. or the *note next(): 676. builtin) then the
result is *note None: 157.  Otherwise, if *note send(): 13cb. is used,
then the result will be the value passed in to that method.

All of this makes generator functions quite similar to coroutines; they
yield multiple times, they have more than one entry point and their
execution can be suspended.  The only difference is that a generator
function cannot control where the execution should continue after it
yields; the control is always transferred to the generator’s caller.

Yield expressions are allowed anywhere in a *note try: d65. construct.
If the generator is not resumed before it is finalized (by reaching a
zero reference count or by being garbage collected), the
generator-iterator’s *note close(): 13cf. method will be called,
allowing any pending *note finally: 182. clauses to execute.

When ‘yield from <expr>’ is used, it treats the supplied expression as a
subiterator.  All values produced by that subiterator are passed
directly to the caller of the current generator’s methods.  Any values
passed in with *note send(): 13cb. and any exceptions passed in with
*note throw(): 13cd. are passed to the underlying iterator if it has the
appropriate methods.  If this is not the case, then *note send(): 13cb.
will raise *note AttributeError: 390. or *note TypeError: 192, while
*note throw(): 13cd. will just raise the passed in exception
immediately.

When the underlying iterator is complete, the ‘value’ attribute of the
raised *note StopIteration: 47b. instance becomes the value of the yield
expression.  It can be either set explicitly when raising *note
StopIteration: 47b, or automatically when the subiterator is a generator
(by returning a value from the subgenerator).

     Changed in version 3.3: Added ‘yield from <expr>’ to delegate
     control flow to a subiterator.

The parentheses may be omitted when the yield expression is the sole
expression on the right hand side of an assignment statement.

See also
........

PEP 255(1) - Simple Generators

     The proposal for adding generators and the *note yield: 18f.
     statement to Python.

PEP 342(2) - Coroutines via Enhanced Generators

     The proposal to enhance the API and syntax of generators, making
     them usable as simple coroutines.

PEP 380(3) - Syntax for Delegating to a Subgenerator

     The proposal to introduce the ‘yield_from’ syntax, making
     delegation to subgenerators easy.

PEP 525(4) - Asynchronous Generators

     The proposal that expanded on PEP 492(5) by adding generator
     capabilities to coroutine functions.

* Menu:

* Generator-iterator methods::
* Examples::
* Asynchronous generator functions::
* Asynchronous generator-iterator methods::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0255

   (2) https://www.python.org/dev/peps/pep-0342

   (3) https://www.python.org/dev/peps/pep-0380

   (4) https://www.python.org/dev/peps/pep-0525

   (5) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: Generator-iterator methods,  Next: Examples,  Up: Yield expressions

4.6.2.10 Generator-iterator methods
...................................

This subsection describes the methods of a generator iterator.  They can
be used to control the execution of a generator function.

Note that calling any of the generator methods below when the generator
is already executing raises a *note ValueError: 1f9. exception.

 -- Method: generator.__next__ ()

     Starts the execution of a generator function or resumes it at the
     last executed yield expression.  When a generator function is
     resumed with a *note __next__(): 1213. method, the current yield
     expression always evaluates to *note None: 157.  The execution then
     continues to the next yield expression, where the generator is
     suspended again, and the value of the *note expression_list: 1443.
     is returned to *note __next__(): 1213.’s caller.  If the generator
     exits without yielding another value, a *note StopIteration: 47b.
     exception is raised.

     This method is normally called implicitly, e.g.  by a *note for:
     c23. loop, or by the built-in *note next(): 676. function.

 -- Method: generator.send (value)

     Resumes the execution and “sends” a value into the generator
     function.  The `value' argument becomes the result of the current
     yield expression.  The *note send(): 13cb. method returns the next
     value yielded by the generator, or raises *note StopIteration: 47b.
     if the generator exits without yielding another value.  When *note
     send(): 13cb. is called to start the generator, it must be called
     with *note None: 157. as the argument, because there is no yield
     expression that could receive the value.

 -- Method: generator.throw (type[, value[, traceback]])

     Raises an exception of type ‘type’ at the point where the generator
     was paused, and returns the next value yielded by the generator
     function.  If the generator exits without yielding another value, a
     *note StopIteration: 47b. exception is raised.  If the generator
     function does not catch the passed-in exception, or raises a
     different exception, then that exception propagates to the caller.

 -- Method: generator.close ()

     Raises a *note GeneratorExit: d25. at the point where the generator
     function was paused.  If the generator function then exits
     gracefully, is already closed, or raises *note GeneratorExit: d25.
     (by not catching the exception), close returns to its caller.  If
     the generator yields a value, a *note RuntimeError: 2b8. is raised.
     If the generator raises any other exception, it is propagated to
     the caller.  *note close(): 13cf. does nothing if the generator has
     already exited due to an exception or normal exit.


File: python.info,  Node: Examples,  Next: Asynchronous generator functions,  Prev: Generator-iterator methods,  Up: Yield expressions

4.6.2.11 Examples
.................

Here is a simple example that demonstrates the behavior of generators
and generator functions:

     >>> def echo(value=None):
     ...     print("Execution starts when 'next()' is called for the first time.")
     ...     try:
     ...         while True:
     ...             try:
     ...                 value = (yield value)
     ...             except Exception as e:
     ...                 value = e
     ...     finally:
     ...         print("Don't forget to clean up when 'close()' is called.")
     ...
     >>> generator = echo(1)
     >>> print(next(generator))
     Execution starts when 'next()' is called for the first time.
     1
     >>> print(next(generator))
     None
     >>> print(generator.send(2))
     2
     >>> generator.throw(TypeError, "spam")
     TypeError('spam',)
     >>> generator.close()
     Don't forget to clean up when 'close()' is called.

For examples using ‘yield from’, see *note PEP 380; Syntax for
Delegating to a Subgenerator: 96c. in “What’s New in Python.”


File: python.info,  Node: Asynchronous generator functions,  Next: Asynchronous generator-iterator methods,  Prev: Examples,  Up: Yield expressions

4.6.2.12 Asynchronous generator functions
.........................................

The presence of a yield expression in a function or method defined using
*note async def: 282. further defines the function as an *note
asynchronous generator: 1441. function.

When an asynchronous generator function is called, it returns an
asynchronous iterator known as an asynchronous generator object.  That
object then controls the execution of the generator function.  An
asynchronous generator object is typically used in an *note async for:
2e1. statement in a coroutine function analogously to how a generator
object would be used in a *note for: c23. statement.

Calling one of the asynchronous generator’s methods returns an *note
awaitable: 50e. object, and the execution starts when this object is
awaited on.  At that time, the execution proceeds to the first yield
expression, where it is suspended again, returning the value of *note
expression_list: 1443. to the awaiting coroutine.  As with a generator,
suspension means that all local state is retained, including the current
bindings of local variables, the instruction pointer, the internal
evaluation stack, and the state of any exception handling.  When the
execution is resumed by awaiting on the next object returned by the
asynchronous generator’s methods, the function can proceed exactly as if
the yield expression were just another external call.  The value of the
yield expression after resuming depends on the method which resumed the
execution.  If *note __anext__(): 1447. is used then the result is *note
None: 157.  Otherwise, if *note asend(): 1448. is used, then the result
will be the value passed in to that method.

In an asynchronous generator function, yield expressions are allowed
anywhere in a *note try: d65. construct.  However, if an asynchronous
generator is not resumed before it is finalized (by reaching a zero
reference count or by being garbage collected), then a yield expression
within a ‘try’ construct could result in a failure to execute pending
*note finally: 182. clauses.  In this case, it is the responsibility of
the event loop or scheduler running the asynchronous generator to call
the asynchronous generator-iterator’s *note aclose(): 1449. method and
run the resulting coroutine object, thus allowing any pending ‘finally’
clauses to execute.

To take care of finalization, an event loop should define a `finalizer'
function which takes an asynchronous generator-iterator and presumably
calls *note aclose(): 1449. and executes the coroutine.  This
`finalizer' may be registered by calling *note sys.set_asyncgen_hooks():
144a.  When first iterated over, an asynchronous generator-iterator will
store the registered `finalizer' to be called upon finalization.  For a
reference example of a `finalizer' method see the implementation of
‘asyncio.Loop.shutdown_asyncgens’ in Lib/asyncio/base_events.py(1).

The expression ‘yield from <expr>’ is a syntax error when used in an
asynchronous generator function.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/base_events.py


File: python.info,  Node: Asynchronous generator-iterator methods,  Prev: Asynchronous generator functions,  Up: Yield expressions

4.6.2.13 Asynchronous generator-iterator methods
................................................

This subsection describes the methods of an asynchronous generator
iterator, which are used to control the execution of a generator
function.

 -- Method: coroutine agen.__anext__ ()

     Returns an awaitable which when run starts to execute the
     asynchronous generator or resumes it at the last executed yield
     expression.  When an asynchronous generator function is resumed
     with an *note __anext__(): 1447. method, the current yield
     expression always evaluates to *note None: 157. in the returned
     awaitable, which when run will continue to the next yield
     expression.  The value of the *note expression_list: 1443. of the
     yield expression is the value of the *note StopIteration: 47b.
     exception raised by the completing coroutine.  If the asynchronous
     generator exits without yielding another value, the awaitable
     instead raises a *note StopAsyncIteration: f49. exception,
     signalling that the asynchronous iteration has completed.

     This method is normally called implicitly by a *note async for:
     2e1. loop.

 -- Method: coroutine agen.asend (value)

     Returns an awaitable which when run resumes the execution of the
     asynchronous generator.  As with the *note send(): 13cb. method for
     a generator, this “sends” a value into the asynchronous generator
     function, and the `value' argument becomes the result of the
     current yield expression.  The awaitable returned by the *note
     asend(): 1448. method will return the next value yielded by the
     generator as the value of the raised *note StopIteration: 47b, or
     raises *note StopAsyncIteration: f49. if the asynchronous generator
     exits without yielding another value.  When *note asend(): 1448. is
     called to start the asynchronous generator, it must be called with
     *note None: 157. as the argument, because there is no yield
     expression that could receive the value.

 -- Method: coroutine agen.athrow (type[, value[, traceback]])

     Returns an awaitable that raises an exception of type ‘type’ at the
     point where the asynchronous generator was paused, and returns the
     next value yielded by the generator function as the value of the
     raised *note StopIteration: 47b. exception.  If the asynchronous
     generator exits without yielding another value, a *note
     StopAsyncIteration: f49. exception is raised by the awaitable.  If
     the generator function does not catch the passed-in exception, or
     raises a different exception, then when the awaitable is run that
     exception propagates to the caller of the awaitable.

 -- Method: coroutine agen.aclose ()

     Returns an awaitable that when run will throw a *note
     GeneratorExit: d25. into the asynchronous generator function at the
     point where it was paused.  If the asynchronous generator function
     then exits gracefully, is already closed, or raises *note
     GeneratorExit: d25. (by not catching the exception), then the
     returned awaitable will raise a *note StopIteration: 47b.
     exception.  Any further awaitables returned by subsequent calls to
     the asynchronous generator will raise a *note StopAsyncIteration:
     f49. exception.  If the asynchronous generator yields a value, a
     *note RuntimeError: 2b8. is raised by the awaitable.  If the
     asynchronous generator raises any other exception, it is propagated
     to the caller of the awaitable.  If the asynchronous generator has
     already exited due to an exception or normal exit, then further
     calls to *note aclose(): 1449. will return an awaitable that does
     nothing.


File: python.info,  Node: Primaries,  Next: Await expression,  Prev: Atoms,  Up: Expressions

4.6.3 Primaries
---------------

Primaries represent the most tightly bound operations of the language.
Their syntax is:

     primary ::= atom | attributeref | subscription | slicing | call

* Menu:

* Attribute references::
* Subscriptions::
* Slicings::
* Calls::


File: python.info,  Node: Attribute references,  Next: Subscriptions,  Up: Primaries

4.6.3.1 Attribute references
............................

An attribute reference is a primary followed by a period and a name:

     attributeref ::= primary "." identifier

The primary must evaluate to an object of a type that supports attribute
references, which most objects do.  This object is then asked to produce
the attribute whose name is the identifier.  This production can be
customized by overriding the *note __getattr__(): 30f. method.  If this
attribute is not available, the exception *note AttributeError: 390. is
raised.  Otherwise, the type and value of the object produced is
determined by the object.  Multiple evaluations of the same attribute
reference may yield different objects.


File: python.info,  Node: Subscriptions,  Next: Slicings,  Prev: Attribute references,  Up: Primaries

4.6.3.2 Subscriptions
.....................

A subscription selects an item of a sequence (string, tuple or list) or
mapping (dictionary) object:

     subscription ::= primary "[" expression_list "]"

The primary must evaluate to an object that supports subscription (lists
or dictionaries for example).  User-defined objects can support
subscription by defining a *note __getitem__(): 27a. method.

For built-in objects, there are two types of objects that support
subscription:

If the primary is a mapping, the expression list must evaluate to an
object whose value is one of the keys of the mapping, and the
subscription selects the value in the mapping that corresponds to that
key.  (The expression list is a tuple except if it has exactly one
item.)

If the primary is a sequence, the expression list must evaluate to an
integer or a slice (as discussed in the following section).

The formal syntax makes no special provision for negative indices in
sequences; however, built-in sequences all provide a *note
__getitem__(): 27a. method that interprets negative indices by adding
the length of the sequence to the index (so that ‘x[-1]’ selects the
last item of ‘x’).  The resulting value must be a nonnegative integer
less than the number of items in the sequence, and the subscription
selects the item whose index is that value (counting from zero).  Since
the support for negative indices and slicing occurs in the object’s
*note __getitem__(): 27a. method, subclasses overriding this method will
need to explicitly add that support.

A string’s items are characters.  A character is not a separate data
type but a string of exactly one character.


File: python.info,  Node: Slicings,  Next: Calls,  Prev: Subscriptions,  Up: Primaries

4.6.3.3 Slicings
................

A slicing selects a range of items in a sequence object (e.g., a string,
tuple or list).  Slicings may be used as expressions or as targets in
assignment or *note del: 11a8. statements.  The syntax for a slicing:

     slicing      ::= primary "[" slice_list "]"
     slice_list   ::= slice_item ("," slice_item)* [","]
     slice_item   ::= expression | proper_slice
     proper_slice ::= [lower_bound] ":" [upper_bound] [ ":" [stride] ]
     lower_bound  ::= expression
     upper_bound  ::= expression
     stride       ::= expression

There is ambiguity in the formal syntax here: anything that looks like
an expression list also looks like a slice list, so any subscription can
be interpreted as a slicing.  Rather than further complicating the
syntax, this is disambiguated by defining that in this case the
interpretation as a subscription takes priority over the interpretation
as a slicing (this is the case if the slice list contains no proper
slice).

The semantics for a slicing are as follows.  The primary is indexed
(using the same *note __getitem__(): 27a. method as normal subscription)
with a key that is constructed from the slice list, as follows.  If the
slice list contains at least one comma, the key is a tuple containing
the conversion of the slice items; otherwise, the conversion of the lone
slice item is the key.  The conversion of a slice item that is an
expression is that expression.  The conversion of a proper slice is a
slice object (see section *note The standard type hierarchy: 135c.)
whose ‘start’, ‘stop’ and ‘step’ attributes are the values of the
expressions given as lower bound, upper bound and stride, respectively,
substituting ‘None’ for missing expressions.


File: python.info,  Node: Calls,  Prev: Slicings,  Up: Primaries

4.6.3.4 Calls
.............

A call calls a callable object (e.g., a *note function: 1461.) with a
possibly empty series of *note arguments: 1462.:

     call                 ::= primary "(" [argument_list [","] | comprehension] ")"
     argument_list        ::= positional_arguments ["," starred_and_keywords]
                                ["," keywords_arguments]
                              | starred_and_keywords ["," keywords_arguments]
                              | keywords_arguments
     positional_arguments ::= ["*"] expression ("," ["*"] expression)*
     starred_and_keywords ::= ("*" expression | keyword_item)
                              ("," "*" expression | "," keyword_item)*
     keywords_arguments   ::= (keyword_item | "**" expression)
                              ("," keyword_item | "," "**" expression)*
     keyword_item         ::= identifier "=" expression

An optional trailing comma may be present after the positional and
keyword arguments but does not affect the semantics.

The primary must evaluate to a callable object (user-defined functions,
built-in functions, methods of built-in objects, class objects, methods
of class instances, and all objects having a *note __call__(): 1369.
method are callable).  All argument expressions are evaluated before the
call is attempted.  Please refer to section *note Function definitions:
1196. for the syntax of formal *note parameter: 1469. lists.

If keyword arguments are present, they are first converted to positional
arguments, as follows.  First, a list of unfilled slots is created for
the formal parameters.  If there are N positional arguments, they are
placed in the first N slots.  Next, for each keyword argument, the
identifier is used to determine the corresponding slot (if the
identifier is the same as the first formal parameter name, the first
slot is used, and so on).  If the slot is already filled, a *note
TypeError: 192. exception is raised.  Otherwise, the value of the
argument is placed in the slot, filling it (even if the expression is
‘None’, it fills the slot).  When all arguments have been processed, the
slots that are still unfilled are filled with the corresponding default
value from the function definition.  (Default values are calculated,
once, when the function is defined; thus, a mutable object such as a
list or dictionary used as default value will be shared by all calls
that don’t specify an argument value for the corresponding slot; this
should usually be avoided.)  If there are any unfilled slots for which
no default value is specified, a *note TypeError: 192. exception is
raised.  Otherwise, the list of filled slots is used as the argument
list for the call.

`CPython implementation detail:' An implementation may provide built-in
functions whose positional parameters do not have names, even if they
are ‘named’ for the purpose of documentation, and which therefore cannot
be supplied by keyword.  In CPython, this is the case for functions
implemented in C that use *note PyArg_ParseTuple(): 268. to parse their
arguments.

If there are more positional arguments than there are formal parameter
slots, a *note TypeError: 192. exception is raised, unless a formal
parameter using the syntax ‘*identifier’ is present; in this case, that
formal parameter receives a tuple containing the excess positional
arguments (or an empty tuple if there were no excess positional
arguments).

If any keyword argument does not correspond to a formal parameter name,
a *note TypeError: 192. exception is raised, unless a formal parameter
using the syntax ‘**identifier’ is present; in this case, that formal
parameter receives a dictionary containing the excess keyword arguments
(using the keywords as keys and the argument values as corresponding
values), or a (new) empty dictionary if there were no excess keyword
arguments.

If the syntax ‘*expression’ appears in the function call, ‘expression’
must evaluate to an *note iterable: b9f.  Elements from these iterables
are treated as if they were additional positional arguments.  For the
call ‘f(x1, x2, *y, x3, x4)’, if `y' evaluates to a sequence `y1', …,
`yM', this is equivalent to a call with M+4 positional arguments `x1',
`x2', `y1', …, `yM', `x3', `x4'.

A consequence of this is that although the ‘*expression’ syntax may
appear `after' explicit keyword arguments, it is processed `before' the
keyword arguments (and any ‘**expression’ arguments – see below).  So:

     >>> def f(a, b):
     ...     print(a, b)
     ...
     >>> f(b=1, *(2,))
     2 1
     >>> f(a=1, *(2,))
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: f() got multiple values for keyword argument 'a'
     >>> f(1, *(2,))
     1 2

It is unusual for both keyword arguments and the ‘*expression’ syntax to
be used in the same call, so in practice this confusion does not arise.

If the syntax ‘**expression’ appears in the function call, ‘expression’
must evaluate to a *note mapping: b2c, the contents of which are treated
as additional keyword arguments.  If a keyword is already present (as an
explicit keyword argument, or from another unpacking), a *note
TypeError: 192. exception is raised.

Formal parameters using the syntax ‘*identifier’ or ‘**identifier’
cannot be used as positional argument slots or as keyword argument
names.

Changed in version 3.5: Function calls accept any number of ‘*’ and ‘**’
unpackings, positional arguments may follow iterable unpackings (‘*’),
and keyword arguments may follow dictionary unpackings (‘**’).
Originally proposed by PEP 448(1).

A call always returns some value, possibly ‘None’, unless it raises an
exception.  How this value is computed depends on the type of the
callable object.

If it is—

a user-defined function:

     The code block for the function is executed, passing it the
     argument list.  The first thing the code block will do is bind the
     formal parameters to the arguments; this is described in section
     *note Function definitions: 1196.  When the code block executes a
     *note return: 190. statement, this specifies the return value of
     the function call.

a built-in function or method:

     The result is up to the interpreter; see *note Built-in Functions:
     be6. for the descriptions of built-in functions and methods.

a class object:

     A new instance of that class is returned.

a class instance method:

     The corresponding user-defined function is called, with an argument
     list that is one longer than the argument list of the call: the
     instance becomes the first argument.

a class instance:

     The class must define a *note __call__(): 1369. method; the effect
     is then the same as if that method was called.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0448


File: python.info,  Node: Await expression,  Next: The power operator,  Prev: Primaries,  Up: Expressions

4.6.4 Await expression
----------------------

Suspend the execution of *note coroutine: 1a5. on an *note awaitable:
50e. object.  Can only be used inside a *note coroutine function: 633.

     await_expr ::= "await" primary

New in version 3.5.


File: python.info,  Node: The power operator,  Next: Unary arithmetic and bitwise operations,  Prev: Await expression,  Up: Expressions

4.6.5 The power operator
------------------------

The power operator binds more tightly than unary operators on its left;
it binds less tightly than unary operators on its right.  The syntax is:

     power ::= (await_expr | primary) ["**" u_expr]

Thus, in an unparenthesized sequence of power and unary operators, the
operators are evaluated from right to left (this does not constrain the
evaluation order for the operands): ‘-1**2’ results in ‘-1’.

The power operator has the same semantics as the built-in *note pow():
152. function, when called with two arguments: it yields its left
argument raised to the power of its right argument.  The numeric
arguments are first converted to a common type, and the result is of
that type.

For int operands, the result has the same type as the operands unless
the second argument is negative; in that case, all arguments are
converted to float and a float result is delivered.  For example,
‘10**2’ returns ‘100’, but ‘10**-2’ returns ‘0.01’.

Raising ‘0.0’ to a negative power results in a *note ZeroDivisionError:
11e6.  Raising a negative number to a fractional power results in a
*note complex: 189. number.  (In earlier versions it raised a *note
ValueError: 1f9.)


File: python.info,  Node: Unary arithmetic and bitwise operations,  Next: Binary arithmetic operations,  Prev: The power operator,  Up: Expressions

4.6.6 Unary arithmetic and bitwise operations
---------------------------------------------

All unary arithmetic and bitwise operations have the same priority:

     u_expr ::= power | "-" u_expr | "+" u_expr | "~" u_expr

The unary ‘-’ (minus) operator yields the negation of its numeric
argument.

The unary ‘+’ (plus) operator yields its numeric argument unchanged.

The unary ‘~’ (invert) operator yields the bitwise inversion of its
integer argument.  The bitwise inversion of ‘x’ is defined as ‘-(x+1)’.
It only applies to integral numbers.

In all three cases, if the argument does not have the proper type, a
*note TypeError: 192. exception is raised.


File: python.info,  Node: Binary arithmetic operations,  Next: Shifting operations,  Prev: Unary arithmetic and bitwise operations,  Up: Expressions

4.6.7 Binary arithmetic operations
----------------------------------

The binary arithmetic operations have the conventional priority levels.
Note that some of these operations also apply to certain non-numeric
types.  Apart from the power operator, there are only two levels, one
for multiplicative operators and one for additive operators:

     m_expr ::= u_expr | m_expr "*" u_expr | m_expr "@" m_expr |
                m_expr "//" u_expr | m_expr "/" u_expr |
                m_expr "%" u_expr
     a_expr ::= m_expr | a_expr "+" m_expr | a_expr "-" m_expr

The ‘*’ (multiplication) operator yields the product of its arguments.
The arguments must either both be numbers, or one argument must be an
integer and the other must be a sequence.  In the former case, the
numbers are converted to a common type and then multiplied together.  In
the latter case, sequence repetition is performed; a negative repetition
factor yields an empty sequence.

The ‘@’ (at) operator is intended to be used for matrix multiplication.
No builtin Python types implement this operator.

New in version 3.5.

The ‘/’ (division) and ‘//’ (floor division) operators yield the
quotient of their arguments.  The numeric arguments are first converted
to a common type.  Division of integers yields a float, while floor
division of integers results in an integer; the result is that of
mathematical division with the ‘floor’ function applied to the result.
Division by zero raises the *note ZeroDivisionError: 11e6. exception.

The ‘%’ (modulo) operator yields the remainder from the division of the
first argument by the second.  The numeric arguments are first converted
to a common type.  A zero right argument raises the *note
ZeroDivisionError: 11e6. exception.  The arguments may be floating point
numbers, e.g., ‘3.14%0.7’ equals ‘0.34’ (since ‘3.14’ equals ‘4*0.7 +
0.34’.)  The modulo operator always yields a result with the same sign
as its second operand (or zero); the absolute value of the result is
strictly smaller than the absolute value of the second operand (1).

The floor division and modulo operators are connected by the following
identity: ‘x == (x//y)*y + (x%y)’.  Floor division and modulo are also
connected with the built-in function *note divmod(): f4d.: ‘divmod(x, y)
== (x//y, x%y)’.  (2).

In addition to performing the modulo operation on numbers, the ‘%’
operator is also overloaded by string objects to perform old-style
string formatting (also known as interpolation).  The syntax for string
formatting is described in the Python Library Reference, section *note
printf-style String Formatting: 115f.

The floor division operator, the modulo operator, and the *note
divmod(): f4d. function are not defined for complex numbers.  Instead,
convert to a floating point number using the *note abs(): 11f8. function
if appropriate.

The ‘+’ (addition) operator yields the sum of its arguments.  The
arguments must either both be numbers or both be sequences of the same
type.  In the former case, the numbers are converted to a common type
and then added together.  In the latter case, the sequences are
concatenated.

The ‘-’ (subtraction) operator yields the difference of its arguments.
The numeric arguments are first converted to a common type.

   ---------- Footnotes ----------

   (1) (1) While ‘abs(x%y) < abs(y)’ is true mathematically, for floats
it may not be true numerically due to roundoff.  For example, and
assuming a platform on which a Python float is an IEEE 754
double-precision number, in order that ‘-1e-100 % 1e100’ have the same
sign as ‘1e100’, the computed result is ‘-1e-100 + 1e100’, which is
numerically exactly equal to ‘1e100’.  The function *note math.fmod():
1476. returns a result whose sign matches the sign of the first argument
instead, and so returns ‘-1e-100’ in this case.  Which approach is more
appropriate depends on the application.

   (2) (2) If x is very close to an exact integer multiple of y, it’s
possible for ‘x//y’ to be one larger than ‘(x-x%y)//y’ due to rounding.
In such cases, Python returns the latter result, in order to preserve
that ‘divmod(x,y)[0] * y + x % y’ be very close to ‘x’.


File: python.info,  Node: Shifting operations,  Next: Binary bitwise operations,  Prev: Binary arithmetic operations,  Up: Expressions

4.6.8 Shifting operations
-------------------------

The shifting operations have lower priority than the arithmetic
operations:

     shift_expr ::= a_expr | shift_expr ("<<" | ">>") a_expr

These operators accept integers as arguments.  They shift the first
argument to the left or right by the number of bits given by the second
argument.

A right shift by `n' bits is defined as floor division by ‘pow(2,n)’.  A
left shift by `n' bits is defined as multiplication with ‘pow(2,n)’.


File: python.info,  Node: Binary bitwise operations,  Next: Comparisons,  Prev: Shifting operations,  Up: Expressions

4.6.9 Binary bitwise operations
-------------------------------

Each of the three bitwise operations has a different priority level:

     and_expr ::= shift_expr | and_expr "&" shift_expr
     xor_expr ::= and_expr | xor_expr "^" and_expr
     or_expr  ::= xor_expr | or_expr "|" xor_expr

The ‘&’ operator yields the bitwise AND of its arguments, which must be
integers.

The ‘^’ operator yields the bitwise XOR (exclusive OR) of its arguments,
which must be integers.

The ‘|’ operator yields the bitwise (inclusive) OR of its arguments,
which must be integers.


File: python.info,  Node: Comparisons,  Next: Boolean operations,  Prev: Binary bitwise operations,  Up: Expressions

4.6.10 Comparisons
------------------

Unlike C, all comparison operations in Python have the same priority,
which is lower than that of any arithmetic, shifting or bitwise
operation.  Also unlike C, expressions like ‘a < b < c’ have the
interpretation that is conventional in mathematics:

     comparison    ::= or_expr (comp_operator or_expr)*
     comp_operator ::= "<" | ">" | "==" | ">=" | "<=" | "!="
                       | "is" ["not"] | ["not"] "in"

Comparisons yield boolean values: ‘True’ or ‘False’.

Comparisons can be chained arbitrarily, e.g., ‘x < y <= z’ is equivalent
to ‘x < y and y <= z’, except that ‘y’ is evaluated only once (but in
both cases ‘z’ is not evaluated at all when ‘x < y’ is found to be
false).

Formally, if `a', `b', `c', …, `y', `z' are expressions and `op1',
`op2', …, `opN' are comparison operators, then ‘a op1 b op2 c ... y opN
z’ is equivalent to ‘a op1 b and b op2 c and ... y opN z’, except that
each expression is evaluated at most once.

Note that ‘a op1 b op2 c’ doesn’t imply any kind of comparison between
`a' and `c', so that, e.g., ‘x < y > z’ is perfectly legal (though
perhaps not pretty).

* Menu:

* Value comparisons::
* Membership test operations::
* Identity comparisons::


File: python.info,  Node: Value comparisons,  Next: Membership test operations,  Up: Comparisons

4.6.10.1 Value comparisons
..........................

The operators ‘<’, ‘>’, ‘==’, ‘>=’, ‘<=’, and ‘!=’ compare the values of
two objects.  The objects do not need to have the same type.

Chapter *note Objects, values and types: 1358. states that objects have
a value (in addition to type and identity).  The value of an object is a
rather abstract notion in Python: For example, there is no canonical
access method for an object’s value.  Also, there is no requirement that
the value of an object should be constructed in a particular way, e.g.
comprised of all its data attributes.  Comparison operators implement a
particular notion of what the value of an object is.  One can think of
them as defining the value of an object indirectly, by means of their
comparison implementation.

Because all types are (direct or indirect) subtypes of *note object:
2ae, they inherit the default comparison behavior from *note object:
2ae.  Types can customize their comparison behavior by implementing
`rich comparison methods' like *note __lt__(): c27, described in *note
Basic customization: 1371.

The default behavior for equality comparison (‘==’ and ‘!=’) is based on
the identity of the objects.  Hence, equality comparison of instances
with the same identity results in equality, and equality comparison of
instances with different identities results in inequality.  A motivation
for this default behavior is the desire that all objects should be
reflexive (i.e.  ‘x is y’ implies ‘x == y’).

A default order comparison (‘<’, ‘>’, ‘<=’, and ‘>=’) is not provided;
an attempt raises *note TypeError: 192.  A motivation for this default
behavior is the lack of a similar invariant as for equality.

The behavior of the default equality comparison, that instances with
different identities are always unequal, may be in contrast to what
types will need that have a sensible definition of object value and
value-based equality.  Such types will need to customize their
comparison behavior, and in fact, a number of built-in types have done
that.

The following list describes the comparison behavior of the most
important built-in types.

   * Numbers of built-in numeric types (*note Numeric Types — int,
     float, complex: 1159.) and of the standard library types *note
     fractions.Fraction: 185. and *note decimal.Decimal: 188. can be
     compared within and across their types, with the restriction that
     complex numbers do not support order comparison.  Within the limits
     of the types involved, they compare mathematically
     (algorithmically) correct without loss of precision.

     The not-a-number values ‘float('NaN')’ and ‘decimal.Decimal('NaN')’
     are special.  Any ordered comparison of a number to a not-a-number
     value is false.  A counter-intuitive implication is that
     not-a-number values are not equal to themselves.  For example, if
     ‘x = float('NaN')’, ‘3 < x’, ‘x < 3’, ‘x == x’, ‘x != x’ are all
     false.  This behavior is compliant with IEEE 754.

   * ‘None’ and ‘NotImplemented’ are singletons.  PEP 8(1) advises that
     comparisons for singletons should always be done with ‘is’ or ‘is
     not’, never the equality operators.

   * Binary sequences (instances of *note bytes: 326. or *note
     bytearray: 327.) can be compared within and across their types.
     They compare lexicographically using the numeric values of their
     elements.

   * Strings (instances of *note str: 325.) compare lexicographically
     using the numerical Unicode code points (the result of the built-in
     function *note ord(): 1362.) of their characters.  (2)

     Strings and binary sequences cannot be directly compared.

   * Sequences (instances of *note tuple: 473, *note list: 260, or *note
     range: 9b2.) can be compared only within each of their types, with
     the restriction that ranges do not support order comparison.
     Equality comparison across these types results in inequality, and
     ordering comparison across these types raises *note TypeError: 192.

     Sequences compare lexicographically using comparison of
     corresponding elements.  The built-in containers typically assume
     identical objects are equal to themselves.  That lets them bypass
     equality tests for identical objects to improve performance and to
     maintain their internal invariants.

     Lexicographical comparison between built-in collections works as
     follows:

        - For two collections to compare equal, they must be of the same
          type, have the same length, and each pair of corresponding
          elements must compare equal (for example, ‘[1,2] == (1,2)’ is
          false because the type is not the same).

        - Collections that support order comparison are ordered the same
          as their first unequal elements (for example, ‘[1,2,x] <=
          [1,2,y]’ has the same value as ‘x <= y’).  If a corresponding
          element does not exist, the shorter collection is ordered
          first (for example, ‘[1,2] < [1,2,3]’ is true).

   * Mappings (instances of *note dict: 1b6.) compare equal if and only
     if they have equal ‘(key, value)’ pairs.  Equality comparison of
     the keys and values enforces reflexivity.

     Order comparisons (‘<’, ‘>’, ‘<=’, and ‘>=’) raise *note TypeError:
     192.

   * Sets (instances of *note set: b62. or *note frozenset: be1.) can be
     compared within and across their types.

     They define order comparison operators to mean subset and superset
     tests.  Those relations do not define total orderings (for example,
     the two sets ‘{1,2}’ and ‘{2,3}’ are not equal, nor subsets of one
     another, nor supersets of one another).  Accordingly, sets are not
     appropriate arguments for functions which depend on total ordering
     (for example, *note min(): 7fd, *note max(): 7fe, and *note
     sorted(): 439. produce undefined results given a list of sets as
     inputs).

     Comparison of sets enforces reflexivity of its elements.

   * Most other built-in types have no comparison methods implemented,
     so they inherit the default comparison behavior.

User-defined classes that customize their comparison behavior should
follow some consistency rules, if possible:

   * Equality comparison should be reflexive.  In other words, identical
     objects should compare equal:

          ‘x is y’ implies ‘x == y’

   * Comparison should be symmetric.  In other words, the following
     expressions should have the same result:

          ‘x == y’ and ‘y == x’

          ‘x != y’ and ‘y != x’

          ‘x < y’ and ‘y > x’

          ‘x <= y’ and ‘y >= x’

   * Comparison should be transitive.  The following (non-exhaustive)
     examples illustrate that:

          ‘x > y and y > z’ implies ‘x > z’

          ‘x < y and y <= z’ implies ‘x < z’

   * Inverse comparison should result in the boolean negation.  In other
     words, the following expressions should have the same result:

          ‘x == y’ and ‘not x != y’

          ‘x < y’ and ‘not x >= y’ (for total ordering)

          ‘x > y’ and ‘not x <= y’ (for total ordering)

     The last two expressions apply to totally ordered collections (e.g.
     to sequences, but not to sets or mappings).  See also the *note
     total_ordering(): 83f. decorator.

   * The *note hash(): 9b8. result should be consistent with equality.
     Objects that are equal should either have the same hash value, or
     be marked as unhashable.

Python does not enforce these consistency rules.  In fact, the
not-a-number values are an example for not following these rules.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0008

   (2) (3) The Unicode standard distinguishes between `code points'
(e.g.  U+0041) and `abstract characters' (e.g.  “LATIN CAPITAL LETTER
A”).  While most abstract characters in Unicode are only represented
using one code point, there is a number of abstract characters that can
in addition be represented using a sequence of more than one code point.
For example, the abstract character “LATIN CAPITAL LETTER C WITH
CEDILLA” can be represented as a single `precomposed character' at code
position U+00C7, or as a sequence of a `base character' at code position
U+0043 (LATIN CAPITAL LETTER C), followed by a `combining character' at
code position U+0327 (COMBINING CEDILLA).

The comparison operators on strings compare at the level of Unicode code
points.  This may be counter-intuitive to humans.  For example,
‘"\u00C7" == "\u0043\u0327"’ is ‘False’, even though both strings
represent the same abstract character “LATIN CAPITAL LETTER C WITH
CEDILLA”.

To compare strings at the level of abstract characters (that is, in a
way intuitive to humans), use *note unicodedata.normalize(): fe8.


File: python.info,  Node: Membership test operations,  Next: Identity comparisons,  Prev: Value comparisons,  Up: Comparisons

4.6.10.2 Membership test operations
...................................

The operators *note in: 797. and *note not in: 1399. test for
membership.  ‘x in s’ evaluates to ‘True’ if `x' is a member of `s', and
‘False’ otherwise.  ‘x not in s’ returns the negation of ‘x in s’.  All
built-in sequences and set types support this as well as dictionary, for
which ‘in’ tests whether the dictionary has a given key.  For container
types such as list, tuple, set, frozenset, dict, or collections.deque,
the expression ‘x in y’ is equivalent to ‘any(x is e or x == e for e in
y)’.

For the string and bytes types, ‘x in y’ is ‘True’ if and only if `x' is
a substring of `y'.  An equivalent test is ‘y.find(x) != -1’.  Empty
strings are always considered to be a substring of any other string, so
‘"" in "abc"’ will return ‘True’.

For user-defined classes which define the *note __contains__(): d1b.
method, ‘x in y’ returns ‘True’ if ‘y.__contains__(x)’ returns a true
value, and ‘False’ otherwise.

For user-defined classes which do not define *note __contains__(): d1b.
but do define *note __iter__(): 504, ‘x in y’ is ‘True’ if some value
‘z’, for which the expression ‘x is z or x == z’ is true, is produced
while iterating over ‘y’.  If an exception is raised during the
iteration, it is as if *note in: 797. raised that exception.

Lastly, the old-style iteration protocol is tried: if a class defines
*note __getitem__(): 27a, ‘x in y’ is ‘True’ if and only if there is a
non-negative integer index `i' such that ‘x is y[i] or x == y[i]’, and
no lower integer index raises the *note IndexError: e69. exception.  (If
any other exception is raised, it is as if *note in: 797. raised that
exception).

The operator *note not in: 1399. is defined to have the inverse truth
value of *note in: 797.


File: python.info,  Node: Identity comparisons,  Prev: Membership test operations,  Up: Comparisons

4.6.10.3 Identity comparisons
.............................

The operators *note is: 135a. and *note is not: 1486. test for an
object’s identity: ‘x is y’ is true if and only if `x' and `y' are the
same object.  An Object’s identity is determined using the *note id():
d79. function.  ‘x is not y’ yields the inverse truth value.  (1)

   ---------- Footnotes ----------

   (1) (4) Due to automatic garbage-collection, free lists, and the
dynamic nature of descriptors, you may notice seemingly unusual
behaviour in certain uses of the *note is: 135a. operator, like those
involving comparisons between instance methods, or constants.  Check
their documentation for more info.


File: python.info,  Node: Boolean operations,  Next: Conditional expressions,  Prev: Comparisons,  Up: Expressions

4.6.11 Boolean operations
-------------------------

     or_test  ::= and_test | or_test "or" and_test
     and_test ::= not_test | and_test "and" not_test
     not_test ::= comparison | "not" not_test

In the context of Boolean operations, and also when expressions are used
by control flow statements, the following values are interpreted as
false: ‘False’, ‘None’, numeric zero of all types, and empty strings and
containers (including strings, tuples, lists, dictionaries, sets and
frozensets).  All other values are interpreted as true.  User-defined
objects can customize their truth value by providing a *note __bool__():
c5b. method.

The operator *note not: 148b. yields ‘True’ if its argument is false,
‘False’ otherwise.

The expression ‘x and y’ first evaluates `x'; if `x' is false, its value
is returned; otherwise, `y' is evaluated and the resulting value is
returned.

The expression ‘x or y’ first evaluates `x'; if `x' is true, its value
is returned; otherwise, `y' is evaluated and the resulting value is
returned.

Note that neither *note and: 1488. nor *note or: 1489. restrict the
value and type they return to ‘False’ and ‘True’, but rather return the
last evaluated argument.  This is sometimes useful, e.g., if ‘s’ is a
string that should be replaced by a default value if it is empty, the
expression ‘s or 'foo'’ yields the desired value.  Because *note not:
148b. has to create a new value, it returns a boolean value regardless
of the type of its argument (for example, ‘not 'foo'’ produces ‘False’
rather than ‘''’.)


File: python.info,  Node: Conditional expressions,  Next: Lambdas,  Prev: Boolean operations,  Up: Expressions

4.6.12 Conditional expressions
------------------------------

     conditional_expression ::= or_test ["if" or_test "else" expression]
     expression             ::= conditional_expression | lambda_expr
     expression_nocond      ::= or_test | lambda_expr_nocond

Conditional expressions (sometimes called a “ternary operator”) have the
lowest priority of all Python operations.

The expression ‘x if C else y’ first evaluates the condition, `C' rather
than `x'.  If `C' is true, `x' is evaluated and its value is returned;
otherwise, `y' is evaluated and its value is returned.

See PEP 308(1) for more details about conditional expressions.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0308


File: python.info,  Node: Lambdas,  Next: Expression lists,  Prev: Conditional expressions,  Up: Expressions

4.6.13 Lambdas
--------------

     lambda_expr        ::= "lambda" [parameter_list] ":" expression
     lambda_expr_nocond ::= "lambda" [parameter_list] ":" expression_nocond

Lambda expressions (sometimes called lambda forms) are used to create
anonymous functions.  The expression ‘lambda parameters: expression’
yields a function object.  The unnamed object behaves like a function
object defined with:

     def <lambda>(parameters):
         return expression

See section *note Function definitions: 1196. for the syntax of
parameter lists.  Note that functions created with lambda expressions
cannot contain statements or annotations.


File: python.info,  Node: Expression lists,  Next: Evaluation order,  Prev: Lambdas,  Up: Expressions

4.6.14 Expression lists
-----------------------

     expression_list    ::= expression ("," expression)* [","]
     starred_list       ::= starred_item ("," starred_item)* [","]
     starred_expression ::= expression | (starred_item ",")* [starred_item]
     starred_item       ::= expression | "*" or_expr

Except when part of a list or set display, an expression list containing
at least one comma yields a tuple.  The length of the tuple is the
number of expressions in the list.  The expressions are evaluated from
left to right.

An asterisk ‘*’ denotes `iterable unpacking'.  Its operand must be an
*note iterable: b9f.  The iterable is expanded into a sequence of items,
which are included in the new tuple, list, or set, at the site of the
unpacking.

New in version 3.5: Iterable unpacking in expression lists, originally
proposed by PEP 448(1).

The trailing comma is required only to create a single tuple (a.k.a.  a
`singleton'); it is optional in all other cases.  A single expression
without a trailing comma doesn’t create a tuple, but rather yields the
value of that expression.  (To create an empty tuple, use an empty pair
of parentheses: ‘()’.)

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0448


File: python.info,  Node: Evaluation order,  Next: Operator precedence,  Prev: Expression lists,  Up: Expressions

4.6.15 Evaluation order
-----------------------

Python evaluates expressions from left to right.  Notice that while
evaluating an assignment, the right-hand side is evaluated before the
left-hand side.

In the following lines, expressions will be evaluated in the arithmetic
order of their suffixes:

     expr1, expr2, expr3, expr4
     (expr1, expr2, expr3, expr4)
     {expr1: expr2, expr3: expr4}
     expr1 + expr2 * (expr3 - expr4)
     expr1(expr2, expr3, *expr4, **expr5)
     expr3, expr4 = expr1, expr2


File: python.info,  Node: Operator precedence,  Prev: Evaluation order,  Up: Expressions

4.6.16 Operator precedence
--------------------------

The following table summarizes the operator precedence in Python, from
lowest precedence (least binding) to highest precedence (most binding).
Operators in the same box have the same precedence.  Unless the syntax
is explicitly given, operators are binary.  Operators in the same box
group left to right (except for exponentiation, which groups from right
to left).

Note that comparisons, membership tests, and identity tests, all have
the same precedence and have a left-to-right chaining feature as
described in the *note Comparisons: 147f. section.

Operator                                            Description
                                                    
----------------------------------------------------------------------------------------------
                                                    
‘:=’                                                Assignment expression
                                                    
                                                    
*note lambda: c22.                                  Lambda expression
                                                    
                                                    
*note if: 1490. – ‘else’                            Conditional expression
                                                    
                                                    
*note or: 1489.                                     Boolean OR
                                                    
                                                    
*note and: 1488.                                    Boolean AND
                                                    
                                                    
*note not: 148b. ‘x’                                Boolean NOT
                                                    
                                                    
*note in: 797, *note not in: 1399,                  Comparisons, including membership tests
*note is: 135a, *note is not: 1486, ‘<’, ‘<=’,      and identity tests
‘>’, ‘>=’, ‘!=’, ‘==’                               

‘|’                                                 Bitwise OR
                                                    
                                                    
‘^’                                                 Bitwise XOR
                                                    
                                                    
‘&’                                                 Bitwise AND
                                                    
                                                    
‘<<’, ‘>>’                                          Shifts
                                                    
                                                    
‘+’, ‘-’                                            Addition and subtraction
                                                    
                                                    
‘*’, ‘@’, ‘/’, ‘//’, ‘%’                            Multiplication, matrix multiplication,
                                                    division, floor division, remainder (1)
                                                    
                                                    
‘+x’, ‘-x’, ‘~x’                                    Positive, negative, bitwise NOT
                                                    
                                                    
‘**’                                                Exponentiation (2)
                                                    
                                                    
*note await: 1a2. ‘x’                               Await expression
                                                    
                                                    
‘x[index]’, ‘x[index:index]’, ‘x(arguments...)’,    Subscription, slicing, call, attribute
‘x.attribute’                                       reference
                                                    
                                                    
‘(expressions...)’,                                 Binding or parenthesized expression,
                                                    list display, dictionary display, set
‘[expressions...]’, ‘{key: value...}’,              display
‘{expressions...}’                                  

   ---------- Footnotes ----------

   (1) (5) The ‘%’ operator is also used for string formatting; the same
precedence applies.

   (2) (6) The power operator ‘**’ binds less tightly than an arithmetic
or bitwise unary operator on its right, that is, ‘2**-1’ is ‘0.5’.


File: python.info,  Node: Simple statements,  Next: Compound statements,  Prev: Expressions,  Up: The Python Language Reference

4.7 Simple statements
=====================

A simple statement is comprised within a single logical line.  Several
simple statements may occur on a single line separated by semicolons.
The syntax for simple statements is:

     simple_stmt ::= expression_stmt
                     | assert_stmt
                     | assignment_stmt
                     | augmented_assignment_stmt
                     | annotated_assignment_stmt
                     | pass_stmt
                     | del_stmt
                     | return_stmt
                     | yield_stmt
                     | raise_stmt
                     | break_stmt
                     | continue_stmt
                     | import_stmt
                     | future_stmt
                     | global_stmt
                     | nonlocal_stmt

* Menu:

* Expression statements::
* Assignment statements::
* The assert statement::
* The pass statement::
* The del statement: The del statement<2>.
* The return statement::
* The yield statement::
* The raise statement::
* The break statement::
* The continue statement::
* The import statement::
* The global statement::
* The nonlocal statement::


File: python.info,  Node: Expression statements,  Next: Assignment statements,  Up: Simple statements

4.7.1 Expression statements
---------------------------

Expression statements are used (mostly interactively) to compute and
write a value, or (usually) to call a procedure (a function that returns
no meaningful result; in Python, procedures return the value ‘None’).
Other uses of expression statements are allowed and occasionally useful.
The syntax for an expression statement is:

     expression_stmt ::= starred_expression

An expression statement evaluates the expression list (which may be a
single expression).

In interactive mode, if the value is not ‘None’, it is converted to a
string using the built-in *note repr(): 7c0. function and the resulting
string is written to standard output on a line by itself (except if the
result is ‘None’, so that procedure calls do not cause any output.)


File: python.info,  Node: Assignment statements,  Next: The assert statement,  Prev: Expression statements,  Up: Simple statements

4.7.2 Assignment statements
---------------------------

Assignment statements are used to (re)bind names to values and to modify
attributes or items of mutable objects:

     assignment_stmt ::= (target_list "=")+ (starred_expression | yield_expression)
     target_list     ::= target ("," target)* [","]
     target          ::= identifier
                         | "(" [target_list] ")"
                         | "[" [target_list] "]"
                         | attributeref
                         | subscription
                         | slicing
                         | "*" target

(See section *note Primaries: 144f. for the syntax definitions for
`attributeref', `subscription', and `slicing'.)

An assignment statement evaluates the expression list (remember that
this can be a single expression or a comma-separated list, the latter
yielding a tuple) and assigns the single resulting object to each of the
target lists, from left to right.

Assignment is defined recursively depending on the form of the target
(list).  When a target is part of a mutable object (an attribute
reference, subscription or slicing), the mutable object must ultimately
perform the assignment and decide about its validity, and may raise an
exception if the assignment is unacceptable.  The rules observed by
various types and the exceptions raised are given with the definition of
the object types (see section *note The standard type hierarchy: 135c.).

Assignment of an object to a target list, optionally enclosed in
parentheses or square brackets, is recursively defined as follows.

   * If the target list is a single target with no trailing comma,
     optionally in parentheses, the object is assigned to that target.

   * Else: The object must be an iterable with the same number of items
     as there are targets in the target list, and the items are
     assigned, from left to right, to the corresponding targets.

        * If the target list contains one target prefixed with an
          asterisk, called a “starred” target: The object must be an
          iterable with at least as many items as there are targets in
          the target list, minus one.  The first items of the iterable
          are assigned, from left to right, to the targets before the
          starred target.  The final items of the iterable are assigned
          to the targets after the starred target.  A list of the
          remaining items in the iterable is then assigned to the
          starred target (the list can be empty).

        * Else: The object must be an iterable with the same number of
          items as there are targets in the target list, and the items
          are assigned, from left to right, to the corresponding
          targets.

Assignment of an object to a single target is recursively defined as
follows.

   * If the target is an identifier (name):

        * If the name does not occur in a *note global: 117e. or *note
          nonlocal: c32. statement in the current code block: the name
          is bound to the object in the current local namespace.

        * Otherwise: the name is bound to the object in the global
          namespace or the outer namespace determined by *note nonlocal:
          c32, respectively.

     The name is rebound if it was already bound.  This may cause the
     reference count for the object previously bound to the name to
     reach zero, causing the object to be deallocated and its destructor
     (if it has one) to be called.

   * If the target is an attribute reference: The primary expression in
     the reference is evaluated.  It should yield an object with
     assignable attributes; if this is not the case, *note TypeError:
     192. is raised.  That object is then asked to assign the assigned
     object to the given attribute; if it cannot perform the assignment,
     it raises an exception (usually but not necessarily *note
     AttributeError: 390.).  Note: If the object is a class instance and
     the attribute reference occurs on both sides of the assignment
     operator, the right-hand side expression, ‘a.x’ can access either
     an instance attribute or (if no instance attribute exists) a class
     attribute.  The left-hand side target ‘a.x’ is always set as an
     instance attribute, creating it if necessary.  Thus, the two
     occurrences of ‘a.x’ do not necessarily refer to the same
     attribute: if the right-hand side expression refers to a class
     attribute, the left-hand side creates a new instance attribute as
     the target of the assignment:

          class Cls:
              x = 3             # class variable
          inst = Cls()
          inst.x = inst.x + 1   # writes inst.x as 4 leaving Cls.x as 3

     This description does not necessarily apply to descriptor
     attributes, such as properties created with *note property(): 1d5.

   * If the target is a subscription: The primary expression in the
     reference is evaluated.  It should yield either a mutable sequence
     object (such as a list) or a mapping object (such as a dictionary).
     Next, the subscript expression is evaluated.

     If the primary is a mutable sequence object (such as a list), the
     subscript must yield an integer.  If it is negative, the sequence’s
     length is added to it.  The resulting value must be a nonnegative
     integer less than the sequence’s length, and the sequence is asked
     to assign the assigned object to its item with that index.  If the
     index is out of range, *note IndexError: e69. is raised (assignment
     to a subscripted sequence cannot add new items to a list).

     If the primary is a mapping object (such as a dictionary), the
     subscript must have a type compatible with the mapping’s key type,
     and the mapping is then asked to create a key/datum pair which maps
     the subscript to the assigned object.  This can either replace an
     existing key/value pair with the same key value, or insert a new
     key/value pair (if no key with the same value existed).

     For user-defined objects, the *note __setitem__(): c55. method is
     called with appropriate arguments.

   * If the target is a slicing: The primary expression in the reference
     is evaluated.  It should yield a mutable sequence object (such as a
     list).  The assigned object should be a sequence object of the same
     type.  Next, the lower and upper bound expressions are evaluated,
     insofar they are present; defaults are zero and the sequence’s
     length.  The bounds should evaluate to integers.  If either bound
     is negative, the sequence’s length is added to it.  The resulting
     bounds are clipped to lie between zero and the sequence’s length,
     inclusive.  Finally, the sequence object is asked to replace the
     slice with the items of the assigned sequence.  The length of the
     slice may be different from the length of the assigned sequence,
     thus changing the length of the target sequence, if the target
     sequence allows it.

`CPython implementation detail:' In the current implementation, the
syntax for targets is taken to be the same as for expressions, and
invalid syntax is rejected during the code generation phase, causing
less detailed error messages.

Although the definition of assignment implies that overlaps between the
left-hand side and the right-hand side are ‘simultaneous’ (for example
‘a, b = b, a’ swaps two variables), overlaps `within' the collection of
assigned-to variables occur left-to-right, sometimes resulting in
confusion.  For instance, the following program prints ‘[0, 2]’:

     x = [0, 1]
     i = 0
     i, x[i] = 1, 2         # i is updated, then x[i] is updated
     print(x)

See also
........

PEP 3132(1) - Extended Iterable Unpacking

     The specification for the ‘*target’ feature.

* Menu:

* Augmented assignment statements::
* Annotated assignment statements::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3132


File: python.info,  Node: Augmented assignment statements,  Next: Annotated assignment statements,  Up: Assignment statements

4.7.2.1 Augmented assignment statements
.......................................

Augmented assignment is the combination, in a single statement, of a
binary operation and an assignment statement:

     augmented_assignment_stmt ::= augtarget augop (expression_list | yield_expression)
     augtarget                 ::= identifier | attributeref | subscription | slicing
     augop                     ::= "+=" | "-=" | "*=" | "@=" | "/=" | "//=" | "%=" | "**="
                                   | ">>=" | "<<=" | "&=" | "^=" | "|="

(See section *note Primaries: 144f. for the syntax definitions of the
last three symbols.)

An augmented assignment evaluates the target (which, unlike normal
assignment statements, cannot be an unpacking) and the expression list,
performs the binary operation specific to the type of assignment on the
two operands, and assigns the result to the original target.  The target
is only evaluated once.

An augmented assignment expression like ‘x += 1’ can be rewritten as ‘x
= x + 1’ to achieve a similar, but not exactly equal effect.  In the
augmented version, ‘x’ is only evaluated once.  Also, when possible, the
actual operation is performed `in-place', meaning that rather than
creating a new object and assigning that to the target, the old object
is modified instead.

Unlike normal assignments, augmented assignments evaluate the left-hand
side `before' evaluating the right-hand side.  For example, ‘a[i] +=
f(x)’ first looks-up ‘a[i]’, then it evaluates ‘f(x)’ and performs the
addition, and lastly, it writes the result back to ‘a[i]’.

With the exception of assigning to tuples and multiple targets in a
single statement, the assignment done by augmented assignment statements
is handled the same way as normal assignments.  Similarly, with the
exception of the possible `in-place' behavior, the binary operation
performed by augmented assignment is the same as the normal binary
operations.

For targets which are attribute references, the same *note caveat about
class and instance attributes: 14ac. applies as for regular assignments.


File: python.info,  Node: Annotated assignment statements,  Prev: Augmented assignment statements,  Up: Assignment statements

4.7.2.2 Annotated assignment statements
.......................................

*note Annotation: 614. assignment is the combination, in a single
statement, of a variable or attribute annotation and an optional
assignment statement:

     annotated_assignment_stmt ::= augtarget ":" expression
                                   ["=" (starred_expression | yield_expression)]

The difference from normal *note Assignment statements: 14a7. is that
only single target is allowed.

For simple names as assignment targets, if in class or module scope, the
annotations are evaluated and stored in a special class or module
attribute ‘__annotations__’ that is a dictionary mapping from variable
names (mangled if private) to evaluated annotations.  This attribute is
writable and is automatically created at the start of class or module
body execution, if annotations are found statically.

For expressions as assignment targets, the annotations are evaluated if
in class or module scope, but not stored.

If a name is annotated in a function scope, then this name is local for
that scope.  Annotations are never evaluated and stored in function
scopes.

If the right hand side is present, an annotated assignment performs the
actual assignment before evaluating annotations (where applicable).  If
the right hand side is not present for an expression target, then the
interpreter evaluates the target except for the last *note
__setitem__(): c55. or *note __setattr__(): e1f. call.

See also
........

PEP 526(1) - Syntax for Variable Annotations

     The proposal that added syntax for annotating the types of
     variables (including class variables and instance variables),
     instead of expressing them through comments.

PEP 484(2) - Type hints

     The proposal that added the *note typing: 119. module to provide a
     standard syntax for type annotations that can be used in static
     analysis tools and IDEs.

Changed in version 3.8: Now annotated assignments allow same expressions
in the right hand side as the regular assignments.  Previously, some
expressions (like un-parenthesized tuple expressions) caused a syntax
error.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0526

   (2) https://www.python.org/dev/peps/pep-0484


File: python.info,  Node: The assert statement,  Next: The pass statement,  Prev: Assignment statements,  Up: Simple statements

4.7.3 The ‘assert’ statement
----------------------------

Assert statements are a convenient way to insert debugging assertions
into a program:

     assert_stmt ::= "assert" expression ["," expression]

The simple form, ‘assert expression’, is equivalent to

     if __debug__:
         if not expression: raise AssertionError

The extended form, ‘assert expression1, expression2’, is equivalent to

     if __debug__:
         if not expression1: raise AssertionError(expression2)

These equivalences assume that *note __debug__: f30. and *note
AssertionError: f66. refer to the built-in variables with those names.
In the current implementation, the built-in variable *note __debug__:
f30. is ‘True’ under normal circumstances, ‘False’ when optimization is
requested (command line option *note -O: 67f.).  The current code
generator emits no code for an assert statement when optimization is
requested at compile time.  Note that it is unnecessary to include the
source code for the expression that failed in the error message; it will
be displayed as part of the stack trace.

Assignments to *note __debug__: f30. are illegal.  The value for the
built-in variable is determined when the interpreter starts.


File: python.info,  Node: The pass statement,  Next: The del statement<2>,  Prev: The assert statement,  Up: Simple statements

4.7.4 The ‘pass’ statement
--------------------------

     pass_stmt ::= "pass"

*note pass: 117a. is a null operation — when it is executed, nothing
happens.  It is useful as a placeholder when a statement is required
syntactically, but no code needs to be executed, for example:

     def f(arg): pass    # a function that does nothing (yet)

     class C: pass       # a class with no methods (yet)


File: python.info,  Node: The del statement<2>,  Next: The return statement,  Prev: The pass statement,  Up: Simple statements

4.7.5 The ‘del’ statement
-------------------------

     del_stmt ::= "del" target_list

Deletion is recursively defined very similar to the way assignment is
defined.  Rather than spelling it out in full details, here are some
hints.

Deletion of a target list recursively deletes each target, from left to
right.

Deletion of a name removes the binding of that name from the local or
global namespace, depending on whether the name occurs in a *note
global: 117e. statement in the same code block.  If the name is unbound,
a *note NameError: d6e. exception will be raised.

Deletion of attribute references, subscriptions and slicings is passed
to the primary object involved; deletion of a slicing is in general
equivalent to assignment of an empty slice of the right type (but even
this is determined by the sliced object).

Changed in version 3.2: Previously it was illegal to delete a name from
the local namespace if it occurs as a free variable in a nested block.


File: python.info,  Node: The return statement,  Next: The yield statement,  Prev: The del statement<2>,  Up: Simple statements

4.7.6 The ‘return’ statement
----------------------------

     return_stmt ::= "return" [expression_list]

*note return: 190. may only occur syntactically nested in a function
definition, not within a nested class definition.

If an expression list is present, it is evaluated, else ‘None’ is
substituted.

*note return: 190. leaves the current function call with the expression
list (or ‘None’) as return value.

When *note return: 190. passes control out of a *note try: d65.
statement with a *note finally: 182. clause, that ‘finally’ clause is
executed before really leaving the function.

In a generator function, the *note return: 190. statement indicates that
the generator is done and will cause *note StopIteration: 47b. to be
raised.  The returned value (if any) is used as an argument to construct
*note StopIteration: 47b. and becomes the ‘StopIteration.value’
attribute.

In an asynchronous generator function, an empty *note return: 190.
statement indicates that the asynchronous generator is done and will
cause *note StopAsyncIteration: f49. to be raised.  A non-empty ‘return’
statement is a syntax error in an asynchronous generator function.


File: python.info,  Node: The yield statement,  Next: The raise statement,  Prev: The return statement,  Up: Simple statements

4.7.7 The ‘yield’ statement
---------------------------

     yield_stmt ::= yield_expression

A *note yield: 18f. statement is semantically equivalent to a *note
yield expression: 143e.  The yield statement can be used to omit the
parentheses that would otherwise be required in the equivalent yield
expression statement.  For example, the yield statements

     yield <expr>
     yield from <expr>

are equivalent to the yield expression statements

     (yield <expr>)
     (yield from <expr>)

Yield expressions and statements are only used when defining a *note
generator: 996. function, and are only used in the body of the generator
function.  Using yield in a function definition is sufficient to cause
that definition to create a generator function instead of a normal
function.

For full details of *note yield: 18f. semantics, refer to the *note
Yield expressions: 143e. section.


File: python.info,  Node: The raise statement,  Next: The break statement,  Prev: The yield statement,  Up: Simple statements

4.7.8 The ‘raise’ statement
---------------------------

     raise_stmt ::= "raise" [expression ["from" expression]]

If no expressions are present, *note raise: c35. re-raises the last
exception that was active in the current scope.  If no exception is
active in the current scope, a *note RuntimeError: 2b8. exception is
raised indicating that this is an error.

Otherwise, *note raise: c35. evaluates the first expression as the
exception object.  It must be either a subclass or an instance of *note
BaseException: 1a7.  If it is a class, the exception instance will be
obtained when needed by instantiating the class with no arguments.

The `type' of the exception is the exception instance’s class, the
`value' is the instance itself.

A traceback object is normally created automatically when an exception
is raised and attached to it as the ‘__traceback__’ attribute, which is
writable.  You can create an exception and set your own traceback in one
step using the ‘with_traceback()’ exception method (which returns the
same exception instance, with its traceback set to its argument), like
so:

     raise Exception("foo occurred").with_traceback(tracebackobj)

The ‘from’ clause is used for exception chaining: if given, the second
`expression' must be another exception class or instance, which will
then be attached to the raised exception as the ‘__cause__’ attribute
(which is writable).  If the raised exception is not handled, both
exceptions will be printed:

     >>> try:
     ...     print(1 / 0)
     ... except Exception as exc:
     ...     raise RuntimeError("Something bad happened") from exc
     ...
     Traceback (most recent call last):
       File "<stdin>", line 2, in <module>
     ZeroDivisionError: division by zero

     The above exception was the direct cause of the following exception:

     Traceback (most recent call last):
       File "<stdin>", line 4, in <module>
     RuntimeError: Something bad happened

A similar mechanism works implicitly if an exception is raised inside an
exception handler or a *note finally: 182. clause: the previous
exception is then attached as the new exception’s ‘__context__’
attribute:

     >>> try:
     ...     print(1 / 0)
     ... except:
     ...     raise RuntimeError("Something bad happened")
     ...
     Traceback (most recent call last):
       File "<stdin>", line 2, in <module>
     ZeroDivisionError: division by zero

     During handling of the above exception, another exception occurred:

     Traceback (most recent call last):
       File "<stdin>", line 4, in <module>
     RuntimeError: Something bad happened

Exception chaining can be explicitly suppressed by specifying *note
None: 157. in the ‘from’ clause:

     >>> try:
     ...     print(1 / 0)
     ... except:
     ...     raise RuntimeError("Something bad happened") from None
     ...
     Traceback (most recent call last):
       File "<stdin>", line 4, in <module>
     RuntimeError: Something bad happened

Additional information on exceptions can be found in section *note
Exceptions: 13e5, and information about handling exceptions is in
section *note The try statement: d65.

Changed in version 3.3: *note None: 157. is now permitted as ‘Y’ in
‘raise X from Y’.

New in version 3.3: The ‘__suppress_context__’ attribute to suppress
automatic display of the exception context.


File: python.info,  Node: The break statement,  Next: The continue statement,  Prev: The raise statement,  Up: Simple statements

4.7.9 The ‘break’ statement
---------------------------

     break_stmt ::= "break"

*note break: 2d9. may only occur syntactically nested in a *note for:
c23. or *note while: 1167. loop, but not nested in a function or class
definition within that loop.

It terminates the nearest enclosing loop, skipping the optional ‘else’
clause if the loop has one.

If a *note for: c23. loop is terminated by *note break: 2d9, the loop
control target keeps its current value.

When *note break: 2d9. passes control out of a *note try: d65. statement
with a *note finally: 182. clause, that ‘finally’ clause is executed
before really leaving the loop.


File: python.info,  Node: The continue statement,  Next: The import statement,  Prev: The break statement,  Up: Simple statements

4.7.10 The ‘continue’ statement
-------------------------------

     continue_stmt ::= "continue"

*note continue: 181. may only occur syntactically nested in a *note for:
c23. or *note while: 1167. loop, but not nested in a function or class
definition within that loop.  It continues with the next cycle of the
nearest enclosing loop.

When *note continue: 181. passes control out of a *note try: d65.
statement with a *note finally: 182. clause, that ‘finally’ clause is
executed before really starting the next loop cycle.


File: python.info,  Node: The import statement,  Next: The global statement,  Prev: The continue statement,  Up: Simple statements

4.7.11 The ‘import’ statement
-----------------------------

     import_stmt     ::= "import" module ["as" identifier] ("," module ["as" identifier])*
                         | "from" relative_module "import" identifier ["as" identifier]
                         ("," identifier ["as" identifier])*
                         | "from" relative_module "import" "(" identifier ["as" identifier]
                         ("," identifier ["as" identifier])* [","] ")"
                         | "from" module "import" "*"
     module          ::= (identifier ".")* identifier
     relative_module ::= "."* module | "."+

The basic import statement (no *note from: c38. clause) is executed in
two steps:

  1. find a module, loading and initializing it if necessary

  2. define a name or names in the local namespace for the scope where
     the *note import: c10. statement occurs.

When the statement contains multiple clauses (separated by commas) the
two steps are carried out separately for each clause, just as though the
clauses had been separated out into individual import statements.

The details of the first step, finding and loading modules are described
in greater detail in the section on the *note import system: 136a, which
also describes the various types of packages and modules that can be
imported, as well as all the hooks that can be used to customize the
import system.  Note that failures in this step may indicate either that
the module could not be located, `or' that an error occurred while
initializing the module, which includes execution of the module’s code.

If the requested module is retrieved successfully, it will be made
available in the local namespace in one of three ways:

   * If the module name is followed by ‘as’, then the name following
     ‘as’ is bound directly to the imported module.

   * If no other name is specified, and the module being imported is a
     top level module, the module’s name is bound in the local namespace
     as a reference to the imported module

   * If the module being imported is `not' a top level module, then the
     name of the top level package that contains the module is bound in
     the local namespace as a reference to the top level package.  The
     imported module must be accessed using its full qualified name
     rather than directly

The *note from: c38. form uses a slightly more complex process:

  1. find the module specified in the *note from: c38. clause, loading
     and initializing it if necessary;

  2. for each of the identifiers specified in the *note import: c10.
     clauses:

       1. check if the imported module has an attribute by that name

       2. if not, attempt to import a submodule with that name and then
          check the imported module again for that attribute

       3. if the attribute is not found, *note ImportError: 329. is
          raised.

       4. otherwise, a reference to that value is stored in the local
          namespace, using the name in the ‘as’ clause if it is present,
          otherwise using the attribute name

Examples:

     import foo                 # foo imported and bound locally
     import foo.bar.baz         # foo.bar.baz imported, foo bound locally
     import foo.bar.baz as fbb  # foo.bar.baz imported and bound as fbb
     from foo.bar import baz    # foo.bar.baz imported and bound as baz
     from foo import attr       # foo imported and foo.attr bound as attr

If the list of identifiers is replaced by a star (‘'*'’), all public
names defined in the module are bound in the local namespace for the
scope where the *note import: c10. statement occurs.

The `public names' defined by a module are determined by checking the
module’s namespace for a variable named ‘__all__’; if defined, it must
be a sequence of strings which are names defined or imported by that
module.  The names given in ‘__all__’ are all considered public and are
required to exist.  If ‘__all__’ is not defined, the set of public names
includes all names found in the module’s namespace which do not begin
with an underscore character (‘'_'’).  ‘__all__’ should contain the
entire public API. It is intended to avoid accidentally exporting items
that are not part of the API (such as library modules which were
imported and used within the module).

The wild card form of import — ‘from module import *’ — is only allowed
at the module level.  Attempting to use it in class or function
definitions will raise a *note SyntaxError: 44d.

When specifying what module to import you do not have to specify the
absolute name of the module.  When a module or package is contained
within another package it is possible to make a relative import within
the same top package without having to mention the package name.  By
using leading dots in the specified module or package after *note from:
c38. you can specify how high to traverse up the current package
hierarchy without specifying exact names.  One leading dot means the
current package where the module making the import exists.  Two dots
means up one package level.  Three dots is up two levels, etc.  So if
you execute ‘from . import mod’ from a module in the ‘pkg’ package then
you will end up importing ‘pkg.mod’.  If you execute ‘from ..subpkg2
import mod’ from within ‘pkg.subpkg1’ you will import ‘pkg.subpkg2.mod’.
The specification for relative imports is contained in the *note Package
Relative Imports: 1413. section.

*note importlib.import_module(): b06. is provided to support
applications that determine dynamically the modules to be loaded.

Raises an *note auditing event: 1275. ‘import’ with arguments ‘module’,
‘filename’, ‘sys.path’, ‘sys.meta_path’, ‘sys.path_hooks’.

* Menu:

* Future statements::


File: python.info,  Node: Future statements,  Up: The import statement

4.7.11.1 Future statements
..........................

A `future statement' is a directive to the compiler that a particular
module should be compiled using syntax or semantics that will be
available in a specified future release of Python where the feature
becomes standard.

The future statement is intended to ease migration to future versions of
Python that introduce incompatible changes to the language.  It allows
use of the new features on a per-module basis before the release in
which the feature becomes standard.

     future_stmt ::= "from" "__future__" "import" feature ["as" identifier]
                     ("," feature ["as" identifier])*
                     | "from" "__future__" "import" "(" feature ["as" identifier]
                     ("," feature ["as" identifier])* [","] ")"
     feature     ::= identifier

A future statement must appear near the top of the module.  The only
lines that can appear before a future statement are:

   * the module docstring (if any),

   * comments,

   * blank lines, and

   * other future statements.

The only feature in Python 3.7 that requires using the future statement
is ‘annotations’.

All historical features enabled by the future statement are still
recognized by Python 3.  The list includes ‘absolute_import’,
‘division’, ‘generators’, ‘generator_stop’, ‘unicode_literals’,
‘print_function’, ‘nested_scopes’ and ‘with_statement’.  They are all
redundant because they are always enabled, and only kept for backwards
compatibility.

A future statement is recognized and treated specially at compile time:
Changes to the semantics of core constructs are often implemented by
generating different code.  It may even be the case that a new feature
introduces new incompatible syntax (such as a new reserved word), in
which case the compiler may need to parse the module differently.  Such
decisions cannot be pushed off until runtime.

For any given release, the compiler knows which feature names have been
defined, and raises a compile-time error if a future statement contains
a feature not known to it.

The direct runtime semantics are the same as for any import statement:
there is a standard module *note __future__: 0, described later, and it
will be imported in the usual way at the time the future statement is
executed.

The interesting runtime semantics depend on the specific feature enabled
by the future statement.

Note that there is nothing special about the statement:

     import __future__ [as name]

That is not a future statement; it’s an ordinary import statement with
no special semantics or syntax restrictions.

Code compiled by calls to the built-in functions *note exec(): c37. and
*note compile(): 1b2. that occur in a module ‘M’ containing a future
statement will, by default, use the new syntax or semantics associated
with the future statement.  This can be controlled by optional arguments
to *note compile(): 1b2. — see the documentation of that function for
details.

A future statement typed at an interactive interpreter prompt will take
effect for the rest of the interpreter session.  If an interpreter is
started with the *note -i: e12. option, is passed a script name to
execute, and the script includes a future statement, it will be in
effect in the interactive session started after the script is executed.

See also
........

PEP 236(1) - Back to the __future__

     The original proposal for the __future__ mechanism.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0236


File: python.info,  Node: The global statement,  Next: The nonlocal statement,  Prev: The import statement,  Up: Simple statements

4.7.12 The ‘global’ statement
-----------------------------

     global_stmt ::= "global" identifier ("," identifier)*

The *note global: 117e. statement is a declaration which holds for the
entire current code block.  It means that the listed identifiers are to
be interpreted as globals.  It would be impossible to assign to a global
variable without ‘global’, although free variables may refer to globals
without being declared global.

Names listed in a *note global: 117e. statement must not be used in the
same code block textually preceding that ‘global’ statement.

Names listed in a *note global: 117e. statement must not be defined as
formal parameters or in a *note for: c23. loop control target, *note
class: c5d. definition, function definition, *note import: c10.
statement, or variable annotation.

`CPython implementation detail:' The current implementation does not
enforce some of these restrictions, but programs should not abuse this
freedom, as future implementations may enforce them or silently change
the meaning of the program.

`Programmer’s note:' *note global: 117e. is a directive to the parser.
It applies only to code parsed at the same time as the ‘global’
statement.  In particular, a ‘global’ statement contained in a string or
code object supplied to the built-in *note exec(): c37. function does
not affect the code block `containing' the function call, and code
contained in such a string is unaffected by ‘global’ statements in the
code containing the function call.  The same applies to the *note
eval(): b83. and *note compile(): 1b2. functions.


File: python.info,  Node: The nonlocal statement,  Prev: The global statement,  Up: Simple statements

4.7.13 The ‘nonlocal’ statement
-------------------------------

     nonlocal_stmt ::= "nonlocal" identifier ("," identifier)*

The *note nonlocal: c32. statement causes the listed identifiers to
refer to previously bound variables in the nearest enclosing scope
excluding globals.  This is important because the default behavior for
binding is to search the local namespace first.  The statement allows
encapsulated code to rebind variables outside of the local scope besides
the global (module) scope.

Names listed in a *note nonlocal: c32. statement, unlike those listed in
a *note global: 117e. statement, must refer to pre-existing bindings in
an enclosing scope (the scope in which a new binding should be created
cannot be determined unambiguously).

Names listed in a *note nonlocal: c32. statement must not collide with
pre-existing bindings in the local scope.

See also
........

PEP 3104(1) - Access to Names in Outer Scopes

     The specification for the *note nonlocal: c32. statement.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3104


File: python.info,  Node: Compound statements,  Next: Top-level components,  Prev: Simple statements,  Up: The Python Language Reference

4.8 Compound statements
=======================

Compound statements contain (groups of) other statements; they affect or
control the execution of those other statements in some way.  In
general, compound statements span multiple lines, although in simple
incarnations a whole compound statement may be contained in one line.

The *note if: dda, *note while: 1167. and *note for: c23. statements
implement traditional control flow constructs.  *note try: d65.
specifies exception handlers and/or cleanup code for a group of
statements, while the *note with: 6dd. statement allows the execution of
initialization and finalization code around a block of code.  Function
and class definitions are also syntactically compound statements.

A compound statement consists of one or more ‘clauses.’ A clause
consists of a header and a ‘suite.’ The clause headers of a particular
compound statement are all at the same indentation level.  Each clause
header begins with a uniquely identifying keyword and ends with a colon.
A suite is a group of statements controlled by a clause.  A suite can be
one or more semicolon-separated simple statements on the same line as
the header, following the header’s colon, or it can be one or more
indented statements on subsequent lines.  Only the latter form of a
suite can contain nested compound statements; the following is illegal,
mostly because it wouldn’t be clear to which *note if: dda. clause a
following *note else: 116e. clause would belong:

     if test1: if test2: print(x)

Also note that the semicolon binds tighter than the colon in this
context, so that in the following example, either all or none of the
*note print(): 87a. calls are executed:

     if x < y < z: print(x); print(y); print(z)

Summarizing:

     compound_stmt ::= if_stmt
                       | while_stmt
                       | for_stmt
                       | try_stmt
                       | with_stmt
                       | funcdef
                       | classdef
                       | async_with_stmt
                       | async_for_stmt
                       | async_funcdef
     suite         ::= stmt_list NEWLINE | NEWLINE INDENT statement+ DEDENT
     statement     ::= stmt_list NEWLINE | compound_stmt
     stmt_list     ::= simple_stmt (";" simple_stmt)* [";"]

Note that statements always end in a ‘NEWLINE’ possibly followed by a
‘DEDENT’.  Also note that optional continuation clauses always begin
with a keyword that cannot start a statement, thus there are no
ambiguities (the ‘dangling *note else: 116e.’ problem is solved in
Python by requiring nested *note if: dda. statements to be indented).

The formatting of the grammar rules in the following sections places
each clause on a separate line for clarity.
* Menu:

* The if statement::
* The while statement::
* The for statement::
* The try statement::
* The with statement::
* Function definitions::
* Class definitions::
* Coroutines: Coroutines<2>.


File: python.info,  Node: The if statement,  Next: The while statement,  Up: Compound statements

4.8.1 The ‘if’ statement
------------------------

The *note if: dda. statement is used for conditional execution:

     if_stmt ::= "if" expression ":" suite
                 ("elif" expression ":" suite)*
                 ["else" ":" suite]

It selects exactly one of the suites by evaluating the expressions one
by one until one is found to be true (see section *note Boolean
operations: 1487. for the definition of true and false); then that suite
is executed (and no other part of the *note if: dda. statement is
executed or evaluated).  If all expressions are false, the suite of the
*note else: 116e. clause, if present, is executed.


File: python.info,  Node: The while statement,  Next: The for statement,  Prev: The if statement,  Up: Compound statements

4.8.2 The ‘while’ statement
---------------------------

The *note while: 1167. statement is used for repeated execution as long
as an expression is true:

     while_stmt ::= "while" expression ":" suite
                    ["else" ":" suite]

This repeatedly tests the expression and, if it is true, executes the
first suite; if the expression is false (which may be the first time it
is tested) the suite of the ‘else’ clause, if present, is executed and
the loop terminates.

A *note break: 2d9. statement executed in the first suite terminates the
loop without executing the ‘else’ clause’s suite.  A *note continue:
181. statement executed in the first suite skips the rest of the suite
and goes back to testing the expression.


File: python.info,  Node: The for statement,  Next: The try statement,  Prev: The while statement,  Up: Compound statements

4.8.3 The ‘for’ statement
-------------------------

The *note for: c23. statement is used to iterate over the elements of a
sequence (such as a string, tuple or list) or other iterable object:

     for_stmt ::= "for" target_list "in" expression_list ":" suite
                  ["else" ":" suite]

The expression list is evaluated once; it should yield an iterable
object.  An iterator is created for the result of the ‘expression_list’.
The suite is then executed once for each item provided by the iterator,
in the order returned by the iterator.  Each item in turn is assigned to
the target list using the standard rules for assignments (see *note
Assignment statements: 14a7.), and then the suite is executed.  When the
items are exhausted (which is immediately when the sequence is empty or
an iterator raises a *note StopIteration: 47b. exception), the suite in
the ‘else’ clause, if present, is executed, and the loop terminates.

A *note break: 2d9. statement executed in the first suite terminates the
loop without executing the ‘else’ clause’s suite.  A *note continue:
181. statement executed in the first suite skips the rest of the suite
and continues with the next item, or with the ‘else’ clause if there is
no next item.

The for-loop makes assignments to the variables in the target list.
This overwrites all previous assignments to those variables including
those made in the suite of the for-loop:

     for i in range(10):
         print(i)
         i = 5             # this will not affect the for-loop
                           # because i will be overwritten with the next
                           # index in the range

Names in the target list are not deleted when the loop is finished, but
if the sequence is empty, they will not have been assigned to at all by
the loop.  Hint: the built-in function *note range(): 9b2. returns an
iterator of integers suitable to emulate the effect of Pascal’s ‘for i
:= a to b do’; e.g., ‘list(range(3))’ returns the list ‘[0, 1, 2]’.

     Note: 
     There is a subtlety when the sequence is being modified by the loop
     (this can only occur for mutable sequences, e.g.  lists).  An
     internal counter is used to keep track of which item is used next,
     and this is incremented on each iteration.  When this counter has
     reached the length of the sequence the loop terminates.  This means
     that if the suite deletes the current (or a previous) item from the
     sequence, the next item will be skipped (since it gets the index of
     the current item which has already been treated).  Likewise, if the
     suite inserts an item in the sequence before the current item, the
     current item will be treated again the next time through the loop.
     This can lead to nasty bugs that can be avoided by making a
     temporary copy using a slice of the whole sequence, e.g.,

          for x in a[:]:
              if x < 0: a.remove(x)


File: python.info,  Node: The try statement,  Next: The with statement,  Prev: The for statement,  Up: Compound statements

4.8.4 The ‘try’ statement
-------------------------

The *note try: d65. statement specifies exception handlers and/or
cleanup code for a group of statements:

     try_stmt  ::= try1_stmt | try2_stmt
     try1_stmt ::= "try" ":" suite
                   ("except" [expression ["as" identifier]] ":" suite)+
                   ["else" ":" suite]
                   ["finally" ":" suite]
     try2_stmt ::= "try" ":" suite
                   "finally" ":" suite

The *note except: b31. clause(s) specify one or more exception handlers.
When no exception occurs in the *note try: d65. clause, no exception
handler is executed.  When an exception occurs in the ‘try’ suite, a
search for an exception handler is started.  This search inspects the
except clauses in turn until one is found that matches the exception.
An expression-less except clause, if present, must be last; it matches
any exception.  For an except clause with an expression, that expression
is evaluated, and the clause matches the exception if the resulting
object is “compatible” with the exception.  An object is compatible with
an exception if it is the class or a base class of the exception object
or a tuple containing an item compatible with the exception.

If no except clause matches the exception, the search for an exception
handler continues in the surrounding code and on the invocation stack.
(1)

If the evaluation of an expression in the header of an except clause
raises an exception, the original search for a handler is canceled and a
search starts for the new exception in the surrounding code and on the
call stack (it is treated as if the entire *note try: d65. statement
raised the exception).

When a matching except clause is found, the exception is assigned to the
target specified after the ‘as’ keyword in that except clause, if
present, and the except clause’s suite is executed.  All except clauses
must have an executable block.  When the end of this block is reached,
execution continues normally after the entire try statement.  (This
means that if two nested handlers exist for the same exception, and the
exception occurs in the try clause of the inner handler, the outer
handler will not handle the exception.)

When an exception has been assigned using ‘as target’, it is cleared at
the end of the except clause.  This is as if

     except E as N:
         foo

was translated to

     except E as N:
         try:
             foo
         finally:
             del N

This means the exception must be assigned to a different name to be able
to refer to it after the except clause.  Exceptions are cleared because
with the traceback attached to them, they form a reference cycle with
the stack frame, keeping all locals in that frame alive until the next
garbage collection occurs.

Before an except clause’s suite is executed, details about the exception
are stored in the *note sys: fd. module and can be accessed via *note
sys.exc_info(): c52.  *note sys.exc_info(): c52. returns a 3-tuple
consisting of the exception class, the exception instance and a
traceback object (see section *note The standard type hierarchy: 135c.)
identifying the point in the program where the exception occurred.
*note sys.exc_info(): c52. values are restored to their previous values
(before the call) when returning from a function that handled an
exception.

The optional ‘else’ clause is executed if the control flow leaves the
*note try: d65. suite, no exception was raised, and no *note return:
190, *note continue: 181, or *note break: 2d9. statement was executed.
Exceptions in the ‘else’ clause are not handled by the preceding *note
except: b31. clauses.

If *note finally: 182. is present, it specifies a ‘cleanup’ handler.
The *note try: d65. clause is executed, including any *note except: b31.
and ‘else’ clauses.  If an exception occurs in any of the clauses and is
not handled, the exception is temporarily saved.  The ‘finally’ clause
is executed.  If there is a saved exception it is re-raised at the end
of the ‘finally’ clause.  If the ‘finally’ clause raises another
exception, the saved exception is set as the context of the new
exception.  If the ‘finally’ clause executes a *note return: 190, *note
break: 2d9. or *note continue: 181. statement, the saved exception is
discarded:

     >>> def f():
     ...     try:
     ...         1/0
     ...     finally:
     ...         return 42
     ...
     >>> f()
     42

The exception information is not available to the program during
execution of the *note finally: 182. clause.

When a *note return: 190, *note break: 2d9. or *note continue: 181.
statement is executed in the *note try: d65. suite of a ‘try’…‘finally’
statement, the *note finally: 182. clause is also executed ‘on the way
out.’

The return value of a function is determined by the last *note return:
190. statement executed.  Since the *note finally: 182. clause always
executes, a ‘return’ statement executed in the ‘finally’ clause will
always be the last one executed:

     >>> def foo():
     ...     try:
     ...         return 'try'
     ...     finally:
     ...         return 'finally'
     ...
     >>> foo()
     'finally'

Additional information on exceptions can be found in section *note
Exceptions: 13e5, and information on using the *note raise: c35.
statement to generate exceptions may be found in section *note The raise
statement: c35.

Changed in version 3.8: Prior to Python 3.8, a *note continue: 181.
statement was illegal in the *note finally: 182. clause due to a problem
with the implementation.

   ---------- Footnotes ----------

   (1) (1) The exception is propagated to the invocation stack unless
there is a *note finally: 182. clause which happens to raise another
exception.  That new exception causes the old one to be lost.


File: python.info,  Node: The with statement,  Next: Function definitions,  Prev: The try statement,  Up: Compound statements

4.8.5 The ‘with’ statement
--------------------------

The *note with: 6dd. statement is used to wrap the execution of a block
with methods defined by a context manager (see section *note With
Statement Context Managers: 13c2.).  This allows common *note try:
d65.…*note except: b31.…*note finally: 182. usage patterns to be
encapsulated for convenient reuse.

     with_stmt ::= "with" with_item ("," with_item)* ":" suite
     with_item ::= expression ["as" target]

The execution of the *note with: 6dd. statement with one “item” proceeds
as follows:

  1. The context expression (the expression given in the *note
     with_item: 14e5.) is evaluated to obtain a context manager.

  2. The context manager’s *note __exit__(): c89. is loaded for later
     use.

  3. The context manager’s *note __enter__(): c88. method is invoked.

  4. If a target was included in the *note with: 6dd. statement, the
     return value from *note __enter__(): c88. is assigned to it.

          Note: The *note with: 6dd. statement guarantees that if the
          *note __enter__(): c88. method returns without an error, then
          *note __exit__(): c89. will always be called.  Thus, if an
          error occurs during the assignment to the target list, it will
          be treated the same as an error occurring within the suite
          would be.  See step 6 below.

  5. The suite is executed.

  6. The context manager’s *note __exit__(): c89. method is invoked.  If
     an exception caused the suite to be exited, its type, value, and
     traceback are passed as arguments to *note __exit__(): c89.
     Otherwise, three *note None: 157. arguments are supplied.

     If the suite was exited due to an exception, and the return value
     from the *note __exit__(): c89. method was false, the exception is
     reraised.  If the return value was true, the exception is
     suppressed, and execution continues with the statement following
     the *note with: 6dd. statement.

     If the suite was exited for any reason other than an exception, the
     return value from *note __exit__(): c89. is ignored, and execution
     proceeds at the normal location for the kind of exit that was
     taken.

With more than one item, the context managers are processed as if
multiple *note with: 6dd. statements were nested:

     with A() as a, B() as b:
         suite

is equivalent to

     with A() as a:
         with B() as b:
             suite

Changed in version 3.1: Support for multiple context expressions.

See also
........

PEP 343(1) - The “with” statement

     The specification, background, and examples for the Python *note
     with: 6dd. statement.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0343


File: python.info,  Node: Function definitions,  Next: Class definitions,  Prev: The with statement,  Up: Compound statements

4.8.6 Function definitions
--------------------------

A function definition defines a user-defined function object (see
section *note The standard type hierarchy: 135c.):

     funcdef                   ::= [decorators] "def" funcname "(" [parameter_list] ")"
                                   ["->" expression] ":" suite
     decorators                ::= decorator+
     decorator                 ::= "@" dotted_name ["(" [argument_list [","]] ")"] NEWLINE
     dotted_name               ::= identifier ("." identifier)*
     parameter_list            ::= defparameter ("," defparameter)* "," "/" ["," [parameter_list_no_posonly]]
                                     | parameter_list_no_posonly
     parameter_list_no_posonly ::= defparameter ("," defparameter)* ["," [parameter_list_starargs]]
                                   | parameter_list_starargs
     parameter_list_starargs   ::= "*" [parameter] ("," defparameter)* ["," ["**" parameter [","]]]
                                   | "**" parameter [","]
     parameter                 ::= identifier [":" expression]
     defparameter              ::= parameter ["=" expression]
     funcname                  ::= identifier

A function definition is an executable statement.  Its execution binds
the function name in the current local namespace to a function object (a
wrapper around the executable code for the function).  This function
object contains a reference to the current global namespace as the
global namespace to be used when the function is called.

The function definition does not execute the function body; this gets
executed only when the function is called.  (1)

A function definition may be wrapped by one or more *note decorator:
281. expressions.  Decorator expressions are evaluated when the function
is defined, in the scope that contains the function definition.  The
result must be a callable, which is invoked with the function object as
the only argument.  The returned value is bound to the function name
instead of the function object.  Multiple decorators are applied in
nested fashion.  For example, the following code

     @f1(arg)
     @f2
     def func(): pass

is roughly equivalent to

     def func(): pass
     func = f1(arg)(f2(func))

except that the original function is not temporarily bound to the name
‘func’.

When one or more *note parameters: 1469. have the form `parameter' ‘=’
`expression', the function is said to have “default parameter values.”
For a parameter with a default value, the corresponding *note argument:
1462. may be omitted from a call, in which case the parameter’s default
value is substituted.  If a parameter has a default value, all following
parameters up until the “‘*’” must also have a default value — this is a
syntactic restriction that is not expressed by the grammar.

`Default parameter values are evaluated from left to right when the
function definition is executed.'  This means that the expression is
evaluated once, when the function is defined, and that the same
“pre-computed” value is used for each call.  This is especially
important to understand when a default parameter is a mutable object,
such as a list or a dictionary: if the function modifies the object
(e.g.  by appending an item to a list), the default value is in effect
modified.  This is generally not what was intended.  A way around this
is to use ‘None’ as the default, and explicitly test for it in the body
of the function, e.g.:

     def whats_on_the_telly(penguin=None):
         if penguin is None:
             penguin = []
         penguin.append("property of the zoo")
         return penguin

Function call semantics are described in more detail in section *note
Calls: 640.  A function call always assigns values to all parameters
mentioned in the parameter list, either from position arguments, from
keyword arguments, or from default values.  If the form “‘*identifier’”
is present, it is initialized to a tuple receiving any excess positional
parameters, defaulting to the empty tuple.  If the form “‘**identifier’”
is present, it is initialized to a new ordered mapping receiving any
excess keyword arguments, defaulting to a new empty mapping of the same
type.  Parameters after “‘*’” or “‘*identifier’” are keyword-only
parameters and may only be passed used keyword arguments.

Parameters may have an *note annotation: 1197. of the form “‘:
expression’” following the parameter name.  Any parameter may have an
annotation, even those of the form ‘*identifier’ or ‘**identifier’.
Functions may have “return” annotation of the form “‘-> expression’”
after the parameter list.  These annotations can be any valid Python
expression.  The presence of annotations does not change the semantics
of a function.  The annotation values are available as values of a
dictionary keyed by the parameters’ names in the ‘__annotations__’
attribute of the function object.  If the ‘annotations’ import from
*note __future__: 0. is used, annotations are preserved as strings at
runtime which enables postponed evaluation.  Otherwise, they are
evaluated when the function definition is executed.  In this case
annotations may be evaluated in a different order than they appear in
the source code.

It is also possible to create anonymous functions (functions not bound
to a name), for immediate use in expressions.  This uses lambda
expressions, described in section *note Lambdas: c22.  Note that the
lambda expression is merely a shorthand for a simplified function
definition; a function defined in a “*note def: db1.” statement can be
passed around or assigned to another name just like a function defined
by a lambda expression.  The “‘def’” form is actually more powerful
since it allows the execution of multiple statements and annotations.

`Programmer’s note:' Functions are first-class objects.  A “‘def’”
statement executed inside a function definition defines a local function
that can be returned or passed around.  Free variables used in the
nested function can access the local variables of the function
containing the def.  See section *note Naming and binding: 13db. for
details.

See also
........

PEP 3107(2) - Function Annotations

     The original specification for function annotations.

PEP 484(3) - Type Hints

     Definition of a standard meaning for annotations: type hints.

PEP 526(4) - Syntax for Variable Annotations

     Ability to type hint variable declarations, including class
     variables and instance variables

PEP 563(5) - Postponed Evaluation of Annotations

     Support for forward references within annotations by preserving
     annotations in a string form at runtime instead of eager
     evaluation.

   ---------- Footnotes ----------

   (1) (2) A string literal appearing as the first statement in the
function body is transformed into the function’s ‘__doc__’ attribute and
therefore the function’s *note docstring: 14f1.

   (2) https://www.python.org/dev/peps/pep-3107

   (3) https://www.python.org/dev/peps/pep-0484

   (4) https://www.python.org/dev/peps/pep-0526

   (5) https://www.python.org/dev/peps/pep-0563


File: python.info,  Node: Class definitions,  Next: Coroutines<2>,  Prev: Function definitions,  Up: Compound statements

4.8.7 Class definitions
-----------------------

A class definition defines a class object (see section *note The
standard type hierarchy: 135c.):

     classdef    ::= [decorators] "class" classname [inheritance] ":" suite
     inheritance ::= "(" [argument_list] ")"
     classname   ::= identifier

A class definition is an executable statement.  The inheritance list
usually gives a list of base classes (see *note Metaclasses: 1384. for
more advanced uses), so each item in the list should evaluate to a class
object which allows subclassing.  Classes without an inheritance list
inherit, by default, from the base class *note object: 2ae.; hence,

     class Foo:
         pass

is equivalent to

     class Foo(object):
         pass

The class’s suite is then executed in a new execution frame (see *note
Naming and binding: 13db.), using a newly created local namespace and
the original global namespace.  (Usually, the suite contains mostly
function definitions.)  When the class’s suite finishes execution, its
execution frame is discarded but its local namespace is saved.  (1) A
class object is then created using the inheritance list for the base
classes and the saved local namespace for the attribute dictionary.  The
class name is bound to this class object in the original local
namespace.

The order in which attributes are defined in the class body is preserved
in the new class’s ‘__dict__’.  Note that this is reliable only right
after the class is created and only for classes that were defined using
the definition syntax.

Class creation can be customized heavily using *note metaclasses: 1384.

Classes can also be decorated: just like when decorating functions,

     @f1(arg)
     @f2
     class Foo: pass

is roughly equivalent to

     class Foo: pass
     Foo = f1(arg)(f2(Foo))

The evaluation rules for the decorator expressions are the same as for
function decorators.  The result is then bound to the class name.

`Programmer’s note:' Variables defined in the class definition are class
attributes; they are shared by instances.  Instance attributes can be
set in a method with ‘self.name = value’.  Both class and instance
attributes are accessible through the notation “‘self.name’”, and an
instance attribute hides a class attribute with the same name when
accessed in this way.  Class attributes can be used as defaults for
instance attributes, but using mutable values there can lead to
unexpected results.  *note Descriptors: 4de. can be used to create
instance variables with different implementation details.

See also
........

PEP 3115(2) - Metaclasses in Python 3000

     The proposal that changed the declaration of metaclasses to the
     current syntax, and the semantics for how classes with metaclasses
     are constructed.

PEP 3129(3) - Class Decorators

     The proposal that added class decorators.  Function and method
     decorators were introduced in PEP 318(4).

   ---------- Footnotes ----------

   (1) (3) A string literal appearing as the first statement in the
class body is transformed into the namespace’s ‘__doc__’ item and
therefore the class’s *note docstring: 14f1.

   (2) https://www.python.org/dev/peps/pep-3115

   (3) https://www.python.org/dev/peps/pep-3129

   (4) https://www.python.org/dev/peps/pep-0318


File: python.info,  Node: Coroutines<2>,  Prev: Class definitions,  Up: Compound statements

4.8.8 Coroutines
----------------

New in version 3.5.

* Menu:

* Coroutine function definition::
* The async for statement::
* The async with statement::


File: python.info,  Node: Coroutine function definition,  Next: The async for statement,  Up: Coroutines<2>

4.8.8.1 Coroutine function definition
.....................................

     async_funcdef ::= [decorators] "async" "def" funcname "(" [parameter_list] ")"
                       ["->" expression] ":" suite

Execution of Python coroutines can be suspended and resumed at many
points (see *note coroutine: 1a5.).  Inside the body of a coroutine
function, ‘await’ and ‘async’ identifiers become reserved keywords;
*note await: 1a2. expressions, *note async for: 2e1. and *note async
with: 637. can only be used in coroutine function bodies.

Functions defined with ‘async def’ syntax are always coroutine
functions, even if they do not contain ‘await’ or ‘async’ keywords.

It is a *note SyntaxError: 44d. to use a ‘yield from’ expression inside
the body of a coroutine function.

An example of a coroutine function:

     async def func(param1, param2):
         do_stuff()
         await some_coroutine()


File: python.info,  Node: The async for statement,  Next: The async with statement,  Prev: Coroutine function definition,  Up: Coroutines<2>

4.8.8.2 The ‘async for’ statement
.................................

     async_for_stmt ::= "async" for_stmt

An *note asynchronous iterable: 634. is able to call asynchronous code
in its `iter' implementation, and *note asynchronous iterator: 639. can
call asynchronous code in its `next' method.

The ‘async for’ statement allows convenient iteration over asynchronous
iterators.

The following code:

     async for TARGET in ITER:
         BLOCK
     else:
         BLOCK2

Is semantically equivalent to:

     iter = (ITER)
     iter = type(iter).__aiter__(iter)
     running = True
     while running:
         try:
             TARGET = await type(iter).__anext__(iter)
         except StopAsyncIteration:
             running = False
         else:
             BLOCK
     else:
         BLOCK2

See also *note __aiter__(): 47c. and *note __anext__(): 13d1. for
details.

It is a *note SyntaxError: 44d. to use an ‘async for’ statement outside
the body of a coroutine function.


File: python.info,  Node: The async with statement,  Prev: The async for statement,  Up: Coroutines<2>

4.8.8.3 The ‘async with’ statement
..................................

     async_with_stmt ::= "async" with_stmt

An *note asynchronous context manager: 635. is a *note context manager:
55d. that is able to suspend execution in its `enter' and `exit'
methods.

The following code:

     async with EXPR as VAR:
         BLOCK

Is semantically equivalent to:

     mgr = (EXPR)
     aexit = type(mgr).__aexit__
     aenter = type(mgr).__aenter__(mgr)

     VAR = await aenter
     try:
         BLOCK
     except:
         if not await aexit(mgr, *sys.exc_info()):
             raise
     else:
         await aexit(mgr, None, None, None)

See also *note __aenter__(): 13d4. and *note __aexit__(): 13d5. for
details.

It is a *note SyntaxError: 44d. to use an ‘async with’ statement outside
the body of a coroutine function.

See also
........

PEP 492(1) - Coroutines with async and await syntax

     The proposal that made coroutines a proper standalone concept in
     Python, and added supporting syntax.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0492


File: python.info,  Node: Top-level components,  Next: Full Grammar specification,  Prev: Compound statements,  Up: The Python Language Reference

4.9 Top-level components
========================

The Python interpreter can get its input from a number of sources: from
a script passed to it as standard input or as program argument, typed in
interactively, from a module source file, etc.  This chapter gives the
syntax used in these cases.

* Menu:

* Complete Python programs::
* File input::
* Interactive input::
* Expression input::


File: python.info,  Node: Complete Python programs,  Next: File input,  Up: Top-level components

4.9.1 Complete Python programs
------------------------------

While a language specification need not prescribe how the language
interpreter is invoked, it is useful to have a notion of a complete
Python program.  A complete Python program is executed in a minimally
initialized environment: all built-in and standard modules are
available, but none have been initialized, except for *note sys: fd.
(various system services), *note builtins: 13. (built-in functions,
exceptions and ‘None’) and *note __main__: 1.  The latter is used to
provide the local and global namespace for execution of the complete
program.

The syntax for a complete Python program is that for file input,
described in the next section.

The interpreter may also be invoked in interactive mode; in this case,
it does not read and execute a complete program but reads and executes
one statement (possibly compound) at a time.  The initial environment is
identical to that of a complete program; each statement is executed in
the namespace of *note __main__: 1.

A complete program can be passed to the interpreter in three forms: with
the *note -c: 1145. `string' command line option, as a file passed as
the first command line argument, or as standard input.  If the file or
standard input is a tty device, the interpreter enters interactive mode;
otherwise, it executes the file as a complete program.


File: python.info,  Node: File input,  Next: Interactive input,  Prev: Complete Python programs,  Up: Top-level components

4.9.2 File input
----------------

All input read from non-interactive files has the same form:

     file_input ::= (NEWLINE | statement)*

This syntax is used in the following situations:

   * when parsing a complete Python program (from a file or from a
     string);

   * when parsing a module;

   * when parsing a string passed to the *note exec(): c37. function;


File: python.info,  Node: Interactive input,  Next: Expression input,  Prev: File input,  Up: Top-level components

4.9.3 Interactive input
-----------------------

Input in interactive mode is parsed using the following grammar:

     interactive_input ::= [stmt_list] NEWLINE | compound_stmt NEWLINE

Note that a (top-level) compound statement must be followed by a blank
line in interactive mode; this is needed to help the parser detect the
end of the input.


File: python.info,  Node: Expression input,  Prev: Interactive input,  Up: Top-level components

4.9.4 Expression input
----------------------

*note eval(): b83. is used for expression input.  It ignores leading
whitespace.  The string argument to *note eval(): b83. must have the
following form:

     eval_input ::= expression_list NEWLINE*


File: python.info,  Node: Full Grammar specification,  Prev: Top-level components,  Up: The Python Language Reference

4.10 Full Grammar specification
===============================

This is the full Python grammar, as it is read by the parser generator
and used to parse Python source files:

     # Grammar for Python

     # NOTE WELL: You should also follow all the steps listed at
     # https://devguide.python.org/grammar/

     # Start symbols for the grammar:
     #       single_input is a single interactive statement;
     #       file_input is a module or sequence of commands read from an input file;
     #       eval_input is the input for the eval() functions.
     #       func_type_input is a PEP 484 Python 2 function type comment
     # NB: compound_stmt in single_input is followed by extra NEWLINE!
     # NB: due to the way TYPE_COMMENT is tokenized it will always be followed by a NEWLINE
     single_input: NEWLINE | simple_stmt | compound_stmt NEWLINE
     file_input: (NEWLINE | stmt)* ENDMARKER
     eval_input: testlist NEWLINE* ENDMARKER

     decorator: '@' dotted_name [ '(' [arglist] ')' ] NEWLINE
     decorators: decorator+
     decorated: decorators (classdef | funcdef | async_funcdef)

     async_funcdef: ASYNC funcdef
     funcdef: 'def' NAME parameters ['->' test] ':' [TYPE_COMMENT] func_body_suite

     parameters: '(' [typedargslist] ')'

     # The following definition for typedarglist is equivalent to this set of rules:
     #
     #     arguments = argument (',' [TYPE_COMMENT] argument)*
     #     argument = tfpdef ['=' test]
     #     kwargs = '**' tfpdef [','] [TYPE_COMMENT]
     #     args = '*' [tfpdef]
     #     kwonly_kwargs = (',' [TYPE_COMMENT] argument)* (TYPE_COMMENT | [',' [TYPE_COMMENT] [kwargs]])
     #     args_kwonly_kwargs = args kwonly_kwargs | kwargs
     #     poskeyword_args_kwonly_kwargs = arguments ( TYPE_COMMENT | [',' [TYPE_COMMENT] [args_kwonly_kwargs]])
     #     typedargslist_no_posonly  = poskeyword_args_kwonly_kwargs | args_kwonly_kwargs
     #     typedarglist = (arguments ',' [TYPE_COMMENT] '/' [',' [[TYPE_COMMENT] typedargslist_no_posonly]])|(typedargslist_no_posonly)"
     #
     # It needs to be fully expanded to allow our LL(1) parser to work on it.

     typedargslist: (
       (tfpdef ['=' test] (',' [TYPE_COMMENT] tfpdef ['=' test])* ',' [TYPE_COMMENT] '/' [',' [ [TYPE_COMMENT] tfpdef ['=' test] (
             ',' [TYPE_COMMENT] tfpdef ['=' test])* (TYPE_COMMENT | [',' [TYPE_COMMENT] [
             '*' [tfpdef] (',' [TYPE_COMMENT] tfpdef ['=' test])* (TYPE_COMMENT | [',' [TYPE_COMMENT] ['**' tfpdef [','] [TYPE_COMMENT]]])
           | '**' tfpdef [','] [TYPE_COMMENT]]])
       | '*' [tfpdef] (',' [TYPE_COMMENT] tfpdef ['=' test])* (TYPE_COMMENT | [',' [TYPE_COMMENT] ['**' tfpdef [','] [TYPE_COMMENT]]])
       | '**' tfpdef [','] [TYPE_COMMENT]]] )
     |  (tfpdef ['=' test] (',' [TYPE_COMMENT] tfpdef ['=' test])* (TYPE_COMMENT | [',' [TYPE_COMMENT] [
        '*' [tfpdef] (',' [TYPE_COMMENT] tfpdef ['=' test])* (TYPE_COMMENT | [',' [TYPE_COMMENT] ['**' tfpdef [','] [TYPE_COMMENT]]])
       | '**' tfpdef [','] [TYPE_COMMENT]]])
       | '*' [tfpdef] (',' [TYPE_COMMENT] tfpdef ['=' test])* (TYPE_COMMENT | [',' [TYPE_COMMENT] ['**' tfpdef [','] [TYPE_COMMENT]]])
       | '**' tfpdef [','] [TYPE_COMMENT])
     )
     tfpdef: NAME [':' test]

     # The following definition for varargslist is equivalent to this set of rules:
     #
     #     arguments = argument (',' argument )*
     #     argument = vfpdef ['=' test]
     #     kwargs = '**' vfpdef [',']
     #     args = '*' [vfpdef]
     #     kwonly_kwargs = (',' argument )* [',' [kwargs]]
     #     args_kwonly_kwargs = args kwonly_kwargs | kwargs
     #     poskeyword_args_kwonly_kwargs = arguments [',' [args_kwonly_kwargs]]
     #     vararglist_no_posonly = poskeyword_args_kwonly_kwargs | args_kwonly_kwargs
     #     varargslist = arguments ',' '/' [','[(vararglist_no_posonly)]] | (vararglist_no_posonly)
     #
     # It needs to be fully expanded to allow our LL(1) parser to work on it.

     varargslist: vfpdef ['=' test ](',' vfpdef ['=' test])* ',' '/' [',' [ (vfpdef ['=' test] (',' vfpdef ['=' test])* [',' [
             '*' [vfpdef] (',' vfpdef ['=' test])* [',' ['**' vfpdef [',']]]
           | '**' vfpdef [',']]]
       | '*' [vfpdef] (',' vfpdef ['=' test])* [',' ['**' vfpdef [',']]]
       | '**' vfpdef [',']) ]] | (vfpdef ['=' test] (',' vfpdef ['=' test])* [',' [
             '*' [vfpdef] (',' vfpdef ['=' test])* [',' ['**' vfpdef [',']]]
           | '**' vfpdef [',']]]
       | '*' [vfpdef] (',' vfpdef ['=' test])* [',' ['**' vfpdef [',']]]
       | '**' vfpdef [',']
     )
     vfpdef: NAME

     stmt: simple_stmt | compound_stmt
     simple_stmt: small_stmt (';' small_stmt)* [';'] NEWLINE
     small_stmt: (expr_stmt | del_stmt | pass_stmt | flow_stmt |
                  import_stmt | global_stmt | nonlocal_stmt | assert_stmt)
     expr_stmt: testlist_star_expr (annassign | augassign (yield_expr|testlist) |
                          [('=' (yield_expr|testlist_star_expr))+ [TYPE_COMMENT]] )
     annassign: ':' test ['=' (yield_expr|testlist_star_expr)]
     testlist_star_expr: (test|star_expr) (',' (test|star_expr))* [',']
     augassign: ('+=' | '-=' | '*=' | '@=' | '/=' | '%=' | '&=' | '|=' | '^=' |
                 '<<=' | '>>=' | '**=' | '//=')
     # For normal and annotated assignments, additional restrictions enforced by the interpreter
     del_stmt: 'del' exprlist
     pass_stmt: 'pass'
     flow_stmt: break_stmt | continue_stmt | return_stmt | raise_stmt | yield_stmt
     break_stmt: 'break'
     continue_stmt: 'continue'
     return_stmt: 'return' [testlist_star_expr]
     yield_stmt: yield_expr
     raise_stmt: 'raise' [test ['from' test]]
     import_stmt: import_name | import_from
     import_name: 'import' dotted_as_names
     # note below: the ('.' | '...') is necessary because '...' is tokenized as ELLIPSIS
     import_from: ('from' (('.' | '...')* dotted_name | ('.' | '...')+)
                   'import' ('*' | '(' import_as_names ')' | import_as_names))
     import_as_name: NAME ['as' NAME]
     dotted_as_name: dotted_name ['as' NAME]
     import_as_names: import_as_name (',' import_as_name)* [',']
     dotted_as_names: dotted_as_name (',' dotted_as_name)*
     dotted_name: NAME ('.' NAME)*
     global_stmt: 'global' NAME (',' NAME)*
     nonlocal_stmt: 'nonlocal' NAME (',' NAME)*
     assert_stmt: 'assert' test [',' test]

     compound_stmt: if_stmt | while_stmt | for_stmt | try_stmt | with_stmt | funcdef | classdef | decorated | async_stmt
     async_stmt: ASYNC (funcdef | with_stmt | for_stmt)
     if_stmt: 'if' namedexpr_test ':' suite ('elif' namedexpr_test ':' suite)* ['else' ':' suite]
     while_stmt: 'while' namedexpr_test ':' suite ['else' ':' suite]
     for_stmt: 'for' exprlist 'in' testlist ':' [TYPE_COMMENT] suite ['else' ':' suite]
     try_stmt: ('try' ':' suite
                ((except_clause ':' suite)+
                 ['else' ':' suite]
                 ['finally' ':' suite] |
                'finally' ':' suite))
     with_stmt: 'with' with_item (',' with_item)*  ':' [TYPE_COMMENT] suite
     with_item: test ['as' expr]
     # NB compile.c makes sure that the default except clause is last
     except_clause: 'except' [test ['as' NAME]]
     suite: simple_stmt | NEWLINE INDENT stmt+ DEDENT

     namedexpr_test: test [':=' test]
     test: or_test ['if' or_test 'else' test] | lambdef
     test_nocond: or_test | lambdef_nocond
     lambdef: 'lambda' [varargslist] ':' test
     lambdef_nocond: 'lambda' [varargslist] ':' test_nocond
     or_test: and_test ('or' and_test)*
     and_test: not_test ('and' not_test)*
     not_test: 'not' not_test | comparison
     comparison: expr (comp_op expr)*
     # <> isn't actually a valid comparison operator in Python. It's here for the
     # sake of a __future__ import described in PEP 401 (which really works :-)
     comp_op: '<'|'>'|'=='|'>='|'<='|'<>'|'!='|'in'|'not' 'in'|'is'|'is' 'not'
     star_expr: '*' expr
     expr: xor_expr ('|' xor_expr)*
     xor_expr: and_expr ('^' and_expr)*
     and_expr: shift_expr ('&' shift_expr)*
     shift_expr: arith_expr (('<<'|'>>') arith_expr)*
     arith_expr: term (('+'|'-') term)*
     term: factor (('*'|'@'|'/'|'%'|'//') factor)*
     factor: ('+'|'-'|'~') factor | power
     power: atom_expr ['**' factor]
     atom_expr: [AWAIT] atom trailer*
     atom: ('(' [yield_expr|testlist_comp] ')' |
            '[' [testlist_comp] ']' |
            '{' [dictorsetmaker] '}' |
            NAME | NUMBER | STRING+ | '...' | 'None' | 'True' | 'False')
     testlist_comp: (namedexpr_test|star_expr) ( comp_for | (',' (namedexpr_test|star_expr))* [','] )
     trailer: '(' [arglist] ')' | '[' subscriptlist ']' | '.' NAME
     subscriptlist: subscript (',' subscript)* [',']
     subscript: test | [test] ':' [test] [sliceop]
     sliceop: ':' [test]
     exprlist: (expr|star_expr) (',' (expr|star_expr))* [',']
     testlist: test (',' test)* [',']
     dictorsetmaker: ( ((test ':' test | '**' expr)
                        (comp_for | (',' (test ':' test | '**' expr))* [','])) |
                       ((test | star_expr)
                        (comp_for | (',' (test | star_expr))* [','])) )

     classdef: 'class' NAME ['(' [arglist] ')'] ':' suite

     arglist: argument (',' argument)*  [',']

     # The reason that keywords are test nodes instead of NAME is that using NAME
     # results in an ambiguity. ast.c makes sure it's a NAME.
     # "test '=' test" is really "keyword '=' test", but we have no such token.
     # These need to be in a single rule to avoid grammar that is ambiguous
     # to our LL(1) parser. Even though 'test' includes '*expr' in star_expr,
     # we explicitly match '*' here, too, to give it proper precedence.
     # Illegal combinations and orderings are blocked in ast.c:
     # multiple (test comp_for) arguments are blocked; keyword unpackings
     # that precede iterable unpackings are blocked; etc.
     argument: ( test [comp_for] |
                 test ':=' test |
                 test '=' test |
                 '**' test |
                 '*' test )

     comp_iter: comp_for | comp_if
     sync_comp_for: 'for' exprlist 'in' or_test [comp_iter]
     comp_for: [ASYNC] sync_comp_for
     comp_if: 'if' test_nocond [comp_iter]

     # not used in grammar, but may appear in "node" passed from Parser to Compiler
     encoding_decl: NAME

     yield_expr: 'yield' [yield_arg]
     yield_arg: 'from' test | testlist_star_expr

     # the TYPE_COMMENT in suites is only parsed for funcdefs,
     # but can't go elsewhere due to ambiguity
     func_body_suite: simple_stmt | NEWLINE [TYPE_COMMENT NEWLINE] INDENT stmt+ DEDENT

     func_type_input: func_type NEWLINE* ENDMARKER
     func_type: '(' [typelist] ')' '->' test
     # typelist is a modified typedargslist (see above)
     typelist: (test (',' test)* [','
            ['*' [test] (',' test)* [',' '**' test] | '**' test]]
          |  '*' [test] (',' test)* [',' '**' test] | '**' test)


File: python.info,  Node: The Python Standard Library,  Next: Extending and Embedding the Python Interpreter,  Prev: The Python Language Reference,  Up: Top

5 The Python Standard Library
*****************************

While *note The Python Language Reference: 1136. describes the exact
syntax and semantics of the Python language, this library reference
manual describes the standard library that is distributed with Python.
It also describes some of the optional components that are commonly
included in Python distributions.

Python’s standard library is very extensive, offering a wide range of
facilities as indicated by the long table of contents listed below.  The
library contains built-in modules (written in C) that provide access to
system functionality such as file I/O that would otherwise be
inaccessible to Python programmers, as well as modules written in Python
that provide standardized solutions for many problems that occur in
everyday programming.  Some of these modules are explicitly designed to
encourage and enhance the portability of Python programs by abstracting
away platform-specifics into platform-neutral APIs.

The Python installers for the Windows platform usually include the
entire standard library and often also include many additional
components.  For Unix-like operating systems Python is normally provided
as a collection of packages, so it may be necessary to use the packaging
tools provided with the operating system to obtain some or all of the
optional components.

In addition to the standard library, there is a growing collection of
several thousand components (from individual programs and modules to
packages and entire application development frameworks), available from
the Python Package Index(1).

* Menu:

* Introduction: Introduction<6>.
* Built-in Functions::
* Built-in Constants::
* Built-in Types::
* Built-in Exceptions::
* Text Processing Services::
* Binary Data Services::
* Data Types::
* Numeric and Mathematical Modules::
* Functional Programming Modules::
* File and Directory Access::
* Data Persistence::
* Data Compression and Archiving::
* File Formats::
* Cryptographic Services::
* Generic Operating System Services::
* Concurrent Execution::
* contextvars — Context Variables::
* Networking and Interprocess Communication::
* Internet Data Handling::
* Structured Markup Processing Tools::
* Internet Protocols and Support::
* Multimedia Services::
* Internationalization::
* Program Frameworks::
* Graphical User Interfaces with Tk::
* Development Tools::
* Debugging and Profiling::
* Software Packaging and Distribution::
* Python Runtime Services::
* Custom Python Interpreters::
* Importing Modules::
* Python Language Services::
* Miscellaneous Services::
* MS Windows Specific Services::
* Unix Specific Services::
* Superseded Modules::
* Undocumented Modules::

   ---------- Footnotes ----------

   (1) https://pypi.org


File: python.info,  Node: Introduction<6>,  Next: Built-in Functions,  Up: The Python Standard Library

5.1 Introduction
================

The “Python library” contains several different kinds of components.

It contains data types that would normally be considered part of the
“core” of a language, such as numbers and lists.  For these types, the
Python language core defines the form of literals and places some
constraints on their semantics, but does not fully define the semantics.
(On the other hand, the language core does define syntactic properties
like the spelling and priorities of operators.)

The library also contains built-in functions and exceptions — objects
that can be used by all Python code without the need of an *note import:
c10. statement.  Some of these are defined by the core language, but
many are not essential for the core semantics and are only described
here.

The bulk of the library, however, consists of a collection of modules.
There are many ways to dissect this collection.  Some modules are
written in C and built in to the Python interpreter; others are written
in Python and imported in source form.  Some modules provide interfaces
that are highly specific to Python, like printing a stack trace; some
provide interfaces that are specific to particular operating systems,
such as access to specific hardware; others provide interfaces that are
specific to a particular application domain, like the World Wide Web.
Some modules are available in all versions and ports of Python; others
are only available when the underlying system supports or requires them;
yet others are available only when a particular configuration option was
chosen at the time when Python was compiled and installed.

This manual is organized “from the inside out:” it first describes the
built-in functions, data types and exceptions, and finally the modules,
grouped in chapters of related modules.

This means that if you start reading this manual from the start, and
skip to the next chapter when you get bored, you will get a reasonable
overview of the available modules and application areas that are
supported by the Python library.  Of course, you don’t `have' to read it
like a novel — you can also browse the table of contents (in front of
the manual), or look for a specific function, module or term in the
index (in the back).  And finally, if you enjoy learning about random
subjects, you choose a random page number (see module *note random: dc.)
and read a section or two.  Regardless of the order in which you read
the sections of this manual, it helps to start with chapter *note
Built-in Functions: be6, as the remainder of the manual assumes
familiarity with this material.

Let the show begin!

* Menu:

* Notes on availability::


File: python.info,  Node: Notes on availability,  Up: Introduction<6>

5.1.1 Notes on availability
---------------------------

   * An “Availability: Unix” note means that this function is commonly
     found on Unix systems.  It does not make any claims about its
     existence on a specific operating system.

   * If not separately noted, all functions that claim “Availability:
     Unix” are supported on Mac OS X, which builds on a Unix core.


File: python.info,  Node: Built-in Functions,  Next: Built-in Constants,  Prev: Introduction<6>,  Up: The Python Standard Library

5.2 Built-in Functions
======================

The Python interpreter has a number of functions and types built into it
that are always available.  They are listed here in alphabetical order.

                                              Built-in Functions
                                              
---------------------------------------------------------------------------------------------------------------------
                                                                                            
*note abs(): 11f8.      *note delattr(): 1514.*note hash(): 9b8.     *note memoryview(): 1515.*note set(): 1516.
                                                                                            
                                                                                            
*note all(): d78.       *note dict(): 1517.   *note help(): 567.     *note min(): 7fd.      *note setattr(): 1518.
                                                                                            
                                                                                            
*note any(): d77.       *note dir(): d26.     *note hex(): c59.      *note next(): 676.     *note slice(): df7.
                                                                                            
                                                                                            
*note ascii(): d3f.     *note divmod(): f4d.  *note id(): d79.       *note object(): 2ae.   *note sorted(): 439.
                                                                                            
                                                                                            
*note bin(): c33.       *note enumerate(): dd6.*note input(): c5e.   *note oct(): c58.      *note staticmethod(): 1d7.
                                                                                            
                                                                                            
*note bool(): 183.      *note eval(): b83.    *note int(): 184.      *note open(): 4e5.     *note str(): 1519.
                                                                                            
                                                                                            
*note breakpoint(): 2ee.*note exec(): c37.    *note isinstance(): 444.*note ord(): 1362.    *note sum(): 1e3.
                                                                                            
                                                                                            
*note bytearray(): ff7. *note filter(): c21.  *note issubclass(): 445.*note pow(): 152.     *note super(): 4d7.
                                                                                            
                                                                                            
*note bytes(): ff6.     *note float(): 187.   *note iter(): d1a.     *note print(): 87a.    *note tuple(): 151a.
                                                                                            
                                                                                            
*note callable(): b37.  *note format(): 4d0.  *note len(): 150.      *note property(): 1d5. *note type(): 5fd.
                                                                                            
                                                                                            
*note chr(): 1363.      *note frozenset(): 151b.*note list(): 151c.  *note range(): 151d.   *note vars(): f6f.
                                                                                            
                                                                                            
*note classmethod(): 1d6.*note getattr(): 43d.*note locals(): 44a.   *note repr(): 7c0.     *note zip(): c25.
                                                                                            
                                                                                            
*note compile(): 1b2.   *note globals(): 151e.*note map(): c20.      *note reversed(): 18e. *note __import__(): 605.
                                                                                            
                                                                                            
*note complex(): 189.   *note hasattr(): 43c. *note max(): 7fe.      *note round(): c60.
                                                                     

 -- Function: abs (x)

     Return the absolute value of a number.  The argument may be an
     integer or a floating point number.  If the argument is a complex
     number, its magnitude is returned.  If `x' defines *note __abs__():
     13bb, ‘abs(x)’ returns ‘x.__abs__()’.

 -- Function: all (iterable)

     Return ‘True’ if all elements of the `iterable' are true (or if the
     iterable is empty).  Equivalent to:

          def all(iterable):
              for element in iterable:
                  if not element:
                      return False
              return True

 -- Function: any (iterable)

     Return ‘True’ if any element of the `iterable' is true.  If the
     iterable is empty, return ‘False’.  Equivalent to:

          def any(iterable):
              for element in iterable:
                  if element:
                      return True
              return False

 -- Function: ascii (object)

     As *note repr(): 7c0, return a string containing a printable
     representation of an object, but escape the non-ASCII characters in
     the string returned by *note repr(): 7c0. using ‘\x’, ‘\u’ or ‘\U’
     escapes.  This generates a string similar to that returned by *note
     repr(): 7c0. in Python 2.

 -- Function: bin (x)

     Convert an integer number to a binary string prefixed with “0b”.
     The result is a valid Python expression.  If `x' is not a Python
     *note int: 184. object, it has to define an *note __index__(): 18a.
     method that returns an integer.  Some examples:

          >>> bin(3)
          '0b11'
          >>> bin(-10)
          '-0b1010'

     If prefix “0b” is desired or not, you can use either of the
     following ways.

          >>> format(14, '#b'), format(14, 'b')
          ('0b1110', '1110')
          >>> f'{14:#b}', f'{14:b}'
          ('0b1110', '1110')

     See also *note format(): 4d0. for more information.

 -- Class: bool ([x])

     Return a Boolean value, i.e.  one of ‘True’ or ‘False’.  `x' is
     converted using the standard *note truth testing procedure: 151f.
     If `x' is false or omitted, this returns ‘False’; otherwise it
     returns ‘True’.  The *note bool: 183. class is a subclass of *note
     int: 184. (see *note Numeric Types — int, float, complex: 1159.).
     It cannot be subclassed further.  Its only instances are ‘False’
     and ‘True’ (see *note Boolean Values: 1520.).

     Changed in version 3.7: `x' is now a positional-only parameter.

 -- Function: breakpoint (*args, **kws)

     This function drops you into the debugger at the call site.
     Specifically, it calls *note sys.breakpointhook(): 308, passing
     ‘args’ and ‘kws’ straight through.  By default,
     ‘sys.breakpointhook()’ calls *note pdb.set_trace(): 3b7. expecting
     no arguments.  In this case, it is purely a convenience function so
     you don’t have to explicitly import *note pdb: c9. or type as much
     code to enter the debugger.  However, *note sys.breakpointhook():
     308. can be set to some other function and *note breakpoint(): 2ee.
     will automatically call that, allowing you to drop into the
     debugger of choice.

     Raises an *note auditing event: 1275. ‘builtins.breakpoint’ with
     argument ‘breakpointhook’.

     New in version 3.7.

 -- Class: bytearray ([source[, encoding[, errors]]])

     Return a new array of bytes.  The *note bytearray: 327. class is a
     mutable sequence of integers in the range 0 <= x < 256.  It has
     most of the usual methods of mutable sequences, described in *note
     Mutable Sequence Types: 1521, as well as most methods that the
     *note bytes: 326. type has, see *note Bytes and Bytearray
     Operations: 1522.

     The optional `source' parameter can be used to initialize the array
     in a few different ways:

        * If it is a `string', you must also give the `encoding' (and
          optionally, `errors') parameters; *note bytearray(): 327. then
          converts the string to bytes using *note str.encode(): c2a.

        * If it is an `integer', the array will have that size and will
          be initialized with null bytes.

        * If it is an object conforming to the `buffer' interface, a
          read-only buffer of the object will be used to initialize the
          bytes array.

        * If it is an `iterable', it must be an iterable of integers in
          the range ‘0 <= x < 256’, which are used as the initial
          contents of the array.

     Without an argument, an array of size 0 is created.

     See also *note Binary Sequence Types — bytes, bytearray,
     memoryview: 1523. and *note Bytearray Objects: 1524.

 -- Class: bytes ([source[, encoding[, errors]]])

     Return a new “bytes” object, which is an immutable sequence of
     integers in the range ‘0 <= x < 256’.  *note bytes: 326. is an
     immutable version of *note bytearray: 327. – it has the same
     non-mutating methods and the same indexing and slicing behavior.

     Accordingly, constructor arguments are interpreted as for *note
     bytearray(): 327.

     Bytes objects can also be created with literals, see *note String
     and Bytes literals: 131c.

     See also *note Binary Sequence Types — bytes, bytearray,
     memoryview: 1523, *note Bytes Objects: 1525, and *note Bytes and
     Bytearray Operations: 1522.

 -- Function: callable (object)

     Return *note True: 48f. if the `object' argument appears callable,
     *note False: 37d. if not.  If this returns ‘True’, it is still
     possible that a call fails, but if it is ‘False’, calling `object'
     will never succeed.  Note that classes are callable (calling a
     class returns a new instance); instances are callable if their
     class has a *note __call__(): 1369. method.

     New in version 3.2: This function was first removed in Python 3.0
     and then brought back in Python 3.2.

 -- Function: chr (i)

     Return the string representing a character whose Unicode code point
     is the integer `i'.  For example, ‘chr(97)’ returns the string
     ‘'a'’, while ‘chr(8364)’ returns the string ‘'€'’.  This is the
     inverse of *note ord(): 1362.

     The valid range for the argument is from 0 through 1,114,111
     (0x10FFFF in base 16).  *note ValueError: 1f9. will be raised if
     `i' is outside that range.

 -- Function: @classmethod

     Transform a method into a class method.

     A class method receives the class as implicit first argument, just
     like an instance method receives the instance.  To declare a class
     method, use this idiom:

          class C:
              @classmethod
              def f(cls, arg1, arg2, ...): ...

     The ‘@classmethod’ form is a function *note decorator: 281. – see
     *note Function definitions: 1196. for details.

     A class method can be called either on the class (such as ‘C.f()’)
     or on an instance (such as ‘C().f()’).  The instance is ignored
     except for its class.  If a class method is called for a derived
     class, the derived class object is passed as the implied first
     argument.

     Class methods are different than C++ or Java static methods.  If
     you want those, see *note staticmethod(): 1d7.

     For more information on class methods, see *note The standard type
     hierarchy: 135c.

 -- Function: compile (source, filename, mode, flags=0,
          dont_inherit=False, optimize=-1)

     Compile the `source' into a code or AST object.  Code objects can
     be executed by *note exec(): c37. or *note eval(): b83.  `source'
     can either be a normal string, a byte string, or an AST object.
     Refer to the *note ast: 8. module documentation for information on
     how to work with AST objects.

     The `filename' argument should give the file from which the code
     was read; pass some recognizable value if it wasn’t read from a
     file (‘'<string>'’ is commonly used).

     The `mode' argument specifies what kind of code must be compiled;
     it can be ‘'exec'’ if `source' consists of a sequence of
     statements, ‘'eval'’ if it consists of a single expression, or
     ‘'single'’ if it consists of a single interactive statement (in the
     latter case, expression statements that evaluate to something other
     than ‘None’ will be printed).

     The optional arguments `flags' and `dont_inherit' control which
     *note future statements: 14c9. affect the compilation of `source'.
     If neither is present (or both are zero) the code is compiled with
     those future statements that are in effect in the code that is
     calling *note compile(): 1b2.  If the `flags' argument is given and
     `dont_inherit' is not (or is zero) then the future statements
     specified by the `flags' argument are used in addition to those
     that would be used anyway.  If `dont_inherit' is a non-zero integer
     then the `flags' argument is it – the future statements in effect
     around the call to compile are ignored.

     Future statements are specified by bits which can be bitwise ORed
     together to specify multiple statements.  The bitfield required to
     specify a given feature can be found as the ‘compiler_flag’
     attribute on the ‘_Feature’ instance in the *note __future__: 0.
     module.

     The optional argument `flags' also controls whether the compiled
     source is allowed to contain top-level ‘await’, ‘async for’ and
     ‘async with’.  When the bit ‘ast.PyCF_ALLOW_TOP_LEVEL_AWAIT’ is
     set, the return code object has ‘CO_COROUTINE’ set in ‘co_code’,
     and can be interactively executed via ‘await eval(code_object)’.

     The argument `optimize' specifies the optimization level of the
     compiler; the default value of ‘-1’ selects the optimization level
     of the interpreter as given by *note -O: 67f. options.  Explicit
     levels are ‘0’ (no optimization; ‘__debug__’ is true), ‘1’ (asserts
     are removed, ‘__debug__’ is false) or ‘2’ (docstrings are removed
     too).

     This function raises *note SyntaxError: 44d. if the compiled source
     is invalid, and *note ValueError: 1f9. if the source contains null
     bytes.

     If you want to parse Python code into its AST representation, see
     *note ast.parse(): 1a0.

     Raises an *note auditing event: 1275. ‘compile’ with arguments
     ‘source’ and ‘filename’.  This event may also be raised by implicit
     compilation.

          Note: When compiling a string with multi-line code in
          ‘'single'’ or ‘'eval'’ mode, input must be terminated by at
          least one newline character.  This is to facilitate detection
          of incomplete and complete statements in the *note code: 1b.
          module.

          Warning: It is possible to crash the Python interpreter with a
          sufficiently large/complex string when compiling to an AST
          object due to stack depth limitations in Python’s AST
          compiler.

     Changed in version 3.2: Allowed use of Windows and Mac newlines.
     Also input in ‘'exec'’ mode does not have to end in a newline
     anymore.  Added the `optimize' parameter.

     Changed in version 3.5: Previously, *note TypeError: 192. was
     raised when null bytes were encountered in `source'.

     New in version 3.8: ‘ast.PyCF_ALLOW_TOP_LEVEL_AWAIT’ can now be
     passed in flags to enable support for top-level ‘await’, ‘async
     for’, and ‘async with’.

 -- Class: complex ([real[, imag]])

     Return a complex number with the value `real' + `imag'*1j or
     convert a string or number to a complex number.  If the first
     parameter is a string, it will be interpreted as a complex number
     and the function must be called without a second parameter.  The
     second parameter can never be a string.  Each argument may be any
     numeric type (including complex).  If `imag' is omitted, it
     defaults to zero and the constructor serves as a numeric conversion
     like *note int: 184. and *note float: 187.  If both arguments are
     omitted, returns ‘0j’.

     For a general Python object ‘x’, ‘complex(x)’ delegates to
     ‘x.__complex__()’.  If ‘__complex__()’ is not defined then it falls
     back to *note __float__(): 18c.  If ‘__float__()’ is not defined
     then it falls back to *note __index__(): 18a.

          Note: When converting from a string, the string must not
          contain whitespace around the central ‘+’ or ‘-’ operator.
          For example, ‘complex('1+2j')’ is fine, but ‘complex('1 +
          2j')’ raises *note ValueError: 1f9.

     The complex type is described in *note Numeric Types — int, float,
     complex: 1159.

     Changed in version 3.6: Grouping digits with underscores as in code
     literals is allowed.

     Changed in version 3.8: Falls back to *note __index__(): 18a. if
     *note __complex__(): 18d. and *note __float__(): 18c. are not
     defined.

 -- Function: delattr (object, name)

     This is a relative of *note setattr(): 1518.  The arguments are an
     object and a string.  The string must be the name of one of the
     object’s attributes.  The function deletes the named attribute,
     provided the object allows it.  For example, ‘delattr(x, 'foobar')’
     is equivalent to ‘del x.foobar’.

 -- Class: dict (**kwarg)

 -- Class: dict (mapping, **kwarg)

 -- Class: dict (iterable, **kwarg)

     Create a new dictionary.  The *note dict: 1b6. object is the
     dictionary class.  See *note dict: 1b6. and *note Mapping Types —
     dict: 2f1. for documentation about this class.

     For other containers see the built-in *note list: 260, *note set:
     b62, and *note tuple: 473. classes, as well as the *note
     collections: 1e. module.

 -- Function: dir ([object])

     Without arguments, return the list of names in the current local
     scope.  With an argument, attempt to return a list of valid
     attributes for that object.

     If the object has a method named *note __dir__(): 310, this method
     will be called and must return the list of attributes.  This allows
     objects that implement a custom *note __getattr__(): 30f. or *note
     __getattribute__(): 43e. function to customize the way *note dir():
     d26. reports their attributes.

     If the object does not provide *note __dir__(): 310, the function
     tries its best to gather information from the object’s *note
     __dict__: 4f1. attribute, if defined, and from its type object.
     The resulting list is not necessarily complete, and may be
     inaccurate when the object has a custom *note __getattr__(): 30f.

     The default *note dir(): d26. mechanism behaves differently with
     different types of objects, as it attempts to produce the most
     relevant, rather than complete, information:

        * If the object is a module object, the list contains the names
          of the module’s attributes.

        * If the object is a type or class object, the list contains the
          names of its attributes, and recursively of the attributes of
          its bases.

        * Otherwise, the list contains the object’s attributes’ names,
          the names of its class’s attributes, and recursively of the
          attributes of its class’s base classes.

     The resulting list is sorted alphabetically.  For example:

          >>> import struct
          >>> dir()   # show the names in the module namespace  # doctest: +SKIP
          ['__builtins__', '__name__', 'struct']
          >>> dir(struct)   # show the names in the struct module # doctest: +SKIP
          ['Struct', '__all__', '__builtins__', '__cached__', '__doc__', '__file__',
           '__initializing__', '__loader__', '__name__', '__package__',
           '_clearcache', 'calcsize', 'error', 'pack', 'pack_into',
           'unpack', 'unpack_from']
          >>> class Shape:
          ...     def __dir__(self):
          ...         return ['area', 'perimeter', 'location']
          >>> s = Shape()
          >>> dir(s)
          ['area', 'location', 'perimeter']

          Note: Because *note dir(): d26. is supplied primarily as a
          convenience for use at an interactive prompt, it tries to
          supply an interesting set of names more than it tries to
          supply a rigorously or consistently defined set of names, and
          its detailed behavior may change across releases.  For
          example, metaclass attributes are not in the result list when
          the argument is a class.

 -- Function: divmod (a, b)

     Take two (non complex) numbers as arguments and return a pair of
     numbers consisting of their quotient and remainder when using
     integer division.  With mixed operand types, the rules for binary
     arithmetic operators apply.  For integers, the result is the same
     as ‘(a // b, a % b)’.  For floating point numbers the result is
     ‘(q, a % b)’, where `q' is usually ‘math.floor(a / b)’ but may be 1
     less than that.  In any case ‘q * b + a % b’ is very close to `a',
     if ‘a % b’ is non-zero it has the same sign as `b', and ‘0 <= abs(a
     % b) < abs(b)’.

 -- Function: enumerate (iterable, start=0)

     Return an enumerate object.  `iterable' must be a sequence, an
     *note iterator: f73, or some other object which supports iteration.
     The *note __next__(): c57. method of the iterator returned by *note
     enumerate(): dd6. returns a tuple containing a count (from `start'
     which defaults to 0) and the values obtained from iterating over
     `iterable'.

          >>> seasons = ['Spring', 'Summer', 'Fall', 'Winter']
          >>> list(enumerate(seasons))
          [(0, 'Spring'), (1, 'Summer'), (2, 'Fall'), (3, 'Winter')]
          >>> list(enumerate(seasons, start=1))
          [(1, 'Spring'), (2, 'Summer'), (3, 'Fall'), (4, 'Winter')]

     Equivalent to:

          def enumerate(sequence, start=0):
              n = start
              for elem in sequence:
                  yield n, elem
                  n += 1

 -- Function: eval (expression[, globals[, locals]])

     The arguments are a string and optional globals and locals.  If
     provided, `globals' must be a dictionary.  If provided, `locals'
     can be any mapping object.

     The `expression' argument is parsed and evaluated as a Python
     expression (technically speaking, a condition list) using the
     `globals' and `locals' dictionaries as global and local namespace.
     If the `globals' dictionary is present and does not contain a value
     for the key ‘__builtins__’, a reference to the dictionary of the
     built-in module *note builtins: 13. is inserted under that key
     before `expression' is parsed.  This means that `expression'
     normally has full access to the standard *note builtins: 13. module
     and restricted environments are propagated.  If the `locals'
     dictionary is omitted it defaults to the `globals' dictionary.  If
     both dictionaries are omitted, the expression is executed with the
     `globals' and `locals' in the environment where *note eval(): b83.
     is called.  Note, `eval()' does not have access to the *note nested
     scopes: 1526. (non-locals) in the enclosing environment.

     The return value is the result of the evaluated expression.  Syntax
     errors are reported as exceptions.  Example:

          >>> x = 1
          >>> eval('x+1')
          2

     This function can also be used to execute arbitrary code objects
     (such as those created by *note compile(): 1b2.).  In this case
     pass a code object instead of a string.  If the code object has
     been compiled with ‘'exec'’ as the `mode' argument, *note eval():
     b83.’s return value will be ‘None’.

     Hints: dynamic execution of statements is supported by the *note
     exec(): c37. function.  The *note globals(): 151e. and *note
     locals(): 44a. functions returns the current global and local
     dictionary, respectively, which may be useful to pass around for
     use by *note eval(): b83. or *note exec(): c37.

     See *note ast.literal_eval(): 49b. for a function that can safely
     evaluate strings with expressions containing only literals.

     Raises an *note auditing event: 1275. ‘exec’ with the code object
     as the argument.  Code compilation events may also be raised.

 -- Function: exec (object[, globals[, locals]])

     This function supports dynamic execution of Python code.  `object'
     must be either a string or a code object.  If it is a string, the
     string is parsed as a suite of Python statements which is then
     executed (unless a syntax error occurs).  (1) If it is a code
     object, it is simply executed.  In all cases, the code that’s
     executed is expected to be valid as file input (see the section
     “File input” in the Reference Manual).  Be aware that the *note
     return: 190. and *note yield: 18f. statements may not be used
     outside of function definitions even within the context of code
     passed to the *note exec(): c37. function.  The return value is
     ‘None’.

     In all cases, if the optional parts are omitted, the code is
     executed in the current scope.  If only `globals' is provided, it
     must be a dictionary (and not a subclass of dictionary), which will
     be used for both the global and the local variables.  If `globals'
     and `locals' are given, they are used for the global and local
     variables, respectively.  If provided, `locals' can be any mapping
     object.  Remember that at module level, globals and locals are the
     same dictionary.  If exec gets two separate objects as `globals'
     and `locals', the code will be executed as if it were embedded in a
     class definition.

     If the `globals' dictionary does not contain a value for the key
     ‘__builtins__’, a reference to the dictionary of the built-in
     module *note builtins: 13. is inserted under that key.  That way
     you can control what builtins are available to the executed code by
     inserting your own ‘__builtins__’ dictionary into `globals' before
     passing it to *note exec(): c37.

     Raises an *note auditing event: 1275. ‘exec’ with the code object
     as the argument.  Code compilation events may also be raised.

          Note: The built-in functions *note globals(): 151e. and *note
          locals(): 44a. return the current global and local dictionary,
          respectively, which may be useful to pass around for use as
          the second and third argument to *note exec(): c37.

          Note: The default `locals' act as described for function *note
          locals(): 44a. below: modifications to the default `locals'
          dictionary should not be attempted.  Pass an explicit `locals'
          dictionary if you need to see effects of the code on `locals'
          after function *note exec(): c37. returns.

 -- Function: filter (function, iterable)

     Construct an iterator from those elements of `iterable' for which
     `function' returns true.  `iterable' may be either a sequence, a
     container which supports iteration, or an iterator.  If `function'
     is ‘None’, the identity function is assumed, that is, all elements
     of `iterable' that are false are removed.

     Note that ‘filter(function, iterable)’ is equivalent to the
     generator expression ‘(item for item in iterable if
     function(item))’ if function is not ‘None’ and ‘(item for item in
     iterable if item)’ if function is ‘None’.

     See *note itertools.filterfalse(): 1527. for the complementary
     function that returns elements of `iterable' for which `function'
     returns false.

 -- Class: float ([x])

     Return a floating point number constructed from a number or string
     `x'.

     If the argument is a string, it should contain a decimal number,
     optionally preceded by a sign, and optionally embedded in
     whitespace.  The optional sign may be ‘'+'’ or ‘'-'’; a ‘'+'’ sign
     has no effect on the value produced.  The argument may also be a
     string representing a NaN (not-a-number), or a positive or negative
     infinity.  More precisely, the input must conform to the following
     grammar after leading and trailing whitespace characters are
     removed:

          sign           ::= "+" | "-"
          infinity       ::= "Infinity" | "inf"
          nan            ::= "nan"
          numeric_value  ::= floatnumber | infinity | nan
          numeric_string ::= [sign] numeric_value

     Here ‘floatnumber’ is the form of a Python floating-point literal,
     described in *note Floating point literals: 1346.  Case is not
     significant, so, for example, “inf”, “Inf”, “INFINITY” and
     “iNfINity” are all acceptable spellings for positive infinity.

     Otherwise, if the argument is an integer or a floating point
     number, a floating point number with the same value (within
     Python’s floating point precision) is returned.  If the argument is
     outside the range of a Python float, an *note OverflowError: 954.
     will be raised.

     For a general Python object ‘x’, ‘float(x)’ delegates to
     ‘x.__float__()’.  If ‘__float__()’ is not defined then it falls
     back to *note __index__(): 18a.

     If no argument is given, ‘0.0’ is returned.

     Examples:

          >>> float('+1.23')
          1.23
          >>> float('   -12345\n')
          -12345.0
          >>> float('1e-003')
          0.001
          >>> float('+1E6')
          1000000.0
          >>> float('-Infinity')
          -inf

     The float type is described in *note Numeric Types — int, float,
     complex: 1159.

     Changed in version 3.6: Grouping digits with underscores as in code
     literals is allowed.

     Changed in version 3.7: `x' is now a positional-only parameter.

     Changed in version 3.8: Falls back to *note __index__(): 18a. if
     *note __float__(): 18c. is not defined.

 -- Function: format (value[, format_spec])

     Convert a `value' to a “formatted” representation, as controlled by
     `format_spec'.  The interpretation of `format_spec' will depend on
     the type of the `value' argument, however there is a standard
     formatting syntax that is used by most built-in types: *note Format
     Specification Mini-Language: 4d3.

     The default `format_spec' is an empty string which usually gives
     the same effect as calling *note str(value): 325.

     A call to ‘format(value, format_spec)’ is translated to
     ‘type(value).__format__(value, format_spec)’ which bypasses the
     instance dictionary when searching for the value’s *note
     __format__(): 942. method.  A *note TypeError: 192. exception is
     raised if the method search reaches *note object: 2ae. and the
     `format_spec' is non-empty, or if either the `format_spec' or the
     return value are not strings.

     Changed in version 3.4: ‘object().__format__(format_spec)’ raises
     *note TypeError: 192. if `format_spec' is not an empty string.

 -- Class: frozenset ([iterable])

     Return a new *note frozenset: be1. object, optionally with elements
     taken from `iterable'.  ‘frozenset’ is a built-in class.  See *note
     frozenset: be1. and *note Set Types — set, frozenset: 152d. for
     documentation about this class.

     For other containers see the built-in *note set: b62, *note list:
     260, *note tuple: 473, and *note dict: 1b6. classes, as well as the
     *note collections: 1e. module.

 -- Function: getattr (object, name[, default])

     Return the value of the named attribute of `object'.  `name' must
     be a string.  If the string is the name of one of the object’s
     attributes, the result is the value of that attribute.  For
     example, ‘getattr(x, 'foobar')’ is equivalent to ‘x.foobar’.  If
     the named attribute does not exist, `default' is returned if
     provided, otherwise *note AttributeError: 390. is raised.

 -- Function: globals ()

     Return a dictionary representing the current global symbol table.
     This is always the dictionary of the current module (inside a
     function or method, this is the module where it is defined, not the
     module from which it is called).

 -- Function: hasattr (object, name)

     The arguments are an object and a string.  The result is ‘True’ if
     the string is the name of one of the object’s attributes, ‘False’
     if not.  (This is implemented by calling ‘getattr(object, name)’
     and seeing whether it raises an *note AttributeError: 390. or not.)

 -- Function: hash (object)

     Return the hash value of the object (if it has one).  Hash values
     are integers.  They are used to quickly compare dictionary keys
     during a dictionary lookup.  Numeric values that compare equal have
     the same hash value (even if they are of different types, as is the
     case for 1 and 1.0).

          Note: For objects with custom *note __hash__(): 335. methods,
          note that *note hash(): 9b8. truncates the return value based
          on the bit width of the host machine.  See *note __hash__():
          335. for details.

 -- Function: help ([object])

     Invoke the built-in help system.  (This function is intended for
     interactive use.)  If no argument is given, the interactive help
     system starts on the interpreter console.  If the argument is a
     string, then the string is looked up as the name of a module,
     function, class, method, keyword, or documentation topic, and a
     help page is printed on the console.  If the argument is any other
     kind of object, a help page on the object is generated.

     Note that if a slash(/) appears in the parameter list of a
     function, when invoking *note help(): 567, it means that the
     parameters prior to the slash are positional-only.  For more info,
     see *note the FAQ entry on positional-only parameters: 152e.

     This function is added to the built-in namespace by the *note site:
     eb. module.

     Changed in version 3.4: Changes to *note pydoc: d9. and *note
     inspect: a0. mean that the reported signatures for callables are
     now more comprehensive and consistent.

 -- Function: hex (x)

     Convert an integer number to a lowercase hexadecimal string
     prefixed with “0x”.  If `x' is not a Python *note int: 184. object,
     it has to define an *note __index__(): 18a. method that returns an
     integer.  Some examples:

          >>> hex(255)
          '0xff'
          >>> hex(-42)
          '-0x2a'

     If you want to convert an integer number to an uppercase or lower
     hexadecimal string with prefix or not, you can use either of the
     following ways:

          >>> '%#x' % 255, '%x' % 255, '%X' % 255
          ('0xff', 'ff', 'FF')
          >>> format(255, '#x'), format(255, 'x'), format(255, 'X')
          ('0xff', 'ff', 'FF')
          >>> f'{255:#x}', f'{255:x}', f'{255:X}'
          ('0xff', 'ff', 'FF')

     See also *note format(): 4d0. for more information.

     See also *note int(): 184. for converting a hexadecimal string to
     an integer using a base of 16.

          Note: To obtain a hexadecimal string representation for a
          float, use the *note float.hex(): 125e. method.

 -- Function: id (object)

     Return the “identity” of an object.  This is an integer which is
     guaranteed to be unique and constant for this object during its
     lifetime.  Two objects with non-overlapping lifetimes may have the
     same *note id(): d79. value.

     `CPython implementation detail:' This is the address of the object
     in memory.

 -- Function: input ([prompt])

     If the `prompt' argument is present, it is written to standard
     output without a trailing newline.  The function then reads a line
     from input, converts it to a string (stripping a trailing newline),
     and returns that.  When EOF is read, *note EOFError: c5f. is
     raised.  Example:

          >>> s = input('--> ')
          --> Monty Python's Flying Circus
          >>> s
          "Monty Python's Flying Circus"

     If the *note readline: de. module was loaded, then *note input():
     c5e. will use it to provide elaborate line editing and history
     features.

     Raises an *note auditing event: 1275. ‘builtins.input’ with
     argument ‘prompt’ before reading input

     Raises an auditing event ‘builtins.input/result’ with the result
     after successfully reading input.

 -- Class: int ([x])

 -- Class: int (x, base=10)

     Return an integer object constructed from a number or string `x',
     or return ‘0’ if no arguments are given.  If `x' defines *note
     __int__(): 18b, ‘int(x)’ returns ‘x.__int__()’.  If `x' defines
     *note __index__(): 18a, it returns ‘x.__index__()’.  If `x' defines
     *note __trunc__(): 13bf, it returns ‘x.__trunc__()’.  For floating
     point numbers, this truncates towards zero.

     If `x' is not a number or if `base' is given, then `x' must be a
     string, *note bytes: 326, or *note bytearray: 327. instance
     representing an *note integer literal: 133b. in radix `base'.
     Optionally, the literal can be preceded by ‘+’ or ‘-’ (with no
     space in between) and surrounded by whitespace.  A base-n literal
     consists of the digits 0 to n-1, with ‘a’ to ‘z’ (or ‘A’ to ‘Z’)
     having values 10 to 35.  The default `base' is 10.  The allowed
     values are 0 and 2–36.  Base-2, -8, and -16 literals can be
     optionally prefixed with ‘0b’/‘0B’, ‘0o’/‘0O’, or ‘0x’/‘0X’, as
     with integer literals in code.  Base 0 means to interpret exactly
     as a code literal, so that the actual base is 2, 8, 10, or 16, and
     so that ‘int('010', 0)’ is not legal, while ‘int('010')’ is, as
     well as ‘int('010', 8)’.

     The integer type is described in *note Numeric Types — int, float,
     complex: 1159.

     Changed in version 3.4: If `base' is not an instance of *note int:
     184. and the `base' object has a *note base.__index__: 18a. method,
     that method is called to obtain an integer for the base.  Previous
     versions used *note base.__int__: 18b. instead of *note
     base.__index__: 18a.

     Changed in version 3.6: Grouping digits with underscores as in code
     literals is allowed.

     Changed in version 3.7: `x' is now a positional-only parameter.

     Changed in version 3.8: Falls back to *note __index__(): 18a. if
     *note __int__(): 18b. is not defined.

 -- Function: isinstance (object, classinfo)

     Return ‘True’ if the `object' argument is an instance of the
     `classinfo' argument, or of a (direct, indirect or *note virtual:
     b26.) subclass thereof.  If `object' is not an object of the given
     type, the function always returns ‘False’.  If `classinfo' is a
     tuple of type objects (or recursively, other such tuples), return
     ‘True’ if `object' is an instance of any of the types.  If
     `classinfo' is not a type or tuple of types and such tuples, a
     *note TypeError: 192. exception is raised.

 -- Function: issubclass (class, classinfo)

     Return ‘True’ if `class' is a subclass (direct, indirect or *note
     virtual: b26.) of `classinfo'.  A class is considered a subclass of
     itself.  `classinfo' may be a tuple of class objects, in which case
     every entry in `classinfo' will be checked.  In any other case, a
     *note TypeError: 192. exception is raised.

 -- Function: iter (object[, sentinel])

     Return an *note iterator: f73. object.  The first argument is
     interpreted very differently depending on the presence of the
     second argument.  Without a second argument, `object' must be a
     collection object which supports the iteration protocol (the *note
     __iter__(): 504. method), or it must support the sequence protocol
     (the *note __getitem__(): 27a. method with integer arguments
     starting at ‘0’).  If it does not support either of those
     protocols, *note TypeError: 192. is raised.  If the second
     argument, `sentinel', is given, then `object' must be a callable
     object.  The iterator created in this case will call `object' with
     no arguments for each call to its *note __next__(): c57. method; if
     the value returned is equal to `sentinel', *note StopIteration:
     47b. will be raised, otherwise the value will be returned.

     See also *note Iterator Types: 1398.

     One useful application of the second form of *note iter(): d1a. is
     to build a block-reader.  For example, reading fixed-width blocks
     from a binary database file until the end of file is reached:

          from functools import partial
          with open('mydata.db', 'rb') as f:
              for block in iter(partial(f.read, 64), b''):
                  process_block(block)

 -- Function: len (s)

     Return the length (the number of items) of an object.  The argument
     may be a sequence (such as a string, bytes, tuple, list, or range)
     or a collection (such as a dictionary, set, or frozen set).

 -- Class: list ([iterable])

     Rather than being a function, *note list: 260. is actually a
     mutable sequence type, as documented in *note Lists: 152f. and
     *note Sequence Types — list, tuple, range: 11aa.

 -- Function: locals ()

     Update and return a dictionary representing the current local
     symbol table.  Free variables are returned by *note locals(): 44a.
     when it is called in function blocks, but not in class blocks.
     Note that at the module level, *note locals(): 44a. and *note
     globals(): 151e. are the same dictionary.

          Note: The contents of this dictionary should not be modified;
          changes may not affect the values of local and free variables
          used by the interpreter.

 -- Function: map (function, iterable, ...)

     Return an iterator that applies `function' to every item of
     `iterable', yielding the results.  If additional `iterable'
     arguments are passed, `function' must take that many arguments and
     is applied to the items from all iterables in parallel.  With
     multiple iterables, the iterator stops when the shortest iterable
     is exhausted.  For cases where the function inputs are already
     arranged into argument tuples, see *note itertools.starmap(): a1d.

 -- Function: max (iterable, *[, key, default])

 -- Function: max (arg1, arg2, *args[, key])

     Return the largest item in an iterable or the largest of two or
     more arguments.

     If one positional argument is provided, it should be an *note
     iterable: b9f.  The largest item in the iterable is returned.  If
     two or more positional arguments are provided, the largest of the
     positional arguments is returned.

     There are two optional keyword-only arguments.  The `key' argument
     specifies a one-argument ordering function like that used for *note
     list.sort(): 43a.  The `default' argument specifies an object to
     return if the provided iterable is empty.  If the iterable is empty
     and `default' is not provided, a *note ValueError: 1f9. is raised.

     If multiple items are maximal, the function returns the first one
     encountered.  This is consistent with other sort-stability
     preserving tools such as ‘sorted(iterable, key=keyfunc,
     reverse=True)[0]’ and ‘heapq.nlargest(1, iterable, key=keyfunc)’.

     New in version 3.4: The `default' keyword-only argument.

     Changed in version 3.8: The `key' can be ‘None’.

 -- Function: memoryview (obj)

     Return a “memory view” object created from the given argument.  See
     *note Memory Views: 1530. for more information.

 -- Function: min (iterable, *[, key, default])

 -- Function: min (arg1, arg2, *args[, key])

     Return the smallest item in an iterable or the smallest of two or
     more arguments.

     If one positional argument is provided, it should be an *note
     iterable: b9f.  The smallest item in the iterable is returned.  If
     two or more positional arguments are provided, the smallest of the
     positional arguments is returned.

     There are two optional keyword-only arguments.  The `key' argument
     specifies a one-argument ordering function like that used for *note
     list.sort(): 43a.  The `default' argument specifies an object to
     return if the provided iterable is empty.  If the iterable is empty
     and `default' is not provided, a *note ValueError: 1f9. is raised.

     If multiple items are minimal, the function returns the first one
     encountered.  This is consistent with other sort-stability
     preserving tools such as ‘sorted(iterable, key=keyfunc)[0]’ and
     ‘heapq.nsmallest(1, iterable, key=keyfunc)’.

     New in version 3.4: The `default' keyword-only argument.

     Changed in version 3.8: The `key' can be ‘None’.

 -- Function: next (iterator[, default])

     Retrieve the next item from the `iterator' by calling its *note
     __next__(): c57. method.  If `default' is given, it is returned if
     the iterator is exhausted, otherwise *note StopIteration: 47b. is
     raised.

 -- Class: object

     Return a new featureless object.  *note object: 2ae. is a base for
     all classes.  It has the methods that are common to all instances
     of Python classes.  This function does not accept any arguments.

          Note: *note object: 2ae. does `not' have a *note __dict__:
          4f1, so you can’t assign arbitrary attributes to an instance
          of the *note object: 2ae. class.

 -- Function: oct (x)

     Convert an integer number to an octal string prefixed with “0o”.
     The result is a valid Python expression.  If `x' is not a Python
     *note int: 184. object, it has to define an *note __index__(): 18a.
     method that returns an integer.  For example:

          >>> oct(8)
          '0o10'
          >>> oct(-56)
          '-0o70'

     If you want to convert an integer number to octal string either
     with prefix “0o” or not, you can use either of the following ways.

          >>> '%#o' % 10, '%o' % 10
          ('0o12', '12')
          >>> format(10, '#o'), format(10, 'o')
          ('0o12', '12')
          >>> f'{10:#o}', f'{10:o}'
          ('0o12', '12')

     See also *note format(): 4d0. for more information.

 -- Function: open (file, mode='r', buffering=-1, encoding=None,
          errors=None, newline=None, closefd=True, opener=None)

     Open `file' and return a corresponding *note file object: b35.  If
     the file cannot be opened, an *note OSError: 1d1. is raised.

     `file' is a *note path-like object: 35f. giving the pathname
     (absolute or relative to the current working directory) of the file
     to be opened or an integer file descriptor of the file to be
     wrapped.  (If a file descriptor is given, it is closed when the
     returned I/O object is closed, unless `closefd' is set to ‘False’.)

     `mode' is an optional string that specifies the mode in which the
     file is opened.  It defaults to ‘'r'’ which means open for reading
     in text mode.  Other common values are ‘'w'’ for writing
     (truncating the file if it already exists), ‘'x'’ for exclusive
     creation and ‘'a'’ for appending (which on `some' Unix systems,
     means that `all' writes append to the end of the file regardless of
     the current seek position).  In text mode, if `encoding' is not
     specified the encoding used is platform dependent:
     ‘locale.getpreferredencoding(False)’ is called to get the current
     locale encoding.  (For reading and writing raw bytes use binary
     mode and leave `encoding' unspecified.)  The available modes are:

     Character     Meaning
                   
     ----------------------------------------------------------------------------------
                   
     ‘'r'’         open for reading (default)
                   
                   
     ‘'w'’         open for writing, truncating the file first
                   
                   
     ‘'x'’         open for exclusive creation, failing if the file already exists
                   
                   
     ‘'a'’         open for writing, appending to the end of the file if it exists
                   
                   
     ‘'b'’         binary mode
                   
                   
     ‘'t'’         text mode (default)
                   
                   
     ‘'+'’         open for updating (reading and writing)
                   

     The default mode is ‘'r'’ (open for reading text, synonym of
     ‘'rt'’).  Modes ‘'w+'’ and ‘'w+b'’ open and truncate the file.
     Modes ‘'r+'’ and ‘'r+b'’ open the file with no truncation.

     As mentioned in the *note Overview: 1532, Python distinguishes
     between binary and text I/O. Files opened in binary mode (including
     ‘'b'’ in the `mode' argument) return contents as *note bytes: 326.
     objects without any decoding.  In text mode (the default, or when
     ‘'t'’ is included in the `mode' argument), the contents of the file
     are returned as *note str: 325, the bytes having been first decoded
     using a platform-dependent encoding or using the specified
     `encoding' if given.

     There is an additional mode character permitted, ‘'U'’, which no
     longer has any effect, and is considered deprecated.  It previously
     enabled *note universal newlines: 5e9. in text mode, which became
     the default behaviour in Python 3.0.  Refer to the documentation of
     the *note newline: 1533. parameter for further details.

          Note: Python doesn’t depend on the underlying operating
          system’s notion of text files; all the processing is done by
          Python itself, and is therefore platform-independent.

     `buffering' is an optional integer used to set the buffering
     policy.  Pass 0 to switch buffering off (only allowed in binary
     mode), 1 to select line buffering (only usable in text mode), and
     an integer > 1 to indicate the size in bytes of a fixed-size chunk
     buffer.  When no `buffering' argument is given, the default
     buffering policy works as follows:

        * Binary files are buffered in fixed-size chunks; the size of
          the buffer is chosen using a heuristic trying to determine the
          underlying device’s “block size” and falling back on *note
          io.DEFAULT_BUFFER_SIZE: 1534.  On many systems, the buffer
          will typically be 4096 or 8192 bytes long.

        * “Interactive” text files (files for which *note isatty():
          1535. returns ‘True’) use line buffering.  Other text files
          use the policy described above for binary files.

     `encoding' is the name of the encoding used to decode or encode the
     file.  This should only be used in text mode.  The default encoding
     is platform dependent (whatever *note
     locale.getpreferredencoding(): 39a. returns), but any *note text
     encoding: 1536. supported by Python can be used.  See the *note
     codecs: 1c. module for the list of supported encodings.

     `errors' is an optional string that specifies how encoding and
     decoding errors are to be handled—this cannot be used in binary
     mode.  A variety of standard error handlers are available (listed
     under *note Error Handlers: 129c.), though any error handling name
     that has been registered with *note codecs.register_error(): de8.
     is also valid.  The standard names include:

        * ‘'strict'’ to raise a *note ValueError: 1f9. exception if
          there is an encoding error.  The default value of ‘None’ has
          the same effect.

        * ‘'ignore'’ ignores errors.  Note that ignoring encoding errors
          can lead to data loss.

        * ‘'replace'’ causes a replacement marker (such as ‘'?'’) to be
          inserted where there is malformed data.

        * ‘'surrogateescape'’ will represent any incorrect bytes as code
          points in the Unicode Private Use Area ranging from U+DC80 to
          U+DCFF. These private code points will then be turned back
          into the same bytes when the ‘surrogateescape’ error handler
          is used when writing data.  This is useful for processing
          files in an unknown encoding.

        * ‘'xmlcharrefreplace'’ is only supported when writing to a
          file.  Characters not supported by the encoding are replaced
          with the appropriate XML character reference ‘&#nnn;’.

        * ‘'backslashreplace'’ replaces malformed data by Python’s
          backslashed escape sequences.

        * ‘'namereplace'’ (also only supported when writing) replaces
          unsupported characters with ‘\N{...}’ escape sequences.

     `newline' controls how *note universal newlines: 5e9. mode works
     (it only applies to text mode).  It can be ‘None’, ‘''’, ‘'\n'’,
     ‘'\r'’, and ‘'\r\n'’.  It works as follows:

        * When reading input from the stream, if `newline' is ‘None’,
          universal newlines mode is enabled.  Lines in the input can
          end in ‘'\n'’, ‘'\r'’, or ‘'\r\n'’, and these are translated
          into ‘'\n'’ before being returned to the caller.  If it is
          ‘''’, universal newlines mode is enabled, but line endings are
          returned to the caller untranslated.  If it has any of the
          other legal values, input lines are only terminated by the
          given string, and the line ending is returned to the caller
          untranslated.

        * When writing output to the stream, if `newline' is ‘None’, any
          ‘'\n'’ characters written are translated to the system default
          line separator, *note os.linesep: 1537.  If `newline' is ‘''’
          or ‘'\n'’, no translation takes place.  If `newline' is any of
          the other legal values, any ‘'\n'’ characters written are
          translated to the given string.

     If `closefd' is ‘False’ and a file descriptor rather than a
     filename was given, the underlying file descriptor will be kept
     open when the file is closed.  If a filename is given `closefd'
     must be ‘True’ (the default) otherwise an error will be raised.

     A custom opener can be used by passing a callable as `opener'.  The
     underlying file descriptor for the file object is then obtained by
     calling `opener' with (`file', `flags').  `opener' must return an
     open file descriptor (passing *note os.open: 659. as `opener'
     results in functionality similar to passing ‘None’).

     The newly created file is *note non-inheritable: 7ee.

     The following example uses the *note dir_fd: a24. parameter of the
     *note os.open(): 659. function to open a file relative to a given
     directory:

          >>> import os
          >>> dir_fd = os.open('somedir', os.O_RDONLY)
          >>> def opener(path, flags):
          ...     return os.open(path, flags, dir_fd=dir_fd)
          ...
          >>> with open('spamspam.txt', 'w', opener=opener) as f:
          ...     print('This will be written to somedir/spamspam.txt', file=f)
          ...
          >>> os.close(dir_fd)  # don't leak a file descriptor

     The type of *note file object: b35. returned by the *note open():
     4e5. function depends on the mode.  When *note open(): 4e5. is used
     to open a file in a text mode (‘'w'’, ‘'r'’, ‘'wt'’, ‘'rt'’, etc.),
     it returns a subclass of *note io.TextIOBase: c2c. (specifically
     *note io.TextIOWrapper: 5e8.).  When used to open a file in a
     binary mode with buffering, the returned class is a subclass of
     *note io.BufferedIOBase: 57d.  The exact class varies: in read
     binary mode, it returns an *note io.BufferedReader: b7d.; in write
     binary and append binary modes, it returns an *note
     io.BufferedWriter: 1538, and in read/write mode, it returns an
     *note io.BufferedRandom: 1539.  When buffering is disabled, the raw
     stream, a subclass of *note io.RawIOBase: a08, *note io.FileIO:
     c97, is returned.

     See also the file handling modules, such as, *note fileinput: 80,
     *note io: a1. (where *note open(): 4e5. is declared), *note os: c4,
     *note os.path: c5, *note tempfile: 103, and *note shutil: e9.

     Raises an *note auditing event: 1275. ‘open’ with arguments ‘file’,
     ‘mode’, ‘flags’.

     The ‘mode’ and ‘flags’ arguments may have been modified or inferred
     from the original call.

          Changed in version 3.3:

             * The `opener' parameter was added.

             * The ‘'x'’ mode was added.

             * *note IOError: 986. used to be raised, it is now an alias
               of *note OSError: 1d1.

             * *note FileExistsError: 94c. is now raised if the file
               opened in exclusive creation mode (‘'x'’) already exists.

          Changed in version 3.4:

             * The file is now non-inheritable.

     Deprecated since version 3.4, will be removed in version 3.9: The
     ‘'U'’ mode.

          Changed in version 3.5:

             * If the system call is interrupted and the signal handler
               does not raise an exception, the function now retries the
               system call instead of raising an *note InterruptedError:
               64d. exception (see PEP 475(2) for the rationale).

             * The ‘'namereplace'’ error handler was added.

          Changed in version 3.6:

             * Support added to accept objects implementing *note
               os.PathLike: 4e0.

             * On Windows, opening a console buffer may return a
               subclass of *note io.RawIOBase: a08. other than *note
               io.FileIO: c97.

 -- Function: ord (c)

     Given a string representing one Unicode character, return an
     integer representing the Unicode code point of that character.  For
     example, ‘ord('a')’ returns the integer ‘97’ and ‘ord('€')’ (Euro
     sign) returns ‘8364’.  This is the inverse of *note chr(): 1363.

 -- Function: pow (base, exp[, mod])

     Return `base' to the power `exp'; if `mod' is present, return
     `base' to the power `exp', modulo `mod' (computed more efficiently
     than ‘pow(base, exp) % mod’).  The two-argument form ‘pow(base,
     exp)’ is equivalent to using the power operator: ‘base**exp’.

     The arguments must have numeric types.  With mixed operand types,
     the coercion rules for binary arithmetic operators apply.  For
     *note int: 184. operands, the result has the same type as the
     operands (after coercion) unless the second argument is negative;
     in that case, all arguments are converted to float and a float
     result is delivered.  For example, ‘10**2’ returns ‘100’, but
     ‘10**-2’ returns ‘0.01’.

     For *note int: 184. operands `base' and `exp', if `mod' is present,
     `mod' must also be of integer type and `mod' must be nonzero.  If
     `mod' is present and `exp' is negative, `base' must be relatively
     prime to `mod'.  In that case, ‘pow(inv_base, -exp, mod)’ is
     returned, where `inv_base' is an inverse to `base' modulo `mod'.

     Here’s an example of computing an inverse for ‘38’ modulo ‘97’:

          >>> pow(38, -1, mod=97)
          23
          >>> 23 * 38 % 97 == 1
          True

     Changed in version 3.8: For *note int: 184. operands, the
     three-argument form of ‘pow’ now allows the second argument to be
     negative, permitting computation of modular inverses.

     Changed in version 3.9: Allow keyword arguments.  Formerly, only
     positional arguments were supported.

 -- Function: print (*objects, sep=' ', end='\n', file=sys.stdout,
          flush=False)

     Print `objects' to the text stream `file', separated by `sep' and
     followed by `end'.  `sep', `end', `file' and `flush', if present,
     must be given as keyword arguments.

     All non-keyword arguments are converted to strings like *note
     str(): 325. does and written to the stream, separated by `sep' and
     followed by `end'.  Both `sep' and `end' must be strings; they can
     also be ‘None’, which means to use the default values.  If no
     `objects' are given, *note print(): 87a. will just write `end'.

     The `file' argument must be an object with a ‘write(string)’
     method; if it is not present or ‘None’, *note sys.stdout: 303. will
     be used.  Since printed arguments are converted to text strings,
     *note print(): 87a. cannot be used with binary mode file objects.
     For these, use ‘file.write(...)’ instead.

     Whether output is buffered is usually determined by `file', but if
     the `flush' keyword argument is true, the stream is forcibly
     flushed.

     Changed in version 3.3: Added the `flush' keyword argument.

 -- Class: property (fget=None, fset=None, fdel=None, doc=None)

     Return a property attribute.

     `fget' is a function for getting an attribute value.  `fset' is a
     function for setting an attribute value.  `fdel' is a function for
     deleting an attribute value.  And `doc' creates a docstring for the
     attribute.

     A typical use is to define a managed attribute ‘x’:

          class C:
              def __init__(self):
                  self._x = None

              def getx(self):
                  return self._x

              def setx(self, value):
                  self._x = value

              def delx(self):
                  del self._x

              x = property(getx, setx, delx, "I'm the 'x' property.")

     If `c' is an instance of `C', ‘c.x’ will invoke the getter, ‘c.x =
     value’ will invoke the setter and ‘del c.x’ the deleter.

     If given, `doc' will be the docstring of the property attribute.
     Otherwise, the property will copy `fget'’s docstring (if it
     exists).  This makes it possible to create read-only properties
     easily using *note property(): 1d5. as a *note decorator: 281.:

          class Parrot:
              def __init__(self):
                  self._voltage = 100000

              @property
              def voltage(self):
                  """Get the current voltage."""
                  return self._voltage

     The ‘@property’ decorator turns the ‘voltage()’ method into a
     “getter” for a read-only attribute with the same name, and it sets
     the docstring for `voltage' to “Get the current voltage.”

     A property object has ‘getter’, ‘setter’, and ‘deleter’ methods
     usable as decorators that create a copy of the property with the
     corresponding accessor function set to the decorated function.
     This is best explained with an example:

          class C:
              def __init__(self):
                  self._x = None

              @property
              def x(self):
                  """I'm the 'x' property."""
                  return self._x

              @x.setter
              def x(self, value):
                  self._x = value

              @x.deleter
              def x(self):
                  del self._x

     This code is exactly equivalent to the first example.  Be sure to
     give the additional functions the same name as the original
     property (‘x’ in this case.)

     The returned property object also has the attributes ‘fget’,
     ‘fset’, and ‘fdel’ corresponding to the constructor arguments.

     Changed in version 3.5: The docstrings of property objects are now
     writeable.

 -- Function: range (stop)

 -- Function: range (start, stop[, step])

     Rather than being a function, *note range: 9b2. is actually an
     immutable sequence type, as documented in *note Ranges: 153a. and
     *note Sequence Types — list, tuple, range: 11aa.

 -- Function: repr (object)

     Return a string containing a printable representation of an object.
     For many types, this function makes an attempt to return a string
     that would yield an object with the same value when passed to *note
     eval(): b83, otherwise the representation is a string enclosed in
     angle brackets that contains the name of the type of the object
     together with additional information often including the name and
     address of the object.  A class can control what this function
     returns for its instances by defining a *note __repr__(): 333.
     method.

 -- Function: reversed (seq)

     Return a reverse *note iterator: f73.  `seq' must be an object
     which has a *note __reversed__(): 524. method or supports the
     sequence protocol (the *note __len__(): dbe. method and the *note
     __getitem__(): 27a. method with integer arguments starting at ‘0’).

 -- Function: round (number[, ndigits])

     Return `number' rounded to `ndigits' precision after the decimal
     point.  If `ndigits' is omitted or is ‘None’, it returns the
     nearest integer to its input.

     For the built-in types supporting *note round(): c60, values are
     rounded to the closest multiple of 10 to the power minus `ndigits';
     if two multiples are equally close, rounding is done toward the
     even choice (so, for example, both ‘round(0.5)’ and ‘round(-0.5)’
     are ‘0’, and ‘round(1.5)’ is ‘2’).  Any integer value is valid for
     `ndigits' (positive, zero, or negative).  The return value is an
     integer if `ndigits' is omitted or ‘None’.  Otherwise the return
     value has the same type as `number'.

     For a general Python object ‘number’, ‘round’ delegates to
     ‘number.__round__’.

          Note: The behavior of *note round(): c60. for floats can be
          surprising: for example, ‘round(2.675, 2)’ gives ‘2.67’
          instead of the expected ‘2.68’.  This is not a bug: it’s a
          result of the fact that most decimal fractions can’t be
          represented exactly as a float.  See *note Floating Point
          Arithmetic; Issues and Limitations: 125c. for more
          information.

 -- Class: set ([iterable])

     Return a new *note set: b62. object, optionally with elements taken
     from `iterable'.  ‘set’ is a built-in class.  See *note set: b62.
     and *note Set Types — set, frozenset: 152d. for documentation about
     this class.

     For other containers see the built-in *note frozenset: be1, *note
     list: 260, *note tuple: 473, and *note dict: 1b6. classes, as well
     as the *note collections: 1e. module.

 -- Function: setattr (object, name, value)

     This is the counterpart of *note getattr(): 43d.  The arguments are
     an object, a string and an arbitrary value.  The string may name an
     existing attribute or a new attribute.  The function assigns the
     value to the attribute, provided the object allows it.  For
     example, ‘setattr(x, 'foobar', 123)’ is equivalent to ‘x.foobar =
     123’.

 -- Class: slice (stop)

 -- Class: slice (start, stop[, step])

     Return a *note slice: 153b. object representing the set of indices
     specified by ‘range(start, stop, step)’.  The `start' and `step'
     arguments default to ‘None’.  Slice objects have read-only data
     attributes ‘start’, ‘stop’ and ‘step’ which merely return the
     argument values (or their default).  They have no other explicit
     functionality; however they are used by Numerical Python and other
     third party extensions.  Slice objects are also generated when
     extended indexing syntax is used.  For example:
     ‘a[start:stop:step]’ or ‘a[start:stop, i]’.  See *note
     itertools.islice(): 397. for an alternate version that returns an
     iterator.

 -- Function: sorted (iterable, *, key=None, reverse=False)

     Return a new sorted list from the items in `iterable'.

     Has two optional arguments which must be specified as keyword
     arguments.

     `key' specifies a function of one argument that is used to extract
     a comparison key from each element in `iterable' (for example,
     ‘key=str.lower’).  The default value is ‘None’ (compare the
     elements directly).

     `reverse' is a boolean value.  If set to ‘True’, then the list
     elements are sorted as if each comparison were reversed.

     Use *note functools.cmp_to_key(): b49. to convert an old-style
     `cmp' function to a `key' function.

     The built-in *note sorted(): 439. function is guaranteed to be
     stable.  A sort is stable if it guarantees not to change the
     relative order of elements that compare equal — this is helpful for
     sorting in multiple passes (for example, sort by department, then
     by salary grade).

     For sorting examples and a brief sorting tutorial, see *note
     Sorting HOW TO: 153c.

 -- Function: @staticmethod

     Transform a method into a static method.

     A static method does not receive an implicit first argument.  To
     declare a static method, use this idiom:

          class C:
              @staticmethod
              def f(arg1, arg2, ...): ...

     The ‘@staticmethod’ form is a function *note decorator: 281. – see
     *note Function definitions: 1196. for details.

     A static method can be called either on the class (such as ‘C.f()’)
     or on an instance (such as ‘C().f()’).

     Static methods in Python are similar to those found in Java or C++.
     Also see *note classmethod(): 1d6. for a variant that is useful for
     creating alternate class constructors.

     Like all decorators, it is also possible to call ‘staticmethod’ as
     a regular function and do something with its result.  This is
     needed in some cases where you need a reference to a function from
     a class body and you want to avoid the automatic transformation to
     instance method.  For these cases, use this idiom:

          class C:
              builtin_open = staticmethod(open)

     For more information on static methods, see *note The standard type
     hierarchy: 135c.

 -- Class: str (object='')

 -- Class: str (object=b'', encoding='utf-8', errors='strict')

     Return a *note str: 325. version of `object'.  See *note str():
     325. for details.

     ‘str’ is the built-in string *note class: 153d.  For general
     information about strings, see *note Text Sequence Type — str:
     115d.

 -- Function: sum (iterable, /, start=0)

     Sums `start' and the items of an `iterable' from left to right and
     returns the total.  The `iterable'’s items are normally numbers,
     and the start value is not allowed to be a string.

     For some use cases, there are good alternatives to *note sum():
     1e3.  The preferred, fast way to concatenate a sequence of strings
     is by calling ‘''.join(sequence)’.  To add floating point values
     with extended precision, see *note math.fsum(): d31.  To
     concatenate a series of iterables, consider using *note
     itertools.chain(): 153e.

     Changed in version 3.8: The `start' parameter can be specified as a
     keyword argument.

 -- Function: super ([type[, object-or-type]])

     Return a proxy object that delegates method calls to a parent or
     sibling class of `type'.  This is useful for accessing inherited
     methods that have been overridden in a class.

     The `object-or-type' determines the *note method resolution order:
     153f. to be searched.  The search starts from the class right after
     the `type'.

     For example, if *note __mro__: 1540. of `object-or-type' is ‘D -> B
     -> C -> A -> object’ and the value of `type' is ‘B’, then *note
     super(): 4d7. searches ‘C -> A -> object’.

     The *note __mro__: 1540. attribute of the `object-or-type' lists
     the method resolution search order used by both *note getattr():
     43d. and *note super(): 4d7.  The attribute is dynamic and can
     change whenever the inheritance hierarchy is updated.

     If the second argument is omitted, the super object returned is
     unbound.  If the second argument is an object, ‘isinstance(obj,
     type)’ must be true.  If the second argument is a type,
     ‘issubclass(type2, type)’ must be true (this is useful for
     classmethods).

     There are two typical use cases for `super'.  In a class hierarchy
     with single inheritance, `super' can be used to refer to parent
     classes without naming them explicitly, thus making the code more
     maintainable.  This use closely parallels the use of `super' in
     other programming languages.

     The second use case is to support cooperative multiple inheritance
     in a dynamic execution environment.  This use case is unique to
     Python and is not found in statically compiled languages or
     languages that only support single inheritance.  This makes it
     possible to implement “diamond diagrams” where multiple base
     classes implement the same method.  Good design dictates that this
     method have the same calling signature in every case (because the
     order of calls is determined at runtime, because that order adapts
     to changes in the class hierarchy, and because that order can
     include sibling classes that are unknown prior to runtime).

     For both use cases, a typical superclass call looks like this:

          class C(B):
              def method(self, arg):
                  super().method(arg)    # This does the same thing as:
                                         # super(C, self).method(arg)

     In addition to method lookups, *note super(): 4d7. also works for
     attribute lookups.  One possible use case for this is calling *note
     descriptors: 1541. in a parent or sibling class.

     Note that *note super(): 4d7. is implemented as part of the binding
     process for explicit dotted attribute lookups such as
     ‘super().__getitem__(name)’.  It does so by implementing its own
     *note __getattribute__(): 43e. method for searching classes in a
     predictable order that supports cooperative multiple inheritance.
     Accordingly, *note super(): 4d7. is undefined for implicit lookups
     using statements or operators such as ‘super()[name]’.

     Also note that, aside from the zero argument form, *note super():
     4d7. is not limited to use inside methods.  The two argument form
     specifies the arguments exactly and makes the appropriate
     references.  The zero argument form only works inside a class
     definition, as the compiler fills in the necessary details to
     correctly retrieve the class being defined, as well as accessing
     the current instance for ordinary methods.

     For practical suggestions on how to design cooperative classes
     using *note super(): 4d7, see guide to using super()(3).

 -- Function: tuple ([iterable])

     Rather than being a function, *note tuple: 473. is actually an
     immutable sequence type, as documented in *note Tuples: 1542. and
     *note Sequence Types — list, tuple, range: 11aa.

 -- Class: type (object)

 -- Class: type (name, bases, dict)

     With one argument, return the type of an `object'.  The return
     value is a type object and generally the same object as returned by
     *note object.__class__: dfd.

     The *note isinstance(): 444. built-in function is recommended for
     testing the type of an object, because it takes subclasses into
     account.

     With three arguments, return a new type object.  This is
     essentially a dynamic form of the *note class: c5d. statement.  The
     `name' string is the class name and becomes the *note __name__:
     c5a. attribute; the `bases' tuple itemizes the base classes and
     becomes the *note __bases__: dfc. attribute; and the `dict'
     dictionary is the namespace containing definitions for class body
     and is copied to a standard dictionary to become the *note
     __dict__: 4f1. attribute.  For example, the following two
     statements create identical *note type: 5fd. objects:

          >>> class X:
          ...     a = 1
          ...
          >>> X = type('X', (object,), dict(a=1))

     See also *note Type Objects: 1543.

     Changed in version 3.6: Subclasses of *note type: 5fd. which don’t
     override ‘type.__new__’ may no longer use the one-argument form to
     get the type of an object.

 -- Function: vars ([object])

     Return the *note __dict__: 4f1. attribute for a module, class,
     instance, or any other object with a *note __dict__: 4f1.
     attribute.

     Objects such as modules and instances have an updateable *note
     __dict__: 4f1. attribute; however, other objects may have write
     restrictions on their *note __dict__: 4f1. attributes (for example,
     classes use a *note types.MappingProxyType: aab. to prevent direct
     dictionary updates).

     Without an argument, *note vars(): f6f. acts like *note locals():
     44a.  Note, the locals dictionary is only useful for reads since
     updates to the locals dictionary are ignored.

 -- Function: zip (*iterables)

     Make an iterator that aggregates elements from each of the
     iterables.

     Returns an iterator of tuples, where the `i'-th tuple contains the
     `i'-th element from each of the argument sequences or iterables.
     The iterator stops when the shortest input iterable is exhausted.
     With a single iterable argument, it returns an iterator of
     1-tuples.  With no arguments, it returns an empty iterator.
     Equivalent to:

          def zip(*iterables):
              # zip('ABCD', 'xy') --> Ax By
              sentinel = object()
              iterators = [iter(it) for it in iterables]
              while iterators:
                  result = []
                  for it in iterators:
                      elem = next(it, sentinel)
                      if elem is sentinel:
                          return
                      result.append(elem)
                  yield tuple(result)

     The left-to-right evaluation order of the iterables is guaranteed.
     This makes possible an idiom for clustering a data series into
     n-length groups using ‘zip(*[iter(s)]*n)’.  This repeats the `same'
     iterator ‘n’ times so that each output tuple has the result of ‘n’
     calls to the iterator.  This has the effect of dividing the input
     into n-length chunks.

     *note zip(): c25. should only be used with unequal length inputs
     when you don’t care about trailing, unmatched values from the
     longer iterables.  If those values are important, use *note
     itertools.zip_longest(): c24. instead.

     *note zip(): c25. in conjunction with the ‘*’ operator can be used
     to unzip a list:

          >>> x = [1, 2, 3]
          >>> y = [4, 5, 6]
          >>> zipped = zip(x, y)
          >>> list(zipped)
          [(1, 4), (2, 5), (3, 6)]
          >>> x2, y2 = zip(*zip(x, y))
          >>> x == list(x2) and y == list(y2)
          True

 -- Function: __import__ (name, globals=None, locals=None, fromlist=(),
          level=0)

          Note: This is an advanced function that is not needed in
          everyday Python programming, unlike *note
          importlib.import_module(): b06.

     This function is invoked by the *note import: c10. statement.  It
     can be replaced (by importing the *note builtins: 13. module and
     assigning to ‘builtins.__import__’) in order to change semantics of
     the ‘import’ statement, but doing so is `strongly' discouraged as
     it is usually simpler to use import hooks (see PEP 302(4)) to
     attain the same goals and does not cause issues with code which
     assumes the default import implementation is in use.  Direct use of
     *note __import__(): 605. is also discouraged in favor of *note
     importlib.import_module(): b06.

     The function imports the module `name', potentially using the given
     `globals' and `locals' to determine how to interpret the name in a
     package context.  The `fromlist' gives the names of objects or
     submodules that should be imported from the module given by `name'.
     The standard implementation does not use its `locals' argument at
     all, and uses its `globals' only to determine the package context
     of the *note import: c10. statement.

     `level' specifies whether to use absolute or relative imports.  ‘0’
     (the default) means only perform absolute imports.  Positive values
     for `level' indicate the number of parent directories to search
     relative to the directory of the module calling *note __import__():
     605. (see PEP 328(5) for the details).

     When the `name' variable is of the form ‘package.module’, normally,
     the top-level package (the name up till the first dot) is returned,
     `not' the module named by `name'.  However, when a non-empty
     `fromlist' argument is given, the module named by `name' is
     returned.

     For example, the statement ‘import spam’ results in bytecode
     resembling the following code:

          spam = __import__('spam', globals(), locals(), [], 0)

     The statement ‘import spam.ham’ results in this call:

          spam = __import__('spam.ham', globals(), locals(), [], 0)

     Note how *note __import__(): 605. returns the toplevel module here
     because this is the object that is bound to a name by the *note
     import: c10. statement.

     On the other hand, the statement ‘from spam.ham import eggs,
     sausage as saus’ results in

          _temp = __import__('spam.ham', globals(), locals(), ['eggs', 'sausage'], 0)
          eggs = _temp.eggs
          saus = _temp.sausage

     Here, the ‘spam.ham’ module is returned from *note __import__():
     605.  From this object, the names to import are retrieved and
     assigned to their respective names.

     If you simply want to import a module (potentially within a
     package) by name, use *note importlib.import_module(): b06.

     Changed in version 3.3: Negative values for `level' are no longer
     supported (which also changes the default value to 0).

   ---------- Footnotes ----------

   (1) (1) Note that the parser only accepts the Unix-style end of line
convention.  If you are reading the code from a file, make sure to use
newline conversion mode to convert Windows or Mac-style newlines.

   (2) https://www.python.org/dev/peps/pep-0475

   (3) 
https://rhettinger.wordpress.com/2011/05/26/super-considered-super/

   (4) https://www.python.org/dev/peps/pep-0302

   (5) https://www.python.org/dev/peps/pep-0328


File: python.info,  Node: Built-in Constants,  Next: Built-in Types,  Prev: Built-in Functions,  Up: The Python Standard Library

5.3 Built-in Constants
======================

A small number of constants live in the built-in namespace.  They are:

 -- Data: False

     The false value of the *note bool: 183. type.  Assignments to
     ‘False’ are illegal and raise a *note SyntaxError: 44d.

 -- Data: True

     The true value of the *note bool: 183. type.  Assignments to ‘True’
     are illegal and raise a *note SyntaxError: 44d.

 -- Data: None

     The sole value of the type ‘NoneType’.  ‘None’ is frequently used
     to represent the absence of a value, as when default arguments are
     not passed to a function.  Assignments to ‘None’ are illegal and
     raise a *note SyntaxError: 44d.

 -- Data: NotImplemented

     Special value which should be returned by the binary special
     methods (e.g.  *note __eq__(): 334, *note __lt__(): c27, *note
     __add__(): 1393, *note __rsub__(): 13a5, etc.)  to indicate that
     the operation is not implemented with respect to the other type;
     may be returned by the in-place binary special methods (e.g.  *note
     __imul__(): 1397, *note __iand__(): 13b5, etc.)  for the same
     purpose.  Its truth value is true.

          Note: When a binary (or in-place) method returns
          ‘NotImplemented’ the interpreter will try the reflected
          operation on the other type (or some other fallback, depending
          on the operator).  If all attempts return ‘NotImplemented’,
          the interpreter will raise an appropriate exception.
          Incorrectly returning ‘NotImplemented’ will result in a
          misleading error message or the ‘NotImplemented’ value being
          returned to Python code.

          See *note Implementing the arithmetic operations: 135d. for
          examples.

          Note: ‘NotImplementedError’ and ‘NotImplemented’ are not
          interchangeable, even though they have similar names and
          purposes.  See *note NotImplementedError: 603. for details on
          when to use it.

 -- Data: Ellipsis

     The same as the ellipsis literal “‘...’”.  Special value used
     mostly in conjunction with extended slicing syntax for user-defined
     container data types.

 -- Data: __debug__

     This constant is true if Python was not started with an *note -O:
     67f. option.  See also the *note assert: df9. statement.

     Note: The names *note None: 157, *note False: 37d, *note True: 48f.
     and *note __debug__: f30. cannot be reassigned (assignments to
     them, even as an attribute name, raise *note SyntaxError: 44d.), so
     they can be considered “true” constants.

* Menu:

* Constants added by the site module::


File: python.info,  Node: Constants added by the site module,  Up: Built-in Constants

5.3.1 Constants added by the ‘site’ module
------------------------------------------

The *note site: eb. module (which is imported automatically during
startup, except if the *note -S: b17. command-line option is given) adds
several constants to the built-in namespace.  They are useful for the
interactive interpreter shell and should not be used in programs.

 -- Data: quit (code=None)
 -- Data: exit (code=None)

     Objects that when printed, print a message like “Use quit() or
     Ctrl-D (i.e.  EOF) to exit”, and when called, raise *note
     SystemExit: 5f1. with the specified exit code.

 -- Data: copyright
 -- Data: credits

     Objects that when printed or called, print the text of copyright or
     credits, respectively.

 -- Data: license

     Object that when printed, prints the message “Type license() to see
     the full license text”, and when called, displays the full license
     text in a pager-like fashion (one screen at a time).


File: python.info,  Node: Built-in Types,  Next: Built-in Exceptions,  Prev: Built-in Constants,  Up: The Python Standard Library

5.4 Built-in Types
==================

The following sections describe the standard types that are built into
the interpreter.

The principal built-in types are numerics, sequences, mappings, classes,
instances and exceptions.

Some collection classes are mutable.  The methods that add, subtract, or
rearrange their members in place, and don’t return a specific item,
never return the collection instance itself but ‘None’.

Some operations are supported by several object types; in particular,
practically all objects can be compared for equality, tested for truth
value, and converted to a string (with the *note repr(): 7c0. function
or the slightly different *note str(): 325. function).  The latter
function is implicitly used when an object is written by the *note
print(): 87a. function.

* Menu:

* Truth Value Testing::
* Boolean Operations — and, or, not: Boolean Operations — and or not.
* Comparisons: Comparisons<2>.
* Numeric Types — int, float, complex: Numeric Types — int float complex.
* Iterator Types::
* Sequence Types — list, tuple, range: Sequence Types — list tuple range.
* Text Sequence Type — str::
* Binary Sequence Types — bytes, bytearray, memoryview: Binary Sequence Types — bytes bytearray memoryview.
* Set Types — set, frozenset: Set Types — set frozenset.
* Mapping Types — dict::
* Context Manager Types::
* Other Built-in Types::
* Special Attributes::


File: python.info,  Node: Truth Value Testing,  Next: Boolean Operations — and or not,  Up: Built-in Types

5.4.1 Truth Value Testing
-------------------------

Any object can be tested for truth value, for use in an *note if: dda.
or *note while: 1167. condition or as operand of the Boolean operations
below.

By default, an object is considered true unless its class defines either
a *note __bool__(): c5b. method that returns ‘False’ or a *note
__len__(): dbe. method that returns zero, when called with the object.
(1) Here are most of the built-in objects considered false:

   * constants defined to be false: ‘None’ and ‘False’.

   * zero of any numeric type: ‘0’, ‘0.0’, ‘0j’, ‘Decimal(0)’,
     ‘Fraction(0, 1)’

   * empty sequences and collections: ‘''’, ‘()’, ‘[]’, ‘{}’, ‘set()’,
     ‘range(0)’

Operations and built-in functions that have a Boolean result always
return ‘0’ or ‘False’ for false and ‘1’ or ‘True’ for true, unless
otherwise stated.  (Important exception: the Boolean operations ‘or’ and
‘and’ always return one of their operands.)

   ---------- Footnotes ----------

   (1) (1) Additional information on these special methods may be found
in the Python Reference Manual (*note Basic customization: 1371.).


File: python.info,  Node: Boolean Operations — and or not,  Next: Comparisons<2>,  Prev: Truth Value Testing,  Up: Built-in Types

5.4.2 Boolean Operations — ‘and’, ‘or’, ‘not’
---------------------------------------------

These are the Boolean operations, ordered by ascending priority:

Operation         Result                                Notes
                                                        
--------------------------------------------------------------------
                                                        
‘x or y’          if `x' is false, then `y', else `x'   (1)
                                                        
                                                        
‘x and y’         if `x' is false, then `x', else `y'   (2)
                                                        
                                                        
‘not x’           if `x' is false, then ‘True’, else    (3)
                  ‘False’                               
                  

Notes:

  1. This is a short-circuit operator, so it only evaluates the second
     argument if the first one is false.

  2. This is a short-circuit operator, so it only evaluates the second
     argument if the first one is true.

  3. ‘not’ has a lower priority than non-Boolean operators, so ‘not a ==
     b’ is interpreted as ‘not (a == b)’, and ‘a == not b’ is a syntax
     error.


File: python.info,  Node: Comparisons<2>,  Next: Numeric Types — int float complex,  Prev: Boolean Operations — and or not,  Up: Built-in Types

5.4.3 Comparisons
-----------------

There are eight comparison operations in Python.  They all have the same
priority (which is higher than that of the Boolean operations).
Comparisons can be chained arbitrarily; for example, ‘x < y <= z’ is
equivalent to ‘x < y and y <= z’, except that `y' is evaluated only once
(but in both cases `z' is not evaluated at all when ‘x < y’ is found to
be false).

This table summarizes the comparison operations:

Operation        Meaning
                 
-----------------------------------------------
                 
‘<’              strictly less than
                 
                 
‘<=’             less than or equal
                 
                 
‘>’              strictly greater than
                 
                 
‘>=’             greater than or equal
                 
                 
‘==’             equal
                 
                 
‘!=’             not equal
                 
                 
‘is’             object identity
                 
                 
‘is not’         negated object identity
                 

Objects of different types, except different numeric types, never
compare equal.  The ‘==’ operator is always defined but for some object
types (for example, class objects) is equivalent to *note is: 135a.  The
‘<’, ‘<=’, ‘>’ and ‘>=’ operators are only defined where they make
sense; for example, they raise a *note TypeError: 192. exception when
one of the arguments is a complex number.

Non-identical instances of a class normally compare as non-equal unless
the class defines the *note __eq__(): 334. method.

Instances of a class cannot be ordered with respect to other instances
of the same class, or other types of object, unless the class defines
enough of the methods *note __lt__(): c27, *note __le__(): c93, *note
__gt__(): c94, and *note __ge__(): c95. (in general, *note __lt__():
c27. and *note __eq__(): 334. are sufficient, if you want the
conventional meanings of the comparison operators).

The behavior of the *note is: 135a. and *note is not: 1486. operators
cannot be customized; also they can be applied to any two objects and
never raise an exception.

Two more operations with the same syntactic priority, *note in: 797. and
*note not in: 1399, are supported by types that are *note iterable: b9f.
or implement the *note __contains__(): d1b. method.


File: python.info,  Node: Numeric Types — int float complex,  Next: Iterator Types,  Prev: Comparisons<2>,  Up: Built-in Types

5.4.4 Numeric Types — ‘int’, ‘float’, ‘complex’
-----------------------------------------------

There are three distinct numeric types: `integers', `floating point
numbers', and `complex numbers'.  In addition, Booleans are a subtype of
integers.  Integers have unlimited precision.  Floating point numbers
are usually implemented using ‘double’ in C; information about the
precision and internal representation of floating point numbers for the
machine on which your program is running is available in *note
sys.float_info: ef3.  Complex numbers have a real and imaginary part,
which are each a floating point number.  To extract these parts from a
complex number `z', use ‘z.real’ and ‘z.imag’.  (The standard library
includes the additional numeric types *note fractions.Fraction: 185, for
rationals, and *note decimal.Decimal: 188, for floating-point numbers
with user-definable precision.)

Numbers are created by numeric literals or as the result of built-in
functions and operators.  Unadorned integer literals (including hex,
octal and binary numbers) yield integers.  Numeric literals containing a
decimal point or an exponent sign yield floating point numbers.
Appending ‘'j'’ or ‘'J'’ to a numeric literal yields an imaginary number
(a complex number with a zero real part) which you can add to an integer
or float to get a complex number with real and imaginary parts.

Python fully supports mixed arithmetic: when a binary arithmetic
operator has operands of different numeric types, the operand with the
“narrower” type is widened to that of the other, where integer is
narrower than floating point, which is narrower than complex.
Comparisons between numbers of mixed type use the same rule.  (1) The
constructors *note int(): 184, *note float(): 187, and *note complex():
189. can be used to produce numbers of a specific type.

All numeric types (except complex) support the following operations (for
priorities of the operations, see *note Operator precedence: 149f.):

Operation                 Result                                Notes         Full documentation
                                                                              
-------------------------------------------------------------------------------------------------------
                                                                              
‘x + y’                   sum of `x' and `y'
                          
                                                                              
‘x - y’                   difference of `x' and `y'
                          
                                                                              
‘x * y’                   product of `x' and `y'
                          
                                                                              
‘x / y’                   quotient of `x' and `y'
                          
                                                                              
‘x // y’                  floored quotient of `x' and `y'       (1)
                                                                
                                                                              
‘x % y’                   remainder of ‘x / y’                  (2)
                                                                
                                                                              
‘-x’                      `x' negated
                          
                                                                              
‘+x’                      `x' unchanged
                          
                                                                              
‘abs(x)’                  absolute value or magnitude of `x'                  *note abs(): 11f8.
                                                                              
                                                                              
‘int(x)’                  `x' converted to integer              (3)(6)        *note int(): 184.
                                                                              
                                                                              
‘float(x)’                `x' converted to floating point       (4)(6)        *note float(): 187.
                                                                              
                                                                              
‘complex(re, im)’         a complex number with real part       (6)           *note complex(): 189.
                          `re', imaginary part `im'.  `im'                    
                          defaults to zero.
                          
                                                                              
‘c.conjugate()’           conjugate of the complex number `c'
                          
                                                                              
‘divmod(x, y)’            the pair ‘(x // y, x % y)’            (2)           *note divmod(): f4d.
                                                                              
                                                                              
‘pow(x, y)’               `x' to the power `y'                  (5)           *note pow(): 152.
                                                                              
                                                                              
‘x ** y’                  `x' to the power `y'                  (5)
                                                                

Notes:

  1. Also referred to as integer division.  The resultant value is a
     whole integer, though the result’s type is not necessarily int.
     The result is always rounded towards minus infinity: ‘1//2’ is ‘0’,
     ‘(-1)//2’ is ‘-1’, ‘1//(-2)’ is ‘-1’, and ‘(-1)//(-2)’ is ‘0’.

  2. Not for complex numbers.  Instead convert to floats using *note
     abs(): 11f8. if appropriate.

  3. 
     Conversion from floating point to integer may round or truncate as
     in C; see functions *note math.floor(): d1f. and *note math.ceil():
     d20. for well-defined conversions.

  4. float also accepts the strings “nan” and “inf” with an optional
     prefix “+” or “-” for Not a Number (NaN) and positive or negative
     infinity.

  5. Python defines ‘pow(0, 0)’ and ‘0 ** 0’ to be ‘1’, as is common for
     programming languages.

  6. The numeric literals accepted include the digits ‘0’ to ‘9’ or any
     Unicode equivalent (code points with the ‘Nd’ property).

     See
     ‘http://www.unicode.org/Public/12.1.0/ucd/extracted/DerivedNumericType.txt’
     for a complete list of code points with the ‘Nd’ property.

All *note numbers.Real: 1360. types (*note int: 184. and *note float:
187.) also include the following operations:

Operation                Result
                         
---------------------------------------------------------------------------
                         
*note math.trunc(x): d21.`x' truncated to *note Integral: 135f.
                         
                         
*note round(x[, n]): c60.`x' rounded to `n' digits, rounding half to
                         even.  If `n' is omitted, it defaults to 0.
                         
                         
*note math.floor(x): d1f.the greatest *note Integral: 135f. <= `x'
                         
                         
*note math.ceil(x): d20. the least *note Integral: 135f. >= `x'
                         

For additional numeric operations see the *note math: b1. and *note
cmath: 19. modules.

* Menu:

* Bitwise Operations on Integer Types::
* Additional Methods on Integer Types::
* Additional Methods on Float::
* Hashing of numeric types::

   ---------- Footnotes ----------

   (1) (2) As a consequence, the list ‘[1, 2]’ is considered equal to
‘[1.0, 2.0]’, and similarly for tuples.


File: python.info,  Node: Bitwise Operations on Integer Types,  Next: Additional Methods on Integer Types,  Up: Numeric Types — int float complex

5.4.4.1 Bitwise Operations on Integer Types
...........................................

Bitwise operations only make sense for integers.  The result of bitwise
operations is calculated as though carried out in two’s complement with
an infinite number of sign bits.

The priorities of the binary bitwise operations are all lower than the
numeric operations and higher than the comparisons; the unary operation
‘~’ has the same priority as the other unary numeric operations (‘+’ and
‘-’).

This table lists the bitwise operations sorted in ascending priority:

Operation        Result                               Notes
                                                      
---------------------------------------------------------------------
                                                      
‘x | y’          bitwise `or' of `x' and `y'          (4)
                                                      
                                                      
‘x ^ y’          bitwise `exclusive or' of `x' and    (4)
                 `y'                                  
                 
                                                      
‘x & y’          bitwise `and' of `x' and `y'         (4)
                                                      
                                                      
‘x << n’         `x' shifted left by `n' bits         (1)(2)
                                                      
                                                      
‘x >> n’         `x' shifted right by `n' bits        (1)(3)
                                                      
                                                      
‘~x’             the bits of `x' inverted
                 

Notes:

  1. Negative shift counts are illegal and cause a *note ValueError:
     1f9. to be raised.

  2. A left shift by `n' bits is equivalent to multiplication by ‘pow(2,
     n)’ without overflow check.

  3. A right shift by `n' bits is equivalent to division by ‘pow(2, n)’
     without overflow check.

  4. Performing these calculations with at least one extra sign
     extension bit in a finite two’s complement representation (a
     working bit-width of ‘1 + max(x.bit_length(), y.bit_length())’ or
     more) is sufficient to get the same result as if there were an
     infinite number of sign bits.


File: python.info,  Node: Additional Methods on Integer Types,  Next: Additional Methods on Float,  Prev: Bitwise Operations on Integer Types,  Up: Numeric Types — int float complex

5.4.4.2 Additional Methods on Integer Types
...........................................

The int type implements the *note numbers.Integral: 135f. *note abstract
base class: b26.  In addition, it provides a few more methods:

 -- Method: int.bit_length ()

     Return the number of bits necessary to represent an integer in
     binary, excluding the sign and leading zeros:

          >>> n = -37
          >>> bin(n)
          '-0b100101'
          >>> n.bit_length()
          6

     More precisely, if ‘x’ is nonzero, then ‘x.bit_length()’ is the
     unique positive integer ‘k’ such that ‘2**(k-1) <= abs(x) < 2**k’.
     Equivalently, when ‘abs(x)’ is small enough to have a correctly
     rounded logarithm, then ‘k = 1 + int(log(abs(x), 2))’.  If ‘x’ is
     zero, then ‘x.bit_length()’ returns ‘0’.

     Equivalent to:

          def bit_length(self):
              s = bin(self)       # binary representation:  bin(-37) --> '-0b100101'
              s = s.lstrip('-0b') # remove leading zeros and minus sign
              return len(s)       # len('100101') --> 6

     New in version 3.1.

 -- Method: int.to_bytes (length, byteorder, *, signed=False)

     Return an array of bytes representing an integer.

          >>> (1024).to_bytes(2, byteorder='big')
          b'\x04\x00'
          >>> (1024).to_bytes(10, byteorder='big')
          b'\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00'
          >>> (-1024).to_bytes(10, byteorder='big', signed=True)
          b'\xff\xff\xff\xff\xff\xff\xff\xff\xfc\x00'
          >>> x = 1000
          >>> x.to_bytes((x.bit_length() + 7) // 8, byteorder='little')
          b'\xe8\x03'

     The integer is represented using `length' bytes.  An *note
     OverflowError: 954. is raised if the integer is not representable
     with the given number of bytes.

     The `byteorder' argument determines the byte order used to
     represent the integer.  If `byteorder' is ‘"big"’, the most
     significant byte is at the beginning of the byte array.  If
     `byteorder' is ‘"little"’, the most significant byte is at the end
     of the byte array.  To request the native byte order of the host
     system, use *note sys.byteorder: 155c. as the byte order value.

     The `signed' argument determines whether two’s complement is used
     to represent the integer.  If `signed' is ‘False’ and a negative
     integer is given, an *note OverflowError: 954. is raised.  The
     default value for `signed' is ‘False’.

     New in version 3.2.

 -- Class Method: int.from_bytes (bytes, byteorder, *, signed=False)

     Return the integer represented by the given array of bytes.

          >>> int.from_bytes(b'\x00\x10', byteorder='big')
          16
          >>> int.from_bytes(b'\x00\x10', byteorder='little')
          4096
          >>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=True)
          -1024
          >>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=False)
          64512
          >>> int.from_bytes([255, 0, 0], byteorder='big')
          16711680

     The argument `bytes' must either be a *note bytes-like object: 5dd.
     or an iterable producing bytes.

     The `byteorder' argument determines the byte order used to
     represent the integer.  If `byteorder' is ‘"big"’, the most
     significant byte is at the beginning of the byte array.  If
     `byteorder' is ‘"little"’, the most significant byte is at the end
     of the byte array.  To request the native byte order of the host
     system, use *note sys.byteorder: 155c. as the byte order value.

     The `signed' argument indicates whether two’s complement is used to
     represent the integer.

     New in version 3.2.

 -- Method: int.as_integer_ratio ()

     Return a pair of integers whose ratio is exactly equal to the
     original integer and with a positive denominator.  The integer
     ratio of integers (whole numbers) is always the integer as the
     numerator and ‘1’ as the denominator.

     New in version 3.8.


File: python.info,  Node: Additional Methods on Float,  Next: Hashing of numeric types,  Prev: Additional Methods on Integer Types,  Up: Numeric Types — int float complex

5.4.4.3 Additional Methods on Float
...................................

The float type implements the *note numbers.Real: 1360. *note abstract
base class: b26.  float also has the following additional methods.

 -- Method: float.as_integer_ratio ()

     Return a pair of integers whose ratio is exactly equal to the
     original float and with a positive denominator.  Raises *note
     OverflowError: 954. on infinities and a *note ValueError: 1f9. on
     NaNs.

 -- Method: float.is_integer ()

     Return ‘True’ if the float instance is finite with integral value,
     and ‘False’ otherwise:

          >>> (-2.0).is_integer()
          True
          >>> (3.2).is_integer()
          False

Two methods support conversion to and from hexadecimal strings.  Since
Python’s floats are stored internally as binary numbers, converting a
float to or from a `decimal' string usually involves a small rounding
error.  In contrast, hexadecimal strings allow exact representation and
specification of floating-point numbers.  This can be useful when
debugging, and in numerical work.

 -- Method: float.hex ()

     Return a representation of a floating-point number as a hexadecimal
     string.  For finite floating-point numbers, this representation
     will always include a leading ‘0x’ and a trailing ‘p’ and exponent.

 -- Class Method: float.fromhex (s)

     Class method to return the float represented by a hexadecimal
     string `s'.  The string `s' may have leading and trailing
     whitespace.

Note that *note float.hex(): 125e. is an instance method, while *note
float.fromhex(): 1560. is a class method.

A hexadecimal string takes the form:

     [sign] ['0x'] integer ['.' fraction] ['p' exponent]

where the optional ‘sign’ may by either ‘+’ or ‘-’, ‘integer’ and
‘fraction’ are strings of hexadecimal digits, and ‘exponent’ is a
decimal integer with an optional leading sign.  Case is not significant,
and there must be at least one hexadecimal digit in either the integer
or the fraction.  This syntax is similar to the syntax specified in
section 6.4.4.2 of the C99 standard, and also to the syntax used in Java
1.5 onwards.  In particular, the output of *note float.hex(): 125e. is
usable as a hexadecimal floating-point literal in C or Java code, and
hexadecimal strings produced by C’s ‘%a’ format character or Java’s
‘Double.toHexString’ are accepted by *note float.fromhex(): 1560.

Note that the exponent is written in decimal rather than hexadecimal,
and that it gives the power of 2 by which to multiply the coefficient.
For example, the hexadecimal string ‘0x3.a7p10’ represents the
floating-point number ‘(3 + 10./16 + 7./16**2) * 2.0**10’, or ‘3740.0’:

     >>> float.fromhex('0x3.a7p10')
     3740.0

Applying the reverse conversion to ‘3740.0’ gives a different
hexadecimal string representing the same number:

     >>> float.hex(3740.0)
     '0x1.d380000000000p+11'


File: python.info,  Node: Hashing of numeric types,  Prev: Additional Methods on Float,  Up: Numeric Types — int float complex

5.4.4.4 Hashing of numeric types
................................

For numbers ‘x’ and ‘y’, possibly of different types, it’s a requirement
that ‘hash(x) == hash(y)’ whenever ‘x == y’ (see the *note __hash__():
335. method documentation for more details).  For ease of implementation
and efficiency across a variety of numeric types (including *note int:
184, *note float: 187, *note decimal.Decimal: 188. and *note
fractions.Fraction: 185.) Python’s hash for numeric types is based on a
single mathematical function that’s defined for any rational number, and
hence applies to all instances of *note int: 184. and *note
fractions.Fraction: 185, and all finite instances of *note float: 187.
and *note decimal.Decimal: 188.  Essentially, this function is given by
reduction modulo ‘P’ for a fixed prime ‘P’.  The value of ‘P’ is made
available to Python as the ‘modulus’ attribute of *note sys.hash_info:
915.

`CPython implementation detail:' Currently, the prime used is ‘P = 2**31
- 1’ on machines with 32-bit C longs and ‘P = 2**61 - 1’ on machines
with 64-bit C longs.

Here are the rules in detail:

   - If ‘x = m / n’ is a nonnegative rational number and ‘n’ is not
     divisible by ‘P’, define ‘hash(x)’ as ‘m * invmod(n, P) % P’, where
     ‘invmod(n, P)’ gives the inverse of ‘n’ modulo ‘P’.

   - If ‘x = m / n’ is a nonnegative rational number and ‘n’ is
     divisible by ‘P’ (but ‘m’ is not) then ‘n’ has no inverse modulo
     ‘P’ and the rule above doesn’t apply; in this case define ‘hash(x)’
     to be the constant value ‘sys.hash_info.inf’.

   - If ‘x = m / n’ is a negative rational number define ‘hash(x)’ as
     ‘-hash(-x)’.  If the resulting hash is ‘-1’, replace it with ‘-2’.

   - The particular values ‘sys.hash_info.inf’, ‘-sys.hash_info.inf’ and
     ‘sys.hash_info.nan’ are used as hash values for positive infinity,
     negative infinity, or nans (respectively).  (All hashable nans have
     the same hash value.)

   - For a *note complex: 189. number ‘z’, the hash values of the real
     and imaginary parts are combined by computing ‘hash(z.real) +
     sys.hash_info.imag * hash(z.imag)’, reduced modulo
     ‘2**sys.hash_info.width’ so that it lies in
     ‘range(-2**(sys.hash_info.width - 1), 2**(sys.hash_info.width -
     1))’.  Again, if the result is ‘-1’, it’s replaced with ‘-2’.

To clarify the above rules, here’s some example Python code, equivalent
to the built-in hash, for computing the hash of a rational number, *note
float: 187, or *note complex: 189.:

     import sys, math

     def hash_fraction(m, n):
         """Compute the hash of a rational number m / n.

         Assumes m and n are integers, with n positive.
         Equivalent to hash(fractions.Fraction(m, n)).

         """
         P = sys.hash_info.modulus
         # Remove common factors of P.  (Unnecessary if m and n already coprime.)
         while m % P == n % P == 0:
             m, n = m // P, n // P

         if n % P == 0:
             hash_value = sys.hash_info.inf
         else:
             # Fermat's Little Theorem: pow(n, P-1, P) is 1, so
             # pow(n, P-2, P) gives the inverse of n modulo P.
             hash_value = (abs(m) % P) * pow(n, P - 2, P) % P
         if m < 0:
             hash_value = -hash_value
         if hash_value == -1:
             hash_value = -2
         return hash_value

     def hash_float(x):
         """Compute the hash of a float x."""

         if math.isnan(x):
             return sys.hash_info.nan
         elif math.isinf(x):
             return sys.hash_info.inf if x > 0 else -sys.hash_info.inf
         else:
             return hash_fraction(*x.as_integer_ratio())

     def hash_complex(z):
         """Compute the hash of a complex number z."""

         hash_value = hash_float(z.real) + sys.hash_info.imag * hash_float(z.imag)
         # do a signed reduction modulo 2**sys.hash_info.width
         M = 2**(sys.hash_info.width - 1)
         hash_value = (hash_value & (M - 1)) - (hash_value & M)
         if hash_value == -1:
             hash_value = -2
         return hash_value


File: python.info,  Node: Iterator Types,  Next: Sequence Types — list tuple range,  Prev: Numeric Types — int float complex,  Up: Built-in Types

5.4.5 Iterator Types
--------------------

Python supports a concept of iteration over containers.  This is
implemented using two distinct methods; these are used to allow
user-defined classes to support iteration.  Sequences, described below
in more detail, always support the iteration methods.

One method needs to be defined for container objects to provide
iteration support:

 -- Method: container.__iter__ ()

     Return an iterator object.  The object is required to support the
     iterator protocol described below.  If a container supports
     different types of iteration, additional methods can be provided to
     specifically request iterators for those iteration types.  (An
     example of an object supporting multiple forms of iteration would
     be a tree structure which supports both breadth-first and
     depth-first traversal.)  This method corresponds to the *note
     tp_iter: e23. slot of the type structure for Python objects in the
     Python/C API.

The iterator objects themselves are required to support the following
two methods, which together form the `iterator protocol':

 -- Method: iterator.__iter__ ()

     Return the iterator object itself.  This is required to allow both
     containers and iterators to be used with the *note for: c23. and
     *note in: 797. statements.  This method corresponds to the *note
     tp_iter: e23. slot of the type structure for Python objects in the
     Python/C API.

 -- Method: iterator.__next__ ()

     Return the next item from the container.  If there are no further
     items, raise the *note StopIteration: 47b. exception.  This method
     corresponds to the *note tp_iternext: e24. slot of the type
     structure for Python objects in the Python/C API.

Python defines several iterator objects to support iteration over
general and specific sequence types, dictionaries, and other more
specialized forms.  The specific types are not important beyond their
implementation of the iterator protocol.

Once an iterator’s *note __next__(): c57. method raises *note
StopIteration: 47b, it must continue to do so on subsequent calls.
Implementations that do not obey this property are deemed broken.

* Menu:

* Generator Types::


File: python.info,  Node: Generator Types,  Up: Iterator Types

5.4.5.1 Generator Types
.......................

Python’s *note generator: 996.s provide a convenient way to implement
the iterator protocol.  If a container object’s *note __iter__(): 504.
method is implemented as a generator, it will automatically return an
iterator object (technically, a generator object) supplying the *note
__iter__(): 504. and *note __next__(): 1213. methods.  More information
about generators can be found in *note the documentation for the yield
expression: 143e.


File: python.info,  Node: Sequence Types — list tuple range,  Next: Text Sequence Type — str,  Prev: Iterator Types,  Up: Built-in Types

5.4.6 Sequence Types — ‘list’, ‘tuple’, ‘range’
-----------------------------------------------

There are three basic sequence types: lists, tuples, and range objects.
Additional sequence types tailored for processing of *note binary data:
1523. and *note text strings: 115d. are described in dedicated sections.

* Menu:

* Common Sequence Operations::
* Immutable Sequence Types::
* Mutable Sequence Types::
* Lists: Lists<2>.
* Tuples::
* Ranges::


File: python.info,  Node: Common Sequence Operations,  Next: Immutable Sequence Types,  Up: Sequence Types — list tuple range

5.4.6.1 Common Sequence Operations
..................................

The operations in the following table are supported by most sequence
types, both mutable and immutable.  The *note collections.abc.Sequence:
156b. ABC is provided to make it easier to correctly implement these
operations on custom sequence types.

This table lists the sequence operations sorted in ascending priority.
In the table, `s' and `t' are sequences of the same type, `n', `i', `j'
and `k' are integers and `x' is an arbitrary object that meets any type
and value restrictions imposed by `s'.

The ‘in’ and ‘not in’ operations have the same priorities as the
comparison operations.  The ‘+’ (concatenation) and ‘*’ (repetition)
operations have the same priority as the corresponding numeric
operations.  (1)

Operation                      Result                               Notes
                                                                    
-----------------------------------------------------------------------------------
                                                                    
‘x in s’                       ‘True’ if an item of `s' is equal    (1)
                               to `x', else ‘False’                 
                               
                                                                    
‘x not in s’                   ‘False’ if an item of `s' is equal   (1)
                               to `x', else ‘True’                  
                               
                                                                    
‘s + t’                        the concatenation of `s' and `t'     (6)(7)
                                                                    
                                                                    
‘s * n’ or ‘n * s’             equivalent to adding `s' to itself   (2)(7)
                               `n' times                            
                               
                                                                    
‘s[i]’                         `i'th item of `s', origin 0          (3)
                                                                    
                                                                    
‘s[i:j]’                       slice of `s' from `i' to `j'         (3)(4)
                                                                    
                                                                    
‘s[i:j:k]’                     slice of `s' from `i' to `j' with    (3)(5)
                               step `k'                             
                               
                                                                    
‘len(s)’                       length of `s'
                               
                                                                    
‘min(s)’                       smallest item of `s'
                               
                                                                    
‘max(s)’                       largest item of `s'
                               
                                                                    
‘s.index(x[, i[, j]])’         index of the first occurrence of     (8)
                               `x' in `s' (at or after index `i'    
                               and before index `j')
                               
                                                                    
‘s.count(x)’                   total number of occurrences of `x'
                               in `s'
                               

Sequences of the same type also support comparisons.  In particular,
tuples and lists are compared lexicographically by comparing
corresponding elements.  This means that to compare equal, every element
must compare equal and the two sequences must be of the same type and
have the same length.  (For full details see *note Comparisons: 147f. in
the language reference.)

Notes:

  1. While the ‘in’ and ‘not in’ operations are used only for simple
     containment testing in the general case, some specialised sequences
     (such as *note str: 325, *note bytes: 326. and *note bytearray:
     327.) also use them for subsequence testing:

          >>> "gg" in "eggs"
          True

  2. Values of `n' less than ‘0’ are treated as ‘0’ (which yields an
     empty sequence of the same type as `s').  Note that items in the
     sequence `s' are not copied; they are referenced multiple times.
     This often haunts new Python programmers; consider:

          >>> lists = [[]] * 3
          >>> lists
          [[], [], []]
          >>> lists[0].append(3)
          >>> lists
          [[3], [3], [3]]

     What has happened is that ‘[[]]’ is a one-element list containing
     an empty list, so all three elements of ‘[[]] * 3’ are references
     to this single empty list.  Modifying any of the elements of
     ‘lists’ modifies this single list.  You can create a list of
     different lists this way:

          >>> lists = [[] for i in range(3)]
          >>> lists[0].append(3)
          >>> lists[1].append(5)
          >>> lists[2].append(7)
          >>> lists
          [[3], [5], [7]]

     Further explanation is available in the FAQ entry *note How do I
     create a multidimensional list?: 156c.

  3. If `i' or `j' is negative, the index is relative to the end of
     sequence `s': ‘len(s) + i’ or ‘len(s) + j’ is substituted.  But
     note that ‘-0’ is still ‘0’.

  4. The slice of `s' from `i' to `j' is defined as the sequence of
     items with index `k' such that ‘i <= k < j’.  If `i' or `j' is
     greater than ‘len(s)’, use ‘len(s)’.  If `i' is omitted or ‘None’,
     use ‘0’.  If `j' is omitted or ‘None’, use ‘len(s)’.  If `i' is
     greater than or equal to `j', the slice is empty.

  5. The slice of `s' from `i' to `j' with step `k' is defined as the
     sequence of items with index ‘x = i + n*k’ such that ‘0 <= n <
     (j-i)/k’.  In other words, the indices are ‘i’, ‘i+k’, ‘i+2*k’,
     ‘i+3*k’ and so on, stopping when `j' is reached (but never
     including `j').  When `k' is positive, `i' and `j' are reduced to
     ‘len(s)’ if they are greater.  When `k' is negative, `i' and `j'
     are reduced to ‘len(s) - 1’ if they are greater.  If `i' or `j' are
     omitted or ‘None’, they become “end” values (which end depends on
     the sign of `k').  Note, `k' cannot be zero.  If `k' is ‘None’, it
     is treated like ‘1’.

  6. Concatenating immutable sequences always results in a new object.
     This means that building up a sequence by repeated concatenation
     will have a quadratic runtime cost in the total sequence length.
     To get a linear runtime cost, you must switch to one of the
     alternatives below:

        * if concatenating *note str: 325. objects, you can build a list
          and use *note str.join(): 156d. at the end or else write to an
          *note io.StringIO: 821. instance and retrieve its value when
          complete

        * if concatenating *note bytes: 326. objects, you can similarly
          use *note bytes.join(): 156e. or *note io.BytesIO: 78f, or you
          can do in-place concatenation with a *note bytearray: 327.
          object.  *note bytearray: 327. objects are mutable and have an
          efficient overallocation mechanism

        * if concatenating *note tuple: 473. objects, extend a *note
          list: 260. instead

        * for other types, investigate the relevant class documentation

  7. Some sequence types (such as *note range: 9b2.) only support item
     sequences that follow specific patterns, and hence don’t support
     sequence concatenation or repetition.

  8. ‘index’ raises *note ValueError: 1f9. when `x' is not found in `s'.
     Not all implementations support passing the additional arguments
     `i' and `j'.  These arguments allow efficient searching of
     subsections of the sequence.  Passing the extra arguments is
     roughly equivalent to using ‘s[i:j].index(x)’, only without copying
     any data and with the returned index being relative to the start of
     the sequence rather than the start of the slice.

   ---------- Footnotes ----------

   (1) (3) They must have since the parser can’t tell the type of the
operands.


File: python.info,  Node: Immutable Sequence Types,  Next: Mutable Sequence Types,  Prev: Common Sequence Operations,  Up: Sequence Types — list tuple range

5.4.6.2 Immutable Sequence Types
................................

The only operation that immutable sequence types generally implement
that is not also implemented by mutable sequence types is support for
the *note hash(): 9b8. built-in.

This support allows immutable sequences, such as *note tuple: 473.
instances, to be used as *note dict: 1b6. keys and stored in *note set:
b62. and *note frozenset: be1. instances.

Attempting to hash an immutable sequence that contains unhashable values
will result in *note TypeError: 192.


File: python.info,  Node: Mutable Sequence Types,  Next: Lists<2>,  Prev: Immutable Sequence Types,  Up: Sequence Types — list tuple range

5.4.6.3 Mutable Sequence Types
..............................

The operations in the following table are defined on mutable sequence
types.  The *note collections.abc.MutableSequence: 6a0. ABC is provided
to make it easier to correctly implement these operations on custom
sequence types.

In the table `s' is an instance of a mutable sequence type, `t' is any
iterable object and `x' is an arbitrary object that meets any type and
value restrictions imposed by `s' (for example, *note bytearray: 327.
only accepts integers that meet the value restriction ‘0 <= x <= 255’).

Operation                          Result                               Notes
                                                                        
--------------------------------------------------------------------------------------------------
                                                                        
‘s[i] = x’                         item `i' of `s' is replaced by `x'
                                   
                                                                        
‘s[i:j] = t’                       slice of `s' from `i' to `j' is
                                   replaced by the contents of the
                                   iterable `t'
                                   
                                                                        
‘del s[i:j]’                       same as ‘s[i:j] = []’
                                   
                                                                        
‘s[i:j:k] = t’                     the elements of ‘s[i:j:k]’ are       (1)
                                   replaced by those of `t'             
                                   
                                                                        
‘del s[i:j:k]’                     removes the elements of ‘s[i:j:k]’
                                   from the list
                                   
                                                                        
‘s.append(x)’                      appends `x' to the end of the
                                   sequence (same as
                                   ‘s[len(s):len(s)] = [x]’)
                                   
                                                                        
‘s.clear()’                        removes all items from `s' (same     (5)
                                   as ‘del s[:]’)                       
                                   
                                                                        
‘s.copy()’                         creates a shallow copy of `s'        (5)
                                   (same as ‘s[:]’)                     
                                   
                                                                        
‘s.extend(t)’ or ‘s += t’          extends `s' with the contents of
                                   `t' (for the most part the same as
                                   ‘s[len(s):len(s)] = t’)
                                   
                                                                        
‘s *= n’                           updates `s' with its contents        (6)
                                   repeated `n' times                   
                                   
                                                                        
‘s.insert(i, x)’                   inserts `x' into `s' at the index
                                   given by `i' (same as ‘s[i:i] =
                                   [x]’)
                                   
                                                                        
‘s.pop([i])’                       retrieves the item at `i' and also   (2)
                                   removes it from `s'                  
                                   
                                                                        
‘s.remove(x)’                      remove the first item from `s'       (3)
                                   where ‘s[i]’ is equal to `x'         
                                   
                                                                        
‘s.reverse()’                      reverses the items of `s' in place   (4)
                                                                        

Notes:

  1. `t' must have the same length as the slice it is replacing.

  2. The optional argument `i' defaults to ‘-1’, so that by default the
     last item is removed and returned.

  3. ‘remove()’ raises *note ValueError: 1f9. when `x' is not found in
     `s'.

  4. The ‘reverse()’ method modifies the sequence in place for economy
     of space when reversing a large sequence.  To remind users that it
     operates by side effect, it does not return the reversed sequence.

  5. ‘clear()’ and ‘copy()’ are included for consistency with the
     interfaces of mutable containers that don’t support slicing
     operations (such as *note dict: 1b6. and *note set: b62.).
     ‘copy()’ is not part of the *note collections.abc.MutableSequence:
     6a0. ABC, but most concrete mutable sequence classes provide it.

     New in version 3.3: ‘clear()’ and ‘copy()’ methods.

  6. The value `n' is an integer, or an object implementing *note
     __index__(): 18a.  Zero and negative values of `n' clear the
     sequence.  Items in the sequence are not copied; they are
     referenced multiple times, as explained for ‘s * n’ under *note
     Common Sequence Operations: 156a.


File: python.info,  Node: Lists<2>,  Next: Tuples,  Prev: Mutable Sequence Types,  Up: Sequence Types — list tuple range

5.4.6.4 Lists
.............

Lists are mutable sequences, typically used to store collections of
homogeneous items (where the precise degree of similarity will vary by
application).

 -- Class: list ([iterable])

     Lists may be constructed in several ways:

        * Using a pair of square brackets to denote the empty list: ‘[]’

        * Using square brackets, separating items with commas: ‘[a]’,
          ‘[a, b, c]’

        * Using a list comprehension: ‘[x for x in iterable]’

        * Using the type constructor: ‘list()’ or ‘list(iterable)’

     The constructor builds a list whose items are the same and in the
     same order as `iterable'’s items.  `iterable' may be either a
     sequence, a container that supports iteration, or an iterator
     object.  If `iterable' is already a list, a copy is made and
     returned, similar to ‘iterable[:]’.  For example, ‘list('abc')’
     returns ‘['a', 'b', 'c']’ and ‘list( (1, 2, 3) )’ returns ‘[1, 2,
     3]’.  If no argument is given, the constructor creates a new empty
     list, ‘[]’.

     Many other operations also produce lists, including the *note
     sorted(): 439. built-in.

     Lists implement all of the *note common: 156a. and *note mutable:
     1521. sequence operations.  Lists also provide the following
     additional method:

      -- Method: sort (*, key=None, reverse=False)

          This method sorts the list in place, using only ‘<’
          comparisons between items.  Exceptions are not suppressed - if
          any comparison operations fail, the entire sort operation will
          fail (and the list will likely be left in a partially modified
          state).

          *note sort(): 43a. accepts two arguments that can only be
          passed by keyword (*note keyword-only arguments: 2aa.):

          `key' specifies a function of one argument that is used to
          extract a comparison key from each list element (for example,
          ‘key=str.lower’).  The key corresponding to each item in the
          list is calculated once and then used for the entire sorting
          process.  The default value of ‘None’ means that list items
          are sorted directly without calculating a separate key value.

          The *note functools.cmp_to_key(): b49. utility is available to
          convert a 2.x style `cmp' function to a `key' function.

          `reverse' is a boolean value.  If set to ‘True’, then the list
          elements are sorted as if each comparison were reversed.

          This method modifies the sequence in place for economy of
          space when sorting a large sequence.  To remind users that it
          operates by side effect, it does not return the sorted
          sequence (use *note sorted(): 439. to explicitly request a new
          sorted list instance).

          The *note sort(): 43a. method is guaranteed to be stable.  A
          sort is stable if it guarantees not to change the relative
          order of elements that compare equal — this is helpful for
          sorting in multiple passes (for example, sort by department,
          then by salary grade).

          For sorting examples and a brief sorting tutorial, see *note
          Sorting HOW TO: 153c.

          `CPython implementation detail:' While a list is being sorted,
          the effect of attempting to mutate, or even inspect, the list
          is undefined.  The C implementation of Python makes the list
          appear empty for the duration, and raises *note ValueError:
          1f9. if it can detect that the list has been mutated during a
          sort.


File: python.info,  Node: Tuples,  Next: Ranges,  Prev: Lists<2>,  Up: Sequence Types — list tuple range

5.4.6.5 Tuples
..............

Tuples are immutable sequences, typically used to store collections of
heterogeneous data (such as the 2-tuples produced by the *note
enumerate(): dd6. built-in).  Tuples are also used for cases where an
immutable sequence of homogeneous data is needed (such as allowing
storage in a *note set: b62. or *note dict: 1b6. instance).

 -- Class: tuple ([iterable])

     Tuples may be constructed in a number of ways:

        * Using a pair of parentheses to denote the empty tuple: ‘()’

        * Using a trailing comma for a singleton tuple: ‘a,’ or ‘(a,)’

        * Separating items with commas: ‘a, b, c’ or ‘(a, b, c)’

        * Using the *note tuple(): 473. built-in: ‘tuple()’ or
          ‘tuple(iterable)’

     The constructor builds a tuple whose items are the same and in the
     same order as `iterable'’s items.  `iterable' may be either a
     sequence, a container that supports iteration, or an iterator
     object.  If `iterable' is already a tuple, it is returned
     unchanged.  For example, ‘tuple('abc')’ returns ‘('a', 'b', 'c')’
     and ‘tuple( [1, 2, 3] )’ returns ‘(1, 2, 3)’.  If no argument is
     given, the constructor creates a new empty tuple, ‘()’.

     Note that it is actually the comma which makes a tuple, not the
     parentheses.  The parentheses are optional, except in the empty
     tuple case, or when they are needed to avoid syntactic ambiguity.
     For example, ‘f(a, b, c)’ is a function call with three arguments,
     while ‘f((a, b, c))’ is a function call with a 3-tuple as the sole
     argument.

     Tuples implement all of the *note common: 156a. sequence
     operations.

For heterogeneous collections of data where access by name is clearer
than access by index, *note collections.namedtuple(): 1b5. may be a more
appropriate choice than a simple tuple object.


File: python.info,  Node: Ranges,  Prev: Tuples,  Up: Sequence Types — list tuple range

5.4.6.6 Ranges
..............

The *note range: 9b2. type represents an immutable sequence of numbers
and is commonly used for looping a specific number of times in *note
for: c23. loops.

 -- Class: range (stop)

 -- Class: range (start, stop[, step])

     The arguments to the range constructor must be integers (either
     built-in *note int: 184. or any object that implements the
     ‘__index__’ special method).  If the `step' argument is omitted, it
     defaults to ‘1’.  If the `start' argument is omitted, it defaults
     to ‘0’.  If `step' is zero, *note ValueError: 1f9. is raised.

     For a positive `step', the contents of a range ‘r’ are determined
     by the formula ‘r[i] = start + step*i’ where ‘i >= 0’ and ‘r[i] <
     stop’.

     For a negative `step', the contents of the range are still
     determined by the formula ‘r[i] = start + step*i’, but the
     constraints are ‘i >= 0’ and ‘r[i] > stop’.

     A range object will be empty if ‘r[0]’ does not meet the value
     constraint.  Ranges do support negative indices, but these are
     interpreted as indexing from the end of the sequence determined by
     the positive indices.

     Ranges containing absolute values larger than *note sys.maxsize:
     b36. are permitted but some features (such as *note len(): 150.)
     may raise *note OverflowError: 954.

     Range examples:

          >>> list(range(10))
          [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
          >>> list(range(1, 11))
          [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
          >>> list(range(0, 30, 5))
          [0, 5, 10, 15, 20, 25]
          >>> list(range(0, 10, 3))
          [0, 3, 6, 9]
          >>> list(range(0, -10, -1))
          [0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
          >>> list(range(0))
          []
          >>> list(range(1, 0))
          []

     Ranges implement all of the *note common: 156a. sequence operations
     except concatenation and repetition (due to the fact that range
     objects can only represent sequences that follow a strict pattern
     and repetition and concatenation will usually violate that
     pattern).

      -- Attribute: start

          The value of the `start' parameter (or ‘0’ if the parameter
          was not supplied)

      -- Attribute: stop

          The value of the `stop' parameter

      -- Attribute: step

          The value of the `step' parameter (or ‘1’ if the parameter was
          not supplied)

The advantage of the *note range: 9b2. type over a regular *note list:
260. or *note tuple: 473. is that a *note range: 9b2. object will always
take the same (small) amount of memory, no matter the size of the range
it represents (as it only stores the ‘start’, ‘stop’ and ‘step’ values,
calculating individual items and subranges as needed).

Range objects implement the *note collections.abc.Sequence: 156b. ABC,
and provide features such as containment tests, element index lookup,
slicing and support for negative indices (see *note Sequence Types —
list, tuple, range: 11aa.):

     >>> r = range(0, 20, 2)
     >>> r
     range(0, 20, 2)
     >>> 11 in r
     False
     >>> 10 in r
     True
     >>> r.index(10)
     5
     >>> r[5]
     10
     >>> r[:5]
     range(0, 10, 2)
     >>> r[-1]
     18

Testing range objects for equality with ‘==’ and ‘!=’ compares them as
sequences.  That is, two range objects are considered equal if they
represent the same sequence of values.  (Note that two range objects
that compare equal might have different *note start: 1575, *note stop:
1576. and *note step: 1577. attributes, for example ‘range(0) ==
range(2, 1, 3)’ or ‘range(0, 3, 2) == range(0, 4, 2)’.)

Changed in version 3.2: Implement the Sequence ABC. Support slicing and
negative indices.  Test *note int: 184. objects for membership in
constant time instead of iterating through all items.

Changed in version 3.3: Define ‘==’ and ‘!=’ to compare range objects
based on the sequence of values they define (instead of comparing based
on object identity).

New in version 3.3: The *note start: 1575, *note stop: 1576. and *note
step: 1577. attributes.

See also
........

   * The linspace recipe(1) shows how to implement a lazy version of
     range suitable for floating point applications.

   ---------- Footnotes ----------

   (1) http://code.activestate.com/recipes/579000/


File: python.info,  Node: Text Sequence Type — str,  Next: Binary Sequence Types — bytes bytearray memoryview,  Prev: Sequence Types — list tuple range,  Up: Built-in Types

5.4.7 Text Sequence Type — ‘str’
--------------------------------

Textual data in Python is handled with *note str: 325. objects, or
`strings'.  Strings are immutable *note sequences: 11aa. of Unicode code
points.  String literals are written in a variety of ways:

   * Single quotes: ‘'allows embedded "double" quotes'’

   * Double quotes: ‘"allows embedded 'single' quotes"’.

   * Triple quoted: ‘'''Three single quotes'''’, ‘"""Three double
     quotes"""’

Triple quoted strings may span multiple lines - all associated
whitespace will be included in the string literal.

String literals that are part of a single expression and have only
whitespace between them will be implicitly converted to a single string
literal.  That is, ‘("spam " "eggs") == "spam eggs"’.

See *note String and Bytes literals: 131c. for more about the various
forms of string literal, including supported escape sequences, and the
‘r’ (“raw”) prefix that disables most escape sequence processing.

Strings may also be created from other objects using the *note str: 325.
constructor.

Since there is no separate “character” type, indexing a string produces
strings of length 1.  That is, for a non-empty string `s', ‘s[0] ==
s[0:1]’.

There is also no mutable string type, but *note str.join(): 156d. or
*note io.StringIO: 821. can be used to efficiently construct strings
from multiple fragments.

Changed in version 3.3: For backwards compatibility with the Python 2
series, the ‘u’ prefix is once again permitted on string literals.  It
has no effect on the meaning of string literals and cannot be combined
with the ‘r’ prefix.

 -- Class: str (object='')

 -- Class: str (object=b'', encoding='utf-8', errors='strict')

     Return a *note string: 115d. version of `object'.  If `object' is
     not provided, returns the empty string.  Otherwise, the behavior of
     ‘str()’ depends on whether `encoding' or `errors' is given, as
     follows.

     If neither `encoding' nor `errors' is given, ‘str(object)’ returns
     *note object.__str__(): e2a, which is the “informal” or nicely
     printable string representation of `object'.  For string objects,
     this is the string itself.  If `object' does not have a *note
     __str__(): e2a. method, then *note str(): 325. falls back to
     returning *note repr(object): 7c0.

     If at least one of `encoding' or `errors' is given, `object' should
     be a *note bytes-like object: 5dd. (e.g.  *note bytes: 326. or
     *note bytearray: 327.).  In this case, if `object' is a *note
     bytes: 326. (or *note bytearray: 327.) object, then ‘str(bytes,
     encoding, errors)’ is equivalent to *note bytes.decode(encoding,
     errors): c2b.  Otherwise, the bytes object underlying the buffer
     object is obtained before calling *note bytes.decode(): c2b.  See
     *note Binary Sequence Types — bytes, bytearray, memoryview: 1523.
     and *note Buffer Protocol: 1579. for information on buffer objects.

     Passing a *note bytes: 326. object to *note str(): 325. without the
     `encoding' or `errors' arguments falls under the first case of
     returning the informal string representation (see also the *note
     -b: 40a. command-line option to Python).  For example:

          >>> str(b'Zoot!')
          "b'Zoot!'"

     For more information on the ‘str’ class and its methods, see *note
     Text Sequence Type — str: 115d. and the *note String Methods: 115e.
     section below.  To output formatted strings, see the *note
     Formatted string literals: 15c. and *note Format String Syntax:
     d0d. sections.  In addition, see the *note Text Processing
     Services: 157a. section.

* Menu:

* String Methods: String Methods<2>.
* printf-style String Formatting::


File: python.info,  Node: String Methods<2>,  Next: printf-style String Formatting,  Up: Text Sequence Type — str

5.4.7.1 String Methods
......................

Strings implement all of the *note common: 156a. sequence operations,
along with the additional methods described below.

Strings also support two styles of string formatting, one providing a
large degree of flexibility and customization (see *note str.format():
4cf, *note Format String Syntax: d0d. and *note Custom String
Formatting: 157c.) and the other based on C ‘printf’ style formatting
that handles a narrower range of types and is slightly harder to use
correctly, but is often faster for the cases it can handle (*note
printf-style String Formatting: 115f.).

The *note Text Processing Services: 157d. section of the standard
library covers a number of other modules that provide various text
related utilities (including regular expression support in the *note re:
dd. module).

 -- Method: str.capitalize ()

     Return a copy of the string with its first character capitalized
     and the rest lowercased.

     Changed in version 3.8: The first character is now put into
     titlecase rather than uppercase.  This means that characters like
     digraphs will only have their first letter capitalized, instead of
     the full character.

 -- Method: str.casefold ()

     Return a casefolded copy of the string.  Casefolded strings may be
     used for caseless matching.

     Casefolding is similar to lowercasing but more aggressive because
     it is intended to remove all case distinctions in a string.  For
     example, the German lowercase letter ‘'ß'’ is equivalent to ‘"ss"’.
     Since it is already lowercase, *note lower(): 157f. would do
     nothing to ‘'ß'’; *note casefold(): 6a4. converts it to ‘"ss"’.

     The casefolding algorithm is described in section 3.13 of the
     Unicode Standard.

     New in version 3.3.

 -- Method: str.center (width[, fillchar])

     Return centered in a string of length `width'.  Padding is done
     using the specified `fillchar' (default is an ASCII space).  The
     original string is returned if `width' is less than or equal to
     ‘len(s)’.

 -- Method: str.count (sub[, start[, end]])

     Return the number of non-overlapping occurrences of substring `sub'
     in the range [`start', `end'].  Optional arguments `start' and
     `end' are interpreted as in slice notation.

 -- Method: str.encode (encoding="utf-8", errors="strict")

     Return an encoded version of the string as a bytes object.  Default
     encoding is ‘'utf-8'’.  `errors' may be given to set a different
     error handling scheme.  The default for `errors' is ‘'strict'’,
     meaning that encoding errors raise a *note UnicodeError: c2e.
     Other possible values are ‘'ignore'’, ‘'replace'’,
     ‘'xmlcharrefreplace'’, ‘'backslashreplace'’ and any other name
     registered via *note codecs.register_error(): de8, see section
     *note Error Handlers: 129c.  For a list of possible encodings, see
     section *note Standard Encodings: 683.

     Changed in version 3.1: Support for keyword arguments added.

 -- Method: str.endswith (suffix[, start[, end]])

     Return ‘True’ if the string ends with the specified `suffix',
     otherwise return ‘False’.  `suffix' can also be a tuple of suffixes
     to look for.  With optional `start', test beginning at that
     position.  With optional `end', stop comparing at that position.

 -- Method: str.expandtabs (tabsize=8)

     Return a copy of the string where all tab characters are replaced
     by one or more spaces, depending on the current column and the
     given tab size.  Tab positions occur every `tabsize' characters
     (default is 8, giving tab positions at columns 0, 8, 16 and so on).
     To expand the string, the current column is set to zero and the
     string is examined character by character.  If the character is a
     tab (‘\t’), one or more space characters are inserted in the result
     until the current column is equal to the next tab position.  (The
     tab character itself is not copied.)  If the character is a newline
     (‘\n’) or return (‘\r’), it is copied and the current column is
     reset to zero.  Any other character is copied unchanged and the
     current column is incremented by one regardless of how the
     character is represented when printed.

          >>> '01\t012\t0123\t01234'.expandtabs()
          '01      012     0123    01234'
          >>> '01\t012\t0123\t01234'.expandtabs(4)
          '01  012 0123    01234'

 -- Method: str.find (sub[, start[, end]])

     Return the lowest index in the string where substring `sub' is
     found within the slice ‘s[start:end]’.  Optional arguments `start'
     and `end' are interpreted as in slice notation.  Return ‘-1’ if
     `sub' is not found.

          Note: The *note find(): 793. method should be used only if you
          need to know the position of `sub'.  To check if `sub' is a
          substring or not, use the *note in: 797. operator:

               >>> 'Py' in 'Python'
               True

 -- Method: str.format (*args, **kwargs)

     Perform a string formatting operation.  The string on which this
     method is called can contain literal text or replacement fields
     delimited by braces ‘{}’.  Each replacement field contains either
     the numeric index of a positional argument, or the name of a
     keyword argument.  Returns a copy of the string where each
     replacement field is replaced with the string value of the
     corresponding argument.

          >>> "The sum of 1 + 2 is {0}".format(1+2)
          'The sum of 1 + 2 is 3'

     See *note Format String Syntax: d0d. for a description of the
     various formatting options that can be specified in format strings.

          Note: When formatting a number (*note int: 184, *note float:
          187, *note complex: 189, *note decimal.Decimal: 188. and
          subclasses) with the ‘n’ type (ex: ‘'{:n}'.format(1234)’), the
          function temporarily sets the ‘LC_CTYPE’ locale to the
          ‘LC_NUMERIC’ locale to decode ‘decimal_point’ and
          ‘thousands_sep’ fields of ‘localeconv()’ if they are non-ASCII
          or longer than 1 byte, and the ‘LC_NUMERIC’ locale is
          different than the ‘LC_CTYPE’ locale.  This temporary change
          affects other threads.

     Changed in version 3.7: When formatting a number with the ‘n’ type,
     the function sets temporarily the ‘LC_CTYPE’ locale to the
     ‘LC_NUMERIC’ locale in some cases.

 -- Method: str.format_map (mapping)

     Similar to ‘str.format(**mapping)’, except that ‘mapping’ is used
     directly and not copied to a *note dict: 1b6.  This is useful if
     for example ‘mapping’ is a dict subclass:

          >>> class Default(dict):
          ...     def __missing__(self, key):
          ...         return key
          ...
          >>> '{name} was born in {country}'.format_map(Default(name='Guido'))
          'Guido was born in country'

     New in version 3.2.

 -- Method: str.index (sub[, start[, end]])

     Like *note find(): 793, but raise *note ValueError: 1f9. when the
     substring is not found.

 -- Method: str.isalnum ()

     Return ‘True’ if all characters in the string are alphanumeric and
     there is at least one character, ‘False’ otherwise.  A character
     ‘c’ is alphanumeric if one of the following returns ‘True’:
     ‘c.isalpha()’, ‘c.isdecimal()’, ‘c.isdigit()’, or ‘c.isnumeric()’.

 -- Method: str.isalpha ()

     Return ‘True’ if all characters in the string are alphabetic and
     there is at least one character, ‘False’ otherwise.  Alphabetic
     characters are those characters defined in the Unicode character
     database as “Letter”, i.e., those with general category property
     being one of “Lm”, “Lt”, “Lu”, “Ll”, or “Lo”.  Note that this is
     different from the “Alphabetic” property defined in the Unicode
     Standard.

 -- Method: str.isascii ()

     Return ‘True’ if the string is empty or all characters in the
     string are ASCII, ‘False’ otherwise.  ASCII characters have code
     points in the range U+0000-U+007F.

     New in version 3.7.

 -- Method: str.isdecimal ()

     Return ‘True’ if all characters in the string are decimal
     characters and there is at least one character, ‘False’ otherwise.
     Decimal characters are those that can be used to form numbers in
     base 10, e.g.  U+0660, ARABIC-INDIC DIGIT ZERO. Formally a decimal
     character is a character in the Unicode General Category “Nd”.

 -- Method: str.isdigit ()

     Return ‘True’ if all characters in the string are digits and there
     is at least one character, ‘False’ otherwise.  Digits include
     decimal characters and digits that need special handling, such as
     the compatibility superscript digits.  This covers digits which
     cannot be used to form numbers in base 10, like the Kharosthi
     numbers.  Formally, a digit is a character that has the property
     value Numeric_Type=Digit or Numeric_Type=Decimal.

 -- Method: str.isidentifier ()

     Return ‘True’ if the string is a valid identifier according to the
     language definition, section *note Identifiers and keywords: 130d.

     Call *note keyword.iskeyword(): 1588. to test whether string ‘s’ is
     a reserved identifier, such as *note def: db1. and *note class:
     c5d.

     Example:

          >>> from keyword import iskeyword

          >>> 'hello'.isidentifier(), iskeyword('hello')
          True, False
          >>> 'def'.isidentifier(), iskeyword('def')
          True, True

 -- Method: str.islower ()

     Return ‘True’ if all cased characters (1) in the string are
     lowercase and there is at least one cased character, ‘False’
     otherwise.

 -- Method: str.isnumeric ()

     Return ‘True’ if all characters in the string are numeric
     characters, and there is at least one character, ‘False’ otherwise.
     Numeric characters include digit characters, and all characters
     that have the Unicode numeric value property, e.g.  U+2155, VULGAR
     FRACTION ONE FIFTH. Formally, numeric characters are those with the
     property value Numeric_Type=Digit, Numeric_Type=Decimal or
     Numeric_Type=Numeric.

 -- Method: str.isprintable ()

     Return ‘True’ if all characters in the string are printable or the
     string is empty, ‘False’ otherwise.  Nonprintable characters are
     those characters defined in the Unicode character database as
     “Other” or “Separator”, excepting the ASCII space (0x20) which is
     considered printable.  (Note that printable characters in this
     context are those which should not be escaped when *note repr():
     7c0. is invoked on a string.  It has no bearing on the handling of
     strings written to *note sys.stdout: 303. or *note sys.stderr:
     304.)

 -- Method: str.isspace ()

     Return ‘True’ if there are only whitespace characters in the string
     and there is at least one character, ‘False’ otherwise.

     A character is `whitespace' if in the Unicode character database
     (see *note unicodedata: 11a.), either its general category is ‘Zs’
     (“Separator, space”), or its bidirectional class is one of ‘WS’,
     ‘B’, or ‘S’.

 -- Method: str.istitle ()

     Return ‘True’ if the string is a titlecased string and there is at
     least one character, for example uppercase characters may only
     follow uncased characters and lowercase characters only cased ones.
     Return ‘False’ otherwise.

 -- Method: str.isupper ()

     Return ‘True’ if all cased characters (2) in the string are
     uppercase and there is at least one cased character, ‘False’
     otherwise.

 -- Method: str.join (iterable)

     Return a string which is the concatenation of the strings in
     `iterable'.  A *note TypeError: 192. will be raised if there are
     any non-string values in `iterable', including *note bytes: 326.
     objects.  The separator between elements is the string providing
     this method.

 -- Method: str.ljust (width[, fillchar])

     Return the string left justified in a string of length `width'.
     Padding is done using the specified `fillchar' (default is an ASCII
     space).  The original string is returned if `width' is less than or
     equal to ‘len(s)’.

 -- Method: str.lower ()

     Return a copy of the string with all the cased characters (3)
     converted to lowercase.

     The lowercasing algorithm used is described in section 3.13 of the
     Unicode Standard.

 -- Method: str.lstrip ([chars])

     Return a copy of the string with leading characters removed.  The
     `chars' argument is a string specifying the set of characters to be
     removed.  If omitted or ‘None’, the `chars' argument defaults to
     removing whitespace.  The `chars' argument is not a prefix; rather,
     all combinations of its values are stripped:

          >>> '   spacious   '.lstrip()
          'spacious   '
          >>> 'www.example.com'.lstrip('cmowz.')
          'example.com'

 -- Static Method: str.maketrans (x[, y[, z]])

     This static method returns a translation table usable for *note
     str.translate(): 158f.

     If there is only one argument, it must be a dictionary mapping
     Unicode ordinals (integers) or characters (strings of length 1) to
     Unicode ordinals, strings (of arbitrary lengths) or ‘None’.
     Character keys will then be converted to ordinals.

     If there are two arguments, they must be strings of equal length,
     and in the resulting dictionary, each character in x will be mapped
     to the character at the same position in y.  If there is a third
     argument, it must be a string, whose characters will be mapped to
     ‘None’ in the result.

 -- Method: str.partition (sep)

     Split the string at the first occurrence of `sep', and return a
     3-tuple containing the part before the separator, the separator
     itself, and the part after the separator.  If the separator is not
     found, return a 3-tuple containing the string itself, followed by
     two empty strings.

 -- Method: str.replace (old, new[, count])

     Return a copy of the string with all occurrences of substring `old'
     replaced by `new'.  If the optional argument `count' is given, only
     the first `count' occurrences are replaced.

 -- Method: str.rfind (sub[, start[, end]])

     Return the highest index in the string where substring `sub' is
     found, such that `sub' is contained within ‘s[start:end]’.
     Optional arguments `start' and `end' are interpreted as in slice
     notation.  Return ‘-1’ on failure.

 -- Method: str.rindex (sub[, start[, end]])

     Like *note rfind(): 794. but raises *note ValueError: 1f9. when the
     substring `sub' is not found.

 -- Method: str.rjust (width[, fillchar])

     Return the string right justified in a string of length `width'.
     Padding is done using the specified `fillchar' (default is an ASCII
     space).  The original string is returned if `width' is less than or
     equal to ‘len(s)’.

 -- Method: str.rpartition (sep)

     Split the string at the last occurrence of `sep', and return a
     3-tuple containing the part before the separator, the separator
     itself, and the part after the separator.  If the separator is not
     found, return a 3-tuple containing two empty strings, followed by
     the string itself.

 -- Method: str.rsplit (sep=None, maxsplit=-1)

     Return a list of the words in the string, using `sep' as the
     delimiter string.  If `maxsplit' is given, at most `maxsplit'
     splits are done, the `rightmost' ones.  If `sep' is not specified
     or ‘None’, any whitespace string is a separator.  Except for
     splitting from the right, *note rsplit(): 1593. behaves like *note
     split(): 795. which is described in detail below.

 -- Method: str.rstrip ([chars])

     Return a copy of the string with trailing characters removed.  The
     `chars' argument is a string specifying the set of characters to be
     removed.  If omitted or ‘None’, the `chars' argument defaults to
     removing whitespace.  The `chars' argument is not a suffix; rather,
     all combinations of its values are stripped:

          >>> '   spacious   '.rstrip()
          '   spacious'
          >>> 'mississippi'.rstrip('ipz')
          'mississ'

 -- Method: str.split (sep=None, maxsplit=-1)

     Return a list of the words in the string, using `sep' as the
     delimiter string.  If `maxsplit' is given, at most `maxsplit'
     splits are done (thus, the list will have at most ‘maxsplit+1’
     elements).  If `maxsplit' is not specified or ‘-1’, then there is
     no limit on the number of splits (all possible splits are made).

     If `sep' is given, consecutive delimiters are not grouped together
     and are deemed to delimit empty strings (for example,
     ‘'1,,2'.split(',')’ returns ‘['1', '', '2']’).  The `sep' argument
     may consist of multiple characters (for example,
     ‘'1<>2<>3'.split('<>')’ returns ‘['1', '2', '3']’).  Splitting an
     empty string with a specified separator returns ‘['']’.

     For example:

          >>> '1,2,3'.split(',')
          ['1', '2', '3']
          >>> '1,2,3'.split(',', maxsplit=1)
          ['1', '2,3']
          >>> '1,2,,3,'.split(',')
          ['1', '2', '', '3', '']

     If `sep' is not specified or is ‘None’, a different splitting
     algorithm is applied: runs of consecutive whitespace are regarded
     as a single separator, and the result will contain no empty strings
     at the start or end if the string has leading or trailing
     whitespace.  Consequently, splitting an empty string or a string
     consisting of just whitespace with a ‘None’ separator returns ‘[]’.

     For example:

          >>> '1 2 3'.split()
          ['1', '2', '3']
          >>> '1 2 3'.split(maxsplit=1)
          ['1', '2 3']
          >>> '   1   2   3   '.split()
          ['1', '2', '3']

 -- Method: str.splitlines ([keepends])

     Return a list of the lines in the string, breaking at line
     boundaries.  Line breaks are not included in the resulting list
     unless `keepends' is given and true.

     This method splits on the following line boundaries.  In
     particular, the boundaries are a superset of *note universal
     newlines: 5e9.

     Representation              Description
                                 
     --------------------------------------------------------------
                                 
     ‘\n’                        Line Feed
                                 
                                 
     ‘\r’                        Carriage Return
                                 
                                 
     ‘\r\n’                      Carriage Return + Line Feed
                                 
                                 
     ‘\v’ or ‘\x0b’              Line Tabulation
                                 
                                 
     ‘\f’ or ‘\x0c’              Form Feed
                                 
                                 
     ‘\x1c’                      File Separator
                                 
                                 
     ‘\x1d’                      Group Separator
                                 
                                 
     ‘\x1e’                      Record Separator
                                 
                                 
     ‘\x85’                      Next Line (C1 Control Code)
                                 
                                 
     ‘\u2028’                    Line Separator
                                 
                                 
     ‘\u2029’                    Paragraph Separator
                                 

     Changed in version 3.2: ‘\v’ and ‘\f’ added to list of line
     boundaries.

     For example:

          >>> 'ab c\n\nde fg\rkl\r\n'.splitlines()
          ['ab c', '', 'de fg', 'kl']
          >>> 'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
          ['ab c\n', '\n', 'de fg\r', 'kl\r\n']

     Unlike *note split(): 795. when a delimiter string `sep' is given,
     this method returns an empty list for the empty string, and a
     terminal line break does not result in an extra line:

          >>> "".splitlines()
          []
          >>> "One line\n".splitlines()
          ['One line']

     For comparison, ‘split('\n')’ gives:

          >>> ''.split('\n')
          ['']
          >>> 'Two lines\n'.split('\n')
          ['Two lines', '']

 -- Method: str.startswith (prefix[, start[, end]])

     Return ‘True’ if string starts with the `prefix', otherwise return
     ‘False’.  `prefix' can also be a tuple of prefixes to look for.
     With optional `start', test string beginning at that position.
     With optional `end', stop comparing string at that position.

 -- Method: str.strip ([chars])

     Return a copy of the string with the leading and trailing
     characters removed.  The `chars' argument is a string specifying
     the set of characters to be removed.  If omitted or ‘None’, the
     `chars' argument defaults to removing whitespace.  The `chars'
     argument is not a prefix or suffix; rather, all combinations of its
     values are stripped:

          >>> '   spacious   '.strip()
          'spacious'
          >>> 'www.example.com'.strip('cmowz.')
          'example'

     The outermost leading and trailing `chars' argument values are
     stripped from the string.  Characters are removed from the leading
     end until reaching a string character that is not contained in the
     set of characters in `chars'.  A similar action takes place on the
     trailing end.  For example:

          >>> comment_string = '#....... Section 3.2.1 Issue #32 .......'
          >>> comment_string.strip('.#! ')
          'Section 3.2.1 Issue #32'

 -- Method: str.swapcase ()

     Return a copy of the string with uppercase characters converted to
     lowercase and vice versa.  Note that it is not necessarily true
     that ‘s.swapcase().swapcase() == s’.

 -- Method: str.title ()

     Return a titlecased version of the string where words start with an
     uppercase character and the remaining characters are lowercase.

     For example:

          >>> 'Hello world'.title()
          'Hello World'

     The algorithm uses a simple language-independent definition of a
     word as groups of consecutive letters.  The definition works in
     many contexts but it means that apostrophes in contractions and
     possessives form word boundaries, which may not be the desired
     result:

          >>> "they're bill's friends from the UK".title()
          "They'Re Bill'S Friends From The Uk"

     A workaround for apostrophes can be constructed using regular
     expressions:

          >>> import re
          >>> def titlecase(s):
          ...     return re.sub(r"[A-Za-z]+('[A-Za-z]+)?",
          ...                   lambda mo: mo.group(0).capitalize(),
          ...                   s)
          ...
          >>> titlecase("they're bill's friends.")
          "They're Bill's Friends."

 -- Method: str.translate (table)

     Return a copy of the string in which each character has been mapped
     through the given translation table.  The table must be an object
     that implements indexing via *note __getitem__(): 27a, typically a
     *note mapping: b2c. or *note sequence: 1162.  When indexed by a
     Unicode ordinal (an integer), the table object can do any of the
     following: return a Unicode ordinal or a string, to map the
     character to one or more other characters; return ‘None’, to delete
     the character from the return string; or raise a *note LookupError:
     1599. exception, to map the character to itself.

     You can use *note str.maketrans(): 6a7. to create a translation map
     from character-to-character mappings in different formats.

     See also the *note codecs: 1c. module for a more flexible approach
     to custom character mappings.

 -- Method: str.upper ()

     Return a copy of the string with all the cased characters (4)
     converted to uppercase.  Note that ‘s.upper().isupper()’ might be
     ‘False’ if ‘s’ contains uncased characters or if the Unicode
     category of the resulting character(s) is not “Lu” (Letter,
     uppercase), but e.g.  “Lt” (Letter, titlecase).

     The uppercasing algorithm used is described in section 3.13 of the
     Unicode Standard.

 -- Method: str.zfill (width)

     Return a copy of the string left filled with ASCII ‘'0'’ digits to
     make a string of length `width'.  A leading sign prefix
     (‘'+'’/‘'-'’) is handled by inserting the padding `after' the sign
     character rather than before.  The original string is returned if
     `width' is less than or equal to ‘len(s)’.

     For example:

          >>> "42".zfill(5)
          '00042'
          >>> "-42".zfill(5)
          '-0042'

   ---------- Footnotes ----------

   (1) (4) Cased characters are those with general category property
being one of “Lu” (Letter, uppercase), “Ll” (Letter, lowercase), or “Lt”
(Letter, titlecase).

   (2) (4) Cased characters are those with general category property
being one of “Lu” (Letter, uppercase), “Ll” (Letter, lowercase), or “Lt”
(Letter, titlecase).

   (3) (4) Cased characters are those with general category property
being one of “Lu” (Letter, uppercase), “Ll” (Letter, lowercase), or “Lt”
(Letter, titlecase).

   (4) (4) Cased characters are those with general category property
being one of “Lu” (Letter, uppercase), “Ll” (Letter, lowercase), or “Lt”
(Letter, titlecase).


File: python.info,  Node: printf-style String Formatting,  Prev: String Methods<2>,  Up: Text Sequence Type — str

5.4.7.2 ‘printf’-style String Formatting
........................................

     Note: The formatting operations described here exhibit a variety of
     quirks that lead to a number of common errors (such as failing to
     display tuples and dictionaries correctly).  Using the newer *note
     formatted string literals: 15c, the *note str.format(): 4cf.
     interface, or *note template strings: 159c. may help avoid these
     errors.  Each of these alternatives provides their own trade-offs
     and benefits of simplicity, flexibility, and/or extensibility.

String objects have one unique built-in operation: the ‘%’ operator
(modulo).  This is also known as the string `formatting' or
`interpolation' operator.  Given ‘format % values’ (where `format' is a
string), ‘%’ conversion specifications in `format' are replaced with
zero or more elements of `values'.  The effect is similar to using the
‘sprintf()’ in the C language.

If `format' requires a single argument, `values' may be a single
non-tuple object.  (1) Otherwise, `values' must be a tuple with exactly
the number of items specified by the format string, or a single mapping
object (for example, a dictionary).

A conversion specifier contains two or more characters and has the
following components, which must occur in this order:

  1. The ‘'%'’ character, which marks the start of the specifier.

  2. Mapping key (optional), consisting of a parenthesised sequence of
     characters (for example, ‘(somename)’).

  3. Conversion flags (optional), which affect the result of some
     conversion types.

  4. Minimum field width (optional).  If specified as an ‘'*'’
     (asterisk), the actual width is read from the next element of the
     tuple in `values', and the object to convert comes after the
     minimum field width and optional precision.

  5. Precision (optional), given as a ‘'.'’ (dot) followed by the
     precision.  If specified as ‘'*'’ (an asterisk), the actual
     precision is read from the next element of the tuple in `values',
     and the value to convert comes after the precision.

  6. Length modifier (optional).

  7. Conversion type.

When the right argument is a dictionary (or other mapping type), then
the formats in the string `must' include a parenthesised mapping key
into that dictionary inserted immediately after the ‘'%'’ character.
The mapping key selects the value to be formatted from the mapping.  For
example:

     >>> print('%(language)s has %(number)03d quote types.' %
     ...       {'language': "Python", "number": 2})
     Python has 002 quote types.

In this case no ‘*’ specifiers may occur in a format (since they require
a sequential parameter list).

The conversion flag characters are:

Flag          Meaning
              
----------------------------------------------------------------------------------------
              
‘'#'’         The value conversion will use the “alternate form” (where defined
              below).
              
              
‘'0'’         The conversion will be zero padded for numeric values.
              
              
‘'-'’         The converted value is left adjusted (overrides the ‘'0'’ conversion if
              both are given).
              
              
‘' '’         (a space) A blank should be left before a positive number (or empty
              string) produced by a signed conversion.
              
              
‘'+'’         A sign character (‘'+'’ or ‘'-'’) will precede the conversion
              (overrides a “space” flag).
              

A length modifier (‘h’, ‘l’, or ‘L’) may be present, but is ignored as
it is not necessary for Python – so e.g.  ‘%ld’ is identical to ‘%d’.

The conversion types are:

Conversion       Meaning                                                   Notes
                                                                           
---------------------------------------------------------------------------------------
                                                                           
‘'d'’            Signed integer decimal.
                 
                                                                           
‘'i'’            Signed integer decimal.
                 
                                                                           
‘'o'’            Signed octal value.                                       (1)
                                                                           
                                                                           
‘'u'’            Obsolete type – it is identical to ‘'d'’.                 (6)
                                                                           
                                                                           
‘'x'’            Signed hexadecimal (lowercase).                           (2)
                                                                           
                                                                           
‘'X'’            Signed hexadecimal (uppercase).                           (2)
                                                                           
                                                                           
‘'e'’            Floating point exponential format (lowercase).            (3)
                                                                           
                                                                           
‘'E'’            Floating point exponential format (uppercase).            (3)
                                                                           
                                                                           
‘'f'’            Floating point decimal format.                            (3)
                                                                           
                                                                           
‘'F'’            Floating point decimal format.                            (3)
                                                                           
                                                                           
‘'g'’            Floating point format.  Uses lowercase exponential        (4)
                 format if exponent is less than -4 or not less than       
                 precision, decimal format otherwise.
                 
                                                                           
‘'G'’            Floating point format.  Uses uppercase exponential        (4)
                 format if exponent is less than -4 or not less than       
                 precision, decimal format otherwise.
                 
                                                                           
‘'c'’            Single character (accepts integer or single character
                 string).
                 
                                                                           
‘'r'’            String (converts any Python object using                  (5)
                 *note repr(): 7c0.).                                      
                 
                                                                           
‘'s'’            String (converts any Python object using                  (5)
                 *note str(): 325.).                                       
                 
                                                                           
‘'a'’            String (converts any Python object using                  (5)
                 *note ascii(): d3f.).                                     
                 
                                                                           
‘'%'’            No argument is converted, results in a ‘'%'’ character
                 in the result.
                 

Notes:

  1. The alternate form causes a leading octal specifier (‘'0o'’) to be
     inserted before the first digit.

  2. The alternate form causes a leading ‘'0x'’ or ‘'0X'’ (depending on
     whether the ‘'x'’ or ‘'X'’ format was used) to be inserted before
     the first digit.

  3. The alternate form causes the result to always contain a decimal
     point, even if no digits follow it.

     The precision determines the number of digits after the decimal
     point and defaults to 6.

  4. The alternate form causes the result to always contain a decimal
     point, and trailing zeroes are not removed as they would otherwise
     be.

     The precision determines the number of significant digits before
     and after the decimal point and defaults to 6.

  5. If precision is ‘N’, the output is truncated to ‘N’ characters.

  6. See PEP 237(2).

Since Python strings have an explicit length, ‘%s’ conversions do not
assume that ‘'\0'’ is the end of the string.

Changed in version 3.1: ‘%f’ conversions for numbers whose absolute
value is over 1e50 are no longer replaced by ‘%g’ conversions.

   ---------- Footnotes ----------

   (1) (5) To format only a tuple you should therefore provide a
singleton tuple whose only element is the tuple to be formatted.

   (2) https://www.python.org/dev/peps/pep-0237


File: python.info,  Node: Binary Sequence Types — bytes bytearray memoryview,  Next: Set Types — set frozenset,  Prev: Text Sequence Type — str,  Up: Built-in Types

5.4.8 Binary Sequence Types — ‘bytes’, ‘bytearray’, ‘memoryview’
----------------------------------------------------------------

The core built-in types for manipulating binary data are *note bytes:
326. and *note bytearray: 327.  They are supported by *note memoryview:
25a. which uses the *note buffer protocol: 1579. to access the memory of
other binary objects without needing to make a copy.

The *note array: 7. module supports efficient storage of basic data
types like 32-bit integers and IEEE754 double-precision floating values.

* Menu:

* Bytes Objects::
* Bytearray Objects::
* Bytes and Bytearray Operations::
* printf-style Bytes Formatting::
* Memory Views::


File: python.info,  Node: Bytes Objects,  Next: Bytearray Objects,  Up: Binary Sequence Types — bytes bytearray memoryview

5.4.8.1 Bytes Objects
.....................

Bytes objects are immutable sequences of single bytes.  Since many major
binary protocols are based on the ASCII text encoding, bytes objects
offer several methods that are only valid when working with ASCII
compatible data and are closely related to string objects in a variety
of other ways.

 -- Class: bytes ([source[, encoding[, errors]]])

     Firstly, the syntax for bytes literals is largely the same as that
     for string literals, except that a ‘b’ prefix is added:

        * Single quotes: ‘b'still allows embedded "double" quotes'’

        * Double quotes: ‘b"still allows embedded 'single' quotes"’.

        * Triple quoted: ‘b'''3 single quotes'''’, ‘b"""3 double
          quotes"""’

     Only ASCII characters are permitted in bytes literals (regardless
     of the declared source code encoding).  Any binary values over 127
     must be entered into bytes literals using the appropriate escape
     sequence.

     As with string literals, bytes literals may also use a ‘r’ prefix
     to disable processing of escape sequences.  See *note String and
     Bytes literals: 131c. for more about the various forms of bytes
     literal, including supported escape sequences.

     While bytes literals and representations are based on ASCII text,
     bytes objects actually behave like immutable sequences of integers,
     with each value in the sequence restricted such that ‘0 <= x < 256’
     (attempts to violate this restriction will trigger *note
     ValueError: 1f9.).  This is done deliberately to emphasise that
     while many binary formats include ASCII based elements and can be
     usefully manipulated with some text-oriented algorithms, this is
     not generally the case for arbitrary binary data (blindly applying
     text processing algorithms to binary data formats that are not
     ASCII compatible will usually lead to data corruption).

     In addition to the literal forms, bytes objects can be created in a
     number of other ways:

        * A zero-filled bytes object of a specified length: ‘bytes(10)’

        * From an iterable of integers: ‘bytes(range(20))’

        * Copying existing binary data via the buffer protocol:
          ‘bytes(obj)’

     Also see the *note bytes: ff6. built-in.

     Since 2 hexadecimal digits correspond precisely to a single byte,
     hexadecimal numbers are a commonly used format for describing
     binary data.  Accordingly, the bytes type has an additional class
     method to read data in that format:

      -- Class Method: fromhex (string)

          This *note bytes: 326. class method returns a bytes object,
          decoding the given string object.  The string must contain two
          hexadecimal digits per byte, with ASCII whitespace being
          ignored.

               >>> bytes.fromhex('2Ef0 F1f2  ')
               b'.\xf0\xf1\xf2'

          Changed in version 3.7: *note bytes.fromhex(): 323. now skips
          all ASCII whitespace in the string, not just spaces.

     A reverse conversion function exists to transform a bytes object
     into its hexadecimal representation.

      -- Method: hex ()

          Return a string object containing two hexadecimal digits for
          each byte in the instance.

               >>> b'\xf0\xf1\xf2'.hex()
               'f0f1f2'

          If you want to make the hex string easier to read, you can
          specify a single character separator `sep' parameter to
          include in the output.  By default between each byte.  A
          second optional `bytes_per_sep' parameter controls the
          spacing.  Positive values calculate the separator position
          from the right, negative values from the left.

               >>> value = b'\xf0\xf1\xf2'
               >>> value.hex('-')
               'f0-f1-f2'
               >>> value.hex('_', 2)
               'f0_f1f2'
               >>> b'UUDDLRLRAB'.hex(' ', -4)
               '55554444 4c524c52 4142'

          New in version 3.5.

          Changed in version 3.8: *note bytes.hex(): 625. now supports
          optional `sep' and `bytes_per_sep' parameters to insert
          separators between bytes in the hex output.

Since bytes objects are sequences of integers (akin to a tuple), for a
bytes object `b', ‘b[0]’ will be an integer, while ‘b[0:1]’ will be a
bytes object of length 1.  (This contrasts with text strings, where both
indexing and slicing will produce a string of length 1)

The representation of bytes objects uses the literal format (‘b'...'’)
since it is often more useful than e.g.  ‘bytes([46, 46, 46])’.  You can
always convert a bytes object into a list of integers using ‘list(b)’.

     Note: For Python 2.x users: In the Python 2.x series, a variety of
     implicit conversions between 8-bit strings (the closest thing 2.x
     offers to a built-in binary data type) and Unicode strings were
     permitted.  This was a backwards compatibility workaround to
     account for the fact that Python originally only supported 8-bit
     text, and Unicode text was a later addition.  In Python 3.x, those
     implicit conversions are gone - conversions between 8-bit binary
     data and Unicode text must be explicit, and bytes and string
     objects will always compare unequal.


File: python.info,  Node: Bytearray Objects,  Next: Bytes and Bytearray Operations,  Prev: Bytes Objects,  Up: Binary Sequence Types — bytes bytearray memoryview

5.4.8.2 Bytearray Objects
.........................

*note bytearray: 327. objects are a mutable counterpart to *note bytes:
326. objects.

 -- Class: bytearray ([source[, encoding[, errors]]])

     There is no dedicated literal syntax for bytearray objects, instead
     they are always created by calling the constructor:

        * Creating an empty instance: ‘bytearray()’

        * Creating a zero-filled instance with a given length:
          ‘bytearray(10)’

        * From an iterable of integers: ‘bytearray(range(20))’

        * Copying existing binary data via the buffer protocol:
          ‘bytearray(b'Hi!')’

     As bytearray objects are mutable, they support the *note mutable:
     1521. sequence operations in addition to the common bytes and
     bytearray operations described in *note Bytes and Bytearray
     Operations: 1522.

     Also see the *note bytearray: ff7. built-in.

     Since 2 hexadecimal digits correspond precisely to a single byte,
     hexadecimal numbers are a commonly used format for describing
     binary data.  Accordingly, the bytearray type has an additional
     class method to read data in that format:

      -- Class Method: fromhex (string)

          This *note bytearray: 327. class method returns bytearray
          object, decoding the given string object.  The string must
          contain two hexadecimal digits per byte, with ASCII whitespace
          being ignored.

               >>> bytearray.fromhex('2Ef0 F1f2  ')
               bytearray(b'.\xf0\xf1\xf2')

          Changed in version 3.7: *note bytearray.fromhex(): 324. now
          skips all ASCII whitespace in the string, not just spaces.

     A reverse conversion function exists to transform a bytearray
     object into its hexadecimal representation.

      -- Method: hex ()

          Return a string object containing two hexadecimal digits for
          each byte in the instance.

               >>> bytearray(b'\xf0\xf1\xf2').hex()
               'f0f1f2'

          New in version 3.5.

Since bytearray objects are sequences of integers (akin to a list), for
a bytearray object `b', ‘b[0]’ will be an integer, while ‘b[0:1]’ will
be a bytearray object of length 1.  (This contrasts with text strings,
where both indexing and slicing will produce a string of length 1)

The representation of bytearray objects uses the bytes literal format
(‘bytearray(b'...')’) since it is often more useful than e.g.
‘bytearray([46, 46, 46])’.  You can always convert a bytearray object
into a list of integers using ‘list(b)’.


File: python.info,  Node: Bytes and Bytearray Operations,  Next: printf-style Bytes Formatting,  Prev: Bytearray Objects,  Up: Binary Sequence Types — bytes bytearray memoryview

5.4.8.3 Bytes and Bytearray Operations
......................................

Both bytes and bytearray objects support the *note common: 156a.
sequence operations.  They interoperate not just with operands of the
same type, but with any *note bytes-like object: 5dd.  Due to this
flexibility, they can be freely mixed in operations without causing
errors.  However, the return type of the result may depend on the order
of operands.

     Note: The methods on bytes and bytearray objects don’t accept
     strings as their arguments, just as the methods on strings don’t
     accept bytes as their arguments.  For example, you have to write:

          a = "abc"
          b = a.replace("a", "f")

     and:

          a = b"abc"
          b = a.replace(b"a", b"f")

Some bytes and bytearray operations assume the use of ASCII compatible
binary formats, and hence should be avoided when working with arbitrary
binary data.  These restrictions are covered below.

     Note: Using these ASCII based operations to manipulate binary data
     that is not stored in an ASCII based format may lead to data
     corruption.

The following methods on bytes and bytearray objects can be used with
arbitrary binary data.

 -- Method: bytes.count (sub[, start[, end]])
 -- Method: bytearray.count (sub[, start[, end]])

     Return the number of non-overlapping occurrences of subsequence
     `sub' in the range [`start', `end'].  Optional arguments `start'
     and `end' are interpreted as in slice notation.

     The subsequence to search for may be any *note bytes-like object:
     5dd. or an integer in the range 0 to 255.

     Changed in version 3.3: Also accept an integer in the range 0 to
     255 as the subsequence.

 -- Method: bytes.decode (encoding="utf-8", errors="strict")
 -- Method: bytearray.decode (encoding="utf-8", errors="strict")

     Return a string decoded from the given bytes.  Default encoding is
     ‘'utf-8'’.  `errors' may be given to set a different error handling
     scheme.  The default for `errors' is ‘'strict'’, meaning that
     encoding errors raise a *note UnicodeError: c2e.  Other possible
     values are ‘'ignore'’, ‘'replace'’ and any other name registered
     via *note codecs.register_error(): de8, see section *note Error
     Handlers: 129c.  For a list of possible encodings, see section
     *note Standard Encodings: 683.

          Note: Passing the `encoding' argument to *note str: 325.
          allows decoding any *note bytes-like object: 5dd. directly,
          without needing to make a temporary bytes or bytearray object.

     Changed in version 3.1: Added support for keyword arguments.

 -- Method: bytes.endswith (suffix[, start[, end]])
 -- Method: bytearray.endswith (suffix[, start[, end]])

     Return ‘True’ if the binary data ends with the specified `suffix',
     otherwise return ‘False’.  `suffix' can also be a tuple of suffixes
     to look for.  With optional `start', test beginning at that
     position.  With optional `end', stop comparing at that position.

     The suffix(es) to search for may be any *note bytes-like object:
     5dd.

 -- Method: bytes.find (sub[, start[, end]])
 -- Method: bytearray.find (sub[, start[, end]])

     Return the lowest index in the data where the subsequence `sub' is
     found, such that `sub' is contained in the slice ‘s[start:end]’.
     Optional arguments `start' and `end' are interpreted as in slice
     notation.  Return ‘-1’ if `sub' is not found.

     The subsequence to search for may be any *note bytes-like object:
     5dd. or an integer in the range 0 to 255.

          Note: The *note find(): 15a6. method should be used only if
          you need to know the position of `sub'.  To check if `sub' is
          a substring or not, use the *note in: 797. operator:

               >>> b'Py' in b'Python'
               True

     Changed in version 3.3: Also accept an integer in the range 0 to
     255 as the subsequence.

 -- Method: bytes.index (sub[, start[, end]])
 -- Method: bytearray.index (sub[, start[, end]])

     Like *note find(): 15a6, but raise *note ValueError: 1f9. when the
     subsequence is not found.

     The subsequence to search for may be any *note bytes-like object:
     5dd. or an integer in the range 0 to 255.

     Changed in version 3.3: Also accept an integer in the range 0 to
     255 as the subsequence.

 -- Method: bytes.join (iterable)
 -- Method: bytearray.join (iterable)

     Return a bytes or bytearray object which is the concatenation of
     the binary data sequences in `iterable'.  A *note TypeError: 192.
     will be raised if there are any values in `iterable' that are not
     *note bytes-like objects: 5dd, including *note str: 325. objects.
     The separator between elements is the contents of the bytes or
     bytearray object providing this method.

 -- Static Method: bytes.maketrans (from, to)
 -- Static Method: bytearray.maketrans (from, to)

     This static method returns a translation table usable for *note
     bytes.translate(): 15ab. that will map each character in `from'
     into the character at the same position in `to'; `from' and `to'
     must both be *note bytes-like objects: 5dd. and have the same
     length.

     New in version 3.1.

 -- Method: bytes.partition (sep)
 -- Method: bytearray.partition (sep)

     Split the sequence at the first occurrence of `sep', and return a
     3-tuple containing the part before the separator, the separator
     itself or its bytearray copy, and the part after the separator.  If
     the separator is not found, return a 3-tuple containing a copy of
     the original sequence, followed by two empty bytes or bytearray
     objects.

     The separator to search for may be any *note bytes-like object:
     5dd.

 -- Method: bytes.replace (old, new[, count])
 -- Method: bytearray.replace (old, new[, count])

     Return a copy of the sequence with all occurrences of subsequence
     `old' replaced by `new'.  If the optional argument `count' is
     given, only the first `count' occurrences are replaced.

     The subsequence to search for and its replacement may be any *note
     bytes-like object: 5dd.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.rfind (sub[, start[, end]])
 -- Method: bytearray.rfind (sub[, start[, end]])

     Return the highest index in the sequence where the subsequence
     `sub' is found, such that `sub' is contained within ‘s[start:end]’.
     Optional arguments `start' and `end' are interpreted as in slice
     notation.  Return ‘-1’ on failure.

     The subsequence to search for may be any *note bytes-like object:
     5dd. or an integer in the range 0 to 255.

     Changed in version 3.3: Also accept an integer in the range 0 to
     255 as the subsequence.

 -- Method: bytes.rindex (sub[, start[, end]])
 -- Method: bytearray.rindex (sub[, start[, end]])

     Like *note rfind(): 15b0. but raises *note ValueError: 1f9. when
     the subsequence `sub' is not found.

     The subsequence to search for may be any *note bytes-like object:
     5dd. or an integer in the range 0 to 255.

     Changed in version 3.3: Also accept an integer in the range 0 to
     255 as the subsequence.

 -- Method: bytes.rpartition (sep)
 -- Method: bytearray.rpartition (sep)

     Split the sequence at the last occurrence of `sep', and return a
     3-tuple containing the part before the separator, the separator
     itself or its bytearray copy, and the part after the separator.  If
     the separator is not found, return a 3-tuple containing two empty
     bytes or bytearray objects, followed by a copy of the original
     sequence.

     The separator to search for may be any *note bytes-like object:
     5dd.

 -- Method: bytes.startswith (prefix[, start[, end]])
 -- Method: bytearray.startswith (prefix[, start[, end]])

     Return ‘True’ if the binary data starts with the specified
     `prefix', otherwise return ‘False’.  `prefix' can also be a tuple
     of prefixes to look for.  With optional `start', test beginning at
     that position.  With optional `end', stop comparing at that
     position.

     The prefix(es) to search for may be any *note bytes-like object:
     5dd.

 -- Method: bytes.translate (table, /, delete=b'')
 -- Method: bytearray.translate (table, /, delete=b'')

     Return a copy of the bytes or bytearray object where all bytes
     occurring in the optional argument `delete' are removed, and the
     remaining bytes have been mapped through the given translation
     table, which must be a bytes object of length 256.

     You can use the *note bytes.maketrans(): bfc. method to create a
     translation table.

     Set the `table' argument to ‘None’ for translations that only
     delete characters:

          >>> b'read this short text'.translate(None, b'aeiou')
          b'rd ths shrt txt'

     Changed in version 3.6: `delete' is now supported as a keyword
     argument.

The following methods on bytes and bytearray objects have default
behaviours that assume the use of ASCII compatible binary formats, but
can still be used with arbitrary binary data by passing appropriate
arguments.  Note that all of the bytearray methods in this section do
`not' operate in place, and instead produce new objects.

 -- Method: bytes.center (width[, fillbyte])
 -- Method: bytearray.center (width[, fillbyte])

     Return a copy of the object centered in a sequence of length
     `width'.  Padding is done using the specified `fillbyte' (default
     is an ASCII space).  For *note bytes: 326. objects, the original
     sequence is returned if `width' is less than or equal to ‘len(s)’.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.ljust (width[, fillbyte])
 -- Method: bytearray.ljust (width[, fillbyte])

     Return a copy of the object left justified in a sequence of length
     `width'.  Padding is done using the specified `fillbyte' (default
     is an ASCII space).  For *note bytes: 326. objects, the original
     sequence is returned if `width' is less than or equal to ‘len(s)’.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.lstrip ([chars])
 -- Method: bytearray.lstrip ([chars])

     Return a copy of the sequence with specified leading bytes removed.
     The `chars' argument is a binary sequence specifying the set of
     byte values to be removed - the name refers to the fact this method
     is usually used with ASCII characters.  If omitted or ‘None’, the
     `chars' argument defaults to removing ASCII whitespace.  The
     `chars' argument is not a prefix; rather, all combinations of its
     values are stripped:

          >>> b'   spacious   '.lstrip()
          b'spacious   '
          >>> b'www.example.com'.lstrip(b'cmowz.')
          b'example.com'

     The binary sequence of byte values to remove may be any *note
     bytes-like object: 5dd.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.rjust (width[, fillbyte])
 -- Method: bytearray.rjust (width[, fillbyte])

     Return a copy of the object right justified in a sequence of length
     `width'.  Padding is done using the specified `fillbyte' (default
     is an ASCII space).  For *note bytes: 326. objects, the original
     sequence is returned if `width' is less than or equal to ‘len(s)’.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.rsplit (sep=None, maxsplit=-1)
 -- Method: bytearray.rsplit (sep=None, maxsplit=-1)

     Split the binary sequence into subsequences of the same type, using
     `sep' as the delimiter string.  If `maxsplit' is given, at most
     `maxsplit' splits are done, the `rightmost' ones.  If `sep' is not
     specified or ‘None’, any subsequence consisting solely of ASCII
     whitespace is a separator.  Except for splitting from the right,
     *note rsplit(): 15c1. behaves like *note split(): 15c2. which is
     described in detail below.

 -- Method: bytes.rstrip ([chars])
 -- Method: bytearray.rstrip ([chars])

     Return a copy of the sequence with specified trailing bytes
     removed.  The `chars' argument is a binary sequence specifying the
     set of byte values to be removed - the name refers to the fact this
     method is usually used with ASCII characters.  If omitted or
     ‘None’, the `chars' argument defaults to removing ASCII whitespace.
     The `chars' argument is not a suffix; rather, all combinations of
     its values are stripped:

          >>> b'   spacious   '.rstrip()
          b'   spacious'
          >>> b'mississippi'.rstrip(b'ipz')
          b'mississ'

     The binary sequence of byte values to remove may be any *note
     bytes-like object: 5dd.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.split (sep=None, maxsplit=-1)
 -- Method: bytearray.split (sep=None, maxsplit=-1)

     Split the binary sequence into subsequences of the same type, using
     `sep' as the delimiter string.  If `maxsplit' is given and
     non-negative, at most `maxsplit' splits are done (thus, the list
     will have at most ‘maxsplit+1’ elements).  If `maxsplit' is not
     specified or is ‘-1’, then there is no limit on the number of
     splits (all possible splits are made).

     If `sep' is given, consecutive delimiters are not grouped together
     and are deemed to delimit empty subsequences (for example,
     ‘b'1,,2'.split(b',')’ returns ‘[b'1', b'', b'2']’).  The `sep'
     argument may consist of a multibyte sequence (for example,
     ‘b'1<>2<>3'.split(b'<>')’ returns ‘[b'1', b'2', b'3']’).  Splitting
     an empty sequence with a specified separator returns ‘[b'']’ or
     ‘[bytearray(b'')]’ depending on the type of object being split.
     The `sep' argument may be any *note bytes-like object: 5dd.

     For example:

          >>> b'1,2,3'.split(b',')
          [b'1', b'2', b'3']
          >>> b'1,2,3'.split(b',', maxsplit=1)
          [b'1', b'2,3']
          >>> b'1,2,,3,'.split(b',')
          [b'1', b'2', b'', b'3', b'']

     If `sep' is not specified or is ‘None’, a different splitting
     algorithm is applied: runs of consecutive ASCII whitespace are
     regarded as a single separator, and the result will contain no
     empty strings at the start or end if the sequence has leading or
     trailing whitespace.  Consequently, splitting an empty sequence or
     a sequence consisting solely of ASCII whitespace without a
     specified separator returns ‘[]’.

     For example:

          >>> b'1 2 3'.split()
          [b'1', b'2', b'3']
          >>> b'1 2 3'.split(maxsplit=1)
          [b'1', b'2 3']
          >>> b'   1   2   3   '.split()
          [b'1', b'2', b'3']

 -- Method: bytes.strip ([chars])
 -- Method: bytearray.strip ([chars])

     Return a copy of the sequence with specified leading and trailing
     bytes removed.  The `chars' argument is a binary sequence
     specifying the set of byte values to be removed - the name refers
     to the fact this method is usually used with ASCII characters.  If
     omitted or ‘None’, the `chars' argument defaults to removing ASCII
     whitespace.  The `chars' argument is not a prefix or suffix;
     rather, all combinations of its values are stripped:

          >>> b'   spacious   '.strip()
          b'spacious'
          >>> b'www.example.com'.strip(b'cmowz.')
          b'example'

     The binary sequence of byte values to remove may be any *note
     bytes-like object: 5dd.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

The following methods on bytes and bytearray objects assume the use of
ASCII compatible binary formats and should not be applied to arbitrary
binary data.  Note that all of the bytearray methods in this section do
`not' operate in place, and instead produce new objects.

 -- Method: bytes.capitalize ()
 -- Method: bytearray.capitalize ()

     Return a copy of the sequence with each byte interpreted as an
     ASCII character, and the first byte capitalized and the rest
     lowercased.  Non-ASCII byte values are passed through unchanged.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.expandtabs (tabsize=8)
 -- Method: bytearray.expandtabs (tabsize=8)

     Return a copy of the sequence where all ASCII tab characters are
     replaced by one or more ASCII spaces, depending on the current
     column and the given tab size.  Tab positions occur every `tabsize'
     bytes (default is 8, giving tab positions at columns 0, 8, 16 and
     so on).  To expand the sequence, the current column is set to zero
     and the sequence is examined byte by byte.  If the byte is an ASCII
     tab character (‘b'\t'’), one or more space characters are inserted
     in the result until the current column is equal to the next tab
     position.  (The tab character itself is not copied.)  If the
     current byte is an ASCII newline (‘b'\n'’) or carriage return
     (‘b'\r'’), it is copied and the current column is reset to zero.
     Any other byte value is copied unchanged and the current column is
     incremented by one regardless of how the byte value is represented
     when printed:

          >>> b'01\t012\t0123\t01234'.expandtabs()
          b'01      012     0123    01234'
          >>> b'01\t012\t0123\t01234'.expandtabs(4)
          b'01  012 0123    01234'

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.isalnum ()
 -- Method: bytearray.isalnum ()

     Return ‘True’ if all bytes in the sequence are alphabetical ASCII
     characters or ASCII decimal digits and the sequence is not empty,
     ‘False’ otherwise.  Alphabetic ASCII characters are those byte
     values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'’.  ASCII
     decimal digits are those byte values in the sequence
     ‘b'0123456789'’.

     For example:

          >>> b'ABCabc1'.isalnum()
          True
          >>> b'ABC abc1'.isalnum()
          False

 -- Method: bytes.isalpha ()
 -- Method: bytearray.isalpha ()

     Return ‘True’ if all bytes in the sequence are alphabetic ASCII
     characters and the sequence is not empty, ‘False’ otherwise.
     Alphabetic ASCII characters are those byte values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'’.

     For example:

          >>> b'ABCabc'.isalpha()
          True
          >>> b'ABCabc1'.isalpha()
          False

 -- Method: bytes.isascii ()
 -- Method: bytearray.isascii ()

     Return ‘True’ if the sequence is empty or all bytes in the sequence
     are ASCII, ‘False’ otherwise.  ASCII bytes are in the range 0-0x7F.

     New in version 3.7.

 -- Method: bytes.isdigit ()
 -- Method: bytearray.isdigit ()

     Return ‘True’ if all bytes in the sequence are ASCII decimal digits
     and the sequence is not empty, ‘False’ otherwise.  ASCII decimal
     digits are those byte values in the sequence ‘b'0123456789'’.

     For example:

          >>> b'1234'.isdigit()
          True
          >>> b'1.23'.isdigit()
          False

 -- Method: bytes.islower ()
 -- Method: bytearray.islower ()

     Return ‘True’ if there is at least one lowercase ASCII character in
     the sequence and no uppercase ASCII characters, ‘False’ otherwise.

     For example:

          >>> b'hello world'.islower()
          True
          >>> b'Hello world'.islower()
          False

     Lowercase ASCII characters are those byte values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyz'’.  Uppercase ASCII characters are
     those byte values in the sequence ‘b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'’.

 -- Method: bytes.isspace ()
 -- Method: bytearray.isspace ()

     Return ‘True’ if all bytes in the sequence are ASCII whitespace and
     the sequence is not empty, ‘False’ otherwise.  ASCII whitespace
     characters are those byte values in the sequence ‘b' \t\n\r\x0b\f'’
     (space, tab, newline, carriage return, vertical tab, form feed).

 -- Method: bytes.istitle ()
 -- Method: bytearray.istitle ()

     Return ‘True’ if the sequence is ASCII titlecase and the sequence
     is not empty, ‘False’ otherwise.  See *note bytes.title(): 15da.
     for more details on the definition of “titlecase”.

     For example:

          >>> b'Hello World'.istitle()
          True
          >>> b'Hello world'.istitle()
          False

 -- Method: bytes.isupper ()
 -- Method: bytearray.isupper ()

     Return ‘True’ if there is at least one uppercase alphabetic ASCII
     character in the sequence and no lowercase ASCII characters,
     ‘False’ otherwise.

     For example:

          >>> b'HELLO WORLD'.isupper()
          True
          >>> b'Hello world'.isupper()
          False

     Lowercase ASCII characters are those byte values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyz'’.  Uppercase ASCII characters are
     those byte values in the sequence ‘b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'’.

 -- Method: bytes.lower ()
 -- Method: bytearray.lower ()

     Return a copy of the sequence with all the uppercase ASCII
     characters converted to their corresponding lowercase counterpart.

     For example:

          >>> b'Hello World'.lower()
          b'hello world'

     Lowercase ASCII characters are those byte values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyz'’.  Uppercase ASCII characters are
     those byte values in the sequence ‘b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'’.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.splitlines (keepends=False)
 -- Method: bytearray.splitlines (keepends=False)

     Return a list of the lines in the binary sequence, breaking at
     ASCII line boundaries.  This method uses the *note universal
     newlines: 5e9. approach to splitting lines.  Line breaks are not
     included in the resulting list unless `keepends' is given and true.

     For example:

          >>> b'ab c\n\nde fg\rkl\r\n'.splitlines()
          [b'ab c', b'', b'de fg', b'kl']
          >>> b'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
          [b'ab c\n', b'\n', b'de fg\r', b'kl\r\n']

     Unlike *note split(): 15c5. when a delimiter string `sep' is given,
     this method returns an empty list for the empty string, and a
     terminal line break does not result in an extra line:

          >>> b"".split(b'\n'), b"Two lines\n".split(b'\n')
          ([b''], [b'Two lines', b''])
          >>> b"".splitlines(), b"One line\n".splitlines()
          ([], [b'One line'])

 -- Method: bytes.swapcase ()
 -- Method: bytearray.swapcase ()

     Return a copy of the sequence with all the lowercase ASCII
     characters converted to their corresponding uppercase counterpart
     and vice-versa.

     For example:

          >>> b'Hello World'.swapcase()
          b'hELLO wORLD'

     Lowercase ASCII characters are those byte values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyz'’.  Uppercase ASCII characters are
     those byte values in the sequence ‘b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'’.

     Unlike *note str.swapcase(): 1597, it is always the case that
     ‘bin.swapcase().swapcase() == bin’ for the binary versions.  Case
     conversions are symmetrical in ASCII, even though that is not
     generally true for arbitrary Unicode code points.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.title ()
 -- Method: bytearray.title ()

     Return a titlecased version of the binary sequence where words
     start with an uppercase ASCII character and the remaining
     characters are lowercase.  Uncased byte values are left unmodified.

     For example:

          >>> b'Hello world'.title()
          b'Hello World'

     Lowercase ASCII characters are those byte values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyz'’.  Uppercase ASCII characters are
     those byte values in the sequence ‘b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'’.
     All other byte values are uncased.

     The algorithm uses a simple language-independent definition of a
     word as groups of consecutive letters.  The definition works in
     many contexts but it means that apostrophes in contractions and
     possessives form word boundaries, which may not be the desired
     result:

          >>> b"they're bill's friends from the UK".title()
          b"They'Re Bill'S Friends From The Uk"

     A workaround for apostrophes can be constructed using regular
     expressions:

          >>> import re
          >>> def titlecase(s):
          ...     return re.sub(rb"[A-Za-z]+('[A-Za-z]+)?",
          ...                   lambda mo: mo.group(0)[0:1].upper() +
          ...                              mo.group(0)[1:].lower(),
          ...                   s)
          ...
          >>> titlecase(b"they're bill's friends.")
          b"They're Bill's Friends."

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.upper ()
 -- Method: bytearray.upper ()

     Return a copy of the sequence with all the lowercase ASCII
     characters converted to their corresponding uppercase counterpart.

     For example:

          >>> b'Hello World'.upper()
          b'HELLO WORLD'

     Lowercase ASCII characters are those byte values in the sequence
     ‘b'abcdefghijklmnopqrstuvwxyz'’.  Uppercase ASCII characters are
     those byte values in the sequence ‘b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'’.

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.

 -- Method: bytes.zfill (width)
 -- Method: bytearray.zfill (width)

     Return a copy of the sequence left filled with ASCII ‘b'0'’ digits
     to make a sequence of length `width'.  A leading sign prefix
     (‘b'+'’/ ‘b'-'’) is handled by inserting the padding `after' the
     sign character rather than before.  For *note bytes: 326. objects,
     the original sequence is returned if `width' is less than or equal
     to ‘len(seq)’.

     For example:

          >>> b"42".zfill(5)
          b'00042'
          >>> b"-42".zfill(5)
          b'-0042'

          Note: The bytearray version of this method does `not' operate
          in place - it always produces a new object, even if no changes
          were made.


File: python.info,  Node: printf-style Bytes Formatting,  Next: Memory Views,  Prev: Bytes and Bytearray Operations,  Up: Binary Sequence Types — bytes bytearray memoryview

5.4.8.4 ‘printf’-style Bytes Formatting
.......................................

     Note: The formatting operations described here exhibit a variety of
     quirks that lead to a number of common errors (such as failing to
     display tuples and dictionaries correctly).  If the value being
     printed may be a tuple or dictionary, wrap it in a tuple.

Bytes objects (‘bytes’/‘bytearray’) have one unique built-in operation:
the ‘%’ operator (modulo).  This is also known as the bytes `formatting'
or `interpolation' operator.  Given ‘format % values’ (where `format' is
a bytes object), ‘%’ conversion specifications in `format' are replaced
with zero or more elements of `values'.  The effect is similar to using
the ‘sprintf()’ in the C language.

If `format' requires a single argument, `values' may be a single
non-tuple object.  (1) Otherwise, `values' must be a tuple with exactly
the number of items specified by the format bytes object, or a single
mapping object (for example, a dictionary).

A conversion specifier contains two or more characters and has the
following components, which must occur in this order:

  1. The ‘'%'’ character, which marks the start of the specifier.

  2. Mapping key (optional), consisting of a parenthesised sequence of
     characters (for example, ‘(somename)’).

  3. Conversion flags (optional), which affect the result of some
     conversion types.

  4. Minimum field width (optional).  If specified as an ‘'*'’
     (asterisk), the actual width is read from the next element of the
     tuple in `values', and the object to convert comes after the
     minimum field width and optional precision.

  5. Precision (optional), given as a ‘'.'’ (dot) followed by the
     precision.  If specified as ‘'*'’ (an asterisk), the actual
     precision is read from the next element of the tuple in `values',
     and the value to convert comes after the precision.

  6. Length modifier (optional).

  7. Conversion type.

When the right argument is a dictionary (or other mapping type), then
the formats in the bytes object `must' include a parenthesised mapping
key into that dictionary inserted immediately after the ‘'%'’ character.
The mapping key selects the value to be formatted from the mapping.  For
example:

     >>> print(b'%(language)s has %(number)03d quote types.' %
     ...       {b'language': b"Python", b"number": 2})
     b'Python has 002 quote types.'

In this case no ‘*’ specifiers may occur in a format (since they require
a sequential parameter list).

The conversion flag characters are:

Flag          Meaning
              
----------------------------------------------------------------------------------------
              
‘'#'’         The value conversion will use the “alternate form” (where defined
              below).
              
              
‘'0'’         The conversion will be zero padded for numeric values.
              
              
‘'-'’         The converted value is left adjusted (overrides the ‘'0'’ conversion if
              both are given).
              
              
‘' '’         (a space) A blank should be left before a positive number (or empty
              string) produced by a signed conversion.
              
              
‘'+'’         A sign character (‘'+'’ or ‘'-'’) will precede the conversion
              (overrides a “space” flag).
              

A length modifier (‘h’, ‘l’, or ‘L’) may be present, but is ignored as
it is not necessary for Python – so e.g.  ‘%ld’ is identical to ‘%d’.

The conversion types are:

Conversion       Meaning                                                   Notes
                                                                           
---------------------------------------------------------------------------------------
                                                                           
‘'d'’            Signed integer decimal.
                 
                                                                           
‘'i'’            Signed integer decimal.
                 
                                                                           
‘'o'’            Signed octal value.                                       (1)
                                                                           
                                                                           
‘'u'’            Obsolete type – it is identical to ‘'d'’.                 (8)
                                                                           
                                                                           
‘'x'’            Signed hexadecimal (lowercase).                           (2)
                                                                           
                                                                           
‘'X'’            Signed hexadecimal (uppercase).                           (2)
                                                                           
                                                                           
‘'e'’            Floating point exponential format (lowercase).            (3)
                                                                           
                                                                           
‘'E'’            Floating point exponential format (uppercase).            (3)
                                                                           
                                                                           
‘'f'’            Floating point decimal format.                            (3)
                                                                           
                                                                           
‘'F'’            Floating point decimal format.                            (3)
                                                                           
                                                                           
‘'g'’            Floating point format.  Uses lowercase exponential        (4)
                 format if exponent is less than -4 or not less than       
                 precision, decimal format otherwise.
                 
                                                                           
‘'G'’            Floating point format.  Uses uppercase exponential        (4)
                 format if exponent is less than -4 or not less than       
                 precision, decimal format otherwise.
                 
                                                                           
‘'c'’            Single byte (accepts integer or single byte objects).
                 
                                                                           
‘'b'’            Bytes (any object that follows the                        (5)
                 *note buffer protocol: 1579. or has                       
                 *note __bytes__(): 1373.).
                 
                                                                           
‘'s'’            ‘'s'’ is an alias for ‘'b'’ and should only be used for   (6)
                 Python2/3 code bases.                                     
                 
                                                                           
‘'a'’            Bytes (converts any Python object using                   (5)
                 ‘repr(obj).encode('ascii','backslashreplace)’).           
                 
                                                                           
‘'r'’            ‘'r'’ is an alias for ‘'a'’ and should only be used for   (7)
                 Python2/3 code bases.                                     
                 
                                                                           
‘'%'’            No argument is converted, results in a ‘'%'’ character
                 in the result.
                 

Notes:

  1. The alternate form causes a leading octal specifier (‘'0o'’) to be
     inserted before the first digit.

  2. The alternate form causes a leading ‘'0x'’ or ‘'0X'’ (depending on
     whether the ‘'x'’ or ‘'X'’ format was used) to be inserted before
     the first digit.

  3. The alternate form causes the result to always contain a decimal
     point, even if no digits follow it.

     The precision determines the number of digits after the decimal
     point and defaults to 6.

  4. The alternate form causes the result to always contain a decimal
     point, and trailing zeroes are not removed as they would otherwise
     be.

     The precision determines the number of significant digits before
     and after the decimal point and defaults to 6.

  5. If precision is ‘N’, the output is truncated to ‘N’ characters.

  6. ‘b'%s'’ is deprecated, but will not be removed during the 3.x
     series.

  7. ‘b'%r'’ is deprecated, but will not be removed during the 3.x
     series.

  8. See PEP 237(2).

     Note: The bytearray version of this method does `not' operate in
     place - it always produces a new object, even if no changes were
     made.

See also
........

PEP 461(3) - Adding % formatting to bytes and bytearray

New in version 3.5.

   ---------- Footnotes ----------

   (1) (5) To format only a tuple you should therefore provide a
singleton tuple whose only element is the tuple to be formatted.

   (2) https://www.python.org/dev/peps/pep-0237

   (3) https://www.python.org/dev/peps/pep-0461


File: python.info,  Node: Memory Views,  Prev: printf-style Bytes Formatting,  Up: Binary Sequence Types — bytes bytearray memoryview

5.4.8.5 Memory Views
....................

*note memoryview: 25a. objects allow Python code to access the internal
data of an object that supports the *note buffer protocol: 1579. without
copying.

 -- Class: memoryview (obj)

     Create a *note memoryview: 25a. that references `obj'.  `obj' must
     support the buffer protocol.  Built-in objects that support the
     buffer protocol include *note bytes: 326. and *note bytearray: 327.

     A *note memoryview: 25a. has the notion of an `element', which is
     the atomic memory unit handled by the originating object `obj'.
     For many simple types such as *note bytes: 326. and *note
     bytearray: 327, an element is a single byte, but other types such
     as *note array.array: 446. may have bigger elements.

     ‘len(view)’ is equal to the length of *note tolist: 15ea.  If
     ‘view.ndim = 0’, the length is 1.  If ‘view.ndim = 1’, the length
     is equal to the number of elements in the view.  For higher
     dimensions, the length is equal to the length of the nested list
     representation of the view.  The *note itemsize: 15eb. attribute
     will give you the number of bytes in a single element.

     A *note memoryview: 25a. supports slicing and indexing to expose
     its data.  One-dimensional slicing will result in a subview:

          >>> v = memoryview(b'abcefg')
          >>> v[1]
          98
          >>> v[-1]
          103
          >>> v[1:4]
          <memory at 0x7f3ddc9f4350>
          >>> bytes(v[1:4])
          b'bce'

     If *note format: 15ec. is one of the native format specifiers from
     the *note struct: f8. module, indexing with an integer or a tuple
     of integers is also supported and returns a single `element' with
     the correct type.  One-dimensional memoryviews can be indexed with
     an integer or a one-integer tuple.  Multi-dimensional memoryviews
     can be indexed with tuples of exactly `ndim' integers where `ndim'
     is the number of dimensions.  Zero-dimensional memoryviews can be
     indexed with the empty tuple.

     Here is an example with a non-byte format:

          >>> import array
          >>> a = array.array('l', [-11111111, 22222222, -33333333, 44444444])
          >>> m = memoryview(a)
          >>> m[0]
          -11111111
          >>> m[-1]
          44444444
          >>> m[::2].tolist()
          [-11111111, -33333333]

     If the underlying object is writable, the memoryview supports
     one-dimensional slice assignment.  Resizing is not allowed:

          >>> data = bytearray(b'abcefg')
          >>> v = memoryview(data)
          >>> v.readonly
          False
          >>> v[0] = ord(b'z')
          >>> data
          bytearray(b'zbcefg')
          >>> v[1:4] = b'123'
          >>> data
          bytearray(b'z123fg')
          >>> v[2:3] = b'spam'
          Traceback (most recent call last):
            File "<stdin>", line 1, in <module>
          ValueError: memoryview assignment: lvalue and rvalue have different structures
          >>> v[2:6] = b'spam'
          >>> data
          bytearray(b'z1spam')

     One-dimensional memoryviews of hashable (read-only) types with
     formats ‘B’, ‘b’ or ‘c’ are also hashable.  The hash is defined as
     ‘hash(m) == hash(m.tobytes())’:

          >>> v = memoryview(b'abcefg')
          >>> hash(v) == hash(b'abcefg')
          True
          >>> hash(v[2:4]) == hash(b'ce')
          True
          >>> hash(v[::-2]) == hash(b'abcefg'[::-2])
          True

     Changed in version 3.3: One-dimensional memoryviews can now be
     sliced.  One-dimensional memoryviews with formats ‘B’, ‘b’ or ‘c’
     are now hashable.

     Changed in version 3.4: memoryview is now registered automatically
     with *note collections.abc.Sequence: 156b.

     Changed in version 3.5: memoryviews can now be indexed with tuple
     of integers.

     *note memoryview: 25a. has several methods:

      -- Method: __eq__ (exporter)

          A memoryview and a PEP 3118(1) exporter are equal if their
          shapes are equivalent and if all corresponding values are
          equal when the operands’ respective format codes are
          interpreted using *note struct: f8. syntax.

          For the subset of *note struct: f8. format strings currently
          supported by *note tolist(): 15ea, ‘v’ and ‘w’ are equal if
          ‘v.tolist() == w.tolist()’:

               >>> import array
               >>> a = array.array('I', [1, 2, 3, 4, 5])
               >>> b = array.array('d', [1.0, 2.0, 3.0, 4.0, 5.0])
               >>> c = array.array('b', [5, 3, 1])
               >>> x = memoryview(a)
               >>> y = memoryview(b)
               >>> x == a == y == b
               True
               >>> x.tolist() == a.tolist() == y.tolist() == b.tolist()
               True
               >>> z = y[::-2]
               >>> z == c
               True
               >>> z.tolist() == c.tolist()
               True

          If either format string is not supported by the *note struct:
          f8. module, then the objects will always compare as unequal
          (even if the format strings and buffer contents are
          identical):

               >>> from ctypes import BigEndianStructure, c_long
               >>> class BEPoint(BigEndianStructure):
               ...     _fields_ = [("x", c_long), ("y", c_long)]
               ...
               >>> point = BEPoint(100, 200)
               >>> a = memoryview(point)
               >>> b = memoryview(point)
               >>> a == point
               False
               >>> a == b
               False

          Note that, as with floating point numbers, ‘v is w’ does `not'
          imply ‘v == w’ for memoryview objects.

          Changed in version 3.3: Previous versions compared the raw
          memory disregarding the item format and the logical array
          structure.

      -- Method: tobytes (order=None)

          Return the data in the buffer as a bytestring.  This is
          equivalent to calling the *note bytes: 326. constructor on the
          memoryview.

               >>> m = memoryview(b"abc")
               >>> m.tobytes()
               b'abc'
               >>> bytes(m)
               b'abc'

          For non-contiguous arrays the result is equal to the flattened
          list representation with all elements converted to bytes.
          *note tobytes(): 15ee. supports all format strings, including
          those that are not in *note struct: f8. module syntax.

          New in version 3.8: `order' can be {‘C’, ‘F’, ‘A’}.  When
          `order' is ‘C’ or ‘F’, the data of the original array is
          converted to C or Fortran order.  For contiguous views, ‘A’
          returns an exact copy of the physical memory.  In particular,
          in-memory Fortran order is preserved.  For non-contiguous
          views, the data is converted to C first.  `order=None' is the
          same as `order=’C’'.

      -- Method: hex ()

          Return a string object containing two hexadecimal digits for
          each byte in the buffer.

               >>> m = memoryview(b"abc")
               >>> m.hex()
               '616263'

          New in version 3.5.

      -- Method: tolist ()

          Return the data in the buffer as a list of elements.

               >>> memoryview(b'abc').tolist()
               [97, 98, 99]
               >>> import array
               >>> a = array.array('d', [1.1, 2.2, 3.3])
               >>> m = memoryview(a)
               >>> m.tolist()
               [1.1, 2.2, 3.3]

          Changed in version 3.3: *note tolist(): 15ea. now supports all
          single character native formats in *note struct: f8. module
          syntax as well as multi-dimensional representations.

      -- Method: toreadonly ()

          Return a readonly version of the memoryview object.  The
          original memoryview object is unchanged.

               >>> m = memoryview(bytearray(b'abc'))
               >>> mm = m.toreadonly()
               >>> mm.tolist()
               [89, 98, 99]
               >>> mm[0] = 42
               Traceback (most recent call last):
                 File "<stdin>", line 1, in <module>
               TypeError: cannot modify read-only memory
               >>> m[0] = 43
               >>> mm.tolist()
               [43, 98, 99]

          New in version 3.8.

      -- Method: release ()

          Release the underlying buffer exposed by the memoryview
          object.  Many objects take special actions when a view is held
          on them (for example, a *note bytearray: 327. would
          temporarily forbid resizing); therefore, calling release() is
          handy to remove these restrictions (and free any dangling
          resources) as soon as possible.

          After this method has been called, any further operation on
          the view raises a *note ValueError: 1f9. (except *note
          release(): b30. itself which can be called multiple times):

               >>> m = memoryview(b'abc')
               >>> m.release()
               >>> m[0]
               Traceback (most recent call last):
                 File "<stdin>", line 1, in <module>
               ValueError: operation forbidden on released memoryview object

          The context management protocol can be used for a similar
          effect, using the ‘with’ statement:

               >>> with memoryview(b'abc') as m:
               ...     m[0]
               ...
               97
               >>> m[0]
               Traceback (most recent call last):
                 File "<stdin>", line 1, in <module>
               ValueError: operation forbidden on released memoryview object

          New in version 3.2.

      -- Method: cast (format[, shape])

          Cast a memoryview to a new format or shape.  `shape' defaults
          to ‘[byte_length//new_itemsize]’, which means that the result
          view will be one-dimensional.  The return value is a new
          memoryview, but the buffer itself is not copied.  Supported
          casts are 1D -> C-*note contiguous: 15f1. and C-contiguous ->
          1D.

          The destination format is restricted to a single element
          native format in *note struct: f8. syntax.  One of the formats
          must be a byte format (‘B’, ‘b’ or ‘c’).  The byte length of
          the result must be the same as the original length.

          Cast 1D/long to 1D/unsigned bytes:

               >>> import array
               >>> a = array.array('l', [1,2,3])
               >>> x = memoryview(a)
               >>> x.format
               'l'
               >>> x.itemsize
               8
               >>> len(x)
               3
               >>> x.nbytes
               24
               >>> y = x.cast('B')
               >>> y.format
               'B'
               >>> y.itemsize
               1
               >>> len(y)
               24
               >>> y.nbytes
               24

          Cast 1D/unsigned bytes to 1D/char:

               >>> b = bytearray(b'zyz')
               >>> x = memoryview(b)
               >>> x[0] = b'a'
               Traceback (most recent call last):
                 File "<stdin>", line 1, in <module>
               ValueError: memoryview: invalid value for format "B"
               >>> y = x.cast('c')
               >>> y[0] = b'a'
               >>> b
               bytearray(b'ayz')

          Cast 1D/bytes to 3D/ints to 1D/signed char:

               >>> import struct
               >>> buf = struct.pack("i"*12, *list(range(12)))
               >>> x = memoryview(buf)
               >>> y = x.cast('i', shape=[2,2,3])
               >>> y.tolist()
               [[[0, 1, 2], [3, 4, 5]], [[6, 7, 8], [9, 10, 11]]]
               >>> y.format
               'i'
               >>> y.itemsize
               4
               >>> len(y)
               2
               >>> y.nbytes
               48
               >>> z = y.cast('b')
               >>> z.format
               'b'
               >>> z.itemsize
               1
               >>> len(z)
               48
               >>> z.nbytes
               48

          Cast 1D/unsigned long to 2D/unsigned long:

               >>> buf = struct.pack("L"*6, *list(range(6)))
               >>> x = memoryview(buf)
               >>> y = x.cast('L', shape=[2,3])
               >>> len(y)
               2
               >>> y.nbytes
               48
               >>> y.tolist()
               [[0, 1, 2], [3, 4, 5]]

          New in version 3.3.

          Changed in version 3.5: The source format is no longer
          restricted when casting to a byte view.

     There are also several readonly attributes available:

      -- Attribute: obj

          The underlying object of the memoryview:

               >>> b  = bytearray(b'xyz')
               >>> m = memoryview(b)
               >>> m.obj is b
               True

          New in version 3.3.

      -- Attribute: nbytes

          ‘nbytes == product(shape) * itemsize == len(m.tobytes())’.
          This is the amount of space in bytes that the array would use
          in a contiguous representation.  It is not necessarily equal
          to ‘len(m)’:

               >>> import array
               >>> a = array.array('i', [1,2,3,4,5])
               >>> m = memoryview(a)
               >>> len(m)
               5
               >>> m.nbytes
               20
               >>> y = m[::2]
               >>> len(y)
               3
               >>> y.nbytes
               12
               >>> len(y.tobytes())
               12

          Multi-dimensional arrays:

               >>> import struct
               >>> buf = struct.pack("d"*12, *[1.5*x for x in range(12)])
               >>> x = memoryview(buf)
               >>> y = x.cast('d', shape=[3,4])
               >>> y.tolist()
               [[0.0, 1.5, 3.0, 4.5], [6.0, 7.5, 9.0, 10.5], [12.0, 13.5, 15.0, 16.5]]
               >>> len(y)
               3
               >>> y.nbytes
               96

          New in version 3.3.

      -- Attribute: readonly

          A bool indicating whether the memory is read only.

      -- Attribute: format

          A string containing the format (in *note struct: f8. module
          style) for each element in the view.  A memoryview can be
          created from exporters with arbitrary format strings, but some
          methods (e.g.  *note tolist(): 15ea.) are restricted to native
          single element formats.

          Changed in version 3.3: format ‘'B'’ is now handled according
          to the struct module syntax.  This means that
          ‘memoryview(b'abc')[0] == b'abc'[0] == 97’.

      -- Attribute: itemsize

          The size in bytes of each element of the memoryview:

               >>> import array, struct
               >>> m = memoryview(array.array('H', [32000, 32001, 32002]))
               >>> m.itemsize
               2
               >>> m[0]
               32000
               >>> struct.calcsize('H') == m.itemsize
               True

      -- Attribute: ndim

          An integer indicating how many dimensions of a
          multi-dimensional array the memory represents.

      -- Attribute: shape

          A tuple of integers the length of *note ndim: 15f5. giving the
          shape of the memory as an N-dimensional array.

          Changed in version 3.3: An empty tuple instead of ‘None’ when
          ndim = 0.

      -- Attribute: strides

          A tuple of integers the length of *note ndim: 15f5. giving the
          size in bytes to access each element for each dimension of the
          array.

          Changed in version 3.3: An empty tuple instead of ‘None’ when
          ndim = 0.

      -- Attribute: suboffsets

          Used internally for PIL-style arrays.  The value is
          informational only.

      -- Attribute: c_contiguous

          A bool indicating whether the memory is C-*note contiguous:
          15f1.

          New in version 3.3.

      -- Attribute: f_contiguous

          A bool indicating whether the memory is Fortran *note
          contiguous: 15f1.

          New in version 3.3.

      -- Attribute: contiguous

          A bool indicating whether the memory is *note contiguous:
          15f1.

          New in version 3.3.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3118


File: python.info,  Node: Set Types — set frozenset,  Next: Mapping Types — dict,  Prev: Binary Sequence Types — bytes bytearray memoryview,  Up: Built-in Types

5.4.9 Set Types — ‘set’, ‘frozenset’
------------------------------------

A `set' object is an unordered collection of distinct *note hashable:
1364. objects.  Common uses include membership testing, removing
duplicates from a sequence, and computing mathematical operations such
as intersection, union, difference, and symmetric difference.  (For
other containers see the built-in *note dict: 1b6, *note list: 260, and
*note tuple: 473. classes, and the *note collections: 1e. module.)

Like other collections, sets support ‘x in set’, ‘len(set)’, and ‘for x
in set’.  Being an unordered collection, sets do not record element
position or order of insertion.  Accordingly, sets do not support
indexing, slicing, or other sequence-like behavior.

There are currently two built-in set types, *note set: b62. and *note
frozenset: be1.  The *note set: b62. type is mutable — the contents can
be changed using methods like ‘add()’ and ‘remove()’.  Since it is
mutable, it has no hash value and cannot be used as either a dictionary
key or as an element of another set.  The *note frozenset: be1. type is
immutable and *note hashable: 1364. — its contents cannot be altered
after it is created; it can therefore be used as a dictionary key or as
an element of another set.

Non-empty sets (not frozensets) can be created by placing a
comma-separated list of elements within braces, for example: ‘{'jack',
'sjoerd'}’, in addition to the *note set: b62. constructor.

The constructors for both classes work the same:

 -- Class: set ([iterable])
 -- Class: frozenset ([iterable])

     Return a new set or frozenset object whose elements are taken from
     `iterable'.  The elements of a set must be *note hashable: 1364.
     To represent sets of sets, the inner sets must be *note frozenset:
     be1. objects.  If `iterable' is not specified, a new empty set is
     returned.

     Instances of *note set: b62. and *note frozenset: be1. provide the
     following operations:

      -- Describe: len(s)

          Return the number of elements in set `s' (cardinality of `s').

      -- Describe: x in s

          Test `x' for membership in `s'.

      -- Describe: x not in s

          Test `x' for non-membership in `s'.

      -- Method: isdisjoint (other)

          Return ‘True’ if the set has no elements in common with
          `other'.  Sets are disjoint if and only if their intersection
          is the empty set.

      -- Method: issubset (other)

      -- Method: set <= other

          Test whether every element in the set is in `other'.

      -- Method: set < other

          Test whether the set is a proper subset of `other', that is,
          ‘set <= other and set != other’.

      -- Method: issuperset (other)

      -- Method: set >= other

          Test whether every element in `other' is in the set.

      -- Method: set > other

          Test whether the set is a proper superset of `other', that is,
          ‘set >= other and set != other’.

      -- Method: union (*others)

      -- Method: set | other | ...

          Return a new set with elements from the set and all others.

      -- Method: intersection (*others)

      -- Method: set & other & ...

          Return a new set with elements common to the set and all
          others.

      -- Method: difference (*others)

      -- Method: set - other - ...

          Return a new set with elements in the set that are not in the
          others.

      -- Method: symmetric_difference (other)

      -- Method: set ^ other

          Return a new set with elements in either the set or `other'
          but not both.

      -- Method: copy ()

          Return a shallow copy of the set.

     Note, the non-operator versions of *note union(): 1600, *note
     intersection(): 1601, *note difference(): 1602, and *note
     symmetric_difference(): 1603, *note issubset(): 15fe, and *note
     issuperset(): 15ff. methods will accept any iterable as an
     argument.  In contrast, their operator based counterparts require
     their arguments to be sets.  This precludes error-prone
     constructions like ‘set('abc') & 'cbs'’ in favor of the more
     readable ‘set('abc').intersection('cbs')’.

     Both *note set: b62. and *note frozenset: be1. support set to set
     comparisons.  Two sets are equal if and only if every element of
     each set is contained in the other (each is a subset of the other).
     A set is less than another set if and only if the first set is a
     proper subset of the second set (is a subset, but is not equal).  A
     set is greater than another set if and only if the first set is a
     proper superset of the second set (is a superset, but is not
     equal).

     Instances of *note set: b62. are compared to instances of *note
     frozenset: be1. based on their members.  For example, ‘set('abc')
     == frozenset('abc')’ returns ‘True’ and so does ‘set('abc') in
     set([frozenset('abc')])’.

     The subset and equality comparisons do not generalize to a total
     ordering function.  For example, any two nonempty disjoint sets are
     not equal and are not subsets of each other, so `all' of the
     following return ‘False’: ‘a<b’, ‘a==b’, or ‘a>b’.

     Since sets only define partial ordering (subset relationships), the
     output of the *note list.sort(): 43a. method is undefined for lists
     of sets.

     Set elements, like dictionary keys, must be *note hashable: 1364.

     Binary operations that mix *note set: b62. instances with *note
     frozenset: be1. return the type of the first operand.  For example:
     ‘frozenset('ab') | set('bc')’ returns an instance of *note
     frozenset: be1.

     The following table lists operations available for *note set: b62.
     that do not apply to immutable instances of *note frozenset: be1.:

      -- Method: update (*others)

      -- Method: set |= other | ...

          Update the set, adding elements from all others.

      -- Method: intersection_update (*others)

      -- Method: set &= other & ...

          Update the set, keeping only elements found in it and all
          others.

      -- Method: difference_update (*others)

      -- Method: set -= other | ...

          Update the set, removing elements found in others.

      -- Method: symmetric_difference_update (other)

      -- Method: set ^= other

          Update the set, keeping only elements found in either set, but
          not in both.

      -- Method: add (elem)

          Add element `elem' to the set.

      -- Method: remove (elem)

          Remove element `elem' from the set.  Raises *note KeyError:
          2c5. if `elem' is not contained in the set.

      -- Method: discard (elem)

          Remove element `elem' from the set if it is present.

      -- Method: pop ()

          Remove and return an arbitrary element from the set.  Raises
          *note KeyError: 2c5. if the set is empty.

      -- Method: clear ()

          Remove all elements from the set.

     Note, the non-operator versions of the *note update(): 1605, *note
     intersection_update(): 1606, *note difference_update(): 1607, and
     *note symmetric_difference_update(): 1608. methods will accept any
     iterable as an argument.

     Note, the `elem' argument to the *note __contains__(): d1b, *note
     remove(): 160a, and *note discard(): 160b. methods may be a set.
     To support searching for an equivalent frozenset, a temporary one
     is created from `elem'.


File: python.info,  Node: Mapping Types — dict,  Next: Context Manager Types,  Prev: Set Types — set frozenset,  Up: Built-in Types

5.4.10 Mapping Types — ‘dict’
-----------------------------

A *note mapping: b2c. object maps *note hashable: 1364. values to
arbitrary objects.  Mappings are mutable objects.  There is currently
only one standard mapping type, the `dictionary'.  (For other containers
see the built-in *note list: 260, *note set: b62, and *note tuple: 473.
classes, and the *note collections: 1e. module.)

A dictionary’s keys are `almost' arbitrary values.  Values that are not
*note hashable: 1364, that is, values containing lists, dictionaries or
other mutable types (that are compared by value rather than by object
identity) may not be used as keys.  Numeric types used for keys obey the
normal rules for numeric comparison: if two numbers compare equal (such
as ‘1’ and ‘1.0’) then they can be used interchangeably to index the
same dictionary entry.  (Note however, that since computers store
floating-point numbers as approximations it is usually unwise to use
them as dictionary keys.)

Dictionaries can be created by placing a comma-separated list of ‘key:
value’ pairs within braces, for example: ‘{'jack': 4098, 'sjoerd':
4127}’ or ‘{4098: 'jack', 4127: 'sjoerd'}’, or by the *note dict: 1b6.
constructor.

 -- Class: dict (**kwarg)

 -- Class: dict (mapping, **kwarg)

 -- Class: dict (iterable, **kwarg)

     Return a new dictionary initialized from an optional positional
     argument and a possibly empty set of keyword arguments.

     If no positional argument is given, an empty dictionary is created.
     If a positional argument is given and it is a mapping object, a
     dictionary is created with the same key-value pairs as the mapping
     object.  Otherwise, the positional argument must be an *note
     iterable: b9f. object.  Each item in the iterable must itself be an
     iterable with exactly two objects.  The first object of each item
     becomes a key in the new dictionary, and the second object the
     corresponding value.  If a key occurs more than once, the last
     value for that key becomes the corresponding value in the new
     dictionary.

     If keyword arguments are given, the keyword arguments and their
     values are added to the dictionary created from the positional
     argument.  If a key being added is already present, the value from
     the keyword argument replaces the value from the positional
     argument.

     To illustrate, the following examples all return a dictionary equal
     to ‘{"one": 1, "two": 2, "three": 3}’:

          >>> a = dict(one=1, two=2, three=3)
          >>> b = {'one': 1, 'two': 2, 'three': 3}
          >>> c = dict(zip(['one', 'two', 'three'], [1, 2, 3]))
          >>> d = dict([('two', 2), ('one', 1), ('three', 3)])
          >>> e = dict({'three': 3, 'one': 1, 'two': 2})
          >>> a == b == c == d == e
          True

     Providing keyword arguments as in the first example only works for
     keys that are valid Python identifiers.  Otherwise, any valid keys
     can be used.

     These are the operations that dictionaries support (and therefore,
     custom mapping types should support too):

      -- Describe: list(d)

          Return a list of all the keys used in the dictionary `d'.

      -- Describe: len(d)

          Return the number of items in the dictionary `d'.

      -- Describe: d[key]

          Return the item of `d' with key `key'.  Raises a *note
          KeyError: 2c5. if `key' is not in the map.

          If a subclass of dict defines a method *note __missing__():
          b2e. and `key' is not present, the ‘d[key]’ operation calls
          that method with the key `key' as argument.  The ‘d[key]’
          operation then returns or raises whatever is returned or
          raised by the ‘__missing__(key)’ call.  No other operations or
          methods invoke *note __missing__(): b2e.  If *note
          __missing__(): b2e. is not defined, *note KeyError: 2c5. is
          raised.  *note __missing__(): b2e. must be a method; it cannot
          be an instance variable:

               >>> class Counter(dict):
               ...     def __missing__(self, key):
               ...         return 0
               >>> c = Counter()
               >>> c['red']
               0
               >>> c['red'] += 1
               >>> c['red']
               1

          The example above shows part of the implementation of *note
          collections.Counter: 9ce.  A different ‘__missing__’ method is
          used by *note collections.defaultdict: b2d.

      -- Describe: d[key] = value

          Set ‘d[key]’ to `value'.

      -- Describe: del d[key]

          Remove ‘d[key]’ from `d'.  Raises a *note KeyError: 2c5. if
          `key' is not in the map.

      -- Describe: key in d

          Return ‘True’ if `d' has a key `key', else ‘False’.

      -- Describe: key not in d

          Equivalent to ‘not key in d’.

      -- Describe: iter(d)

          Return an iterator over the keys of the dictionary.  This is a
          shortcut for ‘iter(d.keys())’.

      -- Method: clear ()

          Remove all items from the dictionary.

      -- Method: copy ()

          Return a shallow copy of the dictionary.

      -- Class Method: fromkeys (iterable[, value])

          Create a new dictionary with keys from `iterable' and values
          set to `value'.

          *note fromkeys(): 1610. is a class method that returns a new
          dictionary.  `value' defaults to ‘None’.  All of the values
          refer to just a single instance, so it generally doesn’t make
          sense for `value' to be a mutable object such as an empty
          list.  To get distinct values, use a *note dict comprehension:
          642. instead.

      -- Method: get (key[, default])

          Return the value for `key' if `key' is in the dictionary, else
          `default'.  If `default' is not given, it defaults to ‘None’,
          so that this method never raises a *note KeyError: 2c5.

      -- Method: items ()

          Return a new view of the dictionary’s items (‘(key, value)’
          pairs).  See the *note documentation of view objects: 1612.

      -- Method: keys ()

          Return a new view of the dictionary’s keys.  See the *note
          documentation of view objects: 1612.

      -- Method: pop (key[, default])

          If `key' is in the dictionary, remove it and return its value,
          else return `default'.  If `default' is not given and `key' is
          not in the dictionary, a *note KeyError: 2c5. is raised.

      -- Method: popitem ()

          Remove and return a ‘(key, value)’ pair from the dictionary.
          Pairs are returned in LIFO (last-in, first-out) order.

          *note popitem(): 1614. is useful to destructively iterate over
          a dictionary, as often used in set algorithms.  If the
          dictionary is empty, calling *note popitem(): 1614. raises a
          *note KeyError: 2c5.

          Changed in version 3.7: LIFO order is now guaranteed.  In
          prior versions, *note popitem(): 1614. would return an
          arbitrary key/value pair.

      -- Describe: reversed(d)

          Return a reverse iterator over the keys of the dictionary.
          This is a shortcut for ‘reversed(d.keys())’.

      -- Method: setdefault (key[, default])

          If `key' is in the dictionary, return its value.  If not,
          insert `key' with a value of `default' and return `default'.
          `default' defaults to ‘None’.

      -- Method: update ([other])

          Update the dictionary with the key/value pairs from `other',
          overwriting existing keys.  Return ‘None’.

          *note update(): dbc. accepts either another dictionary object
          or an iterable of key/value pairs (as tuples or other
          iterables of length two).  If keyword arguments are specified,
          the dictionary is then updated with those key/value pairs:
          ‘d.update(red=1, blue=2)’.

      -- Method: values ()

          Return a new view of the dictionary’s values.  See the *note
          documentation of view objects: 1612.

          An equality comparison between one ‘dict.values()’ view and
          another will always return ‘False’.  This also applies when
          comparing ‘dict.values()’ to itself:

               >>> d = {'a': 1}
               >>> d.values() == d.values()
               False

     Dictionaries compare equal if and only if they have the same ‘(key,
     value)’ pairs (regardless of ordering).  Order comparisons (‘<’,
     ‘<=’, ‘>=’, ‘>’) raise *note TypeError: 192.

     Dictionaries preserve insertion order.  Note that updating a key
     does not affect the order.  Keys added after deletion are inserted
     at the end.

          >>> d = {"one": 1, "two": 2, "three": 3, "four": 4}
          >>> d
          {'one': 1, 'two': 2, 'three': 3, 'four': 4}
          >>> list(d)
          ['one', 'two', 'three', 'four']
          >>> list(d.values())
          [1, 2, 3, 4]
          >>> d["one"] = 42
          >>> d
          {'one': 42, 'two': 2, 'three': 3, 'four': 4}
          >>> del d["two"]
          >>> d["two"] = None
          >>> d
          {'one': 42, 'three': 3, 'four': 4, 'two': None}

     Changed in version 3.7: Dictionary order is guaranteed to be
     insertion order.  This behavior was an implementation detail of
     CPython from 3.6.

     Dictionaries and dictionary views are reversible.

          >>> d = {"one": 1, "two": 2, "three": 3, "four": 4}
          >>> d
          {'one': 1, 'two': 2, 'three': 3, 'four': 4}
          >>> list(reversed(d))
          ['four', 'three', 'two', 'one']
          >>> list(reversed(d.values()))
          [4, 3, 2, 1]
          >>> list(reversed(d.items()))
          [('four', 4), ('three', 3), ('two', 2), ('one', 1)]

     Changed in version 3.8: Dictionaries are now reversible.

See also
........

*note types.MappingProxyType: aab. can be used to create a read-only
view of a *note dict: 1b6.

* Menu:

* Dictionary view objects::


File: python.info,  Node: Dictionary view objects,  Up: Mapping Types — dict

5.4.10.1 Dictionary view objects
................................

The objects returned by *note dict.keys(): c1d, *note dict.values():
c1f. and *note dict.items(): c1e. are `view objects'.  They provide a
dynamic view on the dictionary’s entries, which means that when the
dictionary changes, the view reflects these changes.

Dictionary views can be iterated over to yield their respective data,
and support membership tests:

 -- Describe: len(dictview)

     Return the number of entries in the dictionary.

 -- Describe: iter(dictview)

     Return an iterator over the keys, values or items (represented as
     tuples of ‘(key, value)’) in the dictionary.

     Keys and values are iterated over in insertion order.  This allows
     the creation of ‘(value, key)’ pairs using *note zip(): c25.:
     ‘pairs = zip(d.values(), d.keys())’.  Another way to create the
     same list is ‘pairs = [(v, k) for (k, v) in d.items()]’.

     Iterating views while adding or deleting entries in the dictionary
     may raise a *note RuntimeError: 2b8. or fail to iterate over all
     entries.

     Changed in version 3.7: Dictionary order is guaranteed to be
     insertion order.

 -- Describe: x in dictview

     Return ‘True’ if `x' is in the underlying dictionary’s keys, values
     or items (in the latter case, `x' should be a ‘(key, value)’
     tuple).

 -- Describe: reversed(dictview)

     Return a reverse iterator over the keys, values or items of the
     dictionary.  The view will be iterated in reverse order of the
     insertion.

     Changed in version 3.8: Dictionary views are now reversible.

Keys views are set-like since their entries are unique and hashable.  If
all values are hashable, so that ‘(key, value)’ pairs are unique and
hashable, then the items view is also set-like.  (Values views are not
treated as set-like since the entries are generally not unique.)  For
set-like views, all of the operations defined for the abstract base
class *note collections.abc.Set: 1616. are available (for example, ‘==’,
‘<’, or ‘^’).

An example of dictionary view usage:

     >>> dishes = {'eggs': 2, 'sausage': 1, 'bacon': 1, 'spam': 500}
     >>> keys = dishes.keys()
     >>> values = dishes.values()

     >>> # iteration
     >>> n = 0
     >>> for val in values:
     ...     n += val
     >>> print(n)
     504

     >>> # keys and values are iterated over in the same order (insertion order)
     >>> list(keys)
     ['eggs', 'sausage', 'bacon', 'spam']
     >>> list(values)
     [2, 1, 1, 500]

     >>> # view objects are dynamic and reflect dict changes
     >>> del dishes['eggs']
     >>> del dishes['sausage']
     >>> list(keys)
     ['bacon', 'spam']

     >>> # set operations
     >>> keys & {'eggs', 'bacon', 'salad'}
     {'bacon'}
     >>> keys ^ {'sausage', 'juice'}
     {'juice', 'sausage', 'bacon', 'spam'}


File: python.info,  Node: Context Manager Types,  Next: Other Built-in Types,  Prev: Mapping Types — dict,  Up: Built-in Types

5.4.11 Context Manager Types
----------------------------

Python’s *note with: 6dd. statement supports the concept of a runtime
context defined by a context manager.  This is implemented using a pair
of methods that allow user-defined classes to define a runtime context
that is entered before the statement body is executed and exited when
the statement ends:

 -- Method: contextmanager.__enter__ ()

     Enter the runtime context and return either this object or another
     object related to the runtime context.  The value returned by this
     method is bound to the identifier in the ‘as’ clause of *note with:
     6dd. statements using this context manager.

     An example of a context manager that returns itself is a *note file
     object: b35.  File objects return themselves from __enter__() to
     allow *note open(): 4e5. to be used as the context expression in a
     *note with: 6dd. statement.

     An example of a context manager that returns a related object is
     the one returned by *note decimal.localcontext(): 1619.  These
     managers set the active decimal context to a copy of the original
     decimal context and then return the copy.  This allows changes to
     be made to the current decimal context in the body of the *note
     with: 6dd. statement without affecting code outside the ‘with’
     statement.

 -- Method: contextmanager.__exit__ (exc_type, exc_val, exc_tb)

     Exit the runtime context and return a Boolean flag indicating if
     any exception that occurred should be suppressed.  If an exception
     occurred while executing the body of the *note with: 6dd.
     statement, the arguments contain the exception type, value and
     traceback information.  Otherwise, all three arguments are ‘None’.

     Returning a true value from this method will cause the *note with:
     6dd. statement to suppress the exception and continue execution
     with the statement immediately following the ‘with’ statement.
     Otherwise the exception continues propagating after this method has
     finished executing.  Exceptions that occur during execution of this
     method will replace any exception that occurred in the body of the
     ‘with’ statement.

     The exception passed in should never be reraised explicitly -
     instead, this method should return a false value to indicate that
     the method completed successfully and does not want to suppress the
     raised exception.  This allows context management code to easily
     detect whether or not an *note __exit__(): 161a. method has
     actually failed.

Python defines several context managers to support easy thread
synchronisation, prompt closure of files or other objects, and simpler
manipulation of the active decimal arithmetic context.  The specific
types are not treated specially beyond their implementation of the
context management protocol.  See the *note contextlib: 24. module for
some examples.

Python’s *note generator: 996.s and the *note contextlib.contextmanager:
b71. decorator provide a convenient way to implement these protocols.
If a generator function is decorated with the *note
contextlib.contextmanager: b71. decorator, it will return a context
manager implementing the necessary *note __enter__(): c88. and *note
__exit__(): c89. methods, rather than the iterator produced by an
undecorated generator function.

Note that there is no specific slot for any of these methods in the type
structure for Python objects in the Python/C API. Extension types
wanting to define these methods must provide them as a normal Python
accessible method.  Compared to the overhead of setting up the runtime
context, the overhead of a single class dictionary lookup is negligible.


File: python.info,  Node: Other Built-in Types,  Next: Special Attributes,  Prev: Context Manager Types,  Up: Built-in Types

5.4.12 Other Built-in Types
---------------------------

The interpreter supports several other kinds of objects.  Most of these
support only one or two operations.

* Menu:

* Modules: Modules<2>.
* Classes and Class Instances::
* Functions::
* Methods::
* Code Objects::
* Type Objects::
* The Null Object::
* The Ellipsis Object::
* The NotImplemented Object::
* Boolean Values::
* Internal Objects::


File: python.info,  Node: Modules<2>,  Next: Classes and Class Instances,  Up: Other Built-in Types

5.4.12.1 Modules
................

The only special operation on a module is attribute access: ‘m.name’,
where `m' is a module and `name' accesses a name defined in `m'’s symbol
table.  Module attributes can be assigned to.  (Note that the *note
import: c10. statement is not, strictly speaking, an operation on a
module object; ‘import foo’ does not require a module object named `foo'
to exist, rather it requires an (external) `definition' for a module
named `foo' somewhere.)

A special attribute of every module is *note __dict__: 4f1.  This is the
dictionary containing the module’s symbol table.  Modifying this
dictionary will actually change the module’s symbol table, but direct
assignment to the *note __dict__: 4f1. attribute is not possible (you
can write ‘m.__dict__['a'] = 1’, which defines ‘m.a’ to be ‘1’, but you
can’t write ‘m.__dict__ = {}’).  Modifying *note __dict__: 4f1. directly
is not recommended.

Modules built into the interpreter are written like this: ‘<module 'sys'
(built-in)>’.  If loaded from a file, they are written as ‘<module 'os'
from '/usr/local/lib/pythonX.Y/os.pyc'>’.


File: python.info,  Node: Classes and Class Instances,  Next: Functions,  Prev: Modules<2>,  Up: Other Built-in Types

5.4.12.2 Classes and Class Instances
....................................

See *note Objects, values and types: 1358. and *note Class definitions:
c5d. for these.


File: python.info,  Node: Functions,  Next: Methods,  Prev: Classes and Class Instances,  Up: Other Built-in Types

5.4.12.3 Functions
..................

Function objects are created by function definitions.  The only
operation on a function object is to call it: ‘func(argument-list)’.

There are really two flavors of function objects: built-in functions and
user-defined functions.  Both support the same operation (to call the
function), but the implementation is different, hence the different
object types.

See *note Function definitions: 1196. for more information.


File: python.info,  Node: Methods,  Next: Code Objects,  Prev: Functions,  Up: Other Built-in Types

5.4.12.4 Methods
................

Methods are functions that are called using the attribute notation.
There are two flavors: built-in methods (such as ‘append()’ on lists)
and class instance methods.  Built-in methods are described with the
types that support them.

If you access a method (a function defined in a class namespace) through
an instance, you get a special object: a `bound method' (also called
`instance method') object.  When called, it will add the ‘self’ argument
to the argument list.  Bound methods have two special read-only
attributes: ‘m.__self__’ is the object on which the method operates, and
‘m.__func__’ is the function implementing the method.  Calling ‘m(arg-1,
arg-2, ..., arg-n)’ is completely equivalent to calling
‘m.__func__(m.__self__, arg-1, arg-2, ..., arg-n)’.

Like function objects, bound method objects support getting arbitrary
attributes.  However, since method attributes are actually stored on the
underlying function object (‘meth.__func__’), setting method attributes
on bound methods is disallowed.  Attempting to set an attribute on a
method results in an *note AttributeError: 390. being raised.  In order
to set a method attribute, you need to explicitly set it on the
underlying function object:

     >>> class C:
     ...     def method(self):
     ...         pass
     ...
     >>> c = C()
     >>> c.method.whoami = 'my name is method'  # can't set on the method
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     AttributeError: 'method' object has no attribute 'whoami'
     >>> c.method.__func__.whoami = 'my name is method'
     >>> c.method.whoami
     'my name is method'

See *note The standard type hierarchy: 135c. for more information.


File: python.info,  Node: Code Objects,  Next: Type Objects,  Prev: Methods,  Up: Other Built-in Types

5.4.12.5 Code Objects
.....................

Code objects are used by the implementation to represent
“pseudo-compiled” executable Python code such as a function body.  They
differ from function objects because they don’t contain a reference to
their global execution environment.  Code objects are returned by the
built-in *note compile(): 1b2. function and can be extracted from
function objects through their ‘__code__’ attribute.  See also the *note
code: 1b. module.

A code object can be executed or evaluated by passing it (instead of a
source string) to the *note exec(): c37. or *note eval(): b83. built-in
functions.

See *note The standard type hierarchy: 135c. for more information.


File: python.info,  Node: Type Objects,  Next: The Null Object,  Prev: Code Objects,  Up: Other Built-in Types

5.4.12.6 Type Objects
.....................

Type objects represent the various object types.  An object’s type is
accessed by the built-in function *note type(): 5fd.  There are no
special operations on types.  The standard module *note types: 118.
defines names for all standard built-in types.

Types are written like this: ‘<class 'int'>’.


File: python.info,  Node: The Null Object,  Next: The Ellipsis Object,  Prev: Type Objects,  Up: Other Built-in Types

5.4.12.7 The Null Object
........................

This object is returned by functions that don’t explicitly return a
value.  It supports no special operations.  There is exactly one null
object, named ‘None’ (a built-in name).  ‘type(None)()’ produces the
same singleton.

It is written as ‘None’.


File: python.info,  Node: The Ellipsis Object,  Next: The NotImplemented Object,  Prev: The Null Object,  Up: Other Built-in Types

5.4.12.8 The Ellipsis Object
............................

This object is commonly used by slicing (see *note Slicings: 1458.).  It
supports no special operations.  There is exactly one ellipsis object,
named *note Ellipsis: 1547. (a built-in name).  ‘type(Ellipsis)()’
produces the *note Ellipsis: 1547. singleton.

It is written as ‘Ellipsis’ or ‘...’.


File: python.info,  Node: The NotImplemented Object,  Next: Boolean Values,  Prev: The Ellipsis Object,  Up: Other Built-in Types

5.4.12.9 The NotImplemented Object
..................................

This object is returned from comparisons and binary operations when they
are asked to operate on types they don’t support.  See *note
Comparisons: 147f. for more information.  There is exactly one
‘NotImplemented’ object.  ‘type(NotImplemented)()’ produces the
singleton instance.

It is written as ‘NotImplemented’.


File: python.info,  Node: Boolean Values,  Next: Internal Objects,  Prev: The NotImplemented Object,  Up: Other Built-in Types

5.4.12.10 Boolean Values
........................

Boolean values are the two constant objects ‘False’ and ‘True’.  They
are used to represent truth values (although other values can also be
considered false or true).  In numeric contexts (for example when used
as the argument to an arithmetic operator), they behave like the
integers 0 and 1, respectively.  The built-in function *note bool():
183. can be used to convert any value to a Boolean, if the value can be
interpreted as a truth value (see section *note Truth Value Testing:
151f. above).

They are written as ‘False’ and ‘True’, respectively.


File: python.info,  Node: Internal Objects,  Prev: Boolean Values,  Up: Other Built-in Types

5.4.12.11 Internal Objects
..........................

See *note The standard type hierarchy: 135c. for this information.  It
describes stack frame objects, traceback objects, and slice objects.


File: python.info,  Node: Special Attributes,  Prev: Other Built-in Types,  Up: Built-in Types

5.4.13 Special Attributes
-------------------------

The implementation adds a few special read-only attributes to several
object types, where they are relevant.  Some of these are not reported
by the *note dir(): d26. built-in function.

 -- Attribute: object.__dict__

     A dictionary or other mapping object used to store an object’s
     (writable) attributes.

 -- Attribute: instance.__class__

     The class to which a class instance belongs.

 -- Attribute: class.__bases__

     The tuple of base classes of a class object.

 -- Attribute: definition.__name__

     The name of the class, function, method, descriptor, or generator
     instance.

 -- Attribute: definition.__qualname__

     The *note qualified name: 1366. of the class, function, method,
     descriptor, or generator instance.

     New in version 3.3.

 -- Attribute: class.__mro__

     This attribute is a tuple of classes that are considered when
     looking for base classes during method resolution.

 -- Method: class.mro ()

     This method can be overridden by a metaclass to customize the
     method resolution order for its instances.  It is called at class
     instantiation, and its result is stored in *note __mro__: 1540.

 -- Method: class.__subclasses__ ()

     Each class keeps a list of weak references to its immediate
     subclasses.  This method returns a list of all those references
     still alive.  Example:

          >>> int.__subclasses__()
          [<class 'bool'>]


File: python.info,  Node: Built-in Exceptions,  Next: Text Processing Services,  Prev: Built-in Types,  Up: The Python Standard Library

5.5 Built-in Exceptions
=======================

In Python, all exceptions must be instances of a class that derives from
*note BaseException: 1a7.  In a *note try: d65. statement with an *note
except: b31. clause that mentions a particular class, that clause also
handles any exception classes derived from that class (but not exception
classes from which `it' is derived).  Two exception classes that are not
related via subclassing are never equivalent, even if they have the same
name.

The built-in exceptions listed below can be generated by the interpreter
or built-in functions.  Except where mentioned, they have an “associated
value” indicating the detailed cause of the error.  This may be a string
or a tuple of several items of information (e.g., an error code and a
string explaining the code).  The associated value is usually passed as
arguments to the exception class’s constructor.

User code can raise built-in exceptions.  This can be used to test an
exception handler or to report an error condition “just like” the
situation in which the interpreter raises the same exception; but beware
that there is nothing to prevent user code from raising an inappropriate
error.

The built-in exception classes can be subclassed to define new
exceptions; programmers are encouraged to derive new exceptions from the
*note Exception: 1a8. class or one of its subclasses, and not from *note
BaseException: 1a7.  More information on defining exceptions is
available in the Python Tutorial under *note User-defined Exceptions:
11eb.

When raising (or re-raising) an exception in an *note except: b31. or
*note finally: 182. clause ‘__context__’ is automatically set to the
last exception caught; if the new exception is not handled the traceback
that is eventually displayed will include the originating exception(s)
and the final exception.

When raising a new exception (rather than using a bare ‘raise’ to
re-raise the exception currently being handled), the implicit exception
context can be supplemented with an explicit cause by using *note from:
c38. with *note raise: c35.:

     raise new_exc from original_exc

The expression following *note from: c38. must be an exception or
‘None’.  It will be set as ‘__cause__’ on the raised exception.  Setting
‘__cause__’ also implicitly sets the ‘__suppress_context__’ attribute to
‘True’, so that using ‘raise new_exc from None’ effectively replaces the
old exception with the new one for display purposes (e.g.  converting
*note KeyError: 2c5. to *note AttributeError: 390.), while leaving the
old exception available in ‘__context__’ for introspection when
debugging.

The default traceback display code shows these chained exceptions in
addition to the traceback for the exception itself.  An explicitly
chained exception in ‘__cause__’ is always shown when present.  An
implicitly chained exception in ‘__context__’ is shown only if
‘__cause__’ is *note None: 157. and ‘__suppress_context__’ is false.

In either case, the exception itself is always shown after any chained
exceptions so that the final line of the traceback always shows the last
exception that was raised.

* Menu:

* Base classes::
* Concrete exceptions::
* Warnings::
* Exception hierarchy::


File: python.info,  Node: Base classes,  Next: Concrete exceptions,  Up: Built-in Exceptions

5.5.1 Base classes
------------------

The following exceptions are used mostly as base classes for other
exceptions.

 -- Exception: BaseException

     The base class for all built-in exceptions.  It is not meant to be
     directly inherited by user-defined classes (for that, use *note
     Exception: 1a8.).  If *note str(): 325. is called on an instance of
     this class, the representation of the argument(s) to the instance
     are returned, or the empty string when there were no arguments.

      -- Attribute: args

          The tuple of arguments given to the exception constructor.
          Some built-in exceptions (like *note OSError: 1d1.) expect a
          certain number of arguments and assign a special meaning to
          the elements of this tuple, while others are usually called
          only with a single string giving an error message.

      -- Method: with_traceback (tb)

          This method sets `tb' as the new traceback for the exception
          and returns the exception object.  It is usually used in
          exception handling code like this:

               try:
                   ...
               except SomeException:
                   tb = sys.exc_info()[2]
                   raise OtherException(...).with_traceback(tb)

 -- Exception: Exception

     All built-in, non-system-exiting exceptions are derived from this
     class.  All user-defined exceptions should also be derived from
     this class.

 -- Exception: ArithmeticError

     The base class for those built-in exceptions that are raised for
     various arithmetic errors: *note OverflowError: 954, *note
     ZeroDivisionError: 11e6, *note FloatingPointError: 163b.

 -- Exception: BufferError

     Raised when a *note buffer: 1579. related operation cannot be
     performed.

 -- Exception: LookupError

     The base class for the exceptions that are raised when a key or
     index used on a mapping or sequence is invalid: *note IndexError:
     e69, *note KeyError: 2c5.  This can be raised directly by *note
     codecs.lookup(): 163d.


File: python.info,  Node: Concrete exceptions,  Next: Warnings,  Prev: Base classes,  Up: Built-in Exceptions

5.5.2 Concrete exceptions
-------------------------

The following exceptions are the exceptions that are usually raised.

 -- Exception: AssertionError

     Raised when an *note assert: df9. statement fails.

 -- Exception: AttributeError

     Raised when an attribute reference (see *note Attribute references:
     1451.) or assignment fails.  (When an object does not support
     attribute references or attribute assignments at all, *note
     TypeError: 192. is raised.)

 -- Exception: EOFError

     Raised when the *note input(): c5e. function hits an end-of-file
     condition (EOF) without reading any data.  (N.B.: the
     ‘io.IOBase.read()’ and *note io.IOBase.readline(): 163f. methods
     return an empty string when they hit EOF.)

 -- Exception: FloatingPointError

     Not currently used.

 -- Exception: GeneratorExit

     Raised when a *note generator: 996. or *note coroutine: 1a5. is
     closed; see *note generator.close(): 13cf. and *note
     coroutine.close(): 13ce.  It directly inherits from *note
     BaseException: 1a7. instead of *note Exception: 1a8. since it is
     technically not an error.

 -- Exception: ImportError

     Raised when the *note import: c10. statement has troubles trying to
     load a module.  Also raised when the “from list” in ‘from ...
     import’ has a name that cannot be found.

     The ‘name’ and ‘path’ attributes can be set using keyword-only
     arguments to the constructor.  When set they represent the name of
     the module that was attempted to be imported and the path to any
     file which triggered the exception, respectively.

     Changed in version 3.3: Added the ‘name’ and ‘path’ attributes.

 -- Exception: ModuleNotFoundError

     A subclass of *note ImportError: 329. which is raised by *note
     import: c10. when a module could not be located.  It is also raised
     when ‘None’ is found in *note sys.modules: 13eb.

     New in version 3.6.

 -- Exception: IndexError

     Raised when a sequence subscript is out of range.  (Slice indices
     are silently truncated to fall in the allowed range; if an index is
     not an integer, *note TypeError: 192. is raised.)

 -- Exception: KeyError

     Raised when a mapping (dictionary) key is not found in the set of
     existing keys.

 -- Exception: KeyboardInterrupt

     Raised when the user hits the interrupt key (normally ‘Control-C’
     or ‘Delete’).  During execution, a check for interrupts is made
     regularly.  The exception inherits from *note BaseException: 1a7.
     so as to not be accidentally caught by code that catches *note
     Exception: 1a8. and thus prevent the interpreter from exiting.

 -- Exception: MemoryError

     Raised when an operation runs out of memory but the situation may
     still be rescued (by deleting some objects).  The associated value
     is a string indicating what kind of (internal) operation ran out of
     memory.  Note that because of the underlying memory management
     architecture (C’s ‘malloc()’ function), the interpreter may not
     always be able to completely recover from this situation; it
     nevertheless raises an exception so that a stack traceback can be
     printed, in case a run-away program was the cause.

 -- Exception: NameError

     Raised when a local or global name is not found.  This applies only
     to unqualified names.  The associated value is an error message
     that includes the name that could not be found.

 -- Exception: NotImplementedError

     This exception is derived from *note RuntimeError: 2b8.  In user
     defined base classes, abstract methods should raise this exception
     when they require derived classes to override the method, or while
     the class is being developed to indicate that the real
     implementation still needs to be added.

          Note: It should not be used to indicate that an operator or
          method is not meant to be supported at all – in that case
          either leave the operator / method undefined or, if a
          subclass, set it to *note None: 157.

          Note: ‘NotImplementedError’ and ‘NotImplemented’ are not
          interchangeable, even though they have similar names and
          purposes.  See *note NotImplemented: 840. for details on when
          to use it.

 -- Exception: OSError ([arg])

 -- Exception: OSError (errno, strerror[, filename[, winerror[,
          filename2]]])

     This exception is raised when a system function returns a
     system-related error, including I/O failures such as “file not
     found” or “disk full” (not for illegal argument types or other
     incidental errors).

     The second form of the constructor sets the corresponding
     attributes, described below.  The attributes default to *note None:
     157. if not specified.  For backwards compatibility, if three
     arguments are passed, the *note args: 1638. attribute contains only
     a 2-tuple of the first two constructor arguments.

     The constructor often actually returns a subclass of *note OSError:
     1d1, as described in *note OS exceptions: 1640. below.  The
     particular subclass depends on the final *note errno: 1641. value.
     This behaviour only occurs when constructing *note OSError: 1d1.
     directly or via an alias, and is not inherited when subclassing.

      -- Attribute: errno

          A numeric error code from the C variable ‘errno’.

      -- Attribute: winerror

          Under Windows, this gives you the native Windows error code.
          The *note errno: 1641. attribute is then an approximate
          translation, in POSIX terms, of that native error code.

          Under Windows, if the `winerror' constructor argument is an
          integer, the *note errno: 1641. attribute is determined from
          the Windows error code, and the `errno' argument is ignored.
          On other platforms, the `winerror' argument is ignored, and
          the *note winerror: 1642. attribute does not exist.

      -- Attribute: strerror

          The corresponding error message, as provided by the operating
          system.  It is formatted by the C functions ‘perror()’ under
          POSIX, and ‘FormatMessage()’ under Windows.

      -- Attribute: filename
      -- Attribute: filename2

          For exceptions that involve a file system path (such as *note
          open(): 4e5. or *note os.unlink(): a31.), *note filename:
          1644. is the file name passed to the function.  For functions
          that involve two file system paths (such as *note os.rename():
          a2d.), *note filename2: 1645. corresponds to the second file
          name passed to the function.

     Changed in version 3.3: *note EnvironmentError: 987, *note IOError:
     986, *note WindowsError: 988, *note socket.error: 989, *note
     select.error: 98a. and ‘mmap.error’ have been merged into *note
     OSError: 1d1, and the constructor may return a subclass.

     Changed in version 3.4: The *note filename: 1644. attribute is now
     the original file name passed to the function, instead of the name
     encoded to or decoded from the filesystem encoding.  Also, the
     `filename2' constructor argument and attribute was added.

 -- Exception: OverflowError

     Raised when the result of an arithmetic operation is too large to
     be represented.  This cannot occur for integers (which would rather
     raise *note MemoryError: f42. than give up).  However, for
     historical reasons, OverflowError is sometimes raised for integers
     that are outside a required range.  Because of the lack of
     standardization of floating point exception handling in C, most
     floating point operations are not checked.

 -- Exception: RecursionError

     This exception is derived from *note RuntimeError: 2b8.  It is
     raised when the interpreter detects that the maximum recursion
     depth (see *note sys.getrecursionlimit(): e6e.) is exceeded.

     New in version 3.5: Previously, a plain *note RuntimeError: 2b8.
     was raised.

 -- Exception: ReferenceError

     This exception is raised when a weak reference proxy, created by
     the *note weakref.proxy(): 24e. function, is used to access an
     attribute of the referent after it has been garbage collected.  For
     more information on weak references, see the *note weakref: 128.
     module.

 -- Exception: RuntimeError

     Raised when an error is detected that doesn’t fall in any of the
     other categories.  The associated value is a string indicating what
     precisely went wrong.

 -- Exception: StopIteration

     Raised by built-in function *note next(): 676. and an *note
     iterator: f73.’s *note __next__(): c57. method to signal that there
     are no further items produced by the iterator.

     The exception object has a single attribute ‘value’, which is given
     as an argument when constructing the exception, and defaults to
     *note None: 157.

     When a *note generator: 996. or *note coroutine: 1a5. function
     returns, a new *note StopIteration: 47b. instance is raised, and
     the value returned by the function is used as the ‘value’ parameter
     to the constructor of the exception.

     If a generator code directly or indirectly raises *note
     StopIteration: 47b, it is converted into a *note RuntimeError: 2b8.
     (retaining the *note StopIteration: 47b. as the new exception’s
     cause).

     Changed in version 3.3: Added ‘value’ attribute and the ability for
     generator functions to use it to return a value.

     Changed in version 3.5: Introduced the RuntimeError transformation
     via ‘from __future__ import generator_stop’, see PEP 479(1).

     Changed in version 3.7: Enable PEP 479(2) for all code by default:
     a *note StopIteration: 47b. error raised in a generator is
     transformed into a *note RuntimeError: 2b8.

 -- Exception: StopAsyncIteration

     Must be raised by *note __anext__(): 13d1. method of an *note
     asynchronous iterator: 639. object to stop the iteration.

     New in version 3.5.

 -- Exception: SyntaxError

     Raised when the parser encounters a syntax error.  This may occur
     in an *note import: c10. statement, in a call to the built-in
     functions *note exec(): c37. or *note eval(): b83, or when reading
     the initial script or standard input (also interactively).

     Instances of this class have attributes ‘filename’, ‘lineno’,
     ‘offset’ and ‘text’ for easier access to the details.  *note str():
     325. of the exception instance returns only the message.

 -- Exception: IndentationError

     Base class for syntax errors related to incorrect indentation.
     This is a subclass of *note SyntaxError: 44d.

 -- Exception: TabError

     Raised when indentation contains an inconsistent use of tabs and
     spaces.  This is a subclass of *note IndentationError: e6c.

 -- Exception: SystemError

     Raised when the interpreter finds an internal error, but the
     situation does not look so serious to cause it to abandon all hope.
     The associated value is a string indicating what went wrong (in
     low-level terms).

     You should report this to the author or maintainer of your Python
     interpreter.  Be sure to report the version of the Python
     interpreter (‘sys.version’; it is also printed at the start of an
     interactive Python session), the exact error message (the
     exception’s associated value) and if possible the source of the
     program that triggered the error.

 -- Exception: SystemExit

     This exception is raised by the *note sys.exit(): cd5. function.
     It inherits from *note BaseException: 1a7. instead of *note
     Exception: 1a8. so that it is not accidentally caught by code that
     catches *note Exception: 1a8.  This allows the exception to
     properly propagate up and cause the interpreter to exit.  When it
     is not handled, the Python interpreter exits; no stack traceback is
     printed.  The constructor accepts the same optional argument passed
     to *note sys.exit(): cd5.  If the value is an integer, it specifies
     the system exit status (passed to C’s ‘exit()’ function); if it is
     ‘None’, the exit status is zero; if it has another type (such as a
     string), the object’s value is printed and the exit status is one.

     A call to *note sys.exit(): cd5. is translated into an exception so
     that clean-up handlers (*note finally: 182. clauses of *note try:
     d65. statements) can be executed, and so that a debugger can
     execute a script without running the risk of losing control.  The
     *note os._exit(): 1646. function can be used if it is absolutely
     positively necessary to exit immediately (for example, in the child
     process after a call to *note os.fork(): 955.).

      -- Attribute: code

          The exit status or error message that is passed to the
          constructor.  (Defaults to ‘None’.)

 -- Exception: TypeError

     Raised when an operation or function is applied to an object of
     inappropriate type.  The associated value is a string giving
     details about the type mismatch.

     This exception may be raised by user code to indicate that an
     attempted operation on an object is not supported, and is not meant
     to be.  If an object is meant to support a given operation but has
     not yet provided an implementation, *note NotImplementedError: 603.
     is the proper exception to raise.

     Passing arguments of the wrong type (e.g.  passing a *note list:
     260. when an *note int: 184. is expected) should result in a *note
     TypeError: 192, but passing arguments with the wrong value (e.g.  a
     number outside expected boundaries) should result in a *note
     ValueError: 1f9.

 -- Exception: UnboundLocalError

     Raised when a reference is made to a local variable in a function
     or method, but no value has been bound to that variable.  This is a
     subclass of *note NameError: d6e.

 -- Exception: UnicodeError

     Raised when a Unicode-related encoding or decoding error occurs.
     It is a subclass of *note ValueError: 1f9.

     *note UnicodeError: c2e. has attributes that describe the encoding
     or decoding error.  For example, ‘err.object[err.start:err.end]’
     gives the particular invalid input that the codec failed on.

      -- Attribute: encoding

          The name of the encoding that raised the error.

      -- Attribute: reason

          A string describing the specific codec error.

      -- Attribute: object

          The object the codec was attempting to encode or decode.

      -- Attribute: start

          The first index of invalid data in *note object: 2ae.

      -- Attribute: end

          The index after the last invalid data in *note object: 2ae.

 -- Exception: UnicodeEncodeError

     Raised when a Unicode-related error occurs during encoding.  It is
     a subclass of *note UnicodeError: c2e.

 -- Exception: UnicodeDecodeError

     Raised when a Unicode-related error occurs during decoding.  It is
     a subclass of *note UnicodeError: c2e.

 -- Exception: UnicodeTranslateError

     Raised when a Unicode-related error occurs during translating.  It
     is a subclass of *note UnicodeError: c2e.

 -- Exception: ValueError

     Raised when an operation or function receives an argument that has
     the right type but an inappropriate value, and the situation is not
     described by a more precise exception such as *note IndexError:
     e69.

 -- Exception: ZeroDivisionError

     Raised when the second argument of a division or modulo operation
     is zero.  The associated value is a string indicating the type of
     the operands and the operation.

The following exceptions are kept for compatibility with previous
versions; starting from Python 3.3, they are aliases of *note OSError:
1d1.

 -- Exception: EnvironmentError

 -- Exception: IOError

 -- Exception: WindowsError

     Only available on Windows.

* Menu:

* OS exceptions::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0479

   (2) https://www.python.org/dev/peps/pep-0479


File: python.info,  Node: OS exceptions,  Up: Concrete exceptions

5.5.2.1 OS exceptions
.....................

The following exceptions are subclasses of *note OSError: 1d1, they get
raised depending on the system error code.

 -- Exception: BlockingIOError

     Raised when an operation would block on an object (e.g.  socket)
     set for non-blocking operation.  Corresponds to ‘errno’ ‘EAGAIN’,
     ‘EALREADY’, ‘EWOULDBLOCK’ and ‘EINPROGRESS’.

     In addition to those of *note OSError: 1d1, *note BlockingIOError:
     98b. can have one more attribute:

      -- Attribute: characters_written

          An integer containing the number of characters written to the
          stream before it blocked.  This attribute is available when
          using the buffered I/O classes from the *note io: a1. module.

 -- Exception: ChildProcessError

     Raised when an operation on a child process failed.  Corresponds to
     ‘errno’ ‘ECHILD’.

 -- Exception: ConnectionError

     A base class for connection-related issues.

     Subclasses are *note BrokenPipeError: 991, *note
     ConnectionAbortedError: 992, *note ConnectionRefusedError: 993. and
     *note ConnectionResetError: 994.

 -- Exception: BrokenPipeError

     A subclass of *note ConnectionError: 6da, raised when trying to
     write on a pipe while the other end has been closed, or trying to
     write on a socket which has been shutdown for writing.  Corresponds
     to ‘errno’ ‘EPIPE’ and ‘ESHUTDOWN’.

 -- Exception: ConnectionAbortedError

     A subclass of *note ConnectionError: 6da, raised when a connection
     attempt is aborted by the peer.  Corresponds to ‘errno’
     ‘ECONNABORTED’.

 -- Exception: ConnectionRefusedError

     A subclass of *note ConnectionError: 6da, raised when a connection
     attempt is refused by the peer.  Corresponds to ‘errno’
     ‘ECONNREFUSED’.

 -- Exception: ConnectionResetError

     A subclass of *note ConnectionError: 6da, raised when a connection
     is reset by the peer.  Corresponds to ‘errno’ ‘ECONNRESET’.

 -- Exception: FileExistsError

     Raised when trying to create a file or directory which already
     exists.  Corresponds to ‘errno’ ‘EEXIST’.

 -- Exception: FileNotFoundError

     Raised when a file or directory is requested but doesn’t exist.
     Corresponds to ‘errno’ ‘ENOENT’.

 -- Exception: InterruptedError

     Raised when a system call is interrupted by an incoming signal.
     Corresponds to ‘errno’ *note EINTR: 64c.

     Changed in version 3.5: Python now retries system calls when a
     syscall is interrupted by a signal, except if the signal handler
     raises an exception (see PEP 475(1) for the rationale), instead of
     raising *note InterruptedError: 64d.

 -- Exception: IsADirectoryError

     Raised when a file operation (such as *note os.remove(): a2c.) is
     requested on a directory.  Corresponds to ‘errno’ ‘EISDIR’.

 -- Exception: NotADirectoryError

     Raised when a directory operation (such as *note os.listdir():
     a36.) is requested on something which is not a directory.
     Corresponds to ‘errno’ ‘ENOTDIR’.

 -- Exception: PermissionError

     Raised when trying to run an operation without the adequate access
     rights - for example filesystem permissions.  Corresponds to
     ‘errno’ ‘EACCES’ and ‘EPERM’.

 -- Exception: ProcessLookupError

     Raised when a given process doesn’t exist.  Corresponds to ‘errno’
     ‘ESRCH’.

 -- Exception: TimeoutError

     Raised when a system function timed out at the system level.
     Corresponds to ‘errno’ ‘ETIMEDOUT’.

New in version 3.3: All the above *note OSError: 1d1. subclasses were
added.

See also
........

PEP 3151(2) - Reworking the OS and IO exception hierarchy

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475

   (2) https://www.python.org/dev/peps/pep-3151


File: python.info,  Node: Warnings,  Next: Exception hierarchy,  Prev: Concrete exceptions,  Up: Built-in Exceptions

5.5.3 Warnings
--------------

The following exceptions are used as warning categories; see the *note
Warning Categories: 1651. documentation for more details.

 -- Exception: Warning

     Base class for warning categories.

 -- Exception: UserWarning

     Base class for warnings generated by user code.

 -- Exception: DeprecationWarning

     Base class for warnings about deprecated features when those
     warnings are intended for other Python developers.

 -- Exception: PendingDeprecationWarning

     Base class for warnings about features which are obsolete and
     expected to be deprecated in the future, but are not deprecated at
     the moment.

     This class is rarely used as emitting a warning about a possible
     upcoming deprecation is unusual, and *note DeprecationWarning: 276.
     is preferred for already active deprecations.

 -- Exception: SyntaxWarning

     Base class for warnings about dubious syntax.

 -- Exception: RuntimeWarning

     Base class for warnings about dubious runtime behavior.

 -- Exception: FutureWarning

     Base class for warnings about deprecated features when those
     warnings are intended for end users of applications that are
     written in Python.

 -- Exception: ImportWarning

     Base class for warnings about probable mistakes in module imports.

 -- Exception: UnicodeWarning

     Base class for warnings related to Unicode.

 -- Exception: BytesWarning

     Base class for warnings related to *note bytes: 326. and *note
     bytearray: 327.

 -- Exception: ResourceWarning

     Base class for warnings related to resource usage.  Ignored by the
     default warning filters.

     New in version 3.2.


File: python.info,  Node: Exception hierarchy,  Prev: Warnings,  Up: Built-in Exceptions

5.5.4 Exception hierarchy
-------------------------

The class hierarchy for built-in exceptions is:

     BaseException
      +-- SystemExit
      +-- KeyboardInterrupt
      +-- GeneratorExit
      +-- Exception
           +-- StopIteration
           +-- StopAsyncIteration
           +-- ArithmeticError
           |    +-- FloatingPointError
           |    +-- OverflowError
           |    +-- ZeroDivisionError
           +-- AssertionError
           +-- AttributeError
           +-- BufferError
           +-- EOFError
           +-- ImportError
           |    +-- ModuleNotFoundError
           +-- LookupError
           |    +-- IndexError
           |    +-- KeyError
           +-- MemoryError
           +-- NameError
           |    +-- UnboundLocalError
           +-- OSError
           |    +-- BlockingIOError
           |    +-- ChildProcessError
           |    +-- ConnectionError
           |    |    +-- BrokenPipeError
           |    |    +-- ConnectionAbortedError
           |    |    +-- ConnectionRefusedError
           |    |    +-- ConnectionResetError
           |    +-- FileExistsError
           |    +-- FileNotFoundError
           |    +-- InterruptedError
           |    +-- IsADirectoryError
           |    +-- NotADirectoryError
           |    +-- PermissionError
           |    +-- ProcessLookupError
           |    +-- TimeoutError
           +-- ReferenceError
           +-- RuntimeError
           |    +-- NotImplementedError
           |    +-- RecursionError
           +-- SyntaxError
           |    +-- IndentationError
           |         +-- TabError
           +-- SystemError
           +-- TypeError
           +-- ValueError
           |    +-- UnicodeError
           |         +-- UnicodeDecodeError
           |         +-- UnicodeEncodeError
           |         +-- UnicodeTranslateError
           +-- Warning
                +-- DeprecationWarning
                +-- PendingDeprecationWarning
                +-- RuntimeWarning
                +-- SyntaxWarning
                +-- UserWarning
                +-- FutureWarning
                +-- ImportWarning
                +-- UnicodeWarning
                +-- BytesWarning
                +-- ResourceWarning


File: python.info,  Node: Text Processing Services,  Next: Binary Data Services,  Prev: Built-in Exceptions,  Up: The Python Standard Library

5.6 Text Processing Services
============================

The modules described in this chapter provide a wide range of string
manipulation operations and other text processing services.

The *note codecs: 1c. module described under *note Binary Data Services:
1657. is also highly relevant to text processing.  In addition, see the
documentation for Python’s built-in string type in *note Text Sequence
Type — str: 115d.

* Menu:

* string — Common string operations::
* re — Regular expression operations::
* difflib — Helpers for computing deltas::
* textwrap — Text wrapping and filling::
* unicodedata — Unicode Database::
* stringprep — Internet String Preparation::
* readline — GNU readline interface::
* rlcompleter — Completion function for GNU readline::


File: python.info,  Node: string — Common string operations,  Next: re — Regular expression operations,  Up: Text Processing Services

5.6.1 ‘string’ — Common string operations
-----------------------------------------

`Source code:' Lib/string.py(1)

__________________________________________________________________

See also
........

*note Text Sequence Type — str: 115d.

*note String Methods: 115e.

* Menu:

* String constants::
* Custom String Formatting::
* Format String Syntax::
* Template strings::
* Helper functions::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/string.py


File: python.info,  Node: String constants,  Next: Custom String Formatting,  Up: string — Common string operations

5.6.1.1 String constants
........................

The constants defined in this module are:

 -- Data: string.ascii_letters

     The concatenation of the *note ascii_lowercase: 165b. and *note
     ascii_uppercase: 165c. constants described below.  This value is
     not locale-dependent.

 -- Data: string.ascii_lowercase

     The lowercase letters ‘'abcdefghijklmnopqrstuvwxyz'’.  This value
     is not locale-dependent and will not change.

 -- Data: string.ascii_uppercase

     The uppercase letters ‘'ABCDEFGHIJKLMNOPQRSTUVWXYZ'’.  This value
     is not locale-dependent and will not change.

 -- Data: string.digits

     The string ‘'0123456789'’.

 -- Data: string.hexdigits

     The string ‘'0123456789abcdefABCDEF'’.

 -- Data: string.octdigits

     The string ‘'01234567'’.

 -- Data: string.punctuation

     String of ASCII characters which are considered punctuation
     characters in the ‘C’ locale: ‘!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~’.

 -- Data: string.printable

     String of ASCII characters which are considered printable.  This is
     a combination of *note digits: 165d, *note ascii_letters: c4f,
     *note punctuation: 1660, and *note whitespace: 1662.

 -- Data: string.whitespace

     A string containing all ASCII characters that are considered
     whitespace.  This includes the characters space, tab, linefeed,
     return, formfeed, and vertical tab.


File: python.info,  Node: Custom String Formatting,  Next: Format String Syntax,  Prev: String constants,  Up: string — Common string operations

5.6.1.2 Custom String Formatting
................................

The built-in string class provides the ability to do complex variable
substitutions and value formatting via the *note format(): 4cf. method
described in PEP 3101(1).  The *note Formatter: 7a9. class in the *note
string: f6. module allows you to create and customize your own string
formatting behaviors using the same implementation as the built-in *note
format(): 4cf. method.

 -- Class: string.Formatter

     The *note Formatter: 7a9. class has the following public methods:

      -- Method: format (format_string, /, *args, **kwargs)

          The primary API method.  It takes a format string and an
          arbitrary set of positional and keyword arguments.  It is just
          a wrapper that calls *note vformat(): 1664.

          Changed in version 3.7: A format string argument is now *note
          positional-only: 2a5.

      -- Method: vformat (format_string, args, kwargs)

          This function does the actual work of formatting.  It is
          exposed as a separate function for cases where you want to
          pass in a predefined dictionary of arguments, rather than
          unpacking and repacking the dictionary as individual arguments
          using the ‘*args’ and ‘**kwargs’ syntax.  *note vformat():
          1664. does the work of breaking up the format string into
          character data and replacement fields.  It calls the various
          methods described below.

     In addition, the *note Formatter: 7a9. defines a number of methods
     that are intended to be replaced by subclasses:

      -- Method: parse (format_string)

          Loop over the format_string and return an iterable of tuples
          (`literal_text', `field_name', `format_spec', `conversion').
          This is used by *note vformat(): 1664. to break the string
          into either literal text, or replacement fields.

          The values in the tuple conceptually represent a span of
          literal text followed by a single replacement field.  If there
          is no literal text (which can happen if two replacement fields
          occur consecutively), then `literal_text' will be a
          zero-length string.  If there is no replacement field, then
          the values of `field_name', `format_spec' and `conversion'
          will be ‘None’.

      -- Method: get_field (field_name, args, kwargs)

          Given `field_name' as returned by *note parse(): 1665. (see
          above), convert it to an object to be formatted.  Returns a
          tuple (obj, used_key).  The default version takes strings of
          the form defined in PEP 3101(2), such as “0[name]” or
          “label.title”.  `args' and `kwargs' are as passed in to *note
          vformat(): 1664.  The return value `used_key' has the same
          meaning as the `key' parameter to *note get_value(): 1667.

      -- Method: get_value (key, args, kwargs)

          Retrieve a given field value.  The `key' argument will be
          either an integer or a string.  If it is an integer, it
          represents the index of the positional argument in `args'; if
          it is a string, then it represents a named argument in
          `kwargs'.

          The `args' parameter is set to the list of positional
          arguments to *note vformat(): 1664, and the `kwargs' parameter
          is set to the dictionary of keyword arguments.

          For compound field names, these functions are only called for
          the first component of the field name; subsequent components
          are handled through normal attribute and indexing operations.

          So for example, the field expression ‘0.name’ would cause
          *note get_value(): 1667. to be called with a `key' argument of
          0.  The ‘name’ attribute will be looked up after *note
          get_value(): 1667. returns by calling the built-in *note
          getattr(): 43d. function.

          If the index or keyword refers to an item that does not exist,
          then an *note IndexError: e69. or *note KeyError: 2c5. should
          be raised.

      -- Method: check_unused_args (used_args, args, kwargs)

          Implement checking for unused arguments if desired.  The
          arguments to this function is the set of all argument keys
          that were actually referred to in the format string (integers
          for positional arguments, and strings for named arguments),
          and a reference to the `args' and `kwargs' that was passed to
          vformat.  The set of unused args can be calculated from these
          parameters.  *note check_unused_args(): 1668. is assumed to
          raise an exception if the check fails.

      -- Method: format_field (value, format_spec)

          *note format_field(): 1669. simply calls the global *note
          format(): 4d0. built-in.  The method is provided so that
          subclasses can override it.

      -- Method: convert_field (value, conversion)

          Converts the value (returned by *note get_field(): 1666.)
          given a conversion type (as in the tuple returned by the *note
          parse(): 1665. method).  The default version understands ‘s’
          (str), ‘r’ (repr) and ‘a’ (ascii) conversion types.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3101

   (2) https://www.python.org/dev/peps/pep-3101


File: python.info,  Node: Format String Syntax,  Next: Template strings,  Prev: Custom String Formatting,  Up: string — Common string operations

5.6.1.3 Format String Syntax
............................

The *note str.format(): 4cf. method and the *note Formatter: 7a9. class
share the same syntax for format strings (although in the case of *note
Formatter: 7a9, subclasses can define their own format string syntax).
The syntax is related to that of *note formatted string literals: 15c,
but there are differences.

Format strings contain “replacement fields” surrounded by curly braces
‘{}’.  Anything that is not contained in braces is considered literal
text, which is copied unchanged to the output.  If you need to include a
brace character in the literal text, it can be escaped by doubling: ‘{{’
and ‘}}’.

The grammar for a replacement field is as follows:

          replacement_field ::= "{" [field_name] ["!" conversion] [":" format_spec] "}"
          field_name        ::= arg_name ("." attribute_name | "[" element_index "]")*
          arg_name          ::= [identifier | digit+]
          attribute_name    ::= identifier
          element_index     ::= digit+ | index_string
          index_string      ::= <any source character except "]"> +
          conversion        ::= "r" | "s" | "a"
          format_spec       ::= <described in the next section>

In less formal terms, the replacement field can start with a
`field_name' that specifies the object whose value is to be formatted
and inserted into the output instead of the replacement field.  The
`field_name' is optionally followed by a `conversion' field, which is
preceded by an exclamation point ‘'!'’, and a `format_spec', which is
preceded by a colon ‘':'’.  These specify a non-default format for the
replacement value.

See also the *note Format Specification Mini-Language: 4d3. section.

The `field_name' itself begins with an `arg_name' that is either a
number or a keyword.  If it’s a number, it refers to a positional
argument, and if it’s a keyword, it refers to a named keyword argument.
If the numerical arg_names in a format string are 0, 1, 2, … in
sequence, they can all be omitted (not just some) and the numbers 0, 1,
2, … will be automatically inserted in that order.  Because `arg_name'
is not quote-delimited, it is not possible to specify arbitrary
dictionary keys (e.g., the strings ‘'10'’ or ‘':-]'’) within a format
string.  The `arg_name' can be followed by any number of index or
attribute expressions.  An expression of the form ‘'.name'’ selects the
named attribute using *note getattr(): 43d, while an expression of the
form ‘'[index]'’ does an index lookup using *note __getitem__(): 27a.

Changed in version 3.1: The positional argument specifiers can be
omitted for *note str.format(): 4cf, so ‘'{} {}'.format(a, b)’ is
equivalent to ‘'{0} {1}'.format(a, b)’.

Changed in version 3.4: The positional argument specifiers can be
omitted for *note Formatter: 7a9.

Some simple format string examples:

     "First, thou shalt count to {0}"  # References first positional argument
     "Bring me a {}"                   # Implicitly references the first positional argument
     "From {} to {}"                   # Same as "From {0} to {1}"
     "My quest is {name}"              # References keyword argument 'name'
     "Weight in tons {0.weight}"       # 'weight' attribute of first positional arg
     "Units destroyed: {players[0]}"   # First element of keyword argument 'players'.

The `conversion' field causes a type coercion before formatting.
Normally, the job of formatting a value is done by the *note
__format__(): 942. method of the value itself.  However, in some cases
it is desirable to force a type to be formatted as a string, overriding
its own definition of formatting.  By converting the value to a string
before calling *note __format__(): 942, the normal formatting logic is
bypassed.

Three conversion flags are currently supported: ‘'!s'’ which calls *note
str(): 325. on the value, ‘'!r'’ which calls *note repr(): 7c0. and
‘'!a'’ which calls *note ascii(): d3f.

Some examples:

     "Harold's a clever {0!s}"        # Calls str() on the argument first
     "Bring out the holy {name!r}"    # Calls repr() on the argument first
     "More {!a}"                      # Calls ascii() on the argument first

The `format_spec' field contains a specification of how the value should
be presented, including such details as field width, alignment, padding,
decimal precision and so on.  Each value type can define its own
“formatting mini-language” or interpretation of the `format_spec'.

Most built-in types support a common formatting mini-language, which is
described in the next section.

A `format_spec' field can also include nested replacement fields within
it.  These nested replacement fields may contain a field name,
conversion flag and format specification, but deeper nesting is not
allowed.  The replacement fields within the format_spec are substituted
before the `format_spec' string is interpreted.  This allows the
formatting of a value to be dynamically specified.

See the *note Format examples: 1674. section for some examples.

* Menu:

* Format Specification Mini-Language::
* Format examples::


File: python.info,  Node: Format Specification Mini-Language,  Next: Format examples,  Up: Format String Syntax

5.6.1.4 Format Specification Mini-Language
..........................................

“Format specifications” are used within replacement fields contained
within a format string to define how individual values are presented
(see *note Format String Syntax: d0d. and *note Formatted string
literals: 15c.).  They can also be passed directly to the built-in *note
format(): 4d0. function.  Each formattable type may define how the
format specification is to be interpreted.

Most built-in types implement the following options for format
specifications, although some of the formatting options are only
supported by the numeric types.

A general convention is that an empty format string (‘""’) produces the
same result as if you had called *note str(): 325. on the value.  A
non-empty format string typically modifies the result.

The general form of a `standard format specifier' is:

     format_spec     ::= [[fill]align][sign][#][0][width][grouping_option][.precision][type]
     fill            ::= <any character>
     align           ::= "<" | ">" | "=" | "^"
     sign            ::= "+" | "-" | " "
     width           ::= digit+
     grouping_option ::= "_" | ","
     precision       ::= digit+
     type            ::= "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%"

If a valid `align' value is specified, it can be preceded by a `fill'
character that can be any character and defaults to a space if omitted.
It is not possible to use a literal curly brace (“‘{’” or “‘}’”) as the
`fill' character in a *note formatted string literal: 15c. or when using
the *note str.format(): 4cf. method.  However, it is possible to insert
a curly brace with a nested replacement field.  This limitation doesn’t
affect the *note format(): 4d0. function.

The meaning of the various alignment options is as follows:

     Option        Meaning
                   
     -----------------------------------------------------------------------------
                   
     ‘'<'’         Forces the field to be left-aligned within the available
                   space (this is the default for most objects).
                   
                   
     ‘'>'’         Forces the field to be right-aligned within the available
                   space (this is the default for numbers).
                   
                   
     ‘'='’         Forces the padding to be placed after the sign (if any) but
                   before the digits.  This is used for printing fields in the
                   form ‘+000000120’.  This alignment option is only valid for
                   numeric types.  It becomes the default when ‘0’ immediately
                   precedes the field width.
                   
                   
     ‘'^'’         Forces the field to be centered within the available space.
                   

Note that unless a minimum field width is defined, the field width will
always be the same size as the data to fill it, so that the alignment
option has no meaning in this case.

The `sign' option is only valid for number types, and can be one of the
following:

     Option        Meaning
                   
     -----------------------------------------------------------------------------
                   
     ‘'+'’         indicates that a sign should be used for both positive as
                   well as negative numbers.
                   
                   
     ‘'-'’         indicates that a sign should be used only for negative
                   numbers (this is the default behavior).
                   
                   
     space         indicates that a leading space should be used on positive
                   numbers, and a minus sign on negative numbers.
                   

The ‘'#'’ option causes the “alternate form” to be used for the
conversion.  The alternate form is defined differently for different
types.  This option is only valid for integer, float, complex and
Decimal types.  For integers, when binary, octal, or hexadecimal output
is used, this option adds the prefix respective ‘'0b'’, ‘'0o'’, or
‘'0x'’ to the output value.  For floats, complex and Decimal the
alternate form causes the result of the conversion to always contain a
decimal-point character, even if no digits follow it.  Normally, a
decimal-point character appears in the result of these conversions only
if a digit follows it.  In addition, for ‘'g'’ and ‘'G'’ conversions,
trailing zeros are not removed from the result.

The ‘','’ option signals the use of a comma for a thousands separator.
For a locale aware separator, use the ‘'n'’ integer presentation type
instead.

Changed in version 3.1: Added the ‘','’ option (see also PEP 378(1)).

The ‘'_'’ option signals the use of an underscore for a thousands
separator for floating point presentation types and for integer
presentation type ‘'d'’.  For integer presentation types ‘'b'’, ‘'o'’,
‘'x'’, and ‘'X'’, underscores will be inserted every 4 digits.  For
other presentation types, specifying this option is an error.

Changed in version 3.6: Added the ‘'_'’ option (see also PEP 515(2)).

`width' is a decimal integer defining the minimum field width.  If not
specified, then the field width will be determined by the content.

When no explicit alignment is given, preceding the `width' field by a
zero (‘'0'’) character enables sign-aware zero-padding for numeric
types.  This is equivalent to a `fill' character of ‘'0'’ with an
`alignment' type of ‘'='’.

The `precision' is a decimal number indicating how many digits should be
displayed after the decimal point for a floating point value formatted
with ‘'f'’ and ‘'F'’, or before and after the decimal point for a
floating point value formatted with ‘'g'’ or ‘'G'’.  For non-number
types the field indicates the maximum field size - in other words, how
many characters will be used from the field content.  The `precision' is
not allowed for integer values.

Finally, the `type' determines how the data should be presented.

The available string presentation types are:

     Type          Meaning
                   
     -----------------------------------------------------------------------------
                   
     ‘'s'’         String format.  This is the default type for strings and may
                   be omitted.
                   
                   
     None          The same as ‘'s'’.
                   

The available integer presentation types are:

     Type          Meaning
                   
     -----------------------------------------------------------------------------
                   
     ‘'b'’         Binary format.  Outputs the number in base 2.
                   
                   
     ‘'c'’         Character.  Converts the integer to the corresponding
                   unicode character before printing.
                   
                   
     ‘'d'’         Decimal Integer.  Outputs the number in base 10.
                   
                   
     ‘'o'’         Octal format.  Outputs the number in base 8.
                   
                   
     ‘'x'’         Hex format.  Outputs the number in base 16, using lower-case
                   letters for the digits above 9.
                   
                   
     ‘'X'’         Hex format.  Outputs the number in base 16, using upper-case
                   letters for the digits above 9.
                   
                   
     ‘'n'’         Number.  This is the same as ‘'d'’, except that it uses the
                   current locale setting to insert the appropriate number
                   separator characters.
                   
                   
     None          The same as ‘'d'’.
                   

In addition to the above presentation types, integers can be formatted
with the floating point presentation types listed below (except ‘'n'’
and ‘None’).  When doing so, *note float(): 187. is used to convert the
integer to a floating point number before formatting.

The available presentation types for floating point and decimal values
are:

     Type          Meaning
                   
     -----------------------------------------------------------------------------
                   
     ‘'e'’         Exponent notation.  Prints the number in scientific notation
                   using the letter ‘e’ to indicate the exponent.  The default
                   precision is ‘6’.
                   
                   
     ‘'E'’         Exponent notation.  Same as ‘'e'’ except it uses an upper
                   case ‘E’ as the separator character.
                   
                   
     ‘'f'’         Fixed-point notation.  Displays the number as a fixed-point
                   number.  The default precision is ‘6’.
                   
                   
     ‘'F'’         Fixed-point notation.  Same as ‘'f'’, but converts ‘nan’ to
                   ‘NAN’ and ‘inf’ to ‘INF’.
                   
                   
     ‘'g'’         General format.  For a given precision ‘p >= 1’, this rounds
                   the number to ‘p’ significant digits and then formats the
                   result in either fixed-point format or in scientific
                   notation, depending on its magnitude.
                   
                   The precise rules are as follows: suppose that the result
                   formatted with presentation type ‘'e'’ and precision ‘p-1’
                   would have exponent ‘exp’.  Then, if ‘m <= exp < p’, where
                   ‘m’ is -4 for floats and -6 for *note Decimals: 188, the
                   number is formatted with presentation type ‘'f'’ and
                   precision ‘p-1-exp’.  Otherwise, the number is formatted
                   with presentation type ‘'e'’ and precision ‘p-1’.  In both
                   cases insignificant trailing zeros are removed from the
                   significand, and the decimal point is also removed if there
                   are no remaining digits following it, unless the ‘'#'’
                   option is used.
                   
                   Positive and negative infinity, positive and negative zero,
                   and nans, are formatted as ‘inf’, ‘-inf’, ‘0’, ‘-0’ and
                   ‘nan’ respectively, regardless of the precision.
                   
                   A precision of ‘0’ is treated as equivalent to a precision
                   of ‘1’.  The default precision is ‘6’.
                   
                   
     ‘'G'’         General format.  Same as ‘'g'’ except switches to ‘'E'’ if
                   the number gets too large.  The representations of infinity
                   and NaN are uppercased, too.
                   
                   
     ‘'n'’         Number.  This is the same as ‘'g'’, except that it uses the
                   current locale setting to insert the appropriate number
                   separator characters.
                   
                   
     ‘'%'’         Percentage.  Multiplies the number by 100 and displays in
                   fixed (‘'f'’) format, followed by a percent sign.
                   
                   
     None          Similar to ‘'g'’, except that fixed-point notation, when
                   used, has at least one digit past the decimal point.  The
                   default precision is as high as needed to represent the
                   particular value.  The overall effect is to match the output
                   of *note str(): 325. as altered by the other format
                   modifiers.
                   

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0378

   (2) https://www.python.org/dev/peps/pep-0515


File: python.info,  Node: Format examples,  Prev: Format Specification Mini-Language,  Up: Format String Syntax

5.6.1.5 Format examples
.......................

This section contains examples of the *note str.format(): 4cf. syntax
and comparison with the old ‘%’-formatting.

In most of the cases the syntax is similar to the old ‘%’-formatting,
with the addition of the ‘{}’ and with ‘:’ used instead of ‘%’.  For
example, ‘'%03.2f'’ can be translated to ‘'{:03.2f}'’.

The new format syntax also supports new and different options, shown in
the following examples.

Accessing arguments by position:

     >>> '{0}, {1}, {2}'.format('a', 'b', 'c')
     'a, b, c'
     >>> '{}, {}, {}'.format('a', 'b', 'c')  # 3.1+ only
     'a, b, c'
     >>> '{2}, {1}, {0}'.format('a', 'b', 'c')
     'c, b, a'
     >>> '{2}, {1}, {0}'.format(*'abc')      # unpacking argument sequence
     'c, b, a'
     >>> '{0}{1}{0}'.format('abra', 'cad')   # arguments' indices can be repeated
     'abracadabra'

Accessing arguments by name:

     >>> 'Coordinates: {latitude}, {longitude}'.format(latitude='37.24N', longitude='-115.81W')
     'Coordinates: 37.24N, -115.81W'
     >>> coord = {'latitude': '37.24N', 'longitude': '-115.81W'}
     >>> 'Coordinates: {latitude}, {longitude}'.format(**coord)
     'Coordinates: 37.24N, -115.81W'

Accessing arguments’ attributes:

     >>> c = 3-5j
     >>> ('The complex number {0} is formed from the real part {0.real} '
     ...  'and the imaginary part {0.imag}.').format(c)
     'The complex number (3-5j) is formed from the real part 3.0 and the imaginary part -5.0.'
     >>> class Point:
     ...     def __init__(self, x, y):
     ...         self.x, self.y = x, y
     ...     def __str__(self):
     ...         return 'Point({self.x}, {self.y})'.format(self=self)
     ...
     >>> str(Point(4, 2))
     'Point(4, 2)'

Accessing arguments’ items:

     >>> coord = (3, 5)
     >>> 'X: {0[0]};  Y: {0[1]}'.format(coord)
     'X: 3;  Y: 5'

Replacing ‘%s’ and ‘%r’:

     >>> "repr() shows quotes: {!r}; str() doesn't: {!s}".format('test1', 'test2')
     "repr() shows quotes: 'test1'; str() doesn't: test2"

Aligning the text and specifying a width:

     >>> '{:<30}'.format('left aligned')
     'left aligned                  '
     >>> '{:>30}'.format('right aligned')
     '                 right aligned'
     >>> '{:^30}'.format('centered')
     '           centered           '
     >>> '{:*^30}'.format('centered')  # use '*' as a fill char
     '***********centered***********'

Replacing ‘%+f’, ‘%-f’, and ‘% f’ and specifying a sign:

     >>> '{:+f}; {:+f}'.format(3.14, -3.14)  # show it always
     '+3.140000; -3.140000'
     >>> '{: f}; {: f}'.format(3.14, -3.14)  # show a space for positive numbers
     ' 3.140000; -3.140000'
     >>> '{:-f}; {:-f}'.format(3.14, -3.14)  # show only the minus -- same as '{:f}; {:f}'
     '3.140000; -3.140000'

Replacing ‘%x’ and ‘%o’ and converting the value to different bases:

     >>> # format also supports binary numbers
     >>> "int: {0:d};  hex: {0:x};  oct: {0:o};  bin: {0:b}".format(42)
     'int: 42;  hex: 2a;  oct: 52;  bin: 101010'
     >>> # with 0x, 0o, or 0b as prefix:
     >>> "int: {0:d};  hex: {0:#x};  oct: {0:#o};  bin: {0:#b}".format(42)
     'int: 42;  hex: 0x2a;  oct: 0o52;  bin: 0b101010'

Using the comma as a thousands separator:

     >>> '{:,}'.format(1234567890)
     '1,234,567,890'

Expressing a percentage:

     >>> points = 19
     >>> total = 22
     >>> 'Correct answers: {:.2%}'.format(points/total)
     'Correct answers: 86.36%'

Using type-specific formatting:

     >>> import datetime
     >>> d = datetime.datetime(2010, 7, 4, 12, 15, 58)
     >>> '{:%Y-%m-%d %H:%M:%S}'.format(d)
     '2010-07-04 12:15:58'

Nesting arguments and more complex examples:

     >>> for align, text in zip('<^>', ['left', 'center', 'right']):
     ...     '{0:{fill}{align}16}'.format(text, fill=align, align=align)
     ...
     'left<<<<<<<<<<<<'
     '^^^^^center^^^^^'
     '>>>>>>>>>>>right'
     >>>
     >>> octets = [192, 168, 0, 1]
     >>> '{:02X}{:02X}{:02X}{:02X}'.format(*octets)
     'C0A80001'
     >>> int(_, 16)
     3232235521
     >>>
     >>> width = 5
     >>> for num in range(5,12):
     ...     for base in 'dXob':
     ...         print('{0:{width}{base}}'.format(num, base=base, width=width), end=' ')
     ...     print()
     ...
         5     5     5   101
         6     6     6   110
         7     7     7   111
         8     8    10  1000
         9     9    11  1001
        10     A    12  1010
        11     B    13  1011


File: python.info,  Node: Template strings,  Next: Helper functions,  Prev: Format String Syntax,  Up: string — Common string operations

5.6.1.6 Template strings
........................

Template strings provide simpler string substitutions as described in
PEP 292(1).  A primary use case for template strings is for
internationalization (i18n) since in that context, the simpler syntax
and functionality makes it easier to translate than other built-in
string formatting facilities in Python.  As an example of a library
built on template strings for i18n, see the flufl.i18n(2) package.

Template strings support ‘$’-based substitutions, using the following
rules:

   * ‘$$’ is an escape; it is replaced with a single ‘$’.

   * ‘$identifier’ names a substitution placeholder matching a mapping
     key of ‘"identifier"’.  By default, ‘"identifier"’ is restricted to
     any case-insensitive ASCII alphanumeric string (including
     underscores) that starts with an underscore or ASCII letter.  The
     first non-identifier character after the ‘$’ character terminates
     this placeholder specification.

   * ‘${identifier}’ is equivalent to ‘$identifier’.  It is required
     when valid identifier characters follow the placeholder but are not
     part of the placeholder, such as ‘"${noun}ification"’.

Any other appearance of ‘$’ in the string will result in a *note
ValueError: 1f9. being raised.

The *note string: f6. module provides a *note Template: 3e0. class that
implements these rules.  The methods of *note Template: 3e0. are:

 -- Class: string.Template (template)

     The constructor takes a single argument which is the template
     string.

      -- Method: substitute (mapping={}, /, **kwds)

          Performs the template substitution, returning a new string.
          `mapping' is any dictionary-like object with keys that match
          the placeholders in the template.  Alternatively, you can
          provide keyword arguments, where the keywords are the
          placeholders.  When both `mapping' and `kwds' are given and
          there are duplicates, the placeholders from `kwds' take
          precedence.

      -- Method: safe_substitute (mapping={}, /, **kwds)

          Like *note substitute(): 1238, except that if placeholders are
          missing from `mapping' and `kwds', instead of raising a *note
          KeyError: 2c5. exception, the original placeholder will appear
          in the resulting string intact.  Also, unlike with *note
          substitute(): 1238, any other appearances of the ‘$’ will
          simply return ‘$’ instead of raising *note ValueError: 1f9.

          While other exceptions may still occur, this method is called
          “safe” because it always tries to return a usable string
          instead of raising an exception.  In another sense, *note
          safe_substitute(): 1239. may be anything other than safe,
          since it will silently ignore malformed templates containing
          dangling delimiters, unmatched braces, or placeholders that
          are not valid Python identifiers.

     *note Template: 3e0. instances also provide one public data
     attribute:

      -- Attribute: template

          This is the object passed to the constructor’s `template'
          argument.  In general, you shouldn’t change it, but read-only
          access is not enforced.

Here is an example of how to use a Template:

     >>> from string import Template
     >>> s = Template('$who likes $what')
     >>> s.substitute(who='tim', what='kung pao')
     'tim likes kung pao'
     >>> d = dict(who='tim')
     >>> Template('Give $who $100').substitute(d)
     Traceback (most recent call last):
     ...
     ValueError: Invalid placeholder in string: line 1, col 11
     >>> Template('$who likes $what').substitute(d)
     Traceback (most recent call last):
     ...
     KeyError: 'what'
     >>> Template('$who likes $what').safe_substitute(d)
     'tim likes $what'

Advanced usage: you can derive subclasses of *note Template: 3e0. to
customize the placeholder syntax, delimiter character, or the entire
regular expression used to parse template strings.  To do this, you can
override these class attributes:

   * `delimiter' – This is the literal string describing a placeholder
     introducing delimiter.  The default value is ‘$’.  Note that this
     should `not' be a regular expression, as the implementation will
     call *note re.escape(): 48b. on this string as needed.  Note
     further that you cannot change the delimiter after class creation
     (i.e.  a different delimiter must be set in the subclass’s class
     namespace).

   * `idpattern' – This is the regular expression describing the pattern
     for non-braced placeholders.  The default value is the regular
     expression ‘(?a:[_a-z][_a-z0-9]*)’.  If this is given and
     `braceidpattern' is ‘None’ this pattern will also apply to braced
     placeholders.

          Note: Since default `flags' is ‘re.IGNORECASE’, pattern
          ‘[a-z]’ can match with some non-ASCII characters.  That’s why
          we use the local ‘a’ flag here.

     Changed in version 3.7: `braceidpattern' can be used to define
     separate patterns used inside and outside the braces.

   * `braceidpattern' – This is like `idpattern' but describes the
     pattern for braced placeholders.  Defaults to ‘None’ which means to
     fall back to `idpattern' (i.e.  the same pattern is used both
     inside and outside braces).  If given, this allows you to define
     different patterns for braced and unbraced placeholders.

     New in version 3.7.

   * `flags' – The regular expression flags that will be applied when
     compiling the regular expression used for recognizing
     substitutions.  The default value is ‘re.IGNORECASE’.  Note that
     ‘re.VERBOSE’ will always be added to the flags, so custom
     `idpattern's must follow conventions for verbose regular
     expressions.

     New in version 3.2.

Alternatively, you can provide the entire regular expression pattern by
overriding the class attribute `pattern'.  If you do this, the value
must be a regular expression object with four named capturing groups.
The capturing groups correspond to the rules given above, along with the
invalid placeholder rule:

   * `escaped' – This group matches the escape sequence, e.g.  ‘$$’, in
     the default pattern.

   * `named' – This group matches the unbraced placeholder name; it
     should not include the delimiter in capturing group.

   * `braced' – This group matches the brace enclosed placeholder name;
     it should not include either the delimiter or braces in the
     capturing group.

   * `invalid' – This group matches any other delimiter pattern (usually
     a single delimiter), and it should appear last in the regular
     expression.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0292

   (2) http://flufli18n.readthedocs.io/en/latest/


File: python.info,  Node: Helper functions,  Prev: Template strings,  Up: string — Common string operations

5.6.1.7 Helper functions
........................

 -- Function: string.capwords (s, sep=None)

     Split the argument into words using *note str.split(): 795,
     capitalize each word using *note str.capitalize(): 157e, and join
     the capitalized words using *note str.join(): 156d.  If the
     optional second argument `sep' is absent or ‘None’, runs of
     whitespace characters are replaced by a single space and leading
     and trailing whitespace are removed, otherwise `sep' is used to
     split and join the words.


File: python.info,  Node: re — Regular expression operations,  Next: difflib — Helpers for computing deltas,  Prev: string — Common string operations,  Up: Text Processing Services

5.6.2 ‘re’ — Regular expression operations
------------------------------------------

`Source code:' Lib/re.py(1)

__________________________________________________________________

This module provides regular expression matching operations similar to
those found in Perl.

Both patterns and strings to be searched can be Unicode strings (*note
str: 325.) as well as 8-bit strings (*note bytes: 326.).  However,
Unicode strings and 8-bit strings cannot be mixed: that is, you cannot
match a Unicode string with a byte pattern or vice-versa; similarly,
when asking for a substitution, the replacement string must be of the
same type as both the pattern and the search string.

Regular expressions use the backslash character (‘'\'’) to indicate
special forms or to allow special characters to be used without invoking
their special meaning.  This collides with Python’s usage of the same
character for the same purpose in string literals; for example, to match
a literal backslash, one might have to write ‘'\\\\'’ as the pattern
string, because the regular expression must be ‘\\’, and each backslash
must be expressed as ‘\\’ inside a regular Python string literal.  Also,
please note that any invalid escape sequences in Python’s usage of the
backslash in string literals now generate a *note DeprecationWarning:
276. and in the future this will become a *note SyntaxError: 44d.  This
behaviour will happen even if it is a valid escape sequence for a
regular expression.

The solution is to use Python’s raw string notation for regular
expression patterns; backslashes are not handled in any special way in a
string literal prefixed with ‘'r'’.  So ‘r"\n"’ is a two-character
string containing ‘'\'’ and ‘'n'’, while ‘"\n"’ is a one-character
string containing a newline.  Usually patterns will be expressed in
Python code using this raw string notation.

It is important to note that most regular expression operations are
available as module-level functions and methods on *note compiled
regular expressions: 890.  The functions are shortcuts that don’t
require you to compile a regex object first, but miss some fine-tuning
parameters.

See also
........

The third-party regex(2) module, which has an API compatible with the
standard library *note re: dd. module, but offers additional
functionality and a more thorough Unicode support.

* Menu:

* Regular Expression Syntax::
* Module Contents::
* Regular Expression Objects::
* Match Objects::
* Regular Expression Examples::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/re.py

   (2) https://pypi.org/project/regex/


File: python.info,  Node: Regular Expression Syntax,  Next: Module Contents,  Up: re — Regular expression operations

5.6.2.1 Regular Expression Syntax
.................................

A regular expression (or RE) specifies a set of strings that matches it;
the functions in this module let you check if a particular string
matches a given regular expression (or if a given regular expression
matches a particular string, which comes down to the same thing).

Regular expressions can be concatenated to form new regular expressions;
if `A' and `B' are both regular expressions, then `AB' is also a regular
expression.  In general, if a string `p' matches `A' and another string
`q' matches `B', the string `pq' will match AB. This holds unless `A' or
`B' contain low precedence operations; boundary conditions between `A'
and `B'; or have numbered group references.  Thus, complex expressions
can easily be constructed from simpler primitive expressions like the
ones described here.  For details of the theory and implementation of
regular expressions, consult the Friedl book *note [Frie09]: 1687, or
almost any textbook about compiler construction.

A brief explanation of the format of regular expressions follows.  For
further information and a gentler presentation, consult the *note
Regular Expression HOWTO: 1688.

Regular expressions can contain both special and ordinary characters.
Most ordinary characters, like ‘'A'’, ‘'a'’, or ‘'0'’, are the simplest
regular expressions; they simply match themselves.  You can concatenate
ordinary characters, so ‘last’ matches the string ‘'last'’.  (In the
rest of this section, we’ll write RE’s in ‘this special style’, usually
without quotes, and strings to be matched ‘'in single quotes'’.)

Some characters, like ‘'|'’ or ‘'('’, are special.  Special characters
either stand for classes of ordinary characters, or affect how the
regular expressions around them are interpreted.

Repetition qualifiers (‘*’, ‘+’, ‘?’, ‘{m,n}’, etc) cannot be directly
nested.  This avoids ambiguity with the non-greedy modifier suffix ‘?’,
and with other modifiers in other implementations.  To apply a second
repetition to an inner repetition, parentheses may be used.  For
example, the expression ‘(?:a{6})*’ matches any multiple of six ‘'a'’
characters.

The special characters are:

‘.’

     (Dot.)  In the default mode, this matches any character except a
     newline.  If the *note DOTALL: 1689. flag has been specified, this
     matches any character including a newline.

‘^’

     (Caret.)  Matches the start of the string, and in *note MULTILINE:
     168a. mode also matches immediately after each newline.

‘$’

     Matches the end of the string or just before the newline at the end
     of the string, and in *note MULTILINE: 168a. mode also matches
     before a newline.  ‘foo’ matches both ‘foo’ and ‘foobar’, while the
     regular expression ‘foo$’ matches only ‘foo’.  More interestingly,
     searching for ‘foo.$’ in ‘'foo1\nfoo2\n'’ matches ‘foo2’ normally,
     but ‘foo1’ in *note MULTILINE: 168a. mode; searching for a single
     ‘$’ in ‘'foo\n'’ will find two (empty) matches: one just before the
     newline, and one at the end of the string.

‘*’

     Causes the resulting RE to match 0 or more repetitions of the
     preceding RE, as many repetitions as are possible.  ‘ab*’ will
     match ‘a’, ‘ab’, or ‘a’ followed by any number of ‘b’s.

‘+’

     Causes the resulting RE to match 1 or more repetitions of the
     preceding RE. ‘ab+’ will match ‘a’ followed by any non-zero number
     of ‘b’s; it will not match just ‘a’.

‘?’

     Causes the resulting RE to match 0 or 1 repetitions of the
     preceding RE. ‘ab?’ will match either ‘a’ or ‘ab’.

‘*?’, ‘+?’, ‘??’

     The ‘'*'’, ‘'+'’, and ‘'?'’ qualifiers are all `greedy'; they match
     as much text as possible.  Sometimes this behaviour isn’t desired;
     if the RE ‘<.*>’ is matched against ‘'<a> b <c>'’, it will match
     the entire string, and not just ‘'<a>'’.  Adding ‘?’ after the
     qualifier makes it perform the match in `non-greedy' or `minimal'
     fashion; as `few' characters as possible will be matched.  Using
     the RE ‘<.*?>’ will match only ‘'<a>'’.

‘{m}’

     Specifies that exactly `m' copies of the previous RE should be
     matched; fewer matches cause the entire RE not to match.  For
     example, ‘a{6}’ will match exactly six ‘'a'’ characters, but not
     five.

‘{m,n}’

     Causes the resulting RE to match from `m' to `n' repetitions of the
     preceding RE, attempting to match as many repetitions as possible.
     For example, ‘a{3,5}’ will match from 3 to 5 ‘'a'’ characters.
     Omitting `m' specifies a lower bound of zero, and omitting `n'
     specifies an infinite upper bound.  As an example, ‘a{4,}b’ will
     match ‘'aaaab'’ or a thousand ‘'a'’ characters followed by a ‘'b'’,
     but not ‘'aaab'’.  The comma may not be omitted or the modifier
     would be confused with the previously described form.

‘{m,n}?’

     Causes the resulting RE to match from `m' to `n' repetitions of the
     preceding RE, attempting to match as `few' repetitions as possible.
     This is the non-greedy version of the previous qualifier.  For
     example, on the 6-character string ‘'aaaaaa'’, ‘a{3,5}’ will match
     5 ‘'a'’ characters, while ‘a{3,5}?’ will only match 3 characters.

‘\’

     Either escapes special characters (permitting you to match
     characters like ‘'*'’, ‘'?'’, and so forth), or signals a special
     sequence; special sequences are discussed below.

     If you’re not using a raw string to express the pattern, remember
     that Python also uses the backslash as an escape sequence in string
     literals; if the escape sequence isn’t recognized by Python’s
     parser, the backslash and subsequent character are included in the
     resulting string.  However, if Python would recognize the resulting
     sequence, the backslash should be repeated twice.  This is
     complicated and hard to understand, so it’s highly recommended that
     you use raw strings for all but the simplest expressions.

‘[]’

     Used to indicate a set of characters.  In a set:

        * Characters can be listed individually, e.g.  ‘[amk]’ will
          match ‘'a'’, ‘'m'’, or ‘'k'’.

        * Ranges of characters can be indicated by giving two characters
          and separating them by a ‘'-'’, for example ‘[a-z]’ will match
          any lowercase ASCII letter, ‘[0-5][0-9]’ will match all the
          two-digits numbers from ‘00’ to ‘59’, and ‘[0-9A-Fa-f]’ will
          match any hexadecimal digit.  If ‘-’ is escaped (e.g.
          ‘[a\-z]’) or if it’s placed as the first or last character
          (e.g.  ‘[-a]’ or ‘[a-]’), it will match a literal ‘'-'’.

        * Special characters lose their special meaning inside sets.
          For example, ‘[(+*)]’ will match any of the literal characters
          ‘'('’, ‘'+'’, ‘'*'’, or ‘')'’.

        * Character classes such as ‘\w’ or ‘\S’ (defined below) are
          also accepted inside a set, although the characters they match
          depends on whether *note ASCII: 3bd. or *note LOCALE: 3be.
          mode is in force.

        * Characters that are not within a range can be matched by
          `complementing' the set.  If the first character of the set is
          ‘'^'’, all the characters that are `not' in the set will be
          matched.  For example, ‘[^5]’ will match any character except
          ‘'5'’, and ‘[^^]’ will match any character except ‘'^'’.  ‘^’
          has no special meaning if it’s not the first character in the
          set.

        * To match a literal ‘']'’ inside a set, precede it with a
          backslash, or place it at the beginning of the set.  For
          example, both ‘[()[\]{}]’ and ‘[]()[{}]’ will both match a
          parenthesis.

        * Support of nested sets and set operations as in Unicode
          Technical Standard #18(1) might be added in the future.  This
          would change the syntax, so to facilitate this change a *note
          FutureWarning: 31a. will be raised in ambiguous cases for the
          time being.  That includes sets starting with a literal ‘'['’
          or containing literal character sequences ‘'--'’, ‘'&&'’,
          ‘'~~'’, and ‘'||'’.  To avoid a warning escape them with a
          backslash.

     Changed in version 3.7: *note FutureWarning: 31a. is raised if a
     character set contains constructs that will change semantically in
     the future.

‘|’

     ‘A|B’, where `A' and `B' can be arbitrary REs, creates a regular
     expression that will match either `A' or `B'. An arbitrary number
     of REs can be separated by the ‘'|'’ in this way.  This can be used
     inside groups (see below) as well.  As the target string is
     scanned, REs separated by ‘'|'’ are tried from left to right.  When
     one pattern completely matches, that branch is accepted.  This
     means that once `A' matches, `B' will not be tested further, even
     if it would produce a longer overall match.  In other words, the
     ‘'|'’ operator is never greedy.  To match a literal ‘'|'’, use
     ‘\|’, or enclose it inside a character class, as in ‘[|]’.

‘(...)’

     Matches whatever regular expression is inside the parentheses, and
     indicates the start and end of a group; the contents of a group can
     be retrieved after a match has been performed, and can be matched
     later in the string with the ‘\number’ special sequence, described
     below.  To match the literals ‘'('’ or ‘')'’, use ‘\(’ or ‘\)’, or
     enclose them inside a character class: ‘[(]’, ‘[)]’.

‘(?...)’

     This is an extension notation (a ‘'?'’ following a ‘'('’ is not
     meaningful otherwise).  The first character after the ‘'?'’
     determines what the meaning and further syntax of the construct is.
     Extensions usually do not create a new group; ‘(?P<name>...)’ is
     the only exception to this rule.  Following are the currently
     supported extensions.

‘(?aiLmsux)’

     (One or more letters from the set ‘'a'’, ‘'i'’, ‘'L'’, ‘'m'’,
     ‘'s'’, ‘'u'’, ‘'x'’.)  The group matches the empty string; the
     letters set the corresponding flags: *note re.A: 168b. (ASCII-only
     matching), *note re.I: 168c. (ignore case), *note re.L: 168d.
     (locale dependent), *note re.M: 168e. (multi-line), *note re.S:
     168f. (dot matches all), ‘re.U’ (Unicode matching), and *note re.X:
     1690. (verbose), for the entire regular expression.  (The flags are
     described in *note Module Contents: 1691.)  This is useful if you
     wish to include the flags as part of the regular expression,
     instead of passing a `flag' argument to the *note re.compile():
     43f. function.  Flags should be used first in the expression
     string.

‘(?:...)’

     A non-capturing version of regular parentheses.  Matches whatever
     regular expression is inside the parentheses, but the substring
     matched by the group `cannot' be retrieved after performing a match
     or referenced later in the pattern.

‘(?aiLmsux-imsx:...)’

     (Zero or more letters from the set ‘'a'’, ‘'i'’, ‘'L'’, ‘'m'’,
     ‘'s'’, ‘'u'’, ‘'x'’, optionally followed by ‘'-'’ followed by one
     or more letters from the ‘'i'’, ‘'m'’, ‘'s'’, ‘'x'’.)  The letters
     set or remove the corresponding flags: *note re.A: 168b.
     (ASCII-only matching), *note re.I: 168c. (ignore case), *note re.L:
     168d. (locale dependent), *note re.M: 168e. (multi-line), *note
     re.S: 168f. (dot matches all), ‘re.U’ (Unicode matching), and *note
     re.X: 1690. (verbose), for the part of the expression.  (The flags
     are described in *note Module Contents: 1691.)

     The letters ‘'a'’, ‘'L'’ and ‘'u'’ are mutually exclusive when used
     as inline flags, so they can’t be combined or follow ‘'-'’.
     Instead, when one of them appears in an inline group, it overrides
     the matching mode in the enclosing group.  In Unicode patterns
     ‘(?a:...)’ switches to ASCII-only matching, and ‘(?u:...)’ switches
     to Unicode matching (default).  In byte pattern ‘(?L:...)’ switches
     to locale depending matching, and ‘(?a:...)’ switches to ASCII-only
     matching (default).  This override is only in effect for the narrow
     inline group, and the original matching mode is restored outside of
     the group.

     New in version 3.6.

     Changed in version 3.7: The letters ‘'a'’, ‘'L'’ and ‘'u'’ also can
     be used in a group.

‘(?P<name>...)’

     Similar to regular parentheses, but the substring matched by the
     group is accessible via the symbolic group name `name'.  Group
     names must be valid Python identifiers, and each group name must be
     defined only once within a regular expression.  A symbolic group is
     also a numbered group, just as if the group were not named.

     Named groups can be referenced in three contexts.  If the pattern
     is ‘(?P<quote>['"]).*?(?P=quote)’ (i.e.  matching a string quoted
     with either single or double quotes):

     Context of reference to group “quote”       Ways to reference it
                                                 
     -----------------------------------------------------------------------------------
                                                 
     in the same pattern itself                     * ‘(?P=quote)’ (as shown)
                                                 
                                                    * ‘\1’
                                                 
                                                 
     when processing match object `m'               * ‘m.group('quote')’
                                                 
                                                    * ‘m.end('quote')’ (etc.)
                                                 
                                                 
     in a string passed to the `repl' argument      * ‘\g<quote>’
     of ‘re.sub()’                               
                                                    * ‘\g<1>’
                                                 
                                                    * ‘\1’
                                                 

‘(?P=name)’

     A backreference to a named group; it matches whatever text was
     matched by the earlier group named `name'.

‘(?#...)’

     A comment; the contents of the parentheses are simply ignored.

‘(?=...)’

     Matches if ‘...’ matches next, but doesn’t consume any of the
     string.  This is called a `lookahead assertion'.  For example,
     ‘Isaac (?=Asimov)’ will match ‘'Isaac '’ only if it’s followed by
     ‘'Asimov'’.

‘(?!...)’

     Matches if ‘...’ doesn’t match next.  This is a `negative lookahead
     assertion'.  For example, ‘Isaac (?!Asimov)’ will match ‘'Isaac '’
     only if it’s `not' followed by ‘'Asimov'’.

‘(?<=...)’

     Matches if the current position in the string is preceded by a
     match for ‘...’ that ends at the current position.  This is called
     a `positive lookbehind assertion'.  ‘(?<=abc)def’ will find a match
     in ‘'abcdef'’, since the lookbehind will back up 3 characters and
     check if the contained pattern matches.  The contained pattern must
     only match strings of some fixed length, meaning that ‘abc’ or
     ‘a|b’ are allowed, but ‘a*’ and ‘a{3,4}’ are not.  Note that
     patterns which start with positive lookbehind assertions will not
     match at the beginning of the string being searched; you will most
     likely want to use the *note search(): ba5. function rather than
     the *note match(): ba6. function:

          >>> import re
          >>> m = re.search('(?<=abc)def', 'abcdef')
          >>> m.group(0)
          'def'

     This example looks for a word following a hyphen:

          >>> m = re.search(r'(?<=-)\w+', 'spam-egg')
          >>> m.group(0)
          'egg'

     Changed in version 3.5: Added support for group references of fixed
     length.

‘(?<!...)’

     Matches if the current position in the string is not preceded by a
     match for ‘...’.  This is called a `negative lookbehind assertion'.
     Similar to positive lookbehind assertions, the contained pattern
     must only match strings of some fixed length.  Patterns which start
     with negative lookbehind assertions may match at the beginning of
     the string being searched.

‘(?(id/name)yes-pattern|no-pattern)’

     Will try to match with ‘yes-pattern’ if the group with given `id'
     or `name' exists, and with ‘no-pattern’ if it doesn’t.
     ‘no-pattern’ is optional and can be omitted.  For example,
     ‘(<)?(\w+@\w+(?:\.\w+)+)(?(1)>|$)’ is a poor email matching
     pattern, which will match with ‘'<user@host.com>'’ as well as
     ‘'user@host.com'’, but not with ‘'<user@host.com'’ nor
     ‘'user@host.com>'’.

The special sequences consist of ‘'\'’ and a character from the list
below.  If the ordinary character is not an ASCII digit or an ASCII
letter, then the resulting RE will match the second character.  For
example, ‘\$’ matches the character ‘'$'’.

‘\number’

     Matches the contents of the group of the same number.  Groups are
     numbered starting from 1.  For example, ‘(.+) \1’ matches ‘'the
     the'’ or ‘'55 55'’, but not ‘'thethe'’ (note the space after the
     group).  This special sequence can only be used to match one of the
     first 99 groups.  If the first digit of `number' is 0, or `number'
     is 3 octal digits long, it will not be interpreted as a group
     match, but as the character with octal value `number'.  Inside the
     ‘'['’ and ‘']'’ of a character class, all numeric escapes are
     treated as characters.

‘\A’

     Matches only at the start of the string.

‘\b’

     Matches the empty string, but only at the beginning or end of a
     word.  A word is defined as a sequence of word characters.  Note
     that formally, ‘\b’ is defined as the boundary between a ‘\w’ and a
     ‘\W’ character (or vice versa), or between ‘\w’ and the
     beginning/end of the string.  This means that ‘r'\bfoo\b'’ matches
     ‘'foo'’, ‘'foo.'’, ‘'(foo)'’, ‘'bar foo baz'’ but not ‘'foobar'’ or
     ‘'foo3'’.

     By default Unicode alphanumerics are the ones used in Unicode
     patterns, but this can be changed by using the *note ASCII: 3bd.
     flag.  Word boundaries are determined by the current locale if the
     *note LOCALE: 3be. flag is used.  Inside a character range, ‘\b’
     represents the backspace character, for compatibility with Python’s
     string literals.

‘\B’

     Matches the empty string, but only when it is `not' at the
     beginning or end of a word.  This means that ‘r'py\B'’ matches
     ‘'python'’, ‘'py3'’, ‘'py2'’, but not ‘'py'’, ‘'py.'’, or ‘'py!'’.
     ‘\B’ is just the opposite of ‘\b’, so word characters in Unicode
     patterns are Unicode alphanumerics or the underscore, although this
     can be changed by using the *note ASCII: 3bd. flag.  Word
     boundaries are determined by the current locale if the *note
     LOCALE: 3be. flag is used.

‘\d’

     For Unicode (str) patterns:

          Matches any Unicode decimal digit (that is, any character in
          Unicode character category [Nd]).  This includes ‘[0-9]’, and
          also many other digit characters.  If the *note ASCII: 3bd.
          flag is used only ‘[0-9]’ is matched.

     For 8-bit (bytes) patterns:

          Matches any decimal digit; this is equivalent to ‘[0-9]’.

‘\D’

     Matches any character which is not a decimal digit.  This is the
     opposite of ‘\d’.  If the *note ASCII: 3bd. flag is used this
     becomes the equivalent of ‘[^0-9]’.

‘\s’

     For Unicode (str) patterns:

          Matches Unicode whitespace characters (which includes ‘[
          \t\n\r\f\v]’, and also many other characters, for example the
          non-breaking spaces mandated by typography rules in many
          languages).  If the *note ASCII: 3bd. flag is used, only ‘[
          \t\n\r\f\v]’ is matched.

     For 8-bit (bytes) patterns:

          Matches characters considered whitespace in the ASCII
          character set; this is equivalent to ‘[ \t\n\r\f\v]’.

‘\S’

     Matches any character which is not a whitespace character.  This is
     the opposite of ‘\s’.  If the *note ASCII: 3bd. flag is used this
     becomes the equivalent of ‘[^ \t\n\r\f\v]’.

‘\w’

     For Unicode (str) patterns:

          Matches Unicode word characters; this includes most characters
          that can be part of a word in any language, as well as numbers
          and the underscore.  If the *note ASCII: 3bd. flag is used,
          only ‘[a-zA-Z0-9_]’ is matched.

     For 8-bit (bytes) patterns:

          Matches characters considered alphanumeric in the ASCII
          character set; this is equivalent to ‘[a-zA-Z0-9_]’.  If the
          *note LOCALE: 3be. flag is used, matches characters considered
          alphanumeric in the current locale and the underscore.

‘\W’

     Matches any character which is not a word character.  This is the
     opposite of ‘\w’.  If the *note ASCII: 3bd. flag is used this
     becomes the equivalent of ‘[^a-zA-Z0-9_]’.  If the *note LOCALE:
     3be. flag is used, matches characters which are neither
     alphanumeric in the current locale nor the underscore.

‘\Z’

     Matches only at the end of the string.

Most of the standard escapes supported by Python string literals are
also accepted by the regular expression parser:

     \a      \b      \f      \n
     \N      \r      \t      \u
     \U      \v      \x      \\

(Note that ‘\b’ is used to represent word boundaries, and means
“backspace” only inside character classes.)

‘'\u'’, ‘'\U'’, and ‘'\N'’ escape sequences are only recognized in
Unicode patterns.  In bytes patterns they are errors.  Unknown escapes
of ASCII letters are reserved for future use and treated as errors.

Octal escapes are included in a limited form.  If the first digit is a
0, or if there are three octal digits, it is considered an octal escape.
Otherwise, it is a group reference.  As for string literals, octal
escapes are always at most three digits in length.

Changed in version 3.3: The ‘'\u'’ and ‘'\U'’ escape sequences have been
added.

Changed in version 3.6: Unknown escapes consisting of ‘'\'’ and an ASCII
letter now are errors.

Changed in version 3.8: The ‘'\N{name}'’ escape sequence has been added.
As in string literals, it expands to the named Unicode character (e.g.
‘'\N{EM DASH}'’).

   ---------- Footnotes ----------

   (1) https://unicode.org/reports/tr18/


File: python.info,  Node: Module Contents,  Next: Regular Expression Objects,  Prev: Regular Expression Syntax,  Up: re — Regular expression operations

5.6.2.2 Module Contents
.......................

The module defines several functions, constants, and an exception.  Some
of the functions are simplified versions of the full featured methods
for compiled regular expressions.  Most non-trivial applications always
use the compiled form.

Changed in version 3.6: Flag constants are now instances of ‘RegexFlag’,
which is a subclass of *note enum.IntFlag: 1693.

 -- Function: re.compile (pattern, flags=0)

     Compile a regular expression pattern into a *note regular
     expression object: 890, which can be used for matching using its
     *note match(): 1694, *note search(): 1695. and other methods,
     described below.

     The expression’s behaviour can be modified by specifying a `flags'
     value.  Values can be any of the following variables, combined
     using bitwise OR (the ‘|’ operator).

     The sequence

          prog = re.compile(pattern)
          result = prog.match(string)

     is equivalent to

          result = re.match(pattern, string)

     but using *note re.compile(): 43f. and saving the resulting regular
     expression object for reuse is more efficient when the expression
     will be used several times in a single program.

          Note: The compiled versions of the most recent patterns passed
          to *note re.compile(): 43f. and the module-level matching
          functions are cached, so programs that use only a few regular
          expressions at a time needn’t worry about compiling regular
          expressions.

 -- Data: re.A
 -- Data: re.ASCII

     Make ‘\w’, ‘\W’, ‘\b’, ‘\B’, ‘\d’, ‘\D’, ‘\s’ and ‘\S’ perform
     ASCII-only matching instead of full Unicode matching.  This is only
     meaningful for Unicode patterns, and is ignored for byte patterns.
     Corresponds to the inline flag ‘(?a)’.

     Note that for backward compatibility, the ‘re.U’ flag still exists
     (as well as its synonym ‘re.UNICODE’ and its embedded counterpart
     ‘(?u)’), but these are redundant in Python 3 since matches are
     Unicode by default for strings (and Unicode matching isn’t allowed
     for bytes).

 -- Data: re.DEBUG

     Display debug information about compiled expression.  No
     corresponding inline flag.

 -- Data: re.I
 -- Data: re.IGNORECASE

     Perform case-insensitive matching; expressions like ‘[A-Z]’ will
     also match lowercase letters.  Full Unicode matching (such as ‘Ü’
     matching ‘ü’) also works unless the *note re.ASCII: 3bd. flag is
     used to disable non-ASCII matches.  The current locale does not
     change the effect of this flag unless the *note re.LOCALE: 3be.
     flag is also used.  Corresponds to the inline flag ‘(?i)’.

     Note that when the Unicode patterns ‘[a-z]’ or ‘[A-Z]’ are used in
     combination with the *note IGNORECASE: 1697. flag, they will match
     the 52 ASCII letters and 4 additional non-ASCII letters: ‘İ’
     (U+0130, Latin capital letter I with dot above), ‘ı’ (U+0131, Latin
     small letter dotless i), ‘ſ’ (U+017F, Latin small letter long s)
     and ‘K’ (U+212A, Kelvin sign).  If the *note ASCII: 3bd. flag is
     used, only letters ‘a’ to ‘z’ and ‘A’ to ‘Z’ are matched.

 -- Data: re.L
 -- Data: re.LOCALE

     Make ‘\w’, ‘\W’, ‘\b’, ‘\B’ and case-insensitive matching dependent
     on the current locale.  This flag can be used only with bytes
     patterns.  The use of this flag is discouraged as the locale
     mechanism is very unreliable, it only handles one “culture” at a
     time, and it only works with 8-bit locales.  Unicode matching is
     already enabled by default in Python 3 for Unicode (str) patterns,
     and it is able to handle different locales/languages.  Corresponds
     to the inline flag ‘(?L)’.

     Changed in version 3.6: *note re.LOCALE: 3be. can be used only with
     bytes patterns and is not compatible with *note re.ASCII: 3bd.

     Changed in version 3.7: Compiled regular expression objects with
     the *note re.LOCALE: 3be. flag no longer depend on the locale at
     compile time.  Only the locale at matching time affects the result
     of matching.

 -- Data: re.M
 -- Data: re.MULTILINE

     When specified, the pattern character ‘'^'’ matches at the
     beginning of the string and at the beginning of each line
     (immediately following each newline); and the pattern character
     ‘'$'’ matches at the end of the string and at the end of each line
     (immediately preceding each newline).  By default, ‘'^'’ matches
     only at the beginning of the string, and ‘'$'’ only at the end of
     the string and immediately before the newline (if any) at the end
     of the string.  Corresponds to the inline flag ‘(?m)’.

 -- Data: re.S
 -- Data: re.DOTALL

     Make the ‘'.'’ special character match any character at all,
     including a newline; without this flag, ‘'.'’ will match anything
     `except' a newline.  Corresponds to the inline flag ‘(?s)’.

 -- Data: re.X
 -- Data: re.VERBOSE

     This flag allows you to write regular expressions that look nicer
     and are more readable by allowing you to visually separate logical
     sections of the pattern and add comments.  Whitespace within the
     pattern is ignored, except when in a character class, or when
     preceded by an unescaped backslash, or within tokens like ‘*?’,
     ‘(?:’ or ‘(?P<...>’.  When a line contains a ‘#’ that is not in a
     character class and is not preceded by an unescaped backslash, all
     characters from the leftmost such ‘#’ through the end of the line
     are ignored.

     This means that the two following regular expression objects that
     match a decimal number are functionally equal:

          a = re.compile(r"""\d +  # the integral part
                             \.    # the decimal point
                             \d *  # some fractional digits""", re.X)
          b = re.compile(r"\d+\.\d*")

     Corresponds to the inline flag ‘(?x)’.

 -- Function: re.search (pattern, string, flags=0)

     Scan through `string' looking for the first location where the
     regular expression `pattern' produces a match, and return a
     corresponding *note match object: 891.  Return ‘None’ if no
     position in the string matches the pattern; note that this is
     different from finding a zero-length match at some point in the
     string.

 -- Function: re.match (pattern, string, flags=0)

     If zero or more characters at the beginning of `string' match the
     regular expression `pattern', return a corresponding *note match
     object: 891.  Return ‘None’ if the string does not match the
     pattern; note that this is different from a zero-length match.

     Note that even in *note MULTILINE: 168a. mode, *note re.match():
     ba6. will only match at the beginning of the string and not at the
     beginning of each line.

     If you want to locate a match anywhere in `string', use *note
     search(): ba5. instead (see also *note search() vs.  match():
     1699.).

 -- Function: re.fullmatch (pattern, string, flags=0)

     If the whole `string' matches the regular expression `pattern',
     return a corresponding *note match object: 891.  Return ‘None’ if
     the string does not match the pattern; note that this is different
     from a zero-length match.

     New in version 3.4.

 -- Function: re.split (pattern, string, maxsplit=0, flags=0)

     Split `string' by the occurrences of `pattern'.  If capturing
     parentheses are used in `pattern', then the text of all groups in
     the pattern are also returned as part of the resulting list.  If
     `maxsplit' is nonzero, at most `maxsplit' splits occur, and the
     remainder of the string is returned as the final element of the
     list.

          >>> re.split(r'\W+', 'Words, words, words.')
          ['Words', 'words', 'words', '']
          >>> re.split(r'(\W+)', 'Words, words, words.')
          ['Words', ', ', 'words', ', ', 'words', '.', '']
          >>> re.split(r'\W+', 'Words, words, words.', 1)
          ['Words', 'words, words.']
          >>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE)
          ['0', '3', '9']

     If there are capturing groups in the separator and it matches at
     the start of the string, the result will start with an empty
     string.  The same holds for the end of the string:

          >>> re.split(r'(\W+)', '...words, words...')
          ['', '...', 'words', ', ', 'words', '...', '']

     That way, separator components are always found at the same
     relative indices within the result list.

     Empty matches for the pattern split the string only when not
     adjacent to a previous empty match.

          >>> re.split(r'\b', 'Words, words, words.')
          ['', 'Words', ', ', 'words', ', ', 'words', '.']
          >>> re.split(r'\W*', '...words...')
          ['', '', 'w', 'o', 'r', 'd', 's', '', '']
          >>> re.split(r'(\W*)', '...words...')
          ['', '...', '', '', 'w', '', 'o', '', 'r', '', 'd', '', 's', '...', '', '', '']

     Changed in version 3.1: Added the optional flags argument.

     Changed in version 3.7: Added support of splitting on a pattern
     that could match an empty string.

 -- Function: re.findall (pattern, string, flags=0)

     Return all non-overlapping matches of `pattern' in `string', as a
     list of strings.  The `string' is scanned left-to-right, and
     matches are returned in the order found.  If one or more groups are
     present in the pattern, return a list of groups; this will be a
     list of tuples if the pattern has more than one group.  Empty
     matches are included in the result.

     Changed in version 3.7: Non-empty matches can now start just after
     a previous empty match.

 -- Function: re.finditer (pattern, string, flags=0)

     Return an *note iterator: f73. yielding *note match objects: 891.
     over all non-overlapping matches for the RE `pattern' in `string'.
     The `string' is scanned left-to-right, and matches are returned in
     the order found.  Empty matches are included in the result.

     Changed in version 3.7: Non-empty matches can now start just after
     a previous empty match.

 -- Function: re.sub (pattern, repl, string, count=0, flags=0)

     Return the string obtained by replacing the leftmost
     non-overlapping occurrences of `pattern' in `string' by the
     replacement `repl'.  If the pattern isn’t found, `string' is
     returned unchanged.  `repl' can be a string or a function; if it is
     a string, any backslash escapes in it are processed.  That is, ‘\n’
     is converted to a single newline character, ‘\r’ is converted to a
     carriage return, and so forth.  Unknown escapes of ASCII letters
     are reserved for future use and treated as errors.  Other unknown
     escapes such as ‘\&’ are left alone.  Backreferences, such as ‘\6’,
     are replaced with the substring matched by group 6 in the pattern.
     For example:

          >>> re.sub(r'def\s+([a-zA-Z_][a-zA-Z_0-9]*)\s*\(\s*\):',
          ...        r'static PyObject*\npy_\1(void)\n{',
          ...        'def myfunc():')
          'static PyObject*\npy_myfunc(void)\n{'

     If `repl' is a function, it is called for every non-overlapping
     occurrence of `pattern'.  The function takes a single *note match
     object: 891. argument, and returns the replacement string.  For
     example:

          >>> def dashrepl(matchobj):
          ...     if matchobj.group(0) == '-': return ' '
          ...     else: return '-'
          >>> re.sub('-{1,2}', dashrepl, 'pro----gram-files')
          'pro--gram files'
          >>> re.sub(r'\sAND\s', ' & ', 'Baked Beans And Spam', flags=re.IGNORECASE)
          'Baked Beans & Spam'

     The pattern may be a string or a *note pattern object: 890.

     The optional argument `count' is the maximum number of pattern
     occurrences to be replaced; `count' must be a non-negative integer.
     If omitted or zero, all occurrences will be replaced.  Empty
     matches for the pattern are replaced only when not adjacent to a
     previous empty match, so ‘sub('x*', '-', 'abxd')’ returns
     ‘'-a-b--d-'’.

     In string-type `repl' arguments, in addition to the character
     escapes and backreferences described above, ‘\g<name>’ will use the
     substring matched by the group named ‘name’, as defined by the
     ‘(?P<name>...)’ syntax.  ‘\g<number>’ uses the corresponding group
     number; ‘\g<2>’ is therefore equivalent to ‘\2’, but isn’t
     ambiguous in a replacement such as ‘\g<2>0’.  ‘\20’ would be
     interpreted as a reference to group 20, not a reference to group 2
     followed by the literal character ‘'0'’.  The backreference ‘\g<0>’
     substitutes in the entire substring matched by the RE.

     Changed in version 3.1: Added the optional flags argument.

     Changed in version 3.5: Unmatched groups are replaced with an empty
     string.

     Changed in version 3.6: Unknown escapes in `pattern' consisting of
     ‘'\'’ and an ASCII letter now are errors.

     Changed in version 3.7: Unknown escapes in `repl' consisting of
     ‘'\'’ and an ASCII letter now are errors.

     Changed in version 3.7: Empty matches for the pattern are replaced
     when adjacent to a previous non-empty match.

 -- Function: re.subn (pattern, repl, string, count=0, flags=0)

     Perform the same operation as *note sub(): 470, but return a tuple
     ‘(new_string, number_of_subs_made)’.

     Changed in version 3.1: Added the optional flags argument.

     Changed in version 3.5: Unmatched groups are replaced with an empty
     string.

 -- Function: re.escape (pattern)

     Escape special characters in `pattern'.  This is useful if you want
     to match an arbitrary literal string that may have regular
     expression metacharacters in it.  For example:

          >>> print(re.escape('http://www.python.org'))
          http://www\.python\.org

          >>> legal_chars = string.ascii_lowercase + string.digits + "!#$%&'*+-.^_`|~:"
          >>> print('[%s]+' % re.escape(legal_chars))
          [abcdefghijklmnopqrstuvwxyz0123456789!\#\$%\&'\*\+\-\.\^_`\|\~:]+

          >>> operators = ['+', '-', '*', '/', '**']
          >>> print('|'.join(map(re.escape, sorted(operators, reverse=True))))
          /|\-|\+|\*\*|\*

     This function must not be used for the replacement string in *note
     sub(): 470. and *note subn(): 728, only backslashes should be
     escaped.  For example:

          >>> digits_re = r'\d+'
          >>> sample = '/usr/sbin/sendmail - 0 errors, 12 warnings'
          >>> print(re.sub(digits_re, digits_re.replace('\\', r'\\'), sample))
          /usr/sbin/sendmail - \d+ errors, \d+ warnings

     Changed in version 3.3: The ‘'_'’ character is no longer escaped.

     Changed in version 3.7: Only characters that can have special
     meaning in a regular expression are escaped.  As a result, ‘'!'’,
     ‘'"'’, ‘'%'’, ‘"'"’, ‘','’, ‘'/'’, ‘':'’, ‘';'’, ‘'<'’, ‘'='’,
     ‘'>'’, ‘'@'’, and ‘"`"’ are no longer escaped.

 -- Function: re.purge ()

     Clear the regular expression cache.

 -- Exception: re.error (msg, pattern=None, pos=None)

     Exception raised when a string passed to one of the functions here
     is not a valid regular expression (for example, it might contain
     unmatched parentheses) or when some other error occurs during
     compilation or matching.  It is never an error if a string contains
     no match for a pattern.  The error instance has the following
     additional attributes:

      -- Attribute: msg

          The unformatted error message.

      -- Attribute: pattern

          The regular expression pattern.

      -- Attribute: pos

          The index in `pattern' where compilation failed (may be
          ‘None’).

      -- Attribute: lineno

          The line corresponding to `pos' (may be ‘None’).

      -- Attribute: colno

          The column corresponding to `pos' (may be ‘None’).

     Changed in version 3.5: Added additional attributes.


File: python.info,  Node: Regular Expression Objects,  Next: Match Objects,  Prev: Module Contents,  Up: re — Regular expression operations

5.6.2.3 Regular Expression Objects
..................................

Compiled regular expression objects support the following methods and
attributes:

 -- Method: Pattern.search (string[, pos[, endpos]])

     Scan through `string' looking for the first location where this
     regular expression produces a match, and return a corresponding
     *note match object: 891.  Return ‘None’ if no position in the
     string matches the pattern; note that this is different from
     finding a zero-length match at some point in the string.

     The optional second parameter `pos' gives an index in the string
     where the search is to start; it defaults to ‘0’.  This is not
     completely equivalent to slicing the string; the ‘'^'’ pattern
     character matches at the real beginning of the string and at
     positions just after a newline, but not necessarily at the index
     where the search is to start.

     The optional parameter `endpos' limits how far the string will be
     searched; it will be as if the string is `endpos' characters long,
     so only the characters from `pos' to ‘endpos - 1’ will be searched
     for a match.  If `endpos' is less than `pos', no match will be
     found; otherwise, if `rx' is a compiled regular expression object,
     ‘rx.search(string, 0, 50)’ is equivalent to ‘rx.search(string[:50],
     0)’.

          >>> pattern = re.compile("d")
          >>> pattern.search("dog")     # Match at index 0
          <re.Match object; span=(0, 1), match='d'>
          >>> pattern.search("dog", 1)  # No match; search doesn't include the "d"

 -- Method: Pattern.match (string[, pos[, endpos]])

     If zero or more characters at the `beginning' of `string' match
     this regular expression, return a corresponding *note match object:
     891.  Return ‘None’ if the string does not match the pattern; note
     that this is different from a zero-length match.

     The optional `pos' and `endpos' parameters have the same meaning as
     for the *note search(): 1695. method.

          >>> pattern = re.compile("o")
          >>> pattern.match("dog")      # No match as "o" is not at the start of "dog".
          >>> pattern.match("dog", 1)   # Match as "o" is the 2nd character of "dog".
          <re.Match object; span=(1, 2), match='o'>

     If you want to locate a match anywhere in `string', use *note
     search(): 1695. instead (see also *note search() vs.  match():
     1699.).

 -- Method: Pattern.fullmatch (string[, pos[, endpos]])

     If the whole `string' matches this regular expression, return a
     corresponding *note match object: 891.  Return ‘None’ if the string
     does not match the pattern; note that this is different from a
     zero-length match.

     The optional `pos' and `endpos' parameters have the same meaning as
     for the *note search(): 1695. method.

          >>> pattern = re.compile("o[gh]")
          >>> pattern.fullmatch("dog")      # No match as "o" is not at the start of "dog".
          >>> pattern.fullmatch("ogre")     # No match as not the full string matches.
          >>> pattern.fullmatch("doggie", 1, 3)   # Matches within given limits.
          <re.Match object; span=(1, 3), match='og'>

     New in version 3.4.

 -- Method: Pattern.split (string, maxsplit=0)

     Identical to the *note split(): 3bf. function, using the compiled
     pattern.

 -- Method: Pattern.findall (string[, pos[, endpos]])

     Similar to the *note findall(): 957. function, using the compiled
     pattern, but also accepts optional `pos' and `endpos' parameters
     that limit the search region like for *note search(): ba5.

 -- Method: Pattern.finditer (string[, pos[, endpos]])

     Similar to the *note finditer(): 169a. function, using the compiled
     pattern, but also accepts optional `pos' and `endpos' parameters
     that limit the search region like for *note search(): ba5.

 -- Method: Pattern.sub (repl, string, count=0)

     Identical to the *note sub(): 470. function, using the compiled
     pattern.

 -- Method: Pattern.subn (repl, string, count=0)

     Identical to the *note subn(): 728. function, using the compiled
     pattern.

 -- Attribute: Pattern.flags

     The regex matching flags.  This is a combination of the flags given
     to *note compile(): 43f, any ‘(?...)’ inline flags in the pattern,
     and implicit flags such as ‘UNICODE’ if the pattern is a Unicode
     string.

 -- Attribute: Pattern.groups

     The number of capturing groups in the pattern.

 -- Attribute: Pattern.groupindex

     A dictionary mapping any symbolic group names defined by ‘(?P<id>)’
     to group numbers.  The dictionary is empty if no symbolic groups
     were used in the pattern.

 -- Attribute: Pattern.pattern

     The pattern string from which the pattern object was compiled.

Changed in version 3.7: Added support of *note copy.copy(): 3c0. and
*note copy.deepcopy(): 3c1.  Compiled regular expression objects are
considered atomic.


File: python.info,  Node: Match Objects,  Next: Regular Expression Examples,  Prev: Regular Expression Objects,  Up: re — Regular expression operations

5.6.2.4 Match Objects
.....................

Match objects always have a boolean value of ‘True’.  Since *note
match(): 1694. and *note search(): 1695. return ‘None’ when there is no
match, you can test whether there was a match with a simple ‘if’
statement:

     match = re.search(pattern, string)
     if match:
         process(match)

Match objects support the following methods and attributes:

 -- Method: Match.expand (template)

     Return the string obtained by doing backslash substitution on the
     template string `template', as done by the *note sub(): 16a1.
     method.  Escapes such as ‘\n’ are converted to the appropriate
     characters, and numeric backreferences (‘\1’, ‘\2’) and named
     backreferences (‘\g<1>’, ‘\g<name>’) are replaced by the contents
     of the corresponding group.

     Changed in version 3.5: Unmatched groups are replaced with an empty
     string.

 -- Method: Match.group ([group1, ...])

     Returns one or more subgroups of the match.  If there is a single
     argument, the result is a single string; if there are multiple
     arguments, the result is a tuple with one item per argument.
     Without arguments, `group1' defaults to zero (the whole match is
     returned).  If a `groupN' argument is zero, the corresponding
     return value is the entire matching string; if it is in the
     inclusive range [1..99], it is the string matching the
     corresponding parenthesized group.  If a group number is negative
     or larger than the number of groups defined in the pattern, an
     *note IndexError: e69. exception is raised.  If a group is
     contained in a part of the pattern that did not match, the
     corresponding result is ‘None’.  If a group is contained in a part
     of the pattern that matched multiple times, the last match is
     returned.

          >>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
          >>> m.group(0)       # The entire match
          'Isaac Newton'
          >>> m.group(1)       # The first parenthesized subgroup.
          'Isaac'
          >>> m.group(2)       # The second parenthesized subgroup.
          'Newton'
          >>> m.group(1, 2)    # Multiple arguments give us a tuple.
          ('Isaac', 'Newton')

     If the regular expression uses the ‘(?P<name>...)’ syntax, the
     `groupN' arguments may also be strings identifying groups by their
     group name.  If a string argument is not used as a group name in
     the pattern, an *note IndexError: e69. exception is raised.

     A moderately complicated example:

          >>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
          >>> m.group('first_name')
          'Malcolm'
          >>> m.group('last_name')
          'Reynolds'

     Named groups can also be referred to by their index:

          >>> m.group(1)
          'Malcolm'
          >>> m.group(2)
          'Reynolds'

     If a group matches multiple times, only the last match is
     accessible:

          >>> m = re.match(r"(..)+", "a1b2c3")  # Matches 3 times.
          >>> m.group(1)                        # Returns only the last match.
          'c3'

 -- Method: Match.__getitem__ (g)

     This is identical to ‘m.group(g)’.  This allows easier access to an
     individual group from a match:

          >>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
          >>> m[0]       # The entire match
          'Isaac Newton'
          >>> m[1]       # The first parenthesized subgroup.
          'Isaac'
          >>> m[2]       # The second parenthesized subgroup.
          'Newton'

     New in version 3.6.

 -- Method: Match.groups (default=None)

     Return a tuple containing all the subgroups of the match, from 1 up
     to however many groups are in the pattern.  The `default' argument
     is used for groups that did not participate in the match; it
     defaults to ‘None’.

     For example:

          >>> m = re.match(r"(\d+)\.(\d+)", "24.1632")
          >>> m.groups()
          ('24', '1632')

     If we make the decimal place and everything after it optional, not
     all groups might participate in the match.  These groups will
     default to ‘None’ unless the `default' argument is given:

          >>> m = re.match(r"(\d+)\.?(\d+)?", "24")
          >>> m.groups()      # Second group defaults to None.
          ('24', None)
          >>> m.groups('0')   # Now, the second group defaults to '0'.
          ('24', '0')

 -- Method: Match.groupdict (default=None)

     Return a dictionary containing all the `named' subgroups of the
     match, keyed by the subgroup name.  The `default' argument is used
     for groups that did not participate in the match; it defaults to
     ‘None’.  For example:

          >>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
          >>> m.groupdict()
          {'first_name': 'Malcolm', 'last_name': 'Reynolds'}

 -- Method: Match.start ([group])
 -- Method: Match.end ([group])

     Return the indices of the start and end of the substring matched by
     `group'; `group' defaults to zero (meaning the whole matched
     substring).  Return ‘-1’ if `group' exists but did not contribute
     to the match.  For a match object `m', and a group `g' that did
     contribute to the match, the substring matched by group `g'
     (equivalent to ‘m.group(g)’) is

          m.string[m.start(g):m.end(g)]

     Note that ‘m.start(group)’ will equal ‘m.end(group)’ if `group'
     matched a null string.  For example, after ‘m = re.search('b(c?)',
     'cba')’, ‘m.start(0)’ is 1, ‘m.end(0)’ is 2, ‘m.start(1)’ and
     ‘m.end(1)’ are both 2, and ‘m.start(2)’ raises an *note IndexError:
     e69. exception.

     An example that will remove `remove_this' from email addresses:

          >>> email = "tony@tiremove_thisger.net"
          >>> m = re.search("remove_this", email)
          >>> email[:m.start()] + email[m.end():]
          'tony@tiger.net'

 -- Method: Match.span ([group])

     For a match `m', return the 2-tuple ‘(m.start(group),
     m.end(group))’.  Note that if `group' did not contribute to the
     match, this is ‘(-1, -1)’.  `group' defaults to zero, the entire
     match.

 -- Attribute: Match.pos

     The value of `pos' which was passed to the *note search(): 1695. or
     *note match(): 1694. method of a *note regex object: 890.  This is
     the index into the string at which the RE engine started looking
     for a match.

 -- Attribute: Match.endpos

     The value of `endpos' which was passed to the *note search(): 1695.
     or *note match(): 1694. method of a *note regex object: 890.  This
     is the index into the string beyond which the RE engine will not
     go.

 -- Attribute: Match.lastindex

     The integer index of the last matched capturing group, or ‘None’ if
     no group was matched at all.  For example, the expressions ‘(a)b’,
     ‘((a)(b))’, and ‘((ab))’ will have ‘lastindex == 1’ if applied to
     the string ‘'ab'’, while the expression ‘(a)(b)’ will have
     ‘lastindex == 2’, if applied to the same string.

 -- Attribute: Match.lastgroup

     The name of the last matched capturing group, or ‘None’ if the
     group didn’t have a name, or if no group was matched at all.

 -- Attribute: Match.re

     The *note regular expression object: 890. whose *note match():
     1694. or *note search(): 1695. method produced this match instance.

 -- Attribute: Match.string

     The string passed to *note match(): 1694. or *note search(): 1695.

Changed in version 3.7: Added support of *note copy.copy(): 3c0. and
*note copy.deepcopy(): 3c1.  Match objects are considered atomic.


File: python.info,  Node: Regular Expression Examples,  Prev: Match Objects,  Up: re — Regular expression operations

5.6.2.5 Regular Expression Examples
...................................

* Menu:

* Checking for a Pair::
* Simulating scanf(): Simulating scanf.
* search() vs. match(): search vs match.
* Making a Phonebook::
* Text Munging::
* Finding all Adverbs::
* Finding all Adverbs and their Positions::
* Raw String Notation::
* Writing a Tokenizer::


File: python.info,  Node: Checking for a Pair,  Next: Simulating scanf,  Up: Regular Expression Examples

5.6.2.6 Checking for a Pair
...........................

In this example, we’ll use the following helper function to display
match objects a little more gracefully:

     def displaymatch(match):
         if match is None:
             return None
         return '<Match: %r, groups=%r>' % (match.group(), match.groups())

Suppose you are writing a poker program where a player’s hand is
represented as a 5-character string with each character representing a
card, “a” for ace, “k” for king, “q” for queen, “j” for jack, “t” for
10, and “2” through “9” representing the card with that value.

To see if a given string is a valid hand, one could do the following:

     >>> valid = re.compile(r"^[a2-9tjqk]{5}$")
     >>> displaymatch(valid.match("akt5q"))  # Valid.
     "<Match: 'akt5q', groups=()>"
     >>> displaymatch(valid.match("akt5e"))  # Invalid.
     >>> displaymatch(valid.match("akt"))    # Invalid.
     >>> displaymatch(valid.match("727ak"))  # Valid.
     "<Match: '727ak', groups=()>"

That last hand, ‘"727ak"’, contained a pair, or two of the same valued
cards.  To match this with a regular expression, one could use
backreferences as such:

     >>> pair = re.compile(r".*(.).*\1")
     >>> displaymatch(pair.match("717ak"))     # Pair of 7s.
     "<Match: '717', groups=('7',)>"
     >>> displaymatch(pair.match("718ak"))     # No pairs.
     >>> displaymatch(pair.match("354aa"))     # Pair of aces.
     "<Match: '354aa', groups=('a',)>"

To find out what card the pair consists of, one could use the *note
group(): 16a9. method of the match object in the following manner:

     >>> pair = re.compile(r".*(.).*\1")
     >>> pair.match("717ak").group(1)
     '7'

     # Error because re.match() returns None, which doesn't have a group() method:
     >>> pair.match("718ak").group(1)
     Traceback (most recent call last):
       File "<pyshell#23>", line 1, in <module>
         re.match(r".*(.).*\1", "718ak").group(1)
     AttributeError: 'NoneType' object has no attribute 'group'

     >>> pair.match("354aa").group(1)
     'a'


File: python.info,  Node: Simulating scanf,  Next: search vs match,  Prev: Checking for a Pair,  Up: Regular Expression Examples

5.6.2.7 Simulating scanf()
..........................

Python does not currently have an equivalent to ‘scanf()’.  Regular
expressions are generally more powerful, though also more verbose, than
‘scanf()’ format strings.  The table below offers some more-or-less
equivalent mappings between ‘scanf()’ format tokens and regular
expressions.

‘scanf()’ Token                      Regular Expression
                                     
---------------------------------------------------------------------------------------
                                     
‘%c’                                 ‘.’
                                     
                                     
‘%5c’                                ‘.{5}’
                                     
                                     
‘%d’                                 ‘[-+]?\d+’
                                     
                                     
‘%e’, ‘%E’, ‘%f’, ‘%g’               ‘[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?’
                                     
                                     
‘%i’                                 ‘[-+]?(0[xX][\dA-Fa-f]+|0[0-7]*|\d+)’
                                     
                                     
‘%o’                                 ‘[-+]?[0-7]+’
                                     
                                     
‘%s’                                 ‘\S+’
                                     
                                     
‘%u’                                 ‘\d+’
                                     
                                     
‘%x’, ‘%X’                           ‘[-+]?(0[xX])?[\dA-Fa-f]+’
                                     

To extract the filename and numbers from a string like

     /usr/sbin/sendmail - 0 errors, 4 warnings

you would use a ‘scanf()’ format like

     %s - %d errors, %d warnings

The equivalent regular expression would be

     (\S+) - (\d+) errors, (\d+) warnings


File: python.info,  Node: search vs match,  Next: Making a Phonebook,  Prev: Simulating scanf,  Up: Regular Expression Examples

5.6.2.8 search() vs. match()
............................

Python offers two different primitive operations based on regular
expressions: *note re.match(): ba6. checks for a match only at the
beginning of the string, while *note re.search(): ba5. checks for a
match anywhere in the string (this is what Perl does by default).

For example:

     >>> re.match("c", "abcdef")    # No match
     >>> re.search("c", "abcdef")   # Match
     <re.Match object; span=(2, 3), match='c'>

Regular expressions beginning with ‘'^'’ can be used with *note
search(): ba5. to restrict the match at the beginning of the string:

     >>> re.match("c", "abcdef")    # No match
     >>> re.search("^c", "abcdef")  # No match
     >>> re.search("^a", "abcdef")  # Match
     <re.Match object; span=(0, 1), match='a'>

Note however that in *note MULTILINE: 168a. mode *note match(): ba6.
only matches at the beginning of the string, whereas using *note
search(): ba5. with a regular expression beginning with ‘'^'’ will match
at the beginning of each line.

     >>> re.match('X', 'A\nB\nX', re.MULTILINE)  # No match
     >>> re.search('^X', 'A\nB\nX', re.MULTILINE)  # Match
     <re.Match object; span=(4, 5), match='X'>


File: python.info,  Node: Making a Phonebook,  Next: Text Munging,  Prev: search vs match,  Up: Regular Expression Examples

5.6.2.9 Making a Phonebook
..........................

*note split(): 3bf. splits a string into a list delimited by the passed
pattern.  The method is invaluable for converting textual data into data
structures that can be easily read and modified by Python as
demonstrated in the following example that creates a phonebook.

First, here is the input.  Normally it may come from a file, here we are
using triple-quoted string syntax

     >>> text = """Ross McFluff: 834.345.1254 155 Elm Street
     ...
     ... Ronald Heathmore: 892.345.3428 436 Finley Avenue
     ... Frank Burger: 925.541.7625 662 South Dogwood Way
     ...
     ...
     ... Heather Albrecht: 548.326.4584 919 Park Place"""

The entries are separated by one or more newlines.  Now we convert the
string into a list with each nonempty line having its own entry:

     >>> entries = re.split("\n+", text)
     >>> entries
     ['Ross McFluff: 834.345.1254 155 Elm Street',
     'Ronald Heathmore: 892.345.3428 436 Finley Avenue',
     'Frank Burger: 925.541.7625 662 South Dogwood Way',
     'Heather Albrecht: 548.326.4584 919 Park Place']

Finally, split each entry into a list with first name, last name,
telephone number, and address.  We use the ‘maxsplit’ parameter of *note
split(): 3bf. because the address has spaces, our splitting pattern, in
it:

     >>> [re.split(":? ", entry, 3) for entry in entries]
     [['Ross', 'McFluff', '834.345.1254', '155 Elm Street'],
     ['Ronald', 'Heathmore', '892.345.3428', '436 Finley Avenue'],
     ['Frank', 'Burger', '925.541.7625', '662 South Dogwood Way'],
     ['Heather', 'Albrecht', '548.326.4584', '919 Park Place']]

The ‘:?’ pattern matches the colon after the last name, so that it does
not occur in the result list.  With a ‘maxsplit’ of ‘4’, we could
separate the house number from the street name:

     >>> [re.split(":? ", entry, 4) for entry in entries]
     [['Ross', 'McFluff', '834.345.1254', '155', 'Elm Street'],
     ['Ronald', 'Heathmore', '892.345.3428', '436', 'Finley Avenue'],
     ['Frank', 'Burger', '925.541.7625', '662', 'South Dogwood Way'],
     ['Heather', 'Albrecht', '548.326.4584', '919', 'Park Place']]


File: python.info,  Node: Text Munging,  Next: Finding all Adverbs,  Prev: Making a Phonebook,  Up: Regular Expression Examples

5.6.2.10 Text Munging
.....................

*note sub(): 470. replaces every occurrence of a pattern with a string
or the result of a function.  This example demonstrates using *note
sub(): 470. with a function to “munge” text, or randomize the order of
all the characters in each word of a sentence except for the first and
last characters:

     >>> def repl(m):
     ...     inner_word = list(m.group(2))
     ...     random.shuffle(inner_word)
     ...     return m.group(1) + "".join(inner_word) + m.group(3)
     >>> text = "Professor Abdolmalek, please report your absences promptly."
     >>> re.sub(r"(\w)(\w+)(\w)", repl, text)
     'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.'
     >>> re.sub(r"(\w)(\w+)(\w)", repl, text)
     'Pofsroser Aodlambelk, plasee reoprt yuor asnebces potlmrpy.'


File: python.info,  Node: Finding all Adverbs,  Next: Finding all Adverbs and their Positions,  Prev: Text Munging,  Up: Regular Expression Examples

5.6.2.11 Finding all Adverbs
............................

*note findall(): 957. matches `all' occurrences of a pattern, not just
the first one as *note search(): ba5. does.  For example, if a writer
wanted to find all of the adverbs in some text, they might use *note
findall(): 957. in the following manner:

     >>> text = "He was carefully disguised but captured quickly by police."
     >>> re.findall(r"\w+ly", text)
     ['carefully', 'quickly']


File: python.info,  Node: Finding all Adverbs and their Positions,  Next: Raw String Notation,  Prev: Finding all Adverbs,  Up: Regular Expression Examples

5.6.2.12 Finding all Adverbs and their Positions
................................................

If one wants more information about all matches of a pattern than the
matched text, *note finditer(): 169a. is useful as it provides *note
match objects: 891. instead of strings.  Continuing with the previous
example, if a writer wanted to find all of the adverbs `and their
positions' in some text, they would use *note finditer(): 169a. in the
following manner:

     >>> text = "He was carefully disguised but captured quickly by police."
     >>> for m in re.finditer(r"\w+ly", text):
     ...     print('%02d-%02d: %s' % (m.start(), m.end(), m.group(0)))
     07-16: carefully
     40-47: quickly


File: python.info,  Node: Raw String Notation,  Next: Writing a Tokenizer,  Prev: Finding all Adverbs and their Positions,  Up: Regular Expression Examples

5.6.2.13 Raw String Notation
............................

Raw string notation (‘r"text"’) keeps regular expressions sane.  Without
it, every backslash (‘'\'’) in a regular expression would have to be
prefixed with another one to escape it.  For example, the two following
lines of code are functionally identical:

     >>> re.match(r"\W(.)\1\W", " ff ")
     <re.Match object; span=(0, 4), match=' ff '>
     >>> re.match("\\W(.)\\1\\W", " ff ")
     <re.Match object; span=(0, 4), match=' ff '>

When one wants to match a literal backslash, it must be escaped in the
regular expression.  With raw string notation, this means ‘r"\\"’.
Without raw string notation, one must use ‘"\\\\"’, making the following
lines of code functionally identical:

     >>> re.match(r"\\", r"\\")
     <re.Match object; span=(0, 1), match='\\'>
     >>> re.match("\\\\", r"\\")
     <re.Match object; span=(0, 1), match='\\'>


File: python.info,  Node: Writing a Tokenizer,  Prev: Raw String Notation,  Up: Regular Expression Examples

5.6.2.14 Writing a Tokenizer
............................

A tokenizer or scanner(1) analyzes a string to categorize groups of
characters.  This is a useful first step in writing a compiler or
interpreter.

The text categories are specified with regular expressions.  The
technique is to combine those into a single master regular expression
and to loop over successive matches:

     import collections
     import re

     Token = collections.namedtuple('Token', ['type', 'value', 'line', 'column'])

     def tokenize(code):
         keywords = {'IF', 'THEN', 'ENDIF', 'FOR', 'NEXT', 'GOSUB', 'RETURN'}
         token_specification = [
             ('NUMBER',   r'\d+(\.\d*)?'),  # Integer or decimal number
             ('ASSIGN',   r':='),           # Assignment operator
             ('END',      r';'),            # Statement terminator
             ('ID',       r'[A-Za-z]+'),    # Identifiers
             ('OP',       r'[+\-*/]'),      # Arithmetic operators
             ('NEWLINE',  r'\n'),           # Line endings
             ('SKIP',     r'[ \t]+'),       # Skip over spaces and tabs
             ('MISMATCH', r'.'),            # Any other character
         ]
         tok_regex = '|'.join('(?P<%s>%s)' % pair for pair in token_specification)
         line_num = 1
         line_start = 0
         for mo in re.finditer(tok_regex, code):
             kind = mo.lastgroup
             value = mo.group()
             column = mo.start() - line_start
             if kind == 'NUMBER':
                 value = float(value) if '.' in value else int(value)
             elif kind == 'ID' and value in keywords:
                 kind = value
             elif kind == 'NEWLINE':
                 line_start = mo.end()
                 line_num += 1
                 continue
             elif kind == 'SKIP':
                 continue
             elif kind == 'MISMATCH':
                 raise RuntimeError(f'{value!r} unexpected on line {line_num}')
             yield Token(kind, value, line_num, column)

     statements = '''
         IF quantity THEN
             total := total + price * quantity;
             tax := price * 0.05;
         ENDIF;
     '''

     for token in tokenize(statements):
         print(token)

The tokenizer produces the following output:

     Token(type='IF', value='IF', line=2, column=4)
     Token(type='ID', value='quantity', line=2, column=7)
     Token(type='THEN', value='THEN', line=2, column=16)
     Token(type='ID', value='total', line=3, column=8)
     Token(type='ASSIGN', value=':=', line=3, column=14)
     Token(type='ID', value='total', line=3, column=17)
     Token(type='OP', value='+', line=3, column=23)
     Token(type='ID', value='price', line=3, column=25)
     Token(type='OP', value='*', line=3, column=31)
     Token(type='ID', value='quantity', line=3, column=33)
     Token(type='END', value=';', line=3, column=41)
     Token(type='ID', value='tax', line=4, column=8)
     Token(type='ASSIGN', value=':=', line=4, column=12)
     Token(type='ID', value='price', line=4, column=15)
     Token(type='OP', value='*', line=4, column=21)
     Token(type='NUMBER', value=0.05, line=4, column=23)
     Token(type='END', value=';', line=4, column=27)
     Token(type='ENDIF', value='ENDIF', line=5, column=4)
     Token(type='END', value=';', line=5, column=9)

(Frie09) Friedl, Jeffrey.  Mastering Regular Expressions.  3rd ed.,
O’Reilly Media, 2009.  The third edition of the book no longer covers
Python at all, but the first edition covered writing good regular
expression patterns in great detail.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Lexical_analysis


File: python.info,  Node: difflib — Helpers for computing deltas,  Next: textwrap — Text wrapping and filling,  Prev: re — Regular expression operations,  Up: Text Processing Services

5.6.3 ‘difflib’ — Helpers for computing deltas
----------------------------------------------

`Source code:' Lib/difflib.py(1)

__________________________________________________________________

This module provides classes and functions for comparing sequences.  It
can be used for example, for comparing files, and can produce difference
information in various formats, including HTML and context and unified
diffs.  For comparing directories and files, see also, the *note
filecmp: 7f. module.

 -- Class: difflib.SequenceMatcher

     This is a flexible class for comparing pairs of sequences of any
     type, so long as the sequence elements are *note hashable: 1364.
     The basic algorithm predates, and is a little fancier than, an
     algorithm published in the late 1980’s by Ratcliff and Obershelp
     under the hyperbolic name “gestalt pattern matching.” The idea is
     to find the longest contiguous matching subsequence that contains
     no “junk” elements; these “junk” elements are ones that are
     uninteresting in some sense, such as blank lines or whitespace.
     (Handling junk is an extension to the Ratcliff and Obershelp
     algorithm.)  The same idea is then applied recursively to the
     pieces of the sequences to the left and to the right of the
     matching subsequence.  This does not yield minimal edit sequences,
     but does tend to yield matches that “look right” to people.

     `Timing:' The basic Ratcliff-Obershelp algorithm is cubic time in
     the worst case and quadratic time in the expected case.  *note
     SequenceMatcher: 943. is quadratic time for the worst case and has
     expected-case behavior dependent in a complicated way on how many
     elements the sequences have in common; best case time is linear.

     `Automatic junk heuristic:' *note SequenceMatcher: 943. supports a
     heuristic that automatically treats certain sequence items as junk.
     The heuristic counts how many times each individual item appears in
     the sequence.  If an item’s duplicates (after the first one)
     account for more than 1% of the sequence and the sequence is at
     least 200 items long, this item is marked as “popular” and is
     treated as junk for the purpose of sequence matching.  This
     heuristic can be turned off by setting the ‘autojunk’ argument to
     ‘False’ when creating the *note SequenceMatcher: 943.

     New in version 3.2: The `autojunk' parameter.

 -- Class: difflib.Differ

     This is a class for comparing sequences of lines of text, and
     producing human-readable differences or deltas.  Differ uses *note
     SequenceMatcher: 943. both to compare sequences of lines, and to
     compare sequences of characters within similar (near-matching)
     lines.

     Each line of a *note Differ: 16c2. delta begins with a two-letter
     code:

     Code           Meaning
                    
     ---------------------------------------------------------------
                    
     ‘'- '’         line unique to sequence 1
                    
                    
     ‘'+ '’         line unique to sequence 2
                    
                    
     ‘' '’          line common to both sequences
                    
                    
     ‘'? '’         line not present in either input sequence
                    

     Lines beginning with ‘‘?’’ attempt to guide the eye to intraline
     differences, and were not present in either input sequence.  These
     lines can be confusing if the sequences contain tab characters.

 -- Class: difflib.HtmlDiff

     This class can be used to create an HTML table (or a complete HTML
     file containing the table) showing a side by side, line by line
     comparison of text with inter-line and intra-line change
     highlights.  The table can be generated in either full or
     contextual difference mode.

     The constructor for this class is:

      -- Method: __init__ (tabsize=8, wrapcolumn=None, linejunk=None,
               charjunk=IS_CHARACTER_JUNK)

          Initializes instance of *note HtmlDiff: 16c3.

          `tabsize' is an optional keyword argument to specify tab stop
          spacing and defaults to ‘8’.

          `wrapcolumn' is an optional keyword to specify column number
          where lines are broken and wrapped, defaults to ‘None’ where
          lines are not wrapped.

          `linejunk' and `charjunk' are optional keyword arguments
          passed into *note ndiff(): 16c5. (used by *note HtmlDiff:
          16c3. to generate the side by side HTML differences).  See
          *note ndiff(): 16c5. documentation for argument default values
          and descriptions.

     The following methods are public:

      -- Method: make_file (fromlines, tolines, fromdesc='', todesc='',
               context=False, numlines=5, *, charset='utf-8')

          Compares `fromlines' and `tolines' (lists of strings) and
          returns a string which is a complete HTML file containing a
          table showing line by line differences with inter-line and
          intra-line changes highlighted.

          `fromdesc' and `todesc' are optional keyword arguments to
          specify from/to file column header strings (both default to an
          empty string).

          `context' and `numlines' are both optional keyword arguments.
          Set `context' to ‘True’ when contextual differences are to be
          shown, else the default is ‘False’ to show the full files.
          `numlines' defaults to ‘5’.  When `context' is ‘True’
          `numlines' controls the number of context lines which surround
          the difference highlights.  When `context' is ‘False’
          `numlines' controls the number of lines which are shown before
          a difference highlight when using the “next” hyperlinks
          (setting to zero would cause the “next” hyperlinks to place
          the next difference highlight at the top of the browser
          without any leading context).

               Note: `fromdesc' and `todesc' are interpreted as
               unescaped HTML and should be properly escaped while
               receiving input from untrusted sources.

          Changed in version 3.5: `charset' keyword-only argument was
          added.  The default charset of HTML document changed from
          ‘'ISO-8859-1'’ to ‘'utf-8'’.

      -- Method: make_table (fromlines, tolines, fromdesc='', todesc='',
               context=False, numlines=5)

          Compares `fromlines' and `tolines' (lists of strings) and
          returns a string which is a complete HTML table showing line
          by line differences with inter-line and intra-line changes
          highlighted.

          The arguments for this method are the same as those for the
          *note make_file(): 6bd. method.

     ‘Tools/scripts/diff.py’ is a command-line front-end to this class
     and contains a good example of its use.

 -- Function: difflib.context_diff (a, b, fromfile='', tofile='',
          fromfiledate='', tofiledate='', n=3, lineterm='\n')

     Compare `a' and `b' (lists of strings); return a delta (a *note
     generator: 996. generating the delta lines) in context diff format.

     Context diffs are a compact way of showing just the lines that have
     changed plus a few lines of context.  The changes are shown in a
     before/after style.  The number of context lines is set by `n'
     which defaults to three.

     By default, the diff control lines (those with ‘***’ or ‘---’) are
     created with a trailing newline.  This is helpful so that inputs
     created from *note io.IOBase.readlines(): 16c8. result in diffs
     that are suitable for use with *note io.IOBase.writelines(): 16c9.
     since both the inputs and outputs have trailing newlines.

     For inputs that do not have trailing newlines, set the `lineterm'
     argument to ‘""’ so that the output will be uniformly newline free.

     The context diff format normally has a header for filenames and
     modification times.  Any or all of these may be specified using
     strings for `fromfile', `tofile', `fromfiledate', and `tofiledate'.
     The modification times are normally expressed in the ISO 8601
     format.  If not specified, the strings default to blanks.

          >>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
          >>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
          >>> sys.stdout.writelines(context_diff(s1, s2, fromfile='before.py', tofile='after.py'))
          *** before.py
          --- after.py
          ***************
          *** 1,4 ****
          ! bacon
          ! eggs
          ! ham
            guido
          --- 1,4 ----
          ! python
          ! eggy
          ! hamster
            guido

     See *note A command-line interface to difflib: 16ca. for a more
     detailed example.

 -- Function: difflib.get_close_matches (word, possibilities, n=3,
          cutoff=0.6)

     Return a list of the best “good enough” matches.  `word' is a
     sequence for which close matches are desired (typically a string),
     and `possibilities' is a list of sequences against which to match
     `word' (typically a list of strings).

     Optional argument `n' (default ‘3’) is the maximum number of close
     matches to return; `n' must be greater than ‘0’.

     Optional argument `cutoff' (default ‘0.6’) is a float in the range
     [0, 1].  Possibilities that don’t score at least that similar to
     `word' are ignored.

     The best (no more than `n') matches among the possibilities are
     returned in a list, sorted by similarity score, most similar first.

          >>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy'])
          ['apple', 'ape']
          >>> import keyword
          >>> get_close_matches('wheel', keyword.kwlist)
          ['while']
          >>> get_close_matches('pineapple', keyword.kwlist)
          []
          >>> get_close_matches('accept', keyword.kwlist)
          ['except']

 -- Function: difflib.ndiff (a, b, linejunk=None,
          charjunk=IS_CHARACTER_JUNK)

     Compare `a' and `b' (lists of strings); return a *note Differ:
     16c2.-style delta (a *note generator: 996. generating the delta
     lines).

     Optional keyword parameters `linejunk' and `charjunk' are filtering
     functions (or ‘None’):

     `linejunk': A function that accepts a single string argument, and
     returns true if the string is junk, or false if not.  The default
     is ‘None’.  There is also a module-level function *note
     IS_LINE_JUNK(): 16cc, which filters out lines without visible
     characters, except for at most one pound character (‘'#'’) –
     however the underlying *note SequenceMatcher: 943. class does a
     dynamic analysis of which lines are so frequent as to constitute
     noise, and this usually works better than using this function.

     `charjunk': A function that accepts a character (a string of length
     1), and returns if the character is junk, or false if not.  The
     default is module-level function *note IS_CHARACTER_JUNK(): 16cd,
     which filters out whitespace characters (a blank or tab; it’s a bad
     idea to include newline in this!).

     ‘Tools/scripts/ndiff.py’ is a command-line front-end to this
     function.

          >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
          ...              'ore\ntree\nemu\n'.splitlines(keepends=True))
          >>> print(''.join(diff), end="")
          - one
          ?  ^
          + ore
          ?  ^
          - two
          - three
          ?  -
          + tree
          + emu

 -- Function: difflib.restore (sequence, which)

     Return one of the two sequences that generated a delta.

     Given a `sequence' produced by *note Differ.compare(): 16cf. or
     *note ndiff(): 16c5, extract lines originating from file 1 or 2
     (parameter `which'), stripping off line prefixes.

     Example:

          >>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
          ...              'ore\ntree\nemu\n'.splitlines(keepends=True))
          >>> diff = list(diff) # materialize the generated delta into a list
          >>> print(''.join(restore(diff, 1)), end="")
          one
          two
          three
          >>> print(''.join(restore(diff, 2)), end="")
          ore
          tree
          emu

 -- Function: difflib.unified_diff (a, b, fromfile='', tofile='',
          fromfiledate='', tofiledate='', n=3, lineterm='\n')

     Compare `a' and `b' (lists of strings); return a delta (a *note
     generator: 996. generating the delta lines) in unified diff format.

     Unified diffs are a compact way of showing just the lines that have
     changed plus a few lines of context.  The changes are shown in an
     inline style (instead of separate before/after blocks).  The number
     of context lines is set by `n' which defaults to three.

     By default, the diff control lines (those with ‘---’, ‘+++’, or
     ‘@@’) are created with a trailing newline.  This is helpful so that
     inputs created from *note io.IOBase.readlines(): 16c8. result in
     diffs that are suitable for use with *note io.IOBase.writelines():
     16c9. since both the inputs and outputs have trailing newlines.

     For inputs that do not have trailing newlines, set the `lineterm'
     argument to ‘""’ so that the output will be uniformly newline free.

     The context diff format normally has a header for filenames and
     modification times.  Any or all of these may be specified using
     strings for `fromfile', `tofile', `fromfiledate', and `tofiledate'.
     The modification times are normally expressed in the ISO 8601
     format.  If not specified, the strings default to blanks.

          >>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
          >>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
          >>> sys.stdout.writelines(unified_diff(s1, s2, fromfile='before.py', tofile='after.py'))
          --- before.py
          +++ after.py
          @@ -1,4 +1,4 @@
          -bacon
          -eggs
          -ham
          +python
          +eggy
          +hamster
           guido

     See *note A command-line interface to difflib: 16ca. for a more
     detailed example.

 -- Function: difflib.diff_bytes (dfunc, a, b, fromfile=b'', tofile=b'',
          fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\n')

     Compare `a' and `b' (lists of bytes objects) using `dfunc'; yield a
     sequence of delta lines (also bytes) in the format returned by
     `dfunc'.  `dfunc' must be a callable, typically either *note
     unified_diff(): 16d0. or *note context_diff(): 16c7.

     Allows you to compare data with unknown or inconsistent encoding.
     All inputs except `n' must be bytes objects, not str.  Works by
     losslessly converting all inputs (except `n') to str, and calling
     ‘dfunc(a, b, fromfile, tofile, fromfiledate, tofiledate, n,
     lineterm)’.  The output of `dfunc' is then converted back to bytes,
     so the delta lines that you receive have the same
     unknown/inconsistent encodings as `a' and `b'.

     New in version 3.5.

 -- Function: difflib.IS_LINE_JUNK (line)

     Return ‘True’ for ignorable lines.  The line `line' is ignorable if
     `line' is blank or contains a single ‘'#'’, otherwise it is not
     ignorable.  Used as a default for parameter `linejunk' in *note
     ndiff(): 16c5. in older versions.

 -- Function: difflib.IS_CHARACTER_JUNK (ch)

     Return ‘True’ for ignorable characters.  The character `ch' is
     ignorable if `ch' is a space or tab, otherwise it is not ignorable.
     Used as a default for parameter `charjunk' in *note ndiff(): 16c5.

See also
........

Pattern Matching: The Gestalt Approach(2)

     Discussion of a similar algorithm by John W. Ratcliff and D. E.
     Metzener.  This was published in Dr.  Dobb’s Journal(3) in July,
     1988.

* Menu:

* SequenceMatcher Objects::
* SequenceMatcher Examples::
* Differ Objects::
* Differ Example::
* A command-line interface to difflib::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/difflib.py

   (2) 
http://www.drdobbs.com/database/pattern-matching-the-gestalt-approach/184407970

   (3) http://www.drdobbs.com/


File: python.info,  Node: SequenceMatcher Objects,  Next: SequenceMatcher Examples,  Up: difflib — Helpers for computing deltas

5.6.3.1 SequenceMatcher Objects
...............................

The *note SequenceMatcher: 943. class has this constructor:

 -- Class: difflib.SequenceMatcher (isjunk=None, a='', b='',
          autojunk=True)

     Optional argument `isjunk' must be ‘None’ (the default) or a
     one-argument function that takes a sequence element and returns
     true if and only if the element is “junk” and should be ignored.
     Passing ‘None’ for `isjunk' is equivalent to passing ‘lambda x:
     False’; in other words, no elements are ignored.  For example,
     pass:

          lambda x: x in " \t"

     if you’re comparing lines as sequences of characters, and don’t
     want to synch up on blanks or hard tabs.

     The optional arguments `a' and `b' are sequences to be compared;
     both default to empty strings.  The elements of both sequences must
     be *note hashable: 1364.

     The optional argument `autojunk' can be used to disable the
     automatic junk heuristic.

     New in version 3.2: The `autojunk' parameter.

     SequenceMatcher objects get three data attributes: `bjunk' is the
     set of elements of `b' for which `isjunk' is ‘True’; `bpopular' is
     the set of non-junk elements considered popular by the heuristic
     (if it is not disabled); `b2j' is a dict mapping the remaining
     elements of `b' to a list of positions where they occur.  All three
     are reset whenever `b' is reset with *note set_seqs(): 16d3. or
     *note set_seq2(): 16d4.

     New in version 3.2: The `bjunk' and `bpopular' attributes.

     *note SequenceMatcher: 943. objects have the following methods:

      -- Method: set_seqs (a, b)

          Set the two sequences to be compared.

     *note SequenceMatcher: 943. computes and caches detailed
     information about the second sequence, so if you want to compare
     one sequence against many sequences, use *note set_seq2(): 16d4. to
     set the commonly used sequence once and call *note set_seq1():
     16d5. repeatedly, once for each of the other sequences.

      -- Method: set_seq1 (a)

          Set the first sequence to be compared.  The second sequence to
          be compared is not changed.

      -- Method: set_seq2 (b)

          Set the second sequence to be compared.  The first sequence to
          be compared is not changed.

      -- Method: find_longest_match (alo, ahi, blo, bhi)

          Find longest matching block in ‘a[alo:ahi]’ and ‘b[blo:bhi]’.

          If `isjunk' was omitted or ‘None’, *note find_longest_match():
          16d6. returns ‘(i, j, k)’ such that ‘a[i:i+k]’ is equal to
          ‘b[j:j+k]’, where ‘alo <= i <= i+k <= ahi’ and ‘blo <= j <=
          j+k <= bhi’.  For all ‘(i', j', k')’ meeting those conditions,
          the additional conditions ‘k >= k'’, ‘i <= i'’, and if ‘i ==
          i'’, ‘j <= j'’ are also met.  In other words, of all maximal
          matching blocks, return one that starts earliest in `a', and
          of all those maximal matching blocks that start earliest in
          `a', return the one that starts earliest in `b'.

               >>> s = SequenceMatcher(None, " abcd", "abcd abcd")
               >>> s.find_longest_match(0, 5, 0, 9)
               Match(a=0, b=4, size=5)

          If `isjunk' was provided, first the longest matching block is
          determined as above, but with the additional restriction that
          no junk element appears in the block.  Then that block is
          extended as far as possible by matching (only) junk elements
          on both sides.  So the resulting block never matches on junk
          except as identical junk happens to be adjacent to an
          interesting match.

          Here’s the same example as before, but considering blanks to
          be junk.  That prevents ‘' abcd'’ from matching the ‘' abcd'’
          at the tail end of the second sequence directly.  Instead only
          the ‘'abcd'’ can match, and matches the leftmost ‘'abcd'’ in
          the second sequence:

               >>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
               >>> s.find_longest_match(0, 5, 0, 9)
               Match(a=1, b=0, size=4)

          If no blocks match, this returns ‘(alo, blo, 0)’.

          This method returns a *note named tuple: a98. ‘Match(a, b,
          size)’.

      -- Method: get_matching_blocks ()

          Return list of triples describing non-overlapping matching
          subsequences.  Each triple is of the form ‘(i, j, n)’, and
          means that ‘a[i:i+n] == b[j:j+n]’.  The triples are
          monotonically increasing in `i' and `j'.

          The last triple is a dummy, and has the value ‘(len(a),
          len(b), 0)’.  It is the only triple with ‘n == 0’.  If ‘(i, j,
          n)’ and ‘(i', j', n')’ are adjacent triples in the list, and
          the second is not the last triple in the list, then ‘i+n < i'’
          or ‘j+n < j'’; in other words, adjacent triples always
          describe non-adjacent equal blocks.

               >>> s = SequenceMatcher(None, "abxcd", "abcd")
               >>> s.get_matching_blocks()
               [Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]

      -- Method: get_opcodes ()

          Return list of 5-tuples describing how to turn `a' into `b'.
          Each tuple is of the form ‘(tag, i1, i2, j1, j2)’.  The first
          tuple has ‘i1 == j1 == 0’, and remaining tuples have `i1'
          equal to the `i2' from the preceding tuple, and, likewise,
          `j1' equal to the previous `j2'.

          The `tag' values are strings, with these meanings:

          Value               Meaning
                              
          ----------------------------------------------------------------------
                              
          ‘'replace'’         ‘a[i1:i2]’ should be replaced by ‘b[j1:j2]’.
                              
                              
          ‘'delete'’          ‘a[i1:i2]’ should be deleted.  Note that ‘j1 ==
                              j2’ in this case.
                              
                              
          ‘'insert'’          ‘b[j1:j2]’ should be inserted at ‘a[i1:i1]’.
                              Note that ‘i1 == i2’ in this case.
                              
                              
          ‘'equal'’           ‘a[i1:i2] == b[j1:j2]’ (the sub-sequences are
                              equal).
                              

          For example:

               >>> a = "qabxcd"
               >>> b = "abycdf"
               >>> s = SequenceMatcher(None, a, b)
               >>> for tag, i1, i2, j1, j2 in s.get_opcodes():
               ...     print('{:7}   a[{}:{}] --> b[{}:{}] {!r:>8} --> {!r}'.format(
               ...         tag, i1, i2, j1, j2, a[i1:i2], b[j1:j2]))
               delete    a[0:1] --> b[0:0]      'q' --> ''
               equal     a[1:3] --> b[0:2]     'ab' --> 'ab'
               replace   a[3:4] --> b[2:3]      'x' --> 'y'
               equal     a[4:6] --> b[3:5]     'cd' --> 'cd'
               insert    a[6:6] --> b[5:6]       '' --> 'f'

      -- Method: get_grouped_opcodes (n=3)

          Return a *note generator: 996. of groups with up to `n' lines
          of context.

          Starting with the groups returned by *note get_opcodes():
          16d8, this method splits out smaller change clusters and
          eliminates intervening ranges which have no changes.

          The groups are returned in the same format as *note
          get_opcodes(): 16d8.

      -- Method: ratio ()

          Return a measure of the sequences’ similarity as a float in
          the range [0, 1].

          Where T is the total number of elements in both sequences, and
          M is the number of matches, this is 2.0*M / T. Note that this
          is ‘1.0’ if the sequences are identical, and ‘0.0’ if they
          have nothing in common.

          This is expensive to compute if *note get_matching_blocks():
          16d7. or *note get_opcodes(): 16d8. hasn’t already been
          called, in which case you may want to try *note quick_ratio():
          16db. or *note real_quick_ratio(): 16dc. first to get an upper
          bound.

               Note: Caution: The result of a *note ratio(): 16da. call
               may depend on the order of the arguments.  For instance:

                    >>> SequenceMatcher(None, 'tide', 'diet').ratio()
                    0.25
                    >>> SequenceMatcher(None, 'diet', 'tide').ratio()
                    0.5

      -- Method: quick_ratio ()

          Return an upper bound on *note ratio(): 16da. relatively
          quickly.

      -- Method: real_quick_ratio ()

          Return an upper bound on *note ratio(): 16da. very quickly.

The three methods that return the ratio of matching to total characters
can give different results due to differing levels of approximation,
although ‘quick_ratio()’ and ‘real_quick_ratio()’ are always at least as
large as ‘ratio()’:

     >>> s = SequenceMatcher(None, "abcd", "bcde")
     >>> s.ratio()
     0.75
     >>> s.quick_ratio()
     0.75
     >>> s.real_quick_ratio()
     1.0


File: python.info,  Node: SequenceMatcher Examples,  Next: Differ Objects,  Prev: SequenceMatcher Objects,  Up: difflib — Helpers for computing deltas

5.6.3.2 SequenceMatcher Examples
................................

This example compares two strings, considering blanks to be “junk”:

     >>> s = SequenceMatcher(lambda x: x == " ",
     ...                     "private Thread currentThread;",
     ...                     "private volatile Thread currentThread;")

‘ratio()’ returns a float in [0, 1], measuring the similarity of the
sequences.  As a rule of thumb, a ‘ratio()’ value over 0.6 means the
sequences are close matches:

     >>> print(round(s.ratio(), 3))
     0.866

If you’re only interested in where the sequences match,
‘get_matching_blocks()’ is handy:

     >>> for block in s.get_matching_blocks():
     ...     print("a[%d] and b[%d] match for %d elements" % block)
     a[0] and b[0] match for 8 elements
     a[8] and b[17] match for 21 elements
     a[29] and b[38] match for 0 elements

Note that the last tuple returned by ‘get_matching_blocks()’ is always a
dummy, ‘(len(a), len(b), 0)’, and this is the only case in which the
last tuple element (number of elements matched) is ‘0’.

If you want to know how to change the first sequence into the second,
use ‘get_opcodes()’:

     >>> for opcode in s.get_opcodes():
     ...     print("%6s a[%d:%d] b[%d:%d]" % opcode)
      equal a[0:8] b[0:8]
     insert a[8:8] b[8:17]
      equal a[8:29] b[17:38]

See also
........

   * The *note get_close_matches(): 16cb. function in this module which
     shows how simple code building on *note SequenceMatcher: 943. can
     be used to do useful work.

   * Simple version control recipe(1) for a small application built with
     *note SequenceMatcher: 943.

   ---------- Footnotes ----------

   (1) https://code.activestate.com/recipes/576729/


File: python.info,  Node: Differ Objects,  Next: Differ Example,  Prev: SequenceMatcher Examples,  Up: difflib — Helpers for computing deltas

5.6.3.3 Differ Objects
......................

Note that *note Differ: 16c2.-generated deltas make no claim to be
`minimal' diffs.  To the contrary, minimal diffs are often
counter-intuitive, because they synch up anywhere possible, sometimes
accidental matches 100 pages apart.  Restricting synch points to
contiguous matches preserves some notion of locality, at the occasional
cost of producing a longer diff.

The *note Differ: 16c2. class has this constructor:

 -- Class: difflib.Differ (linejunk=None, charjunk=None)

     Optional keyword parameters `linejunk' and `charjunk' are for
     filter functions (or ‘None’):

     `linejunk': A function that accepts a single string argument, and
     returns true if the string is junk.  The default is ‘None’, meaning
     that no line is considered junk.

     `charjunk': A function that accepts a single character argument (a
     string of length 1), and returns true if the character is junk.
     The default is ‘None’, meaning that no character is considered
     junk.

     These junk-filtering functions speed up matching to find
     differences and do not cause any differing lines or characters to
     be ignored.  Read the description of the *note
     find_longest_match(): 16d6. method’s `isjunk' parameter for an
     explanation.

     *note Differ: 16c2. objects are used (deltas generated) via a
     single method:

      -- Method: compare (a, b)

          Compare two sequences of lines, and generate the delta (a
          sequence of lines).

          Each sequence must contain individual single-line strings
          ending with newlines.  Such sequences can be obtained from the
          *note readlines(): 16c8. method of file-like objects.  The
          delta generated also consists of newline-terminated strings,
          ready to be printed as-is via the *note writelines(): 16c9.
          method of a file-like object.


File: python.info,  Node: Differ Example,  Next: A command-line interface to difflib,  Prev: Differ Objects,  Up: difflib — Helpers for computing deltas

5.6.3.4 Differ Example
......................

This example compares two texts.  First we set up the texts, sequences
of individual single-line strings ending with newlines (such sequences
can also be obtained from the ‘readlines()’ method of file-like
objects):

     >>> text1 = '''  1. Beautiful is better than ugly.
     ...   2. Explicit is better than implicit.
     ...   3. Simple is better than complex.
     ...   4. Complex is better than complicated.
     ... '''.splitlines(keepends=True)
     >>> len(text1)
     4
     >>> text1[0][-1]
     '\n'
     >>> text2 = '''  1. Beautiful is better than ugly.
     ...   3.   Simple is better than complex.
     ...   4. Complicated is better than complex.
     ...   5. Flat is better than nested.
     ... '''.splitlines(keepends=True)

Next we instantiate a Differ object:

     >>> d = Differ()

Note that when instantiating a *note Differ: 16c2. object we may pass
functions to filter out line and character “junk.” See the *note
Differ(): 16c2. constructor for details.

Finally, we compare the two:

     >>> result = list(d.compare(text1, text2))

‘result’ is a list of strings, so let’s pretty-print it:

     >>> from pprint import pprint
     >>> pprint(result)
     ['    1. Beautiful is better than ugly.\n',
      '-   2. Explicit is better than implicit.\n',
      '-   3. Simple is better than complex.\n',
      '+   3.   Simple is better than complex.\n',
      '?     ++\n',
      '-   4. Complex is better than complicated.\n',
      '?            ^                     ---- ^\n',
      '+   4. Complicated is better than complex.\n',
      '?           ++++ ^                      ^\n',
      '+   5. Flat is better than nested.\n']

As a single multi-line string it looks like this:

     >>> import sys
     >>> sys.stdout.writelines(result)
         1. Beautiful is better than ugly.
     -   2. Explicit is better than implicit.
     -   3. Simple is better than complex.
     +   3.   Simple is better than complex.
     ?     ++
     -   4. Complex is better than complicated.
     ?            ^                     ---- ^
     +   4. Complicated is better than complex.
     ?           ++++ ^                      ^
     +   5. Flat is better than nested.


File: python.info,  Node: A command-line interface to difflib,  Prev: Differ Example,  Up: difflib — Helpers for computing deltas

5.6.3.5 A command-line interface to difflib
...........................................

This example shows how to use difflib to create a ‘diff’-like utility.
It is also contained in the Python source distribution, as
‘Tools/scripts/diff.py’.

     #!/usr/bin/env python3
     """ Command line interface to difflib.py providing diffs in four formats:

     * ndiff:    lists every line and highlights interline changes.
     * context:  highlights clusters of changes in a before/after format.
     * unified:  highlights clusters of changes in an inline format.
     * html:     generates side by side comparison with change highlights.

     """

     import sys, os, difflib, argparse
     from datetime import datetime, timezone

     def file_mtime(path):
         t = datetime.fromtimestamp(os.stat(path).st_mtime,
                                    timezone.utc)
         return t.astimezone().isoformat()

     def main():

         parser = argparse.ArgumentParser()
         parser.add_argument('-c', action='store_true', default=False,
                             help='Produce a context format diff (default)')
         parser.add_argument('-u', action='store_true', default=False,
                             help='Produce a unified format diff')
         parser.add_argument('-m', action='store_true', default=False,
                             help='Produce HTML side by side diff '
                                  '(can use -c and -l in conjunction)')
         parser.add_argument('-n', action='store_true', default=False,
                             help='Produce a ndiff format diff')
         parser.add_argument('-l', '--lines', type=int, default=3,
                             help='Set number of context lines (default 3)')
         parser.add_argument('fromfile')
         parser.add_argument('tofile')
         options = parser.parse_args()

         n = options.lines
         fromfile = options.fromfile
         tofile = options.tofile

         fromdate = file_mtime(fromfile)
         todate = file_mtime(tofile)
         with open(fromfile) as ff:
             fromlines = ff.readlines()
         with open(tofile) as tf:
             tolines = tf.readlines()

         if options.u:
             diff = difflib.unified_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)
         elif options.n:
             diff = difflib.ndiff(fromlines, tolines)
         elif options.m:
             diff = difflib.HtmlDiff().make_file(fromlines,tolines,fromfile,tofile,context=options.c,numlines=n)
         else:
             diff = difflib.context_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)

         sys.stdout.writelines(diff)

     if __name__ == '__main__':
         main()


File: python.info,  Node: textwrap — Text wrapping and filling,  Next: unicodedata — Unicode Database,  Prev: difflib — Helpers for computing deltas,  Up: Text Processing Services

5.6.4 ‘textwrap’ — Text wrapping and filling
--------------------------------------------

`Source code:' Lib/textwrap.py(1)

__________________________________________________________________

The *note textwrap: 108. module provides some convenience functions, as
well as *note TextWrapper: 8de, the class that does all the work.  If
you’re just wrapping or filling one or two text strings, the convenience
functions should be good enough; otherwise, you should use an instance
of *note TextWrapper: 8de. for efficiency.

 -- Function: textwrap.wrap (text, width=70, **kwargs)

     Wraps the single paragraph in `text' (a string) so every line is at
     most `width' characters long.  Returns a list of output lines,
     without final newlines.

     Optional keyword arguments correspond to the instance attributes of
     *note TextWrapper: 8de, documented below.  `width' defaults to
     ‘70’.

     See the *note TextWrapper.wrap(): 16e7. method for additional
     details on how *note wrap(): 16e6. behaves.

 -- Function: textwrap.fill (text, width=70, **kwargs)

     Wraps the single paragraph in `text', and returns a single string
     containing the wrapped paragraph.  *note fill(): 16e8. is shorthand
     for

          "\n".join(wrap(text, ...))

     In particular, *note fill(): 16e8. accepts exactly the same keyword
     arguments as *note wrap(): 16e6.

 -- Function: textwrap.shorten (text, width, **kwargs)

     Collapse and truncate the given `text' to fit in the given `width'.

     First the whitespace in `text' is collapsed (all whitespace is
     replaced by single spaces).  If the result fits in the `width', it
     is returned.  Otherwise, enough words are dropped from the end so
     that the remaining words plus the ‘placeholder’ fit within ‘width’:

          >>> textwrap.shorten("Hello  world!", width=12)
          'Hello world!'
          >>> textwrap.shorten("Hello  world!", width=11)
          'Hello [...]'
          >>> textwrap.shorten("Hello world", width=10, placeholder="...")
          'Hello...'

     Optional keyword arguments correspond to the instance attributes of
     *note TextWrapper: 8de, documented below.  Note that the whitespace
     is collapsed before the text is passed to the *note TextWrapper:
     8de. *note fill(): 16e8. function, so changing the value of *note
     tabsize: 16e9, *note expand_tabs: 16ea, *note drop_whitespace:
     16eb, and *note replace_whitespace: 16ec. will have no effect.

     New in version 3.4.

 -- Function: textwrap.dedent (text)

     Remove any common leading whitespace from every line in `text'.

     This can be used to make triple-quoted strings line up with the
     left edge of the display, while still presenting them in the source
     code in indented form.

     Note that tabs and spaces are both treated as whitespace, but they
     are not equal: the lines ‘" hello"’ and ‘"\thello"’ are considered
     to have no common leading whitespace.

     Lines containing only whitespace are ignored in the input and
     normalized to a single newline character in the output.

     For example:

          def test():
              # end first line with \ to avoid the empty line!
              s = '''\
              hello
                world
              '''
              print(repr(s))          # prints '    hello\n      world\n    '
              print(repr(dedent(s)))  # prints 'hello\n  world\n'

 -- Function: textwrap.indent (text, prefix, predicate=None)

     Add `prefix' to the beginning of selected lines in `text'.

     Lines are separated by calling ‘text.splitlines(True)’.

     By default, `prefix' is added to all lines that do not consist
     solely of whitespace (including any line endings).

     For example:

          >>> s = 'hello\n\n \nworld'
          >>> indent(s, '  ')
          '  hello\n\n \n  world'

     The optional `predicate' argument can be used to control which
     lines are indented.  For example, it is easy to add `prefix' to
     even empty and whitespace-only lines:

          >>> print(indent(s, '+ ', lambda line: True))
          + hello
          +
          +
          + world

     New in version 3.3.

*note wrap(): 16e6, *note fill(): 16e8. and *note shorten(): 8e1. work
by creating a *note TextWrapper: 8de. instance and calling a single
method on it.  That instance is not reused, so for applications that
process many text strings using *note wrap(): 16e6. and/or *note fill():
16e8, it may be more efficient to create your own *note TextWrapper:
8de. object.

Text is preferably wrapped on whitespaces and right after the hyphens in
hyphenated words; only then will long words be broken if necessary,
unless *note TextWrapper.break_long_words: 16ee. is set to false.

 -- Class: textwrap.TextWrapper (**kwargs)

     The *note TextWrapper: 8de. constructor accepts a number of
     optional keyword arguments.  Each keyword argument corresponds to
     an instance attribute, so for example

          wrapper = TextWrapper(initial_indent="* ")

     is the same as

          wrapper = TextWrapper()
          wrapper.initial_indent = "* "

     You can re-use the same *note TextWrapper: 8de. object many times,
     and you can change any of its options through direct assignment to
     instance attributes between uses.

     The *note TextWrapper: 8de. instance attributes (and keyword
     arguments to the constructor) are as follows:

      -- Attribute: width

          (default: ‘70’) The maximum length of wrapped lines.  As long
          as there are no individual words in the input text longer than
          *note width: 16ef, *note TextWrapper: 8de. guarantees that no
          output line will be longer than *note width: 16ef. characters.

      -- Attribute: expand_tabs

          (default: ‘True’) If true, then all tab characters in `text'
          will be expanded to spaces using the ‘expandtabs()’ method of
          `text'.

      -- Attribute: tabsize

          (default: ‘8’) If *note expand_tabs: 16ea. is true, then all
          tab characters in `text' will be expanded to zero or more
          spaces, depending on the current column and the given tab
          size.

          New in version 3.3.

      -- Attribute: replace_whitespace

          (default: ‘True’) If true, after tab expansion but before
          wrapping, the *note wrap(): 16e6. method will replace each
          whitespace character with a single space.  The whitespace
          characters replaced are as follows: tab, newline, vertical
          tab, formfeed, and carriage return (‘'\t\n\v\f\r'’).

               Note: If *note expand_tabs: 16ea. is false and *note
               replace_whitespace: 16ec. is true, each tab character
               will be replaced by a single space, which is `not' the
               same as tab expansion.

               Note: If *note replace_whitespace: 16ec. is false,
               newlines may appear in the middle of a line and cause
               strange output.  For this reason, text should be split
               into paragraphs (using *note str.splitlines(): 1595. or
               similar) which are wrapped separately.

      -- Attribute: drop_whitespace

          (default: ‘True’) If true, whitespace at the beginning and
          ending of every line (after wrapping but before indenting) is
          dropped.  Whitespace at the beginning of the paragraph,
          however, is not dropped if non-whitespace follows it.  If
          whitespace being dropped takes up an entire line, the whole
          line is dropped.

      -- Attribute: initial_indent

          (default: ‘''’) String that will be prepended to the first
          line of wrapped output.  Counts towards the length of the
          first line.  The empty string is not indented.

      -- Attribute: subsequent_indent

          (default: ‘''’) String that will be prepended to all lines of
          wrapped output except the first.  Counts towards the length of
          each line except the first.

      -- Attribute: fix_sentence_endings

          (default: ‘False’) If true, *note TextWrapper: 8de. attempts
          to detect sentence endings and ensure that sentences are
          always separated by exactly two spaces.  This is generally
          desired for text in a monospaced font.  However, the sentence
          detection algorithm is imperfect: it assumes that a sentence
          ending consists of a lowercase letter followed by one of
          ‘'.'’, ‘'!'’, or ‘'?'’, possibly followed by one of ‘'"'’ or
          ‘"'"’, followed by a space.  One problem with this is
          algorithm is that it is unable to detect the difference
          between “Dr.” in

               [...] Dr. Frankenstein's monster [...]

          and “Spot.” in

               [...] See Spot. See Spot run [...]

          *note fix_sentence_endings: 16f2. is false by default.

          Since the sentence detection algorithm relies on
          ‘string.lowercase’ for the definition of “lowercase letter,”
          and a convention of using two spaces after a period to
          separate sentences on the same line, it is specific to
          English-language texts.

      -- Attribute: break_long_words

          (default: ‘True’) If true, then words longer than *note width:
          16ef. will be broken in order to ensure that no lines are
          longer than *note width: 16ef.  If it is false, long words
          will not be broken, and some lines may be longer than *note
          width: 16ef.  (Long words will be put on a line by themselves,
          in order to minimize the amount by which *note width: 16ef. is
          exceeded.)

      -- Attribute: break_on_hyphens

          (default: ‘True’) If true, wrapping will occur preferably on
          whitespaces and right after hyphens in compound words, as it
          is customary in English.  If false, only whitespaces will be
          considered as potentially good places for line breaks, but you
          need to set *note break_long_words: 16ee. to false if you want
          truly insecable words.  Default behaviour in previous versions
          was to always allow breaking hyphenated words.

      -- Attribute: max_lines

          (default: ‘None’) If not ‘None’, then the output will contain
          at most `max_lines' lines, with `placeholder' appearing at the
          end of the output.

          New in version 3.4.

      -- Attribute: placeholder

          (default: ‘' [...]'’) String that will appear at the end of
          the output text if it has been truncated.

          New in version 3.4.

     *note TextWrapper: 8de. also provides some public methods,
     analogous to the module-level convenience functions:

      -- Method: wrap (text)

          Wraps the single paragraph in `text' (a string) so every line
          is at most *note width: 16ef. characters long.  All wrapping
          options are taken from instance attributes of the *note
          TextWrapper: 8de. instance.  Returns a list of output lines,
          without final newlines.  If the wrapped output has no content,
          the returned list is empty.

      -- Method: fill (text)

          Wraps the single paragraph in `text', and returns a single
          string containing the wrapped paragraph.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/textwrap.py


File: python.info,  Node: unicodedata — Unicode Database,  Next: stringprep — Internet String Preparation,  Prev: textwrap — Text wrapping and filling,  Up: Text Processing Services

5.6.5 ‘unicodedata’ — Unicode Database
--------------------------------------

__________________________________________________________________

This module provides access to the Unicode Character Database (UCD)
which defines character properties for all Unicode characters.  The data
contained in this database is compiled from the UCD version 12.1.0(1).

The module uses the same names and symbols as defined by Unicode
Standard Annex #44, "Unicode Character Database"(2).  It defines the
following functions:

 -- Function: unicodedata.lookup (name)

     Look up character by name.  If a character with the given name is
     found, return the corresponding character.  If not found, *note
     KeyError: 2c5. is raised.

     Changed in version 3.3: Support for name aliases (3) and named
     sequences (4) has been added.

 -- Function: unicodedata.name (chr[, default])

     Returns the name assigned to the character `chr' as a string.  If
     no name is defined, `default' is returned, or, if not given, *note
     ValueError: 1f9. is raised.

 -- Function: unicodedata.decimal (chr[, default])

     Returns the decimal value assigned to the character `chr' as
     integer.  If no such value is defined, `default' is returned, or,
     if not given, *note ValueError: 1f9. is raised.

 -- Function: unicodedata.digit (chr[, default])

     Returns the digit value assigned to the character `chr' as integer.
     If no such value is defined, `default' is returned, or, if not
     given, *note ValueError: 1f9. is raised.

 -- Function: unicodedata.numeric (chr[, default])

     Returns the numeric value assigned to the character `chr' as float.
     If no such value is defined, `default' is returned, or, if not
     given, *note ValueError: 1f9. is raised.

 -- Function: unicodedata.category (chr)

     Returns the general category assigned to the character `chr' as
     string.

 -- Function: unicodedata.bidirectional (chr)

     Returns the bidirectional class assigned to the character `chr' as
     string.  If no such value is defined, an empty string is returned.

 -- Function: unicodedata.combining (chr)

     Returns the canonical combining class assigned to the character
     `chr' as integer.  Returns ‘0’ if no combining class is defined.

 -- Function: unicodedata.east_asian_width (chr)

     Returns the east asian width assigned to the character `chr' as
     string.

 -- Function: unicodedata.mirrored (chr)

     Returns the mirrored property assigned to the character `chr' as
     integer.  Returns ‘1’ if the character has been identified as a
     “mirrored” character in bidirectional text, ‘0’ otherwise.

 -- Function: unicodedata.decomposition (chr)

     Returns the character decomposition mapping assigned to the
     character `chr' as string.  An empty string is returned in case no
     such mapping is defined.

 -- Function: unicodedata.normalize (form, unistr)

     Return the normal form `form' for the Unicode string `unistr'.
     Valid values for `form' are ‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.

     The Unicode standard defines various normalization forms of a
     Unicode string, based on the definition of canonical equivalence
     and compatibility equivalence.  In Unicode, several characters can
     be expressed in various way.  For example, the character U+00C7
     (LATIN CAPITAL LETTER C WITH CEDILLA) can also be expressed as the
     sequence U+0043 (LATIN CAPITAL LETTER C) U+0327 (COMBINING
     CEDILLA).

     For each character, there are two normal forms: normal form C and
     normal form D. Normal form D (NFD) is also known as canonical
     decomposition, and translates each character into its decomposed
     form.  Normal form C (NFC) first applies a canonical decomposition,
     then composes pre-combined characters again.

     In addition to these two forms, there are two additional normal
     forms based on compatibility equivalence.  In Unicode, certain
     characters are supported which normally would be unified with other
     characters.  For example, U+2160 (ROMAN NUMERAL ONE) is really the
     same thing as U+0049 (LATIN CAPITAL LETTER I). However, it is
     supported in Unicode for compatibility with existing character sets
     (e.g.  gb2312).

     The normal form KD (NFKD) will apply the compatibility
     decomposition, i.e.  replace all compatibility characters with
     their equivalents.  The normal form KC (NFKC) first applies the
     compatibility decomposition, followed by the canonical composition.

     Even if two unicode strings are normalized and look the same to a
     human reader, if one has combining characters and the other
     doesn’t, they may not compare equal.

 -- Function: unicodedata.is_normalized (form, unistr)

     Return whether the Unicode string `unistr' is in the normal form
     `form'.  Valid values for `form' are ‘NFC’, ‘NFKC’, ‘NFD’, and
     ‘NFKD’.

     New in version 3.8.

In addition, the module exposes the following constant:

 -- Data: unicodedata.unidata_version

     The version of the Unicode database used in this module.

 -- Data: unicodedata.ucd_3_2_0

     This is an object that has the same methods as the entire module,
     but uses the Unicode database version 3.2 instead, for applications
     that require this specific version of the Unicode database (such as
     IDNA).

Examples:

     >>> import unicodedata
     >>> unicodedata.lookup('LEFT CURLY BRACKET')
     '{'
     >>> unicodedata.name('/')
     'SOLIDUS'
     >>> unicodedata.decimal('9')
     9
     >>> unicodedata.decimal('a')
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     ValueError: not a decimal
     >>> unicodedata.category('A')  # 'L'etter, 'u'ppercase
     'Lu'
     >>> unicodedata.bidirectional('\u0660') # 'A'rabic, 'N'umber
     'AN'

   ---------- Footnotes ----------

   (1) http://www.unicode.org/Public/12.1.0/ucd

   (2) https://www.unicode.org/reports/tr44/

   (3) (1) ‘http://www.unicode.org/Public/12.1.0/ucd/NameAliases.txt’

   (4) (2) ‘http://www.unicode.org/Public/12.1.0/ucd/NamedSequences.txt’


File: python.info,  Node: stringprep — Internet String Preparation,  Next: readline — GNU readline interface,  Prev: unicodedata — Unicode Database,  Up: Text Processing Services

5.6.6 ‘stringprep’ — Internet String Preparation
------------------------------------------------

`Source code:' Lib/stringprep.py(1)

__________________________________________________________________

When identifying things (such as host names) in the internet, it is
often necessary to compare such identifications for “equality”.  Exactly
how this comparison is executed may depend on the application domain,
e.g.  whether it should be case-insensitive or not.  It may be also
necessary to restrict the possible identifications, to allow only
identifications consisting of “printable” characters.

RFC 3454(2) defines a procedure for “preparing” Unicode strings in
internet protocols.  Before passing strings onto the wire, they are
processed with the preparation procedure, after which they have a
certain normalized form.  The RFC defines a set of tables, which can be
combined into profiles.  Each profile must define which tables it uses,
and what other optional parts of the ‘stringprep’ procedure are part of
the profile.  One example of a ‘stringprep’ profile is ‘nameprep’, which
is used for internationalized domain names.

The module *note stringprep: f7. only exposes the tables from RFC
3454(3).  As these tables would be very large to represent them as
dictionaries or lists, the module uses the Unicode character database
internally.  The module source code itself was generated using the
‘mkstringprep.py’ utility.

As a result, these tables are exposed as functions, not as data
structures.  There are two kinds of tables in the RFC: sets and
mappings.  For a set, *note stringprep: f7. provides the “characteristic
function”, i.e.  a function that returns ‘True’ if the parameter is part
of the set.  For mappings, it provides the mapping function: given the
key, it returns the associated value.  Below is a list of all functions
available in the module.

 -- Function: stringprep.in_table_a1 (code)

     Determine whether `code' is in tableA.1 (Unassigned code points in
     Unicode 3.2).

 -- Function: stringprep.in_table_b1 (code)

     Determine whether `code' is in tableB.1 (Commonly mapped to
     nothing).

 -- Function: stringprep.map_table_b2 (code)

     Return the mapped value for `code' according to tableB.2 (Mapping
     for case-folding used with NFKC).

 -- Function: stringprep.map_table_b3 (code)

     Return the mapped value for `code' according to tableB.3 (Mapping
     for case-folding used with no normalization).

 -- Function: stringprep.in_table_c11 (code)

     Determine whether `code' is in tableC.1.1 (ASCII space characters).

 -- Function: stringprep.in_table_c12 (code)

     Determine whether `code' is in tableC.1.2 (Non-ASCII space
     characters).

 -- Function: stringprep.in_table_c11_c12 (code)

     Determine whether `code' is in tableC.1 (Space characters, union of
     C.1.1 and C.1.2).

 -- Function: stringprep.in_table_c21 (code)

     Determine whether `code' is in tableC.2.1 (ASCII control
     characters).

 -- Function: stringprep.in_table_c22 (code)

     Determine whether `code' is in tableC.2.2 (Non-ASCII control
     characters).

 -- Function: stringprep.in_table_c21_c22 (code)

     Determine whether `code' is in tableC.2 (Control characters, union
     of C.2.1 and C.2.2).

 -- Function: stringprep.in_table_c3 (code)

     Determine whether `code' is in tableC.3 (Private use).

 -- Function: stringprep.in_table_c4 (code)

     Determine whether `code' is in tableC.4 (Non-character code
     points).

 -- Function: stringprep.in_table_c5 (code)

     Determine whether `code' is in tableC.5 (Surrogate codes).

 -- Function: stringprep.in_table_c6 (code)

     Determine whether `code' is in tableC.6 (Inappropriate for plain
     text).

 -- Function: stringprep.in_table_c7 (code)

     Determine whether `code' is in tableC.7 (Inappropriate for
     canonical representation).

 -- Function: stringprep.in_table_c8 (code)

     Determine whether `code' is in tableC.8 (Change display properties
     or are deprecated).

 -- Function: stringprep.in_table_c9 (code)

     Determine whether `code' is in tableC.9 (Tagging characters).

 -- Function: stringprep.in_table_d1 (code)

     Determine whether `code' is in tableD.1 (Characters with
     bidirectional property “R” or “AL”).

 -- Function: stringprep.in_table_d2 (code)

     Determine whether `code' is in tableD.2 (Characters with
     bidirectional property “L”).

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/stringprep.py

   (2) https://tools.ietf.org/html/rfc3454.html

   (3) https://tools.ietf.org/html/rfc3454.html


File: python.info,  Node: readline — GNU readline interface,  Next: rlcompleter — Completion function for GNU readline,  Prev: stringprep — Internet String Preparation,  Up: Text Processing Services

5.6.7 ‘readline’ — GNU readline interface
-----------------------------------------

__________________________________________________________________

The *note readline: de. module defines a number of functions to
facilitate completion and reading/writing of history files from the
Python interpreter.  This module can be used directly, or via the *note
rlcompleter: e1. module, which supports completion of Python identifiers
at the interactive prompt.  Settings made using this module affect the
behaviour of both the interpreter’s interactive prompt and the prompts
offered by the built-in *note input(): c5e. function.

Readline keybindings may be configured via an initialization file,
typically ‘.inputrc’ in your home directory.  See Readline Init File(1)
in the GNU Readline manual for information about the format and
allowable constructs of that file, and the capabilities of the Readline
library in general.

     Note: The underlying Readline library API may be implemented by the
     ‘libedit’ library instead of GNU readline.  On macOS the *note
     readline: de. module detects which library is being used at run
     time.

     The configuration file for ‘libedit’ is different from that of GNU
     readline.  If you programmatically load configuration strings you
     can check for the text “libedit” in ‘readline.__doc__’ to
     differentiate between GNU readline and libedit.

     If you use `editline'/‘libedit’ readline emulation on macOS, the
     initialization file located in your home directory is named
     ‘.editrc’.  For example, the following content in ‘~/.editrc’ will
     turn ON `vi' keybindings and TAB completion:

          python:bind -v
          python:bind ^I rl_complete

* Menu:

* Init file::
* Line buffer::
* History file::
* History list::
* Startup hooks::
* Completion::
* Example::

   ---------- Footnotes ----------

   (1) https://tiswww.cwru.edu/php/chet/readline/rluserman.html#SEC9


File: python.info,  Node: Init file,  Next: Line buffer,  Up: readline — GNU readline interface

5.6.7.1 Init file
.................

The following functions relate to the init file and user configuration:

 -- Function: readline.parse_and_bind (string)

     Execute the init line provided in the `string' argument.  This
     calls ‘rl_parse_and_bind()’ in the underlying library.

 -- Function: readline.read_init_file ([filename])

     Execute a readline initialization file.  The default filename is
     the last filename used.  This calls ‘rl_read_init_file()’ in the
     underlying library.


File: python.info,  Node: Line buffer,  Next: History file,  Prev: Init file,  Up: readline — GNU readline interface

5.6.7.2 Line buffer
...................

The following functions operate on the line buffer:

 -- Function: readline.get_line_buffer ()

     Return the current contents of the line buffer (‘rl_line_buffer’ in
     the underlying library).

 -- Function: readline.insert_text (string)

     Insert text into the line buffer at the cursor position.  This
     calls ‘rl_insert_text()’ in the underlying library, but ignores the
     return value.

 -- Function: readline.redisplay ()

     Change what’s displayed on the screen to reflect the current
     contents of the line buffer.  This calls ‘rl_redisplay()’ in the
     underlying library.


File: python.info,  Node: History file,  Next: History list,  Prev: Line buffer,  Up: readline — GNU readline interface

5.6.7.3 History file
....................

The following functions operate on a history file:

 -- Function: readline.read_history_file ([filename])

     Load a readline history file, and append it to the history list.
     The default filename is ‘~/.history’.  This calls ‘read_history()’
     in the underlying library.

 -- Function: readline.write_history_file ([filename])

     Save the history list to a readline history file, overwriting any
     existing file.  The default filename is ‘~/.history’.  This calls
     ‘write_history()’ in the underlying library.

 -- Function: readline.append_history_file (nelements[, filename])

     Append the last `nelements' items of history to a file.  The
     default filename is ‘~/.history’.  The file must already exist.
     This calls ‘append_history()’ in the underlying library.  This
     function only exists if Python was compiled for a version of the
     library that supports it.

     New in version 3.5.

 -- Function: readline.get_history_length ()
 -- Function: readline.set_history_length (length)

     Set or return the desired number of lines to save in the history
     file.  The *note write_history_file(): 1721. function uses this
     value to truncate the history file, by calling
     ‘history_truncate_file()’ in the underlying library.  Negative
     values imply unlimited history file size.


File: python.info,  Node: History list,  Next: Startup hooks,  Prev: History file,  Up: readline — GNU readline interface

5.6.7.4 History list
....................

The following functions operate on a global history list:

 -- Function: readline.clear_history ()

     Clear the current history.  This calls ‘clear_history()’ in the
     underlying library.  The Python function only exists if Python was
     compiled for a version of the library that supports it.

 -- Function: readline.get_current_history_length ()

     Return the number of items currently in the history.  (This is
     different from *note get_history_length(): 1722, which returns the
     maximum number of lines that will be written to a history file.)

 -- Function: readline.get_history_item (index)

     Return the current contents of history item at `index'.  The item
     index is one-based.  This calls ‘history_get()’ in the underlying
     library.

 -- Function: readline.remove_history_item (pos)

     Remove history item specified by its position from the history.
     The position is zero-based.  This calls ‘remove_history()’ in the
     underlying library.

 -- Function: readline.replace_history_item (pos, line)

     Replace history item specified by its position with `line'.  The
     position is zero-based.  This calls ‘replace_history_entry()’ in
     the underlying library.

 -- Function: readline.add_history (line)

     Append `line' to the history buffer, as if it was the last line
     typed.  This calls ‘add_history()’ in the underlying library.

 -- Function: readline.set_auto_history (enabled)

     Enable or disable automatic calls to ‘add_history()’ when reading
     input via readline.  The `enabled' argument should be a Boolean
     value that when true, enables auto history, and that when false,
     disables auto history.

     New in version 3.6.

     `CPython implementation detail:' Auto history is enabled by
     default, and changes to this do not persist across multiple
     sessions.


File: python.info,  Node: Startup hooks,  Next: Completion,  Prev: History list,  Up: readline — GNU readline interface

5.6.7.5 Startup hooks
.....................

 -- Function: readline.set_startup_hook ([function])

     Set or remove the function invoked by the ‘rl_startup_hook’
     callback of the underlying library.  If `function' is specified, it
     will be used as the new hook function; if omitted or ‘None’, any
     function already installed is removed.  The hook is called with no
     arguments just before readline prints the first prompt.

 -- Function: readline.set_pre_input_hook ([function])

     Set or remove the function invoked by the ‘rl_pre_input_hook’
     callback of the underlying library.  If `function' is specified, it
     will be used as the new hook function; if omitted or ‘None’, any
     function already installed is removed.  The hook is called with no
     arguments after the first prompt has been printed and just before
     readline starts reading input characters.  This function only
     exists if Python was compiled for a version of the library that
     supports it.


File: python.info,  Node: Completion,  Next: Example,  Prev: Startup hooks,  Up: readline — GNU readline interface

5.6.7.6 Completion
..................

The following functions relate to implementing a custom word completion
function.  This is typically operated by the Tab key, and can suggest
and automatically complete a word being typed.  By default, Readline is
set up to be used by *note rlcompleter: e1. to complete Python
identifiers for the interactive interpreter.  If the *note readline: de.
module is to be used with a custom completer, a different set of word
delimiters should be set.

 -- Function: readline.set_completer ([function])

     Set or remove the completer function.  If `function' is specified,
     it will be used as the new completer function; if omitted or
     ‘None’, any completer function already installed is removed.  The
     completer function is called as ‘function(text, state)’, for
     `state' in ‘0’, ‘1’, ‘2’, …, until it returns a non-string value.
     It should return the next possible completion starting with `text'.

     The installed completer function is invoked by the `entry_func'
     callback passed to ‘rl_completion_matches()’ in the underlying
     library.  The `text' string comes from the first parameter to the
     ‘rl_attempted_completion_function’ callback of the underlying
     library.

 -- Function: readline.get_completer ()

     Get the completer function, or ‘None’ if no completer function has
     been set.

 -- Function: readline.get_completion_type ()

     Get the type of completion being attempted.  This returns the
     ‘rl_completion_type’ variable in the underlying library as an
     integer.

 -- Function: readline.get_begidx ()
 -- Function: readline.get_endidx ()

     Get the beginning or ending index of the completion scope.  These
     indexes are the `start' and `end' arguments passed to the
     ‘rl_attempted_completion_function’ callback of the underlying
     library.

 -- Function: readline.set_completer_delims (string)
 -- Function: readline.get_completer_delims ()

     Set or get the word delimiters for completion.  These determine the
     start of the word to be considered for completion (the completion
     scope).  These functions access the
     ‘rl_completer_word_break_characters’ variable in the underlying
     library.

 -- Function: readline.set_completion_display_matches_hook ([function])

     Set or remove the completion display function.  If `function' is
     specified, it will be used as the new completion display function;
     if omitted or ‘None’, any completion display function already
     installed is removed.  This sets or clears the
     ‘rl_completion_display_matches_hook’ callback in the underlying
     library.  The completion display function is called as
     ‘function(substitution, [matches], longest_match_length)’ once each
     time matches need to be displayed.


File: python.info,  Node: Example,  Prev: Completion,  Up: readline — GNU readline interface

5.6.7.7 Example
...............

The following example demonstrates how to use the *note readline: de.
module’s history reading and writing functions to automatically load and
save a history file named ‘.python_history’ from the user’s home
directory.  The code below would normally be executed automatically
during interactive sessions from the user’s *note PYTHONSTARTUP: 8d9.
file.

     import atexit
     import os
     import readline

     histfile = os.path.join(os.path.expanduser("~"), ".python_history")
     try:
         readline.read_history_file(histfile)
         # default history len is -1 (infinite), which may grow unruly
         readline.set_history_length(1000)
     except FileNotFoundError:
         pass

     atexit.register(readline.write_history_file, histfile)

This code is actually automatically run when Python is run in *note
interactive mode: 8d7. (see *note Readline configuration: 8da.).

The following example achieves the same goal but supports concurrent
interactive sessions, by only appending the new history.

     import atexit
     import os
     import readline
     histfile = os.path.join(os.path.expanduser("~"), ".python_history")

     try:
         readline.read_history_file(histfile)
         h_len = readline.get_current_history_length()
     except FileNotFoundError:
         open(histfile, 'wb').close()
         h_len = 0

     def save(prev_h_len, histfile):
         new_h_len = readline.get_current_history_length()
         readline.set_history_length(1000)
         readline.append_history_file(new_h_len - prev_h_len, histfile)
     atexit.register(save, h_len, histfile)

The following example extends the *note code.InteractiveConsole: 1739.
class to support history save/restore.

     import atexit
     import code
     import os
     import readline

     class HistoryConsole(code.InteractiveConsole):
         def __init__(self, locals=None, filename="<console>",
                      histfile=os.path.expanduser("~/.console-history")):
             code.InteractiveConsole.__init__(self, locals, filename)
             self.init_history(histfile)

         def init_history(self, histfile):
             readline.parse_and_bind("tab: complete")
             if hasattr(readline, "read_history_file"):
                 try:
                     readline.read_history_file(histfile)
                 except FileNotFoundError:
                     pass
                 atexit.register(self.save_history, histfile)

         def save_history(self, histfile):
             readline.set_history_length(1000)
             readline.write_history_file(histfile)


File: python.info,  Node: rlcompleter — Completion function for GNU readline,  Prev: readline — GNU readline interface,  Up: Text Processing Services

5.6.8 ‘rlcompleter’ — Completion function for GNU readline
----------------------------------------------------------

`Source code:' Lib/rlcompleter.py(1)

__________________________________________________________________

The *note rlcompleter: e1. module defines a completion function suitable
for the *note readline: de. module by completing valid Python
identifiers and keywords.

When this module is imported on a Unix platform with the *note readline:
de. module available, an instance of the ‘Completer’ class is
automatically created and its ‘complete()’ method is set as the *note
readline: de. completer.

Example:

     >>> import rlcompleter
     >>> import readline
     >>> readline.parse_and_bind("tab: complete")
     >>> readline. <TAB PRESSED>
     readline.__doc__          readline.get_line_buffer(  readline.read_init_file(
     readline.__file__         readline.insert_text(      readline.set_completer(
     readline.__name__         readline.parse_and_bind(
     >>> readline.

The *note rlcompleter: e1. module is designed for use with Python’s
*note interactive mode: 8d7.  Unless Python is run with the *note -S:
b17. option, the module is automatically imported and configured (see
*note Readline configuration: 8da.).

On platforms without *note readline: de, the ‘Completer’ class defined
by this module can still be used for custom purposes.

* Menu:

* Completer Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/rlcompleter.py


File: python.info,  Node: Completer Objects,  Up: rlcompleter — Completion function for GNU readline

5.6.8.1 Completer Objects
.........................

Completer objects have the following method:

 -- Method: Completer.complete (text, state)

     Return the `state'th completion for `text'.

     If called for `text' that doesn’t include a period character
     (‘'.'’), it will complete from names currently defined in *note
     __main__: 1, *note builtins: 13. and keywords (as defined by the
     *note keyword: a6. module).

     If called for a dotted name, it will try to evaluate anything
     without obvious side-effects (functions will not be evaluated, but
     it can generate calls to *note __getattr__(): 30f.) up to the last
     part, and find matches for the rest via the *note dir(): d26.
     function.  Any exception raised during the evaluation of the
     expression is caught, silenced and *note None: 157. is returned.


File: python.info,  Node: Binary Data Services,  Next: Data Types,  Prev: Text Processing Services,  Up: The Python Standard Library

5.7 Binary Data Services
========================

The modules described in this chapter provide some basic services
operations for manipulation of binary data.  Other operations on binary
data, specifically in relation to file formats and network protocols,
are described in the relevant sections.

Some libraries described under *note Text Processing Services: 157d.
also work with either ASCII-compatible binary formats (for example,
*note re: dd.) or all binary data (for example, *note difflib: 37.).

In addition, see the documentation for Python’s built-in binary data
types in *note Binary Sequence Types — bytes, bytearray, memoryview:
1523.

* Menu:

* struct — Interpret bytes as packed binary data::
* codecs — Codec registry and base classes::


File: python.info,  Node: struct — Interpret bytes as packed binary data,  Next: codecs — Codec registry and base classes,  Up: Binary Data Services

5.7.1 ‘struct’ — Interpret bytes as packed binary data
------------------------------------------------------

`Source code:' Lib/struct.py(1)

__________________________________________________________________

This module performs conversions between Python values and C structs
represented as Python *note bytes: 326. objects.  This can be used in
handling binary data stored in files or from network connections, among
other sources.  It uses *note Format Strings: 1743. as compact
descriptions of the layout of the C structs and the intended conversion
to/from Python values.

     Note: By default, the result of packing a given C struct includes
     pad bytes in order to maintain proper alignment for the C types
     involved; similarly, alignment is taken into account when
     unpacking.  This behavior is chosen so that the bytes of a packed
     struct correspond exactly to the layout in memory of the
     corresponding C struct.  To handle platform-independent data
     formats or omit implicit pad bytes, use ‘standard’ size and
     alignment instead of ‘native’ size and alignment: see *note Byte
     Order, Size, and Alignment: 1744. for details.

Several *note struct: f8. functions (and methods of *note Struct: 1745.)
take a `buffer' argument.  This refers to objects that implement the
*note Buffer Protocol: 1579. and provide either a readable or
read-writable buffer.  The most common types used for that purpose are
*note bytes: 326. and *note bytearray: 327, but many other types that
can be viewed as an array of bytes implement the buffer protocol, so
that they can be read/filled without additional copying from a *note
bytes: 326. object.

* Menu:

* Functions and Exceptions::
* Format Strings::
* Classes: Classes<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/struct.py


File: python.info,  Node: Functions and Exceptions,  Next: Format Strings,  Up: struct — Interpret bytes as packed binary data

5.7.1.1 Functions and Exceptions
................................

The module defines the following exception and functions:

 -- Exception: struct.error

     Exception raised on various occasions; argument is a string
     describing what is wrong.

 -- Function: struct.pack (format, v1, v2, ...)

     Return a bytes object containing the values `v1', `v2', … packed
     according to the format string `format'.  The arguments must match
     the values required by the format exactly.

 -- Function: struct.pack_into (format, buffer, offset, v1, v2, ...)

     Pack the values `v1', `v2', … according to the format string
     `format' and write the packed bytes into the writable buffer
     `buffer' starting at position `offset'.  Note that `offset' is a
     required argument.

 -- Function: struct.unpack (format, buffer)

     Unpack from the buffer `buffer' (presumably packed by ‘pack(format,
     ...)’) according to the format string `format'.  The result is a
     tuple even if it contains exactly one item.  The buffer’s size in
     bytes must match the size required by the format, as reflected by
     *note calcsize(): 1748.

 -- Function: struct.unpack_from (format, buffer, offset=0)

     Unpack from `buffer' starting at position `offset', according to
     the format string `format'.  The result is a tuple even if it
     contains exactly one item.  The buffer’s size in bytes, starting at
     position `offset', must be at least the size required by the
     format, as reflected by *note calcsize(): 1748.

 -- Function: struct.iter_unpack (format, buffer)

     Iteratively unpack from the buffer `buffer' according to the format
     string `format'.  This function returns an iterator which will read
     equally-sized chunks from the buffer until all its contents have
     been consumed.  The buffer’s size in bytes must be a multiple of
     the size required by the format, as reflected by *note calcsize():
     1748.

     Each iteration yields a tuple as specified by the format string.

     New in version 3.4.

 -- Function: struct.calcsize (format)

     Return the size of the struct (and hence of the bytes object
     produced by ‘pack(format, ...)’) corresponding to the format string
     `format'.


File: python.info,  Node: Format Strings,  Next: Classes<2>,  Prev: Functions and Exceptions,  Up: struct — Interpret bytes as packed binary data

5.7.1.2 Format Strings
......................

Format strings are the mechanism used to specify the expected layout
when packing and unpacking data.  They are built up from *note Format
Characters: 174b, which specify the type of data being packed/unpacked.
In addition, there are special characters for controlling the *note Byte
Order, Size, and Alignment: 1744.

* Menu:

* Byte Order, Size, and Alignment: Byte Order Size and Alignment.
* Format Characters::
* Examples: Examples<2>.


File: python.info,  Node: Byte Order Size and Alignment,  Next: Format Characters,  Up: Format Strings

5.7.1.3 Byte Order, Size, and Alignment
.......................................

By default, C types are represented in the machine’s native format and
byte order, and properly aligned by skipping pad bytes if necessary
(according to the rules used by the C compiler).

Alternatively, the first character of the format string can be used to
indicate the byte order, size and alignment of the packed data,
according to the following table:

Character       Byte order                   Size           Alignment
                                                            
----------------------------------------------------------------------------
                                                            
‘@’             native                       native         native
                                                            
                                                            
‘=’             native                       standard       none
                                                            
                                                            
‘<’             little-endian                standard       none
                                                            
                                                            
‘>’             big-endian                   standard       none
                                                            
                                                            
‘!’             network (= big-endian)       standard       none
                                                            

If the first character is not one of these, ‘'@'’ is assumed.

Native byte order is big-endian or little-endian, depending on the host
system.  For example, Intel x86 and AMD64 (x86-64) are little-endian;
Motorola 68000 and PowerPC G5 are big-endian; ARM and Intel Itanium
feature switchable endianness (bi-endian).  Use ‘sys.byteorder’ to check
the endianness of your system.

Native size and alignment are determined using the C compiler’s ‘sizeof’
expression.  This is always combined with native byte order.

Standard size depends only on the format character; see the table in the
*note Format Characters: 174b. section.

Note the difference between ‘'@'’ and ‘'='’: both use native byte order,
but the size and alignment of the latter is standardized.

The form ‘'!'’ is available for those poor souls who claim they can’t
remember whether network byte order is big-endian or little-endian.

There is no way to indicate non-native byte order (force byte-swapping);
use the appropriate choice of ‘'<'’ or ‘'>'’.

Notes:

  1. Padding is only automatically added between successive structure
     members.  No padding is added at the beginning or the end of the
     encoded struct.

  2. No padding is added when using non-native size and alignment, e.g.
     with ‘<’, ‘>’, ‘=’, and ‘!’.

  3. To align the end of a structure to the alignment requirement of a
     particular type, end the format with the code for that type with a
     repeat count of zero.  See *note Examples: 174d.


File: python.info,  Node: Format Characters,  Next: Examples<2>,  Prev: Byte Order Size and Alignment,  Up: Format Strings

5.7.1.4 Format Characters
.........................

Format characters have the following meaning; the conversion between C
and Python values should be obvious given their types.  The ‘Standard
size’ column refers to the size of the packed value in bytes when using
standard size; that is, when the format string starts with one of ‘'<'’,
‘'>'’, ‘'!'’ or ‘'='’.  When using native size, the size of the packed
value is platform-dependent.

Format       C Type                         Python type              Standard size        Notes
                                                                                          
-----------------------------------------------------------------------------------------------------------
                                                                                          
‘x’          pad byte                       no value
                                            
                                                                                          
‘c’          ‘char’                         bytes of length 1        1
                                                                     
                                                                                          
‘b’          ‘signed char’                  integer                  1                    (1), (2)
                                                                                          
                                                                                          
‘B’          ‘unsigned char’                integer                  1                    (2)
                                                                                          
                                                                                          
‘?’          ‘_Bool’                        bool                     1                    (1)
                                                                                          
                                                                                          
‘h’          ‘short’                        integer                  2                    (2)
                                                                                          
                                                                                          
‘H’          ‘unsigned short’               integer                  2                    (2)
                                                                                          
                                                                                          
‘i’          ‘int’                          integer                  4                    (2)
                                                                                          
                                                                                          
‘I’          ‘unsigned int’                 integer                  4                    (2)
                                                                                          
                                                                                          
‘l’          ‘long’                         integer                  4                    (2)
                                                                                          
                                                                                          
‘L’          ‘unsigned long’                integer                  4                    (2)
                                                                                          
                                                                                          
‘q’          ‘long long’                    integer                  8                    (2)
                                                                                          
                                                                                          
‘Q’          ‘unsigned long long’           integer                  8                    (2)
                                                                                          
                                                                                          
‘n’          ‘ssize_t’                      integer                                       (3)
                                                                                          
                                                                                          
‘N’          ‘size_t’                       integer                                       (3)
                                                                                          
                                                                                          
‘e’          (6)                            float                    2                    (4)
                                                                                          
                                                                                          
‘f’          ‘float’                        float                    4                    (4)
                                                                                          
                                                                                          
‘d’          ‘double’                       float                    8                    (4)
                                                                                          
                                                                                          
‘s’          ‘char[]’                       bytes
                                            
                                                                                          
‘p’          ‘char[]’                       bytes
                                            
                                                                                          
‘P’          ‘void *’                       integer                                       (5)
                                                                                          

Changed in version 3.3: Added support for the ‘'n'’ and ‘'N'’ formats.

Changed in version 3.6: Added support for the ‘'e'’ format.

Notes:

  1. 
     The ‘'?'’ conversion code corresponds to the ‘_Bool’ type defined
     by C99.  If this type is not available, it is simulated using a
     ‘char’.  In standard mode, it is always represented by one byte.

  2. When attempting to pack a non-integer using any of the integer
     conversion codes, if the non-integer has a *note __index__(): 18a.
     method then that method is called to convert the argument to an
     integer before packing.

     Changed in version 3.2: Use of the *note __index__(): 18a. method
     for non-integers is new in 3.2.

  3. The ‘'n'’ and ‘'N'’ conversion codes are only available for the
     native size (selected as the default or with the ‘'@'’ byte order
     character).  For the standard size, you can use whichever of the
     other integer formats fits your application.

  4. For the ‘'f'’, ‘'d'’ and ‘'e'’ conversion codes, the packed
     representation uses the IEEE 754 binary32, binary64 or binary16
     format (for ‘'f'’, ‘'d'’ or ‘'e'’ respectively), regardless of the
     floating-point format used by the platform.

  5. The ‘'P'’ format character is only available for the native byte
     ordering (selected as the default or with the ‘'@'’ byte order
     character).  The byte order character ‘'='’ chooses to use little-
     or big-endian ordering based on the host system.  The struct module
     does not interpret this as native ordering, so the ‘'P'’ format is
     not available.

  6. The IEEE 754 binary16 “half precision” type was introduced in the
     2008 revision of the IEEE 754 standard(1).  It has a sign bit, a
     5-bit exponent and 11-bit precision (with 10 bits explicitly
     stored), and can represent numbers between approximately ‘6.1e-05’
     and ‘6.5e+04’ at full precision.  This type is not widely supported
     by C compilers: on a typical machine, an unsigned short can be used
     for storage, but not for math operations.  See the Wikipedia page
     on the half-precision floating-point format(2) for more
     information.

A format character may be preceded by an integral repeat count.  For
example, the format string ‘'4h'’ means exactly the same as ‘'hhhh'’.

Whitespace characters between formats are ignored; a count and its
format must not contain whitespace though.

For the ‘'s'’ format character, the count is interpreted as the length
of the bytes, not a repeat count like for the other format characters;
for example, ‘'10s'’ means a single 10-byte string, while ‘'10c'’ means
10 characters.  If a count is not given, it defaults to 1.  For packing,
the string is truncated or padded with null bytes as appropriate to make
it fit.  For unpacking, the resulting bytes object always has exactly
the specified number of bytes.  As a special case, ‘'0s'’ means a
single, empty string (while ‘'0c'’ means 0 characters).

When packing a value ‘x’ using one of the integer formats (‘'b'’, ‘'B'’,
‘'h'’, ‘'H'’, ‘'i'’, ‘'I'’, ‘'l'’, ‘'L'’, ‘'q'’, ‘'Q'’), if ‘x’ is
outside the valid range for that format then *note struct.error: ca7. is
raised.

Changed in version 3.1: In 3.0, some of the integer formats wrapped
out-of-range values and raised *note DeprecationWarning: 276. instead of
*note struct.error: ca7.

The ‘'p'’ format character encodes a “Pascal string”, meaning a short
variable-length string stored in a `fixed number of bytes', given by the
count.  The first byte stored is the length of the string, or 255,
whichever is smaller.  The bytes of the string follow.  If the string
passed in to *note pack(): bfe. is too long (longer than the count minus
1), only the leading ‘count-1’ bytes of the string are stored.  If the
string is shorter than ‘count-1’, it is padded with null bytes so that
exactly count bytes in all are used.  Note that for *note unpack():
123c, the ‘'p'’ format character consumes ‘count’ bytes, but that the
string returned can never contain more than 255 bytes.

For the ‘'?'’ format character, the return value is either *note True:
48f. or *note False: 37d.  When packing, the truth value of the argument
object is used.  Either 0 or 1 in the native or standard bool
representation will be packed, and any non-zero value will be ‘True’
when unpacking.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/IEEE_floating_point#IEEE_754-2008

   (2) 
https://en.wikipedia.org/wiki/Half-precision_floating-point_format


File: python.info,  Node: Examples<2>,  Prev: Format Characters,  Up: Format Strings

5.7.1.5 Examples
................

     Note: All examples assume a native byte order, size, and alignment
     with a big-endian machine.

A basic example of packing/unpacking three integers:

     >>> from struct import *
     >>> pack('hhl', 1, 2, 3)
     b'\x00\x01\x00\x02\x00\x00\x00\x03'
     >>> unpack('hhl', b'\x00\x01\x00\x02\x00\x00\x00\x03')
     (1, 2, 3)
     >>> calcsize('hhl')
     8

Unpacked fields can be named by assigning them to variables or by
wrapping the result in a named tuple:

     >>> record = b'raymond   \x32\x12\x08\x01\x08'
     >>> name, serialnum, school, gradelevel = unpack('<10sHHb', record)

     >>> from collections import namedtuple
     >>> Student = namedtuple('Student', 'name serialnum school gradelevel')
     >>> Student._make(unpack('<10sHHb', record))
     Student(name=b'raymond   ', serialnum=4658, school=264, gradelevel=8)

The ordering of format characters may have an impact on size since the
padding needed to satisfy alignment requirements is different:

     >>> pack('ci', b'*', 0x12131415)
     b'*\x00\x00\x00\x12\x13\x14\x15'
     >>> pack('ic', 0x12131415, b'*')
     b'\x12\x13\x14\x15*'
     >>> calcsize('ci')
     8
     >>> calcsize('ic')
     5

The following format ‘'llh0l'’ specifies two pad bytes at the end,
assuming longs are aligned on 4-byte boundaries:

     >>> pack('llh0l', 1, 2, 3)
     b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'

This only works when native size and alignment are in effect; standard
size and alignment does not enforce any alignment.

See also
........

Module *note array: 7.

     Packed binary storage of homogeneous data.

Module *note xdrlib: 132.

     Packing and unpacking of XDR data.


File: python.info,  Node: Classes<2>,  Prev: Format Strings,  Up: struct — Interpret bytes as packed binary data

5.7.1.6 Classes
...............

The *note struct: f8. module also defines the following type:

 -- Class: struct.Struct (format)

     Return a new Struct object which writes and reads binary data
     according to the format string `format'.  Creating a Struct object
     once and calling its methods is more efficient than calling the
     *note struct: f8. functions with the same format since the format
     string only needs to be compiled once.

          Note: The compiled versions of the most recent format strings
          passed to *note Struct: 1745. and the module-level functions
          are cached, so programs that use only a few format strings
          needn’t worry about reusing a single *note Struct: 1745.
          instance.

     Compiled Struct objects support the following methods and
     attributes:

      -- Method: pack (v1, v2, ...)

          Identical to the *note pack(): bfe. function, using the
          compiled format.  (‘len(result)’ will equal *note size: 1753.)

      -- Method: pack_into (buffer, offset, v1, v2, ...)

          Identical to the *note pack_into(): 1747. function, using the
          compiled format.

      -- Method: unpack (buffer)

          Identical to the *note unpack(): 123c. function, using the
          compiled format.  The buffer’s size in bytes must equal *note
          size: 1753.

      -- Method: unpack_from (buffer, offset=0)

          Identical to the *note unpack_from(): 1749. function, using
          the compiled format.  The buffer’s size in bytes, starting at
          position `offset', must be at least *note size: 1753.

      -- Method: iter_unpack (buffer)

          Identical to the *note iter_unpack(): 8cc. function, using the
          compiled format.  The buffer’s size in bytes must be a
          multiple of *note size: 1753.

          New in version 3.4.

      -- Attribute: format

          The format string used to construct this Struct object.

          Changed in version 3.7: The format string type is now *note
          str: 325. instead of *note bytes: 326.

      -- Attribute: size

          The calculated size of the struct (and hence of the bytes
          object produced by the *note pack(): bfe. method)
          corresponding to *note format: 4d0.


File: python.info,  Node: codecs — Codec registry and base classes,  Prev: struct — Interpret bytes as packed binary data,  Up: Binary Data Services

5.7.2 ‘codecs’ — Codec registry and base classes
------------------------------------------------

`Source code:' Lib/codecs.py(1)

__________________________________________________________________

This module defines base classes for standard Python codecs (encoders
and decoders) and provides access to the internal Python codec registry,
which manages the codec and error handling lookup process.  Most
standard codecs are *note text encodings: 1536, which encode text to
bytes, but there are also codecs provided that encode text to text, and
bytes to bytes.  Custom codecs may encode and decode between arbitrary
types, but some module features are restricted to use specifically with
*note text encodings: 1536, or with codecs that encode to *note bytes:
326.

The module defines the following functions for encoding and decoding
with any codec:

 -- Function: codecs.encode (obj, encoding='utf-8', errors='strict')

     Encodes `obj' using the codec registered for `encoding'.

     `Errors' may be given to set the desired error handling scheme.
     The default error handler is ‘'strict'’ meaning that encoding
     errors raise *note ValueError: 1f9. (or a more codec specific
     subclass, such as *note UnicodeEncodeError: 1fa.).  Refer to *note
     Codec Base Classes: 175a. for more information on codec error
     handling.

 -- Function: codecs.decode (obj, encoding='utf-8', errors='strict')

     Decodes `obj' using the codec registered for `encoding'.

     `Errors' may be given to set the desired error handling scheme.
     The default error handler is ‘'strict'’ meaning that decoding
     errors raise *note ValueError: 1f9. (or a more codec specific
     subclass, such as *note UnicodeDecodeError: 1fb.).  Refer to *note
     Codec Base Classes: 175a. for more information on codec error
     handling.

The full details for each codec can also be looked up directly:

 -- Function: codecs.lookup (encoding)

     Looks up the codec info in the Python codec registry and returns a
     *note CodecInfo: 175b. object as defined below.

     Encodings are first looked up in the registry’s cache.  If not
     found, the list of registered search functions is scanned.  If no
     *note CodecInfo: 175b. object is found, a *note LookupError: 1599.
     is raised.  Otherwise, the *note CodecInfo: 175b. object is stored
     in the cache and returned to the caller.

 -- Class: codecs.CodecInfo (encode, decode, streamreader=None,
          streamwriter=None, incrementalencoder=None,
          incrementaldecoder=None, name=None)

     Codec details when looking up the codec registry.  The constructor
     arguments are stored in attributes of the same name:

      -- Attribute: name

          The name of the encoding.

      -- Attribute: encode
      -- Attribute: decode

          The stateless encoding and decoding functions.  These must be
          functions or methods which have the same interface as the
          *note encode(): 175f. and *note decode(): 1760. methods of
          Codec instances (see *note Codec Interface: 1761.).  The
          functions or methods are expected to work in a stateless mode.

      -- Attribute: incrementalencoder
      -- Attribute: incrementaldecoder

          Incremental encoder and decoder classes or factory functions.
          These have to provide the interface defined by the base
          classes *note IncrementalEncoder: 1764. and *note
          IncrementalDecoder: 1765, respectively.  Incremental codecs
          can maintain state.

      -- Attribute: streamwriter
      -- Attribute: streamreader

          Stream writer and reader classes or factory functions.  These
          have to provide the interface defined by the base classes
          *note StreamWriter: 1768. and *note StreamReader: 1769,
          respectively.  Stream codecs can maintain state.

To simplify access to the various codec components, the module provides
these additional functions which use *note lookup(): 163d. for the codec
lookup:

 -- Function: codecs.getencoder (encoding)

     Look up the codec for the given encoding and return its encoder
     function.

     Raises a *note LookupError: 1599. in case the encoding cannot be
     found.

 -- Function: codecs.getdecoder (encoding)

     Look up the codec for the given encoding and return its decoder
     function.

     Raises a *note LookupError: 1599. in case the encoding cannot be
     found.

 -- Function: codecs.getincrementalencoder (encoding)

     Look up the codec for the given encoding and return its incremental
     encoder class or factory function.

     Raises a *note LookupError: 1599. in case the encoding cannot be
     found or the codec doesn’t support an incremental encoder.

 -- Function: codecs.getincrementaldecoder (encoding)

     Look up the codec for the given encoding and return its incremental
     decoder class or factory function.

     Raises a *note LookupError: 1599. in case the encoding cannot be
     found or the codec doesn’t support an incremental decoder.

 -- Function: codecs.getreader (encoding)

     Look up the codec for the given encoding and return its *note
     StreamReader: 1769. class or factory function.

     Raises a *note LookupError: 1599. in case the encoding cannot be
     found.

 -- Function: codecs.getwriter (encoding)

     Look up the codec for the given encoding and return its *note
     StreamWriter: 1768. class or factory function.

     Raises a *note LookupError: 1599. in case the encoding cannot be
     found.

Custom codecs are made available by registering a suitable codec search
function:

 -- Function: codecs.register (search_function)

     Register a codec search function.  Search functions are expected to
     take one argument, being the encoding name in all lower case
     letters, and return a *note CodecInfo: 175b. object.  In case a
     search function cannot find a given encoding, it should return
     ‘None’.

          Note: Search function registration is not currently
          reversible, which may cause problems in some cases, such as
          unit testing or module reloading.

While the builtin *note open(): 4e5. and the associated *note io: a1.
module are the recommended approach for working with encoded text files,
this module provides additional utility functions and classes that allow
the use of a wider range of codecs when working with binary files:

 -- Function: codecs.open (filename, mode='r', encoding=None,
          errors='strict', buffering=-1)

     Open an encoded file using the given `mode' and return an instance
     of *note StreamReaderWriter: 1771, providing transparent
     encoding/decoding.  The default file mode is ‘'r'’, meaning to open
     the file in read mode.

          Note: Underlying encoded files are always opened in binary
          mode.  No automatic conversion of ‘'\n'’ is done on reading
          and writing.  The `mode' argument may be any binary mode
          acceptable to the built-in *note open(): 4e5. function; the
          ‘'b'’ is automatically added.

     `encoding' specifies the encoding which is to be used for the file.
     Any encoding that encodes to and decodes from bytes is allowed, and
     the data types supported by the file methods depend on the codec
     used.

     `errors' may be given to define the error handling.  It defaults to
     ‘'strict'’ which causes a *note ValueError: 1f9. to be raised in
     case an encoding error occurs.

     `buffering' has the same meaning as for the built-in *note open():
     4e5. function.  It defaults to -1 which means that the default
     buffer size will be used.

 -- Function: codecs.EncodedFile (file, data_encoding,
          file_encoding=None, errors='strict')

     Return a *note StreamRecoder: eff. instance, a wrapped version of
     `file' which provides transparent transcoding.  The original file
     is closed when the wrapped version is closed.

     Data written to the wrapped file is decoded according to the given
     `data_encoding' and then written to the original file as bytes
     using `file_encoding'.  Bytes read from the original file are
     decoded according to `file_encoding', and the result is encoded
     using `data_encoding'.

     If `file_encoding' is not given, it defaults to `data_encoding'.

     `errors' may be given to define the error handling.  It defaults to
     ‘'strict'’, which causes *note ValueError: 1f9. to be raised in
     case an encoding error occurs.

 -- Function: codecs.iterencode (iterator, encoding, errors='strict',
          **kwargs)

     Uses an incremental encoder to iteratively encode the input
     provided by `iterator'.  This function is a *note generator: 996.
     The `errors' argument (as well as any other keyword argument) is
     passed through to the incremental encoder.

     This function requires that the codec accept text *note str: 325.
     objects to encode.  Therefore it does not support bytes-to-bytes
     encoders such as ‘base64_codec’.

 -- Function: codecs.iterdecode (iterator, encoding, errors='strict',
          **kwargs)

     Uses an incremental decoder to iteratively decode the input
     provided by `iterator'.  This function is a *note generator: 996.
     The `errors' argument (as well as any other keyword argument) is
     passed through to the incremental decoder.

     This function requires that the codec accept *note bytes: 326.
     objects to decode.  Therefore it does not support text-to-text
     encoders such as ‘rot_13’, although ‘rot_13’ may be used
     equivalently with *note iterencode(): 1773.

The module also provides the following constants which are useful for
reading and writing to platform dependent files:

 -- Data: codecs.BOM
 -- Data: codecs.BOM_BE
 -- Data: codecs.BOM_LE
 -- Data: codecs.BOM_UTF8
 -- Data: codecs.BOM_UTF16
 -- Data: codecs.BOM_UTF16_BE
 -- Data: codecs.BOM_UTF16_LE
 -- Data: codecs.BOM_UTF32
 -- Data: codecs.BOM_UTF32_BE
 -- Data: codecs.BOM_UTF32_LE

     These constants define various byte sequences, being Unicode byte
     order marks (BOMs) for several encodings.  They are used in UTF-16
     and UTF-32 data streams to indicate the byte order used, and in
     UTF-8 as a Unicode signature.  *note BOM_UTF16: 1779. is either
     *note BOM_UTF16_BE: 177a. or *note BOM_UTF16_LE: 177b. depending on
     the platform’s native byte order, *note BOM: 1775. is an alias for
     *note BOM_UTF16: 1779, *note BOM_LE: 1777. for *note BOM_UTF16_LE:
     177b. and *note BOM_BE: 1776. for *note BOM_UTF16_BE: 177a.  The
     others represent the BOM in UTF-8 and UTF-32 encodings.

* Menu:

* Codec Base Classes::
* Encodings and Unicode::
* Standard Encodings::
* Python Specific Encodings::
* encodings.idna — Internationalized Domain Names in Applications: encodings idna — Internationalized Domain Names in Applications.
* encodings.mbcs — Windows ANSI codepage: encodings mbcs — Windows ANSI codepage.
* encodings.utf_8_sig — UTF-8 codec with BOM signature: encodings utf_8_sig — UTF-8 codec with BOM signature.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/codecs.py


File: python.info,  Node: Codec Base Classes,  Next: Encodings and Unicode,  Up: codecs — Codec registry and base classes

5.7.2.1 Codec Base Classes
..........................

The *note codecs: 1c. module defines a set of base classes which define
the interfaces for working with codec objects, and can also be used as
the basis for custom codec implementations.

Each codec has to define four interfaces to make it usable as codec in
Python: stateless encoder, stateless decoder, stream reader and stream
writer.  The stream reader and writers typically reuse the stateless
encoder/decoder to implement the file protocols.  Codec authors also
need to define how the codec will handle encoding and decoding errors.
* Menu:

* Error Handlers::
* Stateless Encoding and Decoding::
* Incremental Encoding and Decoding::
* Stream Encoding and Decoding::


File: python.info,  Node: Error Handlers,  Next: Stateless Encoding and Decoding,  Up: Codec Base Classes

5.7.2.2 Error Handlers
......................

To simplify and standardize error handling, codecs may implement
different error handling schemes by accepting the `errors' string
argument.  The following string values are defined and implemented by
all standard Python codecs:

Value                         Meaning
                              
----------------------------------------------------------------------------------
                              
‘'strict'’                    Raise *note UnicodeError: c2e. (or a subclass);
                              this is the default.  Implemented in
                              *note strict_errors(): 1782.
                              
                              
‘'ignore'’                    Ignore the malformed data and continue without
                              further notice.  Implemented in
                              *note ignore_errors(): 1783.
                              

The following error handlers are only applicable to *note text
encodings: 1536.:

Value                         Meaning
                              
----------------------------------------------------------------------------------
                              
‘'replace'’                   Replace with a suitable replacement marker;
                              Python will use the official ‘U+FFFD’ REPLACEMENT
                              CHARACTER for the built-in codecs on decoding,
                              and ‘?’ on encoding.  Implemented in
                              *note replace_errors(): 1784.
                              
                              
‘'xmlcharrefreplace'’         Replace with the appropriate XML character
                              reference (only for encoding).  Implemented in
                              *note xmlcharrefreplace_errors(): 1785.
                              
                              
‘'backslashreplace'’          Replace with backslashed escape sequences.
                              Implemented in
                              *note backslashreplace_errors(): 1786.
                              
                              
‘'namereplace'’               Replace with ‘\N{...}’ escape sequences (only for
                              encoding).  Implemented in
                              *note namereplace_errors(): 1787.
                              
                              
‘'surrogateescape'’           On decoding, replace byte with individual
                              surrogate code ranging from ‘U+DC80’ to ‘U+DCFF’.
                              This code will then be turned back into the same
                              byte when the ‘'surrogateescape'’ error handler
                              is used when encoding the data.  (See PEP 383(1)
                              for more.)
                              

In addition, the following error handler is specific to the given
codecs:

Value                   Codecs                       Meaning
                                                     
-----------------------------------------------------------------------------------------------------
                                                     
‘'surrogatepass'’       utf-8, utf-16, utf-32,       Allow encoding and decoding of surrogate
                        utf-16-be, utf-16-le,        codes.  These codecs normally treat the
                        utf-32-be, utf-32-le         presence of surrogates as an error.
                                                     

New in version 3.1: The ‘'surrogateescape'’ and ‘'surrogatepass'’ error
handlers.

Changed in version 3.4: The ‘'surrogatepass'’ error handlers now works
with utf-16* and utf-32* codecs.

New in version 3.5: The ‘'namereplace'’ error handler.

Changed in version 3.5: The ‘'backslashreplace'’ error handlers now
works with decoding and translating.

The set of allowed values can be extended by registering a new named
error handler:

 -- Function: codecs.register_error (name, error_handler)

     Register the error handling function `error_handler' under the name
     `name'.  The `error_handler' argument will be called during
     encoding and decoding in case of an error, when `name' is specified
     as the errors parameter.

     For encoding, `error_handler' will be called with a *note
     UnicodeEncodeError: 1fa. instance, which contains information about
     the location of the error.  The error handler must either raise
     this or a different exception, or return a tuple with a replacement
     for the unencodable part of the input and a position where encoding
     should continue.  The replacement may be either *note str: 325. or
     *note bytes: 326.  If the replacement is bytes, the encoder will
     simply copy them into the output buffer.  If the replacement is a
     string, the encoder will encode the replacement.  Encoding
     continues on original input at the specified position.  Negative
     position values will be treated as being relative to the end of the
     input string.  If the resulting position is out of bound an *note
     IndexError: e69. will be raised.

     Decoding and translating works similarly, except *note
     UnicodeDecodeError: 1fb. or *note UnicodeTranslateError: 164d. will
     be passed to the handler and that the replacement from the error
     handler will be put into the output directly.

Previously registered error handlers (including the standard error
handlers) can be looked up by name:

 -- Function: codecs.lookup_error (name)

     Return the error handler previously registered under the name
     `name'.

     Raises a *note LookupError: 1599. in case the handler cannot be
     found.

The following standard error handlers are also made available as module
level functions:

 -- Function: codecs.strict_errors (exception)

     Implements the ‘'strict'’ error handling: each encoding or decoding
     error raises a *note UnicodeError: c2e.

 -- Function: codecs.replace_errors (exception)

     Implements the ‘'replace'’ error handling (for *note text
     encodings: 1536. only): substitutes ‘'?'’ for encoding errors (to
     be encoded by the codec), and ‘'\ufffd'’ (the Unicode replacement
     character) for decoding errors.

 -- Function: codecs.ignore_errors (exception)

     Implements the ‘'ignore'’ error handling: malformed data is ignored
     and encoding or decoding is continued without further notice.

 -- Function: codecs.xmlcharrefreplace_errors (exception)

     Implements the ‘'xmlcharrefreplace'’ error handling (for encoding
     with *note text encodings: 1536. only): the unencodable character
     is replaced by an appropriate XML character reference.

 -- Function: codecs.backslashreplace_errors (exception)

     Implements the ‘'backslashreplace'’ error handling (for *note text
     encodings: 1536. only): malformed data is replaced by a backslashed
     escape sequence.

 -- Function: codecs.namereplace_errors (exception)

     Implements the ‘'namereplace'’ error handling (for encoding with
     *note text encodings: 1536. only): the unencodable character is
     replaced by a ‘\N{...}’ escape sequence.

     New in version 3.5.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0383


File: python.info,  Node: Stateless Encoding and Decoding,  Next: Incremental Encoding and Decoding,  Prev: Error Handlers,  Up: Codec Base Classes

5.7.2.3 Stateless Encoding and Decoding
.......................................

The base ‘Codec’ class defines these methods which also define the
function interfaces of the stateless encoder and decoder:

 -- Method: Codec.encode (input[, errors])

     Encodes the object `input' and returns a tuple (output object,
     length consumed).  For instance, *note text encoding: 1536.
     converts a string object to a bytes object using a particular
     character set encoding (e.g., ‘cp1252’ or ‘iso-8859-1’).

     The `errors' argument defines the error handling to apply.  It
     defaults to ‘'strict'’ handling.

     The method may not store state in the ‘Codec’ instance.  Use *note
     StreamWriter: 1768. for codecs which have to keep state in order to
     make encoding efficient.

     The encoder must be able to handle zero length input and return an
     empty object of the output object type in this situation.

 -- Method: Codec.decode (input[, errors])

     Decodes the object `input' and returns a tuple (output object,
     length consumed).  For instance, for a *note text encoding: 1536,
     decoding converts a bytes object encoded using a particular
     character set encoding to a string object.

     For text encodings and bytes-to-bytes codecs, `input' must be a
     bytes object or one which provides the read-only buffer interface –
     for example, buffer objects and memory mapped files.

     The `errors' argument defines the error handling to apply.  It
     defaults to ‘'strict'’ handling.

     The method may not store state in the ‘Codec’ instance.  Use *note
     StreamReader: 1769. for codecs which have to keep state in order to
     make decoding efficient.

     The decoder must be able to handle zero length input and return an
     empty object of the output object type in this situation.


File: python.info,  Node: Incremental Encoding and Decoding,  Next: Stream Encoding and Decoding,  Prev: Stateless Encoding and Decoding,  Up: Codec Base Classes

5.7.2.4 Incremental Encoding and Decoding
.........................................

The *note IncrementalEncoder: 1764. and *note IncrementalDecoder: 1765.
classes provide the basic interface for incremental encoding and
decoding.  Encoding/decoding the input isn’t done with one call to the
stateless encoder/decoder function, but with multiple calls to the *note
encode(): 178a./*note decode(): 178b. method of the incremental
encoder/decoder.  The incremental encoder/decoder keeps track of the
encoding/decoding process during method calls.

The joined output of calls to the *note encode(): 178a./*note decode():
178b. method is the same as if all the single inputs were joined into
one, and this input was encoded/decoded with the stateless
encoder/decoder.

* Menu:

* IncrementalEncoder Objects::
* IncrementalDecoder Objects::


File: python.info,  Node: IncrementalEncoder Objects,  Next: IncrementalDecoder Objects,  Up: Incremental Encoding and Decoding

5.7.2.5 IncrementalEncoder Objects
..................................

The *note IncrementalEncoder: 1764. class is used for encoding an input
in multiple steps.  It defines the following methods which every
incremental encoder must define in order to be compatible with the
Python codec registry.

 -- Class: codecs.IncrementalEncoder (errors='strict')

     Constructor for an *note IncrementalEncoder: 1764. instance.

     All incremental encoders must provide this constructor interface.
     They are free to add additional keyword arguments, but only the
     ones defined here are used by the Python codec registry.

     The *note IncrementalEncoder: 1764. may implement different error
     handling schemes by providing the `errors' keyword argument.  See
     *note Error Handlers: 129c. for possible values.

     The `errors' argument will be assigned to an attribute of the same
     name.  Assigning to this attribute makes it possible to switch
     between different error handling strategies during the lifetime of
     the *note IncrementalEncoder: 1764. object.

      -- Method: encode (object[, final])

          Encodes `object' (taking the current state of the encoder into
          account) and returns the resulting encoded object.  If this is
          the last call to *note encode(): 7f6. `final' must be true
          (the default is false).

      -- Method: reset ()

          Reset the encoder to the initial state.  The output is
          discarded: call ‘.encode(object, final=True)’, passing an
          empty byte or text string if necessary, to reset the encoder
          and to get the output.

      -- Method: getstate ()

          Return the current state of the encoder which must be an
          integer.  The implementation should make sure that ‘0’ is the
          most common state.  (States that are more complicated than
          integers can be converted into an integer by
          marshaling/pickling the state and encoding the bytes of the
          resulting string into an integer.)

      -- Method: setstate (state)

          Set the state of the encoder to `state'.  `state' must be an
          encoder state returned by *note getstate(): 178f.


File: python.info,  Node: IncrementalDecoder Objects,  Prev: IncrementalEncoder Objects,  Up: Incremental Encoding and Decoding

5.7.2.6 IncrementalDecoder Objects
..................................

The *note IncrementalDecoder: 1765. class is used for decoding an input
in multiple steps.  It defines the following methods which every
incremental decoder must define in order to be compatible with the
Python codec registry.

 -- Class: codecs.IncrementalDecoder (errors='strict')

     Constructor for an *note IncrementalDecoder: 1765. instance.

     All incremental decoders must provide this constructor interface.
     They are free to add additional keyword arguments, but only the
     ones defined here are used by the Python codec registry.

     The *note IncrementalDecoder: 1765. may implement different error
     handling schemes by providing the `errors' keyword argument.  See
     *note Error Handlers: 129c. for possible values.

     The `errors' argument will be assigned to an attribute of the same
     name.  Assigning to this attribute makes it possible to switch
     between different error handling strategies during the lifetime of
     the *note IncrementalDecoder: 1765. object.

      -- Method: decode (object[, final])

          Decodes `object' (taking the current state of the decoder into
          account) and returns the resulting decoded object.  If this is
          the last call to *note decode(): 7f7. `final' must be true
          (the default is false).  If `final' is true the decoder must
          decode the input completely and must flush all buffers.  If
          this isn’t possible (e.g.  because of incomplete byte
          sequences at the end of the input) it must initiate error
          handling just like in the stateless case (which might raise an
          exception).

      -- Method: reset ()

          Reset the decoder to the initial state.

      -- Method: getstate ()

          Return the current state of the decoder.  This must be a tuple
          with two items, the first must be the buffer containing the
          still undecoded input.  The second must be an integer and can
          be additional state info.  (The implementation should make
          sure that ‘0’ is the most common additional state info.)  If
          this additional state info is ‘0’ it must be possible to set
          the decoder to the state which has no input buffered and ‘0’
          as the additional state info, so that feeding the previously
          buffered input to the decoder returns it to the previous state
          without producing any output.  (Additional state info that is
          more complicated than integers can be converted into an
          integer by marshaling/pickling the info and encoding the bytes
          of the resulting string into an integer.)

      -- Method: setstate (state)

          Set the state of the decoder to `state'.  `state' must be a
          decoder state returned by *note getstate(): 1794.


File: python.info,  Node: Stream Encoding and Decoding,  Prev: Incremental Encoding and Decoding,  Up: Codec Base Classes

5.7.2.7 Stream Encoding and Decoding
....................................

The *note StreamWriter: 1768. and *note StreamReader: 1769. classes
provide generic working interfaces which can be used to implement new
encoding submodules very easily.  See ‘encodings.utf_8’ for an example
of how this is done.

* Menu:

* StreamWriter Objects::
* StreamReader Objects::
* StreamReaderWriter Objects::
* StreamRecoder Objects::


File: python.info,  Node: StreamWriter Objects,  Next: StreamReader Objects,  Up: Stream Encoding and Decoding

5.7.2.8 StreamWriter Objects
............................

The *note StreamWriter: 1768. class is a subclass of ‘Codec’ and defines
the following methods which every stream writer must define in order to
be compatible with the Python codec registry.

 -- Class: codecs.StreamWriter (stream, errors='strict')

     Constructor for a *note StreamWriter: 1768. instance.

     All stream writers must provide this constructor interface.  They
     are free to add additional keyword arguments, but only the ones
     defined here are used by the Python codec registry.

     The `stream' argument must be a file-like object open for writing
     text or binary data, as appropriate for the specific codec.

     The *note StreamWriter: 1768. may implement different error
     handling schemes by providing the `errors' keyword argument.  See
     *note Error Handlers: 129c. for the standard error handlers the
     underlying stream codec may support.

     The `errors' argument will be assigned to an attribute of the same
     name.  Assigning to this attribute makes it possible to switch
     between different error handling strategies during the lifetime of
     the *note StreamWriter: 1768. object.

      -- Method: write (object)

          Writes the object’s contents encoded to the stream.

      -- Method: writelines (list)

          Writes the concatenated list of strings to the stream
          (possibly by reusing the *note write(): 1799. method).  The
          standard bytes-to-bytes codecs do not support this method.

      -- Method: reset ()

          Flushes and resets the codec buffers used for keeping state.

          Calling this method should ensure that the data on the output
          is put into a clean state that allows appending of new fresh
          data without having to rescan the whole stream to recover
          state.

In addition to the above methods, the *note StreamWriter: 1768. must
also inherit all other methods and attributes from the underlying
stream.


File: python.info,  Node: StreamReader Objects,  Next: StreamReaderWriter Objects,  Prev: StreamWriter Objects,  Up: Stream Encoding and Decoding

5.7.2.9 StreamReader Objects
............................

The *note StreamReader: 1769. class is a subclass of ‘Codec’ and defines
the following methods which every stream reader must define in order to
be compatible with the Python codec registry.

 -- Class: codecs.StreamReader (stream, errors='strict')

     Constructor for a *note StreamReader: 1769. instance.

     All stream readers must provide this constructor interface.  They
     are free to add additional keyword arguments, but only the ones
     defined here are used by the Python codec registry.

     The `stream' argument must be a file-like object open for reading
     text or binary data, as appropriate for the specific codec.

     The *note StreamReader: 1769. may implement different error
     handling schemes by providing the `errors' keyword argument.  See
     *note Error Handlers: 129c. for the standard error handlers the
     underlying stream codec may support.

     The `errors' argument will be assigned to an attribute of the same
     name.  Assigning to this attribute makes it possible to switch
     between different error handling strategies during the lifetime of
     the *note StreamReader: 1769. object.

     The set of allowed values for the `errors' argument can be extended
     with *note register_error(): de8.

      -- Method: read ([size[, chars[, firstline]]])

          Decodes data from the stream and returns the resulting object.

          The `chars' argument indicates the number of decoded code
          points or bytes to return.  The *note read(): 179e. method
          will never return more data than requested, but it might
          return less, if there is not enough available.

          The `size' argument indicates the approximate maximum number
          of encoded bytes or code points to read for decoding.  The
          decoder can modify this setting as appropriate.  The default
          value -1 indicates to read and decode as much as possible.
          This parameter is intended to prevent having to decode huge
          files in one step.

          The `firstline' flag indicates that it would be sufficient to
          only return the first line, if there are decoding errors on
          later lines.

          The method should use a greedy read strategy meaning that it
          should read as much data as is allowed within the definition
          of the encoding and the given size, e.g.  if optional encoding
          endings or state markers are available on the stream, these
          should be read too.

      -- Method: readline ([size[, keepends]])

          Read one line from the input stream and return the decoded
          data.

          `size', if given, is passed as size argument to the stream’s
          *note read(): 179e. method.

          If `keepends' is false line-endings will be stripped from the
          lines returned.

      -- Method: readlines ([sizehint[, keepends]])

          Read all lines available on the input stream and return them
          as a list of lines.

          Line-endings are implemented using the codec’s *note decode():
          7f7. method and are included in the list entries if `keepends'
          is true.

          `sizehint', if given, is passed as the `size' argument to the
          stream’s *note read(): 179e. method.

      -- Method: reset ()

          Resets the codec buffers used for keeping state.

          Note that no stream repositioning should take place.  This
          method is primarily intended to be able to recover from
          decoding errors.

In addition to the above methods, the *note StreamReader: 1769. must
also inherit all other methods and attributes from the underlying
stream.


File: python.info,  Node: StreamReaderWriter Objects,  Next: StreamRecoder Objects,  Prev: StreamReader Objects,  Up: Stream Encoding and Decoding

5.7.2.10 StreamReaderWriter Objects
...................................

The *note StreamReaderWriter: 1771. is a convenience class that allows
wrapping streams which work in both read and write modes.

The design is such that one can use the factory functions returned by
the *note lookup(): 163d. function to construct the instance.

 -- Class: codecs.StreamReaderWriter (stream, Reader, Writer,
          errors='strict')

     Creates a *note StreamReaderWriter: 1771. instance.  `stream' must
     be a file-like object.  `Reader' and `Writer' must be factory
     functions or classes providing the *note StreamReader: 1769. and
     *note StreamWriter: 1768. interface resp.  Error handling is done
     in the same way as defined for the stream readers and writers.

*note StreamReaderWriter: 1771. instances define the combined interfaces
of *note StreamReader: 1769. and *note StreamWriter: 1768. classes.
They inherit all other methods and attributes from the underlying
stream.


File: python.info,  Node: StreamRecoder Objects,  Prev: StreamReaderWriter Objects,  Up: Stream Encoding and Decoding

5.7.2.11 StreamRecoder Objects
..............................

The *note StreamRecoder: eff. translates data from one encoding to
another, which is sometimes useful when dealing with different encoding
environments.

The design is such that one can use the factory functions returned by
the *note lookup(): 163d. function to construct the instance.

 -- Class: codecs.StreamRecoder (stream, encode, decode, Reader, Writer,
          errors='strict')

     Creates a *note StreamRecoder: eff. instance which implements a
     two-way conversion: `encode' and `decode' work on the frontend —
     the data visible to code calling ‘read()’ and ‘write()’, while
     `Reader' and `Writer' work on the backend — the data in `stream'.

     You can use these objects to do transparent transcodings, e.g.,
     from Latin-1 to UTF-8 and back.

     The `stream' argument must be a file-like object.

     The `encode' and `decode' arguments must adhere to the ‘Codec’
     interface.  `Reader' and `Writer' must be factory functions or
     classes providing objects of the *note StreamReader: 1769. and
     *note StreamWriter: 1768. interface respectively.

     Error handling is done in the same way as defined for the stream
     readers and writers.

*note StreamRecoder: eff. instances define the combined interfaces of
*note StreamReader: 1769. and *note StreamWriter: 1768. classes.  They
inherit all other methods and attributes from the underlying stream.


File: python.info,  Node: Encodings and Unicode,  Next: Standard Encodings,  Prev: Codec Base Classes,  Up: codecs — Codec registry and base classes

5.7.2.12 Encodings and Unicode
..............................

Strings are stored internally as sequences of code points in range
‘0x0’–‘0x10FFFF’.  (See PEP 393(1) for more details about the
implementation.)  Once a string object is used outside of CPU and
memory, endianness and how these arrays are stored as bytes become an
issue.  As with other codecs, serialising a string into a sequence of
bytes is known as `encoding', and recreating the string from the
sequence of bytes is known as `decoding'.  There are a variety of
different text serialisation codecs, which are collectivity referred to
as *note text encodings: 1536.

The simplest text encoding (called ‘'latin-1'’ or ‘'iso-8859-1'’) maps
the code points 0–255 to the bytes ‘0x0’–‘0xff’, which means that a
string object that contains code points above ‘U+00FF’ can’t be encoded
with this codec.  Doing so will raise a *note UnicodeEncodeError: 1fa.
that looks like the following (although the details of the error message
may differ): ‘UnicodeEncodeError: 'latin-1' codec can't encode character
'\u1234' in position 3: ordinal not in range(256)’.

There’s another group of encodings (the so called charmap encodings)
that choose a different subset of all Unicode code points and how these
code points are mapped to the bytes ‘0x0’–‘0xff’.  To see how this is
done simply open e.g.  ‘encodings/cp1252.py’ (which is an encoding that
is used primarily on Windows).  There’s a string constant with 256
characters that shows you which character is mapped to which byte value.

All of these encodings can only encode 256 of the 1114112 code points
defined in Unicode.  A simple and straightforward way that can store
each Unicode code point, is to store each code point as four consecutive
bytes.  There are two possibilities: store the bytes in big endian or in
little endian order.  These two encodings are called ‘UTF-32-BE’ and
‘UTF-32-LE’ respectively.  Their disadvantage is that if e.g.  you use
‘UTF-32-BE’ on a little endian machine you will always have to swap
bytes on encoding and decoding.  ‘UTF-32’ avoids this problem: bytes
will always be in natural endianness.  When these bytes are read by a
CPU with a different endianness, then bytes have to be swapped though.
To be able to detect the endianness of a ‘UTF-16’ or ‘UTF-32’ byte
sequence, there’s the so called BOM (“Byte Order Mark”).  This is the
Unicode character ‘U+FEFF’.  This character can be prepended to every
‘UTF-16’ or ‘UTF-32’ byte sequence.  The byte swapped version of this
character (‘0xFFFE’) is an illegal character that may not appear in a
Unicode text.  So when the first character in an ‘UTF-16’ or ‘UTF-32’
byte sequence appears to be a ‘U+FFFE’ the bytes have to be swapped on
decoding.  Unfortunately the character ‘U+FEFF’ had a second purpose as
a ‘ZERO WIDTH NO-BREAK SPACE’: a character that has no width and doesn’t
allow a word to be split.  It can e.g.  be used to give hints to a
ligature algorithm.  With Unicode 4.0 using ‘U+FEFF’ as a ‘ZERO WIDTH
NO-BREAK SPACE’ has been deprecated (with ‘U+2060’ (‘WORD JOINER’)
assuming this role).  Nevertheless Unicode software still must be able
to handle ‘U+FEFF’ in both roles: as a BOM it’s a device to determine
the storage layout of the encoded bytes, and vanishes once the byte
sequence has been decoded into a string; as a ‘ZERO WIDTH NO-BREAK
SPACE’ it’s a normal character that will be decoded like any other.

There’s another encoding that is able to encoding the full range of
Unicode characters: UTF-8.  UTF-8 is an 8-bit encoding, which means
there are no issues with byte order in UTF-8.  Each byte in a UTF-8 byte
sequence consists of two parts: marker bits (the most significant bits)
and payload bits.  The marker bits are a sequence of zero to four ‘1’
bits followed by a ‘0’ bit.  Unicode characters are encoded like this
(with x being payload bits, which when concatenated give the Unicode
character):

Range                                   Encoding
                                        
-------------------------------------------------------------------------------------------
                                        
‘U-00000000’ … ‘U-0000007F’             0xxxxxxx
                                        
                                        
‘U-00000080’ … ‘U-000007FF’             110xxxxx 10xxxxxx
                                        
                                        
‘U-00000800’ … ‘U-0000FFFF’             1110xxxx 10xxxxxx 10xxxxxx
                                        
                                        
‘U-00010000’ … ‘U-0010FFFF’             11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
                                        

The least significant bit of the Unicode character is the rightmost x
bit.

As UTF-8 is an 8-bit encoding no BOM is required and any ‘U+FEFF’
character in the decoded string (even if it’s the first character) is
treated as a ‘ZERO WIDTH NO-BREAK SPACE’.

Without external information it’s impossible to reliably determine which
encoding was used for encoding a string.  Each charmap encoding can
decode any random byte sequence.  However that’s not possible with
UTF-8, as UTF-8 byte sequences have a structure that doesn’t allow
arbitrary byte sequences.  To increase the reliability with which a
UTF-8 encoding can be detected, Microsoft invented a variant of UTF-8
(that Python 2.5 calls ‘"utf-8-sig"’) for its Notepad program: Before
any of the Unicode characters is written to the file, a UTF-8 encoded
BOM (which looks like this as a byte sequence: ‘0xef’, ‘0xbb’, ‘0xbf’)
is written.  As it’s rather improbable that any charmap encoded file
starts with these byte values (which would e.g.  map to

          LATIN SMALL LETTER I WITH DIAERESIS 
          RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK 
          INVERTED QUESTION MARK 

in iso-8859-1), this increases the probability that a ‘utf-8-sig’
encoding can be correctly guessed from the byte sequence.  So here the
BOM is not used to be able to determine the byte order used for
generating the byte sequence, but as a signature that helps in guessing
the encoding.  On encoding the utf-8-sig codec will write ‘0xef’,
‘0xbb’, ‘0xbf’ as the first three bytes to the file.  On decoding
‘utf-8-sig’ will skip those three bytes if they appear as the first
three bytes in the file.  In UTF-8, the use of the BOM is discouraged
and should generally be avoided.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393


File: python.info,  Node: Standard Encodings,  Next: Python Specific Encodings,  Prev: Encodings and Unicode,  Up: codecs — Codec registry and base classes

5.7.2.13 Standard Encodings
...........................

Python comes with a number of codecs built-in, either implemented as C
functions or with dictionaries as mapping tables.  The following table
lists the codecs by name, together with a few common aliases, and the
languages for which the encoding is likely used.  Neither the list of
aliases nor the list of languages is meant to be exhaustive.  Notice
that spelling alternatives that only differ in case or use a hyphen
instead of an underscore are also valid aliases; therefore, e.g.
‘'utf-8'’ is a valid alias for the ‘'utf_8'’ codec.

`CPython implementation detail:' Some common encodings can bypass the
codecs lookup machinery to improve performance.  These optimization
opportunities are only recognized by CPython for a limited set of (case
insensitive) aliases: utf-8, utf8, latin-1, latin1, iso-8859-1,
iso8859-1, mbcs (Windows only), ascii, us-ascii, utf-16, utf16, utf-32,
utf32, and the same using underscores instead of dashes.  Using
alternative aliases for these encodings may result in slower execution.

Changed in version 3.6: Optimization opportunity recognized for
us-ascii.

Many of the character sets support the same languages.  They vary in
individual characters (e.g.  whether the EURO SIGN is supported or not),
and in the assignment of characters to code positions.  For the European
languages in particular, the following variants typically exist:

   * an ISO 8859 codeset

   * a Microsoft Windows code page, which is typically derived from an
     8859 codeset, but replaces control characters with additional
     graphic characters

   * an IBM EBCDIC code page

   * an IBM PC code page, which is ASCII compatible

Codec                 Aliases                              Languages
                                                           
------------------------------------------------------------------------------------------------
                                                           
ascii                 646, us-ascii                        English
                                                           
                                                           
big5                  big5-tw, csbig5                      Traditional Chinese
                                                           
                                                           
big5hkscs             big5-hkscs, hkscs                    Traditional Chinese
                                                           
                                                           
cp037                 IBM037, IBM039                       English
                                                           
                                                           
cp273                 273, IBM273, csIBM273                German
                                                           
                                                           New in version 3.4.
                                                           
                                                           
cp424                 EBCDIC-CP-HE, IBM424                 Hebrew
                                                           
                                                           
cp437                 437, IBM437                          English
                                                           
                                                           
cp500                 EBCDIC-CP-BE, EBCDIC-CP-CH, IBM500   Western Europe
                                                           
                                                           
cp720                                                      Arabic
                                                           
                                                           
cp737                                                      Greek
                                                           
                                                           
cp775                 IBM775                               Baltic languages
                                                           
                                                           
cp850                 850, IBM850                          Western Europe
                                                           
                                                           
cp852                 852, IBM852                          Central and Eastern Europe
                                                           
                                                           
cp855                 855, IBM855                          Bulgarian, Byelorussian,
                                                           Macedonian, Russian, Serbian
                                                           
                                                           
cp856                                                      Hebrew
                                                           
                                                           
cp857                 857, IBM857                          Turkish
                                                           
                                                           
cp858                 858, IBM858                          Western Europe
                                                           
                                                           
cp860                 860, IBM860                          Portuguese
                                                           
                                                           
cp861                 861, CP-IS, IBM861                   Icelandic
                                                           
                                                           
cp862                 862, IBM862                          Hebrew
                                                           
                                                           
cp863                 863, IBM863                          Canadian
                                                           
                                                           
cp864                 IBM864                               Arabic
                                                           
                                                           
cp865                 865, IBM865                          Danish, Norwegian
                                                           
                                                           
cp866                 866, IBM866                          Russian
                                                           
                                                           
cp869                 869, CP-GR, IBM869                   Greek
                                                           
                                                           
cp874                                                      Thai
                                                           
                                                           
cp875                                                      Greek
                                                           
                                                           
cp932                 932, ms932, mskanji, ms-kanji        Japanese
                                                           
                                                           
cp949                 949, ms949, uhc                      Korean
                                                           
                                                           
cp950                 950, ms950                           Traditional Chinese
                                                           
                                                           
cp1006                                                     Urdu
                                                           
                                                           
cp1026                ibm1026                              Turkish
                                                           
                                                           
cp1125                1125, ibm1125, cp866u, ruscii        Ukrainian
                                                           
                                                           New in version 3.4.
                                                           
                                                           
cp1140                ibm1140                              Western Europe
                                                           
                                                           
cp1250                windows-1250                         Central and Eastern Europe
                                                           
                                                           
cp1251                windows-1251                         Bulgarian, Byelorussian,
                                                           Macedonian, Russian, Serbian
                                                           
                                                           
cp1252                windows-1252                         Western Europe
                                                           
                                                           
cp1253                windows-1253                         Greek
                                                           
                                                           
cp1254                windows-1254                         Turkish
                                                           
                                                           
cp1255                windows-1255                         Hebrew
                                                           
                                                           
cp1256                windows-1256                         Arabic
                                                           
                                                           
cp1257                windows-1257                         Baltic languages
                                                           
                                                           
cp1258                windows-1258                         Vietnamese
                                                           
                                                           
euc_jp                eucjp, ujis, u-jis                   Japanese
                                                           
                                                           
euc_jis_2004          jisx0213, eucjis2004                 Japanese
                                                           
                                                           
euc_jisx0213          eucjisx0213                          Japanese
                                                           
                                                           
euc_kr                euckr, korean, ksc5601, ks_c-5601,   Korean
                      ks_c-5601-1987, ksx1001, ks_x-1001   
                      
                                                           
gb2312                chinese, csiso58gb231280, euc-cn,    Simplified Chinese
                      euccn, eucgb2312-cn, gb2312-1980,    
                      gb2312-80, iso-ir-58
                      
                                                           
gbk                   936, cp936, ms936                    Unified Chinese
                                                           
                                                           
gb18030               gb18030-2000                         Unified Chinese
                                                           
                                                           
hz                    hzgb, hz-gb, hz-gb-2312              Simplified Chinese
                                                           
                                                           
iso2022_jp            csiso2022jp, iso2022jp,              Japanese
                      iso-2022-jp                          
                      
                                                           
iso2022_jp_1          iso2022jp-1, iso-2022-jp-1           Japanese
                                                           
                                                           
iso2022_jp_2          iso2022jp-2, iso-2022-jp-2           Japanese, Korean, Simplified
                                                           Chinese, Western Europe, Greek
                                                           
                                                           
iso2022_jp_2004       iso2022jp-2004, iso-2022-jp-2004     Japanese
                                                           
                                                           
iso2022_jp_3          iso2022jp-3, iso-2022-jp-3           Japanese
                                                           
                                                           
iso2022_jp_ext        iso2022jp-ext, iso-2022-jp-ext       Japanese
                                                           
                                                           
iso2022_kr            csiso2022kr, iso2022kr,              Korean
                      iso-2022-kr                          
                      
                                                           
latin_1               iso-8859-1, iso8859-1, 8859,         Western Europe
                      cp819, latin, latin1, L1             
                      
                                                           
iso8859_2             iso-8859-2, latin2, L2               Central and Eastern Europe
                                                           
                                                           
iso8859_3             iso-8859-3, latin3, L3               Esperanto, Maltese
                                                           
                                                           
iso8859_4             iso-8859-4, latin4, L4               Baltic languages
                                                           
                                                           
iso8859_5             iso-8859-5, cyrillic                 Bulgarian, Byelorussian,
                                                           Macedonian, Russian, Serbian
                                                           
                                                           
iso8859_6             iso-8859-6, arabic                   Arabic
                                                           
                                                           
iso8859_7             iso-8859-7, greek, greek8            Greek
                                                           
                                                           
iso8859_8             iso-8859-8, hebrew                   Hebrew
                                                           
                                                           
iso8859_9             iso-8859-9, latin5, L5               Turkish
                                                           
                                                           
iso8859_10            iso-8859-10, latin6, L6              Nordic languages
                                                           
                                                           
iso8859_11            iso-8859-11, thai                    Thai languages
                                                           
                                                           
iso8859_13            iso-8859-13, latin7, L7              Baltic languages
                                                           
                                                           
iso8859_14            iso-8859-14, latin8, L8              Celtic languages
                                                           
                                                           
iso8859_15            iso-8859-15, latin9, L9              Western Europe
                                                           
                                                           
iso8859_16            iso-8859-16, latin10, L10            South-Eastern Europe
                                                           
                                                           
johab                 cp1361, ms1361                       Korean
                                                           
                                                           
koi8_r                                                     Russian
                                                           
                                                           
koi8_t                                                     Tajik
                                                           
                                                           New in version 3.5.
                                                           
                                                           
koi8_u                                                     Ukrainian
                                                           
                                                           
kz1048                kz_1048, strk1048_2002, rk1048       Kazakh
                                                           
                                                           New in version 3.5.
                                                           
                                                           
mac_cyrillic          maccyrillic                          Bulgarian, Byelorussian,
                                                           Macedonian, Russian, Serbian
                                                           
                                                           
mac_greek             macgreek                             Greek
                                                           
                                                           
mac_iceland           maciceland                           Icelandic
                                                           
                                                           
mac_latin2            maclatin2, maccentraleurope          Central and Eastern Europe
                                                           
                                                           
mac_roman             macroman, macintosh                  Western Europe
                                                           
                                                           
mac_turkish           macturkish                           Turkish
                                                           
                                                           
ptcp154               csptcp154, pt154, cp154,             Kazakh
                      cyrillic-asian                       
                      
                                                           
shift_jis             csshiftjis, shiftjis, sjis, s_jis    Japanese
                                                           
                                                           
shift_jis_2004        shiftjis2004, sjis_2004, sjis2004    Japanese
                                                           
                                                           
shift_jisx0213        shiftjisx0213, sjisx0213,            Japanese
                      s_jisx0213                           
                      
                                                           
utf_32                U32, utf32                           all languages
                                                           
                                                           
utf_32_be             UTF-32BE                             all languages
                                                           
                                                           
utf_32_le             UTF-32LE                             all languages
                                                           
                                                           
utf_16                U16, utf16                           all languages
                                                           
                                                           
utf_16_be             UTF-16BE                             all languages
                                                           
                                                           
utf_16_le             UTF-16LE                             all languages
                                                           
                                                           
utf_7                 U7, unicode-1-1-utf-7                all languages
                                                           
                                                           
utf_8                 U8, UTF, utf8, cp65001               all languages
                                                           
                                                           
utf_8_sig                                                  all languages
                                                           

Changed in version 3.4: The utf-16* and utf-32* encoders no longer allow
surrogate code points (‘U+D800’–‘U+DFFF’) to be encoded.  The utf-32*
decoders no longer decode byte sequences that correspond to surrogate
code points.

Changed in version 3.8: ‘cp65001’ is now an alias to ‘utf_8’.


File: python.info,  Node: Python Specific Encodings,  Next: encodings idna — Internationalized Domain Names in Applications,  Prev: Standard Encodings,  Up: codecs — Codec registry and base classes

5.7.2.14 Python Specific Encodings
..................................

A number of predefined codecs are specific to Python, so their codec
names have no meaning outside Python.  These are listed in the tables
below based on the expected input and output types (note that while text
encodings are the most common use case for codecs, the underlying codec
infrastructure supports arbitrary data transforms rather than just text
encodings).  For asymmetric codecs, the stated meaning describes the
encoding direction.

* Menu:

* Text Encodings::
* Binary Transforms::
* Text Transforms::


File: python.info,  Node: Text Encodings,  Next: Binary Transforms,  Up: Python Specific Encodings

5.7.2.15 Text Encodings
.......................

The following codecs provide *note str: 325. to *note bytes: 326.
encoding and *note bytes-like object: 5dd. to *note str: 325. decoding,
similar to the Unicode text encodings.

Codec                    Aliases       Meaning
                                       
-----------------------------------------------------------------------
                                       
idna                                   Implement RFC 3490(1), see
                                       also
                                       *note encodings.idna: 77.
                                       Only ‘errors='strict'’ is
                                       supported.
                                       
                                       
mbcs                     ansi, dbcs    Windows only: Encode the
                                       operand according to the ANSI
                                       codepage (CP_ACP).
                                       
                                       
oem                                    Windows only: Encode the
                                       operand according to the OEM
                                       codepage (CP_OEMCP).
                                       
                                       New in version 3.6.
                                       
                                       
palmos                                 Encoding of PalmOS 3.5.
                                       
                                       
punycode                               Implement RFC 3492(2).
                                       Stateful codecs are not
                                       supported.
                                       
                                       
raw_unicode_escape                     Latin-1 encoding with
                                       ‘\uXXXX’ and ‘\UXXXXXXXX’ for
                                       other code points.  Existing
                                       backslashes are not escaped
                                       in any way.  It is used in
                                       the Python pickle protocol.
                                       
                                       
undefined                              Raise an exception for all
                                       conversions, even empty
                                       strings.  The error handler
                                       is ignored.
                                       
                                       
unicode_escape                         Encoding suitable as the
                                       contents of a Unicode literal
                                       in ASCII-encoded Python
                                       source code, except that
                                       quotes are not escaped.
                                       Decode from Latin-1 source
                                       code.  Beware that Python
                                       source code actually uses
                                       UTF-8 by default.
                                       

Changed in version 3.8: “unicode_internal” codec is removed.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3490.html

   (2) https://tools.ietf.org/html/rfc3492.html


File: python.info,  Node: Binary Transforms,  Next: Text Transforms,  Prev: Text Encodings,  Up: Python Specific Encodings

5.7.2.16 Binary Transforms
..........................

The following codecs provide binary transforms: *note bytes-like object:
5dd. to *note bytes: 326. mappings.  They are not supported by *note
bytes.decode(): c2b. (which only produces *note str: 325. output).

Codec                      Aliases                Meaning                            Encoder / decoder
                                                                                     
------------------------------------------------------------------------------------------------------------------------
                                                                                     
base64_codec (1)           base64, base_64        Convert the operand to multiline   *note base64.encodebytes(): 17ac.
                                                  MIME base64 (the result always     /
                                                  includes a trailing ‘'\n'’).       *note base64.decodebytes(): 17ad.
                                                                                     
                                                  Changed in version 3.4: accepts
                                                  any
                                                  *note bytes-like object: 5dd. as
                                                  input for encoding and decoding
                                                  
                                                                                     
bz2_codec                  bz2                    Compress the operand using bz2.    *note bz2.compress(): 17ae. /
                                                                                     *note bz2.decompress(): 9cb.
                                                                                     
                                                                                     
hex_codec                  hex                    Convert the operand to             *note binascii.b2a_hex(): 17af.
                                                  hexadecimal representation, with   /
                                                  two digits per byte.               *note binascii.a2b_hex(): 17b0.
                                                                                     
                                                                                     
quopri_codec               quopri,                Convert the operand to MIME        *note quopri.encode(): 17b1.
                           quotedprintable,       quoted printable.                  with ‘quotetabs=True’ /
                           quoted_printable                                          *note quopri.decode(): 17b2.
                                                                                     
                                                                                     
uu_codec                   uu                     Convert the operand using          *note uu.encode(): 404. /
                                                  uuencode.                          *note uu.decode(): 17b3.
                                                                                     
                                                                                     
zlib_codec                 zip, zlib              Compress the operand using gzip.   *note zlib.compress(): 5b3. /
                                                                                     *note zlib.decompress(): 5b4.
                                                                                     

New in version 3.2: Restoration of the binary transforms.

Changed in version 3.4: Restoration of the aliases for the binary
transforms.

   ---------- Footnotes ----------

   (1) (1) In addition to *note bytes-like objects: 5dd,
‘'base64_codec'’ also accepts ASCII-only instances of *note str: 325.
for decoding


File: python.info,  Node: Text Transforms,  Prev: Binary Transforms,  Up: Python Specific Encodings

5.7.2.17 Text Transforms
........................

The following codec provides a text transform: a *note str: 325. to
*note str: 325. mapping.  It is not supported by *note str.encode():
c2a. (which only produces *note bytes: 326. output).

Codec                    Aliases       Meaning
                                       
-----------------------------------------------------------------------
                                       
rot_13                   rot13         Return the Caesar-cypher
                                       encryption of the operand.
                                       

New in version 3.2: Restoration of the ‘rot_13’ text transform.

Changed in version 3.4: Restoration of the ‘rot13’ alias.


File: python.info,  Node: encodings idna — Internationalized Domain Names in Applications,  Next: encodings mbcs — Windows ANSI codepage,  Prev: Python Specific Encodings,  Up: codecs — Codec registry and base classes

5.7.2.18 ‘encodings.idna’ — Internationalized Domain Names in Applications
..........................................................................

This module implements RFC 3490(1) (Internationalized Domain Names in
Applications) and RFC 3492(2) (Nameprep: A Stringprep Profile for
Internationalized Domain Names (IDN)). It builds upon the ‘punycode’
encoding and *note stringprep: f7.

These RFCs together define a protocol to support non-ASCII characters in
domain names.  A domain name containing non-ASCII characters (such as
‘www.Alliancefrançaise.nu’) is converted into an ASCII-compatible
encoding (ACE, such as ‘www.xn--alliancefranaise-npb.nu’).  The ACE form
of the domain name is then used in all places where arbitrary characters
are not allowed by the protocol, such as DNS queries, HTTP ‘Host’
fields, and so on.  This conversion is carried out in the application;
if possible invisible to the user: The application should transparently
convert Unicode domain labels to IDNA on the wire, and convert back ACE
labels to Unicode before presenting them to the user.

Python supports this conversion in several ways: the ‘idna’ codec
performs conversion between Unicode and ACE, separating an input string
into labels based on the separator characters defined in section 3.1 of
RFC 3490(3) and converting each label to ACE as required, and conversely
separating an input byte string into labels based on the ‘.’ separator
and converting any ACE labels found into unicode.  Furthermore, the
*note socket: ef. module transparently converts Unicode host names to
ACE, so that applications need not be concerned about converting host
names themselves when they pass them to the socket module.  On top of
that, modules that have host names as function parameters, such as *note
http.client: 94. and *note ftplib: 84, accept Unicode host names (*note
http.client: 94. then also transparently sends an IDNA hostname in the
‘Host’ field if it sends that field at all).

When receiving host names from the wire (such as in reverse name
lookup), no automatic conversion to Unicode is performed: applications
wishing to present such host names to the user should decode them to
Unicode.

The module *note encodings.idna: 77. also implements the nameprep
procedure, which performs certain normalizations on host names, to
achieve case-insensitivity of international domain names, and to unify
similar characters.  The nameprep functions can be used directly if
desired.

 -- Function: encodings.idna.nameprep (label)

     Return the nameprepped version of `label'.  The implementation
     currently assumes query strings, so ‘AllowUnassigned’ is true.

 -- Function: encodings.idna.ToASCII (label)

     Convert a label to ASCII, as specified in RFC 3490(4).
     ‘UseSTD3ASCIIRules’ is assumed to be false.

 -- Function: encodings.idna.ToUnicode (label)

     Convert a label to Unicode, as specified in RFC 3490(5).

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3490.html

   (2) https://tools.ietf.org/html/rfc3492.html

   (3) https://tools.ietf.org/html/rfc3490.html#section-3.1

   (4) https://tools.ietf.org/html/rfc3490.html

   (5) https://tools.ietf.org/html/rfc3490.html


File: python.info,  Node: encodings mbcs — Windows ANSI codepage,  Next: encodings utf_8_sig — UTF-8 codec with BOM signature,  Prev: encodings idna — Internationalized Domain Names in Applications,  Up: codecs — Codec registry and base classes

5.7.2.19 ‘encodings.mbcs’ — Windows ANSI codepage
.................................................

This module implements the ANSI codepage (CP_ACP).

*note Availability: 129a.: Windows only.

Changed in version 3.3: Support any error handler.

Changed in version 3.2: Before 3.2, the `errors' argument was ignored;
‘'replace'’ was always used to encode, and ‘'ignore'’ to decode.


File: python.info,  Node: encodings utf_8_sig — UTF-8 codec with BOM signature,  Prev: encodings mbcs — Windows ANSI codepage,  Up: codecs — Codec registry and base classes

5.7.2.20 ‘encodings.utf_8_sig’ — UTF-8 codec with BOM signature
...............................................................

This module implements a variant of the UTF-8 codec.  On encoding, a
UTF-8 encoded BOM will be prepended to the UTF-8 encoded bytes.  For the
stateful encoder this is only done once (on the first write to the byte
stream).  On decoding, an optional UTF-8 encoded BOM at the start of the
data will be skipped.


File: python.info,  Node: Data Types,  Next: Numeric and Mathematical Modules,  Prev: Binary Data Services,  Up: The Python Standard Library

5.8 Data Types
==============

The modules described in this chapter provide a variety of specialized
data types such as dates and times, fixed-type arrays, heap queues,
double-ended queues, and enumerations.

Python also provides some built-in data types, in particular, *note
dict: 1b6, *note list: 260, *note set: b62. and *note frozenset: be1,
and *note tuple: 473.  The *note str: 325. class is used to hold Unicode
strings, and the *note bytes: 326. and *note bytearray: 327. classes are
used to hold binary data.

The following modules are documented in this chapter:

* Menu:

* datetime — Basic date and time types::
* calendar — General calendar-related functions::
* collections — Container datatypes::
* collections.abc — Abstract Base Classes for Containers: collections abc — Abstract Base Classes for Containers.
* heapq — Heap queue algorithm::
* bisect — Array bisection algorithm::
* array — Efficient arrays of numeric values::
* weakref — Weak references::
* types — Dynamic type creation and names for built-in types::
* copy — Shallow and deep copy operations::
* pprint — Data pretty printer::
* reprlib — Alternate repr() implementation: reprlib — Alternate repr implementation.
* enum — Support for enumerations::


File: python.info,  Node: datetime — Basic date and time types,  Next: calendar — General calendar-related functions,  Up: Data Types

5.8.1 ‘datetime’ — Basic date and time types
--------------------------------------------

`Source code:' Lib/datetime.py(1)

__________________________________________________________________

The *note datetime: 31. module supplies classes for manipulating dates
and times.

While date and time arithmetic is supported, the focus of the
implementation is on efficient attribute extraction for output
formatting and manipulation.

See also
........

Module *note calendar: 15.

     General calendar related functions.

Module *note time: 10a.

     Time access and conversions.

Package dateutil(2)

     Third-party library with expanded time zone and parsing support.

* Menu:

* Aware and Naive Objects::
* Constants::
* Available Types::
* timedelta Objects::
* date Objects::
* datetime Objects::
* time Objects::
* tzinfo Objects::
* timezone Objects::
* strftime() and strptime() Behavior: strftime and strptime Behavior.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/datetime.py

   (2) https://dateutil.readthedocs.io/en/stable/


File: python.info,  Node: Aware and Naive Objects,  Next: Constants,  Up: datetime — Basic date and time types

5.8.1.1 Aware and Naive Objects
...............................

Date and time objects may be categorized as “aware” or “naive.”

With sufficient knowledge of applicable algorithmic and political time
adjustments, such as time zone and daylight saving time information, an
`aware' object can locate itself relative to other aware objects.  An
aware object represents a specific moment in time that is not open to
interpretation.  (1)

A `naive' object does not contain enough information to unambiguously
locate itself relative to other date/time objects.  Whether a naive
object represents Coordinated Universal Time (UTC), local time, or time
in some other timezone is purely up to the program, just like it is up
to the program whether a particular number represents metres, miles, or
mass.  Naive objects are easy to understand and to work with, at the
cost of ignoring some aspects of reality.

For applications requiring aware objects, *note datetime: 194. and *note
time: 4e8. objects have an optional time zone information attribute,
‘tzinfo’, that can be set to an instance of a subclass of the abstract
*note tzinfo: 375. class.  These *note tzinfo: 375. objects capture
information about the offset from UTC time, the time zone name, and
whether daylight saving time is in effect.

Only one concrete *note tzinfo: 375. class, the *note timezone: 9f5.
class, is supplied by the *note datetime: 31. module.  The *note
timezone: 9f5. class can represent simple timezones with fixed offsets
from UTC, such as UTC itself or North American EST and EDT timezones.
Supporting timezones at deeper levels of detail is up to the
application.  The rules for time adjustment across the world are more
political than rational, change frequently, and there is no standard
suitable for every application aside from UTC.

   ---------- Footnotes ----------

   (1) (1) If, that is, we ignore the effects of Relativity


File: python.info,  Node: Constants,  Next: Available Types,  Prev: Aware and Naive Objects,  Up: datetime — Basic date and time types

5.8.1.2 Constants
.................

The *note datetime: 31. module exports the following constants:

 -- Data: datetime.MINYEAR

     The smallest year number allowed in a *note date: 193. or *note
     datetime: 194. object.  *note MINYEAR: 17c3. is ‘1’.

 -- Data: datetime.MAXYEAR

     The largest year number allowed in a *note date: 193. or *note
     datetime: 194. object.  *note MAXYEAR: 17c4. is ‘9999’.


File: python.info,  Node: Available Types,  Next: timedelta Objects,  Prev: Constants,  Up: datetime — Basic date and time types

5.8.1.3 Available Types
.......................

 -- Class: datetime.date

     An idealized naive date, assuming the current Gregorian calendar
     always was, and always will be, in effect.  Attributes: *note year:
     17c6, *note month: 17c7, and *note day: 17c8.

 -- Class: datetime.time

     An idealized time, independent of any particular day, assuming that
     every day has exactly 24*60*60 seconds.  (There is no notion of
     “leap seconds” here.)  Attributes: *note hour: 17c9, *note minute:
     17ca, *note second: 17cb, *note microsecond: 17cc, and *note
     tzinfo: 17cd.

 -- Class: datetime.datetime

     A combination of a date and a time.  Attributes: *note year: 17ce,
     *note month: 17cf, *note day: 17d0, *note hour: 17d1, *note minute:
     17d2, *note second: 17d3, *note microsecond: 17d4, and *note
     tzinfo: 17d5.

 -- Class: datetime.timedelta

     A duration expressing the difference between two *note date: 193,
     *note time: 4e8, or *note datetime: 194. instances to microsecond
     resolution.

 -- Class: datetime.tzinfo

     An abstract base class for time zone information objects.  These
     are used by the *note datetime: 194. and *note time: 4e8. classes
     to provide a customizable notion of time adjustment (for example,
     to account for time zone and/or daylight saving time).

 -- Class: datetime.timezone

     A class that implements the *note tzinfo: 375. abstract base class
     as a fixed offset from the UTC.

     New in version 3.2.

Objects of these types are immutable.

Subclass relationships:

     object
         timedelta
         tzinfo
             timezone
         time
         date
             datetime

* Menu:

* Common Properties::
* Determining if an Object is Aware or Naive::


File: python.info,  Node: Common Properties,  Next: Determining if an Object is Aware or Naive,  Up: Available Types

5.8.1.4 Common Properties
.........................

The *note date: 193, *note datetime: 194, *note time: 4e8, and *note
timezone: 9f5. types share these common features:

   - Objects of these types are immutable.

   - Objects of these types are hashable, meaning that they can be used
     as dictionary keys.

   - Objects of these types support efficient pickling via the *note
     pickle: ca. module.


File: python.info,  Node: Determining if an Object is Aware or Naive,  Prev: Common Properties,  Up: Available Types

5.8.1.5 Determining if an Object is Aware or Naive
..................................................

Objects of the *note date: 193. type are always naive.

An object of type *note time: 4e8. or *note datetime: 194. may be aware
or naive.

A *note datetime: 194. object `d' is aware if both of the following
hold:

  1. ‘d.tzinfo’ is not ‘None’

  2. ‘d.tzinfo.utcoffset(d)’ does not return ‘None’

Otherwise, `d' is naive.

A *note time: 4e8. object `t' is aware if both of the following hold:

  1. ‘t.tzinfo’ is not ‘None’

  2. ‘t.tzinfo.utcoffset(None)’ does not return ‘None’.

Otherwise, `t' is naive.

The distinction between aware and naive doesn’t apply to *note
timedelta: 195. objects.


File: python.info,  Node: timedelta Objects,  Next: date Objects,  Prev: Available Types,  Up: datetime — Basic date and time types

5.8.1.6 ‘timedelta’ Objects
...........................

A *note timedelta: 195. object represents a duration, the difference
between two dates or times.

 -- Class: datetime.timedelta (days=0, seconds=0, microseconds=0,
          milliseconds=0, minutes=0, hours=0, weeks=0)

     All arguments are optional and default to ‘0’.  Arguments may be
     integers or floats, and may be positive or negative.

     Only `days', `seconds' and `microseconds' are stored internally.
     Arguments are converted to those units:

        * A millisecond is converted to 1000 microseconds.

        * A minute is converted to 60 seconds.

        * An hour is converted to 3600 seconds.

        * A week is converted to 7 days.

     and days, seconds and microseconds are then normalized so that the
     representation is unique, with

        * ‘0 <= microseconds < 1000000’

        * ‘0 <= seconds < 3600*24’ (the number of seconds in one day)

        * ‘-999999999 <= days <= 999999999’

     The following example illustrates how any arguments besides `days',
     `seconds' and `microseconds' are “merged” and normalized into those
     three resulting attributes:

          >>> from datetime import timedelta
          >>> delta = timedelta(
          ...     days=50,
          ...     seconds=27,
          ...     microseconds=10,
          ...     milliseconds=29000,
          ...     minutes=5,
          ...     hours=8,
          ...     weeks=2
          ... )
          >>> # Only days, seconds, and microseconds remain
          >>> delta
          datetime.timedelta(days=64, seconds=29156, microseconds=10)

     If any argument is a float and there are fractional microseconds,
     the fractional microseconds left over from all arguments are
     combined and their sum is rounded to the nearest microsecond using
     round-half-to-even tiebreaker.  If no argument is a float, the
     conversion and normalization processes are exact (no information is
     lost).

     If the normalized value of days lies outside the indicated range,
     *note OverflowError: 954. is raised.

     Note that normalization of negative values may be surprising at
     first.  For example:

          >>> from datetime import timedelta
          >>> d = timedelta(microseconds=-1)
          >>> (d.days, d.seconds, d.microseconds)
          (-1, 86399, 999999)

Class attributes:

 -- Attribute: timedelta.min

     The most negative *note timedelta: 195. object,
     ‘timedelta(-999999999)’.

 -- Attribute: timedelta.max

     The most positive *note timedelta: 195. object,
     ‘timedelta(days=999999999, hours=23, minutes=59, seconds=59,
     microseconds=999999)’.

 -- Attribute: timedelta.resolution

     The smallest possible difference between non-equal *note timedelta:
     195. objects, ‘timedelta(microseconds=1)’.

Note that, because of normalization, ‘timedelta.max’ > ‘-timedelta.min’.
‘-timedelta.max’ is not representable as a *note timedelta: 195. object.

Instance attributes (read-only):

Attribute              Value
                       
------------------------------------------------------------------------
                       
‘days’                 Between -999999999 and 999999999 inclusive
                       
                       
‘seconds’              Between 0 and 86399 inclusive
                       
                       
‘microseconds’         Between 0 and 999999 inclusive
                       

Supported operations:

Operation                            Result
                                     
-----------------------------------------------------------------------------------------
                                     
‘t1 = t2 + t3’                       Sum of `t2' and `t3'.  Afterwards `t1'-`t2' ==
                                     `t3' and `t1'-`t3' == `t2' are true.  (1)
                                     
                                     
‘t1 = t2 - t3’                       Difference of `t2' and `t3'.  Afterwards `t1' ==
                                     `t2' - `t3' and `t2' == `t1' + `t3' are true.
                                     (1)(6)
                                     
                                     
‘t1 = t2 * i or t1 = i * t2’         Delta multiplied by an integer.  Afterwards `t1'
                                     // i == `t2' is true, provided ‘i != 0’.
                                     
                                     
                                     In general, `t1' * i == `t1' * (i-1) + `t1' is
                                     true.  (1)
                                     
                                     
‘t1 = t2 * f or t1 = f * t2’         Delta multiplied by a float.  The result is
                                     rounded to the nearest multiple of
                                     timedelta.resolution using round-half-to-even.
                                     
                                     
‘f = t2 / t3’                        Division (3) of overall duration `t2' by interval
                                     unit `t3'.  Returns a *note float: 187. object.
                                     
                                     
‘t1 = t2 / f or t1 = t2 / i’         Delta divided by a float or an int.  The result
                                     is rounded to the nearest multiple of
                                     timedelta.resolution using round-half-to-even.
                                     
                                     
‘t1 = t2 // i’ or ‘t1 = t2 // t3’    The floor is computed and the remainder (if any)
                                     is thrown away.  In the second case, an integer
                                     is returned.  (3)
                                     
                                     
‘t1 = t2 % t3’                       The remainder is computed as a
                                     *note timedelta: 195. object.  (3)
                                     
                                     
‘q, r = divmod(t1, t2)’              Computes the quotient and the remainder: ‘q = t1
                                     // t2’ (3) and ‘r = t1 % t2’.  q is an integer
                                     and r is a *note timedelta: 195. object.
                                     
                                     
‘+t1’                                Returns a *note timedelta: 195. object with the
                                     same value.  (2)
                                     
                                     
‘-t1’                                equivalent to *note timedelta: 195.(-`t1.days',
                                     -`t1.seconds', -`t1.microseconds'), and to `t1'*
                                     -1.  (1)(4)
                                     
                                     
‘abs(t)’                             equivalent to +`t' when ‘t.days >= 0’, and to
                                     -`t' when ‘t.days < 0’.  (2)
                                     
                                     
‘str(t)’                             Returns a string in the form ‘[D day[s],
                                     ][H]H:MM:SS[.UUUUUU]’, where D is negative for
                                     negative ‘t’.  (5)
                                     
                                     
‘repr(t)’                            Returns a string representation of the
                                     *note timedelta: 195. object as a constructor
                                     call with canonical attribute values.
                                     

Notes:

  1. This is exact but may overflow.

  2. This is exact and cannot overflow.

  3. Division by 0 raises *note ZeroDivisionError: 11e6.

  4. -`timedelta.max' is not representable as a *note timedelta: 195.
     object.

  5. String representations of *note timedelta: 195. objects are
     normalized similarly to their internal representation.  This leads
     to somewhat unusual results for negative timedeltas.  For example:

          >>> timedelta(hours=-5)
          datetime.timedelta(days=-1, seconds=68400)
          >>> print(_)
          -1 day, 19:00:00

  6. The expression ‘t2 - t3’ will always be equal to the expression ‘t2
     + (-t3)’ except when t3 is equal to ‘timedelta.max’; in that case
     the former will produce a result while the latter will overflow.

In addition to the operations listed above, *note timedelta: 195.
objects support certain additions and subtractions with *note date: 193.
and *note datetime: 194. objects (see below).

Changed in version 3.2: Floor division and true division of a *note
timedelta: 195. object by another *note timedelta: 195. object are now
supported, as are remainder operations and the *note divmod(): f4d.
function.  True division and multiplication of a *note timedelta: 195.
object by a *note float: 187. object are now supported.

Comparisons of *note timedelta: 195. objects are supported, with some
caveats.

The comparisons ‘==’ or ‘!=’ `always' return a *note bool: 183, no
matter the type of the compared object:

     >>> from datetime import timedelta
     >>> delta1 = timedelta(seconds=57)
     >>> delta2 = timedelta(hours=25, seconds=2)
     >>> delta2 != delta1
     True
     >>> delta2 == 5
     False

For all other comparisons (such as ‘<’ and ‘>’), when a *note timedelta:
195. object is compared to an object of a different type, *note
TypeError: 192. is raised:

     >>> delta2 > delta1
     True
     >>> delta2 > 5
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: '>' not supported between instances of 'datetime.timedelta' and 'int'

In Boolean contexts, a *note timedelta: 195. object is considered to be
true if and only if it isn’t equal to ‘timedelta(0)’.

Instance methods:

 -- Method: timedelta.total_seconds ()

     Return the total number of seconds contained in the duration.
     Equivalent to ‘td / timedelta(seconds=1)’.  For interval units
     other than seconds, use the division form directly (e.g.  ‘td /
     timedelta(microseconds=1)’).

     Note that for very large time intervals (greater than 270 years on
     most platforms) this method will lose microsecond accuracy.

     New in version 3.2.

* Menu:

* Examples of usage; timedelta: Examples of usage timedelta.


File: python.info,  Node: Examples of usage timedelta,  Up: timedelta Objects

5.8.1.7 Examples of usage: ‘timedelta’
......................................

An additional example of normalization:

     >>> # Components of another_year add up to exactly 365 days
     >>> from datetime import timedelta
     >>> year = timedelta(days=365)
     >>> another_year = timedelta(weeks=40, days=84, hours=23,
     ...                          minutes=50, seconds=600)
     >>> year == another_year
     True
     >>> year.total_seconds()
     31536000.0

Examples of *note timedelta: 195. arithmetic:

     >>> from datetime import timedelta
     >>> year = timedelta(days=365)
     >>> ten_years = 10 * year
     >>> ten_years
     datetime.timedelta(days=3650)
     >>> ten_years.days // 365
     10
     >>> nine_years = ten_years - year
     >>> nine_years
     datetime.timedelta(days=3285)
     >>> three_years = nine_years // 3
     >>> three_years, three_years.days // 365
     (datetime.timedelta(days=1095), 3)


File: python.info,  Node: date Objects,  Next: datetime Objects,  Prev: timedelta Objects,  Up: datetime — Basic date and time types

5.8.1.8 ‘date’ Objects
......................

A *note date: 193. object represents a date (year, month and day) in an
idealized calendar, the current Gregorian calendar indefinitely extended
in both directions.

January 1 of year 1 is called day number 1, January 2 of year 1 is
called day number 2, and so on.  (1)

 -- Class: datetime.date (year, month, day)

     All arguments are required.  Arguments must be integers, in the
     following ranges:

        * ‘MINYEAR <= year <= MAXYEAR’

        * ‘1 <= month <= 12’

        * ‘1 <= day <= number of days in the given month and year’

     If an argument outside those ranges is given, *note ValueError:
     1f9. is raised.

Other constructors, all class methods:

 -- Class Method: date.today ()

     Return the current local date.

     This is equivalent to ‘date.fromtimestamp(time.time())’.

 -- Class Method: date.fromtimestamp (timestamp)

     Return the local date corresponding to the POSIX timestamp, such as
     is returned by *note time.time(): 312.

     This may raise *note OverflowError: 954, if the timestamp is out of
     the range of values supported by the platform C ‘localtime()’
     function, and *note OSError: 1d1. on ‘localtime()’ failure.  It’s
     common for this to be restricted to years from 1970 through 2038.
     Note that on non-POSIX systems that include leap seconds in their
     notion of a timestamp, leap seconds are ignored by *note
     fromtimestamp(): 17e1.

     Changed in version 3.3: Raise *note OverflowError: 954. instead of
     *note ValueError: 1f9. if the timestamp is out of the range of
     values supported by the platform C ‘localtime()’ function.  Raise
     *note OSError: 1d1. instead of *note ValueError: 1f9. on
     ‘localtime()’ failure.

 -- Class Method: date.fromordinal (ordinal)

     Return the date corresponding to the proleptic Gregorian ordinal,
     where January 1 of year 1 has ordinal 1.

     *note ValueError: 1f9. is raised unless ‘1 <= ordinal <=
     date.max.toordinal()’.  For any date `d',
     ‘date.fromordinal(d.toordinal()) == d’.

 -- Class Method: date.fromisoformat (date_string)

     Return a *note date: 193. corresponding to a `date_string' given in
     the format ‘YYYY-MM-DD’:

          >>> from datetime import date
          >>> date.fromisoformat('2019-12-04')
          datetime.date(2019, 12, 4)

     This is the inverse of *note date.isoformat(): 17e3.  It only
     supports the format ‘YYYY-MM-DD’.

     New in version 3.7.

 -- Class Method: date.fromisocalendar (year, week, day)

     Return a *note date: 193. corresponding to the ISO calendar date
     specified by year, week and day.  This is the inverse of the
     function *note date.isocalendar(): 17e4.

     New in version 3.8.

Class attributes:

 -- Attribute: date.min

     The earliest representable date, ‘date(MINYEAR, 1, 1)’.

 -- Attribute: date.max

     The latest representable date, ‘date(MAXYEAR, 12, 31)’.

 -- Attribute: date.resolution

     The smallest possible difference between non-equal date objects,
     ‘timedelta(days=1)’.

Instance attributes (read-only):

 -- Attribute: date.year

     Between *note MINYEAR: 17c3. and *note MAXYEAR: 17c4. inclusive.

 -- Attribute: date.month

     Between 1 and 12 inclusive.

 -- Attribute: date.day

     Between 1 and the number of days in the given month of the given
     year.

Supported operations:

Operation                           Result
                                    
---------------------------------------------------------------------------------------
                                    
‘date2 = date1 + timedelta’         `date2' is ‘timedelta.days’ days removed from
                                    `date1'.  (1)
                                    
                                    
‘date2 = date1 - timedelta’         Computes `date2' such that ‘date2 + timedelta ==
                                    date1’.  (2)
                                    
                                    
‘timedelta = date1 - date2’         (3)
                                    
                                    
‘date1 < date2’                     `date1' is considered less than `date2' when
                                    `date1' precedes `date2' in time.  (4)
                                    

Notes:

  1. `date2' is moved forward in time if ‘timedelta.days > 0’, or
     backward if ‘timedelta.days < 0’.  Afterward ‘date2 - date1 ==
     timedelta.days’.  ‘timedelta.seconds’ and ‘timedelta.microseconds’
     are ignored.  *note OverflowError: 954. is raised if ‘date2.year’
     would be smaller than *note MINYEAR: 17c3. or larger than *note
     MAXYEAR: 17c4.

  2. ‘timedelta.seconds’ and ‘timedelta.microseconds’ are ignored.

  3. This is exact, and cannot overflow.  timedelta.seconds and
     timedelta.microseconds are 0, and date2 + timedelta == date1 after.

  4. In other words, ‘date1 < date2’ if and only if ‘date1.toordinal() <
     date2.toordinal()’.  Date comparison raises *note TypeError: 192.
     if the other comparand isn’t also a *note date: 193. object.
     However, ‘NotImplemented’ is returned instead if the other
     comparand has a ‘timetuple()’ attribute.  This hook gives other
     kinds of date objects a chance at implementing mixed-type
     comparison.  If not, when a *note date: 193. object is compared to
     an object of a different type, *note TypeError: 192. is raised
     unless the comparison is ‘==’ or ‘!=’.  The latter cases return
     *note False: 37d. or *note True: 48f, respectively.

In Boolean contexts, all *note date: 193. objects are considered to be
true.

Instance methods:

 -- Method: date.replace (year=self.year, month=self.month,
          day=self.day)

     Return a date with the same value, except for those parameters
     given new values by whichever keyword arguments are specified.

     Example:

          >>> from datetime import date
          >>> d = date(2002, 12, 31)
          >>> d.replace(day=26)
          datetime.date(2002, 12, 26)

 -- Method: date.timetuple ()

     Return a *note time.struct_time: 58e. such as returned by *note
     time.localtime(): 17ea.

     The hours, minutes and seconds are 0, and the DST flag is -1.

     ‘d.timetuple()’ is equivalent to:

          time.struct_time((d.year, d.month, d.day, 0, 0, 0, d.weekday(), yday, -1))

     where ‘yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1’
     is the day number within the current year starting with ‘1’ for
     January 1st.

 -- Method: date.toordinal ()

     Return the proleptic Gregorian ordinal of the date, where January 1
     of year 1 has ordinal 1.  For any *note date: 193. object `d',
     ‘date.fromordinal(d.toordinal()) == d’.

 -- Method: date.weekday ()

     Return the day of the week as an integer, where Monday is 0 and
     Sunday is 6.  For example, ‘date(2002, 12, 4).weekday() == 2’, a
     Wednesday.  See also *note isoweekday(): 17ed.

 -- Method: date.isoweekday ()

     Return the day of the week as an integer, where Monday is 1 and
     Sunday is 7.  For example, ‘date(2002, 12, 4).isoweekday() == 3’, a
     Wednesday.  See also *note weekday(): 17ec, *note isocalendar():
     17e4.

 -- Method: date.isocalendar ()

     Return a 3-tuple, (ISO year, ISO week number, ISO weekday).

     The ISO calendar is a widely used variant of the Gregorian
     calendar.  (2)

     The ISO year consists of 52 or 53 full weeks, and where a week
     starts on a Monday and ends on a Sunday.  The first week of an ISO
     year is the first (Gregorian) calendar week of a year containing a
     Thursday.  This is called week number 1, and the ISO year of that
     Thursday is the same as its Gregorian year.

     For example, 2004 begins on a Thursday, so the first week of ISO
     year 2004 begins on Monday, 29 Dec 2003 and ends on Sunday, 4 Jan
     2004:

          >>> from datetime import date
          >>> date(2003, 12, 29).isocalendar()
          (2004, 1, 1)
          >>> date(2004, 1, 4).isocalendar()
          (2004, 1, 7)

 -- Method: date.isoformat ()

     Return a string representing the date in ISO 8601 format,
     ‘YYYY-MM-DD’:

          >>> from datetime import date
          >>> date(2002, 12, 4).isoformat()
          '2002-12-04'

     This is the inverse of *note date.fromisoformat(): fcf.

 -- Method: date.__str__ ()

     For a date `d', ‘str(d)’ is equivalent to ‘d.isoformat()’.

 -- Method: date.ctime ()

     Return a string representing the date:

          >>> from datetime import date
          >>> date(2002, 12, 4).ctime()
          'Wed Dec  4 00:00:00 2002'

     ‘d.ctime()’ is equivalent to:

          time.ctime(time.mktime(d.timetuple()))

     on platforms where the native C ‘ctime()’ function (which *note
     time.ctime(): 17f0. invokes, but which *note date.ctime(): 17ef.
     does not invoke) conforms to the C standard.

 -- Method: date.strftime (format)

     Return a string representing the date, controlled by an explicit
     format string.  Format codes referring to hours, minutes or seconds
     will see 0 values.  For a complete list of formatting directives,
     see *note strftime() and strptime() Behavior: 17f1.

 -- Method: date.__format__ (format)

     Same as *note date.strftime(): 52d.  This makes it possible to
     specify a format string for a *note date: 193. object in *note
     formatted string literals: 15c. and when using *note str.format():
     4cf.  For a complete list of formatting directives, see *note
     strftime() and strptime() Behavior: 17f1.

* Menu:

* Examples of Usage; date: Examples of Usage date.

   ---------- Footnotes ----------

   (1) (2) This matches the definition of the “proleptic Gregorian”
calendar in Dershowitz and Reingold’s book `Calendrical Calculations',
where it’s the base calendar for all computations.  See the book for
algorithms for converting between proleptic Gregorian ordinals and many
other calendar systems.

   (2) (3) See R. H. van Gent’s guide to the mathematics of the ISO 8601
calendar
(https://www.staff.science.uu.nl/~gent0113/calendar/isocalendar.htm) for
a good explanation.


File: python.info,  Node: Examples of Usage date,  Up: date Objects

5.8.1.9 Examples of Usage: ‘date’
.................................

Example of counting days to an event:

     >>> import time
     >>> from datetime import date
     >>> today = date.today()
     >>> today
     datetime.date(2007, 12, 5)
     >>> today == date.fromtimestamp(time.time())
     True
     >>> my_birthday = date(today.year, 6, 24)
     >>> if my_birthday < today:
     ...     my_birthday = my_birthday.replace(year=today.year + 1)
     >>> my_birthday
     datetime.date(2008, 6, 24)
     >>> time_to_birthday = abs(my_birthday - today)
     >>> time_to_birthday.days
     202

More examples of working with *note date: 193.:

     >>> from datetime import date
     >>> d = date.fromordinal(730920) # 730920th day after 1. 1. 0001
     >>> d
     datetime.date(2002, 3, 11)

     >>> # Methods related to formatting string output
     >>> d.isoformat()
     '2002-03-11'
     >>> d.strftime("%d/%m/%y")
     '11/03/02'
     >>> d.strftime("%A %d. %B %Y")
     'Monday 11. March 2002'
     >>> d.ctime()
     'Mon Mar 11 00:00:00 2002'
     >>> 'The {1} is {0:%d}, the {2} is {0:%B}.'.format(d, "day", "month")
     'The day is 11, the month is March.'

     >>> # Methods for to extracting 'components' under different calendars
     >>> t = d.timetuple()
     >>> for i in t:
     ...     print(i)
     2002                # year
     3                   # month
     11                  # day
     0
     0
     0
     0                   # weekday (0 = Monday)
     70                  # 70th day in the year
     -1
     >>> ic = d.isocalendar()
     >>> for i in ic:
     ...     print(i)
     2002                # ISO year
     11                  # ISO week number
     1                   # ISO day number ( 1 = Monday )

     >>> # A date object is immutable; all operations produce a new object
     >>> d.replace(year=2005)
     datetime.date(2005, 3, 11)


File: python.info,  Node: datetime Objects,  Next: time Objects,  Prev: date Objects,  Up: datetime — Basic date and time types

5.8.1.10 ‘datetime’ Objects
...........................

A *note datetime: 194. object is a single object containing all the
information from a *note date: 193. object and a *note time: 4e8.
object.

Like a *note date: 193. object, *note datetime: 194. assumes the current
Gregorian calendar extended in both directions; like a *note time: 4e8.
object, *note datetime: 194. assumes there are exactly 3600*24 seconds
in every day.

Constructor:

 -- Class: datetime.datetime (year, month, day, hour=0, minute=0,
          second=0, microsecond=0, tzinfo=None, *, fold=0)

     The `year', `month' and `day' arguments are required.  `tzinfo' may
     be ‘None’, or an instance of a *note tzinfo: 375. subclass.  The
     remaining arguments must be integers in the following ranges:

        * ‘MINYEAR <= year <= MAXYEAR’,

        * ‘1 <= month <= 12’,

        * ‘1 <= day <= number of days in the given month and year’,

        * ‘0 <= hour < 24’,

        * ‘0 <= minute < 60’,

        * ‘0 <= second < 60’,

        * ‘0 <= microsecond < 1000000’,

        * ‘fold in [0, 1]’.

     If an argument outside those ranges is given, *note ValueError:
     1f9. is raised.

     New in version 3.6: Added the ‘fold’ argument.

Other constructors, all class methods:

 -- Class Method: datetime.today ()

     Return the current local datetime, with *note tzinfo: 17d5. ‘None’.

     Equivalent to:

          datetime.fromtimestamp(time.time())

     See also *note now(): f34, *note fromtimestamp(): fc3.

     This method is functionally equivalent to *note now(): f34, but
     without a ‘tz’ parameter.

 -- Class Method: datetime.now (tz=None)

     Return the current local date and time.

     If optional argument `tz' is ‘None’ or not specified, this is like
     *note today(): 17f6, but, if possible, supplies more precision than
     can be gotten from going through a *note time.time(): 312.
     timestamp (for example, this may be possible on platforms supplying
     the C ‘gettimeofday()’ function).

     If `tz' is not ‘None’, it must be an instance of a *note tzinfo:
     375. subclass, and the current date and time are converted to
     `tz'’s time zone.

     This function is preferred over *note today(): 17f6. and *note
     utcnow(): 17f7.

 -- Class Method: datetime.utcnow ()

     Return the current UTC date and time, with *note tzinfo: 17d5.
     ‘None’.

     This is like *note now(): f34, but returns the current UTC date and
     time, as a naive *note datetime: 194. object.  An aware current UTC
     datetime can be obtained by calling ‘datetime.now(timezone.utc)’.
     See also *note now(): f34.

          Warning: Because naive ‘datetime’ objects are treated by many
          ‘datetime’ methods as local times, it is preferred to use
          aware datetimes to represent times in UTC. As such, the
          recommended way to create an object representing the current
          time in UTC is by calling ‘datetime.now(timezone.utc)’.

 -- Class Method: datetime.fromtimestamp (timestamp, tz=None)

     Return the local date and time corresponding to the POSIX
     timestamp, such as is returned by *note time.time(): 312.  If
     optional argument `tz' is ‘None’ or not specified, the timestamp is
     converted to the platform’s local date and time, and the returned
     *note datetime: 194. object is naive.

     If `tz' is not ‘None’, it must be an instance of a *note tzinfo:
     375. subclass, and the timestamp is converted to `tz'’s time zone.

     *note fromtimestamp(): fc3. may raise *note OverflowError: 954, if
     the timestamp is out of the range of values supported by the
     platform C ‘localtime()’ or ‘gmtime()’ functions, and *note
     OSError: 1d1. on ‘localtime()’ or ‘gmtime()’ failure.  It’s common
     for this to be restricted to years in 1970 through 2038.  Note that
     on non-POSIX systems that include leap seconds in their notion of a
     timestamp, leap seconds are ignored by *note fromtimestamp(): fc3,
     and then it’s possible to have two timestamps differing by a second
     that yield identical *note datetime: 194. objects.  This method is
     preferred over *note utcfromtimestamp(): 17f8.

     Changed in version 3.3: Raise *note OverflowError: 954. instead of
     *note ValueError: 1f9. if the timestamp is out of the range of
     values supported by the platform C ‘localtime()’ or ‘gmtime()’
     functions.  Raise *note OSError: 1d1. instead of *note ValueError:
     1f9. on ‘localtime()’ or ‘gmtime()’ failure.

     Changed in version 3.6: *note fromtimestamp(): fc3. may return
     instances with *note fold: 4e9. set to 1.

 -- Class Method: datetime.utcfromtimestamp (timestamp)

     Return the UTC *note datetime: 194. corresponding to the POSIX
     timestamp, with *note tzinfo: 17d5. ‘None’.  (The resulting object
     is naive.)

     This may raise *note OverflowError: 954, if the timestamp is out of
     the range of values supported by the platform C ‘gmtime()’
     function, and *note OSError: 1d1. on ‘gmtime()’ failure.  It’s
     common for this to be restricted to years in 1970 through 2038.

     To get an aware *note datetime: 194. object, call *note
     fromtimestamp(): fc3.:

          datetime.fromtimestamp(timestamp, timezone.utc)

     On the POSIX compliant platforms, it is equivalent to the following
     expression:

          datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)

     except the latter formula always supports the full years range:
     between *note MINYEAR: 17c3. and *note MAXYEAR: 17c4. inclusive.

          Warning: Because naive ‘datetime’ objects are treated by many
          ‘datetime’ methods as local times, it is preferred to use
          aware datetimes to represent times in UTC. As such, the
          recommended way to create an object representing a specific
          timestamp in UTC is by calling
          ‘datetime.fromtimestamp(timestamp, tz=timezone.utc)’.

     Changed in version 3.3: Raise *note OverflowError: 954. instead of
     *note ValueError: 1f9. if the timestamp is out of the range of
     values supported by the platform C ‘gmtime()’ function.  Raise
     *note OSError: 1d1. instead of *note ValueError: 1f9. on ‘gmtime()’
     failure.

 -- Class Method: datetime.fromordinal (ordinal)

     Return the *note datetime: 194. corresponding to the proleptic
     Gregorian ordinal, where January 1 of year 1 has ordinal 1.  *note
     ValueError: 1f9. is raised unless ‘1 <= ordinal <=
     datetime.max.toordinal()’.  The hour, minute, second and
     microsecond of the result are all 0, and *note tzinfo: 17d5. is
     ‘None’.

 -- Class Method: datetime.combine (date, time, tzinfo=self.tzinfo)

     Return a new *note datetime: 194. object whose date components are
     equal to the given *note date: 193. object’s, and whose time
     components are equal to the given *note time: 4e8. object’s.  If
     the `tzinfo' argument is provided, its value is used to set the
     *note tzinfo: 17d5. attribute of the result, otherwise the *note
     tzinfo: 17cd. attribute of the `time' argument is used.

     For any *note datetime: 194. object `d', ‘d ==
     datetime.combine(d.date(), d.time(), d.tzinfo)’.  If date is a
     *note datetime: 194. object, its time components and *note tzinfo:
     17d5. attributes are ignored.

     Changed in version 3.6: Added the `tzinfo' argument.

 -- Class Method: datetime.fromisoformat (date_string)

     Return a *note datetime: 194. corresponding to a `date_string' in
     one of the formats emitted by *note date.isoformat(): 17e3. and
     *note datetime.isoformat(): 374.

     Specifically, this function supports strings in the format:

          YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]]

     where ‘*’ can match any single character.

          Caution: This does `not' support parsing arbitrary ISO 8601
          strings - it is only intended as the inverse operation of
          *note datetime.isoformat(): 374.  A more full-featured ISO
          8601 parser, ‘dateutil.parser.isoparse’ is available in the
          third-party package dateutil(1).  This does not support
          parsing arbitrary ISO 8601 strings - it is only intended as
          the inverse operation of *note datetime.isoformat(): 374.

     Examples:

          >>> from datetime import datetime
          >>> datetime.fromisoformat('2011-11-04')
          datetime.datetime(2011, 11, 4, 0, 0)
          >>> datetime.fromisoformat('2011-11-04T00:05:23')
          datetime.datetime(2011, 11, 4, 0, 5, 23)
          >>> datetime.fromisoformat('2011-11-04 00:05:23.283')
          datetime.datetime(2011, 11, 4, 0, 5, 23, 283000)
          >>> datetime.fromisoformat('2011-11-04 00:05:23.283+00:00')
          datetime.datetime(2011, 11, 4, 0, 5, 23, 283000, tzinfo=datetime.timezone.utc)
          >>> datetime.fromisoformat('2011-11-04T00:05:23+04:00')
          datetime.datetime(2011, 11, 4, 0, 5, 23,
              tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))

     New in version 3.7.

 -- Class Method: datetime.fromisocalendar (year, week, day)

     Return a *note datetime: 194. corresponding to the ISO calendar
     date specified by year, week and day.  The non-date components of
     the datetime are populated with their normal default values.  This
     is the inverse of the function *note datetime.isocalendar(): 17fa.

     New in version 3.8.

 -- Class Method: datetime.strptime (date_string, format)

     Return a *note datetime: 194. corresponding to `date_string',
     parsed according to `format'.

     This is equivalent to:

          datetime(*(time.strptime(date_string, format)[0:6]))

     *note ValueError: 1f9. is raised if the date_string and format
     can’t be parsed by *note time.strptime(): d84. or if it returns a
     value which isn’t a time tuple.  For a complete list of formatting
     directives, see *note strftime() and strptime() Behavior: 17f1.

Class attributes:

 -- Attribute: datetime.min

     The earliest representable *note datetime: 194, ‘datetime(MINYEAR,
     1, 1, tzinfo=None)’.

 -- Attribute: datetime.max

     The latest representable *note datetime: 194, ‘datetime(MAXYEAR,
     12, 31, 23, 59, 59, 999999, tzinfo=None)’.

 -- Attribute: datetime.resolution

     The smallest possible difference between non-equal *note datetime:
     194. objects, ‘timedelta(microseconds=1)’.

Instance attributes (read-only):

 -- Attribute: datetime.year

     Between *note MINYEAR: 17c3. and *note MAXYEAR: 17c4. inclusive.

 -- Attribute: datetime.month

     Between 1 and 12 inclusive.

 -- Attribute: datetime.day

     Between 1 and the number of days in the given month of the given
     year.

 -- Attribute: datetime.hour

     In ‘range(24)’.

 -- Attribute: datetime.minute

     In ‘range(60)’.

 -- Attribute: datetime.second

     In ‘range(60)’.

 -- Attribute: datetime.microsecond

     In ‘range(1000000)’.

 -- Attribute: datetime.tzinfo

     The object passed as the `tzinfo' argument to the *note datetime:
     194. constructor, or ‘None’ if none was passed.

 -- Attribute: datetime.fold

     In ‘[0, 1]’.  Used to disambiguate wall times during a repeated
     interval.  (A repeated interval occurs when clocks are rolled back
     at the end of daylight saving time or when the UTC offset for the
     current zone is decreased for political reasons.)  The value 0 (1)
     represents the earlier (later) of the two moments with the same
     wall time representation.

     New in version 3.6.

Supported operations:

Operation                                   Result
                                            
---------------------------------------------------------------------------------
                                            
‘datetime2 = datetime1 + timedelta’         (1)
                                            
                                            
‘datetime2 = datetime1 - timedelta’         (2)
                                            
                                            
‘timedelta = datetime1 - datetime2’         (3)
                                            
                                            
‘datetime1 < datetime2’                     Compares *note datetime: 194. to
                                            *note datetime: 194.  (4)
                                            

  1. datetime2 is a duration of timedelta removed from datetime1, moving
     forward in time if ‘timedelta.days’ > 0, or backward if
     ‘timedelta.days’ < 0.  The result has the same *note tzinfo: 17d5.
     attribute as the input datetime, and datetime2 - datetime1 ==
     timedelta after.  *note OverflowError: 954. is raised if
     datetime2.year would be smaller than *note MINYEAR: 17c3. or larger
     than *note MAXYEAR: 17c4.  Note that no time zone adjustments are
     done even if the input is an aware object.

  2. Computes the datetime2 such that datetime2 + timedelta ==
     datetime1.  As for addition, the result has the same *note tzinfo:
     17d5. attribute as the input datetime, and no time zone adjustments
     are done even if the input is aware.

  3. Subtraction of a *note datetime: 194. from a *note datetime: 194.
     is defined only if both operands are naive, or if both are aware.
     If one is aware and the other is naive, *note TypeError: 192. is
     raised.

     If both are naive, or both are aware and have the same *note
     tzinfo: 17d5. attribute, the *note tzinfo: 17d5. attributes are
     ignored, and the result is a *note timedelta: 195. object `t' such
     that ‘datetime2 + t == datetime1’.  No time zone adjustments are
     done in this case.

     If both are aware and have different *note tzinfo: 17d5.
     attributes, ‘a-b’ acts as if `a' and `b' were first converted to
     naive UTC datetimes first.  The result is ‘(a.replace(tzinfo=None)
     - a.utcoffset()) - (b.replace(tzinfo=None) - b.utcoffset())’ except
     that the implementation never overflows.

  4. `datetime1' is considered less than `datetime2' when `datetime1'
     precedes `datetime2' in time.

     If one comparand is naive and the other is aware, *note TypeError:
     192. is raised if an order comparison is attempted.  For equality
     comparisons, naive instances are never equal to aware instances.

     If both comparands are aware, and have the same *note tzinfo: 17d5.
     attribute, the common *note tzinfo: 17d5. attribute is ignored and
     the base datetimes are compared.  If both comparands are aware and
     have different *note tzinfo: 17d5. attributes, the comparands are
     first adjusted by subtracting their UTC offsets (obtained from
     ‘self.utcoffset()’).

     Changed in version 3.3: Equality comparisons between aware and
     naive *note datetime: 194. instances don’t raise *note TypeError:
     192.

          Note: In order to stop comparison from falling back to the
          default scheme of comparing object addresses, datetime
          comparison normally raises *note TypeError: 192. if the other
          comparand isn’t also a *note datetime: 194. object.  However,
          ‘NotImplemented’ is returned instead if the other comparand
          has a ‘timetuple()’ attribute.  This hook gives other kinds of
          date objects a chance at implementing mixed-type comparison.
          If not, when a *note datetime: 194. object is compared to an
          object of a different type, *note TypeError: 192. is raised
          unless the comparison is ‘==’ or ‘!=’.  The latter cases
          return *note False: 37d. or *note True: 48f, respectively.

Instance methods:

 -- Method: datetime.date ()

     Return *note date: 193. object with same year, month and day.

 -- Method: datetime.time ()

     Return *note time: 4e8. object with same hour, minute, second,
     microsecond and fold.  *note tzinfo: 17d5. is ‘None’.  See also
     method *note timetz(): 1800.

     Changed in version 3.6: The fold value is copied to the returned
     *note time: 4e8. object.

 -- Method: datetime.timetz ()

     Return *note time: 4e8. object with same hour, minute, second,
     microsecond, fold, and tzinfo attributes.  See also method *note
     time(): 10a.

     Changed in version 3.6: The fold value is copied to the returned
     *note time: 4e8. object.

 -- Method: datetime.replace (year=self.year, month=self.month,
          day=self.day, hour=self.hour, minute=self.minute,
          second=self.second, microsecond=self.microsecond,
          tzinfo=self.tzinfo, * fold=0)

     Return a datetime with the same attributes, except for those
     attributes given new values by whichever keyword arguments are
     specified.  Note that ‘tzinfo=None’ can be specified to create a
     naive datetime from an aware datetime with no conversion of date
     and time data.

     New in version 3.6: Added the ‘fold’ argument.

 -- Method: datetime.astimezone (tz=None)

     Return a *note datetime: 194. object with new *note tzinfo: 17d5.
     attribute `tz', adjusting the date and time data so the result is
     the same UTC time as `self', but in `tz'’s local time.

     If provided, `tz' must be an instance of a *note tzinfo: 375.
     subclass, and its *note utcoffset(): 1802. and *note dst(): 1803.
     methods must not return ‘None’.  If `self' is naive, it is presumed
     to represent time in the system timezone.

     If called without arguments (or with ‘tz=None’) the system local
     timezone is assumed for the target timezone.  The ‘.tzinfo’
     attribute of the converted datetime instance will be set to an
     instance of *note timezone: 9f5. with the zone name and offset
     obtained from the OS.

     If ‘self.tzinfo’ is `tz', ‘self.astimezone(tz)’ is equal to `self':
     no adjustment of date or time data is performed.  Else the result
     is local time in the timezone `tz', representing the same UTC time
     as `self': after ‘astz = dt.astimezone(tz)’, ‘astz -
     astz.utcoffset()’ will have the same date and time data as ‘dt -
     dt.utcoffset()’.

     If you merely want to attach a time zone object `tz' to a datetime
     `dt' without adjustment of date and time data, use
     ‘dt.replace(tzinfo=tz)’.  If you merely want to remove the time
     zone object from an aware datetime `dt' without conversion of date
     and time data, use ‘dt.replace(tzinfo=None)’.

     Note that the default *note tzinfo.fromutc(): 1804. method can be
     overridden in a *note tzinfo: 375. subclass to affect the result
     returned by *note astimezone(): 196.  Ignoring error cases, *note
     astimezone(): 196. acts like:

          def astimezone(self, tz):
              if self.tzinfo is tz:
                  return self
              # Convert self to UTC, and attach the new time zone object.
              utc = (self - self.utcoffset()).replace(tzinfo=tz)
              # Convert from UTC to tz's local time.
              return tz.fromutc(utc)

     Changed in version 3.3: `tz' now can be omitted.

     Changed in version 3.6: The *note astimezone(): 196. method can now
     be called on naive instances that are presumed to represent system
     local time.

 -- Method: datetime.utcoffset ()

     If *note tzinfo: 17d5. is ‘None’, returns ‘None’, else returns
     ‘self.tzinfo.utcoffset(self)’, and raises an exception if the
     latter doesn’t return ‘None’ or a *note timedelta: 195. object with
     magnitude less than one day.

     Changed in version 3.7: The UTC offset is not restricted to a whole
     number of minutes.

 -- Method: datetime.dst ()

     If *note tzinfo: 17d5. is ‘None’, returns ‘None’, else returns
     ‘self.tzinfo.dst(self)’, and raises an exception if the latter
     doesn’t return ‘None’ or a *note timedelta: 195. object with
     magnitude less than one day.

     Changed in version 3.7: The DST offset is not restricted to a whole
     number of minutes.

 -- Method: datetime.tzname ()

     If *note tzinfo: 17d5. is ‘None’, returns ‘None’, else returns
     ‘self.tzinfo.tzname(self)’, raises an exception if the latter
     doesn’t return ‘None’ or a string object,

 -- Method: datetime.timetuple ()

     Return a *note time.struct_time: 58e. such as returned by *note
     time.localtime(): 17ea.

     ‘d.timetuple()’ is equivalent to:

          time.struct_time((d.year, d.month, d.day,
                            d.hour, d.minute, d.second,
                            d.weekday(), yday, dst))

     where ‘yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1’
     is the day number within the current year starting with ‘1’ for
     January 1st.  The ‘tm_isdst’ flag of the result is set according to
     the *note dst(): 1803. method: *note tzinfo: 17d5. is ‘None’ or
     *note dst(): 1803. returns ‘None’, ‘tm_isdst’ is set to ‘-1’; else
     if *note dst(): 1803. returns a non-zero value, ‘tm_isdst’ is set
     to ‘1’; else ‘tm_isdst’ is set to ‘0’.

 -- Method: datetime.utctimetuple ()

     If *note datetime: 194. instance `d' is naive, this is the same as
     ‘d.timetuple()’ except that ‘tm_isdst’ is forced to 0 regardless of
     what ‘d.dst()’ returns.  DST is never in effect for a UTC time.

     If `d' is aware, `d' is normalized to UTC time, by subtracting
     ‘d.utcoffset()’, and a *note time.struct_time: 58e. for the
     normalized time is returned.  ‘tm_isdst’ is forced to 0.  Note that
     an *note OverflowError: 954. may be raised if `d'.year was
     ‘MINYEAR’ or ‘MAXYEAR’ and UTC adjustment spills over a year
     boundary.

          Warning: Because naive ‘datetime’ objects are treated by many
          ‘datetime’ methods as local times, it is preferred to use
          aware datetimes to represent times in UTC; as a result, using
          ‘utcfromtimetuple’ may give misleading results.  If you have a
          naive ‘datetime’ representing UTC, use
          ‘datetime.replace(tzinfo=timezone.utc)’ to make it aware, at
          which point you can use *note datetime.timetuple(): 1806.

 -- Method: datetime.toordinal ()

     Return the proleptic Gregorian ordinal of the date.  The same as
     ‘self.date().toordinal()’.

 -- Method: datetime.timestamp ()

     Return POSIX timestamp corresponding to the *note datetime: 194.
     instance.  The return value is a *note float: 187. similar to that
     returned by *note time.time(): 312.

     Naive *note datetime: 194. instances are assumed to represent local
     time and this method relies on the platform C ‘mktime()’ function
     to perform the conversion.  Since *note datetime: 194. supports
     wider range of values than ‘mktime()’ on many platforms, this
     method may raise *note OverflowError: 954. for times far in the
     past or far in the future.

     For aware *note datetime: 194. instances, the return value is
     computed as:

          (dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()

     New in version 3.3.

     Changed in version 3.6: The *note timestamp(): 9d6. method uses the
     *note fold: 4e9. attribute to disambiguate the times during a
     repeated interval.

          Note: There is no method to obtain the POSIX timestamp
          directly from a naive *note datetime: 194. instance
          representing UTC time.  If your application uses this
          convention and your system timezone is not set to UTC, you can
          obtain the POSIX timestamp by supplying ‘tzinfo=timezone.utc’:

               timestamp = dt.replace(tzinfo=timezone.utc).timestamp()

          or by calculating the timestamp directly:

               timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)

 -- Method: datetime.weekday ()

     Return the day of the week as an integer, where Monday is 0 and
     Sunday is 6.  The same as ‘self.date().weekday()’.  See also *note
     isoweekday(): 180a.

 -- Method: datetime.isoweekday ()

     Return the day of the week as an integer, where Monday is 1 and
     Sunday is 7.  The same as ‘self.date().isoweekday()’.  See also
     *note weekday(): 1809, *note isocalendar(): 17fa.

 -- Method: datetime.isocalendar ()

     Return a 3-tuple, (ISO year, ISO week number, ISO weekday).  The
     same as ‘self.date().isocalendar()’.

 -- Method: datetime.isoformat (sep='T', timespec='auto')

     Return a string representing the date and time in ISO 8601 format:

        - ‘YYYY-MM-DDTHH:MM:SS.ffffff’, if *note microsecond: 17d4. is
          not 0

        - ‘YYYY-MM-DDTHH:MM:SS’, if *note microsecond: 17d4. is 0

     If *note utcoffset(): 1802. does not return ‘None’, a string is
     appended, giving the UTC offset:

        - ‘YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]’, if *note
          microsecond: 17d4. is not 0

        - ‘YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]]’, if *note
          microsecond: 17d4. is 0

     Examples:

          >>> from datetime import datetime, timezone
          >>> datetime(2019, 5, 18, 15, 17, 8, 132263).isoformat()
          '2019-05-18T15:17:08.132263'
          >>> datetime(2019, 5, 18, 15, 17, tzinfo=timezone.utc).isoformat()
          '2019-05-18T15:17:00+00:00'

     The optional argument `sep' (default ‘'T'’) is a one-character
     separator, placed between the date and time portions of the result.
     For example:

          >>> from datetime import tzinfo, timedelta, datetime
          >>> class TZ(tzinfo):
          ...     """A time zone with an arbitrary, constant -06:39 offset."""
          ...     def utcoffset(self, dt):
          ...         return timedelta(hours=-6, minutes=-39)
          ...
          >>> datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ')
          '2002-12-25 00:00:00-06:39'
          >>> datetime(2009, 11, 27, microsecond=100, tzinfo=TZ()).isoformat()
          '2009-11-27T00:00:00.000100-06:39'

     The optional argument `timespec' specifies the number of additional
     components of the time to include (the default is ‘'auto'’).  It
     can be one of the following:

        - ‘'auto'’: Same as ‘'seconds'’ if *note microsecond: 17d4. is
          0, same as ‘'microseconds'’ otherwise.

        - ‘'hours'’: Include the *note hour: 17d1. in the two-digit ‘HH’
          format.

        - ‘'minutes'’: Include *note hour: 17d1. and *note minute: 17d2.
          in ‘HH:MM’ format.

        - ‘'seconds'’: Include *note hour: 17d1, *note minute: 17d2, and
          *note second: 17d3. in ‘HH:MM:SS’ format.

        - ‘'milliseconds'’: Include full time, but truncate fractional
          second part to milliseconds.  ‘HH:MM:SS.sss’ format.

        - ‘'microseconds'’: Include full time in ‘HH:MM:SS.ffffff’
          format.

          Note: Excluded time components are truncated, not rounded.

     *note ValueError: 1f9. will be raised on an invalid `timespec'
     argument:

          >>> from datetime import datetime
          >>> datetime.now().isoformat(timespec='minutes')
          '2002-12-25T00:00'
          >>> dt = datetime(2015, 1, 1, 12, 30, 59, 0)
          >>> dt.isoformat(timespec='microseconds')
          '2015-01-01T12:30:59.000000'

     New in version 3.6: Added the `timespec' argument.

 -- Method: datetime.__str__ ()

     For a *note datetime: 194. instance `d', ‘str(d)’ is equivalent to
     ‘d.isoformat(' ')’.

 -- Method: datetime.ctime ()

     Return a string representing the date and time:

          >>> from datetime import datetime
          >>> datetime(2002, 12, 4, 20, 30, 40).ctime()
          'Wed Dec  4 20:30:40 2002'

     The output string will `not' include time zone information,
     regardless of whether the input is aware or naive.

     ‘d.ctime()’ is equivalent to:

          time.ctime(time.mktime(d.timetuple()))

     on platforms where the native C ‘ctime()’ function (which *note
     time.ctime(): 17f0. invokes, but which *note datetime.ctime():
     180c. does not invoke) conforms to the C standard.

 -- Method: datetime.strftime (format)

     Return a string representing the date and time, controlled by an
     explicit format string.  For a complete list of formatting
     directives, see *note strftime() and strptime() Behavior: 17f1.

 -- Method: datetime.__format__ (format)

     Same as *note datetime.strftime(): 52c.  This makes it possible to
     specify a format string for a *note datetime: 194. object in *note
     formatted string literals: 15c. and when using *note str.format():
     4cf.  For a complete list of formatting directives, see *note
     strftime() and strptime() Behavior: 17f1.

* Menu:

* Examples of Usage; datetime: Examples of Usage datetime.

   ---------- Footnotes ----------

   (1) 
https://dateutil.readthedocs.io/en/stable/parser.html#dateutil.parser.isoparse


File: python.info,  Node: Examples of Usage datetime,  Up: datetime Objects

5.8.1.11 Examples of Usage: ‘datetime’
......................................

Examples of working with *note datetime: 194. objects:

     >>> from datetime import datetime, date, time, timezone

     >>> # Using datetime.combine()
     >>> d = date(2005, 7, 14)
     >>> t = time(12, 30)
     >>> datetime.combine(d, t)
     datetime.datetime(2005, 7, 14, 12, 30)

     >>> # Using datetime.now()
     >>> datetime.now()
     datetime.datetime(2007, 12, 6, 16, 29, 43, 79043)   # GMT +1
     >>> datetime.now(timezone.utc)
     datetime.datetime(2007, 12, 6, 15, 29, 43, 79060, tzinfo=datetime.timezone.utc)

     >>> # Using datetime.strptime()
     >>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
     >>> dt
     datetime.datetime(2006, 11, 21, 16, 30)

     >>> # Using datetime.timetuple() to get tuple of all attributes
     >>> tt = dt.timetuple()
     >>> for it in tt:
     ...     print(it)
     ...
     2006    # year
     11      # month
     21      # day
     16      # hour
     30      # minute
     0       # second
     1       # weekday (0 = Monday)
     325     # number of days since 1st January
     -1      # dst - method tzinfo.dst() returned None

     >>> # Date in ISO format
     >>> ic = dt.isocalendar()
     >>> for it in ic:
     ...     print(it)
     ...
     2006    # ISO year
     47      # ISO week
     2       # ISO weekday

     >>> # Formatting a datetime
     >>> dt.strftime("%A, %d. %B %Y %I:%M%p")
     'Tuesday, 21. November 2006 04:30PM'
     >>> 'The {1} is {0:%d}, the {2} is {0:%B}, the {3} is {0:%I:%M%p}.'.format(dt, "day", "month", "time")
     'The day is 21, the month is November, the time is 04:30PM.'

The example below defines a *note tzinfo: 375. subclass capturing time
zone information for Kabul, Afghanistan, which used +4 UTC until 1945
and then +4:30 UTC thereafter:

     from datetime import timedelta, datetime, tzinfo, timezone

     class KabulTz(tzinfo):
         # Kabul used +4 until 1945, when they moved to +4:30
         UTC_MOVE_DATE = datetime(1944, 12, 31, 20, tzinfo=timezone.utc)

         def utcoffset(self, dt):
             if dt.year < 1945:
                 return timedelta(hours=4)
             elif (1945, 1, 1, 0, 0) <= dt.timetuple()[:5] < (1945, 1, 1, 0, 30):
                 # An ambiguous ("imaginary") half-hour range representing
                 # a 'fold' in time due to the shift from +4 to +4:30.
                 # If dt falls in the imaginary range, use fold to decide how
                 # to resolve. See PEP495.
                 return timedelta(hours=4, minutes=(30 if dt.fold else 0))
             else:
                 return timedelta(hours=4, minutes=30)

         def fromutc(self, dt):
             # Follow same validations as in datetime.tzinfo
             if not isinstance(dt, datetime):
                 raise TypeError("fromutc() requires a datetime argument")
             if dt.tzinfo is not self:
                 raise ValueError("dt.tzinfo is not self")

             # A custom implementation is required for fromutc as
             # the input to this function is a datetime with utc values
             # but with a tzinfo set to self.
             # See datetime.astimezone or fromtimestamp.
             if dt.replace(tzinfo=timezone.utc) >= self.UTC_MOVE_DATE:
                 return dt + timedelta(hours=4, minutes=30)
             else:
                 return dt + timedelta(hours=4)

         def dst(self, dt):
             # Kabul does not observe daylight saving time.
             return timedelta(0)

         def tzname(self, dt):
             if dt >= self.UTC_MOVE_DATE:
                 return "+04:30"
             return "+04"

Usage of ‘KabulTz’ from above:

     >>> tz1 = KabulTz()

     >>> # Datetime before the change
     >>> dt1 = datetime(1900, 11, 21, 16, 30, tzinfo=tz1)
     >>> print(dt1.utcoffset())
     4:00:00

     >>> # Datetime after the change
     >>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=tz1)
     >>> print(dt2.utcoffset())
     4:30:00

     >>> # Convert datetime to another time zone
     >>> dt3 = dt2.astimezone(timezone.utc)
     >>> dt3
     datetime.datetime(2006, 6, 14, 8, 30, tzinfo=datetime.timezone.utc)
     >>> dt2
     datetime.datetime(2006, 6, 14, 13, 0, tzinfo=KabulTz())
     >>> dt2 == dt3
     True


File: python.info,  Node: time Objects,  Next: tzinfo Objects,  Prev: datetime Objects,  Up: datetime — Basic date and time types

5.8.1.12 ‘time’ Objects
.......................

A *note time: 10a. object represents a (local) time of day, independent
of any particular day, and subject to adjustment via a *note tzinfo:
375. object.

 -- Class: datetime.time (hour=0, minute=0, second=0, microsecond=0,
          tzinfo=None, *, fold=0)

     All arguments are optional.  `tzinfo' may be ‘None’, or an instance
     of a *note tzinfo: 375. subclass.  The remaining arguments must be
     integers in the following ranges:

        * ‘0 <= hour < 24’,

        * ‘0 <= minute < 60’,

        * ‘0 <= second < 60’,

        * ‘0 <= microsecond < 1000000’,

        * ‘fold in [0, 1]’.

     If an argument outside those ranges is given, *note ValueError:
     1f9. is raised.  All default to ‘0’ except `tzinfo', which defaults
     to *note None: 157.

Class attributes:

 -- Attribute: time.min

     The earliest representable *note time: 4e8, ‘time(0, 0, 0, 0)’.

 -- Attribute: time.max

     The latest representable *note time: 4e8, ‘time(23, 59, 59,
     999999)’.

 -- Attribute: time.resolution

     The smallest possible difference between non-equal *note time: 4e8.
     objects, ‘timedelta(microseconds=1)’, although note that arithmetic
     on *note time: 4e8. objects is not supported.

Instance attributes (read-only):

 -- Attribute: time.hour

     In ‘range(24)’.

 -- Attribute: time.minute

     In ‘range(60)’.

 -- Attribute: time.second

     In ‘range(60)’.

 -- Attribute: time.microsecond

     In ‘range(1000000)’.

 -- Attribute: time.tzinfo

     The object passed as the tzinfo argument to the *note time: 4e8.
     constructor, or ‘None’ if none was passed.

 -- Attribute: time.fold

     In ‘[0, 1]’.  Used to disambiguate wall times during a repeated
     interval.  (A repeated interval occurs when clocks are rolled back
     at the end of daylight saving time or when the UTC offset for the
     current zone is decreased for political reasons.)  The value 0 (1)
     represents the earlier (later) of the two moments with the same
     wall time representation.

     New in version 3.6.

*note time: 4e8. objects support comparison of *note time: 4e8. to *note
time: 4e8, where `a' is considered less than `b' when `a' precedes `b'
in time.  If one comparand is naive and the other is aware, *note
TypeError: 192. is raised if an order comparison is attempted.  For
equality comparisons, naive instances are never equal to aware
instances.

If both comparands are aware, and have the same *note tzinfo: 17cd.
attribute, the common *note tzinfo: 17cd. attribute is ignored and the
base times are compared.  If both comparands are aware and have
different *note tzinfo: 17cd. attributes, the comparands are first
adjusted by subtracting their UTC offsets (obtained from
‘self.utcoffset()’).  In order to stop mixed-type comparisons from
falling back to the default comparison by object address, when a *note
time: 4e8. object is compared to an object of a different type, *note
TypeError: 192. is raised unless the comparison is ‘==’ or ‘!=’.  The
latter cases return *note False: 37d. or *note True: 48f, respectively.

Changed in version 3.3: Equality comparisons between aware and naive
*note time: 4e8. instances don’t raise *note TypeError: 192.

In Boolean contexts, a *note time: 4e8. object is always considered to
be true.

Changed in version 3.5: Before Python 3.5, a *note time: 4e8. object was
considered to be false if it represented midnight in UTC. This behavior
was considered obscure and error-prone and has been removed in Python
3.5.  See bpo-13936(1) for full details.

Other constructor:

 -- Class Method: time.fromisoformat (time_string)

     Return a *note time: 4e8. corresponding to a `time_string' in one
     of the formats emitted by *note time.isoformat(): 1815.
     Specifically, this function supports strings in the format:

          HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]

          Caution: This does `not' support parsing arbitrary ISO 8601
          strings.  It is only intended as the inverse operation of
          *note time.isoformat(): 1815.

     Examples:

          >>> from datetime import time
          >>> time.fromisoformat('04:23:01')
          datetime.time(4, 23, 1)
          >>> time.fromisoformat('04:23:01.000384')
          datetime.time(4, 23, 1, 384)
          >>> time.fromisoformat('04:23:01+04:00')
          datetime.time(4, 23, 1, tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))

     New in version 3.7.

Instance methods:

 -- Method: time.replace (hour=self.hour, minute=self.minute,
          second=self.second, microsecond=self.microsecond,
          tzinfo=self.tzinfo, * fold=0)

     Return a *note time: 4e8. with the same value, except for those
     attributes given new values by whichever keyword arguments are
     specified.  Note that ‘tzinfo=None’ can be specified to create a
     naive *note time: 4e8. from an aware *note time: 4e8, without
     conversion of the time data.

     New in version 3.6: Added the ‘fold’ argument.

 -- Method: time.isoformat (timespec='auto')

     Return a string representing the time in ISO 8601 format, one of:

        - ‘HH:MM:SS.ffffff’, if *note microsecond: 17cc. is not 0

        - ‘HH:MM:SS’, if *note microsecond: 17cc. is 0

        - ‘HH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]’, if *note utcoffset():
          1817. does not return ‘None’

        - ‘HH:MM:SS+HH:MM[:SS[.ffffff]]’, if *note microsecond: 17cc. is
          0 and *note utcoffset(): 1817. does not return ‘None’

     The optional argument `timespec' specifies the number of additional
     components of the time to include (the default is ‘'auto'’).  It
     can be one of the following:

        - ‘'auto'’: Same as ‘'seconds'’ if *note microsecond: 17cc. is
          0, same as ‘'microseconds'’ otherwise.

        - ‘'hours'’: Include the *note hour: 17c9. in the two-digit ‘HH’
          format.

        - ‘'minutes'’: Include *note hour: 17c9. and *note minute: 17ca.
          in ‘HH:MM’ format.

        - ‘'seconds'’: Include *note hour: 17c9, *note minute: 17ca, and
          *note second: 17cb. in ‘HH:MM:SS’ format.

        - ‘'milliseconds'’: Include full time, but truncate fractional
          second part to milliseconds.  ‘HH:MM:SS.sss’ format.

        - ‘'microseconds'’: Include full time in ‘HH:MM:SS.ffffff’
          format.

          Note: Excluded time components are truncated, not rounded.

     *note ValueError: 1f9. will be raised on an invalid `timespec'
     argument.

     Example:

          >>> from datetime import time
          >>> time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes')
          '12:34'
          >>> dt = time(hour=12, minute=34, second=56, microsecond=0)
          >>> dt.isoformat(timespec='microseconds')
          '12:34:56.000000'
          >>> dt.isoformat(timespec='auto')
          '12:34:56'

     New in version 3.6: Added the `timespec' argument.

 -- Method: time.__str__ ()

     For a time `t', ‘str(t)’ is equivalent to ‘t.isoformat()’.

 -- Method: time.strftime (format)

     Return a string representing the time, controlled by an explicit
     format string.  For a complete list of formatting directives, see
     *note strftime() and strptime() Behavior: 17f1.

 -- Method: time.__format__ (format)

     Same as *note time.strftime(): 1819.  This makes it possible to
     specify a format string for a *note time: 4e8. object in *note
     formatted string literals: 15c. and when using *note str.format():
     4cf.  For a complete list of formatting directives, see *note
     strftime() and strptime() Behavior: 17f1.

 -- Method: time.utcoffset ()

     If *note tzinfo: 17cd. is ‘None’, returns ‘None’, else returns
     ‘self.tzinfo.utcoffset(None)’, and raises an exception if the
     latter doesn’t return ‘None’ or a *note timedelta: 195. object with
     magnitude less than one day.

     Changed in version 3.7: The UTC offset is not restricted to a whole
     number of minutes.

 -- Method: time.dst ()

     If *note tzinfo: 17cd. is ‘None’, returns ‘None’, else returns
     ‘self.tzinfo.dst(None)’, and raises an exception if the latter
     doesn’t return ‘None’, or a *note timedelta: 195. object with
     magnitude less than one day.

     Changed in version 3.7: The DST offset is not restricted to a whole
     number of minutes.

 -- Method: time.tzname ()

     If *note tzinfo: 17cd. is ‘None’, returns ‘None’, else returns
     ‘self.tzinfo.tzname(None)’, or raises an exception if the latter
     doesn’t return ‘None’ or a string object.

* Menu:

* Examples of Usage; time: Examples of Usage time.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue13936


File: python.info,  Node: Examples of Usage time,  Up: time Objects

5.8.1.13 Examples of Usage: ‘time’
..................................

Examples of working with a *note time: 4e8. object:

     >>> from datetime import time, tzinfo, timedelta
     >>> class TZ1(tzinfo):
     ...     def utcoffset(self, dt):
     ...         return timedelta(hours=1)
     ...     def dst(self, dt):
     ...         return timedelta(0)
     ...     def tzname(self,dt):
     ...         return "+01:00"
     ...     def  __repr__(self):
     ...         return f"{self.__class__.__name__}()"
     ...
     >>> t = time(12, 10, 30, tzinfo=TZ1())
     >>> t
     datetime.time(12, 10, 30, tzinfo=TZ1())
     >>> t.isoformat()
     '12:10:30+01:00'
     >>> t.dst()
     datetime.timedelta(0)
     >>> t.tzname()
     '+01:00'
     >>> t.strftime("%H:%M:%S %Z")
     '12:10:30 +01:00'
     >>> 'The {} is {:%H:%M}.'.format("time", t)
     'The time is 12:10.'


File: python.info,  Node: tzinfo Objects,  Next: timezone Objects,  Prev: time Objects,  Up: datetime — Basic date and time types

5.8.1.14 ‘tzinfo’ Objects
.........................

 -- Class: datetime.tzinfo

     This is an abstract base class, meaning that this class should not
     be instantiated directly.  Define a subclass of *note tzinfo: 375.
     to capture information about a particular time zone.

     An instance of (a concrete subclass of) *note tzinfo: 375. can be
     passed to the constructors for *note datetime: 194. and *note time:
     4e8. objects.  The latter objects view their attributes as being in
     local time, and the *note tzinfo: 375. object supports methods
     revealing offset of local time from UTC, the name of the time zone,
     and DST offset, all relative to a date or time object passed to
     them.

     You need to derive a concrete subclass, and (at least) supply
     implementations of the standard *note tzinfo: 375. methods needed
     by the *note datetime: 194. methods you use.  The *note datetime:
     31. module provides *note timezone: 9f5, a simple concrete subclass
     of *note tzinfo: 375. which can represent timezones with fixed
     offset from UTC such as UTC itself or North American EST and EDT.

     Special requirement for pickling: A *note tzinfo: 375. subclass
     must have an *note __init__(): d51. method that can be called with
     no arguments, otherwise it can be pickled but possibly not
     unpickled again.  This is a technical requirement that may be
     relaxed in the future.

     A concrete subclass of *note tzinfo: 375. may need to implement the
     following methods.  Exactly which methods are needed depends on the
     uses made of aware *note datetime: 31. objects.  If in doubt,
     simply implement all of them.

 -- Method: tzinfo.utcoffset (dt)

     Return offset of local time from UTC, as a *note timedelta: 195.
     object that is positive east of UTC. If local time is west of UTC,
     this should be negative.

     This represents the `total' offset from UTC; for example, if a
     *note tzinfo: 375. object represents both time zone and DST
     adjustments, *note utcoffset(): 1820. should return their sum.  If
     the UTC offset isn’t known, return ‘None’.  Else the value returned
     must be a *note timedelta: 195. object strictly between
     ‘-timedelta(hours=24)’ and ‘timedelta(hours=24)’ (the magnitude of
     the offset must be less than one day).  Most implementations of
     *note utcoffset(): 1820. will probably look like one of these two:

          return CONSTANT                 # fixed-offset class
          return CONSTANT + self.dst(dt)  # daylight-aware class

     If *note utcoffset(): 1820. does not return ‘None’, *note dst():
     1821. should not return ‘None’ either.

     The default implementation of *note utcoffset(): 1820. raises *note
     NotImplementedError: 603.

     Changed in version 3.7: The UTC offset is not restricted to a whole
     number of minutes.

 -- Method: tzinfo.dst (dt)

     Return the daylight saving time (DST) adjustment, as a *note
     timedelta: 195. object or ‘None’ if DST information isn’t known.

     Return ‘timedelta(0)’ if DST is not in effect.  If DST is in
     effect, return the offset as a *note timedelta: 195. object (see
     *note utcoffset(): 1820. for details).  Note that DST offset, if
     applicable, has already been added to the UTC offset returned by
     *note utcoffset(): 1820, so there’s no need to consult *note dst():
     1821. unless you’re interested in obtaining DST info separately.
     For example, *note datetime.timetuple(): 1806. calls its *note
     tzinfo: 17d5. attribute’s *note dst(): 1821. method to determine
     how the ‘tm_isdst’ flag should be set, and *note tzinfo.fromutc():
     1804. calls *note dst(): 1821. to account for DST changes when
     crossing time zones.

     An instance `tz' of a *note tzinfo: 375. subclass that models both
     standard and daylight times must be consistent in this sense:

     ‘tz.utcoffset(dt) - tz.dst(dt)’

     must return the same result for every *note datetime: 194. `dt'
     with ‘dt.tzinfo == tz’ For sane *note tzinfo: 375. subclasses, this
     expression yields the time zone’s “standard offset”, which should
     not depend on the date or the time, but only on geographic
     location.  The implementation of *note datetime.astimezone(): 196.
     relies on this, but cannot detect violations; it’s the programmer’s
     responsibility to ensure it.  If a *note tzinfo: 375. subclass
     cannot guarantee this, it may be able to override the default
     implementation of *note tzinfo.fromutc(): 1804. to work correctly
     with ‘astimezone()’ regardless.

     Most implementations of *note dst(): 1821. will probably look like
     one of these two:

          def dst(self, dt):
              # a fixed-offset class:  doesn't account for DST
              return timedelta(0)

     or:

          def dst(self, dt):
              # Code to set dston and dstoff to the time zone's DST
              # transition times based on the input dt.year, and expressed
              # in standard local time.

              if dston <= dt.replace(tzinfo=None) < dstoff:
                  return timedelta(hours=1)
              else:
                  return timedelta(0)

     The default implementation of *note dst(): 1821. raises *note
     NotImplementedError: 603.

     Changed in version 3.7: The DST offset is not restricted to a whole
     number of minutes.

 -- Method: tzinfo.tzname (dt)

     Return the time zone name corresponding to the *note datetime: 194.
     object `dt', as a string.  Nothing about string names is defined by
     the *note datetime: 31. module, and there’s no requirement that it
     mean anything in particular.  For example, “GMT”, “UTC”, “-500”,
     “-5:00”, “EDT”, “US/Eastern”, “America/New York” are all valid
     replies.  Return ‘None’ if a string name isn’t known.  Note that
     this is a method rather than a fixed string primarily because some
     *note tzinfo: 375. subclasses will wish to return different names
     depending on the specific value of `dt' passed, especially if the
     *note tzinfo: 375. class is accounting for daylight time.

     The default implementation of *note tzname(): 1822. raises *note
     NotImplementedError: 603.

These methods are called by a *note datetime: 194. or *note time: 4e8.
object, in response to their methods of the same names.  A *note
datetime: 194. object passes itself as the argument, and a *note time:
4e8. object passes ‘None’ as the argument.  A *note tzinfo: 375.
subclass’s methods should therefore be prepared to accept a `dt'
argument of ‘None’, or of class *note datetime: 194.

When ‘None’ is passed, it’s up to the class designer to decide the best
response.  For example, returning ‘None’ is appropriate if the class
wishes to say that time objects don’t participate in the *note tzinfo:
375. protocols.  It may be more useful for ‘utcoffset(None)’ to return
the standard UTC offset, as there is no other convention for discovering
the standard offset.

When a *note datetime: 194. object is passed in response to a *note
datetime: 194. method, ‘dt.tzinfo’ is the same object as `self'.  *note
tzinfo: 375. methods can rely on this, unless user code calls *note
tzinfo: 375. methods directly.  The intent is that the *note tzinfo:
375. methods interpret `dt' as being in local time, and not need worry
about objects in other timezones.

There is one more *note tzinfo: 375. method that a subclass may wish to
override:

 -- Method: tzinfo.fromutc (dt)

     This is called from the default *note datetime.astimezone(): 196.
     implementation.  When called from that, ‘dt.tzinfo’ is `self', and
     `dt'’s date and time data are to be viewed as expressing a UTC
     time.  The purpose of *note fromutc(): 1804. is to adjust the date
     and time data, returning an equivalent datetime in `self'’s local
     time.

     Most *note tzinfo: 375. subclasses should be able to inherit the
     default *note fromutc(): 1804. implementation without problems.
     It’s strong enough to handle fixed-offset time zones, and time
     zones accounting for both standard and daylight time, and the
     latter even if the DST transition times differ in different years.
     An example of a time zone the default *note fromutc(): 1804.
     implementation may not handle correctly in all cases is one where
     the standard offset (from UTC) depends on the specific date and
     time passed, which can happen for political reasons.  The default
     implementations of ‘astimezone()’ and *note fromutc(): 1804. may
     not produce the result you want if the result is one of the hours
     straddling the moment the standard offset changes.

     Skipping code for error cases, the default *note fromutc(): 1804.
     implementation acts like:

          def fromutc(self, dt):
              # raise ValueError error if dt.tzinfo is not self
              dtoff = dt.utcoffset()
              dtdst = dt.dst()
              # raise ValueError if dtoff is None or dtdst is None
              delta = dtoff - dtdst  # this is self's standard offset
              if delta:
                  dt += delta   # convert to standard local time
                  dtdst = dt.dst()
                  # raise ValueError if dtdst is None
              if dtdst:
                  return dt + dtdst
              else:
                  return dt

In the following ‘tzinfo_examples.py’ file there are some examples of
*note tzinfo: 375. classes:

     from datetime import tzinfo, timedelta, datetime

     ZERO = timedelta(0)
     HOUR = timedelta(hours=1)
     SECOND = timedelta(seconds=1)

     # A class capturing the platform's idea of local time.
     # (May result in wrong values on historical times in
     #  timezones where UTC offset and/or the DST rules had
     #  changed in the past.)
     import time as _time

     STDOFFSET = timedelta(seconds = -_time.timezone)
     if _time.daylight:
         DSTOFFSET = timedelta(seconds = -_time.altzone)
     else:
         DSTOFFSET = STDOFFSET

     DSTDIFF = DSTOFFSET - STDOFFSET

     class LocalTimezone(tzinfo):

         def fromutc(self, dt):
             assert dt.tzinfo is self
             stamp = (dt - datetime(1970, 1, 1, tzinfo=self)) // SECOND
             args = _time.localtime(stamp)[:6]
             dst_diff = DSTDIFF // SECOND
             # Detect fold
             fold = (args == _time.localtime(stamp - dst_diff))
             return datetime(*args, microsecond=dt.microsecond,
                             tzinfo=self, fold=fold)

         def utcoffset(self, dt):
             if self._isdst(dt):
                 return DSTOFFSET
             else:
                 return STDOFFSET

         def dst(self, dt):
             if self._isdst(dt):
                 return DSTDIFF
             else:
                 return ZERO

         def tzname(self, dt):
             return _time.tzname[self._isdst(dt)]

         def _isdst(self, dt):
             tt = (dt.year, dt.month, dt.day,
                   dt.hour, dt.minute, dt.second,
                   dt.weekday(), 0, 0)
             stamp = _time.mktime(tt)
             tt = _time.localtime(stamp)
             return tt.tm_isdst > 0

     Local = LocalTimezone()


     # A complete implementation of current DST rules for major US time zones.

     def first_sunday_on_or_after(dt):
         days_to_go = 6 - dt.weekday()
         if days_to_go:
             dt += timedelta(days_to_go)
         return dt


     # US DST Rules
     #
     # This is a simplified (i.e., wrong for a few cases) set of rules for US
     # DST start and end times. For a complete and up-to-date set of DST rules
     # and timezone definitions, visit the Olson Database (or try pytz):
     # http://www.twinsun.com/tz/tz-link.htm
     # http://sourceforge.net/projects/pytz/ (might not be up-to-date)
     #
     # In the US, since 2007, DST starts at 2am (standard time) on the second
     # Sunday in March, which is the first Sunday on or after Mar 8.
     DSTSTART_2007 = datetime(1, 3, 8, 2)
     # and ends at 2am (DST time) on the first Sunday of Nov.
     DSTEND_2007 = datetime(1, 11, 1, 2)
     # From 1987 to 2006, DST used to start at 2am (standard time) on the first
     # Sunday in April and to end at 2am (DST time) on the last
     # Sunday of October, which is the first Sunday on or after Oct 25.
     DSTSTART_1987_2006 = datetime(1, 4, 1, 2)
     DSTEND_1987_2006 = datetime(1, 10, 25, 2)
     # From 1967 to 1986, DST used to start at 2am (standard time) on the last
     # Sunday in April (the one on or after April 24) and to end at 2am (DST time)
     # on the last Sunday of October, which is the first Sunday
     # on or after Oct 25.
     DSTSTART_1967_1986 = datetime(1, 4, 24, 2)
     DSTEND_1967_1986 = DSTEND_1987_2006

     def us_dst_range(year):
         # Find start and end times for US DST. For years before 1967, return
         # start = end for no DST.
         if 2006 < year:
             dststart, dstend = DSTSTART_2007, DSTEND_2007
         elif 1986 < year < 2007:
             dststart, dstend = DSTSTART_1987_2006, DSTEND_1987_2006
         elif 1966 < year < 1987:
             dststart, dstend = DSTSTART_1967_1986, DSTEND_1967_1986
         else:
             return (datetime(year, 1, 1), ) * 2

         start = first_sunday_on_or_after(dststart.replace(year=year))
         end = first_sunday_on_or_after(dstend.replace(year=year))
         return start, end


     class USTimeZone(tzinfo):

         def __init__(self, hours, reprname, stdname, dstname):
             self.stdoffset = timedelta(hours=hours)
             self.reprname = reprname
             self.stdname = stdname
             self.dstname = dstname

         def __repr__(self):
             return self.reprname

         def tzname(self, dt):
             if self.dst(dt):
                 return self.dstname
             else:
                 return self.stdname

         def utcoffset(self, dt):
             return self.stdoffset + self.dst(dt)

         def dst(self, dt):
             if dt is None or dt.tzinfo is None:
                 # An exception may be sensible here, in one or both cases.
                 # It depends on how you want to treat them.  The default
                 # fromutc() implementation (called by the default astimezone()
                 # implementation) passes a datetime with dt.tzinfo is self.
                 return ZERO
             assert dt.tzinfo is self
             start, end = us_dst_range(dt.year)
             # Can't compare naive to aware objects, so strip the timezone from
             # dt first.
             dt = dt.replace(tzinfo=None)
             if start + HOUR <= dt < end - HOUR:
                 # DST is in effect.
                 return HOUR
             if end - HOUR <= dt < end:
                 # Fold (an ambiguous hour): use dt.fold to disambiguate.
                 return ZERO if dt.fold else HOUR
             if start <= dt < start + HOUR:
                 # Gap (a non-existent hour): reverse the fold rule.
                 return HOUR if dt.fold else ZERO
             # DST is off.
             return ZERO

         def fromutc(self, dt):
             assert dt.tzinfo is self
             start, end = us_dst_range(dt.year)
             start = start.replace(tzinfo=self)
             end = end.replace(tzinfo=self)
             std_time = dt + self.stdoffset
             dst_time = std_time + HOUR
             if end <= dst_time < end + HOUR:
                 # Repeated hour
                 return std_time.replace(fold=1)
             if std_time < start or dst_time >= end:
                 # Standard time
                 return std_time
             if start <= std_time < end - HOUR:
                 # Daylight saving time
                 return dst_time


     Eastern  = USTimeZone(-5, "Eastern",  "EST", "EDT")
     Central  = USTimeZone(-6, "Central",  "CST", "CDT")
     Mountain = USTimeZone(-7, "Mountain", "MST", "MDT")
     Pacific  = USTimeZone(-8, "Pacific",  "PST", "PDT")

Note that there are unavoidable subtleties twice per year in a *note
tzinfo: 375. subclass accounting for both standard and daylight time, at
the DST transition points.  For concreteness, consider US Eastern (UTC
-0500), where EDT begins the minute after 1:59 (EST) on the second
Sunday in March, and ends the minute after 1:59 (EDT) on the first
Sunday in November:

       UTC   3:MM  4:MM  5:MM  6:MM  7:MM  8:MM
       EST  22:MM 23:MM  0:MM  1:MM  2:MM  3:MM
       EDT  23:MM  0:MM  1:MM  2:MM  3:MM  4:MM

     start  22:MM 23:MM  0:MM  1:MM  3:MM  4:MM

       end  23:MM  0:MM  1:MM  1:MM  2:MM  3:MM

When DST starts (the “start” line), the local wall clock leaps from 1:59
to 3:00.  A wall time of the form 2:MM doesn’t really make sense on that
day, so ‘astimezone(Eastern)’ won’t deliver a result with ‘hour == 2’ on
the day DST begins.  For example, at the Spring forward transition of
2016, we get:

     >>> from datetime import datetime, timezone
     >>> from tzinfo_examples import HOUR, Eastern
     >>> u0 = datetime(2016, 3, 13, 5, tzinfo=timezone.utc)
     >>> for i in range(4):
     ...     u = u0 + i*HOUR
     ...     t = u.astimezone(Eastern)
     ...     print(u.time(), 'UTC =', t.time(), t.tzname())
     ...
     05:00:00 UTC = 00:00:00 EST
     06:00:00 UTC = 01:00:00 EST
     07:00:00 UTC = 03:00:00 EDT
     08:00:00 UTC = 04:00:00 EDT

When DST ends (the “end” line), there’s a potentially worse problem:
there’s an hour that can’t be spelled unambiguously in local wall time:
the last hour of daylight time.  In Eastern, that’s times of the form
5:MM UTC on the day daylight time ends.  The local wall clock leaps from
1:59 (daylight time) back to 1:00 (standard time) again.  Local times of
the form 1:MM are ambiguous.  ‘astimezone()’ mimics the local clock’s
behavior by mapping two adjacent UTC hours into the same local hour
then.  In the Eastern example, UTC times of the form 5:MM and 6:MM both
map to 1:MM when converted to Eastern, but earlier times have the *note
fold: 4e9. attribute set to 0 and the later times have it set to 1.  For
example, at the Fall back transition of 2016, we get:

     >>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
     >>> for i in range(4):
     ...     u = u0 + i*HOUR
     ...     t = u.astimezone(Eastern)
     ...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
     ...
     04:00:00 UTC = 00:00:00 EDT 0
     05:00:00 UTC = 01:00:00 EDT 0
     06:00:00 UTC = 01:00:00 EST 1
     07:00:00 UTC = 02:00:00 EST 0

Note that the *note datetime: 194. instances that differ only by the
value of the *note fold: 4e9. attribute are considered equal in
comparisons.

Applications that can’t bear wall-time ambiguities should explicitly
check the value of the *note fold: 4e9. attribute or avoid using hybrid
*note tzinfo: 375. subclasses; there are no ambiguities when using *note
timezone: 9f5, or any other fixed-offset *note tzinfo: 375. subclass
(such as a class representing only EST (fixed offset -5 hours), or only
EDT (fixed offset -4 hours)).

See also
........

dateutil.tz(1)

     The *note datetime: 31. module has a basic *note timezone: 9f5.
     class (for handling arbitrary fixed offsets from UTC) and its *note
     timezone.utc: 1823. attribute (a UTC timezone instance).

     `dateutil.tz' library brings the `IANA timezone database' (also
     known as the Olson database) to Python, and its usage is
     recommended.

IANA timezone database(2)

     The Time Zone Database (often called tz, tzdata or zoneinfo)
     contains code and data that represent the history of local time for
     many representative locations around the globe.  It is updated
     periodically to reflect changes made by political bodies to time
     zone boundaries, UTC offsets, and daylight-saving rules.

   ---------- Footnotes ----------

   (1) https://dateutil.readthedocs.io/en/stable/tz.html

   (2) https://www.iana.org/time-zones


File: python.info,  Node: timezone Objects,  Next: strftime and strptime Behavior,  Prev: tzinfo Objects,  Up: datetime — Basic date and time types

5.8.1.15 ‘timezone’ Objects
...........................

The *note timezone: 9f5. class is a subclass of *note tzinfo: 375, each
instance of which represents a timezone defined by a fixed offset from
UTC.

Objects of this class cannot be used to represent timezone information
in the locations where different offsets are used in different days of
the year or where historical changes have been made to civil time.

 -- Class: datetime.timezone (offset, name=None)

     The `offset' argument must be specified as a *note timedelta: 195.
     object representing the difference between the local time and UTC.
     It must be strictly between ‘-timedelta(hours=24)’ and
     ‘timedelta(hours=24)’, otherwise *note ValueError: 1f9. is raised.

     The `name' argument is optional.  If specified it must be a string
     that will be used as the value returned by the *note
     datetime.tzname(): 1805. method.

     New in version 3.2.

     Changed in version 3.7: The UTC offset is not restricted to a whole
     number of minutes.

 -- Method: timezone.utcoffset (dt)

     Return the fixed value specified when the *note timezone: 9f5.
     instance is constructed.

     The `dt' argument is ignored.  The return value is a *note
     timedelta: 195. instance equal to the difference between the local
     time and UTC.

     Changed in version 3.7: The UTC offset is not restricted to a whole
     number of minutes.

 -- Method: timezone.tzname (dt)

     Return the fixed value specified when the *note timezone: 9f5.
     instance is constructed.

     If `name' is not provided in the constructor, the name returned by
     ‘tzname(dt)’ is generated from the value of the ‘offset’ as
     follows.  If `offset' is ‘timedelta(0)’, the name is “UTC”,
     otherwise it is a string in the format ‘UTC±HH:MM’, where ± is the
     sign of ‘offset’, HH and MM are two digits of ‘offset.hours’ and
     ‘offset.minutes’ respectively.

     Changed in version 3.6: Name generated from ‘offset=timedelta(0)’
     is now plain ‘‘UTC’’, not ‘'UTC+00:00'’.

 -- Method: timezone.dst (dt)

     Always returns ‘None’.

 -- Method: timezone.fromutc (dt)

     Return ‘dt + offset’.  The `dt' argument must be an aware *note
     datetime: 194. instance, with ‘tzinfo’ set to ‘self’.

Class attributes:

 -- Attribute: timezone.utc

     The UTC timezone, ‘timezone(timedelta(0))’.


File: python.info,  Node: strftime and strptime Behavior,  Prev: timezone Objects,  Up: datetime — Basic date and time types

5.8.1.16 ‘strftime()’ and ‘strptime()’ Behavior
...............................................

*note date: 193, *note datetime: 194, and *note time: 4e8. objects all
support a ‘strftime(format)’ method, to create a string representing the
time under the control of an explicit format string.

Conversely, the *note datetime.strptime(): ee1. class method creates a
*note datetime: 194. object from a string representing a date and time
and a corresponding format string.

The table below provides a high-level comparison of ‘strftime()’ versus
‘strptime()’:

                     ‘strftime’                                                   ‘strptime’
                                                                                  
---------------------------------------------------------------------------------------------------------------------------------------------------------------------
                                                                                  
Usage                Convert object to a string according to a given format       Parse a string into a *note datetime: 194. object given a corresponding format
                                                                                  
                                                                                  
Type of method       Instance method                                              Class method
                                                                                  
                                                                                  
Method of            *note date: 193.; *note datetime: 194.; *note time: 4e8.     *note datetime: 194.
                                                                                  
                                                                                  
Signature            ‘strftime(format)’                                           ‘strptime(date_string, format)’
                                                                                  

* Menu:

* strftime() and strptime() Format Codes: strftime and strptime Format Codes.
* Technical Detail::


File: python.info,  Node: strftime and strptime Format Codes,  Next: Technical Detail,  Up: strftime and strptime Behavior

5.8.1.17 ‘strftime()’ and ‘strptime()’ Format Codes
...................................................

The following is a list of all the format codes that the 1989 C standard
requires, and these work on all platforms with a standard C
implementation.

Directive       Meaning                              Example                      Notes
                                                                                  
----------------------------------------------------------------------------------------------
                                                                                  
‘%a’            Weekday as locale’s abbreviated           Sun, Mon, …, Sat (en_US); (1)
                name.                                     So, Mo, …, Sa (de_DE)   
                                                     
                                                                                  
‘%A’            Weekday as locale’s full name.            Sunday, Monday, …, Saturday (en_US); (1)
                                                          Sonntag, Montag, …, Samstag (de_DE) 
                                                     
                                                                                  
‘%w’            Weekday as a decimal number, where   0, 1, …, 6
                0 is Sunday and 6 is Saturday.       
                
                                                                                  
‘%d’            Day of the month as a zero-padded    01, 02, …, 31                (9)
                decimal number.                                                   
                
                                                                                  
‘%b’            Month as locale’s abbreviated             Jan, Feb, …, Dec (en_US); (1)
                name.                                     Jan, Feb, …, Dez (de_DE) 
                                                     
                                                                                  
‘%B’            Month as locale’s full name.              January, February, …, December (en_US); (1)
                                                          Januar, Februar, …, Dezember (de_DE) 
                                                     
                                                                                  
‘%m’            Month as a zero-padded decimal       01, 02, …, 12                (9)
                number.                                                           
                
                                                                                  
‘%y’            Year without century as a            00, 01, …, 99                (9)
                zero-padded decimal number.                                       
                
                                                                                  
‘%Y’            Year with century as a decimal       0001, 0002, …, 2013, 2014,   (2)
                number.                              …, 9998, 9999                
                                                     
                                                                                  
‘%H’            Hour (24-hour clock) as a            00, 01, …, 23                (9)
                zero-padded decimal number.                                       
                
                                                                                  
‘%I’            Hour (12-hour clock) as a            01, 02, …, 12                (9)
                zero-padded decimal number.                                       
                
                                                                                  
‘%p’            Locale’s equivalent of either AM          AM, PM (en_US);         (1), (3)
                or PM.                                    am, pm (de_DE)          
                                                     
                                                                                  
‘%M’            Minute as a zero-padded decimal      00, 01, …, 59                (9)
                number.                                                           
                
                                                                                  
‘%S’            Second as a zero-padded decimal      00, 01, …, 59                (4), (9)
                number.                                                           
                
                                                                                  
‘%f’            Microsecond as a decimal number,     000000, 000001, …, 999999    (5)
                zero-padded on the left.                                          
                
                                                                                  
‘%z’            UTC offset in the form               (empty), +0000, -0400,       (6)
                ‘±HHMM[SS[.ffffff]]’ (empty string   +1030, +063415,              
                if the object is naive).             -030712.345216
                                                     
                                                                                  
‘%Z’            Time zone name (empty string if      (empty), UTC, EST, CST
                the object is naive).                
                
                                                                                  
‘%j’            Day of the year as a zero-padded     001, 002, …, 366             (9)
                decimal number.                                                   
                
                                                                                  
‘%U’            Week number of the year (Sunday as   00, 01, …, 53                (7), (9)
                the first day of the week) as a                                   
                zero padded decimal number.  All
                days in a new year preceding the
                first Sunday are considered to be
                in week 0.
                
                                                                                  
‘%W’            Week number of the year (Monday as   00, 01, …, 53                (7), (9)
                the first day of the week) as a                                   
                decimal number.  All days in a new
                year preceding the first Monday
                are considered to be in week 0.
                
                                                                                  
‘%c’            Locale’s appropriate date and time        Tue Aug 16 21:30:00 1988 (en_US); (1)
                representation.                           Di 16 Aug 21:30:00 1988 (de_DE) 
                                                     
                                                                                  
‘%x’            Locale’s appropriate date                 08/16/88 (None);        (1)
                representation.                           08/16/1988 (en_US);     
                                                          16.08.1988 (de_DE) 
                                                     
                                                                                  
‘%X’            Locale’s appropriate time                 21:30:00 (en_US);       (1)
                representation.                           21:30:00 (de_DE)        
                                                     
                                                                                  
‘%%’            A literal ‘'%'’ character.           %
                                                     

Several additional directives not required by the C89 standard are
included for convenience.  These parameters all correspond to ISO 8601
date values.

Directive       Meaning                              Example                      Notes
                                                                                  
----------------------------------------------------------------------------------------------
                                                                                  
‘%G’            ISO 8601 year with century           0001, 0002, …, 2013, 2014,   (8)
                representing the year that           …, 9998, 9999                
                contains the greater part of the     
                ISO week (‘%V’).
                
                                                                                  
‘%u’            ISO 8601 weekday as a decimal        1, 2, …, 7
                number where 1 is Monday.            
                
                                                                                  
‘%V’            ISO 8601 week as a decimal number    01, 02, …, 53                (8), (9)
                with Monday as the first day of                                   
                the week.  Week 01 is the week
                containing Jan 4.
                

These may not be available on all platforms when used with the
‘strftime()’ method.  The ISO 8601 year and ISO 8601 week directives are
not interchangeable with the year and week number directives above.
Calling ‘strptime()’ with incomplete or ambiguous ISO 8601 directives
will raise a *note ValueError: 1f9.

The full set of format codes supported varies across platforms, because
Python calls the platform C library’s ‘strftime()’ function, and
platform variations are common.  To see the full set of format codes
supported on your platform, consult the ‘strftime(3)’ documentation.

New in version 3.6: ‘%G’, ‘%u’ and ‘%V’ were added.


File: python.info,  Node: Technical Detail,  Prev: strftime and strptime Format Codes,  Up: strftime and strptime Behavior

5.8.1.18 Technical Detail
.........................

Broadly speaking, ‘d.strftime(fmt)’ acts like the *note time: 10a.
module’s ‘time.strftime(fmt, d.timetuple())’ although not all objects
support a ‘timetuple()’ method.

For the *note datetime.strptime(): ee1. class method, the default value
is ‘1900-01-01T00:00:00.000’: any components not specified in the format
string will be pulled from the default value.  (1)

Using ‘datetime.strptime(date_string, format)’ is equivalent to:

     datetime(*(time.strptime(date_string, format)[0:6]))

except when the format includes sub-second components or timezone offset
information, which are supported in ‘datetime.strptime’ but are
discarded by ‘time.strptime’.

For *note time: 4e8. objects, the format codes for year, month, and day
should not be used, as *note time: 10a. objects have no such values.  If
they’re used anyway, ‘1900’ is substituted for the year, and ‘1’ for the
month and day.

For *note date: 193. objects, the format codes for hours, minutes,
seconds, and microseconds should not be used, as *note date: 193.
objects have no such values.  If they’re used anyway, ‘0’ is substituted
for them.

For the same reason, handling of format strings containing Unicode code
points that can’t be represented in the charset of the current locale is
also platform-dependent.  On some platforms such code points are
preserved intact in the output, while on others ‘strftime’ may raise
*note UnicodeError: c2e. or return an empty string instead.

Notes:

  1. Because the format depends on the current locale, care should be
     taken when making assumptions about the output value.  Field
     orderings will vary (for example, “month/day/year” versus
     “day/month/year”), and the output may contain Unicode characters
     encoded using the locale’s default encoding (for example, if the
     current locale is ‘ja_JP’, the default encoding could be any one of
     ‘eucJP’, ‘SJIS’, or ‘utf-8’; use *note locale.getlocale(): 182d. to
     determine the current locale’s encoding).

  2. The ‘strptime()’ method can parse years in the full [1, 9999]
     range, but years < 1000 must be zero-filled to 4-digit width.

     Changed in version 3.2: In previous versions, ‘strftime()’ method
     was restricted to years >= 1900.

     Changed in version 3.3: In version 3.2, ‘strftime()’ method was
     restricted to years >= 1000.

  3. When used with the ‘strptime()’ method, the ‘%p’ directive only
     affects the output hour field if the ‘%I’ directive is used to
     parse the hour.

  4. Unlike the *note time: 10a. module, the *note datetime: 31. module
     does not support leap seconds.

  5. When used with the ‘strptime()’ method, the ‘%f’ directive accepts
     from one to six digits and zero pads on the right.  ‘%f’ is an
     extension to the set of format characters in the C standard (but
     implemented separately in datetime objects, and therefore always
     available).

  6. For a naive object, the ‘%z’ and ‘%Z’ format codes are replaced by
     empty strings.

     For an aware object:

     ‘%z’

          ‘utcoffset()’ is transformed into a string of the form
          ‘±HHMM[SS[.ffffff]]’, where ‘HH’ is a 2-digit string giving
          the number of UTC offset hours, ‘MM’ is a 2-digit string
          giving the number of UTC offset minutes, SS is a 2-digit
          string giving the number of UTC offset seconds and ‘ffffff’ is
          a 6-digit string giving the number of UTC offset microseconds.
          The ‘ffffff’ part is omitted when the offset is a whole number
          of seconds and both the ‘ffffff’ and the ‘SS’ part is omitted
          when the offset is a whole number of minutes.  For example, if
          ‘utcoffset()’ returns ‘timedelta(hours=-3, minutes=-30)’, ‘%z’
          is replaced with the string ‘'-0330'’.

     Changed in version 3.7: The UTC offset is not restricted to a whole
     number of minutes.

     Changed in version 3.7: When the ‘%z’ directive is provided to the
     ‘strptime()’ method, the UTC offsets can have a colon as a
     separator between hours, minutes and seconds.  For example,
     ‘'+01:00:00'’ will be parsed as an offset of one hour.  In
     addition, providing ‘'Z'’ is identical to ‘'+00:00'’.

     ‘%Z’

          If ‘tzname()’ returns ‘None’, ‘%Z’ is replaced by an empty
          string.  Otherwise ‘%Z’ is replaced by the returned value,
          which must be a string.

     Changed in version 3.2: When the ‘%z’ directive is provided to the
     ‘strptime()’ method, an aware *note datetime: 194. object will be
     produced.  The ‘tzinfo’ of the result will be set to a *note
     timezone: 9f5. instance.

  7. When used with the ‘strptime()’ method, ‘%U’ and ‘%W’ are only used
     in calculations when the day of the week and the calendar year
     (‘%Y’) are specified.

  8. Similar to ‘%U’ and ‘%W’, ‘%V’ is only used in calculations when
     the day of the week and the ISO year (‘%G’) are specified in a
     ‘strptime()’ format string.  Also note that ‘%G’ and ‘%Y’ are not
     interchangeable.

  9. When used with the ‘strptime()’ method, the leading zero is
     optional for formats ‘%d’, ‘%m’, ‘%H’, ‘%I’, ‘%M’, ‘%S’, ‘%J’,
     ‘%U’, ‘%W’, and ‘%V’.  Format ‘%y’ does require a leading zero.

   ---------- Footnotes ----------

   (1) (4) Passing ‘datetime.strptime('Feb 29', '%b %d')’ will fail
since ‘1900’ is not a leap year.


File: python.info,  Node: calendar — General calendar-related functions,  Next: collections — Container datatypes,  Prev: datetime — Basic date and time types,  Up: Data Types

5.8.2 ‘calendar’ — General calendar-related functions
-----------------------------------------------------

`Source code:' Lib/calendar.py(1)

__________________________________________________________________

This module allows you to output calendars like the Unix ‘cal’ program,
and provides additional useful functions related to the calendar.  By
default, these calendars have Monday as the first day of the week, and
Sunday as the last (the European convention).  Use *note
setfirstweekday(): 1830. to set the first day of the week to Sunday (6)
or to any other weekday.  Parameters that specify dates are given as
integers.  For related functionality, see also the *note datetime: 31.
and *note time: 10a. modules.

The functions and classes defined in this module use an idealized
calendar, the current Gregorian calendar extended indefinitely in both
directions.  This matches the definition of the “proleptic Gregorian”
calendar in Dershowitz and Reingold’s book “Calendrical Calculations”,
where it’s the base calendar for all computations.  Zero and negative
years are interpreted as prescribed by the ISO 8601 standard.  Year 0 is
1 BC, year -1 is 2 BC, and so on.

 -- Class: calendar.Calendar (firstweekday=0)

     Creates a *note Calendar: 1831. object.  `firstweekday' is an
     integer specifying the first day of the week.  ‘0’ is Monday (the
     default), ‘6’ is Sunday.

     A *note Calendar: 1831. object provides several methods that can be
     used for preparing the calendar data for formatting.  This class
     doesn’t do any formatting itself.  This is the job of subclasses.

     *note Calendar: 1831. instances have the following methods:

      -- Method: iterweekdays ()

          Return an iterator for the week day numbers that will be used
          for one week.  The first value from the iterator will be the
          same as the value of the *note firstweekday: 1833. property.

      -- Method: itermonthdates (year, month)

          Return an iterator for the month `month' (1–12) in the year
          `year'.  This iterator will return all days (as *note
          datetime.date: 193. objects) for the month and all days before
          the start of the month or after the end of the month that are
          required to get a complete week.

      -- Method: itermonthdays (year, month)

          Return an iterator for the month `month' in the year `year'
          similar to *note itermonthdates(): 49c, but not restricted by
          the *note datetime.date: 193. range.  Days returned will
          simply be day of the month numbers.  For the days outside of
          the specified month, the day number is ‘0’.

      -- Method: itermonthdays2 (year, month)

          Return an iterator for the month `month' in the year `year'
          similar to *note itermonthdates(): 49c, but not restricted by
          the *note datetime.date: 193. range.  Days returned will be
          tuples consisting of a day of the month number and a week day
          number.

      -- Method: itermonthdays3 (year, month)

          Return an iterator for the month `month' in the year `year'
          similar to *note itermonthdates(): 49c, but not restricted by
          the *note datetime.date: 193. range.  Days returned will be
          tuples consisting of a year, a month and a day of the month
          numbers.

          New in version 3.7.

      -- Method: itermonthdays4 (year, month)

          Return an iterator for the month `month' in the year `year'
          similar to *note itermonthdates(): 49c, but not restricted by
          the *note datetime.date: 193. range.  Days returned will be
          tuples consisting of a year, a month, a day of the month, and
          a day of the week numbers.

          New in version 3.7.

      -- Method: monthdatescalendar (year, month)

          Return a list of the weeks in the month `month' of the `year'
          as full weeks.  Weeks are lists of seven *note datetime.date:
          193. objects.

      -- Method: monthdays2calendar (year, month)

          Return a list of the weeks in the month `month' of the `year'
          as full weeks.  Weeks are lists of seven tuples of day numbers
          and weekday numbers.

      -- Method: monthdayscalendar (year, month)

          Return a list of the weeks in the month `month' of the `year'
          as full weeks.  Weeks are lists of seven day numbers.

      -- Method: yeardatescalendar (year, width=3)

          Return the data for the specified year ready for formatting.
          The return value is a list of month rows.  Each month row
          contains up to `width' months (defaulting to 3).  Each month
          contains between 4 and 6 weeks and each week contains 1–7
          days.  Days are *note datetime.date: 193. objects.

      -- Method: yeardays2calendar (year, width=3)

          Return the data for the specified year ready for formatting
          (similar to *note yeardatescalendar(): 1839.).  Entries in the
          week lists are tuples of day numbers and weekday numbers.  Day
          numbers outside this month are zero.

      -- Method: yeardayscalendar (year, width=3)

          Return the data for the specified year ready for formatting
          (similar to *note yeardatescalendar(): 1839.).  Entries in the
          week lists are day numbers.  Day numbers outside this month
          are zero.

 -- Class: calendar.TextCalendar (firstweekday=0)

     This class can be used to generate plain text calendars.

     *note TextCalendar: 183c. instances have the following methods:

      -- Method: formatmonth (theyear, themonth, w=0, l=0)

          Return a month’s calendar in a multi-line string.  If `w' is
          provided, it specifies the width of the date columns, which
          are centered.  If `l' is given, it specifies the number of
          lines that each week will use.  Depends on the first weekday
          as specified in the constructor or set by the *note
          setfirstweekday(): 1830. method.

      -- Method: prmonth (theyear, themonth, w=0, l=0)

          Print a month’s calendar as returned by *note formatmonth():
          183d.

      -- Method: formatyear (theyear, w=2, l=1, c=6, m=3)

          Return a `m'-column calendar for an entire year as a
          multi-line string.  Optional parameters `w', `l', and `c' are
          for date column width, lines per week, and number of spaces
          between month columns, respectively.  Depends on the first
          weekday as specified in the constructor or set by the *note
          setfirstweekday(): 1830. method.  The earliest year for which
          a calendar can be generated is platform-dependent.

      -- Method: pryear (theyear, w=2, l=1, c=6, m=3)

          Print the calendar for an entire year as returned by *note
          formatyear(): 183f.

 -- Class: calendar.HTMLCalendar (firstweekday=0)

     This class can be used to generate HTML calendars.

     ‘HTMLCalendar’ instances have the following methods:

      -- Method: formatmonth (theyear, themonth, withyear=True)

          Return a month’s calendar as an HTML table.  If `withyear' is
          true the year will be included in the header, otherwise just
          the month name will be used.

      -- Method: formatyear (theyear, width=3)

          Return a year’s calendar as an HTML table.  `width'
          (defaulting to 3) specifies the number of months per row.

      -- Method: formatyearpage (theyear, width=3, css='calendar.css',
               encoding=None)

          Return a year’s calendar as a complete HTML page.  `width'
          (defaulting to 3) specifies the number of months per row.
          `css' is the name for the cascading style sheet to be used.
          *note None: 157. can be passed if no style sheet should be
          used.  `encoding' specifies the encoding to be used for the
          output (defaulting to the system default encoding).

     ‘HTMLCalendar’ has the following attributes you can override to
     customize the CSS classes used by the calendar:

      -- Attribute: cssclasses

          A list of CSS classes used for each weekday.  The default
          class list is:

               cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]

          more styles can be added for each day:

               cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]

          Note that the length of this list must be seven items.

      -- Attribute: cssclass_noday

          The CSS class for a weekday occurring in the previous or
          coming month.

          New in version 3.7.

      -- Attribute: cssclasses_weekday_head

          A list of CSS classes used for weekday names in the header
          row.  The default is the same as *note cssclasses: 1844.

          New in version 3.7.

      -- Attribute: cssclass_month_head

          The month’s head CSS class (used by ‘formatmonthname()’).  The
          default value is ‘"month"’.

          New in version 3.7.

      -- Attribute: cssclass_month

          The CSS class for the whole month’s table (used by *note
          formatmonth(): 1841.).  The default value is ‘"month"’.

          New in version 3.7.

      -- Attribute: cssclass_year

          The CSS class for the whole year’s table of tables (used by
          *note formatyear(): 1842.).  The default value is ‘"year"’.

          New in version 3.7.

      -- Attribute: cssclass_year_head

          The CSS class for the table head for the whole year (used by
          *note formatyear(): 1842.).  The default value is ‘"year"’.

          New in version 3.7.

     Note that although the naming for the above described class
     attributes is singular (e.g.  ‘cssclass_month’ ‘cssclass_noday’),
     one can replace the single CSS class with a space separated list of
     CSS classes, for example:

          "text-bold text-red"

     Here is an example how ‘HTMLCalendar’ can be customized:

          class CustomHTMLCal(calendar.HTMLCalendar):
              cssclasses = [style + " text-nowrap" for style in
                            calendar.HTMLCalendar.cssclasses]
              cssclass_month_head = "text-center month-head"
              cssclass_month = "text-center month"
              cssclass_year = "text-italic lead"

 -- Class: calendar.LocaleTextCalendar (firstweekday=0, locale=None)

     This subclass of *note TextCalendar: 183c. can be passed a locale
     name in the constructor and will return month and weekday names in
     the specified locale.  If this locale includes an encoding all
     strings containing month and weekday names will be returned as
     unicode.

 -- Class: calendar.LocaleHTMLCalendar (firstweekday=0, locale=None)

     This subclass of *note HTMLCalendar: 364. can be passed a locale
     name in the constructor and will return month and weekday names in
     the specified locale.  If this locale includes an encoding all
     strings containing month and weekday names will be returned as
     unicode.

     Note: The ‘formatweekday()’ and ‘formatmonthname()’ methods of
     these two classes temporarily change the current locale to the
     given `locale'.  Because the current locale is a process-wide
     setting, they are not thread-safe.

For simple text calendars this module provides the following functions.

 -- Function: calendar.setfirstweekday (weekday)

     Sets the weekday (‘0’ is Monday, ‘6’ is Sunday) to start each week.
     The values ‘MONDAY’, ‘TUESDAY’, ‘WEDNESDAY’, ‘THURSDAY’, ‘FRIDAY’,
     ‘SATURDAY’, and ‘SUNDAY’ are provided for convenience.  For
     example, to set the first weekday to Sunday:

          import calendar
          calendar.setfirstweekday(calendar.SUNDAY)

 -- Function: calendar.firstweekday ()

     Returns the current setting for the weekday to start each week.

 -- Function: calendar.isleap (year)

     Returns *note True: 48f. if `year' is a leap year, otherwise *note
     False: 37d.

 -- Function: calendar.leapdays (y1, y2)

     Returns the number of leap years in the range from `y1' to `y2'
     (exclusive), where `y1' and `y2' are years.

     This function works for ranges spanning a century change.

 -- Function: calendar.weekday (year, month, day)

     Returns the day of the week (‘0’ is Monday) for `year' (‘1970’–…),
     `month' (‘1’–‘12’), `day' (‘1’–‘31’).

 -- Function: calendar.weekheader (n)

     Return a header containing abbreviated weekday names.  `n'
     specifies the width in characters for one weekday.

 -- Function: calendar.monthrange (year, month)

     Returns weekday of first day of the month and number of days in
     month, for the specified `year' and `month'.

 -- Function: calendar.monthcalendar (year, month)

     Returns a matrix representing a month’s calendar.  Each row
     represents a week; days outside of the month a represented by
     zeros.  Each week begins with Monday unless set by *note
     setfirstweekday(): 1830.

 -- Function: calendar.prmonth (theyear, themonth, w=0, l=0)

     Prints a month’s calendar as returned by *note month(): 1854.

 -- Function: calendar.month (theyear, themonth, w=0, l=0)

     Returns a month’s calendar in a multi-line string using the
     ‘formatmonth()’ of the *note TextCalendar: 183c. class.

 -- Function: calendar.prcal (year, w=0, l=0, c=6, m=3)

     Prints the calendar for an entire year as returned by *note
     calendar(): 15.

 -- Function: calendar.calendar (year, w=2, l=1, c=6, m=3)

     Returns a 3-column calendar for an entire year as a multi-line
     string using the ‘formatyear()’ of the *note TextCalendar: 183c.
     class.

 -- Function: calendar.timegm (tuple)

     An unrelated but handy function that takes a time tuple such as
     returned by the *note gmtime(): b32. function in the *note time:
     10a. module, and returns the corresponding Unix timestamp value,
     assuming an epoch of 1970, and the POSIX encoding.  In fact, *note
     time.gmtime(): b32. and *note timegm(): 1857. are each others’
     inverse.

The *note calendar: 15. module exports the following data attributes:

 -- Data: calendar.day_name

     An array that represents the days of the week in the current
     locale.

 -- Data: calendar.day_abbr

     An array that represents the abbreviated days of the week in the
     current locale.

 -- Data: calendar.month_name

     An array that represents the months of the year in the current
     locale.  This follows normal convention of January being month
     number 1, so it has a length of 13 and ‘month_name[0]’ is the empty
     string.

 -- Data: calendar.month_abbr

     An array that represents the abbreviated months of the year in the
     current locale.  This follows normal convention of January being
     month number 1, so it has a length of 13 and ‘month_abbr[0]’ is the
     empty string.

See also
........

Module *note datetime: 31.

     Object-oriented interface to dates and times with similar
     functionality to the *note time: 10a. module.

Module *note time: 10a.

     Low-level time related functions.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/calendar.py


File: python.info,  Node: collections — Container datatypes,  Next: collections abc — Abstract Base Classes for Containers,  Prev: calendar — General calendar-related functions,  Up: Data Types

5.8.3 ‘collections’ — Container datatypes
-----------------------------------------

`Source code:' Lib/collections/__init__.py(1)

__________________________________________________________________

This module implements specialized container datatypes providing
alternatives to Python’s general purpose built-in containers, *note
dict: 1b6, *note list: 260, *note set: b62, and *note tuple: 473.

*note namedtuple(): 1b5.  factory function for creating tuple subclasses with named fields
                          
                          
*note deque: 526.         list-like container with fast appends and pops on either end
                          
                          
*note ChainMap: 49f.      dict-like class for creating a single view of multiple mappings
                          
                          
*note Counter: 9ce.       dict subclass for counting hashable objects
                          
                          
*note OrderedDict: 1b7.   dict subclass that remembers the order entries were added
                          
                          
*note defaultdict: b2d.   dict subclass that calls a factory function to supply missing values
                          
                          
*note UserDict: 185e.     wrapper around dictionary objects for easier dict subclassing
                          
                          
*note UserList: 185f.     wrapper around list objects for easier list subclassing
                          
                          
*note UserString: 6a1.    wrapper around string objects for easier string subclassing
                          

Deprecated since version 3.3, will be removed in version 3.9: Moved
*note Collections Abstract Base Classes: 1860. to the *note
collections.abc: 1f. module.  For backwards compatibility, they continue
to be visible in this module through Python 3.8.

* Menu:

* ChainMap objects::
* Counter objects::
* deque objects::
* defaultdict objects::
* namedtuple() Factory Function for Tuples with Named Fields: namedtuple Factory Function for Tuples with Named Fields.
* OrderedDict objects::
* UserDict objects::
* UserList objects::
* UserString objects::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/collections/__init__.py


File: python.info,  Node: ChainMap objects,  Next: Counter objects,  Up: collections — Container datatypes

5.8.3.1 ‘ChainMap’ objects
..........................

New in version 3.3.

A *note ChainMap: 49f. class is provided for quickly linking a number of
mappings so they can be treated as a single unit.  It is often much
faster than creating a new dictionary and running multiple *note
update(): dbc. calls.

The class can be used to simulate nested scopes and is useful in
templating.

 -- Class: collections.ChainMap (*maps)

     A *note ChainMap: 49f. groups multiple dicts or other mappings
     together to create a single, updateable view.  If no `maps' are
     specified, a single empty dictionary is provided so that a new
     chain always has at least one mapping.

     The underlying mappings are stored in a list.  That list is public
     and can be accessed or updated using the `maps' attribute.  There
     is no other state.

     Lookups search the underlying mappings successively until a key is
     found.  In contrast, writes, updates, and deletions only operate on
     the first mapping.

     A *note ChainMap: 49f. incorporates the underlying mappings by
     reference.  So, if one of the underlying mappings gets updated,
     those changes will be reflected in *note ChainMap: 49f.

     All of the usual dictionary methods are supported.  In addition,
     there is a `maps' attribute, a method for creating new subcontexts,
     and a property for accessing all but the first mapping:

      -- Attribute: maps

          A user updateable list of mappings.  The list is ordered from
          first-searched to last-searched.  It is the only stored state
          and can be modified to change which mappings are searched.
          The list should always contain at least one mapping.

      -- Method: new_child (m=None)

          Returns a new *note ChainMap: 49f. containing a new map
          followed by all of the maps in the current instance.  If ‘m’
          is specified, it becomes the new map at the front of the list
          of mappings; if not specified, an empty dict is used, so that
          a call to ‘d.new_child()’ is equivalent to: ‘ChainMap({},
          *d.maps)’.  This method is used for creating subcontexts that
          can be updated without altering values in any of the parent
          mappings.

          Changed in version 3.4: The optional ‘m’ parameter was added.

      -- Attribute: parents

          Property returning a new *note ChainMap: 49f. containing all
          of the maps in the current instance except the first one.
          This is useful for skipping the first map in the search.  Use
          cases are similar to those for the *note nonlocal: c32.
          keyword used in *note nested scopes: 1526.  The use cases also
          parallel those for the built-in *note super(): 4d7. function.
          A reference to ‘d.parents’ is equivalent to:
          ‘ChainMap(*d.maps[1:])’.

     Note, the iteration order of a *note ChainMap(): 49f. is determined
     by scanning the mappings last to first:

          >>> baseline = {'music': 'bach', 'art': 'rembrandt'}
          >>> adjustments = {'art': 'van gogh', 'opera': 'carmen'}
          >>> list(ChainMap(adjustments, baseline))
          ['music', 'art', 'opera']

     This gives the same ordering as a series of *note dict.update():
     dbc. calls starting with the last mapping:

          >>> combined = baseline.copy()
          >>> combined.update(adjustments)
          >>> list(combined)
          ['music', 'art', 'opera']

See also
........

   * The MultiContext class(1) in the Enthought CodeTools package(2) has
     options to support writing to any mapping in the chain.

   * Django’s Context class(3) for templating is a read-only chain of
     mappings.  It also features pushing and popping of contexts similar
     to the *note new_child(): 81d. method and the *note parents: 1863.
     property.

   * The Nested Contexts recipe(4) has options to control whether writes
     and other mutations apply only to the first mapping or to any
     mapping in the chain.

   * A greatly simplified read-only version of Chainmap(5).

* Menu:

* ChainMap Examples and Recipes::

   ---------- Footnotes ----------

   (1) 
https://github.com/enthought/codetools/blob/4.0.0/codetools/contexts/multi_context.py

   (2) https://github.com/enthought/codetools

   (3) 
https://github.com/django/django/blob/master/django/template/context.py

   (4) https://code.activestate.com/recipes/577434/

   (5) https://code.activestate.com/recipes/305268/


File: python.info,  Node: ChainMap Examples and Recipes,  Up: ChainMap objects

5.8.3.2 ‘ChainMap’ Examples and Recipes
.......................................

This section shows various approaches to working with chained maps.

Example of simulating Python’s internal lookup chain:

     import builtins
     pylookup = ChainMap(locals(), globals(), vars(builtins))

Example of letting user specified command-line arguments take precedence
over environment variables which in turn take precedence over default
values:

     import os, argparse

     defaults = {'color': 'red', 'user': 'guest'}

     parser = argparse.ArgumentParser()
     parser.add_argument('-u', '--user')
     parser.add_argument('-c', '--color')
     namespace = parser.parse_args()
     command_line_args = {k: v for k, v in vars(namespace).items() if v is not None}

     combined = ChainMap(command_line_args, os.environ, defaults)
     print(combined['color'])
     print(combined['user'])

Example patterns for using the *note ChainMap: 49f. class to simulate
nested contexts:

     c = ChainMap()        # Create root context
     d = c.new_child()     # Create nested child context
     e = c.new_child()     # Child of c, independent from d
     e.maps[0]             # Current context dictionary -- like Python's locals()
     e.maps[-1]            # Root context -- like Python's globals()
     e.parents             # Enclosing context chain -- like Python's nonlocals

     d['x'] = 1            # Set value in current context
     d['x']                # Get first key in the chain of contexts
     del d['x']            # Delete from current context
     list(d)               # All nested values
     k in d                # Check all nested values
     len(d)                # Number of nested values
     d.items()             # All nested items
     dict(d)               # Flatten into a regular dictionary

The *note ChainMap: 49f. class only makes updates (writes and deletions)
to the first mapping in the chain while lookups will search the full
chain.  However, if deep writes and deletions are desired, it is easy to
make a subclass that updates keys found deeper in the chain:

     class DeepChainMap(ChainMap):
         'Variant of ChainMap that allows direct updates to inner scopes'

         def __setitem__(self, key, value):
             for mapping in self.maps:
                 if key in mapping:
                     mapping[key] = value
                     return
             self.maps[0][key] = value

         def __delitem__(self, key):
             for mapping in self.maps:
                 if key in mapping:
                     del mapping[key]
                     return
             raise KeyError(key)

     >>> d = DeepChainMap({'zebra': 'black'}, {'elephant': 'blue'}, {'lion': 'yellow'})
     >>> d['lion'] = 'orange'         # update an existing key two levels down
     >>> d['snake'] = 'red'           # new keys get added to the topmost dict
     >>> del d['elephant']            # remove an existing key one level down
     >>> d                            # display result
     DeepChainMap({'zebra': 'black', 'snake': 'red'}, {}, {'lion': 'orange'})


File: python.info,  Node: Counter objects,  Next: deque objects,  Prev: ChainMap objects,  Up: collections — Container datatypes

5.8.3.3 ‘Counter’ objects
.........................

A counter tool is provided to support convenient and rapid tallies.  For
example:

     >>> # Tally occurrences of words in a list
     >>> cnt = Counter()
     >>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
     ...     cnt[word] += 1
     >>> cnt
     Counter({'blue': 3, 'red': 2, 'green': 1})

     >>> # Find the ten most common words in Hamlet
     >>> import re
     >>> words = re.findall(r'\w+', open('hamlet.txt').read().lower())
     >>> Counter(words).most_common(10)
     [('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631),
      ('you', 554),  ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)]

 -- Class: collections.Counter ([iterable-or-mapping])

     A *note Counter: 9ce. is a *note dict: 1b6. subclass for counting
     hashable objects.  It is a collection where elements are stored as
     dictionary keys and their counts are stored as dictionary values.
     Counts are allowed to be any integer value including zero or
     negative counts.  The *note Counter: 9ce. class is similar to bags
     or multisets in other languages.

     Elements are counted from an `iterable' or initialized from another
     `mapping' (or counter):

          >>> c = Counter()                           # a new, empty counter
          >>> c = Counter('gallahad')                 # a new counter from an iterable
          >>> c = Counter({'red': 4, 'blue': 2})      # a new counter from a mapping
          >>> c = Counter(cats=4, dogs=8)             # a new counter from keyword args

     Counter objects have a dictionary interface except that they return
     a zero count for missing items instead of raising a *note KeyError:
     2c5.:

          >>> c = Counter(['eggs', 'ham'])
          >>> c['bacon']                              # count of a missing element is zero
          0

     Setting a count to zero does not remove an element from a counter.
     Use ‘del’ to remove it entirely:

          >>> c['sausage'] = 0                        # counter entry with a zero count
          >>> del c['sausage']                        # del actually removes the entry

     New in version 3.1.

     Changed in version 3.7: As a *note dict: 1b6. subclass, *note
     Counter: 9ce. Inherited the capability to remember insertion order.
     Math operations on `Counter' objects also preserve order.  Results
     are ordered according to when an element is first encountered in
     the left operand and then by the order encountered in the right
     operand.

     Counter objects support three methods beyond those available for
     all dictionaries:

      -- Method: elements ()

          Return an iterator over elements repeating each as many times
          as its count.  Elements are returned in the order first
          encountered.  If an element’s count is less than one, *note
          elements(): c8d. will ignore it.

               >>> c = Counter(a=4, b=2, c=0, d=-2)
               >>> sorted(c.elements())
               ['a', 'a', 'a', 'a', 'b', 'b']

      -- Method: most_common ([n])

          Return a list of the `n' most common elements and their counts
          from the most common to the least.  If `n' is omitted or
          ‘None’, *note most_common(): c8c. returns `all' elements in
          the counter.  Elements with equal counts are ordered in the
          order first encountered:

               >>> Counter('abracadabra').most_common(3)
               [('a', 5), ('b', 2), ('r', 2)]

      -- Method: subtract ([iterable-or-mapping])

          Elements are subtracted from an `iterable' or from another
          `mapping' (or counter).  Like *note dict.update(): dbc. but
          subtracts counts instead of replacing them.  Both inputs and
          outputs may be zero or negative.

               >>> c = Counter(a=4, b=2, c=0, d=-2)
               >>> d = Counter(a=1, b=2, c=3, d=4)
               >>> c.subtract(d)
               >>> c
               Counter({'a': 3, 'b': 0, 'c': -3, 'd': -6})

          New in version 3.2.

     The usual dictionary methods are available for *note Counter: 9ce.
     objects except for two which work differently for counters.

      -- Method: fromkeys (iterable)

          This class method is not implemented for *note Counter: 9ce.
          objects.

      -- Method: update ([iterable-or-mapping])

          Elements are counted from an `iterable' or added-in from
          another `mapping' (or counter).  Like *note dict.update():
          dbc. but adds counts instead of replacing them.  Also, the
          `iterable' is expected to be a sequence of elements, not a
          sequence of ‘(key, value)’ pairs.

Common patterns for working with *note Counter: 9ce. objects:

     sum(c.values())                 # total of all counts
     c.clear()                       # reset all counts
     list(c)                         # list unique elements
     set(c)                          # convert to a set
     dict(c)                         # convert to a regular dictionary
     c.items()                       # convert to a list of (elem, cnt) pairs
     Counter(dict(list_of_pairs))    # convert from a list of (elem, cnt) pairs
     c.most_common()[:-n-1:-1]       # n least common elements
     +c                              # remove zero and negative counts

Several mathematical operations are provided for combining *note
Counter: 9ce. objects to produce multisets (counters that have counts
greater than zero).  Addition and subtraction combine counters by adding
or subtracting the counts of corresponding elements.  Intersection and
union return the minimum and maximum of corresponding counts.  Each
operation can accept inputs with signed counts, but the output will
exclude results with counts of zero or less.

     >>> c = Counter(a=3, b=1)
     >>> d = Counter(a=1, b=2)
     >>> c + d                       # add two counters together:  c[x] + d[x]
     Counter({'a': 4, 'b': 3})
     >>> c - d                       # subtract (keeping only positive counts)
     Counter({'a': 2})
     >>> c & d                       # intersection:  min(c[x], d[x]) # doctest: +SKIP
     Counter({'a': 1, 'b': 1})
     >>> c | d                       # union:  max(c[x], d[x])
     Counter({'a': 3, 'b': 2})

Unary addition and subtraction are shortcuts for adding an empty counter
or subtracting from an empty counter.

     >>> c = Counter(a=2, b=-4)
     >>> +c
     Counter({'a': 2})
     >>> -c
     Counter({'b': 4})

New in version 3.3: Added support for unary plus, unary minus, and
in-place multiset operations.

     Note: Counters were primarily designed to work with positive
     integers to represent running counts; however, care was taken to
     not unnecessarily preclude use cases needing other types or
     negative values.  To help with those use cases, this section
     documents the minimum range and type restrictions.

        * The *note Counter: 9ce. class itself is a dictionary subclass
          with no restrictions on its keys and values.  The values are
          intended to be numbers representing counts, but you `could'
          store anything in the value field.

        * The *note most_common(): c8c. method requires only that the
          values be orderable.

        * For in-place operations such as ‘c[key] += 1’, the value type
          need only support addition and subtraction.  So fractions,
          floats, and decimals would work and negative values are
          supported.  The same is also true for *note update(): 1867.
          and *note subtract(): b4d. which allow negative and zero
          values for both inputs and outputs.

        * The multiset methods are designed only for use cases with
          positive values.  The inputs may be negative or zero, but only
          outputs with positive values are created.  There are no type
          restrictions, but the value type needs to support addition,
          subtraction, and comparison.

        * The *note elements(): c8d. method requires integer counts.  It
          ignores zero and negative counts.

See also
........

   * Bag class(1) in Smalltalk.

   * Wikipedia entry for Multisets(2).

   * C++ multisets(3) tutorial with examples.

   * For mathematical operations on multisets and their use cases, see
     `Knuth, Donald.  The Art of Computer Programming Volume II, Section
     4.6.3, Exercise 19'.

   * To enumerate all distinct multisets of a given size over a given
     set of elements, see *note
     itertools.combinations_with_replacement(): c0c.:

          map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC

   ---------- Footnotes ----------

   (1) 
https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html

   (2) https://en.wikipedia.org/wiki/Multiset

   (3) 
http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm


File: python.info,  Node: deque objects,  Next: defaultdict objects,  Prev: Counter objects,  Up: collections — Container datatypes

5.8.3.4 ‘deque’ objects
.......................

 -- Class: collections.deque ([iterable[, maxlen]])

     Returns a new deque object initialized left-to-right (using *note
     append(): 1869.) with data from `iterable'.  If `iterable' is not
     specified, the new deque is empty.

     Deques are a generalization of stacks and queues (the name is
     pronounced “deck” and is short for “double-ended queue”).  Deques
     support thread-safe, memory efficient appends and pops from either
     side of the deque with approximately the same O(1) performance in
     either direction.

     Though *note list: 260. objects support similar operations, they
     are optimized for fast fixed-length operations and incur O(n)
     memory movement costs for ‘pop(0)’ and ‘insert(0, v)’ operations
     which change both the size and position of the underlying data
     representation.

     If `maxlen' is not specified or is ‘None’, deques may grow to an
     arbitrary length.  Otherwise, the deque is bounded to the specified
     maximum length.  Once a bounded length deque is full, when new
     items are added, a corresponding number of items are discarded from
     the opposite end.  Bounded length deques provide functionality
     similar to the ‘tail’ filter in Unix.  They are also useful for
     tracking transactions and other pools of data where only the most
     recent activity is of interest.

     Deque objects support the following methods:

      -- Method: append (x)

          Add `x' to the right side of the deque.

      -- Method: appendleft (x)

          Add `x' to the left side of the deque.

      -- Method: clear ()

          Remove all elements from the deque leaving it with length 0.

      -- Method: copy ()

          Create a shallow copy of the deque.

          New in version 3.5.

      -- Method: count (x)

          Count the number of deque elements equal to `x'.

          New in version 3.2.

      -- Method: extend (iterable)

          Extend the right side of the deque by appending elements from
          the iterable argument.

      -- Method: extendleft (iterable)

          Extend the left side of the deque by appending elements from
          `iterable'.  Note, the series of left appends results in
          reversing the order of elements in the iterable argument.

      -- Method: index (x[, start[, stop]])

          Return the position of `x' in the deque (at or after index
          `start' and before index `stop').  Returns the first match or
          raises *note ValueError: 1f9. if not found.

          New in version 3.5.

      -- Method: insert (i, x)

          Insert `x' into the deque at position `i'.

          If the insertion would cause a bounded deque to grow beyond
          `maxlen', an *note IndexError: e69. is raised.

          New in version 3.5.

      -- Method: pop ()

          Remove and return an element from the right side of the deque.
          If no elements are present, raises an *note IndexError: e69.

      -- Method: popleft ()

          Remove and return an element from the left side of the deque.
          If no elements are present, raises an *note IndexError: e69.

      -- Method: remove (value)

          Remove the first occurrence of `value'.  If not found, raises
          a *note ValueError: 1f9.

      -- Method: reverse ()

          Reverse the elements of the deque in-place and then return
          ‘None’.

          New in version 3.2.

      -- Method: rotate (n=1)

          Rotate the deque `n' steps to the right.  If `n' is negative,
          rotate to the left.

          When the deque is not empty, rotating one step to the right is
          equivalent to ‘d.appendleft(d.pop())’, and rotating one step
          to the left is equivalent to ‘d.append(d.popleft())’.

     Deque objects also provide one read-only attribute:

      -- Attribute: maxlen

          Maximum size of a deque or ‘None’ if unbounded.

          New in version 3.1.

In addition to the above, deques support iteration, pickling, ‘len(d)’,
‘reversed(d)’, ‘copy.copy(d)’, ‘copy.deepcopy(d)’, membership testing
with the *note in: 797. operator, and subscript references such as
‘d[0]’ to access the first element.  Indexed access is O(1) at both ends
but slows to O(n) in the middle.  For fast random access, use lists
instead.

Starting in version 3.5, deques support ‘__add__()’, ‘__mul__()’, and
‘__imul__()’.

Example:

     >>> from collections import deque
     >>> d = deque('ghi')                 # make a new deque with three items
     >>> for elem in d:                   # iterate over the deque's elements
     ...     print(elem.upper())
     G
     H
     I

     >>> d.append('j')                    # add a new entry to the right side
     >>> d.appendleft('f')                # add a new entry to the left side
     >>> d                                # show the representation of the deque
     deque(['f', 'g', 'h', 'i', 'j'])

     >>> d.pop()                          # return and remove the rightmost item
     'j'
     >>> d.popleft()                      # return and remove the leftmost item
     'f'
     >>> list(d)                          # list the contents of the deque
     ['g', 'h', 'i']
     >>> d[0]                             # peek at leftmost item
     'g'
     >>> d[-1]                            # peek at rightmost item
     'i'

     >>> list(reversed(d))                # list the contents of a deque in reverse
     ['i', 'h', 'g']
     >>> 'h' in d                         # search the deque
     True
     >>> d.extend('jkl')                  # add multiple elements at once
     >>> d
     deque(['g', 'h', 'i', 'j', 'k', 'l'])
     >>> d.rotate(1)                      # right rotation
     >>> d
     deque(['l', 'g', 'h', 'i', 'j', 'k'])
     >>> d.rotate(-1)                     # left rotation
     >>> d
     deque(['g', 'h', 'i', 'j', 'k', 'l'])

     >>> deque(reversed(d))               # make a new deque in reverse order
     deque(['l', 'k', 'j', 'i', 'h', 'g'])
     >>> d.clear()                        # empty the deque
     >>> d.pop()                          # cannot pop from an empty deque
     Traceback (most recent call last):
         File "<pyshell#6>", line 1, in -toplevel-
             d.pop()
     IndexError: pop from an empty deque

     >>> d.extendleft('abc')              # extendleft() reverses the input order
     >>> d
     deque(['c', 'b', 'a'])

* Menu:

* deque Recipes::


File: python.info,  Node: deque Recipes,  Up: deque objects

5.8.3.5 ‘deque’ Recipes
.......................

This section shows various approaches to working with deques.

Bounded length deques provide functionality similar to the ‘tail’ filter
in Unix:

     def tail(filename, n=10):
         'Return the last n lines of a file'
         with open(filename) as f:
             return deque(f, n)

Another approach to using deques is to maintain a sequence of recently
added elements by appending to the right and popping to the left:

     def moving_average(iterable, n=3):
         # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0
         # http://en.wikipedia.org/wiki/Moving_average
         it = iter(iterable)
         d = deque(itertools.islice(it, n-1))
         d.appendleft(0)
         s = sum(d)
         for elem in it:
             s += elem - d.popleft()
             d.append(elem)
             yield s / n

A round-robin scheduler(1) can be implemented with input iterators
stored in a *note deque: 526.  Values are yielded from the active
iterator in position zero.  If that iterator is exhausted, it can be
removed with *note popleft(): 186f.; otherwise, it can be cycled back to
the end with the *note rotate(): 1871. method:

     def roundrobin(*iterables):
         "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
         iterators = deque(map(iter, iterables))
         while iterators:
             try:
                 while True:
                     yield next(iterators[0])
                     iterators.rotate(-1)
             except StopIteration:
                 # Remove an exhausted iterator.
                 iterators.popleft()

The *note rotate(): 1871. method provides a way to implement *note
deque: 526. slicing and deletion.  For example, a pure Python
implementation of ‘del d[n]’ relies on the ‘rotate()’ method to position
elements to be popped:

     def delete_nth(d, n):
         d.rotate(-n)
         d.popleft()
         d.rotate(n)

To implement *note deque: 526. slicing, use a similar approach applying
*note rotate(): 1871. to bring a target element to the left side of the
deque.  Remove old entries with *note popleft(): 186f, add new entries
with *note extend(): 186c, and then reverse the rotation.  With minor
variations on that approach, it is easy to implement Forth style stack
manipulations such as ‘dup’, ‘drop’, ‘swap’, ‘over’, ‘pick’, ‘rot’, and
‘roll’.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Round-robin_scheduling


File: python.info,  Node: defaultdict objects,  Next: namedtuple Factory Function for Tuples with Named Fields,  Prev: deque objects,  Up: collections — Container datatypes

5.8.3.6 ‘defaultdict’ objects
.............................

 -- Class: collections.defaultdict ([default_factory[, ...]])

     Returns a new dictionary-like object.  *note defaultdict: b2d. is a
     subclass of the built-in *note dict: 1b6. class.  It overrides one
     method and adds one writable instance variable.  The remaining
     functionality is the same as for the *note dict: 1b6. class and is
     not documented here.

     The first argument provides the initial value for the *note
     default_factory: 1874. attribute; it defaults to ‘None’.  All
     remaining arguments are treated the same as if they were passed to
     the *note dict: 1b6. constructor, including keyword arguments.

     *note defaultdict: b2d. objects support the following method in
     addition to the standard *note dict: 1b6. operations:

      -- Method: __missing__ (key)

          If the *note default_factory: 1874. attribute is ‘None’, this
          raises a *note KeyError: 2c5. exception with the `key' as
          argument.

          If *note default_factory: 1874. is not ‘None’, it is called
          without arguments to provide a default value for the given
          `key', this value is inserted in the dictionary for the `key',
          and returned.

          If calling *note default_factory: 1874. raises an exception
          this exception is propagated unchanged.

          This method is called by the *note __getitem__(): 27a. method
          of the *note dict: 1b6. class when the requested key is not
          found; whatever it returns or raises is then returned or
          raised by *note __getitem__(): 27a.

          Note that *note __missing__(): 1875. is `not' called for any
          operations besides *note __getitem__(): 27a.  This means that
          ‘get()’ will, like normal dictionaries, return ‘None’ as a
          default rather than using *note default_factory: 1874.

     *note defaultdict: b2d. objects support the following instance
     variable:

      -- Attribute: default_factory

          This attribute is used by the *note __missing__(): 1875.
          method; it is initialized from the first argument to the
          constructor, if present, or to ‘None’, if absent.

* Menu:

* defaultdict Examples::


File: python.info,  Node: defaultdict Examples,  Up: defaultdict objects

5.8.3.7 ‘defaultdict’ Examples
..............................

Using *note list: 260. as the *note default_factory: 1874, it is easy to
group a sequence of key-value pairs into a dictionary of lists:

     >>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)]
     >>> d = defaultdict(list)
     >>> for k, v in s:
     ...     d[k].append(v)
     ...
     >>> sorted(d.items())
     [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]

When each key is encountered for the first time, it is not already in
the mapping; so an entry is automatically created using the *note
default_factory: 1874. function which returns an empty *note list: 260.
The ‘list.append()’ operation then attaches the value to the new list.
When keys are encountered again, the look-up proceeds normally
(returning the list for that key) and the ‘list.append()’ operation adds
another value to the list.  This technique is simpler and faster than an
equivalent technique using *note dict.setdefault(): 9b3.:

     >>> d = {}
     >>> for k, v in s:
     ...     d.setdefault(k, []).append(v)
     ...
     >>> sorted(d.items())
     [('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]

Setting the *note default_factory: 1874. to *note int: 184. makes the
*note defaultdict: b2d. useful for counting (like a bag or multiset in
other languages):

     >>> s = 'mississippi'
     >>> d = defaultdict(int)
     >>> for k in s:
     ...     d[k] += 1
     ...
     >>> sorted(d.items())
     [('i', 4), ('m', 1), ('p', 2), ('s', 4)]

When a letter is first encountered, it is missing from the mapping, so
the *note default_factory: 1874. function calls *note int(): 184. to
supply a default count of zero.  The increment operation then builds up
the count for each letter.

The function *note int(): 184. which always returns zero is just a
special case of constant functions.  A faster and more flexible way to
create constant functions is to use a lambda function which can supply
any constant value (not just zero):

     >>> def constant_factory(value):
     ...     return lambda: value
     >>> d = defaultdict(constant_factory('<missing>'))
     >>> d.update(name='John', action='ran')
     >>> '%(name)s %(action)s to %(object)s' % d
     'John ran to <missing>'

Setting the *note default_factory: 1874. to *note set: b62. makes the
*note defaultdict: b2d. useful for building a dictionary of sets:

     >>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)]
     >>> d = defaultdict(set)
     >>> for k, v in s:
     ...     d[k].add(v)
     ...
     >>> sorted(d.items())
     [('blue', {2, 4}), ('red', {1, 3})]


File: python.info,  Node: namedtuple Factory Function for Tuples with Named Fields,  Next: OrderedDict objects,  Prev: defaultdict objects,  Up: collections — Container datatypes

5.8.3.8 ‘namedtuple()’ Factory Function for Tuples with Named Fields
....................................................................

Named tuples assign meaning to each position in a tuple and allow for
more readable, self-documenting code.  They can be used wherever regular
tuples are used, and they add the ability to access fields by name
instead of position index.

 -- Function: collections.namedtuple (typename, field_names, *,
          rename=False, defaults=None, module=None)

     Returns a new tuple subclass named `typename'.  The new subclass is
     used to create tuple-like objects that have fields accessible by
     attribute lookup as well as being indexable and iterable.
     Instances of the subclass also have a helpful docstring (with
     typename and field_names) and a helpful *note __repr__(): 333.
     method which lists the tuple contents in a ‘name=value’ format.

     The `field_names' are a sequence of strings such as ‘['x', 'y']’.
     Alternatively, `field_names' can be a single string with each
     fieldname separated by whitespace and/or commas, for example ‘'x
     y'’ or ‘'x, y'’.

     Any valid Python identifier may be used for a fieldname except for
     names starting with an underscore.  Valid identifiers consist of
     letters, digits, and underscores but do not start with a digit or
     underscore and cannot be a *note keyword: a6. such as `class',
     `for', `return', `global', `pass', or `raise'.

     If `rename' is true, invalid fieldnames are automatically replaced
     with positional names.  For example, ‘['abc', 'def', 'ghi', 'abc']’
     is converted to ‘['abc', '_1', 'ghi', '_3']’, eliminating the
     keyword ‘def’ and the duplicate fieldname ‘abc’.

     `defaults' can be ‘None’ or an *note iterable: b9f. of default
     values.  Since fields with a default value must come after any
     fields without a default, the `defaults' are applied to the
     rightmost parameters.  For example, if the fieldnames are ‘['x',
     'y', 'z']’ and the defaults are ‘(1, 2)’, then ‘x’ will be a
     required argument, ‘y’ will default to ‘1’, and ‘z’ will default to
     ‘2’.

     If `module' is defined, the ‘__module__’ attribute of the named
     tuple is set to that value.

     Named tuple instances do not have per-instance dictionaries, so
     they are lightweight and require no more memory than regular
     tuples.

     Changed in version 3.1: Added support for `rename'.

     Changed in version 3.6: The `verbose' and `rename' parameters
     became *note keyword-only arguments: 2aa.

     Changed in version 3.6: Added the `module' parameter.

     Changed in version 3.7: Removed the `verbose' parameter and the
     ‘_source’ attribute.

     Changed in version 3.7: Added the `defaults' parameter and the
     ‘_field_defaults’ attribute.

     >>> # Basic example
     >>> Point = namedtuple('Point', ['x', 'y'])
     >>> p = Point(11, y=22)     # instantiate with positional or keyword arguments
     >>> p[0] + p[1]             # indexable like the plain tuple (11, 22)
     33
     >>> x, y = p                # unpack like a regular tuple
     >>> x, y
     (11, 22)
     >>> p.x + p.y               # fields also accessible by name
     33
     >>> p                       # readable __repr__ with a name=value style
     Point(x=11, y=22)

Named tuples are especially useful for assigning field names to result
tuples returned by the *note csv: 2a. or *note sqlite3: f2. modules:

     EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade')

     import csv
     for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))):
         print(emp.name, emp.title)

     import sqlite3
     conn = sqlite3.connect('/companydata')
     cursor = conn.cursor()
     cursor.execute('SELECT name, age, title, department, paygrade FROM employees')
     for emp in map(EmployeeRecord._make, cursor.fetchall()):
         print(emp.name, emp.title)

In addition to the methods inherited from tuples, named tuples support
three additional methods and two attributes.  To prevent conflicts with
field names, the method and attribute names start with an underscore.

 -- Class Method: somenamedtuple._make (iterable)

     Class method that makes a new instance from an existing sequence or
     iterable.

          >>> t = [11, 22]
          >>> Point._make(t)
          Point(x=11, y=22)

 -- Method: somenamedtuple._asdict ()

     Return a new *note dict: 1b6. which maps field names to their
     corresponding values:

          >>> p = Point(x=11, y=22)
          >>> p._asdict()
          {'x': 11, 'y': 22}

     Changed in version 3.1: Returns an *note OrderedDict: 1b7. instead
     of a regular *note dict: 1b6.

     Changed in version 3.8: Returns a regular *note dict: 1b6. instead
     of an *note OrderedDict: 1b7.  As of Python 3.7, regular dicts are
     guaranteed to be ordered.  If the extra features of *note
     OrderedDict: 1b7. are required, the suggested remediation is to
     cast the result to the desired type: ‘OrderedDict(nt._asdict())’.

 -- Method: somenamedtuple._replace (**kwargs)

     Return a new instance of the named tuple replacing specified fields
     with new values:

          >>> p = Point(x=11, y=22)
          >>> p._replace(x=33)
          Point(x=33, y=22)

          >>> for partnum, record in inventory.items():
          ...     inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())

 -- Attribute: somenamedtuple._fields

     Tuple of strings listing the field names.  Useful for introspection
     and for creating new named tuple types from existing named tuples.

          >>> p._fields            # view the field names
          ('x', 'y')

          >>> Color = namedtuple('Color', 'red green blue')
          >>> Pixel = namedtuple('Pixel', Point._fields + Color._fields)
          >>> Pixel(11, 22, 128, 255, 0)
          Pixel(x=11, y=22, red=128, green=255, blue=0)

 -- Attribute: somenamedtuple._field_defaults

     Dictionary mapping field names to default values.

          >>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
          >>> Account._field_defaults
          {'balance': 0}
          >>> Account('premium')
          Account(type='premium', balance=0)

To retrieve a field whose name is stored in a string, use the *note
getattr(): 43d. function:

     >>> getattr(p, 'x')
     11

To convert a dictionary to a named tuple, use the double-star-operator
(as described in *note Unpacking Argument Lists: 118f.):

     >>> d = {'x': 11, 'y': 22}
     >>> Point(**d)
     Point(x=11, y=22)

Since a named tuple is a regular Python class, it is easy to add or
change functionality with a subclass.  Here is how to add a calculated
field and a fixed-width print format:

     >>> class Point(namedtuple('Point', ['x', 'y'])):
     ...     __slots__ = ()
     ...     @property
     ...     def hypot(self):
     ...         return (self.x ** 2 + self.y ** 2) ** 0.5
     ...     def __str__(self):
     ...         return 'Point: x=%6.3f  y=%6.3f  hypot=%6.3f' % (self.x, self.y, self.hypot)

     >>> for p in Point(3, 4), Point(14, 5/7):
     ...     print(p)
     Point: x= 3.000  y= 4.000  hypot= 5.000
     Point: x=14.000  y= 0.714  hypot=14.018

The subclass shown above sets ‘__slots__’ to an empty tuple.  This helps
keep memory requirements low by preventing the creation of instance
dictionaries.

Subclassing is not useful for adding new, stored fields.  Instead,
simply create a new named tuple type from the *note _fields: 187a.
attribute:

     >>> Point3D = namedtuple('Point3D', Point._fields + ('z',))

Docstrings can be customized by making direct assignments to the
‘__doc__’ fields:

     >>> Book = namedtuple('Book', ['id', 'title', 'authors'])
     >>> Book.__doc__ += ': Hardcover book in active collection'
     >>> Book.id.__doc__ = '13-digit ISBN'
     >>> Book.title.__doc__ = 'Title of first printing'
     >>> Book.authors.__doc__ = 'List of authors sorted by last name'

Changed in version 3.5: Property docstrings became writeable.

See also
........

   * See *note typing.NamedTuple: 27e. for a way to add type hints for
     named tuples.  It also provides an elegant notation using the *note
     class: c5d. keyword:

          class Component(NamedTuple):
              part_number: int
              weight: float
              description: Optional[str] = None

   * See *note types.SimpleNamespace(): 9a0. for a mutable namespace
     based on an underlying dictionary instead of a tuple.

   * The *note dataclasses: 30. module provides a decorator and
     functions for automatically adding generated special methods to
     user-defined classes.


File: python.info,  Node: OrderedDict objects,  Next: UserDict objects,  Prev: namedtuple Factory Function for Tuples with Named Fields,  Up: collections — Container datatypes

5.8.3.9 ‘OrderedDict’ objects
.............................

Ordered dictionaries are just like regular dictionaries but have some
extra capabilities relating to ordering operations.  They have become
less important now that the built-in *note dict: 1b6. class gained the
ability to remember insertion order (this new behavior became guaranteed
in Python 3.7).

Some differences from *note dict: 1b6. still remain:

   * The regular *note dict: 1b6. was designed to be very good at
     mapping operations.  Tracking insertion order was secondary.

   * The *note OrderedDict: 1b7. was designed to be good at reordering
     operations.  Space efficiency, iteration speed, and the performance
     of update operations were secondary.

   * Algorithmically, *note OrderedDict: 1b7. can handle frequent
     reordering operations better than *note dict: 1b6.  This makes it
     suitable for tracking recent accesses (for example in an LRU
     cache(1)).

   * The equality operation for *note OrderedDict: 1b7. checks for
     matching order.

   * The ‘popitem()’ method of *note OrderedDict: 1b7. has a different
     signature.  It accepts an optional argument to specify which item
     is popped.

   * *note OrderedDict: 1b7. has a ‘move_to_end()’ method to efficiently
     reposition an element to an endpoint.

   * Until Python 3.8, *note dict: 1b6. lacked a *note __reversed__():
     524. method.

 -- Class: collections.OrderedDict ([items])

     Return an instance of a *note dict: 1b6. subclass that has methods
     specialized for rearranging dictionary order.

     New in version 3.1.

      -- Method: popitem (last=True)

          The *note popitem(): c77. method for ordered dictionaries
          returns and removes a (key, value) pair.  The pairs are
          returned in LIFO order if `last' is true or FIFO order if
          false.

      -- Method: move_to_end (key, last=True)

          Move an existing `key' to either end of an ordered dictionary.
          The item is moved to the right end if `last' is true (the
          default) or to the beginning if `last' is false.  Raises *note
          KeyError: 2c5. if the `key' does not exist:

               >>> d = OrderedDict.fromkeys('abcde')
               >>> d.move_to_end('b')
               >>> ''.join(d.keys())
               'acdeb'
               >>> d.move_to_end('b', last=False)
               >>> ''.join(d.keys())
               'bacde'

          New in version 3.2.

In addition to the usual mapping methods, ordered dictionaries also
support reverse iteration using *note reversed(): 18e.

Equality tests between *note OrderedDict: 1b7. objects are
order-sensitive and are implemented as
‘list(od1.items())==list(od2.items())’.  Equality tests between *note
OrderedDict: 1b7. objects and other *note Mapping: 187d. objects are
order-insensitive like regular dictionaries.  This allows *note
OrderedDict: 1b7. objects to be substituted anywhere a regular
dictionary is used.

Changed in version 3.5: The items, keys, and values *note views: 187e.
of *note OrderedDict: 1b7. now support reverse iteration using *note
reversed(): 18e.

Changed in version 3.6: With the acceptance of PEP 468(2), order is
retained for keyword arguments passed to the *note OrderedDict: 1b7.
constructor and its ‘update()’ method.

* Menu:

* OrderedDict Examples and Recipes::

   ---------- Footnotes ----------

   (1) 
https://medium.com/@krishankantsinghal/my-first-blog-on-medium-583159139237

   (2) https://www.python.org/dev/peps/pep-0468


File: python.info,  Node: OrderedDict Examples and Recipes,  Up: OrderedDict objects

5.8.3.10 ‘OrderedDict’ Examples and Recipes
...........................................

It is straightforward to create an ordered dictionary variant that
remembers the order the keys were `last' inserted.  If a new entry
overwrites an existing entry, the original insertion position is changed
and moved to the end:

     class LastUpdatedOrderedDict(OrderedDict):
         'Store items in the order the keys were last added'

         def __setitem__(self, key, value):
             super().__setitem__(key, value)
             self.move_to_end(key)

An *note OrderedDict: 1b7. would also be useful for implementing
variants of *note functools.lru_cache(): 1c5.:

     class LRU(OrderedDict):
         'Limit size, evicting the least recently looked-up key when full'

         def __init__(self, maxsize=128, /, *args, **kwds):
             self.maxsize = maxsize
             super().__init__(*args, **kwds)

         def __getitem__(self, key):
             value = super().__getitem__(key)
             self.move_to_end(key)
             return value

         def __setitem__(self, key, value):
             super().__setitem__(key, value)
             if len(self) > self.maxsize:
                 oldest = next(iter(self))
                 del self[oldest]


File: python.info,  Node: UserDict objects,  Next: UserList objects,  Prev: OrderedDict objects,  Up: collections — Container datatypes

5.8.3.11 ‘UserDict’ objects
...........................

The class, *note UserDict: 185e. acts as a wrapper around dictionary
objects.  The need for this class has been partially supplanted by the
ability to subclass directly from *note dict: 1b6.; however, this class
can be easier to work with because the underlying dictionary is
accessible as an attribute.

 -- Class: collections.UserDict ([initialdata])

     Class that simulates a dictionary.  The instance’s contents are
     kept in a regular dictionary, which is accessible via the *note
     data: 1881. attribute of *note UserDict: 185e. instances.  If
     `initialdata' is provided, *note data: 1881. is initialized with
     its contents; note that a reference to `initialdata' will not be
     kept, allowing it be used for other purposes.

     In addition to supporting the methods and operations of mappings,
     *note UserDict: 185e. instances provide the following attribute:

      -- Attribute: data

          A real dictionary used to store the contents of the *note
          UserDict: 185e. class.


File: python.info,  Node: UserList objects,  Next: UserString objects,  Prev: UserDict objects,  Up: collections — Container datatypes

5.8.3.12 ‘UserList’ objects
...........................

This class acts as a wrapper around list objects.  It is a useful base
class for your own list-like classes which can inherit from them and
override existing methods or add new ones.  In this way, one can add new
behaviors to lists.

The need for this class has been partially supplanted by the ability to
subclass directly from *note list: 260.; however, this class can be
easier to work with because the underlying list is accessible as an
attribute.

 -- Class: collections.UserList ([list])

     Class that simulates a list.  The instance’s contents are kept in a
     regular list, which is accessible via the *note data: 1883.
     attribute of *note UserList: 185f. instances.  The instance’s
     contents are initially set to a copy of `list', defaulting to the
     empty list ‘[]’.  `list' can be any iterable, for example a real
     Python list or a *note UserList: 185f. object.

     In addition to supporting the methods and operations of mutable
     sequences, *note UserList: 185f. instances provide the following
     attribute:

      -- Attribute: data

          A real *note list: 260. object used to store the contents of
          the *note UserList: 185f. class.

`Subclassing requirements:' Subclasses of *note UserList: 185f. are
expected to offer a constructor which can be called with either no
arguments or one argument.  List operations which return a new sequence
attempt to create an instance of the actual implementation class.  To do
so, it assumes that the constructor can be called with a single
parameter, which is a sequence object used as a data source.

If a derived class does not wish to comply with this requirement, all of
the special methods supported by this class will need to be overridden;
please consult the sources for information about the methods which need
to be provided in that case.


File: python.info,  Node: UserString objects,  Prev: UserList objects,  Up: collections — Container datatypes

5.8.3.13 ‘UserString’ objects
.............................

The class, *note UserString: 6a1. acts as a wrapper around string
objects.  The need for this class has been partially supplanted by the
ability to subclass directly from *note str: 325.; however, this class
can be easier to work with because the underlying string is accessible
as an attribute.

 -- Class: collections.UserString (seq)

     Class that simulates a string object.  The instance’s content is
     kept in a regular string object, which is accessible via the *note
     data: 1885. attribute of *note UserString: 6a1. instances.  The
     instance’s contents are initially set to a copy of `seq'.  The
     `seq' argument can be any object which can be converted into a
     string using the built-in *note str(): 325. function.

     In addition to supporting the methods and operations of strings,
     *note UserString: 6a1. instances provide the following attribute:

      -- Attribute: data

          A real *note str: 325. object used to store the contents of
          the *note UserString: 6a1. class.

     Changed in version 3.5: New methods ‘__getnewargs__’, ‘__rmod__’,
     ‘casefold’, ‘format_map’, ‘isprintable’, and ‘maketrans’.


File: python.info,  Node: collections abc — Abstract Base Classes for Containers,  Next: heapq — Heap queue algorithm,  Prev: collections — Container datatypes,  Up: Data Types

5.8.4 ‘collections.abc’ — Abstract Base Classes for Containers
--------------------------------------------------------------

New in version 3.3: Formerly, this module was part of the *note
collections: 1e. module.

`Source code:' Lib/_collections_abc.py(1)

__________________________________________________________________

This module provides *note abstract base classes: b26. that can be used
to test whether a class provides a particular interface; for example,
whether it is hashable or whether it is a mapping.

* Menu:

* Collections Abstract Base Classes::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/_collections_abc.py


File: python.info,  Node: Collections Abstract Base Classes,  Up: collections abc — Abstract Base Classes for Containers

5.8.4.1 Collections Abstract Base Classes
.........................................

The collections module offers the following *note ABCs: b26.:

ABC                            Inherits from              Abstract Methods            Mixin Methods
                                                                                      
-----------------------------------------------------------------------------------------------------------------------------------------------
                                                                                      
*note Container: 1889.                                    ‘__contains__’
                                                          
                                                                                      
*note Hashable: 188a.                                     ‘__hash__’
                                                          
                                                                                      
*note Iterable: 188b.                                     ‘__iter__’
                                                          
                                                                                      
*note Iterator: 188c.          *note Iterable: 188b.      ‘__next__’                  ‘__iter__’
                                                                                      
                                                                                      
*note Reversible: 523.         *note Iterable: 188b.      ‘__reversed__’
                                                          
                                                                                      
*note Generator: 6a9.          *note Iterator: 188c.      ‘send’, ‘throw’             ‘close’, ‘__iter__’, ‘__next__’
                                                                                      
                                                                                      
*note Sized: 188d.                                        ‘__len__’
                                                          
                                                                                      
*note Callable: 188e.                                     ‘__call__’
                                                          
                                                                                      
*note Collection: 522.         *note Sized: 188d,         ‘__contains__’,
                               *note Iterable: 188b,      ‘__iter__’, ‘__len__’
                               *note Container: 1889.     
                               
                                                                                      
*note Sequence: 156b.          *note Reversible: 523,     ‘__getitem__’, ‘__len__’    ‘__contains__’, ‘__iter__’, ‘__reversed__’, ‘index’,
                               *note Collection: 522.                                 and ‘count’
                                                                                      
                                                                                      
*note MutableSequence: 6a0.    *note Sequence: 156b.      ‘__getitem__’,              Inherited *note Sequence: 156b. methods and ‘append’,
                                                          ‘__setitem__’,              ‘reverse’, ‘extend’, ‘pop’, ‘remove’, and ‘__iadd__’
                                                          ‘__delitem__’, ‘__len__’,   
                                                          ‘insert’
                                                          
                                                                                      
*note ByteString: 188f.        *note Sequence: 156b.      ‘__getitem__’, ‘__len__’    Inherited *note Sequence: 156b. methods
                                                                                      
                                                                                      
*note Set: 1616.               *note Collection: 522.     ‘__contains__’,             ‘__le__’, ‘__lt__’, ‘__eq__’, ‘__ne__’, ‘__gt__’,
                                                          ‘__iter__’, ‘__len__’       ‘__ge__’, ‘__and__’, ‘__or__’, ‘__sub__’, ‘__xor__’,
                                                                                      and ‘isdisjoint’
                                                                                      
                                                                                      
*note MutableSet: 1890.        *note Set: 1616.           ‘__contains__’,             Inherited *note Set: 1616. methods and ‘clear’, ‘pop’,
                                                          ‘__iter__’, ‘__len__’,      ‘remove’, ‘__ior__’, ‘__iand__’, ‘__ixor__’, and
                                                          ‘add’, ‘discard’            ‘__isub__’
                                                                                      
                                                                                      
*note Mapping: 187d.           *note Collection: 522.     ‘__getitem__’,              ‘__contains__’, ‘keys’, ‘items’, ‘values’, ‘get’,
                                                          ‘__iter__’, ‘__len__’       ‘__eq__’, and ‘__ne__’
                                                                                      
                                                                                      
*note MutableMapping: 9e3.     *note Mapping: 187d.       ‘__getitem__’,              Inherited *note Mapping: 187d. methods and ‘pop’,
                                                          ‘__setitem__’,              ‘popitem’, ‘clear’, ‘update’, and ‘setdefault’
                                                          ‘__delitem__’,              
                                                          ‘__iter__’, ‘__len__’
                                                          
                                                                                      
*note MappingView: 1891.       *note Sized: 188d.                                     ‘__len__’
                                                                                      
                                                                                      
*note ItemsView: 1892.         *note MappingView: 1891,                               ‘__contains__’, ‘__iter__’
                               *note Set: 1616.                                       
                               
                                                                                      
*note KeysView: 1893.          *note MappingView: 1891,                               ‘__contains__’, ‘__iter__’
                               *note Set: 1616.                                       
                               
                                                                                      
*note ValuesView: 1894.        *note MappingView: 1891,                               ‘__contains__’, ‘__iter__’
                               *note Collection: 522.                                 
                               
                                                                                      
*note Awaitable: 6aa.                                     ‘__await__’
                                                          
                                                                                      
*note Coroutine: 6ab.          *note Awaitable: 6aa.      ‘send’, ‘throw’             ‘close’
                                                                                      
                                                                                      
*note AsyncIterable: 6ad.                                 ‘__aiter__’
                                                          
                                                                                      
*note AsyncIterator: 6ac.      *note AsyncIterable: 6ad.  ‘__anext__’                 ‘__aiter__’
                                                                                      
                                                                                      
*note AsyncGenerator: 525.     *note AsyncIterator: 6ac.  ‘asend’, ‘athrow’           ‘aclose’, ‘__aiter__’, ‘__anext__’
                                                                                      

 -- Class: collections.abc.Container
 -- Class: collections.abc.Hashable
 -- Class: collections.abc.Sized
 -- Class: collections.abc.Callable

     ABCs for classes that provide respectively the methods *note
     __contains__(): d1b, *note __hash__(): 335, *note __len__(): dbe,
     and *note __call__(): 1369.

 -- Class: collections.abc.Iterable

     ABC for classes that provide the *note __iter__(): 504. method.

     Checking ‘isinstance(obj, Iterable)’ detects classes that are
     registered as *note Iterable: 188b. or that have an *note
     __iter__(): 504. method, but it does not detect classes that
     iterate with the *note __getitem__(): 27a. method.  The only
     reliable way to determine whether an object is *note iterable: b9f.
     is to call ‘iter(obj)’.

 -- Class: collections.abc.Collection

     ABC for sized iterable container classes.

     New in version 3.6.

 -- Class: collections.abc.Iterator

     ABC for classes that provide the *note __iter__(): 1565. and *note
     __next__(): c57. methods.  See also the definition of *note
     iterator: f73.

 -- Class: collections.abc.Reversible

     ABC for iterable classes that also provide the *note
     __reversed__(): 524. method.

     New in version 3.6.

 -- Class: collections.abc.Generator

     ABC for generator classes that implement the protocol defined in
     PEP 342(1) that extends iterators with the *note send(): 13cb,
     *note throw(): 13cd. and *note close(): 13cf. methods.  See also
     the definition of *note generator: 996.

     New in version 3.5.

 -- Class: collections.abc.Sequence
 -- Class: collections.abc.MutableSequence
 -- Class: collections.abc.ByteString

     ABCs for read-only and mutable *note sequences: 1162.

     Implementation note: Some of the mixin methods, such as *note
     __iter__(): 504, *note __reversed__(): 524. and ‘index()’, make
     repeated calls to the underlying *note __getitem__(): 27a. method.
     Consequently, if *note __getitem__(): 27a. is implemented with
     constant access speed, the mixin methods will have linear
     performance; however, if the underlying method is linear (as it
     would be with a linked list), the mixins will have quadratic
     performance and will likely need to be overridden.

     Changed in version 3.5: The index() method added support for `stop'
     and `start' arguments.

 -- Class: collections.abc.Set
 -- Class: collections.abc.MutableSet

     ABCs for read-only and mutable sets.

 -- Class: collections.abc.Mapping
 -- Class: collections.abc.MutableMapping

     ABCs for read-only and mutable *note mappings: b2c.

 -- Class: collections.abc.MappingView
 -- Class: collections.abc.ItemsView
 -- Class: collections.abc.KeysView
 -- Class: collections.abc.ValuesView

     ABCs for mapping, items, keys, and values *note views: 187e.

 -- Class: collections.abc.Awaitable

     ABC for *note awaitable: 50e. objects, which can be used in *note
     await: 1a2. expressions.  Custom implementations must provide the
     *note __await__(): 636. method.

     *note Coroutine: 1a5. objects and instances of the *note Coroutine:
     6ab. ABC are all instances of this ABC.

          Note: In CPython, generator-based coroutines (generators
          decorated with *note types.coroutine(): 770. or *note
          asyncio.coroutine(): 280.) are `awaitables', even though they
          do not have an *note __await__(): 636. method.  Using
          ‘isinstance(gencoro, Awaitable)’ for them will return ‘False’.
          Use *note inspect.isawaitable(): 6ed. to detect them.

     New in version 3.5.

 -- Class: collections.abc.Coroutine

     ABC for coroutine compatible classes.  These implement the
     following methods, defined in *note Coroutine Objects: 1368.: *note
     send(): 13ca, *note throw(): 13cc, and *note close(): 13ce.  Custom
     implementations must also implement *note __await__(): 636.  All
     *note Coroutine: 6ab. instances are also instances of *note
     Awaitable: 6aa.  See also the definition of *note coroutine: 1a5.

          Note: In CPython, generator-based coroutines (generators
          decorated with *note types.coroutine(): 770. or *note
          asyncio.coroutine(): 280.) are `awaitables', even though they
          do not have an *note __await__(): 636. method.  Using
          ‘isinstance(gencoro, Coroutine)’ for them will return ‘False’.
          Use *note inspect.isawaitable(): 6ed. to detect them.

     New in version 3.5.

 -- Class: collections.abc.AsyncIterable

     ABC for classes that provide ‘__aiter__’ method.  See also the
     definition of *note asynchronous iterable: 634.

     New in version 3.5.

 -- Class: collections.abc.AsyncIterator

     ABC for classes that provide ‘__aiter__’ and ‘__anext__’ methods.
     See also the definition of *note asynchronous iterator: 639.

     New in version 3.5.

 -- Class: collections.abc.AsyncGenerator

     ABC for asynchronous generator classes that implement the protocol
     defined in PEP 525(2) and PEP 492(3).

     New in version 3.6.

These ABCs allow us to ask classes or instances if they provide
particular functionality, for example:

     size = None
     if isinstance(myvar, collections.abc.Sized):
         size = len(myvar)

Several of the ABCs are also useful as mixins that make it easier to
develop classes supporting container APIs.  For example, to write a
class supporting the full *note Set: 1616. API, it is only necessary to
supply the three underlying abstract methods: *note __contains__(): d1b,
*note __iter__(): 504, and *note __len__(): dbe.  The ABC supplies the
remaining methods such as *note __and__(): 13a2. and ‘isdisjoint()’:

     class ListBasedSet(collections.abc.Set):
         ''' Alternate set implementation favoring space over speed
             and not requiring the set elements to be hashable. '''
         def __init__(self, iterable):
             self.elements = lst = []
             for value in iterable:
                 if value not in lst:
                     lst.append(value)

         def __iter__(self):
             return iter(self.elements)

         def __contains__(self, value):
             return value in self.elements

         def __len__(self):
             return len(self.elements)

     s1 = ListBasedSet('abcdef')
     s2 = ListBasedSet('defghi')
     overlap = s1 & s2            # The __and__() method is supported automatically

Notes on using *note Set: 1616. and *note MutableSet: 1890. as a mixin:

  1. Since some set operations create new sets, the default mixin
     methods need a way to create new instances from an iterable.  The
     class constructor is assumed to have a signature in the form
     ‘ClassName(iterable)’.  That assumption is factored-out to an
     internal classmethod called ‘_from_iterable()’ which calls
     ‘cls(iterable)’ to produce a new set.  If the *note Set: 1616.
     mixin is being used in a class with a different constructor
     signature, you will need to override ‘_from_iterable()’ with a
     classmethod that can construct new instances from an iterable
     argument.

  2. To override the comparisons (presumably for speed, as the semantics
     are fixed), redefine *note __le__(): c93. and *note __ge__(): c95,
     then the other operations will automatically follow suit.

  3. The *note Set: 1616. mixin provides a ‘_hash()’ method to compute a
     hash value for the set; however, *note __hash__(): 335. is not
     defined because not all sets are hashable or immutable.  To add set
     hashability using mixins, inherit from both *note Set(): 1616. and
     *note Hashable(): 188a, then define ‘__hash__ = Set._hash’.

See also
........

   * OrderedSet recipe(4) for an example built on *note MutableSet:
     1890.

   * For more about ABCs, see the *note abc: 4. module and PEP 3119(5).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0342

   (2) https://www.python.org/dev/peps/pep-0525

   (3) https://www.python.org/dev/peps/pep-0492

   (4) https://code.activestate.com/recipes/576694/

   (5) https://www.python.org/dev/peps/pep-3119


File: python.info,  Node: heapq — Heap queue algorithm,  Next: bisect — Array bisection algorithm,  Prev: collections abc — Abstract Base Classes for Containers,  Up: Data Types

5.8.5 ‘heapq’ — Heap queue algorithm
------------------------------------

`Source code:' Lib/heapq.py(1)

__________________________________________________________________

This module provides an implementation of the heap queue algorithm, also
known as the priority queue algorithm.

Heaps are binary trees for which every parent node has a value less than
or equal to any of its children.  This implementation uses arrays for
which ‘heap[k] <= heap[2*k+1]’ and ‘heap[k] <= heap[2*k+2]’ for all `k',
counting elements from zero.  For the sake of comparison, non-existing
elements are considered to be infinite.  The interesting property of a
heap is that its smallest element is always the root, ‘heap[0]’.

The API below differs from textbook heap algorithms in two aspects: (a)
We use zero-based indexing.  This makes the relationship between the
index for a node and the indexes for its children slightly less obvious,
but is more suitable since Python uses zero-based indexing.  (b) Our pop
method returns the smallest item, not the largest (called a “min heap”
in textbooks; a “max heap” is more common in texts because of its
suitability for in-place sorting).

These two make it possible to view the heap as a regular Python list
without surprises: ‘heap[0]’ is the smallest item, and ‘heap.sort()’
maintains the heap invariant!

To create a heap, use a list initialized to ‘[]’, or you can transform a
populated list into a heap via function *note heapify(): 1897.

The following functions are provided:

 -- Function: heapq.heappush (heap, item)

     Push the value `item' onto the `heap', maintaining the heap
     invariant.

 -- Function: heapq.heappop (heap)

     Pop and return the smallest item from the `heap', maintaining the
     heap invariant.  If the heap is empty, *note IndexError: e69. is
     raised.  To access the smallest item without popping it, use
     ‘heap[0]’.

 -- Function: heapq.heappushpop (heap, item)

     Push `item' on the heap, then pop and return the smallest item from
     the `heap'.  The combined action runs more efficiently than *note
     heappush(): 1898. followed by a separate call to *note heappop():
     1899.

 -- Function: heapq.heapify (x)

     Transform list `x' into a heap, in-place, in linear time.

 -- Function: heapq.heapreplace (heap, item)

     Pop and return the smallest item from the `heap', and also push the
     new `item'.  The heap size doesn’t change.  If the heap is empty,
     *note IndexError: e69. is raised.

     This one step operation is more efficient than a *note heappop():
     1899. followed by *note heappush(): 1898. and can be more
     appropriate when using a fixed-size heap.  The pop/push combination
     always returns an element from the heap and replaces it with
     `item'.

     The value returned may be larger than the `item' added.  If that
     isn’t desired, consider using *note heappushpop(): 189a. instead.
     Its push/pop combination returns the smaller of the two values,
     leaving the larger value on the heap.

The module also offers three general purpose functions based on heaps.

 -- Function: heapq.merge (*iterables, key=None, reverse=False)

     Merge multiple sorted inputs into a single sorted output (for
     example, merge timestamped entries from multiple log files).
     Returns an *note iterator: f73. over the sorted values.

     Similar to ‘sorted(itertools.chain(*iterables))’ but returns an
     iterable, does not pull the data into memory all at once, and
     assumes that each of the input streams is already sorted (smallest
     to largest).

     Has two optional arguments which must be specified as keyword
     arguments.

     `key' specifies a *note key function: 6d4. of one argument that is
     used to extract a comparison key from each input element.  The
     default value is ‘None’ (compare the elements directly).

     `reverse' is a boolean value.  If set to ‘True’, then the input
     elements are merged as if each comparison were reversed.  To
     achieve behavior similar to ‘sorted(itertools.chain(*iterables),
     reverse=True)’, all iterables must be sorted from largest to
     smallest.

     Changed in version 3.5: Added the optional `key' and `reverse'
     parameters.

 -- Function: heapq.nlargest (n, iterable, key=None)

     Return a list with the `n' largest elements from the dataset
     defined by `iterable'.  `key', if provided, specifies a function of
     one argument that is used to extract a comparison key from each
     element in `iterable' (for example, ‘key=str.lower’).  Equivalent
     to: ‘sorted(iterable, key=key, reverse=True)[:n]’.

 -- Function: heapq.nsmallest (n, iterable, key=None)

     Return a list with the `n' smallest elements from the dataset
     defined by `iterable'.  `key', if provided, specifies a function of
     one argument that is used to extract a comparison key from each
     element in `iterable' (for example, ‘key=str.lower’).  Equivalent
     to: ‘sorted(iterable, key=key)[:n]’.

The latter two functions perform best for smaller values of `n'.  For
larger values, it is more efficient to use the *note sorted(): 439.
function.  Also, when ‘n==1’, it is more efficient to use the built-in
*note min(): 7fd. and *note max(): 7fe. functions.  If repeated usage of
these functions is required, consider turning the iterable into an
actual heap.

* Menu:

* Basic Examples::
* Priority Queue Implementation Notes::
* Theory::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/heapq.py


File: python.info,  Node: Basic Examples,  Next: Priority Queue Implementation Notes,  Up: heapq — Heap queue algorithm

5.8.5.1 Basic Examples
......................

A heapsort(1) can be implemented by pushing all values onto a heap and
then popping off the smallest values one at a time:

     >>> def heapsort(iterable):
     ...     h = []
     ...     for value in iterable:
     ...         heappush(h, value)
     ...     return [heappop(h) for i in range(len(h))]
     ...
     >>> heapsort([1, 3, 5, 7, 9, 2, 4, 6, 8, 0])
     [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

This is similar to ‘sorted(iterable)’, but unlike *note sorted(): 439,
this implementation is not stable.

Heap elements can be tuples.  This is useful for assigning comparison
values (such as task priorities) alongside the main record being
tracked:

     >>> h = []
     >>> heappush(h, (5, 'write code'))
     >>> heappush(h, (7, 'release product'))
     >>> heappush(h, (1, 'write spec'))
     >>> heappush(h, (3, 'create tests'))
     >>> heappop(h)
     (1, 'write spec')

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Heapsort


File: python.info,  Node: Priority Queue Implementation Notes,  Next: Theory,  Prev: Basic Examples,  Up: heapq — Heap queue algorithm

5.8.5.2 Priority Queue Implementation Notes
...........................................

A priority queue(1) is common use for a heap, and it presents several
implementation challenges:

   * Sort stability: how do you get two tasks with equal priorities to
     be returned in the order they were originally added?

   * Tuple comparison breaks for (priority, task) pairs if the
     priorities are equal and the tasks do not have a default comparison
     order.

   * If the priority of a task changes, how do you move it to a new
     position in the heap?

   * Or if a pending task needs to be deleted, how do you find it and
     remove it from the queue?

A solution to the first two challenges is to store entries as 3-element
list including the priority, an entry count, and the task.  The entry
count serves as a tie-breaker so that two tasks with the same priority
are returned in the order they were added.  And since no two entry
counts are the same, the tuple comparison will never attempt to directly
compare two tasks.

Another solution to the problem of non-comparable tasks is to create a
wrapper class that ignores the task item and only compares the priority
field:

     from dataclasses import dataclass, field
     from typing import Any

     @dataclass(order=True)
     class PrioritizedItem:
         priority: int
         item: Any=field(compare=False)

The remaining challenges revolve around finding a pending task and
making changes to its priority or removing it entirely.  Finding a task
can be done with a dictionary pointing to an entry in the queue.

Removing the entry or changing its priority is more difficult because it
would break the heap structure invariants.  So, a possible solution is
to mark the entry as removed and add a new entry with the revised
priority:

     pq = []                         # list of entries arranged in a heap
     entry_finder = {}               # mapping of tasks to entries
     REMOVED = '<removed-task>'      # placeholder for a removed task
     counter = itertools.count()     # unique sequence count

     def add_task(task, priority=0):
         'Add a new task or update the priority of an existing task'
         if task in entry_finder:
             remove_task(task)
         count = next(counter)
         entry = [priority, count, task]
         entry_finder[task] = entry
         heappush(pq, entry)

     def remove_task(task):
         'Mark an existing task as REMOVED.  Raise KeyError if not found.'
         entry = entry_finder.pop(task)
         entry[-1] = REMOVED

     def pop_task():
         'Remove and return the lowest priority task. Raise KeyError if empty.'
         while pq:
             priority, count, task = heappop(pq)
             if task is not REMOVED:
                 del entry_finder[task]
                 return task
         raise KeyError('pop from an empty priority queue')

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Priority_queue


File: python.info,  Node: Theory,  Prev: Priority Queue Implementation Notes,  Up: heapq — Heap queue algorithm

5.8.5.3 Theory
..............

Heaps are arrays for which ‘a[k] <= a[2*k+1]’ and ‘a[k] <= a[2*k+2]’ for
all `k', counting elements from 0.  For the sake of comparison,
non-existing elements are considered to be infinite.  The interesting
property of a heap is that ‘a[0]’ is always its smallest element.

The strange invariant above is meant to be an efficient memory
representation for a tournament.  The numbers below are `k', not ‘a[k]’:

                                    0

                   1                                 2

           3               4                5               6

       7       8       9       10      11      12      13      14

     15 16   17 18   19 20   21 22   23 24   25 26   27 28   29 30

In the tree above, each cell `k' is topping ‘2*k+1’ and ‘2*k+2’.  In a
usual binary tournament we see in sports, each cell is the winner over
the two cells it tops, and we can trace the winner down the tree to see
all opponents s/he had.  However, in many computer applications of such
tournaments, we do not need to trace the history of a winner.  To be
more memory efficient, when a winner is promoted, we try to replace it
by something else at a lower level, and the rule becomes that a cell and
the two cells it tops contain three different items, but the top cell
“wins” over the two topped cells.

If this heap invariant is protected at all time, index 0 is clearly the
overall winner.  The simplest algorithmic way to remove it and find the
“next” winner is to move some loser (let’s say cell 30 in the diagram
above) into the 0 position, and then percolate this new 0 down the tree,
exchanging values, until the invariant is re-established.  This is
clearly logarithmic on the total number of items in the tree.  By
iterating over all items, you get an O(n log n) sort.

A nice feature of this sort is that you can efficiently insert new items
while the sort is going on, provided that the inserted items are not
“better” than the last 0’th element you extracted.  This is especially
useful in simulation contexts, where the tree holds all incoming events,
and the “win” condition means the smallest scheduled time.  When an
event schedules other events for execution, they are scheduled into the
future, so they can easily go into the heap.  So, a heap is a good
structure for implementing schedulers (this is what I used for my MIDI
sequencer :-).

Various structures for implementing schedulers have been extensively
studied, and heaps are good for this, as they are reasonably speedy, the
speed is almost constant, and the worst case is not much different than
the average case.  However, there are other representations which are
more efficient overall, yet the worst cases might be terrible.

Heaps are also very useful in big disk sorts.  You most probably all
know that a big sort implies producing “runs” (which are pre-sorted
sequences, whose size is usually related to the amount of CPU memory),
followed by a merging passes for these runs, which merging is often very
cleverly organised (1).  It is very important that the initial sort
produces the longest runs possible.  Tournaments are a good way to
achieve that.  If, using all the memory available to hold a tournament,
you replace and percolate items that happen to fit the current run,
you’ll produce runs which are twice the size of the memory for random
input, and much better for input fuzzily ordered.

Moreover, if you output the 0’th item on disk and get an input which may
not fit in the current tournament (because the value “wins” over the
last output value), it cannot fit in the heap, so the size of the heap
decreases.  The freed memory could be cleverly reused immediately for
progressively building a second heap, which grows at exactly the same
rate the first heap is melting.  When the first heap completely
vanishes, you switch heaps and start a new run.  Clever and quite
effective!

In a word, heaps are useful memory structures to know.  I use them in a
few applications, and I think it is good to keep a ‘heap’ module around.
:-)

   ---------- Footnotes ----------

   (1) (1) The disk balancing algorithms which are current, nowadays,
are more annoying than clever, and this is a consequence of the seeking
capabilities of the disks.  On devices which cannot seek, like big tape
drives, the story was quite different, and one had to be very clever to
ensure (far in advance) that each tape movement will be the most
effective possible (that is, will best participate at “progressing” the
merge).  Some tapes were even able to read backwards, and this was also
used to avoid the rewinding time.  Believe me, real good tape sorts were
quite spectacular to watch!  From all times, sorting has always been a
Great Art!  :-)


File: python.info,  Node: bisect — Array bisection algorithm,  Next: array — Efficient arrays of numeric values,  Prev: heapq — Heap queue algorithm,  Up: Data Types

5.8.6 ‘bisect’ — Array bisection algorithm
------------------------------------------

`Source code:' Lib/bisect.py(1)

__________________________________________________________________

This module provides support for maintaining a list in sorted order
without having to sort the list after each insertion.  For long lists of
items with expensive comparison operations, this can be an improvement
over the more common approach.  The module is called *note bisect: 12.
because it uses a basic bisection algorithm to do its work.  The source
code may be most useful as a working example of the algorithm (the
boundary conditions are already right!).

The following functions are provided:

 -- Function: bisect.bisect_left (a, x, lo=0, hi=len(a))

     Locate the insertion point for `x' in `a' to maintain sorted order.
     The parameters `lo' and `hi' may be used to specify a subset of the
     list which should be considered; by default the entire list is
     used.  If `x' is already present in `a', the insertion point will
     be before (to the left of) any existing entries.  The return value
     is suitable for use as the first parameter to ‘list.insert()’
     assuming that `a' is already sorted.

     The returned insertion point `i' partitions the array `a' into two
     halves so that ‘all(val < x for val in a[lo:i])’ for the left side
     and ‘all(val >= x for val in a[i:hi])’ for the right side.

 -- Function: bisect.bisect_right (a, x, lo=0, hi=len(a))
 -- Function: bisect.bisect (a, x, lo=0, hi=len(a))

     Similar to *note bisect_left(): 18a3, but returns an insertion
     point which comes after (to the right of) any existing entries of
     `x' in `a'.

     The returned insertion point `i' partitions the array `a' into two
     halves so that ‘all(val <= x for val in a[lo:i])’ for the left side
     and ‘all(val > x for val in a[i:hi])’ for the right side.

 -- Function: bisect.insort_left (a, x, lo=0, hi=len(a))

     Insert `x' in `a' in sorted order.  This is equivalent to
     ‘a.insert(bisect.bisect_left(a, x, lo, hi), x)’ assuming that `a'
     is already sorted.  Keep in mind that the O(log n) search is
     dominated by the slow O(n) insertion step.

 -- Function: bisect.insort_right (a, x, lo=0, hi=len(a))
 -- Function: bisect.insort (a, x, lo=0, hi=len(a))

     Similar to *note insort_left(): 18a6, but inserting `x' in `a'
     after any existing entries of `x'.

See also
........

SortedCollection recipe(2) that uses bisect to build a full-featured
collection class with straight-forward search methods and support for a
key-function.  The keys are precomputed to save unnecessary calls to the
key function during searches.

* Menu:

* Searching Sorted Lists::
* Other Examples::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/bisect.py

   (2) https://code.activestate.com/recipes/577197-sortedcollection/


File: python.info,  Node: Searching Sorted Lists,  Next: Other Examples,  Up: bisect — Array bisection algorithm

5.8.6.1 Searching Sorted Lists
..............................

The above *note bisect(): 12. functions are useful for finding insertion
points but can be tricky or awkward to use for common searching tasks.
The following five functions show how to transform them into the
standard lookups for sorted lists:

     def index(a, x):
         'Locate the leftmost value exactly equal to x'
         i = bisect_left(a, x)
         if i != len(a) and a[i] == x:
             return i
         raise ValueError

     def find_lt(a, x):
         'Find rightmost value less than x'
         i = bisect_left(a, x)
         if i:
             return a[i-1]
         raise ValueError

     def find_le(a, x):
         'Find rightmost value less than or equal to x'
         i = bisect_right(a, x)
         if i:
             return a[i-1]
         raise ValueError

     def find_gt(a, x):
         'Find leftmost value greater than x'
         i = bisect_right(a, x)
         if i != len(a):
             return a[i]
         raise ValueError

     def find_ge(a, x):
         'Find leftmost item greater than or equal to x'
         i = bisect_left(a, x)
         if i != len(a):
             return a[i]
         raise ValueError


File: python.info,  Node: Other Examples,  Prev: Searching Sorted Lists,  Up: bisect — Array bisection algorithm

5.8.6.2 Other Examples
......................

The *note bisect(): 12. function can be useful for numeric table
lookups.  This example uses *note bisect(): 12. to look up a letter
grade for an exam score (say) based on a set of ordered numeric
breakpoints: 90 and up is an ‘A’, 80 to 89 is a ‘B’, and so on:

     >>> def grade(score, breakpoints=[60, 70, 80, 90], grades='FDCBA'):
     ...     i = bisect(breakpoints, score)
     ...     return grades[i]
     ...
     >>> [grade(score) for score in [33, 99, 77, 70, 89, 90, 100]]
     ['F', 'A', 'C', 'C', 'B', 'A', 'A']

Unlike the *note sorted(): 439. function, it does not make sense for the
*note bisect(): 12. functions to have `key' or `reversed' arguments
because that would lead to an inefficient design (successive calls to
bisect functions would not “remember” all of the previous key lookups).

Instead, it is better to search a list of precomputed keys to find the
index of the record in question:

     >>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
     >>> data.sort(key=lambda r: r[1])
     >>> keys = [r[1] for r in data]         # precomputed list of keys
     >>> data[bisect_left(keys, 0)]
     ('black', 0)
     >>> data[bisect_left(keys, 1)]
     ('blue', 1)
     >>> data[bisect_left(keys, 5)]
     ('red', 5)
     >>> data[bisect_left(keys, 8)]
     ('yellow', 8)


File: python.info,  Node: array — Efficient arrays of numeric values,  Next: weakref — Weak references,  Prev: bisect — Array bisection algorithm,  Up: Data Types

5.8.7 ‘array’ — Efficient arrays of numeric values
--------------------------------------------------

__________________________________________________________________

This module defines an object type which can compactly represent an
array of basic values: characters, integers, floating point numbers.
Arrays are sequence types and behave very much like lists, except that
the type of objects stored in them is constrained.  The type is
specified at object creation time by using a `type code', which is a
single character.  The following type codes are defined:

Type code       C Type                   Python Type             Minimum size in bytes       Notes
                                                                                             
---------------------------------------------------------------------------------------------------------
                                                                                             
‘'b'’           signed char              int                     1
                                                                 
                                                                                             
‘'B'’           unsigned char            int                     1
                                                                 
                                                                                             
‘'u'’           Py_UNICODE               Unicode character       2                           (1)
                                                                                             
                                                                                             
‘'h'’           signed short             int                     2
                                                                 
                                                                                             
‘'H'’           unsigned short           int                     2
                                                                 
                                                                                             
‘'i'’           signed int               int                     2
                                                                 
                                                                                             
‘'I'’           unsigned int             int                     2
                                                                 
                                                                                             
‘'l'’           signed long              int                     4
                                                                 
                                                                                             
‘'L'’           unsigned long            int                     4
                                                                 
                                                                                             
‘'q'’           signed long long         int                     8
                                                                 
                                                                                             
‘'Q'’           unsigned long long       int                     8
                                                                 
                                                                                             
‘'f'’           float                    float                   4
                                                                 
                                                                                             
‘'d'’           double                   float                   8
                                                                 

Notes:

  1. The ‘'u'’ type code corresponds to Python’s obsolete unicode
     character (*note Py_UNICODE: ae3. which is ‘wchar_t’).  Depending
     on the platform, it can be 16 bits or 32 bits.

     ‘'u'’ will be removed together with the rest of the *note
     Py_UNICODE: ae3. API.

     Deprecated since version 3.3, will be removed in version 4.0.

The actual representation of values is determined by the machine
architecture (strictly speaking, by the C implementation).  The actual
size can be accessed through the ‘itemsize’ attribute.

The module defines the following type:

 -- Class: array.array (typecode[, initializer])

     A new array whose items are restricted by `typecode', and
     initialized from the optional `initializer' value, which must be a
     list, a *note bytes-like object: 5dd, or iterable over elements of
     the appropriate type.

     If given a list or string, the initializer is passed to the new
     array’s *note fromlist(): 18ae, *note frombytes(): 18af, or *note
     fromunicode(): 18b0. method (see below) to add initial items to the
     array.  Otherwise, the iterable initializer is passed to the *note
     extend(): 18b1. method.

     Raises an *note auditing event: 1275. ‘array.__new__’ with
     arguments ‘typecode’, ‘initializer’.

 -- Data: array.typecodes

     A string with all available type codes.

Array objects support the ordinary sequence operations of indexing,
slicing, concatenation, and multiplication.  When using slice
assignment, the assigned value must be an array object with the same
type code; in all other cases, *note TypeError: 192. is raised.  Array
objects also implement the buffer interface, and may be used wherever
*note bytes-like objects: 5dd. are supported.

The following data items and methods are also supported:

 -- Attribute: array.typecode

     The typecode character used to create the array.

 -- Attribute: array.itemsize

     The length in bytes of one array item in the internal
     representation.

 -- Method: array.append (x)

     Append a new item with value `x' to the end of the array.

 -- Method: array.buffer_info ()

     Return a tuple ‘(address, length)’ giving the current memory
     address and the length in elements of the buffer used to hold
     array’s contents.  The size of the memory buffer in bytes can be
     computed as ‘array.buffer_info()[1] * array.itemsize’.  This is
     occasionally useful when working with low-level (and inherently
     unsafe) I/O interfaces that require memory addresses, such as
     certain ‘ioctl()’ operations.  The returned numbers are valid as
     long as the array exists and no length-changing operations are
     applied to it.

          Note: When using array objects from code written in C or C++
          (the only way to effectively make use of this information), it
          makes more sense to use the buffer interface supported by
          array objects.  This method is maintained for backward
          compatibility and should be avoided in new code.  The buffer
          interface is documented in *note Buffer Protocol: 1579.

 -- Method: array.byteswap ()

     “Byteswap” all items of the array.  This is only supported for
     values which are 1, 2, 4, or 8 bytes in size; for other types of
     values, *note RuntimeError: 2b8. is raised.  It is useful when
     reading data from a file written on a machine with a different byte
     order.

 -- Method: array.count (x)

     Return the number of occurrences of `x' in the array.

 -- Method: array.extend (iterable)

     Append items from `iterable' to the end of the array.  If
     `iterable' is another array, it must have `exactly' the same type
     code; if not, *note TypeError: 192. will be raised.  If `iterable'
     is not an array, it must be iterable and its elements must be the
     right type to be appended to the array.

 -- Method: array.frombytes (s)

     Appends items from the string, interpreting the string as an array
     of machine values (as if it had been read from a file using the
     *note fromfile(): 18b9. method).

     New in version 3.2: *note fromstring(): 18ba. is renamed to *note
     frombytes(): 18af. for clarity.

 -- Method: array.fromfile (f, n)

     Read `n' items (as machine values) from the *note file object: b35.
     `f' and append them to the end of the array.  If less than `n'
     items are available, *note EOFError: c5f. is raised, but the items
     that were available are still inserted into the array.  `f' must be
     a real built-in file object; something else with a ‘read()’ method
     won’t do.

 -- Method: array.fromlist (list)

     Append items from the list.  This is equivalent to ‘for x in list:
     a.append(x)’ except that if there is a type error, the array is
     unchanged.

 -- Method: array.fromstring ()

     Deprecated alias for *note frombytes(): 18af.

     Deprecated since version 3.2, will be removed in version 3.9.

 -- Method: array.fromunicode (s)

     Extends this array with data from the given unicode string.  The
     array must be a type ‘'u'’ array; otherwise a *note ValueError:
     1f9. is raised.  Use ‘array.frombytes(unicodestring.encode(enc))’
     to append Unicode data to an array of some other type.

 -- Method: array.index (x)

     Return the smallest `i' such that `i' is the index of the first
     occurrence of `x' in the array.

 -- Method: array.insert (i, x)

     Insert a new item with value `x' in the array before position `i'.
     Negative values are treated as being relative to the end of the
     array.

 -- Method: array.pop ([i])

     Removes the item with the index `i' from the array and returns it.
     The optional argument defaults to ‘-1’, so that by default the last
     item is removed and returned.

 -- Method: array.remove (x)

     Remove the first occurrence of `x' from the array.

 -- Method: array.reverse ()

     Reverse the order of the items in the array.

 -- Method: array.tobytes ()

     Convert the array to an array of machine values and return the
     bytes representation (the same sequence of bytes that would be
     written to a file by the *note tofile(): 18c1. method.)

     New in version 3.2: *note tostring(): 18c2. is renamed to *note
     tobytes(): 18c0. for clarity.

 -- Method: array.tofile (f)

     Write all items (as machine values) to the *note file object: b35.
     `f'.

 -- Method: array.tolist ()

     Convert the array to an ordinary list with the same items.

 -- Method: array.tostring ()

     Deprecated alias for *note tobytes(): 18c0.

     Deprecated since version 3.2, will be removed in version 3.9.

 -- Method: array.tounicode ()

     Convert the array to a unicode string.  The array must be a type
     ‘'u'’ array; otherwise a *note ValueError: 1f9. is raised.  Use
     ‘array.tobytes().decode(enc)’ to obtain a unicode string from an
     array of some other type.

When an array object is printed or converted to a string, it is
represented as ‘array(typecode, initializer)’.  The `initializer' is
omitted if the array is empty, otherwise it is a string if the
`typecode' is ‘'u'’, otherwise it is a list of numbers.  The string is
guaranteed to be able to be converted back to an array with the same
type and value using *note eval(): b83, so long as the *note array: 446.
class has been imported using ‘from array import array’.  Examples:

     array('l')
     array('u', 'hello \u2641')
     array('l', [1, 2, 3, 4, 5])
     array('d', [1.0, 2.0, 3.14])

See also
........

Module *note struct: f8.

     Packing and unpacking of heterogeneous binary data.

Module *note xdrlib: 132.

     Packing and unpacking of External Data Representation (XDR) data as
     used in some remote procedure call systems.

The Numerical Python Documentation(1)

     The Numeric Python extension (NumPy) defines another array type;
     see ‘http://www.numpy.org/’ for further information about Numerical
     Python.

   ---------- Footnotes ----------

   (1) https://docs.scipy.org/doc/


File: python.info,  Node: weakref — Weak references,  Next: types — Dynamic type creation and names for built-in types,  Prev: array — Efficient arrays of numeric values,  Up: Data Types

5.8.8 ‘weakref’ — Weak references
---------------------------------

`Source code:' Lib/weakref.py(1)

__________________________________________________________________

The *note weakref: 128. module allows the Python programmer to create
`weak references' to objects.

In the following, the term `referent' means the object which is referred
to by a weak reference.

A weak reference to an object is not enough to keep the object alive:
when the only remaining references to a referent are weak references,
*note garbage collection: 1243. is free to destroy the referent and
reuse its memory for something else.  However, until the object is
actually destroyed the weak reference may return the object even if
there are no strong references to it.

A primary use for weak references is to implement caches or mappings
holding large objects, where it’s desired that a large object not be
kept alive solely because it appears in a cache or mapping.

For example, if you have a number of large binary image objects, you may
wish to associate a name with each.  If you used a Python dictionary to
map names to images, or images to names, the image objects would remain
alive just because they appeared as values or keys in the dictionaries.
The *note WeakKeyDictionary: 18c7. and *note WeakValueDictionary: 18c8.
classes supplied by the *note weakref: 128. module are an alternative,
using weak references to construct mappings that don’t keep objects
alive solely because they appear in the mapping objects.  If, for
example, an image object is a value in a *note WeakValueDictionary:
18c8, then when the last remaining references to that image object are
the weak references held by weak mappings, garbage collection can
reclaim the object, and its corresponding entries in weak mappings are
simply deleted.

*note WeakKeyDictionary: 18c7. and *note WeakValueDictionary: 18c8. use
weak references in their implementation, setting up callback functions
on the weak references that notify the weak dictionaries when a key or
value has been reclaimed by garbage collection.  *note WeakSet: cab.
implements the *note set: b62. interface, but keeps weak references to
its elements, just like a *note WeakKeyDictionary: 18c7. does.

*note finalize: 29b. provides a straight forward way to register a
cleanup function to be called when an object is garbage collected.  This
is simpler to use than setting up a callback function on a raw weak
reference, since the module automatically ensures that the finalizer
remains alive until the object is collected.

Most programs should find that using one of these weak container types
or *note finalize: 29b. is all they need – it’s not usually necessary to
create your own weak references directly.  The low-level machinery is
exposed by the *note weakref: 128. module for the benefit of advanced
uses.

Not all objects can be weakly referenced; those objects which can
include class instances, functions written in Python (but not in C),
instance methods, sets, frozensets, some *note file objects: b35, *note
generators: 996, type objects, sockets, arrays, deques, regular
expression pattern objects, and code objects.

Changed in version 3.2: Added support for thread.lock, threading.Lock,
and code objects.

Several built-in types such as *note list: 260. and *note dict: 1b6. do
not directly support weak references but can add support through
subclassing:

     class Dict(dict):
         pass

     obj = Dict(red=1, green=2, blue=3)   # this object is weak referenceable

`CPython implementation detail:' Other built-in types such as *note
tuple: 473. and *note int: 184. do not support weak references even when
subclassed.

Extension types can easily be made to support weak references; see *note
Weak Reference Support: 18c9.

 -- Class: weakref.ref (object[, callback])

     Return a weak reference to `object'.  The original object can be
     retrieved by calling the reference object if the referent is still
     alive; if the referent is no longer alive, calling the reference
     object will cause *note None: 157. to be returned.  If `callback'
     is provided and not *note None: 157, and the returned weakref
     object is still alive, the callback will be called when the object
     is about to be finalized; the weak reference object will be passed
     as the only parameter to the callback; the referent will no longer
     be available.

     It is allowable for many weak references to be constructed for the
     same object.  Callbacks registered for each weak reference will be
     called from the most recently registered callback to the oldest
     registered callback.

     Exceptions raised by the callback will be noted on the standard
     error output, but cannot be propagated; they are handled in exactly
     the same way as exceptions raised from an object’s *note __del__():
     913. method.

     Weak references are *note hashable: 1364. if the `object' is
     hashable.  They will maintain their hash value even after the
     `object' was deleted.  If *note hash(): 9b8. is called the first
     time only after the `object' was deleted, the call will raise *note
     TypeError: 192.

     Weak references support tests for equality, but not ordering.  If
     the referents are still alive, two references have the same
     equality relationship as their referents (regardless of the
     `callback').  If either referent has been deleted, the references
     are equal only if the reference objects are the same object.

     This is a subclassable type rather than a factory function.

      -- Attribute: __callback__

          This read-only attribute returns the callback currently
          associated to the weakref.  If there is no callback or if the
          referent of the weakref is no longer alive then this attribute
          will have value ‘None’.

     Changed in version 3.4: Added the *note __callback__: 905.
     attribute.

 -- Function: weakref.proxy (object[, callback])

     Return a proxy to `object' which uses a weak reference.  This
     supports use of the proxy in most contexts instead of requiring the
     explicit dereferencing used with weak reference objects.  The
     returned object will have a type of either ‘ProxyType’ or
     ‘CallableProxyType’, depending on whether `object' is callable.
     Proxy objects are not *note hashable: 1364. regardless of the
     referent; this avoids a number of problems related to their
     fundamentally mutable nature, and prevent their use as dictionary
     keys.  `callback' is the same as the parameter of the same name to
     the *note ref(): 904. function.

     Changed in version 3.8: Extended the operator support on proxy
     objects to include the matrix multiplication operators ‘@’ and
     ‘@=’.

 -- Function: weakref.getweakrefcount (object)

     Return the number of weak references and proxies which refer to
     `object'.

 -- Function: weakref.getweakrefs (object)

     Return a list of all weak reference and proxy objects which refer
     to `object'.

 -- Class: weakref.WeakKeyDictionary ([dict])

     Mapping class that references keys weakly.  Entries in the
     dictionary will be discarded when there is no longer a strong
     reference to the key.  This can be used to associate additional
     data with an object owned by other parts of an application without
     adding attributes to those objects.  This can be especially useful
     with objects that override attribute accesses.

          Note: Caution: Because a *note WeakKeyDictionary: 18c7. is
          built on top of a Python dictionary, it must not change size
          when iterating over it.  This can be difficult to ensure for a
          *note WeakKeyDictionary: 18c7. because actions performed by
          the program during iteration may cause items in the dictionary
          to vanish “by magic” (as a side effect of garbage collection).

*note WeakKeyDictionary: 18c7. objects have an additional method that
exposes the internal references directly.  The references are not
guaranteed to be “live” at the time they are used, so the result of
calling the references needs to be checked before being used.  This can
be used to avoid creating references that will cause the garbage
collector to keep the keys around longer than needed.

 -- Method: WeakKeyDictionary.keyrefs ()

     Return an iterable of the weak references to the keys.

 -- Class: weakref.WeakValueDictionary ([dict])

     Mapping class that references values weakly.  Entries in the
     dictionary will be discarded when no strong reference to the value
     exists any more.

          Note: Caution: Because a *note WeakValueDictionary: 18c8. is
          built on top of a Python dictionary, it must not change size
          when iterating over it.  This can be difficult to ensure for a
          *note WeakValueDictionary: 18c8. because actions performed by
          the program during iteration may cause items in the dictionary
          to vanish “by magic” (as a side effect of garbage collection).

*note WeakValueDictionary: 18c8. objects have an additional method that
has the same issues as the ‘keyrefs()’ method of *note
WeakKeyDictionary: 18c7. objects.

 -- Method: WeakValueDictionary.valuerefs ()

     Return an iterable of the weak references to the values.

 -- Class: weakref.WeakSet ([elements])

     Set class that keeps weak references to its elements.  An element
     will be discarded when no strong reference to it exists any more.

 -- Class: weakref.WeakMethod (method)

     A custom *note ref: 904. subclass which simulates a weak reference
     to a bound method (i.e., a method defined on a class and looked up
     on an instance).  Since a bound method is ephemeral, a standard
     weak reference cannot keep hold of it.  *note WeakMethod: 903. has
     special code to recreate the bound method until either the object
     or the original function dies:

          >>> class C:
          ...     def method(self):
          ...         print("method called!")
          ...
          >>> c = C()
          >>> r = weakref.ref(c.method)
          >>> r()
          >>> r = weakref.WeakMethod(c.method)
          >>> r()
          <bound method C.method of <__main__.C object at 0x7fc859830220>>
          >>> r()()
          method called!
          >>> del c
          >>> gc.collect()
          0
          >>> r()
          >>>

     New in version 3.4.

 -- Class: weakref.finalize (obj, func, *args, **kwargs)

     Return a callable finalizer object which will be called when `obj'
     is garbage collected.  Unlike an ordinary weak reference, a
     finalizer will always survive until the reference object is
     collected, greatly simplifying lifecycle management.

     A finalizer is considered `alive' until it is called (either
     explicitly or at garbage collection), and after that it is `dead'.
     Calling a live finalizer returns the result of evaluating
     ‘func(*arg, **kwargs)’, whereas calling a dead finalizer returns
     *note None: 157.

     Exceptions raised by finalizer callbacks during garbage collection
     will be shown on the standard error output, but cannot be
     propagated.  They are handled in the same way as exceptions raised
     from an object’s *note __del__(): 913. method or a weak reference’s
     callback.

     When the program exits, each remaining live finalizer is called
     unless its *note atexit: c. attribute has been set to false.  They
     are called in reverse order of creation.

     A finalizer will never invoke its callback during the later part of
     the *note interpreter shutdown: 757. when module globals are liable
     to have been replaced by *note None: 157.

      -- Method: __call__ ()

          If `self' is alive then mark it as dead and return the result
          of calling ‘func(*args, **kwargs)’.  If `self' is dead then
          return *note None: 157.

      -- Method: detach ()

          If `self' is alive then mark it as dead and return the tuple
          ‘(obj, func, args, kwargs)’.  If `self' is dead then return
          *note None: 157.

      -- Method: peek ()

          If `self' is alive then return the tuple ‘(obj, func, args,
          kwargs)’.  If `self' is dead then return *note None: 157.

      -- Attribute: alive

          Property which is true if the finalizer is alive, false
          otherwise.

      -- Attribute: atexit

          A writable boolean property which by default is true.  When
          the program exits, it calls all remaining live finalizers for
          which *note atexit: 18d2. is true.  They are called in reverse
          order of creation.

          Note: It is important to ensure that `func', `args' and
          `kwargs' do not own any references to `obj', either directly
          or indirectly, since otherwise `obj' will never be garbage
          collected.  In particular, `func' should not be a bound method
          of `obj'.

     New in version 3.4.

 -- Data: weakref.ReferenceType

     The type object for weak references objects.

 -- Data: weakref.ProxyType

     The type object for proxies of objects which are not callable.

 -- Data: weakref.CallableProxyType

     The type object for proxies of callable objects.

 -- Data: weakref.ProxyTypes

     Sequence containing all the type objects for proxies.  This can
     make it simpler to test if an object is a proxy without being
     dependent on naming both proxy types.

 -- Exception: weakref.ReferenceError

     Exception raised when a proxy object is used but the underlying
     object has been collected.  This is the same as the standard *note
     ReferenceError: e40. exception.

See also
........

PEP 205(2) - Weak References

     The proposal and rationale for this feature, including links to
     earlier implementations and information about similar features in
     other languages.

* Menu:

* Weak Reference Objects::
* Example: Example<2>.
* Finalizer Objects::
* Comparing finalizers with __del__() methods: Comparing finalizers with __del__ methods.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/weakref.py

   (2) https://www.python.org/dev/peps/pep-0205


File: python.info,  Node: Weak Reference Objects,  Next: Example<2>,  Up: weakref — Weak references

5.8.8.1 Weak Reference Objects
..............................

Weak reference objects have no methods and no attributes besides *note
ref.__callback__: 905.  A weak reference object allows the referent to
be obtained, if it still exists, by calling it:

     >>> import weakref
     >>> class Object:
     ...     pass
     ...
     >>> o = Object()
     >>> r = weakref.ref(o)
     >>> o2 = r()
     >>> o is o2
     True

If the referent no longer exists, calling the reference object returns
*note None: 157.:

     >>> del o, o2
     >>> print(r())
     None

Testing that a weak reference object is still live should be done using
the expression ‘ref() is not None’.  Normally, application code that
needs to use a reference object should follow this pattern:

     # r is a weak reference object
     o = r()
     if o is None:
         # referent has been garbage collected
         print("Object has been deallocated; can't frobnicate.")
     else:
         print("Object is still live!")
         o.do_something_useful()

Using a separate test for “liveness” creates race conditions in threaded
applications; another thread can cause a weak reference to become
invalidated before the weak reference is called; the idiom shown above
is safe in threaded applications as well as single-threaded
applications.

Specialized versions of *note ref: 904. objects can be created through
subclassing.  This is used in the implementation of the *note
WeakValueDictionary: 18c8. to reduce the memory overhead for each entry
in the mapping.  This may be most useful to associate additional
information with a reference, but could also be used to insert
additional processing on calls to retrieve the referent.

This example shows how a subclass of *note ref: 904. can be used to
store additional information about an object and affect the value that’s
returned when the referent is accessed:

     import weakref

     class ExtendedRef(weakref.ref):
         def __init__(self, ob, callback=None, /, **annotations):
             super(ExtendedRef, self).__init__(ob, callback)
             self.__counter = 0
             for k, v in annotations.items():
                 setattr(self, k, v)

         def __call__(self):
             """Return a pair containing the referent and the number of
             times the reference has been called.
             """
             ob = super(ExtendedRef, self).__call__()
             if ob is not None:
                 self.__counter += 1
                 ob = (ob, self.__counter)
             return ob


File: python.info,  Node: Example<2>,  Next: Finalizer Objects,  Prev: Weak Reference Objects,  Up: weakref — Weak references

5.8.8.2 Example
...............

This simple example shows how an application can use object IDs to
retrieve objects that it has seen before.  The IDs of the objects can
then be used in other data structures without forcing the objects to
remain alive, but the objects can still be retrieved by ID if they do.

     import weakref

     _id2obj_dict = weakref.WeakValueDictionary()

     def remember(obj):
         oid = id(obj)
         _id2obj_dict[oid] = obj
         return oid

     def id2obj(oid):
         return _id2obj_dict[oid]


File: python.info,  Node: Finalizer Objects,  Next: Comparing finalizers with __del__ methods,  Prev: Example<2>,  Up: weakref — Weak references

5.8.8.3 Finalizer Objects
.........................

The main benefit of using *note finalize: 29b. is that it makes it
simple to register a callback without needing to preserve the returned
finalizer object.  For instance

     >>> import weakref
     >>> class Object:
     ...     pass
     ...
     >>> kenny = Object()
     >>> weakref.finalize(kenny, print, "You killed Kenny!")  #doctest:+ELLIPSIS
     <finalize object at ...; for 'Object' at ...>
     >>> del kenny
     You killed Kenny!

The finalizer can be called directly as well.  However the finalizer
will invoke the callback at most once.

     >>> def callback(x, y, z):
     ...     print("CALLBACK")
     ...     return x + y + z
     ...
     >>> obj = Object()
     >>> f = weakref.finalize(obj, callback, 1, 2, z=3)
     >>> assert f.alive
     >>> assert f() == 6
     CALLBACK
     >>> assert not f.alive
     >>> f()                     # callback not called because finalizer dead
     >>> del obj                 # callback not called because finalizer dead

You can unregister a finalizer using its *note detach(): 18cf. method.
This kills the finalizer and returns the arguments passed to the
constructor when it was created.

     >>> obj = Object()
     >>> f = weakref.finalize(obj, callback, 1, 2, z=3)
     >>> f.detach()                                           #doctest:+ELLIPSIS
     (<...Object object ...>, <function callback ...>, (1, 2), {'z': 3})
     >>> newobj, func, args, kwargs = _
     >>> assert not f.alive
     >>> assert newobj is obj
     >>> assert func(*args, **kwargs) == 6
     CALLBACK

Unless you set the *note atexit: 18d2. attribute to *note False: 37d, a
finalizer will be called when the program exits if it is still alive.
For instance

     >>> obj = Object()
     >>> weakref.finalize(obj, print, "obj dead or exiting")
     <finalize object at ...; for 'Object' at ...>
     >>> exit()
     obj dead or exiting


File: python.info,  Node: Comparing finalizers with __del__ methods,  Prev: Finalizer Objects,  Up: weakref — Weak references

5.8.8.4 Comparing finalizers with ‘__del__()’ methods
.....................................................

Suppose we want to create a class whose instances represent temporary
directories.  The directories should be deleted with their contents when
the first of the following events occurs:

   * the object is garbage collected,

   * the object’s ‘remove()’ method is called, or

   * the program exits.

We might try to implement the class using a *note __del__(): 913. method
as follows:

     class TempDir:
         def __init__(self):
             self.name = tempfile.mkdtemp()

         def remove(self):
             if self.name is not None:
                 shutil.rmtree(self.name)
                 self.name = None

         @property
         def removed(self):
             return self.name is None

         def __del__(self):
             self.remove()

Starting with Python 3.4, *note __del__(): 913. methods no longer
prevent reference cycles from being garbage collected, and module
globals are no longer forced to *note None: 157. during *note
interpreter shutdown: 757.  So this code should work without any issues
on CPython.

However, handling of *note __del__(): 913. methods is notoriously
implementation specific, since it depends on internal details of the
interpreter’s garbage collector implementation.

A more robust alternative can be to define a finalizer which only
references the specific functions and objects that it needs, rather than
having access to the full state of the object:

     class TempDir:
         def __init__(self):
             self.name = tempfile.mkdtemp()
             self._finalizer = weakref.finalize(self, shutil.rmtree, self.name)

         def remove(self):
             self._finalizer()

         @property
         def removed(self):
             return not self._finalizer.alive

Defined like this, our finalizer only receives a reference to the
details it needs to clean up the directory appropriately.  If the object
never gets garbage collected the finalizer will still be called at exit.

The other advantage of weakref based finalizers is that they can be used
to register finalizers for classes where the definition is controlled by
a third party, such as running code when a module is unloaded:

     import weakref, sys
     def unloading_module():
         # implicit reference to the module globals from the function body
     weakref.finalize(sys.modules[__name__], unloading_module)

     Note: If you create a finalizer object in a daemonic thread just as
     the program exits then there is the possibility that the finalizer
     does not get called at exit.  However, in a daemonic thread *note
     atexit.register(): e79, ‘try: ... finally: ...’ and ‘with: ...’ do
     not guarantee that cleanup occurs either.


File: python.info,  Node: types — Dynamic type creation and names for built-in types,  Next: copy — Shallow and deep copy operations,  Prev: weakref — Weak references,  Up: Data Types

5.8.9 ‘types’ — Dynamic type creation and names for built-in types
------------------------------------------------------------------

`Source code:' Lib/types.py(1)

__________________________________________________________________

This module defines utility functions to assist in dynamic creation of
new types.

It also defines names for some object types that are used by the
standard Python interpreter, but not exposed as builtins like *note int:
184. or *note str: 325. are.

Finally, it provides some additional type-related utility classes and
functions that are not fundamental enough to be builtins.

* Menu:

* Dynamic Type Creation::
* Standard Interpreter Types::
* Additional Utility Classes and Functions::
* Coroutine Utility Functions::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/types.py


File: python.info,  Node: Dynamic Type Creation,  Next: Standard Interpreter Types,  Up: types — Dynamic type creation and names for built-in types

5.8.9.1 Dynamic Type Creation
.............................

 -- Function: types.new_class (name, bases=(), kwds=None,
          exec_body=None)

     Creates a class object dynamically using the appropriate metaclass.

     The first three arguments are the components that make up a class
     definition header: the class name, the base classes (in order), the
     keyword arguments (such as ‘metaclass’).

     The `exec_body' argument is a callback that is used to populate the
     freshly created class namespace.  It should accept the class
     namespace as its sole argument and update the namespace directly
     with the class contents.  If no callback is provided, it has the
     same effect as passing in ‘lambda ns: ns’.

     New in version 3.3.

 -- Function: types.prepare_class (name, bases=(), kwds=None)

     Calculates the appropriate metaclass and creates the class
     namespace.

     The arguments are the components that make up a class definition
     header: the class name, the base classes (in order) and the keyword
     arguments (such as ‘metaclass’).

     The return value is a 3-tuple: ‘metaclass, namespace, kwds’

     `metaclass' is the appropriate metaclass, `namespace' is the
     prepared class namespace and `kwds' is an updated copy of the
     passed in `kwds' argument with any ‘'metaclass'’ entry removed.  If
     no `kwds' argument is passed in, this will be an empty dict.

     New in version 3.3.

     Changed in version 3.6: The default value for the ‘namespace’
     element of the returned tuple has changed.  Now an
     insertion-order-preserving mapping is used when the metaclass does
     not have a ‘__prepare__’ method.

See also
........

*note Metaclasses: 1384.

     Full details of the class creation process supported by these
     functions

PEP 3115(1) - Metaclasses in Python 3000

     Introduced the ‘__prepare__’ namespace hook

 -- Function: types.resolve_bases (bases)

     Resolve MRO entries dynamically as specified by PEP 560(2).

     This function looks for items in `bases' that are not instances of
     *note type: 5fd, and returns a tuple where each such object that
     has an ‘__mro_entries__’ method is replaced with an unpacked result
     of calling this method.  If a `bases' item is an instance of *note
     type: 5fd, or it doesn’t have an ‘__mro_entries__’ method, then it
     is included in the return tuple unchanged.

     New in version 3.7.

See also
........

PEP 560(3) - Core support for typing module and generic types

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3115

   (2) https://www.python.org/dev/peps/pep-0560

   (3) https://www.python.org/dev/peps/pep-0560


File: python.info,  Node: Standard Interpreter Types,  Next: Additional Utility Classes and Functions,  Prev: Dynamic Type Creation,  Up: types — Dynamic type creation and names for built-in types

5.8.9.2 Standard Interpreter Types
..................................

This module provides names for many of the types that are required to
implement a Python interpreter.  It deliberately avoids including some
of the types that arise only incidentally during processing such as the
‘listiterator’ type.

Typical use of these names is for *note isinstance(): 444. or *note
issubclass(): 445. checks.

If you instantiate any of these types, note that signatures may vary
between Python versions.

Standard names are defined for the following types:

 -- Data: types.FunctionType
 -- Data: types.LambdaType

     The type of user-defined functions and functions created by *note
     lambda: c22. expressions.

 -- Data: types.GeneratorType

     The type of *note generator: 996.-iterator objects, created by
     generator functions.

 -- Data: types.CoroutineType

     The type of *note coroutine: 1a5. objects, created by *note async
     def: 282. functions.

     New in version 3.5.

 -- Data: types.AsyncGeneratorType

     The type of *note asynchronous generator: 1441.-iterator objects,
     created by asynchronous generator functions.

     New in version 3.6.

 -- Data: types.CodeType

     The type for code objects such as returned by *note compile(): 1b2.

     Raises an *note auditing event: 1275. ‘code.__new__’ with arguments
     ‘code’, ‘filename’, ‘name’, ‘argcount’, ‘posonlyargcount’,
     ‘kwonlyargcount’, ‘nlocals’, ‘stacksize’, ‘flags’.

     Note that the audited arguments may not match the names or
     positions required by the initializer.

 -- Data: types.CellType

     The type for cell objects: such objects are used as containers for
     a function’s free variables.

     New in version 3.8.

 -- Data: types.MethodType

     The type of methods of user-defined class instances.

 -- Data: types.BuiltinFunctionType
 -- Data: types.BuiltinMethodType

     The type of built-in functions like *note len(): 150. or *note
     sys.exit(): cd5, and methods of built-in classes.  (Here, the term
     “built-in” means “written in C”.)

 -- Data: types.WrapperDescriptorType

     The type of methods of some built-in data types and base classes
     such as *note object.__init__(): d51. or *note object.__lt__():
     c27.

     New in version 3.7.

 -- Data: types.MethodWrapperType

     The type of `bound' methods of some built-in data types and base
     classes.  For example it is the type of ‘object().__str__’.

     New in version 3.7.

 -- Data: types.MethodDescriptorType

     The type of methods of some built-in data types such as *note
     str.join(): 156d.

     New in version 3.7.

 -- Data: types.ClassMethodDescriptorType

     The type of `unbound' class methods of some built-in data types
     such as ‘dict.__dict__['fromkeys']’.

     New in version 3.7.

 -- Class: types.ModuleType (name, doc=None)

     The type of *note modules: 13e9.  Constructor takes the name of the
     module to be created and optionally its *note docstring: 14f1.

          Note: Use *note importlib.util.module_from_spec(): 6e4. to
          create a new module if you wish to set the various
          import-controlled attributes.

      -- Attribute: __doc__

          The *note docstring: 14f1. of the module.  Defaults to ‘None’.

      -- Attribute: __loader__

          The *note loader: 13f8. which loaded the module.  Defaults to
          ‘None’.

          Changed in version 3.4: Defaults to ‘None’.  Previously the
          attribute was optional.

      -- Attribute: __name__

          The name of the module.

      -- Attribute: __package__

          Which *note package: 13ee. a module belongs to.  If the module
          is top-level (i.e.  not a part of any specific package) then
          the attribute should be set to ‘''’, else it should be set to
          the name of the package (which can be *note __name__: d05. if
          the module is a package itself).  Defaults to ‘None’.

          Changed in version 3.4: Defaults to ‘None’.  Previously the
          attribute was optional.

 -- Class: types.TracebackType (tb_next, tb_frame, tb_lasti, tb_lineno)

     The type of traceback objects such as found in ‘sys.exc_info()[2]’.

     See *note the language reference: 32b. for details of the available
     attributes and operations, and guidance on creating tracebacks
     dynamically.

 -- Data: types.FrameType

     The type of frame objects such as found in ‘tb.tb_frame’ if ‘tb’ is
     a traceback object.

     See *note the language reference: 136e. for details of the
     available attributes and operations.

 -- Data: types.GetSetDescriptorType

     The type of objects defined in extension modules with
     ‘PyGetSetDef’, such as ‘FrameType.f_locals’ or
     ‘array.array.typecode’.  This type is used as descriptor for object
     attributes; it has the same purpose as the *note property: 1d5.
     type, but for classes defined in extension modules.

 -- Data: types.MemberDescriptorType

     The type of objects defined in extension modules with
     ‘PyMemberDef’, such as ‘datetime.timedelta.days’.  This type is
     used as descriptor for simple C data members which use standard
     conversion functions; it has the same purpose as the *note
     property: 1d5. type, but for classes defined in extension modules.

     `CPython implementation detail:' In other implementations of
     Python, this type may be identical to ‘GetSetDescriptorType’.

 -- Class: types.MappingProxyType (mapping)

     Read-only proxy of a mapping.  It provides a dynamic view on the
     mapping’s entries, which means that when the mapping changes, the
     view reflects these changes.

     New in version 3.3.

      -- Describe: key in proxy

          Return ‘True’ if the underlying mapping has a key `key', else
          ‘False’.

      -- Describe: proxy[key]

          Return the item of the underlying mapping with key `key'.
          Raises a *note KeyError: 2c5. if `key' is not in the
          underlying mapping.

      -- Describe: iter(proxy)

          Return an iterator over the keys of the underlying mapping.
          This is a shortcut for ‘iter(proxy.keys())’.

      -- Describe: len(proxy)

          Return the number of items in the underlying mapping.

      -- Method: copy ()

          Return a shallow copy of the underlying mapping.

      -- Method: get (key[, default])

          Return the value for `key' if `key' is in the underlying
          mapping, else `default'.  If `default' is not given, it
          defaults to ‘None’, so that this method never raises a *note
          KeyError: 2c5.

      -- Method: items ()

          Return a new view of the underlying mapping’s items (‘(key,
          value)’ pairs).

      -- Method: keys ()

          Return a new view of the underlying mapping’s keys.

      -- Method: values ()

          Return a new view of the underlying mapping’s values.


File: python.info,  Node: Additional Utility Classes and Functions,  Next: Coroutine Utility Functions,  Prev: Standard Interpreter Types,  Up: types — Dynamic type creation and names for built-in types

5.8.9.3 Additional Utility Classes and Functions
................................................

 -- Class: types.SimpleNamespace

     A simple *note object: 2ae. subclass that provides attribute access
     to its namespace, as well as a meaningful repr.

     Unlike *note object: 2ae, with ‘SimpleNamespace’ you can add and
     remove attributes.  If a ‘SimpleNamespace’ object is initialized
     with keyword arguments, those are directly added to the underlying
     namespace.

     The type is roughly equivalent to the following code:

          class SimpleNamespace:
              def __init__(self, /, **kwargs):
                  self.__dict__.update(kwargs)

              def __repr__(self):
                  keys = sorted(self.__dict__)
                  items = ("{}={!r}".format(k, self.__dict__[k]) for k in keys)
                  return "{}({})".format(type(self).__name__, ", ".join(items))

              def __eq__(self, other):
                  return self.__dict__ == other.__dict__

     ‘SimpleNamespace’ may be useful as a replacement for ‘class NS:
     pass’.  However, for a structured record type use *note
     namedtuple(): 1b5. instead.

     New in version 3.3.

 -- Function: types.DynamicClassAttribute (fget=None, fset=None,
          fdel=None, doc=None)

     Route attribute access on a class to __getattr__.

     This is a descriptor, used to define attributes that act
     differently when accessed through an instance and through a class.
     Instance access remains normal, but access to an attribute through
     a class will be routed to the class’s __getattr__ method; this is
     done by raising AttributeError.

     This allows one to have properties active on an instance, and have
     virtual attributes on the class with the same name (see Enum for an
     example).

     New in version 3.4.


File: python.info,  Node: Coroutine Utility Functions,  Prev: Additional Utility Classes and Functions,  Up: types — Dynamic type creation and names for built-in types

5.8.9.4 Coroutine Utility Functions
...................................

 -- Function: types.coroutine (gen_func)

     This function transforms a *note generator: 996. function into a
     *note coroutine function: 633. which returns a generator-based
     coroutine.  The generator-based coroutine is still a *note
     generator iterator: 44c, but is also considered to be a *note
     coroutine: 1a5. object and is *note awaitable: 50e.  However, it
     may not necessarily implement the *note __await__(): 636. method.

     If `gen_func' is a generator function, it will be modified
     in-place.

     If `gen_func' is not a generator function, it will be wrapped.  If
     it returns an instance of *note collections.abc.Generator: 6a9, the
     instance will be wrapped in an `awaitable' proxy object.  All other
     types of objects will be returned as is.

     New in version 3.5.


File: python.info,  Node: copy — Shallow and deep copy operations,  Next: pprint — Data pretty printer,  Prev: types — Dynamic type creation and names for built-in types,  Up: Data Types

5.8.10 ‘copy’ — Shallow and deep copy operations
------------------------------------------------

`Source code:' Lib/copy.py(1)

__________________________________________________________________

Assignment statements in Python do not copy objects, they create
bindings between a target and an object.  For collections that are
mutable or contain mutable items, a copy is sometimes needed so one can
change one copy without changing the other.  This module provides
generic shallow and deep copy operations (explained below).

Interface summary:

 -- Function: copy.copy (x)

     Return a shallow copy of `x'.

 -- Function: copy.deepcopy (x[, memo])

     Return a deep copy of `x'.

 -- Exception: copy.error

     Raised for module specific errors.
The difference between shallow and deep copying is only relevant for
compound objects (objects that contain other objects, like lists or
class instances):

   * A `shallow copy' constructs a new compound object and then (to the
     extent possible) inserts `references' into it to the objects found
     in the original.

   * A `deep copy' constructs a new compound object and then,
     recursively, inserts `copies' into it of the objects found in the
     original.

Two problems often exist with deep copy operations that don’t exist with
shallow copy operations:

   * Recursive objects (compound objects that, directly or indirectly,
     contain a reference to themselves) may cause a recursive loop.

   * Because deep copy copies everything it may copy too much, such as
     data which is intended to be shared between copies.

The *note deepcopy(): 3c1. function avoids these problems by:

   * keeping a ‘memo’ dictionary of objects already copied during the
     current copying pass; and

   * letting user-defined classes override the copying operation or the
     set of components copied.

This module does not copy types like module, method, stack trace, stack
frame, file, socket, window, array, or any similar types.  It does
“copy” functions and classes (shallow and deeply), by returning the
original object unchanged; this is compatible with the way these are
treated by the *note pickle: ca. module.

Shallow copies of dictionaries can be made using *note dict.copy(): 43b,
and of lists by assigning a slice of the entire list, for example,
‘copied_list = original_list[:]’.

Classes can use the same interfaces to control copying that they use to
control pickling.  See the description of module *note pickle: ca. for
information on these methods.  In fact, the *note copy: 26. module uses
the registered pickle functions from the *note copyreg: 27. module.

In order for a class to define its own copy implementation, it can
define special methods ‘__copy__()’ and ‘__deepcopy__()’.  The former is
called to implement the shallow copy operation; no additional arguments
are passed.  The latter is called to implement the deep copy operation;
it is passed one argument, the ‘memo’ dictionary.  If the
‘__deepcopy__()’ implementation needs to make a deep copy of a
component, it should call the *note deepcopy(): 3c1. function with the
component as first argument and the memo dictionary as second argument.

See also
........

Module *note pickle: ca.

     Discussion of the special methods used to support object state
     retrieval and restoration.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/copy.py


File: python.info,  Node: pprint — Data pretty printer,  Next: reprlib — Alternate repr implementation,  Prev: copy — Shallow and deep copy operations,  Up: Data Types

5.8.11 ‘pprint’ — Data pretty printer
-------------------------------------

`Source code:' Lib/pprint.py(1)

__________________________________________________________________

The *note pprint: d2. module provides a capability to “pretty-print”
arbitrary Python data structures in a form which can be used as input to
the interpreter.  If the formatted structures include objects which are
not fundamental Python types, the representation may not be loadable.
This may be the case if objects such as files, sockets or classes are
included, as well as many other objects which are not representable as
Python literals.

The formatted representation keeps objects on a single line if it can,
and breaks them onto multiple lines if they don’t fit within the allowed
width.  Construct *note PrettyPrinter: 889. objects explicitly if you
need to adjust the width constraint.

Dictionaries are sorted by key before the display is computed.

The *note pprint: d2. module defines one class:

 -- Class: pprint.PrettyPrinter (indent=1, width=80, depth=None,
          stream=None, *, compact=False, sort_dicts=True)

     Construct a *note PrettyPrinter: 889. instance.  This constructor
     understands several keyword parameters.  An output stream may be
     set using the `stream' keyword; the only method used on the stream
     object is the file protocol’s ‘write()’ method.  If not specified,
     the *note PrettyPrinter: 889. adopts ‘sys.stdout’.  The amount of
     indentation added for each recursive level is specified by
     `indent'; the default is one.  Other values can cause output to
     look a little odd, but can make nesting easier to spot.  The number
     of levels which may be printed is controlled by `depth'; if the
     data structure being printed is too deep, the next contained level
     is replaced by ‘...’.  By default, there is no constraint on the
     depth of the objects being formatted.  The desired output width is
     constrained using the `width' parameter; the default is 80
     characters.  If a structure cannot be formatted within the
     constrained width, a best effort will be made.  If `compact' is
     false (the default) each item of a long sequence will be formatted
     on a separate line.  If `compact' is true, as many items as will
     fit within the `width' will be formatted on each output line.  If
     `sort_dicts' is true (the default), dictionaries will be formatted
     with their keys sorted, otherwise they will display in insertion
     order.

     Changed in version 3.4: Added the `compact' parameter.

     Changed in version 3.8: Added the `sort_dicts' parameter.

          >>> import pprint
          >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
          >>> stuff.insert(0, stuff[:])
          >>> pp = pprint.PrettyPrinter(indent=4)
          >>> pp.pprint(stuff)
          [   ['spam', 'eggs', 'lumberjack', 'knights', 'ni'],
              'spam',
              'eggs',
              'lumberjack',
              'knights',
              'ni']
          >>> pp = pprint.PrettyPrinter(width=41, compact=True)
          >>> pp.pprint(stuff)
          [['spam', 'eggs', 'lumberjack',
            'knights', 'ni'],
           'spam', 'eggs', 'lumberjack', 'knights',
           'ni']
          >>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
          ... ('parrot', ('fresh fruit',))))))))
          >>> pp = pprint.PrettyPrinter(depth=6)
          >>> pp.pprint(tup)
          ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', (...)))))))

The *note pprint: d2. module also provides several shortcut functions:

 -- Function: pprint.pformat (object, indent=1, width=80, depth=None, *,
          compact=False, sort_dicts=True)

     Return the formatted representation of `object' as a string.
     `indent', `width', `depth', `compact' and `sort_dicts' will be
     passed to the *note PrettyPrinter: 889. constructor as formatting
     parameters.

     Changed in version 3.4: Added the `compact' parameter.

     Changed in version 3.8: Added the `sort_dicts' parameter.

 -- Function: pprint.pp (object, *args, sort_dicts=False, **kwargs)

     Prints the formatted representation of `object' followed by a
     newline.  If `sort_dicts' is false (the default), dictionaries will
     be displayed with their keys in insertion order, otherwise the dict
     keys will be sorted.  `args' and `kwargs' will be passed to *note
     pprint(): d2. as formatting parameters.

     New in version 3.8.

 -- Function: pprint.pprint (object, stream=None, indent=1, width=80,
          depth=None, *, compact=False, sort_dicts=True)

     Prints the formatted representation of `object' on `stream',
     followed by a newline.  If `stream' is ‘None’, ‘sys.stdout’ is
     used.  This may be used in the interactive interpreter instead of
     the *note print(): 87a. function for inspecting values (you can
     even reassign ‘print = pprint.pprint’ for use within a scope).
     `indent', `width', `depth', `compact' and `sort_dicts' will be
     passed to the *note PrettyPrinter: 889. constructor as formatting
     parameters.

     Changed in version 3.4: Added the `compact' parameter.

     Changed in version 3.8: Added the `sort_dicts' parameter.

          >>> import pprint
          >>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
          >>> stuff.insert(0, stuff)
          >>> pprint.pprint(stuff)
          [<Recursion on list with id=...>,
           'spam',
           'eggs',
           'lumberjack',
           'knights',
           'ni']

 -- Function: pprint.isreadable (object)

     Determine if the formatted representation of `object' is
     “readable,” or can be used to reconstruct the value using *note
     eval(): b83.  This always returns ‘False’ for recursive objects.

          >>> pprint.isreadable(stuff)
          False

 -- Function: pprint.isrecursive (object)

     Determine if `object' requires a recursive representation.

One more support function is also defined:

 -- Function: pprint.saferepr (object)

     Return a string representation of `object', protected against
     recursive data structures.  If the representation of `object'
     exposes a recursive entry, the recursive reference will be
     represented as ‘<Recursion on typename with id=number>’.  The
     representation is not otherwise formatted.

          >>> pprint.saferepr(stuff)
          "[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"

* Menu:

* PrettyPrinter Objects::
* Example: Example<3>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pprint.py


File: python.info,  Node: PrettyPrinter Objects,  Next: Example<3>,  Up: pprint — Data pretty printer

5.8.11.1 PrettyPrinter Objects
..............................

*note PrettyPrinter: 889. instances have the following methods:

 -- Method: PrettyPrinter.pformat (object)

     Return the formatted representation of `object'.  This takes into
     account the options passed to the *note PrettyPrinter: 889.
     constructor.

 -- Method: PrettyPrinter.pprint (object)

     Print the formatted representation of `object' on the configured
     stream, followed by a newline.

The following methods provide the implementations for the corresponding
functions of the same names.  Using these methods on an instance is
slightly more efficient since new *note PrettyPrinter: 889. objects
don’t need to be created.

 -- Method: PrettyPrinter.isreadable (object)

     Determine if the formatted representation of the object is
     “readable,” or can be used to reconstruct the value using *note
     eval(): b83.  Note that this returns ‘False’ for recursive objects.
     If the `depth' parameter of the *note PrettyPrinter: 889. is set
     and the object is deeper than allowed, this returns ‘False’.

 -- Method: PrettyPrinter.isrecursive (object)

     Determine if the object requires a recursive representation.

This method is provided as a hook to allow subclasses to modify the way
objects are converted to strings.  The default implementation uses the
internals of the *note saferepr(): 18fe. implementation.

 -- Method: PrettyPrinter.format (object, context, maxlevels, level)

     Returns three values: the formatted version of `object' as a
     string, a flag indicating whether the result is readable, and a
     flag indicating whether recursion was detected.  The first argument
     is the object to be presented.  The second is a dictionary which
     contains the *note id(): d79. of objects that are part of the
     current presentation context (direct and indirect containers for
     `object' that are affecting the presentation) as the keys; if an
     object needs to be presented which is already represented in
     `context', the third return value should be ‘True’.  Recursive
     calls to the *note format(): 1905. method should add additional
     entries for containers to this dictionary.  The third argument,
     `maxlevels', gives the requested limit to recursion; this will be
     ‘0’ if there is no requested limit.  This argument should be passed
     unmodified to recursive calls.  The fourth argument, `level', gives
     the current level; recursive calls should be passed a value less
     than that of the current call.


File: python.info,  Node: Example<3>,  Prev: PrettyPrinter Objects,  Up: pprint — Data pretty printer

5.8.11.2 Example
................

To demonstrate several uses of the *note pprint(): d2. function and its
parameters, let’s fetch information about a project from PyPI(1):

     >>> import json
     >>> import pprint
     >>> from urllib.request import urlopen
     >>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp:
     ...     project_info = json.load(resp)['info']

In its basic form, *note pprint(): d2. shows the whole object:

     >>> pprint.pprint(project_info)
     {'author': 'The Python Packaging Authority',
      'author_email': 'pypa-dev@googlegroups.com',
      'bugtrack_url': None,
      'classifiers': ['Development Status :: 3 - Alpha',
                      'Intended Audience :: Developers',
                      'License :: OSI Approved :: MIT License',
                      'Programming Language :: Python :: 2',
                      'Programming Language :: Python :: 2.6',
                      'Programming Language :: Python :: 2.7',
                      'Programming Language :: Python :: 3',
                      'Programming Language :: Python :: 3.2',
                      'Programming Language :: Python :: 3.3',
                      'Programming Language :: Python :: 3.4',
                      'Topic :: Software Development :: Build Tools'],
      'description': 'A sample Python project\n'
                     '=======================\n'
                     '\n'
                     'This is the description file for the project.\n'
                     '\n'
                     'The file should use UTF-8 encoding and be written using '
                     'ReStructured Text. It\n'
                     'will be used to generate the project webpage on PyPI, and '
                     'should be written for\n'
                     'that purpose.\n'
                     '\n'
                     'Typical contents for this file would include an overview of '
                     'the project, basic\n'
                     'usage examples, etc. Generally, including the project '
                     'changelog in here is not\n'
                     'a good idea, although a simple "What\'s New" section for the '
                     'most recent version\n'
                     'may be appropriate.',
      'description_content_type': None,
      'docs_url': None,
      'download_url': 'UNKNOWN',
      'downloads': {'last_day': -1, 'last_month': -1, 'last_week': -1},
      'home_page': 'https://github.com/pypa/sampleproject',
      'keywords': 'sample setuptools development',
      'license': 'MIT',
      'maintainer': None,
      'maintainer_email': None,
      'name': 'sampleproject',
      'package_url': 'https://pypi.org/project/sampleproject/',
      'platform': 'UNKNOWN',
      'project_url': 'https://pypi.org/project/sampleproject/',
      'project_urls': {'Download': 'UNKNOWN',
                       'Homepage': 'https://github.com/pypa/sampleproject'},
      'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
      'requires_dist': None,
      'requires_python': None,
      'summary': 'A sample Python project',
      'version': '1.2.0'}

The result can be limited to a certain `depth' (ellipsis is used for
deeper contents):

     >>> pprint.pprint(project_info, depth=1)
     {'author': 'The Python Packaging Authority',
      'author_email': 'pypa-dev@googlegroups.com',
      'bugtrack_url': None,
      'classifiers': [...],
      'description': 'A sample Python project\n'
                     '=======================\n'
                     '\n'
                     'This is the description file for the project.\n'
                     '\n'
                     'The file should use UTF-8 encoding and be written using '
                     'ReStructured Text. It\n'
                     'will be used to generate the project webpage on PyPI, and '
                     'should be written for\n'
                     'that purpose.\n'
                     '\n'
                     'Typical contents for this file would include an overview of '
                     'the project, basic\n'
                     'usage examples, etc. Generally, including the project '
                     'changelog in here is not\n'
                     'a good idea, although a simple "What\'s New" section for the '
                     'most recent version\n'
                     'may be appropriate.',
      'description_content_type': None,
      'docs_url': None,
      'download_url': 'UNKNOWN',
      'downloads': {...},
      'home_page': 'https://github.com/pypa/sampleproject',
      'keywords': 'sample setuptools development',
      'license': 'MIT',
      'maintainer': None,
      'maintainer_email': None,
      'name': 'sampleproject',
      'package_url': 'https://pypi.org/project/sampleproject/',
      'platform': 'UNKNOWN',
      'project_url': 'https://pypi.org/project/sampleproject/',
      'project_urls': {...},
      'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
      'requires_dist': None,
      'requires_python': None,
      'summary': 'A sample Python project',
      'version': '1.2.0'}

Additionally, maximum character `width' can be suggested.  If a long
object cannot be split, the specified width will be exceeded:

     >>> pprint.pprint(project_info, depth=1, width=60)
     {'author': 'The Python Packaging Authority',
      'author_email': 'pypa-dev@googlegroups.com',
      'bugtrack_url': None,
      'classifiers': [...],
      'description': 'A sample Python project\n'
                     '=======================\n'
                     '\n'
                     'This is the description file for the '
                     'project.\n'
                     '\n'
                     'The file should use UTF-8 encoding and be '
                     'written using ReStructured Text. It\n'
                     'will be used to generate the project '
                     'webpage on PyPI, and should be written '
                     'for\n'
                     'that purpose.\n'
                     '\n'
                     'Typical contents for this file would '
                     'include an overview of the project, '
                     'basic\n'
                     'usage examples, etc. Generally, including '
                     'the project changelog in here is not\n'
                     'a good idea, although a simple "What\'s '
                     'New" section for the most recent version\n'
                     'may be appropriate.',
      'description_content_type': None,
      'docs_url': None,
      'download_url': 'UNKNOWN',
      'downloads': {...},
      'home_page': 'https://github.com/pypa/sampleproject',
      'keywords': 'sample setuptools development',
      'license': 'MIT',
      'maintainer': None,
      'maintainer_email': None,
      'name': 'sampleproject',
      'package_url': 'https://pypi.org/project/sampleproject/',
      'platform': 'UNKNOWN',
      'project_url': 'https://pypi.org/project/sampleproject/',
      'project_urls': {...},
      'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
      'requires_dist': None,
      'requires_python': None,
      'summary': 'A sample Python project',
      'version': '1.2.0'}

   ---------- Footnotes ----------

   (1) https://pypi.org


File: python.info,  Node: reprlib — Alternate repr implementation,  Next: enum — Support for enumerations,  Prev: pprint — Data pretty printer,  Up: Data Types

5.8.12 ‘reprlib’ — Alternate ‘repr()’ implementation
----------------------------------------------------

`Source code:' Lib/reprlib.py(1)

__________________________________________________________________

The *note reprlib: df. module provides a means for producing object
representations with limits on the size of the resulting strings.  This
is used in the Python debugger and may be useful in other contexts as
well.

This module provides a class, an instance, and a function:

 -- Class: reprlib.Repr

     Class which provides formatting services useful in implementing
     functions similar to the built-in *note repr(): 7c0.; size limits
     for different object types are added to avoid the generation of
     representations which are excessively long.

 -- Data: reprlib.aRepr

     This is an instance of *note Repr: 190a. which is used to provide
     the *note repr(): 190c. function described below.  Changing the
     attributes of this object will affect the size limits used by *note
     repr(): 190c. and the Python debugger.

 -- Function: reprlib.repr (obj)

     This is the *note repr(): 190d. method of ‘aRepr’.  It returns a
     string similar to that returned by the built-in function of the
     same name, but with limits on most sizes.

In addition to size-limiting tools, the module also provides a decorator
for detecting recursive calls to *note __repr__(): 333. and substituting
a placeholder string instead.

 -- Function: @reprlib.recursive_repr (fillvalue="...")

     Decorator for *note __repr__(): 333. methods to detect recursive
     calls within the same thread.  If a recursive call is made, the
     `fillvalue' is returned, otherwise, the usual *note __repr__():
     333. call is made.  For example:

          >>> from reprlib import recursive_repr
          >>> class MyList(list):
          ...     @recursive_repr()
          ...     def __repr__(self):
          ...         return '<' + '|'.join(map(repr, self)) + '>'
          ...
          >>> m = MyList('abc')
          >>> m.append(m)
          >>> m.append('x')
          >>> print(m)
          <'a'|'b'|'c'|...|'x'>

     New in version 3.2.

* Menu:

* Repr Objects::
* Subclassing Repr Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/reprlib.py


File: python.info,  Node: Repr Objects,  Next: Subclassing Repr Objects,  Up: reprlib — Alternate repr implementation

5.8.12.1 Repr Objects
.....................

*note Repr: 190a. instances provide several attributes which can be used
to provide size limits for the representations of different object
types, and methods which format specific object types.

 -- Attribute: Repr.maxlevel

     Depth limit on the creation of recursive representations.  The
     default is ‘6’.

 -- Attribute: Repr.maxdict
 -- Attribute: Repr.maxlist
 -- Attribute: Repr.maxtuple
 -- Attribute: Repr.maxset
 -- Attribute: Repr.maxfrozenset
 -- Attribute: Repr.maxdeque
 -- Attribute: Repr.maxarray

     Limits on the number of entries represented for the named object
     type.  The default is ‘4’ for *note maxdict: 1911, ‘5’ for *note
     maxarray: 1917, and ‘6’ for the others.

 -- Attribute: Repr.maxlong

     Maximum number of characters in the representation for an integer.
     Digits are dropped from the middle.  The default is ‘40’.

 -- Attribute: Repr.maxstring

     Limit on the number of characters in the representation of the
     string.  Note that the “normal” representation of the string is
     used as the character source: if escape sequences are needed in the
     representation, these may be mangled when the representation is
     shortened.  The default is ‘30’.

 -- Attribute: Repr.maxother

     This limit is used to control the size of object types for which no
     specific formatting method is available on the *note Repr: 190a.
     object.  It is applied in a similar manner as *note maxstring:
     1919.  The default is ‘20’.

 -- Method: Repr.repr (obj)

     The equivalent to the built-in *note repr(): 7c0. that uses the
     formatting imposed by the instance.

 -- Method: Repr.repr1 (obj, level)

     Recursive implementation used by *note repr(): 190d.  This uses the
     type of `obj' to determine which formatting method to call, passing
     it `obj' and `level'.  The type-specific methods should call *note
     repr1(): 191b. to perform recursive formatting, with ‘level - 1’
     for the value of `level' in the recursive call.

 -- Method: Repr.repr_TYPE (obj, level)

     Formatting methods for specific types are implemented as methods
     with a name based on the type name.  In the method name, `TYPE' is
     replaced by ‘'_'.join(type(obj).__name__.split())’.  Dispatch to
     these methods is handled by *note repr1(): 191b.  Type-specific
     methods which need to recursively format a value should call
     ‘self.repr1(subobj, level - 1)’.


File: python.info,  Node: Subclassing Repr Objects,  Prev: Repr Objects,  Up: reprlib — Alternate repr implementation

5.8.12.2 Subclassing Repr Objects
.................................

The use of dynamic dispatching by *note Repr.repr1(): 191b. allows
subclasses of *note Repr: 190a. to add support for additional built-in
object types or to modify the handling of types already supported.  This
example shows how special support for file objects could be added:

     import reprlib
     import sys

     class MyRepr(reprlib.Repr):

         def repr_TextIOWrapper(self, obj, level):
             if obj.name in {'<stdin>', '<stdout>', '<stderr>'}:
                 return obj.name
             return repr(obj)

     aRepr = MyRepr()
     print(aRepr.repr(sys.stdin))         # prints '<stdin>'


File: python.info,  Node: enum — Support for enumerations,  Prev: reprlib — Alternate repr implementation,  Up: Data Types

5.8.13 ‘enum’ — Support for enumerations
----------------------------------------

New in version 3.4.

`Source code:' Lib/enum.py(1)

__________________________________________________________________

An enumeration is a set of symbolic names (members) bound to unique,
constant values.  Within an enumeration, the members can be compared by
identity, and the enumeration itself can be iterated over.

* Menu:

* Module Contents: Module Contents<2>.
* Creating an Enum::
* Programmatic access to enumeration members and their attributes::
* Duplicating enum members and values::
* Ensuring unique enumeration values::
* Using automatic values::
* Iteration::
* Comparisons: Comparisons<3>.
* Allowed members and attributes of enumerations::
* Restricted Enum subclassing::
* Pickling::
* Functional API::
* Derived Enumerations::
* When to use __new__() vs. __init__(): When to use __new__ vs __init__.
* Interesting examples::
* How are Enums different?::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/enum.py


File: python.info,  Node: Module Contents<2>,  Next: Creating an Enum,  Up: enum — Support for enumerations

5.8.13.1 Module Contents
........................

This module defines four enumeration classes that can be used to define
unique sets of names and values: *note Enum: 37c, *note IntEnum: 582,
*note Flag: 53a, and *note IntFlag: 1693.  It also defines one
decorator, *note unique(): 1921, and one helper, *note auto: 53b.

 -- Class: enum.Enum

     Base class for creating enumerated constants.  See section *note
     Functional API: 1922. for an alternate construction syntax.

 -- Class: enum.IntEnum

     Base class for creating enumerated constants that are also
     subclasses of *note int: 184.

 -- Class: enum.IntFlag

     Base class for creating enumerated constants that can be combined
     using the bitwise operators without losing their *note IntFlag:
     1693. membership.  *note IntFlag: 1693. members are also subclasses
     of *note int: 184.

 -- Class: enum.Flag

     Base class for creating enumerated constants that can be combined
     using the bitwise operations without losing their *note Flag: 53a.
     membership.

 -- Function: enum.unique ()

     Enum class decorator that ensures only one name is bound to any one
     value.

 -- Class: enum.auto

     Instances are replaced with an appropriate value for Enum members.

New in version 3.6: ‘Flag’, ‘IntFlag’, ‘auto’


File: python.info,  Node: Creating an Enum,  Next: Programmatic access to enumeration members and their attributes,  Prev: Module Contents<2>,  Up: enum — Support for enumerations

5.8.13.2 Creating an Enum
.........................

Enumerations are created using the *note class: c5d. syntax, which makes
them easy to read and write.  An alternative creation method is
described in *note Functional API: 1922.  To define an enumeration,
subclass *note Enum: 37c. as follows:

     >>> from enum import Enum
     >>> class Color(Enum):
     ...     RED = 1
     ...     GREEN = 2
     ...     BLUE = 3
     ...

     Note: Enum member values

     Member values can be anything: *note int: 184, *note str: 325,
     etc..  If the exact value is unimportant you may use *note auto:
     53b. instances and an appropriate value will be chosen for you.
     Care must be taken if you mix *note auto: 53b. with other values.

     Note: Nomenclature

        - The class ‘Color’ is an `enumeration' (or `enum')

        - The attributes ‘Color.RED’, ‘Color.GREEN’, etc., are
          `enumeration members' (or `enum members') and are functionally
          constants.

        - The enum members have `names' and `values' (the name of
          ‘Color.RED’ is ‘RED’, the value of ‘Color.BLUE’ is ‘3’, etc.)

     Note: Even though we use the *note class: c5d. syntax to create
     Enums, Enums are not normal Python classes.  See *note How are
     Enums different?: 1924. for more details.

Enumeration members have human readable string representations:

     >>> print(Color.RED)
     Color.RED

…while their ‘repr’ has more information:

     >>> print(repr(Color.RED))
     <Color.RED: 1>

The `type' of an enumeration member is the enumeration it belongs to:

     >>> type(Color.RED)
     <enum 'Color'>
     >>> isinstance(Color.GREEN, Color)
     True
     >>>

Enum members also have a property that contains just their item name:

     >>> print(Color.RED.name)
     RED

Enumerations support iteration, in definition order:

     >>> class Shake(Enum):
     ...     VANILLA = 7
     ...     CHOCOLATE = 4
     ...     COOKIES = 9
     ...     MINT = 3
     ...
     >>> for shake in Shake:
     ...     print(shake)
     ...
     Shake.VANILLA
     Shake.CHOCOLATE
     Shake.COOKIES
     Shake.MINT

Enumeration members are hashable, so they can be used in dictionaries
and sets:

     >>> apples = {}
     >>> apples[Color.RED] = 'red delicious'
     >>> apples[Color.GREEN] = 'granny smith'
     >>> apples == {Color.RED: 'red delicious', Color.GREEN: 'granny smith'}
     True


File: python.info,  Node: Programmatic access to enumeration members and their attributes,  Next: Duplicating enum members and values,  Prev: Creating an Enum,  Up: enum — Support for enumerations

5.8.13.3 Programmatic access to enumeration members and their attributes
........................................................................

Sometimes it’s useful to access members in enumerations programmatically
(i.e.  situations where ‘Color.RED’ won’t do because the exact color is
not known at program-writing time).  ‘Enum’ allows such access:

     >>> Color(1)
     <Color.RED: 1>
     >>> Color(3)
     <Color.BLUE: 3>

If you want to access enum members by `name', use item access:

     >>> Color['RED']
     <Color.RED: 1>
     >>> Color['GREEN']
     <Color.GREEN: 2>

If you have an enum member and need its ‘name’ or ‘value’:

     >>> member = Color.RED
     >>> member.name
     'RED'
     >>> member.value
     1


File: python.info,  Node: Duplicating enum members and values,  Next: Ensuring unique enumeration values,  Prev: Programmatic access to enumeration members and their attributes,  Up: enum — Support for enumerations

5.8.13.4 Duplicating enum members and values
............................................

Having two enum members with the same name is invalid:

     >>> class Shape(Enum):
     ...     SQUARE = 2
     ...     SQUARE = 3
     ...
     Traceback (most recent call last):
     ...
     TypeError: Attempted to reuse key: 'SQUARE'

However, two enum members are allowed to have the same value.  Given two
members A and B with the same value (and A defined first), B is an alias
to A. By-value lookup of the value of A and B will return A. By-name
lookup of B will also return A:

     >>> class Shape(Enum):
     ...     SQUARE = 2
     ...     DIAMOND = 1
     ...     CIRCLE = 3
     ...     ALIAS_FOR_SQUARE = 2
     ...
     >>> Shape.SQUARE
     <Shape.SQUARE: 2>
     >>> Shape.ALIAS_FOR_SQUARE
     <Shape.SQUARE: 2>
     >>> Shape(2)
     <Shape.SQUARE: 2>

     Note: Attempting to create a member with the same name as an
     already defined attribute (another member, a method, etc.)  or
     attempting to create an attribute with the same name as a member is
     not allowed.


File: python.info,  Node: Ensuring unique enumeration values,  Next: Using automatic values,  Prev: Duplicating enum members and values,  Up: enum — Support for enumerations

5.8.13.5 Ensuring unique enumeration values
...........................................

By default, enumerations allow multiple names as aliases for the same
value.  When this behavior isn’t desired, the following decorator can be
used to ensure each value is used only once in the enumeration:

 -- Function: @enum.unique

A *note class: c5d. decorator specifically for enumerations.  It
searches an enumeration’s ‘__members__’ gathering any aliases it finds;
if any are found *note ValueError: 1f9. is raised with the details:

     >>> from enum import Enum, unique
     >>> @unique
     ... class Mistake(Enum):
     ...     ONE = 1
     ...     TWO = 2
     ...     THREE = 3
     ...     FOUR = 3
     ...
     Traceback (most recent call last):
     ...
     ValueError: duplicate values found in <enum 'Mistake'>: FOUR -> THREE


File: python.info,  Node: Using automatic values,  Next: Iteration,  Prev: Ensuring unique enumeration values,  Up: enum — Support for enumerations

5.8.13.6 Using automatic values
...............................

If the exact value is unimportant you can use *note auto: 53b.:

     >>> from enum import Enum, auto
     >>> class Color(Enum):
     ...     RED = auto()
     ...     BLUE = auto()
     ...     GREEN = auto()
     ...
     >>> list(Color)
     [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

The values are chosen by ‘_generate_next_value_()’, which can be
overridden:

     >>> class AutoName(Enum):
     ...     def _generate_next_value_(name, start, count, last_values):
     ...         return name
     ...
     >>> class Ordinal(AutoName):
     ...     NORTH = auto()
     ...     SOUTH = auto()
     ...     EAST = auto()
     ...     WEST = auto()
     ...
     >>> list(Ordinal)
     [<Ordinal.NORTH: 'NORTH'>, <Ordinal.SOUTH: 'SOUTH'>, <Ordinal.EAST: 'EAST'>, <Ordinal.WEST: 'WEST'>]

     Note: The goal of the default ‘_generate_next_value_()’ methods is
     to provide the next *note int: 184. in sequence with the last *note
     int: 184. provided, but the way it does this is an implementation
     detail and may change.


File: python.info,  Node: Iteration,  Next: Comparisons<3>,  Prev: Using automatic values,  Up: enum — Support for enumerations

5.8.13.7 Iteration
..................

Iterating over the members of an enum does not provide the aliases:

     >>> list(Shape)
     [<Shape.SQUARE: 2>, <Shape.DIAMOND: 1>, <Shape.CIRCLE: 3>]

The special attribute ‘__members__’ is a read-only ordered mapping of
names to members.  It includes all names defined in the enumeration,
including the aliases:

     >>> for name, member in Shape.__members__.items():
     ...     name, member
     ...
     ('SQUARE', <Shape.SQUARE: 2>)
     ('DIAMOND', <Shape.DIAMOND: 1>)
     ('CIRCLE', <Shape.CIRCLE: 3>)
     ('ALIAS_FOR_SQUARE', <Shape.SQUARE: 2>)

The ‘__members__’ attribute can be used for detailed programmatic access
to the enumeration members.  For example, finding all the aliases:

     >>> [name for name, member in Shape.__members__.items() if member.name != name]
     ['ALIAS_FOR_SQUARE']


File: python.info,  Node: Comparisons<3>,  Next: Allowed members and attributes of enumerations,  Prev: Iteration,  Up: enum — Support for enumerations

5.8.13.8 Comparisons
....................

Enumeration members are compared by identity:

     >>> Color.RED is Color.RED
     True
     >>> Color.RED is Color.BLUE
     False
     >>> Color.RED is not Color.BLUE
     True

Ordered comparisons between enumeration values are `not' supported.
Enum members are not integers (but see *note IntEnum: 192b. below):

     >>> Color.RED < Color.BLUE
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: '<' not supported between instances of 'Color' and 'Color'

Equality comparisons are defined though:

     >>> Color.BLUE == Color.RED
     False
     >>> Color.BLUE != Color.RED
     True
     >>> Color.BLUE == Color.BLUE
     True

Comparisons against non-enumeration values will always compare not equal
(again, *note IntEnum: 582. was explicitly designed to behave
differently, see below):

     >>> Color.BLUE == 2
     False


File: python.info,  Node: Allowed members and attributes of enumerations,  Next: Restricted Enum subclassing,  Prev: Comparisons<3>,  Up: enum — Support for enumerations

5.8.13.9 Allowed members and attributes of enumerations
.......................................................

The examples above use integers for enumeration values.  Using integers
is short and handy (and provided by default by the *note Functional API:
1922.), but not strictly enforced.  In the vast majority of use-cases,
one doesn’t care what the actual value of an enumeration is.  But if the
value `is' important, enumerations can have arbitrary values.

Enumerations are Python classes, and can have methods and special
methods as usual.  If we have this enumeration:

     >>> class Mood(Enum):
     ...     FUNKY = 1
     ...     HAPPY = 3
     ...
     ...     def describe(self):
     ...         # self is the member here
     ...         return self.name, self.value
     ...
     ...     def __str__(self):
     ...         return 'my custom str! {0}'.format(self.value)
     ...
     ...     @classmethod
     ...     def favorite_mood(cls):
     ...         # cls here is the enumeration
     ...         return cls.HAPPY
     ...

Then:

     >>> Mood.favorite_mood()
     <Mood.HAPPY: 3>
     >>> Mood.HAPPY.describe()
     ('HAPPY', 3)
     >>> str(Mood.FUNKY)
     'my custom str! 1'

The rules for what is allowed are as follows: names that start and end
with a single underscore are reserved by enum and cannot be used; all
other attributes defined within an enumeration will become members of
this enumeration, with the exception of special methods (*note
__str__(): e2a, *note __add__(): 1393, etc.), descriptors (methods are
also descriptors), and variable names listed in ‘_ignore_’.

Note: if your enumeration defines *note __new__(): 87d. and/or *note
__init__(): d51. then whatever value(s) were given to the enum member
will be passed into those methods.  See *note Planet: 192d. for an
example.


File: python.info,  Node: Restricted Enum subclassing,  Next: Pickling,  Prev: Allowed members and attributes of enumerations,  Up: enum — Support for enumerations

5.8.13.10 Restricted Enum subclassing
.....................................

A new *note Enum: 37c. class must have one base Enum class, up to one
concrete data type, and as many *note object: 2ae.-based mixin classes
as needed.  The order of these base classes is:

     class EnumName([mix-in, ...,] [data-type,] base-enum):
         pass

Also, subclassing an enumeration is allowed only if the enumeration does
not define any members.  So this is forbidden:

     >>> class MoreColor(Color):
     ...     PINK = 17
     ...
     Traceback (most recent call last):
     ...
     TypeError: Cannot extend enumerations

But this is allowed:

     >>> class Foo(Enum):
     ...     def some_behavior(self):
     ...         pass
     ...
     >>> class Bar(Foo):
     ...     HAPPY = 1
     ...     SAD = 2
     ...

Allowing subclassing of enums that define members would lead to a
violation of some important invariants of types and instances.  On the
other hand, it makes sense to allow sharing some common behavior between
a group of enumerations.  (See *note OrderedEnum: 192f. for an example.)


File: python.info,  Node: Pickling,  Next: Functional API,  Prev: Restricted Enum subclassing,  Up: enum — Support for enumerations

5.8.13.11 Pickling
..................

Enumerations can be pickled and unpickled:

     >>> from test.test_enum import Fruit
     >>> from pickle import dumps, loads
     >>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
     True

The usual restrictions for pickling apply: picklable enums must be
defined in the top level of a module, since unpickling requires them to
be importable from that module.

     Note: With pickle protocol version 4 it is possible to easily
     pickle enums nested in other classes.

It is possible to modify how Enum members are pickled/unpickled by
defining *note __reduce_ex__(): 1931. in the enumeration class.


File: python.info,  Node: Functional API,  Next: Derived Enumerations,  Prev: Pickling,  Up: enum — Support for enumerations

5.8.13.12 Functional API
........................

The *note Enum: 37c. class is callable, providing the following
functional API:

     >>> Animal = Enum('Animal', 'ANT BEE CAT DOG')
     >>> Animal
     <enum 'Animal'>
     >>> Animal.ANT
     <Animal.ANT: 1>
     >>> Animal.ANT.value
     1
     >>> list(Animal)
     [<Animal.ANT: 1>, <Animal.BEE: 2>, <Animal.CAT: 3>, <Animal.DOG: 4>]

The semantics of this API resemble *note namedtuple: 1b5.  The first
argument of the call to *note Enum: 37c. is the name of the enumeration.

The second argument is the `source' of enumeration member names.  It can
be a whitespace-separated string of names, a sequence of names, a
sequence of 2-tuples with key/value pairs, or a mapping (e.g.
dictionary) of names to values.  The last two options enable assigning
arbitrary values to enumerations; the others auto-assign increasing
integers starting with 1 (use the ‘start’ parameter to specify a
different starting value).  A new class derived from *note Enum: 37c. is
returned.  In other words, the above assignment to ‘Animal’ is
equivalent to:

     >>> class Animal(Enum):
     ...     ANT = 1
     ...     BEE = 2
     ...     CAT = 3
     ...     DOG = 4
     ...

The reason for defaulting to ‘1’ as the starting number and not ‘0’ is
that ‘0’ is ‘False’ in a boolean sense, but enum members all evaluate to
‘True’.

Pickling enums created with the functional API can be tricky as frame
stack implementation details are used to try and figure out which module
the enumeration is being created in (e.g.  it will fail if you use a
utility function in separate module, and also may not work on IronPython
or Jython).  The solution is to specify the module name explicitly as
follows:

     >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__)

     Warning: If ‘module’ is not supplied, and Enum cannot determine
     what it is, the new Enum members will not be unpicklable; to keep
     errors closer to the source, pickling will be disabled.

The new pickle protocol 4 also, in some circumstances, relies on *note
__qualname__: 1365. being set to the location where pickle will be able
to find the class.  For example, if the class was made available in
class SomeData in the global scope:

     >>> Animal = Enum('Animal', 'ANT BEE CAT DOG', qualname='SomeData.Animal')

The complete signature is:

     Enum(value='NewEnumName', names=<...>, *, module='...', qualname='...', type=<mixed-in class>, start=1)


value: What the new Enum class will record as its name.


names: The Enum members.  This can be a whitespace or comma separated
string (values will start at 1 unless otherwise specified):

     'RED GREEN BLUE' | 'RED,GREEN,BLUE' | 'RED, GREEN, BLUE'

or an iterator of names:

     ['RED', 'GREEN', 'BLUE']

or an iterator of (name, value) pairs:

     [('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)]

or a mapping:

     {'CHARTREUSE': 7, 'SEA_GREEN': 11, 'ROSEMARY': 42}


module: name of module where new Enum class can be found.


qualname: where in module new Enum class can be found.


type: type to mix in to new Enum class.


start: number to start counting at if only names are passed in.

Changed in version 3.5: The `start' parameter was added.


File: python.info,  Node: Derived Enumerations,  Next: When to use __new__ vs __init__,  Prev: Functional API,  Up: enum — Support for enumerations

5.8.13.13 Derived Enumerations
..............................

* Menu:

* IntEnum::
* IntFlag::
* Flag::
* Others::


File: python.info,  Node: IntEnum,  Next: IntFlag,  Up: Derived Enumerations

5.8.13.14 IntEnum
.................

The first variation of *note Enum: 37c. that is provided is also a
subclass of *note int: 184.  Members of an *note IntEnum: 582. can be
compared to integers; by extension, integer enumerations of different
types can also be compared to each other:

     >>> from enum import IntEnum
     >>> class Shape(IntEnum):
     ...     CIRCLE = 1
     ...     SQUARE = 2
     ...
     >>> class Request(IntEnum):
     ...     POST = 1
     ...     GET = 2
     ...
     >>> Shape == 1
     False
     >>> Shape.CIRCLE == 1
     True
     >>> Shape.CIRCLE == Request.POST
     True

However, they still can’t be compared to standard *note Enum: 37c.
enumerations:

     >>> class Shape(IntEnum):
     ...     CIRCLE = 1
     ...     SQUARE = 2
     ...
     >>> class Color(Enum):
     ...     RED = 1
     ...     GREEN = 2
     ...
     >>> Shape.CIRCLE == Color.RED
     False

*note IntEnum: 582. values behave like integers in other ways you’d
expect:

     >>> int(Shape.CIRCLE)
     1
     >>> ['a', 'b', 'c'][Shape.CIRCLE]
     'b'
     >>> [i for i in range(Shape.SQUARE)]
     [0, 1]


File: python.info,  Node: IntFlag,  Next: Flag,  Prev: IntEnum,  Up: Derived Enumerations

5.8.13.15 IntFlag
.................

The next variation of *note Enum: 37c. provided, *note IntFlag: 1693, is
also based on *note int: 184.  The difference being *note IntFlag: 1693.
members can be combined using the bitwise operators (&, |, ^, ~) and the
result is still an *note IntFlag: 1693. member.  However, as the name
implies, *note IntFlag: 1693. members also subclass *note int: 184. and
can be used wherever an *note int: 184. is used.  Any operation on an
*note IntFlag: 1693. member besides the bit-wise operations will lose
the *note IntFlag: 1693. membership.

New in version 3.6.

Sample *note IntFlag: 1693. class:

     >>> from enum import IntFlag
     >>> class Perm(IntFlag):
     ...     R = 4
     ...     W = 2
     ...     X = 1
     ...
     >>> Perm.R | Perm.W
     <Perm.R|W: 6>
     >>> Perm.R + Perm.W
     6
     >>> RW = Perm.R | Perm.W
     >>> Perm.R in RW
     True

It is also possible to name the combinations:

     >>> class Perm(IntFlag):
     ...     R = 4
     ...     W = 2
     ...     X = 1
     ...     RWX = 7
     >>> Perm.RWX
     <Perm.RWX: 7>
     >>> ~Perm.RWX
     <Perm.-8: -8>

Another important difference between *note IntFlag: 1693. and *note
Enum: 37c. is that if no flags are set (the value is 0), its boolean
evaluation is *note False: 37d.:

     >>> Perm.R & Perm.X
     <Perm.0: 0>
     >>> bool(Perm.R & Perm.X)
     False

Because *note IntFlag: 1693. members are also subclasses of *note int:
184. they can be combined with them:

     >>> Perm.X | 8
     <Perm.8|X: 9>


File: python.info,  Node: Flag,  Next: Others,  Prev: IntFlag,  Up: Derived Enumerations

5.8.13.16 Flag
..............

The last variation is *note Flag: 53a.  Like *note IntFlag: 1693, *note
Flag: 53a. members can be combined using the bitwise operators (&, |, ^,
~).  Unlike *note IntFlag: 1693, they cannot be combined with, nor
compared against, any other *note Flag: 53a. enumeration, nor *note int:
184.  While it is possible to specify the values directly it is
recommended to use *note auto: 53b. as the value and let *note Flag:
53a. select an appropriate value.

New in version 3.6.

Like *note IntFlag: 1693, if a combination of *note Flag: 53a. members
results in no flags being set, the boolean evaluation is *note False:
37d.:

     >>> from enum import Flag, auto
     >>> class Color(Flag):
     ...     RED = auto()
     ...     BLUE = auto()
     ...     GREEN = auto()
     ...
     >>> Color.RED & Color.GREEN
     <Color.0: 0>
     >>> bool(Color.RED & Color.GREEN)
     False

Individual flags should have values that are powers of two (1, 2, 4, 8,
…), while combinations of flags won’t:

     >>> class Color(Flag):
     ...     RED = auto()
     ...     BLUE = auto()
     ...     GREEN = auto()
     ...     WHITE = RED | BLUE | GREEN
     ...
     >>> Color.WHITE
     <Color.WHITE: 7>

Giving a name to the “no flags set” condition does not change its
boolean value:

     >>> class Color(Flag):
     ...     BLACK = 0
     ...     RED = auto()
     ...     BLUE = auto()
     ...     GREEN = auto()
     ...
     >>> Color.BLACK
     <Color.BLACK: 0>
     >>> bool(Color.BLACK)
     False

     Note: For the majority of new code, *note Enum: 37c. and *note
     Flag: 53a. are strongly recommended, since *note IntEnum: 582. and
     *note IntFlag: 1693. break some semantic promises of an enumeration
     (by being comparable to integers, and thus by transitivity to other
     unrelated enumerations).  *note IntEnum: 582. and *note IntFlag:
     1693. should be used only in cases where *note Enum: 37c. and *note
     Flag: 53a. will not do; for example, when integer constants are
     replaced with enumerations, or for interoperability with other
     systems.


File: python.info,  Node: Others,  Prev: Flag,  Up: Derived Enumerations

5.8.13.17 Others
................

While *note IntEnum: 582. is part of the *note enum: 7b. module, it
would be very simple to implement independently:

     class IntEnum(int, Enum):
         pass

This demonstrates how similar derived enumerations can be defined; for
example a ‘StrEnum’ that mixes in *note str: 325. instead of *note int:
184.

Some rules:

  1. When subclassing *note Enum: 37c, mix-in types must appear before
     *note Enum: 37c. itself in the sequence of bases, as in the *note
     IntEnum: 582. example above.

  2. While *note Enum: 37c. can have members of any type, once you mix
     in an additional type, all the members must have values of that
     type, e.g.  *note int: 184. above.  This restriction does not apply
     to mix-ins which only add methods and don’t specify another data
     type such as *note int: 184. or *note str: 325.

  3. When another data type is mixed in, the ‘value’ attribute is `not
     the same' as the enum member itself, although it is equivalent and
     will compare equal.

  4. %-style formatting: ‘%s’ and ‘%r’ call the *note Enum: 37c. class’s
     *note __str__(): e2a. and *note __repr__(): 333. respectively;
     other codes (such as ‘%i’ or ‘%h’ for IntEnum) treat the enum
     member as its mixed-in type.

  5. *note Formatted string literals: 15c, *note str.format(): 4cf, and
     *note format(): 4d0. will use the mixed-in type’s *note
     __format__(): 942.  If the *note Enum: 37c. class’s *note str():
     325. or *note repr(): 7c0. is desired, use the ‘!s’ or ‘!r’ format
     codes.


File: python.info,  Node: When to use __new__ vs __init__,  Next: Interesting examples,  Prev: Derived Enumerations,  Up: enum — Support for enumerations

5.8.13.18 When to use ‘__new__()’ vs. ‘__init__()’
..................................................

*note __new__(): 87d. must be used whenever you want to customize the
actual value of the *note Enum: 37c. member.  Any other modifications
may go in either *note __new__(): 87d. or *note __init__(): d51, with
*note __init__(): d51. being preferred.

For example, if you want to pass several items to the constructor, but
only want one of them to be the value:

     >>> class Coordinate(bytes, Enum):
     ...     """
     ...     Coordinate with binary codes that can be indexed by the int code.
     ...     """
     ...     def __new__(cls, value, label, unit):
     ...         obj = bytes.__new__(cls, [value])
     ...         obj._value_ = value
     ...         obj.label = label
     ...         obj.unit = unit
     ...         return obj
     ...     PX = (0, 'P.X', 'km')
     ...     PY = (1, 'P.Y', 'km')
     ...     VX = (2, 'V.X', 'km/s')
     ...     VY = (3, 'V.Y', 'km/s')
     ...

     >>> print(Coordinate['PY'])
     Coordinate.PY

     >>> print(Coordinate(3))
     Coordinate.VY


File: python.info,  Node: Interesting examples,  Next: How are Enums different?,  Prev: When to use __new__ vs __init__,  Up: enum — Support for enumerations

5.8.13.19 Interesting examples
..............................

While *note Enum: 37c, *note IntEnum: 582, *note IntFlag: 1693, and
*note Flag: 53a. are expected to cover the majority of use-cases, they
cannot cover them all.  Here are recipes for some different types of
enumerations that can be used directly, or as examples for creating
one’s own.

* Menu:

* Omitting values::
* OrderedEnum::
* DuplicateFreeEnum::
* Planet::
* TimePeriod::


File: python.info,  Node: Omitting values,  Next: OrderedEnum,  Up: Interesting examples

5.8.13.20 Omitting values
.........................

In many use-cases one doesn’t care what the actual value of an
enumeration is.  There are several ways to define this type of simple
enumeration:

   - use instances of *note auto: 53b. for the value

   - use instances of *note object: 2ae. as the value

   - use a descriptive string as the value

   - use a tuple as the value and a custom *note __new__(): 87d. to
     replace the tuple with an *note int: 184. value

Using any of these methods signifies to the user that these values are
not important, and also enables one to add, remove, or reorder members
without having to renumber the remaining members.

Whichever method you choose, you should provide a *note repr(): 7c0.
that also hides the (unimportant) value:

     >>> class NoValue(Enum):
     ...     def __repr__(self):
     ...         return '<%s.%s>' % (self.__class__.__name__, self.name)
     ...

* Menu:

* Using auto::
* Using object::
* Using a descriptive string::
* Using a custom __new__(): Using a custom __new__.


File: python.info,  Node: Using auto,  Next: Using object,  Up: Omitting values

5.8.13.21 Using ‘auto’
......................

Using *note auto: 53b. would look like:

     >>> class Color(NoValue):
     ...     RED = auto()
     ...     BLUE = auto()
     ...     GREEN = auto()
     ...
     >>> Color.GREEN
     <Color.GREEN>


File: python.info,  Node: Using object,  Next: Using a descriptive string,  Prev: Using auto,  Up: Omitting values

5.8.13.22 Using ‘object’
........................

Using *note object: 2ae. would look like:

     >>> class Color(NoValue):
     ...     RED = object()
     ...     GREEN = object()
     ...     BLUE = object()
     ...
     >>> Color.GREEN
     <Color.GREEN>


File: python.info,  Node: Using a descriptive string,  Next: Using a custom __new__,  Prev: Using object,  Up: Omitting values

5.8.13.23 Using a descriptive string
....................................

Using a string as the value would look like:

     >>> class Color(NoValue):
     ...     RED = 'stop'
     ...     GREEN = 'go'
     ...     BLUE = 'too fast!'
     ...
     >>> Color.GREEN
     <Color.GREEN>
     >>> Color.GREEN.value
     'go'


File: python.info,  Node: Using a custom __new__,  Prev: Using a descriptive string,  Up: Omitting values

5.8.13.24 Using a custom ‘__new__()’
....................................

Using an auto-numbering *note __new__(): 87d. would look like:

     >>> class AutoNumber(NoValue):
     ...     def __new__(cls):
     ...         value = len(cls.__members__) + 1
     ...         obj = object.__new__(cls)
     ...         obj._value_ = value
     ...         return obj
     ...
     >>> class Color(AutoNumber):
     ...     RED = ()
     ...     GREEN = ()
     ...     BLUE = ()
     ...
     >>> Color.GREEN
     <Color.GREEN>
     >>> Color.GREEN.value
     2

     Note: The *note __new__(): 87d. method, if defined, is used during
     creation of the Enum members; it is then replaced by Enum’s *note
     __new__(): 87d. which is used after class creation for lookup of
     existing members.


File: python.info,  Node: OrderedEnum,  Next: DuplicateFreeEnum,  Prev: Omitting values,  Up: Interesting examples

5.8.13.25 OrderedEnum
.....................

An ordered enumeration that is not based on *note IntEnum: 582. and so
maintains the normal *note Enum: 37c. invariants (such as not being
comparable to other enumerations):

     >>> class OrderedEnum(Enum):
     ...     def __ge__(self, other):
     ...         if self.__class__ is other.__class__:
     ...             return self.value >= other.value
     ...         return NotImplemented
     ...     def __gt__(self, other):
     ...         if self.__class__ is other.__class__:
     ...             return self.value > other.value
     ...         return NotImplemented
     ...     def __le__(self, other):
     ...         if self.__class__ is other.__class__:
     ...             return self.value <= other.value
     ...         return NotImplemented
     ...     def __lt__(self, other):
     ...         if self.__class__ is other.__class__:
     ...             return self.value < other.value
     ...         return NotImplemented
     ...
     >>> class Grade(OrderedEnum):
     ...     A = 5
     ...     B = 4
     ...     C = 3
     ...     D = 2
     ...     F = 1
     ...
     >>> Grade.C < Grade.A
     True


File: python.info,  Node: DuplicateFreeEnum,  Next: Planet,  Prev: OrderedEnum,  Up: Interesting examples

5.8.13.26 DuplicateFreeEnum
...........................

Raises an error if a duplicate member name is found instead of creating
an alias:

     >>> class DuplicateFreeEnum(Enum):
     ...     def __init__(self, *args):
     ...         cls = self.__class__
     ...         if any(self.value == e.value for e in cls):
     ...             a = self.name
     ...             e = cls(self.value).name
     ...             raise ValueError(
     ...                 "aliases not allowed in DuplicateFreeEnum:  %r --> %r"
     ...                 % (a, e))
     ...
     >>> class Color(DuplicateFreeEnum):
     ...     RED = 1
     ...     GREEN = 2
     ...     BLUE = 3
     ...     GRENE = 2
     ...
     Traceback (most recent call last):
     ...
     ValueError: aliases not allowed in DuplicateFreeEnum:  'GRENE' --> 'GREEN'

     Note: This is a useful example for subclassing Enum to add or
     change other behaviors as well as disallowing aliases.  If the only
     desired change is disallowing aliases, the *note unique(): 1921.
     decorator can be used instead.


File: python.info,  Node: Planet,  Next: TimePeriod,  Prev: DuplicateFreeEnum,  Up: Interesting examples

5.8.13.27 Planet
................

If *note __new__(): 87d. or *note __init__(): d51. is defined the value
of the enum member will be passed to those methods:

     >>> class Planet(Enum):
     ...     MERCURY = (3.303e+23, 2.4397e6)
     ...     VENUS   = (4.869e+24, 6.0518e6)
     ...     EARTH   = (5.976e+24, 6.37814e6)
     ...     MARS    = (6.421e+23, 3.3972e6)
     ...     JUPITER = (1.9e+27,   7.1492e7)
     ...     SATURN  = (5.688e+26, 6.0268e7)
     ...     URANUS  = (8.686e+25, 2.5559e7)
     ...     NEPTUNE = (1.024e+26, 2.4746e7)
     ...     def __init__(self, mass, radius):
     ...         self.mass = mass       # in kilograms
     ...         self.radius = radius   # in meters
     ...     @property
     ...     def surface_gravity(self):
     ...         # universal gravitational constant  (m3 kg-1 s-2)
     ...         G = 6.67300E-11
     ...         return G * self.mass / (self.radius * self.radius)
     ...
     >>> Planet.EARTH.value
     (5.976e+24, 6378140.0)
     >>> Planet.EARTH.surface_gravity
     9.802652743337129


File: python.info,  Node: TimePeriod,  Prev: Planet,  Up: Interesting examples

5.8.13.28 TimePeriod
....................

An example to show the ‘_ignore_’ attribute in use:

     >>> from datetime import timedelta
     >>> class Period(timedelta, Enum):
     ...     "different lengths of time"
     ...     _ignore_ = 'Period i'
     ...     Period = vars()
     ...     for i in range(367):
     ...         Period['day_%d' % i] = i
     ...
     >>> list(Period)[:2]
     [<Period.day_0: datetime.timedelta(0)>, <Period.day_1: datetime.timedelta(days=1)>]
     >>> list(Period)[-2:]
     [<Period.day_365: datetime.timedelta(days=365)>, <Period.day_366: datetime.timedelta(days=366)>]


File: python.info,  Node: How are Enums different?,  Prev: Interesting examples,  Up: enum — Support for enumerations

5.8.13.29 How are Enums different?
..................................

Enums have a custom metaclass that affects many aspects of both derived
Enum classes and their instances (members).

* Menu:

* Enum Classes::
* Enum Members (aka instances): Enum Members aka instances.
* Finer Points::


File: python.info,  Node: Enum Classes,  Next: Enum Members aka instances,  Up: How are Enums different?

5.8.13.30 Enum Classes
......................

The ‘EnumMeta’ metaclass is responsible for providing the *note
__contains__(): d1b, *note __dir__(): 310, *note __iter__(): 504. and
other methods that allow one to do things with an *note Enum: 37c. class
that fail on a typical class, such as ‘list(Color)’ or ‘some_enum_var in
Color’.  ‘EnumMeta’ is responsible for ensuring that various other
methods on the final *note Enum: 37c. class are correct (such as *note
__new__(): 87d, *note __getnewargs__(): 6a2, *note __str__(): e2a. and
*note __repr__(): 333.).


File: python.info,  Node: Enum Members aka instances,  Next: Finer Points,  Prev: Enum Classes,  Up: How are Enums different?

5.8.13.31 Enum Members (aka instances)
......................................

The most interesting thing about Enum members is that they are
singletons.  ‘EnumMeta’ creates them all while it is creating the *note
Enum: 37c. class itself, and then puts a custom *note __new__(): 87d. in
place to ensure that no new ones are ever instantiated by returning only
the existing member instances.


File: python.info,  Node: Finer Points,  Prev: Enum Members aka instances,  Up: How are Enums different?

5.8.13.32 Finer Points
......................

* Menu:

* Supported __dunder__ names::
* Supported _sunder_ names::
* Enum member type::
* Boolean value of Enum classes and members::
* Enum classes with methods::
* Combining members of Flag::


File: python.info,  Node: Supported __dunder__ names,  Next: Supported _sunder_ names,  Up: Finer Points

5.8.13.33 Supported ‘__dunder__’ names
......................................

‘__members__’ is a read-only ordered mapping of ‘member_name’:‘member’
items.  It is only available on the class.

*note __new__(): 87d, if specified, must create and return the enum
members; it is also a very good idea to set the member’s ‘_value_’
appropriately.  Once all the members are created it is no longer used.


File: python.info,  Node: Supported _sunder_ names,  Next: Enum member type,  Prev: Supported __dunder__ names,  Up: Finer Points

5.8.13.34 Supported ‘_sunder_’ names
....................................

   - ‘_name_’ – name of the member

   - ‘_value_’ – value of the member; can be set / modified in ‘__new__’

   - ‘_missing_’ – a lookup function used when a value is not found; may
     be overridden

   - ‘_ignore_’ – a list of names, either as a *note list(): 260. or a
     *note str(): 325, that will not be transformed into members, and
     will be removed from the final class

   - ‘_order_’ – used in Python 2/3 code to ensure member order is
     consistent (class attribute, removed during class creation)

   - ‘_generate_next_value_’ – used by the *note Functional API: 1922.
     and by *note auto: 53b. to get an appropriate value for an enum
     member; may be overridden

New in version 3.6: ‘_missing_’, ‘_order_’, ‘_generate_next_value_’

New in version 3.7: ‘_ignore_’

To help keep Python 2 / Python 3 code in sync an ‘_order_’ attribute can
be provided.  It will be checked against the actual order of the
enumeration and raise an error if the two do not match:

     >>> class Color(Enum):
     ...     _order_ = 'RED GREEN BLUE'
     ...     RED = 1
     ...     BLUE = 3
     ...     GREEN = 2
     ...
     Traceback (most recent call last):
     ...
     TypeError: member order does not match _order_

     Note: In Python 2 code the ‘_order_’ attribute is necessary as
     definition order is lost before it can be recorded.


File: python.info,  Node: Enum member type,  Next: Boolean value of Enum classes and members,  Prev: Supported _sunder_ names,  Up: Finer Points

5.8.13.35 ‘Enum’ member type
............................

*note Enum: 37c. members are instances of their *note Enum: 37c. class,
and are normally accessed as ‘EnumClass.member’.  Under certain
circumstances they can also be accessed as ‘EnumClass.member.member’,
but you should never do this as that lookup may fail or, worse, return
something besides the *note Enum: 37c. member you are looking for (this
is another good reason to use all-uppercase names for members):

     >>> class FieldTypes(Enum):
     ...     name = 0
     ...     value = 1
     ...     size = 2
     ...
     >>> FieldTypes.value.size
     <FieldTypes.size: 2>
     >>> FieldTypes.size.value
     2

Changed in version 3.5.


File: python.info,  Node: Boolean value of Enum classes and members,  Next: Enum classes with methods,  Prev: Enum member type,  Up: Finer Points

5.8.13.36 Boolean value of ‘Enum’ classes and members
.....................................................

*note Enum: 37c. members that are mixed with non-*note Enum: 37c. types
(such as *note int: 184, *note str: 325, etc.)  are evaluated according
to the mixed-in type’s rules; otherwise, all members evaluate as *note
True: 48f.  To make your own Enum’s boolean evaluation depend on the
member’s value add the following to your class:

     def __bool__(self):
         return bool(self.value)

*note Enum: 37c. classes always evaluate as *note True: 48f.


File: python.info,  Node: Enum classes with methods,  Next: Combining members of Flag,  Prev: Boolean value of Enum classes and members,  Up: Finer Points

5.8.13.37 ‘Enum’ classes with methods
.....................................

If you give your *note Enum: 37c. subclass extra methods, like the *note
Planet: 192d. class above, those methods will show up in a *note dir():
d26. of the member, but not of the class:

     >>> dir(Planet)
     ['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__']
     >>> dir(Planet.EARTH)
     ['__class__', '__doc__', '__module__', 'name', 'surface_gravity', 'value']


File: python.info,  Node: Combining members of Flag,  Prev: Enum classes with methods,  Up: Finer Points

5.8.13.38 Combining members of ‘Flag’
.....................................

If a combination of Flag members is not named, the *note repr(): 7c0.
will include all named flags and all named combinations of flags that
are in the value:

     >>> class Color(Flag):
     ...     RED = auto()
     ...     GREEN = auto()
     ...     BLUE = auto()
     ...     MAGENTA = RED | BLUE
     ...     YELLOW = RED | GREEN
     ...     CYAN = GREEN | BLUE
     ...
     >>> Color(3)  # named combination
     <Color.YELLOW: 3>
     >>> Color(7)      # not named combination
     <Color.CYAN|MAGENTA|BLUE|YELLOW|GREEN|RED: 7>


File: python.info,  Node: Numeric and Mathematical Modules,  Next: Functional Programming Modules,  Prev: Data Types,  Up: The Python Standard Library

5.9 Numeric and Mathematical Modules
====================================

The modules described in this chapter provide numeric and math-related
functions and data types.  The *note numbers: c1. module defines an
abstract hierarchy of numeric types.  The *note math: b1. and *note
cmath: 19. modules contain various mathematical functions for
floating-point and complex numbers.  The *note decimal: 36. module
supports exact representations of decimal numbers, using arbitrary
precision arithmetic.

The following modules are documented in this chapter:

* Menu:

* numbers — Numeric abstract base classes::
* math — Mathematical functions::
* cmath — Mathematical functions for complex numbers::
* decimal — Decimal fixed point and floating point arithmetic::
* fractions — Rational numbers::
* random — Generate pseudo-random numbers::
* statistics — Mathematical statistics functions::


File: python.info,  Node: numbers — Numeric abstract base classes,  Next: math — Mathematical functions,  Up: Numeric and Mathematical Modules

5.9.1 ‘numbers’ — Numeric abstract base classes
-----------------------------------------------

`Source code:' Lib/numbers.py(1)

__________________________________________________________________

The *note numbers: c1. module ( PEP 3141(2)) defines a hierarchy of
numeric *note abstract base classes: b26. which progressively define
more operations.  None of the types defined in this module can be
instantiated.

 -- Class: numbers.Number

     The root of the numeric hierarchy.  If you just want to check if an
     argument `x' is a number, without caring what kind, use
     ‘isinstance(x, Number)’.

* Menu:

* The numeric tower::
* Notes for type implementors::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/numbers.py

   (2) https://www.python.org/dev/peps/pep-3141


File: python.info,  Node: The numeric tower,  Next: Notes for type implementors,  Up: numbers — Numeric abstract base classes

5.9.1.1 The numeric tower
.........................

 -- Class: numbers.Complex

     Subclasses of this type describe complex numbers and include the
     operations that work on the built-in *note complex: 189. type.
     These are: conversions to *note complex: 189. and *note bool: 183,
     *note real: 194e, *note imag: 194f, ‘+’, ‘-’, ‘*’, ‘/’, *note
     abs(): 11f8, *note conjugate(): 1950, ‘==’, and ‘!=’.  All except
     ‘-’ and ‘!=’ are abstract.

      -- Attribute: real

          Abstract.  Retrieves the real component of this number.

      -- Attribute: imag

          Abstract.  Retrieves the imaginary component of this number.

      -- Method: abstractmethod conjugate ()

          Abstract.  Returns the complex conjugate.  For example,
          ‘(1+3j).conjugate() == (1-3j)’.

 -- Class: numbers.Real

     To *note Complex: 1361, *note Real: 1360. adds the operations that
     work on real numbers.

     In short, those are: a conversion to *note float: 187, *note
     math.trunc(): d21, *note round(): c60, *note math.floor(): d1f,
     *note math.ceil(): d20, *note divmod(): f4d, ‘//’, ‘%’, ‘<’, ‘<=’,
     ‘>’, and ‘>=’.

     Real also provides defaults for *note complex(): 189, *note real:
     194e, *note imag: 194f, and *note conjugate(): 1950.

 -- Class: numbers.Rational

     Subtypes *note Real: 1360. and adds *note numerator: 1951. and
     *note denominator: 1952. properties, which should be in lowest
     terms.  With these, it provides a default for *note float(): 187.

      -- Attribute: numerator

          Abstract.

      -- Attribute: denominator

          Abstract.

 -- Class: numbers.Integral

     Subtypes *note Rational: c4b. and adds a conversion to *note int:
     184.  Provides defaults for *note float(): 187, *note numerator:
     1951, and *note denominator: 1952.  Adds abstract methods for ‘**’
     and bit-string operations: ‘<<’, ‘>>’, ‘&’, ‘^’, ‘|’, ‘~’.


File: python.info,  Node: Notes for type implementors,  Prev: The numeric tower,  Up: numbers — Numeric abstract base classes

5.9.1.2 Notes for type implementors
...................................

Implementors should be careful to make equal numbers equal and hash them
to the same values.  This may be subtle if there are two different
extensions of the real numbers.  For example, *note fractions.Fraction:
185. implements *note hash(): 9b8. as follows:

     def __hash__(self):
         if self.denominator == 1:
             # Get integers right.
             return hash(self.numerator)
         # Expensive check, but definitely correct.
         if self == float(self):
             return hash(float(self))
         else:
             # Use tuple's hash to avoid a high collision rate on
             # simple fractions.
             return hash((self.numerator, self.denominator))

* Menu:

* Adding More Numeric ABCs::
* Implementing the arithmetic operations::


File: python.info,  Node: Adding More Numeric ABCs,  Next: Implementing the arithmetic operations,  Up: Notes for type implementors

5.9.1.3 Adding More Numeric ABCs
................................

There are, of course, more possible ABCs for numbers, and this would be
a poor hierarchy if it precluded the possibility of adding those.  You
can add ‘MyFoo’ between *note Complex: 1361. and *note Real: 1360. with:

     class MyFoo(Complex): ...
     MyFoo.register(Real)


File: python.info,  Node: Implementing the arithmetic operations,  Prev: Adding More Numeric ABCs,  Up: Notes for type implementors

5.9.1.4 Implementing the arithmetic operations
..............................................

We want to implement the arithmetic operations so that mixed-mode
operations either call an implementation whose author knew about the
types of both arguments, or convert both to the nearest built in type
and do the operation there.  For subtypes of *note Integral: 135f, this
means that *note __add__(): 1393. and *note __radd__(): 1394. should be
defined as:

     class MyIntegral(Integral):

         def __add__(self, other):
             if isinstance(other, MyIntegral):
                 return do_my_adding_stuff(self, other)
             elif isinstance(other, OtherTypeIKnowAbout):
                 return do_my_other_adding_stuff(self, other)
             else:
                 return NotImplemented

         def __radd__(self, other):
             if isinstance(other, MyIntegral):
                 return do_my_adding_stuff(other, self)
             elif isinstance(other, OtherTypeIKnowAbout):
                 return do_my_other_adding_stuff(other, self)
             elif isinstance(other, Integral):
                 return int(other) + int(self)
             elif isinstance(other, Real):
                 return float(other) + float(self)
             elif isinstance(other, Complex):
                 return complex(other) + complex(self)
             else:
                 return NotImplemented

There are 5 different cases for a mixed-type operation on subclasses of
*note Complex: 1361.  I’ll refer to all of the above code that doesn’t
refer to ‘MyIntegral’ and ‘OtherTypeIKnowAbout’ as “boilerplate”.  ‘a’
will be an instance of ‘A’, which is a subtype of *note Complex: 1361.
(‘a : A <: Complex’), and ‘b : B <: Complex’.  I’ll consider ‘a + b’:

       1. If ‘A’ defines an *note __add__(): 1393. which accepts ‘b’,
          all is well.

       2. If ‘A’ falls back to the boilerplate code, and it were to
          return a value from *note __add__(): 1393, we’d miss the
          possibility that ‘B’ defines a more intelligent *note
          __radd__(): 1394, so the boilerplate should return *note
          NotImplemented: 840. from *note __add__(): 1393.  (Or ‘A’ may
          not implement *note __add__(): 1393. at all.)

       3. Then ‘B’’s *note __radd__(): 1394. gets a chance.  If it
          accepts ‘a’, all is well.

       4. If it falls back to the boilerplate, there are no more
          possible methods to try, so this is where the default
          implementation should live.

       5. If ‘B <: A’, Python tries ‘B.__radd__’ before ‘A.__add__’.
          This is ok, because it was implemented with knowledge of ‘A’,
          so it can handle those instances before delegating to *note
          Complex: 1361.

If ‘A <: Complex’ and ‘B <: Real’ without sharing any other knowledge,
then the appropriate shared operation is the one involving the built in
*note complex: 189, and both *note __radd__(): 1394. s land there, so
‘a+b == b+a’.

Because most of the operations on any given type will be very similar,
it can be useful to define a helper function which generates the forward
and reverse instances of any given operator.  For example, *note
fractions.Fraction: 185. uses:

     def _operator_fallbacks(monomorphic_operator, fallback_operator):
         def forward(a, b):
             if isinstance(b, (int, Fraction)):
                 return monomorphic_operator(a, b)
             elif isinstance(b, float):
                 return fallback_operator(float(a), b)
             elif isinstance(b, complex):
                 return fallback_operator(complex(a), b)
             else:
                 return NotImplemented
         forward.__name__ = '__' + fallback_operator.__name__ + '__'
         forward.__doc__ = monomorphic_operator.__doc__

         def reverse(b, a):
             if isinstance(a, Rational):
                 # Includes ints.
                 return monomorphic_operator(a, b)
             elif isinstance(a, numbers.Real):
                 return fallback_operator(float(a), float(b))
             elif isinstance(a, numbers.Complex):
                 return fallback_operator(complex(a), complex(b))
             else:
                 return NotImplemented
         reverse.__name__ = '__r' + fallback_operator.__name__ + '__'
         reverse.__doc__ = monomorphic_operator.__doc__

         return forward, reverse

     def _add(a, b):
         """a + b"""
         return Fraction(a.numerator * b.denominator +
                         b.numerator * a.denominator,
                         a.denominator * b.denominator)

     __add__, __radd__ = _operator_fallbacks(_add, operator.add)

     # ...


File: python.info,  Node: math — Mathematical functions,  Next: cmath — Mathematical functions for complex numbers,  Prev: numbers — Numeric abstract base classes,  Up: Numeric and Mathematical Modules

5.9.2 ‘math’ — Mathematical functions
-------------------------------------

__________________________________________________________________

This module provides access to the mathematical functions defined by the
C standard.

These functions cannot be used with complex numbers; use the functions
of the same name from the *note cmath: 19. module if you require support
for complex numbers.  The distinction between functions which support
complex numbers and those which don’t is made since most users do not
want to learn quite as much mathematics as required to understand
complex numbers.  Receiving an exception instead of a complex result
allows earlier detection of the unexpected complex number used as a
parameter, so that the programmer can determine how and why it was
generated in the first place.

The following functions are provided by this module.  Except when
explicitly noted otherwise, all return values are floats.

* Menu:

* Number-theoretic and representation functions::
* Power and logarithmic functions::
* Trigonometric functions::
* Angular conversion::
* Hyperbolic functions::
* Special functions::
* Constants: Constants<2>.


File: python.info,  Node: Number-theoretic and representation functions,  Next: Power and logarithmic functions,  Up: math — Mathematical functions

5.9.2.1 Number-theoretic and representation functions
.....................................................

 -- Function: math.ceil (x)

     Return the ceiling of `x', the smallest integer greater than or
     equal to `x'.  If `x' is not a float, delegates to ‘x.__ceil__()’,
     which should return an *note Integral: 135f. value.

 -- Function: math.comb (n, k)

     Return the number of ways to choose `k' items from `n' items
     without repetition and without order.

     Evaluates to ‘n! / (k! * (n - k)!)’ when ‘k <= n’ and evaluates to
     zero when ‘k > n’.

     Also called the binomial coefficient because it is equivalent to
     the coefficient of k-th term in polynomial expansion of the
     expression ‘(1 + x) ** n’.

     Raises *note TypeError: 192. if either of the arguments are not
     integers.  Raises *note ValueError: 1f9. if either of the arguments
     are negative.

     New in version 3.8.

 -- Function: math.copysign (x, y)

     Return a float with the magnitude (absolute value) of `x' but the
     sign of `y'.  On platforms that support signed zeros,
     ‘copysign(1.0, -0.0)’ returns `-1.0'.

 -- Function: math.fabs (x)

     Return the absolute value of `x'.

 -- Function: math.factorial (x)

     Return `x' factorial as an integer.  Raises *note ValueError: 1f9.
     if `x' is not integral or is negative.

 -- Function: math.floor (x)

     Return the floor of `x', the largest integer less than or equal to
     `x'.  If `x' is not a float, delegates to ‘x.__floor__()’, which
     should return an *note Integral: 135f. value.

 -- Function: math.fmod (x, y)

     Return ‘fmod(x, y)’, as defined by the platform C library.  Note
     that the Python expression ‘x % y’ may not return the same result.
     The intent of the C standard is that ‘fmod(x, y)’ be exactly
     (mathematically; to infinite precision) equal to ‘x - n*y’ for some
     integer `n' such that the result has the same sign as `x' and
     magnitude less than ‘abs(y)’.  Python’s ‘x % y’ returns a result
     with the sign of `y' instead, and may not be exactly computable for
     float arguments.  For example, ‘fmod(-1e-100, 1e100)’ is ‘-1e-100’,
     but the result of Python’s ‘-1e-100 % 1e100’ is ‘1e100-1e-100’,
     which cannot be represented exactly as a float, and rounds to the
     surprising ‘1e100’.  For this reason, function *note fmod(): 1476.
     is generally preferred when working with floats, while Python’s ‘x
     % y’ is preferred when working with integers.

 -- Function: math.frexp (x)

     Return the mantissa and exponent of `x' as the pair ‘(m, e)’.  `m'
     is a float and `e' is an integer such that ‘x == m * 2**e’ exactly.
     If `x' is zero, returns ‘(0.0, 0)’, otherwise ‘0.5 <= abs(m) < 1’.
     This is used to “pick apart” the internal representation of a float
     in a portable way.

 -- Function: math.fsum (iterable)

     Return an accurate floating point sum of values in the iterable.
     Avoids loss of precision by tracking multiple intermediate partial
     sums:

          >>> sum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1])
          0.9999999999999999
          >>> fsum([.1, .1, .1, .1, .1, .1, .1, .1, .1, .1])
          1.0

     The algorithm’s accuracy depends on IEEE-754 arithmetic guarantees
     and the typical case where the rounding mode is half-even.  On some
     non-Windows builds, the underlying C library uses extended
     precision addition and may occasionally double-round an
     intermediate sum causing it to be off in its least significant bit.

     For further discussion and two alternative approaches, see the ASPN
     cookbook recipes for accurate floating point summation(1).

 -- Function: math.gcd (a, b)

     Return the greatest common divisor of the integers `a' and `b'.  If
     either `a' or `b' is nonzero, then the value of ‘gcd(a, b)’ is the
     largest positive integer that divides both `a' and `b'.  ‘gcd(0,
     0)’ returns ‘0’.

     New in version 3.5.

 -- Function: math.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

     Return ‘True’ if the values `a' and `b' are close to each other and
     ‘False’ otherwise.

     Whether or not two values are considered close is determined
     according to given absolute and relative tolerances.

     `rel_tol' is the relative tolerance – it is the maximum allowed
     difference between `a' and `b', relative to the larger absolute
     value of `a' or `b'.  For example, to set a tolerance of 5%, pass
     ‘rel_tol=0.05’.  The default tolerance is ‘1e-09’, which assures
     that the two values are the same within about 9 decimal digits.
     `rel_tol' must be greater than zero.

     `abs_tol' is the minimum absolute tolerance – useful for
     comparisons near zero.  `abs_tol' must be at least zero.

     If no errors occur, the result will be: ‘abs(a-b) <= max(rel_tol *
     max(abs(a), abs(b)), abs_tol)’.

     The IEEE 754 special values of ‘NaN’, ‘inf’, and ‘-inf’ will be
     handled according to IEEE rules.  Specifically, ‘NaN’ is not
     considered close to any other value, including ‘NaN’.  ‘inf’ and
     ‘-inf’ are only considered close to themselves.

     New in version 3.5.

     See also
     ........

     PEP 485(2) – A function for testing approximate equality

 -- Function: math.isfinite (x)

     Return ‘True’ if `x' is neither an infinity nor a NaN, and ‘False’
     otherwise.  (Note that ‘0.0’ `is' considered finite.)

     New in version 3.2.

 -- Function: math.isinf (x)

     Return ‘True’ if `x' is a positive or negative infinity, and
     ‘False’ otherwise.

 -- Function: math.isnan (x)

     Return ‘True’ if `x' is a NaN (not a number), and ‘False’
     otherwise.

 -- Function: math.isqrt (n)

     Return the integer square root of the nonnegative integer `n'.
     This is the floor of the exact square root of `n', or equivalently
     the greatest integer `a' such that `a'² ≤ `n'.

     For some applications, it may be more convenient to have the least
     integer `a' such that `n' ≤ `a'², or in other words the ceiling of
     the exact square root of `n'.  For positive `n', this can be
     computed using ‘a = 1 + isqrt(n - 1)’.

     New in version 3.8.

 -- Function: math.ldexp (x, i)

     Return ‘x * (2**i)’.  This is essentially the inverse of function
     *note frexp(): 195a.

 -- Function: math.modf (x)

     Return the fractional and integer parts of `x'.  Both results carry
     the sign of `x' and are floats.

 -- Function: math.perm (n, k=None)

     Return the number of ways to choose `k' items from `n' items
     without repetition and with order.

     Evaluates to ‘n! / (n - k)!’ when ‘k <= n’ and evaluates to zero
     when ‘k > n’.

     If `k' is not specified or is None, then `k' defaults to `n' and
     the function returns ‘n!’.

     Raises *note TypeError: 192. if either of the arguments are not
     integers.  Raises *note ValueError: 1f9. if either of the arguments
     are negative.

     New in version 3.8.

 -- Function: math.prod (iterable, *, start=1)

     Calculate the product of all the elements in the input `iterable'.
     The default `start' value for the product is ‘1’.

     When the iterable is empty, return the start value.  This function
     is intended specifically for use with numeric values and may reject
     non-numeric types.

     New in version 3.8.

 -- Function: math.remainder (x, y)

     Return the IEEE 754-style remainder of `x' with respect to `y'.
     For finite `x' and finite nonzero `y', this is the difference ‘x -
     n*y’, where ‘n’ is the closest integer to the exact value of the
     quotient ‘x / y’.  If ‘x / y’ is exactly halfway between two
     consecutive integers, the nearest `even' integer is used for ‘n’.
     The remainder ‘r = remainder(x, y)’ thus always satisfies ‘abs(r)
     <= 0.5 * abs(y)’.

     Special cases follow IEEE 754: in particular, ‘remainder(x,
     math.inf)’ is `x' for any finite `x', and ‘remainder(x, 0)’ and
     ‘remainder(math.inf, x)’ raise *note ValueError: 1f9. for any
     non-NaN `x'.  If the result of the remainder operation is zero,
     that zero will have the same sign as `x'.

     On platforms using IEEE 754 binary floating-point, the result of
     this operation is always exactly representable: no rounding error
     is introduced.

     New in version 3.7.

 -- Function: math.trunc (x)

     Return the *note Real: 1360. value `x' truncated to an *note
     Integral: 135f. (usually an integer).  Delegates to *note
     x.__trunc__(): 13bf.

Note that *note frexp(): 195a. and *note modf(): 195c. have a different
call/return pattern than their C equivalents: they take a single
argument and return a pair of values, rather than returning their second
return value through an ‘output parameter’ (there is no such thing in
Python).

For the *note ceil(): d20, *note floor(): d1f, and *note modf(): 195c.
functions, note that `all' floating-point numbers of sufficiently large
magnitude are exact integers.  Python floats typically carry no more
than 53 bits of precision (the same as the platform C double type), in
which case any float `x' with ‘abs(x) >= 2**52’ necessarily has no
fractional bits.

   ---------- Footnotes ----------

   (1) https://code.activestate.com/recipes/393090/

   (2) https://www.python.org/dev/peps/pep-0485


File: python.info,  Node: Power and logarithmic functions,  Next: Trigonometric functions,  Prev: Number-theoretic and representation functions,  Up: math — Mathematical functions

5.9.2.2 Power and logarithmic functions
.......................................

 -- Function: math.exp (x)

     Return `e' raised to the power `x', where `e' = 2.718281… is the
     base of natural logarithms.  This is usually more accurate than
     ‘math.e ** x’ or ‘pow(math.e, x)’.

 -- Function: math.expm1 (x)

     Return `e' raised to the power `x', minus 1.  Here `e' is the base
     of natural logarithms.  For small floats `x', the subtraction in
     ‘exp(x) - 1’ can result in a significant loss of precision(1); the
     *note expm1(): b5b. function provides a way to compute this
     quantity to full precision:

          >>> from math import exp, expm1
          >>> exp(1e-5) - 1  # gives result accurate to 11 places
          1.0000050000069649e-05
          >>> expm1(1e-5)    # result accurate to full precision
          1.0000050000166668e-05

     New in version 3.2.

 -- Function: math.log (x[, base])

     With one argument, return the natural logarithm of `x' (to base
     `e').

     With two arguments, return the logarithm of `x' to the given
     `base', calculated as ‘log(x)/log(base)’.

 -- Function: math.log1p (x)

     Return the natural logarithm of `1+x' (base `e').  The result is
     calculated in a way which is accurate for `x' near zero.

 -- Function: math.log2 (x)

     Return the base-2 logarithm of `x'.  This is usually more accurate
     than ‘log(x, 2)’.

     New in version 3.3.

     See also
     ........

     *note int.bit_length(): 155a. returns the number of bits necessary
     to represent an integer in binary, excluding the sign and leading
     zeros.

 -- Function: math.log10 (x)

     Return the base-10 logarithm of `x'.  This is usually more accurate
     than ‘log(x, 10)’.

 -- Function: math.pow (x, y)

     Return ‘x’ raised to the power ‘y’.  Exceptional cases follow Annex
     ‘F’ of the C99 standard as far as possible.  In particular,
     ‘pow(1.0, x)’ and ‘pow(x, 0.0)’ always return ‘1.0’, even when ‘x’
     is a zero or a NaN. If both ‘x’ and ‘y’ are finite, ‘x’ is
     negative, and ‘y’ is not an integer then ‘pow(x, y)’ is undefined,
     and raises *note ValueError: 1f9.

     Unlike the built-in ‘**’ operator, *note math.pow(): 195f. converts
     both its arguments to type *note float: 187.  Use ‘**’ or the
     built-in *note pow(): 152. function for computing exact integer
     powers.

 -- Function: math.sqrt (x)

     Return the square root of `x'.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Loss_of_significance


File: python.info,  Node: Trigonometric functions,  Next: Angular conversion,  Prev: Power and logarithmic functions,  Up: math — Mathematical functions

5.9.2.3 Trigonometric functions
...............................

 -- Function: math.acos (x)

     Return the arc cosine of `x', in radians.

 -- Function: math.asin (x)

     Return the arc sine of `x', in radians.

 -- Function: math.atan (x)

     Return the arc tangent of `x', in radians.

 -- Function: math.atan2 (y, x)

     Return ‘atan(y / x)’, in radians.  The result is between ‘-pi’ and
     ‘pi’.  The vector in the plane from the origin to point ‘(x, y)’
     makes this angle with the positive X axis.  The point of *note
     atan2(): 1964. is that the signs of both inputs are known to it, so
     it can compute the correct quadrant for the angle.  For example,
     ‘atan(1)’ and ‘atan2(1, 1)’ are both ‘pi/4’, but ‘atan2(-1, -1)’ is
     ‘-3*pi/4’.

 -- Function: math.cos (x)

     Return the cosine of `x' radians.

 -- Function: math.dist (p, q)

     Return the Euclidean distance between two points `p' and `q', each
     given as a sequence (or iterable) of coordinates.  The two points
     must have the same dimension.

     Roughly equivalent to:

          sqrt(sum((px - qx) ** 2.0 for px, qx in zip(p, q)))

     New in version 3.8.

 -- Function: math.hypot (*coordinates)

     Return the Euclidean norm, ‘sqrt(sum(x**2 for x in coordinates))’.
     This is the length of the vector from the origin to the point given
     by the coordinates.

     For a two dimensional point ‘(x, y)’, this is equivalent to
     computing the hypotenuse of a right triangle using the Pythagorean
     theorem, ‘sqrt(x*x + y*y)’.

     Changed in version 3.8: Added support for n-dimensional points.
     Formerly, only the two dimensional case was supported.

 -- Function: math.sin (x)

     Return the sine of `x' radians.

 -- Function: math.tan (x)

     Return the tangent of `x' radians.


File: python.info,  Node: Angular conversion,  Next: Hyperbolic functions,  Prev: Trigonometric functions,  Up: math — Mathematical functions

5.9.2.4 Angular conversion
..........................

 -- Function: math.degrees (x)

     Convert angle `x' from radians to degrees.

 -- Function: math.radians (x)

     Convert angle `x' from degrees to radians.


File: python.info,  Node: Hyperbolic functions,  Next: Special functions,  Prev: Angular conversion,  Up: math — Mathematical functions

5.9.2.5 Hyperbolic functions
............................

Hyperbolic functions(1) are analogs of trigonometric functions that are
based on hyperbolas instead of circles.

 -- Function: math.acosh (x)

     Return the inverse hyperbolic cosine of `x'.

 -- Function: math.asinh (x)

     Return the inverse hyperbolic sine of `x'.

 -- Function: math.atanh (x)

     Return the inverse hyperbolic tangent of `x'.

 -- Function: math.cosh (x)

     Return the hyperbolic cosine of `x'.

 -- Function: math.sinh (x)

     Return the hyperbolic sine of `x'.

 -- Function: math.tanh (x)

     Return the hyperbolic tangent of `x'.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Hyperbolic_function


File: python.info,  Node: Special functions,  Next: Constants<2>,  Prev: Hyperbolic functions,  Up: math — Mathematical functions

5.9.2.6 Special functions
.........................

 -- Function: math.erf (x)

     Return the error function(1) at `x'.

     The *note erf(): 447. function can be used to compute traditional
     statistical functions such as the cumulative standard normal
     distribution(2):

          def phi(x):
              'Cumulative distribution function for the standard normal distribution'
              return (1.0 + erf(x / sqrt(2.0))) / 2.0

     New in version 3.2.

 -- Function: math.erfc (x)

     Return the complementary error function at `x'.  The complementary
     error function(3) is defined as ‘1.0 - erf(x)’.  It is used for
     large values of `x' where a subtraction from one would cause a loss
     of significance(4).

     New in version 3.2.

 -- Function: math.gamma (x)

     Return the Gamma function(5) at `x'.

     New in version 3.2.

 -- Function: math.lgamma (x)

     Return the natural logarithm of the absolute value of the Gamma
     function at `x'.

     New in version 3.2.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Error_function

   (2) 
https://en.wikipedia.org/wiki/Normal_distribution#Cumulative_distribution_function

   (3) https://en.wikipedia.org/wiki/Error_function

   (4) https://en.wikipedia.org/wiki/Loss_of_significance

   (5) https://en.wikipedia.org/wiki/Gamma_function


File: python.info,  Node: Constants<2>,  Prev: Special functions,  Up: math — Mathematical functions

5.9.2.7 Constants
.................

 -- Data: math.pi

     The mathematical constant `π' = 3.141592…, to available precision.

 -- Data: math.e

     The mathematical constant `e' = 2.718281…, to available precision.

 -- Data: math.tau

     The mathematical constant `τ' = 6.283185…, to available precision.
     Tau is a circle constant equal to 2`π', the ratio of a circle’s
     circumference to its radius.  To learn more about Tau, check out Vi
     Hart’s video Pi is (still) Wrong(1), and start celebrating Tau
     day(2) by eating twice as much pie!

     New in version 3.6.

 -- Data: math.inf

     A floating-point positive infinity.  (For negative infinity, use
     ‘-math.inf’.)  Equivalent to the output of ‘float('inf')’.

     New in version 3.5.

 -- Data: math.nan

     A floating-point “not a number” (NaN) value.  Equivalent to the
     output of ‘float('nan')’.

     New in version 3.5.

`CPython implementation detail:' The *note math: b1. module consists
mostly of thin wrappers around the platform C math library functions.
Behavior in exceptional cases follows Annex F of the C99 standard where
appropriate.  The current implementation will raise *note ValueError:
1f9. for invalid operations like ‘sqrt(-1.0)’ or ‘log(0.0)’ (where C99
Annex F recommends signaling invalid operation or divide-by-zero), and
*note OverflowError: 954. for results that overflow (for example,
‘exp(1000.0)’).  A NaN will not be returned from any of the functions
above unless one or more of the input arguments was a NaN; in that case,
most functions will return a NaN, but (again following C99 Annex F)
there are some exceptions to this rule, for example ‘pow(float('nan'),
0.0)’ or ‘hypot(float('nan'), float('inf'))’.

Note that Python makes no effort to distinguish signaling NaNs from
quiet NaNs, and behavior for signaling NaNs remains unspecified.
Typical behavior is to treat all NaNs as though they were quiet.

See also
........

Module *note cmath: 19.

     Complex number versions of many of these functions.

   ---------- Footnotes ----------

   (1) https://www.youtube.com/watch?v=jG7vhMMXagQ

   (2) https://tauday.com/


File: python.info,  Node: cmath — Mathematical functions for complex numbers,  Next: decimal — Decimal fixed point and floating point arithmetic,  Prev: math — Mathematical functions,  Up: Numeric and Mathematical Modules

5.9.3 ‘cmath’ — Mathematical functions for complex numbers
----------------------------------------------------------

__________________________________________________________________

This module provides access to mathematical functions for complex
numbers.  The functions in this module accept integers, floating-point
numbers or complex numbers as arguments.  They will also accept any
Python object that has either a *note __complex__(): 18d. or a *note
__float__(): 18c. method: these methods are used to convert the object
to a complex or floating-point number, respectively, and the function is
then applied to the result of the conversion.

     Note: On platforms with hardware and system-level support for
     signed zeros, functions involving branch cuts are continuous on
     `both' sides of the branch cut: the sign of the zero distinguishes
     one side of the branch cut from the other.  On platforms that do
     not support signed zeros the continuity is as specified below.

* Menu:

* Conversions to and from polar coordinates::
* Power and logarithmic functions: Power and logarithmic functions<2>.
* Trigonometric functions: Trigonometric functions<2>.
* Hyperbolic functions: Hyperbolic functions<2>.
* Classification functions::
* Constants: Constants<3>.


File: python.info,  Node: Conversions to and from polar coordinates,  Next: Power and logarithmic functions<2>,  Up: cmath — Mathematical functions for complex numbers

5.9.3.1 Conversions to and from polar coordinates
.................................................

A Python complex number ‘z’ is stored internally using `rectangular' or
`Cartesian' coordinates.  It is completely determined by its `real part'
‘z.real’ and its `imaginary part' ‘z.imag’.  In other words:

     z == z.real + z.imag*1j

`Polar coordinates' give an alternative way to represent a complex
number.  In polar coordinates, a complex number `z' is defined by the
modulus `r' and the phase angle `phi'.  The modulus `r' is the distance
from `z' to the origin, while the phase `phi' is the counterclockwise
angle, measured in radians, from the positive x-axis to the line segment
that joins the origin to `z'.

The following functions can be used to convert from the native
rectangular coordinates to polar coordinates and back.

 -- Function: cmath.phase (x)

     Return the phase of `x' (also known as the `argument' of `x'), as a
     float.  ‘phase(x)’ is equivalent to ‘math.atan2(x.imag, x.real)’.
     The result lies in the range [-`π', `π'], and the branch cut for
     this operation lies along the negative real axis, continuous from
     above.  On systems with support for signed zeros (which includes
     most systems in current use), this means that the sign of the
     result is the same as the sign of ‘x.imag’, even when ‘x.imag’ is
     zero:

          >>> phase(complex(-1.0, 0.0))
          3.141592653589793
          >>> phase(complex(-1.0, -0.0))
          -3.141592653589793

     Note: The modulus (absolute value) of a complex number `x' can be
     computed using the built-in *note abs(): 11f8. function.  There is
     no separate *note cmath: 19. module function for this operation.

 -- Function: cmath.polar (x)

     Return the representation of `x' in polar coordinates.  Returns a
     pair ‘(r, phi)’ where `r' is the modulus of `x' and phi is the
     phase of `x'.  ‘polar(x)’ is equivalent to ‘(abs(x), phase(x))’.

 -- Function: cmath.rect (r, phi)

     Return the complex number `x' with polar coordinates `r' and `phi'.
     Equivalent to ‘r * (math.cos(phi) + math.sin(phi)*1j)’.


File: python.info,  Node: Power and logarithmic functions<2>,  Next: Trigonometric functions<2>,  Prev: Conversions to and from polar coordinates,  Up: cmath — Mathematical functions for complex numbers

5.9.3.2 Power and logarithmic functions
.......................................

 -- Function: cmath.exp (x)

     Return `e' raised to the power `x', where `e' is the base of
     natural logarithms.

 -- Function: cmath.log (x[, base])

     Returns the logarithm of `x' to the given `base'.  If the `base' is
     not specified, returns the natural logarithm of `x'.  There is one
     branch cut, from 0 along the negative real axis to -∞, continuous
     from above.

 -- Function: cmath.log10 (x)

     Return the base-10 logarithm of `x'.  This has the same branch cut
     as *note log(): 197a.

 -- Function: cmath.sqrt (x)

     Return the square root of `x'.  This has the same branch cut as
     *note log(): 197a.


File: python.info,  Node: Trigonometric functions<2>,  Next: Hyperbolic functions<2>,  Prev: Power and logarithmic functions<2>,  Up: cmath — Mathematical functions for complex numbers

5.9.3.3 Trigonometric functions
...............................

 -- Function: cmath.acos (x)

     Return the arc cosine of `x'.  There are two branch cuts: One
     extends right from 1 along the real axis to ∞, continuous from
     below.  The other extends left from -1 along the real axis to -∞,
     continuous from above.

 -- Function: cmath.asin (x)

     Return the arc sine of `x'.  This has the same branch cuts as *note
     acos(): 197e.

 -- Function: cmath.atan (x)

     Return the arc tangent of `x'.  There are two branch cuts: One
     extends from ‘1j’ along the imaginary axis to ‘∞j’, continuous from
     the right.  The other extends from ‘-1j’ along the imaginary axis
     to ‘-∞j’, continuous from the left.

 -- Function: cmath.cos (x)

     Return the cosine of `x'.

 -- Function: cmath.sin (x)

     Return the sine of `x'.

 -- Function: cmath.tan (x)

     Return the tangent of `x'.


File: python.info,  Node: Hyperbolic functions<2>,  Next: Classification functions,  Prev: Trigonometric functions<2>,  Up: cmath — Mathematical functions for complex numbers

5.9.3.4 Hyperbolic functions
............................

 -- Function: cmath.acosh (x)

     Return the inverse hyperbolic cosine of `x'.  There is one branch
     cut, extending left from 1 along the real axis to -∞, continuous
     from above.

 -- Function: cmath.asinh (x)

     Return the inverse hyperbolic sine of `x'.  There are two branch
     cuts: One extends from ‘1j’ along the imaginary axis to ‘∞j’,
     continuous from the right.  The other extends from ‘-1j’ along the
     imaginary axis to ‘-∞j’, continuous from the left.

 -- Function: cmath.atanh (x)

     Return the inverse hyperbolic tangent of `x'.  There are two branch
     cuts: One extends from ‘1’ along the real axis to ‘∞’, continuous
     from below.  The other extends from ‘-1’ along the real axis to
     ‘-∞’, continuous from above.

 -- Function: cmath.cosh (x)

     Return the hyperbolic cosine of `x'.

 -- Function: cmath.sinh (x)

     Return the hyperbolic sine of `x'.

 -- Function: cmath.tanh (x)

     Return the hyperbolic tangent of `x'.


File: python.info,  Node: Classification functions,  Next: Constants<3>,  Prev: Hyperbolic functions<2>,  Up: cmath — Mathematical functions for complex numbers

5.9.3.5 Classification functions
................................

 -- Function: cmath.isfinite (x)

     Return ‘True’ if both the real and imaginary parts of `x' are
     finite, and ‘False’ otherwise.

     New in version 3.2.

 -- Function: cmath.isinf (x)

     Return ‘True’ if either the real or the imaginary part of `x' is an
     infinity, and ‘False’ otherwise.

 -- Function: cmath.isnan (x)

     Return ‘True’ if either the real or the imaginary part of `x' is a
     NaN, and ‘False’ otherwise.

 -- Function: cmath.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

     Return ‘True’ if the values `a' and `b' are close to each other and
     ‘False’ otherwise.

     Whether or not two values are considered close is determined
     according to given absolute and relative tolerances.

     `rel_tol' is the relative tolerance – it is the maximum allowed
     difference between `a' and `b', relative to the larger absolute
     value of `a' or `b'.  For example, to set a tolerance of 5%, pass
     ‘rel_tol=0.05’.  The default tolerance is ‘1e-09’, which assures
     that the two values are the same within about 9 decimal digits.
     `rel_tol' must be greater than zero.

     `abs_tol' is the minimum absolute tolerance – useful for
     comparisons near zero.  `abs_tol' must be at least zero.

     If no errors occur, the result will be: ‘abs(a-b) <= max(rel_tol *
     max(abs(a), abs(b)), abs_tol)’.

     The IEEE 754 special values of ‘NaN’, ‘inf’, and ‘-inf’ will be
     handled according to IEEE rules.  Specifically, ‘NaN’ is not
     considered close to any other value, including ‘NaN’.  ‘inf’ and
     ‘-inf’ are only considered close to themselves.

     New in version 3.5.

     See also
     ........

     PEP 485(1) – A function for testing approximate equality

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0485


File: python.info,  Node: Constants<3>,  Prev: Classification functions,  Up: cmath — Mathematical functions for complex numbers

5.9.3.6 Constants
.................

 -- Data: cmath.pi

     The mathematical constant `π', as a float.

 -- Data: cmath.e

     The mathematical constant `e', as a float.

 -- Data: cmath.tau

     The mathematical constant `τ', as a float.

     New in version 3.6.

 -- Data: cmath.inf

     Floating-point positive infinity.  Equivalent to ‘float('inf')’.

     New in version 3.6.

 -- Data: cmath.infj

     Complex number with zero real part and positive infinity imaginary
     part.  Equivalent to ‘complex(0.0, float('inf'))’.

     New in version 3.6.

 -- Data: cmath.nan

     A floating-point “not a number” (NaN) value.  Equivalent to
     ‘float('nan')’.

     New in version 3.6.

 -- Data: cmath.nanj

     Complex number with zero real part and NaN imaginary part.
     Equivalent to ‘complex(0.0, float('nan'))’.

     New in version 3.6.

Note that the selection of functions is similar, but not identical, to
that in module *note math: b1.  The reason for having two modules is
that some users aren’t interested in complex numbers, and perhaps don’t
even know what they are.  They would rather have ‘math.sqrt(-1)’ raise
an exception than return a complex number.  Also note that the functions
defined in *note cmath: 19. always return a complex number, even if the
answer can be expressed as a real number (in which case the complex
number has an imaginary part of zero).

A note on branch cuts: They are curves along which the given function
fails to be continuous.  They are a necessary feature of many complex
functions.  It is assumed that if you need to compute with complex
functions, you will understand about branch cuts.  Consult almost any
(not too elementary) book on complex variables for enlightenment.  For
information of the proper choice of branch cuts for numerical purposes,
a good reference should be the following:

See also
........

Kahan, W: Branch cuts for complex elementary functions; or, Much ado
about nothing’s sign bit.  In Iserles, A., and Powell, M. (eds.), The
state of the art in numerical analysis.  Clarendon Press (1987)
pp165–211.


File: python.info,  Node: decimal — Decimal fixed point and floating point arithmetic,  Next: fractions — Rational numbers,  Prev: cmath — Mathematical functions for complex numbers,  Up: Numeric and Mathematical Modules

5.9.4 ‘decimal’ — Decimal fixed point and floating point arithmetic
-------------------------------------------------------------------

`Source code:' Lib/decimal.py(1)

__________________________________________________________________

The *note decimal: 36. module provides support for fast
correctly-rounded decimal floating point arithmetic.  It offers several
advantages over the *note float: 187. datatype:

   * Decimal “is based on a floating-point model which was designed with
     people in mind, and necessarily has a paramount guiding principle –
     computers must provide an arithmetic that works in the same way as
     the arithmetic that people learn at school.” – excerpt from the
     decimal arithmetic specification.

   * Decimal numbers can be represented exactly.  In contrast, numbers
     like ‘1.1’ and ‘2.2’ do not have exact representations in binary
     floating point.  End users typically would not expect ‘1.1 + 2.2’
     to display as ‘3.3000000000000003’ as it does with binary floating
     point.

   * The exactness carries over into arithmetic.  In decimal floating
     point, ‘0.1 + 0.1 + 0.1 - 0.3’ is exactly equal to zero.  In binary
     floating point, the result is ‘5.5511151231257827e-017’.  While
     near to zero, the differences prevent reliable equality testing and
     differences can accumulate.  For this reason, decimal is preferred
     in accounting applications which have strict equality invariants.

   * The decimal module incorporates a notion of significant places so
     that ‘1.30 + 1.20’ is ‘2.50’.  The trailing zero is kept to
     indicate significance.  This is the customary presentation for
     monetary applications.  For multiplication, the “schoolbook”
     approach uses all the figures in the multiplicands.  For instance,
     ‘1.3 * 1.2’ gives ‘1.56’ while ‘1.30 * 1.20’ gives ‘1.5600’.

   * Unlike hardware based binary floating point, the decimal module has
     a user alterable precision (defaulting to 28 places) which can be
     as large as needed for a given problem:

          >>> from decimal import *
          >>> getcontext().prec = 6
          >>> Decimal(1) / Decimal(7)
          Decimal('0.142857')
          >>> getcontext().prec = 28
          >>> Decimal(1) / Decimal(7)
          Decimal('0.1428571428571428571428571429')

   * Both binary and decimal floating point are implemented in terms of
     published standards.  While the built-in float type exposes only a
     modest portion of its capabilities, the decimal module exposes all
     required parts of the standard.  When needed, the programmer has
     full control over rounding and signal handling.  This includes an
     option to enforce exact arithmetic by using exceptions to block any
     inexact operations.

   * The decimal module was designed to support “without prejudice, both
     exact unrounded decimal arithmetic (sometimes called fixed-point
     arithmetic) and rounded floating-point arithmetic.” – excerpt from
     the decimal arithmetic specification.

The module design is centered around three concepts: the decimal number,
the context for arithmetic, and signals.

A decimal number is immutable.  It has a sign, coefficient digits, and
an exponent.  To preserve significance, the coefficient digits do not
truncate trailing zeros.  Decimals also include special values such as
‘Infinity’, ‘-Infinity’, and ‘NaN’.  The standard also differentiates
‘-0’ from ‘+0’.

The context for arithmetic is an environment specifying precision,
rounding rules, limits on exponents, flags indicating the results of
operations, and trap enablers which determine whether signals are
treated as exceptions.  Rounding options include *note ROUND_CEILING:
1994, *note ROUND_DOWN: 1995, *note ROUND_FLOOR: 1996, *note
ROUND_HALF_DOWN: 1997, *note ROUND_HALF_EVEN: 1998, *note ROUND_HALF_UP:
1999, *note ROUND_UP: 199a, and *note ROUND_05UP: 199b.

Signals are groups of exceptional conditions arising during the course
of computation.  Depending on the needs of the application, signals may
be ignored, considered as informational, or treated as exceptions.  The
signals in the decimal module are: *note Clamped: 199c, *note
InvalidOperation: 9df, *note DivisionByZero: 199d, *note Inexact: 199e,
*note Rounded: 199f, *note Subnormal: 19a0, *note Overflow: 19a1, *note
Underflow: 19a2. and *note FloatOperation: 9d9.

For each signal there is a flag and a trap enabler.  When a signal is
encountered, its flag is set to one, then, if the trap enabler is set to
one, an exception is raised.  Flags are sticky, so the user needs to
reset them before monitoring a calculation.

See also
........

   * IBM’s General Decimal Arithmetic Specification, The General Decimal
     Arithmetic Specification(2).

* Menu:

* Quick-start Tutorial::
* Decimal objects::
* Context objects::
* Constants: Constants<4>.
* Rounding modes::
* Signals::
* Floating Point Notes::
* Working with threads::
* Recipes::
* Decimal FAQ::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/decimal.py

   (2) http://speleotrove.com/decimal/decarith.html


File: python.info,  Node: Quick-start Tutorial,  Next: Decimal objects,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.1 Quick-start Tutorial
............................

The usual start to using decimals is importing the module, viewing the
current context with *note getcontext(): 19a5. and, if necessary,
setting new values for precision, rounding, or enabled traps:

     >>> from decimal import *
     >>> getcontext()
     Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
             capitals=1, clamp=0, flags=[], traps=[Overflow, DivisionByZero,
             InvalidOperation])

     >>> getcontext().prec = 7       # Set a new precision

Decimal instances can be constructed from integers, strings, floats, or
tuples.  Construction from an integer or a float performs an exact
conversion of the value of that integer or float.  Decimal numbers
include special values such as ‘NaN’ which stands for “Not a number”,
positive and negative ‘Infinity’, and ‘-0’:

     >>> getcontext().prec = 28
     >>> Decimal(10)
     Decimal('10')
     >>> Decimal('3.14')
     Decimal('3.14')
     >>> Decimal(3.14)
     Decimal('3.140000000000000124344978758017532527446746826171875')
     >>> Decimal((0, (3, 1, 4), -2))
     Decimal('3.14')
     >>> Decimal(str(2.0 ** 0.5))
     Decimal('1.4142135623730951')
     >>> Decimal(2) ** Decimal('0.5')
     Decimal('1.414213562373095048801688724')
     >>> Decimal('NaN')
     Decimal('NaN')
     >>> Decimal('-Infinity')
     Decimal('-Infinity')

If the *note FloatOperation: 9d9. signal is trapped, accidental mixing
of decimals and floats in constructors or ordering comparisons raises an
exception:

     >>> c = getcontext()
     >>> c.traps[FloatOperation] = True
     >>> Decimal(3.14)
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
     >>> Decimal('3.5') < 3.7
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
     >>> Decimal('3.5') == 3.5
     True

New in version 3.3.

The significance of a new Decimal is determined solely by the number of
digits input.  Context precision and rounding only come into play during
arithmetic operations.

     >>> getcontext().prec = 6
     >>> Decimal('3.0')
     Decimal('3.0')
     >>> Decimal('3.1415926535')
     Decimal('3.1415926535')
     >>> Decimal('3.1415926535') + Decimal('2.7182818285')
     Decimal('5.85987')
     >>> getcontext().rounding = ROUND_UP
     >>> Decimal('3.1415926535') + Decimal('2.7182818285')
     Decimal('5.85988')

If the internal limits of the C version are exceeded, constructing a
decimal raises *note InvalidOperation: 9df.:

     >>> Decimal("1e9999999999999999999")
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]

Changed in version 3.3.

Decimals interact well with much of the rest of Python.  Here is a small
decimal floating point flying circus:

     >>> data = list(map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split()))
     >>> max(data)
     Decimal('9.25')
     >>> min(data)
     Decimal('0.03')
     >>> sorted(data)
     [Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'),
      Decimal('2.35'), Decimal('3.45'), Decimal('9.25')]
     >>> sum(data)
     Decimal('19.29')
     >>> a,b,c = data[:3]
     >>> str(a)
     '1.34'
     >>> float(a)
     1.34
     >>> round(a, 1)
     Decimal('1.3')
     >>> int(a)
     1
     >>> a * 5
     Decimal('6.70')
     >>> a * b
     Decimal('2.5058')
     >>> c % a
     Decimal('0.77')

And some mathematical functions are also available to Decimal:

     >>> getcontext().prec = 28
     >>> Decimal(2).sqrt()
     Decimal('1.414213562373095048801688724')
     >>> Decimal(1).exp()
     Decimal('2.718281828459045235360287471')
     >>> Decimal('10').ln()
     Decimal('2.302585092994045684017991455')
     >>> Decimal('10').log10()
     Decimal('1')

The ‘quantize()’ method rounds a number to a fixed exponent.  This
method is useful for monetary applications that often round results to a
fixed number of places:

     >>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
     Decimal('7.32')
     >>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
     Decimal('8')

As shown above, the *note getcontext(): 19a5. function accesses the
current context and allows the settings to be changed.  This approach
meets the needs of most applications.

For more advanced work, it may be useful to create alternate contexts
using the Context() constructor.  To make an alternate active, use the
*note setcontext(): 19a6. function.

In accordance with the standard, the *note decimal: 36. module provides
two ready to use standard contexts, *note BasicContext: 9dd. and *note
ExtendedContext: 9de.  The former is especially useful for debugging
because many of the traps are enabled:

     >>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN)
     >>> setcontext(myothercontext)
     >>> Decimal(1) / Decimal(7)
     Decimal('0.142857142857142857142857142857142857142857142857142857142857')

     >>> ExtendedContext
     Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
             capitals=1, clamp=0, flags=[], traps=[])
     >>> setcontext(ExtendedContext)
     >>> Decimal(1) / Decimal(7)
     Decimal('0.142857143')
     >>> Decimal(42) / Decimal(0)
     Decimal('Infinity')

     >>> setcontext(BasicContext)
     >>> Decimal(42) / Decimal(0)
     Traceback (most recent call last):
       File "<pyshell#143>", line 1, in -toplevel-
         Decimal(42) / Decimal(0)
     DivisionByZero: x / 0

Contexts also have signal flags for monitoring exceptional conditions
encountered during computations.  The flags remain set until explicitly
cleared, so it is best to clear the flags before each set of monitored
computations by using the ‘clear_flags()’ method.

     >>> setcontext(ExtendedContext)
     >>> getcontext().clear_flags()
     >>> Decimal(355) / Decimal(113)
     Decimal('3.14159292')
     >>> getcontext()
     Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
             capitals=1, clamp=0, flags=[Inexact, Rounded], traps=[])

The `flags' entry shows that the rational approximation to ‘Pi’ was
rounded (digits beyond the context precision were thrown away) and that
the result is inexact (some of the discarded digits were non-zero).

Individual traps are set using the dictionary in the ‘traps’ field of a
context:

     >>> setcontext(ExtendedContext)
     >>> Decimal(1) / Decimal(0)
     Decimal('Infinity')
     >>> getcontext().traps[DivisionByZero] = 1
     >>> Decimal(1) / Decimal(0)
     Traceback (most recent call last):
       File "<pyshell#112>", line 1, in -toplevel-
         Decimal(1) / Decimal(0)
     DivisionByZero: x / 0

Most programs adjust the current context only once, at the beginning of
the program.  And, in many applications, data is converted to *note
Decimal: 188. with a single cast inside a loop.  With context set and
decimals created, the bulk of the program manipulates the data no
differently than with other Python numeric types.


File: python.info,  Node: Decimal objects,  Next: Context objects,  Prev: Quick-start Tutorial,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.2 Decimal objects
.......................

 -- Class: decimal.Decimal (value="0", context=None)

     Construct a new *note Decimal: 188. object based from `value'.

     `value' can be an integer, string, tuple, *note float: 187, or
     another *note Decimal: 188. object.  If no `value' is given,
     returns ‘Decimal('0')’.  If `value' is a string, it should conform
     to the decimal numeric string syntax after leading and trailing
     whitespace characters, as well as underscores throughout, are
     removed:

          sign           ::=  '+' | '-'
          digit          ::=  '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
          indicator      ::=  'e' | 'E'
          digits         ::=  digit [digit]...
          decimal-part   ::=  digits '.' [digits] | ['.'] digits
          exponent-part  ::=  indicator [sign] digits
          infinity       ::=  'Infinity' | 'Inf'
          nan            ::=  'NaN' [digits] | 'sNaN' [digits]
          numeric-value  ::=  decimal-part [exponent-part] | infinity
          numeric-string ::=  [sign] numeric-value | [sign] nan

     Other Unicode decimal digits are also permitted where ‘digit’
     appears above.  These include decimal digits from various other
     alphabets (for example, Arabic-Indic and Devanāgarī digits) along
     with the fullwidth digits ‘'\uff10'’ through ‘'\uff19'’.

     If `value' is a *note tuple: 473, it should have three components,
     a sign (‘0’ for positive or ‘1’ for negative), a *note tuple: 473.
     of digits, and an integer exponent.  For example, ‘Decimal((0, (1,
     4, 1, 4), -3))’ returns ‘Decimal('1.414')’.

     If `value' is a *note float: 187, the binary floating point value
     is losslessly converted to its exact decimal equivalent.  This
     conversion can often require 53 or more digits of precision.  For
     example, ‘Decimal(float('1.1'))’ converts to
     ‘Decimal('1.100000000000000088817841970012523233890533447265625')’.

     The `context' precision does not affect how many digits are stored.
     That is determined exclusively by the number of digits in `value'.
     For example, ‘Decimal('3.00000')’ records all five zeros even if
     the context precision is only three.

     The purpose of the `context' argument is determining what to do if
     `value' is a malformed string.  If the context traps *note
     InvalidOperation: 9df, an exception is raised; otherwise, the
     constructor returns a new Decimal with the value of ‘NaN’.

     Once constructed, *note Decimal: 188. objects are immutable.

     Changed in version 3.2: The argument to the constructor is now
     permitted to be a *note float: 187. instance.

     Changed in version 3.3: *note float: 187. arguments raise an
     exception if the *note FloatOperation: 9d9. trap is set.  By
     default the trap is off.

     Changed in version 3.6: Underscores are allowed for grouping, as
     with integral and floating-point literals in code.

     Decimal floating point objects share many properties with the other
     built-in numeric types such as *note float: 187. and *note int:
     184.  All of the usual math operations and special methods apply.
     Likewise, decimal objects can be copied, pickled, printed, used as
     dictionary keys, used as set elements, compared, sorted, and
     coerced to another type (such as *note float: 187. or *note int:
     184.).

     There are some small differences between arithmetic on Decimal
     objects and arithmetic on integers and floats.  When the remainder
     operator ‘%’ is applied to Decimal objects, the sign of the result
     is the sign of the `dividend' rather than the sign of the divisor:

          >>> (-7) % 4
          1
          >>> Decimal(-7) % Decimal(4)
          Decimal('-3')

     The integer division operator ‘//’ behaves analogously, returning
     the integer part of the true quotient (truncating towards zero)
     rather than its floor, so as to preserve the usual identity ‘x ==
     (x // y) * y + x % y’:

          >>> -7 // 4
          -2
          >>> Decimal(-7) // Decimal(4)
          Decimal('-1')

     The ‘%’ and ‘//’ operators implement the ‘remainder’ and
     ‘divide-integer’ operations (respectively) as described in the
     specification.

     Decimal objects cannot generally be combined with floats or
     instances of *note fractions.Fraction: 185. in arithmetic
     operations: an attempt to add a *note Decimal: 188. to a *note
     float: 187, for example, will raise a *note TypeError: 192.
     However, it is possible to use Python’s comparison operators to
     compare a *note Decimal: 188. instance ‘x’ with another number ‘y’.
     This avoids confusing results when doing equality comparisons
     between numbers of different types.

     Changed in version 3.2: Mixed-type comparisons between *note
     Decimal: 188. instances and other numeric types are now fully
     supported.

     In addition to the standard numeric properties, decimal floating
     point objects also have a number of specialized methods:

      -- Method: adjusted ()

          Return the adjusted exponent after shifting out the
          coefficient’s rightmost digits until only the lead digit
          remains: ‘Decimal('321e+5').adjusted()’ returns seven.  Used
          for determining the position of the most significant digit
          with respect to the decimal point.

      -- Method: as_integer_ratio ()

          Return a pair ‘(n, d)’ of integers that represent the given
          *note Decimal: 188. instance as a fraction, in lowest terms
          and with a positive denominator:

               >>> Decimal('-3.14').as_integer_ratio()
               (-157, 50)

          The conversion is exact.  Raise OverflowError on infinities
          and ValueError on NaNs.

     New in version 3.6.

      -- Method: as_tuple ()

          Return a *note named tuple: a98. representation of the number:
          ‘DecimalTuple(sign, digits, exponent)’.

      -- Method: canonical ()

          Return the canonical encoding of the argument.  Currently, the
          encoding of a *note Decimal: 188. instance is always
          canonical, so this operation returns its argument unchanged.

      -- Method: compare (other, context=None)

          Compare the values of two Decimal instances.  *note compare():
          19ac. returns a Decimal instance, and if either operand is a
          NaN then the result is a NaN:

               a or b is a NaN  ==> Decimal('NaN')
               a < b            ==> Decimal('-1')
               a == b           ==> Decimal('0')
               a > b            ==> Decimal('1')

      -- Method: compare_signal (other, context=None)

          This operation is identical to the *note compare(): 19ac.
          method, except that all NaNs signal.  That is, if neither
          operand is a signaling NaN then any quiet NaN operand is
          treated as though it were a signaling NaN.

      -- Method: compare_total (other, context=None)

          Compare two operands using their abstract representation
          rather than their numerical value.  Similar to the *note
          compare(): 19ac. method, but the result gives a total ordering
          on *note Decimal: 188. instances.  Two *note Decimal: 188.
          instances with the same numeric value but different
          representations compare unequal in this ordering:

               >>> Decimal('12.0').compare_total(Decimal('12'))
               Decimal('-1')

          Quiet and signaling NaNs are also included in the total
          ordering.  The result of this function is ‘Decimal('0')’ if
          both operands have the same representation, ‘Decimal('-1')’ if
          the first operand is lower in the total order than the second,
          and ‘Decimal('1')’ if the first operand is higher in the total
          order than the second operand.  See the specification for
          details of the total order.

          This operation is unaffected by context and is quiet: no flags
          are changed and no rounding is performed.  As an exception,
          the C version may raise InvalidOperation if the second operand
          cannot be converted exactly.

      -- Method: compare_total_mag (other, context=None)

          Compare two operands using their abstract representation
          rather than their value as in *note compare_total(): 19ae, but
          ignoring the sign of each operand.  ‘x.compare_total_mag(y)’
          is equivalent to ‘x.copy_abs().compare_total(y.copy_abs())’.

          This operation is unaffected by context and is quiet: no flags
          are changed and no rounding is performed.  As an exception,
          the C version may raise InvalidOperation if the second operand
          cannot be converted exactly.

      -- Method: conjugate ()

          Just returns self, this method is only to comply with the
          Decimal Specification.

      -- Method: copy_abs ()

          Return the absolute value of the argument.  This operation is
          unaffected by the context and is quiet: no flags are changed
          and no rounding is performed.

      -- Method: copy_negate ()

          Return the negation of the argument.  This operation is
          unaffected by the context and is quiet: no flags are changed
          and no rounding is performed.

      -- Method: copy_sign (other, context=None)

          Return a copy of the first operand with the sign set to be the
          same as the sign of the second operand.  For example:

               >>> Decimal('2.3').copy_sign(Decimal('-1.5'))
               Decimal('-2.3')

          This operation is unaffected by context and is quiet: no flags
          are changed and no rounding is performed.  As an exception,
          the C version may raise InvalidOperation if the second operand
          cannot be converted exactly.

      -- Method: exp (context=None)

          Return the value of the (natural) exponential function ‘e**x’
          at the given number.  The result is correctly rounded using
          the *note ROUND_HALF_EVEN: 1998. rounding mode.

               >>> Decimal(1).exp()
               Decimal('2.718281828459045235360287471')
               >>> Decimal(321).exp()
               Decimal('2.561702493119680037517373933E+139')

      -- Method: from_float (f)

          Classmethod that converts a float to a decimal number,
          exactly.

          Note ‘Decimal.from_float(0.1)’ is not the same as
          ‘Decimal(‘0.1’)’.  Since 0.1 is not exactly representable in
          binary floating point, the value is stored as the nearest
          representable value which is ‘0x1.999999999999ap-4’.  That
          equivalent value in decimal is
          ‘0.1000000000000000055511151231257827021181583404541015625’.

               Note: From Python 3.2 onwards, a *note Decimal: 188.
               instance can also be constructed directly from a *note
               float: 187.

               >>> Decimal.from_float(0.1)
               Decimal('0.1000000000000000055511151231257827021181583404541015625')
               >>> Decimal.from_float(float('nan'))
               Decimal('NaN')
               >>> Decimal.from_float(float('inf'))
               Decimal('Infinity')
               >>> Decimal.from_float(float('-inf'))
               Decimal('-Infinity')

          New in version 3.1.

      -- Method: fma (other, third, context=None)

          Fused multiply-add.  Return self*other+third with no rounding
          of the intermediate product self*other.

               >>> Decimal(2).fma(3, 5)
               Decimal('11')

      -- Method: is_canonical ()

          Return *note True: 48f. if the argument is canonical and *note
          False: 37d. otherwise.  Currently, a *note Decimal: 188.
          instance is always canonical, so this operation always returns
          *note True: 48f.

      -- Method: is_finite ()

          Return *note True: 48f. if the argument is a finite number,
          and *note False: 37d. if the argument is an infinity or a NaN.

      -- Method: is_infinite ()

          Return *note True: 48f. if the argument is either positive or
          negative infinity and *note False: 37d. otherwise.

      -- Method: is_nan ()

          Return *note True: 48f. if the argument is a (quiet or
          signaling) NaN and *note False: 37d. otherwise.

      -- Method: is_normal (context=None)

          Return *note True: 48f. if the argument is a `normal' finite
          number.  Return *note False: 37d. if the argument is zero,
          subnormal, infinite or a NaN.

      -- Method: is_qnan ()

          Return *note True: 48f. if the argument is a quiet NaN, and
          *note False: 37d. otherwise.

      -- Method: is_signed ()

          Return *note True: 48f. if the argument has a negative sign
          and *note False: 37d. otherwise.  Note that zeros and NaNs can
          both carry signs.

      -- Method: is_snan ()

          Return *note True: 48f. if the argument is a signaling NaN and
          *note False: 37d. otherwise.

      -- Method: is_subnormal (context=None)

          Return *note True: 48f. if the argument is subnormal, and
          *note False: 37d. otherwise.

      -- Method: is_zero ()

          Return *note True: 48f. if the argument is a (positive or
          negative) zero and *note False: 37d. otherwise.

      -- Method: ln (context=None)

          Return the natural (base e) logarithm of the operand.  The
          result is correctly rounded using the *note ROUND_HALF_EVEN:
          1998. rounding mode.

      -- Method: log10 (context=None)

          Return the base ten logarithm of the operand.  The result is
          correctly rounded using the *note ROUND_HALF_EVEN: 1998.
          rounding mode.

      -- Method: logb (context=None)

          For a nonzero number, return the adjusted exponent of its
          operand as a *note Decimal: 188. instance.  If the operand is
          a zero then ‘Decimal('-Infinity')’ is returned and the *note
          DivisionByZero: 199d. flag is raised.  If the operand is an
          infinity then ‘Decimal('Infinity')’ is returned.

      -- Method: logical_and (other, context=None)

          *note logical_and(): 19c1. is a logical operation which takes
          two `logical operands' (see *note Logical operands: 19c2.).
          The result is the digit-wise ‘and’ of the two operands.

      -- Method: logical_invert (context=None)

          *note logical_invert(): 19c3. is a logical operation.  The
          result is the digit-wise inversion of the operand.

      -- Method: logical_or (other, context=None)

          *note logical_or(): 19c4. is a logical operation which takes
          two `logical operands' (see *note Logical operands: 19c2.).
          The result is the digit-wise ‘or’ of the two operands.

      -- Method: logical_xor (other, context=None)

          *note logical_xor(): 19c5. is a logical operation which takes
          two `logical operands' (see *note Logical operands: 19c2.).
          The result is the digit-wise exclusive or of the two operands.

      -- Method: max (other, context=None)

          Like ‘max(self, other)’ except that the context rounding rule
          is applied before returning and that ‘NaN’ values are either
          signaled or ignored (depending on the context and whether they
          are signaling or quiet).

      -- Method: max_mag (other, context=None)

          Similar to the *note max(): 19c6. method, but the comparison
          is done using the absolute values of the operands.

      -- Method: min (other, context=None)

          Like ‘min(self, other)’ except that the context rounding rule
          is applied before returning and that ‘NaN’ values are either
          signaled or ignored (depending on the context and whether they
          are signaling or quiet).

      -- Method: min_mag (other, context=None)

          Similar to the *note min(): 19c8. method, but the comparison
          is done using the absolute values of the operands.

      -- Method: next_minus (context=None)

          Return the largest number representable in the given context
          (or in the current thread’s context if no context is given)
          that is smaller than the given operand.

      -- Method: next_plus (context=None)

          Return the smallest number representable in the given context
          (or in the current thread’s context if no context is given)
          that is larger than the given operand.

      -- Method: next_toward (other, context=None)

          If the two operands are unequal, return the number closest to
          the first operand in the direction of the second operand.  If
          both operands are numerically equal, return a copy of the
          first operand with the sign set to be the same as the sign of
          the second operand.

      -- Method: normalize (context=None)

          Normalize the number by stripping the rightmost trailing zeros
          and converting any result equal to ‘Decimal('0')’ to
          ‘Decimal('0e0')’.  Used for producing canonical values for
          attributes of an equivalence class.  For example,
          ‘Decimal('32.100')’ and ‘Decimal('0.321000e+2')’ both
          normalize to the equivalent value ‘Decimal('32.1')’.

      -- Method: number_class (context=None)

          Return a string describing the `class' of the operand.  The
          returned value is one of the following ten strings.

             * ‘"-Infinity"’, indicating that the operand is negative
               infinity.

             * ‘"-Normal"’, indicating that the operand is a negative
               normal number.

             * ‘"-Subnormal"’, indicating that the operand is negative
               and subnormal.

             * ‘"-Zero"’, indicating that the operand is a negative
               zero.

             * ‘"+Zero"’, indicating that the operand is a positive
               zero.

             * ‘"+Subnormal"’, indicating that the operand is positive
               and subnormal.

             * ‘"+Normal"’, indicating that the operand is a positive
               normal number.

             * ‘"+Infinity"’, indicating that the operand is positive
               infinity.

             * ‘"NaN"’, indicating that the operand is a quiet NaN (Not
               a Number).

             * ‘"sNaN"’, indicating that the operand is a signaling NaN.

      -- Method: quantize (exp, rounding=None, context=None)

          Return a value equal to the first operand after rounding and
          having the exponent of the second operand.

               >>> Decimal('1.41421356').quantize(Decimal('1.000'))
               Decimal('1.414')

          Unlike other operations, if the length of the coefficient
          after the quantize operation would be greater than precision,
          then an *note InvalidOperation: 9df. is signaled.  This
          guarantees that, unless there is an error condition, the
          quantized exponent is always equal to that of the right-hand
          operand.

          Also unlike other operations, quantize never signals
          Underflow, even if the result is subnormal and inexact.

          If the exponent of the second operand is larger than that of
          the first then rounding may be necessary.  In this case, the
          rounding mode is determined by the ‘rounding’ argument if
          given, else by the given ‘context’ argument; if neither
          argument is given the rounding mode of the current thread’s
          context is used.

          An error is returned whenever the resulting exponent is
          greater than ‘Emax’ or less than ‘Etiny’.

      -- Method: radix ()

          Return ‘Decimal(10)’, the radix (base) in which the *note
          Decimal: 188. class does all its arithmetic.  Included for
          compatibility with the specification.

      -- Method: remainder_near (other, context=None)

          Return the remainder from dividing `self' by `other'.  This
          differs from ‘self % other’ in that the sign of the remainder
          is chosen so as to minimize its absolute value.  More
          precisely, the return value is ‘self - n * other’ where ‘n’ is
          the integer nearest to the exact value of ‘self / other’, and
          if two integers are equally near then the even one is chosen.

          If the result is zero then its sign will be the sign of
          `self'.

               >>> Decimal(18).remainder_near(Decimal(10))
               Decimal('-2')
               >>> Decimal(25).remainder_near(Decimal(10))
               Decimal('5')
               >>> Decimal(35).remainder_near(Decimal(10))
               Decimal('-5')

      -- Method: rotate (other, context=None)

          Return the result of rotating the digits of the first operand
          by an amount specified by the second operand.  The second
          operand must be an integer in the range -precision through
          precision.  The absolute value of the second operand gives the
          number of places to rotate.  If the second operand is positive
          then rotation is to the left; otherwise rotation is to the
          right.  The coefficient of the first operand is padded on the
          left with zeros to length precision if necessary.  The sign
          and exponent of the first operand are unchanged.

      -- Method: same_quantum (other, context=None)

          Test whether self and other have the same exponent or whether
          both are ‘NaN’.

          This operation is unaffected by context and is quiet: no flags
          are changed and no rounding is performed.  As an exception,
          the C version may raise InvalidOperation if the second operand
          cannot be converted exactly.

      -- Method: scaleb (other, context=None)

          Return the first operand with exponent adjusted by the second.
          Equivalently, return the first operand multiplied by
          ‘10**other’.  The second operand must be an integer.

      -- Method: shift (other, context=None)

          Return the result of shifting the digits of the first operand
          by an amount specified by the second operand.  The second
          operand must be an integer in the range -precision through
          precision.  The absolute value of the second operand gives the
          number of places to shift.  If the second operand is positive
          then the shift is to the left; otherwise the shift is to the
          right.  Digits shifted into the coefficient are zeros.  The
          sign and exponent of the first operand are unchanged.

      -- Method: sqrt (context=None)

          Return the square root of the argument to full precision.

      -- Method: to_eng_string (context=None)

          Convert to a string, using engineering notation if an exponent
          is needed.

          Engineering notation has an exponent which is a multiple of 3.
          This can leave up to 3 digits to the left of the decimal place
          and may require the addition of either one or two trailing
          zeros.

          For example, this converts ‘Decimal('123E+1')’ to
          ‘Decimal('1.23E+3')’.

      -- Method: to_integral (rounding=None, context=None)

          Identical to the *note to_integral_value(): 19d8. method.  The
          ‘to_integral’ name has been kept for compatibility with older
          versions.

      -- Method: to_integral_exact (rounding=None, context=None)

          Round to the nearest integer, signaling *note Inexact: 199e.
          or *note Rounded: 199f. as appropriate if rounding occurs.
          The rounding mode is determined by the ‘rounding’ parameter if
          given, else by the given ‘context’.  If neither parameter is
          given then the rounding mode of the current context is used.

      -- Method: to_integral_value (rounding=None, context=None)

          Round to the nearest integer without signaling *note Inexact:
          199e. or *note Rounded: 199f.  If given, applies `rounding';
          otherwise, uses the rounding method in either the supplied
          `context' or the current context.

* Menu:

* Logical operands::


File: python.info,  Node: Logical operands,  Up: Decimal objects

5.9.4.3 Logical operands
........................

The ‘logical_and()’, ‘logical_invert()’, ‘logical_or()’, and
‘logical_xor()’ methods expect their arguments to be `logical operands'.
A `logical operand' is a *note Decimal: 188. instance whose exponent and
sign are both zero, and whose digits are all either ‘0’ or ‘1’.


File: python.info,  Node: Context objects,  Next: Constants<4>,  Prev: Decimal objects,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.4 Context objects
.......................

Contexts are environments for arithmetic operations.  They govern
precision, set rules for rounding, determine which signals are treated
as exceptions, and limit the range for exponents.

Each thread has its own current context which is accessed or changed
using the *note getcontext(): 19a5. and *note setcontext(): 19a6.
functions:

 -- Function: decimal.getcontext ()

     Return the current context for the active thread.

 -- Function: decimal.setcontext (c)

     Set the current context for the active thread to `c'.

You can also use the *note with: 6dd. statement and the *note
localcontext(): 1619. function to temporarily change the active context.

 -- Function: decimal.localcontext (ctx=None)

     Return a context manager that will set the current context for the
     active thread to a copy of `ctx' on entry to the with-statement and
     restore the previous context when exiting the with-statement.  If
     no context is specified, a copy of the current context is used.

     For example, the following code sets the current decimal precision
     to 42 places, performs a calculation, and then automatically
     restores the previous context:

          from decimal import localcontext

          with localcontext() as ctx:
              ctx.prec = 42   # Perform a high precision calculation
              s = calculate_something()
          s = +s  # Round the final result back to the default precision

New contexts can also be created using the *note Context: 9e4.
constructor described below.  In addition, the module provides three
pre-made contexts:

 -- Class: decimal.BasicContext

     This is a standard context defined by the General Decimal
     Arithmetic Specification.  Precision is set to nine.  Rounding is
     set to *note ROUND_HALF_UP: 1999.  All flags are cleared.  All
     traps are enabled (treated as exceptions) except *note Inexact:
     199e, *note Rounded: 199f, and *note Subnormal: 19a0.

     Because many of the traps are enabled, this context is useful for
     debugging.

 -- Class: decimal.ExtendedContext

     This is a standard context defined by the General Decimal
     Arithmetic Specification.  Precision is set to nine.  Rounding is
     set to *note ROUND_HALF_EVEN: 1998.  All flags are cleared.  No
     traps are enabled (so that exceptions are not raised during
     computations).

     Because the traps are disabled, this context is useful for
     applications that prefer to have result value of ‘NaN’ or
     ‘Infinity’ instead of raising exceptions.  This allows an
     application to complete a run in the presence of conditions that
     would otherwise halt the program.

 -- Class: decimal.DefaultContext

     This context is used by the *note Context: 9e4. constructor as a
     prototype for new contexts.  Changing a field (such a precision)
     has the effect of changing the default for new contexts created by
     the *note Context: 9e4. constructor.

     This context is most useful in multi-threaded environments.
     Changing one of the fields before threads are started has the
     effect of setting system-wide defaults.  Changing the fields after
     threads have started is not recommended as it would require thread
     synchronization to prevent race conditions.

     In single threaded environments, it is preferable to not use this
     context at all.  Instead, simply create contexts explicitly as
     described below.

     The default values are ‘prec’=‘28’, ‘rounding’=*note
     ROUND_HALF_EVEN: 1998, and enabled traps for *note Overflow: 19a1,
     *note InvalidOperation: 9df, and *note DivisionByZero: 199d.

In addition to the three supplied contexts, new contexts can be created
with the *note Context: 9e4. constructor.

 -- Class: decimal.Context (prec=None, rounding=None, Emin=None,
          Emax=None, capitals=None, clamp=None, flags=None, traps=None)

     Creates a new context.  If a field is not specified or is *note
     None: 157, the default values are copied from the *note
     DefaultContext: 9dc.  If the `flags' field is not specified or is
     *note None: 157, all flags are cleared.

     `prec' is an integer in the range [‘1’, *note MAX_PREC: 19dd.] that
     sets the precision for arithmetic operations in the context.

     The `rounding' option is one of the constants listed in the section
     *note Rounding Modes: 19de.

     The `traps' and `flags' fields list any signals to be set.
     Generally, new contexts should only set traps and leave the flags
     clear.

     The `Emin' and `Emax' fields are integers specifying the outer
     limits allowable for exponents.  `Emin' must be in the range [*note
     MIN_EMIN: 19df, ‘0’], `Emax' in the range [‘0’, *note MAX_EMAX:
     19e0.].

     The `capitals' field is either ‘0’ or ‘1’ (the default).  If set to
     ‘1’, exponents are printed with a capital ‘E’; otherwise, a
     lowercase ‘e’ is used: ‘Decimal('6.02e+23')’.

     The `clamp' field is either ‘0’ (the default) or ‘1’.  If set to
     ‘1’, the exponent ‘e’ of a *note Decimal: 188. instance
     representable in this context is strictly limited to the range
     ‘Emin - prec + 1 <= e <= Emax - prec + 1’.  If `clamp' is ‘0’ then
     a weaker condition holds: the adjusted exponent of the *note
     Decimal: 188. instance is at most ‘Emax’.  When `clamp' is ‘1’, a
     large normal number will, where possible, have its exponent reduced
     and a corresponding number of zeros added to its coefficient, in
     order to fit the exponent constraints; this preserves the value of
     the number but loses information about significant trailing zeros.
     For example:

          >>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
          Decimal('1.23000E+999')

     A `clamp' value of ‘1’ allows compatibility with the fixed-width
     decimal interchange formats specified in IEEE 754.

     The *note Context: 9e4. class defines several general purpose
     methods as well as a large number of methods for doing arithmetic
     directly in a given context.  In addition, for each of the *note
     Decimal: 188. methods described above (with the exception of the
     ‘adjusted()’ and ‘as_tuple()’ methods) there is a corresponding
     *note Context: 9e4. method.  For example, for a *note Context: 9e4.
     instance ‘C’ and *note Decimal: 188. instance ‘x’, ‘C.exp(x)’ is
     equivalent to ‘x.exp(context=C)’.  Each *note Context: 9e4. method
     accepts a Python integer (an instance of *note int: 184.) anywhere
     that a Decimal instance is accepted.

      -- Method: clear_flags ()

          Resets all of the flags to ‘0’.

      -- Method: clear_traps ()

          Resets all of the traps to ‘0’.

          New in version 3.3.

      -- Method: copy ()

          Return a duplicate of the context.

      -- Method: copy_decimal (num)

          Return a copy of the Decimal instance num.

      -- Method: create_decimal (num)

          Creates a new Decimal instance from `num' but using `self' as
          context.  Unlike the *note Decimal: 188. constructor, the
          context precision, rounding method, flags, and traps are
          applied to the conversion.

          This is useful because constants are often given to a greater
          precision than is needed by the application.  Another benefit
          is that rounding immediately eliminates unintended effects
          from digits beyond the current precision.  In the following
          example, using unrounded inputs means that adding zero to a
          sum can change the result:

               >>> getcontext().prec = 3
               >>> Decimal('3.4445') + Decimal('1.0023')
               Decimal('4.45')
               >>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
               Decimal('4.44')

          This method implements the to-number operation of the IBM
          specification.  If the argument is a string, no leading or
          trailing whitespace or underscores are permitted.

      -- Method: create_decimal_from_float (f)

          Creates a new Decimal instance from a float `f' but rounding
          using `self' as the context.  Unlike the *note
          Decimal.from_float(): b73. class method, the context
          precision, rounding method, flags, and traps are applied to
          the conversion.

               >>> context = Context(prec=5, rounding=ROUND_DOWN)
               >>> context.create_decimal_from_float(math.pi)
               Decimal('3.1415')
               >>> context = Context(prec=5, traps=[Inexact])
               >>> context.create_decimal_from_float(math.pi)
               Traceback (most recent call last):
                   ...
               decimal.Inexact: None

          New in version 3.1.

      -- Method: Etiny ()

          Returns a value equal to ‘Emin - prec + 1’ which is the
          minimum exponent value for subnormal results.  When underflow
          occurs, the exponent is set to *note Etiny: 19e6.

      -- Method: Etop ()

          Returns a value equal to ‘Emax - prec + 1’.

     The usual approach to working with decimals is to create *note
     Decimal: 188. instances and then apply arithmetic operations which
     take place within the current context for the active thread.  An
     alternative approach is to use context methods for calculating
     within a specific context.  The methods are similar to those for
     the *note Decimal: 188. class and are only briefly recounted here.

      -- Method: abs (x)

          Returns the absolute value of `x'.

      -- Method: add (x, y)

          Return the sum of `x' and `y'.

      -- Method: canonical (x)

          Returns the same Decimal object `x'.

      -- Method: compare (x, y)

          Compares `x' and `y' numerically.

      -- Method: compare_signal (x, y)

          Compares the values of the two operands numerically.

      -- Method: compare_total (x, y)

          Compares two operands using their abstract representation.

      -- Method: compare_total_mag (x, y)

          Compares two operands using their abstract representation,
          ignoring sign.

      -- Method: copy_abs (x)

          Returns a copy of `x' with the sign set to 0.

      -- Method: copy_negate (x)

          Returns a copy of `x' with the sign inverted.

      -- Method: copy_sign (x, y)

          Copies the sign from `y' to `x'.

      -- Method: divide (x, y)

          Return `x' divided by `y'.

      -- Method: divide_int (x, y)

          Return `x' divided by `y', truncated to an integer.

      -- Method: divmod (x, y)

          Divides two numbers and returns the integer part of the
          result.

      -- Method: exp (x)

          Returns ‘e ** x’.

      -- Method: fma (x, y, z)

          Returns `x' multiplied by `y', plus `z'.

      -- Method: is_canonical (x)

          Returns ‘True’ if `x' is canonical; otherwise returns ‘False’.

      -- Method: is_finite (x)

          Returns ‘True’ if `x' is finite; otherwise returns ‘False’.

      -- Method: is_infinite (x)

          Returns ‘True’ if `x' is infinite; otherwise returns ‘False’.

      -- Method: is_nan (x)

          Returns ‘True’ if `x' is a qNaN or sNaN; otherwise returns
          ‘False’.

      -- Method: is_normal (x)

          Returns ‘True’ if `x' is a normal number; otherwise returns
          ‘False’.

      -- Method: is_qnan (x)

          Returns ‘True’ if `x' is a quiet NaN; otherwise returns
          ‘False’.

      -- Method: is_signed (x)

          Returns ‘True’ if `x' is negative; otherwise returns ‘False’.

      -- Method: is_snan (x)

          Returns ‘True’ if `x' is a signaling NaN; otherwise returns
          ‘False’.

      -- Method: is_subnormal (x)

          Returns ‘True’ if `x' is subnormal; otherwise returns ‘False’.

      -- Method: is_zero (x)

          Returns ‘True’ if `x' is a zero; otherwise returns ‘False’.

      -- Method: ln (x)

          Returns the natural (base e) logarithm of `x'.

      -- Method: log10 (x)

          Returns the base 10 logarithm of `x'.

      -- Method: logb (x)

          Returns the exponent of the magnitude of the operand’s MSD.

      -- Method: logical_and (x, y)

          Applies the logical operation `and' between each operand’s
          digits.

      -- Method: logical_invert (x)

          Invert all the digits in `x'.

      -- Method: logical_or (x, y)

          Applies the logical operation `or' between each operand’s
          digits.

      -- Method: logical_xor (x, y)

          Applies the logical operation `xor' between each operand’s
          digits.

      -- Method: max (x, y)

          Compares two values numerically and returns the maximum.

      -- Method: max_mag (x, y)

          Compares the values numerically with their sign ignored.

      -- Method: min (x, y)

          Compares two values numerically and returns the minimum.

      -- Method: min_mag (x, y)

          Compares the values numerically with their sign ignored.

      -- Method: minus (x)

          Minus corresponds to the unary prefix minus operator in
          Python.

      -- Method: multiply (x, y)

          Return the product of `x' and `y'.

      -- Method: next_minus (x)

          Returns the largest representable number smaller than `x'.

      -- Method: next_plus (x)

          Returns the smallest representable number larger than `x'.

      -- Method: next_toward (x, y)

          Returns the number closest to `x', in direction towards `y'.

      -- Method: normalize (x)

          Reduces `x' to its simplest form.

      -- Method: number_class (x)

          Returns an indication of the class of `x'.

      -- Method: plus (x)

          Plus corresponds to the unary prefix plus operator in Python.
          This operation applies the context precision and rounding, so
          it is `not' an identity operation.

      -- Method: power (x, y, modulo=None)

          Return ‘x’ to the power of ‘y’, reduced modulo ‘modulo’ if
          given.

          With two arguments, compute ‘x**y’.  If ‘x’ is negative then
          ‘y’ must be integral.  The result will be inexact unless ‘y’
          is integral and the result is finite and can be expressed
          exactly in ‘precision’ digits.  The rounding mode of the
          context is used.  Results are always correctly-rounded in the
          Python version.

          Changed in version 3.3: The C module computes *note power():
          1a12. in terms of the correctly-rounded *note exp(): 19f4. and
          *note ln(): 19ff. functions.  The result is well-defined but
          only “almost always correctly-rounded”.

          With three arguments, compute ‘(x**y) % modulo’.  For the
          three argument form, the following restrictions on the
          arguments hold:

                  - all three arguments must be integral

                  - ‘y’ must be nonnegative

                  - at least one of ‘x’ or ‘y’ must be nonzero

                  - ‘modulo’ must be nonzero and have at most
                    ‘precision’ digits

          The value resulting from ‘Context.power(x, y, modulo)’ is
          equal to the value that would be obtained by computing ‘(x**y)
          % modulo’ with unbounded precision, but is computed more
          efficiently.  The exponent of the result is zero, regardless
          of the exponents of ‘x’, ‘y’ and ‘modulo’.  The result is
          always exact.

      -- Method: quantize (x, y)

          Returns a value equal to `x' (rounded), having the exponent of
          `y'.

      -- Method: radix ()

          Just returns 10, as this is Decimal, :)

      -- Method: remainder (x, y)

          Returns the remainder from integer division.

          The sign of the result, if non-zero, is the same as that of
          the original dividend.

      -- Method: remainder_near (x, y)

          Returns ‘x - y * n’, where `n' is the integer nearest the
          exact value of ‘x / y’ (if the result is 0 then its sign will
          be the sign of `x').

      -- Method: rotate (x, y)

          Returns a rotated copy of `x', `y' times.

      -- Method: same_quantum (x, y)

          Returns ‘True’ if the two operands have the same exponent.

      -- Method: scaleb (x, y)

          Returns the first operand after adding the second value its
          exp.

      -- Method: shift (x, y)

          Returns a shifted copy of `x', `y' times.

      -- Method: sqrt (x)

          Square root of a non-negative number to context precision.

      -- Method: subtract (x, y)

          Return the difference between `x' and `y'.

      -- Method: to_eng_string (x)

          Convert to a string, using engineering notation if an exponent
          is needed.

          Engineering notation has an exponent which is a multiple of 3.
          This can leave up to 3 digits to the left of the decimal place
          and may require the addition of either one or two trailing
          zeros.

      -- Method: to_integral_exact (x)

          Rounds to an integer.

      -- Method: to_sci_string (x)

          Converts a number to a string using scientific notation.


File: python.info,  Node: Constants<4>,  Next: Rounding modes,  Prev: Context objects,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.5 Constants
.................

The constants in this section are only relevant for the C module.  They
are also included in the pure Python version for compatibility.

                          32-bit                    64-bit
                                                    
----------------------------------------------------------------------------------------
                                                    
 -- Data:                 ‘425000000’               ‘999999999999999999’
          decimal.MAX_PREC                          

 -- Data:                 ‘425000000’               ‘999999999999999999’
          decimal.MAX_EMAX                          

 -- Data:                 ‘-425000000’              ‘-999999999999999999’
          decimal.MIN_EMIN                          

 -- Data:                 ‘-849999999’              ‘-1999999999999999997’
          decimal.MIN_ETINY                         

 -- Data: decimal.HAVE_THREADS

     The default value is ‘True’.  If Python is compiled without
     threads, the C version automatically disables the expensive thread
     local context machinery.  In this case, the value is ‘False’.


File: python.info,  Node: Rounding modes,  Next: Signals,  Prev: Constants<4>,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.6 Rounding modes
......................

 -- Data: decimal.ROUND_CEILING

     Round towards ‘Infinity’.

 -- Data: decimal.ROUND_DOWN

     Round towards zero.

 -- Data: decimal.ROUND_FLOOR

     Round towards ‘-Infinity’.

 -- Data: decimal.ROUND_HALF_DOWN

     Round to nearest with ties going towards zero.

 -- Data: decimal.ROUND_HALF_EVEN

     Round to nearest with ties going to nearest even integer.

 -- Data: decimal.ROUND_HALF_UP

     Round to nearest with ties going away from zero.

 -- Data: decimal.ROUND_UP

     Round away from zero.

 -- Data: decimal.ROUND_05UP

     Round away from zero if last digit after rounding towards zero
     would have been 0 or 5; otherwise round towards zero.


File: python.info,  Node: Signals,  Next: Floating Point Notes,  Prev: Rounding modes,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.7 Signals
...............

Signals represent conditions that arise during computation.  Each
corresponds to one context flag and one context trap enabler.

The context flag is set whenever the condition is encountered.  After
the computation, flags may be checked for informational purposes (for
instance, to determine whether a computation was exact).  After checking
the flags, be sure to clear all flags before starting the next
computation.

If the context’s trap enabler is set for the signal, then the condition
causes a Python exception to be raised.  For example, if the *note
DivisionByZero: 199d. trap is set, then a *note DivisionByZero: 199d.
exception is raised upon encountering the condition.

 -- Class: decimal.Clamped

     Altered an exponent to fit representation constraints.

     Typically, clamping occurs when an exponent falls outside the
     context’s ‘Emin’ and ‘Emax’ limits.  If possible, the exponent is
     reduced to fit by adding zeros to the coefficient.

 -- Class: decimal.DecimalException

     Base class for other signals and a subclass of *note
     ArithmeticError: 163a.

 -- Class: decimal.DivisionByZero

     Signals the division of a non-infinite number by zero.

     Can occur with division, modulo division, or when raising a number
     to a negative power.  If this signal is not trapped, returns
     ‘Infinity’ or ‘-Infinity’ with the sign determined by the inputs to
     the calculation.

 -- Class: decimal.Inexact

     Indicates that rounding occurred and the result is not exact.

     Signals when non-zero digits were discarded during rounding.  The
     rounded result is returned.  The signal flag or trap is used to
     detect when results are inexact.

 -- Class: decimal.InvalidOperation

     An invalid operation was performed.

     Indicates that an operation was requested that does not make sense.
     If not trapped, returns ‘NaN’.  Possible causes include:

          Infinity - Infinity
          0 * Infinity
          Infinity / Infinity
          x % 0
          Infinity % x
          sqrt(-x) and x > 0
          0 ** 0
          x ** (non-integer)
          x ** Infinity

 -- Class: decimal.Overflow

     Numerical overflow.

     Indicates the exponent is larger than ‘Emax’ after rounding has
     occurred.  If not trapped, the result depends on the rounding mode,
     either pulling inward to the largest representable finite number or
     rounding outward to ‘Infinity’.  In either case, *note Inexact:
     199e. and *note Rounded: 199f. are also signaled.

 -- Class: decimal.Rounded

     Rounding occurred though possibly no information was lost.

     Signaled whenever rounding discards digits; even if those digits
     are zero (such as rounding ‘5.00’ to ‘5.0’).  If not trapped,
     returns the result unchanged.  This signal is used to detect loss
     of significant digits.

 -- Class: decimal.Subnormal

     Exponent was lower than ‘Emin’ prior to rounding.

     Occurs when an operation result is subnormal (the exponent is too
     small).  If not trapped, returns the result unchanged.

 -- Class: decimal.Underflow

     Numerical underflow with result rounded to zero.

     Occurs when a subnormal result is pushed to zero by rounding.
     *note Inexact: 199e. and *note Subnormal: 19a0. are also signaled.

 -- Class: decimal.FloatOperation

     Enable stricter semantics for mixing floats and Decimals.

     If the signal is not trapped (default), mixing floats and Decimals
     is permitted in the *note Decimal: 188. constructor, *note
     create_decimal(): 9e0. and all comparison operators.  Both
     conversion and comparisons are exact.  Any occurrence of a mixed
     operation is silently recorded by setting *note FloatOperation:
     9d9. in the context flags.  Explicit conversions with *note
     from_float(): b73. or *note create_decimal_from_float(): 19e5. do
     not set the flag.

     Otherwise (the signal is trapped), only equality comparisons and
     explicit conversions are silent.  All other mixed operations raise
     *note FloatOperation: 9d9.

The following table summarizes the hierarchy of signals:

     exceptions.ArithmeticError(exceptions.Exception)
         DecimalException
             Clamped
             DivisionByZero(DecimalException, exceptions.ZeroDivisionError)
             Inexact
                 Overflow(Inexact, Rounded)
                 Underflow(Inexact, Rounded, Subnormal)
             InvalidOperation
             Rounded
             Subnormal
             FloatOperation(DecimalException, exceptions.TypeError)


File: python.info,  Node: Floating Point Notes,  Next: Working with threads,  Prev: Signals,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.8 Floating Point Notes
............................

* Menu:

* Mitigating round-off error with increased precision::
* Special values::


File: python.info,  Node: Mitigating round-off error with increased precision,  Next: Special values,  Up: Floating Point Notes

5.9.4.9 Mitigating round-off error with increased precision
...........................................................

The use of decimal floating point eliminates decimal representation
error (making it possible to represent ‘0.1’ exactly); however, some
operations can still incur round-off error when non-zero digits exceed
the fixed precision.

The effects of round-off error can be amplified by the addition or
subtraction of nearly offsetting quantities resulting in loss of
significance.  Knuth provides two instructive examples where rounded
floating point arithmetic with insufficient precision causes the
breakdown of the associative and distributive properties of addition:

     # Examples from Seminumerical Algorithms, Section 4.2.2.
     >>> from decimal import Decimal, getcontext
     >>> getcontext().prec = 8

     >>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
     >>> (u + v) + w
     Decimal('9.5111111')
     >>> u + (v + w)
     Decimal('10')

     >>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
     >>> (u*v) + (u*w)
     Decimal('0.01')
     >>> u * (v+w)
     Decimal('0.0060000')

The *note decimal: 36. module makes it possible to restore the
identities by expanding the precision sufficiently to avoid loss of
significance:

     >>> getcontext().prec = 20
     >>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
     >>> (u + v) + w
     Decimal('9.51111111')
     >>> u + (v + w)
     Decimal('9.51111111')
     >>>
     >>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
     >>> (u*v) + (u*w)
     Decimal('0.0060000')
     >>> u * (v+w)
     Decimal('0.0060000')


File: python.info,  Node: Special values,  Prev: Mitigating round-off error with increased precision,  Up: Floating Point Notes

5.9.4.10 Special values
.......................

The number system for the *note decimal: 36. module provides special
values including ‘NaN’, ‘sNaN’, ‘-Infinity’, ‘Infinity’, and two zeros,
‘+0’ and ‘-0’.

Infinities can be constructed directly with: ‘Decimal('Infinity')’.
Also, they can arise from dividing by zero when the *note
DivisionByZero: 199d. signal is not trapped.  Likewise, when the *note
Overflow: 19a1. signal is not trapped, infinity can result from rounding
beyond the limits of the largest representable number.

The infinities are signed (affine) and can be used in arithmetic
operations where they get treated as very large, indeterminate numbers.
For instance, adding a constant to infinity gives another infinite
result.

Some operations are indeterminate and return ‘NaN’, or if the *note
InvalidOperation: 9df. signal is trapped, raise an exception.  For
example, ‘0/0’ returns ‘NaN’ which means “not a number”.  This variety
of ‘NaN’ is quiet and, once created, will flow through other
computations always resulting in another ‘NaN’.  This behavior can be
useful for a series of computations that occasionally have missing
inputs — it allows the calculation to proceed while flagging specific
results as invalid.

A variant is ‘sNaN’ which signals rather than remaining quiet after
every operation.  This is a useful return value when an invalid result
needs to interrupt a calculation for special handling.

The behavior of Python’s comparison operators can be a little surprising
where a ‘NaN’ is involved.  A test for equality where one of the
operands is a quiet or signaling ‘NaN’ always returns *note False: 37d.
(even when doing ‘Decimal('NaN')==Decimal('NaN')’), while a test for
inequality always returns *note True: 48f.  An attempt to compare two
Decimals using any of the ‘<’, ‘<=’, ‘>’ or ‘>=’ operators will raise
the *note InvalidOperation: 9df. signal if either operand is a ‘NaN’,
and return *note False: 37d. if this signal is not trapped.  Note that
the General Decimal Arithmetic specification does not specify the
behavior of direct comparisons; these rules for comparisons involving a
‘NaN’ were taken from the IEEE 854 standard (see Table 3 in section
5.7).  To ensure strict standards-compliance, use the ‘compare()’ and
‘compare-signal()’ methods instead.

The signed zeros can result from calculations that underflow.  They keep
the sign that would have resulted if the calculation had been carried
out to greater precision.  Since their magnitude is zero, both positive
and negative zeros are treated as equal and their sign is informational.

In addition to the two signed zeros which are distinct yet equal, there
are various representations of zero with differing precisions yet
equivalent in value.  This takes a bit of getting used to.  For an eye
accustomed to normalized floating point representations, it is not
immediately obvious that the following calculation returns a value equal
to zero:

     >>> 1 / Decimal('Infinity')
     Decimal('0E-1000026')


File: python.info,  Node: Working with threads,  Next: Recipes,  Prev: Floating Point Notes,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.11 Working with threads
.............................

The *note getcontext(): 19a5. function accesses a different *note
Context: 9e4. object for each thread.  Having separate thread contexts
means that threads may make changes (such as ‘getcontext().prec=10’)
without interfering with other threads.

Likewise, the *note setcontext(): 19a6. function automatically assigns
its target to the current thread.

If *note setcontext(): 19a6. has not been called before *note
getcontext(): 19a5, then *note getcontext(): 19a5. will automatically
create a new context for use in the current thread.

The new context is copied from a prototype context called
`DefaultContext'.  To control the defaults so that each thread will use
the same values throughout the application, directly modify the
`DefaultContext' object.  This should be done `before' any threads are
started so that there won’t be a race condition between threads calling
*note getcontext(): 19a5.  For example:

     # Set applicationwide defaults for all threads about to be launched
     DefaultContext.prec = 12
     DefaultContext.rounding = ROUND_DOWN
     DefaultContext.traps = ExtendedContext.traps.copy()
     DefaultContext.traps[InvalidOperation] = 1
     setcontext(DefaultContext)

     # Afterwards, the threads can be started
     t1.start()
     t2.start()
     t3.start()
      . . .


File: python.info,  Node: Recipes,  Next: Decimal FAQ,  Prev: Working with threads,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.12 Recipes
................

Here are a few recipes that serve as utility functions and that
demonstrate ways to work with the *note Decimal: 188. class:

     def moneyfmt(value, places=2, curr='', sep=',', dp='.',
                  pos='', neg='-', trailneg=''):
         """Convert Decimal to a money formatted string.

         places:  required number of places after the decimal point
         curr:    optional currency symbol before the sign (may be blank)
         sep:     optional grouping separator (comma, period, space, or blank)
         dp:      decimal point indicator (comma or period)
                  only specify as blank when places is zero
         pos:     optional sign for positive numbers: '+', space or blank
         neg:     optional sign for negative numbers: '-', '(', space or blank
         trailneg:optional trailing minus indicator:  '-', ')', space or blank

         >>> d = Decimal('-1234567.8901')
         >>> moneyfmt(d, curr='$')
         '-$1,234,567.89'
         >>> moneyfmt(d, places=0, sep='.', dp='', neg='', trailneg='-')
         '1.234.568-'
         >>> moneyfmt(d, curr='$', neg='(', trailneg=')')
         '($1,234,567.89)'
         >>> moneyfmt(Decimal(123456789), sep=' ')
         '123 456 789.00'
         >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>')
         '<0.02>'

         """
         q = Decimal(10) ** -places      # 2 places --> '0.01'
         sign, digits, exp = value.quantize(q).as_tuple()
         result = []
         digits = list(map(str, digits))
         build, next = result.append, digits.pop
         if sign:
             build(trailneg)
         for i in range(places):
             build(next() if digits else '0')
         if places:
             build(dp)
         if not digits:
             build('0')
         i = 0
         while digits:
             build(next())
             i += 1
             if i == 3 and digits:
                 i = 0
                 build(sep)
         build(curr)
         build(neg if sign else pos)
         return ''.join(reversed(result))

     def pi():
         """Compute Pi to the current precision.

         >>> print(pi())
         3.141592653589793238462643383

         """
         getcontext().prec += 2  # extra digits for intermediate steps
         three = Decimal(3)      # substitute "three=3.0" for regular floats
         lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24
         while s != lasts:
             lasts = s
             n, na = n+na, na+8
             d, da = d+da, da+32
             t = (t * n) / d
             s += t
         getcontext().prec -= 2
         return +s               # unary plus applies the new precision

     def exp(x):
         """Return e raised to the power of x.  Result type matches input type.

         >>> print(exp(Decimal(1)))
         2.718281828459045235360287471
         >>> print(exp(Decimal(2)))
         7.389056098930650227230427461
         >>> print(exp(2.0))
         7.38905609893
         >>> print(exp(2+0j))
         (7.38905609893+0j)

         """
         getcontext().prec += 2
         i, lasts, s, fact, num = 0, 0, 1, 1, 1
         while s != lasts:
             lasts = s
             i += 1
             fact *= i
             num *= x
             s += num / fact
         getcontext().prec -= 2
         return +s

     def cos(x):
         """Return the cosine of x as measured in radians.

         The Taylor series approximation works best for a small value of x.
         For larger values, first compute x = x % (2 * pi).

         >>> print(cos(Decimal('0.5')))
         0.8775825618903727161162815826
         >>> print(cos(0.5))
         0.87758256189
         >>> print(cos(0.5+0j))
         (0.87758256189+0j)

         """
         getcontext().prec += 2
         i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1
         while s != lasts:
             lasts = s
             i += 2
             fact *= i * (i-1)
             num *= x * x
             sign *= -1
             s += num / fact * sign
         getcontext().prec -= 2
         return +s

     def sin(x):
         """Return the sine of x as measured in radians.

         The Taylor series approximation works best for a small value of x.
         For larger values, first compute x = x % (2 * pi).

         >>> print(sin(Decimal('0.5')))
         0.4794255386042030002732879352
         >>> print(sin(0.5))
         0.479425538604
         >>> print(sin(0.5+0j))
         (0.479425538604+0j)

         """
         getcontext().prec += 2
         i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1
         while s != lasts:
             lasts = s
             i += 2
             fact *= i * (i-1)
             num *= x * x
             sign *= -1
             s += num / fact * sign
         getcontext().prec -= 2
         return +s


File: python.info,  Node: Decimal FAQ,  Prev: Recipes,  Up: decimal — Decimal fixed point and floating point arithmetic

5.9.4.13 Decimal FAQ
....................

Q. It is cumbersome to type ‘decimal.Decimal('1234.5')’.  Is there a way
to minimize typing when using the interactive interpreter?

A. Some users abbreviate the constructor to just a single letter:

     >>> D = decimal.Decimal
     >>> D('1.23') + D('3.45')
     Decimal('4.68')

Q. In a fixed-point application with two decimal places, some inputs
have many places and need to be rounded.  Others are not supposed to
have excess digits and need to be validated.  What methods should be
used?

A. The ‘quantize()’ method rounds to a fixed number of decimal places.
If the *note Inexact: 199e. trap is set, it is also useful for
validation:

     >>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')

     >>> # Round to two places
     >>> Decimal('3.214').quantize(TWOPLACES)
     Decimal('3.21')

     >>> # Validate that a number does not exceed two places
     >>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
     Decimal('3.21')

     >>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
     Traceback (most recent call last):
        ...
     Inexact: None

Q. Once I have valid two place inputs, how do I maintain that invariant
throughout an application?

A. Some operations like addition, subtraction, and multiplication by an
integer will automatically preserve fixed point.  Others operations,
like division and non-integer multiplication, will change the number of
decimal places and need to be followed-up with a ‘quantize()’ step:

     >>> a = Decimal('102.72')           # Initial fixed-point values
     >>> b = Decimal('3.17')
     >>> a + b                           # Addition preserves fixed-point
     Decimal('105.89')
     >>> a - b
     Decimal('99.55')
     >>> a * 42                          # So does integer multiplication
     Decimal('4314.24')
     >>> (a * b).quantize(TWOPLACES)     # Must quantize non-integer multiplication
     Decimal('325.62')
     >>> (b / a).quantize(TWOPLACES)     # And quantize division
     Decimal('0.03')

In developing fixed-point applications, it is convenient to define
functions to handle the ‘quantize()’ step:

     >>> def mul(x, y, fp=TWOPLACES):
     ...     return (x * y).quantize(fp)
     >>> def div(x, y, fp=TWOPLACES):
     ...     return (x / y).quantize(fp)

     >>> mul(a, b)                       # Automatically preserve fixed-point
     Decimal('325.62')
     >>> div(b, a)
     Decimal('0.03')

Q. There are many ways to express the same value.  The numbers ‘200’,
‘200.000’, ‘2E2’, and ‘02E+4’ all have the same value at various
precisions.  Is there a way to transform them to a single recognizable
canonical value?

A. The ‘normalize()’ method maps all equivalent values to a single
representative:

     >>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split())
     >>> [v.normalize() for v in values]
     [Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')]

Q. Some decimal values always print with exponential notation.  Is there
a way to get a non-exponential representation?

A. For some values, exponential notation is the only way to express the
number of significant places in the coefficient.  For example,
expressing ‘5.0E+3’ as ‘5000’ keeps the value constant but cannot show
the original’s two-place significance.

If an application does not care about tracking significance, it is easy
to remove the exponent and trailing zeroes, losing significance, but
keeping the value unchanged:

     >>> def remove_exponent(d):
     ...     return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()

     >>> remove_exponent(Decimal('5E+3'))
     Decimal('5000')

Q. Is there a way to convert a regular float to a *note Decimal: 188.?

A. Yes, any binary floating point number can be exactly expressed as a
Decimal though an exact conversion may take more precision than
intuition would suggest:

     >>> Decimal(math.pi)
     Decimal('3.141592653589793115997963468544185161590576171875')

Q. Within a complex calculation, how can I make sure that I haven’t
gotten a spurious result because of insufficient precision or rounding
anomalies.

A. The decimal module makes it easy to test results.  A best practice is
to re-run calculations using greater precision and with various rounding
modes.  Widely differing results indicate insufficient precision,
rounding mode issues, ill-conditioned inputs, or a numerically unstable
algorithm.

Q. I noticed that context precision is applied to the results of
operations but not to the inputs.  Is there anything to watch out for
when mixing values of different precisions?

A. Yes.  The principle is that all values are considered to be exact and
so is the arithmetic on those values.  Only the results are rounded.
The advantage for inputs is that “what you type is what you get”.  A
disadvantage is that the results can look odd if you forget that the
inputs haven’t been rounded:

     >>> getcontext().prec = 3
     >>> Decimal('3.104') + Decimal('2.104')
     Decimal('5.21')
     >>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
     Decimal('5.20')

The solution is either to increase precision or to force rounding of
inputs using the unary plus operation:

     >>> getcontext().prec = 3
     >>> +Decimal('1.23456789')      # unary plus triggers rounding
     Decimal('1.23')

Alternatively, inputs can be rounded upon creation using the *note
Context.create_decimal(): 9e0. method:

     >>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
     Decimal('1.2345')

Q. Is the CPython implementation fast for large numbers?

A. Yes.  In the CPython and PyPy3 implementations, the C/CFFI versions
of the decimal module integrate the high speed libmpdec(1) library for
arbitrary precision correctly-rounded decimal floating point arithmetic.
‘libmpdec’ uses Karatsuba multiplication(2) for medium-sized numbers and
the Number Theoretic Transform(3) for very large numbers.  However, to
realize this performance gain, the context needs to be set for unrounded
calculations.

     >>> c = getcontext()
     >>> c.prec = MAX_PREC
     >>> c.Emax = MAX_EMAX
     >>> c.Emin = MIN_EMIN

New in version 3.3.

   ---------- Footnotes ----------

   (1) https://www.bytereef.org/mpdecimal/doc/libmpdec/index.html

   (2) https://en.wikipedia.org/wiki/Karatsuba_algorithm

   (3) 
https://en.wikipedia.org/wiki/Discrete_Fourier_transform_(general)#Number-theoretic_transform


File: python.info,  Node: fractions — Rational numbers,  Next: random — Generate pseudo-random numbers,  Prev: decimal — Decimal fixed point and floating point arithmetic,  Up: Numeric and Mathematical Modules

5.9.5 ‘fractions’ — Rational numbers
------------------------------------

`Source code:' Lib/fractions.py(1)

__________________________________________________________________

The *note fractions: 83. module provides support for rational number
arithmetic.

A Fraction instance can be constructed from a pair of integers, from
another rational number, or from a string.

 -- Class: fractions.Fraction (numerator=0, denominator=1)

 -- Class: fractions.Fraction (other_fraction)

 -- Class: fractions.Fraction (float)

 -- Class: fractions.Fraction (decimal)

 -- Class: fractions.Fraction (string)

     The first version requires that `numerator' and `denominator' are
     instances of *note numbers.Rational: c4b. and returns a new *note
     Fraction: 185. instance with value ‘numerator/denominator’.  If
     `denominator' is ‘0’, it raises a *note ZeroDivisionError: 11e6.
     The second version requires that `other_fraction' is an instance of
     *note numbers.Rational: c4b. and returns a *note Fraction: 185.
     instance with the same value.  The next two versions accept either
     a *note float: 187. or a *note decimal.Decimal: 188. instance, and
     return a *note Fraction: 185. instance with exactly the same value.
     Note that due to the usual issues with binary floating-point (see
     *note Floating Point Arithmetic; Issues and Limitations: 125c.),
     the argument to ‘Fraction(1.1)’ is not exactly equal to 11/10, and
     so ‘Fraction(1.1)’ does `not' return ‘Fraction(11, 10)’ as one
     might expect.  (But see the documentation for the *note
     limit_denominator(): 1a32. method below.)  The last version of the
     constructor expects a string or unicode instance.  The usual form
     for this instance is:

          [sign] numerator ['/' denominator]

     where the optional ‘sign’ may be either ‘+’ or ‘-‘ and ‘numerator’
     and ‘denominator’ (if present) are strings of decimal digits.  In
     addition, any string that represents a finite value and is accepted
     by the *note float: 187. constructor is also accepted by the *note
     Fraction: 185. constructor.  In either form the input string may
     also have leading and/or trailing whitespace.  Here are some
     examples:

          >>> from fractions import Fraction
          >>> Fraction(16, -10)
          Fraction(-8, 5)
          >>> Fraction(123)
          Fraction(123, 1)
          >>> Fraction()
          Fraction(0, 1)
          >>> Fraction('3/7')
          Fraction(3, 7)
          >>> Fraction(' -3/7 ')
          Fraction(-3, 7)
          >>> Fraction('1.414213 \t\n')
          Fraction(1414213, 1000000)
          >>> Fraction('-.125')
          Fraction(-1, 8)
          >>> Fraction('7e-6')
          Fraction(7, 1000000)
          >>> Fraction(2.25)
          Fraction(9, 4)
          >>> Fraction(1.1)
          Fraction(2476979795053773, 2251799813685248)
          >>> from decimal import Decimal
          >>> Fraction(Decimal('1.1'))
          Fraction(11, 10)

     The *note Fraction: 185. class inherits from the abstract base
     class *note numbers.Rational: c4b, and implements all of the
     methods and operations from that class.  *note Fraction: 185.
     instances are hashable, and should be treated as immutable.  In
     addition, *note Fraction: 185. has the following properties and
     methods:

     Changed in version 3.2: The *note Fraction: 185. constructor now
     accepts *note float: 187. and *note decimal.Decimal: 188.
     instances.

      -- Attribute: numerator

          Numerator of the Fraction in lowest term.

      -- Attribute: denominator

          Denominator of the Fraction in lowest term.

      -- Method: as_integer_ratio ()

          Return a tuple of two integers, whose ratio is equal to the
          Fraction and with a positive denominator.

          New in version 3.8.

      -- Method: from_float (flt)

          This class method constructs a *note Fraction: 185.
          representing the exact value of `flt', which must be a *note
          float: 187.  Beware that ‘Fraction.from_float(0.3)’ is not the
          same value as ‘Fraction(3, 10)’.

               Note: From Python 3.2 onwards, you can also construct a
               *note Fraction: 185. instance directly from a *note
               float: 187.

      -- Method: from_decimal (dec)

          This class method constructs a *note Fraction: 185.
          representing the exact value of `dec', which must be a *note
          decimal.Decimal: 188. instance.

               Note: From Python 3.2 onwards, you can also construct a
               *note Fraction: 185. instance directly from a *note
               decimal.Decimal: 188. instance.

      -- Method: limit_denominator (max_denominator=1000000)

          Finds and returns the closest *note Fraction: 185. to ‘self’
          that has denominator at most max_denominator.  This method is
          useful for finding rational approximations to a given
          floating-point number:

               >>> from fractions import Fraction
               >>> Fraction('3.1415926535897932').limit_denominator(1000)
               Fraction(355, 113)

          or for recovering a rational number that’s represented as a
          float:

               >>> from math import pi, cos
               >>> Fraction(cos(pi/3))
               Fraction(4503599627370497, 9007199254740992)
               >>> Fraction(cos(pi/3)).limit_denominator()
               Fraction(1, 2)
               >>> Fraction(1.1).limit_denominator()
               Fraction(11, 10)

      -- Method: __floor__ ()

          Returns the greatest *note int: 184. ‘<= self’.  This method
          can also be accessed through the *note math.floor(): d1f.
          function:

               >>> from math import floor
               >>> floor(Fraction(355, 113))
               3

      -- Method: __ceil__ ()

          Returns the least *note int: 184. ‘>= self’.  This method can
          also be accessed through the *note math.ceil(): d20. function.

      -- Method: __round__ ()

      -- Method: __round__ (ndigits)

          The first version returns the nearest *note int: 184. to
          ‘self’, rounding half to even.  The second version rounds
          ‘self’ to the nearest multiple of ‘Fraction(1, 10**ndigits)’
          (logically, if ‘ndigits’ is negative), again rounding half
          toward even.  This method can also be accessed through the
          *note round(): c60. function.

 -- Function: fractions.gcd (a, b)

     Return the greatest common divisor of the integers `a' and `b'.  If
     either `a' or `b' is nonzero, then the absolute value of ‘gcd(a,
     b)’ is the largest integer that divides both `a' and `b'.
     ‘gcd(a,b)’ has the same sign as `b' if `b' is nonzero; otherwise it
     takes the sign of `a'.  ‘gcd(0, 0)’ returns ‘0’.

     Deprecated since version 3.5: Use *note math.gcd(): 70a. instead.

See also
........

Module *note numbers: c1.

     The abstract base classes making up the numeric tower.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/fractions.py


File: python.info,  Node: random — Generate pseudo-random numbers,  Next: statistics — Mathematical statistics functions,  Prev: fractions — Rational numbers,  Up: Numeric and Mathematical Modules

5.9.6 ‘random’ — Generate pseudo-random numbers
-----------------------------------------------

`Source code:' Lib/random.py(1)

__________________________________________________________________

This module implements pseudo-random number generators for various
distributions.

For integers, there is uniform selection from a range.  For sequences,
there is uniform selection of a random element, a function to generate a
random permutation of a list in-place, and a function for random
sampling without replacement.

On the real line, there are functions to compute uniform, normal
(Gaussian), lognormal, negative exponential, gamma, and beta
distributions.  For generating distributions of angles, the von Mises
distribution is available.

Almost all module functions depend on the basic function *note random():
1a3b, which generates a random float uniformly in the semi-open range
[0.0, 1.0).  Python uses the Mersenne Twister as the core generator.  It
produces 53-bit precision floats and has a period of 2**19937-1.  The
underlying implementation in C is both fast and threadsafe.  The
Mersenne Twister is one of the most extensively tested random number
generators in existence.  However, being completely deterministic, it is
not suitable for all purposes, and is completely unsuitable for
cryptographic purposes.

The functions supplied by this module are actually bound methods of a
hidden instance of the *note random.Random: 1a3c. class.  You can
instantiate your own instances of *note Random: 1a3c. to get generators
that don’t share state.

Class *note Random: 1a3c. can also be subclassed if you want to use a
different basic generator of your own devising: in that case, override
the ‘random()’, ‘seed()’, ‘getstate()’, and ‘setstate()’ methods.
Optionally, a new generator can supply a ‘getrandbits()’ method — this
allows *note randrange(): bae. to produce selections over an arbitrarily
large range.

The *note random: dc. module also provides the *note SystemRandom: 1a3d.
class which uses the system function *note os.urandom(): 4c6. to
generate random numbers from sources provided by the operating system.

     Warning: The pseudo-random generators of this module should not be
     used for security purposes.  For security or cryptographic uses,
     see the *note secrets: e4. module.

See also
........

M. Matsumoto and T. Nishimura, “Mersenne Twister: A 623-dimensionally
equidistributed uniform pseudorandom number generator”, ACM Transactions
on Modeling and Computer Simulation Vol.  8, No.  1, January pp.3–30
1998.

Complementary-Multiply-with-Carry recipe(2) for a compatible alternative
random number generator with a long period and comparatively simple
update operations.

* Menu:

* Bookkeeping functions::
* Functions for integers::
* Functions for sequences::
* Real-valued distributions::
* Alternative Generator::
* Notes on Reproducibility::
* Examples and Recipes::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/random.py

   (2) https://code.activestate.com/recipes/576707/


File: python.info,  Node: Bookkeeping functions,  Next: Functions for integers,  Up: random — Generate pseudo-random numbers

5.9.6.1 Bookkeeping functions
.............................

 -- Function: random.seed (a=None, version=2)

     Initialize the random number generator.

     If `a' is omitted or ‘None’, the current system time is used.  If
     randomness sources are provided by the operating system, they are
     used instead of the system time (see the *note os.urandom(): 4c6.
     function for details on availability).

     If `a' is an int, it is used directly.

     With version 2 (the default), a *note str: 325, *note bytes: 326,
     or *note bytearray: 327. object gets converted to an *note int:
     184. and all of its bits are used.

     With version 1 (provided for reproducing random sequences from
     older versions of Python), the algorithm for *note str: 325. and
     *note bytes: 326. generates a narrower range of seeds.

     Changed in version 3.2: Moved to the version 2 scheme which uses
     all of the bits in a string seed.

 -- Function: random.getstate ()

     Return an object capturing the current internal state of the
     generator.  This object can be passed to *note setstate(): 1a40. to
     restore the state.

 -- Function: random.setstate (state)

     `state' should have been obtained from a previous call to *note
     getstate(): 1a3f, and *note setstate(): 1a40. restores the internal
     state of the generator to what it was at the time *note getstate():
     1a3f. was called.

 -- Function: random.getrandbits (k)

     Returns a Python integer with `k' random bits.  This method is
     supplied with the MersenneTwister generator and some other
     generators may also provide it as an optional part of the API. When
     available, *note getrandbits(): 927. enables *note randrange():
     bae. to handle arbitrarily large ranges.


File: python.info,  Node: Functions for integers,  Next: Functions for sequences,  Prev: Bookkeeping functions,  Up: random — Generate pseudo-random numbers

5.9.6.2 Functions for integers
..............................

 -- Function: random.randrange (stop)

 -- Function: random.randrange (start, stop[, step])

     Return a randomly selected element from ‘range(start, stop, step)’.
     This is equivalent to ‘choice(range(start, stop, step))’, but
     doesn’t actually build a range object.

     The positional argument pattern matches that of *note range(): 9b2.
     Keyword arguments should not be used because the function may use
     them in unexpected ways.

     Changed in version 3.2: *note randrange(): bae. is more
     sophisticated about producing equally distributed values.  Formerly
     it used a style like ‘int(random()*n)’ which could produce slightly
     uneven distributions.

 -- Function: random.randint (a, b)

     Return a random integer `N' such that ‘a <= N <= b’.  Alias for
     ‘randrange(a, b+1)’.


File: python.info,  Node: Functions for sequences,  Next: Real-valued distributions,  Prev: Functions for integers,  Up: random — Generate pseudo-random numbers

5.9.6.3 Functions for sequences
...............................

 -- Function: random.choice (seq)

     Return a random element from the non-empty sequence `seq'.  If
     `seq' is empty, raises *note IndexError: e69.

 -- Function: random.choices (population, weights=None, *,
          cum_weights=None, k=1)

     Return a `k' sized list of elements chosen from the `population'
     with replacement.  If the `population' is empty, raises *note
     IndexError: e69.

     If a `weights' sequence is specified, selections are made according
     to the relative weights.  Alternatively, if a `cum_weights'
     sequence is given, the selections are made according to the
     cumulative weights (perhaps computed using *note
     itertools.accumulate(): 1db.).  For example, the relative weights
     ‘[10, 5, 30, 5]’ are equivalent to the cumulative weights ‘[10, 15,
     45, 50]’.  Internally, the relative weights are converted to
     cumulative weights before making selections, so supplying the
     cumulative weights saves work.

     If neither `weights' nor `cum_weights' are specified, selections
     are made with equal probability.  If a weights sequence is
     supplied, it must be the same length as the `population' sequence.
     It is a *note TypeError: 192. to specify both `weights' and
     `cum_weights'.

     The `weights' or `cum_weights' can use any numeric type that
     interoperates with the *note float: 187. values returned by *note
     random(): dc. (that includes integers, floats, and fractions but
     excludes decimals).  Weights are assumed to be non-negative.

     For a given seed, the *note choices(): 569. function with equal
     weighting typically produces a different sequence than repeated
     calls to *note choice(): bb0.  The algorithm used by *note
     choices(): 569. uses floating point arithmetic for internal
     consistency and speed.  The algorithm used by *note choice(): bb0.
     defaults to integer arithmetic with repeated selections to avoid
     small biases from round-off error.

     New in version 3.6.

 -- Function: random.shuffle (x[, random])

     Shuffle the sequence `x' in place.

     The optional argument `random' is a 0-argument function returning a
     random float in [0.0, 1.0); by default, this is the function *note
     random(): 1a3b.

     To shuffle an immutable sequence and return a new shuffled list,
     use ‘sample(x, k=len(x))’ instead.

     Note that even for small ‘len(x)’, the total number of permutations
     of `x' can quickly grow larger than the period of most random
     number generators.  This implies that most permutations of a long
     sequence can never be generated.  For example, a sequence of length
     2080 is the largest that can fit within the period of the Mersenne
     Twister random number generator.

 -- Function: random.sample (population, k)

     Return a `k' length list of unique elements chosen from the
     population sequence or set.  Used for random sampling without
     replacement.

     Returns a new list containing elements from the population while
     leaving the original population unchanged.  The resulting list is
     in selection order so that all sub-slices will also be valid random
     samples.  This allows raffle winners (the sample) to be partitioned
     into grand prize and second place winners (the subslices).

     Members of the population need not be *note hashable: 1364. or
     unique.  If the population contains repeats, then each occurrence
     is a possible selection in the sample.

     To choose a sample from a range of integers, use a *note range():
     9b2. object as an argument.  This is especially fast and space
     efficient for sampling from a large population:
     ‘sample(range(10000000), k=60)’.

     If the sample size is larger than the population size, a *note
     ValueError: 1f9. is raised.


File: python.info,  Node: Real-valued distributions,  Next: Alternative Generator,  Prev: Functions for sequences,  Up: random — Generate pseudo-random numbers

5.9.6.4 Real-valued distributions
.................................

The following functions generate specific real-valued distributions.
Function parameters are named after the corresponding variables in the
distribution’s equation, as used in common mathematical practice; most
of these equations can be found in any statistics text.

 -- Function: random.random ()

     Return the next random floating point number in the range [0.0,
     1.0).

 -- Function: random.uniform (a, b)

     Return a random floating point number `N' such that ‘a <= N <= b’
     for ‘a <= b’ and ‘b <= N <= a’ for ‘b < a’.

     The end-point value ‘b’ may or may not be included in the range
     depending on floating-point rounding in the equation ‘a + (b-a) *
     random()’.

 -- Function: random.triangular (low, high, mode)

     Return a random floating point number `N' such that ‘low <= N <=
     high’ and with the specified `mode' between those bounds.  The
     `low' and `high' bounds default to zero and one.  The `mode'
     argument defaults to the midpoint between the bounds, giving a
     symmetric distribution.

 -- Function: random.betavariate (alpha, beta)

     Beta distribution.  Conditions on the parameters are ‘alpha > 0’
     and ‘beta > 0’.  Returned values range between 0 and 1.

 -- Function: random.expovariate (lambd)

     Exponential distribution.  `lambd' is 1.0 divided by the desired
     mean.  It should be nonzero.  (The parameter would be called
     “lambda”, but that is a reserved word in Python.)  Returned values
     range from 0 to positive infinity if `lambd' is positive, and from
     negative infinity to 0 if `lambd' is negative.

 -- Function: random.gammavariate (alpha, beta)

     Gamma distribution.  (`Not' the gamma function!)  Conditions on the
     parameters are ‘alpha > 0’ and ‘beta > 0’.

     The probability distribution function is:

                    x ** (alpha - 1) * math.exp(-x / beta)
          pdf(x) =  --------------------------------------
                      math.gamma(alpha) * beta ** alpha

 -- Function: random.gauss (mu, sigma)

     Gaussian distribution.  `mu' is the mean, and `sigma' is the
     standard deviation.  This is slightly faster than the *note
     normalvariate(): 1a4a. function defined below.

 -- Function: random.lognormvariate (mu, sigma)

     Log normal distribution.  If you take the natural logarithm of this
     distribution, you’ll get a normal distribution with mean `mu' and
     standard deviation `sigma'.  `mu' can have any value, and `sigma'
     must be greater than zero.

 -- Function: random.normalvariate (mu, sigma)

     Normal distribution.  `mu' is the mean, and `sigma' is the standard
     deviation.

 -- Function: random.vonmisesvariate (mu, kappa)

     `mu' is the mean angle, expressed in radians between 0 and 2*`pi',
     and `kappa' is the concentration parameter, which must be greater
     than or equal to zero.  If `kappa' is equal to zero, this
     distribution reduces to a uniform random angle over the range 0 to
     2*`pi'.

 -- Function: random.paretovariate (alpha)

     Pareto distribution.  `alpha' is the shape parameter.

 -- Function: random.weibullvariate (alpha, beta)

     Weibull distribution.  `alpha' is the scale parameter and `beta' is
     the shape parameter.


File: python.info,  Node: Alternative Generator,  Next: Notes on Reproducibility,  Prev: Real-valued distributions,  Up: random — Generate pseudo-random numbers

5.9.6.5 Alternative Generator
.............................

 -- Class: random.Random ([seed])

     Class that implements the default pseudo-random number generator
     used by the *note random: dc. module.

 -- Class: random.SystemRandom ([seed])

     Class that uses the *note os.urandom(): 4c6. function for
     generating random numbers from sources provided by the operating
     system.  Not available on all systems.  Does not rely on software
     state, and sequences are not reproducible.  Accordingly, the *note
     seed(): bfb. method has no effect and is ignored.  The *note
     getstate(): 1a3f. and *note setstate(): 1a40. methods raise *note
     NotImplementedError: 603. if called.


File: python.info,  Node: Notes on Reproducibility,  Next: Examples and Recipes,  Prev: Alternative Generator,  Up: random — Generate pseudo-random numbers

5.9.6.6 Notes on Reproducibility
................................

Sometimes it is useful to be able to reproduce the sequences given by a
pseudo random number generator.  By re-using a seed value, the same
sequence should be reproducible from run to run as long as multiple
threads are not running.

Most of the random module’s algorithms and seeding functions are subject
to change across Python versions, but two aspects are guaranteed not to
change:

   * If a new seeding method is added, then a backward compatible seeder
     will be offered.

   * The generator’s ‘random()’ method will continue to produce the same
     sequence when the compatible seeder is given the same seed.


File: python.info,  Node: Examples and Recipes,  Prev: Notes on Reproducibility,  Up: random — Generate pseudo-random numbers

5.9.6.7 Examples and Recipes
............................

Basic examples:

     >>> random()                             # Random float:  0.0 <= x < 1.0
     0.37444887175646646

     >>> uniform(2.5, 10.0)                   # Random float:  2.5 <= x < 10.0
     3.1800146073117523

     >>> expovariate(1 / 5)                   # Interval between arrivals averaging 5 seconds
     5.148957571865031

     >>> randrange(10)                        # Integer from 0 to 9 inclusive
     7

     >>> randrange(0, 101, 2)                 # Even integer from 0 to 100 inclusive
     26

     >>> choice(['win', 'lose', 'draw'])      # Single random element from a sequence
     'draw'

     >>> deck = 'ace two three four'.split()
     >>> shuffle(deck)                        # Shuffle a list
     >>> deck
     ['four', 'two', 'ace', 'three']

     >>> sample([10, 20, 30, 40, 50], k=4)    # Four samples without replacement
     [40, 10, 50, 30]

Simulations:

     >>> # Six roulette wheel spins (weighted sampling with replacement)
     >>> choices(['red', 'black', 'green'], [18, 18, 2], k=6)
     ['red', 'green', 'black', 'black', 'red', 'black']

     >>> # Deal 20 cards without replacement from a deck of 52 playing cards
     >>> # and determine the proportion of cards with a ten-value
     >>> # (a ten, jack, queen, or king).
     >>> deck = collections.Counter(tens=16, low_cards=36)
     >>> seen = sample(list(deck.elements()), k=20)
     >>> seen.count('tens') / 20
     0.15

     >>> # Estimate the probability of getting 5 or more heads from 7 spins
     >>> # of a biased coin that settles on heads 60% of the time.
     >>> def trial():
     ...     return choices('HT', cum_weights=(0.60, 1.00), k=7).count('H') >= 5
     ...
     >>> sum(trial() for i in range(10000)) / 10000
     0.4169

     >>> # Probability of the median of 5 samples being in middle two quartiles
     >>> def trial():
     ...     return 2500 <= sorted(choices(range(10000), k=5))[2] < 7500
     ...
     >>> sum(trial() for i in range(10000)) / 10000
     0.7958

Example of statistical bootstrapping(1) using resampling with
replacement to estimate a confidence interval for the mean of a sample
of size five:

     # http://statistics.about.com/od/Applications/a/Example-Of-Bootstrapping.htm
     from statistics import fmean as mean
     from random import choices

     data = 1, 2, 4, 4, 10
     means = sorted(mean(choices(data, k=5)) for i in range(20))
     print(f'The sample mean of {mean(data):.1f} has a 90% confidence '
           f'interval from {means[1]:.1f} to {means[-2]:.1f}')

Example of a resampling permutation test(2) to determine the statistical
significance or p-value(3) of an observed difference between the effects
of a drug versus a placebo:

     # Example from "Statistics is Easy" by Dennis Shasha and Manda Wilson
     from statistics import fmean as mean
     from random import shuffle

     drug = [54, 73, 53, 70, 73, 68, 52, 65, 65]
     placebo = [54, 51, 58, 44, 55, 52, 42, 47, 58, 46]
     observed_diff = mean(drug) - mean(placebo)

     n = 10000
     count = 0
     combined = drug + placebo
     for i in range(n):
         shuffle(combined)
         new_diff = mean(combined[:len(drug)]) - mean(combined[len(drug):])
         count += (new_diff >= observed_diff)

     print(f'{n} label reshufflings produced only {count} instances with a difference')
     print(f'at least as extreme as the observed difference of {observed_diff:.1f}.')
     print(f'The one-sided p-value of {count / n:.4f} leads us to reject the null')
     print(f'hypothesis that there is no difference between the drug and the placebo.')

Simulation of arrival times and service deliveries in a single server
queue:

     from random import expovariate, gauss
     from statistics import mean, median, stdev

     average_arrival_interval = 5.6
     average_service_time = 5.0
     stdev_service_time = 0.5

     num_waiting = 0
     arrivals = []
     starts = []
     arrival = service_end = 0.0
     for i in range(20000):
         if arrival <= service_end:
             num_waiting += 1
             arrival += expovariate(1.0 / average_arrival_interval)
             arrivals.append(arrival)
         else:
             num_waiting -= 1
             service_start = service_end if num_waiting else arrival
             service_time = gauss(average_service_time, stdev_service_time)
             service_end = service_start + service_time
             starts.append(service_start)

     waits = [start - arrival for arrival, start in zip(arrivals, starts)]
     print(f'Mean wait: {mean(waits):.1f}.  Stdev wait: {stdev(waits):.1f}.')
     print(f'Median wait: {median(waits):.1f}.  Max wait: {max(waits):.1f}.')

See also
........

Statistics for Hackers(4) a video tutorial by Jake Vanderplas(5) on
statistical analysis using just a few fundamental concepts including
simulation, sampling, shuffling, and cross-validation.

Economics Simulation(6) a simulation of a marketplace by Peter Norvig(7)
that shows effective use of many of the tools and distributions provided
by this module (gauss, uniform, sample, betavariate, choice, triangular,
and randrange).

A Concrete Introduction to Probability (using Python)(8) a tutorial by
Peter Norvig(9) covering the basics of probability theory, how to write
simulations, and how to perform data analysis using Python.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Bootstrapping_(statistics)

   (2) 
https://en.wikipedia.org/wiki/Resampling_(statistics)#Permutation_tests

   (3) https://en.wikipedia.org/wiki/P-value

   (4) https://www.youtube.com/watch?v=Iq9DzN6mvYA

   (5) https://us.pycon.org/2016/speaker/profile/295/

   (6) 
http://nbviewer.jupyter.org/url/norvig.com/ipython/Economics.ipynb

   (7) http://norvig.com/bio.html

   (8) 
http://nbviewer.jupyter.org/url/norvig.com/ipython/Probability.ipynb

   (9) http://norvig.com/bio.html


File: python.info,  Node: statistics — Mathematical statistics functions,  Prev: random — Generate pseudo-random numbers,  Up: Numeric and Mathematical Modules

5.9.7 ‘statistics’ — Mathematical statistics functions
------------------------------------------------------

New in version 3.4.

`Source code:' Lib/statistics.py(1)

__________________________________________________________________

This module provides functions for calculating mathematical statistics
of numeric (*note Real: 1360.-valued) data.

The module is not intended to be a competitor to third-party libraries
such as NumPy(2), SciPy(3), or proprietary full-featured statistics
packages aimed at professional statisticians such as Minitab, SAS and
Matlab.  It is aimed at the level of graphing and scientific
calculators.

Unless explicitly noted, these functions support *note int: 184, *note
float: 187, *note Decimal: 188. and *note Fraction: 185.  Behaviour with
other types (whether in the numeric tower or not) is currently
unsupported.  Collections with a mix of types are also undefined and
implementation-dependent.  If your input data consists of mixed types,
you may be able to use *note map(): c20. to ensure a consistent result,
for example: ‘map(float, input_data)’.

* Menu:

* Averages and measures of central location::
* Measures of spread::
* Function details::
* Exceptions: Exceptions<3>.
* NormalDist objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/statistics.py

   (2) https://numpy.org

   (3) https://www.scipy.org/


File: python.info,  Node: Averages and measures of central location,  Next: Measures of spread,  Up: statistics — Mathematical statistics functions

5.9.7.1 Averages and measures of central location
.................................................

These functions calculate an average or typical value from a population
or sample.

*note mean(): 199.          Arithmetic mean (“average”) of data.
                            
                            
*note fmean(): 225.         Fast, floating point arithmetic mean.
                            
                            
*note geometric_mean(): 226.Geometric mean of data.
                            
                            
*note harmonic_mean(): 584. Harmonic mean of data.
                            
                            
*note median(): 1a55.       Median (middle value) of data.
                            
                            
*note median_low(): 1a56.   Low median of data.
                            
                            
*note median_high(): 1a57.  High median of data.
                            
                            
*note median_grouped(): 1a58.Median, or 50th percentile, of grouped data.
                            
                            
*note mode(): 2b9.          Single mode (most common value) of discrete or nominal data.
                            
                            
*note multimode(): 227.     List of modes (most common values) of discrete or nomimal data.
                            
                            
*note quantiles(): 228.     Divide data into intervals with equal probability.
                            


File: python.info,  Node: Measures of spread,  Next: Function details,  Prev: Averages and measures of central location,  Up: statistics — Mathematical statistics functions

5.9.7.2 Measures of spread
..........................

These functions calculate a measure of how much the population or sample
tends to deviate from the typical or average values.

*note pstdev(): 1a5a.       Population standard deviation of data.
                            
                            
*note pvariance(): 1a5b.    Population variance of data.
                            
                            
*note stdev(): 1a5c.        Sample standard deviation of data.
                            
                            
*note variance(): 1a5d.     Sample variance of data.
                            


File: python.info,  Node: Function details,  Next: Exceptions<3>,  Prev: Measures of spread,  Up: statistics — Mathematical statistics functions

5.9.7.3 Function details
........................

Note: The functions do not require the data given to them to be sorted.
However, for reading convenience, most of the examples show sorted
sequences.

 -- Function: statistics.mean (data)

     Return the sample arithmetic mean of `data' which can be a sequence
     or iterable.

     The arithmetic mean is the sum of the data divided by the number of
     data points.  It is commonly called “the average”, although it is
     only one of many different mathematical averages.  It is a measure
     of the central location of the data.

     If `data' is empty, *note StatisticsError: 1a5f. will be raised.

     Some examples of use:

          >>> mean([1, 2, 3, 4, 4])
          2.8
          >>> mean([-1.0, 2.5, 3.25, 5.75])
          2.625

          >>> from fractions import Fraction as F
          >>> mean([F(3, 7), F(1, 21), F(5, 3), F(1, 3)])
          Fraction(13, 21)

          >>> from decimal import Decimal as D
          >>> mean([D("0.5"), D("0.75"), D("0.625"), D("0.375")])
          Decimal('0.5625')

          Note: The mean is strongly affected by outliers and is not a
          robust estimator for central location: the mean is not
          necessarily a typical example of the data points.  For more
          robust measures of central location, see *note median(): 1a55.
          and *note mode(): 2b9.

          The sample mean gives an unbiased estimate of the true
          population mean, so that when taken on average over all the
          possible samples, ‘mean(sample)’ converges on the true mean of
          the entire population.  If `data' represents the entire
          population rather than a sample, then ‘mean(data)’ is
          equivalent to calculating the true population mean μ.

 -- Function: statistics.fmean (data)

     Convert `data' to floats and compute the arithmetic mean.

     This runs faster than the *note mean(): 199. function and it always
     returns a *note float: 187.  The `data' may be a sequence or
     iterable.  If the input dataset is empty, raises a *note
     StatisticsError: 1a5f.

          >>> fmean([3.5, 4.0, 5.25])
          4.25

     New in version 3.8.

 -- Function: statistics.geometric_mean (data)

     Convert `data' to floats and compute the geometric mean.

     The geometric mean indicates the central tendency or typical value
     of the `data' using the product of the values (as opposed to the
     arithmetic mean which uses their sum).

     Raises a *note StatisticsError: 1a5f. if the input dataset is
     empty, if it contains a zero, or if it contains a negative value.
     The `data' may be a sequence or iterable.

     No special efforts are made to achieve exact results.  (However,
     this may change in the future.)

          >>> round(geometric_mean([54, 24, 36]), 1)
          36.0

     New in version 3.8.

 -- Function: statistics.harmonic_mean (data)

     Return the harmonic mean of `data', a sequence or iterable of
     real-valued numbers.

     The harmonic mean, sometimes called the subcontrary mean, is the
     reciprocal of the arithmetic *note mean(): 199. of the reciprocals
     of the data.  For example, the harmonic mean of three values `a',
     `b' and `c' will be equivalent to ‘3/(1/a + 1/b + 1/c)’.  If one of
     the values is zero, the result will be zero.

     The harmonic mean is a type of average, a measure of the central
     location of the data.  It is often appropriate when averaging rates
     or ratios, for example speeds.

     Suppose a car travels 10 km at 40 km/hr, then another 10 km at 60
     km/hr.  What is the average speed?

          >>> harmonic_mean([40, 60])
          48.0

     Suppose an investor purchases an equal value of shares in each of
     three companies, with P/E (price/earning) ratios of 2.5, 3 and 10.
     What is the average P/E ratio for the investor’s portfolio?

          >>> harmonic_mean([2.5, 3, 10])  # For an equal investment portfolio.
          3.6

     *note StatisticsError: 1a5f. is raised if `data' is empty, or any
     element is less than zero.

     The current algorithm has an early-out when it encounters a zero in
     the input.  This means that the subsequent inputs are not tested
     for validity.  (This behavior may change in the future.)

     New in version 3.6.

 -- Function: statistics.median (data)

     Return the median (middle value) of numeric data, using the common
     “mean of middle two” method.  If `data' is empty, *note
     StatisticsError: 1a5f. is raised.  `data' can be a sequence or
     iterable.

     The median is a robust measure of central location and is less
     affected by the presence of outliers.  When the number of data
     points is odd, the middle data point is returned:

          >>> median([1, 3, 5])
          3

     When the number of data points is even, the median is interpolated
     by taking the average of the two middle values:

          >>> median([1, 3, 5, 7])
          4.0

     This is suited for when your data is discrete, and you don’t mind
     that the median may not be an actual data point.

     If the data is ordinal (supports order operations) but not numeric
     (doesn’t support addition), consider using *note median_low():
     1a56. or *note median_high(): 1a57. instead.

 -- Function: statistics.median_low (data)

     Return the low median of numeric data.  If `data' is empty, *note
     StatisticsError: 1a5f. is raised.  `data' can be a sequence or
     iterable.

     The low median is always a member of the data set.  When the number
     of data points is odd, the middle value is returned.  When it is
     even, the smaller of the two middle values is returned.

          >>> median_low([1, 3, 5])
          3
          >>> median_low([1, 3, 5, 7])
          3

     Use the low median when your data are discrete and you prefer the
     median to be an actual data point rather than interpolated.

 -- Function: statistics.median_high (data)

     Return the high median of data.  If `data' is empty, *note
     StatisticsError: 1a5f. is raised.  `data' can be a sequence or
     iterable.

     The high median is always a member of the data set.  When the
     number of data points is odd, the middle value is returned.  When
     it is even, the larger of the two middle values is returned.

          >>> median_high([1, 3, 5])
          3
          >>> median_high([1, 3, 5, 7])
          5

     Use the high median when your data are discrete and you prefer the
     median to be an actual data point rather than interpolated.

 -- Function: statistics.median_grouped (data, interval=1)

     Return the median of grouped continuous data, calculated as the
     50th percentile, using interpolation.  If `data' is empty, *note
     StatisticsError: 1a5f. is raised.  `data' can be a sequence or
     iterable.

          >>> median_grouped([52, 52, 53, 54])
          52.5

     In the following example, the data are rounded, so that each value
     represents the midpoint of data classes, e.g.  1 is the midpoint of
     the class 0.5–1.5, 2 is the midpoint of 1.5–2.5, 3 is the midpoint
     of 2.5–3.5, etc.  With the data given, the middle value falls
     somewhere in the class 3.5–4.5, and interpolation is used to
     estimate it:

          >>> median_grouped([1, 2, 2, 3, 4, 4, 4, 4, 4, 5])
          3.7

     Optional argument `interval' represents the class interval, and
     defaults to 1.  Changing the class interval naturally will change
     the interpolation:

          >>> median_grouped([1, 3, 3, 5, 7], interval=1)
          3.25
          >>> median_grouped([1, 3, 3, 5, 7], interval=2)
          3.5

     This function does not check whether the data points are at least
     `interval' apart.

     `CPython implementation detail:' Under some circumstances, *note
     median_grouped(): 1a58. may coerce data points to floats.  This
     behaviour is likely to change in the future.

     See also
     ........

        * “Statistics for the Behavioral Sciences”, Frederick J
          Gravetter and Larry B Wallnau (8th Edition).

        * The SSMEDIAN(1) function in the Gnome Gnumeric spreadsheet,
          including this discussion(2).

 -- Function: statistics.mode (data)

     Return the single most common data point from discrete or nominal
     `data'.  The mode (when it exists) is the most typical value and
     serves as a measure of central location.

     If there are multiple modes with the same frequency, returns the
     first one encountered in the `data'.  If the smallest or largest of
     those is desired instead, use ‘min(multimode(data))’ or
     ‘max(multimode(data))’.  If the input `data' is empty, *note
     StatisticsError: 1a5f. is raised.

     ‘mode’ assumes discrete data and returns a single value.  This is
     the standard treatment of the mode as commonly taught in schools:

          >>> mode([1, 1, 2, 3, 3, 3, 3, 4])
          3

     The mode is unique in that it is the only statistic in this package
     that also applies to nominal (non-numeric) data:

          >>> mode(["red", "blue", "blue", "red", "green", "red", "red"])
          'red'

     Changed in version 3.8: Now handles multimodal datasets by
     returning the first mode encountered.  Formerly, it raised *note
     StatisticsError: 1a5f. when more than one mode was found.

 -- Function: statistics.multimode (data)

     Return a list of the most frequently occurring values in the order
     they were first encountered in the `data'.  Will return more than
     one result if there are multiple modes or an empty list if the
     `data' is empty:

          >>> multimode('aabbbbccddddeeffffgg')
          ['b', 'd', 'f']
          >>> multimode('')
          []

     New in version 3.8.

 -- Function: statistics.pstdev (data, mu=None)

     Return the population standard deviation (the square root of the
     population variance).  See *note pvariance(): 1a5b. for arguments
     and other details.

          >>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
          0.986893273527251

 -- Function: statistics.pvariance (data, mu=None)

     Return the population variance of `data', a non-empty sequence or
     iterable of real-valued numbers.  Variance, or second moment about
     the mean, is a measure of the variability (spread or dispersion) of
     data.  A large variance indicates that the data is spread out; a
     small variance indicates it is clustered closely around the mean.

     If the optional second argument `mu' is given, it is typically the
     mean of the `data'.  It can also be used to compute the second
     moment around a point that is not the mean.  If it is missing or
     ‘None’ (the default), the arithmetic mean is automatically
     calculated.

     Use this function to calculate the variance from the entire
     population.  To estimate the variance from a sample, the *note
     variance(): 1a5d. function is usually a better choice.

     Raises *note StatisticsError: 1a5f. if `data' is empty.

     Examples:

          >>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25]
          >>> pvariance(data)
          1.25

     If you have already calculated the mean of your data, you can pass
     it as the optional second argument `mu' to avoid recalculation:

          >>> mu = mean(data)
          >>> pvariance(data, mu)
          1.25

     Decimals and Fractions are supported:

          >>> from decimal import Decimal as D
          >>> pvariance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
          Decimal('24.815')

          >>> from fractions import Fraction as F
          >>> pvariance([F(1, 4), F(5, 4), F(1, 2)])
          Fraction(13, 72)

          Note: When called with the entire population, this gives the
          population variance σ².  When called on a sample instead, this
          is the biased sample variance s², also known as variance with
          N degrees of freedom.

          If you somehow know the true population mean μ, you may use
          this function to calculate the variance of a sample, giving
          the known population mean as the second argument.  Provided
          the data points are a random sample of the population, the
          result will be an unbiased estimate of the population
          variance.

 -- Function: statistics.stdev (data, xbar=None)

     Return the sample standard deviation (the square root of the sample
     variance).  See *note variance(): 1a5d. for arguments and other
     details.

          >>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
          1.0810874155219827

 -- Function: statistics.variance (data, xbar=None)

     Return the sample variance of `data', an iterable of at least two
     real-valued numbers.  Variance, or second moment about the mean, is
     a measure of the variability (spread or dispersion) of data.  A
     large variance indicates that the data is spread out; a small
     variance indicates it is clustered closely around the mean.

     If the optional second argument `xbar' is given, it should be the
     mean of `data'.  If it is missing or ‘None’ (the default), the mean
     is automatically calculated.

     Use this function when your data is a sample from a population.  To
     calculate the variance from the entire population, see *note
     pvariance(): 1a5b.

     Raises *note StatisticsError: 1a5f. if `data' has fewer than two
     values.

     Examples:

          >>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
          >>> variance(data)
          1.3720238095238095

     If you have already calculated the mean of your data, you can pass
     it as the optional second argument `xbar' to avoid recalculation:

          >>> m = mean(data)
          >>> variance(data, m)
          1.3720238095238095

     This function does not attempt to verify that you have passed the
     actual mean as `xbar'.  Using arbitrary values for `xbar' can lead
     to invalid or impossible results.

     Decimal and Fraction values are supported:

          >>> from decimal import Decimal as D
          >>> variance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
          Decimal('31.01875')

          >>> from fractions import Fraction as F
          >>> variance([F(1, 6), F(1, 2), F(5, 3)])
          Fraction(67, 108)

          Note: This is the sample variance s² with Bessel’s correction,
          also known as variance with N-1 degrees of freedom.  Provided
          that the data points are representative (e.g.  independent and
          identically distributed), the result should be an unbiased
          estimate of the true population variance.

          If you somehow know the actual population mean μ you should
          pass it to the *note pvariance(): 1a5b. function as the `mu'
          parameter to get the variance of a sample.

 -- Function: statistics.quantiles (data, *, n=4, method='exclusive')

     Divide `data' into `n' continuous intervals with equal probability.
     Returns a list of ‘n - 1’ cut points separating the intervals.

     Set `n' to 4 for quartiles (the default).  Set `n' to 10 for
     deciles.  Set `n' to 100 for percentiles which gives the 99 cuts
     points that separate `data' into 100 equal sized groups.  Raises
     *note StatisticsError: 1a5f. if `n' is not least 1.

     The `data' can be any iterable containing sample data.  For
     meaningful results, the number of data points in `data' should be
     larger than `n'.  Raises *note StatisticsError: 1a5f. if there are
     not at least two data points.

     The cut points are linearly interpolated from the two nearest data
     points.  For example, if a cut point falls one-third of the
     distance between two sample values, ‘100’ and ‘112’, the cut-point
     will evaluate to ‘104’.

     The `method' for computing quantiles can be varied depending on
     whether the `data' includes or excludes the lowest and highest
     possible values from the population.

     The default `method' is “exclusive” and is used for data sampled
     from a population that can have more extreme values than found in
     the samples.  The portion of the population falling below the
     `i-th' of `m' sorted data points is computed as ‘i / (m + 1)’.
     Given nine sample values, the method sorts them and assigns the
     following percentiles: 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%.

     Setting the `method' to “inclusive” is used for describing
     population data or for samples that are known to include the most
     extreme values from the population.  The minimum value in `data' is
     treated as the 0th percentile and the maximum value is treated as
     the 100th percentile.  The portion of the population falling below
     the `i-th' of `m' sorted data points is computed as ‘(i - 1) / (m -
     1)’.  Given 11 sample values, the method sorts them and assigns the
     following percentiles: 0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%,
     90%, 100%.

          # Decile cut points for empirically sampled data
          >>> data = [105, 129, 87, 86, 111, 111, 89, 81, 108, 92, 110,
          ...         100, 75, 105, 103, 109, 76, 119, 99, 91, 103, 129,
          ...         106, 101, 84, 111, 74, 87, 86, 103, 103, 106, 86,
          ...         111, 75, 87, 102, 121, 111, 88, 89, 101, 106, 95,
          ...         103, 107, 101, 81, 109, 104]
          >>> [round(q, 1) for q in quantiles(data, n=10)]
          [81.0, 86.2, 89.0, 99.4, 102.5, 103.6, 106.0, 109.8, 111.0]

     New in version 3.8.

   ---------- Footnotes ----------

   (1) 
https://help.gnome.org/users/gnumeric/stable/gnumeric.html#gnumeric-function-SSMEDIAN

   (2) 
https://mail.gnome.org/archives/gnumeric-list/2011-April/msg00018.html


File: python.info,  Node: Exceptions<3>,  Next: NormalDist objects,  Prev: Function details,  Up: statistics — Mathematical statistics functions

5.9.7.4 Exceptions
..................

A single exception is defined:

 -- Exception: statistics.StatisticsError

     Subclass of *note ValueError: 1f9. for statistics-related
     exceptions.


File: python.info,  Node: NormalDist objects,  Prev: Exceptions<3>,  Up: statistics — Mathematical statistics functions

5.9.7.5 ‘NormalDist’ objects
............................

*note NormalDist: 229. is a tool for creating and manipulating normal
distributions of a random variable(1).  It is a class that treats the
mean and standard deviation of data measurements as a single entity.

Normal distributions arise from the Central Limit Theorem(2) and have a
wide range of applications in statistics.

 -- Class: statistics.NormalDist (mu=0.0, sigma=1.0)

     Returns a new `NormalDist' object where `mu' represents the
     arithmetic mean(3) and `sigma' represents the standard
     deviation(4).

     If `sigma' is negative, raises *note StatisticsError: 1a5f.

      -- Attribute: mean

          A read-only property for the arithmetic mean(5) of a normal
          distribution.

      -- Attribute: median

          A read-only property for the median(6) of a normal
          distribution.

      -- Attribute: mode

          A read-only property for the mode(7) of a normal distribution.

      -- Attribute: stdev

          A read-only property for the standard deviation(8) of a normal
          distribution.

      -- Attribute: variance

          A read-only property for the variance(9) of a normal
          distribution.  Equal to the square of the standard deviation.

      -- Class Method: from_samples (data)

          Makes a normal distribution instance with `mu' and `sigma'
          parameters estimated from the `data' using *note fmean(): 225.
          and *note stdev(): 1a5c.

          The `data' can be any *note iterable: b9f. and should consist
          of values that can be converted to type *note float: 187.  If
          `data' does not contain at least two elements, raises *note
          StatisticsError: 1a5f. because it takes at least one point to
          estimate a central value and at least two points to estimate
          dispersion.

      -- Method: samples (n, *, seed=None)

          Generates `n' random samples for a given mean and standard
          deviation.  Returns a *note list: 260. of *note float: 187.
          values.

          If `seed' is given, creates a new instance of the underlying
          random number generator.  This is useful for creating
          reproducible results, even in a multi-threading context.

      -- Method: pdf (x)

          Using a probability density function (pdf)(10), compute the
          relative likelihood that a random variable `X' will be near
          the given value `x'.  Mathematically, it is the limit of the
          ratio ‘P(x <= X < x+dx) / dx’ as `dx' approaches zero.

          The relative likelihood is computed as the probability of a
          sample occurring in a narrow range divided by the width of the
          range (hence the word “density”).  Since the likelihood is
          relative to other points, its value can be greater than ‘1.0’.

      -- Method: cdf (x)

          Using a cumulative distribution function (cdf)(11), compute
          the probability that a random variable `X' will be less than
          or equal to `x'.  Mathematically, it is written ‘P(X <= x)’.

      -- Method: inv_cdf (p)

          Compute the inverse cumulative distribution function, also
          known as the quantile function(12) or the percent-point(13)
          function.  Mathematically, it is written ‘x : P(X <= x) = p’.

          Finds the value `x' of the random variable `X' such that the
          probability of the variable being less than or equal to that
          value equals the given probability `p'.

      -- Method: overlap (other)

          Measures the agreement between two normal probability
          distributions.  Returns a value between 0.0 and 1.0 giving the
          overlapping area for the two probability density
          functions(14).

      -- Method: quantiles (n=4)

          Divide the normal distribution into `n' continuous intervals
          with equal probability.  Returns a list of (n - 1) cut points
          separating the intervals.

          Set `n' to 4 for quartiles (the default).  Set `n' to 10 for
          deciles.  Set `n' to 100 for percentiles which gives the 99
          cuts points that separate the normal distribution into 100
          equal sized groups.

     Instances of *note NormalDist: 229. support addition, subtraction,
     multiplication and division by a constant.  These operations are
     used for translation and scaling.  For example:

          >>> temperature_february = NormalDist(5, 2.5)             # Celsius
          >>> temperature_february * (9/5) + 32                     # Fahrenheit
          NormalDist(mu=41.0, sigma=4.5)

     Dividing a constant by an instance of *note NormalDist: 229. is not
     supported because the result wouldn’t be normally distributed.

     Since normal distributions arise from additive effects of
     independent variables, it is possible to add and subtract two
     independent normally distributed random variables(15) represented
     as instances of *note NormalDist: 229.  For example:

          >>> birth_weights = NormalDist.from_samples([2.5, 3.1, 2.1, 2.4, 2.7, 3.5])
          >>> drug_effects = NormalDist(0.4, 0.15)
          >>> combined = birth_weights + drug_effects
          >>> round(combined.mean, 1)
          3.1
          >>> round(combined.stdev, 1)
          0.5

     New in version 3.8.

* Menu:

* NormalDist Examples and Recipes::

   ---------- Footnotes ----------

   (1) http://www.stat.yale.edu/Courses/1997-98/101/ranvar.htm

   (2) https://en.wikipedia.org/wiki/Central_limit_theorem

   (3) https://en.wikipedia.org/wiki/Arithmetic_mean

   (4) https://en.wikipedia.org/wiki/Standard_deviation

   (5) https://en.wikipedia.org/wiki/Arithmetic_mean

   (6) https://en.wikipedia.org/wiki/Median

   (7) https://en.wikipedia.org/wiki/Mode_(statistics)

   (8) https://en.wikipedia.org/wiki/Standard_deviation

   (9) https://en.wikipedia.org/wiki/Variance

   (10) https://en.wikipedia.org/wiki/Probability_density_function

   (11) https://en.wikipedia.org/wiki/Cumulative_distribution_function

   (12) https://en.wikipedia.org/wiki/Quantile_function

   (13) 
https://www.statisticshowto.datasciencecentral.com/inverse-distribution-function/

   (14) https://www.rasch.org/rmt/rmt101r.htm

   (15) 
https://en.wikipedia.org/wiki/Sum_of_normally_distributed_random_variables


File: python.info,  Node: NormalDist Examples and Recipes,  Up: NormalDist objects

5.9.7.6 ‘NormalDist’ Examples and Recipes
.........................................

*note NormalDist: 229. readily solves classic probability problems.

For example, given historical data for SAT exams(1) showing that scores
are normally distributed with a mean of 1060 and a standard deviation of
192, determine the percentage of students with test scores between 1100
and 1200, after rounding to the nearest whole number:

     >>> sat = NormalDist(1060, 195)
     >>> fraction = sat.cdf(1200 + 0.5) - sat.cdf(1100 - 0.5)
     >>> round(fraction * 100.0, 1)
     18.4

Find the quartiles(2) and deciles(3) for the SAT scores:

     >>> list(map(round, sat.quantiles()))
     [928, 1060, 1192]
     >>> list(map(round, sat.quantiles(n=10)))
     [810, 896, 958, 1011, 1060, 1109, 1162, 1224, 1310]

To estimate the distribution for a model than isn’t easy to solve
analytically, *note NormalDist: 229. can generate input samples for a
Monte Carlo simulation(4):

     >>> def model(x, y, z):
     ...     return (3*x + 7*x*y - 5*y) / (11 * z)
     ...
     >>> n = 100_000
     >>> X = NormalDist(10, 2.5).samples(n, seed=3652260728)
     >>> Y = NormalDist(15, 1.75).samples(n, seed=4582495471)
     >>> Z = NormalDist(50, 1.25).samples(n, seed=6582483453)
     >>> quantiles(map(model, X, Y, Z))
     [1.4591308524824727, 1.8035946855390597, 2.175091447274739]

Normal distributions commonly arise in machine learning problems.

Wikipedia has a nice example of a Naive Bayesian Classifier(5).  The
challenge is to predict a person’s gender from measurements of normally
distributed features including height, weight, and foot size.

We’re given a training dataset with measurements for eight people.  The
measurements are assumed to be normally distributed, so we summarize the
data with *note NormalDist: 229.:

     >>> height_male = NormalDist.from_samples([6, 5.92, 5.58, 5.92])
     >>> height_female = NormalDist.from_samples([5, 5.5, 5.42, 5.75])
     >>> weight_male = NormalDist.from_samples([180, 190, 170, 165])
     >>> weight_female = NormalDist.from_samples([100, 150, 130, 150])
     >>> foot_size_male = NormalDist.from_samples([12, 11, 12, 10])
     >>> foot_size_female = NormalDist.from_samples([6, 8, 7, 9])

Next, we encounter a new person whose feature measurements are known but
whose gender is unknown:

     >>> ht = 6.0        # height
     >>> wt = 130        # weight
     >>> fs = 8          # foot size

Starting with a 50% prior probability(6) of being male or female, we
compute the posterior as the prior times the product of likelihoods for
the feature measurements given the gender:

     >>> prior_male = 0.5
     >>> prior_female = 0.5
     >>> posterior_male = (prior_male * height_male.pdf(ht) *
     ...                   weight_male.pdf(wt) * foot_size_male.pdf(fs))

     >>> posterior_female = (prior_female * height_female.pdf(ht) *
     ...                     weight_female.pdf(wt) * foot_size_female.pdf(fs))

The final prediction goes to the largest posterior.  This is known as
the maximum a posteriori(7) or MAP:

     >>> 'male' if posterior_male > posterior_female else 'female'
     'female'

   ---------- Footnotes ----------

   (1) https://blog.prepscholar.com/sat-standard-deviation

   (2) https://en.wikipedia.org/wiki/Quartile

   (3) https://en.wikipedia.org/wiki/Decile

   (4) https://en.wikipedia.org/wiki/Monte_Carlo_method

   (5) 
https://en.wikipedia.org/wiki/Naive_Bayes_classifier#Sex_classification

   (6) https://en.wikipedia.org/wiki/Prior_probability

   (7) https://en.wikipedia.org/wiki/Maximum_a_posteriori_estimation


File: python.info,  Node: Functional Programming Modules,  Next: File and Directory Access,  Prev: Numeric and Mathematical Modules,  Up: The Python Standard Library

5.10 Functional Programming Modules
===================================

The modules described in this chapter provide functions and classes that
support a functional programming style, and general operations on
callables.

The following modules are documented in this chapter:

* Menu:

* itertools — Functions creating iterators for efficient looping::
* functools — Higher-order functions and operations on callable objects::
* operator — Standard operators as functions::


File: python.info,  Node: itertools — Functions creating iterators for efficient looping,  Next: functools — Higher-order functions and operations on callable objects,  Up: Functional Programming Modules

5.10.1 ‘itertools’ — Functions creating iterators for efficient looping
-----------------------------------------------------------------------

__________________________________________________________________

This module implements a number of *note iterator: f73. building blocks
inspired by constructs from APL, Haskell, and SML. Each has been recast
in a form suitable for Python.

The module standardizes a core set of fast, memory efficient tools that
are useful by themselves or in combination.  Together, they form an
“iterator algebra” making it possible to construct specialized tools
succinctly and efficiently in pure Python.

For instance, SML provides a tabulation tool: ‘tabulate(f)’ which
produces a sequence ‘f(0), f(1), ...’.  The same effect can be achieved
in Python by combining *note map(): c20. and *note count(): c0e. to form
‘map(f, count())’.

These tools and their built-in counterparts also work well with the
high-speed functions in the *note operator: c2. module.  For example,
the multiplication operator can be mapped across two vectors to form an
efficient dot-product: ‘sum(map(operator.mul, vector1, vector2))’.

`Infinite iterators:'

Iterator               Arguments             Results                                               Example
                                                                                                   
-------------------------------------------------------------------------------------------------------------------------------------------------
                                                                                                   
*note count(): c0e.    start, [step]         start, start+step, start+2*step, …                    ‘count(10) --> 10 11 12 13 14 ...’
                                                                                                   
                                                                                                   
*note cycle(): 1a73.   p                     p0, p1, … plast, p0, p1, …                            ‘cycle('ABCD') --> A B C D A B C D ...’
                                                                                                   
                                                                                                   
*note repeat(): feb.   elem [,n]             elem, elem, elem, … endlessly or up to n times        ‘repeat(10, 3) --> 10 10 10’
                                                                                                   

`Iterators terminating on the shortest input sequence:'

Iterator                         Arguments                        Results                                               Example
                                                                                                                        
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
                                                                                                                        
*note accumulate(): 1db.         p [,func]                        p0, p0+p1, p0+p1+p2, …                                ‘accumulate([1,2,3,4,5]) --> 1 3 6 10 15’
                                                                                                                        
                                                                                                                        
*note chain(): 153e.             p, q, …                          p0, p1, … plast, q0, q1, …                            ‘chain('ABC', 'DEF') --> A B C D E F’
                                                                                                                        
                                                                                                                        
*note chain.from_iterable(): 1a74.iterable                        p0, p1, … plast, q0, q1, …                            ‘chain.from_iterable(['ABC', 'DEF']) --> A B C D E F’
                                                                                                                        
                                                                                                                        
*note compress(): c0d.           data, selectors                  (d[0] if s[0]), (d[1] if s[1]), …                     ‘compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F’
                                                                                                                        
                                                                                                                        
*note dropwhile(): 1a75.         pred, seq                        seq[n], seq[n+1], starting when pred fails            ‘dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1’
                                                                                                                        
                                                                                                                        
*note filterfalse(): 1527.       pred, seq                        elements of seq where pred(elem) is false             ‘filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8’
                                                                                                                        
                                                                                                                        
*note groupby(): 1a76.           iterable[, key]                  sub-iterators grouped by value of key(v)
                                                                  
                                                                                                                        
*note islice(): 397.             seq, [start,] stop [, step]      elements from seq[start:stop:step]                    ‘islice('ABCDEFG', 2, None) --> C D E F G’
                                                                                                                        
                                                                                                                        
*note starmap(): a1d.            func, seq                        func(*seq[0]), func(*seq[1]), …                       ‘starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000’
                                                                                                                        
                                                                                                                        
*note takewhile(): 1a77.         pred, seq                        seq[0], seq[1], until pred fails                      ‘takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4’
                                                                                                                        
                                                                                                                        
*note tee(): 1a78.               it, n                            it1, it2, … itn splits one iterator into n
                                                                  
                                                                                                                        
*note zip_longest(): c24.        p, q, …                          (p[0], q[0]), (p[1], q[1]), …                         ‘zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-’
                                                                                                                        

`Combinatoric iterators:'

Iterator                                           Arguments                Results
                                                                            
----------------------------------------------------------------------------------------------------------------------------------------------
                                                                            
*note product(): c9a.                              p, q, … [repeat=1]       cartesian product, equivalent to a nested for-loop
                                                                            
                                                                            
*note permutations(): 1a79.                        p[, r]                   r-length tuples, all possible orderings, no repeated elements
                                                                            
                                                                            
*note combinations(): c99.                         p, r                     r-length tuples, in sorted order, no repeated elements
                                                                            
                                                                            
*note combinations_with_replacement(): c0c.        p, r                     r-length tuples, in sorted order, with repeated elements
                                                                            

Examples                                           Results
                                                   
---------------------------------------------------------------------------------------------------------------------
                                                   
‘product('ABCD', repeat=2)’                        ‘AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD’
                                                   
                                                   
‘permutations('ABCD', 2)’                          ‘AB AC AD BA BC BD CA CB CD DA DB DC’
                                                   
                                                   
‘combinations('ABCD', 2)’                          ‘AB AC AD BC BD CD’
                                                   
                                                   
‘combinations_with_replacement('ABCD', 2)’         ‘AA AB AC AD BB BC BD CC CD DD’
                                                   

* Menu:

* Itertool functions::
* Itertools Recipes::


File: python.info,  Node: Itertool functions,  Next: Itertools Recipes,  Up: itertools — Functions creating iterators for efficient looping

5.10.1.1 Itertool functions
...........................

The following module functions all construct and return iterators.  Some
provide streams of infinite length, so they should only be accessed by
functions or loops that truncate the stream.

 -- Function: itertools.accumulate (iterable[, func, *, initial=None])

     Make an iterator that returns accumulated sums, or accumulated
     results of other binary functions (specified via the optional
     `func' argument).

     If `func' is supplied, it should be a function of two arguments.
     Elements of the input `iterable' may be any type that can be
     accepted as arguments to `func'.  (For example, with the default
     operation of addition, elements may be any addable type including
     *note Decimal: 188. or *note Fraction: 185.)

     Usually, the number of elements output matches the input iterable.
     However, if the keyword argument `initial' is provided, the
     accumulation leads off with the `initial' value so that the output
     has one more element than the input iterable.

     Roughly equivalent to:

          def accumulate(iterable, func=operator.add, *, initial=None):
              'Return running totals'
              # accumulate([1,2,3,4,5]) --> 1 3 6 10 15
              # accumulate([1,2,3,4,5], initial=100) --> 100 101 103 106 110 115
              # accumulate([1,2,3,4,5], operator.mul) --> 1 2 6 24 120
              it = iter(iterable)
              total = initial
              if initial is None:
                  try:
                      total = next(it)
                  except StopIteration:
                      return
              yield total
              for element in it:
                  total = func(total, element)
                  yield total

     There are a number of uses for the `func' argument.  It can be set
     to *note min(): 7fd. for a running minimum, *note max(): 7fe. for a
     running maximum, or *note operator.mul(): 1a7c. for a running
     product.  Amortization tables can be built by accumulating interest
     and applying payments.  First-order recurrence relations(1) can be
     modeled by supplying the initial value in the iterable and using
     only the accumulated total in `func' argument:

          >>> data = [3, 4, 6, 2, 1, 9, 0, 7, 5, 8]
          >>> list(accumulate(data, operator.mul))     # running product
          [3, 12, 72, 144, 144, 1296, 0, 0, 0, 0]
          >>> list(accumulate(data, max))              # running maximum
          [3, 4, 6, 6, 6, 9, 9, 9, 9, 9]

          # Amortize a 5% loan of 1000 with 4 annual payments of 90
          >>> cashflows = [1000, -90, -90, -90, -90]
          >>> list(accumulate(cashflows, lambda bal, pmt: bal*1.05 + pmt))
          [1000, 960.0, 918.0, 873.9000000000001, 827.5950000000001]

          # Chaotic recurrence relation https://en.wikipedia.org/wiki/Logistic_map
          >>> logistic_map = lambda x, _:  r * x * (1 - x)
          >>> r = 3.8
          >>> x0 = 0.4
          >>> inputs = repeat(x0, 36)     # only the initial value is used
          >>> [format(x, '.2f') for x in accumulate(inputs, logistic_map)]
          ['0.40', '0.91', '0.30', '0.81', '0.60', '0.92', '0.29', '0.79', '0.63',
           '0.88', '0.39', '0.90', '0.33', '0.84', '0.52', '0.95', '0.18', '0.57',
           '0.93', '0.25', '0.71', '0.79', '0.63', '0.88', '0.39', '0.91', '0.32',
           '0.83', '0.54', '0.95', '0.20', '0.60', '0.91', '0.30', '0.80', '0.60']

     See *note functools.reduce(): c62. for a similar function that
     returns only the final accumulated value.

     New in version 3.2.

     Changed in version 3.3: Added the optional `func' parameter.

     Changed in version 3.8: Added the optional `initial' parameter.

 -- Function: itertools.chain (*iterables)

     Make an iterator that returns elements from the first iterable
     until it is exhausted, then proceeds to the next iterable, until
     all of the iterables are exhausted.  Used for treating consecutive
     sequences as a single sequence.  Roughly equivalent to:

          def chain(*iterables):
              # chain('ABC', 'DEF') --> A B C D E F
              for it in iterables:
                  for element in it:
                      yield element

 -- Class Method: chain.from_iterable (iterable)

     Alternate constructor for *note chain(): 153e.  Gets chained inputs
     from a single iterable argument that is evaluated lazily.  Roughly
     equivalent to:

          def from_iterable(iterables):
              # chain.from_iterable(['ABC', 'DEF']) --> A B C D E F
              for it in iterables:
                  for element in it:
                      yield element

 -- Function: itertools.combinations (iterable, r)

     Return `r' length subsequences of elements from the input
     `iterable'.

     Combinations are emitted in lexicographic sort order.  So, if the
     input `iterable' is sorted, the combination tuples will be produced
     in sorted order.

     Elements are treated as unique based on their position, not on
     their value.  So if the input elements are unique, there will be no
     repeat values in each combination.

     Roughly equivalent to:

          def combinations(iterable, r):
              # combinations('ABCD', 2) --> AB AC AD BC BD CD
              # combinations(range(4), 3) --> 012 013 023 123
              pool = tuple(iterable)
              n = len(pool)
              if r > n:
                  return
              indices = list(range(r))
              yield tuple(pool[i] for i in indices)
              while True:
                  for i in reversed(range(r)):
                      if indices[i] != i + n - r:
                          break
                  else:
                      return
                  indices[i] += 1
                  for j in range(i+1, r):
                      indices[j] = indices[j-1] + 1
                  yield tuple(pool[i] for i in indices)

     The code for *note combinations(): c99. can be also expressed as a
     subsequence of *note permutations(): 1a79. after filtering entries
     where the elements are not in sorted order (according to their
     position in the input pool):

          def combinations(iterable, r):
              pool = tuple(iterable)
              n = len(pool)
              for indices in permutations(range(n), r):
                  if sorted(indices) == list(indices):
                      yield tuple(pool[i] for i in indices)

     The number of items returned is ‘n! / r! / (n-r)!’ when ‘0 <= r <=
     n’ or zero when ‘r > n’.

 -- Function: itertools.combinations_with_replacement (iterable, r)

     Return `r' length subsequences of elements from the input
     `iterable' allowing individual elements to be repeated more than
     once.

     Combinations are emitted in lexicographic sort order.  So, if the
     input `iterable' is sorted, the combination tuples will be produced
     in sorted order.

     Elements are treated as unique based on their position, not on
     their value.  So if the input elements are unique, the generated
     combinations will also be unique.

     Roughly equivalent to:

          def combinations_with_replacement(iterable, r):
              # combinations_with_replacement('ABC', 2) --> AA AB AC BB BC CC
              pool = tuple(iterable)
              n = len(pool)
              if not n and r:
                  return
              indices = [0] * r
              yield tuple(pool[i] for i in indices)
              while True:
                  for i in reversed(range(r)):
                      if indices[i] != n - 1:
                          break
                  else:
                      return
                  indices[i:] = [indices[i] + 1] * (r - i)
                  yield tuple(pool[i] for i in indices)

     The code for *note combinations_with_replacement(): c0c. can be
     also expressed as a subsequence of *note product(): c9a. after
     filtering entries where the elements are not in sorted order
     (according to their position in the input pool):

          def combinations_with_replacement(iterable, r):
              pool = tuple(iterable)
              n = len(pool)
              for indices in product(range(n), repeat=r):
                  if sorted(indices) == list(indices):
                      yield tuple(pool[i] for i in indices)

     The number of items returned is ‘(n+r-1)! / r! / (n-1)!’ when ‘n >
     0’.

     New in version 3.1.

 -- Function: itertools.compress (data, selectors)

     Make an iterator that filters elements from `data' returning only
     those that have a corresponding element in `selectors' that
     evaluates to ‘True’.  Stops when either the `data' or `selectors'
     iterables has been exhausted.  Roughly equivalent to:

          def compress(data, selectors):
              # compress('ABCDEF', [1,0,1,0,1,1]) --> A C E F
              return (d for d, s in zip(data, selectors) if s)

     New in version 3.1.

 -- Function: itertools.count (start=0, step=1)

     Make an iterator that returns evenly spaced values starting with
     number `start'.  Often used as an argument to *note map(): c20. to
     generate consecutive data points.  Also, used with *note zip():
     c25. to add sequence numbers.  Roughly equivalent to:

          def count(start=0, step=1):
              # count(10) --> 10 11 12 13 14 ...
              # count(2.5, 0.5) -> 2.5 3.0 3.5 ...
              n = start
              while True:
                  yield n
                  n += step

     When counting with floating point numbers, better accuracy can
     sometimes be achieved by substituting multiplicative code such as:
     ‘(start + step * i for i in count())’.

     Changed in version 3.1: Added `step' argument and allowed
     non-integer arguments.

 -- Function: itertools.cycle (iterable)

     Make an iterator returning elements from the iterable and saving a
     copy of each.  When the iterable is exhausted, return elements from
     the saved copy.  Repeats indefinitely.  Roughly equivalent to:

          def cycle(iterable):
              # cycle('ABCD') --> A B C D A B C D A B C D ...
              saved = []
              for element in iterable:
                  yield element
                  saved.append(element)
              while saved:
                  for element in saved:
                        yield element

     Note, this member of the toolkit may require significant auxiliary
     storage (depending on the length of the iterable).

 -- Function: itertools.dropwhile (predicate, iterable)

     Make an iterator that drops elements from the iterable as long as
     the predicate is true; afterwards, returns every element.  Note,
     the iterator does not produce `any' output until the predicate
     first becomes false, so it may have a lengthy start-up time.
     Roughly equivalent to:

          def dropwhile(predicate, iterable):
              # dropwhile(lambda x: x<5, [1,4,6,4,1]) --> 6 4 1
              iterable = iter(iterable)
              for x in iterable:
                  if not predicate(x):
                      yield x
                      break
              for x in iterable:
                  yield x

 -- Function: itertools.filterfalse (predicate, iterable)

     Make an iterator that filters elements from iterable returning only
     those for which the predicate is ‘False’.  If `predicate' is
     ‘None’, return the items that are false.  Roughly equivalent to:

          def filterfalse(predicate, iterable):
              # filterfalse(lambda x: x%2, range(10)) --> 0 2 4 6 8
              if predicate is None:
                  predicate = bool
              for x in iterable:
                  if not predicate(x):
                      yield x

 -- Function: itertools.groupby (iterable, key=None)

     Make an iterator that returns consecutive keys and groups from the
     `iterable'.  The `key' is a function computing a key value for each
     element.  If not specified or is ‘None’, `key' defaults to an
     identity function and returns the element unchanged.  Generally,
     the iterable needs to already be sorted on the same key function.

     The operation of *note groupby(): 1a76. is similar to the ‘uniq’
     filter in Unix.  It generates a break or new group every time the
     value of the key function changes (which is why it is usually
     necessary to have sorted the data using the same key function).
     That behavior differs from SQL’s GROUP BY which aggregates common
     elements regardless of their input order.

     The returned group is itself an iterator that shares the underlying
     iterable with *note groupby(): 1a76.  Because the source is shared,
     when the *note groupby(): 1a76. object is advanced, the previous
     group is no longer visible.  So, if that data is needed later, it
     should be stored as a list:

          groups = []
          uniquekeys = []
          data = sorted(data, key=keyfunc)
          for k, g in groupby(data, keyfunc):
              groups.append(list(g))      # Store group iterator as a list
              uniquekeys.append(k)

     *note groupby(): 1a76. is roughly equivalent to:

          class groupby:
              # [k for k, g in groupby('AAAABBBCCDAABBB')] --> A B C D A B
              # [list(g) for k, g in groupby('AAAABBBCCD')] --> AAAA BBB CC D
              def __init__(self, iterable, key=None):
                  if key is None:
                      key = lambda x: x
                  self.keyfunc = key
                  self.it = iter(iterable)
                  self.tgtkey = self.currkey = self.currvalue = object()
              def __iter__(self):
                  return self
              def __next__(self):
                  self.id = object()
                  while self.currkey == self.tgtkey:
                      self.currvalue = next(self.it)    # Exit on StopIteration
                      self.currkey = self.keyfunc(self.currvalue)
                  self.tgtkey = self.currkey
                  return (self.currkey, self._grouper(self.tgtkey, self.id))
              def _grouper(self, tgtkey, id):
                  while self.id is id and self.currkey == tgtkey:
                      yield self.currvalue
                      try:
                          self.currvalue = next(self.it)
                      except StopIteration:
                          return
                      self.currkey = self.keyfunc(self.currvalue)

 -- Function: itertools.islice (iterable, stop)

 -- Function: itertools.islice (iterable, start, stop[, step])

     Make an iterator that returns selected elements from the iterable.
     If `start' is non-zero, then elements from the iterable are skipped
     until start is reached.  Afterward, elements are returned
     consecutively unless `step' is set higher than one which results in
     items being skipped.  If `stop' is ‘None’, then iteration continues
     until the iterator is exhausted, if at all; otherwise, it stops at
     the specified position.  Unlike regular slicing, *note islice():
     397. does not support negative values for `start', `stop', or
     `step'.  Can be used to extract related fields from data where the
     internal structure has been flattened (for example, a multi-line
     report may list a name field on every third line).  Roughly
     equivalent to:

          def islice(iterable, *args):
              # islice('ABCDEFG', 2) --> A B
              # islice('ABCDEFG', 2, 4) --> C D
              # islice('ABCDEFG', 2, None) --> C D E F G
              # islice('ABCDEFG', 0, None, 2) --> A C E G
              s = slice(*args)
              start, stop, step = s.start or 0, s.stop or sys.maxsize, s.step or 1
              it = iter(range(start, stop, step))
              try:
                  nexti = next(it)
              except StopIteration:
                  # Consume *iterable* up to the *start* position.
                  for i, element in zip(range(start), iterable):
                      pass
                  return
              try:
                  for i, element in enumerate(iterable):
                      if i == nexti:
                          yield element
                          nexti = next(it)
              except StopIteration:
                  # Consume to *stop*.
                  for i, element in zip(range(i + 1, stop), iterable):
                      pass

     If `start' is ‘None’, then iteration starts at zero.  If `step' is
     ‘None’, then the step defaults to one.

 -- Function: itertools.permutations (iterable, r=None)

     Return successive `r' length permutations of elements in the
     `iterable'.

     If `r' is not specified or is ‘None’, then `r' defaults to the
     length of the `iterable' and all possible full-length permutations
     are generated.

     Permutations are emitted in lexicographic sort order.  So, if the
     input `iterable' is sorted, the permutation tuples will be produced
     in sorted order.

     Elements are treated as unique based on their position, not on
     their value.  So if the input elements are unique, there will be no
     repeat values in each permutation.

     Roughly equivalent to:

          def permutations(iterable, r=None):
              # permutations('ABCD', 2) --> AB AC AD BA BC BD CA CB CD DA DB DC
              # permutations(range(3)) --> 012 021 102 120 201 210
              pool = tuple(iterable)
              n = len(pool)
              r = n if r is None else r
              if r > n:
                  return
              indices = list(range(n))
              cycles = list(range(n, n-r, -1))
              yield tuple(pool[i] for i in indices[:r])
              while n:
                  for i in reversed(range(r)):
                      cycles[i] -= 1
                      if cycles[i] == 0:
                          indices[i:] = indices[i+1:] + indices[i:i+1]
                          cycles[i] = n - i
                      else:
                          j = cycles[i]
                          indices[i], indices[-j] = indices[-j], indices[i]
                          yield tuple(pool[i] for i in indices[:r])
                          break
                  else:
                      return

     The code for *note permutations(): 1a79. can be also expressed as a
     subsequence of *note product(): c9a, filtered to exclude entries
     with repeated elements (those from the same position in the input
     pool):

          def permutations(iterable, r=None):
              pool = tuple(iterable)
              n = len(pool)
              r = n if r is None else r
              for indices in product(range(n), repeat=r):
                  if len(set(indices)) == r:
                      yield tuple(pool[i] for i in indices)

     The number of items returned is ‘n! / (n-r)!’ when ‘0 <= r <= n’ or
     zero when ‘r > n’.

 -- Function: itertools.product (*iterables, repeat=1)

     Cartesian product of input iterables.

     Roughly equivalent to nested for-loops in a generator expression.
     For example, ‘product(A, B)’ returns the same as ‘((x,y) for x in A
     for y in B)’.

     The nested loops cycle like an odometer with the rightmost element
     advancing on every iteration.  This pattern creates a lexicographic
     ordering so that if the input’s iterables are sorted, the product
     tuples are emitted in sorted order.

     To compute the product of an iterable with itself, specify the
     number of repetitions with the optional `repeat' keyword argument.
     For example, ‘product(A, repeat=4)’ means the same as ‘product(A,
     A, A, A)’.

     This function is roughly equivalent to the following code, except
     that the actual implementation does not build up intermediate
     results in memory:

          def product(*args, repeat=1):
              # product('ABCD', 'xy') --> Ax Ay Bx By Cx Cy Dx Dy
              # product(range(2), repeat=3) --> 000 001 010 011 100 101 110 111
              pools = [tuple(pool) for pool in args] * repeat
              result = [[]]
              for pool in pools:
                  result = [x+[y] for x in result for y in pool]
              for prod in result:
                  yield tuple(prod)

 -- Function: itertools.repeat (object[, times])

     Make an iterator that returns `object' over and over again.  Runs
     indefinitely unless the `times' argument is specified.  Used as
     argument to *note map(): c20. for invariant parameters to the
     called function.  Also used with *note zip(): c25. to create an
     invariant part of a tuple record.

     Roughly equivalent to:

          def repeat(object, times=None):
              # repeat(10, 3) --> 10 10 10
              if times is None:
                  while True:
                      yield object
              else:
                  for i in range(times):
                      yield object

     A common use for `repeat' is to supply a stream of constant values
     to `map' or `zip':

          >>> list(map(pow, range(10), repeat(2)))
          [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]

 -- Function: itertools.starmap (function, iterable)

     Make an iterator that computes the function using arguments
     obtained from the iterable.  Used instead of *note map(): c20. when
     argument parameters are already grouped in tuples from a single
     iterable (the data has been “pre-zipped”).  The difference between
     *note map(): c20. and *note starmap(): a1d. parallels the
     distinction between ‘function(a,b)’ and ‘function(*c)’.  Roughly
     equivalent to:

          def starmap(function, iterable):
              # starmap(pow, [(2,5), (3,2), (10,3)]) --> 32 9 1000
              for args in iterable:
                  yield function(*args)

 -- Function: itertools.takewhile (predicate, iterable)

     Make an iterator that returns elements from the iterable as long as
     the predicate is true.  Roughly equivalent to:

          def takewhile(predicate, iterable):
              # takewhile(lambda x: x<5, [1,4,6,4,1]) --> 1 4
              for x in iterable:
                  if predicate(x):
                      yield x
                  else:
                      break

 -- Function: itertools.tee (iterable, n=2)

     Return `n' independent iterators from a single iterable.

     The following Python code helps explain what `tee' does (although
     the actual implementation is more complex and uses only a single
     underlying FIFO queue).

     Roughly equivalent to:

          def tee(iterable, n=2):
              it = iter(iterable)
              deques = [collections.deque() for i in range(n)]
              def gen(mydeque):
                  while True:
                      if not mydeque:             # when the local deque is empty
                          try:
                              newval = next(it)   # fetch a new value and
                          except StopIteration:
                              return
                          for d in deques:        # load it to all the deques
                              d.append(newval)
                      yield mydeque.popleft()
              return tuple(gen(d) for d in deques)

     Once *note tee(): 1a78. has made a split, the original `iterable'
     should not be used anywhere else; otherwise, the `iterable' could
     get advanced without the tee objects being informed.

     ‘tee’ iterators are not threadsafe.  A *note RuntimeError: 2b8. may
     be raised when using simultaneously iterators returned by the same
     *note tee(): 1a78. call, even if the original `iterable' is
     threadsafe.

     This itertool may require significant auxiliary storage (depending
     on how much temporary data needs to be stored).  In general, if one
     iterator uses most or all of the data before another iterator
     starts, it is faster to use *note list(): 260. instead of *note
     tee(): 1a78.

 -- Function: itertools.zip_longest (*iterables, fillvalue=None)

     Make an iterator that aggregates elements from each of the
     iterables.  If the iterables are of uneven length, missing values
     are filled-in with `fillvalue'.  Iteration continues until the
     longest iterable is exhausted.  Roughly equivalent to:

          def zip_longest(*args, fillvalue=None):
              # zip_longest('ABCD', 'xy', fillvalue='-') --> Ax By C- D-
              iterators = [iter(it) for it in args]
              num_active = len(iterators)
              if not num_active:
                  return
              while True:
                  values = []
                  for i, it in enumerate(iterators):
                      try:
                          value = next(it)
                      except StopIteration:
                          num_active -= 1
                          if not num_active:
                              return
                          iterators[i] = repeat(fillvalue)
                          value = fillvalue
                      values.append(value)
                  yield tuple(values)

     If one of the iterables is potentially infinite, then the *note
     zip_longest(): c24. function should be wrapped with something that
     limits the number of calls (for example *note islice(): 397. or
     *note takewhile(): 1a77.).  If not specified, `fillvalue' defaults
     to ‘None’.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Recurrence_relation


File: python.info,  Node: Itertools Recipes,  Prev: Itertool functions,  Up: itertools — Functions creating iterators for efficient looping

5.10.1.2 Itertools Recipes
..........................

This section shows recipes for creating an extended toolset using the
existing itertools as building blocks.

Substantially all of these recipes and many, many others can be
installed from the more-itertools project(1) found on the Python Package
Index:

     pip install more-itertools

The extended tools offer the same high performance as the underlying
toolset.  The superior memory performance is kept by processing elements
one at a time rather than bringing the whole iterable into memory all at
once.  Code volume is kept small by linking the tools together in a
functional style which helps eliminate temporary variables.  High speed
is retained by preferring “vectorized” building blocks over the use of
for-loops and *note generator: 996.s which incur interpreter overhead.

     def take(n, iterable):
         "Return first n items of the iterable as a list"
         return list(islice(iterable, n))

     def prepend(value, iterator):
         "Prepend a single value in front of an iterator"
         # prepend(1, [2, 3, 4]) -> 1 2 3 4
         return chain([value], iterator)

     def tabulate(function, start=0):
         "Return function(0), function(1), ..."
         return map(function, count(start))

     def tail(n, iterable):
         "Return an iterator over the last n items"
         # tail(3, 'ABCDEFG') --> E F G
         return iter(collections.deque(iterable, maxlen=n))

     def consume(iterator, n=None):
         "Advance the iterator n-steps ahead. If n is None, consume entirely."
         # Use functions that consume iterators at C speed.
         if n is None:
             # feed the entire iterator into a zero-length deque
             collections.deque(iterator, maxlen=0)
         else:
             # advance to the empty slice starting at position n
             next(islice(iterator, n, n), None)

     def nth(iterable, n, default=None):
         "Returns the nth item or a default value"
         return next(islice(iterable, n, None), default)

     def all_equal(iterable):
         "Returns True if all the elements are equal to each other"
         g = groupby(iterable)
         return next(g, True) and not next(g, False)

     def quantify(iterable, pred=bool):
         "Count how many times the predicate is true"
         return sum(map(pred, iterable))

     def padnone(iterable):
         """Returns the sequence elements and then returns None indefinitely.

         Useful for emulating the behavior of the built-in map() function.
         """
         return chain(iterable, repeat(None))

     def ncycles(iterable, n):
         "Returns the sequence elements n times"
         return chain.from_iterable(repeat(tuple(iterable), n))

     def dotproduct(vec1, vec2):
         return sum(map(operator.mul, vec1, vec2))

     def flatten(list_of_lists):
         "Flatten one level of nesting"
         return chain.from_iterable(list_of_lists)

     def repeatfunc(func, times=None, *args):
         """Repeat calls to func with specified arguments.

         Example:  repeatfunc(random.random)
         """
         if times is None:
             return starmap(func, repeat(args))
         return starmap(func, repeat(args, times))

     def pairwise(iterable):
         "s -> (s0,s1), (s1,s2), (s2, s3), ..."
         a, b = tee(iterable)
         next(b, None)
         return zip(a, b)

     def grouper(iterable, n, fillvalue=None):
         "Collect data into fixed-length chunks or blocks"
         # grouper('ABCDEFG', 3, 'x') --> ABC DEF Gxx"
         args = [iter(iterable)] * n
         return zip_longest(*args, fillvalue=fillvalue)

     def roundrobin(*iterables):
         "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
         # Recipe credited to George Sakkis
         num_active = len(iterables)
         nexts = cycle(iter(it).__next__ for it in iterables)
         while num_active:
             try:
                 for next in nexts:
                     yield next()
             except StopIteration:
                 # Remove the iterator we just exhausted from the cycle.
                 num_active -= 1
                 nexts = cycle(islice(nexts, num_active))

     def partition(pred, iterable):
         'Use a predicate to partition entries into false entries and true entries'
         # partition(is_odd, range(10)) --> 0 2 4 6 8   and  1 3 5 7 9
         t1, t2 = tee(iterable)
         return filterfalse(pred, t1), filter(pred, t2)

     def powerset(iterable):
         "powerset([1,2,3]) --> () (1,) (2,) (3,) (1,2) (1,3) (2,3) (1,2,3)"
         s = list(iterable)
         return chain.from_iterable(combinations(s, r) for r in range(len(s)+1))

     def unique_everseen(iterable, key=None):
         "List unique elements, preserving order. Remember all elements ever seen."
         # unique_everseen('AAAABBBCCDAABBB') --> A B C D
         # unique_everseen('ABBCcAD', str.lower) --> A B C D
         seen = set()
         seen_add = seen.add
         if key is None:
             for element in filterfalse(seen.__contains__, iterable):
                 seen_add(element)
                 yield element
         else:
             for element in iterable:
                 k = key(element)
                 if k not in seen:
                     seen_add(k)
                     yield element

     def unique_justseen(iterable, key=None):
         "List unique elements, preserving order. Remember only the element just seen."
         # unique_justseen('AAAABBBCCDAABBB') --> A B C D A B
         # unique_justseen('ABBCcAD', str.lower) --> A B C A D
         return map(next, map(operator.itemgetter(1), groupby(iterable, key)))

     def iter_except(func, exception, first=None):
         """ Call a function repeatedly until an exception is raised.

         Converts a call-until-exception interface to an iterator interface.
         Like builtins.iter(func, sentinel) but uses an exception instead
         of a sentinel to end the loop.

         Examples:
             iter_except(functools.partial(heappop, h), IndexError)   # priority queue iterator
             iter_except(d.popitem, KeyError)                         # non-blocking dict iterator
             iter_except(d.popleft, IndexError)                       # non-blocking deque iterator
             iter_except(q.get_nowait, Queue.Empty)                   # loop over a producer Queue
             iter_except(s.pop, KeyError)                             # non-blocking set iterator

         """
         try:
             if first is not None:
                 yield first()            # For database APIs needing an initial cast to db.first()
             while True:
                 yield func()
         except exception:
             pass

     def first_true(iterable, default=False, pred=None):
         """Returns the first true value in the iterable.

         If no true value is found, returns *default*

         If *pred* is not None, returns the first item
         for which pred(item) is true.

         """
         # first_true([a,b,c], x) --> a or b or c or x
         # first_true([a,b], x, f) --> a if f(a) else b if f(b) else x
         return next(filter(pred, iterable), default)

     def random_product(*args, repeat=1):
         "Random selection from itertools.product(*args, **kwds)"
         pools = [tuple(pool) for pool in args] * repeat
         return tuple(random.choice(pool) for pool in pools)

     def random_permutation(iterable, r=None):
         "Random selection from itertools.permutations(iterable, r)"
         pool = tuple(iterable)
         r = len(pool) if r is None else r
         return tuple(random.sample(pool, r))

     def random_combination(iterable, r):
         "Random selection from itertools.combinations(iterable, r)"
         pool = tuple(iterable)
         n = len(pool)
         indices = sorted(random.sample(range(n), r))
         return tuple(pool[i] for i in indices)

     def random_combination_with_replacement(iterable, r):
         "Random selection from itertools.combinations_with_replacement(iterable, r)"
         pool = tuple(iterable)
         n = len(pool)
         indices = sorted(random.randrange(n) for i in range(r))
         return tuple(pool[i] for i in indices)

     def nth_combination(iterable, r, index):
         'Equivalent to list(combinations(iterable, r))[index]'
         pool = tuple(iterable)
         n = len(pool)
         if r < 0 or r > n:
             raise ValueError
         c = 1
         k = min(r, n-r)
         for i in range(1, k+1):
             c = c * (n - k + i) // i
         if index < 0:
             index += c
         if index < 0 or index >= c:
             raise IndexError
         result = []
         while r:
             c, n, r = c*r//n, n-1, r-1
             while index >= c:
                 index -= c
                 c, n = c*(n-r)//n, n-1
             result.append(pool[-1-n])
         return tuple(result)

   ---------- Footnotes ----------

   (1) https://pypi.org/project/more-itertools/


File: python.info,  Node: functools — Higher-order functions and operations on callable objects,  Next: operator — Standard operators as functions,  Prev: itertools — Functions creating iterators for efficient looping,  Up: Functional Programming Modules

5.10.2 ‘functools’ — Higher-order functions and operations on callable objects
------------------------------------------------------------------------------

`Source code:' Lib/functools.py(1)

__________________________________________________________________

The *note functools: 85. module is for higher-order functions: functions
that act on or return other functions.  In general, any callable object
can be treated as a function for the purposes of this module.

The *note functools: 85. module defines the following functions:

 -- Function: @functools.cached_property (func)

     Transform a method of a class into a property whose value is
     computed once and then cached as a normal attribute for the life of
     the instance.  Similar to *note property(): 1d5, with the addition
     of caching.  Useful for expensive computed properties of instances
     that are otherwise effectively immutable.

     Example:

          class DataSet:
              def __init__(self, sequence_of_numbers):
                  self._data = sequence_of_numbers

              @cached_property
              def stdev(self):
                  return statistics.stdev(self._data)

              @cached_property
              def variance(self):
                  return statistics.variance(self._data)

     New in version 3.8.

          Note: This decorator requires that the ‘__dict__’ attribute on
          each instance be a mutable mapping.  This means it will not
          work with some types, such as metaclasses (since the
          ‘__dict__’ attributes on type instances are read-only proxies
          for the class namespace), and those that specify ‘__slots__’
          without including ‘__dict__’ as one of the defined slots (as
          such classes don’t provide a ‘__dict__’ attribute at all).

 -- Function: functools.cmp_to_key (func)

     Transform an old-style comparison function to a *note key function:
     6d4.  Used with tools that accept key functions (such as *note
     sorted(): 439, *note min(): 7fd, *note max(): 7fe, *note
     heapq.nlargest(): 189c, *note heapq.nsmallest(): 189d, *note
     itertools.groupby(): 1a76.).  This function is primarily used as a
     transition tool for programs being converted from Python 2 which
     supported the use of comparison functions.

     A comparison function is any callable that accept two arguments,
     compares them, and returns a negative number for less-than, zero
     for equality, or a positive number for greater-than.  A key
     function is a callable that accepts one argument and returns
     another value to be used as the sort key.

     Example:

          sorted(iterable, key=cmp_to_key(locale.strcoll))  # locale-aware sort order

     For sorting examples and a brief sorting tutorial, see *note
     Sorting HOW TO: 153c.

     New in version 3.2.

 -- Function: @functools.lru_cache (user_function)

 -- Function: @functools.lru_cache (maxsize=128, typed=False)

     Decorator to wrap a function with a memoizing callable that saves
     up to the `maxsize' most recent calls.  It can save time when an
     expensive or I/O bound function is periodically called with the
     same arguments.

     Since a dictionary is used to cache results, the positional and
     keyword arguments to the function must be hashable.

     Distinct argument patterns may be considered to be distinct calls
     with separate cache entries.  For example, ‘f(a=1, b=2)’ and
     ‘f(b=2, a=1)’ differ in their keyword argument order and may have
     two separate cache entries.

     If `user_function' is specified, it must be a callable.  This
     allows the `lru_cache' decorator to be applied directly to a user
     function, leaving the `maxsize' at its default value of 128:

          @lru_cache
          def count_vowels(sentence):
              sentence = sentence.casefold()
              return sum(sentence.count(vowel) for vowel in 'aeiou')

     If `maxsize' is set to ‘None’, the LRU feature is disabled and the
     cache can grow without bound.  The LRU feature performs best when
     `maxsize' is a power-of-two.

     If `typed' is set to true, function arguments of different types
     will be cached separately.  For example, ‘f(3)’ and ‘f(3.0)’ will
     be treated as distinct calls with distinct results.

     To help measure the effectiveness of the cache and tune the
     `maxsize' parameter, the wrapped function is instrumented with a
     ‘cache_info()’ function that returns a *note named tuple: a98.
     showing `hits', `misses', `maxsize' and `currsize'.  In a
     multi-threaded environment, the hits and misses are approximate.

     The decorator also provides a ‘cache_clear()’ function for clearing
     or invalidating the cache.

     The original underlying function is accessible through the
     ‘__wrapped__’ attribute.  This is useful for introspection, for
     bypassing the cache, or for rewrapping the function with a
     different cache.

     An LRU (least recently used) cache(2) works best when the most
     recent calls are the best predictors of upcoming calls (for
     example, the most popular articles on a news server tend to change
     each day).  The cache’s size limit assures that the cache does not
     grow without bound on long-running processes such as web servers.

     In general, the LRU cache should only be used when you want to
     reuse previously computed values.  Accordingly, it doesn’t make
     sense to cache functions with side-effects, functions that need to
     create distinct mutable objects on each call, or impure functions
     such as time() or random().

     Example of an LRU cache for static web content:

          @lru_cache(maxsize=32)
          def get_pep(num):
              'Retrieve text of a Python Enhancement Proposal'
              resource = 'http://www.python.org/dev/peps/pep-%04d/' % num
              try:
                  with urllib.request.urlopen(resource) as s:
                      return s.read()
              except urllib.error.HTTPError:
                  return 'Not Found'

          >>> for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991:
          ...     pep = get_pep(n)
          ...     print(n, len(pep))

          >>> get_pep.cache_info()
          CacheInfo(hits=3, misses=8, maxsize=32, currsize=8)

     Example of efficiently computing Fibonacci numbers(3) using a cache
     to implement a dynamic programming(4) technique:

          @lru_cache(maxsize=None)
          def fib(n):
              if n < 2:
                  return n
              return fib(n-1) + fib(n-2)

          >>> [fib(n) for n in range(16)]
          [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610]

          >>> fib.cache_info()
          CacheInfo(hits=28, misses=16, maxsize=None, currsize=16)

     New in version 3.2.

     Changed in version 3.3: Added the `typed' option.

     Changed in version 3.8: Added the `user_function' option.

 -- Function: @functools.total_ordering

     Given a class defining one or more rich comparison ordering
     methods, this class decorator supplies the rest.  This simplifies
     the effort involved in specifying all of the possible rich
     comparison operations:

     The class must define one of *note __lt__(): c27, *note __le__():
     c93, *note __gt__(): c94, or *note __ge__(): c95.  In addition, the
     class should supply an *note __eq__(): 334. method.

     For example:

          @total_ordering
          class Student:
              def _is_valid_operand(self, other):
                  return (hasattr(other, "lastname") and
                          hasattr(other, "firstname"))
              def __eq__(self, other):
                  if not self._is_valid_operand(other):
                      return NotImplemented
                  return ((self.lastname.lower(), self.firstname.lower()) ==
                          (other.lastname.lower(), other.firstname.lower()))
              def __lt__(self, other):
                  if not self._is_valid_operand(other):
                      return NotImplemented
                  return ((self.lastname.lower(), self.firstname.lower()) <
                          (other.lastname.lower(), other.firstname.lower()))

          Note: While this decorator makes it easy to create well
          behaved totally ordered types, it `does' come at the cost of
          slower execution and more complex stack traces for the derived
          comparison methods.  If performance benchmarking indicates
          this is a bottleneck for a given application, implementing all
          six rich comparison methods instead is likely to provide an
          easy speed boost.

     New in version 3.2.

     Changed in version 3.4: Returning NotImplemented from the
     underlying comparison function for unrecognised types is now
     supported.

 -- Function: functools.partial (func, /, *args, **keywords)

     Return a new *note partial object: 1a80. which when called will
     behave like `func' called with the positional arguments `args' and
     keyword arguments `keywords'.  If more arguments are supplied to
     the call, they are appended to `args'.  If additional keyword
     arguments are supplied, they extend and override `keywords'.
     Roughly equivalent to:

          def partial(func, /, *args, **keywords):
              def newfunc(*fargs, **fkeywords):
                  newkeywords = {**keywords, **fkeywords}
                  return func(*args, *fargs, **newkeywords)
              newfunc.func = func
              newfunc.args = args
              newfunc.keywords = keywords
              return newfunc

     The *note partial(): 7bc. is used for partial function application
     which “freezes” some portion of a function’s arguments and/or
     keywords resulting in a new object with a simplified signature.
     For example, *note partial(): 7bc. can be used to create a callable
     that behaves like the *note int(): 184. function where the `base'
     argument defaults to two:

          >>> from functools import partial
          >>> basetwo = partial(int, base=2)
          >>> basetwo.__doc__ = 'Convert base 2 string to an int.'
          >>> basetwo('10010')
          18

 -- Class: functools.partialmethod (func, /, *args, **keywords)

     Return a new *note partialmethod: 29a. descriptor which behaves
     like *note partial: 7bc. except that it is designed to be used as a
     method definition rather than being directly callable.

     `func' must be a *note descriptor: 1541. or a callable (objects
     which are both, like normal functions, are handled as descriptors).

     When `func' is a descriptor (such as a normal Python function,
     *note classmethod(): 1d6, *note staticmethod(): 1d7,
     ‘abstractmethod()’ or another instance of *note partialmethod:
     29a.), calls to ‘__get__’ are delegated to the underlying
     descriptor, and an appropriate *note partial object: 1a80. returned
     as the result.

     When `func' is a non-descriptor callable, an appropriate bound
     method is created dynamically.  This behaves like a normal Python
     function when used as a method: the `self' argument will be
     inserted as the first positional argument, even before the `args'
     and `keywords' supplied to the *note partialmethod: 29a.
     constructor.

     Example:

          >>> class Cell(object):
          ...     def __init__(self):
          ...         self._alive = False
          ...     @property
          ...     def alive(self):
          ...         return self._alive
          ...     def set_state(self, state):
          ...         self._alive = bool(state)
          ...     set_alive = partialmethod(set_state, True)
          ...     set_dead = partialmethod(set_state, False)
          ...
          >>> c = Cell()
          >>> c.alive
          False
          >>> c.set_alive()
          >>> c.alive
          True

     New in version 3.4.

 -- Function: functools.reduce (function, iterable[, initializer])

     Apply `function' of two arguments cumulatively to the items of
     `iterable', from left to right, so as to reduce the iterable to a
     single value.  For example, ‘reduce(lambda x, y: x+y, [1, 2, 3, 4,
     5])’ calculates ‘((((1+2)+3)+4)+5)’.  The left argument, `x', is
     the accumulated value and the right argument, `y', is the update
     value from the `iterable'.  If the optional `initializer' is
     present, it is placed before the items of the iterable in the
     calculation, and serves as a default when the iterable is empty.
     If `initializer' is not given and `iterable' contains only one
     item, the first item is returned.

     Roughly equivalent to:

          def reduce(function, iterable, initializer=None):
              it = iter(iterable)
              if initializer is None:
                  value = next(it)
              else:
                  value = initializer
              for element in it:
                  value = function(value, element)
              return value

     See *note itertools.accumulate(): 1db. for an iterator that yields
     all intermediate values.

 -- Function: @functools.singledispatch

     Transform a function into a *note single-dispatch: 1c9. *note
     generic function: 1c8.

     To define a generic function, decorate it with the
     ‘@singledispatch’ decorator.  Note that the dispatch happens on the
     type of the first argument, create your function accordingly:

          >>> from functools import singledispatch
          >>> @singledispatch
          ... def fun(arg, verbose=False):
          ...     if verbose:
          ...         print("Let me just say,", end=" ")
          ...     print(arg)

     To add overloaded implementations to the function, use the
     ‘register()’ attribute of the generic function.  It is a decorator.
     For functions annotated with types, the decorator will infer the
     type of the first argument automatically:

          >>> @fun.register
          ... def _(arg: int, verbose=False):
          ...     if verbose:
          ...         print("Strength in numbers, eh?", end=" ")
          ...     print(arg)
          ...
          >>> @fun.register
          ... def _(arg: list, verbose=False):
          ...     if verbose:
          ...         print("Enumerate this:")
          ...     for i, elem in enumerate(arg):
          ...         print(i, elem)

     For code which doesn’t use type annotations, the appropriate type
     argument can be passed explicitly to the decorator itself:

          >>> @fun.register(complex)
          ... def _(arg, verbose=False):
          ...     if verbose:
          ...         print("Better than complicated.", end=" ")
          ...     print(arg.real, arg.imag)
          ...

     To enable registering lambdas and pre-existing functions, the
     ‘register()’ attribute can be used in a functional form:

          >>> def nothing(arg, verbose=False):
          ...     print("Nothing.")
          ...
          >>> fun.register(type(None), nothing)

     The ‘register()’ attribute returns the undecorated function which
     enables decorator stacking, pickling, as well as creating unit
     tests for each variant independently:

          >>> @fun.register(float)
          ... @fun.register(Decimal)
          ... def fun_num(arg, verbose=False):
          ...     if verbose:
          ...         print("Half of your number:", end=" ")
          ...     print(arg / 2)
          ...
          >>> fun_num is fun
          False

     When called, the generic function dispatches on the type of the
     first argument:

          >>> fun("Hello, world.")
          Hello, world.
          >>> fun("test.", verbose=True)
          Let me just say, test.
          >>> fun(42, verbose=True)
          Strength in numbers, eh? 42
          >>> fun(['spam', 'spam', 'eggs', 'spam'], verbose=True)
          Enumerate this:
          0 spam
          1 spam
          2 eggs
          3 spam
          >>> fun(None)
          Nothing.
          >>> fun(1.23)
          0.615

     Where there is no registered implementation for a specific type,
     its method resolution order is used to find a more generic
     implementation.  The original function decorated with
     ‘@singledispatch’ is registered for the base ‘object’ type, which
     means it is used if no better implementation is found.

     To check which implementation will the generic function choose for
     a given type, use the ‘dispatch()’ attribute:

          >>> fun.dispatch(float)
          <function fun_num at 0x1035a2840>
          >>> fun.dispatch(dict)    # note: default implementation
          <function fun at 0x103fe0000>

     To access all registered implementations, use the read-only
     ‘registry’ attribute:

          >>> fun.registry.keys()
          dict_keys([<class 'NoneType'>, <class 'int'>, <class 'object'>,
                    <class 'decimal.Decimal'>, <class 'list'>,
                    <class 'float'>])
          >>> fun.registry[float]
          <function fun_num at 0x1035a2840>
          >>> fun.registry[object]
          <function fun at 0x103fe0000>

     New in version 3.4.

     Changed in version 3.7: The ‘register()’ attribute supports using
     type annotations.

 -- Class: functools.singledispatchmethod (func)

     Transform a method into a *note single-dispatch: 1c9. *note generic
     function: 1c8.

     To define a generic method, decorate it with the
     ‘@singledispatchmethod’ decorator.  Note that the dispatch happens
     on the type of the first non-self or non-cls argument, create your
     function accordingly:

          class Negator:
              @singledispatchmethod
              def neg(self, arg):
                  raise NotImplementedError("Cannot negate a")

              @neg.register
              def _(self, arg: int):
                  return -arg

              @neg.register
              def _(self, arg: bool):
                  return not arg

     ‘@singledispatchmethod’ supports nesting with other decorators such
     as ‘@classmethod’.  Note that to allow for ‘dispatcher.register’,
     ‘singledispatchmethod’ must be the `outer most' decorator.  Here is
     the ‘Negator’ class with the ‘neg’ methods being class bound:

          class Negator:
              @singledispatchmethod
              @classmethod
              def neg(cls, arg):
                  raise NotImplementedError("Cannot negate a")

              @neg.register
              @classmethod
              def _(cls, arg: int):
                  return -arg

              @neg.register
              @classmethod
              def _(cls, arg: bool):
                  return not arg

     The same pattern can be used for other similar decorators:
     ‘staticmethod’, ‘abstractmethod’, and others.

     New in version 3.8.

 -- Function: functools.update_wrapper (wrapper, wrapped,
          assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

     Update a `wrapper' function to look like the `wrapped' function.
     The optional arguments are tuples to specify which attributes of
     the original function are assigned directly to the matching
     attributes on the wrapper function and which attributes of the
     wrapper function are updated with the corresponding attributes from
     the original function.  The default values for these arguments are
     the module level constants ‘WRAPPER_ASSIGNMENTS’ (which assigns to
     the wrapper function’s ‘__module__’, ‘__name__’, ‘__qualname__’,
     ‘__annotations__’ and ‘__doc__’, the documentation string) and
     ‘WRAPPER_UPDATES’ (which updates the wrapper function’s ‘__dict__’,
     i.e.  the instance dictionary).

     To allow access to the original function for introspection and
     other purposes (e.g.  bypassing a caching decorator such as *note
     lru_cache(): 1c5.), this function automatically adds a
     ‘__wrapped__’ attribute to the wrapper that refers to the function
     being wrapped.

     The main intended use for this function is in *note decorator: 281.
     functions which wrap the decorated function and return the wrapper.
     If the wrapper function is not updated, the metadata of the
     returned function will reflect the wrapper definition rather than
     the original function definition, which is typically less than
     helpful.

     *note update_wrapper(): 94e. may be used with callables other than
     functions.  Any attributes named in `assigned' or `updated' that
     are missing from the object being wrapped are ignored (i.e.  this
     function will not attempt to set them on the wrapper function).
     *note AttributeError: 390. is still raised if the wrapper function
     itself is missing any attributes named in `updated'.

     New in version 3.2: Automatic addition of the ‘__wrapped__’
     attribute.

     New in version 3.2: Copying of the ‘__annotations__’ attribute by
     default.

     Changed in version 3.2: Missing attributes no longer trigger an
     *note AttributeError: 390.

     Changed in version 3.4: The ‘__wrapped__’ attribute now always
     refers to the wrapped function, even if that function defined a
     ‘__wrapped__’ attribute.  (see bpo-17482(5))

 -- Function: @functools.wraps (wrapped, assigned=WRAPPER_ASSIGNMENTS,
          updated=WRAPPER_UPDATES)

     This is a convenience function for invoking *note update_wrapper():
     94e. as a function decorator when defining a wrapper function.  It
     is equivalent to ‘partial(update_wrapper, wrapped=wrapped,
     assigned=assigned, updated=updated)’.  For example:

          >>> from functools import wraps
          >>> def my_decorator(f):
          ...     @wraps(f)
          ...     def wrapper(*args, **kwds):
          ...         print('Calling decorated function')
          ...         return f(*args, **kwds)
          ...     return wrapper
          ...
          >>> @my_decorator
          ... def example():
          ...     """Docstring"""
          ...     print('Called example function')
          ...
          >>> example()
          Calling decorated function
          Called example function
          >>> example.__name__
          'example'
          >>> example.__doc__
          'Docstring'

     Without the use of this decorator factory, the name of the example
     function would have been ‘'wrapper'’, and the docstring of the
     original ‘example()’ would have been lost.

* Menu:

* partial Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/functools.py

   (2) https://en.wikipedia.org/wiki/Cache_algorithms#Examples

   (3) https://en.wikipedia.org/wiki/Fibonacci_number

   (4) https://en.wikipedia.org/wiki/Dynamic_programming

   (5) https://bugs.python.org/issue17482


File: python.info,  Node: partial Objects,  Up: functools — Higher-order functions and operations on callable objects

5.10.2.1 ‘partial’ Objects
..........................

*note partial: 7bc. objects are callable objects created by *note
partial(): 7bc.  They have three read-only attributes:

 -- Attribute: partial.func

     A callable object or function.  Calls to the *note partial: 7bc.
     object will be forwarded to *note func: 1a82. with new arguments
     and keywords.

 -- Attribute: partial.args

     The leftmost positional arguments that will be prepended to the
     positional arguments provided to a *note partial: 7bc. object call.

 -- Attribute: partial.keywords

     The keyword arguments that will be supplied when the *note partial:
     7bc. object is called.

*note partial: 7bc. objects are like ‘function’ objects in that they are
callable, weak referencable, and can have attributes.  There are some
important differences.  For instance, the *note __name__: c5a. and
‘__doc__’ attributes are not created automatically.  Also, *note
partial: 7bc. objects defined in classes behave like static methods and
do not transform into bound methods during instance attribute look-up.


File: python.info,  Node: operator — Standard operators as functions,  Prev: functools — Higher-order functions and operations on callable objects,  Up: Functional Programming Modules

5.10.3 ‘operator’ — Standard operators as functions
---------------------------------------------------

`Source code:' Lib/operator.py(1)

__________________________________________________________________

The *note operator: c2. module exports a set of efficient functions
corresponding to the intrinsic operators of Python.  For example,
‘operator.add(x, y)’ is equivalent to the expression ‘x+y’.  Many
function names are those used for special methods, without the double
underscores.  For backward compatibility, many of these have a variant
with the double underscores kept.  The variants without the double
underscores are preferred for clarity.

The functions fall into categories that perform object comparisons,
logical operations, mathematical operations and sequence operations.

The object comparison functions are useful for all objects, and are
named after the rich comparison operators they support:

 -- Function: operator.lt (a, b)
 -- Function: operator.le (a, b)
 -- Function: operator.eq (a, b)
 -- Function: operator.ne (a, b)
 -- Function: operator.ge (a, b)
 -- Function: operator.gt (a, b)
 -- Function: operator.__lt__ (a, b)
 -- Function: operator.__le__ (a, b)
 -- Function: operator.__eq__ (a, b)
 -- Function: operator.__ne__ (a, b)
 -- Function: operator.__ge__ (a, b)
 -- Function: operator.__gt__ (a, b)

     Perform “rich comparisons” between `a' and `b'.  Specifically,
     ‘lt(a, b)’ is equivalent to ‘a < b’, ‘le(a, b)’ is equivalent to ‘a
     <= b’, ‘eq(a, b)’ is equivalent to ‘a == b’, ‘ne(a, b)’ is
     equivalent to ‘a != b’, ‘gt(a, b)’ is equivalent to ‘a > b’ and
     ‘ge(a, b)’ is equivalent to ‘a >= b’.  Note that these functions
     can return any value, which may or may not be interpretable as a
     Boolean value.  See *note Comparisons: 147f. for more information
     about rich comparisons.

The logical operations are also generally applicable to all objects, and
support truth tests, identity tests, and boolean operations:

 -- Function: operator.not_ (obj)
 -- Function: operator.__not__ (obj)

     Return the outcome of *note not: 148b. `obj'.  (Note that there is
     no *note __not__(): 1a94. method for object instances; only the
     interpreter core defines this operation.  The result is affected by
     the *note __bool__(): c5b. and *note __len__(): dbe. methods.)

 -- Function: operator.truth (obj)

     Return *note True: 48f. if `obj' is true, and *note False: 37d.
     otherwise.  This is equivalent to using the *note bool: 183.
     constructor.

 -- Function: operator.is_ (a, b)

     Return ‘a is b’.  Tests object identity.

 -- Function: operator.is_not (a, b)

     Return ‘a is not b’.  Tests object identity.

The mathematical and bitwise operations are the most numerous:

 -- Function: operator.abs (obj)
 -- Function: operator.__abs__ (obj)

     Return the absolute value of `obj'.

 -- Function: operator.add (a, b)
 -- Function: operator.__add__ (a, b)

     Return ‘a + b’, for `a' and `b' numbers.

 -- Function: operator.and_ (a, b)
 -- Function: operator.__and__ (a, b)

     Return the bitwise and of `a' and `b'.

 -- Function: operator.floordiv (a, b)
 -- Function: operator.__floordiv__ (a, b)

     Return ‘a // b’.

 -- Function: operator.index (a)
 -- Function: operator.__index__ (a)

     Return `a' converted to an integer.  Equivalent to ‘a.__index__()’.

 -- Function: operator.inv (obj)
 -- Function: operator.invert (obj)
 -- Function: operator.__inv__ (obj)
 -- Function: operator.__invert__ (obj)

     Return the bitwise inverse of the number `obj'.  This is equivalent
     to ‘~obj’.

 -- Function: operator.lshift (a, b)
 -- Function: operator.__lshift__ (a, b)

     Return `a' shifted left by `b'.

 -- Function: operator.mod (a, b)
 -- Function: operator.__mod__ (a, b)

     Return ‘a % b’.

 -- Function: operator.mul (a, b)
 -- Function: operator.__mul__ (a, b)

     Return ‘a * b’, for `a' and `b' numbers.

 -- Function: operator.matmul (a, b)
 -- Function: operator.__matmul__ (a, b)

     Return ‘a @ b’.

     New in version 3.5.

 -- Function: operator.neg (obj)
 -- Function: operator.__neg__ (obj)

     Return `obj' negated (‘-obj’).

 -- Function: operator.or_ (a, b)
 -- Function: operator.__or__ (a, b)

     Return the bitwise or of `a' and `b'.

 -- Function: operator.pos (obj)
 -- Function: operator.__pos__ (obj)

     Return `obj' positive (‘+obj’).

 -- Function: operator.pow (a, b)
 -- Function: operator.__pow__ (a, b)

     Return ‘a ** b’, for `a' and `b' numbers.

 -- Function: operator.rshift (a, b)
 -- Function: operator.__rshift__ (a, b)

     Return `a' shifted right by `b'.

 -- Function: operator.sub (a, b)
 -- Function: operator.__sub__ (a, b)

     Return ‘a - b’.

 -- Function: operator.truediv (a, b)
 -- Function: operator.__truediv__ (a, b)

     Return ‘a / b’ where 2/3 is .66 rather than 0.  This is also known
     as “true” division.

 -- Function: operator.xor (a, b)
 -- Function: operator.__xor__ (a, b)

     Return the bitwise exclusive or of `a' and `b'.

Operations which work with sequences (some of them with mappings too)
include:

 -- Function: operator.concat (a, b)
 -- Function: operator.__concat__ (a, b)

     Return ‘a + b’ for `a' and `b' sequences.

 -- Function: operator.contains (a, b)
 -- Function: operator.__contains__ (a, b)

     Return the outcome of the test ‘b in a’.  Note the reversed
     operands.

 -- Function: operator.countOf (a, b)

     Return the number of occurrences of `b' in `a'.

 -- Function: operator.delitem (a, b)
 -- Function: operator.__delitem__ (a, b)

     Remove the value of `a' at index `b'.

 -- Function: operator.getitem (a, b)
 -- Function: operator.__getitem__ (a, b)

     Return the value of `a' at index `b'.

 -- Function: operator.indexOf (a, b)

     Return the index of the first of occurrence of `b' in `a'.

 -- Function: operator.setitem (a, b, c)
 -- Function: operator.__setitem__ (a, b, c)

     Set the value of `a' at index `b' to `c'.

 -- Function: operator.length_hint (obj, default=0)

     Return an estimated length for the object `o'.  First try to return
     its actual length, then an estimate using *note
     object.__length_hint__(): 800, and finally return the default
     value.

     New in version 3.4.

The *note operator: c2. module also defines tools for generalized
attribute and item lookups.  These are useful for making fast field
extractors as arguments for *note map(): c20, *note sorted(): 439, *note
itertools.groupby(): 1a76, or other functions that expect a function
argument.

 -- Function: operator.attrgetter (attr)

 -- Function: operator.attrgetter (*attrs)

     Return a callable object that fetches `attr' from its operand.  If
     more than one attribute is requested, returns a tuple of
     attributes.  The attribute names can also contain dots.  For
     example:

        * After ‘f = attrgetter('name')’, the call ‘f(b)’ returns
          ‘b.name’.

        * After ‘f = attrgetter('name', 'date')’, the call ‘f(b)’
          returns ‘(b.name, b.date)’.

        * After ‘f = attrgetter('name.first', 'name.last')’, the call
          ‘f(b)’ returns ‘(b.name.first, b.name.last)’.

     Equivalent to:

          def attrgetter(*items):
              if any(not isinstance(item, str) for item in items):
                  raise TypeError('attribute name must be a string')
              if len(items) == 1:
                  attr = items[0]
                  def g(obj):
                      return resolve_attr(obj, attr)
              else:
                  def g(obj):
                      return tuple(resolve_attr(obj, attr) for attr in items)
              return g

          def resolve_attr(obj, attr):
              for name in attr.split("."):
                  obj = getattr(obj, name)
              return obj

 -- Function: operator.itemgetter (item)

 -- Function: operator.itemgetter (*items)

     Return a callable object that fetches `item' from its operand using
     the operand’s *note __getitem__(): 1ac3. method.  If multiple items
     are specified, returns a tuple of lookup values.  For example:

        * After ‘f = itemgetter(2)’, the call ‘f(r)’ returns ‘r[2]’.

        * After ‘g = itemgetter(2, 5, 3)’, the call ‘g(r)’ returns
          ‘(r[2], r[5], r[3])’.

     Equivalent to:

          def itemgetter(*items):
              if len(items) == 1:
                  item = items[0]
                  def g(obj):
                      return obj[item]
              else:
                  def g(obj):
                      return tuple(obj[item] for item in items)
              return g

     The items can be any type accepted by the operand’s *note
     __getitem__(): 1ac3. method.  Dictionaries accept any hashable
     value.  Lists, tuples, and strings accept an index or a slice:

          >>> itemgetter('name')({'name': 'tu', 'age': 18})
          'tu'
          >>> itemgetter(1)('ABCDEFG')
          'B'
          >>> itemgetter(1,3,5)('ABCDEFG')
          ('B', 'D', 'F')
          >>> itemgetter(slice(2,None))('ABCDEFG')
          'CDEFG'

          >>> soldier = dict(rank='captain', name='dotterbart')
          >>> itemgetter('rank')(soldier)
          'captain'

     Example of using *note itemgetter(): 25f. to retrieve specific
     fields from a tuple record:

          >>> inventory = [('apple', 3), ('banana', 2), ('pear', 5), ('orange', 1)]
          >>> getcount = itemgetter(1)
          >>> list(map(getcount, inventory))
          [3, 2, 5, 1]
          >>> sorted(inventory, key=getcount)
          [('orange', 1), ('banana', 2), ('apple', 3), ('pear', 5)]

 -- Function: operator.methodcaller (name, /, *args, **kwargs)

     Return a callable object that calls the method `name' on its
     operand.  If additional arguments and/or keyword arguments are
     given, they will be given to the method as well.  For example:

        * After ‘f = methodcaller('name')’, the call ‘f(b)’ returns
          ‘b.name()’.

        * After ‘f = methodcaller('name', 'foo', bar=1)’, the call
          ‘f(b)’ returns ‘b.name('foo', bar=1)’.

     Equivalent to:

          def methodcaller(name, /, *args, **kwargs):
              def caller(obj):
                  return getattr(obj, name)(*args, **kwargs)
              return caller

* Menu:

* Mapping Operators to Functions::
* In-place Operators::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/operator.py


File: python.info,  Node: Mapping Operators to Functions,  Next: In-place Operators,  Up: operator — Standard operators as functions

5.10.3.1 Mapping Operators to Functions
.......................................

This table shows how abstract operations correspond to operator symbols
in the Python syntax and the functions in the *note operator: c2.
module.

Operation                   Syntax                        Function
                                                          
------------------------------------------------------------------------------------------------------
                                                          
Addition                    ‘a + b’                       ‘add(a, b)’
                                                          
                                                          
Concatenation               ‘seq1 + seq2’                 ‘concat(seq1, seq2)’
                                                          
                                                          
Containment Test            ‘obj in seq’                  ‘contains(seq, obj)’
                                                          
                                                          
Division                    ‘a / b’                       ‘truediv(a, b)’
                                                          
                                                          
Division                    ‘a // b’                      ‘floordiv(a, b)’
                                                          
                                                          
Bitwise And                 ‘a & b’                       ‘and_(a, b)’
                                                          
                                                          
Bitwise Exclusive Or        ‘a ^ b’                       ‘xor(a, b)’
                                                          
                                                          
Bitwise Inversion           ‘~ a’                         ‘invert(a)’
                                                          
                                                          
Bitwise Or                  ‘a | b’                       ‘or_(a, b)’
                                                          
                                                          
Exponentiation              ‘a ** b’                      ‘pow(a, b)’
                                                          
                                                          
Identity                    ‘a is b’                      ‘is_(a, b)’
                                                          
                                                          
Identity                    ‘a is not b’                  ‘is_not(a, b)’
                                                          
                                                          
Indexed Assignment          ‘obj[k] = v’                  ‘setitem(obj, k, v)’
                                                          
                                                          
Indexed Deletion            ‘del obj[k]’                  ‘delitem(obj, k)’
                                                          
                                                          
Indexing                    ‘obj[k]’                      ‘getitem(obj, k)’
                                                          
                                                          
Left Shift                  ‘a << b’                      ‘lshift(a, b)’
                                                          
                                                          
Modulo                      ‘a % b’                       ‘mod(a, b)’
                                                          
                                                          
Multiplication              ‘a * b’                       ‘mul(a, b)’
                                                          
                                                          
Matrix Multiplication       ‘a @ b’                       ‘matmul(a, b)’
                                                          
                                                          
Negation (Arithmetic)       ‘- a’                         ‘neg(a)’
                                                          
                                                          
Negation (Logical)          ‘not a’                       ‘not_(a)’
                                                          
                                                          
Positive                    ‘+ a’                         ‘pos(a)’
                                                          
                                                          
Right Shift                 ‘a >> b’                      ‘rshift(a, b)’
                                                          
                                                          
Slice Assignment            ‘seq[i:j] = values’           ‘setitem(seq, slice(i, j), values)’
                                                          
                                                          
Slice Deletion              ‘del seq[i:j]’                ‘delitem(seq, slice(i, j))’
                                                          
                                                          
Slicing                     ‘seq[i:j]’                    ‘getitem(seq, slice(i, j))’
                                                          
                                                          
String Formatting           ‘s % obj’                     ‘mod(s, obj)’
                                                          
                                                          
Subtraction                 ‘a - b’                       ‘sub(a, b)’
                                                          
                                                          
Truth Test                  ‘obj’                         ‘truth(obj)’
                                                          
                                                          
Ordering                    ‘a < b’                       ‘lt(a, b)’
                                                          
                                                          
Ordering                    ‘a <= b’                      ‘le(a, b)’
                                                          
                                                          
Equality                    ‘a == b’                      ‘eq(a, b)’
                                                          
                                                          
Difference                  ‘a != b’                      ‘ne(a, b)’
                                                          
                                                          
Ordering                    ‘a >= b’                      ‘ge(a, b)’
                                                          
                                                          
Ordering                    ‘a > b’                       ‘gt(a, b)’
                                                          


File: python.info,  Node: In-place Operators,  Prev: Mapping Operators to Functions,  Up: operator — Standard operators as functions

5.10.3.2 In-place Operators
...........................

Many operations have an “in-place” version.  Listed below are functions
providing a more primitive access to in-place operators than the usual
syntax does; for example, the *note statement: 1aca. ‘x += y’ is
equivalent to ‘x = operator.iadd(x, y)’.  Another way to put it is to
say that ‘z = operator.iadd(x, y)’ is equivalent to the compound
statement ‘z = x; z += y’.

In those examples, note that when an in-place method is called, the
computation and assignment are performed in two separate steps.  The
in-place functions listed below only do the first step, calling the
in-place method.  The second step, assignment, is not handled.

For immutable targets such as strings, numbers, and tuples, the updated
value is computed, but not assigned back to the input variable:

     >>> a = 'hello'
     >>> iadd(a, ' world')
     'hello world'
     >>> a
     'hello'

For mutable targets such as lists and dictionaries, the in-place method
will perform the update, so no subsequent assignment is necessary:

     >>> s = ['h', 'e', 'l', 'l', 'o']
     >>> iadd(s, [' ', 'w', 'o', 'r', 'l', 'd'])
     ['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
     >>> s
     ['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']

 -- Function: operator.iadd (a, b)
 -- Function: operator.__iadd__ (a, b)

     ‘a = iadd(a, b)’ is equivalent to ‘a += b’.

 -- Function: operator.iand (a, b)
 -- Function: operator.__iand__ (a, b)

     ‘a = iand(a, b)’ is equivalent to ‘a &= b’.

 -- Function: operator.iconcat (a, b)
 -- Function: operator.__iconcat__ (a, b)

     ‘a = iconcat(a, b)’ is equivalent to ‘a += b’ for `a' and `b'
     sequences.

 -- Function: operator.ifloordiv (a, b)
 -- Function: operator.__ifloordiv__ (a, b)

     ‘a = ifloordiv(a, b)’ is equivalent to ‘a //= b’.

 -- Function: operator.ilshift (a, b)
 -- Function: operator.__ilshift__ (a, b)

     ‘a = ilshift(a, b)’ is equivalent to ‘a <<= b’.

 -- Function: operator.imod (a, b)
 -- Function: operator.__imod__ (a, b)

     ‘a = imod(a, b)’ is equivalent to ‘a %= b’.

 -- Function: operator.imul (a, b)
 -- Function: operator.__imul__ (a, b)

     ‘a = imul(a, b)’ is equivalent to ‘a *= b’.

 -- Function: operator.imatmul (a, b)
 -- Function: operator.__imatmul__ (a, b)

     ‘a = imatmul(a, b)’ is equivalent to ‘a @= b’.

     New in version 3.5.

 -- Function: operator.ior (a, b)
 -- Function: operator.__ior__ (a, b)

     ‘a = ior(a, b)’ is equivalent to ‘a |= b’.

 -- Function: operator.ipow (a, b)
 -- Function: operator.__ipow__ (a, b)

     ‘a = ipow(a, b)’ is equivalent to ‘a **= b’.

 -- Function: operator.irshift (a, b)
 -- Function: operator.__irshift__ (a, b)

     ‘a = irshift(a, b)’ is equivalent to ‘a >>= b’.

 -- Function: operator.isub (a, b)
 -- Function: operator.__isub__ (a, b)

     ‘a = isub(a, b)’ is equivalent to ‘a -= b’.

 -- Function: operator.itruediv (a, b)
 -- Function: operator.__itruediv__ (a, b)

     ‘a = itruediv(a, b)’ is equivalent to ‘a /= b’.

 -- Function: operator.ixor (a, b)
 -- Function: operator.__ixor__ (a, b)

     ‘a = ixor(a, b)’ is equivalent to ‘a ^= b’.


File: python.info,  Node: File and Directory Access,  Next: Data Persistence,  Prev: Functional Programming Modules,  Up: The Python Standard Library

5.11 File and Directory Access
==============================

The modules described in this chapter deal with disk files and
directories.  For example, there are modules for reading the properties
of files, manipulating paths in a portable way, and creating temporary
files.  The full list of modules in this chapter is:

* Menu:

* pathlib — Object-oriented filesystem paths::
* os.path — Common pathname manipulations: os path — Common pathname manipulations.
* fileinput — Iterate over lines from multiple input streams::
* stat — Interpreting stat() results: stat — Interpreting stat results.
* filecmp — File and Directory Comparisons::
* tempfile — Generate temporary files and directories::
* glob — Unix style pathname pattern expansion::
* fnmatch — Unix filename pattern matching::
* linecache — Random access to text lines::
* shutil — High-level file operations::


File: python.info,  Node: pathlib — Object-oriented filesystem paths,  Next: os path — Common pathname manipulations,  Up: File and Directory Access

5.11.1 ‘pathlib’ — Object-oriented filesystem paths
---------------------------------------------------

New in version 3.4.

`Source code:' Lib/pathlib.py(1)

__________________________________________________________________

This module offers classes representing filesystem paths with semantics
appropriate for different operating systems.  Path classes are divided
between *note pure paths: 1aeb, which provide purely computational
operations without I/O, and *note concrete paths: 1aec, which inherit
from pure paths but also provide I/O operations.

[python-figures/pathlib-inheritance]
If you’ve never used this module before or just aren’t sure which class
is right for your task, *note Path: 1ff. is most likely what you need.
It instantiates a *note concrete path: 1aec. for the platform the code
is running on.

Pure paths are useful in some special cases; for example:

  1. If you want to manipulate Windows paths on a Unix machine (or vice
     versa).  You cannot instantiate a *note WindowsPath: 1aed. when
     running on Unix, but you can instantiate *note PureWindowsPath:
     1aee.

  2. You want to make sure that your code only manipulates paths without
     actually accessing the OS. In this case, instantiating one of the
     pure classes may be useful since those simply don’t have any
     OS-accessing operations.

See also
........

PEP 428(2): The pathlib module – object-oriented filesystem paths.

See also
........

For low-level path manipulation on strings, you can also use the *note
os.path: c5. module.

* Menu:

* Basic use::
* Pure paths::
* Concrete paths::
* Correspondence to tools in the os module::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pathlib.py

   (2) https://www.python.org/dev/peps/pep-0428


File: python.info,  Node: Basic use,  Next: Pure paths,  Up: pathlib — Object-oriented filesystem paths

5.11.1.1 Basic use
..................

Importing the main class:

     >>> from pathlib import Path

Listing subdirectories:

     >>> p = Path('.')
     >>> [x for x in p.iterdir() if x.is_dir()]
     [PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
      PosixPath('__pycache__'), PosixPath('build')]

Listing Python source files in this directory tree:

     >>> list(p.glob('**/*.py'))
     [PosixPath('test_pathlib.py'), PosixPath('setup.py'),
      PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
      PosixPath('build/lib/pathlib.py')]

Navigating inside a directory tree:

     >>> p = Path('/etc')
     >>> q = p / 'init.d' / 'reboot'
     >>> q
     PosixPath('/etc/init.d/reboot')
     >>> q.resolve()
     PosixPath('/etc/rc.d/init.d/halt')

Querying path properties:

     >>> q.exists()
     True
     >>> q.is_dir()
     False

Opening a file:

     >>> with q.open() as f: f.readline()
     ...
     '#!/bin/bash\n'


File: python.info,  Node: Pure paths,  Next: Concrete paths,  Prev: Basic use,  Up: pathlib — Object-oriented filesystem paths

5.11.1.2 Pure paths
...................

Pure path objects provide path-handling operations which don’t actually
access a filesystem.  There are three ways to access these classes,
which we also call `flavours':

 -- Class: pathlib.PurePath (*pathsegments)

     A generic class that represents the system’s path flavour
     (instantiating it creates either a *note PurePosixPath: 1af1. or a
     *note PureWindowsPath: 1aee.):

          >>> PurePath('setup.py')      # Running on a Unix machine
          PurePosixPath('setup.py')

     Each element of `pathsegments' can be either a string representing
     a path segment, an object implementing the *note os.PathLike: 4e0.
     interface which returns a string, or another path object:

          >>> PurePath('foo', 'some/path', 'bar')
          PurePosixPath('foo/some/path/bar')
          >>> PurePath(Path('foo'), Path('bar'))
          PurePosixPath('foo/bar')

     When `pathsegments' is empty, the current directory is assumed:

          >>> PurePath()
          PurePosixPath('.')

     When several absolute paths are given, the last is taken as an
     anchor (mimicking *note os.path.join(): e8c.’s behaviour):

          >>> PurePath('/etc', '/usr', 'lib64')
          PurePosixPath('/usr/lib64')
          >>> PureWindowsPath('c:/Windows', 'd:bar')
          PureWindowsPath('d:bar')

     However, in a Windows path, changing the local root doesn’t discard
     the previous drive setting:

          >>> PureWindowsPath('c:/Windows', '/Program Files')
          PureWindowsPath('c:/Program Files')

     Spurious slashes and single dots are collapsed, but double dots
     (‘'..'’) are not, since this would change the meaning of a path in
     the face of symbolic links:

          >>> PurePath('foo//bar')
          PurePosixPath('foo/bar')
          >>> PurePath('foo/./bar')
          PurePosixPath('foo/bar')
          >>> PurePath('foo/../bar')
          PurePosixPath('foo/../bar')

     (a naïve approach would make ‘PurePosixPath('foo/../bar')’
     equivalent to ‘PurePosixPath('bar')’, which is wrong if ‘foo’ is a
     symbolic link to another directory)

     Pure path objects implement the *note os.PathLike: 4e0. interface,
     allowing them to be used anywhere the interface is accepted.

     Changed in version 3.6: Added support for the *note os.PathLike:
     4e0. interface.

 -- Class: pathlib.PurePosixPath (*pathsegments)

     A subclass of *note PurePath: f79, this path flavour represents
     non-Windows filesystem paths:

          >>> PurePosixPath('/etc')
          PurePosixPath('/etc')

     `pathsegments' is specified similarly to *note PurePath: f79.

 -- Class: pathlib.PureWindowsPath (*pathsegments)

     A subclass of *note PurePath: f79, this path flavour represents
     Windows filesystem paths:

          >>> PureWindowsPath('c:/Program Files/')
          PureWindowsPath('c:/Program Files')

     `pathsegments' is specified similarly to *note PurePath: f79.

Regardless of the system you’re running on, you can instantiate all of
these classes, since they don’t provide any operation that does system
calls.

* Menu:

* General properties::
* Operators: Operators<2>.
* Accessing individual parts::
* Methods and properties::


File: python.info,  Node: General properties,  Next: Operators<2>,  Up: Pure paths

5.11.1.3 General properties
...........................

Paths are immutable and hashable.  Paths of a same flavour are
comparable and orderable.  These properties respect the flavour’s
case-folding semantics:

     >>> PurePosixPath('foo') == PurePosixPath('FOO')
     False
     >>> PureWindowsPath('foo') == PureWindowsPath('FOO')
     True
     >>> PureWindowsPath('FOO') in { PureWindowsPath('foo') }
     True
     >>> PureWindowsPath('C:') < PureWindowsPath('d:')
     True

Paths of a different flavour compare unequal and cannot be ordered:

     >>> PureWindowsPath('foo') == PurePosixPath('foo')
     False
     >>> PureWindowsPath('foo') < PurePosixPath('foo')
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
     TypeError: '<' not supported between instances of 'PureWindowsPath' and 'PurePosixPath'


File: python.info,  Node: Operators<2>,  Next: Accessing individual parts,  Prev: General properties,  Up: Pure paths

5.11.1.4 Operators
..................

The slash operator helps create child paths, similarly to *note
os.path.join(): e8c.:

     >>> p = PurePath('/etc')
     >>> p
     PurePosixPath('/etc')
     >>> p / 'init.d' / 'apache2'
     PurePosixPath('/etc/init.d/apache2')
     >>> q = PurePath('bin')
     >>> '/usr' / q
     PurePosixPath('/usr/bin')

A path object can be used anywhere an object implementing *note
os.PathLike: 4e0. is accepted:

     >>> import os
     >>> p = PurePath('/etc')
     >>> os.fspath(p)
     '/etc'

The string representation of a path is the raw filesystem path itself
(in native form, e.g.  with backslashes under Windows), which you can
pass to any function taking a file path as a string:

     >>> p = PurePath('/etc')
     >>> str(p)
     '/etc'
     >>> p = PureWindowsPath('c:/Program Files')
     >>> str(p)
     'c:\\Program Files'

Similarly, calling *note bytes: 326. on a path gives the raw filesystem
path as a bytes object, as encoded by *note os.fsencode(): 4e4.:

     >>> bytes(p)
     b'/etc'

     Note: Calling *note bytes: 326. is only recommended under Unix.
     Under Windows, the unicode form is the canonical representation of
     filesystem paths.


File: python.info,  Node: Accessing individual parts,  Next: Methods and properties,  Prev: Operators<2>,  Up: Pure paths

5.11.1.5 Accessing individual parts
...................................

To access the individual “parts” (components) of a path, use the
following property:

 -- Data: PurePath.parts

     A tuple giving access to the path’s various components:

          >>> p = PurePath('/usr/bin/python3')
          >>> p.parts
          ('/', 'usr', 'bin', 'python3')

          >>> p = PureWindowsPath('c:/Program Files/PSF')
          >>> p.parts
          ('c:\\', 'Program Files', 'PSF')

     (note how the drive and local root are regrouped in a single part)


File: python.info,  Node: Methods and properties,  Prev: Accessing individual parts,  Up: Pure paths

5.11.1.6 Methods and properties
...............................

Pure paths provide the following methods and properties:

 -- Data: PurePath.drive

     A string representing the drive letter or name, if any:

          >>> PureWindowsPath('c:/Program Files/').drive
          'c:'
          >>> PureWindowsPath('/Program Files/').drive
          ''
          >>> PurePosixPath('/etc').drive
          ''

     UNC shares are also considered drives:

          >>> PureWindowsPath('//host/share/foo.txt').drive
          '\\\\host\\share'

 -- Data: PurePath.root

     A string representing the (local or global) root, if any:

          >>> PureWindowsPath('c:/Program Files/').root
          '\\'
          >>> PureWindowsPath('c:Program Files/').root
          ''
          >>> PurePosixPath('/etc').root
          '/'

     UNC shares always have a root:

          >>> PureWindowsPath('//host/share').root
          '\\'

 -- Data: PurePath.anchor

     The concatenation of the drive and root:

          >>> PureWindowsPath('c:/Program Files/').anchor
          'c:\\'
          >>> PureWindowsPath('c:Program Files/').anchor
          'c:'
          >>> PurePosixPath('/etc').anchor
          '/'
          >>> PureWindowsPath('//host/share').anchor
          '\\\\host\\share\\'

 -- Data: PurePath.parents

     An immutable sequence providing access to the logical ancestors of
     the path:

          >>> p = PureWindowsPath('c:/foo/bar/setup.py')
          >>> p.parents[0]
          PureWindowsPath('c:/foo/bar')
          >>> p.parents[1]
          PureWindowsPath('c:/foo')
          >>> p.parents[2]
          PureWindowsPath('c:/')

 -- Data: PurePath.parent

     The logical parent of the path:

          >>> p = PurePosixPath('/a/b/c/d')
          >>> p.parent
          PurePosixPath('/a/b/c')

     You cannot go past an anchor, or empty path:

          >>> p = PurePosixPath('/')
          >>> p.parent
          PurePosixPath('/')
          >>> p = PurePosixPath('.')
          >>> p.parent
          PurePosixPath('.')

          Note: This is a purely lexical operation, hence the following
          behaviour:

               >>> p = PurePosixPath('foo/..')
               >>> p.parent
               PurePosixPath('foo')

          If you want to walk an arbitrary filesystem path upwards, it
          is recommended to first call *note Path.resolve(): 1afc. so as
          to resolve symlinks and eliminate ‘“..”’ components.

 -- Data: PurePath.name

     A string representing the final path component, excluding the drive
     and root, if any:

          >>> PurePosixPath('my/library/setup.py').name
          'setup.py'

     UNC drive names are not considered:

          >>> PureWindowsPath('//some/share/setup.py').name
          'setup.py'
          >>> PureWindowsPath('//some/share').name
          ''

 -- Data: PurePath.suffix

     The file extension of the final component, if any:

          >>> PurePosixPath('my/library/setup.py').suffix
          '.py'
          >>> PurePosixPath('my/library.tar.gz').suffix
          '.gz'
          >>> PurePosixPath('my/library').suffix
          ''

 -- Data: PurePath.suffixes

     A list of the path’s file extensions:

          >>> PurePosixPath('my/library.tar.gar').suffixes
          ['.tar', '.gar']
          >>> PurePosixPath('my/library.tar.gz').suffixes
          ['.tar', '.gz']
          >>> PurePosixPath('my/library').suffixes
          []

 -- Data: PurePath.stem

     The final path component, without its suffix:

          >>> PurePosixPath('my/library.tar.gz').stem
          'library.tar'
          >>> PurePosixPath('my/library.tar').stem
          'library'
          >>> PurePosixPath('my/library').stem
          'library'

 -- Method: PurePath.as_posix ()

     Return a string representation of the path with forward slashes
     (‘/’):

          >>> p = PureWindowsPath('c:\\windows')
          >>> str(p)
          'c:\\windows'
          >>> p.as_posix()
          'c:/windows'

 -- Method: PurePath.as_uri ()

     Represent the path as a ‘file’ URI. *note ValueError: 1f9. is
     raised if the path isn’t absolute.

          >>> p = PurePosixPath('/etc/passwd')
          >>> p.as_uri()
          'file:///etc/passwd'
          >>> p = PureWindowsPath('c:/Windows')
          >>> p.as_uri()
          'file:///c:/Windows'

 -- Method: PurePath.is_absolute ()

     Return whether the path is absolute or not.  A path is considered
     absolute if it has both a root and (if the flavour allows) a drive:

          >>> PurePosixPath('/a/b').is_absolute()
          True
          >>> PurePosixPath('a/b').is_absolute()
          False

          >>> PureWindowsPath('c:/a/b').is_absolute()
          True
          >>> PureWindowsPath('/a/b').is_absolute()
          False
          >>> PureWindowsPath('c:').is_absolute()
          False
          >>> PureWindowsPath('//some/share').is_absolute()
          True

 -- Method: PurePath.is_reserved ()

     With *note PureWindowsPath: 1aee, return ‘True’ if the path is
     considered reserved under Windows, ‘False’ otherwise.  With *note
     PurePosixPath: 1af1, ‘False’ is always returned.

          >>> PureWindowsPath('nul').is_reserved()
          True
          >>> PurePosixPath('nul').is_reserved()
          False

     File system calls on reserved paths can fail mysteriously or have
     unintended effects.

 -- Method: PurePath.joinpath (*other)

     Calling this method is equivalent to combining the path with each
     of the `other' arguments in turn:

          >>> PurePosixPath('/etc').joinpath('passwd')
          PurePosixPath('/etc/passwd')
          >>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd'))
          PurePosixPath('/etc/passwd')
          >>> PurePosixPath('/etc').joinpath('init.d', 'apache2')
          PurePosixPath('/etc/init.d/apache2')
          >>> PureWindowsPath('c:').joinpath('/Program Files')
          PureWindowsPath('c:/Program Files')

 -- Method: PurePath.match (pattern)

     Match this path against the provided glob-style pattern.  Return
     ‘True’ if matching is successful, ‘False’ otherwise.

     If `pattern' is relative, the path can be either relative or
     absolute, and matching is done from the right:

          >>> PurePath('a/b.py').match('*.py')
          True
          >>> PurePath('/a/b/c.py').match('b/*.py')
          True
          >>> PurePath('/a/b/c.py').match('a/*.py')
          False

     If `pattern' is absolute, the path must be absolute, and the whole
     path must match:

          >>> PurePath('/a.py').match('/*.py')
          True
          >>> PurePath('a/b.py').match('/*.py')
          False

     As with other methods, case-sensitivity is observed:

          >>> PureWindowsPath('b.py').match('*.PY')
          True

 -- Method: PurePath.relative_to (*other)

     Compute a version of this path relative to the path represented by
     `other'.  If it’s impossible, ValueError is raised:

          >>> p = PurePosixPath('/etc/passwd')
          >>> p.relative_to('/')
          PurePosixPath('etc/passwd')
          >>> p.relative_to('/etc')
          PurePosixPath('passwd')
          >>> p.relative_to('/usr')
          Traceback (most recent call last):
            File "<stdin>", line 1, in <module>
            File "pathlib.py", line 694, in relative_to
              .format(str(self), str(formatted)))
          ValueError: '/etc/passwd' does not start with '/usr'

 -- Method: PurePath.with_name (name)

     Return a new path with the *note name: 1afd. changed.  If the
     original path doesn’t have a name, ValueError is raised:

          >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
          >>> p.with_name('setup.py')
          PureWindowsPath('c:/Downloads/setup.py')
          >>> p = PureWindowsPath('c:/')
          >>> p.with_name('setup.py')
          Traceback (most recent call last):
            File "<stdin>", line 1, in <module>
            File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name
              raise ValueError("%r has an empty name" % (self,))
          ValueError: PureWindowsPath('c:/') has an empty name

 -- Method: PurePath.with_suffix (suffix)

     Return a new path with the *note suffix: 1afe. changed.  If the
     original path doesn’t have a suffix, the new `suffix' is appended
     instead.  If the `suffix' is an empty string, the original suffix
     is removed:

          >>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
          >>> p.with_suffix('.bz2')
          PureWindowsPath('c:/Downloads/pathlib.tar.bz2')
          >>> p = PureWindowsPath('README')
          >>> p.with_suffix('.txt')
          PureWindowsPath('README.txt')
          >>> p = PureWindowsPath('README.txt')
          >>> p.with_suffix('')
          PureWindowsPath('README')


File: python.info,  Node: Concrete paths,  Next: Correspondence to tools in the os module,  Prev: Pure paths,  Up: pathlib — Object-oriented filesystem paths

5.11.1.7 Concrete paths
.......................

Concrete paths are subclasses of the pure path classes.  In addition to
operations provided by the latter, they also provide methods to do
system calls on path objects.  There are three ways to instantiate
concrete paths:

 -- Class: pathlib.Path (*pathsegments)

     A subclass of *note PurePath: f79, this class represents concrete
     paths of the system’s path flavour (instantiating it creates either
     a *note PosixPath: 1b0a. or a *note WindowsPath: 1aed.):

          >>> Path('setup.py')
          PosixPath('setup.py')

     `pathsegments' is specified similarly to *note PurePath: f79.

 -- Class: pathlib.PosixPath (*pathsegments)

     A subclass of *note Path: 1ff. and *note PurePosixPath: 1af1, this
     class represents concrete non-Windows filesystem paths:

          >>> PosixPath('/etc')
          PosixPath('/etc')

     `pathsegments' is specified similarly to *note PurePath: f79.

 -- Class: pathlib.WindowsPath (*pathsegments)

     A subclass of *note Path: 1ff. and *note PureWindowsPath: 1aee,
     this class represents concrete Windows filesystem paths:

          >>> WindowsPath('c:/Program Files/')
          WindowsPath('c:/Program Files')

     `pathsegments' is specified similarly to *note PurePath: f79.

You can only instantiate the class flavour that corresponds to your
system (allowing system calls on non-compatible path flavours could lead
to bugs or failures in your application):

     >>> import os
     >>> os.name
     'posix'
     >>> Path('setup.py')
     PosixPath('setup.py')
     >>> PosixPath('setup.py')
     PosixPath('setup.py')
     >>> WindowsPath('setup.py')
     Traceback (most recent call last):
       File "<stdin>", line 1, in <module>
       File "pathlib.py", line 798, in __new__
         % (cls.__name__,))
     NotImplementedError: cannot instantiate 'WindowsPath' on your system

* Menu:

* Methods: Methods<2>.


File: python.info,  Node: Methods<2>,  Up: Concrete paths

5.11.1.8 Methods
................

Concrete paths provide the following methods in addition to pure paths
methods.  Many of these methods can raise an *note OSError: 1d1. if a
system call fails (for example because the path doesn’t exist).

Changed in version 3.8: *note exists(): 200, *note is_dir(): 201, *note
is_file(): 202, *note is_mount(): 203, *note is_symlink(): 204, *note
is_block_device(): 205, *note is_char_device(): 206, *note is_fifo():
207, *note is_socket(): 208. now return ‘False’ instead of raising an
exception for paths that contain characters unrepresentable at the OS
level.

 -- Class Method: Path.cwd ()

     Return a new path object representing the current directory (as
     returned by *note os.getcwd(): f11.):

          >>> Path.cwd()
          PosixPath('/home/antoine/pathlib')

 -- Class Method: Path.home ()

     Return a new path object representing the user’s home directory (as
     returned by *note os.path.expanduser(): 1fc. with ‘~’ construct):

          >>> Path.home()
          PosixPath('/home/antoine')

     New in version 3.5.

 -- Method: Path.stat ()

     Return information about this path (similarly to *note os.stat():
     1ef.).  The result is looked up at each call to this method.

          >>> p = Path('setup.py')
          >>> p.stat().st_size
          956
          >>> p.stat().st_mtime
          1327883547.852554

 -- Method: Path.chmod (mode)

     Change the file mode and permissions, like *note os.chmod(): a28.:

          >>> p = Path('setup.py')
          >>> p.stat().st_mode
          33277
          >>> p.chmod(0o444)
          >>> p.stat().st_mode
          33060

 -- Method: Path.exists ()

     Whether the path points to an existing file or directory:

          >>> Path('.').exists()
          True
          >>> Path('setup.py').exists()
          True
          >>> Path('/etc').exists()
          True
          >>> Path('nonexistentfile').exists()
          False

          Note: If the path points to a symlink, *note exists(): 200.
          returns whether the symlink `points to' an existing file or
          directory.

 -- Method: Path.expanduser ()

     Return a new path with expanded ‘~’ and ‘~user’ constructs, as
     returned by *note os.path.expanduser(): 1fc.:

          >>> p = PosixPath('~/films/Monty Python')
          >>> p.expanduser()
          PosixPath('/home/eric/films/Monty Python')

     New in version 3.5.

 -- Method: Path.glob (pattern)

     Glob the given relative `pattern' in the directory represented by
     this path, yielding all matching files (of any kind):

          >>> sorted(Path('.').glob('*.py'))
          [PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
          >>> sorted(Path('.').glob('*/*.py'))
          [PosixPath('docs/conf.py')]

     The “‘**’” pattern means “this directory and all subdirectories,
     recursively”.  In other words, it enables recursive globbing:

          >>> sorted(Path('.').glob('**/*.py'))
          [PosixPath('build/lib/pathlib.py'),
           PosixPath('docs/conf.py'),
           PosixPath('pathlib.py'),
           PosixPath('setup.py'),
           PosixPath('test_pathlib.py')]

          Note: Using the “‘**’” pattern in large directory trees may
          consume an inordinate amount of time.

 -- Method: Path.group ()

     Return the name of the group owning the file.  *note KeyError: 2c5.
     is raised if the file’s gid isn’t found in the system database.

 -- Method: Path.is_dir ()

     Return ‘True’ if the path points to a directory (or a symbolic link
     pointing to a directory), ‘False’ if it points to another kind of
     file.

     ‘False’ is also returned if the path doesn’t exist or is a broken
     symlink; other errors (such as permission errors) are propagated.

 -- Method: Path.is_file ()

     Return ‘True’ if the path points to a regular file (or a symbolic
     link pointing to a regular file), ‘False’ if it points to another
     kind of file.

     ‘False’ is also returned if the path doesn’t exist or is a broken
     symlink; other errors (such as permission errors) are propagated.

 -- Method: Path.is_mount ()

     Return ‘True’ if the path is a `mount point': a point in a file
     system where a different file system has been mounted.  On POSIX,
     the function checks whether `path'’s parent, ‘path/..’, is on a
     different device than `path', or whether ‘path/..’ and `path' point
     to the same i-node on the same device — this should detect mount
     points for all Unix and POSIX variants.  Not implemented on
     Windows.

     New in version 3.7.

 -- Method: Path.is_symlink ()

     Return ‘True’ if the path points to a symbolic link, ‘False’
     otherwise.

     ‘False’ is also returned if the path doesn’t exist; other errors
     (such as permission errors) are propagated.

 -- Method: Path.is_socket ()

     Return ‘True’ if the path points to a Unix socket (or a symbolic
     link pointing to a Unix socket), ‘False’ if it points to another
     kind of file.

     ‘False’ is also returned if the path doesn’t exist or is a broken
     symlink; other errors (such as permission errors) are propagated.

 -- Method: Path.is_fifo ()

     Return ‘True’ if the path points to a FIFO (or a symbolic link
     pointing to a FIFO), ‘False’ if it points to another kind of file.

     ‘False’ is also returned if the path doesn’t exist or is a broken
     symlink; other errors (such as permission errors) are propagated.

 -- Method: Path.is_block_device ()

     Return ‘True’ if the path points to a block device (or a symbolic
     link pointing to a block device), ‘False’ if it points to another
     kind of file.

     ‘False’ is also returned if the path doesn’t exist or is a broken
     symlink; other errors (such as permission errors) are propagated.

 -- Method: Path.is_char_device ()

     Return ‘True’ if the path points to a character device (or a
     symbolic link pointing to a character device), ‘False’ if it points
     to another kind of file.

     ‘False’ is also returned if the path doesn’t exist or is a broken
     symlink; other errors (such as permission errors) are propagated.

 -- Method: Path.iterdir ()

     When the path points to a directory, yield path objects of the
     directory contents:

          >>> p = Path('docs')
          >>> for child in p.iterdir(): child
          ...
          PosixPath('docs/conf.py')
          PosixPath('docs/_templates')
          PosixPath('docs/make.bat')
          PosixPath('docs/index.rst')
          PosixPath('docs/_build')
          PosixPath('docs/_static')
          PosixPath('docs/Makefile')

 -- Method: Path.lchmod (mode)

     Like *note Path.chmod(): 1b0e. but, if the path points to a
     symbolic link, the symbolic link’s mode is changed rather than its
     target’s.

 -- Method: Path.lstat ()

     Like *note Path.stat(): 1b0d. but, if the path points to a symbolic
     link, return the symbolic link’s information rather than its
     target’s.

 -- Method: Path.mkdir (mode=0o777, parents=False, exist_ok=False)

     Create a new directory at this given path.  If `mode' is given, it
     is combined with the process’ ‘umask’ value to determine the file
     mode and access flags.  If the path already exists, *note
     FileExistsError: 94c. is raised.

     If `parents' is true, any missing parents of this path are created
     as needed; they are created with the default permissions without
     taking `mode' into account (mimicking the POSIX ‘mkdir -p’
     command).

     If `parents' is false (the default), a missing parent raises *note
     FileNotFoundError: 7b4.

     If `exist_ok' is false (the default), *note FileExistsError: 94c.
     is raised if the target directory already exists.

     If `exist_ok' is true, *note FileExistsError: 94c. exceptions will
     be ignored (same behavior as the POSIX ‘mkdir -p’ command), but
     only if the last path component is not an existing non-directory
     file.

     Changed in version 3.5: The `exist_ok' parameter was added.

 -- Method: Path.open (mode='r', buffering=-1, encoding=None,
          errors=None, newline=None)

     Open the file pointed to by the path, like the built-in *note
     open(): 4e5. function does:

          >>> p = Path('setup.py')
          >>> with p.open() as f:
          ...     f.readline()
          ...
          '#!/usr/bin/env python3\n'

 -- Method: Path.owner ()

     Return the name of the user owning the file.  *note KeyError: 2c5.
     is raised if the file’s uid isn’t found in the system database.

 -- Method: Path.read_bytes ()

     Return the binary contents of the pointed-to file as a bytes
     object:

          >>> p = Path('my_binary_file')
          >>> p.write_bytes(b'Binary file contents')
          20
          >>> p.read_bytes()
          b'Binary file contents'

     New in version 3.5.

 -- Method: Path.read_text (encoding=None, errors=None)

     Return the decoded contents of the pointed-to file as a string:

          >>> p = Path('my_text_file')
          >>> p.write_text('Text file contents')
          18
          >>> p.read_text()
          'Text file contents'

     The file is opened and then closed.  The optional parameters have
     the same meaning as in *note open(): 4e5.

     New in version 3.5.

 -- Method: Path.rename (target)

     Rename this file or directory to the given `target', and return a
     new Path instance pointing to `target'.  On Unix, if `target'
     exists and is a file, it will be replaced silently if the user has
     permission.  `target' can be either a string or another path
     object:

          >>> p = Path('foo')
          >>> p.open('w').write('some text')
          9
          >>> target = Path('bar')
          >>> p.rename(target)
          PosixPath('bar')
          >>> target.open().read()
          'some text'

     Changed in version 3.8: Added return value, return the new Path
     instance.

 -- Method: Path.replace (target)

     Rename this file or directory to the given `target', and return a
     new Path instance pointing to `target'.  If `target' points to an
     existing file or directory, it will be unconditionally replaced.

     Changed in version 3.8: Added return value, return the new Path
     instance.

 -- Method: Path.resolve (strict=False)

     Make the path absolute, resolving any symlinks.  A new path object
     is returned:

          >>> p = Path()
          >>> p
          PosixPath('.')
          >>> p.resolve()
          PosixPath('/home/antoine/pathlib')

     “‘..’” components are also eliminated (this is the only method to
     do so):

          >>> p = Path('docs/../setup.py')
          >>> p.resolve()
          PosixPath('/home/antoine/pathlib/setup.py')

     If the path doesn’t exist and `strict' is ‘True’, *note
     FileNotFoundError: 7b4. is raised.  If `strict' is ‘False’, the
     path is resolved as far as possible and any remainder is appended
     without checking whether it exists.  If an infinite loop is
     encountered along the resolution path, *note RuntimeError: 2b8. is
     raised.

     New in version 3.6: The `strict' argument (pre-3.6 behavior is
     strict).

 -- Method: Path.rglob (pattern)

     This is like calling *note Path.glob(): 1b0f. with “‘**/’” added in
     front of the given relative `pattern':

          >>> sorted(Path().rglob("*.py"))
          [PosixPath('build/lib/pathlib.py'),
           PosixPath('docs/conf.py'),
           PosixPath('pathlib.py'),
           PosixPath('setup.py'),
           PosixPath('test_pathlib.py')]

 -- Method: Path.rmdir ()

     Remove this directory.  The directory must be empty.

 -- Method: Path.samefile (other_path)

     Return whether this path points to the same file as `other_path',
     which can be either a Path object, or a string.  The semantics are
     similar to *note os.path.samefile(): 876. and *note
     os.path.samestat(): 875.

     An *note OSError: 1d1. can be raised if either file cannot be
     accessed for some reason.

          >>> p = Path('spam')
          >>> q = Path('eggs')
          >>> p.samefile(q)
          False
          >>> p.samefile('spam')
          True

     New in version 3.5.

 -- Method: Path.symlink_to (target, target_is_directory=False)

     Make this path a symbolic link to `target'.  Under Windows,
     `target_is_directory' must be true (default ‘False’) if the link’s
     target is a directory.  Under POSIX, `target_is_directory'’s value
     is ignored.

          >>> p = Path('mylink')
          >>> p.symlink_to('setup.py')
          >>> p.resolve()
          PosixPath('/home/antoine/pathlib/setup.py')
          >>> p.stat().st_size
          956
          >>> p.lstat().st_size
          8

          Note: The order of arguments (link, target) is the reverse of
          *note os.symlink(): a30.’s.

 -- Method: Path.touch (mode=0o666, exist_ok=True)

     Create a file at this given path.  If `mode' is given, it is
     combined with the process’ ‘umask’ value to determine the file mode
     and access flags.  If the file already exists, the function
     succeeds if `exist_ok' is true (and its modification time is
     updated to the current time), otherwise *note FileExistsError: 94c.
     is raised.

 -- Method: Path.unlink (missing_ok=False)

     Remove this file or symbolic link.  If the path points to a
     directory, use *note Path.rmdir(): 1b19. instead.

     If `missing_ok' is false (the default), *note FileNotFoundError:
     7b4. is raised if the path does not exist.

     If `missing_ok' is true, *note FileNotFoundError: 7b4. exceptions
     will be ignored (same behavior as the POSIX ‘rm -f’ command).

     Changed in version 3.8: The `missing_ok' parameter was added.

 -- Method: Path.link_to (target)

     Create a hard link pointing to a path named `target'.

     Changed in version 3.8.

 -- Method: Path.write_bytes (data)

     Open the file pointed to in bytes mode, write `data' to it, and
     close the file:

          >>> p = Path('my_binary_file')
          >>> p.write_bytes(b'Binary file contents')
          20
          >>> p.read_bytes()
          b'Binary file contents'

     An existing file of the same name is overwritten.

     New in version 3.5.

 -- Method: Path.write_text (data, encoding=None, errors=None)

     Open the file pointed to in text mode, write `data' to it, and
     close the file:

          >>> p = Path('my_text_file')
          >>> p.write_text('Text file contents')
          18
          >>> p.read_text()
          'Text file contents'

     An existing file of the same name is overwritten.  The optional
     parameters have the same meaning as in *note open(): 4e5.

     New in version 3.5.


File: python.info,  Node: Correspondence to tools in the os module,  Prev: Concrete paths,  Up: pathlib — Object-oriented filesystem paths

5.11.1.9 Correspondence to tools in the ‘os’ module
...................................................

Below is a table mapping various *note os: c4. functions to their
corresponding *note PurePath: f79./*note Path: 1ff. equivalent.

     Note: Although *note os.path.relpath(): 1b1d. and *note
     PurePath.relative_to(): 1b07. have some overlapping use-cases,
     their semantics differ enough to warrant not considering them
     equivalent.

os and os.path                           pathlib
                                         
----------------------------------------------------------------------------
                                         
*note os.path.abspath(): ca3.            *note Path.resolve(): 1afc.
                                         
                                         
*note os.chmod(): a28.                   *note Path.chmod(): 1b0e.
                                         
                                         
*note os.mkdir(): a2b.                   *note Path.mkdir(): 71d.
                                         
                                         
*note os.rename(): a2d.                  *note Path.rename(): 1b16.
                                         
                                         
*note os.replace(): a2e.                 *note Path.replace(): 1b17.
                                         
                                         
*note os.rmdir(): a2f.                   *note Path.rmdir(): 1b19.
                                         
                                         
*note os.remove(): a2c,                  *note Path.unlink(): f00.
*note os.unlink(): a31.                  

*note os.getcwd(): f11.                  *note Path.cwd(): 1b0c.
                                         
                                         
*note os.path.exists(): 1f4.             *note Path.exists(): 200.
                                         
                                         
*note os.path.expanduser(): 1fc.         *note Path.expanduser(): 71e.
                                         and *note Path.home(): 71f.
                                         
                                         
*note os.path.isdir(): 1f6.              *note Path.is_dir(): 201.
                                         
                                         
*note os.path.isfile(): 1f7.             *note Path.is_file(): 202.
                                         
                                         
*note os.path.islink(): 1f2.             *note Path.is_symlink(): 204.
                                         
                                         
*note os.stat(): 1ef.                    *note Path.stat(): 1b0d,
                                         *note Path.owner(): 1b15,
                                         *note Path.group(): 1b10.
                                         
                                         
*note os.path.isabs(): 1b1e.             *note PurePath.is_absolute(): 1b03.
                                         
                                         
*note os.path.join(): e8c.               *note PurePath.joinpath(): 1b05.
                                         
                                         
*note os.path.basename(): 1b1f.          *note PurePath.name: 1afd.
                                         
                                         
*note os.path.dirname(): 1b20.           *note PurePath.parent: 1afb.
                                         
                                         
*note os.path.samefile(): 876.           *note Path.samefile(): 71c.
                                         
                                         
*note os.path.splitext(): 1b21.          *note PurePath.suffix: 1afe.
                                         


File: python.info,  Node: os path — Common pathname manipulations,  Next: fileinput — Iterate over lines from multiple input streams,  Prev: pathlib — Object-oriented filesystem paths,  Up: File and Directory Access

5.11.2 ‘os.path’ — Common pathname manipulations
------------------------------------------------

`Source code:' Lib/posixpath.py(1) (for POSIX) and Lib/ntpath.py(2) (for
Windows NT).

__________________________________________________________________

This module implements some useful functions on pathnames.  To read or
write files see *note open(): 4e5, and for accessing the filesystem see
the *note os: c4. module.  The path parameters can be passed as either
strings, or bytes.  Applications are encouraged to represent file names
as (Unicode) character strings.  Unfortunately, some file names may not
be representable as strings on Unix, so applications that need to
support arbitrary file names on Unix should use bytes objects to
represent path names.  Vice versa, using bytes objects cannot represent
all file names on Windows (in the standard ‘mbcs’ encoding), hence
Windows applications should use string objects to access all files.

Unlike a unix shell, Python does not do any `automatic' path expansions.
Functions such as *note expanduser(): 1fc. and *note expandvars(): d37.
can be invoked explicitly when an application desires shell-like path
expansion.  (See also the *note glob: 8a. module.)

See also
........

The *note pathlib: c8. module offers high-level path objects.

     Note: All of these functions accept either only bytes or only
     string objects as their parameters.  The result is an object of the
     same type, if a path or file name is returned.

     Note: Since different operating systems have different path name
     conventions, there are several versions of this module in the
     standard library.  The *note os.path: c5. module is always the path
     module suitable for the operating system Python is running on, and
     therefore usable for local paths.  However, you can also import and
     use the individual modules if you want to manipulate a path that is
     `always' in one of the different formats.  They all have the same
     interface:

        * ‘posixpath’ for UNIX-style paths

        * ‘ntpath’ for Windows paths

Changed in version 3.8: *note exists(): 1f4, *note lexists(): 1f5, *note
isdir(): 1f6, *note isfile(): 1f7, *note islink(): 1f2, and *note
ismount(): 1f8. now return ‘False’ instead of raising an exception for
paths that contain characters or bytes unrepresentable at the OS level.

 -- Function: os.path.abspath (path)

     Return a normalized absolutized version of the pathname `path'.  On
     most platforms, this is equivalent to calling the function *note
     normpath(): ca2. as follows: ‘normpath(join(os.getcwd(), path))’.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.basename (path)

     Return the base name of pathname `path'.  This is the second
     element of the pair returned by passing `path' to the function
     *note split(): 1b24.  Note that the result of this function is
     different from the Unix ‘basename’ program; where ‘basename’ for
     ‘'/foo/bar/'’ returns ‘'bar'’, the *note basename(): 1b1f. function
     returns an empty string (‘''’).

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.commonpath (paths)

     Return the longest common sub-path of each pathname in the sequence
     `paths'.  Raise *note ValueError: 1f9. if `paths' contain both
     absolute and relative pathnames, the `paths' are on the different
     drives or if `paths' is empty.  Unlike *note commonprefix(): 71a,
     this returns a valid path.

     *note Availability: 129a.: Unix, Windows.

     New in version 3.5.

     Changed in version 3.6: Accepts a sequence of *note path-like
     objects: 35f.

 -- Function: os.path.commonprefix (list)

     Return the longest path prefix (taken character-by-character) that
     is a prefix of all paths in `list'.  If `list' is empty, return the
     empty string (‘''’).

          Note: This function may return invalid paths because it works
          a character at a time.  To obtain a valid path, see *note
          commonpath(): 719.

               >>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
               '/usr/l'

               >>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
               '/usr'

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.dirname (path)

     Return the directory name of pathname `path'.  This is the first
     element of the pair returned by passing `path' to the function
     *note split(): 1b24.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.exists (path)

     Return ‘True’ if `path' refers to an existing path or an open file
     descriptor.  Returns ‘False’ for broken symbolic links.  On some
     platforms, this function may return ‘False’ if permission is not
     granted to execute *note os.stat(): 1ef. on the requested file,
     even if the `path' physically exists.

     Changed in version 3.3: `path' can now be an integer: ‘True’ is
     returned if it is an open file descriptor, ‘False’ otherwise.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.lexists (path)

     Return ‘True’ if `path' refers to an existing path.  Returns ‘True’
     for broken symbolic links.  Equivalent to *note exists(): 1f4. on
     platforms lacking *note os.lstat(): 1f0.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.expanduser (path)

     On Unix and Windows, return the argument with an initial component
     of ‘~’ or ‘~user’ replaced by that `user'’s home directory.

     On Unix, an initial ‘~’ is replaced by the environment variable
     ‘HOME’ if it is set; otherwise the current user’s home directory is
     looked up in the password directory through the built-in module
     *note pwd: d6.  An initial ‘~user’ is looked up directly in the
     password directory.

     On Windows, ‘USERPROFILE’ will be used if set, otherwise a
     combination of ‘HOMEPATH’ and ‘HOMEDRIVE’ will be used.  An initial
     ‘~user’ is handled by stripping the last directory component from
     the created user path derived above.

     If the expansion fails or if the path does not begin with a tilde,
     the path is returned unchanged.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

     Changed in version 3.8: No longer uses ‘HOME’ on Windows.

 -- Function: os.path.expandvars (path)

     Return the argument with environment variables expanded.
     Substrings of the form ‘$name’ or ‘${name}’ are replaced by the
     value of environment variable `name'.  Malformed variable names and
     references to non-existing variables are left unchanged.

     On Windows, ‘%name%’ expansions are supported in addition to
     ‘$name’ and ‘${name}’.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.getatime (path)

     Return the time of last access of `path'.  The return value is a
     floating point number giving the number of seconds since the epoch
     (see the *note time: 10a. module).  Raise *note OSError: 1d1. if
     the file does not exist or is inaccessible.

 -- Function: os.path.getmtime (path)

     Return the time of last modification of `path'.  The return value
     is a floating point number giving the number of seconds since the
     epoch (see the *note time: 10a. module).  Raise *note OSError: 1d1.
     if the file does not exist or is inaccessible.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.getctime (path)

     Return the system’s ctime which, on some systems (like Unix) is the
     time of the last metadata change, and, on others (like Windows), is
     the creation time for `path'.  The return value is a number giving
     the number of seconds since the epoch (see the *note time: 10a.
     module).  Raise *note OSError: 1d1. if the file does not exist or
     is inaccessible.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.getsize (path)

     Return the size, in bytes, of `path'.  Raise *note OSError: 1d1. if
     the file does not exist or is inaccessible.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.isabs (path)

     Return ‘True’ if `path' is an absolute pathname.  On Unix, that
     means it begins with a slash, on Windows that it begins with a
     (back)slash after chopping off a potential drive letter.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.isfile (path)

     Return ‘True’ if `path' is an *note existing: 1f4. regular file.
     This follows symbolic links, so both *note islink(): 1f2. and *note
     isfile(): 1f7. can be true for the same path.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.isdir (path)

     Return ‘True’ if `path' is an *note existing: 1f4. directory.  This
     follows symbolic links, so both *note islink(): 1f2. and *note
     isdir(): 1f6. can be true for the same path.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.islink (path)

     Return ‘True’ if `path' refers to an *note existing: 1f4. directory
     entry that is a symbolic link.  Always ‘False’ if symbolic links
     are not supported by the Python runtime.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.ismount (path)

     Return ‘True’ if pathname `path' is a `mount point': a point in a
     file system where a different file system has been mounted.  On
     POSIX, the function checks whether `path'’s parent, ‘`path'/..’, is
     on a different device than `path', or whether ‘`path'/..’ and
     `path' point to the same i-node on the same device — this should
     detect mount points for all Unix and POSIX variants.  It is not
     able to reliably detect bind mounts on the same filesystem.  On
     Windows, a drive letter root and a share UNC are always mount
     points, and for any other path ‘GetVolumePathName’ is called to see
     if it is different from the input path.

     New in version 3.4: Support for detecting non-root mount points on
     Windows.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.join (path, *paths)

     Join one or more path components intelligently.  The return value
     is the concatenation of `path' and any members of `*paths' with
     exactly one directory separator (‘os.sep’) following each non-empty
     part except the last, meaning that the result will only end in a
     separator if the last part is empty.  If a component is an absolute
     path, all previous components are thrown away and joining continues
     from the absolute path component.

     On Windows, the drive letter is not reset when an absolute path
     component (e.g., ‘r'\foo'’) is encountered.  If a component
     contains a drive letter, all previous components are thrown away
     and the drive letter is reset.  Note that since there is a current
     directory for each drive, ‘os.path.join("c:", "foo")’ represents a
     path relative to the current directory on drive ‘C:’ (‘c:foo’), not
     ‘c:\foo’.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `path' and `paths'.

 -- Function: os.path.normcase (path)

     Normalize the case of a pathname.  On Windows, convert all
     characters in the pathname to lowercase, and also convert forward
     slashes to backward slashes.  On other operating systems, return
     the path unchanged.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.normpath (path)

     Normalize a pathname by collapsing redundant separators and
     up-level references so that ‘A//B’, ‘A/B/’, ‘A/./B’ and
     ‘A/foo/../B’ all become ‘A/B’.  This string manipulation may change
     the meaning of a path that contains symbolic links.  On Windows, it
     converts forward slashes to backward slashes.  To normalize case,
     use *note normcase(): 1b29.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.realpath (path)

     Return the canonical path of the specified filename, eliminating
     any symbolic links encountered in the path (if they are supported
     by the operating system).

          Note: When symbolic link cycles occur, the returned path will
          be one member of the cycle, but no guarantee is made about
          which member that will be.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

     Changed in version 3.8: Symbolic links and junctions are now
     resolved on Windows.

 -- Function: os.path.relpath (path, start=os.curdir)

     Return a relative filepath to `path' either from the current
     directory or from an optional `start' directory.  This is a path
     computation: the filesystem is not accessed to confirm the
     existence or nature of `path' or `start'.

     `start' defaults to *note os.curdir: 1b2a.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.samefile (path1, path2)

     Return ‘True’ if both pathname arguments refer to the same file or
     directory.  This is determined by the device number and i-node
     number and raises an exception if an *note os.stat(): 1ef. call on
     either pathname fails.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.2: Added Windows support.

     Changed in version 3.4: Windows now uses the same implementation as
     all other platforms.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.sameopenfile (fp1, fp2)

     Return ‘True’ if the file descriptors `fp1' and `fp2' refer to the
     same file.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.2: Added Windows support.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.samestat (stat1, stat2)

     Return ‘True’ if the stat tuples `stat1' and `stat2' refer to the
     same file.  These structures may have been returned by *note
     os.fstat(): 653, *note os.lstat(): 1f0, or *note os.stat(): 1ef.
     This function implements the underlying comparison used by *note
     samefile(): 876. and *note sameopenfile(): 1b2b.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.4: Added Windows support.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.split (path)

     Split the pathname `path' into a pair, ‘(head, tail)’ where `tail'
     is the last pathname component and `head' is everything leading up
     to that.  The `tail' part will never contain a slash; if `path'
     ends in a slash, `tail' will be empty.  If there is no slash in
     `path', `head' will be empty.  If `path' is empty, both `head' and
     `tail' are empty.  Trailing slashes are stripped from `head' unless
     it is the root (one or more slashes only).  In all cases,
     ‘join(head, tail)’ returns a path to the same location as `path'
     (but the strings may differ).  Also see the functions *note
     dirname(): 1b20. and *note basename(): 1b1f.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.splitdrive (path)

     Split the pathname `path' into a pair ‘(drive, tail)’ where `drive'
     is either a mount point or the empty string.  On systems which do
     not use drive specifications, `drive' will always be the empty
     string.  In all cases, ‘drive + tail’ will be the same as `path'.

     On Windows, splits a pathname into drive/UNC sharepoint and
     relative path.

     If the path contains a drive letter, drive will contain everything
     up to and including the colon.  e.g.  ‘splitdrive("c:/dir")’
     returns ‘("c:", "/dir")’

     If the path contains a UNC path, drive will contain the host name
     and share, up to but not including the fourth separator.  e.g.
     ‘splitdrive("//host/computer/dir")’ returns ‘("//host/computer",
     "/dir")’

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.path.splitext (path)

     Split the pathname `path' into a pair ‘(root, ext)’ such that ‘root
     + ext == path’, and `ext' is empty or begins with a period and
     contains at most one period.  Leading periods on the basename are
     ignored; ‘splitext('.cshrc')’ returns ‘('.cshrc', '')’.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Data: os.path.supports_unicode_filenames

     ‘True’ if arbitrary Unicode strings can be used as file names
     (within limitations imposed by the file system).

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/posixpath.py

   (2) https://github.com/python/cpython/tree/3.8/Lib/ntpath.py


File: python.info,  Node: fileinput — Iterate over lines from multiple input streams,  Next: stat — Interpreting stat results,  Prev: os path — Common pathname manipulations,  Up: File and Directory Access

5.11.3 ‘fileinput’ — Iterate over lines from multiple input streams
-------------------------------------------------------------------

`Source code:' Lib/fileinput.py(1)

__________________________________________________________________

This module implements a helper class and functions to quickly write a
loop over standard input or a list of files.  If you just want to read
or write one file see *note open(): 4e5.

The typical use is:

     import fileinput
     for line in fileinput.input():
         process(line)

This iterates over the lines of all files listed in ‘sys.argv[1:]’,
defaulting to ‘sys.stdin’ if the list is empty.  If a filename is ‘'-'’,
it is also replaced by ‘sys.stdin’ and the optional arguments `mode' and
`openhook' are ignored.  To specify an alternative list of filenames,
pass it as the first argument to *note input(): 2ab.  A single file name
is also allowed.

All files are opened in text mode by default, but you can override this
by specifying the `mode' parameter in the call to *note input(): 2ab. or
*note FileInput: 27d.  If an I/O error occurs during opening or reading
a file, *note OSError: 1d1. is raised.

Changed in version 3.3: *note IOError: 986. used to be raised; it is now
an alias of *note OSError: 1d1.

If ‘sys.stdin’ is used more than once, the second and further use will
return no lines, except perhaps for interactive use, or if it has been
explicitly reset (e.g.  using ‘sys.stdin.seek(0)’).

Empty files are opened and immediately closed; the only time their
presence in the list of filenames is noticeable at all is when the last
file opened is empty.

Lines are returned with any newlines intact, which means that the last
line in a file may not have one.

You can control how files are opened by providing an opening hook via
the `openhook' parameter to *note fileinput.input(): 2ab. or *note
FileInput(): 27d.  The hook must be a function that takes two arguments,
`filename' and `mode', and returns an accordingly opened file-like
object.  Two useful hooks are already provided by this module.

The following function is the primary interface of this module:

 -- Function: fileinput.input (files=None, inplace=False, backup='', *,
          mode='r', openhook=None)

     Create an instance of the *note FileInput: 27d. class.  The
     instance will be used as global state for the functions of this
     module, and is also returned to use during iteration.  The
     parameters to this function will be passed along to the constructor
     of the *note FileInput: 27d. class.

     The *note FileInput: 27d. instance can be used as a context manager
     in the *note with: 6dd. statement.  In this example, `input' is
     closed after the ‘with’ statement is exited, even if an exception
     occurs:

          with fileinput.input(files=('spam.txt', 'eggs.txt')) as f:
              for line in f:
                  process(line)

     Changed in version 3.2: Can be used as a context manager.

     Changed in version 3.8: The keyword parameters `mode' and
     `openhook' are now keyword-only.

The following functions use the global state created by *note
fileinput.input(): 2ab.; if there is no active state, *note
RuntimeError: 2b8. is raised.

 -- Function: fileinput.filename ()

     Return the name of the file currently being read.  Before the first
     line has been read, returns ‘None’.

 -- Function: fileinput.fileno ()

     Return the integer “file descriptor” for the current file.  When no
     file is opened (before the first line and between files), returns
     ‘-1’.

 -- Function: fileinput.lineno ()

     Return the cumulative line number of the line that has just been
     read.  Before the first line has been read, returns ‘0’.  After the
     last line of the last file has been read, returns the line number
     of that line.

 -- Function: fileinput.filelineno ()

     Return the line number in the current file.  Before the first line
     has been read, returns ‘0’.  After the last line of the last file
     has been read, returns the line number of that line within the
     file.

 -- Function: fileinput.isfirstline ()

     Return ‘True’ if the line just read is the first line of its file,
     otherwise return ‘False’.

 -- Function: fileinput.isstdin ()

     Return ‘True’ if the last line was read from ‘sys.stdin’, otherwise
     return ‘False’.

 -- Function: fileinput.nextfile ()

     Close the current file so that the next iteration will read the
     first line from the next file (if any); lines not read from the
     file will not count towards the cumulative line count.  The
     filename is not changed until after the first line of the next file
     has been read.  Before the first line has been read, this function
     has no effect; it cannot be used to skip the first file.  After the
     last line of the last file has been read, this function has no
     effect.

 -- Function: fileinput.close ()

     Close the sequence.

The class which implements the sequence behavior provided by the module
is available for subclassing as well:

 -- Class: fileinput.FileInput (files=None, inplace=False, backup='', *,
          mode='r', openhook=None)

     Class *note FileInput: 27d. is the implementation; its methods
     *note filename(): 1b2e, *note fileno(): 1b2f, *note lineno(): 1b30,
     *note filelineno(): 1b31, *note isfirstline(): 1b32, *note
     isstdin(): 1b33, *note nextfile(): 1b34. and *note close(): 1b35.
     correspond to the functions of the same name in the module.  In
     addition it has a *note readline(): 1b36. method which returns the
     next input line, and a *note __getitem__(): 27a. method which
     implements the sequence behavior.  The sequence must be accessed in
     strictly sequential order; random access and *note readline():
     1b36. cannot be mixed.

     With `mode' you can specify which file mode will be passed to *note
     open(): 4e5.  It must be one of ‘'r'’, ‘'rU'’, ‘'U'’ and ‘'rb'’.

     The `openhook', when given, must be a function that takes two
     arguments, `filename' and `mode', and returns an accordingly opened
     file-like object.  You cannot use `inplace' and `openhook'
     together.

     A *note FileInput: 27d. instance can be used as a context manager
     in the *note with: 6dd. statement.  In this example, `input' is
     closed after the ‘with’ statement is exited, even if an exception
     occurs:

          with FileInput(files=('spam.txt', 'eggs.txt')) as input:
              process(input)

     Changed in version 3.2: Can be used as a context manager.

     Deprecated since version 3.4: The ‘'rU'’ and ‘'U'’ modes.

     Deprecated since version 3.8: Support for *note __getitem__(): 27a.
     method is deprecated.

     Changed in version 3.8: The keyword parameter `mode' and `openhook'
     are now keyword-only.

`Optional in-place filtering:' if the keyword argument ‘inplace=True’ is
passed to *note fileinput.input(): 2ab. or to the *note FileInput: 27d.
constructor, the file is moved to a backup file and standard output is
directed to the input file (if a file of the same name as the backup
file already exists, it will be replaced silently).  This makes it
possible to write a filter that rewrites its input file in place.  If
the `backup' parameter is given (typically as ‘backup='.<some
extension>'’), it specifies the extension for the backup file, and the
backup file remains around; by default, the extension is ‘'.bak'’ and it
is deleted when the output file is closed.  In-place filtering is
disabled when standard input is read.

The two following opening hooks are provided by this module:

 -- Function: fileinput.hook_compressed (filename, mode)

     Transparently opens files compressed with gzip and bzip2
     (recognized by the extensions ‘'.gz'’ and ‘'.bz2'’) using the *note
     gzip: 8c. and *note bz2: 14. modules.  If the filename extension is
     not ‘'.gz'’ or ‘'.bz2'’, the file is opened normally (ie, using
     *note open(): 4e5. without any decompression).

     Usage example: ‘fi =
     fileinput.FileInput(openhook=fileinput.hook_compressed)’

 -- Function: fileinput.hook_encoded (encoding, errors=None)

     Returns a hook which opens each file with *note open(): 4e5, using
     the given `encoding' and `errors' to read the file.

     Usage example: ‘fi =
     fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8",
     "surrogateescape"))’

     Changed in version 3.6: Added the optional `errors' parameter.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/fileinput.py


File: python.info,  Node: stat — Interpreting stat results,  Next: filecmp — File and Directory Comparisons,  Prev: fileinput — Iterate over lines from multiple input streams,  Up: File and Directory Access

5.11.4 ‘stat’ — Interpreting ‘stat()’ results
---------------------------------------------

`Source code:' Lib/stat.py(1)

__________________________________________________________________

The *note stat: f4. module defines constants and functions for
interpreting the results of *note os.stat(): 1ef, *note os.fstat(): 653.
and *note os.lstat(): 1f0. (if they exist).  For complete details about
the ‘stat()’, ‘fstat()’ and ‘lstat()’ calls, consult the documentation
for your system.

Changed in version 3.4: The stat module is backed by a C implementation.

The *note stat: f4. module defines the following functions to test for
specific file types:

 -- Function: stat.S_ISDIR (mode)

     Return non-zero if the mode is from a directory.

 -- Function: stat.S_ISCHR (mode)

     Return non-zero if the mode is from a character special device
     file.

 -- Function: stat.S_ISBLK (mode)

     Return non-zero if the mode is from a block special device file.

 -- Function: stat.S_ISREG (mode)

     Return non-zero if the mode is from a regular file.

 -- Function: stat.S_ISFIFO (mode)

     Return non-zero if the mode is from a FIFO (named pipe).

 -- Function: stat.S_ISLNK (mode)

     Return non-zero if the mode is from a symbolic link.

 -- Function: stat.S_ISSOCK (mode)

     Return non-zero if the mode is from a socket.

 -- Function: stat.S_ISDOOR (mode)

     Return non-zero if the mode is from a door.

     New in version 3.4.

 -- Function: stat.S_ISPORT (mode)

     Return non-zero if the mode is from an event port.

     New in version 3.4.

 -- Function: stat.S_ISWHT (mode)

     Return non-zero if the mode is from a whiteout.

     New in version 3.4.

Two additional functions are defined for more general manipulation of
the file’s mode:

 -- Function: stat.S_IMODE (mode)

     Return the portion of the file’s mode that can be set by *note
     os.chmod(): a28.—that is, the file’s permission bits, plus the
     sticky bit, set-group-id, and set-user-id bits (on systems that
     support them).

 -- Function: stat.S_IFMT (mode)

     Return the portion of the file’s mode that describes the file type
     (used by the ‘S_IS*()’ functions above).

Normally, you would use the ‘os.path.is*()’ functions for testing the
type of a file; the functions here are useful when you are doing
multiple tests of the same file and wish to avoid the overhead of the
‘stat()’ system call for each test.  These are also useful when checking
for information about a file that isn’t handled by *note os.path: c5,
like the tests for block and character devices.

Example:

     import os, sys
     from stat import *

     def walktree(top, callback):
         '''recursively descend the directory tree rooted at top,
            calling the callback function for each regular file'''

         for f in os.listdir(top):
             pathname = os.path.join(top, f)
             mode = os.stat(pathname).st_mode
             if S_ISDIR(mode):
                 # It's a directory, recurse into it
                 walktree(pathname, callback)
             elif S_ISREG(mode):
                 # It's a file, call the callback function
                 callback(pathname)
             else:
                 # Unknown file type, print a message
                 print('Skipping %s' % pathname)

     def visitfile(file):
         print('visiting', file)

     if __name__ == '__main__':
         walktree(sys.argv[1], visitfile)

An additional utility function is provided to convert a file’s mode in a
human readable string:

 -- Function: stat.filemode (mode)

     Convert a file’s mode to a string of the form ‘-rwxrwxrwx’.

     New in version 3.3.

     Changed in version 3.4: The function supports *note S_IFDOOR: 8c8,
     *note S_IFPORT: 8c9. and *note S_IFWHT: 8ca.

All the variables below are simply symbolic indexes into the 10-tuple
returned by *note os.stat(): 1ef, *note os.fstat(): 653. or *note
os.lstat(): 1f0.

 -- Data: stat.ST_MODE

     Inode protection mode.

 -- Data: stat.ST_INO

     Inode number.

 -- Data: stat.ST_DEV

     Device inode resides on.

 -- Data: stat.ST_NLINK

     Number of links to the inode.

 -- Data: stat.ST_UID

     User id of the owner.

 -- Data: stat.ST_GID

     Group id of the owner.

 -- Data: stat.ST_SIZE

     Size in bytes of a plain file; amount of data waiting on some
     special files.

 -- Data: stat.ST_ATIME

     Time of last access.

 -- Data: stat.ST_MTIME

     Time of last modification.

 -- Data: stat.ST_CTIME

     The “ctime” as reported by the operating system.  On some systems
     (like Unix) is the time of the last metadata change, and, on others
     (like Windows), is the creation time (see platform documentation
     for details).

The interpretation of “file size” changes according to the file type.
For plain files this is the size of the file in bytes.  For FIFOs and
sockets under most flavors of Unix (including Linux in particular), the
“size” is the number of bytes waiting to be read at the time of the call
to *note os.stat(): 1ef, *note os.fstat(): 653, or *note os.lstat():
1f0.; this can sometimes be useful, especially for polling one of these
special files after a non-blocking open.  The meaning of the size field
for other character and block devices varies more, depending on the
implementation of the underlying system call.

The variables below define the flags used in the *note ST_MODE: 8c7.
field.

Use of the functions above is more portable than use of the first set of
flags:

 -- Data: stat.S_IFSOCK

     Socket.

 -- Data: stat.S_IFLNK

     Symbolic link.

 -- Data: stat.S_IFREG

     Regular file.

 -- Data: stat.S_IFBLK

     Block device.

 -- Data: stat.S_IFDIR

     Directory.

 -- Data: stat.S_IFCHR

     Character device.

 -- Data: stat.S_IFIFO

     FIFO.

 -- Data: stat.S_IFDOOR

     Door.

     New in version 3.4.

 -- Data: stat.S_IFPORT

     Event port.

     New in version 3.4.

 -- Data: stat.S_IFWHT

     Whiteout.

     New in version 3.4.

     Note: *note S_IFDOOR: 8c8, *note S_IFPORT: 8c9. or *note S_IFWHT:
     8ca. are defined as 0 when the platform does not have support for
     the file types.

The following flags can also be used in the `mode' argument of *note
os.chmod(): a28.:

 -- Data: stat.S_ISUID

     Set UID bit.

 -- Data: stat.S_ISGID

     Set-group-ID bit.  This bit has several special uses.  For a
     directory it indicates that BSD semantics is to be used for that
     directory: files created there inherit their group ID from the
     directory, not from the effective group ID of the creating process,
     and directories created there will also get the *note S_ISGID:
     1b54. bit set.  For a file that does not have the group execution
     bit (*note S_IXGRP: 1b55.) set, the set-group-ID bit indicates
     mandatory file/record locking (see also *note S_ENFMT: 1b56.).

 -- Data: stat.S_ISVTX

     Sticky bit.  When this bit is set on a directory it means that a
     file in that directory can be renamed or deleted only by the owner
     of the file, by the owner of the directory, or by a privileged
     process.

 -- Data: stat.S_IRWXU

     Mask for file owner permissions.

 -- Data: stat.S_IRUSR

     Owner has read permission.

 -- Data: stat.S_IWUSR

     Owner has write permission.

 -- Data: stat.S_IXUSR

     Owner has execute permission.

 -- Data: stat.S_IRWXG

     Mask for group permissions.

 -- Data: stat.S_IRGRP

     Group has read permission.

 -- Data: stat.S_IWGRP

     Group has write permission.

 -- Data: stat.S_IXGRP

     Group has execute permission.

 -- Data: stat.S_IRWXO

     Mask for permissions for others (not in group).

 -- Data: stat.S_IROTH

     Others have read permission.

 -- Data: stat.S_IWOTH

     Others have write permission.

 -- Data: stat.S_IXOTH

     Others have execute permission.

 -- Data: stat.S_ENFMT

     System V file locking enforcement.  This flag is shared with *note
     S_ISGID: 1b54.: file/record locking is enforced on files that do
     not have the group execution bit (*note S_IXGRP: 1b55.) set.

 -- Data: stat.S_IREAD

     Unix V7 synonym for *note S_IRUSR: 1b59.

 -- Data: stat.S_IWRITE

     Unix V7 synonym for *note S_IWUSR: 1b5a.

 -- Data: stat.S_IEXEC

     Unix V7 synonym for *note S_IXUSR: 1b5b.

The following flags can be used in the `flags' argument of *note
os.chflags(): a27.:

 -- Data: stat.UF_NODUMP

     Do not dump the file.

 -- Data: stat.UF_IMMUTABLE

     The file may not be changed.

 -- Data: stat.UF_APPEND

     The file may only be appended to.

 -- Data: stat.UF_OPAQUE

     The directory is opaque when viewed through a union stack.

 -- Data: stat.UF_NOUNLINK

     The file may not be renamed or deleted.

 -- Data: stat.UF_COMPRESSED

     The file is stored compressed (Mac OS X 10.6+).

 -- Data: stat.UF_HIDDEN

     The file should not be displayed in a GUI (Mac OS X 10.5+).

 -- Data: stat.SF_ARCHIVED

     The file may be archived.

 -- Data: stat.SF_IMMUTABLE

     The file may not be changed.

 -- Data: stat.SF_APPEND

     The file may only be appended to.

 -- Data: stat.SF_NOUNLINK

     The file may not be renamed or deleted.

 -- Data: stat.SF_SNAPSHOT

     The file is a snapshot file.

See the *BSD or Mac OS systems man page ‘chflags(2)’ for more
information.

On Windows, the following file attribute constants are available for use
when testing bits in the ‘st_file_attributes’ member returned by *note
os.stat(): 1ef.  See the Windows API documentation(2) for more detail on
the meaning of these constants.

 -- Data: stat.FILE_ATTRIBUTE_ARCHIVE
 -- Data: stat.FILE_ATTRIBUTE_COMPRESSED
 -- Data: stat.FILE_ATTRIBUTE_DEVICE
 -- Data: stat.FILE_ATTRIBUTE_DIRECTORY
 -- Data: stat.FILE_ATTRIBUTE_ENCRYPTED
 -- Data: stat.FILE_ATTRIBUTE_HIDDEN
 -- Data: stat.FILE_ATTRIBUTE_INTEGRITY_STREAM
 -- Data: stat.FILE_ATTRIBUTE_NORMAL
 -- Data: stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
 -- Data: stat.FILE_ATTRIBUTE_NO_SCRUB_DATA
 -- Data: stat.FILE_ATTRIBUTE_OFFLINE
 -- Data: stat.FILE_ATTRIBUTE_READONLY
 -- Data: stat.FILE_ATTRIBUTE_REPARSE_POINT
 -- Data: stat.FILE_ATTRIBUTE_SPARSE_FILE
 -- Data: stat.FILE_ATTRIBUTE_SYSTEM
 -- Data: stat.FILE_ATTRIBUTE_TEMPORARY
 -- Data: stat.FILE_ATTRIBUTE_VIRTUAL

     New in version 3.5.

On Windows, the following constants are available for comparing against
the ‘st_reparse_tag’ member returned by *note os.lstat(): 1f0.  These
are well-known constants, but are not an exhaustive list.

 -- Data: stat.IO_REPARSE_TAG_SYMLINK
 -- Data: stat.IO_REPARSE_TAG_MOUNT_POINT
 -- Data: stat.IO_REPARSE_TAG_APPEXECLINK

     New in version 3.8.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/stat.py

   (2) 
https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117.aspx


File: python.info,  Node: filecmp — File and Directory Comparisons,  Next: tempfile — Generate temporary files and directories,  Prev: stat — Interpreting stat results,  Up: File and Directory Access

5.11.5 ‘filecmp’ — File and Directory Comparisons
-------------------------------------------------

`Source code:' Lib/filecmp.py(1)

__________________________________________________________________

The *note filecmp: 7f. module defines functions to compare files and
directories, with various optional time/correctness trade-offs.  For
comparing files, see also the *note difflib: 37. module.

The *note filecmp: 7f. module defines the following functions:

 -- Function: filecmp.cmp (f1, f2, shallow=True)

     Compare the files named `f1' and `f2', returning ‘True’ if they
     seem equal, ‘False’ otherwise.

     If `shallow' is true, files with identical *note os.stat(): 1ef.
     signatures are taken to be equal.  Otherwise, the contents of the
     files are compared.

     Note that no external programs are called from this function,
     giving it portability and efficiency.

     This function uses a cache for past comparisons and the results,
     with cache entries invalidated if the *note os.stat(): 1ef.
     information for the file changes.  The entire cache may be cleared
     using *note clear_cache(): 83b.

 -- Function: filecmp.cmpfiles (dir1, dir2, common, shallow=True)

     Compare the files in the two directories `dir1' and `dir2' whose
     names are given by `common'.

     Returns three lists of file names: `match', `mismatch', `errors'.
     `match' contains the list of files that match, `mismatch' contains
     the names of those that don’t, and `errors' lists the names of
     files which could not be compared.  Files are listed in `errors' if
     they don’t exist in one of the directories, the user lacks
     permission to read them or if the comparison could not be done for
     some other reason.

     The `shallow' parameter has the same meaning and default value as
     for *note filecmp.cmp(): 1b88.

     For example, ‘cmpfiles('a', 'b', ['c', 'd/e'])’ will compare ‘a/c’
     with ‘b/c’ and ‘a/d/e’ with ‘b/d/e’.  ‘'c'’ and ‘'d/e'’ will each
     be in one of the three returned lists.

 -- Function: filecmp.clear_cache ()

     Clear the filecmp cache.  This may be useful if a file is compared
     so quickly after it is modified that it is within the mtime
     resolution of the underlying filesystem.

     New in version 3.4.

* Menu:

* The dircmp class::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/filecmp.py


File: python.info,  Node: The dircmp class,  Up: filecmp — File and Directory Comparisons

5.11.5.1 The ‘dircmp’ class
...........................

 -- Class: filecmp.dircmp (a, b, ignore=None, hide=None)

     Construct a new directory comparison object, to compare the
     directories `a' and `b'.  `ignore' is a list of names to ignore,
     and defaults to *note filecmp.DEFAULT_IGNORES: 83c.  `hide' is a
     list of names to hide, and defaults to ‘[os.curdir, os.pardir]’.

     The *note dircmp: 83d. class compares files by doing `shallow'
     comparisons as described for *note filecmp.cmp(): 1b88.

     The *note dircmp: 83d. class provides the following methods:

      -- Method: report ()

          Print (to *note sys.stdout: 303.) a comparison between `a' and
          `b'.

      -- Method: report_partial_closure ()

          Print a comparison between `a' and `b' and common immediate
          subdirectories.

      -- Method: report_full_closure ()

          Print a comparison between `a' and `b' and common
          subdirectories (recursively).

     The *note dircmp: 83d. class offers a number of interesting
     attributes that may be used to get various bits of information
     about the directory trees being compared.

     Note that via *note __getattr__(): 30f. hooks, all attributes are
     computed lazily, so there is no speed penalty if only those
     attributes which are lightweight to compute are used.

      -- Attribute: left

          The directory `a'.

      -- Attribute: right

          The directory `b'.

      -- Attribute: left_list

          Files and subdirectories in `a', filtered by `hide' and
          `ignore'.

      -- Attribute: right_list

          Files and subdirectories in `b', filtered by `hide' and
          `ignore'.

      -- Attribute: common

          Files and subdirectories in both `a' and `b'.

      -- Attribute: left_only

          Files and subdirectories only in `a'.

      -- Attribute: right_only

          Files and subdirectories only in `b'.

      -- Attribute: common_dirs

          Subdirectories in both `a' and `b'.

      -- Attribute: common_files

          Files in both `a' and `b'.

      -- Attribute: common_funny

          Names in both `a' and `b', such that the type differs between
          the directories, or names for which *note os.stat(): 1ef.
          reports an error.

      -- Attribute: same_files

          Files which are identical in both `a' and `b', using the
          class’s file comparison operator.

      -- Attribute: diff_files

          Files which are in both `a' and `b', whose contents differ
          according to the class’s file comparison operator.

      -- Attribute: funny_files

          Files which are in both `a' and `b', but could not be
          compared.

      -- Attribute: subdirs

          A dictionary mapping names in *note common_dirs: 1b96. to
          *note dircmp: 83d. objects.

 -- Attribute: filecmp.DEFAULT_IGNORES

     New in version 3.4.

     List of directories ignored by *note dircmp: 83d. by default.

Here is a simplified example of using the ‘subdirs’ attribute to search
recursively through two directories to show common different files:

     >>> from filecmp import dircmp
     >>> def print_diff_files(dcmp):
     ...     for name in dcmp.diff_files:
     ...         print("diff_file %s found in %s and %s" % (name, dcmp.left,
     ...               dcmp.right))
     ...     for sub_dcmp in dcmp.subdirs.values():
     ...         print_diff_files(sub_dcmp)
     ...
     >>> dcmp = dircmp('dir1', 'dir2')
     >>> print_diff_files(dcmp)


File: python.info,  Node: tempfile — Generate temporary files and directories,  Next: glob — Unix style pathname pattern expansion,  Prev: filecmp — File and Directory Comparisons,  Up: File and Directory Access

5.11.6 ‘tempfile’ — Generate temporary files and directories
------------------------------------------------------------

`Source code:' Lib/tempfile.py(1)

__________________________________________________________________

This module creates temporary files and directories.  It works on all
supported platforms.  *note TemporaryFile: 1b9f, *note
NamedTemporaryFile: d3c, *note TemporaryDirectory: bbb, and *note
SpooledTemporaryFile: a9b. are high-level interfaces which provide
automatic cleanup and can be used as context managers.  *note mkstemp():
1ba0. and *note mkdtemp(): 1ba1. are lower-level functions which require
manual cleanup.

All the user-callable functions and constructors take additional
arguments which allow direct control over the location and name of
temporary files and directories.  Files names used by this module
include a string of random characters which allows those files to be
securely created in shared temporary directories.  To maintain backward
compatibility, the argument order is somewhat odd; it is recommended to
use keyword arguments for clarity.

The module defines the following user-callable items:

 -- Function: tempfile.TemporaryFile (mode='w+b', buffering=None,
          encoding=None, newline=None, suffix=None, prefix=None,
          dir=None, *, errors=None)

     Return a *note file-like object: 1ba2. that can be used as a
     temporary storage area.  The file is created securely, using the
     same rules as *note mkstemp(): 1ba0.  It will be destroyed as soon
     as it is closed (including an implicit close when the object is
     garbage collected).  Under Unix, the directory entry for the file
     is either not created at all or is removed immediately after the
     file is created.  Other platforms do not support this; your code
     should not rely on a temporary file created using this function
     having or not having a visible name in the file system.

     The resulting object can be used as a context manager (see *note
     Examples: 1ba3.).  On completion of the context or destruction of
     the file object the temporary file will be removed from the
     filesystem.

     The `mode' parameter defaults to ‘'w+b'’ so that the file created
     can be read and written without being closed.  Binary mode is used
     so that it behaves consistently on all platforms without regard for
     the data that is stored.  `buffering', `encoding', `errors' and
     `newline' are interpreted as for *note open(): 4e5.

     The `dir', `prefix' and `suffix' parameters have the same meaning
     and defaults as with *note mkstemp(): 1ba0.

     The returned object is a true file object on POSIX platforms.  On
     other platforms, it is a file-like object whose ‘file’ attribute is
     the underlying true file object.

     The *note os.O_TMPFILE: 878. flag is used if it is available and
     works (Linux-specific, requires Linux kernel 3.11 or later).

     Raises an *note auditing event: 1275. ‘tempfile.mkstemp’ with
     argument ‘fullpath’.

     Changed in version 3.5: The *note os.O_TMPFILE: 878. flag is now
     used if available.

     Changed in version 3.8: Added `errors' parameter.

 -- Function: tempfile.NamedTemporaryFile (mode='w+b', buffering=None,
          encoding=None, newline=None, suffix=None, prefix=None,
          dir=None, delete=True, *, errors=None)

     This function operates exactly as *note TemporaryFile(): 1b9f.
     does, except that the file is guaranteed to have a visible name in
     the file system (on Unix, the directory entry is not unlinked).
     That name can be retrieved from the ‘name’ attribute of the
     returned file-like object.  Whether the name can be used to open
     the file a second time, while the named temporary file is still
     open, varies across platforms (it can be so used on Unix; it cannot
     on Windows NT or later).  If `delete' is true (the default), the
     file is deleted as soon as it is closed.  The returned object is
     always a file-like object whose ‘file’ attribute is the underlying
     true file object.  This file-like object can be used in a *note
     with: 6dd. statement, just like a normal file.

     Raises an *note auditing event: 1275. ‘tempfile.mkstemp’ with
     argument ‘fullpath’.

     Changed in version 3.8: Added `errors' parameter.

 -- Function: tempfile.SpooledTemporaryFile (max_size=0, mode='w+b',
          buffering=None, encoding=None, newline=None, suffix=None,
          prefix=None, dir=None, *, errors=None)

     This function operates exactly as *note TemporaryFile(): 1b9f.
     does, except that data is spooled in memory until the file size
     exceeds `max_size', or until the file’s ‘fileno()’ method is
     called, at which point the contents are written to disk and
     operation proceeds as with *note TemporaryFile(): 1b9f.

     The resulting file has one additional method, ‘rollover()’, which
     causes the file to roll over to an on-disk file regardless of its
     size.

     The returned object is a file-like object whose ‘_file’ attribute
     is either an *note io.BytesIO: 78f. or *note io.TextIOWrapper: 5e8.
     object (depending on whether binary or text `mode' was specified)
     or a true file object, depending on whether ‘rollover()’ has been
     called.  This file-like object can be used in a *note with: 6dd.
     statement, just like a normal file.

     Changed in version 3.3: the truncate method now accepts a ‘size’
     argument.

     Changed in version 3.8: Added `errors' parameter.

 -- Function: tempfile.TemporaryDirectory (suffix=None, prefix=None,
          dir=None)

     This function securely creates a temporary directory using the same
     rules as *note mkdtemp(): 1ba1.  The resulting object can be used
     as a context manager (see *note Examples: 1ba3.).  On completion of
     the context or destruction of the temporary directory object the
     newly created temporary directory and all its contents are removed
     from the filesystem.

     The directory name can be retrieved from the ‘name’ attribute of
     the returned object.  When the returned object is used as a context
     manager, the ‘name’ will be assigned to the target of the ‘as’
     clause in the *note with: 6dd. statement, if there is one.

     The directory can be explicitly cleaned up by calling the
     ‘cleanup()’ method.

     Raises an *note auditing event: 1275. ‘tempfile.mkdtemp’ with
     argument ‘fullpath’.

     New in version 3.2.

 -- Function: tempfile.mkstemp (suffix=None, prefix=None, dir=None,
          text=False)

     Creates a temporary file in the most secure manner possible.  There
     are no race conditions in the file’s creation, assuming that the
     platform properly implements the *note os.O_EXCL: 1ba4. flag for
     *note os.open(): 659.  The file is readable and writable only by
     the creating user ID. If the platform uses permission bits to
     indicate whether a file is executable, the file is executable by no
     one.  The file descriptor is not inherited by child processes.

     Unlike *note TemporaryFile(): 1b9f, the user of *note mkstemp():
     1ba0. is responsible for deleting the temporary file when done with
     it.

     If `suffix' is not ‘None’, the file name will end with that suffix,
     otherwise there will be no suffix.  *note mkstemp(): 1ba0. does not
     put a dot between the file name and the suffix; if you need one,
     put it at the beginning of `suffix'.

     If `prefix' is not ‘None’, the file name will begin with that
     prefix; otherwise, a default prefix is used.  The default is the
     return value of *note gettempprefix(): 1ba5. or *note
     gettempprefixb(): 1ba6, as appropriate.

     If `dir' is not ‘None’, the file will be created in that directory;
     otherwise, a default directory is used.  The default directory is
     chosen from a platform-dependent list, but the user of the
     application can control the directory location by setting the
     `TMPDIR', `TEMP' or `TMP' environment variables.  There is thus no
     guarantee that the generated filename will have any nice
     properties, such as not requiring quoting when passed to external
     commands via ‘os.popen()’.

     If any of `suffix', `prefix', and `dir' are not ‘None’, they must
     be the same type.  If they are bytes, the returned name will be
     bytes instead of str.  If you want to force a bytes return value
     with otherwise default behavior, pass ‘suffix=b''’.

     If `text' is specified, it indicates whether to open the file in
     binary mode (the default) or text mode.  On some platforms, this
     makes no difference.

     *note mkstemp(): 1ba0. returns a tuple containing an OS-level
     handle to an open file (as would be returned by *note os.open():
     659.) and the absolute pathname of that file, in that order.

     Raises an *note auditing event: 1275. ‘tempfile.mkstemp’ with
     argument ‘fullpath’.

     Changed in version 3.5: `suffix', `prefix', and `dir' may now be
     supplied in bytes in order to obtain a bytes return value.  Prior
     to this, only str was allowed.  `suffix' and `prefix' now accept
     and default to ‘None’ to cause an appropriate default value to be
     used.

     Changed in version 3.6: The `dir' parameter now accepts a *note
     path-like object: 35f.

 -- Function: tempfile.mkdtemp (suffix=None, prefix=None, dir=None)

     Creates a temporary directory in the most secure manner possible.
     There are no race conditions in the directory’s creation.  The
     directory is readable, writable, and searchable only by the
     creating user ID.

     The user of *note mkdtemp(): 1ba1. is responsible for deleting the
     temporary directory and its contents when done with it.

     The `prefix', `suffix', and `dir' arguments are the same as for
     *note mkstemp(): 1ba0.

     *note mkdtemp(): 1ba1. returns the absolute pathname of the new
     directory.

     Raises an *note auditing event: 1275. ‘tempfile.mkdtemp’ with
     argument ‘fullpath’.

     Changed in version 3.5: `suffix', `prefix', and `dir' may now be
     supplied in bytes in order to obtain a bytes return value.  Prior
     to this, only str was allowed.  `suffix' and `prefix' now accept
     and default to ‘None’ to cause an appropriate default value to be
     used.

     Changed in version 3.6: The `dir' parameter now accepts a *note
     path-like object: 35f.

 -- Function: tempfile.gettempdir ()

     Return the name of the directory used for temporary files.  This
     defines the default value for the `dir' argument to all functions
     in this module.

     Python searches a standard list of directories to find one which
     the calling user can create files in.  The list is:

       1. The directory named by the ‘TMPDIR’ environment variable.

       2. The directory named by the ‘TEMP’ environment variable.

       3. The directory named by the ‘TMP’ environment variable.

       4. A platform-specific location:

             * On Windows, the directories ‘C:\TEMP’, ‘C:\TMP’, ‘\TEMP’,
               and ‘\TMP’, in that order.

             * On all other platforms, the directories ‘/tmp’,
               ‘/var/tmp’, and ‘/usr/tmp’, in that order.

       5. As a last resort, the current working directory.

     The result of this search is cached, see the description of *note
     tempdir: 1ba8. below.

 -- Function: tempfile.gettempdirb ()

     Same as *note gettempdir(): 1ba7. but the return value is in bytes.

     New in version 3.5.

 -- Function: tempfile.gettempprefix ()

     Return the filename prefix used to create temporary files.  This
     does not contain the directory component.

 -- Function: tempfile.gettempprefixb ()

     Same as *note gettempprefix(): 1ba5. but the return value is in
     bytes.

     New in version 3.5.

The module uses a global variable to store the name of the directory
used for temporary files returned by *note gettempdir(): 1ba7.  It can
be set directly to override the selection process, but this is
discouraged.  All functions in this module take a `dir' argument which
can be used to specify the directory and this is the recommended
approach.

 -- Data: tempfile.tempdir

     When set to a value other than ‘None’, this variable defines the
     default value for the `dir' argument to the functions defined in
     this module.

     If ‘tempdir’ is ‘None’ (the default) at any call to any of the
     above functions except *note gettempprefix(): 1ba5. it is
     initialized following the algorithm described in *note
     gettempdir(): 1ba7.

* Menu:

* Examples: Examples<3>.
* Deprecated functions and variables::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tempfile.py


File: python.info,  Node: Examples<3>,  Next: Deprecated functions and variables,  Up: tempfile — Generate temporary files and directories

5.11.6.1 Examples
.................

Here are some examples of typical usage of the *note tempfile: 103.
module:

     >>> import tempfile

     # create a temporary file and write some data to it
     >>> fp = tempfile.TemporaryFile()
     >>> fp.write(b'Hello world!')
     # read data from file
     >>> fp.seek(0)
     >>> fp.read()
     b'Hello world!'
     # close the file, it will be removed
     >>> fp.close()

     # create a temporary file using a context manager
     >>> with tempfile.TemporaryFile() as fp:
     ...     fp.write(b'Hello world!')
     ...     fp.seek(0)
     ...     fp.read()
     b'Hello world!'
     >>>
     # file is now closed and removed

     # create a temporary directory using the context manager
     >>> with tempfile.TemporaryDirectory() as tmpdirname:
     ...     print('created temporary directory', tmpdirname)
     >>>
     # directory and contents have been removed


File: python.info,  Node: Deprecated functions and variables,  Prev: Examples<3>,  Up: tempfile — Generate temporary files and directories

5.11.6.2 Deprecated functions and variables
...........................................

A historical way to create temporary files was to first generate a file
name with the *note mktemp(): 1bac. function and then create a file
using this name.  Unfortunately this is not secure, because a different
process may create a file with this name in the time between the call to
*note mktemp(): 1bac. and the subsequent attempt to create the file by
the first process.  The solution is to combine the two steps and create
the file immediately.  This approach is used by *note mkstemp(): 1ba0.
and the other functions described above.

 -- Function: tempfile.mktemp (suffix='', prefix='tmp', dir=None)

     Deprecated since version 2.3: Use *note mkstemp(): 1ba0. instead.

     Return an absolute pathname of a file that did not exist at the
     time the call is made.  The `prefix', `suffix', and `dir' arguments
     are similar to those of *note mkstemp(): 1ba0, except that bytes
     file names, ‘suffix=None’ and ‘prefix=None’ are not supported.

          Warning: Use of this function may introduce a security hole in
          your program.  By the time you get around to doing anything
          with the file name it returns, someone else may have beaten
          you to the punch.  *note mktemp(): 1bac. usage can be replaced
          easily with *note NamedTemporaryFile(): d3c, passing it the
          ‘delete=False’ parameter:

               >>> f = NamedTemporaryFile(delete=False)
               >>> f.name
               '/tmp/tmptjujjt'
               >>> f.write(b"Hello World!\n")
               13
               >>> f.close()
               >>> os.unlink(f.name)
               >>> os.path.exists(f.name)
               False


File: python.info,  Node: glob — Unix style pathname pattern expansion,  Next: fnmatch — Unix filename pattern matching,  Prev: tempfile — Generate temporary files and directories,  Up: File and Directory Access

5.11.7 ‘glob’ — Unix style pathname pattern expansion
-----------------------------------------------------

`Source code:' Lib/glob.py(1)

__________________________________________________________________

The *note glob: 8a. module finds all the pathnames matching a specified
pattern according to the rules used by the Unix shell, although results
are returned in arbitrary order.  No tilde expansion is done, but ‘*’,
‘?’, and character ranges expressed with ‘[]’ will be correctly matched.
This is done by using the *note os.scandir(): 25d. and *note
fnmatch.fnmatch(): 1baf. functions in concert, and not by actually
invoking a subshell.  Note that unlike *note fnmatch.fnmatch(): 1baf,
*note glob: 8a. treats filenames beginning with a dot (‘.’) as special
cases.  (For tilde and shell variable expansion, use *note
os.path.expanduser(): 1fc. and *note os.path.expandvars(): d37.)

For a literal match, wrap the meta-characters in brackets.  For example,
‘'[?]'’ matches the character ‘'?'’.

See also
........

The *note pathlib: c8. module offers high-level path objects.

 -- Function: glob.glob (pathname, *, recursive=False)

     Return a possibly-empty list of path names that match `pathname',
     which must be a string containing a path specification.  `pathname'
     can be either absolute (like ‘/usr/src/Python-1.5/Makefile’) or
     relative (like ‘../../Tools/*/*.gif’), and can contain shell-style
     wildcards.  Broken symlinks are included in the results (as in the
     shell).  Whether or not the results are sorted depends on the file
     system.

     If `recursive' is true, the pattern “‘**’” will match any files and
     zero or more directories, subdirectories and symbolic links to
     directories.  If the pattern is followed by an *note os.sep: 1bb0.
     or *note os.altsep: 1bb1. then files will not match.

     Raises an *note auditing event: 1275. ‘glob.glob’ with arguments
     ‘pathname’, ‘recursive’.

          Note: Using the “‘**’” pattern in large directory trees may
          consume an inordinate amount of time.

     Changed in version 3.5: Support for recursive globs using “‘**’”.

 -- Function: glob.iglob (pathname, *, recursive=False)

     Return an *note iterator: f73. which yields the same values as
     *note glob(): 8a. without actually storing them all simultaneously.

     Raises an *note auditing event: 1275. ‘glob.glob’ with arguments
     ‘pathname’, ‘recursive’.

 -- Function: glob.escape (pathname)

     Escape all special characters (‘'?'’, ‘'*'’ and ‘'['’).  This is
     useful if you want to match an arbitrary literal string that may
     have special characters in it.  Special characters in drive/UNC
     sharepoints are not escaped, e.g.  on Windows ‘escape('//?/c:/Quo
     vadis?.txt')’ returns ‘'//?/c:/Quo vadis[?].txt'’.

     New in version 3.4.

For example, consider a directory containing the following files:
‘1.gif’, ‘2.txt’, ‘card.gif’ and a subdirectory ‘sub’ which contains
only the file ‘3.txt’.  *note glob(): 8a. will produce the following
results.  Notice how any leading components of the path are preserved.

     >>> import glob
     >>> glob.glob('./[0-9].*')
     ['./1.gif', './2.txt']
     >>> glob.glob('*.gif')
     ['1.gif', 'card.gif']
     >>> glob.glob('?.gif')
     ['1.gif']
     >>> glob.glob('**/*.txt', recursive=True)
     ['2.txt', 'sub/3.txt']
     >>> glob.glob('./**/', recursive=True)
     ['./', './sub/']

If the directory contains files starting with ‘.’ they won’t be matched
by default.  For example, consider a directory containing ‘card.gif’ and
‘.card.gif’:

     >>> import glob
     >>> glob.glob('*.gif')
     ['card.gif']
     >>> glob.glob('.c*')
     ['.card.gif']

See also
........

Module *note fnmatch: 81.

     Shell-style filename (not path) expansion

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/glob.py


File: python.info,  Node: fnmatch — Unix filename pattern matching,  Next: linecache — Random access to text lines,  Prev: glob — Unix style pathname pattern expansion,  Up: File and Directory Access

5.11.8 ‘fnmatch’ — Unix filename pattern matching
-------------------------------------------------

`Source code:' Lib/fnmatch.py(1)

__________________________________________________________________

This module provides support for Unix shell-style wildcards, which are
`not' the same as regular expressions (which are documented in the *note
re: dd. module).  The special characters used in shell-style wildcards
are:

Pattern          Meaning
                 
----------------------------------------------------------
                 
‘*’              matches everything
                 
                 
‘?’              matches any single character
                 
                 
‘[seq]’          matches any character in `seq'
                 
                 
‘[!seq]’         matches any character not in `seq'
                 

For a literal match, wrap the meta-characters in brackets.  For example,
‘'[?]'’ matches the character ‘'?'’.

Note that the filename separator (‘'/'’ on Unix) is `not' special to
this module.  See module *note glob: 8a. for pathname expansion (*note
glob: 8a. uses *note filter(): 1bb4. to match pathname segments).
Similarly, filenames starting with a period are not special for this
module, and are matched by the ‘*’ and ‘?’ patterns.

 -- Function: fnmatch.fnmatch (filename, pattern)

     Test whether the `filename' string matches the `pattern' string,
     returning *note True: 48f. or *note False: 37d.  Both parameters
     are case-normalized using *note os.path.normcase(): 1b29.  *note
     fnmatchcase(): 1bb5. can be used to perform a case-sensitive
     comparison, regardless of whether that’s standard for the operating
     system.

     This example will print all file names in the current directory
     with the extension ‘.txt’:

          import fnmatch
          import os

          for file in os.listdir('.'):
              if fnmatch.fnmatch(file, '*.txt'):
                  print(file)

 -- Function: fnmatch.fnmatchcase (filename, pattern)

     Test whether `filename' matches `pattern', returning *note True:
     48f. or *note False: 37d.; the comparison is case-sensitive and
     does not apply *note os.path.normcase(): 1b29.

 -- Function: fnmatch.filter (names, pattern)

     Return the subset of the list of `names' that match `pattern'.  It
     is the same as ‘[n for n in names if fnmatch(n, pattern)]’, but
     implemented more efficiently.

 -- Function: fnmatch.translate (pattern)

     Return the shell-style `pattern' converted to a regular expression
     for using with *note re.match(): ba6.

     Example:

          >>> import fnmatch, re
          >>>
          >>> regex = fnmatch.translate('*.txt')
          >>> regex
          '(?s:.*\\.txt)\\Z'
          >>> reobj = re.compile(regex)
          >>> reobj.match('foobar.txt')
          <re.Match object; span=(0, 10), match='foobar.txt'>

See also
........

Module *note glob: 8a.

     Unix shell-style path expansion.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/fnmatch.py


File: python.info,  Node: linecache — Random access to text lines,  Next: shutil — High-level file operations,  Prev: fnmatch — Unix filename pattern matching,  Up: File and Directory Access

5.11.9 ‘linecache’ — Random access to text lines
------------------------------------------------

`Source code:' Lib/linecache.py(1)

__________________________________________________________________

The *note linecache: a8. module allows one to get any line from a Python
source file, while attempting to optimize internally, using a cache, the
common case where many lines are read from a single file.  This is used
by the *note traceback: 113. module to retrieve source lines for
inclusion in the formatted traceback.

The *note tokenize.open(): 1bb8. function is used to open files.  This
function uses *note tokenize.detect_encoding(): 1bb9. to get the
encoding of the file; in the absence of an encoding token, the file
encoding defaults to UTF-8.

The *note linecache: a8. module defines the following functions:

 -- Function: linecache.getline (filename, lineno, module_globals=None)

     Get line `lineno' from file named `filename'.  This function will
     never raise an exception — it will return ‘''’ on errors (the
     terminating newline character will be included for lines that are
     found).

     If a file named `filename' is not found, the function first checks
     for a PEP 302(2) ‘__loader__’ in `module_globals'.  If there is
     such a loader and it defines a ‘get_source’ method, then that
     determines the source lines (if ‘get_source()’ returns ‘None’, then
     ‘''’ is returned).  Finally, if `filename' is a relative filename,
     it is looked up relative to the entries in the module search path,
     ‘sys.path’.

 -- Function: linecache.clearcache ()

     Clear the cache.  Use this function if you no longer need lines
     from files previously read using *note getline(): 6fd.

 -- Function: linecache.checkcache (filename=None)

     Check the cache for validity.  Use this function if files in the
     cache may have changed on disk, and you require the updated
     version.  If `filename' is omitted, it will check all the entries
     in the cache.

 -- Function: linecache.lazycache (filename, module_globals)

     Capture enough detail about a non-file-based module to permit
     getting its lines later via *note getline(): 6fd. even if
     `module_globals' is ‘None’ in the later call.  This avoids doing
     I/O until a line is actually needed, without having to carry the
     module globals around indefinitely.

     New in version 3.5.

Example:

     >>> import linecache
     >>> linecache.getline(linecache.__file__, 8)
     'import sys\n'

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/linecache.py

   (2) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: shutil — High-level file operations,  Prev: linecache — Random access to text lines,  Up: File and Directory Access

5.11.10 ‘shutil’ — High-level file operations
---------------------------------------------

`Source code:' Lib/shutil.py(1)

__________________________________________________________________

The *note shutil: e9. module offers a number of high-level operations on
files and collections of files.  In particular, functions are provided
which support file copying and removal.  For operations on individual
files, see also the *note os: c4. module.

     Warning: Even the higher-level file copying functions (*note
     shutil.copy(): 257, *note shutil.copy2(): 258.) cannot copy all
     file metadata.

     On POSIX platforms, this means that file owner and group are lost
     as well as ACLs.  On Mac OS, the resource fork and other metadata
     are not used.  This means that resources will be lost and file type
     and creator codes will not be correct.  On Windows, file owners,
     ACLs and alternate data streams are not copied.

* Menu:

* Directory and files operations::
* Archiving operations::
* Querying the size of the output terminal::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/shutil.py


File: python.info,  Node: Directory and files operations,  Next: Archiving operations,  Up: shutil — High-level file operations

5.11.10.1 Directory and files operations
........................................

 -- Function: shutil.copyfileobj (fsrc, fdst[, length])

     Copy the contents of the file-like object `fsrc' to the file-like
     object `fdst'.  The integer `length', if given, is the buffer size.
     In particular, a negative `length' value means to copy the data
     without looping over the source data in chunks; by default the data
     is read in chunks to avoid uncontrolled memory consumption.  Note
     that if the current file position of the `fsrc' object is not 0,
     only the contents from the current file position to the end of the
     file will be copied.

 -- Function: shutil.copyfile (src, dst, *, follow_symlinks=True)

     Copy the contents (no metadata) of the file named `src' to a file
     named `dst' and return `dst' in the most efficient way possible.
     `src' and `dst' are path-like objects or path names given as
     strings.

     `dst' must be the complete target file name; look at *note copy():
     257. for a copy that accepts a target directory path.  If `src' and
     `dst' specify the same file, *note SameFileError: 8a7. is raised.

     The destination location must be writable; otherwise, an *note
     OSError: 1d1. exception will be raised.  If `dst' already exists,
     it will be replaced.  Special files such as character or block
     devices and pipes cannot be copied with this function.

     If `follow_symlinks' is false and `src' is a symbolic link, a new
     symbolic link will be created instead of copying the file `src'
     points to.

     Changed in version 3.3: *note IOError: 986. used to be raised
     instead of *note OSError: 1d1.  Added `follow_symlinks' argument.
     Now returns `dst'.

     Changed in version 3.4: Raise *note SameFileError: 8a7. instead of
     *note Error: 8a6.  Since the former is a subclass of the latter,
     this change is backward compatible.

     Changed in version 3.8: Platform-specific fast-copy syscalls may be
     used internally in order to copy the file more efficiently.  See
     *note Platform-dependent efficient copy operations: 25c. section.

 -- Exception: shutil.SameFileError

     This exception is raised if source and destination in *note
     copyfile(): 256. are the same file.

     New in version 3.4.

 -- Function: shutil.copymode (src, dst, *, follow_symlinks=True)

     Copy the permission bits from `src' to `dst'.  The file contents,
     owner, and group are unaffected.  `src' and `dst' are path-like
     objects or path names given as strings.  If `follow_symlinks' is
     false, and both `src' and `dst' are symbolic links, *note
     copymode(): 1bc0. will attempt to modify the mode of `dst' itself
     (rather than the file it points to).  This functionality is not
     available on every platform; please see *note copystat(): a6c. for
     more information.  If *note copymode(): 1bc0. cannot modify
     symbolic links on the local platform, and it is asked to do so, it
     will do nothing and return.

     Changed in version 3.3: Added `follow_symlinks' argument.

 -- Function: shutil.copystat (src, dst, *, follow_symlinks=True)

     Copy the permission bits, last access time, last modification time,
     and flags from `src' to `dst'.  On Linux, *note copystat(): a6c.
     also copies the “extended attributes” where possible.  The file
     contents, owner, and group are unaffected.  `src' and `dst' are
     path-like objects or path names given as strings.

     If `follow_symlinks' is false, and `src' and `dst' both refer to
     symbolic links, *note copystat(): a6c. will operate on the symbolic
     links themselves rather than the files the symbolic links refer
     to—reading the information from the `src' symbolic link, and
     writing the information to the `dst' symbolic link.

          Note: Not all platforms provide the ability to examine and
          modify symbolic links.  Python itself can tell you what
          functionality is locally available.

             * If ‘os.chmod in os.supports_follow_symlinks’ is ‘True’,
               *note copystat(): a6c. can modify the permission bits of
               a symbolic link.

             * If ‘os.utime in os.supports_follow_symlinks’ is ‘True’,
               *note copystat(): a6c. can modify the last access and
               modification times of a symbolic link.

             * If ‘os.chflags in os.supports_follow_symlinks’ is ‘True’,
               *note copystat(): a6c. can modify the flags of a symbolic
               link.  (‘os.chflags’ is not available on all platforms.)

          On platforms where some or all of this functionality is
          unavailable, when asked to modify a symbolic link, *note
          copystat(): a6c. will copy everything it can.  *note
          copystat(): a6c. never returns failure.

          Please see *note os.supports_follow_symlinks: 1bc1. for more
          information.

     Changed in version 3.3: Added `follow_symlinks' argument and
     support for Linux extended attributes.

 -- Function: shutil.copy (src, dst, *, follow_symlinks=True)

     Copies the file `src' to the file or directory `dst'.  `src' and
     `dst' should be strings.  If `dst' specifies a directory, the file
     will be copied into `dst' using the base filename from `src'.
     Returns the path to the newly created file.

     If `follow_symlinks' is false, and `src' is a symbolic link, `dst'
     will be created as a symbolic link.  If `follow_symlinks' is true
     and `src' is a symbolic link, `dst' will be a copy of the file
     `src' refers to.

     *note copy(): 257. copies the file data and the file’s permission
     mode (see *note os.chmod(): a28.).  Other metadata, like the file’s
     creation and modification times, is not preserved.  To preserve all
     file metadata from the original, use *note copy2(): 258. instead.

     Changed in version 3.3: Added `follow_symlinks' argument.  Now
     returns path to the newly created file.

     Changed in version 3.8: Platform-specific fast-copy syscalls may be
     used internally in order to copy the file more efficiently.  See
     *note Platform-dependent efficient copy operations: 25c. section.

 -- Function: shutil.copy2 (src, dst, *, follow_symlinks=True)

     Identical to *note copy(): 257. except that *note copy2(): 258.
     also attempts to preserve file metadata.

     When `follow_symlinks' is false, and `src' is a symbolic link,
     *note copy2(): 258. attempts to copy all metadata from the `src'
     symbolic link to the newly-created `dst' symbolic link.  However,
     this functionality is not available on all platforms.  On platforms
     where some or all of this functionality is unavailable, *note
     copy2(): 258. will preserve all the metadata it can; *note copy2():
     258. never raises an exception because it cannot preserve file
     metadata.

     *note copy2(): 258. uses *note copystat(): a6c. to copy the file
     metadata.  Please see *note copystat(): a6c. for more information
     about platform support for modifying symbolic link metadata.

     Changed in version 3.3: Added `follow_symlinks' argument, try to
     copy extended file system attributes too (currently Linux only).
     Now returns path to the newly created file.

     Changed in version 3.8: Platform-specific fast-copy syscalls may be
     used internally in order to copy the file more efficiently.  See
     *note Platform-dependent efficient copy operations: 25c. section.

 -- Function: shutil.ignore_patterns (*patterns)

     This factory function creates a function that can be used as a
     callable for *note copytree(): 218.’s `ignore' argument, ignoring
     files and directories that match one of the glob-style `patterns'
     provided.  See the example below.

 -- Function: shutil.copytree (src, dst, symlinks=False, ignore=None,
          copy_function=copy2, ignore_dangling_symlinks=False,
          dirs_exist_ok=False)

     Recursively copy an entire directory tree rooted at `src' to a
     directory named `dst' and return the destination directory.
     `dirs_exist_ok' dictates whether to raise an exception in case
     `dst' or any missing parent directory already exists.

     Permissions and times of directories are copied with *note
     copystat(): a6c, individual files are copied using *note copy2():
     258.

     If `symlinks' is true, symbolic links in the source tree are
     represented as symbolic links in the new tree and the metadata of
     the original links will be copied as far as the platform allows; if
     false or omitted, the contents and metadata of the linked files are
     copied to the new tree.

     When `symlinks' is false, if the file pointed by the symlink
     doesn’t exist, an exception will be added in the list of errors
     raised in an *note Error: 8a6. exception at the end of the copy
     process.  You can set the optional `ignore_dangling_symlinks' flag
     to true if you want to silence this exception.  Notice that this
     option has no effect on platforms that don’t support *note
     os.symlink(): a30.

     If `ignore' is given, it must be a callable that will receive as
     its arguments the directory being visited by *note copytree(): 218,
     and a list of its contents, as returned by *note os.listdir(): a36.
     Since *note copytree(): 218. is called recursively, the `ignore'
     callable will be called once for each directory that is copied.
     The callable must return a sequence of directory and file names
     relative to the current directory (i.e.  a subset of the items in
     its second argument); these names will then be ignored in the copy
     process.  *note ignore_patterns(): 1bc2. can be used to create such
     a callable that ignores names based on glob-style patterns.

     If exception(s) occur, an *note Error: 8a6. is raised with a list
     of reasons.

     If `copy_function' is given, it must be a callable that will be
     used to copy each file.  It will be called with the source path and
     the destination path as arguments.  By default, *note copy2(): 258.
     is used, but any function that supports the same signature (like
     *note copy(): 257.) can be used.

     Raises an *note auditing event: 1275. ‘shutil.copytree’ with
     arguments ‘src’, ‘dst’.

     Changed in version 3.3: Copy metadata when `symlinks' is false.
     Now returns `dst'.

     Changed in version 3.2: Added the `copy_function' argument to be
     able to provide a custom copy function.  Added the
     `ignore_dangling_symlinks' argument to silent dangling symlinks
     errors when `symlinks' is false.

     Changed in version 3.8: Platform-specific fast-copy syscalls may be
     used internally in order to copy the file more efficiently.  See
     *note Platform-dependent efficient copy operations: 25c. section.

     New in version 3.8: The `dirs_exist_ok' parameter.

 -- Function: shutil.rmtree (path, ignore_errors=False, onerror=None)

     Delete an entire directory tree; `path' must point to a directory
     (but not a symbolic link to a directory).  If `ignore_errors' is
     true, errors resulting from failed removals will be ignored; if
     false or omitted, such errors are handled by calling a handler
     specified by `onerror' or, if that is omitted, they raise an
     exception.

          Note: On platforms that support the necessary fd-based
          functions a symlink attack resistant version of *note
          rmtree(): 21a. is used by default.  On other platforms, the
          *note rmtree(): 21a. implementation is susceptible to a
          symlink attack: given proper timing and circumstances,
          attackers can manipulate symlinks on the filesystem to delete
          files they wouldn’t be able to access otherwise.  Applications
          can use the *note rmtree.avoids_symlink_attacks: 1bc3.
          function attribute to determine which case applies.

     If `onerror' is provided, it must be a callable that accepts three
     parameters: `function', `path', and `excinfo'.

     The first parameter, `function', is the function which raised the
     exception; it depends on the platform and implementation.  The
     second parameter, `path', will be the path name passed to
     `function'.  The third parameter, `excinfo', will be the exception
     information returned by *note sys.exc_info(): c52.  Exceptions
     raised by `onerror' will not be caught.

     Raises an *note auditing event: 1275. ‘shutil.rmtree’ with argument
     ‘path’.

     Changed in version 3.3: Added a symlink attack resistant version
     that is used automatically if platform supports fd-based functions.

     Changed in version 3.8: On Windows, will no longer delete the
     contents of a directory junction before removing the junction.

      -- Attribute: rmtree.avoids_symlink_attacks

          Indicates whether the current platform and implementation
          provides a symlink attack resistant version of *note rmtree():
          21a.  Currently this is only true for platforms supporting
          fd-based directory access functions.

          New in version 3.3.

 -- Function: shutil.move (src, dst, copy_function=copy2)

     Recursively move a file or directory (`src') to another location
     (`dst') and return the destination.

     If the destination is an existing directory, then `src' is moved
     inside that directory.  If the destination already exists but is
     not a directory, it may be overwritten depending on *note
     os.rename(): a2d. semantics.

     If the destination is on the current filesystem, then *note
     os.rename(): a2d. is used.  Otherwise, `src' is copied to `dst'
     using `copy_function' and then removed.  In case of symlinks, a new
     symlink pointing to the target of `src' will be created in or as
     `dst' and `src' will be removed.

     If `copy_function' is given, it must be a callable that takes two
     arguments `src' and `dst', and will be used to copy `src' to `dest'
     if *note os.rename(): a2d. cannot be used.  If the source is a
     directory, *note copytree(): 218. is called, passing it the
     ‘copy_function()’.  The default `copy_function' is *note copy2():
     258.  Using *note copy(): 257. as the `copy_function' allows the
     move to succeed when it is not possible to also copy the metadata,
     at the expense of not copying any of the metadata.

     Changed in version 3.3: Added explicit symlink handling for foreign
     filesystems, thus adapting it to the behavior of GNU’s ‘mv’.  Now
     returns `dst'.

     Changed in version 3.5: Added the `copy_function' keyword argument.

     Changed in version 3.8: Platform-specific fast-copy syscalls may be
     used internally in order to copy the file more efficiently.  See
     *note Platform-dependent efficient copy operations: 25c. section.

 -- Function: shutil.disk_usage (path)

     Return disk usage statistics about the given path as a *note named
     tuple: a98. with the attributes `total', `used' and `free', which
     are the amount of total, used and free space, in bytes.  `path' may
     be a file or a directory.

     New in version 3.3.

     Changed in version 3.8: On Windows, `path' can now be a file or
     directory.

     *note Availability: 129a.: Unix, Windows.

 -- Function: shutil.chown (path, user=None, group=None)

     Change owner `user' and/or `group' of the given `path'.

     `user' can be a system user name or a uid; the same applies to
     `group'.  At least one argument is required.

     See also *note os.chown(): a29, the underlying function.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: shutil.which (cmd, mode=os.F_OK | os.X_OK, path=None)

     Return the path to an executable which would be run if the given
     `cmd' was called.  If no `cmd' would be called, return ‘None’.

     `mode' is a permission mask passed to *note os.access(): a26, by
     default determining if the file exists and executable.

     When no `path' is specified, the results of *note os.environ():
     b2a. are used, returning either the “PATH” value or a fallback of
     *note os.defpath: f12.

     On Windows, the current directory is always prepended to the `path'
     whether or not you use the default or provide your own, which is
     the behavior the command shell uses when finding executables.
     Additionally, when finding the `cmd' in the `path', the ‘PATHEXT’
     environment variable is checked.  For example, if you call
     ‘shutil.which("python")’, *note which(): f0e. will search ‘PATHEXT’
     to know that it should look for ‘python.exe’ within the `path'
     directories.  For example, on Windows:

          >>> shutil.which("python")
          'C:\\Python33\\python.EXE'

     New in version 3.3.

     Changed in version 3.8: The *note bytes: 326. type is now accepted.
     If `cmd' type is *note bytes: 326, the result type is also *note
     bytes: 326.

 -- Exception: shutil.Error

     This exception collects exceptions that are raised during a
     multi-file operation.  For *note copytree(): 218, the exception
     argument is a list of 3-tuples (`srcname', `dstname', `exception').

* Menu:

* Platform-dependent efficient copy operations::
* copytree example::
* rmtree example::


File: python.info,  Node: Platform-dependent efficient copy operations,  Next: copytree example,  Up: Directory and files operations

5.11.10.2 Platform-dependent efficient copy operations
......................................................

Starting from Python 3.8 all functions involving a file copy (*note
copyfile(): 256, *note copy(): 26, *note copy2(): 258, *note copytree():
218, and *note move(): 259.) may use platform-specific “fast-copy”
syscalls in order to copy the file more efficiently (see bpo-33671(1)).
“fast-copy” means that the copying operation occurs within the kernel,
avoiding the use of userspace buffers in Python as in
“‘outfd.write(infd.read())’”.

On macOS fcopyfile(2) is used to copy the file content (not metadata).

On Linux *note os.sendfile(): 34e. is used.

On Windows *note shutil.copyfile(): 256. uses a bigger default buffer
size (1 MiB instead of 64 KiB) and a *note memoryview(): 25a.-based
variant of *note shutil.copyfileobj(): 25b. is used.

If the fast-copy operation fails and no data was written in the
destination file then shutil will silently fallback on using less
efficient *note copyfileobj(): 25b. function internally.

Changed in version 3.8.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33671

   (2) http://www.manpagez.com/man/3/copyfile/


File: python.info,  Node: copytree example,  Next: rmtree example,  Prev: Platform-dependent efficient copy operations,  Up: Directory and files operations

5.11.10.3 copytree example
..........................

This example is the implementation of the *note copytree(): 218.
function, described above, with the docstring omitted.  It demonstrates
many of the other functions provided by this module.

     def copytree(src, dst, symlinks=False):
         names = os.listdir(src)
         os.makedirs(dst)
         errors = []
         for name in names:
             srcname = os.path.join(src, name)
             dstname = os.path.join(dst, name)
             try:
                 if symlinks and os.path.islink(srcname):
                     linkto = os.readlink(srcname)
                     os.symlink(linkto, dstname)
                 elif os.path.isdir(srcname):
                     copytree(srcname, dstname, symlinks)
                 else:
                     copy2(srcname, dstname)
                 # XXX What about devices, sockets etc.?
             except OSError as why:
                 errors.append((srcname, dstname, str(why)))
             # catch the Error from the recursive copytree so that we can
             # continue with other files
             except Error as err:
                 errors.extend(err.args[0])
         try:
             copystat(src, dst)
         except OSError as why:
             # can't copy file access times on Windows
             if why.winerror is None:
                 errors.extend((src, dst, str(why)))
         if errors:
             raise Error(errors)

Another example that uses the *note ignore_patterns(): 1bc2. helper:

     from shutil import copytree, ignore_patterns

     copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))

This will copy everything except ‘.pyc’ files and files or directories
whose name starts with ‘tmp’.

Another example that uses the `ignore' argument to add a logging call:

     from shutil import copytree
     import logging

     def _logpath(path, names):
         logging.info('Working in %s', path)
         return []   # nothing will be ignored

     copytree(source, destination, ignore=_logpath)


File: python.info,  Node: rmtree example,  Prev: copytree example,  Up: Directory and files operations

5.11.10.4 rmtree example
........................

This example shows how to remove a directory tree on Windows where some
of the files have their read-only bit set.  It uses the onerror callback
to clear the readonly bit and reattempt the remove.  Any subsequent
failure will propagate.

     import os, stat
     import shutil

     def remove_readonly(func, path, _):
         "Clear the readonly bit and reattempt the removal"
         os.chmod(path, stat.S_IWRITE)
         func(path)

     shutil.rmtree(directory, onerror=remove_readonly)


File: python.info,  Node: Archiving operations,  Next: Querying the size of the output terminal,  Prev: Directory and files operations,  Up: shutil — High-level file operations

5.11.10.5 Archiving operations
..............................

New in version 3.2.

Changed in version 3.5: Added support for the `xztar' format.

High-level utilities to create and read compressed and archived files
are also provided.  They rely on the *note zipfile: 142. and *note
tarfile: 101. modules.

 -- Function: shutil.make_archive (base_name, format[, root_dir[,
          base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])

     Create an archive file (such as zip or tar) and return its name.

     `base_name' is the name of the file to create, including the path,
     minus any format-specific extension.  `format' is the archive
     format: one of “zip” (if the *note zlib: 144. module is available),
     “tar”, “gztar” (if the *note zlib: 144. module is available),
     “bztar” (if the *note bz2: 14. module is available), or “xztar” (if
     the *note lzma: ad. module is available).

     `root_dir' is a directory that will be the root directory of the
     archive; for example, we typically chdir into `root_dir' before
     creating the archive.

     `base_dir' is the directory where we start archiving from; i.e.
     `base_dir' will be the common prefix of all files and directories
     in the archive.

     `root_dir' and `base_dir' both default to the current directory.

     If `dry_run' is true, no archive is created, but the operations
     that would be executed are logged to `logger'.

     `owner' and `group' are used when creating a tar archive.  By
     default, uses the current owner and group.

     `logger' must be an object compatible with PEP 282(1), usually an
     instance of *note logging.Logger: 39c.

     The `verbose' argument is unused and deprecated.

     Raises an *note auditing event: 1275. ‘shutil.make_archive’ with
     arguments ‘base_name’, ‘format’, ‘root_dir’, ‘base_dir’.

     Changed in version 3.8: The modern pax (POSIX.1-2001) format is now
     used instead of the legacy GNU format for archives created with
     ‘format="tar"’.

 -- Function: shutil.get_archive_formats ()

     Return a list of supported formats for archiving.  Each element of
     the returned sequence is a tuple ‘(name, description)’.

     By default *note shutil: e9. provides these formats:

        - `zip': ZIP file (if the *note zlib: 144. module is available).

        - `tar': Uncompressed tar file.  Uses POSIX.1-2001 pax format
          for new archives.

        - `gztar': gzip’ed tar-file (if the *note zlib: 144. module is
          available).

        - `bztar': bzip2’ed tar-file (if the *note bz2: 14. module is
          available).

        - `xztar': xz’ed tar-file (if the *note lzma: ad. module is
          available).

     You can register new formats or provide your own archiver for any
     existing formats, by using *note register_archive_format(): 1bcb.

 -- Function: shutil.register_archive_format (name, function[,
          extra_args[, description]])

     Register an archiver for the format `name'.

     `function' is the callable that will be used to unpack archives.
     The callable will receive the `base_name' of the file to create,
     followed by the `base_dir' (which defaults to *note os.curdir:
     1b2a.) to start archiving from.  Further arguments are passed as
     keyword arguments: `owner', `group', `dry_run' and `logger' (as
     passed in *note make_archive(): 219.).

     If given, `extra_args' is a sequence of ‘(name, value)’ pairs that
     will be used as extra keywords arguments when the archiver callable
     is used.

     `description' is used by *note get_archive_formats(): 1bca. which
     returns the list of archivers.  Defaults to an empty string.

 -- Function: shutil.unregister_archive_format (name)

     Remove the archive format `name' from the list of supported
     formats.

 -- Function: shutil.unpack_archive (filename[, extract_dir[, format]])

     Unpack an archive.  `filename' is the full path of the archive.

     `extract_dir' is the name of the target directory where the archive
     is unpacked.  If not provided, the current working directory is
     used.

     `format' is the archive format: one of “zip”, “tar”, “gztar”,
     “bztar”, or “xztar”.  Or any other format registered with *note
     register_unpack_format(): 1bcd.  If not provided, *note
     unpack_archive(): b8a. will use the archive file name extension and
     see if an unpacker was registered for that extension.  In case none
     is found, a *note ValueError: 1f9. is raised.

     Changed in version 3.7: Accepts a *note path-like object: 35f. for
     `filename' and `extract_dir'.

 -- Function: shutil.register_unpack_format (name, extensions,
          function[, extra_args[, description]])

     Registers an unpack format.  `name' is the name of the format and
     `extensions' is a list of extensions corresponding to the format,
     like ‘.zip’ for Zip files.

     `function' is the callable that will be used to unpack archives.
     The callable will receive the path of the archive, followed by the
     directory the archive must be extracted to.

     When provided, `extra_args' is a sequence of ‘(name, value)’ tuples
     that will be passed as keywords arguments to the callable.

     `description' can be provided to describe the format, and will be
     returned by the *note get_unpack_formats(): 1bce. function.

 -- Function: shutil.unregister_unpack_format (name)

     Unregister an unpack format.  `name' is the name of the format.

 -- Function: shutil.get_unpack_formats ()

     Return a list of all registered formats for unpacking.  Each
     element of the returned sequence is a tuple ‘(name, extensions,
     description)’.

     By default *note shutil: e9. provides these formats:

        - `zip': ZIP file (unpacking compressed files works only if the
          corresponding module is available).

        - `tar': uncompressed tar file.

        - `gztar': gzip’ed tar-file (if the *note zlib: 144. module is
          available).

        - `bztar': bzip2’ed tar-file (if the *note bz2: 14. module is
          available).

        - `xztar': xz’ed tar-file (if the *note lzma: ad. module is
          available).

     You can register new formats or provide your own unpacker for any
     existing formats, by using *note register_unpack_format(): 1bcd.

* Menu:

* Archiving example::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0282


File: python.info,  Node: Archiving example,  Up: Archiving operations

5.11.10.6 Archiving example
...........................

In this example, we create a gzip’ed tar-file archive containing all
files found in the ‘.ssh’ directory of the user:

     >>> from shutil import make_archive
     >>> import os
     >>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
     >>> root_dir = os.path.expanduser(os.path.join('~', '.ssh'))
     >>> make_archive(archive_name, 'gztar', root_dir)
     '/Users/tarek/myarchive.tar.gz'

The resulting archive contains:

     $ tar -tzvf /Users/tarek/myarchive.tar.gz
     drwx------ tarek/staff       0 2010-02-01 16:23:40 ./
     -rw-r--r-- tarek/staff     609 2008-06-09 13:26:54 ./authorized_keys
     -rwxr-xr-x tarek/staff      65 2008-06-09 13:26:54 ./config
     -rwx------ tarek/staff     668 2008-06-09 13:26:54 ./id_dsa
     -rwxr-xr-x tarek/staff     609 2008-06-09 13:26:54 ./id_dsa.pub
     -rw------- tarek/staff    1675 2008-06-09 13:26:54 ./id_rsa
     -rw-r--r-- tarek/staff     397 2008-06-09 13:26:54 ./id_rsa.pub
     -rw-r--r-- tarek/staff   37192 2010-02-06 18:23:10 ./known_hosts


File: python.info,  Node: Querying the size of the output terminal,  Prev: Archiving operations,  Up: shutil — High-level file operations

5.11.10.7 Querying the size of the output terminal
..................................................

 -- Function: shutil.get_terminal_size (fallback=(columns, lines))

     Get the size of the terminal window.

     For each of the two dimensions, the environment variable, ‘COLUMNS’
     and ‘LINES’ respectively, is checked.  If the variable is defined
     and the value is a positive integer, it is used.

     When ‘COLUMNS’ or ‘LINES’ is not defined, which is the common case,
     the terminal connected to *note sys.__stdout__: 1bd3. is queried by
     invoking *note os.get_terminal_size(): a3e.

     If the terminal size cannot be successfully queried, either because
     the system doesn’t support querying, or because we are not
     connected to a terminal, the value given in ‘fallback’ parameter is
     used.  ‘fallback’ defaults to ‘(80, 24)’ which is the default size
     used by many terminal emulators.

     The value returned is a named tuple of type *note os.terminal_size:
     1bd4.

     See also: The Single UNIX Specification, Version 2, Other
     Environment Variables(1).

     New in version 3.3.

See also
........

Module *note os: c4.

     Operating system interfaces, including functions to work with files
     at a lower level than Python *note file objects: b35.

Module *note io: a1.

     Python’s built-in I/O library, including both abstract classes and
     some concrete classes such as file I/O.

Built-in function *note open(): 4e5.

     The standard way to open files for reading and writing with Python.

   ---------- Footnotes ----------

   (1) 
http://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003


File: python.info,  Node: Data Persistence,  Next: Data Compression and Archiving,  Prev: File and Directory Access,  Up: The Python Standard Library

5.12 Data Persistence
=====================

The modules described in this chapter support storing Python data in a
persistent form on disk.  The *note pickle: ca. and *note marshal: b0.
modules can turn many Python data types into a stream of bytes and then
recreate the objects from the bytes.  The various DBM-related modules
support a family of hash-based file formats that store a mapping of
strings to other strings.

The list of modules described in this chapter is:

* Menu:

* pickle — Python object serialization::
* copyreg — Register pickle support functions::
* shelve — Python object persistence::
* marshal — Internal Python object serialization::
* dbm — Interfaces to Unix “databases”::
* sqlite3 — DB-API 2.0 interface for SQLite databases: sqlite3 — DB-API 2 0 interface for SQLite databases.


File: python.info,  Node: pickle — Python object serialization,  Next: copyreg — Register pickle support functions,  Up: Data Persistence

5.12.1 ‘pickle’ — Python object serialization
---------------------------------------------

`Source code:' Lib/pickle.py(1)

__________________________________________________________________

The *note pickle: ca. module implements binary protocols for serializing
and de-serializing a Python object structure.  `“Pickling”' is the
process whereby a Python object hierarchy is converted into a byte
stream, and `“unpickling”' is the inverse operation, whereby a byte
stream (from a *note binary file: 1bdb. or *note bytes-like object:
5dd.) is converted back into an object hierarchy.  Pickling (and
unpickling) is alternatively known as “serialization”, “marshalling,”
(2) or “flattening”; however, to avoid confusion, the terms used here
are “pickling” and “unpickling”.

     Warning: The ‘pickle’ module `is not secure'.  Only unpickle data
     you trust.

     It is possible to construct malicious pickle data which will
     `execute arbitrary code during unpickling'.  Never unpickle data
     that could have come from an untrusted source, or that could have
     been tampered with.

     Consider signing data with *note hmac: 8f. if you need to ensure
     that it has not been tampered with.

     Safer serialization formats such as *note json: a4. may be more
     appropriate if you are processing untrusted data.  See *note
     Comparison with json: 1bdc.

* Menu:

* Relationship to other Python modules::
* Data stream format::
* Module Interface::
* What can be pickled and unpickled?::
* Pickling Class Instances::
* Custom Reduction for Types, Functions, and Other Objects: Custom Reduction for Types Functions and Other Objects.
* Out-of-band Buffers::
* Restricting Globals::
* Performance: Performance<2>.
* Examples: Examples<4>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pickle.py

   (2) (1) Don’t confuse this with the *note marshal: b0. module


File: python.info,  Node: Relationship to other Python modules,  Next: Data stream format,  Up: pickle — Python object serialization

5.12.1.1 Relationship to other Python modules
.............................................

* Menu:

* Comparison with marshal::
* Comparison with json::


File: python.info,  Node: Comparison with marshal,  Next: Comparison with json,  Up: Relationship to other Python modules

5.12.1.2 Comparison with ‘marshal’
..................................

Python has a more primitive serialization module called *note marshal:
b0, but in general *note pickle: ca. should always be the preferred way
to serialize Python objects.  *note marshal: b0. exists primarily to
support Python’s ‘.pyc’ files.

The *note pickle: ca. module differs from *note marshal: b0. in several
significant ways:

   * The *note pickle: ca. module keeps track of the objects it has
     already serialized, so that later references to the same object
     won’t be serialized again.  *note marshal: b0. doesn’t do this.

     This has implications both for recursive objects and object
     sharing.  Recursive objects are objects that contain references to
     themselves.  These are not handled by marshal, and in fact,
     attempting to marshal recursive objects will crash your Python
     interpreter.  Object sharing happens when there are multiple
     references to the same object in different places in the object
     hierarchy being serialized.  *note pickle: ca. stores such objects
     only once, and ensures that all other references point to the
     master copy.  Shared objects remain shared, which can be very
     important for mutable objects.

   * *note marshal: b0. cannot be used to serialize user-defined classes
     and their instances.  *note pickle: ca. can save and restore class
     instances transparently, however the class definition must be
     importable and live in the same module as when the object was
     stored.

   * The *note marshal: b0. serialization format is not guaranteed to be
     portable across Python versions.  Because its primary job in life
     is to support ‘.pyc’ files, the Python implementers reserve the
     right to change the serialization format in non-backwards
     compatible ways should the need arise.  The *note pickle: ca.
     serialization format is guaranteed to be backwards compatible
     across Python releases provided a compatible pickle protocol is
     chosen and pickling and unpickling code deals with Python 2 to
     Python 3 type differences if your data is crossing that unique
     breaking change language boundary.


File: python.info,  Node: Comparison with json,  Prev: Comparison with marshal,  Up: Relationship to other Python modules

5.12.1.3 Comparison with ‘json’
...............................

There are fundamental differences between the pickle protocols and JSON
(JavaScript Object Notation)(1):

   * JSON is a text serialization format (it outputs unicode text,
     although most of the time it is then encoded to ‘utf-8’), while
     pickle is a binary serialization format;

   * JSON is human-readable, while pickle is not;

   * JSON is interoperable and widely used outside of the Python
     ecosystem, while pickle is Python-specific;

   * JSON, by default, can only represent a subset of the Python
     built-in types, and no custom classes; pickle can represent an
     extremely large number of Python types (many of them automatically,
     by clever usage of Python’s introspection facilities; complex cases
     can be tackled by implementing *note specific object APIs: 1be0.);

   * Unlike pickle, deserializing untrusted JSON does not in itself
     create an arbitrary code execution vulnerability.

See also
........

The *note json: a4. module: a standard library module allowing JSON
serialization and deserialization.

   ---------- Footnotes ----------

   (1) http://json.org


File: python.info,  Node: Data stream format,  Next: Module Interface,  Prev: Relationship to other Python modules,  Up: pickle — Python object serialization

5.12.1.4 Data stream format
...........................

The data format used by *note pickle: ca. is Python-specific.  This has
the advantage that there are no restrictions imposed by external
standards such as JSON or XDR (which can’t represent pointer sharing);
however it means that non-Python programs may not be able to reconstruct
pickled Python objects.

By default, the *note pickle: ca. data format uses a relatively compact
binary representation.  If you need optimal size characteristics, you
can efficiently *note compress: 1be2. pickled data.

The module *note pickletools: cb. contains tools for analyzing data
streams generated by *note pickle: ca.  *note pickletools: cb. source
code has extensive comments about opcodes used by pickle protocols.

There are currently 6 different protocols which can be used for
pickling.  The higher the protocol used, the more recent the version of
Python needed to read the pickle produced.

   * Protocol version 0 is the original “human-readable” protocol and is
     backwards compatible with earlier versions of Python.

   * Protocol version 1 is an old binary format which is also compatible
     with earlier versions of Python.

   * Protocol version 2 was introduced in Python 2.3.  It provides much
     more efficient pickling of *note new-style class: 1be3.es.  Refer
     to PEP 307(1) for information about improvements brought by
     protocol 2.

   * Protocol version 3 was added in Python 3.0.  It has explicit
     support for *note bytes: 326. objects and cannot be unpickled by
     Python 2.x.  This was the default protocol in Python 3.0–3.7.

   * Protocol version 4 was added in Python 3.4.  It adds support for
     very large objects, pickling more kinds of objects, and some data
     format optimizations.  It is the default protocol starting with
     Python 3.8.  Refer to PEP 3154(2) for information about
     improvements brought by protocol 4.

   * Protocol version 5 was added in Python 3.8.  It adds support for
     out-of-band data and speedup for in-band data.  Refer to PEP 574(3)
     for information about improvements brought by protocol 5.

     Note: Serialization is a more primitive notion than persistence;
     although *note pickle: ca. reads and writes file objects, it does
     not handle the issue of naming persistent objects, nor the (even
     more complicated) issue of concurrent access to persistent objects.
     The *note pickle: ca. module can transform a complex object into a
     byte stream and it can transform the byte stream into an object
     with the same internal structure.  Perhaps the most obvious thing
     to do with these byte streams is to write them onto a file, but it
     is also conceivable to send them across a network or store them in
     a database.  The *note shelve: e7. module provides a simple
     interface to pickle and unpickle objects on DBM-style database
     files.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0307

   (2) https://www.python.org/dev/peps/pep-3154

   (3) https://www.python.org/dev/peps/pep-0574


File: python.info,  Node: Module Interface,  Next: What can be pickled and unpickled?,  Prev: Data stream format,  Up: pickle — Python object serialization

5.12.1.5 Module Interface
.........................

To serialize an object hierarchy, you simply call the *note dumps():
df2. function.  Similarly, to de-serialize a data stream, you call the
*note loads(): 5b8. function.  However, if you want more control over
serialization and de-serialization, you can create a *note Pickler: 20b.
or an *note Unpickler: 1be5. object, respectively.

The *note pickle: ca. module provides the following constants:

 -- Data: pickle.HIGHEST_PROTOCOL

     An integer, the highest *note protocol version: 563. available.
     This value can be passed as a `protocol' value to functions *note
     dump(): 1be6. and *note dumps(): df2. as well as the *note Pickler:
     20b. constructor.

 -- Data: pickle.DEFAULT_PROTOCOL

     An integer, the default *note protocol version: 563. used for
     pickling.  May be less than *note HIGHEST_PROTOCOL: df3.  Currently
     the default protocol is 4, first introduced in Python 3.4 and
     incompatible with previous versions.

     Changed in version 3.0: The default protocol is 3.

     Changed in version 3.8: The default protocol is 4.

The *note pickle: ca. module provides the following functions to make
the pickling process more convenient:

 -- Function: pickle.dump (obj, file, protocol=None, *,
          fix_imports=True, buffer_callback=None)

     Write the pickled representation of the object `obj' to the open
     *note file object: b35. `file'.  This is equivalent to
     ‘Pickler(file, protocol).dump(obj)’.

     Arguments `file', `protocol', `fix_imports' and `buffer_callback'
     have the same meaning as in the *note Pickler: 20b. constructor.

     Changed in version 3.8: The `buffer_callback' argument was added.

 -- Function: pickle.dumps (obj, protocol=None, *, fix_imports=True,
          buffer_callback=None)

     Return the pickled representation of the object `obj' as a *note
     bytes: 326. object, instead of writing it to a file.

     Arguments `protocol', `fix_imports' and `buffer_callback' have the
     same meaning as in the *note Pickler: 20b. constructor.

     Changed in version 3.8: The `buffer_callback' argument was added.

 -- Function: pickle.load (file, *, fix_imports=True, encoding="ASCII",
          errors="strict", buffers=None)

     Read the pickled representation of an object from the open *note
     file object: b35. `file' and return the reconstituted object
     hierarchy specified therein.  This is equivalent to
     ‘Unpickler(file).load()’.

     The protocol version of the pickle is detected automatically, so no
     protocol argument is needed.  Bytes past the pickled representation
     of the object are ignored.

     Arguments `file', `fix_imports', `encoding', `errors', `strict' and
     `buffers' have the same meaning as in the *note Unpickler: 1be5.
     constructor.

     Changed in version 3.8: The `buffers' argument was added.

 -- Function: pickle.loads (bytes_object, *, fix_imports=True,
          encoding="ASCII", errors="strict", buffers=None)

     Return the reconstituted object hierarchy of the pickled
     representation `bytes_object' of an object.

     The protocol version of the pickle is detected automatically, so no
     protocol argument is needed.  Bytes past the pickled representation
     of the object are ignored.

     Arguments `file', `fix_imports', `encoding', `errors', `strict' and
     `buffers' have the same meaning as in the *note Unpickler: 1be5.
     constructor.

     Changed in version 3.8: The `buffers' argument was added.

The *note pickle: ca. module defines three exceptions:

 -- Exception: pickle.PickleError

     Common base class for the other pickling exceptions.  It inherits
     *note Exception: 1a8.

 -- Exception: pickle.PicklingError

     Error raised when an unpicklable object is encountered by *note
     Pickler: 20b.  It inherits *note PickleError: 1be8.

     Refer to *note What can be pickled and unpickled?: 1bea. to learn
     what kinds of objects can be pickled.

 -- Exception: pickle.UnpicklingError

     Error raised when there is a problem unpickling an object, such as
     a data corruption or a security violation.  It inherits *note
     PickleError: 1be8.

     Note that other exceptions may also be raised during unpickling,
     including (but not necessarily limited to) AttributeError,
     EOFError, ImportError, and IndexError.

The *note pickle: ca. module exports three classes, *note Pickler: 20b,
*note Unpickler: 1be5. and *note PickleBuffer: 1bec.:

 -- Class: pickle.Pickler (file, protocol=None, *, fix_imports=True,
          buffer_callback=None)

     This takes a binary file for writing a pickle data stream.

     The optional `protocol' argument, an integer, tells the pickler to
     use the given protocol; supported protocols are 0 to *note
     HIGHEST_PROTOCOL: df3.  If not specified, the default is *note
     DEFAULT_PROTOCOL: 1be7.  If a negative number is specified, *note
     HIGHEST_PROTOCOL: df3. is selected.

     The `file' argument must have a write() method that accepts a
     single bytes argument.  It can thus be an on-disk file opened for
     binary writing, an *note io.BytesIO: 78f. instance, or any other
     custom object that meets this interface.

     If `fix_imports' is true and `protocol' is less than 3, pickle will
     try to map the new Python 3 names to the old module names used in
     Python 2, so that the pickle data stream is readable with Python 2.

     If `buffer_callback' is None (the default), buffer views are
     serialized into `file' as part of the pickle stream.

     If `buffer_callback' is not None, then it can be called any number
     of times with a buffer view.  If the callback returns a false value
     (such as None), the given buffer is *note out-of-band: 1bed.;
     otherwise the buffer is serialized in-band, i.e.  inside the pickle
     stream.

     It is an error if `buffer_callback' is not None and `protocol' is
     None or smaller than 5.

     Changed in version 3.8: The `buffer_callback' argument was added.

      -- Method: dump (obj)

          Write the pickled representation of `obj' to the open file
          object given in the constructor.

      -- Method: persistent_id (obj)

          Do nothing by default.  This exists so a subclass can override
          it.

          If *note persistent_id(): 1bee. returns ‘None’, `obj' is
          pickled as usual.  Any other value causes *note Pickler: 20b.
          to emit the returned value as a persistent ID for `obj'.  The
          meaning of this persistent ID should be defined by *note
          Unpickler.persistent_load(): 1bef.  Note that the value
          returned by *note persistent_id(): 1bee. cannot itself have a
          persistent ID.

          See *note Persistence of External Objects: 1bf0. for details
          and examples of uses.

      -- Attribute: dispatch_table

          A pickler object’s dispatch table is a registry of `reduction
          functions' of the kind which can be declared using *note
          copyreg.pickle(): 1bf1.  It is a mapping whose keys are
          classes and whose values are reduction functions.  A reduction
          function takes a single argument of the associated class and
          should conform to the same interface as a *note __reduce__():
          19a. method.

          By default, a pickler object will not have a *note
          dispatch_table: a5e. attribute, and it will instead use the
          global dispatch table managed by the *note copyreg: 27.
          module.  However, to customize the pickling for a specific
          pickler object one can set the *note dispatch_table: a5e.
          attribute to a dict-like object.  Alternatively, if a subclass
          of *note Pickler: 20b. has a *note dispatch_table: a5e.
          attribute then this will be used as the default dispatch table
          for instances of that class.

          See *note Dispatch Tables: 1bf2. for usage examples.

          New in version 3.3.

      -- Method: reducer_override (self, obj)

          Special reducer that can be defined in *note Pickler: 20b.
          subclasses.  This method has priority over any reducer in the
          *note dispatch_table: a5e.  It should conform to the same
          interface as a *note __reduce__(): 19a. method, and can
          optionally return ‘NotImplemented’ to fallback on *note
          dispatch_table: a5e.-registered reducers to pickle ‘obj’.

          For a detailed example, see *note Custom Reduction for Types,
          Functions, and Other Objects: 1bf3.

          New in version 3.8.

      -- Attribute: fast

          Deprecated.  Enable fast mode if set to a true value.  The
          fast mode disables the usage of memo, therefore speeding the
          pickling process by not generating superfluous PUT opcodes.
          It should not be used with self-referential objects, doing
          otherwise will cause *note Pickler: 20b. to recurse
          infinitely.

          Use *note pickletools.optimize(): 1bf5. if you need more
          compact pickles.

 -- Class: pickle.Unpickler (file, *, fix_imports=True,
          encoding="ASCII", errors="strict", buffers=None)

     This takes a binary file for reading a pickle data stream.

     The protocol version of the pickle is detected automatically, so no
     protocol argument is needed.

     The argument `file' must have three methods, a read() method that
     takes an integer argument, a readinto() method that takes a buffer
     argument and a readline() method that requires no arguments, as in
     the *note io.BufferedIOBase: 57d. interface.  Thus `file' can be an
     on-disk file opened for binary reading, an *note io.BytesIO: 78f.
     object, or any other custom object that meets this interface.

     The optional arguments `fix_imports', `encoding' and `errors' are
     used to control compatibility support for pickle stream generated
     by Python 2.  If `fix_imports' is true, pickle will try to map the
     old Python 2 names to the new names used in Python 3.  The
     `encoding' and `errors' tell pickle how to decode 8-bit string
     instances pickled by Python 2; these default to ‘ASCII’ and
     ‘strict’, respectively.  The `encoding' can be ‘bytes’ to read
     these 8-bit string instances as bytes objects.  Using
     ‘encoding='latin1'’ is required for unpickling NumPy arrays and
     instances of *note datetime: 194, *note date: 193. and *note time:
     4e8. pickled by Python 2.

     If `buffers' is None (the default), then all data necessary for
     deserialization must be contained in the pickle stream.  This means
     that the `buffer_callback' argument was None when a *note Pickler:
     20b. was instantiated (or when *note dump(): 1be6. or *note
     dumps(): df2. was called).

     If `buffers' is not None, it should be an iterable of
     buffer-enabled objects that is consumed each time the pickle stream
     references an *note out-of-band: 1bed. buffer view.  Such buffers
     have been given in order to the `buffer_callback' of a Pickler
     object.

     Changed in version 3.8: The `buffers' argument was added.

      -- Method: load ()

          Read the pickled representation of an object from the open
          file object given in the constructor, and return the
          reconstituted object hierarchy specified therein.  Bytes past
          the pickled representation of the object are ignored.

      -- Method: persistent_load (pid)

          Raise an *note UnpicklingError: 1beb. by default.

          If defined, *note persistent_load(): 1bef. should return the
          object specified by the persistent ID `pid'.  If an invalid
          persistent ID is encountered, an *note UnpicklingError: 1beb.
          should be raised.

          See *note Persistence of External Objects: 1bf0. for details
          and examples of uses.

      -- Method: find_class (module, name)

          Import `module' if necessary and return the object called
          `name' from it, where the `module' and `name' arguments are
          *note str: 325. objects.  Note, unlike its name suggests,
          *note find_class(): 1bf7. is also used for finding functions.

          Subclasses may override this to gain control over what type of
          objects and how they can be loaded, potentially reducing
          security risks.  Refer to *note Restricting Globals: 1bf8. for
          details.

          Raises an *note auditing event: 1275. ‘pickle.find_class’ with
          arguments ‘module’, ‘name’.

 -- Class: pickle.PickleBuffer (buffer)

     A wrapper for a buffer representing picklable data.  `buffer' must
     be a *note buffer-providing: 1579. object, such as a *note
     bytes-like object: 5dd. or a N-dimensional array.

     *note PickleBuffer: 1bec. is itself a buffer provider, therefore it
     is possible to pass it to other APIs expecting a buffer-providing
     object, such as *note memoryview: 25a.

     *note PickleBuffer: 1bec. objects can only be serialized using
     pickle protocol 5 or higher.  They are eligible for *note
     out-of-band serialization: 1bed.

     New in version 3.8.

      -- Method: raw ()

          Return a *note memoryview: 25a. of the memory area underlying
          this buffer.  The returned object is a one-dimensional,
          C-contiguous memoryview with format ‘B’ (unsigned bytes).
          *note BufferError: 163c. is raised if the buffer is neither C-
          nor Fortran-contiguous.

      -- Method: release ()

          Release the underlying buffer exposed by the PickleBuffer
          object.


File: python.info,  Node: What can be pickled and unpickled?,  Next: Pickling Class Instances,  Prev: Module Interface,  Up: pickle — Python object serialization

5.12.1.6 What can be pickled and unpickled?
...........................................

The following types can be pickled:

   * ‘None’, ‘True’, and ‘False’

   * integers, floating point numbers, complex numbers

   * strings, bytes, bytearrays

   * tuples, lists, sets, and dictionaries containing only picklable
     objects

   * functions defined at the top level of a module (using *note def:
     db1, not *note lambda: c22.)

   * built-in functions defined at the top level of a module

   * classes that are defined at the top level of a module

   * instances of such classes whose *note __dict__: 4f1. or the result
     of calling *note __getstate__(): df4. is picklable (see section
     *note Pickling Class Instances: 1be0. for details).

Attempts to pickle unpicklable objects will raise the *note
PicklingError: 1be9. exception; when this happens, an unspecified number
of bytes may have already been written to the underlying file.  Trying
to pickle a highly recursive data structure may exceed the maximum
recursion depth, a *note RecursionError: 628. will be raised in this
case.  You can carefully raise this limit with *note
sys.setrecursionlimit(): e6f.

Note that functions (built-in and user-defined) are pickled by “fully
qualified” name reference, not by value.  (1) This means that only the
function name is pickled, along with the name of the module the function
is defined in.  Neither the function’s code, nor any of its function
attributes are pickled.  Thus the defining module must be importable in
the unpickling environment, and the module must contain the named
object, otherwise an exception will be raised.  (2)

Similarly, classes are pickled by named reference, so the same
restrictions in the unpickling environment apply.  Note that none of the
class’s code or data is pickled, so in the following example the class
attribute ‘attr’ is not restored in the unpickling environment:

     class Foo:
         attr = 'A class attribute'

     picklestring = pickle.dumps(Foo)

These restrictions are why picklable functions and classes must be
defined in the top level of a module.

Similarly, when class instances are pickled, their class’s code and data
are not pickled along with them.  Only the instance data are pickled.
This is done on purpose, so you can fix bugs in a class or add methods
to the class and still load objects that were created with an earlier
version of the class.  If you plan to have long-lived objects that will
see many versions of a class, it may be worthwhile to put a version
number in the objects so that suitable conversions can be made by the
class’s *note __setstate__(): 19b. method.

   ---------- Footnotes ----------

   (1) (2) This is why *note lambda: c22. functions cannot be pickled:
all ‘lambda’ functions share the same name: ‘<lambda>’.

   (2) (3) The exception raised will likely be an *note ImportError:
329. or an *note AttributeError: 390. but it could be something else.


File: python.info,  Node: Pickling Class Instances,  Next: Custom Reduction for Types Functions and Other Objects,  Prev: What can be pickled and unpickled?,  Up: pickle — Python object serialization

5.12.1.7 Pickling Class Instances
.................................

In this section, we describe the general mechanisms available to you to
define, customize, and control how class instances are pickled and
unpickled.

In most cases, no additional code is needed to make instances picklable.
By default, pickle will retrieve the class and the attributes of an
instance via introspection.  When a class instance is unpickled, its
*note __init__(): d51. method is usually `not' invoked.  The default
behaviour first creates an uninitialized instance and then restores the
saved attributes.  The following code shows an implementation of this
behaviour:

     def save(obj):
         return (obj.__class__, obj.__dict__)

     def load(cls, attributes):
         obj = cls.__new__(cls)
         obj.__dict__.update(attributes)
         return obj

Classes can alter the default behaviour by providing one or several
special methods:

 -- Method: object.__getnewargs_ex__ ()

     In protocols 2 and newer, classes that implements the *note
     __getnewargs_ex__(): 1bfd. method can dictate the values passed to
     the *note __new__(): 87d. method upon unpickling.  The method must
     return a pair ‘(args, kwargs)’ where `args' is a tuple of
     positional arguments and `kwargs' a dictionary of named arguments
     for constructing the object.  Those will be passed to the *note
     __new__(): 87d. method upon unpickling.

     You should implement this method if the *note __new__(): 87d.
     method of your class requires keyword-only arguments.  Otherwise,
     it is recommended for compatibility to implement *note
     __getnewargs__(): 6a2.

     Changed in version 3.6: *note __getnewargs_ex__(): 1bfd. is now
     used in protocols 2 and 3.

 -- Method: object.__getnewargs__ ()

     This method serves a similar purpose as *note __getnewargs_ex__():
     1bfd, but supports only positional arguments.  It must return a
     tuple of arguments ‘args’ which will be passed to the *note
     __new__(): 87d. method upon unpickling.

     *note __getnewargs__(): 6a2. will not be called if *note
     __getnewargs_ex__(): 1bfd. is defined.

     Changed in version 3.6: Before Python 3.6, *note __getnewargs__():
     6a2. was called instead of *note __getnewargs_ex__(): 1bfd. in
     protocols 2 and 3.

 -- Method: object.__getstate__ ()

     Classes can further influence how their instances are pickled; if
     the class defines the method *note __getstate__(): df4, it is
     called and the returned object is pickled as the contents for the
     instance, instead of the contents of the instance’s dictionary.  If
     the *note __getstate__(): df4. method is absent, the instance’s
     *note __dict__: 4f1. is pickled as usual.

 -- Method: object.__setstate__ (state)

     Upon unpickling, if the class defines *note __setstate__(): 19b, it
     is called with the unpickled state.  In that case, there is no
     requirement for the state object to be a dictionary.  Otherwise,
     the pickled state must be a dictionary and its items are assigned
     to the new instance’s dictionary.

          Note: If *note __getstate__(): df4. returns a false value, the
          *note __setstate__(): 19b. method will not be called upon
          unpickling.

Refer to the section *note Handling Stateful Objects: 1bfe. for more
information about how to use the methods *note __getstate__(): df4. and
*note __setstate__(): 19b.

     Note: At unpickling time, some methods like *note __getattr__():
     30f, *note __getattribute__(): 43e, or *note __setattr__(): e1f.
     may be called upon the instance.  In case those methods rely on
     some internal invariant being true, the type should implement *note
     __getnewargs__(): 6a2. or *note __getnewargs_ex__(): 1bfd. to
     establish such an invariant; otherwise, neither *note __new__():
     87d. nor *note __init__(): d51. will be called.

As we shall see, pickle does not use directly the methods described
above.  In fact, these methods are part of the copy protocol which
implements the *note __reduce__(): 19a. special method.  The copy
protocol provides a unified interface for retrieving the data necessary
for pickling and copying objects.  (1)

Although powerful, implementing *note __reduce__(): 19a. directly in
your classes is error prone.  For this reason, class designers should
use the high-level interface (i.e., *note __getnewargs_ex__(): 1bfd,
*note __getstate__(): df4. and *note __setstate__(): 19b.) whenever
possible.  We will show, however, cases where using *note __reduce__():
19a. is the only option or leads to more efficient pickling or both.

 -- Method: object.__reduce__ ()

     The interface is currently defined as follows.  The *note
     __reduce__(): 19a. method takes no argument and shall return either
     a string or preferably a tuple (the returned object is often
     referred to as the “reduce value”).

     If a string is returned, the string should be interpreted as the
     name of a global variable.  It should be the object’s local name
     relative to its module; the pickle module searches the module
     namespace to determine the object’s module.  This behaviour is
     typically useful for singletons.

     When a tuple is returned, it must be between two and six items
     long.  Optional items can either be omitted, or ‘None’ can be
     provided as their value.  The semantics of each item are in order:

        * A callable object that will be called to create the initial
          version of the object.

        * A tuple of arguments for the callable object.  An empty tuple
          must be given if the callable does not accept any argument.

        * Optionally, the object’s state, which will be passed to the
          object’s *note __setstate__(): 19b. method as previously
          described.  If the object has no such method then, the value
          must be a dictionary and it will be added to the object’s
          *note __dict__: 4f1. attribute.

        * Optionally, an iterator (and not a sequence) yielding
          successive items.  These items will be appended to the object
          either using ‘obj.append(item)’ or, in batch, using
          ‘obj.extend(list_of_items)’.  This is primarily used for list
          subclasses, but may be used by other classes as long as they
          have ‘append()’ and ‘extend()’ methods with the appropriate
          signature.  (Whether ‘append()’ or ‘extend()’ is used depends
          on which pickle protocol version is used as well as the number
          of items to append, so both must be supported.)

        * Optionally, an iterator (not a sequence) yielding successive
          key-value pairs.  These items will be stored to the object
          using ‘obj[key] = value’.  This is primarily used for
          dictionary subclasses, but may be used by other classes as
          long as they implement *note __setitem__(): c55.

        * Optionally, a callable with a ‘(obj, state)’ signature.  This
          callable allows the user to programmatically control the
          state-updating behavior of a specific object, instead of using
          ‘obj’’s static *note __setstate__(): 19b. method.  If not
          ‘None’, this callable will have priority over ‘obj’’s *note
          __setstate__(): 19b.

          New in version 3.8: The optional sixth tuple item, ‘(obj,
          state)’, was added.

 -- Method: object.__reduce_ex__ (protocol)

     Alternatively, a *note __reduce_ex__(): 1931. method may be
     defined.  The only difference is this method should take a single
     integer argument, the protocol version.  When defined, pickle will
     prefer it over the *note __reduce__(): 19a. method.  In addition,
     *note __reduce__(): 19a. automatically becomes a synonym for the
     extended version.  The main use for this method is to provide
     backwards-compatible reduce values for older Python releases.

* Menu:

* Persistence of External Objects::
* Dispatch Tables::
* Handling Stateful Objects::

   ---------- Footnotes ----------

   (1) (4) The *note copy: 26. module uses this protocol for shallow and
deep copying operations.


File: python.info,  Node: Persistence of External Objects,  Next: Dispatch Tables,  Up: Pickling Class Instances

5.12.1.8 Persistence of External Objects
........................................

For the benefit of object persistence, the *note pickle: ca. module
supports the notion of a reference to an object outside the pickled data
stream.  Such objects are referenced by a persistent ID, which should be
either a string of alphanumeric characters (for protocol 0) (1) or just
an arbitrary object (for any newer protocol).

The resolution of such persistent IDs is not defined by the *note
pickle: ca. module; it will delegate this resolution to the user-defined
methods on the pickler and unpickler, *note persistent_id(): 1bee. and
*note persistent_load(): 1bef. respectively.

To pickle objects that have an external persistent ID, the pickler must
have a custom *note persistent_id(): 1bee. method that takes an object
as an argument and returns either ‘None’ or the persistent ID for that
object.  When ‘None’ is returned, the pickler simply pickles the object
as normal.  When a persistent ID string is returned, the pickler will
pickle that object, along with a marker so that the unpickler will
recognize it as a persistent ID.

To unpickle external objects, the unpickler must have a custom *note
persistent_load(): 1bef. method that takes a persistent ID object and
returns the referenced object.

Here is a comprehensive example presenting how persistent ID can be used
to pickle external objects by reference.

     # Simple example presenting how persistent ID can be used to pickle
     # external objects by reference.

     import pickle
     import sqlite3
     from collections import namedtuple

     # Simple class representing a record in our database.
     MemoRecord = namedtuple("MemoRecord", "key, task")

     class DBPickler(pickle.Pickler):

         def persistent_id(self, obj):
             # Instead of pickling MemoRecord as a regular class instance, we emit a
             # persistent ID.
             if isinstance(obj, MemoRecord):
                 # Here, our persistent ID is simply a tuple, containing a tag and a
                 # key, which refers to a specific record in the database.
                 return ("MemoRecord", obj.key)
             else:
                 # If obj does not have a persistent ID, return None. This means obj
                 # needs to be pickled as usual.
                 return None


     class DBUnpickler(pickle.Unpickler):

         def __init__(self, file, connection):
             super().__init__(file)
             self.connection = connection

         def persistent_load(self, pid):
             # This method is invoked whenever a persistent ID is encountered.
             # Here, pid is the tuple returned by DBPickler.
             cursor = self.connection.cursor()
             type_tag, key_id = pid
             if type_tag == "MemoRecord":
                 # Fetch the referenced record from the database and return it.
                 cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
                 key, task = cursor.fetchone()
                 return MemoRecord(key, task)
             else:
                 # Always raises an error if you cannot return the correct object.
                 # Otherwise, the unpickler will think None is the object referenced
                 # by the persistent ID.
                 raise pickle.UnpicklingError("unsupported persistent object")


     def main():
         import io
         import pprint

         # Initialize and populate our database.
         conn = sqlite3.connect(":memory:")
         cursor = conn.cursor()
         cursor.execute("CREATE TABLE memos(key INTEGER PRIMARY KEY, task TEXT)")
         tasks = (
             'give food to fish',
             'prepare group meeting',
             'fight with a zebra',
             )
         for task in tasks:
             cursor.execute("INSERT INTO memos VALUES(NULL, ?)", (task,))

         # Fetch the records to be pickled.
         cursor.execute("SELECT * FROM memos")
         memos = [MemoRecord(key, task) for key, task in cursor]
         # Save the records using our custom DBPickler.
         file = io.BytesIO()
         DBPickler(file).dump(memos)

         print("Pickled records:")
         pprint.pprint(memos)

         # Update a record, just for good measure.
         cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")

         # Load the records from the pickle data stream.
         file.seek(0)
         memos = DBUnpickler(file, conn).load()

         print("Unpickled records:")
         pprint.pprint(memos)


     if __name__ == '__main__':
         main()

   ---------- Footnotes ----------

   (1) (5) The limitation on alphanumeric characters is due to the fact
the persistent IDs, in protocol 0, are delimited by the newline
character.  Therefore if any kind of newline characters occurs in
persistent IDs, the resulting pickle will become unreadable.


File: python.info,  Node: Dispatch Tables,  Next: Handling Stateful Objects,  Prev: Persistence of External Objects,  Up: Pickling Class Instances

5.12.1.9 Dispatch Tables
........................

If one wants to customize pickling of some classes without disturbing
any other code which depends on pickling, then one can create a pickler
with a private dispatch table.

The global dispatch table managed by the *note copyreg: 27. module is
available as ‘copyreg.dispatch_table’.  Therefore, one may choose to use
a modified copy of ‘copyreg.dispatch_table’ as a private dispatch table.

For example

     f = io.BytesIO()
     p = pickle.Pickler(f)
     p.dispatch_table = copyreg.dispatch_table.copy()
     p.dispatch_table[SomeClass] = reduce_SomeClass

creates an instance of *note pickle.Pickler: 20b. with a private
dispatch table which handles the ‘SomeClass’ class specially.
Alternatively, the code

     class MyPickler(pickle.Pickler):
         dispatch_table = copyreg.dispatch_table.copy()
         dispatch_table[SomeClass] = reduce_SomeClass
     f = io.BytesIO()
     p = MyPickler(f)

does the same, but all instances of ‘MyPickler’ will by default share
the same dispatch table.  The equivalent code using the *note copyreg:
27. module is

     copyreg.pickle(SomeClass, reduce_SomeClass)
     f = io.BytesIO()
     p = pickle.Pickler(f)


File: python.info,  Node: Handling Stateful Objects,  Prev: Dispatch Tables,  Up: Pickling Class Instances

5.12.1.10 Handling Stateful Objects
...................................

Here’s an example that shows how to modify pickling behavior for a
class.  The ‘TextReader’ class opens a text file, and returns the line
number and line contents each time its ‘readline()’ method is called.
If a ‘TextReader’ instance is pickled, all attributes `except' the file
object member are saved.  When the instance is unpickled, the file is
reopened, and reading resumes from the last location.  The *note
__setstate__(): 19b. and *note __getstate__(): df4. methods are used to
implement this behavior.

     class TextReader:
         """Print and number lines in a text file."""

         def __init__(self, filename):
             self.filename = filename
             self.file = open(filename)
             self.lineno = 0

         def readline(self):
             self.lineno += 1
             line = self.file.readline()
             if not line:
                 return None
             if line.endswith('\n'):
                 line = line[:-1]
             return "%i: %s" % (self.lineno, line)

         def __getstate__(self):
             # Copy the object's state from self.__dict__ which contains
             # all our instance attributes. Always use the dict.copy()
             # method to avoid modifying the original state.
             state = self.__dict__.copy()
             # Remove the unpicklable entries.
             del state['file']
             return state

         def __setstate__(self, state):
             # Restore instance attributes (i.e., filename and lineno).
             self.__dict__.update(state)
             # Restore the previously opened file's state. To do so, we need to
             # reopen it and read from it until the line count is restored.
             file = open(self.filename)
             for _ in range(self.lineno):
                 file.readline()
             # Finally, save the file.
             self.file = file

A sample usage might be something like this:

     >>> reader = TextReader("hello.txt")
     >>> reader.readline()
     '1: Hello world!'
     >>> reader.readline()
     '2: I am line number two.'
     >>> new_reader = pickle.loads(pickle.dumps(reader))
     >>> new_reader.readline()
     '3: Goodbye!'


File: python.info,  Node: Custom Reduction for Types Functions and Other Objects,  Next: Out-of-band Buffers,  Prev: Pickling Class Instances,  Up: pickle — Python object serialization

5.12.1.11 Custom Reduction for Types, Functions, and Other Objects
..................................................................

New in version 3.8.

Sometimes, *note dispatch_table: a5e. may not be flexible enough.  In
particular we may want to customize pickling based on another criterion
than the object’s type, or we may want to customize the pickling of
functions and classes.

For those cases, it is possible to subclass from the *note Pickler: 20b.
class and implement a *note reducer_override(): 20c. method.  This
method can return an arbitrary reduction tuple (see *note __reduce__():
19a.).  It can alternatively return ‘NotImplemented’ to fallback to the
traditional behavior.

If both the *note dispatch_table: a5e. and *note reducer_override():
20c. are defined, then *note reducer_override(): 20c. method takes
priority.

     Note: For performance reasons, *note reducer_override(): 20c. may
     not be called for the following objects: ‘None’, ‘True’, ‘False’,
     and exact instances of *note int: 184, *note float: 187, *note
     bytes: 326, *note str: 325, *note dict: 1b6, *note set: b62, *note
     frozenset: be1, *note list: 260. and *note tuple: 473.

Here is a simple example where we allow pickling and reconstructing a
given class:

     import io
     import pickle

     class MyClass:
         my_attribute = 1

     class MyPickler(pickle.Pickler):
         def reducer_override(self, obj):
             """Custom reducer for MyClass."""
             if getattr(obj, "__name__", None) == "MyClass":
                 return type, (obj.__name__, obj.__bases__,
                               {'my_attribute': obj.my_attribute})
             else:
                 # For any other object, fallback to usual reduction
                 return NotImplemented

     f = io.BytesIO()
     p = MyPickler(f)
     p.dump(MyClass)

     del MyClass

     unpickled_class = pickle.loads(f.getvalue())

     assert isinstance(unpickled_class, type)
     assert unpickled_class.__name__ == "MyClass"
     assert unpickled_class.my_attribute == 1


File: python.info,  Node: Out-of-band Buffers,  Next: Restricting Globals,  Prev: Custom Reduction for Types Functions and Other Objects,  Up: pickle — Python object serialization

5.12.1.12 Out-of-band Buffers
.............................

New in version 3.8.

In some contexts, the *note pickle: ca. module is used to transfer
massive amounts of data.  Therefore, it can be important to minimize the
number of memory copies, to preserve performance and resource
consumption.  However, normal operation of the *note pickle: ca. module,
as it transforms a graph-like structure of objects into a sequential
stream of bytes, intrinsically involves copying data to and from the
pickle stream.

This constraint can be eschewed if both the `provider' (the
implementation of the object types to be transferred) and the `consumer'
(the implementation of the communications system) support the
out-of-band transfer facilities provided by pickle protocol 5 and
higher.

* Menu:

* Provider API::
* Consumer API::
* Example: Example<4>.


File: python.info,  Node: Provider API,  Next: Consumer API,  Up: Out-of-band Buffers

5.12.1.13 Provider API
......................

The large data objects to be pickled must implement a *note
__reduce_ex__(): 1931. method specialized for protocol 5 and higher,
which returns a *note PickleBuffer: 1bec. instance (instead of e.g.  a
*note bytes: 326. object) for any large data.

A *note PickleBuffer: 1bec. object `signals' that the underlying buffer
is eligible for out-of-band data transfer.  Those objects remain
compatible with normal usage of the *note pickle: ca. module.  However,
consumers can also opt-in to tell *note pickle: ca. that they will
handle those buffers by themselves.


File: python.info,  Node: Consumer API,  Next: Example<4>,  Prev: Provider API,  Up: Out-of-band Buffers

5.12.1.14 Consumer API
......................

A communications system can enable custom handling of the *note
PickleBuffer: 1bec. objects generated when serializing an object graph.

On the sending side, it needs to pass a `buffer_callback' argument to
*note Pickler: 20b. (or to the *note dump(): 1be6. or *note dumps():
df2. function), which will be called with each *note PickleBuffer: 1bec.
generated while pickling the object graph.  Buffers accumulated by the
`buffer_callback' will not see their data copied into the pickle stream,
only a cheap marker will be inserted.

On the receiving side, it needs to pass a `buffers' argument to *note
Unpickler: 1be5. (or to the *note load(): 5b7. or *note loads(): 5b8.
function), which is an iterable of the buffers which were passed to
`buffer_callback'.  That iterable should produce buffers in the same
order as they were passed to `buffer_callback'.  Those buffers will
provide the data expected by the reconstructors of the objects whose
pickling produced the original *note PickleBuffer: 1bec. objects.

Between the sending side and the receiving side, the communications
system is free to implement its own transfer mechanism for out-of-band
buffers.  Potential optimizations include the use of shared memory or
datatype-dependent compression.


File: python.info,  Node: Example<4>,  Prev: Consumer API,  Up: Out-of-band Buffers

5.12.1.15 Example
.................

Here is a trivial example where we implement a *note bytearray: 327.
subclass able to participate in out-of-band buffer pickling:

     class ZeroCopyByteArray(bytearray):

         def __reduce_ex__(self, protocol):
             if protocol >= 5:
                 return type(self)._reconstruct, (PickleBuffer(self),), None
             else:
                 # PickleBuffer is forbidden with pickle protocols <= 4.
                 return type(self)._reconstruct, (bytearray(self),)

         @classmethod
         def _reconstruct(cls, obj):
             with memoryview(obj) as m:
                 # Get a handle over the original buffer object
                 obj = m.obj
                 if type(obj) is cls:
                     # Original buffer object is a ZeroCopyByteArray, return it
                     # as-is.
                     return obj
                 else:
                     return cls(obj)

The reconstructor (the ‘_reconstruct’ class method) returns the buffer’s
providing object if it has the right type.  This is an easy way to
simulate zero-copy behaviour on this toy example.

On the consumer side, we can pickle those objects the usual way, which
when unserialized will give us a copy of the original object:

     b = ZeroCopyByteArray(b"abc")
     data = pickle.dumps(b, protocol=5)
     new_b = pickle.loads(data)
     print(b == new_b)  # True
     print(b is new_b)  # False: a copy was made

But if we pass a `buffer_callback' and then give back the accumulated
buffers when unserializing, we are able to get back the original object:

     b = ZeroCopyByteArray(b"abc")
     buffers = []
     data = pickle.dumps(b, protocol=5, buffer_callback=buffers.append)
     new_b = pickle.loads(data, buffers=buffers)
     print(b == new_b)  # True
     print(b is new_b)  # True: no copy was made

This example is limited by the fact that *note bytearray: 327. allocates
its own memory: you cannot create a *note bytearray: 327. instance that
is backed by another object’s memory.  However, third-party datatypes
such as NumPy arrays do not have this limitation, and allow use of
zero-copy pickling (or making as few copies as possible) when
transferring between distinct processes or systems.

See also
........

PEP 574(1) – Pickle protocol 5 with out-of-band data

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0574


File: python.info,  Node: Restricting Globals,  Next: Performance<2>,  Prev: Out-of-band Buffers,  Up: pickle — Python object serialization

5.12.1.16 Restricting Globals
.............................

By default, unpickling will import any class or function that it finds
in the pickle data.  For many applications, this behaviour is
unacceptable as it permits the unpickler to import and invoke arbitrary
code.  Just consider what this hand-crafted pickle data stream does when
loaded:

     >>> import pickle
     >>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
     hello world
     0

In this example, the unpickler imports the *note os.system(): db4.
function and then apply the string argument “echo hello world”.
Although this example is inoffensive, it is not difficult to imagine one
that could damage your system.

For this reason, you may want to control what gets unpickled by
customizing *note Unpickler.find_class(): 1bf7.  Unlike its name
suggests, *note Unpickler.find_class(): 1bf7. is called whenever a
global (i.e., a class or a function) is requested.  Thus it is possible
to either completely forbid globals or restrict them to a safe subset.

Here is an example of an unpickler allowing only few safe classes from
the *note builtins: 13. module to be loaded:

     import builtins
     import io
     import pickle

     safe_builtins = {
         'range',
         'complex',
         'set',
         'frozenset',
         'slice',
     }

     class RestrictedUnpickler(pickle.Unpickler):

         def find_class(self, module, name):
             # Only allow safe classes from builtins.
             if module == "builtins" and name in safe_builtins:
                 return getattr(builtins, name)
             # Forbid everything else.
             raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
                                          (module, name))

     def restricted_loads(s):
         """Helper function analogous to pickle.loads()."""
         return RestrictedUnpickler(io.BytesIO(s)).load()

A sample usage of our unpickler working has intended:

     >>> restricted_loads(pickle.dumps([1, 2, range(15)]))
     [1, 2, range(0, 15)]
     >>> restricted_loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
     Traceback (most recent call last):
       ...
     pickle.UnpicklingError: global 'os.system' is forbidden
     >>> restricted_loads(b'cbuiltins\neval\n'
     ...                  b'(S\'getattr(__import__("os"), "system")'
     ...                  b'("echo hello world")\'\ntR.')
     Traceback (most recent call last):
       ...
     pickle.UnpicklingError: global 'builtins.eval' is forbidden

As our examples shows, you have to be careful with what you allow to be
unpickled.  Therefore if security is a concern, you may want to consider
alternatives such as the marshalling API in *note xmlrpc.client: 13f. or
third-party solutions.


File: python.info,  Node: Performance<2>,  Next: Examples<4>,  Prev: Restricting Globals,  Up: pickle — Python object serialization

5.12.1.17 Performance
.....................

Recent versions of the pickle protocol (from protocol 2 and upwards)
feature efficient binary encodings for several common features and
built-in types.  Also, the *note pickle: ca. module has a transparent
optimizer written in C.


File: python.info,  Node: Examples<4>,  Prev: Performance<2>,  Up: pickle — Python object serialization

5.12.1.18 Examples
..................

For the simplest code, use the *note dump(): 1be6. and *note load():
5b7. functions.

     import pickle

     # An arbitrary collection of objects supported by pickle.
     data = {
         'a': [1, 2.0, 3, 4+6j],
         'b': ("character string", b"byte string"),
         'c': {None, True, False}
     }

     with open('data.pickle', 'wb') as f:
         # Pickle the 'data' dictionary using the highest protocol available.
         pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)

The following example reads the resulting pickled data.

     import pickle

     with open('data.pickle', 'rb') as f:
         # The protocol version used is detected automatically, so we do not
         # have to specify it.
         data = pickle.load(f)

See also
........

Module *note copyreg: 27.

     Pickle interface constructor registration for extension types.

Module *note pickletools: cb.

     Tools for working with and analyzing pickled data.

Module *note shelve: e7.

     Indexed databases of objects; uses *note pickle: ca.

Module *note copy: 26.

     Shallow and deep object copying.

Module *note marshal: b0.

     High-performance serialization of built-in types.


File: python.info,  Node: copyreg — Register pickle support functions,  Next: shelve — Python object persistence,  Prev: pickle — Python object serialization,  Up: Data Persistence

5.12.2 ‘copyreg’ — Register ‘pickle’ support functions
------------------------------------------------------

`Source code:' Lib/copyreg.py(1)

__________________________________________________________________

The *note copyreg: 27. module offers a way to define functions used
while pickling specific objects.  The *note pickle: ca. and *note copy:
26. modules use those functions when pickling/copying those objects.
The module provides configuration information about object constructors
which are not classes.  Such constructors may be factory functions or
class instances.

 -- Function: copyreg.constructor (object)

     Declares `object' to be a valid constructor.  If `object' is not
     callable (and hence not valid as a constructor), raises *note
     TypeError: 192.

 -- Function: copyreg.pickle (type, function, constructor=None)

     Declares that `function' should be used as a “reduction” function
     for objects of type `type'.  `function' should return either a
     string or a tuple containing two or three elements.

     The optional `constructor' parameter, if provided, is a callable
     object which can be used to reconstruct the object when called with
     the tuple of arguments returned by `function' at pickling time.
     *note TypeError: 192. will be raised if `object' is a class or
     `constructor' is not callable.

     See the *note pickle: ca. module for more details on the interface
     expected of `function' and `constructor'.  Note that the *note
     dispatch_table: a5e. attribute of a pickler object or subclass of
     *note pickle.Pickler: 20b. can also be used for declaring reduction
     functions.

* Menu:

* Example: Example<5>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/copyreg.py


File: python.info,  Node: Example<5>,  Up: copyreg — Register pickle support functions

5.12.2.1 Example
................

The example below would like to show how to register a pickle function
and how it will be used:

     >>> import copyreg, copy, pickle
     >>> class C(object):
     ...     def __init__(self, a):
     ...         self.a = a
     ...
     >>> def pickle_c(c):
     ...     print("pickling a C instance...")
     ...     return C, (c.a,)
     ...
     >>> copyreg.pickle(C, pickle_c)
     >>> c = C(1)
     >>> d = copy.copy(c)  # doctest: +SKIP
     pickling a C instance...
     >>> p = pickle.dumps(c)  # doctest: +SKIP
     pickling a C instance...


File: python.info,  Node: shelve — Python object persistence,  Next: marshal — Internal Python object serialization,  Prev: copyreg — Register pickle support functions,  Up: Data Persistence

5.12.3 ‘shelve’ — Python object persistence
-------------------------------------------

`Source code:' Lib/shelve.py(1)

__________________________________________________________________

A “shelf” is a persistent, dictionary-like object.  The difference with
“dbm” databases is that the values (not the keys!)  in a shelf can be
essentially arbitrary Python objects — anything that the *note pickle:
ca. module can handle.  This includes most class instances, recursive
data types, and objects containing lots of shared sub-objects.  The keys
are ordinary strings.

 -- Function: shelve.open (filename, flag='c', protocol=None,
          writeback=False)

     Open a persistent dictionary.  The filename specified is the base
     filename for the underlying database.  As a side-effect, an
     extension may be added to the filename and more than one file may
     be created.  By default, the underlying database file is opened for
     reading and writing.  The optional `flag' parameter has the same
     interpretation as the `flag' parameter of *note dbm.open(): 824.

     By default, version 3 pickles are used to serialize values.  The
     version of the pickle protocol can be specified with the `protocol'
     parameter.

     Because of Python semantics, a shelf cannot know when a mutable
     persistent-dictionary entry is modified.  By default modified
     objects are written `only' when assigned to the shelf (see *note
     Example: 1c12.).  If the optional `writeback' parameter is set to
     ‘True’, all entries accessed are also cached in memory, and written
     back on *note sync(): 1c13. and *note close(): 1c14.; this can make
     it handier to mutate mutable entries in the persistent dictionary,
     but, if many entries are accessed, it can consume vast amounts of
     memory for the cache, and it can make the close operation very slow
     since all accessed entries are written back (there is no way to
     determine which accessed entries are mutable, nor which ones were
     actually mutated).

          Note: Do not rely on the shelf being closed automatically;
          always call *note close(): 1c14. explicitly when you don’t
          need it any more, or use *note shelve.open(): 1c11. as a
          context manager:

               with shelve.open('spam') as db:
                   db['eggs'] = 'eggs'

     Warning: Because the *note shelve: e7. module is backed by *note
     pickle: ca, it is insecure to load a shelf from an untrusted
     source.  Like with pickle, loading a shelf can execute arbitrary
     code.

Shelf objects support all methods supported by dictionaries.  This eases
the transition from dictionary based scripts to those requiring
persistent storage.

Two additional methods are supported:

 -- Method: Shelf.sync ()

     Write back all entries in the cache if the shelf was opened with
     `writeback' set to *note True: 48f.  Also empty the cache and
     synchronize the persistent dictionary on disk, if feasible.  This
     is called automatically when the shelf is closed with *note
     close(): 1c14.

 -- Method: Shelf.close ()

     Synchronize and close the persistent `dict' object.  Operations on
     a closed shelf will fail with a *note ValueError: 1f9.

See also
........

Persistent dictionary recipe(2) with widely supported storage formats
and having the speed of native dictionaries.

* Menu:

* Restrictions::
* Example: Example<6>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/shelve.py

   (2) https://code.activestate.com/recipes/576642/


File: python.info,  Node: Restrictions,  Next: Example<6>,  Up: shelve — Python object persistence

5.12.3.1 Restrictions
.....................

   * The choice of which database package will be used (such as *note
     dbm.ndbm: 35. or *note dbm.gnu: 34.) depends on which interface is
     available.  Therefore it is not safe to open the database directly
     using *note dbm: 32.  The database is also (unfortunately) subject
     to the limitations of *note dbm: 32, if it is used — this means
     that (the pickled representation of) the objects stored in the
     database should be fairly small, and in rare cases key collisions
     may cause the database to refuse updates.

   * The *note shelve: e7. module does not support `concurrent'
     read/write access to shelved objects.  (Multiple simultaneous read
     accesses are safe.)  When a program has a shelf open for writing,
     no other program should have it open for reading or writing.  Unix
     file locking can be used to solve this, but this differs across
     Unix versions and requires knowledge about the database
     implementation used.

 -- Class: shelve.Shelf (dict, protocol=None, writeback=False,
          keyencoding='utf-8')

     A subclass of *note collections.abc.MutableMapping: 9e3. which
     stores pickled values in the `dict' object.

     By default, version 3 pickles are used to serialize values.  The
     version of the pickle protocol can be specified with the `protocol'
     parameter.  See the *note pickle: ca. documentation for a
     discussion of the pickle protocols.

     If the `writeback' parameter is ‘True’, the object will hold a
     cache of all entries accessed and write them back to the `dict' at
     sync and close times.  This allows natural operations on mutable
     entries, but can consume much more memory and make sync and close
     take a long time.

     The `keyencoding' parameter is the encoding used to encode keys
     before they are used with the underlying dict.

     A *note Shelf: 8a4. object can also be used as a context manager,
     in which case it will be automatically closed when the *note with:
     6dd. block ends.

     Changed in version 3.2: Added the `keyencoding' parameter;
     previously, keys were always encoded in UTF-8.

     Changed in version 3.4: Added context manager support.

 -- Class: shelve.BsdDbShelf (dict, protocol=None, writeback=False,
          keyencoding='utf-8')

     A subclass of *note Shelf: 8a4. which exposes ‘first()’, ‘next()’,
     ‘previous()’, ‘last()’ and ‘set_location()’ which are available in
     the third-party ‘bsddb’ module from pybsddb(1) but not in other
     database modules.  The `dict' object passed to the constructor must
     support those methods.  This is generally accomplished by calling
     one of ‘bsddb.hashopen()’, ‘bsddb.btopen()’ or ‘bsddb.rnopen()’.
     The optional `protocol', `writeback', and `keyencoding' parameters
     have the same interpretation as for the *note Shelf: 8a4. class.

 -- Class: shelve.DbfilenameShelf (filename, flag='c', protocol=None,
          writeback=False)

     A subclass of *note Shelf: 8a4. which accepts a `filename' instead
     of a dict-like object.  The underlying file will be opened using
     *note dbm.open(): 824.  By default, the file will be created and
     opened for both read and write.  The optional `flag' parameter has
     the same interpretation as for the *note open(): 1c11. function.
     The optional `protocol' and `writeback' parameters have the same
     interpretation as for the *note Shelf: 8a4. class.

   ---------- Footnotes ----------

   (1) https://www.jcea.es/programacion/pybsddb.htm


File: python.info,  Node: Example<6>,  Prev: Restrictions,  Up: shelve — Python object persistence

5.12.3.2 Example
................

To summarize the interface (‘key’ is a string, ‘data’ is an arbitrary
object):

     import shelve

     d = shelve.open(filename)  # open -- file may get suffix added by low-level
                                # library

     d[key] = data              # store data at key (overwrites old data if
                                # using an existing key)
     data = d[key]              # retrieve a COPY of data at key (raise KeyError
                                # if no such key)
     del d[key]                 # delete data stored at key (raises KeyError
                                # if no such key)

     flag = key in d            # true if the key exists
     klist = list(d.keys())     # a list of all existing keys (slow!)

     # as d was opened WITHOUT writeback=True, beware:
     d['xx'] = [0, 1, 2]        # this works as expected, but...
     d['xx'].append(3)          # *this doesn't!* -- d['xx'] is STILL [0, 1, 2]!

     # having opened d without writeback=True, you need to code carefully:
     temp = d['xx']             # extracts the copy
     temp.append(5)             # mutates the copy
     d['xx'] = temp             # stores the copy right back, to persist it

     # or, d=shelve.open(filename,writeback=True) would let you just code
     # d['xx'].append(5) and have it work as expected, BUT it would also
     # consume more memory and make the d.close() operation slower.

     d.close()                  # close it

See also
........

Module *note dbm: 32.

     Generic interface to ‘dbm’-style databases.

Module *note pickle: ca.

     Object serialization used by *note shelve: e7.


File: python.info,  Node: marshal — Internal Python object serialization,  Next: dbm — Interfaces to Unix “databases”,  Prev: shelve — Python object persistence,  Up: Data Persistence

5.12.4 ‘marshal’ — Internal Python object serialization
-------------------------------------------------------

__________________________________________________________________

This module contains functions that can read and write Python values in
a binary format.  The format is specific to Python, but independent of
machine architecture issues (e.g., you can write a Python value to a
file on a PC, transport the file to a Sun, and read it back there).
Details of the format are undocumented on purpose; it may change between
Python versions (although it rarely does).  (1)

This is not a general “persistence” module.  For general persistence and
transfer of Python objects through RPC calls, see the modules *note
pickle: ca. and *note shelve: e7.  The *note marshal: b0. module exists
mainly to support reading and writing the “pseudo-compiled” code for
Python modules of ‘.pyc’ files.  Therefore, the Python maintainers
reserve the right to modify the marshal format in backward incompatible
ways should the need arise.  If you’re serializing and de-serializing
Python objects, use the *note pickle: ca. module instead – the
performance is comparable, version independence is guaranteed, and
pickle supports a substantially wider range of objects than marshal.

     Warning: The *note marshal: b0. module is not intended to be secure
     against erroneous or maliciously constructed data.  Never unmarshal
     data received from an untrusted or unauthenticated source.

Not all Python object types are supported; in general, only objects
whose value is independent from a particular invocation of Python can be
written and read by this module.  The following types are supported:
booleans, integers, floating point numbers, complex numbers, strings,
bytes, bytearrays, tuples, lists, sets, frozensets, dictionaries, and
code objects, where it should be understood that tuples, lists, sets,
frozensets and dictionaries are only supported as long as the values
contained therein are themselves supported.  The singletons *note None:
157, *note Ellipsis: 1547. and *note StopIteration: 47b. can also be
marshalled and unmarshalled.  For format `version' lower than 3,
recursive lists, sets and dictionaries cannot be written (see below).

There are functions that read/write files as well as functions operating
on bytes-like objects.

The module defines these functions:

 -- Function: marshal.dump (value, file[, version])

     Write the value on the open file.  The value must be a supported
     type.  The file must be a writeable *note binary file: 1bdb.

     If the value has (or contains an object that has) an unsupported
     type, a *note ValueError: 1f9. exception is raised — but garbage
     data will also be written to the file.  The object will not be
     properly read back by *note load(): f24.

     The `version' argument indicates the data format that ‘dump’ should
     use (see below).

 -- Function: marshal.load (file)

     Read one value from the open file and return it.  If no valid value
     is read (e.g.  because the data has a different Python version’s
     incompatible marshal format), raise *note EOFError: c5f, *note
     ValueError: 1f9. or *note TypeError: 192.  The file must be a
     readable *note binary file: 1bdb.

          Note: If an object containing an unsupported type was
          marshalled with *note dump(): 1c1b, *note load(): f24. will
          substitute ‘None’ for the unmarshallable type.

 -- Function: marshal.dumps (value[, version])

     Return the bytes object that would be written to a file by
     ‘dump(value, file)’.  The value must be a supported type.  Raise a
     *note ValueError: 1f9. exception if value has (or contains an
     object that has) an unsupported type.

     The `version' argument indicates the data format that ‘dumps’
     should use (see below).

 -- Function: marshal.loads (bytes)

     Convert the *note bytes-like object: 5dd. to a value.  If no valid
     value is found, raise *note EOFError: c5f, *note ValueError: 1f9.
     or *note TypeError: 192.  Extra bytes in the input are ignored.

In addition, the following constants are defined:

 -- Data: marshal.version

     Indicates the format that the module uses.  Version 0 is the
     historical format, version 1 shares interned strings and version 2
     uses a binary format for floating point numbers.  Version 3 adds
     support for object instancing and recursion.  The current version
     is 4.

   ---------- Footnotes ----------

   (1) (1) The name of this module stems from a bit of terminology used
by the designers of Modula-3 (amongst others), who use the term
“marshalling” for shipping of data around in a self-contained form.
Strictly speaking, “to marshal” means to convert some data from internal
to external form (in an RPC buffer for instance) and “unmarshalling” for
the reverse process.


File: python.info,  Node: dbm — Interfaces to Unix “databases”,  Next: sqlite3 — DB-API 2 0 interface for SQLite databases,  Prev: marshal — Internal Python object serialization,  Up: Data Persistence

5.12.5 ‘dbm’ — Interfaces to Unix “databases”
---------------------------------------------

`Source code:' Lib/dbm/__init__.py(1)

__________________________________________________________________

*note dbm: 32. is a generic interface to variants of the DBM database —
*note dbm.gnu: 34. or *note dbm.ndbm: 35.  If none of these modules is
installed, the slow-but-simple implementation in module *note dbm.dumb:
33. will be used.  There is a third party interface(2) to the Oracle
Berkeley DB.

 -- Exception: dbm.error

     A tuple containing the exceptions that can be raised by each of the
     supported modules, with a unique exception also named *note
     dbm.error: 1c20. as the first item — the latter is used when *note
     dbm.error: 1c20. is raised.

 -- Function: dbm.whichdb (filename)

     This function attempts to guess which of the several simple
     database modules available — *note dbm.gnu: 34, *note dbm.ndbm: 35.
     or *note dbm.dumb: 33. — should be used to open a given file.

     Returns one of the following values: ‘None’ if the file can’t be
     opened because it’s unreadable or doesn’t exist; the empty string
     (‘''’) if the file’s format can’t be guessed; or a string
     containing the required module name, such as ‘'dbm.ndbm'’ or
     ‘'dbm.gnu'’.

 -- Function: dbm.open (file, flag='r', mode=0o666)

     Open the database file `file' and return a corresponding object.

     If the database file already exists, the *note whichdb(): 1c21.
     function is used to determine its type and the appropriate module
     is used; if it does not exist, the first module listed above that
     can be imported is used.

     The optional `flag' argument can be:

     Value         Meaning
                   
     --------------------------------------------------------------
                   
     ‘'r'’         Open existing database for reading only
                   (default)
                   
                   
     ‘'w'’         Open existing database for reading and
                   writing
                   
                   
     ‘'c'’         Open database for reading and writing,
                   creating it if it doesn’t exist
                   
                   
     ‘'n'’         Always create a new, empty database, open for
                   reading and writing
                   

     The optional `mode' argument is the Unix mode of the file, used
     only when the database has to be created.  It defaults to octal
     ‘0o666’ (and will be modified by the prevailing umask).

The object returned by *note open(): 824. supports the same basic
functionality as dictionaries; keys and their corresponding values can
be stored, retrieved, and deleted, and the *note in: 797. operator and
the ‘keys()’ method are available, as well as ‘get()’ and
‘setdefault()’.

Changed in version 3.2: ‘get()’ and ‘setdefault()’ are now available in
all database modules.

Changed in version 3.8: Deleting a key from a read-only database raises
database module specific error instead of *note KeyError: 2c5.

Key and values are always stored as bytes.  This means that when strings
are used they are implicitly converted to the default encoding before
being stored.

These objects also support being used in a *note with: 6dd. statement,
which will automatically close them when done.

Changed in version 3.4: Added native support for the context management
protocol to the objects returned by *note open(): 824.

The following example records some hostnames and a corresponding title,
and then prints out the contents of the database:

     import dbm

     # Open database, creating it if necessary.
     with dbm.open('cache', 'c') as db:

         # Record some values
         db[b'hello'] = b'there'
         db['www.python.org'] = 'Python Website'
         db['www.cnn.com'] = 'Cable News Network'

         # Note that the keys are considered bytes now.
         assert db[b'www.python.org'] == b'Python Website'
         # Notice how the value is now in bytes.
         assert db['www.cnn.com'] == b'Cable News Network'

         # Often-used methods of the dict interface work too.
         print(db.get('python.org', b'not present'))

         # Storing a non-string key or value will raise an exception (most
         # likely a TypeError).
         db['www.yahoo.com'] = 4

     # db is automatically closed when leaving the with statement.

See also
........

Module *note shelve: e7.

     Persistence module which stores non-string data.

The individual submodules are described in the following sections.

* Menu:

* dbm.gnu — GNU’s reinterpretation of dbm: dbm gnu — GNU’s reinterpretation of dbm.
* dbm.ndbm — Interface based on ndbm: dbm ndbm — Interface based on ndbm.
* dbm.dumb — Portable DBM implementation: dbm dumb — Portable DBM implementation.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/dbm/__init__.py

   (2) https://www.jcea.es/programacion/pybsddb.htm


File: python.info,  Node: dbm gnu — GNU’s reinterpretation of dbm,  Next: dbm ndbm — Interface based on ndbm,  Up: dbm — Interfaces to Unix “databases”

5.12.5.1 ‘dbm.gnu’ — GNU’s reinterpretation of dbm
..................................................

`Source code:' Lib/dbm/gnu.py(1)

__________________________________________________________________

This module is quite similar to the *note dbm: 32. module, but uses the
GNU library ‘gdbm’ instead to provide some additional functionality.
Please note that the file formats created by *note dbm.gnu: 34. and
*note dbm.ndbm: 35. are incompatible.

The *note dbm.gnu: 34. module provides an interface to the GNU DBM
library.  ‘dbm.gnu.gdbm’ objects behave like mappings (dictionaries),
except that keys and values are always converted to bytes before
storing.  Printing a ‘gdbm’ object doesn’t print the keys and values,
and the ‘items()’ and ‘values()’ methods are not supported.

 -- Exception: dbm.gnu.error

     Raised on *note dbm.gnu: 34.-specific errors, such as I/O errors.
     *note KeyError: 2c5. is raised for general mapping errors like
     specifying an incorrect key.

 -- Function: dbm.gnu.open (filename[, flag[, mode]])

     Open a ‘gdbm’ database and return a ‘gdbm’ object.  The `filename'
     argument is the name of the database file.

     The optional `flag' argument can be:

     Value         Meaning
                   
     --------------------------------------------------------------
                   
     ‘'r'’         Open existing database for reading only
                   (default)
                   
                   
     ‘'w'’         Open existing database for reading and
                   writing
                   
                   
     ‘'c'’         Open database for reading and writing,
                   creating it if it doesn’t exist
                   
                   
     ‘'n'’         Always create a new, empty database, open for
                   reading and writing
                   

     The following additional characters may be appended to the flag to
     control how the database is opened:

     Value         Meaning
                   
     ---------------------------------------------------------------
                   
     ‘'f'’         Open the database in fast mode.  Writes to the
                   database will not be synchronized.
                   
                   
     ‘'s'’         Synchronized mode.  This will cause changes to
                   the database to be immediately written to the
                   file.
                   
                   
     ‘'u'’         Do not lock database.
                   

     Not all flags are valid for all versions of ‘gdbm’.  The module
     constant ‘open_flags’ is a string of supported flag characters.
     The exception *note error: 2c3. is raised if an invalid flag is
     specified.

     The optional `mode' argument is the Unix mode of the file, used
     only when the database has to be created.  It defaults to octal
     ‘0o666’.

     In addition to the dictionary-like methods, ‘gdbm’ objects have the
     following methods:

      -- Method: gdbm.firstkey ()

          It’s possible to loop over every key in the database using
          this method and the *note nextkey(): 1c24. method.  The
          traversal is ordered by ‘gdbm’’s internal hash values, and
          won’t be sorted by the key values.  This method returns the
          starting key.

      -- Method: gdbm.nextkey (key)

          Returns the key that follows `key' in the traversal.  The
          following code prints every key in the database ‘db’, without
          having to create a list in memory that contains them all:

               k = db.firstkey()
               while k != None:
                   print(k)
                   k = db.nextkey(k)

      -- Method: gdbm.reorganize ()

          If you have carried out a lot of deletions and would like to
          shrink the space used by the ‘gdbm’ file, this routine will
          reorganize the database.  ‘gdbm’ objects will not shorten the
          length of a database file except by using this reorganization;
          otherwise, deleted file space will be kept and reused as new
          (key, value) pairs are added.

      -- Method: gdbm.sync ()

          When the database has been opened in fast mode, this method
          forces any unwritten data to be written to the disk.

      -- Method: gdbm.close ()

          Close the ‘gdbm’ database.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/dbm/gnu.py


File: python.info,  Node: dbm ndbm — Interface based on ndbm,  Next: dbm dumb — Portable DBM implementation,  Prev: dbm gnu — GNU’s reinterpretation of dbm,  Up: dbm — Interfaces to Unix “databases”

5.12.5.2 ‘dbm.ndbm’ — Interface based on ndbm
.............................................

`Source code:' Lib/dbm/ndbm.py(1)

__________________________________________________________________

The *note dbm.ndbm: 35. module provides an interface to the Unix
“(n)dbm” library.  Dbm objects behave like mappings (dictionaries),
except that keys and values are always stored as bytes.  Printing a
‘dbm’ object doesn’t print the keys and values, and the ‘items()’ and
‘values()’ methods are not supported.

This module can be used with the “classic” ndbm interface or the GNU
GDBM compatibility interface.  On Unix, the ‘configure’ script will
attempt to locate the appropriate header file to simplify building this
module.

 -- Exception: dbm.ndbm.error

     Raised on *note dbm.ndbm: 35.-specific errors, such as I/O errors.
     *note KeyError: 2c5. is raised for general mapping errors like
     specifying an incorrect key.

 -- Data: dbm.ndbm.library

     Name of the ‘ndbm’ implementation library used.

 -- Function: dbm.ndbm.open (filename[, flag[, mode]])

     Open a dbm database and return a ‘ndbm’ object.  The `filename'
     argument is the name of the database file (without the ‘.dir’ or
     ‘.pag’ extensions).

     The optional `flag' argument must be one of these values:

     Value         Meaning
                   
     --------------------------------------------------------------
                   
     ‘'r'’         Open existing database for reading only
                   (default)
                   
                   
     ‘'w'’         Open existing database for reading and
                   writing
                   
                   
     ‘'c'’         Open database for reading and writing,
                   creating it if it doesn’t exist
                   
                   
     ‘'n'’         Always create a new, empty database, open for
                   reading and writing
                   

     The optional `mode' argument is the Unix mode of the file, used
     only when the database has to be created.  It defaults to octal
     ‘0o666’ (and will be modified by the prevailing umask).

     In addition to the dictionary-like methods, ‘ndbm’ objects provide
     the following method:

      -- Method: ndbm.close ()

          Close the ‘ndbm’ database.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/dbm/ndbm.py


File: python.info,  Node: dbm dumb — Portable DBM implementation,  Prev: dbm ndbm — Interface based on ndbm,  Up: dbm — Interfaces to Unix “databases”

5.12.5.3 ‘dbm.dumb’ — Portable DBM implementation
.................................................

`Source code:' Lib/dbm/dumb.py(1)

     Note: The *note dbm.dumb: 33. module is intended as a last resort
     fallback for the *note dbm: 32. module when a more robust module is
     not available.  The *note dbm.dumb: 33. module is not written for
     speed and is not nearly as heavily used as the other database
     modules.

__________________________________________________________________

The *note dbm.dumb: 33. module provides a persistent dictionary-like
interface which is written entirely in Python.  Unlike other modules
such as *note dbm.gnu: 34. no external library is required.  As with
other persistent mappings, the keys and values are always stored as
bytes.

The module defines the following:

 -- Exception: dbm.dumb.error

     Raised on *note dbm.dumb: 33.-specific errors, such as I/O errors.
     *note KeyError: 2c5. is raised for general mapping errors like
     specifying an incorrect key.

 -- Function: dbm.dumb.open (filename[, flag[, mode]])

     Open a ‘dumbdbm’ database and return a dumbdbm object.  The
     `filename' argument is the basename of the database file (without
     any specific extensions).  When a dumbdbm database is created,
     files with ‘.dat’ and ‘.dir’ extensions are created.

     The optional `flag' argument can be:

     Value         Meaning
                   
     --------------------------------------------------------------
                   
     ‘'r'’         Open existing database for reading only
                   (default)
                   
                   
     ‘'w'’         Open existing database for reading and
                   writing
                   
                   
     ‘'c'’         Open database for reading and writing,
                   creating it if it doesn’t exist
                   
                   
     ‘'n'’         Always create a new, empty database, open for
                   reading and writing
                   

     The optional `mode' argument is the Unix mode of the file, used
     only when the database has to be created.  It defaults to octal
     ‘0o666’ (and will be modified by the prevailing umask).

          Warning: It is possible to crash the Python interpreter when
          loading a database with a sufficiently large/complex entry due
          to stack depth limitations in Python’s AST compiler.

     Changed in version 3.5: *note open(): 2bd. always creates a new
     database when the flag has the value ‘'n'’.

     Changed in version 3.8: A database opened with flags ‘'r'’ is now
     read-only.  Opening with flags ‘'r'’ and ‘'w'’ no longer creates a
     database if it does not exist.

     In addition to the methods provided by the *note
     collections.abc.MutableMapping: 9e3. class, ‘dumbdbm’ objects
     provide the following methods:

      -- Method: dumbdbm.sync ()

          Synchronize the on-disk directory and data files.  This method
          is called by the ‘Shelve.sync()’ method.

      -- Method: dumbdbm.close ()

          Close the ‘dumbdbm’ database.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/dbm/dumb.py


File: python.info,  Node: sqlite3 — DB-API 2 0 interface for SQLite databases,  Prev: dbm — Interfaces to Unix “databases”,  Up: Data Persistence

5.12.6 ‘sqlite3’ — DB-API 2.0 interface for SQLite databases
------------------------------------------------------------

`Source code:' Lib/sqlite3/(1)

__________________________________________________________________

SQLite is a C library that provides a lightweight disk-based database
that doesn’t require a separate server process and allows accessing the
database using a nonstandard variant of the SQL query language.  Some
applications can use SQLite for internal data storage.  It’s also
possible to prototype an application using SQLite and then port the code
to a larger database such as PostgreSQL or Oracle.

The sqlite3 module was written by Gerhard Häring.  It provides a SQL
interface compliant with the DB-API 2.0 specification described by PEP
249(2).

To use the module, you must first create a *note Connection: 3cd. object
that represents the database.  Here the data will be stored in the
‘example.db’ file:

     import sqlite3
     conn = sqlite3.connect('example.db')

You can also supply the special name ‘:memory:’ to create a database in
RAM.

Once you have a *note Connection: 3cd, you can create a *note Cursor:
1c30. object and call its *note execute(): 1c31. method to perform SQL
commands:

     c = conn.cursor()

     # Create table
     c.execute('''CREATE TABLE stocks
                  (date text, trans text, symbol text, qty real, price real)''')

     # Insert a row of data
     c.execute("INSERT INTO stocks VALUES ('2006-01-05','BUY','RHAT',100,35.14)")

     # Save (commit) the changes
     conn.commit()

     # We can also close the connection if we are done with it.
     # Just be sure any changes have been committed or they will be lost.
     conn.close()

The data you’ve saved is persistent and is available in subsequent
sessions:

     import sqlite3
     conn = sqlite3.connect('example.db')
     c = conn.cursor()

Usually your SQL operations will need to use values from Python
variables.  You shouldn’t assemble your query using Python’s string
operations because doing so is insecure; it makes your program
vulnerable to an SQL injection attack (see ‘https://xkcd.com/327/’ for
humorous example of what can go wrong).

Instead, use the DB-API’s parameter substitution.  Put ‘?’ as a
placeholder wherever you want to use a value, and then provide a tuple
of values as the second argument to the cursor’s *note execute(): 1c31.
method.  (Other database modules may use a different placeholder, such
as ‘%s’ or ‘:1’.)  For example:

     # Never do this -- insecure!
     symbol = 'RHAT'
     c.execute("SELECT * FROM stocks WHERE symbol = '%s'" % symbol)

     # Do this instead
     t = ('RHAT',)
     c.execute('SELECT * FROM stocks WHERE symbol=?', t)
     print(c.fetchone())

     # Larger example that inserts many records at a time
     purchases = [('2006-03-28', 'BUY', 'IBM', 1000, 45.00),
                  ('2006-04-05', 'BUY', 'MSFT', 1000, 72.00),
                  ('2006-04-06', 'SELL', 'IBM', 500, 53.00),
                 ]
     c.executemany('INSERT INTO stocks VALUES (?,?,?,?,?)', purchases)

To retrieve data after executing a SELECT statement, you can either
treat the cursor as an *note iterator: f73, call the cursor’s *note
fetchone(): 1c32. method to retrieve a single matching row, or call
*note fetchall(): 1c33. to get a list of the matching rows.

This example uses the iterator form:

     >>> for row in c.execute('SELECT * FROM stocks ORDER BY price'):
             print(row)

     ('2006-01-05', 'BUY', 'RHAT', 100, 35.14)
     ('2006-03-28', 'BUY', 'IBM', 1000, 45.0)
     ('2006-04-06', 'SELL', 'IBM', 500, 53.0)
     ('2006-04-05', 'BUY', 'MSFT', 1000, 72.0)

See also
........

‘https://github.com/ghaering/pysqlite’

     The pysqlite web page – sqlite3 is developed externally under the
     name “pysqlite”.

‘https://www.sqlite.org’

     The SQLite web page; the documentation describes the syntax and the
     available data types for the supported SQL dialect.

‘https://www.w3schools.com/sql/’

     Tutorial, reference and examples for learning SQL syntax.

PEP 249(3) - Database API Specification 2.0

     PEP written by Marc-André Lemburg.

* Menu:

* Module functions and constants::
* Connection Objects::
* Cursor Objects::
* Row Objects::
* Exceptions: Exceptions<4>.
* SQLite and Python types::
* Controlling Transactions::
* Using sqlite3 efficiently::
* Common issues::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/sqlite3/

   (2) https://www.python.org/dev/peps/pep-0249

   (3) https://www.python.org/dev/peps/pep-0249


File: python.info,  Node: Module functions and constants,  Next: Connection Objects,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.1 Module functions and constants
.......................................

 -- Data: sqlite3.version

     The version number of this module, as a string.  This is not the
     version of the SQLite library.

 -- Data: sqlite3.version_info

     The version number of this module, as a tuple of integers.  This is
     not the version of the SQLite library.

 -- Data: sqlite3.sqlite_version

     The version number of the run-time SQLite library, as a string.

 -- Data: sqlite3.sqlite_version_info

     The version number of the run-time SQLite library, as a tuple of
     integers.

 -- Data: sqlite3.PARSE_DECLTYPES

     This constant is meant to be used with the `detect_types' parameter
     of the *note connect(): 3cf. function.

     Setting it makes the *note sqlite3: f2. module parse the declared
     type for each column it returns.  It will parse out the first word
     of the declared type, i.  e.  for “integer primary key”, it will
     parse out “integer”, or for “number(10)” it will parse out
     “number”.  Then for that column, it will look into the converters
     dictionary and use the converter function registered for that type
     there.

 -- Data: sqlite3.PARSE_COLNAMES

     This constant is meant to be used with the `detect_types' parameter
     of the *note connect(): 3cf. function.

     Setting this makes the SQLite interface parse the column name for
     each column it returns.  It will look for a string formed [mytype]
     in there, and then decide that ‘mytype’ is the type of the column.
     It will try to find an entry of ‘mytype’ in the converters
     dictionary and then use the converter function found there to
     return the value.  The column name found in *note
     Cursor.description: 1c3c. is only the first word of the column
     name, i.  e.  if you use something like ‘'as "x [datetime]"'’ in
     your SQL, then we will parse out everything until the first blank
     for the column name: the column name would simply be “x”.

 -- Function: sqlite3.connect (database[, timeout, detect_types,
          isolation_level, check_same_thread, factory,
          cached_statements, uri])

     Opens a connection to the SQLite database file `database'.  By
     default returns a *note Connection: 3cd. object, unless a custom
     `factory' is given.

     `database' is a *note path-like object: 35f. giving the pathname
     (absolute or relative to the current working directory) of the
     database file to be opened.  You can use ‘":memory:"’ to open a
     database connection to a database that resides in RAM instead of on
     disk.

     When a database is accessed by multiple connections, and one of the
     processes modifies the database, the SQLite database is locked
     until that transaction is committed.  The `timeout' parameter
     specifies how long the connection should wait for the lock to go
     away until raising an exception.  The default for the timeout
     parameter is 5.0 (five seconds).

     For the `isolation_level' parameter, please see the *note
     isolation_level: 1c3d. property of *note Connection: 3cd. objects.

     SQLite natively supports only the types TEXT, INTEGER, REAL, BLOB
     and NULL. If you want to use other types you must add support for
     them yourself.  The `detect_types' parameter and the using custom
     `converters' registered with the module-level *note
     register_converter(): 1c3e. function allow you to easily do that.

     `detect_types' defaults to 0 (i.  e.  off, no type detection), you
     can set it to any combination of *note PARSE_DECLTYPES: 1c3a. and
     *note PARSE_COLNAMES: 1c3b. to turn type detection on.

     By default, `check_same_thread' is *note True: 48f. and only the
     creating thread may use the connection.  If set *note False: 37d,
     the returned connection may be shared across multiple threads.
     When using multiple threads with the same connection writing
     operations should be serialized by the user to avoid data
     corruption.

     By default, the *note sqlite3: f2. module uses its *note
     Connection: 3cd. class for the connect call.  You can, however,
     subclass the *note Connection: 3cd. class and make *note connect():
     3cf. use your class instead by providing your class for the
     `factory' parameter.

     Consult the section *note SQLite and Python types: 1c3f. of this
     manual for details.

     The *note sqlite3: f2. module internally uses a statement cache to
     avoid SQL parsing overhead.  If you want to explicitly set the
     number of statements that are cached for the connection, you can
     set the `cached_statements' parameter.  The currently implemented
     default is to cache 100 statements.

     If `uri' is true, `database' is interpreted as a URI. This allows
     you to specify options.  For example, to open a database in
     read-only mode you can use:

          db = sqlite3.connect('file:path/to/database?mode=ro', uri=True)

     More information about this feature, including a list of recognized
     options, can be found in the SQLite URI documentation(1).

     Raises an *note auditing event: 1275. ‘sqlite3.connect’ with
     argument ‘database’.

     Changed in version 3.4: Added the `uri' parameter.

     Changed in version 3.7: `database' can now also be a *note
     path-like object: 35f, not only a string.

 -- Function: sqlite3.register_converter (typename, callable)

     Registers a callable to convert a bytestring from the database into
     a custom Python type.  The callable will be invoked for all
     database values that are of the type `typename'.  Confer the
     parameter `detect_types' of the *note connect(): 3cf. function for
     how the type detection works.  Note that `typename' and the name of
     the type in your query are matched in case-insensitive manner.

 -- Function: sqlite3.register_adapter (type, callable)

     Registers a callable to convert the custom Python type `type' into
     one of SQLite’s supported types.  The callable `callable' accepts
     as single parameter the Python value, and must return a value of
     the following types: int, float, str or bytes.

 -- Function: sqlite3.complete_statement (sql)

     Returns *note True: 48f. if the string `sql' contains one or more
     complete SQL statements terminated by semicolons.  It does not
     verify that the SQL is syntactically correct, only that there are
     no unclosed string literals and the statement is terminated by a
     semicolon.

     This can be used to build a shell for SQLite, as in the following
     example:

          # A minimal SQLite shell for experiments

          import sqlite3

          con = sqlite3.connect(":memory:")
          con.isolation_level = None
          cur = con.cursor()

          buffer = ""

          print("Enter your SQL commands to execute in sqlite3.")
          print("Enter a blank line to exit.")

          while True:
              line = input()
              if line == "":
                  break
              buffer += line
              if sqlite3.complete_statement(buffer):
                  try:
                      buffer = buffer.strip()
                      cur.execute(buffer)

                      if buffer.lstrip().upper().startswith("SELECT"):
                          print(cur.fetchall())
                  except sqlite3.Error as e:
                      print("An error occurred:", e.args[0])
                  buffer = ""

          con.close()

 -- Function: sqlite3.enable_callback_tracebacks (flag)

     By default you will not get any tracebacks in user-defined
     functions, aggregates, converters, authorizer callbacks etc.  If
     you want to debug them, you can call this function with `flag' set
     to ‘True’.  Afterwards, you will get tracebacks from callbacks on
     ‘sys.stderr’.  Use *note False: 37d. to disable the feature again.

   ---------- Footnotes ----------

   (1) https://www.sqlite.org/uri.html


File: python.info,  Node: Connection Objects,  Next: Cursor Objects,  Prev: Module functions and constants,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.2 Connection Objects
...........................

 -- Class: sqlite3.Connection

     A SQLite database connection has the following attributes and
     methods:

      -- Attribute: isolation_level

          Get or set the current default isolation level.  *note None:
          157. for autocommit mode or one of “DEFERRED”, “IMMEDIATE” or
          “EXCLUSIVE”.  See section *note Controlling Transactions:
          1c45. for a more detailed explanation.

      -- Attribute: in_transaction

          *note True: 48f. if a transaction is active (there are
          uncommitted changes), *note False: 37d. otherwise.  Read-only
          attribute.

          New in version 3.2.

      -- Method: cursor (factory=Cursor)

          The cursor method accepts a single optional parameter
          `factory'.  If supplied, this must be a callable returning an
          instance of *note Cursor: 1c30. or its subclasses.

      -- Method: commit ()

          This method commits the current transaction.  If you don’t
          call this method, anything you did since the last call to
          ‘commit()’ is not visible from other database connections.  If
          you wonder why you don’t see the data you’ve written to the
          database, please check you didn’t forget to call this method.

      -- Method: rollback ()

          This method rolls back any changes to the database since the
          last call to *note commit(): 1c48.

      -- Method: close ()

          This closes the database connection.  Note that this does not
          automatically call *note commit(): 1c48.  If you just close
          your database connection without calling *note commit(): 1c48.
          first, your changes will be lost!

      -- Method: execute (sql[, parameters])

          This is a nonstandard shortcut that creates a cursor object by
          calling the *note cursor(): 1c47. method, calls the cursor’s
          *note execute(): 1c31. method with the `parameters' given, and
          returns the cursor.

      -- Method: executemany (sql[, parameters])

          This is a nonstandard shortcut that creates a cursor object by
          calling the *note cursor(): 1c47. method, calls the cursor’s
          *note executemany(): 1c4d. method with the `parameters' given,
          and returns the cursor.

      -- Method: executescript (sql_script)

          This is a nonstandard shortcut that creates a cursor object by
          calling the *note cursor(): 1c47. method, calls the cursor’s
          *note executescript(): 1c4f. method with the given
          `sql_script', and returns the cursor.

      -- Method: create_function (name, num_params, func, *,
               deterministic=False)

          Creates a user-defined function that you can later use from
          within SQL statements under the function name `name'.
          `num_params' is the number of parameters the function accepts
          (if `num_params' is -1, the function may take any number of
          arguments), and `func' is a Python callable that is called as
          the SQL function.  If `deterministic' is true, the created
          function is marked as deterministic(1), which allows SQLite to
          perform additional optimizations.  This flag is supported by
          SQLite 3.8.3 or higher, *note NotSupportedError: 1c50. will be
          raised if used with older versions.

          The function can return any of the types supported by SQLite:
          bytes, str, int, float and ‘None’.

          Changed in version 3.8: The `deterministic' parameter was
          added.

          Example:

               import sqlite3
               import hashlib

               def md5sum(t):
                   return hashlib.md5(t).hexdigest()

               con = sqlite3.connect(":memory:")
               con.create_function("md5", 1, md5sum)
               cur = con.cursor()
               cur.execute("select md5(?)", (b"foo",))
               print(cur.fetchone()[0])

               con.close()

      -- Method: create_aggregate (name, num_params, aggregate_class)

          Creates a user-defined aggregate function.

          The aggregate class must implement a ‘step’ method, which
          accepts the number of parameters `num_params' (if `num_params'
          is -1, the function may take any number of arguments), and a
          ‘finalize’ method which will return the final result of the
          aggregate.

          The ‘finalize’ method can return any of the types supported by
          SQLite: bytes, str, int, float and ‘None’.

          Example:

               import sqlite3

               class MySum:
                   def __init__(self):
                       self.count = 0

                   def step(self, value):
                       self.count += value

                   def finalize(self):
                       return self.count

               con = sqlite3.connect(":memory:")
               con.create_aggregate("mysum", 1, MySum)
               cur = con.cursor()
               cur.execute("create table test(i)")
               cur.execute("insert into test(i) values (1)")
               cur.execute("insert into test(i) values (2)")
               cur.execute("select mysum(i) from test")
               print(cur.fetchone()[0])

               con.close()

      -- Method: create_collation (name, callable)

          Creates a collation with the specified `name' and `callable'.
          The callable will be passed two string arguments.  It should
          return -1 if the first is ordered lower than the second, 0 if
          they are ordered equal and 1 if the first is ordered higher
          than the second.  Note that this controls sorting (ORDER BY in
          SQL) so your comparisons don’t affect other SQL operations.

          Note that the callable will get its parameters as Python
          bytestrings, which will normally be encoded in UTF-8.

          The following example shows a custom collation that sorts “the
          wrong way”:

               import sqlite3

               def collate_reverse(string1, string2):
                   if string1 == string2:
                       return 0
                   elif string1 < string2:
                       return 1
                   else:
                       return -1

               con = sqlite3.connect(":memory:")
               con.create_collation("reverse", collate_reverse)

               cur = con.cursor()
               cur.execute("create table test(x)")
               cur.executemany("insert into test(x) values (?)", [("a",), ("b",)])
               cur.execute("select x from test order by x collate reverse")
               for row in cur:
                   print(row)
               con.close()

          To remove a collation, call ‘create_collation’ with ‘None’ as
          callable:

               con.create_collation("reverse", None)

      -- Method: interrupt ()

          You can call this method from a different thread to abort any
          queries that might be executing on the connection.  The query
          will then abort and the caller will get an exception.

      -- Method: set_authorizer (authorizer_callback)

          This routine registers a callback.  The callback is invoked
          for each attempt to access a column of a table in the
          database.  The callback should return ‘SQLITE_OK’ if access is
          allowed, ‘SQLITE_DENY’ if the entire SQL statement should be
          aborted with an error and ‘SQLITE_IGNORE’ if the column should
          be treated as a NULL value.  These constants are available in
          the *note sqlite3: f2. module.

          The first argument to the callback signifies what kind of
          operation is to be authorized.  The second and third argument
          will be arguments or *note None: 157. depending on the first
          argument.  The 4th argument is the name of the database
          (“main”, “temp”, etc.)  if applicable.  The 5th argument is
          the name of the inner-most trigger or view that is responsible
          for the access attempt or *note None: 157. if this access
          attempt is directly from input SQL code.

          Please consult the SQLite documentation about the possible
          values for the first argument and the meaning of the second
          and third argument depending on the first one.  All necessary
          constants are available in the *note sqlite3: f2. module.

      -- Method: set_progress_handler (handler, n)

          This routine registers a callback.  The callback is invoked
          for every `n' instructions of the SQLite virtual machine.
          This is useful if you want to get called from SQLite during
          long-running operations, for example to update a GUI.

          If you want to clear any previously installed progress
          handler, call the method with *note None: 157. for `handler'.

          Returning a non-zero value from the handler function will
          terminate the currently executing query and cause it to raise
          an *note OperationalError: 1c53. exception.

      -- Method: set_trace_callback (trace_callback)

          Registers `trace_callback' to be called for each SQL statement
          that is actually executed by the SQLite backend.

          The only argument passed to the callback is the statement (as
          string) that is being executed.  The return value of the
          callback is ignored.  Note that the backend does not only run
          statements passed to the *note Cursor.execute(): 1c31.
          methods.  Other sources include the transaction management of
          the Python module and the execution of triggers defined in the
          current database.

          Passing *note None: 157. as `trace_callback' will disable the
          trace callback.

          New in version 3.3.

      -- Method: enable_load_extension (enabled)

          This routine allows/disallows the SQLite engine to load SQLite
          extensions from shared libraries.  SQLite extensions can
          define new functions, aggregates or whole new virtual table
          implementations.  One well-known extension is the
          fulltext-search extension distributed with SQLite.

          Loadable extensions are disabled by default.  See (2).

          New in version 3.2.

               import sqlite3

               con = sqlite3.connect(":memory:")

               # enable extension loading
               con.enable_load_extension(True)

               # Load the fulltext search extension
               con.execute("select load_extension('./fts3.so')")

               # alternatively you can load the extension using an API call:
               # con.load_extension("./fts3.so")

               # disable extension loading again
               con.enable_load_extension(False)

               # example from SQLite wiki
               con.execute("create virtual table recipe using fts3(name, ingredients)")
               con.executescript("""
                   insert into recipe (name, ingredients) values ('broccoli stew', 'broccoli peppers cheese tomatoes');
                   insert into recipe (name, ingredients) values ('pumpkin stew', 'pumpkin onions garlic celery');
                   insert into recipe (name, ingredients) values ('broccoli pie', 'broccoli cheese onions flour');
                   insert into recipe (name, ingredients) values ('pumpkin pie', 'pumpkin sugar flour butter');
                   """)
               for row in con.execute("select rowid, name, ingredients from recipe where name match 'pie'"):
                   print(row)

               con.close()

      -- Method: load_extension (path)

          This routine loads a SQLite extension from a shared library.
          You have to enable extension loading with *note
          enable_load_extension(): b8c. before you can use this routine.

          Loadable extensions are disabled by default.  See (3).

          New in version 3.2.

      -- Attribute: row_factory

          You can change this attribute to a callable that accepts the
          cursor and the original row as a tuple and will return the
          real result row.  This way, you can implement more advanced
          ways of returning results, such as returning an object that
          can also access columns by name.

          Example:

               import sqlite3

               def dict_factory(cursor, row):
                   d = {}
                   for idx, col in enumerate(cursor.description):
                       d[col[0]] = row[idx]
                   return d

               con = sqlite3.connect(":memory:")
               con.row_factory = dict_factory
               cur = con.cursor()
               cur.execute("select 1 as a")
               print(cur.fetchone()["a"])

               con.close()

          If returning a tuple doesn’t suffice and you want name-based
          access to columns, you should consider setting *note
          row_factory: 1c54. to the highly-optimized *note sqlite3.Row:
          752. type.  *note Row: 752. provides both index-based and
          case-insensitive name-based access to columns with almost no
          memory overhead.  It will probably be better than your own
          custom dictionary-based approach or even a db_row based
          solution.

      -- Attribute: text_factory

          Using this attribute you can control what objects are returned
          for the ‘TEXT’ data type.  By default, this attribute is set
          to *note str: 325. and the *note sqlite3: f2. module will
          return Unicode objects for ‘TEXT’.  If you want to return
          bytestrings instead, you can set it to *note bytes: 326.

          You can also set it to any other callable that accepts a
          single bytestring parameter and returns the resulting object.

          See the following example code for illustration:

               import sqlite3

               con = sqlite3.connect(":memory:")
               cur = con.cursor()

               AUSTRIA = "\xd6sterreich"

               # by default, rows are returned as Unicode
               cur.execute("select ?", (AUSTRIA,))
               row = cur.fetchone()
               assert row[0] == AUSTRIA

               # but we can make sqlite3 always return bytestrings ...
               con.text_factory = bytes
               cur.execute("select ?", (AUSTRIA,))
               row = cur.fetchone()
               assert type(row[0]) is bytes
               # the bytestrings will be encoded in UTF-8, unless you stored garbage in the
               # database ...
               assert row[0] == AUSTRIA.encode("utf-8")

               # we can also implement a custom text_factory ...
               # here we implement one that appends "foo" to all strings
               con.text_factory = lambda x: x.decode("utf-8") + "foo"
               cur.execute("select ?", ("bar",))
               row = cur.fetchone()
               assert row[0] == "barfoo"

               con.close()

      -- Attribute: total_changes

          Returns the total number of database rows that have been
          modified, inserted, or deleted since the database connection
          was opened.

      -- Method: iterdump ()

          Returns an iterator to dump the database in an SQL text
          format.  Useful when saving an in-memory database for later
          restoration.  This function provides the same capabilities as
          the ‘.dump’ command in the ‘sqlite3’ shell.

          Example:

               # Convert file existing_db.db to SQL dump file dump.sql
               import sqlite3

               con = sqlite3.connect('existing_db.db')
               with open('dump.sql', 'w') as f:
                   for line in con.iterdump():
                       f.write('%s\n' % line)
               con.close()

      -- Method: backup (target, *, pages=0, progress=None, name="main",
               sleep=0.250)

          This method makes a backup of a SQLite database even while
          it’s being accessed by other clients, or concurrently by the
          same connection.  The copy will be written into the mandatory
          argument `target', that must be another *note Connection: 3cd.
          instance.

          By default, or when `pages' is either ‘0’ or a negative
          integer, the entire database is copied in a single step;
          otherwise the method performs a loop copying up to `pages'
          pages at a time.

          If `progress' is specified, it must either be ‘None’ or a
          callable object that will be executed at each iteration with
          three integer arguments, respectively the `status' of the last
          iteration, the `remaining' number of pages still to be copied
          and the `total' number of pages.

          The `name' argument specifies the database name that will be
          copied: it must be a string containing either ‘"main"’, the
          default, to indicate the main database, ‘"temp"’ to indicate
          the temporary database or the name specified after the ‘AS’
          keyword in an ‘ATTACH DATABASE’ statement for an attached
          database.

          The `sleep' argument specifies the number of seconds to sleep
          by between successive attempts to backup remaining pages, can
          be specified either as an integer or a floating point value.

          Example 1, copy an existing database into another:

               import sqlite3

               def progress(status, remaining, total):
                   print(f'Copied {total-remaining} of {total} pages...')

               con = sqlite3.connect('existing_db.db')
               bck = sqlite3.connect('backup.db')
               with bck:
                   con.backup(bck, pages=1, progress=progress)
               bck.close()
               con.close()

          Example 2, copy an existing database into a transient copy:

               import sqlite3

               source = sqlite3.connect('existing_db.db')
               dest = sqlite3.connect(':memory:')
               source.backup(dest)

          Availability: SQLite 3.6.11 or higher

          New in version 3.7.

   ---------- Footnotes ----------

   (1) https://sqlite.org/deterministic.html

   (2) (1) The sqlite3 module is not built with loadable extension
support by default, because some platforms (notably Mac OS X) have
SQLite libraries which are compiled without this feature.  To get
loadable extension support, you must pass
–enable-loadable-sqlite-extensions to configure.

   (3) (1) The sqlite3 module is not built with loadable extension
support by default, because some platforms (notably Mac OS X) have
SQLite libraries which are compiled without this feature.  To get
loadable extension support, you must pass
–enable-loadable-sqlite-extensions to configure.


File: python.info,  Node: Cursor Objects,  Next: Row Objects,  Prev: Connection Objects,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.3 Cursor Objects
.......................

 -- Class: sqlite3.Cursor

     A *note Cursor: 1c30. instance has the following attributes and
     methods.

      -- Method: execute (sql[, parameters])

          Executes an SQL statement.  The SQL statement may be
          parameterized (i.  e.  placeholders instead of SQL literals).
          The *note sqlite3: f2. module supports two kinds of
          placeholders: question marks (qmark style) and named
          placeholders (named style).

          Here’s an example of both styles:

               import sqlite3

               con = sqlite3.connect(":memory:")
               cur = con.cursor()
               cur.execute("create table people (name_last, age)")

               who = "Yeltsin"
               age = 72

               # This is the qmark style:
               cur.execute("insert into people values (?, ?)", (who, age))

               # And this is the named style:
               cur.execute("select * from people where name_last=:who and age=:age", {"who": who, "age": age})

               print(cur.fetchone())

               con.close()

          *note execute(): 1c31. will only execute a single SQL
          statement.  If you try to execute more than one statement with
          it, it will raise a *note Warning: 1c5a.  Use *note
          executescript(): 1c4f. if you want to execute multiple SQL
          statements with one call.

      -- Method: executemany (sql, seq_of_parameters)

          Executes an SQL command against all parameter sequences or
          mappings found in the sequence `seq_of_parameters'.  The *note
          sqlite3: f2. module also allows using an *note iterator: f73.
          yielding parameters instead of a sequence.

               import sqlite3

               class IterChars:
                   def __init__(self):
                       self.count = ord('a')

                   def __iter__(self):
                       return self

                   def __next__(self):
                       if self.count > ord('z'):
                           raise StopIteration
                       self.count += 1
                       return (chr(self.count - 1),) # this is a 1-tuple

               con = sqlite3.connect(":memory:")
               cur = con.cursor()
               cur.execute("create table characters(c)")

               theIter = IterChars()
               cur.executemany("insert into characters(c) values (?)", theIter)

               cur.execute("select c from characters")
               print(cur.fetchall())

               con.close()

          Here’s a shorter example using a *note generator: 996.:

               import sqlite3
               import string

               def char_generator():
                   for c in string.ascii_lowercase:
                       yield (c,)

               con = sqlite3.connect(":memory:")
               cur = con.cursor()
               cur.execute("create table characters(c)")

               cur.executemany("insert into characters(c) values (?)", char_generator())

               cur.execute("select c from characters")
               print(cur.fetchall())

               con.close()

      -- Method: executescript (sql_script)

          This is a nonstandard convenience method for executing
          multiple SQL statements at once.  It issues a ‘COMMIT’
          statement first, then executes the SQL script it gets as a
          parameter.

          `sql_script' can be an instance of *note str: 325.

          Example:

               import sqlite3

               con = sqlite3.connect(":memory:")
               cur = con.cursor()
               cur.executescript("""
                   create table person(
                       firstname,
                       lastname,
                       age
                   );

                   create table book(
                       title,
                       author,
                       published
                   );

                   insert into book(title, author, published)
                   values (
                       'Dirk Gently''s Holistic Detective Agency',
                       'Douglas Adams',
                       1987
                   );
                   """)
               con.close()

      -- Method: fetchone ()

          Fetches the next row of a query result set, returning a single
          sequence, or *note None: 157. when no more data is available.

      -- Method: fetchmany (size=cursor.arraysize)

          Fetches the next set of rows of a query result, returning a
          list.  An empty list is returned when no more rows are
          available.

          The number of rows to fetch per call is specified by the
          `size' parameter.  If it is not given, the cursor’s arraysize
          determines the number of rows to be fetched.  The method
          should try to fetch as many rows as indicated by the size
          parameter.  If this is not possible due to the specified
          number of rows not being available, fewer rows may be
          returned.

          Note there are performance considerations involved with the
          `size' parameter.  For optimal performance, it is usually best
          to use the arraysize attribute.  If the `size' parameter is
          used, then it is best for it to retain the same value from one
          *note fetchmany(): 1c5b. call to the next.

      -- Method: fetchall ()

          Fetches all (remaining) rows of a query result, returning a
          list.  Note that the cursor’s arraysize attribute can affect
          the performance of this operation.  An empty list is returned
          when no rows are available.

      -- Method: close ()

          Close the cursor now (rather than whenever ‘__del__’ is
          called).

          The cursor will be unusable from this point forward; a *note
          ProgrammingError: 1c5d. exception will be raised if any
          operation is attempted with the cursor.

      -- Attribute: rowcount

          Although the *note Cursor: 1c30. class of the *note sqlite3:
          f2. module implements this attribute, the database engine’s
          own support for the determination of “rows affected”/”rows
          selected” is quirky.

          For *note executemany(): 1c4d. statements, the number of
          modifications are summed up into *note rowcount: 1c5e.

          As required by the Python DB API Spec, the *note rowcount:
          1c5e. attribute “is -1 in case no ‘executeXX()’ has been
          performed on the cursor or the rowcount of the last operation
          is not determinable by the interface”.  This includes ‘SELECT’
          statements because we cannot determine the number of rows a
          query produced until all rows were fetched.

          With SQLite versions before 3.6.5, *note rowcount: 1c5e. is
          set to 0 if you make a ‘DELETE FROM table’ without any
          condition.

      -- Attribute: lastrowid

          This read-only attribute provides the rowid of the last
          modified row.  It is only set if you issued an ‘INSERT’ or a
          ‘REPLACE’ statement using the *note execute(): 1c31. method.
          For operations other than ‘INSERT’ or ‘REPLACE’ or when *note
          executemany(): 1c4d. is called, *note lastrowid: 573. is set
          to *note None: 157.

          If the ‘INSERT’ or ‘REPLACE’ statement failed to insert the
          previous successful rowid is returned.

          Changed in version 3.6: Added support for the ‘REPLACE’
          statement.

      -- Attribute: arraysize

          Read/write attribute that controls the number of rows returned
          by *note fetchmany(): 1c5b.  The default value is 1 which
          means a single row would be fetched per call.

      -- Attribute: description

          This read-only attribute provides the column names of the last
          query.  To remain compatible with the Python DB API, it
          returns a 7-tuple for each column where the last six items of
          each tuple are *note None: 157.

          It is set for ‘SELECT’ statements without any matching rows as
          well.

      -- Attribute: connection

          This read-only attribute provides the SQLite database *note
          Connection: 3cd. used by the *note Cursor: 1c30. object.  A
          *note Cursor: 1c30. object created by calling *note
          con.cursor(): 1c47. will have a *note connection: 1c60.
          attribute that refers to `con':

               >>> con = sqlite3.connect(":memory:")
               >>> cur = con.cursor()
               >>> cur.connection == con
               True


File: python.info,  Node: Row Objects,  Next: Exceptions<4>,  Prev: Cursor Objects,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.4 Row Objects
....................

 -- Class: sqlite3.Row

     A *note Row: 752. instance serves as a highly optimized *note
     row_factory: 1c54. for *note Connection: 3cd. objects.  It tries to
     mimic a tuple in most of its features.

     It supports mapping access by column name and index, iteration,
     representation, equality testing and *note len(): 150.

     If two *note Row: 752. objects have exactly the same columns and
     their members are equal, they compare equal.

      -- Method: keys ()

          This method returns a list of column names.  Immediately after
          a query, it is the first member of each tuple in *note
          Cursor.description: 1c3c.

     Changed in version 3.5: Added support of slicing.

Let’s assume we initialize a table as in the example given above:

     conn = sqlite3.connect(":memory:")
     c = conn.cursor()
     c.execute('''create table stocks
     (date text, trans text, symbol text,
      qty real, price real)''')
     c.execute("""insert into stocks
               values ('2006-01-05','BUY','RHAT',100,35.14)""")
     conn.commit()
     c.close()

Now we plug *note Row: 752. in:

     >>> conn.row_factory = sqlite3.Row
     >>> c = conn.cursor()
     >>> c.execute('select * from stocks')
     <sqlite3.Cursor object at 0x7f4e7dd8fa80>
     >>> r = c.fetchone()
     >>> type(r)
     <class 'sqlite3.Row'>
     >>> tuple(r)
     ('2006-01-05', 'BUY', 'RHAT', 100.0, 35.14)
     >>> len(r)
     5
     >>> r[2]
     'RHAT'
     >>> r.keys()
     ['date', 'trans', 'symbol', 'qty', 'price']
     >>> r['qty']
     100.0
     >>> for member in r:
     ...     print(member)
     ...
     2006-01-05
     BUY
     RHAT
     100.0
     35.14


File: python.info,  Node: Exceptions<4>,  Next: SQLite and Python types,  Prev: Row Objects,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.5 Exceptions
...................

 -- Exception: sqlite3.Warning

     A subclass of *note Exception: 1a8.

 -- Exception: sqlite3.Error

     The base class of the other exceptions in this module.  It is a
     subclass of *note Exception: 1a8.

 -- Exception: sqlite3.DatabaseError

     Exception raised for errors that are related to the database.

 -- Exception: sqlite3.IntegrityError

     Exception raised when the relational integrity of the database is
     affected, e.g.  a foreign key check fails.  It is a subclass of
     *note DatabaseError: 1c67.

 -- Exception: sqlite3.ProgrammingError

     Exception raised for programming errors, e.g.  table not found or
     already exists, syntax error in the SQL statement, wrong number of
     parameters specified, etc.  It is a subclass of *note
     DatabaseError: 1c67.

 -- Exception: sqlite3.OperationalError

     Exception raised for errors that are related to the database’s
     operation and not necessarily under the control of the programmer,
     e.g.  an unexpected disconnect occurs, the data source name is not
     found, a transaction could not be processed, etc.  It is a subclass
     of *note DatabaseError: 1c67.

 -- Exception: sqlite3.NotSupportedError

     Exception raised in case a method or database API was used which is
     not supported by the database, e.g.  calling the *note rollback():
     1c49. method on a connection that does not support transaction or
     has transactions turned off.  It is a subclass of *note
     DatabaseError: 1c67.


File: python.info,  Node: SQLite and Python types,  Next: Controlling Transactions,  Prev: Exceptions<4>,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.6 SQLite and Python types
................................

* Menu:

* Introduction: Introduction<7>.
* Using adapters to store additional Python types in SQLite databases::
* Converting SQLite values to custom Python types::
* Default adapters and converters::


File: python.info,  Node: Introduction<7>,  Next: Using adapters to store additional Python types in SQLite databases,  Up: SQLite and Python types

5.12.6.7 Introduction
.....................

SQLite natively supports the following types: ‘NULL’, ‘INTEGER’, ‘REAL’,
‘TEXT’, ‘BLOB’.

The following Python types can thus be sent to SQLite without any
problem:

Python type                         SQLite type
                                    
------------------------------------------------------
                                    
*note None: 157.                    ‘NULL’
                                    
                                    
*note int: 184.                     ‘INTEGER’
                                    
                                    
*note float: 187.                   ‘REAL’
                                    
                                    
*note str: 325.                     ‘TEXT’
                                    
                                    
*note bytes: 326.                   ‘BLOB’
                                    

This is how SQLite types are converted to Python types by default:

SQLite type       Python type
                  
---------------------------------------------------------------------
                  
‘NULL’            *note None: 157.
                  
                  
‘INTEGER’         *note int: 184.
                  
                  
‘REAL’            *note float: 187.
                  
                  
‘TEXT’            depends on *note text_factory: 1c55,
                  *note str: 325. by default
                  
                  
‘BLOB’            *note bytes: 326.
                  

The type system of the *note sqlite3: f2. module is extensible in two
ways: you can store additional Python types in a SQLite database via
object adaptation, and you can let the *note sqlite3: f2. module convert
SQLite types to different Python types via converters.


File: python.info,  Node: Using adapters to store additional Python types in SQLite databases,  Next: Converting SQLite values to custom Python types,  Prev: Introduction<7>,  Up: SQLite and Python types

5.12.6.8 Using adapters to store additional Python types in SQLite databases
............................................................................

As described before, SQLite supports only a limited set of types
natively.  To use other Python types with SQLite, you must `adapt' them
to one of the sqlite3 module’s supported types for SQLite: one of
NoneType, int, float, str, bytes.

There are two ways to enable the *note sqlite3: f2. module to adapt a
custom Python type to one of the supported ones.

* Menu:

* Letting your object adapt itself::
* Registering an adapter callable::


File: python.info,  Node: Letting your object adapt itself,  Next: Registering an adapter callable,  Up: Using adapters to store additional Python types in SQLite databases

5.12.6.9 Letting your object adapt itself
.........................................

This is a good approach if you write the class yourself.  Let’s suppose
you have a class like this:

     class Point:
         def __init__(self, x, y):
             self.x, self.y = x, y

Now you want to store the point in a single SQLite column.  First you’ll
have to choose one of the supported types first to be used for
representing the point.  Let’s just use str and separate the coordinates
using a semicolon.  Then you need to give your class a method
‘__conform__(self, protocol)’ which must return the converted value.
The parameter `protocol' will be ‘PrepareProtocol’.

     import sqlite3

     class Point:
         def __init__(self, x, y):
             self.x, self.y = x, y

         def __conform__(self, protocol):
             if protocol is sqlite3.PrepareProtocol:
                 return "%f;%f" % (self.x, self.y)

     con = sqlite3.connect(":memory:")
     cur = con.cursor()

     p = Point(4.0, -3.2)
     cur.execute("select ?", (p,))
     print(cur.fetchone()[0])

     con.close()


File: python.info,  Node: Registering an adapter callable,  Prev: Letting your object adapt itself,  Up: Using adapters to store additional Python types in SQLite databases

5.12.6.10 Registering an adapter callable
.........................................

The other possibility is to create a function that converts the type to
the string representation and register the function with *note
register_adapter(): 1c40.

     import sqlite3

     class Point:
         def __init__(self, x, y):
             self.x, self.y = x, y

     def adapt_point(point):
         return "%f;%f" % (point.x, point.y)

     sqlite3.register_adapter(Point, adapt_point)

     con = sqlite3.connect(":memory:")
     cur = con.cursor()

     p = Point(4.0, -3.2)
     cur.execute("select ?", (p,))
     print(cur.fetchone()[0])

     con.close()

The *note sqlite3: f2. module has two default adapters for Python’s
built-in *note datetime.date: 193. and *note datetime.datetime: 194.
types.  Now let’s suppose we want to store *note datetime.datetime: 194.
objects not in ISO representation, but as a Unix timestamp.

     import sqlite3
     import datetime
     import time

     def adapt_datetime(ts):
         return time.mktime(ts.timetuple())

     sqlite3.register_adapter(datetime.datetime, adapt_datetime)

     con = sqlite3.connect(":memory:")
     cur = con.cursor()

     now = datetime.datetime.now()
     cur.execute("select ?", (now,))
     print(cur.fetchone()[0])

     con.close()


File: python.info,  Node: Converting SQLite values to custom Python types,  Next: Default adapters and converters,  Prev: Using adapters to store additional Python types in SQLite databases,  Up: SQLite and Python types

5.12.6.11 Converting SQLite values to custom Python types
.........................................................

Writing an adapter lets you send custom Python types to SQLite.  But to
make it really useful we need to make the Python to SQLite to Python
roundtrip work.

Enter converters.

Let’s go back to the ‘Point’ class.  We stored the x and y coordinates
separated via semicolons as strings in SQLite.

First, we’ll define a converter function that accepts the string as a
parameter and constructs a ‘Point’ object from it.

     Note: Converter functions `always' get called with a *note bytes:
     326. object, no matter under which data type you sent the value to
     SQLite.

     def convert_point(s):
         x, y = map(float, s.split(b";"))
         return Point(x, y)

Now you need to make the *note sqlite3: f2. module know that what you
select from the database is actually a point.  There are two ways of
doing this:

   * Implicitly via the declared type

   * Explicitly via the column name

Both ways are described in section *note Module functions and constants:
1c35, in the entries for the constants *note PARSE_DECLTYPES: 1c3a. and
*note PARSE_COLNAMES: 1c3b.

The following example illustrates both approaches.

     import sqlite3

     class Point:
         def __init__(self, x, y):
             self.x, self.y = x, y

         def __repr__(self):
             return "(%f;%f)" % (self.x, self.y)

     def adapt_point(point):
         return ("%f;%f" % (point.x, point.y)).encode('ascii')

     def convert_point(s):
         x, y = list(map(float, s.split(b";")))
         return Point(x, y)

     # Register the adapter
     sqlite3.register_adapter(Point, adapt_point)

     # Register the converter
     sqlite3.register_converter("point", convert_point)

     p = Point(4.0, -3.2)

     #########################
     # 1) Using declared types
     con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES)
     cur = con.cursor()
     cur.execute("create table test(p point)")

     cur.execute("insert into test(p) values (?)", (p,))
     cur.execute("select p from test")
     print("with declared types:", cur.fetchone()[0])
     cur.close()
     con.close()

     #######################
     # 1) Using column names
     con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_COLNAMES)
     cur = con.cursor()
     cur.execute("create table test(p)")

     cur.execute("insert into test(p) values (?)", (p,))
     cur.execute('select p as "p [point]" from test')
     print("with column names:", cur.fetchone()[0])
     cur.close()
     con.close()


File: python.info,  Node: Default adapters and converters,  Prev: Converting SQLite values to custom Python types,  Up: SQLite and Python types

5.12.6.12 Default adapters and converters
.........................................

There are default adapters for the date and datetime types in the
datetime module.  They will be sent as ISO dates/ISO timestamps to
SQLite.

The default converters are registered under the name “date” for *note
datetime.date: 193. and under the name “timestamp” for *note
datetime.datetime: 194.

This way, you can use date/timestamps from Python without any additional
fiddling in most cases.  The format of the adapters is also compatible
with the experimental SQLite date/time functions.

The following example demonstrates this.

     import sqlite3
     import datetime

     con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES|sqlite3.PARSE_COLNAMES)
     cur = con.cursor()
     cur.execute("create table test(d date, ts timestamp)")

     today = datetime.date.today()
     now = datetime.datetime.now()

     cur.execute("insert into test(d, ts) values (?, ?)", (today, now))
     cur.execute("select d, ts from test")
     row = cur.fetchone()
     print(today, "=>", row[0], type(row[0]))
     print(now, "=>", row[1], type(row[1]))

     cur.execute('select current_date as "d [date]", current_timestamp as "ts [timestamp]"')
     row = cur.fetchone()
     print("current_date", row[0], type(row[0]))
     print("current_timestamp", row[1], type(row[1]))

     con.close()

If a timestamp stored in SQLite has a fractional part longer than 6
numbers, its value will be truncated to microsecond precision by the
timestamp converter.


File: python.info,  Node: Controlling Transactions,  Next: Using sqlite3 efficiently,  Prev: SQLite and Python types,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.13 Controlling Transactions
..................................

The underlying ‘sqlite3’ library operates in ‘autocommit’ mode by
default, but the Python *note sqlite3: f2. module by default does not.

‘autocommit’ mode means that statements that modify the database take
effect immediately.  A ‘BEGIN’ or ‘SAVEPOINT’ statement disables
‘autocommit’ mode, and a ‘COMMIT’, a ‘ROLLBACK’, or a ‘RELEASE’ that
ends the outermost transaction, turns ‘autocommit’ mode back on.

The Python *note sqlite3: f2. module by default issues a ‘BEGIN’
statement implicitly before a Data Modification Language (DML) statement
(i.e.  ‘INSERT’/‘UPDATE’/‘DELETE’/‘REPLACE’).

You can control which kind of ‘BEGIN’ statements *note sqlite3: f2.
implicitly executes via the `isolation_level' parameter to the *note
connect(): 3cf. call, or via the ‘isolation_level’ property of
connections.  If you specify no `isolation_level', a plain ‘BEGIN’ is
used, which is equivalent to specifying ‘DEFERRED’.  Other possible
values are ‘IMMEDIATE’ and ‘EXCLUSIVE’.

You can disable the *note sqlite3: f2. module’s implicit transaction
management by setting ‘isolation_level’ to ‘None’.  This will leave the
underlying ‘sqlite3’ library operating in ‘autocommit’ mode.  You can
then completely control the transaction state by explicitly issuing
‘BEGIN’, ‘ROLLBACK’, ‘SAVEPOINT’, and ‘RELEASE’ statements in your code.

Changed in version 3.6: *note sqlite3: f2. used to implicitly commit an
open transaction before DDL statements.  This is no longer the case.


File: python.info,  Node: Using sqlite3 efficiently,  Next: Common issues,  Prev: Controlling Transactions,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.14 Using ‘sqlite3’ efficiently
.....................................

* Menu:

* Using shortcut methods::
* Accessing columns by name instead of by index::
* Using the connection as a context manager::


File: python.info,  Node: Using shortcut methods,  Next: Accessing columns by name instead of by index,  Up: Using sqlite3 efficiently

5.12.6.15 Using shortcut methods
................................

Using the nonstandard ‘execute()’, ‘executemany()’ and ‘executescript()’
methods of the *note Connection: 3cd. object, your code can be written
more concisely because you don’t have to create the (often superfluous)
*note Cursor: 1c30. objects explicitly.  Instead, the *note Cursor:
1c30. objects are created implicitly and these shortcut methods return
the cursor objects.  This way, you can execute a ‘SELECT’ statement and
iterate over it directly using only a single call on the *note
Connection: 3cd. object.

     import sqlite3

     persons = [
         ("Hugo", "Boss"),
         ("Calvin", "Klein")
         ]

     con = sqlite3.connect(":memory:")

     # Create the table
     con.execute("create table person(firstname, lastname)")

     # Fill the table
     con.executemany("insert into person(firstname, lastname) values (?, ?)", persons)

     # Print the table contents
     for row in con.execute("select firstname, lastname from person"):
         print(row)

     print("I just deleted", con.execute("delete from person").rowcount, "rows")

     # close is not a shortcut method and it's not called automatically,
     # so the connection object should be closed manually
     con.close()


File: python.info,  Node: Accessing columns by name instead of by index,  Next: Using the connection as a context manager,  Prev: Using shortcut methods,  Up: Using sqlite3 efficiently

5.12.6.16 Accessing columns by name instead of by index
.......................................................

One useful feature of the *note sqlite3: f2. module is the built-in
*note sqlite3.Row: 752. class designed to be used as a row factory.

Rows wrapped with this class can be accessed both by index (like tuples)
and case-insensitively by name:

     import sqlite3

     con = sqlite3.connect(":memory:")
     con.row_factory = sqlite3.Row

     cur = con.cursor()
     cur.execute("select 'John' as name, 42 as age")
     for row in cur:
         assert row[0] == row["name"]
         assert row["name"] == row["nAmE"]
         assert row[1] == row["age"]
         assert row[1] == row["AgE"]

     con.close()


File: python.info,  Node: Using the connection as a context manager,  Prev: Accessing columns by name instead of by index,  Up: Using sqlite3 efficiently

5.12.6.17 Using the connection as a context manager
...................................................

Connection objects can be used as context managers that automatically
commit or rollback transactions.  In the event of an exception, the
transaction is rolled back; otherwise, the transaction is committed:

     import sqlite3

     con = sqlite3.connect(":memory:")
     con.execute("create table person (id integer primary key, firstname varchar unique)")

     # Successful, con.commit() is called automatically afterwards
     with con:
         con.execute("insert into person(firstname) values (?)", ("Joe",))

     # con.rollback() is called after the with block finishes with an exception, the
     # exception is still raised and must be caught
     try:
         with con:
             con.execute("insert into person(firstname) values (?)", ("Joe",))
     except sqlite3.IntegrityError:
         print("couldn't add Joe twice")

     # Connection object used as context manager only commits or rollbacks transactions,
     # so the connection object should be closed manually
     con.close()


File: python.info,  Node: Common issues,  Prev: Using sqlite3 efficiently,  Up: sqlite3 — DB-API 2 0 interface for SQLite databases

5.12.6.18 Common issues
.......................

* Menu:

* Multithreading::


File: python.info,  Node: Multithreading,  Up: Common issues

5.12.6.19 Multithreading
........................

Older SQLite versions had issues with sharing connections between
threads.  That’s why the Python module disallows sharing connections and
cursors between threads.  If you still try to do so, you will get an
exception at runtime.

The only exception is calling the *note interrupt(): 1c52. method, which
only makes sense to call from a different thread.


File: python.info,  Node: Data Compression and Archiving,  Next: File Formats,  Prev: Data Persistence,  Up: The Python Standard Library

5.13 Data Compression and Archiving
===================================

The modules described in this chapter support data compression with the
zlib, gzip, bzip2 and lzma algorithms, and the creation of ZIP- and
tar-format archives.  See also *note Archiving operations: b89. provided
by the *note shutil: e9. module.

* Menu:

* zlib — Compression compatible with gzip::
* gzip — Support for gzip files::
* bz2 — Support for bzip2 compression::
* lzma — Compression using the LZMA algorithm::
* zipfile — Work with ZIP archives::
* tarfile — Read and write tar archive files::


File: python.info,  Node: zlib — Compression compatible with gzip,  Next: gzip — Support for gzip files,  Up: Data Compression and Archiving

5.13.1 ‘zlib’ — Compression compatible with ‘gzip’
--------------------------------------------------

__________________________________________________________________

For applications that require data compression, the functions in this
module allow compression and decompression, using the zlib library.  The
zlib library has its own home page at ‘http://www.zlib.net’.  There are
known incompatibilities between the Python module and versions of the
zlib library earlier than 1.1.3; 1.1.3 has a security vulnerability, so
we recommend using 1.1.4 or later.

zlib’s functions have many options and often need to be used in a
particular order.  This documentation doesn’t attempt to cover all of
the permutations; consult the zlib manual at
‘http://www.zlib.net/manual.html’ for authoritative information.

For reading and writing ‘.gz’ files see the *note gzip: 8c. module.

The available exception and functions in this module are:

 -- Exception: zlib.error

     Exception raised on compression and decompression errors.

 -- Function: zlib.adler32 (data[, value])

     Computes an Adler-32 checksum of `data'.  (An Adler-32 checksum is
     almost as reliable as a CRC32 but can be computed much more
     quickly.)  The result is an unsigned 32-bit integer.  If `value' is
     present, it is used as the starting value of the checksum;
     otherwise, a default value of 1 is used.  Passing in `value' allows
     computing a running checksum over the concatenation of several
     inputs.  The algorithm is not cryptographically strong, and should
     not be used for authentication or digital signatures.  Since the
     algorithm is designed for use as a checksum algorithm, it is not
     suitable for use as a general hash algorithm.

     Changed in version 3.0: Always returns an unsigned value.  To
     generate the same numeric value across all Python versions and
     platforms, use ‘adler32(data) & 0xffffffff’.

 -- Function: zlib.compress (data, level=-1)

     Compresses the bytes in `data', returning a bytes object containing
     compressed data.  `level' is an integer from ‘0’ to ‘9’ or ‘-1’
     controlling the level of compression; ‘1’ (Z_BEST_SPEED) is fastest
     and produces the least compression, ‘9’ (Z_BEST_COMPRESSION) is
     slowest and produces the most.  ‘0’ (Z_NO_COMPRESSION) is no
     compression.  The default value is ‘-1’ (Z_DEFAULT_COMPRESSION).
     Z_DEFAULT_COMPRESSION represents a default compromise between speed
     and compression (currently equivalent to level 6).  Raises the
     *note error: 1c7b. exception if any error occurs.

     Changed in version 3.6: `level' can now be used as a keyword
     parameter.

 -- Function: zlib.compressobj (level=-1, method=DEFLATED,
          wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL,
          strategy=Z_DEFAULT_STRATEGY[, zdict])

     Returns a compression object, to be used for compressing data
     streams that won’t fit into memory at once.

     `level' is the compression level – an integer from ‘0’ to ‘9’ or
     ‘-1’.  A value of ‘1’ (Z_BEST_SPEED) is fastest and produces the
     least compression, while a value of ‘9’ (Z_BEST_COMPRESSION) is
     slowest and produces the most.  ‘0’ (Z_NO_COMPRESSION) is no
     compression.  The default value is ‘-1’ (Z_DEFAULT_COMPRESSION).
     Z_DEFAULT_COMPRESSION represents a default compromise between speed
     and compression (currently equivalent to level 6).

     `method' is the compression algorithm.  Currently, the only
     supported value is ‘DEFLATED’.

     The `wbits' argument controls the size of the history buffer (or
     the “window size”) used when compressing data, and whether a header
     and trailer is included in the output.  It can take several ranges
     of values, defaulting to ‘15’ (MAX_WBITS):

        * +9 to +15: The base-two logarithm of the window size, which
          therefore ranges between 512 and 32768.  Larger values produce
          better compression at the expense of greater memory usage.
          The resulting output will include a zlib-specific header and
          trailer.

        * −9 to −15: Uses the absolute value of `wbits' as the window
          size logarithm, while producing a raw output stream with no
          header or trailing checksum.

        * +25 to +31 = 16 + (9 to 15): Uses the low 4 bits of the value
          as the window size logarithm, while including a basic ‘gzip’
          header and trailing checksum in the output.

     The `memLevel' argument controls the amount of memory used for the
     internal compression state.  Valid values range from ‘1’ to ‘9’.
     Higher values use more memory, but are faster and produce smaller
     output.

     `strategy' is used to tune the compression algorithm.  Possible
     values are ‘Z_DEFAULT_STRATEGY’, ‘Z_FILTERED’, ‘Z_HUFFMAN_ONLY’,
     ‘Z_RLE’ (zlib 1.2.0.1) and ‘Z_FIXED’ (zlib 1.2.2.2).

     `zdict' is a predefined compression dictionary.  This is a sequence
     of bytes (such as a *note bytes: 326. object) containing
     subsequences that are expected to occur frequently in the data that
     is to be compressed.  Those subsequences that are expected to be
     most common should come at the end of the dictionary.

     Changed in version 3.3: Added the `zdict' parameter and keyword
     argument support.

 -- Function: zlib.crc32 (data[, value])

     Computes a CRC (Cyclic Redundancy Check) checksum of `data'.  The
     result is an unsigned 32-bit integer.  If `value' is present, it is
     used as the starting value of the checksum; otherwise, a default
     value of 0 is used.  Passing in `value' allows computing a running
     checksum over the concatenation of several inputs.  The algorithm
     is not cryptographically strong, and should not be used for
     authentication or digital signatures.  Since the algorithm is
     designed for use as a checksum algorithm, it is not suitable for
     use as a general hash algorithm.

     Changed in version 3.0: Always returns an unsigned value.  To
     generate the same numeric value across all Python versions and
     platforms, use ‘crc32(data) & 0xffffffff’.

 -- Function: zlib.decompress (data, wbits=MAX_WBITS,
          bufsize=DEF_BUF_SIZE)

     Decompresses the bytes in `data', returning a bytes object
     containing the uncompressed data.  The `wbits' parameter depends on
     the format of `data', and is discussed further below.  If `bufsize'
     is given, it is used as the initial size of the output buffer.
     Raises the *note error: 1c7b. exception if any error occurs.  The
     `wbits' parameter controls the size of the history buffer (or
     “window size”), and what header and trailer format is expected.  It
     is similar to the parameter for *note compressobj(): 1c7d, but
     accepts more ranges of values:

        * +8 to +15: The base-two logarithm of the window size.  The
          input must include a zlib header and trailer.

        * 0: Automatically determine the window size from the zlib
          header.  Only supported since zlib 1.2.3.5.

        * −8 to −15: Uses the absolute value of `wbits' as the window
          size logarithm.  The input must be a raw stream with no header
          or trailer.

        * +24 to +31 = 16 + (8 to 15): Uses the low 4 bits of the value
          as the window size logarithm.  The input must include a gzip
          header and trailer.

        * +40 to +47 = 32 + (8 to 15): Uses the low 4 bits of the value
          as the window size logarithm, and automatically accepts either
          the zlib or gzip format.

     When decompressing a stream, the window size must not be smaller
     than the size originally used to compress the stream; using a
     too-small value may result in an *note error: 1c7b. exception.  The
     default `wbits' value corresponds to the largest window size and
     requires a zlib header and trailer to be included.

     `bufsize' is the initial size of the buffer used to hold
     decompressed data.  If more space is required, the buffer size will
     be increased as needed, so you don’t have to get this value exactly
     right; tuning it will only save a few calls to ‘malloc()’.

     Changed in version 3.6: `wbits' and `bufsize' can be used as
     keyword arguments.

 -- Function: zlib.decompressobj (wbits=MAX_WBITS[, zdict])

     Returns a decompression object, to be used for decompressing data
     streams that won’t fit into memory at once.

     The `wbits' parameter controls the size of the history buffer (or
     the “window size”), and what header and trailer format is expected.
     It has the same meaning as *note described for decompress(): 1c7f.

     The `zdict' parameter specifies a predefined compression
     dictionary.  If provided, this must be the same dictionary as was
     used by the compressor that produced the data that is to be
     decompressed.

          Note: If `zdict' is a mutable object (such as a *note
          bytearray: 327.), you must not modify its contents between the
          call to *note decompressobj(): 1c80. and the first call to the
          decompressor’s ‘decompress()’ method.

     Changed in version 3.3: Added the `zdict' parameter.

Compression objects support the following methods:

 -- Method: Compress.compress (data)

     Compress `data', returning a bytes object containing compressed
     data for at least part of the data in `data'.  This data should be
     concatenated to the output produced by any preceding calls to the
     *note compress(): 5b3. method.  Some input may be kept in internal
     buffers for later processing.

 -- Method: Compress.flush ([mode])

     All pending input is processed, and a bytes object containing the
     remaining compressed output is returned.  `mode' can be selected
     from the constants ‘Z_NO_FLUSH’, ‘Z_PARTIAL_FLUSH’, ‘Z_SYNC_FLUSH’,
     ‘Z_FULL_FLUSH’, ‘Z_BLOCK’ (zlib 1.2.3.4), or ‘Z_FINISH’, defaulting
     to ‘Z_FINISH’.  Except ‘Z_FINISH’, all constants allow compressing
     further bytestrings of data, while ‘Z_FINISH’ finishes the
     compressed stream and prevents compressing any more data.  After
     calling *note flush(): 1c82. with `mode' set to ‘Z_FINISH’, the
     *note compress(): 5b3. method cannot be called again; the only
     realistic action is to delete the object.

 -- Method: Compress.copy ()

     Returns a copy of the compression object.  This can be used to
     efficiently compress a set of data that share a common initial
     prefix.

Changed in version 3.8: Added *note copy.copy(): 3c0. and *note
copy.deepcopy(): 3c1. support to compression objects.

Decompression objects support the following methods and attributes:

 -- Attribute: Decompress.unused_data

     A bytes object which contains any bytes past the end of the
     compressed data.  That is, this remains ‘b""’ until the last byte
     that contains compression data is available.  If the whole
     bytestring turned out to contain compressed data, this is ‘b""’, an
     empty bytes object.

 -- Attribute: Decompress.unconsumed_tail

     A bytes object that contains any data that was not consumed by the
     last *note decompress(): 5b4. call because it exceeded the limit
     for the uncompressed data buffer.  This data has not yet been seen
     by the zlib machinery, so you must feed it (possibly with further
     data concatenated to it) back to a subsequent *note decompress():
     5b4. method call in order to get correct output.

 -- Attribute: Decompress.eof

     A boolean indicating whether the end of the compressed data stream
     has been reached.

     This makes it possible to distinguish between a properly-formed
     compressed stream, and an incomplete or truncated one.

     New in version 3.3.

 -- Method: Decompress.decompress (data, max_length=0)

     Decompress `data', returning a bytes object containing the
     uncompressed data corresponding to at least part of the data in
     `string'.  This data should be concatenated to the output produced
     by any preceding calls to the *note decompress(): 5b4. method.
     Some of the input data may be preserved in internal buffers for
     later processing.

     If the optional parameter `max_length' is non-zero then the return
     value will be no longer than `max_length'.  This may mean that not
     all of the compressed input can be processed; and unconsumed data
     will be stored in the attribute *note unconsumed_tail: 1c85.  This
     bytestring must be passed to a subsequent call to *note
     decompress(): 5b4. if decompression is to continue.  If
     `max_length' is zero then the whole input is decompressed, and
     *note unconsumed_tail: 1c85. is empty.

     Changed in version 3.6: `max_length' can be used as a keyword
     argument.

 -- Method: Decompress.flush ([length])

     All pending input is processed, and a bytes object containing the
     remaining uncompressed output is returned.  After calling *note
     flush(): 1c87, the *note decompress(): 5b4. method cannot be called
     again; the only realistic action is to delete the object.

     The optional parameter `length' sets the initial size of the output
     buffer.

 -- Method: Decompress.copy ()

     Returns a copy of the decompression object.  This can be used to
     save the state of the decompressor midway through the data stream
     in order to speed up random seeks into the stream at a future
     point.

Changed in version 3.8: Added *note copy.copy(): 3c0. and *note
copy.deepcopy(): 3c1. support to decompression objects.

Information about the version of the zlib library in use is available
through the following constants:

 -- Data: zlib.ZLIB_VERSION

     The version string of the zlib library that was used for building
     the module.  This may be different from the zlib library actually
     used at runtime, which is available as *note ZLIB_RUNTIME_VERSION:
     abc.

 -- Data: zlib.ZLIB_RUNTIME_VERSION

     The version string of the zlib library actually loaded by the
     interpreter.

     New in version 3.3.

See also
........

Module *note gzip: 8c.

     Reading and writing ‘gzip’-format files.

‘http://www.zlib.net’

     The zlib library home page.

‘http://www.zlib.net/manual.html’

     The zlib manual explains the semantics and usage of the library’s
     many functions.


File: python.info,  Node: gzip — Support for gzip files,  Next: bz2 — Support for bzip2 compression,  Prev: zlib — Compression compatible with gzip,  Up: Data Compression and Archiving

5.13.2 ‘gzip’ — Support for ‘gzip’ files
----------------------------------------

`Source code:' Lib/gzip.py(1)

__________________________________________________________________

This module provides a simple interface to compress and decompress files
just like the GNU programs ‘gzip’ and ‘gunzip’ would.

The data compression is provided by the *note zlib: 144. module.

The *note gzip: 8c. module provides the *note GzipFile: 6d1. class, as
well as the *note open(): 1c8c, *note compress(): 1cf. and *note
decompress(): b7c. convenience functions.  The *note GzipFile: 6d1.
class reads and writes ‘gzip’-format files, automatically compressing or
decompressing the data so that it looks like an ordinary *note file
object: b35.

Note that additional file formats which can be decompressed by the
‘gzip’ and ‘gunzip’ programs, such as those produced by ‘compress’ and
‘pack’, are not supported by this module.

The module defines the following items:

 -- Function: gzip.open (filename, mode='rb', compresslevel=9,
          encoding=None, errors=None, newline=None)

     Open a gzip-compressed file in binary or text mode, returning a
     *note file object: b35.

     The `filename' argument can be an actual filename (a *note str:
     325. or *note bytes: 326. object), or an existing file object to
     read from or write to.

     The `mode' argument can be any of ‘'r'’, ‘'rb'’, ‘'a'’, ‘'ab'’,
     ‘'w'’, ‘'wb'’, ‘'x'’ or ‘'xb'’ for binary mode, or ‘'rt'’, ‘'at'’,
     ‘'wt'’, or ‘'xt'’ for text mode.  The default is ‘'rb'’.

     The `compresslevel' argument is an integer from 0 to 9, as for the
     *note GzipFile: 6d1. constructor.

     For binary mode, this function is equivalent to the *note GzipFile:
     6d1. constructor: ‘GzipFile(filename, mode, compresslevel)’.  In
     this case, the `encoding', `errors' and `newline' arguments must
     not be provided.

     For text mode, a *note GzipFile: 6d1. object is created, and
     wrapped in an *note io.TextIOWrapper: 5e8. instance with the
     specified encoding, error handling behavior, and line ending(s).

     Changed in version 3.3: Added support for `filename' being a file
     object, support for text mode, and the `encoding', `errors' and
     `newline' arguments.

     Changed in version 3.4: Added support for the ‘'x'’, ‘'xb'’ and
     ‘'xt'’ modes.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Exception: gzip.BadGzipFile

     An exception raised for invalid gzip files.  It inherits *note
     OSError: 1d1.  *note EOFError: c5f. and *note zlib.error: 1c7b. can
     also be raised for invalid gzip files.

     New in version 3.8.

 -- Class: gzip.GzipFile (filename=None, mode=None, compresslevel=9,
          fileobj=None, mtime=None)

     Constructor for the *note GzipFile: 6d1. class, which simulates
     most of the methods of a *note file object: b35, with the exception
     of the ‘truncate()’ method.  At least one of `fileobj' and
     `filename' must be given a non-trivial value.

     The new class instance is based on `fileobj', which can be a
     regular file, an *note io.BytesIO: 78f. object, or any other object
     which simulates a file.  It defaults to ‘None’, in which case
     `filename' is opened to provide a file object.

     When `fileobj' is not ‘None’, the `filename' argument is only used
     to be included in the ‘gzip’ file header, which may include the
     original filename of the uncompressed file.  It defaults to the
     filename of `fileobj', if discernible; otherwise, it defaults to
     the empty string, and in this case the original filename is not
     included in the header.

     The `mode' argument can be any of ‘'r'’, ‘'rb'’, ‘'a'’, ‘'ab'’,
     ‘'w'’, ‘'wb'’, ‘'x'’, or ‘'xb'’, depending on whether the file will
     be read or written.  The default is the mode of `fileobj' if
     discernible; otherwise, the default is ‘'rb'’.

     Note that the file is always opened in binary mode.  To open a
     compressed file in text mode, use *note open(): 1c8c. (or wrap your
     *note GzipFile: 6d1. with an *note io.TextIOWrapper: 5e8.).

     The `compresslevel' argument is an integer from ‘0’ to ‘9’
     controlling the level of compression; ‘1’ is fastest and produces
     the least compression, and ‘9’ is slowest and produces the most
     compression.  ‘0’ is no compression.  The default is ‘9’.

     The `mtime' argument is an optional numeric timestamp to be written
     to the last modification time field in the stream when compressing.
     It should only be provided in compression mode.  If omitted or
     ‘None’, the current time is used.  See the *note mtime: 1c8d.
     attribute for more details.

     Calling a *note GzipFile: 6d1. object’s ‘close()’ method does not
     close `fileobj', since you might wish to append more material after
     the compressed data.  This also allows you to pass an *note
     io.BytesIO: 78f. object opened for writing as `fileobj', and
     retrieve the resulting memory buffer using the *note io.BytesIO:
     78f. object’s *note getvalue(): 1c8e. method.

     *note GzipFile: 6d1. supports the *note io.BufferedIOBase: 57d.
     interface, including iteration and the *note with: 6dd. statement.
     Only the ‘truncate()’ method isn’t implemented.

     *note GzipFile: 6d1. also provides the following method and
     attribute:

      -- Method: peek (n)

          Read `n' uncompressed bytes without advancing the file
          position.  At most one single read on the compressed stream is
          done to satisfy the call.  The number of bytes returned may be
          more or less than requested.

               Note: While calling *note peek(): b7b. does not change
               the file position of the *note GzipFile: 6d1, it may
               change the position of the underlying file object (e.g.
               if the *note GzipFile: 6d1. was constructed with the
               `fileobj' parameter).

          New in version 3.2.

      -- Attribute: mtime

          When decompressing, the value of the last modification time
          field in the most recently read header may be read from this
          attribute, as an integer.  The initial value before reading
          any headers is ‘None’.

          All ‘gzip’ compressed streams are required to contain this
          timestamp field.  Some programs, such as ‘gunzip’, make use of
          the timestamp.  The format is the same as the return value of
          *note time.time(): 312. and the *note st_mtime: 1c8f.
          attribute of the object returned by *note os.stat(): 1ef.

     Changed in version 3.1: Support for the *note with: 6dd. statement
     was added, along with the `mtime' constructor argument and *note
     mtime: 1c8d. attribute.

     Changed in version 3.2: Support for zero-padded and unseekable
     files was added.

     Changed in version 3.3: The *note io.BufferedIOBase.read1(): 1c90.
     method is now implemented.

     Changed in version 3.4: Added support for the ‘'x'’ and ‘'xb'’
     modes.

     Changed in version 3.5: Added support for writing arbitrary *note
     bytes-like objects: 5dd.  The *note read(): 1c91. method now
     accepts an argument of ‘None’.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: gzip.compress (data, compresslevel=9, *, mtime=None)

     Compress the `data', returning a *note bytes: 326. object
     containing the compressed data.  `compresslevel' and `mtime' have
     the same meaning as in the *note GzipFile: 6d1. constructor above.

     New in version 3.2.

     Changed in version 3.8: Added the `mtime' parameter for
     reproducible output.

 -- Function: gzip.decompress (data)

     Decompress the `data', returning a *note bytes: 326. object
     containing the uncompressed data.

     New in version 3.2.

* Menu:

* Examples of usage::
* Command Line Interface::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/gzip.py


File: python.info,  Node: Examples of usage,  Next: Command Line Interface,  Up: gzip — Support for gzip files

5.13.2.1 Examples of usage
..........................

Example of how to read a compressed file:

     import gzip
     with gzip.open('/home/joe/file.txt.gz', 'rb') as f:
         file_content = f.read()

Example of how to create a compressed GZIP file:

     import gzip
     content = b"Lots of content here"
     with gzip.open('/home/joe/file.txt.gz', 'wb') as f:
         f.write(content)

Example of how to GZIP compress an existing file:

     import gzip
     import shutil
     with open('/home/joe/file.txt', 'rb') as f_in:
         with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out:
             shutil.copyfileobj(f_in, f_out)

Example of how to GZIP compress a binary string:

     import gzip
     s_in = b"Lots of content here"
     s_out = gzip.compress(s_in)

See also
........

Module *note zlib: 144.

     The basic data compression module needed to support the ‘gzip’ file
     format.


File: python.info,  Node: Command Line Interface,  Prev: Examples of usage,  Up: gzip — Support for gzip files

5.13.2.2 Command Line Interface
...............................

The *note gzip: 8c. module provides a simple command line interface to
compress or decompress files.

Once executed the *note gzip: 8c. module keeps the input file(s).

Changed in version 3.8: Add a new command line interface with a usage.
By default, when you will execute the CLI, the default compression level
is 6.

* Menu:

* Command line options::


File: python.info,  Node: Command line options,  Up: Command Line Interface

5.13.2.3 Command line options
.............................

 -- Program Option: file

     If `file' is not specified, read from *note sys.stdin: 302.

 -- Program Option: --fast

     Indicates the fastest compression method (less compression).

 -- Program Option: --best

     Indicates the slowest compression method (best compression).

 -- Program Option: -d, --decompress

     Decompress the given file.

 -- Program Option: -h, --help

     Show the help message.


File: python.info,  Node: bz2 — Support for bzip2 compression,  Next: lzma — Compression using the LZMA algorithm,  Prev: gzip — Support for gzip files,  Up: Data Compression and Archiving

5.13.3 ‘bz2’ — Support for ‘bzip2’ compression
----------------------------------------------

`Source code:' Lib/bz2.py(1)

__________________________________________________________________

This module provides a comprehensive interface for compressing and
decompressing data using the bzip2 compression algorithm.

The *note bz2: 14. module contains:

   * The *note open(): 9ca. function and *note BZ2File: 925. class for
     reading and writing compressed files.

   * The *note BZ2Compressor: 1c9d. and *note BZ2Decompressor: 1c9e.
     classes for incremental (de)compression.

   * The *note compress(): 17ae. and *note decompress(): 9cb. functions
     for one-shot (de)compression.

All of the classes in this module may safely be accessed from multiple
threads.

* Menu:

* (De)compression of files: De compression of files.
* Incremental (de)compression: Incremental de compression.
* One-shot (de)compression: One-shot de compression.
* Examples of usage: Examples of usage<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/bz2.py


File: python.info,  Node: De compression of files,  Next: Incremental de compression,  Up: bz2 — Support for bzip2 compression

5.13.3.1 (De)compression of files
.................................

 -- Function: bz2.open (filename, mode='r', compresslevel=9,
          encoding=None, errors=None, newline=None)

     Open a bzip2-compressed file in binary or text mode, returning a
     *note file object: b35.

     As with the constructor for *note BZ2File: 925, the `filename'
     argument can be an actual filename (a *note str: 325. or *note
     bytes: 326. object), or an existing file object to read from or
     write to.

     The `mode' argument can be any of ‘'r'’, ‘'rb'’, ‘'w'’, ‘'wb'’,
     ‘'x'’, ‘'xb'’, ‘'a'’ or ‘'ab'’ for binary mode, or ‘'rt'’, ‘'wt'’,
     ‘'xt'’, or ‘'at'’ for text mode.  The default is ‘'rb'’.

     The `compresslevel' argument is an integer from 1 to 9, as for the
     *note BZ2File: 925. constructor.

     For binary mode, this function is equivalent to the *note BZ2File:
     925. constructor: ‘BZ2File(filename, mode,
     compresslevel=compresslevel)’.  In this case, the `encoding',
     `errors' and `newline' arguments must not be provided.

     For text mode, a *note BZ2File: 925. object is created, and wrapped
     in an *note io.TextIOWrapper: 5e8. instance with the specified
     encoding, error handling behavior, and line ending(s).

     New in version 3.3.

     Changed in version 3.4: The ‘'x'’ (exclusive creation) mode was
     added.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Class: bz2.BZ2File (filename, mode='r', buffering=None,
          compresslevel=9)

     Open a bzip2-compressed file in binary mode.

     If `filename' is a *note str: 325. or *note bytes: 326. object,
     open the named file directly.  Otherwise, `filename' should be a
     *note file object: b35, which will be used to read or write the
     compressed data.

     The `mode' argument can be either ‘'r'’ for reading (default),
     ‘'w'’ for overwriting, ‘'x'’ for exclusive creation, or ‘'a'’ for
     appending.  These can equivalently be given as ‘'rb'’, ‘'wb'’,
     ‘'xb'’ and ‘'ab'’ respectively.

     If `filename' is a file object (rather than an actual file name), a
     mode of ‘'w'’ does not truncate the file, and is instead equivalent
     to ‘'a'’.

     The `buffering' argument is ignored.  Its use is deprecated since
     Python 3.0.

     If `mode' is ‘'w'’ or ‘'a'’, `compresslevel' can be an integer
     between ‘1’ and ‘9’ specifying the level of compression: ‘1’
     produces the least compression, and ‘9’ (default) produces the most
     compression.

     If `mode' is ‘'r'’, the input file may be the concatenation of
     multiple compressed streams.

     *note BZ2File: 925. provides all of the members specified by the
     *note io.BufferedIOBase: 57d, except for ‘detach()’ and
     ‘truncate()’.  Iteration and the *note with: 6dd. statement are
     supported.

     *note BZ2File: 925. also provides the following method:

      -- Method: peek ([n])

          Return buffered data without advancing the file position.  At
          least one byte of data will be returned (unless at EOF). The
          exact number of bytes returned is unspecified.

               Note: While calling *note peek(): 1ca0. does not change
               the file position of the *note BZ2File: 925, it may
               change the position of the underlying file object (e.g.
               if the *note BZ2File: 925. was constructed by passing a
               file object for `filename').

          New in version 3.3.

     Deprecated since version 3.0: The keyword argument `buffering' was
     deprecated and is now ignored.

     Changed in version 3.1: Support for the *note with: 6dd. statement
     was added.

     Changed in version 3.3: The ‘fileno()’, ‘readable()’, ‘seekable()’,
     ‘writable()’, ‘read1()’ and ‘readinto()’ methods were added.

     Changed in version 3.3: Support was added for `filename' being a
     *note file object: b35. instead of an actual filename.

     Changed in version 3.3: The ‘'a'’ (append) mode was added, along
     with support for reading multi-stream files.

     Changed in version 3.4: The ‘'x'’ (exclusive creation) mode was
     added.

     Changed in version 3.5: The *note read(): 1c91. method now accepts
     an argument of ‘None’.

     Changed in version 3.6: Accepts a *note path-like object: 35f.


File: python.info,  Node: Incremental de compression,  Next: One-shot de compression,  Prev: De compression of files,  Up: bz2 — Support for bzip2 compression

5.13.3.2 Incremental (de)compression
....................................

 -- Class: bz2.BZ2Compressor (compresslevel=9)

     Create a new compressor object.  This object may be used to
     compress data incrementally.  For one-shot compression, use the
     *note compress(): 17ae. function instead.

     `compresslevel', if given, must be an integer between ‘1’ and ‘9’.
     The default is ‘9’.

      -- Method: compress (data)

          Provide data to the compressor object.  Returns a chunk of
          compressed data if possible, or an empty byte string
          otherwise.

          When you have finished providing data to the compressor, call
          the *note flush(): 1ca3. method to finish the compression
          process.

      -- Method: flush ()

          Finish the compression process.  Returns the compressed data
          left in internal buffers.

          The compressor object may not be used after this method has
          been called.

 -- Class: bz2.BZ2Decompressor

     Create a new decompressor object.  This object may be used to
     decompress data incrementally.  For one-shot compression, use the
     *note decompress(): 9cb. function instead.

          Note: This class does not transparently handle inputs
          containing multiple compressed streams, unlike *note
          decompress(): 9cb. and *note BZ2File: 925.  If you need to
          decompress a multi-stream input with *note BZ2Decompressor:
          1c9e, you must use a new decompressor for each stream.

      -- Method: decompress (data, max_length=-1)

          Decompress `data' (a *note bytes-like object: 5dd.), returning
          uncompressed data as bytes.  Some of `data' may be buffered
          internally, for use in later calls to *note decompress(): 9cb.
          The returned data should be concatenated with the output of
          any previous calls to *note decompress(): 9cb.

          If `max_length' is nonnegative, returns at most `max_length'
          bytes of decompressed data.  If this limit is reached and
          further output can be produced, the *note needs_input: 1ca4.
          attribute will be set to ‘False’.  In this case, the next call
          to *note decompress(): 697. may provide `data' as ‘b''’ to
          obtain more of the output.

          If all of the input data was decompressed and returned (either
          because this was less than `max_length' bytes, or because
          `max_length' was negative), the *note needs_input: 1ca4.
          attribute will be set to ‘True’.

          Attempting to decompress data after the end of stream is
          reached raises an ‘EOFError’.  Any data found after the end of
          the stream is ignored and saved in the *note unused_data:
          1ca5. attribute.

          Changed in version 3.5: Added the `max_length' parameter.

      -- Attribute: eof

          ‘True’ if the end-of-stream marker has been reached.

          New in version 3.3.

      -- Attribute: unused_data

          Data found after the end of the compressed stream.

          If this attribute is accessed before the end of the stream has
          been reached, its value will be ‘b''’.

      -- Attribute: needs_input

          ‘False’ if the *note decompress(): 697. method can provide
          more decompressed data before requiring new uncompressed
          input.

          New in version 3.5.


File: python.info,  Node: One-shot de compression,  Next: Examples of usage<2>,  Prev: Incremental de compression,  Up: bz2 — Support for bzip2 compression

5.13.3.3 One-shot (de)compression
.................................

 -- Function: bz2.compress (data, compresslevel=9)

     Compress `data', a *note bytes-like object: 5dd.

     `compresslevel', if given, must be an integer between ‘1’ and ‘9’.
     The default is ‘9’.

     For incremental compression, use a *note BZ2Compressor: 1c9d.
     instead.

 -- Function: bz2.decompress (data)

     Decompress `data', a *note bytes-like object: 5dd.

     If `data' is the concatenation of multiple compressed streams,
     decompress all of the streams.

     For incremental decompression, use a *note BZ2Decompressor: 1c9e.
     instead.

     Changed in version 3.3: Support for multi-stream inputs was added.


File: python.info,  Node: Examples of usage<2>,  Prev: One-shot de compression,  Up: bz2 — Support for bzip2 compression

5.13.3.4 Examples of usage
..........................

Below are some examples of typical usage of the *note bz2: 14. module.

Using *note compress(): 17ae. and *note decompress(): 9cb. to
demonstrate round-trip compression:

     >>> import bz2

     >>> data = b"""\
     ... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
     ... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
     ... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
     ... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
     ... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
     ... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
     ... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""

     >>> c = bz2.compress(data)
     >>> len(data) / len(c)  # Data compression ratio
     1.513595166163142

     >>> d = bz2.decompress(c)
     >>> data == d  # Check equality to original object after round-trip
     True

Using *note BZ2Compressor: 1c9d. for incremental compression:

     >>> import bz2

     >>> def gen_data(chunks=10, chunksize=1000):
     ...     """Yield incremental blocks of chunksize bytes."""
     ...     for _ in range(chunks):
     ...         yield b"z" * chunksize
     ...
     >>> comp = bz2.BZ2Compressor()
     >>> out = b""
     >>> for chunk in gen_data():
     ...     # Provide data to the compressor object
     ...     out = out + comp.compress(chunk)
     ...
     >>> # Finish the compression process.  Call this once you have
     >>> # finished providing data to the compressor.
     >>> out = out + comp.flush()

The example above uses a very “nonrandom” stream of data (a stream of
‘b”z”’ chunks).  Random data tends to compress poorly, while ordered,
repetitive data usually yields a high compression ratio.

Writing and reading a bzip2-compressed file in binary mode:

     >>> import bz2

     >>> data = b"""\
     ... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
     ... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
     ... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
     ... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
     ... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
     ... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
     ... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""

     >>> with bz2.open("myfile.bz2", "wb") as f:
     ...     # Write compressed data to file
     ...     unused = f.write(data)

     >>> with bz2.open("myfile.bz2", "rb") as f:
     ...     # Decompress data from file
     ...     content = f.read()

     >>> content == data  # Check equality to original object after round-trip
     True


File: python.info,  Node: lzma — Compression using the LZMA algorithm,  Next: zipfile — Work with ZIP archives,  Prev: bz2 — Support for bzip2 compression,  Up: Data Compression and Archiving

5.13.4 ‘lzma’ — Compression using the LZMA algorithm
----------------------------------------------------

New in version 3.3.

`Source code:' Lib/lzma.py(1)

__________________________________________________________________

This module provides classes and convenience functions for compressing
and decompressing data using the LZMA compression algorithm.  Also
included is a file interface supporting the ‘.xz’ and legacy ‘.lzma’
file formats used by the ‘xz’ utility, as well as raw compressed
streams.

The interface provided by this module is very similar to that of the
*note bz2: 14. module.  However, note that *note LZMAFile: 926. is `not'
thread-safe, unlike *note bz2.BZ2File: 925, so if you need to use a
single *note LZMAFile: 926. instance from multiple threads, it is
necessary to protect it with a lock.

 -- Exception: lzma.LZMAError

     This exception is raised when an error occurs during compression or
     decompression, or while initializing the compressor/decompressor
     state.

* Menu:

* Reading and writing compressed files::
* Compressing and decompressing data in memory::
* Miscellaneous: Miscellaneous<2>.
* Specifying custom filter chains::
* Examples: Examples<5>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/lzma.py


File: python.info,  Node: Reading and writing compressed files,  Next: Compressing and decompressing data in memory,  Up: lzma — Compression using the LZMA algorithm

5.13.4.1 Reading and writing compressed files
.............................................

 -- Function: lzma.open (filename, mode="rb", *, format=None, check=-1,
          preset=None, filters=None, encoding=None, errors=None,
          newline=None)

     Open an LZMA-compressed file in binary or text mode, returning a
     *note file object: b35.

     The `filename' argument can be either an actual file name (given as
     a *note str: 325, *note bytes: 326. or *note path-like: 35f.
     object), in which case the named file is opened, or it can be an
     existing file object to read from or write to.

     The `mode' argument can be any of ‘"r"’, ‘"rb"’, ‘"w"’, ‘"wb"’,
     ‘"x"’, ‘"xb"’, ‘"a"’ or ‘"ab"’ for binary mode, or ‘"rt"’, ‘"wt"’,
     ‘"xt"’, or ‘"at"’ for text mode.  The default is ‘"rb"’.

     When opening a file for reading, the `format' and `filters'
     arguments have the same meanings as for *note LZMADecompressor:
     1caf.  In this case, the `check' and `preset' arguments should not
     be used.

     When opening a file for writing, the `format', `check', `preset'
     and `filters' arguments have the same meanings as for *note
     LZMACompressor: 1cb0.

     For binary mode, this function is equivalent to the *note LZMAFile:
     926. constructor: ‘LZMAFile(filename, mode, ...)’.  In this case,
     the `encoding', `errors' and `newline' arguments must not be
     provided.

     For text mode, a *note LZMAFile: 926. object is created, and
     wrapped in an *note io.TextIOWrapper: 5e8. instance with the
     specified encoding, error handling behavior, and line ending(s).

     Changed in version 3.4: Added support for the ‘"x"’, ‘"xb"’ and
     ‘"xt"’ modes.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Class: lzma.LZMAFile (filename=None, mode="r", *, format=None,
          check=-1, preset=None, filters=None)

     Open an LZMA-compressed file in binary mode.

     An *note LZMAFile: 926. can wrap an already-open *note file object:
     b35, or operate directly on a named file.  The `filename' argument
     specifies either the file object to wrap, or the name of the file
     to open (as a *note str: 325, *note bytes: 326. or *note path-like:
     35f. object).  When wrapping an existing file object, the wrapped
     file will not be closed when the *note LZMAFile: 926. is closed.

     The `mode' argument can be either ‘"r"’ for reading (default),
     ‘"w"’ for overwriting, ‘"x"’ for exclusive creation, or ‘"a"’ for
     appending.  These can equivalently be given as ‘"rb"’, ‘"wb"’,
     ‘"xb"’ and ‘"ab"’ respectively.

     If `filename' is a file object (rather than an actual file name), a
     mode of ‘"w"’ does not truncate the file, and is instead equivalent
     to ‘"a"’.

     When opening a file for reading, the input file may be the
     concatenation of multiple separate compressed streams.  These are
     transparently decoded as a single logical stream.

     When opening a file for reading, the `format' and `filters'
     arguments have the same meanings as for *note LZMADecompressor:
     1caf.  In this case, the `check' and `preset' arguments should not
     be used.

     When opening a file for writing, the `format', `check', `preset'
     and `filters' arguments have the same meanings as for *note
     LZMACompressor: 1cb0.

     *note LZMAFile: 926. supports all the members specified by *note
     io.BufferedIOBase: 57d, except for ‘detach()’ and ‘truncate()’.
     Iteration and the *note with: 6dd. statement are supported.

     The following method is also provided:

      -- Method: peek (size=-1)

          Return buffered data without advancing the file position.  At
          least one byte of data will be returned, unless EOF has been
          reached.  The exact number of bytes returned is unspecified
          (the `size' argument is ignored).

               Note: While calling *note peek(): 1cb1. does not change
               the file position of the *note LZMAFile: 926, it may
               change the position of the underlying file object (e.g.
               if the *note LZMAFile: 926. was constructed by passing a
               file object for `filename').

     Changed in version 3.4: Added support for the ‘"x"’ and ‘"xb"’
     modes.

     Changed in version 3.5: The *note read(): 1c91. method now accepts
     an argument of ‘None’.

     Changed in version 3.6: Accepts a *note path-like object: 35f.


File: python.info,  Node: Compressing and decompressing data in memory,  Next: Miscellaneous<2>,  Prev: Reading and writing compressed files,  Up: lzma — Compression using the LZMA algorithm

5.13.4.2 Compressing and decompressing data in memory
.....................................................

 -- Class: lzma.LZMACompressor (format=FORMAT_XZ, check=-1, preset=None,
          filters=None)

     Create a compressor object, which can be used to compress data
     incrementally.

     For a more convenient way of compressing a single chunk of data,
     see *note compress(): 1cb3.

     The `format' argument specifies what container format should be
     used.  Possible values are:

        * 
          ‘FORMAT_XZ’: The ‘.xz’ container format.

               This is the default format.

        * 
          ‘FORMAT_ALONE’: The legacy ‘.lzma’ container format.

               This format is more limited than ‘.xz’ – it does not
               support integrity checks or multiple filters.

        * 
          ‘FORMAT_RAW’: A raw data stream, not using any container format.

               This format specifier does not support integrity checks,
               and requires that you always specify a custom filter
               chain (for both compression and decompression).
               Additionally, data compressed in this manner cannot be
               decompressed using ‘FORMAT_AUTO’ (see *note
               LZMADecompressor: 1caf.).

     The `check' argument specifies the type of integrity check to
     include in the compressed data.  This check is used when
     decompressing, to ensure that the data has not been corrupted.
     Possible values are:

        * ‘CHECK_NONE’: No integrity check.  This is the default (and
          the only acceptable value) for ‘FORMAT_ALONE’ and
          ‘FORMAT_RAW’.

        * ‘CHECK_CRC32’: 32-bit Cyclic Redundancy Check.

        * ‘CHECK_CRC64’: 64-bit Cyclic Redundancy Check.  This is the
          default for ‘FORMAT_XZ’.

        * ‘CHECK_SHA256’: 256-bit Secure Hash Algorithm.

     If the specified check is not supported, an *note LZMAError: 1cac.
     is raised.

     The compression settings can be specified either as a preset
     compression level (with the `preset' argument), or in detail as a
     custom filter chain (with the `filters' argument).

     The `preset' argument (if provided) should be an integer between
     ‘0’ and ‘9’ (inclusive), optionally OR-ed with the constant
     ‘PRESET_EXTREME’.  If neither `preset' nor `filters' are given, the
     default behavior is to use ‘PRESET_DEFAULT’ (preset level ‘6’).
     Higher presets produce smaller output, but make the compression
     process slower.

          Note: In addition to being more CPU-intensive, compression
          with higher presets also requires much more memory (and
          produces output that needs more memory to decompress).  With
          preset ‘9’ for example, the overhead for an *note
          LZMACompressor: 1cb0. object can be as high as 800 MiB. For
          this reason, it is generally best to stick with the default
          preset.

     The `filters' argument (if provided) should be a filter chain
     specifier.  See *note Specifying custom filter chains: 1cb4. for
     details.

      -- Method: compress (data)

          Compress `data' (a *note bytes: 326. object), returning a
          *note bytes: 326. object containing compressed data for at
          least part of the input.  Some of `data' may be buffered
          internally, for use in later calls to *note compress(): 1cb3.
          and *note flush(): 1cb6.  The returned data should be
          concatenated with the output of any previous calls to *note
          compress(): 1cb3.

      -- Method: flush ()

          Finish the compression process, returning a *note bytes: 326.
          object containing any data stored in the compressor’s internal
          buffers.

          The compressor cannot be used after this method has been
          called.

 -- Class: lzma.LZMADecompressor (format=FORMAT_AUTO, memlimit=None,
          filters=None)

     Create a decompressor object, which can be used to decompress data
     incrementally.

     For a more convenient way of decompressing an entire compressed
     stream at once, see *note decompress(): 1cb7.

     The `format' argument specifies the container format that should be
     used.  The default is ‘FORMAT_AUTO’, which can decompress both
     ‘.xz’ and ‘.lzma’ files.  Other possible values are ‘FORMAT_XZ’,
     ‘FORMAT_ALONE’, and ‘FORMAT_RAW’.

     The `memlimit' argument specifies a limit (in bytes) on the amount
     of memory that the decompressor can use.  When this argument is
     used, decompression will fail with an *note LZMAError: 1cac. if it
     is not possible to decompress the input within the given memory
     limit.

     The `filters' argument specifies the filter chain that was used to
     create the stream being decompressed.  This argument is required if
     `format' is ‘FORMAT_RAW’, but should not be used for other formats.
     See *note Specifying custom filter chains: 1cb4. for more
     information about filter chains.

          Note: This class does not transparently handle inputs
          containing multiple compressed streams, unlike *note
          decompress(): 1cb7. and *note LZMAFile: 926.  To decompress a
          multi-stream input with *note LZMADecompressor: 1caf, you must
          create a new decompressor for each stream.

      -- Method: decompress (data, max_length=-1)

          Decompress `data' (a *note bytes-like object: 5dd.), returning
          uncompressed data as bytes.  Some of `data' may be buffered
          internally, for use in later calls to *note decompress():
          1cb7.  The returned data should be concatenated with the
          output of any previous calls to *note decompress(): 1cb7.

          If `max_length' is nonnegative, returns at most `max_length'
          bytes of decompressed data.  If this limit is reached and
          further output can be produced, the *note needs_input: 1cb8.
          attribute will be set to ‘False’.  In this case, the next call
          to *note decompress(): 708. may provide `data' as ‘b''’ to
          obtain more of the output.

          If all of the input data was decompressed and returned (either
          because this was less than `max_length' bytes, or because
          `max_length' was negative), the *note needs_input: 1cb8.
          attribute will be set to ‘True’.

          Attempting to decompress data after the end of stream is
          reached raises an ‘EOFError’.  Any data found after the end of
          the stream is ignored and saved in the *note unused_data:
          1cb9. attribute.

          Changed in version 3.5: Added the `max_length' parameter.

      -- Attribute: check

          The ID of the integrity check used by the input stream.  This
          may be ‘CHECK_UNKNOWN’ until enough of the input has been
          decoded to determine what integrity check it uses.

      -- Attribute: eof

          ‘True’ if the end-of-stream marker has been reached.

      -- Attribute: unused_data

          Data found after the end of the compressed stream.

          Before the end of the stream is reached, this will be ‘b""’.

      -- Attribute: needs_input

          ‘False’ if the *note decompress(): 708. method can provide
          more decompressed data before requiring new uncompressed
          input.

          New in version 3.5.

 -- Function: lzma.compress (data, format=FORMAT_XZ, check=-1,
          preset=None, filters=None)

     Compress `data' (a *note bytes: 326. object), returning the
     compressed data as a *note bytes: 326. object.

     See *note LZMACompressor: 1cb0. above for a description of the
     `format', `check', `preset' and `filters' arguments.

 -- Function: lzma.decompress (data, format=FORMAT_AUTO, memlimit=None,
          filters=None)

     Decompress `data' (a *note bytes: 326. object), returning the
     uncompressed data as a *note bytes: 326. object.

     If `data' is the concatenation of multiple distinct compressed
     streams, decompress all of these streams, and return the
     concatenation of the results.

     See *note LZMADecompressor: 1caf. above for a description of the
     `format', `memlimit' and `filters' arguments.


File: python.info,  Node: Miscellaneous<2>,  Next: Specifying custom filter chains,  Prev: Compressing and decompressing data in memory,  Up: lzma — Compression using the LZMA algorithm

5.13.4.3 Miscellaneous
......................

 -- Function: lzma.is_check_supported (check)

     Return ‘True’ if the given integrity check is supported on this
     system.

     ‘CHECK_NONE’ and ‘CHECK_CRC32’ are always supported.  ‘CHECK_CRC64’
     and ‘CHECK_SHA256’ may be unavailable if you are using a version of
     ‘liblzma’ that was compiled with a limited feature set.


File: python.info,  Node: Specifying custom filter chains,  Next: Examples<5>,  Prev: Miscellaneous<2>,  Up: lzma — Compression using the LZMA algorithm

5.13.4.4 Specifying custom filter chains
........................................

A filter chain specifier is a sequence of dictionaries, where each
dictionary contains the ID and options for a single filter.  Each
dictionary must contain the key ‘"id"’, and may contain additional keys
to specify filter-dependent options.  Valid filter IDs are as follows:

   * 
     Compression filters:

             * ‘FILTER_LZMA1’ (for use with ‘FORMAT_ALONE’)

             * ‘FILTER_LZMA2’ (for use with ‘FORMAT_XZ’ and
               ‘FORMAT_RAW’)

   * 
     Delta filter:

             * ‘FILTER_DELTA’

   * 
     Branch-Call-Jump (BCJ) filters:

             * ‘FILTER_X86’

             * ‘FILTER_IA64’

             * ‘FILTER_ARM’

             * ‘FILTER_ARMTHUMB’

             * ‘FILTER_POWERPC’

             * ‘FILTER_SPARC’

A filter chain can consist of up to 4 filters, and cannot be empty.  The
last filter in the chain must be a compression filter, and any other
filters must be delta or BCJ filters.

Compression filters support the following options (specified as
additional entries in the dictionary representing the filter):

        * ‘preset’: A compression preset to use as a source of default
          values for options that are not specified explicitly.

        * ‘dict_size’: Dictionary size in bytes.  This should be between
          4 KiB and 1.5 GiB (inclusive).

        * ‘lc’: Number of literal context bits.

        * ‘lp’: Number of literal position bits.  The sum ‘lc + lp’ must
          be at most 4.

        * ‘pb’: Number of position bits; must be at most 4.

        * ‘mode’: ‘MODE_FAST’ or ‘MODE_NORMAL’.

        * ‘nice_len’: What should be considered a “nice length” for a
          match.  This should be 273 or less.

        * ‘mf’: What match finder to use – ‘MF_HC3’, ‘MF_HC4’, ‘MF_BT2’,
          ‘MF_BT3’, or ‘MF_BT4’.

        * ‘depth’: Maximum search depth used by match finder.  0
          (default) means to select automatically based on other filter
          options.

The delta filter stores the differences between bytes, producing more
repetitive input for the compressor in certain circumstances.  It
supports one option, ‘dist’.  This indicates the distance between bytes
to be subtracted.  The default is 1, i.e.  take the differences between
adjacent bytes.

The BCJ filters are intended to be applied to machine code.  They
convert relative branches, calls and jumps in the code to use absolute
addressing, with the aim of increasing the redundancy that can be
exploited by the compressor.  These filters support one option,
‘start_offset’.  This specifies the address that should be mapped to the
beginning of the input data.  The default is 0.


File: python.info,  Node: Examples<5>,  Prev: Specifying custom filter chains,  Up: lzma — Compression using the LZMA algorithm

5.13.4.5 Examples
.................

Reading in a compressed file:

     import lzma
     with lzma.open("file.xz") as f:
         file_content = f.read()

Creating a compressed file:

     import lzma
     data = b"Insert Data Here"
     with lzma.open("file.xz", "w") as f:
         f.write(data)

Compressing data in memory:

     import lzma
     data_in = b"Insert Data Here"
     data_out = lzma.compress(data_in)

Incremental compression:

     import lzma
     lzc = lzma.LZMACompressor()
     out1 = lzc.compress(b"Some data\n")
     out2 = lzc.compress(b"Another piece of data\n")
     out3 = lzc.compress(b"Even more data\n")
     out4 = lzc.flush()
     # Concatenate all the partial results:
     result = b"".join([out1, out2, out3, out4])

Writing compressed data to an already-open file:

     import lzma
     with open("file.xz", "wb") as f:
         f.write(b"This data will not be compressed\n")
         with lzma.open(f, "w") as lzf:
             lzf.write(b"This *will* be compressed\n")
         f.write(b"Not compressed\n")

Creating a compressed file using a custom filter chain:

     import lzma
     my_filters = [
         {"id": lzma.FILTER_DELTA, "dist": 5},
         {"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME},
     ]
     with lzma.open("file.xz", "w", filters=my_filters) as f:
         f.write(b"blah blah blah")


File: python.info,  Node: zipfile — Work with ZIP archives,  Next: tarfile — Read and write tar archive files,  Prev: lzma — Compression using the LZMA algorithm,  Up: Data Compression and Archiving

5.13.5 ‘zipfile’ — Work with ZIP archives
-----------------------------------------

`Source code:' Lib/zipfile.py(1)

__________________________________________________________________

The ZIP file format is a common archive and compression standard.  This
module provides tools to create, read, write, append, and list a ZIP
file.  Any advanced use of this module will require an understanding of
the format, as defined in PKZIP Application Note(2).

This module does not currently handle multi-disk ZIP files.  It can
handle ZIP files that use the ZIP64 extensions (that is ZIP files that
are more than 4 GiB in size).  It supports decryption of encrypted files
in ZIP archives, but it currently cannot create an encrypted file.
Decryption is extremely slow as it is implemented in native Python
rather than C.

The module defines the following items:

 -- Exception: zipfile.BadZipFile

     The error raised for bad ZIP files.

     New in version 3.2.

 -- Exception: zipfile.BadZipfile

     Alias of *note BadZipFile: 1cc2, for compatibility with older
     Python versions.

     Deprecated since version 3.2.

 -- Exception: zipfile.LargeZipFile

     The error raised when a ZIP file would require ZIP64 functionality
     but that has not been enabled.

 -- Class: zipfile.ZipFile

     The class for reading and writing ZIP files.  See section *note
     ZipFile Objects: 1cc5. for constructor details.

 -- Class: zipfile.Path

     A pathlib-compatible wrapper for zip files.  See section *note Path
     Objects: 1cc6. for details.

     New in version 3.8.

 -- Class: zipfile.PyZipFile

     Class for creating ZIP archives containing Python libraries.

 -- Class: zipfile.ZipInfo (filename='NoName', date_time=(1980, 1, 1, 0,
          0, 0))

     Class used to represent information about a member of an archive.
     Instances of this class are returned by the *note getinfo(): 1cc7.
     and *note infolist(): 1cc8. methods of *note ZipFile: 414. objects.
     Most users of the *note zipfile: 142. module will not need to
     create these, but only use those created by this module.
     `filename' should be the full name of the archive member, and
     `date_time' should be a tuple containing six fields which describe
     the time of the last modification to the file; the fields are
     described in section *note ZipInfo Objects: 1cc9.

 -- Function: zipfile.is_zipfile (filename)

     Returns ‘True’ if `filename' is a valid ZIP file based on its magic
     number, otherwise returns ‘False’.  `filename' may be a file or
     file-like object too.

     Changed in version 3.1: Support for file and file-like objects.

 -- Data: zipfile.ZIP_STORED

     The numeric constant for an uncompressed archive member.

 -- Data: zipfile.ZIP_DEFLATED

     The numeric constant for the usual ZIP compression method.  This
     requires the *note zlib: 144. module.

 -- Data: zipfile.ZIP_BZIP2

     The numeric constant for the BZIP2 compression method.  This
     requires the *note bz2: 14. module.

     New in version 3.3.

 -- Data: zipfile.ZIP_LZMA

     The numeric constant for the LZMA compression method.  This
     requires the *note lzma: ad. module.

     New in version 3.3.

          Note: The ZIP file format specification has included support
          for bzip2 compression since 2001, and for LZMA compression
          since 2006.  However, some tools (including older Python
          releases) do not support these compression methods, and may
          either refuse to process the ZIP file altogether, or fail to
          extract individual files.

See also
........

PKZIP Application Note(3)

     Documentation on the ZIP file format by Phil Katz, the creator of
     the format and algorithms used.

Info-ZIP Home Page(4)

     Information about the Info-ZIP project’s ZIP archive programs and
     development libraries.

* Menu:

* ZipFile Objects::
* Path Objects::
* PyZipFile Objects::
* ZipInfo Objects::
* Command-Line Interface::
* Decompression pitfalls::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/zipfile.py

   (2) https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT

   (3) https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT

   (4) http://www.info-zip.org/


File: python.info,  Node: ZipFile Objects,  Next: Path Objects,  Up: zipfile — Work with ZIP archives

5.13.5.1 ZipFile Objects
........................

 -- Class: zipfile.ZipFile (file, mode='r', compression=ZIP_STORED,
          allowZip64=True, compresslevel=None, *,
          strict_timestamps=True)

     Open a ZIP file, where `file' can be a path to a file (a string), a
     file-like object or a *note path-like object: 35f.

     The `mode' parameter should be ‘'r'’ to read an existing file,
     ‘'w'’ to truncate and write a new file, ‘'a'’ to append to an
     existing file, or ‘'x'’ to exclusively create and write a new file.
     If `mode' is ‘'x'’ and `file' refers to an existing file, a *note
     FileExistsError: 94c. will be raised.  If `mode' is ‘'a'’ and
     `file' refers to an existing ZIP file, then additional files are
     added to it.  If `file' does not refer to a ZIP file, then a new
     ZIP archive is appended to the file.  This is meant for adding a
     ZIP archive to another file (such as ‘python.exe’).  If `mode' is
     ‘'a'’ and the file does not exist at all, it is created.  If `mode'
     is ‘'r'’ or ‘'a'’, the file should be seekable.

     `compression' is the ZIP compression method to use when writing the
     archive, and should be *note ZIP_STORED: 1cca, *note ZIP_DEFLATED:
     1ccb, *note ZIP_BZIP2: 1ccc. or *note ZIP_LZMA: 1ccd.; unrecognized
     values will cause *note NotImplementedError: 603. to be raised.  If
     *note ZIP_DEFLATED: 1ccb, *note ZIP_BZIP2: 1ccc. or *note ZIP_LZMA:
     1ccd. is specified but the corresponding module (*note zlib: 144,
     *note bz2: 14. or *note lzma: ad.) is not available, *note
     RuntimeError: 2b8. is raised.  The default is *note ZIP_STORED:
     1cca.

     If `allowZip64' is ‘True’ (the default) zipfile will create ZIP
     files that use the ZIP64 extensions when the zipfile is larger than
     4 GiB. If it is ‘false’ *note zipfile: 142. will raise an exception
     when the ZIP file would require ZIP64 extensions.

     The `compresslevel' parameter controls the compression level to use
     when writing files to the archive.  When using *note ZIP_STORED:
     1cca. or *note ZIP_LZMA: 1ccd. it has no effect.  When using *note
     ZIP_DEFLATED: 1ccb. integers ‘0’ through ‘9’ are accepted (see
     *note zlib: 1c7d. for more information).  When using *note
     ZIP_BZIP2: 1ccc. integers ‘1’ through ‘9’ are accepted (see *note
     bz2: 925. for more information).

     The `strict_timestamps' argument, when set to ‘False’, allows to
     zip files older than 1980-01-01 at the cost of setting the
     timestamp to 1980-01-01.  Similar behavior occurs with files newer
     than 2107-12-31, the timestamp is also set to the limit.

     If the file is created with mode ‘'w'’, ‘'x'’ or ‘'a'’ and then
     *note closed: 1ccf. without adding any files to the archive, the
     appropriate ZIP structures for an empty archive will be written to
     the file.

     ZipFile is also a context manager and therefore supports the *note
     with: 6dd. statement.  In the example, `myzip' is closed after the
     ‘with’ statement’s suite is finished—even if an exception occurs:

          with ZipFile('spam.zip', 'w') as myzip:
              myzip.write('eggs.txt')

     New in version 3.2: Added the ability to use *note ZipFile: 414. as
     a context manager.

     Changed in version 3.3: Added support for *note bzip2: 14. and
     *note lzma: ad. compression.

     Changed in version 3.4: ZIP64 extensions are enabled by default.

     Changed in version 3.5: Added support for writing to unseekable
     streams.  Added support for the ‘'x'’ mode.

     Changed in version 3.6: Previously, a plain *note RuntimeError:
     2b8. was raised for unrecognized compression values.

     Changed in version 3.6.2: The `file' parameter accepts a *note
     path-like object: 35f.

     Changed in version 3.7: Add the `compresslevel' parameter.

     New in version 3.8: The `strict_timestamps' keyword-only argument

 -- Method: ZipFile.close ()

     Close the archive file.  You must call *note close(): 1ccf. before
     exiting your program or essential records will not be written.

 -- Method: ZipFile.getinfo (name)

     Return a *note ZipInfo: 5af. object with information about the
     archive member `name'.  Calling *note getinfo(): 1cc7. for a name
     not currently contained in the archive will raise a *note KeyError:
     2c5.

 -- Method: ZipFile.infolist ()

     Return a list containing a *note ZipInfo: 5af. object for each
     member of the archive.  The objects are in the same order as their
     entries in the actual ZIP file on disk if an existing archive was
     opened.

 -- Method: ZipFile.namelist ()

     Return a list of archive members by name.

 -- Method: ZipFile.open (name, mode='r', pwd=None, *,
          force_zip64=False)

     Access a member of the archive as a binary file-like object.
     `name' can be either the name of a file within the archive or a
     *note ZipInfo: 5af. object.  The `mode' parameter, if included,
     must be ‘'r'’ (the default) or ‘'w'’.  `pwd' is the password used
     to decrypt encrypted ZIP files.

     *note open(): 5b1. is also a context manager and therefore supports
     the *note with: 6dd. statement:

          with ZipFile('spam.zip') as myzip:
              with myzip.open('eggs.txt') as myfile:
                  print(myfile.read())

     With `mode' ‘'r'’ the file-like object (‘ZipExtFile’) is read-only
     and provides the following methods: *note read(): 1c91, *note
     readline(): 163f, *note readlines(): 16c8, *note seek(): 1cd1,
     *note tell(): 1cd2, *note __iter__(): 504, *note __next__(): c57.
     These objects can operate independently of the ZipFile.

     With ‘mode='w'’, a writable file handle is returned, which supports
     the *note write(): 57e. method.  While a writable file handle is
     open, attempting to read or write other files in the ZIP file will
     raise a *note ValueError: 1f9.

     When writing a file, if the file size is not known in advance but
     may exceed 2 GiB, pass ‘force_zip64=True’ to ensure that the header
     format is capable of supporting large files.  If the file size is
     known in advance, construct a *note ZipInfo: 5af. object with *note
     file_size: 1cd3. set, and use that as the `name' parameter.

          Note: The *note open(): 5b1, *note read(): cac. and *note
          extract(): 1cd4. methods can take a filename or a *note
          ZipInfo: 5af. object.  You will appreciate this when trying to
          read a ZIP file that contains members with duplicate names.

     Changed in version 3.6: Removed support of ‘mode='U'’.  Use *note
     io.TextIOWrapper: 5e8. for reading compressed text files in *note
     universal newlines: 5e9. mode.

     Changed in version 3.6: *note open(): 4e5. can now be used to write
     files into the archive with the ‘mode='w'’ option.

     Changed in version 3.6: Calling *note open(): 5b1. on a closed
     ZipFile will raise a *note ValueError: 1f9.  Previously, a *note
     RuntimeError: 2b8. was raised.

 -- Method: ZipFile.extract (member, path=None, pwd=None)

     Extract a member from the archive to the current working directory;
     `member' must be its full name or a *note ZipInfo: 5af. object.
     Its file information is extracted as accurately as possible.
     `path' specifies a different directory to extract to.  `member' can
     be a filename or a *note ZipInfo: 5af. object.  `pwd' is the
     password used for encrypted files.

     Returns the normalized path created (a directory or new file).

          Note: If a member filename is an absolute path, a drive/UNC
          sharepoint and leading (back)slashes will be stripped, e.g.:
          ‘///foo/bar’ becomes ‘foo/bar’ on Unix, and ‘C:\foo\bar’
          becomes ‘foo\bar’ on Windows.  And all ‘".."’ components in a
          member filename will be removed, e.g.: ‘../../foo../../ba..r’
          becomes ‘foo../ba..r’.  On Windows illegal characters (‘:’,
          ‘<’, ‘>’, ‘|’, ‘"’, ‘?’, and ‘*’) replaced by underscore
          (‘_’).

     Changed in version 3.6: Calling *note extract(): 1cd4. on a closed
     ZipFile will raise a *note ValueError: 1f9.  Previously, a *note
     RuntimeError: 2b8. was raised.

     Changed in version 3.6.2: The `path' parameter accepts a *note
     path-like object: 35f.

 -- Method: ZipFile.extractall (path=None, members=None, pwd=None)

     Extract all members from the archive to the current working
     directory.  `path' specifies a different directory to extract to.
     `members' is optional and must be a subset of the list returned by
     *note namelist(): 1cd0.  `pwd' is the password used for encrypted
     files.

          Warning: Never extract archives from untrusted sources without
          prior inspection.  It is possible that files are created
          outside of `path', e.g.  members that have absolute filenames
          starting with ‘"/"’ or filenames with two dots ‘".."’.  This
          module attempts to prevent that.  See *note extract(): 1cd4.
          note.

     Changed in version 3.6: Calling *note extractall(): 1cd5. on a
     closed ZipFile will raise a *note ValueError: 1f9.  Previously, a
     *note RuntimeError: 2b8. was raised.

     Changed in version 3.6.2: The `path' parameter accepts a *note
     path-like object: 35f.

 -- Method: ZipFile.printdir ()

     Print a table of contents for the archive to ‘sys.stdout’.

 -- Method: ZipFile.setpassword (pwd)

     Set `pwd' as default password to extract encrypted files.

 -- Method: ZipFile.read (name, pwd=None)

     Return the bytes of the file `name' in the archive.  `name' is the
     name of the file in the archive, or a *note ZipInfo: 5af. object.
     The archive must be open for read or append.  `pwd' is the password
     used for encrypted files and, if specified, it will override the
     default password set with *note setpassword(): 1cd7.  Calling *note
     read(): cac. on a ZipFile that uses a compression method other than
     *note ZIP_STORED: 1cca, *note ZIP_DEFLATED: 1ccb, *note ZIP_BZIP2:
     1ccc. or *note ZIP_LZMA: 1ccd. will raise a *note
     NotImplementedError: 603.  An error will also be raised if the
     corresponding compression module is not available.

     Changed in version 3.6: Calling *note read(): cac. on a closed
     ZipFile will raise a *note ValueError: 1f9.  Previously, a *note
     RuntimeError: 2b8. was raised.

 -- Method: ZipFile.testzip ()

     Read all the files in the archive and check their CRC’s and file
     headers.  Return the name of the first bad file, or else return
     ‘None’.

     Changed in version 3.6: Calling *note testzip(): 1cd8. on a closed
     ZipFile will raise a *note ValueError: 1f9.  Previously, a *note
     RuntimeError: 2b8. was raised.

 -- Method: ZipFile.write (filename, arcname=None, compress_type=None,
          compresslevel=None)

     Write the file named `filename' to the archive, giving it the
     archive name `arcname' (by default, this will be the same as
     `filename', but without a drive letter and with leading path
     separators removed).  If given, `compress_type' overrides the value
     given for the `compression' parameter to the constructor for the
     new entry.  Similarly, `compresslevel' will override the
     constructor if given.  The archive must be open with mode ‘'w'’,
     ‘'x'’ or ‘'a'’.

          Note: Archive names should be relative to the archive root,
          that is, they should not start with a path separator.

          Note: If ‘arcname’ (or ‘filename’, if ‘arcname’ is not given)
          contains a null byte, the name of the file in the archive will
          be truncated at the null byte.

     Changed in version 3.6: Calling *note write(): 604. on a ZipFile
     created with mode ‘'r'’ or a closed ZipFile will raise a *note
     ValueError: 1f9.  Previously, a *note RuntimeError: 2b8. was
     raised.

 -- Method: ZipFile.writestr (zinfo_or_arcname, data,
          compress_type=None, compresslevel=None)

     Write a file into the archive.  The contents is `data', which may
     be either a *note str: 325. or a *note bytes: 326. instance; if it
     is a *note str: 325, it is encoded as UTF-8 first.
     `zinfo_or_arcname' is either the file name it will be given in the
     archive, or a *note ZipInfo: 5af. instance.  If it’s an instance,
     at least the filename, date, and time must be given.  If it’s a
     name, the date and time is set to the current date and time.  The
     archive must be opened with mode ‘'w'’, ‘'x'’ or ‘'a'’.

     If given, `compress_type' overrides the value given for the
     `compression' parameter to the constructor for the new entry, or in
     the `zinfo_or_arcname' (if that is a *note ZipInfo: 5af. instance).
     Similarly, `compresslevel' will override the constructor if given.

          Note: When passing a *note ZipInfo: 5af. instance as the
          `zinfo_or_arcname' parameter, the compression method used will
          be that specified in the `compress_type' member of the given
          *note ZipInfo: 5af. instance.  By default, the *note ZipInfo:
          5af. constructor sets this member to *note ZIP_STORED: 1cca.

     Changed in version 3.2: The `compress_type' argument.

     Changed in version 3.6: Calling *note writestr(): cae. on a ZipFile
     created with mode ‘'r'’ or a closed ZipFile will raise a *note
     ValueError: 1f9.  Previously, a *note RuntimeError: 2b8. was
     raised.

The following data attributes are also available:

 -- Attribute: ZipFile.filename

     Name of the ZIP file.

 -- Attribute: ZipFile.debug

     The level of debug output to use.  This may be set from ‘0’ (the
     default, no output) to ‘3’ (the most output).  Debugging
     information is written to ‘sys.stdout’.

 -- Attribute: ZipFile.comment

     The comment associated with the ZIP file as a *note bytes: 326.
     object.  If assigning a comment to a *note ZipFile: 414. instance
     created with mode ‘'w'’, ‘'x'’ or ‘'a'’, it should be no longer
     than 65535 bytes.  Comments longer than this will be truncated.


File: python.info,  Node: Path Objects,  Next: PyZipFile Objects,  Prev: ZipFile Objects,  Up: zipfile — Work with ZIP archives

5.13.5.2 Path Objects
.....................

 -- Class: zipfile.Path (root, at='')

     Construct a Path object from a ‘root’ zipfile (which may be a *note
     ZipFile: 414. instance or ‘file’ suitable for passing to the *note
     ZipFile: 414. constructor).

     ‘at’ specifies the location of this Path within the zipfile, e.g.
     ‘dir/file.txt’, ‘dir/’, or ‘’.  Defaults to the empty string,
     indicating the root.

Path objects expose the following features of *note pathlib.Path: 1ff.
objects:

Path objects are traversable using the ‘/’ operator.

 -- Attribute: Path.name

     The final path component.

 -- Method: Path.open (*, **)

     Invoke *note ZipFile.open(): 5b1. on the current path.  Accepts the
     same arguments as *note ZipFile.open(): 5b1.

 -- Method: Path.iterdir ()

     Enumerate the children of the current directory.

 -- Method: Path.is_dir ()

     Return ‘True’ if the current context references a directory.

 -- Method: Path.is_file ()

     Return ‘True’ if the current context references a file.

 -- Method: Path.exists ()

     Return ‘True’ if the current context references a file or directory
     in the zip file.

 -- Method: Path.read_text (*, **)

     Read the current file as unicode text.  Positional and keyword
     arguments are passed through to *note io.TextIOWrapper: 5e8.
     (except ‘buffer’, which is implied by the context).

 -- Method: Path.read_bytes ()

     Read the current file as bytes.


File: python.info,  Node: PyZipFile Objects,  Next: ZipInfo Objects,  Prev: Path Objects,  Up: zipfile — Work with ZIP archives

5.13.5.3 PyZipFile Objects
..........................

The *note PyZipFile: 90f. constructor takes the same parameters as the
*note ZipFile: 414. constructor, and one additional parameter,
`optimize'.

 -- Class: zipfile.PyZipFile (file, mode='r', compression=ZIP_STORED,
          allowZip64=True, optimize=-1)

     New in version 3.2: The `optimize' parameter.

     Changed in version 3.4: ZIP64 extensions are enabled by default.

     Instances have one method in addition to those of *note ZipFile:
     414. objects:

      -- Method: writepy (pathname, basename='', filterfunc=None)

          Search for files ‘*.py’ and add the corresponding file to the
          archive.

          If the `optimize' parameter to *note PyZipFile: 90f. was not
          given or ‘-1’, the corresponding file is a ‘*.pyc’ file,
          compiling if necessary.

          If the `optimize' parameter to *note PyZipFile: 90f. was ‘0’,
          ‘1’ or ‘2’, only files with that optimization level (see *note
          compile(): 1b2.) are added to the archive, compiling if
          necessary.

          If `pathname' is a file, the filename must end with ‘.py’, and
          just the (corresponding ‘*.pyc’) file is added at the top
          level (no path information).  If `pathname' is a file that
          does not end with ‘.py’, a *note RuntimeError: 2b8. will be
          raised.  If it is a directory, and the directory is not a
          package directory, then all the files ‘*.pyc’ are added at the
          top level.  If the directory is a package directory, then all
          ‘*.pyc’ are added under the package name as a file path, and
          if any subdirectories are package directories, all of these
          are added recursively in sorted order.

          `basename' is intended for internal use only.

          `filterfunc', if given, must be a function taking a single
          string argument.  It will be passed each path (including each
          individual full file path) before it is added to the archive.
          If `filterfunc' returns a false value, the path will not be
          added, and if it is a directory its contents will be ignored.
          For example, if our test files are all either in ‘test’
          directories or start with the string ‘test_’, we can use a
          `filterfunc' to exclude them:

               >>> zf = PyZipFile('myprog.zip')
               >>> def notests(s):
               ...     fn = os.path.basename(s)
               ...     return (not (fn == 'test' or fn.startswith('test_')))
               >>> zf.writepy('myprog', filterfunc=notests)

          The *note writepy(): 90e. method makes archives with file
          names like this:

               string.pyc                   # Top level name
               test/__init__.pyc            # Package directory
               test/testall.pyc             # Module test.testall
               test/bogus/__init__.pyc      # Subpackage directory
               test/bogus/myfile.pyc        # Submodule test.bogus.myfile

          New in version 3.4: The `filterfunc' parameter.

          Changed in version 3.6.2: The `pathname' parameter accepts a
          *note path-like object: 35f.

          Changed in version 3.7: Recursion sorts directory entries.


File: python.info,  Node: ZipInfo Objects,  Next: Command-Line Interface,  Prev: PyZipFile Objects,  Up: zipfile — Work with ZIP archives

5.13.5.4 ZipInfo Objects
........................

Instances of the *note ZipInfo: 5af. class are returned by the *note
getinfo(): 1cc7. and *note infolist(): 1cc8. methods of *note ZipFile:
414. objects.  Each object stores information about a single member of
the ZIP archive.

There is one classmethod to make a *note ZipInfo: 5af. instance for a
filesystem file:

 -- Class Method: ZipInfo.from_file (filename, arcname=None, *,
          strict_timestamps=True)

     Construct a *note ZipInfo: 5af. instance for a file on the
     filesystem, in preparation for adding it to a zip file.

     `filename' should be the path to a file or directory on the
     filesystem.

     If `arcname' is specified, it is used as the name within the
     archive.  If `arcname' is not specified, the name will be the same
     as `filename', but with any drive letter and leading path
     separators removed.

     The `strict_timestamps' argument, when set to ‘False’, allows to
     zip files older than 1980-01-01 at the cost of setting the
     timestamp to 1980-01-01.  Similar behavior occurs with files newer
     than 2107-12-31, the timestamp is also set to the limit.

     New in version 3.6.

     Changed in version 3.6.2: The `filename' parameter accepts a *note
     path-like object: 35f.

     New in version 3.8: The `strict_timestamps' keyword-only argument

Instances have the following methods and attributes:

 -- Method: ZipInfo.is_dir ()

     Return ‘True’ if this archive member is a directory.

     This uses the entry’s name: directories should always end with ‘/’.

     New in version 3.6.

 -- Attribute: ZipInfo.filename

     Name of the file in the archive.

 -- Attribute: ZipInfo.date_time

     The time and date of the last modification to the archive member.
     This is a tuple of six values:

     Index       Value
                 
     -------------------------------------------
                 
     ‘0’         Year (>= 1980)
                 
                 
     ‘1’         Month (one-based)
                 
                 
     ‘2’         Day of month (one-based)
                 
                 
     ‘3’         Hours (zero-based)
                 
                 
     ‘4’         Minutes (zero-based)
                 
                 
     ‘5’         Seconds (zero-based)
                 

          Note: The ZIP file format does not support timestamps before
          1980.

 -- Attribute: ZipInfo.compress_type

     Type of compression for the archive member.

 -- Attribute: ZipInfo.comment

     Comment for the individual archive member as a *note bytes: 326.
     object.

 -- Attribute: ZipInfo.extra

     Expansion field data.  The PKZIP Application Note(1) contains some
     comments on the internal structure of the data contained in this
     *note bytes: 326. object.

 -- Attribute: ZipInfo.create_system

     System which created ZIP archive.

 -- Attribute: ZipInfo.create_version

     PKZIP version which created ZIP archive.

 -- Attribute: ZipInfo.extract_version

     PKZIP version needed to extract archive.

 -- Attribute: ZipInfo.reserved

     Must be zero.

 -- Attribute: ZipInfo.flag_bits

     ZIP flag bits.

 -- Attribute: ZipInfo.volume

     Volume number of file header.

 -- Attribute: ZipInfo.internal_attr

     Internal attributes.

 -- Attribute: ZipInfo.external_attr

     External file attributes.

 -- Attribute: ZipInfo.header_offset

     Byte offset to the file header.

 -- Attribute: ZipInfo.CRC

     CRC-32 of the uncompressed file.

 -- Attribute: ZipInfo.compress_size

     Size of the compressed data.

 -- Attribute: ZipInfo.file_size

     Size of the uncompressed file.

   ---------- Footnotes ----------

   (1) https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT


File: python.info,  Node: Command-Line Interface,  Next: Decompression pitfalls,  Prev: ZipInfo Objects,  Up: zipfile — Work with ZIP archives

5.13.5.5 Command-Line Interface
...............................

The *note zipfile: 142. module provides a simple command-line interface
to interact with ZIP archives.

If you want to create a new ZIP archive, specify its name after the
*note -c: 1cfb. option and then list the filename(s) that should be
included:

     $ python -m zipfile -c monty.zip spam.txt eggs.txt

Passing a directory is also acceptable:

     $ python -m zipfile -c monty.zip life-of-brian_1979/

If you want to extract a ZIP archive into the specified directory, use
the *note -e: 1cfc. option:

     $ python -m zipfile -e monty.zip target-dir/

For a list of the files in a ZIP archive, use the *note -l: 1cfd.
option:

     $ python -m zipfile -l monty.zip

* Menu:

* Command-line options::


File: python.info,  Node: Command-line options,  Up: Command-Line Interface

5.13.5.6 Command-line options
.............................

 -- Program Option: -l <zipfile>
 -- Program Option: --list <zipfile>

     List files in a zipfile.

 -- Program Option: -c <zipfile> <source1> ... <sourceN>
 -- Program Option: --create <zipfile> <source1> ... <sourceN>

     Create zipfile from source files.

 -- Program Option: -e <zipfile> <output_dir>
 -- Program Option: --extract <zipfile> <output_dir>

     Extract zipfile into target directory.

 -- Program Option: -t <zipfile>
 -- Program Option: --test <zipfile>

     Test whether the zipfile is valid or not.


File: python.info,  Node: Decompression pitfalls,  Prev: Command-Line Interface,  Up: zipfile — Work with ZIP archives

5.13.5.7 Decompression pitfalls
...............................

The extraction in zipfile module might fail due to some pitfalls listed
below.

* Menu:

* From file itself::
* File System limitations::
* Resources limitations::
* Interruption::
* Default behaviors of extraction::


File: python.info,  Node: From file itself,  Next: File System limitations,  Up: Decompression pitfalls

5.13.5.8 From file itself
.........................

Decompression may fail due to incorrect password / CRC checksum / ZIP
format or unsupported compression method / decryption.


File: python.info,  Node: File System limitations,  Next: Resources limitations,  Prev: From file itself,  Up: Decompression pitfalls

5.13.5.9 File System limitations
................................

Exceeding limitations on different file systems can cause decompression
failed.  Such as allowable characters in the directory entries, length
of the file name, length of the pathname, size of a single file, and
number of files, etc.


File: python.info,  Node: Resources limitations,  Next: Interruption,  Prev: File System limitations,  Up: Decompression pitfalls

5.13.5.10 Resources limitations
...............................

The lack of memory or disk volume would lead to decompression failed.
For example, decompression bombs (aka ZIP bomb(1)) apply to zipfile
library that can cause disk volume exhaustion.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Zip_bomb


File: python.info,  Node: Interruption,  Next: Default behaviors of extraction,  Prev: Resources limitations,  Up: Decompression pitfalls

5.13.5.11 Interruption
......................

Interruption during the decompression, such as pressing control-C or
killing the decompression process may result in incomplete decompression
of the archive.


File: python.info,  Node: Default behaviors of extraction,  Prev: Interruption,  Up: Decompression pitfalls

5.13.5.12 Default behaviors of extraction
.........................................

Not knowing the default extraction behaviors can cause unexpected
decompression results.  For example, when extracting the same archive
twice, it overwrites files without asking.


File: python.info,  Node: tarfile — Read and write tar archive files,  Prev: zipfile — Work with ZIP archives,  Up: Data Compression and Archiving

5.13.6 ‘tarfile’ — Read and write tar archive files
---------------------------------------------------

`Source code:' Lib/tarfile.py(1)

__________________________________________________________________

The *note tarfile: 101. module makes it possible to read and write tar
archives, including those using gzip, bz2 and lzma compression.  Use the
*note zipfile: 142. module to read or write ‘.zip’ files, or the
higher-level functions in *note shutil: b89.

Some facts and figures:

   * reads and writes *note gzip: 8c, *note bz2: 14. and *note lzma: ad.
     compressed archives if the respective modules are available.

   * read/write support for the POSIX.1-1988 (ustar) format.

   * read/write support for the GNU tar format including `longname' and
     `longlink' extensions, read-only support for all variants of the
     `sparse' extension including restoration of sparse files.

   * read/write support for the POSIX.1-2001 (pax) format.

   * handles directories, regular files, hardlinks, symbolic links,
     fifos, character devices and block devices and is able to acquire
     and restore file information like timestamp, access permissions and
     owner.

Changed in version 3.3: Added support for *note lzma: ad. compression.

 -- Function: tarfile.open (name=None, mode='r', fileobj=None,
          bufsize=10240, **kwargs)

     Return a *note TarFile: b7f. object for the pathname `name'.  For
     detailed information on *note TarFile: b7f. objects and the keyword
     arguments that are allowed, see *note TarFile Objects: 1d0d.

     `mode' has to be a string of the form ‘'filemode[:compression]'’,
     it defaults to ‘'r'’.  Here is a full list of mode combinations:

     mode                   action
                            
     -------------------------------------------------------------------------
                            
     ‘'r' or 'r:*'’         Open for reading with transparent compression
                            (recommended).
                            
                            
     ‘'r:'’                 Open for reading exclusively without
                            compression.
                            
                            
     ‘'r:gz'’               Open for reading with gzip compression.
                            
                            
     ‘'r:bz2'’              Open for reading with bzip2 compression.
                            
                            
     ‘'r:xz'’               Open for reading with lzma compression.
                            
                            
     ‘'x'’ or ‘'x:'’        Create a tarfile exclusively without
                            compression.  Raise an
                            *note FileExistsError: 94c. exception if it
                            already exists.
                            
                            
     ‘'x:gz'’               Create a tarfile with gzip compression.  Raise
                            an *note FileExistsError: 94c. exception if it
                            already exists.
                            
                            
     ‘'x:bz2'’              Create a tarfile with bzip2 compression.  Raise
                            an *note FileExistsError: 94c. exception if it
                            already exists.
                            
                            
     ‘'x:xz'’               Create a tarfile with lzma compression.  Raise
                            an *note FileExistsError: 94c. exception if it
                            already exists.
                            
                            
     ‘'a' or 'a:'’          Open for appending with no compression.  The
                            file is created if it does not exist.
                            
                            
     ‘'w' or 'w:'’          Open for uncompressed writing.
                            
                            
     ‘'w:gz'’               Open for gzip compressed writing.
                            
                            
     ‘'w:bz2'’              Open for bzip2 compressed writing.
                            
                            
     ‘'w:xz'’               Open for lzma compressed writing.
                            

     Note that ‘'a:gz'’, ‘'a:bz2'’ or ‘'a:xz'’ is not possible.  If
     `mode' is not suitable to open a certain (compressed) file for
     reading, *note ReadError: 1d0e. is raised.  Use `mode' ‘'r'’ to
     avoid this.  If a compression method is not supported, *note
     CompressionError: 1d0f. is raised.

     If `fileobj' is specified, it is used as an alternative to a *note
     file object: b35. opened in binary mode for `name'.  It is supposed
     to be at position 0.

     For modes ‘'w:gz'’, ‘'r:gz'’, ‘'w:bz2'’, ‘'r:bz2'’, ‘'x:gz'’,
     ‘'x:bz2'’, *note tarfile.open(): 75a. accepts the keyword argument
     `compresslevel' (default ‘9’) to specify the compression level of
     the file.

     For special purposes, there is a second format for `mode':
     ‘'filemode|[compression]'’.  *note tarfile.open(): 75a. will return
     a *note TarFile: b7f. object that processes its data as a stream of
     blocks.  No random seeking will be done on the file.  If given,
     `fileobj' may be any object that has a ‘read()’ or ‘write()’ method
     (depending on the `mode').  `bufsize' specifies the blocksize and
     defaults to ‘20 * 512’ bytes.  Use this variant in combination with
     e.g.  ‘sys.stdin’, a socket *note file object: b35. or a tape
     device.  However, such a *note TarFile: b7f. object is limited in
     that it does not allow random access, see *note Examples: 1d10.
     The currently possible modes:

     Mode              Action
                       
     -------------------------------------------------------------------
                       
     ‘'r|*'’           Open a `stream' of tar blocks for reading with
                       transparent compression.
                       
                       
     ‘'r|'’            Open a `stream' of uncompressed tar blocks for
                       reading.
                       
                       
     ‘'r|gz'’          Open a gzip compressed `stream' for reading.
                       
                       
     ‘'r|bz2'’         Open a bzip2 compressed `stream' for reading.
                       
                       
     ‘'r|xz'’          Open an lzma compressed `stream' for reading.
                       
                       
     ‘'w|'’            Open an uncompressed `stream' for writing.
                       
                       
     ‘'w|gz'’          Open a gzip compressed `stream' for writing.
                       
                       
     ‘'w|bz2'’         Open a bzip2 compressed `stream' for writing.
                       
                       
     ‘'w|xz'’          Open an lzma compressed `stream' for writing.
                       

     Changed in version 3.5: The ‘'x'’ (exclusive creation) mode was
     added.

     Changed in version 3.6: The `name' parameter accepts a *note
     path-like object: 35f.

 -- Class: tarfile.TarFile

     Class for reading and writing tar archives.  Do not use this class
     directly: use *note tarfile.open(): 75a. instead.  See *note
     TarFile Objects: 1d0d.

 -- Function: tarfile.is_tarfile (name)

     Return *note True: 48f. if `name' is a tar archive file, that the
     *note tarfile: 101. module can read.

The *note tarfile: 101. module defines the following exceptions:

 -- Exception: tarfile.TarError

     Base class for all *note tarfile: 101. exceptions.

 -- Exception: tarfile.ReadError

     Is raised when a tar archive is opened, that either cannot be
     handled by the *note tarfile: 101. module or is somehow invalid.

 -- Exception: tarfile.CompressionError

     Is raised when a compression method is not supported or when the
     data cannot be decoded properly.

 -- Exception: tarfile.StreamError

     Is raised for the limitations that are typical for stream-like
     *note TarFile: b7f. objects.

 -- Exception: tarfile.ExtractError

     Is raised for `non-fatal' errors when using *note
     TarFile.extract(): 75c, but only if ‘TarFile.errorlevel’‘== 2’.

 -- Exception: tarfile.HeaderError

     Is raised by *note TarInfo.frombuf(): 1d16. if the buffer it gets
     is invalid.

The following constants are available at the module level:

 -- Data: tarfile.ENCODING

     The default character encoding: ‘'utf-8'’ on Windows, the value
     returned by *note sys.getfilesystemencoding(): 4eb. otherwise.

Each of the following constants defines a tar archive format that the
*note tarfile: 101. module is able to create.  See section *note
Supported tar formats: 1d18. for details.

 -- Data: tarfile.USTAR_FORMAT

     POSIX.1-1988 (ustar) format.

 -- Data: tarfile.GNU_FORMAT

     GNU tar format.

 -- Data: tarfile.PAX_FORMAT

     POSIX.1-2001 (pax) format.

 -- Data: tarfile.DEFAULT_FORMAT

     The default format for creating archives.  This is currently *note
     PAX_FORMAT: 1d1b.

     Changed in version 3.8: The default format for new archives was
     changed to *note PAX_FORMAT: 1d1b. from *note GNU_FORMAT: 1d1a.

See also
........

Module *note zipfile: 142.

     Documentation of the *note zipfile: 142. standard module.

*note Archiving operations: b89.

     Documentation of the higher-level archiving facilities provided by
     the standard *note shutil: e9. module.

GNU tar manual, Basic Tar Format(2)

     Documentation for tar archive files, including GNU tar extensions.

* Menu:

* TarFile Objects::
* TarInfo Objects::
* Command-Line Interface: Command-Line Interface<2>.
* Examples: Examples<6>.
* Supported tar formats::
* Unicode issues::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tarfile.py

   (2) https://www.gnu.org/software/tar/manual/html_node/Standard.html


File: python.info,  Node: TarFile Objects,  Next: TarInfo Objects,  Up: tarfile — Read and write tar archive files

5.13.6.1 TarFile Objects
........................

The *note TarFile: b7f. object provides an interface to a tar archive.
A tar archive is a sequence of blocks.  An archive member (a stored
file) is made up of a header block followed by data blocks.  It is
possible to store a file in a tar archive several times.  Each archive
member is represented by a *note TarInfo: b80. object, see *note TarInfo
Objects: 1d1e. for details.

A *note TarFile: b7f. object can be used as a context manager in a *note
with: 6dd. statement.  It will automatically be closed when the block is
completed.  Please note that in the event of an exception an archive
opened for writing will not be finalized; only the internally used file
object will be closed.  See the *note Examples: 1d10. section for a use
case.

New in version 3.2: Added support for the context management protocol.

 -- Class: tarfile.TarFile (name=None, mode='r', fileobj=None,
          format=DEFAULT_FORMAT, tarinfo=TarInfo, dereference=False,
          ignore_zeros=False, encoding=ENCODING,
          errors='surrogateescape', pax_headers=None, debug=0,
          errorlevel=0)

     All following arguments are optional and can be accessed as
     instance attributes as well.

     `name' is the pathname of the archive.  `name' may be a *note
     path-like object: 35f.  It can be omitted if `fileobj' is given.
     In this case, the file object’s ‘name’ attribute is used if it
     exists.

     `mode' is either ‘'r'’ to read from an existing archive, ‘'a'’ to
     append data to an existing file, ‘'w'’ to create a new file
     overwriting an existing one, or ‘'x'’ to create a new file only if
     it does not already exist.

     If `fileobj' is given, it is used for reading or writing data.  If
     it can be determined, `mode' is overridden by `fileobj'’s mode.
     `fileobj' will be used from position 0.

          Note: `fileobj' is not closed, when *note TarFile: b7f. is
          closed.

     `format' controls the archive format for writing.  It must be one
     of the constants *note USTAR_FORMAT: 1d19, *note GNU_FORMAT: 1d1a.
     or *note PAX_FORMAT: 1d1b. that are defined at module level.  When
     reading, format will be automatically detected, even if different
     formats are present in a single archive.

     The `tarinfo' argument can be used to replace the default *note
     TarInfo: b80. class with a different one.

     If `dereference' is *note False: 37d, add symbolic and hard links
     to the archive.  If it is *note True: 48f, add the content of the
     target files to the archive.  This has no effect on systems that do
     not support symbolic links.

     If `ignore_zeros' is *note False: 37d, treat an empty block as the
     end of the archive.  If it is *note True: 48f, skip empty (and
     invalid) blocks and try to get as many members as possible.  This
     is only useful for reading concatenated or damaged archives.

     `debug' can be set from ‘0’ (no debug messages) up to ‘3’ (all
     debug messages).  The messages are written to ‘sys.stderr’.

     If `errorlevel' is ‘0’, all errors are ignored when using *note
     TarFile.extract(): 75c.  Nevertheless, they appear as error
     messages in the debug output, when debugging is enabled.  If ‘1’,
     all `fatal' errors are raised as *note OSError: 1d1. exceptions.
     If ‘2’, all `non-fatal' errors are raised as *note TarError: 1d12.
     exceptions as well.

     The `encoding' and `errors' arguments define the character encoding
     to be used for reading or writing the archive and how conversion
     errors are going to be handled.  The default settings will work for
     most users.  See section *note Unicode issues: 1d1f. for in-depth
     information.

     The `pax_headers' argument is an optional dictionary of strings
     which will be added as a pax global header if `format' is *note
     PAX_FORMAT: 1d1b.

     Changed in version 3.2: Use ‘'surrogateescape'’ as the default for
     the `errors' argument.

     Changed in version 3.5: The ‘'x'’ (exclusive creation) mode was
     added.

     Changed in version 3.6: The `name' parameter accepts a *note
     path-like object: 35f.

 -- Class Method: TarFile.open (...)

     Alternative constructor.  The *note tarfile.open(): 75a. function
     is actually a shortcut to this classmethod.

 -- Method: TarFile.getmember (name)

     Return a *note TarInfo: b80. object for member `name'.  If `name'
     can not be found in the archive, *note KeyError: 2c5. is raised.

          Note: If a member occurs more than once in the archive, its
          last occurrence is assumed to be the most up-to-date version.

 -- Method: TarFile.getmembers ()

     Return the members of the archive as a list of *note TarInfo: b80.
     objects.  The list has the same order as the members in the
     archive.

 -- Method: TarFile.getnames ()

     Return the members as a list of their names.  It has the same order
     as the list returned by *note getmembers(): 75e.

 -- Method: TarFile.list (verbose=True, *, members=None)

     Print a table of contents to ‘sys.stdout’.  If `verbose' is *note
     False: 37d, only the names of the members are printed.  If it is
     *note True: 48f, output similar to that of ‘ls -l’ is produced.  If
     optional `members' is given, it must be a subset of the list
     returned by *note getmembers(): 75e.

     Changed in version 3.5: Added the `members' parameter.

 -- Method: TarFile.next ()

     Return the next member of the archive as a *note TarInfo: b80.
     object, when *note TarFile: b7f. is opened for reading.  Return
     *note None: 157. if there is no more available.

 -- Method: TarFile.extractall (path=".", members=None, *,
          numeric_owner=False)

     Extract all members from the archive to the current working
     directory or directory `path'.  If optional `members' is given, it
     must be a subset of the list returned by *note getmembers(): 75e.
     Directory information like owner, modification time and permissions
     are set after all members have been extracted.  This is done to
     work around two problems: A directory’s modification time is reset
     each time a file is created in it.  And, if a directory’s
     permissions do not allow writing, extracting files to it will fail.

     If `numeric_owner' is *note True: 48f, the uid and gid numbers from
     the tarfile are used to set the owner/group for the extracted
     files.  Otherwise, the named values from the tarfile are used.

          Warning: Never extract archives from untrusted sources without
          prior inspection.  It is possible that files are created
          outside of `path', e.g.  members that have absolute filenames
          starting with ‘"/"’ or filenames with two dots ‘".."’.

     Changed in version 3.5: Added the `numeric_owner' parameter.

     Changed in version 3.6: The `path' parameter accepts a *note
     path-like object: 35f.

 -- Method: TarFile.extract (member, path="", set_attrs=True, *,
          numeric_owner=False)

     Extract a member from the archive to the current working directory,
     using its full name.  Its file information is extracted as
     accurately as possible.  `member' may be a filename or a *note
     TarInfo: b80. object.  You can specify a different directory using
     `path'.  `path' may be a *note path-like object: 35f.  File
     attributes (owner, mtime, mode) are set unless `set_attrs' is
     false.

     If `numeric_owner' is *note True: 48f, the uid and gid numbers from
     the tarfile are used to set the owner/group for the extracted
     files.  Otherwise, the named values from the tarfile are used.

          Note: The *note extract(): 75c. method does not take care of
          several extraction issues.  In most cases you should consider
          using the *note extractall(): 75b. method.

          Warning: See the warning for *note extractall(): 75b.

     Changed in version 3.2: Added the `set_attrs' parameter.

     Changed in version 3.5: Added the `numeric_owner' parameter.

     Changed in version 3.6: The `path' parameter accepts a *note
     path-like object: 35f.

 -- Method: TarFile.extractfile (member)

     Extract a member from the archive as a file object.  `member' may
     be a filename or a *note TarInfo: b80. object.  If `member' is a
     regular file or a link, an *note io.BufferedReader: b7d. object is
     returned.  Otherwise, *note None: 157. is returned.

     Changed in version 3.3: Return an *note io.BufferedReader: b7d.
     object.

 -- Method: TarFile.add (name, arcname=None, recursive=True, *,
          filter=None)

     Add the file `name' to the archive.  `name' may be any type of file
     (directory, fifo, symbolic link, etc.).  If given, `arcname'
     specifies an alternative name for the file in the archive.
     Directories are added recursively by default.  This can be avoided
     by setting `recursive' to *note False: 37d.  Recursion adds entries
     in sorted order.  If `filter' is given, it should be a function
     that takes a *note TarInfo: b80. object argument and returns the
     changed *note TarInfo: b80. object.  If it instead returns *note
     None: 157. the *note TarInfo: b80. object will be excluded from the
     archive.  See *note Examples: 1d10. for an example.

     Changed in version 3.2: Added the `filter' parameter.

     Changed in version 3.7: Recursion adds entries in sorted order.

 -- Method: TarFile.addfile (tarinfo, fileobj=None)

     Add the *note TarInfo: b80. object `tarinfo' to the archive.  If
     `fileobj' is given, it should be a *note binary file: 1bdb, and
     ‘tarinfo.size’ bytes are read from it and added to the archive.
     You can create *note TarInfo: b80. objects directly, or by using
     *note gettarinfo(): 1d26.

 -- Method: TarFile.gettarinfo (name=None, arcname=None, fileobj=None)

     Create a *note TarInfo: b80. object from the result of *note
     os.stat(): 1ef. or equivalent on an existing file.  The file is
     either named by `name', or specified as a *note file object: b35.
     `fileobj' with a file descriptor.  `name' may be a *note path-like
     object: 35f.  If given, `arcname' specifies an alternative name for
     the file in the archive, otherwise, the name is taken from
     `fileobj'’s *note name: 1d27. attribute, or the `name' argument.
     The name should be a text string.

     You can modify some of the *note TarInfo: b80.’s attributes before
     you add it using *note addfile(): 1d25.  If the file object is not
     an ordinary file object positioned at the beginning of the file,
     attributes such as *note size: 1d28. may need modifying.  This is
     the case for objects such as *note GzipFile: 6d1.  The *note name:
     1d29. may also be modified, in which case `arcname' could be a
     dummy string.

     Changed in version 3.6: The `name' parameter accepts a *note
     path-like object: 35f.

 -- Method: TarFile.close ()

     Close the *note TarFile: b7f.  In write mode, two finishing zero
     blocks are appended to the archive.

 -- Attribute: TarFile.pax_headers

     A dictionary containing key-value pairs of pax global headers.


File: python.info,  Node: TarInfo Objects,  Next: Command-Line Interface<2>,  Prev: TarFile Objects,  Up: tarfile — Read and write tar archive files

5.13.6.2 TarInfo Objects
........................

A *note TarInfo: b80. object represents one member in a *note TarFile:
b7f.  Aside from storing all required attributes of a file (like file
type, size, time, permissions, owner etc.), it provides some useful
methods to determine its type.  It does `not' contain the file’s data
itself.

*note TarInfo: b80. objects are returned by *note TarFile: b7f.’s
methods ‘getmember()’, ‘getmembers()’ and ‘gettarinfo()’.

 -- Class: tarfile.TarInfo (name="")

     Create a *note TarInfo: b80. object.

 -- Class Method: TarInfo.frombuf (buf, encoding, errors)

     Create and return a *note TarInfo: b80. object from string buffer
     `buf'.

     Raises *note HeaderError: 1d15. if the buffer is invalid.

 -- Class Method: TarInfo.fromtarfile (tarfile)

     Read the next member from the *note TarFile: b7f. object `tarfile'
     and return it as a *note TarInfo: b80. object.

 -- Method: TarInfo.tobuf (format=DEFAULT_FORMAT, encoding=ENCODING,
          errors='surrogateescape')

     Create a string buffer from a *note TarInfo: b80. object.  For
     information on the arguments see the constructor of the *note
     TarFile: b7f. class.

     Changed in version 3.2: Use ‘'surrogateescape'’ as the default for
     the `errors' argument.

A ‘TarInfo’ object has the following public data attributes:

 -- Attribute: TarInfo.name

     Name of the archive member.

 -- Attribute: TarInfo.size

     Size in bytes.

 -- Attribute: TarInfo.mtime

     Time of last modification.

 -- Attribute: TarInfo.mode

     Permission bits.

 -- Attribute: TarInfo.type

     File type.  `type' is usually one of these constants: ‘REGTYPE’,
     ‘AREGTYPE’, ‘LNKTYPE’, ‘SYMTYPE’, ‘DIRTYPE’, ‘FIFOTYPE’,
     ‘CONTTYPE’, ‘CHRTYPE’, ‘BLKTYPE’, ‘GNUTYPE_SPARSE’.  To determine
     the type of a *note TarInfo: b80. object more conveniently, use the
     ‘is*()’ methods below.

 -- Attribute: TarInfo.linkname

     Name of the target file name, which is only present in *note
     TarInfo: b80. objects of type ‘LNKTYPE’ and ‘SYMTYPE’.

 -- Attribute: TarInfo.uid

     User ID of the user who originally stored this member.

 -- Attribute: TarInfo.gid

     Group ID of the user who originally stored this member.

 -- Attribute: TarInfo.uname

     User name.

 -- Attribute: TarInfo.gname

     Group name.

 -- Attribute: TarInfo.pax_headers

     A dictionary containing key-value pairs of an associated pax
     extended header.

A *note TarInfo: b80. object also provides some convenient query
methods:

 -- Method: TarInfo.isfile ()

     Return *note True: 48f. if the ‘Tarinfo’ object is a regular file.

 -- Method: TarInfo.isreg ()

     Same as *note isfile(): 1d38.

 -- Method: TarInfo.isdir ()

     Return *note True: 48f. if it is a directory.

 -- Method: TarInfo.issym ()

     Return *note True: 48f. if it is a symbolic link.

 -- Method: TarInfo.islnk ()

     Return *note True: 48f. if it is a hard link.

 -- Method: TarInfo.ischr ()

     Return *note True: 48f. if it is a character device.

 -- Method: TarInfo.isblk ()

     Return *note True: 48f. if it is a block device.

 -- Method: TarInfo.isfifo ()

     Return *note True: 48f. if it is a FIFO.

 -- Method: TarInfo.isdev ()

     Return *note True: 48f. if it is one of character device, block
     device or FIFO.


File: python.info,  Node: Command-Line Interface<2>,  Next: Examples<6>,  Prev: TarInfo Objects,  Up: tarfile — Read and write tar archive files

5.13.6.3 Command-Line Interface
...............................

New in version 3.4.

The *note tarfile: 101. module provides a simple command-line interface
to interact with tar archives.

If you want to create a new tar archive, specify its name after the
*note -c: 1d42. option and then list the filename(s) that should be
included:

     $ python -m tarfile -c monty.tar  spam.txt eggs.txt

Passing a directory is also acceptable:

     $ python -m tarfile -c monty.tar life-of-brian_1979/

If you want to extract a tar archive into the current directory, use the
*note -e: 1d43. option:

     $ python -m tarfile -e monty.tar

You can also extract a tar archive into a different directory by passing
the directory’s name:

     $ python -m tarfile -e monty.tar  other-dir/

For a list of the files in a tar archive, use the *note -l: 1d44.
option:

     $ python -m tarfile -l monty.tar

* Menu:

* Command-line options: Command-line options<2>.


File: python.info,  Node: Command-line options<2>,  Up: Command-Line Interface<2>

5.13.6.4 Command-line options
.............................

 -- Program Option: -l <tarfile>
 -- Program Option: --list <tarfile>

     List files in a tarfile.

 -- Program Option: -c <tarfile> <source1> ... <sourceN>
 -- Program Option: --create <tarfile> <source1> ... <sourceN>

     Create tarfile from source files.

 -- Program Option: -e <tarfile> [<output_dir>]
 -- Program Option: --extract <tarfile> [<output_dir>]

     Extract tarfile into the current directory if `output_dir' is not
     specified.

 -- Program Option: -t <tarfile>
 -- Program Option: --test <tarfile>

     Test whether the tarfile is valid or not.

 -- Program Option: -v, --verbose

     Verbose output.


File: python.info,  Node: Examples<6>,  Next: Supported tar formats,  Prev: Command-Line Interface<2>,  Up: tarfile — Read and write tar archive files

5.13.6.5 Examples
.................

How to extract an entire tar archive to the current working directory:

     import tarfile
     tar = tarfile.open("sample.tar.gz")
     tar.extractall()
     tar.close()

How to extract a subset of a tar archive with *note
TarFile.extractall(): 75b. using a generator function instead of a list:

     import os
     import tarfile

     def py_files(members):
         for tarinfo in members:
             if os.path.splitext(tarinfo.name)[1] == ".py":
                 yield tarinfo

     tar = tarfile.open("sample.tar.gz")
     tar.extractall(members=py_files(tar))
     tar.close()

How to create an uncompressed tar archive from a list of filenames:

     import tarfile
     tar = tarfile.open("sample.tar", "w")
     for name in ["foo", "bar", "quux"]:
         tar.add(name)
     tar.close()

The same example using the *note with: 6dd. statement:

     import tarfile
     with tarfile.open("sample.tar", "w") as tar:
         for name in ["foo", "bar", "quux"]:
             tar.add(name)

How to read a gzip compressed tar archive and display some member
information:

     import tarfile
     tar = tarfile.open("sample.tar.gz", "r:gz")
     for tarinfo in tar:
         print(tarinfo.name, "is", tarinfo.size, "bytes in size and is", end="")
         if tarinfo.isreg():
             print("a regular file.")
         elif tarinfo.isdir():
             print("a directory.")
         else:
             print("something else.")
     tar.close()

How to create an archive and reset the user information using the
`filter' parameter in *note TarFile.add(): 471.:

     import tarfile
     def reset(tarinfo):
         tarinfo.uid = tarinfo.gid = 0
         tarinfo.uname = tarinfo.gname = "root"
         return tarinfo
     tar = tarfile.open("sample.tar.gz", "w:gz")
     tar.add("foo", filter=reset)
     tar.close()


File: python.info,  Node: Supported tar formats,  Next: Unicode issues,  Prev: Examples<6>,  Up: tarfile — Read and write tar archive files

5.13.6.6 Supported tar formats
..............................

There are three tar formats that can be created with the *note tarfile:
101. module:

   * The POSIX.1-1988 ustar format (*note USTAR_FORMAT: 1d19.).  It
     supports filenames up to a length of at best 256 characters and
     linknames up to 100 characters.  The maximum file size is 8 GiB.
     This is an old and limited but widely supported format.

   * The GNU tar format (*note GNU_FORMAT: 1d1a.).  It supports long
     filenames and linknames, files bigger than 8 GiB and sparse files.
     It is the de facto standard on GNU/Linux systems.  *note tarfile:
     101. fully supports the GNU tar extensions for long names, sparse
     file support is read-only.

   * The POSIX.1-2001 pax format (*note PAX_FORMAT: 1d1b.).  It is the
     most flexible format with virtually no limits.  It supports long
     filenames and linknames, large files and stores pathnames in a
     portable way.  Modern tar implementations, including GNU tar,
     bsdtar/libarchive and star, fully support extended `pax' features;
     some old or unmaintained libraries may not, but should treat `pax'
     archives as if they were in the universally-supported `ustar'
     format.  It is the current default format for new archives.

     It extends the existing `ustar' format with extra headers for
     information that cannot be stored otherwise.  There are two
     flavours of pax headers: Extended headers only affect the
     subsequent file header, global headers are valid for the complete
     archive and affect all following files.  All the data in a pax
     header is encoded in `UTF-8' for portability reasons.

There are some more variants of the tar format which can be read, but
not created:

   * The ancient V7 format.  This is the first tar format from Unix
     Seventh Edition, storing only regular files and directories.  Names
     must not be longer than 100 characters, there is no user/group name
     information.  Some archives have miscalculated header checksums in
     case of fields with non-ASCII characters.

   * The SunOS tar extended format.  This format is a variant of the
     POSIX.1-2001 pax format, but is not compatible.


File: python.info,  Node: Unicode issues,  Prev: Supported tar formats,  Up: tarfile — Read and write tar archive files

5.13.6.7 Unicode issues
.......................

The tar format was originally conceived to make backups on tape drives
with the main focus on preserving file system information.  Nowadays tar
archives are commonly used for file distribution and exchanging archives
over networks.  One problem of the original format (which is the basis
of all other formats) is that there is no concept of supporting
different character encodings.  For example, an ordinary tar archive
created on a `UTF-8' system cannot be read correctly on a `Latin-1'
system if it contains non-`ASCII' characters.  Textual metadata (like
filenames, linknames, user/group names) will appear damaged.
Unfortunately, there is no way to autodetect the encoding of an archive.
The pax format was designed to solve this problem.  It stores non-ASCII
metadata using the universal character encoding `UTF-8'.

The details of character conversion in *note tarfile: 101. are
controlled by the `encoding' and `errors' keyword arguments of the *note
TarFile: b7f. class.

`encoding' defines the character encoding to use for the metadata in the
archive.  The default value is *note sys.getfilesystemencoding(): 4eb.
or ‘'ascii'’ as a fallback.  Depending on whether the archive is read or
written, the metadata must be either decoded or encoded.  If `encoding'
is not set appropriately, this conversion may fail.

The `errors' argument defines how characters are treated that cannot be
converted.  Possible values are listed in section *note Error Handlers:
129c.  The default scheme is ‘'surrogateescape'’ which Python also uses
for its file system calls, see *note File Names, Command Line Arguments,
and Environment Variables: 1d4f.

For *note PAX_FORMAT: 1d1b. archives (the default), `encoding' is
generally not needed because all the metadata is stored using `UTF-8'.
`encoding' is only used in the rare cases when binary pax headers are
decoded or when strings with surrogate characters are stored.


File: python.info,  Node: File Formats,  Next: Cryptographic Services,  Prev: Data Compression and Archiving,  Up: The Python Standard Library

5.14 File Formats
=================

The modules described in this chapter parse various miscellaneous file
formats that aren’t markup languages and are not related to e-mail.

* Menu:

* csv — CSV File Reading and Writing::
* configparser — Configuration file parser::
* netrc — netrc file processing::
* xdrlib — Encode and decode XDR data::
* plistlib — Generate and parse Mac OS X .plist files: plistlib — Generate and parse Mac OS X plist files.


File: python.info,  Node: csv — CSV File Reading and Writing,  Next: configparser — Configuration file parser,  Up: File Formats

5.14.1 ‘csv’ — CSV File Reading and Writing
-------------------------------------------

`Source code:' Lib/csv.py(1)

__________________________________________________________________

The so-called CSV (Comma Separated Values) format is the most common
import and export format for spreadsheets and databases.  CSV format was
used for many years prior to attempts to describe the format in a
standardized way in RFC 4180(2).  The lack of a well-defined standard
means that subtle differences often exist in the data produced and
consumed by different applications.  These differences can make it
annoying to process CSV files from multiple sources.  Still, while the
delimiters and quoting characters vary, the overall format is similar
enough that it is possible to write a single module which can
efficiently manipulate such data, hiding the details of reading and
writing the data from the programmer.

The *note csv: 2a. module implements classes to read and write tabular
data in CSV format.  It allows programmers to say, “write this data in
the format preferred by Excel,” or “read data from this file which was
generated by Excel,” without knowing the precise details of the CSV
format used by Excel.  Programmers can also describe the CSV formats
understood by other applications or define their own special-purpose CSV
formats.

The *note csv: 2a. module’s *note reader: 1d55. and *note writer: def.
objects read and write sequences.  Programmers can also read and write
data in dictionary form using the *note DictReader: 1bb. and *note
DictWriter: b6d. classes.

See also
........

PEP 305(3) - CSV File API

     The Python Enhancement Proposal which proposed this addition to
     Python.

* Menu:

* Module Contents: Module Contents<3>.
* Dialects and Formatting Parameters::
* Reader Objects::
* Writer Objects::
* Examples: Examples<7>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/csv.py

   (2) https://tools.ietf.org/html/rfc4180.html

   (3) https://www.python.org/dev/peps/pep-0305


File: python.info,  Node: Module Contents<3>,  Next: Dialects and Formatting Parameters,  Up: csv — CSV File Reading and Writing

5.14.1.1 Module Contents
........................

The *note csv: 2a. module defines the following functions:

 -- Function: csv.reader (csvfile, dialect='excel', **fmtparams)

     Return a reader object which will iterate over lines in the given
     `csvfile'.  `csvfile' can be any object which supports the *note
     iterator: f73. protocol and returns a string each time its
     ‘__next__()’ method is called — *note file objects: b35. and list
     objects are both suitable.  If `csvfile' is a file object, it
     should be opened with ‘newline=''’.  (1) An optional `dialect'
     parameter can be given which is used to define a set of parameters
     specific to a particular CSV dialect.  It may be an instance of a
     subclass of the *note Dialect: 1d58. class or one of the strings
     returned by the *note list_dialects(): 1d59. function.  The other
     optional `fmtparams' keyword arguments can be given to override
     individual formatting parameters in the current dialect.  For full
     details about the dialect and formatting parameters, see section
     *note Dialects and Formatting Parameters: 1d5a.

     Each row read from the csv file is returned as a list of strings.
     No automatic data type conversion is performed unless the
     ‘QUOTE_NONNUMERIC’ format option is specified (in which case
     unquoted fields are transformed into floats).

     A short usage example:

          >>> import csv
          >>> with open('eggs.csv', newline='') as csvfile:
          ...     spamreader = csv.reader(csvfile, delimiter=' ', quotechar='|')
          ...     for row in spamreader:
          ...         print(', '.join(row))
          Spam, Spam, Spam, Spam, Spam, Baked Beans
          Spam, Lovely Spam, Wonderful Spam

 -- Function: csv.writer (csvfile, dialect='excel', **fmtparams)

     Return a writer object responsible for converting the user’s data
     into delimited strings on the given file-like object.  `csvfile'
     can be any object with a ‘write()’ method.  If `csvfile' is a file
     object, it should be opened with ‘newline=''’ (2).  An optional
     `dialect' parameter can be given which is used to define a set of
     parameters specific to a particular CSV dialect.  It may be an
     instance of a subclass of the *note Dialect: 1d58. class or one of
     the strings returned by the *note list_dialects(): 1d59. function.
     The other optional `fmtparams' keyword arguments can be given to
     override individual formatting parameters in the current dialect.
     For full details about the dialect and formatting parameters, see
     section *note Dialects and Formatting Parameters: 1d5a.  To make it
     as easy as possible to interface with modules which implement the
     DB API, the value *note None: 157. is written as the empty string.
     While this isn’t a reversible transformation, it makes it easier to
     dump SQL NULL data values to CSV files without preprocessing the
     data returned from a ‘cursor.fetch*’ call.  All other non-string
     data are stringified with *note str(): 325. before being written.

     A short usage example:

          import csv
          with open('eggs.csv', 'w', newline='') as csvfile:
              spamwriter = csv.writer(csvfile, delimiter=' ',
                                      quotechar='|', quoting=csv.QUOTE_MINIMAL)
              spamwriter.writerow(['Spam'] * 5 + ['Baked Beans'])
              spamwriter.writerow(['Spam', 'Lovely Spam', 'Wonderful Spam'])

 -- Function: csv.register_dialect (name[, dialect[, **fmtparams]])

     Associate `dialect' with `name'.  `name' must be a string.  The
     dialect can be specified either by passing a sub-class of *note
     Dialect: 1d58, or by `fmtparams' keyword arguments, or both, with
     keyword arguments overriding parameters of the dialect.  For full
     details about the dialect and formatting parameters, see section
     *note Dialects and Formatting Parameters: 1d5a.

 -- Function: csv.unregister_dialect (name)

     Delete the dialect associated with `name' from the dialect
     registry.  An *note Error: 1d5d. is raised if `name' is not a
     registered dialect name.

 -- Function: csv.get_dialect (name)

     Return the dialect associated with `name'.  An *note Error: 1d5d.
     is raised if `name' is not a registered dialect name.  This
     function returns an immutable *note Dialect: 1d58.

 -- Function: csv.list_dialects ()

     Return the names of all registered dialects.

 -- Function: csv.field_size_limit ([new_limit])

     Returns the current maximum field size allowed by the parser.  If
     `new_limit' is given, this becomes the new limit.

The *note csv: 2a. module defines the following classes:

 -- Class: csv.DictReader (f, fieldnames=None, restkey=None,
          restval=None, dialect='excel', *args, **kwds)

     Create an object that operates like a regular reader but maps the
     information in each row to a *note dict: 1b6. whose keys are given
     by the optional `fieldnames' parameter.

     The `fieldnames' parameter is a *note sequence: 1162.  If
     `fieldnames' is omitted, the values in the first row of file `f'
     will be used as the fieldnames.  Regardless of how the fieldnames
     are determined, the dictionary preserves their original ordering.

     If a row has more fields than fieldnames, the remaining data is put
     in a list and stored with the fieldname specified by `restkey'
     (which defaults to ‘None’).  If a non-blank row has fewer fields
     than fieldnames, the missing values are filled-in with ‘None’.

     All other optional or keyword arguments are passed to the
     underlying *note reader: 1d55. instance.

     Changed in version 3.8: Returned rows are now of type *note dict:
     1b6.

     A short usage example:

          >>> import csv
          >>> with open('names.csv', newline='') as csvfile:
          ...     reader = csv.DictReader(csvfile)
          ...     for row in reader:
          ...         print(row['first_name'], row['last_name'])
          ...
          Eric Idle
          John Cleese

          >>> print(row)
          {'first_name': 'John', 'last_name': 'Cleese'}

 -- Class: csv.DictWriter (f, fieldnames, restval='',
          extrasaction='raise', dialect='excel', *args, **kwds)

     Create an object which operates like a regular writer but maps
     dictionaries onto output rows.  The `fieldnames' parameter is a
     *note sequence: 1f. of keys that identify the order in which values
     in the dictionary passed to the ‘writerow()’ method are written to
     file `f'.  The optional `restval' parameter specifies the value to
     be written if the dictionary is missing a key in `fieldnames'.  If
     the dictionary passed to the ‘writerow()’ method contains a key not
     found in `fieldnames', the optional `extrasaction' parameter
     indicates what action to take.  If it is set to ‘'raise'’, the
     default value, a *note ValueError: 1f9. is raised.  If it is set to
     ‘'ignore'’, extra values in the dictionary are ignored.  Any other
     optional or keyword arguments are passed to the underlying *note
     writer: def. instance.

     Note that unlike the *note DictReader: 1bb. class, the `fieldnames'
     parameter of the *note DictWriter: b6d. class is not optional.

     A short usage example:

          import csv

          with open('names.csv', 'w', newline='') as csvfile:
              fieldnames = ['first_name', 'last_name']
              writer = csv.DictWriter(csvfile, fieldnames=fieldnames)

              writer.writeheader()
              writer.writerow({'first_name': 'Baked', 'last_name': 'Beans'})
              writer.writerow({'first_name': 'Lovely', 'last_name': 'Spam'})
              writer.writerow({'first_name': 'Wonderful', 'last_name': 'Spam'})

 -- Class: csv.Dialect

     The *note Dialect: 1d58. class is a container class relied on
     primarily for its attributes, which are used to define the
     parameters for a specific *note reader: 1d55. or *note writer: def.
     instance.

 -- Class: csv.excel

     The *note excel: 1d60. class defines the usual properties of an
     Excel-generated CSV file.  It is registered with the dialect name
     ‘'excel'’.

 -- Class: csv.excel_tab

     The *note excel_tab: 1d61. class defines the usual properties of an
     Excel-generated TAB-delimited file.  It is registered with the
     dialect name ‘'excel-tab'’.

 -- Class: csv.unix_dialect

     The *note unix_dialect: b6c. class defines the usual properties of
     a CSV file generated on UNIX systems, i.e.  using ‘'\n'’ as line
     terminator and quoting all fields.  It is registered with the
     dialect name ‘'unix'’.

     New in version 3.2.

 -- Class: csv.Sniffer

     The *note Sniffer: 1d62. class is used to deduce the format of a
     CSV file.

     The *note Sniffer: 1d62. class provides two methods:

      -- Method: sniff (sample, delimiters=None)

          Analyze the given `sample' and return a *note Dialect: 1d58.
          subclass reflecting the parameters found.  If the optional
          `delimiters' parameter is given, it is interpreted as a string
          containing possible valid delimiter characters.

      -- Method: has_header (sample)

          Analyze the sample text (presumed to be in CSV format) and
          return *note True: 48f. if the first row appears to be a
          series of column headers.

An example for *note Sniffer: 1d62. use:

     with open('example.csv', newline='') as csvfile:
         dialect = csv.Sniffer().sniff(csvfile.read(1024))
         csvfile.seek(0)
         reader = csv.reader(csvfile, dialect)
         # ... process CSV file contents here ...

The *note csv: 2a. module defines the following constants:

 -- Data: csv.QUOTE_ALL

     Instructs *note writer: def. objects to quote all fields.

 -- Data: csv.QUOTE_MINIMAL

     Instructs *note writer: def. objects to only quote those fields
     which contain special characters such as `delimiter', `quotechar'
     or any of the characters in `lineterminator'.

 -- Data: csv.QUOTE_NONNUMERIC

     Instructs *note writer: def. objects to quote all non-numeric
     fields.

     Instructs the reader to convert all non-quoted fields to type
     `float'.

 -- Data: csv.QUOTE_NONE

     Instructs *note writer: def. objects to never quote fields.  When
     the current `delimiter' occurs in output data it is preceded by the
     current `escapechar' character.  If `escapechar' is not set, the
     writer will raise *note Error: 1d5d. if any characters that require
     escaping are encountered.

     Instructs *note reader: 1d55. to perform no special processing of
     quote characters.

The *note csv: 2a. module defines the following exception:

 -- Exception: csv.Error

     Raised by any of the functions when an error is detected.

   ---------- Footnotes ----------

   (1) (1) If ‘newline=''’ is not specified, newlines embedded inside
quoted fields will not be interpreted correctly, and on platforms that
use ‘\r\n’ linendings on write an extra ‘\r’ will be added.  It should
always be safe to specify ‘newline=''’, since the csv module does its
own (*note universal: 5e9.) newline handling.

   (2) (1) If ‘newline=''’ is not specified, newlines embedded inside
quoted fields will not be interpreted correctly, and on platforms that
use ‘\r\n’ linendings on write an extra ‘\r’ will be added.  It should
always be safe to specify ‘newline=''’, since the csv module does its
own (*note universal: 5e9.) newline handling.


File: python.info,  Node: Dialects and Formatting Parameters,  Next: Reader Objects,  Prev: Module Contents<3>,  Up: csv — CSV File Reading and Writing

5.14.1.2 Dialects and Formatting Parameters
...........................................

To make it easier to specify the format of input and output records,
specific formatting parameters are grouped together into dialects.  A
dialect is a subclass of the *note Dialect: 1d58. class having a set of
specific methods and a single ‘validate()’ method.  When creating *note
reader: 1d55. or *note writer: def. objects, the programmer can specify
a string or a subclass of the *note Dialect: 1d58. class as the dialect
parameter.  In addition to, or instead of, the `dialect' parameter, the
programmer can also specify individual formatting parameters, which have
the same names as the attributes defined below for the *note Dialect:
1d58. class.

Dialects support the following attributes:

 -- Attribute: Dialect.delimiter

     A one-character string used to separate fields.  It defaults to
     ‘','’.

 -- Attribute: Dialect.doublequote

     Controls how instances of `quotechar' appearing inside a field
     should themselves be quoted.  When *note True: 48f, the character
     is doubled.  When *note False: 37d, the `escapechar' is used as a
     prefix to the `quotechar'.  It defaults to *note True: 48f.

     On output, if `doublequote' is *note False: 37d. and no
     `escapechar' is set, *note Error: 1d5d. is raised if a `quotechar'
     is found in a field.

 -- Attribute: Dialect.escapechar

     A one-character string used by the writer to escape the `delimiter'
     if `quoting' is set to *note QUOTE_NONE: 1d68. and the `quotechar'
     if `doublequote' is *note False: 37d.  On reading, the `escapechar'
     removes any special meaning from the following character.  It
     defaults to *note None: 157, which disables escaping.

 -- Attribute: Dialect.lineterminator

     The string used to terminate lines produced by the *note writer:
     def.  It defaults to ‘'\r\n'’.

          Note: The *note reader: 1d55. is hard-coded to recognise
          either ‘'\r'’ or ‘'\n'’ as end-of-line, and ignores
          `lineterminator'.  This behavior may change in the future.

 -- Attribute: Dialect.quotechar

     A one-character string used to quote fields containing special
     characters, such as the `delimiter' or `quotechar', or which
     contain new-line characters.  It defaults to ‘'"'’.

 -- Attribute: Dialect.quoting

     Controls when quotes should be generated by the writer and
     recognised by the reader.  It can take on any of the ‘QUOTE_*’
     constants (see section *note Module Contents: 1d56.) and defaults
     to *note QUOTE_MINIMAL: 1d66.

 -- Attribute: Dialect.skipinitialspace

     When *note True: 48f, whitespace immediately following the
     `delimiter' is ignored.  The default is *note False: 37d.

 -- Attribute: Dialect.strict

     When ‘True’, raise exception *note Error: 1d5d. on bad CSV input.
     The default is ‘False’.


File: python.info,  Node: Reader Objects,  Next: Writer Objects,  Prev: Dialects and Formatting Parameters,  Up: csv — CSV File Reading and Writing

5.14.1.3 Reader Objects
.......................

Reader objects (*note DictReader: 1bb. instances and objects returned by
the *note reader(): 1d55. function) have the following public methods:

 -- Method: csvreader.__next__ ()

     Return the next row of the reader’s iterable object as a list (if
     the object was returned from *note reader(): 1d55.) or a dict (if
     it is a *note DictReader: 1bb. instance), parsed according to the
     current dialect.  Usually you should call this as ‘next(reader)’.

Reader objects have the following public attributes:

 -- Attribute: csvreader.dialect

     A read-only description of the dialect in use by the parser.

 -- Attribute: csvreader.line_num

     The number of lines read from the source iterator.  This is not the
     same as the number of records returned, as records can span
     multiple lines.

DictReader objects have the following public attribute:

 -- Attribute: csvreader.fieldnames

     If not passed as a parameter when creating the object, this
     attribute is initialized upon first access or when the first record
     is read from the file.


File: python.info,  Node: Writer Objects,  Next: Examples<7>,  Prev: Reader Objects,  Up: csv — CSV File Reading and Writing

5.14.1.4 Writer Objects
.......................

‘Writer’ objects (*note DictWriter: b6d. instances and objects returned
by the *note writer(): def. function) have the following public methods.
A `row' must be an iterable of strings or numbers for ‘Writer’ objects
and a dictionary mapping fieldnames to strings or numbers (by passing
them through *note str(): 325. first) for *note DictWriter: b6d.
objects.  Note that complex numbers are written out surrounded by
parens.  This may cause some problems for other programs which read CSV
files (assuming they support complex numbers at all).

 -- Method: csvwriter.writerow (row)

     Write the `row' parameter to the writer’s file object, formatted
     according to the current dialect.  Return the return value of the
     call to the `write' method of the underlying file object.

     Changed in version 3.5: Added support of arbitrary iterables.

 -- Method: csvwriter.writerows (rows)

     Write all elements in `rows' (an iterable of `row' objects as
     described above) to the writer’s file object, formatted according
     to the current dialect.

Writer objects have the following public attribute:

 -- Attribute: csvwriter.dialect

     A read-only description of the dialect in use by the writer.

DictWriter objects have the following public method:

 -- Method: DictWriter.writeheader ()

     Write a row with the field names (as specified in the constructor)
     to the writer’s file object, formatted according to the current
     dialect.  Return the return value of the *note
     csvwriter.writerow(): 6b8. call used internally.

     New in version 3.2.

     Changed in version 3.8: *note writeheader(): b6e. now also returns
     the value returned by the *note csvwriter.writerow(): 6b8. method
     it uses internally.


File: python.info,  Node: Examples<7>,  Prev: Writer Objects,  Up: csv — CSV File Reading and Writing

5.14.1.5 Examples
.................

The simplest example of reading a CSV file:

     import csv
     with open('some.csv', newline='') as f:
         reader = csv.reader(f)
         for row in reader:
             print(row)

Reading a file with an alternate format:

     import csv
     with open('passwd', newline='') as f:
         reader = csv.reader(f, delimiter=':', quoting=csv.QUOTE_NONE)
         for row in reader:
             print(row)

The corresponding simplest possible writing example is:

     import csv
     with open('some.csv', 'w', newline='') as f:
         writer = csv.writer(f)
         writer.writerows(someiterable)

Since *note open(): 4e5. is used to open a CSV file for reading, the
file will by default be decoded into unicode using the system default
encoding (see *note locale.getpreferredencoding(): 39a.).  To decode a
file using a different encoding, use the ‘encoding’ argument of open:

     import csv
     with open('some.csv', newline='', encoding='utf-8') as f:
         reader = csv.reader(f)
         for row in reader:
             print(row)

The same applies to writing in something other than the system default
encoding: specify the encoding argument when opening the output file.

Registering a new dialect:

     import csv
     csv.register_dialect('unixpwd', delimiter=':', quoting=csv.QUOTE_NONE)
     with open('passwd', newline='') as f:
         reader = csv.reader(f, 'unixpwd')

A slightly more advanced use of the reader — catching and reporting
errors:

     import csv, sys
     filename = 'some.csv'
     with open(filename, newline='') as f:
         reader = csv.reader(f)
         try:
             for row in reader:
                 print(row)
         except csv.Error as e:
             sys.exit('file {}, line {}: {}'.format(filename, reader.line_num, e))

And while the module doesn’t directly support parsing strings, it can
easily be done:

     import csv
     for row in csv.reader(['one,two,three']):
         print(row)


File: python.info,  Node: configparser — Configuration file parser,  Next: netrc — netrc file processing,  Prev: csv — CSV File Reading and Writing,  Up: File Formats

5.14.2 ‘configparser’ — Configuration file parser
-------------------------------------------------

`Source code:' Lib/configparser.py(1)

__________________________________________________________________

This module provides the *note ConfigParser: 4a0. class which implements
a basic configuration language which provides a structure similar to
what’s found in Microsoft Windows INI files.  You can use this to write
Python programs which can be customized by end users easily.

     Note: This library does `not' interpret or write the value-type
     prefixes used in the Windows Registry extended version of INI
     syntax.

See also
........

Module *note shlex: e8.

     Support for creating Unix shell-like mini-languages which can be
     used as an alternate format for application configuration files.

Module *note json: a4.

     The json module implements a subset of JavaScript syntax which can
     also be used for this purpose.

* Menu:

* Quick Start::
* Supported Datatypes::
* Fallback Values::
* Supported INI File Structure::
* Interpolation of values::
* Mapping Protocol Access::
* Customizing Parser Behaviour::
* Legacy API Examples::
* ConfigParser Objects::
* RawConfigParser Objects::
* Exceptions: Exceptions<5>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/configparser.py


File: python.info,  Node: Quick Start,  Next: Supported Datatypes,  Up: configparser — Configuration file parser

5.14.2.1 Quick Start
....................

Let’s take a very basic configuration file that looks like this:

     [DEFAULT]
     ServerAliveInterval = 45
     Compression = yes
     CompressionLevel = 9
     ForwardX11 = yes

     [bitbucket.org]
     User = hg

     [topsecret.server.com]
     Port = 50022
     ForwardX11 = no

The structure of INI files is described *note in the following section:
1d7f.  Essentially, the file consists of sections, each of which
contains keys with values.  *note configparser: 23. classes can read and
write such files.  Let’s start by creating the above configuration file
programmatically.

     >>> import configparser
     >>> config = configparser.ConfigParser()
     >>> config['DEFAULT'] = {'ServerAliveInterval': '45',
     ...                      'Compression': 'yes',
     ...                      'CompressionLevel': '9'}
     >>> config['bitbucket.org'] = {}
     >>> config['bitbucket.org']['User'] = 'hg'
     >>> config['topsecret.server.com'] = {}
     >>> topsecret = config['topsecret.server.com']
     >>> topsecret['Port'] = '50022'     # mutates the parser
     >>> topsecret['ForwardX11'] = 'no'  # same here
     >>> config['DEFAULT']['ForwardX11'] = 'yes'
     >>> with open('example.ini', 'w') as configfile:
     ...   config.write(configfile)
     ...

As you can see, we can treat a config parser much like a dictionary.
There are differences, *note outlined later: 1d80, but the behavior is
very close to what you would expect from a dictionary.

Now that we have created and saved a configuration file, let’s read it
back and explore the data it holds.

     >>> config = configparser.ConfigParser()
     >>> config.sections()
     []
     >>> config.read('example.ini')
     ['example.ini']
     >>> config.sections()
     ['bitbucket.org', 'topsecret.server.com']
     >>> 'bitbucket.org' in config
     True
     >>> 'bytebong.com' in config
     False
     >>> config['bitbucket.org']['User']
     'hg'
     >>> config['DEFAULT']['Compression']
     'yes'
     >>> topsecret = config['topsecret.server.com']
     >>> topsecret['ForwardX11']
     'no'
     >>> topsecret['Port']
     '50022'
     >>> for key in config['bitbucket.org']:
     ...     print(key)
     user
     compressionlevel
     serveraliveinterval
     compression
     forwardx11
     >>> config['bitbucket.org']['ForwardX11']
     'yes'

As we can see above, the API is pretty straightforward.  The only bit of
magic involves the ‘DEFAULT’ section which provides default values for
all other sections (1).  Note also that keys in sections are
case-insensitive and stored in lowercase (2).

   ---------- Footnotes ----------

   (1) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.

   (2) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.


File: python.info,  Node: Supported Datatypes,  Next: Fallback Values,  Prev: Quick Start,  Up: configparser — Configuration file parser

5.14.2.2 Supported Datatypes
............................

Config parsers do not guess datatypes of values in configuration files,
always storing them internally as strings.  This means that if you need
other datatypes, you should convert on your own:

     >>> int(topsecret['Port'])
     50022
     >>> float(topsecret['CompressionLevel'])
     9.0

Since this task is so common, config parsers provide a range of handy
getter methods to handle integers, floats and booleans.  The last one is
the most interesting because simply passing the value to ‘bool()’ would
do no good since ‘bool('False')’ is still ‘True’.  This is why config
parsers also provide *note getboolean(): 1d83.  This method is
case-insensitive and recognizes Boolean values from ‘'yes'’/‘'no'’,
‘'on'’/‘'off'’, ‘'true'’/‘'false'’ and ‘'1'’/‘'0'’ (1).  For example:

     >>> topsecret.getboolean('ForwardX11')
     False
     >>> config['bitbucket.org'].getboolean('ForwardX11')
     True
     >>> config.getboolean('bitbucket.org', 'Compression')
     True

Apart from *note getboolean(): 1d83, config parsers also provide
equivalent *note getint(): 1d84. and *note getfloat(): 1d85. methods.
You can register your own converters and customize the provided ones.
(2)

   ---------- Footnotes ----------

   (1) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.

   (2) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.


File: python.info,  Node: Fallback Values,  Next: Supported INI File Structure,  Prev: Supported Datatypes,  Up: configparser — Configuration file parser

5.14.2.3 Fallback Values
........................

As with a dictionary, you can use a section’s ‘get()’ method to provide
fallback values:

     >>> topsecret.get('Port')
     '50022'
     >>> topsecret.get('CompressionLevel')
     '9'
     >>> topsecret.get('Cipher')
     >>> topsecret.get('Cipher', '3des-cbc')
     '3des-cbc'

Please note that default values have precedence over fallback values.
For instance, in our example the ‘'CompressionLevel'’ key was specified
only in the ‘'DEFAULT'’ section.  If we try to get it from the section
‘'topsecret.server.com'’, we will always get the default, even if we
specify a fallback:

     >>> topsecret.get('CompressionLevel', '3')
     '9'

One more thing to be aware of is that the parser-level ‘get()’ method
provides a custom, more complex interface, maintained for backwards
compatibility.  When using this method, a fallback value can be provided
via the ‘fallback’ keyword-only argument:

     >>> config.get('bitbucket.org', 'monster',
     ...            fallback='No such things as monsters')
     'No such things as monsters'

The same ‘fallback’ argument can be used with the *note getint(): 1d84,
*note getfloat(): 1d85. and *note getboolean(): 1d83. methods, for
example:

     >>> 'BatchMode' in topsecret
     False
     >>> topsecret.getboolean('BatchMode', fallback=True)
     True
     >>> config['DEFAULT']['BatchMode'] = 'no'
     >>> topsecret.getboolean('BatchMode', fallback=True)
     False


File: python.info,  Node: Supported INI File Structure,  Next: Interpolation of values,  Prev: Fallback Values,  Up: configparser — Configuration file parser

5.14.2.4 Supported INI File Structure
.....................................

A configuration file consists of sections, each led by a ‘[section]’
header, followed by key/value entries separated by a specific string
(‘=’ or ‘:’ by default (1)).  By default, section names are case
sensitive but keys are not (2).  Leading and trailing whitespace is
removed from keys and values.  Values can be omitted, in which case the
key/value delimiter may also be left out.  Values can also span multiple
lines, as long as they are indented deeper than the first line of the
value.  Depending on the parser’s mode, blank lines may be treated as
parts of multiline values or ignored.

Configuration files may include comments, prefixed by specific
characters (‘#’ and ‘;’ by default (3)).  Comments may appear on their
own on an otherwise empty line, possibly indented.  (4)

For example:

     [Simple Values]
     key=value
     spaces in keys=allowed
     spaces in values=allowed as well
     spaces around the delimiter = obviously
     you can also use : to delimit keys from values

     [All Values Are Strings]
     values like this: 1000000
     or this: 3.14159265359
     are they treated as numbers? : no
     integers, floats and booleans are held as: strings
     can use the API to get converted values directly: true

     [Multiline Values]
     chorus: I'm a lumberjack, and I'm okay
         I sleep all night and I work all day

     [No Values]
     key_without_value
     empty string value here =

     [You can use comments]
     # like this
     ; or this

     # By default only in an empty line.
     # Inline comments can be harmful because they prevent users
     # from using the delimiting characters as parts of values.
     # That being said, this can be customized.

         [Sections Can Be Indented]
             can_values_be_as_well = True
             does_that_mean_anything_special = False
             purpose = formatting for readability
             multiline_values = are
                 handled just fine as
                 long as they are indented
                 deeper than the first line
                 of a value
             # Did I mention we can indent comments, too?

   ---------- Footnotes ----------

   (1) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.

   (2) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.

   (3) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.

   (4) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.


File: python.info,  Node: Interpolation of values,  Next: Mapping Protocol Access,  Prev: Supported INI File Structure,  Up: configparser — Configuration file parser

5.14.2.5 Interpolation of values
................................

On top of the core functionality, *note ConfigParser: 4a0. supports
interpolation.  This means values can be preprocessed before returning
them from ‘get()’ calls.

 -- Class: configparser.BasicInterpolation

     The default implementation used by *note ConfigParser: 4a0.  It
     enables values to contain format strings which refer to other
     values in the same section, or values in the special default
     section (1).  Additional default values can be provided on
     initialization.

     For example:

          [Paths]
          home_dir: /Users
          my_dir: %(home_dir)s/lumberjack
          my_pictures: %(my_dir)s/Pictures

          [Escape]
          gain: 80%%  # use a %% to escape the % sign (% is the only character that needs to be escaped)

     In the example above, *note ConfigParser: 4a0. with `interpolation'
     set to ‘BasicInterpolation()’ would resolve ‘%(home_dir)s’ to the
     value of ‘home_dir’ (‘/Users’ in this case).  ‘%(my_dir)s’ in
     effect would resolve to ‘/Users/lumberjack’.  All interpolations
     are done on demand so keys used in the chain of references do not
     have to be specified in any specific order in the configuration
     file.

     With ‘interpolation’ set to ‘None’, the parser would simply return
     ‘%(my_dir)s/Pictures’ as the value of ‘my_pictures’ and
     ‘%(home_dir)s/lumberjack’ as the value of ‘my_dir’.

 -- Class: configparser.ExtendedInterpolation

     An alternative handler for interpolation which implements a more
     advanced syntax, used for instance in ‘zc.buildout’.  Extended
     interpolation is using ‘${section:option}’ to denote a value from a
     foreign section.  Interpolation can span multiple levels.  For
     convenience, if the ‘section:’ part is omitted, interpolation
     defaults to the current section (and possibly the default values
     from the special section).

     For example, the configuration specified above with basic
     interpolation, would look like this with extended interpolation:

          [Paths]
          home_dir: /Users
          my_dir: ${home_dir}/lumberjack
          my_pictures: ${my_dir}/Pictures

          [Escape]
          cost: $$80  # use a $$ to escape the $ sign ($ is the only character that needs to be escaped)

     Values from other sections can be fetched as well:

          [Common]
          home_dir: /Users
          library_dir: /Library
          system_dir: /System
          macports_dir: /opt/local

          [Frameworks]
          Python: 3.2
          path: ${Common:system_dir}/Library/Frameworks/

          [Arthur]
          nickname: Two Sheds
          last_name: Jackson
          my_dir: ${Common:home_dir}/twosheds
          my_pictures: ${my_dir}/Pictures
          python_dir: ${Frameworks:path}/Python/Versions/${Frameworks:Python}

   ---------- Footnotes ----------

   (1) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.


File: python.info,  Node: Mapping Protocol Access,  Next: Customizing Parser Behaviour,  Prev: Interpolation of values,  Up: configparser — Configuration file parser

5.14.2.6 Mapping Protocol Access
................................

New in version 3.2.

Mapping protocol access is a generic name for functionality that enables
using custom objects as if they were dictionaries.  In case of *note
configparser: 23, the mapping interface implementation is using the
‘parser['section']['option']’ notation.

‘parser['section']’ in particular returns a proxy for the section’s data
in the parser.  This means that the values are not copied but they are
taken from the original parser on demand.  What’s even more important is
that when values are changed on a section proxy, they are actually
mutated in the original parser.

*note configparser: 23. objects behave as close to actual dictionaries
as possible.  The mapping interface is complete and adheres to the *note
MutableMapping: 9e3. ABC. However, there are a few differences that
should be taken into account:

   * By default, all keys in sections are accessible in a
     case-insensitive manner (1).  E.g.  ‘for option in
     parser["section"]’ yields only ‘optionxform’’ed option key names.
     This means lowercased keys by default.  At the same time, for a
     section that holds the key ‘'a'’, both expressions return ‘True’:

          "a" in parser["section"]
          "A" in parser["section"]

   * All sections include ‘DEFAULTSECT’ values as well which means that
     ‘.clear()’ on a section may not leave the section visibly empty.
     This is because default values cannot be deleted from the section
     (because technically they are not there).  If they are overridden
     in the section, deleting causes the default value to be visible
     again.  Trying to delete a default value causes a *note KeyError:
     2c5.

   * ‘DEFAULTSECT’ cannot be removed from the parser:

        * trying to delete it raises *note ValueError: 1f9,

        * ‘parser.clear()’ leaves it intact,

        * ‘parser.popitem()’ never returns it.

   * ‘parser.get(section, option, **kwargs)’ - the second argument is
     `not' a fallback value.  Note however that the section-level
     ‘get()’ methods are compatible both with the mapping protocol and
     the classic configparser API.

   * ‘parser.items()’ is compatible with the mapping protocol (returns a
     list of `section_name', `section_proxy' pairs including the
     DEFAULTSECT). However, this method can also be invoked with
     arguments: ‘parser.items(section, raw, vars)’.  The latter call
     returns a list of `option', `value' pairs for a specified
     ‘section’, with all interpolations expanded (unless ‘raw=True’ is
     provided).

The mapping protocol is implemented on top of the existing legacy API so
that subclasses overriding the original interface still should have
mappings working as expected.

   ---------- Footnotes ----------

   (1) (1) Config parsers allow for heavy customization.  If you are
interested in changing the behaviour outlined by the footnote reference,
consult the *note Customizing Parser Behaviour: 1d81. section.


File: python.info,  Node: Customizing Parser Behaviour,  Next: Legacy API Examples,  Prev: Mapping Protocol Access,  Up: configparser — Configuration file parser

5.14.2.7 Customizing Parser Behaviour
.....................................

There are nearly as many INI format variants as there are applications
using it.  *note configparser: 23. goes a long way to provide support
for the largest sensible set of INI styles available.  The default
functionality is mainly dictated by historical background and it’s very
likely that you will want to customize some of the features.

The most common way to change the way a specific config parser works is
to use the *note __init__(): d51. options:

   * `defaults', default value: ‘None’

     This option accepts a dictionary of key-value pairs which will be
     initially put in the ‘DEFAULT’ section.  This makes for an elegant
     way to support concise configuration files that don’t specify
     values which are the same as the documented default.

     Hint: if you want to specify default values for a specific section,
     use ‘read_dict()’ before you read the actual file.

   * `dict_type', default value: *note dict: 1b6.

     This option has a major impact on how the mapping protocol will
     behave and how the written configuration files look.  With the
     standard dictionary, every section is stored in the order they were
     added to the parser.  Same goes for options within sections.

     An alternative dictionary type can be used for example to sort
     sections and options on write-back.

     Please note: there are ways to add a set of key-value pairs in a
     single operation.  When you use a regular dictionary in those
     operations, the order of the keys will be ordered.  For example:

          >>> parser = configparser.ConfigParser()
          >>> parser.read_dict({'section1': {'key1': 'value1',
          ...                                'key2': 'value2',
          ...                                'key3': 'value3'},
          ...                   'section2': {'keyA': 'valueA',
          ...                                'keyB': 'valueB',
          ...                                'keyC': 'valueC'},
          ...                   'section3': {'foo': 'x',
          ...                                'bar': 'y',
          ...                                'baz': 'z'}
          ... })
          >>> parser.sections()
          ['section1', 'section2', 'section3']
          >>> [option for option in parser['section3']]
          ['foo', 'bar', 'baz']

   * `allow_no_value', default value: ‘False’

     Some configuration files are known to include settings without
     values, but which otherwise conform to the syntax supported by
     *note configparser: 23.  The `allow_no_value' parameter to the
     constructor can be used to indicate that such values should be
     accepted:

          >>> import configparser

          >>> sample_config = """
          ... [mysqld]
          ...   user = mysql
          ...   pid-file = /var/run/mysqld/mysqld.pid
          ...   skip-external-locking
          ...   old_passwords = 1
          ...   skip-bdb
          ...   # we don't need ACID today
          ...   skip-innodb
          ... """
          >>> config = configparser.ConfigParser(allow_no_value=True)
          >>> config.read_string(sample_config)

          >>> # Settings with values are treated as before:
          >>> config["mysqld"]["user"]
          'mysql'

          >>> # Settings without values provide None:
          >>> config["mysqld"]["skip-bdb"]

          >>> # Settings which aren't specified still raise an error:
          >>> config["mysqld"]["does-not-exist"]
          Traceback (most recent call last):
            ...
          KeyError: 'does-not-exist'

   * `delimiters', default value: ‘('=', ':')’

     Delimiters are substrings that delimit keys from values within a
     section.  The first occurrence of a delimiting substring on a line
     is considered a delimiter.  This means values (but not keys) can
     contain the delimiters.

     See also the `space_around_delimiters' argument to *note
     ConfigParser.write(): 1d89.

   * `comment_prefixes', default value: ‘('#', ';')’

   * `inline_comment_prefixes', default value: ‘None’

     Comment prefixes are strings that indicate the start of a valid
     comment within a config file.  `comment_prefixes' are used only on
     otherwise empty lines (optionally indented) whereas
     `inline_comment_prefixes' can be used after every valid value (e.g.
     section names, options and empty lines as well).  By default inline
     comments are disabled and ‘'#'’ and ‘';'’ are used as prefixes for
     whole line comments.

     Changed in version 3.2: In previous versions of *note configparser:
     23. behaviour matched ‘comment_prefixes=('#',';')’ and
     ‘inline_comment_prefixes=(';',)’.

     Please note that config parsers don’t support escaping of comment
     prefixes so using `inline_comment_prefixes' may prevent users from
     specifying option values with characters used as comment prefixes.
     When in doubt, avoid setting `inline_comment_prefixes'.  In any
     circumstances, the only way of storing comment prefix characters at
     the beginning of a line in multiline values is to interpolate the
     prefix, for example:

          >>> from configparser import ConfigParser, ExtendedInterpolation
          >>> parser = ConfigParser(interpolation=ExtendedInterpolation())
          >>> # the default BasicInterpolation could be used as well
          >>> parser.read_string("""
          ... [DEFAULT]
          ... hash = #
          ...
          ... [hashes]
          ... shebang =
          ...   ${hash}!/usr/bin/env python
          ...   ${hash} -*- coding: utf-8 -*-
          ...
          ... extensions =
          ...   enabled_extension
          ...   another_extension
          ...   #disabled_by_comment
          ...   yet_another_extension
          ...
          ... interpolation not necessary = if # is not at line start
          ... even in multiline values = line #1
          ...   line #2
          ...   line #3
          ... """)
          >>> print(parser['hashes']['shebang'])

          #!/usr/bin/env python
          # -*- coding: utf-8 -*-
          >>> print(parser['hashes']['extensions'])

          enabled_extension
          another_extension
          yet_another_extension
          >>> print(parser['hashes']['interpolation not necessary'])
          if # is not at line start
          >>> print(parser['hashes']['even in multiline values'])
          line #1
          line #2
          line #3

   * `strict', default value: ‘True’

     When set to ‘True’, the parser will not allow for any section or
     option duplicates while reading from a single source (using
     ‘read_file()’, ‘read_string()’ or ‘read_dict()’).  It is
     recommended to use strict parsers in new applications.

     Changed in version 3.2: In previous versions of *note configparser:
     23. behaviour matched ‘strict=False’.

   * `empty_lines_in_values', default value: ‘True’

     In config parsers, values can span multiple lines as long as they
     are indented more than the key that holds them.  By default parsers
     also let empty lines to be parts of values.  At the same time, keys
     can be arbitrarily indented themselves to improve readability.  In
     consequence, when configuration files get big and complex, it is
     easy for the user to lose track of the file structure.  Take for
     instance:

          [Section]
          key = multiline
            value with a gotcha

           this = is still a part of the multiline value of 'key'

     This can be especially problematic for the user to see if she’s
     using a proportional font to edit the file.  That is why when your
     application does not need values with empty lines, you should
     consider disallowing them.  This will make empty lines split keys
     every time.  In the example above, it would produce two keys, ‘key’
     and ‘this’.

   * `default_section', default value: ‘configparser.DEFAULTSECT’ (that
     is: ‘"DEFAULT"’)

     The convention of allowing a special section of default values for
     other sections or interpolation purposes is a powerful concept of
     this library, letting users create complex declarative
     configurations.  This section is normally called ‘"DEFAULT"’ but
     this can be customized to point to any other valid section name.
     Some typical values include: ‘"general"’ or ‘"common"’.  The name
     provided is used for recognizing default sections when reading from
     any source and is used when writing configuration back to a file.
     Its current value can be retrieved using the
     ‘parser_instance.default_section’ attribute and may be modified at
     runtime (i.e.  to convert files from one format to another).

   * `interpolation', default value: ‘configparser.BasicInterpolation’

     Interpolation behaviour may be customized by providing a custom
     handler through the `interpolation' argument.  ‘None’ can be used
     to turn off interpolation completely, ‘ExtendedInterpolation()’
     provides a more advanced variant inspired by ‘zc.buildout’.  More
     on the subject in the *note dedicated documentation section: 1d87.
     *note RawConfigParser: 865. has a default value of ‘None’.

   * `converters', default value: not set

     Config parsers provide option value getters that perform type
     conversion.  By default *note getint(): 1d84, *note getfloat():
     1d85, and *note getboolean(): 1d83. are implemented.  Should other
     getters be desirable, users may define them in a subclass or pass a
     dictionary where each key is a name of the converter and each value
     is a callable implementing said conversion.  For instance, passing
     ‘{'decimal': decimal.Decimal}’ would add ‘getdecimal()’ on both the
     parser object and all section proxies.  In other words, it will be
     possible to write both ‘parser_instance.getdecimal('section',
     'key', fallback=0)’ and
     ‘parser_instance['section'].getdecimal('key', 0)’.

     If the converter needs to access the state of the parser, it can be
     implemented as a method on a config parser subclass.  If the name
     of this method starts with ‘get’, it will be available on all
     section proxies, in the dict-compatible form (see the
     ‘getdecimal()’ example above).

More advanced customization may be achieved by overriding default values
of these parser attributes.  The defaults are defined on the classes, so
they may be overridden by subclasses or by attribute assignment.

 -- Attribute: ConfigParser.BOOLEAN_STATES

     By default when using *note getboolean(): 1d83, config parsers
     consider the following values ‘True’: ‘'1'’, ‘'yes'’, ‘'true'’,
     ‘'on'’ and the following values ‘False’: ‘'0'’, ‘'no'’, ‘'false'’,
     ‘'off'’.  You can override this by specifying a custom dictionary
     of strings and their Boolean outcomes.  For example:

          >>> custom = configparser.ConfigParser()
          >>> custom['section1'] = {'funky': 'nope'}
          >>> custom['section1'].getboolean('funky')
          Traceback (most recent call last):
          ...
          ValueError: Not a boolean: nope
          >>> custom.BOOLEAN_STATES = {'sure': True, 'nope': False}
          >>> custom['section1'].getboolean('funky')
          False

     Other typical Boolean pairs include ‘accept’/‘reject’ or
     ‘enabled’/‘disabled’.

 -- Method: ConfigParser.optionxform (option)

     This method transforms option names on every read, get, or set
     operation.  The default converts the name to lowercase.  This also
     means that when a configuration file gets written, all keys will be
     lowercase.  Override this method if that’s unsuitable.  For
     example:

          >>> config = """
          ... [Section1]
          ... Key = Value
          ...
          ... [Section2]
          ... AnotherKey = Value
          ... """
          >>> typical = configparser.ConfigParser()
          >>> typical.read_string(config)
          >>> list(typical['Section1'].keys())
          ['key']
          >>> list(typical['Section2'].keys())
          ['anotherkey']
          >>> custom = configparser.RawConfigParser()
          >>> custom.optionxform = lambda option: option
          >>> custom.read_string(config)
          >>> list(custom['Section1'].keys())
          ['Key']
          >>> list(custom['Section2'].keys())
          ['AnotherKey']

          Note: The optionxform function transforms option names to a
          canonical form.  This should be an idempotent function: if the
          name is already in canonical form, it should be returned
          unchanged.

 -- Attribute: ConfigParser.SECTCRE

     A compiled regular expression used to parse section headers.  The
     default matches ‘[section]’ to the name ‘"section"’.  Whitespace is
     considered part of the section name, thus ‘[ larch ]’ will be read
     as a section of name ‘" larch "’.  Override this attribute if
     that’s unsuitable.  For example:

          >>> import re
          >>> config = """
          ... [Section 1]
          ... option = value
          ...
          ... [  Section 2  ]
          ... another = val
          ... """
          >>> typical = configparser.ConfigParser()
          >>> typical.read_string(config)
          >>> typical.sections()
          ['Section 1', '  Section 2  ']
          >>> custom = configparser.ConfigParser()
          >>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")
          >>> custom.read_string(config)
          >>> custom.sections()
          ['Section 1', 'Section 2']

          Note: While ConfigParser objects also use an ‘OPTCRE’
          attribute for recognizing option lines, it’s not recommended
          to override it because that would interfere with constructor
          options `allow_no_value' and `delimiters'.


File: python.info,  Node: Legacy API Examples,  Next: ConfigParser Objects,  Prev: Customizing Parser Behaviour,  Up: configparser — Configuration file parser

5.14.2.8 Legacy API Examples
............................

Mainly because of backwards compatibility concerns, *note configparser:
23. provides also a legacy API with explicit ‘get’/‘set’ methods.  While
there are valid use cases for the methods outlined below, mapping
protocol access is preferred for new projects.  The legacy API is at
times more advanced, low-level and downright counterintuitive.

An example of writing to a configuration file:

     import configparser

     config = configparser.RawConfigParser()

     # Please note that using RawConfigParser's set functions, you can assign
     # non-string values to keys internally, but will receive an error when
     # attempting to write to a file or when you get it in non-raw mode. Setting
     # values using the mapping protocol or ConfigParser's set() does not allow
     # such assignments to take place.
     config.add_section('Section1')
     config.set('Section1', 'an_int', '15')
     config.set('Section1', 'a_bool', 'true')
     config.set('Section1', 'a_float', '3.1415')
     config.set('Section1', 'baz', 'fun')
     config.set('Section1', 'bar', 'Python')
     config.set('Section1', 'foo', '%(bar)s is %(baz)s!')

     # Writing our configuration file to 'example.cfg'
     with open('example.cfg', 'w') as configfile:
         config.write(configfile)

An example of reading the configuration file again:

     import configparser

     config = configparser.RawConfigParser()
     config.read('example.cfg')

     # getfloat() raises an exception if the value is not a float
     # getint() and getboolean() also do this for their respective types
     a_float = config.getfloat('Section1', 'a_float')
     an_int = config.getint('Section1', 'an_int')
     print(a_float + an_int)

     # Notice that the next output does not interpolate '%(bar)s' or '%(baz)s'.
     # This is because we are using a RawConfigParser().
     if config.getboolean('Section1', 'a_bool'):
         print(config.get('Section1', 'foo'))

To get interpolation, use *note ConfigParser: 4a0.:

     import configparser

     cfg = configparser.ConfigParser()
     cfg.read('example.cfg')

     # Set the optional *raw* argument of get() to True if you wish to disable
     # interpolation in a single get operation.
     print(cfg.get('Section1', 'foo', raw=False))  # -> "Python is fun!"
     print(cfg.get('Section1', 'foo', raw=True))   # -> "%(bar)s is %(baz)s!"

     # The optional *vars* argument is a dict with members that will take
     # precedence in interpolation.
     print(cfg.get('Section1', 'foo', vars={'bar': 'Documentation',
                                            'baz': 'evil'}))

     # The optional *fallback* argument can be used to provide a fallback value
     print(cfg.get('Section1', 'foo'))
           # -> "Python is fun!"

     print(cfg.get('Section1', 'foo', fallback='Monty is not.'))
           # -> "Python is fun!"

     print(cfg.get('Section1', 'monster', fallback='No such things as monsters.'))
           # -> "No such things as monsters."

     # A bare print(cfg.get('Section1', 'monster')) would raise NoOptionError
     # but we can also use:

     print(cfg.get('Section1', 'monster', fallback=None))
           # -> None

Default values are available in both types of ConfigParsers.  They are
used in interpolation if an option used is not defined elsewhere.

     import configparser

     # New instance with 'bar' and 'baz' defaulting to 'Life' and 'hard' each
     config = configparser.ConfigParser({'bar': 'Life', 'baz': 'hard'})
     config.read('example.cfg')

     print(config.get('Section1', 'foo'))     # -> "Python is fun!"
     config.remove_option('Section1', 'bar')
     config.remove_option('Section1', 'baz')
     print(config.get('Section1', 'foo'))     # -> "Life is hard!"


File: python.info,  Node: ConfigParser Objects,  Next: RawConfigParser Objects,  Prev: Legacy API Examples,  Up: configparser — Configuration file parser

5.14.2.9 ConfigParser Objects
.............................

 -- Class: configparser.ConfigParser (defaults=None, dict_type=dict,
          allow_no_value=False, delimiters=('=', ':'),
          comment_prefixes=('#', ';'), inline_comment_prefixes=None,
          strict=True, empty_lines_in_values=True,
          default_section=configparser.DEFAULTSECT,
          interpolation=BasicInterpolation(), converters={})

     The main configuration parser.  When `defaults' is given, it is
     initialized into the dictionary of intrinsic defaults.  When
     `dict_type' is given, it will be used to create the dictionary
     objects for the list of sections, for the options within a section,
     and for the default values.

     When `delimiters' is given, it is used as the set of substrings
     that divide keys from values.  When `comment_prefixes' is given, it
     will be used as the set of substrings that prefix comments in
     otherwise empty lines.  Comments can be indented.  When
     `inline_comment_prefixes' is given, it will be used as the set of
     substrings that prefix comments in non-empty lines.

     When `strict' is ‘True’ (the default), the parser won’t allow for
     any section or option duplicates while reading from a single source
     (file, string or dictionary), raising *note DuplicateSectionError:
     bf8. or *note DuplicateOptionError: bf9.  When
     `empty_lines_in_values' is ‘False’ (default: ‘True’), each empty
     line marks the end of an option.  Otherwise, internal empty lines
     of a multiline option are kept as part of the value.  When
     `allow_no_value' is ‘True’ (default: ‘False’), options without
     values are accepted; the value held for these is ‘None’ and they
     are serialized without the trailing delimiter.

     When `default_section' is given, it specifies the name for the
     special section holding default values for other sections and
     interpolation purposes (normally named ‘"DEFAULT"’).  This value
     can be retrieved and changed on runtime using the ‘default_section’
     instance attribute.

     Interpolation behaviour may be customized by providing a custom
     handler through the `interpolation' argument.  ‘None’ can be used
     to turn off interpolation completely, ‘ExtendedInterpolation()’
     provides a more advanced variant inspired by ‘zc.buildout’.  More
     on the subject in the *note dedicated documentation section: 1d87.

     All option names used in interpolation will be passed through the
     *note optionxform(): 1d8b. method just like any other option name
     reference.  For example, using the default implementation of *note
     optionxform(): 1d8b. (which converts option names to lower case),
     the values ‘foo %(bar)s’ and ‘foo %(BAR)s’ are equivalent.

     When `converters' is given, it should be a dictionary where each
     key represents the name of a type converter and each value is a
     callable implementing the conversion from string to the desired
     datatype.  Every converter gets its own corresponding ‘get*()’
     method on the parser object and section proxies.

     Changed in version 3.1: The default `dict_type' is *note
     collections.OrderedDict: 1b7.

     Changed in version 3.2: `allow_no_value', `delimiters',
     `comment_prefixes', `strict', `empty_lines_in_values',
     `default_section' and `interpolation' were added.

     Changed in version 3.5: The `converters' argument was added.

     Changed in version 3.7: The `defaults' argument is read with *note
     read_dict(): 1d90, providing consistent behavior across the parser:
     non-string keys and values are implicitly converted to strings.

     Changed in version 3.8: The default `dict_type' is *note dict: 1b6,
     since it now preserves insertion order.

      -- Method: defaults ()

          Return a dictionary containing the instance-wide defaults.

      -- Method: sections ()

          Return a list of the sections available; the `default section'
          is not included in the list.

      -- Method: add_section (section)

          Add a section named `section' to the instance.  If a section
          by the given name already exists, *note DuplicateSectionError:
          bf8. is raised.  If the `default section' name is passed,
          *note ValueError: 1f9. is raised.  The name of the section
          must be a string; if not, *note TypeError: 192. is raised.

          Changed in version 3.2: Non-string section names raise *note
          TypeError: 192.

      -- Method: has_section (section)

          Indicates whether the named `section' is present in the
          configuration.  The `default section' is not acknowledged.

      -- Method: options (section)

          Return a list of options available in the specified `section'.

      -- Method: has_option (section, option)

          If the given `section' exists, and contains the given
          `option', return *note True: 48f.; otherwise return *note
          False: 37d.  If the specified `section' is *note None: 157. or
          an empty string, DEFAULT is assumed.

      -- Method: read (filenames, encoding=None)

          Attempt to read and parse an iterable of filenames, returning
          a list of filenames which were successfully parsed.

          If `filenames' is a string, a *note bytes: 326. object or a
          *note path-like object: 35f, it is treated as a single
          filename.  If a file named in `filenames' cannot be opened,
          that file will be ignored.  This is designed so that you can
          specify an iterable of potential configuration file locations
          (for example, the current directory, the user’s home
          directory, and some system-wide directory), and all existing
          configuration files in the iterable will be read.

          If none of the named files exist, the *note ConfigParser: 4a0.
          instance will contain an empty dataset.  An application which
          requires initial values to be loaded from a file should load
          the required file or files using *note read_file(): 1d96.
          before calling *note read(): fdd. for any optional files:

               import configparser, os

               config = configparser.ConfigParser()
               config.read_file(open('defaults.cfg'))
               config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
                           encoding='cp1250')

          New in version 3.2: The `encoding' parameter.  Previously, all
          files were read using the default encoding for *note open():
          4e5.

          New in version 3.6.1: The `filenames' parameter accepts a
          *note path-like object: 35f.

          New in version 3.7: The `filenames' parameter accepts a *note
          bytes: 326. object.

      -- Method: read_file (f, source=None)

          Read and parse configuration data from `f' which must be an
          iterable yielding Unicode strings (for example files opened in
          text mode).

          Optional argument `source' specifies the name of the file
          being read.  If not given and `f' has a ‘name’ attribute, that
          is used for `source'; the default is ‘'<???>'’.

          New in version 3.2: Replaces *note readfp(): 1d97.

      -- Method: read_string (string, source='<string>')

          Parse configuration data from a string.

          Optional argument `source' specifies a context-specific name
          of the string passed.  If not given, ‘'<string>'’ is used.
          This should commonly be a filesystem path or a URL.

          New in version 3.2.

      -- Method: read_dict (dictionary, source='<dict>')

          Load configuration from any object that provides a dict-like
          ‘items()’ method.  Keys are section names, values are
          dictionaries with keys and values that should be present in
          the section.  If the used dictionary type preserves order,
          sections and their keys will be added in order.  Values are
          automatically converted to strings.

          Optional argument `source' specifies a context-specific name
          of the dictionary passed.  If not given, ‘<dict>’ is used.

          This method can be used to copy state between parsers.

          New in version 3.2.

      -- Method: get (section, option, *, raw=False, vars=None[,
               fallback])

          Get an `option' value for the named `section'.  If `vars' is
          provided, it must be a dictionary.  The `option' is looked up
          in `vars' (if provided), `section', and in `DEFAULTSECT' in
          that order.  If the key is not found and `fallback' is
          provided, it is used as a fallback value.  ‘None’ can be
          provided as a `fallback' value.

          All the ‘'%'’ interpolations are expanded in the return
          values, unless the `raw' argument is true.  Values for
          interpolation keys are looked up in the same manner as the
          option.

          Changed in version 3.2: Arguments `raw', `vars' and `fallback'
          are keyword only to protect users from trying to use the third
          argument as the `fallback' fallback (especially when using the
          mapping protocol).

      -- Method: getint (section, option, *, raw=False, vars=None[,
               fallback])

          A convenience method which coerces the `option' in the
          specified `section' to an integer.  See *note get(): bf5. for
          explanation of `raw', `vars' and `fallback'.

      -- Method: getfloat (section, option, *, raw=False, vars=None[,
               fallback])

          A convenience method which coerces the `option' in the
          specified `section' to a floating point number.  See *note
          get(): bf5. for explanation of `raw', `vars' and `fallback'.

      -- Method: getboolean (section, option, *, raw=False, vars=None[,
               fallback])

          A convenience method which coerces the `option' in the
          specified `section' to a Boolean value.  Note that the
          accepted values for the option are ‘'1'’, ‘'yes'’, ‘'true'’,
          and ‘'on'’, which cause this method to return ‘True’, and
          ‘'0'’, ‘'no'’, ‘'false'’, and ‘'off'’, which cause it to
          return ‘False’.  These string values are checked in a
          case-insensitive manner.  Any other value will cause it to
          raise *note ValueError: 1f9.  See *note get(): bf5. for
          explanation of `raw', `vars' and `fallback'.

      -- Method: items (raw=False, vars=None)

      -- Method: items (section, raw=False, vars=None)

          When `section' is not given, return a list of `section_name',
          `section_proxy' pairs, including DEFAULTSECT.

          Otherwise, return a list of `name', `value' pairs for the
          options in the given `section'.  Optional arguments have the
          same meaning as for the *note get(): bf5. method.

          Changed in version 3.8: Items present in `vars' no longer
          appear in the result.  The previous behaviour mixed actual
          parser options with variables provided for interpolation.

      -- Method: set (section, option, value)

          If the given section exists, set the given option to the
          specified value; otherwise raise *note NoSectionError: 1d9a.
          `option' and `value' must be strings; if not, *note TypeError:
          192. is raised.

      -- Method: write (fileobject, space_around_delimiters=True)

          Write a representation of the configuration to the specified
          *note file object: b35, which must be opened in text mode
          (accepting strings).  This representation can be parsed by a
          future *note read(): fdd. call.  If `space_around_delimiters'
          is true, delimiters between keys and values are surrounded by
          spaces.

      -- Method: remove_option (section, option)

          Remove the specified `option' from the specified `section'.
          If the section does not exist, raise *note NoSectionError:
          1d9a.  If the option existed to be removed, return *note True:
          48f.; otherwise return *note False: 37d.

      -- Method: remove_section (section)

          Remove the specified `section' from the configuration.  If the
          section in fact existed, return ‘True’.  Otherwise return
          ‘False’.

      -- Method: optionxform (option)

          Transforms the option name `option' as found in an input file
          or as passed in by client code to the form that should be used
          in the internal structures.  The default implementation
          returns a lower-case version of `option'; subclasses may
          override this or client code can set an attribute of this name
          on instances to affect this behavior.

          You don’t need to subclass the parser to use this method, you
          can also set it on an instance, to a function that takes a
          string argument and returns a string.  Setting it to ‘str’,
          for example, would make option names case sensitive:

               cfgparser = ConfigParser()
               cfgparser.optionxform = str

          Note that when reading configuration files, whitespace around
          the option names is stripped before *note optionxform(): 1d8b.
          is called.

      -- Method: readfp (fp, filename=None)

          Deprecated since version 3.2: Use *note read_file(): 1d96.
          instead.

          Changed in version 3.2: *note readfp(): 1d97. now iterates on
          `fp' instead of calling ‘fp.readline()’.

          For existing code calling *note readfp(): 1d97. with arguments
          which don’t support iteration, the following generator may be
          used as a wrapper around the file-like object:

               def readline_generator(fp):
                   line = fp.readline()
                   while line:
                       yield line
                       line = fp.readline()

          Instead of ‘parser.readfp(fp)’ use
          ‘parser.read_file(readline_generator(fp))’.

 -- Data: configparser.MAX_INTERPOLATION_DEPTH

     The maximum depth for recursive interpolation for ‘get()’ when the
     `raw' parameter is false.  This is relevant only when the default
     `interpolation' is used.


File: python.info,  Node: RawConfigParser Objects,  Next: Exceptions<5>,  Prev: ConfigParser Objects,  Up: configparser — Configuration file parser

5.14.2.10 RawConfigParser Objects
.................................

 -- Class: configparser.RawConfigParser (defaults=None, dict_type=dict,
          allow_no_value=False, *, delimiters=('=', ':'),
          comment_prefixes=('#', ';'), inline_comment_prefixes=None,
          strict=True, empty_lines_in_values=True,
          default_section=configparser.DEFAULTSECT[, interpolation])

     Legacy variant of the *note ConfigParser: 4a0.  It has
     interpolation disabled by default and allows for non-string section
     names, option names, and values via its unsafe ‘add_section’ and
     ‘set’ methods, as well as the legacy ‘defaults=’ keyword argument
     handling.

     Changed in version 3.8: The default `dict_type' is *note dict: 1b6,
     since it now preserves insertion order.

          Note: Consider using *note ConfigParser: 4a0. instead which
          checks types of the values to be stored internally.  If you
          don’t want interpolation, you can use
          ‘ConfigParser(interpolation=None)’.

      -- Method: add_section (section)

          Add a section named `section' to the instance.  If a section
          by the given name already exists, *note DuplicateSectionError:
          bf8. is raised.  If the `default section' name is passed,
          *note ValueError: 1f9. is raised.

          Type of `section' is not checked which lets users create
          non-string named sections.  This behaviour is unsupported and
          may cause internal errors.

      -- Method: set (section, option, value)

          If the given section exists, set the given option to the
          specified value; otherwise raise *note NoSectionError: 1d9a.
          While it is possible to use *note RawConfigParser: 865. (or
          *note ConfigParser: 4a0. with `raw' parameters set to true)
          for `internal' storage of non-string values, full
          functionality (including interpolation and output to files)
          can only be achieved using string values.

          This method lets users assign non-string values to keys
          internally.  This behaviour is unsupported and will cause
          errors when attempting to write to a file or get it in non-raw
          mode.  `Use the mapping protocol API' which does not allow
          such assignments to take place.


File: python.info,  Node: Exceptions<5>,  Prev: RawConfigParser Objects,  Up: configparser — Configuration file parser

5.14.2.11 Exceptions
....................

 -- Exception: configparser.Error

     Base class for all other *note configparser: 23. exceptions.

 -- Exception: configparser.NoSectionError

     Exception raised when a specified section is not found.

 -- Exception: configparser.DuplicateSectionError

     Exception raised if ‘add_section()’ is called with the name of a
     section that is already present or in strict parsers when a section
     if found more than once in a single input file, string or
     dictionary.

     New in version 3.2: Optional ‘source’ and ‘lineno’ attributes and
     arguments to *note __init__(): d51. were added.

 -- Exception: configparser.DuplicateOptionError

     Exception raised by strict parsers if a single option appears twice
     during reading from a single file, string or dictionary.  This
     catches misspellings and case sensitivity-related errors, e.g.  a
     dictionary may have two keys representing the same case-insensitive
     configuration key.

 -- Exception: configparser.NoOptionError

     Exception raised when a specified option is not found in the
     specified section.

 -- Exception: configparser.InterpolationError

     Base class for exceptions raised when problems occur performing
     string interpolation.

 -- Exception: configparser.InterpolationDepthError

     Exception raised when string interpolation cannot be completed
     because the number of iterations exceeds *note
     MAX_INTERPOLATION_DEPTH: 1d9d.  Subclass of *note
     InterpolationError: 1da5.

 -- Exception: configparser.InterpolationMissingOptionError

     Exception raised when an option referenced from a value does not
     exist.  Subclass of *note InterpolationError: 1da5.

 -- Exception: configparser.InterpolationSyntaxError

     Exception raised when the source text into which substitutions are
     made does not conform to the required syntax.  Subclass of *note
     InterpolationError: 1da5.

 -- Exception: configparser.MissingSectionHeaderError

     Exception raised when attempting to parse a file which has no
     section headers.

 -- Exception: configparser.ParsingError

     Exception raised when errors occur attempting to parse a file.

     Changed in version 3.2: The ‘filename’ attribute and *note
     __init__(): d51. argument were renamed to ‘source’ for consistency.


File: python.info,  Node: netrc — netrc file processing,  Next: xdrlib — Encode and decode XDR data,  Prev: configparser — Configuration file parser,  Up: File Formats

5.14.3 ‘netrc’ — netrc file processing
--------------------------------------

`Source code:' Lib/netrc.py(1)

__________________________________________________________________

The *note netrc: fd8. class parses and encapsulates the netrc file
format used by the Unix ‘ftp’ program and other FTP clients.

 -- Class: netrc.netrc ([file])

     A *note netrc: fd8. instance or subclass instance encapsulates data
     from a netrc file.  The initialization argument, if present,
     specifies the file to parse.  If no argument is given, the file
     ‘.netrc’ in the user’s home directory – as determined by *note
     os.path.expanduser(): 1fc. – will be read.  Otherwise, a *note
     FileNotFoundError: 7b4. exception will be raised.  Parse errors
     will raise *note NetrcParseError: 1dad. with diagnostic information
     including the file name, line number, and terminating token.  If no
     argument is specified on a POSIX system, the presence of passwords
     in the ‘.netrc’ file will raise a *note NetrcParseError: 1dad. if
     the file ownership or permissions are insecure (owned by a user
     other than the user running the process, or accessible for read or
     write by any other user).  This implements security behavior
     equivalent to that of ftp and other programs that use ‘.netrc’.

     Changed in version 3.4: Added the POSIX permission check.

     Changed in version 3.7: *note os.path.expanduser(): 1fc. is used to
     find the location of the ‘.netrc’ file when `file' is not passed as
     argument.

 -- Exception: netrc.NetrcParseError

     Exception raised by the *note netrc: fd8. class when syntactical
     errors are encountered in source text.  Instances of this exception
     provide three interesting attributes: ‘msg’ is a textual
     explanation of the error, ‘filename’ is the name of the source
     file, and ‘lineno’ gives the line number on which the error was
     found.

* Menu:

* netrc Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/netrc.py


File: python.info,  Node: netrc Objects,  Up: netrc — netrc file processing

5.14.3.1 netrc Objects
......................

A *note netrc: fd8. instance has the following methods:

 -- Method: netrc.authenticators (host)

     Return a 3-tuple ‘(login, account, password)’ of authenticators for
     `host'.  If the netrc file did not contain an entry for the given
     host, return the tuple associated with the ‘default’ entry.  If
     neither matching host nor default entry is available, return
     ‘None’.

 -- Method: netrc.__repr__ ()

     Dump the class data as a string in the format of a netrc file.
     (This discards comments and may reorder the entries.)

Instances of *note netrc: fd8. have public instance variables:

 -- Attribute: netrc.hosts

     Dictionary mapping host names to ‘(login, account, password)’
     tuples.  The ‘default’ entry, if any, is represented as a
     pseudo-host by that name.

 -- Attribute: netrc.macros

     Dictionary mapping macro names to string lists.

     Note: Passwords are limited to a subset of the ASCII character set.
     All ASCII punctuation is allowed in passwords, however, note that
     whitespace and non-printable characters are not allowed in
     passwords.  This is a limitation of the way the .netrc file is
     parsed and may be removed in the future.


File: python.info,  Node: xdrlib — Encode and decode XDR data,  Next: plistlib — Generate and parse Mac OS X plist files,  Prev: netrc — netrc file processing,  Up: File Formats

5.14.4 ‘xdrlib’ — Encode and decode XDR data
--------------------------------------------

`Source code:' Lib/xdrlib.py(1)

__________________________________________________________________

The *note xdrlib: 132. module supports the External Data Representation
Standard as described in RFC 1014(2), written by Sun Microsystems, Inc.
June 1987.  It supports most of the data types described in the RFC.

The *note xdrlib: 132. module defines two classes, one for packing
variables into XDR representation, and another for unpacking from XDR
representation.  There are also two exception classes.

 -- Class: xdrlib.Packer

     *note Packer: 1db6. is the class for packing data into XDR
     representation.  The *note Packer: 1db6. class is instantiated with
     no arguments.

 -- Class: xdrlib.Unpacker (data)

     ‘Unpacker’ is the complementary class which unpacks XDR data values
     from a string buffer.  The input buffer is given as `data'.

See also
........

RFC 1014(3) - XDR: External Data Representation Standard

     This RFC defined the encoding of data which was XDR at the time
     this module was originally written.  It has apparently been
     obsoleted by RFC 1832(4).

RFC 1832(5) - XDR: External Data Representation Standard

     Newer RFC that provides a revised definition of XDR.

* Menu:

* Packer Objects::
* Unpacker Objects::
* Exceptions: Exceptions<6>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/xdrlib.py

   (2) https://tools.ietf.org/html/rfc1014.html

   (3) https://tools.ietf.org/html/rfc1014.html

   (4) https://tools.ietf.org/html/rfc1832.html

   (5) https://tools.ietf.org/html/rfc1832.html


File: python.info,  Node: Packer Objects,  Next: Unpacker Objects,  Up: xdrlib — Encode and decode XDR data

5.14.4.1 Packer Objects
.......................

*note Packer: 1db6. instances have the following methods:

 -- Method: Packer.get_buffer ()

     Returns the current pack buffer as a string.

 -- Method: Packer.reset ()

     Resets the pack buffer to the empty string.

In general, you can pack any of the most common XDR data types by
calling the appropriate ‘pack_type()’ method.  Each method takes a
single argument, the value to pack.  The following simple data type
packing methods are supported: ‘pack_uint()’, ‘pack_int()’,
‘pack_enum()’, ‘pack_bool()’, ‘pack_uhyper()’, and ‘pack_hyper()’.

 -- Method: Packer.pack_float (value)

     Packs the single-precision floating point number `value'.

 -- Method: Packer.pack_double (value)

     Packs the double-precision floating point number `value'.

The following methods support packing strings, bytes, and opaque data:

 -- Method: Packer.pack_fstring (n, s)

     Packs a fixed length string, `s'.  `n' is the length of the string
     but it is `not' packed into the data buffer.  The string is padded
     with null bytes if necessary to guaranteed 4 byte alignment.

 -- Method: Packer.pack_fopaque (n, data)

     Packs a fixed length opaque data stream, similarly to *note
     pack_fstring(): 1dbe.

 -- Method: Packer.pack_string (s)

     Packs a variable length string, `s'.  The length of the string is
     first packed as an unsigned integer, then the string data is packed
     with *note pack_fstring(): 1dbe.

 -- Method: Packer.pack_opaque (data)

     Packs a variable length opaque data string, similarly to *note
     pack_string(): 1dc0.

 -- Method: Packer.pack_bytes (bytes)

     Packs a variable length byte stream, similarly to *note
     pack_string(): 1dc0.

The following methods support packing arrays and lists:

 -- Method: Packer.pack_list (list, pack_item)

     Packs a `list' of homogeneous items.  This method is useful for
     lists with an indeterminate size; i.e.  the size is not available
     until the entire list has been walked.  For each item in the list,
     an unsigned integer ‘1’ is packed first, followed by the data value
     from the list.  `pack_item' is the function that is called to pack
     the individual item.  At the end of the list, an unsigned integer
     ‘0’ is packed.

     For example, to pack a list of integers, the code might appear like
     this:

          import xdrlib
          p = xdrlib.Packer()
          p.pack_list([1, 2, 3], p.pack_int)

 -- Method: Packer.pack_farray (n, array, pack_item)

     Packs a fixed length list (`array') of homogeneous items.  `n' is
     the length of the list; it is `not' packed into the buffer, but a
     *note ValueError: 1f9. exception is raised if ‘len(array)’ is not
     equal to `n'.  As above, `pack_item' is the function used to pack
     each element.

 -- Method: Packer.pack_array (list, pack_item)

     Packs a variable length `list' of homogeneous items.  First, the
     length of the list is packed as an unsigned integer, then each
     element is packed as in *note pack_farray(): 1dc4. above.


File: python.info,  Node: Unpacker Objects,  Next: Exceptions<6>,  Prev: Packer Objects,  Up: xdrlib — Encode and decode XDR data

5.14.4.2 Unpacker Objects
.........................

The *note Unpacker: 1db7. class offers the following methods:

 -- Method: Unpacker.reset (data)

     Resets the string buffer with the given `data'.

 -- Method: Unpacker.get_position ()

     Returns the current unpack position in the data buffer.

 -- Method: Unpacker.set_position (position)

     Sets the data buffer unpack position to `position'.  You should be
     careful about using *note get_position(): 1dc9. and *note
     set_position(): 1dca.

 -- Method: Unpacker.get_buffer ()

     Returns the current unpack data buffer as a string.

 -- Method: Unpacker.done ()

     Indicates unpack completion.  Raises an *note Error: 1dcd.
     exception if all of the data has not been unpacked.

In addition, every data type that can be packed with a *note Packer:
1db6, can be unpacked with an *note Unpacker: 1db7.  Unpacking methods
are of the form ‘unpack_type()’, and take no arguments.  They return the
unpacked object.

 -- Method: Unpacker.unpack_float ()

     Unpacks a single-precision floating point number.

 -- Method: Unpacker.unpack_double ()

     Unpacks a double-precision floating point number, similarly to
     *note unpack_float(): 1dce.

In addition, the following methods unpack strings, bytes, and opaque
data:

 -- Method: Unpacker.unpack_fstring (n)

     Unpacks and returns a fixed length string.  `n' is the number of
     characters expected.  Padding with null bytes to guaranteed 4 byte
     alignment is assumed.

 -- Method: Unpacker.unpack_fopaque (n)

     Unpacks and returns a fixed length opaque data stream, similarly to
     *note unpack_fstring(): 1dd0.

 -- Method: Unpacker.unpack_string ()

     Unpacks and returns a variable length string.  The length of the
     string is first unpacked as an unsigned integer, then the string
     data is unpacked with *note unpack_fstring(): 1dd0.

 -- Method: Unpacker.unpack_opaque ()

     Unpacks and returns a variable length opaque data string, similarly
     to *note unpack_string(): 1dd2.

 -- Method: Unpacker.unpack_bytes ()

     Unpacks and returns a variable length byte stream, similarly to
     *note unpack_string(): 1dd2.

The following methods support unpacking arrays and lists:

 -- Method: Unpacker.unpack_list (unpack_item)

     Unpacks and returns a list of homogeneous items.  The list is
     unpacked one element at a time by first unpacking an unsigned
     integer flag.  If the flag is ‘1’, then the item is unpacked and
     appended to the list.  A flag of ‘0’ indicates the end of the list.
     `unpack_item' is the function that is called to unpack the items.

 -- Method: Unpacker.unpack_farray (n, unpack_item)

     Unpacks and returns (as a list) a fixed length array of homogeneous
     items.  `n' is number of list elements to expect in the buffer.  As
     above, `unpack_item' is the function used to unpack each element.

 -- Method: Unpacker.unpack_array (unpack_item)

     Unpacks and returns a variable length `list' of homogeneous items.
     First, the length of the list is unpacked as an unsigned integer,
     then each element is unpacked as in *note unpack_farray(): 1dd6.
     above.


File: python.info,  Node: Exceptions<6>,  Prev: Unpacker Objects,  Up: xdrlib — Encode and decode XDR data

5.14.4.3 Exceptions
...................

Exceptions in this module are coded as class instances:

 -- Exception: xdrlib.Error

     The base exception class.  *note Error: 1dcd. has a single public
     attribute ‘msg’ containing the description of the error.

 -- Exception: xdrlib.ConversionError

     Class derived from *note Error: 1dcd.  Contains no additional
     instance variables.

Here is an example of how you would catch one of these exceptions:

     import xdrlib
     p = xdrlib.Packer()
     try:
         p.pack_double(8.01)
     except xdrlib.ConversionError as instance:
         print('packing the double failed:', instance.msg)


File: python.info,  Node: plistlib — Generate and parse Mac OS X plist files,  Prev: xdrlib — Encode and decode XDR data,  Up: File Formats

5.14.5 ‘plistlib’ — Generate and parse Mac OS X ‘.plist’ files
--------------------------------------------------------------

`Source code:' Lib/plistlib.py(1)

__________________________________________________________________

This module provides an interface for reading and writing the “property
list” files used mainly by Mac OS X and supports both binary and XML
plist files.

The property list (‘.plist’) file format is a simple serialization
supporting basic object types, like dictionaries, lists, numbers and
strings.  Usually the top level object is a dictionary.

To write out and to parse a plist file, use the *note dump(): 880. and
*note load(): 87f. functions.

To work with plist data in bytes objects, use *note dumps(): 882. and
*note loads(): 881.

Values can be strings, integers, floats, booleans, tuples, lists,
dictionaries (but only with string keys), *note Data: 93b, *note bytes:
326, ‘bytesarray’ or *note datetime.datetime: 194. objects.

Changed in version 3.4: New API, old API deprecated.  Support for binary
format plists added.

Changed in version 3.8: Support added for reading and writing *note UID:
20e. tokens in binary plists as used by NSKeyedArchiver and
NSKeyedUnarchiver.

See also
........

PList manual page(2)

     Apple’s documentation of the file format.

This module defines the following functions:

 -- Function: plistlib.load (fp, *, fmt=None, use_builtin_types=True,
          dict_type=dict)

     Read a plist file.  `fp' should be a readable and binary file
     object.  Return the unpacked root object (which usually is a
     dictionary).

     The `fmt' is the format of the file and the following values are
     valid:

        * *note None: 157.: Autodetect the file format

        * *note FMT_XML: 883.: XML file format

        * *note FMT_BINARY: 884.: Binary plist format

     If `use_builtin_types' is true (the default) binary data will be
     returned as instances of *note bytes: 326, otherwise it is returned
     as instances of *note Data: 93b.

     The `dict_type' is the type used for dictionaries that are read
     from the plist file.

     XML data for the *note FMT_XML: 883. format is parsed using the
     Expat parser from *note xml.parsers.expat: 138. – see its
     documentation for possible exceptions on ill-formed XML. Unknown
     elements will simply be ignored by the plist parser.

     The parser for the binary format raises ‘InvalidFileException’ when
     the file cannot be parsed.

     New in version 3.4.

 -- Function: plistlib.loads (data, *, fmt=None, use_builtin_types=True,
          dict_type=dict)

     Load a plist from a bytes object.  See *note load(): 87f. for an
     explanation of the keyword arguments.

     New in version 3.4.

 -- Function: plistlib.dump (value, fp, *, fmt=FMT_XML, sort_keys=True,
          skipkeys=False)

     Write `value' to a plist file.  `Fp' should be a writable, binary
     file object.

     The `fmt' argument specifies the format of the plist file and can
     be one of the following values:

        * *note FMT_XML: 883.: XML formatted plist file

        * *note FMT_BINARY: 884.: Binary formatted plist file

     When `sort_keys' is true (the default) the keys for dictionaries
     will be written to the plist in sorted order, otherwise they will
     be written in the iteration order of the dictionary.

     When `skipkeys' is false (the default) the function raises *note
     TypeError: 192. when a key of a dictionary is not a string,
     otherwise such keys are skipped.

     A *note TypeError: 192. will be raised if the object is of an
     unsupported type or a container that contains objects of
     unsupported types.

     An *note OverflowError: 954. will be raised for integer values that
     cannot be represented in (binary) plist files.

     New in version 3.4.

 -- Function: plistlib.dumps (value, *, fmt=FMT_XML, sort_keys=True,
          skipkeys=False)

     Return `value' as a plist-formatted bytes object.  See the
     documentation for *note dump(): 880. for an explanation of the
     keyword arguments of this function.

     New in version 3.4.

The following functions are deprecated:

 -- Function: plistlib.readPlist (pathOrFile)

     Read a plist file.  `pathOrFile' may be either a file name or a
     (readable and binary) file object.  Returns the unpacked root
     object (which usually is a dictionary).

     This function calls *note load(): 87f. to do the actual work, see
     the documentation of *note that function: 87f. for an explanation
     of the keyword arguments.

     Deprecated since version 3.4: Use *note load(): 87f. instead.

     Changed in version 3.7: Dict values in the result are now normal
     dicts.  You no longer can use attribute access to access items of
     these dictionaries.

 -- Function: plistlib.writePlist (rootObject, pathOrFile)

     Write `rootObject' to an XML plist file.  `pathOrFile' may be
     either a file name or a (writable and binary) file object

     Deprecated since version 3.4: Use *note dump(): 880. instead.

 -- Function: plistlib.readPlistFromBytes (data)

     Read a plist data from a bytes object.  Return the root object.

     See *note load(): 87f. for a description of the keyword arguments.

     Deprecated since version 3.4: Use *note loads(): 881. instead.

     Changed in version 3.7: Dict values in the result are now normal
     dicts.  You no longer can use attribute access to access items of
     these dictionaries.

 -- Function: plistlib.writePlistToBytes (rootObject)

     Return `rootObject' as an XML plist-formatted bytes object.

     Deprecated since version 3.4: Use *note dumps(): 882. instead.

The following classes are available:

 -- Class: plistlib.Data (data)

     Return a “data” wrapper object around the bytes object `data'.
     This is used in functions converting from/to plists to represent
     the ‘<data>’ type available in plists.

     It has one attribute, ‘data’, that can be used to retrieve the
     Python bytes object stored in it.

     Deprecated since version 3.4: Use a *note bytes: 326. object
     instead.

 -- Class: plistlib.UID (data)

     Wraps an *note int: 184.  This is used when reading or writing
     NSKeyedArchiver encoded data, which contains UID (see PList
     manual).

     It has one attribute, ‘data’, which can be used to retrieve the int
     value of the UID. ‘data’ must be in the range ‘0 <= data < 2**64’.

     New in version 3.8.

The following constants are available:

 -- Data: plistlib.FMT_XML

     The XML format for plist files.

     New in version 3.4.

 -- Data: plistlib.FMT_BINARY

     The binary format for plist files

     New in version 3.4.

* Menu:

* Examples: Examples<8>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/plistlib.py

   (2) 
https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PropertyLists/


File: python.info,  Node: Examples<8>,  Up: plistlib — Generate and parse Mac OS X plist files

5.14.5.1 Examples
.................

Generating a plist:

     pl = dict(
         aString = "Doodah",
         aList = ["A", "B", 12, 32.1, [1, 2, 3]],
         aFloat = 0.1,
         anInt = 728,
         aDict = dict(
             anotherString = "<hello & hi there!>",
             aThirdString = "M\xe4ssig, Ma\xdf",
             aTrueValue = True,
             aFalseValue = False,
         ),
         someData = b"<binary gunk>",
         someMoreData = b"<lots of binary gunk>" * 10,
         aDate = datetime.datetime.fromtimestamp(time.mktime(time.gmtime())),
     )
     with open(fileName, 'wb') as fp:
         dump(pl, fp)

Parsing a plist:

     with open(fileName, 'rb') as fp:
         pl = load(fp)
     print(pl["aKey"])


File: python.info,  Node: Cryptographic Services,  Next: Generic Operating System Services,  Prev: File Formats,  Up: The Python Standard Library

5.15 Cryptographic Services
===========================

The modules described in this chapter implement various algorithms of a
cryptographic nature.  They are available at the discretion of the
installation.  On Unix systems, the *note crypt: 29. module may also be
available.  Here’s an overview:

* Menu:

* hashlib — Secure hashes and message digests::
* hmac — Keyed-Hashing for Message Authentication::
* secrets — Generate secure random numbers for managing secrets::


File: python.info,  Node: hashlib — Secure hashes and message digests,  Next: hmac — Keyed-Hashing for Message Authentication,  Up: Cryptographic Services

5.15.1 ‘hashlib’ — Secure hashes and message digests
----------------------------------------------------

`Source code:' Lib/hashlib.py(1)

__________________________________________________________________

This module implements a common interface to many different secure hash
and message digest algorithms.  Included are the FIPS secure hash
algorithms SHA1, SHA224, SHA256, SHA384, and SHA512 (defined in FIPS
180-2) as well as RSA’s MD5 algorithm (defined in Internet RFC 1321(2)).
The terms “secure hash” and “message digest” are interchangeable.  Older
algorithms were called message digests.  The modern term is secure hash.

     Note: If you want the adler32 or crc32 hash functions, they are
     available in the *note zlib: 144. module.

     Warning: Some algorithms have known hash collision weaknesses,
     refer to the “See also” section at the end.

* Menu:

* Hash algorithms::
* SHAKE variable length digests::
* Key derivation::
* BLAKE2::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/hashlib.py

   (2) https://tools.ietf.org/html/rfc1321.html


File: python.info,  Node: Hash algorithms,  Next: SHAKE variable length digests,  Up: hashlib — Secure hashes and message digests

5.15.1.1 Hash algorithms
........................

There is one constructor method named for each type of `hash'.  All
return a hash object with the same simple interface.  For example: use
‘sha256()’ to create a SHA-256 hash object.  You can now feed this
object with *note bytes-like objects: 5dd. (normally *note bytes: 326.)
using the ‘update()’ method.  At any point you can ask it for the
`digest' of the concatenation of the data fed to it so far using the
‘digest()’ or ‘hexdigest()’ methods.

     Note: For better multithreading performance, the Python *note GIL:
     bdd. is released for data larger than 2047 bytes at object creation
     or on update.

     Note: Feeding string objects into ‘update()’ is not supported, as
     hashes work on bytes, not on characters.

Constructors for hash algorithms that are always present in this module
are ‘sha1()’, ‘sha224()’, ‘sha256()’, ‘sha384()’, ‘sha512()’, *note
blake2b(): 541, and *note blake2s(): 542.  ‘md5()’ is normally available
as well, though it may be missing if you are using a rare “FIPS
compliant” build of Python.  Additional algorithms may also be available
depending upon the OpenSSL library that Python uses on your platform.
On most platforms the ‘sha3_224()’, ‘sha3_256()’, ‘sha3_384()’,
‘sha3_512()’, ‘shake_128()’, ‘shake_256()’ are also available.

New in version 3.6: SHA3 (Keccak) and SHAKE constructors ‘sha3_224()’,
‘sha3_256()’, ‘sha3_384()’, ‘sha3_512()’, ‘shake_128()’, ‘shake_256()’.

New in version 3.6: *note blake2b(): 541. and *note blake2s(): 542. were
added.

For example, to obtain the digest of the byte string ‘b'Nobody inspects
the spammish repetition'’:

     >>> import hashlib
     >>> m = hashlib.sha256()
     >>> m.update(b"Nobody inspects")
     >>> m.update(b" the spammish repetition")
     >>> m.digest()
     b'\x03\x1e\xdd}Ae\x15\x93\xc5\xfe\\\x00o\xa5u+7\xfd\xdf\xf7\xbcN\x84:\xa6\xaf\x0c\x95\x0fK\x94\x06'
     >>> m.digest_size
     32
     >>> m.block_size
     64

More condensed:

     >>> hashlib.sha224(b"Nobody inspects the spammish repetition").hexdigest()
     'a4337bc45a8fc544c03f52dc550cd6e1e87021bc896588bd79e901e2'

 -- Function: hashlib.new (name[, data])

     Is a generic constructor that takes the string `name' of the
     desired algorithm as its first parameter.  It also exists to allow
     access to the above listed hashes as well as any other algorithms
     that your OpenSSL library may offer.  The named constructors are
     much faster than *note new(): 1de5. and should be preferred.

Using *note new(): 1de5. with an algorithm provided by OpenSSL:

     >>> h = hashlib.new('ripemd160')
     >>> h.update(b"Nobody inspects the spammish repetition")
     >>> h.hexdigest()
     'cc4a5ce1b3df48aec5d22d1f16b894a0b894eccc'

Hashlib provides the following constant attributes:

 -- Data: hashlib.algorithms_guaranteed

     A set containing the names of the hash algorithms guaranteed to be
     supported by this module on all platforms.  Note that ‘md5’ is in
     this list despite some upstream vendors offering an odd “FIPS
     compliant” Python build that excludes it.

     New in version 3.2.

 -- Data: hashlib.algorithms_available

     A set containing the names of the hash algorithms that are
     available in the running Python interpreter.  These names will be
     recognized when passed to *note new(): 1de5.  *note
     algorithms_guaranteed: cef. will always be a subset.  The same
     algorithm may appear multiple times in this set under different
     names (thanks to OpenSSL).

     New in version 3.2.

The following values are provided as constant attributes of the hash
objects returned by the constructors:

 -- Data: hash.digest_size

     The size of the resulting hash in bytes.

 -- Data: hash.block_size

     The internal block size of the hash algorithm in bytes.

A hash object has the following attributes:

 -- Attribute: hash.name

     The canonical name of this hash, always lowercase and always
     suitable as a parameter to *note new(): 1de5. to create another
     hash of this type.

     Changed in version 3.4: The name attribute has been present in
     CPython since its inception, but until Python 3.4 was not formally
     specified, so may not exist on some platforms.

A hash object has the following methods:

 -- Method: hash.update (data)

     Update the hash object with the *note bytes-like object: 5dd.
     Repeated calls are equivalent to a single call with the
     concatenation of all the arguments: ‘m.update(a); m.update(b)’ is
     equivalent to ‘m.update(a+b)’.

     Changed in version 3.1: The Python GIL is released to allow other
     threads to run while hash updates on data larger than 2047 bytes is
     taking place when using hash algorithms supplied by OpenSSL.

 -- Method: hash.digest ()

     Return the digest of the data passed to the *note update(): 1de8.
     method so far.  This is a bytes object of size *note digest_size:
     1de6. which may contain bytes in the whole range from 0 to 255.

 -- Method: hash.hexdigest ()

     Like *note digest(): 1de9. except the digest is returned as a
     string object of double length, containing only hexadecimal digits.
     This may be used to exchange the value safely in email or other
     non-binary environments.

 -- Method: hash.copy ()

     Return a copy (“clone”) of the hash object.  This can be used to
     efficiently compute the digests of data sharing a common initial
     substring.


File: python.info,  Node: SHAKE variable length digests,  Next: Key derivation,  Prev: Hash algorithms,  Up: hashlib — Secure hashes and message digests

5.15.1.2 SHAKE variable length digests
......................................

The ‘shake_128()’ and ‘shake_256()’ algorithms provide variable length
digests with length_in_bits//2 up to 128 or 256 bits of security.  As
such, their digest methods require a length.  Maximum length is not
limited by the SHAKE algorithm.

 -- Method: shake.digest (length)

     Return the digest of the data passed to the ‘update()’ method so
     far.  This is a bytes object of size `length' which may contain
     bytes in the whole range from 0 to 255.

 -- Method: shake.hexdigest (length)

     Like *note digest(): f5d. except the digest is returned as a string
     object of double length, containing only hexadecimal digits.  This
     may be used to exchange the value safely in email or other
     non-binary environments.


File: python.info,  Node: Key derivation,  Next: BLAKE2,  Prev: SHAKE variable length digests,  Up: hashlib — Secure hashes and message digests

5.15.1.3 Key derivation
.......................

Key derivation and key stretching algorithms are designed for secure
password hashing.  Naive algorithms such as ‘sha1(password)’ are not
resistant against brute-force attacks.  A good password hashing function
must be tunable, slow, and include a salt(1).

 -- Function: hashlib.pbkdf2_hmac (hash_name, password, salt,
          iterations, dklen=None)

     The function provides PKCS#5 password-based key derivation function
     2.  It uses HMAC as pseudorandom function.

     The string `hash_name' is the desired name of the hash digest
     algorithm for HMAC, e.g.  ‘sha1’ or ‘sha256’.  `password' and
     `salt' are interpreted as buffers of bytes.  Applications and
     libraries should limit `password' to a sensible length (e.g.
     1024).  `salt' should be about 16 or more bytes from a proper
     source, e.g.  *note os.urandom(): 4c6.

     The number of `iterations' should be chosen based on the hash
     algorithm and computing power.  As of 2013, at least 100,000
     iterations of SHA-256 are suggested.

     `dklen' is the length of the derived key.  If `dklen' is ‘None’
     then the digest size of the hash algorithm `hash_name' is used,
     e.g.  64 for SHA-512.

          >>> import hashlib
          >>> dk = hashlib.pbkdf2_hmac('sha256', b'password', b'salt', 100000)
          >>> dk.hex()
          '0394a2ede332c9a13eb82e9b24631604c31df978b4e2f0fbd2c549944f9d79a5'

     New in version 3.4.

          Note: A fast implementation of `pbkdf2_hmac' is available with
          OpenSSL. The Python implementation uses an inline version of
          *note hmac: 8f.  It is about three times slower and doesn’t
          release the GIL.

 -- Function: hashlib.scrypt (password, *, salt, n, r, p, maxmem=0,
          dklen=64)

     The function provides scrypt password-based key derivation function
     as defined in RFC 7914(2).

     `password' and `salt' must be *note bytes-like objects: 5dd.
     Applications and libraries should limit `password' to a sensible
     length (e.g.  1024).  `salt' should be about 16 or more bytes from
     a proper source, e.g.  *note os.urandom(): 4c6.

     `n' is the CPU/Memory cost factor, `r' the block size, `p'
     parallelization factor and `maxmem' limits memory (OpenSSL 1.1.0
     defaults to 32 MiB). `dklen' is the length of the derived key.

     *note Availability: 129a.: OpenSSL 1.1+.

     New in version 3.6.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Salt_%28cryptography%29

   (2) https://tools.ietf.org/html/rfc7914.html


File: python.info,  Node: BLAKE2,  Prev: Key derivation,  Up: hashlib — Secure hashes and message digests

5.15.1.4 BLAKE2
...............

BLAKE2(1) is a cryptographic hash function defined in RFC 7693(2) that
comes in two flavors:

   * `BLAKE2b', optimized for 64-bit platforms and produces digests of
     any size between 1 and 64 bytes,

   * `BLAKE2s', optimized for 8- to 32-bit platforms and produces
     digests of any size between 1 and 32 bytes.

BLAKE2 supports `keyed mode' (a faster and simpler replacement for
HMAC(3)), `salted hashing', `personalization', and `tree hashing'.

Hash objects from this module follow the API of standard library’s *note
hashlib: 8d. objects.

* Menu:

* Creating hash objects::
* Constants: Constants<5>.
* Examples: Examples<9>.
* Credits::

   ---------- Footnotes ----------

   (1) https://blake2.net

   (2) https://tools.ietf.org/html/rfc7693.html

   (3) 
https://en.wikipedia.org/wiki/Hash-based_message_authentication_code


File: python.info,  Node: Creating hash objects,  Next: Constants<5>,  Up: BLAKE2

5.15.1.5 Creating hash objects
..............................

New hash objects are created by calling constructor functions:

 -- Function: hashlib.blake2b (data=b'', *, digest_size=64, key=b'',
          salt=b'', person=b'', fanout=1, depth=1, leaf_size=0,
          node_offset=0, node_depth=0, inner_size=0, last_node=False)

 -- Function: hashlib.blake2s (data=b'', *, digest_size=32, key=b'',
          salt=b'', person=b'', fanout=1, depth=1, leaf_size=0,
          node_offset=0, node_depth=0, inner_size=0, last_node=False)

These functions return the corresponding hash objects for calculating
BLAKE2b or BLAKE2s.  They optionally take these general parameters:

   * `data': initial chunk of data to hash, which must be *note
     bytes-like object: 5dd.  It can be passed only as positional
     argument.

   * `digest_size': size of output digest in bytes.

   * `key': key for keyed hashing (up to 64 bytes for BLAKE2b, up to 32
     bytes for BLAKE2s).

   * `salt': salt for randomized hashing (up to 16 bytes for BLAKE2b, up
     to 8 bytes for BLAKE2s).

   * `person': personalization string (up to 16 bytes for BLAKE2b, up to
     8 bytes for BLAKE2s).

The following table shows limits for general parameters (in bytes):

Hash        digest_size     len(key)     len(salt)     len(person)
                                                       
-----------------------------------------------------------------------
                                                       
BLAKE2b     64              64           16            16
                                                       
                                                       
BLAKE2s     32              32           8             8
                                                       

     Note: BLAKE2 specification defines constant lengths for salt and
     personalization parameters, however, for convenience, this
     implementation accepts byte strings of any size up to the specified
     length.  If the length of the parameter is less than specified, it
     is padded with zeros, thus, for example, ‘b'salt'’ and
     ‘b'salt\x00'’ is the same value.  (This is not the case for `key'.)

These sizes are available as module *note constants: 1df0. described
below.

Constructor functions also accept the following tree hashing parameters:

   * `fanout': fanout (0 to 255, 0 if unlimited, 1 in sequential mode).

   * `depth': maximal depth of tree (1 to 255, 255 if unlimited, 1 in
     sequential mode).

   * `leaf_size': maximal byte length of leaf (0 to 2**32-1, 0 if
     unlimited or in sequential mode).

   * `node_offset': node offset (0 to 2**64-1 for BLAKE2b, 0 to 2**48-1
     for BLAKE2s, 0 for the first, leftmost, leaf, or in sequential
     mode).

   * `node_depth': node depth (0 to 255, 0 for leaves, or in sequential
     mode).

   * `inner_size': inner digest size (0 to 64 for BLAKE2b, 0 to 32 for
     BLAKE2s, 0 in sequential mode).

   * `last_node': boolean indicating whether the processed node is the
     last one (‘False’ for sequential mode).

[Explanation of tree mode parameters.]
Figure

See section 2.10 in BLAKE2 specification(1) for comprehensive review of
tree hashing.

   ---------- Footnotes ----------

   (1) https://blake2.net/blake2_20130129.pdf


File: python.info,  Node: Constants<5>,  Next: Examples<9>,  Prev: Creating hash objects,  Up: BLAKE2

5.15.1.6 Constants
..................

 -- Data: blake2b.SALT_SIZE

 -- Data: blake2s.SALT_SIZE

Salt length (maximum length accepted by constructors).

 -- Data: blake2b.PERSON_SIZE

 -- Data: blake2s.PERSON_SIZE

Personalization string length (maximum length accepted by constructors).

 -- Data: blake2b.MAX_KEY_SIZE

 -- Data: blake2s.MAX_KEY_SIZE

Maximum key size.

 -- Data: blake2b.MAX_DIGEST_SIZE

 -- Data: blake2s.MAX_DIGEST_SIZE

Maximum digest size that the hash function can output.


File: python.info,  Node: Examples<9>,  Next: Credits,  Prev: Constants<5>,  Up: BLAKE2

5.15.1.7 Examples
.................

* Menu:

* Simple hashing::
* Using different digest sizes::
* Keyed hashing::
* Randomized hashing::
* Personalization::
* Tree mode::


File: python.info,  Node: Simple hashing,  Next: Using different digest sizes,  Up: Examples<9>

5.15.1.8 Simple hashing
.......................

To calculate hash of some data, you should first construct a hash object
by calling the appropriate constructor function (*note blake2b(): 541.
or *note blake2s(): 542.), then update it with the data by calling
‘update()’ on the object, and, finally, get the digest out of the object
by calling ‘digest()’ (or ‘hexdigest()’ for hex-encoded string).

     >>> from hashlib import blake2b
     >>> h = blake2b()
     >>> h.update(b'Hello world')
     >>> h.hexdigest()
     '6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'

As a shortcut, you can pass the first chunk of data to update directly
to the constructor as the positional argument:

     >>> from hashlib import blake2b
     >>> blake2b(b'Hello world').hexdigest()
     '6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'

You can call *note hash.update(): 1de8. as many times as you need to
iteratively update the hash:

     >>> from hashlib import blake2b
     >>> items = [b'Hello', b' ', b'world']
     >>> h = blake2b()
     >>> for item in items:
     ...     h.update(item)
     >>> h.hexdigest()
     '6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'


File: python.info,  Node: Using different digest sizes,  Next: Keyed hashing,  Prev: Simple hashing,  Up: Examples<9>

5.15.1.9 Using different digest sizes
.....................................

BLAKE2 has configurable size of digests up to 64 bytes for BLAKE2b and
up to 32 bytes for BLAKE2s.  For example, to replace SHA-1 with BLAKE2b
without changing the size of output, we can tell BLAKE2b to produce
20-byte digests:

     >>> from hashlib import blake2b
     >>> h = blake2b(digest_size=20)
     >>> h.update(b'Replacing SHA1 with the more secure function')
     >>> h.hexdigest()
     'd24f26cf8de66472d58d4e1b1774b4c9158b1f4c'
     >>> h.digest_size
     20
     >>> len(h.digest())
     20

Hash objects with different digest sizes have completely different
outputs (shorter hashes are `not' prefixes of longer hashes); BLAKE2b
and BLAKE2s produce different outputs even if the output length is the
same:

     >>> from hashlib import blake2b, blake2s
     >>> blake2b(digest_size=10).hexdigest()
     '6fa1d8fcfd719046d762'
     >>> blake2b(digest_size=11).hexdigest()
     'eb6ec15daf9546254f0809'
     >>> blake2s(digest_size=10).hexdigest()
     '1bf21a98c78a1c376ae9'
     >>> blake2s(digest_size=11).hexdigest()
     '567004bf96e4a25773ebf4'


File: python.info,  Node: Keyed hashing,  Next: Randomized hashing,  Prev: Using different digest sizes,  Up: Examples<9>

5.15.1.10 Keyed hashing
.......................

Keyed hashing can be used for authentication as a faster and simpler
replacement for Hash-based message authentication code(1) (HMAC). BLAKE2
can be securely used in prefix-MAC mode thanks to the
indifferentiability property inherited from BLAKE.

This example shows how to get a (hex-encoded) 128-bit authentication
code for message ‘b'message data'’ with key ‘b'pseudorandom key'’:

     >>> from hashlib import blake2b
     >>> h = blake2b(key=b'pseudorandom key', digest_size=16)
     >>> h.update(b'message data')
     >>> h.hexdigest()
     '3d363ff7401e02026f4a4687d4863ced'

As a practical example, a web application can symmetrically sign cookies
sent to users and later verify them to make sure they weren’t tampered
with:

     >>> from hashlib import blake2b
     >>> from hmac import compare_digest
     >>>
     >>> SECRET_KEY = b'pseudorandomly generated server secret key'
     >>> AUTH_SIZE = 16
     >>>
     >>> def sign(cookie):
     ...     h = blake2b(digest_size=AUTH_SIZE, key=SECRET_KEY)
     ...     h.update(cookie)
     ...     return h.hexdigest().encode('utf-8')
     >>>
     >>> def verify(cookie, sig):
     ...     good_sig = sign(cookie)
     ...     return compare_digest(good_sig, sig)
     >>>
     >>> cookie = b'user-alice'
     >>> sig = sign(cookie)
     >>> print("{0},{1}".format(cookie.decode('utf-8'), sig))
     user-alice,b'43b3c982cf697e0c5ab22172d1ca7421'
     >>> verify(cookie, sig)
     True
     >>> verify(b'user-bob', sig)
     False
     >>> verify(cookie, b'0102030405060708090a0b0c0d0e0f00')
     False

Even though there’s a native keyed hashing mode, BLAKE2 can, of course,
be used in HMAC construction with *note hmac: 8f. module:

     >>> import hmac, hashlib
     >>> m = hmac.new(b'secret key', digestmod=hashlib.blake2s)
     >>> m.update(b'message')
     >>> m.hexdigest()
     'e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142'

   ---------- Footnotes ----------

   (1) 
https://en.wikipedia.org/wiki/Hash-based_message_authentication_code


File: python.info,  Node: Randomized hashing,  Next: Personalization,  Prev: Keyed hashing,  Up: Examples<9>

5.15.1.11 Randomized hashing
............................

By setting `salt' parameter users can introduce randomization to the
hash function.  Randomized hashing is useful for protecting against
collision attacks on the hash function used in digital signatures.

     Randomized hashing is designed for situations where one party, the
     message preparer, generates all or part of a message to be signed
     by a second party, the message signer.  If the message preparer is
     able to find cryptographic hash function collisions (i.e., two
     messages producing the same hash value), then they might prepare
     meaningful versions of the message that would produce the same hash
     value and digital signature, but with different results (e.g.,
     transferring $1,000,000 to an account, rather than $10).
     Cryptographic hash functions have been designed with collision
     resistance as a major goal, but the current concentration on
     attacking cryptographic hash functions may result in a given
     cryptographic hash function providing less collision resistance
     than expected.  Randomized hashing offers the signer additional
     protection by reducing the likelihood that a preparer can generate
     two or more messages that ultimately yield the same hash value
     during the digital signature generation process — even if it is
     practical to find collisions for the hash function.  However, the
     use of randomized hashing may reduce the amount of security
     provided by a digital signature when all portions of the message
     are prepared by the signer.

     (NIST SP-800-106 "Randomized Hashing for Digital Signatures"(1))

In BLAKE2 the salt is processed as a one-time input to the hash function
during initialization, rather than as an input to each compression
function.

     Warning: `Salted hashing' (or just hashing) with BLAKE2 or any
     other general-purpose cryptographic hash function, such as SHA-256,
     is not suitable for hashing passwords.  See BLAKE2 FAQ(2) for more
     information.

     >>> import os
     >>> from hashlib import blake2b
     >>> msg = b'some message'
     >>> # Calculate the first hash with a random salt.
     >>> salt1 = os.urandom(blake2b.SALT_SIZE)
     >>> h1 = blake2b(salt=salt1)
     >>> h1.update(msg)
     >>> # Calculate the second hash with a different random salt.
     >>> salt2 = os.urandom(blake2b.SALT_SIZE)
     >>> h2 = blake2b(salt=salt2)
     >>> h2.update(msg)
     >>> # The digests are different.
     >>> h1.digest() != h2.digest()
     True

   ---------- Footnotes ----------

   (1) https://csrc.nist.gov/publications/detail/sp/800-106/final

   (2) https://blake2.net/#qa


File: python.info,  Node: Personalization,  Next: Tree mode,  Prev: Randomized hashing,  Up: Examples<9>

5.15.1.12 Personalization
.........................

Sometimes it is useful to force hash function to produce different
digests for the same input for different purposes.  Quoting the authors
of the Skein hash function:

     We recommend that all application designers seriously consider
     doing this; we have seen many protocols where a hash that is
     computed in one part of the protocol can be used in an entirely
     different part because two hash computations were done on similar
     or related data, and the attacker can force the application to make
     the hash inputs the same.  Personalizing each hash function used in
     the protocol summarily stops this type of attack.

     (The Skein Hash Function Family(1), p.  21)

BLAKE2 can be personalized by passing bytes to the `person' argument:

     >>> from hashlib import blake2b
     >>> FILES_HASH_PERSON = b'MyApp Files Hash'
     >>> BLOCK_HASH_PERSON = b'MyApp Block Hash'
     >>> h = blake2b(digest_size=32, person=FILES_HASH_PERSON)
     >>> h.update(b'the same content')
     >>> h.hexdigest()
     '20d9cd024d4fb086aae819a1432dd2466de12947831b75c5a30cf2676095d3b4'
     >>> h = blake2b(digest_size=32, person=BLOCK_HASH_PERSON)
     >>> h.update(b'the same content')
     >>> h.hexdigest()
     'cf68fb5761b9c44e7878bfb2c4c9aea52264a80b75005e65619778de59f383a3'

Personalization together with the keyed mode can also be used to derive
different keys from a single one.

     >>> from hashlib import blake2s
     >>> from base64 import b64decode, b64encode
     >>> orig_key = b64decode(b'Rm5EPJai72qcK3RGBpW3vPNfZy5OZothY+kHY6h21KM=')
     >>> enc_key = blake2s(key=orig_key, person=b'kEncrypt').digest()
     >>> mac_key = blake2s(key=orig_key, person=b'kMAC').digest()
     >>> print(b64encode(enc_key).decode('utf-8'))
     rbPb15S/Z9t+agffno5wuhB77VbRi6F9Iv2qIxU7WHw=
     >>> print(b64encode(mac_key).decode('utf-8'))
     G9GtHFE1YluXY1zWPlYk1e/nWfu0WSEb0KRcjhDeP/o=

   ---------- Footnotes ----------

   (1) http://www.skein-hash.info/sites/default/files/skein1.3.pdf


File: python.info,  Node: Tree mode,  Prev: Personalization,  Up: Examples<9>

5.15.1.13 Tree mode
...................

Here’s an example of hashing a minimal tree with two leaf nodes:

       10
      /  \
     00  01

This example uses 64-byte internal digests, and returns the 32-byte
final digest:

     >>> from hashlib import blake2b
     >>>
     >>> FANOUT = 2
     >>> DEPTH = 2
     >>> LEAF_SIZE = 4096
     >>> INNER_SIZE = 64
     >>>
     >>> buf = bytearray(6000)
     >>>
     >>> # Left leaf
     ... h00 = blake2b(buf[0:LEAF_SIZE], fanout=FANOUT, depth=DEPTH,
     ...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
     ...               node_offset=0, node_depth=0, last_node=False)
     >>> # Right leaf
     ... h01 = blake2b(buf[LEAF_SIZE:], fanout=FANOUT, depth=DEPTH,
     ...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
     ...               node_offset=1, node_depth=0, last_node=True)
     >>> # Root node
     ... h10 = blake2b(digest_size=32, fanout=FANOUT, depth=DEPTH,
     ...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
     ...               node_offset=0, node_depth=1, last_node=True)
     >>> h10.update(h00.digest())
     >>> h10.update(h01.digest())
     >>> h10.hexdigest()
     '3ad2a9b37c6070e374c7a8c508fe20ca86b6ed54e286e93a0318e95e881db5aa'


File: python.info,  Node: Credits,  Prev: Examples<9>,  Up: BLAKE2

5.15.1.14 Credits
.................

BLAKE2(1) was designed by `Jean-Philippe Aumasson', `Samuel Neves',
`Zooko Wilcox-O’Hearn', and `Christian Winnerlein' based on SHA-3(2)
finalist BLAKE(3) created by `Jean-Philippe Aumasson', `Luca Henzen',
`Willi Meier', and `Raphael C.-W. Phan'.

It uses core algorithm from ChaCha(4) cipher designed by `Daniel J.
Bernstein'.

The stdlib implementation is based on pyblake2(5) module.  It was
written by `Dmitry Chestnykh' based on C implementation written by
`Samuel Neves'.  The documentation was copied from pyblake2(6) and
written by `Dmitry Chestnykh'.

The C code was partly rewritten for Python by `Christian Heimes'.

The following public domain dedication applies for both C hash function
implementation, extension code, and this documentation:

     To the extent possible under law, the author(s) have dedicated all
     copyright and related and neighboring rights to this software to
     the public domain worldwide.  This software is distributed without
     any warranty.

     You should have received a copy of the CC0 Public Domain Dedication
     along with this software.  If not, see
     ‘https://creativecommons.org/publicdomain/zero/1.0/’.

The following people have helped with development or contributed their
changes to the project and the public domain according to the Creative
Commons Public Domain Dedication 1.0 Universal:

   * `Alexandr Sokolovskiy'

See also
........

Module *note hmac: 8f.

     A module to generate message authentication codes using hashes.

Module *note base64: e.

     Another way to encode binary hashes for non-binary environments.

‘https://blake2.net’

     Official BLAKE2 website.

‘https://csrc.nist.gov/csrc/media/publications/fips/180/2/archive/2002-08-01/documents/fips180-2.pdf’

     The FIPS 180-2 publication on Secure Hash Algorithms.

‘https://en.wikipedia.org/wiki/Cryptographic_hash_function#Cryptographic_hash_algorithms’

     Wikipedia article with information on which algorithms have known
     issues and what that means regarding their use.

‘https://www.ietf.org/rfc/rfc2898.txt’

     PKCS #5: Password-Based Cryptography Specification Version 2.0

   ---------- Footnotes ----------

   (1) https://blake2.net

   (2) https://en.wikipedia.org/wiki/NIST_hash_function_competition

   (3) https://131002.net/blake/

   (4) https://cr.yp.to/chacha.html

   (5) https://pythonhosted.org/pyblake2/

   (6) https://pythonhosted.org/pyblake2/


File: python.info,  Node: hmac — Keyed-Hashing for Message Authentication,  Next: secrets — Generate secure random numbers for managing secrets,  Prev: hashlib — Secure hashes and message digests,  Up: Cryptographic Services

5.15.2 ‘hmac’ — Keyed-Hashing for Message Authentication
--------------------------------------------------------

`Source code:' Lib/hmac.py(1)

__________________________________________________________________

This module implements the HMAC algorithm as described by RFC 2104(2).

 -- Function: hmac.new (key, msg=None, digestmod='')

     Return a new hmac object.  `key' is a bytes or bytearray object
     giving the secret key.  If `msg' is present, the method call
     ‘update(msg)’ is made.  `digestmod' is the digest name, digest
     constructor or module for the HMAC object to use.  It may be any
     name suitable to *note hashlib.new(): 1de5.  Despite its argument
     position, it is required.

     Changed in version 3.4: Parameter `key' can be a bytes or bytearray
     object.  Parameter `msg' can be of any type supported by *note
     hashlib: 8d.  Parameter `digestmod' can be the name of a hash
     algorithm.

     Deprecated since version 3.4, will be removed in version 3.8: MD5
     as implicit default digest for `digestmod' is deprecated.  The
     digestmod parameter is now required.  Pass it as a keyword argument
     to avoid awkwardness when you do not have an initial msg.

 -- Function: hmac.digest (key, msg, digest)

     Return digest of `msg' for given secret `key' and `digest'.  The
     function is equivalent to ‘HMAC(key, msg, digest).digest()’, but
     uses an optimized C or inline implementation, which is faster for
     messages that fit into memory.  The parameters `key', `msg', and
     `digest' have the same meaning as in *note new(): 848.

     CPython implementation detail, the optimized C implementation is
     only used when `digest' is a string and name of a digest algorithm,
     which is supported by OpenSSL.

     New in version 3.7.

An HMAC object has the following methods:

 -- Method: HMAC.update (msg)

     Update the hmac object with `msg'.  Repeated calls are equivalent
     to a single call with the concatenation of all the arguments:
     ‘m.update(a); m.update(b)’ is equivalent to ‘m.update(a + b)’.

     Changed in version 3.4: Parameter `msg' can be of any type
     supported by *note hashlib: 8d.

 -- Method: HMAC.digest ()

     Return the digest of the bytes passed to the *note update(): 849.
     method so far.  This bytes object will be the same length as the
     `digest_size' of the digest given to the constructor.  It may
     contain non-ASCII bytes, including NUL bytes.

          Warning: When comparing the output of *note digest(): 385. to
          an externally-supplied digest during a verification routine,
          it is recommended to use the *note compare_digest(): a01.
          function instead of the ‘==’ operator to reduce the
          vulnerability to timing attacks.

 -- Method: HMAC.hexdigest ()

     Like *note digest(): 385. except the digest is returned as a string
     twice the length containing only hexadecimal digits.  This may be
     used to exchange the value safely in email or other non-binary
     environments.

          Warning: When comparing the output of *note hexdigest(): 1e04.
          to an externally-supplied digest during a verification
          routine, it is recommended to use the *note compare_digest():
          a01. function instead of the ‘==’ operator to reduce the
          vulnerability to timing attacks.

 -- Method: HMAC.copy ()

     Return a copy (“clone”) of the hmac object.  This can be used to
     efficiently compute the digests of strings that share a common
     initial substring.

A hash object has the following attributes:

 -- Attribute: HMAC.digest_size

     The size of the resulting HMAC digest in bytes.

 -- Attribute: HMAC.block_size

     The internal block size of the hash algorithm in bytes.

     New in version 3.4.

 -- Attribute: HMAC.name

     The canonical name of this HMAC, always lowercase, e.g.
     ‘hmac-md5’.

     New in version 3.4.

This module also provides the following helper function:

 -- Function: hmac.compare_digest (a, b)

     Return ‘a == b’.  This function uses an approach designed to
     prevent timing analysis by avoiding content-based short circuiting
     behaviour, making it appropriate for cryptography.  `a' and `b'
     must both be of the same type: either *note str: 325. (ASCII only,
     as e.g.  returned by *note HMAC.hexdigest(): 1e04.), or a *note
     bytes-like object: 5dd.

          Note: If `a' and `b' are of different lengths, or if an error
          occurs, a timing attack could theoretically reveal information
          about the types and lengths of `a' and `b'—but not their
          values.

     New in version 3.3.

See also
........

Module *note hashlib: 8d.

     The Python module providing secure hash functions.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/hmac.py

   (2) https://tools.ietf.org/html/rfc2104.html


File: python.info,  Node: secrets — Generate secure random numbers for managing secrets,  Prev: hmac — Keyed-Hashing for Message Authentication,  Up: Cryptographic Services

5.15.3 ‘secrets’ — Generate secure random numbers for managing secrets
----------------------------------------------------------------------

New in version 3.6.

`Source code:' Lib/secrets.py(1)

__________________________________________________________________

The *note secrets: e4. module is used for generating cryptographically
strong random numbers suitable for managing data such as passwords,
account authentication, security tokens, and related secrets.

In particularly, *note secrets: e4. should be used in preference to the
default pseudo-random number generator in the *note random: dc. module,
which is designed for modelling and simulation, not security or
cryptography.

See also
........

PEP 506(2)

* Menu:

* Random numbers::
* Generating tokens::
* Other functions::
* Recipes and best practices::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/secrets.py

   (2) https://www.python.org/dev/peps/pep-0506


File: python.info,  Node: Random numbers,  Next: Generating tokens,  Up: secrets — Generate secure random numbers for managing secrets

5.15.3.1 Random numbers
.......................

The *note secrets: e4. module provides access to the most secure source
of randomness that your operating system provides.

 -- Class: secrets.SystemRandom

     A class for generating random numbers using the highest-quality
     sources provided by the operating system.  See *note
     random.SystemRandom: 1a3d. for additional details.

 -- Function: secrets.choice (sequence)

     Return a randomly-chosen element from a non-empty sequence.

 -- Function: secrets.randbelow (n)

     Return a random int in the range [0, `n').

 -- Function: secrets.randbits (k)

     Return an int with `k' random bits.


File: python.info,  Node: Generating tokens,  Next: Other functions,  Prev: Random numbers,  Up: secrets — Generate secure random numbers for managing secrets

5.15.3.2 Generating tokens
..........................

The *note secrets: e4. module provides functions for generating secure
tokens, suitable for applications such as password resets, hard-to-guess
URLs, and similar.

 -- Function: secrets.token_bytes ([nbytes=None])

     Return a random byte string containing `nbytes' number of bytes.
     If `nbytes' is ‘None’ or not supplied, a reasonable default is
     used.

          >>> token_bytes(16)
          b'\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b'

 -- Function: secrets.token_hex ([nbytes=None])

     Return a random text string, in hexadecimal.  The string has
     `nbytes' random bytes, each byte converted to two hex digits.  If
     `nbytes' is ‘None’ or not supplied, a reasonable default is used.

          >>> token_hex(16)
          'f9bf78b9a18ce6d46a0cd2b0b86df9da'

 -- Function: secrets.token_urlsafe ([nbytes=None])

     Return a random URL-safe text string, containing `nbytes' random
     bytes.  The text is Base64 encoded, so on average each byte results
     in approximately 1.3 characters.  If `nbytes' is ‘None’ or not
     supplied, a reasonable default is used.

          >>> token_urlsafe(16)
          'Drmhze6EPcv0fN_81Bj-nA'

* Menu:

* How many bytes should tokens use?::


File: python.info,  Node: How many bytes should tokens use?,  Up: Generating tokens

5.15.3.3 How many bytes should tokens use?
..........................................

To be secure against brute-force attacks(1), tokens need to have
sufficient randomness.  Unfortunately, what is considered sufficient
will necessarily increase as computers get more powerful and able to
make more guesses in a shorter period.  As of 2015, it is believed that
32 bytes (256 bits) of randomness is sufficient for the typical use-case
expected for the *note secrets: e4. module.

For those who want to manage their own token length, you can explicitly
specify how much randomness is used for tokens by giving an *note int:
184. argument to the various ‘token_*’ functions.  That argument is
taken as the number of bytes of randomness to use.

Otherwise, if no argument is provided, or if the argument is ‘None’, the
‘token_*’ functions will use a reasonable default instead.

     Note: That default is subject to change at any time, including
     during maintenance releases.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Brute-force_attack


File: python.info,  Node: Other functions,  Next: Recipes and best practices,  Prev: Generating tokens,  Up: secrets — Generate secure random numbers for managing secrets

5.15.3.4 Other functions
........................

 -- Function: secrets.compare_digest (a, b)

     Return ‘True’ if strings `a' and `b' are equal, otherwise ‘False’,
     in such a way as to reduce the risk of timing attacks(1).  See
     *note hmac.compare_digest(): a01. for additional details.

   ---------- Footnotes ----------

   (1) https://codahale.com/a-lesson-in-timing-attacks/


File: python.info,  Node: Recipes and best practices,  Prev: Other functions,  Up: secrets — Generate secure random numbers for managing secrets

5.15.3.5 Recipes and best practices
...................................

This section shows recipes and best practices for using *note secrets:
e4. to manage a basic level of security.

Generate an eight-character alphanumeric password:

     import string
     import secrets
     alphabet = string.ascii_letters + string.digits
     password = ''.join(secrets.choice(alphabet) for i in range(8))

     Note: Applications should not store passwords in a recoverable
     format(1), whether plain text or encrypted.  They should be salted
     and hashed using a cryptographically-strong one-way (irreversible)
     hash function.

Generate a ten-character alphanumeric password with at least one
lowercase character, at least one uppercase character, and at least
three digits:

     import string
     import secrets
     alphabet = string.ascii_letters + string.digits
     while True:
         password = ''.join(secrets.choice(alphabet) for i in range(10))
         if (any(c.islower() for c in password)
                 and any(c.isupper() for c in password)
                 and sum(c.isdigit() for c in password) >= 3):
             break

Generate an XKCD-style passphrase(2):

     import secrets
     # On standard Linux systems, use a convenient dictionary file.
     # Other platforms may need to provide their own word-list.
     with open('/usr/share/dict/words') as f:
         words = [word.strip() for word in f]
         password = ' '.join(secrets.choice(words) for i in range(4))

Generate a hard-to-guess temporary URL containing a security token
suitable for password recovery applications:

     import secrets
     url = 'https://mydomain.com/reset=' + secrets.token_urlsafe()

   ---------- Footnotes ----------

   (1) http://cwe.mitre.org/data/definitions/257.html

   (2) https://xkcd.com/936/


File: python.info,  Node: Generic Operating System Services,  Next: Concurrent Execution,  Prev: Cryptographic Services,  Up: The Python Standard Library

5.16 Generic Operating System Services
======================================

The modules described in this chapter provide interfaces to operating
system features that are available on (almost) all operating systems,
such as files and a clock.  The interfaces are generally modeled after
the Unix or C interfaces, but they are available on most other systems
as well.  Here’s an overview:

* Menu:

* os — Miscellaneous operating system interfaces::
* io — Core tools for working with streams::
* time — Time access and conversions::
* argparse — Parser for command-line options, arguments and sub-commands: argparse — Parser for command-line options arguments and sub-commands.
* getopt — C-style parser for command line options::
* logging — Logging facility for Python::
* logging.config — Logging configuration: logging config — Logging configuration.
* logging.handlers — Logging handlers: logging handlers — Logging handlers.
* getpass — Portable password input::
* curses — Terminal handling for character-cell displays::
* curses.textpad — Text input widget for curses programs: curses textpad — Text input widget for curses programs.
* curses.ascii — Utilities for ASCII characters: curses ascii — Utilities for ASCII characters.
* curses.panel — A panel stack extension for curses: curses panel — A panel stack extension for curses.
* platform — Access to underlying platform’s identifying data::
* errno — Standard errno system symbols::
* ctypes — A foreign function library for Python::


File: python.info,  Node: os — Miscellaneous operating system interfaces,  Next: io — Core tools for working with streams,  Up: Generic Operating System Services

5.16.1 ‘os’ — Miscellaneous operating system interfaces
-------------------------------------------------------

`Source code:' Lib/os.py(1)

__________________________________________________________________

This module provides a portable way of using operating system dependent
functionality.  If you just want to read or write a file see *note
open(): 4e5, if you want to manipulate paths, see the *note os.path: c5.
module, and if you want to read all the lines in all the files on the
command line see the *note fileinput: 80. module.  For creating
temporary files and directories see the *note tempfile: 103. module, and
for high-level file and directory handling see the *note shutil: e9.
module.

Notes on the availability of these functions:

   * The design of all built-in operating system dependent modules of
     Python is such that as long as the same functionality is available,
     it uses the same interface; for example, the function
     ‘os.stat(path)’ returns stat information about `path' in the same
     format (which happens to have originated with the POSIX interface).

   * Extensions peculiar to a particular operating system are also
     available through the *note os: c4. module, but using them is of
     course a threat to portability.

   * All functions accepting path or file names accept both bytes and
     string objects, and result in an object of the same type, if a path
     or file name is returned.

   * On VxWorks, os.fork, os.execv and os.spawn*p* are not supported.

     Note: All functions in this module raise *note OSError: 1d1. (or
     subclasses thereof) in the case of invalid or inaccessible file
     names and paths, or other arguments that have the correct type, but
     are not accepted by the operating system.

 -- Exception: os.error

     An alias for the built-in *note OSError: 1d1. exception.

 -- Data: os.name

     The name of the operating system dependent module imported.  The
     following names have currently been registered: ‘'posix'’, ‘'nt'’,
     ‘'java'’.

     See also
     ........

     *note sys.platform: 2af. has a finer granularity.  *note
     os.uname(): a52. gives system-dependent version information.

     The *note platform: ce. module provides detailed checks for the
     system’s identity.

* Menu:

* File Names, Command Line Arguments, and Environment Variables: File Names Command Line Arguments and Environment Variables.
* Process Parameters::
* File Object Creation::
* File Descriptor Operations::
* Files and Directories::
* Process Management::
* Interface to the scheduler::
* Miscellaneous System Information::
* Random numbers: Random numbers<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/os.py


File: python.info,  Node: File Names Command Line Arguments and Environment Variables,  Next: Process Parameters,  Up: os — Miscellaneous operating system interfaces

5.16.1.1 File Names, Command Line Arguments, and Environment Variables
......................................................................

In Python, file names, command line arguments, and environment variables
are represented using the string type.  On some systems, decoding these
strings to and from bytes is necessary before passing them to the
operating system.  Python uses the file system encoding to perform this
conversion (see *note sys.getfilesystemencoding(): 4eb.).

Changed in version 3.1: On some systems, conversion using the file
system encoding may fail.  In this case, Python uses the *note
surrogateescape encoding error handler: 1780, which means that
undecodable bytes are replaced by a Unicode character U+DCxx on
decoding, and these are again translated to the original byte on
encoding.

The file system encoding must guarantee to successfully decode all bytes
below 128.  If the file system encoding fails to provide this guarantee,
API functions may raise UnicodeErrors.


File: python.info,  Node: Process Parameters,  Next: File Object Creation,  Prev: File Names Command Line Arguments and Environment Variables,  Up: os — Miscellaneous operating system interfaces

5.16.1.2 Process Parameters
...........................

These functions and data items provide information and operate on the
current process and user.

 -- Function: os.ctermid ()

     Return the filename corresponding to the controlling terminal of
     the process.

     *note Availability: 129a.: Unix.

 -- Data: os.environ

     A *note mapping: b2c. object representing the string environment.
     For example, ‘environ['HOME']’ is the pathname of your home
     directory (on some platforms), and is equivalent to
     ‘getenv("HOME")’ in C.

     This mapping is captured the first time the *note os: c4. module is
     imported, typically during Python startup as part of processing
     ‘site.py’.  Changes to the environment made after this time are not
     reflected in ‘os.environ’, except for changes made by modifying
     ‘os.environ’ directly.

     If the platform supports the *note putenv(): 1e21. function, this
     mapping may be used to modify the environment as well as query the
     environment.  *note putenv(): 1e21. will be called automatically
     when the mapping is modified.

     On Unix, keys and values use *note sys.getfilesystemencoding():
     4eb. and ‘'surrogateescape'’ error handler.  Use *note environb:
     b87. if you would like to use a different encoding.

          Note: Calling *note putenv(): 1e21. directly does not change
          ‘os.environ’, so it’s better to modify ‘os.environ’.

          Note: On some platforms, including FreeBSD and Mac OS X,
          setting ‘environ’ may cause memory leaks.  Refer to the system
          documentation for ‘putenv()’.

     If *note putenv(): 1e21. is not provided, a modified copy of this
     mapping may be passed to the appropriate process-creation functions
     to cause child processes to use a modified environment.

     If the platform supports the *note unsetenv(): d36. function, you
     can delete items in this mapping to unset environment variables.
     *note unsetenv(): d36. will be called automatically when an item is
     deleted from ‘os.environ’, and when one of the ‘pop()’ or ‘clear()’
     methods is called.

 -- Data: os.environb

     Bytes version of *note environ: b2a.: a *note mapping: b2c. object
     representing the environment as byte strings.  *note environ: b2a.
     and *note environb: b87. are synchronized (modify *note environb:
     b87. updates *note environ: b2a, and vice versa).

     *note environb: b87. is only available if *note
     supports_bytes_environ: b85. is ‘True’.

     New in version 3.2.

 -- Function: os.chdir (path)

 -- Function: os.fchdir (fd)

 -- Function: os.getcwd ()

     These functions are described in *note Files and Directories: 1e22.

 -- Function: os.fsencode (filename)

     Encode *note path-like: 35f. `filename' to the filesystem encoding
     with ‘'surrogateescape'’ error handler, or ‘'strict'’ on Windows;
     return *note bytes: 326. unchanged.

     *note fsdecode(): 4e3. is the reverse function.

     New in version 3.2.

     Changed in version 3.6: Support added to accept objects
     implementing the *note os.PathLike: 4e0. interface.

 -- Function: os.fsdecode (filename)

     Decode the *note path-like: 35f. `filename' from the filesystem
     encoding with ‘'surrogateescape'’ error handler, or ‘'strict'’ on
     Windows; return *note str: 325. unchanged.

     *note fsencode(): 4e4. is the reverse function.

     New in version 3.2.

     Changed in version 3.6: Support added to accept objects
     implementing the *note os.PathLike: 4e0. interface.

 -- Function: os.fspath (path)

     Return the file system representation of the path.

     If *note str: 325. or *note bytes: 326. is passed in, it is
     returned unchanged.  Otherwise *note __fspath__(): 4e1. is called
     and its value is returned as long as it is a *note str: 325. or
     *note bytes: 326. object.  In all other cases, *note TypeError:
     192. is raised.

     New in version 3.6.

 -- Class: os.PathLike

     An *note abstract base class: b26. for objects representing a file
     system path, e.g.  *note pathlib.PurePath: f79.

     New in version 3.6.

      -- Method: abstractmethod __fspath__ ()

          Return the file system path representation of the object.

          The method should only return a *note str: 325. or *note
          bytes: 326. object, with the preference being for *note str:
          325.

 -- Function: os.getenv (key, default=None)

     Return the value of the environment variable `key' if it exists, or
     `default' if it doesn’t.  `key', `default' and the result are str.

     On Unix, keys and values are decoded with *note
     sys.getfilesystemencoding(): 4eb. and ‘'surrogateescape'’ error
     handler.  Use *note os.getenvb(): b86. if you would like to use a
     different encoding.

     *note Availability: 129a.: most flavors of Unix, Windows.

 -- Function: os.getenvb (key, default=None)

     Return the value of the environment variable `key' if it exists, or
     `default' if it doesn’t.  `key', `default' and the result are
     bytes.

     *note getenvb(): b86. is only available if *note
     supports_bytes_environ: b85. is ‘True’.

     *note Availability: 129a.: most flavors of Unix.

     New in version 3.2.

 -- Function: os.get_exec_path (env=None)

     Returns the list of directories that will be searched for a named
     executable, similar to a shell, when launching a process.  `env',
     when specified, should be an environment variable dictionary to
     lookup the PATH in.  By default, when `env' is ‘None’, *note
     environ: b2a. is used.

     New in version 3.2.

 -- Function: os.getegid ()

     Return the effective group id of the current process.  This
     corresponds to the “set id” bit on the file being executed in the
     current process.

     *note Availability: 129a.: Unix.

 -- Function: os.geteuid ()

     Return the current process’s effective user id.

     *note Availability: 129a.: Unix.

 -- Function: os.getgid ()

     Return the real group id of the current process.

     *note Availability: 129a.: Unix.

 -- Function: os.getgrouplist (user, group)

     Return list of group ids that `user' belongs to.  If `group' is not
     in the list, it is included; typically, `group' is specified as the
     group ID field from the password record for `user'.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.getgroups ()

     Return list of supplemental group ids associated with the current
     process.

     *note Availability: 129a.: Unix.

          Note: On Mac OS X, *note getgroups(): 1e28. behavior differs
          somewhat from other Unix platforms.  If the Python interpreter
          was built with a deployment target of ‘10.5’ or earlier, *note
          getgroups(): 1e28. returns the list of effective group ids
          associated with the current user process; this list is limited
          to a system-defined number of entries, typically 16, and may
          be modified by calls to *note setgroups(): 1e29. if suitably
          privileged.  If built with a deployment target greater than
          ‘10.5’, *note getgroups(): 1e28. returns the current group
          access list for the user associated with the effective user id
          of the process; the group access list may change over the
          lifetime of the process, it is not affected by calls to *note
          setgroups(): 1e29, and its length is not limited to 16.  The
          deployment target value, ‘MACOSX_DEPLOYMENT_TARGET’, can be
          obtained with *note sysconfig.get_config_var(): 958.

 -- Function: os.getlogin ()

     Return the name of the user logged in on the controlling terminal
     of the process.  For most purposes, it is more useful to use *note
     getpass.getuser(): 1e2b. since the latter checks the environment
     variables ‘LOGNAME’ or ‘USERNAME’ to find out who the user is, and
     falls back to ‘pwd.getpwuid(os.getuid())[0]’ to get the login name
     of the current real user id.

     *note Availability: 129a.: Unix, Windows.

 -- Function: os.getpgid (pid)

     Return the process group id of the process with process id `pid'.
     If `pid' is 0, the process group id of the current process is
     returned.

     *note Availability: 129a.: Unix.

 -- Function: os.getpgrp ()

     Return the id of the current process group.

     *note Availability: 129a.: Unix.

 -- Function: os.getpid ()

     Return the current process id.

 -- Function: os.getppid ()

     Return the parent’s process id.  When the parent process has
     exited, on Unix the id returned is the one of the init process (1),
     on Windows it is still the same id, which may be already reused by
     another process.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.2: Added support for Windows.

 -- Function: os.getpriority (which, who)

     Get program scheduling priority.  The value `which' is one of *note
     PRIO_PROCESS: 1e30, *note PRIO_PGRP: 1e31, or *note PRIO_USER:
     1e32, and `who' is interpreted relative to `which' (a process
     identifier for *note PRIO_PROCESS: 1e30, process group identifier
     for *note PRIO_PGRP: 1e31, and a user ID for *note PRIO_USER:
     1e32.).  A zero value for `who' denotes (respectively) the calling
     process, the process group of the calling process, or the real user
     ID of the calling process.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: os.PRIO_PROCESS
 -- Data: os.PRIO_PGRP
 -- Data: os.PRIO_USER

     Parameters for the *note getpriority(): a3b. and *note
     setpriority(): a3c. functions.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.getresuid ()

     Return a tuple (ruid, euid, suid) denoting the current process’s
     real, effective, and saved user ids.

     *note Availability: 129a.: Unix.

     New in version 3.2.

 -- Function: os.getresgid ()

     Return a tuple (rgid, egid, sgid) denoting the current process’s
     real, effective, and saved group ids.

     *note Availability: 129a.: Unix.

     New in version 3.2.

 -- Function: os.getuid ()

     Return the current process’s real user id.

     *note Availability: 129a.: Unix.

 -- Function: os.initgroups (username, gid)

     Call the system initgroups() to initialize the group access list
     with all of the groups of which the specified username is a member,
     plus the specified group id.

     *note Availability: 129a.: Unix.

     New in version 3.2.

 -- Function: os.putenv (key, value)

     Set the environment variable named `key' to the string `value'.
     Such changes to the environment affect subprocesses started with
     *note os.system(): db4, *note popen(): 2a7. or *note fork(): 955.
     and *note execv(): 1e34.

     *note Availability: 129a.: most flavors of Unix, Windows.

          Note: On some platforms, including FreeBSD and Mac OS X,
          setting ‘environ’ may cause memory leaks.  Refer to the system
          documentation for putenv.

     When *note putenv(): 1e21. is supported, assignments to items in
     ‘os.environ’ are automatically translated into corresponding calls
     to *note putenv(): 1e21.; however, calls to *note putenv(): 1e21.
     don’t update ‘os.environ’, so it is actually preferable to assign
     to items of ‘os.environ’.

 -- Function: os.setegid (egid)

     Set the current process’s effective group id.

     *note Availability: 129a.: Unix.

 -- Function: os.seteuid (euid)

     Set the current process’s effective user id.

     *note Availability: 129a.: Unix.

 -- Function: os.setgid (gid)

     Set the current process’ group id.

     *note Availability: 129a.: Unix.

 -- Function: os.setgroups (groups)

     Set the list of supplemental group ids associated with the current
     process to `groups'.  `groups' must be a sequence, and each element
     must be an integer identifying a group.  This operation is
     typically available only to the superuser.

     *note Availability: 129a.: Unix.

          Note: On Mac OS X, the length of `groups' may not exceed the
          system-defined maximum number of effective group ids,
          typically 16.  See the documentation for *note getgroups():
          1e28. for cases where it may not return the same group list
          set by calling setgroups().

 -- Function: os.setpgrp ()

     Call the system call ‘setpgrp()’ or ‘setpgrp(0, 0)’ depending on
     which version is implemented (if any).  See the Unix manual for the
     semantics.

     *note Availability: 129a.: Unix.

 -- Function: os.setpgid (pid, pgrp)

     Call the system call ‘setpgid()’ to set the process group id of the
     process with id `pid' to the process group with id `pgrp'.  See the
     Unix manual for the semantics.

     *note Availability: 129a.: Unix.

 -- Function: os.setpriority (which, who, priority)

     Set program scheduling priority.  The value `which' is one of *note
     PRIO_PROCESS: 1e30, *note PRIO_PGRP: 1e31, or *note PRIO_USER:
     1e32, and `who' is interpreted relative to `which' (a process
     identifier for *note PRIO_PROCESS: 1e30, process group identifier
     for *note PRIO_PGRP: 1e31, and a user ID for *note PRIO_USER:
     1e32.).  A zero value for `who' denotes (respectively) the calling
     process, the process group of the calling process, or the real user
     ID of the calling process.  `priority' is a value in the range -20
     to 19.  The default priority is 0; lower priorities cause more
     favorable scheduling.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.setregid (rgid, egid)

     Set the current process’s real and effective group ids.

     *note Availability: 129a.: Unix.

 -- Function: os.setresgid (rgid, egid, sgid)

     Set the current process’s real, effective, and saved group ids.

     *note Availability: 129a.: Unix.

     New in version 3.2.

 -- Function: os.setresuid (ruid, euid, suid)

     Set the current process’s real, effective, and saved user ids.

     *note Availability: 129a.: Unix.

     New in version 3.2.

 -- Function: os.setreuid (ruid, euid)

     Set the current process’s real and effective user ids.

     *note Availability: 129a.: Unix.

 -- Function: os.getsid (pid)

     Call the system call ‘getsid()’.  See the Unix manual for the
     semantics.

     *note Availability: 129a.: Unix.

 -- Function: os.setsid ()

     Call the system call ‘setsid()’.  See the Unix manual for the
     semantics.

     *note Availability: 129a.: Unix.

 -- Function: os.setuid (uid)

     Set the current process’s user id.

     *note Availability: 129a.: Unix.

 -- Function: os.strerror (code)

     Return the error message corresponding to the error code in `code'.
     On platforms where ‘strerror()’ returns ‘NULL’ when given an
     unknown error number, *note ValueError: 1f9. is raised.

 -- Data: os.supports_bytes_environ

     ‘True’ if the native OS type of the environment is bytes (eg.
     ‘False’ on Windows).

     New in version 3.2.

 -- Function: os.umask (mask)

     Set the current numeric umask and return the previous umask.

 -- Function: os.uname ()

     Returns information identifying the current operating system.  The
     return value is an object with five attributes:

        * ‘sysname’ - operating system name

        * ‘nodename’ - name of machine on network
          (implementation-defined)

        * ‘release’ - operating system release

        * ‘version’ - operating system version

        * ‘machine’ - hardware identifier

     For backwards compatibility, this object is also iterable, behaving
     like a five-tuple containing ‘sysname’, ‘nodename’, ‘release’,
     ‘version’, and ‘machine’ in that order.

     Some systems truncate ‘nodename’ to 8 characters or to the leading
     component; a better way to get the hostname is *note
     socket.gethostname(): 1e41. or even
     ‘socket.gethostbyaddr(socket.gethostname())’.

     *note Availability: 129a.: recent flavors of Unix.

     Changed in version 3.3: Return type changed from a tuple to a
     tuple-like object with named attributes.

 -- Function: os.unsetenv (key)

     Unset (delete) the environment variable named `key'.  Such changes
     to the environment affect subprocesses started with *note
     os.system(): db4, *note popen(): 2a7. or *note fork(): 955. and
     *note execv(): 1e34.

     When *note unsetenv(): d36. is supported, deletion of items in
     ‘os.environ’ is automatically translated into a corresponding call
     to *note unsetenv(): d36.; however, calls to *note unsetenv(): d36.
     don’t update ‘os.environ’, so it is actually preferable to delete
     items of ‘os.environ’.

     *note Availability: 129a.: most flavors of Unix, Windows.


File: python.info,  Node: File Object Creation,  Next: File Descriptor Operations,  Prev: Process Parameters,  Up: os — Miscellaneous operating system interfaces

5.16.1.3 File Object Creation
.............................

These functions create new *note file objects: b35.  (See also *note
open(): 659. for opening file descriptors.)

 -- Function: os.fdopen (fd, *args, **kwargs)

     Return an open file object connected to the file descriptor `fd'.
     This is an alias of the *note open(): 4e5. built-in function and
     accepts the same arguments.  The only difference is that the first
     argument of *note fdopen(): 136d. must always be an integer.


File: python.info,  Node: File Descriptor Operations,  Next: Files and Directories,  Prev: File Object Creation,  Up: os — Miscellaneous operating system interfaces

5.16.1.4 File Descriptor Operations
...................................

These functions operate on I/O streams referenced using file
descriptors.

File descriptors are small integers corresponding to a file that has
been opened by the current process.  For example, standard input is
usually file descriptor 0, standard output is 1, and standard error is
2.  Further files opened by a process will then be assigned 3, 4, 5, and
so forth.  The name “file descriptor” is slightly deceptive; on Unix
platforms, sockets and pipes are also referenced by file descriptors.

The *note fileno(): 1e46. method can be used to obtain the file
descriptor associated with a *note file object: b35. when required.
Note that using the file descriptor directly will bypass the file object
methods, ignoring aspects such as internal buffering of data.

 -- Function: os.close (fd)

     Close file descriptor `fd'.

          Note: This function is intended for low-level I/O and must be
          applied to a file descriptor as returned by *note os.open():
          659. or *note pipe(): 1e47.  To close a “file object” returned
          by the built-in function *note open(): 4e5. or by *note
          popen(): 2a7. or *note fdopen(): 136d, use its *note close():
          f43. method.

 -- Function: os.closerange (fd_low, fd_high)

     Close all file descriptors from `fd_low' (inclusive) to `fd_high'
     (exclusive), ignoring errors.  Equivalent to (but much faster
     than):

          for fd in range(fd_low, fd_high):
              try:
                  os.close(fd)
              except OSError:
                  pass

 -- Function: os.copy_file_range (src, dst, count, offset_src=None,
          offset_dst=None)

     Copy `count' bytes from file descriptor `src', starting from offset
     `offset_src', to file descriptor `dst', starting from offset
     `offset_dst'.  If `offset_src' is None, then `src' is read from the
     current position; respectively for `offset_dst'.  The files pointed
     by `src' and `dst' must reside in the same filesystem, otherwise an
     *note OSError: 1d1. is raised with *note errno: 1641. set to *note
     errno.EXDEV: 1e4a.

     This copy is done without the additional cost of transferring data
     from the kernel to user space and then back into the kernel.
     Additionally, some filesystems could implement extra optimizations.
     The copy is done as if both files are opened as binary.

     The return value is the amount of bytes copied.  This could be less
     than the amount requested.

     *note Availability: 129a.: Linux kernel >= 4.5 or glibc >= 2.27.

     New in version 3.8.

 -- Function: os.device_encoding (fd)

     Return a string describing the encoding of the device associated
     with `fd' if it is connected to a terminal; else return *note None:
     157.

 -- Function: os.dup (fd)

     Return a duplicate of file descriptor `fd'.  The new file
     descriptor is *note non-inheritable: 7ee.

     On Windows, when duplicating a standard stream (0: stdin, 1:
     stdout, 2: stderr), the new file descriptor is *note inheritable:
     7ee.

     Changed in version 3.4: The new file descriptor is now
     non-inheritable.

 -- Function: os.dup2 (fd, fd2, inheritable=True)

     Duplicate file descriptor `fd' to `fd2', closing the latter first
     if necessary.  Return `fd2'.  The new file descriptor is *note
     inheritable: 7ee. by default or non-inheritable if `inheritable' is
     ‘False’.

     Changed in version 3.4: Add the optional `inheritable' parameter.

     Changed in version 3.7: Return `fd2' on success.  Previously,
     ‘None’ was always returned.

 -- Function: os.fchmod (fd, mode)

     Change the mode of the file given by `fd' to the numeric `mode'.
     See the docs for *note chmod(): a28. for possible values of `mode'.
     As of Python 3.3, this is equivalent to ‘os.chmod(fd, mode)’.

     *note Availability: 129a.: Unix.

 -- Function: os.fchown (fd, uid, gid)

     Change the owner and group id of the file given by `fd' to the
     numeric `uid' and `gid'.  To leave one of the ids unchanged, set it
     to -1.  See *note chown(): a29.  As of Python 3.3, this is
     equivalent to ‘os.chown(fd, uid, gid)’.

     *note Availability: 129a.: Unix.

 -- Function: os.fdatasync (fd)

     Force write of file with filedescriptor `fd' to disk.  Does not
     force update of metadata.

     *note Availability: 129a.: Unix.

          Note: This function is not available on MacOS.

 -- Function: os.fpathconf (fd, name)

     Return system configuration information relevant to an open file.
     `name' specifies the configuration value to retrieve; it may be a
     string which is the name of a defined system value; these names are
     specified in a number of standards (POSIX.1, Unix 95, Unix 98, and
     others).  Some platforms define additional names as well.  The
     names known to the host operating system are given in the
     ‘pathconf_names’ dictionary.  For configuration variables not
     included in that mapping, passing an integer for `name' is also
     accepted.

     If `name' is a string and is not known, *note ValueError: 1f9. is
     raised.  If a specific value for `name' is not supported by the
     host system, even if it is included in ‘pathconf_names’, an *note
     OSError: 1d1. is raised with *note errno.EINVAL: efb. for the error
     number.

     As of Python 3.3, this is equivalent to ‘os.pathconf(fd, name)’.

     *note Availability: 129a.: Unix.

 -- Function: os.fstat (fd)

     Get the status of the file descriptor `fd'.  Return a *note
     stat_result: fc2. object.

     As of Python 3.3, this is equivalent to ‘os.stat(fd)’.

     See also
     ........

     The *note stat(): 1ef. function.

 -- Function: os.fstatvfs (fd)

     Return information about the filesystem containing the file
     associated with file descriptor `fd', like *note statvfs(): a38.
     As of Python 3.3, this is equivalent to ‘os.statvfs(fd)’.

     *note Availability: 129a.: Unix.

 -- Function: os.fsync (fd)

     Force write of file with filedescriptor `fd' to disk.  On Unix,
     this calls the native ‘fsync()’ function; on Windows, the MS
     ‘_commit()’ function.

     If you’re starting with a buffered Python *note file object: b35.
     `f', first do ‘f.flush()’, and then do ‘os.fsync(f.fileno())’, to
     ensure that all internal buffers associated with `f' are written to
     disk.

     *note Availability: 129a.: Unix, Windows.

 -- Function: os.ftruncate (fd, length)

     Truncate the file corresponding to file descriptor `fd', so that it
     is at most `length' bytes in size.  As of Python 3.3, this is
     equivalent to ‘os.truncate(fd, length)’.

     Raises an *note auditing event: 1275. ‘os.truncate’ with arguments
     ‘fd’, ‘length’.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.5: Added support for Windows

 -- Function: os.get_blocking (fd)

     Get the blocking mode of the file descriptor: ‘False’ if the *note
     O_NONBLOCK: 717. flag is set, ‘True’ if the flag is cleared.

     See also *note set_blocking(): 716. and *note
     socket.socket.setblocking(): 1e4d.

     *note Availability: 129a.: Unix.

     New in version 3.5.

 -- Function: os.isatty (fd)

     Return ‘True’ if the file descriptor `fd' is open and connected to
     a tty(-like) device, else ‘False’.

 -- Function: os.lockf (fd, cmd, len)

     Apply, test or remove a POSIX lock on an open file descriptor.
     `fd' is an open file descriptor.  `cmd' specifies the command to
     use - one of *note F_LOCK: 1e4f, *note F_TLOCK: 1e50, *note
     F_ULOCK: 1e51. or *note F_TEST: 1e52.  `len' specifies the section
     of the file to lock.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: os.F_LOCK
 -- Data: os.F_TLOCK
 -- Data: os.F_ULOCK
 -- Data: os.F_TEST

     Flags that specify what action *note lockf(): a4f. will take.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.lseek (fd, pos, how)

     Set the current position of file descriptor `fd' to position `pos',
     modified by `how': *note SEEK_SET: d87. or ‘0’ to set the position
     relative to the beginning of the file; *note SEEK_CUR: d88. or ‘1’
     to set it relative to the current position; *note SEEK_END: d89. or
     ‘2’ to set it relative to the end of the file.  Return the new
     cursor position in bytes, starting from the beginning.

 -- Data: os.SEEK_SET
 -- Data: os.SEEK_CUR
 -- Data: os.SEEK_END

     Parameters to the *note lseek(): a53. function.  Their values are
     0, 1, and 2, respectively.

     New in version 3.3: Some operating systems could support additional
     values, like ‘os.SEEK_HOLE’ or ‘os.SEEK_DATA’.

 -- Function: os.open (path, flags, mode=0o777, *, dir_fd=None)

     Open the file `path' and set various flags according to `flags' and
     possibly its mode according to `mode'.  When computing `mode', the
     current umask value is first masked out.  Return the file
     descriptor for the newly opened file.  The new file descriptor is
     *note non-inheritable: 7ee.

     For a description of the flag and mode values, see the C run-time
     documentation; flag constants (like *note O_RDONLY: 1e53. and *note
     O_WRONLY: 1e54.) are defined in the *note os: c4. module.  In
     particular, on Windows adding *note O_BINARY: 1e55. is needed to
     open files in binary mode.

     This function can support *note paths relative to directory
     descriptors: a24. with the `dir_fd' parameter.

     Raises an *note auditing event: 1275. ‘open’ with arguments ‘path’,
     ‘mode’, ‘flags’.

     Changed in version 3.4: The new file descriptor is now
     non-inheritable.

          Note: This function is intended for low-level I/O. For normal
          usage, use the built-in function *note open(): 4e5, which
          returns a *note file object: b35. with ‘read()’ and ‘write()’
          methods (and many more).  To wrap a file descriptor in a file
          object, use *note fdopen(): 136d.

     New in version 3.3: The `dir_fd' argument.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the function now
     retries the system call instead of raising an *note
     InterruptedError: 64d. exception (see PEP 475(1) for the
     rationale).

     Changed in version 3.6: Accepts a *note path-like object: 35f.

The following constants are options for the `flags' parameter to the
*note open(): 659. function.  They can be combined using the bitwise OR
operator ‘|’.  Some of them are not available on all platforms.  For
descriptions of their availability and use, consult the ‘open(2)’ manual
page on Unix or the MSDN(2) on Windows.

 -- Data: os.O_RDONLY
 -- Data: os.O_WRONLY
 -- Data: os.O_RDWR
 -- Data: os.O_APPEND
 -- Data: os.O_CREAT
 -- Data: os.O_EXCL
 -- Data: os.O_TRUNC

     The above constants are available on Unix and Windows.

 -- Data: os.O_DSYNC
 -- Data: os.O_RSYNC
 -- Data: os.O_SYNC
 -- Data: os.O_NDELAY
 -- Data: os.O_NONBLOCK
 -- Data: os.O_NOCTTY
 -- Data: os.O_CLOEXEC

     The above constants are only available on Unix.

     Changed in version 3.3: Add *note O_CLOEXEC: 9b7. constant.

 -- Data: os.O_BINARY
 -- Data: os.O_NOINHERIT
 -- Data: os.O_SHORT_LIVED
 -- Data: os.O_TEMPORARY
 -- Data: os.O_RANDOM
 -- Data: os.O_SEQUENTIAL
 -- Data: os.O_TEXT

     The above constants are only available on Windows.

 -- Data: os.O_ASYNC
 -- Data: os.O_DIRECT
 -- Data: os.O_DIRECTORY
 -- Data: os.O_NOFOLLOW
 -- Data: os.O_NOATIME
 -- Data: os.O_PATH
 -- Data: os.O_TMPFILE
 -- Data: os.O_SHLOCK
 -- Data: os.O_EXLOCK

     The above constants are extensions and not present if they are not
     defined by the C library.

     Changed in version 3.4: Add *note O_PATH: 877. on systems that
     support it.  Add *note O_TMPFILE: 878, only available on Linux
     Kernel 3.11 or newer.

 -- Function: os.openpty ()

     Open a new pseudo-terminal pair.  Return a pair of file descriptors
     ‘(master, slave)’ for the pty and the tty, respectively.  The new
     file descriptors are *note non-inheritable: 7ee.  For a (slightly)
     more portable approach, use the *note pty: d5. module.

     *note Availability: 129a.: some flavors of Unix.

     Changed in version 3.4: The new file descriptors are now
     non-inheritable.

 -- Function: os.pipe ()

     Create a pipe.  Return a pair of file descriptors ‘(r, w)’ usable
     for reading and writing, respectively.  The new file descriptor is
     *note non-inheritable: 7ee.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.4: The new file descriptors are now
     non-inheritable.

 -- Function: os.pipe2 (flags)

     Create a pipe with `flags' set atomically.  `flags' can be
     constructed by ORing together one or more of these values: *note
     O_NONBLOCK: 717, *note O_CLOEXEC: 9b7.  Return a pair of file
     descriptors ‘(r, w)’ usable for reading and writing, respectively.

     *note Availability: 129a.: some flavors of Unix.

     New in version 3.3.

 -- Function: os.posix_fallocate (fd, offset, len)

     Ensures that enough disk space is allocated for the file specified
     by `fd' starting from `offset' and continuing for `len' bytes.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.posix_fadvise (fd, offset, len, advice)

     Announces an intention to access data in a specific pattern thus
     allowing the kernel to make optimizations.  The advice applies to
     the region of the file specified by `fd' starting at `offset' and
     continuing for `len' bytes.  `advice' is one of *note
     POSIX_FADV_NORMAL: 1e6b, *note POSIX_FADV_SEQUENTIAL: 1e6c, *note
     POSIX_FADV_RANDOM: 1e6d, *note POSIX_FADV_NOREUSE: 1e6e, *note
     POSIX_FADV_WILLNEED: 1e6f. or *note POSIX_FADV_DONTNEED: 1e70.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: os.POSIX_FADV_NORMAL
 -- Data: os.POSIX_FADV_SEQUENTIAL
 -- Data: os.POSIX_FADV_RANDOM
 -- Data: os.POSIX_FADV_NOREUSE
 -- Data: os.POSIX_FADV_WILLNEED
 -- Data: os.POSIX_FADV_DONTNEED

     Flags that can be used in `advice' in *note posix_fadvise(): 65a.
     that specify the access pattern that is likely to be used.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.pread (fd, n, offset)

     Read at most `n' bytes from file descriptor `fd' at a position of
     `offset', leaving the file offset unchanged.

     Return a bytestring containing the bytes read.  If the end of the
     file referred to by `fd' has been reached, an empty bytes object is
     returned.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.preadv (fd, buffers, offset, flags=0)

     Read from a file descriptor `fd' at a position of `offset' into
     mutable *note bytes-like objects: 5dd. `buffers', leaving the file
     offset unchanged.  Transfer data into each buffer until it is full
     and then move on to the next buffer in the sequence to hold the
     rest of the data.

     The flags argument contains a bitwise OR of zero or more of the
     following flags:

        - *note RWF_HIPRI: 1e71.

        - *note RWF_NOWAIT: 1e72.

     Return the total number of bytes actually read which can be less
     than the total capacity of all the objects.

     The operating system may set a limit (*note sysconf(): 1e73. value
     ‘'SC_IOV_MAX'’) on the number of buffers that can be used.

     Combine the functionality of *note os.readv(): 3ad. and *note
     os.pread(): 3ae.

     *note Availability: 129a.: Linux 2.6.30 and newer, FreeBSD 6.0 and
     newer, OpenBSD 2.7 and newer.  Using flags requires Linux 4.6 or
     newer.

     New in version 3.7.

 -- Data: os.RWF_NOWAIT

     Do not wait for data which is not immediately available.  If this
     flag is specified, the system call will return instantly if it
     would have to read data from the backing storage or wait for a
     lock.

     If some data was successfully read, it will return the number of
     bytes read.  If no bytes were read, it will return ‘-1’ and set
     errno to *note errno.EAGAIN: 1e74.

     *note Availability: 129a.: Linux 4.14 and newer.

     New in version 3.7.

 -- Data: os.RWF_HIPRI

     High priority read/write.  Allows block-based filesystems to use
     polling of the device, which provides lower latency, but may use
     additional resources.

     Currently, on Linux, this feature is usable only on a file
     descriptor opened using the *note O_DIRECT: 1e66. flag.

     *note Availability: 129a.: Linux 4.6 and newer.

     New in version 3.7.

 -- Function: os.pwrite (fd, str, offset)

     Write the bytestring in `str' to file descriptor `fd' at position
     of `offset', leaving the file offset unchanged.

     Return the number of bytes actually written.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.pwritev (fd, buffers, offset, flags=0)

     Write the `buffers' contents to file descriptor `fd' at a offset
     `offset', leaving the file offset unchanged.  `buffers' must be a
     sequence of *note bytes-like objects: 5dd.  Buffers are processed
     in array order.  Entire contents of the first buffer is written
     before proceeding to the second, and so on.

     The flags argument contains a bitwise OR of zero or more of the
     following flags:

        - *note RWF_DSYNC: 1e75.

        - *note RWF_SYNC: 1e76.

     Return the total number of bytes actually written.

     The operating system may set a limit (*note sysconf(): 1e73. value
     ‘'SC_IOV_MAX'’) on the number of buffers that can be used.

     Combine the functionality of *note os.writev(): 3b0. and *note
     os.pwrite(): 3b1.

     *note Availability: 129a.: Linux 2.6.30 and newer, FreeBSD 6.0 and
     newer, OpenBSD 2.7 and newer.  Using flags requires Linux 4.7 or
     newer.

     New in version 3.7.

 -- Data: os.RWF_DSYNC

     Provide a per-write equivalent of the *note O_DSYNC: 1e5a.
     ‘open(2)’ flag.  This flag effect applies only to the data range
     written by the system call.

     *note Availability: 129a.: Linux 4.7 and newer.

     New in version 3.7.

 -- Data: os.RWF_SYNC

     Provide a per-write equivalent of the *note O_SYNC: 1e5c. ‘open(2)’
     flag.  This flag effect applies only to the data range written by
     the system call.

     *note Availability: 129a.: Linux 4.7 and newer.

     New in version 3.7.

 -- Function: os.read (fd, n)

     Read at most `n' bytes from file descriptor `fd'.

     Return a bytestring containing the bytes read.  If the end of the
     file referred to by `fd' has been reached, an empty bytes object is
     returned.

          Note: This function is intended for low-level I/O and must be
          applied to a file descriptor as returned by *note os.open():
          659. or *note pipe(): 1e47.  To read a “file object” returned
          by the built-in function *note open(): 4e5. or by *note
          popen(): 2a7. or *note fdopen(): 136d, or *note sys.stdin:
          302, use its ‘read()’ or ‘readline()’ methods.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the function now
     retries the system call instead of raising an *note
     InterruptedError: 64d. exception (see PEP 475(3) for the
     rationale).

 -- Function: os.sendfile (out, in, offset, count)

 -- Function: os.sendfile (out, in, offset, count[, headers][,
          trailers], flags=0)

     Copy `count' bytes from file descriptor `in' to file descriptor
     `out' starting at `offset'.  Return the number of bytes sent.  When
     EOF is reached return 0.

     The first function notation is supported by all platforms that
     define *note sendfile(): 34e.

     On Linux, if `offset' is given as ‘None’, the bytes are read from
     the current position of `in' and the position of `in' is updated.

     The second case may be used on Mac OS X and FreeBSD where `headers'
     and `trailers' are arbitrary sequences of buffers that are written
     before and after the data from `in' is written.  It returns the
     same as the first case.

     On Mac OS X and FreeBSD, a value of 0 for `count' specifies to send
     until the end of `in' is reached.

     All platforms support sockets as `out' file descriptor, and some
     platforms allow other types (e.g.  regular file, pipe) as well.

     Cross-platform applications should not use `headers', `trailers'
     and `flags' arguments.

     *note Availability: 129a.: Unix.

          Note: For a higher-level wrapper of *note sendfile(): 34e, see
          *note socket.socket.sendfile(): 73e.

     New in version 3.3.

 -- Function: os.set_blocking (fd, blocking)

     Set the blocking mode of the specified file descriptor.  Set the
     *note O_NONBLOCK: 717. flag if blocking is ‘False’, clear the flag
     otherwise.

     See also *note get_blocking(): 715. and *note
     socket.socket.setblocking(): 1e4d.

     *note Availability: 129a.: Unix.

     New in version 3.5.

 -- Data: os.SF_NODISKIO
 -- Data: os.SF_MNOWAIT
 -- Data: os.SF_SYNC

     Parameters to the *note sendfile(): 34e. function, if the
     implementation supports them.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.readv (fd, buffers)

     Read from a file descriptor `fd' into a number of mutable *note
     bytes-like objects: 5dd. `buffers'.  Transfer data into each buffer
     until it is full and then move on to the next buffer in the
     sequence to hold the rest of the data.

     Return the total number of bytes actually read which can be less
     than the total capacity of all the objects.

     The operating system may set a limit (*note sysconf(): 1e73. value
     ‘'SC_IOV_MAX'’) on the number of buffers that can be used.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.tcgetpgrp (fd)

     Return the process group associated with the terminal given by `fd'
     (an open file descriptor as returned by *note os.open(): 659.).

     *note Availability: 129a.: Unix.

 -- Function: os.tcsetpgrp (fd, pg)

     Set the process group associated with the terminal given by `fd'
     (an open file descriptor as returned by *note os.open(): 659.) to
     `pg'.

     *note Availability: 129a.: Unix.

 -- Function: os.ttyname (fd)

     Return a string which specifies the terminal device associated with
     file descriptor `fd'.  If `fd' is not associated with a terminal
     device, an exception is raised.

     *note Availability: 129a.: Unix.

 -- Function: os.write (fd, str)

     Write the bytestring in `str' to file descriptor `fd'.

     Return the number of bytes actually written.

          Note: This function is intended for low-level I/O and must be
          applied to a file descriptor as returned by *note os.open():
          659. or *note pipe(): 1e47.  To write a “file object” returned
          by the built-in function *note open(): 4e5. or by *note
          popen(): 2a7. or *note fdopen(): 136d, or *note sys.stdout:
          303. or *note sys.stderr: 304, use its ‘write()’ method.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the function now
     retries the system call instead of raising an *note
     InterruptedError: 64d. exception (see PEP 475(4) for the
     rationale).

 -- Function: os.writev (fd, buffers)

     Write the contents of `buffers' to file descriptor `fd'.  `buffers'
     must be a sequence of *note bytes-like objects: 5dd.  Buffers are
     processed in array order.  Entire contents of the first buffer is
     written before proceeding to the second, and so on.

     Returns the total number of bytes actually written.

     The operating system may set a limit (*note sysconf(): 1e73. value
     ‘'SC_IOV_MAX'’) on the number of buffers that can be used.

     *note Availability: 129a.: Unix.

     New in version 3.3.

* Menu:

* Querying the size of a terminal::
* Inheritance of File Descriptors::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475

   (2) https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx

   (3) https://www.python.org/dev/peps/pep-0475

   (4) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Querying the size of a terminal,  Next: Inheritance of File Descriptors,  Up: File Descriptor Operations

5.16.1.5 Querying the size of a terminal
........................................

New in version 3.3.

 -- Function: os.get_terminal_size (fd=STDOUT_FILENO)

     Return the size of the terminal window as ‘(columns, lines)’, tuple
     of type *note terminal_size: 1bd4.

     The optional argument ‘fd’ (default ‘STDOUT_FILENO’, or standard
     output) specifies which file descriptor should be queried.

     If the file descriptor is not connected to a terminal, an *note
     OSError: 1d1. is raised.

     *note shutil.get_terminal_size(): a3f. is the high-level function
     which should normally be used, ‘os.get_terminal_size’ is the
     low-level implementation.

     *note Availability: 129a.: Unix, Windows.

 -- Class: os.terminal_size

     A subclass of tuple, holding ‘(columns, lines)’ of the terminal
     window size.

      -- Attribute: columns

          Width of the terminal window in characters.

      -- Attribute: lines

          Height of the terminal window in characters.


File: python.info,  Node: Inheritance of File Descriptors,  Prev: Querying the size of a terminal,  Up: File Descriptor Operations

5.16.1.6 Inheritance of File Descriptors
........................................

New in version 3.4.

A file descriptor has an “inheritable” flag which indicates if the file
descriptor can be inherited by child processes.  Since Python 3.4, file
descriptors created by Python are non-inheritable by default.

On UNIX, non-inheritable file descriptors are closed in child processes
at the execution of a new program, other file descriptors are inherited.

On Windows, non-inheritable handles and file descriptors are closed in
child processes, except for standard streams (file descriptors 0, 1 and
2: stdin, stdout and stderr), which are always inherited.  Using *note
spawn*: 1e82. functions, all inheritable handles and all inheritable
file descriptors are inherited.  Using the *note subprocess: f9. module,
all file descriptors except standard streams are closed, and inheritable
handles are only inherited if the `close_fds' parameter is ‘False’.

 -- Function: os.get_inheritable (fd)

     Get the “inheritable” flag of the specified file descriptor (a
     boolean).

 -- Function: os.set_inheritable (fd, inheritable)

     Set the “inheritable” flag of the specified file descriptor.

 -- Function: os.get_handle_inheritable (handle)

     Get the “inheritable” flag of the specified handle (a boolean).

     *note Availability: 129a.: Windows.

 -- Function: os.set_handle_inheritable (handle, inheritable)

     Set the “inheritable” flag of the specified handle.

     *note Availability: 129a.: Windows.


File: python.info,  Node: Files and Directories,  Next: Process Management,  Prev: File Descriptor Operations,  Up: os — Miscellaneous operating system interfaces

5.16.1.7 Files and Directories
..............................

On some Unix platforms, many of these functions support one or more of
these features:

   * `specifying a file descriptor:' Normally the `path' argument
     provided to functions in the *note os: c4. module must be a string
     specifying a file path.  However, some functions now alternatively
     accept an open file descriptor for their `path' argument.  The
     function will then operate on the file referred to by the
     descriptor.  (For POSIX systems, Python will call the variant of
     the function prefixed with ‘f’ (e.g.  call ‘fchdir’ instead of
     ‘chdir’).)

     You can check whether or not `path' can be specified as a file
     descriptor for a particular function on your platform using *note
     os.supports_fd: a39.  If this functionality is unavailable, using
     it will raise a *note NotImplementedError: 603.

     If the function also supports `dir_fd' or `follow_symlinks'
     arguments, it’s an error to specify one of those when supplying
     `path' as a file descriptor.

   * `paths relative to directory descriptors:' If `dir_fd' is not
     ‘None’, it should be a file descriptor referring to a directory,
     and the path to operate on should be relative; path will then be
     relative to that directory.  If the path is absolute, `dir_fd' is
     ignored.  (For POSIX systems, Python will call the variant of the
     function with an ‘at’ suffix and possibly prefixed with ‘f’ (e.g.
     call ‘faccessat’ instead of ‘access’).

     You can check whether or not `dir_fd' is supported for a particular
     function on your platform using *note os.supports_dir_fd: a33.  If
     it’s unavailable, using it will raise a *note NotImplementedError:
     603.

   * `not following symlinks:' If `follow_symlinks' is ‘False’, and the
     last element of the path to operate on is a symbolic link, the
     function will operate on the symbolic link itself rather than the
     file pointed to by the link.  (For POSIX systems, Python will call
     the ‘l...’ variant of the function.)

     You can check whether or not `follow_symlinks' is supported for a
     particular function on your platform using *note
     os.supports_follow_symlinks: 1bc1.  If it’s unavailable, using it
     will raise a *note NotImplementedError: 603.

 -- Function: os.access (path, mode, *, dir_fd=None,
          effective_ids=False, follow_symlinks=True)

     Use the real uid/gid to test for access to `path'.  Note that most
     operations will use the effective uid/gid, therefore this routine
     can be used in a suid/sgid environment to test if the invoking user
     has the specified access to `path'.  `mode' should be *note F_OK:
     1e84. to test the existence of `path', or it can be the inclusive
     OR of one or more of *note R_OK: 1e85, *note W_OK: 1e86, and *note
     X_OK: 1e87. to test permissions.  Return *note True: 48f. if access
     is allowed, *note False: 37d. if not.  See the Unix man page
     ‘access(2)’ for more information.

     This function can support specifying *note paths relative to
     directory descriptors: a24. and *note not following symlinks: a25.

     If `effective_ids' is ‘True’, *note access(): a26. will perform its
     access checks using the effective uid/gid instead of the real
     uid/gid.  `effective_ids' may not be supported on your platform;
     you can check whether or not it is available using *note
     os.supports_effective_ids: a3a.  If it is unavailable, using it
     will raise a *note NotImplementedError: 603.

          Note: Using *note access(): a26. to check if a user is
          authorized to e.g.  open a file before actually doing so using
          *note open(): 4e5. creates a security hole, because the user
          might exploit the short time interval between checking and
          opening the file to manipulate it.  It’s preferable to use
          *note EAFP: 1e88. techniques.  For example:

               if os.access("myfile", os.R_OK):
                   with open("myfile") as fp:
                       return fp.read()
               return "some default data"

          is better written as:

               try:
                   fp = open("myfile")
               except PermissionError:
                   return "some default data"
               else:
                   with fp:
                       return fp.read()

          Note: I/O operations may fail even when *note access(): a26.
          indicates that they would succeed, particularly for operations
          on network filesystems which may have permissions semantics
          beyond the usual POSIX permission-bit model.

     Changed in version 3.3: Added the `dir_fd', `effective_ids', and
     `follow_symlinks' parameters.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Data: os.F_OK
 -- Data: os.R_OK
 -- Data: os.W_OK
 -- Data: os.X_OK

     Values to pass as the `mode' parameter of *note access(): a26. to
     test the existence, readability, writability and executability of
     `path', respectively.

 -- Function: os.chdir (path)

     Change the current working directory to `path'.

     This function can support *note specifying a file descriptor: 3aa.
     The descriptor must refer to an opened directory, not an open file.

     This function can raise *note OSError: 1d1. and subclasses such as
     *note FileNotFoundError: 7b4, *note PermissionError: 5f4, and *note
     NotADirectoryError: 98e.

     New in version 3.3: Added support for specifying `path' as a file
     descriptor on some platforms.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.chflags (path, flags, *, follow_symlinks=True)

     Set the flags of `path' to the numeric `flags'.  `flags' may take a
     combination (bitwise OR) of the following values (as defined in the
     *note stat: f4. module):

        * *note stat.UF_NODUMP: 1b66.

        * *note stat.UF_IMMUTABLE: 1b67.

        * *note stat.UF_APPEND: 1b68.

        * *note stat.UF_OPAQUE: 1b69.

        * *note stat.UF_NOUNLINK: 1b6a.

        * *note stat.UF_COMPRESSED: 1b6b.

        * *note stat.UF_HIDDEN: 1b6c.

        * *note stat.SF_ARCHIVED: 1b6d.

        * *note stat.SF_IMMUTABLE: 1b6e.

        * *note stat.SF_APPEND: 1b6f.

        * *note stat.SF_NOUNLINK: 1b70.

        * *note stat.SF_SNAPSHOT: 1b71.

     This function can support *note not following symlinks: a25.

     *note Availability: 129a.: Unix.

     New in version 3.3: The `follow_symlinks' argument.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.chmod (path, mode, *, dir_fd=None,
          follow_symlinks=True)

     Change the mode of `path' to the numeric `mode'.  `mode' may take
     one of the following values (as defined in the *note stat: f4.
     module) or bitwise ORed combinations of them:

        * *note stat.S_ISUID: 1b53.

        * *note stat.S_ISGID: 1b54.

        * *note stat.S_ENFMT: 1b56.

        * *note stat.S_ISVTX: 1b57.

        * *note stat.S_IREAD: 1b63.

        * *note stat.S_IWRITE: 1b64.

        * *note stat.S_IEXEC: 1b65.

        * *note stat.S_IRWXU: 1b58.

        * *note stat.S_IRUSR: 1b59.

        * *note stat.S_IWUSR: 1b5a.

        * *note stat.S_IXUSR: 1b5b.

        * *note stat.S_IRWXG: 1b5c.

        * *note stat.S_IRGRP: 1b5d.

        * *note stat.S_IWGRP: 1b5e.

        * *note stat.S_IXGRP: 1b55.

        * *note stat.S_IRWXO: 1b5f.

        * *note stat.S_IROTH: 1b60.

        * *note stat.S_IWOTH: 1b61.

        * *note stat.S_IXOTH: 1b62.

     This function can support *note specifying a file descriptor: 3aa,
     *note paths relative to directory descriptors: a24. and *note not
     following symlinks: a25.

          Note: Although Windows supports *note chmod(): a28, you can
          only set the file’s read-only flag with it (via the
          ‘stat.S_IWRITE’ and ‘stat.S_IREAD’ constants or a
          corresponding integer value).  All other bits are ignored.

     New in version 3.3: Added support for specifying `path' as an open
     file descriptor, and the `dir_fd' and `follow_symlinks' arguments.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.chown (path, uid, gid, *, dir_fd=None,
          follow_symlinks=True)

     Change the owner and group id of `path' to the numeric `uid' and
     `gid'.  To leave one of the ids unchanged, set it to -1.

     This function can support *note specifying a file descriptor: 3aa,
     *note paths relative to directory descriptors: a24. and *note not
     following symlinks: a25.

     See *note shutil.chown(): a6b. for a higher-level function that
     accepts names in addition to numeric ids.

     *note Availability: 129a.: Unix.

     New in version 3.3: Added support for specifying `path' as an open
     file descriptor, and the `dir_fd' and `follow_symlinks' arguments.

     Changed in version 3.6: Supports a *note path-like object: 35f.

 -- Function: os.chroot (path)

     Change the root directory of the current process to `path'.

     *note Availability: 129a.: Unix.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.fchdir (fd)

     Change the current working directory to the directory represented
     by the file descriptor `fd'.  The descriptor must refer to an
     opened directory, not an open file.  As of Python 3.3, this is
     equivalent to ‘os.chdir(fd)’.

     *note Availability: 129a.: Unix.

 -- Function: os.getcwd ()

     Return a string representing the current working directory.

 -- Function: os.getcwdb ()

     Return a bytestring representing the current working directory.

     Changed in version 3.8: The function now uses the UTF-8 encoding on
     Windows, rather than the ANSI code page: see PEP 529(1) for the
     rationale.  The function is no longer deprecated on Windows.

 -- Function: os.lchflags (path, flags)

     Set the flags of `path' to the numeric `flags', like *note
     chflags(): a27, but do not follow symbolic links.  As of Python
     3.3, this is equivalent to ‘os.chflags(path, flags,
     follow_symlinks=False)’.

     *note Availability: 129a.: Unix.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.lchmod (path, mode)

     Change the mode of `path' to the numeric `mode'.  If path is a
     symlink, this affects the symlink rather than the target.  See the
     docs for *note chmod(): a28. for possible values of `mode'.  As of
     Python 3.3, this is equivalent to ‘os.chmod(path, mode,
     follow_symlinks=False)’.

     *note Availability: 129a.: Unix.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.lchown (path, uid, gid)

     Change the owner and group id of `path' to the numeric `uid' and
     `gid'.  This function will not follow symbolic links.  As of Python
     3.3, this is equivalent to ‘os.chown(path, uid, gid,
     follow_symlinks=False)’.

     *note Availability: 129a.: Unix.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.link (src, dst, *, src_dir_fd=None, dst_dir_fd=None,
          follow_symlinks=True)

     Create a hard link pointing to `src' named `dst'.

     This function can support specifying `src_dir_fd' and/or
     `dst_dir_fd' to supply *note paths relative to directory
     descriptors: a24, and *note not following symlinks: a25.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.2: Added Windows support.

     New in version 3.3: Added the `src_dir_fd', `dst_dir_fd', and
     `follow_symlinks' arguments.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `src' and `dst'.

 -- Function: os.listdir (path='.')

     Return a list containing the names of the entries in the directory
     given by `path'.  The list is in arbitrary order, and does not
     include the special entries ‘'.'’ and ‘'..'’ even if they are
     present in the directory.

     `path' may be a *note path-like object: 35f.  If `path' is of type
     ‘bytes’ (directly or indirectly through the *note PathLike: 4e0.
     interface), the filenames returned will also be of type ‘bytes’; in
     all other circumstances, they will be of type ‘str’.

     This function can also support *note specifying a file descriptor:
     3aa.; the file descriptor must refer to a directory.

     Raises an *note auditing event: 1275. ‘os.listdir’ with argument
     ‘path’.

          Note: To encode ‘str’ filenames to ‘bytes’, use *note
          fsencode(): 4e4.

     See also
     ........

     The *note scandir(): 25d. function returns directory entries along
     with file attribute information, giving better performance for many
     common use cases.

     Changed in version 3.2: The `path' parameter became optional.

     New in version 3.3: Added support for specifying `path' as an open
     file descriptor.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.lstat (path, *, dir_fd=None)

     Perform the equivalent of an ‘lstat()’ system call on the given
     path.  Similar to *note stat(): 1ef, but does not follow symbolic
     links.  Return a *note stat_result: fc2. object.

     On platforms that do not support symbolic links, this is an alias
     for *note stat(): 1ef.

     As of Python 3.3, this is equivalent to ‘os.stat(path,
     dir_fd=dir_fd, follow_symlinks=False)’.

     This function can also support *note paths relative to directory
     descriptors: a24.

     See also
     ........

     The *note stat(): 1ef. function.

     Changed in version 3.2: Added support for Windows 6.0 (Vista)
     symbolic links.

     Changed in version 3.3: Added the `dir_fd' parameter.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `src' and `dst'.

     Changed in version 3.8: On Windows, now opens reparse points that
     represent another path (name surrogates), including symbolic links
     and directory junctions.  Other kinds of reparse points are
     resolved by the operating system as for *note stat(): 1ef.

 -- Function: os.mkdir (path, mode=0o777, *, dir_fd=None)

     Create a directory named `path' with numeric mode `mode'.

     If the directory already exists, *note FileExistsError: 94c. is
     raised.  On some systems, `mode' is ignored.  Where it is used, the
     current umask value is first masked out.  If bits other than the
     last 9 (i.e.  the last 3 digits of the octal representation of the
     `mode') are set, their meaning is platform-dependent.  On some
     platforms, they are ignored and you should call *note chmod(): a28.
     explicitly to set them.

     This function can also support *note paths relative to directory
     descriptors: a24.

     It is also possible to create temporary directories; see the *note
     tempfile: 103. module’s *note tempfile.mkdtemp(): 1ba1. function.

     New in version 3.3: The `dir_fd' argument.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.makedirs (name, mode=0o777, exist_ok=False)

     Recursive directory creation function.  Like *note mkdir(): a2b,
     but makes all intermediate-level directories needed to contain the
     leaf directory.

     The `mode' parameter is passed to *note mkdir(): a2b. for creating
     the leaf directory; see *note the mkdir() description: 1e8c. for
     how it is interpreted.  To set the file permission bits of any
     newly-created parent directories you can set the umask before
     invoking *note makedirs(): 3b2.  The file permission bits of
     existing parent directories are not changed.

     If `exist_ok' is ‘False’ (the default), an *note FileExistsError:
     94c. is raised if the target directory already exists.

          Note: *note makedirs(): 3b2. will become confused if the path
          elements to create include *note pardir: 1e8d. (eg.  “..” on
          UNIX systems).

     This function handles UNC paths correctly.

     New in version 3.2: The `exist_ok' parameter.

     Changed in version 3.4.1: Before Python 3.4.1, if `exist_ok' was
     ‘True’ and the directory existed, *note makedirs(): 3b2. would
     still raise an error if `mode' did not match the mode of the
     existing directory.  Since this behavior was impossible to
     implement safely, it was removed in Python 3.4.1.  See
     bpo-21082(2).

     Changed in version 3.6: Accepts a *note path-like object: 35f.

     Changed in version 3.7: The `mode' argument no longer affects the
     file permission bits of newly-created intermediate-level
     directories.

 -- Function: os.mkfifo (path, mode=0o666, *, dir_fd=None)

     Create a FIFO (a named pipe) named `path' with numeric mode `mode'.
     The current umask value is first masked out from the mode.

     This function can also support *note paths relative to directory
     descriptors: a24.

     FIFOs are pipes that can be accessed like regular files.  FIFOs
     exist until they are deleted (for example with *note os.unlink():
     a31.).  Generally, FIFOs are used as rendezvous between “client”
     and “server” type processes: the server opens the FIFO for reading,
     and the client opens it for writing.  Note that *note mkfifo():
     657. doesn’t open the FIFO — it just creates the rendezvous point.

     *note Availability: 129a.: Unix.

     New in version 3.3: The `dir_fd' argument.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.mknod (path, mode=0o600, device=0, *, dir_fd=None)

     Create a filesystem node (file, device special file or named pipe)
     named `path'.  `mode' specifies both the permissions to use and the
     type of node to be created, being combined (bitwise OR) with one of
     ‘stat.S_IFREG’, ‘stat.S_IFCHR’, ‘stat.S_IFBLK’, and ‘stat.S_IFIFO’
     (those constants are available in *note stat: f4.).  For
     ‘stat.S_IFCHR’ and ‘stat.S_IFBLK’, `device' defines the newly
     created device special file (probably using *note os.makedev():
     1e8e.), otherwise it is ignored.

     This function can also support *note paths relative to directory
     descriptors: a24.

     *note Availability: 129a.: Unix.

     New in version 3.3: The `dir_fd' argument.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.major (device)

     Extract the device major number from a raw device number (usually
     the ‘st_dev’ or ‘st_rdev’ field from ‘stat’).

 -- Function: os.minor (device)

     Extract the device minor number from a raw device number (usually
     the ‘st_dev’ or ‘st_rdev’ field from ‘stat’).

 -- Function: os.makedev (major, minor)

     Compose a raw device number from the major and minor device
     numbers.

 -- Function: os.pathconf (path, name)

     Return system configuration information relevant to a named file.
     `name' specifies the configuration value to retrieve; it may be a
     string which is the name of a defined system value; these names are
     specified in a number of standards (POSIX.1, Unix 95, Unix 98, and
     others).  Some platforms define additional names as well.  The
     names known to the host operating system are given in the
     ‘pathconf_names’ dictionary.  For configuration variables not
     included in that mapping, passing an integer for `name' is also
     accepted.

     If `name' is a string and is not known, *note ValueError: 1f9. is
     raised.  If a specific value for `name' is not supported by the
     host system, even if it is included in ‘pathconf_names’, an *note
     OSError: 1d1. is raised with *note errno.EINVAL: efb. for the error
     number.

     This function can support *note specifying a file descriptor: 3aa.

     *note Availability: 129a.: Unix.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Data: os.pathconf_names

     Dictionary mapping names accepted by *note pathconf(): a37. and
     *note fpathconf(): 1e4c. to the integer values defined for those
     names by the host operating system.  This can be used to determine
     the set of names known to the system.

     *note Availability: 129a.: Unix.

 -- Function: os.readlink (path, *, dir_fd=None)

     Return a string representing the path to which the symbolic link
     points.  The result may be either an absolute or relative pathname;
     if it is relative, it may be converted to an absolute pathname
     using ‘os.path.join(os.path.dirname(path), result)’.

     If the `path' is a string object (directly or indirectly through a
     *note PathLike: 4e0. interface), the result will also be a string
     object, and the call may raise a UnicodeDecodeError.  If the `path'
     is a bytes object (direct or indirectly), the result will be a
     bytes object.

     This function can also support *note paths relative to directory
     descriptors: a24.

     When trying to resolve a path that may contain links, use *note
     realpath(): 1fd. to properly handle recursion and platform
     differences.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.2: Added support for Windows 6.0 (Vista)
     symbolic links.

     New in version 3.3: The `dir_fd' argument.

     Changed in version 3.6: Accepts a *note path-like object: 35f. on
     Unix.

     Changed in version 3.8: Accepts a *note path-like object: 35f. and
     a bytes object on Windows.

     Changed in version 3.8: Added support for directory junctions, and
     changed to return the substitution path (which typically includes
     ‘\\?\’ prefix) rather than the optional “print name” field that was
     previously returned.

 -- Function: os.remove (path, *, dir_fd=None)

     Remove (delete) the file `path'.  If `path' is a directory, an
     *note IsADirectoryError: 98d. is raised.  Use *note rmdir(): a2f.
     to remove directories.

     This function can support *note paths relative to directory
     descriptors: a24.

     On Windows, attempting to remove a file that is in use causes an
     exception to be raised; on Unix, the directory entry is removed but
     the storage allocated to the file is not made available until the
     original file is no longer in use.

     This function is semantically identical to *note unlink(): a31.

     New in version 3.3: The `dir_fd' argument.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.removedirs (name)

     Remove directories recursively.  Works like *note rmdir(): a2f.
     except that, if the leaf directory is successfully removed, *note
     removedirs(): 1e92. tries to successively remove every parent
     directory mentioned in `path' until an error is raised (which is
     ignored, because it generally means that a parent directory is not
     empty).  For example, ‘os.removedirs('foo/bar/baz')’ will first
     remove the directory ‘'foo/bar/baz'’, and then remove ‘'foo/bar'’
     and ‘'foo'’ if they are empty.  Raises *note OSError: 1d1. if the
     leaf directory could not be successfully removed.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.rename (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

     Rename the file or directory `src' to `dst'.  If `dst' exists, the
     operation will fail with an *note OSError: 1d1. subclass in a
     number of cases:

     On Windows, if `dst' exists a *note FileExistsError: 94c. is always
     raised.

     On Unix, if `src' is a file and `dst' is a directory or vice-versa,
     an *note IsADirectoryError: 98d. or a *note NotADirectoryError:
     98e. will be raised respectively.  If both are directories and
     `dst' is empty, `dst' will be silently replaced.  If `dst' is a
     non-empty directory, an *note OSError: 1d1. is raised.  If both are
     files, `dst' it will be replaced silently if the user has
     permission.  The operation may fail on some Unix flavors if `src'
     and `dst' are on different filesystems.  If successful, the
     renaming will be an atomic operation (this is a POSIX requirement).

     This function can support specifying `src_dir_fd' and/or
     `dst_dir_fd' to supply *note paths relative to directory
     descriptors: a24.

     If you want cross-platform overwriting of the destination, use
     *note replace(): a2e.

     New in version 3.3: The `src_dir_fd' and `dst_dir_fd' arguments.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `src' and `dst'.

 -- Function: os.renames (old, new)

     Recursive directory or file renaming function.  Works like *note
     rename(): a2d, except creation of any intermediate directories
     needed to make the new pathname good is attempted first.  After the
     rename, directories corresponding to rightmost path segments of the
     old name will be pruned away using *note removedirs(): 1e92.

          Note: This function can fail with the new directory structure
          made if you lack permissions needed to remove the leaf
          directory or file.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `old' and `new'.

 -- Function: os.replace (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

     Rename the file or directory `src' to `dst'.  If `dst' is a
     directory, *note OSError: 1d1. will be raised.  If `dst' exists and
     is a file, it will be replaced silently if the user has permission.
     The operation may fail if `src' and `dst' are on different
     filesystems.  If successful, the renaming will be an atomic
     operation (this is a POSIX requirement).

     This function can support specifying `src_dir_fd' and/or
     `dst_dir_fd' to supply *note paths relative to directory
     descriptors: a24.

     New in version 3.3.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `src' and `dst'.

 -- Function: os.rmdir (path, *, dir_fd=None)

     Remove (delete) the directory `path'.  If the directory does not
     exist or is not empty, an *note FileNotFoundError: 7b4. or an *note
     OSError: 1d1. is raised respectively.  In order to remove whole
     directory trees, *note shutil.rmtree(): 21a. can be used.

     This function can support *note paths relative to directory
     descriptors: a24.

     New in version 3.3: The `dir_fd' parameter.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.scandir (path='.')

     Return an iterator of *note os.DirEntry: 4e6. objects corresponding
     to the entries in the directory given by `path'.  The entries are
     yielded in arbitrary order, and the special entries ‘'.'’ and
     ‘'..'’ are not included.

     Using *note scandir(): 25d. instead of *note listdir(): a36. can
     significantly increase the performance of code that also needs file
     type or file attribute information, because *note os.DirEntry: 4e6.
     objects expose this information if the operating system provides it
     when scanning a directory.  All *note os.DirEntry: 4e6. methods may
     perform a system call, but *note is_dir(): 1e94. and *note
     is_file(): 649. usually only require a system call for symbolic
     links; *note os.DirEntry.stat(): 1e95. always requires a system
     call on Unix but only requires one for symbolic links on Windows.

     `path' may be a *note path-like object: 35f.  If `path' is of type
     ‘bytes’ (directly or indirectly through the *note PathLike: 4e0.
     interface), the type of the *note name: 1e96. and *note path: 1e97.
     attributes of each *note os.DirEntry: 4e6. will be ‘bytes’; in all
     other circumstances, they will be of type ‘str’.

     This function can also support *note specifying a file descriptor:
     3aa.; the file descriptor must refer to a directory.

     Raises an *note auditing event: 1275. ‘os.scandir’ with argument
     ‘path’.

     The *note scandir(): 25d. iterator supports the *note context
     manager: 55d. protocol and has the following method:

      -- Method: scandir.close ()

          Close the iterator and free acquired resources.

          This is called automatically when the iterator is exhausted or
          garbage collected, or when an error happens during iterating.
          However it is advisable to call it explicitly or use the *note
          with: 6dd. statement.

          New in version 3.6.

     The following example shows a simple use of *note scandir(): 25d.
     to display all the files (excluding directories) in the given
     `path' that don’t start with ‘'.'’.  The ‘entry.is_file()’ call
     will generally not make an additional system call:

          with os.scandir(path) as it:
              for entry in it:
                  if not entry.name.startswith('.') and entry.is_file():
                      print(entry.name)

          Note: On Unix-based systems, *note scandir(): 25d. uses the
          system’s opendir()(3) and readdir()(4) functions.  On Windows,
          it uses the Win32 FindFirstFileW(5) and FindNextFileW(6)
          functions.

     New in version 3.5.

     New in version 3.6: Added support for the *note context manager:
     55d. protocol and the *note close(): 55c. method.  If a *note
     scandir(): 25d. iterator is neither exhausted nor explicitly closed
     a *note ResourceWarning: 4c5. will be emitted in its destructor.

     The function accepts a *note path-like object: 35f.

     Changed in version 3.7: Added support for *note file descriptors:
     3aa. on Unix.

 -- Class: os.DirEntry

     Object yielded by *note scandir(): 25d. to expose the file path and
     other file attributes of a directory entry.

     *note scandir(): 25d. will provide as much of this information as
     possible without making additional system calls.  When a ‘stat()’
     or ‘lstat()’ system call is made, the ‘os.DirEntry’ object will
     cache the result.

     ‘os.DirEntry’ instances are not intended to be stored in long-lived
     data structures; if you know the file metadata has changed or if a
     long time has elapsed since calling *note scandir(): 25d, call
     ‘os.stat(entry.path)’ to fetch up-to-date information.

     Because the ‘os.DirEntry’ methods can make operating system calls,
     they may also raise *note OSError: 1d1.  If you need very
     fine-grained control over errors, you can catch *note OSError: 1d1.
     when calling one of the ‘os.DirEntry’ methods and handle as
     appropriate.

     To be directly usable as a *note path-like object: 35f,
     ‘os.DirEntry’ implements the *note PathLike: 4e0. interface.

     Attributes and methods on a ‘os.DirEntry’ instance are as follows:

      -- Attribute: name

          The entry’s base filename, relative to the *note scandir():
          25d. `path' argument.

          The *note name: 1e1b. attribute will be ‘bytes’ if the *note
          scandir(): 25d. `path' argument is of type ‘bytes’ and ‘str’
          otherwise.  Use *note fsdecode(): 4e3. to decode byte
          filenames.

      -- Attribute: path

          The entry’s full path name: equivalent to
          ‘os.path.join(scandir_path, entry.name)’ where `scandir_path'
          is the *note scandir(): 25d. `path' argument.  The path is
          only absolute if the *note scandir(): 25d. `path' argument was
          absolute.  If the *note scandir(): 25d. `path' argument was a
          *note file descriptor: 3aa, the *note path: c5. attribute is
          the same as the *note name: 1e1b. attribute.

          The *note path: c5. attribute will be ‘bytes’ if the *note
          scandir(): 25d. `path' argument is of type ‘bytes’ and ‘str’
          otherwise.  Use *note fsdecode(): 4e3. to decode byte
          filenames.

      -- Method: inode ()

          Return the inode number of the entry.

          The result is cached on the ‘os.DirEntry’ object.  Use
          ‘os.stat(entry.path, follow_symlinks=False).st_ino’ to fetch
          up-to-date information.

          On the first, uncached call, a system call is required on
          Windows but not on Unix.

      -- Method: is_dir (*, follow_symlinks=True)

          Return ‘True’ if this entry is a directory or a symbolic link
          pointing to a directory; return ‘False’ if the entry is or
          points to any other kind of file, or if it doesn’t exist
          anymore.

          If `follow_symlinks' is ‘False’, return ‘True’ only if this
          entry is a directory (without following symlinks); return
          ‘False’ if the entry is any other kind of file or if it
          doesn’t exist anymore.

          The result is cached on the ‘os.DirEntry’ object, with a
          separate cache for `follow_symlinks' ‘True’ and ‘False’.  Call
          *note os.stat(): 1ef. along with *note stat.S_ISDIR(): 1b3a.
          to fetch up-to-date information.

          On the first, uncached call, no system call is required in
          most cases.  Specifically, for non-symlinks, neither Windows
          or Unix require a system call, except on certain Unix file
          systems, such as network file systems, that return
          ‘dirent.d_type == DT_UNKNOWN’.  If the entry is a symlink, a
          system call will be required to follow the symlink unless
          `follow_symlinks' is ‘False’.

          This method can raise *note OSError: 1d1, such as *note
          PermissionError: 5f4, but *note FileNotFoundError: 7b4. is
          caught and not raised.

      -- Method: is_file (*, follow_symlinks=True)

          Return ‘True’ if this entry is a file or a symbolic link
          pointing to a file; return ‘False’ if the entry is or points
          to a directory or other non-file entry, or if it doesn’t exist
          anymore.

          If `follow_symlinks' is ‘False’, return ‘True’ only if this
          entry is a file (without following symlinks); return ‘False’
          if the entry is a directory or other non-file entry, or if it
          doesn’t exist anymore.

          The result is cached on the ‘os.DirEntry’ object.  Caching,
          system calls made, and exceptions raised are as per *note
          is_dir(): 1e94.

      -- Method: is_symlink ()

          Return ‘True’ if this entry is a symbolic link (even if
          broken); return ‘False’ if the entry points to a directory or
          any kind of file, or if it doesn’t exist anymore.

          The result is cached on the ‘os.DirEntry’ object.  Call *note
          os.path.islink(): 1f2. to fetch up-to-date information.

          On the first, uncached call, no system call is required in
          most cases.  Specifically, neither Windows or Unix require a
          system call, except on certain Unix file systems, such as
          network file systems, that return ‘dirent.d_type ==
          DT_UNKNOWN’.

          This method can raise *note OSError: 1d1, such as *note
          PermissionError: 5f4, but *note FileNotFoundError: 7b4. is
          caught and not raised.

      -- Method: stat (*, follow_symlinks=True)

          Return a *note stat_result: fc2. object for this entry.  This
          method follows symbolic links by default; to stat a symbolic
          link add the ‘follow_symlinks=False’ argument.

          On Unix, this method always requires a system call.  On
          Windows, it only requires a system call if `follow_symlinks'
          is ‘True’ and the entry is a reparse point (for example, a
          symbolic link or directory junction).

          On Windows, the ‘st_ino’, ‘st_dev’ and ‘st_nlink’ attributes
          of the *note stat_result: fc2. are always set to zero.  Call
          *note os.stat(): 1ef. to get these attributes.

          The result is cached on the ‘os.DirEntry’ object, with a
          separate cache for `follow_symlinks' ‘True’ and ‘False’.  Call
          *note os.stat(): 1ef. to fetch up-to-date information.

     Note that there is a nice correspondence between several attributes
     and methods of ‘os.DirEntry’ and of *note pathlib.Path: 1ff.  In
     particular, the ‘name’ attribute has the same meaning, as do the
     ‘is_dir()’, ‘is_file()’, ‘is_symlink()’ and ‘stat()’ methods.

     New in version 3.5.

     Changed in version 3.6: Added support for the *note PathLike: 4e0.
     interface.  Added support for *note bytes: 326. paths on Windows.

 -- Function: os.stat (path, *, dir_fd=None, follow_symlinks=True)

     Get the status of a file or a file descriptor.  Perform the
     equivalent of a ‘stat()’ system call on the given path.  `path' may
     be specified as either a string or bytes – directly or indirectly
     through the *note PathLike: 4e0. interface – or as an open file
     descriptor.  Return a *note stat_result: fc2. object.

     This function normally follows symlinks; to stat a symlink add the
     argument ‘follow_symlinks=False’, or use *note lstat(): 1f0.

     This function can support *note specifying a file descriptor: 3aa.
     and *note not following symlinks: a25.

     On Windows, passing ‘follow_symlinks=False’ will disable following
     all name-surrogate reparse points, which includes symlinks and
     directory junctions.  Other types of reparse points that do not
     resemble links or that the operating system is unable to follow
     will be opened directly.  When following a chain of multiple links,
     this may result in the original link being returned instead of the
     non-link that prevented full traversal.  To obtain stat results for
     the final path in this case, use the *note os.path.realpath(): 1fd.
     function to resolve the path name as far as possible and call *note
     lstat(): 1f0. on the result.  This does not apply to dangling
     symlinks or junction points, which will raise the usual exceptions.

     Example:

          >>> import os
          >>> statinfo = os.stat('somefile.txt')
          >>> statinfo
          os.stat_result(st_mode=33188, st_ino=7876932, st_dev=234881026,
          st_nlink=1, st_uid=501, st_gid=501, st_size=264, st_atime=1297230295,
          st_mtime=1297230027, st_ctime=1297230027)
          >>> statinfo.st_size
          264

     See also
     ........

     *note fstat(): 653. and *note lstat(): 1f0. functions.

     New in version 3.3: Added the `dir_fd' and `follow_symlinks'
     arguments, specifying a file descriptor instead of a path.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

     Changed in version 3.8: On Windows, all reparse points that can be
     resolved by the operating system are now followed, and passing
     ‘follow_symlinks=False’ disables following all name surrogate
     reparse points.  If the operating system reaches a reparse point
     that it is not able to follow, `stat' now returns the information
     for the original path as if ‘follow_symlinks=False’ had been
     specified instead of raising an error.

 -- Class: os.stat_result

     Object whose attributes correspond roughly to the members of the
     ‘stat’ structure.  It is used for the result of *note os.stat():
     1ef, *note os.fstat(): 653. and *note os.lstat(): 1f0.

     Attributes:

      -- Attribute: st_mode

          File mode: file type and file mode bits (permissions).

      -- Attribute: st_ino

          Platform dependent, but if non-zero, uniquely identifies the
          file for a given value of ‘st_dev’.  Typically:

             * the inode number on Unix,

             * the file index(7) on Windows

      -- Attribute: st_dev

          Identifier of the device on which this file resides.

      -- Attribute: st_nlink

          Number of hard links.

      -- Attribute: st_uid

          User identifier of the file owner.

      -- Attribute: st_gid

          Group identifier of the file owner.

      -- Attribute: st_size

          Size of the file in bytes, if it is a regular file or a
          symbolic link.  The size of a symbolic link is the length of
          the pathname it contains, without a terminating null byte.

     Timestamps:

      -- Attribute: st_atime

          Time of most recent access expressed in seconds.

      -- Attribute: st_mtime

          Time of most recent content modification expressed in seconds.

      -- Attribute: st_ctime

          Platform dependent:

             * the time of most recent metadata change on Unix,

             * the time of creation on Windows, expressed in seconds.

      -- Attribute: st_atime_ns

          Time of most recent access expressed in nanoseconds as an
          integer.

      -- Attribute: st_mtime_ns

          Time of most recent content modification expressed in
          nanoseconds as an integer.

      -- Attribute: st_ctime_ns

          Platform dependent:

             * the time of most recent metadata change on Unix,

             * the time of creation on Windows, expressed in nanoseconds
               as an integer.

          Note: The exact meaning and resolution of the *note st_atime:
          1ea1, *note st_mtime: 1c8f, and *note st_ctime: 1ea2.
          attributes depend on the operating system and the file system.
          For example, on Windows systems using the FAT or FAT32 file
          systems, *note st_mtime: 1c8f. has 2-second resolution, and
          *note st_atime: 1ea1. has only 1-day resolution.  See your
          operating system documentation for details.

          Similarly, although *note st_atime_ns: 1ea3, *note
          st_mtime_ns: 1ea4, and *note st_ctime_ns: 1ea5. are always
          expressed in nanoseconds, many systems do not provide
          nanosecond precision.  On systems that do provide nanosecond
          precision, the floating-point object used to store *note
          st_atime: 1ea1, *note st_mtime: 1c8f, and *note st_ctime:
          1ea2. cannot preserve all of it, and as such will be slightly
          inexact.  If you need the exact timestamps you should always
          use *note st_atime_ns: 1ea3, *note st_mtime_ns: 1ea4, and
          *note st_ctime_ns: 1ea5.

     On some Unix systems (such as Linux), the following attributes may
     also be available:

      -- Attribute: st_blocks

          Number of 512-byte blocks allocated for file.  This may be
          smaller than *note st_size: 1ea0./512 when the file has holes.

      -- Attribute: st_blksize

          “Preferred” blocksize for efficient file system I/O. Writing
          to a file in smaller chunks may cause an inefficient
          read-modify-rewrite.

      -- Attribute: st_rdev

          Type of device if an inode device.

      -- Attribute: st_flags

          User defined flags for file.

     On other Unix systems (such as FreeBSD), the following attributes
     may be available (but may be only filled out if root tries to use
     them):

      -- Attribute: st_gen

          File generation number.

      -- Attribute: st_birthtime

          Time of file creation.

     On Solaris and derivatives, the following attributes may also be
     available:

      -- Attribute: st_fstype

          String that uniquely identifies the type of the filesystem
          that contains the file.

     On Mac OS systems, the following attributes may also be available:

      -- Attribute: st_rsize

          Real size of the file.

      -- Attribute: st_creator

          Creator of the file.

      -- Attribute: st_type

          File type.

     On Windows systems, the following attributes are also available:

      -- Attribute: st_file_attributes

          Windows file attributes: ‘dwFileAttributes’ member of the
          ‘BY_HANDLE_FILE_INFORMATION’ structure returned by
          ‘GetFileInformationByHandle()’.  See the ‘FILE_ATTRIBUTE_*’
          constants in the *note stat: f4. module.

      -- Attribute: st_reparse_tag

          When *note st_file_attributes: 714. has the
          ‘FILE_ATTRIBUTE_REPARSE_POINT’ set, this field contains the
          tag identifying the type of reparse point.  See the
          ‘IO_REPARSE_TAG_*’ constants in the *note stat: f4. module.

     The standard module *note stat: f4. defines functions and constants
     that are useful for extracting information from a ‘stat’ structure.
     (On Windows, some items are filled with dummy values.)

     For backward compatibility, a *note stat_result: fc2. instance is
     also accessible as a tuple of at least 10 integers giving the most
     important (and portable) members of the ‘stat’ structure, in the
     order *note st_mode: 1e9a, *note st_ino: 1e9b, *note st_dev: 1e9c,
     *note st_nlink: 1e9d, *note st_uid: 1e9e, *note st_gid: 1e9f, *note
     st_size: 1ea0, *note st_atime: 1ea1, *note st_mtime: 1c8f, *note
     st_ctime: 1ea2.  More items may be added at the end by some
     implementations.  For compatibility with older Python versions,
     accessing *note stat_result: fc2. as a tuple always returns
     integers.

     New in version 3.3: Added the *note st_atime_ns: 1ea3, *note
     st_mtime_ns: 1ea4, and *note st_ctime_ns: 1ea5. members.

     New in version 3.5: Added the *note st_file_attributes: 714. member
     on Windows.

     Changed in version 3.5: Windows now returns the file index as *note
     st_ino: 1e9b. when available.

     New in version 3.7: Added the *note st_fstype: 3b4. member to
     Solaris/derivatives.

     New in version 3.8: Added the *note st_reparse_tag: 1eaf. member on
     Windows.

     Changed in version 3.8: On Windows, the *note st_mode: 1e9a. member
     now identifies special files as ‘S_IFCHR’, ‘S_IFIFO’ or ‘S_IFBLK’
     as appropriate.

 -- Function: os.statvfs (path)

     Perform a ‘statvfs()’ system call on the given path.  The return
     value is an object whose attributes describe the filesystem on the
     given path, and correspond to the members of the ‘statvfs’
     structure, namely: ‘f_bsize’, ‘f_frsize’, ‘f_blocks’, ‘f_bfree’,
     ‘f_bavail’, ‘f_files’, ‘f_ffree’, ‘f_favail’, ‘f_flag’,
     ‘f_namemax’, ‘f_fsid’.

     Two module-level constants are defined for the ‘f_flag’ attribute’s
     bit-flags: if ‘ST_RDONLY’ is set, the filesystem is mounted
     read-only, and if ‘ST_NOSUID’ is set, the semantics of
     setuid/setgid bits are disabled or not supported.

     Additional module-level constants are defined for GNU/glibc based
     systems.  These are ‘ST_NODEV’ (disallow access to device special
     files), ‘ST_NOEXEC’ (disallow program execution), ‘ST_SYNCHRONOUS’
     (writes are synced at once), ‘ST_MANDLOCK’ (allow mandatory locks
     on an FS), ‘ST_WRITE’ (write on file/directory/symlink),
     ‘ST_APPEND’ (append-only file), ‘ST_IMMUTABLE’ (immutable file),
     ‘ST_NOATIME’ (do not update access times), ‘ST_NODIRATIME’ (do not
     update directory access times), ‘ST_RELATIME’ (update atime
     relative to mtime/ctime).

     This function can support *note specifying a file descriptor: 3aa.

     *note Availability: 129a.: Unix.

     Changed in version 3.2: The ‘ST_RDONLY’ and ‘ST_NOSUID’ constants
     were added.

     New in version 3.3: Added support for specifying `path' as an open
     file descriptor.

     Changed in version 3.4: The ‘ST_NODEV’, ‘ST_NOEXEC’,
     ‘ST_SYNCHRONOUS’, ‘ST_MANDLOCK’, ‘ST_WRITE’, ‘ST_APPEND’,
     ‘ST_IMMUTABLE’, ‘ST_NOATIME’, ‘ST_NODIRATIME’, and ‘ST_RELATIME’
     constants were added.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

     New in version 3.7: Added ‘f_fsid’.

 -- Data: os.supports_dir_fd

     A *note set: b62. object indicating which functions in the *note
     os: c4. module accept an open file descriptor for their `dir_fd'
     parameter.  Different platforms provide different features, and the
     underlying functionality Python uses to implement the `dir_fd'
     parameter is not available on all platforms Python supports.  For
     consistency’s sake, functions that may support `dir_fd' always
     allow specifying the parameter, but will throw an exception if the
     functionality is used when it’s not locally available.  (Specifying
     ‘None’ for `dir_fd' is always supported on all platforms.)

     To check whether a particular function accepts an open file
     descriptor for its `dir_fd' parameter, use the ‘in’ operator on
     ‘supports_dir_fd’.  As an example, this expression evaluates to
     ‘True’ if *note os.stat(): 1ef. accepts open file descriptors for
     `dir_fd' on the local platform:

          os.stat in os.supports_dir_fd

     Currently `dir_fd' parameters only work on Unix platforms; none of
     them work on Windows.

     New in version 3.3.

 -- Data: os.supports_effective_ids

     A *note set: b62. object indicating whether *note os.access(): a26.
     permits specifying ‘True’ for its `effective_ids' parameter on the
     local platform.  (Specifying ‘False’ for `effective_ids' is always
     supported on all platforms.)  If the local platform supports it,
     the collection will contain *note os.access(): a26.; otherwise it
     will be empty.

     This expression evaluates to ‘True’ if *note os.access(): a26.
     supports ‘effective_ids=True’ on the local platform:

          os.access in os.supports_effective_ids

     Currently `effective_ids' is only supported on Unix platforms; it
     does not work on Windows.

     New in version 3.3.

 -- Data: os.supports_fd

     A *note set: b62. object indicating which functions in the *note
     os: c4. module permit specifying their `path' parameter as an open
     file descriptor on the local platform.  Different platforms provide
     different features, and the underlying functionality Python uses to
     accept open file descriptors as `path' arguments is not available
     on all platforms Python supports.

     To determine whether a particular function permits specifying an
     open file descriptor for its `path' parameter, use the ‘in’
     operator on ‘supports_fd’.  As an example, this expression
     evaluates to ‘True’ if *note os.chdir(): a34. accepts open file
     descriptors for `path' on your local platform:

          os.chdir in os.supports_fd

     New in version 3.3.

 -- Data: os.supports_follow_symlinks

     A *note set: b62. object indicating which functions in the *note
     os: c4. module accept ‘False’ for their `follow_symlinks' parameter
     on the local platform.  Different platforms provide different
     features, and the underlying functionality Python uses to implement
     `follow_symlinks' is not available on all platforms Python
     supports.  For consistency’s sake, functions that may support
     `follow_symlinks' always allow specifying the parameter, but will
     throw an exception if the functionality is used when it’s not
     locally available.  (Specifying ‘True’ for `follow_symlinks' is
     always supported on all platforms.)

     To check whether a particular function accepts ‘False’ for its
     `follow_symlinks' parameter, use the ‘in’ operator on
     ‘supports_follow_symlinks’.  As an example, this expression
     evaluates to ‘True’ if you may specify ‘follow_symlinks=False’ when
     calling *note os.stat(): 1ef. on the local platform:

          os.stat in os.supports_follow_symlinks

     New in version 3.3.

 -- Function: os.symlink (src, dst, target_is_directory=False, *,
          dir_fd=None)

     Create a symbolic link pointing to `src' named `dst'.

     On Windows, a symlink represents either a file or a directory, and
     does not morph to the target dynamically.  If the target is
     present, the type of the symlink will be created to match.
     Otherwise, the symlink will be created as a directory if
     `target_is_directory' is ‘True’ or a file symlink (the default)
     otherwise.  On non-Windows platforms, `target_is_directory' is
     ignored.

     This function can support *note paths relative to directory
     descriptors: a24.

          Note: On newer versions of Windows 10, unprivileged accounts
          can create symlinks if Developer Mode is enabled.  When
          Developer Mode is not available/enabled, the
          `SeCreateSymbolicLinkPrivilege' privilege is required, or the
          process must be run as an administrator.

          *note OSError: 1d1. is raised when the function is called by
          an unprivileged user.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.2: Added support for Windows 6.0 (Vista)
     symbolic links.

     New in version 3.3: Added the `dir_fd' argument, and now allow
     `target_is_directory' on non-Windows platforms.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `src' and `dst'.

     Changed in version 3.8: Added support for unelevated symlinks on
     Windows with Developer Mode.

 -- Function: os.sync ()

     Force write of everything to disk.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.truncate (path, length)

     Truncate the file corresponding to `path', so that it is at most
     `length' bytes in size.

     This function can support *note specifying a file descriptor: 3aa.

     Raises an *note auditing event: 1275. ‘os.truncate’ with arguments
     ‘path’, ‘length’.

     *note Availability: 129a.: Unix, Windows.

     New in version 3.3.

     Changed in version 3.5: Added support for Windows

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.unlink (path, *, dir_fd=None)

     Remove (delete) the file `path'.  This function is semantically
     identical to *note remove(): a2c.; the ‘unlink’ name is its
     traditional Unix name.  Please see the documentation for *note
     remove(): a2c. for further information.

     New in version 3.3: The `dir_fd' parameter.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.utime (path, times=None, *[, ns], dir_fd=None,
          follow_symlinks=True)

     Set the access and modified times of the file specified by `path'.

     *note utime(): a32. takes two optional parameters, `times' and
     `ns'.  These specify the times set on `path' and are used as
     follows:

        - If `ns' is specified, it must be a 2-tuple of the form
          ‘(atime_ns, mtime_ns)’ where each member is an int expressing
          nanoseconds.

        - If `times' is not ‘None’, it must be a 2-tuple of the form
          ‘(atime, mtime)’ where each member is an int or float
          expressing seconds.

        - If `times' is ‘None’ and `ns' is unspecified, this is
          equivalent to specifying ‘ns=(atime_ns, mtime_ns)’ where both
          times are the current time.

     It is an error to specify tuples for both `times' and `ns'.

     Note that the exact times you set here may not be returned by a
     subsequent *note stat(): 1ef. call, depending on the resolution
     with which your operating system records access and modification
     times; see *note stat(): 1ef.  The best way to preserve exact times
     is to use the `st_atime_ns' and `st_mtime_ns' fields from the *note
     os.stat(): 1ef. result object with the `ns' parameter to ‘utime’.

     This function can support *note specifying a file descriptor: 3aa,
     *note paths relative to directory descriptors: a24. and *note not
     following symlinks: a25.

     New in version 3.3: Added support for specifying `path' as an open
     file descriptor, and the `dir_fd', `follow_symlinks', and `ns'
     parameters.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.walk (top, topdown=True, onerror=None,
          followlinks=False)

     Generate the file names in a directory tree by walking the tree
     either top-down or bottom-up.  For each directory in the tree
     rooted at directory `top' (including `top' itself), it yields a
     3-tuple ‘(dirpath, dirnames, filenames)’.

     `dirpath' is a string, the path to the directory.  `dirnames' is a
     list of the names of the subdirectories in `dirpath' (excluding
     ‘'.'’ and ‘'..'’).  `filenames' is a list of the names of the
     non-directory files in `dirpath'.  Note that the names in the lists
     contain no path components.  To get a full path (which begins with
     `top') to a file or directory in `dirpath', do
     ‘os.path.join(dirpath, name)’.

     If optional argument `topdown' is ‘True’ or not specified, the
     triple for a directory is generated before the triples for any of
     its subdirectories (directories are generated top-down).  If
     `topdown' is ‘False’, the triple for a directory is generated after
     the triples for all of its subdirectories (directories are
     generated bottom-up).  No matter the value of `topdown', the list
     of subdirectories is retrieved before the tuples for the directory
     and its subdirectories are generated.

     When `topdown' is ‘True’, the caller can modify the `dirnames' list
     in-place (perhaps using *note del: 11a8. or slice assignment), and
     *note walk(): 648. will only recurse into the subdirectories whose
     names remain in `dirnames'; this can be used to prune the search,
     impose a specific order of visiting, or even to inform *note
     walk(): 648. about directories the caller creates or renames before
     it resumes *note walk(): 648. again.  Modifying `dirnames' when
     `topdown' is ‘False’ has no effect on the behavior of the walk,
     because in bottom-up mode the directories in `dirnames' are
     generated before `dirpath' itself is generated.

     By default, errors from the *note scandir(): 25d. call are ignored.
     If optional argument `onerror' is specified, it should be a
     function; it will be called with one argument, an *note OSError:
     1d1. instance.  It can report the error to continue with the walk,
     or raise the exception to abort the walk.  Note that the filename
     is available as the ‘filename’ attribute of the exception object.

     By default, *note walk(): 648. will not walk down into symbolic
     links that resolve to directories.  Set `followlinks' to ‘True’ to
     visit directories pointed to by symlinks, on systems that support
     them.

          Note: Be aware that setting `followlinks' to ‘True’ can lead
          to infinite recursion if a link points to a parent directory
          of itself.  *note walk(): 648. does not keep track of the
          directories it visited already.

          Note: If you pass a relative pathname, don’t change the
          current working directory between resumptions of *note walk():
          648.  *note walk(): 648. never changes the current directory,
          and assumes that its caller doesn’t either.

     This example displays the number of bytes taken by non-directory
     files in each directory under the starting directory, except that
     it doesn’t look under any CVS subdirectory:

          import os
          from os.path import join, getsize
          for root, dirs, files in os.walk('python/Lib/email'):
              print(root, "consumes", end=" ")
              print(sum(getsize(join(root, name)) for name in files), end=" ")
              print("bytes in", len(files), "non-directory files")
              if 'CVS' in dirs:
                  dirs.remove('CVS')  # don't visit CVS directories

     In the next example (simple implementation of *note
     shutil.rmtree(): 21a.), walking the tree bottom-up is essential,
     *note rmdir(): a2f. doesn’t allow deleting a directory before the
     directory is empty:

          # Delete everything reachable from the directory named in "top",
          # assuming there are no symbolic links.
          # CAUTION:  This is dangerous!  For example, if top == '/', it
          # could delete all your disk files.
          import os
          for root, dirs, files in os.walk(top, topdown=False):
              for name in files:
                  os.remove(os.path.join(root, name))
              for name in dirs:
                  os.rmdir(os.path.join(root, name))

     Changed in version 3.5: This function now calls *note os.scandir():
     25d. instead of *note os.listdir(): a36, making it faster by
     reducing the number of calls to *note os.stat(): 1ef.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.fwalk (top='.', topdown=True, onerror=None, *,
          follow_symlinks=False, dir_fd=None)

     This behaves exactly like *note walk(): 648, except that it yields
     a 4-tuple ‘(dirpath, dirnames, filenames, dirfd)’, and it supports
     ‘dir_fd’.

     `dirpath', `dirnames' and `filenames' are identical to *note
     walk(): 648. output, and `dirfd' is a file descriptor referring to
     the directory `dirpath'.

     This function always supports *note paths relative to directory
     descriptors: a24. and *note not following symlinks: a25.  Note
     however that, unlike other functions, the *note fwalk(): 3a9.
     default value for `follow_symlinks' is ‘False’.

          Note: Since *note fwalk(): 3a9. yields file descriptors, those
          are only valid until the next iteration step, so you should
          duplicate them (e.g.  with *note dup(): ec5.) if you want to
          keep them longer.

     This example displays the number of bytes taken by non-directory
     files in each directory under the starting directory, except that
     it doesn’t look under any CVS subdirectory:

          import os
          for root, dirs, files, rootfd in os.fwalk('python/Lib/email'):
              print(root, "consumes", end="")
              print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]),
                    end="")
              print("bytes in", len(files), "non-directory files")
              if 'CVS' in dirs:
                  dirs.remove('CVS')  # don't visit CVS directories

     In the next example, walking the tree bottom-up is essential: *note
     rmdir(): a2f. doesn’t allow deleting a directory before the
     directory is empty:

          # Delete everything reachable from the directory named in "top",
          # assuming there are no symbolic links.
          # CAUTION:  This is dangerous!  For example, if top == '/', it
          # could delete all your disk files.
          import os
          for root, dirs, files, rootfd in os.fwalk(top, topdown=False):
              for name in files:
                  os.unlink(name, dir_fd=rootfd)
              for name in dirs:
                  os.rmdir(name, dir_fd=rootfd)

     *note Availability: 129a.: Unix.

     New in version 3.3.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

     Changed in version 3.7: Added support for *note bytes: 326. paths.

 -- Function: os.memfd_create (name[, flags=os.MFD_CLOEXEC])

     Create an anonymous file and return a file descriptor that refers
     to it.  `flags' must be one of the ‘os.MFD_*’ constants available
     on the system (or a bitwise ORed combination of them).  By default,
     the new file descriptor is *note non-inheritable: 7ee.

     The name supplied in `name' is used as a filename and will be
     displayed as the target of the corresponding symbolic link in the
     directory ‘/proc/self/fd/’.  The displayed name is always prefixed
     with ‘memfd:’ and serves only for debugging purposes.  Names do not
     affect the behavior of the file descriptor, and as such multiple
     files can have the same name without any side effects.

     *note Availability: 129a.: Linux 3.17 or newer with glibc 2.27 or
     newer.

     New in version 3.8.

 -- Data: os.MFD_CLOEXEC
 -- Data: os.MFD_ALLOW_SEALING
 -- Data: os.MFD_HUGETLB
 -- Data: os.MFD_HUGE_SHIFT
 -- Data: os.MFD_HUGE_MASK
 -- Data: os.MFD_HUGE_64KB
 -- Data: os.MFD_HUGE_512KB
 -- Data: os.MFD_HUGE_1MB
 -- Data: os.MFD_HUGE_2MB
 -- Data: os.MFD_HUGE_8MB
 -- Data: os.MFD_HUGE_16MB
 -- Data: os.MFD_HUGE_32MB
 -- Data: os.MFD_HUGE_256MB
 -- Data: os.MFD_HUGE_512MB
 -- Data: os.MFD_HUGE_1GB
 -- Data: os.MFD_HUGE_2GB
 -- Data: os.MFD_HUGE_16GB

     These flags can be passed to *note memfd_create(): 1ee.

     *note Availability: 129a.: Linux 3.17 or newer with glibc 2.27 or
     newer.  The ‘MFD_HUGE*’ flags are only available since Linux 4.14.

     New in version 3.8.

* Menu:

* Linux extended attributes::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0529

   (2) https://bugs.python.org/issue21082

   (3) 
http://pubs.opengroup.org/onlinepubs/009695399/functions/opendir.html

   (4) 
http://pubs.opengroup.org/onlinepubs/009695399/functions/readdir_r.html

   (5) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa364418(v=vs.85).aspx

   (6) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa364428(v=vs.85).aspx

   (7) https://msdn.microsoft.com/en-us/library/aa363788


File: python.info,  Node: Linux extended attributes,  Up: Files and Directories

5.16.1.8 Linux extended attributes
..................................

New in version 3.3.

These functions are all available on Linux only.

 -- Function: os.getxattr (path, attribute, *, follow_symlinks=True)

     Return the value of the extended filesystem attribute `attribute'
     for `path'.  `attribute' can be bytes or str (directly or
     indirectly through the *note PathLike: 4e0. interface).  If it is
     str, it is encoded with the filesystem encoding.

     This function can support *note specifying a file descriptor: 3aa.
     and *note not following symlinks: a25.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `path' and `attribute'.

 -- Function: os.listxattr (path=None, *, follow_symlinks=True)

     Return a list of the extended filesystem attributes on `path'.  The
     attributes in the list are represented as strings decoded with the
     filesystem encoding.  If `path' is ‘None’, *note listxattr(): a41.
     will examine the current directory.

     This function can support *note specifying a file descriptor: 3aa.
     and *note not following symlinks: a25.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os.removexattr (path, attribute, *, follow_symlinks=True)

     Removes the extended filesystem attribute `attribute' from `path'.
     `attribute' should be bytes or str (directly or indirectly through
     the *note PathLike: 4e0. interface).  If it is a string, it is
     encoded with the filesystem encoding.

     This function can support *note specifying a file descriptor: 3aa.
     and *note not following symlinks: a25.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `path' and `attribute'.

 -- Function: os.setxattr (path, attribute, value, flags=0, *,
          follow_symlinks=True)

     Set the extended filesystem attribute `attribute' on `path' to
     `value'.  `attribute' must be a bytes or str with no embedded NULs
     (directly or indirectly through the *note PathLike: 4e0.
     interface).  If it is a str, it is encoded with the filesystem
     encoding.  `flags' may be *note XATTR_REPLACE: 1ec2. or *note
     XATTR_CREATE: 1ec3.  If *note XATTR_REPLACE: 1ec2. is given and the
     attribute does not exist, ‘EEXISTS’ will be raised.  If *note
     XATTR_CREATE: 1ec3. is given and the attribute already exists, the
     attribute will not be created and ‘ENODATA’ will be raised.

     This function can support *note specifying a file descriptor: 3aa.
     and *note not following symlinks: a25.

          Note: A bug in Linux kernel versions less than 2.6.39 caused
          the flags argument to be ignored on some filesystems.

     Changed in version 3.6: Accepts a *note path-like object: 35f. for
     `path' and `attribute'.

 -- Data: os.XATTR_SIZE_MAX

     The maximum size the value of an extended attribute can be.
     Currently, this is 64 KiB on Linux.

 -- Data: os.XATTR_CREATE

     This is a possible value for the flags argument in *note
     setxattr(): a43.  It indicates the operation must create an
     attribute.

 -- Data: os.XATTR_REPLACE

     This is a possible value for the flags argument in *note
     setxattr(): a43.  It indicates the operation must replace an
     existing attribute.


File: python.info,  Node: Process Management,  Next: Interface to the scheduler,  Prev: Files and Directories,  Up: os — Miscellaneous operating system interfaces

5.16.1.9 Process Management
...........................

These functions may be used to create and manage processes.

The various *note exec*: 1ec7. functions take a list of arguments for
the new program loaded into the process.  In each case, the first of
these arguments is passed to the new program as its own name rather than
as an argument a user may have typed on a command line.  For the C
programmer, this is the ‘argv[0]’ passed to a program’s ‘main()’.  For
example, ‘os.execv('/bin/echo', ['foo', 'bar'])’ will only print ‘bar’
on standard output; ‘foo’ will seem to be ignored.

 -- Function: os.abort ()

     Generate a ‘SIGABRT’ signal to the current process.  On Unix, the
     default behavior is to produce a core dump; on Windows, the process
     immediately returns an exit code of ‘3’.  Be aware that calling
     this function will not call the Python signal handler registered
     for ‘SIGABRT’ with *note signal.signal(): a72.

 -- Function: os.add_dll_directory (path)

     Add a path to the DLL search path.

     This search path is used when resolving dependencies for imported
     extension modules (the module itself is resolved through sys.path),
     and also by *note ctypes: 2b.

     Remove the directory by calling `close()' on the returned object or
     using it in a *note with: 6dd. statement.

     See the Microsoft documentation(1) for more information about how
     DLLs are loaded.

     *note Availability: 129a.: Windows.

     New in version 3.8: Previous versions of CPython would resolve DLLs
     using the default behavior for the current process.  This led to
     inconsistencies, such as only sometimes searching ‘PATH’ or the
     current working directory, and OS functions such as
     ‘AddDllDirectory’ having no effect.

     In 3.8, the two primary ways DLLs are loaded now explicitly
     override the process-wide behavior to ensure consistency.  See the
     *note porting notes: 2c8. for information on updating libraries.

 -- Function: os.execl (path, arg0, arg1, ...)
 -- Function: os.execle (path, arg0, arg1, ..., env)
 -- Function: os.execlp (file, arg0, arg1, ...)
 -- Function: os.execlpe (file, arg0, arg1, ..., env)
 -- Function: os.execv (path, args)
 -- Function: os.execve (path, args, env)
 -- Function: os.execvp (file, args)
 -- Function: os.execvpe (file, args, env)

     These functions all execute a new program, replacing the current
     process; they do not return.  On Unix, the new executable is loaded
     into the current process, and will have the same process id as the
     caller.  Errors will be reported as *note OSError: 1d1. exceptions.

     The current process is replaced immediately.  Open file objects and
     descriptors are not flushed, so if there may be data buffered on
     these open files, you should flush them using ‘sys.stdout.flush()’
     or *note os.fsync(): 655. before calling an *note exec*: 1ec7.
     function.

     The “l” and “v” variants of the *note exec*: 1ec7. functions differ
     in how command-line arguments are passed.  The “l” variants are
     perhaps the easiest to work with if the number of parameters is
     fixed when the code is written; the individual parameters simply
     become additional parameters to the ‘execl*()’ functions.  The “v”
     variants are good when the number of parameters is variable, with
     the arguments being passed in a list or tuple as the `args'
     parameter.  In either case, the arguments to the child process
     should start with the name of the command being run, but this is
     not enforced.

     The variants which include a “p” near the end (*note execlp():
     1eca, *note execlpe(): 1ecb, *note execvp(): 1ecc, and *note
     execvpe(): 1ecd.) will use the ‘PATH’ environment variable to
     locate the program `file'.  When the environment is being replaced
     (using one of the *note exec*e: 1ec7. variants, discussed in the
     next paragraph), the new environment is used as the source of the
     ‘PATH’ variable.  The other variants, *note execl(): 1ec7, *note
     execle(): 1ec9, *note execv(): 1e34, and *note execve(): a35, will
     not use the ‘PATH’ variable to locate the executable; `path' must
     contain an appropriate absolute or relative path.

     For *note execle(): 1ec9, *note execlpe(): 1ecb, *note execve():
     a35, and *note execvpe(): 1ecd. (note that these all end in “e”),
     the `env' parameter must be a mapping which is used to define the
     environment variables for the new process (these are used instead
     of the current process’ environment); the functions *note execl():
     1ec7, *note execlp(): 1eca, *note execv(): 1e34, and *note
     execvp(): 1ecc. all cause the new process to inherit the
     environment of the current process.

     For *note execve(): a35. on some platforms, `path' may also be
     specified as an open file descriptor.  This functionality may not
     be supported on your platform; you can check whether or not it is
     available using *note os.supports_fd: a39.  If it is unavailable,
     using it will raise a *note NotImplementedError: 603.

     *note Availability: 129a.: Unix, Windows.

     New in version 3.3: Added support for specifying `path' as an open
     file descriptor for *note execve(): a35.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: os._exit (n)

     Exit the process with status `n', without calling cleanup handlers,
     flushing stdio buffers, etc.

          Note: The standard way to exit is ‘sys.exit(n)’.  *note
          _exit(): 1646. should normally only be used in the child
          process after a *note fork(): 955.

The following exit codes are defined and can be used with *note _exit():
1646, although they are not required.  These are typically used for
system programs written in Python, such as a mail server’s external
command delivery program.

     Note: Some of these may not be available on all Unix platforms,
     since there is some variation.  These constants are defined where
     they are defined by the underlying platform.

 -- Data: os.EX_OK

     Exit code that means no error occurred.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_USAGE

     Exit code that means the command was used incorrectly, such as when
     the wrong number of arguments are given.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_DATAERR

     Exit code that means the input data was incorrect.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_NOINPUT

     Exit code that means an input file did not exist or was not
     readable.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_NOUSER

     Exit code that means a specified user did not exist.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_NOHOST

     Exit code that means a specified host did not exist.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_UNAVAILABLE

     Exit code that means that a required service is unavailable.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_SOFTWARE

     Exit code that means an internal software error was detected.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_OSERR

     Exit code that means an operating system error was detected, such
     as the inability to fork or create a pipe.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_OSFILE

     Exit code that means some system file did not exist, could not be
     opened, or had some other kind of error.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_CANTCREAT

     Exit code that means a user specified output file could not be
     created.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_IOERR

     Exit code that means that an error occurred while doing I/O on some
     file.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_TEMPFAIL

     Exit code that means a temporary failure occurred.  This indicates
     something that may not really be an error, such as a network
     connection that couldn’t be made during a retryable operation.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_PROTOCOL

     Exit code that means that a protocol exchange was illegal, invalid,
     or not understood.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_NOPERM

     Exit code that means that there were insufficient permissions to
     perform the operation (but not intended for file system problems).

     *note Availability: 129a.: Unix.

 -- Data: os.EX_CONFIG

     Exit code that means that some kind of configuration error
     occurred.

     *note Availability: 129a.: Unix.

 -- Data: os.EX_NOTFOUND

     Exit code that means something like “an entry was not found”.

     *note Availability: 129a.: Unix.

 -- Function: os.fork ()

     Fork a child process.  Return ‘0’ in the child and the child’s
     process id in the parent.  If an error occurs *note OSError: 1d1.
     is raised.

     Note that some platforms including FreeBSD <= 6.3 and Cygwin have
     known issues when using ‘fork()’ from a thread.

     Changed in version 3.8: Calling ‘fork()’ in a subinterpreter is no
     longer supported (*note RuntimeError: 2b8. is raised).

          Warning: See *note ssl: f3. for applications that use the SSL
          module with fork().

     *note Availability: 129a.: Unix.

 -- Function: os.forkpty ()

     Fork a child process, using a new pseudo-terminal as the child’s
     controlling terminal.  Return a pair of ‘(pid, fd)’, where `pid' is
     ‘0’ in the child, the new child’s process id in the parent, and
     `fd' is the file descriptor of the master end of the
     pseudo-terminal.  For a more portable approach, use the *note pty:
     d5. module.  If an error occurs *note OSError: 1d1. is raised.

     Changed in version 3.8: Calling ‘forkpty()’ in a subinterpreter is
     no longer supported (*note RuntimeError: 2b8. is raised).

     *note Availability: 129a.: some flavors of Unix.

 -- Function: os.kill (pid, sig)

     Send signal `sig' to the process `pid'.  Constants for the specific
     signals available on the host platform are defined in the *note
     signal: ea. module.

     Windows: The *note signal.CTRL_C_EVENT: 1ee0. and *note
     signal.CTRL_BREAK_EVENT: 1ee1. signals are special signals which
     can only be sent to console processes which share a common console
     window, e.g., some subprocesses.  Any other value for `sig' will
     cause the process to be unconditionally killed by the
     TerminateProcess API, and the exit code will be set to `sig'.  The
     Windows version of *note kill(): ce6. additionally takes process
     handles to be killed.

     See also *note signal.pthread_kill(): a6f.

     New in version 3.2: Windows support.

 -- Function: os.killpg (pgid, sig)

     Send the signal `sig' to the process group `pgid'.

     *note Availability: 129a.: Unix.

 -- Function: os.nice (increment)

     Add `increment' to the process’s “niceness”.  Return the new
     niceness.

     *note Availability: 129a.: Unix.

 -- Function: os.plock (op)

     Lock program segments into memory.  The value of `op' (defined in
     ‘<sys/lock.h>’) determines which segments are locked.

     *note Availability: 129a.: Unix.

 -- Function: os.popen (cmd, mode='r', buffering=-1)

     Open a pipe to or from command `cmd'.  The return value is an open
     file object connected to the pipe, which can be read or written
     depending on whether `mode' is ‘'r'’ (default) or ‘'w'’.  The
     `buffering' argument has the same meaning as the corresponding
     argument to the built-in *note open(): 4e5. function.  The returned
     file object reads or writes text strings rather than bytes.

     The ‘close’ method returns *note None: 157. if the subprocess
     exited successfully, or the subprocess’s return code if there was
     an error.  On POSIX systems, if the return code is positive it
     represents the return value of the process left-shifted by one
     byte.  If the return code is negative, the process was terminated
     by the signal given by the negated value of the return code.  (For
     example, the return value might be ‘- signal.SIGKILL’ if the
     subprocess was killed.)  On Windows systems, the return value
     contains the signed integer return code from the child process.

     This is implemented using *note subprocess.Popen: 2b7.; see that
     class’s documentation for more powerful ways to manage and
     communicate with subprocesses.

 -- Function: os.posix_spawn (path, argv, env, *, file_actions=None,
          setpgroup=None, resetids=False, setsid=False, setsigmask=(),
          setsigdef=(), scheduler=None)

     Wraps the ‘posix_spawn()’ C library API for use from Python.

     Most users should use *note subprocess.run(): 3e2. instead of *note
     posix_spawn(): 255.

     The positional-only arguments `path', `args', and `env' are similar
     to *note execve(): a35.

     The `path' parameter is the path to the executable file.The `path'
     should contain a directory.Use *note posix_spawnp(): f4c. to pass
     an executable file without directory.

     The `file_actions' argument may be a sequence of tuples describing
     actions to take on specific file descriptors in the child process
     between the C library implementation’s ‘fork()’ and ‘exec()’ steps.
     The first item in each tuple must be one of the three type
     indicator listed below describing the remaining tuple elements:

      -- Data: os.POSIX_SPAWN_OPEN

          (‘os.POSIX_SPAWN_OPEN’, `fd', `path', `flags', `mode')

          Performs ‘os.dup2(os.open(path, flags, mode), fd)’.

      -- Data: os.POSIX_SPAWN_CLOSE

          (‘os.POSIX_SPAWN_CLOSE’, `fd')

          Performs ‘os.close(fd)’.

      -- Data: os.POSIX_SPAWN_DUP2

          (‘os.POSIX_SPAWN_DUP2’, `fd', `new_fd')

          Performs ‘os.dup2(fd, new_fd)’.

     These tuples correspond to the C library
     ‘posix_spawn_file_actions_addopen()’,
     ‘posix_spawn_file_actions_addclose()’, and
     ‘posix_spawn_file_actions_adddup2()’ API calls used to prepare for
     the ‘posix_spawn()’ call itself.

     The `setpgroup' argument will set the process group of the child to
     the value specified.  If the value specified is 0, the child’s
     process group ID will be made the same as its process ID. If the
     value of `setpgroup' is not set, the child will inherit the
     parent’s process group ID. This argument corresponds to the C
     library ‘POSIX_SPAWN_SETPGROUP’ flag.

     If the `resetids' argument is ‘True’ it will reset the effective
     UID and GID of the child to the real UID and GID of the parent
     process.  If the argument is ‘False’, then the child retains the
     effective UID and GID of the parent.  In either case, if the
     set-user-ID and set-group-ID permission bits are enabled on the
     executable file, their effect will override the setting of the
     effective UID and GID. This argument corresponds to the C library
     ‘POSIX_SPAWN_RESETIDS’ flag.

     If the `setsid' argument is ‘True’, it will create a new session ID
     for ‘posix_spawn’.  `setsid' requires ‘POSIX_SPAWN_SETSID’ or
     ‘POSIX_SPAWN_SETSID_NP’ flag.  Otherwise, *note
     NotImplementedError: 603. is raised.

     The `setsigmask' argument will set the signal mask to the signal
     set specified.  If the parameter is not used, then the child
     inherits the parent’s signal mask.  This argument corresponds to
     the C library ‘POSIX_SPAWN_SETSIGMASK’ flag.

     The `sigdef' argument will reset the disposition of all signals in
     the set specified.  This argument corresponds to the C library
     ‘POSIX_SPAWN_SETSIGDEF’ flag.

     The `scheduler' argument must be a tuple containing the (optional)
     scheduler policy and an instance of *note sched_param: 1ee7. with
     the scheduler parameters.  A value of ‘None’ in the place of the
     scheduler policy indicates that is not being provided.  This
     argument is a combination of the C library
     ‘POSIX_SPAWN_SETSCHEDPARAM’ and ‘POSIX_SPAWN_SETSCHEDULER’ flags.

     New in version 3.8.

     *note Availability: 129a.: Unix.

 -- Function: os.posix_spawnp (path, argv, env, *, file_actions=None,
          setpgroup=None, resetids=False, setsid=False, setsigmask=(),
          setsigdef=(), scheduler=None)

     Wraps the ‘posix_spawnp()’ C library API for use from Python.

     Similar to *note posix_spawn(): 255. except that the system
     searches for the `executable' file in the list of directories
     specified by the ‘PATH’ environment variable (in the same way as
     for ‘execvp(3)’).

     New in version 3.8.

     *note Availability: 129a.: See *note posix_spawn(): 255.
     documentation.

 -- Function: os.register_at_fork (*, before=None, after_in_parent=None,
          after_in_child=None)

     Register callables to be executed when a new child process is
     forked using *note os.fork(): 955. or similar process cloning APIs.
     The parameters are optional and keyword-only.  Each specifies a
     different call point.

        * `before' is a function called before forking a child process.

        * `after_in_parent' is a function called from the parent process
          after forking a child process.

        * `after_in_child' is a function called from the child process.

     These calls are only made if control is expected to return to the
     Python interpreter.  A typical *note subprocess: f9. launch will
     not trigger them as the child is not going to re-enter the
     interpreter.

     Functions registered for execution before forking are called in
     reverse registration order.  Functions registered for execution
     after forking (either in the parent or in the child) are called in
     registration order.

     Note that ‘fork()’ calls made by third-party C code may not call
     those functions, unless it explicitly calls *note
     PyOS_BeforeFork(): 427, *note PyOS_AfterFork_Parent(): 428. and
     *note PyOS_AfterFork_Child(): 2cb.

     There is no way to unregister a function.

     *note Availability: 129a.: Unix.

     New in version 3.7.

 -- Function: os.spawnl (mode, path, ...)
 -- Function: os.spawnle (mode, path, ..., env)
 -- Function: os.spawnlp (mode, file, ...)
 -- Function: os.spawnlpe (mode, file, ..., env)
 -- Function: os.spawnv (mode, path, args)
 -- Function: os.spawnve (mode, path, args, env)
 -- Function: os.spawnvp (mode, file, args)
 -- Function: os.spawnvpe (mode, file, args, env)

     Execute the program `path' in a new process.

     (Note that the *note subprocess: f9. module provides more powerful
     facilities for spawning new processes and retrieving their results;
     using that module is preferable to using these functions.  Check
     especially the *note Replacing Older Functions with the subprocess
     Module: adf. section.)

     If `mode' is *note P_NOWAIT: 1eef, this function returns the
     process id of the new process; if `mode' is *note P_WAIT: 1ef0,
     returns the process’s exit code if it exits normally, or ‘-signal’,
     where `signal' is the signal that killed the process.  On Windows,
     the process id will actually be the process handle, so can be used
     with the *note waitpid(): 661. function.

     Note on VxWorks, this function doesn’t return ‘-signal’ when the
     new process is killed.  Instead it raises OSError exception.

     The “l” and “v” variants of the *note spawn*: 1e82. functions
     differ in how command-line arguments are passed.  The “l” variants
     are perhaps the easiest to work with if the number of parameters is
     fixed when the code is written; the individual parameters simply
     become additional parameters to the ‘spawnl*()’ functions.  The “v”
     variants are good when the number of parameters is variable, with
     the arguments being passed in a list or tuple as the `args'
     parameter.  In either case, the arguments to the child process must
     start with the name of the command being run.

     The variants which include a second “p” near the end (*note
     spawnlp(): 1ee9, *note spawnlpe(): 1eea, *note spawnvp(): 1eed, and
     *note spawnvpe(): 1eee.) will use the ‘PATH’ environment variable
     to locate the program `file'.  When the environment is being
     replaced (using one of the *note spawn*e: 1e82. variants, discussed
     in the next paragraph), the new environment is used as the source
     of the ‘PATH’ variable.  The other variants, *note spawnl(): 1e82,
     *note spawnle(): 1ee8, *note spawnv(): 1eeb, and *note spawnve():
     1eec, will not use the ‘PATH’ variable to locate the executable;
     `path' must contain an appropriate absolute or relative path.

     For *note spawnle(): 1ee8, *note spawnlpe(): 1eea, *note spawnve():
     1eec, and *note spawnvpe(): 1eee. (note that these all end in “e”),
     the `env' parameter must be a mapping which is used to define the
     environment variables for the new process (they are used instead of
     the current process’ environment); the functions *note spawnl():
     1e82, *note spawnlp(): 1ee9, *note spawnv(): 1eeb, and *note
     spawnvp(): 1eed. all cause the new process to inherit the
     environment of the current process.  Note that keys and values in
     the `env' dictionary must be strings; invalid keys or values will
     cause the function to fail, with a return value of ‘127’.

     As an example, the following calls to *note spawnlp(): 1ee9. and
     *note spawnvpe(): 1eee. are equivalent:

          import os
          os.spawnlp(os.P_WAIT, 'cp', 'cp', 'index.html', '/dev/null')

          L = ['cp', 'index.html', '/dev/null']
          os.spawnvpe(os.P_WAIT, 'cp', L, os.environ)

     *note Availability: 129a.: Unix, Windows.  *note spawnlp(): 1ee9,
     *note spawnlpe(): 1eea, *note spawnvp(): 1eed. and *note
     spawnvpe(): 1eee. are not available on Windows.  *note spawnle():
     1ee8. and *note spawnve(): 1eec. are not thread-safe on Windows; we
     advise you to use the *note subprocess: f9. module instead.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Data: os.P_NOWAIT
 -- Data: os.P_NOWAITO

     Possible values for the `mode' parameter to the *note spawn*: 1e82.
     family of functions.  If either of these values is given, the
     ‘spawn*()’ functions will return as soon as the new process has
     been created, with the process id as the return value.

     *note Availability: 129a.: Unix, Windows.

 -- Data: os.P_WAIT

     Possible value for the `mode' parameter to the *note spawn*: 1e82.
     family of functions.  If this is given as `mode', the ‘spawn*()’
     functions will not return until the new process has run to
     completion and will return the exit code of the process the run is
     successful, or ‘-signal’ if a signal kills the process.

     *note Availability: 129a.: Unix, Windows.

 -- Data: os.P_DETACH
 -- Data: os.P_OVERLAY

     Possible values for the `mode' parameter to the *note spawn*: 1e82.
     family of functions.  These are less portable than those listed
     above.  *note P_DETACH: 1ef2. is similar to *note P_NOWAIT: 1eef,
     but the new process is detached from the console of the calling
     process.  If *note P_OVERLAY: 1ef3. is used, the current process
     will be replaced; the *note spawn*: 1e82. function will not return.

     *note Availability: 129a.: Windows.

 -- Function: os.startfile (path[, operation])

     Start a file with its associated application.

     When `operation' is not specified or ‘'open'’, this acts like
     double-clicking the file in Windows Explorer, or giving the file
     name as an argument to the ‘start’ command from the interactive
     command shell: the file is opened with whatever application (if
     any) its extension is associated.

     When another `operation' is given, it must be a “command verb” that
     specifies what should be done with the file.  Common verbs
     documented by Microsoft are ‘'print'’ and ‘'edit'’ (to be used on
     files) as well as ‘'explore'’ and ‘'find'’ (to be used on
     directories).

     *note startfile(): 1ef4. returns as soon as the associated
     application is launched.  There is no option to wait for the
     application to close, and no way to retrieve the application’s exit
     status.  The `path' parameter is relative to the current directory.
     If you want to use an absolute path, make sure the first character
     is not a slash (‘'/'’); the underlying Win32 ‘ShellExecute()’
     function doesn’t work if it is.  Use the *note os.path.normpath():
     ca2. function to ensure that the path is properly encoded for
     Win32.

     To reduce interpreter startup overhead, the Win32 ‘ShellExecute()’
     function is not resolved until this function is first called.  If
     the function cannot be resolved, *note NotImplementedError: 603.
     will be raised.

     *note Availability: 129a.: Windows.

 -- Function: os.system (command)

     Execute the command (a string) in a subshell.  This is implemented
     by calling the Standard C function ‘system()’, and has the same
     limitations.  Changes to *note sys.stdin: 302, etc.  are not
     reflected in the environment of the executed command.  If `command'
     generates any output, it will be sent to the interpreter standard
     output stream.

     On Unix, the return value is the exit status of the process encoded
     in the format specified for *note wait(): 65f.  Note that POSIX
     does not specify the meaning of the return value of the C
     ‘system()’ function, so the return value of the Python function is
     system-dependent.

     On Windows, the return value is that returned by the system shell
     after running `command'.  The shell is given by the Windows
     environment variable ‘COMSPEC’: it is usually ‘cmd.exe’, which
     returns the exit status of the command run; on systems using a
     non-native shell, consult your shell documentation.

     The *note subprocess: f9. module provides more powerful facilities
     for spawning new processes and retrieving their results; using that
     module is preferable to using this function.  See the *note
     Replacing Older Functions with the subprocess Module: adf. section
     in the *note subprocess: f9. documentation for some helpful
     recipes.

     Raises an *note auditing event: 1275. ‘os.system’ with argument
     ‘command’.

     *note Availability: 129a.: Unix, Windows.

 -- Function: os.times ()

     Returns the current global process times.  The return value is an
     object with five attributes:

        * ‘user’ - user time

        * *note system: db4. - system time

        * ‘children_user’ - user time of all child processes

        * ‘children_system’ - system time of all child processes

        * ‘elapsed’ - elapsed real time since a fixed point in the past

     For backwards compatibility, this object also behaves like a
     five-tuple containing ‘user’, *note system: db4, ‘children_user’,
     ‘children_system’, and ‘elapsed’ in that order.

     See the Unix manual page ‘times(2)’ and ‘times(3)’ manual page on
     Unix or ‘the GetProcessTimes MSDN
     <https://docs.microsoft.com/windows/win32/api/processthreadsapi/nf-processthreadsapi-getprocesstimes>’
     _ on Windows.  On Windows, only ‘user’ and *note system: db4. are
     known; the other attributes are zero.

     *note Availability: 129a.: Unix, Windows.

     Changed in version 3.3: Return type changed from a tuple to a
     tuple-like object with named attributes.

 -- Function: os.wait ()

     Wait for completion of a child process, and return a tuple
     containing its pid and exit status indication: a 16-bit number,
     whose low byte is the signal number that killed the process, and
     whose high byte is the exit status (if the signal number is zero);
     the high bit of the low byte is set if a core file was produced.

     *note Availability: 129a.: Unix.

 -- Function: os.waitid (idtype, id, options)

     Wait for the completion of one or more child processes.  `idtype'
     can be *note P_PID: 1ef5, *note P_PGID: 1ef6. or *note P_ALL: 1ef7.
     `id' specifies the pid to wait on.  `options' is constructed from
     the ORing of one or more of *note WEXITED: 1ef8, *note WSTOPPED:
     1ef9. or *note WCONTINUED: 1efa. and additionally may be ORed with
     *note WNOHANG: 1efb. or *note WNOWAIT: 1efc.  The return value is
     an object representing the data contained in the ‘siginfo_t’
     structure, namely: ‘si_pid’, ‘si_uid’, ‘si_signo’, ‘si_status’,
     ‘si_code’ or ‘None’ if *note WNOHANG: 1efb. is specified and there
     are no children in a waitable state.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: os.P_PID
 -- Data: os.P_PGID
 -- Data: os.P_ALL

     These are the possible values for `idtype' in *note waitid(): 660.
     They affect how `id' is interpreted.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: os.WEXITED
 -- Data: os.WSTOPPED
 -- Data: os.WNOWAIT

     Flags that can be used in `options' in *note waitid(): 660. that
     specify what child signal to wait for.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: os.CLD_EXITED
 -- Data: os.CLD_DUMPED
 -- Data: os.CLD_TRAPPED
 -- Data: os.CLD_CONTINUED

     These are the possible values for ‘si_code’ in the result returned
     by *note waitid(): 660.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: os.waitpid (pid, options)

     The details of this function differ on Unix and Windows.

     On Unix: Wait for completion of a child process given by process id
     `pid', and return a tuple containing its process id and exit status
     indication (encoded as for *note wait(): 65f.).  The semantics of
     the call are affected by the value of the integer `options', which
     should be ‘0’ for normal operation.

     If `pid' is greater than ‘0’, *note waitpid(): 661. requests status
     information for that specific process.  If `pid' is ‘0’, the
     request is for the status of any child in the process group of the
     current process.  If `pid' is ‘-1’, the request pertains to any
     child of the current process.  If `pid' is less than ‘-1’, status
     is requested for any process in the process group ‘-pid’ (the
     absolute value of `pid').

     An *note OSError: 1d1. is raised with the value of errno when the
     syscall returns -1.

     On Windows: Wait for completion of a process given by process
     handle `pid', and return a tuple containing `pid', and its exit
     status shifted left by 8 bits (shifting makes cross-platform use of
     the function easier).  A `pid' less than or equal to ‘0’ has no
     special meaning on Windows, and raises an exception.  The value of
     integer `options' has no effect.  `pid' can refer to any process
     whose id is known, not necessarily a child process.  The *note
     spawn*: 1e82. functions called with *note P_NOWAIT: 1eef. return
     suitable process handles.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the function now
     retries the system call instead of raising an *note
     InterruptedError: 64d. exception (see PEP 475(2) for the
     rationale).

 -- Function: os.wait3 (options)

     Similar to *note waitpid(): 661, except no process id argument is
     given and a 3-element tuple containing the child’s process id, exit
     status indication, and resource usage information is returned.
     Refer to *note resource: e0.*note getrusage(): d8c. for details on
     resource usage information.  The option argument is the same as
     that provided to *note waitpid(): 661. and *note wait4(): 65e.

     *note Availability: 129a.: Unix.

 -- Function: os.wait4 (pid, options)

     Similar to *note waitpid(): 661, except a 3-element tuple,
     containing the child’s process id, exit status indication, and
     resource usage information is returned.  Refer to *note resource:
     e0.*note getrusage(): d8c. for details on resource usage
     information.  The arguments to *note wait4(): 65e. are the same as
     those provided to *note waitpid(): 661.

     *note Availability: 129a.: Unix.

 -- Data: os.WNOHANG

     The option for *note waitpid(): 661. to return immediately if no
     child process status is available immediately.  The function
     returns ‘(0, 0)’ in this case.

     *note Availability: 129a.: Unix.

 -- Data: os.WCONTINUED

     This option causes child processes to be reported if they have been
     continued from a job control stop since their status was last
     reported.

     *note Availability: 129a.: some Unix systems.

 -- Data: os.WUNTRACED

     This option causes child processes to be reported if they have been
     stopped but their current state has not been reported since they
     were stopped.

     *note Availability: 129a.: Unix.

The following functions take a process status code as returned by *note
system(): db4, *note wait(): 65f, or *note waitpid(): 661. as a
parameter.  They may be used to determine the disposition of a process.

 -- Function: os.WCOREDUMP (status)

     Return ‘True’ if a core dump was generated for the process,
     otherwise return ‘False’.

     *note Availability: 129a.: Unix.

 -- Function: os.WIFCONTINUED (status)

     Return ‘True’ if the process has been continued from a job control
     stop, otherwise return ‘False’.

     *note Availability: 129a.: Unix.

 -- Function: os.WIFSTOPPED (status)

     Return ‘True’ if the process has been stopped, otherwise return
     ‘False’.

     *note Availability: 129a.: Unix.

 -- Function: os.WIFSIGNALED (status)

     Return ‘True’ if the process exited due to a signal, otherwise
     return ‘False’.

     *note Availability: 129a.: Unix.

 -- Function: os.WIFEXITED (status)

     Return ‘True’ if the process exited using the ‘exit(2)’ system
     call, otherwise return ‘False’.

     *note Availability: 129a.: Unix.

 -- Function: os.WEXITSTATUS (status)

     If ‘WIFEXITED(status)’ is true, return the integer parameter to the
     ‘exit(2)’ system call.  Otherwise, the return value is meaningless.

     *note Availability: 129a.: Unix.

 -- Function: os.WSTOPSIG (status)

     Return the signal which caused the process to stop.

     *note Availability: 129a.: Unix.

 -- Function: os.WTERMSIG (status)

     Return the signal which caused the process to exit.

     *note Availability: 129a.: Unix.

   ---------- Footnotes ----------

   (1) https://msdn.microsoft.com/44228cf2-6306-466c-8f16-f513cd3ba8b5

   (2) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Interface to the scheduler,  Next: Miscellaneous System Information,  Prev: Process Management,  Up: os — Miscellaneous operating system interfaces

5.16.1.10 Interface to the scheduler
....................................

These functions control how a process is allocated CPU time by the
operating system.  They are only available on some Unix platforms.  For
more detailed information, consult your Unix manpages.

New in version 3.3.

The following scheduling policies are exposed if they are supported by
the operating system.

 -- Data: os.SCHED_OTHER

     The default scheduling policy.

 -- Data: os.SCHED_BATCH

     Scheduling policy for CPU-intensive processes that tries to
     preserve interactivity on the rest of the computer.

 -- Data: os.SCHED_IDLE

     Scheduling policy for extremely low priority background tasks.

 -- Data: os.SCHED_SPORADIC

     Scheduling policy for sporadic server programs.

 -- Data: os.SCHED_FIFO

     A First In First Out scheduling policy.

 -- Data: os.SCHED_RR

     A round-robin scheduling policy.

 -- Data: os.SCHED_RESET_ON_FORK

     This flag can be OR’ed with any other scheduling policy.  When a
     process with this flag set forks, its child’s scheduling policy and
     priority are reset to the default.

 -- Class: os.sched_param (sched_priority)

     This class represents tunable scheduling parameters used in *note
     sched_setparam(): a4b, *note sched_setscheduler(): a4c, and *note
     sched_getparam(): a47.  It is immutable.

     At the moment, there is only one possible parameter:

      -- Attribute: sched_priority

          The scheduling priority for a scheduling policy.

 -- Function: os.sched_get_priority_min (policy)

     Get the minimum priority value for `policy'.  `policy' is one of
     the scheduling policy constants above.

 -- Function: os.sched_get_priority_max (policy)

     Get the maximum priority value for `policy'.  `policy' is one of
     the scheduling policy constants above.

 -- Function: os.sched_setscheduler (pid, policy, param)

     Set the scheduling policy for the process with PID `pid'.  A `pid'
     of 0 means the calling process.  `policy' is one of the scheduling
     policy constants above.  `param' is a *note sched_param: 1ee7.
     instance.

 -- Function: os.sched_getscheduler (pid)

     Return the scheduling policy for the process with PID `pid'.  A
     `pid' of 0 means the calling process.  The result is one of the
     scheduling policy constants above.

 -- Function: os.sched_setparam (pid, param)

     Set a scheduling parameters for the process with PID `pid'.  A
     `pid' of 0 means the calling process.  `param' is a *note
     sched_param: 1ee7. instance.

 -- Function: os.sched_getparam (pid)

     Return the scheduling parameters as a *note sched_param: 1ee7.
     instance for the process with PID `pid'.  A `pid' of 0 means the
     calling process.

 -- Function: os.sched_rr_get_interval (pid)

     Return the round-robin quantum in seconds for the process with PID
     `pid'.  A `pid' of 0 means the calling process.

 -- Function: os.sched_yield ()

     Voluntarily relinquish the CPU.

 -- Function: os.sched_setaffinity (pid, mask)

     Restrict the process with PID `pid' (or the current process if
     zero) to a set of CPUs.  `mask' is an iterable of integers
     representing the set of CPUs to which the process should be
     restricted.

 -- Function: os.sched_getaffinity (pid)

     Return the set of CPUs the process with PID `pid' (or the current
     process if zero) is restricted to.


File: python.info,  Node: Miscellaneous System Information,  Next: Random numbers<2>,  Prev: Interface to the scheduler,  Up: os — Miscellaneous operating system interfaces

5.16.1.11 Miscellaneous System Information
..........................................

 -- Function: os.confstr (name)

     Return string-valued system configuration values.  `name' specifies
     the configuration value to retrieve; it may be a string which is
     the name of a defined system value; these names are specified in a
     number of standards (POSIX, Unix 95, Unix 98, and others).  Some
     platforms define additional names as well.  The names known to the
     host operating system are given as the keys of the ‘confstr_names’
     dictionary.  For configuration variables not included in that
     mapping, passing an integer for `name' is also accepted.

     If the configuration value specified by `name' isn’t defined,
     ‘None’ is returned.

     If `name' is a string and is not known, *note ValueError: 1f9. is
     raised.  If a specific value for `name' is not supported by the
     host system, even if it is included in ‘confstr_names’, an *note
     OSError: 1d1. is raised with *note errno.EINVAL: efb. for the error
     number.

     *note Availability: 129a.: Unix.

 -- Data: os.confstr_names

     Dictionary mapping names accepted by *note confstr(): 1f15. to the
     integer values defined for those names by the host operating
     system.  This can be used to determine the set of names known to
     the system.

     *note Availability: 129a.: Unix.

 -- Function: os.cpu_count ()

     Return the number of CPUs in the system.  Returns ‘None’ if
     undetermined.

     This number is not equivalent to the number of CPUs the current
     process can use.  The number of usable CPUs can be obtained with
     ‘len(os.sched_getaffinity(0))’

     New in version 3.4.

 -- Function: os.getloadavg ()

     Return the number of processes in the system run queue averaged
     over the last 1, 5, and 15 minutes or raises *note OSError: 1d1. if
     the load average was unobtainable.

     *note Availability: 129a.: Unix.

 -- Function: os.sysconf (name)

     Return integer-valued system configuration values.  If the
     configuration value specified by `name' isn’t defined, ‘-1’ is
     returned.  The comments regarding the `name' parameter for *note
     confstr(): 1f15. apply here as well; the dictionary that provides
     information on the known names is given by ‘sysconf_names’.

     *note Availability: 129a.: Unix.

 -- Data: os.sysconf_names

     Dictionary mapping names accepted by *note sysconf(): 1e73. to the
     integer values defined for those names by the host operating
     system.  This can be used to determine the set of names known to
     the system.

     *note Availability: 129a.: Unix.

The following data values are used to support path manipulation
operations.  These are defined for all platforms.

Higher-level operations on pathnames are defined in the *note os.path:
c5. module.

 -- Data: os.curdir

     The constant string used by the operating system to refer to the
     current directory.  This is ‘'.'’ for Windows and POSIX. Also
     available via *note os.path: c5.

 -- Data: os.pardir

     The constant string used by the operating system to refer to the
     parent directory.  This is ‘'..'’ for Windows and POSIX. Also
     available via *note os.path: c5.

 -- Data: os.sep

     The character used by the operating system to separate pathname
     components.  This is ‘'/'’ for POSIX and ‘'\\'’ for Windows.  Note
     that knowing this is not sufficient to be able to parse or
     concatenate pathnames — use *note os.path.split(): 1b24. and *note
     os.path.join(): e8c. — but it is occasionally useful.  Also
     available via *note os.path: c5.

 -- Data: os.altsep

     An alternative character used by the operating system to separate
     pathname components, or ‘None’ if only one separator character
     exists.  This is set to ‘'/'’ on Windows systems where ‘sep’ is a
     backslash.  Also available via *note os.path: c5.

 -- Data: os.extsep

     The character which separates the base filename from the extension;
     for example, the ‘'.'’ in ‘os.py’.  Also available via *note
     os.path: c5.

 -- Data: os.pathsep

     The character conventionally used by the operating system to
     separate search path components (as in ‘PATH’), such as ‘':'’ for
     POSIX or ‘';'’ for Windows.  Also available via *note os.path: c5.

 -- Data: os.defpath

     The default search path used by *note exec*p*: 1ec7. and *note
     spawn*p*: 1e82. if the environment doesn’t have a ‘'PATH'’ key.
     Also available via *note os.path: c5.

 -- Data: os.linesep

     The string used to separate (or, rather, terminate) lines on the
     current platform.  This may be a single character, such as ‘'\n'’
     for POSIX, or multiple characters, for example, ‘'\r\n'’ for
     Windows.  Do not use `os.linesep' as a line terminator when writing
     files opened in text mode (the default); use a single ‘'\n'’
     instead, on all platforms.

 -- Data: os.devnull

     The file path of the null device.  For example: ‘'/dev/null'’ for
     POSIX, ‘'nul'’ for Windows.  Also available via *note os.path: c5.

 -- Data: os.RTLD_LAZY
 -- Data: os.RTLD_NOW
 -- Data: os.RTLD_GLOBAL
 -- Data: os.RTLD_LOCAL
 -- Data: os.RTLD_NODELETE
 -- Data: os.RTLD_NOLOAD
 -- Data: os.RTLD_DEEPBIND

     Flags for use with the *note setdlopenflags(): a5b. and *note
     getdlopenflags(): e41. functions.  See the Unix manual page
     ‘dlopen(3)’ for what the different flags mean.

     New in version 3.3.


File: python.info,  Node: Random numbers<2>,  Prev: Miscellaneous System Information,  Up: os — Miscellaneous operating system interfaces

5.16.1.12 Random numbers
........................

 -- Function: os.getrandom (size, flags=0)

     Get up to `size' random bytes.  The function can return less bytes
     than requested.

     These bytes can be used to seed user-space random number generators
     or for cryptographic purposes.

     ‘getrandom()’ relies on entropy gathered from device drivers and
     other sources of environmental noise.  Unnecessarily reading large
     quantities of data will have a negative impact on other users of
     the ‘/dev/random’ and ‘/dev/urandom’ devices.

     The flags argument is a bit mask that can contain zero or more of
     the following values ORed together: *note os.GRND_RANDOM: 1f1b. and
     *note GRND_NONBLOCK: 1f1c.

     See also the Linux getrandom() manual page(1).

     *note Availability: 129a.: Linux 3.17 and newer.

     New in version 3.6.

 -- Function: os.urandom (size)

     Return a string of `size' random bytes suitable for cryptographic
     use.

     This function returns random bytes from an OS-specific randomness
     source.  The returned data should be unpredictable enough for
     cryptographic applications, though its exact quality depends on the
     OS implementation.

     On Linux, if the ‘getrandom()’ syscall is available, it is used in
     blocking mode: block until the system urandom entropy pool is
     initialized (128 bits of entropy are collected by the kernel).  See
     the PEP 524(2) for the rationale.  On Linux, the *note getrandom():
     55e. function can be used to get random bytes in non-blocking mode
     (using the *note GRND_NONBLOCK: 1f1c. flag) or to poll until the
     system urandom entropy pool is initialized.

     On a Unix-like system, random bytes are read from the
     ‘/dev/urandom’ device.  If the ‘/dev/urandom’ device is not
     available or not readable, the *note NotImplementedError: 603.
     exception is raised.

     On Windows, it will use ‘CryptGenRandom()’.

     See also
     ........

     The *note secrets: e4. module provides higher level functions.  For
     an easy-to-use interface to the random number generator provided by
     your platform, please see *note random.SystemRandom: 1a3d.

     Changed in version 3.6.0: On Linux, ‘getrandom()’ is now used in
     blocking mode to increase the security.

     Changed in version 3.5.2: On Linux, if the ‘getrandom()’ syscall
     blocks (the urandom entropy pool is not initialized yet), fall back
     on reading ‘/dev/urandom’.

     Changed in version 3.5: On Linux 3.17 and newer, the ‘getrandom()’
     syscall is now used when available.  On OpenBSD 5.6 and newer, the
     C ‘getentropy()’ function is now used.  These functions avoid the
     usage of an internal file descriptor.

 -- Data: os.GRND_NONBLOCK

     By default, when reading from ‘/dev/random’, *note getrandom():
     55e. blocks if no random bytes are available, and when reading from
     ‘/dev/urandom’, it blocks if the entropy pool has not yet been
     initialized.

     If the *note GRND_NONBLOCK: 1f1c. flag is set, then *note
     getrandom(): 55e. does not block in these cases, but instead
     immediately raises *note BlockingIOError: 98b.

     New in version 3.6.

 -- Data: os.GRND_RANDOM

     If this bit is set, then random bytes are drawn from the
     ‘/dev/random’ pool instead of the ‘/dev/urandom’ pool.

     New in version 3.6.

   ---------- Footnotes ----------

   (1) http://man7.org/linux/man-pages/man2/getrandom.2.html

   (2) https://www.python.org/dev/peps/pep-0524


File: python.info,  Node: io — Core tools for working with streams,  Next: time — Time access and conversions,  Prev: os — Miscellaneous operating system interfaces,  Up: Generic Operating System Services

5.16.2 ‘io’ — Core tools for working with streams
-------------------------------------------------

`Source code:' Lib/io.py(1)

__________________________________________________________________

* Menu:

* Overview::
* High-level Module Interface::
* Class hierarchy::
* Performance: Performance<3>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/io.py


File: python.info,  Node: Overview,  Next: High-level Module Interface,  Up: io — Core tools for working with streams

5.16.2.1 Overview
.................

The *note io: a1. module provides Python’s main facilities for dealing
with various types of I/O. There are three main types of I/O: `text
I/O', `binary I/O' and `raw I/O'. These are generic categories, and
various backing stores can be used for each of them.  A concrete object
belonging to any of these categories is called a *note file object: b35.
Other common terms are `stream' and `file-like object'.

Independent of its category, each concrete stream object will also have
various capabilities: it can be read-only, write-only, or read-write.
It can also allow arbitrary random access (seeking forwards or backwards
to any location), or only sequential access (for example in the case of
a socket or pipe).

All streams are careful about the type of data you give to them.  For
example giving a *note str: 325. object to the ‘write()’ method of a
binary stream will raise a *note TypeError: 192.  So will giving a *note
bytes: 326. object to the ‘write()’ method of a text stream.

Changed in version 3.3: Operations that used to raise *note IOError:
986. now raise *note OSError: 1d1, since *note IOError: 986. is now an
alias of *note OSError: 1d1.

* Menu:

* Text I/O::
* Binary I/O::
* Raw I/O::


File: python.info,  Node: Text I/O,  Next: Binary I/O,  Up: Overview

5.16.2.2 Text I/O
.................

Text I/O expects and produces *note str: 325. objects.  This means that
whenever the backing store is natively made of bytes (such as in the
case of a file), encoding and decoding of data is made transparently as
well as optional translation of platform-specific newline characters.

The easiest way to create a text stream is with *note open(): 4e5,
optionally specifying an encoding:

     f = open("myfile.txt", "r", encoding="utf-8")

In-memory text streams are also available as *note StringIO: 821.
objects:

     f = io.StringIO("some initial text data")

The text stream API is described in detail in the documentation of *note
TextIOBase: c2c.


File: python.info,  Node: Binary I/O,  Next: Raw I/O,  Prev: Text I/O,  Up: Overview

5.16.2.3 Binary I/O
...................

Binary I/O (also called `buffered I/O') expects *note bytes-like
objects: 5dd. and produces *note bytes: 326. objects.  No encoding,
decoding, or newline translation is performed.  This category of streams
can be used for all kinds of non-text data, and also when manual control
over the handling of text data is desired.

The easiest way to create a binary stream is with *note open(): 4e5.
with ‘'b'’ in the mode string:

     f = open("myfile.jpg", "rb")

In-memory binary streams are also available as *note BytesIO: 78f.
objects:

     f = io.BytesIO(b"some initial binary data: \x00\x01")

The binary stream API is described in detail in the docs of *note
BufferedIOBase: 57d.

Other library modules may provide additional ways to create text or
binary streams.  See *note socket.socket.makefile(): b0c. for example.


File: python.info,  Node: Raw I/O,  Prev: Binary I/O,  Up: Overview

5.16.2.4 Raw I/O
................

Raw I/O (also called `unbuffered I/O') is generally used as a low-level
building-block for binary and text streams; it is rarely useful to
directly manipulate a raw stream from user code.  Nevertheless, you can
create a raw stream by opening a file in binary mode with buffering
disabled:

     f = open("myfile.jpg", "rb", buffering=0)

The raw stream API is described in detail in the docs of *note
RawIOBase: a08.


File: python.info,  Node: High-level Module Interface,  Next: Class hierarchy,  Prev: Overview,  Up: io — Core tools for working with streams

5.16.2.5 High-level Module Interface
....................................

 -- Data: io.DEFAULT_BUFFER_SIZE

     An int containing the default buffer size used by the module’s
     buffered I/O classes.  *note open(): 4e5. uses the file’s blksize
     (as obtained by *note os.stat(): 1ef.) if possible.

 -- Function: io.open (file, mode='r', buffering=-1, encoding=None,
          errors=None, newline=None, closefd=True, opener=None)

     This is an alias for the builtin *note open(): 4e5. function.

     This function raises an *note auditing event: 1275. ‘open’ with
     arguments ‘path’, ‘mode’ and ‘flags’.  The ‘mode’ and ‘flags’
     arguments may have been modified or inferred from the original
     call.

 -- Function: io.open_code (path)

     Opens the provided file with mode ‘'rb'’.  This function should be
     used when the intent is to treat the contents as executable code.

     ‘path’ should be an absolute path.

     The behavior of this function may be overridden by an earlier call
     to the *note PyFile_SetOpenCodeHook(): 1f24, however, it should
     always be considered interchangeable with ‘open(path, 'rb')’.
     Overriding the behavior is intended for additional validation or
     preprocessing of the file.

     New in version 3.8.

 -- Exception: io.BlockingIOError

     This is a compatibility alias for the builtin *note
     BlockingIOError: 98b. exception.

 -- Exception: io.UnsupportedOperation

     An exception inheriting *note OSError: 1d1. and *note ValueError:
     1f9. that is raised when an unsupported operation is called on a
     stream.

* Menu:

* In-memory streams::


File: python.info,  Node: In-memory streams,  Up: High-level Module Interface

5.16.2.6 In-memory streams
..........................

It is also possible to use a *note str: 325. or *note bytes-like object:
5dd. as a file for both reading and writing.  For strings *note
StringIO: 821. can be used like a file opened in text mode.  *note
BytesIO: 78f. can be used like a file opened in binary mode.  Both
provide full read-write capabilities with random access.

See also
........

*note sys: fd.

     contains the standard IO streams: *note sys.stdin: 302, *note
     sys.stdout: 303, and *note sys.stderr: 304.


File: python.info,  Node: Class hierarchy,  Next: Performance<3>,  Prev: High-level Module Interface,  Up: io — Core tools for working with streams

5.16.2.7 Class hierarchy
........................

The implementation of I/O streams is organized as a hierarchy of
classes.  First *note abstract base classes: b26. (ABCs), which are used
to specify the various categories of streams, then concrete classes
providing the standard stream implementations.

          Note: The abstract base classes also provide default
          implementations of some methods in order to help
          implementation of concrete stream classes.  For example, *note
          BufferedIOBase: 57d. provides unoptimized implementations of
          ‘readinto()’ and *note readline(): 163f.

At the top of the I/O hierarchy is the abstract base class *note IOBase:
1d9.  It defines the basic interface to a stream.  Note, however, that
there is no separation between reading and writing to streams;
implementations are allowed to raise *note UnsupportedOperation: 1f26.
if they do not support a given operation.

The *note RawIOBase: a08. ABC extends *note IOBase: 1d9.  It deals with
the reading and writing of bytes to a stream.  *note FileIO: c97.
subclasses *note RawIOBase: a08. to provide an interface to files in the
machine’s file system.

The *note BufferedIOBase: 57d. ABC deals with buffering on a raw byte
stream (*note RawIOBase: a08.).  Its subclasses, *note BufferedWriter:
1538, *note BufferedReader: b7d, and *note BufferedRWPair: 1f29. buffer
streams that are readable, writable, and both readable and writable.
*note BufferedRandom: 1539. provides a buffered interface to random
access streams.  Another *note BufferedIOBase: 57d. subclass, *note
BytesIO: 78f, is a stream of in-memory bytes.

The *note TextIOBase: c2c. ABC, another subclass of *note IOBase: 1d9,
deals with streams whose bytes represent text, and handles encoding and
decoding to and from strings.  *note TextIOWrapper: 5e8, which extends
it, is a buffered text interface to a buffered raw stream (*note
BufferedIOBase: 57d.).  Finally, *note StringIO: 821. is an in-memory
stream for text.

Argument names are not part of the specification, and only the arguments
of *note open(): 4e5. are intended to be used as keyword arguments.

The following table summarizes the ABCs provided by the *note io: a1.
module:

ABC                           Inherits               Stub Methods                 Mixin Methods and Properties
                                                                                  
-----------------------------------------------------------------------------------------------------------------------------------------
                                                                                  
*note IOBase: 1d9.                                   ‘fileno’, ‘seek’, and        ‘close’, ‘closed’, ‘__enter__’, ‘__exit__’, ‘flush’,
                                                     ‘truncate’                   ‘isatty’, ‘__iter__’, ‘__next__’, ‘readable’,
                                                                                  ‘readline’, ‘readlines’, ‘seekable’, ‘tell’,
                                                                                  ‘writable’, and ‘writelines’
                                                                                  
                                                                                  
*note RawIOBase: a08.         *note IOBase: 1d9.     ‘readinto’ and ‘write’       Inherited *note IOBase: 1d9. methods, ‘read’, and
                                                                                  ‘readall’
                                                                                  
                                                                                  
*note BufferedIOBase: 57d.    *note IOBase: 1d9.     ‘detach’, ‘read’, ‘read1’,   Inherited *note IOBase: 1d9. methods, ‘readinto’,
                                                     and ‘write’                  and ‘readinto1’
                                                                                  
                                                                                  
*note TextIOBase: c2c.        *note IOBase: 1d9.     ‘detach’, ‘read’,            Inherited *note IOBase: 1d9. methods, ‘encoding’,
                                                     ‘readline’, and ‘write’      ‘errors’, and ‘newlines’
                                                                                  

* Menu:

* I/O Base Classes::
* Raw File I/O::
* Buffered Streams::
* Text I/O: Text I/O<2>.


File: python.info,  Node: I/O Base Classes,  Next: Raw File I/O,  Up: Class hierarchy

5.16.2.8 I/O Base Classes
.........................

 -- Class: io.IOBase

     The abstract base class for all I/O classes, acting on streams of
     bytes.  There is no public constructor.

     This class provides empty abstract implementations for many methods
     that derived classes can override selectively; the default
     implementations represent a file that cannot be read, written or
     seeked.

     Even though *note IOBase: 1d9. does not declare ‘read()’ or
     ‘write()’ because their signatures will vary, implementations and
     clients should consider those methods part of the interface.  Also,
     implementations may raise a *note ValueError: 1f9. (or *note
     UnsupportedOperation: 1f26.) when operations they do not support
     are called.

     The basic type used for binary data read from or written to a file
     is *note bytes: 326.  Other *note bytes-like objects: 5dd. are
     accepted as method arguments too.  Text I/O classes work with *note
     str: 325. data.

     Note that calling any method (even inquiries) on a closed stream is
     undefined.  Implementations may raise *note ValueError: 1f9. in
     this case.

     *note IOBase: 1d9. (and its subclasses) supports the iterator
     protocol, meaning that an *note IOBase: 1d9. object can be iterated
     over yielding the lines in a stream.  Lines are defined slightly
     differently depending on whether the stream is a binary stream
     (yielding bytes), or a text stream (yielding character strings).
     See *note readline(): 163f. below.

     *note IOBase: 1d9. is also a context manager and therefore supports
     the *note with: 6dd. statement.  In this example, `file' is closed
     after the ‘with’ statement’s suite is finished—even if an exception
     occurs:

          with open('spam.txt', 'w') as file:
              file.write('Spam and eggs!')

     *note IOBase: 1d9. provides these data attributes and methods:

      -- Method: close ()

          Flush and close this stream.  This method has no effect if the
          file is already closed.  Once the file is closed, any
          operation on the file (e.g.  reading or writing) will raise a
          *note ValueError: 1f9.

          As a convenience, it is allowed to call this method more than
          once; only the first call, however, will have an effect.

      -- Attribute: closed

          ‘True’ if the stream is closed.

      -- Method: fileno ()

          Return the underlying file descriptor (an integer) of the
          stream if it exists.  An *note OSError: 1d1. is raised if the
          IO object does not use a file descriptor.

      -- Method: flush ()

          Flush the write buffers of the stream if applicable.  This
          does nothing for read-only and non-blocking streams.

      -- Method: isatty ()

          Return ‘True’ if the stream is interactive (i.e., connected to
          a terminal/tty device).

      -- Method: readable ()

          Return ‘True’ if the stream can be read from.  If ‘False’,
          ‘read()’ will raise *note OSError: 1d1.

      -- Method: readline (size=-1)

          Read and return one line from the stream.  If `size' is
          specified, at most `size' bytes will be read.

          The line terminator is always ‘b'\n'’ for binary files; for
          text files, the `newline' argument to *note open(): 4e5. can
          be used to select the line terminator(s) recognized.

      -- Method: readlines (hint=-1)

          Read and return a list of lines from the stream.  `hint' can
          be specified to control the number of lines read: no more
          lines will be read if the total size (in bytes/characters) of
          all lines so far exceeds `hint'.

          Note that it’s already possible to iterate on file objects
          using ‘for line in file: ...’ without calling
          ‘file.readlines()’.

      -- Method: seek (offset, whence=SEEK_SET)

          Change the stream position to the given byte `offset'.
          `offset' is interpreted relative to the position indicated by
          `whence'.  The default value for `whence' is ‘SEEK_SET’.
          Values for `whence' are:

             * ‘SEEK_SET’ or ‘0’ – start of the stream (the default);
               `offset' should be zero or positive

             * ‘SEEK_CUR’ or ‘1’ – current stream position; `offset' may
               be negative

             * ‘SEEK_END’ or ‘2’ – end of the stream; `offset' is
               usually negative

          Return the new absolute position.

          New in version 3.1: The ‘SEEK_*’ constants.

          New in version 3.3: Some operating systems could support
          additional values, like ‘os.SEEK_HOLE’ or ‘os.SEEK_DATA’.  The
          valid values for a file could depend on it being open in text
          or binary mode.

      -- Method: seekable ()

          Return ‘True’ if the stream supports random access.  If
          ‘False’, *note seek(): 1cd1, *note tell(): 1cd2. and *note
          truncate(): c98. will raise *note OSError: 1d1.

      -- Method: tell ()

          Return the current stream position.

      -- Method: truncate (size=None)

          Resize the stream to the given `size' in bytes (or the current
          position if `size' is not specified).  The current stream
          position isn’t changed.  This resizing can extend or reduce
          the current file size.  In case of extension, the contents of
          the new file area depend on the platform (on most systems,
          additional bytes are zero-filled).  The new file size is
          returned.

          Changed in version 3.5: Windows will now zero-fill files when
          extending.

      -- Method: writable ()

          Return ‘True’ if the stream supports writing.  If ‘False’,
          ‘write()’ and *note truncate(): c98. will raise *note OSError:
          1d1.

      -- Method: writelines (lines)

          Write a list of lines to the stream.  Line separators are not
          added, so it is usual for each of the lines provided to have a
          line separator at the end.

      -- Method: __del__ ()

          Prepare for object destruction.  *note IOBase: 1d9. provides a
          default implementation of this method that calls the
          instance’s *note close(): f43. method.

 -- Class: io.RawIOBase

     Base class for raw binary I/O. It inherits *note IOBase: 1d9.
     There is no public constructor.

     Raw binary I/O typically provides low-level access to an underlying
     OS device or API, and does not try to encapsulate it in high-level
     primitives (this is left to Buffered I/O and Text I/O, described
     later in this page).

     In addition to the attributes and methods from *note IOBase: 1d9,
     *note RawIOBase: a08. provides the following methods:

      -- Method: read (size=-1)

          Read up to `size' bytes from the object and return them.  As a
          convenience, if `size' is unspecified or -1, all bytes until
          EOF are returned.  Otherwise, only one system call is ever
          made.  Fewer than `size' bytes may be returned if the
          operating system call returns fewer than `size' bytes.

          If 0 bytes are returned, and `size' was not 0, this indicates
          end of file.  If the object is in non-blocking mode and no
          bytes are available, ‘None’ is returned.

          The default implementation defers to *note readall(): 1f30.
          and *note readinto(): 6f7.

      -- Method: readall ()

          Read and return all the bytes from the stream until EOF, using
          multiple calls to the stream if necessary.

      -- Method: readinto (b)

          Read bytes into a pre-allocated, writable *note bytes-like
          object: 5dd. `b', and return the number of bytes read.  For
          example, `b' might be a *note bytearray: 327.  If the object
          is in non-blocking mode and no bytes are available, ‘None’ is
          returned.

      -- Method: write (b)

          Write the given *note bytes-like object: 5dd, `b', to the
          underlying raw stream, and return the number of bytes written.
          This can be less than the length of `b' in bytes, depending on
          specifics of the underlying raw stream, and especially if it
          is in non-blocking mode.  ‘None’ is returned if the raw stream
          is set not to block and no single byte could be readily
          written to it.  The caller may release or mutate `b' after
          this method returns, so the implementation should only access
          `b' during the method call.

 -- Class: io.BufferedIOBase

     Base class for binary streams that support some kind of buffering.
     It inherits *note IOBase: 1d9.  There is no public constructor.

     The main difference with *note RawIOBase: a08. is that methods
     *note read(): 1c91, *note readinto(): 1f32. and *note write(): 57e.
     will try (respectively) to read as much input as requested or to
     consume all given output, at the expense of making perhaps more
     than one system call.

     In addition, those methods can raise *note BlockingIOError: 98b. if
     the underlying raw stream is in non-blocking mode and cannot take
     or give enough data; unlike their *note RawIOBase: a08.
     counterparts, they will never return ‘None’.

     Besides, the *note read(): 1c91. method does not have a default
     implementation that defers to *note readinto(): 1f32.

     A typical *note BufferedIOBase: 57d. implementation should not
     inherit from a *note RawIOBase: a08. implementation, but wrap one,
     like *note BufferedWriter: 1538. and *note BufferedReader: b7d. do.

     *note BufferedIOBase: 57d. provides or overrides these methods and
     attribute in addition to those from *note IOBase: 1d9.:

      -- Attribute: raw

          The underlying raw stream (a *note RawIOBase: a08. instance)
          that *note BufferedIOBase: 57d. deals with.  This is not part
          of the *note BufferedIOBase: 57d. API and may not exist on
          some implementations.

      -- Method: detach ()

          Separate the underlying raw stream from the buffer and return
          it.

          After the raw stream has been detached, the buffer is in an
          unusable state.

          Some buffers, like *note BytesIO: 78f, do not have the concept
          of a single raw stream to return from this method.  They raise
          *note UnsupportedOperation: 1f26.

          New in version 3.1.

      -- Method: read (size=-1)

          Read and return up to `size' bytes.  If the argument is
          omitted, ‘None’, or negative, data is read and returned until
          EOF is reached.  An empty *note bytes: 326. object is returned
          if the stream is already at EOF.

          If the argument is positive, and the underlying raw stream is
          not interactive, multiple raw reads may be issued to satisfy
          the byte count (unless EOF is reached first).  But for
          interactive raw streams, at most one raw read will be issued,
          and a short result does not imply that EOF is imminent.

          A *note BlockingIOError: 98b. is raised if the underlying raw
          stream is in non blocking-mode, and has no data available at
          the moment.

      -- Method: read1 ([size])

          Read and return up to `size' bytes, with at most one call to
          the underlying raw stream’s *note read(): 6f6. (or *note
          readinto(): 6f7.) method.  This can be useful if you are
          implementing your own buffering on top of a *note
          BufferedIOBase: 57d. object.

          If `size' is ‘-1’ (the default), an arbitrary number of bytes
          are returned (more than zero unless EOF is reached).

      -- Method: readinto (b)

          Read bytes into a pre-allocated, writable *note bytes-like
          object: 5dd. `b' and return the number of bytes read.  For
          example, `b' might be a *note bytearray: 327.

          Like *note read(): 1c91, multiple reads may be issued to the
          underlying raw stream, unless the latter is interactive.

          A *note BlockingIOError: 98b. is raised if the underlying raw
          stream is in non blocking-mode, and has no data available at
          the moment.

      -- Method: readinto1 (b)

          Read bytes into a pre-allocated, writable *note bytes-like
          object: 5dd. `b', using at most one call to the underlying raw
          stream’s *note read(): 6f6. (or *note readinto(): 6f7.)
          method.  Return the number of bytes read.

          A *note BlockingIOError: 98b. is raised if the underlying raw
          stream is in non blocking-mode, and has no data available at
          the moment.

          New in version 3.5.

      -- Method: write (b)

          Write the given *note bytes-like object: 5dd, `b', and return
          the number of bytes written (always equal to the length of `b'
          in bytes, since if the write fails an *note OSError: 1d1. will
          be raised).  Depending on the actual implementation, these
          bytes may be readily written to the underlying stream, or held
          in a buffer for performance and latency reasons.

          When in non-blocking mode, a *note BlockingIOError: 98b. is
          raised if the data needed to be written to the raw stream but
          it couldn’t accept all the data without blocking.

          The caller may release or mutate `b' after this method
          returns, so the implementation should only access `b' during
          the method call.


File: python.info,  Node: Raw File I/O,  Next: Buffered Streams,  Prev: I/O Base Classes,  Up: Class hierarchy

5.16.2.9 Raw File I/O
.....................

 -- Class: io.FileIO (name, mode='r', closefd=True, opener=None)

     *note FileIO: c97. represents an OS-level file containing bytes
     data.  It implements the *note RawIOBase: a08. interface (and
     therefore the *note IOBase: 1d9. interface, too).

     The `name' can be one of two things:

        * a character string or *note bytes: 326. object representing
          the path to the file which will be opened.  In this case
          closefd must be ‘True’ (the default) otherwise an error will
          be raised.

        * an integer representing the number of an existing OS-level
          file descriptor to which the resulting *note FileIO: c97.
          object will give access.  When the FileIO object is closed
          this fd will be closed as well, unless `closefd' is set to
          ‘False’.

     The `mode' can be ‘'r'’, ‘'w'’, ‘'x'’ or ‘'a'’ for reading
     (default), writing, exclusive creation or appending.  The file will
     be created if it doesn’t exist when opened for writing or
     appending; it will be truncated when opened for writing.  *note
     FileExistsError: 94c. will be raised if it already exists when
     opened for creating.  Opening a file for creating implies writing,
     so this mode behaves in a similar way to ‘'w'’.  Add a ‘'+'’ to the
     mode to allow simultaneous reading and writing.

     The ‘read()’ (when called with a positive argument), ‘readinto()’
     and ‘write()’ methods on this class will only make one system call.

     A custom opener can be used by passing a callable as `opener'.  The
     underlying file descriptor for the file object is then obtained by
     calling `opener' with (`name', `flags').  `opener' must return an
     open file descriptor (passing *note os.open: 659. as `opener'
     results in functionality similar to passing ‘None’).

     The newly created file is *note non-inheritable: 7ee.

     See the *note open(): 4e5. built-in function for examples on using
     the `opener' parameter.

     Changed in version 3.3: The `opener' parameter was added.  The
     ‘'x'’ mode was added.

     Changed in version 3.4: The file is now non-inheritable.

     In addition to the attributes and methods from *note IOBase: 1d9.
     and *note RawIOBase: a08, *note FileIO: c97. provides the following
     data attributes:

      -- Attribute: mode

          The mode as given in the constructor.

      -- Attribute: name

          The file name.  This is the file descriptor of the file when
          no name is given in the constructor.


File: python.info,  Node: Buffered Streams,  Next: Text I/O<2>,  Prev: Raw File I/O,  Up: Class hierarchy

5.16.2.10 Buffered Streams
..........................

Buffered I/O streams provide a higher-level interface to an I/O device
than raw I/O does.

 -- Class: io.BytesIO ([initial_bytes])

     A stream implementation using an in-memory bytes buffer.  It
     inherits *note BufferedIOBase: 57d.  The buffer is discarded when
     the *note close(): f43. method is called.

     The optional argument `initial_bytes' is a *note bytes-like object:
     5dd. that contains initial data.

     *note BytesIO: 78f. provides or overrides these methods in addition
     to those from *note BufferedIOBase: 57d. and *note IOBase: 1d9.:

      -- Method: getbuffer ()

          Return a readable and writable view over the contents of the
          buffer without copying them.  Also, mutating the view will
          transparently update the contents of the buffer:

               >>> b = io.BytesIO(b"abcdef")
               >>> view = b.getbuffer()
               >>> view[2:4] = b"56"
               >>> b.getvalue()
               b'ab56ef'

               Note: As long as the view exists, the *note BytesIO: 78f.
               object cannot be resized or closed.

          New in version 3.2.

      -- Method: getvalue ()

          Return *note bytes: 326. containing the entire contents of the
          buffer.

      -- Method: read1 ([size])

          In *note BytesIO: 78f, this is the same as *note read(): 1c91.

          Changed in version 3.7: The `size' argument is now optional.

      -- Method: readinto1 (b)

          In *note BytesIO: 78f, this is the same as *note readinto():
          1f32.

          New in version 3.5.

 -- Class: io.BufferedReader (raw, buffer_size=DEFAULT_BUFFER_SIZE)

     A buffer providing higher-level access to a readable, sequential
     *note RawIOBase: a08. object.  It inherits *note BufferedIOBase:
     57d.  When reading data from this object, a larger amount of data
     may be requested from the underlying raw stream, and kept in an
     internal buffer.  The buffered data can then be returned directly
     on subsequent reads.

     The constructor creates a *note BufferedReader: b7d. for the given
     readable `raw' stream and `buffer_size'.  If `buffer_size' is
     omitted, *note DEFAULT_BUFFER_SIZE: 1534. is used.

     *note BufferedReader: b7d. provides or overrides these methods in
     addition to those from *note BufferedIOBase: 57d. and *note IOBase:
     1d9.:

      -- Method: peek ([size])

          Return bytes from the stream without advancing the position.
          At most one single read on the raw stream is done to satisfy
          the call.  The number of bytes returned may be less or more
          than requested.

      -- Method: read ([size])

          Read and return `size' bytes, or if `size' is not given or
          negative, until EOF or if the read call would block in
          non-blocking mode.

      -- Method: read1 ([size])

          Read and return up to `size' bytes with only one call on the
          raw stream.  If at least one byte is buffered, only buffered
          bytes are returned.  Otherwise, one raw stream read call is
          made.

          Changed in version 3.7: The `size' argument is now optional.

 -- Class: io.BufferedWriter (raw, buffer_size=DEFAULT_BUFFER_SIZE)

     A buffer providing higher-level access to a writeable, sequential
     *note RawIOBase: a08. object.  It inherits *note BufferedIOBase:
     57d.  When writing to this object, data is normally placed into an
     internal buffer.  The buffer will be written out to the underlying
     *note RawIOBase: a08. object under various conditions, including:

        * when the buffer gets too small for all pending data;

        * when *note flush(): 1f3d. is called;

        * when a ‘seek()’ is requested (for *note BufferedRandom: 1539.
          objects);

        * when the *note BufferedWriter: 1538. object is closed or
          destroyed.

     The constructor creates a *note BufferedWriter: 1538. for the given
     writeable `raw' stream.  If the `buffer_size' is not given, it
     defaults to *note DEFAULT_BUFFER_SIZE: 1534.

     *note BufferedWriter: 1538. provides or overrides these methods in
     addition to those from *note BufferedIOBase: 57d. and *note IOBase:
     1d9.:

      -- Method: flush ()

          Force bytes held in the buffer into the raw stream.  A *note
          BlockingIOError: 98b. should be raised if the raw stream
          blocks.

      -- Method: write (b)

          Write the *note bytes-like object: 5dd, `b', and return the
          number of bytes written.  When in non-blocking mode, a *note
          BlockingIOError: 98b. is raised if the buffer needs to be
          written out but the raw stream blocks.

 -- Class: io.BufferedRandom (raw, buffer_size=DEFAULT_BUFFER_SIZE)

     A buffered interface to random access streams.  It inherits *note
     BufferedReader: b7d. and *note BufferedWriter: 1538.

     The constructor creates a reader and writer for a seekable raw
     stream, given in the first argument.  If the `buffer_size' is
     omitted it defaults to *note DEFAULT_BUFFER_SIZE: 1534.

     *note BufferedRandom: 1539. is capable of anything *note
     BufferedReader: b7d. or *note BufferedWriter: 1538. can do.  In
     addition, ‘seek()’ and ‘tell()’ are guaranteed to be implemented.

 -- Class: io.BufferedRWPair (reader, writer,
          buffer_size=DEFAULT_BUFFER_SIZE)

     A buffered I/O object combining two unidirectional *note RawIOBase:
     a08. objects – one readable, the other writeable – into a single
     bidirectional endpoint.  It inherits *note BufferedIOBase: 57d.

     `reader' and `writer' are *note RawIOBase: a08. objects that are
     readable and writeable respectively.  If the `buffer_size' is
     omitted it defaults to *note DEFAULT_BUFFER_SIZE: 1534.

     *note BufferedRWPair: 1f29. implements all of *note BufferedIOBase:
     57d.’s methods except for *note detach(): 1f34, which raises *note
     UnsupportedOperation: 1f26.

          Warning: *note BufferedRWPair: 1f29. does not attempt to
          synchronize accesses to its underlying raw streams.  You
          should not pass it the same object as reader and writer; use
          *note BufferedRandom: 1539. instead.


File: python.info,  Node: Text I/O<2>,  Prev: Buffered Streams,  Up: Class hierarchy

5.16.2.11 Text I/O
..................

 -- Class: io.TextIOBase

     Base class for text streams.  This class provides a character and
     line based interface to stream I/O. It inherits *note IOBase: 1d9.
     There is no public constructor.

     *note TextIOBase: c2c. provides or overrides these data attributes
     and methods in addition to those from *note IOBase: 1d9.:

      -- Attribute: encoding

          The name of the encoding used to decode the stream’s bytes
          into strings, and to encode strings into bytes.

      -- Attribute: errors

          The error setting of the decoder or encoder.

      -- Attribute: newlines

          A string, a tuple of strings, or ‘None’, indicating the
          newlines translated so far.  Depending on the implementation
          and the initial constructor flags, this may not be available.

      -- Attribute: buffer

          The underlying binary buffer (a *note BufferedIOBase: 57d.
          instance) that *note TextIOBase: c2c. deals with.  This is not
          part of the *note TextIOBase: c2c. API and may not exist in
          some implementations.

      -- Method: detach ()

          Separate the underlying binary buffer from the *note
          TextIOBase: c2c. and return it.

          After the underlying buffer has been detached, the *note
          TextIOBase: c2c. is in an unusable state.

          Some *note TextIOBase: c2c. implementations, like *note
          StringIO: 821, may not have the concept of an underlying
          buffer and calling this method will raise *note
          UnsupportedOperation: 1f26.

          New in version 3.1.

      -- Method: read (size=-1)

          Read and return at most `size' characters from the stream as a
          single *note str: 325.  If `size' is negative or ‘None’, reads
          until EOF.

      -- Method: readline (size=-1)

          Read until newline or EOF and return a single ‘str’.  If the
          stream is already at EOF, an empty string is returned.

          If `size' is specified, at most `size' characters will be
          read.

      -- Method: seek (offset, whence=SEEK_SET)

          Change the stream position to the given `offset'.  Behaviour
          depends on the `whence' parameter.  The default value for
          `whence' is ‘SEEK_SET’.

             * ‘SEEK_SET’ or ‘0’: seek from the start of the stream (the
               default); `offset' must either be a number returned by
               *note TextIOBase.tell(): 1f46, or zero.  Any other
               `offset' value produces undefined behaviour.

             * ‘SEEK_CUR’ or ‘1’: “seek” to the current position;
               `offset' must be zero, which is a no-operation (all other
               values are unsupported).

             * ‘SEEK_END’ or ‘2’: seek to the end of the stream;
               `offset' must be zero (all other values are unsupported).

          Return the new absolute position as an opaque number.

          New in version 3.1: The ‘SEEK_*’ constants.

      -- Method: tell ()

          Return the current stream position as an opaque number.  The
          number does not usually represent a number of bytes in the
          underlying binary storage.

      -- Method: write (s)

          Write the string `s' to the stream and return the number of
          characters written.

 -- Class: io.TextIOWrapper (buffer, encoding=None, errors=None,
          newline=None, line_buffering=False, write_through=False)

     A buffered text stream over a *note BufferedIOBase: 57d. binary
     stream.  It inherits *note TextIOBase: c2c.

     `encoding' gives the name of the encoding that the stream will be
     decoded or encoded with.  It defaults to *note
     locale.getpreferredencoding(False): 39a.

     `errors' is an optional string that specifies how encoding and
     decoding errors are to be handled.  Pass ‘'strict'’ to raise a
     *note ValueError: 1f9. exception if there is an encoding error (the
     default of ‘None’ has the same effect), or pass ‘'ignore'’ to
     ignore errors.  (Note that ignoring encoding errors can lead to
     data loss.)  ‘'replace'’ causes a replacement marker (such as
     ‘'?'’) to be inserted where there is malformed data.
     ‘'backslashreplace'’ causes malformed data to be replaced by a
     backslashed escape sequence.  When writing, ‘'xmlcharrefreplace'’
     (replace with the appropriate XML character reference) or
     ‘'namereplace'’ (replace with ‘\N{...}’ escape sequences) can be
     used.  Any other error handling name that has been registered with
     *note codecs.register_error(): de8. is also valid.

     `newline' controls how line endings are handled.  It can be ‘None’,
     ‘''’, ‘'\n'’, ‘'\r'’, and ‘'\r\n'’.  It works as follows:

        * When reading input from the stream, if `newline' is ‘None’,
          *note universal newlines: 5e9. mode is enabled.  Lines in the
          input can end in ‘'\n'’, ‘'\r'’, or ‘'\r\n'’, and these are
          translated into ‘'\n'’ before being returned to the caller.
          If it is ‘''’, universal newlines mode is enabled, but line
          endings are returned to the caller untranslated.  If it has
          any of the other legal values, input lines are only terminated
          by the given string, and the line ending is returned to the
          caller untranslated.

        * When writing output to the stream, if `newline' is ‘None’, any
          ‘'\n'’ characters written are translated to the system default
          line separator, *note os.linesep: 1537.  If `newline' is ‘''’
          or ‘'\n'’, no translation takes place.  If `newline' is any of
          the other legal values, any ‘'\n'’ characters written are
          translated to the given string.

     If `line_buffering' is ‘True’, ‘flush()’ is implied when a call to
     write contains a newline character or a carriage return.

     If `write_through' is ‘True’, calls to ‘write()’ are guaranteed not
     to be buffered: any data written on the *note TextIOWrapper: 5e8.
     object is immediately handled to its underlying binary `buffer'.

     Changed in version 3.3: The `write_through' argument has been
     added.

     Changed in version 3.3: The default `encoding' is now
     ‘locale.getpreferredencoding(False)’ instead of
     ‘locale.getpreferredencoding()’.  Don’t change temporary the locale
     encoding using *note locale.setlocale(): 1f48, use the current
     locale encoding instead of the user preferred encoding.

     *note TextIOWrapper: 5e8. provides these members in addition to
     those of *note TextIOBase: c2c. and its parents:

      -- Attribute: line_buffering

          Whether line buffering is enabled.

      -- Attribute: write_through

          Whether writes are passed immediately to the underlying binary
          buffer.

          New in version 3.7.

      -- Method: reconfigure (*[, encoding][, errors][, newline][,
               line_buffering][, write_through])

          Reconfigure this text stream using new settings for
          `encoding', `errors', `newline', `line_buffering' and
          `write_through'.

          Parameters not specified keep current settings, except
          ‘errors='strict'’ is used when `encoding' is specified but
          `errors' is not specified.

          It is not possible to change the encoding or newline if some
          data has already been read from the stream.  On the other
          hand, changing encoding after write is possible.

          This method does an implicit stream flush before setting the
          new parameters.

          New in version 3.7.

 -- Class: io.StringIO (initial_value='', newline='\n')

     An in-memory stream for text I/O. The text buffer is discarded when
     the *note close(): f43. method is called.

     The initial value of the buffer can be set by providing
     `initial_value'.  If newline translation is enabled, newlines will
     be encoded as if by *note write(): 1f47.  The stream is positioned
     at the start of the buffer.

     The `newline' argument works like that of *note TextIOWrapper: 5e8.
     The default is to consider only ‘\n’ characters as ends of lines
     and to do no newline translation.  If `newline' is set to ‘None’,
     newlines are written as ‘\n’ on all platforms, but universal
     newline decoding is still performed when reading.

     *note StringIO: 821. provides this method in addition to those from
     *note TextIOBase: c2c. and its parents:

      -- Method: getvalue ()

          Return a ‘str’ containing the entire contents of the buffer.
          Newlines are decoded as if by *note read(): 1f44, although the
          stream position is not changed.

     Example usage:

          import io

          output = io.StringIO()
          output.write('First line.\n')
          print('Second line.', file=output)

          # Retrieve file contents -- this will be
          # 'First line.\nSecond line.\n'
          contents = output.getvalue()

          # Close object and discard memory buffer --
          # .getvalue() will now raise an exception.
          output.close()

 -- Class: io.IncrementalNewlineDecoder

     A helper codec that decodes newlines for *note universal newlines:
     5e9. mode.  It inherits *note codecs.IncrementalDecoder: 1765.


File: python.info,  Node: Performance<3>,  Prev: Class hierarchy,  Up: io — Core tools for working with streams

5.16.2.12 Performance
.....................

This section discusses the performance of the provided concrete I/O
implementations.

* Menu:

* Binary I/O: Binary I/O<2>.
* Text I/O: Text I/O<3>.
* Multi-threading: Multi-threading<3>.
* Reentrancy::


File: python.info,  Node: Binary I/O<2>,  Next: Text I/O<3>,  Up: Performance<3>

5.16.2.13 Binary I/O
....................

By reading and writing only large chunks of data even when the user asks
for a single byte, buffered I/O hides any inefficiency in calling and
executing the operating system’s unbuffered I/O routines.  The gain
depends on the OS and the kind of I/O which is performed.  For example,
on some modern OSes such as Linux, unbuffered disk I/O can be as fast as
buffered I/O. The bottom line, however, is that buffered I/O offers
predictable performance regardless of the platform and the backing
device.  Therefore, it is almost always preferable to use buffered I/O
rather than unbuffered I/O for binary data.


File: python.info,  Node: Text I/O<3>,  Next: Multi-threading<3>,  Prev: Binary I/O<2>,  Up: Performance<3>

5.16.2.14 Text I/O
..................

Text I/O over a binary storage (such as a file) is significantly slower
than binary I/O over the same storage, because it requires conversions
between unicode and binary data using a character codec.  This can
become noticeable handling huge amounts of text data like large log
files.  Also, ‘TextIOWrapper.tell()’ and ‘TextIOWrapper.seek()’ are both
quite slow due to the reconstruction algorithm used.

*note StringIO: 821, however, is a native in-memory unicode container
and will exhibit similar speed to *note BytesIO: 78f.


File: python.info,  Node: Multi-threading<3>,  Next: Reentrancy,  Prev: Text I/O<3>,  Up: Performance<3>

5.16.2.15 Multi-threading
.........................

*note FileIO: c97. objects are thread-safe to the extent that the
operating system calls (such as ‘read(2)’ under Unix) they wrap are
thread-safe too.

Binary buffered objects (instances of *note BufferedReader: b7d, *note
BufferedWriter: 1538, *note BufferedRandom: 1539. and *note
BufferedRWPair: 1f29.) protect their internal structures using a lock;
it is therefore safe to call them from multiple threads at once.

*note TextIOWrapper: 5e8. objects are not thread-safe.


File: python.info,  Node: Reentrancy,  Prev: Multi-threading<3>,  Up: Performance<3>

5.16.2.16 Reentrancy
....................

Binary buffered objects (instances of *note BufferedReader: b7d, *note
BufferedWriter: 1538, *note BufferedRandom: 1539. and *note
BufferedRWPair: 1f29.) are not reentrant.  While reentrant calls will
not happen in normal situations, they can arise from doing I/O in a
*note signal: ea. handler.  If a thread tries to re-enter a buffered
object which it is already accessing, a *note RuntimeError: 2b8. is
raised.  Note this doesn’t prohibit a different thread from entering the
buffered object.

The above implicitly extends to text files, since the *note open(): 4e5.
function will wrap a buffered object inside a *note TextIOWrapper: 5e8.
This includes standard streams and therefore affects the built-in
function *note print(): 87a. as well.


File: python.info,  Node: time — Time access and conversions,  Next: argparse — Parser for command-line options arguments and sub-commands,  Prev: io — Core tools for working with streams,  Up: Generic Operating System Services

5.16.3 ‘time’ — Time access and conversions
-------------------------------------------

__________________________________________________________________

This module provides various time-related functions.  For related
functionality, see also the *note datetime: 31. and *note calendar: 15.
modules.

Although this module is always available, not all functions are
available on all platforms.  Most of the functions defined in this
module call platform C library functions with the same name.  It may
sometimes be helpful to consult the platform documentation, because the
semantics of these functions varies among platforms.

An explanation of some terminology and conventions is in order.

   * The `epoch' is the point where the time starts, and is platform
     dependent.  For Unix, the epoch is January 1, 1970, 00:00:00 (UTC).
     To find out what the epoch is on a given platform, look at
     ‘time.gmtime(0)’.

   * The term `seconds since the epoch' refers to the total number of
     elapsed seconds since the epoch, typically excluding leap
     seconds(1).  Leap seconds are excluded from this total on all
     POSIX-compliant platforms.

   * The functions in this module may not handle dates and times before
     the epoch or far in the future.  The cut-off point in the future is
     determined by the C library; for 32-bit systems, it is typically in
     2038.

   * Function *note strptime(): d84. can parse 2-digit years when given
     ‘%y’ format code.  When 2-digit years are parsed, they are
     converted according to the POSIX and ISO C standards: values 69–99
     are mapped to 1969–1999, and values 0–68 are mapped to 2000–2068.

   * UTC is Coordinated Universal Time (formerly known as Greenwich Mean
     Time, or GMT). The acronym UTC is not a mistake but a compromise
     between English and French.

   * DST is Daylight Saving Time, an adjustment of the timezone by
     (usually) one hour during part of the year.  DST rules are magic
     (determined by local law) and can change from year to year.  The C
     library has a table containing the local rules (often it is read
     from a system file for flexibility) and is the only source of True
     Wisdom in this respect.

   * The precision of the various real-time functions may be less than
     suggested by the units in which their value or argument is
     expressed.  E.g.  on most Unix systems, the clock “ticks” only 50
     or 100 times a second.

   * On the other hand, the precision of *note time(): 312. and *note
     sleep(): 674. is better than their Unix equivalents: times are
     expressed as floating point numbers, *note time(): 312. returns the
     most accurate time available (using Unix ‘gettimeofday()’ where
     available), and *note sleep(): 674. will accept a time with a
     nonzero fraction (Unix ‘select()’ is used to implement this, where
     available).

   * The time value as returned by *note gmtime(): b32, *note
     localtime(): 17ea, and *note strptime(): d84, and accepted by *note
     asctime(): b56, *note mktime(): b57. and *note strftime(): b58, is
     a sequence of 9 integers.  The return values of *note gmtime():
     b32, *note localtime(): 17ea, and *note strptime(): d84. also offer
     attribute names for individual fields.

     See *note struct_time: 58e. for a description of these objects.

     Changed in version 3.3: The *note struct_time: 58e. type was
     extended to provide the ‘tm_gmtoff’ and ‘tm_zone’ attributes when
     platform supports corresponding ‘struct tm’ members.

     Changed in version 3.6: The *note struct_time: 58e. attributes
     ‘tm_gmtoff’ and ‘tm_zone’ are now available on all platforms.

   * Use the following functions to convert between time
     representations:

     From                          To                            Use
                                                                 
     ------------------------------------------------------------------------------------------
                                                                 
     seconds since the epoch       *note struct_time: 58e. in    *note gmtime(): b32.
                                   UTC                           
                                   
                                                                 
     seconds since the epoch       *note struct_time: 58e. in    *note localtime(): 17ea.
                                   local time                    
                                   
                                                                 
     *note struct_time: 58e. in    seconds since the epoch       *note calendar.timegm(): 1857.
     UTC                                                         

     *note struct_time: 58e. in    seconds since the epoch       *note mktime(): b57.
     local time                                                  

* Menu:

* Functions: Functions<2>.
* Clock ID Constants::
* Timezone Constants::

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Leap_second


File: python.info,  Node: Functions<2>,  Next: Clock ID Constants,  Up: time — Time access and conversions

5.16.3.1 Functions
..................

 -- Function: time.asctime ([t])

     Convert a tuple or *note struct_time: 58e. representing a time as
     returned by *note gmtime(): b32. or *note localtime(): 17ea. to a
     string of the following form: ‘'Sun Jun 20 23:21:05 1993'’.  The
     day field is two characters long and is space padded if the day is
     a single digit, e.g.: ‘'Wed Jun 9 04:26:40 1993'’.

     If `t' is not provided, the current time as returned by *note
     localtime(): 17ea. is used.  Locale information is not used by
     *note asctime(): b56.

          Note: Unlike the C function of the same name, *note asctime():
          b56. does not add a trailing newline.

 -- Function: time.pthread_getcpuclockid (thread_id)

     Return the `clk_id' of the thread-specific CPU-time clock for the
     specified `thread_id'.

     Use *note threading.get_ident(): aa4. or the *note ident: 1f57.
     attribute of *note threading.Thread: 233. objects to get a suitable
     value for `thread_id'.

          Warning: Passing an invalid or expired `thread_id' may result
          in undefined behavior, such as segmentation fault.

     *note Availability: 129a.: Unix (see the man page for
     ‘pthread_getcpuclockid(3)’ for further information).

     New in version 3.7.

 -- Function: time.clock_getres (clk_id)

     Return the resolution (precision) of the specified clock `clk_id'.
     Refer to *note Clock ID Constants: 1f58. for a list of accepted
     values for `clk_id'.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: time.clock_gettime (clk_id) -> float

     Return the time of the specified clock `clk_id'.  Refer to *note
     Clock ID Constants: 1f58. for a list of accepted values for
     `clk_id'.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: time.clock_gettime_ns (clk_id) -> int

     Similar to *note clock_gettime(): aa8. but return time as
     nanoseconds.

     *note Availability: 129a.: Unix.

     New in version 3.7.

 -- Function: time.clock_settime (clk_id, time: float)

     Set the time of the specified clock `clk_id'.  Currently, *note
     CLOCK_REALTIME: 1f59. is the only accepted value for `clk_id'.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: time.clock_settime_ns (clk_id, time: int)

     Similar to *note clock_settime(): aa9. but set time with
     nanoseconds.

     *note Availability: 129a.: Unix.

     New in version 3.7.

 -- Function: time.ctime ([secs])

     Convert a time expressed in seconds since the epoch to a string of
     a form: ‘'Sun Jun 20 23:21:05 1993'’ representing local time.  The
     day field is two characters long and is space padded if the day is
     a single digit, e.g.: ‘'Wed Jun 9 04:26:40 1993'’.

     If `secs' is not provided or *note None: 157, the current time as
     returned by *note time(): 312. is used.  ‘ctime(secs)’ is
     equivalent to ‘asctime(localtime(secs))’.  Locale information is
     not used by *note ctime(): 17f0.

 -- Function: time.get_clock_info (name)

     Get information on the specified clock as a namespace object.
     Supported clock names and the corresponding functions to read their
     value are:

        * ‘'clock'’: ‘time.clock()’

        * ‘'monotonic'’: *note time.monotonic(): 763.

        * ‘'perf_counter'’: *note time.perf_counter(): 2a8.

        * ‘'process_time'’: *note time.process_time(): 2a9.

        * ‘'thread_time'’: *note time.thread_time(): 3ee.

        * ‘'time'’: *note time.time(): 312.

     The result has the following attributes:

        - `adjustable': ‘True’ if the clock can be changed automatically
          (e.g.  by a NTP daemon) or manually by the system
          administrator, ‘False’ otherwise

        - `implementation': The name of the underlying C function used
          to get the clock value.  Refer to *note Clock ID Constants:
          1f58. for possible values.

        - `monotonic': ‘True’ if the clock cannot go backward, ‘False’
          otherwise

        - `resolution': The resolution of the clock in seconds (*note
          float: 187.)

     New in version 3.3.

 -- Function: time.gmtime ([secs])

     Convert a time expressed in seconds since the epoch to a *note
     struct_time: 58e. in UTC in which the dst flag is always zero.  If
     `secs' is not provided or *note None: 157, the current time as
     returned by *note time(): 312. is used.  Fractions of a second are
     ignored.  See above for a description of the *note struct_time:
     58e. object.  See *note calendar.timegm(): 1857. for the inverse of
     this function.

 -- Function: time.localtime ([secs])

     Like *note gmtime(): b32. but converts to local time.  If `secs' is
     not provided or *note None: 157, the current time as returned by
     *note time(): 312. is used.  The dst flag is set to ‘1’ when DST
     applies to the given time.

 -- Function: time.mktime (t)

     This is the inverse function of *note localtime(): 17ea.  Its
     argument is the *note struct_time: 58e. or full 9-tuple (since the
     dst flag is needed; use ‘-1’ as the dst flag if it is unknown)
     which expresses the time in `local' time, not UTC. It returns a
     floating point number, for compatibility with *note time(): 312.
     If the input value cannot be represented as a valid time, either
     *note OverflowError: 954. or *note ValueError: 1f9. will be raised
     (which depends on whether the invalid value is caught by Python or
     the underlying C libraries).  The earliest date for which it can
     generate a time is platform-dependent.

 -- Function: time.monotonic () -> float

     Return the value (in fractional seconds) of a monotonic clock, i.e.
     a clock that cannot go backwards.  The clock is not affected by
     system clock updates.  The reference point of the returned value is
     undefined, so that only the difference between the results of
     consecutive calls is valid.

     New in version 3.3.

     Changed in version 3.5: The function is now always available and
     always system-wide.

 -- Function: time.monotonic_ns () -> int

     Similar to *note monotonic(): 763, but return time as nanoseconds.

     New in version 3.7.

 -- Function: time.perf_counter () -> float

     Return the value (in fractional seconds) of a performance counter,
     i.e.  a clock with the highest available resolution to measure a
     short duration.  It does include time elapsed during sleep and is
     system-wide.  The reference point of the returned value is
     undefined, so that only the difference between the results of
     consecutive calls is valid.

     New in version 3.3.

 -- Function: time.perf_counter_ns () -> int

     Similar to *note perf_counter(): 2a8, but return time as
     nanoseconds.

     New in version 3.7.

 -- Function: time.process_time () -> float

     Return the value (in fractional seconds) of the sum of the system
     and user CPU time of the current process.  It does not include time
     elapsed during sleep.  It is process-wide by definition.  The
     reference point of the returned value is undefined, so that only
     the difference between the results of consecutive calls is valid.

     New in version 3.3.

 -- Function: time.process_time_ns () -> int

     Similar to *note process_time(): 2a9. but return time as
     nanoseconds.

     New in version 3.7.

 -- Function: time.sleep (secs)

     Suspend execution of the calling thread for the given number of
     seconds.  The argument may be a floating point number to indicate a
     more precise sleep time.  The actual suspension time may be less
     than that requested because any caught signal will terminate the
     *note sleep(): 674. following execution of that signal’s catching
     routine.  Also, the suspension time may be longer than requested by
     an arbitrary amount because of the scheduling of other activity in
     the system.

     Changed in version 3.5: The function now sleeps at least `secs'
     even if the sleep is interrupted by a signal, except if the signal
     handler raises an exception (see PEP 475(1) for the rationale).

 -- Function: time.strftime (format[, t])

     Convert a tuple or *note struct_time: 58e. representing a time as
     returned by *note gmtime(): b32. or *note localtime(): 17ea. to a
     string as specified by the `format' argument.  If `t' is not
     provided, the current time as returned by *note localtime(): 17ea.
     is used.  `format' must be a string.  *note ValueError: 1f9. is
     raised if any field in `t' is outside of the allowed range.

     0 is a legal argument for any position in the time tuple; if it is
     normally illegal the value is forced to a correct one.

     The following directives can be embedded in the `format' string.
     They are shown without the optional field width and precision
     specification, and are replaced by the indicated characters in the
     *note strftime(): b58. result:

     Directive       Meaning                                              Notes
                                                                          
     ---------------------------------------------------------------------------------
                                                                          
     ‘%a’            Locale’s abbreviated weekday name.
                     
                                                                          
     ‘%A’            Locale’s full weekday name.
                     
                                                                          
     ‘%b’            Locale’s abbreviated month name.
                     
                                                                          
     ‘%B’            Locale’s full month name.
                     
                                                                          
     ‘%c’            Locale’s appropriate date and time representation.
                     
                                                                          
     ‘%d’            Day of the month as a decimal number [01,31].
                     
                                                                          
     ‘%H’            Hour (24-hour clock) as a decimal number [00,23].
                     
                                                                          
     ‘%I’            Hour (12-hour clock) as a decimal number [01,12].
                     
                                                                          
     ‘%j’            Day of the year as a decimal number [001,366].
                     
                                                                          
     ‘%m’            Month as a decimal number [01,12].
                     
                                                                          
     ‘%M’            Minute as a decimal number [00,59].
                     
                                                                          
     ‘%p’            Locale’s equivalent of either AM or PM.              (1)
                                                                          
                                                                          
     ‘%S’            Second as a decimal number [00,61].                  (2)
                                                                          
                                                                          
     ‘%U’            Week number of the year (Sunday as the first day     (3)
                     of the week) as a decimal number [00,53].  All       
                     days in a new year preceding the first Sunday are
                     considered to be in week 0.
                     
                                                                          
     ‘%w’            Weekday as a decimal number [0(Sunday),6].
                     
                                                                          
     ‘%W’            Week number of the year (Monday as the first day     (3)
                     of the week) as a decimal number [00,53].  All       
                     days in a new year preceding the first Monday are
                     considered to be in week 0.
                     
                                                                          
     ‘%x’            Locale’s appropriate date representation.
                     
                                                                          
     ‘%X’            Locale’s appropriate time representation.
                     
                                                                          
     ‘%y’            Year without century as a decimal number [00,99].
                     
                                                                          
     ‘%Y’            Year with century as a decimal number.
                     
                                                                          
     ‘%z’            Time zone offset indicating a positive or negative
                     time difference from UTC/GMT of the form +HHMM or
                     -HHMM, where H represents decimal hour digits and
                     M represents decimal minute digits [-23:59,
                     +23:59].
                     
                                                                          
     ‘%Z’            Time zone name (no characters if no time zone
                     exists).
                     
                                                                          
     ‘%%’            A literal ‘'%'’ character.
                     

     Notes:

       1. When used with the *note strptime(): d84. function, the ‘%p’
          directive only affects the output hour field if the ‘%I’
          directive is used to parse the hour.

       2. The range really is ‘0’ to ‘61’; value ‘60’ is valid in
          timestamps representing leap seconds(2) and value ‘61’ is
          supported for historical reasons.

       3. When used with the *note strptime(): d84. function, ‘%U’ and
          ‘%W’ are only used in calculations when the day of the week
          and the year are specified.

     Here is an example, a format for dates compatible with that
     specified in the RFC 2822(3) Internet email standard.  (4)

          >>> from time import gmtime, strftime
          >>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime())
          'Thu, 28 Jun 2001 14:17:15 +0000'

     Additional directives may be supported on certain platforms, but
     only the ones listed here have a meaning standardized by ANSI C. To
     see the full set of format codes supported on your platform,
     consult the ‘strftime(3)’ documentation.

     On some platforms, an optional field width and precision
     specification can immediately follow the initial ‘'%'’ of a
     directive in the following order; this is also not portable.  The
     field width is normally 2 except for ‘%j’ where it is 3.

 -- Function: time.strptime (string[, format])

     Parse a string representing a time according to a format.  The
     return value is a *note struct_time: 58e. as returned by *note
     gmtime(): b32. or *note localtime(): 17ea.

     The `format' parameter uses the same directives as those used by
     *note strftime(): b58.; it defaults to ‘"%a %b %d %H:%M:%S %Y"’
     which matches the formatting returned by *note ctime(): 17f0.  If
     `string' cannot be parsed according to `format', or if it has
     excess data after parsing, *note ValueError: 1f9. is raised.  The
     default values used to fill in any missing data when more accurate
     values cannot be inferred are ‘(1900, 1, 1, 0, 0, 0, 0, 1, -1)’.
     Both `string' and `format' must be strings.

     For example:

          >>> import time
          >>> time.strptime("30 Nov 00", "%d %b %y")   # doctest: +NORMALIZE_WHITESPACE
          time.struct_time(tm_year=2000, tm_mon=11, tm_mday=30, tm_hour=0, tm_min=0,
                           tm_sec=0, tm_wday=3, tm_yday=335, tm_isdst=-1)

     Support for the ‘%Z’ directive is based on the values contained in
     ‘tzname’ and whether ‘daylight’ is true.  Because of this, it is
     platform-specific except for recognizing UTC and GMT which are
     always known (and are considered to be non-daylight savings
     timezones).

     Only the directives specified in the documentation are supported.
     Because ‘strftime()’ is implemented per platform it can sometimes
     offer more directives than those listed.  But ‘strptime()’ is
     independent of any platform and thus does not necessarily support
     all directives available that are not documented as supported.

 -- Class: time.struct_time

     The type of the time value sequence returned by *note gmtime():
     b32, *note localtime(): 17ea, and *note strptime(): d84.  It is an
     object with a *note named tuple: a98. interface: values can be
     accessed by index and by attribute name.  The following values are
     present:

     Index       Attribute               Values
                                         
     --------------------------------------------------------------------------
                                         
     0           ‘tm_year’               (for example, 1993)
                                         
                                         
     1           ‘tm_mon’                range [1, 12]
                                         
                                         
     2           ‘tm_mday’               range [1, 31]
                                         
                                         
     3           ‘tm_hour’               range [0, 23]
                                         
                                         
     4           ‘tm_min’                range [0, 59]
                                         
                                         
     5           ‘tm_sec’                range [0, 61]; see `(2)' in
                                         *note strftime(): b58. description
                                         
                                         
     6           ‘tm_wday’               range [0, 6], Monday is 0
                                         
                                         
     7           ‘tm_yday’               range [1, 366]
                                         
                                         
     8           ‘tm_isdst’              0, 1 or -1; see below
                                         
                                         
     N/A         ‘tm_zone’               abbreviation of timezone name
                                         
                                         
     N/A         ‘tm_gmtoff’             offset east of UTC in seconds
                                         

     Note that unlike the C structure, the month value is a range of [1,
     12], not [0, 11].

     In calls to *note mktime(): b57, ‘tm_isdst’ may be set to 1 when
     daylight savings time is in effect, and 0 when it is not.  A value
     of -1 indicates that this is not known, and will usually result in
     the correct state being filled in.

     When a tuple with an incorrect length is passed to a function
     expecting a *note struct_time: 58e, or having elements of the wrong
     type, a *note TypeError: 192. is raised.

 -- Function: time.time () -> float

     Return the time in seconds since the *note epoch: 1f54. as a
     floating point number.  The specific date of the epoch and the
     handling of leap seconds(5) is platform dependent.  On Windows and
     most Unix systems, the epoch is January 1, 1970, 00:00:00 (UTC) and
     leap seconds are not counted towards the time in seconds since the
     epoch.  This is commonly referred to as Unix time(6).  To find out
     what the epoch is on a given platform, look at ‘gmtime(0)’.

     Note that even though the time is always returned as a floating
     point number, not all systems provide time with a better precision
     than 1 second.  While this function normally returns non-decreasing
     values, it can return a lower value than a previous call if the
     system clock has been set back between the two calls.

     The number returned by *note time(): 312. may be converted into a
     more common time format (i.e.  year, month, day, hour, etc…) in UTC
     by passing it to *note gmtime(): b32. function or in local time by
     passing it to the *note localtime(): 17ea. function.  In both cases
     a *note struct_time: 58e. object is returned, from which the
     components of the calendar date may be accessed as attributes.

 -- Function: time.thread_time () -> float

     Return the value (in fractional seconds) of the sum of the system
     and user CPU time of the current thread.  It does not include time
     elapsed during sleep.  It is thread-specific by definition.  The
     reference point of the returned value is undefined, so that only
     the difference between the results of consecutive calls in the same
     thread is valid.

     *note Availability: 129a.: Windows, Linux, Unix systems supporting
     ‘CLOCK_THREAD_CPUTIME_ID’.

     New in version 3.7.

 -- Function: time.thread_time_ns () -> int

     Similar to *note thread_time(): 3ee. but return time as
     nanoseconds.

     New in version 3.7.

 -- Function: time.time_ns () -> int

     Similar to *note time(): 312. but returns time as an integer number
     of nanoseconds since the *note epoch: 1f54.

     New in version 3.7.

 -- Function: time.tzset ()

     Reset the time conversion rules used by the library routines.  The
     environment variable ‘TZ’ specifies how this is done.  It will also
     set the variables ‘tzname’ (from the ‘TZ’ environment variable),
     ‘timezone’ (non-DST seconds West of UTC), ‘altzone’ (DST seconds
     west of UTC) and ‘daylight’ (to 0 if this timezone does not have
     any daylight saving time rules, or to nonzero if there is a time,
     past, present or future when daylight saving time applies).

     *note Availability: 129a.: Unix.

          Note: Although in many cases, changing the ‘TZ’ environment
          variable may affect the output of functions like *note
          localtime(): 17ea. without calling *note tzset(): 1f5a, this
          behavior should not be relied on.

          The ‘TZ’ environment variable should contain no whitespace.

     The standard format of the ‘TZ’ environment variable is (whitespace
     added for clarity):

          std offset [dst [offset [,start[/time], end[/time]]]]

     Where the components are:

     ‘std’ and ‘dst’

          Three or more alphanumerics giving the timezone abbreviations.
          These will be propagated into time.tzname

     ‘offset’

          The offset has the form: ‘± hh[:mm[:ss]]’.  This indicates the
          value added the local time to arrive at UTC. If preceded by a
          ‘-‘, the timezone is east of the Prime Meridian; otherwise, it
          is west.  If no offset follows dst, summer time is assumed to
          be one hour ahead of standard time.

     ‘start[/time], end[/time]’

          Indicates when to change to and back from DST. The format of
          the start and end dates are one of the following:

          ‘J`n'’

               The Julian day `n' (1 <= `n' <= 365).  Leap days are not
               counted, so in all years February 28 is day 59 and March
               1 is day 60.

          ‘`n'’

               The zero-based Julian day (0 <= `n' <= 365).  Leap days
               are counted, and it is possible to refer to February 29.

          ‘M`m'.`n'.`d'’

               The `d'’th day (0 <= `d' <= 6) of week `n' of month `m'
               of the year (1 <= `n' <= 5, 1 <= `m' <= 12, where week 5
               means “the last `d' day in month `m'” which may occur in
               either the fourth or the fifth week).  Week 1 is the
               first week in which the `d'’th day occurs.  Day zero is a
               Sunday.

          ‘time’ has the same format as ‘offset’ except that no leading
          sign (‘-‘ or ‘+’) is allowed.  The default, if time is not
          given, is 02:00:00.

          >>> os.environ['TZ'] = 'EST+05EDT,M4.1.0,M10.5.0'
          >>> time.tzset()
          >>> time.strftime('%X %x %Z')
          '02:07:36 05/08/03 EDT'
          >>> os.environ['TZ'] = 'AEST-10AEDT-11,M10.5.0,M3.5.0'
          >>> time.tzset()
          >>> time.strftime('%X %x %Z')
          '16:08:12 05/08/03 AEST'

     On many Unix systems (including *BSD, Linux, Solaris, and Darwin),
     it is more convenient to use the system’s zoneinfo (‘tzfile(5)’)
     database to specify the timezone rules.  To do this, set the ‘TZ’
     environment variable to the path of the required timezone datafile,
     relative to the root of the systems ‘zoneinfo’ timezone database,
     usually located at ‘/usr/share/zoneinfo’.  For example,
     ‘'US/Eastern'’, ‘'Australia/Melbourne'’, ‘'Egypt'’ or
     ‘'Europe/Amsterdam'’.

          >>> os.environ['TZ'] = 'US/Eastern'
          >>> time.tzset()
          >>> time.tzname
          ('EST', 'EDT')
          >>> os.environ['TZ'] = 'Egypt'
          >>> time.tzset()
          >>> time.tzname
          ('EET', 'EEST')

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475

   (2) https://en.wikipedia.org/wiki/Leap_second

   (3) https://tools.ietf.org/html/rfc2822.html

   (4) (1) The use of ‘%Z’ is now deprecated, but the ‘%z’ escape that
expands to the preferred hour/minute offset is not supported by all ANSI
C libraries.  Also, a strict reading of the original 1982 RFC 822
(https://tools.ietf.org/html/rfc822.html) standard calls for a two-digit
year (%y rather than %Y), but practice moved to 4-digit years long
before the year 2000.  After that, RFC 822
(https://tools.ietf.org/html/rfc822.html) became obsolete and the
4-digit year has been first recommended by RFC 1123
(https://tools.ietf.org/html/rfc1123.html) and then mandated by RFC 2822
(https://tools.ietf.org/html/rfc2822.html).

   (5) https://en.wikipedia.org/wiki/Leap_second

   (6) https://en.wikipedia.org/wiki/Unix_time


File: python.info,  Node: Clock ID Constants,  Next: Timezone Constants,  Prev: Functions<2>,  Up: time — Time access and conversions

5.16.3.2 Clock ID Constants
...........................

These constants are used as parameters for *note clock_getres(): aa7.
and *note clock_gettime(): aa8.

 -- Data: time.CLOCK_BOOTTIME

     Identical to *note CLOCK_MONOTONIC: 3eb, except it also includes
     any time that the system is suspended.

     This allows applications to get a suspend-aware monotonic clock
     without having to deal with the complications of *note
     CLOCK_REALTIME: 1f59, which may have discontinuities if the time is
     changed using ‘settimeofday()’ or similar.

     *note Availability: 129a.: Linux 2.6.39 or later.

     New in version 3.7.

 -- Data: time.CLOCK_HIGHRES

     The Solaris OS has a ‘CLOCK_HIGHRES’ timer that attempts to use an
     optimal hardware source, and may give close to nanosecond
     resolution.  ‘CLOCK_HIGHRES’ is the nonadjustable, high-resolution
     clock.

     *note Availability: 129a.: Solaris.

     New in version 3.3.

 -- Data: time.CLOCK_MONOTONIC

     Clock that cannot be set and represents monotonic time since some
     unspecified starting point.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: time.CLOCK_MONOTONIC_RAW

     Similar to *note CLOCK_MONOTONIC: 3eb, but provides access to a raw
     hardware-based time that is not subject to NTP adjustments.

     *note Availability: 129a.: Linux 2.6.28 and newer, macOS 10.12 and
     newer.

     New in version 3.3.

 -- Data: time.CLOCK_PROCESS_CPUTIME_ID

     High-resolution per-process timer from the CPU.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: time.CLOCK_PROF

     High-resolution per-process timer from the CPU.

     *note Availability: 129a.: FreeBSD, NetBSD 7 or later, OpenBSD.

     New in version 3.7.

 -- Data: time.CLOCK_THREAD_CPUTIME_ID

     Thread-specific CPU-time clock.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Data: time.CLOCK_UPTIME

     Time whose absolute value is the time the system has been running
     and not suspended, providing accurate uptime measurement, both
     absolute and interval.

     *note Availability: 129a.: FreeBSD, OpenBSD 5.5 or later.

     New in version 3.7.

 -- Data: time.CLOCK_UPTIME_RAW

     Clock that increments monotonically, tracking the time since an
     arbitrary point, unaffected by frequency or time adjustments and
     not incremented while the system is asleep.

     *note Availability: 129a.: macOS 10.12 and newer.

     New in version 3.8.

The following constant is the only parameter that can be sent to *note
clock_settime(): aa9.

 -- Data: time.CLOCK_REALTIME

     System-wide real-time clock.  Setting this clock requires
     appropriate privileges.

     *note Availability: 129a.: Unix.

     New in version 3.3.


File: python.info,  Node: Timezone Constants,  Prev: Clock ID Constants,  Up: time — Time access and conversions

5.16.3.3 Timezone Constants
...........................

 -- Data: time.altzone

     The offset of the local DST timezone, in seconds west of UTC, if
     one is defined.  This is negative if the local DST timezone is east
     of UTC (as in Western Europe, including the UK). Only use this if
     ‘daylight’ is nonzero.  See note below.

 -- Data: time.daylight

     Nonzero if a DST timezone is defined.  See note below.

 -- Data: time.timezone

     The offset of the local (non-DST) timezone, in seconds west of UTC
     (negative in most of Western Europe, positive in the US, zero in
     the UK). See note below.

 -- Data: time.tzname

     A tuple of two strings: the first is the name of the local non-DST
     timezone, the second is the name of the local DST timezone.  If no
     DST timezone is defined, the second string should not be used.  See
     note below.

     Note: For the above Timezone constants (*note altzone: 1f62, *note
     daylight: 1f63, *note timezone: 1f64, and *note tzname: 1f65.), the
     value is determined by the timezone rules in effect at module load
     time or the last time *note tzset(): 1f5a. is called and may be
     incorrect for times in the past.  It is recommended to use the
     ‘tm_gmtoff’ and ‘tm_zone’ results from *note localtime(): 17ea. to
     obtain timezone information.

See also
........

Module *note datetime: 31.

     More object-oriented interface to dates and times.

Module *note locale: a9.

     Internationalization services.  The locale setting affects the
     interpretation of many format specifiers in *note strftime(): b58.
     and *note strptime(): d84.

Module *note calendar: 15.

     General calendar-related functions.  *note timegm(): 1857. is the
     inverse of *note gmtime(): b32. from this module.


File: python.info,  Node: argparse — Parser for command-line options arguments and sub-commands,  Next: getopt — C-style parser for command line options,  Prev: time — Time access and conversions,  Up: Generic Operating System Services

5.16.4 ‘argparse’ — Parser for command-line options, arguments and sub-commands
-------------------------------------------------------------------------------

New in version 3.2.

`Source code:' Lib/argparse.py(1)

__________________________________________________________________

Tutorial
........

This page contains the API reference information.  For a more gentle
introduction to Python command-line parsing, have a look at the *note
argparse tutorial: 1f68.

The *note argparse: 6. module makes it easy to write user-friendly
command-line interfaces.  The program defines what arguments it
requires, and *note argparse: 6. will figure out how to parse those out
of *note sys.argv: bee.  The *note argparse: 6. module also
automatically generates help and usage messages and issues errors when
users give the program invalid arguments.

* Menu:

* Example: Example<7>.
* ArgumentParser objects::
* The add_argument() method: The add_argument method.
* The parse_args() method: The parse_args method.
* Other utilities::
* Upgrading optparse code::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/argparse.py


File: python.info,  Node: Example<7>,  Next: ArgumentParser objects,  Up: argparse — Parser for command-line options arguments and sub-commands

5.16.4.1 Example
................

The following code is a Python program that takes a list of integers and
produces either the sum or the max:

     import argparse  parser = argparse.ArgumentParser(description='Process some integers.') parser.add_argument('integers', metavar='N', type=int, nargs='+',                     help='an integer for the accumulator') parser.add_argument('--sum', dest='accumulate', action='store_const',                     const=sum, default=max,                     help='sum the integers (default: find the max)')  args = parser.parse_args() print(args.accumulate(args.integers))

Assuming the Python code above is saved into a file called ‘prog.py’, it
can be run at the command line and provides useful help messages:

     $ python prog.py -h usage: prog.py [-h] [--sum] N [N ...]  Process some integers.  positional arguments:  N           an integer for the accumulator  optional arguments:  -h, --help  show this help message and exit  --sum       sum the integers (default: find the max)

When run with the appropriate arguments, it prints either the sum or the
max of the command-line integers:

     $ python prog.py 1 2 3 4 4  $ python prog.py 1 2 3 4 --sum 10

If invalid arguments are passed in, it will issue an error:

     $ python prog.py a b c usage: prog.py [-h] [--sum] N [N ...] prog.py: error: argument N: invalid int value: 'a'

The following sections walk you through this example.

* Menu:

* Creating a parser::
* Adding arguments::
* Parsing arguments::


File: python.info,  Node: Creating a parser,  Next: Adding arguments,  Up: Example<7>

5.16.4.2 Creating a parser
..........................

The first step in using the *note argparse: 6. is creating an *note
ArgumentParser: 689. object:

     >>> parser = argparse.ArgumentParser(description='Process some integers.')

The *note ArgumentParser: 689. object will hold all the information
necessary to parse the command line into Python data types.


File: python.info,  Node: Adding arguments,  Next: Parsing arguments,  Prev: Creating a parser,  Up: Example<7>

5.16.4.3 Adding arguments
.........................

Filling an *note ArgumentParser: 689. with information about program
arguments is done by making calls to the *note add_argument(): 1f6c.
method.  Generally, these calls tell the *note ArgumentParser: 689. how
to take the strings on the command line and turn them into objects.
This information is stored and used when *note parse_args(): 1f6d. is
called.  For example:

     >>> parser.add_argument('integers', metavar='N', type=int, nargs='+', ...                     help='an integer for the accumulator') >>> parser.add_argument('--sum', dest='accumulate', action='store_const', ...                     const=sum, default=max, ...                     help='sum the integers (default: find the max)')

Later, calling *note parse_args(): 1f6d. will return an object with two
attributes, ‘integers’ and ‘accumulate’.  The ‘integers’ attribute will
be a list of one or more ints, and the ‘accumulate’ attribute will be
either the *note sum(): 1e3. function, if ‘--sum’ was specified at the
command line, or the *note max(): 7fe. function if it was not.


File: python.info,  Node: Parsing arguments,  Prev: Adding arguments,  Up: Example<7>

5.16.4.4 Parsing arguments
..........................

*note ArgumentParser: 689. parses arguments through the *note
parse_args(): 1f6d. method.  This will inspect the command line, convert
each argument to the appropriate type and then invoke the appropriate
action.  In most cases, this means a simple *note Namespace: 1f6f.
object will be built up from attributes parsed out of the command line:

     >>> parser.parse_args(['--sum', '7', '-1', '42']) Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])

In a script, *note parse_args(): 1f6d. will typically be called with no
arguments, and the *note ArgumentParser: 689. will automatically
determine the command-line arguments from *note sys.argv: bee.


File: python.info,  Node: ArgumentParser objects,  Next: The add_argument method,  Prev: Example<7>,  Up: argparse — Parser for command-line options arguments and sub-commands

5.16.4.5 ArgumentParser objects
...............................

 -- Class: argparse.ArgumentParser (prog=None, usage=None,
          description=None, epilog=None, parents=[],
          formatter_class=argparse.HelpFormatter, prefix_chars='-',
          fromfile_prefix_chars=None, argument_default=None,
          conflict_handler='error', add_help=True, allow_abbrev=True)

     Create a new *note ArgumentParser: 689. object.  All parameters
     should be passed as keyword arguments.  Each parameter has its own
     more detailed description below, but in short they are:

        * *note prog: 1f71. - The name of the program (default:
          ‘sys.argv[0]’)

        * *note usage: 1f72. - The string describing the program usage
          (default: generated from arguments added to parser)

        * *note description: 1f73. - Text to display before the argument
          help (default: none)

        * *note epilog: 1f74. - Text to display after the argument help
          (default: none)

        * *note parents: 1f75. - A list of *note ArgumentParser: 689.
          objects whose arguments should also be included

        * *note formatter_class: 1f76. - A class for customizing the
          help output

        * *note prefix_chars: 1f77. - The set of characters that prefix
          optional arguments (default: ‘-‘)

        * *note fromfile_prefix_chars: 1f78. - The set of characters
          that prefix files from which additional arguments should be
          read (default: ‘None’)

        * *note argument_default: 1f79. - The global default value for
          arguments (default: ‘None’)

        * *note conflict_handler: 1f7a. - The strategy for resolving
          conflicting optionals (usually unnecessary)

        * *note add_help: 1f7b. - Add a ‘-h/--help’ option to the parser
          (default: ‘True’)

        * *note allow_abbrev: 68b. - Allows long options to be
          abbreviated if the abbreviation is unambiguous.  (default:
          ‘True’)

     Changed in version 3.5: `allow_abbrev' parameter was added.

     Changed in version 3.8: In previous versions, `allow_abbrev' also
     disabled grouping of short flags such as ‘-vv’ to mean ‘-v -v’.

The following sections describe how each of these are used.

* Menu:

* prog::
* usage::
* description::
* epilog::
* parents::
* formatter_class::
* prefix_chars::
* fromfile_prefix_chars::
* argument_default::
* allow_abbrev::
* conflict_handler::
* add_help::


File: python.info,  Node: prog,  Next: usage,  Up: ArgumentParser objects

5.16.4.6 prog
.............

By default, *note ArgumentParser: 689. objects use ‘sys.argv[0]’ to
determine how to display the name of the program in help messages.  This
default is almost always desirable because it will make the help
messages match how the program was invoked on the command line.  For
example, consider a file named ‘myprogram.py’ with the following code:

     import argparse parser = argparse.ArgumentParser() parser.add_argument('--foo', help='foo help') args = parser.parse_args()

The help for this program will display ‘myprogram.py’ as the program
name (regardless of where the program was invoked from):

     $ python myprogram.py --help usage: myprogram.py [-h] [--foo FOO]  optional arguments:  -h, --help  show this help message and exit  --foo FOO   foo help $ cd .. $ python subdir/myprogram.py --help usage: myprogram.py [-h] [--foo FOO]  optional arguments:  -h, --help  show this help message and exit  --foo FOO   foo help

To change this default behavior, another value can be supplied using the
‘prog=’ argument to *note ArgumentParser: 689.:

     >>> parser = argparse.ArgumentParser(prog='myprogram') >>> parser.print_help() usage: myprogram [-h]  optional arguments:  -h, --help  show this help message and exit

Note that the program name, whether determined from ‘sys.argv[0]’ or
from the ‘prog=’ argument, is available to help messages using the
‘%(prog)s’ format specifier.

     >>> parser = argparse.ArgumentParser(prog='myprogram') >>> parser.add_argument('--foo', help='foo of the %(prog)s program') >>> parser.print_help() usage: myprogram [-h] [--foo FOO]  optional arguments:  -h, --help  show this help message and exit  --foo FOO   foo of the myprogram program


File: python.info,  Node: usage,  Next: description,  Prev: prog,  Up: ArgumentParser objects

5.16.4.7 usage
..............

By default, *note ArgumentParser: 689. calculates the usage message from
the arguments it contains:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--foo', nargs='?', help='foo help') >>> parser.add_argument('bar', nargs='+', help='bar help') >>> parser.print_help() usage: PROG [-h] [--foo [FOO]] bar [bar ...]  positional arguments:  bar          bar help  optional arguments:  -h, --help   show this help message and exit  --foo [FOO]  foo help

The default message can be overridden with the ‘usage=’ keyword
argument:

     >>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]') >>> parser.add_argument('--foo', nargs='?', help='foo help') >>> parser.add_argument('bar', nargs='+', help='bar help') >>> parser.print_help() usage: PROG [options]  positional arguments:  bar          bar help  optional arguments:  -h, --help   show this help message and exit  --foo [FOO]  foo help

The ‘%(prog)s’ format specifier is available to fill in the program name
in your usage messages.


File: python.info,  Node: description,  Next: epilog,  Prev: usage,  Up: ArgumentParser objects

5.16.4.8 description
....................

Most calls to the *note ArgumentParser: 689. constructor will use the
‘description=’ keyword argument.  This argument gives a brief
description of what the program does and how it works.  In help
messages, the description is displayed between the command-line usage
string and the help messages for the various arguments:

     >>> parser = argparse.ArgumentParser(description='A foo that bars') >>> parser.print_help() usage: argparse.py [-h]  A foo that bars  optional arguments:  -h, --help  show this help message and exit

By default, the description will be line-wrapped so that it fits within
the given space.  To change this behavior, see the *note
formatter_class: 1f76. argument.


File: python.info,  Node: epilog,  Next: parents,  Prev: description,  Up: ArgumentParser objects

5.16.4.9 epilog
...............

Some programs like to display additional description of the program
after the description of the arguments.  Such text can be specified
using the ‘epilog=’ argument to *note ArgumentParser: 689.:

     >>> parser = argparse.ArgumentParser( ...     description='A foo that bars', ...     epilog="And that's how you'd foo a bar") >>> parser.print_help() usage: argparse.py [-h]  A foo that bars  optional arguments:  -h, --help  show this help message and exit  And that's how you'd foo a bar

As with the *note description: 1f73. argument, the ‘epilog=’ text is by
default line-wrapped, but this behavior can be adjusted with the *note
formatter_class: 1f76. argument to *note ArgumentParser: 689.


File: python.info,  Node: parents,  Next: formatter_class,  Prev: epilog,  Up: ArgumentParser objects

5.16.4.10 parents
.................

Sometimes, several parsers share a common set of arguments.  Rather than
repeating the definitions of these arguments, a single parser with all
the shared arguments and passed to ‘parents=’ argument to *note
ArgumentParser: 689. can be used.  The ‘parents=’ argument takes a list
of *note ArgumentParser: 689. objects, collects all the positional and
optional actions from them, and adds these actions to the *note
ArgumentParser: 689. object being constructed:

     >>> parent_parser = argparse.ArgumentParser(add_help=False) >>> parent_parser.add_argument('--parent', type=int)  >>> foo_parser = argparse.ArgumentParser(parents=[parent_parser]) >>> foo_parser.add_argument('foo') >>> foo_parser.parse_args(['--parent', '2', 'XXX']) Namespace(foo='XXX', parent=2)  >>> bar_parser = argparse.ArgumentParser(parents=[parent_parser]) >>> bar_parser.add_argument('--bar') >>> bar_parser.parse_args(['--bar', 'YYY']) Namespace(bar='YYY', parent=None)

Note that most parent parsers will specify ‘add_help=False’.  Otherwise,
the *note ArgumentParser: 689. will see two ‘-h/--help’ options (one in
the parent and one in the child) and raise an error.

     Note: You must fully initialize the parsers before passing them via
     ‘parents=’.  If you change the parent parsers after the child
     parser, those changes will not be reflected in the child.


File: python.info,  Node: formatter_class,  Next: prefix_chars,  Prev: parents,  Up: ArgumentParser objects

5.16.4.11 formatter_class
.........................

*note ArgumentParser: 689. objects allow the help formatting to be
customized by specifying an alternate formatting class.  Currently,
there are four such classes:

 -- Class: argparse.RawDescriptionHelpFormatter
 -- Class: argparse.RawTextHelpFormatter
 -- Class: argparse.ArgumentDefaultsHelpFormatter
 -- Class: argparse.MetavarTypeHelpFormatter

*note RawDescriptionHelpFormatter: 1f7c. and *note RawTextHelpFormatter:
1f7d. give more control over how textual descriptions are displayed.  By
default, *note ArgumentParser: 689. objects line-wrap the *note
description: 1f73. and *note epilog: 1f74. texts in command-line help
messages:

     >>> parser = argparse.ArgumentParser( ...     prog='PROG', ...     description='''this description ...         was indented weird ...             but that is okay''', ...     epilog=''' ...             likewise for this epilog whose whitespace will ...         be cleaned up and whose words will be wrapped ...         across a couple lines''') >>> parser.print_help() usage: PROG [-h]  this description was indented weird but that is okay  optional arguments:  -h, --help  show this help message and exit  likewise for this epilog whose whitespace will be cleaned up and whose words will be wrapped across a couple lines

Passing *note RawDescriptionHelpFormatter: 1f7c. as ‘formatter_class=’
indicates that *note description: 1f73. and *note epilog: 1f74. are
already correctly formatted and should not be line-wrapped:

     >>> parser = argparse.ArgumentParser( ...     prog='PROG', ...     formatter_class=argparse.RawDescriptionHelpFormatter, ...     description=textwrap.dedent('''\ ...         Please do not mess up this text! ...         -------------------------------- ...             I have indented it ...             exactly the way ...             I want it ...         ''')) >>> parser.print_help() usage: PROG [-h]  Please do not mess up this text! --------------------------------    I have indented it    exactly the way    I want it  optional arguments:  -h, --help  show this help message and exit

*note RawTextHelpFormatter: 1f7d. maintains whitespace for all sorts of
help text, including argument descriptions.  However, multiple new lines
are replaced with one.  If you wish to preserve multiple blank lines,
add spaces between the newlines.

*note ArgumentDefaultsHelpFormatter: 1f7e. automatically adds
information about default values to each of the argument help messages:

     >>> parser = argparse.ArgumentParser( ...     prog='PROG', ...     formatter_class=argparse.ArgumentDefaultsHelpFormatter) >>> parser.add_argument('--foo', type=int, default=42, help='FOO!') >>> parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!') >>> parser.print_help() usage: PROG [-h] [--foo FOO] [bar [bar ...]]  positional arguments:  bar         BAR! (default: [1, 2, 3])  optional arguments:  -h, --help  show this help message and exit  --foo FOO   FOO! (default: 42)

*note MetavarTypeHelpFormatter: 1f7f. uses the name of the *note type:
1f80. argument for each argument as the display name for its values
(rather than using the *note dest: 1f81. as the regular formatter does):

     >>> parser = argparse.ArgumentParser( ...     prog='PROG', ...     formatter_class=argparse.MetavarTypeHelpFormatter) >>> parser.add_argument('--foo', type=int) >>> parser.add_argument('bar', type=float) >>> parser.print_help() usage: PROG [-h] [--foo int] float  positional arguments:   float  optional arguments:   -h, --help  show this help message and exit   --foo int


File: python.info,  Node: prefix_chars,  Next: fromfile_prefix_chars,  Prev: formatter_class,  Up: ArgumentParser objects

5.16.4.12 prefix_chars
......................

Most command-line options will use ‘-’ as the prefix, e.g.  ‘-f/--foo’.
Parsers that need to support different or additional prefix characters,
e.g.  for options like ‘+f’ or ‘/foo’, may specify them using the
‘prefix_chars=’ argument to the ArgumentParser constructor:

     >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+') >>> parser.add_argument('+f') >>> parser.add_argument('++bar') >>> parser.parse_args('+f X ++bar Y'.split()) Namespace(bar='Y', f='X')

The ‘prefix_chars=’ argument defaults to ‘'-'’.  Supplying a set of
characters that does not include ‘-’ will cause ‘-f/--foo’ options to be
disallowed.


File: python.info,  Node: fromfile_prefix_chars,  Next: argument_default,  Prev: prefix_chars,  Up: ArgumentParser objects

5.16.4.13 fromfile_prefix_chars
...............................

Sometimes, for example when dealing with a particularly long argument
lists, it may make sense to keep the list of arguments in a file rather
than typing it out at the command line.  If the ‘fromfile_prefix_chars=’
argument is given to the *note ArgumentParser: 689. constructor, then
arguments that start with any of the specified characters will be
treated as files, and will be replaced by the arguments they contain.
For example:

     >>> with open('args.txt', 'w') as fp: ...     fp.write('-f\nbar') >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@') >>> parser.add_argument('-f') >>> parser.parse_args(['-f', 'foo', '@args.txt']) Namespace(f='bar')

Arguments read from a file must by default be one per line (but see also
*note convert_arg_line_to_args(): 1f82.) and are treated as if they were
in the same place as the original file referencing argument on the
command line.  So in the example above, the expression ‘['-f', 'foo',
'@args.txt']’ is considered equivalent to the expression ‘['-f', 'foo',
'-f', 'bar']’.

The ‘fromfile_prefix_chars=’ argument defaults to ‘None’, meaning that
arguments will never be treated as file references.


File: python.info,  Node: argument_default,  Next: allow_abbrev,  Prev: fromfile_prefix_chars,  Up: ArgumentParser objects

5.16.4.14 argument_default
..........................

Generally, argument defaults are specified either by passing a default
to *note add_argument(): 1f6c. or by calling the *note set_defaults():
1f83. methods with a specific set of name-value pairs.  Sometimes
however, it may be useful to specify a single parser-wide default for
arguments.  This can be accomplished by passing the ‘argument_default=’
keyword argument to *note ArgumentParser: 689.  For example, to globally
suppress attribute creation on *note parse_args(): 1f6d. calls, we
supply ‘argument_default=SUPPRESS’:

     >>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS) >>> parser.add_argument('--foo') >>> parser.add_argument('bar', nargs='?') >>> parser.parse_args(['--foo', '1', 'BAR']) Namespace(bar='BAR', foo='1') >>> parser.parse_args([]) Namespace()


File: python.info,  Node: allow_abbrev,  Next: conflict_handler,  Prev: argument_default,  Up: ArgumentParser objects

5.16.4.15 allow_abbrev
......................

Normally, when you pass an argument list to the *note parse_args():
1f6d. method of an *note ArgumentParser: 689, it *note recognizes
abbreviations: 68a. of long options.

This feature can be disabled by setting ‘allow_abbrev’ to ‘False’:

     >>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False) >>> parser.add_argument('--foobar', action='store_true') >>> parser.add_argument('--foonley', action='store_false') >>> parser.parse_args(['--foon']) usage: PROG [-h] [--foobar] [--foonley] PROG: error: unrecognized arguments: --foon

New in version 3.5.


File: python.info,  Node: conflict_handler,  Next: add_help,  Prev: allow_abbrev,  Up: ArgumentParser objects

5.16.4.16 conflict_handler
..........................

*note ArgumentParser: 689. objects do not allow two actions with the
same option string.  By default, *note ArgumentParser: 689. objects
raise an exception if an attempt is made to create an argument with an
option string that is already in use:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-f', '--foo', help='old foo help') >>> parser.add_argument('--foo', help='new foo help') Traceback (most recent call last):  .. ArgumentError: argument --foo: conflicting option string(s): --foo

Sometimes (e.g.  when using *note parents: 1f75.) it may be useful to
simply override any older arguments with the same option string.  To get
this behavior, the value ‘'resolve'’ can be supplied to the
‘conflict_handler=’ argument of *note ArgumentParser: 689.:

     >>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve') >>> parser.add_argument('-f', '--foo', help='old foo help') >>> parser.add_argument('--foo', help='new foo help') >>> parser.print_help() usage: PROG [-h] [-f FOO] [--foo FOO]  optional arguments:  -h, --help  show this help message and exit  -f FOO      old foo help  --foo FOO   new foo help

Note that *note ArgumentParser: 689. objects only remove an action if
all of its option strings are overridden.  So, in the example above, the
old ‘-f/--foo’ action is retained as the ‘-f’ action, because only the
‘--foo’ option string was overridden.


File: python.info,  Node: add_help,  Prev: conflict_handler,  Up: ArgumentParser objects

5.16.4.17 add_help
..................

By default, ArgumentParser objects add an option which simply displays
the parser’s help message.  For example, consider a file named
‘myprogram.py’ containing the following code:

     import argparse parser = argparse.ArgumentParser() parser.add_argument('--foo', help='foo help') args = parser.parse_args()

If ‘-h’ or ‘--help’ is supplied at the command line, the ArgumentParser
help will be printed:

     $ python myprogram.py --help usage: myprogram.py [-h] [--foo FOO]  optional arguments:  -h, --help  show this help message and exit  --foo FOO   foo help

Occasionally, it may be useful to disable the addition of this help
option.  This can be achieved by passing ‘False’ as the ‘add_help=’
argument to *note ArgumentParser: 689.:

     >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> parser.add_argument('--foo', help='foo help') >>> parser.print_help() usage: PROG [--foo FOO]  optional arguments:  --foo FOO  foo help

The help option is typically ‘-h/--help’.  The exception to this is if
the ‘prefix_chars=’ is specified and does not include ‘-’, in which case
‘-h’ and ‘--help’ are not valid options.  In this case, the first
character in ‘prefix_chars’ is used to prefix the help options:

     >>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/') >>> parser.print_help() usage: PROG [+h]  optional arguments:   +h, ++help  show this help message and exit


File: python.info,  Node: The add_argument method,  Next: The parse_args method,  Prev: ArgumentParser objects,  Up: argparse — Parser for command-line options arguments and sub-commands

5.16.4.18 The add_argument() method
...................................

 -- Method: ArgumentParser.add_argument (name or flags...[, action][,
          nargs][, const][, default][, type][, choices][, required][,
          help][, metavar][, dest])

     Define how a single command-line argument should be parsed.  Each
     parameter has its own more detailed description below, but in short
     they are:

        * *note name or flags: 1f86. - Either a name or a list of option
          strings, e.g.  ‘foo’ or ‘-f, --foo’.

        * *note action: 1f87. - The basic type of action to be taken
          when this argument is encountered at the command line.

        * *note nargs: 1f88. - The number of command-line arguments that
          should be consumed.

        * *note const: 1f89. - A constant value required by some *note
          action: 1f87. and *note nargs: 1f88. selections.

        * *note default: 1f8a. - The value produced if the argument is
          absent from the command line.

        * *note type: 1f80. - The type to which the command-line
          argument should be converted.

        * *note choices: 1f8b. - A container of the allowable values for
          the argument.

        * *note required: 1f8c. - Whether or not the command-line option
          may be omitted (optionals only).

        * *note help: 1f8d. - A brief description of what the argument
          does.

        * *note metavar: 1f8e. - A name for the argument in usage
          messages.

        * *note dest: 1f81. - The name of the attribute to be added to
          the object returned by *note parse_args(): 1f6d.

The following sections describe how each of these are used.

* Menu:

* name or flags::
* action::
* nargs::
* const::
* default::
* type::
* choices::
* required::
* help::
* metavar::
* dest::
* Action classes::


File: python.info,  Node: name or flags,  Next: action,  Up: The add_argument method

5.16.4.19 name or flags
.......................

The *note add_argument(): 1f6c. method must know whether an optional
argument, like ‘-f’ or ‘--foo’, or a positional argument, like a list of
filenames, is expected.  The first arguments passed to *note
add_argument(): 1f6c. must therefore be either a series of flags, or a
simple argument name.  For example, an optional argument could be
created like:

     >>> parser.add_argument('-f', '--foo')

while a positional argument could be created like:

     >>> parser.add_argument('bar')

When *note parse_args(): 1f6d. is called, optional arguments will be
identified by the ‘-’ prefix, and the remaining arguments will be
assumed to be positional:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-f', '--foo') >>> parser.add_argument('bar') >>> parser.parse_args(['BAR']) Namespace(bar='BAR', foo=None) >>> parser.parse_args(['BAR', '--foo', 'FOO']) Namespace(bar='BAR', foo='FOO') >>> parser.parse_args(['--foo', 'FOO']) usage: PROG [-h] [-f FOO] bar PROG: error: the following arguments are required: bar


File: python.info,  Node: action,  Next: nargs,  Prev: name or flags,  Up: The add_argument method

5.16.4.20 action
................

*note ArgumentParser: 689. objects associate command-line arguments with
actions.  These actions can do just about anything with the command-line
arguments associated with them, though most actions simply add an
attribute to the object returned by *note parse_args(): 1f6d.  The
‘action’ keyword argument specifies how the command-line arguments
should be handled.  The supplied actions are:

   * ‘'store'’ - This just stores the argument’s value.  This is the
     default action.  For example:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> parser.parse_args('--foo 1'.split()) Namespace(foo='1')

   * ‘'store_const'’ - This stores the value specified by the *note
     const: 1f89. keyword argument.  The ‘'store_const'’ action is most
     commonly used with optional arguments that specify some sort of
     flag.  For example:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='store_const', const=42) >>> parser.parse_args(['--foo']) Namespace(foo=42)

   * ‘'store_true'’ and ‘'store_false'’ - These are special cases of
     ‘'store_const'’ used for storing the values ‘True’ and ‘False’
     respectively.  In addition, they create default values of ‘False’
     and ‘True’ respectively.  For example:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='store_true') >>> parser.add_argument('--bar', action='store_false') >>> parser.add_argument('--baz', action='store_false') >>> parser.parse_args('--foo --bar'.split()) Namespace(foo=True, bar=False, baz=True)

   * ‘'append'’ - This stores a list, and appends each argument value to
     the list.  This is useful to allow an option to be specified
     multiple times.  Example usage:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='append') >>> parser.parse_args('--foo 1 --foo 2'.split()) Namespace(foo=['1', '2'])

   * ‘'append_const'’ - This stores a list, and appends the value
     specified by the *note const: 1f89. keyword argument to the list.
     (Note that the *note const: 1f89. keyword argument defaults to
     ‘None’.)  The ‘'append_const'’ action is typically useful when
     multiple arguments need to store constants to the same list.  For
     example:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--str', dest='types', action='append_const', const=str) >>> parser.add_argument('--int', dest='types', action='append_const', const=int) >>> parser.parse_args('--str --int'.split()) Namespace(types=[<class 'str'>, <class 'int'>])

   * ‘'count'’ - This counts the number of times a keyword argument
     occurs.  For example, this is useful for increasing verbosity
     levels:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--verbose', '-v', action='count', default=0) >>> parser.parse_args(['-vvv']) Namespace(verbose=3)

     Note, the `default' will be ‘None’ unless explicitly set to `0'.

   * ‘'help'’ - This prints a complete help message for all the options
     in the current parser and then exits.  By default a help action is
     automatically added to the parser.  See *note ArgumentParser: 689.
     for details of how the output is created.

   * ‘'version'’ - This expects a ‘version=’ keyword argument in the
     *note add_argument(): 1f6c. call, and prints version information
     and exits when invoked:

          >>> import argparse >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--version', action='version', version='%(prog)s 2.0') >>> parser.parse_args(['--version']) PROG 2.0

   * ‘'extend'’ - This stores a list, and extends each argument value to
     the list.  Example usage:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument("--foo", action="extend", nargs="+", type=str) >>> parser.parse_args(["--foo", "f1", "--foo", "f2", "f3", "f4"]) Namespace(foo=['f1', 'f2', 'f3', 'f4'])

     New in version 3.8.

You may also specify an arbitrary action by passing an Action subclass
or other object that implements the same interface.  The recommended way
to do this is to extend *note Action: 1f8f, overriding the ‘__call__’
method and optionally the ‘__init__’ method.

An example of a custom action:

     >>> class FooAction(argparse.Action): ...     def __init__(self, option_strings, dest, nargs=None, **kwargs): ...         if nargs is not None: ...             raise ValueError("nargs not allowed") ...         super(FooAction, self).__init__(option_strings, dest, **kwargs) ...     def __call__(self, parser, namespace, values, option_string=None): ...         print('%r %r %r' % (namespace, values, option_string)) ...         setattr(namespace, self.dest, values) ... >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action=FooAction) >>> parser.add_argument('bar', action=FooAction) >>> args = parser.parse_args('1 --foo 2'.split()) Namespace(bar=None, foo=None) '1' None Namespace(bar='1', foo=None) '2' '--foo' >>> args Namespace(bar='1', foo='2')

For more details, see *note Action: 1f8f.


File: python.info,  Node: nargs,  Next: const,  Prev: action,  Up: The add_argument method

5.16.4.21 nargs
...............

ArgumentParser objects usually associate a single command-line argument
with a single action to be taken.  The ‘nargs’ keyword argument
associates a different number of command-line arguments with a single
action.  The supported values are:

   * ‘N’ (an integer).  ‘N’ arguments from the command line will be
     gathered together into a list.  For example:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs=2) >>> parser.add_argument('bar', nargs=1) >>> parser.parse_args('c --foo a b'.split()) Namespace(bar=['c'], foo=['a', 'b'])

     Note that ‘nargs=1’ produces a list of one item.  This is different
     from the default, in which the item is produced by itself.

   * ‘'?'’.  One argument will be consumed from the command line if
     possible, and produced as a single item.  If no command-line
     argument is present, the value from *note default: 1f8a. will be
     produced.  Note that for optional arguments, there is an additional
     case - the option string is present but not followed by a
     command-line argument.  In this case the value from *note const:
     1f89. will be produced.  Some examples to illustrate this:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs='?', const='c', default='d') >>> parser.add_argument('bar', nargs='?', default='d') >>> parser.parse_args(['XX', '--foo', 'YY']) Namespace(bar='XX', foo='YY') >>> parser.parse_args(['XX', '--foo']) Namespace(bar='XX', foo='c') >>> parser.parse_args([]) Namespace(bar='d', foo='d')

     One of the more common uses of ‘nargs='?'’ is to allow optional
     input and output files:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'), ...                     default=sys.stdin) >>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'), ...                     default=sys.stdout) >>> parser.parse_args(['input.txt', 'output.txt']) Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>,           outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>) >>> parser.parse_args([]) Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>,           outfile=<_io.TextIOWrapper name='<stdout>' encoding='UTF-8'>)

   * ‘'*'’.  All command-line arguments present are gathered into a
     list.  Note that it generally doesn’t make much sense to have more
     than one positional argument with ‘nargs='*'’, but multiple
     optional arguments with ‘nargs='*'’ is possible.  For example:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', nargs='*') >>> parser.add_argument('--bar', nargs='*') >>> parser.add_argument('baz', nargs='*') >>> parser.parse_args('a b --foo x y --bar 1 2'.split()) Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y'])

   * ‘'+'’.  Just like ‘'*'’, all command-line args present are gathered
     into a list.  Additionally, an error message will be generated if
     there wasn’t at least one command-line argument present.  For
     example:

          >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('foo', nargs='+') >>> parser.parse_args(['a', 'b']) Namespace(foo=['a', 'b']) >>> parser.parse_args([]) usage: PROG [-h] foo [foo ...] PROG: error: the following arguments are required: foo

   * ‘argparse.REMAINDER’.  All the remaining command-line arguments are
     gathered into a list.  This is commonly useful for command line
     utilities that dispatch to other command line utilities:

          >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--foo') >>> parser.add_argument('command') >>> parser.add_argument('args', nargs=argparse.REMAINDER) >>> print(parser.parse_args('--foo B cmd --arg1 XX ZZ'.split())) Namespace(args=['--arg1', 'XX', 'ZZ'], command='cmd', foo='B')

If the ‘nargs’ keyword argument is not provided, the number of arguments
consumed is determined by the *note action: 1f87.  Generally this means
a single command-line argument will be consumed and a single item (not a
list) will be produced.


File: python.info,  Node: const,  Next: default,  Prev: nargs,  Up: The add_argument method

5.16.4.22 const
...............

The ‘const’ argument of *note add_argument(): 1f6c. is used to hold
constant values that are not read from the command line but are required
for the various *note ArgumentParser: 689. actions.  The two most common
uses of it are:

   * When *note add_argument(): 1f6c. is called with
     ‘action='store_const'’ or ‘action='append_const'’.  These actions
     add the ‘const’ value to one of the attributes of the object
     returned by *note parse_args(): 1f6d.  See the *note action: 1f87.
     description for examples.

   * When *note add_argument(): 1f6c. is called with option strings
     (like ‘-f’ or ‘--foo’) and ‘nargs='?'’.  This creates an optional
     argument that can be followed by zero or one command-line
     arguments.  When parsing the command line, if the option string is
     encountered with no command-line argument following it, the value
     of ‘const’ will be assumed instead.  See the *note nargs: 1f88.
     description for examples.

With the ‘'store_const'’ and ‘'append_const'’ actions, the ‘const’
keyword argument must be given.  For other actions, it defaults to
‘None’.


File: python.info,  Node: default,  Next: type,  Prev: const,  Up: The add_argument method

5.16.4.23 default
.................

All optional arguments and some positional arguments may be omitted at
the command line.  The ‘default’ keyword argument of *note
add_argument(): 1f6c, whose value defaults to ‘None’, specifies what
value should be used if the command-line argument is not present.  For
optional arguments, the ‘default’ value is used when the option string
was not present at the command line:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default=42) >>> parser.parse_args(['--foo', '2']) Namespace(foo='2') >>> parser.parse_args([]) Namespace(foo=42)

If the ‘default’ value is a string, the parser parses the value as if it
were a command-line argument.  In particular, the parser applies any
*note type: 1f80. conversion argument, if provided, before setting the
attribute on the *note Namespace: 1f6f. return value.  Otherwise, the
parser uses the value as is:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--length', default='10', type=int) >>> parser.add_argument('--width', default=10.5, type=int) >>> parser.parse_args() Namespace(length=10, width=10.5)

For positional arguments with *note nargs: 1f88. equal to ‘?’ or ‘*’,
the ‘default’ value is used when no command-line argument was present:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('foo', nargs='?', default=42) >>> parser.parse_args(['a']) Namespace(foo='a') >>> parser.parse_args([]) Namespace(foo=42)

Providing ‘default=argparse.SUPPRESS’ causes no attribute to be added if
the command-line argument was not present:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default=argparse.SUPPRESS) >>> parser.parse_args([]) Namespace() >>> parser.parse_args(['--foo', '1']) Namespace(foo='1')


File: python.info,  Node: type,  Next: choices,  Prev: default,  Up: The add_argument method

5.16.4.24 type
..............

By default, *note ArgumentParser: 689. objects read command-line
arguments in as simple strings.  However, quite often the command-line
string should instead be interpreted as another type, like a *note
float: 187. or *note int: 184.  The ‘type’ keyword argument of *note
add_argument(): 1f6c. allows any necessary type-checking and type
conversions to be performed.  Common built-in types and functions can be
used directly as the value of the ‘type’ argument:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('foo', type=int) >>> parser.add_argument('bar', type=open) >>> parser.parse_args('2 temp.txt'.split()) Namespace(bar=<_io.TextIOWrapper name='temp.txt' encoding='UTF-8'>, foo=2)

See the section on the *note default: 1f8a. keyword argument for
information on when the ‘type’ argument is applied to default arguments.

To ease the use of various types of files, the argparse module provides
the factory FileType which takes the ‘mode=’, ‘bufsize=’, ‘encoding=’
and ‘errors=’ arguments of the *note open(): 4e5. function.  For
example, ‘FileType('w')’ can be used to create a writable file:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('bar', type=argparse.FileType('w')) >>> parser.parse_args(['out.txt']) Namespace(bar=<_io.TextIOWrapper name='out.txt' encoding='UTF-8'>)

‘type=’ can take any callable that takes a single string argument and
returns the converted value:

     >>> def perfect_square(string): ...     value = int(string) ...     sqrt = math.sqrt(value) ...     if sqrt != int(sqrt): ...         msg = "%r is not a perfect square" % string ...         raise argparse.ArgumentTypeError(msg) ...     return value ... >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('foo', type=perfect_square) >>> parser.parse_args(['9']) Namespace(foo=9) >>> parser.parse_args(['7']) usage: PROG [-h] foo PROG: error: argument foo: '7' is not a perfect square

The *note choices: 1f8b. keyword argument may be more convenient for
type checkers that simply check against a range of values:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('foo', type=int, choices=range(5, 10)) >>> parser.parse_args(['7']) Namespace(foo=7) >>> parser.parse_args(['11']) usage: PROG [-h] {5,6,7,8,9} PROG: error: argument foo: invalid choice: 11 (choose from 5, 6, 7, 8, 9)

See the *note choices: 1f8b. section for more details.


File: python.info,  Node: choices,  Next: required,  Prev: type,  Up: The add_argument method

5.16.4.25 choices
.................

Some command-line arguments should be selected from a restricted set of
values.  These can be handled by passing a container object as the
`choices' keyword argument to *note add_argument(): 1f6c.  When the
command line is parsed, argument values will be checked, and an error
message will be displayed if the argument was not one of the acceptable
values:

     >>> parser = argparse.ArgumentParser(prog='game.py') >>> parser.add_argument('move', choices=['rock', 'paper', 'scissors']) >>> parser.parse_args(['rock']) Namespace(move='rock') >>> parser.parse_args(['fire']) usage: game.py [-h] {rock,paper,scissors} game.py: error: argument move: invalid choice: 'fire' (choose from 'rock', 'paper', 'scissors')

Note that inclusion in the `choices' container is checked after any
*note type: 1f80. conversions have been performed, so the type of the
objects in the `choices' container should match the *note type: 1f80.
specified:

     >>> parser = argparse.ArgumentParser(prog='doors.py') >>> parser.add_argument('door', type=int, choices=range(1, 4)) >>> print(parser.parse_args(['3'])) Namespace(door=3) >>> parser.parse_args(['4']) usage: doors.py [-h] {1,2,3} doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3)

Any container can be passed as the `choices' value, so *note list: 260.
objects, *note set: b62. objects, and custom containers are all
supported.


File: python.info,  Node: required,  Next: help,  Prev: choices,  Up: The add_argument method

5.16.4.26 required
..................

In general, the *note argparse: 6. module assumes that flags like ‘-f’
and ‘--bar’ indicate `optional' arguments, which can always be omitted
at the command line.  To make an option `required', ‘True’ can be
specified for the ‘required=’ keyword argument to *note add_argument():
1f6c.:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', required=True) >>> parser.parse_args(['--foo', 'BAR']) Namespace(foo='BAR') >>> parser.parse_args([]) usage: argparse.py [-h] [--foo FOO] argparse.py: error: option --foo is required

As the example shows, if an option is marked as ‘required’, *note
parse_args(): 1f6d. will report an error if that option is not present
at the command line.

     Note: Required options are generally considered bad form because
     users expect `options' to be `optional', and thus they should be
     avoided when possible.


File: python.info,  Node: help,  Next: metavar,  Prev: required,  Up: The add_argument method

5.16.4.27 help
..............

The ‘help’ value is a string containing a brief description of the
argument.  When a user requests help (usually by using ‘-h’ or ‘--help’
at the command line), these ‘help’ descriptions will be displayed with
each argument:

     >>> parser = argparse.ArgumentParser(prog='frobble') >>> parser.add_argument('--foo', action='store_true', ...                     help='foo the bars before frobbling') >>> parser.add_argument('bar', nargs='+', ...                     help='one of the bars to be frobbled') >>> parser.parse_args(['-h']) usage: frobble [-h] [--foo] bar [bar ...]  positional arguments:  bar     one of the bars to be frobbled  optional arguments:  -h, --help  show this help message and exit  --foo   foo the bars before frobbling

The ‘help’ strings can include various format specifiers to avoid
repetition of things like the program name or the argument *note
default: 1f8a.  The available specifiers include the program name,
‘%(prog)s’ and most keyword arguments to *note add_argument(): 1f6c,
e.g.  ‘%(default)s’, ‘%(type)s’, etc.:

     >>> parser = argparse.ArgumentParser(prog='frobble') >>> parser.add_argument('bar', nargs='?', type=int, default=42, ...                     help='the bar to %(prog)s (default: %(default)s)') >>> parser.print_help() usage: frobble [-h] [bar]  positional arguments:  bar     the bar to frobble (default: 42)  optional arguments:  -h, --help  show this help message and exit

As the help string supports %-formatting, if you want a literal ‘%’ to
appear in the help string, you must escape it as ‘%%’.

*note argparse: 6. supports silencing the help entry for certain
options, by setting the ‘help’ value to ‘argparse.SUPPRESS’:

     >>> parser = argparse.ArgumentParser(prog='frobble') >>> parser.add_argument('--foo', help=argparse.SUPPRESS) >>> parser.print_help() usage: frobble [-h]  optional arguments:   -h, --help  show this help message and exit


File: python.info,  Node: metavar,  Next: dest,  Prev: help,  Up: The add_argument method

5.16.4.28 metavar
.................

When *note ArgumentParser: 689. generates help messages, it needs some
way to refer to each expected argument.  By default, ArgumentParser
objects use the *note dest: 1f81. value as the “name” of each object.
By default, for positional argument actions, the *note dest: 1f81. value
is used directly, and for optional argument actions, the *note dest:
1f81. value is uppercased.  So, a single positional argument with
‘dest='bar'’ will be referred to as ‘bar’.  A single optional argument
‘--foo’ that should be followed by a single command-line argument will
be referred to as ‘FOO’.  An example:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> parser.add_argument('bar') >>> parser.parse_args('X --foo Y'.split()) Namespace(bar='X', foo='Y') >>> parser.print_help() usage:  [-h] [--foo FOO] bar  positional arguments:  bar  optional arguments:  -h, --help  show this help message and exit  --foo FOO

An alternative name can be specified with ‘metavar’:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', metavar='YYY') >>> parser.add_argument('bar', metavar='XXX') >>> parser.parse_args('X --foo Y'.split()) Namespace(bar='X', foo='Y') >>> parser.print_help() usage:  [-h] [--foo YYY] XXX  positional arguments:  XXX  optional arguments:  -h, --help  show this help message and exit  --foo YYY

Note that ‘metavar’ only changes the `displayed' name - the name of the
attribute on the *note parse_args(): 1f6d. object is still determined by
the *note dest: 1f81. value.

Different values of ‘nargs’ may cause the metavar to be used multiple
times.  Providing a tuple to ‘metavar’ specifies a different display for
each of the arguments:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x', nargs=2) >>> parser.add_argument('--foo', nargs=2, metavar=('bar', 'baz')) >>> parser.print_help() usage: PROG [-h] [-x X X] [--foo bar baz]  optional arguments:  -h, --help     show this help message and exit  -x X X  --foo bar baz


File: python.info,  Node: dest,  Next: Action classes,  Prev: metavar,  Up: The add_argument method

5.16.4.29 dest
..............

Most *note ArgumentParser: 689. actions add some value as an attribute
of the object returned by *note parse_args(): 1f6d.  The name of this
attribute is determined by the ‘dest’ keyword argument of *note
add_argument(): 1f6c.  For positional argument actions, ‘dest’ is
normally supplied as the first argument to *note add_argument(): 1f6c.:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('bar') >>> parser.parse_args(['XXX']) Namespace(bar='XXX')

For optional argument actions, the value of ‘dest’ is normally inferred
from the option strings.  *note ArgumentParser: 689. generates the value
of ‘dest’ by taking the first long option string and stripping away the
initial ‘--’ string.  If no long option strings were supplied, ‘dest’
will be derived from the first short option string by stripping the
initial ‘-’ character.  Any internal ‘-’ characters will be converted to
‘_’ characters to make sure the string is a valid attribute name.  The
examples below illustrate this behavior:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('-f', '--foo-bar', '--foo') >>> parser.add_argument('-x', '-y') >>> parser.parse_args('-f 1 -x 2'.split()) Namespace(foo_bar='1', x='2') >>> parser.parse_args('--foo 1 -y 2'.split()) Namespace(foo_bar='1', x='2')

‘dest’ allows a custom attribute name to be provided:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', dest='bar') >>> parser.parse_args('--foo XXX'.split()) Namespace(bar='XXX')


File: python.info,  Node: Action classes,  Prev: dest,  Up: The add_argument method

5.16.4.30 Action classes
........................

Action classes implement the Action API, a callable which returns a
callable which processes arguments from the command-line.  Any object
which follows this API may be passed as the ‘action’ parameter to
‘add_argument()’.

 -- Class: argparse.Action (option_strings, dest, nargs=None,
          const=None, default=None, type=None, choices=None,
          required=False, help=None, metavar=None)

Action objects are used by an ArgumentParser to represent the
information needed to parse a single argument from one or more strings
from the command line.  The Action class must accept the two positional
arguments plus any keyword arguments passed to *note
ArgumentParser.add_argument(): 1f6c. except for the ‘action’ itself.

Instances of Action (or return value of any callable to the ‘action’
parameter) should have attributes “dest”, “option_strings”, “default”,
“type”, “required”, “help”, etc.  defined.  The easiest way to ensure
these attributes are defined is to call ‘Action.__init__’.

Action instances should be callable, so subclasses must override the
‘__call__’ method, which should accept four parameters:

   * ‘parser’ - The ArgumentParser object which contains this action.

   * ‘namespace’ - The *note Namespace: 1f6f. object that will be
     returned by *note parse_args(): 1f6d.  Most actions add an
     attribute to this object using *note setattr(): 1518.

   * ‘values’ - The associated command-line arguments, with any type
     conversions applied.  Type conversions are specified with the *note
     type: 1f80. keyword argument to *note add_argument(): 1f6c.

   * ‘option_string’ - The option string that was used to invoke this
     action.  The ‘option_string’ argument is optional, and will be
     absent if the action is associated with a positional argument.

The ‘__call__’ method may perform arbitrary actions, but will typically
set attributes on the ‘namespace’ based on ‘dest’ and ‘values’.


File: python.info,  Node: The parse_args method,  Next: Other utilities,  Prev: The add_argument method,  Up: argparse — Parser for command-line options arguments and sub-commands

5.16.4.31 The parse_args() method
.................................

 -- Method: ArgumentParser.parse_args (args=None, namespace=None)

     Convert argument strings to objects and assign them as attributes
     of the namespace.  Return the populated namespace.

     Previous calls to *note add_argument(): 1f6c. determine exactly
     what objects are created and how they are assigned.  See the
     documentation for *note add_argument(): 1f6c. for details.

        * *note args: 1f93. - List of strings to parse.  The default is
          taken from *note sys.argv: bee.

        * *note namespace: 1f94. - An object to take the attributes.
          The default is a new empty *note Namespace: 1f6f. object.

* Menu:

* Option value syntax::
* Invalid arguments::
* Arguments containing -::
* Argument abbreviations (prefix matching): Argument abbreviations prefix matching.
* Beyond sys.argv: Beyond sys argv.
* The Namespace object::


File: python.info,  Node: Option value syntax,  Next: Invalid arguments,  Up: The parse_args method

5.16.4.32 Option value syntax
.............................

The *note parse_args(): 1f6d. method supports several ways of specifying
the value of an option (if it takes one).  In the simplest case, the
option and its value are passed as two separate arguments:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x') >>> parser.add_argument('--foo') >>> parser.parse_args(['-x', 'X']) Namespace(foo=None, x='X') >>> parser.parse_args(['--foo', 'FOO']) Namespace(foo='FOO', x=None)

For long options (options with names longer than a single character),
the option and value can also be passed as a single command-line
argument, using ‘=’ to separate them:

     >>> parser.parse_args(['--foo=FOO']) Namespace(foo='FOO', x=None)

For short options (options only one character long), the option and its
value can be concatenated:

     >>> parser.parse_args(['-xX']) Namespace(foo=None, x='X')

Several short options can be joined together, using only a single ‘-’
prefix, as long as only the last option (or none of them) requires a
value:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x', action='store_true') >>> parser.add_argument('-y', action='store_true') >>> parser.add_argument('-z') >>> parser.parse_args(['-xyzZ']) Namespace(x=True, y=True, z='Z')


File: python.info,  Node: Invalid arguments,  Next: Arguments containing -,  Prev: Option value syntax,  Up: The parse_args method

5.16.4.33 Invalid arguments
...........................

While parsing the command line, *note parse_args(): 1f6d. checks for a
variety of errors, including ambiguous options, invalid types, invalid
options, wrong number of positional arguments, etc.  When it encounters
such an error, it exits and prints the error along with a usage message:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--foo', type=int) >>> parser.add_argument('bar', nargs='?')  >>> # invalid type >>> parser.parse_args(['--foo', 'spam']) usage: PROG [-h] [--foo FOO] [bar] PROG: error: argument --foo: invalid int value: 'spam'  >>> # invalid option >>> parser.parse_args(['--bar']) usage: PROG [-h] [--foo FOO] [bar] PROG: error: no such option: --bar  >>> # wrong number of arguments >>> parser.parse_args(['spam', 'badger']) usage: PROG [-h] [--foo FOO] [bar] PROG: error: extra arguments found: badger


File: python.info,  Node: Arguments containing -,  Next: Argument abbreviations prefix matching,  Prev: Invalid arguments,  Up: The parse_args method

5.16.4.34 Arguments containing ‘-’
..................................

The *note parse_args(): 1f6d. method attempts to give errors whenever
the user has clearly made a mistake, but some situations are inherently
ambiguous.  For example, the command-line argument ‘-1’ could either be
an attempt to specify an option or an attempt to provide a positional
argument.  The *note parse_args(): 1f6d. method is cautious here:
positional arguments may only begin with ‘-’ if they look like negative
numbers and there are no options in the parser that look like negative
numbers:

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-x') >>> parser.add_argument('foo', nargs='?')  >>> # no negative number options, so -1 is a positional argument >>> parser.parse_args(['-x', '-1']) Namespace(foo=None, x='-1')  >>> # no negative number options, so -1 and -5 are positional arguments >>> parser.parse_args(['-x', '-1', '-5']) Namespace(foo='-5', x='-1')  >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-1', dest='one') >>> parser.add_argument('foo', nargs='?')  >>> # negative number options present, so -1 is an option >>> parser.parse_args(['-1', 'X']) Namespace(foo=None, one='X')  >>> # negative number options present, so -2 is an option >>> parser.parse_args(['-2']) usage: PROG [-h] [-1 ONE] [foo] PROG: error: no such option: -2  >>> # negative number options present, so both -1s are options >>> parser.parse_args(['-1', '-1']) usage: PROG [-h] [-1 ONE] [foo] PROG: error: argument -1: expected one argument

If you have positional arguments that must begin with ‘-’ and don’t look
like negative numbers, you can insert the pseudo-argument ‘'--'’ which
tells *note parse_args(): 1f6d. that everything after that is a
positional argument:

     >>> parser.parse_args(['--', '-f']) Namespace(foo='-f', one=None)


File: python.info,  Node: Argument abbreviations prefix matching,  Next: Beyond sys argv,  Prev: Arguments containing -,  Up: The parse_args method

5.16.4.35 Argument abbreviations (prefix matching)
..................................................

The *note parse_args(): 1f6d. method *note by default: 68b. allows long
options to be abbreviated to a prefix, if the abbreviation is
unambiguous (the prefix matches a unique option):

     >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('-bacon') >>> parser.add_argument('-badger') >>> parser.parse_args('-bac MMM'.split()) Namespace(bacon='MMM', badger=None) >>> parser.parse_args('-bad WOOD'.split()) Namespace(bacon=None, badger='WOOD') >>> parser.parse_args('-ba BA'.split()) usage: PROG [-h] [-bacon BACON] [-badger BADGER] PROG: error: ambiguous option: -ba could match -badger, -bacon

An error is produced for arguments that could produce more than one
options.  This feature can be disabled by setting *note allow_abbrev:
68b. to ‘False’.


File: python.info,  Node: Beyond sys argv,  Next: The Namespace object,  Prev: Argument abbreviations prefix matching,  Up: The parse_args method

5.16.4.36 Beyond ‘sys.argv’
...........................

Sometimes it may be useful to have an ArgumentParser parse arguments
other than those of *note sys.argv: bee.  This can be accomplished by
passing a list of strings to *note parse_args(): 1f6d.  This is useful
for testing at the interactive prompt:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument( ...     'integers', metavar='int', type=int, choices=range(10), ...     nargs='+', help='an integer in the range 0..9') >>> parser.add_argument( ...     '--sum', dest='accumulate', action='store_const', const=sum, ...     default=max, help='sum the integers (default: find the max)') >>> parser.parse_args(['1', '2', '3', '4']) Namespace(accumulate=<built-in function max>, integers=[1, 2, 3, 4]) >>> parser.parse_args(['1', '2', '3', '4', '--sum']) Namespace(accumulate=<built-in function sum>, integers=[1, 2, 3, 4])


File: python.info,  Node: The Namespace object,  Prev: Beyond sys argv,  Up: The parse_args method

5.16.4.37 The Namespace object
..............................

 -- Class: argparse.Namespace

     Simple class used by default by *note parse_args(): 1f6d. to create
     an object holding attributes and return it.

This class is deliberately simple, just an *note object: 2ae. subclass
with a readable string representation.  If you prefer to have dict-like
view of the attributes, you can use the standard Python idiom, *note
vars(): f6f.:

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> args = parser.parse_args(['--foo', 'BAR']) >>> vars(args) {'foo': 'BAR'}

It may also be useful to have an *note ArgumentParser: 689. assign
attributes to an already existing object, rather than a new *note
Namespace: 1f6f. object.  This can be achieved by specifying the
‘namespace=’ keyword argument:

     >>> class C: ...     pass ... >>> c = C() >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> parser.parse_args(args=['--foo', 'BAR'], namespace=c) >>> c.foo 'BAR'


File: python.info,  Node: Other utilities,  Next: Upgrading optparse code,  Prev: The parse_args method,  Up: argparse — Parser for command-line options arguments and sub-commands

5.16.4.38 Other utilities
.........................

* Menu:

* Sub-commands::
* FileType objects::
* Argument groups::
* Mutual exclusion::
* Parser defaults::
* Printing help::
* Partial parsing::
* Customizing file parsing::
* Exiting methods::
* Intermixed parsing::


File: python.info,  Node: Sub-commands,  Next: FileType objects,  Up: Other utilities

5.16.4.39 Sub-commands
......................

 -- Method: ArgumentParser.add_subparsers ([title][, description][,
          prog][, parser_class][, action][, option_string][, dest][,
          required][, help][, metavar])

     Many programs split up their functionality into a number of
     sub-commands, for example, the ‘svn’ program can invoke
     sub-commands like ‘svn checkout’, ‘svn update’, and ‘svn commit’.
     Splitting up functionality this way can be a particularly good idea
     when a program performs several different functions which require
     different kinds of command-line arguments.  *note ArgumentParser:
     689. supports the creation of such sub-commands with the *note
     add_subparsers(): 49a. method.  The *note add_subparsers(): 49a.
     method is normally called with no arguments and returns a special
     action object.  This object has a single method, ‘add_parser()’,
     which takes a command name and any *note ArgumentParser: 689.
     constructor arguments, and returns an *note ArgumentParser: 689.
     object that can be modified as usual.

     Description of parameters:

        * title - title for the sub-parser group in help output; by
          default “subcommands” if description is provided, otherwise
          uses title for positional arguments

        * description - description for the sub-parser group in help
          output, by default ‘None’

        * prog - usage information that will be displayed with
          sub-command help, by default the name of the program and any
          positional arguments before the subparser argument

        * parser_class - class which will be used to create sub-parser
          instances, by default the class of the current parser (e.g.
          ArgumentParser)

        * *note action: 1f87. - the basic type of action to be taken
          when this argument is encountered at the command line

        * *note dest: 1f81. - name of the attribute under which
          sub-command name will be stored; by default ‘None’ and no
          value is stored

        * *note required: 1f8c. - Whether or not a subcommand must be
          provided, by default ‘False’ (added in 3.7)

        * *note help: 1f8d. - help for sub-parser group in help output,
          by default ‘None’

        * *note metavar: 1f8e. - string presenting available
          sub-commands in help; by default it is ‘None’ and presents
          sub-commands in form {cmd1, cmd2, ..}

     Some example usage:

          >>> # create the top-level parser >>> parser = argparse.ArgumentParser(prog='PROG') >>> parser.add_argument('--foo', action='store_true', help='foo help') >>> subparsers = parser.add_subparsers(help='sub-command help') >>> >>> # create the parser for the "a" command >>> parser_a = subparsers.add_parser('a', help='a help') >>> parser_a.add_argument('bar', type=int, help='bar help') >>> >>> # create the parser for the "b" command >>> parser_b = subparsers.add_parser('b', help='b help') >>> parser_b.add_argument('--baz', choices='XYZ', help='baz help') >>> >>> # parse some argument lists >>> parser.parse_args(['a', '12']) Namespace(bar=12, foo=False) >>> parser.parse_args(['--foo', 'b', '--baz', 'Z']) Namespace(baz='Z', foo=True)

     Note that the object returned by *note parse_args(): 1f6d. will
     only contain attributes for the main parser and the subparser that
     was selected by the command line (and not any other subparsers).
     So in the example above, when the ‘a’ command is specified, only
     the ‘foo’ and ‘bar’ attributes are present, and when the ‘b’
     command is specified, only the ‘foo’ and ‘baz’ attributes are
     present.

     Similarly, when a help message is requested from a subparser, only
     the help for that particular parser will be printed.  The help
     message will not include parent parser or sibling parser messages.
     (A help message for each subparser command, however, can be given
     by supplying the ‘help=’ argument to ‘add_parser()’ as above.)

          >>> parser.parse_args(['--help']) usage: PROG [-h] [--foo] {a,b} ...  positional arguments:   {a,b}   sub-command help     a     a help     b     b help  optional arguments:   -h, --help  show this help message and exit   --foo   foo help  >>> parser.parse_args(['a', '--help']) usage: PROG a [-h] bar  positional arguments:   bar     bar help  optional arguments:   -h, --help  show this help message and exit  >>> parser.parse_args(['b', '--help']) usage: PROG b [-h] [--baz {X,Y,Z}]  optional arguments:   -h, --help     show this help message and exit   --baz {X,Y,Z}  baz help

     The *note add_subparsers(): 49a. method also supports ‘title’ and
     ‘description’ keyword arguments.  When either is present, the
     subparser’s commands will appear in their own group in the help
     output.  For example:

          >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers(title='subcommands', ...                                    description='valid subcommands', ...                                    help='additional help') >>> subparsers.add_parser('foo') >>> subparsers.add_parser('bar') >>> parser.parse_args(['-h']) usage:  [-h] {foo,bar} ...  optional arguments:   -h, --help  show this help message and exit  subcommands:   valid subcommands    {foo,bar}   additional help

     Furthermore, ‘add_parser’ supports an additional ‘aliases’
     argument, which allows multiple strings to refer to the same
     subparser.  This example, like ‘svn’, aliases ‘co’ as a shorthand
     for ‘checkout’:

          >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers() >>> checkout = subparsers.add_parser('checkout', aliases=['co']) >>> checkout.add_argument('foo') >>> parser.parse_args(['co', 'bar']) Namespace(foo='bar')

     One particularly effective way of handling sub-commands is to
     combine the use of the *note add_subparsers(): 49a. method with
     calls to *note set_defaults(): 1f83. so that each subparser knows
     which Python function it should execute.  For example:

          >>> # sub-command functions >>> def foo(args): ...     print(args.x * args.y) ... >>> def bar(args): ...     print('((%s))' % args.z) ... >>> # create the top-level parser >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers() >>> >>> # create the parser for the "foo" command >>> parser_foo = subparsers.add_parser('foo') >>> parser_foo.add_argument('-x', type=int, default=1) >>> parser_foo.add_argument('y', type=float) >>> parser_foo.set_defaults(func=foo) >>> >>> # create the parser for the "bar" command >>> parser_bar = subparsers.add_parser('bar') >>> parser_bar.add_argument('z') >>> parser_bar.set_defaults(func=bar) >>> >>> # parse the args and call whatever function was selected >>> args = parser.parse_args('foo 1 -x 2'.split()) >>> args.func(args) 2.0 >>> >>> # parse the args and call whatever function was selected >>> args = parser.parse_args('bar XYZYX'.split()) >>> args.func(args) ((XYZYX))

     This way, you can let *note parse_args(): 1f6d. do the job of
     calling the appropriate function after argument parsing is
     complete.  Associating functions with actions like this is
     typically the easiest way to handle the different actions for each
     of your subparsers.  However, if it is necessary to check the name
     of the subparser that was invoked, the ‘dest’ keyword argument to
     the *note add_subparsers(): 49a. call will work:

          >>> parser = argparse.ArgumentParser() >>> subparsers = parser.add_subparsers(dest='subparser_name') >>> subparser1 = subparsers.add_parser('1') >>> subparser1.add_argument('-x') >>> subparser2 = subparsers.add_parser('2') >>> subparser2.add_argument('y') >>> parser.parse_args(['2', 'frobble']) Namespace(subparser_name='2', y='frobble')

     Changed in version 3.7: New `required' keyword argument.


File: python.info,  Node: FileType objects,  Next: Argument groups,  Prev: Sub-commands,  Up: Other utilities

5.16.4.40 FileType objects
..........................

 -- Class: argparse.FileType (mode='r', bufsize=-1, encoding=None,
          errors=None)

     The *note FileType: 814. factory creates objects that can be passed
     to the type argument of *note ArgumentParser.add_argument(): 1f6c.
     Arguments that have *note FileType: 814. objects as their type will
     open command-line arguments as files with the requested modes,
     buffer sizes, encodings and error handling (see the *note open():
     4e5. function for more details):

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--raw', type=argparse.FileType('wb', 0)) >>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8')) >>> parser.parse_args(['--raw', 'raw.dat', 'file.txt']) Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>)

     FileType objects understand the pseudo-argument ‘'-'’ and
     automatically convert this into ‘sys.stdin’ for readable *note
     FileType: 814. objects and ‘sys.stdout’ for writable *note
     FileType: 814. objects:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('infile', type=argparse.FileType('r')) >>> parser.parse_args(['-']) Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)

     New in version 3.4: The `encodings' and `errors' keyword arguments.


File: python.info,  Node: Argument groups,  Next: Mutual exclusion,  Prev: FileType objects,  Up: Other utilities

5.16.4.41 Argument groups
.........................

 -- Method: ArgumentParser.add_argument_group (title=None,
          description=None)

     By default, *note ArgumentParser: 689. groups command-line
     arguments into “positional arguments” and “optional arguments” when
     displaying help messages.  When there is a better conceptual
     grouping of arguments than this default one, appropriate groups can
     be created using the *note add_argument_group(): 1f9f. method:

          >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> group = parser.add_argument_group('group') >>> group.add_argument('--foo', help='foo help') >>> group.add_argument('bar', help='bar help') >>> parser.print_help() usage: PROG [--foo FOO] bar  group:   bar    bar help   --foo FOO  foo help

     The *note add_argument_group(): 1f9f. method returns an argument
     group object which has an *note add_argument(): 1f6c. method just
     like a regular *note ArgumentParser: 689.  When an argument is
     added to the group, the parser treats it just like a normal
     argument, but displays the argument in a separate group for help
     messages.  The *note add_argument_group(): 1f9f. method accepts
     `title' and `description' arguments which can be used to customize
     this display:

          >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> group1 = parser.add_argument_group('group1', 'group1 description') >>> group1.add_argument('foo', help='foo help') >>> group2 = parser.add_argument_group('group2', 'group2 description') >>> group2.add_argument('--bar', help='bar help') >>> parser.print_help() usage: PROG [--bar BAR] foo  group1:   group1 description    foo    foo help  group2:   group2 description    --bar BAR  bar help

     Note that any arguments not in your user-defined groups will end up
     back in the usual “positional arguments” and “optional arguments”
     sections.


File: python.info,  Node: Mutual exclusion,  Next: Parser defaults,  Prev: Argument groups,  Up: Other utilities

5.16.4.42 Mutual exclusion
..........................

 -- Method: ArgumentParser.add_mutually_exclusive_group (required=False)

     Create a mutually exclusive group.  *note argparse: 6. will make
     sure that only one of the arguments in the mutually exclusive group
     was present on the command line:

          >>> parser = argparse.ArgumentParser(prog='PROG') >>> group = parser.add_mutually_exclusive_group() >>> group.add_argument('--foo', action='store_true') >>> group.add_argument('--bar', action='store_false') >>> parser.parse_args(['--foo']) Namespace(bar=True, foo=True) >>> parser.parse_args(['--bar']) Namespace(bar=False, foo=False) >>> parser.parse_args(['--foo', '--bar']) usage: PROG [-h] [--foo | --bar] PROG: error: argument --bar: not allowed with argument --foo

     The *note add_mutually_exclusive_group(): 1fa1. method also accepts
     a `required' argument, to indicate that at least one of the
     mutually exclusive arguments is required:

          >>> parser = argparse.ArgumentParser(prog='PROG') >>> group = parser.add_mutually_exclusive_group(required=True) >>> group.add_argument('--foo', action='store_true') >>> group.add_argument('--bar', action='store_false') >>> parser.parse_args([]) usage: PROG [-h] (--foo | --bar) PROG: error: one of the arguments --foo --bar is required

     Note that currently mutually exclusive argument groups do not
     support the `title' and `description' arguments of *note
     add_argument_group(): 1f9f.


File: python.info,  Node: Parser defaults,  Next: Printing help,  Prev: Mutual exclusion,  Up: Other utilities

5.16.4.43 Parser defaults
.........................

 -- Method: ArgumentParser.set_defaults (**kwargs)

     Most of the time, the attributes of the object returned by *note
     parse_args(): 1f6d. will be fully determined by inspecting the
     command-line arguments and the argument actions.  *note
     set_defaults(): 1f83. allows some additional attributes that are
     determined without any inspection of the command line to be added:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('foo', type=int) >>> parser.set_defaults(bar=42, baz='badger') >>> parser.parse_args(['736']) Namespace(bar=42, baz='badger', foo=736)

     Note that parser-level defaults always override argument-level
     defaults:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default='bar') >>> parser.set_defaults(foo='spam') >>> parser.parse_args([]) Namespace(foo='spam')

     Parser-level defaults can be particularly useful when working with
     multiple parsers.  See the *note add_subparsers(): 49a. method for
     an example of this type.

 -- Method: ArgumentParser.get_default (dest)

     Get the default value for a namespace attribute, as set by either
     *note add_argument(): 1f6c. or by *note set_defaults(): 1f83.:

          >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', default='badger') >>> parser.get_default('foo') 'badger'


File: python.info,  Node: Printing help,  Next: Partial parsing,  Prev: Parser defaults,  Up: Other utilities

5.16.4.44 Printing help
.......................

In most typical applications, *note parse_args(): 1f6d. will take care
of formatting and printing any usage or error messages.  However,
several formatting methods are available:

 -- Method: ArgumentParser.print_usage (file=None)

     Print a brief description of how the *note ArgumentParser: 689.
     should be invoked on the command line.  If `file' is ‘None’, *note
     sys.stdout: 303. is assumed.

 -- Method: ArgumentParser.print_help (file=None)

     Print a help message, including the program usage and information
     about the arguments registered with the *note ArgumentParser: 689.
     If `file' is ‘None’, *note sys.stdout: 303. is assumed.

There are also variants of these methods that simply return a string
instead of printing it:

 -- Method: ArgumentParser.format_usage ()

     Return a string containing a brief description of how the *note
     ArgumentParser: 689. should be invoked on the command line.

 -- Method: ArgumentParser.format_help ()

     Return a string containing a help message, including the program
     usage and information about the arguments registered with the *note
     ArgumentParser: 689.


File: python.info,  Node: Partial parsing,  Next: Customizing file parsing,  Prev: Printing help,  Up: Other utilities

5.16.4.45 Partial parsing
.........................

 -- Method: ArgumentParser.parse_known_args (args=None, namespace=None)

Sometimes a script may only parse a few of the command-line arguments,
passing the remaining arguments on to another script or program.  In
these cases, the *note parse_known_args(): 1faa. method can be useful.
It works much like *note parse_args(): 1f6d. except that it does not
produce an error when extra arguments are present.  Instead, it returns
a two item tuple containing the populated namespace and the list of
remaining argument strings.

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', action='store_true') >>> parser.add_argument('bar') >>> parser.parse_known_args(['--foo', '--badger', 'BAR', 'spam']) (Namespace(bar='BAR', foo=True), ['--badger', 'spam'])

     Warning: *note Prefix matching: 68a. rules apply to
     ‘parse_known_args()’.  The parser may consume an option even if
     it’s just a prefix of one of its known options, instead of leaving
     it in the remaining arguments list.


File: python.info,  Node: Customizing file parsing,  Next: Exiting methods,  Prev: Partial parsing,  Up: Other utilities

5.16.4.46 Customizing file parsing
..................................

 -- Method: ArgumentParser.convert_arg_line_to_args (arg_line)

     Arguments that are read from a file (see the
     `fromfile_prefix_chars' keyword argument to the *note
     ArgumentParser: 689. constructor) are read one argument per line.
     *note convert_arg_line_to_args(): 1f82. can be overridden for
     fancier reading.

     This method takes a single argument `arg_line' which is a string
     read from the argument file.  It returns a list of arguments parsed
     from this string.  The method is called once per line read from the
     argument file, in order.

     A useful override of this method is one that treats each
     space-separated word as an argument.  The following example
     demonstrates how to do this:

          class MyArgumentParser(argparse.ArgumentParser):     def convert_arg_line_to_args(self, arg_line):         return arg_line.split()


File: python.info,  Node: Exiting methods,  Next: Intermixed parsing,  Prev: Customizing file parsing,  Up: Other utilities

5.16.4.47 Exiting methods
.........................

 -- Method: ArgumentParser.exit (status=0, message=None)

     This method terminates the program, exiting with the specified
     `status' and, if given, it prints a `message' before that.  The
     user can override this method to handle these steps differently:

          class ErrorCatchingArgumentParser(argparse.ArgumentParser):     def exit(self, status=0, message=None):         if status:             raise Exception(f'Exiting because of an error: {message}')         exit(status)

 -- Method: ArgumentParser.error (message)

     This method prints a usage message including the `message' to the
     standard error and terminates the program with a status code of 2.


File: python.info,  Node: Intermixed parsing,  Prev: Exiting methods,  Up: Other utilities

5.16.4.48 Intermixed parsing
............................

 -- Method: ArgumentParser.parse_intermixed_args (args=None,
          namespace=None)

 -- Method: ArgumentParser.parse_known_intermixed_args (args=None,
          namespace=None)

A number of Unix commands allow the user to intermix optional arguments
with positional arguments.  The *note parse_intermixed_args(): 33a. and
*note parse_known_intermixed_args(): 1fb0. methods support this parsing
style.

These parsers do not support all the argparse features, and will raise
exceptions if unsupported features are used.  In particular, subparsers,
‘argparse.REMAINDER’, and mutually exclusive groups that include both
optionals and positionals are not supported.

The following example shows the difference between *note
parse_known_args(): 1faa. and *note parse_intermixed_args(): 33a.: the
former returns ‘['2', '3']’ as unparsed arguments, while the latter
collects all the positionals into ‘rest’.

     >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo') >>> parser.add_argument('cmd') >>> parser.add_argument('rest', nargs='*', type=int) >>> parser.parse_known_args('doit 1 --foo bar 2 3'.split()) (Namespace(cmd='doit', foo='bar', rest=[1]), ['2', '3']) >>> parser.parse_intermixed_args('doit 1 --foo bar 2 3'.split()) Namespace(cmd='doit', foo='bar', rest=[1, 2, 3])

*note parse_known_intermixed_args(): 1fb0. returns a two item tuple
containing the populated namespace and the list of remaining argument
strings.  *note parse_intermixed_args(): 33a. raises an error if there
are any remaining unparsed argument strings.

New in version 3.7.


File: python.info,  Node: Upgrading optparse code,  Prev: Other utilities,  Up: argparse — Parser for command-line options arguments and sub-commands

5.16.4.49 Upgrading optparse code
.................................

Originally, the *note argparse: 6. module had attempted to maintain
compatibility with *note optparse: c3.  However, *note optparse: c3. was
difficult to extend transparently, particularly with the changes
required to support the new ‘nargs=’ specifiers and better usage
messages.  When most everything in *note optparse: c3. had either been
copy-pasted over or monkey-patched, it no longer seemed practical to try
to maintain the backwards compatibility.

The *note argparse: 6. module improves on the standard library *note
optparse: c3. module in a number of ways including:

   * Handling positional arguments.

   * Supporting sub-commands.

   * Allowing alternative option prefixes like ‘+’ and ‘/’.

   * Handling zero-or-more and one-or-more style arguments.

   * Producing more informative usage messages.

   * Providing a much simpler interface for custom ‘type’ and ‘action’.

A partial upgrade path from *note optparse: c3. to *note argparse: 6.:

   * Replace all *note optparse.OptionParser.add_option(): 1fb2. calls
     with *note ArgumentParser.add_argument(): 1f6c. calls.

   * Replace ‘(options, args) = parser.parse_args()’ with ‘args =
     parser.parse_args()’ and add additional *note
     ArgumentParser.add_argument(): 1f6c. calls for the positional
     arguments.  Keep in mind that what was previously called ‘options’,
     now in the *note argparse: 6. context is called ‘args’.

   * Replace *note optparse.OptionParser.disable_interspersed_args():
     1fb3. by using *note parse_intermixed_args(): 33a. instead of *note
     parse_args(): 1f6d.

   * Replace callback actions and the ‘callback_*’ keyword arguments
     with ‘type’ or ‘action’ arguments.

   * Replace string names for ‘type’ keyword arguments with the
     corresponding type objects (e.g.  int, float, complex, etc).

   * Replace ‘optparse.Values’ with *note Namespace: 1f6f. and
     ‘optparse.OptionError’ and ‘optparse.OptionValueError’ with
     ‘ArgumentError’.

   * Replace strings with implicit arguments such as ‘%default’ or
     ‘%prog’ with the standard Python syntax to use dictionaries to
     format strings, that is, ‘%(default)s’ and ‘%(prog)s’.

   * Replace the OptionParser constructor ‘version’ argument with a call
     to ‘parser.add_argument('--version', action='version',
     version='<the version>')’.


File: python.info,  Node: getopt — C-style parser for command line options,  Next: logging — Logging facility for Python,  Prev: argparse — Parser for command-line options arguments and sub-commands,  Up: Generic Operating System Services

5.16.5 ‘getopt’ — C-style parser for command line options
---------------------------------------------------------

`Source code:' Lib/getopt.py(1)

     Note: The *note getopt: 87. module is a parser for command line
     options whose API is designed to be familiar to users of the C
     ‘getopt()’ function.  Users who are unfamiliar with the C
     ‘getopt()’ function or who would like to write less code and get
     better help and error messages should consider using the *note
     argparse: 6. module instead.

__________________________________________________________________

This module helps scripts to parse the command line arguments in
‘sys.argv’.  It supports the same conventions as the Unix ‘getopt()’
function (including the special meanings of arguments of the form ‘‘-’‘
and ‘‘--’‘).  Long options similar to those supported by GNU software
may be used as well via an optional third argument.

This module provides two functions and an exception:

 -- Function: getopt.getopt (args, shortopts, longopts=[])

     Parses command line options and parameter list.  `args' is the
     argument list to be parsed, without the leading reference to the
     running program.  Typically, this means ‘sys.argv[1:]’.
     `shortopts' is the string of option letters that the script wants
     to recognize, with options that require an argument followed by a
     colon (‘':'’; i.e., the same format that Unix ‘getopt()’ uses).

          Note: Unlike GNU ‘getopt()’, after a non-option argument, all
          further arguments are considered also non-options.  This is
          similar to the way non-GNU Unix systems work.

     `longopts', if specified, must be a list of strings with the names
     of the long options which should be supported.  The leading ‘'--'’
     characters should not be included in the option name.  Long options
     which require an argument should be followed by an equal sign
     (‘'='’).  Optional arguments are not supported.  To accept only
     long options, `shortopts' should be an empty string.  Long options
     on the command line can be recognized so long as they provide a
     prefix of the option name that matches exactly one of the accepted
     options.  For example, if `longopts' is ‘['foo', 'frob']’, the
     option ‘--fo’ will match as ‘--foo’, but ‘--f’ will not match
     uniquely, so *note GetoptError: 1fb7. will be raised.

     The return value consists of two elements: the first is a list of
     ‘(option, value)’ pairs; the second is the list of program
     arguments left after the option list was stripped (this is a
     trailing slice of `args').  Each option-and-value pair returned has
     the option as its first element, prefixed with a hyphen for short
     options (e.g., ‘'-x'’) or two hyphens for long options (e.g.,
     ‘'--long-option'’), and the option argument as its second element,
     or an empty string if the option has no argument.  The options
     occur in the list in the same order in which they were found, thus
     allowing multiple occurrences.  Long and short options may be
     mixed.

 -- Function: getopt.gnu_getopt (args, shortopts, longopts=[])

     This function works like *note getopt(): 87, except that GNU style
     scanning mode is used by default.  This means that option and
     non-option arguments may be intermixed.  The *note getopt(): 87.
     function stops processing options as soon as a non-option argument
     is encountered.

     If the first character of the option string is ‘'+'’, or if the
     environment variable ‘POSIXLY_CORRECT’ is set, then option
     processing stops as soon as a non-option argument is encountered.

 -- Exception: getopt.GetoptError

     This is raised when an unrecognized option is found in the argument
     list or when an option requiring an argument is given none.  The
     argument to the exception is a string indicating the cause of the
     error.  For long options, an argument given to an option which does
     not require one will also cause this exception to be raised.  The
     attributes ‘msg’ and ‘opt’ give the error message and related
     option; if there is no specific option to which the exception
     relates, ‘opt’ is an empty string.

 -- Exception: getopt.error

     Alias for *note GetoptError: 1fb7.; for backward compatibility.

An example using only Unix style options:

     >>> import getopt >>> args = '-a -b -cfoo -d bar a1 a2'.split() >>> args ['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2'] >>> optlist, args = getopt.getopt(args, 'abc:d:') >>> optlist [('-a', ''), ('-b', ''), ('-c', 'foo'), ('-d', 'bar')] >>> args ['a1', 'a2']

Using long option names is equally easy:

     >>> s = '--condition=foo --testing --output-file abc.def -x a1 a2' >>> args = s.split() >>> args ['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2'] >>> optlist, args = getopt.getopt(args, 'x', [ ...     'condition=', 'output-file=', 'testing']) >>> optlist [('--condition', 'foo'), ('--testing', ''), ('--output-file', 'abc.def'), ('-x', '')] >>> args ['a1', 'a2']

In a script, typical usage is something like this:

     import getopt, sys  def main():     try:         opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])     except getopt.GetoptError as err:         # print help information and exit:         print(err)  # will print something like "option -a not recognized"         usage()         sys.exit(2)     output = None     verbose = False     for o, a in opts:         if o == "-v":             verbose = True         elif o in ("-h", "--help"):             usage()             sys.exit()         elif o in ("-o", "--output"):             output = a         else:             assert False, "unhandled option"     # ...  if __name__ == "__main__":     main()

Note that an equivalent command line interface could be produced with
less code and more informative help and error messages by using the
*note argparse: 6. module:

     import argparse  if __name__ == '__main__':     parser = argparse.ArgumentParser()     parser.add_argument('-o', '--output')     parser.add_argument('-v', dest='verbose', action='store_true')     args = parser.parse_args()     # ... do something with args.output ...     # ... do something with args.verbose ..

See also
........

Module *note argparse: 6.

     Alternative command line option and argument parsing library.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/getopt.py


File: python.info,  Node: logging — Logging facility for Python,  Next: logging config — Logging configuration,  Prev: getopt — C-style parser for command line options,  Up: Generic Operating System Services

5.16.6 ‘logging’ — Logging facility for Python
----------------------------------------------

`Source code:' Lib/logging/__init__.py(1)

Important
.........

This page contains the API reference information.  For tutorial
information and discussion of more advanced topics, see

   * *note Basic Tutorial: b65.

   * *note Advanced Tutorial: b66.

   * *note Logging Cookbook: b67.

__________________________________________________________________

This module defines functions and classes which implement a flexible
event logging system for applications and libraries.

The key benefit of having the logging API provided by a standard library
module is that all Python modules can participate in logging, so your
application log can include your own messages integrated with messages
from third-party modules.

The module provides a lot of functionality and flexibility.  If you are
unfamiliar with logging, the best way to get to grips with it is to see
the tutorials (see the links on the right).

The basic classes defined by the module, together with their functions,
are listed below.

   * Loggers expose the interface that application code directly uses.

   * Handlers send the log records (created by loggers) to the
     appropriate destination.

   * Filters provide a finer grained facility for determining which log
     records to output.

   * Formatters specify the layout of log records in the final output.

* Menu:

* Logger Objects::
* Logging Levels::
* Handler Objects::
* Formatter Objects::
* Filter Objects::
* LogRecord Objects::
* LogRecord attributes::
* LoggerAdapter Objects::
* Thread Safety::
* Module-Level Functions::
* Module-Level Attributes::
* Integration with the warnings module::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/logging/__init__.py


File: python.info,  Node: Logger Objects,  Next: Logging Levels,  Up: logging — Logging facility for Python

5.16.6.1 Logger Objects
.......................

Loggers have the following attributes and methods.  Note that Loggers
should `NEVER' be instantiated directly, but always through the
module-level function ‘logging.getLogger(name)’.  Multiple calls to
*note getLogger(): 1fbe. with the same name will always return a
reference to the same Logger object.

The ‘name’ is potentially a period-separated hierarchical value, like
‘foo.bar.baz’ (though it could also be just plain ‘foo’, for example).
Loggers that are further down in the hierarchical list are children of
loggers higher up in the list.  For example, given a logger with a name
of ‘foo’, loggers with names of ‘foo.bar’, ‘foo.bar.baz’, and ‘foo.bam’
are all descendants of ‘foo’.  The logger name hierarchy is analogous to
the Python package hierarchy, and identical to it if you organise your
loggers on a per-module basis using the recommended construction
‘logging.getLogger(__name__)’.  That’s because in a module, ‘__name__’
is the module’s name in the Python package namespace.

 -- Class: logging.Logger

      -- Attribute: propagate

          If this attribute evaluates to true, events logged to this
          logger will be passed to the handlers of higher level
          (ancestor) loggers, in addition to any handlers attached to
          this logger.  Messages are passed directly to the ancestor
          loggers’ handlers - neither the level nor filters of the
          ancestor loggers in question are considered.

          If this evaluates to false, logging messages are not passed to
          the handlers of ancestor loggers.

          The constructor sets this attribute to ‘True’.

               Note: If you attach a handler to a logger `and' one or
               more of its ancestors, it may emit the same record
               multiple times.  In general, you should not need to
               attach a handler to more than one logger - if you just
               attach it to the appropriate logger which is highest in
               the logger hierarchy, then it will see all events logged
               by all descendant loggers, provided that their propagate
               setting is left set to ‘True’.  A common scenario is to
               attach handlers only to the root logger, and to let
               propagation take care of the rest.

      -- Method: setLevel (level)

          Sets the threshold for this logger to `level'.  Logging
          messages which are less severe than `level' will be ignored;
          logging messages which have severity `level' or higher will be
          emitted by whichever handler or handlers service this logger,
          unless a handler’s level has been set to a higher severity
          level than `level'.

          When a logger is created, the level is set to ‘NOTSET’ (which
          causes all messages to be processed when the logger is the
          root logger, or delegation to the parent when the logger is a
          non-root logger).  Note that the root logger is created with
          level ‘WARNING’.

          The term ‘delegation to the parent’ means that if a logger has
          a level of NOTSET, its chain of ancestor loggers is traversed
          until either an ancestor with a level other than NOTSET is
          found, or the root is reached.

          If an ancestor is found with a level other than NOTSET, then
          that ancestor’s level is treated as the effective level of the
          logger where the ancestor search began, and is used to
          determine how a logging event is handled.

          If the root is reached, and it has a level of NOTSET, then all
          messages will be processed.  Otherwise, the root’s level will
          be used as the effective level.

          See *note Logging Levels: 1fc1. for a list of levels.

          Changed in version 3.2: The `level' parameter now accepts a
          string representation of the level such as ‘INFO’ as an
          alternative to the integer constants such as ‘INFO’.  Note,
          however, that levels are internally stored as integers, and
          methods such as e.g.  *note getEffectiveLevel(): 1fc2. and
          *note isEnabledFor(): 1fc3. will return/expect to be passed
          integers.

      -- Method: isEnabledFor (level)

          Indicates if a message of severity `level' would be processed
          by this logger.  This method checks first the module-level
          level set by ‘logging.disable(level)’ and then the logger’s
          effective level as determined by *note getEffectiveLevel():
          1fc2.

      -- Method: getEffectiveLevel ()

          Indicates the effective level for this logger.  If a value
          other than ‘NOTSET’ has been set using *note setLevel(): 1fc0,
          it is returned.  Otherwise, the hierarchy is traversed towards
          the root until a value other than ‘NOTSET’ is found, and that
          value is returned.  The value returned is an integer,
          typically one of ‘logging.DEBUG’, ‘logging.INFO’ etc.

      -- Method: getChild (suffix)

          Returns a logger which is a descendant to this logger, as
          determined by the suffix.  Thus,
          ‘logging.getLogger('abc').getChild('def.ghi')’ would return
          the same logger as would be returned by
          ‘logging.getLogger('abc.def.ghi')’.  This is a convenience
          method, useful when the parent logger is named using e.g.
          ‘__name__’ rather than a literal string.

          New in version 3.2.

      -- Method: debug (msg, *args, **kwargs)

          Logs a message with level ‘DEBUG’ on this logger.  The `msg'
          is the message format string, and the `args' are the arguments
          which are merged into `msg' using the string formatting
          operator.  (Note that this means that you can use keywords in
          the format string, together with a single dictionary
          argument.)

          There are four keyword arguments in `kwargs' which are
          inspected: `exc_info', `stack_info', `stacklevel' and `extra'.

          If `exc_info' does not evaluate as false, it causes exception
          information to be added to the logging message.  If an
          exception tuple (in the format returned by *note
          sys.exc_info(): c52.) or an exception instance is provided, it
          is used; otherwise, *note sys.exc_info(): c52. is called to
          get the exception information.

          The second optional keyword argument is `stack_info', which
          defaults to ‘False’.  If true, stack information is added to
          the logging message, including the actual logging call.  Note
          that this is not the same stack information as that displayed
          through specifying `exc_info': The former is stack frames from
          the bottom of the stack up to the logging call in the current
          thread, whereas the latter is information about stack frames
          which have been unwound, following an exception, while
          searching for exception handlers.

          You can specify `stack_info' independently of `exc_info', e.g.
          to just show how you got to a certain point in your code, even
          when no exceptions were raised.  The stack frames are printed
          following a header line which says:

               Stack (most recent call last):

          This mimics the ‘Traceback (most recent call last):’ which is
          used when displaying exception frames.

          The third optional keyword argument is `stacklevel', which
          defaults to ‘1’.  If greater than 1, the corresponding number
          of stack frames are skipped when computing the line number and
          function name set in the *note LogRecord: 8fa. created for the
          logging event.  This can be used in logging helpers so that
          the function name, filename and line number recorded are not
          the information for the helper function/method, but rather its
          caller.  The name of this parameter mirrors the equivalent one
          in the *note warnings: 126. module.

          The fourth keyword argument is `extra' which can be used to
          pass a dictionary which is used to populate the __dict__ of
          the *note LogRecord: 8fa. created for the logging event with
          user-defined attributes.  These custom attributes can then be
          used as you like.  For example, they could be incorporated
          into logged messages.  For example:

               FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s' logging.basicConfig(format=FORMAT) d = {'clientip': '192.168.0.1', 'user': 'fbloggs'} logger = logging.getLogger('tcpserver') logger.warning('Protocol problem: %s', 'connection reset', extra=d)

          would print something like

               2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

          The keys in the dictionary passed in `extra' should not clash
          with the keys used by the logging system.  (See the *note
          Formatter: 1fc4. documentation for more information on which
          keys are used by the logging system.)

          If you choose to use these attributes in logged messages, you
          need to exercise some care.  In the above example, for
          instance, the *note Formatter: 1fc4. has been set up with a
          format string which expects ‘clientip’ and ‘user’ in the
          attribute dictionary of the *note LogRecord: 8fa.  If these
          are missing, the message will not be logged because a string
          formatting exception will occur.  So in this case, you always
          need to pass the `extra' dictionary with these keys.

          While this might be annoying, this feature is intended for use
          in specialized circumstances, such as multi-threaded servers
          where the same code executes in many contexts, and interesting
          conditions which arise are dependent on this context (such as
          remote client IP address and authenticated user name, in the
          above example).  In such circumstances, it is likely that
          specialized *note Formatter: 1fc4.s would be used with
          particular *note Handler: 1fc5.s.

          Changed in version 3.2: The `stack_info' parameter was added.

          Changed in version 3.5: The `exc_info' parameter can now
          accept exception instances.

          Changed in version 3.8: The `stacklevel' parameter was added.

      -- Method: info (msg, *args, **kwargs)

          Logs a message with level ‘INFO’ on this logger.  The
          arguments are interpreted as for *note debug(): 1fc7.

      -- Method: warning (msg, *args, **kwargs)

          Logs a message with level ‘WARNING’ on this logger.  The
          arguments are interpreted as for *note debug(): 1fc7.

               Note: There is an obsolete method ‘warn’ which is
               functionally identical to ‘warning’.  As ‘warn’ is
               deprecated, please do not use it - use ‘warning’ instead.

      -- Method: error (msg, *args, **kwargs)

          Logs a message with level ‘ERROR’ on this logger.  The
          arguments are interpreted as for *note debug(): 1fc7.

      -- Method: critical (msg, *args, **kwargs)

          Logs a message with level ‘CRITICAL’ on this logger.  The
          arguments are interpreted as for *note debug(): 1fc7.

      -- Method: log (level, msg, *args, **kwargs)

          Logs a message with integer level `level' on this logger.  The
          other arguments are interpreted as for *note debug(): 1fc7.

      -- Method: exception (msg, *args, **kwargs)

          Logs a message with level ‘ERROR’ on this logger.  The
          arguments are interpreted as for *note debug(): 1fc7.
          Exception info is added to the logging message.  This method
          should only be called from an exception handler.

      -- Method: addFilter (filter)

          Adds the specified filter `filter' to this logger.

      -- Method: removeFilter (filter)

          Removes the specified filter `filter' from this logger.

      -- Method: filter (record)

          Apply this logger’s filters to the record and return ‘True’ if
          the record is to be processed.  The filters are consulted in
          turn, until one of them returns a false value.  If none of
          them return a false value, the record will be processed
          (passed to handlers).  If one returns a false value, no
          further processing of the record occurs.

      -- Method: addHandler (hdlr)

          Adds the specified handler `hdlr' to this logger.

      -- Method: removeHandler (hdlr)

          Removes the specified handler `hdlr' from this logger.

      -- Method: findCaller (stack_info=False, stacklevel=1)

          Finds the caller’s source filename and line number.  Returns
          the filename, line number, function name and stack information
          as a 4-element tuple.  The stack information is returned as
          ‘None’ unless `stack_info' is ‘True’.

          The `stacklevel' parameter is passed from code calling the
          *note debug(): 1fc7. and other APIs.  If greater than 1, the
          excess is used to skip stack frames before determining the
          values to be returned.  This will generally be useful when
          calling logging APIs from helper/wrapper code, so that the
          information in the event log refers not to the helper/wrapper
          code, but to the code that calls it.

      -- Method: handle (record)

          Handles a record by passing it to all handlers associated with
          this logger and its ancestors (until a false value of
          `propagate' is found).  This method is used for unpickled
          records received from a socket, as well as those created
          locally.  Logger-level filtering is applied using *note
          filter(): 1fcc.

      -- Method: makeRecord (name, level, fn, lno, msg, args, exc_info,
               func=None, extra=None, sinfo=None)

          This is a factory method which can be overridden in subclasses
          to create specialized *note LogRecord: 8fa. instances.

      -- Method: hasHandlers ()

          Checks to see if this logger has any handlers configured.
          This is done by looking for handlers in this logger and its
          parents in the logger hierarchy.  Returns ‘True’ if a handler
          was found, else ‘False’.  The method stops searching up the
          hierarchy whenever a logger with the ‘propagate’ attribute set
          to false is found - that will be the last logger which is
          checked for the existence of handlers.

          New in version 3.2.

     Changed in version 3.7: Loggers can now be pickled and unpickled.


File: python.info,  Node: Logging Levels,  Next: Handler Objects,  Prev: Logger Objects,  Up: logging — Logging facility for Python

5.16.6.2 Logging Levels
.......................

The numeric values of logging levels are given in the following table.
These are primarily of interest if you want to define your own levels,
and need them to have specific values relative to the predefined levels.
If you define a level with the same numeric value, it overwrites the
predefined value; the predefined name is lost.

Level              Numeric value
                   
---------------------------------------
                   
‘CRITICAL’         50
                   
                   
‘ERROR’            40
                   
                   
‘WARNING’          30
                   
                   
‘INFO’             20
                   
                   
‘DEBUG’            10
                   
                   
‘NOTSET’           0
                   


File: python.info,  Node: Handler Objects,  Next: Formatter Objects,  Prev: Logging Levels,  Up: logging — Logging facility for Python

5.16.6.3 Handler Objects
........................

Handlers have the following attributes and methods.  Note that *note
Handler: 1fc5. is never instantiated directly; this class acts as a base
for more useful subclasses.  However, the *note __init__(): d51. method
in subclasses needs to call *note Handler.__init__(): 1fd6.

 -- Class: logging.Handler

      -- Method: __init__ (level=NOTSET)

          Initializes the *note Handler: 1fc5. instance by setting its
          level, setting the list of filters to the empty list and
          creating a lock (using *note createLock(): 1fd7.) for
          serializing access to an I/O mechanism.

      -- Method: createLock ()

          Initializes a thread lock which can be used to serialize
          access to underlying I/O functionality which may not be
          threadsafe.

      -- Method: acquire ()

          Acquires the thread lock created with *note createLock():
          1fd7.

      -- Method: release ()

          Releases the thread lock acquired with *note acquire(): 1fd8.

      -- Method: setLevel (level)

          Sets the threshold for this handler to `level'.  Logging
          messages which are less severe than `level' will be ignored.
          When a handler is created, the level is set to ‘NOTSET’ (which
          causes all messages to be processed).

          See *note Logging Levels: 1fc1. for a list of levels.

          Changed in version 3.2: The `level' parameter now accepts a
          string representation of the level such as ‘INFO’ as an
          alternative to the integer constants such as ‘INFO’.

      -- Method: setFormatter (fmt)

          Sets the *note Formatter: 1fc4. for this handler to `fmt'.

      -- Method: addFilter (filter)

          Adds the specified filter `filter' to this handler.

      -- Method: removeFilter (filter)

          Removes the specified filter `filter' from this handler.

      -- Method: filter (record)

          Apply this handler’s filters to the record and return ‘True’
          if the record is to be processed.  The filters are consulted
          in turn, until one of them returns a false value.  If none of
          them return a false value, the record will be emitted.  If one
          returns a false value, the handler will not emit the record.

      -- Method: flush ()

          Ensure all logging output has been flushed.  This version does
          nothing and is intended to be implemented by subclasses.

      -- Method: close ()

          Tidy up any resources used by the handler.  This version does
          no output but removes the handler from an internal list of
          handlers which is closed when *note shutdown(): 1fe1. is
          called.  Subclasses should ensure that this gets called from
          overridden *note close(): 1fe0. methods.

      -- Method: handle (record)

          Conditionally emits the specified logging record, depending on
          filters which may have been added to the handler.  Wraps the
          actual emission of the record with acquisition/release of the
          I/O thread lock.

      -- Method: handleError (record)

          This method should be called from handlers when an exception
          is encountered during an *note emit(): 1fe4. call.  If the
          module-level attribute ‘raiseExceptions’ is ‘False’,
          exceptions get silently ignored.  This is what is mostly
          wanted for a logging system - most users will not care about
          errors in the logging system, they are more interested in
          application errors.  You could, however, replace this with a
          custom handler if you wish.  The specified record is the one
          which was being processed when the exception occurred.  (The
          default value of ‘raiseExceptions’ is ‘True’, as that is more
          useful during development).

      -- Method: format (record)

          Do formatting for a record - if a formatter is set, use it.
          Otherwise, use the default formatter for the module.

      -- Method: emit (record)

          Do whatever it takes to actually log the specified logging
          record.  This version is intended to be implemented by
          subclasses and so raises a *note NotImplementedError: 603.

For a list of handlers included as standard, see *note logging.handlers:
ac.


File: python.info,  Node: Formatter Objects,  Next: Filter Objects,  Prev: Handler Objects,  Up: logging — Logging facility for Python

5.16.6.4 Formatter Objects
..........................

*note Formatter: 1fc4. objects have the following attributes and
methods.  They are responsible for converting a *note LogRecord: 8fa. to
(usually) a string which can be interpreted by either a human or an
external system.  The base *note Formatter: 1fc4. allows a formatting
string to be specified.  If none is supplied, the default value of
‘'%(message)s'’ is used, which just includes the message in the logging
call.  To have additional items of information in the formatted output
(such as a timestamp), keep reading.

A Formatter can be initialized with a format string which makes use of
knowledge of the *note LogRecord: 8fa. attributes - such as the default
value mentioned above making use of the fact that the user’s message and
arguments are pre-formatted into a *note LogRecord: 8fa.’s `message'
attribute.  This format string contains standard Python %-style mapping
keys.  See section *note printf-style String Formatting: 115f. for more
information on string formatting.

The useful mapping keys in a *note LogRecord: 8fa. are given in the
section on *note LogRecord attributes: 1fe8.

 -- Class: logging.Formatter (fmt=None, datefmt=None, style='%')

     Returns a new instance of the *note Formatter: 1fc4. class.  The
     instance is initialized with a format string for the message as a
     whole, as well as a format string for the date/time portion of a
     message.  If no `fmt' is specified, ‘'%(message)s'’ is used.  If no
     `datefmt' is specified, a format is used which is described in the
     *note formatTime(): 1fe9. documentation.

     The `style' parameter can be one of ‘%’, ‘{‘ or ‘$’ and determines
     how the format string will be merged with its data: using one of
     %-formatting, *note str.format(): 4cf. or *note string.Template:
     3e0.  See *note Using particular formatting styles throughout your
     application: 1fea. for more information on using {- and
     $-formatting for log messages.

     Changed in version 3.2: The `style' parameter was added.

     Changed in version 3.8: The `validate' parameter was added.
     Incorrect or mismatched style and fmt will raise a ‘ValueError’.
     For example: ‘logging.Formatter('%(asctime)s - %(message)s',
     style='{')’.

      -- Method: format (record)

          The record’s attribute dictionary is used as the operand to a
          string formatting operation.  Returns the resulting string.
          Before formatting the dictionary, a couple of preparatory
          steps are carried out.  The `message' attribute of the record
          is computed using `msg' % `args'.  If the formatting string
          contains ‘'(asctime)'’, *note formatTime(): 1fe9. is called to
          format the event time.  If there is exception information, it
          is formatted using *note formatException(): 1fec. and appended
          to the message.  Note that the formatted exception information
          is cached in attribute `exc_text'.  This is useful because the
          exception information can be pickled and sent across the wire,
          but you should be careful if you have more than one *note
          Formatter: 1fc4. subclass which customizes the formatting of
          exception information.  In this case, you will have to clear
          the cached value after a formatter has done its formatting, so
          that the next formatter to handle the event doesn’t use the
          cached value but recalculates it afresh.

          If stack information is available, it’s appended after the
          exception information, using *note formatStack(): 1fed. to
          transform it if necessary.

      -- Method: formatTime (record, datefmt=None)

          This method should be called from *note format(): 4d0. by a
          formatter which wants to make use of a formatted time.  This
          method can be overridden in formatters to provide for any
          specific requirement, but the basic behavior is as follows: if
          `datefmt' (a string) is specified, it is used with *note
          time.strftime(): b58. to format the creation time of the
          record.  Otherwise, the format ‘%Y-%m-%d %H:%M:%S,uuu’ is
          used, where the uuu part is a millisecond value and the other
          letters are as per the *note time.strftime(): b58.
          documentation.  An example time in this format is ‘2003-01-23
          00:29:50,411’.  The resulting string is returned.

          This function uses a user-configurable function to convert the
          creation time to a tuple.  By default, *note time.localtime():
          17ea. is used; to change this for a particular formatter
          instance, set the ‘converter’ attribute to a function with the
          same signature as *note time.localtime(): 17ea. or *note
          time.gmtime(): b32.  To change it for all formatters, for
          example if you want all logging times to be shown in GMT, set
          the ‘converter’ attribute in the ‘Formatter’ class.

          Changed in version 3.3: Previously, the default format was
          hard-coded as in this example: ‘2010-09-06 22:38:15,292’ where
          the part before the comma is handled by a strptime format
          string (‘'%Y-%m-%d %H:%M:%S'’), and the part after the comma
          is a millisecond value.  Because strptime does not have a
          format placeholder for milliseconds, the millisecond value is
          appended using another format string, ‘'%s,%03d'’ — and both
          of these format strings have been hardcoded into this method.
          With the change, these strings are defined as class-level
          attributes which can be overridden at the instance level when
          desired.  The names of the attributes are
          ‘default_time_format’ (for the strptime format string) and
          ‘default_msec_format’ (for appending the millisecond value).

      -- Method: formatException (exc_info)

          Formats the specified exception information (a standard
          exception tuple as returned by *note sys.exc_info(): c52.) as
          a string.  This default implementation just uses *note
          traceback.print_exception(): 1fee.  The resulting string is
          returned.

      -- Method: formatStack (stack_info)

          Formats the specified stack information (a string as returned
          by *note traceback.print_stack(): 76e, but with the last
          newline removed) as a string.  This default implementation
          just returns the input value.


File: python.info,  Node: Filter Objects,  Next: LogRecord Objects,  Prev: Formatter Objects,  Up: logging — Logging facility for Python

5.16.6.5 Filter Objects
.......................

‘Filters’ can be used by ‘Handlers’ and ‘Loggers’ for more sophisticated
filtering than is provided by levels.  The base filter class only allows
events which are below a certain point in the logger hierarchy.  For
example, a filter initialized with ‘A.B’ will allow events logged by
loggers ‘A.B’, ‘A.B.C’, ‘A.B.C.D’, ‘A.B.D’ etc.  but not ‘A.BB’, ‘B.A.B’
etc.  If initialized with the empty string, all events are passed.

 -- Class: logging.Filter (name='')

     Returns an instance of the *note Filter: b6a. class.  If `name' is
     specified, it names a logger which, together with its children,
     will have its events allowed through the filter.  If `name' is the
     empty string, allows every event.

      -- Method: filter (record)

          Is the specified record to be logged?  Returns zero for no,
          nonzero for yes.  If deemed appropriate, the record may be
          modified in-place by this method.

Note that filters attached to handlers are consulted before an event is
emitted by the handler, whereas filters attached to loggers are
consulted whenever an event is logged (using *note debug(): 1fc7, *note
info(): 1ff2, etc.), before sending an event to handlers.  This means
that events which have been generated by descendant loggers will not be
filtered by a logger’s filter setting, unless the filter has also been
applied to those descendant loggers.

You don’t actually need to subclass ‘Filter’: you can pass any instance
which has a ‘filter’ method with the same semantics.

Changed in version 3.2: You don’t need to create specialized ‘Filter’
classes, or use other classes with a ‘filter’ method: you can use a
function (or other callable) as a filter.  The filtering logic will
check to see if the filter object has a ‘filter’ attribute: if it does,
it’s assumed to be a ‘Filter’ and its *note filter(): 1ff1. method is
called.  Otherwise, it’s assumed to be a callable and called with the
record as the single parameter.  The returned value should conform to
that returned by *note filter(): 1ff1.

Although filters are used primarily to filter records based on more
sophisticated criteria than levels, they get to see every record which
is processed by the handler or logger they’re attached to: this can be
useful if you want to do things like counting how many records were
processed by a particular logger or handler, or adding, changing or
removing attributes in the *note LogRecord: 8fa. being processed.
Obviously changing the LogRecord needs to be done with some care, but it
does allow the injection of contextual information into logs (see *note
Using Filters to impart contextual information: 1ff3.).


File: python.info,  Node: LogRecord Objects,  Next: LogRecord attributes,  Prev: Filter Objects,  Up: logging — Logging facility for Python

5.16.6.6 LogRecord Objects
..........................

*note LogRecord: 8fa. instances are created automatically by the *note
Logger: 39c. every time something is logged, and can be created manually
via *note makeLogRecord(): 1ff6. (for example, from a pickled event
received over the wire).

 -- Class: logging.LogRecord (name, level, pathname, lineno, msg, args,
          exc_info, func=None, sinfo=None)

     Contains all the information pertinent to the event being logged.

     The primary information is passed in ‘msg’ and ‘args’, which are
     combined using ‘msg % args’ to create the ‘message’ field of the
     record.


     Parameters:

        * ‘name’ – The name of the logger used to log the event
          represented by this LogRecord.  Note that this name will
          always have this value, even though it may be emitted by a
          handler attached to a different (ancestor) logger.

        * ‘level’ – The numeric level of the logging event (one of
          DEBUG, INFO etc.)  Note that this is converted to `two'
          attributes of the LogRecord: ‘levelno’ for the numeric value
          and ‘levelname’ for the corresponding level name.

        * ‘pathname’ – The full pathname of the source file where the
          logging call was made.

        * ‘lineno’ – The line number in the source file where the
          logging call was made.

        * ‘msg’ – The event description message, possibly a format
          string with placeholders for variable data.

        * ‘args’ – Variable data to merge into the `msg' argument to
          obtain the event description.

        * ‘exc_info’ – An exception tuple with the current exception
          information, or ‘None’ if no exception information is
          available.

        * ‘func’ – The name of the function or method from which the
          logging call was invoked.

        * ‘sinfo’ – A text string representing stack information from
          the base of the stack in the current thread, up to the logging
          call.

      -- Method: getMessage ()

          Returns the message for this *note LogRecord: 8fa. instance
          after merging any user-supplied arguments with the message.
          If the user-supplied message argument to the logging call is
          not a string, *note str(): 325. is called on it to convert it
          to a string.  This allows use of user-defined classes as
          messages, whose ‘__str__’ method can return the actual format
          string to be used.

     Changed in version 3.2: The creation of a *note LogRecord: 8fa. has
     been made more configurable by providing a factory which is used to
     create the record.  The factory can be set using *note
     getLogRecordFactory(): 1ff8. and *note setLogRecordFactory(): 1ff9.
     (see this for the factory’s signature).

     This functionality can be used to inject your own values into a
     *note LogRecord: 8fa. at creation time.  You can use the following
     pattern:

          old_factory = logging.getLogRecordFactory()  def record_factory(*args, **kwargs):     record = old_factory(*args, **kwargs)     record.custom_attribute = 0xdecafbad     return record  logging.setLogRecordFactory(record_factory)

     With this pattern, multiple factories could be chained, and as long
     as they don’t overwrite each other’s attributes or unintentionally
     overwrite the standard attributes listed above, there should be no
     surprises.


File: python.info,  Node: LogRecord attributes,  Next: LoggerAdapter Objects,  Prev: LogRecord Objects,  Up: logging — Logging facility for Python

5.16.6.7 LogRecord attributes
.............................

The LogRecord has a number of attributes, most of which are derived from
the parameters to the constructor.  (Note that the names do not always
correspond exactly between the LogRecord constructor parameters and the
LogRecord attributes.)  These attributes can be used to merge data from
the record into the format string.  The following table lists (in
alphabetical order) the attribute names, their meanings and the
corresponding placeholder in a %-style format string.

If you are using {}-formatting (*note str.format(): 4cf.), you can use
‘{attrname}’ as the placeholder in the format string.  If you are using
$-formatting (*note string.Template: 3e0.), use the form ‘${attrname}’.
In both cases, of course, replace ‘attrname’ with the actual attribute
name you want to use.

In the case of {}-formatting, you can specify formatting flags by
placing them after the attribute name, separated from it with a colon.
For example: a placeholder of ‘{msecs:03d}’ would format a millisecond
value of ‘4’ as ‘004’.  Refer to the *note str.format(): 4cf.
documentation for full details on the options available to you.

Attribute name       Format                        Description
                                                   
-------------------------------------------------------------------------------------------------------
                                                   
args                 You shouldn’t need to         The tuple of arguments merged into ‘msg’ to
                     format this yourself.         produce ‘message’, or a dict whose values are
                                                   used for the merge (when there is only one
                                                   argument, and it is a dictionary).
                                                   
                                                   
asctime              ‘%(asctime)s’                 Human-readable time when the
                                                   *note LogRecord: 8fa. was created.  By default
                                                   this is of the form ‘2003-07-08 16:49:45,896’
                                                   (the numbers after the comma are millisecond
                                                   portion of the time).
                                                   
                                                   
created              ‘%(created)f’                 Time when the *note LogRecord: 8fa. was created
                                                   (as returned by *note time.time(): 312.).
                                                   
                                                   
exc_info             You shouldn’t need to         Exception tuple (à la ‘sys.exc_info’) or, if no
                     format this yourself.         exception has occurred, ‘None’.
                                                   
                                                   
filename             ‘%(filename)s’                Filename portion of ‘pathname’.
                                                   
                                                   
funcName             ‘%(funcName)s’                Name of function containing the logging call.
                                                   
                                                   
levelname            ‘%(levelname)s’               Text logging level for the message (‘'DEBUG'’,
                                                   ‘'INFO'’, ‘'WARNING'’, ‘'ERROR'’, ‘'CRITICAL'’).
                                                   
                                                   
levelno              ‘%(levelno)s’                 Numeric logging level for the message (‘DEBUG’,
                                                   ‘INFO’, ‘WARNING’, ‘ERROR’, ‘CRITICAL’).
                                                   
                                                   
lineno               ‘%(lineno)d’                  Source line number where the logging call was
                                                   issued (if available).
                                                   
                                                   
message              ‘%(message)s’                 The logged message, computed as ‘msg % args’.
                                                   This is set when *note Formatter.format(): 1feb.
                                                   is invoked.
                                                   
                                                   
module               ‘%(module)s’                  Module (name portion of ‘filename’).
                                                   
                                                   
msecs                ‘%(msecs)d’                   Millisecond portion of the time when the
                                                   *note LogRecord: 8fa. was created.
                                                   
                                                   
msg                  You shouldn’t need to         The format string passed in the original logging
                     format this yourself.         call.  Merged with ‘args’ to produce ‘message’,
                                                   or an arbitrary object (see
                                                   *note Using arbitrary objects as messages: 1ffb.).
                                                   
                                                   
name                 ‘%(name)s’                    Name of the logger used to log the call.
                                                   
                                                   
pathname             ‘%(pathname)s’                Full pathname of the source file where the
                                                   logging call was issued (if available).
                                                   
                                                   
process              ‘%(process)d’                 Process ID (if available).
                                                   
                                                   
processName          ‘%(processName)s’             Process name (if available).
                                                   
                                                   
relativeCreated      ‘%(relativeCreated)d’         Time in milliseconds when the LogRecord was
                                                   created, relative to the time the logging module
                                                   was loaded.
                                                   
                                                   
stack_info           You shouldn’t need to         Stack frame information (where available) from
                     format this yourself.         the bottom of the stack in the current thread, up
                                                   to and including the stack frame of the logging
                                                   call which resulted in the creation of this
                                                   record.
                                                   
                                                   
thread               ‘%(thread)d’                  Thread ID (if available).
                                                   
                                                   
threadName           ‘%(threadName)s’              Thread name (if available).
                                                   

Changed in version 3.1: `processName' was added.


File: python.info,  Node: LoggerAdapter Objects,  Next: Thread Safety,  Prev: LogRecord attributes,  Up: logging — Logging facility for Python

5.16.6.8 LoggerAdapter Objects
..............................

*note LoggerAdapter: c7f. instances are used to conveniently pass
contextual information into logging calls.  For a usage example, see the
section on *note adding contextual information to your logging output:
1ffe.

 -- Class: logging.LoggerAdapter (logger, extra)

     Returns an instance of *note LoggerAdapter: c7f. initialized with
     an underlying *note Logger: 39c. instance and a dict-like object.

      -- Method: process (msg, kwargs)

          Modifies the message and/or keyword arguments passed to a
          logging call in order to insert contextual information.  This
          implementation takes the object passed as `extra' to the
          constructor and adds it to `kwargs' using key ‘extra’.  The
          return value is a (`msg', `kwargs') tuple which has the
          (possibly modified) versions of the arguments passed in.

In addition to the above, *note LoggerAdapter: c7f. supports the
following methods of *note Logger: 39c.: *note debug(): 704, *note
info(): 1fc6, *note warning(): 1fc8, *note error(): 1fc9, *note
exception(): 702, *note critical(): 703, *note log(): 701, *note
isEnabledFor(): 1fc3, *note getEffectiveLevel(): 1fc2, *note setLevel():
1fc0. and *note hasHandlers(): 1fd2.  These methods have the same
signatures as their counterparts in *note Logger: 39c, so you can use
the two types of instances interchangeably.

Changed in version 3.2: The *note isEnabledFor(): 1fc3, *note
getEffectiveLevel(): 1fc2, *note setLevel(): 1fc0. and *note
hasHandlers(): 1fd2. methods were added to *note LoggerAdapter: c7f.
These methods delegate to the underlying logger.


File: python.info,  Node: Thread Safety,  Next: Module-Level Functions,  Prev: LoggerAdapter Objects,  Up: logging — Logging facility for Python

5.16.6.9 Thread Safety
......................

The logging module is intended to be thread-safe without any special
work needing to be done by its clients.  It achieves this though using
threading locks; there is one lock to serialize access to the module’s
shared data, and each handler also creates a lock to serialize access to
its underlying I/O.

If you are implementing asynchronous signal handlers using the *note
signal: ea. module, you may not be able to use logging from within such
handlers.  This is because lock implementations in the *note threading:
109. module are not always re-entrant, and so cannot be invoked from
such signal handlers.


File: python.info,  Node: Module-Level Functions,  Next: Module-Level Attributes,  Prev: Thread Safety,  Up: logging — Logging facility for Python

5.16.6.10 Module-Level Functions
................................

In addition to the classes described above, there are a number of
module-level functions.

 -- Function: logging.getLogger (name=None)

     Return a logger with the specified name or, if name is ‘None’,
     return a logger which is the root logger of the hierarchy.  If
     specified, the name is typically a dot-separated hierarchical name
     like `‘a’', `‘a.b’' or `‘a.b.c.d’'.  Choice of these names is
     entirely up to the developer who is using logging.

     All calls to this function with a given name return the same logger
     instance.  This means that logger instances never need to be passed
     between different parts of an application.

 -- Function: logging.getLoggerClass ()

     Return either the standard *note Logger: 39c. class, or the last
     class passed to *note setLoggerClass(): 2003.  This function may be
     called from within a new class definition, to ensure that
     installing a customized *note Logger: 39c. class will not undo
     customizations already applied by other code.  For example:

          class MyLogger(logging.getLoggerClass()):     # ... override behaviour here

 -- Function: logging.getLogRecordFactory ()

     Return a callable which is used to create a *note LogRecord: 8fa.

     New in version 3.2: This function has been provided, along with
     *note setLogRecordFactory(): 1ff9, to allow developers more control
     over how the *note LogRecord: 8fa. representing a logging event is
     constructed.

     See *note setLogRecordFactory(): 1ff9. for more information about
     the how the factory is called.

 -- Function: logging.debug (msg, *args, **kwargs)

     Logs a message with level ‘DEBUG’ on the root logger.  The `msg' is
     the message format string, and the `args' are the arguments which
     are merged into `msg' using the string formatting operator.  (Note
     that this means that you can use keywords in the format string,
     together with a single dictionary argument.)

     There are three keyword arguments in `kwargs' which are inspected:
     `exc_info' which, if it does not evaluate as false, causes
     exception information to be added to the logging message.  If an
     exception tuple (in the format returned by *note sys.exc_info():
     c52.) or an exception instance is provided, it is used; otherwise,
     *note sys.exc_info(): c52. is called to get the exception
     information.

     The second optional keyword argument is `stack_info', which
     defaults to ‘False’.  If true, stack information is added to the
     logging message, including the actual logging call.  Note that this
     is not the same stack information as that displayed through
     specifying `exc_info': The former is stack frames from the bottom
     of the stack up to the logging call in the current thread, whereas
     the latter is information about stack frames which have been
     unwound, following an exception, while searching for exception
     handlers.

     You can specify `stack_info' independently of `exc_info', e.g.  to
     just show how you got to a certain point in your code, even when no
     exceptions were raised.  The stack frames are printed following a
     header line which says:

          Stack (most recent call last):

     This mimics the ‘Traceback (most recent call last):’ which is used
     when displaying exception frames.

     The third optional keyword argument is `extra' which can be used to
     pass a dictionary which is used to populate the __dict__ of the
     LogRecord created for the logging event with user-defined
     attributes.  These custom attributes can then be used as you like.
     For example, they could be incorporated into logged messages.  For
     example:

          FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s' logging.basicConfig(format=FORMAT) d = {'clientip': '192.168.0.1', 'user': 'fbloggs'} logging.warning('Protocol problem: %s', 'connection reset', extra=d)

     would print something like:

          2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

     The keys in the dictionary passed in `extra' should not clash with
     the keys used by the logging system.  (See the *note Formatter:
     1fc4. documentation for more information on which keys are used by
     the logging system.)

     If you choose to use these attributes in logged messages, you need
     to exercise some care.  In the above example, for instance, the
     *note Formatter: 1fc4. has been set up with a format string which
     expects ‘clientip’ and ‘user’ in the attribute dictionary of the
     LogRecord.  If these are missing, the message will not be logged
     because a string formatting exception will occur.  So in this case,
     you always need to pass the `extra' dictionary with these keys.

     While this might be annoying, this feature is intended for use in
     specialized circumstances, such as multi-threaded servers where the
     same code executes in many contexts, and interesting conditions
     which arise are dependent on this context (such as remote client IP
     address and authenticated user name, in the above example).  In
     such circumstances, it is likely that specialized *note Formatter:
     1fc4.s would be used with particular *note Handler: 1fc5.s.

     Changed in version 3.2: The `stack_info' parameter was added.

 -- Function: logging.info (msg, *args, **kwargs)

     Logs a message with level ‘INFO’ on the root logger.  The arguments
     are interpreted as for *note debug(): 1fc7.

 -- Function: logging.warning (msg, *args, **kwargs)

     Logs a message with level ‘WARNING’ on the root logger.  The
     arguments are interpreted as for *note debug(): 1fc7.

          Note: There is an obsolete function ‘warn’ which is
          functionally identical to ‘warning’.  As ‘warn’ is deprecated,
          please do not use it - use ‘warning’ instead.

 -- Function: logging.error (msg, *args, **kwargs)

     Logs a message with level ‘ERROR’ on the root logger.  The
     arguments are interpreted as for *note debug(): 1fc7.

 -- Function: logging.critical (msg, *args, **kwargs)

     Logs a message with level ‘CRITICAL’ on the root logger.  The
     arguments are interpreted as for *note debug(): 1fc7.

 -- Function: logging.exception (msg, *args, **kwargs)

     Logs a message with level ‘ERROR’ on the root logger.  The
     arguments are interpreted as for *note debug(): 1fc7.  Exception
     info is added to the logging message.  This function should only be
     called from an exception handler.

 -- Function: logging.log (level, msg, *args, **kwargs)

     Logs a message with level `level' on the root logger.  The other
     arguments are interpreted as for *note debug(): 1fc7.

          Note: The above module-level convenience functions, which
          delegate to the root logger, call *note basicConfig(): 1de. to
          ensure that at least one handler is available.  Because of
          this, they should `not' be used in threads, in versions of
          Python earlier than 2.7.1 and 3.2, unless at least one handler
          has been added to the root logger `before' the threads are
          started.  In earlier versions of Python, due to a thread
          safety shortcoming in *note basicConfig(): 1de, this can
          (under rare circumstances) lead to handlers being added
          multiple times to the root logger, which can in turn lead to
          multiple messages for the same event.

 -- Function: logging.disable (level=CRITICAL)

     Provides an overriding level `level' for all loggers which takes
     precedence over the logger’s own level.  When the need arises to
     temporarily throttle logging output down across the whole
     application, this function can be useful.  Its effect is to disable
     all logging calls of severity `level' and below, so that if you
     call it with a value of INFO, then all INFO and DEBUG events would
     be discarded, whereas those of severity WARNING and above would be
     processed according to the logger’s effective level.  If
     ‘logging.disable(logging.NOTSET)’ is called, it effectively removes
     this overriding level, so that logging output again depends on the
     effective levels of individual loggers.

     Note that if you have defined any custom logging level higher than
     ‘CRITICAL’ (this is not recommended), you won’t be able to rely on
     the default value for the `level' parameter, but will have to
     explicitly supply a suitable value.

     Changed in version 3.7: The `level' parameter was defaulted to
     level ‘CRITICAL’.  See Issue #28524 for more information about this
     change.

 -- Function: logging.addLevelName (level, levelName)

     Associates level `level' with text `levelName' in an internal
     dictionary, which is used to map numeric levels to a textual
     representation, for example when a *note Formatter: 1fc4. formats a
     message.  This function can also be used to define your own levels.
     The only constraints are that all levels used must be registered
     using this function, levels should be positive integers and they
     should increase in increasing order of severity.

          Note: If you are thinking of defining your own levels, please
          see the section on *note Custom Levels: 200b.

 -- Function: logging.getLevelName (level)

     Returns the textual representation of logging level `level'.  If
     the level is one of the predefined levels ‘CRITICAL’, ‘ERROR’,
     ‘WARNING’, ‘INFO’ or ‘DEBUG’ then you get the corresponding string.
     If you have associated levels with names using *note
     addLevelName(): 200a. then the name you have associated with
     `level' is returned.  If a numeric value corresponding to one of
     the defined levels is passed in, the corresponding string
     representation is returned.  Otherwise, the string ‘Level %s’ %
     level is returned.

          Note: Levels are internally integers (as they need to be
          compared in the logging logic).  This function is used to
          convert between an integer level and the level name displayed
          in the formatted log output by means of the ‘%(levelname)s’
          format specifier (see *note LogRecord attributes: 1fe8.).

     Changed in version 3.4: In Python versions earlier than 3.4, this
     function could also be passed a text level, and would return the
     corresponding numeric value of the level.  This undocumented
     behaviour was considered a mistake, and was removed in Python 3.4,
     but reinstated in 3.4.2 due to retain backward compatibility.

 -- Function: logging.makeLogRecord (attrdict)

     Creates and returns a new *note LogRecord: 8fa. instance whose
     attributes are defined by `attrdict'.  This function is useful for
     taking a pickled *note LogRecord: 8fa. attribute dictionary, sent
     over a socket, and reconstituting it as a *note LogRecord: 8fa.
     instance at the receiving end.

 -- Function: logging.basicConfig (**kwargs)

     Does basic configuration for the logging system by creating a *note
     StreamHandler: b68. with a default *note Formatter: 1fc4. and
     adding it to the root logger.  The functions *note debug(): 1fc7,
     *note info(): 1ff2, *note warning(): 2004, *note error(): 2005. and
     *note critical(): 2006. will call *note basicConfig(): 1de.
     automatically if no handlers are defined for the root logger.

     This function does nothing if the root logger already has handlers
     configured, unless the keyword argument `force' is set to ‘True’.

          Note: This function should be called from the main thread
          before other threads are started.  In versions of Python prior
          to 2.7.1 and 3.2, if this function is called from multiple
          threads, it is possible (in rare circumstances) that a handler
          will be added to the root logger more than once, leading to
          unexpected results such as messages being duplicated in the
          log.

     The following keyword arguments are supported.

     Format             Description
                        
     ---------------------------------------------------------------------
                        
     `filename'         Specifies that a FileHandler be created, using
                        the specified filename, rather than a
                        StreamHandler.
                        
                        
     `filemode'         If `filename' is specified, open the file in
                        this *note mode: 1531.  Defaults to ‘'a'’.
                        
                        
     `format'           Use the specified format string for the
                        handler.
                        
                        
     `datefmt'          Use the specified date/time format, as accepted
                        by *note time.strftime(): b58.
                        
                        
     `style'            If `format' is specified, use this style for
                        the format string.  One of ‘'%'’, ‘'{'’ or
                        ‘'$'’ for *note printf-style: 115f,
                        *note str.format(): 4cf. or
                        *note string.Template: 3e0. respectively.
                        Defaults to ‘'%'’.
                        
                        
     `level'            Set the root logger level to the specified
                        *note level: 1fc1.
                        
                        
     `stream'           Use the specified stream to initialize the
                        StreamHandler.  Note that this argument is
                        incompatible with `filename' - if both are
                        present, a ‘ValueError’ is raised.
                        
                        
     `handlers'         If specified, this should be an iterable of
                        already created handlers to add to the root
                        logger.  Any handlers which don’t already have
                        a formatter set will be assigned the default
                        formatter created in this function.  Note that
                        this argument is incompatible with `filename'
                        or `stream' - if both are present, a
                        ‘ValueError’ is raised.
                        
                        
     `force'            If this keyword argument is specified as true,
                        any existing handlers attached to the root
                        logger are removed and closed, before carrying
                        out the configuration as specified by the other
                        arguments.
                        

     Changed in version 3.2: The `style' argument was added.

     Changed in version 3.3: The `handlers' argument was added.
     Additional checks were added to catch situations where incompatible
     arguments are specified (e.g.  `handlers' together with `stream' or
     `filename', or `stream' together with `filename').

     Changed in version 3.8: The `force' argument was added.

 -- Function: logging.shutdown ()

     Informs the logging system to perform an orderly shutdown by
     flushing and closing all handlers.  This should be called at
     application exit and no further use of the logging system should be
     made after this call.

     When the logging module is imported, it registers this function as
     an exit handler (see *note atexit: c.), so normally there’s no need
     to do that manually.

 -- Function: logging.setLoggerClass (klass)

     Tells the logging system to use the class `klass' when
     instantiating a logger.  The class should define *note __init__():
     d51. such that only a name argument is required, and the *note
     __init__(): d51. should call ‘Logger.__init__()’.  This function is
     typically called before any loggers are instantiated by
     applications which need to use custom logger behavior.  After this
     call, as at any other time, do not instantiate loggers directly
     using the subclass: continue to use the *note logging.getLogger():
     1fbe. API to get your loggers.

 -- Function: logging.setLogRecordFactory (factory)

     Set a callable which is used to create a *note LogRecord: 8fa.


     Parameters: ‘factory’ – The factory callable to be used to
     instantiate a log record.

     New in version 3.2: This function has been provided, along with
     *note getLogRecordFactory(): 1ff8, to allow developers more control
     over how the *note LogRecord: 8fa. representing a logging event is
     constructed.

     The factory has the following signature:

     ‘factory(name, level, fn, lno, msg, args, exc_info, func=None,
     sinfo=None, **kwargs)’


          name: The logger name.


          level: The logging level (numeric).


          fn: The full pathname of the file where the logging call was
          made.


          lno: The line number in the file where the logging call was
          made.


          msg: The logging message.


          args: The arguments for the logging message.


          exc_info: An exception tuple, or ‘None’.


          func: The name of the function or method which invoked the
          logging call.


          sinfo: A stack traceback such as is provided by *note
          traceback.print_stack(): 76e, showing the call hierarchy.


          kwargs: Additional keyword arguments.


File: python.info,  Node: Module-Level Attributes,  Next: Integration with the warnings module,  Prev: Module-Level Functions,  Up: logging — Logging facility for Python

5.16.6.11 Module-Level Attributes
.................................

 -- Attribute: logging.lastResort

     A “handler of last resort” is available through this attribute.
     This is a *note StreamHandler: b68. writing to ‘sys.stderr’ with a
     level of ‘WARNING’, and is used to handle logging events in the
     absence of any logging configuration.  The end result is to just
     print the message to ‘sys.stderr’.  This replaces the earlier error
     message saying that “no handlers could be found for logger XYZ”.
     If you need the earlier behaviour for some reason, ‘lastResort’ can
     be set to ‘None’.

     New in version 3.2.


File: python.info,  Node: Integration with the warnings module,  Prev: Module-Level Attributes,  Up: logging — Logging facility for Python

5.16.6.12 Integration with the warnings module
..............................................

The *note captureWarnings(): 200f. function can be used to integrate
*note logging: aa. with the *note warnings: 126. module.

 -- Function: logging.captureWarnings (capture)

     This function is used to turn the capture of warnings by logging on
     and off.

     If `capture' is ‘True’, warnings issued by the *note warnings: 126.
     module will be redirected to the logging system.  Specifically, a
     warning will be formatted using *note warnings.formatwarning():
     f26. and the resulting string logged to a logger named
     ‘'py.warnings'’ with a severity of ‘WARNING’.

     If `capture' is ‘False’, the redirection of warnings to the logging
     system will stop, and warnings will be redirected to their original
     destinations (i.e.  those in effect before ‘captureWarnings(True)’
     was called).

See also
........

Module *note logging.config: ab.

     Configuration API for the logging module.

Module *note logging.handlers: ac.

     Useful handlers included with the logging module.

PEP 282(1) - A Logging System

     The proposal which described this feature for inclusion in the
     Python standard library.

Original Python logging package(2)

     This is the original source for the *note logging: aa. package.
     The version of the package available from this site is suitable for
     use with Python 1.5.2, 2.1.x and 2.2.x, which do not include the
     *note logging: aa. package in the standard library.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0282

   (2) https://www.red-dove.com/python_logging.html


File: python.info,  Node: logging config — Logging configuration,  Next: logging handlers — Logging handlers,  Prev: logging — Logging facility for Python,  Up: Generic Operating System Services

5.16.7 ‘logging.config’ — Logging configuration
-----------------------------------------------

`Source code:' Lib/logging/config.py(1)

Important
.........

This page contains only reference information.  For tutorials, please
see

   * *note Basic Tutorial: b65.

   * *note Advanced Tutorial: b66.

   * *note Logging Cookbook: b67.

__________________________________________________________________

This section describes the API for configuring the logging module.

* Menu:

* Configuration functions::
* Configuration dictionary schema::
* Configuration file format::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/logging/config.py


File: python.info,  Node: Configuration functions,  Next: Configuration dictionary schema,  Up: logging config — Logging configuration

5.16.7.1 Configuration functions
................................

The following functions configure the logging module.  They are located
in the *note logging.config: ab. module.  Their use is optional — you
can configure the logging module using these functions or by making
calls to the main API (defined in *note logging: aa. itself) and
defining handlers which are declared either in *note logging: aa. or
*note logging.handlers: ac.

 -- Function: logging.config.dictConfig (config)

          Takes the logging configuration from a dictionary.  The
          contents of this dictionary are described in *note
          Configuration dictionary schema: 2013. below.

          If an error is encountered during configuration, this function
          will raise a *note ValueError: 1f9, *note TypeError: 192,
          *note AttributeError: 390. or *note ImportError: 329. with a
          suitably descriptive message.  The following is a (possibly
          incomplete) list of conditions which will raise an error:

             * A ‘level’ which is not a string or which is a string not
               corresponding to an actual logging level.

             * A ‘propagate’ value which is not a boolean.

             * An id which does not have a corresponding destination.

             * A non-existent handler id found during an incremental
               call.

             * An invalid logger name.

             * Inability to resolve to an internal or external object.

          Parsing is performed by the ‘DictConfigurator’ class, whose
          constructor is passed the dictionary used for configuration,
          and has a ‘configure()’ method.  The *note logging.config: ab.
          module has a callable attribute ‘dictConfigClass’ which is
          initially set to ‘DictConfigurator’.  You can replace the
          value of ‘dictConfigClass’ with a suitable implementation of
          your own.

          *note dictConfig(): b1e. calls ‘dictConfigClass’ passing the
          specified dictionary, and then calls the ‘configure()’ method
          on the returned object to put the configuration into effect:

               def dictConfig(config):     dictConfigClass(config).configure()

          For example, a subclass of ‘DictConfigurator’ could call
          ‘DictConfigurator.__init__()’ in its own *note __init__():
          d51, then set up custom prefixes which would be usable in the
          subsequent ‘configure()’ call.  ‘dictConfigClass’ would be
          bound to this new subclass, and then *note dictConfig(): b1e.
          could be called exactly as in the default, uncustomized state.

     New in version 3.2.

 -- Function: logging.config.fileConfig (fname, defaults=None,
          disable_existing_loggers=True)

     Reads the logging configuration from a *note configparser:
     23.-format file.  The format of the file should be as described in
     *note Configuration file format: 2014.  This function can be called
     several times from an application, allowing an end user to select
     from various pre-canned configurations (if the developer provides a
     mechanism to present the choices and load the chosen
     configuration).


     Parameters:

        * ‘fname’ – A filename, or a file-like object, or an instance
          derived from *note RawConfigParser: 865.  If a
          ‘RawConfigParser’-derived instance is passed, it is used as
          is.  Otherwise, a ‘Configparser’ is instantiated, and the
          configuration read by it from the object passed in ‘fname’.
          If that has a *note readline(): de. method, it is assumed to
          be a file-like object and read using *note read_file(): 1d96.;
          otherwise, it is assumed to be a filename and passed to *note
          read(): fdd.

        * ‘defaults’ – Defaults to be passed to the ConfigParser can be
          specified in this argument.

        * ‘disable_existing_loggers’ – If specified as ‘False’, loggers
          which exist when this call is made are left enabled.  The
          default is ‘True’ because this enables old behaviour in a
          backward-compatible way.  This behaviour is to disable any
          existing non-root loggers unless they or their ancestors are
          explicitly named in the logging configuration.

     Changed in version 3.4: An instance of a subclass of *note
     RawConfigParser: 865. is now accepted as a value for ‘fname’.  This
     facilitates:

        * Use of a configuration file where logging configuration is
          just part of the overall application configuration.

        * Use of a configuration read from a file, and then modified by
          the using application (e.g.  based on command-line parameters
          or other aspects of the runtime environment) before being
          passed to ‘fileConfig’.

 -- Function: logging.config.listen (port=DEFAULT_LOGGING_CONFIG_PORT,
          verify=None)

     Starts up a socket server on the specified port, and listens for
     new configurations.  If no port is specified, the module’s default
     ‘DEFAULT_LOGGING_CONFIG_PORT’ is used.  Logging configurations will
     be sent as a file suitable for processing by *note dictConfig():
     b1e. or *note fileConfig(): 39e.  Returns a *note Thread: 233.
     instance on which you can call *note start(): 2015. to start the
     server, and which you can *note join(): b53. when appropriate.  To
     stop the server, call *note stopListening(): 2016.

     The ‘verify’ argument, if specified, should be a callable which
     should verify whether bytes received across the socket are valid
     and should be processed.  This could be done by encrypting and/or
     signing what is sent across the socket, such that the ‘verify’
     callable can perform signature verification and/or decryption.  The
     ‘verify’ callable is called with a single argument - the bytes
     received across the socket - and should return the bytes to be
     processed, or ‘None’ to indicate that the bytes should be
     discarded.  The returned bytes could be the same as the passed in
     bytes (e.g.  when only verification is done), or they could be
     completely different (perhaps if decryption were performed).

     To send a configuration to the socket, read in the configuration
     file and send it to the socket as a sequence of bytes preceded by a
     four-byte length string packed in binary using ‘struct.pack('>L',
     n)’.

          Note: Because portions of the configuration are passed through
          *note eval(): b83, use of this function may open its users to
          a security risk.  While the function only binds to a socket on
          ‘localhost’, and so does not accept connections from remote
          machines, there are scenarios where untrusted code could be
          run under the account of the process which calls *note
          listen(): 866.  Specifically, if the process calling *note
          listen(): 866. runs on a multi-user machine where users cannot
          trust each other, then a malicious user could arrange to run
          essentially arbitrary code in a victim user’s process, simply
          by connecting to the victim’s *note listen(): 866. socket and
          sending a configuration which runs whatever code the attacker
          wants to have executed in the victim’s process.  This is
          especially easy to do if the default port is used, but not
          hard even if a different port is used).  To avoid the risk of
          this happening, use the ‘verify’ argument to *note listen():
          866. to prevent unrecognised configurations from being
          applied.

     Changed in version 3.4: The ‘verify’ argument was added.

          Note: If you want to send configurations to the listener which
          don’t disable existing loggers, you will need to use a JSON
          format for the configuration, which will use *note
          dictConfig(): b1e. for configuration.  This method allows you
          to specify ‘disable_existing_loggers’ as ‘False’ in the
          configuration you send.

 -- Function: logging.config.stopListening ()

     Stops the listening server which was created with a call to *note
     listen(): 866.  This is typically called before calling ‘join()’ on
     the return value from *note listen(): 866.


File: python.info,  Node: Configuration dictionary schema,  Next: Configuration file format,  Prev: Configuration functions,  Up: logging config — Logging configuration

5.16.7.2 Configuration dictionary schema
........................................

Describing a logging configuration requires listing the various objects
to create and the connections between them; for example, you may create
a handler named ‘console’ and then say that the logger named ‘startup’
will send its messages to the ‘console’ handler.  These objects aren’t
limited to those provided by the *note logging: aa. module because you
might write your own formatter or handler class.  The parameters to
these classes may also need to include external objects such as
‘sys.stderr’.  The syntax for describing these objects and connections
is defined in *note Object connections: 2018. below.

* Menu:

* Dictionary Schema Details::
* Incremental Configuration::
* Object connections::
* User-defined objects::
* Access to external objects::
* Access to internal objects::
* Import resolution and custom importers::


File: python.info,  Node: Dictionary Schema Details,  Next: Incremental Configuration,  Up: Configuration dictionary schema

5.16.7.3 Dictionary Schema Details
..................................

The dictionary passed to *note dictConfig(): b1e. must contain the
following keys:

   * `version' - to be set to an integer value representing the schema
     version.  The only valid value at present is 1, but having this key
     allows the schema to evolve while still preserving backwards
     compatibility.

All other keys are optional, but if present they will be interpreted as
described below.  In all cases below where a ‘configuring dict’ is
mentioned, it will be checked for the special ‘'()'’ key to see if a
custom instantiation is required.  If so, the mechanism described in
*note User-defined objects: 201a. below is used to create an instance;
otherwise, the context is used to determine what to instantiate.

   * `formatters' - the corresponding value will be a dict in which each
     key is a formatter id and each value is a dict describing how to
     configure the corresponding *note Formatter: 1fc4. instance.

     The configuring dict is searched for keys ‘format’ and ‘datefmt’
     (with defaults of ‘None’) and these are used to construct a *note
     Formatter: 1fc4. instance.

     Changed in version 3.8: a ‘validate’ key (with default of ‘True’)
     can be added into the ‘formatters’ section of the configuring dict,
     this is to validate the format.

   * `filters' - the corresponding value will be a dict in which each
     key is a filter id and each value is a dict describing how to
     configure the corresponding Filter instance.

     The configuring dict is searched for the key ‘name’ (defaulting to
     the empty string) and this is used to construct a *note
     logging.Filter: b6a. instance.

   * `handlers' - the corresponding value will be a dict in which each
     key is a handler id and each value is a dict describing how to
     configure the corresponding Handler instance.

     The configuring dict is searched for the following keys:

        * ‘class’ (mandatory).  This is the fully qualified name of the
          handler class.

        * ‘level’ (optional).  The level of the handler.

        * ‘formatter’ (optional).  The id of the formatter for this
          handler.

        * ‘filters’ (optional).  A list of ids of the filters for this
          handler.

     All `other' keys are passed through as keyword arguments to the
     handler’s constructor.  For example, given the snippet:

          handlers:   console:     class : logging.StreamHandler     formatter: brief     level   : INFO     filters: [allow_foo]     stream  : ext://sys.stdout   file:     class : logging.handlers.RotatingFileHandler     formatter: precise     filename: logconfig.log     maxBytes: 1024     backupCount: 3

     the handler with id ‘console’ is instantiated as a *note
     logging.StreamHandler: b68, using ‘sys.stdout’ as the underlying
     stream.  The handler with id ‘file’ is instantiated as a *note
     logging.handlers.RotatingFileHandler: 201b. with the keyword
     arguments ‘filename='logconfig.log', maxBytes=1024, backupCount=3’.

   * `loggers' - the corresponding value will be a dict in which each
     key is a logger name and each value is a dict describing how to
     configure the corresponding Logger instance.

     The configuring dict is searched for the following keys:

        * ‘level’ (optional).  The level of the logger.

        * ‘propagate’ (optional).  The propagation setting of the
          logger.

        * ‘filters’ (optional).  A list of ids of the filters for this
          logger.

        * ‘handlers’ (optional).  A list of ids of the handlers for this
          logger.

     The specified loggers will be configured according to the level,
     propagation, filters and handlers specified.

   * `root' - this will be the configuration for the root logger.
     Processing of the configuration will be as for any logger, except
     that the ‘propagate’ setting will not be applicable.

   * `incremental' - whether the configuration is to be interpreted as
     incremental to the existing configuration.  This value defaults to
     ‘False’, which means that the specified configuration replaces the
     existing configuration with the same semantics as used by the
     existing *note fileConfig(): 39e. API.

     If the specified value is ‘True’, the configuration is processed as
     described in the section on *note Incremental Configuration: 201c.

   * `disable_existing_loggers' - whether any existing non-root loggers
     are to be disabled.  This setting mirrors the parameter of the same
     name in *note fileConfig(): 39e.  If absent, this parameter
     defaults to ‘True’.  This value is ignored if `incremental' is
     ‘True’.


File: python.info,  Node: Incremental Configuration,  Next: Object connections,  Prev: Dictionary Schema Details,  Up: Configuration dictionary schema

5.16.7.4 Incremental Configuration
..................................

It is difficult to provide complete flexibility for incremental
configuration.  For example, because objects such as filters and
formatters are anonymous, once a configuration is set up, it is not
possible to refer to such anonymous objects when augmenting a
configuration.

Furthermore, there is not a compelling case for arbitrarily altering the
object graph of loggers, handlers, filters, formatters at run-time, once
a configuration is set up; the verbosity of loggers and handlers can be
controlled just by setting levels (and, in the case of loggers,
propagation flags).  Changing the object graph arbitrarily in a safe way
is problematic in a multi-threaded environment; while not impossible,
the benefits are not worth the complexity it adds to the implementation.

Thus, when the ‘incremental’ key of a configuration dict is present and
is ‘True’, the system will completely ignore any ‘formatters’ and
‘filters’ entries, and process only the ‘level’ settings in the
‘handlers’ entries, and the ‘level’ and ‘propagate’ settings in the
‘loggers’ and ‘root’ entries.

Using a value in the configuration dict lets configurations to be sent
over the wire as pickled dicts to a socket listener.  Thus, the logging
verbosity of a long-running application can be altered over time with no
need to stop and restart the application.


File: python.info,  Node: Object connections,  Next: User-defined objects,  Prev: Incremental Configuration,  Up: Configuration dictionary schema

5.16.7.5 Object connections
...........................

The schema describes a set of logging objects - loggers, handlers,
formatters, filters - which are connected to each other in an object
graph.  Thus, the schema needs to represent connections between the
objects.  For example, say that, once configured, a particular logger
has attached to it a particular handler.  For the purposes of this
discussion, we can say that the logger represents the source, and the
handler the destination, of a connection between the two.  Of course in
the configured objects this is represented by the logger holding a
reference to the handler.  In the configuration dict, this is done by
giving each destination object an id which identifies it unambiguously,
and then using the id in the source object’s configuration to indicate
that a connection exists between the source and the destination object
with that id.

So, for example, consider the following YAML snippet:

     formatters:   brief:     # configuration for formatter with id 'brief' goes here   precise:     # configuration for formatter with id 'precise' goes here handlers:   h1: #This is an id    # configuration of handler with id 'h1' goes here    formatter: brief   h2: #This is another id    # configuration of handler with id 'h2' goes here    formatter: precise loggers:   foo.bar.baz:     # other configuration for logger 'foo.bar.baz'     handlers: [h1, h2]

(Note: YAML used here because it’s a little more readable than the
equivalent Python source form for the dictionary.)

The ids for loggers are the logger names which would be used
programmatically to obtain a reference to those loggers, e.g.
‘foo.bar.baz’.  The ids for Formatters and Filters can be any string
value (such as ‘brief’, ‘precise’ above) and they are transient, in that
they are only meaningful for processing the configuration dictionary and
used to determine connections between objects, and are not persisted
anywhere when the configuration call is complete.

The above snippet indicates that logger named ‘foo.bar.baz’ should have
two handlers attached to it, which are described by the handler ids ‘h1’
and ‘h2’.  The formatter for ‘h1’ is that described by id ‘brief’, and
the formatter for ‘h2’ is that described by id ‘precise’.


File: python.info,  Node: User-defined objects,  Next: Access to external objects,  Prev: Object connections,  Up: Configuration dictionary schema

5.16.7.6 User-defined objects
.............................

The schema supports user-defined objects for handlers, filters and
formatters.  (Loggers do not need to have different types for different
instances, so there is no support in this configuration schema for
user-defined logger classes.)

Objects to be configured are described by dictionaries which detail
their configuration.  In some places, the logging system will be able to
infer from the context how an object is to be instantiated, but when a
user-defined object is to be instantiated, the system will not know how
to do this.  In order to provide complete flexibility for user-defined
object instantiation, the user needs to provide a ‘factory’ - a callable
which is called with a configuration dictionary and which returns the
instantiated object.  This is signalled by an absolute import path to
the factory being made available under the special key ‘'()'’.  Here’s a
concrete example:

     formatters:   brief:     format: '%(message)s'   default:     format: '%(asctime)s %(levelname)-8s %(name)-15s %(message)s'     datefmt: '%Y-%m-%d %H:%M:%S'   custom:       (): my.package.customFormatterFactory       bar: baz       spam: 99.9       answer: 42

The above YAML snippet defines three formatters.  The first, with id
‘brief’, is a standard *note logging.Formatter: 1fc4. instance with the
specified format string.  The second, with id ‘default’, has a longer
format and also defines the time format explicitly, and will result in a
*note logging.Formatter: 1fc4. initialized with those two format
strings.  Shown in Python source form, the ‘brief’ and ‘default’
formatters have configuration sub-dictionaries:

     {   'format' : '%(message)s' }

and:

     {   'format' : '%(asctime)s %(levelname)-8s %(name)-15s %(message)s',   'datefmt' : '%Y-%m-%d %H:%M:%S' }

respectively, and as these dictionaries do not contain the special key
‘'()'’, the instantiation is inferred from the context: as a result,
standard *note logging.Formatter: 1fc4. instances are created.  The
configuration sub-dictionary for the third formatter, with id ‘custom’,
is:

     {   '()' : 'my.package.customFormatterFactory',   'bar' : 'baz',   'spam' : 99.9,   'answer' : 42 }

and this contains the special key ‘'()'’, which means that user-defined
instantiation is wanted.  In this case, the specified factory callable
will be used.  If it is an actual callable it will be used directly -
otherwise, if you specify a string (as in the example) the actual
callable will be located using normal import mechanisms.  The callable
will be called with the `remaining' items in the configuration
sub-dictionary as keyword arguments.  In the above example, the
formatter with id ‘custom’ will be assumed to be returned by the call:

     my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)

The key ‘'()'’ has been used as the special key because it is not a
valid keyword parameter name, and so will not clash with the names of
the keyword arguments used in the call.  The ‘'()'’ also serves as a
mnemonic that the corresponding value is a callable.


File: python.info,  Node: Access to external objects,  Next: Access to internal objects,  Prev: User-defined objects,  Up: Configuration dictionary schema

5.16.7.7 Access to external objects
...................................

There are times where a configuration needs to refer to objects external
to the configuration, for example ‘sys.stderr’.  If the configuration
dict is constructed using Python code, this is straightforward, but a
problem arises when the configuration is provided via a text file (e.g.
JSON, YAML). In a text file, there is no standard way to distinguish
‘sys.stderr’ from the literal string ‘'sys.stderr'’.  To facilitate this
distinction, the configuration system looks for certain special prefixes
in string values and treat them specially.  For example, if the literal
string ‘'ext://sys.stderr'’ is provided as a value in the configuration,
then the ‘ext://’ will be stripped off and the remainder of the value
processed using normal import mechanisms.

The handling of such prefixes is done in a way analogous to protocol
handling: there is a generic mechanism to look for prefixes which match
the regular expression ‘^(?P<prefix>[a-z]+)://(?P<suffix>.*)$’ whereby,
if the ‘prefix’ is recognised, the ‘suffix’ is processed in a
prefix-dependent manner and the result of the processing replaces the
string value.  If the prefix is not recognised, then the string value
will be left as-is.


File: python.info,  Node: Access to internal objects,  Next: Import resolution and custom importers,  Prev: Access to external objects,  Up: Configuration dictionary schema

5.16.7.8 Access to internal objects
...................................

As well as external objects, there is sometimes also a need to refer to
objects in the configuration.  This will be done implicitly by the
configuration system for things that it knows about.  For example, the
string value ‘'DEBUG'’ for a ‘level’ in a logger or handler will
automatically be converted to the value ‘logging.DEBUG’, and the
‘handlers’, ‘filters’ and ‘formatter’ entries will take an object id and
resolve to the appropriate destination object.

However, a more generic mechanism is needed for user-defined objects
which are not known to the *note logging: aa. module.  For example,
consider *note logging.handlers.MemoryHandler: 2024, which takes a
‘target’ argument which is another handler to delegate to.  Since the
system already knows about this class, then in the configuration, the
given ‘target’ just needs to be the object id of the relevant target
handler, and the system will resolve to the handler from the id.  If,
however, a user defines a ‘my.package.MyHandler’ which has an
‘alternate’ handler, the configuration system would not know that the
‘alternate’ referred to a handler.  To cater for this, a generic
resolution system allows the user to specify:

     handlers:   file:     # configuration of file handler goes here    custom:     (): my.package.MyHandler     alternate: cfg://handlers.file

The literal string ‘'cfg://handlers.file'’ will be resolved in an
analogous way to strings with the ‘ext://’ prefix, but looking in the
configuration itself rather than the import namespace.  The mechanism
allows access by dot or by index, in a similar way to that provided by
‘str.format’.  Thus, given the following snippet:

     handlers:   email:     class: logging.handlers.SMTPHandler     mailhost: localhost     fromaddr: my_app@domain.tld     toaddrs:       - support_team@domain.tld       - dev_team@domain.tld     subject: Houston, we have a problem.

in the configuration, the string ‘'cfg://handlers'’ would resolve to the
dict with key ‘handlers’, the string ‘'cfg://handlers.email’ would
resolve to the dict with key ‘email’ in the ‘handlers’ dict, and so on.
The string ‘'cfg://handlers.email.toaddrs[1]’ would resolve to
‘'dev_team.domain.tld'’ and the string
‘'cfg://handlers.email.toaddrs[0]'’ would resolve to the value
‘'support_team@domain.tld'’.  The ‘subject’ value could be accessed
using either ‘'cfg://handlers.email.subject'’ or, equivalently,
‘'cfg://handlers.email[subject]'’.  The latter form only needs to be
used if the key contains spaces or non-alphanumeric characters.  If an
index value consists only of decimal digits, access will be attempted
using the corresponding integer value, falling back to the string value
if needed.

Given a string ‘cfg://handlers.myhandler.mykey.123’, this will resolve
to ‘config_dict['handlers']['myhandler']['mykey']['123']’.  If the
string is specified as ‘cfg://handlers.myhandler.mykey[123]’, the system
will attempt to retrieve the value from
‘config_dict['handlers']['myhandler']['mykey'][123]’, and fall back to
‘config_dict['handlers']['myhandler']['mykey']['123']’ if that fails.


File: python.info,  Node: Import resolution and custom importers,  Prev: Access to internal objects,  Up: Configuration dictionary schema

5.16.7.9 Import resolution and custom importers
...............................................

Import resolution, by default, uses the builtin *note __import__(): 605.
function to do its importing.  You may want to replace this with your
own importing mechanism: if so, you can replace the ‘importer’ attribute
of the ‘DictConfigurator’ or its superclass, the ‘BaseConfigurator’
class.  However, you need to be careful because of the way functions are
accessed from classes via descriptors.  If you are using a Python
callable to do your imports, and you want to define it at class level
rather than instance level, you need to wrap it with *note
staticmethod(): 1d7.  For example:

     from importlib import import_module from logging.config import BaseConfigurator  BaseConfigurator.importer = staticmethod(import_module)

You don’t need to wrap with *note staticmethod(): 1d7. if you’re setting
the import callable on a configurator `instance'.


File: python.info,  Node: Configuration file format,  Prev: Configuration dictionary schema,  Up: logging config — Logging configuration

5.16.7.10 Configuration file format
...................................

The configuration file format understood by *note fileConfig(): 39e. is
based on *note configparser: 23. functionality.  The file must contain
sections called ‘[loggers]’, ‘[handlers]’ and ‘[formatters]’ which
identify by name the entities of each type which are defined in the
file.  For each such entity, there is a separate section which
identifies how that entity is configured.  Thus, for a logger named
‘log01’ in the ‘[loggers]’ section, the relevant configuration details
are held in a section ‘[logger_log01]’.  Similarly, a handler called
‘hand01’ in the ‘[handlers]’ section will have its configuration held in
a section called ‘[handler_hand01]’, while a formatter called ‘form01’
in the ‘[formatters]’ section will have its configuration specified in a
section called ‘[formatter_form01]’.  The root logger configuration must
be specified in a section called ‘[logger_root]’.

     Note: The *note fileConfig(): 39e. API is older than the *note
     dictConfig(): b1e. API and does not provide functionality to cover
     certain aspects of logging.  For example, you cannot configure
     *note Filter: b6a. objects, which provide for filtering of messages
     beyond simple integer levels, using *note fileConfig(): 39e.  If
     you need to have instances of *note Filter: b6a. in your logging
     configuration, you will need to use *note dictConfig(): b1e.  Note
     that future enhancements to configuration functionality will be
     added to *note dictConfig(): b1e, so it’s worth considering
     transitioning to this newer API when it’s convenient to do so.

Examples of these sections in the file are given below.

     [loggers] keys=root,log02,log03,log04,log05,log06,log07  [handlers] keys=hand01,hand02,hand03,hand04,hand05,hand06,hand07,hand08,hand09  [formatters] keys=form01,form02,form03,form04,form05,form06,form07,form08,form09

The root logger must specify a level and a list of handlers.  An example
of a root logger section is given below.

     [logger_root] level=NOTSET handlers=hand01

The ‘level’ entry can be one of ‘DEBUG, INFO, WARNING, ERROR, CRITICAL’
or ‘NOTSET’.  For the root logger only, ‘NOTSET’ means that all messages
will be logged.  Level values are *note eval(): b83.uated in the context
of the ‘logging’ package’s namespace.

The ‘handlers’ entry is a comma-separated list of handler names, which
must appear in the ‘[handlers]’ section.  These names must appear in the
‘[handlers]’ section and have corresponding sections in the
configuration file.

For loggers other than the root logger, some additional information is
required.  This is illustrated by the following example.

     [logger_parser] level=DEBUG handlers=hand01 propagate=1 qualname=compiler.parser

The ‘level’ and ‘handlers’ entries are interpreted as for the root
logger, except that if a non-root logger’s level is specified as
‘NOTSET’, the system consults loggers higher up the hierarchy to
determine the effective level of the logger.  The ‘propagate’ entry is
set to 1 to indicate that messages must propagate to handlers higher up
the logger hierarchy from this logger, or 0 to indicate that messages
are `not' propagated to handlers up the hierarchy.  The ‘qualname’ entry
is the hierarchical channel name of the logger, that is to say the name
used by the application to get the logger.

Sections which specify handler configuration are exemplified by the
following.

     [handler_hand01] class=StreamHandler level=NOTSET formatter=form01 args=(sys.stdout,)

The ‘class’ entry indicates the handler’s class (as determined by *note
eval(): b83. in the ‘logging’ package’s namespace).  The ‘level’ is
interpreted as for loggers, and ‘NOTSET’ is taken to mean ‘log
everything’.

The ‘formatter’ entry indicates the key name of the formatter for this
handler.  If blank, a default formatter (‘logging._defaultFormatter’) is
used.  If a name is specified, it must appear in the ‘[formatters]’
section and have a corresponding section in the configuration file.

The ‘args’ entry, when *note eval(): b83.uated in the context of the
‘logging’ package’s namespace, is the list of arguments to the
constructor for the handler class.  Refer to the constructors for the
relevant handlers, or to the examples below, to see how typical entries
are constructed.  If not provided, it defaults to ‘()’.

The optional ‘kwargs’ entry, when *note eval(): b83.uated in the context
of the ‘logging’ package’s namespace, is the keyword argument dict to
the constructor for the handler class.  If not provided, it defaults to
‘{}’.

     [handler_hand02] class=FileHandler level=DEBUG formatter=form02 args=('python.log', 'w')  [handler_hand03] class=handlers.SocketHandler level=INFO formatter=form03 args=('localhost', handlers.DEFAULT_TCP_LOGGING_PORT)  [handler_hand04] class=handlers.DatagramHandler level=WARN formatter=form04 args=('localhost', handlers.DEFAULT_UDP_LOGGING_PORT)  [handler_hand05] class=handlers.SysLogHandler level=ERROR formatter=form05 args=(('localhost', handlers.SYSLOG_UDP_PORT), handlers.SysLogHandler.LOG_USER)  [handler_hand06] class=handlers.NTEventLogHandler level=CRITICAL formatter=form06 args=('Python Application', '', 'Application')  [handler_hand07] class=handlers.SMTPHandler level=WARN formatter=form07 args=('localhost', 'from@abc', ['user1@abc', 'user2@xyz'], 'Logger Subject') kwargs={'timeout': 10.0}  [handler_hand08] class=handlers.MemoryHandler level=NOTSET formatter=form08 target= args=(10, ERROR)  [handler_hand09] class=handlers.HTTPHandler level=NOTSET formatter=form09 args=('localhost:9022', '/log', 'GET') kwargs={'secure': True}

Sections which specify formatter configuration are typified by the
following.

     [formatter_form01] format=F1 %(asctime)s %(levelname)s %(message)s datefmt= class=logging.Formatter

The ‘format’ entry is the overall format string, and the ‘datefmt’ entry
is the ‘strftime()’-compatible date/time format string.  If empty, the
package substitutes something which is almost equivalent to specifying
the date format string ‘'%Y-%m-%d %H:%M:%S'’.  This format also
specifies milliseconds, which are appended to the result of using the
above format string, with a comma separator.  An example time in this
format is ‘2003-01-23 00:29:50,411’.

The ‘class’ entry is optional.  It indicates the name of the formatter’s
class (as a dotted module and class name.)  This option is useful for
instantiating a *note Formatter: 1fc4. subclass.  Subclasses of *note
Formatter: 1fc4. can present exception tracebacks in an expanded or
condensed format.

     Note: Due to the use of *note eval(): b83. as described above,
     there are potential security risks which result from using the
     *note listen(): 866. to send and receive configurations via
     sockets.  The risks are limited to where multiple users with no
     mutual trust run code on the same machine; see the *note listen():
     866. documentation for more information.

See also
........

Module *note logging: aa.

     API reference for the logging module.

Module *note logging.handlers: ac.

     Useful handlers included with the logging module.


File: python.info,  Node: logging handlers — Logging handlers,  Next: getpass — Portable password input,  Prev: logging config — Logging configuration,  Up: Generic Operating System Services

5.16.8 ‘logging.handlers’ — Logging handlers
--------------------------------------------

`Source code:' Lib/logging/handlers.py(1)

Important
.........

This page contains only reference information.  For tutorials, please
see

   * *note Basic Tutorial: b65.

   * *note Advanced Tutorial: b66.

   * *note Logging Cookbook: b67.

__________________________________________________________________

The following useful handlers are provided in the package.  Note that
three of the handlers (*note StreamHandler: b68, *note FileHandler:
202a. and *note NullHandler: c0f.) are actually defined in the *note
logging: aa. module itself, but have been documented here along with the
other handlers.

* Menu:

* StreamHandler::
* FileHandler::
* NullHandler::
* WatchedFileHandler::
* BaseRotatingHandler::
* RotatingFileHandler::
* TimedRotatingFileHandler::
* SocketHandler::
* DatagramHandler::
* SysLogHandler::
* NTEventLogHandler::
* SMTPHandler::
* MemoryHandler::
* HTTPHandler::
* QueueHandler::
* QueueListener::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/logging/handlers.py


File: python.info,  Node: StreamHandler,  Next: FileHandler,  Up: logging handlers — Logging handlers

5.16.8.1 StreamHandler
......................

The *note StreamHandler: b68. class, located in the core *note logging:
aa. package, sends logging output to streams such as `sys.stdout',
`sys.stderr' or any file-like object (or, more precisely, any object
which supports ‘write()’ and ‘flush()’ methods).

 -- Class: logging.StreamHandler (stream=None)

     Returns a new instance of the *note StreamHandler: b68. class.  If
     `stream' is specified, the instance will use it for logging output;
     otherwise, `sys.stderr' will be used.

      -- Method: emit (record)

          If a formatter is specified, it is used to format the record.
          The record is then written to the stream with a terminator.
          If exception information is present, it is formatted using
          *note traceback.print_exception(): 1fee. and appended to the
          stream.

      -- Method: flush ()

          Flushes the stream by calling its *note flush(): 202e. method.
          Note that the ‘close()’ method is inherited from *note
          Handler: 1fc5. and so does no output, so an explicit *note
          flush(): 202e. call may be needed at times.

      -- Method: setStream (stream)

          Sets the instance’s stream to the specified value, if it is
          different.  The old stream is flushed before the new stream is
          set.


          Parameters: ‘stream’ – The stream that the handler should use.


          Returns: the old stream, if the stream was changed, or `None'
          if it wasn’t.

     New in version 3.7.

Changed in version 3.2: The ‘StreamHandler’ class now has a ‘terminator’
attribute, default value ‘'\n'’, which is used as the terminator when
writing a formatted record to a stream.  If you don’t want this newline
termination, you can set the handler instance’s ‘terminator’ attribute
to the empty string.  In earlier versions, the terminator was hardcoded
as ‘'\n'’.


File: python.info,  Node: FileHandler,  Next: NullHandler,  Prev: StreamHandler,  Up: logging handlers — Logging handlers

5.16.8.2 FileHandler
....................

The *note FileHandler: 202a. class, located in the core *note logging:
aa. package, sends logging output to a disk file.  It inherits the
output functionality from *note StreamHandler: b68.

 -- Class: logging.FileHandler (filename, mode='a', encoding=None,
          delay=False)

     Returns a new instance of the *note FileHandler: 202a. class.  The
     specified file is opened and used as the stream for logging.  If
     `mode' is not specified, ‘'a'’ is used.  If `encoding' is not
     ‘None’, it is used to open the file with that encoding.  If `delay'
     is true, then file opening is deferred until the first call to
     *note emit(): 2031.  By default, the file grows indefinitely.

     Changed in version 3.6: As well as string values, *note Path: 1ff.
     objects are also accepted for the `filename' argument.

      -- Method: close ()

          Closes the file.

      -- Method: emit (record)

          Outputs the record to the file.


File: python.info,  Node: NullHandler,  Next: WatchedFileHandler,  Prev: FileHandler,  Up: logging handlers — Logging handlers

5.16.8.3 NullHandler
....................

New in version 3.1.

The *note NullHandler: c0f. class, located in the core *note logging:
aa. package, does not do any formatting or output.  It is essentially a
‘no-op’ handler for use by library developers.

 -- Class: logging.NullHandler

     Returns a new instance of the *note NullHandler: c0f. class.

      -- Method: emit (record)

          This method does nothing.

      -- Method: handle (record)

          This method does nothing.

      -- Method: createLock ()

          This method returns ‘None’ for the lock, since there is no
          underlying I/O to which access needs to be serialized.

See *note Configuring Logging for a Library: 2038. for more information
on how to use *note NullHandler: c0f.


File: python.info,  Node: WatchedFileHandler,  Next: BaseRotatingHandler,  Prev: NullHandler,  Up: logging handlers — Logging handlers

5.16.8.4 WatchedFileHandler
...........................

The *note WatchedFileHandler: 203b. class, located in the *note
logging.handlers: ac. module, is a ‘FileHandler’ which watches the file
it is logging to.  If the file changes, it is closed and reopened using
the file name.

A file change can happen because of usage of programs such as
`newsyslog' and `logrotate' which perform log file rotation.  This
handler, intended for use under Unix/Linux, watches the file to see if
it has changed since the last emit.  (A file is deemed to have changed
if its device or inode have changed.)  If the file has changed, the old
file stream is closed, and the file opened to get a new stream.

This handler is not appropriate for use under Windows, because under
Windows open log files cannot be moved or renamed - logging opens the
files with exclusive locks - and so there is no need for such a handler.
Furthermore, `ST_INO' is not supported under Windows; *note stat(): 1ef.
always returns zero for this value.

 -- Class: logging.handlers.WatchedFileHandler (filename, mode='a',
          encoding=None, delay=False)

     Returns a new instance of the *note WatchedFileHandler: 203b.
     class.  The specified file is opened and used as the stream for
     logging.  If `mode' is not specified, ‘'a'’ is used.  If `encoding'
     is not ‘None’, it is used to open the file with that encoding.  If
     `delay' is true, then file opening is deferred until the first call
     to *note emit(): 203c.  By default, the file grows indefinitely.

     Changed in version 3.6: As well as string values, *note Path: 1ff.
     objects are also accepted for the `filename' argument.

      -- Method: reopenIfNeeded ()

          Checks to see if the file has changed.  If it has, the
          existing stream is flushed and closed and the file opened
          again, typically as a precursor to outputting the record to
          the file.

          New in version 3.6.

      -- Method: emit (record)

          Outputs the record to the file, but first calls *note
          reopenIfNeeded(): 557. to reopen the file if it has changed.


File: python.info,  Node: BaseRotatingHandler,  Next: RotatingFileHandler,  Prev: WatchedFileHandler,  Up: logging handlers — Logging handlers

5.16.8.5 BaseRotatingHandler
............................

The *note BaseRotatingHandler: 203f. class, located in the *note
logging.handlers: ac. module, is the base class for the rotating file
handlers, *note RotatingFileHandler: 201b. and *note
TimedRotatingFileHandler: 862.  You should not need to instantiate this
class, but it has attributes and methods you may need to override.

 -- Class: logging.handlers.BaseRotatingHandler (filename, mode,
          encoding=None, delay=False)

     The parameters are as for ‘FileHandler’.  The attributes are:

      -- Attribute: namer

          If this attribute is set to a callable, the *note
          rotation_filename(): 2041. method delegates to this callable.
          The parameters passed to the callable are those passed to
          *note rotation_filename(): 2041.

               Note: The namer function is called quite a few times
               during rollover, so it should be as simple and as fast as
               possible.  It should also return the same output every
               time for a given input, otherwise the rollover behaviour
               may not work as expected.

          New in version 3.3.

      -- Attribute: rotator

          If this attribute is set to a callable, the *note rotate():
          2043. method delegates to this callable.  The parameters
          passed to the callable are those passed to *note rotate():
          2043.

          New in version 3.3.

      -- Method: rotation_filename (default_name)

          Modify the filename of a log file when rotating.

          This is provided so that a custom filename can be provided.

          The default implementation calls the ‘namer’ attribute of the
          handler, if it’s callable, passing the default name to it.  If
          the attribute isn’t callable (the default is ‘None’), the name
          is returned unchanged.


          Parameters: ‘default_name’ – The default name for the log
          file.

          New in version 3.3.

      -- Method: rotate (source, dest)

          When rotating, rotate the current log.

          The default implementation calls the ‘rotator’ attribute of
          the handler, if it’s callable, passing the source and dest
          arguments to it.  If the attribute isn’t callable (the default
          is ‘None’), the source is simply renamed to the destination.


          Parameters:

             * ‘source’ – The source filename.  This is normally the
               base filename, e.g.  ‘test.log’.

             * ‘dest’ – The destination filename.  This is normally what
               the source is rotated to, e.g.  ‘test.log.1’.

          New in version 3.3.

The reason the attributes exist is to save you having to subclass - you
can use the same callables for instances of *note RotatingFileHandler:
201b. and *note TimedRotatingFileHandler: 862.  If either the namer or
rotator callable raises an exception, this will be handled in the same
way as any other exception during an ‘emit()’ call, i.e.  via the
‘handleError()’ method of the handler.

If you need to make more significant changes to rotation processing, you
can override the methods.

For an example, see *note Using a rotator and namer to customize log
rotation processing: 2044.


File: python.info,  Node: RotatingFileHandler,  Next: TimedRotatingFileHandler,  Prev: BaseRotatingHandler,  Up: logging handlers — Logging handlers

5.16.8.6 RotatingFileHandler
............................

The *note RotatingFileHandler: 201b. class, located in the *note
logging.handlers: ac. module, supports rotation of disk log files.

 -- Class: logging.handlers.RotatingFileHandler (filename, mode='a',
          maxBytes=0, backupCount=0, encoding=None, delay=False)

     Returns a new instance of the *note RotatingFileHandler: 201b.
     class.  The specified file is opened and used as the stream for
     logging.  If `mode' is not specified, ‘'a'’ is used.  If `encoding'
     is not ‘None’, it is used to open the file with that encoding.  If
     `delay' is true, then file opening is deferred until the first call
     to *note emit(): 2047.  By default, the file grows indefinitely.

     You can use the `maxBytes' and `backupCount' values to allow the
     file to `rollover' at a predetermined size.  When the size is about
     to be exceeded, the file is closed and a new file is silently
     opened for output.  Rollover occurs whenever the current log file
     is nearly `maxBytes' in length; but if either of `maxBytes' or
     `backupCount' is zero, rollover never occurs, so you generally want
     to set `backupCount' to at least 1, and have a non-zero `maxBytes'.
     When `backupCount' is non-zero, the system will save old log files
     by appending the extensions ‘.1’, ‘.2’ etc., to the filename.  For
     example, with a `backupCount' of 5 and a base file name of
     ‘app.log’, you would get ‘app.log’, ‘app.log.1’, ‘app.log.2’, up to
     ‘app.log.5’.  The file being written to is always ‘app.log’.  When
     this file is filled, it is closed and renamed to ‘app.log.1’, and
     if files ‘app.log.1’, ‘app.log.2’, etc.  exist, then they are
     renamed to ‘app.log.2’, ‘app.log.3’ etc.  respectively.

     Changed in version 3.6: As well as string values, *note Path: 1ff.
     objects are also accepted for the `filename' argument.

      -- Method: doRollover ()

          Does a rollover, as described above.

      -- Method: emit (record)

          Outputs the record to the file, catering for rollover as
          described previously.


File: python.info,  Node: TimedRotatingFileHandler,  Next: SocketHandler,  Prev: RotatingFileHandler,  Up: logging handlers — Logging handlers

5.16.8.7 TimedRotatingFileHandler
.................................

The *note TimedRotatingFileHandler: 862. class, located in the *note
logging.handlers: ac. module, supports rotation of disk log files at
certain timed intervals.

 -- Class: logging.handlers.TimedRotatingFileHandler (filename,
          when='h', interval=1, backupCount=0, encoding=None,
          delay=False, utc=False, atTime=None)

     Returns a new instance of the *note TimedRotatingFileHandler: 862.
     class.  The specified file is opened and used as the stream for
     logging.  On rotating it also sets the filename suffix.  Rotating
     happens based on the product of `when' and `interval'.

     You can use the `when' to specify the type of `interval'.  The list
     of possible values is below.  Note that they are not case
     sensitive.

     Value                Type of interval                 If/how `atTime' is used
                                                           
     ------------------------------------------------------------------------------------
                                                           
     ‘'S'’                Seconds                          Ignored
                                                           
                                                           
     ‘'M'’                Minutes                          Ignored
                                                           
                                                           
     ‘'H'’                Hours                            Ignored
                                                           
                                                           
     ‘'D'’                Days                             Ignored
                                                           
                                                           
     ‘'W0'-'W6'’          Weekday (0=Monday)               Used to compute initial
                                                           rollover time
                                                           
                                                           
     ‘'midnight'’         Roll over at midnight, if        Used to compute initial
                          `atTime' not specified, else     rollover time
                          at time `atTime'                 
                          

     When using weekday-based rotation, specify ‘W0’ for Monday, ‘W1’
     for Tuesday, and so on up to ‘W6’ for Sunday.  In this case, the
     value passed for `interval' isn’t used.

     The system will save old log files by appending extensions to the
     filename.  The extensions are date-and-time based, using the
     strftime format ‘%Y-%m-%d_%H-%M-%S’ or a leading portion thereof,
     depending on the rollover interval.

     When computing the next rollover time for the first time (when the
     handler is created), the last modification time of an existing log
     file, or else the current time, is used to compute when the next
     rotation will occur.

     If the `utc' argument is true, times in UTC will be used; otherwise
     local time is used.

     If `backupCount' is nonzero, at most `backupCount' files will be
     kept, and if more would be created when rollover occurs, the oldest
     one is deleted.  The deletion logic uses the interval to determine
     which files to delete, so changing the interval may leave old files
     lying around.

     If `delay' is true, then file opening is deferred until the first
     call to *note emit(): 204b.

     If `atTime' is not ‘None’, it must be a ‘datetime.time’ instance
     which specifies the time of day when rollover occurs, for the cases
     where rollover is set to happen “at midnight” or “on a particular
     weekday”.  Note that in these cases, the `atTime' value is
     effectively used to compute the `initial' rollover, and subsequent
     rollovers would be calculated via the normal interval calculation.

          Note: Calculation of the initial rollover time is done when
          the handler is initialised.  Calculation of subsequent
          rollover times is done only when rollover occurs, and rollover
          occurs only when emitting output.  If this is not kept in
          mind, it might lead to some confusion.  For example, if an
          interval of “every minute” is set, that does not mean you will
          always see log files with times (in the filename) separated by
          a minute; if, during application execution, logging output is
          generated more frequently than once a minute, `then' you can
          expect to see log files with times separated by a minute.  If,
          on the other hand, logging messages are only output once every
          five minutes (say), then there will be gaps in the file times
          corresponding to the minutes where no output (and hence no
          rollover) occurred.

     Changed in version 3.4: `atTime' parameter was added.

     Changed in version 3.6: As well as string values, *note Path: 1ff.
     objects are also accepted for the `filename' argument.

      -- Method: doRollover ()

          Does a rollover, as described above.

      -- Method: emit (record)

          Outputs the record to the file, catering for rollover as
          described above.


File: python.info,  Node: SocketHandler,  Next: DatagramHandler,  Prev: TimedRotatingFileHandler,  Up: logging handlers — Logging handlers

5.16.8.8 SocketHandler
......................

The *note SocketHandler: 863. class, located in the *note
logging.handlers: ac. module, sends logging output to a network socket.
The base class uses a TCP socket.

 -- Class: logging.handlers.SocketHandler (host, port)

     Returns a new instance of the *note SocketHandler: 863. class
     intended to communicate with a remote machine whose address is
     given by `host' and `port'.

     Changed in version 3.4: If ‘port’ is specified as ‘None’, a Unix
     domain socket is created using the value in ‘host’ - otherwise, a
     TCP socket is created.

      -- Method: close ()

          Closes the socket.

      -- Method: emit ()

          Pickles the record’s attribute dictionary and writes it to the
          socket in binary format.  If there is an error with the
          socket, silently drops the packet.  If the connection was
          previously lost, re-establishes the connection.  To unpickle
          the record at the receiving end into a *note LogRecord: 8fa,
          use the *note makeLogRecord(): 1ff6. function.

      -- Method: handleError ()

          Handles an error which has occurred during *note emit(): 2050.
          The most likely cause is a lost connection.  Closes the socket
          so that we can retry on the next event.

      -- Method: makeSocket ()

          This is a factory method which allows subclasses to define the
          precise type of socket they want.  The default implementation
          creates a TCP socket (*note socket.SOCK_STREAM: c7d.).

      -- Method: makePickle (record)

          Pickles the record’s attribute dictionary in binary format
          with a length prefix, and returns it ready for transmission
          across the socket.  The details of this operation are
          equivalent to:

               data = pickle.dumps(record_attr_dict, 1) datalen = struct.pack('>L', len(data)) return datalen + data

          Note that pickles aren’t completely secure.  If you are
          concerned about security, you may want to override this method
          to implement a more secure mechanism.  For example, you can
          sign pickles using HMAC and then verify them on the receiving
          end, or alternatively you can disable unpickling of global
          objects on the receiving end.

      -- Method: send (packet)

          Send a pickled byte-string `packet' to the socket.  The format
          of the sent byte-string is as described in the documentation
          for *note makePickle(): 2053.

          This function allows for partial sends, which can happen when
          the network is busy.

      -- Method: createSocket ()

          Tries to create a socket; on failure, uses an exponential
          back-off algorithm.  On initial failure, the handler will drop
          the message it was trying to send.  When subsequent messages
          are handled by the same instance, it will not try connecting
          until some time has passed.  The default parameters are such
          that the initial delay is one second, and if after that delay
          the connection still can’t be made, the handler will double
          the delay each time up to a maximum of 30 seconds.

          This behaviour is controlled by the following handler
          attributes:

             * ‘retryStart’ (initial delay, defaulting to 1.0 seconds).

             * ‘retryFactor’ (multiplier, defaulting to 2.0).

             * ‘retryMax’ (maximum delay, defaulting to 30.0 seconds).

          This means that if the remote listener starts up `after' the
          handler has been used, you could lose messages (since the
          handler won’t even attempt a connection until the delay has
          elapsed, but just silently drop messages during the delay
          period).


File: python.info,  Node: DatagramHandler,  Next: SysLogHandler,  Prev: SocketHandler,  Up: logging handlers — Logging handlers

5.16.8.9 DatagramHandler
........................

The *note DatagramHandler: 864. class, located in the *note
logging.handlers: ac. module, inherits from *note SocketHandler: 863. to
support sending logging messages over UDP sockets.

 -- Class: logging.handlers.DatagramHandler (host, port)

     Returns a new instance of the *note DatagramHandler: 864. class
     intended to communicate with a remote machine whose address is
     given by `host' and `port'.

     Changed in version 3.4: If ‘port’ is specified as ‘None’, a Unix
     domain socket is created using the value in ‘host’ - otherwise, a
     UDP socket is created.

      -- Method: emit ()

          Pickles the record’s attribute dictionary and writes it to the
          socket in binary format.  If there is an error with the
          socket, silently drops the packet.  To unpickle the record at
          the receiving end into a *note LogRecord: 8fa, use the *note
          makeLogRecord(): 1ff6. function.

      -- Method: makeSocket ()

          The factory method of *note SocketHandler: 863. is here
          overridden to create a UDP socket (*note socket.SOCK_DGRAM:
          c7c.).

      -- Method: send (s)

          Send a pickled byte-string to a socket.  The format of the
          sent byte-string is as described in the documentation for
          *note SocketHandler.makePickle(): 2053.


File: python.info,  Node: SysLogHandler,  Next: NTEventLogHandler,  Prev: DatagramHandler,  Up: logging handlers — Logging handlers

5.16.8.10 SysLogHandler
.......................

The *note SysLogHandler: a13. class, located in the *note
logging.handlers: ac. module, supports sending logging messages to a
remote or local Unix syslog.

 -- Class: logging.handlers.SysLogHandler (address=('localhost',
          SYSLOG_UDP_PORT), facility=LOG_USER,
          socktype=socket.SOCK_DGRAM)

     Returns a new instance of the *note SysLogHandler: a13. class
     intended to communicate with a remote Unix machine whose address is
     given by `address' in the form of a ‘(host, port)’ tuple.  If
     `address' is not specified, ‘('localhost', 514)’ is used.  The
     address is used to open a socket.  An alternative to providing a
     ‘(host, port)’ tuple is providing an address as a string, for
     example ‘/dev/log’.  In this case, a Unix domain socket is used to
     send the message to the syslog.  If `facility' is not specified,
     ‘LOG_USER’ is used.  The type of socket opened depends on the
     `socktype' argument, which defaults to *note socket.SOCK_DGRAM:
     c7c. and thus opens a UDP socket.  To open a TCP socket (for use
     with the newer syslog daemons such as rsyslog), specify a value of
     *note socket.SOCK_STREAM: c7d.

     Note that if your server is not listening on UDP port 514, *note
     SysLogHandler: a13. may appear not to work.  In that case, check
     what address you should be using for a domain socket - it’s system
     dependent.  For example, on Linux it’s usually ‘/dev/log’ but on
     OS/X it’s ‘/var/run/syslog’.  You’ll need to check your platform
     and use the appropriate address (you may need to do this check at
     runtime if your application needs to run on several platforms).  On
     Windows, you pretty much have to use the UDP option.

     Changed in version 3.2: `socktype' was added.

      -- Method: close ()

          Closes the socket to the remote host.

      -- Method: emit (record)

          The record is formatted, and then sent to the syslog server.
          If exception information is present, it is `not' sent to the
          server.

          Changed in version 3.2.1: (See: bpo-12168(1).)  In earlier
          versions, the message sent to the syslog daemons was always
          terminated with a NUL byte, because early versions of these
          daemons expected a NUL terminated message - even though it’s
          not in the relevant specification ( RFC 5424(2)).  More recent
          versions of these daemons don’t expect the NUL byte but strip
          it off if it’s there, and even more recent daemons (which
          adhere more closely to RFC 5424) pass the NUL byte on as part
          of the message.

          To enable easier handling of syslog messages in the face of
          all these differing daemon behaviours, the appending of the
          NUL byte has been made configurable, through the use of a
          class-level attribute, ‘append_nul’.  This defaults to ‘True’
          (preserving the existing behaviour) but can be set to ‘False’
          on a ‘SysLogHandler’ instance in order for that instance to
          `not' append the NUL terminator.

          Changed in version 3.3: (See: bpo-12419(3).)  In earlier
          versions, there was no facility for an “ident” or “tag” prefix
          to identify the source of the message.  This can now be
          specified using a class-level attribute, defaulting to ‘""’ to
          preserve existing behaviour, but which can be overridden on a
          ‘SysLogHandler’ instance in order for that instance to prepend
          the ident to every message handled.  Note that the provided
          ident must be text, not bytes, and is prepended to the message
          exactly as is.

      -- Method: encodePriority (facility, priority)

          Encodes the facility and priority into an integer.  You can
          pass in strings or integers - if strings are passed, internal
          mapping dictionaries are used to convert them to integers.

          The symbolic ‘LOG_’ values are defined in *note SysLogHandler:
          a13. and mirror the values defined in the ‘sys/syslog.h’
          header file.

          `Priorities'

          Name (string)                  Symbolic value
                                         
          ---------------------------------------------------
                                         
          ‘alert’                        LOG_ALERT
                                         
                                         
          ‘crit’ or ‘critical’           LOG_CRIT
                                         
                                         
          ‘debug’                        LOG_DEBUG
                                         
                                         
          ‘emerg’ or ‘panic’             LOG_EMERG
                                         
                                         
          ‘err’ or ‘error’               LOG_ERR
                                         
                                         
          ‘info’                         LOG_INFO
                                         
                                         
          ‘notice’                       LOG_NOTICE
                                         
                                         
          ‘warn’ or ‘warning’            LOG_WARNING
                                         

          `Facilities'

          Name (string)       Symbolic value
                              
          ----------------------------------------
                              
          ‘auth’              LOG_AUTH
                              
                              
          ‘authpriv’          LOG_AUTHPRIV
                              
                              
          ‘cron’              LOG_CRON
                              
                              
          ‘daemon’            LOG_DAEMON
                              
                              
          ‘ftp’               LOG_FTP
                              
                              
          ‘kern’              LOG_KERN
                              
                              
          ‘lpr’               LOG_LPR
                              
                              
          ‘mail’              LOG_MAIL
                              
                              
          ‘news’              LOG_NEWS
                              
                              
          ‘syslog’            LOG_SYSLOG
                              
                              
          ‘user’              LOG_USER
                              
                              
          ‘uucp’              LOG_UUCP
                              
                              
          ‘local0’            LOG_LOCAL0
                              
                              
          ‘local1’            LOG_LOCAL1
                              
                              
          ‘local2’            LOG_LOCAL2
                              
                              
          ‘local3’            LOG_LOCAL3
                              
                              
          ‘local4’            LOG_LOCAL4
                              
                              
          ‘local5’            LOG_LOCAL5
                              
                              
          ‘local6’            LOG_LOCAL6
                              
                              
          ‘local7’            LOG_LOCAL7
                              

      -- Method: mapPriority (levelname)

          Maps a logging level name to a syslog priority name.  You may
          need to override this if you are using custom levels, or if
          the default algorithm is not suitable for your needs.  The
          default algorithm maps ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’ and
          ‘CRITICAL’ to the equivalent syslog names, and all other level
          names to ‘warning’.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue12168

   (2) https://tools.ietf.org/html/rfc5424.html

   (3) https://bugs.python.org/issue12419


File: python.info,  Node: NTEventLogHandler,  Next: SMTPHandler,  Prev: SysLogHandler,  Up: logging handlers — Logging handlers

5.16.8.11 NTEventLogHandler
...........................

The *note NTEventLogHandler: 2063. class, located in the *note
logging.handlers: ac. module, supports sending logging messages to a
local Windows NT, Windows 2000 or Windows XP event log.  Before you can
use it, you need Mark Hammond’s Win32 extensions for Python installed.

 -- Class: logging.handlers.NTEventLogHandler (appname, dllname=None,
          logtype='Application')

     Returns a new instance of the *note NTEventLogHandler: 2063. class.
     The `appname' is used to define the application name as it appears
     in the event log.  An appropriate registry entry is created using
     this name.  The `dllname' should give the fully qualified pathname
     of a .dll or .exe which contains message definitions to hold in the
     log (if not specified, ‘'win32service.pyd'’ is used - this is
     installed with the Win32 extensions and contains some basic
     placeholder message definitions.  Note that use of these
     placeholders will make your event logs big, as the entire message
     source is held in the log.  If you want slimmer logs, you have to
     pass in the name of your own .dll or .exe which contains the
     message definitions you want to use in the event log).  The
     `logtype' is one of ‘'Application'’, ‘'System'’ or ‘'Security'’,
     and defaults to ‘'Application'’.

      -- Method: close ()

          At this point, you can remove the application name from the
          registry as a source of event log entries.  However, if you do
          this, you will not be able to see the events as you intended
          in the Event Log Viewer - it needs to be able to access the
          registry to get the .dll name.  The current version does not
          do this.

      -- Method: emit (record)

          Determines the message ID, event category and event type, and
          then logs the message in the NT event log.

      -- Method: getEventCategory (record)

          Returns the event category for the record.  Override this if
          you want to specify your own categories.  This version returns
          0.

      -- Method: getEventType (record)

          Returns the event type for the record.  Override this if you
          want to specify your own types.  This version does a mapping
          using the handler’s typemap attribute, which is set up in
          *note __init__(): d51. to a dictionary which contains mappings
          for ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’ and ‘CRITICAL’.  If
          you are using your own levels, you will either need to
          override this method or place a suitable dictionary in the
          handler’s `typemap' attribute.

      -- Method: getMessageID (record)

          Returns the message ID for the record.  If you are using your
          own messages, you could do this by having the `msg' passed to
          the logger being an ID rather than a format string.  Then, in
          here, you could use a dictionary lookup to get the message ID.
          This version returns 1, which is the base message ID in
          ‘win32service.pyd’.


File: python.info,  Node: SMTPHandler,  Next: MemoryHandler,  Prev: NTEventLogHandler,  Up: logging handlers — Logging handlers

5.16.8.12 SMTPHandler
.....................

The *note SMTPHandler: 206b. class, located in the *note
logging.handlers: ac. module, supports sending logging messages to an
email address via SMTP.

 -- Class: logging.handlers.SMTPHandler (mailhost, fromaddr, toaddrs,
          subject, credentials=None, secure=None, timeout=1.0)

     Returns a new instance of the *note SMTPHandler: 206b. class.  The
     instance is initialized with the from and to addresses and subject
     line of the email.  The `toaddrs' should be a list of strings.  To
     specify a non-standard SMTP port, use the (host, port) tuple format
     for the `mailhost' argument.  If you use a string, the standard
     SMTP port is used.  If your SMTP server requires authentication,
     you can specify a (username, password) tuple for the `credentials'
     argument.

     To specify the use of a secure protocol (TLS), pass in a tuple to
     the `secure' argument.  This will only be used when authentication
     credentials are supplied.  The tuple should be either an empty
     tuple, or a single-value tuple with the name of a keyfile, or a
     2-value tuple with the names of the keyfile and certificate file.
     (This tuple is passed to the *note smtplib.SMTP.starttls(): a79.
     method.)

     A timeout can be specified for communication with the SMTP server
     using the `timeout' argument.

     New in version 3.3: The `timeout' argument was added.

      -- Method: emit (record)

          Formats the record and sends it to the specified addressees.

      -- Method: getSubject (record)

          If you want to specify a subject line which is
          record-dependent, override this method.


File: python.info,  Node: MemoryHandler,  Next: HTTPHandler,  Prev: SMTPHandler,  Up: logging handlers — Logging handlers

5.16.8.13 MemoryHandler
.......................

The *note MemoryHandler: 2024. class, located in the *note
logging.handlers: ac. module, supports buffering of logging records in
memory, periodically flushing them to a `target' handler.  Flushing
occurs whenever the buffer is full, or when an event of a certain
severity or greater is seen.

*note MemoryHandler: 2024. is a subclass of the more general *note
BufferingHandler: 2070, which is an abstract class.  This buffers
logging records in memory.  Whenever each record is added to the buffer,
a check is made by calling ‘shouldFlush()’ to see if the buffer should
be flushed.  If it should, then ‘flush()’ is expected to do the
flushing.

 -- Class: logging.handlers.BufferingHandler (capacity)

     Initializes the handler with a buffer of the specified capacity.
     Here, `capacity' means the number of logging records buffered.

      -- Method: emit (record)

          Append the record to the buffer.  If *note shouldFlush():
          2072. returns true, call *note flush(): 2073. to process the
          buffer.

      -- Method: flush ()

          You can override this to implement custom flushing behavior.
          This version just zaps the buffer to empty.

      -- Method: shouldFlush (record)

          Return ‘True’ if the buffer is up to capacity.  This method
          can be overridden to implement custom flushing strategies.

 -- Class: logging.handlers.MemoryHandler (capacity, flushLevel=ERROR,
          target=None, flushOnClose=True)

     Returns a new instance of the *note MemoryHandler: 2024. class.
     The instance is initialized with a buffer size of `capacity'
     (number of records buffered).  If `flushLevel' is not specified,
     ‘ERROR’ is used.  If no `target' is specified, the target will need
     to be set using *note setTarget(): 2074. before this handler does
     anything useful.  If `flushOnClose' is specified as ‘False’, then
     the buffer is `not' flushed when the handler is closed.  If not
     specified or specified as ‘True’, the previous behaviour of
     flushing the buffer will occur when the handler is closed.

     Changed in version 3.6: The `flushOnClose' parameter was added.

      -- Method: close ()

          Calls *note flush(): 2076, sets the target to ‘None’ and
          clears the buffer.

      -- Method: flush ()

          For a *note MemoryHandler: 2024, flushing means just sending
          the buffered records to the target, if there is one.  The
          buffer is also cleared when this happens.  Override if you
          want different behavior.

      -- Method: setTarget (target)

          Sets the target handler for this handler.

      -- Method: shouldFlush (record)

          Checks for buffer full or a record at the `flushLevel' or
          higher.


File: python.info,  Node: HTTPHandler,  Next: QueueHandler,  Prev: MemoryHandler,  Up: logging handlers — Logging handlers

5.16.8.14 HTTPHandler
.....................

The *note HTTPHandler: 705. class, located in the *note
logging.handlers: ac. module, supports sending logging messages to a Web
server, using either ‘GET’ or ‘POST’ semantics.

 -- Class: logging.handlers.HTTPHandler (host, url, method='GET',
          secure=False, credentials=None, context=None)

     Returns a new instance of the *note HTTPHandler: 705. class.  The
     `host' can be of the form ‘host:port’, should you need to use a
     specific port number.  If no `method' is specified, ‘GET’ is used.
     If `secure' is true, a HTTPS connection will be used.  The
     `context' parameter may be set to a *note ssl.SSLContext: 3d9.
     instance to configure the SSL settings used for the HTTPS
     connection.  If `credentials' is specified, it should be a 2-tuple
     consisting of userid and password, which will be placed in a HTTP
     ‘Authorization’ header using Basic authentication.  If you specify
     credentials, you should also specify secure=True so that your
     userid and password are not passed in cleartext across the wire.

     Changed in version 3.5: The `context' parameter was added.

      -- Method: mapLogRecord (record)

          Provides a dictionary, based on ‘record’, which is to be
          URL-encoded and sent to the web server.  The default
          implementation just returns ‘record.__dict__’.  This method
          can be overridden if e.g.  only a subset of *note LogRecord:
          8fa. is to be sent to the web server, or if more specific
          customization of what’s sent to the server is required.

      -- Method: emit (record)

          Sends the record to the Web server as a URL-encoded
          dictionary.  The *note mapLogRecord(): 207a. method is used to
          convert the record to the dictionary to be sent.

          Note: Since preparing a record for sending it to a Web server
          is not the same as a generic formatting operation, using *note
          setFormatter(): 1fdb. to specify a *note Formatter: 1fc4. for
          a *note HTTPHandler: 705. has no effect.  Instead of calling
          *note format(): 1fe5, this handler calls *note mapLogRecord():
          207a. and then *note urllib.parse.urlencode(): 77f. to encode
          the dictionary in a form suitable for sending to a Web server.


File: python.info,  Node: QueueHandler,  Next: QueueListener,  Prev: HTTPHandler,  Up: logging handlers — Logging handlers

5.16.8.15 QueueHandler
......................

New in version 3.2.

The *note QueueHandler: 207e. class, located in the *note
logging.handlers: ac. module, supports sending logging messages to a
queue, such as those implemented in the *note queue: da. or *note
multiprocessing: b7. modules.

Along with the *note QueueListener: 706. class, *note QueueHandler:
207e. can be used to let handlers do their work on a separate thread
from the one which does the logging.  This is important in Web
applications and also other service applications where threads servicing
clients need to respond as quickly as possible, while any potentially
slow operations (such as sending an email via *note SMTPHandler: 206b.)
are done on a separate thread.

 -- Class: logging.handlers.QueueHandler (queue)

     Returns a new instance of the *note QueueHandler: 207e. class.  The
     instance is initialized with the queue to send messages to.  The
     `queue' can be any queue-like object; it’s used as-is by the *note
     enqueue(): 207f. method, which needs to know how to send messages
     to it.  The queue is not `required' to have the task tracking API,
     which means that you can use *note SimpleQueue: 3bb. instances for
     `queue'.

      -- Method: emit (record)

          Enqueues the result of preparing the LogRecord.  Should an
          exception occur (e.g.  because a bounded queue has filled up),
          the *note handleError(): 1fe3. method is called to handle the
          error.  This can result in the record silently being dropped
          (if ‘logging.raiseExceptions’ is ‘False’) or a message printed
          to ‘sys.stderr’ (if ‘logging.raiseExceptions’ is ‘True’).

      -- Method: prepare (record)

          Prepares a record for queuing.  The object returned by this
          method is enqueued.

          The base implementation formats the record to merge the
          message, arguments, and exception information, if present.  It
          also removes unpickleable items from the record in-place.

          You might want to override this method if you want to convert
          the record to a dict or JSON string, or send a modified copy
          of the record while leaving the original intact.

      -- Method: enqueue (record)

          Enqueues the record on the queue using ‘put_nowait()’; you may
          want to override this if you want to use blocking behaviour,
          or a timeout, or a customized queue implementation.


File: python.info,  Node: QueueListener,  Prev: QueueHandler,  Up: logging handlers — Logging handlers

5.16.8.16 QueueListener
.......................

New in version 3.2.

The *note QueueListener: 706. class, located in the *note
logging.handlers: ac. module, supports receiving logging messages from a
queue, such as those implemented in the *note queue: da. or *note
multiprocessing: b7. modules.  The messages are received from a queue in
an internal thread and passed, on the same thread, to one or more
handlers for processing.  While *note QueueListener: 706. is not itself
a handler, it is documented here because it works hand-in-hand with
*note QueueHandler: 207e.

Along with the *note QueueHandler: 207e. class, *note QueueListener:
706. can be used to let handlers do their work on a separate thread from
the one which does the logging.  This is important in Web applications
and also other service applications where threads servicing clients need
to respond as quickly as possible, while any potentially slow operations
(such as sending an email via *note SMTPHandler: 206b.) are done on a
separate thread.

 -- Class: logging.handlers.QueueListener (queue, *handlers,
          respect_handler_level=False)

     Returns a new instance of the *note QueueListener: 706. class.  The
     instance is initialized with the queue to send messages to and a
     list of handlers which will handle entries placed on the queue.
     The queue can be any queue-like object; it’s passed as-is to the
     *note dequeue(): 2084. method, which needs to know how to get
     messages from it.  The queue is not `required' to have the task
     tracking API (though it’s used if available), which means that you
     can use *note SimpleQueue: 3bb. instances for `queue'.

     If ‘respect_handler_level’ is ‘True’, a handler’s level is
     respected (compared with the level for the message) when deciding
     whether to pass messages to that handler; otherwise, the behaviour
     is as in previous Python versions - to always pass each message to
     each handler.

     Changed in version 3.5: The ‘respect_handler_level’ argument was
     added.

      -- Method: dequeue (block)

          Dequeues a record and return it, optionally blocking.

          The base implementation uses ‘get()’.  You may want to
          override this method if you want to use timeouts or work with
          custom queue implementations.

      -- Method: prepare (record)

          Prepare a record for handling.

          This implementation just returns the passed-in record.  You
          may want to override this method if you need to do any custom
          marshalling or manipulation of the record before passing it to
          the handlers.

      -- Method: handle (record)

          Handle a record.

          This just loops through the handlers offering them the record
          to handle.  The actual object passed to the handlers is that
          which is returned from *note prepare(): 2085.

      -- Method: start ()

          Starts the listener.

          This starts up a background thread to monitor the queue for
          LogRecords to process.

      -- Method: stop ()

          Stops the listener.

          This asks the thread to terminate, and then waits for it to do
          so.  Note that if you don’t call this before your application
          exits, there may be some records still left on the queue,
          which won’t be processed.

      -- Method: enqueue_sentinel ()

          Writes a sentinel to the queue to tell the listener to quit.
          This implementation uses ‘put_nowait()’.  You may want to
          override this method if you want to use timeouts or work with
          custom queue implementations.

          New in version 3.3.

See also
........

Module *note logging: aa.

     API reference for the logging module.

Module *note logging.config: ab.

     Configuration API for the logging module.


File: python.info,  Node: getpass — Portable password input,  Next: curses — Terminal handling for character-cell displays,  Prev: logging handlers — Logging handlers,  Up: Generic Operating System Services

5.16.9 ‘getpass’ — Portable password input
------------------------------------------

`Source code:' Lib/getpass.py(1)

__________________________________________________________________

The *note getpass: 88. module provides two functions:

 -- Function: getpass.getpass (prompt='Password: ', stream=None)

     Prompt the user for a password without echoing.  The user is
     prompted using the string `prompt', which defaults to ‘'Password:
     '’.  On Unix, the prompt is written to the file-like object
     `stream' using the replace error handler if needed.  `stream'
     defaults to the controlling terminal (‘/dev/tty’) or if that is
     unavailable to ‘sys.stderr’ (this argument is ignored on Windows).

     If echo free input is unavailable getpass() falls back to printing
     a warning message to `stream' and reading from ‘sys.stdin’ and
     issuing a *note GetPassWarning: 208d.

          Note: If you call getpass from within IDLE, the input may be
          done in the terminal you launched IDLE from rather than the
          idle window itself.

 -- Exception: getpass.GetPassWarning

     A *note UserWarning: 1653. subclass issued when password input may
     be echoed.

 -- Function: getpass.getuser ()

     Return the “login name” of the user.

     This function checks the environment variables ‘LOGNAME’, ‘USER’,
     ‘LNAME’ and ‘USERNAME’, in order, and returns the value of the
     first one which is set to a non-empty string.  If none are set, the
     login name from the password database is returned on systems which
     support the *note pwd: d6. module, otherwise, an exception is
     raised.

     In general, this function should be preferred over *note
     os.getlogin(): 1e2a.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/getpass.py


File: python.info,  Node: curses — Terminal handling for character-cell displays,  Next: curses textpad — Text input widget for curses programs,  Prev: getpass — Portable password input,  Up: Generic Operating System Services

5.16.10 ‘curses’ — Terminal handling for character-cell displays
----------------------------------------------------------------

__________________________________________________________________

The *note curses: 2c. module provides an interface to the curses
library, the de-facto standard for portable advanced terminal handling.

While curses is most widely used in the Unix environment, versions are
available for Windows, DOS, and possibly other systems as well.  This
extension module is designed to match the API of ncurses, an open-source
curses library hosted on Linux and the BSD variants of Unix.

     Note: Whenever the documentation mentions a `character' it can be
     specified as an integer, a one-character Unicode string or a
     one-byte byte string.

     Whenever the documentation mentions a `character string' it can be
     specified as a Unicode string or a byte string.

     Note: Since version 5.4, the ncurses library decides how to
     interpret non-ASCII data using the ‘nl_langinfo’ function.  That
     means that you have to call *note locale.setlocale(): 1f48. in the
     application and encode Unicode strings using one of the system’s
     available encodings.  This example uses the system’s default
     encoding:

          import locale locale.setlocale(locale.LC_ALL, '') code = locale.getpreferredencoding()

     Then use `code' as the encoding for *note str.encode(): c2a. calls.

See also
........

Module *note curses.ascii: 2d.

     Utilities for working with ASCII characters, regardless of your
     locale settings.

Module *note curses.panel: 2e.

     A panel stack extension that adds depth to curses windows.

Module *note curses.textpad: 2f.

     Editable text widget for curses supporting ‘Emacs’-like bindings.

*note Curses Programming with Python: 2090.

     Tutorial material on using curses with Python, by Andrew Kuchling
     and Eric Raymond.

The Tools/demo/(1) directory in the Python source distribution contains
some example programs using the curses bindings provided by this module.

* Menu:

* Functions: Functions<3>.
* Window Objects::
* Constants: Constants<6>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Tools/demo/


File: python.info,  Node: Functions<3>,  Next: Window Objects,  Up: curses — Terminal handling for character-cell displays

5.16.10.1 Functions
...................

The module *note curses: 2c. defines the following exception:

 -- Exception: curses.error

     Exception raised when a curses library function returns an error.

     Note: Whenever `x' or `y' arguments to a function or a method are
     optional, they default to the current cursor location.  Whenever
     `attr' is optional, it defaults to ‘A_NORMAL’.

The module *note curses: 2c. defines the following functions:

 -- Function: curses.baudrate ()

     Return the output speed of the terminal in bits per second.  On
     software terminal emulators it will have a fixed high value.
     Included for historical reasons; in former times, it was used to
     write output loops for time delays and occasionally to change
     interfaces depending on the line speed.

 -- Function: curses.beep ()

     Emit a short attention sound.

 -- Function: curses.can_change_color ()

     Return ‘True’ or ‘False’, depending on whether the programmer can
     change the colors displayed by the terminal.

 -- Function: curses.cbreak ()

     Enter cbreak mode.  In cbreak mode (sometimes called “rare” mode)
     normal tty line buffering is turned off and characters are
     available to be read one by one.  However, unlike raw mode, special
     characters (interrupt, quit, suspend, and flow control) retain
     their effects on the tty driver and calling program.  Calling first
     *note raw(): 2098. then *note cbreak(): 2097. leaves the terminal
     in cbreak mode.

 -- Function: curses.color_content (color_number)

     Return the intensity of the red, green, and blue (RGB) components
     in the color `color_number', which must be between ‘0’ and
     ‘COLORS’.  Return a 3-tuple, containing the R,G,B values for the
     given color, which will be between ‘0’ (no component) and ‘1000’
     (maximum amount of component).

 -- Function: curses.color_pair (color_number)

     Return the attribute value for displaying text in the specified
     color.  This attribute value can be combined with ‘A_STANDOUT’,
     ‘A_REVERSE’, and the other ‘A_*’ attributes.  *note pair_number():
     209b. is the counterpart to this function.

 -- Function: curses.curs_set (visibility)

     Set the cursor state.  `visibility' can be set to ‘0’, ‘1’, or ‘2’,
     for invisible, normal, or very visible.  If the terminal supports
     the visibility requested, return the previous cursor state;
     otherwise raise an exception.  On many terminals, the “visible”
     mode is an underline cursor and the “very visible” mode is a block
     cursor.

 -- Function: curses.def_prog_mode ()

     Save the current terminal mode as the “program” mode, the mode when
     the running program is using curses.  (Its counterpart is the
     “shell” mode, for when the program is not in curses.)  Subsequent
     calls to *note reset_prog_mode(): 209e. will restore this mode.

 -- Function: curses.def_shell_mode ()

     Save the current terminal mode as the “shell” mode, the mode when
     the running program is not using curses.  (Its counterpart is the
     “program” mode, when the program is using curses capabilities.)
     Subsequent calls to *note reset_shell_mode(): 20a0. will restore
     this mode.

 -- Function: curses.delay_output (ms)

     Insert an `ms' millisecond pause in output.

 -- Function: curses.doupdate ()

     Update the physical screen.  The curses library keeps two data
     structures, one representing the current physical screen contents
     and a virtual screen representing the desired next state.  The
     *note doupdate(): 20a2. ground updates the physical screen to match
     the virtual screen.

     The virtual screen may be updated by a *note noutrefresh(): 20a3.
     call after write operations such as *note addstr(): 20a4. have been
     performed on a window.  The normal *note refresh(): 20a5. call is
     simply ‘noutrefresh()’ followed by ‘doupdate()’; if you have to
     update multiple windows, you can speed performance and perhaps
     reduce screen flicker by issuing ‘noutrefresh()’ calls on all
     windows, followed by a single ‘doupdate()’.

 -- Function: curses.echo ()

     Enter echo mode.  In echo mode, each character input is echoed to
     the screen as it is entered.

 -- Function: curses.endwin ()

     De-initialize the library, and return terminal to normal status.

 -- Function: curses.erasechar ()

     Return the user’s current erase character as a one-byte bytes
     object.  Under Unix operating systems this is a property of the
     controlling tty of the curses program, and is not set by the curses
     library itself.

 -- Function: curses.filter ()

     The *note filter(): 20a9. routine, if used, must be called before
     *note initscr(): 20aa. is called.  The effect is that, during those
     calls, ‘LINES’ is set to ‘1’; the capabilities ‘clear’, ‘cup’,
     ‘cud’, ‘cud1’, ‘cuu1’, ‘cuu’, ‘vpa’ are disabled; and the ‘home’
     string is set to the value of ‘cr’.  The effect is that the cursor
     is confined to the current line, and so are screen updates.  This
     may be used for enabling character-at-a-time line editing without
     touching the rest of the screen.

 -- Function: curses.flash ()

     Flash the screen.  That is, change it to reverse-video and then
     change it back in a short interval.  Some people prefer such as
     ‘visible bell’ to the audible attention signal produced by *note
     beep(): 2095.

 -- Function: curses.flushinp ()

     Flush all input buffers.  This throws away any typeahead that has
     been typed by the user and has not yet been processed by the
     program.

 -- Function: curses.getmouse ()

     After *note getch(): 20ae. returns ‘KEY_MOUSE’ to signal a mouse
     event, this method should be call to retrieve the queued mouse
     event, represented as a 5-tuple ‘(id, x, y, z, bstate)’.  `id' is
     an ID value used to distinguish multiple devices, and `x', `y', `z'
     are the event’s coordinates.  (`z' is currently unused.)  `bstate'
     is an integer value whose bits will be set to indicate the type of
     event, and will be the bitwise OR of one or more of the following
     constants, where `n' is the button number from 1 to 4:
     ‘BUTTONn_PRESSED’, ‘BUTTONn_RELEASED’, ‘BUTTONn_CLICKED’,
     ‘BUTTONn_DOUBLE_CLICKED’, ‘BUTTONn_TRIPLE_CLICKED’, ‘BUTTON_SHIFT’,
     ‘BUTTON_CTRL’, ‘BUTTON_ALT’.

 -- Function: curses.getsyx ()

     Return the current coordinates of the virtual screen cursor as a
     tuple ‘(y, x)’.  If *note leaveok: 20b0. is currently ‘True’, then
     return ‘(-1, -1)’.

 -- Function: curses.getwin (file)

     Read window related data stored in the file by an earlier
     ‘putwin()’ call.  The routine then creates and initializes a new
     window using that data, returning the new window object.

 -- Function: curses.has_colors ()

     Return ‘True’ if the terminal can display colors; otherwise, return
     ‘False’.

 -- Function: curses.has_ic ()

     Return ‘True’ if the terminal has insert- and delete-character
     capabilities.  This function is included for historical reasons
     only, as all modern software terminal emulators have such
     capabilities.

 -- Function: curses.has_il ()

     Return ‘True’ if the terminal has insert- and delete-line
     capabilities, or can simulate them using scrolling regions.  This
     function is included for historical reasons only, as all modern
     software terminal emulators have such capabilities.

 -- Function: curses.has_key (ch)

     Take a key value `ch', and return ‘True’ if the current terminal
     type recognizes a key with that value.

 -- Function: curses.halfdelay (tenths)

     Used for half-delay mode, which is similar to cbreak mode in that
     characters typed by the user are immediately available to the
     program.  However, after blocking for `tenths' tenths of seconds,
     raise an exception if nothing has been typed.  The value of
     `tenths' must be a number between ‘1’ and ‘255’.  Use *note
     nocbreak(): 20b7. to leave half-delay mode.

 -- Function: curses.init_color (color_number, r, g, b)

     Change the definition of a color, taking the number of the color to
     be changed followed by three RGB values (for the amounts of red,
     green, and blue components).  The value of `color_number' must be
     between ‘0’ and ‘COLORS’.  Each of `r', `g', `b', must be a value
     between ‘0’ and ‘1000’.  When *note init_color(): 20b8. is used,
     all occurrences of that color on the screen immediately change to
     the new definition.  This function is a no-op on most terminals; it
     is active only if *note can_change_color(): 2096. returns ‘True’.

 -- Function: curses.init_pair (pair_number, fg, bg)

     Change the definition of a color-pair.  It takes three arguments:
     the number of the color-pair to be changed, the foreground color
     number, and the background color number.  The value of
     `pair_number' must be between ‘1’ and ‘COLOR_PAIRS - 1’ (the ‘0’
     color pair is wired to white on black and cannot be changed).  The
     value of `fg' and `bg' arguments must be between ‘0’ and ‘COLORS’.
     If the color-pair was previously initialized, the screen is
     refreshed and all occurrences of that color-pair are changed to the
     new definition.

 -- Function: curses.initscr ()

     Initialize the library.  Return a *note window: 20ba. object which
     represents the whole screen.

          Note: If there is an error opening the terminal, the
          underlying curses library may cause the interpreter to exit.

 -- Function: curses.is_term_resized (nlines, ncols)

     Return ‘True’ if *note resize_term(): 20bc. would modify the window
     structure, ‘False’ otherwise.

 -- Function: curses.isendwin ()

     Return ‘True’ if *note endwin(): 20a7. has been called (that is,
     the curses library has been deinitialized).

 -- Function: curses.keyname (k)

     Return the name of the key numbered `k' as a bytes object.  The
     name of a key generating printable ASCII character is the key’s
     character.  The name of a control-key combination is a two-byte
     bytes object consisting of a caret (‘b'^'’) followed by the
     corresponding printable ASCII character.  The name of an alt-key
     combination (128–255) is a bytes object consisting of the prefix
     ‘b'M-'’ followed by the name of the corresponding ASCII character.

 -- Function: curses.killchar ()

     Return the user’s current line kill character as a one-byte bytes
     object.  Under Unix operating systems this is a property of the
     controlling tty of the curses program, and is not set by the curses
     library itself.

 -- Function: curses.longname ()

     Return a bytes object containing the terminfo long name field
     describing the current terminal.  The maximum length of a verbose
     description is 128 characters.  It is defined only after the call
     to *note initscr(): 20aa.

 -- Function: curses.meta (flag)

     If `flag' is ‘True’, allow 8-bit characters to be input.  If `flag'
     is ‘False’, allow only 7-bit chars.

 -- Function: curses.mouseinterval (interval)

     Set the maximum time in milliseconds that can elapse between press
     and release events in order for them to be recognized as a click,
     and return the previous interval value.  The default value is 200
     msec, or one fifth of a second.

 -- Function: curses.mousemask (mousemask)

     Set the mouse events to be reported, and return a tuple
     ‘(availmask, oldmask)’.  `availmask' indicates which of the
     specified mouse events can be reported; on complete failure it
     returns ‘0’.  `oldmask' is the previous value of the given window’s
     mouse event mask.  If this function is never called, no mouse
     events are ever reported.

 -- Function: curses.napms (ms)

     Sleep for `ms' milliseconds.

 -- Function: curses.newpad (nlines, ncols)

     Create and return a pointer to a new pad data structure with the
     given number of lines and columns.  Return a pad as a window
     object.

     A pad is like a window, except that it is not restricted by the
     screen size, and is not necessarily associated with a particular
     part of the screen.  Pads can be used when a large window is
     needed, and only a part of the window will be on the screen at one
     time.  Automatic refreshes of pads (such as from scrolling or
     echoing of input) do not occur.  The *note refresh(): 20a5. and
     *note noutrefresh(): 20a3. methods of a pad require 6 arguments to
     specify the part of the pad to be displayed and the location on the
     screen to be used for the display.  The arguments are `pminrow',
     `pmincol', `sminrow', `smincol', `smaxrow', `smaxcol'; the `p'
     arguments refer to the upper left corner of the pad region to be
     displayed and the `s' arguments define a clipping box on the screen
     within which the pad region is to be displayed.

 -- Function: curses.newwin (nlines, ncols)

 -- Function: curses.newwin (nlines, ncols, begin_y, begin_x)

     Return a new *note window: 20ba, whose left-upper corner is at
     ‘(begin_y, begin_x)’, and whose height/width is `nlines'/`ncols'.

     By default, the window will extend from the specified position to
     the lower right corner of the screen.

 -- Function: curses.nl ()

     Enter newline mode.  This mode translates the return key into
     newline on input, and translates newline into return and line-feed
     on output.  Newline mode is initially on.

 -- Function: curses.nocbreak ()

     Leave cbreak mode.  Return to normal “cooked” mode with line
     buffering.

 -- Function: curses.noecho ()

     Leave echo mode.  Echoing of input characters is turned off.

 -- Function: curses.nonl ()

     Leave newline mode.  Disable translation of return into newline on
     input, and disable low-level translation of newline into
     newline/return on output (but this does not change the behavior of
     ‘addch('\n')’, which always does the equivalent of return and line
     feed on the virtual screen).  With translation off, curses can
     sometimes speed up vertical motion a little; also, it will be able
     to detect the return key on input.

 -- Function: curses.noqiflush ()

     When the ‘noqiflush()’ routine is used, normal flush of input and
     output queues associated with the ‘INTR’, ‘QUIT’ and ‘SUSP’
     characters will not be done.  You may want to call ‘noqiflush()’ in
     a signal handler if you want output to continue as though the
     interrupt had not occurred, after the handler exits.

 -- Function: curses.noraw ()

     Leave raw mode.  Return to normal “cooked” mode with line
     buffering.

 -- Function: curses.pair_content (pair_number)

     Return a tuple ‘(fg, bg)’ containing the colors for the requested
     color pair.  The value of `pair_number' must be between ‘1’ and
     ‘COLOR_PAIRS - 1’.

 -- Function: curses.pair_number (attr)

     Return the number of the color-pair set by the attribute value
     `attr'.  *note color_pair(): 209a. is the counterpart to this
     function.

 -- Function: curses.putp (str)

     Equivalent to ‘tputs(str, 1, putchar)’; emit the value of a
     specified terminfo capability for the current terminal.  Note that
     the output of *note putp(): 20cd. always goes to standard output.

 -- Function: curses.qiflush ([flag])

     If `flag' is ‘False’, the effect is the same as calling *note
     noqiflush(): 20ca.  If `flag' is ‘True’, or no argument is
     provided, the queues will be flushed when these control characters
     are read.

 -- Function: curses.raw ()

     Enter raw mode.  In raw mode, normal line buffering and processing
     of interrupt, quit, suspend, and flow control keys are turned off;
     characters are presented to curses input functions one by one.

 -- Function: curses.reset_prog_mode ()

     Restore the terminal to “program” mode, as previously saved by
     *note def_prog_mode(): 209d.

 -- Function: curses.reset_shell_mode ()

     Restore the terminal to “shell” mode, as previously saved by *note
     def_shell_mode(): 209f.

 -- Function: curses.resetty ()

     Restore the state of the terminal modes to what it was at the last
     call to *note savetty(): 20d0.

 -- Function: curses.resize_term (nlines, ncols)

     Backend function used by *note resizeterm(): 20d1, performing most
     of the work; when resizing the windows, *note resize_term(): 20bc.
     blank-fills the areas that are extended.  The calling application
     should fill in these areas with appropriate data.  The
     ‘resize_term()’ function attempts to resize all windows.  However,
     due to the calling convention of pads, it is not possible to resize
     these without additional interaction with the application.

 -- Function: curses.resizeterm (nlines, ncols)

     Resize the standard and current windows to the specified
     dimensions, and adjusts other bookkeeping data used by the curses
     library that record the window dimensions (in particular the
     SIGWINCH handler).

 -- Function: curses.savetty ()

     Save the current state of the terminal modes in a buffer, usable by
     *note resetty(): 20cf.

 -- Function: curses.setsyx (y, x)

     Set the virtual screen cursor to `y', `x'.  If `y' and `x' are both
     ‘-1’, then *note leaveok: 20b0. is set ‘True’.

 -- Function: curses.setupterm (term=None, fd=-1)

     Initialize the terminal.  `term' is a string giving the terminal
     name, or ‘None’; if omitted or ‘None’, the value of the ‘TERM’
     environment variable will be used.  `fd' is the file descriptor to
     which any initialization sequences will be sent; if not supplied or
     ‘-1’, the file descriptor for ‘sys.stdout’ will be used.

 -- Function: curses.start_color ()

     Must be called if the programmer wants to use colors, and before
     any other color manipulation routine is called.  It is good
     practice to call this routine right after *note initscr(): 20aa.

     *note start_color(): 20d4. initializes eight basic colors (black,
     red, green, yellow, blue, magenta, cyan, and white), and two global
     variables in the *note curses: 2c. module, ‘COLORS’ and
     ‘COLOR_PAIRS’, containing the maximum number of colors and
     color-pairs the terminal can support.  It also restores the colors
     on the terminal to the values they had when the terminal was just
     turned on.

 -- Function: curses.termattrs ()

     Return a logical OR of all video attributes supported by the
     terminal.  This information is useful when a curses program needs
     complete control over the appearance of the screen.

 -- Function: curses.termname ()

     Return the value of the environment variable ‘TERM’, as a bytes
     object, truncated to 14 characters.

 -- Function: curses.tigetflag (capname)

     Return the value of the Boolean capability corresponding to the
     terminfo capability name `capname' as an integer.  Return the value
     ‘-1’ if `capname' is not a Boolean capability, or ‘0’ if it is
     canceled or absent from the terminal description.

 -- Function: curses.tigetnum (capname)

     Return the value of the numeric capability corresponding to the
     terminfo capability name `capname' as an integer.  Return the value
     ‘-2’ if `capname' is not a numeric capability, or ‘-1’ if it is
     canceled or absent from the terminal description.

 -- Function: curses.tigetstr (capname)

     Return the value of the string capability corresponding to the
     terminfo capability name `capname' as a bytes object.  Return
     ‘None’ if `capname' is not a terminfo “string capability”, or is
     canceled or absent from the terminal description.

 -- Function: curses.tparm (str[, ...])

     Instantiate the bytes object `str' with the supplied parameters,
     where `str' should be a parameterized string obtained from the
     terminfo database.  E.g.  ‘tparm(tigetstr("cup"), 5, 3)’ could
     result in ‘b'\033[6;4H'’, the exact result depending on terminal
     type.

 -- Function: curses.typeahead (fd)

     Specify that the file descriptor `fd' be used for typeahead
     checking.  If `fd' is ‘-1’, then no typeahead checking is done.

     The curses library does “line-breakout optimization” by looking for
     typeahead periodically while updating the screen.  If input is
     found, and it is coming from a tty, the current update is postponed
     until refresh or doupdate is called again, allowing faster response
     to commands typed in advance.  This function allows specifying a
     different file descriptor for typeahead checking.

 -- Function: curses.unctrl (ch)

     Return a bytes object which is a printable representation of the
     character `ch'.  Control characters are represented as a caret
     followed by the character, for example as ‘b'^C'’.  Printing
     characters are left as they are.

 -- Function: curses.ungetch (ch)

     Push `ch' so the next *note getch(): 20ae. will return it.

          Note: Only one `ch' can be pushed before ‘getch()’ is called.

 -- Function: curses.update_lines_cols ()

     Update ‘LINES’ and ‘COLS’.  Useful for detecting manual screen
     resize.

     New in version 3.5.

 -- Function: curses.unget_wch (ch)

     Push `ch' so the next *note get_wch(): 9d3. will return it.

          Note: Only one `ch' can be pushed before ‘get_wch()’ is
          called.

     New in version 3.3.

 -- Function: curses.ungetmouse (id, x, y, z, bstate)

     Push a ‘KEY_MOUSE’ event onto the input queue, associating the
     given state data with it.

 -- Function: curses.use_env (flag)

     If used, this function should be called before *note initscr():
     20aa. or newterm are called.  When `flag' is ‘False’, the values of
     lines and columns specified in the terminfo database will be used,
     even if environment variables ‘LINES’ and ‘COLUMNS’ (used by
     default) are set, or if curses is running in a window (in which
     case default behavior would be to use the window size if ‘LINES’
     and ‘COLUMNS’ are not set).

 -- Function: curses.use_default_colors ()

     Allow use of default values for colors on terminals supporting this
     feature.  Use this to support transparency in your application.
     The default color is assigned to the color number ‘-1’.  After
     calling this function, ‘init_pair(x, curses.COLOR_RED, -1)’
     initializes, for instance, color pair `x' to a red foreground color
     on the default background.

 -- Function: curses.wrapper (func, ...)

     Initialize curses and call another callable object, `func', which
     should be the rest of your curses-using application.  If the
     application raises an exception, this function will restore the
     terminal to a sane state before re-raising the exception and
     generating a traceback.  The callable object `func' is then passed
     the main window ‘stdscr’ as its first argument, followed by any
     other arguments passed to ‘wrapper()’.  Before calling `func',
     ‘wrapper()’ turns on cbreak mode, turns off echo, enables the
     terminal keypad, and initializes colors if the terminal has color
     support.  On exit (whether normally or by exception) it restores
     cooked mode, turns on echo, and disables the terminal keypad.


File: python.info,  Node: Window Objects,  Next: Constants<6>,  Prev: Functions<3>,  Up: curses — Terminal handling for character-cell displays

5.16.10.2 Window Objects
........................

Window objects, as returned by *note initscr(): 20aa. and *note
newwin(): 20c6. above, have the following methods and attributes:

 -- Method: window.addch (ch[, attr])

 -- Method: window.addch (y, x, ch[, attr])

     Paint character `ch' at ‘(y, x)’ with attributes `attr',
     overwriting any character previously painter at that location.  By
     default, the character position and attributes are the current
     settings for the window object.

          Note: Writing outside the window, subwindow, or pad raises a
          *note curses.error: 2093.  Attempting to write to the lower
          right corner of a window, subwindow, or pad will cause an
          exception to be raised after the character is printed.

 -- Method: window.addnstr (str, n[, attr])

 -- Method: window.addnstr (y, x, str, n[, attr])

     Paint at most `n' characters of the character string `str' at ‘(y,
     x)’ with attributes `attr', overwriting anything previously on the
     display.

 -- Method: window.addstr (str[, attr])

 -- Method: window.addstr (y, x, str[, attr])

     Paint the character string `str' at ‘(y, x)’ with attributes
     `attr', overwriting anything previously on the display.

          Note: 
             * Writing outside the window, subwindow, or pad raises
               *note curses.error: 2093.  Attempting to write to the
               lower right corner of a window, subwindow, or pad will
               cause an exception to be raised after the string is
               printed.

             * A bug in ncurses(1), the backend for this Python module,
               can cause SegFaults when resizing windows.  This is fixed
               in ncurses-6.1-20190511.  If you are stuck with an
               earlier ncurses, you can avoid triggering this if you do
               not call *note addstr(): 20a4. with a `str' that has
               embedded newlines.  Instead, call *note addstr(): 20a4.
               separately for each line.

 -- Method: window.attroff (attr)

     Remove attribute `attr' from the “background” set applied to all
     writes to the current window.

 -- Method: window.attron (attr)

     Add attribute `attr' from the “background” set applied to all
     writes to the current window.

 -- Method: window.attrset (attr)

     Set the “background” set of attributes to `attr'.  This set is
     initially ‘0’ (no attributes).

 -- Method: window.bkgd (ch[, attr])

     Set the background property of the window to the character `ch',
     with attributes `attr'.  The change is then applied to every
     character position in that window:

        * The attribute of every character in the window is changed to
          the new background attribute.

        * Wherever the former background character appears, it is
          changed to the new background character.

 -- Method: window.bkgdset (ch[, attr])

     Set the window’s background.  A window’s background consists of a
     character and any combination of attributes.  The attribute part of
     the background is combined (OR’ed) with all non-blank characters
     that are written into the window.  Both the character and attribute
     parts of the background are combined with the blank characters.
     The background becomes a property of the character and moves with
     the character through any scrolling and insert/delete
     line/character operations.

 -- Method: window.border ([ls[, rs[, ts[, bs[, tl[, tr[, bl[,
          br]]]]]]]])

     Draw a border around the edges of the window.  Each parameter
     specifies the character to use for a specific part of the border;
     see the table below for more details.

          Note: A ‘0’ value for any parameter will cause the default
          character to be used for that parameter.  Keyword parameters
          can `not' be used.  The defaults are listed in this table:

     Parameter       Description               Default value
                                               
     ----------------------------------------------------------------------
                                               
     `ls'            Left side                 ‘ACS_VLINE’
                                               
                                               
     `rs'            Right side                ‘ACS_VLINE’
                                               
                                               
     `ts'            Top                       ‘ACS_HLINE’
                                               
                                               
     `bs'            Bottom                    ‘ACS_HLINE’
                                               
                                               
     `tl'            Upper-left corner         ‘ACS_ULCORNER’
                                               
                                               
     `tr'            Upper-right corner        ‘ACS_URCORNER’
                                               
                                               
     `bl'            Bottom-left corner        ‘ACS_LLCORNER’
                                               
                                               
     `br'            Bottom-right corner       ‘ACS_LRCORNER’
                                               

 -- Method: window.box ([vertch, horch])

     Similar to *note border(): 20e9, but both `ls' and `rs' are
     `vertch' and both `ts' and `bs' are `horch'.  The default corner
     characters are always used by this function.

 -- Method: window.chgat (attr)

 -- Method: window.chgat (num, attr)

 -- Method: window.chgat (y, x, attr)

 -- Method: window.chgat (y, x, num, attr)

     Set the attributes of `num' characters at the current cursor
     position, or at position ‘(y, x)’ if supplied.  If `num' is not
     given or is ‘-1’, the attribute will be set on all the characters
     to the end of the line.  This function moves cursor to position
     ‘(y, x)’ if supplied.  The changed line will be touched using the
     *note touchline(): 20ec. method so that the contents will be
     redisplayed by the next window refresh.

 -- Method: window.clear ()

     Like *note erase(): 20ee, but also cause the whole window to be
     repainted upon next call to *note refresh(): 20a5.

 -- Method: window.clearok (flag)

     If `flag' is ‘True’, the next call to *note refresh(): 20a5. will
     clear the window completely.

 -- Method: window.clrtobot ()

     Erase from cursor to the end of the window: all lines below the
     cursor are deleted, and then the equivalent of *note clrtoeol():
     20f1. is performed.

 -- Method: window.clrtoeol ()

     Erase from cursor to the end of the line.

 -- Method: window.cursyncup ()

     Update the current cursor position of all the ancestors of the
     window to reflect the current cursor position of the window.

 -- Method: window.delch ([y, x])

     Delete any character at ‘(y, x)’.

 -- Method: window.deleteln ()

     Delete the line under the cursor.  All following lines are moved up
     by one line.

 -- Method: window.derwin (begin_y, begin_x)

 -- Method: window.derwin (nlines, ncols, begin_y, begin_x)

     An abbreviation for “derive window”, *note derwin(): 20f5. is the
     same as calling *note subwin(): 20f6, except that `begin_y' and
     `begin_x' are relative to the origin of the window, rather than
     relative to the entire screen.  Return a window object for the
     derived window.

 -- Method: window.echochar (ch[, attr])

     Add character `ch' with attribute `attr', and immediately call
     *note refresh(): 20a5. on the window.

 -- Method: window.enclose (y, x)

     Test whether the given pair of screen-relative character-cell
     coordinates are enclosed by the given window, returning ‘True’ or
     ‘False’.  It is useful for determining what subset of the screen
     windows enclose the location of a mouse event.

 -- Attribute: window.encoding

     Encoding used to encode method arguments (Unicode strings and
     characters).  The encoding attribute is inherited from the parent
     window when a subwindow is created, for example with *note
     window.subwin(): 20f6.  By default, the locale encoding is used
     (see *note locale.getpreferredencoding(): 39a.).

     New in version 3.3.

 -- Method: window.erase ()

     Clear the window.

 -- Method: window.getbegyx ()

     Return a tuple ‘(y, x)’ of co-ordinates of upper-left corner.

 -- Method: window.getbkgd ()

     Return the given window’s current background character/attribute
     pair.

 -- Method: window.getch ([y, x])

     Get a character.  Note that the integer returned does `not' have to
     be in ASCII range: function keys, keypad keys and so on are
     represented by numbers higher than 255.  In no-delay mode, return
     ‘-1’ if there is no input, otherwise wait until a key is pressed.

 -- Method: window.get_wch ([y, x])

     Get a wide character.  Return a character for most keys, or an
     integer for function keys, keypad keys, and other special keys.  In
     no-delay mode, raise an exception if there is no input.

     New in version 3.3.

 -- Method: window.getkey ([y, x])

     Get a character, returning a string instead of an integer, as *note
     getch(): 20ae. does.  Function keys, keypad keys and other special
     keys return a multibyte string containing the key name.  In
     no-delay mode, raise an exception if there is no input.

 -- Method: window.getmaxyx ()

     Return a tuple ‘(y, x)’ of the height and width of the window.

 -- Method: window.getparyx ()

     Return the beginning coordinates of this window relative to its
     parent window as a tuple ‘(y, x)’.  Return ‘(-1, -1)’ if this
     window has no parent.

 -- Method: window.getstr ()

 -- Method: window.getstr (n)

 -- Method: window.getstr (y, x)

 -- Method: window.getstr (y, x, n)

     Read a bytes object from the user, with primitive line editing
     capacity.

 -- Method: window.getyx ()

     Return a tuple ‘(y, x)’ of current cursor position relative to the
     window’s upper-left corner.

 -- Method: window.hline (ch, n)

 -- Method: window.hline (y, x, ch, n)

     Display a horizontal line starting at ‘(y, x)’ with length `n'
     consisting of the character `ch'.

 -- Method: window.idcok (flag)

     If `flag' is ‘False’, curses no longer considers using the hardware
     insert/delete character feature of the terminal; if `flag' is
     ‘True’, use of character insertion and deletion is enabled.  When
     curses is first initialized, use of character insert/delete is
     enabled by default.

 -- Method: window.idlok (flag)

     If `flag' is ‘True’, *note curses: 2c. will try and use hardware
     line editing facilities.  Otherwise, line insertion/deletion are
     disabled.

 -- Method: window.immedok (flag)

     If `flag' is ‘True’, any change in the window image automatically
     causes the window to be refreshed; you no longer have to call *note
     refresh(): 20a5. yourself.  However, it may degrade performance
     considerably, due to repeated calls to wrefresh.  This option is
     disabled by default.

 -- Method: window.inch ([y, x])

     Return the character at the given position in the window.  The
     bottom 8 bits are the character proper, and upper bits are the
     attributes.

 -- Method: window.insch (ch[, attr])

 -- Method: window.insch (y, x, ch[, attr])

     Paint character `ch' at ‘(y, x)’ with attributes `attr', moving the
     line from position `x' right by one character.

 -- Method: window.insdelln (nlines)

     Insert `nlines' lines into the specified window above the current
     line.  The `nlines' bottom lines are lost.  For negative `nlines',
     delete `nlines' lines starting with the one under the cursor, and
     move the remaining lines up.  The bottom `nlines' lines are
     cleared.  The current cursor position remains the same.

 -- Method: window.insertln ()

     Insert a blank line under the cursor.  All following lines are
     moved down by one line.

 -- Method: window.insnstr (str, n[, attr])

 -- Method: window.insnstr (y, x, str, n[, attr])

     Insert a character string (as many characters as will fit on the
     line) before the character under the cursor, up to `n' characters.
     If `n' is zero or negative, the entire string is inserted.  All
     characters to the right of the cursor are shifted right, with the
     rightmost characters on the line being lost.  The cursor position
     does not change (after moving to `y', `x', if specified).

 -- Method: window.insstr (str[, attr])

 -- Method: window.insstr (y, x, str[, attr])

     Insert a character string (as many characters as will fit on the
     line) before the character under the cursor.  All characters to the
     right of the cursor are shifted right, with the rightmost
     characters on the line being lost.  The cursor position does not
     change (after moving to `y', `x', if specified).

 -- Method: window.instr ([n])

 -- Method: window.instr (y, x[, n])

     Return a bytes object of characters, extracted from the window
     starting at the current cursor position, or at `y', `x' if
     specified.  Attributes are stripped from the characters.  If `n' is
     specified, *note instr(): 210a. returns a string at most `n'
     characters long (exclusive of the trailing NUL).

 -- Method: window.is_linetouched (line)

     Return ‘True’ if the specified line was modified since the last
     call to *note refresh(): 20a5.; otherwise return ‘False’.  Raise a
     *note curses.error: 2093. exception if `line' is not valid for the
     given window.

 -- Method: window.is_wintouched ()

     Return ‘True’ if the specified window was modified since the last
     call to *note refresh(): 20a5.; otherwise return ‘False’.

 -- Method: window.keypad (flag)

     If `flag' is ‘True’, escape sequences generated by some keys
     (keypad, function keys) will be interpreted by *note curses: 2c.
     If `flag' is ‘False’, escape sequences will be left as is in the
     input stream.

 -- Method: window.leaveok (flag)

     If `flag' is ‘True’, cursor is left where it is on update, instead
     of being at “cursor position.” This reduces cursor movement where
     possible.  If possible the cursor will be made invisible.

     If `flag' is ‘False’, cursor will always be at “cursor position”
     after an update.

 -- Method: window.move (new_y, new_x)

     Move cursor to ‘(new_y, new_x)’.

 -- Method: window.mvderwin (y, x)

     Move the window inside its parent window.  The screen-relative
     parameters of the window are not changed.  This routine is used to
     display different parts of the parent window at the same physical
     position on the screen.

 -- Method: window.mvwin (new_y, new_x)

     Move the window so its upper-left corner is at ‘(new_y, new_x)’.

 -- Method: window.nodelay (flag)

     If `flag' is ‘True’, *note getch(): 20ae. will be non-blocking.

 -- Method: window.notimeout (flag)

     If `flag' is ‘True’, escape sequences will not be timed out.

     If `flag' is ‘False’, after a few milliseconds, an escape sequence
     will not be interpreted, and will be left in the input stream as
     is.

 -- Method: window.noutrefresh ()

     Mark for refresh but wait.  This function updates the data
     structure representing the desired state of the window, but does
     not force an update of the physical screen.  To accomplish that,
     call *note doupdate(): 20a2.

 -- Method: window.overlay (destwin[, sminrow, smincol, dminrow,
          dmincol, dmaxrow, dmaxcol])

     Overlay the window on top of `destwin'.  The windows need not be
     the same size, only the overlapping region is copied.  This copy is
     non-destructive, which means that the current background character
     does not overwrite the old contents of `destwin'.

     To get fine-grained control over the copied region, the second form
     of *note overlay(): 2113. can be used.  `sminrow' and `smincol' are
     the upper-left coordinates of the source window, and the other
     variables mark a rectangle in the destination window.

 -- Method: window.overwrite (destwin[, sminrow, smincol, dminrow,
          dmincol, dmaxrow, dmaxcol])

     Overwrite the window on top of `destwin'.  The windows need not be
     the same size, in which case only the overlapping region is copied.
     This copy is destructive, which means that the current background
     character overwrites the old contents of `destwin'.

     To get fine-grained control over the copied region, the second form
     of *note overwrite(): 2114. can be used.  `sminrow' and `smincol'
     are the upper-left coordinates of the source window, the other
     variables mark a rectangle in the destination window.

 -- Method: window.putwin (file)

     Write all data associated with the window into the provided file
     object.  This information can be later retrieved using the *note
     getwin(): 20b1. function.

 -- Method: window.redrawln (beg, num)

     Indicate that the `num' screen lines, starting at line `beg', are
     corrupted and should be completely redrawn on the next *note
     refresh(): 20a5. call.

 -- Method: window.redrawwin ()

     Touch the entire window, causing it to be completely redrawn on the
     next *note refresh(): 20a5. call.

 -- Method: window.refresh ([pminrow, pmincol, sminrow, smincol,
          smaxrow, smaxcol])

     Update the display immediately (sync actual screen with previous
     drawing/deleting methods).

     The 6 optional arguments can only be specified when the window is a
     pad created with *note newpad(): 20c5.  The additional parameters
     are needed to indicate what part of the pad and screen are
     involved.  `pminrow' and `pmincol' specify the upper left-hand
     corner of the rectangle to be displayed in the pad.  `sminrow',
     `smincol', `smaxrow', and `smaxcol' specify the edges of the
     rectangle to be displayed on the screen.  The lower right-hand
     corner of the rectangle to be displayed in the pad is calculated
     from the screen coordinates, since the rectangles must be the same
     size.  Both rectangles must be entirely contained within their
     respective structures.  Negative values of `pminrow', `pmincol',
     `sminrow', or `smincol' are treated as if they were zero.

 -- Method: window.resize (nlines, ncols)

     Reallocate storage for a curses window to adjust its dimensions to
     the specified values.  If either dimension is larger than the
     current values, the window’s data is filled with blanks that have
     the current background rendition (as set by *note bkgdset(): 20e8.)
     merged into them.

 -- Method: window.scroll ([lines=1])

     Scroll the screen or scrolling region upward by `lines' lines.

 -- Method: window.scrollok (flag)

     Control what happens when the cursor of a window is moved off the
     edge of the window or scrolling region, either as a result of a
     newline action on the bottom line, or typing the last character of
     the last line.  If `flag' is ‘False’, the cursor is left on the
     bottom line.  If `flag' is ‘True’, the window is scrolled up one
     line.  Note that in order to get the physical scrolling effect on
     the terminal, it is also necessary to call *note idlok(): 2102.

 -- Method: window.setscrreg (top, bottom)

     Set the scrolling region from line `top' to line `bottom'.  All
     scrolling actions will take place in this region.

 -- Method: window.standend ()

     Turn off the standout attribute.  On some terminals this has the
     side effect of turning off all attributes.

 -- Method: window.standout ()

     Turn on attribute `A_STANDOUT'.

 -- Method: window.subpad (begin_y, begin_x)

 -- Method: window.subpad (nlines, ncols, begin_y, begin_x)

     Return a sub-window, whose upper-left corner is at ‘(begin_y,
     begin_x)’, and whose width/height is `ncols'/`nlines'.

 -- Method: window.subwin (begin_y, begin_x)

 -- Method: window.subwin (nlines, ncols, begin_y, begin_x)

     Return a sub-window, whose upper-left corner is at ‘(begin_y,
     begin_x)’, and whose width/height is `ncols'/`nlines'.

     By default, the sub-window will extend from the specified position
     to the lower right corner of the window.

 -- Method: window.syncdown ()

     Touch each location in the window that has been touched in any of
     its ancestor windows.  This routine is called by *note refresh():
     20a5, so it should almost never be necessary to call it manually.

 -- Method: window.syncok (flag)

     If `flag' is ‘True’, then *note syncup(): 2121. is called
     automatically whenever there is a change in the window.

 -- Method: window.syncup ()

     Touch all locations in ancestors of the window that have been
     changed in the window.

 -- Method: window.timeout (delay)

     Set blocking or non-blocking read behavior for the window.  If
     `delay' is negative, blocking read is used (which will wait
     indefinitely for input).  If `delay' is zero, then non-blocking
     read is used, and *note getch(): 20ae. will return ‘-1’ if no input
     is waiting.  If `delay' is positive, then *note getch(): 20ae. will
     block for `delay' milliseconds, and return ‘-1’ if there is still
     no input at the end of that time.

 -- Method: window.touchline (start, count[, changed])

     Pretend `count' lines have been changed, starting with line
     `start'.  If `changed' is supplied, it specifies whether the
     affected lines are marked as having been changed (`changed'‘=True’)
     or unchanged (`changed'‘=False’).

 -- Method: window.touchwin ()

     Pretend the whole window has been changed, for purposes of drawing
     optimizations.

 -- Method: window.untouchwin ()

     Mark all lines in the window as unchanged since the last call to
     *note refresh(): 20a5.

 -- Method: window.vline (ch, n)

 -- Method: window.vline (y, x, ch, n)

     Display a vertical line starting at ‘(y, x)’ with length `n'
     consisting of the character `ch'.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue35924


File: python.info,  Node: Constants<6>,  Prev: Window Objects,  Up: curses — Terminal handling for character-cell displays

5.16.10.3 Constants
...................

The *note curses: 2c. module defines the following data members:

 -- Data: curses.ERR

     Some curses routines that return an integer, such as *note getch():
     20ae, return *note ERR: 2127. upon failure.

 -- Data: curses.OK

     Some curses routines that return an integer, such as *note napms():
     20c4, return *note OK: 2128. upon success.

 -- Data: curses.version

     A bytes object representing the current version of the module.
     Also available as ‘__version__’.

 -- Data: curses.ncurses_version

     A named tuple containing the three components of the ncurses
     library version: `major', `minor', and `patch'.  All values are
     integers.  The components can also be accessed by name, so
     ‘curses.ncurses_version[0]’ is equivalent to
     ‘curses.ncurses_version.major’ and so on.

     Availability: if the ncurses library is used.

     New in version 3.8.

Some constants are available to specify character cell attributes.  The
exact constants available are system dependent.

Attribute              Meaning
                       
-----------------------------------------------------------
                       
‘A_ALTCHARSET’         Alternate character set mode
                       
                       
‘A_BLINK’              Blink mode
                       
                       
‘A_BOLD’               Bold mode
                       
                       
‘A_DIM’                Dim mode
                       
                       
‘A_INVIS’              Invisible or blank mode
                       
                       
‘A_ITALIC’             Italic mode
                       
                       
‘A_NORMAL’             Normal attribute
                       
                       
‘A_PROTECT’            Protected mode
                       
                       
‘A_REVERSE’            Reverse background and foreground
                       colors
                       
                       
‘A_STANDOUT’           Standout mode
                       
                       
‘A_UNDERLINE’          Underline mode
                       
                       
‘A_HORIZONTAL’         Horizontal highlight
                       
                       
‘A_LEFT’               Left highlight
                       
                       
‘A_LOW’                Low highlight
                       
                       
‘A_RIGHT’              Right highlight
                       
                       
‘A_TOP’                Top highlight
                       
                       
‘A_VERTICAL’           Vertical highlight
                       
                       
‘A_CHARTEXT’           Bit-mask to extract a character
                       

New in version 3.7: ‘A_ITALIC’ was added.

Several constants are available to extract corresponding attributes
returned by some methods.

Bit-mask               Meaning
                       
-----------------------------------------------------------
                       
‘A_ATTRIBUTES’         Bit-mask to extract attributes
                       
                       
‘A_CHARTEXT’           Bit-mask to extract a character
                       
                       
‘A_COLOR’              Bit-mask to extract color-pair
                       field information
                       

Keys are referred to by integer constants with names starting with
‘KEY_’.  The exact keycaps available are system dependent.

Key constant            Key
                        
-------------------------------------------------------------------------
                        
‘KEY_MIN’               Minimum key value
                        
                        
‘KEY_BREAK’             Break key (unreliable)
                        
                        
‘KEY_DOWN’              Down-arrow
                        
                        
‘KEY_UP’                Up-arrow
                        
                        
‘KEY_LEFT’              Left-arrow
                        
                        
‘KEY_RIGHT’             Right-arrow
                        
                        
‘KEY_HOME’              Home key (upward+left arrow)
                        
                        
‘KEY_BACKSPACE’         Backspace (unreliable)
                        
                        
‘KEY_F0’                Function keys.  Up to 64 function keys are
                        supported.
                        
                        
‘KEY_Fn’                Value of function key `n'
                        
                        
‘KEY_DL’                Delete line
                        
                        
‘KEY_IL’                Insert line
                        
                        
‘KEY_DC’                Delete character
                        
                        
‘KEY_IC’                Insert char or enter insert mode
                        
                        
‘KEY_EIC’               Exit insert char mode
                        
                        
‘KEY_CLEAR’             Clear screen
                        
                        
‘KEY_EOS’               Clear to end of screen
                        
                        
‘KEY_EOL’               Clear to end of line
                        
                        
‘KEY_SF’                Scroll 1 line forward
                        
                        
‘KEY_SR’                Scroll 1 line backward (reverse)
                        
                        
‘KEY_NPAGE’             Next page
                        
                        
‘KEY_PPAGE’             Previous page
                        
                        
‘KEY_STAB’              Set tab
                        
                        
‘KEY_CTAB’              Clear tab
                        
                        
‘KEY_CATAB’             Clear all tabs
                        
                        
‘KEY_ENTER’             Enter or send (unreliable)
                        
                        
‘KEY_SRESET’            Soft (partial) reset (unreliable)
                        
                        
‘KEY_RESET’             Reset or hard reset (unreliable)
                        
                        
‘KEY_PRINT’             Print
                        
                        
‘KEY_LL’                Home down or bottom (lower left)
                        
                        
‘KEY_A1’                Upper left of keypad
                        
                        
‘KEY_A3’                Upper right of keypad
                        
                        
‘KEY_B2’                Center of keypad
                        
                        
‘KEY_C1’                Lower left of keypad
                        
                        
‘KEY_C3’                Lower right of keypad
                        
                        
‘KEY_BTAB’              Back tab
                        
                        
‘KEY_BEG’               Beg (beginning)
                        
                        
‘KEY_CANCEL’            Cancel
                        
                        
‘KEY_CLOSE’             Close
                        
                        
‘KEY_COMMAND’           Cmd (command)
                        
                        
‘KEY_COPY’              Copy
                        
                        
‘KEY_CREATE’            Create
                        
                        
‘KEY_END’               End
                        
                        
‘KEY_EXIT’              Exit
                        
                        
‘KEY_FIND’              Find
                        
                        
‘KEY_HELP’              Help
                        
                        
‘KEY_MARK’              Mark
                        
                        
‘KEY_MESSAGE’           Message
                        
                        
‘KEY_MOVE’              Move
                        
                        
‘KEY_NEXT’              Next
                        
                        
‘KEY_OPEN’              Open
                        
                        
‘KEY_OPTIONS’           Options
                        
                        
‘KEY_PREVIOUS’          Prev (previous)
                        
                        
‘KEY_REDO’              Redo
                        
                        
‘KEY_REFERENCE’         Ref (reference)
                        
                        
‘KEY_REFRESH’           Refresh
                        
                        
‘KEY_REPLACE’           Replace
                        
                        
‘KEY_RESTART’           Restart
                        
                        
‘KEY_RESUME’            Resume
                        
                        
‘KEY_SAVE’              Save
                        
                        
‘KEY_SBEG’              Shifted Beg (beginning)
                        
                        
‘KEY_SCANCEL’           Shifted Cancel
                        
                        
‘KEY_SCOMMAND’          Shifted Command
                        
                        
‘KEY_SCOPY’             Shifted Copy
                        
                        
‘KEY_SCREATE’           Shifted Create
                        
                        
‘KEY_SDC’               Shifted Delete char
                        
                        
‘KEY_SDL’               Shifted Delete line
                        
                        
‘KEY_SELECT’            Select
                        
                        
‘KEY_SEND’              Shifted End
                        
                        
‘KEY_SEOL’              Shifted Clear line
                        
                        
‘KEY_SEXIT’             Shifted Exit
                        
                        
‘KEY_SFIND’             Shifted Find
                        
                        
‘KEY_SHELP’             Shifted Help
                        
                        
‘KEY_SHOME’             Shifted Home
                        
                        
‘KEY_SIC’               Shifted Input
                        
                        
‘KEY_SLEFT’             Shifted Left arrow
                        
                        
‘KEY_SMESSAGE’          Shifted Message
                        
                        
‘KEY_SMOVE’             Shifted Move
                        
                        
‘KEY_SNEXT’             Shifted Next
                        
                        
‘KEY_SOPTIONS’          Shifted Options
                        
                        
‘KEY_SPREVIOUS’         Shifted Prev
                        
                        
‘KEY_SPRINT’            Shifted Print
                        
                        
‘KEY_SREDO’             Shifted Redo
                        
                        
‘KEY_SREPLACE’          Shifted Replace
                        
                        
‘KEY_SRIGHT’            Shifted Right arrow
                        
                        
‘KEY_SRSUME’            Shifted Resume
                        
                        
‘KEY_SSAVE’             Shifted Save
                        
                        
‘KEY_SSUSPEND’          Shifted Suspend
                        
                        
‘KEY_SUNDO’             Shifted Undo
                        
                        
‘KEY_SUSPEND’           Suspend
                        
                        
‘KEY_UNDO’              Undo
                        
                        
‘KEY_MOUSE’             Mouse event has occurred
                        
                        
‘KEY_RESIZE’            Terminal resize event
                        
                        
‘KEY_MAX’               Maximum key value
                        

On VT100s and their software emulations, such as X terminal emulators,
there are normally at least four function keys (‘KEY_F1’, ‘KEY_F2’,
‘KEY_F3’, ‘KEY_F4’) available, and the arrow keys mapped to ‘KEY_UP’,
‘KEY_DOWN’, ‘KEY_LEFT’ and ‘KEY_RIGHT’ in the obvious way.  If your
machine has a PC keyboard, it is safe to expect arrow keys and twelve
function keys (older PC keyboards may have only ten function keys);
also, the following keypad mappings are standard:

Keycap                 Constant
                       
---------------------------------------
                       
‘Insert’               KEY_IC
                       
                       
‘Delete’               KEY_DC
                       
                       
‘Home’                 KEY_HOME
                       
                       
‘End’                  KEY_END
                       
                       
‘Page Up’              KEY_PPAGE
                       
                       
‘Page Down’            KEY_NPAGE
                       

The following table lists characters from the alternate character set.
These are inherited from the VT100 terminal, and will generally be
available on software emulations such as X terminals.  When there is no
graphic available, curses falls back on a crude printable ASCII
approximation.

     Note: These are available only after *note initscr(): 20aa. has
     been called.

ACS code               Meaning
                       
----------------------------------------------------------------------
                       
‘ACS_BBSS’             alternate name for upper right corner
                       
                       
‘ACS_BLOCK’            solid square block
                       
                       
‘ACS_BOARD’            board of squares
                       
                       
‘ACS_BSBS’             alternate name for horizontal line
                       
                       
‘ACS_BSSB’             alternate name for upper left corner
                       
                       
‘ACS_BSSS’             alternate name for top tee
                       
                       
‘ACS_BTEE’             bottom tee
                       
                       
‘ACS_BULLET’           bullet
                       
                       
‘ACS_CKBOARD’          checker board (stipple)
                       
                       
‘ACS_DARROW’           arrow pointing down
                       
                       
‘ACS_DEGREE’           degree symbol
                       
                       
‘ACS_DIAMOND’          diamond
                       
                       
‘ACS_GEQUAL’           greater-than-or-equal-to
                       
                       
‘ACS_HLINE’            horizontal line
                       
                       
‘ACS_LANTERN’          lantern symbol
                       
                       
‘ACS_LARROW’           left arrow
                       
                       
‘ACS_LEQUAL’           less-than-or-equal-to
                       
                       
‘ACS_LLCORNER’         lower left-hand corner
                       
                       
‘ACS_LRCORNER’         lower right-hand corner
                       
                       
‘ACS_LTEE’             left tee
                       
                       
‘ACS_NEQUAL’           not-equal sign
                       
                       
‘ACS_PI’               letter pi
                       
                       
‘ACS_PLMINUS’          plus-or-minus sign
                       
                       
‘ACS_PLUS’             big plus sign
                       
                       
‘ACS_RARROW’           right arrow
                       
                       
‘ACS_RTEE’             right tee
                       
                       
‘ACS_S1’               scan line 1
                       
                       
‘ACS_S3’               scan line 3
                       
                       
‘ACS_S7’               scan line 7
                       
                       
‘ACS_S9’               scan line 9
                       
                       
‘ACS_SBBS’             alternate name for lower right corner
                       
                       
‘ACS_SBSB’             alternate name for vertical line
                       
                       
‘ACS_SBSS’             alternate name for right tee
                       
                       
‘ACS_SSBB’             alternate name for lower left corner
                       
                       
‘ACS_SSBS’             alternate name for bottom tee
                       
                       
‘ACS_SSSB’             alternate name for left tee
                       
                       
‘ACS_SSSS’             alternate name for crossover or big plus
                       
                       
‘ACS_STERLING’         pound sterling
                       
                       
‘ACS_TTEE’             top tee
                       
                       
‘ACS_UARROW’           up arrow
                       
                       
‘ACS_ULCORNER’         upper left corner
                       
                       
‘ACS_URCORNER’         upper right corner
                       
                       
‘ACS_VLINE’            vertical line
                       

The following table lists the predefined colors:

Constant                Color
                        
---------------------------------------------------------
                        
‘COLOR_BLACK’           Black
                        
                        
‘COLOR_BLUE’            Blue
                        
                        
‘COLOR_CYAN’            Cyan (light greenish blue)
                        
                        
‘COLOR_GREEN’           Green
                        
                        
‘COLOR_MAGENTA’         Magenta (purplish red)
                        
                        
‘COLOR_RED’             Red
                        
                        
‘COLOR_WHITE’           White
                        
                        
‘COLOR_YELLOW’          Yellow
                        


File: python.info,  Node: curses textpad — Text input widget for curses programs,  Next: curses ascii — Utilities for ASCII characters,  Prev: curses — Terminal handling for character-cell displays,  Up: Generic Operating System Services

5.16.11 ‘curses.textpad’ — Text input widget for curses programs
----------------------------------------------------------------

The *note curses.textpad: 2f. module provides a *note Textbox: 212b.
class that handles elementary text editing in a curses window,
supporting a set of keybindings resembling those of Emacs (thus, also of
Netscape Navigator, BBedit 6.x, FrameMaker, and many other programs).
The module also provides a rectangle-drawing function useful for framing
text boxes or for other purposes.

The module *note curses.textpad: 2f. defines the following function:

 -- Function: curses.textpad.rectangle (win, uly, ulx, lry, lrx)

     Draw a rectangle.  The first argument must be a window object; the
     remaining arguments are coordinates relative to that window.  The
     second and third arguments are the y and x coordinates of the upper
     left hand corner of the rectangle to be drawn; the fourth and fifth
     arguments are the y and x coordinates of the lower right hand
     corner.  The rectangle will be drawn using VT100/IBM PC forms
     characters on terminals that make this possible (including xterm
     and most other software terminal emulators).  Otherwise it will be
     drawn with ASCII dashes, vertical bars, and plus signs.

* Menu:

* Textbox objects::


File: python.info,  Node: Textbox objects,  Up: curses textpad — Text input widget for curses programs

5.16.11.1 Textbox objects
.........................

You can instantiate a *note Textbox: 212b. object as follows:

 -- Class: curses.textpad.Textbox (win)

     Return a textbox widget object.  The `win' argument should be a
     curses *note window: 20ba. object in which the textbox is to be
     contained.  The edit cursor of the textbox is initially located at
     the upper left hand corner of the containing window, with
     coordinates ‘(0, 0)’.  The instance’s *note stripspaces: 212f. flag
     is initially on.

     *note Textbox: 212b. objects have the following methods:

      -- Method: edit ([validator])

          This is the entry point you will normally use.  It accepts
          editing keystrokes until one of the termination keystrokes is
          entered.  If `validator' is supplied, it must be a function.
          It will be called for each keystroke entered with the
          keystroke as a parameter; command dispatch is done on the
          result.  This method returns the window contents as a string;
          whether blanks in the window are included is affected by the
          *note stripspaces: 212f. attribute.

      -- Method: do_command (ch)

          Process a single command keystroke.  Here are the supported
          special keystrokes:

          Keystroke              Action
                                 
          -----------------------------------------------------------------------
                                 
          ‘Control-A’            Go to left edge of window.
                                 
                                 
          ‘Control-B’            Cursor left, wrapping to previous line if
                                 appropriate.
                                 
                                 
          ‘Control-D’            Delete character under cursor.
                                 
                                 
          ‘Control-E’            Go to right edge (stripspaces off) or end of
                                 line (stripspaces on).
                                 
                                 
          ‘Control-F’            Cursor right, wrapping to next line when
                                 appropriate.
                                 
                                 
          ‘Control-G’            Terminate, returning the window contents.
                                 
                                 
          ‘Control-H’            Delete character backward.
                                 
                                 
          ‘Control-J’            Terminate if the window is 1 line, otherwise
                                 insert newline.
                                 
                                 
          ‘Control-K’            If line is blank, delete it, otherwise clear
                                 to end of line.
                                 
                                 
          ‘Control-L’            Refresh screen.
                                 
                                 
          ‘Control-N’            Cursor down; move down one line.
                                 
                                 
          ‘Control-O’            Insert a blank line at cursor location.
                                 
                                 
          ‘Control-P’            Cursor up; move up one line.
                                 

          Move operations do nothing if the cursor is at an edge where
          the movement is not possible.  The following synonyms are
          supported where possible:

          Constant                     Keystroke
                                       
          ----------------------------------------------------
                                       
          ‘KEY_LEFT’                   ‘Control-B’
                                       
                                       
          ‘KEY_RIGHT’                  ‘Control-F’
                                       
                                       
          ‘KEY_UP’                     ‘Control-P’
                                       
                                       
          ‘KEY_DOWN’                   ‘Control-N’
                                       
                                       
          ‘KEY_BACKSPACE’              ‘Control-h’
                                       

          All other keystrokes are treated as a command to insert the
          given character and move right (with line wrapping).

      -- Method: gather ()

          Return the window contents as a string; whether blanks in the
          window are included is affected by the *note stripspaces:
          212f. member.

      -- Attribute: stripspaces

          This attribute is a flag which controls the interpretation of
          blanks in the window.  When it is on, trailing blanks on each
          line are ignored; any cursor motion that would land the cursor
          on a trailing blank goes to the end of that line instead, and
          trailing blanks are stripped when the window contents are
          gathered.


File: python.info,  Node: curses ascii — Utilities for ASCII characters,  Next: curses panel — A panel stack extension for curses,  Prev: curses textpad — Text input widget for curses programs,  Up: Generic Operating System Services

5.16.12 ‘curses.ascii’ — Utilities for ASCII characters
-------------------------------------------------------

__________________________________________________________________

The *note curses.ascii: 2d. module supplies name constants for ASCII
characters and functions to test membership in various ASCII character
classes.  The constants supplied are names for control characters as
follows:

Name               Meaning
                   
----------------------------------------------------------------------
                   
‘NUL’

‘SOH’              Start of heading, console interrupt
                   
                   
‘STX’              Start of text
                   
                   
‘ETX’              End of text
                   
                   
‘EOT’              End of transmission
                   
                   
‘ENQ’              Enquiry, goes with ‘ACK’ flow control
                   
                   
‘ACK’              Acknowledgement
                   
                   
‘BEL’              Bell
                   
                   
‘BS’               Backspace
                   
                   
‘TAB’              Tab
                   
                   
‘HT’               Alias for ‘TAB’: “Horizontal tab”
                   
                   
‘LF’               Line feed
                   
                   
‘NL’               Alias for ‘LF’: “New line”
                   
                   
‘VT’               Vertical tab
                   
                   
‘FF’               Form feed
                   
                   
‘CR’               Carriage return
                   
                   
‘SO’               Shift-out, begin alternate character set
                   
                   
‘SI’               Shift-in, resume default character set
                   
                   
‘DLE’              Data-link escape
                   
                   
‘DC1’              XON, for flow control
                   
                   
‘DC2’              Device control 2, block-mode flow control
                   
                   
‘DC3’              XOFF, for flow control
                   
                   
‘DC4’              Device control 4
                   
                   
‘NAK’              Negative acknowledgement
                   
                   
‘SYN’              Synchronous idle
                   
                   
‘ETB’              End transmission block
                   
                   
‘CAN’              Cancel
                   
                   
‘EM’               End of medium
                   
                   
‘SUB’              Substitute
                   
                   
‘ESC’              Escape
                   
                   
‘FS’               File separator
                   
                   
‘GS’               Group separator
                   
                   
‘RS’               Record separator, block-mode terminator
                   
                   
‘US’               Unit separator
                   
                   
‘SP’               Space
                   
                   
‘DEL’              Delete
                   

Note that many of these have little practical significance in modern
usage.  The mnemonics derive from teleprinter conventions that predate
digital computers.

The module supplies the following functions, patterned on those in the
standard C library:

 -- Function: curses.ascii.isalnum (c)

     Checks for an ASCII alphanumeric character; it is equivalent to
     ‘isalpha(c) or isdigit(c)’.

 -- Function: curses.ascii.isalpha (c)

     Checks for an ASCII alphabetic character; it is equivalent to
     ‘isupper(c) or islower(c)’.

 -- Function: curses.ascii.isascii (c)

     Checks for a character value that fits in the 7-bit ASCII set.

 -- Function: curses.ascii.isblank (c)

     Checks for an ASCII whitespace character; space or horizontal tab.

 -- Function: curses.ascii.iscntrl (c)

     Checks for an ASCII control character (in the range 0x00 to 0x1f or
     0x7f).

 -- Function: curses.ascii.isdigit (c)

     Checks for an ASCII decimal digit, ‘'0'’ through ‘'9'’.  This is
     equivalent to ‘c in string.digits’.

 -- Function: curses.ascii.isgraph (c)

     Checks for ASCII any printable character except space.

 -- Function: curses.ascii.islower (c)

     Checks for an ASCII lower-case character.

 -- Function: curses.ascii.isprint (c)

     Checks for any ASCII printable character including space.

 -- Function: curses.ascii.ispunct (c)

     Checks for any printable ASCII character which is not a space or an
     alphanumeric character.

 -- Function: curses.ascii.isspace (c)

     Checks for ASCII white-space characters; space, line feed, carriage
     return, form feed, horizontal tab, vertical tab.

 -- Function: curses.ascii.isupper (c)

     Checks for an ASCII uppercase letter.

 -- Function: curses.ascii.isxdigit (c)

     Checks for an ASCII hexadecimal digit.  This is equivalent to ‘c in
     string.hexdigits’.

 -- Function: curses.ascii.isctrl (c)

     Checks for an ASCII control character (ordinal values 0 to 31).

 -- Function: curses.ascii.ismeta (c)

     Checks for a non-ASCII character (ordinal values 0x80 and above).

These functions accept either integers or single-character strings; when
the argument is a string, it is first converted using the built-in
function *note ord(): 1362.

Note that all these functions check ordinal bit values derived from the
character of the string you pass in; they do not actually know anything
about the host machine’s character encoding.

The following two functions take either a single-character string or
integer byte value; they return a value of the same type.

 -- Function: curses.ascii.ascii (c)

     Return the ASCII value corresponding to the low 7 bits of `c'.

 -- Function: curses.ascii.ctrl (c)

     Return the control character corresponding to the given character
     (the character bit value is bitwise-anded with 0x1f).

 -- Function: curses.ascii.alt (c)

     Return the 8-bit character corresponding to the given ASCII
     character (the character bit value is bitwise-ored with 0x80).

The following function takes either a single-character string or integer
value; it returns a string.

 -- Function: curses.ascii.unctrl (c)

     Return a string representation of the ASCII character `c'.  If `c'
     is printable, this string is the character itself.  If the
     character is a control character (0x00–0x1f) the string consists of
     a caret (‘'^'’) followed by the corresponding uppercase letter.  If
     the character is an ASCII delete (0x7f) the string is ‘'^?'’.  If
     the character has its meta bit (0x80) set, the meta bit is
     stripped, the preceding rules applied, and ‘'!'’ prepended to the
     result.

 -- Data: curses.ascii.controlnames

     A 33-element string array that contains the ASCII mnemonics for the
     thirty-two ASCII control characters from 0 (NUL) to 0x1f (US), in
     order, plus the mnemonic ‘SP’ for the space character.


File: python.info,  Node: curses panel — A panel stack extension for curses,  Next: platform — Access to underlying platform’s identifying data,  Prev: curses ascii — Utilities for ASCII characters,  Up: Generic Operating System Services

5.16.13 ‘curses.panel’ — A panel stack extension for curses
-----------------------------------------------------------

__________________________________________________________________

Panels are windows with the added feature of depth, so they can be
stacked on top of each other, and only the visible portions of each
window will be displayed.  Panels can be added, moved up or down in the
stack, and removed.

* Menu:

* Functions: Functions<4>.
* Panel Objects::


File: python.info,  Node: Functions<4>,  Next: Panel Objects,  Up: curses panel — A panel stack extension for curses

5.16.13.1 Functions
...................

The module *note curses.panel: 2e. defines the following functions:

 -- Function: curses.panel.bottom_panel ()

     Returns the bottom panel in the panel stack.

 -- Function: curses.panel.new_panel (win)

     Returns a panel object, associating it with the given window `win'.
     Be aware that you need to keep the returned panel object referenced
     explicitly.  If you don’t, the panel object is garbage collected
     and removed from the panel stack.

 -- Function: curses.panel.top_panel ()

     Returns the top panel in the panel stack.

 -- Function: curses.panel.update_panels ()

     Updates the virtual screen after changes in the panel stack.  This
     does not call *note curses.doupdate(): 20a2, so you’ll have to do
     this yourself.


File: python.info,  Node: Panel Objects,  Prev: Functions<4>,  Up: curses panel — A panel stack extension for curses

5.16.13.2 Panel Objects
.......................

Panel objects, as returned by *note new_panel(): 214e. above, are
windows with a stacking order.  There’s always a window associated with
a panel which determines the content, while the panel methods are
responsible for the window’s depth in the panel stack.

Panel objects have the following methods:

 -- Method: Panel.above ()

     Returns the panel above the current panel.

 -- Method: Panel.below ()

     Returns the panel below the current panel.

 -- Method: Panel.bottom ()

     Push the panel to the bottom of the stack.

 -- Method: Panel.hidden ()

     Returns ‘True’ if the panel is hidden (not visible), ‘False’
     otherwise.

 -- Method: Panel.hide ()

     Hide the panel.  This does not delete the object, it just makes the
     window on screen invisible.

 -- Method: Panel.move (y, x)

     Move the panel to the screen coordinates ‘(y, x)’.

 -- Method: Panel.replace (win)

     Change the window associated with the panel to the window `win'.

 -- Method: Panel.set_userptr (obj)

     Set the panel’s user pointer to `obj'.  This is used to associate
     an arbitrary piece of data with the panel, and can be any Python
     object.

 -- Method: Panel.show ()

     Display the panel (which might have been hidden).

 -- Method: Panel.top ()

     Push panel to the top of the stack.

 -- Method: Panel.userptr ()

     Returns the user pointer for the panel.  This might be any Python
     object.

 -- Method: Panel.window ()

     Returns the window object associated with the panel.


File: python.info,  Node: platform — Access to underlying platform’s identifying data,  Next: errno — Standard errno system symbols,  Prev: curses panel — A panel stack extension for curses,  Up: Generic Operating System Services

5.16.14 ‘platform’ — Access to underlying platform’s identifying data
---------------------------------------------------------------------

`Source code:' Lib/platform.py(1)

__________________________________________________________________

     Note: Specific platforms listed alphabetically, with Linux included
     in the Unix section.

* Menu:

* Cross Platform::
* Java Platform::
* Windows Platform::
* Mac OS Platform::
* Unix Platforms::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/platform.py


File: python.info,  Node: Cross Platform,  Next: Java Platform,  Up: platform — Access to underlying platform’s identifying data

5.16.14.1 Cross Platform
........................

 -- Function: platform.architecture (executable=sys.executable, bits='',
          linkage='')

     Queries the given executable (defaults to the Python interpreter
     binary) for various architecture information.

     Returns a tuple ‘(bits, linkage)’ which contain information about
     the bit architecture and the linkage format used for the
     executable.  Both values are returned as strings.

     Values that cannot be determined are returned as given by the
     parameter presets.  If bits is given as ‘''’, the ‘sizeof(pointer)’
     (or ‘sizeof(long)’ on Python version < 1.5.2) is used as indicator
     for the supported pointer size.

     The function relies on the system’s ‘file’ command to do the actual
     work.  This is available on most if not all Unix platforms and some
     non-Unix platforms and then only if the executable points to the
     Python interpreter.  Reasonable defaults are used when the above
     needs are not met.

          Note: On Mac OS X (and perhaps other platforms), executable
          files may be universal files containing multiple
          architectures.

          To get at the “64-bitness” of the current interpreter, it is
          more reliable to query the *note sys.maxsize: b36. attribute:

               is_64bits = sys.maxsize > 2**32

 -- Function: platform.machine ()

     Returns the machine type, e.g.  ‘'i386'’.  An empty string is
     returned if the value cannot be determined.

 -- Function: platform.node ()

     Returns the computer’s network name (may not be fully qualified!).
     An empty string is returned if the value cannot be determined.

 -- Function: platform.platform (aliased=0, terse=0)

     Returns a single string identifying the underlying platform with as
     much useful information as possible.

     The output is intended to be `human readable' rather than machine
     parseable.  It may look different on different platforms and this
     is intended.

     If `aliased' is true, the function will use aliases for various
     platforms that report system names which differ from their common
     names, for example SunOS will be reported as Solaris.  The *note
     system_alias(): 2164. function is used to implement this.

     Setting `terse' to true causes the function to return only the
     absolute minimum information needed to identify the platform.

     Changed in version 3.8: On macOS, the function now uses *note
     mac_ver(): f54, if it returns a non-empty release string, to get
     the macOS version rather than the darwin version.

 -- Function: platform.processor ()

     Returns the (real) processor name, e.g.  ‘'amdk6'’.

     An empty string is returned if the value cannot be determined.
     Note that many platforms do not provide this information or simply
     return the same value as for *note machine(): 2162.  NetBSD does
     this.

 -- Function: platform.python_build ()

     Returns a tuple ‘(buildno, builddate)’ stating the Python build
     number and date as strings.

 -- Function: platform.python_compiler ()

     Returns a string identifying the compiler used for compiling
     Python.

 -- Function: platform.python_branch ()

     Returns a string identifying the Python implementation SCM branch.

 -- Function: platform.python_implementation ()

     Returns a string identifying the Python implementation.  Possible
     return values are: ‘CPython’, ‘IronPython’, ‘Jython’, ‘PyPy’.

 -- Function: platform.python_revision ()

     Returns a string identifying the Python implementation SCM
     revision.

 -- Function: platform.python_version ()

     Returns the Python version as string ‘'major.minor.patchlevel'’.

     Note that unlike the Python ‘sys.version’, the returned value will
     always include the patchlevel (it defaults to 0).

 -- Function: platform.python_version_tuple ()

     Returns the Python version as tuple ‘(major, minor, patchlevel)’ of
     strings.

     Note that unlike the Python ‘sys.version’, the returned value will
     always include the patchlevel (it defaults to ‘'0'’).

 -- Function: platform.release ()

     Returns the system’s release, e.g.  ‘'2.2.0'’ or ‘'NT'’ An empty
     string is returned if the value cannot be determined.

 -- Function: platform.system ()

     Returns the system/OS name, e.g.  ‘'Linux'’, ‘'Windows'’, or
     ‘'Java'’.  An empty string is returned if the value cannot be
     determined.

 -- Function: platform.system_alias (system, release, version)

     Returns ‘(system, release, version)’ aliased to common marketing
     names used for some systems.  It also does some reordering of the
     information in some cases where it would otherwise cause confusion.

 -- Function: platform.version ()

     Returns the system’s release version, e.g.  ‘'#3 on degas'’.  An
     empty string is returned if the value cannot be determined.

 -- Function: platform.uname ()

     Fairly portable uname interface.  Returns a *note namedtuple():
     1b5. containing six attributes: *note system: 216e, *note node:
     2163, *note release: 216d, *note version: 216f, *note machine:
     2162, and *note processor: 2165.

     Note that this adds a sixth attribute (*note processor: 2165.) not
     present in the *note os.uname(): a52. result.  Also, the attribute
     names are different for the first two attributes; *note os.uname():
     a52. names them ‘sysname’ and ‘nodename’.

     Entries which cannot be determined are set to ‘''’.

     Changed in version 3.3: Result changed from a tuple to a
     namedtuple.


File: python.info,  Node: Java Platform,  Next: Windows Platform,  Prev: Cross Platform,  Up: platform — Access to underlying platform’s identifying data

5.16.14.2 Java Platform
.......................

 -- Function: platform.java_ver (release='', vendor='', vminfo=('', '',
          ''), osinfo=('', '', ''))

     Version interface for Jython.

     Returns a tuple ‘(release, vendor, vminfo, osinfo)’ with `vminfo'
     being a tuple ‘(vm_name, vm_release, vm_vendor)’ and `osinfo' being
     a tuple ‘(os_name, os_version, os_arch)’.  Values which cannot be
     determined are set to the defaults given as parameters (which all
     default to ‘''’).


File: python.info,  Node: Windows Platform,  Next: Mac OS Platform,  Prev: Java Platform,  Up: platform — Access to underlying platform’s identifying data

5.16.14.3 Windows Platform
..........................

 -- Function: platform.win32_ver (release='', version='', csd='',
          ptype='')

     Get additional version information from the Windows Registry and
     return a tuple ‘(release, version, csd, ptype)’ referring to OS
     release, version number, CSD level (service pack) and OS type
     (multi/single processor).

     As a hint: `ptype' is ‘'Uniprocessor Free'’ on single processor NT
     machines and ‘'Multiprocessor Free'’ on multi processor machines.
     The `‘Free’' refers to the OS version being free of debugging code.
     It could also state `‘Checked’' which means the OS version uses
     debugging code, i.e.  code that checks arguments, ranges, etc.

          Note: This function works best with Mark Hammond’s ‘win32all’
          package installed, but also on Python 2.3 and later (support
          for this was added in Python 2.6).  It obviously only runs on
          Win32 compatible platforms.

 -- Function: platform.win32_edition ()

     Returns a string representing the current Windows edition.
     Possible values include but are not limited to ‘'Enterprise'’,
     ‘'IoTUAP'’, ‘'ServerStandard'’, and ‘'nanoserver'’.

     New in version 3.8.

 -- Function: platform.win32_is_iot ()

     Return ‘True’ if the Windows edition returned by *note
     win32_edition(): 2174. is recognized as an IoT edition.

     New in version 3.8.


File: python.info,  Node: Mac OS Platform,  Next: Unix Platforms,  Prev: Windows Platform,  Up: platform — Access to underlying platform’s identifying data

5.16.14.4 Mac OS Platform
.........................

 -- Function: platform.mac_ver (release='', versioninfo=('', '', ''),
          machine='')

     Get Mac OS version information and return it as tuple ‘(release,
     versioninfo, machine)’ with `versioninfo' being a tuple ‘(version,
     dev_stage, non_release_version)’.

     Entries which cannot be determined are set to ‘''’.  All tuple
     entries are strings.


File: python.info,  Node: Unix Platforms,  Prev: Mac OS Platform,  Up: platform — Access to underlying platform’s identifying data

5.16.14.5 Unix Platforms
........................

 -- Function: platform.libc_ver (executable=sys.executable, lib='',
          version='', chunksize=16384)

     Tries to determine the libc version against which the file
     executable (defaults to the Python interpreter) is linked.  Returns
     a tuple of strings ‘(lib, version)’ which default to the given
     parameters in case the lookup fails.

     Note that this function has intimate knowledge of how different
     libc versions add symbols to the executable is probably only usable
     for executables compiled using ‘gcc’.

     The file is read and scanned in chunks of `chunksize' bytes.


File: python.info,  Node: errno — Standard errno system symbols,  Next: ctypes — A foreign function library for Python,  Prev: platform — Access to underlying platform’s identifying data,  Up: Generic Operating System Services

5.16.15 ‘errno’ — Standard errno system symbols
-----------------------------------------------

__________________________________________________________________

This module makes available standard ‘errno’ system symbols.  The value
of each symbol is the corresponding integer value.  The names and
descriptions are borrowed from ‘linux/include/errno.h’, which should be
pretty all-inclusive.

 -- Data: errno.errorcode

     Dictionary providing a mapping from the errno value to the string
     name in the underlying system.  For instance,
     ‘errno.errorcode[errno.EPERM]’ maps to ‘'EPERM'’.

To translate a numeric error code to an error message, use *note
os.strerror(): 1e3f.

Of the following list, symbols that are not used on the current platform
are not defined by the module.  The specific list of defined symbols is
available as ‘errno.errorcode.keys()’.  Symbols available can include:

 -- Data: errno.EPERM

     Operation not permitted

 -- Data: errno.ENOENT

     No such file or directory

 -- Data: errno.ESRCH

     No such process

 -- Data: errno.EINTR

     Interrupted system call.

     See also
     ........

     This error is mapped to the exception *note InterruptedError: 64d.

 -- Data: errno.EIO

     I/O error

 -- Data: errno.ENXIO

     No such device or address

 -- Data: errno.E2BIG

     Arg list too long

 -- Data: errno.ENOEXEC

     Exec format error

 -- Data: errno.EBADF

     Bad file number

 -- Data: errno.ECHILD

     No child processes

 -- Data: errno.EAGAIN

     Try again

 -- Data: errno.ENOMEM

     Out of memory

 -- Data: errno.EACCES

     Permission denied

 -- Data: errno.EFAULT

     Bad address

 -- Data: errno.ENOTBLK

     Block device required

 -- Data: errno.EBUSY

     Device or resource busy

 -- Data: errno.EEXIST

     File exists

 -- Data: errno.EXDEV

     Cross-device link

 -- Data: errno.ENODEV

     No such device

 -- Data: errno.ENOTDIR

     Not a directory

 -- Data: errno.EISDIR

     Is a directory

 -- Data: errno.EINVAL

     Invalid argument

 -- Data: errno.ENFILE

     File table overflow

 -- Data: errno.EMFILE

     Too many open files

 -- Data: errno.ENOTTY

     Not a typewriter

 -- Data: errno.ETXTBSY

     Text file busy

 -- Data: errno.EFBIG

     File too large

 -- Data: errno.ENOSPC

     No space left on device

 -- Data: errno.ESPIPE

     Illegal seek

 -- Data: errno.EROFS

     Read-only file system

 -- Data: errno.EMLINK

     Too many links

 -- Data: errno.EPIPE

     Broken pipe

 -- Data: errno.EDOM

     Math argument out of domain of func

 -- Data: errno.ERANGE

     Math result not representable

 -- Data: errno.EDEADLK

     Resource deadlock would occur

 -- Data: errno.ENAMETOOLONG

     File name too long

 -- Data: errno.ENOLCK

     No record locks available

 -- Data: errno.ENOSYS

     Function not implemented

 -- Data: errno.ENOTEMPTY

     Directory not empty

 -- Data: errno.ELOOP

     Too many symbolic links encountered

 -- Data: errno.EWOULDBLOCK

     Operation would block

 -- Data: errno.ENOMSG

     No message of desired type

 -- Data: errno.EIDRM

     Identifier removed

 -- Data: errno.ECHRNG

     Channel number out of range

 -- Data: errno.EL2NSYNC

     Level 2 not synchronized

 -- Data: errno.EL3HLT

     Level 3 halted

 -- Data: errno.EL3RST

     Level 3 reset

 -- Data: errno.ELNRNG

     Link number out of range

 -- Data: errno.EUNATCH

     Protocol driver not attached

 -- Data: errno.ENOCSI

     No CSI structure available

 -- Data: errno.EL2HLT

     Level 2 halted

 -- Data: errno.EBADE

     Invalid exchange

 -- Data: errno.EBADR

     Invalid request descriptor

 -- Data: errno.EXFULL

     Exchange full

 -- Data: errno.ENOANO

     No anode

 -- Data: errno.EBADRQC

     Invalid request code

 -- Data: errno.EBADSLT

     Invalid slot

 -- Data: errno.EDEADLOCK

     File locking deadlock error

 -- Data: errno.EBFONT

     Bad font file format

 -- Data: errno.ENOSTR

     Device not a stream

 -- Data: errno.ENODATA

     No data available

 -- Data: errno.ETIME

     Timer expired

 -- Data: errno.ENOSR

     Out of streams resources

 -- Data: errno.ENONET

     Machine is not on the network

 -- Data: errno.ENOPKG

     Package not installed

 -- Data: errno.EREMOTE

     Object is remote

 -- Data: errno.ENOLINK

     Link has been severed

 -- Data: errno.EADV

     Advertise error

 -- Data: errno.ESRMNT

     Srmount error

 -- Data: errno.ECOMM

     Communication error on send

 -- Data: errno.EPROTO

     Protocol error

 -- Data: errno.EMULTIHOP

     Multihop attempted

 -- Data: errno.EDOTDOT

     RFS specific error

 -- Data: errno.EBADMSG

     Not a data message

 -- Data: errno.EOVERFLOW

     Value too large for defined data type

 -- Data: errno.ENOTUNIQ

     Name not unique on network

 -- Data: errno.EBADFD

     File descriptor in bad state

 -- Data: errno.EREMCHG

     Remote address changed

 -- Data: errno.ELIBACC

     Can not access a needed shared library

 -- Data: errno.ELIBBAD

     Accessing a corrupted shared library

 -- Data: errno.ELIBSCN

     .lib section in a.out corrupted

 -- Data: errno.ELIBMAX

     Attempting to link in too many shared libraries

 -- Data: errno.ELIBEXEC

     Cannot exec a shared library directly

 -- Data: errno.EILSEQ

     Illegal byte sequence

 -- Data: errno.ERESTART

     Interrupted system call should be restarted

 -- Data: errno.ESTRPIPE

     Streams pipe error

 -- Data: errno.EUSERS

     Too many users

 -- Data: errno.ENOTSOCK

     Socket operation on non-socket

 -- Data: errno.EDESTADDRREQ

     Destination address required

 -- Data: errno.EMSGSIZE

     Message too long

 -- Data: errno.EPROTOTYPE

     Protocol wrong type for socket

 -- Data: errno.ENOPROTOOPT

     Protocol not available

 -- Data: errno.EPROTONOSUPPORT

     Protocol not supported

 -- Data: errno.ESOCKTNOSUPPORT

     Socket type not supported

 -- Data: errno.EOPNOTSUPP

     Operation not supported on transport endpoint

 -- Data: errno.EPFNOSUPPORT

     Protocol family not supported

 -- Data: errno.EAFNOSUPPORT

     Address family not supported by protocol

 -- Data: errno.EADDRINUSE

     Address already in use

 -- Data: errno.EADDRNOTAVAIL

     Cannot assign requested address

 -- Data: errno.ENETDOWN

     Network is down

 -- Data: errno.ENETUNREACH

     Network is unreachable

 -- Data: errno.ENETRESET

     Network dropped connection because of reset

 -- Data: errno.ECONNABORTED

     Software caused connection abort

 -- Data: errno.ECONNRESET

     Connection reset by peer

 -- Data: errno.ENOBUFS

     No buffer space available

 -- Data: errno.EISCONN

     Transport endpoint is already connected

 -- Data: errno.ENOTCONN

     Transport endpoint is not connected

 -- Data: errno.ESHUTDOWN

     Cannot send after transport endpoint shutdown

 -- Data: errno.ETOOMANYREFS

     Too many references: cannot splice

 -- Data: errno.ETIMEDOUT

     Connection timed out

 -- Data: errno.ECONNREFUSED

     Connection refused

 -- Data: errno.EHOSTDOWN

     Host is down

 -- Data: errno.EHOSTUNREACH

     No route to host

 -- Data: errno.EALREADY

     Operation already in progress

 -- Data: errno.EINPROGRESS

     Operation now in progress

 -- Data: errno.ESTALE

     Stale NFS file handle

 -- Data: errno.EUCLEAN

     Structure needs cleaning

 -- Data: errno.ENOTNAM

     Not a XENIX named type file

 -- Data: errno.ENAVAIL

     No XENIX semaphores available

 -- Data: errno.EISNAM

     Is a named type file

 -- Data: errno.EREMOTEIO

     Remote I/O error

 -- Data: errno.EDQUOT

     Quota exceeded


File: python.info,  Node: ctypes — A foreign function library for Python,  Prev: errno — Standard errno system symbols,  Up: Generic Operating System Services

5.16.16 ‘ctypes’ — A foreign function library for Python
--------------------------------------------------------

__________________________________________________________________

*note ctypes: 2b. is a foreign function library for Python.  It provides
C compatible data types, and allows calling functions in DLLs or shared
libraries.  It can be used to wrap these libraries in pure Python.

* Menu:

* ctypes tutorial::
* ctypes reference::


File: python.info,  Node: ctypes tutorial,  Next: ctypes reference,  Up: ctypes — A foreign function library for Python

5.16.16.1 ctypes tutorial
.........................

Note: The code samples in this tutorial use *note doctest: 67. to make
sure that they actually work.  Since some code samples behave
differently under Linux, Windows, or Mac OS X, they contain doctest
directives in comments.

Note: Some code samples reference the ctypes *note c_int: 21f4. type.
On platforms where ‘sizeof(long) == sizeof(int)’ it is an alias to *note
c_long: 21f5.  So, you should not be confused if *note c_long: 21f5. is
printed if you would expect *note c_int: 21f4. — they are actually the
same type.

* Menu:

* Loading dynamic link libraries::
* Accessing functions from loaded dlls::
* Calling functions::
* Fundamental data types::
* Calling functions, continued: Calling functions continued.
* Calling functions with your own custom data types::
* Specifying the required argument types (function prototypes): Specifying the required argument types function prototypes.
* Return types::
* Passing pointers (or; passing parameters by reference): Passing pointers or passing parameters by reference.
* Structures and unions::
* Structure/union alignment and byte order::
* Bit fields in structures and unions::
* Arrays::
* Pointers::
* Type conversions::
* Incomplete Types::
* Callback functions::
* Accessing values exported from dlls::
* Surprises::
* Variable-sized data types::


File: python.info,  Node: Loading dynamic link libraries,  Next: Accessing functions from loaded dlls,  Up: ctypes tutorial

5.16.16.2 Loading dynamic link libraries
........................................

*note ctypes: 2b. exports the `cdll', and on Windows `windll' and
`oledll' objects, for loading dynamic link libraries.

You load libraries by accessing them as attributes of these objects.
`cdll' loads libraries which export functions using the standard ‘cdecl’
calling convention, while `windll' libraries call functions using the
‘stdcall’ calling convention.  `oledll' also uses the ‘stdcall’ calling
convention, and assumes the functions return a Windows ‘HRESULT’ error
code.  The error code is used to automatically raise an *note OSError:
1d1. exception when the function call fails.

Changed in version 3.3: Windows errors used to raise *note WindowsError:
988, which is now an alias of *note OSError: 1d1.

Here are some examples for Windows.  Note that ‘msvcrt’ is the MS
standard C library containing most standard C functions, and uses the
cdecl calling convention:

     >>> from ctypes import * >>> print(windll.kernel32)   <WinDLL 'kernel32', handle ... at ...> >>> print(cdll.msvcrt)       <CDLL 'msvcrt', handle ... at ...> >>> libc = cdll.msvcrt       >>>

Windows appends the usual ‘.dll’ file suffix automatically.

     Note: Accessing the standard C library through ‘cdll.msvcrt’ will
     use an outdated version of the library that may be incompatible
     with the one being used by Python.  Where possible, use native
     Python functionality, or else import and use the ‘msvcrt’ module.

On Linux, it is required to specify the filename `including' the
extension to load a library, so attribute access can not be used to load
libraries.  Either the ‘LoadLibrary()’ method of the dll loaders should
be used, or you should load the library by creating an instance of CDLL
by calling the constructor:

     >>> cdll.LoadLibrary("libc.so.6")   <CDLL 'libc.so.6', handle ... at ...> >>> libc = CDLL("libc.so.6")        >>> libc                            <CDLL 'libc.so.6', handle ... at ...> >>>


File: python.info,  Node: Accessing functions from loaded dlls,  Next: Calling functions,  Prev: Loading dynamic link libraries,  Up: ctypes tutorial

5.16.16.3 Accessing functions from loaded dlls
..............................................

Functions are accessed as attributes of dll objects:

     >>> from ctypes import * >>> libc.printf <_FuncPtr object at 0x...> >>> print(windll.kernel32.GetModuleHandleA)   <_FuncPtr object at 0x...> >>> print(windll.kernel32.MyOwnFunction)      Traceback (most recent call last):   File "<stdin>", line 1, in <module>   File "ctypes.py", line 239, in __getattr__     func = _StdcallFuncPtr(name, self) AttributeError: function 'MyOwnFunction' not found >>>

Note that win32 system dlls like ‘kernel32’ and ‘user32’ often export
ANSI as well as UNICODE versions of a function.  The UNICODE version is
exported with an ‘W’ appended to the name, while the ANSI version is
exported with an ‘A’ appended to the name.  The win32 ‘GetModuleHandle’
function, which returns a `module handle' for a given module name, has
the following C prototype, and a macro is used to expose one of them as
‘GetModuleHandle’ depending on whether UNICODE is defined or not:

     /* ANSI version */ HMODULE GetModuleHandleA(LPCSTR lpModuleName); /* UNICODE version */ HMODULE GetModuleHandleW(LPCWSTR lpModuleName);

`windll' does not try to select one of them by magic, you must access
the version you need by specifying ‘GetModuleHandleA’ or
‘GetModuleHandleW’ explicitly, and then call it with bytes or string
objects respectively.

Sometimes, dlls export functions with names which aren’t valid Python
identifiers, like ‘"??2@YAPAXI@Z"’.  In this case you have to use *note
getattr(): 43d. to retrieve the function:

     >>> getattr(cdll.msvcrt, "??2@YAPAXI@Z")   <_FuncPtr object at 0x...> >>>

On Windows, some dlls export functions not by name but by ordinal.
These functions can be accessed by indexing the dll object with the
ordinal number:

     >>> cdll.kernel32[1]   <_FuncPtr object at 0x...> >>> cdll.kernel32[0]   Traceback (most recent call last):   File "<stdin>", line 1, in <module>   File "ctypes.py", line 310, in __getitem__     func = _StdcallFuncPtr(name, self) AttributeError: function ordinal 0 not found >>>


File: python.info,  Node: Calling functions,  Next: Fundamental data types,  Prev: Accessing functions from loaded dlls,  Up: ctypes tutorial

5.16.16.4 Calling functions
...........................

You can call these functions like any other Python callable.  This
example uses the ‘time()’ function, which returns system time in seconds
since the Unix epoch, and the ‘GetModuleHandleA()’ function, which
returns a win32 module handle.

This example calls both functions with a ‘NULL’ pointer (‘None’ should
be used as the ‘NULL’ pointer):

     >>> print(libc.time(None))   1150640792 >>> print(hex(windll.kernel32.GetModuleHandleA(None)))   0x1d000000 >>>

     Note: *note ctypes: 2b. may raise a *note ValueError: 1f9. after
     calling the function, if it detects that an invalid number of
     arguments were passed.  This behavior should not be relied upon.
     It is deprecated in 3.6.2, and will be removed in 3.7.

*note ValueError: 1f9. is raised when you call an ‘stdcall’ function
with the ‘cdecl’ calling convention, or vice versa:

     >>> cdll.kernel32.GetModuleHandleA(None)   Traceback (most recent call last):   File "<stdin>", line 1, in <module> ValueError: Procedure probably called with not enough arguments (4 bytes missing) >>>  >>> windll.msvcrt.printf(b"spam")   Traceback (most recent call last):   File "<stdin>", line 1, in <module> ValueError: Procedure probably called with too many arguments (4 bytes in excess) >>>

To find out the correct calling convention you have to look into the C
header file or the documentation for the function you want to call.

On Windows, *note ctypes: 2b. uses win32 structured exception handling
to prevent crashes from general protection faults when functions are
called with invalid argument values:

     >>> windll.kernel32.GetModuleHandleA(32)   Traceback (most recent call last):   File "<stdin>", line 1, in <module> OSError: exception: access violation reading 0x00000020 >>>

There are, however, enough ways to crash Python with *note ctypes: 2b,
so you should be careful anyway.  The *note faulthandler: 7d. module can
be helpful in debugging crashes (e.g.  from segmentation faults produced
by erroneous C library calls).

‘None’, integers, bytes objects and (unicode) strings are the only
native Python objects that can directly be used as parameters in these
function calls.  ‘None’ is passed as a C ‘NULL’ pointer, bytes objects
and strings are passed as pointer to the memory block that contains
their data (‘char *’ or ‘wchar_t *’).  Python integers are passed as the
platforms default C ‘int’ type, their value is masked to fit into the C
type.

Before we move on calling functions with other parameter types, we have
to learn more about *note ctypes: 2b. data types.


File: python.info,  Node: Fundamental data types,  Next: Calling functions continued,  Prev: Calling functions,  Up: ctypes tutorial

5.16.16.5 Fundamental data types
................................

*note ctypes: 2b. defines a number of primitive C compatible data types:

ctypes type                C type                                         Python type
                                                                          
-----------------------------------------------------------------------------------------------------------
                                                                          
*note c_bool: 21fe.        ‘_Bool’                                        bool (1)
                                                                          
                                                                          
*note c_char: 21ff.        ‘char’                                         1-character bytes object
                                                                          
                                                                          
*note c_wchar: 2200.       ‘wchar_t’                                      1-character string
                                                                          
                                                                          
*note c_byte: 2201.        ‘char’                                         int
                                                                          
                                                                          
*note c_ubyte: 2202.       ‘unsigned char’                                int
                                                                          
                                                                          
*note c_short: 2203.       ‘short’                                        int
                                                                          
                                                                          
*note c_ushort: 2204.      ‘unsigned short’                               int
                                                                          
                                                                          
*note c_int: 21f4.         ‘int’                                          int
                                                                          
                                                                          
*note c_uint: 2205.        ‘unsigned int’                                 int
                                                                          
                                                                          
*note c_long: 21f5.        ‘long’                                         int
                                                                          
                                                                          
*note c_ulong: 2206.       ‘unsigned long’                                int
                                                                          
                                                                          
*note c_longlong: 2207.    ‘__int64’ or ‘long long’                       int
                                                                          
                                                                          
*note c_ulonglong: 2208.   ‘unsigned __int64’ or ‘unsigned long long’     int
                                                                          
                                                                          
*note c_size_t: 2209.      ‘size_t’                                       int
                                                                          
                                                                          
*note c_ssize_t: bc4.      ‘ssize_t’ or ‘Py_ssize_t’                      int
                                                                          
                                                                          
*note c_float: 220a.       ‘float’                                        float
                                                                          
                                                                          
*note c_double: 220b.      ‘double’                                       float
                                                                          
                                                                          
*note c_longdouble: 220c.  ‘long double’                                  float
                                                                          
                                                                          
*note c_char_p: 220d.      ‘char *’ (NUL terminated)                      bytes object or ‘None’
                                                                          
                                                                          
*note c_wchar_p: 220e.     ‘wchar_t *’ (NUL terminated)                   string or ‘None’
                                                                          
                                                                          
*note c_void_p: 220f.      ‘void *’                                       int or ‘None’
                                                                          

  1. The constructor accepts any object with a truth value.

All these types can be created by calling them with an optional
initializer of the correct type and value:

     >>> c_int() c_long(0) >>> c_wchar_p("Hello, World") c_wchar_p(140018365411392) >>> c_ushort(-3) c_ushort(65533) >>>

Since these types are mutable, their value can also be changed
afterwards:

     >>> i = c_int(42) >>> print(i) c_long(42) >>> print(i.value) 42 >>> i.value = -99 >>> print(i.value) -99 >>>

Assigning a new value to instances of the pointer types *note c_char_p:
220d, *note c_wchar_p: 220e, and *note c_void_p: 220f. changes the
`memory location' they point to, `not the contents' of the memory block
(of course not, because Python bytes objects are immutable):

     >>> s = "Hello, World" >>> c_s = c_wchar_p(s) >>> print(c_s) c_wchar_p(139966785747344) >>> print(c_s.value) Hello World >>> c_s.value = "Hi, there" >>> print(c_s)              # the memory location has changed c_wchar_p(139966783348904) >>> print(c_s.value) Hi, there >>> print(s)                # first object is unchanged Hello, World >>>

You should be careful, however, not to pass them to functions expecting
pointers to mutable memory.  If you need mutable memory blocks, ctypes
has a *note create_string_buffer(): 2210. function which creates these
in various ways.  The current memory block contents can be accessed (or
changed) with the ‘raw’ property; if you want to access it as NUL
terminated string, use the ‘value’ property:

     >>> from ctypes import * >>> p = create_string_buffer(3)            # create a 3 byte buffer, initialized to NUL bytes >>> print(sizeof(p), repr(p.raw)) 3 b'\x00\x00\x00' >>> p = create_string_buffer(b"Hello")     # create a buffer containing a NUL terminated string >>> print(sizeof(p), repr(p.raw)) 6 b'Hello\x00' >>> print(repr(p.value)) b'Hello' >>> p = create_string_buffer(b"Hello", 10) # create a 10 byte buffer >>> print(sizeof(p), repr(p.raw)) 10 b'Hello\x00\x00\x00\x00\x00' >>> p.value = b"Hi" >>> print(sizeof(p), repr(p.raw)) 10 b'Hi\x00lo\x00\x00\x00\x00\x00' >>>

The *note create_string_buffer(): 2210. function replaces the
‘c_buffer()’ function (which is still available as an alias), as well as
the ‘c_string()’ function from earlier ctypes releases.  To create a
mutable memory block containing unicode characters of the C type
‘wchar_t’ use the *note create_unicode_buffer(): ede. function.


File: python.info,  Node: Calling functions continued,  Next: Calling functions with your own custom data types,  Prev: Fundamental data types,  Up: ctypes tutorial

5.16.16.6 Calling functions, continued
......................................

Note that printf prints to the real standard output channel, `not' to
*note sys.stdout: 303, so these examples will only work at the console
prompt, not from within `IDLE' or `PythonWin':

     >>> printf = libc.printf >>> printf(b"Hello, %s\n", b"World!") Hello, World! 14 >>> printf(b"Hello, %S\n", "World!") Hello, World! 14 >>> printf(b"%d bottles of beer\n", 42) 42 bottles of beer 19 >>> printf(b"%f bottles of beer\n", 42.5) Traceback (most recent call last):   File "<stdin>", line 1, in <module> ArgumentError: argument 2: exceptions.TypeError: Don't know how to convert parameter 2 >>>

As has been mentioned before, all Python types except integers, strings,
and bytes objects have to be wrapped in their corresponding *note
ctypes: 2b. type, so that they can be converted to the required C data
type:

     >>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14)) An int 1234, a double 3.140000 31 >>>


File: python.info,  Node: Calling functions with your own custom data types,  Next: Specifying the required argument types function prototypes,  Prev: Calling functions continued,  Up: ctypes tutorial

5.16.16.7 Calling functions with your own custom data types
...........................................................

You can also customize *note ctypes: 2b. argument conversion to allow
instances of your own classes be used as function arguments.  *note
ctypes: 2b. looks for an ‘_as_parameter_’ attribute and uses this as the
function argument.  Of course, it must be one of integer, string, or
bytes:

     >>> class Bottles: ...     def __init__(self, number): ...         self._as_parameter_ = number ... >>> bottles = Bottles(42) >>> printf(b"%d bottles of beer\n", bottles) 42 bottles of beer 19 >>>

If you don’t want to store the instance’s data in the ‘_as_parameter_’
instance variable, you could define a *note property: 1d5. which makes
the attribute available on request.


File: python.info,  Node: Specifying the required argument types function prototypes,  Next: Return types,  Prev: Calling functions with your own custom data types,  Up: ctypes tutorial

5.16.16.8 Specifying the required argument types (function prototypes)
......................................................................

It is possible to specify the required argument types of functions
exported from DLLs by setting the ‘argtypes’ attribute.

‘argtypes’ must be a sequence of C data types (the ‘printf’ function is
probably not a good example here, because it takes a variable number and
different types of parameters depending on the format string, on the
other hand this is quite handy to experiment with this feature):

     >>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double] >>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2) String 'Hi', Int 10, Double 2.200000 37 >>>

Specifying a format protects against incompatible argument types (just
as a prototype for a C function), and tries to convert the arguments to
valid types:

     >>> printf(b"%d %d %d", 1, 2, 3) Traceback (most recent call last):   File "<stdin>", line 1, in <module> ArgumentError: argument 2: exceptions.TypeError: wrong type >>> printf(b"%s %d %f\n", b"X", 2, 3) X 2 3.000000 13 >>>

If you have defined your own classes which you pass to function calls,
you have to implement a ‘from_param()’ class method for them to be able
to use them in the ‘argtypes’ sequence.  The ‘from_param()’ class method
receives the Python object passed to the function call, it should do a
typecheck or whatever is needed to make sure this object is acceptable,
and then return the object itself, its ‘_as_parameter_’ attribute, or
whatever you want to pass as the C function argument in this case.
Again, the result should be an integer, string, bytes, a *note ctypes:
2b. instance, or an object with an ‘_as_parameter_’ attribute.


File: python.info,  Node: Return types,  Next: Passing pointers or passing parameters by reference,  Prev: Specifying the required argument types function prototypes,  Up: ctypes tutorial

5.16.16.9 Return types
......................

By default functions are assumed to return the C ‘int’ type.  Other
return types can be specified by setting the ‘restype’ attribute of the
function object.

Here is a more advanced example, it uses the ‘strchr’ function, which
expects a string pointer and a char, and returns a pointer to a string:

     >>> strchr = libc.strchr >>> strchr(b"abcdef", ord("d"))   8059983 >>> strchr.restype = c_char_p    # c_char_p is a pointer to a string >>> strchr(b"abcdef", ord("d")) b'def' >>> print(strchr(b"abcdef", ord("x"))) None >>>

If you want to avoid the ‘ord("x")’ calls above, you can set the
‘argtypes’ attribute, and the second argument will be converted from a
single character Python bytes object into a C char:

     >>> strchr.restype = c_char_p >>> strchr.argtypes = [c_char_p, c_char] >>> strchr(b"abcdef", b"d") 'def' >>> strchr(b"abcdef", b"def") Traceback (most recent call last):   File "<stdin>", line 1, in <module> ArgumentError: argument 2: exceptions.TypeError: one character string expected >>> print(strchr(b"abcdef", b"x")) None >>> strchr(b"abcdef", b"d") 'def' >>>

You can also use a callable Python object (a function or a class for
example) as the ‘restype’ attribute, if the foreign function returns an
integer.  The callable will be called with the `integer' the C function
returns, and the result of this call will be used as the result of your
function call.  This is useful to check for error return values and
automatically raise an exception:

     >>> GetModuleHandle = windll.kernel32.GetModuleHandleA   >>> def ValidHandle(value): ...     if value == 0: ...         raise WinError() ...     return value ... >>> >>> GetModuleHandle.restype = ValidHandle   >>> GetModuleHandle(None)   486539264 >>> GetModuleHandle("something silly")   Traceback (most recent call last):   File "<stdin>", line 1, in <module>   File "<stdin>", line 3, in ValidHandle OSError: [Errno 126] The specified module could not be found. >>>

‘WinError’ is a function which will call Windows ‘FormatMessage()’ api
to get the string representation of an error code, and `returns' an
exception.  ‘WinError’ takes an optional error code parameter, if no one
is used, it calls *note GetLastError(): 2219. to retrieve it.

Please note that a much more powerful error checking mechanism is
available through the ‘errcheck’ attribute; see the reference manual for
details.


File: python.info,  Node: Passing pointers or passing parameters by reference,  Next: Structures and unions,  Prev: Return types,  Up: ctypes tutorial

5.16.16.10 Passing pointers (or: passing parameters by reference)
.................................................................

Sometimes a C api function expects a `pointer' to a data type as
parameter, probably to write into the corresponding location, or if the
data is too large to be passed by value.  This is also known as `passing
parameters by reference'.

*note ctypes: 2b. exports the *note byref(): 221c. function which is
used to pass parameters by reference.  The same effect can be achieved
with the *note pointer(): 221d. function, although *note pointer():
221d. does a lot more work since it constructs a real pointer object, so
it is faster to use *note byref(): 221c. if you don’t need the pointer
object in Python itself:

     >>> i = c_int() >>> f = c_float() >>> s = create_string_buffer(b'\000' * 32) >>> print(i.value, f.value, repr(s.value)) 0 0.0 b'' >>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s", ...             byref(i), byref(f), s) 3 >>> print(i.value, f.value, repr(s.value)) 1 3.1400001049 b'Hello' >>>


File: python.info,  Node: Structures and unions,  Next: Structure/union alignment and byte order,  Prev: Passing pointers or passing parameters by reference,  Up: ctypes tutorial

5.16.16.11 Structures and unions
................................

Structures and unions must derive from the *note Structure: 2220. and
*note Union: 2221. base classes which are defined in the *note ctypes:
2b. module.  Each subclass must define a ‘_fields_’ attribute.
‘_fields_’ must be a list of `2-tuples', containing a `field name' and a
`field type'.

The field type must be a *note ctypes: 2b. type like *note c_int: 21f4,
or any other derived *note ctypes: 2b. type: structure, union, array,
pointer.

Here is a simple example of a POINT structure, which contains two
integers named `x' and `y', and also shows how to initialize a structure
in the constructor:

     >>> from ctypes import * >>> class POINT(Structure): ...     _fields_ = [("x", c_int), ...                 ("y", c_int)] ... >>> point = POINT(10, 20) >>> print(point.x, point.y) 10 20 >>> point = POINT(y=5) >>> print(point.x, point.y) 0 5 >>> POINT(1, 2, 3) Traceback (most recent call last):   File "<stdin>", line 1, in <module> TypeError: too many initializers >>>

You can, however, build much more complicated structures.  A structure
can itself contain other structures by using a structure as a field
type.

Here is a RECT structure which contains two POINTs named `upperleft' and
`lowerright':

     >>> class RECT(Structure): ...     _fields_ = [("upperleft", POINT), ...                 ("lowerright", POINT)] ... >>> rc = RECT(point) >>> print(rc.upperleft.x, rc.upperleft.y) 0 5 >>> print(rc.lowerright.x, rc.lowerright.y) 0 0 >>>

Nested structures can also be initialized in the constructor in several
ways:

     >>> r = RECT(POINT(1, 2), POINT(3, 4)) >>> r = RECT((1, 2), (3, 4))

Field *note descriptor: 1541.s can be retrieved from the `class', they
are useful for debugging because they can provide useful information:

     >>> print(POINT.x) <Field type=c_long, ofs=0, size=4> >>> print(POINT.y) <Field type=c_long, ofs=4, size=4> >>>
     Warning: *note ctypes: 2b. does not support passing unions or
     structures with bit-fields to functions by value.  While this may
     work on 32-bit x86, it’s not guaranteed by the library to work in
     the general case.  Unions and structures with bit-fields should
     always be passed to functions by pointer.


File: python.info,  Node: Structure/union alignment and byte order,  Next: Bit fields in structures and unions,  Prev: Structures and unions,  Up: ctypes tutorial

5.16.16.12 Structure/union alignment and byte order
...................................................

By default, Structure and Union fields are aligned in the same way the C
compiler does it.  It is possible to override this behavior be
specifying a ‘_pack_’ class attribute in the subclass definition.  This
must be set to a positive integer and specifies the maximum alignment
for the fields.  This is what ‘#pragma pack(n)’ also does in MSVC.

*note ctypes: 2b. uses the native byte order for Structures and Unions.
To build structures with non-native byte order, you can use one of the
*note BigEndianStructure: 2224, *note LittleEndianStructure: 2225,
‘BigEndianUnion’, and ‘LittleEndianUnion’ base classes.  These classes
cannot contain pointer fields.


File: python.info,  Node: Bit fields in structures and unions,  Next: Arrays,  Prev: Structure/union alignment and byte order,  Up: ctypes tutorial

5.16.16.13 Bit fields in structures and unions
..............................................

It is possible to create structures and unions containing bit fields.
Bit fields are only possible for integer fields, the bit width is
specified as the third item in the ‘_fields_’ tuples:

     >>> class Int(Structure): ...     _fields_ = [("first_16", c_int, 16), ...                 ("second_16", c_int, 16)] ... >>> print(Int.first_16) <Field type=c_long, ofs=0:0, bits=16> >>> print(Int.second_16) <Field type=c_long, ofs=0:16, bits=16> >>>


File: python.info,  Node: Arrays,  Next: Pointers,  Prev: Bit fields in structures and unions,  Up: ctypes tutorial

5.16.16.14 Arrays
.................

Arrays are sequences, containing a fixed number of instances of the same
type.

The recommended way to create array types is by multiplying a data type
with a positive integer:

     TenPointsArrayType = POINT * 10

Here is an example of a somewhat artificial data type, a structure
containing 4 POINTs among other stuff:

     >>> from ctypes import * >>> class POINT(Structure): ...     _fields_ = ("x", c_int), ("y", c_int) ... >>> class MyStruct(Structure): ...     _fields_ = [("a", c_int), ...                 ("b", c_float), ...                 ("point_array", POINT * 4)] >>> >>> print(len(MyStruct().point_array)) 4 >>>

Instances are created in the usual way, by calling the class:

     arr = TenPointsArrayType() for pt in arr:     print(pt.x, pt.y)

The above code print a series of ‘0 0’ lines, because the array contents
is initialized to zeros.

Initializers of the correct type can also be specified:

     >>> from ctypes import * >>> TenIntegers = c_int * 10 >>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10) >>> print(ii) <c_long_Array_10 object at 0x...> >>> for i in ii: print(i, end=" ") ... 1 2 3 4 5 6 7 8 9 10 >>>


File: python.info,  Node: Pointers,  Next: Type conversions,  Prev: Arrays,  Up: ctypes tutorial

5.16.16.15 Pointers
...................

Pointer instances are created by calling the *note pointer(): 221d.
function on a *note ctypes: 2b. type:

     >>> from ctypes import * >>> i = c_int(42) >>> pi = pointer(i) >>>

Pointer instances have a *note contents: 222c. attribute which returns
the object to which the pointer points, the ‘i’ object above:

     >>> pi.contents c_long(42) >>>

Note that *note ctypes: 2b. does not have OOR (original object return),
it constructs a new, equivalent object each time you retrieve an
attribute:

     >>> pi.contents is i False >>> pi.contents is pi.contents False >>>

Assigning another *note c_int: 21f4. instance to the pointer’s contents
attribute would cause the pointer to point to the memory location where
this is stored:

     >>> i = c_int(99) >>> pi.contents = i >>> pi.contents c_long(99) >>>

Pointer instances can also be indexed with integers:

     >>> pi[0] 99 >>>

Assigning to an integer index changes the pointed to value:

     >>> print(i) c_long(99) >>> pi[0] = 22 >>> print(i) c_long(22) >>>

It is also possible to use indexes different from 0, but you must know
what you’re doing, just as in C: You can access or change arbitrary
memory locations.  Generally you only use this feature if you receive a
pointer from a C function, and you `know' that the pointer actually
points to an array instead of a single item.

Behind the scenes, the *note pointer(): 221d. function does more than
simply create pointer instances, it has to create pointer `types' first.
This is done with the *note POINTER(): 222d. function, which accepts any
*note ctypes: 2b. type, and returns a new type:

     >>> PI = POINTER(c_int) >>> PI <class 'ctypes.LP_c_long'> >>> PI(42) Traceback (most recent call last):   File "<stdin>", line 1, in <module> TypeError: expected c_long instead of int >>> PI(c_int(42)) <ctypes.LP_c_long object at 0x...> >>>

Calling the pointer type without an argument creates a ‘NULL’ pointer.
‘NULL’ pointers have a ‘False’ boolean value:

     >>> null_ptr = POINTER(c_int)() >>> print(bool(null_ptr)) False >>>

*note ctypes: 2b. checks for ‘NULL’ when dereferencing pointers (but
dereferencing invalid non-‘NULL’ pointers would crash Python):

     >>> null_ptr[0] Traceback (most recent call last):     .... ValueError: NULL pointer access >>>  >>> null_ptr[0] = 1234 Traceback (most recent call last):     .... ValueError: NULL pointer access >>>


File: python.info,  Node: Type conversions,  Next: Incomplete Types,  Prev: Pointers,  Up: ctypes tutorial

5.16.16.16 Type conversions
...........................

Usually, ctypes does strict type checking.  This means, if you have
‘POINTER(c_int)’ in the ‘argtypes’ list of a function or as the type of
a member field in a structure definition, only instances of exactly the
same type are accepted.  There are some exceptions to this rule, where
ctypes accepts other objects.  For example, you can pass compatible
array instances instead of pointer types.  So, for ‘POINTER(c_int)’,
ctypes accepts an array of c_int:

     >>> class Bar(Structure): ...     _fields_ = [("count", c_int), ("values", POINTER(c_int))] ... >>> bar = Bar() >>> bar.values = (c_int * 3)(1, 2, 3) >>> bar.count = 3 >>> for i in range(bar.count): ...     print(bar.values[i]) ... 1 2 3 >>>

In addition, if a function argument is explicitly declared to be a
pointer type (such as ‘POINTER(c_int)’) in ‘argtypes’, an object of the
pointed type (‘c_int’ in this case) can be passed to the function.
ctypes will apply the required *note byref(): 221c. conversion in this
case automatically.

To set a POINTER type field to ‘NULL’, you can assign ‘None’:

     >>> bar.values = None >>>

Sometimes you have instances of incompatible types.  In C, you can cast
one type into another type.  *note ctypes: 2b. provides a *note cast():
f4a. function which can be used in the same way.  The ‘Bar’ structure
defined above accepts ‘POINTER(c_int)’ pointers or *note c_int: 21f4.
arrays for its ‘values’ field, but not instances of other types:

     >>> bar.values = (c_byte * 4)() Traceback (most recent call last):   File "<stdin>", line 1, in <module> TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance >>>

For these cases, the *note cast(): f4a. function is handy.

The *note cast(): f4a. function can be used to cast a ctypes instance
into a pointer to a different ctypes data type.  *note cast(): f4a.
takes two parameters, a ctypes object that is or can be converted to a
pointer of some kind, and a ctypes pointer type.  It returns an instance
of the second argument, which references the same memory block as the
first argument:

     >>> a = (c_byte * 4)() >>> cast(a, POINTER(c_int)) <ctypes.LP_c_long object at ...> >>>

So, *note cast(): f4a. can be used to assign to the ‘values’ field of
‘Bar’ the structure:

     >>> bar = Bar() >>> bar.values = cast((c_byte * 4)(), POINTER(c_int)) >>> print(bar.values[0]) 0 >>>


File: python.info,  Node: Incomplete Types,  Next: Callback functions,  Prev: Type conversions,  Up: ctypes tutorial

5.16.16.17 Incomplete Types
...........................

`Incomplete Types' are structures, unions or arrays whose members are
not yet specified.  In C, they are specified by forward declarations,
which are defined later:

     struct cell; /* forward declaration */  struct cell {     char *name;     struct cell *next; };

The straightforward translation into ctypes code would be this, but it
does not work:

     >>> class cell(Structure): ...     _fields_ = [("name", c_char_p), ...                 ("next", POINTER(cell))] ... Traceback (most recent call last):   File "<stdin>", line 1, in <module>   File "<stdin>", line 2, in cell NameError: name 'cell' is not defined >>>

because the new ‘class cell’ is not available in the class statement
itself.  In *note ctypes: 2b, we can define the ‘cell’ class and set the
‘_fields_’ attribute later, after the class statement:

     >>> from ctypes import * >>> class cell(Structure): ...     pass ... >>> cell._fields_ = [("name", c_char_p), ...                  ("next", POINTER(cell))] >>>

Lets try it.  We create two instances of ‘cell’, and let them point to
each other, and finally follow the pointer chain a few times:

     >>> c1 = cell() >>> c1.name = "foo" >>> c2 = cell() >>> c2.name = "bar" >>> c1.next = pointer(c2) >>> c2.next = pointer(c1) >>> p = c1 >>> for i in range(8): ...     print(p.name, end=" ") ...     p = p.next[0] ... foo bar foo bar foo bar foo bar >>>


File: python.info,  Node: Callback functions,  Next: Accessing values exported from dlls,  Prev: Incomplete Types,  Up: ctypes tutorial

5.16.16.18 Callback functions
.............................

*note ctypes: 2b. allows creating C callable function pointers from
Python callables.  These are sometimes called `callback functions'.

First, you must create a class for the callback function.  The class
knows the calling convention, the return type, and the number and types
of arguments this function will receive.

The *note CFUNCTYPE(): 2234. factory function creates types for callback
functions using the ‘cdecl’ calling convention.  On Windows, the *note
WINFUNCTYPE(): 2235. factory function creates types for callback
functions using the ‘stdcall’ calling convention.

Both of these factory functions are called with the result type as first
argument, and the callback functions expected argument types as the
remaining arguments.

I will present an example here which uses the standard C library’s
‘qsort()’ function, that is used to sort items with the help of a
callback function.  ‘qsort()’ will be used to sort an array of integers:

     >>> IntArray5 = c_int * 5 >>> ia = IntArray5(5, 1, 7, 33, 99) >>> qsort = libc.qsort >>> qsort.restype = None >>>

‘qsort()’ must be called with a pointer to the data to sort, the number
of items in the data array, the size of one item, and a pointer to the
comparison function, the callback.  The callback will then be called
with two pointers to items, and it must return a negative integer if the
first item is smaller than the second, a zero if they are equal, and a
positive integer otherwise.

So our callback function receives pointers to integers, and must return
an integer.  First we create the ‘type’ for the callback function:

     >>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int)) >>>

To get started, here is a simple callback that shows the values it gets
passed:

     >>> def py_cmp_func(a, b): ...     print("py_cmp_func", a[0], b[0]) ...     return 0 ... >>> cmp_func = CMPFUNC(py_cmp_func) >>>

The result:

     >>> qsort(ia, len(ia), sizeof(c_int), cmp_func)   py_cmp_func 5 1 py_cmp_func 33 99 py_cmp_func 7 33 py_cmp_func 5 7 py_cmp_func 1 7 >>>

Now we can actually compare the two items and return a useful result:

     >>> def py_cmp_func(a, b): ...     print("py_cmp_func", a[0], b[0]) ...     return a[0] - b[0] ... >>> >>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func))  py_cmp_func 5 1 py_cmp_func 33 99 py_cmp_func 7 33 py_cmp_func 1 7 py_cmp_func 5 7 >>>

As we can easily check, our array is sorted now:

     >>> for i in ia: print(i, end=" ") ... 1 5 7 33 99 >>>

The function factories can be used as decorator factories, so we may as
well write:

     >>> @CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int)) ... def py_cmp_func(a, b): ...     print("py_cmp_func", a[0], b[0]) ...     return a[0] - b[0] ... >>> qsort(ia, len(ia), sizeof(c_int), py_cmp_func) py_cmp_func 5 1 py_cmp_func 33 99 py_cmp_func 7 33 py_cmp_func 1 7 py_cmp_func 5 7 >>>

     Note: Make sure you keep references to *note CFUNCTYPE(): 2234.
     objects as long as they are used from C code.  *note ctypes: 2b.
     doesn’t, and if you don’t, they may be garbage collected, crashing
     your program when a callback is made.

     Also, note that if the callback function is called in a thread
     created outside of Python’s control (e.g.  by the foreign code that
     calls the callback), ctypes creates a new dummy Python thread on
     every invocation.  This behavior is correct for most purposes, but
     it means that values stored with *note threading.local: 2236. will
     `not' survive across different callbacks, even when those calls are
     made from the same C thread.


File: python.info,  Node: Accessing values exported from dlls,  Next: Surprises,  Prev: Callback functions,  Up: ctypes tutorial

5.16.16.19 Accessing values exported from dlls
..............................................

Some shared libraries not only export functions, they also export
variables.  An example in the Python library itself is the *note
Py_OptimizeFlag: 2239, an integer set to 0, 1, or 2, depending on the
*note -O: 67f. or *note -OO: 680. flag given on startup.

*note ctypes: 2b. can access values like this with the ‘in_dll()’ class
methods of the type.  `pythonapi' is a predefined symbol giving access
to the Python C api:

     >>> opt_flag = c_int.in_dll(pythonapi, "Py_OptimizeFlag") >>> print(opt_flag) c_long(0) >>>

If the interpreter would have been started with *note -O: 67f, the
sample would have printed ‘c_long(1)’, or ‘c_long(2)’ if *note -OO: 680.
would have been specified.

An extended example which also demonstrates the use of pointers accesses
the *note PyImport_FrozenModules: 223a. pointer exported by Python.

Quoting the docs for that value:

     This pointer is initialized to point to an array of ‘struct
     _frozen’ records, terminated by one whose members are all ‘NULL’ or
     zero.  When a frozen module is imported, it is searched in this
     table.  Third-party code could play tricks with this to provide a
     dynamically created collection of frozen modules.

So manipulating this pointer could even prove useful.  To restrict the
example size, we show only how this table can be read with *note ctypes:
2b.:

     >>> from ctypes import * >>> >>> class struct_frozen(Structure): ...     _fields_ = [("name", c_char_p), ...                 ("code", POINTER(c_ubyte)), ...                 ("size", c_int)] ... >>>

We have defined the ‘struct _frozen’ data type, so we can get the
pointer to the table:

     >>> FrozenTable = POINTER(struct_frozen) >>> table = FrozenTable.in_dll(pythonapi, "PyImport_FrozenModules") >>>

Since ‘table’ is a ‘pointer’ to the array of ‘struct_frozen’ records, we
can iterate over it, but we just have to make sure that our loop
terminates, because pointers have no size.  Sooner or later it would
probably crash with an access violation or whatever, so it’s better to
break out of the loop when we hit the ‘NULL’ entry:

     >>> for item in table: ...     if item.name is None: ...         break ...     print(item.name.decode("ascii"), item.size) ... _frozen_importlib 31764 _frozen_importlib_external 41499 __hello__ 161 __phello__ -161 __phello__.spam 161 >>>

The fact that standard Python has a frozen module and a frozen package
(indicated by the negative size member) is not well known, it is only
used for testing.  Try it out with ‘import __hello__’ for example.


File: python.info,  Node: Surprises,  Next: Variable-sized data types,  Prev: Accessing values exported from dlls,  Up: ctypes tutorial

5.16.16.20 Surprises
....................

There are some edges in *note ctypes: 2b. where you might expect
something other than what actually happens.

Consider the following example:

     >>> from ctypes import * >>> class POINT(Structure): ...     _fields_ = ("x", c_int), ("y", c_int) ... >>> class RECT(Structure): ...     _fields_ = ("a", POINT), ("b", POINT) ... >>> p1 = POINT(1, 2) >>> p2 = POINT(3, 4) >>> rc = RECT(p1, p2) >>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y) 1 2 3 4 >>> # now swap the two points >>> rc.a, rc.b = rc.b, rc.a >>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y) 3 4 3 4 >>>

Hm.  We certainly expected the last statement to print ‘3 4 1 2’.  What
happened?  Here are the steps of the ‘rc.a, rc.b = rc.b, rc.a’ line
above:

     >>> temp0, temp1 = rc.b, rc.a >>> rc.a = temp0 >>> rc.b = temp1 >>>

Note that ‘temp0’ and ‘temp1’ are objects still using the internal
buffer of the ‘rc’ object above.  So executing ‘rc.a = temp0’ copies the
buffer contents of ‘temp0’ into ‘rc’ ‘s buffer.  This, in turn, changes
the contents of ‘temp1’.  So, the last assignment ‘rc.b = temp1’,
doesn’t have the expected effect.

Keep in mind that retrieving sub-objects from Structure, Unions, and
Arrays doesn’t `copy' the sub-object, instead it retrieves a wrapper
object accessing the root-object’s underlying buffer.

Another example that may behave differently from what one would expect
is this:

     >>> s = c_char_p() >>> s.value = b"abc def ghi" >>> s.value b'abc def ghi' >>> s.value is s.value False >>>

     Note: Objects instantiated from *note c_char_p: 220d. can only have
     their value set to bytes or integers.

Why is it printing ‘False’?  ctypes instances are objects containing a
memory block plus some *note descriptor: 1541.s accessing the contents
of the memory.  Storing a Python object in the memory block does not
store the object itself, instead the ‘contents’ of the object is stored.
Accessing the contents again constructs a new Python object each time!


File: python.info,  Node: Variable-sized data types,  Prev: Surprises,  Up: ctypes tutorial

5.16.16.21 Variable-sized data types
....................................

*note ctypes: 2b. provides some support for variable-sized arrays and
structures.

The *note resize(): 223f. function can be used to resize the memory
buffer of an existing ctypes object.  The function takes the object as
first argument, and the requested size in bytes as the second argument.
The memory block cannot be made smaller than the natural memory block
specified by the objects type, a *note ValueError: 1f9. is raised if
this is tried:

     >>> short_array = (c_short * 4)() >>> print(sizeof(short_array)) 8 >>> resize(short_array, 4) Traceback (most recent call last):     ... ValueError: minimum size is 8 >>> resize(short_array, 32) >>> sizeof(short_array) 32 >>> sizeof(type(short_array)) 8 >>>

This is nice and fine, but how would one access the additional elements
contained in this array?  Since the type still only knows about 4
elements, we get errors accessing other elements:

     >>> short_array[:] [0, 0, 0, 0] >>> short_array[7] Traceback (most recent call last):     ... IndexError: invalid index >>>

Another way to use variable-sized data types with *note ctypes: 2b. is
to use the dynamic nature of Python, and (re-)define the data type after
the required size is already known, on a case by case basis.


File: python.info,  Node: ctypes reference,  Prev: ctypes tutorial,  Up: ctypes — A foreign function library for Python

5.16.16.22 ctypes reference
...........................

* Menu:

* Finding shared libraries::
* Loading shared libraries::
* Foreign functions::
* Function prototypes::
* Utility functions::
* Data types::
* Fundamental data types: Fundamental data types<2>.
* Structured data types::
* Arrays and pointers::


File: python.info,  Node: Finding shared libraries,  Next: Loading shared libraries,  Up: ctypes reference

5.16.16.23 Finding shared libraries
...................................

When programming in a compiled language, shared libraries are accessed
when compiling/linking a program, and when the program is run.

The purpose of the ‘find_library()’ function is to locate a library in a
way similar to what the compiler or runtime loader does (on platforms
with several versions of a shared library the most recent should be
loaded), while the ctypes library loaders act like when a program is
run, and call the runtime loader directly.

The ‘ctypes.util’ module provides a function which can help to determine
the library to load.

 -- Data: ctypes.util.find_library (name)

     Try to find a library and return a pathname.  `name' is the library
     name without any prefix like `lib', suffix like ‘.so’, ‘.dylib’ or
     version number (this is the form used for the posix linker option
     ‘-l’).  If no library can be found, returns ‘None’.

The exact functionality is system dependent.

On Linux, ‘find_library()’ tries to run external programs
(‘/sbin/ldconfig’, ‘gcc’, ‘objdump’ and ‘ld’) to find the library file.
It returns the filename of the library file.

Changed in version 3.6: On Linux, the value of the environment variable
‘LD_LIBRARY_PATH’ is used when searching for libraries, if a library
cannot be found by any other means.

Here are some examples:

     >>> from ctypes.util import find_library >>> find_library("m") 'libm.so.6' >>> find_library("c") 'libc.so.6' >>> find_library("bz2") 'libbz2.so.1.0' >>>

On OS X, ‘find_library()’ tries several predefined naming schemes and
paths to locate the library, and returns a full pathname if successful:

     >>> from ctypes.util import find_library >>> find_library("c") '/usr/lib/libc.dylib' >>> find_library("m") '/usr/lib/libm.dylib' >>> find_library("bz2") '/usr/lib/libbz2.dylib' >>> find_library("AGL") '/System/Library/Frameworks/AGL.framework/AGL' >>>

On Windows, ‘find_library()’ searches along the system search path, and
returns the full pathname, but since there is no predefined naming
scheme a call like ‘find_library("c")’ will fail and return ‘None’.

If wrapping a shared library with *note ctypes: 2b, it `may' be better
to determine the shared library name at development time, and hardcode
that into the wrapper module instead of using ‘find_library()’ to locate
the library at runtime.


File: python.info,  Node: Loading shared libraries,  Next: Foreign functions,  Prev: Finding shared libraries,  Up: ctypes reference

5.16.16.24 Loading shared libraries
...................................

There are several ways to load shared libraries into the Python process.
One way is to instantiate one of the following classes:

 -- Class: ctypes.CDLL (name, mode=DEFAULT_MODE, handle=None,
          use_errno=False, use_last_error=False, winmode=0)

     Instances of this class represent loaded shared libraries.
     Functions in these libraries use the standard C calling convention,
     and are assumed to return ‘int’.

 -- Class: ctypes.OleDLL (name, mode=DEFAULT_MODE, handle=None,
          use_errno=False, use_last_error=False, winmode=0)

     Windows only: Instances of this class represent loaded shared
     libraries, functions in these libraries use the ‘stdcall’ calling
     convention, and are assumed to return the windows specific *note
     HRESULT: 2247. code.  *note HRESULT: 2247. values contain
     information specifying whether the function call failed or
     succeeded, together with additional error code.  If the return
     value signals a failure, an *note OSError: 1d1. is automatically
     raised.

     Changed in version 3.3: *note WindowsError: 988. used to be raised.

 -- Class: ctypes.WinDLL (name, mode=DEFAULT_MODE, handle=None,
          use_errno=False, use_last_error=False, winmode=0)

     Windows only: Instances of this class represent loaded shared
     libraries, functions in these libraries use the ‘stdcall’ calling
     convention, and are assumed to return ‘int’ by default.

     On Windows CE only the standard calling convention is used, for
     convenience the *note WinDLL: 2248. and *note OleDLL: 2246. use the
     standard calling convention on this platform.

The Python *note global interpreter lock: 4fb. is released before
calling any function exported by these libraries, and reacquired
afterwards.

 -- Class: ctypes.PyDLL (name, mode=DEFAULT_MODE, handle=None)

     Instances of this class behave like *note CDLL: 1bf. instances,
     except that the Python GIL is `not' released during the function
     call, and after the function execution the Python error flag is
     checked.  If the error flag is set, a Python exception is raised.

     Thus, this is only useful to call Python C api functions directly.

All these classes can be instantiated by calling them with at least one
argument, the pathname of the shared library.  If you have an existing
handle to an already loaded shared library, it can be passed as the
‘handle’ named parameter, otherwise the underlying platforms ‘dlopen’ or
‘LoadLibrary’ function is used to load the library into the process, and
to get a handle to it.

The `mode' parameter can be used to specify how the library is loaded.
For details, consult the ‘dlopen(3)’ manpage.  On Windows, `mode' is
ignored.  On posix systems, RTLD_NOW is always added, and is not
configurable.

The `use_errno' parameter, when set to true, enables a ctypes mechanism
that allows accessing the system *note errno: 7c. error number in a safe
way.  *note ctypes: 2b. maintains a thread-local copy of the systems
*note errno: 7c. variable; if you call foreign functions created with
‘use_errno=True’ then the *note errno: 7c. value before the function
call is swapped with the ctypes private copy, the same happens
immediately after the function call.

The function *note ctypes.get_errno(): 224a. returns the value of the
ctypes private copy, and the function *note ctypes.set_errno(): 224b.
changes the ctypes private copy to a new value and returns the former
value.

The `use_last_error' parameter, when set to true, enables the same
mechanism for the Windows error code which is managed by the *note
GetLastError(): 2219. and ‘SetLastError()’ Windows API functions; *note
ctypes.get_last_error(): 224c. and *note ctypes.set_last_error(): 224d.
are used to request and change the ctypes private copy of the windows
error code.

The `winmode' parameter is used on Windows to specify how the library is
loaded (since `mode' is ignored).  It takes any value that is valid for
the Win32 API ‘LoadLibraryEx’ flags parameter.  When omitted, the
default is to use the flags that result in the most secure DLL load to
avoiding issues such as DLL hijacking.  Passing the full path to the DLL
is the safest way to ensure the correct library and dependencies are
loaded.

Changed in version 3.8: Added `winmode' parameter.

 -- Data: ctypes.RTLD_GLOBAL

     Flag to use as `mode' parameter.  On platforms where this flag is
     not available, it is defined as the integer zero.

 -- Data: ctypes.RTLD_LOCAL

     Flag to use as `mode' parameter.  On platforms where this is not
     available, it is the same as `RTLD_GLOBAL'.

 -- Data: ctypes.DEFAULT_MODE

     The default mode which is used to load shared libraries.  On OSX
     10.3, this is `RTLD_GLOBAL', otherwise it is the same as
     `RTLD_LOCAL'.

Instances of these classes have no public methods.  Functions exported
by the shared library can be accessed as attributes or by index.  Please
note that accessing the function through an attribute caches the result
and therefore accessing it repeatedly returns the same object each time.
On the other hand, accessing it through an index returns a new object
each time:

     >>> from ctypes import CDLL >>> libc = CDLL("libc.so.6")  # On Linux >>> libc.time == libc.time True >>> libc['time'] == libc['time'] False

The following public attributes are available, their name starts with an
underscore to not clash with exported function names:

 -- Attribute: PyDLL._handle

     The system handle used to access the library.

 -- Attribute: PyDLL._name

     The name of the library passed in the constructor.

Shared libraries can also be loaded by using one of the prefabricated
objects, which are instances of the *note LibraryLoader: 2250. class,
either by calling the ‘LoadLibrary()’ method, or by retrieving the
library as attribute of the loader instance.

 -- Class: ctypes.LibraryLoader (dlltype)

     Class which loads shared libraries.  `dlltype' should be one of the
     *note CDLL: 1bf, *note PyDLL: 2249, *note WinDLL: 2248, or *note
     OleDLL: 2246. types.

     *note __getattr__(): 30f. has special behavior: It allows loading a
     shared library by accessing it as attribute of a library loader
     instance.  The result is cached, so repeated attribute accesses
     return the same library each time.

      -- Method: LoadLibrary (name)

          Load a shared library into the process and return it.  This
          method always returns a new instance of the library.

These prefabricated library loaders are available:

 -- Data: ctypes.cdll

     Creates *note CDLL: 1bf. instances.

 -- Data: ctypes.windll

     Windows only: Creates *note WinDLL: 2248. instances.

 -- Data: ctypes.oledll

     Windows only: Creates *note OleDLL: 2246. instances.

 -- Data: ctypes.pydll

     Creates *note PyDLL: 2249. instances.

For accessing the C Python api directly, a ready-to-use Python shared
library object is available:

 -- Data: ctypes.pythonapi

     An instance of *note PyDLL: 2249. that exposes Python C API
     functions as attributes.  Note that all these functions are assumed
     to return C ‘int’, which is of course not always the truth, so you
     have to assign the correct ‘restype’ attribute to use these
     functions.

Loading a library through any of these objects raises an *note auditing
event: 1275. ‘ctypes.dlopen’ with string argument ‘name’, the name used
to load the library.

Accessing a function on a loaded library raises an auditing event
‘ctypes.dlsym’ with arguments ‘library’ (the library object) and ‘name’
(the symbol’s name as a string or integer).

In cases when only the library handle is available rather than the
object, accessing a function raises an auditing event
‘ctypes.dlsym/handle’ with arguments ‘handle’ (the raw library handle)
and ‘name’.


File: python.info,  Node: Foreign functions,  Next: Function prototypes,  Prev: Loading shared libraries,  Up: ctypes reference

5.16.16.25 Foreign functions
............................

As explained in the previous section, foreign functions can be accessed
as attributes of loaded shared libraries.  The function objects created
in this way by default accept any number of arguments, accept any ctypes
data instances as arguments, and return the default result type
specified by the library loader.  They are instances of a private class:

 -- Class: ctypes._FuncPtr

     Base class for C callable foreign functions.

     Instances of foreign functions are also C compatible data types;
     they represent C function pointers.

     This behavior can be customized by assigning to special attributes
     of the foreign function object.

      -- Attribute: restype

          Assign a ctypes type to specify the result type of the foreign
          function.  Use ‘None’ for ‘void’, a function not returning
          anything.

          It is possible to assign a callable Python object that is not
          a ctypes type, in this case the function is assumed to return
          a C ‘int’, and the callable will be called with this integer,
          allowing further processing or error checking.  Using this is
          deprecated, for more flexible post processing or error
          checking use a ctypes data type as *note restype: 2255. and
          assign a callable to the *note errcheck: 2256. attribute.

      -- Attribute: argtypes

          Assign a tuple of ctypes types to specify the argument types
          that the function accepts.  Functions using the ‘stdcall’
          calling convention can only be called with the same number of
          arguments as the length of this tuple; functions using the C
          calling convention accept additional, unspecified arguments as
          well.

          When a foreign function is called, each actual argument is
          passed to the ‘from_param()’ class method of the items in the
          *note argtypes: 2257. tuple, this method allows adapting the
          actual argument to an object that the foreign function
          accepts.  For example, a *note c_char_p: 220d. item in the
          *note argtypes: 2257. tuple will convert a string passed as
          argument into a bytes object using ctypes conversion rules.

          New: It is now possible to put items in argtypes which are not
          ctypes types, but each item must have a ‘from_param()’ method
          which returns a value usable as argument (integer, string,
          ctypes instance).  This allows defining adapters that can
          adapt custom objects as function parameters.

      -- Attribute: errcheck

          Assign a Python function or another callable to this
          attribute.  The callable will be called with three or more
          arguments:

           -- Function: callable (result, func, arguments)

               `result' is what the foreign function returns, as
               specified by the ‘restype’ attribute.

               `func' is the foreign function object itself, this allows
               reusing the same callable object to check or post process
               the results of several functions.

               `arguments' is a tuple containing the parameters
               originally passed to the function call, this allows
               specializing the behavior on the arguments used.

          The object that this function returns will be returned from
          the foreign function call, but it can also check the result
          value and raise an exception if the foreign function call
          failed.

 -- Exception: ctypes.ArgumentError

     This exception is raised when a foreign function call cannot
     convert one of the passed arguments.

On Windows, when a foreign function call raises a system exception (for
example, due to an access violation), it will be captured and replaced
with a suitable Python exception.  Further, an auditing event
‘ctypes.seh_exception’ with argument ‘code’ will be raised, allowing an
audit hook to replace the exception with its own.

Some ways to invoke foreign function calls may raise an auditing event
‘ctypes.call_function’ with arguments ‘function pointer’ and
‘arguments’.


File: python.info,  Node: Function prototypes,  Next: Utility functions,  Prev: Foreign functions,  Up: ctypes reference

5.16.16.26 Function prototypes
..............................

Foreign functions can also be created by instantiating function
prototypes.  Function prototypes are similar to function prototypes in
C; they describe a function (return type, argument types, calling
convention) without defining an implementation.  The factory functions
must be called with the desired result type and the argument types of
the function, and can be used as decorator factories, and as such, be
applied to functions through the ‘@wrapper’ syntax.  See *note Callback
functions: 2233. for examples.

 -- Function: ctypes.CFUNCTYPE (restype, *argtypes, use_errno=False,
          use_last_error=False)

     The returned function prototype creates functions that use the
     standard C calling convention.  The function will release the GIL
     during the call.  If `use_errno' is set to true, the ctypes private
     copy of the system *note errno: 7c. variable is exchanged with the
     real *note errno: 7c. value before and after the call;
     `use_last_error' does the same for the Windows error code.

 -- Function: ctypes.WINFUNCTYPE (restype, *argtypes, use_errno=False,
          use_last_error=False)

     Windows only: The returned function prototype creates functions
     that use the ‘stdcall’ calling convention, except on Windows CE
     where *note WINFUNCTYPE(): 2235. is the same as *note CFUNCTYPE():
     2234.  The function will release the GIL during the call.
     `use_errno' and `use_last_error' have the same meaning as above.

 -- Function: ctypes.PYFUNCTYPE (restype, *argtypes)

     The returned function prototype creates functions that use the
     Python calling convention.  The function will `not' release the GIL
     during the call.

Function prototypes created by these factory functions can be
instantiated in different ways, depending on the type and number of the
parameters in the call:

      -- Function: prototype (address)

          Returns a foreign function at the specified address which must
          be an integer.

      -- Function: prototype (callable)

          Create a C callable function (a callback function) from a
          Python `callable'.

      -- Function: prototype (func_spec[, paramflags])

          Returns a foreign function exported by a shared library.
          `func_spec' must be a 2-tuple ‘(name_or_ordinal, library)’.
          The first item is the name of the exported function as string,
          or the ordinal of the exported function as small integer.  The
          second item is the shared library instance.

      -- Function: prototype (vtbl_index, name[, paramflags[, iid]])

          Returns a foreign function that will call a COM method.
          `vtbl_index' is the index into the virtual function table, a
          small non-negative integer.  `name' is name of the COM method.
          `iid' is an optional pointer to the interface identifier which
          is used in extended error reporting.

          COM methods use a special calling convention: They require a
          pointer to the COM interface as first argument, in addition to
          those parameters that are specified in the ‘argtypes’ tuple.

     The optional `paramflags' parameter creates foreign function
     wrappers with much more functionality than the features described
     above.

     `paramflags' must be a tuple of the same length as ‘argtypes’.

     Each item in this tuple contains further information about a
     parameter, it must be a tuple containing one, two, or three items.

     The first item is an integer containing a combination of direction
     flags for the parameter:

          1

               Specifies an input parameter to the function.

          2

               Output parameter.  The foreign function fills in a value.

          4

               Input parameter which defaults to the integer zero.

     The optional second item is the parameter name as string.  If this
     is specified, the foreign function can be called with named
     parameters.

     The optional third item is the default value for this parameter.

This example demonstrates how to wrap the Windows ‘MessageBoxW’ function
so that it supports default parameters and named arguments.  The C
declaration from the windows header file is this:

     WINUSERAPI int WINAPI MessageBoxW(     HWND hWnd,     LPCWSTR lpText,     LPCWSTR lpCaption,     UINT uType);

Here is the wrapping with *note ctypes: 2b.:

     >>> from ctypes import c_int, WINFUNCTYPE, windll >>> from ctypes.wintypes import HWND, LPCWSTR, UINT >>> prototype = WINFUNCTYPE(c_int, HWND, LPCWSTR, LPCWSTR, UINT) >>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", "Hello from ctypes"), (1, "flags", 0) >>> MessageBox = prototype(("MessageBoxW", windll.user32), paramflags)

The ‘MessageBox’ foreign function can now be called in these ways:

     >>> MessageBox() >>> MessageBox(text="Spam, spam, spam") >>> MessageBox(flags=2, text="foo bar")

A second example demonstrates output parameters.  The win32
‘GetWindowRect’ function retrieves the dimensions of a specified window
by copying them into ‘RECT’ structure that the caller has to supply.
Here is the C declaration:

     WINUSERAPI BOOL WINAPI GetWindowRect(      HWND hWnd,      LPRECT lpRect);

Here is the wrapping with *note ctypes: 2b.:

     >>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError >>> from ctypes.wintypes import BOOL, HWND, RECT >>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT)) >>> paramflags = (1, "hwnd"), (2, "lprect") >>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags) >>>

Functions with output parameters will automatically return the output
parameter value if there is a single one, or a tuple containing the
output parameter values when there are more than one, so the
GetWindowRect function now returns a RECT instance, when called.

Output parameters can be combined with the ‘errcheck’ protocol to do
further output processing and error checking.  The win32 ‘GetWindowRect’
api function returns a ‘BOOL’ to signal success or failure, so this
function could do the error checking, and raises an exception when the
api call failed:

     >>> def errcheck(result, func, args): ...     if not result: ...         raise WinError() ...     return args ... >>> GetWindowRect.errcheck = errcheck >>>

If the ‘errcheck’ function returns the argument tuple it receives
unchanged, *note ctypes: 2b. continues the normal processing it does on
the output parameters.  If you want to return a tuple of window
coordinates instead of a ‘RECT’ instance, you can retrieve the fields in
the function and return them instead, the normal processing will no
longer take place:

     >>> def errcheck(result, func, args): ...     if not result: ...         raise WinError() ...     rc = args[1] ...     return rc.left, rc.top, rc.bottom, rc.right ... >>> GetWindowRect.errcheck = errcheck >>>


File: python.info,  Node: Utility functions,  Next: Data types,  Prev: Function prototypes,  Up: ctypes reference

5.16.16.27 Utility functions
............................

 -- Function: ctypes.addressof (obj)

     Returns the address of the memory buffer as integer.  `obj' must be
     an instance of a ctypes type.

     Raises an *note auditing event: 1275. ‘ctypes.addressof’ with
     argument ‘obj’.

 -- Function: ctypes.alignment (obj_or_type)

     Returns the alignment requirements of a ctypes type.  `obj_or_type'
     must be a ctypes type or instance.

 -- Function: ctypes.byref (obj[, offset])

     Returns a light-weight pointer to `obj', which must be an instance
     of a ctypes type.  `offset' defaults to zero, and must be an
     integer that will be added to the internal pointer value.

     ‘byref(obj, offset)’ corresponds to this C code:

          (((char *)&obj) + offset)

     The returned object can only be used as a foreign function call
     parameter.  It behaves similar to ‘pointer(obj)’, but the
     construction is a lot faster.

 -- Function: ctypes.cast (obj, type)

     This function is similar to the cast operator in C. It returns a
     new instance of `type' which points to the same memory block as
     `obj'.  `type' must be a pointer type, and `obj' must be an object
     that can be interpreted as a pointer.

 -- Function: ctypes.create_string_buffer (init_or_size, size=None)

     This function creates a mutable character buffer.  The returned
     object is a ctypes array of *note c_char: 21ff.

     `init_or_size' must be an integer which specifies the size of the
     array, or a bytes object which will be used to initialize the array
     items.

     If a bytes object is specified as first argument, the buffer is
     made one item larger than its length so that the last element in
     the array is a NUL termination character.  An integer can be passed
     as second argument which allows specifying the size of the array if
     the length of the bytes should not be used.

     Raises an *note auditing event: 1275. ‘ctypes.create_string_buffer’
     with arguments ‘init’, ‘size’.

 -- Function: ctypes.create_unicode_buffer (init_or_size, size=None)

     This function creates a mutable unicode character buffer.  The
     returned object is a ctypes array of *note c_wchar: 2200.

     `init_or_size' must be an integer which specifies the size of the
     array, or a string which will be used to initialize the array
     items.

     If a string is specified as first argument, the buffer is made one
     item larger than the length of the string so that the last element
     in the array is a NUL termination character.  An integer can be
     passed as second argument which allows specifying the size of the
     array if the length of the string should not be used.

     Raises an *note auditing event: 1275.
     ‘ctypes.create_unicode_buffer’ with arguments ‘init’, ‘size’.

 -- Function: ctypes.DllCanUnloadNow ()

     Windows only: This function is a hook which allows implementing
     in-process COM servers with ctypes.  It is called from the
     DllCanUnloadNow function that the _ctypes extension dll exports.

 -- Function: ctypes.DllGetClassObject ()

     Windows only: This function is a hook which allows implementing
     in-process COM servers with ctypes.  It is called from the
     DllGetClassObject function that the ‘_ctypes’ extension dll
     exports.

 -- Function: ctypes.util.find_library (name)

     Try to find a library and return a pathname.  `name' is the library
     name without any prefix like ‘lib’, suffix like ‘.so’, ‘.dylib’ or
     version number (this is the form used for the posix linker option
     ‘-l’).  If no library can be found, returns ‘None’.

     The exact functionality is system dependent.

 -- Function: ctypes.util.find_msvcrt ()

     Windows only: return the filename of the VC runtime library used by
     Python, and by the extension modules.  If the name of the library
     cannot be determined, ‘None’ is returned.

     If you need to free memory, for example, allocated by an extension
     module with a call to the ‘free(void *)’, it is important that you
     use the function in the same library that allocated the memory.

 -- Function: ctypes.FormatError ([code])

     Windows only: Returns a textual description of the error code
     `code'.  If no error code is specified, the last error code is used
     by calling the Windows api function GetLastError.

 -- Function: ctypes.GetLastError ()

     Windows only: Returns the last error code set by Windows in the
     calling thread.  This function calls the Windows ‘GetLastError()’
     function directly, it does not return the ctypes-private copy of
     the error code.

 -- Function: ctypes.get_errno ()

     Returns the current value of the ctypes-private copy of the system
     *note errno: 7c. variable in the calling thread.

     Raises an *note auditing event: 1275. ‘ctypes.get_errno’ with no
     arguments.

 -- Function: ctypes.get_last_error ()

     Windows only: returns the current value of the ctypes-private copy
     of the system ‘LastError’ variable in the calling thread.

     Raises an *note auditing event: 1275. ‘ctypes.get_last_error’ with
     no arguments.

 -- Function: ctypes.memmove (dst, src, count)

     Same as the standard C memmove library function: copies `count'
     bytes from `src' to `dst'.  `dst' and `src' must be integers or
     ctypes instances that can be converted to pointers.

 -- Function: ctypes.memset (dst, c, count)

     Same as the standard C memset library function: fills the memory
     block at address `dst' with `count' bytes of value `c'.  `dst' must
     be an integer specifying an address, or a ctypes instance.

 -- Function: ctypes.POINTER (type)

     This factory function creates and returns a new ctypes pointer
     type.  Pointer types are cached and reused internally, so calling
     this function repeatedly is cheap.  `type' must be a ctypes type.

 -- Function: ctypes.pointer (obj)

     This function creates a new pointer instance, pointing to `obj'.
     The returned object is of the type ‘POINTER(type(obj))’.

     Note: If you just want to pass a pointer to an object to a foreign
     function call, you should use ‘byref(obj)’ which is much faster.

 -- Function: ctypes.resize (obj, size)

     This function resizes the internal memory buffer of `obj', which
     must be an instance of a ctypes type.  It is not possible to make
     the buffer smaller than the native size of the objects type, as
     given by ‘sizeof(type(obj))’, but it is possible to enlarge the
     buffer.

 -- Function: ctypes.set_errno (value)

     Set the current value of the ctypes-private copy of the system
     *note errno: 7c. variable in the calling thread to `value' and
     return the previous value.

     Raises an *note auditing event: 1275. ‘ctypes.set_errno’ with
     argument ‘errno’.

 -- Function: ctypes.set_last_error (value)

     Windows only: set the current value of the ctypes-private copy of
     the system ‘LastError’ variable in the calling thread to `value'
     and return the previous value.

     Raises an *note auditing event: 1275. ‘ctypes.set_last_error’ with
     argument ‘error’.

 -- Function: ctypes.sizeof (obj_or_type)

     Returns the size in bytes of a ctypes type or instance memory
     buffer.  Does the same as the C ‘sizeof’ operator.

 -- Function: ctypes.string_at (address, size=-1)

     This function returns the C string starting at memory address
     `address' as a bytes object.  If size is specified, it is used as
     size, otherwise the string is assumed to be zero-terminated.

     Raises an *note auditing event: 1275. ‘ctypes.string_at’ with
     arguments ‘address’, ‘size’.

 -- Function: ctypes.WinError (code=None, descr=None)

     Windows only: this function is probably the worst-named thing in
     ctypes.  It creates an instance of OSError.  If `code' is not
     specified, ‘GetLastError’ is called to determine the error code.
     If `descr' is not specified, *note FormatError(): 2263. is called
     to get a textual description of the error.

     Changed in version 3.3: An instance of *note WindowsError: 988.
     used to be created.

 -- Function: ctypes.wstring_at (address, size=-1)

     This function returns the wide character string starting at memory
     address `address' as a string.  If `size' is specified, it is used
     as the number of characters of the string, otherwise the string is
     assumed to be zero-terminated.

     Raises an *note auditing event: 1275. ‘ctypes.wstring_at’ with
     arguments ‘address’, ‘size’.


File: python.info,  Node: Data types,  Next: Fundamental data types<2>,  Prev: Utility functions,  Up: ctypes reference

5.16.16.28 Data types
.....................

 -- Class: ctypes._CData

     This non-public class is the common base class of all ctypes data
     types.  Among other things, all ctypes type instances contain a
     memory block that hold C compatible data; the address of the memory
     block is returned by the *note addressof(): 225e. helper function.
     Another instance variable is exposed as *note _objects: 226c.; this
     contains other Python objects that need to be kept alive in case
     the memory block contains pointers.

     Common methods of ctypes data types, these are all class methods
     (to be exact, they are methods of the *note metaclass: 226d.):

      -- Method: from_buffer (source[, offset])

          This method returns a ctypes instance that shares the buffer
          of the `source' object.  The `source' object must support the
          writeable buffer interface.  The optional `offset' parameter
          specifies an offset into the source buffer in bytes; the
          default is zero.  If the source buffer is not large enough a
          *note ValueError: 1f9. is raised.

          Raises an *note auditing event: 1275. ‘ctypes.cdata/buffer’
          with arguments ‘pointer’, ‘size’, ‘offset’.

      -- Method: from_buffer_copy (source[, offset])

          This method creates a ctypes instance, copying the buffer from
          the `source' object buffer which must be readable.  The
          optional `offset' parameter specifies an offset into the
          source buffer in bytes; the default is zero.  If the source
          buffer is not large enough a *note ValueError: 1f9. is raised.

          Raises an *note auditing event: 1275. ‘ctypes.cdata/buffer’
          with arguments ‘pointer’, ‘size’, ‘offset’.

      -- Method: from_address (address)

          This method returns a ctypes type instance using the memory
          specified by `address' which must be an integer.

          This method, and others that indirectly call this method,
          raises an *note auditing event: 1275. ‘ctypes.cdata’ with
          argument ‘address’.

      -- Method: from_param (obj)

          This method adapts `obj' to a ctypes type.  It is called with
          the actual object used in a foreign function call when the
          type is present in the foreign function’s ‘argtypes’ tuple; it
          must return an object that can be used as a function call
          parameter.

          All ctypes data types have a default implementation of this
          classmethod that normally returns `obj' if that is an instance
          of the type.  Some types accept other objects as well.

      -- Method: in_dll (library, name)

          This method returns a ctypes type instance exported by a
          shared library.  `name' is the name of the symbol that exports
          the data, `library' is the loaded shared library.

     Common instance variables of ctypes data types:

      -- Attribute: _b_base_

          Sometimes ctypes data instances do not own the memory block
          they contain, instead they share part of the memory block of a
          base object.  The *note _b_base_: 2273. read-only member is
          the root ctypes object that owns the memory block.

      -- Attribute: _b_needsfree_

          This read-only variable is true when the ctypes data instance
          has allocated the memory block itself, false otherwise.

      -- Attribute: _objects

          This member is either ‘None’ or a dictionary containing Python
          objects that need to be kept alive so that the memory block
          contents is kept valid.  This object is only exposed for
          debugging; never modify the contents of this dictionary.


File: python.info,  Node: Fundamental data types<2>,  Next: Structured data types,  Prev: Data types,  Up: ctypes reference

5.16.16.29 Fundamental data types
.................................

 -- Class: ctypes._SimpleCData

     This non-public class is the base class of all fundamental ctypes
     data types.  It is mentioned here because it contains the common
     attributes of the fundamental ctypes data types.  *note
     _SimpleCData: 2277. is a subclass of *note _CData: fe9, so it
     inherits their methods and attributes.  ctypes data types that are
     not and do not contain pointers can now be pickled.

     Instances have a single attribute:

      -- Attribute: value

          This attribute contains the actual value of the instance.  For
          integer and pointer types, it is an integer, for character
          types, it is a single character bytes object or string, for
          character pointer types it is a Python bytes object or string.

          When the ‘value’ attribute is retrieved from a ctypes
          instance, usually a new object is returned each time.  *note
          ctypes: 2b. does `not' implement original object return,
          always a new object is constructed.  The same is true for all
          other ctypes object instances.

Fundamental data types, when returned as foreign function call results,
or, for example, by retrieving structure field members or array items,
are transparently converted to native Python types.  In other words, if
a foreign function has a ‘restype’ of *note c_char_p: 220d, you will
always receive a Python bytes object, `not' a *note c_char_p: 220d.
instance.

Subclasses of fundamental data types do `not' inherit this behavior.
So, if a foreign functions ‘restype’ is a subclass of *note c_void_p:
220f, you will receive an instance of this subclass from the function
call.  Of course, you can get the value of the pointer by accessing the
‘value’ attribute.

These are the fundamental ctypes data types:

 -- Class: ctypes.c_byte

     Represents the C ‘signed char’ datatype, and interprets the value
     as small integer.  The constructor accepts an optional integer
     initializer; no overflow checking is done.

 -- Class: ctypes.c_char

     Represents the C ‘char’ datatype, and interprets the value as a
     single character.  The constructor accepts an optional string
     initializer, the length of the string must be exactly one
     character.

 -- Class: ctypes.c_char_p

     Represents the C ‘char *’ datatype when it points to a
     zero-terminated string.  For a general character pointer that may
     also point to binary data, ‘POINTER(c_char)’ must be used.  The
     constructor accepts an integer address, or a bytes object.

 -- Class: ctypes.c_double

     Represents the C ‘double’ datatype.  The constructor accepts an
     optional float initializer.

 -- Class: ctypes.c_longdouble

     Represents the C ‘long double’ datatype.  The constructor accepts
     an optional float initializer.  On platforms where ‘sizeof(long
     double) == sizeof(double)’ it is an alias to *note c_double: 220b.

 -- Class: ctypes.c_float

     Represents the C ‘float’ datatype.  The constructor accepts an
     optional float initializer.

 -- Class: ctypes.c_int

     Represents the C ‘signed int’ datatype.  The constructor accepts an
     optional integer initializer; no overflow checking is done.  On
     platforms where ‘sizeof(int) == sizeof(long)’ it is an alias to
     *note c_long: 21f5.

 -- Class: ctypes.c_int8

     Represents the C 8-bit ‘signed int’ datatype.  Usually an alias for
     *note c_byte: 2201.

 -- Class: ctypes.c_int16

     Represents the C 16-bit ‘signed int’ datatype.  Usually an alias
     for *note c_short: 2203.

 -- Class: ctypes.c_int32

     Represents the C 32-bit ‘signed int’ datatype.  Usually an alias
     for *note c_int: 21f4.

 -- Class: ctypes.c_int64

     Represents the C 64-bit ‘signed int’ datatype.  Usually an alias
     for *note c_longlong: 2207.

 -- Class: ctypes.c_long

     Represents the C ‘signed long’ datatype.  The constructor accepts
     an optional integer initializer; no overflow checking is done.

 -- Class: ctypes.c_longlong

     Represents the C ‘signed long long’ datatype.  The constructor
     accepts an optional integer initializer; no overflow checking is
     done.

 -- Class: ctypes.c_short

     Represents the C ‘signed short’ datatype.  The constructor accepts
     an optional integer initializer; no overflow checking is done.

 -- Class: ctypes.c_size_t

     Represents the C ‘size_t’ datatype.

 -- Class: ctypes.c_ssize_t

     Represents the C ‘ssize_t’ datatype.

     New in version 3.2.

 -- Class: ctypes.c_ubyte

     Represents the C ‘unsigned char’ datatype, it interprets the value
     as small integer.  The constructor accepts an optional integer
     initializer; no overflow checking is done.

 -- Class: ctypes.c_uint

     Represents the C ‘unsigned int’ datatype.  The constructor accepts
     an optional integer initializer; no overflow checking is done.  On
     platforms where ‘sizeof(int) == sizeof(long)’ it is an alias for
     *note c_ulong: 2206.

 -- Class: ctypes.c_uint8

     Represents the C 8-bit ‘unsigned int’ datatype.  Usually an alias
     for *note c_ubyte: 2202.

 -- Class: ctypes.c_uint16

     Represents the C 16-bit ‘unsigned int’ datatype.  Usually an alias
     for *note c_ushort: 2204.

 -- Class: ctypes.c_uint32

     Represents the C 32-bit ‘unsigned int’ datatype.  Usually an alias
     for *note c_uint: 2205.

 -- Class: ctypes.c_uint64

     Represents the C 64-bit ‘unsigned int’ datatype.  Usually an alias
     for *note c_ulonglong: 2208.

 -- Class: ctypes.c_ulong

     Represents the C ‘unsigned long’ datatype.  The constructor accepts
     an optional integer initializer; no overflow checking is done.

 -- Class: ctypes.c_ulonglong

     Represents the C ‘unsigned long long’ datatype.  The constructor
     accepts an optional integer initializer; no overflow checking is
     done.

 -- Class: ctypes.c_ushort

     Represents the C ‘unsigned short’ datatype.  The constructor
     accepts an optional integer initializer; no overflow checking is
     done.

 -- Class: ctypes.c_void_p

     Represents the C ‘void *’ type.  The value is represented as
     integer.  The constructor accepts an optional integer initializer.

 -- Class: ctypes.c_wchar

     Represents the C ‘wchar_t’ datatype, and interprets the value as a
     single character unicode string.  The constructor accepts an
     optional string initializer, the length of the string must be
     exactly one character.

 -- Class: ctypes.c_wchar_p

     Represents the C ‘wchar_t *’ datatype, which must be a pointer to a
     zero-terminated wide character string.  The constructor accepts an
     integer address, or a string.

 -- Class: ctypes.c_bool

     Represent the C ‘bool’ datatype (more accurately, ‘_Bool’ from
     C99).  Its value can be ‘True’ or ‘False’, and the constructor
     accepts any object that has a truth value.

 -- Class: ctypes.HRESULT

     Windows only: Represents a ‘HRESULT’ value, which contains success
     or error information for a function or method call.

 -- Class: ctypes.py_object

     Represents the C *note PyObject *: 4b0. datatype.  Calling this
     without an argument creates a ‘NULL’ *note PyObject *: 4b0.
     pointer.

The ‘ctypes.wintypes’ module provides quite some other Windows specific
data types, for example ‘HWND’, ‘WPARAM’, or ‘DWORD’.  Some useful
structures like ‘MSG’ or ‘RECT’ are also defined.


File: python.info,  Node: Structured data types,  Next: Arrays and pointers,  Prev: Fundamental data types<2>,  Up: ctypes reference

5.16.16.30 Structured data types
................................

 -- Class: ctypes.Union (*args, **kw)

     Abstract base class for unions in native byte order.

 -- Class: ctypes.BigEndianStructure (*args, **kw)

     Abstract base class for structures in `big endian' byte order.

 -- Class: ctypes.LittleEndianStructure (*args, **kw)

     Abstract base class for structures in `little endian' byte order.

Structures with non-native byte order cannot contain pointer type
fields, or any other data types containing pointer type fields.

 -- Class: ctypes.Structure (*args, **kw)

     Abstract base class for structures in `native' byte order.

     Concrete structure and union types must be created by subclassing
     one of these types, and at least define a *note _fields_: 2284.
     class variable.  *note ctypes: 2b. will create *note descriptor:
     1541.s which allow reading and writing the fields by direct
     attribute accesses.  These are the

      -- Attribute: _fields_

          A sequence defining the structure fields.  The items must be
          2-tuples or 3-tuples.  The first item is the name of the
          field, the second item specifies the type of the field; it can
          be any ctypes data type.

          For integer type fields like *note c_int: 21f4, a third
          optional item can be given.  It must be a small positive
          integer defining the bit width of the field.

          Field names must be unique within one structure or union.
          This is not checked, only one field can be accessed when names
          are repeated.

          It is possible to define the *note _fields_: 2284. class
          variable `after' the class statement that defines the
          Structure subclass, this allows creating data types that
          directly or indirectly reference themselves:

               class List(Structure):     pass List._fields_ = [("pnext", POINTER(List)),                  ...                 ]

          The *note _fields_: 2284. class variable must, however, be
          defined before the type is first used (an instance is created,
          *note sizeof(): 2266. is called on it, and so on).  Later
          assignments to the *note _fields_: 2284. class variable will
          raise an AttributeError.

          It is possible to define sub-subclasses of structure types,
          they inherit the fields of the base class plus the *note
          _fields_: 2284. defined in the sub-subclass, if any.

      -- Attribute: _pack_

          An optional small integer that allows overriding the alignment
          of structure fields in the instance.  *note _pack_: 2285. must
          already be defined when *note _fields_: 2284. is assigned,
          otherwise it will have no effect.

      -- Attribute: _anonymous_

          An optional sequence that lists the names of unnamed
          (anonymous) fields.  *note _anonymous_: 2286. must be already
          defined when *note _fields_: 2284. is assigned, otherwise it
          will have no effect.

          The fields listed in this variable must be structure or union
          type fields.  *note ctypes: 2b. will create descriptors in the
          structure type that allows accessing the nested fields
          directly, without the need to create the structure or union
          field.

          Here is an example type (Windows):

               class _U(Union):     _fields_ = [("lptdesc", POINTER(TYPEDESC)),                 ("lpadesc", POINTER(ARRAYDESC)),                 ("hreftype", HREFTYPE)]  class TYPEDESC(Structure):     _anonymous_ = ("u",)     _fields_ = [("u", _U),                 ("vt", VARTYPE)]

          The ‘TYPEDESC’ structure describes a COM data type, the ‘vt’
          field specifies which one of the union fields is valid.  Since
          the ‘u’ field is defined as anonymous field, it is now
          possible to access the members directly off the TYPEDESC
          instance.  ‘td.lptdesc’ and ‘td.u.lptdesc’ are equivalent, but
          the former is faster since it does not need to create a
          temporary union instance:

               td = TYPEDESC() td.vt = VT_PTR td.lptdesc = POINTER(some_type) td.u.lptdesc = POINTER(some_type)

     It is possible to define sub-subclasses of structures, they inherit
     the fields of the base class.  If the subclass definition has a
     separate *note _fields_: 2284. variable, the fields specified in
     this are appended to the fields of the base class.

     Structure and union constructors accept both positional and keyword
     arguments.  Positional arguments are used to initialize member
     fields in the same order as they are appear in *note _fields_:
     2284.  Keyword arguments in the constructor are interpreted as
     attribute assignments, so they will initialize *note _fields_:
     2284. with the same name, or create new attributes for names not
     present in *note _fields_: 2284.


File: python.info,  Node: Arrays and pointers,  Prev: Structured data types,  Up: ctypes reference

5.16.16.31 Arrays and pointers
..............................

 -- Class: ctypes.Array (*args)

     Abstract base class for arrays.

     The recommended way to create concrete array types is by
     multiplying any *note ctypes: 2b. data type with a positive
     integer.  Alternatively, you can subclass this type and define
     *note _length_: 2289. and *note _type_: 228a. class variables.
     Array elements can be read and written using standard subscript and
     slice accesses; for slice reads, the resulting object is `not'
     itself an *note Array: f40.

      -- Attribute: _length_

          A positive integer specifying the number of elements in the
          array.  Out-of-range subscripts result in an *note IndexError:
          e69.  Will be returned by *note len(): 150.

      -- Attribute: _type_

          Specifies the type of each element in the array.

     Array subclass constructors accept positional arguments, used to
     initialize the elements in order.

 -- Class: ctypes._Pointer

     Private, abstract base class for pointers.

     Concrete pointer types are created by calling *note POINTER():
     222d. with the type that will be pointed to; this is done
     automatically by *note pointer(): 221d.

     If a pointer points to an array, its elements can be read and
     written using standard subscript and slice accesses.  Pointer
     objects have no size, so *note len(): 150. will raise *note
     TypeError: 192.  Negative subscripts will read from the memory
     `before' the pointer (as in C), and out-of-range subscripts will
     probably crash with an access violation (if you’re lucky).

      -- Attribute: _type_

          Specifies the type pointed to.

      -- Attribute: contents

          Returns the object to which to pointer points.  Assigning to
          this attribute changes the pointer to point to the assigned
          object.


File: python.info,  Node: Concurrent Execution,  Next: contextvars — Context Variables,  Prev: Generic Operating System Services,  Up: The Python Standard Library

5.17 Concurrent Execution
=========================

The modules described in this chapter provide support for concurrent
execution of code.  The appropriate choice of tool will depend on the
task to be executed (CPU bound vs IO bound) and preferred style of
development (event driven cooperative multitasking vs preemptive
multitasking).  Here’s an overview:

* Menu:

* threading — Thread-based parallelism::
* multiprocessing — Process-based parallelism::
* multiprocessing.shared_memory — Provides shared memory for direct access across processes: multiprocessing shared_memory — Provides shared memory for direct access across processes.
* The concurrent package::
* concurrent.futures — Launching parallel tasks: concurrent futures — Launching parallel tasks.
* subprocess — Subprocess management::
* sched — Event scheduler::
* queue — A synchronized queue class::
* _thread — Low-level threading API::
* _dummy_thread — Drop-in replacement for the _thread module::
* dummy_threading — Drop-in replacement for the threading module::


File: python.info,  Node: threading — Thread-based parallelism,  Next: multiprocessing — Process-based parallelism,  Up: Concurrent Execution

5.17.1 ‘threading’ — Thread-based parallelism
---------------------------------------------

`Source code:' Lib/threading.py(1)

__________________________________________________________________

This module constructs higher-level threading interfaces on top of the
lower level *note _thread: 3. module.  See also the *note queue: da.
module.

Changed in version 3.7: This module used to be optional, it is now
always available.

     Note: While they are not listed below, the ‘camelCase’ names used
     for some methods and functions in this module in the Python 2.x
     series are still supported by this module.

This module defines the following functions:

 -- Function: threading.active_count ()

     Return the number of *note Thread: 233. objects currently alive.
     The returned count is equal to the length of the list returned by
     *note enumerate(): 2293.

 -- Function: threading.current_thread ()

     Return the current *note Thread: 233. object, corresponding to the
     caller’s thread of control.  If the caller’s thread of control was
     not created through the *note threading: 109. module, a dummy
     thread object with limited functionality is returned.

 -- Function: threading.excepthook (args, /)

     Handle uncaught exception raised by *note Thread.run(): 230.

     The `args' argument has the following attributes:

        * `exc_type': Exception type.

        * `exc_value': Exception value, can be ‘None’.

        * `exc_traceback': Exception traceback, can be ‘None’.

        * `thread': Thread which raised the exception, can be ‘None’.

     If `exc_type' is *note SystemExit: 5f1, the exception is silently
     ignored.  Otherwise, the exception is printed out on *note
     sys.stderr: 304.

     If this function raises an exception, *note sys.excepthook(): e57.
     is called to handle it.

     *note threading.excepthook(): 22f. can be overridden to control how
     uncaught exceptions raised by *note Thread.run(): 230. are handled.

     Storing `exc_value' using a custom hook can create a reference
     cycle.  It should be cleared explicitly to break the reference
     cycle when the exception is no longer needed.

     Storing `thread' using a custom hook can resurrect it if it is set
     to an object which is being finalized.  Avoid storing `thread'
     after the custom hook completes to avoid resurrecting objects.

     See also
     ........

     *note sys.excepthook(): e57. handles uncaught exceptions.

     New in version 3.8.

 -- Function: threading.get_ident ()

     Return the ‘thread identifier’ of the current thread.  This is a
     nonzero integer.  Its value has no direct meaning; it is intended
     as a magic cookie to be used e.g.  to index a dictionary of
     thread-specific data.  Thread identifiers may be recycled when a
     thread exits and another thread is created.

     New in version 3.3.

 -- Function: threading.get_native_id ()

     Return the native integral Thread ID of the current thread assigned
     by the kernel.  This is a non-negative integer.  Its value may be
     used to uniquely identify this particular thread system-wide (until
     the thread terminates, after which the value may be recycled by the
     OS).

     *note Availability: 129a.: Windows, FreeBSD, Linux, macOS, OpenBSD,
     NetBSD, AIX.

     New in version 3.8.

 -- Function: threading.enumerate ()

     Return a list of all *note Thread: 233. objects currently alive.
     The list includes daemonic threads, dummy thread objects created by
     *note current_thread(): 2294, and the main thread.  It excludes
     terminated threads and threads that have not yet been started.

 -- Function: threading.main_thread ()

     Return the main *note Thread: 233. object.  In normal conditions,
     the main thread is the thread from which the Python interpreter was
     started.

     New in version 3.4.

 -- Function: threading.settrace (func)

     Set a trace function for all threads started from the *note
     threading: 109. module.  The `func' will be passed to *note
     sys.settrace(): e31. for each thread, before its *note run(): 230.
     method is called.

 -- Function: threading.setprofile (func)

     Set a profile function for all threads started from the *note
     threading: 109. module.  The `func' will be passed to *note
     sys.setprofile(): e30. for each thread, before its *note run():
     230. method is called.

 -- Function: threading.stack_size ([size])

     Return the thread stack size used when creating new threads.  The
     optional `size' argument specifies the stack size to be used for
     subsequently created threads, and must be 0 (use platform or
     configured default) or a positive integer value of at least 32,768
     (32 KiB). If `size' is not specified, 0 is used.  If changing the
     thread stack size is unsupported, a *note RuntimeError: 2b8. is
     raised.  If the specified stack size is invalid, a *note
     ValueError: 1f9. is raised and the stack size is unmodified.  32
     KiB is currently the minimum supported stack size value to
     guarantee sufficient stack space for the interpreter itself.  Note
     that some platforms may have particular restrictions on values for
     the stack size, such as requiring a minimum stack size > 32 KiB or
     requiring allocation in multiples of the system memory page size -
     platform documentation should be referred to for more information
     (4 KiB pages are common; using multiples of 4096 for the stack size
     is the suggested approach in the absence of more specific
     information).

     *note Availability: 129a.: Windows, systems with POSIX threads.

This module also defines the following constant:

 -- Data: threading.TIMEOUT_MAX

     The maximum value allowed for the `timeout' parameter of blocking
     functions (*note Lock.acquire(): 760, *note RLock.acquire(): 761,
     *note Condition.wait(): 2299, etc.).  Specifying a timeout greater
     than this value will raise an *note OverflowError: 954.

     New in version 3.2.

This module defines a number of classes, which are detailed in the
sections below.

The design of this module is loosely based on Java’s threading model.
However, where Java makes locks and condition variables basic behavior
of every object, they are separate objects in Python.  Python’s *note
Thread: 233. class supports a subset of the behavior of Java’s Thread
class; currently, there are no priorities, no thread groups, and threads
cannot be destroyed, stopped, suspended, resumed, or interrupted.  The
static methods of Java’s Thread class, when implemented, are mapped to
module-level functions.

All of the methods described below are executed atomically.

* Menu:

* Thread-Local Data::
* Thread Objects::
* Lock Objects::
* RLock Objects::
* Condition Objects::
* Semaphore Objects::
* Event Objects::
* Timer Objects::
* Barrier Objects::
* Using locks, conditions, and semaphores in the with statement: Using locks conditions and semaphores in the with statement.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/threading.py


File: python.info,  Node: Thread-Local Data,  Next: Thread Objects,  Up: threading — Thread-based parallelism

5.17.1.1 Thread-Local Data
..........................

Thread-local data is data whose values are thread specific.  To manage
thread-local data, just create an instance of *note local: 2236. (or a
subclass) and store attributes on it:

     mydata = threading.local() mydata.x = 1

The instance’s values will be different for separate threads.

 -- Class: threading.local

     A class that represents thread-local data.

     For more details and extensive examples, see the documentation
     string of the ‘_threading_local’ module.


File: python.info,  Node: Thread Objects,  Next: Lock Objects,  Prev: Thread-Local Data,  Up: threading — Thread-based parallelism

5.17.1.2 Thread Objects
.......................

The *note Thread: 233. class represents an activity that is run in a
separate thread of control.  There are two ways to specify the activity:
by passing a callable object to the constructor, or by overriding the
*note run(): 230. method in a subclass.  No other methods (except for
the constructor) should be overridden in a subclass.  In other words,
`only' override the ‘__init__()’ and *note run(): 230. methods of this
class.

Once a thread object is created, its activity must be started by calling
the thread’s *note start(): 2015. method.  This invokes the *note run():
230. method in a separate thread of control.

Once the thread’s activity is started, the thread is considered ‘alive’.
It stops being alive when its *note run(): 230. method terminates –
either normally, or by raising an unhandled exception.  The *note
is_alive(): 229d. method tests whether the thread is alive.

Other threads can call a thread’s *note join(): b53. method.  This
blocks the calling thread until the thread whose *note join(): b53.
method is called is terminated.

A thread has a name.  The name can be passed to the constructor, and
read or changed through the *note name: 229e. attribute.

If the *note run(): 230. method raises an exception, *note
threading.excepthook(): 22f. is called to handle it.  By default, *note
threading.excepthook(): 22f. ignores silently *note SystemExit: 5f1.

A thread can be flagged as a “daemon thread”.  The significance of this
flag is that the entire Python program exits when only daemon threads
are left.  The initial value is inherited from the creating thread.  The
flag can be set through the *note daemon: 229f. property or the `daemon'
constructor argument.

     Note: Daemon threads are abruptly stopped at shutdown.  Their
     resources (such as open files, database transactions, etc.)  may
     not be released properly.  If you want your threads to stop
     gracefully, make them non-daemonic and use a suitable signalling
     mechanism such as an *note Event: aa2.

There is a “main thread” object; this corresponds to the initial thread
of control in the Python program.  It is not a daemon thread.

There is the possibility that “dummy thread objects” are created.  These
are thread objects corresponding to “alien threads”, which are threads
of control started outside the threading module, such as directly from C
code.  Dummy thread objects have limited functionality; they are always
considered alive and daemonic, and cannot be *note join(): b53.ed.  They
are never deleted, since it is impossible to detect the termination of
alien threads.

 -- Class: threading.Thread (group=None, target=None, name=None,
          args=(), kwargs={}, *, daemon=None)

     This constructor should always be called with keyword arguments.
     Arguments are:

     `group' should be ‘None’; reserved for future extension when a
     ‘ThreadGroup’ class is implemented.

     `target' is the callable object to be invoked by the *note run():
     230. method.  Defaults to ‘None’, meaning nothing is called.

     `name' is the thread name.  By default, a unique name is
     constructed of the form “Thread-`N'” where `N' is a small decimal
     number.

     `args' is the argument tuple for the target invocation.  Defaults
     to ‘()’.

     `kwargs' is a dictionary of keyword arguments for the target
     invocation.  Defaults to ‘{}’.

     If not ‘None’, `daemon' explicitly sets whether the thread is
     daemonic.  If ‘None’ (the default), the daemonic property is
     inherited from the current thread.

     If the subclass overrides the constructor, it must make sure to
     invoke the base class constructor (‘Thread.__init__()’) before
     doing anything else to the thread.

     Changed in version 3.3: Added the `daemon' argument.

      -- Method: start ()

          Start the thread’s activity.

          It must be called at most once per thread object.  It arranges
          for the object’s *note run(): 230. method to be invoked in a
          separate thread of control.

          This method will raise a *note RuntimeError: 2b8. if called
          more than once on the same thread object.

      -- Method: run ()

          Method representing the thread’s activity.

          You may override this method in a subclass.  The standard
          *note run(): 230. method invokes the callable object passed to
          the object’s constructor as the `target' argument, if any,
          with positional and keyword arguments taken from the `args'
          and `kwargs' arguments, respectively.

      -- Method: join (timeout=None)

          Wait until the thread terminates.  This blocks the calling
          thread until the thread whose *note join(): b53. method is
          called terminates – either normally or through an unhandled
          exception – or until the optional timeout occurs.

          When the `timeout' argument is present and not ‘None’, it
          should be a floating point number specifying a timeout for the
          operation in seconds (or fractions thereof).  As *note join():
          b53. always returns ‘None’, you must call *note is_alive():
          229d. after *note join(): b53. to decide whether a timeout
          happened – if the thread is still alive, the *note join():
          b53. call timed out.

          When the `timeout' argument is not present or ‘None’, the
          operation will block until the thread terminates.

          A thread can be *note join(): b53.ed many times.

          *note join(): b53. raises a *note RuntimeError: 2b8. if an
          attempt is made to join the current thread as that would cause
          a deadlock.  It is also an error to *note join(): b53. a
          thread before it has been started and attempts to do so raise
          the same exception.

      -- Attribute: name

          A string used for identification purposes only.  It has no
          semantics.  Multiple threads may be given the same name.  The
          initial name is set by the constructor.

      -- Method: getName ()
      -- Method: setName ()

          Old getter/setter API for *note name: 229e.; use it directly
          as a property instead.

      -- Attribute: ident

          The ‘thread identifier’ of this thread or ‘None’ if the thread
          has not been started.  This is a nonzero integer.  See the
          *note get_ident(): aa4. function.  Thread identifiers may be
          recycled when a thread exits and another thread is created.
          The identifier is available even after the thread has exited.

      -- Attribute: native_id

          The native integral thread ID of this thread.  This is a
          non-negative integer, or ‘None’ if the thread has not been
          started.  See the *note get_native_id(): 231. function.  This
          represents the Thread ID (‘TID’) as assigned to the thread by
          the OS (kernel).  Its value may be used to uniquely identify
          this particular thread system-wide (until the thread
          terminates, after which the value may be recycled by the OS).

               Note: Similar to Process IDs, Thread IDs are only valid
               (guaranteed unique system-wide) from the time the thread
               is created until the thread has been terminated.

          *note Availability: 129a.: Requires *note get_native_id():
          231. function.

          New in version 3.8.

      -- Method: is_alive ()

          Return whether the thread is alive.

          This method returns ‘True’ just before the *note run(): 230.
          method starts until just after the *note run(): 230. method
          terminates.  The module function *note enumerate(): 2293.
          returns a list of all alive threads.

      -- Attribute: daemon

          A boolean value indicating whether this thread is a daemon
          thread (True) or not (False).  This must be set before *note
          start(): 2015. is called, otherwise *note RuntimeError: 2b8.
          is raised.  Its initial value is inherited from the creating
          thread; the main thread is not a daemon thread and therefore
          all threads created in the main thread default to *note
          daemon: 229f. = ‘False’.

          The entire Python program exits when no alive non-daemon
          threads are left.

      -- Method: isDaemon ()
      -- Method: setDaemon ()

          Old getter/setter API for *note daemon: 229f.; use it directly
          as a property instead.

`CPython implementation detail:' In CPython, due to the *note Global
Interpreter Lock: 4fb, only one thread can execute Python code at once
(even though certain performance-oriented libraries might overcome this
limitation).  If you want your application to make better use of the
computational resources of multi-core machines, you are advised to use
*note multiprocessing: b7. or *note
concurrent.futures.ProcessPoolExecutor: 2a2.  However, threading is
still an appropriate model if you want to run multiple I/O-bound tasks
simultaneously.


File: python.info,  Node: Lock Objects,  Next: RLock Objects,  Prev: Thread Objects,  Up: threading — Thread-based parallelism

5.17.1.3 Lock Objects
.....................

A primitive lock is a synchronization primitive that is not owned by a
particular thread when locked.  In Python, it is currently the lowest
level synchronization primitive available, implemented directly by the
*note _thread: 3. extension module.

A primitive lock is in one of two states, “locked” or “unlocked”.  It is
created in the unlocked state.  It has two basic methods, *note
acquire(): 760. and *note release(): 22a6.  When the state is unlocked,
*note acquire(): 760. changes the state to locked and returns
immediately.  When the state is locked, *note acquire(): 760. blocks
until a call to *note release(): 22a6. in another thread changes it to
unlocked, then the *note acquire(): 760. call resets it to locked and
returns.  The *note release(): 22a6. method should only be called in the
locked state; it changes the state to unlocked and returns immediately.
If an attempt is made to release an unlocked lock, a *note RuntimeError:
2b8. will be raised.

Locks also support the *note context management protocol: 22a7.

When more than one thread is blocked in *note acquire(): 760. waiting
for the state to turn to unlocked, only one thread proceeds when a *note
release(): 22a6. call resets the state to unlocked; which one of the
waiting threads proceeds is not defined, and may vary across
implementations.

All methods are executed atomically.

 -- Class: threading.Lock

     The class implementing primitive lock objects.  Once a thread has
     acquired a lock, subsequent attempts to acquire it block, until it
     is released; any thread may release it.

     Note that ‘Lock’ is actually a factory function which returns an
     instance of the most efficient version of the concrete Lock class
     that is supported by the platform.

      -- Method: acquire (blocking=True, timeout=-1)

          Acquire a lock, blocking or non-blocking.

          When invoked with the `blocking' argument set to ‘True’ (the
          default), block until the lock is unlocked, then set it to
          locked and return ‘True’.

          When invoked with the `blocking' argument set to ‘False’, do
          not block.  If a call with `blocking' set to ‘True’ would
          block, return ‘False’ immediately; otherwise, set the lock to
          locked and return ‘True’.

          When invoked with the floating-point `timeout' argument set to
          a positive value, block for at most the number of seconds
          specified by `timeout' and as long as the lock cannot be
          acquired.  A `timeout' argument of ‘-1’ specifies an unbounded
          wait.  It is forbidden to specify a `timeout' when `blocking'
          is false.

          The return value is ‘True’ if the lock is acquired
          successfully, ‘False’ if not (for example if the `timeout'
          expired).

          Changed in version 3.2: The `timeout' parameter is new.

          Changed in version 3.2: Lock acquisition can now be
          interrupted by signals on POSIX if the underlying threading
          implementation supports it.

      -- Method: release ()

          Release a lock.  This can be called from any thread, not only
          the thread which has acquired the lock.

          When the lock is locked, reset it to unlocked, and return.  If
          any other threads are blocked waiting for the lock to become
          unlocked, allow exactly one of them to proceed.

          When invoked on an unlocked lock, a *note RuntimeError: 2b8.
          is raised.

          There is no return value.

      -- Method: locked ()

      -- Method: Return true if the lock is acquired.


File: python.info,  Node: RLock Objects,  Next: Condition Objects,  Prev: Lock Objects,  Up: threading — Thread-based parallelism

5.17.1.4 RLock Objects
......................

A reentrant lock is a synchronization primitive that may be acquired
multiple times by the same thread.  Internally, it uses the concepts of
“owning thread” and “recursion level” in addition to the locked/unlocked
state used by primitive locks.  In the locked state, some thread owns
the lock; in the unlocked state, no thread owns it.

To lock the lock, a thread calls its *note acquire(): 761. method; this
returns once the thread owns the lock.  To unlock the lock, a thread
calls its *note release(): 22a6. method.  *note acquire(): 760./*note
release(): 22a6. call pairs may be nested; only the final *note
release(): 22a6. (the *note release(): 22a6. of the outermost pair)
resets the lock to unlocked and allows another thread blocked in *note
acquire(): 760. to proceed.

Reentrant locks also support the *note context management protocol:
22a7.

 -- Class: threading.RLock

     This class implements reentrant lock objects.  A reentrant lock
     must be released by the thread that acquired it.  Once a thread has
     acquired a reentrant lock, the same thread may acquire it again
     without blocking; the thread must release it once for each time it
     has acquired it.

     Note that ‘RLock’ is actually a factory function which returns an
     instance of the most efficient version of the concrete RLock class
     that is supported by the platform.

      -- Method: acquire (blocking=True, timeout=-1)

          Acquire a lock, blocking or non-blocking.

          When invoked without arguments: if this thread already owns
          the lock, increment the recursion level by one, and return
          immediately.  Otherwise, if another thread owns the lock,
          block until the lock is unlocked.  Once the lock is unlocked
          (not owned by any thread), then grab ownership, set the
          recursion level to one, and return.  If more than one thread
          is blocked waiting until the lock is unlocked, only one at a
          time will be able to grab ownership of the lock.  There is no
          return value in this case.

          When invoked with the `blocking' argument set to true, do the
          same thing as when called without arguments, and return
          ‘True’.

          When invoked with the `blocking' argument set to false, do not
          block.  If a call without an argument would block, return
          ‘False’ immediately; otherwise, do the same thing as when
          called without arguments, and return ‘True’.

          When invoked with the floating-point `timeout' argument set to
          a positive value, block for at most the number of seconds
          specified by `timeout' and as long as the lock cannot be
          acquired.  Return ‘True’ if the lock has been acquired, false
          if the timeout has elapsed.

          Changed in version 3.2: The `timeout' parameter is new.

      -- Method: release ()

          Release a lock, decrementing the recursion level.  If after
          the decrement it is zero, reset the lock to unlocked (not
          owned by any thread), and if any other threads are blocked
          waiting for the lock to become unlocked, allow exactly one of
          them to proceed.  If after the decrement the recursion level
          is still nonzero, the lock remains locked and owned by the
          calling thread.

          Only call this method when the calling thread owns the lock.
          A *note RuntimeError: 2b8. is raised if this method is called
          when the lock is unlocked.

          There is no return value.


File: python.info,  Node: Condition Objects,  Next: Semaphore Objects,  Prev: RLock Objects,  Up: threading — Thread-based parallelism

5.17.1.5 Condition Objects
..........................

A condition variable is always associated with some kind of lock; this
can be passed in or one will be created by default.  Passing one in is
useful when several condition variables must share the same lock.  The
lock is part of the condition object: you don’t have to track it
separately.

A condition variable obeys the *note context management protocol: 22a7.:
using the ‘with’ statement acquires the associated lock for the duration
of the enclosed block.  The *note acquire(): 22af. and *note release():
22b0. methods also call the corresponding methods of the associated
lock.

Other methods must be called with the associated lock held.  The *note
wait(): 2299. method releases the lock, and then blocks until another
thread awakens it by calling *note notify(): 22b1. or *note
notify_all(): 22b2.  Once awakened, *note wait(): 2299. re-acquires the
lock and returns.  It is also possible to specify a timeout.

The *note notify(): 22b1. method wakes up one of the threads waiting for
the condition variable, if any are waiting.  The *note notify_all():
22b2. method wakes up all threads waiting for the condition variable.

Note: the *note notify(): 22b1. and *note notify_all(): 22b2. methods
don’t release the lock; this means that the thread or threads awakened
will not return from their *note wait(): 2299. call immediately, but
only when the thread that called *note notify(): 22b1. or *note
notify_all(): 22b2. finally relinquishes ownership of the lock.

The typical programming style using condition variables uses the lock to
synchronize access to some shared state; threads that are interested in
a particular change of state call *note wait(): 2299. repeatedly until
they see the desired state, while threads that modify the state call
*note notify(): 22b1. or *note notify_all(): 22b2. when they change the
state in such a way that it could possibly be a desired state for one of
the waiters.  For example, the following code is a generic
producer-consumer situation with unlimited buffer capacity:

     # Consume one item with cv:     while not an_item_is_available():         cv.wait()     get_an_available_item()  # Produce one item with cv:     make_an_item_available()     cv.notify()

The ‘while’ loop checking for the application’s condition is necessary
because *note wait(): 2299. can return after an arbitrary long time, and
the condition which prompted the *note notify(): 22b1. call may no
longer hold true.  This is inherent to multi-threaded programming.  The
*note wait_for(): 22b3. method can be used to automate the condition
checking, and eases the computation of timeouts:

     # Consume an item with cv:     cv.wait_for(an_item_is_available)     get_an_available_item()

To choose between *note notify(): 22b1. and *note notify_all(): 22b2,
consider whether one state change can be interesting for only one or
several waiting threads.  E.g.  in a typical producer-consumer
situation, adding one item to the buffer only needs to wake up one
consumer thread.

 -- Class: threading.Condition (lock=None)

     This class implements condition variable objects.  A condition
     variable allows one or more threads to wait until they are notified
     by another thread.

     If the `lock' argument is given and not ‘None’, it must be a *note
     Lock: 22a8. or *note RLock: be2. object, and it is used as the
     underlying lock.  Otherwise, a new *note RLock: be2. object is
     created and used as the underlying lock.

     Changed in version 3.3: changed from a factory function to a class.

      -- Method: acquire (*args)

          Acquire the underlying lock.  This method calls the
          corresponding method on the underlying lock; the return value
          is whatever that method returns.

      -- Method: release ()

          Release the underlying lock.  This method calls the
          corresponding method on the underlying lock; there is no
          return value.

      -- Method: wait (timeout=None)

          Wait until notified or until a timeout occurs.  If the calling
          thread has not acquired the lock when this method is called, a
          *note RuntimeError: 2b8. is raised.

          This method releases the underlying lock, and then blocks
          until it is awakened by a *note notify(): 22b1. or *note
          notify_all(): 22b2. call for the same condition variable in
          another thread, or until the optional timeout occurs.  Once
          awakened or timed out, it re-acquires the lock and returns.

          When the `timeout' argument is present and not ‘None’, it
          should be a floating point number specifying a timeout for the
          operation in seconds (or fractions thereof).

          When the underlying lock is an *note RLock: be2, it is not
          released using its *note release(): 22b0. method, since this
          may not actually unlock the lock when it was acquired multiple
          times recursively.  Instead, an internal interface of the
          *note RLock: be2. class is used, which really unlocks it even
          when it has been recursively acquired several times.  Another
          internal interface is then used to restore the recursion level
          when the lock is reacquired.

          The return value is ‘True’ unless a given `timeout' expired,
          in which case it is ‘False’.

          Changed in version 3.2: Previously, the method always returned
          ‘None’.

      -- Method: wait_for (predicate, timeout=None)

          Wait until a condition evaluates to true.  `predicate' should
          be a callable which result will be interpreted as a boolean
          value.  A `timeout' may be provided giving the maximum time to
          wait.

          This utility method may call *note wait(): 2299. repeatedly
          until the predicate is satisfied, or until a timeout occurs.
          The return value is the last return value of the predicate and
          will evaluate to ‘False’ if the method timed out.

          Ignoring the timeout feature, calling this method is roughly
          equivalent to writing:

               while not predicate():     cv.wait()

          Therefore, the same rules apply as with *note wait(): 2299.:
          The lock must be held when called and is re-acquired on
          return.  The predicate is evaluated with the lock held.

          New in version 3.2.

      -- Method: notify (n=1)

          By default, wake up one thread waiting on this condition, if
          any.  If the calling thread has not acquired the lock when
          this method is called, a *note RuntimeError: 2b8. is raised.

          This method wakes up at most `n' of the threads waiting for
          the condition variable; it is a no-op if no threads are
          waiting.

          The current implementation wakes up exactly `n' threads, if at
          least `n' threads are waiting.  However, it’s not safe to rely
          on this behavior.  A future, optimized implementation may
          occasionally wake up more than `n' threads.

          Note: an awakened thread does not actually return from its
          *note wait(): 2299. call until it can reacquire the lock.
          Since *note notify(): 22b1. does not release the lock, its
          caller should.

      -- Method: notify_all ()

          Wake up all threads waiting on this condition.  This method
          acts like *note notify(): 22b1, but wakes up all waiting
          threads instead of one.  If the calling thread has not
          acquired the lock when this method is called, a *note
          RuntimeError: 2b8. is raised.


File: python.info,  Node: Semaphore Objects,  Next: Event Objects,  Prev: Condition Objects,  Up: threading — Thread-based parallelism

5.17.1.6 Semaphore Objects
..........................

This is one of the oldest synchronization primitives in the history of
computer science, invented by the early Dutch computer scientist Edsger
W. Dijkstra (he used the names ‘P()’ and ‘V()’ instead of *note
acquire(): bdf. and *note release(): 22b6.).

A semaphore manages an internal counter which is decremented by each
*note acquire(): bdf. call and incremented by each *note release():
22b6. call.  The counter can never go below zero; when *note acquire():
bdf. finds that it is zero, it blocks, waiting until some other thread
calls *note release(): 22b6.

Semaphores also support the *note context management protocol: 22a7.

 -- Class: threading.Semaphore (value=1)

     This class implements semaphore objects.  A semaphore manages an
     atomic counter representing the number of *note release(): 22b6.
     calls minus the number of *note acquire(): bdf. calls, plus an
     initial value.  The *note acquire(): bdf. method blocks if
     necessary until it can return without making the counter negative.
     If not given, `value' defaults to 1.

     The optional argument gives the initial `value' for the internal
     counter; it defaults to ‘1’.  If the `value' given is less than 0,
     *note ValueError: 1f9. is raised.

     Changed in version 3.3: changed from a factory function to a class.

      -- Method: acquire (blocking=True, timeout=None)

          Acquire a semaphore.

          When invoked without arguments:

             * If the internal counter is larger than zero on entry,
               decrement it by one and return ‘True’ immediately.

             * If the internal counter is zero on entry, block until
               awoken by a call to *note release(): 22b6.  Once awoken
               (and the counter is greater than 0), decrement the
               counter by 1 and return ‘True’.  Exactly one thread will
               be awoken by each call to *note release(): 22b6.  The
               order in which threads are awoken should not be relied
               on.

          When invoked with `blocking' set to false, do not block.  If a
          call without an argument would block, return ‘False’
          immediately; otherwise, do the same thing as when called
          without arguments, and return ‘True’.

          When invoked with a `timeout' other than ‘None’, it will block
          for at most `timeout' seconds.  If acquire does not complete
          successfully in that interval, return ‘False’.  Return ‘True’
          otherwise.

          Changed in version 3.2: The `timeout' parameter is new.

      -- Method: release ()

          Release a semaphore, incrementing the internal counter by one.
          When it was zero on entry and another thread is waiting for it
          to become larger than zero again, wake up that thread.

 -- Class: threading.BoundedSemaphore (value=1)

     Class implementing bounded semaphore objects.  A bounded semaphore
     checks to make sure its current value doesn’t exceed its initial
     value.  If it does, *note ValueError: 1f9. is raised.  In most
     situations semaphores are used to guard resources with limited
     capacity.  If the semaphore is released too many times it’s a sign
     of a bug.  If not given, `value' defaults to 1.

     Changed in version 3.3: changed from a factory function to a class.

* Menu:

* Semaphore Example::


File: python.info,  Node: Semaphore Example,  Up: Semaphore Objects

5.17.1.7 ‘Semaphore’ Example
............................

Semaphores are often used to guard resources with limited capacity, for
example, a database server.  In any situation where the size of the
resource is fixed, you should use a bounded semaphore.  Before spawning
any worker threads, your main thread would initialize the semaphore:

     maxconnections = 5 # ... pool_sema = BoundedSemaphore(value=maxconnections)

Once spawned, worker threads call the semaphore’s acquire and release
methods when they need to connect to the server:

     with pool_sema:     conn = connectdb()     try:         # ... use connection ...     finally:         conn.close()

The use of a bounded semaphore reduces the chance that a programming
error which causes the semaphore to be released more than it’s acquired
will go undetected.


File: python.info,  Node: Event Objects,  Next: Timer Objects,  Prev: Semaphore Objects,  Up: threading — Thread-based parallelism

5.17.1.8 Event Objects
......................

This is one of the simplest mechanisms for communication between
threads: one thread signals an event and other threads wait for it.

An event object manages an internal flag that can be set to true with
the *note set(): 22bb. method and reset to false with the *note clear():
22bc. method.  The *note wait(): caa. method blocks until the flag is
true.

 -- Class: threading.Event

     Class implementing event objects.  An event manages a flag that can
     be set to true with the *note set(): 22bb. method and reset to
     false with the *note clear(): 22bc. method.  The *note wait(): caa.
     method blocks until the flag is true.  The flag is initially false.

     Changed in version 3.3: changed from a factory function to a class.

      -- Method: is_set ()

          Return ‘True’ if and only if the internal flag is true.

      -- Method: set ()

          Set the internal flag to true.  All threads waiting for it to
          become true are awakened.  Threads that call *note wait():
          caa. once the flag is true will not block at all.

      -- Method: clear ()

          Reset the internal flag to false.  Subsequently, threads
          calling *note wait(): caa. will block until *note set(): 22bb.
          is called to set the internal flag to true again.

      -- Method: wait (timeout=None)

          Block until the internal flag is true.  If the internal flag
          is true on entry, return immediately.  Otherwise, block until
          another thread calls *note set(): 22bb. to set the flag to
          true, or until the optional timeout occurs.

          When the timeout argument is present and not ‘None’, it should
          be a floating point number specifying a timeout for the
          operation in seconds (or fractions thereof).

          This method returns ‘True’ if and only if the internal flag
          has been set to true, either before the wait call or after the
          wait starts, so it will always return ‘True’ except if a
          timeout is given and the operation times out.

          Changed in version 3.1: Previously, the method always returned
          ‘None’.


File: python.info,  Node: Timer Objects,  Next: Barrier Objects,  Prev: Event Objects,  Up: threading — Thread-based parallelism

5.17.1.9 Timer Objects
......................

This class represents an action that should be run only after a certain
amount of time has passed — a timer.  *note Timer: aa3. is a subclass of
*note Thread: 233. and as such also functions as an example of creating
custom threads.

Timers are started, as with threads, by calling their ‘start()’ method.
The timer can be stopped (before its action has begun) by calling the
*note cancel(): 22c0. method.  The interval the timer will wait before
executing its action may not be exactly the same as the interval
specified by the user.

For example:

     def hello():     print("hello, world")  t = Timer(30.0, hello) t.start()  # after 30 seconds, "hello, world" will be printed

 -- Class: threading.Timer (interval, function, args=None, kwargs=None)

     Create a timer that will run `function' with arguments `args' and
     keyword arguments `kwargs', after `interval' seconds have passed.
     If `args' is ‘None’ (the default) then an empty list will be used.
     If `kwargs' is ‘None’ (the default) then an empty dict will be
     used.

     Changed in version 3.3: changed from a factory function to a class.

      -- Method: cancel ()

          Stop the timer, and cancel the execution of the timer’s
          action.  This will only work if the timer is still in its
          waiting stage.


File: python.info,  Node: Barrier Objects,  Next: Using locks conditions and semaphores in the with statement,  Prev: Timer Objects,  Up: threading — Thread-based parallelism

5.17.1.10 Barrier Objects
.........................

New in version 3.2.

This class provides a simple synchronization primitive for use by a
fixed number of threads that need to wait for each other.  Each of the
threads tries to pass the barrier by calling the *note wait(): 22c2.
method and will block until all of the threads have made their *note
wait(): 22c2. calls.  At this point, the threads are released
simultaneously.

The barrier can be reused any number of times for the same number of
threads.

As an example, here is a simple way to synchronize a client and server
thread:

     b = Barrier(2, timeout=5)  def server():     start_server()     b.wait()     while True:         connection = accept_connection()         process_server_connection(connection)  def client():     b.wait()     while True:         connection = make_connection()         process_client_connection(connection)

 -- Class: threading.Barrier (parties, action=None, timeout=None)

     Create a barrier object for `parties' number of threads.  An
     `action', when provided, is a callable to be called by one of the
     threads when they are released.  `timeout' is the default timeout
     value if none is specified for the *note wait(): 22c2. method.

      -- Method: wait (timeout=None)

          Pass the barrier.  When all the threads party to the barrier
          have called this function, they are all released
          simultaneously.  If a `timeout' is provided, it is used in
          preference to any that was supplied to the class constructor.

          The return value is an integer in the range 0 to `parties' –
          1, different for each thread.  This can be used to select a
          thread to do some special housekeeping, e.g.:

               i = barrier.wait() if i == 0:     # Only one thread needs to print this     print("passed the barrier")

          If an `action' was provided to the constructor, one of the
          threads will have called it prior to being released.  Should
          this call raise an error, the barrier is put into the broken
          state.

          If the call times out, the barrier is put into the broken
          state.

          This method may raise a *note BrokenBarrierError: b54.
          exception if the barrier is broken or reset while a thread is
          waiting.

      -- Method: reset ()

          Return the barrier to the default, empty state.  Any threads
          waiting on it will receive the *note BrokenBarrierError: b54.
          exception.

          Note that using this function may require some external
          synchronization if there are other threads whose state is
          unknown.  If a barrier is broken it may be better to just
          leave it and create a new one.

      -- Method: abort ()

          Put the barrier into a broken state.  This causes any active
          or future calls to *note wait(): 22c2. to fail with the *note
          BrokenBarrierError: b54.  Use this for example if one of the
          threads needs to abort, to avoid deadlocking the application.

          It may be preferable to simply create the barrier with a
          sensible `timeout' value to automatically guard against one of
          the threads going awry.

      -- Attribute: parties

          The number of threads required to pass the barrier.

      -- Attribute: n_waiting

          The number of threads currently waiting in the barrier.

      -- Attribute: broken

          A boolean that is ‘True’ if the barrier is in the broken
          state.

 -- Exception: threading.BrokenBarrierError

     This exception, a subclass of *note RuntimeError: 2b8, is raised
     when the *note Barrier: b52. object is reset or broken.


File: python.info,  Node: Using locks conditions and semaphores in the with statement,  Prev: Barrier Objects,  Up: threading — Thread-based parallelism

5.17.1.11 Using locks, conditions, and semaphores in the ‘with’ statement
.........................................................................

All of the objects provided by this module that have ‘acquire()’ and
‘release()’ methods can be used as context managers for a *note with:
6dd. statement.  The ‘acquire()’ method will be called when the block is
entered, and ‘release()’ will be called when the block is exited.
Hence, the following snippet:

     with some_lock:     # do something...

is equivalent to:

     some_lock.acquire() try:     # do something... finally:     some_lock.release()

Currently, *note Lock: 22a8, *note RLock: be2, *note Condition: a9f,
*note Semaphore: aa0, and *note BoundedSemaphore: aa1. objects may be
used as *note with: 6dd. statement context managers.


File: python.info,  Node: multiprocessing — Process-based parallelism,  Next: multiprocessing shared_memory — Provides shared memory for direct access across processes,  Prev: threading — Thread-based parallelism,  Up: Concurrent Execution

5.17.2 ‘multiprocessing’ — Process-based parallelism
----------------------------------------------------

`Source code:' Lib/multiprocessing/(1)

__________________________________________________________________

* Menu:

* Introduction: Introduction<8>.
* Reference::
* Programming guidelines::
* Examples: Examples<10>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/multiprocessing/


File: python.info,  Node: Introduction<8>,  Next: Reference,  Up: multiprocessing — Process-based parallelism

5.17.2.1 Introduction
.....................

*note multiprocessing: b7. is a package that supports spawning processes
using an API similar to the *note threading: 109. module.  The *note
multiprocessing: b7. package offers both local and remote concurrency,
effectively side-stepping the *note Global Interpreter Lock: 4fb. by
using subprocesses instead of threads.  Due to this, the *note
multiprocessing: b7. module allows the programmer to fully leverage
multiple processors on a given machine.  It runs on both Unix and
Windows.

The *note multiprocessing: b7. module also introduces APIs which do not
have analogs in the *note threading: 109. module.  A prime example of
this is the *note Pool: 86f. object which offers a convenient means of
parallelizing the execution of a function across multiple input values,
distributing the input data across processes (data parallelism).  The
following example demonstrates the common practice of defining such
functions in a module so that child processes can successfully import
that module.  This basic example of data parallelism using *note Pool:
86f,

     from multiprocessing import Pool  def f(x):     return x*x  if __name__ == '__main__':     with Pool(5) as p:         print(p.map(f, [1, 2, 3]))

will print to standard output

     [1, 4, 9]

* Menu:

* The Process class::
* Contexts and start methods::
* Exchanging objects between processes::
* Synchronization between processes::
* Sharing state between processes::
* Using a pool of workers::


File: python.info,  Node: The Process class,  Next: Contexts and start methods,  Up: Introduction<8>

5.17.2.2 The ‘Process’ class
............................

In *note multiprocessing: b7, processes are spawned by creating a *note
Process: 3a7. object and then calling its *note start(): 22cd. method.
*note Process: 3a7. follows the API of *note threading.Thread: 233.  A
trivial example of a multiprocess program is

     from multiprocessing import Process  def f(name):     print('hello', name)  if __name__ == '__main__':     p = Process(target=f, args=('bob',))     p.start()     p.join()

To show the individual process IDs involved, here is an expanded
example:

     from multiprocessing import Process import os  def info(title):     print(title)     print('module name:', __name__)     print('parent process:', os.getppid())     print('process id:', os.getpid())  def f(name):     info('function f')     print('hello', name)  if __name__ == '__main__':     info('main line')     p = Process(target=f, args=('bob',))     p.start()     p.join()

For an explanation of why the ‘if __name__ == '__main__'’ part is
necessary, see *note Programming guidelines: 22ce.


File: python.info,  Node: Contexts and start methods,  Next: Exchanging objects between processes,  Prev: The Process class,  Up: Introduction<8>

5.17.2.3 Contexts and start methods
...................................

Depending on the platform, *note multiprocessing: b7. supports three
ways to start a process.  These `start methods' are

     `spawn'

          The parent process starts a fresh python interpreter process.
          The child process will only inherit those resources necessary
          to run the process objects *note run(): 22d0. method.  In
          particular, unnecessary file descriptors and handles from the
          parent process will not be inherited.  Starting a process
          using this method is rather slow compared to using `fork' or
          `forkserver'.

          Available on Unix and Windows.  The default on Windows and
          macOS.

     `fork'

          The parent process uses *note os.fork(): 955. to fork the
          Python interpreter.  The child process, when it begins, is
          effectively identical to the parent process.  All resources of
          the parent are inherited by the child process.  Note that
          safely forking a multithreaded process is problematic.

          Available on Unix only.  The default on Unix.

     `forkserver'

          When the program starts and selects the `forkserver' start
          method, a server process is started.  From then on, whenever a
          new process is needed, the parent process connects to the
          server and requests that it fork a new process.  The fork
          server process is single threaded so it is safe for it to use
          *note os.fork(): 955.  No unnecessary resources are inherited.

          Available on Unix platforms which support passing file
          descriptors over Unix pipes.

Changed in version 3.8: On macOS, the `spawn' start method is now the
default.  The `fork' start method should be considered unsafe as it can
lead to crashes of the subprocess.  See bpo-33725(1).

Changed in version 3.4: `spawn' added on all unix platforms, and
`forkserver' added for some unix platforms.  Child processes no longer
inherit all of the parents inheritable handles on Windows.

On Unix using the `spawn' or `forkserver' start methods will also start
a `resource tracker' process which tracks the unlinked named system
resources (such as named semaphores or *note SharedMemory: 22d1.
objects) created by processes of the program.  When all processes have
exited the resource tracker unlinks any remaining tracked object.
Usually there should be none, but if a process was killed by a signal
there may be some “leaked” resources.  (Neither leaked semaphores nor
shared memory segments will be automatically unlinked until the next
reboot.  This is problematic for both objects because the system allows
only a limited number of named semaphores, and shared memory segments
occupy some space in the main memory.)

To select a start method you use the *note set_start_method(): 86d. in
the ‘if __name__ == '__main__'’ clause of the main module.  For example:

     import multiprocessing as mp  def foo(q):     q.put('hello')  if __name__ == '__main__':     mp.set_start_method('spawn')     q = mp.Queue()     p = mp.Process(target=foo, args=(q,))     p.start()     print(q.get())     p.join()

*note set_start_method(): 86d. should not be used more than once in the
program.

Alternatively, you can use *note get_context(): 86e. to obtain a context
object.  Context objects have the same API as the multiprocessing
module, and allow one to use multiple start methods in the same program.

     import multiprocessing as mp  def foo(q):     q.put('hello')  if __name__ == '__main__':     ctx = mp.get_context('spawn')     q = ctx.Queue()     p = ctx.Process(target=foo, args=(q,))     p.start()     print(q.get())     p.join()

Note that objects related to one context may not be compatible with
processes for a different context.  In particular, locks created using
the `fork' context cannot be passed to processes started using the
`spawn' or `forkserver' start methods.

A library which wants to use a particular start method should probably
use *note get_context(): 86e. to avoid interfering with the choice of
the library user.

     Warning: The ‘'spawn'’ and ‘'forkserver'’ start methods cannot
     currently be used with “frozen” executables (i.e., binaries
     produced by packages like `PyInstaller' and `cx_Freeze') on Unix.
     The ‘'fork'’ start method does work.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue33725


File: python.info,  Node: Exchanging objects between processes,  Next: Synchronization between processes,  Prev: Contexts and start methods,  Up: Introduction<8>

5.17.2.4 Exchanging objects between processes
.............................................

*note multiprocessing: b7. supports two types of communication channel
between processes:

`Queues'

     The *note Queue: 22d3. class is a near clone of *note queue.Queue:
     d0b.  For example:

          from multiprocessing import Process, Queue  def f(q):     q.put([42, None, 'hello'])  if __name__ == '__main__':     q = Queue()     p = Process(target=f, args=(q,))     p.start()     print(q.get())    # prints "[42, None, 'hello']"     p.join()

     Queues are thread and process safe.

`Pipes'

     The *note Pipe(): 22d4. function returns a pair of connection
     objects connected by a pipe which by default is duplex (two-way).
     For example:

          from multiprocessing import Process, Pipe  def f(conn):     conn.send([42, None, 'hello'])     conn.close()  if __name__ == '__main__':     parent_conn, child_conn = Pipe()     p = Process(target=f, args=(child_conn,))     p.start()     print(parent_conn.recv())   # prints "[42, None, 'hello']"     p.join()

     The two connection objects returned by *note Pipe(): 22d4.
     represent the two ends of the pipe.  Each connection object has
     ‘send()’ and ‘recv()’ methods (among others).  Note that data in a
     pipe may become corrupted if two processes (or threads) try to read
     from or write to the `same' end of the pipe at the same time.  Of
     course there is no risk of corruption from processes using
     different ends of the pipe at the same time.


File: python.info,  Node: Synchronization between processes,  Next: Sharing state between processes,  Prev: Exchanging objects between processes,  Up: Introduction<8>

5.17.2.5 Synchronization between processes
..........................................

*note multiprocessing: b7. contains equivalents of all the
synchronization primitives from *note threading: 109.  For instance one
can use a lock to ensure that only one process prints to standard output
at a time:

     from multiprocessing import Process, Lock  def f(l, i):     l.acquire()     try:         print('hello world', i)     finally:         l.release()  if __name__ == '__main__':     lock = Lock()      for num in range(10):         Process(target=f, args=(lock, num)).start()

Without using the lock output from the different processes is liable to
get all mixed up.


File: python.info,  Node: Sharing state between processes,  Next: Using a pool of workers,  Prev: Synchronization between processes,  Up: Introduction<8>

5.17.2.6 Sharing state between processes
........................................

As mentioned above, when doing concurrent programming it is usually best
to avoid using shared state as far as possible.  This is particularly
true when using multiple processes.

However, if you really do need to use some shared data then *note
multiprocessing: b7. provides a couple of ways of doing so.

`Shared memory'

     Data can be stored in a shared memory map using *note Value: 22d7.
     or *note Array: 22d8.  For example, the following code

          from multiprocessing import Process, Value, Array  def f(n, a):     n.value = 3.1415927     for i in range(len(a)):         a[i] = -a[i]  if __name__ == '__main__':     num = Value('d', 0.0)     arr = Array('i', range(10))      p = Process(target=f, args=(num, arr))     p.start()     p.join()      print(num.value)     print(arr[:])

     will print

          3.1415927 [0, -1, -2, -3, -4, -5, -6, -7, -8, -9]

     The ‘'d'’ and ‘'i'’ arguments used when creating ‘num’ and ‘arr’
     are typecodes of the kind used by the *note array: 7. module: ‘'d'’
     indicates a double precision float and ‘'i'’ indicates a signed
     integer.  These shared objects will be process and thread-safe.

     For more flexibility in using shared memory one can use the *note
     multiprocessing.sharedctypes: bd. module which supports the
     creation of arbitrary ctypes objects allocated from shared memory.

`Server process'

     A manager object returned by ‘Manager()’ controls a server process
     which holds Python objects and allows other processes to manipulate
     them using proxies.

     A manager returned by ‘Manager()’ will support types *note list:
     260, *note dict: 1b6, *note Namespace: 22d9, *note Lock: 22da,
     *note RLock: 22db, *note Semaphore: 22dc, *note BoundedSemaphore:
     22dd, *note Condition: 22de, *note Event: 22df, *note Barrier:
     22e0, *note Queue: 22d3, *note Value: 22d7. and *note Array: 22d8.
     For example,

          from multiprocessing import Process, Manager  def f(d, l):     d[1] = '1'     d['2'] = 2     d[0.25] = None     l.reverse()  if __name__ == '__main__':     with Manager() as manager:         d = manager.dict()         l = manager.list(range(10))          p = Process(target=f, args=(d, l))         p.start()         p.join()          print(d)         print(l)

     will print

          {0.25: None, 1: '1', '2': 2} [9, 8, 7, 6, 5, 4, 3, 2, 1, 0]

     Server process managers are more flexible than using shared memory
     objects because they can be made to support arbitrary object types.
     Also, a single manager can be shared by processes on different
     computers over a network.  They are, however, slower than using
     shared memory.


File: python.info,  Node: Using a pool of workers,  Prev: Sharing state between processes,  Up: Introduction<8>

5.17.2.7 Using a pool of workers
................................

The *note Pool: 86f. class represents a pool of worker processes.  It
has methods which allows tasks to be offloaded to the worker processes
in a few different ways.

For example:

     from multiprocessing import Pool, TimeoutError import time import os  def f(x):     return x*x  if __name__ == '__main__':     # start 4 worker processes     with Pool(processes=4) as pool:          # print "[0, 1, 4,..., 81]"         print(pool.map(f, range(10)))          # print same numbers in arbitrary order         for i in pool.imap_unordered(f, range(10)):             print(i)          # evaluate "f(20)" asynchronously         res = pool.apply_async(f, (20,))      # runs in *only* one process         print(res.get(timeout=1))             # prints "400"          # evaluate "os.getpid()" asynchronously         res = pool.apply_async(os.getpid, ()) # runs in *only* one process         print(res.get(timeout=1))             # prints the PID of that process          # launching multiple evaluations asynchronously *may* use more processes         multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]         print([res.get(timeout=1) for res in multiple_results])          # make a single worker sleep for 10 secs         res = pool.apply_async(time.sleep, (10,))         try:             print(res.get(timeout=1))         except TimeoutError:             print("We lacked patience and got a multiprocessing.TimeoutError")          print("For the moment, the pool remains available for more work")      # exiting the 'with'-block has stopped the pool     print("Now the pool is closed and no longer available")

Note that the methods of a pool should only ever be used by the process
which created it.

     Note: Functionality within this package requires that the
     ‘__main__’ module be importable by the children.  This is covered
     in *note Programming guidelines: 22ce. however it is worth pointing
     out here.  This means that some examples, such as the *note
     multiprocessing.pool.Pool: 86f. examples will not work in the
     interactive interpreter.  For example:

          >>> from multiprocessing import Pool >>> p = Pool(5) >>> def f(x): ...     return x*x ... >>> p.map(f, [1,2,3]) Process PoolWorker-1: Process PoolWorker-2: Process PoolWorker-3: Traceback (most recent call last): Traceback (most recent call last): Traceback (most recent call last): AttributeError: 'module' object has no attribute 'f' AttributeError: 'module' object has no attribute 'f' AttributeError: 'module' object has no attribute 'f'

     (If you try this it will actually output three full tracebacks
     interleaved in a semi-random fashion, and then you may have to stop
     the parent process somehow.)


File: python.info,  Node: Reference,  Next: Programming guidelines,  Prev: Introduction<8>,  Up: multiprocessing — Process-based parallelism

5.17.2.8 Reference
..................

The *note multiprocessing: b7. package mostly replicates the API of the
*note threading: 109. module.

* Menu:

* Process and exceptions::
* Pipes and Queues::
* Miscellaneous: Miscellaneous<3>.
* Connection Objects: Connection Objects<2>.
* Synchronization primitives::
* Shared ctypes Objects::
* Managers::
* Proxy Objects::
* Process Pools::
* Listeners and Clients::
* Authentication keys::
* Logging: Logging<2>.
* The multiprocessing.dummy module: The multiprocessing dummy module.


File: python.info,  Node: Process and exceptions,  Next: Pipes and Queues,  Up: Reference

5.17.2.9 ‘Process’ and exceptions
.................................

 -- Class: multiprocessing.Process (group=None, target=None, name=None,
          args=(), kwargs={}, *, daemon=None)

     Process objects represent activity that is run in a separate
     process.  The *note Process: 3a7. class has equivalents of all the
     methods of *note threading.Thread: 233.

     The constructor should always be called with keyword arguments.
     `group' should always be ‘None’; it exists solely for compatibility
     with *note threading.Thread: 233.  `target' is the callable object
     to be invoked by the *note run(): 22d0. method.  It defaults to
     ‘None’, meaning nothing is called.  `name' is the process name (see
     *note name: 22e4. for more details).  `args' is the argument tuple
     for the target invocation.  `kwargs' is a dictionary of keyword
     arguments for the target invocation.  If provided, the keyword-only
     `daemon' argument sets the process *note daemon: 22e5. flag to
     ‘True’ or ‘False’.  If ‘None’ (the default), this flag will be
     inherited from the creating process.

     By default, no arguments are passed to `target'.

     If a subclass overrides the constructor, it must make sure it
     invokes the base class constructor (‘Process.__init__()’) before
     doing anything else to the process.

     Changed in version 3.3: Added the `daemon' argument.

      -- Method: run ()

          Method representing the process’s activity.

          You may override this method in a subclass.  The standard
          *note run(): 22d0. method invokes the callable object passed
          to the object’s constructor as the target argument, if any,
          with sequential and keyword arguments taken from the `args'
          and `kwargs' arguments, respectively.

      -- Method: start ()

          Start the process’s activity.

          This must be called at most once per process object.  It
          arranges for the object’s *note run(): 22d0. method to be
          invoked in a separate process.

      -- Method: join ([timeout])

          If the optional argument `timeout' is ‘None’ (the default),
          the method blocks until the process whose *note join(): 22e6.
          method is called terminates.  If `timeout' is a positive
          number, it blocks at most `timeout' seconds.  Note that the
          method returns ‘None’ if its process terminates or if the
          method times out.  Check the process’s *note exitcode: 22e7.
          to determine if it terminated.

          A process can be joined many times.

          A process cannot join itself because this would cause a
          deadlock.  It is an error to attempt to join a process before
          it has been started.

      -- Attribute: name

          The process’s name.  The name is a string used for
          identification purposes only.  It has no semantics.  Multiple
          processes may be given the same name.

          The initial name is set by the constructor.  If no explicit
          name is provided to the constructor, a name of the form
          ‘Process-N[1]:N[2]:…:N[k]’ is constructed, where each N[k] is
          the N-th child of its parent.

      -- Method: is_alive ()

          Return whether the process is alive.

          Roughly, a process object is alive from the moment the *note
          start(): 22cd. method returns until the child process
          terminates.

      -- Attribute: daemon

          The process’s daemon flag, a Boolean value.  This must be set
          before *note start(): 22cd. is called.

          The initial value is inherited from the creating process.

          When a process exits, it attempts to terminate all of its
          daemonic child processes.

          Note that a daemonic process is not allowed to create child
          processes.  Otherwise a daemonic process would leave its
          children orphaned if it gets terminated when its parent
          process exits.  Additionally, these are `not' Unix daemons or
          services, they are normal processes that will be terminated
          (and not joined) if non-daemonic processes have exited.

     In addition to the *note threading.Thread: 233. API, *note Process:
     3a7. objects also support the following attributes and methods:

      -- Attribute: pid

          Return the process ID. Before the process is spawned, this
          will be ‘None’.

      -- Attribute: exitcode

          The child’s exit code.  This will be ‘None’ if the process has
          not yet terminated.  A negative value `-N' indicates that the
          child was terminated by signal `N'.

      -- Attribute: authkey

          The process’s authentication key (a byte string).

          When *note multiprocessing: b7. is initialized the main
          process is assigned a random string using *note os.urandom():
          4c6.

          When a *note Process: 3a7. object is created, it will inherit
          the authentication key of its parent process, although this
          may be changed by setting *note authkey: 22ea. to another byte
          string.

          See *note Authentication keys: 22eb.

      -- Attribute: sentinel

          A numeric handle of a system object which will become “ready”
          when the process ends.

          You can use this value if you want to wait on several events
          at once using *note multiprocessing.connection.wait(): a19.
          Otherwise calling *note join(): 22e6. is simpler.

          On Windows, this is an OS handle usable with the
          ‘WaitForSingleObject’ and ‘WaitForMultipleObjects’ family of
          API calls.  On Unix, this is a file descriptor usable with
          primitives from the *note select: e5. module.

          New in version 3.3.

      -- Method: terminate ()

          Terminate the process.  On Unix this is done using the
          ‘SIGTERM’ signal; on Windows ‘TerminateProcess()’ is used.
          Note that exit handlers and finally clauses, etc., will not be
          executed.

          Note that descendant processes of the process will `not' be
          terminated – they will simply become orphaned.

               Warning: If this method is used when the associated
               process is using a pipe or queue then the pipe or queue
               is liable to become corrupted and may become unusable by
               other process.  Similarly, if the process has acquired a
               lock or semaphore etc.  then terminating it is liable to
               cause other processes to deadlock.

      -- Method: kill ()

          Same as *note terminate(): 22ec. but using the ‘SIGKILL’
          signal on Unix.

          New in version 3.7.

      -- Method: close ()

          Close the *note Process: 3a7. object, releasing all resources
          associated with it.  *note ValueError: 1f9. is raised if the
          underlying process is still running.  Once *note close(): 3a5.
          returns successfully, most other methods and attributes of the
          *note Process: 3a7. object will raise *note ValueError: 1f9.

          New in version 3.7.

     Note that the *note start(): 22cd, *note join(): 22e6, *note
     is_alive(): 22e8, *note terminate(): 22ec. and *note exitcode:
     22e7. methods should only be called by the process that created the
     process object.

     Example usage of some of the methods of *note Process: 3a7.:

           >>> import multiprocessing, time, signal  >>> p = multiprocessing.Process(target=time.sleep, args=(1000,))  >>> print(p, p.is_alive())  <Process ... initial> False  >>> p.start()  >>> print(p, p.is_alive())  <Process ... started> True  >>> p.terminate()  >>> time.sleep(0.1)  >>> print(p, p.is_alive())  <Process ... stopped exitcode=-SIGTERM> False  >>> p.exitcode == -signal.SIGTERM  True

 -- Exception: multiprocessing.ProcessError

     The base class of all *note multiprocessing: b7. exceptions.

 -- Exception: multiprocessing.BufferTooShort

     Exception raised by ‘Connection.recv_bytes_into()’ when the
     supplied buffer object is too small for the message read.

     If ‘e’ is an instance of *note BufferTooShort: 22ee. then
     ‘e.args[0]’ will give the message as a byte string.

 -- Exception: multiprocessing.AuthenticationError

     Raised when there is an authentication error.

 -- Exception: multiprocessing.TimeoutError

     Raised by methods with a timeout when the timeout expires.


File: python.info,  Node: Pipes and Queues,  Next: Miscellaneous<3>,  Prev: Process and exceptions,  Up: Reference

5.17.2.10 Pipes and Queues
..........................

When using multiple processes, one generally uses message passing for
communication between processes and avoids having to use any
synchronization primitives like locks.

For passing messages one can use *note Pipe(): 22d4. (for a connection
between two processes) or a queue (which allows multiple producers and
consumers).

The *note Queue: 22d3, *note SimpleQueue: 22f2. and *note JoinableQueue:
22f3. types are multi-producer, multi-consumer FIFO queues modelled on
the *note queue.Queue: d0b. class in the standard library.  They differ
in that *note Queue: 22d3. lacks the *note task_done(): 22f4. and *note
join(): 22f5. methods introduced into Python 2.5’s *note queue.Queue:
d0b. class.

If you use *note JoinableQueue: 22f3. then you `must' call *note
JoinableQueue.task_done(): 22f6. for each task removed from the queue or
else the semaphore used to count the number of unfinished tasks may
eventually overflow, raising an exception.

Note that one can also create a shared queue by using a manager object –
see *note Managers: 22f7.

     Note: *note multiprocessing: b7. uses the usual *note queue.Empty:
     22f8. and *note queue.Full: 22f9. exceptions to signal a timeout.
     They are not available in the *note multiprocessing: b7. namespace
     so you need to import them from *note queue: da.

     Note: When an object is put on a queue, the object is pickled and a
     background thread later flushes the pickled data to an underlying
     pipe.  This has some consequences which are a little surprising,
     but should not cause any practical difficulties – if they really
     bother you then you can instead use a queue created with a *note
     manager: 22f7.

       1. After putting an object on an empty queue there may be an
          infinitesimal delay before the queue’s *note empty(): 22fa.
          method returns *note False: 37d. and *note get_nowait(): 22fb.
          can return without raising *note queue.Empty: 22f8.

       2. If multiple processes are enqueuing objects, it is possible
          for the objects to be received at the other end out-of-order.
          However, objects enqueued by the same process will always be
          in the expected order with respect to each other.

     Warning: If a process is killed using *note Process.terminate():
     22ec. or *note os.kill(): ce6. while it is trying to use a *note
     Queue: 22d3, then the data in the queue is likely to become
     corrupted.  This may cause any other process to get an exception
     when it tries to use the queue later on.

     Warning: As mentioned above, if a child process has put items on a
     queue (and it has not used *note JoinableQueue.cancel_join_thread:
     22fc.), then that process will not terminate until all buffered
     items have been flushed to the pipe.

     This means that if you try joining that process you may get a
     deadlock unless you are sure that all items which have been put on
     the queue have been consumed.  Similarly, if the child process is
     non-daemonic then the parent process may hang on exit when it tries
     to join all its non-daemonic children.

     Note that a queue created using a manager does not have this issue.
     See *note Programming guidelines: 22ce.

For an example of the usage of queues for interprocess communication see
*note Examples: 22fd.

 -- Function: multiprocessing.Pipe ([duplex])

     Returns a pair ‘(conn1, conn2)’ of *note Connection: 22fe. objects
     representing the ends of a pipe.

     If `duplex' is ‘True’ (the default) then the pipe is bidirectional.
     If `duplex' is ‘False’ then the pipe is unidirectional: ‘conn1’ can
     only be used for receiving messages and ‘conn2’ can only be used
     for sending messages.

 -- Class: multiprocessing.Queue ([maxsize])

     Returns a process shared queue implemented using a pipe and a few
     locks/semaphores.  When a process first puts an item on the queue a
     feeder thread is started which transfers objects from a buffer into
     the pipe.

     The usual *note queue.Empty: 22f8. and *note queue.Full: 22f9.
     exceptions from the standard library’s *note queue: da. module are
     raised to signal timeouts.

     *note Queue: 22d3. implements all the methods of *note queue.Queue:
     d0b. except for *note task_done(): 22f4. and *note join(): 22f5.

      -- Method: qsize ()

          Return the approximate size of the queue.  Because of
          multithreading/multiprocessing semantics, this number is not
          reliable.

          Note that this may raise *note NotImplementedError: 603. on
          Unix platforms like Mac OS X where ‘sem_getvalue()’ is not
          implemented.

      -- Method: empty ()

          Return ‘True’ if the queue is empty, ‘False’ otherwise.
          Because of multithreading/multiprocessing semantics, this is
          not reliable.

      -- Method: full ()

          Return ‘True’ if the queue is full, ‘False’ otherwise.
          Because of multithreading/multiprocessing semantics, this is
          not reliable.

      -- Method: put (obj[, block[, timeout]])

          Put obj into the queue.  If the optional argument `block' is
          ‘True’ (the default) and `timeout' is ‘None’ (the default),
          block if necessary until a free slot is available.  If
          `timeout' is a positive number, it blocks at most `timeout'
          seconds and raises the *note queue.Full: 22f9. exception if no
          free slot was available within that time.  Otherwise (`block'
          is ‘False’), put an item on the queue if a free slot is
          immediately available, else raise the *note queue.Full: 22f9.
          exception (`timeout' is ignored in that case).

          Changed in version 3.8: If the queue is closed, *note
          ValueError: 1f9. is raised instead of *note AssertionError:
          f66.

      -- Method: put_nowait (obj)

          Equivalent to ‘put(obj, False)’.

      -- Method: get ([block[, timeout]])

          Remove and return an item from the queue.  If optional args
          `block' is ‘True’ (the default) and `timeout' is ‘None’ (the
          default), block if necessary until an item is available.  If
          `timeout' is a positive number, it blocks at most `timeout'
          seconds and raises the *note queue.Empty: 22f8. exception if
          no item was available within that time.  Otherwise (block is
          ‘False’), return an item if one is immediately available, else
          raise the *note queue.Empty: 22f8. exception (`timeout' is
          ignored in that case).

          Changed in version 3.8: If the queue is closed, *note
          ValueError: 1f9. is raised instead of *note OSError: 1d1.

      -- Method: get_nowait ()

          Equivalent to ‘get(False)’.

     *note multiprocessing.Queue: 22d3. has a few additional methods not
     found in *note queue.Queue: d0b.  These methods are usually
     unnecessary for most code:

      -- Method: close ()

          Indicate that no more data will be put on this queue by the
          current process.  The background thread will quit once it has
          flushed all buffered data to the pipe.  This is called
          automatically when the queue is garbage collected.

      -- Method: join_thread ()

          Join the background thread.  This can only be used after *note
          close(): 2302. has been called.  It blocks until the
          background thread exits, ensuring that all data in the buffer
          has been flushed to the pipe.

          By default if a process is not the creator of the queue then
          on exit it will attempt to join the queue’s background thread.
          The process can call *note cancel_join_thread(): 22fc. to make
          *note join_thread(): 2303. do nothing.

      -- Method: cancel_join_thread ()

          Prevent *note join_thread(): 2303. from blocking.  In
          particular, this prevents the background thread from being
          joined automatically when the process exits – see *note
          join_thread(): 2303.

          A better name for this method might be
          ‘allow_exit_without_flush()’.  It is likely to cause enqueued
          data to lost, and you almost certainly will not need to use
          it.  It is really only there if you need the current process
          to exit immediately without waiting to flush enqueued data to
          the underlying pipe, and you don’t care about lost data.

          Note: This class’s functionality requires a functioning shared
          semaphore implementation on the host operating system.
          Without one, the functionality in this class will be disabled,
          and attempts to instantiate a *note Queue: 22d3. will result
          in an *note ImportError: 329.  See bpo-3770(1) for additional
          information.  The same holds true for any of the specialized
          queue types listed below.

 -- Class: multiprocessing.SimpleQueue

     It is a simplified *note Queue: 22d3. type, very close to a locked
     *note Pipe: 22d4.

      -- Method: empty ()

          Return ‘True’ if the queue is empty, ‘False’ otherwise.

      -- Method: get ()

          Remove and return an item from the queue.

      -- Method: put (item)

          Put `item' into the queue.

 -- Class: multiprocessing.JoinableQueue ([maxsize])

     *note JoinableQueue: 22f3, a *note Queue: 22d3. subclass, is a
     queue which additionally has *note task_done(): 22f6. and *note
     join(): 2307. methods.

      -- Method: task_done ()

          Indicate that a formerly enqueued task is complete.  Used by
          queue consumers.  For each *note get(): f65. used to fetch a
          task, a subsequent call to *note task_done(): 22f6. tells the
          queue that the processing on the task is complete.

          If a *note join(): 22f5. is currently blocking, it will resume
          when all items have been processed (meaning that a *note
          task_done(): 22f6. call was received for every item that had
          been *note put(): f64. into the queue).

          Raises a *note ValueError: 1f9. if called more times than
          there were items placed in the queue.

      -- Method: join ()

          Block until all items in the queue have been gotten and
          processed.

          The count of unfinished tasks goes up whenever an item is
          added to the queue.  The count goes down whenever a consumer
          calls *note task_done(): 22f6. to indicate that the item was
          retrieved and all work on it is complete.  When the count of
          unfinished tasks drops to zero, *note join(): 22f5. unblocks.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3770


File: python.info,  Node: Miscellaneous<3>,  Next: Connection Objects<2>,  Prev: Pipes and Queues,  Up: Reference

5.17.2.11 Miscellaneous
.......................

 -- Function: multiprocessing.active_children ()

     Return list of all live children of the current process.

     Calling this has the side effect of “joining” any processes which
     have already finished.

 -- Function: multiprocessing.cpu_count ()

     Return the number of CPUs in the system.

     This number is not equivalent to the number of CPUs the current
     process can use.  The number of usable CPUs can be obtained with
     ‘len(os.sched_getaffinity(0))’

     May raise *note NotImplementedError: 603.

     See also
     ........

     *note os.cpu_count(): 873.

 -- Function: multiprocessing.current_process ()

     Return the *note Process: 3a7. object corresponding to the current
     process.

     An analogue of *note threading.current_thread(): 2294.

 -- Function: multiprocessing.parent_process ()

     Return the *note Process: 3a7. object corresponding to the parent
     process of the *note current_process(): 230a.  For the main
     process, ‘parent_process’ will be ‘None’.

     New in version 3.8.

 -- Function: multiprocessing.freeze_support ()

     Add support for when a program which uses *note multiprocessing:
     b7. has been frozen to produce a Windows executable.  (Has been
     tested with `py2exe', `PyInstaller' and `cx_Freeze'.)

     One needs to call this function straight after the ‘if __name__ ==
     '__main__'’ line of the main module.  For example:

          from multiprocessing import Process, freeze_support  def f():     print('hello world!')  if __name__ == '__main__':     freeze_support()     Process(target=f).start()

     If the ‘freeze_support()’ line is omitted then trying to run the
     frozen executable will raise *note RuntimeError: 2b8.

     Calling ‘freeze_support()’ has no effect when invoked on any
     operating system other than Windows.  In addition, if the module is
     being run normally by the Python interpreter on Windows (the
     program has not been frozen), then ‘freeze_support()’ has no
     effect.

 -- Function: multiprocessing.get_all_start_methods ()

     Returns a list of the supported start methods, the first of which
     is the default.  The possible start methods are ‘'fork'’, ‘'spawn'’
     and ‘'forkserver'’.  On Windows only ‘'spawn'’ is available.  On
     Unix ‘'fork'’ and ‘'spawn'’ are always supported, with ‘'fork'’
     being the default.

     New in version 3.4.

 -- Function: multiprocessing.get_context (method=None)

     Return a context object which has the same attributes as the *note
     multiprocessing: b7. module.

     If `method' is ‘None’ then the default context is returned.
     Otherwise `method' should be ‘'fork'’, ‘'spawn'’, ‘'forkserver'’.
     *note ValueError: 1f9. is raised if the specified start method is
     not available.

     New in version 3.4.

 -- Function: multiprocessing.get_start_method (allow_none=False)

     Return the name of start method used for starting processes.

     If the start method has not been fixed and `allow_none' is false,
     then the start method is fixed to the default and the name is
     returned.  If the start method has not been fixed and `allow_none'
     is true then ‘None’ is returned.

     The return value can be ‘'fork'’, ‘'spawn'’, ‘'forkserver'’ or
     ‘None’.  ‘'fork'’ is the default on Unix, while ‘'spawn'’ is the
     default on Windows.

     New in version 3.4.

 -- Function: multiprocessing.set_executable ()

     Sets the path of the Python interpreter to use when starting a
     child process.  (By default *note sys.executable: 272. is used).
     Embedders will probably need to do some thing like

          set_executable(os.path.join(sys.exec_prefix, 'pythonw.exe'))

     before they can create child processes.

     Changed in version 3.4: Now supported on Unix when the ‘'spawn'’
     start method is used.

 -- Function: multiprocessing.set_start_method (method)

     Set the method which should be used to start child processes.
     `method' can be ‘'fork'’, ‘'spawn'’ or ‘'forkserver'’.

     Note that this should be called at most once, and it should be
     protected inside the ‘if __name__ == '__main__'’ clause of the main
     module.

     New in version 3.4.

     Note: *note multiprocessing: b7. contains no analogues of *note
     threading.active_count(): 2292, *note threading.enumerate(): 2293,
     *note threading.settrace(): 2295, *note threading.setprofile():
     2296, *note threading.Timer: aa3, or *note threading.local: 2236.


File: python.info,  Node: Connection Objects<2>,  Next: Synchronization primitives,  Prev: Miscellaneous<3>,  Up: Reference

5.17.2.12 Connection Objects
............................

Connection objects allow the sending and receiving of picklable objects
or strings.  They can be thought of as message oriented connected
sockets.

Connection objects are usually created using *note Pipe: 22d4. – see
also *note Listeners and Clients: 230f.

 -- Class: multiprocessing.connection.Connection

      -- Method: send (obj)

          Send an object to the other end of the connection which should
          be read using *note recv(): 2311.

          The object must be picklable.  Very large pickles
          (approximately 32 MiB+, though it depends on the OS) may raise
          a *note ValueError: 1f9. exception.

      -- Method: recv ()

          Return an object sent from the other end of the connection
          using *note send(): 2310.  Blocks until there is something to
          receive.  Raises *note EOFError: c5f. if there is nothing left
          to receive and the other end was closed.

      -- Method: fileno ()

          Return the file descriptor or handle used by the connection.

      -- Method: close ()

          Close the connection.

          This is called automatically when the connection is garbage
          collected.

      -- Method: poll ([timeout])

          Return whether there is any data available to be read.

          If `timeout' is not specified then it will return immediately.
          If `timeout' is a number then this specifies the maximum time
          in seconds to block.  If `timeout' is ‘None’ then an infinite
          timeout is used.

          Note that multiple connection objects may be polled at once by
          using *note multiprocessing.connection.wait(): a19.

      -- Method: send_bytes (buffer[, offset[, size]])

          Send byte data from a *note bytes-like object: 5dd. as a
          complete message.

          If `offset' is given then data is read from that position in
          `buffer'.  If `size' is given then that many bytes will be
          read from buffer.  Very large buffers (approximately 32 MiB+,
          though it depends on the OS) may raise a *note ValueError:
          1f9. exception

      -- Method: recv_bytes ([maxlength])

          Return a complete message of byte data sent from the other end
          of the connection as a string.  Blocks until there is
          something to receive.  Raises *note EOFError: c5f. if there is
          nothing left to receive and the other end has closed.

          If `maxlength' is specified and the message is longer than
          `maxlength' then *note OSError: 1d1. is raised and the
          connection will no longer be readable.

          Changed in version 3.3: This function used to raise *note
          IOError: 986, which is now an alias of *note OSError: 1d1.

      -- Method: recv_bytes_into (buffer[, offset])

          Read into `buffer' a complete message of byte data sent from
          the other end of the connection and return the number of bytes
          in the message.  Blocks until there is something to receive.
          Raises *note EOFError: c5f. if there is nothing left to
          receive and the other end was closed.

          `buffer' must be a writable *note bytes-like object: 5dd.  If
          `offset' is given then the message will be written into the
          buffer from that position.  Offset must be a non-negative
          integer less than the length of `buffer' (in bytes).

          If the buffer is too short then a ‘BufferTooShort’ exception
          is raised and the complete message is available as ‘e.args[0]’
          where ‘e’ is the exception instance.

     Changed in version 3.3: Connection objects themselves can now be
     transferred between processes using *note Connection.send(): 2310.
     and *note Connection.recv(): 2311.

     New in version 3.3: Connection objects now support the context
     management protocol – see *note Context Manager Types: 13c4.  *note
     __enter__(): 1618. returns the connection object, and *note
     __exit__(): 161a. calls *note close(): 2313.

For example:

     >>> from multiprocessing import Pipe >>> a, b = Pipe() >>> a.send([1, 'hello', None]) >>> b.recv() [1, 'hello', None] >>> b.send_bytes(b'thank you') >>> a.recv_bytes() b'thank you' >>> import array >>> arr1 = array.array('i', range(5)) >>> arr2 = array.array('i', [0] * 10) >>> a.send_bytes(arr1) >>> count = b.recv_bytes_into(arr2) >>> assert count == len(arr1) * arr1.itemsize >>> arr2 array('i', [0, 1, 2, 3, 4, 0, 0, 0, 0, 0])

     Warning: The *note Connection.recv(): 2311. method automatically
     unpickles the data it receives, which can be a security risk unless
     you can trust the process which sent the message.

     Therefore, unless the connection object was produced using ‘Pipe()’
     you should only use the *note recv(): 2311. and *note send(): 2310.
     methods after performing some sort of authentication.  See *note
     Authentication keys: 22eb.

     Warning: If a process is killed while it is trying to read or write
     to a pipe then the data in the pipe is likely to become corrupted,
     because it may become impossible to be sure where the message
     boundaries lie.


File: python.info,  Node: Synchronization primitives,  Next: Shared ctypes Objects,  Prev: Connection Objects<2>,  Up: Reference

5.17.2.13 Synchronization primitives
....................................

Generally synchronization primitives are not as necessary in a
multiprocess program as they are in a multithreaded program.  See the
documentation for *note threading: 109. module.

Note that one can also create synchronization primitives by using a
manager object – see *note Managers: 22f7.

 -- Class: multiprocessing.Barrier (parties[, action[, timeout]])

     A barrier object: a clone of *note threading.Barrier: b52.

     New in version 3.3.

 -- Class: multiprocessing.BoundedSemaphore ([value])

     A bounded semaphore object: a close analog of *note
     threading.BoundedSemaphore: aa1.

     A solitary difference from its close analog exists: its ‘acquire’
     method’s first argument is named `block', as is consistent with
     *note Lock.acquire(): 2319.

          Note: On Mac OS X, this is indistinguishable from *note
          Semaphore: 22dc. because ‘sem_getvalue()’ is not implemented
          on that platform.

 -- Class: multiprocessing.Condition ([lock])

     A condition variable: an alias for *note threading.Condition: a9f.

     If `lock' is specified then it should be a *note Lock: 22da. or
     *note RLock: 22db. object from *note multiprocessing: b7.

     Changed in version 3.3: The *note wait_for(): 22b3. method was
     added.

 -- Class: multiprocessing.Event

     A clone of *note threading.Event: aa2.

 -- Class: multiprocessing.Lock

     A non-recursive lock object: a close analog of *note
     threading.Lock: 22a8.  Once a process or thread has acquired a
     lock, subsequent attempts to acquire it from any process or thread
     will block until it is released; any process or thread may release
     it.  The concepts and behaviors of *note threading.Lock: 22a8. as
     it applies to threads are replicated here in *note
     multiprocessing.Lock: 22da. as it applies to either processes or
     threads, except as noted.

     Note that *note Lock: 22da. is actually a factory function which
     returns an instance of ‘multiprocessing.synchronize.Lock’
     initialized with a default context.

     *note Lock: 22da. supports the *note context manager: 55d. protocol
     and thus may be used in *note with: 6dd. statements.

      -- Method: acquire (block=True, timeout=None)

          Acquire a lock, blocking or non-blocking.

          With the `block' argument set to ‘True’ (the default), the
          method call will block until the lock is in an unlocked state,
          then set it to locked and return ‘True’.  Note that the name
          of this first argument differs from that in *note
          threading.Lock.acquire(): 760.

          With the `block' argument set to ‘False’, the method call does
          not block.  If the lock is currently in a locked state, return
          ‘False’; otherwise set the lock to a locked state and return
          ‘True’.

          When invoked with a positive, floating-point value for
          `timeout', block for at most the number of seconds specified
          by `timeout' as long as the lock can not be acquired.
          Invocations with a negative value for `timeout' are equivalent
          to a `timeout' of zero.  Invocations with a `timeout' value of
          ‘None’ (the default) set the timeout period to infinite.  Note
          that the treatment of negative or ‘None’ values for `timeout'
          differs from the implemented behavior in *note
          threading.Lock.acquire(): 760.  The `timeout' argument has no
          practical implications if the `block' argument is set to
          ‘False’ and is thus ignored.  Returns ‘True’ if the lock has
          been acquired or ‘False’ if the timeout period has elapsed.

      -- Method: release ()

          Release a lock.  This can be called from any process or
          thread, not only the process or thread which originally
          acquired the lock.

          Behavior is the same as in *note threading.Lock.release():
          22a6. except that when invoked on an unlocked lock, a *note
          ValueError: 1f9. is raised.

 -- Class: multiprocessing.RLock

     A recursive lock object: a close analog of *note threading.RLock:
     be2.  A recursive lock must be released by the process or thread
     that acquired it.  Once a process or thread has acquired a
     recursive lock, the same process or thread may acquire it again
     without blocking; that process or thread must release it once for
     each time it has been acquired.

     Note that *note RLock: 22db. is actually a factory function which
     returns an instance of ‘multiprocessing.synchronize.RLock’
     initialized with a default context.

     *note RLock: 22db. supports the *note context manager: 55d.
     protocol and thus may be used in *note with: 6dd. statements.

      -- Method: acquire (block=True, timeout=None)

          Acquire a lock, blocking or non-blocking.

          When invoked with the `block' argument set to ‘True’, block
          until the lock is in an unlocked state (not owned by any
          process or thread) unless the lock is already owned by the
          current process or thread.  The current process or thread then
          takes ownership of the lock (if it does not already have
          ownership) and the recursion level inside the lock increments
          by one, resulting in a return value of ‘True’.  Note that
          there are several differences in this first argument’s
          behavior compared to the implementation of *note
          threading.RLock.acquire(): 761, starting with the name of the
          argument itself.

          When invoked with the `block' argument set to ‘False’, do not
          block.  If the lock has already been acquired (and thus is
          owned) by another process or thread, the current process or
          thread does not take ownership and the recursion level within
          the lock is not changed, resulting in a return value of
          ‘False’.  If the lock is in an unlocked state, the current
          process or thread takes ownership and the recursion level is
          incremented, resulting in a return value of ‘True’.

          Use and behaviors of the `timeout' argument are the same as in
          *note Lock.acquire(): 2319.  Note that some of these behaviors
          of `timeout' differ from the implemented behaviors in *note
          threading.RLock.acquire(): 761.

      -- Method: release ()

          Release a lock, decrementing the recursion level.  If after
          the decrement the recursion level is zero, reset the lock to
          unlocked (not owned by any process or thread) and if any other
          processes or threads are blocked waiting for the lock to
          become unlocked, allow exactly one of them to proceed.  If
          after the decrement the recursion level is still nonzero, the
          lock remains locked and owned by the calling process or
          thread.

          Only call this method when the calling process or thread owns
          the lock.  An *note AssertionError: f66. is raised if this
          method is called by a process or thread other than the owner
          or if the lock is in an unlocked (unowned) state.  Note that
          the type of exception raised in this situation differs from
          the implemented behavior in *note threading.RLock.release():
          22ac.

 -- Class: multiprocessing.Semaphore ([value])

     A semaphore object: a close analog of *note threading.Semaphore:
     aa0.

     A solitary difference from its close analog exists: its ‘acquire’
     method’s first argument is named `block', as is consistent with
     *note Lock.acquire(): 2319.

     Note: On Mac OS X, ‘sem_timedwait’ is unsupported, so calling
     ‘acquire()’ with a timeout will emulate that function’s behavior
     using a sleeping loop.

     Note: If the SIGINT signal generated by ‘Ctrl-C’ arrives while the
     main thread is blocked by a call to ‘BoundedSemaphore.acquire()’,
     *note Lock.acquire(): 2319, *note RLock.acquire(): 231b,
     ‘Semaphore.acquire()’, ‘Condition.acquire()’ or ‘Condition.wait()’
     then the call will be immediately interrupted and *note
     KeyboardInterrupt: 197. will be raised.

     This differs from the behaviour of *note threading: 109. where
     SIGINT will be ignored while the equivalent blocking calls are in
     progress.

     Note: Some of this package’s functionality requires a functioning
     shared semaphore implementation on the host operating system.
     Without one, the ‘multiprocessing.synchronize’ module will be
     disabled, and attempts to import it will result in an *note
     ImportError: 329.  See bpo-3770(1) for additional information.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue3770


File: python.info,  Node: Shared ctypes Objects,  Next: Managers,  Prev: Synchronization primitives,  Up: Reference

5.17.2.14 Shared ‘ctypes’ Objects
.................................

It is possible to create shared objects using shared memory which can be
inherited by child processes.

 -- Function: multiprocessing.Value (typecode_or_type, *args, lock=True)

     Return a *note ctypes: 2b. object allocated from shared memory.  By
     default the return value is actually a synchronized wrapper for the
     object.  The object itself can be accessed via the `value'
     attribute of a *note Value: 22d7.

     `typecode_or_type' determines the type of the returned object: it
     is either a ctypes type or a one character typecode of the kind
     used by the *note array: 7. module.  `*args' is passed on to the
     constructor for the type.

     If `lock' is ‘True’ (the default) then a new recursive lock object
     is created to synchronize access to the value.  If `lock' is a
     *note Lock: 22da. or *note RLock: 22db. object then that will be
     used to synchronize access to the value.  If `lock' is ‘False’ then
     access to the returned object will not be automatically protected
     by a lock, so it will not necessarily be “process-safe”.

     Operations like ‘+=’ which involve a read and write are not atomic.
     So if, for instance, you want to atomically increment a shared
     value it is insufficient to just do

          counter.value += 1

     Assuming the associated lock is recursive (which it is by default)
     you can instead do

          with counter.get_lock():     counter.value += 1

     Note that `lock' is a keyword-only argument.

 -- Function: multiprocessing.Array (typecode_or_type,
          size_or_initializer, *, lock=True)

     Return a ctypes array allocated from shared memory.  By default the
     return value is actually a synchronized wrapper for the array.

     `typecode_or_type' determines the type of the elements of the
     returned array: it is either a ctypes type or a one character
     typecode of the kind used by the *note array: 7. module.  If
     `size_or_initializer' is an integer, then it determines the length
     of the array, and the array will be initially zeroed.  Otherwise,
     `size_or_initializer' is a sequence which is used to initialize the
     array and whose length determines the length of the array.

     If `lock' is ‘True’ (the default) then a new lock object is created
     to synchronize access to the value.  If `lock' is a *note Lock:
     22da. or *note RLock: 22db. object then that will be used to
     synchronize access to the value.  If `lock' is ‘False’ then access
     to the returned object will not be automatically protected by a
     lock, so it will not necessarily be “process-safe”.

     Note that `lock' is a keyword only argument.

     Note that an array of *note ctypes.c_char: 21ff. has `value' and
     `raw' attributes which allow one to use it to store and retrieve
     strings.

* Menu:

* The multiprocessing.sharedctypes module: The multiprocessing sharedctypes module.


File: python.info,  Node: The multiprocessing sharedctypes module,  Up: Shared ctypes Objects

5.17.2.15 The ‘multiprocessing.sharedctypes’ module
...................................................

The *note multiprocessing.sharedctypes: bd. module provides functions
for allocating *note ctypes: 2b. objects from shared memory which can be
inherited by child processes.

     Note: Although it is possible to store a pointer in shared memory
     remember that this will refer to a location in the address space of
     a specific process.  However, the pointer is quite likely to be
     invalid in the context of a second process and trying to
     dereference the pointer from the second process may cause a crash.

 -- Function: multiprocessing.sharedctypes.RawArray (typecode_or_type,
          size_or_initializer)

     Return a ctypes array allocated from shared memory.

     `typecode_or_type' determines the type of the elements of the
     returned array: it is either a ctypes type or a one character
     typecode of the kind used by the *note array: 7. module.  If
     `size_or_initializer' is an integer then it determines the length
     of the array, and the array will be initially zeroed.  Otherwise
     `size_or_initializer' is a sequence which is used to initialize the
     array and whose length determines the length of the array.

     Note that setting and getting an element is potentially non-atomic
     – use *note Array(): 2320. instead to make sure that access is
     automatically synchronized using a lock.

 -- Function: multiprocessing.sharedctypes.RawValue (typecode_or_type,
          *args)

     Return a ctypes object allocated from shared memory.

     `typecode_or_type' determines the type of the returned object: it
     is either a ctypes type or a one character typecode of the kind
     used by the *note array: 7. module.  `*args' is passed on to the
     constructor for the type.

     Note that setting and getting the value is potentially non-atomic –
     use *note Value(): 2322. instead to make sure that access is
     automatically synchronized using a lock.

     Note that an array of *note ctypes.c_char: 21ff. has ‘value’ and
     ‘raw’ attributes which allow one to use it to store and retrieve
     strings – see documentation for *note ctypes: 2b.

 -- Function: multiprocessing.sharedctypes.Array (typecode_or_type,
          size_or_initializer, *, lock=True)

     The same as *note RawArray(): 231f. except that depending on the
     value of `lock' a process-safe synchronization wrapper may be
     returned instead of a raw ctypes array.

     If `lock' is ‘True’ (the default) then a new lock object is created
     to synchronize access to the value.  If `lock' is a *note Lock:
     22da. or *note RLock: 22db. object then that will be used to
     synchronize access to the value.  If `lock' is ‘False’ then access
     to the returned object will not be automatically protected by a
     lock, so it will not necessarily be “process-safe”.

     Note that `lock' is a keyword-only argument.

 -- Function: multiprocessing.sharedctypes.Value (typecode_or_type,
          *args, lock=True)

     The same as *note RawValue(): 2321. except that depending on the
     value of `lock' a process-safe synchronization wrapper may be
     returned instead of a raw ctypes object.

     If `lock' is ‘True’ (the default) then a new lock object is created
     to synchronize access to the value.  If `lock' is a *note Lock:
     22da. or *note RLock: 22db. object then that will be used to
     synchronize access to the value.  If `lock' is ‘False’ then access
     to the returned object will not be automatically protected by a
     lock, so it will not necessarily be “process-safe”.

     Note that `lock' is a keyword-only argument.

 -- Function: multiprocessing.sharedctypes.copy (obj)

     Return a ctypes object allocated from shared memory which is a copy
     of the ctypes object `obj'.

 -- Function: multiprocessing.sharedctypes.synchronized (obj[, lock])

     Return a process-safe wrapper object for a ctypes object which uses
     `lock' to synchronize access.  If `lock' is ‘None’ (the default)
     then a *note multiprocessing.RLock: 22db. object is created
     automatically.

     A synchronized wrapper will have two methods in addition to those
     of the object it wraps: ‘get_obj()’ returns the wrapped object and
     ‘get_lock()’ returns the lock object used for synchronization.

     Note that accessing the ctypes object through the wrapper can be a
     lot slower than accessing the raw ctypes object.

     Changed in version 3.5: Synchronized objects support the *note
     context manager: 55d. protocol.

The table below compares the syntax for creating shared ctypes objects
from shared memory with the normal ctypes syntax.  (In the table
‘MyStruct’ is some subclass of *note ctypes.Structure: 2220.)

ctypes                   sharedctypes using type        sharedctypes using typecode
                                                        
----------------------------------------------------------------------------------------
                                                        
c_double(2.4)            RawValue(c_double, 2.4)        RawValue(‘d’, 2.4)
                                                        
                                                        
MyStruct(4, 6)           RawValue(MyStruct, 4, 6)
                         
                                                        
(c_short * 7)()          RawArray(c_short, 7)           RawArray(‘h’, 7)
                                                        
                                                        
(c_int * 3)(9, 2, 8)     RawArray(c_int, (9, 2, 8))     RawArray(‘i’, (9, 2, 8))
                                                        

Below is an example where a number of ctypes objects are modified by a
child process:

     from multiprocessing import Process, Lock from multiprocessing.sharedctypes import Value, Array from ctypes import Structure, c_double  class Point(Structure):     _fields_ = [('x', c_double), ('y', c_double)]  def modify(n, x, s, A):     n.value **= 2     x.value **= 2     s.value = s.value.upper()     for a in A:         a.x **= 2         a.y **= 2  if __name__ == '__main__':     lock = Lock()      n = Value('i', 7)     x = Value(c_double, 1.0/3.0, lock=False)     s = Array('c', b'hello world', lock=lock)     A = Array(Point, [(1.875,-6.25), (-5.75,2.0), (2.375,9.5)], lock=lock)      p = Process(target=modify, args=(n, x, s, A))     p.start()     p.join()      print(n.value)     print(x.value)     print(s.value)     print([(a.x, a.y) for a in A])

The results printed are

     49 0.1111111111111111 HELLO WORLD [(3.515625, 39.0625), (33.0625, 4.0), (5.640625, 90.25)]


File: python.info,  Node: Managers,  Next: Proxy Objects,  Prev: Shared ctypes Objects,  Up: Reference

5.17.2.16 Managers
..................

Managers provide a way to create data which can be shared between
different processes, including sharing over a network between processes
running on different machines.  A manager object controls a server
process which manages `shared objects'.  Other processes can access the
shared objects by using proxies.

 -- Function: multiprocessing.Manager ()

     Returns a started *note SyncManager: 2326. object which can be used
     for sharing objects between processes.  The returned manager object
     corresponds to a spawned child process and has methods which will
     create shared objects and return corresponding proxies.

Manager processes will be shutdown as soon as they are garbage collected
or their parent process exits.  The manager classes are defined in the
*note multiprocessing.managers: ba. module:

 -- Class: multiprocessing.managers.BaseManager ([address[, authkey]])

     Create a BaseManager object.

     Once created one should call *note start(): 2328. or
     ‘get_server().serve_forever()’ to ensure that the manager object
     refers to a started manager process.

     `address' is the address on which the manager process listens for
     new connections.  If `address' is ‘None’ then an arbitrary one is
     chosen.

     `authkey' is the authentication key which will be used to check the
     validity of incoming connections to the server process.  If
     `authkey' is ‘None’ then ‘current_process().authkey’ is used.
     Otherwise `authkey' is used and it must be a byte string.

      -- Method: start ([initializer[, initargs]])

          Start a subprocess to start the manager.  If `initializer' is
          not ‘None’ then the subprocess will call
          ‘initializer(*initargs)’ when it starts.

      -- Method: get_server ()

          Returns a ‘Server’ object which represents the actual server
          under the control of the Manager.  The ‘Server’ object
          supports the ‘serve_forever()’ method:

               >>> from multiprocessing.managers import BaseManager >>> manager = BaseManager(address=('', 50000), authkey=b'abc') >>> server = manager.get_server() >>> server.serve_forever()

          ‘Server’ additionally has an *note address: 232a. attribute.

      -- Method: connect ()

          Connect a local manager object to a remote manager process:

               >>> from multiprocessing.managers import BaseManager >>> m = BaseManager(address=('127.0.0.1', 50000), authkey=b'abc') >>> m.connect()

      -- Method: shutdown ()

          Stop the process used by the manager.  This is only available
          if *note start(): 2328. has been used to start the server
          process.

          This can be called multiple times.

      -- Method: register (typeid[, callable[, proxytype[, exposed[,
               method_to_typeid[, create_method]]]]])

          A classmethod which can be used for registering a type or
          callable with the manager class.

          `typeid' is a “type identifier” which is used to identify a
          particular type of shared object.  This must be a string.

          `callable' is a callable used for creating objects for this
          type identifier.  If a manager instance will be connected to
          the server using the *note connect(): 232b. method, or if the
          `create_method' argument is ‘False’ then this can be left as
          ‘None’.

          `proxytype' is a subclass of *note BaseProxy: 232e. which is
          used to create proxies for shared objects with this `typeid'.
          If ‘None’ then a proxy class is created automatically.

          `exposed' is used to specify a sequence of method names which
          proxies for this typeid should be allowed to access using
          *note BaseProxy._callmethod(): 232f.  (If `exposed' is ‘None’
          then ‘proxytype._exposed_’ is used instead if it exists.)  In
          the case where no exposed list is specified, all “public
          methods” of the shared object will be accessible.  (Here a
          “public method” means any attribute which has a *note
          __call__(): 1369. method and whose name does not begin with
          ‘'_'’.)

          `method_to_typeid' is a mapping used to specify the return
          type of those exposed methods which should return a proxy.  It
          maps method names to typeid strings.  (If `method_to_typeid'
          is ‘None’ then ‘proxytype._method_to_typeid_’ is used instead
          if it exists.)  If a method’s name is not a key of this
          mapping or if the mapping is ‘None’ then the object returned
          by the method will be copied by value.

          `create_method' determines whether a method should be created
          with name `typeid' which can be used to tell the server
          process to create a new shared object and return a proxy for
          it.  By default it is ‘True’.

     *note BaseManager: 2327. instances also have one read-only
     property:

      -- Attribute: address

          The address used by the manager.

     Changed in version 3.3: Manager objects support the context
     management protocol – see *note Context Manager Types: 13c4.  *note
     __enter__(): 1618. starts the server process (if it has not already
     started) and then returns the manager object.  *note __exit__():
     161a. calls *note shutdown(): 232c.

     In previous versions *note __enter__(): 1618. did not start the
     manager’s server process if it was not already started.

 -- Class: multiprocessing.managers.SyncManager

     A subclass of *note BaseManager: 2327. which can be used for the
     synchronization of processes.  Objects of this type are returned by
     ‘multiprocessing.Manager()’.

     Its methods create and return *note Proxy Objects: 55a. for a
     number of commonly used data types to be synchronized across
     processes.  This notably includes shared lists and dictionaries.

      -- Method: Barrier (parties[, action[, timeout]])

          Create a shared *note threading.Barrier: b52. object and
          return a proxy for it.

          New in version 3.3.

      -- Method: BoundedSemaphore ([value])

          Create a shared *note threading.BoundedSemaphore: aa1. object
          and return a proxy for it.

      -- Method: Condition ([lock])

          Create a shared *note threading.Condition: a9f. object and
          return a proxy for it.

          If `lock' is supplied then it should be a proxy for a *note
          threading.Lock: 22a8. or *note threading.RLock: be2. object.

          Changed in version 3.3: The *note wait_for(): 22b3. method was
          added.

      -- Method: Event ()

          Create a shared *note threading.Event: aa2. object and return
          a proxy for it.

      -- Method: Lock ()

          Create a shared *note threading.Lock: 22a8. object and return
          a proxy for it.

      -- Method: Namespace ()

          Create a shared *note Namespace: 22d9. object and return a
          proxy for it.

      -- Method: Queue ([maxsize])

          Create a shared *note queue.Queue: d0b. object and return a
          proxy for it.

      -- Method: RLock ()

          Create a shared *note threading.RLock: be2. object and return
          a proxy for it.

      -- Method: Semaphore ([value])

          Create a shared *note threading.Semaphore: aa0. object and
          return a proxy for it.

      -- Method: Array (typecode, sequence)

          Create an array and return a proxy for it.

      -- Method: Value (typecode, value)

          Create an object with a writable ‘value’ attribute and return
          a proxy for it.

      -- Method: dict ()

      -- Method: dict (mapping)

      -- Method: dict (sequence)

          Create a shared *note dict: 1b6. object and return a proxy for
          it.

      -- Method: list ()

      -- Method: list (sequence)

          Create a shared *note list: 260. object and return a proxy for
          it.

     Changed in version 3.6: Shared objects are capable of being nested.
     For example, a shared container object such as a shared list can
     contain other shared objects which will all be managed and
     synchronized by the *note SyncManager: 2326.

 -- Class: multiprocessing.managers.Namespace

     A type that can register with *note SyncManager: 2326.

     A namespace object has no public methods, but does have writable
     attributes.  Its representation shows the values of its attributes.

     However, when using a proxy for a namespace object, an attribute
     beginning with ‘'_'’ will be an attribute of the proxy and not an
     attribute of the referent:

          >>> manager = multiprocessing.Manager() >>> Global = manager.Namespace() >>> Global.x = 10 >>> Global.y = 'hello' >>> Global._z = 12.3    # this is an attribute of the proxy >>> print(Global) Namespace(x=10, y='hello')

* Menu:

* Customized managers::
* Using a remote manager::


File: python.info,  Node: Customized managers,  Next: Using a remote manager,  Up: Managers

5.17.2.17 Customized managers
.............................

To create one’s own manager, one creates a subclass of *note
BaseManager: 2327. and uses the *note register(): 232d. classmethod to
register new types or callables with the manager class.  For example:

     from multiprocessing.managers import BaseManager  class MathsClass:     def add(self, x, y):         return x + y     def mul(self, x, y):         return x * y  class MyManager(BaseManager):     pass  MyManager.register('Maths', MathsClass)  if __name__ == '__main__':     with MyManager() as manager:         maths = manager.Maths()         print(maths.add(4, 3))         # prints 7         print(maths.mul(7, 8))         # prints 56


File: python.info,  Node: Using a remote manager,  Prev: Customized managers,  Up: Managers

5.17.2.18 Using a remote manager
................................

It is possible to run a manager server on one machine and have clients
use it from other machines (assuming that the firewalls involved allow
it).

Running the following commands creates a server for a single shared
queue which remote clients can access:

     >>> from multiprocessing.managers import BaseManager >>> from queue import Queue >>> queue = Queue() >>> class QueueManager(BaseManager): pass >>> QueueManager.register('get_queue', callable=lambda:queue) >>> m = QueueManager(address=('', 50000), authkey=b'abracadabra') >>> s = m.get_server() >>> s.serve_forever()

One client can access the server as follows:

     >>> from multiprocessing.managers import BaseManager >>> class QueueManager(BaseManager): pass >>> QueueManager.register('get_queue') >>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra') >>> m.connect() >>> queue = m.get_queue() >>> queue.put('hello')

Another client can also use it:

     >>> from multiprocessing.managers import BaseManager >>> class QueueManager(BaseManager): pass >>> QueueManager.register('get_queue') >>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra') >>> m.connect() >>> queue = m.get_queue() >>> queue.get() 'hello'

Local processes can also access that queue, using the code from above on
the client to access it remotely:

     >>> from multiprocessing import Process, Queue >>> from multiprocessing.managers import BaseManager >>> class Worker(Process): ...     def __init__(self, q): ...         self.q = q ...         super(Worker, self).__init__() ...     def run(self): ...         self.q.put('local hello') ... >>> queue = Queue() >>> w = Worker(queue) >>> w.start() >>> class QueueManager(BaseManager): pass ... >>> QueueManager.register('get_queue', callable=lambda: queue) >>> m = QueueManager(address=('', 50000), authkey=b'abracadabra') >>> s = m.get_server() >>> s.serve_forever()


File: python.info,  Node: Proxy Objects,  Next: Process Pools,  Prev: Managers,  Up: Reference

5.17.2.19 Proxy Objects
.......................

A proxy is an object which `refers' to a shared object which lives
(presumably) in a different process.  The shared object is said to be
the `referent' of the proxy.  Multiple proxy objects may have the same
referent.

A proxy object has methods which invoke corresponding methods of its
referent (although not every method of the referent will necessarily be
available through the proxy).  In this way, a proxy can be used just
like its referent can:

     >>> from multiprocessing import Manager >>> manager = Manager() >>> l = manager.list([i*i for i in range(10)]) >>> print(l) [0, 1, 4, 9, 16, 25, 36, 49, 64, 81] >>> print(repr(l)) <ListProxy object, typeid 'list' at 0x...> >>> l[4] 16 >>> l[2:5] [4, 9, 16]

Notice that applying *note str(): 325. to a proxy will return the
representation of the referent, whereas applying *note repr(): 7c0. will
return the representation of the proxy.

An important feature of proxy objects is that they are picklable so they
can be passed between processes.  As such, a referent can contain *note
Proxy Objects: 55a.  This permits nesting of these managed lists, dicts,
and other *note Proxy Objects: 55a.:

     >>> a = manager.list() >>> b = manager.list() >>> a.append(b)         # referent of a now contains referent of b >>> print(a, b) [<ListProxy object, typeid 'list' at ...>] [] >>> b.append('hello') >>> print(a[0], b) ['hello'] ['hello']

Similarly, dict and list proxies may be nested inside one another:

     >>> l_outer = manager.list([ manager.dict() for i in range(2) ]) >>> d_first_inner = l_outer[0] >>> d_first_inner['a'] = 1 >>> d_first_inner['b'] = 2 >>> l_outer[1]['c'] = 3 >>> l_outer[1]['z'] = 26 >>> print(l_outer[0]) {'a': 1, 'b': 2} >>> print(l_outer[1]) {'c': 3, 'z': 26}

If standard (non-proxy) *note list: 260. or *note dict: 1b6. objects are
contained in a referent, modifications to those mutable values will not
be propagated through the manager because the proxy has no way of
knowing when the values contained within are modified.  However, storing
a value in a container proxy (which triggers a ‘__setitem__’ on the
proxy object) does propagate through the manager and so to effectively
modify such an item, one could re-assign the modified value to the
container proxy:

     # create a list proxy and append a mutable object (a dictionary) lproxy = manager.list() lproxy.append({}) # now mutate the dictionary d = lproxy[0] d['a'] = 1 d['b'] = 2 # at this point, the changes to d are not yet synced, but by # updating the dictionary, the proxy is notified of the change lproxy[0] = d

This approach is perhaps less convenient than employing nested *note
Proxy Objects: 55a. for most use cases but also demonstrates a level of
control over the synchronization.

     Note: The proxy types in *note multiprocessing: b7. do nothing to
     support comparisons by value.  So, for instance, we have:

          >>> manager.list([1,2,3]) == [1,2,3] False

     One should just use a copy of the referent instead when making
     comparisons.

 -- Class: multiprocessing.managers.BaseProxy

     Proxy objects are instances of subclasses of *note BaseProxy: 232e.

      -- Method: _callmethod (methodname[, args[, kwds]])

          Call and return the result of a method of the proxy’s
          referent.

          If ‘proxy’ is a proxy whose referent is ‘obj’ then the
          expression

               proxy._callmethod(methodname, args, kwds)

          will evaluate the expression

               getattr(obj, methodname)(*args, **kwds)

          in the manager’s process.

          The returned value will be a copy of the result of the call or
          a proxy to a new shared object – see documentation for the
          `method_to_typeid' argument of *note BaseManager.register():
          232d.

          If an exception is raised by the call, then is re-raised by
          *note _callmethod(): 232f.  If some other exception is raised
          in the manager’s process then this is converted into a
          ‘RemoteError’ exception and is raised by *note _callmethod():
          232f.

          Note in particular that an exception will be raised if
          `methodname' has not been `exposed'.

          An example of the usage of *note _callmethod(): 232f.:

               >>> l = manager.list(range(10)) >>> l._callmethod('__len__') 10 >>> l._callmethod('__getitem__', (slice(2, 7),)) # equivalent to l[2:7] [2, 3, 4, 5, 6] >>> l._callmethod('__getitem__', (20,))          # equivalent to l[20] Traceback (most recent call last): ... IndexError: list index out of range

      -- Method: _getvalue ()

          Return a copy of the referent.

          If the referent is unpicklable then this will raise an
          exception.

      -- Method: __repr__ ()

          Return a representation of the proxy object.

      -- Method: __str__ ()

          Return the representation of the referent.

* Menu:

* Cleanup::


File: python.info,  Node: Cleanup,  Up: Proxy Objects

5.17.2.20 Cleanup
.................

A proxy object uses a weakref callback so that when it gets garbage
collected it deregisters itself from the manager which owns its
referent.

A shared object gets deleted from the manager process when there are no
longer any proxies referring to it.


File: python.info,  Node: Process Pools,  Next: Listeners and Clients,  Prev: Proxy Objects,  Up: Reference

5.17.2.21 Process Pools
.......................

One can create a pool of processes which will carry out tasks submitted
to it with the *note Pool: 86f. class.

 -- Class: multiprocessing.pool.Pool ([processes[, initializer[,
          initargs[, maxtasksperchild[, context]]]]])

     A process pool object which controls a pool of worker processes to
     which jobs can be submitted.  It supports asynchronous results with
     timeouts and callbacks and has a parallel map implementation.

     `processes' is the number of worker processes to use.  If
     `processes' is ‘None’ then the number returned by *note
     os.cpu_count(): 873. is used.

     If `initializer' is not ‘None’ then each worker process will call
     ‘initializer(*initargs)’ when it starts.

     `maxtasksperchild' is the number of tasks a worker process can
     complete before it will exit and be replaced with a fresh worker
     process, to enable unused resources to be freed.  The default
     `maxtasksperchild' is ‘None’, which means worker processes will
     live as long as the pool.

     `context' can be used to specify the context used for starting the
     worker processes.  Usually a pool is created using the function
     ‘multiprocessing.Pool()’ or the *note Pool(): 86f. method of a
     context object.  In both cases `context' is set appropriately.

     Note that the methods of the pool object should only be called by
     the process which created the pool.

     New in version 3.2: `maxtasksperchild'

     New in version 3.4: `context'

          Note: Worker processes within a *note Pool: 86f. typically
          live for the complete duration of the Pool’s work queue.  A
          frequent pattern found in other systems (such as Apache,
          mod_wsgi, etc) to free resources held by workers is to allow a
          worker within a pool to complete only a set amount of work
          before being exiting, being cleaned up and a new process
          spawned to replace the old one.  The `maxtasksperchild'
          argument to the *note Pool: 86f. exposes this ability to the
          end user.

      -- Method: apply (func[, args[, kwds]])

          Call `func' with arguments `args' and keyword arguments
          `kwds'.  It blocks until the result is ready.  Given this
          blocks, *note apply_async(): 2346. is better suited for
          performing work in parallel.  Additionally, `func' is only
          executed in one of the workers of the pool.

      -- Method: apply_async (func[, args[, kwds[, callback[,
               error_callback]]]])

          A variant of the *note apply(): 2345. method which returns a
          result object.

          If `callback' is specified then it should be a callable which
          accepts a single argument.  When the result becomes ready
          `callback' is applied to it, that is unless the call failed,
          in which case the `error_callback' is applied instead.

          If `error_callback' is specified then it should be a callable
          which accepts a single argument.  If the target function
          fails, then the `error_callback' is called with the exception
          instance.

          Callbacks should complete immediately since otherwise the
          thread which handles the results will get blocked.

      -- Method: map (func, iterable[, chunksize])

          A parallel equivalent of the *note map(): c20. built-in
          function (it supports only one `iterable' argument though, for
          multiple iterables see *note starmap(): a1b.).  It blocks
          until the result is ready.

          This method chops the iterable into a number of chunks which
          it submits to the process pool as separate tasks.  The
          (approximate) size of these chunks can be specified by setting
          `chunksize' to a positive integer.

          Note that it may cause high memory usage for very long
          iterables.  Consider using *note imap(): 2347. or *note
          imap_unordered(): 2348. with explicit `chunksize' option for
          better efficiency.

      -- Method: map_async (func, iterable[, chunksize[, callback[,
               error_callback]]])

          A variant of the *note map(): a1e. method which returns a
          result object.

          If `callback' is specified then it should be a callable which
          accepts a single argument.  When the result becomes ready
          `callback' is applied to it, that is unless the call failed,
          in which case the `error_callback' is applied instead.

          If `error_callback' is specified then it should be a callable
          which accepts a single argument.  If the target function
          fails, then the `error_callback' is called with the exception
          instance.

          Callbacks should complete immediately since otherwise the
          thread which handles the results will get blocked.

      -- Method: imap (func, iterable[, chunksize])

          A lazier version of *note map(): a1e.

          The `chunksize' argument is the same as the one used by the
          *note map(): a1e. method.  For very long iterables using a
          large value for `chunksize' can make the job complete `much'
          faster than using the default value of ‘1’.

          Also if `chunksize' is ‘1’ then the ‘next()’ method of the
          iterator returned by the *note imap(): 2347. method has an
          optional `timeout' parameter: ‘next(timeout)’ will raise *note
          multiprocessing.TimeoutError: 22f0. if the result cannot be
          returned within `timeout' seconds.

      -- Method: imap_unordered (func, iterable[, chunksize])

          The same as *note imap(): 2347. except that the ordering of
          the results from the returned iterator should be considered
          arbitrary.  (Only when there is only one worker process is the
          order guaranteed to be “correct”.)

      -- Method: starmap (func, iterable[, chunksize])

          Like *note map(): c20. except that the elements of the
          `iterable' are expected to be iterables that are unpacked as
          arguments.

          Hence an `iterable' of ‘[(1,2), (3, 4)]’ results in
          ‘[func(1,2), func(3,4)]’.

          New in version 3.3.

      -- Method: starmap_async (func, iterable[, chunksize[, callback[,
               error_callback]]])

          A combination of *note starmap(): a1b. and *note map_async():
          a1f. that iterates over `iterable' of iterables and calls
          `func' with the iterables unpacked.  Returns a result object.

          New in version 3.3.

      -- Method: close ()

          Prevents any more tasks from being submitted to the pool.
          Once all the tasks have been completed the worker processes
          will exit.

      -- Method: terminate ()

          Stops the worker processes immediately without completing
          outstanding work.  When the pool object is garbage collected
          *note terminate(): 234a. will be called immediately.

      -- Method: join ()

          Wait for the worker processes to exit.  One must call *note
          close(): 2349. or *note terminate(): 234a. before using *note
          join(): 234b.

     New in version 3.3: Pool objects now support the context management
     protocol – see *note Context Manager Types: 13c4.  *note
     __enter__(): 1618. returns the pool object, and *note __exit__():
     161a. calls *note terminate(): 234a.

 -- Class: multiprocessing.pool.AsyncResult

     The class of the result returned by *note Pool.apply_async(): 2346.
     and *note Pool.map_async(): a1f.

      -- Method: get ([timeout])

          Return the result when it arrives.  If `timeout' is not ‘None’
          and the result does not arrive within `timeout' seconds then
          *note multiprocessing.TimeoutError: 22f0. is raised.  If the
          remote call raised an exception then that exception will be
          reraised by *note get(): 234d.

      -- Method: wait ([timeout])

          Wait until the result is available or until `timeout' seconds
          pass.

      -- Method: ready ()

          Return whether the call has completed.

      -- Method: successful ()

          Return whether the call completed without raising an
          exception.  Will raise *note AssertionError: f66. if the
          result is not ready.

          Changed in version 3.7: If the result is not ready, *note
          ValueError: 1f9. is raised instead of *note AssertionError:
          f66.

The following example demonstrates the use of a pool:

     from multiprocessing import Pool import time  def f(x):     return x*x  if __name__ == '__main__':     with Pool(processes=4) as pool:         # start 4 worker processes         result = pool.apply_async(f, (10,)) # evaluate "f(10)" asynchronously in a single process         print(result.get(timeout=1))        # prints "100" unless your computer is *very* slow          print(pool.map(f, range(10)))       # prints "[0, 1, 4,..., 81]"          it = pool.imap(f, range(10))         print(next(it))                     # prints "0"         print(next(it))                     # prints "1"         print(it.next(timeout=1))           # prints "4" unless your computer is *very* slow          result = pool.apply_async(time.sleep, (10,))         print(result.get(timeout=1))        # raises multiprocessing.TimeoutError


File: python.info,  Node: Listeners and Clients,  Next: Authentication keys,  Prev: Process Pools,  Up: Reference

5.17.2.22 Listeners and Clients
...............................

Usually message passing between processes is done using queues or by
using *note Connection: 22fe. objects returned by *note Pipe(): 22d4.

However, the *note multiprocessing.connection: b8. module allows some
extra flexibility.  It basically gives a high level message oriented API
for dealing with sockets or Windows named pipes.  It also has support
for `digest authentication' using the *note hmac: 8f. module, and for
polling multiple connections at the same time.

 -- Function: multiprocessing.connection.deliver_challenge (connection,
          authkey)

     Send a randomly generated message to the other end of the
     connection and wait for a reply.

     If the reply matches the digest of the message using `authkey' as
     the key then a welcome message is sent to the other end of the
     connection.  Otherwise *note AuthenticationError: 22ef. is raised.

 -- Function: multiprocessing.connection.answer_challenge (connection,
          authkey)

     Receive a message, calculate the digest of the message using
     `authkey' as the key, and then send the digest back.

     If a welcome message is not received, then *note
     AuthenticationError: 22ef. is raised.

 -- Function: multiprocessing.connection.Client (address[, family[,
          authkey]])

     Attempt to set up a connection to the listener which is using
     address `address', returning a *note Connection: 22fe.

     The type of the connection is determined by `family' argument, but
     this can generally be omitted since it can usually be inferred from
     the format of `address'.  (See *note Address Formats: 2355.)

     If `authkey' is given and not None, it should be a byte string and
     will be used as the secret key for an HMAC-based authentication
     challenge.  No authentication is done if `authkey' is None.  *note
     AuthenticationError: 22ef. is raised if authentication fails.  See
     *note Authentication keys: 22eb.

 -- Class: multiprocessing.connection.Listener ([address[, family[,
          backlog[, authkey]]]])

     A wrapper for a bound socket or Windows named pipe which is
     ‘listening’ for connections.

     `address' is the address to be used by the bound socket or named
     pipe of the listener object.

          Note: If an address of ‘0.0.0.0’ is used, the address will not
          be a connectable end point on Windows.  If you require a
          connectable end-point, you should use ‘127.0.0.1’.

     `family' is the type of socket (or named pipe) to use.  This can be
     one of the strings ‘'AF_INET'’ (for a TCP socket), ‘'AF_UNIX'’ (for
     a Unix domain socket) or ‘'AF_PIPE'’ (for a Windows named pipe).
     Of these only the first is guaranteed to be available.  If `family'
     is ‘None’ then the family is inferred from the format of `address'.
     If `address' is also ‘None’ then a default is chosen.  This default
     is the family which is assumed to be the fastest available.  See
     *note Address Formats: 2355.  Note that if `family' is ‘'AF_UNIX'’
     and address is ‘None’ then the socket will be created in a private
     temporary directory created using *note tempfile.mkstemp(): 1ba0.

     If the listener object uses a socket then `backlog' (1 by default)
     is passed to the *note listen(): 73f. method of the socket once it
     has been bound.

     If `authkey' is given and not None, it should be a byte string and
     will be used as the secret key for an HMAC-based authentication
     challenge.  No authentication is done if `authkey' is None.  *note
     AuthenticationError: 22ef. is raised if authentication fails.  See
     *note Authentication keys: 22eb.

      -- Method: accept ()

          Accept a connection on the bound socket or named pipe of the
          listener object and return a *note Connection: 22fe. object.
          If authentication is attempted and fails, then *note
          AuthenticationError: 22ef. is raised.

      -- Method: close ()

          Close the bound socket or named pipe of the listener object.
          This is called automatically when the listener is garbage
          collected.  However it is advisable to call it explicitly.

     Listener objects have the following read-only properties:

      -- Attribute: address

          The address which is being used by the Listener object.

      -- Attribute: last_accepted

          The address from which the last accepted connection came.  If
          this is unavailable then it is ‘None’.

     New in version 3.3: Listener objects now support the context
     management protocol – see *note Context Manager Types: 13c4.  *note
     __enter__(): 1618. returns the listener object, and *note
     __exit__(): 161a. calls *note close(): 2358.

 -- Function: multiprocessing.connection.wait (object_list,
          timeout=None)

     Wait till an object in `object_list' is ready.  Returns the list of
     those objects in `object_list' which are ready.  If `timeout' is a
     float then the call blocks for at most that many seconds.  If
     `timeout' is ‘None’ then it will block for an unlimited period.  A
     negative timeout is equivalent to a zero timeout.

     For both Unix and Windows, an object can appear in `object_list' if
     it is

        * a readable *note Connection: 22fe. object;

        * a connected and readable *note socket.socket: 668. object; or

        * the *note sentinel: a1a. attribute of a *note Process: 3a7.
          object.

     A connection or socket object is ready when there is data available
     to be read from it, or the other end has been closed.

     `Unix': ‘wait(object_list, timeout)’ almost equivalent
     ‘select.select(object_list, [], [], timeout)’.  The difference is
     that, if *note select.select(): 667. is interrupted by a signal, it
     can raise *note OSError: 1d1. with an error number of ‘EINTR’,
     whereas *note wait(): a19. will not.

     `Windows': An item in `object_list' must either be an integer
     handle which is waitable (according to the definition used by the
     documentation of the Win32 function ‘WaitForMultipleObjects()’) or
     it can be an object with a ‘fileno()’ method which returns a socket
     handle or pipe handle.  (Note that pipe handles and socket handles
     are `not' waitable handles.)

     New in version 3.3.

`Examples'

The following server code creates a listener which uses ‘'secret
password'’ as an authentication key.  It then waits for a connection and
sends some data to the client:

     from multiprocessing.connection import Listener from array import array  address = ('localhost', 6000)     # family is deduced to be 'AF_INET'  with Listener(address, authkey=b'secret password') as listener:     with listener.accept() as conn:         print('connection accepted from', listener.last_accepted)          conn.send([2.25, None, 'junk', float])          conn.send_bytes(b'hello')          conn.send_bytes(array('i', [42, 1729]))

The following code connects to the server and receives some data from
the server:

     from multiprocessing.connection import Client from array import array  address = ('localhost', 6000)  with Client(address, authkey=b'secret password') as conn:     print(conn.recv())                  # => [2.25, None, 'junk', float]      print(conn.recv_bytes())            # => 'hello'      arr = array('i', [0, 0, 0, 0, 0])     print(conn.recv_bytes_into(arr))    # => 8     print(arr)                          # => array('i', [42, 1729, 0, 0, 0])

The following code uses *note wait(): a19. to wait for messages from
multiple processes at once:

     import time, random from multiprocessing import Process, Pipe, current_process from multiprocessing.connection import wait  def foo(w):     for i in range(10):         w.send((i, current_process().name))     w.close()  if __name__ == '__main__':     readers = []      for i in range(4):         r, w = Pipe(duplex=False)         readers.append(r)         p = Process(target=foo, args=(w,))         p.start()         # We close the writable end of the pipe now to be sure that         # p is the only process which owns a handle for it.  This         # ensures that when p closes its handle for the writable end,         # wait() will promptly report the readable end as being ready.         w.close()      while readers:         for r in wait(readers):             try:                 msg = r.recv()             except EOFError:                 readers.remove(r)             else:                 print(msg)

* Menu:

* Address Formats::


File: python.info,  Node: Address Formats,  Up: Listeners and Clients

5.17.2.23 Address Formats
.........................

   * An ‘'AF_INET'’ address is a tuple of the form ‘(hostname, port)’
     where `hostname' is a string and `port' is an integer.

   * An ‘'AF_UNIX'’ address is a string representing a filename on the
     filesystem.

   * 
     An ‘'AF_PIPE'’ address is a string of the form

          ‘r'\.\pipe{PipeName}'’.  To use *note Client(): 2354. to
          connect to a named pipe on a remote computer called
          `ServerName' one should use an address of the form
          ‘r'\`ServerName'\pipe{PipeName}'’ instead.

Note that any string beginning with two backslashes is assumed by
default to be an ‘'AF_PIPE'’ address rather than an ‘'AF_UNIX'’ address.


File: python.info,  Node: Authentication keys,  Next: Logging<2>,  Prev: Listeners and Clients,  Up: Reference

5.17.2.24 Authentication keys
.............................

When one uses *note Connection.recv: 2311, the data received is
automatically unpickled.  Unfortunately unpickling data from an
untrusted source is a security risk.  Therefore *note Listener: 2356.
and *note Client(): 2354. use the *note hmac: 8f. module to provide
digest authentication.

An authentication key is a byte string which can be thought of as a
password: once a connection is established both ends will demand proof
that the other knows the authentication key.  (Demonstrating that both
ends are using the same key does `not' involve sending the key over the
connection.)

If authentication is requested but no authentication key is specified
then the return value of ‘current_process().authkey’ is used (see *note
Process: 3a7.).  This value will be automatically inherited by any *note
Process: 3a7. object that the current process creates.  This means that
(by default) all processes of a multi-process program will share a
single authentication key which can be used when setting up connections
between themselves.

Suitable authentication keys can also be generated by using *note
os.urandom(): 4c6.


File: python.info,  Node: Logging<2>,  Next: The multiprocessing dummy module,  Prev: Authentication keys,  Up: Reference

5.17.2.25 Logging
.................

Some support for logging is available.  Note, however, that the *note
logging: aa. package does not use process shared locks so it is possible
(depending on the handler type) for messages from different processes to
get mixed up.

 -- Function: multiprocessing.get_logger ()

     Returns the logger used by *note multiprocessing: b7.  If
     necessary, a new one will be created.

     When first created the logger has level ‘logging.NOTSET’ and no
     default handler.  Messages sent to this logger will not by default
     propagate to the root logger.

     Note that on Windows child processes will only inherit the level of
     the parent process’s logger – any other customization of the logger
     will not be inherited.

 -- Function: multiprocessing.log_to_stderr ()

     This function performs a call to *note get_logger(): 235e. but in
     addition to returning the logger created by get_logger, it adds a
     handler which sends output to *note sys.stderr: 304. using format
     ‘'[%(levelname)s/%(processName)s] %(message)s'’.

Below is an example session with logging turned on:

     >>> import multiprocessing, logging >>> logger = multiprocessing.log_to_stderr() >>> logger.setLevel(logging.INFO) >>> logger.warning('doomed') [WARNING/MainProcess] doomed >>> m = multiprocessing.Manager() [INFO/SyncManager-...] child process calling self.run() [INFO/SyncManager-...] created temp directory /.../pymp-... [INFO/SyncManager-...] manager serving at '/.../listener-...' >>> del m [INFO/MainProcess] sending shutdown message to manager [INFO/SyncManager-...] manager exiting with exitcode 0

For a full table of logging levels, see the *note logging: aa. module.


File: python.info,  Node: The multiprocessing dummy module,  Prev: Logging<2>,  Up: Reference

5.17.2.26 The ‘multiprocessing.dummy’ module
............................................

*note multiprocessing.dummy: b9. replicates the API of *note
multiprocessing: b7. but is no more than a wrapper around the *note
threading: 109. module.


File: python.info,  Node: Programming guidelines,  Next: Examples<10>,  Prev: Reference,  Up: multiprocessing — Process-based parallelism

5.17.2.27 Programming guidelines
................................

There are certain guidelines and idioms which should be adhered to when
using *note multiprocessing: b7.

* Menu:

* All start methods::
* The spawn and forkserver start methods::


File: python.info,  Node: All start methods,  Next: The spawn and forkserver start methods,  Up: Programming guidelines

5.17.2.28 All start methods
...........................

The following applies to all start methods.

Avoid shared state

     As far as possible one should try to avoid shifting large amounts
     of data between processes.

     It is probably best to stick to using queues or pipes for
     communication between processes rather than using the lower level
     synchronization primitives.

Picklability

     Ensure that the arguments to the methods of proxies are picklable.

Thread safety of proxies

     Do not use a proxy object from more than one thread unless you
     protect it with a lock.

     (There is never a problem with different processes using the `same'
     proxy.)

Joining zombie processes

     On Unix when a process finishes but has not been joined it becomes
     a zombie.  There should never be very many because each time a new
     process starts (or *note active_children(): 2309. is called) all
     completed processes which have not yet been joined will be joined.
     Also calling a finished process’s *note Process.is_alive: 22e8.
     will join the process.  Even so it is probably good practice to
     explicitly join all the processes that you start.

Better to inherit than pickle/unpickle

     When using the `spawn' or `forkserver' start methods many types
     from *note multiprocessing: b7. need to be picklable so that child
     processes can use them.  However, one should generally avoid
     sending shared objects to other processes using pipes or queues.
     Instead you should arrange the program so that a process which
     needs access to a shared resource created elsewhere can inherit it
     from an ancestor process.

Avoid terminating processes

     Using the *note Process.terminate: 22ec. method to stop a process
     is liable to cause any shared resources (such as locks, semaphores,
     pipes and queues) currently being used by the process to become
     broken or unavailable to other processes.

     Therefore it is probably best to only consider using *note
     Process.terminate: 22ec. on processes which never use any shared
     resources.

Joining processes that use queues

     Bear in mind that a process that has put items in a queue will wait
     before terminating until all the buffered items are fed by the
     “feeder” thread to the underlying pipe.  (The child process can
     call the *note Queue.cancel_join_thread: 22fc. method of the queue
     to avoid this behaviour.)

     This means that whenever you use a queue you need to make sure that
     all items which have been put on the queue will eventually be
     removed before the process is joined.  Otherwise you cannot be sure
     that processes which have put items on the queue will terminate.
     Remember also that non-daemonic processes will be joined
     automatically.

     An example which will deadlock is the following:

          from multiprocessing import Process, Queue  def f(q):     q.put('X' * 1000000)  if __name__ == '__main__':     queue = Queue()     p = Process(target=f, args=(queue,))     p.start()     p.join()                    # this deadlocks     obj = queue.get()

     A fix here would be to swap the last two lines (or simply remove
     the ‘p.join()’ line).

Explicitly pass resources to child processes

     On Unix using the `fork' start method, a child process can make use
     of a shared resource created in a parent process using a global
     resource.  However, it is better to pass the object as an argument
     to the constructor for the child process.

     Apart from making the code (potentially) compatible with Windows
     and the other start methods this also ensures that as long as the
     child process is still alive the object will not be garbage
     collected in the parent process.  This might be important if some
     resource is freed when the object is garbage collected in the
     parent process.

     So for instance

          from multiprocessing import Process, Lock  def f():     ... do something using "lock" ...  if __name__ == '__main__':     lock = Lock()     for i in range(10):         Process(target=f).start()

     should be rewritten as

          from multiprocessing import Process, Lock  def f(l):     ... do something using "l" ...  if __name__ == '__main__':     lock = Lock()     for i in range(10):         Process(target=f, args=(lock,)).start()

Beware of replacing *note sys.stdin: 302. with a “file like object”

     *note multiprocessing: b7. originally unconditionally called:

          os.close(sys.stdin.fileno())

     in the ‘multiprocessing.Process._bootstrap()’ method — this
     resulted in issues with processes-in-processes.  This has been
     changed to:

          sys.stdin.close() sys.stdin = open(os.open(os.devnull, os.O_RDONLY), closefd=False)

     Which solves the fundamental issue of processes colliding with each
     other resulting in a bad file descriptor error, but introduces a
     potential danger to applications which replace *note sys.stdin():
     302. with a “file-like object” with output buffering.  This danger
     is that if multiple processes call *note close(): f43. on this
     file-like object, it could result in the same data being flushed to
     the object multiple times, resulting in corruption.

     If you write a file-like object and implement your own caching, you
     can make it fork-safe by storing the pid whenever you append to the
     cache, and discarding the cache when the pid changes.  For example:

          @property def cache(self):     pid = os.getpid()     if pid != self._pid:         self._pid = pid         self._cache = []     return self._cache

     For more information, see bpo-5155(1), bpo-5313(2) and bpo-5331(3)

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue5155

   (2) https://bugs.python.org/issue5313

   (3) https://bugs.python.org/issue5331


File: python.info,  Node: The spawn and forkserver start methods,  Prev: All start methods,  Up: Programming guidelines

5.17.2.29 The `spawn' and `forkserver' start methods
....................................................

There are a few extra restriction which don’t apply to the `fork' start
method.

More picklability

     Ensure that all arguments to ‘Process.__init__()’ are picklable.
     Also, if you subclass *note Process: 3a7. then make sure that
     instances will be picklable when the *note Process.start: 22cd.
     method is called.

Global variables

     Bear in mind that if code run in a child process tries to access a
     global variable, then the value it sees (if any) may not be the
     same as the value in the parent process at the time that *note
     Process.start: 22cd. was called.

     However, global variables which are just module level constants
     cause no problems.

Safe importing of main module

     Make sure that the main module can be safely imported by a new
     Python interpreter without causing unintended side effects (such a
     starting a new process).

     For example, using the `spawn' or `forkserver' start method running
     the following module would fail with a *note RuntimeError: 2b8.:

          from multiprocessing import Process  def foo():     print('hello')  p = Process(target=foo) p.start()

     Instead one should protect the “entry point” of the program by
     using ‘if __name__ == '__main__':’ as follows:

          from multiprocessing import Process, freeze_support, set_start_method  def foo():     print('hello')  if __name__ == '__main__':     freeze_support()     set_start_method('spawn')     p = Process(target=foo)     p.start()

     (The ‘freeze_support()’ line can be omitted if the program will be
     run normally instead of frozen.)

     This allows the newly spawned Python interpreter to safely import
     the module and then run the module’s ‘foo()’ function.

     Similar restrictions apply if a pool or manager is created in the
     main module.


File: python.info,  Node: Examples<10>,  Prev: Programming guidelines,  Up: multiprocessing — Process-based parallelism

5.17.2.30 Examples
..................

Demonstration of how to create and use customized managers and proxies:

     from multiprocessing import freeze_support from multiprocessing.managers import BaseManager, BaseProxy import operator  ##  class Foo:     def f(self):         print('you called Foo.f()')     def g(self):         print('you called Foo.g()')     def _h(self):         print('you called Foo._h()')  # A simple generator function def baz():     for i in range(10):         yield i*i  # Proxy type for generator objects class GeneratorProxy(BaseProxy):     _exposed_ = ['__next__']     def __iter__(self):         return self     def __next__(self):         return self._callmethod('__next__')  # Function to return the operator module def get_operator_module():     return operator  ##  class MyManager(BaseManager):     pass  # register the Foo class; make `f()` and `g()` accessible via proxy MyManager.register('Foo1', Foo)  # register the Foo class; make `g()` and `_h()` accessible via proxy MyManager.register('Foo2', Foo, exposed=('g', '_h'))  # register the generator function baz; use `GeneratorProxy` to make proxies MyManager.register('baz', baz, proxytype=GeneratorProxy)  # register get_operator_module(); make public functions accessible via proxy MyManager.register('operator', get_operator_module)  ##  def test():     manager = MyManager()     manager.start()      print('-' * 20)      f1 = manager.Foo1()     f1.f()     f1.g()     assert not hasattr(f1, '_h')     assert sorted(f1._exposed_) == sorted(['f', 'g'])      print('-' * 20)      f2 = manager.Foo2()     f2.g()     f2._h()     assert not hasattr(f2, 'f')     assert sorted(f2._exposed_) == sorted(['g', '_h'])      print('-' * 20)      it = manager.baz()     for i in it:         print('<%d>' % i, end=' ')     print()      print('-' * 20)      op = manager.operator()     print('op.add(23, 45) =', op.add(23, 45))     print('op.pow(2, 94) =', op.pow(2, 94))     print('op._exposed_ =', op._exposed_)  ##  if __name__ == '__main__':     freeze_support()     test()

Using *note Pool: 86f.:

     import multiprocessing import time import random import sys  # # Functions used by test code #  def calculate(func, args):     result = func(*args)     return '%s says that %s%s = %s' % (         multiprocessing.current_process().name,         func.__name__, args, result         )  def calculatestar(args):     return calculate(*args)  def mul(a, b):     time.sleep(0.5 * random.random())     return a * b  def plus(a, b):     time.sleep(0.5 * random.random())     return a + b  def f(x):     return 1.0 / (x - 5.0)  def pow3(x):     return x ** 3  def noop(x):     pass  # # Test code #  def test():     PROCESSES = 4     print('Creating pool with %d processes\n' % PROCESSES)      with multiprocessing.Pool(PROCESSES) as pool:         #         # Tests         #          TASKS = [(mul, (i, 7)) for i in range(10)] + \                 [(plus, (i, 8)) for i in range(10)]          results = [pool.apply_async(calculate, t) for t in TASKS]         imap_it = pool.imap(calculatestar, TASKS)         imap_unordered_it = pool.imap_unordered(calculatestar, TASKS)          print('Ordered results using pool.apply_async():')         for r in results:             print('\t', r.get())         print()          print('Ordered results using pool.imap():')         for x in imap_it:             print('\t', x)         print()          print('Unordered results using pool.imap_unordered():')         for x in imap_unordered_it:             print('\t', x)         print()          print('Ordered results using pool.map() --- will block till complete:')         for x in pool.map(calculatestar, TASKS):             print('\t', x)         print()          #         # Test error handling         #          print('Testing error handling:')          try:             print(pool.apply(f, (5,)))         except ZeroDivisionError:             print('\tGot ZeroDivisionError as expected from pool.apply()')         else:             raise AssertionError('expected ZeroDivisionError')          try:             print(pool.map(f, list(range(10))))         except ZeroDivisionError:             print('\tGot ZeroDivisionError as expected from pool.map()')         else:             raise AssertionError('expected ZeroDivisionError')          try:             print(list(pool.imap(f, list(range(10)))))         except ZeroDivisionError:             print('\tGot ZeroDivisionError as expected from list(pool.imap())')         else:             raise AssertionError('expected ZeroDivisionError')          it = pool.imap(f, list(range(10)))         for i in range(10):             try:                 x = next(it)             except ZeroDivisionError:                 if i == 5:                     pass             except StopIteration:                 break             else:                 if i == 5:                     raise AssertionError('expected ZeroDivisionError')          assert i == 9         print('\tGot ZeroDivisionError as expected from IMapIterator.next()')         print()          #         # Testing timeouts         #          print('Testing ApplyResult.get() with timeout:', end=' ')         res = pool.apply_async(calculate, TASKS[0])         while 1:             sys.stdout.flush()             try:                 sys.stdout.write('\n\t%s' % res.get(0.02))                 break             except multiprocessing.TimeoutError:                 sys.stdout.write('.')         print()         print()          print('Testing IMapIterator.next() with timeout:', end=' ')         it = pool.imap(calculatestar, TASKS)         while 1:             sys.stdout.flush()             try:                 sys.stdout.write('\n\t%s' % it.next(0.02))             except StopIteration:                 break             except multiprocessing.TimeoutError:                 sys.stdout.write('.')         print()         print()   if __name__ == '__main__':     multiprocessing.freeze_support()     test()

An example showing how to use queues to feed tasks to a collection of
worker processes and collect the results:

     import time import random  from multiprocessing import Process, Queue, current_process, freeze_support  # # Function run by worker processes #  def worker(input, output):     for func, args in iter(input.get, 'STOP'):         result = calculate(func, args)         output.put(result)  # # Function used to calculate result #  def calculate(func, args):     result = func(*args)     return '%s says that %s%s = %s' % \         (current_process().name, func.__name__, args, result)  # # Functions referenced by tasks #  def mul(a, b):     time.sleep(0.5*random.random())     return a * b  def plus(a, b):     time.sleep(0.5*random.random())     return a + b  # # #  def test():     NUMBER_OF_PROCESSES = 4     TASKS1 = [(mul, (i, 7)) for i in range(20)]     TASKS2 = [(plus, (i, 8)) for i in range(10)]      # Create queues     task_queue = Queue()     done_queue = Queue()      # Submit tasks     for task in TASKS1:         task_queue.put(task)      # Start worker processes     for i in range(NUMBER_OF_PROCESSES):         Process(target=worker, args=(task_queue, done_queue)).start()      # Get and print results     print('Unordered results:')     for i in range(len(TASKS1)):         print('\t', done_queue.get())      # Add more tasks using `put()`     for task in TASKS2:         task_queue.put(task)      # Get and print some more results     for i in range(len(TASKS2)):         print('\t', done_queue.get())      # Tell child processes to stop     for i in range(NUMBER_OF_PROCESSES):         task_queue.put('STOP')   if __name__ == '__main__':     freeze_support()     test()


File: python.info,  Node: multiprocessing shared_memory — Provides shared memory for direct access across processes,  Next: The concurrent package,  Prev: multiprocessing — Process-based parallelism,  Up: Concurrent Execution

5.17.3 ‘multiprocessing.shared_memory’ — Provides shared memory for direct access across processes
--------------------------------------------------------------------------------------------------

`Source code:' Lib/multiprocessing/shared_memory.py(1)

New in version 3.8.

__________________________________________________________________

This module provides a class, *note SharedMemory: 22d1, for the
allocation and management of shared memory to be accessed by one or more
processes on a multicore or symmetric multiprocessor (SMP) machine.  To
assist with the life-cycle management of shared memory especially across
distinct processes, a *note BaseManager: 2327. subclass,
‘SharedMemoryManager’, is also provided in the
‘multiprocessing.managers’ module.

In this module, shared memory refers to “System V style” shared memory
blocks (though is not necessarily implemented explicitly as such) and
does not refer to “distributed shared memory”.  This style of shared
memory permits distinct processes to potentially read and write to a
common (or shared) region of volatile memory.  Processes are
conventionally limited to only have access to their own process memory
space but shared memory permits the sharing of data between processes,
avoiding the need to instead send messages between processes containing
that data.  Sharing data directly via memory can provide significant
performance benefits compared to sharing data via disk or socket or
other communications requiring the serialization/deserialization and
copying of data.

 -- Class: multiprocessing.shared_memory.SharedMemory (name=None,
          create=False, size=0)

     Creates a new shared memory block or attaches to an existing shared
     memory block.  Each shared memory block is assigned a unique name.
     In this way, one process can create a shared memory block with a
     particular name and a different process can attach to that same
     shared memory block using that same name.

     As a resource for sharing data across processes, shared memory
     blocks may outlive the original process that created them.  When
     one process no longer needs access to a shared memory block that
     might still be needed by other processes, the *note close(): 2367.
     method should be called.  When a shared memory block is no longer
     needed by any process, the *note unlink(): 2368. method should be
     called to ensure proper cleanup.

     `name' is the unique name for the requested shared memory,
     specified as a string.  When creating a new shared memory block, if
     ‘None’ (the default) is supplied for the name, a novel name will be
     generated.

     `create' controls whether a new shared memory block is created
     (‘True’) or an existing shared memory block is attached (‘False’).

     `size' specifies the requested number of bytes when creating a new
     shared memory block.  Because some platforms choose to allocate
     chunks of memory based upon that platform’s memory page size, the
     exact size of the shared memory block may be larger or equal to the
     size requested.  When attaching to an existing shared memory block,
     the ‘size’ parameter is ignored.

      -- Method: close ()

          Closes access to the shared memory from this instance.  In
          order to ensure proper cleanup of resources, all instances
          should call ‘close()’ once the instance is no longer needed.
          Note that calling ‘close()’ does not cause the shared memory
          block itself to be destroyed.

      -- Method: unlink ()

          Requests that the underlying shared memory block be destroyed.
          In order to ensure proper cleanup of resources, ‘unlink()’
          should be called once (and only once) across all processes
          which have need for the shared memory block.  After requesting
          its destruction, a shared memory block may or may not be
          immediately destroyed and this behavior may differ across
          platforms.  Attempts to access data inside the shared memory
          block after ‘unlink()’ has been called may result in memory
          access errors.  Note: the last process relinquishing its hold
          on a shared memory block may call ‘unlink()’ and *note
          close(): 2367. in either order.

      -- Attribute: buf

          A memoryview of contents of the shared memory block.

      -- Attribute: name

          Read-only access to the unique name of the shared memory
          block.

      -- Attribute: size

          Read-only access to size in bytes of the shared memory block.

The following example demonstrates low-level use of *note SharedMemory:
22d1. instances:

     >>> from multiprocessing import shared_memory >>> shm_a = shared_memory.SharedMemory(create=True, size=10) >>> type(shm_a.buf) <class 'memoryview'> >>> buffer = shm_a.buf >>> len(buffer) 10 >>> buffer[:4] = bytearray([22, 33, 44, 55])  # Modify multiple at once >>> buffer[4] = 100                           # Modify single byte at a time >>> # Attach to an existing shared memory block >>> shm_b = shared_memory.SharedMemory(shm_a.name) >>> import array >>> array.array('b', shm_b.buf[:5])  # Copy the data into a new array.array array('b', [22, 33, 44, 55, 100]) >>> shm_b.buf[:5] = b'howdy'  # Modify via shm_b using bytes >>> bytes(shm_a.buf[:5])      # Access via shm_a b'howdy' >>> shm_b.close()   # Close each SharedMemory instance >>> shm_a.close() >>> shm_a.unlink()  # Call unlink only once to release the shared memory

The following example demonstrates a practical use of the *note
SharedMemory: 22d1. class with NumPy arrays(2), accessing the same
‘numpy.ndarray’ from two distinct Python shells:

     >>> # In the first Python interactive shell >>> import numpy as np >>> a = np.array([1, 1, 2, 3, 5, 8])  # Start with an existing NumPy array >>> from multiprocessing import shared_memory >>> shm = shared_memory.SharedMemory(create=True, size=a.nbytes) >>> # Now create a NumPy array backed by shared memory >>> b = np.ndarray(a.shape, dtype=a.dtype, buffer=shm.buf) >>> b[:] = a[:]  # Copy the original data into shared memory >>> b array([1, 1, 2, 3, 5, 8]) >>> type(b) <class 'numpy.ndarray'> >>> type(a) <class 'numpy.ndarray'> >>> shm.name  # We did not specify a name so one was chosen for us 'psm_21467_46075'  >>> # In either the same shell or a new Python shell on the same machine >>> import numpy as np >>> from multiprocessing import shared_memory >>> # Attach to the existing shared memory block >>> existing_shm = shared_memory.SharedMemory(name='psm_21467_46075') >>> # Note that a.shape is (6,) and a.dtype is np.int64 in this example >>> c = np.ndarray((6,), dtype=np.int64, buffer=existing_shm.buf) >>> c array([1, 1, 2, 3, 5, 8]) >>> c[-1] = 888 >>> c array([  1,   1,   2,   3,   5, 888])  >>> # Back in the first Python interactive shell, b reflects this change >>> b array([  1,   1,   2,   3,   5, 888])  >>> # Clean up from within the second Python shell >>> del c  # Unnecessary; merely emphasizing the array is no longer used >>> existing_shm.close()  >>> # Clean up from within the first Python shell >>> del b  # Unnecessary; merely emphasizing the array is no longer used >>> shm.close() >>> shm.unlink()  # Free and release the shared memory block at the very end

 -- Class: multiprocessing.managers.SharedMemoryManager ([address[,
          authkey]])

     A subclass of *note BaseManager: 2327. which can be used for the
     management of shared memory blocks across processes.

     A call to *note start(): 2328. on a *note SharedMemoryManager:
     236c. instance causes a new process to be started.  This new
     process’s sole purpose is to manage the life cycle of all shared
     memory blocks created through it.  To trigger the release of all
     shared memory blocks managed by that process, call *note
     shutdown(): 232c. on the instance.  This triggers a
     ‘SharedMemory.unlink()’ call on all of the *note SharedMemory:
     236d. objects managed by that process and then stops the process
     itself.  By creating ‘SharedMemory’ instances through a
     ‘SharedMemoryManager’, we avoid the need to manually track and
     trigger the freeing of shared memory resources.

     This class provides methods for creating and returning *note
     SharedMemory: 236d. instances and for creating a list-like object
     (*note ShareableList: 236e.) backed by shared memory.

     Refer to *note multiprocessing.managers.BaseManager: 2327. for a
     description of the inherited `address' and `authkey' optional input
     arguments and how they may be used to connect to an existing
     ‘SharedMemoryManager’ service from other processes.

      -- Method: SharedMemory (size)

          Create and return a new *note SharedMemory: 236d. object with
          the specified ‘size’ in bytes.

      -- Method: ShareableList (sequence)

          Create and return a new *note ShareableList: 236e. object,
          initialized by the values from the input ‘sequence’.

The following example demonstrates the basic mechanisms of a
‘SharedMemoryManager’:

     >>> from multiprocessing.managers import SharedMemoryManager >>> smm = SharedMemoryManager() >>> smm.start()  # Start the process that manages the shared memory blocks >>> sl = smm.ShareableList(range(4)) >>> sl ShareableList([0, 1, 2, 3], name='psm_6572_7512') >>> raw_shm = smm.SharedMemory(size=128) >>> another_sl = smm.ShareableList('alpha') >>> another_sl ShareableList(['a', 'l', 'p', 'h', 'a'], name='psm_6572_12221') >>> smm.shutdown()  # Calls unlink() on sl, raw_shm, and another_sl

The following example depicts a potentially more convenient pattern for
using ‘SharedMemoryManager’ objects via the *note with: 6dd. statement
to ensure that all shared memory blocks are released after they are no
longer needed:

     >>> with SharedMemoryManager() as smm: ...     sl = smm.ShareableList(range(2000)) ...     # Divide the work among two processes, storing partial results in sl ...     p1 = Process(target=do_work, args=(sl, 0, 1000)) ...     p2 = Process(target=do_work, args=(sl, 1000, 2000)) ...     p1.start() ...     p2.start()  # A multiprocessing.Pool might be more efficient ...     p1.join() ...     p2.join()   # Wait for all work to complete in both processes ...     total_result = sum(sl)  # Consolidate the partial results now in sl

When using a ‘SharedMemoryManager’ in a *note with: 6dd. statement, the
shared memory blocks created using that manager are all released when
the *note with: 6dd. statement’s code block finishes execution.

 -- Class: multiprocessing.shared_memory.ShareableList (sequence=None,
          *, name=None)

     Provides a mutable list-like object where all values stored within
     are stored in a shared memory block.  This constrains storable
     values to only the ‘int’, ‘float’, ‘bool’, ‘str’ (less than 10M
     bytes each), ‘bytes’ (less than 10M bytes each), and ‘None’
     built-in data types.  It also notably differs from the built-in
     ‘list’ type in that these lists can not change their overall length
     (i.e.  no append, insert, etc.)  and do not support the dynamic
     creation of new *note ShareableList: 236f. instances via slicing.

     `sequence' is used in populating a new ‘ShareableList’ full of
     values.  Set to ‘None’ to instead attach to an already existing
     ‘ShareableList’ by its unique shared memory name.

     `name' is the unique name for the requested shared memory, as
     described in the definition for *note SharedMemory: 22d1.  When
     attaching to an existing ‘ShareableList’, specify its shared memory
     block’s unique name while leaving ‘sequence’ set to ‘None’.

      -- Method: count (value)

          Returns the number of occurrences of ‘value’.

      -- Method: index (value)

          Returns first index position of ‘value’.  Raises *note
          ValueError: 1f9. if ‘value’ is not present.

      -- Attribute: format

          Read-only attribute containing the *note struct: f8. packing
          format used by all currently stored values.

      -- Attribute: shm

          The *note SharedMemory: 22d1. instance where the values are
          stored.

The following example demonstrates basic use of a *note ShareableList:
236f. instance:

     >>> from multiprocessing import shared_memory >>> a = shared_memory.ShareableList(['howdy', b'HoWdY', -273.154, 100, None, True, 42]) >>> [ type(entry) for entry in a ] [<class 'str'>, <class 'bytes'>, <class 'float'>, <class 'int'>, <class 'NoneType'>, <class 'bool'>, <class 'int'>] >>> a[2] -273.154 >>> a[2] = -78.5 >>> a[2] -78.5 >>> a[2] = 'dry ice'  # Changing data types is supported as well >>> a[2] 'dry ice' >>> a[2] = 'larger than previously allocated storage space' Traceback (most recent call last):   ... ValueError: exceeds available storage for existing str >>> a[2] 'dry ice' >>> len(a) 7 >>> a.index(42) 6 >>> a.count(b'howdy') 0 >>> a.count(b'HoWdY') 1 >>> a.shm.close() >>> a.shm.unlink() >>> del a  # Use of a ShareableList after call to unlink() is unsupported

The following example depicts how one, two, or many processes may access
the same *note ShareableList: 236f. by supplying the name of the shared
memory block behind it:

     >>> b = shared_memory.ShareableList(range(5))         # In a first process >>> c = shared_memory.ShareableList(name=b.shm.name)  # In a second process >>> c ShareableList([0, 1, 2, 3, 4], name='...') >>> c[-1] = -999 >>> b[-1] -999 >>> b.shm.close() >>> c.shm.close() >>> c.shm.unlink()

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/multiprocessing/shared_memory.py

   (2) https://www.numpy.org/


File: python.info,  Node: The concurrent package,  Next: concurrent futures — Launching parallel tasks,  Prev: multiprocessing shared_memory — Provides shared memory for direct access across processes,  Up: Concurrent Execution

5.17.4 The ‘concurrent’ package
-------------------------------

Currently, there is only one module in this package:

   * *note concurrent.futures: 22. – Launching parallel tasks


File: python.info,  Node: concurrent futures — Launching parallel tasks,  Next: subprocess — Subprocess management,  Prev: The concurrent package,  Up: Concurrent Execution

5.17.5 ‘concurrent.futures’ — Launching parallel tasks
------------------------------------------------------

New in version 3.2.

`Source code:' Lib/concurrent/futures/thread.py(1) and
Lib/concurrent/futures/process.py(2)

__________________________________________________________________

The *note concurrent.futures: 22. module provides a high-level interface
for asynchronously executing callables.

The asynchronous execution can be performed with threads, using *note
ThreadPoolExecutor: 278, or separate processes, using *note
ProcessPoolExecutor: 2a2.  Both implement the same interface, which is
defined by the abstract *note Executor: 2378. class.

* Menu:

* Executor Objects::
* ThreadPoolExecutor::
* ProcessPoolExecutor::
* Future Objects::
* Module Functions::
* Exception classes::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/concurrent/futures/thread.py

   (2) 
https://github.com/python/cpython/tree/3.8/Lib/concurrent/futures/process.py


File: python.info,  Node: Executor Objects,  Next: ThreadPoolExecutor,  Up: concurrent futures — Launching parallel tasks

5.17.5.1 Executor Objects
.........................

 -- Class: concurrent.futures.Executor

     An abstract class that provides methods to execute calls
     asynchronously.  It should not be used directly, but through its
     concrete subclasses.

           -- Method: submit (fn, *args, **kwargs)

               Schedules the callable, `fn', to be executed as ‘fn(*args
               **kwargs)’ and returns a *note Future: b20. object
               representing the execution of the callable.

                    with ThreadPoolExecutor(max_workers=1) as executor:     future = executor.submit(pow, 323, 1235)     print(future.result())

           -- Method: map (func, *iterables, timeout=None, chunksize=1)

               Similar to *note map(func, *iterables): c20. except:

                  * the `iterables' are collected immediately rather
                    than lazily;

                  * `func' is executed asynchronously and several calls
                    to `func' may be made concurrently.

               The returned iterator raises a *note
               concurrent.futures.TimeoutError: 237a. if *note
               __next__(): c57. is called and the result isn’t available
               after `timeout' seconds from the original call to *note
               Executor.map(): 6b2.  `timeout' can be an int or a float.
               If `timeout' is not specified or ‘None’, there is no
               limit to the wait time.

               If a `func' call raises an exception, then that exception
               will be raised when its value is retrieved from the
               iterator.

               When using *note ProcessPoolExecutor: 2a2, this method
               chops `iterables' into a number of chunks which it
               submits to the pool as separate tasks.  The (approximate)
               size of these chunks can be specified by setting
               `chunksize' to a positive integer.  For very long
               iterables, using a large value for `chunksize' can
               significantly improve performance compared to the default
               size of 1.  With *note ThreadPoolExecutor: 278,
               `chunksize' has no effect.

               Changed in version 3.5: Added the `chunksize' argument.

           -- Method: shutdown (wait=True)

               Signal the executor that it should free any resources
               that it is using when the currently pending futures are
               done executing.  Calls to *note Executor.submit(): 2a1.
               and *note Executor.map(): 6b2. made after shutdown will
               raise *note RuntimeError: 2b8.

               If `wait' is ‘True’ then this method will not return
               until all the pending futures are done executing and the
               resources associated with the executor have been freed.
               If `wait' is ‘False’ then this method will return
               immediately and the resources associated with the
               executor will be freed when all pending futures are done
               executing.  Regardless of the value of `wait', the entire
               Python program will not exit until all pending futures
               are done executing.

               You can avoid having to call this method explicitly if
               you use the *note with: 6dd. statement, which will
               shutdown the *note Executor: 2378. (waiting as if *note
               Executor.shutdown(): b21. were called with `wait' set to
               ‘True’):

                    import shutil with ThreadPoolExecutor(max_workers=4) as e:     e.submit(shutil.copy, 'src1.txt', 'dest1.txt')     e.submit(shutil.copy, 'src2.txt', 'dest2.txt')     e.submit(shutil.copy, 'src3.txt', 'dest3.txt')     e.submit(shutil.copy, 'src4.txt', 'dest4.txt')


File: python.info,  Node: ThreadPoolExecutor,  Next: ProcessPoolExecutor,  Prev: Executor Objects,  Up: concurrent futures — Launching parallel tasks

5.17.5.2 ThreadPoolExecutor
...........................

*note ThreadPoolExecutor: 278. is an *note Executor: 2378. subclass that
uses a pool of threads to execute calls asynchronously.

Deadlocks can occur when the callable associated with a *note Future:
b20. waits on the results of another *note Future: b20.  For example:

     import time def wait_on_b():     time.sleep(5)     print(b.result())  # b will never complete because it is waiting on a.     return 5  def wait_on_a():     time.sleep(5)     print(a.result())  # a will never complete because it is waiting on b.     return 6   executor = ThreadPoolExecutor(max_workers=2) a = executor.submit(wait_on_b) b = executor.submit(wait_on_a)

And:

     def wait_on_future():     f = executor.submit(pow, 5, 2)     # This will never complete because there is only one worker thread and     # it is executing this function.     print(f.result())  executor = ThreadPoolExecutor(max_workers=1) executor.submit(wait_on_future)

 -- Class: concurrent.futures.ThreadPoolExecutor (max_workers=None,
          thread_name_prefix='', initializer=None, initargs=())

     An *note Executor: 2378. subclass that uses a pool of at most
     `max_workers' threads to execute calls asynchronously.

     `initializer' is an optional callable that is called at the start
     of each worker thread; `initargs' is a tuple of arguments passed to
     the initializer.  Should `initializer' raise an exception, all
     currently pending jobs will raise a *note BrokenThreadPool: 237c,
     as well as any attempt to submit more jobs to the pool.

     Changed in version 3.5: If `max_workers' is ‘None’ or not given, it
     will default to the number of processors on the machine, multiplied
     by ‘5’, assuming that *note ThreadPoolExecutor: 278. is often used
     to overlap I/O instead of CPU work and the number of workers should
     be higher than the number of workers for *note ProcessPoolExecutor:
     2a2.

     New in version 3.6: The `thread_name_prefix' argument was added to
     allow users to control the *note threading.Thread: 233. names for
     worker threads created by the pool for easier debugging.

     Changed in version 3.7: Added the `initializer' and `initargs'
     arguments.

     Changed in version 3.8: Default value of `max_workers' is changed
     to ‘min(32, os.cpu_count() + 4)’.  This default value preserves at
     least 5 workers for I/O bound tasks.  It utilizes at most 32 CPU
     cores for CPU bound tasks which release the GIL. And it avoids
     using very large resources implicitly on many-core machines.

     ThreadPoolExecutor now reuses idle worker threads before starting
     `max_workers' worker threads too.

* Menu:

* ThreadPoolExecutor Example::


File: python.info,  Node: ThreadPoolExecutor Example,  Up: ThreadPoolExecutor

5.17.5.3 ThreadPoolExecutor Example
...................................

     import concurrent.futures import urllib.request  URLS = ['http://www.foxnews.com/',         'http://www.cnn.com/',         'http://europe.wsj.com/',         'http://www.bbc.co.uk/',         'http://some-made-up-domain.com/']  # Retrieve a single page and report the URL and contents def load_url(url, timeout):     with urllib.request.urlopen(url, timeout=timeout) as conn:         return conn.read()  # We can use a with statement to ensure threads are cleaned up promptly with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor:     # Start the load operations and mark each future with its URL     future_to_url = {executor.submit(load_url, url, 60): url for url in URLS}     for future in concurrent.futures.as_completed(future_to_url):         url = future_to_url[future]         try:             data = future.result()         except Exception as exc:             print('%r generated an exception: %s' % (url, exc))         else:             print('%r page is %d bytes' % (url, len(data)))


File: python.info,  Node: ProcessPoolExecutor,  Next: Future Objects,  Prev: ThreadPoolExecutor,  Up: concurrent futures — Launching parallel tasks

5.17.5.4 ProcessPoolExecutor
............................

The *note ProcessPoolExecutor: 2a2. class is an *note Executor: 2378.
subclass that uses a pool of processes to execute calls asynchronously.
*note ProcessPoolExecutor: 2a2. uses the *note multiprocessing: b7.
module, which allows it to side-step the *note Global Interpreter Lock:
4fb. but also means that only picklable objects can be executed and
returned.

The ‘__main__’ module must be importable by worker subprocesses.  This
means that *note ProcessPoolExecutor: 2a2. will not work in the
interactive interpreter.

Calling *note Executor: 2378. or *note Future: b20. methods from a
callable submitted to a *note ProcessPoolExecutor: 2a2. will result in
deadlock.

 -- Class: concurrent.futures.ProcessPoolExecutor (max_workers=None,
          mp_context=None, initializer=None, initargs=())

     An *note Executor: 2378. subclass that executes calls
     asynchronously using a pool of at most `max_workers' processes.  If
     `max_workers' is ‘None’ or not given, it will default to the number
     of processors on the machine.  If `max_workers' is lower or equal
     to ‘0’, then a *note ValueError: 1f9. will be raised.  On Windows,
     `max_workers' must be equal or lower than ‘61’.  If it is not then
     *note ValueError: 1f9. will be raised.  If `max_workers' is ‘None’,
     then the default chosen will be at most ‘61’, even if more
     processors are available.  `mp_context' can be a multiprocessing
     context or None.  It will be used to launch the workers.  If
     `mp_context' is ‘None’ or not given, the default multiprocessing
     context is used.

     `initializer' is an optional callable that is called at the start
     of each worker process; `initargs' is a tuple of arguments passed
     to the initializer.  Should `initializer' raise an exception, all
     currently pending jobs will raise a *note BrokenProcessPool: 237f,
     as well any attempt to submit more jobs to the pool.

     Changed in version 3.3: When one of the worker processes terminates
     abruptly, a ‘BrokenProcessPool’ error is now raised.  Previously,
     behaviour was undefined but operations on the executor or its
     futures would often freeze or deadlock.

     Changed in version 3.7: The `mp_context' argument was added to
     allow users to control the start_method for worker processes
     created by the pool.

     Added the `initializer' and `initargs' arguments.

* Menu:

* ProcessPoolExecutor Example::


File: python.info,  Node: ProcessPoolExecutor Example,  Up: ProcessPoolExecutor

5.17.5.5 ProcessPoolExecutor Example
....................................

     import concurrent.futures import math  PRIMES = [     112272535095293,     112582705942171,     112272535095293,     115280095190773,     115797848077099,     1099726899285419]  def is_prime(n):     if n < 2:         return False     if n == 2:         return True     if n % 2 == 0:         return False      sqrt_n = int(math.floor(math.sqrt(n)))     for i in range(3, sqrt_n + 1, 2):         if n % i == 0:             return False     return True  def main():     with concurrent.futures.ProcessPoolExecutor() as executor:         for number, prime in zip(PRIMES, executor.map(is_prime, PRIMES)):             print('%d is prime: %s' % (number, prime))  if __name__ == '__main__':     main()


File: python.info,  Node: Future Objects,  Next: Module Functions,  Prev: ProcessPoolExecutor,  Up: concurrent futures — Launching parallel tasks

5.17.5.6 Future Objects
.......................

The *note Future: b20. class encapsulates the asynchronous execution of
a callable.  *note Future: b20. instances are created by *note
Executor.submit(): 2a1.

 -- Class: concurrent.futures.Future

     Encapsulates the asynchronous execution of a callable.  *note
     Future: b20. instances are created by *note Executor.submit(): 2a1.
     and should not be created directly except for testing.

           -- Method: cancel ()

               Attempt to cancel the call.  If the call is currently
               being executed or finished running and cannot be
               cancelled then the method will return ‘False’, otherwise
               the call will be cancelled and the method will return
               ‘True’.

           -- Method: cancelled ()

               Return ‘True’ if the call was successfully cancelled.

           -- Method: running ()

               Return ‘True’ if the call is currently being executed and
               cannot be cancelled.

           -- Method: done ()

               Return ‘True’ if the call was successfully cancelled or
               finished running.

           -- Method: result (timeout=None)

               Return the value returned by the call.  If the call
               hasn’t yet completed then this method will wait up to
               `timeout' seconds.  If the call hasn’t completed in
               `timeout' seconds, then a *note
               concurrent.futures.TimeoutError: 237a. will be raised.
               `timeout' can be an int or float.  If `timeout' is not
               specified or ‘None’, there is no limit to the wait time.

               If the future is cancelled before completing then *note
               CancelledError: 2387. will be raised.

               If the call raised, this method will raise the same
               exception.

           -- Method: exception (timeout=None)

               Return the exception raised by the call.  If the call
               hasn’t yet completed then this method will wait up to
               `timeout' seconds.  If the call hasn’t completed in
               `timeout' seconds, then a *note
               concurrent.futures.TimeoutError: 237a. will be raised.
               `timeout' can be an int or float.  If `timeout' is not
               specified or ‘None’, there is no limit to the wait time.

               If the future is cancelled before completing then *note
               CancelledError: 2387. will be raised.

               If the call completed without raising, ‘None’ is
               returned.

           -- Method: add_done_callback (fn)

               Attaches the callable `fn' to the future.  `fn' will be
               called, with the future as its only argument, when the
               future is cancelled or finishes running.

               Added callables are called in the order that they were
               added and are always called in a thread belonging to the
               process that added them.  If the callable raises an *note
               Exception: 1a8. subclass, it will be logged and ignored.
               If the callable raises a *note BaseException: 1a7.
               subclass, the behavior is undefined.

               If the future has already completed or been cancelled,
               `fn' will be called immediately.

     The following *note Future: b20. methods are meant for use in unit
     tests and *note Executor: 2378. implementations.

           -- Method: set_running_or_notify_cancel ()

               This method should only be called by *note Executor:
               2378. implementations before executing the work
               associated with the *note Future: b20. and by unit tests.

               If the method returns ‘False’ then the *note Future: b20.
               was cancelled, i.e.  *note Future.cancel(): 2382. was
               called and returned ‘True’.  Any threads waiting on the
               *note Future: b20. completing (i.e.  through *note
               as_completed(): 1027. or *note wait(): 238b.) will be
               woken up.

               If the method returns ‘True’ then the *note Future: b20.
               was not cancelled and has been put in the running state,
               i.e.  calls to *note Future.running(): 2384. will return
               ‘True’.

               This method can only be called once and cannot be called
               after *note Future.set_result(): 238c. or *note
               Future.set_exception(): 238d. have been called.

           -- Method: set_result (result)

               Sets the result of the work associated with the *note
               Future: b20. to `result'.

               This method should only be used by *note Executor: 2378.
               implementations and unit tests.

               Changed in version 3.8: This method raises *note
               concurrent.futures.InvalidStateError: 238e. if the *note
               Future: b20. is already done.

           -- Method: set_exception (exception)

               Sets the result of the work associated with the *note
               Future: b20. to the *note Exception: 1a8. `exception'.

               This method should only be used by *note Executor: 2378.
               implementations and unit tests.

               Changed in version 3.8: This method raises *note
               concurrent.futures.InvalidStateError: 238e. if the *note
               Future: b20. is already done.


File: python.info,  Node: Module Functions,  Next: Exception classes,  Prev: Future Objects,  Up: concurrent futures — Launching parallel tasks

5.17.5.7 Module Functions
.........................

 -- Function: concurrent.futures.wait (fs, timeout=None,
          return_when=ALL_COMPLETED)

     Wait for the *note Future: b20. instances (possibly created by
     different *note Executor: 2378. instances) given by `fs' to
     complete.  Returns a named 2-tuple of sets.  The first set, named
     ‘done’, contains the futures that completed (finished or cancelled
     futures) before the wait completed.  The second set, named
     ‘not_done’, contains the futures that did not complete (pending or
     running futures).

     `timeout' can be used to control the maximum number of seconds to
     wait before returning.  `timeout' can be an int or float.  If
     `timeout' is not specified or ‘None’, there is no limit to the wait
     time.

     `return_when' indicates when this function should return.  It must
     be one of the following constants:

     Constant                          Description
                                       
     -------------------------------------------------------------------------------
                                       
     ‘FIRST_COMPLETED’                 The function will return when any future
                                       finishes or is cancelled.
                                       
                                       
     ‘FIRST_EXCEPTION’                 The function will return when any future
                                       finishes by raising an exception.  If no
                                       future raises an exception then it is
                                       equivalent to ‘ALL_COMPLETED’.
                                       
                                       
     ‘ALL_COMPLETED’                   The function will return when all futures
                                       finish or are cancelled.
                                       

 -- Function: concurrent.futures.as_completed (fs, timeout=None)

     Returns an iterator over the *note Future: b20. instances (possibly
     created by different *note Executor: 2378. instances) given by `fs'
     that yields futures as they complete (finished or cancelled
     futures).  Any futures given by `fs' that are duplicated will be
     returned once.  Any futures that completed before *note
     as_completed(): 1027. is called will be yielded first.  The
     returned iterator raises a *note concurrent.futures.TimeoutError:
     237a. if *note __next__(): c57. is called and the result isn’t
     available after `timeout' seconds from the original call to *note
     as_completed(): 1027.  `timeout' can be an int or float.  If
     `timeout' is not specified or ‘None’, there is no limit to the wait
     time.

See also
........

PEP 3148(1) – futures - execute computations asynchronously

     The proposal which described this feature for inclusion in the
     Python standard library.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3148


File: python.info,  Node: Exception classes,  Prev: Module Functions,  Up: concurrent futures — Launching parallel tasks

5.17.5.8 Exception classes
..........................

 -- Exception: concurrent.futures.CancelledError

     Raised when a future is cancelled.

 -- Exception: concurrent.futures.TimeoutError

     Raised when a future operation exceeds the given timeout.

 -- Exception: concurrent.futures.BrokenExecutor

     Derived from *note RuntimeError: 2b8, this exception class is
     raised when an executor is broken for some reason, and cannot be
     used to submit or execute new tasks.

     New in version 3.7.

 -- Exception: concurrent.futures.InvalidStateError

     Raised when an operation is performed on a future that is not
     allowed in the current state.

     New in version 3.8.

 -- Exception: concurrent.futures.thread.BrokenThreadPool

     Derived from *note BrokenExecutor: 2391, this exception class is
     raised when one of the workers of a ‘ThreadPoolExecutor’ has failed
     initializing.

     New in version 3.7.

 -- Exception: concurrent.futures.process.BrokenProcessPool

     Derived from *note BrokenExecutor: 2391. (formerly *note
     RuntimeError: 2b8.), this exception class is raised when one of the
     workers of a ‘ProcessPoolExecutor’ has terminated in a non-clean
     fashion (for example, if it was killed from the outside).

     New in version 3.3.


File: python.info,  Node: subprocess — Subprocess management,  Next: sched — Event scheduler,  Prev: concurrent futures — Launching parallel tasks,  Up: Concurrent Execution

5.17.6 ‘subprocess’ — Subprocess management
-------------------------------------------

`Source code:' Lib/subprocess.py(1)

__________________________________________________________________

The *note subprocess: f9. module allows you to spawn new processes,
connect to their input/output/error pipes, and obtain their return
codes.  This module intends to replace several older modules and
functions:

     os.system os.spawn*

Information about how the *note subprocess: f9. module can be used to
replace these modules and functions can be found in the following
sections.

See also
........

PEP 324(2) – PEP proposing the subprocess module

* Menu:

* Using the subprocess Module::
* Security Considerations::
* Popen Objects::
* Windows Popen Helpers::
* Older high-level API::
* Replacing Older Functions with the subprocess Module::
* Legacy Shell Invocation Functions::
* Notes::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/subprocess.py

   (2) https://www.python.org/dev/peps/pep-0324


File: python.info,  Node: Using the subprocess Module,  Next: Security Considerations,  Up: subprocess — Subprocess management

5.17.6.1 Using the ‘subprocess’ Module
......................................

The recommended approach to invoking subprocesses is to use the *note
run(): 3e2. function for all use cases it can handle.  For more advanced
use cases, the underlying *note Popen: 2b7. interface can be used
directly.

The *note run(): 3e2. function was added in Python 3.5; if you need to
retain compatibility with older versions, see the *note Older high-level
API: 2395. section.

 -- Function: subprocess.run (args, *, stdin=None, input=None,
          stdout=None, stderr=None, capture_output=False, shell=False,
          cwd=None, timeout=None, check=False, encoding=None,
          errors=None, text=None, env=None, universal_newlines=None)

     Run the command described by `args'.  Wait for command to complete,
     then return a *note CompletedProcess: 754. instance.

     The arguments shown above are merely the most common ones,
     described below in *note Frequently Used Arguments: 2396. (hence
     the use of keyword-only notation in the abbreviated signature).
     The full function signature is largely the same as that of the
     *note Popen: 2b7. constructor - most of the arguments to this
     function are passed through to that interface.  (`timeout',
     `input', `check', and `capture_output' are not.)

     If `capture_output' is true, stdout and stderr will be captured.
     When used, the internal *note Popen: 2b7. object is automatically
     created with ‘stdout=PIPE’ and ‘stderr=PIPE’.  The `stdout' and
     `stderr' arguments may not be supplied at the same time as
     `capture_output'.  If you wish to capture and combine both streams
     into one, use ‘stdout=PIPE’ and ‘stderr=STDOUT’ instead of
     `capture_output'.

     The `timeout' argument is passed to *note Popen.communicate():
     2397.  If the timeout expires, the child process will be killed and
     waited for.  The *note TimeoutExpired: 2398. exception will be
     re-raised after the child process has terminated.

     The `input' argument is passed to *note Popen.communicate(): 2397.
     and thus to the subprocess’s stdin.  If used it must be a byte
     sequence, or a string if `encoding' or `errors' is specified or
     `text' is true.  When used, the internal *note Popen: 2b7. object
     is automatically created with ‘stdin=PIPE’, and the `stdin'
     argument may not be used as well.

     If `check' is true, and the process exits with a non-zero exit
     code, a *note CalledProcessError: ca8. exception will be raised.
     Attributes of that exception hold the arguments, the exit code, and
     stdout and stderr if they were captured.

     If `encoding' or `errors' are specified, or `text' is true, file
     objects for stdin, stdout and stderr are opened in text mode using
     the specified `encoding' and `errors' or the *note
     io.TextIOWrapper: 5e8. default.  The `universal_newlines' argument
     is equivalent to `text' and is provided for backwards
     compatibility.  By default, file objects are opened in binary mode.

     If `env' is not ‘None’, it must be a mapping that defines the
     environment variables for the new process; these are used instead
     of the default behavior of inheriting the current process’
     environment.  It is passed directly to *note Popen: 2b7.

     Examples:

          >>> subprocess.run(["ls", "-l"])  # doesn't capture output CompletedProcess(args=['ls', '-l'], returncode=0)  >>> subprocess.run("exit 1", shell=True, check=True) Traceback (most recent call last):   ... subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1  >>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True) CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0, stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'')

     New in version 3.5.

     Changed in version 3.6: Added `encoding' and `errors' parameters

     Changed in version 3.7: Added the `text' parameter, as a more
     understandable alias of `universal_newlines'.  Added the
     `capture_output' parameter.

 -- Class: subprocess.CompletedProcess

     The return value from *note run(): 3e2, representing a process that
     has finished.

      -- Attribute: args

          The arguments used to launch the process.  This may be a list
          or a string.

      -- Attribute: returncode

          Exit status of the child process.  Typically, an exit status
          of 0 indicates that it ran successfully.

          A negative value ‘-N’ indicates that the child was terminated
          by signal ‘N’ (POSIX only).

      -- Attribute: stdout

          Captured stdout from the child process.  A bytes sequence, or
          a string if *note run(): 3e2. was called with an encoding,
          errors, or text=True.  ‘None’ if stdout was not captured.

          If you ran the process with ‘stderr=subprocess.STDOUT’, stdout
          and stderr will be combined in this attribute, and *note
          stderr: 239c. will be ‘None’.

      -- Attribute: stderr

          Captured stderr from the child process.  A bytes sequence, or
          a string if *note run(): 3e2. was called with an encoding,
          errors, or text=True.  ‘None’ if stderr was not captured.

      -- Method: check_returncode ()

          If *note returncode: 239a. is non-zero, raise a *note
          CalledProcessError: ca8.

     New in version 3.5.

 -- Data: subprocess.DEVNULL

     Special value that can be used as the `stdin', `stdout' or `stderr'
     argument to *note Popen: 2b7. and indicates that the special file
     *note os.devnull: f52. will be used.

     New in version 3.3.

 -- Data: subprocess.PIPE

     Special value that can be used as the `stdin', `stdout' or `stderr'
     argument to *note Popen: 2b7. and indicates that a pipe to the
     standard stream should be opened.  Most useful with *note
     Popen.communicate(): 2397.

 -- Data: subprocess.STDOUT

     Special value that can be used as the `stderr' argument to *note
     Popen: 2b7. and indicates that standard error should go into the
     same handle as standard output.

 -- Exception: subprocess.SubprocessError

     Base class for all other exceptions from this module.

     New in version 3.3.

 -- Exception: subprocess.TimeoutExpired

     Subclass of *note SubprocessError: 239f, raised when a timeout
     expires while waiting for a child process.

      -- Attribute: cmd

          Command that was used to spawn the child process.

      -- Attribute: timeout

          Timeout in seconds.

      -- Attribute: output

          Output of the child process if it was captured by *note run():
          3e2. or *note check_output(): 8cf.  Otherwise, ‘None’.

      -- Attribute: stdout

          Alias for output, for symmetry with *note stderr: 23a4.

      -- Attribute: stderr

          Stderr output of the child process if it was captured by *note
          run(): 3e2.  Otherwise, ‘None’.

     New in version 3.3.

     Changed in version 3.5: `stdout' and `stderr' attributes added

 -- Exception: subprocess.CalledProcessError

     Subclass of *note SubprocessError: 239f, raised when a process run
     by *note check_call(): 23a5. or *note check_output(): 8cf. returns
     a non-zero exit status.

      -- Attribute: returncode

          Exit status of the child process.  If the process exited due
          to a signal, this will be the negative signal number.

      -- Attribute: cmd

          Command that was used to spawn the child process.

      -- Attribute: output

          Output of the child process if it was captured by *note run():
          3e2. or *note check_output(): 8cf.  Otherwise, ‘None’.

      -- Attribute: stdout

          Alias for output, for symmetry with *note stderr: 23aa.

      -- Attribute: stderr

          Stderr output of the child process if it was captured by *note
          run(): 3e2.  Otherwise, ‘None’.

     Changed in version 3.5: `stdout' and `stderr' attributes added

* Menu:

* Frequently Used Arguments::
* Popen Constructor::
* Exceptions: Exceptions<7>.


File: python.info,  Node: Frequently Used Arguments,  Next: Popen Constructor,  Up: Using the subprocess Module

5.17.6.2 Frequently Used Arguments
..................................

To support a wide variety of use cases, the *note Popen: 2b7.
constructor (and the convenience functions) accept a large number of
optional arguments.  For most typical use cases, many of these arguments
can be safely left at their default values.  The arguments that are most
commonly needed are:

     `args' is required for all calls and should be a string, or a
     sequence of program arguments.  Providing a sequence of arguments
     is generally preferred, as it allows the module to take care of any
     required escaping and quoting of arguments (e.g.  to permit spaces
     in file names).  If passing a single string, either `shell' must be
     *note True: 48f. (see below) or else the string must simply name
     the program to be executed without specifying any arguments.

     `stdin', `stdout' and `stderr' specify the executed program’s
     standard input, standard output and standard error file handles,
     respectively.  Valid values are *note PIPE: 3e3, *note DEVNULL:
     a95, an existing file descriptor (a positive integer), an existing
     file object, and ‘None’.  *note PIPE: 3e3. indicates that a new
     pipe to the child should be created.  *note DEVNULL: a95. indicates
     that the special file *note os.devnull: f52. will be used.  With
     the default settings of ‘None’, no redirection will occur; the
     child’s file handles will be inherited from the parent.
     Additionally, `stderr' can be *note STDOUT: 239e, which indicates
     that the stderr data from the child process should be captured into
     the same file handle as for `stdout'.

     If `encoding' or `errors' are specified, or `text' (also known as
     `universal_newlines') is true, the file objects `stdin', `stdout'
     and `stderr' will be opened in text mode using the `encoding' and
     `errors' specified in the call or the defaults for *note
     io.TextIOWrapper: 5e8.

     For `stdin', line ending characters ‘'\n'’ in the input will be
     converted to the default line separator *note os.linesep: 1537.
     For `stdout' and `stderr', all line endings in the output will be
     converted to ‘'\n'’.  For more information see the documentation of
     the *note io.TextIOWrapper: 5e8. class when the `newline' argument
     to its constructor is ‘None’.

     If text mode is not used, `stdin', `stdout' and `stderr' will be
     opened as binary streams.  No encoding or line ending conversion is
     performed.

     New in version 3.6: Added `encoding' and `errors' parameters.

     New in version 3.7: Added the `text' parameter as an alias for
     `universal_newlines'.

          Note: The newlines attribute of the file objects *note
          Popen.stdin: 23ac, *note Popen.stdout: 23ad. and *note
          Popen.stderr: 23ae. are not updated by the *note
          Popen.communicate(): 2397. method.

     If `shell' is ‘True’, the specified command will be executed
     through the shell.  This can be useful if you are using Python
     primarily for the enhanced control flow it offers over most system
     shells and still want convenient access to other shell features
     such as shell pipes, filename wildcards, environment variable
     expansion, and expansion of ‘~’ to a user’s home directory.
     However, note that Python itself offers implementations of many
     shell-like features (in particular, *note glob: 8a, *note fnmatch:
     81, *note os.walk(): 648, *note os.path.expandvars(): d37, *note
     os.path.expanduser(): 1fc, and *note shutil: e9.).

     Changed in version 3.3: When `universal_newlines' is ‘True’, the
     class uses the encoding *note locale.getpreferredencoding(False):
     39a. instead of ‘locale.getpreferredencoding()’.  See the *note
     io.TextIOWrapper: 5e8. class for more information on this change.

          Note: Read the *note Security Considerations: 23af. section
          before using ‘shell=True’.

These options, along with all of the other options, are described in
more detail in the *note Popen: 2b7. constructor documentation.


File: python.info,  Node: Popen Constructor,  Next: Exceptions<7>,  Prev: Frequently Used Arguments,  Up: Using the subprocess Module

5.17.6.3 Popen Constructor
..........................

The underlying process creation and management in this module is handled
by the *note Popen: 2b7. class.  It offers a lot of flexibility so that
developers are able to handle the less common cases not covered by the
convenience functions.

 -- Class: subprocess.Popen (args, bufsize=-1, executable=None,
          stdin=None, stdout=None, stderr=None, preexec_fn=None,
          close_fds=True, shell=False, cwd=None, env=None,
          universal_newlines=None, startupinfo=None, creationflags=0,
          restore_signals=True, start_new_session=False, pass_fds=(), *,
          encoding=None, errors=None, text=None)

     Execute a child program in a new process.  On POSIX, the class uses
     *note os.execvp(): 1ecc.-like behavior to execute the child
     program.  On Windows, the class uses the Windows ‘CreateProcess()’
     function.  The arguments to *note Popen: 2b7. are as follows.

     `args' should be a sequence of program arguments or else a single
     string or *note path-like object: 35f.  By default, the program to
     execute is the first item in `args' if `args' is a sequence.  If
     `args' is a string, the interpretation is platform-dependent and
     described below.  See the `shell' and `executable' arguments for
     additional differences from the default behavior.  Unless otherwise
     stated, it is recommended to pass `args' as a sequence.

     On POSIX, if `args' is a string, the string is interpreted as the
     name or path of the program to execute.  However, this can only be
     done if not passing arguments to the program.

          Note: *note shlex.split(): 216. can be useful when determining
          the correct tokenization for `args', especially in complex
          cases:

               >>> import shlex, subprocess >>> command_line = input() /bin/vikings -input eggs.txt -output "spam spam.txt" -cmd "echo '$MONEY'" >>> args = shlex.split(command_line) >>> print(args) ['/bin/vikings', '-input', 'eggs.txt', '-output', 'spam spam.txt', '-cmd', "echo '$MONEY'"] >>> p = subprocess.Popen(args) # Success!

          Note in particular that options (such as `-input') and
          arguments (such as `eggs.txt') that are separated by
          whitespace in the shell go in separate list elements, while
          arguments that need quoting or backslash escaping when used in
          the shell (such as filenames containing spaces or the `echo'
          command shown above) are single list elements.

     On Windows, if `args' is a sequence, it will be converted to a
     string in a manner described in *note Converting an argument
     sequence to a string on Windows: 23b1.  This is because the
     underlying ‘CreateProcess()’ operates on strings.

     Changed in version 3.6: `args' parameter accepts a *note path-like
     object: 35f. if `shell' is ‘False’ and a sequence containing
     path-like objects on POSIX.

     Changed in version 3.8: `args' parameter accepts a *note path-like
     object: 35f. if `shell' is ‘False’ and a sequence containing bytes
     and path-like objects on Windows.

     The `shell' argument (which defaults to ‘False’) specifies whether
     to use the shell as the program to execute.  If `shell' is ‘True’,
     it is recommended to pass `args' as a string rather than as a
     sequence.

     On POSIX with ‘shell=True’, the shell defaults to ‘/bin/sh’.  If
     `args' is a string, the string specifies the command to execute
     through the shell.  This means that the string must be formatted
     exactly as it would be when typed at the shell prompt.  This
     includes, for example, quoting or backslash escaping filenames with
     spaces in them.  If `args' is a sequence, the first item specifies
     the command string, and any additional items will be treated as
     additional arguments to the shell itself.  That is to say, *note
     Popen: 2b7. does the equivalent of:

          Popen(['/bin/sh', '-c', args[0], args[1], ...])

     On Windows with ‘shell=True’, the ‘COMSPEC’ environment variable
     specifies the default shell.  The only time you need to specify
     ‘shell=True’ on Windows is when the command you wish to execute is
     built into the shell (e.g.  ‘dir’ or ‘copy’).  You do not need
     ‘shell=True’ to run a batch file or console-based executable.

          Note: Read the *note Security Considerations: 23af. section
          before using ‘shell=True’.

     `bufsize' will be supplied as the corresponding argument to the
     *note open(): 4e5. function when creating the stdin/stdout/stderr
     pipe file objects:

        - ‘0’ means unbuffered (read and write are one system call and
          can return short)

        - ‘1’ means line buffered (only usable if
          ‘universal_newlines=True’ i.e., in a text mode)

        - any other positive value means use a buffer of approximately
          that size

        - negative bufsize (the default) means the system default of
          io.DEFAULT_BUFFER_SIZE will be used.

     Changed in version 3.3.1: `bufsize' now defaults to -1 to enable
     buffering by default to match the behavior that most code expects.
     In versions prior to Python 3.2.4 and 3.3.1 it incorrectly
     defaulted to ‘0’ which was unbuffered and allowed short reads.
     This was unintentional and did not match the behavior of Python 2
     as most code expected.

     The `executable' argument specifies a replacement program to
     execute.  It is very seldom needed.  When ‘shell=False’,
     `executable' replaces the program to execute specified by `args'.
     However, the original `args' is still passed to the program.  Most
     programs treat the program specified by `args' as the command name,
     which can then be different from the program actually executed.  On
     POSIX, the `args' name becomes the display name for the executable
     in utilities such as ‘ps’.  If ‘shell=True’, on POSIX the
     `executable' argument specifies a replacement shell for the default
     ‘/bin/sh’.

     Changed in version 3.6: `executable' parameter accepts a *note
     path-like object: 35f. on POSIX.

     Changed in version 3.8: `executable' parameter accepts a bytes and
     *note path-like object: 35f. on Windows.

     `stdin', `stdout' and `stderr' specify the executed program’s
     standard input, standard output and standard error file handles,
     respectively.  Valid values are *note PIPE: 3e3, *note DEVNULL:
     a95, an existing file descriptor (a positive integer), an existing
     *note file object: b35, and ‘None’.  *note PIPE: 3e3. indicates
     that a new pipe to the child should be created.  *note DEVNULL:
     a95. indicates that the special file *note os.devnull: f52. will be
     used.  With the default settings of ‘None’, no redirection will
     occur; the child’s file handles will be inherited from the parent.
     Additionally, `stderr' can be *note STDOUT: 239e, which indicates
     that the stderr data from the applications should be captured into
     the same file handle as for stdout.

     If `preexec_fn' is set to a callable object, this object will be
     called in the child process just before the child is executed.
     (POSIX only)

          Warning: The `preexec_fn' parameter is not safe to use in the
          presence of threads in your application.  The child process
          could deadlock before exec is called.  If you must use it,
          keep it trivial!  Minimize the number of libraries you call
          into.

          Note: If you need to modify the environment for the child use
          the `env' parameter rather than doing it in a `preexec_fn'.
          The `start_new_session' parameter can take the place of a
          previously common use of `preexec_fn' to call os.setsid() in
          the child.

     Changed in version 3.8: The `preexec_fn' parameter is no longer
     supported in subinterpreters.  The use of the parameter in a
     subinterpreter raises *note RuntimeError: 2b8.  The new restriction
     may affect applications that are deployed in mod_wsgi, uWSGI, and
     other embedded environments.

     If `close_fds' is true, all file descriptors except ‘0’, ‘1’ and
     ‘2’ will be closed before the child process is executed.  Otherwise
     when `close_fds' is false, file descriptors obey their inheritable
     flag as described in *note Inheritance of File Descriptors: 7ee.

     On Windows, if `close_fds' is true then no handles will be
     inherited by the child process unless explicitly passed in the
     ‘handle_list’ element of *note STARTUPINFO.lpAttributeList: 490, or
     by standard handle redirection.

     Changed in version 3.2: The default for `close_fds' was changed
     from *note False: 37d. to what is described above.

     Changed in version 3.7: On Windows the default for `close_fds' was
     changed from *note False: 37d. to *note True: 48f. when redirecting
     the standard handles.  It’s now possible to set `close_fds' to
     *note True: 48f. when redirecting the standard handles.

     `pass_fds' is an optional sequence of file descriptors to keep open
     between the parent and child.  Providing any `pass_fds' forces
     `close_fds' to be *note True: 48f.  (POSIX only)

     Changed in version 3.2: The `pass_fds' parameter was added.

     If `cwd' is not ‘None’, the function changes the working directory
     to `cwd' before executing the child.  `cwd' can be a string, bytes
     or *note path-like: 35f. object.  In particular, the function looks
     for `executable' (or for the first item in `args') relative to
     `cwd' if the executable path is a relative path.

     Changed in version 3.6: `cwd' parameter accepts a *note path-like
     object: 35f. on POSIX.

     Changed in version 3.7: `cwd' parameter accepts a *note path-like
     object: 35f. on Windows.

     Changed in version 3.8: `cwd' parameter accepts a bytes object on
     Windows.

     If `restore_signals' is true (the default) all signals that Python
     has set to SIG_IGN are restored to SIG_DFL in the child process
     before the exec.  Currently this includes the SIGPIPE, SIGXFZ and
     SIGXFSZ signals.  (POSIX only)

     Changed in version 3.2: `restore_signals' was added.

     If `start_new_session' is true the setsid() system call will be
     made in the child process prior to the execution of the subprocess.
     (POSIX only)

     Changed in version 3.2: `start_new_session' was added.

     If `env' is not ‘None’, it must be a mapping that defines the
     environment variables for the new process; these are used instead
     of the default behavior of inheriting the current process’
     environment.

          Note: If specified, `env' must provide any variables required
          for the program to execute.  On Windows, in order to run a
          side-by-side assembly(1) the specified `env' `must' include a
          valid ‘SystemRoot’.

     If `encoding' or `errors' are specified, or `text' is true, the
     file objects `stdin', `stdout' and `stderr' are opened in text mode
     with the specified encoding and `errors', as described above in
     *note Frequently Used Arguments: 2396.  The `universal_newlines'
     argument is equivalent to `text' and is provided for backwards
     compatibility.  By default, file objects are opened in binary mode.

     New in version 3.6: `encoding' and `errors' were added.

     New in version 3.7: `text' was added as a more readable alias for
     `universal_newlines'.

     If given, `startupinfo' will be a *note STARTUPINFO: 23b2. object,
     which is passed to the underlying ‘CreateProcess’ function.
     `creationflags', if given, can be one or more of the following
     flags:

             * *note CREATE_NEW_CONSOLE: 23b3.

             * *note CREATE_NEW_PROCESS_GROUP: 23b4.

             * *note ABOVE_NORMAL_PRIORITY_CLASS: 23b5.

             * *note BELOW_NORMAL_PRIORITY_CLASS: 23b6.

             * *note HIGH_PRIORITY_CLASS: 23b7.

             * *note IDLE_PRIORITY_CLASS: 23b8.

             * *note NORMAL_PRIORITY_CLASS: 23b9.

             * *note REALTIME_PRIORITY_CLASS: 23ba.

             * *note CREATE_NO_WINDOW: 23bb.

             * *note DETACHED_PROCESS: 23bc.

             * *note CREATE_DEFAULT_ERROR_MODE: 23bd.

             * *note CREATE_BREAKAWAY_FROM_JOB: 23be.

     Popen objects are supported as context managers via the *note with:
     6dd. statement: on exit, standard file descriptors are closed, and
     the process is waited for.

          with Popen(["ifconfig"], stdout=PIPE) as proc:     log.write(proc.stdout.read())

     Popen and the other functions in this module that use it raise an
     *note auditing event: 1275. ‘subprocess.Popen’ with arguments
     ‘executable’, ‘args’, ‘cwd’, and ‘env’.  The value for ‘args’ may
     be a single string or a list of strings, depending on platform.

     Changed in version 3.2: Added context manager support.

     Changed in version 3.6: Popen destructor now emits a *note
     ResourceWarning: 4c5. warning if the child process is still
     running.

     Changed in version 3.8: Popen can use *note os.posix_spawn(): 255.
     in some cases for better performance.  On Windows Subsystem for
     Linux and QEMU User Emulation, Popen constructor using *note
     os.posix_spawn(): 255. no longer raise an exception on errors like
     missing program, but the child process fails with a non-zero *note
     returncode: 23bf.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Side-by-Side_Assembly


File: python.info,  Node: Exceptions<7>,  Prev: Popen Constructor,  Up: Using the subprocess Module

5.17.6.4 Exceptions
...................

Exceptions raised in the child process, before the new program has
started to execute, will be re-raised in the parent.

The most common exception raised is *note OSError: 1d1.  This occurs,
for example, when trying to execute a non-existent file.  Applications
should prepare for *note OSError: 1d1. exceptions.

A *note ValueError: 1f9. will be raised if *note Popen: 2b7. is called
with invalid arguments.

*note check_call(): 23a5. and *note check_output(): 8cf. will raise
*note CalledProcessError: ca8. if the called process returns a non-zero
return code.

All of the functions and methods that accept a `timeout' parameter, such
as *note call(): 3e4. and *note Popen.communicate(): 2397. will raise
*note TimeoutExpired: 2398. if the timeout expires before the process
exits.

Exceptions defined in this module all inherit from *note
SubprocessError: 239f.

     New in version 3.3: The *note SubprocessError: 239f. base class was
     added.


File: python.info,  Node: Security Considerations,  Next: Popen Objects,  Prev: Using the subprocess Module,  Up: subprocess — Subprocess management

5.17.6.5 Security Considerations
................................

Unlike some other popen functions, this implementation will never
implicitly call a system shell.  This means that all characters,
including shell metacharacters, can safely be passed to child processes.
If the shell is invoked explicitly, via ‘shell=True’, it is the
application’s responsibility to ensure that all whitespace and
metacharacters are quoted appropriately to avoid shell injection(1)
vulnerabilities.

When using ‘shell=True’, the *note shlex.quote(): a68. function can be
used to properly escape whitespace and shell metacharacters in strings
that are going to be used to construct shell commands.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Shell_injection#Shell_injection


File: python.info,  Node: Popen Objects,  Next: Windows Popen Helpers,  Prev: Security Considerations,  Up: subprocess — Subprocess management

5.17.6.6 Popen Objects
......................

Instances of the *note Popen: 2b7. class have the following methods:

 -- Method: Popen.poll ()

     Check if child process has terminated.  Set and return *note
     returncode: 23bf. attribute.  Otherwise, returns ‘None’.

 -- Method: Popen.wait (timeout=None)

     Wait for child process to terminate.  Set and return *note
     returncode: 23bf. attribute.

     If the process does not terminate after `timeout' seconds, raise a
     *note TimeoutExpired: 2398. exception.  It is safe to catch this
     exception and retry the wait.

          Note: This will deadlock when using ‘stdout=PIPE’ or
          ‘stderr=PIPE’ and the child process generates enough output to
          a pipe such that it blocks waiting for the OS pipe buffer to
          accept more data.  Use *note Popen.communicate(): 2397. when
          using pipes to avoid that.

          Note: The function is implemented using a busy loop
          (non-blocking call and short sleeps).  Use the *note asyncio:
          a. module for an asynchronous wait: see *note
          asyncio.create_subprocess_exec: 28f.

     Changed in version 3.3: `timeout' was added.

 -- Method: Popen.communicate (input=None, timeout=None)

     Interact with process: Send data to stdin.  Read data from stdout
     and stderr, until end-of-file is reached.  Wait for process to
     terminate.  The optional `input' argument should be data to be sent
     to the child process, or ‘None’, if no data should be sent to the
     child.  If streams were opened in text mode, `input' must be a
     string.  Otherwise, it must be bytes.

     *note communicate(): 2397. returns a tuple ‘(stdout_data,
     stderr_data)’.  The data will be strings if streams were opened in
     text mode; otherwise, bytes.

     Note that if you want to send data to the process’s stdin, you need
     to create the Popen object with ‘stdin=PIPE’.  Similarly, to get
     anything other than ‘None’ in the result tuple, you need to give
     ‘stdout=PIPE’ and/or ‘stderr=PIPE’ too.

     If the process does not terminate after `timeout' seconds, a *note
     TimeoutExpired: 2398. exception will be raised.  Catching this
     exception and retrying communication will not lose any output.

     The child process is not killed if the timeout expires, so in order
     to cleanup properly a well-behaved application should kill the
     child process and finish communication:

          proc = subprocess.Popen(...) try:     outs, errs = proc.communicate(timeout=15) except TimeoutExpired:     proc.kill()     outs, errs = proc.communicate()

          Note: The data read is buffered in memory, so do not use this
          method if the data size is large or unlimited.

     Changed in version 3.3: `timeout' was added.

 -- Method: Popen.send_signal (signal)

     Sends the signal `signal' to the child.

          Note: On Windows, SIGTERM is an alias for *note terminate():
          23c4.  CTRL_C_EVENT and CTRL_BREAK_EVENT can be sent to
          processes started with a `creationflags' parameter which
          includes ‘CREATE_NEW_PROCESS_GROUP’.

 -- Method: Popen.terminate ()

     Stop the child.  On Posix OSs the method sends SIGTERM to the
     child.  On Windows the Win32 API function ‘TerminateProcess()’ is
     called to stop the child.

 -- Method: Popen.kill ()

     Kills the child.  On Posix OSs the function sends SIGKILL to the
     child.  On Windows *note kill(): 23c5. is an alias for *note
     terminate(): 23c4.

The following attributes are also available:

 -- Attribute: Popen.args

     The `args' argument as it was passed to *note Popen: 2b7. – a
     sequence of program arguments or else a single string.

     New in version 3.3.

 -- Attribute: Popen.stdin

     If the `stdin' argument was *note PIPE: 3e3, this attribute is a
     writeable stream object as returned by *note open(): 4e5.  If the
     `encoding' or `errors' arguments were specified or the
     `universal_newlines' argument was ‘True’, the stream is a text
     stream, otherwise it is a byte stream.  If the `stdin' argument was
     not *note PIPE: 3e3, this attribute is ‘None’.

 -- Attribute: Popen.stdout

     If the `stdout' argument was *note PIPE: 3e3, this attribute is a
     readable stream object as returned by *note open(): 4e5.  Reading
     from the stream provides output from the child process.  If the
     `encoding' or `errors' arguments were specified or the
     `universal_newlines' argument was ‘True’, the stream is a text
     stream, otherwise it is a byte stream.  If the `stdout' argument
     was not *note PIPE: 3e3, this attribute is ‘None’.

 -- Attribute: Popen.stderr

     If the `stderr' argument was *note PIPE: 3e3, this attribute is a
     readable stream object as returned by *note open(): 4e5.  Reading
     from the stream provides error output from the child process.  If
     the `encoding' or `errors' arguments were specified or the
     `universal_newlines' argument was ‘True’, the stream is a text
     stream, otherwise it is a byte stream.  If the `stderr' argument
     was not *note PIPE: 3e3, this attribute is ‘None’.

     Warning: Use *note communicate(): 2397. rather than *note
     .stdin.write: 23ac, *note .stdout.read: 23ad. or *note
     .stderr.read: 23ae. to avoid deadlocks due to any of the other OS
     pipe buffers filling up and blocking the child process.

 -- Attribute: Popen.pid

     The process ID of the child process.

     Note that if you set the `shell' argument to ‘True’, this is the
     process ID of the spawned shell.

 -- Attribute: Popen.returncode

     The child return code, set by *note poll(): 23c2. and *note wait():
     587. (and indirectly by *note communicate(): 2397.).  A ‘None’
     value indicates that the process hasn’t terminated yet.

     A negative value ‘-N’ indicates that the child was terminated by
     signal ‘N’ (POSIX only).


File: python.info,  Node: Windows Popen Helpers,  Next: Older high-level API,  Prev: Popen Objects,  Up: subprocess — Subprocess management

5.17.6.7 Windows Popen Helpers
..............................

The *note STARTUPINFO: 23b2. class and following constants are only
available on Windows.

 -- Class: subprocess.STARTUPINFO (*, dwFlags=0, hStdInput=None,
          hStdOutput=None, hStdError=None, wShowWindow=0,
          lpAttributeList=None)

     Partial support of the Windows STARTUPINFO(1) structure is used for
     *note Popen: 2b7. creation.  The following attributes can be set by
     passing them as keyword-only arguments.

     Changed in version 3.7: Keyword-only argument support was added.

      -- Attribute: dwFlags

          A bit field that determines whether certain *note STARTUPINFO:
          23b2. attributes are used when the process creates a window.

               si = subprocess.STARTUPINFO() si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW

      -- Attribute: hStdInput

          If *note dwFlags: 23c9. specifies *note STARTF_USESTDHANDLES:
          23cb, this attribute is the standard input handle for the
          process.  If *note STARTF_USESTDHANDLES: 23cb. is not
          specified, the default for standard input is the keyboard
          buffer.

      -- Attribute: hStdOutput

          If *note dwFlags: 23c9. specifies *note STARTF_USESTDHANDLES:
          23cb, this attribute is the standard output handle for the
          process.  Otherwise, this attribute is ignored and the default
          for standard output is the console window’s buffer.

      -- Attribute: hStdError

          If *note dwFlags: 23c9. specifies *note STARTF_USESTDHANDLES:
          23cb, this attribute is the standard error handle for the
          process.  Otherwise, this attribute is ignored and the default
          for standard error is the console window’s buffer.

      -- Attribute: wShowWindow

          If *note dwFlags: 23c9. specifies *note STARTF_USESHOWWINDOW:
          23cf, this attribute can be any of the values that can be
          specified in the ‘nCmdShow’ parameter for the ShowWindow(2)
          function, except for ‘SW_SHOWDEFAULT’.  Otherwise, this
          attribute is ignored.

          *note SW_HIDE: 23d0. is provided for this attribute.  It is
          used when *note Popen: 2b7. is called with ‘shell=True’.

      -- Attribute: lpAttributeList

          A dictionary of additional attributes for process creation as
          given in ‘STARTUPINFOEX’, see UpdateProcThreadAttribute(3).

          Supported attributes:

          `handle_list'

               Sequence of handles that will be inherited.  `close_fds'
               must be true if non-empty.

               The handles must be temporarily made inheritable by *note
               os.set_handle_inheritable(): 7f2. when passed to the
               *note Popen: 2b7. constructor, else *note OSError: 1d1.
               will be raised with Windows error
               ‘ERROR_INVALID_PARAMETER’ (87).

                    Warning: In a multithreaded process, use caution to
                    avoid leaking handles that are marked inheritable
                    when combining this feature with concurrent calls to
                    other process creation functions that inherit all
                    handles such as *note os.system(): db4.  This also
                    applies to standard handle redirection, which
                    temporarily creates inheritable handles.

          New in version 3.7.

* Menu:

* Windows Constants::

   ---------- Footnotes ----------

   (1) https://msdn.microsoft.com/en-us/library/ms686331(v=vs.85).aspx

   (2) https://msdn.microsoft.com/en-us/library/ms633548(v=vs.85).aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/ms686880(v=vs.85).aspx


File: python.info,  Node: Windows Constants,  Up: Windows Popen Helpers

5.17.6.8 Windows Constants
..........................

The *note subprocess: f9. module exposes the following constants.

 -- Data: subprocess.STD_INPUT_HANDLE

     The standard input device.  Initially, this is the console input
     buffer, ‘CONIN$’.

 -- Data: subprocess.STD_OUTPUT_HANDLE

     The standard output device.  Initially, this is the active console
     screen buffer, ‘CONOUT$’.

 -- Data: subprocess.STD_ERROR_HANDLE

     The standard error device.  Initially, this is the active console
     screen buffer, ‘CONOUT$’.

 -- Data: subprocess.SW_HIDE

     Hides the window.  Another window will be activated.

 -- Data: subprocess.STARTF_USESTDHANDLES

     Specifies that the *note STARTUPINFO.hStdInput: 23ca, *note
     STARTUPINFO.hStdOutput: 23cc, and *note STARTUPINFO.hStdError:
     23cd. attributes contain additional information.

 -- Data: subprocess.STARTF_USESHOWWINDOW

     Specifies that the *note STARTUPINFO.wShowWindow: 23ce. attribute
     contains additional information.

 -- Data: subprocess.CREATE_NEW_CONSOLE

     The new process has a new console, instead of inheriting its
     parent’s console (the default).

 -- Data: subprocess.CREATE_NEW_PROCESS_GROUP

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process group will be created.  This flag is necessary for using
     *note os.kill(): ce6. on the subprocess.

     This flag is ignored if *note CREATE_NEW_CONSOLE: 23b3. is
     specified.

 -- Data: subprocess.ABOVE_NORMAL_PRIORITY_CLASS

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will have an above average priority.

     New in version 3.7.

 -- Data: subprocess.BELOW_NORMAL_PRIORITY_CLASS

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will have a below average priority.

     New in version 3.7.

 -- Data: subprocess.HIGH_PRIORITY_CLASS

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will have a high priority.

     New in version 3.7.

 -- Data: subprocess.IDLE_PRIORITY_CLASS

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will have an idle (lowest) priority.

     New in version 3.7.

 -- Data: subprocess.NORMAL_PRIORITY_CLASS

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will have an normal priority.  (default)

     New in version 3.7.

 -- Data: subprocess.REALTIME_PRIORITY_CLASS

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will have realtime priority.  You should almost never use
     REALTIME_PRIORITY_CLASS, because this interrupts system threads
     that manage mouse input, keyboard input, and background disk
     flushing.  This class can be appropriate for applications that
     “talk” directly to hardware or that perform brief tasks that should
     have limited interruptions.

     New in version 3.7.

 -- Data: subprocess.CREATE_NO_WINDOW

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will not create a window.

     New in version 3.7.

 -- Data: subprocess.DETACHED_PROCESS

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process will not inherit its parent’s console.  This value cannot
     be used with CREATE_NEW_CONSOLE.

     New in version 3.7.

 -- Data: subprocess.CREATE_DEFAULT_ERROR_MODE

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process does not inherit the error mode of the calling process.
     Instead, the new process gets the default error mode.  This feature
     is particularly useful for multithreaded shell applications that
     run with hard errors disabled.

     New in version 3.7.

 -- Data: subprocess.CREATE_BREAKAWAY_FROM_JOB

     A *note Popen: 2b7. ‘creationflags’ parameter to specify that a new
     process is not associated with the job.

     New in version 3.7.


File: python.info,  Node: Older high-level API,  Next: Replacing Older Functions with the subprocess Module,  Prev: Windows Popen Helpers,  Up: subprocess — Subprocess management

5.17.6.9 Older high-level API
.............................

Prior to Python 3.5, these three functions comprised the high level API
to subprocess.  You can now use *note run(): 3e2. in many cases, but
lots of existing code calls these functions.

 -- Function: subprocess.call (args, *, stdin=None, stdout=None,
          stderr=None, shell=False, cwd=None, timeout=None)

     Run the command described by `args'.  Wait for command to complete,
     then return the *note returncode: 23bf. attribute.

     Code needing to capture stdout or stderr should use *note run():
     3e2. instead:

          run(...).returncode

     To suppress stdout or stderr, supply a value of *note DEVNULL: a95.

     The arguments shown above are merely some common ones.  The full
     function signature is the same as that of the *note Popen: 2b7.
     constructor - this function passes all supplied arguments other
     than `timeout' directly through to that interface.

          Note: Do not use ‘stdout=PIPE’ or ‘stderr=PIPE’ with this
          function.  The child process will block if it generates enough
          output to a pipe to fill up the OS pipe buffer as the pipes
          are not being read from.

     Changed in version 3.3: `timeout' was added.

 -- Function: subprocess.check_call (args, *, stdin=None, stdout=None,
          stderr=None, shell=False, cwd=None, timeout=None)

     Run command with arguments.  Wait for command to complete.  If the
     return code was zero then return, otherwise raise *note
     CalledProcessError: ca8.  The *note CalledProcessError: ca8. object
     will have the return code in the *note returncode: 23a6. attribute.

     Code needing to capture stdout or stderr should use *note run():
     3e2. instead:

          run(..., check=True)

     To suppress stdout or stderr, supply a value of *note DEVNULL: a95.

     The arguments shown above are merely some common ones.  The full
     function signature is the same as that of the *note Popen: 2b7.
     constructor - this function passes all supplied arguments other
     than `timeout' directly through to that interface.

          Note: Do not use ‘stdout=PIPE’ or ‘stderr=PIPE’ with this
          function.  The child process will block if it generates enough
          output to a pipe to fill up the OS pipe buffer as the pipes
          are not being read from.

     Changed in version 3.3: `timeout' was added.

 -- Function: subprocess.check_output (args, *, stdin=None, stderr=None,
          shell=False, cwd=None, encoding=None, errors=None,
          universal_newlines=None, timeout=None, text=None)

     Run command with arguments and return its output.

     If the return code was non-zero it raises a *note
     CalledProcessError: ca8.  The *note CalledProcessError: ca8. object
     will have the return code in the *note returncode: 23a6. attribute
     and any output in the *note output: 23a8. attribute.

     This is equivalent to:

          run(..., check=True, stdout=PIPE).stdout

     The arguments shown above are merely some common ones.  The full
     function signature is largely the same as that of *note run(): 3e2.
     - most arguments are passed directly through to that interface.
     However, explicitly passing ‘input=None’ to inherit the parent’s
     standard input file handle is not supported.

     By default, this function will return the data as encoded bytes.
     The actual encoding of the output data may depend on the command
     being invoked, so the decoding to text will often need to be
     handled at the application level.

     This behaviour may be overridden by setting `text', `encoding',
     `errors', or `universal_newlines' to ‘True’ as described in *note
     Frequently Used Arguments: 2396. and *note run(): 3e2.

     To also capture standard error in the result, use
     ‘stderr=subprocess.STDOUT’:

          >>> subprocess.check_output( ...     "ls non_existent_file; exit 0", ...     stderr=subprocess.STDOUT, ...     shell=True) 'ls: non_existent_file: No such file or directory\n'

     New in version 3.1.

     Changed in version 3.3: `timeout' was added.

     Changed in version 3.4: Support for the `input' keyword argument
     was added.

     Changed in version 3.6: `encoding' and `errors' were added.  See
     *note run(): 3e2. for details.

     New in version 3.7: `text' was added as a more readable alias for
     `universal_newlines'.


File: python.info,  Node: Replacing Older Functions with the subprocess Module,  Next: Legacy Shell Invocation Functions,  Prev: Older high-level API,  Up: subprocess — Subprocess management

5.17.6.10 Replacing Older Functions with the ‘subprocess’ Module
................................................................

In this section, “a becomes b” means that b can be used as a replacement
for a.

     Note: All “a” functions in this section fail (more or less)
     silently if the executed program cannot be found; the “b”
     replacements raise *note OSError: 1d1. instead.

     In addition, the replacements using *note check_output(): 8cf. will
     fail with a *note CalledProcessError: ca8. if the requested
     operation produces a non-zero return code.  The output is still
     available as the *note output: 23a8. attribute of the raised
     exception.

In the following examples, we assume that the relevant functions have
already been imported from the *note subprocess: f9. module.

* Menu:

* Replacing /bin/sh shell command substitution::
* Replacing shell pipeline::
* Replacing os.system(): Replacing os system.
* Replacing the os.spawn family: Replacing the os spawn family.
* Replacing os.popen(), os.popen2(), os.popen3(): Replacing os popen os popen2 os popen3.
* Replacing functions from the popen2 module::


File: python.info,  Node: Replacing /bin/sh shell command substitution,  Next: Replacing shell pipeline,  Up: Replacing Older Functions with the subprocess Module

5.17.6.11 Replacing ‘/bin/sh’ shell command substitution
........................................................

     output=$(mycmd myarg)

becomes:

     output = check_output(["mycmd", "myarg"])


File: python.info,  Node: Replacing shell pipeline,  Next: Replacing os system,  Prev: Replacing /bin/sh shell command substitution,  Up: Replacing Older Functions with the subprocess Module

5.17.6.12 Replacing shell pipeline
..................................

     output=$(dmesg | grep hda)

becomes:

     p1 = Popen(["dmesg"], stdout=PIPE) p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE) p1.stdout.close()  # Allow p1 to receive a SIGPIPE if p2 exits. output = p2.communicate()[0]

The ‘p1.stdout.close()’ call after starting the p2 is important in order
for p1 to receive a SIGPIPE if p2 exits before p1.

Alternatively, for trusted input, the shell’s own pipeline support may
still be used directly:

     output=$(dmesg | grep hda)

becomes:

     output=check_output("dmesg | grep hda", shell=True)


File: python.info,  Node: Replacing os system,  Next: Replacing the os spawn family,  Prev: Replacing shell pipeline,  Up: Replacing Older Functions with the subprocess Module

5.17.6.13 Replacing ‘os.system()’
.................................

     sts = os.system("mycmd" + " myarg") # becomes sts = call("mycmd" + " myarg", shell=True)

Notes:

   * Calling the program through the shell is usually not required.

A more realistic example would look like this:

     try:     retcode = call("mycmd" + " myarg", shell=True)     if retcode < 0:         print("Child was terminated by signal", -retcode, file=sys.stderr)     else:         print("Child returned", retcode, file=sys.stderr) except OSError as e:     print("Execution failed:", e, file=sys.stderr)


File: python.info,  Node: Replacing the os spawn family,  Next: Replacing os popen os popen2 os popen3,  Prev: Replacing os system,  Up: Replacing Older Functions with the subprocess Module

5.17.6.14 Replacing the ‘os.spawn’ family
.........................................

P_NOWAIT example:

     pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg") ==> pid = Popen(["/bin/mycmd", "myarg"]).pid

P_WAIT example:

     retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg") ==> retcode = call(["/bin/mycmd", "myarg"])

Vector example:

     os.spawnvp(os.P_NOWAIT, path, args) ==> Popen([path] + args[1:])

Environment example:

     os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env) ==> Popen(["/bin/mycmd", "myarg"], env={"PATH": "/usr/bin"})


File: python.info,  Node: Replacing os popen os popen2 os popen3,  Next: Replacing functions from the popen2 module,  Prev: Replacing the os spawn family,  Up: Replacing Older Functions with the subprocess Module

5.17.6.15 Replacing ‘os.popen()’, ‘os.popen2()’, ‘os.popen3()’
..............................................................

     (child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize) ==> p = Popen(cmd, shell=True, bufsize=bufsize,           stdin=PIPE, stdout=PIPE, close_fds=True) (child_stdin, child_stdout) = (p.stdin, p.stdout)

     (child_stdin,  child_stdout,  child_stderr) = os.popen3(cmd, mode, bufsize) ==> p = Popen(cmd, shell=True, bufsize=bufsize,           stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True) (child_stdin,  child_stdout,  child_stderr) = (p.stdin, p.stdout, p.stderr)

     (child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize) ==> p = Popen(cmd, shell=True, bufsize=bufsize,           stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True) (child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout)

Return code handling translates as follows:

     pipe = os.popen(cmd, 'w') ... rc = pipe.close() if rc is not None and rc >> 8:     print("There were some errors") ==> process = Popen(cmd, stdin=PIPE) ... process.stdin.close() if process.wait() != 0:     print("There were some errors")


File: python.info,  Node: Replacing functions from the popen2 module,  Prev: Replacing os popen os popen2 os popen3,  Up: Replacing Older Functions with the subprocess Module

5.17.6.16 Replacing functions from the ‘popen2’ module
......................................................

     Note: If the cmd argument to popen2 functions is a string, the
     command is executed through /bin/sh.  If it is a list, the command
     is directly executed.

     (child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode) ==> p = Popen("somestring", shell=True, bufsize=bufsize,           stdin=PIPE, stdout=PIPE, close_fds=True) (child_stdout, child_stdin) = (p.stdout, p.stdin)

     (child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode) ==> p = Popen(["mycmd", "myarg"], bufsize=bufsize,           stdin=PIPE, stdout=PIPE, close_fds=True) (child_stdout, child_stdin) = (p.stdout, p.stdin)

‘popen2.Popen3’ and ‘popen2.Popen4’ basically work as *note
subprocess.Popen: 2b7, except that:

   * *note Popen: 2b7. raises an exception if the execution fails.

   * The `capturestderr' argument is replaced with the `stderr'
     argument.

   * ‘stdin=PIPE’ and ‘stdout=PIPE’ must be specified.

   * popen2 closes all file descriptors by default, but you have to
     specify ‘close_fds=True’ with *note Popen: 2b7. to guarantee this
     behavior on all platforms or past Python versions.


File: python.info,  Node: Legacy Shell Invocation Functions,  Next: Notes,  Prev: Replacing Older Functions with the subprocess Module,  Up: subprocess — Subprocess management

5.17.6.17 Legacy Shell Invocation Functions
...........................................

This module also provides the following legacy functions from the 2.x
‘commands’ module.  These operations implicitly invoke the system shell
and none of the guarantees described above regarding security and
exception handling consistency are valid for these functions.

 -- Function: subprocess.getstatusoutput (cmd)

     Return ‘(exitcode, output)’ of executing `cmd' in a shell.

     Execute the string `cmd' in a shell with ‘Popen.check_output()’ and
     return a 2-tuple ‘(exitcode, output)’.  The locale encoding is
     used; see the notes on *note Frequently Used Arguments: 2396. for
     more details.

     A trailing newline is stripped from the output.  The exit code for
     the command can be interpreted as the return code of subprocess.
     Example:

          >>> subprocess.getstatusoutput('ls /bin/ls') (0, '/bin/ls') >>> subprocess.getstatusoutput('cat /bin/junk') (1, 'cat: /bin/junk: No such file or directory') >>> subprocess.getstatusoutput('/bin/junk') (127, 'sh: /bin/junk: not found') >>> subprocess.getstatusoutput('/bin/kill $$') (-15, '')

     *note Availability: 129a.: POSIX & Windows.

     Changed in version 3.3.4: Windows support was added.

     The function now returns (exitcode, output) instead of (status,
     output) as it did in Python 3.3.3 and earlier.  exitcode has the
     same value as *note returncode: 23bf.

 -- Function: subprocess.getoutput (cmd)

     Return output (stdout and stderr) of executing `cmd' in a shell.

     Like *note getstatusoutput(): 8d0, except the exit code is ignored
     and the return value is a string containing the command’s output.
     Example:

          >>> subprocess.getoutput('ls /bin/ls') '/bin/ls'

     *note Availability: 129a.: POSIX & Windows.

     Changed in version 3.3.4: Windows support added


File: python.info,  Node: Notes,  Prev: Legacy Shell Invocation Functions,  Up: subprocess — Subprocess management

5.17.6.18 Notes
...............

* Menu:

* Converting an argument sequence to a string on Windows::


File: python.info,  Node: Converting an argument sequence to a string on Windows,  Up: Notes

5.17.6.19 Converting an argument sequence to a string on Windows
................................................................

On Windows, an `args' sequence is converted to a string that can be
parsed using the following rules (which correspond to the rules used by
the MS C runtime):

  1. Arguments are delimited by white space, which is either a space or
     a tab.

  2. A string surrounded by double quotation marks is interpreted as a
     single argument, regardless of white space contained within.  A
     quoted string can be embedded in an argument.

  3. A double quotation mark preceded by a backslash is interpreted as a
     literal double quotation mark.

  4. Backslashes are interpreted literally, unless they immediately
     precede a double quotation mark.

  5. If backslashes immediately precede a double quotation mark, every
     pair of backslashes is interpreted as a literal backslash.  If the
     number of backslashes is odd, the last backslash escapes the next
     double quotation mark as described in rule 3.

See also
........

*note shlex: e8.

     Module which provides function to parse and escape command lines.


File: python.info,  Node: sched — Event scheduler,  Next: queue — A synchronized queue class,  Prev: subprocess — Subprocess management,  Up: Concurrent Execution

5.17.7 ‘sched’ — Event scheduler
--------------------------------

`Source code:' Lib/sched.py(1)

__________________________________________________________________

The *note sched: e3. module defines a class which implements a general
purpose event scheduler:

 -- Class: sched.scheduler (timefunc=time.monotonic,
          delayfunc=time.sleep)

     The *note scheduler: a63. class defines a generic interface to
     scheduling events.  It needs two functions to actually deal with
     the “outside world” — `timefunc' should be callable without
     arguments, and return a number (the “time”, in any units
     whatsoever).  The `delayfunc' function should be callable with one
     argument, compatible with the output of `timefunc', and should
     delay that many time units.  `delayfunc' will also be called with
     the argument ‘0’ after each event is run to allow other threads an
     opportunity to run in multi-threaded applications.

     Changed in version 3.3: `timefunc' and `delayfunc' parameters are
     optional.

     Changed in version 3.3: *note scheduler: a63. class can be safely
     used in multi-threaded environments.

Example:

     >>> import sched, time >>> s = sched.scheduler(time.time, time.sleep) >>> def print_time(a='default'): ...     print("From print_time", time.time(), a) ... >>> def print_some_times(): ...     print(time.time()) ...     s.enter(10, 1, print_time) ...     s.enter(5, 2, print_time, argument=('positional',)) ...     s.enter(5, 1, print_time, kwargs={'a': 'keyword'}) ...     s.run() ...     print(time.time()) ... >>> print_some_times() 930343690.257 From print_time 930343695.274 positional From print_time 930343695.275 keyword From print_time 930343700.273 default 930343700.276

* Menu:

* Scheduler Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/sched.py


File: python.info,  Node: Scheduler Objects,  Up: sched — Event scheduler

5.17.7.1 Scheduler Objects
..........................

*note scheduler: a63. instances have the following methods and
attributes:

 -- Method: scheduler.enterabs (time, priority, action, argument=(),
          kwargs={})

     Schedule a new event.  The `time' argument should be a numeric type
     compatible with the return value of the `timefunc' function passed
     to the constructor.  Events scheduled for the same `time' will be
     executed in the order of their `priority'.  A lower number
     represents a higher priority.

     Executing the event means executing ‘action(*argument, **kwargs)’.
     `argument' is a sequence holding the positional arguments for
     `action'.  `kwargs' is a dictionary holding the keyword arguments
     for `action'.

     Return value is an event which may be used for later cancellation
     of the event (see *note cancel(): 23e5.).

     Changed in version 3.3: `argument' parameter is optional.

     Changed in version 3.3: `kwargs' parameter was added.

 -- Method: scheduler.enter (delay, priority, action, argument=(),
          kwargs={})

     Schedule an event for `delay' more time units.  Other than the
     relative time, the other arguments, the effect and the return value
     are the same as those for *note enterabs(): a65.

     Changed in version 3.3: `argument' parameter is optional.

     Changed in version 3.3: `kwargs' parameter was added.

 -- Method: scheduler.cancel (event)

     Remove the event from the queue.  If `event' is not an event
     currently in the queue, this method will raise a *note ValueError:
     1f9.

 -- Method: scheduler.empty ()

     Return ‘True’ if the event queue is empty.

 -- Method: scheduler.run (blocking=True)

     Run all scheduled events.  This method will wait (using the
     ‘delayfunc()’ function passed to the constructor) for the next
     event, then execute it and so on until there are no more scheduled
     events.

     If `blocking' is false executes the scheduled events due to expire
     soonest (if any) and then return the deadline of the next scheduled
     call in the scheduler (if any).

     Either `action' or `delayfunc' can raise an exception.  In either
     case, the scheduler will maintain a consistent state and propagate
     the exception.  If an exception is raised by `action', the event
     will not be attempted in future calls to *note run(): a62.

     If a sequence of events takes longer to run than the time available
     before the next event, the scheduler will simply fall behind.  No
     events will be dropped; the calling code is responsible for
     canceling events which are no longer pertinent.

     Changed in version 3.3: `blocking' parameter was added.

 -- Attribute: scheduler.queue

     Read-only attribute returning a list of upcoming events in the
     order they will be run.  Each event is shown as a *note named
     tuple: a98. with the following fields: time, priority, action,
     argument, kwargs.


File: python.info,  Node: queue — A synchronized queue class,  Next: _thread — Low-level threading API,  Prev: sched — Event scheduler,  Up: Concurrent Execution

5.17.8 ‘queue’ — A synchronized queue class
-------------------------------------------

`Source code:' Lib/queue.py(1)

__________________________________________________________________

The *note queue: da. module implements multi-producer, multi-consumer
queues.  It is especially useful in threaded programming when
information must be exchanged safely between multiple threads.  The
*note Queue: d0b. class in this module implements all the required
locking semantics.

The module implements three types of queue, which differ only in the
order in which the entries are retrieved.  In a FIFO queue, the first
tasks added are the first retrieved.  In a LIFO queue, the most recently
added entry is the first retrieved (operating like a stack).  With a
priority queue, the entries are kept sorted (using the *note heapq: 8e.
module) and the lowest valued entry is retrieved first.

Internally, those three types of queues use locks to temporarily block
competing threads; however, they are not designed to handle reentrancy
within a thread.

In addition, the module implements a “simple” FIFO queue type, *note
SimpleQueue: 3bb, whose specific implementation provides additional
guarantees in exchange for the smaller functionality.

The *note queue: da. module defines the following classes and
exceptions:

 -- Class: queue.Queue (maxsize=0)

     Constructor for a FIFO queue.  `maxsize' is an integer that sets
     the upperbound limit on the number of items that can be placed in
     the queue.  Insertion will block once this size has been reached,
     until queue items are consumed.  If `maxsize' is less than or equal
     to zero, the queue size is infinite.

 -- Class: queue.LifoQueue (maxsize=0)

     Constructor for a LIFO queue.  `maxsize' is an integer that sets
     the upperbound limit on the number of items that can be placed in
     the queue.  Insertion will block once this size has been reached,
     until queue items are consumed.  If `maxsize' is less than or equal
     to zero, the queue size is infinite.

 -- Class: queue.PriorityQueue (maxsize=0)

     Constructor for a priority queue.  `maxsize' is an integer that
     sets the upperbound limit on the number of items that can be placed
     in the queue.  Insertion will block once this size has been
     reached, until queue items are consumed.  If `maxsize' is less than
     or equal to zero, the queue size is infinite.

     The lowest valued entries are retrieved first (the lowest valued
     entry is the one returned by ‘sorted(list(entries))[0]’).  A
     typical pattern for entries is a tuple in the form:
     ‘(priority_number, data)’.

     If the `data' elements are not comparable, the data can be wrapped
     in a class that ignores the data item and only compares the
     priority number:

          from dataclasses import dataclass, field from typing import Any  @dataclass(order=True) class PrioritizedItem:     priority: int     item: Any=field(compare=False)

 -- Class: queue.SimpleQueue

     Constructor for an unbounded FIFO queue.  Simple queues lack
     advanced functionality such as task tracking.

     New in version 3.7.

 -- Exception: queue.Empty

     Exception raised when non-blocking *note get(): 23ec. (or *note
     get_nowait(): 23ed.) is called on a *note Queue: d0b. object which
     is empty.

 -- Exception: queue.Full

     Exception raised when non-blocking *note put(): 23ee. (or *note
     put_nowait(): 23ef.) is called on a *note Queue: d0b. object which
     is full.

* Menu:

* Queue Objects::
* SimpleQueue Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/queue.py


File: python.info,  Node: Queue Objects,  Next: SimpleQueue Objects,  Up: queue — A synchronized queue class

5.17.8.1 Queue Objects
......................

Queue objects (*note Queue: d0b, *note LifoQueue: 23ea, or *note
PriorityQueue: 23eb.) provide the public methods described below.

 -- Method: Queue.qsize ()

     Return the approximate size of the queue.  Note, qsize() > 0
     doesn’t guarantee that a subsequent get() will not block, nor will
     qsize() < maxsize guarantee that put() will not block.

 -- Method: Queue.empty ()

     Return ‘True’ if the queue is empty, ‘False’ otherwise.  If empty()
     returns ‘True’ it doesn’t guarantee that a subsequent call to put()
     will not block.  Similarly, if empty() returns ‘False’ it doesn’t
     guarantee that a subsequent call to get() will not block.

 -- Method: Queue.full ()

     Return ‘True’ if the queue is full, ‘False’ otherwise.  If full()
     returns ‘True’ it doesn’t guarantee that a subsequent call to get()
     will not block.  Similarly, if full() returns ‘False’ it doesn’t
     guarantee that a subsequent call to put() will not block.

 -- Method: Queue.put (item, block=True, timeout=None)

     Put `item' into the queue.  If optional args `block' is true and
     `timeout' is ‘None’ (the default), block if necessary until a free
     slot is available.  If `timeout' is a positive number, it blocks at
     most `timeout' seconds and raises the *note Full: 22f9. exception
     if no free slot was available within that time.  Otherwise (`block'
     is false), put an item on the queue if a free slot is immediately
     available, else raise the *note Full: 22f9. exception (`timeout' is
     ignored in that case).

 -- Method: Queue.put_nowait (item)

     Equivalent to ‘put(item, False)’.

 -- Method: Queue.get (block=True, timeout=None)

     Remove and return an item from the queue.  If optional args `block'
     is true and `timeout' is ‘None’ (the default), block if necessary
     until an item is available.  If `timeout' is a positive number, it
     blocks at most `timeout' seconds and raises the *note Empty: 22f8.
     exception if no item was available within that time.  Otherwise
     (`block' is false), return an item if one is immediately available,
     else raise the *note Empty: 22f8. exception (`timeout' is ignored
     in that case).

     Prior to 3.0 on POSIX systems, and for all versions on Windows, if
     `block' is true and `timeout' is ‘None’, this operation goes into
     an uninterruptible wait on an underlying lock.  This means that no
     exceptions can occur, and in particular a SIGINT will not trigger a
     *note KeyboardInterrupt: 197.

 -- Method: Queue.get_nowait ()

     Equivalent to ‘get(False)’.

Two methods are offered to support tracking whether enqueued tasks have
been fully processed by daemon consumer threads.

 -- Method: Queue.task_done ()

     Indicate that a formerly enqueued task is complete.  Used by queue
     consumer threads.  For each *note get(): 23ec. used to fetch a
     task, a subsequent call to *note task_done(): 22f4. tells the queue
     that the processing on the task is complete.

     If a *note join(): 22f5. is currently blocking, it will resume when
     all items have been processed (meaning that a *note task_done():
     22f4. call was received for every item that had been *note put():
     23ee. into the queue).

     Raises a *note ValueError: 1f9. if called more times than there
     were items placed in the queue.

 -- Method: Queue.join ()

     Blocks until all items in the queue have been gotten and processed.

     The count of unfinished tasks goes up whenever an item is added to
     the queue.  The count goes down whenever a consumer thread calls
     *note task_done(): 22f4. to indicate that the item was retrieved
     and all work on it is complete.  When the count of unfinished tasks
     drops to zero, *note join(): 22f5. unblocks.

Example of how to wait for enqueued tasks to be completed:

     def worker():     while True:         item = q.get()         if item is None:             break         do_work(item)         q.task_done()  q = queue.Queue() threads = [] for i in range(num_worker_threads):     t = threading.Thread(target=worker)     t.start()     threads.append(t)  for item in source():     q.put(item)  # block until all tasks are done q.join()  # stop workers for i in range(num_worker_threads):     q.put(None) for t in threads:     t.join()


File: python.info,  Node: SimpleQueue Objects,  Prev: Queue Objects,  Up: queue — A synchronized queue class

5.17.8.2 SimpleQueue Objects
............................

*note SimpleQueue: 3bb. objects provide the public methods described
below.

 -- Method: SimpleQueue.qsize ()

     Return the approximate size of the queue.  Note, qsize() > 0
     doesn’t guarantee that a subsequent get() will not block.

 -- Method: SimpleQueue.empty ()

     Return ‘True’ if the queue is empty, ‘False’ otherwise.  If empty()
     returns ‘False’ it doesn’t guarantee that a subsequent call to
     get() will not block.

 -- Method: SimpleQueue.put (item, block=True, timeout=None)

     Put `item' into the queue.  The method never blocks and always
     succeeds (except for potential low-level errors such as failure to
     allocate memory).  The optional args `block' and `timeout' are
     ignored and only provided for compatibility with *note Queue.put():
     23ee.

     `CPython implementation detail:' This method has a C implementation
     which is reentrant.  That is, a ‘put()’ or ‘get()’ call can be
     interrupted by another ‘put()’ call in the same thread without
     deadlocking or corrupting internal state inside the queue.  This
     makes it appropriate for use in destructors such as ‘__del__’
     methods or *note weakref: 128. callbacks.

 -- Method: SimpleQueue.put_nowait (item)

     Equivalent to ‘put(item)’, provided for compatibility with *note
     Queue.put_nowait(): 23ef.

 -- Method: SimpleQueue.get (block=True, timeout=None)

     Remove and return an item from the queue.  If optional args `block'
     is true and `timeout' is ‘None’ (the default), block if necessary
     until an item is available.  If `timeout' is a positive number, it
     blocks at most `timeout' seconds and raises the *note Empty: 22f8.
     exception if no item was available within that time.  Otherwise
     (`block' is false), return an item if one is immediately available,
     else raise the *note Empty: 22f8. exception (`timeout' is ignored
     in that case).

 -- Method: SimpleQueue.get_nowait ()

     Equivalent to ‘get(False)’.

See also
........

Class *note multiprocessing.Queue: 22d3.

     A queue class for use in a multi-processing (rather than
     multi-threading) context.

*note collections.deque: 526. is an alternative implementation of
unbounded queues with fast atomic *note append(): 1869. and *note
popleft(): 186f. operations that do not require locking and also support
indexing.

The following are support modules for some of the above services:


File: python.info,  Node: _thread — Low-level threading API,  Next: _dummy_thread — Drop-in replacement for the _thread module,  Prev: queue — A synchronized queue class,  Up: Concurrent Execution

5.17.9 ‘_thread’ — Low-level threading API
------------------------------------------

__________________________________________________________________

This module provides low-level primitives for working with multiple
threads (also called `light-weight processes' or `tasks') — multiple
threads of control sharing their global data space.  For
synchronization, simple locks (also called `mutexes' or `binary
semaphores') are provided.  The *note threading: 109. module provides an
easier to use and higher-level threading API built on top of this
module.

Changed in version 3.7: This module used to be optional, it is now
always available.

This module defines the following constants and functions:

 -- Exception: _thread.error

     Raised on thread-specific errors.

     Changed in version 3.3: This is now a synonym of the built-in *note
     RuntimeError: 2b8.

 -- Data: _thread.LockType

     This is the type of lock objects.

 -- Function: _thread.start_new_thread (function, args[, kwargs])

     Start a new thread and return its identifier.  The thread executes
     the function `function' with the argument list `args' (which must
     be a tuple).  The optional `kwargs' argument specifies a dictionary
     of keyword arguments.

     When the function returns, the thread silently exits.

     When the function terminates with an unhandled exception, *note
     sys.unraisablehook(): 22b. is called to handle the exception.  The
     `object' attribute of the hook argument is `function'.  By default,
     a stack trace is printed and then the thread exits (but other
     threads continue to run).

     When the function raises a *note SystemExit: 5f1. exception, it is
     silently ignored.

     Changed in version 3.8: *note sys.unraisablehook(): 22b. is now
     used to handle unhandled exceptions.

 -- Function: _thread.interrupt_main ()

     Simulate the effect of a ‘signal.SIGINT’ signal arriving in the
     main thread.  A thread can use this function to interrupt the main
     thread.

     If ‘signal.SIGINT’ isn’t handled by Python (it was set to *note
     signal.SIG_DFL: 2401. or *note signal.SIG_IGN: 2402.), this
     function does nothing.

 -- Function: _thread.exit ()

     Raise the *note SystemExit: 5f1. exception.  When not caught, this
     will cause the thread to exit silently.

 -- Function: _thread.allocate_lock ()

     Return a new lock object.  Methods of locks are described below.
     The lock is initially unlocked.

 -- Function: _thread.get_ident ()

     Return the ‘thread identifier’ of the current thread.  This is a
     nonzero integer.  Its value has no direct meaning; it is intended
     as a magic cookie to be used e.g.  to index a dictionary of
     thread-specific data.  Thread identifiers may be recycled when a
     thread exits and another thread is created.

 -- Function: _thread.get_native_id ()

     Return the native integral Thread ID of the current thread assigned
     by the kernel.  This is a non-negative integer.  Its value may be
     used to uniquely identify this particular thread system-wide (until
     the thread terminates, after which the value may be recycled by the
     OS).

     *note Availability: 129a.: Windows, FreeBSD, Linux, macOS, OpenBSD,
     NetBSD, AIX.

     New in version 3.8.

 -- Function: _thread.stack_size ([size])

     Return the thread stack size used when creating new threads.  The
     optional `size' argument specifies the stack size to be used for
     subsequently created threads, and must be 0 (use platform or
     configured default) or a positive integer value of at least 32,768
     (32 KiB). If `size' is not specified, 0 is used.  If changing the
     thread stack size is unsupported, a *note RuntimeError: 2b8. is
     raised.  If the specified stack size is invalid, a *note
     ValueError: 1f9. is raised and the stack size is unmodified.  32
     KiB is currently the minimum supported stack size value to
     guarantee sufficient stack space for the interpreter itself.  Note
     that some platforms may have particular restrictions on values for
     the stack size, such as requiring a minimum stack size > 32 KiB or
     requiring allocation in multiples of the system memory page size -
     platform documentation should be referred to for more information
     (4 KiB pages are common; using multiples of 4096 for the stack size
     is the suggested approach in the absence of more specific
     information).

     *note Availability: 129a.: Windows, systems with POSIX threads.

 -- Data: _thread.TIMEOUT_MAX

     The maximum value allowed for the `timeout' parameter of
     ‘Lock.acquire()’.  Specifying a timeout greater than this value
     will raise an *note OverflowError: 954.

     New in version 3.2.

Lock objects have the following methods:

 -- Method: lock.acquire (waitflag=1, timeout=-1)

     Without any optional argument, this method acquires the lock
     unconditionally, if necessary waiting until it is released by
     another thread (only one thread at a time can acquire a lock —
     that’s their reason for existence).

     If the integer `waitflag' argument is present, the action depends
     on its value: if it is zero, the lock is only acquired if it can be
     acquired immediately without waiting, while if it is nonzero, the
     lock is acquired unconditionally as above.

     If the floating-point `timeout' argument is present and positive,
     it specifies the maximum wait time in seconds before returning.  A
     negative `timeout' argument specifies an unbounded wait.  You
     cannot specify a `timeout' if `waitflag' is zero.

     The return value is ‘True’ if the lock is acquired successfully,
     ‘False’ if not.

     Changed in version 3.2: The `timeout' parameter is new.

     Changed in version 3.2: Lock acquires can now be interrupted by
     signals on POSIX.

 -- Method: lock.release ()

     Releases the lock.  The lock must have been acquired earlier, but
     not necessarily by the same thread.

 -- Method: lock.locked ()

     Return the status of the lock: ‘True’ if it has been acquired by
     some thread, ‘False’ if not.

In addition to these methods, lock objects can also be used via the
*note with: 6dd. statement, e.g.:

     import _thread  a_lock = _thread.allocate_lock()  with a_lock:     print("a_lock is locked while this executes")

`Caveats:'

   * Threads interact strangely with interrupts: the *note
     KeyboardInterrupt: 197. exception will be received by an arbitrary
     thread.  (When the *note signal: ea. module is available,
     interrupts always go to the main thread.)

   * Calling *note sys.exit(): cd5. or raising the *note SystemExit:
     5f1. exception is equivalent to calling *note _thread.exit(): 2403.

   * It is not possible to interrupt the ‘acquire()’ method on a lock —
     the *note KeyboardInterrupt: 197. exception will happen after the
     lock has been acquired.

   * When the main thread exits, it is system defined whether the other
     threads survive.  On most systems, they are killed without
     executing *note try: d65. … *note finally: 182. clauses or
     executing object destructors.

   * When the main thread exits, it does not do any of its usual cleanup
     (except that *note try: d65. … *note finally: 182. clauses are
     honored), and the standard I/O files are not flushed.


File: python.info,  Node: _dummy_thread — Drop-in replacement for the _thread module,  Next: dummy_threading — Drop-in replacement for the threading module,  Prev: _thread — Low-level threading API,  Up: Concurrent Execution

5.17.10 ‘_dummy_thread’ — Drop-in replacement for the ‘_thread’ module
----------------------------------------------------------------------

`Source code:' Lib/_dummy_thread.py(1)

Deprecated since version 3.7: Python now always has threading enabled.
Please use *note _thread: 3. (or, better, *note threading: 109.)
instead.

__________________________________________________________________

This module provides a duplicate interface to the *note _thread: 3.
module.  It was meant to be imported when the *note _thread: 3. module
was not provided on a platform.

Be careful to not use this module where deadlock might occur from a
thread being created that blocks waiting for another thread to be
created.  This often occurs with blocking I/O.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/_dummy_thread.py


File: python.info,  Node: dummy_threading — Drop-in replacement for the threading module,  Prev: _dummy_thread — Drop-in replacement for the _thread module,  Up: Concurrent Execution

5.17.11 ‘dummy_threading’ — Drop-in replacement for the ‘threading’ module
--------------------------------------------------------------------------

`Source code:' Lib/dummy_threading.py(1)

Deprecated since version 3.7: Python now always has threading enabled.
Please use *note threading: 109. instead.

__________________________________________________________________

This module provides a duplicate interface to the *note threading: 109.
module.  It was meant to be imported when the *note _thread: 3. module
was not provided on a platform.

Be careful to not use this module where deadlock might occur from a
thread being created that blocks waiting for another thread to be
created.  This often occurs with blocking I/O.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/dummy_threading.py


File: python.info,  Node: contextvars — Context Variables,  Next: Networking and Interprocess Communication,  Prev: Concurrent Execution,  Up: The Python Standard Library

5.18 ‘contextvars’ — Context Variables
======================================

__________________________________________________________________

This module provides APIs to manage, store, and access context-local
state.  The *note ContextVar: 2412. class is used to declare and work
with `Context Variables'.  The *note copy_context(): 2413. function and
the *note Context: 2414. class should be used to manage the current
context in asynchronous frameworks.

Context managers that have state should use Context Variables instead of
*note threading.local(): 2236. to prevent their state from bleeding to
other code unexpectedly, when used in concurrent code.

See also PEP 567(1) for additional details.

New in version 3.7.

* Menu:

* Context Variables::
* Manual Context Management::
* asyncio support::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0567


File: python.info,  Node: Context Variables,  Next: Manual Context Management,  Up: contextvars — Context Variables

5.18.1 Context Variables
------------------------

 -- Class: contextvars.ContextVar (name[, *, default])

     This class is used to declare a new Context Variable, e.g.:

          var: ContextVar[int] = ContextVar('var', default=42)

     The required `name' parameter is used for introspection and debug
     purposes.

     The optional keyword-only `default' parameter is returned by *note
     ContextVar.get(): 2416. when no value for the variable is found in
     the current context.

     `Important:' Context Variables should be created at the top module
     level and never in closures.  *note Context: 2414. objects hold
     strong references to context variables which prevents context
     variables from being properly garbage collected.

      -- Attribute: name

          The name of the variable.  This is a read-only property.

          New in version 3.7.1.

      -- Method: get ([default])

          Return a value for the context variable for the current
          context.

          If there is no value for the variable in the current context,
          the method will:

             * return the value of the `default' argument of the method,
               if provided; or

             * return the default value for the context variable, if it
               was created with one; or

             * raise a *note LookupError: 1599.

      -- Method: set (value)

          Call to set a new value for the context variable in the
          current context.

          The required `value' argument is the new value for the context
          variable.

          Returns a *note Token: 2419. object that can be used to
          restore the variable to its previous value via the *note
          ContextVar.reset(): 241a. method.

      -- Method: reset (token)

          Reset the context variable to the value it had before the
          *note ContextVar.set(): 2418. that created the `token' was
          used.

          For example:

               var = ContextVar('var')  token = var.set('new value') # code that uses 'var'; var.get() returns 'new value'. var.reset(token)  # After the reset call the var has no value again, so # var.get() would raise a LookupError.

 -- Class: contextvars.Token

     `Token' objects are returned by the *note ContextVar.set(): 2418.
     method.  They can be passed to the *note ContextVar.reset(): 241a.
     method to revert the value of the variable to what it was before
     the corresponding `set'.

      -- Attribute: Token.var

          A read-only property.  Points to the *note ContextVar: 2412.
          object that created the token.

      -- Attribute: Token.old_value

          A read-only property.  Set to the value the variable had
          before the *note ContextVar.set(): 2418. method call that
          created the token.  It points to ‘Token.MISSING’ is the
          variable was not set before the call.

      -- Attribute: Token.MISSING

          A marker object used by ‘Token.old_value’.


File: python.info,  Node: Manual Context Management,  Next: asyncio support,  Prev: Context Variables,  Up: contextvars — Context Variables

5.18.2 Manual Context Management
--------------------------------

 -- Function: contextvars.copy_context ()

     Returns a copy of the current *note Context: 2414. object.

     The following snippet gets a copy of the current context and prints
     all variables and their values that are set in it:

          ctx: Context = copy_context() print(list(ctx.items()))

     The function has an O(1) complexity, i.e.  works equally fast for
     contexts with a few context variables and for contexts that have a
     lot of them.

 -- Class: contextvars.Context

     A mapping of *note ContextVars: 2412. to their values.

     ‘Context()’ creates an empty context with no values in it.  To get
     a copy of the current context use the *note copy_context(): 2413.
     function.

     Context implements the *note collections.abc.Mapping: 187d.
     interface.

      -- Method: run (callable, *args, **kwargs)

          Execute ‘callable(*args, **kwargs)’ code in the context object
          the `run' method is called on.  Return the result of the
          execution or propagate an exception if one occurred.

          Any changes to any context variables that `callable' makes
          will be contained in the context object:

               var = ContextVar('var') var.set('spam')  def main():     # 'var' was set to 'spam' before     # calling 'copy_context()' and 'ctx.run(main)', so:     # var.get() == ctx[var] == 'spam'      var.set('ham')      # Now, after setting 'var' to 'ham':     # var.get() == ctx[var] == 'ham'  ctx = copy_context()  # Any changes that the 'main' function makes to 'var' # will be contained in 'ctx'. ctx.run(main)  # The 'main()' function was run in the 'ctx' context, # so changes to 'var' are contained in it: # ctx[var] == 'ham'  # However, outside of 'ctx', 'var' is still set to 'spam': # var.get() == 'spam'

          The method raises a *note RuntimeError: 2b8. when called on
          the same context object from more than one OS thread, or when
          called recursively.

      -- Method: copy ()

          Return a shallow copy of the context object.

      -- Describe: var in context

          Return ‘True’ if the `context' has a value for `var' set;
          return ‘False’ otherwise.

      -- Describe: context[var]

          Return the value of the `var' *note ContextVar: 2412.
          variable.  If the variable is not set in the context object, a
          *note KeyError: 2c5. is raised.

      -- Method: get (var[, default])

          Return the value for `var' if `var' has the value in the
          context object.  Return `default' otherwise.  If `default' is
          not given, return ‘None’.

      -- Describe: iter(context)

          Return an iterator over the variables stored in the context
          object.

      -- Describe: len(proxy)

          Return the number of variables set in the context object.

      -- Method: keys ()

          Return a list of all variables in the context object.

      -- Method: values ()

          Return a list of all variables’ values in the context object.

      -- Method: items ()

          Return a list of 2-tuples containing all variables and their
          values in the context object.


File: python.info,  Node: asyncio support,  Prev: Manual Context Management,  Up: contextvars — Context Variables

5.18.3 asyncio support
----------------------

Context variables are natively supported in *note asyncio: a. and are
ready to be used without any extra configuration.  For example, here is
a simple echo server, that uses a context variable to make the address
of a remote client available in the Task that handles that client:

     import asyncio import contextvars  client_addr_var = contextvars.ContextVar('client_addr')  def render_goodbye():     # The address of the currently handled client can be accessed     # without passing it explicitly to this function.      client_addr = client_addr_var.get()     return f'Good bye, client @ {client_addr}\n'.encode()  async def handle_request(reader, writer):     addr = writer.transport.get_extra_info('socket').getpeername()     client_addr_var.set(addr)      # In any code that we call is now possible to get     # client's address by calling 'client_addr_var.get()'.      while True:         line = await reader.readline()         print(line)         if not line.strip():             break         writer.write(line)      writer.write(render_goodbye())     writer.close()  async def main():     srv = await asyncio.start_server(         handle_request, '127.0.0.1', 8081)      async with srv:         await srv.serve_forever()  asyncio.run(main())  # To test it you can use telnet: #     telnet 127.0.0.1 8081


File: python.info,  Node: Networking and Interprocess Communication,  Next: Internet Data Handling,  Prev: contextvars — Context Variables,  Up: The Python Standard Library

5.19 Networking and Interprocess Communication
==============================================

The modules described in this chapter provide mechanisms for networking
and inter-processes communication.

Some modules only work for two processes that are on the same machine,
e.g.  *note signal: ea. and *note mmap: b3.  Other modules support
networking protocols that two or more processes can use to communicate
across machines.

The list of modules described in this chapter is:

* Menu:

* asyncio — Asynchronous I/O::
* socket — Low-level networking interface::
* ssl — TLS/SSL wrapper for socket objects::
* select — Waiting for I/O completion::
* selectors — High-level I/O multiplexing::
* asyncore — Asynchronous socket handler::
* asynchat — Asynchronous socket command/response handler::
* signal — Set handlers for asynchronous events::
* mmap — Memory-mapped file support::


File: python.info,  Node: asyncio — Asynchronous I/O,  Next: socket — Low-level networking interface,  Up: Networking and Interprocess Communication

5.19.1 ‘asyncio’ — Asynchronous I/O
-----------------------------------

__________________________________________________________________

Hello World!
............

     import asyncio  async def main():     print('Hello ...')     await asyncio.sleep(1)     print('... World!')  # Python 3.7+ asyncio.run(main())

asyncio is a library to write `concurrent' code using the `async/await'
syntax.

asyncio is used as a foundation for multiple Python asynchronous
frameworks that provide high-performance network and web-servers,
database connection libraries, distributed task queues, etc.

asyncio is often a perfect fit for IO-bound and high-level `structured'
network code.

asyncio provides a set of `high-level' APIs to:

   * *note run Python coroutines: 242b. concurrently and have full
     control over their execution;

   * perform *note network IO and IPC: 242c.;

   * control *note subprocesses: 242d.;

   * distribute tasks via *note queues: 242e.;

   * *note synchronize: 242f. concurrent code;

Additionally, there are `low-level' APIs for `library and framework
developers' to:

   * create and manage *note event loops: 638, which provide
     asynchronous APIs for *note networking: 352, running *note
     subprocesses: 2430, handling *note OS signals: 2431, etc;

   * implement efficient protocols using *note transports: 2432.;

   * *note bridge: 2433. callback-based libraries and code with
     async/await syntax.

Reference
.........

* Menu:

* Coroutines and Tasks::
* Streams::
* Synchronization Primitives::
* Subprocesses::
* Queues::
* Exceptions: Exceptions<9>.
* Event Loop::
* Futures::
* Transports and Protocols::
* Policies::
* Platform Support::
* High-level API Index::
* Low-level API Index::
* Developing with asyncio::


File: python.info,  Node: Coroutines and Tasks,  Next: Streams,  Up: asyncio — Asynchronous I/O

5.19.1.1 Coroutines and Tasks
.............................

This section outlines high-level asyncio APIs to work with coroutines
and Tasks.

* Menu:

* Coroutines: Coroutines<3>.
* Awaitables::
* Running an asyncio Program::
* Creating Tasks::
* Sleeping::
* Running Tasks Concurrently::
* Shielding From Cancellation::
* Timeouts::
* Waiting Primitives::
* Scheduling From Other Threads::
* Introspection::
* Task Object::
* Generator-based Coroutines::


File: python.info,  Node: Coroutines<3>,  Next: Awaitables,  Up: Coroutines and Tasks

5.19.1.2 Coroutines
...................

*note Coroutines: 1a5. declared with the async/await syntax is the
preferred way of writing asyncio applications.  For example, the
following snippet of code (requires Python 3.7+) prints “hello”, waits 1
second, and then prints “world”:

     >>> import asyncio  >>> async def main(): ...     print('hello') ...     await asyncio.sleep(1) ...     print('world')  >>> asyncio.run(main()) hello world

Note that simply calling a coroutine will not schedule it to be
executed:

     >>> main() <coroutine object main at 0x1053bb7c8>

To actually run a coroutine, asyncio provides three main mechanisms:

   * The *note asyncio.run(): 1a4. function to run the top-level entry
     point “main()” function (see the above example.)

   * Awaiting on a coroutine.  The following snippet of code will print
     “hello” after waiting for 1 second, and then print “world” after
     waiting for `another' 2 seconds:

          import asyncio import time  async def say_after(delay, what):     await asyncio.sleep(delay)     print(what)  async def main():     print(f"started at {time.strftime('%X')}")      await say_after(1, 'hello')     await say_after(2, 'world')      print(f"finished at {time.strftime('%X')}")  asyncio.run(main())

     Expected output:

          started at 17:13:52 hello world finished at 17:13:55

   * The *note asyncio.create_task(): 1ac. function to run coroutines
     concurrently as asyncio *note Tasks: 1ab.

     Let’s modify the above example and run two ‘say_after’ coroutines
     `concurrently':

          async def main():     task1 = asyncio.create_task(         say_after(1, 'hello'))      task2 = asyncio.create_task(         say_after(2, 'world'))      print(f"started at {time.strftime('%X')}")      # Wait until both tasks are completed (should take     # around 2 seconds.)     await task1     await task2      print(f"finished at {time.strftime('%X')}")

     Note that expected output now shows that the snippet runs 1 second
     faster than before:

          started at 17:14:32 hello world finished at 17:14:34


File: python.info,  Node: Awaitables,  Next: Running an asyncio Program,  Prev: Coroutines<3>,  Up: Coroutines and Tasks

5.19.1.3 Awaitables
...................

We say that an object is an `awaitable' object if it can be used in an
*note await: 1a2. expression.  Many asyncio APIs are designed to accept
awaitables.

There are three main types of `awaitable' objects: `coroutines',
`Tasks', and `Futures'.

Coroutines
..........

Python coroutines are `awaitables' and therefore can be awaited from
other coroutines:

     import asyncio  async def nested():     return 42  async def main():     # Nothing happens if we just call "nested()".     # A coroutine object is created but not awaited,     # so it *won't run at all*.     nested()      # Let's do it differently now and await it:     print(await nested())  # will print "42".  asyncio.run(main())

     Important: In this documentation the term “coroutine” can be used
     for two closely related concepts:

        * a `coroutine function': an *note async def: 282. function;

        * a `coroutine object': an object returned by calling a
          `coroutine function'.

asyncio also supports legacy *note generator-based: 2439. coroutines.

Tasks
.....

`Tasks' are used to schedule coroutines `concurrently'.

When a coroutine is wrapped into a `Task' with functions like *note
asyncio.create_task(): 1ac. the coroutine is automatically scheduled to
run soon:

     import asyncio  async def nested():     return 42  async def main():     # Schedule nested() to run soon concurrently     # with "main()".     task = asyncio.create_task(nested())      # "task" can now be used to cancel "nested()", or     # can simply be awaited to wait until it is complete:     await task  asyncio.run(main())

Futures
.......

A *note Future: 438. is a special `low-level' awaitable object that
represents an `eventual result' of an asynchronous operation.

When a Future object is `awaited' it means that the coroutine will wait
until the Future is resolved in some other place.

Future objects in asyncio are needed to allow callback-based code to be
used with async/await.

Normally `there is no need' to create Future objects at the application
level code.

Future objects, sometimes exposed by libraries and some asyncio APIs,
can be awaited:

     async def main():     await function_that_returns_a_future_object()      # this is also valid:     await asyncio.gather(         function_that_returns_a_future_object(),         some_python_coroutine()     )

A good example of a low-level function that returns a Future object is
*note loop.run_in_executor(): 243a.


File: python.info,  Node: Running an asyncio Program,  Next: Creating Tasks,  Prev: Awaitables,  Up: Coroutines and Tasks

5.19.1.4 Running an asyncio Program
...................................

 -- Function: asyncio.run (coro, *, debug=False)

     Execute the *note coroutine: 1a5. `coro' and return the result.

     This function runs the passed coroutine, taking care of managing
     the asyncio event loop and `finalizing asynchronous generators'.

     This function cannot be called when another asyncio event loop is
     running in the same thread.

     If `debug' is ‘True’, the event loop will be run in debug mode.

     This function always creates a new event loop and closes it at the
     end.  It should be used as a main entry point for asyncio programs,
     and should ideally only be called once.

     Example:

          async def main():     await asyncio.sleep(1)     print('hello')  asyncio.run(main())

     New in version 3.7.

          Note: The source code for ‘asyncio.run()’ can be found in
          Lib/asyncio/runners.py(1).

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncio/runners.py


File: python.info,  Node: Creating Tasks,  Next: Sleeping,  Prev: Running an asyncio Program,  Up: Coroutines and Tasks

5.19.1.5 Creating Tasks
.......................

 -- Function: asyncio.create_task (coro, *, name=None)

     Wrap the `coro' *note coroutine: 242b. into a *note Task: 1ab. and
     schedule its execution.  Return the Task object.

     If `name' is not ‘None’, it is set as the name of the task using
     *note Task.set_name(): 1ae.

     The task is executed in the loop returned by *note
     get_running_loop(): 349, *note RuntimeError: 2b8. is raised if
     there is no running loop in current thread.

     This function has been `added in Python 3.7'.  Prior to Python 3.7,
     the low-level *note asyncio.ensure_future(): 50c. function can be
     used instead:

          async def coro():     ...  # In Python 3.7+ task = asyncio.create_task(coro()) ...  # This works in all Python versions but is less readable task = asyncio.ensure_future(coro()) ...

     New in version 3.7.

     Changed in version 3.8: Added the ‘name’ parameter.


File: python.info,  Node: Sleeping,  Next: Running Tasks Concurrently,  Prev: Creating Tasks,  Up: Coroutines and Tasks

5.19.1.6 Sleeping
.................

 -- Function: coroutine asyncio.sleep (delay, result=None, *, loop=None)

     Block for `delay' seconds.

     If `result' is provided, it is returned to the caller when the
     coroutine completes.

     ‘sleep()’ always suspends the current task, allowing other tasks to
     run.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     Example of coroutine displaying the current date every second for 5
     seconds:

          import asyncio import datetime  async def display_date():     loop = asyncio.get_running_loop()     end_time = loop.time() + 5.0     while True:         print(datetime.datetime.now())         if (loop.time() + 1.0) >= end_time:             break         await asyncio.sleep(1)  asyncio.run(display_date())


File: python.info,  Node: Running Tasks Concurrently,  Next: Shielding From Cancellation,  Prev: Sleeping,  Up: Coroutines and Tasks

5.19.1.7 Running Tasks Concurrently
...................................

 -- Function: awaitable asyncio.gather (*aws, loop=None,
          return_exceptions=False)

     Run *note awaitable objects: 2437. in the `aws' sequence
     `concurrently'.

     If any awaitable in `aws' is a coroutine, it is automatically
     scheduled as a Task.

     If all awaitables are completed successfully, the result is an
     aggregate list of returned values.  The order of result values
     corresponds to the order of awaitables in `aws'.

     If `return_exceptions' is ‘False’ (default), the first raised
     exception is immediately propagated to the task that awaits on
     ‘gather()’.  Other awaitables in the `aws' sequence `won’t be
     cancelled' and will continue to run.

     If `return_exceptions' is ‘True’, exceptions are treated the same
     as successful results, and aggregated in the result list.

     If ‘gather()’ is `cancelled', all submitted awaitables (that have
     not completed yet) are also `cancelled'.

     If any Task or Future from the `aws' sequence is `cancelled', it is
     treated as if it raised *note CancelledError: 1a6. – the ‘gather()’
     call is `not' cancelled in this case.  This is to prevent the
     cancellation of one submitted Task/Future to cause other
     Tasks/Futures to be cancelled.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     Example:

          import asyncio  async def factorial(name, number):     f = 1     for i in range(2, number + 1):         print(f"Task {name}: Compute factorial({i})...")         await asyncio.sleep(1)         f *= i     print(f"Task {name}: factorial({number}) = {f}")  async def main():     # Schedule three calls *concurrently*:     await asyncio.gather(         factorial("A", 2),         factorial("B", 3),         factorial("C", 4),     )  asyncio.run(main())  # Expected output: # #     Task A: Compute factorial(2)... #     Task B: Compute factorial(2)... #     Task C: Compute factorial(2)... #     Task A: factorial(2) = 2 #     Task B: Compute factorial(3)... #     Task C: Compute factorial(3)... #     Task B: factorial(3) = 6 #     Task C: Compute factorial(4)... #     Task C: factorial(4) = 24

     Changed in version 3.7: If the `gather' itself is cancelled, the
     cancellation is propagated regardless of `return_exceptions'.


File: python.info,  Node: Shielding From Cancellation,  Next: Timeouts,  Prev: Running Tasks Concurrently,  Up: Coroutines and Tasks

5.19.1.8 Shielding From Cancellation
....................................

 -- Function: awaitable asyncio.shield (aw, *, loop=None)

     Protect an *note awaitable object: 2437. from being *note
     cancelled: 2442.

     If `aw' is a coroutine it is automatically scheduled as a Task.

     The statement:

          res = await shield(something())

     is equivalent to:

          res = await something()

     `except' that if the coroutine containing it is cancelled, the Task
     running in ‘something()’ is not cancelled.  From the point of view
     of ‘something()’, the cancellation did not happen.  Although its
     caller is still cancelled, so the “await” expression still raises a
     *note CancelledError: 1a6.

     If ‘something()’ is cancelled by other means (i.e.  from within
     itself) that would also cancel ‘shield()’.

     If it is desired to completely ignore cancellation (not
     recommended) the ‘shield()’ function should be combined with a
     try/except clause, as follows:

          try:     res = await shield(something()) except CancelledError:     res = None

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.


File: python.info,  Node: Timeouts,  Next: Waiting Primitives,  Prev: Shielding From Cancellation,  Up: Coroutines and Tasks

5.19.1.9 Timeouts
.................

 -- Function: coroutine asyncio.wait_for (aw, timeout, *, loop=None)

     Wait for the `aw' *note awaitable: 2437. to complete with a
     timeout.

     If `aw' is a coroutine it is automatically scheduled as a Task.

     `timeout' can either be ‘None’ or a float or int number of seconds
     to wait for.  If `timeout' is ‘None’, block until the future
     completes.

     If a timeout occurs, it cancels the task and raises *note
     asyncio.TimeoutError: 2444.

     To avoid the task *note cancellation: 2442, wrap it in *note
     shield(): 285.

     The function will wait until the future is actually cancelled, so
     the total wait time may exceed the `timeout'.

     If the wait is cancelled, the future `aw' is also cancelled.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     Example:

          async def eternity():     # Sleep for one hour     await asyncio.sleep(3600)     print('yay!')  async def main():     # Wait for at most 1 second     try:         await asyncio.wait_for(eternity(), timeout=1.0)     except asyncio.TimeoutError:         print('timeout!')  asyncio.run(main())  # Expected output: # #     timeout!

     Changed in version 3.7: When `aw' is cancelled due to a timeout,
     ‘wait_for’ waits for `aw' to be cancelled.  Previously, it raised
     *note asyncio.TimeoutError: 2444. immediately.


File: python.info,  Node: Waiting Primitives,  Next: Scheduling From Other Threads,  Prev: Timeouts,  Up: Coroutines and Tasks

5.19.1.10 Waiting Primitives
............................

 -- Function: coroutine asyncio.wait (aws, *, loop=None, timeout=None,
          return_when=ALL_COMPLETED)

     Run *note awaitable objects: 2437. in the `aws' set concurrently
     and block until the condition specified by `return_when'.

     Returns two sets of Tasks/Futures: ‘(done, pending)’.

     Usage:

          done, pending = await asyncio.wait(aws)

     `timeout' (a float or int), if specified, can be used to control
     the maximum number of seconds to wait before returning.

     Note that this function does not raise *note asyncio.TimeoutError:
     2444.  Futures or Tasks that aren’t done when the timeout occurs
     are simply returned in the second set.

     `return_when' indicates when this function should return.  It must
     be one of the following constants:

     Constant                          Description
                                       
     -------------------------------------------------------------------------------
                                       
     ‘FIRST_COMPLETED’                 The function will return when any future
                                       finishes or is cancelled.
                                       
                                       
     ‘FIRST_EXCEPTION’                 The function will return when any future
                                       finishes by raising an exception.  If no
                                       future raises an exception then it is
                                       equivalent to ‘ALL_COMPLETED’.
                                       
                                       
     ‘ALL_COMPLETED’                   The function will return when all futures
                                       finish or are cancelled.
                                       

     Unlike *note wait_for(): 286, ‘wait()’ does not cancel the futures
     when a timeout occurs.

     Deprecated since version 3.8: If any awaitable in `aws' is a
     coroutine, it is automatically scheduled as a Task.  Passing
     coroutines objects to ‘wait()’ directly is deprecated as it leads
     to *note confusing behavior: 2447.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

          Note: ‘wait()’ schedules coroutines as Tasks automatically and
          later returns those implicitly created Task objects in ‘(done,
          pending)’ sets.  Therefore the following code won’t work as
          expected:

               async def foo():     return 42  coro = foo() done, pending = await asyncio.wait({coro})  if coro in done:     # This branch will never be run!

          Here is how the above snippet can be fixed:

               async def foo():     return 42  task = asyncio.create_task(foo()) done, pending = await asyncio.wait({task})  if task in done:     # Everything will work as expected now.

     Deprecated since version 3.8: Passing coroutine objects to ‘wait()’
     directly is deprecated.

 -- Function: asyncio.as_completed (aws, *, loop=None, timeout=None)

     Run *note awaitable objects: 2437. in the `aws' set concurrently.
     Return an iterator of *note Future: 438. objects.  Each Future
     object returned represents the earliest result from the set of the
     remaining awaitables.

     Raises *note asyncio.TimeoutError: 2444. if the timeout occurs
     before all Futures are done.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     Example:

          for f in as_completed(aws):     earliest_result = await f     # ...


File: python.info,  Node: Scheduling From Other Threads,  Next: Introspection,  Prev: Waiting Primitives,  Up: Coroutines and Tasks

5.19.1.11 Scheduling From Other Threads
.......................................

 -- Function: asyncio.run_coroutine_threadsafe (coro, loop)

     Submit a coroutine to the given event loop.  Thread-safe.

     Return a *note concurrent.futures.Future: b20. to wait for the
     result from another OS thread.

     This function is meant to be called from a different OS thread than
     the one where the event loop is running.  Example:

          # Create a coroutine coro = asyncio.sleep(1, result=3)  # Submit the coroutine to a given loop future = asyncio.run_coroutine_threadsafe(coro, loop)  # Wait for the result with an optional timeout argument assert future.result(timeout) == 3

     If an exception is raised in the coroutine, the returned Future
     will be notified.  It can also be used to cancel the task in the
     event loop:

          try:     result = future.result(timeout) except asyncio.TimeoutError:     print('The coroutine took too long, cancelling the task...')     future.cancel() except Exception as exc:     print(f'The coroutine raised an exception: {exc!r}') else:     print(f'The coroutine returned: {result!r}')

     See the *note concurrency and multithreading: 2449. section of the
     documentation.

     Unlike other asyncio functions this function requires the `loop'
     argument to be passed explicitly.

     New in version 3.5.1.


File: python.info,  Node: Introspection,  Next: Task Object,  Prev: Scheduling From Other Threads,  Up: Coroutines and Tasks

5.19.1.12 Introspection
.......................

 -- Function: asyncio.current_task (loop=None)

     Return the currently running *note Task: 1ab. instance, or ‘None’
     if no task is running.

     If `loop' is ‘None’ *note get_running_loop(): 349. is used to get
     the current loop.

     New in version 3.7.

 -- Function: asyncio.all_tasks (loop=None)

     Return a set of not yet finished *note Task: 1ab. objects run by
     the loop.

     If `loop' is ‘None’, *note get_running_loop(): 349. is used for
     getting current loop.

     New in version 3.7.


File: python.info,  Node: Task Object,  Next: Generator-based Coroutines,  Prev: Introspection,  Up: Coroutines and Tasks

5.19.1.13 Task Object
.....................

 -- Class: asyncio.Task (coro, *, loop=None, name=None)

     A *note Future-like: 438. object that runs a Python *note
     coroutine: 242b.  Not thread-safe.

     Tasks are used to run coroutines in event loops.  If a coroutine
     awaits on a Future, the Task suspends the execution of the
     coroutine and waits for the completion of the Future.  When the
     Future is `done', the execution of the wrapped coroutine resumes.

     Event loops use cooperative scheduling: an event loop runs one Task
     at a time.  While a Task awaits for the completion of a Future, the
     event loop runs other Tasks, callbacks, or performs IO operations.

     Use the high-level *note asyncio.create_task(): 1ac. function to
     create Tasks, or the low-level *note loop.create_task(): 1ad. or
     *note ensure_future(): 50c. functions.  Manual instantiation of
     Tasks is discouraged.

     To cancel a running Task use the *note cancel(): 2442. method.
     Calling it will cause the Task to throw a *note CancelledError:
     1a6. exception into the wrapped coroutine.  If a coroutine is
     awaiting on a Future object during cancellation, the Future object
     will be cancelled.

     *note cancelled(): 244c. can be used to check if the Task was
     cancelled.  The method returns ‘True’ if the wrapped coroutine did
     not suppress the *note CancelledError: 1a6. exception and was
     actually cancelled.

     *note asyncio.Task: 1ab. inherits from *note Future: 438. all of
     its APIs except *note Future.set_result(): 244d. and *note
     Future.set_exception(): 244e.

     Tasks support the *note contextvars: 25. module.  When a Task is
     created it copies the current context and later runs its coroutine
     in the copied context.

     Changed in version 3.7: Added support for the *note contextvars:
     25. module.

     Changed in version 3.8: Added the ‘name’ parameter.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

      -- Method: cancel ()

          Request the Task to be cancelled.

          This arranges for a *note CancelledError: 1a6. exception to be
          thrown into the wrapped coroutine on the next cycle of the
          event loop.

          The coroutine then has a chance to clean up or even deny the
          request by suppressing the exception with a *note try: d65. …
          … ‘except CancelledError’ … *note finally: 182. block.
          Therefore, unlike *note Future.cancel(): 244f, *note
          Task.cancel(): 2442. does not guarantee that the Task will be
          cancelled, although suppressing cancellation completely is not
          common and is actively discouraged.  The following example
          illustrates how coroutines can intercept the cancellation
          request:

               async def cancel_me():     print('cancel_me(): before sleep')      try:         # Wait for 1 hour         await asyncio.sleep(3600)     except asyncio.CancelledError:         print('cancel_me(): cancel sleep')         raise     finally:         print('cancel_me(): after sleep')  async def main():     # Create a "cancel_me" Task     task = asyncio.create_task(cancel_me())      # Wait for 1 second     await asyncio.sleep(1)      task.cancel()     try:         await task     except asyncio.CancelledError:         print("main(): cancel_me is cancelled now")  asyncio.run(main())  # Expected output: # #     cancel_me(): before sleep #     cancel_me(): cancel sleep #     cancel_me(): after sleep #     main(): cancel_me is cancelled now

      -- Method: cancelled ()

          Return ‘True’ if the Task is `cancelled'.

          The Task is `cancelled' when the cancellation was requested
          with *note cancel(): 2442. and the wrapped coroutine
          propagated the *note CancelledError: 1a6. exception thrown
          into it.

      -- Method: done ()

          Return ‘True’ if the Task is `done'.

          A Task is `done' when the wrapped coroutine either returned a
          value, raised an exception, or the Task was cancelled.

      -- Method: result ()

          Return the result of the Task.

          If the Task is `done', the result of the wrapped coroutine is
          returned (or if the coroutine raised an exception, that
          exception is re-raised.)

          If the Task has been `cancelled', this method raises a *note
          CancelledError: 1a6. exception.

          If the Task’s result isn’t yet available, this method raises a
          *note InvalidStateError: 2453. exception.

      -- Method: exception ()

          Return the exception of the Task.

          If the wrapped coroutine raised an exception that exception is
          returned.  If the wrapped coroutine returned normally this
          method returns ‘None’.

          If the Task has been `cancelled', this method raises a *note
          CancelledError: 1a6. exception.

          If the Task isn’t `done' yet, this method raises an *note
          InvalidStateError: 2453. exception.

      -- Method: add_done_callback (callback, *, context=None)

          Add a callback to be run when the Task is `done'.

          This method should only be used in low-level callback-based
          code.

          See the documentation of *note Future.add_done_callback():
          342. for more details.

      -- Method: remove_done_callback (callback)

          Remove `callback' from the callbacks list.

          This method should only be used in low-level callback-based
          code.

          See the documentation of *note Future.remove_done_callback():
          2457. for more details.

      -- Method: get_stack (*, limit=None)

          Return the list of stack frames for this Task.

          If the wrapped coroutine is not done, this returns the stack
          where it is suspended.  If the coroutine has completed
          successfully or was cancelled, this returns an empty list.  If
          the coroutine was terminated by an exception, this returns the
          list of traceback frames.

          The frames are always ordered from oldest to newest.

          Only one stack frame is returned for a suspended coroutine.

          The optional `limit' argument sets the maximum number of
          frames to return; by default all available frames are
          returned.  The ordering of the returned list differs depending
          on whether a stack or a traceback is returned: the newest
          frames of a stack are returned, but the oldest frames of a
          traceback are returned.  (This matches the behavior of the
          traceback module.)

      -- Method: print_stack (*, limit=None, file=None)

          Print the stack or traceback for this Task.

          This produces output similar to that of the traceback module
          for the frames retrieved by *note get_stack(): 2458.

          The `limit' argument is passed to *note get_stack(): 2458.
          directly.

          The `file' argument is an I/O stream to which the output is
          written; by default output is written to *note sys.stderr:
          304.

      -- Method: get_coro ()

          Return the coroutine object wrapped by the *note Task: 1ab.

          New in version 3.8.

      -- Method: get_name ()

          Return the name of the Task.

          If no name has been explicitly assigned to the Task, the
          default asyncio Task implementation generates a default name
          during instantiation.

          New in version 3.8.

      -- Method: set_name (value)

          Set the name of the Task.

          The `value' argument can be any object, which is then
          converted to a string.

          In the default Task implementation, the name will be visible
          in the *note repr(): 7c0. output of a task object.

          New in version 3.8.

      -- Class Method: all_tasks (loop=None)

          Return a set of all tasks for an event loop.

          By default all tasks for the current event loop are returned.
          If `loop' is ‘None’, the *note get_event_loop(): 34a. function
          is used to get the current loop.

          Deprecated since version 3.7, will be removed in version 3.9:
          Do not call this as a task method.  Use the *note
          asyncio.all_tasks(): 346. function instead.

      -- Class Method: current_task (loop=None)

          Return the currently running task or ‘None’.

          If `loop' is ‘None’, the *note get_event_loop(): 34a. function
          is used to get the current loop.

          Deprecated since version 3.7, will be removed in version 3.9:
          Do not call this as a task method.  Use the *note
          asyncio.current_task(): 345. function instead.


File: python.info,  Node: Generator-based Coroutines,  Prev: Task Object,  Up: Coroutines and Tasks

5.19.1.14 Generator-based Coroutines
....................................

     Note: Support for generator-based coroutines is `deprecated' and is
     scheduled for removal in Python 3.10.

Generator-based coroutines predate async/await syntax.  They are Python
generators that use ‘yield from’ expressions to await on Futures and
other coroutines.

Generator-based coroutines should be decorated with *note
@asyncio.coroutine: 280, although this is not enforced.

 -- Function: @asyncio.coroutine

     Decorator to mark generator-based coroutines.

     This decorator enables legacy generator-based coroutines to be
     compatible with async/await code:

          @asyncio.coroutine def old_style_coroutine():     yield from asyncio.sleep(1)  async def main():     await old_style_coroutine()

     This decorator should not be used for *note async def: 282.
     coroutines.

     Deprecated since version 3.8, will be removed in version 3.10: Use
     *note async def: 282. instead.

 -- Function: asyncio.iscoroutine (obj)

     Return ‘True’ if `obj' is a *note coroutine object: 242b.

     This method is different from *note inspect.iscoroutine(): 6eb.
     because it returns ‘True’ for generator-based coroutines.

 -- Function: asyncio.iscoroutinefunction (func)

     Return ‘True’ if `func' is a *note coroutine function: 242b.

     This method is different from *note inspect.iscoroutinefunction():
     6ec. because it returns ‘True’ for generator-based coroutine
     functions decorated with *note @coroutine: 280.


File: python.info,  Node: Streams,  Next: Synchronization Primitives,  Prev: Coroutines and Tasks,  Up: asyncio — Asynchronous I/O

5.19.1.15 Streams
.................

`Source code:' Lib/asyncio/streams.py(1)

__________________________________________________________________

Streams are high-level async/await-ready primitives to work with network
connections.  Streams allow sending and receiving data without using
callbacks or low-level protocols and transports.  Here is an example of
a TCP echo client written using asyncio streams:

     import asyncio  async def tcp_echo_client(message):     reader, writer = await asyncio.open_connection(         '127.0.0.1', 8888)      print(f'Send: {message!r}')     writer.write(message.encode())     await writer.drain()      data = await reader.read(100)     print(f'Received: {data.decode()!r}')      print('Close the connection')     writer.close()     await writer.wait_closed()  asyncio.run(tcp_echo_client('Hello World!'))

See also the *note Examples: 2460. section below.

Stream Functions
................

The following top-level asyncio functions can be used to create and work
with streams:

 -- Function: coroutine asyncio.open_connection (host=None, port=None,
          *, loop=None, limit=None, ssl=None, family=0, proto=0,
          flags=0, sock=None, local_addr=None, server_hostname=None,
          ssl_handshake_timeout=None)

     Establish a network connection and return a pair of ‘(reader,
     writer)’ objects.

     The returned `reader' and `writer' objects are instances of *note
     StreamReader: efc. and *note StreamWriter: efd. classes.

     The `loop' argument is optional and can always be determined
     automatically when this function is awaited from a coroutine.

     `limit' determines the buffer size limit used by the returned *note
     StreamReader: efc. instance.  By default the `limit' is set to 64
     KiB.

     The rest of the arguments are passed directly to *note
     loop.create_connection(): 1b0.

     New in version 3.7: The `ssl_handshake_timeout' parameter.

 -- Function: coroutine asyncio.start_server (client_connected_cb,
          host=None, port=None, *, loop=None, limit=None,
          family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None,
          backlog=100, ssl=None, reuse_address=None, reuse_port=None,
          ssl_handshake_timeout=None, start_serving=True)

     Start a socket server.

     The `client_connected_cb' callback is called whenever a new client
     connection is established.  It receives a ‘(reader, writer)’ pair
     as two arguments, instances of the *note StreamReader: efc. and
     *note StreamWriter: efd. classes.

     `client_connected_cb' can be a plain callable or a *note coroutine
     function: 242b.; if it is a coroutine function, it will be
     automatically scheduled as a *note Task: 1ab.

     The `loop' argument is optional and can always be determined
     automatically when this method is awaited from a coroutine.

     `limit' determines the buffer size limit used by the returned *note
     StreamReader: efc. instance.  By default the `limit' is set to 64
     KiB.

     The rest of the arguments are passed directly to *note
     loop.create_server(): 352.

     New in version 3.7: The `ssl_handshake_timeout' and `start_serving'
     parameters.

Unix Sockets
............

 -- Function: coroutine asyncio.open_unix_connection (path=None, *,
          loop=None, limit=None, ssl=None, sock=None,
          server_hostname=None, ssl_handshake_timeout=None)

     Establish a Unix socket connection and return a pair of ‘(reader,
     writer)’.

     Similar to *note open_connection(): 358. but operates on Unix
     sockets.

     See also the documentation of *note loop.create_unix_connection():
     2462.

     *note Availability: 129a.: Unix.

     New in version 3.7: The `ssl_handshake_timeout' parameter.

     Changed in version 3.7: The `path' parameter can now be a *note
     path-like object: 35f.

 -- Function: coroutine asyncio.start_unix_server (client_connected_cb,
          path=None, *, loop=None, limit=None, sock=None, backlog=100,
          ssl=None, ssl_handshake_timeout=None, start_serving=True)

     Start a Unix socket server.

     Similar to *note start_server(): 359. but works with Unix sockets.

     See also the documentation of *note loop.create_unix_server(): 353.

     *note Availability: 129a.: Unix.

     New in version 3.7: The `ssl_handshake_timeout' and `start_serving'
     parameters.

     Changed in version 3.7: The `path' parameter can now be a *note
     path-like object: 35f.

* Menu:

* StreamReader::
* StreamWriter::
* Examples: Examples<11>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncio/streams.py


File: python.info,  Node: StreamReader,  Next: StreamWriter,  Up: Streams

5.19.1.16 StreamReader
......................

 -- Class: asyncio.StreamReader

     Represents a reader object that provides APIs to read data from the
     IO stream.

     It is not recommended to instantiate `StreamReader' objects
     directly; use *note open_connection(): 358. and *note
     start_server(): 359. instead.

      -- Method: coroutine read (n=-1)

          Read up to `n' bytes.  If `n' is not provided, or set to ‘-1’,
          read until EOF and return all read bytes.

          If EOF was received and the internal buffer is empty, return
          an empty ‘bytes’ object.

      -- Method: coroutine readline ()

          Read one line, where “line” is a sequence of bytes ending with
          ‘\n’.

          If EOF is received and ‘\n’ was not found, the method returns
          partially read data.

          If EOF is received and the internal buffer is empty, return an
          empty ‘bytes’ object.

      -- Method: coroutine readexactly (n)

          Read exactly `n' bytes.

          Raise an *note IncompleteReadError: 2467. if EOF is reached
          before `n' can be read.  Use the *note
          IncompleteReadError.partial: 2468. attribute to get the
          partially read data.

      -- Method: coroutine readuntil (separator=b'\n')

          Read data from the stream until `separator' is found.

          On success, the data and separator will be removed from the
          internal buffer (consumed).  Returned data will include the
          separator at the end.

          If the amount of data read exceeds the configured stream
          limit, a *note LimitOverrunError: 2469. exception is raised,
          and the data is left in the internal buffer and can be read
          again.

          If EOF is reached before the complete separator is found, an
          *note IncompleteReadError: 2467. exception is raised, and the
          internal buffer is reset.  The *note
          IncompleteReadError.partial: 2468. attribute may contain a
          portion of the separator.

          New in version 3.5.2.

      -- Method: at_eof ()

          Return ‘True’ if the buffer is empty and ‘feed_eof()’ was
          called.


File: python.info,  Node: StreamWriter,  Next: Examples<11>,  Prev: StreamReader,  Up: Streams

5.19.1.17 StreamWriter
......................

 -- Class: asyncio.StreamWriter

     Represents a writer object that provides APIs to write data to the
     IO stream.

     It is not recommended to instantiate `StreamWriter' objects
     directly; use *note open_connection(): 358. and *note
     start_server(): 359. instead.

      -- Method: write (data)

          The method attempts to write the `data' to the underlying
          socket immediately.  If that fails, the data is queued in an
          internal write buffer until it can be sent.

          The method should be used along with the ‘drain()’ method:

               stream.write(data) await stream.drain()

      -- Method: writelines (data)

          The method writes a list (or any iterable) of bytes to the
          underlying socket immediately.  If that fails, the data is
          queued in an internal write buffer until it can be sent.

          The method should be used along with the ‘drain()’ method:

               stream.writelines(lines) await stream.drain()

      -- Method: close ()

          The method closes the stream and the underlying socket.

          The method should be used along with the ‘wait_closed()’
          method:

               stream.close() await stream.wait_closed()

      -- Method: can_write_eof ()

          Return ‘True’ if the underlying transport supports the *note
          write_eof(): 2470. method, ‘False’ otherwise.

      -- Method: write_eof ()

          Close the write end of the stream after the buffered write
          data is flushed.

      -- Attribute: transport

          Return the underlying asyncio transport.

      -- Method: get_extra_info (name, default=None)

          Access optional transport information; see *note
          BaseTransport.get_extra_info(): 2c6. for details.

      -- Method: coroutine drain ()

          Wait until it is appropriate to resume writing to the stream.
          Example:

               writer.write(data) await writer.drain()

          This is a flow control method that interacts with the
          underlying IO write buffer.  When the size of the buffer
          reaches the high watermark, `drain()' blocks until the size of
          the buffer is drained down to the low watermark and writing
          can be resumed.  When there is nothing to wait for, the *note
          drain(): 2473. returns immediately.

      -- Method: is_closing ()

          Return ‘True’ if the stream is closed or in the process of
          being closed.

          New in version 3.7.

      -- Method: coroutine wait_closed ()

          Wait until the stream is closed.

          Should be called after *note close(): 246e. to wait until the
          underlying connection is closed.

          New in version 3.7.


File: python.info,  Node: Examples<11>,  Prev: StreamWriter,  Up: Streams

5.19.1.18 Examples
..................

* Menu:

* TCP echo client using streams::
* TCP echo server using streams::
* Get HTTP headers::
* Register an open socket to wait for data using streams::


File: python.info,  Node: TCP echo client using streams,  Next: TCP echo server using streams,  Up: Examples<11>

5.19.1.19 TCP echo client using streams
.......................................

TCP echo client using the *note asyncio.open_connection(): 358.
function:

     import asyncio  async def tcp_echo_client(message):     reader, writer = await asyncio.open_connection(         '127.0.0.1', 8888)      print(f'Send: {message!r}')     writer.write(message.encode())      data = await reader.read(100)     print(f'Received: {data.decode()!r}')      print('Close the connection')     writer.close()  asyncio.run(tcp_echo_client('Hello World!'))

See also
........

The *note TCP echo client protocol: 2476. example uses the low-level
*note loop.create_connection(): 1b0. method.


File: python.info,  Node: TCP echo server using streams,  Next: Get HTTP headers,  Prev: TCP echo client using streams,  Up: Examples<11>

5.19.1.20 TCP echo server using streams
.......................................

TCP echo server using the *note asyncio.start_server(): 359. function:

     import asyncio  async def handle_echo(reader, writer):     data = await reader.read(100)     message = data.decode()     addr = writer.get_extra_info('peername')      print(f"Received {message!r} from {addr!r}")      print(f"Send: {message!r}")     writer.write(data)     await writer.drain()      print("Close the connection")     writer.close()  async def main():     server = await asyncio.start_server(         handle_echo, '127.0.0.1', 8888)      addr = server.sockets[0].getsockname()     print(f'Serving on {addr}')      async with server:         await server.serve_forever()  asyncio.run(main())

See also
........

The *note TCP echo server protocol: 2479. example uses the *note
loop.create_server(): 352. method.


File: python.info,  Node: Get HTTP headers,  Next: Register an open socket to wait for data using streams,  Prev: TCP echo server using streams,  Up: Examples<11>

5.19.1.21 Get HTTP headers
..........................

Simple example querying HTTP headers of the URL passed on the command
line:

     import asyncio import urllib.parse import sys  async def print_http_headers(url):     url = urllib.parse.urlsplit(url)     if url.scheme == 'https':         reader, writer = await asyncio.open_connection(             url.hostname, 443, ssl=True)     else:         reader, writer = await asyncio.open_connection(             url.hostname, 80)      query = (         f"HEAD {url.path or '/'} HTTP/1.0\r\n"         f"Host: {url.hostname}\r\n"         f"\r\n"     )      writer.write(query.encode('latin-1'))     while True:         line = await reader.readline()         if not line:             break          line = line.decode('latin1').rstrip()         if line:             print(f'HTTP header> {line}')      # Ignore the body, close the socket     writer.close()  url = sys.argv[1] asyncio.run(print_http_headers(url))

Usage:

     python example.py http://example.com/path/page.html

or with HTTPS:

     python example.py https://example.com/path/page.html


File: python.info,  Node: Register an open socket to wait for data using streams,  Prev: Get HTTP headers,  Up: Examples<11>

5.19.1.22 Register an open socket to wait for data using streams
................................................................

Coroutine waiting until a socket receives data using the *note
open_connection(): 358. function:

     import asyncio import socket  async def wait_for_data():     # Get a reference to the current event loop because     # we want to access low-level APIs.     loop = asyncio.get_running_loop()      # Create a pair of connected sockets.     rsock, wsock = socket.socketpair()      # Register the open socket to wait for data.     reader, writer = await asyncio.open_connection(sock=rsock)      # Simulate the reception of data from the network     loop.call_soon(wsock.send, 'abc'.encode())      # Wait for data     data = await reader.read(100)      # Got data, we are done: close the socket     print("Received:", data.decode())     writer.close()      # Close the second socket     wsock.close()  asyncio.run(wait_for_data())

See also
........

The *note register an open socket to wait for data using a protocol:
247d. example uses a low-level protocol and the *note
loop.create_connection(): 1b0. method.

The *note watch a file descriptor for read events: 247e. example uses
the low-level *note loop.add_reader(): 247f. method to watch a file
descriptor.


File: python.info,  Node: Synchronization Primitives,  Next: Subprocesses,  Prev: Streams,  Up: asyncio — Asynchronous I/O

5.19.1.23 Synchronization Primitives
....................................

`Source code:' Lib/asyncio/locks.py(1)

__________________________________________________________________

asyncio synchronization primitives are designed to be similar to those
of the *note threading: 109. module with two important caveats:

   * asyncio primitives are not thread-safe, therefore they should not
     be used for OS thread synchronization (use *note threading: 109.
     for that);

   * methods of these synchronization primitives do not accept the
     `timeout' argument; use the *note asyncio.wait_for(): 286. function
     to perform operations with timeouts.

asyncio has the following basic synchronization primitives:

   * *note Lock: 289.

   * *note Event: 28a.

   * *note Condition: 28b.

   * *note Semaphore: 28c.

   * *note BoundedSemaphore: 28d.

__________________________________________________________________

* Menu:

* Lock::
* Event::
* Condition::
* Semaphore::
* BoundedSemaphore::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncio/locks.py


File: python.info,  Node: Lock,  Next: Event,  Up: Synchronization Primitives

5.19.1.24 Lock
..............

 -- Class: asyncio.Lock (*, loop=None)

     Implements a mutex lock for asyncio tasks.  Not thread-safe.

     An asyncio lock can be used to guarantee exclusive access to a
     shared resource.

     The preferred way to use a Lock is an *note async with: 637.
     statement:

          lock = asyncio.Lock()  # ... later async with lock:     # access shared state

     which is equivalent to:

          lock = asyncio.Lock()  # ... later await lock.acquire() try:     # access shared state finally:     lock.release()

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

      -- Method: coroutine acquire ()

          Acquire the lock.

          This method waits until the lock is `unlocked', sets it to
          `locked' and returns ‘True’.

          When more than one coroutine is blocked in *note acquire():
          2483. waiting for the lock to be unlocked, only one coroutine
          eventually proceeds.

          Acquiring a lock is `fair': the coroutine that proceeds will
          be the first coroutine that started waiting on the lock.

      -- Method: release ()

          Release the lock.

          When the lock is `locked', reset it to `unlocked' and return.

          If the lock is `unlocked', a *note RuntimeError: 2b8. is
          raised.

      -- Method: locked ()

          Return ‘True’ if the lock is `locked'.


File: python.info,  Node: Event,  Next: Condition,  Prev: Lock,  Up: Synchronization Primitives

5.19.1.25 Event
...............

 -- Class: asyncio.Event (*, loop=None)

     An event object.  Not thread-safe.

     An asyncio event can be used to notify multiple asyncio tasks that
     some event has happened.

     An Event object manages an internal flag that can be set to `true'
     with the *note set(): b62. method and reset to `false' with the
     *note clear(): 2487. method.  The *note wait(): 287. method blocks
     until the flag is set to `true'.  The flag is set to `false'
     initially.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     Example:

          async def waiter(event):     print('waiting for it ...')     await event.wait()     print('... got it!')  async def main():     # Create an Event object.     event = asyncio.Event()      # Spawn a Task to wait until 'event' is set.     waiter_task = asyncio.create_task(waiter(event))      # Sleep for 1 second and set the event.     await asyncio.sleep(1)     event.set()      # Wait until the waiter task is finished.     await waiter_task  asyncio.run(main())

      -- Method: coroutine wait ()

          Wait until the event is set.

          If the event is set, return ‘True’ immediately.  Otherwise
          block until another task calls *note set(): b62.

      -- Method: set ()

          Set the event.

          All tasks waiting for event to be set will be immediately
          awakened.

      -- Method: clear ()

          Clear (unset) the event.

          Tasks awaiting on *note wait(): 287. will now block until the
          *note set(): b62. method is called again.

      -- Method: is_set ()

          Return ‘True’ if the event is set.


File: python.info,  Node: Condition,  Next: Semaphore,  Prev: Event,  Up: Synchronization Primitives

5.19.1.26 Condition
...................

 -- Class: asyncio.Condition (lock=None, *, loop=None)

     A Condition object.  Not thread-safe.

     An asyncio condition primitive can be used by a task to wait for
     some event to happen and then get exclusive access to a shared
     resource.

     In essence, a Condition object combines the functionality of an
     *note Event: 28a. and a *note Lock: 289.  It is possible to have
     multiple Condition objects share one Lock, which allows
     coordinating exclusive access to a shared resource between
     different tasks interested in particular states of that shared
     resource.

     The optional `lock' argument must be a *note Lock: 289. object or
     ‘None’.  In the latter case a new Lock object is created
     automatically.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     The preferred way to use a Condition is an *note async with: 637.
     statement:

          cond = asyncio.Condition()  # ... later async with cond:     await cond.wait()

     which is equivalent to:

          cond = asyncio.Condition()  # ... later await cond.acquire() try:     await cond.wait() finally:     cond.release()

      -- Method: coroutine acquire ()

          Acquire the underlying lock.

          This method waits until the underlying lock is `unlocked',
          sets it to `locked' and returns ‘True’.

      -- Method: notify (n=1)

          Wake up at most `n' tasks (1 by default) waiting on this
          condition.  The method is no-op if no tasks are waiting.

          The lock must be acquired before this method is called and
          released shortly after.  If called with an `unlocked' lock a
          *note RuntimeError: 2b8. error is raised.

      -- Method: locked ()

          Return ‘True’ if the underlying lock is acquired.

      -- Method: notify_all ()

          Wake up all tasks waiting on this condition.

          This method acts like *note notify(): 248e, but wakes up all
          waiting tasks.

          The lock must be acquired before this method is called and
          released shortly after.  If called with an `unlocked' lock a
          *note RuntimeError: 2b8. error is raised.

      -- Method: release ()

          Release the underlying lock.

          When invoked on an unlocked lock, a *note RuntimeError: 2b8.
          is raised.

      -- Method: coroutine wait ()

          Wait until notified.

          If the calling task has not acquired the lock when this method
          is called, a *note RuntimeError: 2b8. is raised.

          This method releases the underlying lock, and then blocks
          until it is awakened by a *note notify(): 248e. or *note
          notify_all(): 2490. call.  Once awakened, the Condition
          re-acquires its lock and this method returns ‘True’.

      -- Method: coroutine wait_for (predicate)

          Wait until a predicate becomes `true'.

          The predicate must be a callable which result will be
          interpreted as a boolean value.  The final value is the return
          value.


File: python.info,  Node: Semaphore,  Next: BoundedSemaphore,  Prev: Condition,  Up: Synchronization Primitives

5.19.1.27 Semaphore
...................

 -- Class: asyncio.Semaphore (value=1, *, loop=None)

     A Semaphore object.  Not thread-safe.

     A semaphore manages an internal counter which is decremented by
     each *note acquire(): 2495. call and incremented by each *note
     release(): 2496. call.  The counter can never go below zero; when
     *note acquire(): 2495. finds that it is zero, it blocks, waiting
     until some task calls *note release(): 2496.

     The optional `value' argument gives the initial value for the
     internal counter (‘1’ by default).  If the given value is less than
     ‘0’ a *note ValueError: 1f9. is raised.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     The preferred way to use a Semaphore is an *note async with: 637.
     statement:

          sem = asyncio.Semaphore(10)  # ... later async with sem:     # work with shared resource

     which is equivalent to:

          sem = asyncio.Semaphore(10)  # ... later await sem.acquire() try:     # work with shared resource finally:     sem.release()

      -- Method: coroutine acquire ()

          Acquire a semaphore.

          If the internal counter is greater than zero, decrement it by
          one and return ‘True’ immediately.  If it is zero, wait until
          a *note release(): 2496. is called and return ‘True’.

      -- Method: locked ()

          Returns ‘True’ if semaphore can not be acquired immediately.

      -- Method: release ()

          Release a semaphore, incrementing the internal counter by one.
          Can wake up a task waiting to acquire the semaphore.

          Unlike *note BoundedSemaphore: 28d, *note Semaphore: 28c.
          allows making more ‘release()’ calls than ‘acquire()’ calls.


File: python.info,  Node: BoundedSemaphore,  Prev: Semaphore,  Up: Synchronization Primitives

5.19.1.28 BoundedSemaphore
..........................

 -- Class: asyncio.BoundedSemaphore (value=1, *, loop=None)

     A bounded semaphore object.  Not thread-safe.

     Bounded Semaphore is a version of *note Semaphore: 28c. that raises
     a *note ValueError: 1f9. in *note release(): 2496. if it increases
     the internal counter above the initial `value'.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

__________________________________________________________________

Deprecated since version 3.7: Acquiring a lock using ‘await lock’ or
‘yield from lock’ and/or *note with: 6dd. statement (‘with await lock’,
‘with (yield from lock)’) is deprecated.  Use ‘async with lock’ instead.


File: python.info,  Node: Subprocesses,  Next: Queues,  Prev: Synchronization Primitives,  Up: asyncio — Asynchronous I/O

5.19.1.29 Subprocesses
......................

`Source code:' Lib/asyncio/subprocess.py(1),
Lib/asyncio/base_subprocess.py(2)

__________________________________________________________________

This section describes high-level async/await asyncio APIs to create and
manage subprocesses.  Here’s an example of how asyncio can run a shell
command and obtain its result:

     import asyncio  async def run(cmd):     proc = await asyncio.create_subprocess_shell(         cmd,         stdout=asyncio.subprocess.PIPE,         stderr=asyncio.subprocess.PIPE)      stdout, stderr = await proc.communicate()      print(f'[{cmd!r} exited with {proc.returncode}]')     if stdout:         print(f'[stdout]\n{stdout.decode()}')     if stderr:         print(f'[stderr]\n{stderr.decode()}')  asyncio.run(run('ls /zzz'))

will print:

     ['ls /zzz' exited with 1] [stderr] ls: /zzz: No such file or directory

Because all asyncio subprocess functions are asynchronous and asyncio
provides many tools to work with such functions, it is easy to execute
and monitor multiple subprocesses in parallel.  It is indeed trivial to
modify the above example to run several commands simultaneously:

     async def main():     await asyncio.gather(         run('ls /zzz'),         run('sleep 1; echo "hello"'))  asyncio.run(main())

See also the *note Examples: 249c. subsection.

* Menu:

* Creating Subprocesses::
* Constants: Constants<7>.
* Interacting with Subprocesses::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/subprocess.py

   (2) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/base_subprocess.py


File: python.info,  Node: Creating Subprocesses,  Next: Constants<7>,  Up: Subprocesses

5.19.1.30 Creating Subprocesses
...............................

 -- Function: coroutine asyncio.create_subprocess_exec (program, *args,
          stdin=None, stdout=None, stderr=None, loop=None, limit=None,
          **kwds)

     Create a subprocess.

     The `limit' argument sets the buffer limit for *note StreamReader:
     efc. wrappers for ‘Process.stdout’ and ‘Process.stderr’ (if *note
     subprocess.PIPE: 3e3. is passed to `stdout' and `stderr'
     arguments).

     Return a *note Process: 249e. instance.

     See the documentation of *note loop.subprocess_exec(): 2430. for
     other parameters.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

 -- Function: coroutine asyncio.create_subprocess_shell (cmd,
          stdin=None, stdout=None, stderr=None, loop=None, limit=None,
          **kwds)

     Run the `cmd' shell command.

     The `limit' argument sets the buffer limit for *note StreamReader:
     efc. wrappers for ‘Process.stdout’ and ‘Process.stderr’ (if *note
     subprocess.PIPE: 3e3. is passed to `stdout' and `stderr'
     arguments).

     Return a *note Process: 249e. instance.

     See the documentation of *note loop.subprocess_shell(): 249f. for
     other parameters.

     Important: It is the application’s responsibility to ensure that
     all whitespace and special characters are quoted appropriately to
     avoid shell injection(1) vulnerabilities.  The *note shlex.quote():
     a68. function can be used to properly escape whitespace and special
     shell characters in strings that are going to be used to construct
     shell commands.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     Note: The default asyncio event loop implementation on `Windows'
     does not support subprocesses.  Subprocesses are available for
     Windows if a *note ProactorEventLoop: 1a9. is used.  See *note
     Subprocess Support on Windows: 24a0. for details.

See also
........

asyncio also has the following `low-level' APIs to work with
subprocesses: *note loop.subprocess_exec(): 2430, *note
loop.subprocess_shell(): 249f, *note loop.connect_read_pipe(): 24a1,
*note loop.connect_write_pipe(): 24a2, as well as the *note Subprocess
Transports: 24a3. and *note Subprocess Protocols: 24a4.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Shell_injection#Shell_injection


File: python.info,  Node: Constants<7>,  Next: Interacting with Subprocesses,  Prev: Creating Subprocesses,  Up: Subprocesses

5.19.1.31 Constants
...................

 -- Data: asyncio.subprocess.PIPE

     Can be passed to the `stdin', `stdout' or `stderr' parameters.

     If `PIPE' is passed to `stdin' argument, the *note Process.stdin:
     24a7. attribute will point to a *note StreamWriter: efd. instance.

     If `PIPE' is passed to `stdout' or `stderr' arguments, the *note
     Process.stdout: 24a8. and *note Process.stderr: 24a9. attributes
     will point to *note StreamReader: efc. instances.

 -- Data: asyncio.subprocess.STDOUT

     Special value that can be used as the `stderr' argument and
     indicates that standard error should be redirected into standard
     output.

 -- Data: asyncio.subprocess.DEVNULL

     Special value that can be used as the `stdin', `stdout' or `stderr'
     argument to process creation functions.  It indicates that the
     special file *note os.devnull: f52. will be used for the
     corresponding subprocess stream.


File: python.info,  Node: Interacting with Subprocesses,  Prev: Constants<7>,  Up: Subprocesses

5.19.1.32 Interacting with Subprocesses
.......................................

Both *note create_subprocess_exec(): 28f. and *note
create_subprocess_shell(): 290. functions return instances of the
`Process' class.  `Process' is a high-level wrapper that allows
communicating with subprocesses and watching for their completion.

 -- Class: asyncio.subprocess.Process

     An object that wraps OS processes created by the *note
     create_subprocess_exec(): 28f. and *note create_subprocess_shell():
     290. functions.

     This class is designed to have a similar API to the *note
     subprocess.Popen: 2b7. class, but there are some notable
     differences:

        * unlike Popen, Process instances do not have an equivalent to
          the *note poll(): 23c2. method;

        * the *note communicate(): 24ad. and *note wait(): 24ae. methods
          don’t have a `timeout' parameter: use the *note wait_for():
          286. function;

        * the *note Process.wait(): 24ae. method is asynchronous,
          whereas *note subprocess.Popen.wait(): 587. method is
          implemented as a blocking busy loop;

        * the `universal_newlines' parameter is not supported.

     This class is *note not thread safe: 2449.

     See also the *note Subprocess and Threads: 24af. section.

      -- Method: coroutine wait ()

          Wait for the child process to terminate.

          Set and return the *note returncode: 24b0. attribute.

               Note: This method can deadlock when using ‘stdout=PIPE’
               or ‘stderr=PIPE’ and the child process generates so much
               output that it blocks waiting for the OS pipe buffer to
               accept more data.  Use the *note communicate(): 24ad.
               method when using pipes to avoid this condition.

      -- Method: coroutine communicate (input=None)

          Interact with process:

            1. send data to `stdin' (if `input' is not ‘None’);

            2. read data from `stdout' and `stderr', until EOF is
               reached;

            3. wait for process to terminate.

          The optional `input' argument is the data (*note bytes: 326.
          object) that will be sent to the child process.

          Return a tuple ‘(stdout_data, stderr_data)’.

          If either *note BrokenPipeError: 991. or *note
          ConnectionResetError: 994. exception is raised when writing
          `input' into `stdin', the exception is ignored.  This
          condition occurs when the process exits before all data are
          written into `stdin'.

          If it is desired to send data to the process’ `stdin', the
          process needs to be created with ‘stdin=PIPE’.  Similarly, to
          get anything other than ‘None’ in the result tuple, the
          process has to be created with ‘stdout=PIPE’ and/or
          ‘stderr=PIPE’ arguments.

          Note, that the data read is buffered in memory, so do not use
          this method if the data size is large or unlimited.

      -- Method: send_signal (signal)

          Sends the signal `signal' to the child process.

               Note: On Windows, ‘SIGTERM’ is an alias for *note
               terminate(): 24b2.  ‘CTRL_C_EVENT’ and ‘CTRL_BREAK_EVENT’
               can be sent to processes started with a `creationflags'
               parameter which includes ‘CREATE_NEW_PROCESS_GROUP’.

      -- Method: terminate ()

          Stop the child process.

          On POSIX systems this method sends ‘signal.SIGTERM’ to the
          child process.

          On Windows the Win32 API function ‘TerminateProcess()’ is
          called to stop the child process.

      -- Method: kill ()

          Kill the child.

          On POSIX systems this method sends ‘SIGKILL’ to the child
          process.

          On Windows this method is an alias for *note terminate():
          24b2.

      -- Attribute: stdin

          Standard input stream (*note StreamWriter: efd.) or ‘None’ if
          the process was created with ‘stdin=None’.

      -- Attribute: stdout

          Standard output stream (*note StreamReader: efc.) or ‘None’ if
          the process was created with ‘stdout=None’.

      -- Attribute: stderr

          Standard error stream (*note StreamReader: efc.) or ‘None’ if
          the process was created with ‘stderr=None’.

          Warning: Use the *note communicate(): 24ad. method rather than
          *note process.stdin.write(): 24a7, *note await
          process.stdout.read(): 24a8. or *note await
          process.stderr.read: 24a9.  This avoids deadlocks due to
          streams pausing reading or writing and blocking the child
          process.

      -- Attribute: pid

          Process identification number (PID).

          Note that for processes created by the *note
          create_subprocess_shell(): 290. function, this attribute is
          the PID of the spawned shell.

      -- Attribute: returncode

          Return code of the process when it exits.

          A ‘None’ value indicates that the process has not terminated
          yet.

          A negative value ‘-N’ indicates that the child was terminated
          by signal ‘N’ (POSIX only).

* Menu:

* Subprocess and Threads::
* Examples: Examples<12>.


File: python.info,  Node: Subprocess and Threads,  Next: Examples<12>,  Up: Interacting with Subprocesses

5.19.1.33 Subprocess and Threads
................................

Standard asyncio event loop supports running subprocesses from different
threads by default.

On Windows subprocesses are provided by *note ProactorEventLoop: 1a9.
only (default), *note SelectorEventLoop: 24b6. has no subprocess
support.

On UNIX `child watchers' are used for subprocess finish waiting, see
*note Process Watchers: 24b7. for more info.

Changed in version 3.8: UNIX switched to use *note ThreadedChildWatcher:
24b8. for spawning subprocesses from different threads without any
limitation.

Spawning a subprocess with `inactive' current child watcher raises *note
RuntimeError: 2b8.

Note that alternative event loop implementations might have own
limitations; please refer to their documentation.

See also
........

The *note Concurrency and multithreading in asyncio: 2449. section.


File: python.info,  Node: Examples<12>,  Prev: Subprocess and Threads,  Up: Interacting with Subprocesses

5.19.1.34 Examples
..................

An example using the *note Process: 249e. class to control a subprocess
and the *note StreamReader: efc. class to read from its standard output.
The subprocess is created by the *note create_subprocess_exec(): 28f.
function:

     import asyncio import sys  async def get_date():     code = 'import datetime; print(datetime.datetime.now())'      # Create the subprocess; redirect the standard output     # into a pipe.     proc = await asyncio.create_subprocess_exec(         sys.executable, '-c', code,         stdout=asyncio.subprocess.PIPE)      # Read one line of output.     data = await proc.stdout.readline()     line = data.decode('ascii').rstrip()      # Wait for the subprocess exit.     await proc.wait()     return line  date = asyncio.run(get_date()) print(f"Current date: {date}")

See also the *note same example: 24ba. written using low-level APIs.


File: python.info,  Node: Queues,  Next: Exceptions<9>,  Prev: Subprocesses,  Up: asyncio — Asynchronous I/O

5.19.1.35 Queues
................

`Source code:' Lib/asyncio/queues.py(1)

__________________________________________________________________

asyncio queues are designed to be similar to classes of the *note queue:
da. module.  Although asyncio queues are not thread-safe, they are
designed to be used specifically in async/await code.

Note that methods of asyncio queues don’t have a `timeout' parameter;
use *note asyncio.wait_for(): 286. function to do queue operations with
a timeout.

See also the *note Examples: 24bd. section below.

* Menu:

* Queue::
* Priority Queue::
* LIFO Queue::
* Exceptions: Exceptions<8>.
* Examples: Examples<13>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncio/queues.py


File: python.info,  Node: Queue,  Next: Priority Queue,  Up: Queues

5.19.1.36 Queue
...............

 -- Class: asyncio.Queue (maxsize=0, *, loop=None)

     A first in, first out (FIFO) queue.

     If `maxsize' is less than or equal to zero, the queue size is
     infinite.  If it is an integer greater than ‘0’, then ‘await put()’
     blocks when the queue reaches `maxsize' until an item is removed by
     *note get(): 24bf.

     Unlike the standard library threading *note queue: da, the size of
     the queue is always known and can be returned by calling the *note
     qsize(): 24c0. method.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `loop' parameter.

     This class is *note not thread safe: 2449.

      -- Attribute: maxsize

          Number of items allowed in the queue.

      -- Method: empty ()

          Return ‘True’ if the queue is empty, ‘False’ otherwise.

      -- Method: full ()

          Return ‘True’ if there are *note maxsize: 24c1. items in the
          queue.

          If the queue was initialized with ‘maxsize=0’ (the default),
          then *note full(): 24c3. never returns ‘True’.

      -- Method: coroutine get ()

          Remove and return an item from the queue.  If queue is empty,
          wait until an item is available.

      -- Method: get_nowait ()

          Return an item if one is immediately available, else raise
          *note QueueEmpty: 24c5.

      -- Method: coroutine join ()

          Block until all items in the queue have been received and
          processed.

          The count of unfinished tasks goes up whenever an item is
          added to the queue.  The count goes down whenever a consumer
          coroutine calls *note task_done(): 694. to indicate that the
          item was retrieved and all work on it is complete.  When the
          count of unfinished tasks drops to zero, *note join(): 693.
          unblocks.

      -- Method: coroutine put (item)

          Put an item into the queue.  If the queue is full, wait until
          a free slot is available before adding the item.

      -- Method: put_nowait (item)

          Put an item into the queue without blocking.

          If no free slot is immediately available, raise *note
          QueueFull: 24c8.

      -- Method: qsize ()

          Return the number of items in the queue.

      -- Method: task_done ()

          Indicate that a formerly enqueued task is complete.

          Used by queue consumers.  For each *note get(): 24bf. used to
          fetch a task, a subsequent call to *note task_done(): 694.
          tells the queue that the processing on the task is complete.

          If a *note join(): 693. is currently blocking, it will resume
          when all items have been processed (meaning that a *note
          task_done(): 694. call was received for every item that had
          been *note put(): 24c6. into the queue).

          Raises *note ValueError: 1f9. if called more times than there
          were items placed in the queue.


File: python.info,  Node: Priority Queue,  Next: LIFO Queue,  Prev: Queue,  Up: Queues

5.19.1.37 Priority Queue
........................

 -- Class: asyncio.PriorityQueue

     A variant of *note Queue: 28e.; retrieves entries in priority order
     (lowest first).

     Entries are typically tuples of the form ‘(priority_number, data)’.


File: python.info,  Node: LIFO Queue,  Next: Exceptions<8>,  Prev: Priority Queue,  Up: Queues

5.19.1.38 LIFO Queue
....................

 -- Class: asyncio.LifoQueue

     A variant of *note Queue: 28e. that retrieves most recently added
     entries first (last in, first out).


File: python.info,  Node: Exceptions<8>,  Next: Examples<13>,  Prev: LIFO Queue,  Up: Queues

5.19.1.39 Exceptions
....................

 -- Exception: asyncio.QueueEmpty

     This exception is raised when the *note get_nowait(): 24c4. method
     is called on an empty queue.

 -- Exception: asyncio.QueueFull

     Exception raised when the *note put_nowait(): 24c7. method is
     called on a queue that has reached its `maxsize'.


File: python.info,  Node: Examples<13>,  Prev: Exceptions<8>,  Up: Queues

5.19.1.40 Examples
..................

Queues can be used to distribute workload between several concurrent
tasks:

     import asyncio import random import time   async def worker(name, queue):     while True:         # Get a "work item" out of the queue.         sleep_for = await queue.get()          # Sleep for the "sleep_for" seconds.         await asyncio.sleep(sleep_for)          # Notify the queue that the "work item" has been processed.         queue.task_done()          print(f'{name} has slept for {sleep_for:.2f} seconds')   async def main():     # Create a queue that we will use to store our "workload".     queue = asyncio.Queue()      # Generate random timings and put them into the queue.     total_sleep_time = 0     for _ in range(20):         sleep_for = random.uniform(0.05, 1.0)         total_sleep_time += sleep_for         queue.put_nowait(sleep_for)      # Create three worker tasks to process the queue concurrently.     tasks = []     for i in range(3):         task = asyncio.create_task(worker(f'worker-{i}', queue))         tasks.append(task)      # Wait until the queue is fully processed.     started_at = time.monotonic()     await queue.join()     total_slept_for = time.monotonic() - started_at      # Cancel our worker tasks.     for task in tasks:         task.cancel()     # Wait until all worker tasks are cancelled.     await asyncio.gather(*tasks, return_exceptions=True)      print('====')     print(f'3 workers slept in parallel for {total_slept_for:.2f} seconds')     print(f'total expected sleep time: {total_sleep_time:.2f} seconds')   asyncio.run(main())


File: python.info,  Node: Exceptions<9>,  Next: Event Loop,  Prev: Queues,  Up: asyncio — Asynchronous I/O

5.19.1.41 Exceptions
....................

`Source code:' Lib/asyncio/exceptions.py(1)

__________________________________________________________________

 -- Exception: asyncio.TimeoutError

     The operation has exceeded the given deadline.

          Important: This exception is different from the builtin *note
          TimeoutError: 990. exception.

 -- Exception: asyncio.CancelledError

     The operation has been cancelled.

     This exception can be caught to perform custom operations when
     asyncio Tasks are cancelled.  In almost all situations the
     exception must be re-raised.

     Changed in version 3.8: *note CancelledError: 1a6. is now a
     subclass of *note BaseException: 1a7.

 -- Exception: asyncio.InvalidStateError

     Invalid internal state of *note Task: 1ab. or *note Future: 438.

     Can be raised in situations like setting a result value for a
     `Future' object that already has a result value set.

 -- Exception: asyncio.SendfileNotAvailableError

     The “sendfile” syscall is not available for the given socket or
     file type.

     A subclass of *note RuntimeError: 2b8.

 -- Exception: asyncio.IncompleteReadError

     The requested read operation did not complete fully.

     Raised by the *note asyncio stream APIs: 242c.

     This exception is a subclass of *note EOFError: c5f.

      -- Attribute: expected

          The total number (*note int: 184.) of expected bytes.

      -- Attribute: partial

          A string of *note bytes: 326. read before the end of stream
          was reached.

 -- Exception: asyncio.LimitOverrunError

     Reached the buffer size limit while looking for a separator.

     Raised by the *note asyncio stream APIs: 242c.

      -- Attribute: consumed

          The total number of to be consumed bytes.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/exceptions.py


File: python.info,  Node: Event Loop,  Next: Futures,  Prev: Exceptions<9>,  Up: asyncio — Asynchronous I/O

5.19.1.42 Event Loop
....................

`Source code:' Lib/asyncio/events.py(1), Lib/asyncio/base_events.py(2)

__________________________________________________________________

Preface
.......

The event loop is the core of every asyncio application.  Event loops
run asynchronous tasks and callbacks, perform network IO operations, and
run subprocesses.

Application developers should typically use the high-level asyncio
functions, such as *note asyncio.run(): 1a4, and should rarely need to
reference the loop object or call its methods.  This section is intended
mostly for authors of lower-level code, libraries, and frameworks, who
need finer control over the event loop behavior.

Obtaining the Event Loop
........................

The following low-level functions can be used to get, set, or create an
event loop:

 -- Function: asyncio.get_running_loop ()

     Return the running event loop in the current OS thread.

     If there is no running event loop a *note RuntimeError: 2b8. is
     raised.  This function can only be called from a coroutine or a
     callback.

     New in version 3.7.

 -- Function: asyncio.get_event_loop ()

     Get the current event loop.  If there is no current event loop set
     in the current OS thread and *note set_event_loop(): 24d7. has not
     yet been called, asyncio will create a new event loop and set it as
     the current one.

     Because this function has rather complex behavior (especially when
     custom event loop policies are in use), using the *note
     get_running_loop(): 349. function is preferred to *note
     get_event_loop(): 34a. in coroutines and callbacks.

     Consider also using the *note asyncio.run(): 1a4. function instead
     of using lower level functions to manually create and close an
     event loop.

 -- Function: asyncio.set_event_loop (loop)

     Set `loop' as a current event loop for the current OS thread.

 -- Function: asyncio.new_event_loop ()

     Create a new event loop object.

Note that the behaviour of *note get_event_loop(): 34a, *note
set_event_loop(): 24d7, and *note new_event_loop(): 24d8. functions can
be altered by *note setting a custom event loop policy: 24d9.

Contents
........

This documentation page contains the following sections:

   * The *note Event Loop Methods: 24da. section is the reference
     documentation of the event loop APIs;

   * The *note Callback Handles: 24db. section documents the *note
     Handle: fdb. and *note TimerHandle: 24dc. instances which are
     returned from scheduling methods such as *note loop.call_soon():
     33e. and *note loop.call_later(): 340.;

   * The *note Server Objects: 24dd. section documents types returned
     from event loop methods like *note loop.create_server(): 352.;

   * The *note Event Loop Implementations: 24de. section documents the
     *note SelectorEventLoop: 24b6. and *note ProactorEventLoop: 1a9.
     classes;

   * The *note Examples: 24df. section showcases how to work with some
     event loop APIs.

* Menu:

* Event Loop Methods::
* Callback Handles::
* Server Objects::
* Event Loop Implementations::
* Examples: Examples<14>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncio/events.py

   (2) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/base_events.py


File: python.info,  Node: Event Loop Methods,  Next: Callback Handles,  Up: Event Loop

5.19.1.43 Event Loop Methods
............................

Event loops have `low-level' APIs for the following:

* Menu:

* Running and stopping the loop::
* Scheduling callbacks::
* Scheduling delayed callbacks::
* Creating Futures and Tasks::
* Opening network connections::
* Creating network servers::
* Transferring files::
* TLS Upgrade::
* Watching file descriptors::
* Working with socket objects directly::
* DNS::
* Working with pipes::
* Unix signals::
* Executing code in thread or process pools::
* Error Handling API::
* Enabling debug mode::
* Running Subprocesses::


File: python.info,  Node: Running and stopping the loop,  Next: Scheduling callbacks,  Up: Event Loop Methods

5.19.1.44 Running and stopping the loop
.......................................

 -- Method: loop.run_until_complete (future)

     Run until the `future' (an instance of *note Future: 438.) has
     completed.

     If the argument is a *note coroutine object: 242b. it is implicitly
     scheduled to run as a *note asyncio.Task: 1ab.

     Return the Future’s result or raise its exception.

 -- Method: loop.run_forever ()

     Run the event loop until *note stop(): 515. is called.

     If *note stop(): 515. is called before *note run_forever(): 24e1.
     is called, the loop will poll the I/O selector once with a timeout
     of zero, run all callbacks scheduled in response to I/O events (and
     those that were already scheduled), and then exit.

     If *note stop(): 515. is called while *note run_forever(): 24e1. is
     running, the loop will run the current batch of callbacks and then
     exit.  Note that new callbacks scheduled by callbacks will not run
     in this case; instead, they will run the next time *note
     run_forever(): 24e1. or *note run_until_complete(): 50d. is called.

 -- Method: loop.stop ()

     Stop the event loop.

 -- Method: loop.is_running ()

     Return ‘True’ if the event loop is currently running.

 -- Method: loop.is_closed ()

     Return ‘True’ if the event loop was closed.

 -- Method: loop.close ()

     Close the event loop.

     The loop must not be running when this function is called.  Any
     pending callbacks will be discarded.

     This method clears all queues and shuts down the executor, but does
     not wait for the executor to finish.

     This method is idempotent and irreversible.  No other methods
     should be called after the event loop is closed.

 -- Method: coroutine loop.shutdown_asyncgens ()

     Schedule all currently open *note asynchronous generator: 1441.
     objects to close with an *note aclose(): 1449. call.  After calling
     this method, the event loop will issue a warning if a new
     asynchronous generator is iterated.  This should be used to
     reliably finalize all scheduled asynchronous generators.

     Note that there is no need to call this function when *note
     asyncio.run(): 1a4. is used.

     Example:

          try:     loop.run_forever() finally:     loop.run_until_complete(loop.shutdown_asyncgens())     loop.close()

     New in version 3.6.


File: python.info,  Node: Scheduling callbacks,  Next: Scheduling delayed callbacks,  Prev: Running and stopping the loop,  Up: Event Loop Methods

5.19.1.45 Scheduling callbacks
..............................

 -- Method: loop.call_soon (callback, *args, context=None)

     Schedule a `callback' to be called with `args' arguments at the
     next iteration of the event loop.

     Callbacks are called in the order in which they are registered.
     Each callback will be called exactly once.

     An optional keyword-only `context' argument allows specifying a
     custom *note contextvars.Context: 2414. for the `callback' to run
     in.  The current context is used when no `context' is provided.

     An instance of *note asyncio.Handle: fdb. is returned, which can be
     used later to cancel the callback.

     This method is not thread-safe.

 -- Method: loop.call_soon_threadsafe (callback, *args, context=None)

     A thread-safe variant of *note call_soon(): 33e.  Must be used to
     schedule callbacks `from another thread'.

     See the *note concurrency and multithreading: 2449. section of the
     documentation.

Changed in version 3.7: The `context' keyword-only parameter was added.
See PEP 567(1) for more details.

     Note: Most *note asyncio: a. scheduling functions don’t allow
     passing keyword arguments.  To do that, use *note
     functools.partial(): 7bc.:

          # will schedule "print("Hello", flush=True)" loop.call_soon(     functools.partial(print, "Hello", flush=True))

     Using partial objects is usually more convenient than using
     lambdas, as asyncio can render partial objects better in debug and
     error messages.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0567


File: python.info,  Node: Scheduling delayed callbacks,  Next: Creating Futures and Tasks,  Prev: Scheduling callbacks,  Up: Event Loop Methods

5.19.1.46 Scheduling delayed callbacks
......................................

Event loop provides mechanisms to schedule callback functions to be
called at some point in the future.  Event loop uses monotonic clocks to
track time.

 -- Method: loop.call_later (delay, callback, *args, context=None)

     Schedule `callback' to be called after the given `delay' number of
     seconds (can be either an int or a float).

     An instance of *note asyncio.TimerHandle: 24dc. is returned which
     can be used to cancel the callback.

     `callback' will be called exactly once.  If two callbacks are
     scheduled for exactly the same time, the order in which they are
     called is undefined.

     The optional positional `args' will be passed to the callback when
     it is called.  If you want the callback to be called with keyword
     arguments use *note functools.partial(): 7bc.

     An optional keyword-only `context' argument allows specifying a
     custom *note contextvars.Context: 2414. for the `callback' to run
     in.  The current context is used when no `context' is provided.

     Changed in version 3.7: The `context' keyword-only parameter was
     added.  See PEP 567(1) for more details.

     Changed in version 3.8: In Python 3.7 and earlier with the default
     event loop implementation, the `delay' could not exceed one day.
     This has been fixed in Python 3.8.

 -- Method: loop.call_at (when, callback, *args, context=None)

     Schedule `callback' to be called at the given absolute timestamp
     `when' (an int or a float), using the same time reference as *note
     loop.time(): 24e8.

     This method’s behavior is the same as *note call_later(): 340.

     An instance of *note asyncio.TimerHandle: 24dc. is returned which
     can be used to cancel the callback.

     Changed in version 3.7: The `context' keyword-only parameter was
     added.  See PEP 567(2) for more details.

     Changed in version 3.8: In Python 3.7 and earlier with the default
     event loop implementation, the difference between `when' and the
     current time could not exceed one day.  This has been fixed in
     Python 3.8.

 -- Method: loop.time ()

     Return the current time, as a *note float: 187. value, according to
     the event loop’s internal monotonic clock.

     Note: 
     Changed in version 3.8: In Python 3.7 and earlier timeouts
     (relative `delay' or absolute `when') should not exceed one day.
     This has been fixed in Python 3.8.

See also
........

The *note asyncio.sleep(): 283. function.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0567

   (2) https://www.python.org/dev/peps/pep-0567


File: python.info,  Node: Creating Futures and Tasks,  Next: Opening network connections,  Prev: Scheduling delayed callbacks,  Up: Event Loop Methods

5.19.1.47 Creating Futures and Tasks
....................................

 -- Method: loop.create_future ()

     Create an *note asyncio.Future: 438. object attached to the event
     loop.

     This is the preferred way to create Futures in asyncio.  This lets
     third-party event loops provide alternative implementations of the
     Future object (with better performance or instrumentation).

     New in version 3.5.2.

 -- Method: loop.create_task (coro, *, name=None)

     Schedule the execution of a *note Coroutines: 242b.  Return a *note
     Task: 1ab. object.

     Third-party event loops can use their own subclass of *note Task:
     1ab. for interoperability.  In this case, the result type is a
     subclass of *note Task: 1ab.

     If the `name' argument is provided and not ‘None’, it is set as the
     name of the task using *note Task.set_name(): 1ae.

     Changed in version 3.8: Added the ‘name’ parameter.

 -- Method: loop.set_task_factory (factory)

     Set a task factory that will be used by *note loop.create_task():
     1ad.

     If `factory' is ‘None’ the default task factory will be set.
     Otherwise, `factory' must be a `callable' with the signature
     matching ‘(loop, coro)’, where `loop' is a reference to the active
     event loop, and `coro' is a coroutine object.  The callable must
     return a *note asyncio.Future: 438.-compatible object.

 -- Method: loop.get_task_factory ()

     Return a task factory or ‘None’ if the default one is in use.


File: python.info,  Node: Opening network connections,  Next: Creating network servers,  Prev: Creating Futures and Tasks,  Up: Event Loop Methods

5.19.1.48 Opening network connections
.....................................

 -- Method: coroutine loop.create_connection (protocol_factory,
          host=None, port=None, *, ssl=None, family=0, proto=0, flags=0,
          sock=None, local_addr=None, server_hostname=None,
          ssl_handshake_timeout=None)

     Open a streaming transport connection to a given address specified
     by `host' and `port'.

     The socket family can be either *note AF_INET: 24eb. or *note
     AF_INET6: 24ec. depending on `host' (or the `family' argument, if
     provided).

     The socket type will be *note SOCK_STREAM: c7d.

     `protocol_factory' must be a callable returning an *note asyncio
     protocol: 24ed. implementation.

     This method will try to establish the connection in the background.
     When successful, it returns a ‘(transport, protocol)’ pair.

     The chronological synopsis of the underlying operation is as
     follows:

       1. The connection is established and a *note transport: 24ee. is
          created for it.

       2. `protocol_factory' is called without arguments and is expected
          to return a *note protocol: 24ed. instance.

       3. The protocol instance is coupled with the transport by calling
          its *note connection_made(): 24ef. method.

       4. A ‘(transport, protocol)’ tuple is returned on success.

     The created transport is an implementation-dependent bidirectional
     stream.

     Other arguments:

        * `ssl': if given and not false, a SSL/TLS transport is created
          (by default a plain TCP transport is created).  If `ssl' is a
          *note ssl.SSLContext: 3d9. object, this context is used to
          create the transport; if `ssl' is *note True: 48f, a default
          context returned from *note ssl.create_default_context(): 8b5.
          is used.

          See also
          ........

          *note SSL/TLS security considerations: 24f0.

        * `server_hostname' sets or overrides the hostname that the
          target server’s certificate will be matched against.  Should
          only be passed if `ssl' is not ‘None’.  By default the value
          of the `host' argument is used.  If `host' is empty, there is
          no default and you must pass a value for `server_hostname'.
          If `server_hostname' is an empty string, hostname matching is
          disabled (which is a serious security risk, allowing for
          potential man-in-the-middle attacks).

        * `family', `proto', `flags' are the optional address family,
          protocol and flags to be passed through to getaddrinfo() for
          `host' resolution.  If given, these should all be integers
          from the corresponding *note socket: ef. module constants.

        * `happy_eyeballs_delay', if given, enables Happy Eyeballs for
          this connection.  It should be a floating-point number
          representing the amount of time in seconds to wait for a
          connection attempt to complete, before starting the next
          attempt in parallel.  This is the “Connection Attempt Delay”
          as defined in RFC 8305(1).  A sensible default value
          recommended by the RFC is ‘0.25’ (250 milliseconds).

        * `interleave' controls address reordering when a host name
          resolves to multiple IP addresses.  If ‘0’ or unspecified, no
          reordering is done, and addresses are tried in the order
          returned by *note getaddrinfo(): 497.  If a positive integer
          is specified, the addresses are interleaved by address family,
          and the given integer is interpreted as “First Address Family
          Count” as defined in RFC 8305(2).  The default is ‘0’ if
          `happy_eyeballs_delay' is not specified, and ‘1’ if it is.

        * `sock', if given, should be an existing, already connected
          *note socket.socket: 668. object to be used by the transport.
          If `sock' is given, none of `host', `port', `family', `proto',
          `flags', `happy_eyeballs_delay', `interleave' and `local_addr'
          should be specified.

        * `local_addr', if given, is a ‘(local_host, local_port)’ tuple
          used to bind the socket to locally.  The `local_host' and
          `local_port' are looked up using ‘getaddrinfo()’, similarly to
          `host' and `port'.

        * `ssl_handshake_timeout' is (for a TLS connection) the time in
          seconds to wait for the TLS handshake to complete before
          aborting the connection.  ‘60.0’ seconds if ‘None’ (default).

     New in version 3.8: The `happy_eyeballs_delay' and `interleave'
     parameters.

     New in version 3.7: The `ssl_handshake_timeout' parameter.

     Changed in version 3.6: The socket option ‘TCP_NODELAY’ is set by
     default for all TCP connections.

     Changed in version 3.5: Added support for SSL/TLS in *note
     ProactorEventLoop: 1a9.

     See also
     ........

     The *note open_connection(): 358. function is a high-level
     alternative API. It returns a pair of (*note StreamReader: efc,
     *note StreamWriter: efd.) that can be used directly in async/await
     code.

 -- Method: coroutine loop.create_datagram_endpoint (protocol_factory,
          local_addr=None, remote_addr=None, *, family=0, proto=0,
          flags=0, reuse_address=None, reuse_port=None,
          allow_broadcast=None, sock=None)

          Note: The parameter `reuse_address' is no longer supported, as
          using ‘SO_REUSEADDR’ poses a significant security concern for
          UDP. Explicitly passing ‘reuse_address=True’ will raise an
          exception.

          When multiple processes with differing UIDs assign sockets to
          an indentical UDP socket address with ‘SO_REUSEADDR’, incoming
          packets can become randomly distributed among the sockets.

          For supported platforms, `reuse_port' can be used as a
          replacement for similar functionality.  With `reuse_port',
          ‘SO_REUSEPORT’ is used instead, which specifically prevents
          processes with differing UIDs from assigning sockets to the
          same socket address.

     Create a datagram connection.

     The socket family can be either *note AF_INET: 24eb, *note
     AF_INET6: 24ec, or *note AF_UNIX: 24f1, depending on `host' (or the
     `family' argument, if provided).

     The socket type will be *note SOCK_DGRAM: c7c.

     `protocol_factory' must be a callable returning a *note protocol:
     24ed. implementation.

     A tuple of ‘(transport, protocol)’ is returned on success.

     Other arguments:

        * `local_addr', if given, is a ‘(local_host, local_port)’ tuple
          used to bind the socket to locally.  The `local_host' and
          `local_port' are looked up using *note getaddrinfo(): 497.

        * `remote_addr', if given, is a ‘(remote_host, remote_port)’
          tuple used to connect the socket to a remote address.  The
          `remote_host' and `remote_port' are looked up using *note
          getaddrinfo(): 497.

        * `family', `proto', `flags' are the optional address family,
          protocol and flags to be passed through to *note
          getaddrinfo(): 497. for `host' resolution.  If given, these
          should all be integers from the corresponding *note socket:
          ef. module constants.

        * `reuse_port' tells the kernel to allow this endpoint to be
          bound to the same port as other existing endpoints are bound
          to, so long as they all set this flag when being created.
          This option is not supported on Windows and some Unixes.  If
          the ‘SO_REUSEPORT’ constant is not defined then this
          capability is unsupported.

        * `allow_broadcast' tells the kernel to allow this endpoint to
          send messages to the broadcast address.

        * `sock' can optionally be specified in order to use a
          preexisting, already connected, *note socket.socket: 668.
          object to be used by the transport.  If specified,
          `local_addr' and `remote_addr' should be omitted (must be
          *note None: 157.).

     See *note UDP echo client protocol: 24f2. and *note UDP echo server
     protocol: 24f3. examples.

     Changed in version 3.4.4: The `family', `proto', `flags',
     `reuse_address', `reuse_port, *allow_broadcast', and `sock'
     parameters were added.

     Changed in version 3.8.1: The `reuse_address' parameter is no
     longer supported due to security concerns.

     Changed in version 3.8: Added support for Windows.

 -- Method: coroutine loop.create_unix_connection (protocol_factory,
          path=None, *, ssl=None, sock=None, server_hostname=None,
          ssl_handshake_timeout=None)

     Create a Unix connection.

     The socket family will be *note AF_UNIX: 24f1.; socket type will be
     *note SOCK_STREAM: c7d.

     A tuple of ‘(transport, protocol)’ is returned on success.

     `path' is the name of a Unix domain socket and is required, unless
     a `sock' parameter is specified.  Abstract Unix sockets, *note str:
     325, *note bytes: 326, and *note Path: 1ff. paths are supported.

     See the documentation of the *note loop.create_connection(): 1b0.
     method for information about arguments to this method.

     *note Availability: 129a.: Unix.

     New in version 3.7: The `ssl_handshake_timeout' parameter.

     Changed in version 3.7: The `path' parameter can now be a *note
     path-like object: 35f.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc8305.html

   (2) https://tools.ietf.org/html/rfc8305.html


File: python.info,  Node: Creating network servers,  Next: Transferring files,  Prev: Opening network connections,  Up: Event Loop Methods

5.19.1.49 Creating network servers
..................................

 -- Method: coroutine loop.create_server (protocol_factory, host=None,
          port=None, *, family=socket.AF_UNSPEC,
          flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None,
          reuse_address=None, reuse_port=None,
          ssl_handshake_timeout=None, start_serving=True)

     Create a TCP server (socket type *note SOCK_STREAM: c7d.) listening
     on `port' of the `host' address.

     Returns a *note Server: 351. object.

     Arguments:

        * `protocol_factory' must be a callable returning a *note
          protocol: 24ed. implementation.

        * The `host' parameter can be set to several types which
          determine where the server would be listening:

             - If `host' is a string, the TCP server is bound to a
               single network interface specified by `host'.

             - If `host' is a sequence of strings, the TCP server is
               bound to all network interfaces specified by the
               sequence.

             - If `host' is an empty string or ‘None’, all interfaces
               are assumed and a list of multiple sockets will be
               returned (most likely one for IPv4 and another one for
               IPv6).

        * `family' can be set to either *note socket.AF_INET: 24eb. or
          *note AF_INET6: 24ec. to force the socket to use IPv4 or IPv6.
          If not set, the `family' will be determined from host name
          (defaults to ‘AF_UNSPEC’).

        * `flags' is a bitmask for *note getaddrinfo(): 497.

        * `sock' can optionally be specified in order to use a
          preexisting socket object.  If specified, `host' and `port'
          must not be specified.

        * `backlog' is the maximum number of queued connections passed
          to *note listen(): 73f. (defaults to 100).

        * `ssl' can be set to an *note SSLContext: 3d9. instance to
          enable TLS over the accepted connections.

        * `reuse_address' tells the kernel to reuse a local socket in
          ‘TIME_WAIT’ state, without waiting for its natural timeout to
          expire.  If not specified will automatically be set to ‘True’
          on Unix.

        * `reuse_port' tells the kernel to allow this endpoint to be
          bound to the same port as other existing endpoints are bound
          to, so long as they all set this flag when being created.
          This option is not supported on Windows.

        * `ssl_handshake_timeout' is (for a TLS server) the time in
          seconds to wait for the TLS handshake to complete before
          aborting the connection.  ‘60.0’ seconds if ‘None’ (default).

        * `start_serving' set to ‘True’ (the default) causes the created
          server to start accepting connections immediately.  When set
          to ‘False’, the user should await on *note
          Server.start_serving(): 354. or *note Server.serve_forever():
          355. to make the server to start accepting connections.

     New in version 3.7: Added `ssl_handshake_timeout' and
     `start_serving' parameters.

     Changed in version 3.6: The socket option ‘TCP_NODELAY’ is set by
     default for all TCP connections.

     Changed in version 3.5: Added support for SSL/TLS in *note
     ProactorEventLoop: 1a9.

     Changed in version 3.5.1: The `host' parameter can be a sequence of
     strings.

     See also
     ........

     The *note start_server(): 359. function is a higher-level
     alternative API that returns a pair of *note StreamReader: efc. and
     *note StreamWriter: efd. that can be used in an async/await code.

 -- Method: coroutine loop.create_unix_server (protocol_factory,
          path=None, *, sock=None, backlog=100, ssl=None,
          ssl_handshake_timeout=None, start_serving=True)

     Similar to *note loop.create_server(): 352. but works with the
     *note AF_UNIX: 24f1. socket family.

     `path' is the name of a Unix domain socket, and is required, unless
     a `sock' argument is provided.  Abstract Unix sockets, *note str:
     325, *note bytes: 326, and *note Path: 1ff. paths are supported.

     See the documentation of the *note loop.create_server(): 352.
     method for information about arguments to this method.

     *note Availability: 129a.: Unix.

     New in version 3.7: The `ssl_handshake_timeout' and `start_serving'
     parameters.

     Changed in version 3.7: The `path' parameter can now be a *note
     Path: 1ff. object.

 -- Method: coroutine loop.connect_accepted_socket (protocol_factory,
          sock, *, ssl=None, ssl_handshake_timeout=None)

     Wrap an already accepted connection into a transport/protocol pair.

     This method can be used by servers that accept connections outside
     of asyncio but that use asyncio to handle them.

     Parameters:

        * `protocol_factory' must be a callable returning a *note
          protocol: 24ed. implementation.

        * `sock' is a preexisting socket object returned from *note
          socket.accept: 669.

        * `ssl' can be set to an *note SSLContext: 3d9. to enable SSL
          over the accepted connections.

        * `ssl_handshake_timeout' is (for an SSL connection) the time in
          seconds to wait for the SSL handshake to complete before
          aborting the connection.  ‘60.0’ seconds if ‘None’ (default).

     Returns a ‘(transport, protocol)’ pair.

     New in version 3.7: The `ssl_handshake_timeout' parameter.

     New in version 3.5.3.


File: python.info,  Node: Transferring files,  Next: TLS Upgrade,  Prev: Creating network servers,  Up: Event Loop Methods

5.19.1.50 Transferring files
............................

 -- Method: coroutine loop.sendfile (transport, file, offset=0,
          count=None, *, fallback=True)

     Send a `file' over a `transport'.  Return the total number of bytes
     sent.

     The method uses high-performance *note os.sendfile(): 34e. if
     available.

     `file' must be a regular file object opened in binary mode.

     `offset' tells from where to start reading the file.  If specified,
     `count' is the total number of bytes to transmit as opposed to
     sending the file until EOF is reached.  File position is always
     updated, even when this method raises an error, and *note
     file.tell(): 1cd2. can be used to obtain the actual number of bytes
     sent.

     `fallback' set to ‘True’ makes asyncio to manually read and send
     the file when the platform does not support the sendfile system
     call (e.g.  Windows or SSL socket on Unix).

     Raise *note SendfileNotAvailableError: 24d2. if the system does not
     support the `sendfile' syscall and `fallback' is ‘False’.

     New in version 3.7.


File: python.info,  Node: TLS Upgrade,  Next: Watching file descriptors,  Prev: Transferring files,  Up: Event Loop Methods

5.19.1.51 TLS Upgrade
.....................

 -- Method: coroutine loop.start_tls (transport, protocol, sslcontext,
          *, server_side=False, server_hostname=None,
          ssl_handshake_timeout=None)

     Upgrade an existing transport-based connection to TLS.

     Return a new transport instance, that the `protocol' must start
     using immediately after the `await'.  The `transport' instance
     passed to the `start_tls' method should never be used again.

     Parameters:

        * `transport' and `protocol' instances that methods like *note
          create_server(): 352. and *note create_connection(): 1b0.
          return.

        * `sslcontext': a configured instance of *note SSLContext: 3d9.

        * `server_side' pass ‘True’ when a server-side connection is
          being upgraded (like the one created by *note create_server():
          352.).

        * `server_hostname': sets or overrides the host name that the
          target server’s certificate will be matched against.

        * `ssl_handshake_timeout' is (for a TLS connection) the time in
          seconds to wait for the TLS handshake to complete before
          aborting the connection.  ‘60.0’ seconds if ‘None’ (default).

     New in version 3.7.


File: python.info,  Node: Watching file descriptors,  Next: Working with socket objects directly,  Prev: TLS Upgrade,  Up: Event Loop Methods

5.19.1.52 Watching file descriptors
...................................

 -- Method: loop.add_reader (fd, callback, *args)

     Start monitoring the `fd' file descriptor for read availability and
     invoke `callback' with the specified arguments once `fd' is
     available for reading.

 -- Method: loop.remove_reader (fd)

     Stop monitoring the `fd' file descriptor for read availability.

 -- Method: loop.add_writer (fd, callback, *args)

     Start monitoring the `fd' file descriptor for write availability
     and invoke `callback' with the specified arguments once `fd' is
     available for writing.

     Use *note functools.partial(): 7bc. *note to pass keyword
     arguments: 24e5. to `callback'.

 -- Method: loop.remove_writer (fd)

     Stop monitoring the `fd' file descriptor for write availability.

See also *note Platform Support: 24fc. section for some limitations of
these methods.


File: python.info,  Node: Working with socket objects directly,  Next: DNS,  Prev: Watching file descriptors,  Up: Event Loop Methods

5.19.1.53 Working with socket objects directly
..............................................

In general, protocol implementations that use transport-based APIs such
as *note loop.create_connection(): 1b0. and *note loop.create_server():
352. are faster than implementations that work with sockets directly.
However, there are some use cases when performance is not critical, and
working with *note socket: 668. objects directly is more convenient.

 -- Method: coroutine loop.sock_recv (sock, nbytes)

     Receive up to `nbytes' from `sock'.  Asynchronous version of *note
     socket.recv(): 66b.

     Return the received data as a bytes object.

     `sock' must be a non-blocking socket.

     Changed in version 3.7: Even though this method was always
     documented as a coroutine method, releases before Python 3.7
     returned a *note Future: 438.  Since Python 3.7 this is an ‘async
     def’ method.

 -- Method: coroutine loop.sock_recv_into (sock, buf)

     Receive data from `sock' into the `buf' buffer.  Modeled after the
     blocking *note socket.recv_into(): ca5. method.

     Return the number of bytes written to the buffer.

     `sock' must be a non-blocking socket.

     New in version 3.7.

 -- Method: coroutine loop.sock_sendall (sock, data)

     Send `data' to the `sock' socket.  Asynchronous version of *note
     socket.sendall(): 66f.

     This method continues to send to the socket until either all data
     in `data' has been sent or an error occurs.  ‘None’ is returned on
     success.  On error, an exception is raised.  Additionally, there is
     no way to determine how much data, if any, was successfully
     processed by the receiving end of the connection.

     `sock' must be a non-blocking socket.

     Changed in version 3.7: Even though the method was always
     documented as a coroutine method, before Python 3.7 it returned an
     *note Future: 438.  Since Python 3.7, this is an ‘async def’
     method.

 -- Method: coroutine loop.sock_connect (sock, address)

     Connect `sock' to a remote socket at `address'.

     Asynchronous version of *note socket.connect(): 66a.

     `sock' must be a non-blocking socket.

     Changed in version 3.5.2: ‘address’ no longer needs to be resolved.
     ‘sock_connect’ will try to check if the `address' is already
     resolved by calling *note socket.inet_pton(): 8af.  If not, *note
     loop.getaddrinfo(): 497. will be used to resolve the `address'.

     See also
     ........

     *note loop.create_connection(): 1b0. and *note
     asyncio.open_connection(): 358.

 -- Method: coroutine loop.sock_accept (sock)

     Accept a connection.  Modeled after the blocking *note
     socket.accept(): 669. method.

     The socket must be bound to an address and listening for
     connections.  The return value is a pair ‘(conn, address)’ where
     `conn' is a `new' socket object usable to send and receive data on
     the connection, and `address' is the address bound to the socket on
     the other end of the connection.

     `sock' must be a non-blocking socket.

     Changed in version 3.7: Even though the method was always
     documented as a coroutine method, before Python 3.7 it returned a
     *note Future: 438.  Since Python 3.7, this is an ‘async def’
     method.

     See also
     ........

     *note loop.create_server(): 352. and *note start_server(): 359.

 -- Method: coroutine loop.sock_sendfile (sock, file, offset=0,
          count=None, *, fallback=True)

     Send a file using high-performance *note os.sendfile: 34e. if
     possible.  Return the total number of bytes sent.

     Asynchronous version of *note socket.sendfile(): 73e.

     `sock' must be a non-blocking *note socket.SOCK_STREAM: c7d. *note
     socket: 668.

     `file' must be a regular file object open in binary mode.

     `offset' tells from where to start reading the file.  If specified,
     `count' is the total number of bytes to transmit as opposed to
     sending the file until EOF is reached.  File position is always
     updated, even when this method raises an error, and *note
     file.tell(): 1cd2. can be used to obtain the actual number of bytes
     sent.

     `fallback', when set to ‘True’, makes asyncio manually read and
     send the file when the platform does not support the sendfile
     syscall (e.g.  Windows or SSL socket on Unix).

     Raise *note SendfileNotAvailableError: 24d2. if the system does not
     support `sendfile' syscall and `fallback' is ‘False’.

     `sock' must be a non-blocking socket.

     New in version 3.7.


File: python.info,  Node: DNS,  Next: Working with pipes,  Prev: Working with socket objects directly,  Up: Event Loop Methods

5.19.1.54 DNS
.............

 -- Method: coroutine loop.getaddrinfo (host, port, *, family=0, type=0,
          proto=0, flags=0)

     Asynchronous version of *note socket.getaddrinfo(): 24ff.

 -- Method: coroutine loop.getnameinfo (sockaddr, flags=0)

     Asynchronous version of *note socket.getnameinfo(): 2500.

Changed in version 3.7: Both `getaddrinfo' and `getnameinfo' methods
were always documented to return a coroutine, but prior to Python 3.7
they were, in fact, returning *note asyncio.Future: 438. objects.
Starting with Python 3.7 both methods are coroutines.


File: python.info,  Node: Working with pipes,  Next: Unix signals,  Prev: DNS,  Up: Event Loop Methods

5.19.1.55 Working with pipes
............................

 -- Method: coroutine loop.connect_read_pipe (protocol_factory, pipe)

     Register the read end of `pipe' in the event loop.

     `protocol_factory' must be a callable returning an *note asyncio
     protocol: 24ed. implementation.

     `pipe' is a *note file-like object: b35.

     Return pair ‘(transport, protocol)’, where `transport' supports the
     *note ReadTransport: 2502. interface and `protocol' is an object
     instantiated by the `protocol_factory'.

     With *note SelectorEventLoop: 24b6. event loop, the `pipe' is set
     to non-blocking mode.

 -- Method: coroutine loop.connect_write_pipe (protocol_factory, pipe)

     Register the write end of `pipe' in the event loop.

     `protocol_factory' must be a callable returning an *note asyncio
     protocol: 24ed. implementation.

     `pipe' is *note file-like object: b35.

     Return pair ‘(transport, protocol)’, where `transport' supports
     *note WriteTransport: 2503. interface and `protocol' is an object
     instantiated by the `protocol_factory'.

     With *note SelectorEventLoop: 24b6. event loop, the `pipe' is set
     to non-blocking mode.

     Note: *note SelectorEventLoop: 24b6. does not support the above
     methods on Windows.  Use *note ProactorEventLoop: 1a9. instead for
     Windows.

See also
........

The *note loop.subprocess_exec(): 2430. and *note
loop.subprocess_shell(): 249f. methods.


File: python.info,  Node: Unix signals,  Next: Executing code in thread or process pools,  Prev: Working with pipes,  Up: Event Loop Methods

5.19.1.56 Unix signals
......................

 -- Method: loop.add_signal_handler (signum, callback, *args)

     Set `callback' as the handler for the `signum' signal.

     The callback will be invoked by `loop', along with other queued
     callbacks and runnable coroutines of that event loop.  Unlike
     signal handlers registered using *note signal.signal(): a72, a
     callback registered with this function is allowed to interact with
     the event loop.

     Raise *note ValueError: 1f9. if the signal number is invalid or
     uncatchable.  Raise *note RuntimeError: 2b8. if there is a problem
     setting up the handler.

     Use *note functools.partial(): 7bc. *note to pass keyword
     arguments: 24e5. to `callback'.

     Like *note signal.signal(): a72, this function must be invoked in
     the main thread.

 -- Method: loop.remove_signal_handler (sig)

     Remove the handler for the `sig' signal.

     Return ‘True’ if the signal handler was removed, or ‘False’ if no
     handler was set for the given signal.

     *note Availability: 129a.: Unix.

See also
........

The *note signal: ea. module.


File: python.info,  Node: Executing code in thread or process pools,  Next: Error Handling API,  Prev: Unix signals,  Up: Event Loop Methods

5.19.1.57 Executing code in thread or process pools
...................................................

 -- Method: awaitable loop.run_in_executor (executor, func, *args)

     Arrange for `func' to be called in the specified executor.

     The `executor' argument should be an *note
     concurrent.futures.Executor: 2378. instance.  The default executor
     is used if `executor' is ‘None’.

     Example:

          import asyncio import concurrent.futures  def blocking_io():     # File operations (such as logging) can block the     # event loop: run them in a thread pool.     with open('/dev/urandom', 'rb') as f:         return f.read(100)  def cpu_bound():     # CPU-bound operations will block the event loop:     # in general it is preferable to run them in a     # process pool.     return sum(i * i for i in range(10 ** 7))  async def main():     loop = asyncio.get_running_loop()      ## Options:      # 1. Run in the default loop's executor:     result = await loop.run_in_executor(         None, blocking_io)     print('default thread pool', result)      # 2. Run in a custom thread pool:     with concurrent.futures.ThreadPoolExecutor() as pool:         result = await loop.run_in_executor(             pool, blocking_io)         print('custom thread pool', result)      # 3. Run in a custom process pool:     with concurrent.futures.ProcessPoolExecutor() as pool:         result = await loop.run_in_executor(             pool, cpu_bound)         print('custom process pool', result)  asyncio.run(main())

     This method returns a *note asyncio.Future: 438. object.

     Use *note functools.partial(): 7bc. *note to pass keyword
     arguments: 24e5. to `func'.

     Changed in version 3.5.3: *note loop.run_in_executor(): 243a. no
     longer configures the ‘max_workers’ of the thread pool executor it
     creates, instead leaving it up to the thread pool executor (*note
     ThreadPoolExecutor: 278.) to set the default.

 -- Method: loop.set_default_executor (executor)

     Set `executor' as the default executor used by *note
     run_in_executor(): 243a.  `executor' should be an instance of *note
     ThreadPoolExecutor: 278.

     Deprecated since version 3.8: Using an executor that is not an
     instance of *note ThreadPoolExecutor: 278. is deprecated and will
     trigger an error in Python 3.9.

     `executor' must be an instance of *note
     concurrent.futures.ThreadPoolExecutor: 278.


File: python.info,  Node: Error Handling API,  Next: Enabling debug mode,  Prev: Executing code in thread or process pools,  Up: Event Loop Methods

5.19.1.58 Error Handling API
............................

Allows customizing how exceptions are handled in the event loop.

 -- Method: loop.set_exception_handler (handler)

     Set `handler' as the new event loop exception handler.

     If `handler' is ‘None’, the default exception handler will be set.
     Otherwise, `handler' must be a callable with the signature matching
     ‘(loop, context)’, where ‘loop’ is a reference to the active event
     loop, and ‘context’ is a ‘dict’ object containing the details of
     the exception (see *note call_exception_handler(): 2509.
     documentation for details about context).

 -- Method: loop.get_exception_handler ()

     Return the current exception handler, or ‘None’ if no custom
     exception handler was set.

     New in version 3.5.2.

 -- Method: loop.default_exception_handler (context)

     Default exception handler.

     This is called when an exception occurs and no exception handler is
     set.  This can be called by a custom exception handler that wants
     to defer to the default handler behavior.

     `context' parameter has the same meaning as in *note
     call_exception_handler(): 2509.

 -- Method: loop.call_exception_handler (context)

     Call the current event loop exception handler.

     `context' is a ‘dict’ object containing the following keys (new
     keys may be introduced in future Python versions):

        * ‘message’: Error message;

        * ‘exception’ (optional): Exception object;

        * ‘future’ (optional): *note asyncio.Future: 438. instance;

        * ‘handle’ (optional): *note asyncio.Handle: fdb. instance;

        * ‘protocol’ (optional): *note Protocol: 24ed. instance;

        * ‘transport’ (optional): *note Transport: 24ee. instance;

        * ‘socket’ (optional): *note socket.socket: 668. instance.

          Note: This method should not be overloaded in subclassed event
          loops.  For custom exception handling, use the *note
          set_exception_handler(): 2508. method.


File: python.info,  Node: Enabling debug mode,  Next: Running Subprocesses,  Prev: Error Handling API,  Up: Event Loop Methods

5.19.1.59 Enabling debug mode
.............................

 -- Method: loop.get_debug ()

     Get the debug mode (*note bool: 183.) of the event loop.

     The default value is ‘True’ if the environment variable *note
     PYTHONASYNCIODEBUG: 1297. is set to a non-empty string, ‘False’
     otherwise.

 -- Method: loop.set_debug (enabled: bool)

     Set the debug mode of the event loop.

     Changed in version 3.7: The new ‘-X dev’ command line option can
     now also be used to enable the debug mode.

See also
........

The *note debug mode of asyncio: 128b.


File: python.info,  Node: Running Subprocesses,  Prev: Enabling debug mode,  Up: Event Loop Methods

5.19.1.60 Running Subprocesses
..............................

Methods described in this subsections are low-level.  In regular
async/await code consider using the high-level *note
asyncio.create_subprocess_shell(): 290. and *note
asyncio.create_subprocess_exec(): 28f. convenience functions instead.

     Note: The default asyncio event loop on `Windows' does not support
     subprocesses.  See *note Subprocess Support on Windows: 24a0. for
     details.

 -- Method: coroutine loop.subprocess_exec (protocol_factory, *args,
          stdin=subprocess.PIPE, stdout=subprocess.PIPE,
          stderr=subprocess.PIPE, **kwargs)

     Create a subprocess from one or more string arguments specified by
     `args'.

     `args' must be a list of strings represented by:

        * *note str: 325.;

        * or *note bytes: 326, encoded to the *note filesystem encoding:
          1e1d.

     The first string specifies the program executable, and the
     remaining strings specify the arguments.  Together, string
     arguments form the ‘argv’ of the program.

     This is similar to the standard library *note subprocess.Popen:
     2b7. class called with ‘shell=False’ and the list of strings passed
     as the first argument; however, where *note Popen: 2b7. takes a
     single argument which is list of strings, `subprocess_exec' takes
     multiple string arguments.

     The `protocol_factory' must be a callable returning a subclass of
     the *note asyncio.SubprocessProtocol: 250d. class.

     Other parameters:

        * `stdin' can be any of these:

             * a file-like object representing a pipe to be connected to
               the subprocess’s standard input stream using *note
               connect_write_pipe(): 24a2.

             * the *note subprocess.PIPE: 3e3. constant (default) which
               will create a new pipe and connect it,

             * the value ‘None’ which will make the subprocess inherit
               the file descriptor from this process

             * the *note subprocess.DEVNULL: a95. constant which
               indicates that the special *note os.devnull: f52. file
               will be used

        * `stdout' can be any of these:

             * a file-like object representing a pipe to be connected to
               the subprocess’s standard output stream using *note
               connect_write_pipe(): 24a2.

             * the *note subprocess.PIPE: 3e3. constant (default) which
               will create a new pipe and connect it,

             * the value ‘None’ which will make the subprocess inherit
               the file descriptor from this process

             * the *note subprocess.DEVNULL: a95. constant which
               indicates that the special *note os.devnull: f52. file
               will be used

        * `stderr' can be any of these:

             * a file-like object representing a pipe to be connected to
               the subprocess’s standard error stream using *note
               connect_write_pipe(): 24a2.

             * the *note subprocess.PIPE: 3e3. constant (default) which
               will create a new pipe and connect it,

             * the value ‘None’ which will make the subprocess inherit
               the file descriptor from this process

             * the *note subprocess.DEVNULL: a95. constant which
               indicates that the special *note os.devnull: f52. file
               will be used

             * the *note subprocess.STDOUT: 239e. constant which will
               connect the standard error stream to the process’
               standard output stream

        * All other keyword arguments are passed to *note
          subprocess.Popen: 2b7. without interpretation, except for
          `bufsize', `universal_newlines', `shell', `text', `encoding'
          and `errors', which should not be specified at all.

          The ‘asyncio’ subprocess API does not support decoding the
          streams as text.  *note bytes.decode(): c2b. can be used to
          convert the bytes returned from the stream to text.

     See the constructor of the *note subprocess.Popen: 2b7. class for
     documentation on other arguments.

     Returns a pair of ‘(transport, protocol)’, where `transport'
     conforms to the *note asyncio.SubprocessTransport: 250e. base class
     and `protocol' is an object instantiated by the `protocol_factory'.

 -- Method: coroutine loop.subprocess_shell (protocol_factory, cmd, *,
          stdin=subprocess.PIPE, stdout=subprocess.PIPE,
          stderr=subprocess.PIPE, **kwargs)

     Create a subprocess from `cmd', which can be a *note str: 325. or a
     *note bytes: 326. string encoded to the *note filesystem encoding:
     1e1d, using the platform’s “shell” syntax.

     This is similar to the standard library *note subprocess.Popen:
     2b7. class called with ‘shell=True’.

     The `protocol_factory' must be a callable returning a subclass of
     the *note SubprocessProtocol: 250d. class.

     See *note subprocess_exec(): 2430. for more details about the
     remaining arguments.

     Returns a pair of ‘(transport, protocol)’, where `transport'
     conforms to the *note SubprocessTransport: 250e. base class and
     `protocol' is an object instantiated by the `protocol_factory'.

     Note: It is the application’s responsibility to ensure that all
     whitespace and special characters are quoted appropriately to avoid
     shell injection(1) vulnerabilities.  The *note shlex.quote(): a68.
     function can be used to properly escape whitespace and special
     characters in strings that are going to be used to construct shell
     commands.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Shell_injection#Shell_injection


File: python.info,  Node: Callback Handles,  Next: Server Objects,  Prev: Event Loop Methods,  Up: Event Loop

5.19.1.61 Callback Handles
..........................

 -- Class: asyncio.Handle

     A callback wrapper object returned by *note loop.call_soon(): 33e,
     *note loop.call_soon_threadsafe(): 33f.

      -- Method: cancel ()

          Cancel the callback.  If the callback has already been
          canceled or executed, this method has no effect.

      -- Method: cancelled ()

          Return ‘True’ if the callback was cancelled.

          New in version 3.7.

 -- Class: asyncio.TimerHandle

     A callback wrapper object returned by *note loop.call_later(): 340,
     and *note loop.call_at(): 341.

     This class is a subclass of *note Handle: fdb.

      -- Method: when ()

          Return a scheduled callback time as *note float: 187. seconds.

          The time is an absolute timestamp, using the same time
          reference as *note loop.time(): 24e8.

          New in version 3.7.


File: python.info,  Node: Server Objects,  Next: Event Loop Implementations,  Prev: Callback Handles,  Up: Event Loop

5.19.1.62 Server Objects
........................

Server objects are created by *note loop.create_server(): 352, *note
loop.create_unix_server(): 353, *note start_server(): 359, and *note
start_unix_server(): 2463. functions.

Do not instantiate the class directly.

 -- Class: asyncio.Server

     `Server' objects are asynchronous context managers.  When used in
     an ‘async with’ statement, it’s guaranteed that the Server object
     is closed and not accepting new connections when the ‘async with’
     statement is completed:

          srv = await loop.create_server(...)  async with srv:     # some code  # At this point, srv is closed and no longer accepts new connections.

     Changed in version 3.7: Server object is an asynchronous context
     manager since Python 3.7.

      -- Method: close ()

          Stop serving: close listening sockets and set the *note
          sockets: 499. attribute to ‘None’.

          The sockets that represent existing incoming client
          connections are left open.

          The server is closed asynchronously, use the *note
          wait_closed(): 2511. coroutine to wait until the server is
          closed.

      -- Method: get_loop ()

          Return the event loop associated with the server object.

          New in version 3.7.

      -- Method: coroutine start_serving ()

          Start accepting connections.

          This method is idempotent, so it can be called when the server
          is already being serving.

          The `start_serving' keyword-only parameter to *note
          loop.create_server(): 352. and *note asyncio.start_server():
          359. allows creating a Server object that is not accepting
          connections initially.  In this case ‘Server.start_serving()’,
          or *note Server.serve_forever(): 355. can be used to make the
          Server start accepting connections.

          New in version 3.7.

      -- Method: coroutine serve_forever ()

          Start accepting connections until the coroutine is cancelled.
          Cancellation of ‘serve_forever’ task causes the server to be
          closed.

          This method can be called if the server is already accepting
          connections.  Only one ‘serve_forever’ task can exist per one
          `Server' object.

          Example:

               async def client_connected(reader, writer):     # Communicate with the client with     # reader/writer streams.  For example:     await reader.readline()  async def main(host, port):     srv = await asyncio.start_server(         client_connected, host, port)     await srv.serve_forever()  asyncio.run(main('127.0.0.1', 0))

          New in version 3.7.

      -- Method: is_serving ()

          Return ‘True’ if the server is accepting new connections.

          New in version 3.7.

      -- Method: coroutine wait_closed ()

          Wait until the *note close(): 2510. method completes.

      -- Attribute: sockets

          List of *note socket.socket: 668. objects the server is
          listening on.

          Changed in version 3.7: Prior to Python 3.7 ‘Server.sockets’
          used to return an internal list of server sockets directly.
          In 3.7 a copy of that list is returned.


File: python.info,  Node: Event Loop Implementations,  Next: Examples<14>,  Prev: Server Objects,  Up: Event Loop

5.19.1.63 Event Loop Implementations
....................................

asyncio ships with two different event loop implementations: *note
SelectorEventLoop: 24b6. and *note ProactorEventLoop: 1a9.

By default asyncio is configured to use *note SelectorEventLoop: 24b6.
on Unix and *note ProactorEventLoop: 1a9. on Windows.

 -- Class: asyncio.SelectorEventLoop

     An event loop based on the *note selectors: e6. module.

     Uses the most efficient `selector' available for the given
     platform.  It is also possible to manually configure the exact
     selector implementation to be used:

          import asyncio import selectors  selector = selectors.SelectSelector() loop = asyncio.SelectorEventLoop(selector) asyncio.set_event_loop(loop)

     *note Availability: 129a.: Unix, Windows.

 -- Class: asyncio.ProactorEventLoop

     An event loop for Windows that uses “I/O Completion Ports” (IOCP).

     *note Availability: 129a.: Windows.

     See also
     ........

     MSDN documentation on I/O Completion Ports(1).

 -- Class: asyncio.AbstractEventLoop

     Abstract base class for asyncio-compliant event loops.

     The *note Event Loop Methods: 638. section lists all methods that
     an alternative implementation of ‘AbstractEventLoop’ should have
     defined.

   ---------- Footnotes ----------

   (1) 
https://docs.microsoft.com/en-ca/windows/desktop/FileIO/i-o-completion-ports


File: python.info,  Node: Examples<14>,  Prev: Event Loop Implementations,  Up: Event Loop

5.19.1.64 Examples
..................

Note that all examples in this section `purposefully' show how to use
the low-level event loop APIs, such as *note loop.run_forever(): 24e1.
and *note loop.call_soon(): 33e.  Modern asyncio applications rarely
need to be written this way; consider using the high-level functions
like *note asyncio.run(): 1a4.

* Menu:

* Hello World with call_soon(): Hello World with call_soon.
* Display the current date with call_later(): Display the current date with call_later.
* Watch a file descriptor for read events::
* Set signal handlers for SIGINT and SIGTERM::


File: python.info,  Node: Hello World with call_soon,  Next: Display the current date with call_later,  Up: Examples<14>

5.19.1.65 Hello World with call_soon()
......................................

An example using the *note loop.call_soon(): 33e. method to schedule a
callback.  The callback displays ‘"Hello World"’ and then stops the
event loop:

     import asyncio  def hello_world(loop):     """A callback to print 'Hello World' and stop the event loop"""     print('Hello World')     loop.stop()  loop = asyncio.get_event_loop()  # Schedule a call to hello_world() loop.call_soon(hello_world, loop)  # Blocking call interrupted by loop.stop() try:     loop.run_forever() finally:     loop.close()

See also
........

A similar *note Hello World: 242b. example created with a coroutine and
the *note run(): 1a4. function.


File: python.info,  Node: Display the current date with call_later,  Next: Watch a file descriptor for read events,  Prev: Hello World with call_soon,  Up: Examples<14>

5.19.1.66 Display the current date with call_later()
....................................................

An example of a callback displaying the current date every second.  The
callback uses the *note loop.call_later(): 340. method to reschedule
itself after 5 seconds, and then stops the event loop:

     import asyncio import datetime  def display_date(end_time, loop):     print(datetime.datetime.now())     if (loop.time() + 1.0) < end_time:         loop.call_later(1, display_date, end_time, loop)     else:         loop.stop()  loop = asyncio.get_event_loop()  # Schedule the first call to display_date() end_time = loop.time() + 5.0 loop.call_soon(display_date, end_time, loop)  # Blocking call interrupted by loop.stop() try:     loop.run_forever() finally:     loop.close()

See also
........

A similar *note current date: 243e. example created with a coroutine and
the *note run(): 1a4. function.


File: python.info,  Node: Watch a file descriptor for read events,  Next: Set signal handlers for SIGINT and SIGTERM,  Prev: Display the current date with call_later,  Up: Examples<14>

5.19.1.67 Watch a file descriptor for read events
.................................................

Wait until a file descriptor received some data using the *note
loop.add_reader(): 247f. method and then close the event loop:

     import asyncio from socket import socketpair  # Create a pair of connected file descriptors rsock, wsock = socketpair()  loop = asyncio.get_event_loop()  def reader():     data = rsock.recv(100)     print("Received:", data.decode())      # We are done: unregister the file descriptor     loop.remove_reader(rsock)      # Stop the event loop     loop.stop()  # Register the file descriptor for read event loop.add_reader(rsock, reader)  # Simulate the reception of data from the network loop.call_soon(wsock.send, 'abc'.encode())  try:     # Run the event loop     loop.run_forever() finally:     # We are done. Close sockets and the event loop.     rsock.close()     wsock.close()     loop.close()

See also
........

   * A similar *note example: 247d. using transports, protocols, and the
     *note loop.create_connection(): 1b0. method.

   * Another similar *note example: 247b. using the high-level *note
     asyncio.open_connection(): 358. function and streams.


File: python.info,  Node: Set signal handlers for SIGINT and SIGTERM,  Prev: Watch a file descriptor for read events,  Up: Examples<14>

5.19.1.68 Set signal handlers for SIGINT and SIGTERM
....................................................

(This ‘signals’ example only works on Unix.)

Register handlers for signals ‘SIGINT’ and ‘SIGTERM’ using the *note
loop.add_signal_handler(): 2431. method:

     import asyncio import functools import os import signal  def ask_exit(signame, loop):     print("got signal %s: exit" % signame)     loop.stop()  async def main():     loop = asyncio.get_running_loop()      for signame in {'SIGINT', 'SIGTERM'}:         loop.add_signal_handler(             getattr(signal, signame),             functools.partial(ask_exit, signame, loop))      await asyncio.sleep(3600)  print("Event loop running for 1 hour, press Ctrl+C to interrupt.") print(f"pid {os.getpid()}: send SIGINT or SIGTERM to exit.")  asyncio.run(main())


File: python.info,  Node: Futures,  Next: Transports and Protocols,  Prev: Event Loop,  Up: asyncio — Asynchronous I/O

5.19.1.69 Futures
.................

`Source code:' Lib/asyncio/futures.py(1), Lib/asyncio/base_futures.py(2)

__________________________________________________________________

`Future' objects are used to bridge `low-level callback-based code' with
high-level async/await code.

* Menu:

* Future Functions::
* Future Object::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncio/futures.py

   (2) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/base_futures.py


File: python.info,  Node: Future Functions,  Next: Future Object,  Up: Futures

5.19.1.70 Future Functions
..........................

 -- Function: asyncio.isfuture (obj)

     Return ‘True’ if `obj' is either of:

        * an instance of *note asyncio.Future: 438,

        * an instance of *note asyncio.Task: 1ab,

        * a Future-like object with a ‘_asyncio_future_blocking’
          attribute.

     New in version 3.5.

 -- Function: asyncio.ensure_future (obj, *, loop=None)

     Return:

        * `obj' argument as is, if `obj' is a *note Future: 438, a *note
          Task: 1ab, or a Future-like object (*note isfuture(): 251e. is
          used for the test.)

        * a *note Task: 1ab. object wrapping `obj', if `obj' is a
          coroutine (*note iscoroutine(): 245b. is used for the test);
          in this case the coroutine will be scheduled by
          ‘ensure_future()’.

        * a *note Task: 1ab. object that would await on `obj', if `obj'
          is an awaitable (*note inspect.isawaitable(): 6ed. is used for
          the test.)

     If `obj' is neither of the above a *note TypeError: 192. is raised.

          Important: See also the *note create_task(): 1ac. function
          which is the preferred way for creating new Tasks.

     Changed in version 3.5.1: The function accepts any *note awaitable:
     50e. object.

 -- Function: asyncio.wrap_future (future, *, loop=None)

     Wrap a *note concurrent.futures.Future: b20. object in a *note
     asyncio.Future: 438. object.


File: python.info,  Node: Future Object,  Prev: Future Functions,  Up: Futures

5.19.1.71 Future Object
.......................

 -- Class: asyncio.Future (*, loop=None)

     A Future represents an eventual result of an asynchronous
     operation.  Not thread-safe.

     Future is an *note awaitable: 50e. object.  Coroutines can await on
     Future objects until they either have a result or an exception set,
     or until they are cancelled.

     Typically Futures are used to enable low-level callback-based code
     (e.g.  in protocols implemented using asyncio *note transports:
     2432.) to interoperate with high-level async/await code.

     The rule of thumb is to never expose Future objects in user-facing
     APIs, and the recommended way to create a Future object is to call
     *note loop.create_future(): 511.  This way alternative event loop
     implementations can inject their own optimized implementations of a
     Future object.

     Changed in version 3.7: Added support for the *note contextvars:
     25. module.

      -- Method: result ()

          Return the result of the Future.

          If the Future is `done' and has a result set by the *note
          set_result(): 244d. method, the result value is returned.

          If the Future is `done' and has an exception set by the *note
          set_exception(): 244e. method, this method raises the
          exception.

          If the Future has been `cancelled', this method raises a *note
          CancelledError: 1a6. exception.

          If the Future’s result isn’t yet available, this method raises
          a *note InvalidStateError: 2453. exception.

      -- Method: set_result (result)

          Mark the Future as `done' and set its result.

          Raises a *note InvalidStateError: 2453. error if the Future is
          already `done'.

      -- Method: set_exception (exception)

          Mark the Future as `done' and set an exception.

          Raises a *note InvalidStateError: 2453. error if the Future is
          already `done'.

      -- Method: done ()

          Return ‘True’ if the Future is `done'.

          A Future is `done' if it was `cancelled' or if it has a result
          or an exception set with *note set_result(): 244d. or *note
          set_exception(): 244e. calls.

      -- Method: cancelled ()

          Return ‘True’ if the Future was `cancelled'.

          The method is usually used to check if a Future is not
          `cancelled' before setting a result or an exception for it:

               if not fut.cancelled():     fut.set_result(42)

      -- Method: add_done_callback (callback, *, context=None)

          Add a callback to be run when the Future is `done'.

          The `callback' is called with the Future object as its only
          argument.

          If the Future is already `done' when this method is called,
          the callback is scheduled with *note loop.call_soon(): 33e.

          An optional keyword-only `context' argument allows specifying
          a custom *note contextvars.Context: 2414. for the `callback'
          to run in.  The current context is used when no `context' is
          provided.

          *note functools.partial(): 7bc. can be used to pass parameters
          to the callback, e.g.:

               # Call 'print("Future:", fut)' when "fut" is done. fut.add_done_callback(     functools.partial(print, "Future:"))

          Changed in version 3.7: The `context' keyword-only parameter
          was added.  See PEP 567(1) for more details.

      -- Method: remove_done_callback (callback)

          Remove `callback' from the callbacks list.

          Returns the number of callbacks removed, which is typically 1,
          unless a callback was added more than once.

      -- Method: cancel ()

          Cancel the Future and schedule callbacks.

          If the Future is already `done' or `cancelled', return
          ‘False’.  Otherwise, change the Future’s state to `cancelled',
          schedule the callbacks, and return ‘True’.

      -- Method: exception ()

          Return the exception that was set on this Future.

          The exception (or ‘None’ if no exception was set) is returned
          only if the Future is `done'.

          If the Future has been `cancelled', this method raises a *note
          CancelledError: 1a6. exception.

          If the Future isn’t `done' yet, this method raises an *note
          InvalidStateError: 2453. exception.

      -- Method: get_loop ()

          Return the event loop the Future object is bound to.

          New in version 3.7.

This example creates a Future object, creates and schedules an
asynchronous Task to set result for the Future, and waits until the
Future has a result:

     async def set_after(fut, delay, value):     # Sleep for *delay* seconds.     await asyncio.sleep(delay)      # Set *value* as a result of *fut* Future.     fut.set_result(value)  async def main():     # Get the current event loop.     loop = asyncio.get_running_loop()      # Create a new Future object.     fut = loop.create_future()      # Run "set_after()" coroutine in a parallel Task.     # We are using the low-level "loop.create_task()" API here because     # we already have a reference to the event loop at hand.     # Otherwise we could have just used "asyncio.create_task()".     loop.create_task(         set_after(fut, 1, '... world'))      print('hello ...')      # Wait until *fut* has a result (1 second) and print it.     print(await fut)  asyncio.run(main())

     Important: The Future object was designed to mimic *note
     concurrent.futures.Future: b20.  Key differences include:

        - unlike asyncio Futures, *note concurrent.futures.Future: b20.
          instances cannot be awaited.

        - *note asyncio.Future.result(): 2521. and *note
          asyncio.Future.exception(): 2524. do not accept the `timeout'
          argument.

        - *note asyncio.Future.result(): 2521. and *note
          asyncio.Future.exception(): 2524. raise an *note
          InvalidStateError: 2453. exception when the Future is not
          `done'.

        - Callbacks registered with *note
          asyncio.Future.add_done_callback(): 342. are not called
          immediately.  They are scheduled with *note loop.call_soon():
          33e. instead.

        - asyncio Future is not compatible with the *note
          concurrent.futures.wait(): 238b. and *note
          concurrent.futures.as_completed(): 1027. functions.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0567


File: python.info,  Node: Transports and Protocols,  Next: Policies,  Prev: Futures,  Up: asyncio — Asynchronous I/O

5.19.1.72 Transports and Protocols
..................................

Preface
.......

Transports and Protocols are used by the `low-level' event loop APIs
such as *note loop.create_connection(): 1b0.  They use callback-based
programming style and enable high-performance implementations of network
or IPC protocols (e.g.  HTTP).

Essentially, transports and protocols should only be used in libraries
and frameworks and never in high-level asyncio applications.

This documentation page covers both *note Transports: 2528. and *note
Protocols: 2529.

Introduction
............

At the highest level, the transport is concerned with `how' bytes are
transmitted, while the protocol determines `which' bytes to transmit
(and to some extent when).

A different way of saying the same thing: a transport is an abstraction
for a socket (or similar I/O endpoint) while a protocol is an
abstraction for an application, from the transport’s point of view.

Yet another view is the transport and protocol interfaces together
define an abstract interface for using network I/O and interprocess I/O.

There is always a 1:1 relationship between transport and protocol
objects: the protocol calls transport methods to send data, while the
transport calls protocol methods to pass it data that has been received.

Most of connection oriented event loop methods (such as *note
loop.create_connection(): 1b0.) usually accept a `protocol_factory'
argument used to create a `Protocol' object for an accepted connection,
represented by a `Transport' object.  Such methods usually return a
tuple of ‘(transport, protocol)’.

Contents
........

This documentation page contains the following sections:

   * The *note Transports: 2528. section documents asyncio *note
     BaseTransport: 252a, *note ReadTransport: 2502, *note
     WriteTransport: 2503, *note Transport: 252b, *note
     DatagramTransport: 252c, and *note SubprocessTransport: 250e.
     classes.

   * The *note Protocols: 2529. section documents asyncio *note
     BaseProtocol: 252d, *note Protocol: 252e, *note BufferedProtocol:
     2c7, *note DatagramProtocol: 252f, and *note SubprocessProtocol:
     250d. classes.

   * The *note Examples: 2530. section showcases how to work with
     transports, protocols, and low-level event loop APIs.

* Menu:

* Transports::
* Protocols::
* Examples: Examples<15>.


File: python.info,  Node: Transports,  Next: Protocols,  Up: Transports and Protocols

5.19.1.73 Transports
....................

`Source code:' Lib/asyncio/transports.py(1)

__________________________________________________________________

Transports are classes provided by *note asyncio: a. in order to
abstract various kinds of communication channels.

Transport objects are always instantiated by an *note asyncio event
loop: 638.

asyncio implements transports for TCP, UDP, SSL, and subprocess pipes.
The methods available on a transport depend on the transport’s kind.

The transport classes are *note not thread safe: 2449.

* Menu:

* Transports Hierarchy::
* Base Transport::
* Read-only Transports::
* Write-only Transports::
* Datagram Transports::
* Subprocess Transports::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/transports.py


File: python.info,  Node: Transports Hierarchy,  Next: Base Transport,  Up: Transports

5.19.1.74 Transports Hierarchy
..............................

 -- Class: asyncio.BaseTransport

     Base class for all transports.  Contains methods that all asyncio
     transports share.

 -- Class: asyncio.WriteTransport (BaseTransport)

     A base transport for write-only connections.

     Instances of the `WriteTransport' class are returned from the *note
     loop.connect_write_pipe(): 24a2. event loop method and are also
     used by subprocess-related methods like *note
     loop.subprocess_exec(): 2430.

 -- Class: asyncio.ReadTransport (BaseTransport)

     A base transport for read-only connections.

     Instances of the `ReadTransport' class are returned from the *note
     loop.connect_read_pipe(): 24a1. event loop method and are also used
     by subprocess-related methods like *note loop.subprocess_exec():
     2430.

 -- Class: asyncio.Transport (WriteTransport, ReadTransport)

     Interface representing a bidirectional transport, such as a TCP
     connection.

     The user does not instantiate a transport directly; they call a
     utility function, passing it a protocol factory and other
     information necessary to create the transport and protocol.

     Instances of the `Transport' class are returned from or used by
     event loop methods like *note loop.create_connection(): 1b0, *note
     loop.create_unix_connection(): 2462, *note loop.create_server():
     352, *note loop.sendfile(): 24f6, etc.

 -- Class: asyncio.DatagramTransport (BaseTransport)

     A transport for datagram (UDP) connections.

     Instances of the `DatagramTransport' class are returned from the
     *note loop.create_datagram_endpoint(): 2e5. event loop method.

 -- Class: asyncio.SubprocessTransport (BaseTransport)

     An abstraction to represent a connection between a parent and its
     child OS process.

     Instances of the `SubprocessTransport' class are returned from
     event loop methods *note loop.subprocess_shell(): 249f. and *note
     loop.subprocess_exec(): 2430.


File: python.info,  Node: Base Transport,  Next: Read-only Transports,  Prev: Transports Hierarchy,  Up: Transports

5.19.1.75 Base Transport
........................

 -- Method: BaseTransport.close ()

     Close the transport.

     If the transport has a buffer for outgoing data, buffered data will
     be flushed asynchronously.  No more data will be received.  After
     all buffered data is flushed, the protocol’s *note
     protocol.connection_lost(): 2534. method will be called with *note
     None: 157. as its argument.

 -- Method: BaseTransport.is_closing ()

     Return ‘True’ if the transport is closing or is closed.

 -- Method: BaseTransport.get_extra_info (name, default=None)

     Return information about the transport or underlying resources it
     uses.

     `name' is a string representing the piece of transport-specific
     information to get.

     `default' is the value to return if the information is not
     available, or if the transport does not support querying it with
     the given third-party event loop implementation or on the current
     platform.

     For example, the following code attempts to get the underlying
     socket object of the transport:

          sock = transport.get_extra_info('socket') if sock is not None:     print(sock.getsockopt(...))

     Categories of information that can be queried on some transports:

        * socket:

             - ‘'peername'’: the remote address to which the socket is
               connected, result of *note socket.socket.getpeername():
               2535. (‘None’ on error)

             - ‘'socket'’: *note socket.socket: 668. instance

             - ‘'sockname'’: the socket’s own address, result of *note
               socket.socket.getsockname(): 2536.

        * SSL socket:

             - ‘'compression'’: the compression algorithm being used as
               a string, or ‘None’ if the connection isn’t compressed;
               result of *note ssl.SSLSocket.compression(): a8a.

             - ‘'cipher'’: a three-value tuple containing the name of
               the cipher being used, the version of the SSL protocol
               that defines its use, and the number of secret bits being
               used; result of *note ssl.SSLSocket.cipher(): 2537.

             - ‘'peercert'’: peer certificate; result of *note
               ssl.SSLSocket.getpeercert(): 8c5.

             - ‘'sslcontext'’: *note ssl.SSLContext: 3d9. instance

             - ‘'ssl_object'’: *note ssl.SSLObject: 3d8. or *note
               ssl.SSLSocket: 3d7. instance

        * pipe:

             - ‘'pipe'’: pipe object

        * subprocess:

             - ‘'subprocess'’: *note subprocess.Popen: 2b7. instance

 -- Method: BaseTransport.set_protocol (protocol)

     Set a new protocol.

     Switching protocol should only be done when both protocols are
     documented to support the switch.

 -- Method: BaseTransport.get_protocol ()

     Return the current protocol.


File: python.info,  Node: Read-only Transports,  Next: Write-only Transports,  Prev: Base Transport,  Up: Transports

5.19.1.76 Read-only Transports
..............................

 -- Method: ReadTransport.is_reading ()

     Return ‘True’ if the transport is receiving new data.

     New in version 3.7.

 -- Method: ReadTransport.pause_reading ()

     Pause the receiving end of the transport.  No data will be passed
     to the protocol’s *note protocol.data_received(): 253b. method
     until *note resume_reading(): 35d. is called.

     Changed in version 3.7: The method is idempotent, i.e.  it can be
     called when the transport is already paused or closed.

 -- Method: ReadTransport.resume_reading ()

     Resume the receiving end.  The protocol’s *note
     protocol.data_received(): 253b. method will be called once again if
     some data is available for reading.

     Changed in version 3.7: The method is idempotent, i.e.  it can be
     called when the transport is already reading.


File: python.info,  Node: Write-only Transports,  Next: Datagram Transports,  Prev: Read-only Transports,  Up: Transports

5.19.1.77 Write-only Transports
...............................

 -- Method: WriteTransport.abort ()

     Close the transport immediately, without waiting for pending
     operations to complete.  Buffered data will be lost.  No more data
     will be received.  The protocol’s *note protocol.connection_lost():
     2534. method will eventually be called with *note None: 157. as its
     argument.

 -- Method: WriteTransport.can_write_eof ()

     Return *note True: 48f. if the transport supports *note
     write_eof(): 253f, *note False: 37d. if not.

 -- Method: WriteTransport.get_write_buffer_size ()

     Return the current size of the output buffer used by the transport.

 -- Method: WriteTransport.get_write_buffer_limits ()

     Get the `high' and `low' watermarks for write flow control.  Return
     a tuple ‘(low, high)’ where `low' and `high' are positive number of
     bytes.

     Use *note set_write_buffer_limits(): 2541. to set the limits.

     New in version 3.4.2.

 -- Method: WriteTransport.set_write_buffer_limits (high=None, low=None)

     Set the `high' and `low' watermarks for write flow control.

     These two values (measured in number of bytes) control when the
     protocol’s *note protocol.pause_writing(): 2542. and *note
     protocol.resume_writing(): 2543. methods are called.  If specified,
     the low watermark must be less than or equal to the high watermark.
     Neither `high' nor `low' can be negative.

     *note pause_writing(): 2542. is called when the buffer size becomes
     greater than or equal to the `high' value.  If writing has been
     paused, *note resume_writing(): 2543. is called when the buffer
     size becomes less than or equal to the `low' value.

     The defaults are implementation-specific.  If only the high
     watermark is given, the low watermark defaults to an
     implementation-specific value less than or equal to the high
     watermark.  Setting `high' to zero forces `low' to zero as well,
     and causes *note pause_writing(): 2542. to be called whenever the
     buffer becomes non-empty.  Setting `low' to zero causes *note
     resume_writing(): 2543. to be called only once the buffer is empty.
     Use of zero for either limit is generally sub-optimal as it reduces
     opportunities for doing I/O and computation concurrently.

     Use *note get_write_buffer_limits(): 690. to get the limits.

 -- Method: WriteTransport.write (data)

     Write some `data' bytes to the transport.

     This method does not block; it buffers the data and arranges for it
     to be sent out asynchronously.

 -- Method: WriteTransport.writelines (list_of_data)

     Write a list (or any iterable) of data bytes to the transport.
     This is functionally equivalent to calling *note write(): 2544. on
     each element yielded by the iterable, but may be implemented more
     efficiently.

 -- Method: WriteTransport.write_eof ()

     Close the write end of the transport after flushing all buffered
     data.  Data may still be received.

     This method can raise *note NotImplementedError: 603. if the
     transport (e.g.  SSL) doesn’t support half-closed connections.


File: python.info,  Node: Datagram Transports,  Next: Subprocess Transports,  Prev: Write-only Transports,  Up: Transports

5.19.1.78 Datagram Transports
.............................

 -- Method: DatagramTransport.sendto (data, addr=None)

     Send the `data' bytes to the remote peer given by `addr' (a
     transport-dependent target address).  If `addr' is *note None: 157,
     the data is sent to the target address given on transport creation.

     This method does not block; it buffers the data and arranges for it
     to be sent out asynchronously.

 -- Method: DatagramTransport.abort ()

     Close the transport immediately, without waiting for pending
     operations to complete.  Buffered data will be lost.  No more data
     will be received.  The protocol’s *note protocol.connection_lost():
     2534. method will eventually be called with *note None: 157. as its
     argument.


File: python.info,  Node: Subprocess Transports,  Prev: Datagram Transports,  Up: Transports

5.19.1.79 Subprocess Transports
...............................

 -- Method: SubprocessTransport.get_pid ()

     Return the subprocess process id as an integer.

 -- Method: SubprocessTransport.get_pipe_transport (fd)

     Return the transport for the communication pipe corresponding to
     the integer file descriptor `fd':

        * ‘0’: readable streaming transport of the standard input
          (`stdin'), or *note None: 157. if the subprocess was not
          created with ‘stdin=PIPE’

        * ‘1’: writable streaming transport of the standard output
          (`stdout'), or *note None: 157. if the subprocess was not
          created with ‘stdout=PIPE’

        * ‘2’: writable streaming transport of the standard error
          (`stderr'), or *note None: 157. if the subprocess was not
          created with ‘stderr=PIPE’

        * other `fd': *note None: 157.

 -- Method: SubprocessTransport.get_returncode ()

     Return the subprocess return code as an integer or *note None: 157.
     if it hasn’t returned, which is similar to the *note
     subprocess.Popen.returncode: 23bf. attribute.

 -- Method: SubprocessTransport.kill ()

     Kill the subprocess.

     On POSIX systems, the function sends SIGKILL to the subprocess.  On
     Windows, this method is an alias for *note terminate(): 254e.

     See also *note subprocess.Popen.kill(): 23c5.

 -- Method: SubprocessTransport.send_signal (signal)

     Send the `signal' number to the subprocess, as in *note
     subprocess.Popen.send_signal(): 23c3.

 -- Method: SubprocessTransport.terminate ()

     Stop the subprocess.

     On POSIX systems, this method sends SIGTERM to the subprocess.  On
     Windows, the Windows API function TerminateProcess() is called to
     stop the subprocess.

     See also *note subprocess.Popen.terminate(): 23c4.

 -- Method: SubprocessTransport.close ()

     Kill the subprocess by calling the *note kill(): 254d. method.

     If the subprocess hasn’t returned yet, and close transports of
     `stdin', `stdout', and `stderr' pipes.


File: python.info,  Node: Protocols,  Next: Examples<15>,  Prev: Transports,  Up: Transports and Protocols

5.19.1.80 Protocols
...................

`Source code:' Lib/asyncio/protocols.py(1)

__________________________________________________________________

asyncio provides a set of abstract base classes that should be used to
implement network protocols.  Those classes are meant to be used
together with *note transports: 24ee.

Subclasses of abstract base protocol classes may implement some or all
methods.  All these methods are callbacks: they are called by transports
on certain events, for example when some data is received.  A base
protocol method should be called by the corresponding transport.

* Menu:

* Base Protocols::
* Base Protocol::
* Streaming Protocols::
* Buffered Streaming Protocols::
* Datagram Protocols::
* Subprocess Protocols::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/protocols.py


File: python.info,  Node: Base Protocols,  Next: Base Protocol,  Up: Protocols

5.19.1.81 Base Protocols
........................

 -- Class: asyncio.BaseProtocol

     Base protocol with methods that all protocols share.

 -- Class: asyncio.Protocol (BaseProtocol)

     The base class for implementing streaming protocols (TCP, Unix
     sockets, etc).

 -- Class: asyncio.BufferedProtocol (BaseProtocol)

     A base class for implementing streaming protocols with manual
     control of the receive buffer.

 -- Class: asyncio.DatagramProtocol (BaseProtocol)

     The base class for implementing datagram (UDP) protocols.

 -- Class: asyncio.SubprocessProtocol (BaseProtocol)

     The base class for implementing protocols communicating with child
     processes (unidirectional pipes).


File: python.info,  Node: Base Protocol,  Next: Streaming Protocols,  Prev: Base Protocols,  Up: Protocols

5.19.1.82 Base Protocol
.......................

All asyncio protocols can implement Base Protocol callbacks.

Connection Callbacks
....................

Connection callbacks are called on all protocols, exactly once per a
successful connection.  All other protocol callbacks can only be called
between those two methods.

 -- Method: BaseProtocol.connection_made (transport)

     Called when a connection is made.

     The `transport' argument is the transport representing the
     connection.  The protocol is responsible for storing the reference
     to its transport.

 -- Method: BaseProtocol.connection_lost (exc)

     Called when the connection is lost or closed.

     The argument is either an exception object or *note None: 157.  The
     latter means a regular EOF is received, or the connection was
     aborted or closed by this side of the connection.

Flow Control Callbacks
......................

Flow control callbacks can be called by transports to pause or resume
writing performed by the protocol.

See the documentation of the *note set_write_buffer_limits(): 2541.
method for more details.

 -- Method: BaseProtocol.pause_writing ()

     Called when the transport’s buffer goes over the high watermark.

 -- Method: BaseProtocol.resume_writing ()

     Called when the transport’s buffer drains below the low watermark.

If the buffer size equals the high watermark, *note pause_writing():
2542. is not called: the buffer size must go strictly over.

Conversely, *note resume_writing(): 2543. is called when the buffer size
is equal or lower than the low watermark.  These end conditions are
important to ensure that things go as expected when either mark is zero.


File: python.info,  Node: Streaming Protocols,  Next: Buffered Streaming Protocols,  Prev: Base Protocol,  Up: Protocols

5.19.1.83 Streaming Protocols
.............................

Event methods, such as *note loop.create_server(): 352, *note
loop.create_unix_server(): 353, *note loop.create_connection(): 1b0,
*note loop.create_unix_connection(): 2462, *note
loop.connect_accepted_socket(): 35a, *note loop.connect_read_pipe():
24a1, and *note loop.connect_write_pipe(): 24a2. accept factories that
return streaming protocols.

 -- Method: Protocol.data_received (data)

     Called when some data is received.  `data' is a non-empty bytes
     object containing the incoming data.

     Whether the data is buffered, chunked or reassembled depends on the
     transport.  In general, you shouldn’t rely on specific semantics
     and instead make your parsing generic and flexible.  However, data
     is always received in the correct order.

     The method can be called an arbitrary number of times while a
     connection is open.

     However, *note protocol.eof_received(): 2554. is called at most
     once.  Once ‘eof_received()’ is called, ‘data_received()’ is not
     called anymore.

 -- Method: Protocol.eof_received ()

     Called when the other end signals it won’t send any more data (for
     example by calling *note transport.write_eof(): 253f, if the other
     end also uses asyncio).

     This method may return a false value (including ‘None’), in which
     case the transport will close itself.  Conversely, if this method
     returns a true value, the protocol used determines whether to close
     the transport.  Since the default implementation returns ‘None’, it
     implicitly closes the connection.

     Some transports, including SSL, don’t support half-closed
     connections, in which case returning true from this method will
     result in the connection being closed.

State machine:

     start -> connection_made     [-> data_received]*     [-> eof_received]? -> connection_lost -> end


File: python.info,  Node: Buffered Streaming Protocols,  Next: Datagram Protocols,  Prev: Streaming Protocols,  Up: Protocols

5.19.1.84 Buffered Streaming Protocols
......................................

New in version 3.7: `Important:' this has been added to asyncio in
Python 3.7 `on a provisional basis'!  This is as an experimental API
that might be changed or removed completely in Python 3.8.

Buffered Protocols can be used with any event loop method that supports
*note Streaming Protocols: 2553.

‘BufferedProtocol’ implementations allow explicit manual allocation and
control of the receive buffer.  Event loops can then use the buffer
provided by the protocol to avoid unnecessary data copies.  This can
result in noticeable performance improvement for protocols that receive
big amounts of data.  Sophisticated protocol implementations can
significantly reduce the number of buffer allocations.

The following callbacks are called on *note BufferedProtocol: 2c7.
instances:

 -- Method: BufferedProtocol.get_buffer (sizehint)

     Called to allocate a new receive buffer.

     `sizehint' is the recommended minimum size for the returned buffer.
     It is acceptable to return smaller or larger buffers than what
     `sizehint' suggests.  When set to -1, the buffer size can be
     arbitrary.  It is an error to return a buffer with a zero size.

     ‘get_buffer()’ must return an object implementing the *note buffer
     protocol: 1579.

 -- Method: BufferedProtocol.buffer_updated (nbytes)

     Called when the buffer was updated with the received data.

     `nbytes' is the total number of bytes that were written to the
     buffer.

 -- Method: BufferedProtocol.eof_received ()

     See the documentation of the *note protocol.eof_received(): 2554.
     method.

*note get_buffer(): 2556. can be called an arbitrary number of times
during a connection.  However, *note protocol.eof_received(): 2554. is
called at most once and, if called, *note get_buffer(): 2556. and *note
buffer_updated(): 2557. won’t be called after it.

State machine:

     start -> connection_made     [-> get_buffer         [-> buffer_updated]?     ]*     [-> eof_received]? -> connection_lost -> end


File: python.info,  Node: Datagram Protocols,  Next: Subprocess Protocols,  Prev: Buffered Streaming Protocols,  Up: Protocols

5.19.1.85 Datagram Protocols
............................

Datagram Protocol instances should be constructed by protocol factories
passed to the *note loop.create_datagram_endpoint(): 2e5. method.

 -- Method: DatagramProtocol.datagram_received (data, addr)

     Called when a datagram is received.  `data' is a bytes object
     containing the incoming data.  `addr' is the address of the peer
     sending the data; the exact format depends on the transport.

 -- Method: DatagramProtocol.error_received (exc)

     Called when a previous send or receive operation raises an *note
     OSError: 1d1.  `exc' is the *note OSError: 1d1. instance.

     This method is called in rare conditions, when the transport (e.g.
     UDP) detects that a datagram could not be delivered to its
     recipient.  In many conditions though, undeliverable datagrams will
     be silently dropped.

     Note: On BSD systems (macOS, FreeBSD, etc.)  flow control is not
     supported for datagram protocols, because there is no reliable way
     to detect send failures caused by writing too many packets.

     The socket always appears ‘ready’ and excess packets are dropped.
     An *note OSError: 1d1. with ‘errno’ set to *note errno.ENOBUFS:
     21de. may or may not be raised; if it is raised, it will be
     reported to *note DatagramProtocol.error_received(): 255b. but
     otherwise ignored.


File: python.info,  Node: Subprocess Protocols,  Prev: Datagram Protocols,  Up: Protocols

5.19.1.86 Subprocess Protocols
..............................

Datagram Protocol instances should be constructed by protocol factories
passed to the *note loop.subprocess_exec(): 2430. and *note
loop.subprocess_shell(): 249f. methods.

 -- Method: SubprocessProtocol.pipe_data_received (fd, data)

     Called when the child process writes data into its stdout or stderr
     pipe.

     `fd' is the integer file descriptor of the pipe.

     `data' is a non-empty bytes object containing the received data.

 -- Method: SubprocessProtocol.pipe_connection_lost (fd, exc)

     Called when one of the pipes communicating with the child process
     is closed.

     `fd' is the integer file descriptor that was closed.

 -- Method: SubprocessProtocol.process_exited ()

     Called when the child process has exited.


File: python.info,  Node: Examples<15>,  Prev: Protocols,  Up: Transports and Protocols

5.19.1.87 Examples
..................

* Menu:

* TCP Echo Server::
* TCP Echo Client::
* UDP Echo Server::
* UDP Echo Client::
* Connecting Existing Sockets::
* loop.subprocess_exec() and SubprocessProtocol: loop subprocess_exec and SubprocessProtocol.


File: python.info,  Node: TCP Echo Server,  Next: TCP Echo Client,  Up: Examples<15>

5.19.1.88 TCP Echo Server
.........................

Create a TCP echo server using the *note loop.create_server(): 352.
method, send back received data, and close the connection:

     import asyncio   class EchoServerProtocol(asyncio.Protocol):     def connection_made(self, transport):         peername = transport.get_extra_info('peername')         print('Connection from {}'.format(peername))         self.transport = transport      def data_received(self, data):         message = data.decode()         print('Data received: {!r}'.format(message))          print('Send: {!r}'.format(message))         self.transport.write(data)          print('Close the client socket')         self.transport.close()   async def main():     # Get a reference to the event loop as we plan to use     # low-level APIs.     loop = asyncio.get_running_loop()      server = await loop.create_server(         lambda: EchoServerProtocol(),         '127.0.0.1', 8888)      async with server:         await server.serve_forever()   asyncio.run(main())

See also
........

The *note TCP echo server using streams: 2477. example uses the
high-level *note asyncio.start_server(): 359. function.


File: python.info,  Node: TCP Echo Client,  Next: UDP Echo Server,  Prev: TCP Echo Server,  Up: Examples<15>

5.19.1.89 TCP Echo Client
.........................

A TCP echo client using the *note loop.create_connection(): 1b0. method,
sends data, and waits until the connection is closed:

     import asyncio   class EchoClientProtocol(asyncio.Protocol):     def __init__(self, message, on_con_lost):         self.message = message         self.on_con_lost = on_con_lost      def connection_made(self, transport):         transport.write(self.message.encode())         print('Data sent: {!r}'.format(self.message))      def data_received(self, data):         print('Data received: {!r}'.format(data.decode()))      def connection_lost(self, exc):         print('The server closed the connection')         self.on_con_lost.set_result(True)   async def main():     # Get a reference to the event loop as we plan to use     # low-level APIs.     loop = asyncio.get_running_loop()      on_con_lost = loop.create_future()     message = 'Hello World!'      transport, protocol = await loop.create_connection(         lambda: EchoClientProtocol(message, on_con_lost),         '127.0.0.1', 8888)      # Wait until the protocol signals that the connection     # is lost and close the transport.     try:         await on_con_lost     finally:         transport.close()   asyncio.run(main())

See also
........

The *note TCP echo client using streams: 2474. example uses the
high-level *note asyncio.open_connection(): 358. function.


File: python.info,  Node: UDP Echo Server,  Next: UDP Echo Client,  Prev: TCP Echo Client,  Up: Examples<15>

5.19.1.90 UDP Echo Server
.........................

A UDP echo server, using the *note loop.create_datagram_endpoint(): 2e5.
method, sends back received data:

     import asyncio   class EchoServerProtocol:     def connection_made(self, transport):         self.transport = transport      def datagram_received(self, data, addr):         message = data.decode()         print('Received %r from %s' % (message, addr))         print('Send %r to %s' % (message, addr))         self.transport.sendto(data, addr)   async def main():     print("Starting UDP server")      # Get a reference to the event loop as we plan to use     # low-level APIs.     loop = asyncio.get_running_loop()      # One protocol instance will be created to serve all     # client requests.     transport, protocol = await loop.create_datagram_endpoint(         lambda: EchoServerProtocol(),         local_addr=('127.0.0.1', 9999))      try:         await asyncio.sleep(3600)  # Serve for 1 hour.     finally:         transport.close()   asyncio.run(main())


File: python.info,  Node: UDP Echo Client,  Next: Connecting Existing Sockets,  Prev: UDP Echo Server,  Up: Examples<15>

5.19.1.91 UDP Echo Client
.........................

A UDP echo client, using the *note loop.create_datagram_endpoint(): 2e5.
method, sends data and closes the transport when it receives the answer:

     import asyncio   class EchoClientProtocol:     def __init__(self, message, on_con_lost):         self.message = message         self.on_con_lost = on_con_lost         self.transport = None      def connection_made(self, transport):         self.transport = transport         print('Send:', self.message)         self.transport.sendto(self.message.encode())      def datagram_received(self, data, addr):         print("Received:", data.decode())          print("Close the socket")         self.transport.close()      def error_received(self, exc):         print('Error received:', exc)      def connection_lost(self, exc):         print("Connection closed")         self.on_con_lost.set_result(True)   async def main():     # Get a reference to the event loop as we plan to use     # low-level APIs.     loop = asyncio.get_running_loop()      on_con_lost = loop.create_future()     message = "Hello World!"      transport, protocol = await loop.create_datagram_endpoint(         lambda: EchoClientProtocol(message, on_con_lost),         remote_addr=('127.0.0.1', 9999))      try:         await on_con_lost     finally:         transport.close()   asyncio.run(main())


File: python.info,  Node: Connecting Existing Sockets,  Next: loop subprocess_exec and SubprocessProtocol,  Prev: UDP Echo Client,  Up: Examples<15>

5.19.1.92 Connecting Existing Sockets
.....................................

Wait until a socket receives data using the *note
loop.create_connection(): 1b0. method with a protocol:

     import asyncio import socket   class MyProtocol(asyncio.Protocol):      def __init__(self, on_con_lost):         self.transport = None         self.on_con_lost = on_con_lost      def connection_made(self, transport):         self.transport = transport      def data_received(self, data):         print("Received:", data.decode())          # We are done: close the transport;         # connection_lost() will be called automatically.         self.transport.close()      def connection_lost(self, exc):         # The socket has been closed         self.on_con_lost.set_result(True)   async def main():     # Get a reference to the event loop as we plan to use     # low-level APIs.     loop = asyncio.get_running_loop()     on_con_lost = loop.create_future()      # Create a pair of connected sockets     rsock, wsock = socket.socketpair()      # Register the socket to wait for data.     transport, protocol = await loop.create_connection(         lambda: MyProtocol(on_con_lost), sock=rsock)      # Simulate the reception of data from the network.     loop.call_soon(wsock.send, 'abc'.encode())      try:         await protocol.on_con_lost     finally:         transport.close()         wsock.close()  asyncio.run(main())

See also
........

The *note watch a file descriptor for read events: 247e. example uses
the low-level *note loop.add_reader(): 247f. method to register an FD.

The *note register an open socket to wait for data using streams: 247b.
example uses high-level streams created by the *note open_connection():
358. function in a coroutine.


File: python.info,  Node: loop subprocess_exec and SubprocessProtocol,  Prev: Connecting Existing Sockets,  Up: Examples<15>

5.19.1.93 loop.subprocess_exec() and SubprocessProtocol
.......................................................

An example of a subprocess protocol used to get the output of a
subprocess and to wait for the subprocess exit.

The subprocess is created by th *note loop.subprocess_exec(): 2430.
method:

     import asyncio import sys  class DateProtocol(asyncio.SubprocessProtocol):     def __init__(self, exit_future):         self.exit_future = exit_future         self.output = bytearray()      def pipe_data_received(self, fd, data):         self.output.extend(data)      def process_exited(self):         self.exit_future.set_result(True)  async def get_date():     # Get a reference to the event loop as we plan to use     # low-level APIs.     loop = asyncio.get_running_loop()      code = 'import datetime; print(datetime.datetime.now())'     exit_future = asyncio.Future(loop=loop)      # Create the subprocess controlled by DateProtocol;     # redirect the standard output into a pipe.     transport, protocol = await loop.subprocess_exec(         lambda: DateProtocol(exit_future),         sys.executable, '-c', code,         stdin=None, stderr=None)      # Wait for the subprocess exit using the process_exited()     # method of the protocol.     await exit_future      # Close the stdout pipe.     transport.close()      # Read the output which was collected by the     # pipe_data_received() method of the protocol.     data = bytes(protocol.output)     return data.decode('ascii').rstrip()  date = asyncio.run(get_date()) print(f"Current date: {date}")

See also the *note same example: 24b9. written using high-level APIs.


File: python.info,  Node: Policies,  Next: Platform Support,  Prev: Transports and Protocols,  Up: asyncio — Asynchronous I/O

5.19.1.94 Policies
..................

An event loop policy is a global per-process object that controls the
management of the event loop.  Each event loop has a default policy,
which can be changed and customized using the policy API.

A policy defines the notion of `context' and manages a separate event
loop per context.  The default policy defines `context' to be the
current thread.

By using a custom event loop policy, the behavior of *note
get_event_loop(): 34a, *note set_event_loop(): 24d7, and *note
new_event_loop(): 24d8. functions can be customized.

Policy objects should implement the APIs defined in the *note
AbstractEventLoopPolicy: 2568. abstract base class.

* Menu:

* Getting and Setting the Policy::
* Policy Objects::
* Process Watchers::
* Custom Policies::


File: python.info,  Node: Getting and Setting the Policy,  Next: Policy Objects,  Up: Policies

5.19.1.95 Getting and Setting the Policy
........................................

The following functions can be used to get and set the policy for the
current process:

 -- Function: asyncio.get_event_loop_policy ()

     Return the current process-wide policy.

 -- Function: asyncio.set_event_loop_policy (policy)

     Set the current process-wide policy to `policy'.

     If `policy' is set to ‘None’, the default policy is restored.


File: python.info,  Node: Policy Objects,  Next: Process Watchers,  Prev: Getting and Setting the Policy,  Up: Policies

5.19.1.96 Policy Objects
........................

The abstract event loop policy base class is defined as follows:

 -- Class: asyncio.AbstractEventLoopPolicy

     An abstract base class for asyncio policies.

      -- Method: get_event_loop ()

          Get the event loop for the current context.

          Return an event loop object implementing the *note
          AbstractEventLoop: 2513. interface.

          This method should never return ‘None’.

          Changed in version 3.6.

      -- Method: set_event_loop (loop)

          Set the event loop for the current context to `loop'.

      -- Method: new_event_loop ()

          Create and return a new event loop object.

          This method should never return ‘None’.

      -- Method: get_child_watcher ()

          Get a child process watcher object.

          Return a watcher object implementing the *note
          AbstractChildWatcher: 2571. interface.

          This function is Unix specific.

      -- Method: set_child_watcher (watcher)

          Set the current child process watcher to `watcher'.

          This function is Unix specific.

asyncio ships with the following built-in policies:

 -- Class: asyncio.DefaultEventLoopPolicy

     The default asyncio policy.  Uses *note SelectorEventLoop: 24b6. on
     Unix and *note ProactorEventLoop: 1a9. on Windows.

     There is no need to install the default policy manually.  asyncio
     is configured to use the default policy automatically.

     Changed in version 3.8: On Windows, *note ProactorEventLoop: 1a9.
     is now used by default.

 -- Class: asyncio.WindowsSelectorEventLoopPolicy

     An alternative event loop policy that uses the *note
     SelectorEventLoop: 24b6. event loop implementation.

     *note Availability: 129a.: Windows.

 -- Class: asyncio.WindowsProactorEventLoopPolicy

     An alternative event loop policy that uses the *note
     ProactorEventLoop: 1a9. event loop implementation.

     *note Availability: 129a.: Windows.


File: python.info,  Node: Process Watchers,  Next: Custom Policies,  Prev: Policy Objects,  Up: Policies

5.19.1.97 Process Watchers
..........................

A process watcher allows customization of how an event loop monitors
child processes on Unix.  Specifically, the event loop needs to know
when a child process has exited.

In asyncio, child processes are created with *note
create_subprocess_exec(): 28f. and *note loop.subprocess_exec(): 2430.
functions.

asyncio defines the *note AbstractChildWatcher: 2571. abstract base
class, which child watchers should implement, and has four different
implementations: *note ThreadedChildWatcher: 24b8. (configured to be
used by default), *note MultiLoopChildWatcher: 2577, *note
SafeChildWatcher: 2578, and *note FastChildWatcher: 2579.

See also the *note Subprocess and Threads: 24af. section.

The following two functions can be used to customize the child process
watcher implementation used by the asyncio event loop:

 -- Function: asyncio.get_child_watcher ()

     Return the current child watcher for the current policy.

 -- Function: asyncio.set_child_watcher (watcher)

     Set the current child watcher to `watcher' for the current policy.
     `watcher' must implement methods defined in the *note
     AbstractChildWatcher: 2571. base class.

     Note: Third-party event loops implementations might not support
     custom child watchers.  For such event loops, using *note
     set_child_watcher(): 257b. might be prohibited or have no effect.

 -- Class: asyncio.AbstractChildWatcher

      -- Method: add_child_handler (pid, callback, *args)

          Register a new child handler.

          Arrange for ‘callback(pid, returncode, *args)’ to be called
          when a process with PID equal to `pid' terminates.  Specifying
          another callback for the same process replaces the previous
          handler.

          The `callback' callable must be thread-safe.

      -- Method: remove_child_handler (pid)

          Removes the handler for process with PID equal to `pid'.

          The function returns ‘True’ if the handler was successfully
          removed, ‘False’ if there was nothing to remove.

      -- Method: attach_loop (loop)

          Attach the watcher to an event loop.

          If the watcher was previously attached to an event loop, then
          it is first detached before attaching to the new loop.

          Note: loop may be ‘None’.

      -- Method: is_active ()

          Return ‘True’ if the watcher is ready to use.

          Spawning a subprocess with `inactive' current child watcher
          raises *note RuntimeError: 2b8.

          New in version 3.8.

      -- Method: close ()

          Close the watcher.

          This method has to be called to ensure that underlying
          resources are cleaned-up.

 -- Class: asyncio.ThreadedChildWatcher

     This implementation starts a new waiting thread for every
     subprocess spawn.

     It works reliably even when the asyncio event loop is run in a
     non-main OS thread.

     There is no noticeable overhead when handling a big number of
     children (`O(1)' each time a child terminates), but stating a
     thread per process requires extra memory.

     This watcher is used by default.

     New in version 3.8.

 -- Class: asyncio.MultiLoopChildWatcher

     This implementation registers a ‘SIGCHLD’ signal handler on
     instantiation.  That can break third-party code that installs a
     custom handler for ‘SIGCHLD’. signal).

     The watcher avoids disrupting other code spawning processes by
     polling every process explicitly on a ‘SIGCHLD’ signal.

     There is no limitation for running subprocesses from different
     threads once the watcher is installed.

     The solution is safe but it has a significant overhead when
     handling a big number of processes (`O(n)' each time a ‘SIGCHLD’ is
     received).

     New in version 3.8.

 -- Class: asyncio.SafeChildWatcher

     This implementation uses active event loop from the main thread to
     handle ‘SIGCHLD’ signal.  If the main thread has no running event
     loop another thread cannot spawn a subprocess (*note RuntimeError:
     2b8. is raised).

     The watcher avoids disrupting other code spawning processes by
     polling every process explicitly on a ‘SIGCHLD’ signal.

     This solution is as safe as *note MultiLoopChildWatcher: 2577. and
     has the same `O(N)' complexity but requires a running event loop in
     the main thread to work.

 -- Class: asyncio.FastChildWatcher

     This implementation reaps every terminated processes by calling
     ‘os.waitpid(-1)’ directly, possibly breaking other code spawning
     processes and waiting for their termination.

     There is no noticeable overhead when handling a big number of
     children (`O(1)' each time a child terminates).

     This solution requires a running event loop in the main thread to
     work, as *note SafeChildWatcher: 2578.


File: python.info,  Node: Custom Policies,  Prev: Process Watchers,  Up: Policies

5.19.1.98 Custom Policies
.........................

To implement a new event loop policy, it is recommended to subclass
*note DefaultEventLoopPolicy: 2573. and override the methods for which
custom behavior is wanted, e.g.:

     class MyEventLoopPolicy(asyncio.DefaultEventLoopPolicy):      def get_event_loop(self):         """Get the event loop.          This may be None or an instance of EventLoop.         """         loop = super().get_event_loop()         # Do something with loop ...         return loop  asyncio.set_event_loop_policy(MyEventLoopPolicy())


File: python.info,  Node: Platform Support,  Next: High-level API Index,  Prev: Policies,  Up: asyncio — Asynchronous I/O

5.19.1.99 Platform Support
..........................

The *note asyncio: a. module is designed to be portable, but some
platforms have subtle differences and limitations due to the platforms’
underlying architecture and capabilities.

* Menu:

* All Platforms::
* Windows: Windows<43>.
* macOS: macOS<18>.


File: python.info,  Node: All Platforms,  Next: Windows<43>,  Up: Platform Support

5.19.1.100 All Platforms
........................

   * *note loop.add_reader(): 247f. and *note loop.add_writer(): 24fa.
     cannot be used to monitor file I/O.


File: python.info,  Node: Windows<43>,  Next: macOS<18>,  Prev: All Platforms,  Up: Platform Support

5.19.1.101 Windows
..................

`Source code:' Lib/asyncio/proactor_events.py(1),
Lib/asyncio/windows_events.py(2), Lib/asyncio/windows_utils.py(3)

__________________________________________________________________

Changed in version 3.8: On Windows, *note ProactorEventLoop: 1a9. is now
the default event loop.

All event loops on Windows do not support the following methods:

   * *note loop.create_unix_connection(): 2462. and *note
     loop.create_unix_server(): 353. are not supported.  The *note
     socket.AF_UNIX: 24f1. socket family is specific to Unix.

   * *note loop.add_signal_handler(): 2431. and *note
     loop.remove_signal_handler(): 2505. are not supported.

*note SelectorEventLoop: 24b6. has the following limitations:

   * *note SelectSelector: 2586. is used to wait on socket events: it
     supports sockets and is limited to 512 sockets.

   * *note loop.add_reader(): 247f. and *note loop.add_writer(): 24fa.
     only accept socket handles (e.g.  pipe file descriptors are not
     supported).

   * Pipes are not supported, so the *note loop.connect_read_pipe():
     24a1. and *note loop.connect_write_pipe(): 24a2. methods are not
     implemented.

   * *note Subprocesses: 242d. are not supported, i.e.  *note
     loop.subprocess_exec(): 2430. and *note loop.subprocess_shell():
     249f. methods are not implemented.

*note ProactorEventLoop: 1a9. has the following limitations:

   * The *note loop.add_reader(): 247f. and *note loop.add_writer():
     24fa. methods are not supported.

The resolution of the monotonic clock on Windows is usually around 15.6
msec.  The best resolution is 0.5 msec.  The resolution depends on the
hardware (availability of HPET(4)) and on the Windows configuration.

* Menu:

* Subprocess Support on Windows::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/proactor_events.py

   (2) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/windows_events.py

   (3) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/windows_utils.py

   (4) https://en.wikipedia.org/wiki/High_Precision_Event_Timer


File: python.info,  Node: Subprocess Support on Windows,  Up: Windows<43>

5.19.1.102 Subprocess Support on Windows
........................................

On Windows, the default event loop *note ProactorEventLoop: 1a9.
supports subprocesses, whereas *note SelectorEventLoop: 24b6. does not.

The *note policy.set_child_watcher(): 2572. function is also not
supported, as *note ProactorEventLoop: 1a9. has a different mechanism to
watch child processes.


File: python.info,  Node: macOS<18>,  Prev: Windows<43>,  Up: Platform Support

5.19.1.103 macOS
................

Modern macOS versions are fully supported.

macOS <= 10.8
.............

On macOS 10.6, 10.7 and 10.8, the default event loop uses *note
selectors.KqueueSelector: 2589, which does not support character devices
on these versions.  The *note SelectorEventLoop: 24b6. can be manually
configured to use *note SelectSelector: 2586. or *note PollSelector:
442. to support character devices on these older versions of macOS.
Example:

     import asyncio import selectors  selector = selectors.SelectSelector() loop = asyncio.SelectorEventLoop(selector) asyncio.set_event_loop(loop)


File: python.info,  Node: High-level API Index,  Next: Low-level API Index,  Prev: Platform Support,  Up: asyncio — Asynchronous I/O

5.19.1.104 High-level API Index
...............................

This page lists all high-level async/await enabled asyncio APIs.

* Menu:

* Tasks::
* Queues: Queues<2>.
* Subprocesses: Subprocesses<2>.
* Streams: Streams<2>.
* Synchronization::
* Exceptions: Exceptions<10>.


File: python.info,  Node: Tasks,  Next: Queues<2>,  Up: High-level API Index

5.19.1.105 Tasks
................

Utilities to run asyncio programs, create Tasks, and await on multiple
things with timeouts.

*note run(): 1a4.                                      Create event loop, run a coroutine, close the loop.
                                                       
                                                       
*note create_task(): 1ac.                              Start an asyncio Task.
                                                       
                                                       
‘await’ *note sleep(): 283.                            Sleep for a number of seconds.
                                                       
                                                       
‘await’ *note gather(): 284.                           Schedule and wait for things concurrently.
                                                       
                                                       
‘await’ *note wait_for(): 286.                         Run with a timeout.
                                                       
                                                       
‘await’ *note shield(): 285.                           Shield from cancellation.
                                                       
                                                       
‘await’ *note wait(): 287.                             Monitor for completion.
                                                       
                                                       
*note current_task(): 345.                             Return the current Task.
                                                       
                                                       
*note all_tasks(): 346.                                Return all tasks for an event loop.
                                                       
                                                       
*note Task: 1ab.                                       Task object.
                                                       
                                                       
*note run_coroutine_threadsafe(): 50f.                 Schedule a coroutine from another OS thread.
                                                       
                                                       
‘for in’ *note as_completed(): 288.                    Monitor for completion with a ‘for’ loop.
                                                       

Examples
........

   * *note Using asyncio.gather() to run things in parallel: 2440.

   * *note Using asyncio.wait_for() to enforce a timeout: 2445.

   * *note Cancellation: 2450.

   * *note Using asyncio.sleep(): 243e.

   * See also the main *note Tasks documentation page: 242b.


File: python.info,  Node: Queues<2>,  Next: Subprocesses<2>,  Prev: Tasks,  Up: High-level API Index

5.19.1.106 Queues
.................

Queues should be used to distribute work amongst multiple asyncio Tasks,
implement connection pools, and pub/sub patterns.

*note Queue: 28e.                                      A FIFO queue.
                                                       
                                                       
*note PriorityQueue: 24ca.                             A priority queue.
                                                       
                                                       
*note LifoQueue: 24cc.                                 A LIFO queue.
                                                       

Examples
........

   * *note Using asyncio.Queue to distribute workload between several
     Tasks: 24ce.

   * See also the *note Queues documentation page: 242e.


File: python.info,  Node: Subprocesses<2>,  Next: Streams<2>,  Prev: Queues<2>,  Up: High-level API Index

5.19.1.107 Subprocesses
.......................

Utilities to spawn subprocesses and run shell commands.

‘await’ *note create_subprocess_exec(): 28f.           Create a subprocess.
                                                       
                                                       
‘await’ *note create_subprocess_shell(): 290.          Run a shell command.
                                                       

Examples
........

   * *note Executing a shell command: 249b.

   * See also the *note subprocess APIs: 242d. documentation.


File: python.info,  Node: Streams<2>,  Next: Synchronization,  Prev: Subprocesses<2>,  Up: High-level API Index

5.19.1.108 Streams
..................

High-level APIs to work with network IO.

‘await’ *note open_connection(): 358.                  Establish a TCP connection.
                                                       
                                                       
‘await’ *note open_unix_connection(): 2461.            Establish a Unix socket connection.
                                                       
                                                       
‘await’ *note start_server(): 359.                     Start a TCP server.
                                                       
                                                       
‘await’ *note start_unix_server(): 2463.               Start a Unix socket server.
                                                       
                                                       
*note StreamReader: efc.                               High-level async/await object to receive network
                                                       data.
                                                       
                                                       
*note StreamWriter: efd.                               High-level async/await object to send network data.
                                                       

Examples
........

   * *note Example TCP client: 245f.

   * See also the *note streams APIs: 242c. documentation.


File: python.info,  Node: Synchronization,  Next: Exceptions<10>,  Prev: Streams<2>,  Up: High-level API Index

5.19.1.109 Synchronization
..........................

Threading-like synchronization primitives that can be used in Tasks.

*note Lock: 289.                                       A mutex lock.
                                                       
                                                       
*note Event: 28a.                                      An event object.
                                                       
                                                       
*note Condition: 28b.                                  A condition object.
                                                       
                                                       
*note Semaphore: 28c.                                  A semaphore.
                                                       
                                                       
*note BoundedSemaphore: 28d.                           A bounded semaphore.
                                                       

Examples
........

   * *note Using asyncio.Event: 2488.

   * See also the documentation of asyncio *note synchronization
     primitives: 242f.


File: python.info,  Node: Exceptions<10>,  Prev: Synchronization,  Up: High-level API Index

5.19.1.110 Exceptions
.....................

*note asyncio.TimeoutError: 2444.                      Raised on timeout by functions like
                                                       *note wait_for(): 286.  Keep in mind that
                                                       ‘asyncio.TimeoutError’ is `unrelated' to the
                                                       built-in *note TimeoutError: 990. exception.
                                                       
                                                       
*note asyncio.CancelledError: 1a6.                     Raised when a Task is cancelled.  See also
                                                       *note Task.cancel(): 2442.
                                                       

Examples
........

   * *note Handling CancelledError to run code on cancellation request:
     2450.

   * See also the full list of *note asyncio-specific exceptions: 24d0.


File: python.info,  Node: Low-level API Index,  Next: Developing with asyncio,  Prev: High-level API Index,  Up: asyncio — Asynchronous I/O

5.19.1.111 Low-level API Index
..............................

This page lists all low-level asyncio APIs.

* Menu:

* Obtaining the Event Loop::
* Event Loop Methods: Event Loop Methods<2>.
* Transports: Transports<2>.
* Protocols: Protocols<2>.
* Event Loop Policies::


File: python.info,  Node: Obtaining the Event Loop,  Next: Event Loop Methods<2>,  Up: Low-level API Index

5.19.1.112 Obtaining the Event Loop
...................................

*note asyncio.get_running_loop(): 349.                 The `preferred' function to get the running event
                                                       loop.
                                                       
                                                       
*note asyncio.get_event_loop(): 34a.                   Get an event loop instance (current or via the
                                                       policy).
                                                       
                                                       
*note asyncio.set_event_loop(): 24d7.                  Set the event loop as current via the current
                                                       policy.
                                                       
                                                       
*note asyncio.new_event_loop(): 24d8.                  Create a new event loop.
                                                       

Examples
........

   * *note Using asyncio.get_running_loop(): 2525.


File: python.info,  Node: Event Loop Methods<2>,  Next: Transports<2>,  Prev: Obtaining the Event Loop,  Up: Low-level API Index

5.19.1.113 Event Loop Methods
.............................

See also the main documentation section about the *note event loop
methods: 638.

Lifecycle
.........

*note loop.run_until_complete(): 50d.                  Run a Future/Task/awaitable until complete.
                                                       
                                                       
*note loop.run_forever(): 24e1.                        Run the event loop forever.
                                                       
                                                       
*note loop.stop(): 515.                                Stop the event loop.
                                                       
                                                       
*note loop.close(): 24e3.                              Close the event loop.
                                                       
                                                       
*note loop.is_running(): 24e2.                         Return ‘True’ if the event loop is running.
                                                       
                                                       
*note loop.is_closed(): 68f.                           Return ‘True’ if the event loop is closed.
                                                       
                                                       
‘await’ *note loop.shutdown_asyncgens(): 516.          Close asynchronous generators.
                                                       

Debugging
.........

*note loop.set_debug(): 68d.                           Enable or disable the debug mode.
                                                       
                                                       
*note loop.get_debug(): 68e.                           Get the current debug mode.
                                                       

Scheduling Callbacks
....................

*note loop.call_soon(): 33e.                           Invoke a callback soon.
                                                       
                                                       
*note loop.call_soon_threadsafe(): 33f.                A thread-safe variant of
                                                       *note loop.call_soon(): 33e.
                                                       
                                                       
*note loop.call_later(): 340.                          Invoke a callback `after' the given time.
                                                       
                                                       
*note loop.call_at(): 341.                             Invoke a callback `at' the given time.
                                                       

Thread/Process Pool
...................

‘await’ *note loop.run_in_executor(): 243a.            Run a CPU-bound or other blocking function in a
                                                       *note concurrent.futures: 22. executor.
                                                       
                                                       
*note loop.set_default_executor(): 279.                Set the default executor for
                                                       *note loop.run_in_executor(): 243a.
                                                       

Tasks and Futures
.................

*note loop.create_future(): 511.                       Create a *note Future: 438. object.
                                                       
                                                       
*note loop.create_task(): 1ad.                         Schedule coroutine as a *note Task: 1ab.
                                                       
                                                       
*note loop.set_task_factory(): 691.                    Set a factory used by *note loop.create_task(): 1ad.
                                                       to create *note Tasks: 1ab.
                                                       
                                                       
*note loop.get_task_factory(): 692.                    Get the factory *note loop.create_task(): 1ad. uses
                                                       to create *note Tasks: 1ab.
                                                       

DNS
...

‘await’ *note loop.getaddrinfo(): 497.                 Asynchronous version of
                                                       *note socket.getaddrinfo(): 24ff.
                                                       
                                                       
‘await’ *note loop.getnameinfo(): 498.                 Asynchronous version of
                                                       *note socket.getnameinfo(): 2500.
                                                       

Networking and IPC
..................

‘await’ *note loop.create_connection(): 1b0.           Open a TCP connection.
                                                       
                                                       
‘await’ *note loop.create_server(): 352.               Create a TCP server.
                                                       
                                                       
‘await’ *note loop.create_unix_connection(): 2462.     Open a Unix socket connection.
                                                       
                                                       
‘await’ *note loop.create_unix_server(): 353.          Create a Unix socket server.
                                                       
                                                       
‘await’ *note loop.connect_accepted_socket(): 35a.     Wrap a *note socket: 668. into a ‘(transport,
                                                       protocol)’ pair.
                                                       
                                                       
‘await’ *note loop.create_datagram_endpoint(): 2e5.    Open a datagram (UDP) connection.
                                                       
                                                       
‘await’ *note loop.sendfile(): 24f6.                   Send a file over a transport.
                                                       
                                                       
‘await’ *note loop.start_tls(): 343.                   Upgrade an existing connection to TLS.
                                                       
                                                       
‘await’ *note loop.connect_read_pipe(): 24a1.          Wrap a read end of a pipe into a ‘(transport,
                                                       protocol)’ pair.
                                                       
                                                       
‘await’ *note loop.connect_write_pipe(): 24a2.         Wrap a write end of a pipe into a ‘(transport,
                                                       protocol)’ pair.
                                                       

Sockets
.......

‘await’ *note loop.sock_recv(): 494.                   Receive data from the *note socket: 668.
                                                       
                                                       
‘await’ *note loop.sock_recv_into(): 344.              Receive data from the *note socket: 668. into a
                                                       buffer.
                                                       
                                                       
‘await’ *note loop.sock_sendall(): 495.                Send data to the *note socket: 668.
                                                       
                                                       
‘await’ *note loop.sock_connect(): 695.                Connect the *note socket: 668.
                                                       
                                                       
‘await’ *note loop.sock_accept(): 496.                 Accept a *note socket: 668. connection.
                                                       
                                                       
‘await’ *note loop.sock_sendfile(): 34d.               Send a file over the *note socket: 668.
                                                       
                                                       
*note loop.add_reader(): 247f.                         Start watching a file descriptor for read
                                                       availability.
                                                       
                                                       
*note loop.remove_reader(): 24f9.                      Stop watching a file descriptor for read
                                                       availability.
                                                       
                                                       
*note loop.add_writer(): 24fa.                         Start watching a file descriptor for write
                                                       availability.
                                                       
                                                       
*note loop.remove_writer(): 24fb.                      Stop watching a file descriptor for write
                                                       availability.
                                                       

Unix Signals
............

*note loop.add_signal_handler(): 2431.                 Add a handler for a *note signal: ea.
                                                       
                                                       
*note loop.remove_signal_handler(): 2505.              Remove a handler for a *note signal: ea.
                                                       

Subprocesses
............

*note loop.subprocess_exec(): 2430.                    Spawn a subprocess.
                                                       
                                                       
*note loop.subprocess_shell(): 249f.                   Spawn a subprocess from a shell command.
                                                       

Error Handling
..............

*note loop.call_exception_handler(): 2509.             Call the exception handler.
                                                       
                                                       
*note loop.set_exception_handler(): 2508.              Set a new exception handler.
                                                       
                                                       
*note loop.get_exception_handler(): 512.               Get the current exception handler.
                                                       
                                                       
*note loop.default_exception_handler(): 250a.          The default exception handler implementation.
                                                       

Examples
........

   * *note Using asyncio.get_event_loop() and loop.run_forever(): 2514.

   * *note Using loop.call_later(): 2516.

   * Using ‘loop.create_connection()’ to implement *note an echo-client:
     2476.

   * Using ‘loop.create_connection()’ to *note connect a socket: 247d.

   * *note Using add_reader() to watch an FD for read events: 247e.

   * *note Using loop.add_signal_handler(): 2519.

   * *note Using loop.subprocess_exec(): 24ba.


File: python.info,  Node: Transports<2>,  Next: Protocols<2>,  Prev: Event Loop Methods<2>,  Up: Low-level API Index

5.19.1.114 Transports
.....................

All transports implement the following methods:

*note transport.close(): 2533.                         Close the transport.
                                                       
                                                       
*note transport.is_closing(): 510.                     Return ‘True’ if the transport is closing or is
                                                       closed.
                                                       
                                                       
*note transport.get_extra_info(): 2c6.                 Request for information about the transport.
                                                       
                                                       
*note transport.set_protocol(): 2538.                  Set a new protocol.
                                                       
                                                       
*note transport.get_protocol(): 2539.                  Return the current protocol.
                                                       

Transports that can receive data (TCP and Unix connections, pipes, etc).
Returned from methods like *note loop.create_connection(): 1b0, *note
loop.create_unix_connection(): 2462, *note loop.connect_read_pipe():
24a1, etc:

Read Transports
...............

*note transport.is_reading(): 35c.                     Return ‘True’ if the transport is receiving.
                                                       
                                                       
*note transport.pause_reading(): 35e.                  Pause receiving.
                                                       
                                                       
*note transport.resume_reading(): 35d.                 Resume receiving.
                                                       

Transports that can Send data (TCP and Unix connections, pipes, etc).
Returned from methods like *note loop.create_connection(): 1b0, *note
loop.create_unix_connection(): 2462, *note loop.connect_write_pipe():
24a2, etc:

Write Transports
................

*note transport.write(): 2544.                         Write data to the transport.
                                                       
                                                       
*note transport.writelines(): 2545.                    Write buffers to the transport.
                                                       
                                                       
*note transport.can_write_eof(): 253e.                 Return *note True: 48f. if the transport supports
                                                       sending EOF.
                                                       
                                                       
*note transport.write_eof(): 253f.                     Close and send EOF after flushing buffered data.
                                                       
                                                       
*note transport.abort(): 253d.                         Close the transport immediately.
                                                       
                                                       
*note transport.get_write_buffer_size(): 2540.         Return high and low water marks for write flow
                                                       control.
                                                       
                                                       
*note transport.set_write_buffer_limits(): 2541.       Set new high and low water marks for write flow
                                                       control.
                                                       

Transports returned by *note loop.create_datagram_endpoint(): 2e5.:

Datagram Transports
...................

*note transport.sendto(): 2547.                        Send data to the remote peer.
                                                       
                                                       
*note transport.abort(): 2548.                         Close the transport immediately.
                                                       

Low-level transport abstraction over subprocesses.  Returned by *note
loop.subprocess_exec(): 2430. and *note loop.subprocess_shell(): 249f.:

Subprocess Transports
.....................

*note transport.get_pid(): 254a.                       Return the subprocess process id.
                                                       
                                                       
*note transport.get_pipe_transport(): 254b.            Return the transport for the requested communication
                                                       pipe (`stdin', `stdout', or `stderr').
                                                       
                                                       
*note transport.get_returncode(): 254c.                Return the subprocess return code.
                                                       
                                                       
*note transport.kill(): 254d.                          Kill the subprocess.
                                                       
                                                       
*note transport.send_signal(): 254f.                   Send a signal to the subprocess.
                                                       
                                                       
*note transport.terminate(): 254e.                     Stop the subprocess.
                                                       
                                                       
*note transport.close(): 2550.                         Kill the subprocess and close all pipes.
                                                       


File: python.info,  Node: Protocols<2>,  Next: Event Loop Policies,  Prev: Transports<2>,  Up: Low-level API Index

5.19.1.115 Protocols
....................

Protocol classes can implement the following `callback methods':

‘callback’ *note connection_made(): 24ef.              Called when a connection is made.
                                                       
                                                       
‘callback’ *note connection_lost(): 2534.              Called when the connection is lost or closed.
                                                       
                                                       
‘callback’ *note pause_writing(): 2542.                Called when the transport’s buffer goes over the
                                                       high water mark.
                                                       
                                                       
‘callback’ *note resume_writing(): 2543.               Called when the transport’s buffer drains below the
                                                       low water mark.
                                                       

Streaming Protocols (TCP, Unix Sockets, Pipes)
..............................................

‘callback’ *note data_received(): 253b.                Called when some data is received.
                                                       
                                                       
‘callback’ *note eof_received(): 2554.                 Called when an EOF is received.
                                                       

Buffered Streaming Protocols
............................

‘callback’ *note get_buffer(): 2556.                   Called to allocate a new receive buffer.
                                                       
                                                       
‘callback’ *note buffer_updated(): 2557.               Called when the buffer was updated with the received
                                                       data.
                                                       
                                                       
‘callback’ *note eof_received(): 2558.                 Called when an EOF is received.
                                                       

Datagram Protocols
..................

‘callback’ *note datagram_received(): 255a.            Called when a datagram is received.
                                                       
                                                       
‘callback’ *note error_received(): 255b.               Called when a previous send or receive operation
                                                       raises an *note OSError: 1d1.
                                                       

Subprocess Protocols
....................

‘callback’ *note pipe_data_received(): 255d.           Called when the child process writes data into its
                                                       `stdout' or `stderr' pipe.
                                                       
                                                       
‘callback’ *note pipe_connection_lost(): 255e.         Called when one of the pipes communicating with the
                                                       child process is closed.
                                                       
                                                       
‘callback’ *note process_exited(): 255f.               Called when the child process has exited.
                                                       


File: python.info,  Node: Event Loop Policies,  Prev: Protocols<2>,  Up: Low-level API Index

5.19.1.116 Event Loop Policies
..............................

Policies is a low-level mechanism to alter the behavior of functions
like *note asyncio.get_event_loop(): 34a.  See also the main *note
policies section: 24d9. for more details.

Accessing Policies
..................

*note asyncio.get_event_loop_policy(): 256a.           Return the current process-wide policy.
                                                       
                                                       
*note asyncio.set_event_loop_policy(): 256b.           Set a new process-wide policy.
                                                       
                                                       
*note AbstractEventLoopPolicy: 2568.                   Base class for policy objects.
                                                       


File: python.info,  Node: Developing with asyncio,  Prev: Low-level API Index,  Up: asyncio — Asynchronous I/O

5.19.1.117 Developing with asyncio
..................................

Asynchronous programming is different from classic “sequential”
programming.

This page lists common mistakes and traps and explains how to avoid
them.

* Menu:

* Debug Mode::
* Concurrency and Multithreading::
* Running Blocking Code::
* Logging: Logging<3>.
* Detect never-awaited coroutines::
* Detect never-retrieved exceptions::


File: python.info,  Node: Debug Mode,  Next: Concurrency and Multithreading,  Up: Developing with asyncio

5.19.1.118 Debug Mode
.....................

By default asyncio runs in production mode.  In order to ease the
development asyncio has a `debug mode'.

There are several ways to enable asyncio debug mode:

   * Setting the *note PYTHONASYNCIODEBUG: 1297. environment variable to
     ‘1’.

   * Using the *note -X: 155. ‘dev’ Python command line option.

   * Passing ‘debug=True’ to *note asyncio.run(): 1a4.

   * Calling *note loop.set_debug(): 68d.

In addition to enabling the debug mode, consider also:

   * setting the log level of the *note asyncio logger: 259d. to
     ‘logging.DEBUG’, for example the following snippet of code can be
     run at startup of the application:

          logging.basicConfig(level=logging.DEBUG)

   * configuring the *note warnings: 126. module to display *note
     ResourceWarning: 4c5. warnings.  One way of doing that is by using
     the *note -W: 40c. ‘default’ command line option.

When the debug mode is enabled:

   * asyncio checks for *note coroutines that were not awaited: 259e.
     and logs them; this mitigates the “forgotten await” pitfall.

   * Many non-threadsafe asyncio APIs (such as *note loop.call_soon():
     33e. and *note loop.call_at(): 341. methods) raise an exception if
     they are called from a wrong thread.

   * The execution time of the I/O selector is logged if it takes too
     long to perform an I/O operation.

   * Callbacks taking longer than 100ms are logged.  The
     ‘loop.slow_callback_duration’ attribute can be used to set the
     minimum execution duration in seconds that is considered “slow”.


File: python.info,  Node: Concurrency and Multithreading,  Next: Running Blocking Code,  Prev: Debug Mode,  Up: Developing with asyncio

5.19.1.119 Concurrency and Multithreading
.........................................

An event loop runs in a thread (typically the main thread) and executes
all callbacks and Tasks in its thread.  While a Task is running in the
event loop, no other Tasks can run in the same thread.  When a Task
executes an ‘await’ expression, the running Task gets suspended, and the
event loop executes the next Task.

To schedule a callback from a different OS thread, the *note
loop.call_soon_threadsafe(): 33f. method should be used.  Example:

     loop.call_soon_threadsafe(callback, *args)

Almost all asyncio objects are not thread safe, which is typically not a
problem unless there is code that works with them from outside of a Task
or a callback.  If there’s a need for such code to call a low-level
asyncio API, the *note loop.call_soon_threadsafe(): 33f. method should
be used, e.g.:

     loop.call_soon_threadsafe(fut.cancel)

To schedule a coroutine object from a different OS thread, the *note
run_coroutine_threadsafe(): 50f. function should be used.  It returns a
*note concurrent.futures.Future: b20. to access the result:

     async def coro_func():      return await asyncio.sleep(1, 42)  # Later in another OS thread:  future = asyncio.run_coroutine_threadsafe(coro_func(), loop) # Wait for the result: result = future.result()

To handle signals and to execute subprocesses, the event loop must be
run in the main thread.

The *note loop.run_in_executor(): 243a. method can be used with a *note
concurrent.futures.ThreadPoolExecutor: 278. to execute blocking code in
a different OS thread without blocking the OS thread that the event loop
runs in.


File: python.info,  Node: Running Blocking Code,  Next: Logging<3>,  Prev: Concurrency and Multithreading,  Up: Developing with asyncio

5.19.1.120 Running Blocking Code
................................

Blocking (CPU-bound) code should not be called directly.  For example,
if a function performs a CPU-intensive calculation for 1 second, all
concurrent asyncio Tasks and IO operations would be delayed by 1 second.

An executor can be used to run a task in a different thread or even in a
different process to avoid blocking the OS thread with the event loop.
See the *note loop.run_in_executor(): 243a. method for more details.


File: python.info,  Node: Logging<3>,  Next: Detect never-awaited coroutines,  Prev: Running Blocking Code,  Up: Developing with asyncio

5.19.1.121 Logging
..................

asyncio uses the *note logging: aa. module and all logging is performed
via the ‘"asyncio"’ logger.

The default log level is ‘logging.INFO’, which can be easily adjusted:

     logging.getLogger("asyncio").setLevel(logging.WARNING)


File: python.info,  Node: Detect never-awaited coroutines,  Next: Detect never-retrieved exceptions,  Prev: Logging<3>,  Up: Developing with asyncio

5.19.1.122 Detect never-awaited coroutines
..........................................

When a coroutine function is called, but not awaited (e.g.  ‘coro()’
instead of ‘await coro()’) or the coroutine is not scheduled with *note
asyncio.create_task(): 1ac, asyncio will emit a *note RuntimeWarning:
2be.:

     import asyncio  async def test():     print("never scheduled")  async def main():     test()  asyncio.run(main())

Output:

     test.py:7: RuntimeWarning: coroutine 'test' was never awaited   test()

Output in debug mode:

     test.py:7: RuntimeWarning: coroutine 'test' was never awaited Coroutine created at (most recent call last)   File "../t.py", line 9, in <module>     asyncio.run(main(), debug=True)    < .. >    File "../t.py", line 7, in main     test()   test()

The usual fix is to either await the coroutine or call the *note
asyncio.create_task(): 1ac. function:

     async def main():     await test()


File: python.info,  Node: Detect never-retrieved exceptions,  Prev: Detect never-awaited coroutines,  Up: Developing with asyncio

5.19.1.123 Detect never-retrieved exceptions
............................................

If a *note Future.set_exception(): 244e. is called but the Future object
is never awaited on, the exception would never be propagated to the user
code.  In this case, asyncio would emit a log message when the Future
object is garbage collected.

Example of an unhandled exception:

     import asyncio  async def bug():     raise Exception("not consumed")  async def main():     asyncio.create_task(bug())  asyncio.run(main())

Output:

     Task exception was never retrieved future: <Task finished coro=<bug() done, defined at test.py:3>   exception=Exception('not consumed')>  Traceback (most recent call last):   File "test.py", line 4, in bug     raise Exception("not consumed") Exception: not consumed

*note Enable the debug mode: 128b. to get the traceback where the task
was created:

     asyncio.run(main(), debug=True)

Output in debug mode:

     Task exception was never retrieved future: <Task finished coro=<bug() done, defined at test.py:3>     exception=Exception('not consumed') created at asyncio/tasks.py:321>  source_traceback: Object created at (most recent call last):   File "../t.py", line 9, in <module>     asyncio.run(main(), debug=True)  < .. >  Traceback (most recent call last):   File "../t.py", line 4, in bug     raise Exception("not consumed") Exception: not consumed

     Note: The source code for asyncio can be found in Lib/asyncio/(1).

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncio/


File: python.info,  Node: socket — Low-level networking interface,  Next: ssl — TLS/SSL wrapper for socket objects,  Prev: asyncio — Asynchronous I/O,  Up: Networking and Interprocess Communication

5.19.2 ‘socket’ — Low-level networking interface
------------------------------------------------

`Source code:' Lib/socket.py(1)

__________________________________________________________________

This module provides access to the BSD `socket' interface.  It is
available on all modern Unix systems, Windows, MacOS, and probably
additional platforms.

     Note: Some behavior may be platform dependent, since calls are made
     to the operating system socket APIs.

The Python interface is a straightforward transliteration of the Unix
system call and library interface for sockets to Python’s
object-oriented style: the *note socket(): 668. function returns a
`socket object' whose methods implement the various socket system calls.
Parameter types are somewhat higher-level than in the C interface: as
with ‘read()’ and ‘write()’ operations on Python files, buffer
allocation on receive operations is automatic, and buffer length is
implicit on send operations.

See also
........

Module *note socketserver: f0.

     Classes that simplify writing network servers.

Module *note ssl: f3.

     A TLS/SSL wrapper for socket objects.

* Menu:

* Socket families::
* Module contents::
* Socket Objects::
* Notes on socket timeouts::
* Example: Example<8>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/socket.py


File: python.info,  Node: Socket families,  Next: Module contents,  Up: socket — Low-level networking interface

5.19.2.1 Socket families
........................

Depending on the system and the build options, various socket families
are supported by this module.

The address format required by a particular socket object is
automatically selected based on the address family specified when the
socket object was created.  Socket addresses are represented as follows:

   - The address of an *note AF_UNIX: 24f1. socket bound to a file
     system node is represented as a string, using the file system
     encoding and the ‘'surrogateescape'’ error handler (see PEP
     383(1)).  An address in Linux’s abstract namespace is returned as a
     *note bytes-like object: 5dd. with an initial null byte; note that
     sockets in this namespace can communicate with normal file system
     sockets, so programs intended to run on Linux may need to deal with
     both types of address.  A string or bytes-like object can be used
     for either type of address when passing it as an argument.

          Changed in version 3.3: Previously, *note AF_UNIX: 24f1.
          socket paths were assumed to use UTF-8 encoding.

          Changed in version 3.5: Writable *note bytes-like object: 5dd.
          is now accepted.

   - A pair ‘(host, port)’ is used for the *note AF_INET: 24eb. address
     family, where `host' is a string representing either a hostname in
     Internet domain notation like ‘'daring.cwi.nl'’ or an IPv4 address
     like ‘'100.50.200.5'’, and `port' is an integer.

        - For IPv4 addresses, two special forms are accepted instead of
          a host address: ‘''’ represents ‘INADDR_ANY’, which is used to
          bind to all interfaces, and the string ‘'<broadcast>'’
          represents ‘INADDR_BROADCAST’.  This behavior is not
          compatible with IPv6, therefore, you may want to avoid these
          if you intend to support IPv6 with your Python programs.

   - For *note AF_INET6: 24ec. address family, a four-tuple ‘(host,
     port, flowinfo, scopeid)’ is used, where `flowinfo' and `scopeid'
     represent the ‘sin6_flowinfo’ and ‘sin6_scope_id’ members in
     ‘struct sockaddr_in6’ in C. For *note socket: ef. module methods,
     `flowinfo' and `scopeid' can be omitted just for backward
     compatibility.  Note, however, omission of `scopeid' can cause
     problems in manipulating scoped IPv6 addresses.

     Changed in version 3.7: For multicast addresses (with `scopeid'
     meaningful) `address' may not contain ‘%scope’ (or ‘zone id’) part.
     This information is superfluous and may be safely omitted
     (recommended).

   - ‘AF_NETLINK’ sockets are represented as pairs ‘(pid, groups)’.

   - Linux-only support for TIPC is available using the ‘AF_TIPC’
     address family.  TIPC is an open, non-IP based networked protocol
     designed for use in clustered computer environments.  Addresses are
     represented by a tuple, and the fields depend on the address type.
     The general tuple form is ‘(addr_type, v1, v2, v3 [, scope])’,
     where:

        - `addr_type' is one of ‘TIPC_ADDR_NAMESEQ’, ‘TIPC_ADDR_NAME’,
          or ‘TIPC_ADDR_ID’.

        - `scope' is one of ‘TIPC_ZONE_SCOPE’, ‘TIPC_CLUSTER_SCOPE’, and
          ‘TIPC_NODE_SCOPE’.

        - If `addr_type' is ‘TIPC_ADDR_NAME’, then `v1' is the server
          type, `v2' is the port identifier, and `v3' should be 0.

          If `addr_type' is ‘TIPC_ADDR_NAMESEQ’, then `v1' is the server
          type, `v2' is the lower port number, and `v3' is the upper
          port number.

          If `addr_type' is ‘TIPC_ADDR_ID’, then `v1' is the node, `v2'
          is the reference, and `v3' should be set to 0.

   - A tuple ‘(interface, )’ is used for the *note AF_CAN: 25a9. address
     family, where `interface' is a string representing a network
     interface name like ‘'can0'’.  The network interface name ‘''’ can
     be used to receive packets from all network interfaces of this
     family.

        - *note CAN_ISOTP: 25aa. protocol require a tuple ‘(interface,
          rx_addr, tx_addr)’ where both additional parameters are
          unsigned long integer that represent a CAN identifier
          (standard or extended).

   - A string or a tuple ‘(id, unit)’ is used for the ‘SYSPROTO_CONTROL’
     protocol of the ‘PF_SYSTEM’ family.  The string is the name of a
     kernel control using a dynamically-assigned ID. The tuple can be
     used if ID and unit number of the kernel control are known or if a
     registered ID is used.

     New in version 3.3.

   - ‘AF_BLUETOOTH’ supports the following protocols and address
     formats:

        - ‘BTPROTO_L2CAP’ accepts ‘(bdaddr, psm)’ where ‘bdaddr’ is the
          Bluetooth address as a string and ‘psm’ is an integer.

        - ‘BTPROTO_RFCOMM’ accepts ‘(bdaddr, channel)’ where ‘bdaddr’ is
          the Bluetooth address as a string and ‘channel’ is an integer.

        - ‘BTPROTO_HCI’ accepts ‘(device_id,)’ where ‘device_id’ is
          either an integer or a string with the Bluetooth address of
          the interface.  (This depends on your OS; NetBSD and
          DragonFlyBSD expect a Bluetooth address while everything else
          expects an integer.)

          Changed in version 3.2: NetBSD and DragonFlyBSD support added.

        - ‘BTPROTO_SCO’ accepts ‘bdaddr’ where ‘bdaddr’ is a *note
          bytes: 326. object containing the Bluetooth address in a
          string format.  (ex.  ‘b'12:23:34:45:56:67'’) This protocol is
          not supported under FreeBSD.

   - *note AF_ALG: 579. is a Linux-only socket based interface to Kernel
     cryptography.  An algorithm socket is configured with a tuple of
     two to four elements ‘(type, name [, feat [, mask]])’, where:

        - `type' is the algorithm type as string, e.g.  ‘aead’, ‘hash’,
          ‘skcipher’ or ‘rng’.

        - `name' is the algorithm name and operation mode as string,
          e.g.  ‘sha256’, ‘hmac(sha256)’, ‘cbc(aes)’ or
          ‘drbg_nopr_ctr_aes256’.

        - `feat' and `mask' are unsigned 32bit integers.

     *note Availability: 129a.: Linux 2.6.38, some algorithm types
     require more recent Kernels.

     New in version 3.6.

   - *note AF_VSOCK: 3c8. allows communication between virtual machines
     and their hosts.  The sockets are represented as a ‘(CID, port)’
     tuple where the context ID or CID and port are integers.

     *note Availability: 129a.: Linux >= 4.8 QEMU >= 2.8 ESX >= 4.0 ESX
     Workstation >= 6.5.

     New in version 3.7.

   - *note AF_PACKET: 25ab. is a low-level interface directly to network
     devices.  The packets are represented by the tuple ‘(ifname,
     proto[, pkttype[, hatype[, addr]]])’ where:

        - `ifname' - String specifying the device name.

        - `proto' - An in network-byte-order integer specifying the
          Ethernet protocol number.

        - `pkttype' - Optional integer specifying the packet type:

             - ‘PACKET_HOST’ (the default) - Packet addressed to the
               local host.

             - ‘PACKET_BROADCAST’ - Physical-layer broadcast packet.

             - ‘PACKET_MULTIHOST’ - Packet sent to a physical-layer
               multicast address.

             - ‘PACKET_OTHERHOST’ - Packet to some other host that has
               been caught by a device driver in promiscuous mode.

             - ‘PACKET_OUTGOING’ - Packet originating from the local
               host that is looped back to a packet socket.

        - `hatype' - Optional integer specifying the ARP hardware
          address type.

        - `addr' - Optional bytes-like object specifying the hardware
          physical address, whose interpretation depends on the device.

   - *note AF_QIPCRTR: 25ac. is a Linux-only socket based interface for
     communicating with services running on co-processors in Qualcomm
     platforms.  The address family is represented as a ‘(node, port)’
     tuple where the `node' and `port' are non-negative integers.

     New in version 3.8.

If you use a hostname in the `host' portion of IPv4/v6 socket address,
the program may show a nondeterministic behavior, as Python uses the
first address returned from the DNS resolution.  The socket address will
be resolved differently into an actual IPv4/v6 address, depending on the
results from DNS resolution and/or the host configuration.  For
deterministic behavior use a numeric address in `host' portion.

All errors raise exceptions.  The normal exceptions for invalid argument
types and out-of-memory conditions can be raised; starting from Python
3.3, errors related to socket or address semantics raise *note OSError:
1d1. or one of its subclasses (they used to raise *note socket.error:
989.).

Non-blocking mode is supported through *note setblocking(): 1e4d.  A
generalization of this based on timeouts is supported through *note
settimeout(): 25ad.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0383


File: python.info,  Node: Module contents,  Next: Socket Objects,  Prev: Socket families,  Up: socket — Low-level networking interface

5.19.2.2 Module contents
........................

The module *note socket: ef. exports the following elements.

* Menu:

* Exceptions: Exceptions<11>.
* Constants: Constants<8>.
* Functions: Functions<5>.


File: python.info,  Node: Exceptions<11>,  Next: Constants<8>,  Up: Module contents

5.19.2.3 Exceptions
...................

 -- Exception: socket.error

     A deprecated alias of *note OSError: 1d1.

     Changed in version 3.3: Following PEP 3151(1), this class was made
     an alias of *note OSError: 1d1.

 -- Exception: socket.herror

     A subclass of *note OSError: 1d1, this exception is raised for
     address-related errors, i.e.  for functions that use `h_errno' in
     the POSIX C API, including *note gethostbyname_ex(): 25b1. and
     *note gethostbyaddr(): 25b2.  The accompanying value is a pair
     ‘(h_errno, string)’ representing an error returned by a library
     call.  `h_errno' is a numeric value, while `string' represents the
     description of `h_errno', as returned by the ‘hstrerror()’ C
     function.

     Changed in version 3.3: This class was made a subclass of *note
     OSError: 1d1.

 -- Exception: socket.gaierror

     A subclass of *note OSError: 1d1, this exception is raised for
     address-related errors by *note getaddrinfo(): 24ff. and *note
     getnameinfo(): 2500.  The accompanying value is a pair ‘(error,
     string)’ representing an error returned by a library call.
     `string' represents the description of `error', as returned by the
     ‘gai_strerror()’ C function.  The numeric `error' value will match
     one of the ‘EAI_*’ constants defined in this module.

     Changed in version 3.3: This class was made a subclass of *note
     OSError: 1d1.

 -- Exception: socket.timeout

     A subclass of *note OSError: 1d1, this exception is raised when a
     timeout occurs on a socket which has had timeouts enabled via a
     prior call to *note settimeout(): 25ad. (or implicitly through
     *note setdefaulttimeout(): 25b4.).  The accompanying value is a
     string whose value is currently always “timed out”.

     Changed in version 3.3: This class was made a subclass of *note
     OSError: 1d1.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3151


File: python.info,  Node: Constants<8>,  Next: Functions<5>,  Prev: Exceptions<11>,  Up: Module contents

5.19.2.4 Constants
..................

     The AF_* and SOCK_* constants are now ‘AddressFamily’ and
     ‘SocketKind’ *note IntEnum: 582. collections.

     New in version 3.4.

 -- Data: socket.AF_UNIX
 -- Data: socket.AF_INET
 -- Data: socket.AF_INET6

     These constants represent the address (and protocol) families, used
     for the first argument to *note socket(): 668.  If the *note
     AF_UNIX: 24f1. constant is not defined then this protocol is
     unsupported.  More constants may be available depending on the
     system.

 -- Data: socket.SOCK_STREAM
 -- Data: socket.SOCK_DGRAM
 -- Data: socket.SOCK_RAW
 -- Data: socket.SOCK_RDM
 -- Data: socket.SOCK_SEQPACKET

     These constants represent the socket types, used for the second
     argument to *note socket(): 668.  More constants may be available
     depending on the system.  (Only *note SOCK_STREAM: c7d. and *note
     SOCK_DGRAM: c7c. appear to be generally useful.)

 -- Data: socket.SOCK_CLOEXEC
 -- Data: socket.SOCK_NONBLOCK

     These two constants, if defined, can be combined with the socket
     types and allow you to set some flags atomically (thus avoiding
     possible race conditions and the need for separate calls).

     See also
     ........

     Secure File Descriptor Handling(1) for a more thorough explanation.

     *note Availability: 129a.: Linux >= 2.6.27.

     New in version 3.2.

 -- Data: SO_*
 -- Data: socket.SOMAXCONN

 -- Data: MSG_*

 -- Data: SOL_*

 -- Data: SCM_*

 -- Data: IPPROTO_*

 -- Data: IPPORT_*

 -- Data: INADDR_*

 -- Data: IP_*

 -- Data: IPV6_*

 -- Data: EAI_*

 -- Data: AI_*

 -- Data: NI_*

 -- Data: TCP_*

     Many constants of these forms, documented in the Unix documentation
     on sockets and/or the IP protocol, are also defined in the socket
     module.  They are generally used in arguments to the ‘setsockopt()’
     and ‘getsockopt()’ methods of socket objects.  In most cases, only
     those symbols that are defined in the Unix header files are
     defined; for a few symbols, default values are provided.

     Changed in version 3.6: ‘SO_DOMAIN’, ‘SO_PROTOCOL’, ‘SO_PEERSEC’,
     ‘SO_PASSSEC’, ‘TCP_USER_TIMEOUT’, ‘TCP_CONGESTION’ were added.

     Changed in version 3.6.5: On Windows, ‘TCP_FASTOPEN’, ‘TCP_KEEPCNT’
     appear if run-time Windows supports.

     Changed in version 3.7: ‘TCP_NOTSENT_LOWAT’ was added.

     On Windows, ‘TCP_KEEPIDLE’, ‘TCP_KEEPINTVL’ appear if run-time
     Windows supports.

 -- Data: socket.AF_CAN
 -- Data: socket.PF_CAN

 -- Data: SOL_CAN_*

 -- Data: CAN_*

     Many constants of these forms, documented in the Linux
     documentation, are also defined in the socket module.

     *note Availability: 129a.: Linux >= 2.6.25.

     New in version 3.3.

 -- Data: socket.CAN_BCM

 -- Data: CAN_BCM_*

     CAN_BCM, in the CAN protocol family, is the broadcast manager (BCM)
     protocol.  Broadcast manager constants, documented in the Linux
     documentation, are also defined in the socket module.

     *note Availability: 129a.: Linux >= 2.6.25.

          Note: The ‘CAN_BCM_CAN_FD_FRAME’ flag is only available on
          Linux >= 4.8.

     New in version 3.4.

 -- Data: socket.CAN_RAW_FD_FRAMES

     Enables CAN FD support in a CAN_RAW socket.  This is disabled by
     default.  This allows your application to send both CAN and CAN FD
     frames; however, you must accept both CAN and CAN FD frames when
     reading from the socket.

     This constant is documented in the Linux documentation.

     *note Availability: 129a.: Linux >= 3.6.

     New in version 3.5.

 -- Data: socket.CAN_ISOTP

     CAN_ISOTP, in the CAN protocol family, is the ISO-TP (ISO 15765-2)
     protocol.  ISO-TP constants, documented in the Linux documentation.

     *note Availability: 129a.: Linux >= 2.6.25.

     New in version 3.7.

 -- Data: socket.AF_PACKET
 -- Data: socket.PF_PACKET

 -- Data: PACKET_*

     Many constants of these forms, documented in the Linux
     documentation, are also defined in the socket module.

     *note Availability: 129a.: Linux >= 2.2.

 -- Data: socket.AF_RDS
 -- Data: socket.PF_RDS
 -- Data: socket.SOL_RDS

 -- Data: RDS_*

     Many constants of these forms, documented in the Linux
     documentation, are also defined in the socket module.

     *note Availability: 129a.: Linux >= 2.6.30.

     New in version 3.3.

 -- Data: socket.SIO_RCVALL
 -- Data: socket.SIO_KEEPALIVE_VALS
 -- Data: socket.SIO_LOOPBACK_FAST_PATH

 -- Data: RCVALL_*

     Constants for Windows’ WSAIoctl().  The constants are used as
     arguments to the *note ioctl(): 575. method of socket objects.

     Changed in version 3.6: ‘SIO_LOOPBACK_FAST_PATH’ was added.

 -- Data: TIPC_*

     TIPC related constants, matching the ones exported by the C socket
     API. See the TIPC documentation for more information.

 -- Data: socket.AF_ALG
 -- Data: socket.SOL_ALG

 -- Data: ALG_*

     Constants for Linux Kernel cryptography.

     *note Availability: 129a.: Linux >= 2.6.38.

     New in version 3.6.

 -- Data: socket.AF_VSOCK
 -- Data: socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID

 -- Data: VMADDR*

 -- Data: SO_VM*

     Constants for Linux host/guest communication.

     *note Availability: 129a.: Linux >= 4.8.

     New in version 3.7.

 -- Data: socket.AF_LINK

     *note Availability: 129a.: BSD, OSX.

     New in version 3.4.

 -- Data: socket.has_ipv6

     This constant contains a boolean value which indicates if IPv6 is
     supported on this platform.

 -- Data: socket.BDADDR_ANY
 -- Data: socket.BDADDR_LOCAL

     These are string constants containing Bluetooth addresses with
     special meanings.  For example, *note BDADDR_ANY: 25c3. can be used
     to indicate any address when specifying the binding socket with
     ‘BTPROTO_RFCOMM’.

 -- Data: socket.HCI_FILTER
 -- Data: socket.HCI_TIME_STAMP
 -- Data: socket.HCI_DATA_DIR

     For use with ‘BTPROTO_HCI’.  *note HCI_FILTER: 25c5. is not
     available for NetBSD or DragonFlyBSD. *note HCI_TIME_STAMP: 25c6.
     and *note HCI_DATA_DIR: 25c7. are not available for FreeBSD,
     NetBSD, or DragonFlyBSD.

 -- Data: socket.AF_QIPCRTR

     Constant for Qualcomm’s IPC router protocol, used to communicate
     with service providing remote processors.

     *note Availability: 129a.: Linux >= 4.7.

   ---------- Footnotes ----------

   (1) http://udrepper.livejournal.com/20407.html


File: python.info,  Node: Functions<5>,  Prev: Constants<8>,  Up: Module contents

5.19.2.5 Functions
..................

* Menu:

* Creating sockets::
* Other functions: Other functions<2>.


File: python.info,  Node: Creating sockets,  Next: Other functions<2>,  Up: Functions<5>

5.19.2.6 Creating sockets
.........................

The following functions all create *note socket objects: 25ca.

 -- Function: socket.socket (family=AF_INET, type=SOCK_STREAM, proto=0,
          fileno=None)

     Create a new socket using the given address family, socket type and
     protocol number.  The address family should be *note AF_INET: 24eb.
     (the default), *note AF_INET6: 24ec, *note AF_UNIX: 24f1, *note
     AF_CAN: 25a9, *note AF_PACKET: 25ab, or *note AF_RDS: 25bb.  The
     socket type should be *note SOCK_STREAM: c7d. (the default), *note
     SOCK_DGRAM: c7c, *note SOCK_RAW: 25b6. or perhaps one of the other
     ‘SOCK_’ constants.  The protocol number is usually zero and may be
     omitted or in the case where the address family is *note AF_CAN:
     25a9. the protocol should be one of ‘CAN_RAW’, *note CAN_BCM: 8ad.
     or *note CAN_ISOTP: 25aa.

     If `fileno' is specified, the values for `family', `type', and
     `proto' are auto-detected from the specified file descriptor.
     Auto-detection can be overruled by calling the function with
     explicit `family', `type', or `proto' arguments.  This only affects
     how Python represents e.g.  the return value of *note
     socket.getpeername(): 2535. but not the actual OS resource.  Unlike
     *note socket.fromfd(): 25cb, `fileno' will return the same socket
     and not a duplicate.  This may help close a detached socket using
     *note socket.close(): 3c6.

     The newly created socket is *note non-inheritable: 7ee.

     Raises an *note auditing event: 1275. ‘socket.__new__’ with
     arguments ‘self’, ‘family’, ‘type’, ‘protocol’.

     Changed in version 3.3: The AF_CAN family was added.  The AF_RDS
     family was added.

     Changed in version 3.4: The CAN_BCM protocol was added.

     Changed in version 3.4: The returned socket is now non-inheritable.

     Changed in version 3.7: The CAN_ISOTP protocol was added.

     Changed in version 3.7: When *note SOCK_NONBLOCK: 48c. or *note
     SOCK_CLOEXEC: 48d. bit flags are applied to `type' they are
     cleared, and *note socket.type: 48e. will not reflect them.  They
     are still passed to the underlying system ‘socket()’ call.
     Therefore::

          sock = socket.socket(

               socket.AF_INET, socket.SOCK_STREAM |
               socket.SOCK_NONBLOCK)

     will still create a non-blocking socket on OSes that support
     ‘SOCK_NONBLOCK’, but ‘sock.type’ will be set to
     ‘socket.SOCK_STREAM’.

 -- Function: socket.socketpair ([family[, type[, proto]]])

     Build a pair of connected socket objects using the given address
     family, socket type, and protocol number.  Address family, socket
     type, and protocol number are as for the *note socket(): 668.
     function above.  The default family is *note AF_UNIX: 24f1. if
     defined on the platform; otherwise, the default is *note AF_INET:
     24eb.

     The newly created sockets are *note non-inheritable: 7ee.

     Changed in version 3.2: The returned socket objects now support the
     whole socket API, rather than a subset.

     Changed in version 3.4: The returned sockets are now
     non-inheritable.

     Changed in version 3.5: Windows support added.

 -- Function: socket.create_connection (address[, timeout[,
          source_address]])

     Connect to a TCP service listening on the Internet `address' (a
     2-tuple ‘(host, port)’), and return the socket object.  This is a
     higher-level function than *note socket.connect(): 66a.: if `host'
     is a non-numeric hostname, it will try to resolve it for both *note
     AF_INET: 24eb. and *note AF_INET6: 24ec, and then try to connect to
     all possible addresses in turn until a connection succeeds.  This
     makes it easy to write clients that are compatible to both IPv4 and
     IPv6.

     Passing the optional `timeout' parameter will set the timeout on
     the socket instance before attempting to connect.  If no `timeout'
     is supplied, the global default timeout setting returned by *note
     getdefaulttimeout(): 25cc. is used.

     If supplied, `source_address' must be a 2-tuple ‘(host, port)’ for
     the socket to bind to as its source address before connecting.  If
     host or port are ‘’ or 0 respectively the OS default behavior will
     be used.

     Changed in version 3.2: `source_address' was added.

 -- Function: socket.create_server (address, *, family=AF_INET,
          backlog=None, reuse_port=False, dualstack_ipv6=False)

     Convenience function which creates a TCP socket bound to `address'
     (a 2-tuple ‘(host, port)’) and return the socket object.

     `family' should be either *note AF_INET: 24eb. or *note AF_INET6:
     24ec.  `backlog' is the queue size passed to *note socket.listen():
     73f.; when ‘0’ a default reasonable value is chosen.  `reuse_port'
     dictates whether to set the ‘SO_REUSEPORT’ socket option.

     If `dualstack_ipv6' is true and the platform supports it the socket
     will be able to accept both IPv4 and IPv6 connections, else it will
     raise *note ValueError: 1f9.  Most POSIX platforms and Windows are
     supposed to support this functionality.  When this functionality is
     enabled the address returned by *note socket.getpeername(): 2535.
     when an IPv4 connection occurs will be an IPv6 address represented
     as an IPv4-mapped IPv6 address.  If `dualstack_ipv6' is false it
     will explicitly disable this functionality on platforms that enable
     it by default (e.g.  Linux).  This parameter can be used in
     conjunction with *note has_dualstack_ipv6(): 21d.:

          import socket  addr = ("", 8080)  # all interfaces, port 8080 if socket.has_dualstack_ipv6():     s = socket.create_server(addr, family=socket.AF_INET6, dualstack_ipv6=True) else:     s = socket.create_server(addr)

          Note: On POSIX platforms the ‘SO_REUSEADDR’ socket option is
          set in order to immediately reuse previous sockets which were
          bound on the same `address' and remained in TIME_WAIT state.

     New in version 3.8.

 -- Function: socket.has_dualstack_ipv6 ()

     Return ‘True’ if the platform supports creating a TCP socket which
     can handle both IPv4 and IPv6 connections.

     New in version 3.8.

 -- Function: socket.fromfd (fd, family, type, proto=0)

     Duplicate the file descriptor `fd' (an integer as returned by a
     file object’s ‘fileno()’ method) and build a socket object from the
     result.  Address family, socket type and protocol number are as for
     the *note socket(): 668. function above.  The file descriptor
     should refer to a socket, but this is not checked — subsequent
     operations on the object may fail if the file descriptor is
     invalid.  This function is rarely needed, but can be used to get or
     set socket options on a socket passed to a program as standard
     input or output (such as a server started by the Unix inet daemon).
     The socket is assumed to be in blocking mode.

     The newly created socket is *note non-inheritable: 7ee.

     Changed in version 3.4: The returned socket is now non-inheritable.

 -- Function: socket.fromshare (data)

     Instantiate a socket from data obtained from the *note
     socket.share(): 48a. method.  The socket is assumed to be in
     blocking mode.

     *note Availability: 129a.: Windows.

     New in version 3.3.

 -- Data: socket.SocketType

     This is a Python type object that represents the socket object
     type.  It is the same as ‘type(socket(...))’.


File: python.info,  Node: Other functions<2>,  Prev: Creating sockets,  Up: Functions<5>

5.19.2.7 Other functions
........................

The *note socket: ef. module also offers various network-related
services:

 -- Function: socket.close (fd)

     Close a socket file descriptor.  This is like *note os.close():
     3c7, but for sockets.  On some platforms (most noticeable Windows)
     *note os.close(): 3c7. does not work for socket file descriptors.

     New in version 3.7.

 -- Function: socket.getaddrinfo (host, port, family=0, type=0, proto=0,
          flags=0)

     Translate the `host'/`port' argument into a sequence of 5-tuples
     that contain all the necessary arguments for creating a socket
     connected to that service.  `host' is a domain name, a string
     representation of an IPv4/v6 address or ‘None’.  `port' is a string
     service name such as ‘'http'’, a numeric port number or ‘None’.  By
     passing ‘None’ as the value of `host' and `port', you can pass
     ‘NULL’ to the underlying C API.

     The `family', `type' and `proto' arguments can be optionally
     specified in order to narrow the list of addresses returned.
     Passing zero as a value for each of these arguments selects the
     full range of results.  The `flags' argument can be one or several
     of the ‘AI_*’ constants, and will influence how results are
     computed and returned.  For example, ‘AI_NUMERICHOST’ will disable
     domain name resolution and will raise an error if `host' is a
     domain name.

     The function returns a list of 5-tuples with the following
     structure:

     ‘(family, type, proto, canonname, sockaddr)’

     In these tuples, `family', `type', `proto' are all integers and are
     meant to be passed to the *note socket(): 668. function.
     `canonname' will be a string representing the canonical name of the
     `host' if ‘AI_CANONNAME’ is part of the `flags' argument; else
     `canonname' will be empty.  `sockaddr' is a tuple describing a
     socket address, whose format depends on the returned `family' (a
     ‘(address, port)’ 2-tuple for *note AF_INET: 24eb, a ‘(address,
     port, flow info, scope id)’ 4-tuple for *note AF_INET6: 24ec.), and
     is meant to be passed to the *note socket.connect(): 66a. method.

     Raises an *note auditing event: 1275. ‘socket.getaddrinfo’ with
     arguments ‘host’, ‘port’, ‘family’, ‘type’, ‘protocol’.

     The following example fetches address information for a
     hypothetical TCP connection to ‘example.org’ on port 80 (results
     may differ on your system if IPv6 isn’t enabled):

          >>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP) [(<AddressFamily.AF_INET6: 10>, <SocketType.SOCK_STREAM: 1>,  6, '', ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)),  (<AddressFamily.AF_INET: 2>, <SocketType.SOCK_STREAM: 1>,  6, '', ('93.184.216.34', 80))]

     Changed in version 3.2: parameters can now be passed using keyword
     arguments.

     Changed in version 3.7: for IPv6 multicast addresses, string
     representing an address will not contain ‘%scope’ part.

 -- Function: socket.getfqdn ([name])

     Return a fully qualified domain name for `name'.  If `name' is
     omitted or empty, it is interpreted as the local host.  To find the
     fully qualified name, the hostname returned by *note
     gethostbyaddr(): 25b2. is checked, followed by aliases for the
     host, if available.  The first name which includes a period is
     selected.  In case no fully qualified domain name is available, the
     hostname as returned by *note gethostname(): 1e41. is returned.

 -- Function: socket.gethostbyname (hostname)

     Translate a host name to IPv4 address format.  The IPv4 address is
     returned as a string, such as ‘'100.50.200.5'’.  If the host name
     is an IPv4 address itself it is returned unchanged.  See *note
     gethostbyname_ex(): 25b1. for a more complete interface.  *note
     gethostbyname(): 25d0. does not support IPv6 name resolution, and
     *note getaddrinfo(): 24ff. should be used instead for IPv4/v6 dual
     stack support.

     Raises an *note auditing event: 1275. ‘socket.gethostbyname’ with
     argument ‘hostname’.

 -- Function: socket.gethostbyname_ex (hostname)

     Translate a host name to IPv4 address format, extended interface.
     Return a triple ‘(hostname, aliaslist, ipaddrlist)’ where
     `hostname' is the primary host name responding to the given
     `ip_address', `aliaslist' is a (possibly empty) list of alternative
     host names for the same address, and `ipaddrlist' is a list of IPv4
     addresses for the same interface on the same host (often but not
     always a single address).  *note gethostbyname_ex(): 25b1. does not
     support IPv6 name resolution, and *note getaddrinfo(): 24ff. should
     be used instead for IPv4/v6 dual stack support.

     Raises an *note auditing event: 1275. ‘socket.gethostbyname’ with
     argument ‘hostname’.

 -- Function: socket.gethostname ()

     Return a string containing the hostname of the machine where the
     Python interpreter is currently executing.

     Raises an *note auditing event: 1275. ‘socket.gethostname’ with no
     arguments.

     Note: *note gethostname(): 1e41. doesn’t always return the fully
     qualified domain name; use *note getfqdn(): 25cf. for that.

 -- Function: socket.gethostbyaddr (ip_address)

     Return a triple ‘(hostname, aliaslist, ipaddrlist)’ where
     `hostname' is the primary host name responding to the given
     `ip_address', `aliaslist' is a (possibly empty) list of alternative
     host names for the same address, and `ipaddrlist' is a list of
     IPv4/v6 addresses for the same interface on the same host (most
     likely containing only a single address).  To find the fully
     qualified domain name, use the function *note getfqdn(): 25cf.
     *note gethostbyaddr(): 25b2. supports both IPv4 and IPv6.

     Raises an *note auditing event: 1275. ‘socket.gethostbyaddr’ with
     argument ‘ip_address’.

 -- Function: socket.getnameinfo (sockaddr, flags)

     Translate a socket address `sockaddr' into a 2-tuple ‘(host,
     port)’.  Depending on the settings of `flags', the result can
     contain a fully-qualified domain name or numeric address
     representation in `host'.  Similarly, `port' can contain a string
     port name or a numeric port number.

     For IPv6 addresses, ‘%scope’ is appended to the host part if
     `sockaddr' contains meaningful `scopeid'.  Usually this happens for
     multicast addresses.

     For more information about `flags' you can consult
     ‘getnameinfo(3)’.

     Raises an *note auditing event: 1275. ‘socket.getnameinfo’ with
     argument ‘sockaddr’.

 -- Function: socket.getprotobyname (protocolname)

     Translate an Internet protocol name (for example, ‘'icmp'’) to a
     constant suitable for passing as the (optional) third argument to
     the *note socket(): 668. function.  This is usually only needed for
     sockets opened in “raw” mode (*note SOCK_RAW: 25b6.); for the
     normal socket modes, the correct protocol is chosen automatically
     if the protocol is omitted or zero.

 -- Function: socket.getservbyname (servicename[, protocolname])

     Translate an Internet service name and protocol name to a port
     number for that service.  The optional protocol name, if given,
     should be ‘'tcp'’ or ‘'udp'’, otherwise any protocol will match.

     Raises an *note auditing event: 1275. ‘socket.getservbyname’ with
     arguments ‘servicename’, ‘protocolname’.

 -- Function: socket.getservbyport (port[, protocolname])

     Translate an Internet port number and protocol name to a service
     name for that service.  The optional protocol name, if given,
     should be ‘'tcp'’ or ‘'udp'’, otherwise any protocol will match.

     Raises an *note auditing event: 1275. ‘socket.getservbyport’ with
     arguments ‘port’, ‘protocolname’.

 -- Function: socket.ntohl (x)

     Convert 32-bit positive integers from network to host byte order.
     On machines where the host byte order is the same as network byte
     order, this is a no-op; otherwise, it performs a 4-byte swap
     operation.

 -- Function: socket.ntohs (x)

     Convert 16-bit positive integers from network to host byte order.
     On machines where the host byte order is the same as network byte
     order, this is a no-op; otherwise, it performs a 2-byte swap
     operation.

     Deprecated since version 3.7: In case `x' does not fit in 16-bit
     unsigned integer, but does fit in a positive C int, it is silently
     truncated to 16-bit unsigned integer.  This silent truncation
     feature is deprecated, and will raise an exception in future
     versions of Python.

 -- Function: socket.htonl (x)

     Convert 32-bit positive integers from host to network byte order.
     On machines where the host byte order is the same as network byte
     order, this is a no-op; otherwise, it performs a 4-byte swap
     operation.

 -- Function: socket.htons (x)

     Convert 16-bit positive integers from host to network byte order.
     On machines where the host byte order is the same as network byte
     order, this is a no-op; otherwise, it performs a 2-byte swap
     operation.

     Deprecated since version 3.7: In case `x' does not fit in 16-bit
     unsigned integer, but does fit in a positive C int, it is silently
     truncated to 16-bit unsigned integer.  This silent truncation
     feature is deprecated, and will raise an exception in future
     versions of Python.

 -- Function: socket.inet_aton (ip_string)

     Convert an IPv4 address from dotted-quad string format (for
     example, ‘123.45.67.89’) to 32-bit packed binary format, as a bytes
     object four characters in length.  This is useful when conversing
     with a program that uses the standard C library and needs objects
     of type ‘struct in_addr’, which is the C type for the 32-bit packed
     binary this function returns.

     *note inet_aton(): 25d6. also accepts strings with less than three
     dots; see the Unix manual page ‘inet(3)’ for details.

     If the IPv4 address string passed to this function is invalid,
     *note OSError: 1d1. will be raised.  Note that exactly what is
     valid depends on the underlying C implementation of ‘inet_aton()’.

     *note inet_aton(): 25d6. does not support IPv6, and *note
     inet_pton(): 8af. should be used instead for IPv4/v6 dual stack
     support.

 -- Function: socket.inet_ntoa (packed_ip)

     Convert a 32-bit packed IPv4 address (a *note bytes-like object:
     5dd. four bytes in length) to its standard dotted-quad string
     representation (for example, ‘123.45.67.89’).  This is useful when
     conversing with a program that uses the standard C library and
     needs objects of type ‘struct in_addr’, which is the C type for the
     32-bit packed binary data this function takes as an argument.

     If the byte sequence passed to this function is not exactly 4 bytes
     in length, *note OSError: 1d1. will be raised.  *note inet_ntoa():
     25d7. does not support IPv6, and *note inet_ntop(): 8b0. should be
     used instead for IPv4/v6 dual stack support.

     Changed in version 3.5: Writable *note bytes-like object: 5dd. is
     now accepted.

 -- Function: socket.inet_pton (address_family, ip_string)

     Convert an IP address from its family-specific string format to a
     packed, binary format.  *note inet_pton(): 8af. is useful when a
     library or network protocol calls for an object of type ‘struct
     in_addr’ (similar to *note inet_aton(): 25d6.) or ‘struct
     in6_addr’.

     Supported values for `address_family' are currently *note AF_INET:
     24eb. and *note AF_INET6: 24ec.  If the IP address string
     `ip_string' is invalid, *note OSError: 1d1. will be raised.  Note
     that exactly what is valid depends on both the value of
     `address_family' and the underlying implementation of
     ‘inet_pton()’.

     *note Availability: 129a.: Unix (maybe not all platforms), Windows.

     Changed in version 3.4: Windows support added

 -- Function: socket.inet_ntop (address_family, packed_ip)

     Convert a packed IP address (a *note bytes-like object: 5dd. of
     some number of bytes) to its standard, family-specific string
     representation (for example, ‘'7.10.0.5'’ or ‘'5aef:2b::8'’).
     *note inet_ntop(): 8b0. is useful when a library or network
     protocol returns an object of type ‘struct in_addr’ (similar to
     *note inet_ntoa(): 25d7.) or ‘struct in6_addr’.

     Supported values for `address_family' are currently *note AF_INET:
     24eb. and *note AF_INET6: 24ec.  If the bytes object `packed_ip' is
     not the correct length for the specified address family, *note
     ValueError: 1f9. will be raised.  *note OSError: 1d1. is raised for
     errors from the call to *note inet_ntop(): 8b0.

     *note Availability: 129a.: Unix (maybe not all platforms), Windows.

     Changed in version 3.4: Windows support added

     Changed in version 3.5: Writable *note bytes-like object: 5dd. is
     now accepted.

 -- Function: socket.CMSG_LEN (length)

     Return the total length, without trailing padding, of an ancillary
     data item with associated data of the given `length'.  This value
     can often be used as the buffer size for *note recvmsg(): 66d. to
     receive a single item of ancillary data, but RFC 3542(1) requires
     portable applications to use *note CMSG_SPACE(): f58. and thus
     include space for padding, even when the item will be the last in
     the buffer.  Raises *note OverflowError: 954. if `length' is
     outside the permissible range of values.

     *note Availability: 129a.: most Unix platforms, possibly others.

     New in version 3.3.

 -- Function: socket.CMSG_SPACE (length)

     Return the buffer size needed for *note recvmsg(): 66d. to receive
     an ancillary data item with associated data of the given `length',
     along with any trailing padding.  The buffer space needed to
     receive multiple items is the sum of the *note CMSG_SPACE(): f58.
     values for their associated data lengths.  Raises *note
     OverflowError: 954. if `length' is outside the permissible range of
     values.

     Note that some systems might support ancillary data without
     providing this function.  Also note that setting the buffer size
     using the results of this function may not precisely limit the
     amount of ancillary data that can be received, since additional
     data may be able to fit into the padding area.

     *note Availability: 129a.: most Unix platforms, possibly others.

     New in version 3.3.

 -- Function: socket.getdefaulttimeout ()

     Return the default timeout in seconds (float) for new socket
     objects.  A value of ‘None’ indicates that new socket objects have
     no timeout.  When the socket module is first imported, the default
     is ‘None’.

 -- Function: socket.setdefaulttimeout (timeout)

     Set the default timeout in seconds (float) for new socket objects.
     When the socket module is first imported, the default is ‘None’.
     See *note settimeout(): 25ad. for possible values and their
     respective meanings.

 -- Function: socket.sethostname (name)

     Set the machine’s hostname to `name'.  This will raise an *note
     OSError: 1d1. if you don’t have enough rights.

     Raises an *note auditing event: 1275. ‘socket.sethostname’ with
     argument ‘name’.

     *note Availability: 129a.: Unix.

     New in version 3.3.

 -- Function: socket.if_nameindex ()

     Return a list of network interface information (index int, name
     string) tuples.  *note OSError: 1d1. if the system call fails.

     *note Availability: 129a.: Unix, Windows.

     New in version 3.3.

     Changed in version 3.8: Windows support was added.

 -- Function: socket.if_nametoindex (if_name)

     Return a network interface index number corresponding to an
     interface name.  *note OSError: 1d1. if no interface with the given
     name exists.

     *note Availability: 129a.: Unix, Windows.

     New in version 3.3.

     Changed in version 3.8: Windows support was added.

 -- Function: socket.if_indextoname (if_index)

     Return a network interface name corresponding to an interface index
     number.  *note OSError: 1d1. if no interface with the given index
     exists.

     *note Availability: 129a.: Unix, Windows.

     New in version 3.3.

     Changed in version 3.8: Windows support was added.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3542.html


File: python.info,  Node: Socket Objects,  Next: Notes on socket timeouts,  Prev: Module contents,  Up: socket — Low-level networking interface

5.19.2.8 Socket Objects
.......................

Socket objects have the following methods.  Except for *note makefile():
b0c, these correspond to Unix system calls applicable to sockets.

Changed in version 3.2: Support for the *note context manager: 55d.
protocol was added.  Exiting the context manager is equivalent to
calling *note close(): 3c6.

 -- Method: socket.accept ()

     Accept a connection.  The socket must be bound to an address and
     listening for connections.  The return value is a pair ‘(conn,
     address)’ where `conn' is a `new' socket object usable to send and
     receive data on the connection, and `address' is the address bound
     to the socket on the other end of the connection.

     The newly created socket is *note non-inheritable: 7ee.

     Changed in version 3.4: The socket is now non-inheritable.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(1) for the rationale).

 -- Method: socket.bind (address)

     Bind the socket to `address'.  The socket must not already be
     bound.  (The format of `address' depends on the address family —
     see above.)

     Raises an *note auditing event: 1275. ‘socket.bind’ with arguments
     ‘self’, ‘address’.

 -- Method: socket.close ()

     Mark the socket closed.  The underlying system resource (e.g.  a
     file descriptor) is also closed when all file objects from *note
     makefile(): b0c. are closed.  Once that happens, all future
     operations on the socket object will fail.  The remote end will
     receive no more data (after queued data is flushed).

     Sockets are automatically closed when they are garbage-collected,
     but it is recommended to *note close(): 3c6. them explicitly, or to
     use a *note with: 6dd. statement around them.

     Changed in version 3.6: *note OSError: 1d1. is now raised if an
     error occurs when the underlying ‘close()’ call is made.

          Note: *note close(): 3c6. releases the resource associated
          with a connection but does not necessarily close the
          connection immediately.  If you want to close the connection
          in a timely fashion, call *note shutdown(): 25da. before *note
          close(): 3c6.

 -- Method: socket.connect (address)

     Connect to a remote socket at `address'.  (The format of `address'
     depends on the address family — see above.)

     If the connection is interrupted by a signal, the method waits
     until the connection completes, or raise a *note socket.timeout:
     c01. on timeout, if the signal handler doesn’t raise an exception
     and the socket is blocking or has a timeout.  For non-blocking
     sockets, the method raises an *note InterruptedError: 64d.
     exception if the connection is interrupted by a signal (or the
     exception raised by the signal handler).

     Raises an *note auditing event: 1275. ‘socket.connect’ with
     arguments ‘self’, ‘address’.

     Changed in version 3.5: The method now waits until the connection
     completes instead of raising an *note InterruptedError: 64d.
     exception if the connection is interrupted by a signal, the signal
     handler doesn’t raise an exception and the socket is blocking or
     has a timeout (see the PEP 475(2) for the rationale).

 -- Method: socket.connect_ex (address)

     Like ‘connect(address)’, but return an error indicator instead of
     raising an exception for errors returned by the C-level ‘connect()’
     call (other problems, such as “host not found,” can still raise
     exceptions).  The error indicator is ‘0’ if the operation
     succeeded, otherwise the value of the ‘errno’ variable.  This is
     useful to support, for example, asynchronous connects.

     Raises an *note auditing event: 1275. ‘socket.connect’ with
     arguments ‘self’, ‘address’.

 -- Method: socket.detach ()

     Put the socket object into closed state without actually closing
     the underlying file descriptor.  The file descriptor is returned,
     and can be reused for other purposes.

     New in version 3.2.

 -- Method: socket.dup ()

     Duplicate the socket.

     The newly created socket is *note non-inheritable: 7ee.

     Changed in version 3.4: The socket is now non-inheritable.

 -- Method: socket.fileno ()

     Return the socket’s file descriptor (a small integer), or -1 on
     failure.  This is useful with *note select.select(): 667.

     Under Windows the small integer returned by this method cannot be
     used where a file descriptor can be used (such as *note
     os.fdopen(): 136d.).  Unix does not have this limitation.

 -- Method: socket.get_inheritable ()

     Get the *note inheritable flag: 7ee. of the socket’s file
     descriptor or socket’s handle: ‘True’ if the socket can be
     inherited in child processes, ‘False’ if it cannot.

     New in version 3.4.

 -- Method: socket.getpeername ()

     Return the remote address to which the socket is connected.  This
     is useful to find out the port number of a remote IPv4/v6 socket,
     for instance.  (The format of the address returned depends on the
     address family — see above.)  On some systems this function is not
     supported.

 -- Method: socket.getsockname ()

     Return the socket’s own address.  This is useful to find out the
     port number of an IPv4/v6 socket, for instance.  (The format of the
     address returned depends on the address family — see above.)

 -- Method: socket.getsockopt (level, optname[, buflen])

     Return the value of the given socket option (see the Unix man page
     ‘getsockopt(2)’).  The needed symbolic constants (‘SO_*’ etc.)  are
     defined in this module.  If `buflen' is absent, an integer option
     is assumed and its integer value is returned by the function.  If
     `buflen' is present, it specifies the maximum length of the buffer
     used to receive the option in, and this buffer is returned as a
     bytes object.  It is up to the caller to decode the contents of the
     buffer (see the optional built-in module *note struct: f8. for a
     way to decode C structures encoded as byte strings).

 -- Method: socket.getblocking ()

     Return ‘True’ if socket is in blocking mode, ‘False’ if in
     non-blocking.

     This is equivalent to checking ‘socket.gettimeout() == 0’.

     New in version 3.7.

 -- Method: socket.gettimeout ()

     Return the timeout in seconds (float) associated with socket
     operations, or ‘None’ if no timeout is set.  This reflects the last
     call to *note setblocking(): 1e4d. or *note settimeout(): 25ad.

 -- Method: socket.ioctl (control, option)


     Platform: Windows

     The *note ioctl(): 575. method is a limited interface to the
     WSAIoctl system interface.  Please refer to the Win32
     documentation(3) for more information.

     On other platforms, the generic *note fcntl.fcntl(): 25df. and
     *note fcntl.ioctl(): dd1. functions may be used; they accept a
     socket object as their first argument.

     Currently only the following control codes are supported:
     ‘SIO_RCVALL’, ‘SIO_KEEPALIVE_VALS’, and ‘SIO_LOOPBACK_FAST_PATH’.

     Changed in version 3.6: ‘SIO_LOOPBACK_FAST_PATH’ was added.

 -- Method: socket.listen ([backlog])

     Enable a server to accept connections.  If `backlog' is specified,
     it must be at least 0 (if it is lower, it is set to 0); it
     specifies the number of unaccepted connections that the system will
     allow before refusing new connections.  If not specified, a default
     reasonable value is chosen.

     Changed in version 3.5: The `backlog' parameter is now optional.

 -- Method: socket.makefile (mode='r', buffering=None, *, encoding=None,
          errors=None, newline=None)

     Return a *note file object: b35. associated with the socket.  The
     exact returned type depends on the arguments given to *note
     makefile(): b0c.  These arguments are interpreted the same way as
     by the built-in *note open(): 4e5. function, except the only
     supported `mode' values are ‘'r'’ (default), ‘'w'’ and ‘'b'’.

     The socket must be in blocking mode; it can have a timeout, but the
     file object’s internal buffer may end up in an inconsistent state
     if a timeout occurs.

     Closing the file object returned by *note makefile(): b0c. won’t
     close the original socket unless all other file objects have been
     closed and *note socket.close(): 3c6. has been called on the socket
     object.

          Note: On Windows, the file-like object created by *note
          makefile(): b0c. cannot be used where a file object with a
          file descriptor is expected, such as the stream arguments of
          *note subprocess.Popen(): 2b7.

 -- Method: socket.recv (bufsize[, flags])

     Receive data from the socket.  The return value is a bytes object
     representing the data received.  The maximum amount of data to be
     received at once is specified by `bufsize'.  See the Unix manual
     page ‘recv(2)’ for the meaning of the optional argument `flags'; it
     defaults to zero.

          Note: For best match with hardware and network realities, the
          value of `bufsize' should be a relatively small power of 2,
          for example, 4096.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(4) for the rationale).

 -- Method: socket.recvfrom (bufsize[, flags])

     Receive data from the socket.  The return value is a pair ‘(bytes,
     address)’ where `bytes' is a bytes object representing the data
     received and `address' is the address of the socket sending the
     data.  See the Unix manual page ‘recv(2)’ for the meaning of the
     optional argument `flags'; it defaults to zero.  (The format of
     `address' depends on the address family — see above.)

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(5) for the rationale).

     Changed in version 3.7: For multicast IPv6 address, first item of
     `address' does not contain ‘%scope’ part anymore.  In order to get
     full IPv6 address use *note getnameinfo(): 2500.

 -- Method: socket.recvmsg (bufsize[, ancbufsize[, flags]])

     Receive normal data (up to `bufsize' bytes) and ancillary data from
     the socket.  The `ancbufsize' argument sets the size in bytes of
     the internal buffer used to receive the ancillary data; it defaults
     to 0, meaning that no ancillary data will be received.  Appropriate
     buffer sizes for ancillary data can be calculated using *note
     CMSG_SPACE(): f58. or *note CMSG_LEN(): f59, and items which do not
     fit into the buffer might be truncated or discarded.  The `flags'
     argument defaults to 0 and has the same meaning as for *note
     recv(): 66b.

     The return value is a 4-tuple: ‘(data, ancdata, msg_flags,
     address)’.  The `data' item is a *note bytes: 326. object holding
     the non-ancillary data received.  The `ancdata' item is a list of
     zero or more tuples ‘(cmsg_level, cmsg_type, cmsg_data)’
     representing the ancillary data (control messages) received:
     `cmsg_level' and `cmsg_type' are integers specifying the protocol
     level and protocol-specific type respectively, and `cmsg_data' is a
     *note bytes: 326. object holding the associated data.  The
     `msg_flags' item is the bitwise OR of various flags indicating
     conditions on the received message; see your system documentation
     for details.  If the receiving socket is unconnected, `address' is
     the address of the sending socket, if available; otherwise, its
     value is unspecified.

     On some systems, *note sendmsg(): 670. and *note recvmsg(): 66d.
     can be used to pass file descriptors between processes over an
     *note AF_UNIX: 24f1. socket.  When this facility is used (it is
     often restricted to *note SOCK_STREAM: c7d. sockets), *note
     recvmsg(): 66d. will return, in its ancillary data, items of the
     form ‘(socket.SOL_SOCKET, socket.SCM_RIGHTS, fds)’, where `fds' is
     a *note bytes: 326. object representing the new file descriptors as
     a binary array of the native C ‘int’ type.  If *note recvmsg():
     66d. raises an exception after the system call returns, it will
     first attempt to close any file descriptors received via this
     mechanism.

     Some systems do not indicate the truncated length of ancillary data
     items which have been only partially received.  If an item appears
     to extend beyond the end of the buffer, *note recvmsg(): 66d. will
     issue a *note RuntimeWarning: 2be, and will return the part of it
     which is inside the buffer provided it has not been truncated
     before the start of its associated data.

     On systems which support the ‘SCM_RIGHTS’ mechanism, the following
     function will receive up to `maxfds' file descriptors, returning
     the message data and a list containing the descriptors (while
     ignoring unexpected conditions such as unrelated control messages
     being received).  See also *note sendmsg(): 670.

          import socket, array  def recv_fds(sock, msglen, maxfds):     fds = array.array("i")   # Array of ints     msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize))     for cmsg_level, cmsg_type, cmsg_data in ancdata:         if cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS:             # Append data, ignoring any truncated integers at the end.             fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])     return msg, list(fds)

     *note Availability: 129a.: most Unix platforms, possibly others.

     New in version 3.3.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(6) for the rationale).

 -- Method: socket.recvmsg_into (buffers[, ancbufsize[, flags]])

     Receive normal data and ancillary data from the socket, behaving as
     *note recvmsg(): 66d. would, but scatter the non-ancillary data
     into a series of buffers instead of returning a new bytes object.
     The `buffers' argument must be an iterable of objects that export
     writable buffers (e.g.  *note bytearray: 327. objects); these will
     be filled with successive chunks of the non-ancillary data until it
     has all been written or there are no more buffers.  The operating
     system may set a limit (*note sysconf(): 1e73. value ‘SC_IOV_MAX’)
     on the number of buffers that can be used.  The `ancbufsize' and
     `flags' arguments have the same meaning as for *note recvmsg():
     66d.

     The return value is a 4-tuple: ‘(nbytes, ancdata, msg_flags,
     address)’, where `nbytes' is the total number of bytes of
     non-ancillary data written into the buffers, and `ancdata',
     `msg_flags' and `address' are the same as for *note recvmsg(): 66d.

     Example:

          >>> import socket >>> s1, s2 = socket.socketpair() >>> b1 = bytearray(b'----') >>> b2 = bytearray(b'0123456789') >>> b3 = bytearray(b'--------------') >>> s1.send(b'Mary had a little lamb') 22 >>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3]) (22, [], 0, None) >>> [b1, b2, b3] [bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]

     *note Availability: 129a.: most Unix platforms, possibly others.

     New in version 3.3.

 -- Method: socket.recvfrom_into (buffer[, nbytes[, flags]])

     Receive data from the socket, writing it into `buffer' instead of
     creating a new bytestring.  The return value is a pair ‘(nbytes,
     address)’ where `nbytes' is the number of bytes received and
     `address' is the address of the socket sending the data.  See the
     Unix manual page ‘recv(2)’ for the meaning of the optional argument
     `flags'; it defaults to zero.  (The format of `address' depends on
     the address family — see above.)

 -- Method: socket.recv_into (buffer[, nbytes[, flags]])

     Receive up to `nbytes' bytes from the socket, storing the data into
     a buffer rather than creating a new bytestring.  If `nbytes' is not
     specified (or 0), receive up to the size available in the given
     buffer.  Returns the number of bytes received.  See the Unix manual
     page ‘recv(2)’ for the meaning of the optional argument `flags'; it
     defaults to zero.

 -- Method: socket.send (bytes[, flags])

     Send data to the socket.  The socket must be connected to a remote
     socket.  The optional `flags' argument has the same meaning as for
     *note recv(): 66b. above.  Returns the number of bytes sent.
     Applications are responsible for checking that all data has been
     sent; if only some of the data was transmitted, the application
     needs to attempt delivery of the remaining data.  For further
     information on this topic, consult the *note Socket Programming
     HOWTO: 25e0.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(7) for the rationale).

 -- Method: socket.sendall (bytes[, flags])

     Send data to the socket.  The socket must be connected to a remote
     socket.  The optional `flags' argument has the same meaning as for
     *note recv(): 66b. above.  Unlike *note send(): 66e, this method
     continues to send data from `bytes' until either all data has been
     sent or an error occurs.  ‘None’ is returned on success.  On error,
     an exception is raised, and there is no way to determine how much
     data, if any, was successfully sent.

     Changed in version 3.5: The socket timeout is no more reset each
     time data is sent successfully.  The socket timeout is now the
     maximum total duration to send all data.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(8) for the rationale).

 -- Method: socket.sendto (bytes, address)

 -- Method: socket.sendto (bytes, flags, address)

     Send data to the socket.  The socket should not be connected to a
     remote socket, since the destination socket is specified by
     `address'.  The optional `flags' argument has the same meaning as
     for *note recv(): 66b. above.  Return the number of bytes sent.
     (The format of `address' depends on the address family — see
     above.)

     Raises an *note auditing event: 1275. ‘socket.sendto’ with
     arguments ‘self’, ‘address’.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(9) for the rationale).

 -- Method: socket.sendmsg (buffers[, ancdata[, flags[, address]]])

     Send normal and ancillary data to the socket, gathering the
     non-ancillary data from a series of buffers and concatenating it
     into a single message.  The `buffers' argument specifies the
     non-ancillary data as an iterable of *note bytes-like objects: 5dd.
     (e.g.  *note bytes: 326. objects); the operating system may set a
     limit (*note sysconf(): 1e73. value ‘SC_IOV_MAX’) on the number of
     buffers that can be used.  The `ancdata' argument specifies the
     ancillary data (control messages) as an iterable of zero or more
     tuples ‘(cmsg_level, cmsg_type, cmsg_data)’, where `cmsg_level' and
     `cmsg_type' are integers specifying the protocol level and
     protocol-specific type respectively, and `cmsg_data' is a
     bytes-like object holding the associated data.  Note that some
     systems (in particular, systems without *note CMSG_SPACE(): f58.)
     might support sending only one control message per call.  The
     `flags' argument defaults to 0 and has the same meaning as for
     *note send(): 66e.  If `address' is supplied and not ‘None’, it
     sets a destination address for the message.  The return value is
     the number of bytes of non-ancillary data sent.

     The following function sends the list of file descriptors `fds'
     over an *note AF_UNIX: 24f1. socket, on systems which support the
     ‘SCM_RIGHTS’ mechanism.  See also *note recvmsg(): 66d.

          import socket, array  def send_fds(sock, msg, fds):     return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])

     *note Availability: 129a.: most Unix platforms, possibly others.

     Raises an *note auditing event: 1275. ‘socket.sendmsg’ with
     arguments ‘self’, ‘address’.

     New in version 3.3.

     Changed in version 3.5: If the system call is interrupted and the
     signal handler does not raise an exception, the method now retries
     the system call instead of raising an *note InterruptedError: 64d.
     exception (see PEP 475(10) for the rationale).

 -- Method: socket.sendmsg_afalg ([msg], *, op[, iv[, assoclen[,
          flags]]])

     Specialized version of *note sendmsg(): 670. for *note AF_ALG: 579.
     socket.  Set mode, IV, AEAD associated data length and flags for
     *note AF_ALG: 579. socket.

     *note Availability: 129a.: Linux >= 2.6.38.

     New in version 3.6.

 -- Method: socket.sendfile (file, offset=0, count=None)

     Send a file until EOF is reached by using high-performance *note
     os.sendfile: 34e. and return the total number of bytes which were
     sent.  `file' must be a regular file object opened in binary mode.
     If *note os.sendfile: 34e. is not available (e.g.  Windows) or
     `file' is not a regular file *note send(): 66e. will be used
     instead.  `offset' tells from where to start reading the file.  If
     specified, `count' is the total number of bytes to transmit as
     opposed to sending the file until EOF is reached.  File position is
     updated on return or also in case of error in which case *note
     file.tell(): 1cd2. can be used to figure out the number of bytes
     which were sent.  The socket must be of *note SOCK_STREAM: c7d.
     type.  Non-blocking sockets are not supported.

     New in version 3.5.

 -- Method: socket.set_inheritable (inheritable)

     Set the *note inheritable flag: 7ee. of the socket’s file
     descriptor or socket’s handle.

     New in version 3.4.

 -- Method: socket.setblocking (flag)

     Set blocking or non-blocking mode of the socket: if `flag' is
     false, the socket is set to non-blocking, else to blocking mode.

     This method is a shorthand for certain *note settimeout(): 25ad.
     calls:

        * ‘sock.setblocking(True)’ is equivalent to
          ‘sock.settimeout(None)’

        * ‘sock.setblocking(False)’ is equivalent to
          ‘sock.settimeout(0.0)’

     Changed in version 3.7: The method no longer applies *note
     SOCK_NONBLOCK: 48c. flag on *note socket.type: 48e.

 -- Method: socket.settimeout (value)

     Set a timeout on blocking socket operations.  The `value' argument
     can be a nonnegative floating point number expressing seconds, or
     ‘None’.  If a non-zero value is given, subsequent socket operations
     will raise a *note timeout: c01. exception if the timeout period
     `value' has elapsed before the operation has completed.  If zero is
     given, the socket is put in non-blocking mode.  If ‘None’ is given,
     the socket is put in blocking mode.

     For further information, please consult the *note notes on socket
     timeouts: 25e1.

     Changed in version 3.7: The method no longer toggles *note
     SOCK_NONBLOCK: 48c. flag on *note socket.type: 48e.

 -- Method: socket.setsockopt (level, optname, value: int)

 -- Method: socket.setsockopt (level, optname, value: buffer)

 -- Method: socket.setsockopt (level, optname, None, optlen: int)

     Set the value of the given socket option (see the Unix manual page
     ‘setsockopt(2)’).  The needed symbolic constants are defined in the
     *note socket: ef. module (‘SO_*’ etc.).  The value can be an
     integer, ‘None’ or a *note bytes-like object: 5dd. representing a
     buffer.  In the later case it is up to the caller to ensure that
     the bytestring contains the proper bits (see the optional built-in
     module *note struct: f8. for a way to encode C structures as
     bytestrings).  When `value' is set to ‘None’, `optlen' argument is
     required.  It’s equivalent to call ‘setsockopt()’ C function with
     ‘optval=NULL’ and ‘optlen=optlen’.

     Changed in version 3.5: Writable *note bytes-like object: 5dd. is
     now accepted.

     Changed in version 3.6: setsockopt(level, optname, None, optlen:
     int) form added.

 -- Method: socket.shutdown (how)

     Shut down one or both halves of the connection.  If `how' is
     ‘SHUT_RD’, further receives are disallowed.  If `how' is ‘SHUT_WR’,
     further sends are disallowed.  If `how' is ‘SHUT_RDWR’, further
     sends and receives are disallowed.

 -- Method: socket.share (process_id)

     Duplicate a socket and prepare it for sharing with a target
     process.  The target process must be provided with `process_id'.
     The resulting bytes object can then be passed to the target process
     using some form of interprocess communication and the socket can be
     recreated there using *note fromshare(): 489.  Once this method has
     been called, it is safe to close the socket since the operating
     system has already duplicated it for the target process.

     *note Availability: 129a.: Windows.

     New in version 3.3.

Note that there are no methods ‘read()’ or ‘write()’; use *note recv():
66b. and *note send(): 66e. without `flags' argument instead.

Socket objects also have these (read-only) attributes that correspond to
the values given to the *note socket: 668. constructor.

 -- Attribute: socket.family

     The socket family.

 -- Attribute: socket.type

     The socket type.

 -- Attribute: socket.proto

     The socket protocol.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475

   (2) https://www.python.org/dev/peps/pep-0475

   (3) https://msdn.microsoft.com/en-us/library/ms741621%28VS.85%29.aspx

   (4) https://www.python.org/dev/peps/pep-0475

   (5) https://www.python.org/dev/peps/pep-0475

   (6) https://www.python.org/dev/peps/pep-0475

   (7) https://www.python.org/dev/peps/pep-0475

   (8) https://www.python.org/dev/peps/pep-0475

   (9) https://www.python.org/dev/peps/pep-0475

   (10) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Notes on socket timeouts,  Next: Example<8>,  Prev: Socket Objects,  Up: socket — Low-level networking interface

5.19.2.9 Notes on socket timeouts
.................................

A socket object can be in one of three modes: blocking, non-blocking, or
timeout.  Sockets are by default always created in blocking mode, but
this can be changed by calling *note setdefaulttimeout(): 25b4.

   * In `blocking mode', operations block until complete or the system
     returns an error (such as connection timed out).

   * In `non-blocking mode', operations fail (with an error that is
     unfortunately system-dependent) if they cannot be completed
     immediately: functions from the *note select: e5. can be used to
     know when and whether a socket is available for reading or writing.

   * In `timeout mode', operations fail if they cannot be completed
     within the timeout specified for the socket (they raise a *note
     timeout: c01. exception) or if the system returns an error.

     Note: At the operating system level, sockets in `timeout mode' are
     internally set in non-blocking mode.  Also, the blocking and
     timeout modes are shared between file descriptors and socket
     objects that refer to the same network endpoint.  This
     implementation detail can have visible consequences if e.g.  you
     decide to use the *note fileno(): 25dd. of a socket.

* Menu:

* Timeouts and the connect method::
* Timeouts and the accept method::


File: python.info,  Node: Timeouts and the connect method,  Next: Timeouts and the accept method,  Up: Notes on socket timeouts

5.19.2.10 Timeouts and the ‘connect’ method
...........................................

The *note connect(): 66a. operation is also subject to the timeout
setting, and in general it is recommended to call *note settimeout():
25ad. before calling *note connect(): 66a. or pass a timeout parameter
to *note create_connection(): b91.  However, the system network stack
may also return a connection timeout error of its own regardless of any
Python socket timeout setting.


File: python.info,  Node: Timeouts and the accept method,  Prev: Timeouts and the connect method,  Up: Notes on socket timeouts

5.19.2.11 Timeouts and the ‘accept’ method
..........................................

If *note getdefaulttimeout(): 25cc. is not *note None: 157, sockets
returned by the *note accept(): 669. method inherit that timeout.
Otherwise, the behaviour depends on settings of the listening socket:

   * if the listening socket is in `blocking mode' or in `timeout mode',
     the socket returned by *note accept(): 669. is in `blocking mode';

   * if the listening socket is in `non-blocking mode', whether the
     socket returned by *note accept(): 669. is in blocking or
     non-blocking mode is operating system-dependent.  If you want to
     ensure cross-platform behaviour, it is recommended you manually
     override this setting.


File: python.info,  Node: Example<8>,  Prev: Notes on socket timeouts,  Up: socket — Low-level networking interface

5.19.2.12 Example
.................

Here are four minimal example programs using the TCP/IP protocol: a
server that echoes all data that it receives back (servicing only one
client), and a client using it.  Note that a server must perform the
sequence *note socket(): 668, *note bind(): 25d9, *note listen(): 73f,
*note accept(): 669. (possibly repeating the *note accept(): 669. to
service more than one client), while a client only needs the sequence
*note socket(): 668, *note connect(): 66a.  Also note that the server
does not *note sendall(): 66f./*note recv(): 66b. on the socket it is
listening on but on the new socket returned by *note accept(): 669.

The first two examples support IPv4 only.

     # Echo server program import socket  HOST = ''                 # Symbolic name meaning all available interfaces PORT = 50007              # Arbitrary non-privileged port with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:     s.bind((HOST, PORT))     s.listen(1)     conn, addr = s.accept()     with conn:         print('Connected by', addr)         while True:             data = conn.recv(1024)             if not data: break             conn.sendall(data)

     # Echo client program import socket  HOST = 'daring.cwi.nl'    # The remote host PORT = 50007              # The same port as used by the server with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:     s.connect((HOST, PORT))     s.sendall(b'Hello, world')     data = s.recv(1024) print('Received', repr(data))

The next two examples are identical to the above two, but support both
IPv4 and IPv6.  The server side will listen to the first address family
available (it should listen to both instead).  On most of IPv6-ready
systems, IPv6 will take precedence and the server may not accept IPv4
traffic.  The client side will try to connect to the all addresses
returned as a result of the name resolution, and sends traffic to the
first one connected successfully.

     # Echo server program import socket import sys  HOST = None               # Symbolic name meaning all available interfaces PORT = 50007              # Arbitrary non-privileged port s = None for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC,                               socket.SOCK_STREAM, 0, socket.AI_PASSIVE):     af, socktype, proto, canonname, sa = res     try:         s = socket.socket(af, socktype, proto)     except OSError as msg:         s = None         continue     try:         s.bind(sa)         s.listen(1)     except OSError as msg:         s.close()         s = None         continue     break if s is None:     print('could not open socket')     sys.exit(1) conn, addr = s.accept() with conn:     print('Connected by', addr)     while True:         data = conn.recv(1024)         if not data: break         conn.send(data)

     # Echo client program import socket import sys  HOST = 'daring.cwi.nl'    # The remote host PORT = 50007              # The same port as used by the server s = None for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):     af, socktype, proto, canonname, sa = res     try:         s = socket.socket(af, socktype, proto)     except OSError as msg:         s = None         continue     try:         s.connect(sa)     except OSError as msg:         s.close()         s = None         continue     break if s is None:     print('could not open socket')     sys.exit(1) with s:     s.sendall(b'Hello, world')     data = s.recv(1024) print('Received', repr(data))

The next example shows how to write a very simple network sniffer with
raw sockets on Windows.  The example requires administrator privileges
to modify the interface:

     import socket  # the public network interface HOST = socket.gethostbyname(socket.gethostname())  # create a raw socket and bind it to the public interface s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP) s.bind((HOST, 0))  # Include IP headers s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)  # receive all packages s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)  # receive a package print(s.recvfrom(65565))  # disabled promiscuous mode s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)

The next example shows how to use the socket interface to communicate to
a CAN network using the raw socket protocol.  To use CAN with the
broadcast manager protocol instead, open a socket with:

     socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)

After binding (‘CAN_RAW’) or connecting (*note CAN_BCM: 8ad.) the
socket, you can use the *note socket.send(): 66e, and the *note
socket.recv(): 66b. operations (and their counterparts) on the socket
object as usual.

This last example might require special privileges:

     import socket import struct   # CAN frame packing/unpacking (see 'struct can_frame' in <linux/can.h>)  can_frame_fmt = "=IB3x8s" can_frame_size = struct.calcsize(can_frame_fmt)  def build_can_frame(can_id, data):     can_dlc = len(data)     data = data.ljust(8, b'\x00')     return struct.pack(can_frame_fmt, can_id, can_dlc, data)  def dissect_can_frame(frame):     can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame)     return (can_id, can_dlc, data[:can_dlc])   # create a raw socket and bind it to the 'vcan0' interface s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW) s.bind(('vcan0',))  while True:     cf, addr = s.recvfrom(can_frame_size)      print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf))      try:         s.send(cf)     except OSError:         print('Error sending CAN frame')      try:         s.send(build_can_frame(0x01, b'\x01\x02\x03'))     except OSError:         print('Error sending CAN frame')

Running an example several times with too small delay between
executions, could lead to this error:

     OSError: [Errno 98] Address already in use

This is because the previous execution has left the socket in a
‘TIME_WAIT’ state, and can’t be immediately reused.

There is a *note socket: ef. flag to set, in order to prevent this,
‘socket.SO_REUSEADDR’:

     s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) s.bind((HOST, PORT))

the ‘SO_REUSEADDR’ flag tells the kernel to reuse a local socket in
‘TIME_WAIT’ state, without waiting for its natural timeout to expire.

See also
........

For an introduction to socket programming (in C), see the following
papers:

   - `An Introductory 4.3BSD Interprocess Communication Tutorial', by
     Stuart Sechrest

   - `An Advanced 4.3BSD Interprocess Communication Tutorial', by Samuel
     J. Leffler et al,

both in the UNIX Programmer’s Manual, Supplementary Documents 1
(sections PS1:7 and PS1:8).  The platform-specific reference material
for the various socket-related system calls are also a valuable source
of information on the details of socket semantics.  For Unix, refer to
the manual pages; for Windows, see the WinSock (or Winsock 2)
specification.  For IPv6-ready APIs, readers may want to refer to RFC
3493(1) titled Basic Socket Interface Extensions for IPv6.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3493.html


File: python.info,  Node: ssl — TLS/SSL wrapper for socket objects,  Next: select — Waiting for I/O completion,  Prev: socket — Low-level networking interface,  Up: Networking and Interprocess Communication

5.19.3 ‘ssl’ — TLS/SSL wrapper for socket objects
-------------------------------------------------

`Source code:' Lib/ssl.py(1)

__________________________________________________________________

This module provides access to Transport Layer Security (often known as
“Secure Sockets Layer”) encryption and peer authentication facilities
for network sockets, both client-side and server-side.  This module uses
the OpenSSL library.  It is available on all modern Unix systems,
Windows, Mac OS X, and probably additional platforms, as long as OpenSSL
is installed on that platform.

     Note: Some behavior may be platform dependent, since calls are made
     to the operating system socket APIs.  The installed version of
     OpenSSL may also cause variations in behavior.  For example,
     TLSv1.1 and TLSv1.2 come with openssl version 1.0.1.

     Warning: Don’t use this module without reading the *note Security
     considerations: 24f0.  Doing so may lead to a false sense of
     security, as the default settings of the ssl module are not
     necessarily appropriate for your application.

This section documents the objects and functions in the ‘ssl’ module;
for more general information about TLS, SSL, and certificates, the
reader is referred to the documents in the “See Also” section at the
bottom.

This module provides a class, *note ssl.SSLSocket: 3d7, which is derived
from the *note socket.socket: 668. type, and provides a socket-like
wrapper that also encrypts and decrypts the data going over the socket
with SSL. It supports additional methods such as ‘getpeercert()’, which
retrieves the certificate of the other side of the connection, and
‘cipher()’,which retrieves the cipher being used for the secure
connection.

For more sophisticated applications, the *note ssl.SSLContext: 3d9.
class helps manage settings and certificates, which can then be
inherited by SSL sockets created through the *note
SSLContext.wrap_socket(): 3da. method.

Changed in version 3.5.3: Updated to support linking with OpenSSL 1.1.0

Changed in version 3.6: OpenSSL 0.9.8, 1.0.0 and 1.0.1 are deprecated
and no longer supported.  In the future the ssl module will require at
least OpenSSL 1.0.2 or 1.1.0.

* Menu:

* Functions, Constants, and Exceptions: Functions Constants and Exceptions.
* SSL Sockets::
* SSL Contexts::
* Certificates::
* Examples: Examples<16>.
* Notes on non-blocking sockets::
* Memory BIO Support: Memory BIO Support<2>.
* SSL session::
* Security considerations::
* TLS 1.3: TLS 1 3.
* LibreSSL support::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/ssl.py


File: python.info,  Node: Functions Constants and Exceptions,  Next: SSL Sockets,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.1 Functions, Constants, and Exceptions
.............................................

* Menu:

* Socket creation::
* Context creation::
* Exceptions: Exceptions<12>.
* Random generation::
* Certificate handling::
* Constants: Constants<9>.


File: python.info,  Node: Socket creation,  Next: Context creation,  Up: Functions Constants and Exceptions

5.19.3.2 Socket creation
........................

Since Python 3.2 and 2.7.9, it is recommended to use the *note
SSLContext.wrap_socket(): 3da. of an *note SSLContext: 3d9. instance to
wrap sockets as *note SSLSocket: 3d7. objects.  The helper functions
*note create_default_context(): 8b5. returns a new context with secure
default settings.  The old *note wrap_socket(): 464. function is
deprecated since it is both inefficient and has no support for server
name indication (SNI) and hostname matching.

Client socket example with default context and IPv4/IPv6 dual stack:

     import socket import ssl  hostname = 'www.python.org' context = ssl.create_default_context()  with socket.create_connection((hostname, 443)) as sock:     with context.wrap_socket(sock, server_hostname=hostname) as ssock:         print(ssock.version())

Client socket example with custom context and IPv4:

     hostname = 'www.python.org' # PROTOCOL_TLS_CLIENT requires valid cert chain and hostname context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) context.load_verify_locations('path/to/cabundle.pem')  with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:     with context.wrap_socket(sock, server_hostname=hostname) as ssock:         print(ssock.version())

Server socket example listening on localhost IPv4:

     context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER) context.load_cert_chain('/path/to/certchain.pem', '/path/to/private.key')  with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:     sock.bind(('127.0.0.1', 8443))     sock.listen(5)     with context.wrap_socket(sock, server_side=True) as ssock:         conn, addr = ssock.accept()         ...


File: python.info,  Node: Context creation,  Next: Exceptions<12>,  Prev: Socket creation,  Up: Functions Constants and Exceptions

5.19.3.3 Context creation
.........................

A convenience function helps create *note SSLContext: 3d9. objects for
common purposes.

 -- Function: ssl.create_default_context (purpose=Purpose.SERVER_AUTH,
          cafile=None, capath=None, cadata=None)

     Return a new *note SSLContext: 3d9. object with default settings
     for the given `purpose'.  The settings are chosen by the *note ssl:
     f3. module, and usually represent a higher security level than when
     calling the *note SSLContext: 3d9. constructor directly.

     `cafile', `capath', `cadata' represent optional CA certificates to
     trust for certificate verification, as in *note
     SSLContext.load_verify_locations(): 7df.  If all three are *note
     None: 157, this function can choose to trust the system’s default
     CA certificates instead.

     The settings are: *note PROTOCOL_TLS: 25ee, *note OP_NO_SSLv2: b93,
     and *note OP_NO_SSLv3: 25ef. with high encryption cipher suites
     without RC4 and without unauthenticated cipher suites.  Passing
     *note SERVER_AUTH: 8c0. as `purpose' sets *note verify_mode: 25f0.
     to *note CERT_REQUIRED: 25f1. and either loads CA certificates
     (when at least one of `cafile', `capath' or `cadata' is given) or
     uses *note SSLContext.load_default_certs(): 8bf. to load default CA
     certificates.

     When *note keylog_filename: 25f2. is supported and the environment
     variable ‘SSLKEYLOGFILE’ is set, *note create_default_context():
     8b5. enables key logging.

          Note: The protocol, options, cipher and other settings may
          change to more restrictive values anytime without prior
          deprecation.  The values represent a fair balance between
          compatibility and security.

          If your application needs specific settings, you should create
          a *note SSLContext: 3d9. and apply the settings yourself.

          Note: If you find that when certain older clients or servers
          attempt to connect with a *note SSLContext: 3d9. created by
          this function that they get an error stating “Protocol or
          cipher suite mismatch”, it may be that they only support
          SSL3.0 which this function excludes using the *note
          OP_NO_SSLv3: 25ef.  SSL3.0 is widely considered to be
          completely broken(1).  If you still wish to continue to use
          this function but still allow SSL 3.0 connections you can
          re-enable them using:

               ctx = ssl.create_default_context(Purpose.CLIENT_AUTH) ctx.options &= ~ssl.OP_NO_SSLv3

     New in version 3.4.

     Changed in version 3.4.4: RC4 was dropped from the default cipher
     string.

     Changed in version 3.6: ChaCha20/Poly1305 was added to the default
     cipher string.

     3DES was dropped from the default cipher string.

     Changed in version 3.8: Support for key logging to ‘SSLKEYLOGFILE’
     was added.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/POODLE


File: python.info,  Node: Exceptions<12>,  Next: Random generation,  Prev: Context creation,  Up: Functions Constants and Exceptions

5.19.3.4 Exceptions
...................

 -- Exception: ssl.SSLError

     Raised to signal an error from the underlying SSL implementation
     (currently provided by the OpenSSL library).  This signifies some
     problem in the higher-level encryption and authentication layer
     that’s superimposed on the underlying network connection.  This
     error is a subtype of *note OSError: 1d1.  The error code and
     message of *note SSLError: c02. instances are provided by the
     OpenSSL library.

     Changed in version 3.3: *note SSLError: c02. used to be a subtype
     of *note socket.error: 989.

      -- Attribute: library

          A string mnemonic designating the OpenSSL submodule in which
          the error occurred, such as ‘SSL’, ‘PEM’ or ‘X509’.  The range
          of possible values depends on the OpenSSL version.

          New in version 3.3.

      -- Attribute: reason

          A string mnemonic designating the reason this error occurred,
          for example ‘CERTIFICATE_VERIFY_FAILED’.  The range of
          possible values depends on the OpenSSL version.

          New in version 3.3.

 -- Exception: ssl.SSLZeroReturnError

     A subclass of *note SSLError: c02. raised when trying to read or
     write and the SSL connection has been closed cleanly.  Note that
     this doesn’t mean that the underlying transport (read TCP) has been
     closed.

     New in version 3.3.

 -- Exception: ssl.SSLWantReadError

     A subclass of *note SSLError: c02. raised by a *note non-blocking
     SSL socket: 25f5. when trying to read or write data, but more data
     needs to be received on the underlying TCP transport before the
     request can be fulfilled.

     New in version 3.3.

 -- Exception: ssl.SSLWantWriteError

     A subclass of *note SSLError: c02. raised by a *note non-blocking
     SSL socket: 25f5. when trying to read or write data, but more data
     needs to be sent on the underlying TCP transport before the request
     can be fulfilled.

     New in version 3.3.

 -- Exception: ssl.SSLSyscallError

     A subclass of *note SSLError: c02. raised when a system error was
     encountered while trying to fulfill an operation on a SSL socket.
     Unfortunately, there is no easy way to inspect the original errno
     number.

     New in version 3.3.

 -- Exception: ssl.SSLEOFError

     A subclass of *note SSLError: c02. raised when the SSL connection
     has been terminated abruptly.  Generally, you shouldn’t try to
     reuse the underlying transport when this error is encountered.

     New in version 3.3.

 -- Exception: ssl.SSLCertVerificationError

     A subclass of *note SSLError: c02. raised when certificate
     validation has failed.

     New in version 3.7.

      -- Attribute: verify_code

          A numeric error number that denotes the verification error.

      -- Attribute: verify_message

          A human readable string of the verification error.

 -- Exception: ssl.CertificateError

     An alias for *note SSLCertVerificationError: 3d2.

     Changed in version 3.7: The exception is now an alias for *note
     SSLCertVerificationError: 3d2.


File: python.info,  Node: Random generation,  Next: Certificate handling,  Prev: Exceptions<12>,  Up: Functions Constants and Exceptions

5.19.3.5 Random generation
..........................

 -- Function: ssl.RAND_bytes (num)

     Return `num' cryptographically strong pseudo-random bytes.  Raises
     an *note SSLError: c02. if the PRNG has not been seeded with enough
     data or if the operation is not supported by the current RAND
     method.  *note RAND_status(): 25fc. can be used to check the status
     of the PRNG and *note RAND_add(): 25fd. can be used to seed the
     PRNG.

     For almost all applications *note os.urandom(): 4c6. is preferable.

     Read the Wikipedia article, Cryptographically secure pseudorandom
     number generator (CSPRNG)(1), to get the requirements of a
     cryptographically generator.

     New in version 3.3.

 -- Function: ssl.RAND_pseudo_bytes (num)

     Return (bytes, is_cryptographic): bytes are `num' pseudo-random
     bytes, is_cryptographic is ‘True’ if the bytes generated are
     cryptographically strong.  Raises an *note SSLError: c02. if the
     operation is not supported by the current RAND method.

     Generated pseudo-random byte sequences will be unique if they are
     of sufficient length, but are not necessarily unpredictable.  They
     can be used for non-cryptographic purposes and for certain purposes
     in cryptographic protocols, but usually not for key generation etc.

     For almost all applications *note os.urandom(): 4c6. is preferable.

     New in version 3.3.

     Deprecated since version 3.6: OpenSSL has deprecated *note
     ssl.RAND_pseudo_bytes(): a85, use *note ssl.RAND_bytes(): a84.
     instead.

 -- Function: ssl.RAND_status ()

     Return ‘True’ if the SSL pseudo-random number generator has been
     seeded with ‘enough’ randomness, and ‘False’ otherwise.  You can
     use *note ssl.RAND_egd(): 25fe. and *note ssl.RAND_add(): 25fd. to
     increase the randomness of the pseudo-random number generator.

 -- Function: ssl.RAND_egd (path)

     If you are running an entropy-gathering daemon (EGD) somewhere, and
     `path' is the pathname of a socket connection open to it, this will
     read 256 bytes of randomness from the socket, and add it to the SSL
     pseudo-random number generator to increase the security of
     generated secret keys.  This is typically only necessary on systems
     without better sources of randomness.

     See ‘http://egd.sourceforge.net/’ or
     ‘http://prngd.sourceforge.net/’ for sources of entropy-gathering
     daemons.

     *note Availability: 129a.: not available with LibreSSL and OpenSSL
     > 1.1.0.

 -- Function: ssl.RAND_add (bytes, entropy)

     Mix the given `bytes' into the SSL pseudo-random number generator.
     The parameter `entropy' (a float) is a lower bound on the entropy
     contained in string (so you can always use ‘0.0’).  See RFC 1750(2)
     for more information on sources of entropy.

     Changed in version 3.5: Writable *note bytes-like object: 5dd. is
     now accepted.

   ---------- Footnotes ----------

   (1) 
https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator

   (2) https://tools.ietf.org/html/rfc1750.html


File: python.info,  Node: Certificate handling,  Next: Constants<9>,  Prev: Random generation,  Up: Functions Constants and Exceptions

5.19.3.6 Certificate handling
.............................

 -- Function: ssl.match_hostname (cert, hostname)

     Verify that `cert' (in decoded format as returned by *note
     SSLSocket.getpeercert(): 8c5.) matches the given `hostname'.  The
     rules applied are those for checking the identity of HTTPS servers
     as outlined in RFC 2818(1), RFC 5280(2) and RFC 6125(3).  In
     addition to HTTPS, this function should be suitable for checking
     the identity of servers in various SSL-based protocols such as
     FTPS, IMAPS, POPS and others.

     *note CertificateError: 25fa. is raised on failure.  On success,
     the function returns nothing:

          >>> cert = {'subject': ((('commonName', 'example.com'),),)} >>> ssl.match_hostname(cert, "example.com") >>> ssl.match_hostname(cert, "example.org") Traceback (most recent call last):   File "<stdin>", line 1, in <module>   File "/home/py3k/Lib/ssl.py", line 130, in match_hostname ssl.CertificateError: hostname 'example.org' doesn't match 'example.com'

     New in version 3.2.

     Changed in version 3.3.3: The function now follows RFC 6125(4),
     section 6.4.3 and does neither match multiple wildcards (e.g.
     ‘*.*.com’ or ‘*a*.example.org’) nor a wildcard inside an
     internationalized domain names (IDN) fragment.  IDN A-labels such
     as ‘www*.xn--pthon-kva.org’ are still supported, but
     ‘x*.python.org’ no longer matches ‘xn--tda.python.org’.

     Changed in version 3.5: Matching of IP addresses, when present in
     the subjectAltName field of the certificate, is now supported.

     Changed in version 3.7: The function is no longer used to TLS
     connections.  Hostname matching is now performed by OpenSSL.

     Allow wildcard when it is the leftmost and the only character in
     that segment.  Partial wildcards like ‘www*.example.com’ are no
     longer supported.

     Deprecated since version 3.7.

 -- Function: ssl.cert_time_to_seconds (cert_time)

     Return the time in seconds since the Epoch, given the ‘cert_time’
     string representing the “notBefore” or “notAfter” date from a
     certificate in ‘"%b %d %H:%M:%S %Y %Z"’ strptime format (C locale).

     Here’s an example:

          >>> import ssl >>> timestamp = ssl.cert_time_to_seconds("Jan  5 09:34:43 2018 GMT") >>> timestamp   1515144883 >>> from datetime import datetime >>> print(datetime.utcfromtimestamp(timestamp))   2018-01-05 09:34:43

     “notBefore” or “notAfter” dates must use GMT ( RFC 5280(5)).

     Changed in version 3.5: Interpret the input time as a time in UTC
     as specified by ‘GMT’ timezone in the input string.  Local timezone
     was used previously.  Return an integer (no fractions of a second
     in the input format)

 -- Function: ssl.get_server_certificate (addr,
          ssl_version=PROTOCOL_TLS, ca_certs=None)

     Given the address ‘addr’ of an SSL-protected server, as a
     (`hostname', `port-number') pair, fetches the server’s certificate,
     and returns it as a PEM-encoded string.  If ‘ssl_version’ is
     specified, uses that version of the SSL protocol to attempt to
     connect to the server.  If ‘ca_certs’ is specified, it should be a
     file containing a list of root certificates, the same format as
     used for the same parameter in *note SSLContext.wrap_socket(): 3da.
     The call will attempt to validate the server certificate against
     that set of root certificates, and will fail if the validation
     attempt fails.

     Changed in version 3.3: This function is now IPv6-compatible.

     Changed in version 3.5: The default `ssl_version' is changed from
     *note PROTOCOL_SSLv3: 2600. to *note PROTOCOL_TLS: 25ee. for
     maximum compatibility with modern servers.

 -- Function: ssl.DER_cert_to_PEM_cert (DER_cert_bytes)

     Given a certificate as a DER-encoded blob of bytes, returns a
     PEM-encoded string version of the same certificate.

 -- Function: ssl.PEM_cert_to_DER_cert (PEM_cert_string)

     Given a certificate as an ASCII PEM string, returns a DER-encoded
     sequence of bytes for that same certificate.

 -- Function: ssl.get_default_verify_paths ()

     Returns a named tuple with paths to OpenSSL’s default cafile and
     capath.  The paths are the same as used by *note
     SSLContext.set_default_verify_paths(): 8b7.  The return value is a
     *note named tuple: a98. ‘DefaultVerifyPaths’:

        * ‘cafile’ - resolved path to cafile or ‘None’ if the file
          doesn’t exist,

        * ‘capath’ - resolved path to capath or ‘None’ if the directory
          doesn’t exist,

        * ‘openssl_cafile_env’ - OpenSSL’s environment key that points
          to a cafile,

        * ‘openssl_cafile’ - hard coded path to a cafile,

        * ‘openssl_capath_env’ - OpenSSL’s environment key that points
          to a capath,

        * ‘openssl_capath’ - hard coded path to a capath directory

     *note Availability: 129a.: LibreSSL ignores the environment vars
     ‘openssl_cafile_env’ and ‘openssl_capath_env’.

     New in version 3.4.

 -- Function: ssl.enum_certificates (store_name)

     Retrieve certificates from Windows’ system cert store.
     `store_name' may be one of ‘CA’, ‘ROOT’ or ‘MY’.  Windows may
     provide additional cert stores, too.

     The function returns a list of (cert_bytes, encoding_type, trust)
     tuples.  The encoding_type specifies the encoding of cert_bytes.
     It is either ‘x509_asn’ for X.509 ASN.1 data or ‘pkcs_7_asn’ for
     PKCS#7 ASN.1 data.  Trust specifies the purpose of the certificate
     as a set of OIDS or exactly ‘True’ if the certificate is
     trustworthy for all purposes.

     Example:

          >>> ssl.enum_certificates("CA") [(b'data...', 'x509_asn', {'1.3.6.1.5.5.7.3.1', '1.3.6.1.5.5.7.3.2'}),  (b'data...', 'x509_asn', True)]

     *note Availability: 129a.: Windows.

     New in version 3.4.

 -- Function: ssl.enum_crls (store_name)

     Retrieve CRLs from Windows’ system cert store.  `store_name' may be
     one of ‘CA’, ‘ROOT’ or ‘MY’.  Windows may provide additional cert
     stores, too.

     The function returns a list of (cert_bytes, encoding_type, trust)
     tuples.  The encoding_type specifies the encoding of cert_bytes.
     It is either ‘x509_asn’ for X.509 ASN.1 data or ‘pkcs_7_asn’ for
     PKCS#7 ASN.1 data.

     *note Availability: 129a.: Windows.

     New in version 3.4.

 -- Function: ssl.wrap_socket (sock, keyfile=None, certfile=None,
          server_side=False, cert_reqs=CERT_NONE,
          ssl_version=PROTOCOL_TLS, ca_certs=None,
          do_handshake_on_connect=True, suppress_ragged_eofs=True,
          ciphers=None)

     Takes an instance ‘sock’ of *note socket.socket: 668, and returns
     an instance of *note ssl.SSLSocket: 3d7, a subtype of *note
     socket.socket: 668, which wraps the underlying socket in an SSL
     context.  ‘sock’ must be a *note SOCK_STREAM: c7d. socket; other
     socket types are unsupported.

     Internally, function creates a *note SSLContext: 3d9. with protocol
     `ssl_version' and *note SSLContext.options: 2603. set to
     `cert_reqs'.  If parameters `keyfile', `certfile', `ca_certs' or
     `ciphers' are set, then the values are passed to *note
     SSLContext.load_cert_chain(): a86, *note
     SSLContext.load_verify_locations(): 7df, and *note
     SSLContext.set_ciphers(): 2604.

     The arguments `server_side', `do_handshake_on_connect', and
     `suppress_ragged_eofs' have the same meaning as *note
     SSLContext.wrap_socket(): 3da.

     Deprecated since version 3.7: Since Python 3.2 and 2.7.9, it is
     recommended to use the *note SSLContext.wrap_socket(): 3da. instead
     of *note wrap_socket(): 464.  The top-level function is limited and
     creates an insecure client socket without server name indication or
     hostname matching.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2818.html

   (2) https://tools.ietf.org/html/rfc5280.html

   (3) https://tools.ietf.org/html/rfc6125.html

   (4) https://tools.ietf.org/html/rfc6125.html

   (5) https://tools.ietf.org/html/rfc5280.html


File: python.info,  Node: Constants<9>,  Prev: Certificate handling,  Up: Functions Constants and Exceptions

5.19.3.7 Constants
..................

     All constants are now *note enum.IntEnum: 582. or *note
     enum.IntFlag: 1693. collections.

     New in version 3.6.

 -- Data: ssl.CERT_NONE

     Possible value for *note SSLContext.verify_mode: 25f0, or the
     ‘cert_reqs’ parameter to *note wrap_socket(): 464.  Except for
     *note PROTOCOL_TLS_CLIENT: 2607, it is the default mode.  With
     client-side sockets, just about any cert is accepted.  Validation
     errors, such as untrusted or expired cert, are ignored and do not
     abort the TLS/SSL handshake.

     In server mode, no certificate is requested from the client, so the
     client does not send any for client cert authentication.

     See the discussion of *note Security considerations: 24f0. below.

 -- Data: ssl.CERT_OPTIONAL

     Possible value for *note SSLContext.verify_mode: 25f0, or the
     ‘cert_reqs’ parameter to *note wrap_socket(): 464.  In client mode,
     *note CERT_OPTIONAL: 2608. has the same meaning as *note
     CERT_REQUIRED: 25f1.  It is recommended to use *note CERT_REQUIRED:
     25f1. for client-side sockets instead.

     In server mode, a client certificate request is sent to the client.
     The client may either ignore the request or send a certificate in
     order perform TLS client cert authentication.  If the client
     chooses to send a certificate, it is verified.  Any verification
     error immediately aborts the TLS handshake.

     Use of this setting requires a valid set of CA certificates to be
     passed, either to *note SSLContext.load_verify_locations(): 7df. or
     as a value of the ‘ca_certs’ parameter to *note wrap_socket(): 464.

 -- Data: ssl.CERT_REQUIRED

     Possible value for *note SSLContext.verify_mode: 25f0, or the
     ‘cert_reqs’ parameter to *note wrap_socket(): 464.  In this mode,
     certificates are required from the other side of the socket
     connection; an *note SSLError: c02. will be raised if no
     certificate is provided, or if its validation fails.  This mode is
     `not' sufficient to verify a certificate in client mode as it does
     not match hostnames.  *note check_hostname: 2609. must be enabled
     as well to verify the authenticity of a cert.  *note
     PROTOCOL_TLS_CLIENT: 2607. uses *note CERT_REQUIRED: 25f1. and
     enables *note check_hostname: 2609. by default.

     With server socket, this mode provides mandatory TLS client cert
     authentication.  A client certificate request is sent to the client
     and the client must provide a valid and trusted certificate.

     Use of this setting requires a valid set of CA certificates to be
     passed, either to *note SSLContext.load_verify_locations(): 7df. or
     as a value of the ‘ca_certs’ parameter to *note wrap_socket(): 464.

 -- Class: ssl.VerifyMode

     *note enum.IntEnum: 582. collection of CERT_* constants.

     New in version 3.6.

 -- Data: ssl.VERIFY_DEFAULT

     Possible value for *note SSLContext.verify_flags: 8ba.  In this
     mode, certificate revocation lists (CRLs) are not checked.  By
     default OpenSSL does neither require nor verify CRLs.

     New in version 3.4.

 -- Data: ssl.VERIFY_CRL_CHECK_LEAF

     Possible value for *note SSLContext.verify_flags: 8ba.  In this
     mode, only the peer cert is checked but none of the intermediate CA
     certificates.  The mode requires a valid CRL that is signed by the
     peer cert’s issuer (its direct ancestor CA). If no proper CRL has
     has been loaded with *note SSLContext.load_verify_locations: 7df,
     validation will fail.

     New in version 3.4.

 -- Data: ssl.VERIFY_CRL_CHECK_CHAIN

     Possible value for *note SSLContext.verify_flags: 8ba.  In this
     mode, CRLs of all certificates in the peer cert chain are checked.

     New in version 3.4.

 -- Data: ssl.VERIFY_X509_STRICT

     Possible value for *note SSLContext.verify_flags: 8ba. to disable
     workarounds for broken X.509 certificates.

     New in version 3.4.

 -- Data: ssl.VERIFY_X509_TRUSTED_FIRST

     Possible value for *note SSLContext.verify_flags: 8ba.  It
     instructs OpenSSL to prefer trusted certificates when building the
     trust chain to validate a certificate.  This flag is enabled by
     default.

     New in version 3.4.4.

 -- Class: ssl.VerifyFlags

     *note enum.IntFlag: 1693. collection of VERIFY_* constants.

     New in version 3.6.

 -- Data: ssl.PROTOCOL_TLS

     Selects the highest protocol version that both the client and
     server support.  Despite the name, this option can select both
     “SSL” and “TLS” protocols.

     New in version 3.6.

 -- Data: ssl.PROTOCOL_TLS_CLIENT

     Auto-negotiate the highest protocol version like *note
     PROTOCOL_TLS: 25ee, but only support client-side *note SSLSocket:
     3d7. connections.  The protocol enables *note CERT_REQUIRED: 25f1.
     and *note check_hostname: 2609. by default.

     New in version 3.6.

 -- Data: ssl.PROTOCOL_TLS_SERVER

     Auto-negotiate the highest protocol version like *note
     PROTOCOL_TLS: 25ee, but only support server-side *note SSLSocket:
     3d7. connections.

     New in version 3.6.

 -- Data: ssl.PROTOCOL_SSLv23

     Alias for *note PROTOCOL_TLS: 25ee.

     Deprecated since version 3.6: Use *note PROTOCOL_TLS: 25ee.
     instead.

 -- Data: ssl.PROTOCOL_SSLv2

     Selects SSL version 2 as the channel encryption protocol.

     This protocol is not available if OpenSSL is compiled with the
     ‘OPENSSL_NO_SSL2’ flag.

          Warning: SSL version 2 is insecure.  Its use is highly
          discouraged.

     Deprecated since version 3.6: OpenSSL has removed support for
     SSLv2.

 -- Data: ssl.PROTOCOL_SSLv3

     Selects SSL version 3 as the channel encryption protocol.

     This protocol is not be available if OpenSSL is compiled with the
     ‘OPENSSL_NO_SSLv3’ flag.

          Warning: SSL version 3 is insecure.  Its use is highly
          discouraged.

     Deprecated since version 3.6: OpenSSL has deprecated all version
     specific protocols.  Use the default protocol *note PROTOCOL_TLS:
     25ee. with flags like *note OP_NO_SSLv3: 25ef. instead.

 -- Data: ssl.PROTOCOL_TLSv1

     Selects TLS version 1.0 as the channel encryption protocol.

     Deprecated since version 3.6: OpenSSL has deprecated all version
     specific protocols.  Use the default protocol *note PROTOCOL_TLS:
     25ee. with flags like *note OP_NO_SSLv3: 25ef. instead.

 -- Data: ssl.PROTOCOL_TLSv1_1

     Selects TLS version 1.1 as the channel encryption protocol.
     Available only with openssl version 1.0.1+.

     New in version 3.4.

     Deprecated since version 3.6: OpenSSL has deprecated all version
     specific protocols.  Use the default protocol *note PROTOCOL_TLS:
     25ee. with flags like *note OP_NO_SSLv3: 25ef. instead.

 -- Data: ssl.PROTOCOL_TLSv1_2

     Selects TLS version 1.2 as the channel encryption protocol.  This
     is the most modern version, and probably the best choice for
     maximum protection, if both sides can speak it.  Available only
     with openssl version 1.0.1+.

     New in version 3.4.

     Deprecated since version 3.6: OpenSSL has deprecated all version
     specific protocols.  Use the default protocol *note PROTOCOL_TLS:
     25ee. with flags like *note OP_NO_SSLv3: 25ef. instead.

 -- Data: ssl.OP_ALL

     Enables workarounds for various bugs present in other SSL
     implementations.  This option is set by default.  It does not
     necessarily set the same flags as OpenSSL’s ‘SSL_OP_ALL’ constant.

     New in version 3.2.

 -- Data: ssl.OP_NO_SSLv2

     Prevents an SSLv2 connection.  This option is only applicable in
     conjunction with *note PROTOCOL_TLS: 25ee.  It prevents the peers
     from choosing SSLv2 as the protocol version.

     New in version 3.2.

     Deprecated since version 3.6: SSLv2 is deprecated

 -- Data: ssl.OP_NO_SSLv3

     Prevents an SSLv3 connection.  This option is only applicable in
     conjunction with *note PROTOCOL_TLS: 25ee.  It prevents the peers
     from choosing SSLv3 as the protocol version.

     New in version 3.2.

     Deprecated since version 3.6: SSLv3 is deprecated

 -- Data: ssl.OP_NO_TLSv1

     Prevents a TLSv1 connection.  This option is only applicable in
     conjunction with *note PROTOCOL_TLS: 25ee.  It prevents the peers
     from choosing TLSv1 as the protocol version.

     New in version 3.2.

     Deprecated since version 3.7: The option is deprecated since
     OpenSSL 1.1.0, use the new *note SSLContext.minimum_version: 3dc.
     and *note SSLContext.maximum_version: 3dd. instead.

 -- Data: ssl.OP_NO_TLSv1_1

     Prevents a TLSv1.1 connection.  This option is only applicable in
     conjunction with *note PROTOCOL_TLS: 25ee.  It prevents the peers
     from choosing TLSv1.1 as the protocol version.  Available only with
     openssl version 1.0.1+.

     New in version 3.4.

     Deprecated since version 3.7: The option is deprecated since
     OpenSSL 1.1.0.

 -- Data: ssl.OP_NO_TLSv1_2

     Prevents a TLSv1.2 connection.  This option is only applicable in
     conjunction with *note PROTOCOL_TLS: 25ee.  It prevents the peers
     from choosing TLSv1.2 as the protocol version.  Available only with
     openssl version 1.0.1+.

     New in version 3.4.

     Deprecated since version 3.7: The option is deprecated since
     OpenSSL 1.1.0.

 -- Data: ssl.OP_NO_TLSv1_3

     Prevents a TLSv1.3 connection.  This option is only applicable in
     conjunction with *note PROTOCOL_TLS: 25ee.  It prevents the peers
     from choosing TLSv1.3 as the protocol version.  TLS 1.3 is
     available with OpenSSL 1.1.1 or later.  When Python has been
     compiled against an older version of OpenSSL, the flag defaults to
     `0'.

     New in version 3.7.

     Deprecated since version 3.7: The option is deprecated since
     OpenSSL 1.1.0.  It was added to 2.7.15, 3.6.3 and 3.7.0 for
     backwards compatibility with OpenSSL 1.0.2.

 -- Data: ssl.OP_NO_RENEGOTIATION

     Disable all renegotiation in TLSv1.2 and earlier.  Do not send
     HelloRequest messages, and ignore renegotiation requests via
     ClientHello.

     This option is only available with OpenSSL 1.1.0h and later.

     New in version 3.7.

 -- Data: ssl.OP_CIPHER_SERVER_PREFERENCE

     Use the server’s cipher ordering preference, rather than the
     client’s.  This option has no effect on client sockets and SSLv2
     server sockets.

     New in version 3.3.

 -- Data: ssl.OP_SINGLE_DH_USE

     Prevents re-use of the same DH key for distinct SSL sessions.  This
     improves forward secrecy but requires more computational resources.
     This option only applies to server sockets.

     New in version 3.3.

 -- Data: ssl.OP_SINGLE_ECDH_USE

     Prevents re-use of the same ECDH key for distinct SSL sessions.
     This improves forward secrecy but requires more computational
     resources.  This option only applies to server sockets.

     New in version 3.3.

 -- Data: ssl.OP_ENABLE_MIDDLEBOX_COMPAT

     Send dummy Change Cipher Spec (CCS) messages in TLS 1.3 handshake
     to make a TLS 1.3 connection look more like a TLS 1.2 connection.

     This option is only available with OpenSSL 1.1.1 and later.

     New in version 3.8.

 -- Data: ssl.OP_NO_COMPRESSION

     Disable compression on the SSL channel.  This is useful if the
     application protocol supports its own compression scheme.

     This option is only available with OpenSSL 1.0.0 and later.

     New in version 3.3.

 -- Class: ssl.Options

     *note enum.IntFlag: 1693. collection of OP_* constants.

 -- Data: ssl.OP_NO_TICKET

     Prevent client side from requesting a session ticket.

     New in version 3.6.

 -- Data: ssl.HAS_ALPN

     Whether the OpenSSL library has built-in support for the
     `Application-Layer Protocol Negotiation' TLS extension as described
     in RFC 7301(1).

     New in version 3.5.

 -- Data: ssl.HAS_NEVER_CHECK_COMMON_NAME

     Whether the OpenSSL library has built-in support not checking
     subject common name and *note
     SSLContext.hostname_checks_common_name: 3d3. is writeable.

     New in version 3.7.

 -- Data: ssl.HAS_ECDH

     Whether the OpenSSL library has built-in support for the Elliptic
     Curve-based Diffie-Hellman key exchange.  This should be true
     unless the feature was explicitly disabled by the distributor.

     New in version 3.3.

 -- Data: ssl.HAS_SNI

     Whether the OpenSSL library has built-in support for the `Server
     Name Indication' extension (as defined in RFC 6066(2)).

     New in version 3.2.

 -- Data: ssl.HAS_NPN

     Whether the OpenSSL library has built-in support for the `Next
     Protocol Negotiation' as described in the Application Layer
     Protocol Negotiation(3).  When true, you can use the *note
     SSLContext.set_npn_protocols(): a8c. method to advertise which
     protocols you want to support.

     New in version 3.3.

 -- Data: ssl.HAS_SSLv2

     Whether the OpenSSL library has built-in support for the SSL 2.0
     protocol.

     New in version 3.7.

 -- Data: ssl.HAS_SSLv3

     Whether the OpenSSL library has built-in support for the SSL 3.0
     protocol.

     New in version 3.7.

 -- Data: ssl.HAS_TLSv1

     Whether the OpenSSL library has built-in support for the TLS 1.0
     protocol.

     New in version 3.7.

 -- Data: ssl.HAS_TLSv1_1

     Whether the OpenSSL library has built-in support for the TLS 1.1
     protocol.

     New in version 3.7.

 -- Data: ssl.HAS_TLSv1_2

     Whether the OpenSSL library has built-in support for the TLS 1.2
     protocol.

     New in version 3.7.

 -- Data: ssl.HAS_TLSv1_3

     Whether the OpenSSL library has built-in support for the TLS 1.3
     protocol.

     New in version 3.7.

 -- Data: ssl.CHANNEL_BINDING_TYPES

     List of supported TLS channel binding types.  Strings in this list
     can be used as arguments to *note SSLSocket.get_channel_binding():
     a89.

     New in version 3.3.

 -- Data: ssl.OPENSSL_VERSION

     The version string of the OpenSSL library loaded by the
     interpreter:

          >>> ssl.OPENSSL_VERSION 'OpenSSL 1.0.2k  26 Jan 2017'

     New in version 3.2.

 -- Data: ssl.OPENSSL_VERSION_INFO

     A tuple of five integers representing version information about the
     OpenSSL library:

          >>> ssl.OPENSSL_VERSION_INFO (1, 0, 2, 11, 15)

     New in version 3.2.

 -- Data: ssl.OPENSSL_VERSION_NUMBER

     The raw version number of the OpenSSL library, as a single integer:

          >>> ssl.OPENSSL_VERSION_NUMBER 268443839 >>> hex(ssl.OPENSSL_VERSION_NUMBER) '0x100020bf'

     New in version 3.2.

 -- Data: ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE
 -- Data: ssl.ALERT_DESCRIPTION_INTERNAL_ERROR

 -- Data: ALERT_DESCRIPTION_*

     Alert Descriptions from RFC 5246(4) and others.  The IANA TLS Alert
     Registry(5) contains this list and references to the RFCs where
     their meaning is defined.

     Used as the return value of the callback function in *note
     SSLContext.set_servername_callback(): 8c4.

     New in version 3.4.

 -- Class: ssl.AlertDescription

     *note enum.IntEnum: 582. collection of ALERT_DESCRIPTION_*
     constants.

     New in version 3.6.

 -- Data: Purpose.SERVER_AUTH

     Option for *note create_default_context(): 8b5. and *note
     SSLContext.load_default_certs(): 8bf.  This value indicates that
     the context may be used to authenticate Web servers (therefore, it
     will be used to create client-side sockets).

     New in version 3.4.

 -- Data: Purpose.CLIENT_AUTH

     Option for *note create_default_context(): 8b5. and *note
     SSLContext.load_default_certs(): 8bf.  This value indicates that
     the context may be used to authenticate Web clients (therefore, it
     will be used to create server-side sockets).

     New in version 3.4.

 -- Class: ssl.SSLErrorNumber

     *note enum.IntEnum: 582. collection of SSL_ERROR_* constants.

     New in version 3.6.

 -- Class: ssl.TLSVersion

     *note enum.IntEnum: 582. collection of SSL and TLS versions for
     *note SSLContext.maximum_version: 3dd. and *note
     SSLContext.minimum_version: 3dc.

     New in version 3.7.

 -- Attribute: TLSVersion.MINIMUM_SUPPORTED

 -- Attribute: TLSVersion.MAXIMUM_SUPPORTED

     The minimum or maximum supported SSL or TLS version.  These are
     magic constants.  Their values don’t reflect the lowest and highest
     available TLS/SSL versions.

 -- Attribute: TLSVersion.SSLv3

 -- Attribute: TLSVersion.TLSv1

 -- Attribute: TLSVersion.TLSv1_1

 -- Attribute: TLSVersion.TLSv1_2

 -- Attribute: TLSVersion.TLSv1_3

     SSL 3.0 to TLS 1.3.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc7301.html

   (2) https://tools.ietf.org/html/rfc6066.html

   (3) 
https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation

   (4) https://tools.ietf.org/html/rfc5246.html

   (5) 
https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6


File: python.info,  Node: SSL Sockets,  Next: SSL Contexts,  Prev: Functions Constants and Exceptions,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.8 SSL Sockets
....................

 -- Class: ssl.SSLSocket (socket.socket)

     SSL sockets provide the following methods of *note Socket Objects:
     25ca.:

        - *note accept(): 669.

        - *note bind(): 25d9.

        - *note close(): 5f5.

        - *note connect(): 66a.

        - *note detach(): b90.

        - *note fileno(): 25dd.

        - *note getpeername(): 2535, *note getsockname(): 2536.

        - *note getsockopt(): 577, *note setsockopt(): 578.

        - *note gettimeout(): 25de, *note settimeout(): 25ad, *note
          setblocking(): 1e4d.

        - *note listen(): 73f.

        - *note makefile(): b0c.

        - *note recv(): 66b, *note recv_into(): ca5. (but passing a
          non-zero ‘flags’ argument is not allowed)

        - *note send(): 66e, *note sendall(): 66f. (with the same
          limitation)

        - *note sendfile(): 73e. (but *note os.sendfile: 34e. will be
          used for plain-text sockets only, else *note send(): 66e. will
          be used)

        - *note shutdown(): 25da.

     However, since the SSL (and TLS) protocol has its own framing atop
     of TCP, the SSL sockets abstraction can, in certain respects,
     diverge from the specification of normal, OS-level sockets.  See
     especially the *note notes on non-blocking sockets: 25f5.

     Instances of *note SSLSocket: 3d7. must be created using the *note
     SSLContext.wrap_socket(): 3da. method.

     Changed in version 3.5: The ‘sendfile()’ method was added.

     Changed in version 3.5: The ‘shutdown()’ does not reset the socket
     timeout each time bytes are received or sent.  The socket timeout
     is now to maximum total duration of the shutdown.

     Deprecated since version 3.6: It is deprecated to create a *note
     SSLSocket: 3d7. instance directly, use *note
     SSLContext.wrap_socket(): 3da. to wrap a socket.

     Changed in version 3.7: *note SSLSocket: 3d7. instances must to
     created with *note wrap_socket(): 3da.  In earlier versions, it was
     possible to create instances directly.  This was never documented
     or officially supported.

SSL sockets also have the following additional methods and attributes:

 -- Method: SSLSocket.read (len=1024, buffer=None)

     Read up to `len' bytes of data from the SSL socket and return the
     result as a ‘bytes’ instance.  If `buffer' is specified, then read
     into the buffer instead, and return the number of bytes read.

     Raise *note SSLWantReadError: 74a. or *note SSLWantWriteError: 74b.
     if the socket is *note non-blocking: 25f5. and the read would
     block.

     As at any time a re-negotiation is possible, a call to *note
     read(): 74f. can also cause write operations.

     Changed in version 3.5: The socket timeout is no more reset each
     time bytes are received or sent.  The socket timeout is now to
     maximum total duration to read up to `len' bytes.

     Deprecated since version 3.6: Use ‘recv()’ instead of *note read():
     74f.

 -- Method: SSLSocket.write (buf)

     Write `buf' to the SSL socket and return the number of bytes
     written.  The `buf' argument must be an object supporting the
     buffer interface.

     Raise *note SSLWantReadError: 74a. or *note SSLWantWriteError: 74b.
     if the socket is *note non-blocking: 25f5. and the write would
     block.

     As at any time a re-negotiation is possible, a call to *note
     write(): 750. can also cause read operations.

     Changed in version 3.5: The socket timeout is no more reset each
     time bytes are received or sent.  The socket timeout is now to
     maximum total duration to write `buf'.

     Deprecated since version 3.6: Use ‘send()’ instead of *note
     write(): 750.

     Note: The *note read(): 74f. and *note write(): 750. methods are
     the low-level methods that read and write unencrypted,
     application-level data and decrypt/encrypt it to encrypted,
     wire-level data.  These methods require an active SSL connection,
     i.e.  the handshake was completed and *note SSLSocket.unwrap():
     2633. was not called.

     Normally you should use the socket API methods like *note recv():
     66b. and *note send(): 66e. instead of these methods.

 -- Method: SSLSocket.do_handshake ()

     Perform the SSL setup handshake.

     Changed in version 3.4: The handshake method also performs *note
     match_hostname(): 3d1. when the *note check_hostname: 2609.
     attribute of the socket’s *note context: 2634. is true.

     Changed in version 3.5: The socket timeout is no more reset each
     time bytes are received or sent.  The socket timeout is now to
     maximum total duration of the handshake.

     Changed in version 3.7: Hostname or IP address is matched by
     OpenSSL during handshake.  The function *note match_hostname():
     3d1. is no longer used.  In case OpenSSL refuses a hostname or IP
     address, the handshake is aborted early and a TLS alert message is
     send to the peer.

 -- Method: SSLSocket.getpeercert (binary_form=False)

     If there is no certificate for the peer on the other end of the
     connection, return ‘None’.  If the SSL handshake hasn’t been done
     yet, raise *note ValueError: 1f9.

     If the ‘binary_form’ parameter is *note False: 37d, and a
     certificate was received from the peer, this method returns a *note
     dict: 1b6. instance.  If the certificate was not validated, the
     dict is empty.  If the certificate was validated, it returns a dict
     with several keys, amongst them ‘subject’ (the principal for which
     the certificate was issued) and ‘issuer’ (the principal issuing the
     certificate).  If a certificate contains an instance of the
     `Subject Alternative Name' extension (see RFC 3280(1)), there will
     also be a ‘subjectAltName’ key in the dictionary.

     The ‘subject’ and ‘issuer’ fields are tuples containing the
     sequence of relative distinguished names (RDNs) given in the
     certificate’s data structure for the respective fields, and each
     RDN is a sequence of name-value pairs.  Here is a real-world
     example:

          {'issuer': ((('countryName', 'IL'),),             (('organizationName', 'StartCom Ltd.'),),             (('organizationalUnitName',               'Secure Digital Certificate Signing'),),             (('commonName',               'StartCom Class 2 Primary Intermediate Server CA'),)),  'notAfter': 'Nov 22 08:15:19 2013 GMT',  'notBefore': 'Nov 21 03:09:52 2011 GMT',  'serialNumber': '95F0',  'subject': ((('description', '571208-SLe257oHY9fVQ07Z'),),              (('countryName', 'US'),),              (('stateOrProvinceName', 'California'),),              (('localityName', 'San Francisco'),),              (('organizationName', 'Electronic Frontier Foundation, Inc.'),),              (('commonName', '*.eff.org'),),              (('emailAddress', 'hostmaster@eff.org'),)),  'subjectAltName': (('DNS', '*.eff.org'), ('DNS', 'eff.org')),  'version': 3}

          Note: To validate a certificate for a particular service, you
          can use the *note match_hostname(): 3d1. function.

     If the ‘binary_form’ parameter is *note True: 48f, and a
     certificate was provided, this method returns the DER-encoded form
     of the entire certificate as a sequence of bytes, or *note None:
     157. if the peer did not provide a certificate.  Whether the peer
     provides a certificate depends on the SSL socket’s role:

        * for a client SSL socket, the server will always provide a
          certificate, regardless of whether validation was required;

        * for a server SSL socket, the client will only provide a
          certificate when requested by the server; therefore *note
          getpeercert(): 8c5. will return *note None: 157. if you used
          *note CERT_NONE: 2606. (rather than *note CERT_OPTIONAL: 2608.
          or *note CERT_REQUIRED: 25f1.).

     Changed in version 3.2: The returned dictionary includes additional
     items such as ‘issuer’ and ‘notBefore’.

     Changed in version 3.4: *note ValueError: 1f9. is raised when the
     handshake isn’t done.  The returned dictionary includes additional
     X509v3 extension items such as ‘crlDistributionPoints’, ‘caIssuers’
     and ‘OCSP’ URIs.

     Changed in version 3.8.1: IPv6 address strings no longer have a
     trailing new line.

 -- Method: SSLSocket.cipher ()

     Returns a three-value tuple containing the name of the cipher being
     used, the version of the SSL protocol that defines its use, and the
     number of secret bits being used.  If no connection has been
     established, returns ‘None’.

 -- Method: SSLSocket.shared_ciphers ()

     Return the list of ciphers shared by the client during the
     handshake.  Each entry of the returned list is a three-value tuple
     containing the name of the cipher, the version of the SSL protocol
     that defines its use, and the number of secret bits the cipher
     uses.  *note shared_ciphers(): 74d. returns ‘None’ if no connection
     has been established or the socket is a client socket.

     New in version 3.5.

 -- Method: SSLSocket.compression ()

     Return the compression algorithm being used as a string, or ‘None’
     if the connection isn’t compressed.

     If the higher-level protocol supports its own compression
     mechanism, you can use *note OP_NO_COMPRESSION: a8b. to disable
     SSL-level compression.

     New in version 3.3.

 -- Method: SSLSocket.get_channel_binding (cb_type="tls-unique")

     Get channel binding data for current connection, as a bytes object.
     Returns ‘None’ if not connected or the handshake has not been
     completed.

     The `cb_type' parameter allow selection of the desired channel
     binding type.  Valid channel binding types are listed in the *note
     CHANNEL_BINDING_TYPES: 2625. list.  Currently only the ‘tls-unique’
     channel binding, defined by RFC 5929(2), is supported.  *note
     ValueError: 1f9. will be raised if an unsupported channel binding
     type is requested.

     New in version 3.3.

 -- Method: SSLSocket.selected_alpn_protocol ()

     Return the protocol that was selected during the TLS handshake.  If
     *note SSLContext.set_alpn_protocols(): 745. was not called, if the
     other party does not support ALPN, if this socket does not support
     any of the client’s proposed protocols, or if the handshake has not
     happened yet, ‘None’ is returned.

     New in version 3.5.

 -- Method: SSLSocket.selected_npn_protocol ()

     Return the higher-level protocol that was selected during the
     TLS/SSL handshake.  If *note SSLContext.set_npn_protocols(): a8c.
     was not called, or if the other party does not support NPN, or if
     the handshake has not yet happened, this will return ‘None’.

     New in version 3.3.

 -- Method: SSLSocket.unwrap ()

     Performs the SSL shutdown handshake, which removes the TLS layer
     from the underlying socket, and returns the underlying socket
     object.  This can be used to go from encrypted operation over a
     connection to unencrypted.  The returned socket should always be
     used for further communication with the other side of the
     connection, rather than the original socket.

 -- Method: SSLSocket.verify_client_post_handshake ()

     Requests post-handshake authentication (PHA) from a TLS 1.3 client.
     PHA can only be initiated for a TLS 1.3 connection from a
     server-side socket, after the initial TLS handshake and with PHA
     enabled on both sides, see *note SSLContext.post_handshake_auth:
     222.

     The method does not perform a cert exchange immediately.  The
     server-side sends a CertificateRequest during the next write event
     and expects the client to respond with a certificate on the next
     read event.

     If any precondition isn’t met (e.g.  not TLS 1.3, PHA not enabled),
     an *note SSLError: c02. is raised.

          Note: Only available with OpenSSL 1.1.1 and TLS 1.3 enabled.
          Without TLS 1.3 support, the method raises *note
          NotImplementedError: 603.

     New in version 3.8.

 -- Method: SSLSocket.version ()

     Return the actual SSL protocol version negotiated by the connection
     as a string, or ‘None’ is no secure connection is established.  As
     of this writing, possible return values include ‘"SSLv2"’,
     ‘"SSLv3"’, ‘"TLSv1"’, ‘"TLSv1.1"’ and ‘"TLSv1.2"’.  Recent OpenSSL
     versions may define more return values.

     New in version 3.5.

 -- Method: SSLSocket.pending ()

     Returns the number of already decrypted bytes available for read,
     pending on the connection.

 -- Attribute: SSLSocket.context

     The *note SSLContext: 3d9. object this SSL socket is tied to.  If
     the SSL socket was created using the deprecated *note
     wrap_socket(): 464. function (rather than *note
     SSLContext.wrap_socket(): 3da.), this is a custom context object
     created for this SSL socket.

     New in version 3.2.

 -- Attribute: SSLSocket.server_side

     A boolean which is ‘True’ for server-side sockets and ‘False’ for
     client-side sockets.

     New in version 3.2.

 -- Attribute: SSLSocket.server_hostname

     Hostname of the server: *note str: 325. type, or ‘None’ for
     server-side socket or if the hostname was not specified in the
     constructor.

     New in version 3.2.

     Changed in version 3.7: The attribute is now always ASCII text.
     When ‘server_hostname’ is an internationalized domain name (IDN),
     this attribute now stores the A-label form (‘"xn--pythn-mua.org"’),
     rather than the U-label form (‘"pythön.org"’).

 -- Attribute: SSLSocket.session

     The *note SSLSession: 580. for this SSL connection.  The session is
     available for client and server side sockets after the TLS
     handshake has been performed.  For client sockets the session can
     be set before *note do_handshake(): 74e. has been called to reuse a
     session.

     New in version 3.6.

 -- Attribute: SSLSocket.session_reused

     New in version 3.6.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3280.html

   (2) https://tools.ietf.org/html/rfc5929.html


File: python.info,  Node: SSL Contexts,  Next: Certificates,  Prev: SSL Sockets,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.9 SSL Contexts
.....................

New in version 3.2.

An SSL context holds various data longer-lived than single SSL
connections, such as SSL configuration options, certificate(s) and
private key(s).  It also manages a cache of SSL sessions for server-side
sockets, in order to speed up repeated connections from the same
clients.

 -- Class: ssl.SSLContext (protocol=PROTOCOL_TLS)

     Create a new SSL context.  You may pass `protocol' which must be
     one of the ‘PROTOCOL_*’ constants defined in this module.  The
     parameter specifies which version of the SSL protocol to use.
     Typically, the server chooses a particular protocol version, and
     the client must adapt to the server’s choice.  Most of the versions
     are not interoperable with the other versions.  If not specified,
     the default is *note PROTOCOL_TLS: 25ee.; it provides the most
     compatibility with other versions.

     Here’s a table showing which versions in a client (down the side)
     can connect to which versions in a server (along the top):

          `client' / `server'          `SSLv2'          `SSLv3'          `TLS' (1)         `TLSv1'       `TLSv1.1'       `TLSv1.2'
                                                                                                                         
                                                                                                                         
          `SSLv2'                      yes              no               no (2)            no            no              no
                                                                                                                         
                                                                                                                         
          `SSLv3'                      no               yes              no (3)            no            no              no
                                                                                                                         
                                                                                                                         
          `TLS' (`SSLv23') (4)         no (5)           no (6)           yes               yes           yes             yes
                                                                                                                         
                                                                                                                         
          `TLSv1'                      no               no               yes               yes           no              no
                                                                                                                         
                                                                                                                         
          `TLSv1.1'                    no               no               yes               no            yes             no
                                                                                                                         
                                                                                                                         
          `TLSv1.2'                    no               no               yes               no            no              yes
                                                                                                                         

     See also
     ........

     *note create_default_context(): 8b5. lets the *note ssl: f3. module
     choose security settings for a given purpose.

     Changed in version 3.6: The context is created with secure default
     values.  The options *note OP_NO_COMPRESSION: a8b, *note
     OP_CIPHER_SERVER_PREFERENCE: a90, *note OP_SINGLE_DH_USE: 2617,
     *note OP_SINGLE_ECDH_USE: 2618, *note OP_NO_SSLv2: b93. (except for
     *note PROTOCOL_SSLv2: 260f.), and *note OP_NO_SSLv3: 25ef. (except
     for *note PROTOCOL_SSLv3: 2600.) are set by default.  The initial
     cipher suite list contains only ‘HIGH’ ciphers, no ‘NULL’ ciphers
     and no ‘MD5’ ciphers (except for *note PROTOCOL_SSLv2: 260f.).

*note SSLContext: 3d9. objects have the following methods and
attributes:

 -- Method: SSLContext.cert_store_stats ()

     Get statistics about quantities of loaded X.509 certificates, count
     of X.509 certificates flagged as CA certificates and certificate
     revocation lists as dictionary.

     Example for a context with one CA cert and one other cert:

          >>> context.cert_store_stats() {'crl': 0, 'x509_ca': 1, 'x509': 2}

     New in version 3.4.

 -- Method: SSLContext.load_cert_chain (certfile, keyfile=None,
          password=None)

     Load a private key and the corresponding certificate.  The
     `certfile' string must be the path to a single file in PEM format
     containing the certificate as well as any number of CA certificates
     needed to establish the certificate’s authenticity.  The `keyfile'
     string, if present, must point to a file containing the private key
     in.  Otherwise the private key will be taken from `certfile' as
     well.  See the discussion of *note Certificates: 263b. for more
     information on how the certificate is stored in the `certfile'.

     The `password' argument may be a function to call to get the
     password for decrypting the private key.  It will only be called if
     the private key is encrypted and a password is necessary.  It will
     be called with no arguments, and it should return a string, bytes,
     or bytearray.  If the return value is a string it will be encoded
     as UTF-8 before using it to decrypt the key.  Alternatively a
     string, bytes, or bytearray value may be supplied directly as the
     `password' argument.  It will be ignored if the private key is not
     encrypted and no password is needed.

     If the `password' argument is not specified and a password is
     required, OpenSSL’s built-in password prompting mechanism will be
     used to interactively prompt the user for a password.

     An *note SSLError: c02. is raised if the private key doesn’t match
     with the certificate.

     Changed in version 3.3: New optional argument `password'.

 -- Method: SSLContext.load_default_certs (purpose=Purpose.SERVER_AUTH)

     Load a set of default “certification authority” (CA) certificates
     from default locations.  On Windows it loads CA certs from the ‘CA’
     and ‘ROOT’ system stores.  On other systems it calls *note
     SSLContext.set_default_verify_paths(): 8b7.  In the future the
     method may load CA certificates from other locations, too.

     The `purpose' flag specifies what kind of CA certificates are
     loaded.  The default settings *note Purpose.SERVER_AUTH: 8c0. loads
     certificates, that are flagged and trusted for TLS web server
     authentication (client side sockets).  *note Purpose.CLIENT_AUTH:
     8c1. loads CA certificates for client certificate verification on
     the server side.

     New in version 3.4.

 -- Method: SSLContext.load_verify_locations (cafile=None, capath=None,
          cadata=None)

     Load a set of “certification authority” (CA) certificates used to
     validate other peers’ certificates when *note verify_mode: 25f0. is
     other than *note CERT_NONE: 2606.  At least one of `cafile' or
     `capath' must be specified.

     This method can also load certification revocation lists (CRLs) in
     PEM or DER format.  In order to make use of CRLs, *note
     SSLContext.verify_flags: 8ba. must be configured properly.

     The `cafile' string, if present, is the path to a file of
     concatenated CA certificates in PEM format.  See the discussion of
     *note Certificates: 263b. for more information about how to arrange
     the certificates in this file.

     The `capath' string, if present, is the path to a directory
     containing several CA certificates in PEM format, following an
     OpenSSL specific layout(7).

     The `cadata' object, if present, is either an ASCII string of one
     or more PEM-encoded certificates or a *note bytes-like object: 5dd.
     of DER-encoded certificates.  Like with `capath' extra lines around
     PEM-encoded certificates are ignored but at least one certificate
     must be present.

     Changed in version 3.4: New optional argument `cadata'

 -- Method: SSLContext.get_ca_certs (binary_form=False)

     Get a list of loaded “certification authority” (CA) certificates.
     If the ‘binary_form’ parameter is *note False: 37d. each list entry
     is a dict like the output of *note SSLSocket.getpeercert(): 8c5.
     Otherwise the method returns a list of DER-encoded certificates.
     The returned list does not contain certificates from `capath'
     unless a certificate was requested and loaded by a SSL connection.

          Note: Certificates in a capath directory aren’t loaded unless
          they have been used at least once.

     New in version 3.4.

 -- Method: SSLContext.get_ciphers ()

     Get a list of enabled ciphers.  The list is in order of cipher
     priority.  See *note SSLContext.set_ciphers(): 2604.

     Example:

          >>> ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23) >>> ctx.set_ciphers('ECDHE+AESGCM:!ECDSA') >>> ctx.get_ciphers()  # OpenSSL 1.0.x [{'alg_bits': 256,   'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH     Au=RSA  '                  'Enc=AESGCM(256) Mac=AEAD',   'id': 50380848,   'name': 'ECDHE-RSA-AES256-GCM-SHA384',   'protocol': 'TLSv1/SSLv3',   'strength_bits': 256},  {'alg_bits': 128,   'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH     Au=RSA  '                  'Enc=AESGCM(128) Mac=AEAD',   'id': 50380847,   'name': 'ECDHE-RSA-AES128-GCM-SHA256',   'protocol': 'TLSv1/SSLv3',   'strength_bits': 128}]

     On OpenSSL 1.1 and newer the cipher dict contains additional
     fields:

          >>> ctx.get_ciphers()  # OpenSSL 1.1+ [{'aead': True,   'alg_bits': 256,   'auth': 'auth-rsa',   'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH     Au=RSA  '                  'Enc=AESGCM(256) Mac=AEAD',   'digest': None,   'id': 50380848,   'kea': 'kx-ecdhe',   'name': 'ECDHE-RSA-AES256-GCM-SHA384',   'protocol': 'TLSv1.2',   'strength_bits': 256,   'symmetric': 'aes-256-gcm'},  {'aead': True,   'alg_bits': 128,   'auth': 'auth-rsa',   'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH     Au=RSA  '                  'Enc=AESGCM(128) Mac=AEAD',   'digest': None,   'id': 50380847,   'kea': 'kx-ecdhe',   'name': 'ECDHE-RSA-AES128-GCM-SHA256',   'protocol': 'TLSv1.2',   'strength_bits': 128,   'symmetric': 'aes-128-gcm'}]

     *note Availability: 129a.: OpenSSL 1.0.2+.

     New in version 3.6.

 -- Method: SSLContext.set_default_verify_paths ()

     Load a set of default “certification authority” (CA) certificates
     from a filesystem path defined when building the OpenSSL library.
     Unfortunately, there’s no easy way to know whether this method
     succeeds: no error is returned if no certificates are to be found.
     When the OpenSSL library is provided as part of the operating
     system, though, it is likely to be configured properly.

 -- Method: SSLContext.set_ciphers (ciphers)

     Set the available ciphers for sockets created with this context.
     It should be a string in the OpenSSL cipher list format(8).  If no
     cipher can be selected (because compile-time options or other
     configuration forbids use of all the specified ciphers), an *note
     SSLError: c02. will be raised.

          Note: when connected, the *note SSLSocket.cipher(): 2537.
          method of SSL sockets will give the currently selected cipher.

          OpenSSL 1.1.1 has TLS 1.3 cipher suites enabled by default.
          The suites cannot be disabled with *note set_ciphers(): 2604.

 -- Method: SSLContext.set_alpn_protocols (protocols)

     Specify which protocols the socket should advertise during the
     SSL/TLS handshake.  It should be a list of ASCII strings, like
     ‘['http/1.1', 'spdy/2']’, ordered by preference.  The selection of
     a protocol will happen during the handshake, and will play out
     according to RFC 7301(9).  After a successful handshake, the *note
     SSLSocket.selected_alpn_protocol(): 746. method will return the
     agreed-upon protocol.

     This method will raise *note NotImplementedError: 603. if *note
     HAS_ALPN: 747. is ‘False’.

     OpenSSL 1.1.0 to 1.1.0e will abort the handshake and raise *note
     SSLError: c02. when both sides support ALPN but cannot agree on a
     protocol.  1.1.0f+ behaves like 1.0.2, *note
     SSLSocket.selected_alpn_protocol(): 746. returns None.

     New in version 3.5.

 -- Method: SSLContext.set_npn_protocols (protocols)

     Specify which protocols the socket should advertise during the
     SSL/TLS handshake.  It should be a list of strings, like
     ‘['http/1.1', 'spdy/2']’, ordered by preference.  The selection of
     a protocol will happen during the handshake, and will play out
     according to the Application Layer Protocol Negotiation(10).  After
     a successful handshake, the *note
     SSLSocket.selected_npn_protocol(): 2635. method will return the
     agreed-upon protocol.

     This method will raise *note NotImplementedError: 603. if *note
     HAS_NPN: 261f. is ‘False’.

     New in version 3.3.

 -- Attribute: SSLContext.sni_callback

     Register a callback function that will be called after the TLS
     Client Hello handshake message has been received by the SSL/TLS
     server when the TLS client specifies a server name indication.  The
     server name indication mechanism is specified in RFC 6066(11)
     section 3 - Server Name Indication.

     Only one callback can be set per ‘SSLContext’.  If `sni_callback'
     is set to ‘None’ then the callback is disabled.  Calling this
     function a subsequent time will disable the previously registered
     callback.

     The callback function will be called with three arguments; the
     first being the *note ssl.SSLSocket: 3d7, the second is a string
     that represents the server name that the client is intending to
     communicate (or *note None: 157. if the TLS Client Hello does not
     contain a server name) and the third argument is the original *note
     SSLContext: 3d9.  The server name argument is text.  For
     internationalized domain name, the server name is an IDN A-label
     (‘"xn--pythn-mua.org"’).

     A typical use of this callback is to change the *note
     ssl.SSLSocket: 3d7.’s *note SSLSocket.context: 2634. attribute to a
     new object of type *note SSLContext: 3d9. representing a
     certificate chain that matches the server name.

     Due to the early negotiation phase of the TLS connection, only
     limited methods and attributes are usable like *note
     SSLSocket.selected_alpn_protocol(): 746. and *note
     SSLSocket.context: 2634.  *note SSLSocket.getpeercert(): 8c5, *note
     SSLSocket.getpeercert(): 8c5, *note SSLSocket.cipher(): 2537. and
     ‘SSLSocket.compress()’ methods require that the TLS connection has
     progressed beyond the TLS Client Hello and therefore will not
     contain return meaningful values nor can they be called safely.

     The `sni_callback' function must return ‘None’ to allow the TLS
     negotiation to continue.  If a TLS failure is required, a constant
     *note ALERT_DESCRIPTION_*: 2627. can be returned.  Other return
     values will result in a TLS fatal error with *note
     ALERT_DESCRIPTION_INTERNAL_ERROR: 2627.

     If an exception is raised from the `sni_callback' function the TLS
     connection will terminate with a fatal TLS alert message *note
     ALERT_DESCRIPTION_HANDSHAKE_FAILURE: 2626.

     This method will raise *note NotImplementedError: 603. if the
     OpenSSL library had OPENSSL_NO_TLSEXT defined when it was built.

     New in version 3.7.

 -- Attribute: SSLContext.set_servername_callback (server_name_callback)

     This is a legacy API retained for backwards compatibility.  When
     possible, you should use *note sni_callback: 263c. instead.  The
     given `server_name_callback' is similar to `sni_callback', except
     that when the server hostname is an IDN-encoded internationalized
     domain name, the `server_name_callback' receives a decoded U-label
     (‘"pythön.org"’).

     If there is an decoding error on the server name, the TLS
     connection will terminate with an *note
     ALERT_DESCRIPTION_INTERNAL_ERROR: 2627. fatal TLS alert message to
     the client.

     New in version 3.4.

 -- Method: SSLContext.load_dh_params (dhfile)

     Load the key generation parameters for Diffie-Hellman (DH) key
     exchange.  Using DH key exchange improves forward secrecy at the
     expense of computational resources (both on the server and on the
     client).  The `dhfile' parameter should be the path to a file
     containing DH parameters in PEM format.

     This setting doesn’t apply to client sockets.  You can also use the
     *note OP_SINGLE_DH_USE: 2617. option to further improve security.

     New in version 3.3.

 -- Method: SSLContext.set_ecdh_curve (curve_name)

     Set the curve name for Elliptic Curve-based Diffie-Hellman (ECDH)
     key exchange.  ECDH is significantly faster than regular DH while
     arguably as secure.  The `curve_name' parameter should be a string
     describing a well-known elliptic curve, for example ‘prime256v1’
     for a widely supported curve.

     This setting doesn’t apply to client sockets.  You can also use the
     *note OP_SINGLE_ECDH_USE: 2618. option to further improve security.

     This method is not available if *note HAS_ECDH: 261d. is ‘False’.

     New in version 3.3.

     See also
     ........

     SSL/TLS & Perfect Forward Secrecy(12)

          Vincent Bernat.

 -- Method: SSLContext.wrap_socket (sock, server_side=False,
          do_handshake_on_connect=True, suppress_ragged_eofs=True,
          server_hostname=None, session=None)

     Wrap an existing Python socket `sock' and return an instance of
     *note SSLContext.sslsocket_class: 263d. (default *note SSLSocket:
     3d7.).  The returned SSL socket is tied to the context, its
     settings and certificates.  `sock' must be a *note SOCK_STREAM:
     c7d. socket; other socket types are unsupported.

     The parameter ‘server_side’ is a boolean which identifies whether
     server-side or client-side behavior is desired from this socket.

     For client-side sockets, the context construction is lazy; if the
     underlying socket isn’t connected yet, the context construction
     will be performed after ‘connect()’ is called on the socket.  For
     server-side sockets, if the socket has no remote peer, it is
     assumed to be a listening socket, and the server-side SSL wrapping
     is automatically performed on client connections accepted via the
     ‘accept()’ method.  The method may raise *note SSLError: c02.

     On client connections, the optional parameter `server_hostname'
     specifies the hostname of the service which we are connecting to.
     This allows a single server to host multiple SSL-based services
     with distinct certificates, quite similarly to HTTP virtual hosts.
     Specifying `server_hostname' will raise a *note ValueError: 1f9. if
     `server_side' is true.

     The parameter ‘do_handshake_on_connect’ specifies whether to do the
     SSL handshake automatically after doing a ‘socket.connect()’, or
     whether the application program will call it explicitly, by
     invoking the *note SSLSocket.do_handshake(): 74e. method.  Calling
     *note SSLSocket.do_handshake(): 74e. explicitly gives the program
     control over the blocking behavior of the socket I/O involved in
     the handshake.

     The parameter ‘suppress_ragged_eofs’ specifies how the
     ‘SSLSocket.recv()’ method should signal unexpected EOF from the
     other end of the connection.  If specified as *note True: 48f. (the
     default), it returns a normal EOF (an empty bytes object) in
     response to unexpected EOF errors raised from the underlying
     socket; if *note False: 37d, it will raise the exceptions back to
     the caller.

     `session', see *note session: 2638.

     Changed in version 3.5: Always allow a server_hostname to be
     passed, even if OpenSSL does not have SNI.

     Changed in version 3.6: `session' argument was added.

     Changed in version 3.7: The method returns on instance of *note
     SSLContext.sslsocket_class: 263d. instead of hard-coded *note
     SSLSocket: 3d7.

 -- Attribute: SSLContext.sslsocket_class

     The return type of *note SSLContext.wrap_socket(): 3da, defaults to
     *note SSLSocket: 3d7.  The attribute can be overridden on instance
     of class in order to return a custom subclass of *note SSLSocket:
     3d7.

     New in version 3.7.

 -- Method: SSLContext.wrap_bio (incoming, outgoing, server_side=False,
          server_hostname=None, session=None)

     Wrap the BIO objects `incoming' and `outgoing' and return an
     instance of *note SSLContext.sslobject_class: 263e. (default *note
     SSLObject: 3d8.).  The SSL routines will read input data from the
     incoming BIO and write data to the outgoing BIO.

     The `server_side', `server_hostname' and `session' parameters have
     the same meaning as in *note SSLContext.wrap_socket(): 3da.

     Changed in version 3.6: `session' argument was added.

     Changed in version 3.7: The method returns on instance of *note
     SSLContext.sslobject_class: 263e. instead of hard-coded *note
     SSLObject: 3d8.

 -- Attribute: SSLContext.sslobject_class

     The return type of *note SSLContext.wrap_bio(): 3db, defaults to
     *note SSLObject: 3d8.  The attribute can be overridden on instance
     of class in order to return a custom subclass of *note SSLObject:
     3d8.

     New in version 3.7.

 -- Method: SSLContext.session_stats ()

     Get statistics about the SSL sessions created or managed by this
     context.  A dictionary is returned which maps the names of each
     piece of information(13) to their numeric values.  For example,
     here is the total number of hits and misses in the session cache
     since the context was created:

          >>> stats = context.session_stats() >>> stats['hits'], stats['misses'] (0, 0)

 -- Attribute: SSLContext.check_hostname

     Whether to match the peer cert’s hostname with *note
     match_hostname(): 3d1. in *note SSLSocket.do_handshake(): 74e.  The
     context’s *note verify_mode: 25f0. must be set to *note
     CERT_OPTIONAL: 2608. or *note CERT_REQUIRED: 25f1, and you must
     pass `server_hostname' to *note wrap_socket(): 3da. in order to
     match the hostname.  Enabling hostname checking automatically sets
     *note verify_mode: 25f0. from *note CERT_NONE: 2606. to *note
     CERT_REQUIRED: 25f1.  It cannot be set back to *note CERT_NONE:
     2606. as long as hostname checking is enabled.  The *note
     PROTOCOL_TLS_CLIENT: 2607. protocol enables hostname checking by
     default.  With other protocols, hostname checking must be enabled
     explicitly.

     Example:

          import socket, ssl  context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2) context.verify_mode = ssl.CERT_REQUIRED context.check_hostname = True context.load_default_certs()  s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) ssl_sock = context.wrap_socket(s, server_hostname='www.verisign.com') ssl_sock.connect(('www.verisign.com', 443))

     New in version 3.4.

     Changed in version 3.7: *note verify_mode: 25f0. is now
     automatically changed to *note CERT_REQUIRED: 25f1. when hostname
     checking is enabled and *note verify_mode: 25f0. is *note
     CERT_NONE: 2606.  Previously the same operation would have failed
     with a *note ValueError: 1f9.

          Note: This features requires OpenSSL 0.9.8f or newer.

 -- Attribute: SSLContext.keylog_filename

     Write TLS keys to a keylog file, whenever key material is generated
     or received.  The keylog file is designed for debugging purposes
     only.  The file format is specified by NSS and used by many traffic
     analyzers such as Wireshark.  The log file is opened in append-only
     mode.  Writes are synchronized between threads, but not between
     processes.

     New in version 3.8.

          Note: This features requires OpenSSL 1.1.1 or newer.

 -- Attribute: SSLContext.maximum_version

     A *note TLSVersion: 262a. enum member representing the highest
     supported TLS version.  The value defaults to *note
     TLSVersion.MAXIMUM_SUPPORTED: 262c.  The attribute is read-only for
     protocols other than *note PROTOCOL_TLS: 25ee, *note
     PROTOCOL_TLS_CLIENT: 2607, and *note PROTOCOL_TLS_SERVER: 260d.

     The attributes *note maximum_version: 3dd, *note minimum_version:
     3dc. and *note SSLContext.options: 2603. all affect the supported
     SSL and TLS versions of the context.  The implementation does not
     prevent invalid combination.  For example a context with *note
     OP_NO_TLSv1_2: 2614. in *note options: 2603. and *note
     maximum_version: 3dd. set to *note TLSVersion.TLSv1_2: 2630. will
     not be able to establish a TLS 1.2 connection.

          Note: This attribute is not available unless the ssl module is
          compiled with OpenSSL 1.1.0g or newer.

     New in version 3.7.

 -- Attribute: SSLContext.minimum_version

     Like *note SSLContext.maximum_version: 3dd. except it is the lowest
     supported version or *note TLSVersion.MINIMUM_SUPPORTED: 262b.

          Note: This attribute is not available unless the ssl module is
          compiled with OpenSSL 1.1.0g or newer.

     New in version 3.7.

 -- Attribute: SSLContext.num_tickets

     Control the number of TLS 1.3 session tickets of a
     ‘TLS_PROTOCOL_SERVER’ context.  The setting has no impact on TLS
     1.0 to 1.2 connections.

          Note: This attribute is not available unless the ssl module is
          compiled with OpenSSL 1.1.1 or newer.

     New in version 3.8.

 -- Attribute: SSLContext.options

     An integer representing the set of SSL options enabled on this
     context.  The default value is *note OP_ALL: 2611, but you can
     specify other options such as *note OP_NO_SSLv2: b93. by ORing them
     together.

          Note: With versions of OpenSSL older than 0.9.8m, it is only
          possible to set options, not to clear them.  Attempting to
          clear an option (by resetting the corresponding bits) will
          raise a *note ValueError: 1f9.

     Changed in version 3.6: *note SSLContext.options: 2603. returns
     *note Options: 261a. flags:

          >>> ssl.create_default_context().options  # doctest: +SKIP <Options.OP_ALL|OP_NO_SSLv3|OP_NO_SSLv2|OP_NO_COMPRESSION: 2197947391>

 -- Attribute: SSLContext.post_handshake_auth

     Enable TLS 1.3 post-handshake client authentication.
     Post-handshake auth is disabled by default and a server can only
     request a TLS client certificate during the initial handshake.
     When enabled, a server may request a TLS client certificate at any
     time after the handshake.

     When enabled on client-side sockets, the client signals the server
     that it supports post-handshake authentication.

     When enabled on server-side sockets, *note SSLContext.verify_mode:
     25f0. must be set to *note CERT_OPTIONAL: 2608. or *note
     CERT_REQUIRED: 25f1, too.  The actual client cert exchange is
     delayed until *note SSLSocket.verify_client_post_handshake(): 223.
     is called and some I/O is performed.

          Note: Only available with OpenSSL 1.1.1 and TLS 1.3 enabled.
          Without TLS 1.3 support, the property value is None and can’t
          be modified

     New in version 3.8.

 -- Attribute: SSLContext.protocol

     The protocol version chosen when constructing the context.  This
     attribute is read-only.

 -- Attribute: SSLContext.hostname_checks_common_name

     Whether *note check_hostname: 2609. falls back to verify the cert’s
     subject common name in the absence of a subject alternative name
     extension (default: true).

          Note: Only writeable with OpenSSL 1.1.0 or higher.

     New in version 3.7.

 -- Attribute: SSLContext.verify_flags

     The flags for certificate verification operations.  You can set
     flags like *note VERIFY_CRL_CHECK_LEAF: 8bc. by ORing them
     together.  By default OpenSSL does neither require nor verify
     certificate revocation lists (CRLs).  Available only with openssl
     version 0.9.8+.

     New in version 3.4.

     Changed in version 3.6: *note SSLContext.verify_flags: 8ba. returns
     *note VerifyFlags: 260c. flags:

          >>> ssl.create_default_context().verify_flags  # doctest: +SKIP <VerifyFlags.VERIFY_X509_TRUSTED_FIRST: 32768>

 -- Attribute: SSLContext.verify_mode

     Whether to try to verify other peers’ certificates and how to
     behave if verification fails.  This attribute must be one of *note
     CERT_NONE: 2606, *note CERT_OPTIONAL: 2608. or *note CERT_REQUIRED:
     25f1.

     Changed in version 3.6: *note SSLContext.verify_mode: 25f0. returns
     *note VerifyMode: 260a. enum:

          >>> ssl.create_default_context().verify_mode <VerifyMode.CERT_REQUIRED: 2>

   ---------- Footnotes ----------

   (1) (3) TLS 1.3 protocol will be available with *note PROTOCOL_TLS:
25ee. in OpenSSL >= 1.1.1.  There is no dedicated PROTOCOL constant for
just TLS 1.3.

   (2) (1) *note SSLContext: 3d9. disables SSLv2 with *note OP_NO_SSLv2:
b93. by default.

   (3) (2) *note SSLContext: 3d9. disables SSLv3 with *note OP_NO_SSLv3:
25ef. by default.

   (4) (3) TLS 1.3 protocol will be available with *note PROTOCOL_TLS:
25ee. in OpenSSL >= 1.1.1.  There is no dedicated PROTOCOL constant for
just TLS 1.3.

   (5) (1) *note SSLContext: 3d9. disables SSLv2 with *note OP_NO_SSLv2:
b93. by default.

   (6) (2) *note SSLContext: 3d9. disables SSLv3 with *note OP_NO_SSLv3:
25ef. by default.

   (7) 
https://www.openssl.org/docs/manmaster/man3/SSL_CTX_load_verify_locations.html

   (8) https://www.openssl.org/docs/manmaster/man1/ciphers.html

   (9) https://tools.ietf.org/html/rfc7301.html

   (10) 
https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation

   (11) https://tools.ietf.org/html/rfc6066.html

   (12) 
https://vincent.bernat.im/en/blog/2011-ssl-perfect-forward-secrecy

   (13) 
https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_sess_number.html


File: python.info,  Node: Certificates,  Next: Examples<16>,  Prev: SSL Contexts,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.10 Certificates
......................

Certificates in general are part of a public-key / private-key system.
In this system, each `principal', (which may be a machine, or a person,
or an organization) is assigned a unique two-part encryption key.  One
part of the key is public, and is called the `public key'; the other
part is kept secret, and is called the `private key'.  The two parts are
related, in that if you encrypt a message with one of the parts, you can
decrypt it with the other part, and `only' with the other part.

A certificate contains information about two principals.  It contains
the name of a `subject', and the subject’s public key.  It also contains
a statement by a second principal, the `issuer', that the subject is who
they claim to be, and that this is indeed the subject’s public key.  The
issuer’s statement is signed with the issuer’s private key, which only
the issuer knows.  However, anyone can verify the issuer’s statement by
finding the issuer’s public key, decrypting the statement with it, and
comparing it to the other information in the certificate.  The
certificate also contains information about the time period over which
it is valid.  This is expressed as two fields, called “notBefore” and
“notAfter”.

In the Python use of certificates, a client or server can use a
certificate to prove who they are.  The other side of a network
connection can also be required to produce a certificate, and that
certificate can be validated to the satisfaction of the client or server
that requires such validation.  The connection attempt can be set to
raise an exception if the validation fails.  Validation is done
automatically, by the underlying OpenSSL framework; the application need
not concern itself with its mechanics.  But the application does usually
need to provide sets of certificates to allow this process to take
place.

Python uses files to contain certificates.  They should be formatted as
“PEM” (see RFC 1422(1)), which is a base-64 encoded form wrapped with a
header line and a footer line:

     -----BEGIN CERTIFICATE----- ... (certificate in base64 PEM encoding) ... -----END CERTIFICATE-----

* Menu:

* Certificate chains::
* CA certificates::
* Combined key and certificate::
* Self-signed certificates::

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc1422.html


File: python.info,  Node: Certificate chains,  Next: CA certificates,  Up: Certificates

5.19.3.11 Certificate chains
............................

The Python files which contain certificates can contain a sequence of
certificates, sometimes called a `certificate chain'.  This chain should
start with the specific certificate for the principal who “is” the
client or server, and then the certificate for the issuer of that
certificate, and then the certificate for the issuer of `that'
certificate, and so on up the chain till you get to a certificate which
is `self-signed', that is, a certificate which has the same subject and
issuer, sometimes called a `root certificate'.  The certificates should
just be concatenated together in the certificate file.  For example,
suppose we had a three certificate chain, from our server certificate to
the certificate of the certification authority that signed our server
certificate, to the root certificate of the agency which issued the
certification authority’s certificate:

     -----BEGIN CERTIFICATE----- ... (certificate for your server)... -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- ... (the certificate for the CA)... -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- ... (the root certificate for the CA's issuer)... -----END CERTIFICATE-----


File: python.info,  Node: CA certificates,  Next: Combined key and certificate,  Prev: Certificate chains,  Up: Certificates

5.19.3.12 CA certificates
.........................

If you are going to require validation of the other side of the
connection’s certificate, you need to provide a “CA certs” file, filled
with the certificate chains for each issuer you are willing to trust.
Again, this file just contains these chains concatenated together.  For
validation, Python will use the first chain it finds in the file which
matches.  The platform’s certificates file can be used by calling *note
SSLContext.load_default_certs(): 8bf, this is done automatically with
*note create_default_context(): 8b5.


File: python.info,  Node: Combined key and certificate,  Next: Self-signed certificates,  Prev: CA certificates,  Up: Certificates

5.19.3.13 Combined key and certificate
......................................

Often the private key is stored in the same file as the certificate; in
this case, only the ‘certfile’ parameter to *note
SSLContext.load_cert_chain(): a86. and *note wrap_socket(): 464. needs
to be passed.  If the private key is stored with the certificate, it
should come before the first certificate in the certificate chain:

     -----BEGIN RSA PRIVATE KEY----- ... (private key in base64 encoding) ... -----END RSA PRIVATE KEY----- -----BEGIN CERTIFICATE----- ... (certificate in base64 PEM encoding) ... -----END CERTIFICATE-----


File: python.info,  Node: Self-signed certificates,  Prev: Combined key and certificate,  Up: Certificates

5.19.3.14 Self-signed certificates
..................................

If you are going to create a server that provides SSL-encrypted
connection services, you will need to acquire a certificate for that
service.  There are many ways of acquiring appropriate certificates,
such as buying one from a certification authority.  Another common
practice is to generate a self-signed certificate.  The simplest way to
do this is with the OpenSSL package, using something like the following:

     % openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem Generating a 1024 bit RSA private key .......++++++ .............................++++++ writing new private key to 'cert.pem' ----- You are about to be asked to enter information that will be incorporated into your certificate request. What you are about to enter is what is called a Distinguished Name or a DN. There are quite a few fields but you can leave some blank For some fields there will be a default value, If you enter '.', the field will be left blank. ----- Country Name (2 letter code) [AU]:US State or Province Name (full name) [Some-State]:MyState Locality Name (eg, city) []:Some City Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc. Organizational Unit Name (eg, section) []:My Group Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com Email Address []:ops@myserver.mygroup.myorganization.com %

The disadvantage of a self-signed certificate is that it is its own root
certificate, and no one else will have it in their cache of known (and
trusted) root certificates.


File: python.info,  Node: Examples<16>,  Next: Notes on non-blocking sockets,  Prev: Certificates,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.15 Examples
..................

* Menu:

* Testing for SSL support::
* Client-side operation::
* Server-side operation::


File: python.info,  Node: Testing for SSL support,  Next: Client-side operation,  Up: Examples<16>

5.19.3.16 Testing for SSL support
.................................

To test for the presence of SSL support in a Python installation, user
code should use the following idiom:

     try:     import ssl except ImportError:     pass else:     ...  # do something that requires SSL support


File: python.info,  Node: Client-side operation,  Next: Server-side operation,  Prev: Testing for SSL support,  Up: Examples<16>

5.19.3.17 Client-side operation
...............................

This example creates a SSL context with the recommended security
settings for client sockets, including automatic certificate
verification:

     >>> context = ssl.create_default_context()

If you prefer to tune security settings yourself, you might create a
context from scratch (but beware that you might not get the settings
right):

     >>> context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) >>> context.load_verify_locations("/etc/ssl/certs/ca-bundle.crt")

(this snippet assumes your operating system places a bundle of all CA
certificates in ‘/etc/ssl/certs/ca-bundle.crt’; if not, you’ll get an
error and have to adjust the location)

The *note PROTOCOL_TLS_CLIENT: 2607. protocol configures the context for
cert validation and hostname verification.  *note verify_mode: 25f0. is
set to *note CERT_REQUIRED: 25f1. and *note check_hostname: 2609. is set
to ‘True’.  All other protocols create SSL contexts with insecure
defaults.

When you use the context to connect to a server, *note CERT_REQUIRED:
25f1. and *note check_hostname: 2609. validate the server certificate:
it ensures that the server certificate was signed with one of the CA
certificates, checks the signature for correctness, and verifies other
properties like validity and identity of the hostname:

     >>> conn = context.wrap_socket(socket.socket(socket.AF_INET), ...                            server_hostname="www.python.org") >>> conn.connect(("www.python.org", 443))

You may then fetch the certificate:

     >>> cert = conn.getpeercert()

Visual inspection shows that the certificate does identify the desired
service (that is, the HTTPS host ‘www.python.org’):

     >>> pprint.pprint(cert) {'OCSP': ('http://ocsp.digicert.com',),  'caIssuers': ('http://cacerts.digicert.com/DigiCertSHA2ExtendedValidationServerCA.crt',),  'crlDistributionPoints': ('http://crl3.digicert.com/sha2-ev-server-g1.crl',                            'http://crl4.digicert.com/sha2-ev-server-g1.crl'),  'issuer': ((('countryName', 'US'),),             (('organizationName', 'DigiCert Inc'),),             (('organizationalUnitName', 'www.digicert.com'),),             (('commonName', 'DigiCert SHA2 Extended Validation Server CA'),)),  'notAfter': 'Sep  9 12:00:00 2016 GMT',  'notBefore': 'Sep  5 00:00:00 2014 GMT',  'serialNumber': '01BB6F00122B177F36CAB49CEA8B6B26',  'subject': ((('businessCategory', 'Private Organization'),),              (('1.3.6.1.4.1.311.60.2.1.3', 'US'),),              (('1.3.6.1.4.1.311.60.2.1.2', 'Delaware'),),              (('serialNumber', '3359300'),),              (('streetAddress', '16 Allen Rd'),),              (('postalCode', '03894-4801'),),              (('countryName', 'US'),),              (('stateOrProvinceName', 'NH'),),              (('localityName', 'Wolfeboro,'),),              (('organizationName', 'Python Software Foundation'),),              (('commonName', 'www.python.org'),)),  'subjectAltName': (('DNS', 'www.python.org'),                     ('DNS', 'python.org'),                     ('DNS', 'pypi.org'),                     ('DNS', 'docs.python.org'),                     ('DNS', 'testpypi.org'),                     ('DNS', 'bugs.python.org'),                     ('DNS', 'wiki.python.org'),                     ('DNS', 'hg.python.org'),                     ('DNS', 'mail.python.org'),                     ('DNS', 'packaging.python.org'),                     ('DNS', 'pythonhosted.org'),                     ('DNS', 'www.pythonhosted.org'),                     ('DNS', 'test.pythonhosted.org'),                     ('DNS', 'us.pycon.org'),                     ('DNS', 'id.python.org')),  'version': 3}

Now the SSL channel is established and the certificate verified, you can
proceed to talk with the server:

     >>> conn.sendall(b"HEAD / HTTP/1.0\r\nHost: linuxfr.org\r\n\r\n") >>> pprint.pprint(conn.recv(1024).split(b"\r\n")) [b'HTTP/1.1 200 OK',  b'Date: Sat, 18 Oct 2014 18:27:20 GMT',  b'Server: nginx',  b'Content-Type: text/html; charset=utf-8',  b'X-Frame-Options: SAMEORIGIN',  b'Content-Length: 45679',  b'Accept-Ranges: bytes',  b'Via: 1.1 varnish',  b'Age: 2188',  b'X-Served-By: cache-lcy1134-LCY',  b'X-Cache: HIT',  b'X-Cache-Hits: 11',  b'Vary: Cookie',  b'Strict-Transport-Security: max-age=63072000; includeSubDomains',  b'Connection: close',  b'',  b'']

See the discussion of *note Security considerations: 24f0. below.


File: python.info,  Node: Server-side operation,  Prev: Client-side operation,  Up: Examples<16>

5.19.3.18 Server-side operation
...............................

For server operation, typically you’ll need to have a server
certificate, and private key, each in a file.  You’ll first create a
context holding the key and the certificate, so that clients can check
your authenticity.  Then you’ll open a socket, bind it to a port, call
‘listen()’ on it, and start waiting for clients to connect:

     import socket, ssl  context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) context.load_cert_chain(certfile="mycertfile", keyfile="mykeyfile")  bindsocket = socket.socket() bindsocket.bind(('myaddr.mydomain.com', 10023)) bindsocket.listen(5)

When a client connects, you’ll call ‘accept()’ on the socket to get the
new socket from the other end, and use the context’s *note
SSLContext.wrap_socket(): 3da. method to create a server-side SSL socket
for the connection:

     while True:     newsocket, fromaddr = bindsocket.accept()     connstream = context.wrap_socket(newsocket, server_side=True)     try:         deal_with_client(connstream)     finally:         connstream.shutdown(socket.SHUT_RDWR)         connstream.close()

Then you’ll read data from the ‘connstream’ and do something with it
till you are finished with the client (or the client is finished with
you):

     def deal_with_client(connstream):     data = connstream.recv(1024)     # empty data means the client is finished with us     while data:         if not do_something(connstream, data):             # we'll assume do_something returns False             # when we're finished with client             break         data = connstream.recv(1024)     # finished with client

And go back to listening for new client connections (of course, a real
server would probably handle each client connection in a separate
thread, or put the sockets in *note non-blocking mode: 25f5. and use an
event loop).


File: python.info,  Node: Notes on non-blocking sockets,  Next: Memory BIO Support<2>,  Prev: Examples<16>,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.19 Notes on non-blocking sockets
.......................................

SSL sockets behave slightly different than regular sockets in
non-blocking mode.  When working with non-blocking sockets, there are
thus several things you need to be aware of:

   - Most *note SSLSocket: 3d7. methods will raise either *note
     SSLWantWriteError: 74b. or *note SSLWantReadError: 74a. instead of
     *note BlockingIOError: 98b. if an I/O operation would block.  *note
     SSLWantReadError: 74a. will be raised if a read operation on the
     underlying socket is necessary, and *note SSLWantWriteError: 74b.
     for a write operation on the underlying socket.  Note that attempts
     to `write' to an SSL socket may require `reading' from the
     underlying socket first, and attempts to `read' from the SSL socket
     may require a prior `write' to the underlying socket.

     Changed in version 3.5: In earlier Python versions, the
     ‘SSLSocket.send()’ method returned zero instead of raising *note
     SSLWantWriteError: 74b. or *note SSLWantReadError: 74a.

   - Calling *note select(): 667. tells you that the OS-level socket can
     be read from (or written to), but it does not imply that there is
     sufficient data at the upper SSL layer.  For example, only part of
     an SSL frame might have arrived.  Therefore, you must be ready to
     handle ‘SSLSocket.recv()’ and ‘SSLSocket.send()’ failures, and
     retry after another call to *note select(): 667.

   - Conversely, since the SSL layer has its own framing, a SSL socket
     may still have data available for reading without *note select():
     667. being aware of it.  Therefore, you should first call
     ‘SSLSocket.recv()’ to drain any potentially available data, and
     then only block on a *note select(): 667. call if still necessary.

     (of course, similar provisions apply when using other primitives
     such as *note poll(): 264c, or those in the *note selectors: e6.
     module)

   - The SSL handshake itself will be non-blocking: the *note
     SSLSocket.do_handshake(): 74e. method has to be retried until it
     returns successfully.  Here is a synopsis using *note select():
     667. to wait for the socket’s readiness:

          while True:     try:         sock.do_handshake()         break     except ssl.SSLWantReadError:         select.select([sock], [], [])     except ssl.SSLWantWriteError:         select.select([], [sock], [])

See also
........

The *note asyncio: a. module supports *note non-blocking SSL sockets:
25f5. and provides a higher level API. It polls for events using the
*note selectors: e6. module and handles *note SSLWantWriteError: 74b,
*note SSLWantReadError: 74a. and *note BlockingIOError: 98b. exceptions.
It runs the SSL handshake asynchronously as well.


File: python.info,  Node: Memory BIO Support<2>,  Next: SSL session,  Prev: Notes on non-blocking sockets,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.20 Memory BIO Support
............................

New in version 3.5.

Ever since the SSL module was introduced in Python 2.6, the *note
SSLSocket: 3d7. class has provided two related but distinct areas of
functionality:

   - SSL protocol handling

   - Network IO

The network IO API is identical to that provided by *note socket.socket:
668, from which *note SSLSocket: 3d7. also inherits.  This allows an SSL
socket to be used as a drop-in replacement for a regular socket, making
it very easy to add SSL support to an existing application.

Combining SSL protocol handling and network IO usually works well, but
there are some cases where it doesn’t.  An example is async IO
frameworks that want to use a different IO multiplexing model than the
“select/poll on a file descriptor” (readiness based) model that is
assumed by *note socket.socket: 668. and by the internal OpenSSL socket
IO routines.  This is mostly relevant for platforms like Windows where
this model is not efficient.  For this purpose, a reduced scope variant
of *note SSLSocket: 3d7. called *note SSLObject: 3d8. is provided.

 -- Class: ssl.SSLObject

     A reduced-scope variant of *note SSLSocket: 3d7. representing an
     SSL protocol instance that does not contain any network IO methods.
     This class is typically used by framework authors that want to
     implement asynchronous IO for SSL through memory buffers.

     This class implements an interface on top of a low-level SSL object
     as implemented by OpenSSL. This object captures the state of an SSL
     connection but does not provide any network IO itself.  IO needs to
     be performed through separate “BIO” objects which are OpenSSL’s IO
     abstraction layer.

     This class has no public constructor.  An *note SSLObject: 3d8.
     instance must be created using the *note wrap_bio(): 3db. method.
     This method will create the *note SSLObject: 3d8. instance and bind
     it to a pair of BIOs.  The `incoming' BIO is used to pass data from
     Python to the SSL protocol instance, while the `outgoing' BIO is
     used to pass data the other way around.

     The following methods are available:

        - *note context: 2634.

        - *note server_side: 2637.

        - *note server_hostname: 3d5.

        - *note session: 2638.

        - *note session_reused: 2639.

        - *note read(): 74f.

        - *note write(): 750.

        - *note getpeercert(): 8c5.

        - *note selected_npn_protocol(): 2635.

        - *note cipher(): 2537.

        - *note shared_ciphers(): 74d.

        - *note compression(): a8a.

        - *note pending(): 2636.

        - *note do_handshake(): 74e.

        - *note unwrap(): 2633.

        - *note get_channel_binding(): a89.

     When compared to *note SSLSocket: 3d7, this object lacks the
     following features:

        - Any form of network IO; ‘recv()’ and ‘send()’ read and write
          only to the underlying *note MemoryBIO: 743. buffers.

        - There is no `do_handshake_on_connect' machinery.  You must
          always manually call *note do_handshake(): 74e. to start the
          handshake.

        - There is no handling of `suppress_ragged_eofs'.  All
          end-of-file conditions that are in violation of the protocol
          are reported via the *note SSLEOFError: 25f7. exception.

        - The method *note unwrap(): 2633. call does not return
          anything, unlike for an SSL socket where it returns the
          underlying socket.

        - The `server_name_callback' callback passed to *note
          SSLContext.set_servername_callback(): 8c4. will get an *note
          SSLObject: 3d8. instance instead of a *note SSLSocket: 3d7.
          instance as its first parameter.

     Some notes related to the use of *note SSLObject: 3d8.:

        - All IO on an *note SSLObject: 3d8. is *note non-blocking:
          25f5.  This means that for example *note read(): 74f. will
          raise an *note SSLWantReadError: 74a. if it needs more data
          than the incoming BIO has available.

        - There is no module-level ‘wrap_bio()’ call like there is for
          *note wrap_socket(): 3da.  An *note SSLObject: 3d8. is always
          created via an *note SSLContext: 3d9.

     Changed in version 3.7: *note SSLObject: 3d8. instances must to
     created with *note wrap_bio(): 3db.  In earlier versions, it was
     possible to create instances directly.  This was never documented
     or officially supported.

An SSLObject communicates with the outside world using memory buffers.
The class *note MemoryBIO: 743. provides a memory buffer that can be
used for this purpose.  It wraps an OpenSSL memory BIO (Basic IO)
object:

 -- Class: ssl.MemoryBIO

     A memory buffer that can be used to pass data between Python and an
     SSL protocol instance.

      -- Attribute: pending

          Return the number of bytes currently in the memory buffer.

      -- Attribute: eof

          A boolean indicating whether the memory BIO is current at the
          end-of-file position.

      -- Method: read (n=-1)

          Read up to `n' bytes from the memory buffer.  If `n' is not
          specified or negative, all bytes are returned.

      -- Method: write (buf)

          Write the bytes from `buf' to the memory BIO. The `buf'
          argument must be an object supporting the buffer protocol.

          The return value is the number of bytes written, which is
          always equal to the length of `buf'.

      -- Method: write_eof ()

          Write an EOF marker to the memory BIO. After this method has
          been called, it is illegal to call *note write(): 2651.  The
          attribute *note eof: 264f. will become true after all data
          currently in the buffer has been read.


File: python.info,  Node: SSL session,  Next: Security considerations,  Prev: Memory BIO Support<2>,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.21 SSL session
.....................

New in version 3.6.

 -- Class: ssl.SSLSession

     Session object used by *note session: 2638.

      -- Attribute: id

      -- Attribute: time

      -- Attribute: timeout

      -- Attribute: ticket_lifetime_hint

      -- Attribute: has_ticket


File: python.info,  Node: Security considerations,  Next: TLS 1 3,  Prev: SSL session,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.22 Security considerations
.................................

* Menu:

* Best defaults::
* Manual settings::
* Multi-processing::


File: python.info,  Node: Best defaults,  Next: Manual settings,  Up: Security considerations

5.19.3.23 Best defaults
.......................

For `client use', if you don’t have any special requirements for your
security policy, it is highly recommended that you use the *note
create_default_context(): 8b5. function to create your SSL context.  It
will load the system’s trusted CA certificates, enable certificate
validation and hostname checking, and try to choose reasonably secure
protocol and cipher settings.

For example, here is how you would use the *note smtplib.SMTP: a76.
class to create a trusted, secure connection to a SMTP server:

     >>> import ssl, smtplib >>> smtp = smtplib.SMTP("mail.python.org", port=587) >>> context = ssl.create_default_context() >>> smtp.starttls(context=context) (220, b'2.0.0 Ready to start TLS')

If a client certificate is needed for the connection, it can be added
with *note SSLContext.load_cert_chain(): a86.

By contrast, if you create the SSL context by calling the *note
SSLContext: 3d9. constructor yourself, it will not have certificate
validation nor hostname checking enabled by default.  If you do so,
please read the paragraphs below to achieve a good security level.


File: python.info,  Node: Manual settings,  Next: Multi-processing,  Prev: Best defaults,  Up: Security considerations

5.19.3.24 Manual settings
.........................

* Menu:

* Verifying certificates::
* Protocol versions::
* Cipher selection::


File: python.info,  Node: Verifying certificates,  Next: Protocol versions,  Up: Manual settings

5.19.3.25 Verifying certificates
................................

When calling the *note SSLContext: 3d9. constructor directly, *note
CERT_NONE: 2606. is the default.  Since it does not authenticate the
other peer, it can be insecure, especially in client mode where most of
time you would like to ensure the authenticity of the server you’re
talking to.  Therefore, when in client mode, it is highly recommended to
use *note CERT_REQUIRED: 25f1.  However, it is in itself not sufficient;
you also have to check that the server certificate, which can be
obtained by calling *note SSLSocket.getpeercert(): 8c5, matches the
desired service.  For many protocols and applications, the service can
be identified by the hostname; in this case, the *note match_hostname():
3d1. function can be used.  This common check is automatically performed
when *note SSLContext.check_hostname: 2609. is enabled.

Changed in version 3.7: Hostname matchings is now performed by OpenSSL.
Python no longer uses *note match_hostname(): 3d1.

In server mode, if you want to authenticate your clients using the SSL
layer (rather than using a higher-level authentication mechanism),
you’ll also have to specify *note CERT_REQUIRED: 25f1. and similarly
check the client certificate.


File: python.info,  Node: Protocol versions,  Next: Cipher selection,  Prev: Verifying certificates,  Up: Manual settings

5.19.3.26 Protocol versions
...........................

SSL versions 2 and 3 are considered insecure and are therefore dangerous
to use.  If you want maximum compatibility between clients and servers,
it is recommended to use *note PROTOCOL_TLS_CLIENT: 2607. or *note
PROTOCOL_TLS_SERVER: 260d. as the protocol version.  SSLv2 and SSLv3 are
disabled by default.

     >>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) >>> client_context.options |= ssl.OP_NO_TLSv1 >>> client_context.options |= ssl.OP_NO_TLSv1_1

The SSL context created above will only allow TLSv1.2 and later (if
supported by your system) connections to a server.  *note
PROTOCOL_TLS_CLIENT: 2607. implies certificate validation and hostname
checks by default.  You have to load certificates into the context.


File: python.info,  Node: Cipher selection,  Prev: Protocol versions,  Up: Manual settings

5.19.3.27 Cipher selection
..........................

If you have advanced security requirements, fine-tuning of the ciphers
enabled when negotiating a SSL session is possible through the *note
SSLContext.set_ciphers(): 2604. method.  Starting from Python 3.2.3, the
ssl module disables certain weak ciphers by default, but you may want to
further restrict the cipher choice.  Be sure to read OpenSSL’s
documentation about the cipher list format(1).  If you want to check
which ciphers are enabled by a given cipher list, use *note
SSLContext.get_ciphers(): 581. or the ‘openssl ciphers’ command on your
system.

   ---------- Footnotes ----------

   (1) 
https://www.openssl.org/docs/manmaster/man1/ciphers.html#CIPHER-LIST-FORMAT


File: python.info,  Node: Multi-processing,  Prev: Manual settings,  Up: Security considerations

5.19.3.28 Multi-processing
..........................

If using this module as part of a multi-processed application (using,
for example the *note multiprocessing: b7. or *note concurrent.futures:
22. modules), be aware that OpenSSL’s internal random number generator
does not properly handle forked processes.  Applications must change the
PRNG state of the parent process if they use any SSL feature with *note
os.fork(): 955.  Any successful call of *note RAND_add(): 25fd, *note
RAND_bytes(): a84. or *note RAND_pseudo_bytes(): a85. is sufficient.


File: python.info,  Node: TLS 1 3,  Next: LibreSSL support,  Prev: Security considerations,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.29 TLS 1.3
.................

New in version 3.7.

Python has provisional and experimental support for TLS 1.3 with OpenSSL
1.1.1.  The new protocol behaves slightly differently than previous
version of TLS/SSL. Some new TLS 1.3 features are not yet available.

   - TLS 1.3 uses a disjunct set of cipher suites.  All AES-GCM and
     ChaCha20 cipher suites are enabled by default.  The method *note
     SSLContext.set_ciphers(): 2604. cannot enable or disable any TLS
     1.3 ciphers yet, but *note SSLContext.get_ciphers(): 581. returns
     them.

   - Session tickets are no longer sent as part of the initial handshake
     and are handled differently.  *note SSLSocket.session: 2638. and
     *note SSLSession: 580. are not compatible with TLS 1.3.

   - Client-side certificates are also no longer verified during the
     initial handshake.  A server can request a certificate at any time.
     Clients process certificate requests while they send or receive
     application data from the server.

   - TLS 1.3 features like early data, deferred TLS client cert request,
     signature algorithm configuration, and rekeying are not supported
     yet.


File: python.info,  Node: LibreSSL support,  Prev: TLS 1 3,  Up: ssl — TLS/SSL wrapper for socket objects

5.19.3.30 LibreSSL support
..........................

LibreSSL is a fork of OpenSSL 1.0.1.  The ssl module has limited support
for LibreSSL. Some features are not available when the ssl module is
compiled with LibreSSL.

   * LibreSSL >= 2.6.1 no longer supports NPN. The methods *note
     SSLContext.set_npn_protocols(): a8c. and *note
     SSLSocket.selected_npn_protocol(): 2635. are not available.

   * *note SSLContext.set_default_verify_paths(): 8b7. ignores the env
     vars ‘SSL_CERT_FILE’ and ‘SSL_CERT_PATH’ although *note
     get_default_verify_paths(): 8b6. still reports them.

See also
........

Class *note socket.socket: 668.

     Documentation of underlying *note socket: ef. class

SSL/TLS Strong Encryption: An Introduction(1)

     Intro from the Apache HTTP Server documentation

RFC 1422: Privacy Enhancement for Internet Electronic Mail: Part II: Certificate-Based Key Management(2)

     Steve Kent

RFC 4086: Randomness Requirements for Security(3)

     Donald E., Jeffrey I. Schiller

RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile(4)

     D. Cooper

RFC 5246: The Transport Layer Security (TLS) Protocol Version 1.2(5)

     T. Dierks et.  al.

RFC 6066: Transport Layer Security (TLS) Extensions(6)

     D. Eastlake

IANA TLS: Transport Layer Security (TLS) Parameters(7)

     IANA

RFC 7525: Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)(8)

     IETF

Mozilla’s Server Side TLS recommendations(9)

     Mozilla

   ---------- Footnotes ----------

   (1) https://httpd.apache.org/docs/trunk/en/ssl/ssl_intro.html

   (2) https://tools.ietf.org/html/rfc1422.html

   (3) https://tools.ietf.org/html/rfc4086.html

   (4) https://tools.ietf.org/html/rfc5280.html

   (5) https://tools.ietf.org/html/rfc5246.html

   (6) https://tools.ietf.org/html/rfc6066.html

   (7) 
https://www.iana.org/assignments/tls-parameters/tls-parameters.xml

   (8) https://tools.ietf.org/html/rfc7525.html

   (9) https://wiki.mozilla.org/Security/Server_Side_TLS


File: python.info,  Node: select — Waiting for I/O completion,  Next: selectors — High-level I/O multiplexing,  Prev: ssl — TLS/SSL wrapper for socket objects,  Up: Networking and Interprocess Communication

5.19.4 ‘select’ — Waiting for I/O completion
--------------------------------------------

__________________________________________________________________

This module provides access to the ‘select()’ and ‘poll()’ functions
available in most operating systems, ‘devpoll()’ available on Solaris
and derivatives, ‘epoll()’ available on Linux 2.5+ and ‘kqueue()’
available on most BSD. Note that on Windows, it only works for sockets;
on other operating systems, it also works for other file types (in
particular, on Unix, it works on pipes).  It cannot be used on regular
files to determine whether a file has grown since it was last read.

     Note: The *note selectors: e6. module allows high-level and
     efficient I/O multiplexing, built upon the *note select: e5. module
     primitives.  Users are encouraged to use the *note selectors: e6.
     module instead, unless they want precise control over the OS-level
     primitives used.

The module defines the following:

 -- Exception: select.error

     A deprecated alias of *note OSError: 1d1.

     Changed in version 3.3: Following PEP 3151(1), this class was made
     an alias of *note OSError: 1d1.

 -- Function: select.devpoll ()

     (Only supported on Solaris and derivatives.)  Returns a ‘/dev/poll’
     polling object; see section *note /dev/poll Polling Objects: 2665.
     below for the methods supported by devpoll objects.

     ‘devpoll()’ objects are linked to the number of file descriptors
     allowed at the time of instantiation.  If your program reduces this
     value, ‘devpoll()’ will fail.  If your program increases this
     value, ‘devpoll()’ may return an incomplete list of active file
     descriptors.

     The new file descriptor is *note non-inheritable: 7ee.

     New in version 3.3.

     Changed in version 3.4: The new file descriptor is now
     non-inheritable.

 -- Function: select.epoll (sizehint=-1, flags=0)

     (Only supported on Linux 2.5.44 and newer.)  Return an edge polling
     object, which can be used as Edge or Level Triggered interface for
     I/O events.

     `sizehint' informs epoll about the expected number of events to be
     registered.  It must be positive, or ‘-1’ to use the default.  It
     is only used on older systems where ‘epoll_create1()’ is not
     available; otherwise it has no effect (though its value is still
     checked).

     `flags' is deprecated and completely ignored.  However, when
     supplied, its value must be ‘0’ or ‘select.EPOLL_CLOEXEC’,
     otherwise ‘OSError’ is raised.

     See the *note Edge and Level Trigger Polling (epoll) Objects: 2666.
     section below for the methods supported by epolling objects.

     ‘epoll’ objects support the context management protocol: when used
     in a *note with: 6dd. statement, the new file descriptor is
     automatically closed at the end of the block.

     The new file descriptor is *note non-inheritable: 7ee.

     Changed in version 3.3: Added the `flags' parameter.

     Changed in version 3.4: Support for the *note with: 6dd. statement
     was added.  The new file descriptor is now non-inheritable.

     Deprecated since version 3.4: The `flags' parameter.
     ‘select.EPOLL_CLOEXEC’ is used by default now.  Use *note
     os.set_inheritable(): 7f0. to make the file descriptor inheritable.

 -- Function: select.poll ()

     (Not supported by all operating systems.)  Returns a polling
     object, which supports registering and unregistering file
     descriptors, and then polling them for I/O events; see section
     *note Polling Objects: 2667. below for the methods supported by
     polling objects.

 -- Function: select.kqueue ()

     (Only supported on BSD.) Returns a kernel queue object; see section
     *note Kqueue Objects: 2669. below for the methods supported by
     kqueue objects.

     The new file descriptor is *note non-inheritable: 7ee.

     Changed in version 3.4: The new file descriptor is now
     non-inheritable.

 -- Function: select.kevent (ident, filter=KQ_FILTER_READ,
          flags=KQ_EV_ADD, fflags=0, data=0, udata=0)

     (Only supported on BSD.) Returns a kernel event object; see section
     *note Kevent Objects: 266b. below for the methods supported by
     kevent objects.

 -- Function: select.select (rlist, wlist, xlist[, timeout])

     This is a straightforward interface to the Unix ‘select()’ system
     call.  The first three arguments are sequences of ‘waitable
     objects’: either integers representing file descriptors or objects
     with a parameterless method named *note fileno(): 1e46. returning
     such an integer:

        * `rlist': wait until ready for reading

        * `wlist': wait until ready for writing

        * `xlist': wait for an “exceptional condition” (see the manual
          page for what your system considers such a condition)

     Empty sequences are allowed, but acceptance of three empty
     sequences is platform-dependent.  (It is known to work on Unix but
     not on Windows.)  The optional `timeout' argument specifies a
     time-out as a floating point number in seconds.  When the `timeout'
     argument is omitted the function blocks until at least one file
     descriptor is ready.  A time-out value of zero specifies a poll and
     never blocks.

     The return value is a triple of lists of objects that are ready:
     subsets of the first three arguments.  When the time-out is reached
     without a file descriptor becoming ready, three empty lists are
     returned.

     Among the acceptable object types in the sequences are Python *note
     file objects: b35. (e.g.  ‘sys.stdin’, or objects returned by *note
     open(): 4e5. or *note os.popen(): 2a7.), socket objects returned by
     *note socket.socket(): 668.  You may also define a `wrapper' class
     yourself, as long as it has an appropriate *note fileno(): 1e46.
     method (that really returns a file descriptor, not just a random
     integer).

          Note: 
          File objects on Windows are not acceptable, but sockets are.
          On Windows, the underlying ‘select()’ function is provided by
          the WinSock library, and does not handle file descriptors that
          don’t originate from WinSock.

     Changed in version 3.5: The function is now retried with a
     recomputed timeout when interrupted by a signal, except if the
     signal handler raises an exception (see PEP 475(2) for the
     rationale), instead of raising *note InterruptedError: 64d.

 -- Attribute: select.PIPE_BUF

     The minimum number of bytes which can be written without blocking
     to a pipe when the pipe has been reported as ready for writing by
     *note select(): 667, *note poll(): 264c. or another interface in
     this module.  This doesn’t apply to other kind of file-like objects
     such as sockets.

     This value is guaranteed by POSIX to be at least 512.

     *note Availability: 129a.: Unix

     New in version 3.2.

* Menu:

* /dev/poll Polling Objects::
* Edge and Level Trigger Polling (epoll) Objects: Edge and Level Trigger Polling epoll Objects.
* Polling Objects::
* Kqueue Objects::
* Kevent Objects::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3151

   (2) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: /dev/poll Polling Objects,  Next: Edge and Level Trigger Polling epoll Objects,  Up: select — Waiting for I/O completion

5.19.4.1 ‘/dev/poll’ Polling Objects
....................................

Solaris and derivatives have ‘/dev/poll’.  While ‘select()’ is O(highest
file descriptor) and ‘poll()’ is O(number of file descriptors),
‘/dev/poll’ is O(active file descriptors).

‘/dev/poll’ behaviour is very close to the standard ‘poll()’ object.

 -- Method: devpoll.close ()

     Close the file descriptor of the polling object.

     New in version 3.4.

 -- Attribute: devpoll.closed

     ‘True’ if the polling object is closed.

     New in version 3.4.

 -- Method: devpoll.fileno ()

     Return the file descriptor number of the polling object.

     New in version 3.4.

 -- Method: devpoll.register (fd[, eventmask])

     Register a file descriptor with the polling object.  Future calls
     to the *note poll(): 264c. method will then check whether the file
     descriptor has any pending I/O events.  `fd' can be either an
     integer, or an object with a *note fileno(): 1e46. method that
     returns an integer.  File objects implement ‘fileno()’, so they can
     also be used as the argument.

     `eventmask' is an optional bitmask describing the type of events
     you want to check for.  The constants are the same that with
     ‘poll()’ object.  The default value is a combination of the
     constants ‘POLLIN’, ‘POLLPRI’, and ‘POLLOUT’.

          Warning: Registering a file descriptor that’s already
          registered is not an error, but the result is undefined.  The
          appropriate action is to unregister or modify it first.  This
          is an important difference compared with ‘poll()’.

 -- Method: devpoll.modify (fd[, eventmask])

     This method does an *note unregister(): 266f. followed by a *note
     register(): 266d.  It is (a bit) more efficient that doing the same
     explicitly.

 -- Method: devpoll.unregister (fd)

     Remove a file descriptor being tracked by a polling object.  Just
     like the *note register(): 266d. method, `fd' can be an integer or
     an object with a *note fileno(): 1e46. method that returns an
     integer.

     Attempting to remove a file descriptor that was never registered is
     safely ignored.

 -- Method: devpoll.poll ([timeout])

     Polls the set of registered file descriptors, and returns a
     possibly-empty list containing ‘(fd, event)’ 2-tuples for the
     descriptors that have events or errors to report.  `fd' is the file
     descriptor, and `event' is a bitmask with bits set for the reported
     events for that descriptor — ‘POLLIN’ for waiting input, ‘POLLOUT’
     to indicate that the descriptor can be written to, and so forth.
     An empty list indicates that the call timed out and no file
     descriptors had any events to report.  If `timeout' is given, it
     specifies the length of time in milliseconds which the system will
     wait for events before returning.  If `timeout' is omitted, -1, or
     *note None: 157, the call will block until there is an event for
     this poll object.

     Changed in version 3.5: The function is now retried with a
     recomputed timeout when interrupted by a signal, except if the
     signal handler raises an exception (see PEP 475(1) for the
     rationale), instead of raising *note InterruptedError: 64d.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Edge and Level Trigger Polling epoll Objects,  Next: Polling Objects,  Prev: /dev/poll Polling Objects,  Up: select — Waiting for I/O completion

5.19.4.2 Edge and Level Trigger Polling (epoll) Objects
.......................................................

     ‘https://linux.die.net/man/4/epoll’

     `eventmask'

     Constant                      Meaning
                                   
     ----------------------------------------------------------------------------------
                                   
     ‘EPOLLIN’                     Available for read
                                   
                                   
     ‘EPOLLOUT’                    Available for write
                                   
                                   
     ‘EPOLLPRI’                    Urgent data for read
                                   
                                   
     ‘EPOLLERR’                    Error condition happened on the assoc.  fd
                                   
                                   
     ‘EPOLLHUP’                    Hang up happened on the assoc.  fd
                                   
                                   
     ‘EPOLLET’                     Set Edge Trigger behavior, the default is Level
                                   Trigger behavior
                                   
                                   
     ‘EPOLLONESHOT’                Set one-shot behavior.  After one event is pulled
                                   out, the fd is internally disabled
                                   
                                   
     ‘EPOLLEXCLUSIVE’              Wake only one epoll object when the associated fd
                                   has an event.  The default (if this flag is not
                                   set) is to wake all epoll objects polling on a
                                   fd.
                                   
                                   
     ‘EPOLLRDHUP’                  Stream socket peer closed connection or shut down
                                   writing half of connection.
                                   
                                   
     ‘EPOLLRDNORM’                 Equivalent to ‘EPOLLIN’
                                   
                                   
     ‘EPOLLRDBAND’                 Priority data band can be read.
                                   
                                   
     ‘EPOLLWRNORM’                 Equivalent to ‘EPOLLOUT’
                                   
                                   
     ‘EPOLLWRBAND’                 Priority data may be written.
                                   
                                   
     ‘EPOLLMSG’                    Ignored.
                                   

     New in version 3.6: ‘EPOLLEXCLUSIVE’ was added.  It’s only
     supported by Linux Kernel 4.5 or later.

 -- Method: epoll.close ()

     Close the control file descriptor of the epoll object.

 -- Attribute: epoll.closed

     ‘True’ if the epoll object is closed.

 -- Method: epoll.fileno ()

     Return the file descriptor number of the control fd.

 -- Method: epoll.fromfd (fd)

     Create an epoll object from a given file descriptor.

 -- Method: epoll.register (fd[, eventmask])

     Register a fd descriptor with the epoll object.

 -- Method: epoll.modify (fd, eventmask)

     Modify a registered file descriptor.

 -- Method: epoll.unregister (fd)

     Remove a registered file descriptor from the epoll object.

 -- Method: epoll.poll (timeout=None, maxevents=-1)

     Wait for events.  timeout in seconds (float)

     Changed in version 3.5: The function is now retried with a
     recomputed timeout when interrupted by a signal, except if the
     signal handler raises an exception (see PEP 475(1) for the
     rationale), instead of raising *note InterruptedError: 64d.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Polling Objects,  Next: Kqueue Objects,  Prev: Edge and Level Trigger Polling epoll Objects,  Up: select — Waiting for I/O completion

5.19.4.3 Polling Objects
........................

The ‘poll()’ system call, supported on most Unix systems, provides
better scalability for network servers that service many, many clients
at the same time.  ‘poll()’ scales better because the system call only
requires listing the file descriptors of interest, while ‘select()’
builds a bitmap, turns on bits for the fds of interest, and then
afterward the whole bitmap has to be linearly scanned again.  ‘select()’
is O(highest file descriptor), while ‘poll()’ is O(number of file
descriptors).

 -- Method: poll.register (fd[, eventmask])

     Register a file descriptor with the polling object.  Future calls
     to the *note poll(): 264c. method will then check whether the file
     descriptor has any pending I/O events.  `fd' can be either an
     integer, or an object with a *note fileno(): 1e46. method that
     returns an integer.  File objects implement ‘fileno()’, so they can
     also be used as the argument.

     `eventmask' is an optional bitmask describing the type of events
     you want to check for, and can be a combination of the constants
     ‘POLLIN’, ‘POLLPRI’, and ‘POLLOUT’, described in the table below.
     If not specified, the default value used will check for all 3 types
     of events.

     Constant                Meaning
                             
     -----------------------------------------------------------------------
                             
     ‘POLLIN’                There is data to read
                             
                             
     ‘POLLPRI’               There is urgent data to read
                             
                             
     ‘POLLOUT’               Ready for output: writing will not block
                             
                             
     ‘POLLERR’               Error condition of some sort
                             
                             
     ‘POLLHUP’               Hung up
                             
                             
     ‘POLLRDHUP’             Stream socket peer closed connection, or
                             shut down writing half of connection
                             
                             
     ‘POLLNVAL’              Invalid request: descriptor not open
                             

     Registering a file descriptor that’s already registered is not an
     error, and has the same effect as registering the descriptor
     exactly once.

 -- Method: poll.modify (fd, eventmask)

     Modifies an already registered fd.  This has the same effect as
     ‘register(fd, eventmask)’.  Attempting to modify a file descriptor
     that was never registered causes an *note OSError: 1d1. exception
     with errno ‘ENOENT’ to be raised.

 -- Method: poll.unregister (fd)

     Remove a file descriptor being tracked by a polling object.  Just
     like the *note register(): 2678. method, `fd' can be an integer or
     an object with a *note fileno(): 1e46. method that returns an
     integer.

     Attempting to remove a file descriptor that was never registered
     causes a *note KeyError: 2c5. exception to be raised.

 -- Method: poll.poll ([timeout])

     Polls the set of registered file descriptors, and returns a
     possibly-empty list containing ‘(fd, event)’ 2-tuples for the
     descriptors that have events or errors to report.  `fd' is the file
     descriptor, and `event' is a bitmask with bits set for the reported
     events for that descriptor — ‘POLLIN’ for waiting input, ‘POLLOUT’
     to indicate that the descriptor can be written to, and so forth.
     An empty list indicates that the call timed out and no file
     descriptors had any events to report.  If `timeout' is given, it
     specifies the length of time in milliseconds which the system will
     wait for events before returning.  If `timeout' is omitted,
     negative, or *note None: 157, the call will block until there is an
     event for this poll object.

     Changed in version 3.5: The function is now retried with a
     recomputed timeout when interrupted by a signal, except if the
     signal handler raises an exception (see PEP 475(1) for the
     rationale), instead of raising *note InterruptedError: 64d.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Kqueue Objects,  Next: Kevent Objects,  Prev: Polling Objects,  Up: select — Waiting for I/O completion

5.19.4.4 Kqueue Objects
.......................

 -- Method: kqueue.close ()

     Close the control file descriptor of the kqueue object.

 -- Attribute: kqueue.closed

     ‘True’ if the kqueue object is closed.

 -- Method: kqueue.fileno ()

     Return the file descriptor number of the control fd.

 -- Method: kqueue.fromfd (fd)

     Create a kqueue object from a given file descriptor.

 -- Method: kqueue.control (changelist, max_events[, timeout]) ->
          eventlist

     Low level interface to kevent

        - changelist must be an iterable of kevent objects or ‘None’

        - max_events must be 0 or a positive integer

        - timeout in seconds (floats possible); the default is ‘None’,
          to wait forever

     Changed in version 3.5: The function is now retried with a
     recomputed timeout when interrupted by a signal, except if the
     signal handler raises an exception (see PEP 475(1) for the
     rationale), instead of raising *note InterruptedError: 64d.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Kevent Objects,  Prev: Kqueue Objects,  Up: select — Waiting for I/O completion

5.19.4.5 Kevent Objects
.......................

‘https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2’

 -- Attribute: kevent.ident

     Value used to identify the event.  The interpretation depends on
     the filter but it’s usually the file descriptor.  In the
     constructor ident can either be an int or an object with a *note
     fileno(): 1e46. method.  kevent stores the integer internally.

 -- Attribute: kevent.filter

     Name of the kernel filter.

     Constant                        Meaning
                                     
     ----------------------------------------------------------------------------------
                                     
     ‘KQ_FILTER_READ’                Takes a descriptor and returns whenever there
                                     is data available to read
                                     
                                     
     ‘KQ_FILTER_WRITE’               Takes a descriptor and returns whenever there
                                     is data available to write
                                     
                                     
     ‘KQ_FILTER_AIO’                 AIO requests
                                     
                                     
     ‘KQ_FILTER_VNODE’               Returns when one or more of the requested
                                     events watched in `fflag' occurs
                                     
                                     
     ‘KQ_FILTER_PROC’                Watch for events on a process id
                                     
                                     
     ‘KQ_FILTER_NETDEV’              Watch for events on a network device [not
                                     available on Mac OS X]
                                     
                                     
     ‘KQ_FILTER_SIGNAL’              Returns whenever the watched signal is
                                     delivered to the process
                                     
                                     
     ‘KQ_FILTER_TIMER’               Establishes an arbitrary timer
                                     

 -- Attribute: kevent.flags

     Filter action.

     Constant                        Meaning
                                     
     ----------------------------------------------------------------------------------
                                     
     ‘KQ_EV_ADD’                     Adds or modifies an event
                                     
                                     
     ‘KQ_EV_DELETE’                  Removes an event from the queue
                                     
                                     
     ‘KQ_EV_ENABLE’                  Permitscontrol() to returns the event
                                     
                                     
     ‘KQ_EV_DISABLE’                 Disablesevent
                                     
                                     
     ‘KQ_EV_ONESHOT’                 Removes event after first occurrence
                                     
                                     
     ‘KQ_EV_CLEAR’                   Reset the state after an event is retrieved
                                     
                                     
     ‘KQ_EV_SYSFLAGS’                internal event
                                     
                                     
     ‘KQ_EV_FLAG1’                   internal event
                                     
                                     
     ‘KQ_EV_EOF’                     Filter specific EOF condition
                                     
                                     
     ‘KQ_EV_ERROR’                   See return values
                                     

 -- Attribute: kevent.fflags

     Filter specific flags.

     ‘KQ_FILTER_READ’ and ‘KQ_FILTER_WRITE’ filter flags:

     Constant                         Meaning
                                      
     ----------------------------------------------------------------------------------
                                      
     ‘KQ_NOTE_LOWAT’                  low water mark of a socket buffer
                                      

     ‘KQ_FILTER_VNODE’ filter flags:

     Constant                         Meaning
                                      
     ----------------------------------------------------------------------------------
                                      
     ‘KQ_NOTE_DELETE’                 `unlink()' was called
                                      
                                      
     ‘KQ_NOTE_WRITE’                  a write occurred
                                      
                                      
     ‘KQ_NOTE_EXTEND’                 the file was extended
                                      
                                      
     ‘KQ_NOTE_ATTRIB’                 an attribute was changed
                                      
                                      
     ‘KQ_NOTE_LINK’                   the link count has changed
                                      
                                      
     ‘KQ_NOTE_RENAME’                 the file was renamed
                                      
                                      
     ‘KQ_NOTE_REVOKE’                 access to the file was revoked
                                      

     ‘KQ_FILTER_PROC’ filter flags:

     Constant                         Meaning
                                      
     ----------------------------------------------------------------------------------
                                      
     ‘KQ_NOTE_EXIT’                   the process has exited
                                      
                                      
     ‘KQ_NOTE_FORK’                   the process has called `fork()'
                                      
                                      
     ‘KQ_NOTE_EXEC’                   the process has executed a new process
                                      
                                      
     ‘KQ_NOTE_PCTRLMASK’              internal filter flag
                                      
                                      
     ‘KQ_NOTE_PDATAMASK’              internal filter flag
                                      
                                      
     ‘KQ_NOTE_TRACK’                  follow a process across `fork()'
                                      
                                      
     ‘KQ_NOTE_CHILD’                  returned on the child process for `NOTE_TRACK'
                                      
                                      
     ‘KQ_NOTE_TRACKERR’               unable to attach to a child
                                      

     ‘KQ_FILTER_NETDEV’ filter flags (not available on Mac OS X):

     Constant                         Meaning
                                      
     ----------------------------------------------------------------------------------
                                      
     ‘KQ_NOTE_LINKUP’                 link is up
                                      
                                      
     ‘KQ_NOTE_LINKDOWN’               link is down
                                      
                                      
     ‘KQ_NOTE_LINKINV’                link state is invalid
                                      

 -- Attribute: kevent.data

     Filter specific data.

 -- Attribute: kevent.udata

     User defined value.


File: python.info,  Node: selectors — High-level I/O multiplexing,  Next: asyncore — Asynchronous socket handler,  Prev: select — Waiting for I/O completion,  Up: Networking and Interprocess Communication

5.19.5 ‘selectors’ — High-level I/O multiplexing
------------------------------------------------

New in version 3.4.

`Source code:' Lib/selectors.py(1)

__________________________________________________________________

* Menu:

* Introduction: Introduction<9>.
* Classes: Classes<3>.
* Examples: Examples<17>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/selectors.py


File: python.info,  Node: Introduction<9>,  Next: Classes<3>,  Up: selectors — High-level I/O multiplexing

5.19.5.1 Introduction
.....................

This module allows high-level and efficient I/O multiplexing, built upon
the *note select: e5. module primitives.  Users are encouraged to use
this module instead, unless they want precise control over the OS-level
primitives used.

It defines a *note BaseSelector: 268a. abstract base class, along with
several concrete implementations (*note KqueueSelector: 2589, *note
EpollSelector: 441.…), that can be used to wait for I/O readiness
notification on multiple file objects.  In the following, “file object”
refers to any object with a ‘fileno()’ method, or a raw file descriptor.
See *note file object: b35.

*note DefaultSelector: 268b. is an alias to the most efficient
implementation available on the current platform: this should be the
default choice for most users.

     Note: The type of file objects supported depends on the platform:
     on Windows, sockets are supported, but not pipes, whereas on Unix,
     both are supported (some other types may be supported as well, such
     as fifos or special file devices).

See also
........

*note select: e5.

     Low-level I/O multiplexing module.


File: python.info,  Node: Classes<3>,  Next: Examples<17>,  Prev: Introduction<9>,  Up: selectors — High-level I/O multiplexing

5.19.5.2 Classes
................

Classes hierarchy:

     BaseSelector +-- SelectSelector +-- PollSelector +-- EpollSelector +-- DevpollSelector +-- KqueueSelector

In the following, `events' is a bitwise mask indicating which I/O events
should be waited for on a given file object.  It can be a combination of
the modules constants below:

     Constant                    Meaning
                                 
     --------------------------------------------------------------------------------
                                 
     ‘EVENT_READ’                Available for read
                                 
                                 
     ‘EVENT_WRITE’               Available for write
                                 

 -- Class: selectors.SelectorKey

     A *note SelectorKey: 268d. is a *note namedtuple: 1b5. used to
     associate a file object to its underlying file descriptor, selected
     event mask and attached data.  It is returned by several *note
     BaseSelector: 268a. methods.

      -- Attribute: fileobj

          File object registered.

      -- Attribute: fd

          Underlying file descriptor.

      -- Attribute: events

          Events that must be waited for on this file object.

      -- Attribute: data

          Optional opaque data associated to this file object: for
          example, this could be used to store a per-client session ID.

 -- Class: selectors.BaseSelector

     A *note BaseSelector: 268a. is used to wait for I/O event readiness
     on multiple file objects.  It supports file stream registration,
     unregistration, and a method to wait for I/O events on those
     streams, with an optional timeout.  It’s an abstract base class, so
     cannot be instantiated.  Use *note DefaultSelector: 268b. instead,
     or one of *note SelectSelector: 2586, *note KqueueSelector: 2589.
     etc.  if you want to specifically use an implementation, and your
     platform supports it.  *note BaseSelector: 268a. and its concrete
     implementations support the *note context manager: 55d. protocol.

      -- Method: abstractmethod register (fileobj, events, data=None)

          Register a file object for selection, monitoring it for I/O
          events.

          `fileobj' is the file object to monitor.  It may either be an
          integer file descriptor or an object with a ‘fileno()’ method.
          `events' is a bitwise mask of events to monitor.  `data' is an
          opaque object.

          This returns a new *note SelectorKey: 268d. instance, or
          raises a *note ValueError: 1f9. in case of invalid event mask
          or file descriptor, or *note KeyError: 2c5. if the file object
          is already registered.

      -- Method: abstractmethod unregister (fileobj)

          Unregister a file object from selection, removing it from
          monitoring.  A file object shall be unregistered prior to
          being closed.

          `fileobj' must be a file object previously registered.

          This returns the associated *note SelectorKey: 268d. instance,
          or raises a *note KeyError: 2c5. if `fileobj' is not
          registered.  It will raise *note ValueError: 1f9. if `fileobj'
          is invalid (e.g.  it has no ‘fileno()’ method or its
          ‘fileno()’ method has an invalid return value).

      -- Method: modify (fileobj, events, data=None)

          Change a registered file object’s monitored events or attached
          data.

          This is equivalent to ‘BaseSelector.unregister(fileobj)()’
          followed by ‘BaseSelector.register(fileobj, events, data)()’,
          except that it can be implemented more efficiently.

          This returns a new *note SelectorKey: 268d. instance, or
          raises a *note ValueError: 1f9. in case of invalid event mask
          or file descriptor, or *note KeyError: 2c5. if the file object
          is not registered.

      -- Method: abstractmethod select (timeout=None)

          Wait until some registered file objects become ready, or the
          timeout expires.

          If ‘timeout > 0’, this specifies the maximum wait time, in
          seconds.  If ‘timeout <= 0’, the call won’t block, and will
          report the currently ready file objects.  If `timeout' is
          ‘None’, the call will block until a monitored file object
          becomes ready.

          This returns a list of ‘(key, events)’ tuples, one for each
          ready file object.

          `key' is the *note SelectorKey: 268d. instance corresponding
          to a ready file object.  `events' is a bitmask of events ready
          on this file object.

               Note: This method can return before any file object
               becomes ready or the timeout has elapsed if the current
               process receives a signal: in this case, an empty list
               will be returned.

          Changed in version 3.5: The selector is now retried with a
          recomputed timeout when interrupted by a signal if the signal
          handler did not raise an exception (see PEP 475(1) for the
          rationale), instead of returning an empty list of events
          before the timeout.

      -- Method: close ()

          Close the selector.

          This must be called to make sure that any underlying resource
          is freed.  The selector shall not be used once it has been
          closed.

      -- Method: get_key (fileobj)

          Return the key associated with a registered file object.

          This returns the *note SelectorKey: 268d. instance associated
          to this file object, or raises *note KeyError: 2c5. if the
          file object is not registered.

      -- Method: abstractmethod get_map ()

          Return a mapping of file objects to selector keys.

          This returns a *note Mapping: 187d. instance mapping
          registered file objects to their associated *note SelectorKey:
          268d. instance.

 -- Class: selectors.DefaultSelector

     The default selector class, using the most efficient implementation
     available on the current platform.  This should be the default
     choice for most users.

 -- Class: selectors.SelectSelector

     *note select.select(): 667.-based selector.

 -- Class: selectors.PollSelector

     *note select.poll(): 264c.-based selector.

 -- Class: selectors.EpollSelector

     *note select.epoll(): 89d.-based selector.

      -- Method: fileno ()

          This returns the file descriptor used by the underlying *note
          select.epoll(): 89d. object.

 -- Class: selectors.DevpollSelector

     *note select.devpoll(): 89f.-based selector.

      -- Method: fileno ()

          This returns the file descriptor used by the underlying *note
          select.devpoll(): 89f. object.

     New in version 3.5.

 -- Class: selectors.KqueueSelector

     *note select.kqueue(): 2668.-based selector.

      -- Method: fileno ()

          This returns the file descriptor used by the underlying *note
          select.kqueue(): 2668. object.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Examples<17>,  Prev: Classes<3>,  Up: selectors — High-level I/O multiplexing

5.19.5.3 Examples
.................

Here is a simple echo server implementation:

     import selectors import socket  sel = selectors.DefaultSelector()  def accept(sock, mask):     conn, addr = sock.accept()  # Should be ready     print('accepted', conn, 'from', addr)     conn.setblocking(False)     sel.register(conn, selectors.EVENT_READ, read)  def read(conn, mask):     data = conn.recv(1000)  # Should be ready     if data:         print('echoing', repr(data), 'to', conn)         conn.send(data)  # Hope it won't block     else:         print('closing', conn)         sel.unregister(conn)         conn.close()  sock = socket.socket() sock.bind(('localhost', 1234)) sock.listen(100) sock.setblocking(False) sel.register(sock, selectors.EVENT_READ, accept)  while True:     events = sel.select()     for key, mask in events:         callback = key.data         callback(key.fileobj, mask)


File: python.info,  Node: asyncore — Asynchronous socket handler,  Next: asynchat — Asynchronous socket command/response handler,  Prev: selectors — High-level I/O multiplexing,  Up: Networking and Interprocess Communication

5.19.6 ‘asyncore’ — Asynchronous socket handler
-----------------------------------------------

`Source code:' Lib/asyncore.py(1)

Deprecated since version 3.6: Please use *note asyncio: a. instead.

__________________________________________________________________

     Note: This module exists for backwards compatibility only.  For new
     code we recommend using *note asyncio: a.

This module provides the basic infrastructure for writing asynchronous
socket service clients and servers.

There are only two ways to have a program on a single processor do “more
than one thing at a time.” Multi-threaded programming is the simplest
and most popular way to do it, but there is another very different
technique, that lets you have nearly all the advantages of
multi-threading, without actually using multiple threads.  It’s really
only practical if your program is largely I/O bound.  If your program is
processor bound, then pre-emptive scheduled threads are probably what
you really need.  Network servers are rarely processor bound, however.

If your operating system supports the ‘select()’ system call in its I/O
library (and nearly all do), then you can use it to juggle multiple
communication channels at once; doing other work while your I/O is
taking place in the “background.” Although this strategy can seem
strange and complex, especially at first, it is in many ways easier to
understand and control than multi-threaded programming.  The *note
asyncore: b. module solves many of the difficult problems for you,
making the task of building sophisticated high-performance network
servers and clients a snap.  For “conversational” applications and
protocols the companion *note asynchat: 9. module is invaluable.

The basic idea behind both modules is to create one or more network
`channels', instances of class *note asyncore.dispatcher: bb6. and *note
asynchat.async_chat: 8a9.  Creating the channels adds them to a global
map, used by the *note loop(): 269e. function if you do not provide it
with your own `map'.

Once the initial channel(s) is(are) created, calling the *note loop():
269e. function activates channel service, which continues until the last
channel (including any that have been added to the map during
asynchronous service) is closed.

 -- Function: asyncore.loop ([timeout[, use_poll[, map[, count]]]])

     Enter a polling loop that terminates after count passes or all open
     channels have been closed.  All arguments are optional.  The
     `count' parameter defaults to ‘None’, resulting in the loop
     terminating only when all channels have been closed.  The `timeout'
     argument sets the timeout parameter for the appropriate *note
     select(): 667. or *note poll(): 264c. call, measured in seconds;
     the default is 30 seconds.  The `use_poll' parameter, if true,
     indicates that *note poll(): 264c. should be used in preference to
     *note select(): 667. (the default is ‘False’).

     The `map' parameter is a dictionary whose items are the channels to
     watch.  As channels are closed they are deleted from their map.  If
     `map' is omitted, a global map is used.  Channels (instances of
     *note asyncore.dispatcher: bb6, *note asynchat.async_chat: 8a9. and
     subclasses thereof) can freely be mixed in the map.

 -- Class: asyncore.dispatcher

     The *note dispatcher: bb6. class is a thin wrapper around a
     low-level socket object.  To make it more useful, it has a few
     methods for event-handling which are called from the asynchronous
     loop.  Otherwise, it can be treated as a normal non-blocking socket
     object.

     The firing of low-level events at certain times or in certain
     connection states tells the asynchronous loop that certain
     higher-level events have taken place.  For example, if we have
     asked for a socket to connect to another host, we know that the
     connection has been made when the socket becomes writable for the
     first time (at this point you know that you may write to it with
     the expectation of success).  The implied higher-level events are:

     Event                      Description
                                
     ------------------------------------------------------------------------
                                
     ‘handle_connect()’         Implied by the first read or write event
                                
                                
     ‘handle_close()’           Implied by a read event with no data
                                available
                                
                                
     ‘handle_accepted()’        Implied by a read event on a listening
                                socket
                                

     During asynchronous processing, each mapped channel’s *note
     readable(): 269f. and *note writable(): 26a0. methods are used to
     determine whether the channel’s socket should be added to the list
     of channels ‘select()’ed or ‘poll()’ed for read and write events.

     Thus, the set of channel events is larger than the basic socket
     events.  The full set of methods that can be overridden in your
     subclass follows:

      -- Method: handle_read ()

          Called when the asynchronous loop detects that a ‘read()’ call
          on the channel’s socket will succeed.

      -- Method: handle_write ()

          Called when the asynchronous loop detects that a writable
          socket can be written.  Often this method will implement the
          necessary buffering for performance.  For example:

               def handle_write(self):     sent = self.send(self.buffer)     self.buffer = self.buffer[sent:]

      -- Method: handle_expt ()

          Called when there is out of band (OOB) data for a socket
          connection.  This will almost never happen, as OOB is
          tenuously supported and rarely used.

      -- Method: handle_connect ()

          Called when the active opener’s socket actually makes a
          connection.  Might send a “welcome” banner, or initiate a
          protocol negotiation with the remote endpoint, for example.

      -- Method: handle_close ()

          Called when the socket is closed.

      -- Method: handle_error ()

          Called when an exception is raised and not otherwise handled.
          The default version prints a condensed traceback.

      -- Method: handle_accept ()

          Called on listening channels (passive openers) when a
          connection can be established with a new remote endpoint that
          has issued a *note connect(): 26a7. call for the local
          endpoint.  Deprecated in version 3.2; use *note
          handle_accepted(): bb7. instead.

          Deprecated since version 3.2.

      -- Method: handle_accepted (sock, addr)

          Called on listening channels (passive openers) when a
          connection has been established with a new remote endpoint
          that has issued a *note connect(): 26a7. call for the local
          endpoint.  `sock' is a `new' socket object usable to send and
          receive data on the connection, and `addr' is the address
          bound to the socket on the other end of the connection.

          New in version 3.2.

      -- Method: readable ()

          Called each time around the asynchronous loop to determine
          whether a channel’s socket should be added to the list on
          which read events can occur.  The default method simply
          returns ‘True’, indicating that by default, all channels will
          be interested in read events.

      -- Method: writable ()

          Called each time around the asynchronous loop to determine
          whether a channel’s socket should be added to the list on
          which write events can occur.  The default method simply
          returns ‘True’, indicating that by default, all channels will
          be interested in write events.

     In addition, each channel delegates or extends many of the socket
     methods.  Most of these are nearly identical to their socket
     partners.

      -- Method: create_socket (family=socket.AF_INET,
               type=socket.SOCK_STREAM)

          This is identical to the creation of a normal socket, and will
          use the same options for creation.  Refer to the *note socket:
          ef. documentation for information on creating sockets.

          Changed in version 3.3: `family' and `type' arguments can be
          omitted.

      -- Method: connect (address)

          As with the normal socket object, `address' is a tuple with
          the first element the host to connect to, and the second the
          port number.

      -- Method: send (data)

          Send `data' to the remote end-point of the socket.

      -- Method: recv (buffer_size)

          Read at most `buffer_size' bytes from the socket’s remote
          end-point.  An empty bytes object implies that the channel has
          been closed from the other end.

          Note that *note recv(): 26aa. may raise *note BlockingIOError:
          98b. , even though *note select.select(): 667. or *note
          select.poll(): 264c. has reported the socket ready for
          reading.

      -- Method: listen (backlog)

          Listen for connections made to the socket.  The `backlog'
          argument specifies the maximum number of queued connections
          and should be at least 1; the maximum value is
          system-dependent (usually 5).

      -- Method: bind (address)

          Bind the socket to `address'.  The socket must not already be
          bound.  (The format of `address' depends on the address family
          — refer to the *note socket: ef. documentation for more
          information.)  To mark the socket as re-usable (setting the
          ‘SO_REUSEADDR’ option), call the *note dispatcher: bb6.
          object’s ‘set_reuse_addr()’ method.

      -- Method: accept ()

          Accept a connection.  The socket must be bound to an address
          and listening for connections.  The return value can be either
          ‘None’ or a pair ‘(conn, address)’ where `conn' is a `new'
          socket object usable to send and receive data on the
          connection, and `address' is the address bound to the socket
          on the other end of the connection.  When ‘None’ is returned
          it means the connection didn’t take place, in which case the
          server should just ignore this event and keep listening for
          further incoming connections.

      -- Method: close ()

          Close the socket.  All future operations on the socket object
          will fail.  The remote end-point will receive no more data
          (after queued data is flushed).  Sockets are automatically
          closed when they are garbage-collected.

 -- Class: asyncore.dispatcher_with_send

     A *note dispatcher: bb6. subclass which adds simple buffered output
     capability, useful for simple clients.  For more sophisticated
     usage use *note asynchat.async_chat: 8a9.

 -- Class: asyncore.file_dispatcher

     A file_dispatcher takes a file descriptor or *note file object:
     b35. along with an optional map argument and wraps it for use with
     the ‘poll()’ or ‘loop()’ functions.  If provided a file object or
     anything with a ‘fileno()’ method, that method will be called and
     passed to the *note file_wrapper: 26b0. constructor.

     *note Availability: 129a.: Unix.

 -- Class: asyncore.file_wrapper

     A file_wrapper takes an integer file descriptor and calls *note
     os.dup(): ec5. to duplicate the handle so that the original handle
     may be closed independently of the file_wrapper.  This class
     implements sufficient methods to emulate a socket for use by the
     *note file_dispatcher: 26af. class.

     *note Availability: 129a.: Unix.

* Menu:

* asyncore Example basic HTTP client::
* asyncore Example basic echo server::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asyncore.py


File: python.info,  Node: asyncore Example basic HTTP client,  Next: asyncore Example basic echo server,  Up: asyncore — Asynchronous socket handler

5.19.6.1 asyncore Example basic HTTP client
...........................................

Here is a very basic HTTP client that uses the *note dispatcher: bb6.
class to implement its socket handling:

     import asyncore  class HTTPClient(asyncore.dispatcher):      def __init__(self, host, path):         asyncore.dispatcher.__init__(self)         self.create_socket()         self.connect( (host, 80) )         self.buffer = bytes('GET %s HTTP/1.0\r\nHost: %s\r\n\r\n' %                             (path, host), 'ascii')      def handle_connect(self):         pass      def handle_close(self):         self.close()      def handle_read(self):         print(self.recv(8192))      def writable(self):         return (len(self.buffer) > 0)      def handle_write(self):         sent = self.send(self.buffer)         self.buffer = self.buffer[sent:]   client = HTTPClient('www.python.org', '/') asyncore.loop()


File: python.info,  Node: asyncore Example basic echo server,  Prev: asyncore Example basic HTTP client,  Up: asyncore — Asynchronous socket handler

5.19.6.2 asyncore Example basic echo server
...........................................

Here is a basic echo server that uses the *note dispatcher: bb6. class
to accept connections and dispatches the incoming connections to a
handler:

     import asyncore  class EchoHandler(asyncore.dispatcher_with_send):      def handle_read(self):         data = self.recv(8192)         if data:             self.send(data)  class EchoServer(asyncore.dispatcher):      def __init__(self, host, port):         asyncore.dispatcher.__init__(self)         self.create_socket()         self.set_reuse_addr()         self.bind((host, port))         self.listen(5)      def handle_accepted(self, sock, addr):         print('Incoming connection from %s' % repr(addr))         handler = EchoHandler(sock)  server = EchoServer('localhost', 8080) asyncore.loop()


File: python.info,  Node: asynchat — Asynchronous socket command/response handler,  Next: signal — Set handlers for asynchronous events,  Prev: asyncore — Asynchronous socket handler,  Up: Networking and Interprocess Communication

5.19.7 ‘asynchat’ — Asynchronous socket command/response handler
----------------------------------------------------------------

`Source code:' Lib/asynchat.py(1)

Deprecated since version 3.6: Please use *note asyncio: a. instead.

__________________________________________________________________

     Note: This module exists for backwards compatibility only.  For new
     code we recommend using *note asyncio: a.

This module builds on the *note asyncore: b. infrastructure, simplifying
asynchronous clients and servers and making it easier to handle
protocols whose elements are terminated by arbitrary strings, or are of
variable length.  *note asynchat: 9. defines the abstract class *note
async_chat: 8a9. that you subclass, providing implementations of the
‘collect_incoming_data()’ and ‘found_terminator()’ methods.  It uses the
same asynchronous loop as *note asyncore: b, and the two types of
channel, *note asyncore.dispatcher: bb6. and *note asynchat.async_chat:
8a9, can freely be mixed in the channel map.  Typically an *note
asyncore.dispatcher: bb6. server channel generates new *note
asynchat.async_chat: 8a9. channel objects as it receives incoming
connection requests.

 -- Class: asynchat.async_chat

     This class is an abstract subclass of *note asyncore.dispatcher:
     bb6.  To make practical use of the code you must subclass *note
     async_chat: 8a9, providing meaningful *note
     collect_incoming_data(): 26b7. and *note found_terminator(): 26b8.
     methods.  The *note asyncore.dispatcher: bb6. methods can be used,
     although not all make sense in a message/response context.

     Like *note asyncore.dispatcher: bb6, *note async_chat: 8a9. defines
     a set of events that are generated by an analysis of socket
     conditions after a ‘select()’ call.  Once the polling loop has been
     started the *note async_chat: 8a9. object’s methods are called by
     the event-processing framework with no action on the part of the
     programmer.

     Two class attributes can be modified, to improve performance, or
     possibly even to conserve memory.

      -- Data: ac_in_buffer_size

          The asynchronous input buffer size (default ‘4096’).

      -- Data: ac_out_buffer_size

          The asynchronous output buffer size (default ‘4096’).

     Unlike *note asyncore.dispatcher: bb6, *note async_chat: 8a9.
     allows you to define a FIFO queue of `producers'.  A producer need
     have only one method, ‘more()’, which should return data to be
     transmitted on the channel.  The producer indicates exhaustion
     (`i.e.'  that it contains no more data) by having its ‘more()’
     method return the empty bytes object.  At this point the *note
     async_chat: 8a9. object removes the producer from the queue and
     starts using the next producer, if any.  When the producer queue is
     empty the ‘handle_write()’ method does nothing.  You use the
     channel object’s *note set_terminator(): 26bb. method to describe
     how to recognize the end of, or an important breakpoint in, an
     incoming transmission from the remote endpoint.

     To build a functioning *note async_chat: 8a9. subclass your input
     methods *note collect_incoming_data(): 26b7. and *note
     found_terminator(): 26b8. must handle the data that the channel
     receives asynchronously.  The methods are described below.

 -- Method: async_chat.close_when_done ()

     Pushes a ‘None’ on to the producer queue.  When this producer is
     popped off the queue it causes the channel to be closed.

 -- Method: async_chat.collect_incoming_data (data)

     Called with `data' holding an arbitrary amount of received data.
     The default method, which must be overridden, raises a *note
     NotImplementedError: 603. exception.

 -- Method: async_chat.discard_buffers ()

     In emergencies this method will discard any data held in the input
     and/or output buffers and the producer queue.

 -- Method: async_chat.found_terminator ()

     Called when the incoming data stream matches the termination
     condition set by *note set_terminator(): 26bb.  The default method,
     which must be overridden, raises a *note NotImplementedError: 603.
     exception.  The buffered input data should be available via an
     instance attribute.

 -- Method: async_chat.get_terminator ()

     Returns the current terminator for the channel.

 -- Method: async_chat.push (data)

     Pushes data on to the channel’s queue to ensure its transmission.
     This is all you need to do to have the channel write the data out
     to the network, although it is possible to use your own producers
     in more complex schemes to implement encryption and chunking, for
     example.

 -- Method: async_chat.push_with_producer (producer)

     Takes a producer object and adds it to the producer queue
     associated with the channel.  When all currently-pushed producers
     have been exhausted the channel will consume this producer’s data
     by calling its ‘more()’ method and send the data to the remote
     endpoint.

 -- Method: async_chat.set_terminator (term)

     Sets the terminating condition to be recognized on the channel.
     ‘term’ may be any of three types of value, corresponding to three
     different ways to handle incoming protocol data.

     term            Description
                     
     ------------------------------------------------------------------
                     
     `string'        Will call *note found_terminator(): 26b8. when
                     the string is found in the input stream
                     
                     
     `integer'       Will call *note found_terminator(): 26b8. when
                     the indicated number of characters have been
                     received
                     
                     
     ‘None’          The channel continues to collect data forever
                     

     Note that any data following the terminator will be available for
     reading by the channel after *note found_terminator(): 26b8. is
     called.

* Menu:

* asynchat Example::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/asynchat.py


File: python.info,  Node: asynchat Example,  Up: asynchat — Asynchronous socket command/response handler

5.19.7.1 asynchat Example
.........................

The following partial example shows how HTTP requests can be read with
*note async_chat: 8a9.  A web server might create an
‘http_request_handler’ object for each incoming client connection.
Notice that initially the channel terminator is set to match the blank
line at the end of the HTTP headers, and a flag indicates that the
headers are being read.

Once the headers have been read, if the request is of type POST
(indicating that further data are present in the input stream) then the
‘Content-Length:’ header is used to set a numeric terminator to read the
right amount of data from the channel.

The ‘handle_request()’ method is called once all relevant input has been
marshalled, after setting the channel terminator to ‘None’ to ensure
that any extraneous data sent by the web client are ignored.

     import asynchat  class http_request_handler(asynchat.async_chat):      def __init__(self, sock, addr, sessions, log):         asynchat.async_chat.__init__(self, sock=sock)         self.addr = addr         self.sessions = sessions         self.ibuffer = []         self.obuffer = b""         self.set_terminator(b"\r\n\r\n")         self.reading_headers = True         self.handling = False         self.cgi_data = None         self.log = log      def collect_incoming_data(self, data):         """Buffer the data"""         self.ibuffer.append(data)      def found_terminator(self):         if self.reading_headers:             self.reading_headers = False             self.parse_headers(b"".join(self.ibuffer))             self.ibuffer = []             if self.op.upper() == b"POST":                 clen = self.headers.getheader("content-length")                 self.set_terminator(int(clen))             else:                 self.handling = True                 self.set_terminator(None)                 self.handle_request()         elif not self.handling:             self.set_terminator(None)  # browsers sometimes over-send             self.cgi_data = parse(self.headers, b"".join(self.ibuffer))             self.handling = True             self.ibuffer = []             self.handle_request()


File: python.info,  Node: signal — Set handlers for asynchronous events,  Next: mmap — Memory-mapped file support,  Prev: asynchat — Asynchronous socket command/response handler,  Up: Networking and Interprocess Communication

5.19.8 ‘signal’ — Set handlers for asynchronous events
------------------------------------------------------

__________________________________________________________________

This module provides mechanisms to use signal handlers in Python.

* Menu:

* General rules::
* Module contents: Module contents<2>.
* Example: Example<9>.
* Note on SIGPIPE::


File: python.info,  Node: General rules,  Next: Module contents<2>,  Up: signal — Set handlers for asynchronous events

5.19.8.1 General rules
......................

The *note signal.signal(): a72. function allows defining custom handlers
to be executed when a signal is received.  A small number of default
handlers are installed: ‘SIGPIPE’ is ignored (so write errors on pipes
and sockets can be reported as ordinary Python exceptions) and ‘SIGINT’
is translated into a *note KeyboardInterrupt: 197. exception if the
parent process has not changed it.

A handler for a particular signal, once set, remains installed until it
is explicitly reset (Python emulates the BSD style interface regardless
of the underlying implementation), with the exception of the handler for
‘SIGCHLD’, which follows the underlying implementation.

* Menu:

* Execution of Python signal handlers::
* Signals and threads::


File: python.info,  Node: Execution of Python signal handlers,  Next: Signals and threads,  Up: General rules

5.19.8.2 Execution of Python signal handlers
............................................

A Python signal handler does not get executed inside the low-level (C)
signal handler.  Instead, the low-level signal handler sets a flag which
tells the *note virtual machine: 26c7. to execute the corresponding
Python signal handler at a later point(for example at the next *note
bytecode: 609. instruction).  This has consequences:

   * It makes little sense to catch synchronous errors like ‘SIGFPE’ or
     ‘SIGSEGV’ that are caused by an invalid operation in C code.
     Python will return from the signal handler to the C code, which is
     likely to raise the same signal again, causing Python to apparently
     hang.  From Python 3.3 onwards, you can use the *note faulthandler:
     7d. module to report on synchronous errors.

   * A long-running calculation implemented purely in C (such as regular
     expression matching on a large body of text) may run uninterrupted
     for an arbitrary amount of time, regardless of any signals
     received.  The Python signal handlers will be called when the
     calculation finishes.


File: python.info,  Node: Signals and threads,  Prev: Execution of Python signal handlers,  Up: General rules

5.19.8.3 Signals and threads
............................

Python signal handlers are always executed in the main Python thread,
even if the signal was received in another thread.  This means that
signals can’t be used as a means of inter-thread communication.  You can
use the synchronization primitives from the *note threading: 109. module
instead.

Besides, only the main thread is allowed to set a new signal handler.


File: python.info,  Node: Module contents<2>,  Next: Example<9>,  Prev: General rules,  Up: signal — Set handlers for asynchronous events

5.19.8.4 Module contents
........................

Changed in version 3.5: signal (SIG*), handler (*note SIG_DFL: 2401,
*note SIG_IGN: 2402.) and sigmask (*note SIG_BLOCK: 26cb, *note
SIG_UNBLOCK: 26cc, *note SIG_SETMASK: 26cd.) related constants listed
below were turned into *note enums: 582.  *note getsignal(): 26ce, *note
pthread_sigmask(): a6e, *note sigpending(): a70. and *note sigwait():
a71. functions return human-readable *note enums: 582.

The variables defined in the *note signal: ea. module are:

 -- Data: signal.SIG_DFL

     This is one of two standard signal handling options; it will simply
     perform the default function for the signal.  For example, on most
     systems the default action for ‘SIGQUIT’ is to dump core and exit,
     while the default action for ‘SIGCHLD’ is to simply ignore it.

 -- Data: signal.SIG_IGN

     This is another standard signal handler, which will simply ignore
     the given signal.

 -- Data: SIG*

     All the signal numbers are defined symbolically.  For example, the
     hangup signal is defined as ‘signal.SIGHUP’; the variable names are
     identical to the names used in C programs, as found in
     ‘<signal.h>’.  The Unix man page for ‘‘signal()’’ lists the
     existing signals (on some systems this is ‘signal(2)’, on others
     the list is in ‘signal(7)’).  Note that not all systems define the
     same set of signal names; only those names defined by the system
     are defined by this module.

 -- Data: signal.CTRL_C_EVENT

     The signal corresponding to the ‘Ctrl+C’ keystroke event.  This
     signal can only be used with *note os.kill(): ce6.

     *note Availability: 129a.: Windows.

     New in version 3.2.

 -- Data: signal.CTRL_BREAK_EVENT

     The signal corresponding to the ‘Ctrl+Break’ keystroke event.  This
     signal can only be used with *note os.kill(): ce6.

     *note Availability: 129a.: Windows.

     New in version 3.2.

 -- Data: signal.NSIG

     One more than the number of the highest signal number.

 -- Data: signal.ITIMER_REAL

     Decrements interval timer in real time, and delivers ‘SIGALRM’ upon
     expiration.

 -- Data: signal.ITIMER_VIRTUAL

     Decrements interval timer only when the process is executing, and
     delivers SIGVTALRM upon expiration.

 -- Data: signal.ITIMER_PROF

     Decrements interval timer both when the process executes and when
     the system is executing on behalf of the process.  Coupled with
     ITIMER_VIRTUAL, this timer is usually used to profile the time
     spent by the application in user and kernel space.  SIGPROF is
     delivered upon expiration.

 -- Data: signal.SIG_BLOCK

     A possible value for the `how' parameter to *note
     pthread_sigmask(): a6e. indicating that signals are to be blocked.

     New in version 3.3.

 -- Data: signal.SIG_UNBLOCK

     A possible value for the `how' parameter to *note
     pthread_sigmask(): a6e. indicating that signals are to be
     unblocked.

     New in version 3.3.

 -- Data: signal.SIG_SETMASK

     A possible value for the `how' parameter to *note
     pthread_sigmask(): a6e. indicating that the signal mask is to be
     replaced.

     New in version 3.3.

The *note signal: ea. module defines one exception:

 -- Exception: signal.ItimerError

     Raised to signal an error from the underlying *note setitimer():
     26d4. or *note getitimer(): 26d5. implementation.  Expect this
     error if an invalid interval timer or a negative time is passed to
     *note setitimer(): 26d4.  This error is a subtype of *note OSError:
     1d1.

     New in version 3.3: This error used to be a subtype of *note
     IOError: 986, which is now an alias of *note OSError: 1d1.

The *note signal: ea. module defines the following functions:

 -- Function: signal.alarm (time)

     If `time' is non-zero, this function requests that a ‘SIGALRM’
     signal be sent to the process in `time' seconds.  Any previously
     scheduled alarm is canceled (only one alarm can be scheduled at any
     time).  The returned value is then the number of seconds before any
     previously set alarm was to have been delivered.  If `time' is
     zero, no alarm is scheduled, and any scheduled alarm is canceled.
     If the return value is zero, no alarm is currently scheduled.

     *note Availability: 129a.: Unix.  See the man page ‘alarm(2)’ for
     further information.

 -- Function: signal.getsignal (signalnum)

     Return the current signal handler for the signal `signalnum'.  The
     returned value may be a callable Python object, or one of the
     special values *note signal.SIG_IGN: 2402, *note signal.SIG_DFL:
     2401. or *note None: 157.  Here, *note signal.SIG_IGN: 2402. means
     that the signal was previously ignored, *note signal.SIG_DFL: 2401.
     means that the default way of handling the signal was previously in
     use, and ‘None’ means that the previous signal handler was not
     installed from Python.

 -- Function: signal.strsignal (signalnum)

     Return the system description of the signal `signalnum', such as
     “Interrupt”, “Segmentation fault”, etc.  Returns *note None: 157.
     if the signal is not recognized.

     New in version 3.8.

 -- Function: signal.valid_signals ()

     Return the set of valid signal numbers on this platform.  This can
     be less than ‘range(1, NSIG)’ if some signals are reserved by the
     system for internal use.

     New in version 3.8.

 -- Function: signal.pause ()

     Cause the process to sleep until a signal is received; the
     appropriate handler will then be called.  Returns nothing.

     *note Availability: 129a.: Unix.  See the man page ‘signal(2)’ for
     further information.

     See also *note sigwait(): a71, *note sigwaitinfo(): 673, *note
     sigtimedwait(): 672. and *note sigpending(): a70.

 -- Function: signal.raise_signal (signum)

     Sends a signal to the calling process.  Returns nothing.

     New in version 3.8.

 -- Function: signal.pthread_kill (thread_id, signalnum)

     Send the signal `signalnum' to the thread `thread_id', another
     thread in the same process as the caller.  The target thread can be
     executing any code (Python or not).  However, if the target thread
     is executing the Python interpreter, the Python signal handlers
     will be *note executed by the main thread: 26c9.  Therefore, the
     only point of sending a signal to a particular Python thread would
     be to force a running system call to fail with *note
     InterruptedError: 64d.

     Use *note threading.get_ident(): aa4. or the *note ident: 1f57.
     attribute of *note threading.Thread: 233. objects to get a suitable
     value for `thread_id'.

     If `signalnum' is 0, then no signal is sent, but error checking is
     still performed; this can be used to check if the target thread is
     still running.

     *note Availability: 129a.: Unix.  See the man page
     ‘pthread_kill(3)’ for further information.

     See also *note os.kill(): ce6.

     New in version 3.3.

 -- Function: signal.pthread_sigmask (how, mask)

     Fetch and/or change the signal mask of the calling thread.  The
     signal mask is the set of signals whose delivery is currently
     blocked for the caller.  Return the old signal mask as a set of
     signals.

     The behavior of the call is dependent on the value of `how', as
     follows.

        * *note SIG_BLOCK: 26cb.: The set of blocked signals is the
          union of the current set and the `mask' argument.

        * *note SIG_UNBLOCK: 26cc.: The signals in `mask' are removed
          from the current set of blocked signals.  It is permissible to
          attempt to unblock a signal which is not blocked.

        * *note SIG_SETMASK: 26cd.: The set of blocked signals is set to
          the `mask' argument.

     `mask' is a set of signal numbers (e.g.  {‘signal.SIGINT’,
     ‘signal.SIGTERM’}).  Use *note valid_signals(): 26d7. for a full
     mask including all signals.

     For example, ‘signal.pthread_sigmask(signal.SIG_BLOCK, [])’ reads
     the signal mask of the calling thread.

     *note Availability: 129a.: Unix.  See the man page ‘sigprocmask(3)’
     and ‘pthread_sigmask(3)’ for further information.

     See also *note pause(): 26d8, *note sigpending(): a70. and *note
     sigwait(): a71.

     New in version 3.3.

 -- Function: signal.setitimer (which, seconds, interval=0.0)

     Sets given interval timer (one of *note signal.ITIMER_REAL: 26d0,
     *note signal.ITIMER_VIRTUAL: 26d1. or *note signal.ITIMER_PROF:
     26d2.) specified by `which' to fire after `seconds' (float is
     accepted, different from *note alarm(): 26d6.) and after that every
     `interval' seconds (if `interval' is non-zero).  The interval timer
     specified by `which' can be cleared by setting `seconds' to zero.

     When an interval timer fires, a signal is sent to the process.  The
     signal sent is dependent on the timer being used; *note
     signal.ITIMER_REAL: 26d0. will deliver ‘SIGALRM’, *note
     signal.ITIMER_VIRTUAL: 26d1. sends ‘SIGVTALRM’, and *note
     signal.ITIMER_PROF: 26d2. will deliver ‘SIGPROF’.

     The old values are returned as a tuple: (delay, interval).

     Attempting to pass an invalid interval timer will cause an *note
     ItimerError: 26d3.

     *note Availability: 129a.: Unix.

 -- Function: signal.getitimer (which)

     Returns current value of a given interval timer specified by
     `which'.

     *note Availability: 129a.: Unix.

 -- Function: signal.set_wakeup_fd (fd, *, warn_on_full_buffer=True)

     Set the wakeup file descriptor to `fd'.  When a signal is received,
     the signal number is written as a single byte into the fd.  This
     can be used by a library to wakeup a poll or select call, allowing
     the signal to be fully processed.

     The old wakeup fd is returned (or -1 if file descriptor wakeup was
     not enabled).  If `fd' is -1, file descriptor wakeup is disabled.
     If not -1, `fd' must be non-blocking.  It is up to the library to
     remove any bytes from `fd' before calling poll or select again.

     When threads are enabled, this function can only be called from the
     main thread; attempting to call it from other threads will cause a
     *note ValueError: 1f9. exception to be raised.

     There are two common ways to use this function.  In both
     approaches, you use the fd to wake up when a signal arrives, but
     then they differ in how they determine `which' signal or signals
     have arrived.

     In the first approach, we read the data out of the fd’s buffer, and
     the byte values give you the signal numbers.  This is simple, but
     in rare cases it can run into a problem: generally the fd will have
     a limited amount of buffer space, and if too many signals arrive
     too quickly, then the buffer may become full, and some signals may
     be lost.  If you use this approach, then you should set
     ‘warn_on_full_buffer=True’, which will at least cause a warning to
     be printed to stderr when signals are lost.

     In the second approach, we use the wakeup fd `only' for wakeups,
     and ignore the actual byte values.  In this case, all we care about
     is whether the fd’s buffer is empty or non-empty; a full buffer
     doesn’t indicate a problem at all.  If you use this approach, then
     you should set ‘warn_on_full_buffer=False’, so that your users are
     not confused by spurious warning messages.

     Changed in version 3.5: On Windows, the function now also supports
     socket handles.

     Changed in version 3.7: Added ‘warn_on_full_buffer’ parameter.

 -- Function: signal.siginterrupt (signalnum, flag)

     Change system call restart behaviour: if `flag' is *note False:
     37d, system calls will be restarted when interrupted by signal
     `signalnum', otherwise system calls will be interrupted.  Returns
     nothing.

     *note Availability: 129a.: Unix.  See the man page
     ‘siginterrupt(3)’ for further information.

     Note that installing a signal handler with *note signal(): ea. will
     reset the restart behaviour to interruptible by implicitly calling
     ‘siginterrupt()’ with a true `flag' value for the given signal.

 -- Function: signal.signal (signalnum, handler)

     Set the handler for signal `signalnum' to the function `handler'.
     `handler' can be a callable Python object taking two arguments (see
     below), or one of the special values *note signal.SIG_IGN: 2402. or
     *note signal.SIG_DFL: 2401.  The previous signal handler will be
     returned (see the description of *note getsignal(): 26ce. above).
     (See the Unix man page ‘signal(2)’ for further information.)

     When threads are enabled, this function can only be called from the
     main thread; attempting to call it from other threads will cause a
     *note ValueError: 1f9. exception to be raised.

     The `handler' is called with two arguments: the signal number and
     the current stack frame (‘None’ or a frame object; for a
     description of frame objects, see the *note description in the type
     hierarchy: 136e. or see the attribute descriptions in the *note
     inspect: a0. module).

     On Windows, *note signal(): ea. can only be called with ‘SIGABRT’,
     ‘SIGFPE’, ‘SIGILL’, ‘SIGINT’, ‘SIGSEGV’, ‘SIGTERM’, or ‘SIGBREAK’.
     A *note ValueError: 1f9. will be raised in any other case.  Note
     that not all systems define the same set of signal names; an *note
     AttributeError: 390. will be raised if a signal name is not defined
     as ‘SIG*’ module level constant.

 -- Function: signal.sigpending ()

     Examine the set of signals that are pending for delivery to the
     calling thread (i.e., the signals which have been raised while
     blocked).  Return the set of the pending signals.

     *note Availability: 129a.: Unix.  See the man page ‘sigpending(2)’
     for further information.

     See also *note pause(): 26d8, *note pthread_sigmask(): a6e. and
     *note sigwait(): a71.

     New in version 3.3.

 -- Function: signal.sigwait (sigset)

     Suspend execution of the calling thread until the delivery of one
     of the signals specified in the signal set `sigset'.  The function
     accepts the signal (removes it from the pending list of signals),
     and returns the signal number.

     *note Availability: 129a.: Unix.  See the man page ‘sigwait(3)’ for
     further information.

     See also *note pause(): 26d8, *note pthread_sigmask(): a6e, *note
     sigpending(): a70, *note sigwaitinfo(): 673. and *note
     sigtimedwait(): 672.

     New in version 3.3.

 -- Function: signal.sigwaitinfo (sigset)

     Suspend execution of the calling thread until the delivery of one
     of the signals specified in the signal set `sigset'.  The function
     accepts the signal and removes it from the pending list of signals.
     If one of the signals in `sigset' is already pending for the
     calling thread, the function will return immediately with
     information about that signal.  The signal handler is not called
     for the delivered signal.  The function raises an *note
     InterruptedError: 64d. if it is interrupted by a signal that is not
     in `sigset'.

     The return value is an object representing the data contained in
     the ‘siginfo_t’ structure, namely: ‘si_signo’, ‘si_code’,
     ‘si_errno’, ‘si_pid’, ‘si_uid’, ‘si_status’, ‘si_band’.

     *note Availability: 129a.: Unix.  See the man page ‘sigwaitinfo(2)’
     for further information.

     See also *note pause(): 26d8, *note sigwait(): a71. and *note
     sigtimedwait(): 672.

     New in version 3.3.

     Changed in version 3.5: The function is now retried if interrupted
     by a signal not in `sigset' and the signal handler does not raise
     an exception (see PEP 475(1) for the rationale).

 -- Function: signal.sigtimedwait (sigset, timeout)

     Like *note sigwaitinfo(): 673, but takes an additional `timeout'
     argument specifying a timeout.  If `timeout' is specified as ‘0’, a
     poll is performed.  Returns *note None: 157. if a timeout occurs.

     *note Availability: 129a.: Unix.  See the man page
     ‘sigtimedwait(2)’ for further information.

     See also *note pause(): 26d8, *note sigwait(): a71. and *note
     sigwaitinfo(): 673.

     New in version 3.3.

     Changed in version 3.5: The function is now retried with the
     recomputed `timeout' if interrupted by a signal not in `sigset' and
     the signal handler does not raise an exception (see PEP 475(2) for
     the rationale).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0475

   (2) https://www.python.org/dev/peps/pep-0475


File: python.info,  Node: Example<9>,  Next: Note on SIGPIPE,  Prev: Module contents<2>,  Up: signal — Set handlers for asynchronous events

5.19.8.5 Example
................

Here is a minimal example program.  It uses the *note alarm(): 26d6.
function to limit the time spent waiting to open a file; this is useful
if the file is for a serial device that may not be turned on, which
would normally cause the *note os.open(): 659. to hang indefinitely.
The solution is to set a 5-second alarm before opening the file; if the
operation takes too long, the alarm signal will be sent, and the handler
raises an exception.

     import signal, os  def handler(signum, frame):     print('Signal handler called with signal', signum)     raise OSError("Couldn't open device!")  # Set the signal handler and a 5-second alarm signal.signal(signal.SIGALRM, handler) signal.alarm(5)  # This open() may hang indefinitely fd = os.open('/dev/ttyS0', os.O_RDWR)  signal.alarm(0)          # Disable the alarm


File: python.info,  Node: Note on SIGPIPE,  Prev: Example<9>,  Up: signal — Set handlers for asynchronous events

5.19.8.6 Note on SIGPIPE
........................

Piping output of your program to tools like ‘head(1)’ will cause a
‘SIGPIPE’ signal to be sent to your process when the receiver of its
standard output closes early.  This results in an exception like
‘BrokenPipeError: [Errno 32] Broken pipe’.  To handle this case, wrap
your entry point to catch this exception as follows:

     import os import sys  def main():     try:         # simulate large output (your code replaces this loop)         for x in range(10000):             print("y")         # flush output here to force SIGPIPE to be triggered         # while inside this try block.         sys.stdout.flush()     except BrokenPipeError:         # Python flushes standard streams on exit; redirect remaining output         # to devnull to avoid another BrokenPipeError at shutdown         devnull = os.open(os.devnull, os.O_WRONLY)         os.dup2(devnull, sys.stdout.fileno())         sys.exit(1)  # Python exits with error code 1 on EPIPE  if __name__ == '__main__':     main()

Do not set ‘SIGPIPE’’s disposition to *note SIG_DFL: 2401. in order to
avoid *note BrokenPipeError: 991.  Doing that would cause your program
to exit unexpectedly also whenever any socket connection is interrupted
while your program is still writing to it.


File: python.info,  Node: mmap — Memory-mapped file support,  Prev: signal — Set handlers for asynchronous events,  Up: Networking and Interprocess Communication

5.19.9 ‘mmap’ — Memory-mapped file support
------------------------------------------

__________________________________________________________________

Memory-mapped file objects behave like both *note bytearray: 327. and
like *note file objects: b35.  You can use mmap objects in most places
where *note bytearray: 327. are expected; for example, you can use the
*note re: dd. module to search through a memory-mapped file.  You can
also change a single byte by doing ‘obj[index] = 97’, or change a
subsequence by assigning to a slice: ‘obj[i1:i2] = b'...'’.  You can
also read and write data starting at the current file position, and
‘seek()’ through the file to different positions.

A memory-mapped file is created by the *note mmap: 1ea. constructor,
which is different on Unix and on Windows.  In either case you must
provide a file descriptor for a file opened for update.  If you wish to
map an existing Python file object, use its ‘fileno()’ method to obtain
the correct value for the `fileno' parameter.  Otherwise, you can open
the file using the *note os.open(): 659. function, which returns a file
descriptor directly (the file still needs to be closed when done).

     Note: If you want to create a memory-mapping for a writable,
     buffered file, you should *note flush(): 1f2b. the file first.
     This is necessary to ensure that local modifications to the buffers
     are actually available to the mapping.

For both the Unix and Windows versions of the constructor, `access' may
be specified as an optional keyword parameter.  `access' accepts one of
four values: ‘ACCESS_READ’, ‘ACCESS_WRITE’, or ‘ACCESS_COPY’ to specify
read-only, write-through or copy-on-write memory respectively, or
‘ACCESS_DEFAULT’ to defer to `prot'.  `access' can be used on both Unix
and Windows.  If `access' is not specified, Windows mmap returns a
write-through mapping.  The initial memory values for all three access
types are taken from the specified file.  Assignment to an ‘ACCESS_READ’
memory map raises a *note TypeError: 192. exception.  Assignment to an
‘ACCESS_WRITE’ memory map affects both memory and the underlying file.
Assignment to an ‘ACCESS_COPY’ memory map affects memory but does not
update the underlying file.

Changed in version 3.7: Added ‘ACCESS_DEFAULT’ constant.

To map anonymous memory, -1 should be passed as the fileno along with
the length.

 -- Class: mmap.mmap (fileno, length, tagname=None,
          access=ACCESS_DEFAULT[, offset])

     `(Windows version)' Maps `length' bytes from the file specified by
     the file handle `fileno', and creates a mmap object.  If `length'
     is larger than the current size of the file, the file is extended
     to contain `length' bytes.  If `length' is ‘0’, the maximum length
     of the map is the current size of the file, except that if the file
     is empty Windows raises an exception (you cannot create an empty
     mapping on Windows).

     `tagname', if specified and not ‘None’, is a string giving a tag
     name for the mapping.  Windows allows you to have many different
     mappings against the same file.  If you specify the name of an
     existing tag, that tag is opened, otherwise a new tag of this name
     is created.  If this parameter is omitted or ‘None’, the mapping is
     created without a name.  Avoiding the use of the tag parameter will
     assist in keeping your code portable between Unix and Windows.

     `offset' may be specified as a non-negative integer offset.  mmap
     references will be relative to the offset from the beginning of the
     file.  `offset' defaults to 0.  `offset' must be a multiple of the
     ‘ALLOCATIONGRANULARITY’.

     Raises an *note auditing event: 1275. ‘mmap.__new__’ with arguments
     ‘fileno’, ‘length’, ‘access’, ‘offset’.

 -- Class: mmap.mmap (fileno, length, flags=MAP_SHARED,
          prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset])

     `(Unix version)' Maps `length' bytes from the file specified by the
     file descriptor `fileno', and returns a mmap object.  If `length'
     is ‘0’, the maximum length of the map will be the current size of
     the file when *note mmap: 1ea. is called.

     `flags' specifies the nature of the mapping.  ‘MAP_PRIVATE’ creates
     a private copy-on-write mapping, so changes to the contents of the
     mmap object will be private to this process, and ‘MAP_SHARED’
     creates a mapping that’s shared with all other processes mapping
     the same areas of the file.  The default value is ‘MAP_SHARED’.

     `prot', if specified, gives the desired memory protection; the two
     most useful values are ‘PROT_READ’ and ‘PROT_WRITE’, to specify
     that the pages may be read or written.  `prot' defaults to
     ‘PROT_READ | PROT_WRITE’.

     `access' may be specified in lieu of `flags' and `prot' as an
     optional keyword parameter.  It is an error to specify both
     `flags', `prot' and `access'.  See the description of `access'
     above for information on how to use this parameter.

     `offset' may be specified as a non-negative integer offset.  mmap
     references will be relative to the offset from the beginning of the
     file.  `offset' defaults to 0.  `offset' must be a multiple of
     ‘ALLOCATIONGRANULARITY’ which is equal to ‘PAGESIZE’ on Unix
     systems.

     To ensure validity of the created memory mapping the file specified
     by the descriptor `fileno' is internally automatically synchronized
     with physical backing store on Mac OS X and OpenVMS.

     This example shows a simple way of using *note mmap: 1ea.:

          import mmap  # write a simple example file with open("hello.txt", "wb") as f:     f.write(b"Hello Python!\n")  with open("hello.txt", "r+b") as f:     # memory-map the file, size 0 means whole file     mm = mmap.mmap(f.fileno(), 0)     # read content via standard file methods     print(mm.readline())  # prints b"Hello Python!\n"     # read content via slice notation     print(mm[:5])  # prints b"Hello"     # update content using slice notation;     # note that new content must have same size     mm[6:] = b" world!\n"     # ... and read again using standard file methods     mm.seek(0)     print(mm.readline())  # prints b"Hello  world!\n"     # close the map     mm.close()

     *note mmap: 1ea. can also be used as a context manager in a *note
     with: 6dd. statement:

          import mmap  with mmap.mmap(-1, 13) as mm:     mm.write(b"Hello world!")

     New in version 3.2: Context manager support.

     The next example demonstrates how to create an anonymous map and
     exchange data between the parent and child processes:

          import mmap import os  mm = mmap.mmap(-1, 13) mm.write(b"Hello world!")  pid = os.fork()  if pid == 0:  # In a child process     mm.seek(0)     print(mm.readline())      mm.close()

     Raises an *note auditing event: 1275. ‘mmap.__new__’ with arguments
     ‘fileno’, ‘length’, ‘access’, ‘offset’.

     Memory-mapped file objects support the following methods:

      -- Method: close ()

          Closes the mmap.  Subsequent calls to other methods of the
          object will result in a ValueError exception being raised.
          This will not close the open file.

      -- Attribute: closed

          ‘True’ if the file is closed.

          New in version 3.2.

      -- Method: find (sub[, start[, end]])

          Returns the lowest index in the object where the subsequence
          `sub' is found, such that `sub' is contained in the range
          [`start', `end'].  Optional arguments `start' and `end' are
          interpreted as in slice notation.  Returns ‘-1’ on failure.

          Changed in version 3.5: Writable *note bytes-like object: 5dd.
          is now accepted.

      -- Method: flush ([offset[, size]])

          Flushes changes made to the in-memory copy of a file back to
          disk.  Without use of this call there is no guarantee that
          changes are written back before the object is destroyed.  If
          `offset' and `size' are specified, only changes to the given
          range of bytes will be flushed to disk; otherwise, the whole
          extent of the mapping is flushed.  `offset' must be a multiple
          of the ‘PAGESIZE’ or ‘ALLOCATIONGRANULARITY’.

          ‘None’ is returned to indicate success.  An exception is
          raised when the call failed.

          Changed in version 3.8: Previously, a nonzero value was
          returned on success; zero was returned on error under Windows.
          A zero value was returned on success; an exception was raised
          on error under Unix.

      -- Method: madvise (option[, start[, length]])

          Send advice `option' to the kernel about the memory region
          beginning at `start' and extending `length' bytes.  `option'
          must be one of the *note MADV_* constants: 26e2. available on
          the system.  If `start' and `length' are omitted, the entire
          mapping is spanned.  On some systems (including Linux),
          `start' must be a multiple of the ‘PAGESIZE’.

          Availability: Systems with the ‘madvise()’ system call.

          New in version 3.8.

      -- Method: move (dest, src, count)

          Copy the `count' bytes starting at offset `src' to the
          destination index `dest'.  If the mmap was created with
          ‘ACCESS_READ’, then calls to move will raise a *note
          TypeError: 192. exception.

      -- Method: read ([n])

          Return a *note bytes: 326. containing up to `n' bytes starting
          from the current file position.  If the argument is omitted,
          ‘None’ or negative, return all bytes from the current file
          position to the end of the mapping.  The file position is
          updated to point after the bytes that were returned.

          Changed in version 3.3: Argument can be omitted or ‘None’.

      -- Method: read_byte ()

          Returns a byte at the current file position as an integer, and
          advances the file position by 1.

      -- Method: readline ()

          Returns a single line, starting at the current file position
          and up to the next newline.

      -- Method: resize (newsize)

          Resizes the map and the underlying file, if any.  If the mmap
          was created with ‘ACCESS_READ’ or ‘ACCESS_COPY’, resizing the
          map will raise a *note TypeError: 192. exception.

      -- Method: rfind (sub[, start[, end]])

          Returns the highest index in the object where the subsequence
          `sub' is found, such that `sub' is contained in the range
          [`start', `end'].  Optional arguments `start' and `end' are
          interpreted as in slice notation.  Returns ‘-1’ on failure.

          Changed in version 3.5: Writable *note bytes-like object: 5dd.
          is now accepted.

      -- Method: seek (pos[, whence])

          Set the file’s current position.  `whence' argument is
          optional and defaults to ‘os.SEEK_SET’ or ‘0’ (absolute file
          positioning); other values are ‘os.SEEK_CUR’ or ‘1’ (seek
          relative to the current position) and ‘os.SEEK_END’ or ‘2’
          (seek relative to the file’s end).

      -- Method: size ()

          Return the length of the file, which can be larger than the
          size of the memory-mapped area.

      -- Method: tell ()

          Returns the current position of the file pointer.

      -- Method: write (bytes)

          Write the bytes in `bytes' into memory at the current position
          of the file pointer and return the number of bytes written
          (never less than ‘len(bytes)’, since if the write fails, a
          *note ValueError: 1f9. will be raised).  The file position is
          updated to point after the bytes that were written.  If the
          mmap was created with ‘ACCESS_READ’, then writing to it will
          raise a *note TypeError: 192. exception.

          Changed in version 3.5: Writable *note bytes-like object: 5dd.
          is now accepted.

          Changed in version 3.6: The number of bytes written is now
          returned.

      -- Method: write_byte (byte)

          Write the integer `byte' into memory at the current position
          of the file pointer; the file position is advanced by ‘1’.  If
          the mmap was created with ‘ACCESS_READ’, then writing to it
          will raise a *note TypeError: 192. exception.

* Menu:

* MADV_* Constants::


File: python.info,  Node: MADV_* Constants,  Up: mmap — Memory-mapped file support

5.19.9.1 MADV_* Constants
.........................

 -- Data: mmap.MADV_NORMAL
 -- Data: mmap.MADV_RANDOM
 -- Data: mmap.MADV_SEQUENTIAL
 -- Data: mmap.MADV_WILLNEED
 -- Data: mmap.MADV_DONTNEED
 -- Data: mmap.MADV_REMOVE
 -- Data: mmap.MADV_DONTFORK
 -- Data: mmap.MADV_DOFORK
 -- Data: mmap.MADV_HWPOISON
 -- Data: mmap.MADV_MERGEABLE
 -- Data: mmap.MADV_UNMERGEABLE
 -- Data: mmap.MADV_SOFT_OFFLINE
 -- Data: mmap.MADV_HUGEPAGE
 -- Data: mmap.MADV_NOHUGEPAGE
 -- Data: mmap.MADV_DONTDUMP
 -- Data: mmap.MADV_DODUMP
 -- Data: mmap.MADV_FREE
 -- Data: mmap.MADV_NOSYNC
 -- Data: mmap.MADV_AUTOSYNC
 -- Data: mmap.MADV_NOCORE
 -- Data: mmap.MADV_CORE
 -- Data: mmap.MADV_PROTECT

     These options can be passed to *note mmap.madvise(): 1eb.  Not
     every option will be present on every system.

     Availability: Systems with the madvise() system call.

     New in version 3.8.


File: python.info,  Node: Internet Data Handling,  Next: Structured Markup Processing Tools,  Prev: Networking and Interprocess Communication,  Up: The Python Standard Library

5.20 Internet Data Handling
===========================

This chapter describes modules which support handling data formats
commonly used on the Internet.

* Menu:

* email — An email and MIME handling package::
* json — JSON encoder and decoder::
* mailcap — Mailcap file handling::
* mailbox — Manipulate mailboxes in various formats::
* mimetypes — Map filenames to MIME types::
* base64 — Base16, Base32, Base64, Base85 Data Encodings: base64 — Base16 Base32 Base64 Base85 Data Encodings.
* binhex — Encode and decode binhex4 files::
* binascii — Convert between binary and ASCII::
* quopri — Encode and decode MIME quoted-printable data::
* uu — Encode and decode uuencode files::


File: python.info,  Node: email — An email and MIME handling package,  Next: json — JSON encoder and decoder,  Up: Internet Data Handling

5.20.1 ‘email’ — An email and MIME handling package
---------------------------------------------------

`Source code:' Lib/email/__init__.py(1)

__________________________________________________________________

The *note email: 69. package is a library for managing email messages.
It is specifically `not' designed to do any sending of email messages to
SMTP ( RFC 2821(2)), NNTP, or other servers; those are functions of
modules such as *note smtplib: ed. and *note nntplib: c0.  The *note
email: 69. package attempts to be as RFC-compliant as possible,
supporting RFC 5233(3) and RFC 6532(4), as well as such MIME-related
RFCs as RFC 2045(5), RFC 2046(6), RFC 2047(7), RFC 2183(8), and RFC
2231(9).

The overall structure of the email package can be divided into three
major components, plus a fourth component that controls the behavior of
the other components.

The central component of the package is an “object model” that
represents email messages.  An application interacts with the package
primarily through the object model interface defined in the *note
message: 72. sub-module.  The application can use this API to ask
questions about an existing email, to construct a new email, or to add
or remove email subcomponents that themselves use the same object model
interface.  That is, following the nature of email messages and their
MIME subcomponents, the email object model is a tree structure of
objects that all provide the *note EmailMessage: 537. API.

The other two major components of the package are the *note parser: 74.
and the *note generator: 6e.  The parser takes the serialized version of
an email message (a stream of bytes) and converts it into a tree of
*note EmailMessage: 537. objects.  The generator takes an *note
EmailMessage: 537. and turns it back into a serialized byte stream.
(The parser and generator also handle streams of text characters, but
this usage is discouraged as it is too easy to end up with messages that
are not valid in one way or another.)

The control component is the *note policy: 75. module.  Every *note
EmailMessage: 537, every *note generator: 6e, and every *note parser:
74. has an associated *note policy: 75. object that controls its
behavior.  Usually an application only needs to specify the policy when
an *note EmailMessage: 537. is created, either by directly instantiating
an *note EmailMessage: 537. to create a new email, or by parsing an
input stream using a *note parser: 74.  But the policy can be changed
when the message is serialized using a *note generator: 6e.  This
allows, for example, a generic email message to be parsed from disk, but
to serialize it using standard SMTP settings when sending it to an email
server.

The email package does its best to hide the details of the various
governing RFCs from the application.  Conceptually the application
should be able to treat the email message as a structured tree of
unicode text and binary attachments, without having to worry about how
these are represented when serialized.  In practice, however, it is
often necessary to be aware of at least some of the rules governing MIME
messages and their structure, specifically the names and nature of the
MIME “content types” and how they identify multipart documents.  For the
most part this knowledge should only be required for more complex
applications, and even then it should only be the high level structure
in question, and not the details of how those structures are
represented.  Since MIME content types are used widely in modern
internet software (not just email), this will be a familiar concept to
many programmers.

The following sections describe the functionality of the *note email:
69. package.  We start with the *note message: 72. object model, which
is the primary interface an application will use, and follow that with
the *note parser: 74. and *note generator: 6e. components.  Then we
cover the *note policy: 75. controls, which completes the treatment of
the main components of the library.

The next three sections cover the exceptions the package may raise and
the defects (non-compliance with the RFCs) that the *note parser: 74.
may detect.  Then we cover the *note headerregistry: 70. and the *note
contentmanager: 6b. sub-components, which provide tools for doing more
detailed manipulation of headers and payloads, respectively.  Both of
these components contain features relevant to consuming and producing
non-trivial messages, but also document their extensibility APIs, which
will be of interest to advanced applications.

Following those is a set of examples of using the fundamental parts of
the APIs covered in the preceding sections.

The foregoing represent the modern (unicode friendly) API of the email
package.  The remaining sections, starting with the *note Message: 536.
class, cover the legacy *note compat32: 535. API that deals much more
directly with the details of how email messages are represented.  The
*note compat32: 535. API does `not' hide the details of the RFCs from
the application, but for applications that need to operate at that
level, they can be useful tools.  This documentation is also relevant
for applications that are still using the *note compat32: 535. API for
backward compatibility reasons.

Changed in version 3.6: Docs reorganized and rewritten to promote the
new *note EmailMessage: 537./*note EmailPolicy: 9ec. API.

Contents of the *note email: 69. package documentation:

* Menu:

* email.message; Representing an email message: email message Representing an email message.
* email.parser; Parsing email messages: email parser Parsing email messages.
* email.generator; Generating MIME documents: email generator Generating MIME documents.
* email.policy; Policy Objects: email policy Policy Objects.
* email.errors; Exception and Defect classes: email errors Exception and Defect classes.
* email.headerregistry; Custom Header Objects: email headerregistry Custom Header Objects.
* email.contentmanager; Managing MIME Content: email contentmanager Managing MIME Content.
* email; Examples: email Examples.
* email.message.Message; Representing an email message using the compat32 API: email message Message Representing an email message using the compat32 API.
* email.mime; Creating email and MIME objects from scratch: email mime Creating email and MIME objects from scratch.
* email.header; Internationalized headers: email header Internationalized headers.
* email.charset; Representing character sets: email charset Representing character sets.
* email.encoders; Encoders: email encoders Encoders.
* email.utils; Miscellaneous utilities: email utils Miscellaneous utilities.
* email.iterators; Iterators: email iterators Iterators.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/__init__.py

   (2) https://tools.ietf.org/html/rfc2821.html

   (3) https://tools.ietf.org/html/rfc5233.html

   (4) https://tools.ietf.org/html/rfc6532.html

   (5) https://tools.ietf.org/html/rfc2045.html

   (6) https://tools.ietf.org/html/rfc2046.html

   (7) https://tools.ietf.org/html/rfc2047.html

   (8) https://tools.ietf.org/html/rfc2183.html

   (9) https://tools.ietf.org/html/rfc2231.html


File: python.info,  Node: email message Representing an email message,  Next: email parser Parsing email messages,  Up: email — An email and MIME handling package

5.20.1.1 ‘email.message’: Representing an email message
.......................................................

`Source code:' Lib/email/message.py(1)

__________________________________________________________________

New in version 3.6: (2)

The central class in the *note email: 69. package is the *note
EmailMessage: 537. class, imported from the *note email.message: 72.
module.  It is the base class for the *note email: 69. object model.
*note EmailMessage: 537. provides the core functionality for setting and
querying header fields, for accessing message bodies, and for creating
or modifying structured messages.

An email message consists of `headers' and a `payload' (which is also
referred to as the `content').  Headers are RFC 5322(3) or RFC 6532(4)
style field names and values, where the field name and value are
separated by a colon.  The colon is not part of either the field name or
the field value.  The payload may be a simple text message, or a binary
object, or a structured sequence of sub-messages each with their own set
of headers and their own payload.  The latter type of payload is
indicated by the message having a MIME type such as ‘multipart/*’ or
‘message/rfc822’.

The conceptual model provided by an *note EmailMessage: 537. object is
that of an ordered dictionary of headers coupled with a `payload' that
represents the RFC 5322(5) body of the message, which might be a list of
sub-‘EmailMessage’ objects.  In addition to the normal dictionary
methods for accessing the header names and values, there are methods for
accessing specialized information from the headers (for example the MIME
content type), for operating on the payload, for generating a serialized
version of the message, and for recursively walking over the object
tree.

The *note EmailMessage: 537. dictionary-like interface is indexed by the
header names, which must be ASCII values.  The values of the dictionary
are strings with some extra methods.  Headers are stored and returned in
case-preserving form, but field names are matched case-insensitively.
Unlike a real dict, there is an ordering to the keys, and there can be
duplicate keys.  Additional methods are provided for working with
headers that have duplicate keys.

The `payload' is either a string or bytes object, in the case of simple
message objects, or a list of *note EmailMessage: 537. objects, for MIME
container documents such as ‘multipart/*’ and ‘message/rfc822’ message
objects.

 -- Class: email.message.EmailMessage (policy=default)

     If `policy' is specified use the rules it specifies to update and
     serialize the representation of the message.  If `policy' is not
     set, use the *note default: 270c. policy, which follows the rules
     of the email RFCs except for line endings (instead of the RFC
     mandated ‘\r\n’, it uses the Python standard ‘\n’ line endings).
     For more information see the *note policy: 75. documentation.

      -- Method: as_string (unixfrom=False, maxheaderlen=None,
               policy=None)

          Return the entire message flattened as a string.  When
          optional `unixfrom' is true, the envelope header is included
          in the returned string.  `unixfrom' defaults to ‘False’.  For
          backward compatibility with the base *note Message: 536. class
          `maxheaderlen' is accepted, but defaults to ‘None’, which
          means that by default the line length is controlled by the
          ‘max_line_length’ of the policy.  The `policy' argument may be
          used to override the default policy obtained from the message
          instance.  This can be used to control some of the formatting
          produced by the method, since the specified `policy' will be
          passed to the *note Generator: b3f.

          Flattening the message may trigger changes to the *note
          EmailMessage: 537. if defaults need to be filled in to
          complete the transformation to a string (for example, MIME
          boundaries may be generated or modified).

          Note that this method is provided as a convenience and may not
          be the most useful way to serialize messages in your
          application, especially if you are dealing with multiple
          messages.  See *note email.generator.Generator: b3f. for a
          more flexible API for serializing messages.  Note also that
          this method is restricted to producing messages serialized as
          “7 bit clean” when *note utf8: 6c6. is ‘False’, which is the
          default.

          Changed in version 3.6: the default behavior when
          `maxheaderlen' is not specified was changed from defaulting to
          0 to defaulting to the value of `max_line_length' from the
          policy.

      -- Method: __str__ ()

          Equivalent to
          ‘as_string(policy=self.policy.clone(utf8=True))’.  Allows
          ‘str(msg)’ to produce a string containing the serialized
          message in a readable format.

          Changed in version 3.4: the method was changed to use
          ‘utf8=True’, thus producing an RFC 6531(6)-like message
          representation, instead of being a direct alias for *note
          as_string(): 270d.

      -- Method: as_bytes (unixfrom=False, policy=None)

          Return the entire message flattened as a bytes object.  When
          optional `unixfrom' is true, the envelope header is included
          in the returned string.  `unixfrom' defaults to ‘False’.  The
          `policy' argument may be used to override the default policy
          obtained from the message instance.  This can be used to
          control some of the formatting produced by the method, since
          the specified `policy' will be passed to the *note
          BytesGenerator: b40.

          Flattening the message may trigger changes to the *note
          EmailMessage: 537. if defaults need to be filled in to
          complete the transformation to a string (for example, MIME
          boundaries may be generated or modified).

          Note that this method is provided as a convenience and may not
          be the most useful way to serialize messages in your
          application, especially if you are dealing with multiple
          messages.  See *note email.generator.BytesGenerator: b40. for
          a more flexible API for serializing messages.

      -- Method: __bytes__ ()

          Equivalent to *note as_bytes(): 270f.  Allows ‘bytes(msg)’ to
          produce a bytes object containing the serialized message.

      -- Method: is_multipart ()

          Return ‘True’ if the message’s payload is a list of sub-*note
          EmailMessage: 537. objects, otherwise return ‘False’.  When
          *note is_multipart(): 2711. returns ‘False’, the payload
          should be a string object (which might be a CTE encoded binary
          payload).  Note that *note is_multipart(): 2711. returning
          ‘True’ does not necessarily mean that
          “msg.get_content_maintype() == ‘multipart’” will return the
          ‘True’.  For example, ‘is_multipart’ will return ‘True’ when
          the *note EmailMessage: 537. is of type ‘message/rfc822’.

      -- Method: set_unixfrom (unixfrom)

          Set the message’s envelope header to `unixfrom', which should
          be a string.  (See *note mboxMessage: 2713. for a brief
          description of this header.)

      -- Method: get_unixfrom ()

          Return the message’s envelope header.  Defaults to ‘None’ if
          the envelope header was never set.

     The following methods implement the mapping-like interface for
     accessing the message’s headers.  Note that there are some semantic
     differences between these methods and a normal mapping (i.e.
     dictionary) interface.  For example, in a dictionary there are no
     duplicate keys, but here there may be duplicate message headers.
     Also, in dictionaries there is no guaranteed order to the keys
     returned by *note keys(): 2715, but in an *note EmailMessage: 537.
     object, headers are always returned in the order they appeared in
     the original message, or in which they were added to the message
     later.  Any header deleted and then re-added is always appended to
     the end of the header list.

     These semantic differences are intentional and are biased toward
     convenience in the most common use cases.

     Note that in all cases, any envelope header present in the message
     is not included in the mapping interface.

      -- Method: __len__ ()

          Return the total number of headers, including duplicates.

      -- Method: __contains__ (name)

          Return ‘True’ if the message object has a field named `name'.
          Matching is done without regard to case and `name' does not
          include the trailing colon.  Used for the ‘in’ operator.  For
          example:

               if 'message-id' in myMessage:    print('Message-ID:', myMessage['message-id'])

      -- Method: __getitem__ (name)

          Return the value of the named header field.  `name' does not
          include the colon field separator.  If the header is missing,
          ‘None’ is returned; a *note KeyError: 2c5. is never raised.

          Note that if the named field appears more than once in the
          message’s headers, exactly which of those field values will be
          returned is undefined.  Use the *note get_all(): 2719. method
          to get the values of all the extant headers named `name'.

          Using the standard (non-‘compat32’) policies, the returned
          value is an instance of a subclass of *note
          email.headerregistry.BaseHeader: 271a.

      -- Method: __setitem__ (name, val)

          Add a header to the message with field name `name' and value
          `val'.  The field is appended to the end of the message’s
          existing headers.

          Note that this does `not' overwrite or delete any existing
          header with the same name.  If you want to ensure that the new
          header is the only one present in the message with field name
          `name', delete the field first, e.g.:

               del msg['subject'] msg['subject'] = 'Python roolz!'

          If the ‘policy’ defines certain headers to be unique (as the
          standard policies do), this method may raise a *note
          ValueError: 1f9. when an attempt is made to assign a value to
          such a header when one already exists.  This behavior is
          intentional for consistency’s sake, but do not depend on it as
          we may choose to make such assignments do an automatic
          deletion of the existing header in the future.

      -- Method: __delitem__ (name)

          Delete all occurrences of the field with name `name' from the
          message’s headers.  No exception is raised if the named field
          isn’t present in the headers.

      -- Method: keys ()

          Return a list of all the message’s header field names.

      -- Method: values ()

          Return a list of all the message’s field values.

      -- Method: items ()

          Return a list of 2-tuples containing all the message’s field
          headers and values.

      -- Method: get (name, failobj=None)

          Return the value of the named header field.  This is identical
          to *note __getitem__(): 2718. except that optional `failobj'
          is returned if the named header is missing (`failobj' defaults
          to ‘None’).

     Here are some additional useful header related methods:

      -- Method: get_all (name, failobj=None)

          Return a list of all the values for the field named `name'.
          If there are no such named headers in the message, `failobj'
          is returned (defaults to ‘None’).

      -- Method: add_header (_name, _value, **_params)

          Extended header setting.  This method is similar to *note
          __setitem__(): 271b. except that additional header parameters
          can be provided as keyword arguments.  `_name' is the header
          field to add and `_value' is the `primary' value for the
          header.

          For each item in the keyword argument dictionary `_params',
          the key is taken as the parameter name, with underscores
          converted to dashes (since dashes are illegal in Python
          identifiers).  Normally, the parameter will be added as
          ‘key="value"’ unless the value is ‘None’, in which case only
          the key will be added.

          If the value contains non-ASCII characters, the charset and
          language may be explicitly controlled by specifying the value
          as a three tuple in the format ‘(CHARSET, LANGUAGE, VALUE)’,
          where ‘CHARSET’ is a string naming the charset to be used to
          encode the value, ‘LANGUAGE’ can usually be set to ‘None’ or
          the empty string (see RFC 2231(7) for other possibilities),
          and ‘VALUE’ is the string value containing non-ASCII code
          points.  If a three tuple is not passed and the value contains
          non-ASCII characters, it is automatically encoded in RFC
          2231(8) format using a ‘CHARSET’ of ‘utf-8’ and a ‘LANGUAGE’
          of ‘None’.

          Here is an example:

               msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')

          This will add a header that looks like

               Content-Disposition: attachment; filename="bud.gif"

          An example of the extended interface with non-ASCII
          characters:

               msg.add_header('Content-Disposition', 'attachment',                filename=('iso-8859-1', '', 'Fußballer.ppt'))

      -- Method: replace_header (_name, _value)

          Replace a header.  Replace the first header found in the
          message that matches `_name', retaining header order and field
          name case of the original header.  If no matching header is
          found, raise a *note KeyError: 2c5.

      -- Method: get_content_type ()

          Return the message’s content type, coerced to lower case of
          the form ‘maintype/subtype’.  If there is no ‘Content-Type’
          header in the message return the value returned by *note
          get_default_type(): 2723.  If the ‘Content-Type’ header is
          invalid, return ‘text/plain’.

          (According to RFC 2045(9), messages always have a default
          type, *note get_content_type(): 2722. will always return a
          value.  RFC 2045(10) defines a message’s default type to be
          ‘text/plain’ unless it appears inside a ‘multipart/digest’
          container, in which case it would be ‘message/rfc822’.  If the
          ‘Content-Type’ header has an invalid type specification, RFC
          2045(11) mandates that the default type be ‘text/plain’.)

      -- Method: get_content_maintype ()

          Return the message’s main content type.  This is the
          ‘maintype’ part of the string returned by *note
          get_content_type(): 2722.

      -- Method: get_content_subtype ()

          Return the message’s sub-content type.  This is the ‘subtype’
          part of the string returned by *note get_content_type(): 2722.

      -- Method: get_default_type ()

          Return the default content type.  Most messages have a default
          content type of ‘text/plain’, except for messages that are
          subparts of ‘multipart/digest’ containers.  Such subparts have
          a default content type of ‘message/rfc822’.

      -- Method: set_default_type (ctype)

          Set the default content type.  `ctype' should either be
          ‘text/plain’ or ‘message/rfc822’, although this is not
          enforced.  The default content type is not stored in the
          ‘Content-Type’ header, so it only affects the return value of
          the ‘get_content_type’ methods when no ‘Content-Type’ header
          is present in the message.

      -- Method: set_param (param, value, header='Content-Type',
               requote=True, charset=None, language='', replace=False)

          Set a parameter in the ‘Content-Type’ header.  If the
          parameter already exists in the header, replace its value with
          `value'.  When `header' is ‘Content-Type’ (the default) and
          the header does not yet exist in the message, add it, set its
          value to ‘text/plain’, and append the new parameter value.
          Optional `header' specifies an alternative header to
          ‘Content-Type’.

          If the value contains non-ASCII characters, the charset and
          language may be explicitly specified using the optional
          `charset' and `language' parameters.  Optional `language'
          specifies the RFC 2231(12) language, defaulting to the empty
          string.  Both `charset' and `language' should be strings.  The
          default is to use the ‘utf8’ `charset' and ‘None’ for the
          `language'.

          If `replace' is ‘False’ (the default) the header is moved to
          the end of the list of headers.  If `replace' is ‘True’, the
          header will be updated in place.

          Use of the `requote' parameter with *note EmailMessage: 537.
          objects is deprecated.

          Note that existing parameter values of headers may be accessed
          through the ‘params’ attribute of the header value (for
          example, ‘msg['Content-Type'].params['charset']’).

          Changed in version 3.4: ‘replace’ keyword was added.

      -- Method: del_param (param, header='content-type', requote=True)

          Remove the given parameter completely from the ‘Content-Type’
          header.  The header will be re-written in place without the
          parameter or its value.  Optional `header' specifies an
          alternative to ‘Content-Type’.

          Use of the `requote' parameter with *note EmailMessage: 537.
          objects is deprecated.

      -- Method: get_filename (failobj=None)

          Return the value of the ‘filename’ parameter of the
          ‘Content-Disposition’ header of the message.  If the header
          does not have a ‘filename’ parameter, this method falls back
          to looking for the ‘name’ parameter on the ‘Content-Type’
          header.  If neither is found, or the header is missing, then
          `failobj' is returned.  The returned string will always be
          unquoted as per *note email.utils.unquote(): 272a.

      -- Method: get_boundary (failobj=None)

          Return the value of the ‘boundary’ parameter of the
          ‘Content-Type’ header of the message, or `failobj' if either
          the header is missing, or has no ‘boundary’ parameter.  The
          returned string will always be unquoted as per *note
          email.utils.unquote(): 272a.

      -- Method: set_boundary (boundary)

          Set the ‘boundary’ parameter of the ‘Content-Type’ header to
          `boundary'.  *note set_boundary(): 272c. will always quote
          `boundary' if necessary.  A *note HeaderParseError: 272d. is
          raised if the message object has no ‘Content-Type’ header.

          Note that using this method is subtly different from deleting
          the old ‘Content-Type’ header and adding a new one with the
          new boundary via *note add_header(): 2720, because *note
          set_boundary(): 272c. preserves the order of the
          ‘Content-Type’ header in the list of headers.

      -- Method: get_content_charset (failobj=None)

          Return the ‘charset’ parameter of the ‘Content-Type’ header,
          coerced to lower case.  If there is no ‘Content-Type’ header,
          or if that header has no ‘charset’ parameter, `failobj' is
          returned.

      -- Method: get_charsets (failobj=None)

          Return a list containing the character set names in the
          message.  If the message is a ‘multipart’, then the list will
          contain one element for each subpart in the payload,
          otherwise, it will be a list of length 1.

          Each item in the list will be a string which is the value of
          the ‘charset’ parameter in the ‘Content-Type’ header for the
          represented subpart.  If the subpart has no ‘Content-Type’
          header, no ‘charset’ parameter, or is not of the ‘text’ main
          MIME type, then that item in the returned list will be
          `failobj'.

      -- Method: is_attachment ()

          Return ‘True’ if there is a ‘Content-Disposition’ header and
          its (case insensitive) value is ‘attachment’, ‘False’
          otherwise.

          Changed in version 3.4.2: is_attachment is now a method
          instead of a property, for consistency with *note
          is_multipart(): 2731.

      -- Method: get_content_disposition ()

          Return the lowercased value (without parameters) of the
          message’s ‘Content-Disposition’ header if it has one, or
          ‘None’.  The possible values for this method are `inline',
          `attachment' or ‘None’ if the message follows RFC 2183(13).

          New in version 3.5.

     The following methods relate to interrogating and manipulating the
     content (payload) of the message.

      -- Method: walk ()

          The *note walk(): 2733. method is an all-purpose generator
          which can be used to iterate over all the parts and subparts
          of a message object tree, in depth-first traversal order.  You
          will typically use *note walk(): 2733. as the iterator in a
          ‘for’ loop; each iteration returns the next subpart.

          Here’s an example that prints the MIME type of every part of a
          multipart message structure:

               >>> for part in msg.walk(): ...     print(part.get_content_type()) multipart/report text/plain message/delivery-status text/plain text/plain message/rfc822 text/plain

          ‘walk’ iterates over the subparts of any part where *note
          is_multipart(): 2711. returns ‘True’, even though
          ‘msg.get_content_maintype() == 'multipart'’ may return
          ‘False’.  We can see this in our example by making use of the
          ‘_structure’ debug helper function:

               >>> from email.iterators import _structure >>> for part in msg.walk(): ...     print(part.get_content_maintype() == 'multipart', ...           part.is_multipart()) True True False False False True False False False False False True False False >>> _structure(msg) multipart/report     text/plain     message/delivery-status         text/plain         text/plain     message/rfc822         text/plain

          Here the ‘message’ parts are not ‘multiparts’, but they do
          contain subparts.  ‘is_multipart()’ returns ‘True’ and ‘walk’
          descends into the subparts.

      -- Method: get_body (preferencelist=('related', 'html', 'plain'))

          Return the MIME part that is the best candidate to be the
          “body” of the message.

          `preferencelist' must be a sequence of strings from the set
          ‘related’, ‘html’, and ‘plain’, and indicates the order of
          preference for the content type of the part returned.

          Start looking for candidate matches with the object on which
          the ‘get_body’ method is called.

          If ‘related’ is not included in `preferencelist', consider the
          root part (or subpart of the root part) of any related
          encountered as a candidate if the (sub-)part matches a
          preference.

          When encountering a ‘multipart/related’, check the ‘start’
          parameter and if a part with a matching ‘Content-ID’ is found,
          consider only it when looking for candidate matches.
          Otherwise consider only the first (default root) part of the
          ‘multipart/related’.

          If a part has a ‘Content-Disposition’ header, only consider
          the part a candidate match if the value of the header is
          ‘inline’.

          If none of the candidates matches any of the preferences in
          `preferencelist', return ‘None’.

          Notes: (1) For most applications the only `preferencelist'
          combinations that really make sense are ‘('plain',)’,
          ‘('html', 'plain')’, and the default ‘('related', 'html',
          'plain')’.  (2) Because matching starts with the object on
          which ‘get_body’ is called, calling ‘get_body’ on a
          ‘multipart/related’ will return the object itself unless
          `preferencelist' has a non-default value.  (3) Messages (or
          message parts) that do not specify a ‘Content-Type’ or whose
          ‘Content-Type’ header is invalid will be treated as if they
          are of type ‘text/plain’, which may occasionally cause
          ‘get_body’ to return unexpected results.

      -- Method: iter_attachments ()

          Return an iterator over all of the immediate sub-parts of the
          message that are not candidate “body” parts.  That is, skip
          the first occurrence of each of ‘text/plain’, ‘text/html’,
          ‘multipart/related’, or ‘multipart/alternative’ (unless they
          are explicitly marked as attachments via ‘Content-Disposition:
          attachment’), and return all remaining parts.  When applied
          directly to a ‘multipart/related’, return an iterator over the
          all the related parts except the root part (ie: the part
          pointed to by the ‘start’ parameter, or the first part if
          there is no ‘start’ parameter or the ‘start’ parameter doesn’t
          match the ‘Content-ID’ of any of the parts).  When applied
          directly to a ‘multipart/alternative’ or a non-‘multipart’,
          return an empty iterator.

      -- Method: iter_parts ()

          Return an iterator over all of the immediate sub-parts of the
          message, which will be empty for a non-‘multipart’.  (See also
          *note walk(): 2733.)

      -- Method: get_content (*args, content_manager=None, **kw)

          Call the *note get_content(): 2738. method of the
          `content_manager', passing self as the message object, and
          passing along any other arguments or keywords as additional
          arguments.  If `content_manager' is not specified, use the
          ‘content_manager’ specified by the current *note policy: 75.

      -- Method: set_content (*args, content_manager=None, **kw)

          Call the *note set_content(): 273a. method of the
          `content_manager', passing self as the message object, and
          passing along any other arguments or keywords as additional
          arguments.  If `content_manager' is not specified, use the
          ‘content_manager’ specified by the current *note policy: 75.

      -- Method: make_related (boundary=None)

          Convert a non-‘multipart’ message into a ‘multipart/related’
          message, moving any existing ‘Content-’ headers and payload
          into a (new) first part of the ‘multipart’.  If `boundary' is
          specified, use it as the boundary string in the multipart,
          otherwise leave the boundary to be automatically created when
          it is needed (for example, when the message is serialized).

      -- Method: make_alternative (boundary=None)

          Convert a non-‘multipart’ or a ‘multipart/related’ into a
          ‘multipart/alternative’, moving any existing ‘Content-’
          headers and payload into a (new) first part of the
          ‘multipart’.  If `boundary' is specified, use it as the
          boundary string in the multipart, otherwise leave the boundary
          to be automatically created when it is needed (for example,
          when the message is serialized).

      -- Method: make_mixed (boundary=None)

          Convert a non-‘multipart’, a ‘multipart/related’, or a
          ‘multipart-alternative’ into a ‘multipart/mixed’, moving any
          existing ‘Content-’ headers and payload into a (new) first
          part of the ‘multipart’.  If `boundary' is specified, use it
          as the boundary string in the multipart, otherwise leave the
          boundary to be automatically created when it is needed (for
          example, when the message is serialized).

      -- Method: add_related (*args, content_manager=None, **kw)

          If the message is a ‘multipart/related’, create a new message
          object, pass all of the arguments to its *note set_content():
          2739. method, and *note attach(): 273f. it to the ‘multipart’.
          If the message is a non-‘multipart’, call *note
          make_related(): 273b. and then proceed as above.  If the
          message is any other type of ‘multipart’, raise a *note
          TypeError: 192.  If `content_manager' is not specified, use
          the ‘content_manager’ specified by the current *note policy:
          75.  If the added part has no ‘Content-Disposition’ header,
          add one with the value ‘inline’.

      -- Method: add_alternative (*args, content_manager=None, **kw)

          If the message is a ‘multipart/alternative’, create a new
          message object, pass all of the arguments to its *note
          set_content(): 2739. method, and *note attach(): 273f. it to
          the ‘multipart’.  If the message is a non-‘multipart’ or
          ‘multipart/related’, call *note make_alternative(): 273c. and
          then proceed as above.  If the message is any other type of
          ‘multipart’, raise a *note TypeError: 192.  If
          `content_manager' is not specified, use the ‘content_manager’
          specified by the current *note policy: 75.

      -- Method: add_attachment (*args, content_manager=None, **kw)

          If the message is a ‘multipart/mixed’, create a new message
          object, pass all of the arguments to its *note set_content():
          2739. method, and *note attach(): 273f. it to the ‘multipart’.
          If the message is a non-‘multipart’, ‘multipart/related’, or
          ‘multipart/alternative’, call *note make_mixed(): 273d. and
          then proceed as above.  If `content_manager' is not specified,
          use the ‘content_manager’ specified by the current *note
          policy: 75.  If the added part has no ‘Content-Disposition’
          header, add one with the value ‘attachment’.  This method can
          be used both for explicit attachments (‘Content-Disposition:
          attachment’) and ‘inline’ attachments (‘Content-Disposition:
          inline’), by passing appropriate options to the
          ‘content_manager’.

      -- Method: clear ()

          Remove the payload and all of the headers.

      -- Method: clear_content ()

          Remove the payload and all of the ‘Content-’ headers, leaving
          all other headers intact and in their original order.

     *note EmailMessage: 537. objects have the following instance
     attributes:

      -- Attribute: preamble

          The format of a MIME document allows for some text between the
          blank line following the headers, and the first multipart
          boundary string.  Normally, this text is never visible in a
          MIME-aware mail reader because it falls outside the standard
          MIME armor.  However, when viewing the raw text of the
          message, or when viewing the message in a non-MIME aware
          reader, this text can become visible.

          The `preamble' attribute contains this leading extra-armor
          text for MIME documents.  When the *note Parser: b0b.
          discovers some text after the headers but before the first
          boundary string, it assigns this text to the message’s
          `preamble' attribute.  When the *note Generator: b3f. is
          writing out the plain text representation of a MIME message,
          and it finds the message has a `preamble' attribute, it will
          write this text in the area between the headers and the first
          boundary.  See *note email.parser: 74. and *note
          email.generator: 6e. for details.

          Note that if the message object has no preamble, the
          `preamble' attribute will be ‘None’.

      -- Attribute: epilogue

          The `epilogue' attribute acts the same way as the `preamble'
          attribute, except that it contains text that appears between
          the last boundary and the end of the message.  As with the
          *note preamble: 2744, if there is no epilog text this
          attribute will be ‘None’.

      -- Attribute: defects

          The `defects' attribute contains a list of all the problems
          found when parsing this message.  See *note email.errors: 6d.
          for a detailed description of the possible parsing defects.

 -- Class: email.message.MIMEPart (policy=default)

     This class represents a subpart of a MIME message.  It is identical
     to *note EmailMessage: 537, except that no ‘MIME-Version’ headers
     are added when *note set_content(): 2739. is called, since
     sub-parts do not need their own ‘MIME-Version’ headers.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/message.py

   (2) (1) Originally added in 3.4 as a *note provisional module: 974.
Docs for legacy message class moved to *note email.message.Message;
Representing an email message using the compat32 API: 270b.

   (3) https://tools.ietf.org/html/rfc5322.html

   (4) https://tools.ietf.org/html/rfc6532.html

   (5) https://tools.ietf.org/html/rfc5322.html

   (6) https://tools.ietf.org/html/rfc6531.html

   (7) https://tools.ietf.org/html/rfc2231.html

   (8) https://tools.ietf.org/html/rfc2231.html

   (9) https://tools.ietf.org/html/rfc2045.html

   (10) https://tools.ietf.org/html/rfc2045.html

   (11) https://tools.ietf.org/html/rfc2045.html

   (12) https://tools.ietf.org/html/rfc2231.html

   (13) https://tools.ietf.org/html/rfc2183.html


File: python.info,  Node: email parser Parsing email messages,  Next: email generator Generating MIME documents,  Prev: email message Representing an email message,  Up: email — An email and MIME handling package

5.20.1.2 ‘email.parser’: Parsing email messages
...............................................

`Source code:' Lib/email/parser.py(1)

__________________________________________________________________

Message object structures can be created in one of two ways: they can be
created from whole cloth by creating an *note EmailMessage: 537. object,
adding headers using the dictionary interface, and adding payload(s)
using *note set_content(): 2739. and related methods, or they can be
created by parsing a serialized representation of the email message.

The *note email: 69. package provides a standard parser that understands
most email document structures, including MIME documents.  You can pass
the parser a bytes, string or file object, and the parser will return to
you the root *note EmailMessage: 537. instance of the object structure.
For simple, non-MIME messages the payload of this root object will
likely be a string containing the text of the message.  For MIME
messages, the root object will return ‘True’ from its *note
is_multipart(): 2711. method, and the subparts can be accessed via the
payload manipulation methods, such as *note get_body(): 2734, *note
iter_parts(): 2736, and *note walk(): 2733.

There are actually two parser interfaces available for use, the *note
Parser: b0b. API and the incremental *note FeedParser: 2749. API. The
*note Parser: b0b. API is most useful if you have the entire text of the
message in memory, or if the entire message lives in a file on the file
system.  *note FeedParser: 2749. is more appropriate when you are
reading the message from a stream which might block waiting for more
input (such as reading an email message from a socket).  The *note
FeedParser: 2749. can consume and parse the message incrementally, and
only returns the root object when you close the parser.

Note that the parser can be extended in limited ways, and of course you
can implement your own parser completely from scratch.  All of the logic
that connects the *note email: 69. package’s bundled parser and the
*note EmailMessage: 537. class is embodied in the ‘policy’ class, so a
custom parser can create message object trees any way it finds necessary
by implementing custom versions of the appropriate ‘policy’ methods.

* Menu:

* FeedParser API::
* Parser API::
* Additional notes::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/parser.py


File: python.info,  Node: FeedParser API,  Next: Parser API,  Up: email parser Parsing email messages

5.20.1.3 FeedParser API
.......................

The *note BytesFeedParser: b3c, imported from the ‘email.feedparser’
module, provides an API that is conducive to incremental parsing of
email messages, such as would be necessary when reading the text of an
email message from a source that can block (such as a socket).  The
*note BytesFeedParser: b3c. can of course be used to parse an email
message fully contained in a *note bytes-like object: 5dd, string, or
file, but the *note BytesParser: b3d. API may be more convenient for
such use cases.  The semantics and results of the two parser APIs are
identical.

The *note BytesFeedParser: b3c.’s API is simple; you create an instance,
feed it a bunch of bytes until there’s no more to feed it, then close
the parser to retrieve the root message object.  The *note
BytesFeedParser: b3c. is extremely accurate when parsing
standards-compliant messages, and it does a very good job of parsing
non-compliant messages, providing information about how a message was
deemed broken.  It will populate a message object’s *note defects: 2746.
attribute with a list of any problems it found in a message.  See the
*note email.errors: 6d. module for the list of defects that it can find.

Here is the API for the *note BytesFeedParser: b3c.:

 -- Class: email.parser.BytesFeedParser (_factory=None, *,
          policy=policy.compat32)

     Create a *note BytesFeedParser: b3c. instance.  Optional `_factory'
     is a no-argument callable; if not specified use the *note
     message_factory: 534. from the `policy'.  Call `_factory' whenever
     a new message object is needed.

     If `policy' is specified use the rules it specifies to update the
     representation of the message.  If `policy' is not set, use the
     *note compat32: 9e9. policy, which maintains backward compatibility
     with the Python 3.2 version of the email package and provides *note
     Message: 536. as the default factory.  All other policies provide
     *note EmailMessage: 537. as the default `_factory'.  For more
     information on what else `policy' controls, see the *note policy:
     75. documentation.

     Note: `The policy keyword should always be specified'; The default
     will change to *note email.policy.default: 270c. in a future
     version of Python.

     New in version 3.2.

     Changed in version 3.3: Added the `policy' keyword.

     Changed in version 3.6: `_factory' defaults to the policy
     ‘message_factory’.

      -- Method: feed (data)

          Feed the parser some more data.  `data' should be a *note
          bytes-like object: 5dd. containing one or more lines.  The
          lines can be partial and the parser will stitch such partial
          lines together properly.  The lines can have any of the three
          common line endings: carriage return, newline, or carriage
          return and newline (they can even be mixed).

      -- Method: close ()

          Complete the parsing of all previously fed data and return the
          root message object.  It is undefined what happens if *note
          feed(): 274b. is called after this method has been called.

 -- Class: email.parser.FeedParser (_factory=None, *,
          policy=policy.compat32)

     Works like *note BytesFeedParser: b3c. except that the input to the
     *note feed(): 274b. method must be a string.  This is of limited
     utility, since the only way for such a message to be valid is for
     it to contain only ASCII text or, if ‘utf8’ is ‘True’, no binary
     attachments.

     Changed in version 3.3: Added the `policy' keyword.


File: python.info,  Node: Parser API,  Next: Additional notes,  Prev: FeedParser API,  Up: email parser Parsing email messages

5.20.1.4 Parser API
...................

The *note BytesParser: b3d. class, imported from the *note email.parser:
74. module, provides an API that can be used to parse a message when the
complete contents of the message are available in a *note bytes-like
object: 5dd. or file.  The *note email.parser: 74. module also provides
*note Parser: b0b. for parsing strings, and header-only parsers, *note
BytesHeaderParser: 9f0. and *note HeaderParser: 9f1, which can be used
if you’re only interested in the headers of the message.  *note
BytesHeaderParser: 9f0. and *note HeaderParser: 9f1. can be much faster
in these situations, since they do not attempt to parse the message
body, instead setting the payload to the raw body.

 -- Class: email.parser.BytesParser (_class=None, *,
          policy=policy.compat32)

     Create a *note BytesParser: b3d. instance.  The `_class' and
     `policy' arguments have the same meaning and semantics as the
     `_factory' and `policy' arguments of *note BytesFeedParser: b3c.

     Note: `The policy keyword should always be specified'; The default
     will change to *note email.policy.default: 270c. in a future
     version of Python.

     Changed in version 3.3: Removed the `strict' argument that was
     deprecated in 2.4.  Added the `policy' keyword.

     Changed in version 3.6: `_class' defaults to the policy
     ‘message_factory’.

      -- Method: parse (fp, headersonly=False)

          Read all the data from the binary file-like object `fp', parse
          the resulting bytes, and return the message object.  `fp' must
          support both the *note readline(): 163f. and the ‘read()’
          methods.

          The bytes contained in `fp' must be formatted as a block of
          RFC 5322(1) (or, if ‘utf8’ is ‘True’, RFC 6532(2)) style
          headers and header continuation lines, optionally preceded by
          an envelope header.  The header block is terminated either by
          the end of the data or by a blank line.  Following the header
          block is the body of the message (which may contain
          MIME-encoded subparts, including subparts with a
          ‘Content-Transfer-Encoding’ of ‘8bit’).

          Optional `headersonly' is a flag specifying whether to stop
          parsing after reading the headers or not.  The default is
          ‘False’, meaning it parses the entire contents of the file.

      -- Method: parsebytes (bytes, headersonly=False)

          Similar to the *note parse(): 274e. method, except it takes a
          *note bytes-like object: 5dd. instead of a file-like object.
          Calling this method on a *note bytes-like object: 5dd. is
          equivalent to wrapping `bytes' in a *note BytesIO: 78f.
          instance first and calling *note parse(): 274e.

          Optional `headersonly' is as with the *note parse(): 274e.
          method.

     New in version 3.2.

 -- Class: email.parser.BytesHeaderParser (_class=None, *,
          policy=policy.compat32)

     Exactly like *note BytesParser: b3d, except that `headersonly'
     defaults to ‘True’.

     New in version 3.3.

 -- Class: email.parser.Parser (_class=None, *, policy=policy.compat32)

     This class is parallel to *note BytesParser: b3d, but handles
     string input.

     Changed in version 3.3: Removed the `strict' argument.  Added the
     `policy' keyword.

     Changed in version 3.6: `_class' defaults to the policy
     ‘message_factory’.

      -- Method: parse (fp, headersonly=False)

          Read all the data from the text-mode file-like object `fp',
          parse the resulting text, and return the root message object.
          `fp' must support both the *note readline(): 1b36. and the
          *note read(): 1f44. methods on file-like objects.

          Other than the text mode requirement, this method operates
          like *note BytesParser.parse(): 274e.

      -- Method: parsestr (text, headersonly=False)

          Similar to the *note parse(): 2750. method, except it takes a
          string object instead of a file-like object.  Calling this
          method on a string is equivalent to wrapping `text' in a *note
          StringIO: 821. instance first and calling *note parse(): 2750.

          Optional `headersonly' is as with the *note parse(): 2750.
          method.

 -- Class: email.parser.HeaderParser (_class=None, *,
          policy=policy.compat32)

     Exactly like *note Parser: b0b, except that `headersonly' defaults
     to ‘True’.

Since creating a message object structure from a string or a file object
is such a common task, four functions are provided as a convenience.
They are available in the top-level *note email: 69. package namespace.

 -- Function: email.message_from_bytes (s, _class=None, *,
          policy=policy.compat32)

     Return a message object structure from a *note bytes-like object:
     5dd.  This is equivalent to ‘BytesParser().parsebytes(s)’.
     Optional `_class' and `policy' are interpreted as with the *note
     BytesParser: b3d. class constructor.

     New in version 3.2.

     Changed in version 3.3: Removed the `strict' argument.  Added the
     `policy' keyword.

 -- Function: email.message_from_binary_file (fp, _class=None, *,
          policy=policy.compat32)

     Return a message object structure tree from an open binary *note
     file object: b35.  This is equivalent to ‘BytesParser().parse(fp)’.
     `_class' and `policy' are interpreted as with the *note
     BytesParser: b3d. class constructor.

     New in version 3.2.

     Changed in version 3.3: Removed the `strict' argument.  Added the
     `policy' keyword.

 -- Function: email.message_from_string (s, _class=None, *,
          policy=policy.compat32)

     Return a message object structure from a string.  This is
     equivalent to ‘Parser().parsestr(s)’.  `_class' and `policy' are
     interpreted as with the *note Parser: b0b. class constructor.

     Changed in version 3.3: Removed the `strict' argument.  Added the
     `policy' keyword.

 -- Function: email.message_from_file (fp, _class=None, *,
          policy=policy.compat32)

     Return a message object structure tree from an open *note file
     object: b35.  This is equivalent to ‘Parser().parse(fp)’.  `_class'
     and `policy' are interpreted as with the *note Parser: b0b. class
     constructor.

     Changed in version 3.3: Removed the `strict' argument.  Added the
     `policy' keyword.

     Changed in version 3.6: `_class' defaults to the policy
     ‘message_factory’.

Here’s an example of how you might use *note message_from_bytes(): b3a.
at an interactive Python prompt:

     >>> import email >>> msg = email.message_from_bytes(myBytes)

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc5322.html

   (2) https://tools.ietf.org/html/rfc6532.html


File: python.info,  Node: Additional notes,  Prev: Parser API,  Up: email parser Parsing email messages

5.20.1.5 Additional notes
.........................

Here are some notes on the parsing semantics:

   * Most non-‘multipart’ type messages are parsed as a single message
     object with a string payload.  These objects will return ‘False’
     for *note is_multipart(): 2711, and *note iter_parts(): 2736. will
     yield an empty list.

   * All ‘multipart’ type messages will be parsed as a container message
     object with a list of sub-message objects for their payload.  The
     outer container message will return ‘True’ for *note
     is_multipart(): 2711, and *note iter_parts(): 2736. will yield a
     list of subparts.

   * Most messages with a content type of ‘message/*’ (such as
     ‘message/delivery-status’ and ‘message/rfc822’) will also be parsed
     as container object containing a list payload of length 1.  Their
     *note is_multipart(): 2711. method will return ‘True’.  The single
     element yielded by *note iter_parts(): 2736. will be a sub-message
     object.

   * Some non-standards-compliant messages may not be internally
     consistent about their ‘multipart’-edness.  Such messages may have
     a ‘Content-Type’ header of type ‘multipart’, but their *note
     is_multipart(): 2711. method may return ‘False’.  If such messages
     were parsed with the *note FeedParser: 2749, they will have an
     instance of the ‘MultipartInvariantViolationDefect’ class in their
     `defects' attribute list.  See *note email.errors: 6d. for details.


File: python.info,  Node: email generator Generating MIME documents,  Next: email policy Policy Objects,  Prev: email parser Parsing email messages,  Up: email — An email and MIME handling package

5.20.1.6 ‘email.generator’: Generating MIME documents
.....................................................

`Source code:' Lib/email/generator.py(1)

__________________________________________________________________

One of the most common tasks is to generate the flat (serialized)
version of the email message represented by a message object structure.
You will need to do this if you want to send your message via *note
smtplib.SMTP.sendmail(): 738. or the *note nntplib: c0. module, or print
the message on the console.  Taking a message object structure and
producing a serialized representation is the job of the generator
classes.

As with the *note email.parser: 74. module, you aren’t limited to the
functionality of the bundled generator; you could write one from scratch
yourself.  However the bundled generator knows how to generate most
email in a standards-compliant way, should handle MIME and non-MIME
email messages just fine, and is designed so that the bytes-oriented
parsing and generation operations are inverses, assuming the same
non-transforming *note policy: 75. is used for both.  That is, parsing
the serialized byte stream via the *note BytesParser: b3d. class and
then regenerating the serialized byte stream using *note BytesGenerator:
b40. should produce output identical to the input (2).  (On the other
hand, using the generator on an *note EmailMessage: 537. constructed by
program may result in changes to the *note EmailMessage: 537. object as
defaults are filled in.)

The *note Generator: b3f. class can be used to flatten a message into a
text (as opposed to binary) serialized representation, but since Unicode
cannot represent binary data directly, the message is of necessity
transformed into something that contains only ASCII characters, using
the standard email RFC Content Transfer Encoding techniques for encoding
email messages for transport over channels that are not “8 bit clean”.

To accommodate reproducible processing of SMIME-signed messages *note
Generator: b3f. disables header folding for message parts of type
‘multipart/signed’ and all subparts.

 -- Class: email.generator.BytesGenerator (outfp, mangle_from_=None,
          maxheaderlen=None, *, policy=None)

     Return a *note BytesGenerator: b40. object that will write any
     message provided to the *note flatten(): 2757. method, or any
     surrogateescape encoded text provided to the *note write(): 2758.
     method, to the *note file-like object: 1ba2. `outfp'.  `outfp' must
     support a ‘write’ method that accepts binary data.

     If optional `mangle_from_' is ‘True’, put a ‘>’ character in front
     of any line in the body that starts with the exact string ‘"From
     "’, that is ‘From’ followed by a space at the beginning of a line.
     `mangle_from_' defaults to the value of the *note mangle_from_:
     6c4. setting of the `policy' (which is ‘True’ for the *note
     compat32: 535. policy and ‘False’ for all others).  `mangle_from_'
     is intended for use when messages are stored in unix mbox format
     (see *note mailbox: ae. and WHY THE CONTENT-LENGTH FORMAT IS
     BAD(3)).

     If `maxheaderlen' is not ‘None’, refold any header lines that are
     longer than `maxheaderlen', or if ‘0’, do not rewrap any headers.
     If `manheaderlen' is ‘None’ (the default), wrap headers and other
     message lines according to the `policy' settings.

     If `policy' is specified, use that policy to control message
     generation.  If `policy' is ‘None’ (the default), use the policy
     associated with the *note Message: 536. or *note EmailMessage: 537.
     object passed to ‘flatten’ to control the message generation.  See
     *note email.policy: 75. for details on what `policy' controls.

     New in version 3.2.

     Changed in version 3.3: Added the `policy' keyword.

     Changed in version 3.6: The default behavior of the `mangle_from_'
     and `maxheaderlen' parameters is to follow the policy.

      -- Method: flatten (msg, unixfrom=False, linesep=None)

          Print the textual representation of the message object
          structure rooted at `msg' to the output file specified when
          the *note BytesGenerator: b40. instance was created.

          If the *note policy: 75. option *note cte_type: 2759. is
          ‘8bit’ (the default), copy any headers in the original parsed
          message that have not been modified to the output with any
          bytes with the high bit set reproduced as in the original, and
          preserve the non-ASCII ‘Content-Transfer-Encoding’ of any body
          parts that have them.  If ‘cte_type’ is ‘7bit’, convert the
          bytes with the high bit set as needed using an
          ASCII-compatible ‘Content-Transfer-Encoding’.  That is,
          transform parts with non-ASCII ‘Content-Transfer-Encoding’
          (‘Content-Transfer-Encoding: 8bit’) to an ASCII compatible
          ‘Content-Transfer-Encoding’, and encode RFC-invalid non-ASCII
          bytes in headers using the MIME ‘unknown-8bit’ character set,
          thus rendering them RFC-compliant.

          If `unixfrom' is ‘True’, print the envelope header delimiter
          used by the Unix mailbox format (see *note mailbox: ae.)
          before the first of the RFC 5322(4) headers of the root
          message object.  If the root object has no envelope header,
          craft a standard one.  The default is ‘False’.  Note that for
          subparts, no envelope header is ever printed.

          If `linesep' is not ‘None’, use it as the separator character
          between all the lines of the flattened message.  If `linesep'
          is ‘None’ (the default), use the value specified in the
          `policy'.

      -- Method: clone (fp)

          Return an independent clone of this *note BytesGenerator: b40.
          instance with the exact same option settings, and `fp' as the
          new `outfp'.

      -- Method: write (s)

          Encode `s' using the ‘ASCII’ codec and the ‘surrogateescape’
          error handler, and pass it to the `write' method of the
          `outfp' passed to the *note BytesGenerator: b40.’s
          constructor.

As a convenience, *note EmailMessage: 537. provides the methods *note
as_bytes(): 270f. and ‘bytes(aMessage)’ (a.k.a.  *note __bytes__():
2710.), which simplify the generation of a serialized binary
representation of a message object.  For more detail, see *note
email.message: 72.

Because strings cannot represent binary data, the *note Generator: b3f.
class must convert any binary data in any message it flattens to an
ASCII compatible format, by converting them to an ASCII compatible
‘Content-Transfer_Encoding’.  Using the terminology of the email RFCs,
you can think of this as *note Generator: b3f. serializing to an I/O
stream that is not “8 bit clean”.  In other words, most applications
will want to be using *note BytesGenerator: b40, and not *note
Generator: b3f.

 -- Class: email.generator.Generator (outfp, mangle_from_=None,
          maxheaderlen=None, *, policy=None)

     Return a *note Generator: b3f. object that will write any message
     provided to the *note flatten(): 275b. method, or any text provided
     to the *note write(): 275c. method, to the *note file-like object:
     1ba2. `outfp'.  `outfp' must support a ‘write’ method that accepts
     string data.

     If optional `mangle_from_' is ‘True’, put a ‘>’ character in front
     of any line in the body that starts with the exact string ‘"From
     "’, that is ‘From’ followed by a space at the beginning of a line.
     `mangle_from_' defaults to the value of the *note mangle_from_:
     6c4. setting of the `policy' (which is ‘True’ for the *note
     compat32: 535. policy and ‘False’ for all others).  `mangle_from_'
     is intended for use when messages are stored in unix mbox format
     (see *note mailbox: ae. and WHY THE CONTENT-LENGTH FORMAT IS
     BAD(5)).

     If `maxheaderlen' is not ‘None’, refold any header lines that are
     longer than `maxheaderlen', or if ‘0’, do not rewrap any headers.
     If `manheaderlen' is ‘None’ (the default), wrap headers and other
     message lines according to the `policy' settings.

     If `policy' is specified, use that policy to control message
     generation.  If `policy' is ‘None’ (the default), use the policy
     associated with the *note Message: 536. or *note EmailMessage: 537.
     object passed to ‘flatten’ to control the message generation.  See
     *note email.policy: 75. for details on what `policy' controls.

     Changed in version 3.3: Added the `policy' keyword.

     Changed in version 3.6: The default behavior of the `mangle_from_'
     and `maxheaderlen' parameters is to follow the policy.

      -- Method: flatten (msg, unixfrom=False, linesep=None)

          Print the textual representation of the message object
          structure rooted at `msg' to the output file specified when
          the *note Generator: b3f. instance was created.

          If the *note policy: 75. option *note cte_type: 2759. is
          ‘8bit’, generate the message as if the option were set to
          ‘7bit’.  (This is required because strings cannot represent
          non-ASCII bytes.)  Convert any bytes with the high bit set as
          needed using an ASCII-compatible ‘Content-Transfer-Encoding’.
          That is, transform parts with non-ASCII
          ‘Content-Transfer-Encoding’ (‘Content-Transfer-Encoding:
          8bit’) to an ASCII compatible ‘Content-Transfer-Encoding’, and
          encode RFC-invalid non-ASCII bytes in headers using the MIME
          ‘unknown-8bit’ character set, thus rendering them
          RFC-compliant.

          If `unixfrom' is ‘True’, print the envelope header delimiter
          used by the Unix mailbox format (see *note mailbox: ae.)
          before the first of the RFC 5322(6) headers of the root
          message object.  If the root object has no envelope header,
          craft a standard one.  The default is ‘False’.  Note that for
          subparts, no envelope header is ever printed.

          If `linesep' is not ‘None’, use it as the separator character
          between all the lines of the flattened message.  If `linesep'
          is ‘None’ (the default), use the value specified in the
          `policy'.

          Changed in version 3.2: Added support for re-encoding ‘8bit’
          message bodies, and the `linesep' argument.

      -- Method: clone (fp)

          Return an independent clone of this *note Generator: b3f.
          instance with the exact same options, and `fp' as the new
          `outfp'.

      -- Method: write (s)

          Write `s' to the `write' method of the `outfp' passed to the
          *note Generator: b3f.’s constructor.  This provides just
          enough file-like API for *note Generator: b3f. instances to be
          used in the *note print(): 87a. function.

As a convenience, *note EmailMessage: 537. provides the methods *note
as_string(): 270d. and ‘str(aMessage)’ (a.k.a.  *note __str__(): 270e.),
which simplify the generation of a formatted string representation of a
message object.  For more detail, see *note email.message: 72.

The *note email.generator: 6e. module also provides a derived class,
*note DecodedGenerator: 533, which is like the *note Generator: b3f.
base class, except that non-‘text’ parts are not serialized, but are
instead represented in the output stream by a string derived from a
template filled in with information about the part.

 -- Class: email.generator.DecodedGenerator (outfp, mangle_from_=None,
          maxheaderlen=None, fmt=None, *, policy=None)

     Act like *note Generator: b3f, except that for any subpart of the
     message passed to *note Generator.flatten(): 275b, if the subpart
     is of main type ‘text’, print the decoded payload of the subpart,
     and if the main type is not ‘text’, instead of printing it fill in
     the string `fmt' using information from the part and print the
     resulting filled-in string.

     To fill in `fmt', execute ‘fmt % part_info’, where ‘part_info’ is a
     dictionary composed of the following keys and values:

        * ‘type’ – Full MIME type of the non-‘text’ part

        * ‘maintype’ – Main MIME type of the non-‘text’ part

        * ‘subtype’ – Sub-MIME type of the non-‘text’ part

        * ‘filename’ – Filename of the non-‘text’ part

        * ‘description’ – Description associated with the non-‘text’
          part

        * ‘encoding’ – Content transfer encoding of the non-‘text’ part

     If `fmt' is ‘None’, use the following default `fmt':

          “[Non-text (%(type)s) part of message omitted, filename
          %(filename)s]”

     Optional `_mangle_from_' and `maxheaderlen' are as with the *note
     Generator: b3f. base class.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/generator.py

   (2) (1) This statement assumes that you use the appropriate setting
for ‘unixfrom’, and that there are no ‘policy’ settings calling for
automatic adjustments (for example, ‘refold_source’ must be ‘none’,
which is `not' the default).  It is also not 100% true, since if the
message does not conform to the RFC standards occasionally information
about the exact original text is lost during parsing error recovery.  It
is a goal to fix these latter edge cases when possible.

   (3) https://www.jwz.org/doc/content-length.html

   (4) https://tools.ietf.org/html/rfc5322.html

   (5) https://www.jwz.org/doc/content-length.html

   (6) https://tools.ietf.org/html/rfc5322.html


File: python.info,  Node: email policy Policy Objects,  Next: email errors Exception and Defect classes,  Prev: email generator Generating MIME documents,  Up: email — An email and MIME handling package

5.20.1.7 ‘email.policy’: Policy Objects
.......................................

New in version 3.3.

`Source code:' Lib/email/policy.py(1)

__________________________________________________________________

The *note email: 69. package’s prime focus is the handling of email
messages as described by the various email and MIME RFCs.  However, the
general format of email messages (a block of header fields each
consisting of a name followed by a colon followed by a value, the whole
block followed by a blank line and an arbitrary ‘body’), is a format
that has found utility outside of the realm of email.  Some of these
uses conform fairly closely to the main email RFCs, some do not.  Even
when working with email, there are times when it is desirable to break
strict compliance with the RFCs, such as generating emails that
interoperate with email servers that do not themselves follow the
standards, or that implement extensions you want to use in ways that
violate the standards.

Policy objects give the email package the flexibility to handle all
these disparate use cases.

A *note Policy: 9e8. object encapsulates a set of attributes and methods
that control the behavior of various components of the email package
during use.  *note Policy: 9e8. instances can be passed to various
classes and methods in the email package to alter the default behavior.
The settable values and their defaults are described below.

There is a default policy used by all classes in the email package.  For
all of the *note parser: 74. classes and the related convenience
functions, and for the *note Message: 536. class, this is the *note
Compat32: 9e9. policy, via its corresponding pre-defined instance *note
compat32: 535.  This policy provides for complete backward compatibility
(in some cases, including bug compatibility) with the pre-Python3.3
version of the email package.

This default value for the `policy' keyword to *note EmailMessage: 537.
is the *note EmailPolicy: 9ec. policy, via its pre-defined instance
*note default: 270c.

When a *note Message: 536. or *note EmailMessage: 537. object is
created, it acquires a policy.  If the message is created by a *note
parser: 74, a policy passed to the parser will be the policy used by the
message it creates.  If the message is created by the program, then the
policy can be specified when it is created.  When a message is passed to
a *note generator: 6e, the generator uses the policy from the message by
default, but you can also pass a specific policy to the generator that
will override the one stored on the message object.

The default value for the `policy' keyword for the *note email.parser:
74. classes and the parser convenience functions `will be changing' in a
future version of Python.  Therefore you should `always specify
explicitly which policy you want to use' when calling any of the classes
and functions described in the *note parser: 74. module.

The first part of this documentation covers the features of *note
Policy: 9e8, an *note abstract base class: b26. that defines the
features that are common to all policy objects, including *note
compat32: 535.  This includes certain hook methods that are called
internally by the email package, which a custom policy could override to
obtain different behavior.  The second part describes the concrete
classes *note EmailPolicy: 9ec. and *note Compat32: 9e9, which implement
the hooks that provide the standard behavior and the backward compatible
behavior and features, respectively.

*note Policy: 9e8. instances are immutable, but they can be cloned,
accepting the same keyword arguments as the class constructor and
returning a new *note Policy: 9e8. instance that is a copy of the
original but with the specified attributes values changed.

As an example, the following code could be used to read an email message
from a file on disk and pass it to the system ‘sendmail’ program on a
Unix system:

     >>> from email import message_from_binary_file >>> from email.generator import BytesGenerator >>> from email import policy >>> from subprocess import Popen, PIPE >>> with open('mymsg.txt', 'rb') as f: ...     msg = message_from_binary_file(f, policy=policy.default) >>> p = Popen(['sendmail', msg['To'].addresses[0]], stdin=PIPE) >>> g = BytesGenerator(p.stdin, policy=msg.policy.clone(linesep='\r\n')) >>> g.flatten(msg) >>> p.stdin.close() >>> rc = p.wait()

Here we are telling *note BytesGenerator: b40. to use the RFC correct
line separator characters when creating the binary string to feed into
‘sendmail's’ ‘stdin’, where the default policy would use ‘\n’ line
separators.

Some email package methods accept a `policy' keyword argument, allowing
the policy to be overridden for that method.  For example, the following
code uses the *note as_bytes(): 834. method of the `msg' object from the
previous example and writes the message to a file using the native line
separators for the platform on which it is running:

     >>> import os >>> with open('converted.txt', 'wb') as f: ...     f.write(msg.as_bytes(policy=msg.policy.clone(linesep=os.linesep))) 17

Policy objects can also be combined using the addition operator,
producing a policy object whose settings are a combination of the
non-default values of the summed objects:

     >>> compat_SMTP = policy.compat32.clone(linesep='\r\n') >>> compat_strict = policy.compat32.clone(raise_on_defect=True) >>> compat_strict_SMTP = compat_SMTP + compat_strict

This operation is not commutative; that is, the order in which the
objects are added matters.  To illustrate:

     >>> policy100 = policy.compat32.clone(max_line_length=100) >>> policy80 = policy.compat32.clone(max_line_length=80) >>> apolicy = policy100 + policy80 >>> apolicy.max_line_length 80 >>> apolicy = policy80 + policy100 >>> apolicy.max_line_length 100

 -- Class: email.policy.Policy (**kw)

     This is the *note abstract base class: b26. for all policy classes.
     It provides default implementations for a couple of trivial
     methods, as well as the implementation of the immutability
     property, the *note clone(): 9ea. method, and the constructor
     semantics.

     The constructor of a policy class can be passed various keyword
     arguments.  The arguments that may be specified are any non-method
     properties on this class, plus any additional non-method properties
     on the concrete class.  A value specified in the constructor will
     override the default value for the corresponding attribute.

     This class defines the following properties, and thus values for
     the following may be passed in the constructor of any policy class:

      -- Attribute: max_line_length

          The maximum length of any line in the serialized output, not
          counting the end of line character(s).  Default is 78, per RFC
          5322(2).  A value of ‘0’ or *note None: 157. indicates that no
          line wrapping should be done at all.

      -- Attribute: linesep

          The string to be used to terminate lines in serialized output.
          The default is ‘\n’ because that’s the internal end-of-line
          discipline used by Python, though ‘\r\n’ is required by the
          RFCs.

      -- Attribute: cte_type

          Controls the type of Content Transfer Encodings that may be or
          are required to be used.  The possible values are:

          ‘7bit’       all data must be “7 bit clean” (ASCII-only).  This means that
                       where necessary data will be encoded using either
                       quoted-printable or base64 encoding.
                       
                       
          ‘8bit’       data is not constrained to be 7 bit clean.  Data in headers is
                       still required to be ASCII-only and so will be encoded (see
                       *note fold_binary(): 2762. and *note utf8: 6c6. below for
                       exceptions), but body parts may use the ‘8bit’ CTE.
                       

          A ‘cte_type’ value of ‘8bit’ only works with ‘BytesGenerator’,
          not ‘Generator’, because strings cannot contain binary data.
          If a ‘Generator’ is operating under a policy that specifies
          ‘cte_type=8bit’, it will act as if ‘cte_type’ is ‘7bit’.

      -- Attribute: raise_on_defect

          If *note True: 48f, any defects encountered will be raised as
          errors.  If *note False: 37d. (the default), defects will be
          passed to the *note register_defect(): 2764. method.

      -- Attribute: mangle_from_

          If *note True: 48f, lines starting with `“From “' in the body
          are escaped by putting a ‘>’ in front of them.  This parameter
          is used when the message is being serialized by a generator.
          Default: *note False: 37d.

          New in version 3.5: The `mangle_from_' parameter.

      -- Attribute: message_factory

          A factory function for constructing a new empty message
          object.  Used by the parser when building messages.  Defaults
          to ‘None’, in which case *note Message: 536. is used.

          New in version 3.6.

     The following *note Policy: 9e8. method is intended to be called by
     code using the email library to create policy instances with custom
     settings:

      -- Method: clone (**kw)

          Return a new *note Policy: 9e8. instance whose attributes have
          the same values as the current instance, except where those
          attributes are given new values by the keyword arguments.

     The remaining *note Policy: 9e8. methods are called by the email
     package code, and are not intended to be called by an application
     using the email package.  A custom policy must implement all of
     these methods.

      -- Method: handle_defect (obj, defect)

          Handle a `defect' found on `obj'.  When the email package
          calls this method, `defect' will always be a subclass of
          ‘Defect’.

          The default implementation checks the *note raise_on_defect:
          2763. flag.  If it is ‘True’, `defect' is raised as an
          exception.  If it is ‘False’ (the default), `obj' and `defect'
          are passed to *note register_defect(): 2764.

      -- Method: register_defect (obj, defect)

          Register a `defect' on `obj'.  In the email package, `defect'
          will always be a subclass of ‘Defect’.

          The default implementation calls the ‘append’ method of the
          ‘defects’ attribute of `obj'.  When the email package calls
          *note handle_defect: 2765, `obj' will normally have a
          ‘defects’ attribute that has an ‘append’ method.  Custom
          object types used with the email package (for example, custom
          ‘Message’ objects) should also provide such an attribute,
          otherwise defects in parsed messages will raise unexpected
          errors.

      -- Method: header_max_count (name)

          Return the maximum allowed number of headers named `name'.

          Called when a header is added to an *note EmailMessage: 537.
          or *note Message: 536. object.  If the returned value is not
          ‘0’ or ‘None’, and there are already a number of headers with
          the name `name' greater than or equal to the value returned, a
          *note ValueError: 1f9. is raised.

          Because the default behavior of ‘Message.__setitem__’ is to
          append the value to the list of headers, it is easy to create
          duplicate headers without realizing it.  This method allows
          certain headers to be limited in the number of instances of
          that header that may be added to a ‘Message’ programmatically.
          (The limit is not observed by the parser, which will
          faithfully produce as many headers as exist in the message
          being parsed.)

          The default implementation returns ‘None’ for all header
          names.

      -- Method: header_source_parse (sourcelines)

          The email package calls this method with a list of strings,
          each string ending with the line separation characters found
          in the source being parsed.  The first line includes the field
          header name and separator.  All whitespace in the source is
          preserved.  The method should return the ‘(name, value)’ tuple
          that is to be stored in the ‘Message’ to represent the parsed
          header.

          If an implementation wishes to retain compatibility with the
          existing email package policies, `name' should be the case
          preserved name (all characters up to the ‘‘:’’ separator),
          while `value' should be the unfolded value (all line separator
          characters removed, but whitespace kept intact), stripped of
          leading whitespace.

          `sourcelines' may contain surrogateescaped binary data.

          There is no default implementation

      -- Method: header_store_parse (name, value)

          The email package calls this method with the name and value
          provided by the application program when the application
          program is modifying a ‘Message’ programmatically (as opposed
          to a ‘Message’ created by a parser).  The method should return
          the ‘(name, value)’ tuple that is to be stored in the
          ‘Message’ to represent the header.

          If an implementation wishes to retain compatibility with the
          existing email package policies, the `name' and `value' should
          be strings or string subclasses that do not change the content
          of the passed in arguments.

          There is no default implementation

      -- Method: header_fetch_parse (name, value)

          The email package calls this method with the `name' and
          `value' currently stored in the ‘Message’ when that header is
          requested by the application program, and whatever the method
          returns is what is passed back to the application as the value
          of the header being retrieved.  Note that there may be more
          than one header with the same name stored in the ‘Message’;
          the method is passed the specific name and value of the header
          destined to be returned to the application.

          `value' may contain surrogateescaped binary data.  There
          should be no surrogateescaped binary data in the value
          returned by the method.

          There is no default implementation

      -- Method: fold (name, value)

          The email package calls this method with the `name' and
          `value' currently stored in the ‘Message’ for a given header.
          The method should return a string that represents that header
          “folded” correctly (according to the policy settings) by
          composing the `name' with the `value' and inserting *note
          linesep: 2761. characters at the appropriate places.  See RFC
          5322(3) for a discussion of the rules for folding email
          headers.

          `value' may contain surrogateescaped binary data.  There
          should be no surrogateescaped binary data in the string
          returned by the method.

      -- Method: fold_binary (name, value)

          The same as *note fold(): 276a, except that the returned value
          should be a bytes object rather than a string.

          `value' may contain surrogateescaped binary data.  These could
          be converted back into binary data in the returned bytes
          object.

 -- Class: email.policy.EmailPolicy (**kw)

     This concrete *note Policy: 9e8. provides behavior that is intended
     to be fully compliant with the current email RFCs.  These include
     (but are not limited to) RFC 5322(4), RFC 2047(5), and the current
     MIME RFCs.

     This policy adds new header parsing and folding algorithms.
     Instead of simple strings, headers are ‘str’ subclasses with
     attributes that depend on the type of the field.  The parsing and
     folding algorithm fully implement RFC 2047(6) and RFC 5322(7).

     The default value for the *note message_factory: 534. attribute is
     *note EmailMessage: 537.

     In addition to the settable attributes listed above that apply to
     all policies, this policy adds the following additional attributes:

     New in version 3.6: (8)

      -- Attribute: utf8

          If ‘False’, follow RFC 5322(9), supporting non-ASCII
          characters in headers by encoding them as “encoded words”.  If
          ‘True’, follow RFC 6532(10) and use ‘utf-8’ encoding for
          headers.  Messages formatted in this way may be passed to SMTP
          servers that support the ‘SMTPUTF8’ extension ( RFC 6531(11)).

      -- Attribute: refold_source

          If the value for a header in the ‘Message’ object originated
          from a *note parser: 74. (as opposed to being set by a
          program), this attribute indicates whether or not a generator
          should refold that value when transforming the message back
          into serialized form.  The possible values are:

          ‘none’       all source values use original folding
                       
                       
          ‘long’       source values that have any line that is longer than
                       ‘max_line_length’ will be refolded
                       
                       
          ‘all’        all values are refolded.
                       

          The default is ‘long’.

      -- Attribute: header_factory

          A callable that takes two arguments, ‘name’ and ‘value’, where
          ‘name’ is a header field name and ‘value’ is an unfolded
          header field value, and returns a string subclass that
          represents that header.  A default ‘header_factory’ (see *note
          headerregistry: 70.) is provided that supports custom parsing
          for the various address and date RFC 5322(12) header field
          types, and the major MIME header field stypes.  Support for
          additional custom parsing will be added in the future.

      -- Attribute: content_manager

          An object with at least two methods: get_content and
          set_content.  When the *note get_content(): 2737. or *note
          set_content(): 2739. method of an *note EmailMessage: 537.
          object is called, it calls the corresponding method of this
          object, passing it the message object as its first argument,
          and any arguments or keywords that were passed to it as
          additional arguments.  By default ‘content_manager’ is set to
          *note raw_data_manager: 276d.

          New in version 3.4.

     The class provides the following concrete implementations of the
     abstract methods of *note Policy: 9e8.:

      -- Method: header_max_count (name)

          Returns the value of the *note max_count: 276f. attribute of
          the specialized class used to represent the header with the
          given name.

      -- Method: header_source_parse (sourcelines)

          The name is parsed as everything up to the ‘‘:’’ and returned
          unmodified.  The value is determined by stripping leading
          whitespace off the remainder of the first line, joining all
          subsequent lines together, and stripping any trailing carriage
          return or linefeed characters.

      -- Method: header_store_parse (name, value)

          The name is returned unchanged.  If the input value has a
          ‘name’ attribute and it matches `name' ignoring case, the
          value is returned unchanged.  Otherwise the `name' and `value'
          are passed to ‘header_factory’, and the resulting header
          object is returned as the value.  In this case a ‘ValueError’
          is raised if the input value contains CR or LF characters.

      -- Method: header_fetch_parse (name, value)

          If the value has a ‘name’ attribute, it is returned to
          unmodified.  Otherwise the `name', and the `value' with any CR
          or LF characters removed, are passed to the ‘header_factory’,
          and the resulting header object is returned.  Any
          surrogateescaped bytes get turned into the unicode
          unknown-character glyph.

      -- Method: fold (name, value)

          Header folding is controlled by the *note refold_source: 276b.
          policy setting.  A value is considered to be a ‘source value’
          if and only if it does not have a ‘name’ attribute (having a
          ‘name’ attribute means it is a header object of some sort).
          If a source value needs to be refolded according to the
          policy, it is converted into a header object by passing the
          `name' and the `value' with any CR and LF characters removed
          to the ‘header_factory’.  Folding of a header object is done
          by calling its ‘fold’ method with the current policy.

          Source values are split into lines using *note splitlines():
          1595.  If the value is not to be refolded, the lines are
          rejoined using the ‘linesep’ from the policy and returned.
          The exception is lines containing non-ascii binary data.  In
          that case the value is refolded regardless of the
          ‘refold_source’ setting, which causes the binary data to be
          CTE encoded using the ‘unknown-8bit’ charset.

      -- Method: fold_binary (name, value)

          The same as *note fold(): 2773. if *note cte_type: 2759. is
          ‘7bit’, except that the returned value is bytes.

          If *note cte_type: 2759. is ‘8bit’, non-ASCII binary data is
          converted back into bytes.  Headers with binary data are not
          refolded, regardless of the ‘refold_header’ setting, since
          there is no way to know whether the binary data consists of
          single byte characters or multibyte characters.

The following instances of *note EmailPolicy: 9ec. provide defaults
suitable for specific application domains.  Note that in the future the
behavior of these instances (in particular the ‘HTTP’ instance) may be
adjusted to conform even more closely to the RFCs relevant to their
domains.

 -- Data: email.policy.default

     An instance of ‘EmailPolicy’ with all defaults unchanged.  This
     policy uses the standard Python ‘\n’ line endings rather than the
     RFC-correct ‘\r\n’.

 -- Data: email.policy.SMTP

     Suitable for serializing messages in conformance with the email
     RFCs.  Like ‘default’, but with ‘linesep’ set to ‘\r\n’, which is
     RFC compliant.

 -- Data: email.policy.SMTPUTF8

     The same as ‘SMTP’ except that *note utf8: 6c6. is ‘True’.  Useful
     for serializing messages to a message store without using encoded
     words in the headers.  Should only be used for SMTP transmission if
     the sender or recipient addresses have non-ASCII characters (the
     *note smtplib.SMTP.send_message(): 739. method handles this
     automatically).

 -- Data: email.policy.HTTP

     Suitable for serializing headers with for use in HTTP traffic.
     Like ‘SMTP’ except that ‘max_line_length’ is set to ‘None’
     (unlimited).

 -- Data: email.policy.strict

     Convenience instance.  The same as ‘default’ except that
     ‘raise_on_defect’ is set to ‘True’.  This allows any policy to be
     made strict by writing:

          somepolicy + policy.strict

With all of these *note EmailPolicies: 9ec, the effective API of the
email package is changed from the Python 3.2 API in the following ways:

        * Setting a header on a *note Message: 536. results in that
          header being parsed and a header object created.

        * Fetching a header value from a *note Message: 536. results in
          that header being parsed and a header object created and
          returned.

        * Any header object, or any header that is refolded due to the
          policy settings, is folded using an algorithm that fully
          implements the RFC folding algorithms, including knowing where
          encoded words are required and allowed.

From the application view, this means that any header obtained through
the *note EmailMessage: 537. is a header object with extra attributes,
whose string value is the fully decoded unicode value of the header.
Likewise, a header may be assigned a new value, or a new header created,
using a unicode string, and the policy will take care of converting the
unicode string into the correct RFC encoded form.

The header objects and their attributes are described in *note
headerregistry: 70.

 -- Class: email.policy.Compat32 (**kw)

     This concrete *note Policy: 9e8. is the backward compatibility
     policy.  It replicates the behavior of the email package in Python
     3.2.  The *note policy: 75. module also defines an instance of this
     class, *note compat32: 535, that is used as the default policy.
     Thus the default behavior of the email package is to maintain
     compatibility with Python 3.2.

     The following attributes have values that are different from the
     *note Policy: 9e8. default:

      -- Attribute: mangle_from_

          The default is ‘True’.

     The class provides the following concrete implementations of the
     abstract methods of *note Policy: 9e8.:

      -- Method: header_source_parse (sourcelines)

          The name is parsed as everything up to the ‘‘:’’ and returned
          unmodified.  The value is determined by stripping leading
          whitespace off the remainder of the first line, joining all
          subsequent lines together, and stripping any trailing carriage
          return or linefeed characters.

      -- Method: header_store_parse (name, value)

          The name and value are returned unmodified.

      -- Method: header_fetch_parse (name, value)

          If the value contains binary data, it is converted into a
          *note Header: 277d. object using the ‘unknown-8bit’ charset.
          Otherwise it is returned unmodified.

      -- Method: fold (name, value)

          Headers are folded using the *note Header: 277d. folding
          algorithm, which preserves existing line breaks in the value,
          and wraps each resulting line to the ‘max_line_length’.
          Non-ASCII binary data are CTE encoded using the ‘unknown-8bit’
          charset.

      -- Method: fold_binary (name, value)

          Headers are folded using the *note Header: 277d. folding
          algorithm, which preserves existing line breaks in the value,
          and wraps each resulting line to the ‘max_line_length’.  If
          ‘cte_type’ is ‘7bit’, non-ascii binary data is CTE encoded
          using the ‘unknown-8bit’ charset.  Otherwise the original
          source header is used, with its existing line breaks and any
          (RFC invalid) binary data it may contain.

 -- Data: email.policy.compat32

     An instance of *note Compat32: 9e9, providing backward
     compatibility with the behavior of the email package in Python 3.2.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/policy.py

   (2) https://tools.ietf.org/html/rfc5322.html

   (3) https://tools.ietf.org/html/rfc5322.html

   (4) https://tools.ietf.org/html/rfc5322.html

   (5) https://tools.ietf.org/html/rfc2047.html

   (6) https://tools.ietf.org/html/rfc2047.html

   (7) https://tools.ietf.org/html/rfc5322.html

   (8) (1) Originally added in 3.3 as a *note provisional feature: 974.

   (9) https://tools.ietf.org/html/rfc5322.html

   (10) https://tools.ietf.org/html/rfc6532.html

   (11) https://tools.ietf.org/html/rfc6531.html

   (12) https://tools.ietf.org/html/rfc5322.html


File: python.info,  Node: email errors Exception and Defect classes,  Next: email headerregistry Custom Header Objects,  Prev: email policy Policy Objects,  Up: email — An email and MIME handling package

5.20.1.8 ‘email.errors’: Exception and Defect classes
.....................................................

`Source code:' Lib/email/errors.py(1)

__________________________________________________________________

The following exception classes are defined in the *note email.errors:
6d. module:

 -- Exception: email.errors.MessageError

     This is the base class for all exceptions that the *note email: 69.
     package can raise.  It is derived from the standard *note
     Exception: 1a8. class and defines no additional methods.

 -- Exception: email.errors.MessageParseError

     This is the base class for exceptions raised by the *note Parser:
     b0b. class.  It is derived from *note MessageError: 2782.  This
     class is also used internally by the parser used by *note
     headerregistry: 70.

 -- Exception: email.errors.HeaderParseError

     Raised under some error conditions when parsing the RFC 5322(2)
     headers of a message, this class is derived from *note
     MessageParseError: 2783.  The *note set_boundary(): 272c. method
     will raise this error if the content type is unknown when the
     method is called.  *note Header: 277d. may raise this error for
     certain base64 decoding errors, and when an attempt is made to
     create a header that appears to contain an embedded header (that
     is, there is what is supposed to be a continuation line that has no
     leading whitespace and looks like a header).

 -- Exception: email.errors.BoundaryError

     Deprecated and no longer used.

 -- Exception: email.errors.MultipartConversionError

     Raised when a payload is added to a *note Message: 536. object
     using ‘add_payload()’, but the payload is already a scalar and the
     message’s ‘Content-Type’ main type is not either ‘multipart’ or
     missing.  *note MultipartConversionError: 2785. multiply inherits
     from *note MessageError: 2782. and the built-in *note TypeError:
     192.

     Since ‘Message.add_payload()’ is deprecated, this exception is
     rarely raised in practice.  However the exception may also be
     raised if the *note attach(): 273f. method is called on an instance
     of a class derived from *note MIMENonMultipart: 2786. (e.g.  *note
     MIMEImage: 2787.).

Here is the list of the defects that the *note FeedParser: 2749. can
find while parsing messages.  Note that the defects are added to the
message where the problem was found, so for example, if a message nested
inside a ‘multipart/alternative’ had a malformed header, that nested
message object would have a defect, but the containing messages would
not.

All defect classes are subclassed from ‘email.errors.MessageDefect’.

   * ‘NoBoundaryInMultipartDefect’ – A message claimed to be a
     multipart, but had no ‘boundary’ parameter.

   * ‘StartBoundaryNotFoundDefect’ – The start boundary claimed in the
     ‘Content-Type’ header was never found.

   * ‘CloseBoundaryNotFoundDefect’ – A start boundary was found, but no
     corresponding close boundary was ever found.

     New in version 3.3.

   * ‘FirstHeaderLineIsContinuationDefect’ – The message had a
     continuation line as its first header line.

   * ‘MisplacedEnvelopeHeaderDefect’ - A “Unix From” header was found in
     the middle of a header block.

   * ‘MissingHeaderBodySeparatorDefect’ - A line was found while parsing
     headers that had no leading white space but contained no ‘:’.
     Parsing continues assuming that the line represents the first line
     of the body.

     New in version 3.3.

   * ‘MalformedHeaderDefect’ – A header was found that was missing a
     colon, or was otherwise malformed.

     Deprecated since version 3.3: This defect has not been used for
     several Python versions.

   * ‘MultipartInvariantViolationDefect’ – A message claimed to be a
     ‘multipart’, but no subparts were found.  Note that when a message
     has this defect, its *note is_multipart(): 2731. method may return
     ‘False’ even though its content type claims to be ‘multipart’.

   * ‘InvalidBase64PaddingDefect’ – When decoding a block of base64
     encoded bytes, the padding was not correct.  Enough padding is
     added to perform the decode, but the resulting decoded bytes may be
     invalid.

   * ‘InvalidBase64CharactersDefect’ – When decoding a block of base64
     encoded bytes, characters outside the base64 alphabet were
     encountered.  The characters are ignored, but the resulting decoded
     bytes may be invalid.

   * ‘InvalidBase64LengthDefect’ – When decoding a block of base64
     encoded bytes, the number of non-padding base64 characters was
     invalid (1 more than a multiple of 4).  The encoded block was kept
     as-is.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/errors.py

   (2) https://tools.ietf.org/html/rfc5322.html


File: python.info,  Node: email headerregistry Custom Header Objects,  Next: email contentmanager Managing MIME Content,  Prev: email errors Exception and Defect classes,  Up: email — An email and MIME handling package

5.20.1.9 ‘email.headerregistry’: Custom Header Objects
......................................................

`Source code:' Lib/email/headerregistry.py(1)

__________________________________________________________________

New in version 3.6: (2)

Headers are represented by customized subclasses of *note str: 325.  The
particular class used to represent a given header is determined by the
*note header_factory: 276c. of the *note policy: 75. in effect when the
headers are created.  This section documents the particular
‘header_factory’ implemented by the email package for handling RFC
5322(3) compliant email messages, which not only provides customized
header objects for various header types, but also provides an extension
mechanism for applications to add their own custom header types.

When using any of the policy objects derived from *note EmailPolicy:
9ec, all headers are produced by *note HeaderRegistry: 278a. and have
*note BaseHeader: 271a. as their last base class.  Each header class has
an additional base class that is determined by the type of the header.
For example, many headers have the class *note UnstructuredHeader: 278b.
as their other base class.  The specialized second class for a header is
determined by the name of the header, using a lookup table stored in the
*note HeaderRegistry: 278a.  All of this is managed transparently for
the typical application program, but interfaces are provided for
modifying the default behavior for use by more complex applications.

The sections below first document the header base classes and their
attributes, followed by the API for modifying the behavior of *note
HeaderRegistry: 278a, and finally the support classes used to represent
the data parsed from structured headers.

 -- Class: email.headerregistry.BaseHeader (name, value)

     `name' and `value' are passed to ‘BaseHeader’ from the *note
     header_factory: 276c. call.  The string value of any header object
     is the `value' fully decoded to unicode.

     This base class defines the following read-only properties:

      -- Attribute: name

          The name of the header (the portion of the field before the
          ‘:’).  This is exactly the value passed in the *note
          header_factory: 276c. call for `name'; that is, case is
          preserved.

      -- Attribute: defects

          A tuple of ‘HeaderDefect’ instances reporting any RFC
          compliance problems found during parsing.  The email package
          tries to be complete about detecting compliance issues.  See
          the *note errors: 6d. module for a discussion of the types of
          defects that may be reported.

      -- Attribute: max_count

          The maximum number of headers of this type that can have the
          same ‘name’.  A value of ‘None’ means unlimited.  The
          ‘BaseHeader’ value for this attribute is ‘None’; it is
          expected that specialized header classes will override this
          value as needed.

     ‘BaseHeader’ also provides the following method, which is called by
     the email library code and should not in general be called by
     application programs:

      -- Method: fold (*, policy)

          Return a string containing *note linesep: 2761. characters as
          required to correctly fold the header according to `policy'.
          A *note cte_type: 2759. of ‘8bit’ will be treated as if it
          were ‘7bit’, since headers may not contain arbitrary binary
          data.  If *note utf8: 6c6. is ‘False’, non-ASCII data will be
          RFC 2047(4) encoded.

     ‘BaseHeader’ by itself cannot be used to create a header object.
     It defines a protocol that each specialized header cooperates with
     in order to produce the header object.  Specifically, ‘BaseHeader’
     requires that the specialized class provide a *note classmethod():
     1d6. named ‘parse’.  This method is called as follows:

          parse(string, kwds)

     ‘kwds’ is a dictionary containing one pre-initialized key,
     ‘defects’.  ‘defects’ is an empty list.  The parse method should
     append any detected defects to this list.  On return, the ‘kwds’
     dictionary `must' contain values for at least the keys ‘decoded’
     and ‘defects’.  ‘decoded’ should be the string value for the header
     (that is, the header value fully decoded to unicode).  The parse
     method should assume that `string' may contain
     content-transfer-encoded parts, but should correctly handle all
     valid unicode characters as well so that it can parse un-encoded
     header values.

     ‘BaseHeader’’s ‘__new__’ then creates the header instance, and
     calls its ‘init’ method.  The specialized class only needs to
     provide an ‘init’ method if it wishes to set additional attributes
     beyond those provided by ‘BaseHeader’ itself.  Such an ‘init’
     method should look like this:

          def init(self, /, *args, **kw):     self._myattr = kw.pop('myattr')     super().init(*args, **kw)

     That is, anything extra that the specialized class puts in to the
     ‘kwds’ dictionary should be removed and handled, and the remaining
     contents of ‘kw’ (and ‘args’) passed to the ‘BaseHeader’ ‘init’
     method.

 -- Class: email.headerregistry.UnstructuredHeader

     An “unstructured” header is the default type of header in RFC
     5322(5).  Any header that does not have a specified syntax is
     treated as unstructured.  The classic example of an unstructured
     header is the ‘Subject’ header.

     In RFC 5322(6), an unstructured header is a run of arbitrary text
     in the ASCII character set.  RFC 2047(7), however, has an RFC
     5322(8) compatible mechanism for encoding non-ASCII text as ASCII
     characters within a header value.  When a `value' containing
     encoded words is passed to the constructor, the
     ‘UnstructuredHeader’ parser converts such encoded words into
     unicode, following the RFC 2047(9) rules for unstructured text.
     The parser uses heuristics to attempt to decode certain
     non-compliant encoded words.  Defects are registered in such cases,
     as well as defects for issues such as invalid characters within the
     encoded words or the non-encoded text.

     This header type provides no additional attributes.

 -- Class: email.headerregistry.DateHeader

     RFC 5322(10) specifies a very specific format for dates within
     email headers.  The ‘DateHeader’ parser recognizes that date
     format, as well as recognizing a number of variant forms that are
     sometimes found “in the wild”.

     This header type provides the following additional attributes:

      -- Attribute: datetime

          If the header value can be recognized as a valid date of one
          form or another, this attribute will contain a *note datetime:
          194. instance representing that date.  If the timezone of the
          input date is specified as ‘-0000’ (indicating it is in UTC
          but contains no information about the source timezone), then
          *note datetime: 2790. will be a naive *note datetime: 194.  If
          a specific timezone offset is found (including ‘+0000’), then
          *note datetime: 2790. will contain an aware ‘datetime’ that
          uses *note datetime.timezone: 9f5. to record the timezone
          offset.

     The ‘decoded’ value of the header is determined by formatting the
     ‘datetime’ according to the RFC 5322(11) rules; that is, it is set
     to:

          email.utils.format_datetime(self.datetime)

     When creating a ‘DateHeader’, `value' may be *note datetime: 194.
     instance.  This means, for example, that the following code is
     valid and does what one would expect:

          msg['Date'] = datetime(2011, 7, 15, 21)

     Because this is a naive ‘datetime’ it will be interpreted as a UTC
     timestamp, and the resulting value will have a timezone of ‘-0000’.
     Much more useful is to use the *note localtime(): 9f4. function
     from the *note utils: 76. module:

          msg['Date'] = utils.localtime()

     This example sets the date header to the current time and date
     using the current timezone offset.

 -- Class: email.headerregistry.AddressHeader

     Address headers are one of the most complex structured header
     types.  The ‘AddressHeader’ class provides a generic interface to
     any address header.

     This header type provides the following additional attributes:

      -- Attribute: groups

          A tuple of *note Group: 2793. objects encoding the addresses
          and groups found in the header value.  Addresses that are not
          part of a group are represented in this list as single-address
          ‘Groups’ whose *note display_name: 2794. is ‘None’.

      -- Attribute: addresses

          A tuple of *note Address: 2796. objects encoding all of the
          individual addresses from the header value.  If the header
          value contains any groups, the individual addresses from the
          group are included in the list at the point where the group
          occurs in the value (that is, the list of addresses is
          “flattened” into a one dimensional list).

     The ‘decoded’ value of the header will have all encoded words
     decoded to unicode.  *note idna: 77. encoded domain names are also
     decoded to unicode.  The ‘decoded’ value is set by *note join:
     156d.ing the *note str: 325. value of the elements of the ‘groups’
     attribute with ‘', '’.

     A list of *note Address: 2796. and *note Group: 2793. objects in
     any combination may be used to set the value of an address header.
     ‘Group’ objects whose ‘display_name’ is ‘None’ will be interpreted
     as single addresses, which allows an address list to be copied with
     groups intact by using the list obtained from the ‘groups’
     attribute of the source header.

 -- Class: email.headerregistry.SingleAddressHeader

     A subclass of *note AddressHeader: 2791. that adds one additional
     attribute:

      -- Attribute: address

          The single address encoded by the header value.  If the header
          value actually contains more than one address (which would be
          a violation of the RFC under the default *note policy: 75.),
          accessing this attribute will result in a *note ValueError:
          1f9.

Many of the above classes also have a ‘Unique’ variant (for example,
‘UniqueUnstructuredHeader’).  The only difference is that in the
‘Unique’ variant, *note max_count: 276f. is set to 1.

 -- Class: email.headerregistry.MIMEVersionHeader

     There is really only one valid value for the ‘MIME-Version’ header,
     and that is ‘1.0’.  For future proofing, this header class supports
     other valid version numbers.  If a version number has a valid value
     per RFC 2045(12), then the header object will have non-‘None’
     values for the following attributes:

      -- Attribute: version

          The version number as a string, with any whitespace and/or
          comments removed.

      -- Attribute: major

          The major version number as an integer

      -- Attribute: minor

          The minor version number as an integer

 -- Class: email.headerregistry.ParameterizedMIMEHeader

     MIME headers all start with the prefix ‘Content-‘.  Each specific
     header has a certain value, described under the class for that
     header.  Some can also take a list of supplemental parameters,
     which have a common format.  This class serves as a base for all
     the MIME headers that take parameters.

      -- Attribute: params

          A dictionary mapping parameter names to parameter values.

 -- Class: email.headerregistry.ContentTypeHeader

     A *note ParameterizedMIMEHeader: 279d. class that handles the
     ‘Content-Type’ header.

      -- Attribute: content_type

          The content type string, in the form ‘maintype/subtype’.

      -- Attribute: maintype

      -- Attribute: subtype

 -- Class: email.headerregistry.ContentDispositionHeader

     A *note ParameterizedMIMEHeader: 279d. class that handles the
     ‘Content-Disposition’ header.

      -- Attribute: content-disposition

          ‘inline’ and ‘attachment’ are the only valid values in common
          use.

 -- Class: email.headerregistry.ContentTransferEncoding

     Handles the ‘Content-Transfer-Encoding’ header.

      -- Attribute: cte

          Valid values are ‘7bit’, ‘8bit’, ‘base64’, and
          ‘quoted-printable’.  See RFC 2045(13) for more information.

 -- Class: email.headerregistry.HeaderRegistry (base_class=BaseHeader,
          default_class=UnstructuredHeader, use_default_map=True)

     This is the factory used by *note EmailPolicy: 9ec. by default.
     ‘HeaderRegistry’ builds the class used to create a header instance
     dynamically, using `base_class' and a specialized class retrieved
     from a registry that it holds.  When a given header name does not
     appear in the registry, the class specified by `default_class' is
     used as the specialized class.  When `use_default_map' is ‘True’
     (the default), the standard mapping of header names to classes is
     copied in to the registry during initialization.  `base_class' is
     always the last class in the generated class’s ‘__bases__’ list.

     The default mappings are:


          subject: UniqueUnstructuredHeader


          date: UniqueDateHeader


          resent-date: DateHeader


          orig-date: UniqueDateHeader


          sender: UniqueSingleAddressHeader


          resent-sender: SingleAddressHeader


          to: UniqueAddressHeader


          resent-to: AddressHeader


          cc: UniqueAddressHeader


          resent-cc: AddressHeader


          bcc: UniqueAddressHeader


          resent-bcc: AddressHeader


          from: UniqueAddressHeader


          resent-from: AddressHeader


          reply-to: UniqueAddressHeader


          mime-version: MIMEVersionHeader


          content-type: ContentTypeHeader


          content-disposition: ContentDispositionHeader


          content-transfer-encoding: ContentTransferEncodingHeader


          message-id: MessageIDHeader

     ‘HeaderRegistry’ has the following methods:

      -- Method: map_to_type (self, name, cls)

          `name' is the name of the header to be mapped.  It will be
          converted to lower case in the registry.  `cls' is the
          specialized class to be used, along with `base_class', to
          create the class used to instantiate headers that match
          `name'.

      -- Method: __getitem__ (name)

          Construct and return a class to handle creating a `name'
          header.

      -- Method: __call__ (name, value)

          Retrieves the specialized header associated with `name' from
          the registry (using `default_class' if `name' does not appear
          in the registry) and composes it with `base_class' to produce
          a class, calls the constructed class’s constructor, passing it
          the same argument list, and finally returns the class instance
          created thereby.

The following classes are the classes used to represent data parsed from
structured headers and can, in general, be used by an application
program to construct structured values to assign to specific headers.

 -- Class: email.headerregistry.Address (display_name='', username='',
          domain='', addr_spec=None)

     The class used to represent an email address.  The general form of
     an address is:

          [display_name] <username@domain>

     or:

          username@domain

     where each part must conform to specific syntax rules spelled out
     in RFC 5322(14).

     As a convenience `addr_spec' can be specified instead of `username'
     and `domain', in which case `username' and `domain' will be parsed
     from the `addr_spec'.  An `addr_spec' must be a properly RFC quoted
     string; if it is not ‘Address’ will raise an error.  Unicode
     characters are allowed and will be property encoded when
     serialized.  However, per the RFCs, unicode is `not' allowed in the
     username portion of the address.

      -- Attribute: display_name

          The display name portion of the address, if any, with all
          quoting removed.  If the address does not have a display name,
          this attribute will be an empty string.

      -- Attribute: username

          The ‘username’ portion of the address, with all quoting
          removed.

      -- Attribute: domain

          The ‘domain’ portion of the address.

      -- Attribute: addr_spec

          The ‘username@domain’ portion of the address, correctly quoted
          for use as a bare address (the second form shown above).  This
          attribute is not mutable.

      -- Method: __str__ ()

          The ‘str’ value of the object is the address quoted according
          to RFC 5322(15) rules, but with no Content Transfer Encoding
          of any non-ASCII characters.

     To support SMTP ( RFC 5321(16)), ‘Address’ handles one special
     case: if ‘username’ and ‘domain’ are both the empty string (or
     ‘None’), then the string value of the ‘Address’ is ‘<>’.

 -- Class: email.headerregistry.Group (display_name=None,
          addresses=None)

     The class used to represent an address group.  The general form of
     an address group is:

          display_name: [address-list];

     As a convenience for processing lists of addresses that consist of
     a mixture of groups and single addresses, a ‘Group’ may also be
     used to represent single addresses that are not part of a group by
     setting `display_name' to ‘None’ and providing a list of the single
     address as `addresses'.

      -- Attribute: display_name

          The ‘display_name’ of the group.  If it is ‘None’ and there is
          exactly one ‘Address’ in ‘addresses’, then the ‘Group’
          represents a single address that is not in a group.

      -- Attribute: addresses

          A possibly empty tuple of *note Address: 2796. objects
          representing the addresses in the group.

      -- Method: __str__ ()

          The ‘str’ value of a ‘Group’ is formatted according to RFC
          5322(17), but with no Content Transfer Encoding of any
          non-ASCII characters.  If ‘display_name’ is none and there is
          a single ‘Address’ in the ‘addresses’ list, the ‘str’ value
          will be the same as the ‘str’ of that single ‘Address’.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/email/headerregistry.py

   (2) (1) Originally added in 3.3 as a *note provisional module: 974.

   (3) https://tools.ietf.org/html/rfc5322.html

   (4) https://tools.ietf.org/html/rfc2047.html

   (5) https://tools.ietf.org/html/rfc5322.html

   (6) https://tools.ietf.org/html/rfc5322.html

   (7) https://tools.ietf.org/html/rfc2047.html

   (8) https://tools.ietf.org/html/rfc5322.html

   (9) https://tools.ietf.org/html/rfc2047.html

   (10) https://tools.ietf.org/html/rfc5322.html

   (11) https://tools.ietf.org/html/rfc5322.html

   (12) https://tools.ietf.org/html/rfc2045.html

   (13) https://tools.ietf.org/html/rfc2045.html

   (14) https://tools.ietf.org/html/rfc5322.html

   (15) https://tools.ietf.org/html/rfc5322.html

   (16) https://tools.ietf.org/html/rfc5321.html

   (17) https://tools.ietf.org/html/rfc5322.html


File: python.info,  Node: email contentmanager Managing MIME Content,  Next: email Examples,  Prev: email headerregistry Custom Header Objects,  Up: email — An email and MIME handling package

5.20.1.10 ‘email.contentmanager’: Managing MIME Content
.......................................................

`Source code:' Lib/email/contentmanager.py(1)

__________________________________________________________________

New in version 3.6: (2)

 -- Class: email.contentmanager.ContentManager

     Base class for content managers.  Provides the standard registry
     mechanisms to register converters between MIME content and other
     representations, as well as the ‘get_content’ and ‘set_content’
     dispatch methods.

      -- Method: get_content (msg, *args, **kw)

          Look up a handler function based on the ‘mimetype’ of `msg'
          (see next paragraph), call it, passing through all arguments,
          and return the result of the call.  The expectation is that
          the handler will extract the payload from `msg' and return an
          object that encodes information about the extracted data.

          To find the handler, look for the following keys in the
          registry, stopping with the first one found:

                  * the string representing the full MIME type
                    (‘maintype/subtype’)

                  * the string representing the ‘maintype’

                  * the empty string

          If none of these keys produce a handler, raise a *note
          KeyError: 2c5. for the full MIME type.

      -- Method: set_content (msg, obj, *args, **kw)

          If the ‘maintype’ is ‘multipart’, raise a *note TypeError:
          192.; otherwise look up a handler function based on the type
          of `obj' (see next paragraph), call *note clear_content():
          2743. on the `msg', and call the handler function, passing
          through all arguments.  The expectation is that the handler
          will transform and store `obj' into `msg', possibly making
          other changes to `msg' as well, such as adding various MIME
          headers to encode information needed to interpret the stored
          data.

          To find the handler, obtain the type of `obj' (‘typ =
          type(obj)’), and look for the following keys in the registry,
          stopping with the first one found:

                  * the type itself (‘typ’)

                  * the type’s fully qualified name (‘typ.__module__ +
                    '.' + typ.__qualname__’).

                  * the type’s qualname (‘typ.__qualname__’)

                  * the type’s name (‘typ.__name__’).

          If none of the above match, repeat all of the checks above for
          each of the types in the *note MRO: 27b3. (‘typ.__mro__’).
          Finally, if no other key yields a handler, check for a handler
          for the key ‘None’.  If there is no handler for ‘None’, raise
          a *note KeyError: 2c5. for the fully qualified name of the
          type.

          Also add a ‘MIME-Version’ header if one is not present (see
          also *note MIMEPart: 837.).

      -- Method: add_get_handler (key, handler)

          Record the function `handler' as the handler for `key'.  For
          the possible values of `key', see *note get_content(): 27b5.

      -- Method: add_set_handler (typekey, handler)

          Record `handler' as the function to call when an object of a
          type matching `typekey' is passed to *note set_content():
          27b7.  For the possible values of `typekey', see *note
          set_content(): 27b7.

* Menu:

* Content Manager Instances::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/email/contentmanager.py

   (2) (1) Originally added in 3.4 as a *note provisional module: 974.


File: python.info,  Node: Content Manager Instances,  Up: email contentmanager Managing MIME Content

5.20.1.11 Content Manager Instances
...................................

Currently the email package provides only one concrete content manager,
*note raw_data_manager: 276d, although more may be added in the future.
*note raw_data_manager: 276d. is the *note content_manager: 838.
provided by *note EmailPolicy: 9ec. and its derivatives.

 -- Data: email.contentmanager.raw_data_manager

     This content manager provides only a minimum interface beyond that
     provided by *note Message: 536. itself: it deals only with text,
     raw byte strings, and *note Message: 536. objects.  Nevertheless,
     it provides significant advantages compared to the base API:
     ‘get_content’ on a text part will return a unicode string without
     the application needing to manually decode it, ‘set_content’
     provides a rich set of options for controlling the headers added to
     a part and controlling the content transfer encoding, and it
     enables the use of the various ‘add_’ methods, thereby simplifying
     the creation of multipart messages.

      -- Method: email.contentmanager.get_content (msg,
               errors='replace')

          Return the payload of the part as either a string (for ‘text’
          parts), an *note EmailMessage: 537. object (for
          ‘message/rfc822’ parts), or a ‘bytes’ object (for all other
          non-multipart types).  Raise a *note KeyError: 2c5. if called
          on a ‘multipart’.  If the part is a ‘text’ part and `errors'
          is specified, use it as the error handler when decoding the
          payload to unicode.  The default error handler is ‘replace’.

      -- Method: email.contentmanager.set_content (msg, <'str'>,
               subtype="plain", charset='utf-8' cte=None,
               disposition=None, filename=None, cid=None, params=None,
               headers=None)

      -- Method: email.contentmanager.set_content (msg, <'bytes'>,
               maintype, subtype, cte="base64", disposition=None,
               filename=None, cid=None, params=None, headers=None)

      -- Method: email.contentmanager.set_content (msg,
               <'EmailMessage'>, cte=None, disposition=None,
               filename=None, cid=None, params=None, headers=None)

          Add headers and payload to `msg':

          Add a ‘Content-Type’ header with a ‘maintype/subtype’ value.

                  * For ‘str’, set the MIME ‘maintype’ to ‘text’, and
                    set the subtype to `subtype' if it is specified, or
                    ‘plain’ if it is not.

                  * For ‘bytes’, use the specified `maintype' and
                    `subtype', or raise a *note TypeError: 192. if they
                    are not specified.

                  * For *note EmailMessage: 537. objects, set the
                    maintype to ‘message’, and set the subtype to
                    `subtype' if it is specified or ‘rfc822’ if it is
                    not.  If `subtype' is ‘partial’, raise an error
                    (‘bytes’ objects must be used to construct
                    ‘message/partial’ parts).

          If `charset' is provided (which is valid only for ‘str’),
          encode the string to bytes using the specified character set.
          The default is ‘utf-8’.  If the specified `charset' is a known
          alias for a standard MIME charset name, use the standard
          charset instead.

          If `cte' is set, encode the payload using the specified
          content transfer encoding, and set the
          ‘Content-Transfer-Encoding’ header to that value.  Possible
          values for `cte' are ‘quoted-printable’, ‘base64’, ‘7bit’,
          ‘8bit’, and ‘binary’.  If the input cannot be encoded in the
          specified encoding (for example, specifying a `cte' of ‘7bit’
          for an input that contains non-ASCII values), raise a *note
          ValueError: 1f9.

                  * For ‘str’ objects, if `cte' is not set use
                    heuristics to determine the most compact encoding.

                  * For *note EmailMessage: 537, per RFC 2046(1), raise
                    an error if a `cte' of ‘quoted-printable’ or
                    ‘base64’ is requested for `subtype' ‘rfc822’, and
                    for any `cte' other than ‘7bit’ for `subtype'
                    ‘external-body’.  For ‘message/rfc822’, use ‘8bit’
                    if `cte' is not specified.  For all other values of
                    `subtype', use ‘7bit’.

               Note: A `cte' of ‘binary’ does not actually work
               correctly yet.  The ‘EmailMessage’ object as modified by
               ‘set_content’ is correct, but *note BytesGenerator: b40.
               does not serialize it correctly.

          If `disposition' is set, use it as the value of the
          ‘Content-Disposition’ header.  If not specified, and
          `filename' is specified, add the header with the value
          ‘attachment’.  If `disposition' is not specified and
          `filename' is also not specified, do not add the header.  The
          only valid values for `disposition' are ‘attachment’ and
          ‘inline’.

          If `filename' is specified, use it as the value of the
          ‘filename’ parameter of the ‘Content-Disposition’ header.

          If `cid' is specified, add a ‘Content-ID’ header with `cid' as
          its value.

          If `params' is specified, iterate its ‘items’ method and use
          the resulting ‘(key, value)’ pairs to set additional
          parameters on the ‘Content-Type’ header.

          If `headers' is specified and is a list of strings of the form
          ‘headername: headervalue’ or a list of ‘header’ objects
          (distinguished from strings by having a ‘name’ attribute), add
          the headers to `msg'.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2046.html


File: python.info,  Node: email Examples,  Next: email message Message Representing an email message using the compat32 API,  Prev: email contentmanager Managing MIME Content,  Up: email — An email and MIME handling package

5.20.1.12 ‘email’: Examples
...........................

Here are a few examples of how to use the *note email: 69. package to
read, write, and send simple email messages, as well as more complex
MIME messages.

First, let’s see how to create and send a simple text message (both the
text content and the addresses may contain unicode characters):

     # Import smtplib for the actual sending function import smtplib  # Import the email modules we'll need from email.message import EmailMessage  # Open the plain text file whose name is in textfile for reading. with open(textfile) as fp:     # Create a text/plain message     msg = EmailMessage()     msg.set_content(fp.read())  # me == the sender's email address # you == the recipient's email address msg['Subject'] = f'The contents of {textfile}' msg['From'] = me msg['To'] = you  # Send the message via our own SMTP server. s = smtplib.SMTP('localhost') s.send_message(msg) s.quit()

Parsing RFC 822(1) headers can easily be done by the using the classes
from the *note parser: 74. module:

     # Import the email modules we'll need from email.parser import BytesParser, Parser from email.policy import default  # If the e-mail headers are in a file, uncomment these two lines: # with open(messagefile, 'rb') as fp: #     headers = BytesParser(policy=default).parse(fp)  #  Or for parsing headers in a string (this is an uncommon operation), use: headers = Parser(policy=default).parsestr(         'From: Foo Bar <user@example.com>\n'         'To: <someone_else@example.com>\n'         'Subject: Test message\n'         '\n'         'Body would go here\n')  #  Now the header items can be accessed as a dictionary: print('To: {}'.format(headers['to'])) print('From: {}'.format(headers['from'])) print('Subject: {}'.format(headers['subject']))  # You can also access the parts of the addresses: print('Recipient username: {}'.format(headers['to'].addresses[0].username)) print('Sender name: {}'.format(headers['from'].addresses[0].display_name))

Here’s an example of how to send a MIME message containing a bunch of
family pictures that may be residing in a directory:

     # Import smtplib for the actual sending function import smtplib  # And imghdr to find the types of our images import imghdr  # Here are the email package modules we'll need from email.message import EmailMessage  # Create the container email message. msg = EmailMessage() msg['Subject'] = 'Our family reunion' # me == the sender's email address # family = the list of all recipients' email addresses msg['From'] = me msg['To'] = ', '.join(family) msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'  # Open the files in binary mode.  Use imghdr to figure out the # MIME subtype for each specific image. for file in pngfiles:     with open(file, 'rb') as fp:         img_data = fp.read()     msg.add_attachment(img_data, maintype='image',                                  subtype=imghdr.what(None, img_data))  # Send the email via our own SMTP server. with smtplib.SMTP('localhost') as s:     s.send_message(msg)

Here’s an example of how to send the entire contents of a directory as
an email message: (2)

     #!/usr/bin/env python3  """Send the contents of a directory as a MIME message."""  import os import smtplib # For guessing MIME type based on file name extension import mimetypes  from argparse import ArgumentParser  from email.message import EmailMessage from email.policy import SMTP   def main():     parser = ArgumentParser(description="""\ Send the contents of a directory as a MIME message. Unless the -o option is given, the email is sent by forwarding to your local SMTP server, which then does the normal delivery process.  Your local machine must be running an SMTP server. """)     parser.add_argument('-d', '--directory',                         help="""Mail the contents of the specified directory,                         otherwise use the current directory.  Only the regular                         files in the directory are sent, and we don't recurse to                         subdirectories.""")     parser.add_argument('-o', '--output',                         metavar='FILE',                         help="""Print the composed message to FILE instead of                         sending the message to the SMTP server.""")     parser.add_argument('-s', '--sender', required=True,                         help='The value of the From: header (required)')     parser.add_argument('-r', '--recipient', required=True,                         action='append', metavar='RECIPIENT',                         default=[], dest='recipients',                         help='A To: header value (at least one required)')     args = parser.parse_args()     directory = args.directory     if not directory:         directory = '.'     # Create the message     msg = EmailMessage()     msg['Subject'] = f'Contents of directory {os.path.abspath(directory)}'     msg['To'] = ', '.join(args.recipients)     msg['From'] = args.sender     msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'      for filename in os.listdir(directory):         path = os.path.join(directory, filename)         if not os.path.isfile(path):             continue         # Guess the content type based on the file's extension.  Encoding         # will be ignored, although we should check for simple things like         # gzip'd or compressed files.         ctype, encoding = mimetypes.guess_type(path)         if ctype is None or encoding is not None:             # No guess could be made, or the file is encoded (compressed), so             # use a generic bag-of-bits type.             ctype = 'application/octet-stream'         maintype, subtype = ctype.split('/', 1)         with open(path, 'rb') as fp:             msg.add_attachment(fp.read(),                                maintype=maintype,                                subtype=subtype,                                filename=filename)     # Now send or store the message     if args.output:         with open(args.output, 'wb') as fp:             fp.write(msg.as_bytes(policy=SMTP))     else:         with smtplib.SMTP('localhost') as s:             s.send_message(msg)   if __name__ == '__main__':     main()

Here’s an example of how to unpack a MIME message like the one above,
into a directory of files:

     #!/usr/bin/env python3  """Unpack a MIME message into a directory of files."""  import os import email import mimetypes  from email.policy import default  from argparse import ArgumentParser   def main():     parser = ArgumentParser(description="""\ Unpack a MIME message into a directory of files. """)     parser.add_argument('-d', '--directory', required=True,                         help="""Unpack the MIME message into the named                         directory, which will be created if it doesn't already                         exist.""")     parser.add_argument('msgfile')     args = parser.parse_args()      with open(args.msgfile, 'rb') as fp:         msg = email.message_from_binary_file(fp, policy=default)      try:         os.mkdir(args.directory)     except FileExistsError:         pass      counter = 1     for part in msg.walk():         # multipart/* are just containers         if part.get_content_maintype() == 'multipart':             continue         # Applications should really sanitize the given filename so that an         # email message can't be used to overwrite important files         filename = part.get_filename()         if not filename:             ext = mimetypes.guess_extension(part.get_content_type())             if not ext:                 # Use a generic bag-of-bits extension                 ext = '.bin'             filename = f'part-{counter:03d}{ext}'         counter += 1         with open(os.path.join(args.directory, filename), 'wb') as fp:             fp.write(part.get_payload(decode=True))   if __name__ == '__main__':     main()

Here’s an example of how to create an HTML message with an alternative
plain text version.  To make things a bit more interesting, we include a
related image in the html part, and we save a copy of what we are going
to send to disk, as well as sending it.

     #!/usr/bin/env python3  import smtplib  from email.message import EmailMessage from email.headerregistry import Address from email.utils import make_msgid  # Create the base text message. msg = EmailMessage() msg['Subject'] = "Ayons asperges pour le déjeuner" msg['From'] = Address("Pepé Le Pew", "pepe", "example.com") msg['To'] = (Address("Penelope Pussycat", "penelope", "example.com"),              Address("Fabrette Pussycat", "fabrette", "example.com")) msg.set_content("""\ Salut!  Cela ressemble à un excellent recipie[1] déjeuner.  [1] http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718  --Pepé """)  # Add the html version.  This converts the message into a multipart/alternative # container, with the original text message as the first part and the new html # message as the second part. asparagus_cid = make_msgid() msg.add_alternative("""\ <html>   <head></head>   <body>     <p>Salut!</p>     <p>Cela ressemble à un excellent         <a href="http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718">             recipie         </a> déjeuner.     </p>     <img src="cid:{asparagus_cid}" />   </body> </html> """.format(asparagus_cid=asparagus_cid[1:-1]), subtype='html') # note that we needed to peel the <> off the msgid for use in the html.  # Now add the related image to the html part. with open("roasted-asparagus.jpg", 'rb') as img:     msg.get_payload()[1].add_related(img.read(), 'image', 'jpeg',                                      cid=asparagus_cid)  # Make a local copy of what we are going to send. with open('outgoing.msg', 'wb') as f:     f.write(bytes(msg))  # Send the message via local SMTP server. with smtplib.SMTP('localhost') as s:     s.send_message(msg)

If we were sent the message from the last example, here is one way we
could process it:

     import os import sys import tempfile import mimetypes import webbrowser  # Import the email modules we'll need from email import policy from email.parser import BytesParser  # An imaginary module that would make this work and be safe. from imaginary import magic_html_parser  # In a real program you'd get the filename from the arguments. with open('outgoing.msg', 'rb') as fp:     msg = BytesParser(policy=policy.default).parse(fp)  # Now the header items can be accessed as a dictionary, and any non-ASCII will # be converted to unicode: print('To:', msg['to']) print('From:', msg['from']) print('Subject:', msg['subject'])  # If we want to print a preview of the message content, we can extract whatever # the least formatted payload is and print the first three lines.  Of course, # if the message has no plain text part printing the first three lines of html # is probably useless, but this is just a conceptual example. simplest = msg.get_body(preferencelist=('plain', 'html')) print() print(''.join(simplest.get_content().splitlines(keepends=True)[:3]))  ans = input("View full message?") if ans.lower()[0] == 'n':     sys.exit()  # We can extract the richest alternative in order to display it: richest = msg.get_body() partfiles = {} if richest['content-type'].maintype == 'text':     if richest['content-type'].subtype == 'plain':         for line in richest.get_content().splitlines():             print(line)         sys.exit()     elif richest['content-type'].subtype == 'html':         body = richest     else:         print("Don't know how to display {}".format(richest.get_content_type()))         sys.exit() elif richest['content-type'].content_type == 'multipart/related':     body = richest.get_body(preferencelist=('html'))     for part in richest.iter_attachments():         fn = part.get_filename()         if fn:             extension = os.path.splitext(part.get_filename())[1]         else:             extension = mimetypes.guess_extension(part.get_content_type())         with tempfile.NamedTemporaryFile(suffix=extension, delete=False) as f:             f.write(part.get_content())             # again strip the <> to go from email form of cid to html form.             partfiles[part['content-id'][1:-1]] = f.name else:     print("Don't know how to display {}".format(richest.get_content_type()))     sys.exit() with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:     # The magic_html_parser has to rewrite the href="cid:...." attributes to     # point to the filenames in partfiles.  It also has to do a safety-sanitize     # of the html.  It could be written using html.parser.     f.write(magic_html_parser(body.get_content(), partfiles)) webbrowser.open(f.name) os.remove(f.name) for fn in partfiles.values():     os.remove(fn)  # Of course, there are lots of email messages that could break this simple # minded program, but it will handle the most common ones.

Up to the prompt, the output from the above is:

     To: Penelope Pussycat <penelope@example.com>, Fabrette Pussycat <fabrette@example.com> From: Pepé Le Pew <pepe@example.com> Subject: Ayons asperges pour le déjeuner  Salut!  Cela ressemble à un excellent recipie[1] déjeuner.

Legacy API:

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc822.html

   (2) (1) Thanks to Matthew Dixon Cowles for the original inspiration
and examples.


File: python.info,  Node: email message Message Representing an email message using the compat32 API,  Next: email mime Creating email and MIME objects from scratch,  Prev: email Examples,  Up: email — An email and MIME handling package

5.20.1.13 ‘email.message.Message’: Representing an email message using the ‘compat32’ API
.........................................................................................

The *note Message: 536. class is very similar to the *note EmailMessage:
537. class, without the methods added by that class, and with the
default behavior of certain other methods being slightly different.  We
also document here some methods that, while supported by the *note
EmailMessage: 537. class, are not recommended unless you are dealing
with legacy code.

The philosophy and structure of the two classes is otherwise the same.

This document describes the behavior under the default (for *note
Message: 536.) policy *note Compat32: 9e9.  If you are going to use
another policy, you should be using the *note EmailMessage: 537. class
instead.

An email message consists of `headers' and a `payload'.  Headers must be
RFC 5233(1) style names and values, where the field name and value are
separated by a colon.  The colon is not part of either the field name or
the field value.  The payload may be a simple text message, or a binary
object, or a structured sequence of sub-messages each with their own set
of headers and their own payload.  The latter type of payload is
indicated by the message having a MIME type such as ‘multipart/*’ or
‘message/rfc822’.

The conceptual model provided by a *note Message: 536. object is that of
an ordered dictionary of headers with additional methods for accessing
both specialized information from the headers, for accessing the
payload, for generating a serialized version of the message, and for
recursively walking over the object tree.  Note that duplicate headers
are supported but special methods must be used to access them.

The *note Message: 536. pseudo-dictionary is indexed by the header
names, which must be ASCII values.  The values of the dictionary are
strings that are supposed to contain only ASCII characters; there is
some special handling for non-ASCII input, but it doesn’t always produce
the correct results.  Headers are stored and returned in case-preserving
form, but field names are matched case-insensitively.  There may also be
a single envelope header, also known as the `Unix-From' header or the
‘From_’ header.  The `payload' is either a string or bytes, in the case
of simple message objects, or a list of *note Message: 536. objects, for
MIME container documents (e.g.  ‘multipart/*’ and ‘message/rfc822’).

Here are the methods of the *note Message: 536. class:

 -- Class: email.message.Message (policy=compat32)

     If `policy' is specified (it must be an instance of a *note policy:
     75. class) use the rules it specifies to update and serialize the
     representation of the message.  If `policy' is not set, use the
     *note compat32: 9e9. policy, which maintains backward compatibility
     with the Python 3.2 version of the email package.  For more
     information see the *note policy: 75. documentation.

     Changed in version 3.3: The `policy' keyword argument was added.

      -- Method: as_string (unixfrom=False, maxheaderlen=0, policy=None)

          Return the entire message flattened as a string.  When
          optional `unixfrom' is true, the envelope header is included
          in the returned string.  `unixfrom' defaults to ‘False’.  For
          backward compatibility reasons, `maxheaderlen' defaults to
          ‘0’, so if you want a different value you must override it
          explicitly (the value specified for `max_line_length' in the
          policy will be ignored by this method).  The `policy' argument
          may be used to override the default policy obtained from the
          message instance.  This can be used to control some of the
          formatting produced by the method, since the specified
          `policy' will be passed to the ‘Generator’.

          Flattening the message may trigger changes to the *note
          Message: 536. if defaults need to be filled in to complete the
          transformation to a string (for example, MIME boundaries may
          be generated or modified).

          Note that this method is provided as a convenience and may not
          always format the message the way you want.  For example, by
          default it does not do the mangling of lines that begin with
          ‘From’ that is required by the unix mbox format.  For more
          flexibility, instantiate a *note Generator: b3f. instance and
          use its *note flatten(): 275b. method directly.  For example:

               from io import StringIO from email.generator import Generator fp = StringIO() g = Generator(fp, mangle_from_=True, maxheaderlen=60) g.flatten(msg) text = fp.getvalue()

          If the message object contains binary data that is not encoded
          according to RFC standards, the non-compliant data will be
          replaced by unicode “unknown character” code points.  (See
          also *note as_bytes(): 834. and *note BytesGenerator: b40.)

          Changed in version 3.4: the `policy' keyword argument was
          added.

      -- Method: __str__ ()

          Equivalent to *note as_string(): 833.  Allows ‘str(msg)’ to
          produce a string containing the formatted message.

      -- Method: as_bytes (unixfrom=False, policy=None)

          Return the entire message flattened as a bytes object.  When
          optional `unixfrom' is true, the envelope header is included
          in the returned string.  `unixfrom' defaults to ‘False’.  The
          `policy' argument may be used to override the default policy
          obtained from the message instance.  This can be used to
          control some of the formatting produced by the method, since
          the specified `policy' will be passed to the ‘BytesGenerator’.

          Flattening the message may trigger changes to the *note
          Message: 536. if defaults need to be filled in to complete the
          transformation to a string (for example, MIME boundaries may
          be generated or modified).

          Note that this method is provided as a convenience and may not
          always format the message the way you want.  For example, by
          default it does not do the mangling of lines that begin with
          ‘From’ that is required by the unix mbox format.  For more
          flexibility, instantiate a *note BytesGenerator: b40. instance
          and use its *note flatten(): 2757. method directly.  For
          example:

               from io import BytesIO from email.generator import BytesGenerator fp = BytesIO() g = BytesGenerator(fp, mangle_from_=True, maxheaderlen=60) g.flatten(msg) text = fp.getvalue()

          New in version 3.4.

      -- Method: __bytes__ ()

          Equivalent to *note as_bytes(): 834.  Allows ‘bytes(msg)’ to
          produce a bytes object containing the formatted message.

          New in version 3.4.

      -- Method: is_multipart ()

          Return ‘True’ if the message’s payload is a list of sub-*note
          Message: 536. objects, otherwise return ‘False’.  When *note
          is_multipart(): 2731. returns ‘False’, the payload should be a
          string object (which might be a CTE encoded binary payload).
          (Note that *note is_multipart(): 2731. returning ‘True’ does
          not necessarily mean that “msg.get_content_maintype() ==
          ‘multipart’” will return the ‘True’.  For example,
          ‘is_multipart’ will return ‘True’ when the *note Message: 536.
          is of type ‘message/rfc822’.)

      -- Method: set_unixfrom (unixfrom)

          Set the message’s envelope header to `unixfrom', which should
          be a string.

      -- Method: get_unixfrom ()

          Return the message’s envelope header.  Defaults to ‘None’ if
          the envelope header was never set.

      -- Method: attach (payload)

          Add the given `payload' to the current payload, which must be
          ‘None’ or a list of *note Message: 536. objects before the
          call.  After the call, the payload will always be a list of
          *note Message: 536. objects.  If you want to set the payload
          to a scalar object (e.g.  a string), use *note set_payload():
          27c0. instead.

          This is a legacy method.  On the ‘EmailMessage’ class its
          functionality is replaced by *note set_content(): 2739. and
          the related ‘make’ and ‘add’ methods.

      -- Method: get_payload (i=None, decode=False)

          Return the current payload, which will be a list of *note
          Message: 536. objects when *note is_multipart(): 2731. is
          ‘True’, or a string when *note is_multipart(): 2731. is
          ‘False’.  If the payload is a list and you mutate the list
          object, you modify the message’s payload in place.

          With optional argument `i', *note get_payload(): b3e. will
          return the `i'-th element of the payload, counting from zero,
          if *note is_multipart(): 2731. is ‘True’.  An *note
          IndexError: e69. will be raised if `i' is less than 0 or
          greater than or equal to the number of items in the payload.
          If the payload is a string (i.e.  *note is_multipart(): 2731.
          is ‘False’) and `i' is given, a *note TypeError: 192. is
          raised.

          Optional `decode' is a flag indicating whether the payload
          should be decoded or not, according to the
          ‘Content-Transfer-Encoding’ header.  When ‘True’ and the
          message is not a multipart, the payload will be decoded if
          this header’s value is ‘quoted-printable’ or ‘base64’.  If
          some other encoding is used, or ‘Content-Transfer-Encoding’
          header is missing, the payload is returned as-is (undecoded).
          In all cases the returned value is binary data.  If the
          message is a multipart and the `decode' flag is ‘True’, then
          ‘None’ is returned.  If the payload is base64 and it was not
          perfectly formed (missing padding, characters outside the
          base64 alphabet), then an appropriate defect will be added to
          the message’s defect property (‘InvalidBase64PaddingDefect’ or
          ‘InvalidBase64CharactersDefect’, respectively).

          When `decode' is ‘False’ (the default) the body is returned as
          a string without decoding the ‘Content-Transfer-Encoding’.
          However, for a ‘Content-Transfer-Encoding’ of 8bit, an attempt
          is made to decode the original bytes using the ‘charset’
          specified by the ‘Content-Type’ header, using the ‘replace’
          error handler.  If no ‘charset’ is specified, or if the
          ‘charset’ given is not recognized by the email package, the
          body is decoded using the default ASCII charset.

          This is a legacy method.  On the ‘EmailMessage’ class its
          functionality is replaced by *note get_content(): 2737. and
          *note iter_parts(): 2736.

      -- Method: set_payload (payload, charset=None)

          Set the entire message object’s payload to `payload'.  It is
          the client’s responsibility to ensure the payload invariants.
          Optional `charset' sets the message’s default character set;
          see *note set_charset(): 27c1. for details.

          This is a legacy method.  On the ‘EmailMessage’ class its
          functionality is replaced by *note set_content(): 2739.

      -- Method: set_charset (charset)

          Set the character set of the payload to `charset', which can
          either be a *note Charset: 6c8. instance (see *note
          email.charset: 6a.), a string naming a character set, or
          ‘None’.  If it is a string, it will be converted to a *note
          Charset: 6c8. instance.  If `charset' is ‘None’, the ‘charset’
          parameter will be removed from the ‘Content-Type’ header (the
          message will not be otherwise modified).  Anything else will
          generate a *note TypeError: 192.

          If there is no existing ‘MIME-Version’ header one will be
          added.  If there is no existing ‘Content-Type’ header, one
          will be added with a value of ‘text/plain’.  Whether the
          ‘Content-Type’ header already exists or not, its ‘charset’
          parameter will be set to `charset.output_charset'.  If
          `charset.input_charset' and `charset.output_charset' differ,
          the payload will be re-encoded to the `output_charset'.  If
          there is no existing ‘Content-Transfer-Encoding’ header, then
          the payload will be transfer-encoded, if needed, using the
          specified *note Charset: 6c8, and a header with the
          appropriate value will be added.  If a
          ‘Content-Transfer-Encoding’ header already exists, the payload
          is assumed to already be correctly encoded using that
          ‘Content-Transfer-Encoding’ and is not modified.

          This is a legacy method.  On the ‘EmailMessage’ class its
          functionality is replaced by the `charset' parameter of the
          ‘email.emailmessage.EmailMessage.set_content()’ method.

      -- Method: get_charset ()

          Return the *note Charset: 6c8. instance associated with the
          message’s payload.

          This is a legacy method.  On the ‘EmailMessage’ class it
          always returns ‘None’.

     The following methods implement a mapping-like interface for
     accessing the message’s RFC 2822(2) headers.  Note that there are
     some semantic differences between these methods and a normal
     mapping (i.e.  dictionary) interface.  For example, in a dictionary
     there are no duplicate keys, but here there may be duplicate
     message headers.  Also, in dictionaries there is no guaranteed
     order to the keys returned by *note keys(): 27c3, but in a *note
     Message: 536. object, headers are always returned in the order they
     appeared in the original message, or were added to the message
     later.  Any header deleted and then re-added are always appended to
     the end of the header list.

     These semantic differences are intentional and are biased toward
     maximal convenience.

     Note that in all cases, any envelope header present in the message
     is not included in the mapping interface.

     In a model generated from bytes, any header values that (in
     contravention of the RFCs) contain non-ASCII bytes will, when
     retrieved through this interface, be represented as *note Header:
     277d. objects with a charset of ‘unknown-8bit’.

      -- Method: __len__ ()

          Return the total number of headers, including duplicates.

      -- Method: __contains__ (name)

          Return ‘True’ if the message object has a field named `name'.
          Matching is done case-insensitively and `name' should not
          include the trailing colon.  Used for the ‘in’ operator, e.g.:

               if 'message-id' in myMessage:    print('Message-ID:', myMessage['message-id'])

      -- Method: __getitem__ (name)

          Return the value of the named header field.  `name' should not
          include the colon field separator.  If the header is missing,
          ‘None’ is returned; a *note KeyError: 2c5. is never raised.

          Note that if the named field appears more than once in the
          message’s headers, exactly which of those field values will be
          returned is undefined.  Use the *note get_all(): 27c7. method
          to get the values of all the extant named headers.

      -- Method: __setitem__ (name, val)

          Add a header to the message with field name `name' and value
          `val'.  The field is appended to the end of the message’s
          existing fields.

          Note that this does `not' overwrite or delete any existing
          header with the same name.  If you want to ensure that the new
          header is the only one present in the message with field name
          `name', delete the field first, e.g.:

               del msg['subject'] msg['subject'] = 'Python roolz!'

      -- Method: __delitem__ (name)

          Delete all occurrences of the field with name `name' from the
          message’s headers.  No exception is raised if the named field
          isn’t present in the headers.

      -- Method: keys ()

          Return a list of all the message’s header field names.

      -- Method: values ()

          Return a list of all the message’s field values.

      -- Method: items ()

          Return a list of 2-tuples containing all the message’s field
          headers and values.

      -- Method: get (name, failobj=None)

          Return the value of the named header field.  This is identical
          to *note __getitem__(): 27c6. except that optional `failobj'
          is returned if the named header is missing (defaults to
          ‘None’).

     Here are some additional useful methods:

      -- Method: get_all (name, failobj=None)

          Return a list of all the values for the field named `name'.
          If there are no such named headers in the message, `failobj'
          is returned (defaults to ‘None’).

      -- Method: add_header (_name, _value, **_params)

          Extended header setting.  This method is similar to *note
          __setitem__(): 27c8. except that additional header parameters
          can be provided as keyword arguments.  `_name' is the header
          field to add and `_value' is the `primary' value for the
          header.

          For each item in the keyword argument dictionary `_params',
          the key is taken as the parameter name, with underscores
          converted to dashes (since dashes are illegal in Python
          identifiers).  Normally, the parameter will be added as
          ‘key="value"’ unless the value is ‘None’, in which case only
          the key will be added.  If the value contains non-ASCII
          characters, it can be specified as a three tuple in the format
          ‘(CHARSET, LANGUAGE, VALUE)’, where ‘CHARSET’ is a string
          naming the charset to be used to encode the value, ‘LANGUAGE’
          can usually be set to ‘None’ or the empty string (see RFC
          2231(3) for other possibilities), and ‘VALUE’ is the string
          value containing non-ASCII code points.  If a three tuple is
          not passed and the value contains non-ASCII characters, it is
          automatically encoded in RFC 2231(4) format using a ‘CHARSET’
          of ‘utf-8’ and a ‘LANGUAGE’ of ‘None’.

          Here’s an example:

               msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')

          This will add a header that looks like

               Content-Disposition: attachment; filename="bud.gif"

          An example with non-ASCII characters:

               msg.add_header('Content-Disposition', 'attachment',                filename=('iso-8859-1', '', 'Fußballer.ppt'))

          Which produces

               Content-Disposition: attachment; filename*="iso-8859-1''Fu%DFballer.ppt"

      -- Method: replace_header (_name, _value)

          Replace a header.  Replace the first header found in the
          message that matches `_name', retaining header order and field
          name case.  If no matching header was found, a *note KeyError:
          2c5. is raised.

      -- Method: get_content_type ()

          Return the message’s content type.  The returned string is
          coerced to lower case of the form ‘maintype/subtype’.  If
          there was no ‘Content-Type’ header in the message the default
          type as given by *note get_default_type(): 27d0. will be
          returned.  Since according to RFC 2045(5), messages always
          have a default type, *note get_content_type(): 27cf. will
          always return a value.

          RFC 2045(6) defines a message’s default type to be
          ‘text/plain’ unless it appears inside a ‘multipart/digest’
          container, in which case it would be ‘message/rfc822’.  If the
          ‘Content-Type’ header has an invalid type specification, RFC
          2045(7) mandates that the default type be ‘text/plain’.

      -- Method: get_content_maintype ()

          Return the message’s main content type.  This is the
          ‘maintype’ part of the string returned by *note
          get_content_type(): 27cf.

      -- Method: get_content_subtype ()

          Return the message’s sub-content type.  This is the ‘subtype’
          part of the string returned by *note get_content_type(): 27cf.

      -- Method: get_default_type ()

          Return the default content type.  Most messages have a default
          content type of ‘text/plain’, except for messages that are
          subparts of ‘multipart/digest’ containers.  Such subparts have
          a default content type of ‘message/rfc822’.

      -- Method: set_default_type (ctype)

          Set the default content type.  `ctype' should either be
          ‘text/plain’ or ‘message/rfc822’, although this is not
          enforced.  The default content type is not stored in the
          ‘Content-Type’ header.

      -- Method: get_params (failobj=None, header='content-type',
               unquote=True)

          Return the message’s ‘Content-Type’ parameters, as a list.
          The elements of the returned list are 2-tuples of key/value
          pairs, as split on the ‘'='’ sign.  The left hand side of the
          ‘'='’ is the key, while the right hand side is the value.  If
          there is no ‘'='’ sign in the parameter the value is the empty
          string, otherwise the value is as described in *note
          get_param(): 27d5. and is unquoted if optional `unquote' is
          ‘True’ (the default).

          Optional `failobj' is the object to return if there is no
          ‘Content-Type’ header.  Optional `header' is the header to
          search instead of ‘Content-Type’.

          This is a legacy method.  On the ‘EmailMessage’ class its
          functionality is replaced by the `params' property of the
          individual header objects returned by the header access
          methods.

      -- Method: get_param (param, failobj=None, header='content-type',
               unquote=True)

          Return the value of the ‘Content-Type’ header’s parameter
          `param' as a string.  If the message has no ‘Content-Type’
          header or if there is no such parameter, then `failobj' is
          returned (defaults to ‘None’).

          Optional `header' if given, specifies the message header to
          use instead of ‘Content-Type’.

          Parameter keys are always compared case insensitively.  The
          return value can either be a string, or a 3-tuple if the
          parameter was RFC 2231(8) encoded.  When it’s a 3-tuple, the
          elements of the value are of the form ‘(CHARSET, LANGUAGE,
          VALUE)’.  Note that both ‘CHARSET’ and ‘LANGUAGE’ can be
          ‘None’, in which case you should consider ‘VALUE’ to be
          encoded in the ‘us-ascii’ charset.  You can usually ignore
          ‘LANGUAGE’.

          If your application doesn’t care whether the parameter was
          encoded as in RFC 2231(9), you can collapse the parameter
          value by calling *note email.utils.collapse_rfc2231_value():
          27d6, passing in the return value from *note get_param():
          27d5.  This will return a suitably decoded Unicode string when
          the value is a tuple, or the original string unquoted if it
          isn’t.  For example:

               rawparam = msg.get_param('foo') param = email.utils.collapse_rfc2231_value(rawparam)

          In any case, the parameter value (either the returned string,
          or the ‘VALUE’ item in the 3-tuple) is always unquoted, unless
          `unquote' is set to ‘False’.

          This is a legacy method.  On the ‘EmailMessage’ class its
          functionality is replaced by the `params' property of the
          individual header objects returned by the header access
          methods.

      -- Method: set_param (param, value, header='Content-Type',
               requote=True, charset=None, language='', replace=False)

          Set a parameter in the ‘Content-Type’ header.  If the
          parameter already exists in the header, its value will be
          replaced with `value'.  If the ‘Content-Type’ header as not
          yet been defined for this message, it will be set to
          ‘text/plain’ and the new parameter value will be appended as
          per RFC 2045(10).

          Optional `header' specifies an alternative header to
          ‘Content-Type’, and all parameters will be quoted as necessary
          unless optional `requote' is ‘False’ (the default is ‘True’).

          If optional `charset' is specified, the parameter will be
          encoded according to RFC 2231(11).  Optional `language'
          specifies the RFC 2231 language, defaulting to the empty
          string.  Both `charset' and `language' should be strings.

          If `replace' is ‘False’ (the default) the header is moved to
          the end of the list of headers.  If `replace' is ‘True’, the
          header will be updated in place.

          Changed in version 3.4: ‘replace’ keyword was added.

      -- Method: del_param (param, header='content-type', requote=True)

          Remove the given parameter completely from the ‘Content-Type’
          header.  The header will be re-written in place without the
          parameter or its value.  All values will be quoted as
          necessary unless `requote' is ‘False’ (the default is ‘True’).
          Optional `header' specifies an alternative to ‘Content-Type’.

      -- Method: set_type (type, header='Content-Type', requote=True)

          Set the main type and subtype for the ‘Content-Type’ header.
          `type' must be a string in the form ‘maintype/subtype’,
          otherwise a *note ValueError: 1f9. is raised.

          This method replaces the ‘Content-Type’ header, keeping all
          the parameters in place.  If `requote' is ‘False’, this leaves
          the existing header’s quoting as is, otherwise the parameters
          will be quoted (the default).

          An alternative header can be specified in the `header'
          argument.  When the ‘Content-Type’ header is set a
          ‘MIME-Version’ header is also added.

          This is a legacy method.  On the ‘EmailMessage’ class its
          functionality is replaced by the ‘make_’ and ‘add_’ methods.

      -- Method: get_filename (failobj=None)

          Return the value of the ‘filename’ parameter of the
          ‘Content-Disposition’ header of the message.  If the header
          does not have a ‘filename’ parameter, this method falls back
          to looking for the ‘name’ parameter on the ‘Content-Type’
          header.  If neither is found, or the header is missing, then
          `failobj' is returned.  The returned string will always be
          unquoted as per *note email.utils.unquote(): 272a.

      -- Method: get_boundary (failobj=None)

          Return the value of the ‘boundary’ parameter of the
          ‘Content-Type’ header of the message, or `failobj' if either
          the header is missing, or has no ‘boundary’ parameter.  The
          returned string will always be unquoted as per *note
          email.utils.unquote(): 272a.

      -- Method: set_boundary (boundary)

          Set the ‘boundary’ parameter of the ‘Content-Type’ header to
          `boundary'.  *note set_boundary(): 27db. will always quote
          `boundary' if necessary.  A *note HeaderParseError: 272d. is
          raised if the message object has no ‘Content-Type’ header.

          Note that using this method is subtly different than deleting
          the old ‘Content-Type’ header and adding a new one with the
          new boundary via *note add_header(): 27cd, because *note
          set_boundary(): 27db. preserves the order of the
          ‘Content-Type’ header in the list of headers.  However, it
          does `not' preserve any continuation lines which may have been
          present in the original ‘Content-Type’ header.

      -- Method: get_content_charset (failobj=None)

          Return the ‘charset’ parameter of the ‘Content-Type’ header,
          coerced to lower case.  If there is no ‘Content-Type’ header,
          or if that header has no ‘charset’ parameter, `failobj' is
          returned.

          Note that this method differs from *note get_charset(): 27c2.
          which returns the *note Charset: 6c8. instance for the default
          encoding of the message body.

      -- Method: get_charsets (failobj=None)

          Return a list containing the character set names in the
          message.  If the message is a ‘multipart’, then the list will
          contain one element for each subpart in the payload,
          otherwise, it will be a list of length 1.

          Each item in the list will be a string which is the value of
          the ‘charset’ parameter in the ‘Content-Type’ header for the
          represented subpart.  However, if the subpart has no
          ‘Content-Type’ header, no ‘charset’ parameter, or is not of
          the ‘text’ main MIME type, then that item in the returned list
          will be `failobj'.

      -- Method: get_content_disposition ()

          Return the lowercased value (without parameters) of the
          message’s ‘Content-Disposition’ header if it has one, or
          ‘None’.  The possible values for this method are `inline',
          `attachment' or ‘None’ if the message follows RFC 2183(12).

          New in version 3.5.

      -- Method: walk ()

          The *note walk(): 27de. method is an all-purpose generator
          which can be used to iterate over all the parts and subparts
          of a message object tree, in depth-first traversal order.  You
          will typically use *note walk(): 27de. as the iterator in a
          ‘for’ loop; each iteration returns the next subpart.

          Here’s an example that prints the MIME type of every part of a
          multipart message structure:

               >>> for part in msg.walk(): ...     print(part.get_content_type()) multipart/report text/plain message/delivery-status text/plain text/plain message/rfc822 text/plain

          ‘walk’ iterates over the subparts of any part where *note
          is_multipart(): 2731. returns ‘True’, even though
          ‘msg.get_content_maintype() == 'multipart'’ may return
          ‘False’.  We can see this in our example by making use of the
          ‘_structure’ debug helper function:

               >>> for part in msg.walk(): ...     print(part.get_content_maintype() == 'multipart', ...           part.is_multipart()) True True False False False True False False False False False True False False >>> _structure(msg) multipart/report     text/plain     message/delivery-status         text/plain         text/plain     message/rfc822         text/plain

          Here the ‘message’ parts are not ‘multiparts’, but they do
          contain subparts.  ‘is_multipart()’ returns ‘True’ and ‘walk’
          descends into the subparts.

     *note Message: 536. objects can also optionally contain two
     instance attributes, which can be used when generating the plain
     text of a MIME message.

      -- Attribute: preamble

          The format of a MIME document allows for some text between the
          blank line following the headers, and the first multipart
          boundary string.  Normally, this text is never visible in a
          MIME-aware mail reader because it falls outside the standard
          MIME armor.  However, when viewing the raw text of the
          message, or when viewing the message in a non-MIME aware
          reader, this text can become visible.

          The `preamble' attribute contains this leading extra-armor
          text for MIME documents.  When the *note Parser: b0b.
          discovers some text after the headers but before the first
          boundary string, it assigns this text to the message’s
          `preamble' attribute.  When the *note Generator: b3f. is
          writing out the plain text representation of a MIME message,
          and it finds the message has a `preamble' attribute, it will
          write this text in the area between the headers and the first
          boundary.  See *note email.parser: 74. and *note
          email.generator: 6e. for details.

          Note that if the message object has no preamble, the
          `preamble' attribute will be ‘None’.

      -- Attribute: epilogue

          The `epilogue' attribute acts the same way as the `preamble'
          attribute, except that it contains text that appears between
          the last boundary and the end of the message.

          You do not need to set the epilogue to the empty string in
          order for the *note Generator: b3f. to print a newline at the
          end of the file.

      -- Attribute: defects

          The `defects' attribute contains a list of all the problems
          found when parsing this message.  See *note email.errors: 6d.
          for a detailed description of the possible parsing defects.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc5233.html

   (2) https://tools.ietf.org/html/rfc2822.html

   (3) https://tools.ietf.org/html/rfc2231.html

   (4) https://tools.ietf.org/html/rfc2231.html

   (5) https://tools.ietf.org/html/rfc2045.html

   (6) https://tools.ietf.org/html/rfc2045.html

   (7) https://tools.ietf.org/html/rfc2045.html

   (8) https://tools.ietf.org/html/rfc2231.html

   (9) https://tools.ietf.org/html/rfc2231.html

   (10) https://tools.ietf.org/html/rfc2045.html

   (11) https://tools.ietf.org/html/rfc2231.html

   (12) https://tools.ietf.org/html/rfc2183.html


File: python.info,  Node: email mime Creating email and MIME objects from scratch,  Next: email header Internationalized headers,  Prev: email message Message Representing an email message using the compat32 API,  Up: email — An email and MIME handling package

5.20.1.14 ‘email.mime’: Creating email and MIME objects from scratch
....................................................................

`Source code:' Lib/email/mime/(1)

__________________________________________________________________

This module is part of the legacy (‘Compat32’) email API. Its
functionality is partially replaced by the *note contentmanager: 6b. in
the new API, but in certain applications these classes may still be
useful, even in non-legacy code.

Ordinarily, you get a message object structure by passing a file or some
text to a parser, which parses the text and returns the root message
object.  However you can also build a complete message structure from
scratch, or even individual *note Message: 536. objects by hand.  In
fact, you can also take an existing structure and add new *note Message:
536. objects, move them around, etc.  This makes a very convenient
interface for slicing-and-dicing MIME messages.

You can create a new object structure by creating *note Message: 536.
instances, adding attachments and all the appropriate headers manually.
For MIME messages though, the *note email: 69. package provides some
convenient subclasses to make things easier.

Here are the classes:

 -- Class: email.mime.base.MIMEBase (_maintype, _subtype, *,
          policy=compat32, **_params)

     Module: ‘email.mime.base’

     This is the base class for all the MIME-specific subclasses of
     *note Message: 536.  Ordinarily you won’t create instances
     specifically of *note MIMEBase: 27e4, although you could.  *note
     MIMEBase: 27e4. is provided primarily as a convenient base class
     for more specific MIME-aware subclasses.

     `_maintype' is the ‘Content-Type’ major type (e.g.  ‘text’ or
     ‘image’), and `_subtype' is the ‘Content-Type’ minor type (e.g.
     ‘plain’ or ‘gif’).  `_params' is a parameter key/value dictionary
     and is passed directly to *note Message.add_header: 27cd.

     If `policy' is specified, (defaults to the *note compat32: 9e9.
     policy) it will be passed to *note Message: 536.

     The *note MIMEBase: 27e4. class always adds a ‘Content-Type’ header
     (based on `_maintype', `_subtype', and `_params'), and a
     ‘MIME-Version’ header (always set to ‘1.0’).

     Changed in version 3.6: Added `policy' keyword-only parameter.

 -- Class: email.mime.nonmultipart.MIMENonMultipart

     Module: ‘email.mime.nonmultipart’

     A subclass of *note MIMEBase: 27e4, this is an intermediate base
     class for MIME messages that are not ‘multipart’.  The primary
     purpose of this class is to prevent the use of the *note attach():
     273f. method, which only makes sense for ‘multipart’ messages.  If
     *note attach(): 273f. is called, a *note MultipartConversionError:
     2785. exception is raised.

 -- Class: email.mime.multipart.MIMEMultipart (_subtype='mixed',
          boundary=None, _subparts=None, *, policy=compat32, **_params)

     Module: ‘email.mime.multipart’

     A subclass of *note MIMEBase: 27e4, this is an intermediate base
     class for MIME messages that are ‘multipart’.  Optional `_subtype'
     defaults to ‘mixed’, but can be used to specify the subtype of the
     message.  A ‘Content-Type’ header of ‘multipart/_subtype’ will be
     added to the message object.  A ‘MIME-Version’ header will also be
     added.

     Optional `boundary' is the multipart boundary string.  When ‘None’
     (the default), the boundary is calculated when needed (for example,
     when the message is serialized).

     `_subparts' is a sequence of initial subparts for the payload.  It
     must be possible to convert this sequence to a list.  You can
     always attach new subparts to the message by using the *note
     Message.attach: 273f. method.

     Optional `policy' argument defaults to *note compat32: 9e9.

     Additional parameters for the ‘Content-Type’ header are taken from
     the keyword arguments, or passed into the `_params' argument, which
     is a keyword dictionary.

     Changed in version 3.6: Added `policy' keyword-only parameter.

 -- Class: email.mime.application.MIMEApplication (_data,
          _subtype='octet-stream',
          _encoder=email.encoders.encode_base64, *, policy=compat32,
          **_params)

     Module: ‘email.mime.application’

     A subclass of *note MIMENonMultipart: 2786, the *note
     MIMEApplication: 27e6. class is used to represent MIME message
     objects of major type ‘application’.  `_data' is a string
     containing the raw byte data.  Optional `_subtype' specifies the
     MIME subtype and defaults to ‘octet-stream’.

     Optional `_encoder' is a callable (i.e.  function) which will
     perform the actual encoding of the data for transport.  This
     callable takes one argument, which is the *note MIMEApplication:
     27e6. instance.  It should use *note get_payload(): b3e. and *note
     set_payload(): 27c0. to change the payload to encoded form.  It
     should also add any ‘Content-Transfer-Encoding’ or other headers to
     the message object as necessary.  The default encoding is base64.
     See the *note email.encoders: 6c. module for a list of the built-in
     encoders.

     Optional `policy' argument defaults to *note compat32: 9e9.

     `_params' are passed straight through to the base class
     constructor.

     Changed in version 3.6: Added `policy' keyword-only parameter.

 -- Class: email.mime.audio.MIMEAudio (_audiodata, _subtype=None,
          _encoder=email.encoders.encode_base64, *, policy=compat32,
          **_params)

     Module: ‘email.mime.audio’

     A subclass of *note MIMENonMultipart: 2786, the *note MIMEAudio:
     27e7. class is used to create MIME message objects of major type
     ‘audio’.  `_audiodata' is a string containing the raw audio data.
     If this data can be decoded by the standard Python module *note
     sndhdr: ee, then the subtype will be automatically included in the
     ‘Content-Type’ header.  Otherwise you can explicitly specify the
     audio subtype via the `_subtype' argument.  If the minor type could
     not be guessed and `_subtype' was not given, then *note TypeError:
     192. is raised.

     Optional `_encoder' is a callable (i.e.  function) which will
     perform the actual encoding of the audio data for transport.  This
     callable takes one argument, which is the *note MIMEAudio: 27e7.
     instance.  It should use *note get_payload(): b3e. and *note
     set_payload(): 27c0. to change the payload to encoded form.  It
     should also add any ‘Content-Transfer-Encoding’ or other headers to
     the message object as necessary.  The default encoding is base64.
     See the *note email.encoders: 6c. module for a list of the built-in
     encoders.

     Optional `policy' argument defaults to *note compat32: 9e9.

     `_params' are passed straight through to the base class
     constructor.

     Changed in version 3.6: Added `policy' keyword-only parameter.

 -- Class: email.mime.image.MIMEImage (_imagedata, _subtype=None,
          _encoder=email.encoders.encode_base64, *, policy=compat32,
          **_params)

     Module: ‘email.mime.image’

     A subclass of *note MIMENonMultipart: 2786, the *note MIMEImage:
     2787. class is used to create MIME message objects of major type
     ‘image’.  `_imagedata' is a string containing the raw image data.
     If this data can be decoded by the standard Python module *note
     imghdr: 99, then the subtype will be automatically included in the
     ‘Content-Type’ header.  Otherwise you can explicitly specify the
     image subtype via the `_subtype' argument.  If the minor type could
     not be guessed and `_subtype' was not given, then *note TypeError:
     192. is raised.

     Optional `_encoder' is a callable (i.e.  function) which will
     perform the actual encoding of the image data for transport.  This
     callable takes one argument, which is the *note MIMEImage: 2787.
     instance.  It should use *note get_payload(): b3e. and *note
     set_payload(): 27c0. to change the payload to encoded form.  It
     should also add any ‘Content-Transfer-Encoding’ or other headers to
     the message object as necessary.  The default encoding is base64.
     See the *note email.encoders: 6c. module for a list of the built-in
     encoders.

     Optional `policy' argument defaults to *note compat32: 9e9.

     `_params' are passed straight through to the *note MIMEBase: 27e4.
     constructor.

     Changed in version 3.6: Added `policy' keyword-only parameter.

 -- Class: email.mime.message.MIMEMessage (_msg, _subtype='rfc822', *,
          policy=compat32)

     Module: ‘email.mime.message’

     A subclass of *note MIMENonMultipart: 2786, the *note MIMEMessage:
     27e8. class is used to create MIME objects of main type ‘message’.
     `_msg' is used as the payload, and must be an instance of class
     *note Message: 536. (or a subclass thereof), otherwise a *note
     TypeError: 192. is raised.

     Optional `_subtype' sets the subtype of the message; it defaults to
     ‘rfc822’.

     Optional `policy' argument defaults to *note compat32: 9e9.

     Changed in version 3.6: Added `policy' keyword-only parameter.

 -- Class: email.mime.text.MIMEText (_text, _subtype='plain',
          _charset=None, *, policy=compat32)

     Module: ‘email.mime.text’

     A subclass of *note MIMENonMultipart: 2786, the *note MIMEText:
     6c7. class is used to create MIME objects of major type ‘text’.
     `_text' is the string for the payload.  `_subtype' is the minor
     type and defaults to ‘plain’.  `_charset' is the character set of
     the text and is passed as an argument to the *note
     MIMENonMultipart: 2786. constructor; it defaults to ‘us-ascii’ if
     the string contains only ‘ascii’ code points, and ‘utf-8’
     otherwise.  The `_charset' parameter accepts either a string or a
     *note Charset: 6c8. instance.

     Unless the `_charset' argument is explicitly set to ‘None’, the
     MIMEText object created will have both a ‘Content-Type’ header with
     a ‘charset’ parameter, and a ‘Content-Transfer-Encoding’ header.
     This means that a subsequent ‘set_payload’ call will not result in
     an encoded payload, even if a charset is passed in the
     ‘set_payload’ command.  You can “reset” this behavior by deleting
     the ‘Content-Transfer-Encoding’ header, after which a ‘set_payload’
     call will automatically encode the new payload (and add a new
     ‘Content-Transfer-Encoding’ header).

     Optional `policy' argument defaults to *note compat32: 9e9.

     Changed in version 3.5: `_charset' also accepts *note Charset: 6c8.
     instances.

     Changed in version 3.6: Added `policy' keyword-only parameter.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/mime/


File: python.info,  Node: email header Internationalized headers,  Next: email charset Representing character sets,  Prev: email mime Creating email and MIME objects from scratch,  Up: email — An email and MIME handling package

5.20.1.15 ‘email.header’: Internationalized headers
...................................................

`Source code:' Lib/email/header.py(1)

__________________________________________________________________

This module is part of the legacy (‘Compat32’) email API. In the current
API encoding and decoding of headers is handled transparently by the
dictionary-like API of the *note EmailMessage: 537. class.  In addition
to uses in legacy code, this module can be useful in applications that
need to completely control the character sets used when encoding
headers.

The remaining text in this section is the original documentation of the
module.

RFC 2822(2) is the base standard that describes the format of email
messages.  It derives from the older RFC 822(3) standard which came into
widespread use at a time when most email was composed of ASCII
characters only.  RFC 2822(4) is a specification written assuming email
contains only 7-bit ASCII characters.

Of course, as email has been deployed worldwide, it has become
internationalized, such that language specific character sets can now be
used in email messages.  The base standard still requires email messages
to be transferred using only 7-bit ASCII characters, so a slew of RFCs
have been written describing how to encode email containing non-ASCII
characters into RFC 2822(5)-compliant format.  These RFCs include RFC
2045(6), RFC 2046(7), RFC 2047(8), and RFC 2231(9).  The *note email:
69. package supports these standards in its *note email.header: 6f. and
*note email.charset: 6a. modules.

If you want to include non-ASCII characters in your email headers, say
in the ‘Subject’ or ‘To’ fields, you should use the *note Header: 277d.
class and assign the field in the *note Message: 536. object to an
instance of *note Header: 277d. instead of using a string for the header
value.  Import the *note Header: 277d. class from the *note
email.header: 6f. module.  For example:

     >>> from email.message import Message >>> from email.header import Header >>> msg = Message() >>> h = Header('p\xf6stal', 'iso-8859-1') >>> msg['Subject'] = h >>> msg.as_string() 'Subject: =?iso-8859-1?q?p=F6stal?=\n\n'

Notice here how we wanted the ‘Subject’ field to contain a non-ASCII
character?  We did this by creating a *note Header: 277d. instance and
passing in the character set that the byte string was encoded in.  When
the subsequent *note Message: 536. instance was flattened, the ‘Subject’
field was properly RFC 2047(10) encoded.  MIME-aware mail readers would
show this header using the embedded ISO-8859-1 character.

Here is the *note Header: 277d. class description:

 -- Class: email.header.Header (s=None, charset=None, maxlinelen=None,
          header_name=None, continuation_ws=' ', errors='strict')

     Create a MIME-compliant header that can contain strings in
     different character sets.

     Optional `s' is the initial header value.  If ‘None’ (the default),
     the initial header value is not set.  You can later append to the
     header with *note append(): 27eb. method calls.  `s' may be an
     instance of *note bytes: 326. or *note str: 325, but see the *note
     append(): 27eb. documentation for semantics.

     Optional `charset' serves two purposes: it has the same meaning as
     the `charset' argument to the *note append(): 27eb. method.  It
     also sets the default character set for all subsequent *note
     append(): 27eb. calls that omit the `charset' argument.  If
     `charset' is not provided in the constructor (the default), the
     ‘us-ascii’ character set is used both as `s'’s initial charset and
     as the default for subsequent *note append(): 27eb. calls.

     The maximum line length can be specified explicitly via
     `maxlinelen'.  For splitting the first line to a shorter value (to
     account for the field header which isn’t included in `s', e.g.
     ‘Subject’) pass in the name of the field in `header_name'.  The
     default `maxlinelen' is 76, and the default value for `header_name'
     is ‘None’, meaning it is not taken into account for the first line
     of a long, split header.

     Optional `continuation_ws' must be RFC 2822(11)-compliant folding
     whitespace, and is usually either a space or a hard tab character.
     This character will be prepended to continuation lines.
     `continuation_ws' defaults to a single space character.

     Optional `errors' is passed straight through to the *note append():
     27eb. method.

      -- Method: append (s, charset=None, errors='strict')

          Append the string `s' to the MIME header.

          Optional `charset', if given, should be a *note Charset: 6c8.
          instance (see *note email.charset: 6a.) or the name of a
          character set, which will be converted to a *note Charset:
          6c8. instance.  A value of ‘None’ (the default) means that the
          `charset' given in the constructor is used.

          `s' may be an instance of *note bytes: 326. or *note str: 325.
          If it is an instance of *note bytes: 326, then `charset' is
          the encoding of that byte string, and a *note UnicodeError:
          c2e. will be raised if the string cannot be decoded with that
          character set.

          If `s' is an instance of *note str: 325, then `charset' is a
          hint specifying the character set of the characters in the
          string.

          In either case, when producing an RFC 2822(12)-compliant
          header using RFC 2047(13) rules, the string will be encoded
          using the output codec of the charset.  If the string cannot
          be encoded using the output codec, a UnicodeError will be
          raised.

          Optional `errors' is passed as the errors argument to the
          decode call if `s' is a byte string.

      -- Method: encode (splitchars=';, \t', maxlinelen=None,
               linesep='\n')

          Encode a message header into an RFC-compliant format, possibly
          wrapping long lines and encapsulating non-ASCII parts in
          base64 or quoted-printable encodings.

          Optional `splitchars' is a string containing characters which
          should be given extra weight by the splitting algorithm during
          normal header wrapping.  This is in very rough support of RFC
          2822(14)’s ‘higher level syntactic breaks’: split points
          preceded by a splitchar are preferred during line splitting,
          with the characters preferred in the order in which they
          appear in the string.  Space and tab may be included in the
          string to indicate whether preference should be given to one
          over the other as a split point when other split chars do not
          appear in the line being split.  Splitchars does not affect
          RFC 2047(15) encoded lines.

          `maxlinelen', if given, overrides the instance’s value for the
          maximum line length.

          `linesep' specifies the characters used to separate the lines
          of the folded header.  It defaults to the most useful value
          for Python application code (‘\n’), but ‘\r\n’ can be
          specified in order to produce headers with RFC-compliant line
          separators.

          Changed in version 3.2: Added the `linesep' argument.

     The *note Header: 277d. class also provides a number of methods to
     support standard operators and built-in functions.

      -- Method: __str__ ()

          Returns an approximation of the *note Header: 277d. as a
          string, using an unlimited line length.  All pieces are
          converted to unicode using the specified encoding and joined
          together appropriately.  Any pieces with a charset of
          ‘'unknown-8bit'’ are decoded as ASCII using the ‘'replace'’
          error handler.

          Changed in version 3.2: Added handling for the
          ‘'unknown-8bit'’ charset.

      -- Method: __eq__ (other)

          This method allows you to compare two *note Header: 277d.
          instances for equality.

      -- Method: __ne__ (other)

          This method allows you to compare two *note Header: 277d.
          instances for inequality.

The *note email.header: 6f. module also provides the following
convenient functions.

 -- Function: email.header.decode_header (header)

     Decode a message header value without converting the character set.
     The header value is in `header'.

     This function returns a list of ‘(decoded_string, charset)’ pairs
     containing each of the decoded parts of the header.  `charset' is
     ‘None’ for non-encoded parts of the header, otherwise a lower case
     string containing the name of the character set specified in the
     encoded string.

     Here’s an example:

          >>> from email.header import decode_header >>> decode_header('=?iso-8859-1?q?p=F6stal?=') [(b'p\xf6stal', 'iso-8859-1')]

 -- Function: email.header.make_header (decoded_seq, maxlinelen=None,
          header_name=None, continuation_ws=' ')

     Create a *note Header: 277d. instance from a sequence of pairs as
     returned by *note decode_header(): 9ed.

     *note decode_header(): 9ed. takes a header value string and returns
     a sequence of pairs of the format ‘(decoded_string, charset)’ where
     `charset' is the name of the character set.

     This function takes one of those sequence of pairs and returns a
     *note Header: 277d. instance.  Optional `maxlinelen',
     `header_name', and `continuation_ws' are as in the *note Header:
     277d. constructor.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/header.py

   (2) https://tools.ietf.org/html/rfc2822.html

   (3) https://tools.ietf.org/html/rfc822.html

   (4) https://tools.ietf.org/html/rfc2822.html

   (5) https://tools.ietf.org/html/rfc2822.html

   (6) https://tools.ietf.org/html/rfc2045.html

   (7) https://tools.ietf.org/html/rfc2046.html

   (8) https://tools.ietf.org/html/rfc2047.html

   (9) https://tools.ietf.org/html/rfc2231.html

   (10) https://tools.ietf.org/html/rfc2047.html

   (11) https://tools.ietf.org/html/rfc2822.html

   (12) https://tools.ietf.org/html/rfc2822.html

   (13) https://tools.ietf.org/html/rfc2047.html

   (14) https://tools.ietf.org/html/rfc2822.html

   (15) https://tools.ietf.org/html/rfc2047.html


File: python.info,  Node: email charset Representing character sets,  Next: email encoders Encoders,  Prev: email header Internationalized headers,  Up: email — An email and MIME handling package

5.20.1.16 ‘email.charset’: Representing character sets
......................................................

`Source code:' Lib/email/charset.py(1)

__________________________________________________________________

This module is part of the legacy (‘Compat32’) email API. In the new API
only the aliases table is used.

The remaining text in this section is the original documentation of the
module.

This module provides a class *note Charset: 6c8. for representing
character sets and character set conversions in email messages, as well
as a character set registry and several convenience methods for
manipulating this registry.  Instances of *note Charset: 6c8. are used
in several other modules within the *note email: 69. package.

Import this class from the *note email.charset: 6a. module.

 -- Class: email.charset.Charset (input_charset=DEFAULT_CHARSET)

     Map character sets to their email properties.

     This class provides information about the requirements imposed on
     email for a specific character set.  It also provides convenience
     routines for converting between character sets, given the
     availability of the applicable codecs.  Given a character set, it
     will do its best to provide information on how to use that
     character set in an email message in an RFC-compliant way.

     Certain character sets must be encoded with quoted-printable or
     base64 when used in email headers or bodies.  Certain character
     sets must be converted outright, and are not allowed in email.

     Optional `input_charset' is as described below; it is always
     coerced to lower case.  After being alias normalized it is also
     used as a lookup into the registry of character sets to find out
     the header encoding, body encoding, and output conversion codec to
     be used for the character set.  For example, if `input_charset' is
     ‘iso-8859-1’, then headers and bodies will be encoded using
     quoted-printable and no output conversion codec is necessary.  If
     `input_charset' is ‘euc-jp’, then headers will be encoded with
     base64, bodies will not be encoded, but output text will be
     converted from the ‘euc-jp’ character set to the ‘iso-2022-jp’
     character set.

     *note Charset: 6c8. instances have the following data attributes:

      -- Attribute: input_charset

          The initial character set specified.  Common aliases are
          converted to their `official' email names (e.g.  ‘latin_1’ is
          converted to ‘iso-8859-1’).  Defaults to 7-bit ‘us-ascii’.

      -- Attribute: header_encoding

          If the character set must be encoded before it can be used in
          an email header, this attribute will be set to ‘Charset.QP’
          (for quoted-printable), ‘Charset.BASE64’ (for base64
          encoding), or ‘Charset.SHORTEST’ for the shortest of QP or
          BASE64 encoding.  Otherwise, it will be ‘None’.

      -- Attribute: body_encoding

          Same as `header_encoding', but describes the encoding for the
          mail message’s body, which indeed may be different than the
          header encoding.  ‘Charset.SHORTEST’ is not allowed for
          `body_encoding'.

      -- Attribute: output_charset

          Some character sets must be converted before they can be used
          in email headers or bodies.  If the `input_charset' is one of
          them, this attribute will contain the name of the character
          set output will be converted to.  Otherwise, it will be
          ‘None’.

      -- Attribute: input_codec

          The name of the Python codec used to convert the
          `input_charset' to Unicode.  If no conversion codec is
          necessary, this attribute will be ‘None’.

      -- Attribute: output_codec

          The name of the Python codec used to convert Unicode to the
          `output_charset'.  If no conversion codec is necessary, this
          attribute will have the same value as the `input_codec'.

     *note Charset: 6c8. instances also have the following methods:

      -- Method: get_body_encoding ()

          Return the content transfer encoding used for body encoding.

          This is either the string ‘quoted-printable’ or ‘base64’
          depending on the encoding used, or it is a function, in which
          case you should call the function with a single argument, the
          Message object being encoded.  The function should then set
          the ‘Content-Transfer-Encoding’ header itself to whatever is
          appropriate.

          Returns the string ‘quoted-printable’ if `body_encoding' is
          ‘QP’, returns the string ‘base64’ if `body_encoding' is
          ‘BASE64’, and returns the string ‘7bit’ otherwise.

      -- Method: get_output_charset ()

          Return the output character set.

          This is the `output_charset' attribute if that is not ‘None’,
          otherwise it is `input_charset'.

      -- Method: header_encode (string)

          Header-encode the string `string'.

          The type of encoding (base64 or quoted-printable) will be
          based on the `header_encoding' attribute.

      -- Method: header_encode_lines (string, maxlengths)

          Header-encode a `string' by converting it first to bytes.

          This is similar to *note header_encode(): 27fa. except that
          the string is fit into maximum line lengths as given by the
          argument `maxlengths', which must be an iterator: each element
          returned from this iterator will provide the next maximum line
          length.

      -- Method: body_encode (string)

          Body-encode the string `string'.

          The type of encoding (base64 or quoted-printable) will be
          based on the `body_encoding' attribute.

     The *note Charset: 6c8. class also provides a number of methods to
     support standard operations and built-in functions.

      -- Method: __str__ ()

          Returns `input_charset' as a string coerced to lower case.
          *note __repr__(): 333. is an alias for *note __str__(): 27fd.

      -- Method: __eq__ (other)

          This method allows you to compare two *note Charset: 6c8.
          instances for equality.

      -- Method: __ne__ (other)

          This method allows you to compare two *note Charset: 6c8.
          instances for inequality.

The *note email.charset: 6a. module also provides the following
functions for adding new entries to the global character set, alias, and
codec registries:

 -- Function: email.charset.add_charset (charset, header_enc=None,
          body_enc=None, output_charset=None)

     Add character properties to the global registry.

     `charset' is the input character set, and must be the canonical
     name of a character set.

     Optional `header_enc' and `body_enc' is either ‘Charset.QP’ for
     quoted-printable, ‘Charset.BASE64’ for base64 encoding,
     ‘Charset.SHORTEST’ for the shortest of quoted-printable or base64
     encoding, or ‘None’ for no encoding.  ‘SHORTEST’ is only valid for
     `header_enc'.  The default is ‘None’ for no encoding.

     Optional `output_charset' is the character set that the output
     should be in.  Conversions will proceed from input charset, to
     Unicode, to the output charset when the method ‘Charset.convert()’
     is called.  The default is to output in the same character set as
     the input.

     Both `input_charset' and `output_charset' must have Unicode codec
     entries in the module’s character set-to-codec mapping; use *note
     add_codec(): 2801. to add codecs the module does not know about.
     See the *note codecs: 1c. module’s documentation for more
     information.

     The global character set registry is kept in the module global
     dictionary ‘CHARSETS’.

 -- Function: email.charset.add_alias (alias, canonical)

     Add a character set alias.  `alias' is the alias name, e.g.
     ‘latin-1’.  `canonical' is the character set’s canonical name, e.g.
     ‘iso-8859-1’.

     The global charset alias registry is kept in the module global
     dictionary ‘ALIASES’.

 -- Function: email.charset.add_codec (charset, codecname)

     Add a codec that map characters in the given character set to and
     from Unicode.

     `charset' is the canonical name of a character set.  `codecname' is
     the name of a Python codec, as appropriate for the second argument
     to the *note str: 325.’s *note encode(): c2a. method.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/charset.py


File: python.info,  Node: email encoders Encoders,  Next: email utils Miscellaneous utilities,  Prev: email charset Representing character sets,  Up: email — An email and MIME handling package

5.20.1.17 ‘email.encoders’: Encoders
....................................

`Source code:' Lib/email/encoders.py(1)

__________________________________________________________________

This module is part of the legacy (‘Compat32’) email API. In the new API
the functionality is provided by the `cte' parameter of the *note
set_content(): 2739. method.

This module is deprecated in Python 3.  The functions provided here
should not be called explicitly since the *note MIMEText: 6c7. class
sets the content type and CTE header using the `_subtype' and `_charset'
values passed during the instaniation of that class.

The remaining text in this section is the original documentation of the
module.

When creating *note Message: 536. objects from scratch, you often need
to encode the payloads for transport through compliant mail servers.
This is especially true for ‘image/*’ and ‘text/*’ type messages
containing binary data.

The *note email: 69. package provides some convenient encoders in its
‘encoders’ module.  These encoders are actually used by the *note
MIMEAudio: 27e7. and *note MIMEImage: 2787. class constructors to
provide default encodings.  All encoder functions take exactly one
argument, the message object to encode.  They usually extract the
payload, encode it, and reset the payload to this newly encoded value.
They should also set the ‘Content-Transfer-Encoding’ header as
appropriate.

Note that these functions are not meaningful for a multipart message.
They must be applied to individual subparts instead, and will raise a
*note TypeError: 192. if passed a message whose type is multipart.

Here are the encoding functions provided:

 -- Function: email.encoders.encode_quopri (msg)

     Encodes the payload into quoted-printable form and sets the
     ‘Content-Transfer-Encoding’ header to ‘quoted-printable’ (2).  This
     is a good encoding to use when most of your payload is normal
     printable data, but contains a few unprintable characters.

 -- Function: email.encoders.encode_base64 (msg)

     Encodes the payload into base64 form and sets the
     ‘Content-Transfer-Encoding’ header to ‘base64’.  This is a good
     encoding to use when most of your payload is unprintable data since
     it is a more compact form than quoted-printable.  The drawback of
     base64 encoding is that it renders the text non-human readable.

 -- Function: email.encoders.encode_7or8bit (msg)

     This doesn’t actually modify the message’s payload, but it does set
     the ‘Content-Transfer-Encoding’ header to either ‘7bit’ or ‘8bit’
     as appropriate, based on the payload data.

 -- Function: email.encoders.encode_noop (msg)

     This does nothing; it doesn’t even set the
     ‘Content-Transfer-Encoding’ header.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/encoders.py

   (2) (1) Note that encoding with *note encode_quopri(): 2805. also
encodes all tabs and space characters in the data.


File: python.info,  Node: email utils Miscellaneous utilities,  Next: email iterators Iterators,  Prev: email encoders Encoders,  Up: email — An email and MIME handling package

5.20.1.18 ‘email.utils’: Miscellaneous utilities
................................................

`Source code:' Lib/email/utils.py(1)

__________________________________________________________________

There are a couple of useful utilities provided in the *note
email.utils: 76. module:

 -- Function: email.utils.localtime (dt=None)

     Return local time as an aware datetime object.  If called without
     arguments, return current time.  Otherwise `dt' argument should be
     a *note datetime: 194. instance, and it is converted to the local
     time zone according to the system time zone database.  If `dt' is
     naive (that is, ‘dt.tzinfo’ is ‘None’), it is assumed to be in
     local time.  In this case, a positive or zero value for `isdst'
     causes ‘localtime’ to presume initially that summer time (for
     example, Daylight Saving Time) is or is not (respectively) in
     effect for the specified time.  A negative value for `isdst' causes
     the ‘localtime’ to attempt to divine whether summer time is in
     effect for the specified time.

     New in version 3.3.

 -- Function: email.utils.make_msgid (idstring=None, domain=None)

     Returns a string suitable for an RFC 2822(2)-compliant ‘Message-ID’
     header.  Optional `idstring' if given, is a string used to
     strengthen the uniqueness of the message id.  Optional `domain' if
     given provides the portion of the msgid after the ‘@’.  The default
     is the local hostname.  It is not normally necessary to override
     this default, but may be useful certain cases, such as a
     constructing distributed system that uses a consistent domain name
     across multiple hosts.

     Changed in version 3.2: Added the `domain' keyword.

The remaining functions are part of the legacy (‘Compat32’) email API.
There is no need to directly use these with the new API, since the
parsing and formatting they provide is done automatically by the header
parsing machinery of the new API.

 -- Function: email.utils.quote (str)

     Return a new string with backslashes in `str' replaced by two
     backslashes, and double quotes replaced by backslash-double quote.

 -- Function: email.utils.unquote (str)

     Return a new string which is an `unquoted' version of `str'.  If
     `str' ends and begins with double quotes, they are stripped off.
     Likewise if `str' ends and begins with angle brackets, they are
     stripped off.

 -- Function: email.utils.parseaddr (address)

     Parse address – which should be the value of some
     address-containing field such as ‘To’ or ‘Cc’ – into its
     constituent `realname' and `email address' parts.  Returns a tuple
     of that information, unless the parse fails, in which case a
     2-tuple of ‘('', '')’ is returned.

 -- Function: email.utils.formataddr (pair, charset='utf-8')

     The inverse of *note parseaddr(): 280d, this takes a 2-tuple of the
     form ‘(realname, email_address)’ and returns the string value
     suitable for a ‘To’ or ‘Cc’ header.  If the first element of `pair'
     is false, then the second element is returned unmodified.

     Optional `charset' is the character set that will be used in the
     RFC 2047(3) encoding of the ‘realname’ if the ‘realname’ contains
     non-ASCII characters.  Can be an instance of *note str: 325. or a
     *note Charset: 6c8.  Defaults to ‘utf-8’.

     Changed in version 3.3: Added the `charset' option.

 -- Function: email.utils.getaddresses (fieldvalues)

     This method returns a list of 2-tuples of the form returned by
     ‘parseaddr()’.  `fieldvalues' is a sequence of header field values
     as might be returned by *note Message.get_all: 27c7.  Here’s a
     simple example that gets all the recipients of a message:

          from email.utils import getaddresses  tos = msg.get_all('to', []) ccs = msg.get_all('cc', []) resent_tos = msg.get_all('resent-to', []) resent_ccs = msg.get_all('resent-cc', []) all_recipients = getaddresses(tos + ccs + resent_tos + resent_ccs)

 -- Function: email.utils.parsedate (date)

     Attempts to parse a date according to the rules in RFC 2822(4).
     however, some mailers don’t follow that format as specified, so
     *note parsedate(): 280f. tries to guess correctly in such cases.
     `date' is a string containing an RFC 2822(5) date, such as ‘"Mon,
     20 Nov 1995 19:12:08 -0500"’.  If it succeeds in parsing the date,
     *note parsedate(): 280f. returns a 9-tuple that can be passed
     directly to *note time.mktime(): b57.; otherwise ‘None’ will be
     returned.  Note that indexes 6, 7, and 8 of the result tuple are
     not usable.

 -- Function: email.utils.parsedate_tz (date)

     Performs the same function as *note parsedate(): 280f, but returns
     either ‘None’ or a 10-tuple; the first 9 elements make up a tuple
     that can be passed directly to *note time.mktime(): b57, and the
     tenth is the offset of the date’s timezone from UTC (which is the
     official term for Greenwich Mean Time) (6).  If the input string
     has no timezone, the last element of the tuple returned is ‘0’,
     which represents UTC. Note that indexes 6, 7, and 8 of the result
     tuple are not usable.

 -- Function: email.utils.parsedate_to_datetime (date)

     The inverse of *note format_datetime(): 9f2.  Performs the same
     function as *note parsedate(): 280f, but on success returns a *note
     datetime: 194.  If the input date has a timezone of ‘-0000’, the
     ‘datetime’ will be a naive ‘datetime’, and if the date is
     conforming to the RFCs it will represent a time in UTC but with no
     indication of the actual source timezone of the message the date
     comes from.  If the input date has any other valid timezone offset,
     the ‘datetime’ will be an aware ‘datetime’ with the corresponding a
     *note timezone: 9f5. *note tzinfo: 375.

     New in version 3.3.

 -- Function: email.utils.mktime_tz (tuple)

     Turn a 10-tuple as returned by *note parsedate_tz(): 2810. into a
     UTC timestamp (seconds since the Epoch).  If the timezone item in
     the tuple is ‘None’, assume local time.

 -- Function: email.utils.formatdate (timeval=None, localtime=False,
          usegmt=False)

     Returns a date string as per RFC 2822(7), e.g.:

          Fri, 09 Nov 2001 01:08:47 -0000

     Optional `timeval' if given is a floating point time value as
     accepted by *note time.gmtime(): b32. and *note time.localtime():
     17ea, otherwise the current time is used.

     Optional `localtime' is a flag that when ‘True’, interprets
     `timeval', and returns a date relative to the local timezone
     instead of UTC, properly taking daylight savings time into account.
     The default is ‘False’ meaning UTC is used.

     Optional `usegmt' is a flag that when ‘True’, outputs a date string
     with the timezone as an ascii string ‘GMT’, rather than a numeric
     ‘-0000’.  This is needed for some protocols (such as HTTP). This
     only applies when `localtime' is ‘False’.  The default is ‘False’.

 -- Function: email.utils.format_datetime (dt, usegmt=False)

     Like ‘formatdate’, but the input is a *note datetime: 31. instance.
     If it is a naive datetime, it is assumed to be “UTC with no
     information about the source timezone”, and the conventional
     ‘-0000’ is used for the timezone.  If it is an aware ‘datetime’,
     then the numeric timezone offset is used.  If it is an aware
     timezone with offset zero, then `usegmt' may be set to ‘True’, in
     which case the string ‘GMT’ is used instead of the numeric timezone
     offset.  This provides a way to generate standards conformant HTTP
     date headers.

     New in version 3.3.

 -- Function: email.utils.decode_rfc2231 (s)

     Decode the string `s' according to RFC 2231(8).

 -- Function: email.utils.encode_rfc2231 (s, charset=None,
          language=None)

     Encode the string `s' according to RFC 2231(9).  Optional `charset'
     and `language', if given is the character set name and language
     name to use.  If neither is given, `s' is returned as-is.  If
     `charset' is given but `language' is not, the string is encoded
     using the empty string for `language'.

 -- Function: email.utils.collapse_rfc2231_value (value,
          errors='replace', fallback_charset='us-ascii')

     When a header parameter is encoded in RFC 2231(10) format, *note
     Message.get_param: 27d5. may return a 3-tuple containing the
     character set, language, and value.  *note
     collapse_rfc2231_value(): 27d6. turns this into a unicode string.
     Optional `errors' is passed to the `errors' argument of *note str:
     325.’s *note encode(): c2a. method; it defaults to ‘'replace'’.
     Optional `fallback_charset' specifies the character set to use if
     the one in the RFC 2231(11) header is not known by Python; it
     defaults to ‘'us-ascii'’.

     For convenience, if the `value' passed to *note
     collapse_rfc2231_value(): 27d6. is not a tuple, it should be a
     string and it is returned unquoted.

 -- Function: email.utils.decode_params (params)

     Decode parameters list according to RFC 2231(12).  `params' is a
     sequence of 2-tuples containing elements of the form
     ‘(content-type, string-value)’.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/utils.py

   (2) https://tools.ietf.org/html/rfc2822.html

   (3) https://tools.ietf.org/html/rfc2047.html

   (4) https://tools.ietf.org/html/rfc2822.html

   (5) https://tools.ietf.org/html/rfc2822.html

   (6) (1) Note that the sign of the timezone offset is the opposite of
the sign of the ‘time.timezone’ variable for the same timezone; the
latter variable follows the POSIX standard while this module follows RFC
2822 (https://tools.ietf.org/html/rfc2822.html).

   (7) https://tools.ietf.org/html/rfc2822.html

   (8) https://tools.ietf.org/html/rfc2231.html

   (9) https://tools.ietf.org/html/rfc2231.html

   (10) https://tools.ietf.org/html/rfc2231.html

   (11) https://tools.ietf.org/html/rfc2231.html

   (12) https://tools.ietf.org/html/rfc2231.html


File: python.info,  Node: email iterators Iterators,  Prev: email utils Miscellaneous utilities,  Up: email — An email and MIME handling package

5.20.1.19 ‘email.iterators’: Iterators
......................................

`Source code:' Lib/email/iterators.py(1)

__________________________________________________________________

Iterating over a message object tree is fairly easy with the *note
Message.walk: 27de. method.  The *note email.iterators: 71. module
provides some useful higher level iterations over message object trees.

 -- Function: email.iterators.body_line_iterator (msg, decode=False)

     This iterates over all the payloads in all the subparts of `msg',
     returning the string payloads line-by-line.  It skips over all the
     subpart headers, and it skips over any subpart with a payload that
     isn’t a Python string.  This is somewhat equivalent to reading the
     flat text representation of the message from a file using *note
     readline(): 1b36, skipping over all the intervening headers.

     Optional `decode' is passed through to *note Message.get_payload:
     b3e.

 -- Function: email.iterators.typed_subpart_iterator (msg,
          maintype='text', subtype=None)

     This iterates over all the subparts of `msg', returning only those
     subparts that match the MIME type specified by `maintype' and
     `subtype'.

     Note that `subtype' is optional; if omitted, then subpart MIME type
     matching is done only with the main type.  `maintype' is optional
     too; it defaults to ‘text’.

     Thus, by default *note typed_subpart_iterator(): 2819. returns each
     subpart that has a MIME type of ‘text/*’.

The following function has been added as a useful debugging tool.  It
should `not' be considered part of the supported public interface for
the package.

 -- Function: email.iterators._structure (msg, fp=None, level=0,
          include_default=False)

     Prints an indented representation of the content types of the
     message object structure.  For example:

          >>> msg = email.message_from_file(somefile) >>> _structure(msg) multipart/mixed     text/plain     text/plain     multipart/digest         message/rfc822             text/plain         message/rfc822             text/plain         message/rfc822             text/plain         message/rfc822             text/plain         message/rfc822             text/plain     text/plain

     Optional `fp' is a file-like object to print the output to.  It
     must be suitable for Python’s *note print(): 87a. function.
     `level' is used internally.  `include_default', if true, prints the
     default type as well.

See also
........

Module *note smtplib: ed.

     SMTP (Simple Mail Transport Protocol) client

Module *note poplib: d0.

     POP (Post Office Protocol) client

Module *note imaplib: 98.

     IMAP (Internet Message Access Protocol) client

Module *note nntplib: c0.

     NNTP (Net News Transport Protocol) client

Module *note mailbox: ae.

     Tools for creating, reading, and managing collections of messages
     on disk using a variety standard formats.

Module *note smtpd: ec.

     SMTP server framework (primarily useful for testing)

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/email/iterators.py


File: python.info,  Node: json — JSON encoder and decoder,  Next: mailcap — Mailcap file handling,  Prev: email — An email and MIME handling package,  Up: Internet Data Handling

5.20.2 ‘json’ — JSON encoder and decoder
----------------------------------------

`Source code:' Lib/json/__init__.py(1)

__________________________________________________________________

JSON (JavaScript Object Notation)(2), specified by RFC 7159(3) (which
obsoletes RFC 4627(4)) and by ECMA-404(5), is a lightweight data
interchange format inspired by JavaScript(6) object literal syntax
(although it is not a strict subset of JavaScript (7) ).

*note json: a4. exposes an API familiar to users of the standard library
*note marshal: b0. and *note pickle: ca. modules.

Encoding basic Python object hierarchies:

     >>> import json >>> json.dumps(['foo', {'bar': ('baz', None, 1.0, 2)}]) '["foo", {"bar": ["baz", null, 1.0, 2]}]' >>> print(json.dumps("\"foo\bar")) "\"foo\bar" >>> print(json.dumps('\u1234')) "\u1234" >>> print(json.dumps('\\')) "\\" >>> print(json.dumps({"c": 0, "b": 0, "a": 0}, sort_keys=True)) {"a": 0, "b": 0, "c": 0} >>> from io import StringIO >>> io = StringIO() >>> json.dump(['streaming API'], io) >>> io.getvalue() '["streaming API"]'

Compact encoding:

     >>> import json >>> json.dumps([1, 2, 3, {'4': 5, '6': 7}], separators=(',', ':')) '[1,2,3,{"4":5,"6":7}]'

Pretty printing:

     >>> import json >>> print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4)) {     "4": 5,     "6": 7 }

Decoding JSON:

     >>> import json >>> json.loads('["foo", {"bar":["baz", null, 1.0, 2]}]') ['foo', {'bar': ['baz', None, 1.0, 2]}] >>> json.loads('"\\"foo\\bar"') '"foo\x08ar' >>> from io import StringIO >>> io = StringIO('["streaming API"]') >>> json.load(io) ['streaming API']

Specializing JSON object decoding:

     >>> import json >>> def as_complex(dct): ...     if '__complex__' in dct: ...         return complex(dct['real'], dct['imag']) ...     return dct ... >>> json.loads('{"__complex__": true, "real": 1, "imag": 2}', ...     object_hook=as_complex) (1+2j) >>> import decimal >>> json.loads('1.1', parse_float=decimal.Decimal) Decimal('1.1')

Extending *note JSONEncoder: 5fb.:

     >>> import json >>> class ComplexEncoder(json.JSONEncoder): ...     def default(self, obj): ...         if isinstance(obj, complex): ...             return [obj.real, obj.imag] ...         # Let the base class default method raise the TypeError ...         return json.JSONEncoder.default(self, obj) ... >>> json.dumps(2 + 1j, cls=ComplexEncoder) '[2.0, 1.0]' >>> ComplexEncoder().encode(2 + 1j) '[2.0, 1.0]' >>> list(ComplexEncoder().iterencode(2 + 1j)) ['[2.0', ', 1.0', ']']

Using *note json.tool: a5. from the shell to validate and pretty-print:

     $ echo '{"json":"obj"}' | python -m json.tool {     "json": "obj" } $ echo '{1.2:3.4}' | python -m json.tool Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

See *note Command Line Interface: 281d. for detailed documentation.

     Note: JSON is a subset of YAML(8) 1.2.  The JSON produced by this
     module’s default settings (in particular, the default `separators'
     value) is also a subset of YAML 1.0 and 1.1.  This module can thus
     also be used as a YAML serializer.

     Note: This module’s encoders and decoders preserve input and output
     order by default.  Order is only lost if the underlying containers
     are unordered.

     Prior to Python 3.7, *note dict: 1b6. was not guaranteed to be
     ordered, so inputs and outputs were typically scrambled unless
     *note collections.OrderedDict: 1b7. was specifically requested.
     Starting with Python 3.7, the regular *note dict: 1b6. became order
     preserving, so it is no longer necessary to specify *note
     collections.OrderedDict: 1b7. for JSON generation and parsing.

* Menu:

* Basic Usage::
* Encoders and Decoders::
* Exceptions: Exceptions<13>.
* Standard Compliance and Interoperability::
* Command Line Interface: Command Line Interface<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/json/__init__.py

   (2) http://json.org

   (3) https://tools.ietf.org/html/rfc7159.html

   (4) https://tools.ietf.org/html/rfc4627.html

   (5) 
http://www.ecma-international.org/publications/standards/Ecma-404.htm

   (6) https://en.wikipedia.org/wiki/JavaScript

   (7) (1) As noted in the errata for RFC 7159
(https://www.rfc-editor.org/errata_search.php?rfc=7159), JSON permits
literal U+2028 (LINE SEPARATOR) and U+2029 (PARAGRAPH SEPARATOR)
characters in strings, whereas JavaScript (as of ECMAScript Edition 5.1)
does not.

   (8) http://yaml.org/


File: python.info,  Node: Basic Usage,  Next: Encoders and Decoders,  Up: json — JSON encoder and decoder

5.20.2.1 Basic Usage
....................

 -- Function: json.dump (obj, fp, *, skipkeys=False, ensure_ascii=True,
          check_circular=True, allow_nan=True, cls=None, indent=None,
          separators=None, default=None, sort_keys=False, **kw)

     Serialize `obj' as a JSON formatted stream to `fp' (a
     ‘.write()’-supporting *note file-like object: 1ba2.) using this
     *note conversion table: 281f.

     If `skipkeys' is true (default: ‘False’), then dict keys that are
     not of a basic type (*note str: 325, *note int: 184, *note float:
     187, *note bool: 183, ‘None’) will be skipped instead of raising a
     *note TypeError: 192.

     The *note json: a4. module always produces *note str: 325. objects,
     not *note bytes: 326. objects.  Therefore, ‘fp.write()’ must
     support *note str: 325. input.

     If `ensure_ascii' is true (the default), the output is guaranteed
     to have all incoming non-ASCII characters escaped.  If
     `ensure_ascii' is false, these characters will be output as-is.

     If `check_circular' is false (default: ‘True’), then the circular
     reference check for container types will be skipped and a circular
     reference will result in an *note OverflowError: 954. (or worse).

     If `allow_nan' is false (default: ‘True’), then it will be a *note
     ValueError: 1f9. to serialize out of range *note float: 187. values
     (‘nan’, ‘inf’, ‘-inf’) in strict compliance of the JSON
     specification.  If `allow_nan' is true, their JavaScript
     equivalents (‘NaN’, ‘Infinity’, ‘-Infinity’) will be used.

     If `indent' is a non-negative integer or string, then JSON array
     elements and object members will be pretty-printed with that indent
     level.  An indent level of 0, negative, or ‘""’ will only insert
     newlines.  ‘None’ (the default) selects the most compact
     representation.  Using a positive integer indent indents that many
     spaces per level.  If `indent' is a string (such as ‘"\t"’), that
     string is used to indent each level.

     Changed in version 3.2: Allow strings for `indent' in addition to
     integers.

     If specified, `separators' should be an ‘(item_separator,
     key_separator)’ tuple.  The default is ‘(', ', ': ')’ if `indent'
     is ‘None’ and ‘(',', ': ')’ otherwise.  To get the most compact
     JSON representation, you should specify ‘(',', ':')’ to eliminate
     whitespace.

     Changed in version 3.4: Use ‘(',', ': ')’ as default if `indent' is
     not ‘None’.

     If specified, `default' should be a function that gets called for
     objects that can’t otherwise be serialized.  It should return a
     JSON encodable version of the object or raise a *note TypeError:
     192.  If not specified, *note TypeError: 192. is raised.

     If `sort_keys' is true (default: ‘False’), then the output of
     dictionaries will be sorted by key.

     To use a custom *note JSONEncoder: 5fb. subclass (e.g.  one that
     overrides the ‘default()’ method to serialize additional types),
     specify it with the `cls' kwarg; otherwise *note JSONEncoder: 5fb.
     is used.

     Changed in version 3.6: All optional parameters are now *note
     keyword-only: 2aa.

          Note: Unlike *note pickle: ca. and *note marshal: b0, JSON is
          not a framed protocol, so trying to serialize multiple objects
          with repeated calls to *note dump(): 5f9. using the same `fp'
          will result in an invalid JSON file.

 -- Function: json.dumps (obj, *, skipkeys=False, ensure_ascii=True,
          check_circular=True, allow_nan=True, cls=None, indent=None,
          separators=None, default=None, sort_keys=False, **kw)

     Serialize `obj' to a JSON formatted *note str: 325. using this
     *note conversion table: 281f.  The arguments have the same meaning
     as in *note dump(): 5f9.

          Note: Keys in key/value pairs of JSON are always of the type
          *note str: 325.  When a dictionary is converted into JSON, all
          the keys of the dictionary are coerced to strings.  As a
          result of this, if a dictionary is converted into JSON and
          then back into a dictionary, the dictionary may not equal the
          original one.  That is, ‘loads(dumps(x)) != x’ if x has
          non-string keys.

 -- Function: json.load (fp, *, cls=None, object_hook=None,
          parse_float=None, parse_int=None, parse_constant=None,
          object_pairs_hook=None, **kw)

     Deserialize `fp' (a ‘.read()’-supporting *note text file: 11de. or
     *note binary file: 1bdb. containing a JSON document) to a Python
     object using this *note conversion table: 2820.

     `object_hook' is an optional function that will be called with the
     result of any object literal decoded (a *note dict: 1b6.).  The
     return value of `object_hook' will be used instead of the *note
     dict: 1b6.  This feature can be used to implement custom decoders
     (e.g.  JSON-RPC(1) class hinting).

     `object_pairs_hook' is an optional function that will be called
     with the result of any object literal decoded with an ordered list
     of pairs.  The return value of `object_pairs_hook' will be used
     instead of the *note dict: 1b6.  This feature can be used to
     implement custom decoders.  If `object_hook' is also defined, the
     `object_pairs_hook' takes priority.

     Changed in version 3.1: Added support for `object_pairs_hook'.

     `parse_float', if specified, will be called with the string of
     every JSON float to be decoded.  By default, this is equivalent to
     ‘float(num_str)’.  This can be used to use another datatype or
     parser for JSON floats (e.g.  *note decimal.Decimal: 188.).

     `parse_int', if specified, will be called with the string of every
     JSON int to be decoded.  By default, this is equivalent to
     ‘int(num_str)’.  This can be used to use another datatype or parser
     for JSON integers (e.g.  *note float: 187.).

     `parse_constant', if specified, will be called with one of the
     following strings: ‘'-Infinity'’, ‘'Infinity'’, ‘'NaN'’.  This can
     be used to raise an exception if invalid JSON numbers are
     encountered.

     Changed in version 3.1: `parse_constant' doesn’t get called on
     ‘null’, ‘true’, ‘false’ anymore.

     To use a custom *note JSONDecoder: 5fc. subclass, specify it with
     the ‘cls’ kwarg; otherwise *note JSONDecoder: 5fc. is used.
     Additional keyword arguments will be passed to the constructor of
     the class.

     If the data being deserialized is not a valid JSON document, a
     *note JSONDecodeError: 6fa. will be raised.

     Changed in version 3.6: All optional parameters are now *note
     keyword-only: 2aa.

     Changed in version 3.6: `fp' can now be a *note binary file: 1bdb.
     The input encoding should be UTF-8, UTF-16 or UTF-32.

 -- Function: json.loads (s, *, cls=None, object_hook=None,
          parse_float=None, parse_int=None, parse_constant=None,
          object_pairs_hook=None, **kw)

     Deserialize `s' (a *note str: 325, *note bytes: 326. or *note
     bytearray: 327. instance containing a JSON document) to a Python
     object using this *note conversion table: 2820.

     The other arguments have the same meaning as in *note load(): 554,
     except `encoding' which is ignored and deprecated since Python 3.1.

     If the data being deserialized is not a valid JSON document, a
     *note JSONDecodeError: 6fa. will be raised.

     Deprecated since version 3.1, will be removed in version 3.9:
     `encoding' keyword argument.

     Changed in version 3.6: `s' can now be of type *note bytes: 326. or
     *note bytearray: 327.  The input encoding should be UTF-8, UTF-16
     or UTF-32.

   ---------- Footnotes ----------

   (1) http://www.jsonrpc.org


File: python.info,  Node: Encoders and Decoders,  Next: Exceptions<13>,  Prev: Basic Usage,  Up: json — JSON encoder and decoder

5.20.2.2 Encoders and Decoders
..............................

 -- Class: json.JSONDecoder (*, object_hook=None, parse_float=None,
          parse_int=None, parse_constant=None, strict=True,
          object_pairs_hook=None)

     Simple JSON decoder.

     Performs the following translations in decoding by default:

     JSON                Python
                         
     --------------------------------------------
                         
     object              dict
                         
                         
     array               list
                         
                         
     string              str
                         
                         
     number (int)        int
                         
                         
     number (real)       float
                         
                         
     true                True
                         
                         
     false               False
                         
                         
     null                None
                         

     It also understands ‘NaN’, ‘Infinity’, and ‘-Infinity’ as their
     corresponding ‘float’ values, which is outside the JSON spec.

     `object_hook', if specified, will be called with the result of
     every JSON object decoded and its return value will be used in
     place of the given *note dict: 1b6.  This can be used to provide
     custom deserializations (e.g.  to support JSON-RPC class hinting).

     `object_pairs_hook', if specified will be called with the result of
     every JSON object decoded with an ordered list of pairs.  The
     return value of `object_pairs_hook' will be used instead of the
     *note dict: 1b6.  This feature can be used to implement custom
     decoders.  If `object_hook' is also defined, the
     `object_pairs_hook' takes priority.

     Changed in version 3.1: Added support for `object_pairs_hook'.

     `parse_float', if specified, will be called with the string of
     every JSON float to be decoded.  By default, this is equivalent to
     ‘float(num_str)’.  This can be used to use another datatype or
     parser for JSON floats (e.g.  *note decimal.Decimal: 188.).

     `parse_int', if specified, will be called with the string of every
     JSON int to be decoded.  By default, this is equivalent to
     ‘int(num_str)’.  This can be used to use another datatype or parser
     for JSON integers (e.g.  *note float: 187.).

     `parse_constant', if specified, will be called with one of the
     following strings: ‘'-Infinity'’, ‘'Infinity'’, ‘'NaN'’.  This can
     be used to raise an exception if invalid JSON numbers are
     encountered.

     If `strict' is false (‘True’ is the default), then control
     characters will be allowed inside strings.  Control characters in
     this context are those with character codes in the 0–31 range,
     including ‘'\t'’ (tab), ‘'\n'’, ‘'\r'’ and ‘'\0'’.

     If the data being deserialized is not a valid JSON document, a
     *note JSONDecodeError: 6fa. will be raised.

     Changed in version 3.6: All parameters are now *note keyword-only:
     2aa.

      -- Method: decode (s)

          Return the Python representation of `s' (a *note str: 325.
          instance containing a JSON document).

          *note JSONDecodeError: 6fa. will be raised if the given JSON
          document is not valid.

      -- Method: raw_decode (s)

          Decode a JSON document from `s' (a *note str: 325. beginning
          with a JSON document) and return a 2-tuple of the Python
          representation and the index in `s' where the document ended.

          This can be used to decode a JSON document from a string that
          may have extraneous data at the end.

 -- Class: json.JSONEncoder (*, skipkeys=False, ensure_ascii=True,
          check_circular=True, allow_nan=True, sort_keys=False,
          indent=None, separators=None, default=None)

     Extensible JSON encoder for Python data structures.

     Supports the following objects and types by default:

     Python                                       JSON
                                                  
     -----------------------------------------------------------------
                                                  
     dict                                         object
                                                  
                                                  
     list, tuple                                  array
                                                  
                                                  
     str                                          string
                                                  
                                                  
     int, float, int- & float-derived Enums       number
                                                  
                                                  
     True                                         true
                                                  
                                                  
     False                                        false
                                                  
                                                  
     None                                         null
                                                  

     Changed in version 3.4: Added support for int- and float-derived
     Enum classes.

     To extend this to recognize other objects, subclass and implement a
     *note default(): 2824. method with another method that returns a
     serializable object for ‘o’ if possible, otherwise it should call
     the superclass implementation (to raise *note TypeError: 192.).

     If `skipkeys' is false (the default), then it is a *note TypeError:
     192. to attempt encoding of keys that are not *note str: 325, *note
     int: 184, *note float: 187. or ‘None’.  If `skipkeys' is true, such
     items are simply skipped.

     If `ensure_ascii' is true (the default), the output is guaranteed
     to have all incoming non-ASCII characters escaped.  If
     `ensure_ascii' is false, these characters will be output as-is.

     If `check_circular' is true (the default), then lists, dicts, and
     custom encoded objects will be checked for circular references
     during encoding to prevent an infinite recursion (which would cause
     an *note OverflowError: 954.).  Otherwise, no such check takes
     place.

     If `allow_nan' is true (the default), then ‘NaN’, ‘Infinity’, and
     ‘-Infinity’ will be encoded as such.  This behavior is not JSON
     specification compliant, but is consistent with most JavaScript
     based encoders and decoders.  Otherwise, it will be a *note
     ValueError: 1f9. to encode such floats.

     If `sort_keys' is true (default: ‘False’), then the output of
     dictionaries will be sorted by key; this is useful for regression
     tests to ensure that JSON serializations can be compared on a
     day-to-day basis.

     If `indent' is a non-negative integer or string, then JSON array
     elements and object members will be pretty-printed with that indent
     level.  An indent level of 0, negative, or ‘""’ will only insert
     newlines.  ‘None’ (the default) selects the most compact
     representation.  Using a positive integer indent indents that many
     spaces per level.  If `indent' is a string (such as ‘"\t"’), that
     string is used to indent each level.

     Changed in version 3.2: Allow strings for `indent' in addition to
     integers.

     If specified, `separators' should be an ‘(item_separator,
     key_separator)’ tuple.  The default is ‘(', ', ': ')’ if `indent'
     is ‘None’ and ‘(',', ': ')’ otherwise.  To get the most compact
     JSON representation, you should specify ‘(',', ':')’ to eliminate
     whitespace.

     Changed in version 3.4: Use ‘(',', ': ')’ as default if `indent' is
     not ‘None’.

     If specified, `default' should be a function that gets called for
     objects that can’t otherwise be serialized.  It should return a
     JSON encodable version of the object or raise a *note TypeError:
     192.  If not specified, *note TypeError: 192. is raised.

     Changed in version 3.6: All parameters are now *note keyword-only:
     2aa.

      -- Method: default (o)

          Implement this method in a subclass such that it returns a
          serializable object for `o', or calls the base implementation
          (to raise a *note TypeError: 192.).

          For example, to support arbitrary iterators, you could
          implement default like this:

               def default(self, o):    try:        iterable = iter(o)    except TypeError:        pass    else:        return list(iterable)    # Let the base class default method raise the TypeError    return json.JSONEncoder.default(self, o)

      -- Method: encode (o)

          Return a JSON string representation of a Python data
          structure, `o'.  For example:

               >>> json.JSONEncoder().encode({"foo": ["bar", "baz"]}) '{"foo": ["bar", "baz"]}'

      -- Method: iterencode (o)

          Encode the given object, `o', and yield each string
          representation as available.  For example:

               for chunk in json.JSONEncoder().iterencode(bigobject):     mysocket.write(chunk)


File: python.info,  Node: Exceptions<13>,  Next: Standard Compliance and Interoperability,  Prev: Encoders and Decoders,  Up: json — JSON encoder and decoder

5.20.2.3 Exceptions
...................

 -- Exception: json.JSONDecodeError (msg, doc, pos)

     Subclass of *note ValueError: 1f9. with the following additional
     attributes:

      -- Attribute: msg

          The unformatted error message.

      -- Attribute: doc

          The JSON document being parsed.

      -- Attribute: pos

          The start index of `doc' where parsing failed.

      -- Attribute: lineno

          The line corresponding to `pos'.

      -- Attribute: colno

          The column corresponding to `pos'.

     New in version 3.5.


File: python.info,  Node: Standard Compliance and Interoperability,  Next: Command Line Interface<2>,  Prev: Exceptions<13>,  Up: json — JSON encoder and decoder

5.20.2.4 Standard Compliance and Interoperability
.................................................

The JSON format is specified by RFC 7159(1) and by ECMA-404(2).  This
section details this module’s level of compliance with the RFC. For
simplicity, *note JSONEncoder: 5fb. and *note JSONDecoder: 5fc.
subclasses, and parameters other than those explicitly mentioned, are
not considered.

This module does not comply with the RFC in a strict fashion,
implementing some extensions that are valid JavaScript but not valid
JSON. In particular:

   - Infinite and NaN number values are accepted and output;

   - Repeated names within an object are accepted, and only the value of
     the last name-value pair is used.

Since the RFC permits RFC-compliant parsers to accept input texts that
are not RFC-compliant, this module’s deserializer is technically
RFC-compliant under default settings.

* Menu:

* Character Encodings::
* Infinite and NaN Number Values::
* Repeated Names Within an Object::
* Top-level Non-Object, Non-Array Values: Top-level Non-Object Non-Array Values.
* Implementation Limitations::

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc7159.html

   (2) 
http://www.ecma-international.org/publications/standards/Ecma-404.htm


File: python.info,  Node: Character Encodings,  Next: Infinite and NaN Number Values,  Up: Standard Compliance and Interoperability

5.20.2.5 Character Encodings
............................

The RFC requires that JSON be represented using either UTF-8, UTF-16, or
UTF-32, with UTF-8 being the recommended default for maximum
interoperability.

As permitted, though not required, by the RFC, this module’s serializer
sets `ensure_ascii=True' by default, thus escaping the output so that
the resulting strings only contain ASCII characters.

Other than the `ensure_ascii' parameter, this module is defined strictly
in terms of conversion between Python objects and *note Unicode strings:
325, and thus does not otherwise directly address the issue of character
encodings.

The RFC prohibits adding a byte order mark (BOM) to the start of a JSON
text, and this module’s serializer does not add a BOM to its output.
The RFC permits, but does not require, JSON deserializers to ignore an
initial BOM in their input.  This module’s deserializer raises a *note
ValueError: 1f9. when an initial BOM is present.

The RFC does not explicitly forbid JSON strings which contain byte
sequences that don’t correspond to valid Unicode characters (e.g.
unpaired UTF-16 surrogates), but it does note that they may cause
interoperability problems.  By default, this module accepts and outputs
(when present in the original *note str: 325.) code points for such
sequences.


File: python.info,  Node: Infinite and NaN Number Values,  Next: Repeated Names Within an Object,  Prev: Character Encodings,  Up: Standard Compliance and Interoperability

5.20.2.6 Infinite and NaN Number Values
.......................................

The RFC does not permit the representation of infinite or NaN number
values.  Despite that, by default, this module accepts and outputs
‘Infinity’, ‘-Infinity’, and ‘NaN’ as if they were valid JSON number
literal values:

     >>> # Neither of these calls raises an exception, but the results are not valid JSON >>> json.dumps(float('-inf')) '-Infinity' >>> json.dumps(float('nan')) 'NaN' >>> # Same when deserializing >>> json.loads('-Infinity') -inf >>> json.loads('NaN') nan

In the serializer, the `allow_nan' parameter can be used to alter this
behavior.  In the deserializer, the `parse_constant' parameter can be
used to alter this behavior.


File: python.info,  Node: Repeated Names Within an Object,  Next: Top-level Non-Object Non-Array Values,  Prev: Infinite and NaN Number Values,  Up: Standard Compliance and Interoperability

5.20.2.7 Repeated Names Within an Object
........................................

The RFC specifies that the names within a JSON object should be unique,
but does not mandate how repeated names in JSON objects should be
handled.  By default, this module does not raise an exception; instead,
it ignores all but the last name-value pair for a given name:

     >>> weird_json = '{"x": 1, "x": 2, "x": 3}' >>> json.loads(weird_json) {'x': 3}

The `object_pairs_hook' parameter can be used to alter this behavior.


File: python.info,  Node: Top-level Non-Object Non-Array Values,  Next: Implementation Limitations,  Prev: Repeated Names Within an Object,  Up: Standard Compliance and Interoperability

5.20.2.8 Top-level Non-Object, Non-Array Values
...............................................

The old version of JSON specified by the obsolete RFC 4627(1) required
that the top-level value of a JSON text must be either a JSON object or
array (Python *note dict: 1b6. or *note list: 260.), and could not be a
JSON null, boolean, number, or string value.  RFC 7159(2) removed that
restriction, and this module does not and has never implemented that
restriction in either its serializer or its deserializer.

Regardless, for maximum interoperability, you may wish to voluntarily
adhere to the restriction yourself.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc4627.html

   (2) https://tools.ietf.org/html/rfc7159.html


File: python.info,  Node: Implementation Limitations,  Prev: Top-level Non-Object Non-Array Values,  Up: Standard Compliance and Interoperability

5.20.2.9 Implementation Limitations
...................................

Some JSON deserializer implementations may set limits on:

   * the size of accepted JSON texts

   * the maximum level of nesting of JSON objects and arrays

   * the range and precision of JSON numbers

   * the content and maximum length of JSON strings

This module does not impose any such limits beyond those of the relevant
Python datatypes themselves or the Python interpreter itself.

When serializing to JSON, beware any such limitations in applications
that may consume your JSON. In particular, it is common for JSON numbers
to be deserialized into IEEE 754 double precision numbers and thus
subject to that representation’s range and precision limitations.  This
is especially relevant when serializing Python *note int: 184. values of
extremely large magnitude, or when serializing instances of “exotic”
numerical types such as *note decimal.Decimal: 188.


File: python.info,  Node: Command Line Interface<2>,  Prev: Standard Compliance and Interoperability,  Up: json — JSON encoder and decoder

5.20.2.10 Command Line Interface
................................

`Source code:' Lib/json/tool.py(1)

__________________________________________________________________

The *note json.tool: a5. module provides a simple command line interface
to validate and pretty-print JSON objects.

If the optional ‘infile’ and ‘outfile’ arguments are not specified,
*note sys.stdin: 302. and *note sys.stdout: 303. will be used
respectively:

     $ echo '{"json": "obj"}' | python -m json.tool {     "json": "obj" } $ echo '{1.2:3.4}' | python -m json.tool Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

Changed in version 3.5: The output is now in the same order as the
input.  Use the *note –sort-keys: 2834. option to sort the output of
dictionaries alphabetically by key.

* Menu:

* Command line options: Command line options<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/json/tool.py


File: python.info,  Node: Command line options<2>,  Up: Command Line Interface<2>

5.20.2.11 Command line options
..............................

 -- Program Option: infile

     The JSON file to be validated or pretty-printed:

          $ python -m json.tool mp_films.json [     {         "title": "And Now for Something Completely Different",         "year": 1971     },     {         "title": "Monty Python and the Holy Grail",         "year": 1975     } ]

     If `infile' is not specified, read from *note sys.stdin: 302.

 -- Program Option: outfile

     Write the output of the `infile' to the given `outfile'.
     Otherwise, write it to *note sys.stdout: 303.

 -- Program Option: --sort-keys

     Sort the output of dictionaries alphabetically by key.

     New in version 3.5.

 -- Program Option: --json-lines

     Parse every input line as separate JSON object.

     New in version 3.8.

 -- Program Option: -h, --help

     Show the help message.


File: python.info,  Node: mailcap — Mailcap file handling,  Next: mailbox — Manipulate mailboxes in various formats,  Prev: json — JSON encoder and decoder,  Up: Internet Data Handling

5.20.3 ‘mailcap’ — Mailcap file handling
----------------------------------------

`Source code:' Lib/mailcap.py(1)

__________________________________________________________________

Mailcap files are used to configure how MIME-aware applications such as
mail readers and Web browsers react to files with different MIME types.
(The name “mailcap” is derived from the phrase “mail capability”.)  For
example, a mailcap file might contain a line like ‘video/mpeg; xmpeg
%s’.  Then, if the user encounters an email message or Web document with
the MIME type ‘video/mpeg’, ‘%s’ will be replaced by a filename (usually
one belonging to a temporary file) and the ‘xmpeg’ program can be
automatically started to view the file.

The mailcap format is documented in RFC 1524(2), “A User Agent
Configuration Mechanism For Multimedia Mail Format Information,” but is
not an Internet standard.  However, mailcap files are supported on most
Unix systems.

 -- Function: mailcap.findmatch (caps, MIMEtype, key='view',
          filename='/dev/null', plist=[])

     Return a 2-tuple; the first element is a string containing the
     command line to be executed (which can be passed to *note
     os.system(): db4.), and the second element is the mailcap entry for
     a given MIME type.  If no matching MIME type can be found, ‘(None,
     None)’ is returned.

     `key' is the name of the field desired, which represents the type
     of activity to be performed; the default value is ‘view’, since in
     the most common case you simply want to view the body of the
     MIME-typed data.  Other possible values might be ‘compose’ and
     ‘edit’, if you wanted to create a new body of the given MIME type
     or alter the existing body data.  See RFC 1524(3) for a complete
     list of these fields.

     `filename' is the filename to be substituted for ‘%s’ in the
     command line; the default value is ‘'/dev/null'’ which is almost
     certainly not what you want, so usually you’ll override it by
     specifying a filename.

     `plist' can be a list containing named parameters; the default
     value is simply an empty list.  Each entry in the list must be a
     string containing the parameter name, an equals sign (‘'='’), and
     the parameter’s value.  Mailcap entries can contain named
     parameters like ‘%{foo}’, which will be replaced by the value of
     the parameter named ‘foo’.  For example, if the command line
     ‘showpartial %{id} %{number} %{total}’ was in a mailcap file, and
     `plist' was set to ‘['id=1', 'number=2', 'total=3']’, the resulting
     command line would be ‘'showpartial 1 2 3'’.

     In a mailcap file, the “test” field can optionally be specified to
     test some external condition (such as the machine architecture, or
     the window system in use) to determine whether or not the mailcap
     line applies.  *note findmatch(): 283c. will automatically check
     such conditions and skip the entry if the check fails.

 -- Function: mailcap.getcaps ()

     Returns a dictionary mapping MIME types to a list of mailcap file
     entries.  This dictionary must be passed to the *note findmatch():
     283c. function.  An entry is stored as a list of dictionaries, but
     it shouldn’t be necessary to know the details of this
     representation.

     The information is derived from all of the mailcap files found on
     the system.  Settings in the user’s mailcap file ‘$HOME/.mailcap’
     will override settings in the system mailcap files ‘/etc/mailcap’,
     ‘/usr/etc/mailcap’, and ‘/usr/local/etc/mailcap’.

An example usage:

     >>> import mailcap >>> d = mailcap.getcaps() >>> mailcap.findmatch(d, 'video/mpeg', filename='tmp1223') ('xmpeg tmp1223', {'view': 'xmpeg %s'})

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/mailcap.py

   (2) https://tools.ietf.org/html/rfc1524.html

   (3) https://tools.ietf.org/html/rfc1524.html


File: python.info,  Node: mailbox — Manipulate mailboxes in various formats,  Next: mimetypes — Map filenames to MIME types,  Prev: mailcap — Mailcap file handling,  Up: Internet Data Handling

5.20.4 ‘mailbox’ — Manipulate mailboxes in various formats
----------------------------------------------------------

`Source code:' Lib/mailbox.py(1)

__________________________________________________________________

This module defines two classes, *note Mailbox: bd6. and *note Message:
bda, for accessing and manipulating on-disk mailboxes and the messages
they contain.  *note Mailbox: bd6. offers a dictionary-like mapping from
keys to messages.  *note Message: bda. extends the *note email.message:
72. module’s *note Message: 536. class with format-specific state and
behavior.  Supported mailbox formats are Maildir, mbox, MH, Babyl, and
MMDF.

See also
........

Module *note email: 69.

     Represent and manipulate messages.

* Menu:

* Mailbox objects::
* Message objects::
* Exceptions: Exceptions<14>.
* Examples: Examples<18>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/mailbox.py


File: python.info,  Node: Mailbox objects,  Next: Message objects,  Up: mailbox — Manipulate mailboxes in various formats

5.20.4.1 ‘Mailbox’ objects
..........................

 -- Class: mailbox.Mailbox

     A mailbox, which may be inspected and modified.

     The *note Mailbox: bd6. class defines an interface and is not
     intended to be instantiated.  Instead, format-specific subclasses
     should inherit from *note Mailbox: bd6. and your code should
     instantiate a particular subclass.

     The *note Mailbox: bd6. interface is dictionary-like, with small
     keys corresponding to messages.  Keys are issued by the *note
     Mailbox: bd6. instance with which they will be used and are only
     meaningful to that *note Mailbox: bd6. instance.  A key continues
     to identify a message even if the corresponding message is
     modified, such as by replacing it with another message.

     Messages may be added to a *note Mailbox: bd6. instance using the
     set-like method *note add(): bd5. and removed using a ‘del’
     statement or the set-like methods *note remove(): 2842. and *note
     discard(): 2843.

     *note Mailbox: bd6. interface semantics differ from dictionary
     semantics in some noteworthy ways.  Each time a message is
     requested, a new representation (typically a *note Message: bda.
     instance) is generated based upon the current state of the mailbox.
     Similarly, when a message is added to a *note Mailbox: bd6.
     instance, the provided message representation’s contents are
     copied.  In neither case is a reference to the message
     representation kept by the *note Mailbox: bd6. instance.

     The default *note Mailbox: bd6. iterator iterates over message
     representations, not keys as the default dictionary iterator does.
     Moreover, modification of a mailbox during iteration is safe and
     well-defined.  Messages added to the mailbox after an iterator is
     created will not be seen by the iterator.  Messages removed from
     the mailbox before the iterator yields them will be silently
     skipped, though using a key from an iterator may result in a *note
     KeyError: 2c5. exception if the corresponding message is
     subsequently removed.

          Warning: Be very cautious when modifying mailboxes that might
          be simultaneously changed by some other process.  The safest
          mailbox format to use for such tasks is Maildir; try to avoid
          using single-file formats such as mbox for concurrent writing.
          If you’re modifying a mailbox, you `must' lock it by calling
          the *note lock(): 2844. and *note unlock(): 2845. methods
          `before' reading any messages in the file or making any
          changes by adding or deleting a message.  Failing to lock the
          mailbox runs the risk of losing messages or corrupting the
          entire mailbox.

     *note Mailbox: bd6. instances have the following methods:

      -- Method: add (message)

          Add `message' to the mailbox and return the key that has been
          assigned to it.

          Parameter `message' may be a *note Message: bda. instance, an
          *note email.message.Message: 536. instance, a string, a byte
          string, or a file-like object (which should be open in binary
          mode).  If `message' is an instance of the appropriate
          format-specific *note Message: bda. subclass (e.g., if it’s an
          *note mboxMessage: 2713. instance and this is an *note mbox:
          2846. instance), its format-specific information is used.
          Otherwise, reasonable defaults for format-specific information
          are used.

          Changed in version 3.2: Support for binary input was added.

      -- Method: remove (key)
      -- Method: __delitem__ (key)
      -- Method: discard (key)

          Delete the message corresponding to `key' from the mailbox.

          If no such message exists, a *note KeyError: 2c5. exception is
          raised if the method was called as *note remove(): 2842. or
          *note __delitem__(): 2847. but no exception is raised if the
          method was called as *note discard(): 2843.  The behavior of
          *note discard(): 2843. may be preferred if the underlying
          mailbox format supports concurrent modification by other
          processes.

      -- Method: __setitem__ (key, message)

          Replace the message corresponding to `key' with `message'.
          Raise a *note KeyError: 2c5. exception if no message already
          corresponds to `key'.

          As with *note add(): bd5, parameter `message' may be a *note
          Message: bda. instance, an *note email.message.Message: 536.
          instance, a string, a byte string, or a file-like object
          (which should be open in binary mode).  If `message' is an
          instance of the appropriate format-specific *note Message:
          bda. subclass (e.g., if it’s an *note mboxMessage: 2713.
          instance and this is an *note mbox: 2846. instance), its
          format-specific information is used.  Otherwise, the
          format-specific information of the message that currently
          corresponds to `key' is left unchanged.

      -- Method: iterkeys ()
      -- Method: keys ()

          Return an iterator over all keys if called as *note
          iterkeys(): 2849. or return a list of keys if called as *note
          keys(): 284a.

      -- Method: itervalues ()
      -- Method: __iter__ ()
      -- Method: values ()

          Return an iterator over representations of all messages if
          called as *note itervalues(): 284b. or *note __iter__(): 284c.
          or return a list of such representations if called as *note
          values(): 284d.  The messages are represented as instances of
          the appropriate format-specific *note Message: bda. subclass
          unless a custom message factory was specified when the *note
          Mailbox: bd6. instance was initialized.

               Note: The behavior of *note __iter__(): 284c. is unlike
               that of dictionaries, which iterate over keys.

      -- Method: iteritems ()
      -- Method: items ()

          Return an iterator over (`key', `message') pairs, where `key'
          is a key and `message' is a message representation, if called
          as *note iteritems(): 284e. or return a list of such pairs if
          called as *note items(): 284f.  The messages are represented
          as instances of the appropriate format-specific *note Message:
          bda. subclass unless a custom message factory was specified
          when the *note Mailbox: bd6. instance was initialized.

      -- Method: get (key, default=None)
      -- Method: __getitem__ (key)

          Return a representation of the message corresponding to `key'.
          If no such message exists, `default' is returned if the method
          was called as *note get(): 2850. and a *note KeyError: 2c5.
          exception is raised if the method was called as *note
          __getitem__(): 2851.  The message is represented as an
          instance of the appropriate format-specific *note Message:
          bda. subclass unless a custom message factory was specified
          when the *note Mailbox: bd6. instance was initialized.

      -- Method: get_message (key)

          Return a representation of the message corresponding to `key'
          as an instance of the appropriate format-specific *note
          Message: bda. subclass, or raise a *note KeyError: 2c5.
          exception if no such message exists.

      -- Method: get_bytes (key)

          Return a byte representation of the message corresponding to
          `key', or raise a *note KeyError: 2c5. exception if no such
          message exists.

          New in version 3.2.

      -- Method: get_string (key)

          Return a string representation of the message corresponding to
          `key', or raise a *note KeyError: 2c5. exception if no such
          message exists.  The message is processed through *note
          email.message.Message: 536. to convert it to a 7bit clean
          representation.

      -- Method: get_file (key)

          Return a file-like representation of the message corresponding
          to `key', or raise a *note KeyError: 2c5. exception if no such
          message exists.  The file-like object behaves as if open in
          binary mode.  This file should be closed once it is no longer
          needed.

          Changed in version 3.2: The file object really is a binary
          file; previously it was incorrectly returned in text mode.
          Also, the file-like object now supports the context management
          protocol: you can use a *note with: 6dd. statement to
          automatically close it.

               Note: Unlike other representations of messages, file-like
               representations are not necessarily independent of the
               *note Mailbox: bd6. instance that created them or of the
               underlying mailbox.  More specific documentation is
               provided by each subclass.

      -- Method: __contains__ (key)

          Return ‘True’ if `key' corresponds to a message, ‘False’
          otherwise.

      -- Method: __len__ ()

          Return a count of messages in the mailbox.

      -- Method: clear ()

          Delete all messages from the mailbox.

      -- Method: pop (key, default=None)

          Return a representation of the message corresponding to `key'
          and delete the message.  If no such message exists, return
          `default'.  The message is represented as an instance of the
          appropriate format-specific *note Message: bda. subclass
          unless a custom message factory was specified when the *note
          Mailbox: bd6. instance was initialized.

      -- Method: popitem ()

          Return an arbitrary (`key', `message') pair, where `key' is a
          key and `message' is a message representation, and delete the
          corresponding message.  If the mailbox is empty, raise a *note
          KeyError: 2c5. exception.  The message is represented as an
          instance of the appropriate format-specific *note Message:
          bda. subclass unless a custom message factory was specified
          when the *note Mailbox: bd6. instance was initialized.

      -- Method: update (arg)

          Parameter `arg' should be a `key'-to-`message' mapping or an
          iterable of (`key', `message') pairs.  Updates the mailbox so
          that, for each given `key' and `message', the message
          corresponding to `key' is set to `message' as if by using
          *note __setitem__(): 2848.  As with *note __setitem__(): 2848,
          each `key' must already correspond to a message in the mailbox
          or else a *note KeyError: 2c5. exception will be raised, so in
          general it is incorrect for `arg' to be a *note Mailbox: bd6.
          instance.

               Note: Unlike with dictionaries, keyword arguments are not
               supported.

      -- Method: flush ()

          Write any pending changes to the filesystem.  For some *note
          Mailbox: bd6. subclasses, changes are always written
          immediately and *note flush(): 2859. does nothing, but you
          should still make a habit of calling this method.

      -- Method: lock ()

          Acquire an exclusive advisory lock on the mailbox so that
          other processes know not to modify it.  An *note
          ExternalClashError: 285a. is raised if the lock is not
          available.  The particular locking mechanisms used depend upon
          the mailbox format.  You should `always' lock the mailbox
          before making any modifications to its contents.

      -- Method: unlock ()

          Release the lock on the mailbox, if any.

      -- Method: close ()

          Flush the mailbox, unlock it if necessary, and close any open
          files.  For some *note Mailbox: bd6. subclasses, this method
          does nothing.

* Menu:

* Maildir::
* mbox::
* MH::
* Babyl::
* MMDF::


File: python.info,  Node: Maildir,  Next: mbox,  Up: Mailbox objects

5.20.4.2 ‘Maildir’
..................

 -- Class: mailbox.Maildir (dirname, factory=None, create=True)

     A subclass of *note Mailbox: bd6. for mailboxes in Maildir format.
     Parameter `factory' is a callable object that accepts a file-like
     message representation (which behaves as if opened in binary mode)
     and returns a custom representation.  If `factory' is ‘None’, *note
     MaildirMessage: 285e. is used as the default message
     representation.  If `create' is ‘True’, the mailbox is created if
     it does not exist.

     If `create' is ‘True’ and the `dirname' path exists, it will be
     treated as an existing maildir without attempting to verify its
     directory layout.

     It is for historical reasons that `dirname' is named as such rather
     than `path'.

     Maildir is a directory-based mailbox format invented for the qmail
     mail transfer agent and now widely supported by other programs.
     Messages in a Maildir mailbox are stored in separate files within a
     common directory structure.  This design allows Maildir mailboxes
     to be accessed and modified by multiple unrelated programs without
     data corruption, so file locking is unnecessary.

     Maildir mailboxes contain three subdirectories, namely: ‘tmp’,
     ‘new’, and ‘cur’.  Messages are created momentarily in the ‘tmp’
     subdirectory and then moved to the ‘new’ subdirectory to finalize
     delivery.  A mail user agent may subsequently move the message to
     the ‘cur’ subdirectory and store information about the state of the
     message in a special “info” section appended to its file name.

     Folders of the style introduced by the Courier mail transfer agent
     are also supported.  Any subdirectory of the main mailbox is
     considered a folder if ‘'.'’ is the first character in its name.
     Folder names are represented by *note Maildir: c9b. without the
     leading ‘'.'’.  Each folder is itself a Maildir mailbox but should
     not contain other folders.  Instead, a logical nesting is indicated
     using ‘'.'’ to delimit levels, e.g., “Archived.2005.07”.

          Note: The Maildir specification requires the use of a colon
          (‘':'’) in certain message file names.  However, some
          operating systems do not permit this character in file names,
          If you wish to use a Maildir-like format on such an operating
          system, you should specify another character to use instead.
          The exclamation point (‘'!'’) is a popular choice.  For
          example:

               import mailbox mailbox.Maildir.colon = '!'

          The ‘colon’ attribute may also be set on a per-instance basis.

     *note Maildir: c9b. instances have all of the methods of *note
     Mailbox: bd6. in addition to the following:

      -- Method: list_folders ()

          Return a list of the names of all folders.

      -- Method: get_folder (folder)

          Return a *note Maildir: c9b. instance representing the folder
          whose name is `folder'.  A *note NoSuchMailboxError: 2861.
          exception is raised if the folder does not exist.

      -- Method: add_folder (folder)

          Create a folder whose name is `folder' and return a *note
          Maildir: c9b. instance representing it.

      -- Method: remove_folder (folder)

          Delete the folder whose name is `folder'.  If the folder
          contains any messages, a *note NotEmptyError: 2864. exception
          will be raised and the folder will not be deleted.

      -- Method: clean ()

          Delete temporary files from the mailbox that have not been
          accessed in the last 36 hours.  The Maildir specification says
          that mail-reading programs should do this occasionally.

     Some *note Mailbox: bd6. methods implemented by *note Maildir: c9b.
     deserve special remarks:

      -- Method: add (message)
      -- Method: __setitem__ (key, message)
      -- Method: update (arg)

               Warning: These methods generate unique file names based
               upon the current process ID. When using multiple threads,
               undetected name clashes may occur and cause corruption of
               the mailbox unless threads are coordinated to avoid using
               these methods to manipulate the same mailbox
               simultaneously.

      -- Method: flush ()

          All changes to Maildir mailboxes are immediately applied, so
          this method does nothing.

      -- Method: lock ()
      -- Method: unlock ()

          Maildir mailboxes do not support (or require) locking, so
          these methods do nothing.

      -- Method: close ()

          *note Maildir: c9b. instances do not keep any open files and
          the underlying mailboxes do not support locking, so this
          method does nothing.

      -- Method: get_file (key)

          Depending upon the host platform, it may not be possible to
          modify or remove the underlying message while the returned
          file remains open.

See also
........

maildir man page from qmail(1)

     The original specification of the format.

Using maildir format(2)

     Notes on Maildir by its inventor.  Includes an updated
     name-creation scheme and details on “info” semantics.

maildir man page from Courier(3)

     Another specification of the format.  Describes a common extension
     for supporting folders.

   ---------- Footnotes ----------

   (1) http://www.qmail.org/man/man5/maildir.html

   (2) https://cr.yp.to/proto/maildir.html

   (3) http://www.courier-mta.org/maildir.html


File: python.info,  Node: mbox,  Next: MH,  Prev: Maildir,  Up: Mailbox objects

5.20.4.3 ‘mbox’
...............

 -- Class: mailbox.mbox (path, factory=None, create=True)

     A subclass of *note Mailbox: bd6. for mailboxes in mbox format.
     Parameter `factory' is a callable object that accepts a file-like
     message representation (which behaves as if opened in binary mode)
     and returns a custom representation.  If `factory' is ‘None’, *note
     mboxMessage: 2713. is used as the default message representation.
     If `create' is ‘True’, the mailbox is created if it does not exist.

     The mbox format is the classic format for storing mail on Unix
     systems.  All messages in an mbox mailbox are stored in a single
     file with the beginning of each message indicated by a line whose
     first five characters are “From “.

     Several variations of the mbox format exist to address perceived
     shortcomings in the original.  In the interest of compatibility,
     *note mbox: 2846. implements the original format, which is
     sometimes referred to as `mboxo'.  This means that the
     ‘Content-Length’ header, if present, is ignored and that any
     occurrences of “From ” at the beginning of a line in a message body
     are transformed to “>From ” when storing the message, although
     occurrences of “>From ” are not transformed to “From ” when reading
     the message.

     Some *note Mailbox: bd6. methods implemented by *note mbox: 2846.
     deserve special remarks:

      -- Method: get_file (key)

          Using the file after calling ‘flush()’ or ‘close()’ on the
          *note mbox: 2846. instance may yield unpredictable results or
          raise an exception.

      -- Method: lock ()
      -- Method: unlock ()

          Three locking mechanisms are used—dot locking and, if
          available, the ‘flock()’ and ‘lockf()’ system calls.

See also
........

mbox man page from qmail(1)

     A specification of the format and its variations.

mbox man page from tin(2)

     Another specification of the format, with details on locking.

Configuring Netscape Mail on Unix: Why The Content-Length Format is Bad(3)

     An argument for using the original mbox format rather than a
     variation.

"mbox" is a family of several mutually incompatible mailbox formats(4)

     A history of mbox variations.

   ---------- Footnotes ----------

   (1) http://www.qmail.org/man/man5/mbox.html

   (2) http://www.tin.org/bin/man.cgi?section=5&topic=mbox

   (3) https://www.jwz.org/doc/content-length.html

   (4) 
https://www.loc.gov/preservation/digital/formats/fdd/fdd000383.shtml


File: python.info,  Node: MH,  Next: Babyl,  Prev: mbox,  Up: Mailbox objects

5.20.4.4 ‘MH’
.............

 -- Class: mailbox.MH (path, factory=None, create=True)

     A subclass of *note Mailbox: bd6. for mailboxes in MH format.
     Parameter `factory' is a callable object that accepts a file-like
     message representation (which behaves as if opened in binary mode)
     and returns a custom representation.  If `factory' is ‘None’, *note
     MHMessage: 2876. is used as the default message representation.  If
     `create' is ‘True’, the mailbox is created if it does not exist.

     MH is a directory-based mailbox format invented for the MH Message
     Handling System, a mail user agent.  Each message in an MH mailbox
     resides in its own file.  An MH mailbox may contain other MH
     mailboxes (called `folders') in addition to messages.  Folders may
     be nested indefinitely.  MH mailboxes also support `sequences',
     which are named lists used to logically group messages without
     moving them to sub-folders.  Sequences are defined in a file called
     ‘.mh_sequences’ in each folder.

     The *note MH: 2875. class manipulates MH mailboxes, but it does not
     attempt to emulate all of ‘mh’’s behaviors.  In particular, it does
     not modify and is not affected by the ‘context’ or ‘.mh_profile’
     files that are used by ‘mh’ to store its state and configuration.

     *note MH: 2875. instances have all of the methods of *note Mailbox:
     bd6. in addition to the following:

      -- Method: list_folders ()

          Return a list of the names of all folders.

      -- Method: get_folder (folder)

          Return an *note MH: 2875. instance representing the folder
          whose name is `folder'.  A *note NoSuchMailboxError: 2861.
          exception is raised if the folder does not exist.

      -- Method: add_folder (folder)

          Create a folder whose name is `folder' and return an *note MH:
          2875. instance representing it.

      -- Method: remove_folder (folder)

          Delete the folder whose name is `folder'.  If the folder
          contains any messages, a *note NotEmptyError: 2864. exception
          will be raised and the folder will not be deleted.

      -- Method: get_sequences ()

          Return a dictionary of sequence names mapped to key lists.  If
          there are no sequences, the empty dictionary is returned.

      -- Method: set_sequences (sequences)

          Re-define the sequences that exist in the mailbox based upon
          `sequences', a dictionary of names mapped to key lists, like
          returned by *note get_sequences(): 287b.

      -- Method: pack ()

          Rename messages in the mailbox as necessary to eliminate gaps
          in numbering.  Entries in the sequences list are updated
          correspondingly.

               Note: Already-issued keys are invalidated by this
               operation and should not be subsequently used.

     Some *note Mailbox: bd6. methods implemented by *note MH: 2875.
     deserve special remarks:

      -- Method: remove (key)
      -- Method: __delitem__ (key)
      -- Method: discard (key)

          These methods immediately delete the message.  The MH
          convention of marking a message for deletion by prepending a
          comma to its name is not used.

      -- Method: lock ()
      -- Method: unlock ()

          Three locking mechanisms are used—dot locking and, if
          available, the ‘flock()’ and ‘lockf()’ system calls.  For MH
          mailboxes, locking the mailbox means locking the
          ‘.mh_sequences’ file and, only for the duration of any
          operations that affect them, locking individual message files.

      -- Method: get_file (key)

          Depending upon the host platform, it may not be possible to
          remove the underlying message while the returned file remains
          open.

      -- Method: flush ()

          All changes to MH mailboxes are immediately applied, so this
          method does nothing.

      -- Method: close ()

          *note MH: 2875. instances do not keep any open files, so this
          method is equivalent to *note unlock(): 2882.

See also
........

nmh - Message Handling System(1)

     Home page of ‘nmh’, an updated version of the original ‘mh’.

MH & nmh: Email for Users & Programmers(2)

     A GPL-licensed book on ‘mh’ and ‘nmh’, with some information on the
     mailbox format.

   ---------- Footnotes ----------

   (1) http://www.nongnu.org/nmh/

   (2) https://rand-mh.sourceforge.io/book/


File: python.info,  Node: Babyl,  Next: MMDF,  Prev: MH,  Up: Mailbox objects

5.20.4.5 ‘Babyl’
................

 -- Class: mailbox.Babyl (path, factory=None, create=True)

     A subclass of *note Mailbox: bd6. for mailboxes in Babyl format.
     Parameter `factory' is a callable object that accepts a file-like
     message representation (which behaves as if opened in binary mode)
     and returns a custom representation.  If `factory' is ‘None’, *note
     BabylMessage: 2889. is used as the default message representation.
     If `create' is ‘True’, the mailbox is created if it does not exist.

     Babyl is a single-file mailbox format used by the Rmail mail user
     agent included with Emacs.  The beginning of a message is indicated
     by a line containing the two characters Control-Underscore
     (‘'\037'’) and Control-L (‘'\014'’).  The end of a message is
     indicated by the start of the next message or, in the case of the
     last message, a line containing a Control-Underscore (‘'\037'’)
     character.

     Messages in a Babyl mailbox have two sets of headers, original
     headers and so-called visible headers.  Visible headers are
     typically a subset of the original headers that have been
     reformatted or abridged to be more attractive.  Each message in a
     Babyl mailbox also has an accompanying list of `labels', or short
     strings that record extra information about the message, and a list
     of all user-defined labels found in the mailbox is kept in the
     Babyl options section.

     *note Babyl: 2888. instances have all of the methods of *note
     Mailbox: bd6. in addition to the following:

      -- Method: get_labels ()

          Return a list of the names of all user-defined labels used in
          the mailbox.

               Note: The actual messages are inspected to determine
               which labels exist in the mailbox rather than consulting
               the list of labels in the Babyl options section, but the
               Babyl section is updated whenever the mailbox is
               modified.

     Some *note Mailbox: bd6. methods implemented by *note Babyl: 2888.
     deserve special remarks:

      -- Method: get_file (key)

          In Babyl mailboxes, the headers of a message are not stored
          contiguously with the body of the message.  To generate a
          file-like representation, the headers and body are copied
          together into an *note io.BytesIO: 78f. instance, which has an
          API identical to that of a file.  As a result, the file-like
          object is truly independent of the underlying mailbox but does
          not save memory compared to a string representation.

      -- Method: lock ()
      -- Method: unlock ()

          Three locking mechanisms are used—dot locking and, if
          available, the ‘flock()’ and ‘lockf()’ system calls.

See also
........

Format of Version 5 Babyl Files(1)

     A specification of the Babyl format.

Reading Mail with Rmail(2)

     The Rmail manual, with some information on Babyl semantics.

   ---------- Footnotes ----------

   (1) https://quimby.gnus.org/notes/BABYL

   (2) 
https://www.gnu.org/software/emacs/manual/html_node/emacs/Rmail.html


File: python.info,  Node: MMDF,  Prev: Babyl,  Up: Mailbox objects

5.20.4.6 ‘MMDF’
...............

 -- Class: mailbox.MMDF (path, factory=None, create=True)

     A subclass of *note Mailbox: bd6. for mailboxes in MMDF format.
     Parameter `factory' is a callable object that accepts a file-like
     message representation (which behaves as if opened in binary mode)
     and returns a custom representation.  If `factory' is ‘None’, *note
     MMDFMessage: 2891. is used as the default message representation.
     If `create' is ‘True’, the mailbox is created if it does not exist.

     MMDF is a single-file mailbox format invented for the Multichannel
     Memorandum Distribution Facility, a mail transfer agent.  Each
     message is in the same form as an mbox message but is bracketed
     before and after by lines containing four Control-A (‘'\001'’)
     characters.  As with the mbox format, the beginning of each message
     is indicated by a line whose first five characters are “From “, but
     additional occurrences of “From ” are not transformed to “>From ”
     when storing messages because the extra message separator lines
     prevent mistaking such occurrences for the starts of subsequent
     messages.

     Some *note Mailbox: bd6. methods implemented by *note MMDF: 2890.
     deserve special remarks:

      -- Method: get_file (key)

          Using the file after calling ‘flush()’ or ‘close()’ on the
          *note MMDF: 2890. instance may yield unpredictable results or
          raise an exception.

      -- Method: lock ()
      -- Method: unlock ()

          Three locking mechanisms are used—dot locking and, if
          available, the ‘flock()’ and ‘lockf()’ system calls.

See also
........

mmdf man page from tin(1)

     A specification of MMDF format from the documentation of tin, a
     newsreader.

MMDF(2)

     A Wikipedia article describing the Multichannel Memorandum
     Distribution Facility.

   ---------- Footnotes ----------

   (1) http://www.tin.org/bin/man.cgi?section=5&topic=mmdf

   (2) https://en.wikipedia.org/wiki/MMDF


File: python.info,  Node: Message objects,  Next: Exceptions<14>,  Prev: Mailbox objects,  Up: mailbox — Manipulate mailboxes in various formats

5.20.4.7 ‘Message’ objects
..........................

 -- Class: mailbox.Message (message=None)

     A subclass of the *note email.message: 72. module’s *note Message:
     536.  Subclasses of *note mailbox.Message: bda. add
     mailbox-format-specific state and behavior.

     If `message' is omitted, the new instance is created in a default,
     empty state.  If `message' is an *note email.message.Message: 536.
     instance, its contents are copied; furthermore, any format-specific
     information is converted insofar as possible if `message' is a
     *note Message: bda. instance.  If `message' is a string, a byte
     string, or a file, it should contain an RFC 2822(1)-compliant
     message, which is read and parsed.  Files should be open in binary
     mode, but text mode files are accepted for backward compatibility.

     The format-specific state and behaviors offered by subclasses vary,
     but in general it is only the properties that are not specific to a
     particular mailbox that are supported (although presumably the
     properties are specific to a particular mailbox format).  For
     example, file offsets for single-file mailbox formats and file
     names for directory-based mailbox formats are not retained, because
     they are only applicable to the original mailbox.  But state such
     as whether a message has been read by the user or marked as
     important is retained, because it applies to the message itself.

     There is no requirement that *note Message: bda. instances be used
     to represent messages retrieved using *note Mailbox: bd6.
     instances.  In some situations, the time and memory required to
     generate *note Message: bda. representations might not be
     acceptable.  For such situations, *note Mailbox: bd6. instances
     also offer string and file-like representations, and a custom
     message factory may be specified when a *note Mailbox: bd6.
     instance is initialized.

* Menu:

* MaildirMessage::
* mboxMessage::
* MHMessage::
* BabylMessage::
* MMDFMessage::

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2822.html


File: python.info,  Node: MaildirMessage,  Next: mboxMessage,  Up: Message objects

5.20.4.8 ‘MaildirMessage’
.........................

 -- Class: mailbox.MaildirMessage (message=None)

     A message with Maildir-specific behaviors.  Parameter `message' has
     the same meaning as with the *note Message: bda. constructor.

     Typically, a mail user agent application moves all of the messages
     in the ‘new’ subdirectory to the ‘cur’ subdirectory after the first
     time the user opens and closes the mailbox, recording that the
     messages are old whether or not they’ve actually been read.  Each
     message in ‘cur’ has an “info” section added to its file name to
     store information about its state.  (Some mail readers may also add
     an “info” section to messages in ‘new’.)  The “info” section may
     take one of two forms: it may contain “2,” followed by a list of
     standardized flags (e.g., “2,FR”) or it may contain “1,” followed
     by so-called experimental information.  Standard flags for Maildir
     messages are as follows:

     Flag       Meaning       Explanation
                              
     --------------------------------------------------------------
                              
     D          Draft         Under composition
                              
                              
     F          Flagged       Marked as important
                              
                              
     P          Passed        Forwarded, resent, or bounced
                              
                              
     R          Replied       Replied to
                              
                              
     S          Seen          Read
                              
                              
     T          Trashed       Marked for subsequent deletion
                              

     *note MaildirMessage: 285e. instances offer the following methods:

      -- Method: get_subdir ()

          Return either “new” (if the message should be stored in the
          ‘new’ subdirectory) or “cur” (if the message should be stored
          in the ‘cur’ subdirectory).

               Note: A message is typically moved from ‘new’ to ‘cur’
               after its mailbox has been accessed, whether or not the
               message is has been read.  A message ‘msg’ has been read
               if ‘"S" in msg.get_flags()’ is ‘True’.

      -- Method: set_subdir (subdir)

          Set the subdirectory the message should be stored in.
          Parameter `subdir' must be either “new” or “cur”.

      -- Method: get_flags ()

          Return a string specifying the flags that are currently set.
          If the message complies with the standard Maildir format, the
          result is the concatenation in alphabetical order of zero or
          one occurrence of each of ‘'D'’, ‘'F'’, ‘'P'’, ‘'R'’, ‘'S'’,
          and ‘'T'’.  The empty string is returned if no flags are set
          or if “info” contains experimental semantics.

      -- Method: set_flags (flags)

          Set the flags specified by `flags' and unset all others.

      -- Method: add_flag (flag)

          Set the flag(s) specified by `flag' without changing other
          flags.  To add more than one flag at a time, `flag' may be a
          string of more than one character.  The current “info” is
          overwritten whether or not it contains experimental
          information rather than flags.

      -- Method: remove_flag (flag)

          Unset the flag(s) specified by `flag' without changing other
          flags.  To remove more than one flag at a time, `flag' maybe a
          string of more than one character.  If “info” contains
          experimental information rather than flags, the current “info”
          is not modified.

      -- Method: get_date ()

          Return the delivery date of the message as a floating-point
          number representing seconds since the epoch.

      -- Method: set_date (date)

          Set the delivery date of the message to `date', a
          floating-point number representing seconds since the epoch.

      -- Method: get_info ()

          Return a string containing the “info” for a message.  This is
          useful for accessing and modifying “info” that is experimental
          (i.e., not a list of flags).

      -- Method: set_info (info)

          Set “info” to `info', which should be a string.

When a *note MaildirMessage: 285e. instance is created based upon an
*note mboxMessage: 2713. or *note MMDFMessage: 2891. instance, the
‘Status’ and ‘X-Status’ headers are omitted and the following
conversions take place:

Resulting state          *note mboxMessage: 2713. or
                         *note MMDFMessage: 2891. state
                         
----------------------------------------------------------------------------
                         
“cur” subdirectory       O flag
                         
                         
F flag                   F flag
                         
                         
R flag                   A flag
                         
                         
S flag                   R flag
                         
                         
T flag                   D flag
                         

When a *note MaildirMessage: 285e. instance is created based upon an
*note MHMessage: 2876. instance, the following conversions take place:

Resulting state                     *note MHMessage: 2876. state
                                    
-------------------------------------------------------------------
                                    
“cur” subdirectory                  “unseen” sequence
                                    
                                    
“cur” subdirectory and S flag       no “unseen” sequence
                                    
                                    
F flag                              “flagged” sequence
                                    
                                    
R flag                              “replied” sequence
                                    

When a *note MaildirMessage: 285e. instance is created based upon a
*note BabylMessage: 2889. instance, the following conversions take
place:

Resulting state                     *note BabylMessage: 2889. state
                                    
------------------------------------------------------------------------
                                    
“cur” subdirectory                  “unseen” label
                                    
                                    
“cur” subdirectory and S flag       no “unseen” label
                                    
                                    
P flag                              “forwarded” or “resent” label
                                    
                                    
R flag                              “answered” label
                                    
                                    
T flag                              “deleted” label
                                    


File: python.info,  Node: mboxMessage,  Next: MHMessage,  Prev: MaildirMessage,  Up: Message objects

5.20.4.9 ‘mboxMessage’
......................

 -- Class: mailbox.mboxMessage (message=None)

     A message with mbox-specific behaviors.  Parameter `message' has
     the same meaning as with the *note Message: bda. constructor.

     Messages in an mbox mailbox are stored together in a single file.
     The sender’s envelope address and the time of delivery are
     typically stored in a line beginning with “From ” that is used to
     indicate the start of a message, though there is considerable
     variation in the exact format of this data among mbox
     implementations.  Flags that indicate the state of the message,
     such as whether it has been read or marked as important, are
     typically stored in ‘Status’ and ‘X-Status’ headers.

     Conventional flags for mbox messages are as follows:

     Flag       Meaning        Explanation
                               
     ---------------------------------------------------------------
                               
     R          Read           Read
                               
                               
     O          Old            Previously detected by MUA
                               
                               
     D          Deleted        Marked for subsequent deletion
                               
                               
     F          Flagged        Marked as important
                               
                               
     A          Answered       Replied to
                               

     The “R” and “O” flags are stored in the ‘Status’ header, and the
     “D”, “F”, and “A” flags are stored in the ‘X-Status’ header.  The
     flags and headers typically appear in the order mentioned.

     *note mboxMessage: 2713. instances offer the following methods:

      -- Method: get_from ()

          Return a string representing the “From ” line that marks the
          start of the message in an mbox mailbox.  The leading “From ”
          and the trailing newline are excluded.

      -- Method: set_from (from_, time_=None)

          Set the “From ” line to `from_', which should be specified
          without a leading “From ” or trailing newline.  For
          convenience, `time_' may be specified and will be formatted
          appropriately and appended to `from_'.  If `time_' is
          specified, it should be a *note time.struct_time: 58e.
          instance, a tuple suitable for passing to *note
          time.strftime(): b58, or ‘True’ (to use *note time.gmtime():
          b32.).

      -- Method: get_flags ()

          Return a string specifying the flags that are currently set.
          If the message complies with the conventional format, the
          result is the concatenation in the following order of zero or
          one occurrence of each of ‘'R'’, ‘'O'’, ‘'D'’, ‘'F'’, and
          ‘'A'’.

      -- Method: set_flags (flags)

          Set the flags specified by `flags' and unset all others.
          Parameter `flags' should be the concatenation in any order of
          zero or more occurrences of each of ‘'R'’, ‘'O'’, ‘'D'’,
          ‘'F'’, and ‘'A'’.

      -- Method: add_flag (flag)

          Set the flag(s) specified by `flag' without changing other
          flags.  To add more than one flag at a time, `flag' may be a
          string of more than one character.

      -- Method: remove_flag (flag)

          Unset the flag(s) specified by `flag' without changing other
          flags.  To remove more than one flag at a time, `flag' maybe a
          string of more than one character.

When an *note mboxMessage: 2713. instance is created based upon a *note
MaildirMessage: 285e. instance, a “From ” line is generated based upon
the *note MaildirMessage: 285e. instance’s delivery date, and the
following conversions take place:

Resulting state       *note MaildirMessage: 285e. state
                      
----------------------------------------------------------
                      
R flag                S flag
                      
                      
O flag                “cur” subdirectory
                      
                      
D flag                T flag
                      
                      
F flag                F flag
                      
                      
A flag                R flag
                      

When an *note mboxMessage: 2713. instance is created based upon an *note
MHMessage: 2876. instance, the following conversions take place:

Resulting state         *note MHMessage: 2876. state
                        
-------------------------------------------------------
                        
R flag and O flag       no “unseen” sequence
                        
                        
O flag                  “unseen” sequence
                        
                        
F flag                  “flagged” sequence
                        
                        
A flag                  “replied” sequence
                        

When an *note mboxMessage: 2713. instance is created based upon a *note
BabylMessage: 2889. instance, the following conversions take place:

Resulting state         *note BabylMessage: 2889. state
                        
----------------------------------------------------------
                        
R flag and O flag       no “unseen” label
                        
                        
O flag                  “unseen” label
                        
                        
D flag                  “deleted” label
                        
                        
A flag                  “answered” label
                        

When a *note Message: bda. instance is created based upon an *note
MMDFMessage: 2891. instance, the “From ” line is copied and all flags
directly correspond:

Resulting state       *note MMDFMessage: 2891. state
                      
-------------------------------------------------------
                      
R flag                R flag
                      
                      
O flag                O flag
                      
                      
D flag                D flag
                      
                      
F flag                F flag
                      
                      
A flag                A flag
                      


File: python.info,  Node: MHMessage,  Next: BabylMessage,  Prev: mboxMessage,  Up: Message objects

5.20.4.10 ‘MHMessage’
.....................

 -- Class: mailbox.MHMessage (message=None)

     A message with MH-specific behaviors.  Parameter `message' has the
     same meaning as with the *note Message: bda. constructor.

     MH messages do not support marks or flags in the traditional sense,
     but they do support sequences, which are logical groupings of
     arbitrary messages.  Some mail reading programs (although not the
     standard ‘mh’ and ‘nmh’) use sequences in much the same way flags
     are used with other formats, as follows:

     Sequence       Explanation
                    
     --------------------------------------------------------------
                    
     unseen         Not read, but previously detected by MUA
                    
                    
     replied        Replied to
                    
                    
     flagged        Marked as important
                    

     *note MHMessage: 2876. instances offer the following methods:

      -- Method: get_sequences ()

          Return a list of the names of sequences that include this
          message.

      -- Method: set_sequences (sequences)

          Set the list of sequences that include this message.

      -- Method: add_sequence (sequence)

          Add `sequence' to the list of sequences that include this
          message.

      -- Method: remove_sequence (sequence)

          Remove `sequence' from the list of sequences that include this
          message.

When an *note MHMessage: 2876. instance is created based upon a *note
MaildirMessage: 285e. instance, the following conversions take place:

Resulting state          *note MaildirMessage: 285e. state
                         
-------------------------------------------------------------
                         
“unseen” sequence        no S flag
                         
                         
“replied” sequence       R flag
                         
                         
“flagged” sequence       F flag
                         

When an *note MHMessage: 2876. instance is created based upon an *note
mboxMessage: 2713. or *note MMDFMessage: 2891. instance, the ‘Status’
and ‘X-Status’ headers are omitted and the following conversions take
place:

Resulting state          *note mboxMessage: 2713. or
                         *note MMDFMessage: 2891. state
                         
----------------------------------------------------------------------------
                         
“unseen” sequence        no R flag
                         
                         
“replied” sequence       A flag
                         
                         
“flagged” sequence       F flag
                         

When an *note MHMessage: 2876. instance is created based upon a *note
BabylMessage: 2889. instance, the following conversions take place:

Resulting state          *note BabylMessage: 2889. state
                         
-----------------------------------------------------------
                         
“unseen” sequence        “unseen” label
                         
                         
“replied” sequence       “answered” label
                         


File: python.info,  Node: BabylMessage,  Next: MMDFMessage,  Prev: MHMessage,  Up: Message objects

5.20.4.11 ‘BabylMessage’
........................

 -- Class: mailbox.BabylMessage (message=None)

     A message with Babyl-specific behaviors.  Parameter `message' has
     the same meaning as with the *note Message: bda. constructor.

     Certain message labels, called `attributes', are defined by
     convention to have special meanings.  The attributes are as
     follows:

     Label           Explanation
                     
     ---------------------------------------------------------------
                     
     unseen          Not read, but previously detected by MUA
                     
                     
     deleted         Marked for subsequent deletion
                     
                     
     filed           Copied to another file or mailbox
                     
                     
     answered        Replied to
                     
                     
     forwarded       Forwarded
                     
                     
     edited          Modified by the user
                     
                     
     resent          Resent
                     

     By default, Rmail displays only visible headers.  The *note
     BabylMessage: 2889. class, though, uses the original headers
     because they are more complete.  Visible headers may be accessed
     explicitly if desired.

     *note BabylMessage: 2889. instances offer the following methods:

      -- Method: get_labels ()

          Return a list of labels on the message.

      -- Method: set_labels (labels)

          Set the list of labels on the message to `labels'.

      -- Method: add_label (label)

          Add `label' to the list of labels on the message.

      -- Method: remove_label (label)

          Remove `label' from the list of labels on the message.

      -- Method: get_visible ()

          Return an *note Message: bda. instance whose headers are the
          message’s visible headers and whose body is empty.

      -- Method: set_visible (visible)

          Set the message’s visible headers to be the same as the
          headers in `message'.  Parameter `visible' should be a *note
          Message: bda. instance, an *note email.message.Message: 536.
          instance, a string, or a file-like object (which should be
          open in text mode).

      -- Method: update_visible ()

          When a *note BabylMessage: 2889. instance’s original headers
          are modified, the visible headers are not automatically
          modified to correspond.  This method updates the visible
          headers as follows: each visible header with a corresponding
          original header is set to the value of the original header,
          each visible header without a corresponding original header is
          removed, and any of ‘Date’, ‘From’, ‘Reply-To’, ‘To’, ‘CC’,
          and ‘Subject’ that are present in the original headers but not
          the visible headers are added to the visible headers.

When a *note BabylMessage: 2889. instance is created based upon a *note
MaildirMessage: 285e. instance, the following conversions take place:

Resulting state         *note MaildirMessage: 285e. state
                        
------------------------------------------------------------
                        
“unseen” label          no S flag
                        
                        
“deleted” label         T flag
                        
                        
“answered” label        R flag
                        
                        
“forwarded” label       P flag
                        

When a *note BabylMessage: 2889. instance is created based upon an *note
mboxMessage: 2713. or *note MMDFMessage: 2891. instance, the ‘Status’
and ‘X-Status’ headers are omitted and the following conversions take
place:

Resulting state        *note mboxMessage: 2713. or
                       *note MMDFMessage: 2891. state
                       
--------------------------------------------------------------------------
                       
“unseen” label         no R flag
                       
                       
“deleted” label        D flag
                       
                       
“answered” label       A flag
                       

When a *note BabylMessage: 2889. instance is created based upon an *note
MHMessage: 2876. instance, the following conversions take place:

Resulting state        *note MHMessage: 2876. state
                       
------------------------------------------------------
                       
“unseen” label         “unseen” sequence
                       
                       
“answered” label       “replied” sequence
                       


File: python.info,  Node: MMDFMessage,  Prev: BabylMessage,  Up: Message objects

5.20.4.12 ‘MMDFMessage’
.......................

 -- Class: mailbox.MMDFMessage (message=None)

     A message with MMDF-specific behaviors.  Parameter `message' has
     the same meaning as with the *note Message: bda. constructor.

     As with message in an mbox mailbox, MMDF messages are stored with
     the sender’s address and the delivery date in an initial line
     beginning with “From “.  Likewise, flags that indicate the state of
     the message are typically stored in ‘Status’ and ‘X-Status’
     headers.

     Conventional flags for MMDF messages are identical to those of mbox
     message and are as follows:

     Flag       Meaning        Explanation
                               
     ---------------------------------------------------------------
                               
     R          Read           Read
                               
                               
     O          Old            Previously detected by MUA
                               
                               
     D          Deleted        Marked for subsequent deletion
                               
                               
     F          Flagged        Marked as important
                               
                               
     A          Answered       Replied to
                               

     The “R” and “O” flags are stored in the ‘Status’ header, and the
     “D”, “F”, and “A” flags are stored in the ‘X-Status’ header.  The
     flags and headers typically appear in the order mentioned.

     *note MMDFMessage: 2891. instances offer the following methods,
     which are identical to those offered by *note mboxMessage: 2713.:

      -- Method: get_from ()

          Return a string representing the “From ” line that marks the
          start of the message in an mbox mailbox.  The leading “From ”
          and the trailing newline are excluded.

      -- Method: set_from (from_, time_=None)

          Set the “From ” line to `from_', which should be specified
          without a leading “From ” or trailing newline.  For
          convenience, `time_' may be specified and will be formatted
          appropriately and appended to `from_'.  If `time_' is
          specified, it should be a *note time.struct_time: 58e.
          instance, a tuple suitable for passing to *note
          time.strftime(): b58, or ‘True’ (to use *note time.gmtime():
          b32.).

      -- Method: get_flags ()

          Return a string specifying the flags that are currently set.
          If the message complies with the conventional format, the
          result is the concatenation in the following order of zero or
          one occurrence of each of ‘'R'’, ‘'O'’, ‘'D'’, ‘'F'’, and
          ‘'A'’.

      -- Method: set_flags (flags)

          Set the flags specified by `flags' and unset all others.
          Parameter `flags' should be the concatenation in any order of
          zero or more occurrences of each of ‘'R'’, ‘'O'’, ‘'D'’,
          ‘'F'’, and ‘'A'’.

      -- Method: add_flag (flag)

          Set the flag(s) specified by `flag' without changing other
          flags.  To add more than one flag at a time, `flag' may be a
          string of more than one character.

      -- Method: remove_flag (flag)

          Unset the flag(s) specified by `flag' without changing other
          flags.  To remove more than one flag at a time, `flag' maybe a
          string of more than one character.

When an *note MMDFMessage: 2891. instance is created based upon a *note
MaildirMessage: 285e. instance, a “From ” line is generated based upon
the *note MaildirMessage: 285e. instance’s delivery date, and the
following conversions take place:

Resulting state       *note MaildirMessage: 285e. state
                      
----------------------------------------------------------
                      
R flag                S flag
                      
                      
O flag                “cur” subdirectory
                      
                      
D flag                T flag
                      
                      
F flag                F flag
                      
                      
A flag                R flag
                      

When an *note MMDFMessage: 2891. instance is created based upon an *note
MHMessage: 2876. instance, the following conversions take place:

Resulting state         *note MHMessage: 2876. state
                        
-------------------------------------------------------
                        
R flag and O flag       no “unseen” sequence
                        
                        
O flag                  “unseen” sequence
                        
                        
F flag                  “flagged” sequence
                        
                        
A flag                  “replied” sequence
                        

When an *note MMDFMessage: 2891. instance is created based upon a *note
BabylMessage: 2889. instance, the following conversions take place:

Resulting state         *note BabylMessage: 2889. state
                        
----------------------------------------------------------
                        
R flag and O flag       no “unseen” label
                        
                        
O flag                  “unseen” label
                        
                        
D flag                  “deleted” label
                        
                        
A flag                  “answered” label
                        

When an *note MMDFMessage: 2891. instance is created based upon an *note
mboxMessage: 2713. instance, the “From ” line is copied and all flags
directly correspond:

Resulting state       *note mboxMessage: 2713. state
                      
-------------------------------------------------------
                      
R flag                R flag
                      
                      
O flag                O flag
                      
                      
D flag                D flag
                      
                      
F flag                F flag
                      
                      
A flag                A flag
                      


File: python.info,  Node: Exceptions<14>,  Next: Examples<18>,  Prev: Message objects,  Up: mailbox — Manipulate mailboxes in various formats

5.20.4.13 Exceptions
....................

The following exception classes are defined in the *note mailbox: ae.
module:

 -- Exception: mailbox.Error

     The based class for all other module-specific exceptions.

 -- Exception: mailbox.NoSuchMailboxError

     Raised when a mailbox is expected but is not found, such as when
     instantiating a *note Mailbox: bd6. subclass with a path that does
     not exist (and with the `create' parameter set to ‘False’), or when
     opening a folder that does not exist.

 -- Exception: mailbox.NotEmptyError

     Raised when a mailbox is not empty but is expected to be, such as
     when deleting a folder that contains messages.

 -- Exception: mailbox.ExternalClashError

     Raised when some mailbox-related condition beyond the control of
     the program causes it to be unable to proceed, such as when failing
     to acquire a lock that another program already holds a lock, or
     when a uniquely-generated file name already exists.

 -- Exception: mailbox.FormatError

     Raised when the data in a file cannot be parsed, such as when an
     *note MH: 2875. instance attempts to read a corrupted
     ‘.mh_sequences’ file.


File: python.info,  Node: Examples<18>,  Prev: Exceptions<14>,  Up: mailbox — Manipulate mailboxes in various formats

5.20.4.14 Examples
..................

A simple example of printing the subjects of all messages in a mailbox
that seem interesting:

     import mailbox for message in mailbox.mbox('~/mbox'):     subject = message['subject']       # Could possibly be None.     if subject and 'python' in subject.lower():         print(subject)

To copy all mail from a Babyl mailbox to an MH mailbox, converting all
of the format-specific information that can be converted:

     import mailbox destination = mailbox.MH('~/Mail') destination.lock() for message in mailbox.Babyl('~/RMAIL'):     destination.add(mailbox.MHMessage(message)) destination.flush() destination.unlock()

This example sorts mail from several mailing lists into different
mailboxes, being careful to avoid mail corruption due to concurrent
modification by other programs, mail loss due to interruption of the
program, or premature termination due to malformed messages in the
mailbox:

     import mailbox import email.errors  list_names = ('python-list', 'python-dev', 'python-bugs')  boxes = {name: mailbox.mbox('~/email/%s' % name) for name in list_names} inbox = mailbox.Maildir('~/Maildir', factory=None)  for key in inbox.iterkeys():     try:         message = inbox[key]     except email.errors.MessageParseError:         continue                # The message is malformed. Just leave it.      for name in list_names:         list_id = message['list-id']         if list_id and name in list_id:             # Get mailbox to use             box = boxes[name]              # Write copy to disk before removing original.             # If there's a crash, you might duplicate a message, but             # that's better than losing a message completely.             box.lock()             box.add(message)             box.flush()             box.unlock()              # Remove original message             inbox.lock()             inbox.discard(key)             inbox.flush()             inbox.unlock()             break               # Found destination, so stop looking.  for box in boxes.itervalues():     box.close()


File: python.info,  Node: mimetypes — Map filenames to MIME types,  Next: base64 — Base16 Base32 Base64 Base85 Data Encodings,  Prev: mailbox — Manipulate mailboxes in various formats,  Up: Internet Data Handling

5.20.5 ‘mimetypes’ — Map filenames to MIME types
------------------------------------------------

`Source code:' Lib/mimetypes.py(1)

__________________________________________________________________

The *note mimetypes: b2. module converts between a filename or URL and
the MIME type associated with the filename extension.  Conversions are
provided from filename to MIME type and from MIME type to filename
extension; encodings are not supported for the latter conversion.

The module provides one class and a number of convenience functions.
The functions are the normal interface to this module, but some
applications may be interested in the class as well.

The functions described below provide the primary interface for this
module.  If the module has not been initialized, they will call *note
init(): 28c9. if they rely on the information *note init(): 28c9. sets
up.

 -- Function: mimetypes.guess_type (url, strict=True)

     Guess the type of a file based on its filename, path or URL, given
     by `url'.  URL can be a string or a *note path-like object: 35f.

     The return value is a tuple ‘(type, encoding)’ where `type' is
     ‘None’ if the type can’t be guessed (missing or unknown suffix) or
     a string of the form ‘'type/subtype'’, usable for a MIME
     ‘content-type’ header.

     `encoding' is ‘None’ for no encoding or the name of the program
     used to encode (e.g.  ‘compress’ or ‘gzip’).  The encoding is
     suitable for use as a ‘Content-Encoding’ header, `not' as a
     ‘Content-Transfer-Encoding’ header.  The mappings are table driven.
     Encoding suffixes are case sensitive; type suffixes are first tried
     case sensitively, then case insensitively.

     The optional `strict' argument is a flag specifying whether the
     list of known MIME types is limited to only the official types
     registered with IANA(2). When `strict' is ‘True’ (the default),
     only the IANA types are supported; when `strict' is ‘False’, some
     additional non-standard but commonly used MIME types are also
     recognized.

     Changed in version 3.8: Added support for url being a *note
     path-like object: 35f.

 -- Function: mimetypes.guess_all_extensions (type, strict=True)

     Guess the extensions for a file based on its MIME type, given by
     `type'.  The return value is a list of strings giving all possible
     filename extensions, including the leading dot (‘'.'’).  The
     extensions are not guaranteed to have been associated with any
     particular data stream, but would be mapped to the MIME type `type'
     by *note guess_type(): e9a.

     The optional `strict' argument has the same meaning as with the
     *note guess_type(): e9a. function.

 -- Function: mimetypes.guess_extension (type, strict=True)

     Guess the extension for a file based on its MIME type, given by
     `type'.  The return value is a string giving a filename extension,
     including the leading dot (‘'.'’).  The extension is not guaranteed
     to have been associated with any particular data stream, but would
     be mapped to the MIME type `type' by *note guess_type(): e9a.  If
     no extension can be guessed for `type', ‘None’ is returned.

     The optional `strict' argument has the same meaning as with the
     *note guess_type(): e9a. function.

Some additional functions and data items are available for controlling
the behavior of the module.

 -- Function: mimetypes.init (files=None)

     Initialize the internal data structures.  If given, `files' must be
     a sequence of file names which should be used to augment the
     default type map.  If omitted, the file names to use are taken from
     *note knownfiles: 28cc.; on Windows, the current registry settings
     are loaded.  Each file named in `files' or *note knownfiles: 28cc.
     takes precedence over those named before it.  Calling *note init():
     28c9. repeatedly is allowed.

     Specifying an empty list for `files' will prevent the system
     defaults from being applied: only the well-known values will be
     present from a built-in list.

     If `files' is ‘None’ the internal data structure is completely
     rebuilt to its initial default value.  This is a stable operation
     and will produce the same results when called multiple times.

     Changed in version 3.2: Previously, Windows registry settings were
     ignored.

 -- Function: mimetypes.read_mime_types (filename)

     Load the type map given in the file `filename', if it exists.  The
     type map is returned as a dictionary mapping filename extensions,
     including the leading dot (‘'.'’), to strings of the form
     ‘'type/subtype'’.  If the file `filename' does not exist or cannot
     be read, ‘None’ is returned.

 -- Function: mimetypes.add_type (type, ext, strict=True)

     Add a mapping from the MIME type `type' to the extension `ext'.
     When the extension is already known, the new type will replace the
     old one.  When the type is already known the extension will be
     added to the list of known extensions.

     When `strict' is ‘True’ (the default), the mapping will be added to
     the official MIME types, otherwise to the non-standard ones.

 -- Data: mimetypes.inited

     Flag indicating whether or not the global data structures have been
     initialized.  This is set to ‘True’ by *note init(): 28c9.

 -- Data: mimetypes.knownfiles

     List of type map file names commonly installed.  These files are
     typically named ‘mime.types’ and are installed in different
     locations by different packages.

 -- Data: mimetypes.suffix_map

     Dictionary mapping suffixes to suffixes.  This is used to allow
     recognition of encoded files for which the encoding and the type
     are indicated by the same extension.  For example, the ‘.tgz’
     extension is mapped to ‘.tar.gz’ to allow the encoding and type to
     be recognized separately.

 -- Data: mimetypes.encodings_map

     Dictionary mapping filename extensions to encoding types.

 -- Data: mimetypes.types_map

     Dictionary mapping filename extensions to MIME types.

 -- Data: mimetypes.common_types

     Dictionary mapping filename extensions to non-standard, but
     commonly found MIME types.

An example usage of the module:

     >>> import mimetypes >>> mimetypes.init() >>> mimetypes.knownfiles ['/etc/mime.types', '/etc/httpd/mime.types', ... ] >>> mimetypes.suffix_map['.tgz'] '.tar.gz' >>> mimetypes.encodings_map['.gz'] 'gzip' >>> mimetypes.types_map['.tgz'] 'application/x-tar-gz'

* Menu:

* MimeTypes Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/mimetypes.py

   (2) https://www.iana.org/assignments/media-types/media-types.xhtml


File: python.info,  Node: MimeTypes Objects,  Up: mimetypes — Map filenames to MIME types

5.20.5.1 MimeTypes Objects
..........................

The *note MimeTypes: 28d6. class may be useful for applications which
may want more than one MIME-type database; it provides an interface
similar to the one of the *note mimetypes: b2. module.

 -- Class: mimetypes.MimeTypes (filenames=(), strict=True)

     This class represents a MIME-types database.  By default, it
     provides access to the same database as the rest of this module.
     The initial database is a copy of that provided by the module, and
     may be extended by loading additional ‘mime.types’-style files into
     the database using the *note read(): 28d7. or *note readfp(): 28d8.
     methods.  The mapping dictionaries may also be cleared before
     loading additional data if the default data is not desired.

     The optional `filenames' parameter can be used to cause additional
     files to be loaded “on top” of the default database.

      -- Attribute: suffix_map

          Dictionary mapping suffixes to suffixes.  This is used to
          allow recognition of encoded files for which the encoding and
          the type are indicated by the same extension.  For example,
          the ‘.tgz’ extension is mapped to ‘.tar.gz’ to allow the
          encoding and type to be recognized separately.  This is
          initially a copy of the global *note suffix_map: 28d0. defined
          in the module.

      -- Attribute: encodings_map

          Dictionary mapping filename extensions to encoding types.
          This is initially a copy of the global *note encodings_map:
          28d1. defined in the module.

      -- Attribute: types_map

          Tuple containing two dictionaries, mapping filename extensions
          to MIME types: the first dictionary is for the non-standards
          types and the second one is for the standard types.  They are
          initialized by *note common_types: 28d3. and *note types_map:
          28d2.

      -- Attribute: types_map_inv

          Tuple containing two dictionaries, mapping MIME types to a
          list of filename extensions: the first dictionary is for the
          non-standards types and the second one is for the standard
          types.  They are initialized by *note common_types: 28d3. and
          *note types_map: 28d2.

      -- Method: guess_extension (type, strict=True)

          Similar to the *note guess_extension(): 28cb. function, using
          the tables stored as part of the object.

      -- Method: guess_type (url, strict=True)

          Similar to the *note guess_type(): e9a. function, using the
          tables stored as part of the object.

      -- Method: guess_all_extensions (type, strict=True)

          Similar to the *note guess_all_extensions(): 28ca. function,
          using the tables stored as part of the object.

      -- Method: read (filename, strict=True)

          Load MIME information from a file named `filename'.  This uses
          *note readfp(): 28d8. to parse the file.

          If `strict' is ‘True’, information will be added to list of
          standard types, else to the list of non-standard types.

      -- Method: readfp (fp, strict=True)

          Load MIME type information from an open file `fp'.  The file
          must have the format of the standard ‘mime.types’ files.

          If `strict' is ‘True’, information will be added to the list
          of standard types, else to the list of non-standard types.

      -- Method: read_windows_registry (strict=True)

          Load MIME type information from the Windows registry.

          *note Availability: 129a.: Windows.

          If `strict' is ‘True’, information will be added to the list
          of standard types, else to the list of non-standard types.

          New in version 3.2.


File: python.info,  Node: base64 — Base16 Base32 Base64 Base85 Data Encodings,  Next: binhex — Encode and decode binhex4 files,  Prev: mimetypes — Map filenames to MIME types,  Up: Internet Data Handling

5.20.6 ‘base64’ — Base16, Base32, Base64, Base85 Data Encodings
---------------------------------------------------------------

`Source code:' Lib/base64.py(1)

__________________________________________________________________

This module provides functions for encoding binary data to printable
ASCII characters and decoding such encodings back to binary data.  It
provides encoding and decoding functions for the encodings specified in
RFC 3548(2), which defines the Base16, Base32, and Base64 algorithms,
and for the de-facto standard Ascii85 and Base85 encodings.

The RFC 3548(3) encodings are suitable for encoding binary data so that
it can safely sent by email, used as parts of URLs, or included as part
of an HTTP POST request.  The encoding algorithm is not the same as the
‘uuencode’ program.

There are two interfaces provided by this module.  The modern interface
supports encoding *note bytes-like objects: 5dd. to ASCII *note bytes:
326, and decoding *note bytes-like objects: 5dd. or strings containing
ASCII to *note bytes: 326.  Both base-64 alphabets defined in RFC
3548(4) (normal, and URL- and filesystem-safe) are supported.

The legacy interface does not support decoding from strings, but it does
provide functions for encoding and decoding to and from *note file
objects: b35.  It only supports the Base64 standard alphabet, and it
adds newlines every 76 characters as per RFC 2045(5).  Note that if you
are looking for RFC 2045(6) support you probably want to be looking at
the *note email: 69. package instead.

Changed in version 3.3: ASCII-only Unicode strings are now accepted by
the decoding functions of the modern interface.

Changed in version 3.4: Any *note bytes-like objects: 5dd. are now
accepted by all encoding and decoding functions in this module.
Ascii85/Base85 support added.

The modern interface provides:

 -- Function: base64.b64encode (s, altchars=None)

     Encode the *note bytes-like object: 5dd. `s' using Base64 and
     return the encoded *note bytes: 326.

     Optional `altchars' must be a *note bytes-like object: 5dd. of at
     least length 2 (additional characters are ignored) which specifies
     an alternative alphabet for the ‘+’ and ‘/’ characters.  This
     allows an application to e.g.  generate URL or filesystem safe
     Base64 strings.  The default is ‘None’, for which the standard
     Base64 alphabet is used.

 -- Function: base64.b64decode (s, altchars=None, validate=False)

     Decode the Base64 encoded *note bytes-like object: 5dd. or ASCII
     string `s' and return the decoded *note bytes: 326.

     Optional `altchars' must be a *note bytes-like object: 5dd. or
     ASCII string of at least length 2 (additional characters are
     ignored) which specifies the alternative alphabet used instead of
     the ‘+’ and ‘/’ characters.

     A *note binascii.Error: 952. exception is raised if `s' is
     incorrectly padded.

     If `validate' is ‘False’ (the default), characters that are neither
     in the normal base-64 alphabet nor the alternative alphabet are
     discarded prior to the padding check.  If `validate' is ‘True’,
     these non-alphabet characters in the input result in a *note
     binascii.Error: 952.

 -- Function: base64.standard_b64encode (s)

     Encode *note bytes-like object: 5dd. `s' using the standard Base64
     alphabet and return the encoded *note bytes: 326.

 -- Function: base64.standard_b64decode (s)

     Decode *note bytes-like object: 5dd. or ASCII string `s' using the
     standard Base64 alphabet and return the decoded *note bytes: 326.

 -- Function: base64.urlsafe_b64encode (s)

     Encode *note bytes-like object: 5dd. `s' using the URL- and
     filesystem-safe alphabet, which substitutes ‘-’ instead of ‘+’ and
     ‘_’ instead of ‘/’ in the standard Base64 alphabet, and return the
     encoded *note bytes: 326.  The result can still contain ‘=’.

 -- Function: base64.urlsafe_b64decode (s)

     Decode *note bytes-like object: 5dd. or ASCII string `s' using the
     URL- and filesystem-safe alphabet, which substitutes ‘-’ instead of
     ‘+’ and ‘_’ instead of ‘/’ in the standard Base64 alphabet, and
     return the decoded *note bytes: 326.

 -- Function: base64.b32encode (s)

     Encode the *note bytes-like object: 5dd. `s' using Base32 and
     return the encoded *note bytes: 326.

 -- Function: base64.b32decode (s, casefold=False, map01=None)

     Decode the Base32 encoded *note bytes-like object: 5dd. or ASCII
     string `s' and return the decoded *note bytes: 326.

     Optional `casefold' is a flag specifying whether a lowercase
     alphabet is acceptable as input.  For security purposes, the
     default is ‘False’.

     RFC 3548(7) allows for optional mapping of the digit 0 (zero) to
     the letter O (oh), and for optional mapping of the digit 1 (one) to
     either the letter I (eye) or letter L (el).  The optional argument
     `map01' when not ‘None’, specifies which letter the digit 1 should
     be mapped to (when `map01' is not ‘None’, the digit 0 is always
     mapped to the letter O). For security purposes the default is
     ‘None’, so that 0 and 1 are not allowed in the input.

     A *note binascii.Error: 952. is raised if `s' is incorrectly padded
     or if there are non-alphabet characters present in the input.

 -- Function: base64.b16encode (s)

     Encode the *note bytes-like object: 5dd. `s' using Base16 and
     return the encoded *note bytes: 326.

 -- Function: base64.b16decode (s, casefold=False)

     Decode the Base16 encoded *note bytes-like object: 5dd. or ASCII
     string `s' and return the decoded *note bytes: 326.

     Optional `casefold' is a flag specifying whether a lowercase
     alphabet is acceptable as input.  For security purposes, the
     default is ‘False’.

     A *note binascii.Error: 952. is raised if `s' is incorrectly padded
     or if there are non-alphabet characters present in the input.

 -- Function: base64.a85encode (b, *, foldspaces=False, wrapcol=0,
          pad=False, adobe=False)

     Encode the *note bytes-like object: 5dd. `b' using Ascii85 and
     return the encoded *note bytes: 326.

     `foldspaces' is an optional flag that uses the special short
     sequence ‘y’ instead of 4 consecutive spaces (ASCII 0x20) as
     supported by ‘btoa’.  This feature is not supported by the
     “standard” Ascii85 encoding.

     `wrapcol' controls whether the output should have newline (‘b'\n'’)
     characters added to it.  If this is non-zero, each output line will
     be at most this many characters long.

     `pad' controls whether the input is padded to a multiple of 4
     before encoding.  Note that the ‘btoa’ implementation always pads.

     `adobe' controls whether the encoded byte sequence is framed with
     ‘<~’ and ‘~>’, which is used by the Adobe implementation.

     New in version 3.4.

 -- Function: base64.a85decode (b, *, foldspaces=False, adobe=False,
          ignorechars=b' \t\n\r\v')

     Decode the Ascii85 encoded *note bytes-like object: 5dd. or ASCII
     string `b' and return the decoded *note bytes: 326.

     `foldspaces' is a flag that specifies whether the ‘y’ short
     sequence should be accepted as shorthand for 4 consecutive spaces
     (ASCII 0x20).  This feature is not supported by the “standard”
     Ascii85 encoding.

     `adobe' controls whether the input sequence is in Adobe Ascii85
     format (i.e.  is framed with <~ and ~>).

     `ignorechars' should be a *note bytes-like object: 5dd. or ASCII
     string containing characters to ignore from the input.  This should
     only contain whitespace characters, and by default contains all
     whitespace characters in ASCII.

     New in version 3.4.

 -- Function: base64.b85encode (b, pad=False)

     Encode the *note bytes-like object: 5dd. `b' using base85 (as used
     in e.g.  git-style binary diffs) and return the encoded *note
     bytes: 326.

     If `pad' is true, the input is padded with ‘b'\0'’ so its length is
     a multiple of 4 bytes before encoding.

     New in version 3.4.

 -- Function: base64.b85decode (b)

     Decode the base85-encoded *note bytes-like object: 5dd. or ASCII
     string `b' and return the decoded *note bytes: 326.  Padding is
     implicitly removed, if necessary.

     New in version 3.4.

The legacy interface:

 -- Function: base64.decode (input, output)

     Decode the contents of the binary `input' file and write the
     resulting binary data to the `output' file.  `input' and `output'
     must be *note file objects: b35.  `input' will be read until
     ‘input.readline()’ returns an empty bytes object.

 -- Function: base64.decodebytes (s)

     Decode the *note bytes-like object: 5dd. `s', which must contain
     one or more lines of base64 encoded data, and return the decoded
     *note bytes: 326.

     New in version 3.1.

 -- Function: base64.decodestring (s)

     Deprecated alias of *note decodebytes(): 17ad.

     Deprecated since version 3.1.

 -- Function: base64.encode (input, output)

     Encode the contents of the binary `input' file and write the
     resulting base64 encoded data to the `output' file.  `input' and
     `output' must be *note file objects: b35.  `input' will be read
     until ‘input.read()’ returns an empty bytes object.  *note
     encode(): 28ed. inserts a newline character (‘b'\n'’) after every
     76 bytes of the output, as well as ensuring that the output always
     ends with a newline, as per RFC 2045(8) (MIME).

 -- Function: base64.encodebytes (s)

     Encode the *note bytes-like object: 5dd. `s', which can contain
     arbitrary binary data, and return *note bytes: 326. containing the
     base64-encoded data, with newlines (‘b'\n'’) inserted after every
     76 bytes of output, and ensuring that there is a trailing newline,
     as per RFC 2045(9) (MIME).

     New in version 3.1.

 -- Function: base64.encodestring (s)

     Deprecated alias of *note encodebytes(): 17ac.

     Deprecated since version 3.1.

An example usage of the module:

     >>> import base64 >>> encoded = base64.b64encode(b'data to be encoded') >>> encoded b'ZGF0YSB0byBiZSBlbmNvZGVk' >>> data = base64.b64decode(encoded) >>> data b'data to be encoded'

See also
........

Module *note binascii: 10.

     Support module containing ASCII-to-binary and binary-to-ASCII
     conversions.

RFC 1521(10) - MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies

     Section 5.2, “Base64 Content-Transfer-Encoding,” provides the
     definition of the base64 encoding.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/base64.py

   (2) https://tools.ietf.org/html/rfc3548.html

   (3) https://tools.ietf.org/html/rfc3548.html

   (4) https://tools.ietf.org/html/rfc3548.html

   (5) https://tools.ietf.org/html/rfc2045.html

   (6) https://tools.ietf.org/html/rfc2045.html

   (7) https://tools.ietf.org/html/rfc3548.html

   (8) https://tools.ietf.org/html/rfc2045.html

   (9) https://tools.ietf.org/html/rfc2045.html

   (10) https://tools.ietf.org/html/rfc1521.html


File: python.info,  Node: binhex — Encode and decode binhex4 files,  Next: binascii — Convert between binary and ASCII,  Prev: base64 — Base16 Base32 Base64 Base85 Data Encodings,  Up: Internet Data Handling

5.20.7 ‘binhex’ — Encode and decode binhex4 files
-------------------------------------------------

`Source code:' Lib/binhex.py(1)

__________________________________________________________________

This module encodes and decodes files in binhex4 format, a format
allowing representation of Macintosh files in ASCII. Only the data fork
is handled.

The *note binhex: 11. module defines the following functions:

 -- Function: binhex.binhex (input, output)

     Convert a binary file with filename `input' to binhex file
     `output'.  The `output' parameter can either be a filename or a
     file-like object (any object supporting a ‘write()’ and ‘close()’
     method).

 -- Function: binhex.hexbin (input, output)

     Decode a binhex file `input'.  `input' may be a filename or a
     file-like object supporting ‘read()’ and ‘close()’ methods.  The
     resulting file is written to a file named `output', unless the
     argument is ‘None’ in which case the output filename is read from
     the binhex file.

The following exception is also defined:

 -- Exception: binhex.Error

     Exception raised when something can’t be encoded using the binhex
     format (for example, a filename is too long to fit in the filename
     field), or when input is not properly encoded binhex data.

See also
........

Module *note binascii: 10.

     Support module containing ASCII-to-binary and binary-to-ASCII
     conversions.

* Menu:

* Notes: Notes<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/binhex.py


File: python.info,  Node: Notes<2>,  Up: binhex — Encode and decode binhex4 files

5.20.7.1 Notes
..............

There is an alternative, more powerful interface to the coder and
decoder, see the source for details.

If you code or decode textfiles on non-Macintosh platforms they will
still use the old Macintosh newline convention (carriage-return as end
of line).


File: python.info,  Node: binascii — Convert between binary and ASCII,  Next: quopri — Encode and decode MIME quoted-printable data,  Prev: binhex — Encode and decode binhex4 files,  Up: Internet Data Handling

5.20.8 ‘binascii’ — Convert between binary and ASCII
----------------------------------------------------

__________________________________________________________________

The *note binascii: 10. module contains a number of methods to convert
between binary and various ASCII-encoded binary representations.
Normally, you will not use these functions directly but use wrapper
modules like *note uu: 123, *note base64: e, or *note binhex: 11.
instead.  The *note binascii: 10. module contains low-level functions
written in C for greater speed that are used by the higher-level
modules.

     Note: ‘a2b_*’ functions accept Unicode strings containing only
     ASCII characters.  Other functions only accept *note bytes-like
     objects: 5dd. (such as *note bytes: 326, *note bytearray: 327. and
     other objects that support the buffer protocol).

     Changed in version 3.3: ASCII-only unicode strings are now accepted
     by the ‘a2b_*’ functions.

The *note binascii: 10. module defines the following functions:

 -- Function: binascii.a2b_uu (string)

     Convert a single line of uuencoded data back to binary and return
     the binary data.  Lines normally contain 45 (binary) bytes, except
     for the last line.  Line data may be followed by whitespace.

 -- Function: binascii.b2a_uu (data, *, backtick=False)

     Convert binary data to a line of ASCII characters, the return value
     is the converted line, including a newline char.  The length of
     `data' should be at most 45.  If `backtick' is true, zeros are
     represented by ‘'`'’ instead of spaces.

     Changed in version 3.7: Added the `backtick' parameter.

 -- Function: binascii.a2b_base64 (string)

     Convert a block of base64 data back to binary and return the binary
     data.  More than one line may be passed at a time.

 -- Function: binascii.b2a_base64 (data, *, newline=True)

     Convert binary data to a line of ASCII characters in base64 coding.
     The return value is the converted line, including a newline char if
     `newline' is true.  The output of this function conforms to RFC
     3548(1).

     Changed in version 3.6: Added the `newline' parameter.

 -- Function: binascii.a2b_qp (data, header=False)

     Convert a block of quoted-printable data back to binary and return
     the binary data.  More than one line may be passed at a time.  If
     the optional argument `header' is present and true, underscores
     will be decoded as spaces.

 -- Function: binascii.b2a_qp (data, quotetabs=False, istext=True,
          header=False)

     Convert binary data to a line(s) of ASCII characters in
     quoted-printable encoding.  The return value is the converted
     line(s).  If the optional argument `quotetabs' is present and true,
     all tabs and spaces will be encoded.  If the optional argument
     `istext' is present and true, newlines are not encoded but trailing
     whitespace will be encoded.  If the optional argument `header' is
     present and true, spaces will be encoded as underscores per RFC
     1522(2).  If the optional argument `header' is present and false,
     newline characters will be encoded as well; otherwise linefeed
     conversion might corrupt the binary data stream.

 -- Function: binascii.a2b_hqx (string)

     Convert binhex4 formatted ASCII data to binary, without doing
     RLE-decompression.  The string should contain a complete number of
     binary bytes, or (in case of the last portion of the binhex4 data)
     have the remaining bits zero.

 -- Function: binascii.rledecode_hqx (data)

     Perform RLE-decompression on the data, as per the binhex4 standard.
     The algorithm uses ‘0x90’ after a byte as a repeat indicator,
     followed by a count.  A count of ‘0’ specifies a byte value of
     ‘0x90’.  The routine returns the decompressed data, unless data
     input data ends in an orphaned repeat indicator, in which case the
     *note Incomplete: 28fe. exception is raised.

     Changed in version 3.2: Accept only bytestring or bytearray objects
     as input.

 -- Function: binascii.rlecode_hqx (data)

     Perform binhex4 style RLE-compression on `data' and return the
     result.

 -- Function: binascii.b2a_hqx (data)

     Perform hexbin4 binary-to-ASCII translation and return the
     resulting string.  The argument should already be RLE-coded, and
     have a length divisible by 3 (except possibly the last fragment).

 -- Function: binascii.crc_hqx (data, value)

     Compute a 16-bit CRC value of `data', starting with `value' as the
     initial CRC, and return the result.  This uses the CRC-CCITT
     polynomial `x'^16 + `x'^12 + `x'^5 + 1, often represented as
     0x1021.  This CRC is used in the binhex4 format.

 -- Function: binascii.crc32 (data[, value])

     Compute CRC-32, the 32-bit checksum of `data', starting with an
     initial CRC of `value'.  The default initial CRC is zero.  The
     algorithm is consistent with the ZIP file checksum.  Since the
     algorithm is designed for use as a checksum algorithm, it is not
     suitable for use as a general hash algorithm.  Use as follows:

          print(binascii.crc32(b"hello world")) # Or, in two pieces: crc = binascii.crc32(b"hello") crc = binascii.crc32(b" world", crc) print('crc32 = {:#010x}'.format(crc))

     Changed in version 3.0: The result is always unsigned.  To generate
     the same numeric value across all Python versions and platforms,
     use ‘crc32(data) & 0xffffffff’.

 -- Function: binascii.b2a_hex (data[, sep[, bytes_per_sep=1]])
 -- Function: binascii.hexlify (data[, sep[, bytes_per_sep=1]])

     Return the hexadecimal representation of the binary `data'.  Every
     byte of `data' is converted into the corresponding 2-digit hex
     representation.  The returned bytes object is therefore twice as
     long as the length of `data'.

     Similar functionality (but returning a text string) is also
     conveniently accessible using the *note bytes.hex(): 625. method.

     If `sep' is specified, it must be a single character str or bytes
     object.  It will be inserted in the output after every
     `bytes_per_sep' input bytes.  Separator placement is counted from
     the right end of the output by default, if you wish to count from
     the left, supply a negative `bytes_per_sep' value.

          >>> import binascii >>> binascii.b2a_hex(b'\xb9\x01\xef') b'b901ef' >>> binascii.hexlify(b'\xb9\x01\xef', '-') b'b9-01-ef' >>> binascii.b2a_hex(b'\xb9\x01\xef', b'_', 2) b'b9_01ef' >>> binascii.b2a_hex(b'\xb9\x01\xef', b' ', -2) b'b901 ef'

     Changed in version 3.8: The `sep' and `bytes_per_sep' parameters
     were added.

 -- Function: binascii.a2b_hex (hexstr)
 -- Function: binascii.unhexlify (hexstr)

     Return the binary data represented by the hexadecimal string
     `hexstr'.  This function is the inverse of *note b2a_hex(): 17af.
     `hexstr' must contain an even number of hexadecimal digits (which
     can be upper or lower case), otherwise an *note Error: 952.
     exception is raised.

     Similar functionality (accepting only text string arguments, but
     more liberal towards whitespace) is also accessible using the *note
     bytes.fromhex(): 323. class method.

 -- Exception: binascii.Error

     Exception raised on errors.  These are usually programming errors.

 -- Exception: binascii.Incomplete

     Exception raised on incomplete data.  These are usually not
     programming errors, but may be handled by reading a little more
     data and trying again.

See also
........

Module *note base64: e.

     Support for RFC compliant base64-style encoding in base 16, 32, 64,
     and 85.

Module *note binhex: 11.

     Support for the binhex format used on the Macintosh.

Module *note uu: 123.

     Support for UU encoding used on Unix.

Module *note quopri: db.

     Support for quoted-printable encoding used in MIME email messages.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3548.html

   (2) https://tools.ietf.org/html/rfc1522.html


File: python.info,  Node: quopri — Encode and decode MIME quoted-printable data,  Next: uu — Encode and decode uuencode files,  Prev: binascii — Convert between binary and ASCII,  Up: Internet Data Handling

5.20.9 ‘quopri’ — Encode and decode MIME quoted-printable data
--------------------------------------------------------------

`Source code:' Lib/quopri.py(1)

__________________________________________________________________

This module performs quoted-printable transport encoding and decoding,
as defined in RFC 1521(2): “MIME (Multipurpose Internet Mail Extensions)
Part One: Mechanisms for Specifying and Describing the Format of
Internet Message Bodies”.  The quoted-printable encoding is designed for
data where there are relatively few nonprintable characters; the base64
encoding scheme available via the *note base64: e. module is more
compact if there are many such characters, as when sending a graphics
file.

 -- Function: quopri.decode (input, output, header=False)

     Decode the contents of the `input' file and write the resulting
     decoded binary data to the `output' file.  `input' and `output'
     must be *note binary file objects: b35.  If the optional argument
     `header' is present and true, underscore will be decoded as space.
     This is used to decode “Q”-encoded headers as described in RFC
     1522(3): “MIME (Multipurpose Internet Mail Extensions) Part Two:
     Message Header Extensions for Non-ASCII Text”.

 -- Function: quopri.encode (input, output, quotetabs, header=False)

     Encode the contents of the `input' file and write the resulting
     quoted-printable data to the `output' file.  `input' and `output'
     must be *note binary file objects: b35.  `quotetabs', a
     non-optional flag which controls whether to encode embedded spaces
     and tabs; when true it encodes such embedded whitespace, and when
     false it leaves them unencoded.  Note that spaces and tabs
     appearing at the end of lines are always encoded, as per RFC
     1521(4).  `header' is a flag which controls if spaces are encoded
     as underscores as per RFC 1522(5).

 -- Function: quopri.decodestring (s, header=False)

     Like *note decode(): 17b2, except that it accepts a source *note
     bytes: 326. and returns the corresponding decoded *note bytes: 326.

 -- Function: quopri.encodestring (s, quotetabs=False, header=False)

     Like *note encode(): 17b1, except that it accepts a source *note
     bytes: 326. and returns the corresponding encoded *note bytes: 326.
     By default, it sends a ‘False’ value to `quotetabs' parameter of
     the *note encode(): 17b1. function.

See also
........

Module *note base64: e.

     Encode and decode MIME base64 data

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/quopri.py

   (2) https://tools.ietf.org/html/rfc1521.html

   (3) https://tools.ietf.org/html/rfc1522.html

   (4) https://tools.ietf.org/html/rfc1521.html

   (5) https://tools.ietf.org/html/rfc1522.html


File: python.info,  Node: uu — Encode and decode uuencode files,  Prev: quopri — Encode and decode MIME quoted-printable data,  Up: Internet Data Handling

5.20.10 ‘uu’ — Encode and decode uuencode files
-----------------------------------------------

`Source code:' Lib/uu.py(1)

__________________________________________________________________

This module encodes and decodes files in uuencode format, allowing
arbitrary binary data to be transferred over ASCII-only connections.
Wherever a file argument is expected, the methods accept a file-like
object.  For backwards compatibility, a string containing a pathname is
also accepted, and the corresponding file will be opened for reading and
writing; the pathname ‘'-'’ is understood to mean the standard input or
output.  However, this interface is deprecated; it’s better for the
caller to open the file itself, and be sure that, when required, the
mode is ‘'rb'’ or ‘'wb'’ on Windows.

This code was contributed by Lance Ellinghouse, and modified by Jack
Jansen.

The *note uu: 123. module defines the following functions:

 -- Function: uu.encode (in_file, out_file, name=None, mode=None, *,
          backtick=False)

     Uuencode file `in_file' into file `out_file'.  The uuencoded file
     will have the header specifying `name' and `mode' as the defaults
     for the results of decoding the file.  The default defaults are
     taken from `in_file', or ‘'-'’ and ‘0o666’ respectively.  If
     `backtick' is true, zeros are represented by ‘'`'’ instead of
     spaces.

     Changed in version 3.7: Added the `backtick' parameter.

 -- Function: uu.decode (in_file, out_file=None, mode=None, quiet=False)

     This call decodes uuencoded file `in_file' placing the result on
     file `out_file'.  If `out_file' is a pathname, `mode' is used to
     set the permission bits if the file must be created.  Defaults for
     `out_file' and `mode' are taken from the uuencode header.  However,
     if the file specified in the header already exists, a *note
     uu.Error: 2909. is raised.

     *note decode(): 17b3. may print a warning to standard error if the
     input was produced by an incorrect uuencoder and Python could
     recover from that error.  Setting `quiet' to a true value silences
     this warning.

 -- Exception: uu.Error

     Subclass of *note Exception: 1a8, this can be raised by *note
     uu.decode(): 17b3. under various situations, such as described
     above, but also including a badly formatted header, or truncated
     input file.

See also
........

Module *note binascii: 10.

     Support module containing ASCII-to-binary and binary-to-ASCII
     conversions.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/uu.py


File: python.info,  Node: Structured Markup Processing Tools,  Next: Internet Protocols and Support,  Prev: Internet Data Handling,  Up: The Python Standard Library

5.21 Structured Markup Processing Tools
=======================================

Python supports a variety of modules to work with various forms of
structured data markup.  This includes modules to work with the Standard
Generalized Markup Language (SGML) and the Hypertext Markup Language
(HTML), and several interfaces for working with the Extensible Markup
Language (XML).

* Menu:

* html — HyperText Markup Language support::
* html.parser — Simple HTML and XHTML parser: html parser — Simple HTML and XHTML parser.
* html.entities — Definitions of HTML general entities: html entities — Definitions of HTML general entities.
* XML Processing Modules::
* xml.etree.ElementTree — The ElementTree XML API: xml etree ElementTree — The ElementTree XML API.
* xml.dom — The Document Object Model API: xml dom — The Document Object Model API.
* xml.dom.minidom — Minimal DOM implementation: xml dom minidom — Minimal DOM implementation.
* xml.dom.pulldom — Support for building partial DOM trees: xml dom pulldom — Support for building partial DOM trees.
* xml.sax — Support for SAX2 parsers: xml sax — Support for SAX2 parsers.
* xml.sax.handler — Base classes for SAX handlers: xml sax handler — Base classes for SAX handlers.
* xml.sax.saxutils — SAX Utilities: xml sax saxutils — SAX Utilities.
* xml.sax.xmlreader — Interface for XML parsers: xml sax xmlreader — Interface for XML parsers.
* xml.parsers.expat — Fast XML parsing using Expat: xml parsers expat — Fast XML parsing using Expat.


File: python.info,  Node: html — HyperText Markup Language support,  Next: html parser — Simple HTML and XHTML parser,  Up: Structured Markup Processing Tools

5.21.1 ‘html’ — HyperText Markup Language support
-------------------------------------------------

`Source code:' Lib/html/__init__.py(1)

__________________________________________________________________

This module defines utilities to manipulate HTML.

 -- Function: html.escape (s, quote=True)

     Convert the characters ‘&’, ‘<’ and ‘>’ in string `s' to HTML-safe
     sequences.  Use this if you need to display text that might contain
     such characters in HTML. If the optional flag `quote' is true, the
     characters (‘"’) and (‘'’) are also translated; this helps for
     inclusion in an HTML attribute value delimited by quotes, as in ‘<a
     href="...">’.

     New in version 3.2.

 -- Function: html.unescape (s)

     Convert all named and numeric character references (e.g.  ‘&gt;’,
     ‘&#62;’, ‘&#x3e;’) in the string `s' to the corresponding Unicode
     characters.  This function uses the rules defined by the HTML 5
     standard for both valid and invalid character references, and the
     *note list of HTML 5 named character references: a0a.

     New in version 3.4.

__________________________________________________________________

Submodules in the ‘html’ package are:

   * *note html.parser: 92. – HTML/XHTML parser with lenient parsing
     mode

   * *note html.entities: 91. – HTML entity definitions

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/html/__init__.py


File: python.info,  Node: html parser — Simple HTML and XHTML parser,  Next: html entities — Definitions of HTML general entities,  Prev: html — HyperText Markup Language support,  Up: Structured Markup Processing Tools

5.21.2 ‘html.parser’ — Simple HTML and XHTML parser
---------------------------------------------------

`Source code:' Lib/html/parser.py(1)

__________________________________________________________________

This module defines a class *note HTMLParser: 7b3. which serves as the
basis for parsing text files formatted in HTML (HyperText Mark-up
Language) and XHTML.

 -- Class: html.parser.HTMLParser (*, convert_charrefs=True)

     Create a parser instance able to parse invalid markup.

     If `convert_charrefs' is ‘True’ (the default), all character
     references (except the ones in ‘script’/‘style’ elements) are
     automatically converted to the corresponding Unicode characters.

     An *note HTMLParser: 7b3. instance is fed HTML data and calls
     handler methods when start tags, end tags, text, comments, and
     other markup elements are encountered.  The user should subclass
     *note HTMLParser: 7b3. and override its methods to implement the
     desired behavior.

     This parser does not check that end tags match start tags or call
     the end-tag handler for elements which are closed implicitly by
     closing an outer element.

     Changed in version 3.4: `convert_charrefs' keyword argument added.

     Changed in version 3.5: The default value for argument
     `convert_charrefs' is now ‘True’.

* Menu:

* Example HTML Parser Application::
* HTMLParser Methods::
* Examples: Examples<19>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/html/parser.py


File: python.info,  Node: Example HTML Parser Application,  Next: HTMLParser Methods,  Up: html parser — Simple HTML and XHTML parser

5.21.2.1 Example HTML Parser Application
........................................

As a basic example, below is a simple HTML parser that uses the *note
HTMLParser: 7b3. class to print out start tags, end tags, and data as
they are encountered:

     from html.parser import HTMLParser  class MyHTMLParser(HTMLParser):     def handle_starttag(self, tag, attrs):         print("Encountered a start tag:", tag)      def handle_endtag(self, tag):         print("Encountered an end tag :", tag)      def handle_data(self, data):         print("Encountered some data  :", data)  parser = MyHTMLParser() parser.feed('<html><head><title>Test</title></head>'             '<body><h1>Parse me!</h1></body></html>')

The output will then be:

     Encountered a start tag: html Encountered a start tag: head Encountered a start tag: title Encountered some data  : Test Encountered an end tag : title Encountered an end tag : head Encountered a start tag: body Encountered a start tag: h1 Encountered some data  : Parse me! Encountered an end tag : h1 Encountered an end tag : body Encountered an end tag : html


File: python.info,  Node: HTMLParser Methods,  Next: Examples<19>,  Prev: Example HTML Parser Application,  Up: html parser — Simple HTML and XHTML parser

5.21.2.2 ‘HTMLParser’ Methods
.............................

*note HTMLParser: 7b3. instances have the following methods:

 -- Method: HTMLParser.feed (data)

     Feed some text to the parser.  It is processed insofar as it
     consists of complete elements; incomplete data is buffered until
     more data is fed or *note close(): 2914. is called.  `data' must be
     *note str: 325.

 -- Method: HTMLParser.close ()

     Force processing of all buffered data as if it were followed by an
     end-of-file mark.  This method may be redefined by a derived class
     to define additional processing at the end of the input, but the
     redefined version should always call the *note HTMLParser: 7b3.
     base class method *note close(): 2914.

 -- Method: HTMLParser.reset ()

     Reset the instance.  Loses all unprocessed data.  This is called
     implicitly at instantiation time.

 -- Method: HTMLParser.getpos ()

     Return current line number and offset.

 -- Method: HTMLParser.get_starttag_text ()

     Return the text of the most recently opened start tag.  This should
     not normally be needed for structured processing, but may be useful
     in dealing with HTML “as deployed” or for re-generating input with
     minimal changes (whitespace between attributes can be preserved,
     etc.).

The following methods are called when data or markup elements are
encountered and they are meant to be overridden in a subclass.  The base
class implementations do nothing (except for *note handle_startendtag():
2918.):

 -- Method: HTMLParser.handle_starttag (tag, attrs)

     This method is called to handle the start of a tag (e.g.  ‘<div
     id="main">’).

     The `tag' argument is the name of the tag converted to lower case.
     The `attrs' argument is a list of ‘(name, value)’ pairs containing
     the attributes found inside the tag’s ‘<>’ brackets.  The `name'
     will be translated to lower case, and quotes in the `value' have
     been removed, and character and entity references have been
     replaced.

     For instance, for the tag ‘<A HREF="https://www.cwi.nl/">’, this
     method would be called as ‘handle_starttag('a', [('href',
     'https://www.cwi.nl/')])’.

     All entity references from *note html.entities: 91. are replaced in
     the attribute values.

 -- Method: HTMLParser.handle_endtag (tag)

     This method is called to handle the end tag of an element (e.g.
     ‘</div>’).

     The `tag' argument is the name of the tag converted to lower case.

 -- Method: HTMLParser.handle_startendtag (tag, attrs)

     Similar to *note handle_starttag(): 2919, but called when the
     parser encounters an XHTML-style empty tag (‘<img ... />’).  This
     method may be overridden by subclasses which require this
     particular lexical information; the default implementation simply
     calls *note handle_starttag(): 2919. and *note handle_endtag():
     291a.

 -- Method: HTMLParser.handle_data (data)

     This method is called to process arbitrary data (e.g.  text nodes
     and the content of ‘<script>...</script>’ and
     ‘<style>...</style>’).

 -- Method: HTMLParser.handle_entityref (name)

     This method is called to process a named character reference of the
     form ‘&name;’ (e.g.  ‘&gt;’), where `name' is a general entity
     reference (e.g.  ‘'gt'’).  This method is never called if
     `convert_charrefs' is ‘True’.

 -- Method: HTMLParser.handle_charref (name)

     This method is called to process decimal and hexadecimal numeric
     character references of the form ‘&#NNN;’ and ‘&#xNNN;’.  For
     example, the decimal equivalent for ‘&gt;’ is ‘&#62;’, whereas the
     hexadecimal is ‘&#x3E;’; in this case the method will receive
     ‘'62'’ or ‘'x3E'’.  This method is never called if
     `convert_charrefs' is ‘True’.

 -- Method: HTMLParser.handle_comment (data)

     This method is called when a comment is encountered (e.g.
     ‘<!--comment-->’).

     For example, the comment ‘<!-- comment -->’ will cause this method
     to be called with the argument ‘' comment '’.

     The content of Internet Explorer conditional comments (condcoms)
     will also be sent to this method, so, for ‘<!--[if IE
     9]>IE9-specific content<![endif]-->’, this method will receive
     ‘'[if IE 9]>IE9-specific content<![endif]'’.

 -- Method: HTMLParser.handle_decl (decl)

     This method is called to handle an HTML doctype declaration (e.g.
     ‘<!DOCTYPE html>’).

     The `decl' parameter will be the entire contents of the declaration
     inside the ‘<!...>’ markup (e.g.  ‘'DOCTYPE html'’).

 -- Method: HTMLParser.handle_pi (data)

     Method called when a processing instruction is encountered.  The
     `data' parameter will contain the entire processing instruction.
     For example, for the processing instruction ‘<?proc color='red'>’,
     this method would be called as ‘handle_pi("proc color='red'")’.  It
     is intended to be overridden by a derived class; the base class
     implementation does nothing.

          Note: The *note HTMLParser: 7b3. class uses the SGML syntactic
          rules for processing instructions.  An XHTML processing
          instruction using the trailing ‘'?'’ will cause the ‘'?'’ to
          be included in `data'.

 -- Method: HTMLParser.unknown_decl (data)

     This method is called when an unrecognized declaration is read by
     the parser.

     The `data' parameter will be the entire contents of the declaration
     inside the ‘<![...]>’ markup.  It is sometimes useful to be
     overridden by a derived class.  The base class implementation does
     nothing.


File: python.info,  Node: Examples<19>,  Prev: HTMLParser Methods,  Up: html parser — Simple HTML and XHTML parser

5.21.2.3 Examples
.................

The following class implements a parser that will be used to illustrate
more examples:

     from html.parser import HTMLParser from html.entities import name2codepoint  class MyHTMLParser(HTMLParser):     def handle_starttag(self, tag, attrs):         print("Start tag:", tag)         for attr in attrs:             print("     attr:", attr)      def handle_endtag(self, tag):         print("End tag  :", tag)      def handle_data(self, data):         print("Data     :", data)      def handle_comment(self, data):         print("Comment  :", data)      def handle_entityref(self, name):         c = chr(name2codepoint[name])         print("Named ent:", c)      def handle_charref(self, name):         if name.startswith('x'):             c = chr(int(name[1:], 16))         else:             c = chr(int(name))         print("Num ent  :", c)      def handle_decl(self, data):         print("Decl     :", data)  parser = MyHTMLParser()

Parsing a doctype:

     >>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" ' ...             '"http://www.w3.org/TR/html4/strict.dtd">') Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"

Parsing an element with a few attributes and a title:

     >>> parser.feed('<img src="python-logo.png" alt="The Python logo">') Start tag: img      attr: ('src', 'python-logo.png')      attr: ('alt', 'The Python logo') >>> >>> parser.feed('<h1>Python</h1>') Start tag: h1 Data     : Python End tag  : h1

The content of ‘script’ and ‘style’ elements is returned as is, without
further parsing:

     >>> parser.feed('<style type="text/css">#python { color: green }</style>') Start tag: style      attr: ('type', 'text/css') Data     : #python { color: green } End tag  : style  >>> parser.feed('<script type="text/javascript">' ...             'alert("<strong>hello!</strong>");</script>') Start tag: script      attr: ('type', 'text/javascript') Data     : alert("<strong>hello!</strong>"); End tag  : script

Parsing comments:

     >>> parser.feed('<!-- a comment -->' ...             '<!--[if IE 9]>IE-specific content<![endif]-->') Comment  :  a comment Comment  : [if IE 9]>IE-specific content<![endif]

Parsing named and numeric character references and converting them to
the correct char (note: these 3 references are all equivalent to ‘'>'’):

     >>> parser.feed('&gt;&#62;&#x3E;') Named ent: > Num ent  : > Num ent  : >

Feeding incomplete chunks to *note feed(): 2913. works, but *note
handle_data(): 291b. might be called more than once (unless
`convert_charrefs' is set to ‘True’):

     >>> for chunk in ['<sp', 'an>buff', 'ered ', 'text</s', 'pan>']: ...     parser.feed(chunk) ... Start tag: span Data     : buff Data     : ered Data     : text End tag  : span

Parsing invalid HTML (e.g.  unquoted attributes) also works:

     >>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>') Start tag: p Start tag: a      attr: ('class', 'link')      attr: ('href', '#main') Data     : tag soup End tag  : p End tag  : a


File: python.info,  Node: html entities — Definitions of HTML general entities,  Next: XML Processing Modules,  Prev: html parser — Simple HTML and XHTML parser,  Up: Structured Markup Processing Tools

5.21.3 ‘html.entities’ — Definitions of HTML general entities
-------------------------------------------------------------

`Source code:' Lib/html/entities.py(1)

__________________________________________________________________

This module defines four dictionaries, *note html5: a0a, *note
name2codepoint: 2926, *note codepoint2name: 2927, and *note entitydefs:
2928.

 -- Data: html.entities.html5

     A dictionary that maps HTML5 named character references (2) to the
     equivalent Unicode character(s), e.g.  ‘html5['gt;'] == '>'’.  Note
     that the trailing semicolon is included in the name (e.g.
     ‘'gt;'’), however some of the names are accepted by the standard
     even without the semicolon: in this case the name is present with
     and without the ‘';'’.  See also *note html.unescape(): 84e.

     New in version 3.3.

 -- Data: html.entities.entitydefs

     A dictionary mapping XHTML 1.0 entity definitions to their
     replacement text in ISO Latin-1.

 -- Data: html.entities.name2codepoint

     A dictionary that maps HTML entity names to the Unicode code
     points.

 -- Data: html.entities.codepoint2name

     A dictionary that maps Unicode code points to HTML entity names.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/html/entities.py

   (2) (1) See
‘https://www.w3.org/TR/html5/syntax.html#named-character-references’


File: python.info,  Node: XML Processing Modules,  Next: xml etree ElementTree — The ElementTree XML API,  Prev: html entities — Definitions of HTML general entities,  Up: Structured Markup Processing Tools

5.21.4 XML Processing Modules
-----------------------------

`Source code:' Lib/xml/(1)

__________________________________________________________________

Python’s interfaces for processing XML are grouped in the ‘xml’ package.

     Warning: The XML modules are not secure against erroneous or
     maliciously constructed data.  If you need to parse untrusted or
     unauthenticated data see the *note XML vulnerabilities: 292c. and
     *note The defusedxml and defusedexpat Packages: 292d. sections.

It is important to note that modules in the *note xml: 133. package
require that there be at least one SAX-compliant XML parser available.
The Expat parser is included with Python, so the *note
xml.parsers.expat: 138. module will always be available.

The documentation for the *note xml.dom: 134. and *note xml.sax: 13b.
packages are the definition of the Python bindings for the DOM and SAX
interfaces.

The XML handling submodules are:

   * *note xml.etree.ElementTree: 137.: the ElementTree API, a simple
     and lightweight XML processor

   * *note xml.dom: 134.: the DOM API definition

   * *note xml.dom.minidom: 135.: a minimal DOM implementation

   * *note xml.dom.pulldom: 136.: support for building partial DOM trees

   * *note xml.sax: 13b.: SAX2 base classes and convenience functions

   * *note xml.parsers.expat: 138.: the Expat parser binding

* Menu:

* XML vulnerabilities::
* The defusedxml and defusedexpat Packages::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/xml/


File: python.info,  Node: XML vulnerabilities,  Next: The defusedxml and defusedexpat Packages,  Up: XML Processing Modules

5.21.4.1 XML vulnerabilities
............................

The XML processing modules are not secure against maliciously
constructed data.  An attacker can abuse XML features to carry out
denial of service attacks, access local files, generate network
connections to other machines, or circumvent firewalls.

The following table gives an overview of the known attacks and whether
the various modules are vulnerable to them.

kind                          sax                etree               minidom            pulldom            xmlrpc
                                                                                                           
------------------------------------------------------------------------------------------------------------------------------
                                                                                                           
billion laughs                `Vulnerable'       `Vulnerable'        `Vulnerable'       `Vulnerable'       `Vulnerable'
                                                                                                           
                                                                                                           
quadratic blowup              `Vulnerable'       `Vulnerable'        `Vulnerable'       `Vulnerable'       `Vulnerable'
                                                                                                           
                                                                                                           
external entity expansion     Safe (4)           Safe (1)            Safe (2)           Safe (4)           Safe (3)
                                                                                                           
                                                                                                           
DTD(1) retrieval              Safe (4)           Safe                Safe               Safe (4)           Safe
                                                                                                           
                                                                                                           
decompression bomb            Safe               Safe                Safe               Safe               `Vulnerable'
                                                                                                           

  1. *note xml.etree.ElementTree: 137. doesn’t expand external entities
     and raises a ‘ParserError’ when an entity occurs.

  2. *note xml.dom.minidom: 135. doesn’t expand external entities and
     simply returns the unexpanded entity verbatim.

  3. ‘xmlrpclib’ doesn’t expand external entities and omits them.

  4. Since Python 3.7.1, external general entities are no longer
     processed by default.

billion laughs / exponential entity expansion

     The Billion Laughs(2) attack – also known as exponential entity
     expansion – uses multiple levels of nested entities.  Each entity
     refers to another entity several times, and the final entity
     definition contains a small string.  The exponential expansion
     results in several gigabytes of text and consumes lots of memory
     and CPU time.

quadratic blowup entity expansion

     A quadratic blowup attack is similar to a Billion Laughs(3) attack;
     it abuses entity expansion, too.  Instead of nested entities it
     repeats one large entity with a couple of thousand chars over and
     over again.  The attack isn’t as efficient as the exponential case
     but it avoids triggering parser countermeasures that forbid
     deeply-nested entities.

external entity expansion

     Entity declarations can contain more than just text for
     replacement.  They can also point to external resources or local
     files.  The XML parser accesses the resource and embeds the content
     into the XML document.

DTD(4) retrieval

     Some XML libraries like Python’s *note xml.dom.pulldom: 136.
     retrieve document type definitions from remote or local locations.
     The feature has similar implications as the external entity
     expansion issue.

decompression bomb

     Decompression bombs (aka ZIP bomb(5)) apply to all XML libraries
     that can parse compressed XML streams such as gzipped HTTP streams
     or LZMA-compressed files.  For an attacker it can reduce the amount
     of transmitted data by three magnitudes or more.

The documentation for defusedxml(6) on PyPI has further information
about all known attack vectors with examples and references.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Document_type_definition

   (2) https://en.wikipedia.org/wiki/Billion_laughs

   (3) https://en.wikipedia.org/wiki/Billion_laughs

   (4) https://en.wikipedia.org/wiki/Document_type_definition

   (5) https://en.wikipedia.org/wiki/Zip_bomb

   (6) https://pypi.org/project/defusedxml/


File: python.info,  Node: The defusedxml and defusedexpat Packages,  Prev: XML vulnerabilities,  Up: XML Processing Modules

5.21.4.2 The ‘defusedxml’ and ‘defusedexpat’ Packages
.....................................................

defusedxml(1) is a pure Python package with modified subclasses of all
stdlib XML parsers that prevent any potentially malicious operation.
Use of this package is recommended for any server code that parses
untrusted XML data.  The package also ships with example exploits and
extended documentation on more XML exploits such as XPath injection.

defusedexpat(2) provides a modified libexpat and a patched ‘pyexpat’
module that have countermeasures against entity expansion DoS attacks.
The ‘defusedexpat’ module still allows a sane and configurable amount of
entity expansions.  The modifications may be included in some future
release of Python, but will not be included in any bugfix releases of
Python because they break backward compatibility.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/defusedxml/

   (2) https://pypi.org/project/defusedexpat/


File: python.info,  Node: xml etree ElementTree — The ElementTree XML API,  Next: xml dom — The Document Object Model API,  Prev: XML Processing Modules,  Up: Structured Markup Processing Tools

5.21.5 ‘xml.etree.ElementTree’ — The ElementTree XML API
--------------------------------------------------------

`Source code:' Lib/xml/etree/ElementTree.py(1)

__________________________________________________________________

The *note xml.etree.ElementTree: 137. module implements a simple and
efficient API for parsing and creating XML data.

Changed in version 3.3: This module will use a fast implementation
whenever available.  The ‘xml.etree.cElementTree’ module is deprecated.

     Warning: The *note xml.etree.ElementTree: 137. module is not secure
     against maliciously constructed data.  If you need to parse
     untrusted or unauthenticated data see *note XML vulnerabilities:
     292c.

* Menu:

* Tutorial::
* XPath support::
* Reference: Reference<2>.
* XInclude support::
* Reference: Reference<3>.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/xml/etree/ElementTree.py


File: python.info,  Node: Tutorial,  Next: XPath support,  Up: xml etree ElementTree — The ElementTree XML API

5.21.5.1 Tutorial
.................

This is a short tutorial for using *note xml.etree.ElementTree: 137.
(‘ET’ in short).  The goal is to demonstrate some of the building blocks
and basic concepts of the module.

* Menu:

* XML tree and elements::
* Parsing XML::
* Pull API for non-blocking parsing::
* Finding interesting elements::
* Modifying an XML File::
* Building XML documents::
* Parsing XML with Namespaces::
* Additional resources::


File: python.info,  Node: XML tree and elements,  Next: Parsing XML,  Up: Tutorial

5.21.5.2 XML tree and elements
..............................

XML is an inherently hierarchical data format, and the most natural way
to represent it is with a tree.  ‘ET’ has two classes for this purpose -
*note ElementTree: 90b. represents the whole XML document as a tree, and
*note Element: ab9. represents a single node in this tree.  Interactions
with the whole document (reading and writing to/from files) are usually
done on the *note ElementTree: 90b. level.  Interactions with a single
XML element and its sub-elements are done on the *note Element: ab9.
level.


File: python.info,  Node: Parsing XML,  Next: Pull API for non-blocking parsing,  Prev: XML tree and elements,  Up: Tutorial

5.21.5.3 Parsing XML
....................

We’ll be using the following XML document as the sample data for this
section:

     <?xml version="1.0"?> <data>     <country name="Liechtenstein">         <rank>1</rank>         <year>2008</year>         <gdppc>141100</gdppc>         <neighbor name="Austria" direction="E"/>         <neighbor name="Switzerland" direction="W"/>     </country>     <country name="Singapore">         <rank>4</rank>         <year>2011</year>         <gdppc>59900</gdppc>         <neighbor name="Malaysia" direction="N"/>     </country>     <country name="Panama">         <rank>68</rank>         <year>2011</year>         <gdppc>13600</gdppc>         <neighbor name="Costa Rica" direction="W"/>         <neighbor name="Colombia" direction="E"/>     </country> </data>

We can import this data by reading from a file:

     import xml.etree.ElementTree as ET tree = ET.parse('country_data.xml') root = tree.getroot()

Or directly from a string:

     root = ET.fromstring(country_data_as_string)

*note fromstring(): 2937. parses XML from a string directly into an
*note Element: ab9, which is the root element of the parsed tree.  Other
parsing functions may create an *note ElementTree: 90b.  Check the
documentation to be sure.

As an *note Element: ab9, ‘root’ has a tag and a dictionary of
attributes:

     >>> root.tag 'data' >>> root.attrib {}

It also has children nodes over which we can iterate:

     >>> for child in root: ...     print(child.tag, child.attrib) ... country {'name': 'Liechtenstein'} country {'name': 'Singapore'} country {'name': 'Panama'}

Children are nested, and we can access specific child nodes by index:

     >>> root[0][1].text '2008'

     Note: Not all elements of the XML input will end up as elements of
     the parsed tree.  Currently, this module skips over any XML
     comments, processing instructions, and document type declarations
     in the input.  Nevertheless, trees built using this module’s API
     rather than parsing from XML text can have comments and processing
     instructions in them; they will be included when generating XML
     output.  A document type declaration may be accessed by passing a
     custom *note TreeBuilder: 251. instance to the *note XMLParser:
     250. constructor.


File: python.info,  Node: Pull API for non-blocking parsing,  Next: Finding interesting elements,  Prev: Parsing XML,  Up: Tutorial

5.21.5.4 Pull API for non-blocking parsing
..........................................

Most parsing functions provided by this module require the whole
document to be read at once before returning any result.  It is possible
to use an *note XMLParser: 250. and feed data into it incrementally, but
it is a push API that calls methods on a callback target, which is too
low-level and inconvenient for most needs.  Sometimes what the user
really wants is to be able to parse XML incrementally, without blocking
operations, while enjoying the convenience of fully constructed *note
Element: ab9. objects.

The most powerful tool for doing this is *note XMLPullParser: 907.  It
does not require a blocking read to obtain the XML data, and is instead
fed with data incrementally with *note XMLPullParser.feed(): 2939.
calls.  To get the parsed XML elements, call *note
XMLPullParser.read_events(): 293a.  Here is an example:

     >>> parser = ET.XMLPullParser(['start', 'end']) >>> parser.feed('<mytag>sometext') >>> list(parser.read_events()) [('start', <Element 'mytag' at 0x7fa66db2be58>)] >>> parser.feed(' more text</mytag>') >>> for event, elem in parser.read_events(): ...     print(event) ...     print(elem.tag, 'text=', elem.text) ... end

The obvious use case is applications that operate in a non-blocking
fashion where the XML data is being received from a socket or read
incrementally from some storage device.  In such cases, blocking reads
are unacceptable.

Because it’s so flexible, *note XMLPullParser: 907. can be inconvenient
to use for simpler use-cases.  If you don’t mind your application
blocking on reading XML data but would still like to have incremental
parsing capabilities, take a look at *note iterparse(): 93c.  It can be
useful when you’re reading a large XML document and don’t want to hold
it wholly in memory.


File: python.info,  Node: Finding interesting elements,  Next: Modifying an XML File,  Prev: Pull API for non-blocking parsing,  Up: Tutorial

5.21.5.5 Finding interesting elements
.....................................

*note Element: ab9. has some useful methods that help iterate
recursively over all the sub-tree below it (its children, their
children, and so on).  For example, *note Element.iter(): cda.:

     >>> for neighbor in root.iter('neighbor'): ...     print(neighbor.attrib) ... {'name': 'Austria', 'direction': 'E'} {'name': 'Switzerland', 'direction': 'W'} {'name': 'Malaysia', 'direction': 'N'} {'name': 'Costa Rica', 'direction': 'W'} {'name': 'Colombia', 'direction': 'E'}

*note Element.findall(): 293c. finds only elements with a tag which are
direct children of the current element.  *note Element.find(): 293d.
finds the `first' child with a particular tag, and *note Element.text:
293e. accesses the element’s text content.  *note Element.get(): 293f.
accesses the element’s attributes:

     >>> for country in root.findall('country'): ...     rank = country.find('rank').text ...     name = country.get('name') ...     print(name, rank) ... Liechtenstein 1 Singapore 4 Panama 68

More sophisticated specification of which elements to look for is
possible by using *note XPath: 40f.


File: python.info,  Node: Modifying an XML File,  Next: Building XML documents,  Prev: Finding interesting elements,  Up: Tutorial

5.21.5.6 Modifying an XML File
..............................

*note ElementTree: 90b. provides a simple way to build XML documents and
write them to files.  The *note ElementTree.write(): 90c. method serves
this purpose.

Once created, an *note Element: ab9. object may be manipulated by
directly changing its fields (such as *note Element.text: 293e.), adding
and modifying attributes (*note Element.set(): 2941. method), as well as
adding new children (for example with *note Element.append(): 2942.).

Let’s say we want to add one to each country’s rank, and add an
‘updated’ attribute to the rank element:

     >>> for rank in root.iter('rank'): ...     new_rank = int(rank.text) + 1 ...     rank.text = str(new_rank) ...     rank.set('updated', 'yes') ... >>> tree.write('output.xml')

Our XML now looks like this:

     <?xml version="1.0"?> <data>     <country name="Liechtenstein">         <rank updated="yes">2</rank>         <year>2008</year>         <gdppc>141100</gdppc>         <neighbor name="Austria" direction="E"/>         <neighbor name="Switzerland" direction="W"/>     </country>     <country name="Singapore">         <rank updated="yes">5</rank>         <year>2011</year>         <gdppc>59900</gdppc>         <neighbor name="Malaysia" direction="N"/>     </country>     <country name="Panama">         <rank updated="yes">69</rank>         <year>2011</year>         <gdppc>13600</gdppc>         <neighbor name="Costa Rica" direction="W"/>         <neighbor name="Colombia" direction="E"/>     </country> </data>

We can remove elements using *note Element.remove(): 2943.  Let’s say we
want to remove all countries with a rank higher than 50:

     >>> for country in root.findall('country'): ...     rank = int(country.find('rank').text) ...     if rank > 50: ...         root.remove(country) ... >>> tree.write('output.xml')

Our XML now looks like this:

     <?xml version="1.0"?> <data>     <country name="Liechtenstein">         <rank updated="yes">2</rank>         <year>2008</year>         <gdppc>141100</gdppc>         <neighbor name="Austria" direction="E"/>         <neighbor name="Switzerland" direction="W"/>     </country>     <country name="Singapore">         <rank updated="yes">5</rank>         <year>2011</year>         <gdppc>59900</gdppc>         <neighbor name="Malaysia" direction="N"/>     </country> </data>


File: python.info,  Node: Building XML documents,  Next: Parsing XML with Namespaces,  Prev: Modifying an XML File,  Up: Tutorial

5.21.5.7 Building XML documents
...............................

The *note SubElement(): 2945. function also provides a convenient way to
create new sub-elements for a given element:

     >>> a = ET.Element('a') >>> b = ET.SubElement(a, 'b') >>> c = ET.SubElement(a, 'c') >>> d = ET.SubElement(c, 'd') >>> ET.dump(a) <a><b /><c><d /></c></a>


File: python.info,  Node: Parsing XML with Namespaces,  Next: Additional resources,  Prev: Building XML documents,  Up: Tutorial

5.21.5.8 Parsing XML with Namespaces
....................................

If the XML input has namespaces(1), tags and attributes with prefixes in
the form ‘prefix:sometag’ get expanded to ‘{uri}sometag’ where the
`prefix' is replaced by the full `URI'. Also, if there is a default
namespace(2), that full URI gets prepended to all of the non-prefixed
tags.

Here is an XML example that incorporates two namespaces, one with the
prefix “fictional” and the other serving as the default namespace:

     <?xml version="1.0"?> <actors xmlns:fictional="http://characters.example.com"         xmlns="http://people.example.com">     <actor>         <name>John Cleese</name>         <fictional:character>Lancelot</fictional:character>         <fictional:character>Archie Leach</fictional:character>     </actor>     <actor>         <name>Eric Idle</name>         <fictional:character>Sir Robin</fictional:character>         <fictional:character>Gunther</fictional:character>         <fictional:character>Commander Clement</fictional:character>     </actor> </actors>

One way to search and explore this XML example is to manually add the
URI to every tag or attribute in the xpath of a *note find(): 293d. or
*note findall(): 293c.:

     root = fromstring(xml_text) for actor in root.findall('{http://people.example.com}actor'):     name = actor.find('{http://people.example.com}name')     print(name.text)     for char in actor.findall('{http://characters.example.com}character'):         print(' |-->', char.text)

A better way to search the namespaced XML example is to create a
dictionary with your own prefixes and use those in the search functions:

     ns = {'real_person': 'http://people.example.com',       'role': 'http://characters.example.com'}  for actor in root.findall('real_person:actor', ns):     name = actor.find('real_person:name', ns)     print(name.text)     for char in actor.findall('role:character', ns):         print(' |-->', char.text)

These two approaches both output:

     John Cleese  |--> Lancelot  |--> Archie Leach Eric Idle  |--> Sir Robin  |--> Gunther  |--> Commander Clement

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/XML_namespace

   (2) https://www.w3.org/TR/xml-names/#defaulting


File: python.info,  Node: Additional resources,  Prev: Parsing XML with Namespaces,  Up: Tutorial

5.21.5.9 Additional resources
.............................

See ‘http://effbot.org/zone/element-index.htm’ for tutorials and links
to other docs.


File: python.info,  Node: XPath support,  Next: Reference<2>,  Prev: Tutorial,  Up: xml etree ElementTree — The ElementTree XML API

5.21.5.10 XPath support
.......................

This module provides limited support for XPath expressions(1) for
locating elements in a tree.  The goal is to support a small subset of
the abbreviated syntax; a full XPath engine is outside the scope of the
module.

* Menu:

* Example: Example<10>.
* Supported XPath syntax::

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/xpath


File: python.info,  Node: Example<10>,  Next: Supported XPath syntax,  Up: XPath support

5.21.5.11 Example
.................

Here’s an example that demonstrates some of the XPath capabilities of
the module.  We’ll be using the ‘countrydata’ XML document from the
*note Parsing XML: 2935. section:

     import xml.etree.ElementTree as ET  root = ET.fromstring(countrydata)  # Top-level elements root.findall(".")  # All 'neighbor' grand-children of 'country' children of the top-level # elements root.findall("./country/neighbor")  # Nodes with name='Singapore' that have a 'year' child root.findall(".//year/..[@name='Singapore']")  # 'year' nodes that are children of nodes with name='Singapore' root.findall(".//*[@name='Singapore']/year")  # All 'neighbor' nodes that are the second child of their parent root.findall(".//neighbor[2]")

For XML with namespaces, use the usual qualified ‘{namespace}tag’
notation:

     # All dublin-core "title" tags in the document root.findall(".//{http://purl.org/dc/elements/1.1/}title")


File: python.info,  Node: Supported XPath syntax,  Prev: Example<10>,  Up: XPath support

5.21.5.12 Supported XPath syntax
................................

Syntax                      Meaning
                            
---------------------------------------------------------------------------------------
                            
‘tag’                       Selects all child elements with the given tag.  For
                            example, ‘spam’ selects all child elements named ‘spam’,
                            and ‘spam/egg’ selects all grandchildren named ‘egg’ in
                            all children named ‘spam’.  ‘{namespace}*’ selects all
                            tags in the given namespace, ‘{*}spam’ selects tags
                            named ‘spam’ in any (or no) namespace, and ‘{}*’ only
                            selects tags that are not in a namespace.
                            
                            Changed in version 3.8: Support for star-wildcards was
                            added.
                            
                            
‘*’                         Selects all child elements, including comments and
                            processing instructions.  For example, ‘*/egg’ selects
                            all grandchildren named ‘egg’.
                            
                            
‘.’                         Selects the current node.  This is mostly useful at the
                            beginning of the path, to indicate that it’s a relative
                            path.
                            
                            
‘//’                        Selects all subelements, on all levels beneath the
                            current element.  For example, ‘.//egg’ selects all
                            ‘egg’ elements in the entire tree.
                            
                            
‘..’                        Selects the parent element.  Returns ‘None’ if the path
                            attempts to reach the ancestors of the start element
                            (the element ‘find’ was called on).
                            
                            
‘[@attrib]’                 Selects all elements that have the given attribute.
                            
                            
‘[@attrib='value']’         Selects all elements for which the given attribute has
                            the given value.  The value cannot contain quotes.
                            
                            
‘[tag]’                     Selects all elements that have a child named ‘tag’.
                            Only immediate children are supported.
                            
                            
‘[.='text']’                Selects all elements whose complete text content,
                            including descendants, equals the given ‘text’.
                            
                            New in version 3.7.
                            
                            
‘[tag='text']’              Selects all elements that have a child named ‘tag’ whose
                            complete text content, including descendants, equals the
                            given ‘text’.
                            
                            
‘[position]’                Selects all elements that are located at the given
                            position.  The position can be either an integer (1 is
                            the first position), the expression ‘last()’ (for the
                            last position), or a position relative to the last
                            position (e.g.  ‘last()-1’).
                            

Predicates (expressions within square brackets) must be preceded by a
tag name, an asterisk, or another predicate.  ‘position’ predicates must
be preceded by a tag name.


File: python.info,  Node: Reference<2>,  Next: XInclude support,  Prev: XPath support,  Up: xml etree ElementTree — The ElementTree XML API

5.21.5.13 Reference
...................

* Menu:

* Functions: Functions<6>.


File: python.info,  Node: Functions<6>,  Up: Reference<2>

5.21.5.14 Functions
...................

 -- Function: xml.etree.ElementTree.canonicalize (xml_data=None, *,
          out=None, from_file=None, **options)

     C14N 2.0(1) transformation function.

     Canonicalization is a way to normalise XML output in a way that
     allows byte-by-byte comparisons and digital signatures.  It reduced
     the freedom that XML serializers have and instead generates a more
     constrained XML representation.  The main restrictions regard the
     placement of namespace declarations, the ordering of attributes,
     and ignorable whitespace.

     This function takes an XML data string (`xml_data') or a file path
     or file-like object (`from_file') as input, converts it to the
     canonical form, and writes it out using the `out' file(-like)
     object, if provided, or returns it as a text string if not.  The
     output file receives text, not bytes.  It should therefore be
     opened in text mode with ‘utf-8’ encoding.

     Typical uses:

          xml_data = "<root>...</root>" print(canonicalize(xml_data))  with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:     canonicalize(xml_data, out=out_file)  with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:     canonicalize(from_file="inputfile.xml", out=out_file)

     The configuration `options' are as follows:

        - `with_comments': set to true to include comments (default:
          false)

        - 
          `strip_text': set to true to strip whitespace before and after text content

               (default: false)

        - 
          `rewrite_prefixes': set to true to replace namespace prefixes by “n{number}”

               (default: false)

        - 
          `qname_aware_tags': a set of qname aware tag names in which prefixes

               should be replaced in text content (default: empty)

        - 
          `qname_aware_attrs': a set of qname aware attribute names in which prefixes

               should be replaced in text content (default: empty)

        - `exclude_attrs': a set of attribute names that should not be
          serialised

        - `exclude_tags': a set of tag names that should not be
          serialised

     In the option list above, “a set” refers to any collection or
     iterable of strings, no ordering is expected.

     New in version 3.8.

 -- Function: xml.etree.ElementTree.Comment (text=None)

     Comment element factory.  This factory function creates a special
     element that will be serialized as an XML comment by the standard
     serializer.  The comment string can be either a bytestring or a
     Unicode string.  `text' is a string containing the comment string.
     Returns an element instance representing a comment.

     Note that *note XMLParser: 250. skips over comments in the input
     instead of creating comment objects for them.  An *note
     ElementTree: 90b. will only contain comment nodes if they have been
     inserted into to the tree using one of the *note Element: ab9.
     methods.

 -- Function: xml.etree.ElementTree.dump (elem)

     Writes an element tree or element structure to sys.stdout.  This
     function should be used for debugging only.

     The exact output format is implementation dependent.  In this
     version, it’s written as an ordinary XML file.

     `elem' is an element tree or an individual element.

     Changed in version 3.8: The *note dump(): 2950. function now
     preserves the attribute order specified by the user.

 -- Function: xml.etree.ElementTree.fromstring (text, parser=None)

     Parses an XML section from a string constant.  Same as *note XML():
     2951.  `text' is a string containing XML data.  `parser' is an
     optional parser instance.  If not given, the standard *note
     XMLParser: 250. parser is used.  Returns an *note Element: ab9.
     instance.

 -- Function: xml.etree.ElementTree.fromstringlist (sequence,
          parser=None)

     Parses an XML document from a sequence of string fragments.
     `sequence' is a list or other sequence containing XML data
     fragments.  `parser' is an optional parser instance.  If not given,
     the standard *note XMLParser: 250. parser is used.  Returns an
     *note Element: ab9. instance.

     New in version 3.2.

 -- Function: xml.etree.ElementTree.iselement (element)

     Check if an object appears to be a valid element object.  `element'
     is an element instance.  Return ‘True’ if this is an element
     object.

 -- Function: xml.etree.ElementTree.iterparse (source, events=None,
          parser=None)

     Parses an XML section into an element tree incrementally, and
     reports what’s going on to the user.  `source' is a filename or
     *note file object: b35. containing XML data.  `events' is a
     sequence of events to report back.  The supported events are the
     strings ‘"start"’, ‘"end"’, ‘"comment"’, ‘"pi"’, ‘"start-ns"’ and
     ‘"end-ns"’ (the “ns” events are used to get detailed namespace
     information).  If `events' is omitted, only ‘"end"’ events are
     reported.  `parser' is an optional parser instance.  If not given,
     the standard *note XMLParser: 250. parser is used.  `parser' must
     be a subclass of *note XMLParser: 250. and can only use the default
     *note TreeBuilder: 251. as a target.  Returns an *note iterator:
     f73. providing ‘(event, elem)’ pairs.

     Note that while *note iterparse(): 93c. builds the tree
     incrementally, it issues blocking reads on `source' (or the file it
     names).  As such, it’s unsuitable for applications where blocking
     reads can’t be made.  For fully non-blocking parsing, see *note
     XMLPullParser: 907.

          Note: *note iterparse(): 93c. only guarantees that it has seen
          the “>” character of a starting tag when it emits a “start”
          event, so the attributes are defined, but the contents of the
          text and tail attributes are undefined at that point.  The
          same applies to the element children; they may or may not be
          present.

          If you need a fully populated element, look for “end” events
          instead.

     Deprecated since version 3.4: The `parser' argument.

     Changed in version 3.8: The ‘comment’ and ‘pi’ events were added.

 -- Function: xml.etree.ElementTree.parse (source, parser=None)

     Parses an XML section into an element tree.  `source' is a filename
     or file object containing XML data.  `parser' is an optional parser
     instance.  If not given, the standard *note XMLParser: 250. parser
     is used.  Returns an *note ElementTree: 90b. instance.

 -- Function: xml.etree.ElementTree.ProcessingInstruction (target,
          text=None)

     PI element factory.  This factory function creates a special
     element that will be serialized as an XML processing instruction.
     `target' is a string containing the PI target.  `text' is a string
     containing the PI contents, if given.  Returns an element instance,
     representing a processing instruction.

     Note that *note XMLParser: 250. skips over processing instructions
     in the input instead of creating comment objects for them.  An
     *note ElementTree: 90b. will only contain processing instruction
     nodes if they have been inserted into to the tree using one of the
     *note Element: ab9. methods.

 -- Function: xml.etree.ElementTree.register_namespace (prefix, uri)

     Registers a namespace prefix.  The registry is global, and any
     existing mapping for either the given prefix or the namespace URI
     will be removed.  `prefix' is a namespace prefix.  `uri' is a
     namespace uri.  Tags and attributes in this namespace will be
     serialized with the given prefix, if at all possible.

     New in version 3.2.

 -- Function: xml.etree.ElementTree.SubElement (parent, tag, attrib={},
          **extra)

     Subelement factory.  This function creates an element instance, and
     appends it to an existing element.

     The element name, attribute names, and attribute values can be
     either bytestrings or Unicode strings.  `parent' is the parent
     element.  `tag' is the subelement name.  `attrib' is an optional
     dictionary, containing element attributes.  `extra' contains
     additional attributes, given as keyword arguments.  Returns an
     element instance.

 -- Function: xml.etree.ElementTree.tostring (element,
          encoding="us-ascii", method="xml", *, xml_declaration=None,
          default_namespace=None, short_empty_elements=True)

     Generates a string representation of an XML element, including all
     subelements.  `element' is an *note Element: ab9. instance.
     `encoding' (2) is the output encoding (default is US-ASCII). Use
     ‘encoding="unicode"’ to generate a Unicode string (otherwise, a
     bytestring is generated).  `method' is either ‘"xml"’, ‘"html"’ or
     ‘"text"’ (default is ‘"xml"’).  `xml_declaration',
     `default_namespace' and `short_empty_elements' has the same meaning
     as in *note ElementTree.write(): 90c.  Returns an (optionally)
     encoded string containing the XML data.

     New in version 3.4: The `short_empty_elements' parameter.

     New in version 3.8: The `xml_declaration' and `default_namespace'
     parameters.

     Changed in version 3.8: The *note tostring(): 909. function now
     preserves the attribute order specified by the user.

 -- Function: xml.etree.ElementTree.tostringlist (element,
          encoding="us-ascii", method="xml", *, xml_declaration=None,
          default_namespace=None, short_empty_elements=True)

     Generates a string representation of an XML element, including all
     subelements.  `element' is an *note Element: ab9. instance.
     `encoding' (3) is the output encoding (default is US-ASCII). Use
     ‘encoding="unicode"’ to generate a Unicode string (otherwise, a
     bytestring is generated).  `method' is either ‘"xml"’, ‘"html"’ or
     ‘"text"’ (default is ‘"xml"’).  `xml_declaration',
     `default_namespace' and `short_empty_elements' has the same meaning
     as in *note ElementTree.write(): 90c.  Returns a list of
     (optionally) encoded strings containing the XML data.  It does not
     guarantee any specific sequence, except that
     ‘b"".join(tostringlist(element)) == tostring(element)’.

     New in version 3.2.

     New in version 3.4: The `short_empty_elements' parameter.

     New in version 3.8: The `xml_declaration' and `default_namespace'
     parameters.

     Changed in version 3.8: The *note tostringlist(): 90a. function now
     preserves the attribute order specified by the user.

 -- Function: xml.etree.ElementTree.XML (text, parser=None)

     Parses an XML section from a string constant.  This function can be
     used to embed “XML literals” in Python code.  `text' is a string
     containing XML data.  `parser' is an optional parser instance.  If
     not given, the standard *note XMLParser: 250. parser is used.
     Returns an *note Element: ab9. instance.

 -- Function: xml.etree.ElementTree.XMLID (text, parser=None)

     Parses an XML section from a string constant, and also returns a
     dictionary which maps from element id:s to elements.  `text' is a
     string containing XML data.  `parser' is an optional parser
     instance.  If not given, the standard *note XMLParser: 250. parser
     is used.  Returns a tuple containing an *note Element: ab9.
     instance and a dictionary.

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/xml-c14n2/

   (2) (1) The encoding string included in XML output should conform to
the appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See
‘https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl’ and
‘https://www.iana.org/assignments/character-sets/character-sets.xhtml’.

   (3) (1) The encoding string included in XML output should conform to
the appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See
‘https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl’ and
‘https://www.iana.org/assignments/character-sets/character-sets.xhtml’.


File: python.info,  Node: XInclude support,  Next: Reference<3>,  Prev: Reference<2>,  Up: xml etree ElementTree — The ElementTree XML API

5.21.5.15 XInclude support
..........................

This module provides limited support for XInclude directives(1), via the
‘xml.etree.ElementInclude’ helper module.  This module can be used to
insert subtrees and text strings into element trees, based on
information in the tree.

* Menu:

* Example: Example<11>.

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/xinclude/


File: python.info,  Node: Example<11>,  Up: XInclude support

5.21.5.16 Example
.................

Here’s an example that demonstrates use of the XInclude module.  To
include an XML document in the current document, use the
‘{http://www.w3.org/2001/XInclude}include’ element and set the `parse'
attribute to ‘"xml"’, and use the `href' attribute to specify the
document to include.

     <?xml version="1.0"?> <document xmlns:xi="http://www.w3.org/2001/XInclude">   <xi:include href="source.xml" parse="xml" /> </document>

By default, the `href' attribute is treated as a file name.  You can use
custom loaders to override this behaviour.  Also note that the standard
helper does not support XPointer syntax.

To process this file, load it as usual, and pass the root element to the
*note xml.etree.ElementTree: 137. module:

     from xml.etree import ElementTree, ElementInclude  tree = ElementTree.parse("document.xml") root = tree.getroot()  ElementInclude.include(root)

The ElementInclude module replaces the
‘{http://www.w3.org/2001/XInclude}include’ element with the root element
from the `source.xml' document.  The result might look something like
this:

     <document xmlns:xi="http://www.w3.org/2001/XInclude">   <para>This is a paragraph.</para> </document>

If the `parse' attribute is omitted, it defaults to “xml”.  The href
attribute is required.

To include a text document, use the
‘{http://www.w3.org/2001/XInclude}include’ element, and set the `parse'
attribute to “text”:

     <?xml version="1.0"?> <document xmlns:xi="http://www.w3.org/2001/XInclude">   Copyright (c) <xi:include href="year.txt" parse="text" />. </document>

The result might look something like:

     <document xmlns:xi="http://www.w3.org/2001/XInclude">   Copyright (c) 2003. </document>


File: python.info,  Node: Reference<3>,  Prev: XInclude support,  Up: xml etree ElementTree — The ElementTree XML API

5.21.5.17 Reference
...................

* Menu:

* Functions: Functions<7>.
* Element Objects::
* ElementTree Objects::
* QName Objects::
* TreeBuilder Objects::
* XMLParser Objects::
* XMLPullParser Objects::
* Exceptions: Exceptions<15>.


File: python.info,  Node: Functions<7>,  Next: Element Objects,  Up: Reference<3>

5.21.5.18 Functions
...................

 -- Function: xml.etree.ElementInclude.default_loader (href, parse,
          encoding=None)

     Default loader.  This default loader reads an included resource
     from disk.  `href' is a URL. `parse' is for parse mode either “xml”
     or “text”.  `encoding' is an optional text encoding.  If not given,
     encoding is ‘utf-8’.  Returns the expanded resource.  If the parse
     mode is ‘"xml"’, this is an ElementTree instance.  If the parse
     mode is “text”, this is a Unicode string.  If the loader fails, it
     can return None or raise an exception.

 -- Function: xml.etree.ElementInclude.include (elem, loader=None)

     This function expands XInclude directives.  `elem' is the root
     element.  `loader' is an optional resource loader.  If omitted, it
     defaults to *note default_loader(): 295c.  If given, it should be a
     callable that implements the same interface as *note
     default_loader(): 295c.  Returns the expanded resource.  If the
     parse mode is ‘"xml"’, this is an ElementTree instance.  If the
     parse mode is “text”, this is a Unicode string.  If the loader
     fails, it can return None or raise an exception.


File: python.info,  Node: Element Objects,  Next: ElementTree Objects,  Prev: Functions<7>,  Up: Reference<3>

5.21.5.19 Element Objects
.........................

 -- Class: xml.etree.ElementTree.Element (tag, attrib={}, **extra)

     Element class.  This class defines the Element interface, and
     provides a reference implementation of this interface.

     The element name, attribute names, and attribute values can be
     either bytestrings or Unicode strings.  `tag' is the element name.
     `attrib' is an optional dictionary, containing element attributes.
     `extra' contains additional attributes, given as keyword arguments.

      -- Attribute: tag

          A string identifying what kind of data this element represents
          (the element type, in other words).

      -- Attribute: text
      -- Attribute: tail

          These attributes can be used to hold additional data
          associated with the element.  Their values are usually strings
          but may be any application-specific object.  If the element is
          created from an XML file, the `text' attribute holds either
          the text between the element’s start tag and its first child
          or end tag, or ‘None’, and the `tail' attribute holds either
          the text between the element’s end tag and the next tag, or
          ‘None’.  For the XML data

               <a><b>1<c>2<d/>3</c></b>4</a>

          the `a' element has ‘None’ for both `text' and `tail'
          attributes, the `b' element has `text' ‘"1"’ and `tail' ‘"4"’,
          the `c' element has `text' ‘"2"’ and `tail' ‘None’, and the
          `d' element has `text' ‘None’ and `tail' ‘"3"’.

          To collect the inner text of an element, see *note itertext():
          b46, for example ‘"".join(element.itertext())’.

          Applications may store arbitrary objects in these attributes.

      -- Attribute: attrib

          A dictionary containing the element’s attributes.  Note that
          while the `attrib' value is always a real mutable Python
          dictionary, an ElementTree implementation may choose to use
          another internal representation, and create the dictionary
          only if someone asks for it.  To take advantage of such
          implementations, use the dictionary methods below whenever
          possible.

     The following dictionary-like methods work on the element
     attributes.

      -- Method: clear ()

          Resets an element.  This function removes all subelements,
          clears all attributes, and sets the text and tail attributes
          to ‘None’.

      -- Method: get (key, default=None)

          Gets the element attribute named `key'.

          Returns the attribute value, or `default' if the attribute was
          not found.

      -- Method: items ()

          Returns the element attributes as a sequence of (name, value)
          pairs.  The attributes are returned in an arbitrary order.

      -- Method: keys ()

          Returns the elements attribute names as a list.  The names are
          returned in an arbitrary order.

      -- Method: set (key, value)

          Set the attribute `key' on the element to `value'.

     The following methods work on the element’s children (subelements).

      -- Method: append (subelement)

          Adds the element `subelement' to the end of this element’s
          internal list of subelements.  Raises *note TypeError: 192. if
          `subelement' is not an *note Element: ab9.

      -- Method: extend (subelements)

          Appends `subelements' from a sequence object with zero or more
          elements.  Raises *note TypeError: 192. if a subelement is not
          an *note Element: ab9.

          New in version 3.2.

      -- Method: find (match, namespaces=None)

          Finds the first subelement matching `match'.  `match' may be a
          tag name or a *note path: 40f.  Returns an element instance or
          ‘None’.  `namespaces' is an optional mapping from namespace
          prefix to full name.  Pass ‘''’ as prefix to move all
          unprefixed tag names in the expression into the given
          namespace.

      -- Method: findall (match, namespaces=None)

          Finds all matching subelements, by tag name or *note path:
          40f.  Returns a list containing all matching elements in
          document order.  `namespaces' is an optional mapping from
          namespace prefix to full name.  Pass ‘''’ as prefix to move
          all unprefixed tag names in the expression into the given
          namespace.

      -- Method: findtext (match, default=None, namespaces=None)

          Finds text for the first subelement matching `match'.  `match'
          may be a tag name or a *note path: 40f.  Returns the text
          content of the first matching element, or `default' if no
          element was found.  Note that if the matching element has no
          text content an empty string is returned.  `namespaces' is an
          optional mapping from namespace prefix to full name.  Pass
          ‘''’ as prefix to move all unprefixed tag names in the
          expression into the given namespace.

      -- Method: getchildren ()

          Deprecated since version 3.2, will be removed in version 3.9:
          Use ‘list(elem)’ or iteration.

      -- Method: getiterator (tag=None)

          Deprecated since version 3.2, will be removed in version 3.9:
          Use method *note Element.iter(): cda. instead.

      -- Method: insert (index, subelement)

          Inserts `subelement' at the given position in this element.
          Raises *note TypeError: 192. if `subelement' is not an *note
          Element: ab9.

      -- Method: iter (tag=None)

          Creates a tree *note iterator: f73. with the current element
          as the root.  The iterator iterates over this element and all
          elements below it, in document (depth first) order.  If `tag'
          is not ‘None’ or ‘'*'’, only elements whose tag equals `tag'
          are returned from the iterator.  If the tree structure is
          modified during iteration, the result is undefined.

          New in version 3.2.

      -- Method: iterfind (match, namespaces=None)

          Finds all matching subelements, by tag name or *note path:
          40f.  Returns an iterable yielding all matching elements in
          document order.  `namespaces' is an optional mapping from
          namespace prefix to full name.

          New in version 3.2.

      -- Method: itertext ()

          Creates a text iterator.  The iterator loops over this element
          and all subelements, in document order, and returns all inner
          text.

          New in version 3.2.

      -- Method: makeelement (tag, attrib)

          Creates a new element object of the same type as this element.
          Do not call this method, use the *note SubElement(): 2945.
          factory function instead.

      -- Method: remove (subelement)

          Removes `subelement' from the element.  Unlike the find*
          methods this method compares elements based on the instance
          identity, not on tag value or contents.

     *note Element: ab9. objects also support the following sequence
     type methods for working with subelements: *note __delitem__():
     c56, *note __getitem__(): 27a, *note __setitem__(): c55, *note
     __len__(): dbe.

     Caution: Elements with no subelements will test as ‘False’.  This
     behavior will change in future versions.  Use specific ‘len(elem)’
     or ‘elem is None’ test instead.

          element = root.find('foo')  if not element:  # careful!     print("element not found, or element has no subelements")  if element is None:     print("element not found")

     Prior to Python 3.8, the serialisation order of the XML attributes
     of elements was artificially made predictable by sorting the
     attributes by their name.  Based on the now guaranteed ordering of
     dicts, this arbitrary reordering was removed in Python 3.8 to
     preserve the order in which attributes were originally parsed or
     created by user code.

     In general, user code should try not to depend on a specific
     ordering of attributes, given that the XML Information Set(1)
     explicitly excludes the attribute order from conveying information.
     Code should be prepared to deal with any ordering on input.  In
     cases where deterministic XML output is required, e.g.  for
     cryptographic signing or test data sets, canonical serialisation is
     available with the *note canonicalize(): 294e. function.

     In cases where canonical output is not applicable but a specific
     attribute order is still desirable on output, code should aim for
     creating the attributes directly in the desired order, to avoid
     perceptual mismatches for readers of the code.  In cases where this
     is difficult to achieve, a recipe like the following can be applied
     prior to serialisation to enforce an order independently from the
     Element creation:

          def reorder_attributes(root):     for el in root.iter():         attrib = el.attrib         if len(attrib) > 1:             # adjust attribute order, e.g. by sorting             attribs = sorted(attrib.items())             attrib.clear()             attrib.update(attribs)

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/xml-infoset/


File: python.info,  Node: ElementTree Objects,  Next: QName Objects,  Prev: Element Objects,  Up: Reference<3>

5.21.5.20 ElementTree Objects
.............................

 -- Class: xml.etree.ElementTree.ElementTree (element=None, file=None)

     ElementTree wrapper class.  This class represents an entire element
     hierarchy, and adds some extra support for serialization to and
     from standard XML.

     `element' is the root element.  The tree is initialized with the
     contents of the XML `file' if given.

      -- Method: _setroot (element)

          Replaces the root element for this tree.  This discards the
          current contents of the tree, and replaces it with the given
          element.  Use with care.  `element' is an element instance.

      -- Method: find (match, namespaces=None)

          Same as *note Element.find(): 293d, starting at the root of
          the tree.

      -- Method: findall (match, namespaces=None)

          Same as *note Element.findall(): 293c, starting at the root of
          the tree.

      -- Method: findtext (match, default=None, namespaces=None)

          Same as *note Element.findtext(): 2966, starting at the root
          of the tree.

      -- Method: getiterator (tag=None)

          Deprecated since version 3.2, will be removed in version 3.9:
          Use method *note ElementTree.iter(): 2972. instead.

      -- Method: getroot ()

          Returns the root element for this tree.

      -- Method: iter (tag=None)

          Creates and returns a tree iterator for the root element.  The
          iterator loops over all elements in this tree, in section
          order.  `tag' is the tag to look for (default is to return all
          elements).

      -- Method: iterfind (match, namespaces=None)

          Same as *note Element.iterfind(): b45, starting at the root of
          the tree.

          New in version 3.2.

      -- Method: parse (source, parser=None)

          Loads an external XML section into this element tree.
          `source' is a file name or *note file object: b35.  `parser'
          is an optional parser instance.  If not given, the standard
          *note XMLParser: 250. parser is used.  Returns the section
          root element.

      -- Method: write (file, encoding="us-ascii", xml_declaration=None,
               default_namespace=None, method="xml", *,
               short_empty_elements=True)

          Writes the element tree to a file, as XML. `file' is a file
          name, or a *note file object: b35. opened for writing.
          `encoding' (1) is the output encoding (default is US-ASCII).
          `xml_declaration' controls if an XML declaration should be
          added to the file.  Use ‘False’ for never, ‘True’ for always,
          ‘None’ for only if not US-ASCII or UTF-8 or Unicode (default
          is ‘None’).  `default_namespace' sets the default XML
          namespace (for “xmlns”).  `method' is either ‘"xml"’, ‘"html"’
          or ‘"text"’ (default is ‘"xml"’).  The keyword-only
          `short_empty_elements' parameter controls the formatting of
          elements that contain no content.  If ‘True’ (the default),
          they are emitted as a single self-closed tag, otherwise they
          are emitted as a pair of start/end tags.

          The output is either a string (*note str: 325.) or binary
          (*note bytes: 326.).  This is controlled by the `encoding'
          argument.  If `encoding' is ‘"unicode"’, the output is a
          string; otherwise, it’s binary.  Note that this may conflict
          with the type of `file' if it’s an open *note file object:
          b35.; make sure you do not try to write a string to a binary
          stream and vice versa.

          New in version 3.4: The `short_empty_elements' parameter.

          Changed in version 3.8: The *note write(): 90c. method now
          preserves the attribute order specified by the user.

This is the XML file that is going to be manipulated:

     <html>     <head>         <title>Example page</title>     </head>     <body>         <p>Moved to <a href="http://example.org/">example.org</a>         or <a href="http://example.com/">example.com</a>.</p>     </body> </html>

Example of changing the attribute “target” of every link in first
paragraph:

     >>> from xml.etree.ElementTree import ElementTree >>> tree = ElementTree() >>> tree.parse("index.xhtml") <Element 'html' at 0xb77e6fac> >>> p = tree.find("body/p")     # Finds first occurrence of tag p in body >>> p <Element 'p' at 0xb77ec26c> >>> links = list(p.iter("a"))   # Returns list of all links >>> links [<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>] >>> for i in links:             # Iterates through all found links ...     i.attrib["target"] = "blank" >>> tree.write("output.xhtml")

   ---------- Footnotes ----------

   (1) (1) The encoding string included in XML output should conform to
the appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See
‘https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl’ and
‘https://www.iana.org/assignments/character-sets/character-sets.xhtml’.


File: python.info,  Node: QName Objects,  Next: TreeBuilder Objects,  Prev: ElementTree Objects,  Up: Reference<3>

5.21.5.21 QName Objects
.......................

 -- Class: xml.etree.ElementTree.QName (text_or_uri, tag=None)

     QName wrapper.  This can be used to wrap a QName attribute value,
     in order to get proper namespace handling on output.  `text_or_uri'
     is a string containing the QName value, in the form {uri}local, or,
     if the tag argument is given, the URI part of a QName.  If `tag' is
     given, the first argument is interpreted as a URI, and this
     argument is interpreted as a local name.  *note QName: 2978.
     instances are opaque.


File: python.info,  Node: TreeBuilder Objects,  Next: XMLParser Objects,  Prev: QName Objects,  Up: Reference<3>

5.21.5.22 TreeBuilder Objects
.............................

 -- Class: xml.etree.ElementTree.TreeBuilder (element_factory=None, *,
          comment_factory=None, pi_factory=None, insert_comments=False,
          insert_pis=False)

     Generic element structure builder.  This builder converts a
     sequence of start, data, end, comment and pi method calls to a
     well-formed element structure.  You can use this class to build an
     element structure using a custom XML parser, or a parser for some
     other XML-like format.

     `element_factory', when given, must be a callable accepting two
     positional arguments: a tag and a dict of attributes.  It is
     expected to return a new element instance.

     The `comment_factory' and `pi_factory' functions, when given,
     should behave like the *note Comment(): 294f. and *note
     ProcessingInstruction(): 2954. functions to create comments and
     processing instructions.  When not given, the default factories
     will be used.  When `insert_comments' and/or `insert_pis' is true,
     comments/pis will be inserted into the tree if they appear within
     the root element (but not outside of it).

      -- Method: close ()

          Flushes the builder buffers, and returns the toplevel document
          element.  Returns an *note Element: ab9. instance.

      -- Method: data (data)

          Adds text to the current element.  `data' is a string.  This
          should be either a bytestring, or a Unicode string.

      -- Method: end (tag)

          Closes the current element.  `tag' is the element name.
          Returns the closed element.

      -- Method: start (tag, attrs)

          Opens a new element.  `tag' is the element name.  `attrs' is a
          dictionary containing element attributes.  Returns the opened
          element.

      -- Method: comment (text)

          Creates a comment with the given `text'.  If ‘insert_comments’
          is true, this will also add it to the tree.

          New in version 3.8.

      -- Method: pi (target, text)

          Creates a comment with the given `target' name and `text'.  If
          ‘insert_pis’ is true, this will also add it to the tree.

          New in version 3.8.

     In addition, a custom *note TreeBuilder: 251. object can provide
     the following methods:

      -- Method: doctype (name, pubid, system)

          Handles a doctype declaration.  `name' is the doctype name.
          `pubid' is the public identifier.  `system' is the system
          identifier.  This method does not exist on the default *note
          TreeBuilder: 251. class.

          New in version 3.2.

      -- Method: start_ns (prefix, uri)

          Is called whenever the parser encounters a new namespace
          declaration, before the ‘start()’ callback for the opening
          element that defines it.  `prefix' is ‘''’ for the default
          namespace and the declared namespace prefix name otherwise.
          `uri' is the namespace URI.

          New in version 3.8.

      -- Method: end_ns (prefix)

          Is called after the ‘end()’ callback of an element that
          declared a namespace prefix mapping, with the name of the
          `prefix' that went out of scope.

          New in version 3.8.

 -- Class: xml.etree.ElementTree.C14NWriterTarget (write, *,
          with_comments=False, strip_text=False, rewrite_prefixes=False,
          qname_aware_tags=None, qname_aware_attrs=None,
          exclude_attrs=None, exclude_tags=None)

     A C14N 2.0(1) writer.  Arguments are the same as for the *note
     canonicalize(): 294e. function.  This class does not build a tree
     but translates the callback events directly into a serialised form
     using the `write' function.

     New in version 3.8.

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/xml-c14n2/


File: python.info,  Node: XMLParser Objects,  Next: XMLPullParser Objects,  Prev: TreeBuilder Objects,  Up: Reference<3>

5.21.5.23 XMLParser Objects
...........................

 -- Class: xml.etree.ElementTree.XMLParser (*, target=None,
          encoding=None)

     This class is the low-level building block of the module.  It uses
     *note xml.parsers.expat: 138. for efficient, event-based parsing of
     XML. It can be fed XML data incrementally with the *note feed():
     2985. method, and parsing events are translated to a push API - by
     invoking callbacks on the `target' object.  If `target' is omitted,
     the standard *note TreeBuilder: 251. is used.  If `encoding' (1) is
     given, the value overrides the encoding specified in the XML file.

     Changed in version 3.8: Parameters are now *note keyword-only: 2aa.
     The `html' argument no longer supported.

      -- Method: close ()

          Finishes feeding data to the parser.  Returns the result of
          calling the ‘close()’ method of the `target' passed during
          construction; by default, this is the toplevel document
          element.

      -- Method: feed (data)

          Feeds data to the parser.  `data' is encoded data.

     *note XMLParser.feed(): 2985. calls `target'’s ‘start(tag,
     attrs_dict)’ method for each opening tag, its ‘end(tag)’ method for
     each closing tag, and data is processed by method ‘data(data)’.
     For further supported callback methods, see the *note TreeBuilder:
     251. class.  *note XMLParser.close(): 2986. calls `target'’s method
     ‘close()’.  *note XMLParser: 250. can be used not only for building
     a tree structure.  This is an example of counting the maximum depth
     of an XML file:

          >>> from xml.etree.ElementTree import XMLParser >>> class MaxDepth:                     # The target object of the parser ...     maxDepth = 0 ...     depth = 0 ...     def start(self, tag, attrib):   # Called for each opening tag. ...         self.depth += 1 ...         if self.depth > self.maxDepth: ...             self.maxDepth = self.depth ...     def end(self, tag):             # Called for each closing tag. ...         self.depth -= 1 ...     def data(self, data): ...         pass            # We do not need to do anything with data. ...     def close(self):    # Called when all data has been parsed. ...         return self.maxDepth ... >>> target = MaxDepth() >>> parser = XMLParser(target=target) >>> exampleXml = """ ... <a> ...   <b> ...   </b> ...   <b> ...     <c> ...       <d> ...       </d> ...     </c> ...   </b> ... </a>""" >>> parser.feed(exampleXml) >>> parser.close() 4

   ---------- Footnotes ----------

   (1) (1) The encoding string included in XML output should conform to
the appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See
‘https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl’ and
‘https://www.iana.org/assignments/character-sets/character-sets.xhtml’.


File: python.info,  Node: XMLPullParser Objects,  Next: Exceptions<15>,  Prev: XMLParser Objects,  Up: Reference<3>

5.21.5.24 XMLPullParser Objects
...............................

 -- Class: xml.etree.ElementTree.XMLPullParser (events=None)

     A pull parser suitable for non-blocking applications.  Its
     input-side API is similar to that of *note XMLParser: 250, but
     instead of pushing calls to a callback target, *note XMLPullParser:
     907. collects an internal list of parsing events and lets the user
     read from it.  `events' is a sequence of events to report back.
     The supported events are the strings ‘"start"’, ‘"end"’,
     ‘"comment"’, ‘"pi"’, ‘"start-ns"’ and ‘"end-ns"’ (the “ns” events
     are used to get detailed namespace information).  If `events' is
     omitted, only ‘"end"’ events are reported.

      -- Method: feed (data)

          Feed the given bytes data to the parser.

      -- Method: close ()

          Signal the parser that the data stream is terminated.  Unlike
          *note XMLParser.close(): 2986, this method always returns
          *note None: 157.  Any events not yet retrieved when the parser
          is closed can still be read with *note read_events(): 293a.

      -- Method: read_events ()

          Return an iterator over the events which have been encountered
          in the data fed to the parser.  The iterator yields ‘(event,
          elem)’ pairs, where `event' is a string representing the type
          of event (e.g.  ‘"end"’) and `elem' is the encountered *note
          Element: ab9. object, or other context value as follows.

             * ‘start’, ‘end’: the current Element.

             * ‘comment’, ‘pi’: the current comment / processing
               instruction

             * ‘start-ns’: a tuple ‘(prefix, uri)’ naming the declared
               namespace mapping.

             * ‘end-ns’: *note None: 157. (this may change in a future
               version)

          Events provided in a previous call to *note read_events():
          293a. will not be yielded again.  Events are consumed from the
          internal queue only when they are retrieved from the iterator,
          so multiple readers iterating in parallel over iterators
          obtained from *note read_events(): 293a. will have
          unpredictable results.

          Note: *note XMLPullParser: 907. only guarantees that it has
          seen the “>” character of a starting tag when it emits a
          “start” event, so the attributes are defined, but the contents
          of the text and tail attributes are undefined at that point.
          The same applies to the element children; they may or may not
          be present.

          If you need a fully populated element, look for “end” events
          instead.

     New in version 3.4.

     Changed in version 3.8: The ‘comment’ and ‘pi’ events were added.


File: python.info,  Node: Exceptions<15>,  Prev: XMLPullParser Objects,  Up: Reference<3>

5.21.5.25 Exceptions
....................

 -- Class: xml.etree.ElementTree.ParseError

     XML parse error, raised by the various parsing methods in this
     module when parsing fails.  The string representation of an
     instance of this exception will contain a user-friendly error
     message.  In addition, it will have the following attributes
     available:

      -- Attribute: code

          A numeric error code from the expat parser.  See the
          documentation of *note xml.parsers.expat: 138. for the list of
          error codes and their meanings.

      -- Attribute: position

          A tuple of `line', `column' numbers, specifying where the
          error occurred.


File: python.info,  Node: xml dom — The Document Object Model API,  Next: xml dom minidom — Minimal DOM implementation,  Prev: xml etree ElementTree — The ElementTree XML API,  Up: Structured Markup Processing Tools

5.21.6 ‘xml.dom’ — The Document Object Model API
------------------------------------------------

`Source code:' Lib/xml/dom/__init__.py(1)

__________________________________________________________________

The Document Object Model, or “DOM,” is a cross-language API from the
World Wide Web Consortium (W3C) for accessing and modifying XML
documents.  A DOM implementation presents an XML document as a tree
structure, or allows client code to build such a structure from scratch.
It then gives access to the structure through a set of objects which
provided well-known interfaces.

The DOM is extremely useful for random-access applications.  SAX only
allows you a view of one bit of the document at a time.  If you are
looking at one SAX element, you have no access to another.  If you are
looking at a text node, you have no access to a containing element.
When you write a SAX application, you need to keep track of your
program’s position in the document somewhere in your own code.  SAX does
not do it for you.  Also, if you need to look ahead in the XML document,
you are just out of luck.

Some applications are simply impossible in an event driven model with no
access to a tree.  Of course you could build some sort of tree yourself
in SAX events, but the DOM allows you to avoid writing that code.  The
DOM is a standard tree representation for XML data.

The Document Object Model is being defined by the W3C in stages, or
“levels” in their terminology.  The Python mapping of the API is
substantially based on the DOM Level 2 recommendation.

DOM applications typically start by parsing some XML into a DOM. How
this is accomplished is not covered at all by DOM Level 1, and Level 2
provides only limited improvements: There is a ‘DOMImplementation’
object class which provides access to ‘Document’ creation methods, but
no way to access an XML reader/parser/Document builder in an
implementation-independent way.  There is also no well-defined way to
access these methods without an existing ‘Document’ object.  In Python,
each DOM implementation will provide a function *note
getDOMImplementation(): 298f.  DOM Level 3 adds a Load/Store
specification, which defines an interface to the reader, but this is not
yet available in the Python standard library.

Once you have a DOM document object, you can access the parts of your
XML document through its properties and methods.  These properties are
defined in the DOM specification; this portion of the reference manual
describes the interpretation of the specification in Python.

The specification provided by the W3C defines the DOM API for Java,
ECMAScript, and OMG IDL. The Python mapping defined here is based in
large part on the IDL version of the specification, but strict
compliance is not required (though implementations are free to support
the strict mapping from IDL). See section *note Conformance: 2990. for a
detailed discussion of mapping requirements.

See also
........

Document Object Model (DOM) Level 2 Specification(2)

     The W3C recommendation upon which the Python DOM API is based.

Document Object Model (DOM) Level 1 Specification(3)

     The W3C recommendation for the DOM supported by *note
     xml.dom.minidom: 135.

Python Language Mapping Specification(4)

     This specifies the mapping from OMG IDL to Python.

* Menu:

* Module Contents: Module Contents<4>.
* Objects in the DOM::
* Conformance::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/xml/dom/__init__.py

   (2) https://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/

   (3) https://www.w3.org/TR/REC-DOM-Level-1/

   (4) http://www.omg.org/cgi-bin/doc?formal/02-11-05.pdf


File: python.info,  Node: Module Contents<4>,  Next: Objects in the DOM,  Up: xml dom — The Document Object Model API

5.21.6.1 Module Contents
........................

The *note xml.dom: 134. contains the following functions:

 -- Function: xml.dom.registerDOMImplementation (name, factory)

     Register the `factory' function with the name `name'.  The factory
     function should return an object which implements the
     ‘DOMImplementation’ interface.  The factory function can return the
     same object every time, or a new one for each call, as appropriate
     for the specific implementation (e.g.  if that implementation
     supports some customization).

 -- Function: xml.dom.getDOMImplementation (name=None, features=())

     Return a suitable DOM implementation.  The `name' is either
     well-known, the module name of a DOM implementation, or ‘None’.  If
     it is not ‘None’, imports the corresponding module and returns a
     ‘DOMImplementation’ object if the import succeeds.  If no name is
     given, and if the environment variable ‘PYTHON_DOM’ is set, this
     variable is used to find the implementation.

     If name is not given, this examines the available implementations
     to find one with the required feature set.  If no implementation
     can be found, raise an *note ImportError: 329.  The features list
     must be a sequence of ‘(feature, version)’ pairs which are passed
     to the ‘hasFeature()’ method on available ‘DOMImplementation’
     objects.

Some convenience constants are also provided:

 -- Data: xml.dom.EMPTY_NAMESPACE

     The value used to indicate that no namespace is associated with a
     node in the DOM. This is typically found as the ‘namespaceURI’ of a
     node, or used as the `namespaceURI' parameter to a
     namespaces-specific method.

 -- Data: xml.dom.XML_NAMESPACE

     The namespace URI associated with the reserved prefix ‘xml’, as
     defined by Namespaces in XML(1) (section 4).

 -- Data: xml.dom.XMLNS_NAMESPACE

     The namespace URI for namespace declarations, as defined by
     Document Object Model (DOM) Level 2 Core Specification(2) (section
     1.1.8).

 -- Data: xml.dom.XHTML_NAMESPACE

     The URI of the XHTML namespace as defined by XHTML 1.0: The
     Extensible HyperText Markup Language(3) (section 3.1.1).

In addition, *note xml.dom: 134. contains a base ‘Node’ class and the
DOM exception classes.  The ‘Node’ class provided by this module does
not implement any of the methods or attributes defined by the DOM
specification; concrete DOM implementations must provide those.  The
‘Node’ class provided as part of this module does provide the constants
used for the ‘nodeType’ attribute on concrete ‘Node’ objects; they are
located within the class rather than at the module level to conform with
the DOM specifications.

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/REC-xml-names/

   (2) https://www.w3.org/TR/DOM-Level-2-Core/core.html

   (3) https://www.w3.org/TR/xhtml1/


File: python.info,  Node: Objects in the DOM,  Next: Conformance,  Prev: Module Contents<4>,  Up: xml dom — The Document Object Model API

5.21.6.2 Objects in the DOM
...........................

The definitive documentation for the DOM is the DOM specification from
the W3C.

Note that DOM attributes may also be manipulated as nodes instead of as
simple strings.  It is fairly rare that you must do this, however, so
this usage is not yet documented.

Interface                            Section                                 Purpose
                                                                             
-------------------------------------------------------------------------------------------------------------------
                                                                             
‘DOMImplementation’                  *note DOMImplementation Objects: 2999.  Interface to the underlying
                                                                             implementation.
                                                                             
                                                                             
‘Node’                               *note Node Objects: 299a.               Base interface for most objects in
                                                                             a document.
                                                                             
                                                                             
‘NodeList’                           *note NodeList Objects: 299b.           Interface for a sequence of nodes.
                                                                             
                                                                             
‘DocumentType’                       *note DocumentType Objects: 299c.       Information about the declarations
                                                                             needed to process a document.
                                                                             
                                                                             
‘Document’                           *note Document Objects: 299d.           Object which represents an entire
                                                                             document.
                                                                             
                                                                             
‘Element’                            *note Element Objects: 299e.            Element nodes in the document
                                                                             hierarchy.
                                                                             
                                                                             
‘Attr’                               *note Attr Objects: 299f.               Attribute value nodes on element
                                                                             nodes.
                                                                             
                                                                             
‘Comment’                            *note Comment Objects: 29a0.            Representation of comments in the
                                                                             source document.
                                                                             
                                                                             
‘Text’                               *note Text and CDATASection Objects: 29a1.Nodes containing textual content
                                                                             from the document.
                                                                             
                                                                             
‘ProcessingInstruction’              *note ProcessingInstruction Objects: 29a2.Processing instruction
                                                                             representation.
                                                                             

An additional section describes the exceptions defined for working with
the DOM in Python.

* Menu:

* DOMImplementation Objects::
* Node Objects::
* NodeList Objects::
* DocumentType Objects::
* Document Objects::
* Element Objects: Element Objects<2>.
* Attr Objects::
* NamedNodeMap Objects::
* Comment Objects::
* Text and CDATASection Objects::
* ProcessingInstruction Objects::
* Exceptions: Exceptions<16>.


File: python.info,  Node: DOMImplementation Objects,  Next: Node Objects,  Up: Objects in the DOM

5.21.6.3 DOMImplementation Objects
..................................

The ‘DOMImplementation’ interface provides a way for applications to
determine the availability of particular features in the DOM they are
using.  DOM Level 2 added the ability to create new ‘Document’ and
‘DocumentType’ objects using the ‘DOMImplementation’ as well.

 -- Method: DOMImplementation.hasFeature (feature, version)

     Return ‘True’ if the feature identified by the pair of strings
     `feature' and `version' is implemented.

 -- Method: DOMImplementation.createDocument (namespaceUri,
          qualifiedName, doctype)

     Return a new ‘Document’ object (the root of the DOM), with a child
     ‘Element’ object having the given `namespaceUri' and
     `qualifiedName'.  The `doctype' must be a ‘DocumentType’ object
     created by *note createDocumentType(): 29a6, or ‘None’.  In the
     Python DOM API, the first two arguments can also be ‘None’ in order
     to indicate that no ‘Element’ child is to be created.

 -- Method: DOMImplementation.createDocumentType (qualifiedName,
          publicId, systemId)

     Return a new ‘DocumentType’ object that encapsulates the given
     `qualifiedName', `publicId', and `systemId' strings, representing
     the information contained in an XML document type declaration.


File: python.info,  Node: Node Objects,  Next: NodeList Objects,  Prev: DOMImplementation Objects,  Up: Objects in the DOM

5.21.6.4 Node Objects
.....................

All of the components of an XML document are subclasses of ‘Node’.

 -- Attribute: Node.nodeType

     An integer representing the node type.  Symbolic constants for the
     types are on the ‘Node’ object: ‘ELEMENT_NODE’, ‘ATTRIBUTE_NODE’,
     ‘TEXT_NODE’, ‘CDATA_SECTION_NODE’, ‘ENTITY_NODE’,
     ‘PROCESSING_INSTRUCTION_NODE’, ‘COMMENT_NODE’, ‘DOCUMENT_NODE’,
     ‘DOCUMENT_TYPE_NODE’, ‘NOTATION_NODE’.  This is a read-only
     attribute.

 -- Attribute: Node.parentNode

     The parent of the current node, or ‘None’ for the document node.
     The value is always a ‘Node’ object or ‘None’.  For ‘Element’
     nodes, this will be the parent element, except for the root
     element, in which case it will be the ‘Document’ object.  For
     ‘Attr’ nodes, this is always ‘None’.  This is a read-only
     attribute.

 -- Attribute: Node.attributes

     A ‘NamedNodeMap’ of attribute objects.  Only elements have actual
     values for this; others provide ‘None’ for this attribute.  This is
     a read-only attribute.

 -- Attribute: Node.previousSibling

     The node that immediately precedes this one with the same parent.
     For instance the element with an end-tag that comes just before the
     `self' element’s start-tag.  Of course, XML documents are made up
     of more than just elements so the previous sibling could be text, a
     comment, or something else.  If this node is the first child of the
     parent, this attribute will be ‘None’.  This is a read-only
     attribute.

 -- Attribute: Node.nextSibling

     The node that immediately follows this one with the same parent.
     See also *note previousSibling: 29ab.  If this is the last child of
     the parent, this attribute will be ‘None’.  This is a read-only
     attribute.

 -- Attribute: Node.childNodes

     A list of nodes contained within this node.  This is a read-only
     attribute.

 -- Attribute: Node.firstChild

     The first child of the node, if there are any, or ‘None’.  This is
     a read-only attribute.

 -- Attribute: Node.lastChild

     The last child of the node, if there are any, or ‘None’.  This is a
     read-only attribute.

 -- Attribute: Node.localName

     The part of the ‘tagName’ following the colon if there is one, else
     the entire ‘tagName’.  The value is a string.

 -- Attribute: Node.prefix

     The part of the ‘tagName’ preceding the colon if there is one, else
     the empty string.  The value is a string, or ‘None’.

 -- Attribute: Node.namespaceURI

     The namespace associated with the element name.  This will be a
     string or ‘None’.  This is a read-only attribute.

 -- Attribute: Node.nodeName

     This has a different meaning for each node type; see the DOM
     specification for details.  You can always get the information you
     would get here from another property such as the ‘tagName’ property
     for elements or the ‘name’ property for attributes.  For all node
     types, the value of this attribute will be either a string or
     ‘None’.  This is a read-only attribute.

 -- Attribute: Node.nodeValue

     This has a different meaning for each node type; see the DOM
     specification for details.  The situation is similar to that with
     *note nodeName: 29b3.  The value is a string or ‘None’.

 -- Method: Node.hasAttributes ()

     Return ‘True’ if the node has any attributes.

 -- Method: Node.hasChildNodes ()

     Return ‘True’ if the node has any child nodes.

 -- Method: Node.isSameNode (other)

     Return ‘True’ if `other' refers to the same node as this node.
     This is especially useful for DOM implementations which use any
     sort of proxy architecture (because more than one object can refer
     to the same node).

          Note: This is based on a proposed DOM Level 3 API which is
          still in the “working draft” stage, but this particular
          interface appears uncontroversial.  Changes from the W3C will
          not necessarily affect this method in the Python DOM interface
          (though any new W3C API for this would also be supported).

 -- Method: Node.appendChild (newChild)

     Add a new child node to this node at the end of the list of
     children, returning `newChild'.  If the node was already in the
     tree, it is removed first.

 -- Method: Node.insertBefore (newChild, refChild)

     Insert a new child node before an existing child.  It must be the
     case that `refChild' is a child of this node; if not, *note
     ValueError: 1f9. is raised.  `newChild' is returned.  If `refChild'
     is ‘None’, it inserts `newChild' at the end of the children’s list.

 -- Method: Node.removeChild (oldChild)

     Remove a child node.  `oldChild' must be a child of this node; if
     not, *note ValueError: 1f9. is raised.  `oldChild' is returned on
     success.  If `oldChild' will not be used further, its ‘unlink()’
     method should be called.

 -- Method: Node.replaceChild (newChild, oldChild)

     Replace an existing node with a new node.  It must be the case that
     `oldChild' is a child of this node; if not, *note ValueError: 1f9.
     is raised.

 -- Method: Node.normalize ()

     Join adjacent text nodes so that all stretches of text are stored
     as single ‘Text’ instances.  This simplifies processing text from a
     DOM tree for many applications.

 -- Method: Node.cloneNode (deep)

     Clone this node.  Setting `deep' means to clone all child nodes as
     well.  This returns the clone.


File: python.info,  Node: NodeList Objects,  Next: DocumentType Objects,  Prev: Node Objects,  Up: Objects in the DOM

5.21.6.5 NodeList Objects
.........................

A ‘NodeList’ represents a sequence of nodes.  These objects are used in
two ways in the DOM Core recommendation: an ‘Element’ object provides
one as its list of child nodes, and the ‘getElementsByTagName()’ and
‘getElementsByTagNameNS()’ methods of ‘Node’ return objects with this
interface to represent query results.

The DOM Level 2 recommendation defines one method and one attribute for
these objects:

 -- Method: NodeList.item (i)

     Return the `i'’th item from the sequence, if there is one, or
     ‘None’.  The index `i' is not allowed to be less than zero or
     greater than or equal to the length of the sequence.

 -- Attribute: NodeList.length

     The number of nodes in the sequence.

In addition, the Python DOM interface requires that some additional
support is provided to allow ‘NodeList’ objects to be used as Python
sequences.  All ‘NodeList’ implementations must include support for
*note __len__(): dbe. and *note __getitem__(): 27a.; this allows
iteration over the ‘NodeList’ in *note for: c23. statements and proper
support for the *note len(): 150. built-in function.

If a DOM implementation supports modification of the document, the
‘NodeList’ implementation must also support the *note __setitem__():
c55. and *note __delitem__(): c56. methods.


File: python.info,  Node: DocumentType Objects,  Next: Document Objects,  Prev: NodeList Objects,  Up: Objects in the DOM

5.21.6.6 DocumentType Objects
.............................

Information about the notations and entities declared by a document
(including the external subset if the parser uses it and can provide the
information) is available from a ‘DocumentType’ object.  The
‘DocumentType’ for a document is available from the ‘Document’ object’s
‘doctype’ attribute; if there is no ‘DOCTYPE’ declaration for the
document, the document’s ‘doctype’ attribute will be set to ‘None’
instead of an instance of this interface.

‘DocumentType’ is a specialization of ‘Node’, and adds the following
attributes:

 -- Attribute: DocumentType.publicId

     The public identifier for the external subset of the document type
     definition.  This will be a string or ‘None’.

 -- Attribute: DocumentType.systemId

     The system identifier for the external subset of the document type
     definition.  This will be a URI as a string, or ‘None’.

 -- Attribute: DocumentType.internalSubset

     A string giving the complete internal subset from the document.
     This does not include the brackets which enclose the subset.  If
     the document has no internal subset, this should be ‘None’.

 -- Attribute: DocumentType.name

     The name of the root element as given in the ‘DOCTYPE’ declaration,
     if present.

 -- Attribute: DocumentType.entities

     This is a ‘NamedNodeMap’ giving the definitions of external
     entities.  For entity names defined more than once, only the first
     definition is provided (others are ignored as required by the XML
     recommendation).  This may be ‘None’ if the information is not
     provided by the parser, or if no entities are defined.

 -- Attribute: DocumentType.notations

     This is a ‘NamedNodeMap’ giving the definitions of notations.  For
     notation names defined more than once, only the first definition is
     provided (others are ignored as required by the XML
     recommendation).  This may be ‘None’ if the information is not
     provided by the parser, or if no notations are defined.


File: python.info,  Node: Document Objects,  Next: Element Objects<2>,  Prev: DocumentType Objects,  Up: Objects in the DOM

5.21.6.7 Document Objects
.........................

A ‘Document’ represents an entire XML document, including its
constituent elements, attributes, processing instructions, comments etc.
Remember that it inherits properties from ‘Node’.

 -- Attribute: Document.documentElement

     The one and only root element of the document.

 -- Method: Document.createElement (tagName)

     Create and return a new element node.  The element is not inserted
     into the document when it is created.  You need to explicitly
     insert it with one of the other methods such as ‘insertBefore()’ or
     ‘appendChild()’.

 -- Method: Document.createElementNS (namespaceURI, tagName)

     Create and return a new element with a namespace.  The `tagName'
     may have a prefix.  The element is not inserted into the document
     when it is created.  You need to explicitly insert it with one of
     the other methods such as ‘insertBefore()’ or ‘appendChild()’.

 -- Method: Document.createTextNode (data)

     Create and return a text node containing the data passed as a
     parameter.  As with the other creation methods, this one does not
     insert the node into the tree.

 -- Method: Document.createComment (data)

     Create and return a comment node containing the data passed as a
     parameter.  As with the other creation methods, this one does not
     insert the node into the tree.

 -- Method: Document.createProcessingInstruction (target, data)

     Create and return a processing instruction node containing the
     `target' and `data' passed as parameters.  As with the other
     creation methods, this one does not insert the node into the tree.

 -- Method: Document.createAttribute (name)

     Create and return an attribute node.  This method does not
     associate the attribute node with any particular element.  You must
     use ‘setAttributeNode()’ on the appropriate ‘Element’ object to use
     the newly created attribute instance.

 -- Method: Document.createAttributeNS (namespaceURI, qualifiedName)

     Create and return an attribute node with a namespace.  The
     `tagName' may have a prefix.  This method does not associate the
     attribute node with any particular element.  You must use
     ‘setAttributeNode()’ on the appropriate ‘Element’ object to use the
     newly created attribute instance.

 -- Method: Document.getElementsByTagName (tagName)

     Search for all descendants (direct children, children’s children,
     etc.)  with a particular element type name.

 -- Method: Document.getElementsByTagNameNS (namespaceURI, localName)

     Search for all descendants (direct children, children’s children,
     etc.)  with a particular namespace URI and localname.  The
     localname is the part of the namespace after the prefix.


File: python.info,  Node: Element Objects<2>,  Next: Attr Objects,  Prev: Document Objects,  Up: Objects in the DOM

5.21.6.8 Element Objects
........................

‘Element’ is a subclass of ‘Node’, so inherits all the attributes of
that class.

 -- Attribute: Element.tagName

     The element type name.  In a namespace-using document it may have
     colons in it.  The value is a string.

 -- Method: Element.getElementsByTagName (tagName)

     Same as equivalent method in the ‘Document’ class.

 -- Method: Element.getElementsByTagNameNS (namespaceURI, localName)

     Same as equivalent method in the ‘Document’ class.

 -- Method: Element.hasAttribute (name)

     Return ‘True’ if the element has an attribute named by `name'.

 -- Method: Element.hasAttributeNS (namespaceURI, localName)

     Return ‘True’ if the element has an attribute named by
     `namespaceURI' and `localName'.

 -- Method: Element.getAttribute (name)

     Return the value of the attribute named by `name' as a string.  If
     no such attribute exists, an empty string is returned, as if the
     attribute had no value.

 -- Method: Element.getAttributeNode (attrname)

     Return the ‘Attr’ node for the attribute named by `attrname'.

 -- Method: Element.getAttributeNS (namespaceURI, localName)

     Return the value of the attribute named by `namespaceURI' and
     `localName' as a string.  If no such attribute exists, an empty
     string is returned, as if the attribute had no value.

 -- Method: Element.getAttributeNodeNS (namespaceURI, localName)

     Return an attribute value as a node, given a `namespaceURI' and
     `localName'.

 -- Method: Element.removeAttribute (name)

     Remove an attribute by name.  If there is no matching attribute, a
     *note NotFoundErr: 29de. is raised.

 -- Method: Element.removeAttributeNode (oldAttr)

     Remove and return `oldAttr' from the attribute list, if present.
     If `oldAttr' is not present, *note NotFoundErr: 29de. is raised.

 -- Method: Element.removeAttributeNS (namespaceURI, localName)

     Remove an attribute by name.  Note that it uses a localName, not a
     qname.  No exception is raised if there is no matching attribute.

 -- Method: Element.setAttribute (name, value)

     Set an attribute value from a string.

 -- Method: Element.setAttributeNode (newAttr)

     Add a new attribute node to the element, replacing an existing
     attribute if necessary if the ‘name’ attribute matches.  If a
     replacement occurs, the old attribute node will be returned.  If
     `newAttr' is already in use, *note InuseAttributeErr: 29e3. will be
     raised.

 -- Method: Element.setAttributeNodeNS (newAttr)

     Add a new attribute node to the element, replacing an existing
     attribute if necessary if the ‘namespaceURI’ and ‘localName’
     attributes match.  If a replacement occurs, the old attribute node
     will be returned.  If `newAttr' is already in use, *note
     InuseAttributeErr: 29e3. will be raised.

 -- Method: Element.setAttributeNS (namespaceURI, qname, value)

     Set an attribute value from a string, given a `namespaceURI' and a
     `qname'.  Note that a qname is the whole attribute name.  This is
     different than above.


File: python.info,  Node: Attr Objects,  Next: NamedNodeMap Objects,  Prev: Element Objects<2>,  Up: Objects in the DOM

5.21.6.9 Attr Objects
.....................

‘Attr’ inherits from ‘Node’, so inherits all its attributes.

 -- Attribute: Attr.name

     The attribute name.  In a namespace-using document it may include a
     colon.

 -- Attribute: Attr.localName

     The part of the name following the colon if there is one, else the
     entire name.  This is a read-only attribute.

 -- Attribute: Attr.prefix

     The part of the name preceding the colon if there is one, else the
     empty string.

 -- Attribute: Attr.value

     The text value of the attribute.  This is a synonym for the
     ‘nodeValue’ attribute.


File: python.info,  Node: NamedNodeMap Objects,  Next: Comment Objects,  Prev: Attr Objects,  Up: Objects in the DOM

5.21.6.10 NamedNodeMap Objects
..............................

‘NamedNodeMap’ does `not' inherit from ‘Node’.

 -- Attribute: NamedNodeMap.length

     The length of the attribute list.

 -- Method: NamedNodeMap.item (index)

     Return an attribute with a particular index.  The order you get the
     attributes in is arbitrary but will be consistent for the life of a
     DOM. Each item is an attribute node.  Get its value with the
     ‘value’ attribute.

There are also experimental methods that give this class more mapping
behavior.  You can use them or you can use the standardized
‘getAttribute*()’ family of methods on the ‘Element’ objects.


File: python.info,  Node: Comment Objects,  Next: Text and CDATASection Objects,  Prev: NamedNodeMap Objects,  Up: Objects in the DOM

5.21.6.11 Comment Objects
.........................

‘Comment’ represents a comment in the XML document.  It is a subclass of
‘Node’, but cannot have child nodes.

 -- Attribute: Comment.data

     The content of the comment as a string.  The attribute contains all
     characters between the leading ‘<!-’‘-’ and trailing ‘-’‘->’, but
     does not include them.


File: python.info,  Node: Text and CDATASection Objects,  Next: ProcessingInstruction Objects,  Prev: Comment Objects,  Up: Objects in the DOM

5.21.6.12 Text and CDATASection Objects
.......................................

The ‘Text’ interface represents text in the XML document.  If the parser
and DOM implementation support the DOM’s XML extension, portions of the
text enclosed in CDATA marked sections are stored in ‘CDATASection’
objects.  These two interfaces are identical, but provide different
values for the ‘nodeType’ attribute.

These interfaces extend the ‘Node’ interface.  They cannot have child
nodes.

 -- Attribute: Text.data

     The content of the text node as a string.

     Note: The use of a ‘CDATASection’ node does not indicate that the
     node represents a complete CDATA marked section, only that the
     content of the node was part of a CDATA section.  A single CDATA
     section may be represented by more than one node in the document
     tree.  There is no way to determine whether two adjacent
     ‘CDATASection’ nodes represent different CDATA marked sections.


File: python.info,  Node: ProcessingInstruction Objects,  Next: Exceptions<16>,  Prev: Text and CDATASection Objects,  Up: Objects in the DOM

5.21.6.13 ProcessingInstruction Objects
.......................................

Represents a processing instruction in the XML document; this inherits
from the ‘Node’ interface and cannot have child nodes.

 -- Attribute: ProcessingInstruction.target

     The content of the processing instruction up to the first
     whitespace character.  This is a read-only attribute.

 -- Attribute: ProcessingInstruction.data

     The content of the processing instruction following the first
     whitespace character.


File: python.info,  Node: Exceptions<16>,  Prev: ProcessingInstruction Objects,  Up: Objects in the DOM

5.21.6.14 Exceptions
....................

The DOM Level 2 recommendation defines a single exception, *note
DOMException: 29f8, and a number of constants that allow applications to
determine what sort of error occurred.  *note DOMException: 29f8.
instances carry a *note code: 1b. attribute that provides the
appropriate value for the specific exception.

The Python DOM interface provides the constants, but also expands the
set of exceptions so that a specific exception exists for each of the
exception codes defined by the DOM. The implementations must raise the
appropriate specific exception, each of which carries the appropriate
value for the *note code: 1b. attribute.

 -- Exception: xml.dom.DOMException

     Base exception class used for all specific DOM exceptions.  This
     exception class cannot be directly instantiated.

 -- Exception: xml.dom.DomstringSizeErr

     Raised when a specified range of text does not fit into a string.
     This is not known to be used in the Python DOM implementations, but
     may be received from DOM implementations not written in Python.

 -- Exception: xml.dom.HierarchyRequestErr

     Raised when an attempt is made to insert a node where the node type
     is not allowed.

 -- Exception: xml.dom.IndexSizeErr

     Raised when an index or size parameter to a method is negative or
     exceeds the allowed values.

 -- Exception: xml.dom.InuseAttributeErr

     Raised when an attempt is made to insert an ‘Attr’ node that is
     already present elsewhere in the document.

 -- Exception: xml.dom.InvalidAccessErr

     Raised if a parameter or an operation is not supported on the
     underlying object.

 -- Exception: xml.dom.InvalidCharacterErr

     This exception is raised when a string parameter contains a
     character that is not permitted in the context it’s being used in
     by the XML 1.0 recommendation.  For example, attempting to create
     an ‘Element’ node with a space in the element type name will cause
     this error to be raised.

 -- Exception: xml.dom.InvalidModificationErr

     Raised when an attempt is made to modify the type of a node.

 -- Exception: xml.dom.InvalidStateErr

     Raised when an attempt is made to use an object that is not defined
     or is no longer usable.

 -- Exception: xml.dom.NamespaceErr

     If an attempt is made to change any object in a way that is not
     permitted with regard to the Namespaces in XML(1) recommendation,
     this exception is raised.

 -- Exception: xml.dom.NotFoundErr

     Exception when a node does not exist in the referenced context.
     For example, ‘NamedNodeMap.removeNamedItem()’ will raise this if
     the node passed in does not exist in the map.

 -- Exception: xml.dom.NotSupportedErr

     Raised when the implementation does not support the requested type
     of object or operation.

 -- Exception: xml.dom.NoDataAllowedErr

     This is raised if data is specified for a node which does not
     support data.

 -- Exception: xml.dom.NoModificationAllowedErr

     Raised on attempts to modify an object where modifications are not
     allowed (such as for read-only nodes).

 -- Exception: xml.dom.SyntaxErr

     Raised when an invalid or illegal string is specified.

 -- Exception: xml.dom.WrongDocumentErr

     Raised when a node is inserted in a different document than it
     currently belongs to, and the implementation does not support
     migrating the node from one document to the other.

The exception codes defined in the DOM recommendation map to the
exceptions described above according to this table:

Constant                                   Exception
                                           
---------------------------------------------------------------------------------
                                           
‘DOMSTRING_SIZE_ERR’                       *note DomstringSizeErr: 29f9.
                                           
                                           
‘HIERARCHY_REQUEST_ERR’                    *note HierarchyRequestErr: 29fa.
                                           
                                           
‘INDEX_SIZE_ERR’                           *note IndexSizeErr: 29fb.
                                           
                                           
‘INUSE_ATTRIBUTE_ERR’                      *note InuseAttributeErr: 29e3.
                                           
                                           
‘INVALID_ACCESS_ERR’                       *note InvalidAccessErr: 29fc.
                                           
                                           
‘INVALID_CHARACTER_ERR’                    *note InvalidCharacterErr: 29fd.
                                           
                                           
‘INVALID_MODIFICATION_ERR’                 *note InvalidModificationErr: 29fe.
                                           
                                           
‘INVALID_STATE_ERR’                        *note InvalidStateErr: 29ff.
                                           
                                           
‘NAMESPACE_ERR’                            *note NamespaceErr: 2a00.
                                           
                                           
‘NOT_FOUND_ERR’                            *note NotFoundErr: 29de.
                                           
                                           
‘NOT_SUPPORTED_ERR’                        *note NotSupportedErr: 2a01.
                                           
                                           
‘NO_DATA_ALLOWED_ERR’                      *note NoDataAllowedErr: 2a02.
                                           
                                           
‘NO_MODIFICATION_ALLOWED_ERR’              *note NoModificationAllowedErr: 2a03.
                                           
                                           
‘SYNTAX_ERR’                               *note SyntaxErr: 2a04.
                                           
                                           
‘WRONG_DOCUMENT_ERR’                       *note WrongDocumentErr: 2a05.
                                           

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/REC-xml-names/


File: python.info,  Node: Conformance,  Prev: Objects in the DOM,  Up: xml dom — The Document Object Model API

5.21.6.15 Conformance
.....................

This section describes the conformance requirements and relationships
between the Python DOM API, the W3C DOM recommendations, and the OMG IDL
mapping for Python.

* Menu:

* Type Mapping::
* Accessor Methods::


File: python.info,  Node: Type Mapping,  Next: Accessor Methods,  Up: Conformance

5.21.6.16 Type Mapping
......................

The IDL types used in the DOM specification are mapped to Python types
according to the following table.

IDL Type               Python Type
                       
-----------------------------------------------------------------------
                       
‘boolean’              ‘bool’ or ‘int’
                       
                       
‘int’                  ‘int’
                       
                       
‘long int’             ‘int’
                       
                       
‘unsigned int’         ‘int’
                       
                       
‘DOMString’            ‘str’ or ‘bytes’
                       
                       
‘null’                 ‘None’
                       


File: python.info,  Node: Accessor Methods,  Prev: Type Mapping,  Up: Conformance

5.21.6.17 Accessor Methods
..........................

The mapping from OMG IDL to Python defines accessor functions for IDL
‘attribute’ declarations in much the way the Java mapping does.  Mapping
the IDL declarations

     readonly attribute string someValue;          attribute string anotherValue;

yields three accessor functions: a “get” method for ‘someValue’
(‘_get_someValue()’), and “get” and “set” methods for ‘anotherValue’
(‘_get_anotherValue()’ and ‘_set_anotherValue()’).  The mapping, in
particular, does not require that the IDL attributes are accessible as
normal Python attributes: ‘object.someValue’ is `not' required to work,
and may raise an *note AttributeError: 390.

The Python DOM API, however, `does' require that normal attribute access
work.  This means that the typical surrogates generated by Python IDL
compilers are not likely to work, and wrapper objects may be needed on
the client if the DOM objects are accessed via CORBA. While this does
require some additional consideration for CORBA DOM clients, the
implementers with experience using DOM over CORBA from Python do not
consider this a problem.  Attributes that are declared ‘readonly’ may
not restrict write access in all DOM implementations.

In the Python DOM API, accessor functions are not required.  If
provided, they should take the form defined by the Python IDL mapping,
but these methods are considered unnecessary since the attributes are
accessible directly from Python.  “Set” accessors should never be
provided for ‘readonly’ attributes.

The IDL definitions do not fully embody the requirements of the W3C DOM
API, such as the notion of certain objects, such as the return value of
‘getElementsByTagName()’, being “live”.  The Python DOM API does not
require implementations to enforce such requirements.


File: python.info,  Node: xml dom minidom — Minimal DOM implementation,  Next: xml dom pulldom — Support for building partial DOM trees,  Prev: xml dom — The Document Object Model API,  Up: Structured Markup Processing Tools

5.21.7 ‘xml.dom.minidom’ — Minimal DOM implementation
-----------------------------------------------------

`Source code:' Lib/xml/dom/minidom.py(1)

__________________________________________________________________

*note xml.dom.minidom: 135. is a minimal implementation of the Document
Object Model interface, with an API similar to that in other languages.
It is intended to be simpler than the full DOM and also significantly
smaller.  Users who are not already proficient with the DOM should
consider using the *note xml.etree.ElementTree: 137. module for their
XML processing instead.

     Warning: The *note xml.dom.minidom: 135. module is not secure
     against maliciously constructed data.  If you need to parse
     untrusted or unauthenticated data see *note XML vulnerabilities:
     292c.

DOM applications typically start by parsing some XML into a DOM. With
*note xml.dom.minidom: 135, this is done through the parse functions:

     from xml.dom.minidom import parse, parseString  dom1 = parse('c:\\temp\\mydata.xml')  # parse an XML file by name  datasource = open('c:\\temp\\mydata.xml') dom2 = parse(datasource)  # parse an open file  dom3 = parseString('<myxml>Some data<empty/> some more data</myxml>')

The *note parse(): 2a0d. function can take either a filename or an open
file object.

 -- Function: xml.dom.minidom.parse (filename_or_file, parser=None,
          bufsize=None)

     Return a ‘Document’ from the given input.  `filename_or_file' may
     be either a file name, or a file-like object.  `parser', if given,
     must be a SAX2 parser object.  This function will change the
     document handler of the parser and activate namespace support;
     other parser configuration (like setting an entity resolver) must
     have been done in advance.

If you have XML in a string, you can use the *note parseString(): 2a0e.
function instead:

 -- Function: xml.dom.minidom.parseString (string, parser=None)

     Return a ‘Document’ that represents the `string'.  This method
     creates an *note io.StringIO: 821. object for the string and passes
     that on to *note parse(): 2a0d.

Both functions return a ‘Document’ object representing the content of
the document.

What the *note parse(): 2a0d. and *note parseString(): 2a0e. functions
do is connect an XML parser with a “DOM builder” that can accept parse
events from any SAX parser and convert them into a DOM tree.  The name
of the functions are perhaps misleading, but are easy to grasp when
learning the interfaces.  The parsing of the document will be completed
before these functions return; it’s simply that these functions do not
provide a parser implementation themselves.

You can also create a ‘Document’ by calling a method on a “DOM
Implementation” object.  You can get this object either by calling the
‘getDOMImplementation()’ function in the *note xml.dom: 134. package or
the *note xml.dom.minidom: 135. module.  Once you have a ‘Document’, you
can add child nodes to it to populate the DOM:

     from xml.dom.minidom import getDOMImplementation  impl = getDOMImplementation()  newdoc = impl.createDocument(None, "some_tag", None) top_element = newdoc.documentElement text = newdoc.createTextNode('Some textual content.') top_element.appendChild(text)

Once you have a DOM document object, you can access the parts of your
XML document through its properties and methods.  These properties are
defined in the DOM specification.  The main property of the document
object is the ‘documentElement’ property.  It gives you the main element
in the XML document: the one that holds all others.  Here is an example
program:

     dom3 = parseString("<myxml>Some data</myxml>") assert dom3.documentElement.tagName == "myxml"

When you are finished with a DOM tree, you may optionally call the
‘unlink()’ method to encourage early cleanup of the now-unneeded
objects.  ‘unlink()’ is an *note xml.dom.minidom: 135.-specific
extension to the DOM API that renders the node and its descendants are
essentially useless.  Otherwise, Python’s garbage collector will
eventually take care of the objects in the tree.

See also
........

Document Object Model (DOM) Level 1 Specification(2)

     The W3C recommendation for the DOM supported by *note
     xml.dom.minidom: 135.

* Menu:

* DOM Objects::
* DOM Example::
* minidom and the DOM standard::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/xml/dom/minidom.py

   (2) https://www.w3.org/TR/REC-DOM-Level-1/


File: python.info,  Node: DOM Objects,  Next: DOM Example,  Up: xml dom minidom — Minimal DOM implementation

5.21.7.1 DOM Objects
....................

The definition of the DOM API for Python is given as part of the *note
xml.dom: 134. module documentation.  This section lists the differences
between the API and *note xml.dom.minidom: 135.

 -- Method: Node.unlink ()

     Break internal references within the DOM so that it will be garbage
     collected on versions of Python without cyclic GC. Even when cyclic
     GC is available, using this can make large amounts of memory
     available sooner, so calling this on DOM objects as soon as they
     are no longer needed is good practice.  This only needs to be
     called on the ‘Document’ object, but may be called on child nodes
     to discard children of that node.

     You can avoid calling this method explicitly by using the *note
     with: 6dd. statement.  The following code will automatically unlink
     `dom' when the ‘with’ block is exited:

          with xml.dom.minidom.parse(datasource) as dom:     ... # Work with dom.

 -- Method: Node.writexml (writer, indent="", addindent="", newl="")

     Write XML to the writer object.  The writer receives texts but not
     bytes as input, it should have a ‘write()’ method which matches
     that of the file object interface.  The `indent' parameter is the
     indentation of the current node.  The `addindent' parameter is the
     incremental indentation to use for subnodes of the current one.
     The `newl' parameter specifies the string to use to terminate
     newlines.

     For the ‘Document’ node, an additional keyword argument `encoding'
     can be used to specify the encoding field of the XML header.

     Changed in version 3.8: The *note writexml(): 2a12. method now
     preserves the attribute order specified by the user.

 -- Method: Node.toxml (encoding=None)

     Return a string or byte string containing the XML represented by
     the DOM node.

     With an explicit `encoding' (1) argument, the result is a byte
     string in the specified encoding.  With no `encoding' argument, the
     result is a Unicode string, and the XML declaration in the
     resulting string does not specify an encoding.  Encoding this
     string in an encoding other than UTF-8 is likely incorrect, since
     UTF-8 is the default encoding of XML.

     Changed in version 3.8: The *note toxml(): 2a13. method now
     preserves the attribute order specified by the user.

 -- Method: Node.toprettyxml (indent="\t", newl="\n", encoding=None)

     Return a pretty-printed version of the document.  `indent'
     specifies the indentation string and defaults to a tabulator;
     `newl' specifies the string emitted at the end of each line and
     defaults to ‘\n’.

     The `encoding' argument behaves like the corresponding argument of
     *note toxml(): 2a13.

     Changed in version 3.8: The *note toprettyxml(): 2a14. method now
     preserves the attribute order specified by the user.

   ---------- Footnotes ----------

   (1) (1) The encoding name included in the XML output should conform
to the appropriate standards.  For example, “UTF-8” is valid, but “UTF8”
is not valid in an XML document’s declaration, even though Python
accepts it as an encoding name.  See
‘https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl’ and
‘https://www.iana.org/assignments/character-sets/character-sets.xhtml’.


File: python.info,  Node: DOM Example,  Next: minidom and the DOM standard,  Prev: DOM Objects,  Up: xml dom minidom — Minimal DOM implementation

5.21.7.2 DOM Example
....................

This example program is a fairly realistic example of a simple program.
In this particular case, we do not take much advantage of the
flexibility of the DOM.

     import xml.dom.minidom  document = """\ <slideshow> <title>Demo slideshow</title> <slide><title>Slide title</title> <point>This is a demo</point> <point>Of a program for processing slides</point> </slide>  <slide><title>Another demo slide</title> <point>It is important</point> <point>To have more than</point> <point>one slide</point> </slide> </slideshow> """  dom = xml.dom.minidom.parseString(document)  def getText(nodelist):     rc = []     for node in nodelist:         if node.nodeType == node.TEXT_NODE:             rc.append(node.data)     return ''.join(rc)  def handleSlideshow(slideshow):     print("<html>")     handleSlideshowTitle(slideshow.getElementsByTagName("title")[0])     slides = slideshow.getElementsByTagName("slide")     handleToc(slides)     handleSlides(slides)     print("</html>")  def handleSlides(slides):     for slide in slides:         handleSlide(slide)  def handleSlide(slide):     handleSlideTitle(slide.getElementsByTagName("title")[0])     handlePoints(slide.getElementsByTagName("point"))  def handleSlideshowTitle(title):     print("<title>%s</title>" % getText(title.childNodes))  def handleSlideTitle(title):     print("<h2>%s</h2>" % getText(title.childNodes))  def handlePoints(points):     print("<ul>")     for point in points:         handlePoint(point)     print("</ul>")  def handlePoint(point):     print("<li>%s</li>" % getText(point.childNodes))  def handleToc(slides):     for slide in slides:         title = slide.getElementsByTagName("title")[0]         print("<p>%s</p>" % getText(title.childNodes))  handleSlideshow(dom)


File: python.info,  Node: minidom and the DOM standard,  Prev: DOM Example,  Up: xml dom minidom — Minimal DOM implementation

5.21.7.3 minidom and the DOM standard
.....................................

The *note xml.dom.minidom: 135. module is essentially a DOM
1.0-compatible DOM with some DOM 2 features (primarily namespace
features).

Usage of the DOM interface in Python is straight-forward.  The following
mapping rules apply:

   * Interfaces are accessed through instance objects.  Applications
     should not instantiate the classes themselves; they should use the
     creator functions available on the ‘Document’ object.  Derived
     interfaces support all operations (and attributes) from the base
     interfaces, plus any new operations.

   * Operations are used as methods.  Since the DOM uses only *note in:
     797. parameters, the arguments are passed in normal order (from
     left to right).  There are no optional arguments.  ‘void’
     operations return ‘None’.

   * IDL attributes map to instance attributes.  For compatibility with
     the OMG IDL language mapping for Python, an attribute ‘foo’ can
     also be accessed through accessor methods ‘_get_foo()’ and
     ‘_set_foo()’.  ‘readonly’ attributes must not be changed; this is
     not enforced at runtime.

   * The types ‘short int’, ‘unsigned int’, ‘unsigned long long’, and
     ‘boolean’ all map to Python integer objects.

   * The type ‘DOMString’ maps to Python strings.  *note
     xml.dom.minidom: 135. supports either bytes or strings, but will
     normally produce strings.  Values of type ‘DOMString’ may also be
     ‘None’ where allowed to have the IDL ‘null’ value by the DOM
     specification from the W3C.

   * ‘const’ declarations map to variables in their respective scope
     (e.g.  ‘xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE’); they
     must not be changed.

   * ‘DOMException’ is currently not supported in *note xml.dom.minidom:
     135.  Instead, *note xml.dom.minidom: 135. uses standard Python
     exceptions such as *note TypeError: 192. and *note AttributeError:
     390.

   * ‘NodeList’ objects are implemented using Python’s built-in list
     type.  These objects provide the interface defined in the DOM
     specification, but with earlier versions of Python they do not
     support the official API. They are, however, much more “Pythonic”
     than the interface defined in the W3C recommendations.

The following interfaces have no implementation in *note
xml.dom.minidom: 135.:

   * ‘DOMTimeStamp’

   * ‘EntityReference’

Most of these reflect information in the XML document that is not of
general utility to most DOM users.


File: python.info,  Node: xml dom pulldom — Support for building partial DOM trees,  Next: xml sax — Support for SAX2 parsers,  Prev: xml dom minidom — Minimal DOM implementation,  Up: Structured Markup Processing Tools

5.21.8 ‘xml.dom.pulldom’ — Support for building partial DOM trees
-----------------------------------------------------------------

`Source code:' Lib/xml/dom/pulldom.py(1)

__________________________________________________________________

The *note xml.dom.pulldom: 136. module provides a “pull parser” which
can also be asked to produce DOM-accessible fragments of the document
where necessary.  The basic concept involves pulling “events” from a
stream of incoming XML and processing them.  In contrast to SAX which
also employs an event-driven processing model together with callbacks,
the user of a pull parser is responsible for explicitly pulling events
from the stream, looping over those events until either processing is
finished or an error condition occurs.

     Warning: The *note xml.dom.pulldom: 136. module is not secure
     against maliciously constructed data.  If you need to parse
     untrusted or unauthenticated data see *note XML vulnerabilities:
     292c.

Changed in version 3.7.1: The SAX parser no longer processes general
external entities by default to increase security by default.  To enable
processing of external entities, pass a custom parser instance in:

     from xml.dom.pulldom import parse from xml.sax import make_parser from xml.sax.handler import feature_external_ges  parser = make_parser() parser.setFeature(feature_external_ges, True) parse(filename, parser=parser)

Example:

     from xml.dom import pulldom  doc = pulldom.parse('sales_items.xml') for event, node in doc:     if event == pulldom.START_ELEMENT and node.tagName == 'item':         if int(node.getAttribute('price')) > 50:             doc.expandNode(node)             print(node.toxml())

‘event’ is a constant and can be one of:

   * ‘START_ELEMENT’

   * ‘END_ELEMENT’

   * ‘COMMENT’

   * ‘START_DOCUMENT’

   * ‘END_DOCUMENT’

   * ‘CHARACTERS’

   * ‘PROCESSING_INSTRUCTION’

   * ‘IGNORABLE_WHITESPACE’

‘node’ is an object of type ‘xml.dom.minidom.Document’,
‘xml.dom.minidom.Element’ or ‘xml.dom.minidom.Text’.

Since the document is treated as a “flat” stream of events, the document
“tree” is implicitly traversed and the desired elements are found
regardless of their depth in the tree.  In other words, one does not
need to consider hierarchical issues such as recursive searching of the
document nodes, although if the context of elements were important, one
would either need to maintain some context-related state (i.e.
remembering where one is in the document at any given point) or to make
use of the *note DOMEventStream.expandNode(): 2a1b. method and switch to
DOM-related processing.

 -- Class: xml.dom.pulldom.PullDom (documentFactory=None)

     Subclass of *note xml.sax.handler.ContentHandler: 2a1d.

 -- Class: xml.dom.pulldom.SAX2DOM (documentFactory=None)

     Subclass of *note xml.sax.handler.ContentHandler: 2a1d.

 -- Function: xml.dom.pulldom.parse (stream_or_string, parser=None,
          bufsize=None)

     Return a *note DOMEventStream: 27b. from the given input.
     `stream_or_string' may be either a file name, or a file-like
     object.  `parser', if given, must be an *note XMLReader: 2a20.
     object.  This function will change the document handler of the
     parser and activate namespace support; other parser configuration
     (like setting an entity resolver) must have been done in advance.

If you have XML in a string, you can use the *note parseString(): 2a21.
function instead:

 -- Function: xml.dom.pulldom.parseString (string, parser=None)

     Return a *note DOMEventStream: 27b. that represents the (Unicode)
     `string'.

 -- Data: xml.dom.pulldom.default_bufsize

     Default value for the `bufsize' parameter to *note parse(): 2a1f.

     The value of this variable can be changed before calling *note
     parse(): 2a1f. and the new value will take effect.

* Menu:

* DOMEventStream Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/xml/dom/pulldom.py


File: python.info,  Node: DOMEventStream Objects,  Up: xml dom pulldom — Support for building partial DOM trees

5.21.8.1 DOMEventStream Objects
...............................

 -- Class: xml.dom.pulldom.DOMEventStream (stream, parser, bufsize)

     Deprecated since version 3.8: Support for *note sequence protocol:
     27a. is deprecated.

      -- Method: getEvent ()

          Return a tuple containing `event' and the current `node' as
          ‘xml.dom.minidom.Document’ if event equals ‘START_DOCUMENT’,
          ‘xml.dom.minidom.Element’ if event equals ‘START_ELEMENT’ or
          ‘END_ELEMENT’ or ‘xml.dom.minidom.Text’ if event equals
          ‘CHARACTERS’.  The current node does not contain information
          about its children, unless *note expandNode(): 2a1b. is
          called.

      -- Method: expandNode (node)

          Expands all children of `node' into `node'.  Example:

               from xml.dom import pulldom  xml = '<html><title>Foo</title> <p>Some text <div>and more</div></p> </html>' doc = pulldom.parseString(xml) for event, node in doc:     if event == pulldom.START_ELEMENT and node.tagName == 'p':         # Following statement only prints '<p/>'         print(node.toxml())         doc.expandNode(node)         # Following statement prints node with all its children '<p>Some text <div>and more</div></p>'         print(node.toxml())

      -- Method: reset ()


File: python.info,  Node: xml sax — Support for SAX2 parsers,  Next: xml sax handler — Base classes for SAX handlers,  Prev: xml dom pulldom — Support for building partial DOM trees,  Up: Structured Markup Processing Tools

5.21.9 ‘xml.sax’ — Support for SAX2 parsers
-------------------------------------------

`Source code:' Lib/xml/sax/__init__.py(1)

__________________________________________________________________

The *note xml.sax: 13b. package provides a number of modules which
implement the Simple API for XML (SAX) interface for Python.  The
package itself provides the SAX exceptions and the convenience functions
which will be most used by users of the SAX API.

     Warning: The *note xml.sax: 13b. module is not secure against
     maliciously constructed data.  If you need to parse untrusted or
     unauthenticated data see *note XML vulnerabilities: 292c.

Changed in version 3.7.1: The SAX parser no longer processes general
external entities by default to increase security.  Before, the parser
created network connections to fetch remote files or loaded local files
from the file system for DTD and entities.  The feature can be enabled
again with method *note setFeature(): 2a29. on the parser object and
argument *note feature_external_ges: 2a2a.

The convenience functions are:

 -- Function: xml.sax.make_parser (parser_list=[])

     Create and return a SAX *note XMLReader: 2a20. object.  The first
     parser found will be used.  If `parser_list' is provided, it must
     be an iterable of strings which name modules that have a function
     named ‘create_parser()’.  Modules listed in `parser_list' will be
     used before modules in the default list of parsers.

     Changed in version 3.8: The `parser_list' argument can be any
     iterable, not just a list.

 -- Function: xml.sax.parse (filename_or_stream, handler,
          error_handler=handler.ErrorHandler())

     Create a SAX parser and use it to parse a document.  The document,
     passed in as `filename_or_stream', can be a filename or a file
     object.  The `handler' parameter needs to be a SAX *note
     ContentHandler: 2a1d. instance.  If `error_handler' is given, it
     must be a SAX *note ErrorHandler: 2a2b. instance; if omitted, *note
     SAXParseException: 2a2c. will be raised on all errors.  There is no
     return value; all work must be done by the `handler' passed in.

 -- Function: xml.sax.parseString (string, handler,
          error_handler=handler.ErrorHandler())

     Similar to *note parse(): f15, but parses from a buffer `string'
     received as a parameter.  `string' must be a *note str: 325.
     instance or a *note bytes-like object: 5dd.

     Changed in version 3.5: Added support of *note str: 325. instances.

A typical SAX application uses three kinds of objects: readers, handlers
and input sources.  “Reader” in this context is another term for parser,
i.e.  some piece of code that reads the bytes or characters from the
input source, and produces a sequence of events.  The events then get
distributed to the handler objects, i.e.  the reader invokes a method on
the handler.  A SAX application must therefore obtain a reader object,
create or open the input sources, create the handlers, and connect these
objects all together.  As the final step of preparation, the reader is
called to parse the input.  During parsing, methods on the handler
objects are called based on structural and syntactic events from the
input data.

For these objects, only the interfaces are relevant; they are normally
not instantiated by the application itself.  Since Python does not have
an explicit notion of interface, they are formally introduced as
classes, but applications may use implementations which do not inherit
from the provided classes.  The *note InputSource: 786, *note Locator:
2a2d, ‘Attributes’, ‘AttributesNS’, and *note XMLReader: 2a20.
interfaces are defined in the module *note xml.sax.xmlreader: 13e.  The
handler interfaces are defined in *note xml.sax.handler: 13c.  For
convenience, *note InputSource: 786. (which is often instantiated
directly) and the handler classes are also available from *note xml.sax:
13b.  These interfaces are described below.

In addition to these classes, *note xml.sax: 13b. provides the following
exception classes.

 -- Exception: xml.sax.SAXException (msg, exception=None)

     Encapsulate an XML error or warning.  This class can contain basic
     error or warning information from either the XML parser or the
     application: it can be subclassed to provide additional
     functionality or to add localization.  Note that although the
     handlers defined in the *note ErrorHandler: 2a2b. interface receive
     instances of this exception, it is not required to actually raise
     the exception — it is also useful as a container for information.

     When instantiated, `msg' should be a human-readable description of
     the error.  The optional `exception' parameter, if given, should be
     ‘None’ or an exception that was caught by the parsing code and is
     being passed along as information.

     This is the base class for the other SAX exception classes.

 -- Exception: xml.sax.SAXParseException (msg, exception, locator)

     Subclass of *note SAXException: 2a2e. raised on parse errors.
     Instances of this class are passed to the methods of the SAX *note
     ErrorHandler: 2a2b. interface to provide information about the
     parse error.  This class supports the SAX *note Locator: 2a2d.
     interface as well as the *note SAXException: 2a2e. interface.

 -- Exception: xml.sax.SAXNotRecognizedException (msg, exception=None)

     Subclass of *note SAXException: 2a2e. raised when a SAX *note
     XMLReader: 2a20. is confronted with an unrecognized feature or
     property.  SAX applications and extensions may use this class for
     similar purposes.

 -- Exception: xml.sax.SAXNotSupportedException (msg, exception=None)

     Subclass of *note SAXException: 2a2e. raised when a SAX *note
     XMLReader: 2a20. is asked to enable a feature that is not
     supported, or to set a property to a value that the implementation
     does not support.  SAX applications and extensions may use this
     class for similar purposes.

See also
........

SAX: The Simple API for XML(2)

     This site is the focal point for the definition of the SAX API. It
     provides a Java implementation and online documentation.  Links to
     implementations and historical information are also available.

Module *note xml.sax.handler: 13c.

     Definitions of the interfaces for application-provided objects.

Module *note xml.sax.saxutils: 13d.

     Convenience functions for use in SAX applications.

Module *note xml.sax.xmlreader: 13e.

     Definitions of the interfaces for parser-provided objects.

* Menu:

* SAXException Objects::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/xml/sax/__init__.py

   (2) http://www.saxproject.org/


File: python.info,  Node: SAXException Objects,  Up: xml sax — Support for SAX2 parsers

5.21.9.1 SAXException Objects
.............................

The *note SAXException: 2a2e. exception class supports the following
methods:

 -- Method: SAXException.getMessage ()

     Return a human-readable message describing the error condition.

 -- Method: SAXException.getException ()

     Return an encapsulated exception object, or ‘None’.


File: python.info,  Node: xml sax handler — Base classes for SAX handlers,  Next: xml sax saxutils — SAX Utilities,  Prev: xml sax — Support for SAX2 parsers,  Up: Structured Markup Processing Tools

5.21.10 ‘xml.sax.handler’ — Base classes for SAX handlers
---------------------------------------------------------

`Source code:' Lib/xml/sax/handler.py(1)

__________________________________________________________________

The SAX API defines four kinds of handlers: content handlers, DTD
handlers, error handlers, and entity resolvers.  Applications normally
only need to implement those interfaces whose events they are interested
in; they can implement the interfaces in a single object or in multiple
objects.  Handler implementations should inherit from the base classes
provided in the module *note xml.sax.handler: 13c, so that all methods
get default implementations.

 -- Class: xml.sax.handler.ContentHandler

     This is the main callback interface in SAX, and the one most
     important to applications.  The order of events in this interface
     mirrors the order of the information in the document.

 -- Class: xml.sax.handler.DTDHandler

     Handle DTD events.

     This interface specifies only those DTD events required for basic
     parsing (unparsed entities and attributes).

 -- Class: xml.sax.handler.EntityResolver

     Basic interface for resolving entities.  If you create an object
     implementing this interface, then register the object with your
     Parser, the parser will call the method in your object to resolve
     all external entities.

 -- Class: xml.sax.handler.ErrorHandler

     Interface used by the parser to present error and warning messages
     to the application.  The methods of this object control whether
     errors are immediately converted to exceptions or are handled in
     some other way.

In addition to these classes, *note xml.sax.handler: 13c. provides
symbolic constants for the feature and property names.

 -- Data: xml.sax.handler.feature_namespaces

          value: ‘"http://xml.org/sax/features/namespaces"’ 
          true: Perform Namespace processing. 
          false: Optionally do not perform Namespace processing (implies namespace-prefixes; default). 
          access: (parsing) read-only; (not parsing) read/write 

 -- Data: xml.sax.handler.feature_namespace_prefixes

          value: ‘"http://xml.org/sax/features/namespace-prefixes"’ 
          true: Report the original prefixed names and attributes used for Namespace declarations. 
          false: Do not report attributes used for Namespace declarations, and optionally do not report original prefixed names (default). 
          access: (parsing) read-only; (not parsing) read/write 

 -- Data: xml.sax.handler.feature_string_interning

          value: ‘"http://xml.org/sax/features/string-interning"’ 
          true: All element names, prefixes, attribute names, Namespace URIs, and local names are interned using the built-in intern function. 
          false: Names are not necessarily interned, although they may be (default). 
          access: (parsing) read-only; (not parsing) read/write 

 -- Data: xml.sax.handler.feature_validation

          value: ‘"http://xml.org/sax/features/validation"’ 
          true: Report all validation errors (implies external-general-entities and external-parameter-entities). 
          false: Do not report validation errors. 
          access: (parsing) read-only; (not parsing) read/write 

 -- Data: xml.sax.handler.feature_external_ges

          value: ‘"http://xml.org/sax/features/external-general-entities"’ 
          true: Include all external general (text) entities. 
          false: Do not include external general entities. 
          access: (parsing) read-only; (not parsing) read/write 

 -- Data: xml.sax.handler.feature_external_pes

          value: ‘"http://xml.org/sax/features/external-parameter-entities"’ 
          true: Include all external parameter entities, including the external DTD subset. 
          false: Do not include any external parameter entities, even the external DTD subset. 
          access: (parsing) read-only; (not parsing) read/write 

 -- Data: xml.sax.handler.all_features

     List of all features.

 -- Data: xml.sax.handler.property_lexical_handler

          value: ‘"http://xml.org/sax/properties/lexical-handler"’ 
          data type: xml.sax.sax2lib.LexicalHandler (not supported in Python 2) 
          description: An optional extension handler for lexical events like comments. 
          access: read/write 

 -- Data: xml.sax.handler.property_declaration_handler

          value: ‘"http://xml.org/sax/properties/declaration-handler"’ 
          data type: xml.sax.sax2lib.DeclHandler (not supported in Python 2) 
          description: An optional extension handler for DTD-related events other than notations and unparsed entities. 
          access: read/write 

 -- Data: xml.sax.handler.property_dom_node

          value: ‘"http://xml.org/sax/properties/dom-node"’ 
          data type: org.w3c.dom.Node (not supported in Python 2) 
          description: When parsing, the current DOM node being visited if this is a DOM iterator; when not parsing, the root DOM node for iteration. 
          access: (parsing) read-only; (not parsing) read/write 

 -- Data: xml.sax.handler.property_xml_string

          value: ‘"http://xml.org/sax/properties/xml-string"’ 
          data type: String 
          description: The literal string of characters that was the source for the current event. 
          access: read-only 

 -- Data: xml.sax.handler.all_properties

     List of all known property names.

* Menu:

* ContentHandler Objects::
* DTDHandler Objects::
* EntityResolver Objects::
* ErrorHandler Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/xml/sax/handler.py


File: python.info,  Node: ContentHandler Objects,  Next: DTDHandler Objects,  Up: xml sax handler — Base classes for SAX handlers

5.21.10.1 ContentHandler Objects
................................

Users are expected to subclass *note ContentHandler: 2a1d. to support
their application.  The following methods are called by the parser on
the appropriate events in the input document:

 -- Method: ContentHandler.setDocumentLocator (locator)

     Called by the parser to give the application a locator for locating
     the origin of document events.

     SAX parsers are strongly encouraged (though not absolutely
     required) to supply a locator: if it does so, it must supply the
     locator to the application by invoking this method before invoking
     any of the other methods in the DocumentHandler interface.

     The locator allows the application to determine the end position of
     any document-related event, even if the parser is not reporting an
     error.  Typically, the application will use this information for
     reporting its own errors (such as character content that does not
     match an application’s business rules).  The information returned
     by the locator is probably not sufficient for use with a search
     engine.

     Note that the locator will return correct information only during
     the invocation of the events in this interface.  The application
     should not attempt to use it at any other time.

 -- Method: ContentHandler.startDocument ()

     Receive notification of the beginning of a document.

     The SAX parser will invoke this method only once, before any other
     methods in this interface or in DTDHandler (except for *note
     setDocumentLocator(): 2a46.).

 -- Method: ContentHandler.endDocument ()

     Receive notification of the end of a document.

     The SAX parser will invoke this method only once, and it will be
     the last method invoked during the parse.  The parser shall not
     invoke this method until it has either abandoned parsing (because
     of an unrecoverable error) or reached the end of input.

 -- Method: ContentHandler.startPrefixMapping (prefix, uri)

     Begin the scope of a prefix-URI Namespace mapping.

     The information from this event is not necessary for normal
     Namespace processing: the SAX XML reader will automatically replace
     prefixes for element and attribute names when the
     ‘feature_namespaces’ feature is enabled (the default).

     There are cases, however, when applications need to use prefixes in
     character data or in attribute values, where they cannot safely be
     expanded automatically; the *note startPrefixMapping(): 2a49. and
     *note endPrefixMapping(): 2a4a. events supply the information to
     the application to expand prefixes in those contexts itself, if
     necessary.

     Note that *note startPrefixMapping(): 2a49. and *note
     endPrefixMapping(): 2a4a. events are not guaranteed to be properly
     nested relative to each-other: all *note startPrefixMapping():
     2a49. events will occur before the corresponding *note
     startElement(): 2a4b. event, and all *note endPrefixMapping():
     2a4a. events will occur after the corresponding *note endElement():
     2a4c. event, but their order is not guaranteed.

 -- Method: ContentHandler.endPrefixMapping (prefix)

     End the scope of a prefix-URI mapping.

     See *note startPrefixMapping(): 2a49. for details.  This event will
     always occur after the corresponding *note endElement(): 2a4c.
     event, but the order of *note endPrefixMapping(): 2a4a. events is
     not otherwise guaranteed.

 -- Method: ContentHandler.startElement (name, attrs)

     Signals the start of an element in non-namespace mode.

     The `name' parameter contains the raw XML 1.0 name of the element
     type as a string and the `attrs' parameter holds an object of the
     ‘Attributes’ interface (see *note The Attributes Interface: 2a4d.)
     containing the attributes of the element.  The object passed as
     `attrs' may be re-used by the parser; holding on to a reference to
     it is not a reliable way to keep a copy of the attributes.  To keep
     a copy of the attributes, use the *note copy(): 26. method of the
     `attrs' object.

 -- Method: ContentHandler.endElement (name)

     Signals the end of an element in non-namespace mode.

     The `name' parameter contains the name of the element type, just as
     with the *note startElement(): 2a4b. event.

 -- Method: ContentHandler.startElementNS (name, qname, attrs)

     Signals the start of an element in namespace mode.

     The `name' parameter contains the name of the element type as a
     ‘(uri, localname)’ tuple, the `qname' parameter contains the raw
     XML 1.0 name used in the source document, and the `attrs' parameter
     holds an instance of the ‘AttributesNS’ interface (see *note The
     AttributesNS Interface: 2a4f.) containing the attributes of the
     element.  If no namespace is associated with the element, the `uri'
     component of `name' will be ‘None’.  The object passed as `attrs'
     may be re-used by the parser; holding on to a reference to it is
     not a reliable way to keep a copy of the attributes.  To keep a
     copy of the attributes, use the *note copy(): 26. method of the
     `attrs' object.

     Parsers may set the `qname' parameter to ‘None’, unless the
     ‘feature_namespace_prefixes’ feature is activated.

 -- Method: ContentHandler.endElementNS (name, qname)

     Signals the end of an element in namespace mode.

     The `name' parameter contains the name of the element type, just as
     with the *note startElementNS(): 2a4e. method, likewise the `qname'
     parameter.

 -- Method: ContentHandler.characters (content)

     Receive notification of character data.

     The Parser will call this method to report each chunk of character
     data.  SAX parsers may return all contiguous character data in a
     single chunk, or they may split it into several chunks; however,
     all of the characters in any single event must come from the same
     external entity so that the Locator provides useful information.

     `content' may be a string or bytes instance; the ‘expat’ reader
     module always produces strings.

          Note: The earlier SAX 1 interface provided by the Python XML
          Special Interest Group used a more Java-like interface for
          this method.  Since most parsers used from Python did not take
          advantage of the older interface, the simpler signature was
          chosen to replace it.  To convert old code to the new
          interface, use `content' instead of slicing content with the
          old `offset' and `length' parameters.

 -- Method: ContentHandler.ignorableWhitespace (whitespace)

     Receive notification of ignorable whitespace in element content.

     Validating Parsers must use this method to report each chunk of
     ignorable whitespace (see the W3C XML 1.0 recommendation, section
     2.10): non-validating parsers may also use this method if they are
     capable of parsing and using content models.

     SAX parsers may return all contiguous whitespace in a single chunk,
     or they may split it into several chunks; however, all of the
     characters in any single event must come from the same external
     entity, so that the Locator provides useful information.

 -- Method: ContentHandler.processingInstruction (target, data)

     Receive notification of a processing instruction.

     The Parser will invoke this method once for each processing
     instruction found: note that processing instructions may occur
     before or after the main document element.

     A SAX parser should never report an XML declaration (XML 1.0,
     section 2.8) or a text declaration (XML 1.0, section 4.3.1) using
     this method.

 -- Method: ContentHandler.skippedEntity (name)

     Receive notification of a skipped entity.

     The Parser will invoke this method once for each entity skipped.
     Non-validating processors may skip entities if they have not seen
     the declarations (because, for example, the entity was declared in
     an external DTD subset).  All processors may skip external
     entities, depending on the values of the ‘feature_external_ges’ and
     the ‘feature_external_pes’ properties.


File: python.info,  Node: DTDHandler Objects,  Next: EntityResolver Objects,  Prev: ContentHandler Objects,  Up: xml sax handler — Base classes for SAX handlers

5.21.10.2 DTDHandler Objects
............................

*note DTDHandler: 2a37. instances provide the following methods:

 -- Method: DTDHandler.notationDecl (name, publicId, systemId)

     Handle a notation declaration event.

 -- Method: DTDHandler.unparsedEntityDecl (name, publicId, systemId,
          ndata)

     Handle an unparsed entity declaration event.


File: python.info,  Node: EntityResolver Objects,  Next: ErrorHandler Objects,  Prev: DTDHandler Objects,  Up: xml sax handler — Base classes for SAX handlers

5.21.10.3 EntityResolver Objects
................................

 -- Method: EntityResolver.resolveEntity (publicId, systemId)

     Resolve the system identifier of an entity and return either the
     system identifier to read from as a string, or an InputSource to
     read from.  The default implementation returns `systemId'.


File: python.info,  Node: ErrorHandler Objects,  Prev: EntityResolver Objects,  Up: xml sax handler — Base classes for SAX handlers

5.21.10.4 ErrorHandler Objects
..............................

Objects with this interface are used to receive error and warning
information from the *note XMLReader: 2a20.  If you create an object
that implements this interface, then register the object with your *note
XMLReader: 2a20, the parser will call the methods in your object to
report all warnings and errors.  There are three levels of errors
available: warnings, (possibly) recoverable errors, and unrecoverable
errors.  All methods take a ‘SAXParseException’ as the only parameter.
Errors and warnings may be converted to an exception by raising the
passed-in exception object.

 -- Method: ErrorHandler.error (exception)

     Called when the parser encounters a recoverable error.  If this
     method does not raise an exception, parsing may continue, but
     further document information should not be expected by the
     application.  Allowing the parser to continue may allow additional
     errors to be discovered in the input document.

 -- Method: ErrorHandler.fatalError (exception)

     Called when the parser encounters an error it cannot recover from;
     parsing is expected to terminate when this method returns.

 -- Method: ErrorHandler.warning (exception)

     Called when the parser presents minor warning information to the
     application.  Parsing is expected to continue when this method
     returns, and document information will continue to be passed to the
     application.  Raising an exception in this method will cause
     parsing to end.


File: python.info,  Node: xml sax saxutils — SAX Utilities,  Next: xml sax xmlreader — Interface for XML parsers,  Prev: xml sax handler — Base classes for SAX handlers,  Up: Structured Markup Processing Tools

5.21.11 ‘xml.sax.saxutils’ — SAX Utilities
------------------------------------------

`Source code:' Lib/xml/sax/saxutils.py(1)

__________________________________________________________________

The module *note xml.sax.saxutils: 13d. contains a number of classes and
functions that are commonly useful when creating SAX applications,
either in direct use, or as base classes.

 -- Function: xml.sax.saxutils.escape (data, entities={})

     Escape ‘'&'’, ‘'<'’, and ‘'>'’ in a string of data.

     You can escape other strings of data by passing a dictionary as the
     optional `entities' parameter.  The keys and values must all be
     strings; each key will be replaced with its corresponding value.
     The characters ‘'&'’, ‘'<'’ and ‘'>'’ are always escaped, even if
     `entities' is provided.

 -- Function: xml.sax.saxutils.unescape (data, entities={})

     Unescape ‘'&amp;'’, ‘'&lt;'’, and ‘'&gt;'’ in a string of data.

     You can unescape other strings of data by passing a dictionary as
     the optional `entities' parameter.  The keys and values must all be
     strings; each key will be replaced with its corresponding value.
     ‘'&amp'’, ‘'&lt;'’, and ‘'&gt;'’ are always unescaped, even if
     `entities' is provided.

 -- Function: xml.sax.saxutils.quoteattr (data, entities={})

     Similar to *note escape(): 2a63, but also prepares `data' to be
     used as an attribute value.  The return value is a quoted version
     of `data' with any additional required replacements.  *note
     quoteattr(): 2a65. will select a quote character based on the
     content of `data', attempting to avoid encoding any quote
     characters in the string.  If both single- and double-quote
     characters are already in `data', the double-quote characters will
     be encoded and `data' will be wrapped in double-quotes.  The
     resulting string can be used directly as an attribute value:

          >>> print("<element attr=%s>" % quoteattr("ab ' cd \" ef")) <element attr="ab ' cd &quot; ef">

     This function is useful when generating attribute values for HTML
     or any SGML using the reference concrete syntax.

 -- Class: xml.sax.saxutils.XMLGenerator (out=None,
          encoding='iso-8859-1', short_empty_elements=False)

     This class implements the *note ContentHandler: 2a1d. interface by
     writing SAX events back into an XML document.  In other words,
     using an *note XMLGenerator: 2a66. as the content handler will
     reproduce the original document being parsed.  `out' should be a
     file-like object which will default to `sys.stdout'.  `encoding' is
     the encoding of the output stream which defaults to ‘'iso-8859-1'’.
     `short_empty_elements' controls the formatting of elements that
     contain no content: if ‘False’ (the default) they are emitted as a
     pair of start/end tags, if set to ‘True’ they are emitted as a
     single self-closed tag.

     New in version 3.2: The `short_empty_elements' parameter.

 -- Class: xml.sax.saxutils.XMLFilterBase (base)

     This class is designed to sit between an *note XMLReader: 2a20. and
     the client application’s event handlers.  By default, it does
     nothing but pass requests up to the reader and events on to the
     handlers unmodified, but subclasses can override specific methods
     to modify the event stream or the configuration requests as they
     pass through.

 -- Function: xml.sax.saxutils.prepare_input_source (source, base='')

     This function takes an input source and an optional base URL and
     returns a fully resolved *note InputSource: 786. object ready for
     reading.  The input source can be given as a string, a file-like
     object, or an *note InputSource: 786. object; parsers will use this
     function to implement the polymorphic `source' argument to their
     ‘parse()’ method.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/xml/sax/saxutils.py


File: python.info,  Node: xml sax xmlreader — Interface for XML parsers,  Next: xml parsers expat — Fast XML parsing using Expat,  Prev: xml sax saxutils — SAX Utilities,  Up: Structured Markup Processing Tools

5.21.12 ‘xml.sax.xmlreader’ — Interface for XML parsers
-------------------------------------------------------

`Source code:' Lib/xml/sax/xmlreader.py(1)

__________________________________________________________________

SAX parsers implement the *note XMLReader: 2a20. interface.  They are
implemented in a Python module, which must provide a function
‘create_parser()’.  This function is invoked by *note
xml.sax.make_parser(): f60. with no arguments to create a new parser
object.

 -- Class: xml.sax.xmlreader.XMLReader

     Base class which can be inherited by SAX parsers.

 -- Class: xml.sax.xmlreader.IncrementalParser

     In some cases, it is desirable not to parse an input source at
     once, but to feed chunks of the document as they get available.
     Note that the reader will normally not read the entire file, but
     read it in chunks as well; still ‘parse()’ won’t return until the
     entire document is processed.  So these interfaces should be used
     if the blocking behaviour of ‘parse()’ is not desirable.

     When the parser is instantiated it is ready to begin accepting data
     from the feed method immediately.  After parsing has been finished
     with a call to close the reset method must be called to make the
     parser ready to accept new data, either from feed or using the
     parse method.

     Note that these methods must `not' be called during parsing, that
     is, after parse has been called and before it returns.

     By default, the class also implements the parse method of the
     XMLReader interface using the feed, close and reset methods of the
     IncrementalParser interface as a convenience to SAX 2.0 driver
     writers.

 -- Class: xml.sax.xmlreader.Locator

     Interface for associating a SAX event with a document location.  A
     locator object will return valid results only during calls to
     DocumentHandler methods; at any other time, the results are
     unpredictable.  If information is not available, methods may return
     ‘None’.

 -- Class: xml.sax.xmlreader.InputSource (system_id=None)

     Encapsulation of the information needed by the *note XMLReader:
     2a20. to read entities.

     This class may include information about the public identifier,
     system identifier, byte stream (possibly with character encoding
     information) and/or the character stream of an entity.

     Applications will create objects of this class for use in the *note
     XMLReader.parse(): 2a6c. method and for returning from
     EntityResolver.resolveEntity.

     An *note InputSource: 786. belongs to the application, the *note
     XMLReader: 2a20. is not allowed to modify *note InputSource: 786.
     objects passed to it from the application, although it may make
     copies and modify those.

 -- Class: xml.sax.xmlreader.AttributesImpl (attrs)

     This is an implementation of the ‘Attributes’ interface (see
     section *note The Attributes Interface: 2a4d.).  This is a
     dictionary-like object which represents the element attributes in a
     ‘startElement()’ call.  In addition to the most useful dictionary
     operations, it supports a number of other methods as described by
     the interface.  Objects of this class should be instantiated by
     readers; `attrs' must be a dictionary-like object containing a
     mapping from attribute names to attribute values.

 -- Class: xml.sax.xmlreader.AttributesNSImpl (attrs, qnames)

     Namespace-aware variant of *note AttributesImpl: 2a6d, which will
     be passed to ‘startElementNS()’.  It is derived from *note
     AttributesImpl: 2a6d, but understands attribute names as two-tuples
     of `namespaceURI' and `localname'.  In addition, it provides a
     number of methods expecting qualified names as they appear in the
     original document.  This class implements the ‘AttributesNS’
     interface (see section *note The AttributesNS Interface: 2a4f.).

* Menu:

* XMLReader Objects::
* IncrementalParser Objects::
* Locator Objects::
* InputSource Objects::
* The Attributes Interface::
* The AttributesNS Interface::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/xml/sax/xmlreader.py


File: python.info,  Node: XMLReader Objects,  Next: IncrementalParser Objects,  Up: xml sax xmlreader — Interface for XML parsers

5.21.12.1 XMLReader Objects
...........................

The *note XMLReader: 2a20. interface supports the following methods:

 -- Method: XMLReader.parse (source)

     Process an input source, producing SAX events.  The `source' object
     can be a system identifier (a string identifying the input source –
     typically a file name or a URL), a *note pathlib.Path: 1ff. or
     *note path-like: 35f. object, or an *note InputSource: 786. object.
     When *note parse(): 2a6c. returns, the input is completely
     processed, and the parser object can be discarded or reset.

     Changed in version 3.5: Added support of character streams.

     Changed in version 3.8: Added support of path-like objects.

 -- Method: XMLReader.getContentHandler ()

     Return the current *note ContentHandler: 2a1d.

 -- Method: XMLReader.setContentHandler (handler)

     Set the current *note ContentHandler: 2a1d.  If no *note
     ContentHandler: 2a1d. is set, content events will be discarded.

 -- Method: XMLReader.getDTDHandler ()

     Return the current *note DTDHandler: 2a37.

 -- Method: XMLReader.setDTDHandler (handler)

     Set the current *note DTDHandler: 2a37.  If no *note DTDHandler:
     2a37. is set, DTD events will be discarded.

 -- Method: XMLReader.getEntityResolver ()

     Return the current *note EntityResolver: 2a38.

 -- Method: XMLReader.setEntityResolver (handler)

     Set the current *note EntityResolver: 2a38.  If no *note
     EntityResolver: 2a38. is set, attempts to resolve an external
     entity will result in opening the system identifier for the entity,
     and fail if it is not available.

 -- Method: XMLReader.getErrorHandler ()

     Return the current *note ErrorHandler: 2a2b.

 -- Method: XMLReader.setErrorHandler (handler)

     Set the current error handler.  If no *note ErrorHandler: 2a2b. is
     set, errors will be raised as exceptions, and warnings will be
     printed.

 -- Method: XMLReader.setLocale (locale)

     Allow an application to set the locale for errors and warnings.

     SAX parsers are not required to provide localization for errors and
     warnings; if they cannot support the requested locale, however,
     they must raise a SAX exception.  Applications may request a locale
     change in the middle of a parse.

 -- Method: XMLReader.getFeature (featurename)

     Return the current setting for feature `featurename'.  If the
     feature is not recognized, ‘SAXNotRecognizedException’ is raised.
     The well-known featurenames are listed in the module *note
     xml.sax.handler: 13c.

 -- Method: XMLReader.setFeature (featurename, value)

     Set the `featurename' to `value'.  If the feature is not
     recognized, ‘SAXNotRecognizedException’ is raised.  If the feature
     or its setting is not supported by the parser,
     `SAXNotSupportedException' is raised.

 -- Method: XMLReader.getProperty (propertyname)

     Return the current setting for property `propertyname'.  If the
     property is not recognized, a ‘SAXNotRecognizedException’ is
     raised.  The well-known propertynames are listed in the module
     *note xml.sax.handler: 13c.

 -- Method: XMLReader.setProperty (propertyname, value)

     Set the `propertyname' to `value'.  If the property is not
     recognized, ‘SAXNotRecognizedException’ is raised.  If the property
     or its setting is not supported by the parser,
     `SAXNotSupportedException' is raised.


File: python.info,  Node: IncrementalParser Objects,  Next: Locator Objects,  Prev: XMLReader Objects,  Up: xml sax xmlreader — Interface for XML parsers

5.21.12.2 IncrementalParser Objects
...................................

Instances of *note IncrementalParser: 2a6b. offer the following
additional methods:

 -- Method: IncrementalParser.feed (data)

     Process a chunk of `data'.

 -- Method: IncrementalParser.close ()

     Assume the end of the document.  That will check well-formedness
     conditions that can be checked only at the end, invoke handlers,
     and may clean up resources allocated during parsing.

 -- Method: IncrementalParser.reset ()

     This method is called after close has been called to reset the
     parser so that it is ready to parse new documents.  The results of
     calling parse or feed after close without calling reset are
     undefined.


File: python.info,  Node: Locator Objects,  Next: InputSource Objects,  Prev: IncrementalParser Objects,  Up: xml sax xmlreader — Interface for XML parsers

5.21.12.3 Locator Objects
.........................

Instances of *note Locator: 2a2d. provide these methods:

 -- Method: Locator.getColumnNumber ()

     Return the column number where the current event begins.

 -- Method: Locator.getLineNumber ()

     Return the line number where the current event begins.

 -- Method: Locator.getPublicId ()

     Return the public identifier for the current event.

 -- Method: Locator.getSystemId ()

     Return the system identifier for the current event.


File: python.info,  Node: InputSource Objects,  Next: The Attributes Interface,  Prev: Locator Objects,  Up: xml sax xmlreader — Interface for XML parsers

5.21.12.4 InputSource Objects
.............................

 -- Method: InputSource.setPublicId (id)

     Sets the public identifier of this *note InputSource: 786.

 -- Method: InputSource.getPublicId ()

     Returns the public identifier of this *note InputSource: 786.

 -- Method: InputSource.setSystemId (id)

     Sets the system identifier of this *note InputSource: 786.

 -- Method: InputSource.getSystemId ()

     Returns the system identifier of this *note InputSource: 786.

 -- Method: InputSource.setEncoding (encoding)

     Sets the character encoding of this *note InputSource: 786.

     The encoding must be a string acceptable for an XML encoding
     declaration (see section 4.3.3 of the XML recommendation).

     The encoding attribute of the *note InputSource: 786. is ignored if
     the *note InputSource: 786. also contains a character stream.

 -- Method: InputSource.getEncoding ()

     Get the character encoding of this InputSource.

 -- Method: InputSource.setByteStream (bytefile)

     Set the byte stream (a *note binary file: 1bdb.) for this input
     source.

     The SAX parser will ignore this if there is also a character stream
     specified, but it will use a byte stream in preference to opening a
     URI connection itself.

     If the application knows the character encoding of the byte stream,
     it should set it with the setEncoding method.

 -- Method: InputSource.getByteStream ()

     Get the byte stream for this input source.

     The getEncoding method will return the character encoding for this
     byte stream, or ‘None’ if unknown.

 -- Method: InputSource.setCharacterStream (charfile)

     Set the character stream (a *note text file: 11de.) for this input
     source.

     If there is a character stream specified, the SAX parser will
     ignore any byte stream and will not attempt to open a URI
     connection to the system identifier.

 -- Method: InputSource.getCharacterStream ()

     Get the character stream for this input source.


File: python.info,  Node: The Attributes Interface,  Next: The AttributesNS Interface,  Prev: InputSource Objects,  Up: xml sax xmlreader — Interface for XML parsers

5.21.12.5 The ‘Attributes’ Interface
....................................

‘Attributes’ objects implement a portion of the *note mapping protocol:
b2c, including the methods ‘copy()’, ‘get()’, *note __contains__(): d1b,
‘items()’, ‘keys()’, and ‘values()’.  The following methods are also
provided:

 -- Method: Attributes.getLength ()

     Return the number of attributes.

 -- Method: Attributes.getNames ()

     Return the names of the attributes.

 -- Method: Attributes.getType (name)

     Returns the type of the attribute `name', which is normally
     ‘'CDATA'’.

 -- Method: Attributes.getValue (name)

     Return the value of attribute `name'.


File: python.info,  Node: The AttributesNS Interface,  Prev: The Attributes Interface,  Up: xml sax xmlreader — Interface for XML parsers

5.21.12.6 The ‘AttributesNS’ Interface
......................................

This interface is a subtype of the ‘Attributes’ interface (see section
*note The Attributes Interface: 2a4d.).  All methods supported by that
interface are also available on ‘AttributesNS’ objects.

The following methods are also available:

 -- Method: AttributesNS.getValueByQName (name)

     Return the value for a qualified name.

 -- Method: AttributesNS.getNameByQName (name)

     Return the ‘(namespace, localname)’ pair for a qualified `name'.

 -- Method: AttributesNS.getQNameByName (name)

     Return the qualified name for a ‘(namespace, localname)’ pair.

 -- Method: AttributesNS.getQNames ()

     Return the qualified names of all attributes.


File: python.info,  Node: xml parsers expat — Fast XML parsing using Expat,  Prev: xml sax xmlreader — Interface for XML parsers,  Up: Structured Markup Processing Tools

5.21.13 ‘xml.parsers.expat’ — Fast XML parsing using Expat
----------------------------------------------------------

__________________________________________________________________

     Warning: The ‘pyexpat’ module is not secure against maliciously
     constructed data.  If you need to parse untrusted or
     unauthenticated data see *note XML vulnerabilities: 292c.

The *note xml.parsers.expat: 138. module is a Python interface to the
Expat non-validating XML parser.  The module provides a single extension
type, ‘xmlparser’, that represents the current state of an XML parser.
After an ‘xmlparser’ object has been created, various attributes of the
object can be set to handler functions.  When an XML document is then
fed to the parser, the handler functions are called for the character
data and markup in the XML document.

This module uses the ‘pyexpat’ module to provide access to the Expat
parser.  Direct use of the ‘pyexpat’ module is deprecated.

This module provides one exception and one type object:

 -- Exception: xml.parsers.expat.ExpatError

     The exception raised when Expat reports an error.  See section
     *note ExpatError Exceptions: 2aa0. for more information on
     interpreting Expat errors.

 -- Exception: xml.parsers.expat.error

     Alias for *note ExpatError: c00.

 -- Data: xml.parsers.expat.XMLParserType

     The type of the return values from the *note ParserCreate(): 2aa3.
     function.

The *note xml.parsers.expat: 138. module contains two functions:

 -- Function: xml.parsers.expat.ErrorString (errno)

     Returns an explanatory string for a given error number `errno'.

 -- Function: xml.parsers.expat.ParserCreate (encoding=None,
          namespace_separator=None)

     Creates and returns a new ‘xmlparser’ object.  `encoding', if
     specified, must be a string naming the encoding used by the XML
     data.  Expat doesn’t support as many encodings as Python does, and
     its repertoire of encodings can’t be extended; it supports UTF-8,
     UTF-16, ISO-8859-1 (Latin1), and ASCII. If `encoding' (1) is given
     it will override the implicit or explicit encoding of the document.

     Expat can optionally do XML namespace processing for you, enabled
     by providing a value for `namespace_separator'.  The value must be
     a one-character string; a *note ValueError: 1f9. will be raised if
     the string has an illegal length (‘None’ is considered the same as
     omission).  When namespace processing is enabled, element type
     names and attribute names that belong to a namespace will be
     expanded.  The element name passed to the element handlers
     ‘StartElementHandler’ and ‘EndElementHandler’ will be the
     concatenation of the namespace URI, the namespace separator
     character, and the local part of the name.  If the namespace
     separator is a zero byte (‘chr(0)’) then the namespace URI and the
     local part will be concatenated without any separator.

     For example, if `namespace_separator' is set to a space character
     (‘' '’) and the following document is parsed:

          <?xml version="1.0"?> <root xmlns    = "http://default-namespace.org/"       xmlns:py = "http://www.python.org/ns/">   <py:elem1 />   <elem2 xmlns="" /> </root>

     ‘StartElementHandler’ will receive the following strings for each
     element:

          http://default-namespace.org/ root http://www.python.org/ns/ elem1 elem2

     Due to limitations in the ‘Expat’ library used by ‘pyexpat’, the
     ‘xmlparser’ instance returned can only be used to parse a single
     XML document.  Call ‘ParserCreate’ for each document to provide
     unique parser instances.

See also
........

The Expat XML Parser(2)

     Home page of the Expat project.

* Menu:

* XMLParser Objects: XMLParser Objects<2>.
* ExpatError Exceptions::
* Example: Example<12>.
* Content Model Descriptions::
* Expat error constants::

   ---------- Footnotes ----------

   (1) (1) The encoding string included in XML output should conform to
the appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See
‘https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl’ and
‘https://www.iana.org/assignments/character-sets/character-sets.xhtml’.

   (2) http://www.libexpat.org/


File: python.info,  Node: XMLParser Objects<2>,  Next: ExpatError Exceptions,  Up: xml parsers expat — Fast XML parsing using Expat

5.21.13.1 XMLParser Objects
...........................

‘xmlparser’ objects have the following methods:

 -- Method: xmlparser.Parse (data[, isfinal])

     Parses the contents of the string `data', calling the appropriate
     handler functions to process the parsed data.  `isfinal' must be
     true on the final call to this method; it allows the parsing of a
     single file in fragments, not the submission of multiple files.
     `data' can be the empty string at any time.

 -- Method: xmlparser.ParseFile (file)

     Parse XML data reading from the object `file'.  `file' only needs
     to provide the ‘read(nbytes)’ method, returning the empty string
     when there’s no more data.

 -- Method: xmlparser.SetBase (base)

     Sets the base to be used for resolving relative URIs in system
     identifiers in declarations.  Resolving relative identifiers is
     left to the application: this value will be passed through as the
     `base' argument to the *note ExternalEntityRefHandler(): 2aaa,
     *note NotationDeclHandler(): 2aab, and *note
     UnparsedEntityDeclHandler(): 2aac. functions.

 -- Method: xmlparser.GetBase ()

     Returns a string containing the base set by a previous call to
     *note SetBase(): 2aa9, or ‘None’ if *note SetBase(): 2aa9. hasn’t
     been called.

 -- Method: xmlparser.GetInputContext ()

     Returns the input data that generated the current event as a
     string.  The data is in the encoding of the entity which contains
     the text.  When called while an event handler is not active, the
     return value is ‘None’.

 -- Method: xmlparser.ExternalEntityParserCreate (context[, encoding])

     Create a “child” parser which can be used to parse an external
     parsed entity referred to by content parsed by the parent parser.
     The `context' parameter should be the string passed to the *note
     ExternalEntityRefHandler(): 2aaa. handler function, described
     below.  The child parser is created with the *note
     ordered_attributes: 2ab0. and *note specified_attributes: 2ab1. set
     to the values of this parser.

 -- Method: xmlparser.SetParamEntityParsing (flag)

     Control parsing of parameter entities (including the external DTD
     subset).  Possible `flag' values are
     ‘XML_PARAM_ENTITY_PARSING_NEVER’,
     ‘XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE’ and
     ‘XML_PARAM_ENTITY_PARSING_ALWAYS’.  Return true if setting the flag
     was successful.

 -- Method: xmlparser.UseForeignDTD ([flag])

     Calling this with a true value for `flag' (the default) will cause
     Expat to call the *note ExternalEntityRefHandler: 2aaa. with *note
     None: 157. for all arguments to allow an alternate DTD to be
     loaded.  If the document does not contain a document type
     declaration, the *note ExternalEntityRefHandler: 2aaa. will still
     be called, but the *note StartDoctypeDeclHandler: 2ab4. and *note
     EndDoctypeDeclHandler: 2ab5. will not be called.

     Passing a false value for `flag' will cancel a previous call that
     passed a true value, but otherwise has no effect.

     This method can only be called before the *note Parse(): 2aa7. or
     *note ParseFile(): 2aa8. methods are called; calling it after
     either of those have been called causes *note ExpatError: c00. to
     be raised with the *note code: 1b. attribute set to
     ‘errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]’.

‘xmlparser’ objects have the following attributes:

 -- Attribute: xmlparser.buffer_size

     The size of the buffer used when *note buffer_text: 2ab7. is true.
     A new buffer size can be set by assigning a new integer value to
     this attribute.  When the size is changed, the buffer will be
     flushed.

 -- Attribute: xmlparser.buffer_text

     Setting this to true causes the ‘xmlparser’ object to buffer
     textual content returned by Expat to avoid multiple calls to the
     *note CharacterDataHandler(): 2ab8. callback whenever possible.
     This can improve performance substantially since Expat normally
     breaks character data into chunks at every line ending.  This
     attribute is false by default, and may be changed at any time.

 -- Attribute: xmlparser.buffer_used

     If *note buffer_text: 2ab7. is enabled, the number of bytes stored
     in the buffer.  These bytes represent UTF-8 encoded text.  This
     attribute has no meaningful interpretation when *note buffer_text:
     2ab7. is false.

 -- Attribute: xmlparser.ordered_attributes

     Setting this attribute to a non-zero integer causes the attributes
     to be reported as a list rather than a dictionary.  The attributes
     are presented in the order found in the document text.  For each
     attribute, two list entries are presented: the attribute name and
     the attribute value.  (Older versions of this module also used this
     format.)  By default, this attribute is false; it may be changed at
     any time.

 -- Attribute: xmlparser.specified_attributes

     If set to a non-zero integer, the parser will report only those
     attributes which were specified in the document instance and not
     those which were derived from attribute declarations.  Applications
     which set this need to be especially careful to use what additional
     information is available from the declarations as needed to comply
     with the standards for the behavior of XML processors.  By default,
     this attribute is false; it may be changed at any time.

The following attributes contain values relating to the most recent
error encountered by an ‘xmlparser’ object, and will only have correct
values once a call to ‘Parse()’ or ‘ParseFile()’ has raised an *note
xml.parsers.expat.ExpatError: c00. exception.

 -- Attribute: xmlparser.ErrorByteIndex

     Byte index at which an error occurred.

 -- Attribute: xmlparser.ErrorCode

     Numeric code specifying the problem.  This value can be passed to
     the *note ErrorString(): 2aa4. function, or compared to one of the
     constants defined in the ‘errors’ object.

 -- Attribute: xmlparser.ErrorColumnNumber

     Column number at which an error occurred.

 -- Attribute: xmlparser.ErrorLineNumber

     Line number at which an error occurred.

The following attributes contain values relating to the current parse
location in an ‘xmlparser’ object.  During a callback reporting a parse
event they indicate the location of the first of the sequence of
characters that generated the event.  When called outside of a callback,
the position indicated will be just past the last parse event
(regardless of whether there was an associated callback).

 -- Attribute: xmlparser.CurrentByteIndex

     Current byte index in the parser input.

 -- Attribute: xmlparser.CurrentColumnNumber

     Current column number in the parser input.

 -- Attribute: xmlparser.CurrentLineNumber

     Current line number in the parser input.

Here is the list of handlers that can be set.  To set a handler on an
‘xmlparser’ object `o', use ‘o.handlername = func’.  `handlername' must
be taken from the following list, and `func' must be a callable object
accepting the correct number of arguments.  The arguments are all
strings, unless otherwise stated.

 -- Method: xmlparser.XmlDeclHandler (version, encoding, standalone)

     Called when the XML declaration is parsed.  The XML declaration is
     the (optional) declaration of the applicable version of the XML
     recommendation, the encoding of the document text, and an optional
     “standalone” declaration.  `version' and `encoding' will be
     strings, and `standalone' will be ‘1’ if the document is declared
     standalone, ‘0’ if it is declared not to be standalone, or ‘-1’ if
     the standalone clause was omitted.  This is only available with
     Expat version 1.95.0 or newer.

 -- Method: xmlparser.StartDoctypeDeclHandler (doctypeName, systemId,
          publicId, has_internal_subset)

     Called when Expat begins parsing the document type declaration
     (‘<!DOCTYPE ...’).  The `doctypeName' is provided exactly as
     presented.  The `systemId' and `publicId' parameters give the
     system and public identifiers if specified, or ‘None’ if omitted.
     `has_internal_subset' will be true if the document contains and
     internal document declaration subset.  This requires Expat version
     1.2 or newer.

 -- Method: xmlparser.EndDoctypeDeclHandler ()

     Called when Expat is done parsing the document type declaration.
     This requires Expat version 1.2 or newer.

 -- Method: xmlparser.ElementDeclHandler (name, model)

     Called once for each element type declaration.  `name' is the name
     of the element type, and `model' is a representation of the content
     model.

 -- Method: xmlparser.AttlistDeclHandler (elname, attname, type,
          default, required)

     Called for each declared attribute for an element type.  If an
     attribute list declaration declares three attributes, this handler
     is called three times, once for each attribute.  `elname' is the
     name of the element to which the declaration applies and `attname'
     is the name of the attribute declared.  The attribute type is a
     string passed as `type'; the possible values are ‘'CDATA'’, ‘'ID'’,
     ‘'IDREF'’, … `default' gives the default value for the attribute
     used when the attribute is not specified by the document instance,
     or ‘None’ if there is no default value (‘#IMPLIED’ values).  If the
     attribute is required to be given in the document instance,
     `required' will be true.  This requires Expat version 1.95.0 or
     newer.

 -- Method: xmlparser.StartElementHandler (name, attributes)

     Called for the start of every element.  `name' is a string
     containing the element name, and `attributes' is the element
     attributes.  If *note ordered_attributes: 2ab0. is true, this is a
     list (see *note ordered_attributes: 2ab0. for a full description).
     Otherwise it’s a dictionary mapping names to values.

 -- Method: xmlparser.EndElementHandler (name)

     Called for the end of every element.

 -- Method: xmlparser.ProcessingInstructionHandler (target, data)

     Called for every processing instruction.

 -- Method: xmlparser.CharacterDataHandler (data)

     Called for character data.  This will be called for normal
     character data, CDATA marked content, and ignorable whitespace.
     Applications which must distinguish these cases can use the *note
     StartCdataSectionHandler: 2ac7, *note EndCdataSectionHandler: 2ac8,
     and *note ElementDeclHandler: 2ac2. callbacks to collect the
     required information.

 -- Method: xmlparser.UnparsedEntityDeclHandler (entityName, base,
          systemId, publicId, notationName)

     Called for unparsed (NDATA) entity declarations.  This is only
     present for version 1.2 of the Expat library; for more recent
     versions, use *note EntityDeclHandler: 2ac9. instead.  (The
     underlying function in the Expat library has been declared
     obsolete.)

 -- Method: xmlparser.EntityDeclHandler (entityName,
          is_parameter_entity, value, base, systemId, publicId,
          notationName)

     Called for all entity declarations.  For parameter and internal
     entities, `value' will be a string giving the declared contents of
     the entity; this will be ‘None’ for external entities.  The
     `notationName' parameter will be ‘None’ for parsed entities, and
     the name of the notation for unparsed entities.
     `is_parameter_entity' will be true if the entity is a parameter
     entity or false for general entities (most applications only need
     to be concerned with general entities).  This is only available
     starting with version 1.95.0 of the Expat library.

 -- Method: xmlparser.NotationDeclHandler (notationName, base, systemId,
          publicId)

     Called for notation declarations.  `notationName', `base', and
     `systemId', and `publicId' are strings if given.  If the public
     identifier is omitted, `publicId' will be ‘None’.

 -- Method: xmlparser.StartNamespaceDeclHandler (prefix, uri)

     Called when an element contains a namespace declaration.  Namespace
     declarations are processed before the *note StartElementHandler:
     2ac4. is called for the element on which declarations are placed.

 -- Method: xmlparser.EndNamespaceDeclHandler (prefix)

     Called when the closing tag is reached for an element that
     contained a namespace declaration.  This is called once for each
     namespace declaration on the element in the reverse of the order
     for which the *note StartNamespaceDeclHandler: 2aca. was called to
     indicate the start of each namespace declaration’s scope.  Calls to
     this handler are made after the corresponding *note
     EndElementHandler: 2ac5. for the end of the element.

 -- Method: xmlparser.CommentHandler (data)

     Called for comments.  `data' is the text of the comment, excluding
     the leading ‘'<!-’‘-'’ and trailing ‘'-’‘->'’.

 -- Method: xmlparser.StartCdataSectionHandler ()

     Called at the start of a CDATA section.  This and *note
     EndCdataSectionHandler: 2ac8. are needed to be able to identify the
     syntactical start and end for CDATA sections.

 -- Method: xmlparser.EndCdataSectionHandler ()

     Called at the end of a CDATA section.

 -- Method: xmlparser.DefaultHandler (data)

     Called for any characters in the XML document for which no
     applicable handler has been specified.  This means characters that
     are part of a construct which could be reported, but for which no
     handler has been supplied.

 -- Method: xmlparser.DefaultHandlerExpand (data)

     This is the same as the *note DefaultHandler(): 2acd, but doesn’t
     inhibit expansion of internal entities.  The entity reference will
     not be passed to the default handler.

 -- Method: xmlparser.NotStandaloneHandler ()

     Called if the XML document hasn’t been declared as being a
     standalone document.  This happens when there is an external subset
     or a reference to a parameter entity, but the XML declaration does
     not set standalone to ‘yes’ in an XML declaration.  If this handler
     returns ‘0’, then the parser will raise an
     ‘XML_ERROR_NOT_STANDALONE’ error.  If this handler is not set, no
     exception is raised by the parser for this condition.

 -- Method: xmlparser.ExternalEntityRefHandler (context, base, systemId,
          publicId)

     Called for references to external entities.  `base' is the current
     base, as set by a previous call to *note SetBase(): 2aa9.  The
     public and system identifiers, `systemId' and `publicId', are
     strings if given; if the public identifier is not given, `publicId'
     will be ‘None’.  The `context' value is opaque and should only be
     used as described below.

     For external entities to be parsed, this handler must be
     implemented.  It is responsible for creating the sub-parser using
     ‘ExternalEntityParserCreate(context)’, initializing it with the
     appropriate callbacks, and parsing the entity.  This handler should
     return an integer; if it returns ‘0’, the parser will raise an
     ‘XML_ERROR_EXTERNAL_ENTITY_HANDLING’ error, otherwise parsing will
     continue.

     If this handler is not provided, external entities are reported by
     the *note DefaultHandler: 2acd. callback, if provided.


File: python.info,  Node: ExpatError Exceptions,  Next: Example<12>,  Prev: XMLParser Objects<2>,  Up: xml parsers expat — Fast XML parsing using Expat

5.21.13.2 ExpatError Exceptions
...............................

*note ExpatError: c00. exceptions have a number of interesting
attributes:

 -- Attribute: ExpatError.code

     Expat’s internal error number for the specific error.  The *note
     errors.messages: 2ad2. dictionary maps these error numbers to
     Expat’s error messages.  For example:

          from xml.parsers.expat import ParserCreate, ExpatError, errors  p = ParserCreate() try:     p.Parse(some_xml_document) except ExpatError as err:     print("Error:", errors.messages[err.code])

     The *note errors: 139. module also provides error message constants
     and a dictionary *note codes: 2ad3. mapping these messages back to
     the error codes, see below.

 -- Attribute: ExpatError.lineno

     Line number on which the error was detected.  The first line is
     numbered ‘1’.

 -- Attribute: ExpatError.offset

     Character offset into the line where the error occurred.  The first
     column is numbered ‘0’.


File: python.info,  Node: Example<12>,  Next: Content Model Descriptions,  Prev: ExpatError Exceptions,  Up: xml parsers expat — Fast XML parsing using Expat

5.21.13.3 Example
.................

The following program defines three handlers that just print out their
arguments.

     import xml.parsers.expat  # 3 handler functions def start_element(name, attrs):     print('Start element:', name, attrs) def end_element(name):     print('End element:', name) def char_data(data):     print('Character data:', repr(data))  p = xml.parsers.expat.ParserCreate()  p.StartElementHandler = start_element p.EndElementHandler = end_element p.CharacterDataHandler = char_data  p.Parse("""<?xml version="1.0"?> <parent id="top"><child1 name="paul">Text goes here</child1> <child2 name="fred">More text</child2> </parent>""", 1)

The output from this program is:

     Start element: parent {'id': 'top'} Start element: child1 {'name': 'paul'} Character data: 'Text goes here' End element: child1 Character data: '\n' Start element: child2 {'name': 'fred'} Character data: 'More text' End element: child2 Character data: '\n' End element: parent


File: python.info,  Node: Content Model Descriptions,  Next: Expat error constants,  Prev: Example<12>,  Up: xml parsers expat — Fast XML parsing using Expat

5.21.13.4 Content Model Descriptions
....................................

Content models are described using nested tuples.  Each tuple contains
four values: the type, the quantifier, the name, and a tuple of
children.  Children are simply additional content model descriptions.

The values of the first two fields are constants defined in the *note
xml.parsers.expat.model: 13a. module.  These constants can be collected
in two groups: the model type group and the quantifier group.

The constants in the model type group are:

 -- Data: xml.parsers.expat.model.XML_CTYPE_ANY

     The element named by the model name was declared to have a content
     model of ‘ANY’.

 -- Data: xml.parsers.expat.model.XML_CTYPE_CHOICE

     The named element allows a choice from a number of options; this is
     used for content models such as ‘(A | B | C)’.

 -- Data: xml.parsers.expat.model.XML_CTYPE_EMPTY

     Elements which are declared to be ‘EMPTY’ have this model type.

 -- Data: xml.parsers.expat.model.XML_CTYPE_MIXED

 -- Data: xml.parsers.expat.model.XML_CTYPE_NAME

 -- Data: xml.parsers.expat.model.XML_CTYPE_SEQ

     Models which represent a series of models which follow one after
     the other are indicated with this model type.  This is used for
     models such as ‘(A, B, C)’.

The constants in the quantifier group are:

 -- Data: xml.parsers.expat.model.XML_CQUANT_NONE

     No modifier is given, so it can appear exactly once, as for ‘A’.

 -- Data: xml.parsers.expat.model.XML_CQUANT_OPT

     The model is optional: it can appear once or not at all, as for
     ‘A?’.

 -- Data: xml.parsers.expat.model.XML_CQUANT_PLUS

     The model must occur one or more times (like ‘A+’).

 -- Data: xml.parsers.expat.model.XML_CQUANT_REP

     The model must occur zero or more times, as for ‘A*’.


File: python.info,  Node: Expat error constants,  Prev: Content Model Descriptions,  Up: xml parsers expat — Fast XML parsing using Expat

5.21.13.5 Expat error constants
...............................

The following constants are provided in the *note
xml.parsers.expat.errors: 139. module.  These constants are useful in
interpreting some of the attributes of the ‘ExpatError’ exception
objects raised when an error has occurred.  Since for backwards
compatibility reasons, the constants’ value is the error `message' and
not the numeric error `code', you do this by comparing its *note code:
1b. attribute with ‘errors.codes[errors.XML_ERROR_`CONSTANT_NAME']’.

The ‘errors’ module has the following attributes:

 -- Data: xml.parsers.expat.errors.codes

     A dictionary mapping numeric error codes to their string
     descriptions.

     New in version 3.2.

 -- Data: xml.parsers.expat.errors.messages

     A dictionary mapping string descriptions to their error codes.

     New in version 3.2.

 -- Data: xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY

 -- Data:
          xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF

     An entity reference in an attribute value referred to an external
     entity instead of an internal entity.

 -- Data: xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF

     A character reference referred to a character which is illegal in
     XML (for example, character ‘0’, or ‘‘&#0;’’).

 -- Data: xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF

     An entity reference referred to an entity which was declared with a
     notation, so cannot be parsed.

 -- Data: xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE

     An attribute was used more than once in a start tag.

 -- Data: xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING

 -- Data: xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN

     Raised when an input byte could not properly be assigned to a
     character; for example, a NUL byte (value ‘0’) in a UTF-8 input
     stream.

 -- Data: xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT

     Something other than whitespace occurred after the document
     element.

 -- Data: xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI

     An XML declaration was found somewhere other than the start of the
     input data.

 -- Data: xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS

     The document contains no elements (XML requires all documents to
     contain exactly one top-level element)..

 -- Data: xml.parsers.expat.errors.XML_ERROR_NO_MEMORY

     Expat was not able to allocate memory internally.

 -- Data: xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF

     A parameter entity reference was found where it was not allowed.

 -- Data: xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR

     An incomplete character was found in the input.

 -- Data: xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF

     An entity reference contained another reference to the same entity;
     possibly via a different name, and possibly indirectly.

 -- Data: xml.parsers.expat.errors.XML_ERROR_SYNTAX

     Some unspecified syntax error was encountered.

 -- Data: xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH

     An end tag did not match the innermost open start tag.

 -- Data: xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN

     Some token (such as a start tag) was not closed before the end of
     the stream or the next token was encountered.

 -- Data: xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY

     A reference was made to an entity which was not defined.

 -- Data: xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING

     The document encoding is not supported by Expat.

 -- Data: xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION

     A CDATA marked section was not closed.

 -- Data: xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING

 -- Data: xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE

     The parser determined that the document was not “standalone” though
     it declared itself to be in the XML declaration, and the
     ‘NotStandaloneHandler’ was set and returned ‘0’.

 -- Data: xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE

 -- Data: xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE

 -- Data: xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD

     An operation was requested that requires DTD support to be compiled
     in, but Expat was configured without DTD support.  This should
     never be reported by a standard build of the *note
     xml.parsers.expat: 138. module.

 -- Data:
          xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING

     A behavioral change was requested after parsing started that can
     only be changed before parsing has started.  This is (currently)
     only raised by ‘UseForeignDTD()’.

 -- Data: xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX

     An undeclared prefix was found when namespace processing was
     enabled.

 -- Data: xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX

     The document attempted to remove the namespace declaration
     associated with a prefix.

 -- Data: xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE

     A parameter entity contained incomplete markup.

 -- Data: xml.parsers.expat.errors.XML_ERROR_XML_DECL

     The document contained no document element at all.

 -- Data: xml.parsers.expat.errors.XML_ERROR_TEXT_DECL

     There was an error parsing a text declaration in an external
     entity.

 -- Data: xml.parsers.expat.errors.XML_ERROR_PUBLICID

     Characters were found in the public id that are not allowed.

 -- Data: xml.parsers.expat.errors.XML_ERROR_SUSPENDED

     The requested operation was made on a suspended parser, but isn’t
     allowed.  This includes attempts to provide additional input or to
     stop the parser.

 -- Data: xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED

     An attempt to resume the parser was made when the parser had not
     been suspended.

 -- Data: xml.parsers.expat.errors.XML_ERROR_ABORTED

     This should not be reported to Python applications.

 -- Data: xml.parsers.expat.errors.XML_ERROR_FINISHED

     The requested operation was made on a parser which was finished
     parsing input, but isn’t allowed.  This includes attempts to
     provide additional input or to stop the parser.

 -- Data: xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE


File: python.info,  Node: Internet Protocols and Support,  Next: Multimedia Services,  Prev: Structured Markup Processing Tools,  Up: The Python Standard Library

5.22 Internet Protocols and Support
===================================

The modules described in this chapter implement Internet protocols and
support for related technology.  They are all implemented in Python.
Most of these modules require the presence of the system-dependent
module *note socket: ef, which is currently supported on most popular
platforms.  Here is an overview:

* Menu:

* webbrowser — Convenient Web-browser controller::
* cgi — Common Gateway Interface support::
* cgitb — Traceback manager for CGI scripts::
* wsgiref — WSGI Utilities and Reference Implementation::
* urllib — URL handling modules::
* urllib.request — Extensible library for opening URLs: urllib request — Extensible library for opening URLs.
* urllib.response — Response classes used by urllib: urllib response — Response classes used by urllib.
* urllib.parse — Parse URLs into components: urllib parse — Parse URLs into components.
* urllib.error — Exception classes raised by urllib.request: urllib error — Exception classes raised by urllib request.
* urllib.robotparser — Parser for robots.txt: urllib robotparser — Parser for robots txt.
* http — HTTP modules::
* http.client — HTTP protocol client: http client — HTTP protocol client.
* ftplib — FTP protocol client::
* poplib — POP3 protocol client::
* imaplib — IMAP4 protocol client::
* nntplib — NNTP protocol client::
* smtplib — SMTP protocol client::
* smtpd — SMTP Server::
* telnetlib — Telnet client::
* uuid — UUID objects according to RFC 4122::
* socketserver — A framework for network servers::
* http.server — HTTP servers: http server — HTTP servers.
* http.cookies — HTTP state management: http cookies — HTTP state management.
* http.cookiejar — Cookie handling for HTTP clients: http cookiejar — Cookie handling for HTTP clients.
* xmlrpc — XMLRPC server and client modules::
* xmlrpc.client — XML-RPC client access: xmlrpc client — XML-RPC client access.
* xmlrpc.server — Basic XML-RPC servers: xmlrpc server — Basic XML-RPC servers.
* ipaddress — IPv4/IPv6 manipulation library::


File: python.info,  Node: webbrowser — Convenient Web-browser controller,  Next: cgi — Common Gateway Interface support,  Up: Internet Protocols and Support

5.22.1 ‘webbrowser’ — Convenient Web-browser controller
-------------------------------------------------------

`Source code:' Lib/webbrowser.py(1)

__________________________________________________________________

The *note webbrowser: 129. module provides a high-level interface to
allow displaying Web-based documents to users.  Under most
circumstances, simply calling the *note open(): 2b06. function from this
module will do the right thing.

Under Unix, graphical browsers are preferred under X11, but text-mode
browsers will be used if graphical browsers are not available or an X11
display isn’t available.  If text-mode browsers are used, the calling
process will block until the user exits the browser.

If the environment variable ‘BROWSER’ exists, it is interpreted as the
*note os.pathsep: 1290.-separated list of browsers to try ahead of the
platform defaults.  When the value of a list part contains the string
‘%s’, then it is interpreted as a literal browser command line to be
used with the argument URL substituted for ‘%s’; if the part does not
contain ‘%s’, it is simply interpreted as the name of the browser to
launch.  (2)

For non-Unix platforms, or when a remote browser is available on Unix,
the controlling process will not wait for the user to finish with the
browser, but allow the remote browser to maintain its own windows on the
display.  If remote browsers are not available on Unix, the controlling
process will launch a new browser and wait.

The script ‘webbrowser’ can be used as a command-line interface for the
module.  It accepts a URL as the argument.  It accepts the following
optional parameters: ‘-n’ opens the URL in a new browser window, if
possible; ‘-t’ opens the URL in a new browser page (“tab”).  The options
are, naturally, mutually exclusive.  Usage example:

     python -m webbrowser -t "http://www.python.org"

The following exception is defined:

 -- Exception: webbrowser.Error

     Exception raised when a browser control error occurs.

The following functions are defined:

 -- Function: webbrowser.open (url, new=0, autoraise=True)

     Display `url' using the default browser.  If `new' is 0, the `url'
     is opened in the same browser window if possible.  If `new' is 1, a
     new browser window is opened if possible.  If `new' is 2, a new
     browser page (“tab”) is opened if possible.  If `autoraise' is
     ‘True’, the window is raised if possible (note that under many
     window managers this will occur regardless of the setting of this
     variable).

     Note that on some platforms, trying to open a filename using this
     function, may work and start the operating system’s associated
     program.  However, this is neither supported nor portable.

     Raises an *note auditing event: 1275. ‘webbrowser.open’ with
     argument ‘url’.

 -- Function: webbrowser.open_new (url)

     Open `url' in a new window of the default browser, if possible,
     otherwise, open `url' in the only browser window.

 -- Function: webbrowser.open_new_tab (url)

     Open `url' in a new page (“tab”) of the default browser, if
     possible, otherwise equivalent to *note open_new(): 2b08.

 -- Function: webbrowser.get (using=None)

     Return a controller object for the browser type `using'.  If
     `using' is ‘None’, return a controller for a default browser
     appropriate to the caller’s environment.

 -- Function: webbrowser.register (name, constructor, instance=None, *,
          preferred=False)

     Register the browser type `name'.  Once a browser type is
     registered, the *note get(): 2b0a. function can return a controller
     for that browser type.  If `instance' is not provided, or is
     ‘None’, `constructor' will be called without parameters to create
     an instance when needed.  If `instance' is provided, `constructor'
     will never be called, and may be ‘None’.

     Setting `preferred' to ‘True’ makes this browser a preferred result
     for a *note get(): 2b0a. call with no argument.  Otherwise, this
     entry point is only useful if you plan to either set the ‘BROWSER’
     variable or call *note get(): 2b0a. with a nonempty argument
     matching the name of a handler you declare.

     Changed in version 3.7: `preferred' keyword-only parameter was
     added.

A number of browser types are predefined.  This table gives the type
names that may be passed to the *note get(): 2b0a. function and the
corresponding instantiations for the controller classes, all defined in
this module.

Type Name                    Class Name                                    Notes
                                                                           
---------------------------------------------------------------------------------------
                                                                           
‘'mozilla'’                  ‘Mozilla('mozilla')’
                             
                                                                           
‘'firefox'’                  ‘Mozilla('mozilla')’
                             
                                                                           
‘'netscape'’                 ‘Mozilla('netscape')’
                             
                                                                           
‘'galeon'’                   ‘Galeon('galeon')’
                             
                                                                           
‘'epiphany'’                 ‘Galeon('epiphany')’
                             
                                                                           
‘'skipstone'’                ‘BackgroundBrowser('skipstone')’
                             
                                                                           
‘'kfmclient'’                ‘Konqueror()’                                 (1)
                                                                           
                                                                           
‘'konqueror'’                ‘Konqueror()’                                 (1)
                                                                           
                                                                           
‘'kfm'’                      ‘Konqueror()’                                 (1)
                                                                           
                                                                           
‘'mosaic'’                   ‘BackgroundBrowser('mosaic')’
                             
                                                                           
‘'opera'’                    ‘Opera()’
                             
                                                                           
‘'grail'’                    ‘Grail()’
                             
                                                                           
‘'links'’                    ‘GenericBrowser('links')’
                             
                                                                           
‘'elinks'’                   ‘Elinks('elinks')’
                             
                                                                           
‘'lynx'’                     ‘GenericBrowser('lynx')’
                             
                                                                           
‘'w3m'’                      ‘GenericBrowser('w3m')’
                             
                                                                           
‘'windows-default'’          ‘WindowsDefault’                              (2)
                                                                           
                                                                           
‘'macosx'’                   ‘MacOSX('default')’                           (3)
                                                                           
                                                                           
‘'safari'’                   ‘MacOSX('safari')’                            (3)
                                                                           
                                                                           
‘'google-chrome'’            ‘Chrome('google-chrome')’
                             
                                                                           
‘'chrome'’                   ‘Chrome('chrome')’
                             
                                                                           
‘'chromium'’                 ‘Chromium('chromium')’
                             
                                                                           
‘'chromium-browser'’         ‘Chromium('chromium-browser')’
                             

Notes:

  1. “Konqueror” is the file manager for the KDE desktop environment for
     Unix, and only makes sense to use if KDE is running.  Some way of
     reliably detecting KDE would be nice; the ‘KDEDIR’ variable is not
     sufficient.  Note also that the name “kfm” is used even when using
     the ‘konqueror’ command with KDE 2 — the implementation selects the
     best strategy for running Konqueror.

  2. Only on Windows platforms.

  3. Only on Mac OS X platform.

New in version 3.3: Support for Chrome/Chromium has been added.

Here are some simple examples:

     url = 'http://docs.python.org/'  # Open URL in a new tab, if a browser window is already open. webbrowser.open_new_tab(url)  # Open URL in new window, raising the window if possible. webbrowser.open_new(url)

* Menu:

* Browser Controller Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/webbrowser.py

   (2) (1) Executables named here without a full path will be searched
in the directories given in the ‘PATH’ environment variable.


File: python.info,  Node: Browser Controller Objects,  Up: webbrowser — Convenient Web-browser controller

5.22.1.1 Browser Controller Objects
...................................

Browser controllers provide these methods which parallel three of the
module-level convenience functions:

 -- Method: controller.open (url, new=0, autoraise=True)

     Display `url' using the browser handled by this controller.  If
     `new' is 1, a new browser window is opened if possible.  If `new'
     is 2, a new browser page (“tab”) is opened if possible.

 -- Method: controller.open_new (url)

     Open `url' in a new window of the browser handled by this
     controller, if possible, otherwise, open `url' in the only browser
     window.  Alias *note open_new(): 2b08.

 -- Method: controller.open_new_tab (url)

     Open `url' in a new page (“tab”) of the browser handled by this
     controller, if possible, otherwise equivalent to *note open_new():
     2b08.


File: python.info,  Node: cgi — Common Gateway Interface support,  Next: cgitb — Traceback manager for CGI scripts,  Prev: webbrowser — Convenient Web-browser controller,  Up: Internet Protocols and Support

5.22.2 ‘cgi’ — Common Gateway Interface support
-----------------------------------------------

`Source code:' Lib/cgi.py(1)

__________________________________________________________________

Support module for Common Gateway Interface (CGI) scripts.

This module defines a number of utilities for use by CGI scripts written
in Python.

* Menu:

* Introduction: Introduction<10>.
* Using the cgi module::
* Higher Level Interface::
* Functions: Functions<8>.
* Caring about security::
* Installing your CGI script on a Unix system::
* Testing your CGI script::
* Debugging CGI scripts::
* Common problems and solutions::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/cgi.py


File: python.info,  Node: Introduction<10>,  Next: Using the cgi module,  Up: cgi — Common Gateway Interface support

5.22.2.1 Introduction
.....................

A CGI script is invoked by an HTTP server, usually to process user input
submitted through an HTML ‘<FORM>’ or ‘<ISINDEX>’ element.

Most often, CGI scripts live in the server’s special ‘cgi-bin’
directory.  The HTTP server places all sorts of information about the
request (such as the client’s hostname, the requested URL, the query
string, and lots of other goodies) in the script’s shell environment,
executes the script, and sends the script’s output back to the client.

The script’s input is connected to the client too, and sometimes the
form data is read this way; at other times the form data is passed via
the “query string” part of the URL. This module is intended to take care
of the different cases and provide a simpler interface to the Python
script.  It also provides a number of utilities that help in debugging
scripts, and the latest addition is support for file uploads from a form
(if your browser supports it).

The output of a CGI script should consist of two sections, separated by
a blank line.  The first section contains a number of headers, telling
the client what kind of data is following.  Python code to generate a
minimal header section looks like this:

     print("Content-Type: text/html")    # HTML is following print()                             # blank line, end of headers

The second section is usually HTML, which allows the client software to
display nicely formatted text with header, in-line images, etc.  Here’s
Python code that prints a simple piece of HTML:

     print("<TITLE>CGI script output</TITLE>") print("<H1>This is my first CGI script</H1>") print("Hello, world!")


File: python.info,  Node: Using the cgi module,  Next: Higher Level Interface,  Prev: Introduction<10>,  Up: cgi — Common Gateway Interface support

5.22.2.2 Using the cgi module
.............................

Begin by writing ‘import cgi’.

When you write a new script, consider adding these lines:

     import cgitb cgitb.enable()

This activates a special exception handler that will display detailed
reports in the Web browser if any errors occur.  If you’d rather not
show the guts of your program to users of your script, you can have the
reports saved to files instead, with code like this:

     import cgitb cgitb.enable(display=0, logdir="/path/to/logdir")

It’s very helpful to use this feature during script development.  The
reports produced by *note cgitb: 17. provide information that can save
you a lot of time in tracking down bugs.  You can always remove the
‘cgitb’ line later when you have tested your script and are confident
that it works correctly.

To get at submitted form data, use the ‘FieldStorage’ class.  If the
form contains non-ASCII characters, use the `encoding' keyword parameter
set to the value of the encoding defined for the document.  It is
usually contained in the META tag in the HEAD section of the HTML
document or by the ‘Content-Type’ header).  This reads the form contents
from the standard input or the environment (depending on the value of
various environment variables set according to the CGI standard).  Since
it may consume standard input, it should be instantiated only once.

The ‘FieldStorage’ instance can be indexed like a Python dictionary.  It
allows membership testing with the *note in: 797. operator, and also
supports the standard dictionary method *note keys(): c1d. and the
built-in function *note len(): 150.  Form fields containing empty
strings are ignored and do not appear in the dictionary; to keep such
values, provide a true value for the optional `keep_blank_values'
keyword parameter when creating the ‘FieldStorage’ instance.

For instance, the following code (which assumes that the ‘Content-Type’
header and blank line have already been printed) checks that the fields
‘name’ and ‘addr’ are both set to a non-empty string:

     form = cgi.FieldStorage() if "name" not in form or "addr" not in form:     print("<H1>Error</H1>")     print("Please fill in the name and addr fields.")     return print("<p>name:", form["name"].value) print("<p>addr:", form["addr"].value) ...further form processing here...

Here the fields, accessed through ‘form[key]’, are themselves instances
of ‘FieldStorage’ (or ‘MiniFieldStorage’, depending on the form
encoding).  The ‘value’ attribute of the instance yields the string
value of the field.  The ‘getvalue()’ method returns this string value
directly; it also accepts an optional second argument as a default to
return if the requested key is not present.

If the submitted form data contains more than one field with the same
name, the object retrieved by ‘form[key]’ is not a ‘FieldStorage’ or
‘MiniFieldStorage’ instance but a list of such instances.  Similarly, in
this situation, ‘form.getvalue(key)’ would return a list of strings.  If
you expect this possibility (when your HTML form contains multiple
fields with the same name), use the *note getlist(): 2b17. method, which
always returns a list of values (so that you do not need to special-case
the single item case).  For example, this code concatenates any number
of username fields, separated by commas:

     value = form.getlist("username") usernames = ",".join(value)

If a field represents an uploaded file, accessing the value via the
‘value’ attribute or the ‘getvalue()’ method reads the entire file in
memory as bytes.  This may not be what you want.  You can test for an
uploaded file by testing either the ‘filename’ attribute or the ‘file’
attribute.  You can then read the data from the ‘file’ attribute before
it is automatically closed as part of the garbage collection of the
‘FieldStorage’ instance (the *note read(): 6f6. and *note readline():
163f. methods will return bytes):

     fileitem = form["userfile"] if fileitem.file:     # It's an uploaded file; count lines     linecount = 0     while True:         line = fileitem.file.readline()         if not line: break         linecount = linecount + 1

‘FieldStorage’ objects also support being used in a *note with: 6dd.
statement, which will automatically close them when done.

If an error is encountered when obtaining the contents of an uploaded
file (for example, when the user interrupts the form submission by
clicking on a Back or Cancel button) the ‘done’ attribute of the object
for the field will be set to the value -1.

The file upload draft standard entertains the possibility of uploading
multiple files from one field (using a recursive ‘multipart/*’
encoding).  When this occurs, the item will be a dictionary-like
‘FieldStorage’ item.  This can be determined by testing its ‘type’
attribute, which should be ‘multipart/form-data’ (or perhaps another
MIME type matching ‘multipart/*’).  In this case, it can be iterated
over recursively just like the top-level form object.

When a form is submitted in the “old” format (as the query string or as
a single data part of type ‘application/x-www-form-urlencoded’), the
items will actually be instances of the class ‘MiniFieldStorage’.  In
this case, the ‘list’, ‘file’, and ‘filename’ attributes are always
‘None’.

A form submitted via POST that also has a query string will contain both
‘FieldStorage’ and ‘MiniFieldStorage’ items.

Changed in version 3.4: The ‘file’ attribute is automatically closed
upon the garbage collection of the creating ‘FieldStorage’ instance.

Changed in version 3.5: Added support for the context management
protocol to the ‘FieldStorage’ class.


File: python.info,  Node: Higher Level Interface,  Next: Functions<8>,  Prev: Using the cgi module,  Up: cgi — Common Gateway Interface support

5.22.2.3 Higher Level Interface
...............................

The previous section explains how to read CGI form data using the
‘FieldStorage’ class.  This section describes a higher level interface
which was added to this class to allow one to do it in a more readable
and intuitive way.  The interface doesn’t make the techniques described
in previous sections obsolete — they are still useful to process file
uploads efficiently, for example.

The interface consists of two simple methods.  Using the methods you can
process form data in a generic way, without the need to worry whether
only one or more values were posted under one name.

In the previous section, you learned to write following code anytime you
expected a user to post more than one value under one name:

     item = form.getvalue("item") if isinstance(item, list):     # The user is requesting more than one item. else:     # The user is requesting only one item.

This situation is common for example when a form contains a group of
multiple checkboxes with the same name:

     <input type="checkbox" name="item" value="1" /> <input type="checkbox" name="item" value="2" />

In most situations, however, there’s only one form control with a
particular name in a form and then you expect and need only one value
associated with this name.  So you write a script containing for example
this code:

     user = form.getvalue("user").upper()

The problem with the code is that you should never expect that a client
will provide valid input to your scripts.  For example, if a curious
user appends another ‘user=foo’ pair to the query string, then the
script would crash, because in this situation the ‘getvalue("user")’
method call returns a list instead of a string.  Calling the *note
upper(): 159a. method on a list is not valid (since lists do not have a
method of this name) and results in an *note AttributeError: 390.
exception.

Therefore, the appropriate way to read form data values was to always
use the code which checks whether the obtained value is a single value
or a list of values.  That’s annoying and leads to less readable
scripts.

A more convenient approach is to use the methods *note getfirst(): 2b19.
and *note getlist(): 2b17. provided by this higher level interface.

 -- Method: FieldStorage.getfirst (name, default=None)

     This method always returns only one value associated with form
     field `name'.  The method returns only the first value in case that
     more values were posted under such name.  Please note that the
     order in which the values are received may vary from browser to
     browser and should not be counted on.  (1) If no such form field or
     value exists then the method returns the value specified by the
     optional parameter `default'.  This parameter defaults to ‘None’ if
     not specified.

 -- Method: FieldStorage.getlist (name)

     This method always returns a list of values associated with form
     field `name'.  The method returns an empty list if no such form
     field or value exists for `name'.  It returns a list consisting of
     one item if only one such value exists.

Using these methods you can write nice compact code:

     import cgi form = cgi.FieldStorage() user = form.getfirst("user", "").upper()    # This way it's safe. for item in form.getlist("item"):     do_something(item)

   ---------- Footnotes ----------

   (1) (1) Note that some recent versions of the HTML specification do
state what order the field values should be supplied in, but knowing
whether a request was received from a conforming browser, or even from a
browser at all, is tedious and error-prone.


File: python.info,  Node: Functions<8>,  Next: Caring about security,  Prev: Higher Level Interface,  Up: cgi — Common Gateway Interface support

5.22.2.4 Functions
..................

These are useful if you want more control, or if you want to employ some
of the algorithms implemented in this module in other circumstances.

 -- Function: cgi.parse (fp=None, environ=os.environ,
          keep_blank_values=False, strict_parsing=False)

     Parse a query in the environment or from a file (the file defaults
     to ‘sys.stdin’).  The `keep_blank_values' and `strict_parsing'
     parameters are passed to *note urllib.parse.parse_qs(): 2b1d.
     unchanged.

 -- Function: cgi.parse_multipart (fp, pdict, encoding="utf-8",
          errors="replace")

     Parse input of type ‘multipart/form-data’ (for file uploads).
     Arguments are `fp' for the input file, `pdict' for a dictionary
     containing other parameters in the ‘Content-Type’ header, and
     `encoding', the request encoding.

     Returns a dictionary just like *note urllib.parse.parse_qs():
     2b1d.: keys are the field names, each value is a list of values for
     that field.  For non-file fields, the value is a list of strings.

     This is easy to use but not much good if you are expecting
     megabytes to be uploaded — in that case, use the ‘FieldStorage’
     class instead which is much more flexible.

     Changed in version 3.7: Added the `encoding' and `errors'
     parameters.  For non-file fields, the value is now a list of
     strings, not bytes.

 -- Function: cgi.parse_header (string)

     Parse a MIME header (such as ‘Content-Type’) into a main value and
     a dictionary of parameters.

 -- Function: cgi.test ()

     Robust test CGI script, usable as main program.  Writes minimal
     HTTP headers and formats all information provided to the script in
     HTML form.

 -- Function: cgi.print_environ ()

     Format the shell environment in HTML.

 -- Function: cgi.print_form (form)

     Format a form in HTML.

 -- Function: cgi.print_directory ()

     Format the current directory in HTML.

 -- Function: cgi.print_environ_usage ()

     Print a list of useful (used by CGI) environment variables in HTML.


File: python.info,  Node: Caring about security,  Next: Installing your CGI script on a Unix system,  Prev: Functions<8>,  Up: cgi — Common Gateway Interface support

5.22.2.5 Caring about security
..............................

There’s one important rule: if you invoke an external program (via the
*note os.system(): db4. or *note os.popen(): 2a7. functions.  or others
with similar functionality), make very sure you don’t pass arbitrary
strings received from the client to the shell.  This is a well-known
security hole whereby clever hackers anywhere on the Web can exploit a
gullible CGI script to invoke arbitrary shell commands.  Even parts of
the URL or field names cannot be trusted, since the request doesn’t have
to come from your form!

To be on the safe side, if you must pass a string gotten from a form to
a shell command, you should make sure the string contains only
alphanumeric characters, dashes, underscores, and periods.


File: python.info,  Node: Installing your CGI script on a Unix system,  Next: Testing your CGI script,  Prev: Caring about security,  Up: cgi — Common Gateway Interface support

5.22.2.6 Installing your CGI script on a Unix system
....................................................

Read the documentation for your HTTP server and check with your local
system administrator to find the directory where CGI scripts should be
installed; usually this is in a directory ‘cgi-bin’ in the server tree.

Make sure that your script is readable and executable by “others”; the
Unix file mode should be ‘0o755’ octal (use ‘chmod 0755 filename’).
Make sure that the first line of the script contains ‘#!’ starting in
column 1 followed by the pathname of the Python interpreter, for
instance:

     #!/usr/local/bin/python

Make sure the Python interpreter exists and is executable by “others”.

Make sure that any files your script needs to read or write are readable
or writable, respectively, by “others” — their mode should be ‘0o644’
for readable and ‘0o666’ for writable.  This is because, for security
reasons, the HTTP server executes your script as user “nobody”, without
any special privileges.  It can only read (write, execute) files that
everybody can read (write, execute).  The current directory at execution
time is also different (it is usually the server’s cgi-bin directory)
and the set of environment variables is also different from what you get
when you log in.  In particular, don’t count on the shell’s search path
for executables ( ‘PATH’) or the Python module search path ( *note
PYTHONPATH: 947.) to be set to anything interesting.

If you need to load modules from a directory which is not on Python’s
default module search path, you can change the path in your script,
before importing other modules.  For example:

     import sys sys.path.insert(0, "/usr/home/joe/lib/python") sys.path.insert(0, "/usr/local/lib/python")

(This way, the directory inserted last will be searched first!)

Instructions for non-Unix systems will vary; check your HTTP server’s
documentation (it will usually have a section on CGI scripts).


File: python.info,  Node: Testing your CGI script,  Next: Debugging CGI scripts,  Prev: Installing your CGI script on a Unix system,  Up: cgi — Common Gateway Interface support

5.22.2.7 Testing your CGI script
................................

Unfortunately, a CGI script will generally not run when you try it from
the command line, and a script that works perfectly from the command
line may fail mysteriously when run from the server.  There’s one reason
why you should still test your script from the command line: if it
contains a syntax error, the Python interpreter won’t execute it at all,
and the HTTP server will most likely send a cryptic error to the client.

Assuming your script has no syntax errors, yet it does not work, you
have no choice but to read the next section.


File: python.info,  Node: Debugging CGI scripts,  Next: Common problems and solutions,  Prev: Testing your CGI script,  Up: cgi — Common Gateway Interface support

5.22.2.8 Debugging CGI scripts
..............................

First of all, check for trivial installation errors — reading the
section above on installing your CGI script carefully can save you a lot
of time.  If you wonder whether you have understood the installation
procedure correctly, try installing a copy of this module file
(‘cgi.py’) as a CGI script.  When invoked as a script, the file will
dump its environment and the contents of the form in HTML form.  Give it
the right mode etc, and send it a request.  If it’s installed in the
standard ‘cgi-bin’ directory, it should be possible to send it a request
by entering a URL into your browser of the form:

     http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home

If this gives an error of type 404, the server cannot find the script –
perhaps you need to install it in a different directory.  If it gives
another error, there’s an installation problem that you should fix
before trying to go any further.  If you get a nicely formatted listing
of the environment and form content (in this example, the fields should
be listed as “addr” with value “At Home” and “name” with value “Joe
Blow”), the ‘cgi.py’ script has been installed correctly.  If you follow
the same procedure for your own script, you should now be able to debug
it.

The next step could be to call the *note cgi: 16. module’s *note test():
105. function from your script: replace its main code with the single
statement

     cgi.test()

This should produce the same results as those gotten from installing the
‘cgi.py’ file itself.

When an ordinary Python script raises an unhandled exception (for
whatever reason: of a typo in a module name, a file that can’t be
opened, etc.), the Python interpreter prints a nice traceback and exits.
While the Python interpreter will still do this when your CGI script
raises an exception, most likely the traceback will end up in one of the
HTTP server’s log files, or be discarded altogether.

Fortunately, once you have managed to get your script to execute `some'
code, you can easily send tracebacks to the Web browser using the *note
cgitb: 17. module.  If you haven’t done so already, just add the lines:

     import cgitb cgitb.enable()

to the top of your script.  Then try running it again; when a problem
occurs, you should see a detailed report that will likely make apparent
the cause of the crash.

If you suspect that there may be a problem in importing the *note cgitb:
17. module, you can use an even more robust approach (which only uses
built-in modules):

     import sys sys.stderr = sys.stdout print("Content-Type: text/plain") print() ...your code here...

This relies on the Python interpreter to print the traceback.  The
content type of the output is set to plain text, which disables all HTML
processing.  If your script works, the raw HTML will be displayed by
your client.  If it raises an exception, most likely after the first two
lines have been printed, a traceback will be displayed.  Because no HTML
interpretation is going on, the traceback will be readable.


File: python.info,  Node: Common problems and solutions,  Prev: Debugging CGI scripts,  Up: cgi — Common Gateway Interface support

5.22.2.9 Common problems and solutions
......................................

   * Most HTTP servers buffer the output from CGI scripts until the
     script is completed.  This means that it is not possible to display
     a progress report on the client’s display while the script is
     running.

   * Check the installation instructions above.

   * Check the HTTP server’s log files.  (‘tail -f logfile’ in a
     separate window may be useful!)

   * Always check a script for syntax errors first, by doing something
     like ‘python script.py’.

   * If your script does not have any syntax errors, try adding ‘import
     cgitb; cgitb.enable()’ to the top of the script.

   * When invoking external programs, make sure they can be found.
     Usually, this means using absolute path names — ‘PATH’ is usually
     not set to a very useful value in a CGI script.

   * When reading or writing external files, make sure they can be read
     or written by the userid under which your CGI script will be
     running: this is typically the userid under which the web server is
     running, or some explicitly specified userid for a web server’s
     ‘suexec’ feature.

   * Don’t try to give a CGI script a set-uid mode.  This doesn’t work
     on most systems, and is a security liability as well.


File: python.info,  Node: cgitb — Traceback manager for CGI scripts,  Next: wsgiref — WSGI Utilities and Reference Implementation,  Prev: cgi — Common Gateway Interface support,  Up: Internet Protocols and Support

5.22.3 ‘cgitb’ — Traceback manager for CGI scripts
--------------------------------------------------

`Source code:' Lib/cgitb.py(1)

__________________________________________________________________

The *note cgitb: 17. module provides a special exception handler for
Python scripts.  (Its name is a bit misleading.  It was originally
designed to display extensive traceback information in HTML for CGI
scripts.  It was later generalized to also display this information in
plain text.)  After this module is activated, if an uncaught exception
occurs, a detailed, formatted report will be displayed.  The report
includes a traceback showing excerpts of the source code for each level,
as well as the values of the arguments and local variables to currently
running functions, to help you debug the problem.  Optionally, you can
save this information to a file instead of sending it to the browser.

To enable this feature, simply add this to the top of your CGI script:

     import cgitb cgitb.enable()

The options to the *note enable(): 2b2c. function control whether the
report is displayed in the browser and whether the report is logged to a
file for later analysis.

 -- Function: cgitb.enable (display=1, logdir=None, context=5,
          format="html")

     This function causes the *note cgitb: 17. module to take over the
     interpreter’s default handling for exceptions by setting the value
     of *note sys.excepthook: e57.

     The optional argument `display' defaults to ‘1’ and can be set to
     ‘0’ to suppress sending the traceback to the browser.  If the
     argument `logdir' is present, the traceback reports are written to
     files.  The value of `logdir' should be a directory where these
     files will be placed.  The optional argument `context' is the
     number of lines of context to display around the current line of
     source code in the traceback; this defaults to ‘5’.  If the
     optional argument `format' is ‘"html"’, the output is formatted as
     HTML. Any other value forces plain text output.  The default value
     is ‘"html"’.

 -- Function: cgitb.text (info, context=5)

     This function handles the exception described by `info' (a 3-tuple
     containing the result of *note sys.exc_info(): c52.), formatting
     its traceback as text and returning the result as a string.  The
     optional argument `context' is the number of lines of context to
     display around the current line of source code in the traceback;
     this defaults to ‘5’.

 -- Function: cgitb.html (info, context=5)

     This function handles the exception described by `info' (a 3-tuple
     containing the result of *note sys.exc_info(): c52.), formatting
     its traceback as HTML and returning the result as a string.  The
     optional argument `context' is the number of lines of context to
     display around the current line of source code in the traceback;
     this defaults to ‘5’.

 -- Function: cgitb.handler (info=None)

     This function handles an exception using the default settings (that
     is, show a report in the browser, but don’t log to a file).  This
     can be used when you’ve caught an exception and want to report it
     using *note cgitb: 17.  The optional `info' argument should be a
     3-tuple containing an exception type, exception value, and
     traceback object, exactly like the tuple returned by *note
     sys.exc_info(): c52.  If the `info' argument is not supplied, the
     current exception is obtained from *note sys.exc_info(): c52.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/cgitb.py


File: python.info,  Node: wsgiref — WSGI Utilities and Reference Implementation,  Next: urllib — URL handling modules,  Prev: cgitb — Traceback manager for CGI scripts,  Up: Internet Protocols and Support

5.22.4 ‘wsgiref’ — WSGI Utilities and Reference Implementation
--------------------------------------------------------------

__________________________________________________________________

The Web Server Gateway Interface (WSGI) is a standard interface between
web server software and web applications written in Python.  Having a
standard interface makes it easy to use an application that supports
WSGI with a number of different web servers.

Only authors of web servers and programming frameworks need to know
every detail and corner case of the WSGI design.  You don’t need to
understand every detail of WSGI just to install a WSGI application or to
write a web application using an existing framework.

*note wsgiref: 12c. is a reference implementation of the WSGI
specification that can be used to add WSGI support to a web server or
framework.  It provides utilities for manipulating WSGI environment
variables and response headers, base classes for implementing WSGI
servers, a demo HTTP server that serves WSGI applications, and a
validation tool that checks WSGI servers and applications for
conformance to the WSGI specification ( PEP 3333(1)).

See wsgi.readthedocs.io(2) for more information about WSGI, and links to
tutorials and other resources.

* Menu:

* wsgiref.util – WSGI environment utilities: wsgiref util – WSGI environment utilities.
* wsgiref.headers – WSGI response header tools: wsgiref headers – WSGI response header tools.
* wsgiref.simple_server – a simple WSGI HTTP server: wsgiref simple_server – a simple WSGI HTTP server.
* wsgiref.validate — WSGI conformance checker: wsgiref validate — WSGI conformance checker.
* wsgiref.handlers – server/gateway base classes: wsgiref handlers – server/gateway base classes.
* Examples: Examples<20>.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3333

   (2) https://wsgi.readthedocs.io/


File: python.info,  Node: wsgiref util – WSGI environment utilities,  Next: wsgiref headers – WSGI response header tools,  Up: wsgiref — WSGI Utilities and Reference Implementation

5.22.4.1 ‘wsgiref.util’ – WSGI environment utilities
....................................................

This module provides a variety of utility functions for working with
WSGI environments.  A WSGI environment is a dictionary containing HTTP
request variables as described in PEP 3333(1).  All of the functions
taking an `environ' parameter expect a WSGI-compliant dictionary to be
supplied; please see PEP 3333(2) for a detailed specification.

 -- Function: wsgiref.util.guess_scheme (environ)

     Return a guess for whether ‘wsgi.url_scheme’ should be “http” or
     “https”, by checking for a ‘HTTPS’ environment variable in the
     `environ' dictionary.  The return value is a string.

     This function is useful when creating a gateway that wraps CGI or a
     CGI-like protocol such as FastCGI. Typically, servers providing
     such protocols will include a ‘HTTPS’ variable with a value of “1”,
     “yes”, or “on” when a request is received via SSL. So, this
     function returns “https” if such a value is found, and “http”
     otherwise.

 -- Function: wsgiref.util.request_uri (environ, include_query=True)

     Return the full request URI, optionally including the query string,
     using the algorithm found in the “URL Reconstruction” section of
     PEP 3333(3).  If `include_query' is false, the query string is not
     included in the resulting URI.

 -- Function: wsgiref.util.application_uri (environ)

     Similar to *note request_uri(): 2b34, except that the ‘PATH_INFO’
     and ‘QUERY_STRING’ variables are ignored.  The result is the base
     URI of the application object addressed by the request.

 -- Function: wsgiref.util.shift_path_info (environ)

     Shift a single name from ‘PATH_INFO’ to ‘SCRIPT_NAME’ and return
     the name.  The `environ' dictionary is `modified' in-place; use a
     copy if you need to keep the original ‘PATH_INFO’ or ‘SCRIPT_NAME’
     intact.

     If there are no remaining path segments in ‘PATH_INFO’, ‘None’ is
     returned.

     Typically, this routine is used to process each portion of a
     request URI path, for example to treat the path as a series of
     dictionary keys.  This routine modifies the passed-in environment
     to make it suitable for invoking another WSGI application that is
     located at the target URI. For example, if there is a WSGI
     application at ‘/foo’, and the request URI path is ‘/foo/bar/baz’,
     and the WSGI application at ‘/foo’ calls *note shift_path_info():
     2b36, it will receive the string “bar”, and the environment will be
     updated to be suitable for passing to a WSGI application at
     ‘/foo/bar’.  That is, ‘SCRIPT_NAME’ will change from ‘/foo’ to
     ‘/foo/bar’, and ‘PATH_INFO’ will change from ‘/bar/baz’ to ‘/baz’.

     When ‘PATH_INFO’ is just a “/”, this routine returns an empty
     string and appends a trailing slash to ‘SCRIPT_NAME’, even though
     empty path segments are normally ignored, and ‘SCRIPT_NAME’ doesn’t
     normally end in a slash.  This is intentional behavior, to ensure
     that an application can tell the difference between URIs ending in
     ‘/x’ from ones ending in ‘/x/’ when using this routine to do object
     traversal.

 -- Function: wsgiref.util.setup_testing_defaults (environ)

     Update `environ' with trivial defaults for testing purposes.

     This routine adds various parameters required for WSGI, including
     ‘HTTP_HOST’, ‘SERVER_NAME’, ‘SERVER_PORT’, ‘REQUEST_METHOD’,
     ‘SCRIPT_NAME’, ‘PATH_INFO’, and all of the PEP 3333(4)-defined
     ‘wsgi.*’ variables.  It only supplies default values, and does not
     replace any existing settings for these variables.

     This routine is intended to make it easier for unit tests of WSGI
     servers and applications to set up dummy environments.  It should
     NOT be used by actual WSGI servers or applications, since the data
     is fake!

     Example usage:

          from wsgiref.util import setup_testing_defaults from wsgiref.simple_server import make_server  # A relatively simple WSGI application. It's going to print out the # environment dictionary after being updated by setup_testing_defaults def simple_app(environ, start_response):     setup_testing_defaults(environ)      status = '200 OK'     headers = [('Content-type', 'text/plain; charset=utf-8')]      start_response(status, headers)      ret = [("%s: %s\n" % (key, value)).encode("utf-8")            for key, value in environ.items()]     return ret  with make_server('', 8000, simple_app) as httpd:     print("Serving on port 8000...")     httpd.serve_forever()

In addition to the environment functions above, the *note wsgiref.util:
130. module also provides these miscellaneous utilities:

 -- Function: wsgiref.util.is_hop_by_hop (header_name)

     Return ‘True’ if ‘header_name’ is an HTTP/1.1 “Hop-by-Hop” header,
     as defined by RFC 2616(5).

 -- Class: wsgiref.util.FileWrapper (filelike, blksize=8192)

     A wrapper to convert a file-like object to an *note iterator: f73.
     The resulting objects support both *note __getitem__(): 27a. and
     *note __iter__(): 504. iteration styles, for compatibility with
     Python 2.1 and Jython.  As the object is iterated over, the
     optional `blksize' parameter will be repeatedly passed to the
     `filelike' object’s ‘read()’ method to obtain bytestrings to yield.
     When ‘read()’ returns an empty bytestring, iteration is ended and
     is not resumable.

     If `filelike' has a ‘close()’ method, the returned object will also
     have a ‘close()’ method, and it will invoke the `filelike' object’s
     ‘close()’ method when called.

     Example usage:

          from io import StringIO from wsgiref.util import FileWrapper  # We're using a StringIO-buffer for as the file-like object filelike = StringIO("This is an example file-like object"*10) wrapper = FileWrapper(filelike, blksize=5)  for chunk in wrapper:     print(chunk)

     Deprecated since version 3.8: Support for *note sequence protocol:
     27a. is deprecated.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3333

   (2) https://www.python.org/dev/peps/pep-3333

   (3) https://www.python.org/dev/peps/pep-3333

   (4) https://www.python.org/dev/peps/pep-3333

   (5) https://tools.ietf.org/html/rfc2616.html


File: python.info,  Node: wsgiref headers – WSGI response header tools,  Next: wsgiref simple_server – a simple WSGI HTTP server,  Prev: wsgiref util – WSGI environment utilities,  Up: wsgiref — WSGI Utilities and Reference Implementation

5.22.4.2 ‘wsgiref.headers’ – WSGI response header tools
.......................................................

This module provides a single class, *note Headers: 783, for convenient
manipulation of WSGI response headers using a mapping-like interface.

 -- Class: wsgiref.headers.Headers ([headers])

     Create a mapping-like object wrapping `headers', which must be a
     list of header name/value tuples as described in PEP 3333(1).  The
     default value of `headers' is an empty list.

     *note Headers: 783. objects support typical mapping operations
     including *note __getitem__(): 27a, ‘get()’, *note __setitem__():
     c55, ‘setdefault()’, *note __delitem__(): c56. and *note
     __contains__(): d1b.  For each of these methods, the key is the
     header name (treated case-insensitively), and the value is the
     first value associated with that header name.  Setting a header
     deletes any existing values for that header, then adds a new value
     at the end of the wrapped header list.  Headers’ existing order is
     generally maintained, with new headers added to the end of the
     wrapped list.

     Unlike a dictionary, *note Headers: 783. objects do not raise an
     error when you try to get or delete a key that isn’t in the wrapped
     header list.  Getting a nonexistent header just returns ‘None’, and
     deleting a nonexistent header does nothing.

     *note Headers: 783. objects also support ‘keys()’, ‘values()’, and
     ‘items()’ methods.  The lists returned by ‘keys()’ and ‘items()’
     can include the same key more than once if there is a multi-valued
     header.  The ‘len()’ of a *note Headers: 783. object is the same as
     the length of its ‘items()’, which is the same as the length of the
     wrapped header list.  In fact, the ‘items()’ method just returns a
     copy of the wrapped header list.

     Calling ‘bytes()’ on a *note Headers: 783. object returns a
     formatted bytestring suitable for transmission as HTTP response
     headers.  Each header is placed on a line with its value, separated
     by a colon and a space.  Each line is terminated by a carriage
     return and line feed, and the bytestring is terminated with a blank
     line.

     In addition to their mapping interface and formatting features,
     *note Headers: 783. objects also have the following methods for
     querying and adding multi-valued headers, and for adding headers
     with MIME parameters:

      -- Method: get_all (name)

          Return a list of all the values for the named header.

          The returned list will be sorted in the order they appeared in
          the original header list or were added to this instance, and
          may contain duplicates.  Any fields deleted and re-inserted
          are always appended to the header list.  If no fields exist
          with the given name, returns an empty list.

      -- Method: add_header (name, value, **_params)

          Add a (possibly multi-valued) header, with optional MIME
          parameters specified via keyword arguments.

          `name' is the header field to add.  Keyword arguments can be
          used to set MIME parameters for the header field.  Each
          parameter must be a string or ‘None’.  Underscores in
          parameter names are converted to dashes, since dashes are
          illegal in Python identifiers, but many MIME parameter names
          include dashes.  If the parameter value is a string, it is
          added to the header value parameters in the form
          ‘name="value"’.  If it is ‘None’, only the parameter name is
          added.  (This is used for MIME parameters without a value.)
          Example usage:

               h.add_header('content-disposition', 'attachment', filename='bud.gif')

          The above will add a header that looks like this:

               Content-Disposition: attachment; filename="bud.gif"

     Changed in version 3.5: `headers' parameter is optional.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3333


File: python.info,  Node: wsgiref simple_server – a simple WSGI HTTP server,  Next: wsgiref validate — WSGI conformance checker,  Prev: wsgiref headers – WSGI response header tools,  Up: wsgiref — WSGI Utilities and Reference Implementation

5.22.4.3 ‘wsgiref.simple_server’ – a simple WSGI HTTP server
............................................................

This module implements a simple HTTP server (based on *note http.server:
97.) that serves WSGI applications.  Each server instance serves a
single WSGI application on a given host and port.  If you want to serve
multiple applications on a single host and port, you should create a
WSGI application that parses ‘PATH_INFO’ to select which application to
invoke for each request.  (E.g., using the ‘shift_path_info()’ function
from *note wsgiref.util: 130.)

 -- Function: wsgiref.simple_server.make_server (host, port, app,
          server_class=WSGIServer, handler_class=WSGIRequestHandler)

     Create a new WSGI server listening on `host' and `port', accepting
     connections for `app'.  The return value is an instance of the
     supplied `server_class', and will process requests using the
     specified `handler_class'.  `app' must be a WSGI application
     object, as defined by PEP 3333(1).

     Example usage:

          from wsgiref.simple_server import make_server, demo_app  with make_server('', 8000, demo_app) as httpd:     print("Serving HTTP on port 8000...")      # Respond to requests until process is killed     httpd.serve_forever()      # Alternative: serve one request, then exit     httpd.handle_request()

 -- Function: wsgiref.simple_server.demo_app (environ, start_response)

     This function is a small but complete WSGI application that returns
     a text page containing the message “Hello world!” and a list of the
     key/value pairs provided in the `environ' parameter.  It’s useful
     for verifying that a WSGI server (such as *note
     wsgiref.simple_server: 12f.) is able to run a simple WSGI
     application correctly.

 -- Class: wsgiref.simple_server.WSGIServer (server_address,
          RequestHandlerClass)

     Create a *note WSGIServer: 2b3f. instance.  `server_address' should
     be a ‘(host,port)’ tuple, and `RequestHandlerClass' should be the
     subclass of *note http.server.BaseHTTPRequestHandler: a03. that
     will be used to process requests.

     You do not normally need to call this constructor, as the *note
     make_server(): 2b3d. function can handle all the details for you.

     *note WSGIServer: 2b3f. is a subclass of *note
     http.server.HTTPServer: 2b40, so all of its methods (such as
     ‘serve_forever()’ and ‘handle_request()’) are available.  *note
     WSGIServer: 2b3f. also provides these WSGI-specific methods:

      -- Method: set_app (application)

          Sets the callable `application' as the WSGI application that
          will receive requests.

      -- Method: get_app ()

          Returns the currently-set application callable.

     Normally, however, you do not need to use these additional methods,
     as *note set_app(): 2b41. is normally called by *note
     make_server(): 2b3d, and the *note get_app(): 2b42. exists mainly
     for the benefit of request handler instances.

 -- Class: wsgiref.simple_server.WSGIRequestHandler (request,
          client_address, server)

     Create an HTTP handler for the given `request' (i.e.  a socket),
     `client_address' (a ‘(host,port)’ tuple), and `server' (*note
     WSGIServer: 2b3f. instance).

     You do not need to create instances of this class directly; they
     are automatically created as needed by *note WSGIServer: 2b3f.
     objects.  You can, however, subclass this class and supply it as a
     `handler_class' to the *note make_server(): 2b3d. function.  Some
     possibly relevant methods for overriding in subclasses:

      -- Method: get_environ ()

          Returns a dictionary containing the WSGI environment for a
          request.  The default implementation copies the contents of
          the *note WSGIServer: 2b3f. object’s ‘base_environ’ dictionary
          attribute and then adds various headers derived from the HTTP
          request.  Each call to this method should return a new
          dictionary containing all of the relevant CGI environment
          variables as specified in PEP 3333(2).

      -- Method: get_stderr ()

          Return the object that should be used as the ‘wsgi.errors’
          stream.  The default implementation just returns ‘sys.stderr’.

      -- Method: handle ()

          Process the HTTP request.  The default implementation creates
          a handler instance using a *note wsgiref.handlers: 12d. class
          to implement the actual WSGI application interface.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3333

   (2) https://www.python.org/dev/peps/pep-3333


File: python.info,  Node: wsgiref validate — WSGI conformance checker,  Next: wsgiref handlers – server/gateway base classes,  Prev: wsgiref simple_server – a simple WSGI HTTP server,  Up: wsgiref — WSGI Utilities and Reference Implementation

5.22.4.4 ‘wsgiref.validate’ — WSGI conformance checker
......................................................

When creating new WSGI application objects, frameworks, servers, or
middleware, it can be useful to validate the new code’s conformance
using *note wsgiref.validate: 131.  This module provides a function that
creates WSGI application objects that validate communications between a
WSGI server or gateway and a WSGI application object, to check both
sides for protocol conformance.

Note that this utility does not guarantee complete PEP 3333(1)
compliance; an absence of errors from this module does not necessarily
mean that errors do not exist.  However, if this module does produce an
error, then it is virtually certain that either the server or
application is not 100% compliant.

This module is based on the ‘paste.lint’ module from Ian Bicking’s
“Python Paste” library.

 -- Function: wsgiref.validate.validator (application)

     Wrap `application' and return a new WSGI application object.  The
     returned application will forward all requests to the original
     `application', and will check that both the `application' and the
     server invoking it are conforming to the WSGI specification and to
     RFC 2616(2).

     Any detected nonconformance results in an *note AssertionError:
     f66. being raised; note, however, that how these errors are handled
     is server-dependent.  For example, *note wsgiref.simple_server:
     12f. and other servers based on *note wsgiref.handlers: 12d. (that
     don’t override the error handling methods to do something else)
     will simply output a message that an error has occurred, and dump
     the traceback to ‘sys.stderr’ or some other error stream.

     This wrapper may also generate output using the *note warnings:
     126. module to indicate behaviors that are questionable but which
     may not actually be prohibited by PEP 3333(3).  Unless they are
     suppressed using Python command-line options or the *note warnings:
     126. API, any such warnings will be written to ‘sys.stderr’ (`not'
     ‘wsgi.errors’, unless they happen to be the same object).

     Example usage:

          from wsgiref.validate import validator from wsgiref.simple_server import make_server  # Our callable object which is intentionally not compliant to the # standard, so the validator is going to break def simple_app(environ, start_response):     status = '200 OK'  # HTTP Status     headers = [('Content-type', 'text/plain')]  # HTTP Headers     start_response(status, headers)      # This is going to break because we need to return a list, and     # the validator is going to inform us     return b"Hello World"  # This is the application wrapped in a validator validator_app = validator(simple_app)  with make_server('', 8000, validator_app) as httpd:     print("Listening on port 8000....")     httpd.serve_forever()

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3333

   (2) https://tools.ietf.org/html/rfc2616.html

   (3) https://www.python.org/dev/peps/pep-3333


File: python.info,  Node: wsgiref handlers – server/gateway base classes,  Next: Examples<20>,  Prev: wsgiref validate — WSGI conformance checker,  Up: wsgiref — WSGI Utilities and Reference Implementation

5.22.4.5 ‘wsgiref.handlers’ – server/gateway base classes
.........................................................

This module provides base handler classes for implementing WSGI servers
and gateways.  These base classes handle most of the work of
communicating with a WSGI application, as long as they are given a
CGI-like environment, along with input, output, and error streams.

 -- Class: wsgiref.handlers.CGIHandler

     CGI-based invocation via ‘sys.stdin’, ‘sys.stdout’, ‘sys.stderr’
     and ‘os.environ’.  This is useful when you have a WSGI application
     and want to run it as a CGI script.  Simply invoke
     ‘CGIHandler().run(app)’, where ‘app’ is the WSGI application object
     you wish to invoke.

     This class is a subclass of *note BaseCGIHandler: 2b4b. that sets
     ‘wsgi.run_once’ to true, ‘wsgi.multithread’ to false, and
     ‘wsgi.multiprocess’ to true, and always uses *note sys: fd. and
     *note os: c4. to obtain the necessary CGI streams and environment.

 -- Class: wsgiref.handlers.IISCGIHandler

     A specialized alternative to *note CGIHandler: 2b4a, for use when
     deploying on Microsoft’s IIS web server, without having set the
     config allowPathInfo option (IIS>=7) or metabase
     allowPathInfoForScriptMappings (IIS<7).

     By default, IIS gives a ‘PATH_INFO’ that duplicates the
     ‘SCRIPT_NAME’ at the front, causing problems for WSGI applications
     that wish to implement routing.  This handler strips any such
     duplicated path.

     IIS can be configured to pass the correct ‘PATH_INFO’, but this
     causes another bug where ‘PATH_TRANSLATED’ is wrong.  Luckily this
     variable is rarely used and is not guaranteed by WSGI. On IIS<7,
     though, the setting can only be made on a vhost level, affecting
     all other script mappings, many of which break when exposed to the
     ‘PATH_TRANSLATED’ bug.  For this reason IIS<7 is almost never
     deployed with the fix.  (Even IIS7 rarely uses it because there is
     still no UI for it.)

     There is no way for CGI code to tell whether the option was set, so
     a separate handler class is provided.  It is used in the same way
     as *note CGIHandler: 2b4a, i.e., by calling
     ‘IISCGIHandler().run(app)’, where ‘app’ is the WSGI application
     object you wish to invoke.

     New in version 3.2.

 -- Class: wsgiref.handlers.BaseCGIHandler (stdin, stdout, stderr,
          environ, multithread=True, multiprocess=False)

     Similar to *note CGIHandler: 2b4a, but instead of using the *note
     sys: fd. and *note os: c4. modules, the CGI environment and I/O
     streams are specified explicitly.  The `multithread' and
     `multiprocess' values are used to set the ‘wsgi.multithread’ and
     ‘wsgi.multiprocess’ flags for any applications run by the handler
     instance.

     This class is a subclass of *note SimpleHandler: 2b4d. intended for
     use with software other than HTTP “origin servers”.  If you are
     writing a gateway protocol implementation (such as CGI, FastCGI,
     SCGI, etc.)  that uses a ‘Status:’ header to send an HTTP status,
     you probably want to subclass this instead of *note SimpleHandler:
     2b4d.

 -- Class: wsgiref.handlers.SimpleHandler (stdin, stdout, stderr,
          environ, multithread=True, multiprocess=False)

     Similar to *note BaseCGIHandler: 2b4b, but designed for use with
     HTTP origin servers.  If you are writing an HTTP server
     implementation, you will probably want to subclass this instead of
     *note BaseCGIHandler: 2b4b.

     This class is a subclass of *note BaseHandler: efe.  It overrides
     the *note __init__(): d51, ‘get_stdin()’, ‘get_stderr()’,
     ‘add_cgi_vars()’, ‘_write()’, and ‘_flush()’ methods to support
     explicitly setting the environment and streams via the constructor.
     The supplied environment and streams are stored in the ‘stdin’,
     ‘stdout’, ‘stderr’, and ‘environ’ attributes.

     The *note write(): 57e. method of `stdout' should write each chunk
     in full, like *note io.BufferedIOBase: 57d.

 -- Class: wsgiref.handlers.BaseHandler

     This is an abstract base class for running WSGI applications.  Each
     instance will handle a single HTTP request, although in principle
     you could create a subclass that was reusable for multiple
     requests.

     *note BaseHandler: efe. instances have only one method intended for
     external use:

      -- Method: run (app)

          Run the specified WSGI application, `app'.

     All of the other *note BaseHandler: efe. methods are invoked by
     this method in the process of running the application, and thus
     exist primarily to allow customizing the process.

     The following methods MUST be overridden in a subclass:

      -- Method: _write (data)

          Buffer the bytes `data' for transmission to the client.  It’s
          okay if this method actually transmits the data; *note
          BaseHandler: efe. just separates write and flush operations
          for greater efficiency when the underlying system actually has
          such a distinction.

      -- Method: _flush ()

          Force buffered data to be transmitted to the client.  It’s
          okay if this method is a no-op (i.e., if *note _write(): 2b4f.
          actually sends the data).

      -- Method: get_stdin ()

          Return an input stream object suitable for use as the
          ‘wsgi.input’ of the request currently being processed.

      -- Method: get_stderr ()

          Return an output stream object suitable for use as the
          ‘wsgi.errors’ of the request currently being processed.

      -- Method: add_cgi_vars ()

          Insert CGI variables for the current request into the
          ‘environ’ attribute.

     Here are some other methods and attributes you may wish to
     override.  This list is only a summary, however, and does not
     include every method that can be overridden.  You should consult
     the docstrings and source code for additional information before
     attempting to create a customized *note BaseHandler: efe. subclass.

     Attributes and methods for customizing the WSGI environment:

      -- Attribute: wsgi_multithread

          The value to be used for the ‘wsgi.multithread’ environment
          variable.  It defaults to true in *note BaseHandler: efe, but
          may have a different default (or be set by the constructor) in
          the other subclasses.

      -- Attribute: wsgi_multiprocess

          The value to be used for the ‘wsgi.multiprocess’ environment
          variable.  It defaults to true in *note BaseHandler: efe, but
          may have a different default (or be set by the constructor) in
          the other subclasses.

      -- Attribute: wsgi_run_once

          The value to be used for the ‘wsgi.run_once’ environment
          variable.  It defaults to false in *note BaseHandler: efe, but
          *note CGIHandler: 2b4a. sets it to true by default.

      -- Attribute: os_environ

          The default environment variables to be included in every
          request’s WSGI environment.  By default, this is a copy of
          ‘os.environ’ at the time that *note wsgiref.handlers: 12d. was
          imported, but subclasses can either create their own at the
          class or instance level.  Note that the dictionary should be
          considered read-only, since the default value is shared
          between multiple classes and instances.

      -- Attribute: server_software

          If the *note origin_server: 2b59. attribute is set, this
          attribute’s value is used to set the default ‘SERVER_SOFTWARE’
          WSGI environment variable, and also to set a default ‘Server:’
          header in HTTP responses.  It is ignored for handlers (such as
          *note BaseCGIHandler: 2b4b. and *note CGIHandler: 2b4a.) that
          are not HTTP origin servers.

          Changed in version 3.3: The term “Python” is replaced with
          implementation specific term like “CPython”, “Jython” etc.

      -- Method: get_scheme ()

          Return the URL scheme being used for the current request.  The
          default implementation uses the ‘guess_scheme()’ function from
          *note wsgiref.util: 130. to guess whether the scheme should be
          “http” or “https”, based on the current request’s ‘environ’
          variables.

      -- Method: setup_environ ()

          Set the ‘environ’ attribute to a fully-populated WSGI
          environment.  The default implementation uses all of the above
          methods and attributes, plus the *note get_stdin(): 2b51,
          *note get_stderr(): 2b52, and *note add_cgi_vars(): 2b53.
          methods and the *note wsgi_file_wrapper: 2b5c. attribute.  It
          also inserts a ‘SERVER_SOFTWARE’ key if not present, as long
          as the *note origin_server: 2b59. attribute is a true value
          and the *note server_software: 2b58. attribute is set.

     Methods and attributes for customizing exception handling:

      -- Method: log_exception (exc_info)

          Log the `exc_info' tuple in the server log.  `exc_info' is a
          ‘(type, value, traceback)’ tuple.  The default implementation
          simply writes the traceback to the request’s ‘wsgi.errors’
          stream and flushes it.  Subclasses can override this method to
          change the format or retarget the output, mail the traceback
          to an administrator, or whatever other action may be deemed
          suitable.

      -- Attribute: traceback_limit

          The maximum number of frames to include in tracebacks output
          by the default *note log_exception(): 2b5d. method.  If
          ‘None’, all frames are included.

      -- Method: error_output (environ, start_response)

          This method is a WSGI application to generate an error page
          for the user.  It is only invoked if an error occurs before
          headers are sent to the client.

          This method can access the current error information using
          ‘sys.exc_info()’, and should pass that information to
          `start_response' when calling it (as described in the “Error
          Handling” section of PEP 3333(1)).

          The default implementation just uses the *note error_status:
          2b60, *note error_headers: 2b61, and *note error_body: 2b62.
          attributes to generate an output page.  Subclasses can
          override this to produce more dynamic error output.

          Note, however, that it’s not recommended from a security
          perspective to spit out diagnostics to any old user; ideally,
          you should have to do something special to enable diagnostic
          output, which is why the default implementation doesn’t
          include any.

      -- Attribute: error_status

          The HTTP status used for error responses.  This should be a
          status string as defined in PEP 3333(2); it defaults to a 500
          code and message.

      -- Attribute: error_headers

          The HTTP headers used for error responses.  This should be a
          list of WSGI response headers (‘(name, value)’ tuples), as
          described in PEP 3333(3).  The default list just sets the
          content type to ‘text/plain’.

      -- Attribute: error_body

          The error response body.  This should be an HTTP response body
          bytestring.  It defaults to the plain text, “A server error
          occurred.  Please contact the administrator.”

     Methods and attributes for PEP 3333(4)’s “Optional
     Platform-Specific File Handling” feature:

      -- Attribute: wsgi_file_wrapper

          A ‘wsgi.file_wrapper’ factory, or ‘None’.  The default value
          of this attribute is the *note wsgiref.util.FileWrapper: 27c.
          class.

      -- Method: sendfile ()

          Override to implement platform-specific file transmission.
          This method is called only if the application’s return value
          is an instance of the class specified by the *note
          wsgi_file_wrapper: 2b5c. attribute.  It should return a true
          value if it was able to successfully transmit the file, so
          that the default transmission code will not be executed.  The
          default implementation of this method just returns a false
          value.

     Miscellaneous methods and attributes:

      -- Attribute: origin_server

          This attribute should be set to a true value if the handler’s
          *note _write(): 2b4f. and *note _flush(): 2b50. are being used
          to communicate directly to the client, rather than via a
          CGI-like gateway protocol that wants the HTTP status in a
          special ‘Status:’ header.

          This attribute’s default value is true in *note BaseHandler:
          efe, but false in *note BaseCGIHandler: 2b4b. and *note
          CGIHandler: 2b4a.

      -- Attribute: http_version

          If *note origin_server: 2b59. is true, this string attribute
          is used to set the HTTP version of the response set to the
          client.  It defaults to ‘"1.0"’.

 -- Function: wsgiref.handlers.read_environ ()

     Transcode CGI variables from ‘os.environ’ to PEP 3333(5) “bytes in
     unicode” strings, returning a new dictionary.  This function is
     used by *note CGIHandler: 2b4a. and *note IISCGIHandler: 2b4c. in
     place of directly using ‘os.environ’, which is not necessarily
     WSGI-compliant on all platforms and web servers using Python 3 –
     specifically, ones where the OS’s actual environment is Unicode
     (i.e.  Windows), or ones where the environment is bytes, but the
     system encoding used by Python to decode it is anything other than
     ISO-8859-1 (e.g.  Unix systems using UTF-8).

     If you are implementing a CGI-based handler of your own, you
     probably want to use this routine instead of just copying values
     out of ‘os.environ’ directly.

     New in version 3.2.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3333

   (2) https://www.python.org/dev/peps/pep-3333

   (3) https://www.python.org/dev/peps/pep-3333

   (4) https://www.python.org/dev/peps/pep-3333

   (5) https://www.python.org/dev/peps/pep-3333


File: python.info,  Node: Examples<20>,  Prev: wsgiref handlers – server/gateway base classes,  Up: wsgiref — WSGI Utilities and Reference Implementation

5.22.4.6 Examples
.................

This is a working “Hello World” WSGI application:

     from wsgiref.simple_server import make_server  # Every WSGI application must have an application object - a callable # object that accepts two arguments. For that purpose, we're going to # use a function (note that you're not limited to a function, you can # use a class for example). The first argument passed to the function # is a dictionary containing CGI-style environment variables and the # second variable is the callable object. def hello_world_app(environ, start_response):     status = '200 OK'  # HTTP Status     headers = [('Content-type', 'text/plain; charset=utf-8')]  # HTTP Headers     start_response(status, headers)      # The returned object is going to be printed     return [b"Hello World"]  with make_server('', 8000, hello_world_app) as httpd:     print("Serving on port 8000...")      # Serve until process is killed     httpd.serve_forever()

Example of a WSGI application serving the current directory, accept
optional directory and port number (default: 8000) on the command line:

     #!/usr/bin/env python3 ''' Small wsgiref based web server. Takes a path to serve from and an optional port number (defaults to 8000), then tries to serve files. Mime types are guessed from the file names, 404 errors are raised if the file is not found. Used for the make serve target in Doc. ''' import sys import os import mimetypes from wsgiref import simple_server, util  def app(environ, respond):      fn = os.path.join(path, environ['PATH_INFO'][1:])     if '.' not in fn.split(os.path.sep)[-1]:         fn = os.path.join(fn, 'index.html')     type = mimetypes.guess_type(fn)[0]      if os.path.exists(fn):         respond('200 OK', [('Content-Type', type)])         return util.FileWrapper(open(fn, "rb"))     else:         respond('404 Not Found', [('Content-Type', 'text/plain')])         return [b'not found']  if __name__ == '__main__':     path = sys.argv[1] if len(sys.argv) > 1 else os.getcwd()     port = int(sys.argv[2]) if len(sys.argv) > 2 else 8000     httpd = simple_server.make_server('', port, app)     print("Serving {} on port {}, control-C to stop".format(path, port))     try:         httpd.serve_forever()     except KeyboardInterrupt:         print("Shutting down.")         httpd.server_close()


File: python.info,  Node: urllib — URL handling modules,  Next: urllib request — Extensible library for opening URLs,  Prev: wsgiref — WSGI Utilities and Reference Implementation,  Up: Internet Protocols and Support

5.22.5 ‘urllib’ — URL handling modules
--------------------------------------

`Source code:' Lib/urllib/(1)

__________________________________________________________________

‘urllib’ is a package that collects several modules for working with
URLs:

   * *note urllib.request: 120. for opening and reading URLs

   * *note urllib.error: 11e. containing the exceptions raised by *note
     urllib.request: 120.

   * *note urllib.parse: 11f. for parsing URLs

   * *note urllib.robotparser: 122. for parsing ‘robots.txt’ files

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/urllib/


File: python.info,  Node: urllib request — Extensible library for opening URLs,  Next: urllib response — Response classes used by urllib,  Prev: urllib — URL handling modules,  Up: Internet Protocols and Support

5.22.6 ‘urllib.request’ — Extensible library for opening URLs
-------------------------------------------------------------

`Source code:' Lib/urllib/request.py(1)

__________________________________________________________________

The *note urllib.request: 120. module defines functions and classes
which help in opening URLs (mostly HTTP) in a complex world — basic and
digest authentication, redirections, cookies and more.

See also
........

The Requests package(2) is recommended for a higher-level HTTP client
interface.

The *note urllib.request: 120. module defines the following functions:

 -- Function: urllib.request.urlopen (url, data=None[, timeout], *,
          cafile=None, capath=None, cadefault=False, context=None)

     Open the URL `url', which can be either a string or a *note
     Request: 8ea. object.

     `data' must be an object specifying additional data to be sent to
     the server, or ‘None’ if no such data is needed.  See *note
     Request: 8ea. for details.

     urllib.request module uses HTTP/1.1 and includes ‘Connection:close’
     header in its HTTP requests.

     The optional `timeout' parameter specifies a timeout in seconds for
     blocking operations like the connection attempt (if not specified,
     the global default timeout setting will be used).  This actually
     only works for HTTP, HTTPS and FTP connections.

     If `context' is specified, it must be a *note ssl.SSLContext: 3d9.
     instance describing the various SSL options.  See *note
     HTTPSConnection: 388. for more details.

     The optional `cafile' and `capath' parameters specify a set of
     trusted CA certificates for HTTPS requests.  `cafile' should point
     to a single file containing a bundle of CA certificates, whereas
     `capath' should point to a directory of hashed certificate files.
     More information can be found in *note
     ssl.SSLContext.load_verify_locations(): 7df.

     The `cadefault' parameter is ignored.

     This function always returns an object which can work as a *note
     context manager: 55d. and has methods such as

        * ‘geturl()’ — return the URL of the resource retrieved,
          commonly used to determine if a redirect was followed

        * ‘info()’ — return the meta-information of the page, such as
          headers, in the form of an *note email.message_from_string():
          2752. instance (see Quick Reference to HTTP Headers(3))

        * ‘getcode()’ – return the HTTP status code of the response.

     For HTTP and HTTPS URLs, this function returns a *note
     http.client.HTTPResponse: a06. object slightly modified.  In
     addition to the three new methods above, the msg attribute contains
     the same information as the *note reason: 2b6a. attribute — the
     reason phrase returned by server — instead of the response headers
     as it is specified in the documentation for *note HTTPResponse:
     a06.

     For FTP, file, and data URLs and requests explicitly handled by
     legacy *note URLopener: 2b6b. and *note FancyURLopener: 2b6c.
     classes, this function returns a ‘urllib.response.addinfourl’
     object.

     Raises *note URLError: 2b6d. on protocol errors.

     Note that ‘None’ may be returned if no handler handles the request
     (though the default installed global *note OpenerDirector: 2b6e.
     uses *note UnknownHandler: 2b6f. to ensure this never happens).

     In addition, if proxy settings are detected (for example, when a
     ‘*_proxy’ environment variable like ‘http_proxy’ is set), *note
     ProxyHandler: eac. is default installed and makes sure the requests
     are handled through the proxy.

     The legacy ‘urllib.urlopen’ function from Python 2.6 and earlier
     has been discontinued; *note urllib.request.urlopen(): 780.
     corresponds to the old ‘urllib2.urlopen’.  Proxy handling, which
     was done by passing a dictionary parameter to ‘urllib.urlopen’, can
     be obtained by using *note ProxyHandler: eac. objects.

     The default opener raises an *note auditing event: 1275.
     ‘urllib.Request’ with arguments ‘fullurl’, ‘data’, ‘headers’,
     ‘method’ taken from the request object.

     Changed in version 3.2: `cafile' and `capath' were added.

     Changed in version 3.2: HTTPS virtual hosts are now supported if
     possible (that is, if *note ssl.HAS_SNI: 261e. is true).

     New in version 3.2: `data' can be an iterable object.

     Changed in version 3.3: `cadefault' was added.

     Changed in version 3.4.3: `context' was added.

     Deprecated since version 3.6: `cafile', `capath' and `cadefault'
     are deprecated in favor of `context'.  Please use *note
     ssl.SSLContext.load_cert_chain(): a86. instead, or let *note
     ssl.create_default_context(): 8b5. select the system’s trusted CA
     certificates for you.

 -- Function: urllib.request.install_opener (opener)

     Install an *note OpenerDirector: 2b6e. instance as the default
     global opener.  Installing an opener is only necessary if you want
     urlopen to use that opener; otherwise, simply call *note
     OpenerDirector.open(): 8ee. instead of *note urlopen(): 780.  The
     code does not check for a real *note OpenerDirector: 2b6e, and any
     class with the appropriate interface will work.

 -- Function: urllib.request.build_opener ([handler, ...])

     Return an *note OpenerDirector: 2b6e. instance, which chains the
     handlers in the order given.  `handler's can be either instances of
     *note BaseHandler: 2b72, or subclasses of *note BaseHandler: 2b72.
     (in which case it must be possible to call the constructor without
     any parameters).  Instances of the following classes will be in
     front of the `handler's, unless the `handler's contain them,
     instances of them or subclasses of them: *note ProxyHandler: eac.
     (if proxy settings are detected), *note UnknownHandler: 2b6f, *note
     HTTPHandler: 2b73, *note HTTPDefaultErrorHandler: 2b74, *note
     HTTPRedirectHandler: 2b75, *note FTPHandler: 2b76, *note
     FileHandler: 2b77, *note HTTPErrorProcessor: 2b78.

     If the Python installation has SSL support (i.e., if the *note ssl:
     f3. module can be imported), *note HTTPSHandler: b9b. will also be
     added.

     A *note BaseHandler: 2b72. subclass may also change its
     ‘handler_order’ attribute to modify its position in the handlers
     list.

 -- Function: urllib.request.pathname2url (path)

     Convert the pathname `path' from the local syntax for a path to the
     form used in the path component of a URL. This does not produce a
     complete URL. The return value will already be quoted using the
     *note quote(): 402. function.

 -- Function: urllib.request.url2pathname (path)

     Convert the path component `path' from a percent-encoded URL to the
     local syntax for a path.  This does not accept a complete URL. This
     function uses *note unquote(): 2b7b. to decode `path'.

 -- Function: urllib.request.getproxies ()

     This helper function returns a dictionary of scheme to proxy server
     URL mappings.  It scans the environment for variables named
     ‘<scheme>_proxy’, in a case insensitive approach, for all operating
     systems first, and when it cannot find it, looks for proxy
     information from Mac OSX System Configuration for Mac OS X and
     Windows Systems Registry for Windows.  If both lowercase and
     uppercase environment variables exist (and disagree), lowercase is
     preferred.

          Note: If the environment variable ‘REQUEST_METHOD’ is set,
          which usually indicates your script is running in a CGI
          environment, the environment variable ‘HTTP_PROXY’ (uppercase
          ‘_PROXY’) will be ignored.  This is because that variable can
          be injected by a client using the “Proxy:” HTTP header.  If
          you need to use an HTTP proxy in a CGI environment, either use
          ‘ProxyHandler’ explicitly, or make sure the variable name is
          in lowercase (or at least the ‘_proxy’ suffix).

The following classes are provided:

 -- Class: urllib.request.Request (url, data=None, headers={},
          origin_req_host=None, unverifiable=False, method=None)

     This class is an abstraction of a URL request.

     `url' should be a string containing a valid URL.

     `data' must be an object specifying additional data to send to the
     server, or ‘None’ if no such data is needed.  Currently HTTP
     requests are the only ones that use `data'.  The supported object
     types include bytes, file-like objects, and iterables of bytes-like
     objects.  If no ‘Content-Length’ nor ‘Transfer-Encoding’ header
     field has been provided, *note HTTPHandler: 2b73. will set these
     headers according to the type of `data'.  ‘Content-Length’ will be
     used to send bytes objects, while ‘Transfer-Encoding: chunked’ as
     specified in RFC 7230(4), Section 3.3.1 will be used to send files
     and other iterables.

     For an HTTP POST request method, `data' should be a buffer in the
     standard ‘application/x-www-form-urlencoded’ format.  The *note
     urllib.parse.urlencode(): 77f. function takes a mapping or sequence
     of 2-tuples and returns an ASCII string in this format.  It should
     be encoded to bytes before being used as the `data' parameter.

     `headers' should be a dictionary, and will be treated as if *note
     add_header(): 2b7d. was called with each key and value as
     arguments.  This is often used to “spoof” the ‘User-Agent’ header
     value, which is used by a browser to identify itself – some HTTP
     servers only allow requests coming from common browsers as opposed
     to scripts.  For example, Mozilla Firefox may identify itself as
     ‘"Mozilla/5.0 (X11; U; Linux i686) Gecko/20071127
     Firefox/2.0.0.11"’, while *note urllib: 11d.’s default user agent
     string is ‘"Python-urllib/2.6"’ (on Python 2.6).

     An appropriate ‘Content-Type’ header should be included if the
     `data' argument is present.  If this header has not been provided
     and `data' is not None, ‘Content-Type:
     application/x-www-form-urlencoded’ will be added as a default.

     The next two arguments are only of interest for correct handling of
     third-party HTTP cookies:

     `origin_req_host' should be the request-host of the origin
     transaction, as defined by RFC 2965(5).  It defaults to
     ‘http.cookiejar.request_host(self)’.  This is the host name or IP
     address of the original request that was initiated by the user.
     For example, if the request is for an image in an HTML document,
     this should be the request-host of the request for the page
     containing the image.

     `unverifiable' should indicate whether the request is unverifiable,
     as defined by RFC 2965(6).  It defaults to ‘False’.  An
     unverifiable request is one whose URL the user did not have the
     option to approve.  For example, if the request is for an image in
     an HTML document, and the user had no option to approve the
     automatic fetching of the image, this should be true.

     `method' should be a string that indicates the HTTP request method
     that will be used (e.g.  ‘'HEAD'’).  If provided, its value is
     stored in the *note method: 8eb. attribute and is used by *note
     get_method(): ab6.  The default is ‘'GET'’ if `data' is ‘None’ or
     ‘'POST'’ otherwise.  Subclasses may indicate a different default
     method by setting the *note method: 8eb. attribute in the class
     itself.

          Note: The request will not work as expected if the data object
          is unable to deliver its content more than once (e.g.  a file
          or an iterable that can produce the content only once) and the
          request is retried for HTTP redirects or authentication.  The
          `data' is sent to the HTTP server right away after the
          headers.  There is no support for a 100-continue expectation
          in the library.

     Changed in version 3.3: *note Request.method: 8eb. argument is
     added to the Request class.

     Changed in version 3.4: Default *note Request.method: 8eb. may be
     indicated at the class level.

     Changed in version 3.6: Do not raise an error if the
     ‘Content-Length’ has not been provided and `data' is neither ‘None’
     nor a bytes object.  Fall back to use chunked transfer encoding
     instead.

 -- Class: urllib.request.OpenerDirector

     The *note OpenerDirector: 2b6e. class opens URLs via *note
     BaseHandler: 2b72.s chained together.  It manages the chaining of
     handlers, and recovery from errors.

 -- Class: urllib.request.BaseHandler

     This is the base class for all registered handlers — and handles
     only the simple mechanics of registration.

 -- Class: urllib.request.HTTPDefaultErrorHandler

     A class which defines a default handler for HTTP error responses;
     all responses are turned into *note HTTPError: 8f0. exceptions.

 -- Class: urllib.request.HTTPRedirectHandler

     A class to handle redirections.

 -- Class: urllib.request.HTTPCookieProcessor (cookiejar=None)

     A class to handle HTTP Cookies.

 -- Class: urllib.request.ProxyHandler (proxies=None)

     Cause requests to go through a proxy.  If `proxies' is given, it
     must be a dictionary mapping protocol names to URLs of proxies.
     The default is to read the list of proxies from the environment
     variables ‘<protocol>_proxy’.  If no proxy environment variables
     are set, then in a Windows environment proxy settings are obtained
     from the registry’s Internet Settings section, and in a Mac OS X
     environment proxy information is retrieved from the OS X System
     Configuration Framework.

     To disable autodetected proxy pass an empty dictionary.

     The ‘no_proxy’ environment variable can be used to specify hosts
     which shouldn’t be reached via proxy; if set, it should be a
     comma-separated list of hostname suffixes, optionally with ‘:port’
     appended, for example ‘cern.ch,ncsa.uiuc.edu,some.host:8080’.

               Note: ‘HTTP_PROXY’ will be ignored if a variable
               ‘REQUEST_METHOD’ is set; see the documentation on *note
               getproxies(): 2b7c.

 -- Class: urllib.request.HTTPPasswordMgr

     Keep a database of ‘(realm, uri) -> (user, password)’ mappings.

 -- Class: urllib.request.HTTPPasswordMgrWithDefaultRealm

     Keep a database of ‘(realm, uri) -> (user, password)’ mappings.  A
     realm of ‘None’ is considered a catch-all realm, which is searched
     if no other realm fits.

 -- Class: urllib.request.HTTPPasswordMgrWithPriorAuth

     A variant of *note HTTPPasswordMgrWithDefaultRealm: 2b80. that also
     has a database of ‘uri -> is_authenticated’ mappings.  Can be used
     by a BasicAuth handler to determine when to send authentication
     credentials immediately instead of waiting for a ‘401’ response
     first.

     New in version 3.5.

 -- Class: urllib.request.AbstractBasicAuthHandler (password_mgr=None)

     This is a mixin class that helps with HTTP authentication, both to
     the remote host and to a proxy.  `password_mgr', if given, should
     be something that is compatible with *note HTTPPasswordMgr: 2b7f.;
     refer to section *note HTTPPasswordMgr Objects: 2b82. for
     information on the interface that must be supported.  If
     `passwd_mgr' also provides ‘is_authenticated’ and
     ‘update_authenticated’ methods (see *note
     HTTPPasswordMgrWithPriorAuth Objects: 2b83.), then the handler will
     use the ‘is_authenticated’ result for a given URI to determine
     whether or not to send authentication credentials with the request.
     If ‘is_authenticated’ returns ‘True’ for the URI, credentials are
     sent.  If ‘is_authenticated’ is ‘False’, credentials are not sent,
     and then if a ‘401’ response is received the request is re-sent
     with the authentication credentials.  If authentication succeeds,
     ‘update_authenticated’ is called to set ‘is_authenticated’ ‘True’
     for the URI, so that subsequent requests to the URI or any of its
     super-URIs will automatically include the authentication
     credentials.

     New in version 3.5: Added ‘is_authenticated’ support.

 -- Class: urllib.request.HTTPBasicAuthHandler (password_mgr=None)

     Handle authentication with the remote host.  `password_mgr', if
     given, should be something that is compatible with *note
     HTTPPasswordMgr: 2b7f.; refer to section *note HTTPPasswordMgr
     Objects: 2b82. for information on the interface that must be
     supported.  HTTPBasicAuthHandler will raise a *note ValueError:
     1f9. when presented with a wrong Authentication scheme.

 -- Class: urllib.request.ProxyBasicAuthHandler (password_mgr=None)

     Handle authentication with the proxy.  `password_mgr', if given,
     should be something that is compatible with *note HTTPPasswordMgr:
     2b7f.; refer to section *note HTTPPasswordMgr Objects: 2b82. for
     information on the interface that must be supported.

 -- Class: urllib.request.AbstractDigestAuthHandler (password_mgr=None)

     This is a mixin class that helps with HTTP authentication, both to
     the remote host and to a proxy.  `password_mgr', if given, should
     be something that is compatible with *note HTTPPasswordMgr: 2b7f.;
     refer to section *note HTTPPasswordMgr Objects: 2b82. for
     information on the interface that must be supported.

 -- Class: urllib.request.HTTPDigestAuthHandler (password_mgr=None)

     Handle authentication with the remote host.  `password_mgr', if
     given, should be something that is compatible with *note
     HTTPPasswordMgr: 2b7f.; refer to section *note HTTPPasswordMgr
     Objects: 2b82. for information on the interface that must be
     supported.  When both Digest Authentication Handler and Basic
     Authentication Handler are both added, Digest Authentication is
     always tried first.  If the Digest Authentication returns a 40x
     response again, it is sent to Basic Authentication handler to
     Handle.  This Handler method will raise a *note ValueError: 1f9.
     when presented with an authentication scheme other than Digest or
     Basic.

     Changed in version 3.3: Raise *note ValueError: 1f9. on unsupported
     Authentication Scheme.

 -- Class: urllib.request.ProxyDigestAuthHandler (password_mgr=None)

     Handle authentication with the proxy.  `password_mgr', if given,
     should be something that is compatible with *note HTTPPasswordMgr:
     2b7f.; refer to section *note HTTPPasswordMgr Objects: 2b82. for
     information on the interface that must be supported.

 -- Class: urllib.request.HTTPHandler

     A class to handle opening of HTTP URLs.

 -- Class: urllib.request.HTTPSHandler (debuglevel=0, context=None,
          check_hostname=None)

     A class to handle opening of HTTPS URLs.  `context' and
     `check_hostname' have the same meaning as in *note
     http.client.HTTPSConnection: 388.

     Changed in version 3.2: `context' and `check_hostname' were added.

 -- Class: urllib.request.FileHandler

     Open local files.

 -- Class: urllib.request.DataHandler

     Open data URLs.

     New in version 3.4.

 -- Class: urllib.request.FTPHandler

     Open FTP URLs.

 -- Class: urllib.request.CacheFTPHandler

     Open FTP URLs, keeping a cache of open FTP connections to minimize
     delays.

 -- Class: urllib.request.UnknownHandler

     A catch-all class to handle unknown URLs.

 -- Class: urllib.request.HTTPErrorProcessor

     Process HTTP error responses.

* Menu:

* Request Objects::
* OpenerDirector Objects::
* BaseHandler Objects::
* HTTPRedirectHandler Objects::
* HTTPCookieProcessor Objects::
* ProxyHandler Objects::
* HTTPPasswordMgr Objects::
* HTTPPasswordMgrWithPriorAuth Objects::
* AbstractBasicAuthHandler Objects::
* HTTPBasicAuthHandler Objects::
* ProxyBasicAuthHandler Objects::
* AbstractDigestAuthHandler Objects::
* HTTPDigestAuthHandler Objects::
* ProxyDigestAuthHandler Objects::
* HTTPHandler Objects::
* HTTPSHandler Objects::
* FileHandler Objects::
* DataHandler Objects::
* FTPHandler Objects::
* CacheFTPHandler Objects::
* UnknownHandler Objects::
* HTTPErrorProcessor Objects::
* Examples: Examples<21>.
* Legacy interface::
* urllib.request Restrictions: urllib request Restrictions.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/urllib/request.py

   (2) https://requests.readthedocs.io/en/master/

   (3) http://jkorpela.fi/http.html

   (4) https://tools.ietf.org/html/rfc7230.html

   (5) https://tools.ietf.org/html/rfc2965.html

   (6) https://tools.ietf.org/html/rfc2965.html


File: python.info,  Node: Request Objects,  Next: OpenerDirector Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.1 Request Objects
........................

The following methods describe *note Request: 8ea.’s public interface,
and so all may be overridden in subclasses.  It also defines several
public attributes that can be used by clients to inspect the parsed
request.

 -- Attribute: Request.full_url

     The original URL passed to the constructor.

     Changed in version 3.4.

     Request.full_url is a property with setter, getter and a deleter.
     Getting *note full_url: 8ec. returns the original request URL with
     the fragment, if it was present.

 -- Attribute: Request.type

     The URI scheme.

 -- Attribute: Request.host

     The URI authority, typically a host, but may also contain a port
     separated by a colon.

 -- Attribute: Request.origin_req_host

     The original host for the request, without port.

 -- Attribute: Request.selector

     The URI path.  If the *note Request: 8ea. uses a proxy, then
     selector will be the full URL that is passed to the proxy.

 -- Attribute: Request.data

     The entity body for the request, or ‘None’ if not specified.

     Changed in version 3.4: Changing value of *note Request.data: 8ed.
     now deletes “Content-Length” header if it was previously set or
     calculated.

 -- Attribute: Request.unverifiable

     boolean, indicates whether the request is unverifiable as defined
     by RFC 2965(1).

 -- Attribute: Request.method

     The HTTP request method to use.  By default its value is *note
     None: 157, which means that *note get_method(): ab6. will do its
     normal computation of the method to be used.  Its value can be set
     (thus overriding the default computation in *note get_method():
     ab6.) either by providing a default value by setting it at the
     class level in a *note Request: 8ea. subclass, or by passing a
     value in to the *note Request: 8ea. constructor via the `method'
     argument.

     New in version 3.3.

     Changed in version 3.4: A default value can now be set in
     subclasses; previously it could only be set via the constructor
     argument.

 -- Method: Request.get_method ()

     Return a string indicating the HTTP request method.  If *note
     Request.method: 8eb. is not ‘None’, return its value, otherwise
     return ‘'GET'’ if *note Request.data: 8ed. is ‘None’, or ‘'POST'’
     if it’s not.  This is only meaningful for HTTP requests.

     Changed in version 3.3: get_method now looks at the value of *note
     Request.method: 8eb.

 -- Method: Request.add_header (key, val)

     Add another header to the request.  Headers are currently ignored
     by all handlers except HTTP handlers, where they are added to the
     list of headers sent to the server.  Note that there cannot be more
     than one header with the same name, and later calls will overwrite
     previous calls in case the `key' collides.  Currently, this is no
     loss of HTTP functionality, since all headers which have meaning
     when used more than once have a (header-specific) way of gaining
     the same functionality using only one header.

 -- Method: Request.add_unredirected_header (key, header)

     Add a header that will not be added to a redirected request.

 -- Method: Request.has_header (header)

     Return whether the instance has the named header (checks both
     regular and unredirected).

 -- Method: Request.remove_header (header)

     Remove named header from the request instance (both from regular
     and unredirected headers).

     New in version 3.4.

 -- Method: Request.get_full_url ()

     Return the URL given in the constructor.

     Changed in version 3.4.

     Returns *note Request.full_url: 8ec.

 -- Method: Request.set_proxy (host, type)

     Prepare the request by connecting to a proxy server.  The `host'
     and `type' will replace those of the instance, and the instance’s
     selector will be the original URL given in the constructor.

 -- Method: Request.get_header (header_name, default=None)

     Return the value of the given header.  If the header is not
     present, return the default value.

 -- Method: Request.header_items ()

     Return a list of tuples (header_name, header_value) of the Request
     headers.

Changed in version 3.4: The request methods add_data, has_data,
get_data, get_type, get_host, get_selector, get_origin_req_host and
is_unverifiable that were deprecated since 3.3 have been removed.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2965.html


File: python.info,  Node: OpenerDirector Objects,  Next: BaseHandler Objects,  Prev: Request Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.2 OpenerDirector Objects
...............................

*note OpenerDirector: 2b6e. instances have the following methods:

 -- Method: OpenerDirector.add_handler (handler)

     `handler' should be an instance of *note BaseHandler: 2b72.  The
     following methods are searched, and added to the possible chains
     (note that HTTP errors are a special case).  Note that, in the
     following, `protocol' should be replaced with the actual protocol
     to handle, for example ‘http_response()’ would be the HTTP protocol
     response handler.  Also `type' should be replaced with the actual
     HTTP code, for example ‘http_error_404()’ would handle HTTP 404
     errors.

        * ‘<protocol>_open()’ — signal that the handler knows how to
          open `protocol' URLs.

          See *note BaseHandler.<protocol>_open(): 2b99. for more
          information.

        * ‘http_error_<type>()’ — signal that the handler knows how to
          handle HTTP errors with HTTP error code `type'.

          See *note BaseHandler.http_error_<nnn>(): 2b9a. for more
          information.

        * ‘<protocol>_error()’ — signal that the handler knows how to
          handle errors from (non-‘http’) `protocol'.

        * ‘<protocol>_request()’ — signal that the handler knows how to
          pre-process `protocol' requests.

          See *note BaseHandler.<protocol>_request(): 2b9b. for more
          information.

        * ‘<protocol>_response()’ — signal that the handler knows how to
          post-process `protocol' responses.

          See *note BaseHandler.<protocol>_response(): 2b9c. for more
          information.

 -- Method: OpenerDirector.open (url, data=None[, timeout])

     Open the given `url' (which can be a request object or a string),
     optionally passing the given `data'.  Arguments, return values and
     exceptions raised are the same as those of *note urlopen(): 780.
     (which simply calls the *note open(): 4e5. method on the currently
     installed global *note OpenerDirector: 2b6e.).  The optional
     `timeout' parameter specifies a timeout in seconds for blocking
     operations like the connection attempt (if not specified, the
     global default timeout setting will be used).  The timeout feature
     actually works only for HTTP, HTTPS and FTP connections).

 -- Method: OpenerDirector.error (proto, *args)

     Handle an error of the given protocol.  This will call the
     registered error handlers for the given protocol with the given
     arguments (which are protocol specific).  The HTTP protocol is a
     special case which uses the HTTP response code to determine the
     specific error handler; refer to the ‘http_error_<type>()’ methods
     of the handler classes.

     Return values and exceptions raised are the same as those of *note
     urlopen(): 780.

OpenerDirector objects open URLs in three stages:

The order in which these methods are called within each stage is
determined by sorting the handler instances.

  1. Every handler with a method named like ‘<protocol>_request()’ has
     that method called to pre-process the request.

  2. Handlers with a method named like ‘<protocol>_open()’ are called to
     handle the request.  This stage ends when a handler either returns
     a non-*note None: 157. value (ie.  a response), or raises an
     exception (usually *note URLError: 2b6d.).  Exceptions are allowed
     to propagate.

     In fact, the above algorithm is first tried for methods named
     ‘default_open()’.  If all such methods return *note None: 157, the
     algorithm is repeated for methods named like ‘<protocol>_open()’.
     If all such methods return *note None: 157, the algorithm is
     repeated for methods named ‘unknown_open()’.

     Note that the implementation of these methods may involve calls of
     the parent *note OpenerDirector: 2b6e. instance’s *note open():
     8ee. and *note error(): 2b9d. methods.

  3. Every handler with a method named like ‘<protocol>_response()’ has
     that method called to post-process the response.


File: python.info,  Node: BaseHandler Objects,  Next: HTTPRedirectHandler Objects,  Prev: OpenerDirector Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.3 BaseHandler Objects
............................

*note BaseHandler: 2b72. objects provide a couple of methods that are
directly useful, and others that are meant to be used by derived
classes.  These are intended for direct use:

 -- Method: BaseHandler.add_parent (director)

     Add a director as parent.

 -- Method: BaseHandler.close ()

     Remove any parents.

The following attribute and methods should only be used by classes
derived from *note BaseHandler: 2b72.

     Note: The convention has been adopted that subclasses defining
     ‘<protocol>_request()’ or ‘<protocol>_response()’ methods are named
     ‘*Processor’; all others are named ‘*Handler’.

 -- Attribute: BaseHandler.parent

     A valid *note OpenerDirector: 2b6e, which can be used to open using
     a different protocol, or handle errors.

 -- Method: BaseHandler.default_open (req)

     This method is `not' defined in *note BaseHandler: 2b72, but
     subclasses should define it if they want to catch all URLs.

     This method, if implemented, will be called by the parent *note
     OpenerDirector: 2b6e.  It should return a file-like object as
     described in the return value of the *note open(): 4e5. of *note
     OpenerDirector: 2b6e, or ‘None’.  It should raise *note URLError:
     2b6d, unless a truly exceptional thing happens (for example, *note
     MemoryError: f42. should not be mapped to ‘URLError’).

     This method will be called before any protocol-specific open
     method.

 -- Method: BaseHandler.<protocol>_open(req)

     This method is `not' defined in *note BaseHandler: 2b72, but
     subclasses should define it if they want to handle URLs with the
     given protocol.

     This method, if defined, will be called by the parent *note
     OpenerDirector: 2b6e.  Return values should be the same as for
     ‘default_open()’.

 -- Method: BaseHandler.unknown_open (req)

     This method is `not' defined in *note BaseHandler: 2b72, but
     subclasses should define it if they want to catch all URLs with no
     specific registered handler to open it.

     This method, if implemented, will be called by the *note parent:
     2ba2. *note OpenerDirector: 2b6e.  Return values should be the same
     as for *note default_open(): 2ba3.

 -- Method: BaseHandler.http_error_default (req, fp, code, msg, hdrs)

     This method is `not' defined in *note BaseHandler: 2b72, but
     subclasses should override it if they intend to provide a catch-all
     for otherwise unhandled HTTP errors.  It will be called
     automatically by the *note OpenerDirector: 2b6e. getting the error,
     and should not normally be called in other circumstances.

     `req' will be a *note Request: 8ea. object, `fp' will be a
     file-like object with the HTTP error body, `code' will be the
     three-digit code of the error, `msg' will be the user-visible
     explanation of the code and `hdrs' will be a mapping object with
     the headers of the error.

     Return values and exceptions raised should be the same as those of
     *note urlopen(): 780.

 -- Method: BaseHandler.http_error_<nnn>(req, fp, code, msg, hdrs)

     `nnn' should be a three-digit HTTP error code.  This method is also
     not defined in *note BaseHandler: 2b72, but will be called, if it
     exists, on an instance of a subclass, when an HTTP error with code
     `nnn' occurs.

     Subclasses should override this method to handle specific HTTP
     errors.

     Arguments, return values and exceptions raised should be the same
     as for ‘http_error_default()’.

 -- Method: BaseHandler.<protocol>_request(req)

     This method is `not' defined in *note BaseHandler: 2b72, but
     subclasses should define it if they want to pre-process requests of
     the given protocol.

     This method, if defined, will be called by the parent *note
     OpenerDirector: 2b6e.  `req' will be a *note Request: 8ea. object.
     The return value should be a *note Request: 8ea. object.

 -- Method: BaseHandler.<protocol>_response(req, response)

     This method is `not' defined in *note BaseHandler: 2b72, but
     subclasses should define it if they want to post-process responses
     of the given protocol.

     This method, if defined, will be called by the parent *note
     OpenerDirector: 2b6e.  `req' will be a *note Request: 8ea. object.
     `response' will be an object implementing the same interface as the
     return value of *note urlopen(): 780.  The return value should
     implement the same interface as the return value of *note
     urlopen(): 780.


File: python.info,  Node: HTTPRedirectHandler Objects,  Next: HTTPCookieProcessor Objects,  Prev: BaseHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.4 HTTPRedirectHandler Objects
....................................

     Note: Some HTTP redirections require action from this module’s
     client code.  If this is the case, *note HTTPError: 8f0. is raised.
     See RFC 2616(1) for details of the precise meanings of the various
     redirection codes.

     An ‘HTTPError’ exception raised as a security consideration if the
     HTTPRedirectHandler is presented with a redirected URL which is not
     an HTTP, HTTPS or FTP URL.

 -- Method: HTTPRedirectHandler.redirect_request (req, fp, code, msg,
          hdrs, newurl)

     Return a *note Request: 8ea. or ‘None’ in response to a redirect.
     This is called by the default implementations of the
     ‘http_error_30*()’ methods when a redirection is received from the
     server.  If a redirection should take place, return a new *note
     Request: 8ea. to allow ‘http_error_30*()’ to perform the redirect
     to `newurl'.  Otherwise, raise *note HTTPError: 8f0. if no other
     handler should try to handle this URL, or return ‘None’ if you
     can’t but another handler might.

          Note: The default implementation of this method does not
          strictly follow RFC 2616(2), which says that 301 and 302
          responses to ‘POST’ requests must not be automatically
          redirected without confirmation by the user.  In reality,
          browsers do allow automatic redirection of these responses,
          changing the POST to a ‘GET’, and the default implementation
          reproduces this behavior.

 -- Method: HTTPRedirectHandler.http_error_301 (req, fp, code, msg,
          hdrs)

     Redirect to the ‘Location:’ or ‘URI:’ URL. This method is called by
     the parent *note OpenerDirector: 2b6e. when getting an HTTP ‘moved
     permanently’ response.

 -- Method: HTTPRedirectHandler.http_error_302 (req, fp, code, msg,
          hdrs)

     The same as *note http_error_301(): 2ba9, but called for the
     ‘found’ response.

 -- Method: HTTPRedirectHandler.http_error_303 (req, fp, code, msg,
          hdrs)

     The same as *note http_error_301(): 2ba9, but called for the ‘see
     other’ response.

 -- Method: HTTPRedirectHandler.http_error_307 (req, fp, code, msg,
          hdrs)

     The same as *note http_error_301(): 2ba9, but called for the
     ‘temporary redirect’ response.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2616.html

   (2) https://tools.ietf.org/html/rfc2616.html


File: python.info,  Node: HTTPCookieProcessor Objects,  Next: ProxyHandler Objects,  Prev: HTTPRedirectHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.5 HTTPCookieProcessor Objects
....................................

*note HTTPCookieProcessor: 2b7e. instances have one attribute:

 -- Attribute: HTTPCookieProcessor.cookiejar

     The *note http.cookiejar.CookieJar: 2bb0. in which cookies are
     stored.


File: python.info,  Node: ProxyHandler Objects,  Next: HTTPPasswordMgr Objects,  Prev: HTTPCookieProcessor Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.6 ProxyHandler Objects
.............................

 -- Method: ProxyHandler.<protocol>_open(request)

     The *note ProxyHandler: eac. will have a method ‘<protocol>_open()’
     for every `protocol' which has a proxy in the `proxies' dictionary
     given in the constructor.  The method will modify requests to go
     through the proxy, by calling ‘request.set_proxy()’, and call the
     next handler in the chain to actually execute the protocol.


File: python.info,  Node: HTTPPasswordMgr Objects,  Next: HTTPPasswordMgrWithPriorAuth Objects,  Prev: ProxyHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.7 HTTPPasswordMgr Objects
................................

These methods are available on *note HTTPPasswordMgr: 2b7f. and *note
HTTPPasswordMgrWithDefaultRealm: 2b80. objects.

 -- Method: HTTPPasswordMgr.add_password (realm, uri, user, passwd)

     `uri' can be either a single URI, or a sequence of URIs.  `realm',
     `user' and `passwd' must be strings.  This causes ‘(user, passwd)’
     to be used as authentication tokens when authentication for `realm'
     and a super-URI of any of the given URIs is given.

 -- Method: HTTPPasswordMgr.find_user_password (realm, authuri)

     Get user/password for given realm and URI, if any.  This method
     will return ‘(None, None)’ if there is no matching user/password.

     For *note HTTPPasswordMgrWithDefaultRealm: 2b80. objects, the realm
     ‘None’ will be searched if the given `realm' has no matching
     user/password.


File: python.info,  Node: HTTPPasswordMgrWithPriorAuth Objects,  Next: AbstractBasicAuthHandler Objects,  Prev: HTTPPasswordMgr Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.8 HTTPPasswordMgrWithPriorAuth Objects
.............................................

This password manager extends *note HTTPPasswordMgrWithDefaultRealm:
2b80. to support tracking URIs for which authentication credentials
should always be sent.

 -- Method: HTTPPasswordMgrWithPriorAuth.add_password (realm, uri, user,
          passwd, is_authenticated=False)

     `realm', `uri', `user', `passwd' are as for *note
     HTTPPasswordMgr.add_password(): 2bb4.  `is_authenticated' sets the
     initial value of the ‘is_authenticated’ flag for the given URI or
     list of URIs.  If `is_authenticated' is specified as ‘True’,
     `realm' is ignored.

 -- Method: HTTPPasswordMgr.find_user_password (realm, authuri)

     Same as for *note HTTPPasswordMgrWithDefaultRealm: 2b80. objects

 -- Method: HTTPPasswordMgrWithPriorAuth.update_authenticated (self,
          uri, is_authenticated=False)

     Update the ‘is_authenticated’ flag for the given `uri' or list of
     URIs.

 -- Method: HTTPPasswordMgrWithPriorAuth.is_authenticated (self,
          authuri)

     Returns the current state of the ‘is_authenticated’ flag for the
     given URI.


File: python.info,  Node: AbstractBasicAuthHandler Objects,  Next: HTTPBasicAuthHandler Objects,  Prev: HTTPPasswordMgrWithPriorAuth Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.9 AbstractBasicAuthHandler Objects
.........................................

 -- Method: AbstractBasicAuthHandler.http_error_auth_reqed (authreq,
          host, req, headers)

     Handle an authentication request by getting a user/password pair,
     and re-trying the request.  `authreq' should be the name of the
     header where the information about the realm is included in the
     request, `host' specifies the URL and path to authenticate for,
     `req' should be the (failed) *note Request: 8ea. object, and
     `headers' should be the error headers.

     `host' is either an authority (e.g.  ‘"python.org"’) or a URL
     containing an authority component (e.g.  ‘"http://python.org/"’).
     In either case, the authority must not contain a userinfo component
     (so, ‘"python.org"’ and ‘"python.org:80"’ are fine,
     ‘"joe:password@python.org"’ is not).


File: python.info,  Node: HTTPBasicAuthHandler Objects,  Next: ProxyBasicAuthHandler Objects,  Prev: AbstractBasicAuthHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.10 HTTPBasicAuthHandler Objects
......................................

 -- Method: HTTPBasicAuthHandler.http_error_401 (req, fp, code, msg,
          hdrs)

     Retry the request with authentication information, if available.


File: python.info,  Node: ProxyBasicAuthHandler Objects,  Next: AbstractDigestAuthHandler Objects,  Prev: HTTPBasicAuthHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.11 ProxyBasicAuthHandler Objects
.......................................

 -- Method: ProxyBasicAuthHandler.http_error_407 (req, fp, code, msg,
          hdrs)

     Retry the request with authentication information, if available.


File: python.info,  Node: AbstractDigestAuthHandler Objects,  Next: HTTPDigestAuthHandler Objects,  Prev: ProxyBasicAuthHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.12 AbstractDigestAuthHandler Objects
...........................................

 -- Method: AbstractDigestAuthHandler.http_error_auth_reqed (authreq,
          host, req, headers)

     `authreq' should be the name of the header where the information
     about the realm is included in the request, `host' should be the
     host to authenticate to, `req' should be the (failed) *note
     Request: 8ea. object, and `headers' should be the error headers.


File: python.info,  Node: HTTPDigestAuthHandler Objects,  Next: ProxyDigestAuthHandler Objects,  Prev: AbstractDigestAuthHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.13 HTTPDigestAuthHandler Objects
.......................................

 -- Method: HTTPDigestAuthHandler.http_error_401 (req, fp, code, msg,
          hdrs)

     Retry the request with authentication information, if available.


File: python.info,  Node: ProxyDigestAuthHandler Objects,  Next: HTTPHandler Objects,  Prev: HTTPDigestAuthHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.14 ProxyDigestAuthHandler Objects
........................................

 -- Method: ProxyDigestAuthHandler.http_error_407 (req, fp, code, msg,
          hdrs)

     Retry the request with authentication information, if available.


File: python.info,  Node: HTTPHandler Objects,  Next: HTTPSHandler Objects,  Prev: ProxyDigestAuthHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.15 HTTPHandler Objects
.............................

 -- Method: HTTPHandler.http_open (req)

     Send an HTTP request, which can be either GET or POST, depending on
     ‘req.has_data()’.


File: python.info,  Node: HTTPSHandler Objects,  Next: FileHandler Objects,  Prev: HTTPHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.16 HTTPSHandler Objects
..............................

 -- Method: HTTPSHandler.https_open (req)

     Send an HTTPS request, which can be either GET or POST, depending
     on ‘req.has_data()’.


File: python.info,  Node: FileHandler Objects,  Next: DataHandler Objects,  Prev: HTTPSHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.17 FileHandler Objects
.............................

 -- Method: FileHandler.file_open (req)

     Open the file locally, if there is no host name, or the host name
     is ‘'localhost'’.

     Changed in version 3.2: This method is applicable only for local
     hostnames.  When a remote hostname is given, an *note URLError:
     2b6d. is raised.


File: python.info,  Node: DataHandler Objects,  Next: FTPHandler Objects,  Prev: FileHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.18 DataHandler Objects
.............................

 -- Method: DataHandler.data_open (req)

     Read a data URL. This kind of URL contains the content encoded in
     the URL itself.  The data URL syntax is specified in RFC 2397(1).
     This implementation ignores white spaces in base64 encoded data
     URLs so the URL may be wrapped in whatever source file it comes
     from.  But even though some browsers don’t mind about a missing
     padding at the end of a base64 encoded data URL, this
     implementation will raise an *note ValueError: 1f9. in that case.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2397.html


File: python.info,  Node: FTPHandler Objects,  Next: CacheFTPHandler Objects,  Prev: DataHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.19 FTPHandler Objects
............................

 -- Method: FTPHandler.ftp_open (req)

     Open the FTP file indicated by `req'.  The login is always done
     with empty username and password.


File: python.info,  Node: CacheFTPHandler Objects,  Next: UnknownHandler Objects,  Prev: FTPHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.20 CacheFTPHandler Objects
.................................

*note CacheFTPHandler: 2b88. objects are *note FTPHandler: 2b76. objects
with the following additional methods:

 -- Method: CacheFTPHandler.setTimeout (t)

     Set timeout of connections to `t' seconds.

 -- Method: CacheFTPHandler.setMaxConns (m)

     Set maximum number of cached connections to `m'.


File: python.info,  Node: UnknownHandler Objects,  Next: HTTPErrorProcessor Objects,  Prev: CacheFTPHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.21 UnknownHandler Objects
................................

 -- Method: UnknownHandler.unknown_open ()

     Raise a *note URLError: 2b6d. exception.


File: python.info,  Node: HTTPErrorProcessor Objects,  Next: Examples<21>,  Prev: UnknownHandler Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.22 HTTPErrorProcessor Objects
....................................

 -- Method: HTTPErrorProcessor.http_response (request, response)

     Process HTTP error responses.

     For 200 error codes, the response object is returned immediately.

     For non-200 error codes, this simply passes the job on to the
     ‘http_error_<type>()’ handler methods, via *note
     OpenerDirector.error(): 2b9d.  Eventually, *note
     HTTPDefaultErrorHandler: 2b74. will raise an *note HTTPError: 8f0.
     if no other handler handles the error.

 -- Method: HTTPErrorProcessor.https_response (request, response)

     Process HTTPS error responses.

     The behavior is same as *note http_response(): 2be4.


File: python.info,  Node: Examples<21>,  Next: Legacy interface,  Prev: HTTPErrorProcessor Objects,  Up: urllib request — Extensible library for opening URLs

5.22.6.23 Examples
..................

In addition to the examples below, more examples are given in *note
HOWTO Fetch Internet Resources Using The urllib Package: 2be8.

This example gets the python.org main page and displays the first 300
bytes of it.

     >>> import urllib.request >>> with urllib.request.urlopen('http://www.python.org/') as f: ...     print(f.read(300)) ... b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\n\n<head>\n <meta http-equiv="content-type" content="text/html; charset=utf-8" />\n <title>Python Programming '

Note that urlopen returns a bytes object.  This is because there is no
way for urlopen to automatically determine the encoding of the byte
stream it receives from the HTTP server.  In general, a program will
decode the returned bytes object to string once it determines or guesses
the appropriate encoding.

The following W3C document,
‘https://www.w3.org/International/O-charset’, lists the various ways in
which an (X)HTML or an XML document could have specified its encoding
information.

As the python.org website uses `utf-8' encoding as specified in its meta
tag, we will use the same for decoding the bytes object.

     >>> with urllib.request.urlopen('http://www.python.org/') as f: ...     print(f.read(100).decode('utf-8')) ... <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtm

It is also possible to achieve the same result without using the *note
context manager: 55d. approach.

     >>> import urllib.request >>> f = urllib.request.urlopen('http://www.python.org/') >>> print(f.read(100).decode('utf-8')) <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtm

In the following example, we are sending a data-stream to the stdin of a
CGI and reading the data it returns to us.  Note that this example will
only work when the Python installation supports SSL.

     >>> import urllib.request >>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi', ...                       data=b'This data is passed to stdin of the CGI') >>> with urllib.request.urlopen(req) as f: ...     print(f.read().decode('utf-8')) ... Got Data: "This data is passed to stdin of the CGI"

The code for the sample CGI used in the above example is:

     #!/usr/bin/env python import sys data = sys.stdin.read() print('Content-type: text/plain\n\nGot Data: "%s"' % data)

Here is an example of doing a ‘PUT’ request using *note Request: 8ea.:

     import urllib.request DATA = b'some data' req = urllib.request.Request(url='http://localhost:8080', data=DATA,method='PUT') with urllib.request.urlopen(req) as f:     pass print(f.status) print(f.reason)

Use of Basic HTTP Authentication:

     import urllib.request # Create an OpenerDirector with support for Basic HTTP Authentication... auth_handler = urllib.request.HTTPBasicAuthHandler() auth_handler.add_password(realm='PDQ Application',                           uri='https://mahler:8092/site-updates.py',                           user='klem',                           passwd='kadidd!ehopper') opener = urllib.request.build_opener(auth_handler) # ...and install it globally so it can be used with urlopen. urllib.request.install_opener(opener) urllib.request.urlopen('http://www.example.com/login.html')

*note build_opener(): 2b71. provides many handlers by default, including
a *note ProxyHandler: eac.  By default, *note ProxyHandler: eac. uses
the environment variables named ‘<scheme>_proxy’, where ‘<scheme>’ is
the URL scheme involved.  For example, the ‘http_proxy’ environment
variable is read to obtain the HTTP proxy’s URL.

This example replaces the default *note ProxyHandler: eac. with one that
uses programmatically-supplied proxy URLs, and adds proxy authorization
support with *note ProxyBasicAuthHandler: 2b85.

     proxy_handler = urllib.request.ProxyHandler({'http': 'http://www.example.com:3128/'}) proxy_auth_handler = urllib.request.ProxyBasicAuthHandler() proxy_auth_handler.add_password('realm', 'host', 'username', 'password')  opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler) # This time, rather than install the OpenerDirector, we use it directly: opener.open('http://www.example.com/login.html')

Adding HTTP headers:

Use the `headers' argument to the *note Request: 8ea. constructor, or:

     import urllib.request req = urllib.request.Request('http://www.example.com/') req.add_header('Referer', 'http://www.python.org/') # Customize the default User-Agent header value: req.add_header('User-Agent', 'urllib-example/0.1 (Contact: . . .)') r = urllib.request.urlopen(req)

*note OpenerDirector: 2b6e. automatically adds a ‘User-Agent’ header to
every *note Request: 8ea.  To change this:

     import urllib.request opener = urllib.request.build_opener() opener.addheaders = [('User-agent', 'Mozilla/5.0')] opener.open('http://www.example.com/')

Also, remember that a few standard headers (‘Content-Length’,
‘Content-Type’ and ‘Host’) are added when the *note Request: 8ea. is
passed to *note urlopen(): 780. (or *note OpenerDirector.open(): 8ee.).
Here is an example session that uses the ‘GET’ method to retrieve a URL
containing parameters:

     >>> import urllib.request >>> import urllib.parse >>> params = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0}) >>> url = "http://www.musi-cal.com/cgi-bin/query?%s" % params >>> with urllib.request.urlopen(url) as f: ...     print(f.read().decode('utf-8')) ...

The following example uses the ‘POST’ method instead.  Note that params
output from urlencode is encoded to bytes before it is sent to urlopen
as data:

     >>> import urllib.request >>> import urllib.parse >>> data = urllib.parse.urlencode({'spam': 1, 'eggs': 2, 'bacon': 0}) >>> data = data.encode('ascii') >>> with urllib.request.urlopen("http://requestb.in/xrbl82xr", data) as f: ...     print(f.read().decode('utf-8')) ...

The following example uses an explicitly specified HTTP proxy,
overriding environment settings:

     >>> import urllib.request >>> proxies = {'http': 'http://proxy.example.com:8080/'} >>> opener = urllib.request.FancyURLopener(proxies) >>> with opener.open("http://www.python.org") as f: ...     f.read().decode('utf-8') ...

The following example uses no proxies at all, overriding environment
settings:

     >>> import urllib.request >>> opener = urllib.request.FancyURLopener({}) >>> with opener.open("http://www.python.org/") as f: ...     f.read().decode('utf-8') ...


File: python.info,  Node: Legacy interface,  Next: urllib request Restrictions,  Prev: Examples<21>,  Up: urllib request — Extensible library for opening URLs

5.22.6.24 Legacy interface
..........................

The following functions and classes are ported from the Python 2 module
‘urllib’ (as opposed to ‘urllib2’).  They might become deprecated at
some point in the future.

 -- Function: urllib.request.urlretrieve (url, filename=None,
          reporthook=None, data=None)

     Copy a network object denoted by a URL to a local file.  If the URL
     points to a local file, the object will not be copied unless
     filename is supplied.  Return a tuple ‘(filename, headers)’ where
     `filename' is the local file name under which the object can be
     found, and `headers' is whatever the ‘info()’ method of the object
     returned by *note urlopen(): 780. returned (for a remote object).
     Exceptions are the same as for *note urlopen(): 780.

     The second argument, if present, specifies the file location to
     copy to (if absent, the location will be a tempfile with a
     generated name).  The third argument, if present, is a callable
     that will be called once on establishment of the network connection
     and once after each block read thereafter.  The callable will be
     passed three arguments; a count of blocks transferred so far, a
     block size in bytes, and the total size of the file.  The third
     argument may be ‘-1’ on older FTP servers which do not return a
     file size in response to a retrieval request.

     The following example illustrates the most common usage scenario:

          >>> import urllib.request >>> local_filename, headers = urllib.request.urlretrieve('http://python.org/') >>> html = open(local_filename) >>> html.close()

     If the `url' uses the ‘http:’ scheme identifier, the optional
     `data' argument may be given to specify a ‘POST’ request (normally
     the request type is ‘GET’).  The `data' argument must be a bytes
     object in standard ‘application/x-www-form-urlencoded’ format; see
     the *note urllib.parse.urlencode(): 77f. function.

     *note urlretrieve(): 2beb. will raise ‘ContentTooShortError’ when
     it detects that the amount of data available was less than the
     expected amount (which is the size reported by a `Content-Length'
     header).  This can occur, for example, when the download is
     interrupted.

     The `Content-Length' is treated as a lower bound: if there’s more
     data to read, urlretrieve reads more data, but if less data is
     available, it raises the exception.

     You can still retrieve the downloaded data in this case, it is
     stored in the ‘content’ attribute of the exception instance.

     If no `Content-Length' header was supplied, urlretrieve can not
     check the size of the data it has downloaded, and just returns it.
     In this case you just have to assume that the download was
     successful.

 -- Function: urllib.request.urlcleanup ()

     Cleans up temporary files that may have been left behind by
     previous calls to *note urlretrieve(): 2beb.

 -- Class: urllib.request.URLopener (proxies=None, **x509)

     Deprecated since version 3.3.

     Base class for opening and reading URLs.  Unless you need to
     support opening objects using schemes other than ‘http:’, ‘ftp:’,
     or ‘file:’, you probably want to use *note FancyURLopener: 2b6c.

     By default, the *note URLopener: 2b6b. class sends a ‘User-Agent’
     header of ‘urllib/VVV’, where `VVV' is the *note urllib: 11d.
     version number.  Applications can define their own ‘User-Agent’
     header by subclassing *note URLopener: 2b6b. or *note
     FancyURLopener: 2b6c. and setting the class attribute *note
     version: 2bed. to an appropriate string value in the subclass
     definition.

     The optional `proxies' parameter should be a dictionary mapping
     scheme names to proxy URLs, where an empty dictionary turns proxies
     off completely.  Its default value is ‘None’, in which case
     environmental proxy settings will be used if present, as discussed
     in the definition of *note urlopen(): 780, above.

     Additional keyword parameters, collected in `x509', may be used for
     authentication of the client when using the ‘https:’ scheme.  The
     keywords `key_file' and `cert_file' are supported to provide an SSL
     key and certificate; both are needed to support client
     authentication.

     *note URLopener: 2b6b. objects will raise an *note OSError: 1d1.
     exception if the server returns an error code.

      -- Method: open (fullurl, data=None)

          Open `fullurl' using the appropriate protocol.  This method
          sets up cache and proxy information, then calls the
          appropriate open method with its input arguments.  If the
          scheme is not recognized, *note open_unknown(): 2bef. is
          called.  The `data' argument has the same meaning as the
          `data' argument of *note urlopen(): 780.

          This method always quotes `fullurl' using *note quote(): 402.

      -- Method: open_unknown (fullurl, data=None)

          Overridable interface to open unknown URL types.

      -- Method: retrieve (url, filename=None, reporthook=None,
               data=None)

          Retrieves the contents of `url' and places it in `filename'.
          The return value is a tuple consisting of a local filename and
          either an *note email.message.Message: 536. object containing
          the response headers (for remote URLs) or ‘None’ (for local
          URLs).  The caller must then open and read the contents of
          `filename'.  If `filename' is not given and the URL refers to
          a local file, the input filename is returned.  If the URL is
          non-local and `filename' is not given, the filename is the
          output of *note tempfile.mktemp(): 1bac. with a suffix that
          matches the suffix of the last path component of the input
          URL. If `reporthook' is given, it must be a function accepting
          three numeric parameters: A chunk number, the maximum size
          chunks are read in and the total size of the download (-1 if
          unknown).  It will be called once at the start and after each
          chunk of data is read from the network.  `reporthook' is
          ignored for local URLs.

          If the `url' uses the ‘http:’ scheme identifier, the optional
          `data' argument may be given to specify a ‘POST’ request
          (normally the request type is ‘GET’).  The `data' argument
          must in standard ‘application/x-www-form-urlencoded’ format;
          see the *note urllib.parse.urlencode(): 77f. function.

      -- Attribute: version

          Variable that specifies the user agent of the opener object.
          To get *note urllib: 11d. to tell servers that it is a
          particular user agent, set this in a subclass as a class
          variable or in the constructor before calling the base
          constructor.

 -- Class: urllib.request.FancyURLopener (...)

     Deprecated since version 3.3.

     *note FancyURLopener: 2b6c. subclasses *note URLopener: 2b6b.
     providing default handling for the following HTTP response codes:
     301, 302, 303, 307 and 401.  For the 30x response codes listed
     above, the ‘Location’ header is used to fetch the actual URL. For
     401 response codes (authentication required), basic HTTP
     authentication is performed.  For the 30x response codes, recursion
     is bounded by the value of the `maxtries' attribute, which defaults
     to 10.

     For all other response codes, the method ‘http_error_default()’ is
     called which you can override in subclasses to handle the error
     appropriately.

          Note: According to the letter of RFC 2616(1), 301 and 302
          responses to POST requests must not be automatically
          redirected without confirmation by the user.  In reality,
          browsers do allow automatic redirection of these responses,
          changing the POST to a GET, and *note urllib: 11d. reproduces
          this behaviour.

     The parameters to the constructor are the same as those for *note
     URLopener: 2b6b.

          Note: When performing basic authentication, a *note
          FancyURLopener: 2b6c. instance calls its *note
          prompt_user_passwd(): 2bf0. method.  The default
          implementation asks the users for the required information on
          the controlling terminal.  A subclass may override this method
          to support more appropriate behavior if needed.

     The *note FancyURLopener: 2b6c. class offers one additional method
     that should be overloaded to provide the appropriate behavior:

      -- Method: prompt_user_passwd (host, realm)

          Return information needed to authenticate the user at the
          given host in the specified security realm.  The return value
          should be a tuple, ‘(user, password)’, which can be used for
          basic authentication.

          The implementation prompts for this information on the
          terminal; an application should override this method to use an
          appropriate interaction model in the local environment.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2616.html


File: python.info,  Node: urllib request Restrictions,  Prev: Legacy interface,  Up: urllib request — Extensible library for opening URLs

5.22.6.25 ‘urllib.request’ Restrictions
.......................................

   * Currently, only the following protocols are supported: HTTP
     (versions 0.9 and 1.0), FTP, local files, and data URLs.

     Changed in version 3.4: Added support for data URLs.

   * The caching feature of *note urlretrieve(): 2beb. has been disabled
     until someone finds the time to hack proper processing of
     Expiration time headers.

   * There should be a function to query whether a particular URL is in
     the cache.

   * For backward compatibility, if a URL appears to point to a local
     file but the file can’t be opened, the URL is re-interpreted using
     the FTP protocol.  This can sometimes cause confusing error
     messages.

   * The *note urlopen(): 780. and *note urlretrieve(): 2beb. functions
     can cause arbitrarily long delays while waiting for a network
     connection to be set up.  This means that it is difficult to build
     an interactive Web client using these functions without using
     threads.

   * The data returned by *note urlopen(): 780. or *note urlretrieve():
     2beb. is the raw data returned by the server.  This may be binary
     data (such as an image), plain text or (for example) HTML. The HTTP
     protocol provides type information in the reply header, which can
     be inspected by looking at the ‘Content-Type’ header.  If the
     returned data is HTML, you can use the module *note html.parser:
     92. to parse it.

   * The code handling the FTP protocol cannot differentiate between a
     file and a directory.  This can lead to unexpected behavior when
     attempting to read a URL that points to a file that is not
     accessible.  If the URL ends in a ‘/’, it is assumed to refer to a
     directory and will be handled accordingly.  But if an attempt to
     read a file leads to a 550 error (meaning the URL cannot be found
     or is not accessible, often for permission reasons), then the path
     is treated as a directory in order to handle the case when a
     directory is specified by a URL but the trailing ‘/’ has been left
     off.  This can cause misleading results when you try to fetch a
     file whose read permissions make it inaccessible; the FTP code will
     try to read it, fail with a 550 error, and then perform a directory
     listing for the unreadable file.  If fine-grained control is
     needed, consider using the *note ftplib: 84. module, subclassing
     *note FancyURLopener: 2b6c, or changing `_urlopener' to meet your
     needs.


File: python.info,  Node: urllib response — Response classes used by urllib,  Next: urllib parse — Parse URLs into components,  Prev: urllib request — Extensible library for opening URLs,  Up: Internet Protocols and Support

5.22.7 ‘urllib.response’ — Response classes used by urllib
----------------------------------------------------------

The *note urllib.response: 121. module defines functions and classes
which define a minimal file like interface, including ‘read()’ and
‘readline()’.  The typical response object is an addinfourl instance,
which defines an ‘info()’ method and that returns headers and a
‘geturl()’ method that returns the url.  Functions defined by this
module are used internally by the *note urllib.request: 120. module.


File: python.info,  Node: urllib parse — Parse URLs into components,  Next: urllib error — Exception classes raised by urllib request,  Prev: urllib response — Response classes used by urllib,  Up: Internet Protocols and Support

5.22.8 ‘urllib.parse’ — Parse URLs into components
--------------------------------------------------

`Source code:' Lib/urllib/parse.py(1)

__________________________________________________________________

This module defines a standard interface to break Uniform Resource
Locator (URL) strings up in components (addressing scheme, network
location, path etc.), to combine the components back into a URL string,
and to convert a “relative URL” to an absolute URL given a “base URL.”

The module has been designed to match the Internet RFC on Relative
Uniform Resource Locators.  It supports the following URL schemes:
‘file’, ‘ftp’, ‘gopher’, ‘hdl’, ‘http’, ‘https’, ‘imap’, ‘mailto’,
‘mms’, ‘news’, ‘nntp’, ‘prospero’, ‘rsync’, ‘rtsp’, ‘rtspu’, ‘sftp’,
‘shttp’, ‘sip’, ‘sips’, ‘snews’, ‘svn’, ‘svn+ssh’, ‘telnet’, ‘wais’,
‘ws’, ‘wss’.

The *note urllib.parse: 11f. module defines functions that fall into two
broad categories: URL parsing and URL quoting.  These are covered in
detail in the following sections.

* Menu:

* URL Parsing::
* Parsing ASCII Encoded Bytes::
* Structured Parse Results::
* URL Quoting::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/urllib/parse.py


File: python.info,  Node: URL Parsing,  Next: Parsing ASCII Encoded Bytes,  Up: urllib parse — Parse URLs into components

5.22.8.1 URL Parsing
....................

The URL parsing functions focus on splitting a URL string into its
components, or on combining URL components into a URL string.

 -- Function: urllib.parse.urlparse (urlstring, scheme='',
          allow_fragments=True)

     Parse a URL into six components, returning a 6-item *note named
     tuple: a98.  This corresponds to the general structure of a URL:
     ‘scheme://netloc/path;parameters?query#fragment’.  Each tuple item
     is a string, possibly empty.  The components are not broken up in
     smaller parts (for example, the network location is a single
     string), and % escapes are not expanded.  The delimiters as shown
     above are not part of the result, except for a leading slash in the
     `path' component, which is retained if present.  For example:

          >>> from urllib.parse import urlparse >>> o = urlparse('http://www.cwi.nl:80/%7Eguido/Python.html') >>> o   # doctest: +NORMALIZE_WHITESPACE ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',             params='', query='', fragment='') >>> o.scheme 'http' >>> o.port 80 >>> o.geturl() 'http://www.cwi.nl:80/%7Eguido/Python.html'

     Following the syntax specifications in RFC 1808(1), urlparse
     recognizes a netloc only if it is properly introduced by ‘//’.
     Otherwise the input is presumed to be a relative URL and thus to
     start with a path component.

           >>> from urllib.parse import urlparse  >>> urlparse('//www.cwi.nl:80/%7Eguido/Python.html')  ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',             params='', query='', fragment='')  >>> urlparse('www.cwi.nl/%7Eguido/Python.html')  ParseResult(scheme='', netloc='', path='www.cwi.nl/%7Eguido/Python.html',             params='', query='', fragment='')  >>> urlparse('help/Python.html')  ParseResult(scheme='', netloc='', path='help/Python.html', params='',             query='', fragment='')

     The `scheme' argument gives the default addressing scheme, to be
     used only if the URL does not specify one.  It should be the same
     type (text or bytes) as `urlstring', except that the default value
     ‘''’ is always allowed, and is automatically converted to ‘b''’ if
     appropriate.

     If the `allow_fragments' argument is false, fragment identifiers
     are not recognized.  Instead, they are parsed as part of the path,
     parameters or query component, and ‘fragment’ is set to the empty
     string in the return value.

     The return value is a *note named tuple: a98, which means that its
     items can be accessed by index or as named attributes, which are:

     Attribute              Index       Value                          Value if not present
                                                                       
     ---------------------------------------------------------------------------------------------
                                                                       
     ‘scheme’               0           URL scheme specifier           `scheme' parameter
                                                                       
                                                                       
     ‘netloc’               1           Network location part          empty string
                                                                       
                                                                       
     ‘path’                 2           Hierarchical path              empty string
                                                                       
                                                                       
     ‘params’               3           Parameters for last path       empty string
                                        element                        
                                        
                                                                       
     ‘query’                4           Query component                empty string
                                                                       
                                                                       
     ‘fragment’             5           Fragment identifier            empty string
                                                                       
                                                                       
     ‘username’                         User name                      *note None: 157.
                                                                       
                                                                       
     ‘password’                         Password                       *note None: 157.
                                                                       
                                                                       
     ‘hostname’                         Host name (lower case)         *note None: 157.
                                                                       
                                                                       
     ‘port’                             Port number as integer, if     *note None: 157.
                                        present                        
                                        

     Reading the ‘port’ attribute will raise a *note ValueError: 1f9. if
     an invalid port is specified in the URL. See section *note
     Structured Parse Results: 2bf6. for more information on the result
     object.

     Unmatched square brackets in the ‘netloc’ attribute will raise a
     *note ValueError: 1f9.

     Characters in the ‘netloc’ attribute that decompose under NFKC
     normalization (as used by the IDNA encoding) into any of ‘/’, ‘?’,
     ‘#’, ‘@’, or ‘:’ will raise a *note ValueError: 1f9.  If the URL is
     decomposed before parsing, no error will be raised.

     As is the case with all named tuples, the subclass has a few
     additional methods and attributes that are particularly useful.
     One such method is ‘_replace()’.  The ‘_replace()’ method will
     return a new ParseResult object replacing specified fields with new
     values.

           >>> from urllib.parse import urlparse  >>> u = urlparse('//www.cwi.nl:80/%7Eguido/Python.html')  >>> u  ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',              params='', query='', fragment='')  >>> u._replace(scheme='http')  ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',              params='', query='', fragment='')

     Changed in version 3.2: Added IPv6 URL parsing capabilities.

     Changed in version 3.3: The fragment is now parsed for all URL
     schemes (unless `allow_fragment' is false), in accordance with RFC
     3986(2).  Previously, a whitelist of schemes that support fragments
     existed.

     Changed in version 3.6: Out-of-range port numbers now raise *note
     ValueError: 1f9, instead of returning *note None: 157.

     Changed in version 3.8: Characters that affect netloc parsing under
     NFKC normalization will now raise *note ValueError: 1f9.

 -- Function: urllib.parse.parse_qs (qs, keep_blank_values=False,
          strict_parsing=False, encoding='utf-8', errors='replace',
          max_num_fields=None)

     Parse a query string given as a string argument (data of type
     ‘application/x-www-form-urlencoded’).  Data are returned as a
     dictionary.  The dictionary keys are the unique query variable
     names and the values are lists of values for each name.

     The optional argument `keep_blank_values' is a flag indicating
     whether blank values in percent-encoded queries should be treated
     as blank strings.  A true value indicates that blanks should be
     retained as blank strings.  The default false value indicates that
     blank values are to be ignored and treated as if they were not
     included.

     The optional argument `strict_parsing' is a flag indicating what to
     do with parsing errors.  If false (the default), errors are
     silently ignored.  If true, errors raise a *note ValueError: 1f9.
     exception.

     The optional `encoding' and `errors' parameters specify how to
     decode percent-encoded sequences into Unicode characters, as
     accepted by the *note bytes.decode(): c2b. method.

     The optional argument `max_num_fields' is the maximum number of
     fields to read.  If set, then throws a *note ValueError: 1f9. if
     there are more than `max_num_fields' fields read.

     Use the *note urllib.parse.urlencode(): 77f. function (with the
     ‘doseq’ parameter set to ‘True’) to convert such dictionaries into
     query strings.

     Changed in version 3.2: Add `encoding' and `errors' parameters.

     Changed in version 3.8: Added `max_num_fields' parameter.

 -- Function: urllib.parse.parse_qsl (qs, keep_blank_values=False,
          strict_parsing=False, encoding='utf-8', errors='replace',
          max_num_fields=None)

     Parse a query string given as a string argument (data of type
     ‘application/x-www-form-urlencoded’).  Data are returned as a list
     of name, value pairs.

     The optional argument `keep_blank_values' is a flag indicating
     whether blank values in percent-encoded queries should be treated
     as blank strings.  A true value indicates that blanks should be
     retained as blank strings.  The default false value indicates that
     blank values are to be ignored and treated as if they were not
     included.

     The optional argument `strict_parsing' is a flag indicating what to
     do with parsing errors.  If false (the default), errors are
     silently ignored.  If true, errors raise a *note ValueError: 1f9.
     exception.

     The optional `encoding' and `errors' parameters specify how to
     decode percent-encoded sequences into Unicode characters, as
     accepted by the *note bytes.decode(): c2b. method.

     The optional argument `max_num_fields' is the maximum number of
     fields to read.  If set, then throws a *note ValueError: 1f9. if
     there are more than `max_num_fields' fields read.

     Use the *note urllib.parse.urlencode(): 77f. function to convert
     such lists of pairs into query strings.

     Changed in version 3.2: Add `encoding' and `errors' parameters.

     Changed in version 3.8: Added `max_num_fields' parameter.

 -- Function: urllib.parse.urlunparse (parts)

     Construct a URL from a tuple as returned by ‘urlparse()’.  The
     `parts' argument can be any six-item iterable.  This may result in
     a slightly different, but equivalent URL, if the URL that was
     parsed originally had unnecessary delimiters (for example, a ‘?’
     with an empty query; the RFC states that these are equivalent).

 -- Function: urllib.parse.urlsplit (urlstring, scheme='',
          allow_fragments=True)

     This is similar to *note urlparse(): 5ef, but does not split the
     params from the URL. This should generally be used instead of *note
     urlparse(): 5ef. if the more recent URL syntax allowing parameters
     to be applied to each segment of the `path' portion of the URL (see
     RFC 2396(3)) is wanted.  A separate function is needed to separate
     the path segments and parameters.  This function returns a 5-item
     *note named tuple: a98.:

          (addressing scheme, network location, path, query, fragment identifier).

     The return value is a *note named tuple: a98, its items can be
     accessed by index or as named attributes:

     Attribute              Index       Value                         Value if not present
                                                                      
     --------------------------------------------------------------------------------------------
                                                                      
     ‘scheme’               0           URL scheme specifier          `scheme' parameter
                                                                      
                                                                      
     ‘netloc’               1           Network location part         empty string
                                                                      
                                                                      
     ‘path’                 2           Hierarchical path             empty string
                                                                      
                                                                      
     ‘query’                3           Query component               empty string
                                                                      
                                                                      
     ‘fragment’             4           Fragment identifier           empty string
                                                                      
                                                                      
     ‘username’                         User name                     *note None: 157.
                                                                      
                                                                      
     ‘password’                         Password                      *note None: 157.
                                                                      
                                                                      
     ‘hostname’                         Host name (lower case)        *note None: 157.
                                                                      
                                                                      
     ‘port’                             Port number as integer, if    *note None: 157.
                                        present                       
                                        

     Reading the ‘port’ attribute will raise a *note ValueError: 1f9. if
     an invalid port is specified in the URL. See section *note
     Structured Parse Results: 2bf6. for more information on the result
     object.

     Unmatched square brackets in the ‘netloc’ attribute will raise a
     *note ValueError: 1f9.

     Characters in the ‘netloc’ attribute that decompose under NFKC
     normalization (as used by the IDNA encoding) into any of ‘/’, ‘?’,
     ‘#’, ‘@’, or ‘:’ will raise a *note ValueError: 1f9.  If the URL is
     decomposed before parsing, no error will be raised.

     Changed in version 3.6: Out-of-range port numbers now raise *note
     ValueError: 1f9, instead of returning *note None: 157.

     Changed in version 3.8: Characters that affect netloc parsing under
     NFKC normalization will now raise *note ValueError: 1f9.

 -- Function: urllib.parse.urlunsplit (parts)

     Combine the elements of a tuple as returned by *note urlsplit():
     5ee. into a complete URL as a string.  The `parts' argument can be
     any five-item iterable.  This may result in a slightly different,
     but equivalent URL, if the URL that was parsed originally had
     unnecessary delimiters (for example, a ?  with an empty query; the
     RFC states that these are equivalent).

 -- Function: urllib.parse.urljoin (base, url, allow_fragments=True)

     Construct a full (“absolute”) URL by combining a “base URL”
     (`base') with another URL (`url').  Informally, this uses
     components of the base URL, in particular the addressing scheme,
     the network location and (part of) the path, to provide missing
     components in the relative URL. For example:

          >>> from urllib.parse import urljoin >>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', 'FAQ.html') 'http://www.cwi.nl/%7Eguido/FAQ.html'

     The `allow_fragments' argument has the same meaning and default as
     for *note urlparse(): 5ef.

          Note: If `url' is an absolute URL (that is, starting with ‘//’
          or ‘scheme://’), the `url'’s host name and/or scheme will be
          present in the result.  For example:

          >>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', ...         '//www.python.org/%7Eguido') 'http://www.python.org/%7Eguido'

     If you do not want that behavior, preprocess the `url' with *note
     urlsplit(): 5ee. and *note urlunsplit(): 2bf9, removing possible
     `scheme' and `netloc' parts.

     Changed in version 3.5: Behaviour updated to match the semantics
     defined in RFC 3986(4).

 -- Function: urllib.parse.urldefrag (url)

     If `url' contains a fragment identifier, return a modified version
     of `url' with no fragment identifier, and the fragment identifier
     as a separate string.  If there is no fragment identifier in `url',
     return `url' unmodified and an empty string.

     The return value is a *note named tuple: a98, its items can be
     accessed by index or as named attributes:

     Attribute              Index       Value                         Value if not present
                                                                      
     --------------------------------------------------------------------------------------------
                                                                      
     ‘url’                  0           URL with no fragment          empty string
                                                                      
                                                                      
     ‘fragment’             1           Fragment identifier           empty string
                                                                      

     See section *note Structured Parse Results: 2bf6. for more
     information on the result object.

     Changed in version 3.2: Result is a structured object rather than a
     simple 2-tuple.

 -- Function: urllib.parse.unwrap (url)

     Extract the url from a wrapped URL (that is, a string formatted as
     ‘<URL:scheme://host/path>’, ‘<scheme://host/path>’,
     ‘URL:scheme://host/path’ or ‘scheme://host/path’).  If `url' is not
     a wrapped URL, it is returned without changes.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc1808.html

   (2) https://tools.ietf.org/html/rfc3986.html

   (3) https://tools.ietf.org/html/rfc2396.html

   (4) https://tools.ietf.org/html/rfc3986.html


File: python.info,  Node: Parsing ASCII Encoded Bytes,  Next: Structured Parse Results,  Prev: URL Parsing,  Up: urllib parse — Parse URLs into components

5.22.8.2 Parsing ASCII Encoded Bytes
....................................

The URL parsing functions were originally designed to operate on
character strings only.  In practice, it is useful to be able to
manipulate properly quoted and encoded URLs as sequences of ASCII bytes.
Accordingly, the URL parsing functions in this module all operate on
*note bytes: 326. and *note bytearray: 327. objects in addition to *note
str: 325. objects.

If *note str: 325. data is passed in, the result will also contain only
*note str: 325. data.  If *note bytes: 326. or *note bytearray: 327.
data is passed in, the result will contain only *note bytes: 326. data.

Attempting to mix *note str: 325. data with *note bytes: 326. or *note
bytearray: 327. in a single function call will result in a *note
TypeError: 192. being raised, while attempting to pass in non-ASCII byte
values will trigger *note UnicodeDecodeError: 1fb.

To support easier conversion of result objects between *note str: 325.
and *note bytes: 326, all return values from URL parsing functions
provide either an ‘encode()’ method (when the result contains *note str:
325. data) or a ‘decode()’ method (when the result contains *note bytes:
326. data).  The signatures of these methods match those of the
corresponding *note str: 325. and *note bytes: 326. methods (except that
the default encoding is ‘'ascii'’ rather than ‘'utf-8'’).  Each produces
a value of a corresponding type that contains either *note bytes: 326.
data (for ‘encode()’ methods) or *note str: 325. data (for ‘decode()’
methods).

Applications that need to operate on potentially improperly quoted URLs
that may contain non-ASCII data will need to do their own decoding from
bytes to characters before invoking the URL parsing methods.

The behaviour described in this section applies only to the URL parsing
functions.  The URL quoting functions use their own rules when producing
or consuming byte sequences as detailed in the documentation of the
individual URL quoting functions.

Changed in version 3.2: URL parsing functions now accept ASCII encoded
byte sequences


File: python.info,  Node: Structured Parse Results,  Next: URL Quoting,  Prev: Parsing ASCII Encoded Bytes,  Up: urllib parse — Parse URLs into components

5.22.8.3 Structured Parse Results
.................................

The result objects from the *note urlparse(): 5ef, *note urlsplit():
5ee. and *note urldefrag(): bd1. functions are subclasses of the *note
tuple: 473. type.  These subclasses add the attributes listed in the
documentation for those functions, the encoding and decoding support
described in the previous section, as well as an additional method:

 -- Method: urllib.parse.SplitResult.geturl ()

     Return the re-combined version of the original URL as a string.
     This may differ from the original URL in that the scheme may be
     normalized to lower case and empty components may be dropped.
     Specifically, empty parameters, queries, and fragment identifiers
     will be removed.

     For *note urldefrag(): bd1. results, only empty fragment
     identifiers will be removed.  For *note urlsplit(): 5ee. and *note
     urlparse(): 5ef. results, all noted changes will be made to the URL
     returned by this method.

     The result of this method remains unchanged if passed back through
     the original parsing function:

          >>> from urllib.parse import urlsplit >>> url = 'HTTP://www.Python.org/doc/#' >>> r1 = urlsplit(url) >>> r1.geturl() 'http://www.Python.org/doc/' >>> r2 = urlsplit(r1.geturl()) >>> r2.geturl() 'http://www.Python.org/doc/'

The following classes provide the implementations of the structured
parse results when operating on *note str: 325. objects:

 -- Class: urllib.parse.DefragResult (url, fragment)

     Concrete class for *note urldefrag(): bd1. results containing *note
     str: 325. data.  The ‘encode()’ method returns a *note
     DefragResultBytes: 2bff. instance.

     New in version 3.2.

 -- Class: urllib.parse.ParseResult (scheme, netloc, path, params,
          query, fragment)

     Concrete class for *note urlparse(): 5ef. results containing *note
     str: 325. data.  The ‘encode()’ method returns a *note
     ParseResultBytes: 2c01. instance.

 -- Class: urllib.parse.SplitResult (scheme, netloc, path, query,
          fragment)

     Concrete class for *note urlsplit(): 5ee. results containing *note
     str: 325. data.  The ‘encode()’ method returns a *note
     SplitResultBytes: 2c03. instance.

The following classes provide the implementations of the parse results
when operating on *note bytes: 326. or *note bytearray: 327. objects:

 -- Class: urllib.parse.DefragResultBytes (url, fragment)

     Concrete class for *note urldefrag(): bd1. results containing *note
     bytes: 326. data.  The ‘decode()’ method returns a *note
     DefragResult: 2bfe. instance.

     New in version 3.2.

 -- Class: urllib.parse.ParseResultBytes (scheme, netloc, path, params,
          query, fragment)

     Concrete class for *note urlparse(): 5ef. results containing *note
     bytes: 326. data.  The ‘decode()’ method returns a *note
     ParseResult: 2c00. instance.

     New in version 3.2.

 -- Class: urllib.parse.SplitResultBytes (scheme, netloc, path, query,
          fragment)

     Concrete class for *note urlsplit(): 5ee. results containing *note
     bytes: 326. data.  The ‘decode()’ method returns a *note
     SplitResult: 2c02. instance.

     New in version 3.2.


File: python.info,  Node: URL Quoting,  Prev: Structured Parse Results,  Up: urllib parse — Parse URLs into components

5.22.8.4 URL Quoting
....................

The URL quoting functions focus on taking program data and making it
safe for use as URL components by quoting special characters and
appropriately encoding non-ASCII text.  They also support reversing
these operations to recreate the original data from the contents of a
URL component if that task isn’t already covered by the URL parsing
functions above.

 -- Function: urllib.parse.quote (string, safe='/', encoding=None,
          errors=None)

     Replace special characters in `string' using the ‘%xx’ escape.
     Letters, digits, and the characters ‘'_.-~'’ are never quoted.  By
     default, this function is intended for quoting the path section of
     URL. The optional `safe' parameter specifies additional ASCII
     characters that should not be quoted — its default value is ‘'/'’.

     `string' may be either a *note str: 325. or a *note bytes: 326.

     Changed in version 3.7: Moved from RFC 2396(1) to RFC 3986(2) for
     quoting URL strings.  “~” is now included in the set of unreserved
     characters.

     The optional `encoding' and `errors' parameters specify how to deal
     with non-ASCII characters, as accepted by the *note str.encode():
     c2a. method.  `encoding' defaults to ‘'utf-8'’.  `errors' defaults
     to ‘'strict'’, meaning unsupported characters raise a *note
     UnicodeEncodeError: 1fa.  `encoding' and `errors' must not be
     supplied if `string' is a *note bytes: 326, or a *note TypeError:
     192. is raised.

     Note that ‘quote(string, safe, encoding, errors)’ is equivalent to
     ‘quote_from_bytes(string.encode(encoding, errors), safe)’.

     Example: ‘quote('/El Niño/')’ yields ‘'/El%20Ni%C3%B1o/'’.

 -- Function: urllib.parse.quote_plus (string, safe='', encoding=None,
          errors=None)

     Like *note quote(): 402, but also replace spaces by plus signs, as
     required for quoting HTML form values when building up a query
     string to go into a URL. Plus signs in the original string are
     escaped unless they are included in `safe'.  It also does not have
     `safe' default to ‘'/'’.

     Example: ‘quote_plus('/El Niño/')’ yields ‘'%2FEl+Ni%C3%B1o%2F'’.

 -- Function: urllib.parse.quote_from_bytes (bytes, safe='/')

     Like *note quote(): 402, but accepts a *note bytes: 326. object
     rather than a *note str: 325, and does not perform string-to-bytes
     encoding.

     Example: ‘quote_from_bytes(b'a&\xef')’ yields ‘'a%26%EF'’.

 -- Function: urllib.parse.unquote (string, encoding='utf-8',
          errors='replace')

     Replace ‘%xx’ escapes by their single-character equivalent.  The
     optional `encoding' and `errors' parameters specify how to decode
     percent-encoded sequences into Unicode characters, as accepted by
     the *note bytes.decode(): c2b. method.

     `string' must be a *note str: 325.

     `encoding' defaults to ‘'utf-8'’.  `errors' defaults to
     ‘'replace'’, meaning invalid sequences are replaced by a
     placeholder character.

     Example: ‘unquote('/El%20Ni%C3%B1o/')’ yields ‘'/El Niño/'’.

 -- Function: urllib.parse.unquote_plus (string, encoding='utf-8',
          errors='replace')

     Like *note unquote(): 2b7b, but also replace plus signs by spaces,
     as required for unquoting HTML form values.

     `string' must be a *note str: 325.

     Example: ‘unquote_plus('/El+Ni%C3%B1o/')’ yields ‘'/El Niño/'’.

 -- Function: urllib.parse.unquote_to_bytes (string)

     Replace ‘%xx’ escapes by their single-octet equivalent, and return
     a *note bytes: 326. object.

     `string' may be either a *note str: 325. or a *note bytes: 326.

     If it is a *note str: 325, unescaped non-ASCII characters in
     `string' are encoded into UTF-8 bytes.

     Example: ‘unquote_to_bytes('a%26%EF')’ yields ‘b'a&\xef'’.

 -- Function: urllib.parse.urlencode (query, doseq=False, safe='',
          encoding=None, errors=None, quote_via=quote_plus)

     Convert a mapping object or a sequence of two-element tuples, which
     may contain *note str: 325. or *note bytes: 326. objects, to a
     percent-encoded ASCII text string.  If the resultant string is to
     be used as a `data' for POST operation with the *note urlopen():
     780. function, then it should be encoded to bytes, otherwise it
     would result in a *note TypeError: 192.

     The resulting string is a series of ‘key=value’ pairs separated by
     ‘'&'’ characters, where both `key' and `value' are quoted using the
     `quote_via' function.  By default, *note quote_plus(): bd2. is used
     to quote the values, which means spaces are quoted as a ‘'+'’
     character and ‘/’ characters are encoded as ‘%2F’, which follows
     the standard for GET requests
     (‘application/x-www-form-urlencoded’).  An alternate function that
     can be passed as `quote_via' is *note quote(): 402, which will
     encode spaces as ‘%20’ and not encode ‘/’ characters.  For maximum
     control of what is quoted, use ‘quote’ and specify a value for
     `safe'.

     When a sequence of two-element tuples is used as the `query'
     argument, the first element of each tuple is a key and the second
     is a value.  The value element in itself can be a sequence and in
     that case, if the optional parameter `doseq' is evaluates to
     ‘True’, individual ‘key=value’ pairs separated by ‘'&'’ are
     generated for each element of the value sequence for the key.  The
     order of parameters in the encoded string will match the order of
     parameter tuples in the sequence.

     The `safe', `encoding', and `errors' parameters are passed down to
     `quote_via' (the `encoding' and `errors' parameters are only passed
     when a query element is a *note str: 325.).

     To reverse this encoding process, *note parse_qs(): 2b1d. and *note
     parse_qsl(): 2bf7. are provided in this module to parse query
     strings into Python data structures.

     Refer to *note urllib examples: 2be9. to find out how urlencode
     method can be used for generating query string for a URL or data
     for POST.

     Changed in version 3.2: Query parameter supports bytes and string
     objects.

     New in version 3.5: `quote_via' parameter.

See also
........

RFC 3986(3) - Uniform Resource Identifiers

     This is the current standard (STD66).  Any changes to urllib.parse
     module should conform to this.  Certain deviations could be
     observed, which are mostly for backward compatibility purposes and
     for certain de-facto parsing requirements as commonly observed in
     major browsers.

RFC 2732(4) - Format for Literal IPv6 Addresses in URL’s.

     This specifies the parsing requirements of IPv6 URLs.

RFC 2396(5) - Uniform Resource Identifiers (URI): Generic Syntax

     Document describing the generic syntactic requirements for both
     Uniform Resource Names (URNs) and Uniform Resource Locators (URLs).

RFC 2368(6) - The mailto URL scheme.

     Parsing requirements for mailto URL schemes.

RFC 1808(7) - Relative Uniform Resource Locators

     This Request For Comments includes the rules for joining an
     absolute and a relative URL, including a fair number of “Abnormal
     Examples” which govern the treatment of border cases.

RFC 1738(8) - Uniform Resource Locators (URL)

     This specifies the formal syntax and semantics of absolute URLs.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2396.html

   (2) https://tools.ietf.org/html/rfc3986.html

   (3) https://tools.ietf.org/html/rfc3986.html

   (4) https://tools.ietf.org/html/rfc2732.html

   (5) https://tools.ietf.org/html/rfc2396.html

   (6) https://tools.ietf.org/html/rfc2368.html

   (7) https://tools.ietf.org/html/rfc1808.html

   (8) https://tools.ietf.org/html/rfc1738.html


File: python.info,  Node: urllib error — Exception classes raised by urllib request,  Next: urllib robotparser — Parser for robots txt,  Prev: urllib parse — Parse URLs into components,  Up: Internet Protocols and Support

5.22.9 ‘urllib.error’ — Exception classes raised by urllib.request
------------------------------------------------------------------

`Source code:' Lib/urllib/error.py(1)

__________________________________________________________________

The *note urllib.error: 11e. module defines the exception classes for
exceptions raised by *note urllib.request: 120.  The base exception
class is *note URLError: 2b6d.

The following exceptions are raised by *note urllib.error: 11e. as
appropriate:

 -- Exception: urllib.error.URLError

     The handlers raise this exception (or derived exceptions) when they
     run into a problem.  It is a subclass of *note OSError: 1d1.

      -- Attribute: reason

          The reason for this error.  It can be a message string or
          another exception instance.

     Changed in version 3.3: *note URLError: 2b6d. has been made a
     subclass of *note OSError: 1d1. instead of *note IOError: 986.

 -- Exception: urllib.error.HTTPError

     Though being an exception (a subclass of *note URLError: 2b6d.), an
     *note HTTPError: 8f0. can also function as a non-exceptional
     file-like return value (the same thing that *note urlopen(): 780.
     returns).  This is useful when handling exotic HTTP errors, such as
     requests for authentication.

      -- Attribute: code

          An HTTP status code as defined in RFC 2616(2).  This numeric
          value corresponds to a value found in the dictionary of codes
          as found in *note
          http.server.BaseHTTPRequestHandler.responses: 2c0c.

      -- Attribute: reason

          This is usually a string explaining the reason for this error.

      -- Attribute: headers

          The HTTP response headers for the HTTP request that caused the
          *note HTTPError: 8f0.

          New in version 3.4.

 -- Exception: urllib.error.ContentTooShortError (msg, content)

     This exception is raised when the *note urlretrieve(): 2beb.
     function detects that the amount of the downloaded data is less
     than the expected amount (given by the `Content-Length' header).
     The ‘content’ attribute stores the downloaded (and supposedly
     truncated) data.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/urllib/error.py

   (2) https://tools.ietf.org/html/rfc2616.html


File: python.info,  Node: urllib robotparser — Parser for robots txt,  Next: http — HTTP modules,  Prev: urllib error — Exception classes raised by urllib request,  Up: Internet Protocols and Support

5.22.10 ‘urllib.robotparser’ — Parser for robots.txt
----------------------------------------------------

`Source code:' Lib/urllib/robotparser.py(1)

__________________________________________________________________

This module provides a single class, *note RobotFileParser: 5a2, which
answers questions about whether or not a particular user agent can fetch
a URL on the Web site that published the ‘robots.txt’ file.  For more
details on the structure of ‘robots.txt’ files, see
‘http://www.robotstxt.org/orig.html’.

 -- Class: urllib.robotparser.RobotFileParser (url='')

     This class provides methods to read, parse and answer questions
     about the ‘robots.txt’ file at `url'.

      -- Method: set_url (url)

          Sets the URL referring to a ‘robots.txt’ file.

      -- Method: read ()

          Reads the ‘robots.txt’ URL and feeds it to the parser.

      -- Method: parse (lines)

          Parses the lines argument.

      -- Method: can_fetch (useragent, url)

          Returns ‘True’ if the `useragent' is allowed to fetch the
          `url' according to the rules contained in the parsed
          ‘robots.txt’ file.

      -- Method: mtime ()

          Returns the time the ‘robots.txt’ file was last fetched.  This
          is useful for long-running web spiders that need to check for
          new ‘robots.txt’ files periodically.

      -- Method: modified ()

          Sets the time the ‘robots.txt’ file was last fetched to the
          current time.

      -- Method: crawl_delay (useragent)

          Returns the value of the ‘Crawl-delay’ parameter from
          ‘robots.txt’ for the `useragent' in question.  If there is no
          such parameter or it doesn’t apply to the `useragent'
          specified or the ‘robots.txt’ entry for this parameter has
          invalid syntax, return ‘None’.

          New in version 3.6.

      -- Method: request_rate (useragent)

          Returns the contents of the ‘Request-rate’ parameter from
          ‘robots.txt’ as a *note named tuple: a98.
          ‘RequestRate(requests, seconds)’.  If there is no such
          parameter or it doesn’t apply to the `useragent' specified or
          the ‘robots.txt’ entry for this parameter has invalid syntax,
          return ‘None’.

          New in version 3.6.

      -- Method: site_maps ()

          Returns the contents of the ‘Sitemap’ parameter from
          ‘robots.txt’ in the form of a *note list(): 260.  If there is
          no such parameter or the ‘robots.txt’ entry for this parameter
          has invalid syntax, return ‘None’.

          New in version 3.8.

The following example demonstrates basic use of the *note
RobotFileParser: 5a2. class:

     >>> import urllib.robotparser >>> rp = urllib.robotparser.RobotFileParser() >>> rp.set_url("http://www.musi-cal.com/robots.txt") >>> rp.read() >>> rrate = rp.request_rate("*") >>> rrate.requests 3 >>> rrate.seconds 20 >>> rp.crawl_delay("*") 6 >>> rp.can_fetch("*", "http://www.musi-cal.com/cgi-bin/search?city=San+Francisco") False >>> rp.can_fetch("*", "http://www.musi-cal.com/") True

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/urllib/robotparser.py


File: python.info,  Node: http — HTTP modules,  Next: http client — HTTP protocol client,  Prev: urllib robotparser — Parser for robots txt,  Up: Internet Protocols and Support

5.22.11 ‘http’ — HTTP modules
-----------------------------

`Source code:' Lib/http/__init__.py(1)

__________________________________________________________________

*note http: 93. is a package that collects several modules for working
with the HyperText Transfer Protocol:

   * *note http.client: 94. is a low-level HTTP protocol client; for
     high-level URL opening use *note urllib.request: 120.

   * *note http.server: 97. contains basic HTTP server classes based on
     *note socketserver: f0.

   * *note http.cookies: 96. has utilities for implementing state
     management with cookies

   * *note http.cookiejar: 95. provides persistence of cookies

*note http: 93. is also a module that defines a number of HTTP status
codes and associated messages through the *note http.HTTPStatus: 6d6.
enum:

 -- Class: http.HTTPStatus

     New in version 3.5.

     A subclass of *note enum.IntEnum: 582. that defines a set of HTTP
     status codes, reason phrases and long descriptions written in
     English.

     Usage:

          >>> from http import HTTPStatus >>> HTTPStatus.OK <HTTPStatus.OK: 200> >>> HTTPStatus.OK == 200 True >>> HTTPStatus.OK.value 200 >>> HTTPStatus.OK.phrase 'OK' >>> HTTPStatus.OK.description 'Request fulfilled, document follows' >>> list(HTTPStatus) [<HTTPStatus.CONTINUE: 100>, <HTTPStatus.SWITCHING_PROTOCOLS: 101>, ...]

* Menu:

* HTTP status codes::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/http/__init__.py


File: python.info,  Node: HTTP status codes,  Up: http — HTTP modules

5.22.11.1 HTTP status codes
...........................

Supported, IANA-registered(1) status codes available in *note
http.HTTPStatus: 6d6. are:

Code        Enum Name                               Details
                                                    
----------------------------------------------------------------------------------------------------------------------------------------
                                                    
‘100’       ‘CONTINUE’                              HTTP/1.1 RFC 7231(2), Section 6.2.1
                                                    
                                                    
‘101’       ‘SWITCHING_PROTOCOLS’                   HTTP/1.1 RFC 7231(3), Section 6.2.2
                                                    
                                                    
‘102’       ‘PROCESSING’                            WebDAV RFC 2518(4), Section 10.1
                                                    
                                                    
‘200’       ‘OK’                                    HTTP/1.1 RFC 7231(5), Section 6.3.1
                                                    
                                                    
‘201’       ‘CREATED’                               HTTP/1.1 RFC 7231(6), Section 6.3.2
                                                    
                                                    
‘202’       ‘ACCEPTED’                              HTTP/1.1 RFC 7231(7), Section 6.3.3
                                                    
                                                    
‘203’       ‘NON_AUTHORITATIVE_INFORMATION’         HTTP/1.1 RFC 7231(8), Section 6.3.4
                                                    
                                                    
‘204’       ‘NO_CONTENT’                            HTTP/1.1 RFC 7231(9), Section 6.3.5
                                                    
                                                    
‘205’       ‘RESET_CONTENT’                         HTTP/1.1 RFC 7231(10), Section 6.3.6
                                                    
                                                    
‘206’       ‘PARTIAL_CONTENT’                       HTTP/1.1 RFC 7233(11), Section 4.1
                                                    
                                                    
‘207’       ‘MULTI_STATUS’                          WebDAV RFC 4918(12), Section 11.1
                                                    
                                                    
‘208’       ‘ALREADY_REPORTED’                      WebDAV Binding Extensions RFC 5842(13), Section 7.1 (Experimental)
                                                    
                                                    
‘226’       ‘IM_USED’                               Delta Encoding in HTTP RFC 3229(14), Section 10.4.1
                                                    
                                                    
‘300’       ‘MULTIPLE_CHOICES’                      HTTP/1.1 RFC 7231(15), Section 6.4.1
                                                    
                                                    
‘301’       ‘MOVED_PERMANENTLY’                     HTTP/1.1 RFC 7231(16), Section 6.4.2
                                                    
                                                    
‘302’       ‘FOUND’                                 HTTP/1.1 RFC 7231(17), Section 6.4.3
                                                    
                                                    
‘303’       ‘SEE_OTHER’                             HTTP/1.1 RFC 7231(18), Section 6.4.4
                                                    
                                                    
‘304’       ‘NOT_MODIFIED’                          HTTP/1.1 RFC 7232(19), Section 4.1
                                                    
                                                    
‘305’       ‘USE_PROXY’                             HTTP/1.1 RFC 7231(20), Section 6.4.5
                                                    
                                                    
‘307’       ‘TEMPORARY_REDIRECT’                    HTTP/1.1 RFC 7231(21), Section 6.4.7
                                                    
                                                    
‘308’       ‘PERMANENT_REDIRECT’                    Permanent Redirect RFC 7238(22), Section 3 (Experimental)
                                                    
                                                    
‘400’       ‘BAD_REQUEST’                           HTTP/1.1 RFC 7231(23), Section 6.5.1
                                                    
                                                    
‘401’       ‘UNAUTHORIZED’                          HTTP/1.1 Authentication RFC 7235(24), Section 3.1
                                                    
                                                    
‘402’       ‘PAYMENT_REQUIRED’                      HTTP/1.1 RFC 7231(25), Section 6.5.2
                                                    
                                                    
‘403’       ‘FORBIDDEN’                             HTTP/1.1 RFC 7231(26), Section 6.5.3
                                                    
                                                    
‘404’       ‘NOT_FOUND’                             HTTP/1.1 RFC 7231(27), Section 6.5.4
                                                    
                                                    
‘405’       ‘METHOD_NOT_ALLOWED’                    HTTP/1.1 RFC 7231(28), Section 6.5.5
                                                    
                                                    
‘406’       ‘NOT_ACCEPTABLE’                        HTTP/1.1 RFC 7231(29), Section 6.5.6
                                                    
                                                    
‘407’       ‘PROXY_AUTHENTICATION_REQUIRED’         HTTP/1.1 Authentication RFC 7235(30), Section 3.2
                                                    
                                                    
‘408’       ‘REQUEST_TIMEOUT’                       HTTP/1.1 RFC 7231(31), Section 6.5.7
                                                    
                                                    
‘409’       ‘CONFLICT’                              HTTP/1.1 RFC 7231(32), Section 6.5.8
                                                    
                                                    
‘410’       ‘GONE’                                  HTTP/1.1 RFC 7231(33), Section 6.5.9
                                                    
                                                    
‘411’       ‘LENGTH_REQUIRED’                       HTTP/1.1 RFC 7231(34), Section 6.5.10
                                                    
                                                    
‘412’       ‘PRECONDITION_FAILED’                   HTTP/1.1 RFC 7232(35), Section 4.2
                                                    
                                                    
‘413’       ‘REQUEST_ENTITY_TOO_LARGE’              HTTP/1.1 RFC 7231(36), Section 6.5.11
                                                    
                                                    
‘414’       ‘REQUEST_URI_TOO_LONG’                  HTTP/1.1 RFC 7231(37), Section 6.5.12
                                                    
                                                    
‘415’       ‘UNSUPPORTED_MEDIA_TYPE’                HTTP/1.1 RFC 7231(38), Section 6.5.13
                                                    
                                                    
‘416’       ‘REQUESTED_RANGE_NOT_SATISFIABLE’       HTTP/1.1 Range Requests RFC 7233(39), Section 4.4
                                                    
                                                    
‘417’       ‘EXPECTATION_FAILED’                    HTTP/1.1 RFC 7231(40), Section 6.5.14
                                                    
                                                    
‘421’       ‘MISDIRECTED_REQUEST’                   HTTP/2 RFC 7540(41), Section 9.1.2
                                                    
                                                    
‘422’       ‘UNPROCESSABLE_ENTITY’                  WebDAV RFC 4918(42), Section 11.2
                                                    
                                                    
‘423’       ‘LOCKED’                                WebDAV RFC 4918(43), Section 11.3
                                                    
                                                    
‘424’       ‘FAILED_DEPENDENCY’                     WebDAV RFC 4918(44), Section 11.4
                                                    
                                                    
‘426’       ‘UPGRADE_REQUIRED’                      HTTP/1.1 RFC 7231(45), Section 6.5.15
                                                    
                                                    
‘428’       ‘PRECONDITION_REQUIRED’                 Additional HTTP Status Codes RFC 6585(46)
                                                    
                                                    
‘429’       ‘TOO_MANY_REQUESTS’                     Additional HTTP Status Codes RFC 6585(47)
                                                    
                                                    
‘431’       ‘REQUEST_HEADER_FIELDS_TOO_LARGE’       Additional HTTP Status Codes RFC 6585(48)
                                                    
                                                    
‘451’       ‘UNAVAILABLE_FOR_LEGAL_REASONS’         An HTTP Status Code to Report Legal Obstacles RFC 7725(49)
                                                    
                                                    
‘500’       ‘INTERNAL_SERVER_ERROR’                 HTTP/1.1 RFC 7231(50), Section 6.6.1
                                                    
                                                    
‘501’       ‘NOT_IMPLEMENTED’                       HTTP/1.1 RFC 7231(51), Section 6.6.2
                                                    
                                                    
‘502’       ‘BAD_GATEWAY’                           HTTP/1.1 RFC 7231(52), Section 6.6.3
                                                    
                                                    
‘503’       ‘SERVICE_UNAVAILABLE’                   HTTP/1.1 RFC 7231(53), Section 6.6.4
                                                    
                                                    
‘504’       ‘GATEWAY_TIMEOUT’                       HTTP/1.1 RFC 7231(54), Section 6.6.5
                                                    
                                                    
‘505’       ‘HTTP_VERSION_NOT_SUPPORTED’            HTTP/1.1 RFC 7231(55), Section 6.6.6
                                                    
                                                    
‘506’       ‘VARIANT_ALSO_NEGOTIATES’               Transparent Content Negotiation in HTTP RFC 2295(56), Section 8.1 (Experimental)
                                                    
                                                    
‘507’       ‘INSUFFICIENT_STORAGE’                  WebDAV RFC 4918(57), Section 11.5
                                                    
                                                    
‘508’       ‘LOOP_DETECTED’                         WebDAV Binding Extensions RFC 5842(58), Section 7.2 (Experimental)
                                                    
                                                    
‘510’       ‘NOT_EXTENDED’                          An HTTP Extension Framework RFC 2774(59), Section 7 (Experimental)
                                                    
                                                    
‘511’       ‘NETWORK_AUTHENTICATION_REQUIRED’       Additional HTTP Status Codes RFC 6585(60), Section 6
                                                    

In order to preserve backwards compatibility, enum values are also
present in the *note http.client: 94. module in the form of constants.
The enum name is equal to the constant name (i.e.  ‘http.HTTPStatus.OK’
is also available as ‘http.client.OK’).

Changed in version 3.7: Added ‘421 MISDIRECTED_REQUEST’ status code.

New in version 3.8: Added ‘451 UNAVAILABLE_FOR_LEGAL_REASONS’ status
code.

   ---------- Footnotes ----------

   (1) 
https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

   (2) https://tools.ietf.org/html/rfc7231.html

   (3) https://tools.ietf.org/html/rfc7231.html

   (4) https://tools.ietf.org/html/rfc2518.html

   (5) https://tools.ietf.org/html/rfc7231.html

   (6) https://tools.ietf.org/html/rfc7231.html

   (7) https://tools.ietf.org/html/rfc7231.html

   (8) https://tools.ietf.org/html/rfc7231.html

   (9) https://tools.ietf.org/html/rfc7231.html

   (10) https://tools.ietf.org/html/rfc7231.html

   (11) https://tools.ietf.org/html/rfc7233.html

   (12) https://tools.ietf.org/html/rfc4918.html

   (13) https://tools.ietf.org/html/rfc5842.html

   (14) https://tools.ietf.org/html/rfc3229.html

   (15) https://tools.ietf.org/html/rfc7231.html

   (16) https://tools.ietf.org/html/rfc7231.html

   (17) https://tools.ietf.org/html/rfc7231.html

   (18) https://tools.ietf.org/html/rfc7231.html

   (19) https://tools.ietf.org/html/rfc7232.html

   (20) https://tools.ietf.org/html/rfc7231.html

   (21) https://tools.ietf.org/html/rfc7231.html

   (22) https://tools.ietf.org/html/rfc7238.html

   (23) https://tools.ietf.org/html/rfc7231.html

   (24) https://tools.ietf.org/html/rfc7235.html

   (25) https://tools.ietf.org/html/rfc7231.html

   (26) https://tools.ietf.org/html/rfc7231.html

   (27) https://tools.ietf.org/html/rfc7231.html

   (28) https://tools.ietf.org/html/rfc7231.html

   (29) https://tools.ietf.org/html/rfc7231.html

   (30) https://tools.ietf.org/html/rfc7235.html

   (31) https://tools.ietf.org/html/rfc7231.html

   (32) https://tools.ietf.org/html/rfc7231.html

   (33) https://tools.ietf.org/html/rfc7231.html

   (34) https://tools.ietf.org/html/rfc7231.html

   (35) https://tools.ietf.org/html/rfc7232.html

   (36) https://tools.ietf.org/html/rfc7231.html

   (37) https://tools.ietf.org/html/rfc7231.html

   (38) https://tools.ietf.org/html/rfc7231.html

   (39) https://tools.ietf.org/html/rfc7233.html

   (40) https://tools.ietf.org/html/rfc7231.html

   (41) https://tools.ietf.org/html/rfc7540.html

   (42) https://tools.ietf.org/html/rfc4918.html

   (43) https://tools.ietf.org/html/rfc4918.html

   (44) https://tools.ietf.org/html/rfc4918.html

   (45) https://tools.ietf.org/html/rfc7231.html

   (46) https://tools.ietf.org/html/rfc6585.html

   (47) https://tools.ietf.org/html/rfc6585.html

   (48) https://tools.ietf.org/html/rfc6585.html

   (49) https://tools.ietf.org/html/rfc7725.html

   (50) https://tools.ietf.org/html/rfc7231.html

   (51) https://tools.ietf.org/html/rfc7231.html

   (52) https://tools.ietf.org/html/rfc7231.html

   (53) https://tools.ietf.org/html/rfc7231.html

   (54) https://tools.ietf.org/html/rfc7231.html

   (55) https://tools.ietf.org/html/rfc7231.html

   (56) https://tools.ietf.org/html/rfc2295.html

   (57) https://tools.ietf.org/html/rfc4918.html

   (58) https://tools.ietf.org/html/rfc5842.html

   (59) https://tools.ietf.org/html/rfc2774.html

   (60) https://tools.ietf.org/html/rfc6585.html


File: python.info,  Node: http client — HTTP protocol client,  Next: ftplib — FTP protocol client,  Prev: http — HTTP modules,  Up: Internet Protocols and Support

5.22.12 ‘http.client’ — HTTP protocol client
--------------------------------------------

`Source code:' Lib/http/client.py(1)

__________________________________________________________________

This module defines classes which implement the client side of the HTTP
and HTTPS protocols.  It is normally not used directly — the module
*note urllib.request: 120. uses it to handle URLs that use HTTP and
HTTPS.

See also
........

The Requests package(2) is recommended for a higher-level HTTP client
interface.

     Note: HTTPS support is only available if Python was compiled with
     SSL support (through the *note ssl: f3. module).

The module provides the following classes:

 -- Class: http.client.HTTPConnection (host, port=None[, timeout],
          source_address=None, blocksize=8192)

     An *note HTTPConnection: 387. instance represents one transaction
     with an HTTP server.  It should be instantiated passing it a host
     and optional port number.  If no port number is passed, the port is
     extracted from the host string if it has the form ‘host:port’, else
     the default HTTP port (80) is used.  If the optional `timeout'
     parameter is given, blocking operations (like connection attempts)
     will timeout after that many seconds (if it is not given, the
     global default timeout setting is used).  The optional
     `source_address' parameter may be a tuple of a (host, port) to use
     as the source address the HTTP connection is made from.  The
     optional `blocksize' parameter sets the buffer size in bytes for
     sending a file-like message body.

     For example, the following calls all create instances that connect
     to the server at the same host and port:

          >>> h1 = http.client.HTTPConnection('www.python.org') >>> h2 = http.client.HTTPConnection('www.python.org:80') >>> h3 = http.client.HTTPConnection('www.python.org', 80) >>> h4 = http.client.HTTPConnection('www.python.org', 80, timeout=10)

     Changed in version 3.2: `source_address' was added.

     Changed in version 3.4: The `strict' parameter was removed.  HTTP
     0.9-style “Simple Responses” are not longer supported.

     Changed in version 3.7: `blocksize' parameter was added.

 -- Class: http.client.HTTPSConnection (host, port=None, key_file=None,
          cert_file=None[, timeout], source_address=None, *,
          context=None, check_hostname=None, blocksize=8192)

     A subclass of *note HTTPConnection: 387. that uses SSL for
     communication with secure servers.  Default port is ‘443’.  If
     `context' is specified, it must be a *note ssl.SSLContext: 3d9.
     instance describing the various SSL options.

     Please read *note Security considerations: 24f0. for more
     information on best practices.

     Changed in version 3.2: `source_address', `context' and
     `check_hostname' were added.

     Changed in version 3.2: This class now supports HTTPS virtual hosts
     if possible (that is, if *note ssl.HAS_SNI: 261e. is true).

     Changed in version 3.4: The `strict' parameter was removed.  HTTP
     0.9-style “Simple Responses” are no longer supported.

     Changed in version 3.4.3: This class now performs all the necessary
     certificate and hostname checks by default.  To revert to the
     previous, unverified, behavior ‘ssl._create_unverified_context()’
     can be passed to the `context' parameter.

     Changed in version 3.8: This class now enables TLS 1.3 *note
     ssl.SSLContext.post_handshake_auth: 222. for the default `context'
     or when `cert_file' is passed with a custom `context'.

     Deprecated since version 3.6: `key_file' and `cert_file' are
     deprecated in favor of `context'.  Please use *note
     ssl.SSLContext.load_cert_chain(): a86. instead, or let *note
     ssl.create_default_context(): 8b5. select the system’s trusted CA
     certificates for you.

     The `check_hostname' parameter is also deprecated; the *note
     ssl.SSLContext.check_hostname: 2609. attribute of `context' should
     be used instead.

 -- Class: http.client.HTTPResponse (sock, debuglevel=0, method=None,
          url=None)

     Class whose instances are returned upon successful connection.  Not
     instantiated directly by user.

     Changed in version 3.4: The `strict' parameter was removed.  HTTP
     0.9 style “Simple Responses” are no longer supported.

This module provides the following function:

 -- Function: http.client.parse_headers (fp)

     Parse the headers from a file pointer `fp' representing a HTTP
     request/response.  The file has to be a ‘BufferedIOBase’ reader
     (i.e.  not text) and must provide a valid RFC 2822(3) style header.

     This function returns an instance of ‘http.client.HTTPMessage’ that
     holds the header fields, but no payload (the same as *note
     HTTPResponse.msg: 2c1e. and *note
     http.server.BaseHTTPRequestHandler.headers: 2c1f.).  After
     returning, the file pointer `fp' is ready to read the HTTP body.

          Note: *note parse_headers(): f78. does not parse the
          start-line of a HTTP message; it only parses the ‘Name: value’
          lines.  The file has to be ready to read these field lines, so
          the first line should already be consumed before calling the
          function.

The following exceptions are raised as appropriate:

 -- Exception: http.client.HTTPException

     The base class of the other exceptions in this module.  It is a
     subclass of *note Exception: 1a8.

 -- Exception: http.client.NotConnected

     A subclass of *note HTTPException: 2c20.

 -- Exception: http.client.InvalidURL

     A subclass of *note HTTPException: 2c20, raised if a port is given
     and is either non-numeric or empty.

 -- Exception: http.client.UnknownProtocol

     A subclass of *note HTTPException: 2c20.

 -- Exception: http.client.UnknownTransferEncoding

     A subclass of *note HTTPException: 2c20.

 -- Exception: http.client.UnimplementedFileMode

     A subclass of *note HTTPException: 2c20.

 -- Exception: http.client.IncompleteRead

     A subclass of *note HTTPException: 2c20.

 -- Exception: http.client.ImproperConnectionState

     A subclass of *note HTTPException: 2c20.

 -- Exception: http.client.CannotSendRequest

     A subclass of *note ImproperConnectionState: 2c27.

 -- Exception: http.client.CannotSendHeader

     A subclass of *note ImproperConnectionState: 2c27.

 -- Exception: http.client.ResponseNotReady

     A subclass of *note ImproperConnectionState: 2c27.

 -- Exception: http.client.BadStatusLine

     A subclass of *note HTTPException: 2c20.  Raised if a server
     responds with a HTTP status code that we don’t understand.

 -- Exception: http.client.LineTooLong

     A subclass of *note HTTPException: 2c20.  Raised if an excessively
     long line is received in the HTTP protocol from the server.

 -- Exception: http.client.RemoteDisconnected

     A subclass of *note ConnectionResetError: 994. and *note
     BadStatusLine: 2c2b.  Raised by *note HTTPConnection.getresponse():
     6d8. when the attempt to read the response results in no data read
     from the connection, indicating that the remote end has closed the
     connection.

     New in version 3.5: Previously, *note BadStatusLine: 2c2b.‘('')’
     was raised.

The constants defined in this module are:

 -- Data: http.client.HTTP_PORT

     The default port for the HTTP protocol (always ‘80’).

 -- Data: http.client.HTTPS_PORT

     The default port for the HTTPS protocol (always ‘443’).

 -- Data: http.client.responses

     This dictionary maps the HTTP 1.1 status codes to the W3C names.

     Example: ‘http.client.responses[http.client.NOT_FOUND]’ is ‘'Not
     Found'’.

See *note HTTP status codes: 2c1a. for a list of HTTP status codes that
are available in this module as constants.

* Menu:

* HTTPConnection Objects::
* HTTPResponse Objects::
* Examples: Examples<22>.
* HTTPMessage Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/http/client.py

   (2) https://requests.readthedocs.io/en/master/

   (3) https://tools.ietf.org/html/rfc2822.html


File: python.info,  Node: HTTPConnection Objects,  Next: HTTPResponse Objects,  Up: http client — HTTP protocol client

5.22.12.1 HTTPConnection Objects
................................

*note HTTPConnection: 387. instances have the following methods:

 -- Method: HTTPConnection.request (method, url, body=None, headers={},
          *, encode_chunked=False)

     This will send a request to the server using the HTTP request
     method `method' and the selector `url'.

     If `body' is specified, the specified data is sent after the
     headers are finished.  It may be a *note str: 325, a *note
     bytes-like object: 5dd, an open *note file object: b35, or an
     iterable of *note bytes: 326.  If `body' is a string, it is encoded
     as ISO-8859-1, the default for HTTP. If it is a bytes-like object,
     the bytes are sent as is.  If it is a *note file object: b35, the
     contents of the file is sent; this file object should support at
     least the ‘read()’ method.  If the file object is an instance of
     *note io.TextIOBase: c2c, the data returned by the ‘read()’ method
     will be encoded as ISO-8859-1, otherwise the data returned by
     ‘read()’ is sent as is.  If `body' is an iterable, the elements of
     the iterable are sent as is until the iterable is exhausted.

     The `headers' argument should be a mapping of extra HTTP headers to
     send with the request.

     If `headers' contains neither Content-Length nor Transfer-Encoding,
     but there is a request body, one of those header fields will be
     added automatically.  If `body' is ‘None’, the Content-Length
     header is set to ‘0’ for methods that expect a body (‘PUT’, ‘POST’,
     and ‘PATCH’).  If `body' is a string or a bytes-like object that is
     not also a *note file: b35, the Content-Length header is set to its
     length.  Any other type of `body' (files and iterables in general)
     will be chunk-encoded, and the Transfer-Encoding header will
     automatically be set instead of Content-Length.

     The `encode_chunked' argument is only relevant if Transfer-Encoding
     is specified in `headers'.  If `encode_chunked' is ‘False’, the
     HTTPConnection object assumes that all encoding is handled by the
     calling code.  If it is ‘True’, the body will be chunk-encoded.

          Note: Chunked transfer encoding has been added to the HTTP
          protocol version 1.1.  Unless the HTTP server is known to
          handle HTTP 1.1, the caller must either specify the
          Content-Length, or must pass a *note str: 325. or bytes-like
          object that is not also a file as the body representation.

     New in version 3.2: `body' can now be an iterable.

     Changed in version 3.6: If neither Content-Length nor
     Transfer-Encoding are set in `headers', file and iterable `body'
     objects are now chunk-encoded.  The `encode_chunked' argument was
     added.  No attempt is made to determine the Content-Length for file
     objects.

 -- Method: HTTPConnection.getresponse ()

     Should be called after a request is sent to get the response from
     the server.  Returns an *note HTTPResponse: a06. instance.

          Note: Note that you must have read the whole response before
          you can send a new request to the server.

     Changed in version 3.5: If a *note ConnectionError: 6da. or
     subclass is raised, the *note HTTPConnection: 387. object will be
     ready to reconnect when a new request is sent.

 -- Method: HTTPConnection.set_debuglevel (level)

     Set the debugging level.  The default debug level is ‘0’, meaning
     no debugging output is printed.  Any value greater than ‘0’ will
     cause all currently defined debug output to be printed to stdout.
     The ‘debuglevel’ is passed to any new *note HTTPResponse: a06.
     objects that are created.

     New in version 3.1.

 -- Method: HTTPConnection.set_tunnel (host, port=None, headers=None)

     Set the host and the port for HTTP Connect Tunnelling.  This allows
     running the connection through a proxy server.

     The host and port arguments specify the endpoint of the tunneled
     connection (i.e.  the address included in the CONNECT request,
     `not' the address of the proxy server).

     The headers argument should be a mapping of extra HTTP headers to
     send with the CONNECT request.

     For example, to tunnel through a HTTPS proxy server running locally
     on port 8080, we would pass the address of the proxy to the *note
     HTTPSConnection: 388. constructor, and the address of the host that
     we eventually want to reach to the *note set_tunnel(): ba0. method:

          >>> import http.client >>> conn = http.client.HTTPSConnection("localhost", 8080) >>> conn.set_tunnel("www.python.org") >>> conn.request("HEAD","/index.html")

     New in version 3.2.

 -- Method: HTTPConnection.connect ()

     Connect to the server specified when the object was created.  By
     default, this is called automatically when making a request if the
     client does not already have a connection.

 -- Method: HTTPConnection.close ()

     Close the connection to the server.

 -- Attribute: HTTPConnection.blocksize

     Buffer size in bytes for sending a file-like message body.

     New in version 3.7.

As an alternative to using the ‘request()’ method described above, you
can also send your request step by step, by using the four functions
below.

 -- Method: HTTPConnection.putrequest (method, url, skip_host=False,
          skip_accept_encoding=False)

     This should be the first call after the connection to the server
     has been made.  It sends a line to the server consisting of the
     `method' string, the `url' string, and the HTTP version
     (‘HTTP/1.1’).  To disable automatic sending of ‘Host:’ or
     ‘Accept-Encoding:’ headers (for example to accept additional
     content encodings), specify `skip_host' or `skip_accept_encoding'
     with non-False values.

 -- Method: HTTPConnection.putheader (header, argument[, ...])

     Send an RFC 822(1)-style header to the server.  It sends a line to
     the server consisting of the header, a colon and a space, and the
     first argument.  If more arguments are given, continuation lines
     are sent, each consisting of a tab and an argument.

 -- Method: HTTPConnection.endheaders (message_body=None, *,
          encode_chunked=False)

     Send a blank line to the server, signalling the end of the headers.
     The optional `message_body' argument can be used to pass a message
     body associated with the request.

     If `encode_chunked' is ‘True’, the result of each iteration of
     `message_body' will be chunk-encoded as specified in RFC 7230(2),
     Section 3.3.1.  How the data is encoded is dependent on the type of
     `message_body'.  If `message_body' implements the *note buffer
     interface: 1579. the encoding will result in a single chunk.  If
     `message_body' is a *note collections.abc.Iterable: 188b, each
     iteration of `message_body' will result in a chunk.  If
     `message_body' is a *note file object: b35, each call to ‘.read()’
     will result in a chunk.  The method automatically signals the end
     of the chunk-encoded data immediately after `message_body'.

          Note: Due to the chunked encoding specification, empty chunks
          yielded by an iterator body will be ignored by the
          chunk-encoder.  This is to avoid premature termination of the
          read of the request by the target server due to malformed
          encoding.

     New in version 3.6: Chunked encoding support.  The `encode_chunked'
     parameter was added.

 -- Method: HTTPConnection.send (data)

     Send data to the server.  This should be used directly only after
     the *note endheaders(): 545. method has been called and before
     *note getresponse(): 6d8. is called.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc822.html

   (2) https://tools.ietf.org/html/rfc7230.html


File: python.info,  Node: HTTPResponse Objects,  Next: Examples<22>,  Prev: HTTPConnection Objects,  Up: http client — HTTP protocol client

5.22.12.2 HTTPResponse Objects
..............................

An *note HTTPResponse: a06. instance wraps the HTTP response from the
server.  It provides access to the request headers and the entity body.
The response is an iterable object and can be used in a with statement.

Changed in version 3.5: The *note io.BufferedIOBase: 57d. interface is
now implemented and all of its reader operations are supported.

 -- Method: HTTPResponse.read ([amt])

     Reads and returns the response body, or up to the next `amt' bytes.

 -- Method: HTTPResponse.readinto (b)

     Reads up to the next len(b) bytes of the response body into the
     buffer `b'.  Returns the number of bytes read.

     New in version 3.3.

 -- Method: HTTPResponse.getheader (name, default=None)

     Return the value of the header `name', or `default' if there is no
     header matching `name'.  If there is more than one header with the
     name `name', return all of the values joined by ‘, ‘.  If ‘default’
     is any iterable other than a single string, its elements are
     similarly returned joined by commas.

 -- Method: HTTPResponse.getheaders ()

     Return a list of (header, value) tuples.

 -- Method: HTTPResponse.fileno ()

     Return the ‘fileno’ of the underlying socket.

 -- Attribute: HTTPResponse.msg

     A ‘http.client.HTTPMessage’ instance containing the response
     headers.  ‘http.client.HTTPMessage’ is a subclass of *note
     email.message.Message: 536.

 -- Attribute: HTTPResponse.version

     HTTP protocol version used by server.  10 for HTTP/1.0, 11 for
     HTTP/1.1.

 -- Attribute: HTTPResponse.status

     Status code returned by server.

 -- Attribute: HTTPResponse.reason

     Reason phrase returned by server.

 -- Attribute: HTTPResponse.debuglevel

     A debugging hook.  If *note debuglevel: 2c41. is greater than zero,
     messages will be printed to stdout as the response is read and
     parsed.

 -- Attribute: HTTPResponse.closed

     Is ‘True’ if the stream is closed.


File: python.info,  Node: Examples<22>,  Next: HTTPMessage Objects,  Prev: HTTPResponse Objects,  Up: http client — HTTP protocol client

5.22.12.3 Examples
..................

Here is an example session that uses the ‘GET’ method:

     >>> import http.client >>> conn = http.client.HTTPSConnection("www.python.org") >>> conn.request("GET", "/") >>> r1 = conn.getresponse() >>> print(r1.status, r1.reason) 200 OK >>> data1 = r1.read()  # This will return entire content. >>> # The following example demonstrates reading data in chunks. >>> conn.request("GET", "/") >>> r1 = conn.getresponse() >>> while chunk := r1.read(200): ...     print(repr(chunk)) b'<!doctype html>\n<!--[if"... ... >>> # Example of an invalid request >>> conn = http.client.HTTPSConnection("docs.python.org") >>> conn.request("GET", "/parrot.spam") >>> r2 = conn.getresponse() >>> print(r2.status, r2.reason) 404 Not Found >>> data2 = r2.read() >>> conn.close()

Here is an example session that uses the ‘HEAD’ method.  Note that the
‘HEAD’ method never returns any data.

     >>> import http.client >>> conn = http.client.HTTPSConnection("www.python.org") >>> conn.request("HEAD", "/") >>> res = conn.getresponse() >>> print(res.status, res.reason) 200 OK >>> data = res.read() >>> print(len(data)) 0 >>> data == b'' True

Here is an example session that shows how to ‘POST’ requests:

     >>> import http.client, urllib.parse >>> params = urllib.parse.urlencode({'@number': 12524, '@type': 'issue', '@action': 'show'}) >>> headers = {"Content-type": "application/x-www-form-urlencoded", ...            "Accept": "text/plain"} >>> conn = http.client.HTTPConnection("bugs.python.org") >>> conn.request("POST", "", params, headers) >>> response = conn.getresponse() >>> print(response.status, response.reason) 302 Found >>> data = response.read() >>> data b'Redirecting to <a href="http://bugs.python.org/issue12524">http://bugs.python.org/issue12524</a>' >>> conn.close()

Client side ‘HTTP PUT’ requests are very similar to ‘POST’ requests.
The difference lies only the server side where HTTP server will allow
resources to be created via ‘PUT’ request.  It should be noted that
custom HTTP methods +are also handled in *note urllib.request.Request:
8ea. by sending the appropriate +method attribute.Here is an example
session that shows how to do ‘PUT’ request using http.client:

     >>> # This creates an HTTP message >>> # with the content of BODY as the enclosed representation >>> # for the resource http://localhost:8080/file ... >>> import http.client >>> BODY = "***filecontents***" >>> conn = http.client.HTTPConnection("localhost", 8080) >>> conn.request("PUT", "/file", BODY) >>> response = conn.getresponse() >>> print(response.status, response.reason) 200, OK


File: python.info,  Node: HTTPMessage Objects,  Prev: Examples<22>,  Up: http client — HTTP protocol client

5.22.12.4 HTTPMessage Objects
.............................

An ‘http.client.HTTPMessage’ instance holds the headers from an HTTP
response.  It is implemented using the *note email.message.Message: 536.
class.


File: python.info,  Node: ftplib — FTP protocol client,  Next: poplib — POP3 protocol client,  Prev: http client — HTTP protocol client,  Up: Internet Protocols and Support

5.22.13 ‘ftplib’ — FTP protocol client
--------------------------------------

`Source code:' Lib/ftplib.py(1)

__________________________________________________________________

This module defines the class *note FTP: 9f7. and a few related items.
The *note FTP: 9f7. class implements the client side of the FTP
protocol.  You can use this to write Python programs that perform a
variety of automated FTP jobs, such as mirroring other FTP servers.  It
is also used by the module *note urllib.request: 120. to handle URLs
that use FTP. For more information on FTP (File Transfer Protocol), see
Internet RFC 959(2).

Here’s a sample session using the *note ftplib: 84. module:

     >>> from ftplib import FTP >>> ftp = FTP('ftp.debian.org')     # connect to host, default port >>> ftp.login()                     # user anonymous, passwd anonymous@ '230 Login successful.' >>> ftp.cwd('debian')               # change into "debian" directory >>> ftp.retrlines('LIST')           # list directory contents -rw-rw-r--    1 1176     1176         1063 Jun 15 10:18 README ... drwxr-sr-x    5 1176     1176         4096 Dec 19  2000 pool drwxr-sr-x    4 1176     1176         4096 Nov 17  2008 project drwxr-xr-x    3 1176     1176         4096 Oct 10  2012 tools '226 Directory send OK.' >>> with open('README', 'wb') as fp: >>>     ftp.retrbinary('RETR README', fp.write) '226 Transfer complete.' >>> ftp.quit()

The module defines the following items:

 -- Class: ftplib.FTP (host='', user='', passwd='', acct='',
          timeout=None, source_address=None)

     Return a new instance of the *note FTP: 9f7. class.  When `host' is
     given, the method call ‘connect(host)’ is made.  When `user' is
     given, additionally the method call ‘login(user, passwd, acct)’ is
     made (where `passwd' and `acct' default to the empty string when
     not given).  The optional `timeout' parameter specifies a timeout
     in seconds for blocking operations like the connection attempt (if
     is not specified, the global default timeout setting will be used).
     `source_address' is a 2-tuple ‘(host, port)’ for the socket to bind
     to as its source address before connecting.

     The *note FTP: 9f7. class supports the *note with: 6dd. statement,
     e.g.:

          >>> from ftplib import FTP >>> with FTP("ftp1.at.proftpd.org") as ftp: ...     ftp.login() ...     ftp.dir() ... # doctest: +SKIP '230 Anonymous login ok, restrictions apply.' dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 . dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .. dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora >>>

     Changed in version 3.2: Support for the *note with: 6dd. statement
     was added.

     Changed in version 3.3: `source_address' parameter was added.

 -- Class: ftplib.FTP_TLS (host='', user='', passwd='', acct='',
          keyfile=None, certfile=None, context=None, timeout=None,
          source_address=None)

     A *note FTP: 9f7. subclass which adds TLS support to FTP as
     described in RFC 4217(3).  Connect as usual to port 21 implicitly
     securing the FTP control connection before authenticating.
     Securing the data connection requires the user to explicitly ask
     for it by calling the *note prot_p(): 2c48. method.  `context' is a
     *note ssl.SSLContext: 3d9. object which allows bundling SSL
     configuration options, certificates and private keys into a single
     (potentially long-lived) structure.  Please read *note Security
     considerations: 24f0. for best practices.

     `keyfile' and `certfile' are a legacy alternative to `context' –
     they can point to PEM-formatted private key and certificate chain
     files (respectively) for the SSL connection.

     New in version 3.2.

     Changed in version 3.3: `source_address' parameter was added.

     Changed in version 3.4: The class now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

     Deprecated since version 3.6: `keyfile' and `certfile' are
     deprecated in favor of `context'.  Please use *note
     ssl.SSLContext.load_cert_chain(): a86. instead, or let *note
     ssl.create_default_context(): 8b5. select the system’s trusted CA
     certificates for you.

     Here’s a sample session using the *note FTP_TLS: 9f8. class:

          >>> ftps = FTP_TLS('ftp.pureftpd.org') >>> ftps.login() '230 Anonymous user logged in' >>> ftps.prot_p() '200 Data protection level set to "private"' >>> ftps.nlst() ['6jack', 'OpenBSD', 'antilink', 'blogbench', 'bsdcam', 'clockspeed', 'djbdns-jedi', 'docs', 'eaccelerator-jedi', 'favicon.ico', 'francotone', 'fugu', 'ignore', 'libpuzzle', 'metalog', 'minidentd', 'misc', 'mysql-udf-global-user-variables', 'php-jenkins-hash', 'php-skein-hash', 'php-webdav', 'phpaudit', 'phpbench', 'pincaster', 'ping', 'posto', 'pub', 'public', 'public_keys', 'pure-ftpd', 'qscan', 'qtc', 'sharedance', 'skycache', 'sound', 'tmp', 'ucarp']

 -- Exception: ftplib.error_reply

     Exception raised when an unexpected reply is received from the
     server.

 -- Exception: ftplib.error_temp

     Exception raised when an error code signifying a temporary error
     (response codes in the range 400–499) is received.

 -- Exception: ftplib.error_perm

     Exception raised when an error code signifying a permanent error
     (response codes in the range 500–599) is received.

 -- Exception: ftplib.error_proto

     Exception raised when a reply is received from the server that does
     not fit the response specifications of the File Transfer Protocol,
     i.e.  begin with a digit in the range 1–5.

 -- Data: ftplib.all_errors

     The set of all exceptions (as a tuple) that methods of *note FTP:
     9f7. instances may raise as a result of problems with the FTP
     connection (as opposed to programming errors made by the caller).
     This set includes the four exceptions listed above as well as *note
     OSError: 1d1. and *note EOFError: c5f.

See also
........

Module *note netrc: be.

     Parser for the ‘.netrc’ file format.  The file ‘.netrc’ is
     typically used by FTP clients to load user authentication
     information before prompting the user.

* Menu:

* FTP Objects::
* FTP_TLS Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/ftplib.py

   (2) https://tools.ietf.org/html/rfc959.html

   (3) https://tools.ietf.org/html/rfc4217.html


File: python.info,  Node: FTP Objects,  Next: FTP_TLS Objects,  Up: ftplib — FTP protocol client

5.22.13.1 FTP Objects
.....................

Several methods are available in two flavors: one for handling text
files and another for binary files.  These are named for the command
which is used followed by ‘lines’ for the text version or ‘binary’ for
the binary version.

*note FTP: 9f7. instances have the following methods:

 -- Method: FTP.set_debuglevel (level)

     Set the instance’s debugging level.  This controls the amount of
     debugging output printed.  The default, ‘0’, produces no debugging
     output.  A value of ‘1’ produces a moderate amount of debugging
     output, generally a single line per request.  A value of ‘2’ or
     higher produces the maximum amount of debugging output, logging
     each line sent and received on the control connection.

 -- Method: FTP.connect (host='', port=0, timeout=None,
          source_address=None)

     Connect to the given host and port.  The default port number is
     ‘21’, as specified by the FTP protocol specification.  It is rarely
     needed to specify a different port number.  This function should be
     called only once for each instance; it should not be called at all
     if a host was given when the instance was created.  All other
     methods can only be used after a connection has been made.  The
     optional `timeout' parameter specifies a timeout in seconds for the
     connection attempt.  If no `timeout' is passed, the global default
     timeout setting will be used.  `source_address' is a 2-tuple
     ‘(host, port)’ for the socket to bind to as its source address
     before connecting.

     Raises an *note auditing event: 1275. ‘ftplib.connect’ with
     arguments ‘self’, ‘host’, ‘port’.

     Changed in version 3.3: `source_address' parameter was added.

 -- Method: FTP.getwelcome ()

     Return the welcome message sent by the server in reply to the
     initial connection.  (This message sometimes contains disclaimers
     or help information that may be relevant to the user.)

 -- Method: FTP.login (user='anonymous', passwd='', acct='')

     Log in as the given `user'.  The `passwd' and `acct' parameters are
     optional and default to the empty string.  If no `user' is
     specified, it defaults to ‘'anonymous'’.  If `user' is
     ‘'anonymous'’, the default `passwd' is ‘'anonymous@'’.  This
     function should be called only once for each instance, after a
     connection has been established; it should not be called at all if
     a host and user were given when the instance was created.  Most FTP
     commands are only allowed after the client has logged in.  The
     `acct' parameter supplies “accounting information”; few systems
     implement this.

 -- Method: FTP.abort ()

     Abort a file transfer that is in progress.  Using this does not
     always work, but it’s worth a try.

 -- Method: FTP.sendcmd (cmd)

     Send a simple command string to the server and return the response
     string.

     Raises an *note auditing event: 1275. ‘ftplib.sendcmd’ with
     arguments ‘self’, ‘cmd’.

 -- Method: FTP.voidcmd (cmd)

     Send a simple command string to the server and handle the response.
     Return nothing if a response code corresponding to success (codes
     in the range 200–299) is received.  Raise *note error_reply: 2c49.
     otherwise.

     Raises an *note auditing event: 1275. ‘ftplib.sendcmd’ with
     arguments ‘self’, ‘cmd’.

 -- Method: FTP.retrbinary (cmd, callback, blocksize=8192, rest=None)

     Retrieve a file in binary transfer mode.  `cmd' should be an
     appropriate ‘RETR’ command: ‘'RETR filename'’.  The `callback'
     function is called for each block of data received, with a single
     bytes argument giving the data block.  The optional `blocksize'
     argument specifies the maximum chunk size to read on the low-level
     socket object created to do the actual transfer (which will also be
     the largest size of the data blocks passed to `callback').  A
     reasonable default is chosen.  `rest' means the same thing as in
     the *note transfercmd(): 2c58. method.

 -- Method: FTP.retrlines (cmd, callback=None)

     Retrieve a file or directory listing in ASCII transfer mode.  `cmd'
     should be an appropriate ‘RETR’ command (see *note retrbinary():
     2c57.) or a command such as ‘LIST’ or ‘NLST’ (usually just the
     string ‘'LIST'’).  ‘LIST’ retrieves a list of files and information
     about those files.  ‘NLST’ retrieves a list of file names.  The
     `callback' function is called for each line with a string argument
     containing the line with the trailing CRLF stripped.  The default
     `callback' prints the line to ‘sys.stdout’.

 -- Method: FTP.set_pasv (val)

     Enable “passive” mode if `val' is true, otherwise disable passive
     mode.  Passive mode is on by default.

 -- Method: FTP.storbinary (cmd, fp, blocksize=8192, callback=None,
          rest=None)

     Store a file in binary transfer mode.  `cmd' should be an
     appropriate ‘STOR’ command: ‘"STOR filename"’.  `fp' is a *note
     file object: b35. (opened in binary mode) which is read until EOF
     using its ‘read()’ method in blocks of size `blocksize' to provide
     the data to be stored.  The `blocksize' argument defaults to 8192.
     `callback' is an optional single parameter callable that is called
     on each block of data after it is sent.  `rest' means the same
     thing as in the *note transfercmd(): 2c58. method.

     Changed in version 3.2: `rest' parameter added.

 -- Method: FTP.storlines (cmd, fp, callback=None)

     Store a file in ASCII transfer mode.  `cmd' should be an
     appropriate ‘STOR’ command (see *note storbinary(): c92.).  Lines
     are read until EOF from the *note file object: b35. `fp' (opened in
     binary mode) using its *note readline(): 163f. method to provide
     the data to be stored.  `callback' is an optional single parameter
     callable that is called on each line after it is sent.

 -- Method: FTP.transfercmd (cmd, rest=None)

     Initiate a transfer over the data connection.  If the transfer is
     active, send an ‘EPRT’ or ‘PORT’ command and the transfer command
     specified by `cmd', and accept the connection.  If the server is
     passive, send an ‘EPSV’ or ‘PASV’ command, connect to it, and start
     the transfer command.  Either way, return the socket for the
     connection.

     If optional `rest' is given, a ‘REST’ command is sent to the
     server, passing `rest' as an argument.  `rest' is usually a byte
     offset into the requested file, telling the server to restart
     sending the file’s bytes at the requested offset, skipping over the
     initial bytes.  Note however that RFC 959(1) requires only that
     `rest' be a string containing characters in the printable range
     from ASCII code 33 to ASCII code 126.  The *note transfercmd():
     2c58. method, therefore, converts `rest' to a string, but no check
     is performed on the string’s contents.  If the server does not
     recognize the ‘REST’ command, an *note error_reply: 2c49. exception
     will be raised.  If this happens, simply call *note transfercmd():
     2c58. without a `rest' argument.

 -- Method: FTP.ntransfercmd (cmd, rest=None)

     Like *note transfercmd(): 2c58, but returns a tuple of the data
     connection and the expected size of the data.  If the expected size
     could not be computed, ‘None’ will be returned as the expected
     size.  `cmd' and `rest' means the same thing as in *note
     transfercmd(): 2c58.

 -- Method: FTP.mlsd (path="", facts=[])

     List a directory in a standardized format by using ‘MLSD’ command (
     RFC 3659(2)).  If `path' is omitted the current directory is
     assumed.  `facts' is a list of strings representing the type of
     information desired (e.g.  ‘["type", "size", "perm"]’).  Return a
     generator object yielding a tuple of two elements for every file
     found in path.  First element is the file name, the second one is a
     dictionary containing facts about the file name.  Content of this
     dictionary might be limited by the `facts' argument but server is
     not guaranteed to return all requested facts.

     New in version 3.3.

 -- Method: FTP.nlst (argument[, ...])

     Return a list of file names as returned by the ‘NLST’ command.  The
     optional `argument' is a directory to list (default is the current
     server directory).  Multiple arguments can be used to pass
     non-standard options to the ‘NLST’ command.

          Note: If your server supports the command, *note mlsd(): 9fa.
          offers a better API.

 -- Method: FTP.dir (argument[, ...])

     Produce a directory listing as returned by the ‘LIST’ command,
     printing it to standard output.  The optional `argument' is a
     directory to list (default is the current server directory).
     Multiple arguments can be used to pass non-standard options to the
     ‘LIST’ command.  If the last argument is a function, it is used as
     a `callback' function as for *note retrlines(): 2c59.; the default
     prints to ‘sys.stdout’.  This method returns ‘None’.

          Note: If your server supports the command, *note mlsd(): 9fa.
          offers a better API.

 -- Method: FTP.rename (fromname, toname)

     Rename file `fromname' on the server to `toname'.

 -- Method: FTP.delete (filename)

     Remove the file named `filename' from the server.  If successful,
     returns the text of the response, otherwise raises *note
     error_perm: 2c4b. on permission errors or *note error_reply: 2c49.
     on other errors.

 -- Method: FTP.cwd (pathname)

     Set the current directory on the server.

 -- Method: FTP.mkd (pathname)

     Create a new directory on the server.

 -- Method: FTP.pwd ()

     Return the pathname of the current directory on the server.

 -- Method: FTP.rmd (dirname)

     Remove the directory named `dirname' on the server.

 -- Method: FTP.size (filename)

     Request the size of the file named `filename' on the server.  On
     success, the size of the file is returned as an integer, otherwise
     ‘None’ is returned.  Note that the ‘SIZE’ command is not
     standardized, but is supported by many common server
     implementations.

 -- Method: FTP.quit ()

     Send a ‘QUIT’ command to the server and close the connection.  This
     is the “polite” way to close a connection, but it may raise an
     exception if the server responds with an error to the ‘QUIT’
     command.  This implies a call to the *note close(): 2c65. method
     which renders the *note FTP: 9f7. instance useless for subsequent
     calls (see below).

 -- Method: FTP.close ()

     Close the connection unilaterally.  This should not be applied to
     an already closed connection such as after a successful call to
     *note quit(): 2c64.  After this call the *note FTP: 9f7. instance
     should not be used any more (after a call to *note close(): 2c65.
     or *note quit(): 2c64. you cannot reopen the connection by issuing
     another *note login(): 2c53. method).

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc959.html

   (2) https://tools.ietf.org/html/rfc3659.html


File: python.info,  Node: FTP_TLS Objects,  Prev: FTP Objects,  Up: ftplib — FTP protocol client

5.22.13.2 FTP_TLS Objects
.........................

*note FTP_TLS: 9f8. class inherits from *note FTP: 9f7, defining these
additional objects:

 -- Attribute: FTP_TLS.ssl_version

     The SSL version to use (defaults to *note ssl.PROTOCOL_SSLv23:
     260e.).

 -- Method: FTP_TLS.auth ()

     Set up a secure control connection by using TLS or SSL, depending
     on what is specified in the *note ssl_version: 2c67. attribute.

     Changed in version 3.4: The method now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

 -- Method: FTP_TLS.ccc ()

     Revert control channel back to plaintext.  This can be useful to
     take advantage of firewalls that know how to handle NAT with
     non-secure FTP without opening fixed ports.

     New in version 3.3.

 -- Method: FTP_TLS.prot_p ()

     Set up secure data connection.

 -- Method: FTP_TLS.prot_c ()

     Set up clear text data connection.


File: python.info,  Node: poplib — POP3 protocol client,  Next: imaplib — IMAP4 protocol client,  Prev: ftplib — FTP protocol client,  Up: Internet Protocols and Support

5.22.14 ‘poplib’ — POP3 protocol client
---------------------------------------

`Source code:' Lib/poplib.py(1)

__________________________________________________________________

This module defines a class, *note POP3: 2c6c, which encapsulates a
connection to a POP3 server and implements the protocol as defined in
RFC 1939(2).  The *note POP3: 2c6c. class supports both the minimal and
optional command sets from RFC 1939(3).  The *note POP3: 2c6c. class
also supports the ‘STLS’ command introduced in RFC 2595(4) to enable
encrypted communication on an already established connection.

Additionally, this module provides a class *note POP3_SSL: bb4, which
provides support for connecting to POP3 servers that use SSL as an
underlying protocol layer.

Note that POP3, though widely supported, is obsolescent.  The
implementation quality of POP3 servers varies widely, and too many are
quite poor.  If your mailserver supports IMAP, you would be better off
using the *note imaplib.IMAP4: 600. class, as IMAP servers tend to be
better implemented.

The *note poplib: d0. module provides two classes:

 -- Class: poplib.POP3 (host, port=POP3_PORT[, timeout])

     This class implements the actual POP3 protocol.  The connection is
     created when the instance is initialized.  If `port' is omitted,
     the standard POP3 port (110) is used.  The optional `timeout'
     parameter specifies a timeout in seconds for the connection attempt
     (if not specified, the global default timeout setting will be
     used).

     Raises an *note auditing event: 1275. ‘poplib.connect’ with
     arguments ‘self’, ‘host’, ‘port’.

     All commands will raise an *note auditing event: 1275.
     ‘poplib.putline’ with arguments ‘self’ and ‘line’, where ‘line’ is
     the bytes about to be sent to the remote host.

 -- Class: poplib.POP3_SSL (host, port=POP3_SSL_PORT, keyfile=None,
          certfile=None, timeout=None, context=None)

     This is a subclass of *note POP3: 2c6c. that connects to the server
     over an SSL encrypted socket.  If `port' is not specified, 995, the
     standard POP3-over-SSL port is used.  `timeout' works as in the
     *note POP3: 2c6c. constructor.  `context' is an optional *note
     ssl.SSLContext: 3d9. object which allows bundling SSL configuration
     options, certificates and private keys into a single (potentially
     long-lived) structure.  Please read *note Security considerations:
     24f0. for best practices.

     `keyfile' and `certfile' are a legacy alternative to `context' -
     they can point to PEM-formatted private key and certificate chain
     files, respectively, for the SSL connection.

     Raises an *note auditing event: 1275. ‘poplib.connect’ with
     arguments ‘self’, ‘host’, ‘port’.

     All commands will raise an *note auditing event: 1275.
     ‘poplib.putline’ with arguments ‘self’ and ‘line’, where ‘line’ is
     the bytes about to be sent to the remote host.

     Changed in version 3.2: `context' parameter added.

     Changed in version 3.4: The class now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

     Deprecated since version 3.6: `keyfile' and `certfile' are
     deprecated in favor of `context'.  Please use *note
     ssl.SSLContext.load_cert_chain(): a86. instead, or let *note
     ssl.create_default_context(): 8b5. select the system’s trusted CA
     certificates for you.

One exception is defined as an attribute of the *note poplib: d0.
module:

 -- Exception: poplib.error_proto

     Exception raised on any errors from this module (errors from *note
     socket: ef. module are not caught).  The reason for the exception
     is passed to the constructor as a string.

See also
........

Module *note imaplib: 98.

     The standard Python IMAP module.

Frequently Asked Questions About Fetchmail(5)

     The FAQ for the ‘fetchmail’ POP/IMAP client collects information on
     POP3 server variations and RFC noncompliance that may be useful if
     you need to write an application based on the POP protocol.

* Menu:

* POP3 Objects::
* POP3 Example::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/poplib.py

   (2) https://tools.ietf.org/html/rfc1939.html

   (3) https://tools.ietf.org/html/rfc1939.html

   (4) https://tools.ietf.org/html/rfc2595.html

   (5) http://www.catb.org/~esr/fetchmail/fetchmail-FAQ.html


File: python.info,  Node: POP3 Objects,  Next: POP3 Example,  Up: poplib — POP3 protocol client

5.22.14.1 POP3 Objects
......................

All POP3 commands are represented by methods of the same name, in
lower-case; most return the response text sent by the server.

An *note POP3: 2c6c. instance has the following methods:

 -- Method: POP3.set_debuglevel (level)

     Set the instance’s debugging level.  This controls the amount of
     debugging output printed.  The default, ‘0’, produces no debugging
     output.  A value of ‘1’ produces a moderate amount of debugging
     output, generally a single line per request.  A value of ‘2’ or
     higher produces the maximum amount of debugging output, logging
     each line sent and received on the control connection.

 -- Method: POP3.getwelcome ()

     Returns the greeting string sent by the POP3 server.

 -- Method: POP3.capa ()

     Query the server’s capabilities as specified in RFC 2449(1).
     Returns a dictionary in the form ‘{'name': ['param'...]}’.

     New in version 3.4.

 -- Method: POP3.user (username)

     Send user command, response should indicate that a password is
     required.

 -- Method: POP3.pass_ (password)

     Send password, response includes message count and mailbox size.
     Note: the mailbox on the server is locked until ‘quit()’ is called.

 -- Method: POP3.apop (user, secret)

     Use the more secure APOP authentication to log into the POP3
     server.

 -- Method: POP3.rpop (user)

     Use RPOP authentication (similar to UNIX r-commands) to log into
     POP3 server.

 -- Method: POP3.stat ()

     Get mailbox status.  The result is a tuple of 2 integers: ‘(message
     count, mailbox size)’.

 -- Method: POP3.list ([which])

     Request message list, result is in the form ‘(response, ['mesg_num
     octets', ...], octets)’.  If `which' is set, it is the message to
     list.

 -- Method: POP3.retr (which)

     Retrieve whole message number `which', and set its seen flag.
     Result is in form ‘(response, ['line', ...], octets)’.

 -- Method: POP3.dele (which)

     Flag message number `which' for deletion.  On most servers
     deletions are not actually performed until QUIT (the major
     exception is Eudora QPOP, which deliberately violates the RFCs by
     doing pending deletes on any disconnect).

 -- Method: POP3.rset ()

     Remove any deletion marks for the mailbox.

 -- Method: POP3.noop ()

     Do nothing.  Might be used as a keep-alive.

 -- Method: POP3.quit ()

     Signoff: commit changes, unlock mailbox, drop connection.

 -- Method: POP3.top (which, howmuch)

     Retrieves the message header plus `howmuch' lines of the message
     after the header of message number `which'.  Result is in form
     ‘(response, ['line', ...], octets)’.

     The POP3 TOP command this method uses, unlike the RETR command,
     doesn’t set the message’s seen flag; unfortunately, TOP is poorly
     specified in the RFCs and is frequently broken in off-brand
     servers.  Test this method by hand against the POP3 servers you
     will use before trusting it.

 -- Method: POP3.uidl (which=None)

     Return message digest (unique id) list.  If `which' is specified,
     result contains the unique id for that message in the form
     ‘'response mesgnum uid’, otherwise result is list ‘(response,
     ['mesgnum uid', ...], octets)’.

 -- Method: POP3.utf8 ()

     Try to switch to UTF-8 mode.  Returns the server response if
     successful, raises *note error_proto: b0a. if not.  Specified in
     RFC 6856(2).

     New in version 3.5.

 -- Method: POP3.stls (context=None)

     Start a TLS session on the active connection as specified in RFC
     2595(3).  This is only allowed before user authentication

     `context' parameter is a *note ssl.SSLContext: 3d9. object which
     allows bundling SSL configuration options, certificates and private
     keys into a single (potentially long-lived) structure.  Please read
     *note Security considerations: 24f0. for best practices.

     This method supports hostname checking via *note
     ssl.SSLContext.check_hostname: 2609. and `Server Name Indication'
     (see *note ssl.HAS_SNI: 261e.).

     New in version 3.4.

Instances of *note POP3_SSL: bb4. have no additional methods.  The
interface of this subclass is identical to its parent.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2449.html

   (2) https://tools.ietf.org/html/rfc6856.html

   (3) https://tools.ietf.org/html/rfc2595.html


File: python.info,  Node: POP3 Example,  Prev: POP3 Objects,  Up: poplib — POP3 protocol client

5.22.14.2 POP3 Example
......................

Here is a minimal example (without error checking) that opens a mailbox
and retrieves and prints all messages:

     import getpass, poplib  M = poplib.POP3('localhost') M.user(getpass.getuser()) M.pass_(getpass.getpass()) numMessages = len(M.list()[1]) for i in range(numMessages):     for j in M.retr(i+1)[1]:         print(j)

At the end of the module, there is a test section that contains a more
extensive example of usage.


File: python.info,  Node: imaplib — IMAP4 protocol client,  Next: nntplib — NNTP protocol client,  Prev: poplib — POP3 protocol client,  Up: Internet Protocols and Support

5.22.15 ‘imaplib’ — IMAP4 protocol client
-----------------------------------------

`Source code:' Lib/imaplib.py(1)

__________________________________________________________________

This module defines three classes, *note IMAP4: 600, *note IMAP4_SSL:
a0c. and *note IMAP4_stream: 2c81, which encapsulate a connection to an
IMAP4 server and implement a large subset of the IMAP4rev1 client
protocol as defined in RFC 2060(2).  It is backward compatible with
IMAP4 ( RFC 1730(3)) servers, but note that the ‘STATUS’ command is not
supported in IMAP4.

Three classes are provided by the *note imaplib: 98. module, *note
IMAP4: 600. is the base class:

 -- Class: imaplib.IMAP4 (host='', port=IMAP4_PORT)

     This class implements the actual IMAP4 protocol.  The connection is
     created and protocol version (IMAP4 or IMAP4rev1) is determined
     when the instance is initialized.  If `host' is not specified, ‘''’
     (the local host) is used.  If `port' is omitted, the standard IMAP4
     port (143) is used.

     The *note IMAP4: 600. class supports the *note with: 6dd.
     statement.  When used like this, the IMAP4 ‘LOGOUT’ command is
     issued automatically when the ‘with’ statement exits.  E.g.:

          >>> from imaplib import IMAP4 >>> with IMAP4("domain.org") as M: ...     M.noop() ... ('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])

     Changed in version 3.5: Support for the *note with: 6dd. statement
     was added.

Three exceptions are defined as attributes of the *note IMAP4: 600.
class:

 -- Exception: IMAP4.error

     Exception raised on any errors.  The reason for the exception is
     passed to the constructor as a string.

 -- Exception: IMAP4.abort

     IMAP4 server errors cause this exception to be raised.  This is a
     sub-class of *note IMAP4.error: 2c82.  Note that closing the
     instance and instantiating a new one will usually allow recovery
     from this exception.

 -- Exception: IMAP4.readonly

     This exception is raised when a writable mailbox has its status
     changed by the server.  This is a sub-class of *note IMAP4.error:
     2c82.  Some other client now has write permission, and the mailbox
     will need to be re-opened to re-obtain write permission.

There’s also a subclass for secure connections:

 -- Class: imaplib.IMAP4_SSL (host='', port=IMAP4_SSL_PORT,
          keyfile=None, certfile=None, ssl_context=None)

     This is a subclass derived from *note IMAP4: 600. that connects
     over an SSL encrypted socket (to use this class you need a socket
     module that was compiled with SSL support).  If `host' is not
     specified, ‘''’ (the local host) is used.  If `port' is omitted,
     the standard IMAP4-over-SSL port (993) is used.  `ssl_context' is a
     *note ssl.SSLContext: 3d9. object which allows bundling SSL
     configuration options, certificates and private keys into a single
     (potentially long-lived) structure.  Please read *note Security
     considerations: 24f0. for best practices.

     `keyfile' and `certfile' are a legacy alternative to `ssl_context'
     - they can point to PEM-formatted private key and certificate chain
     files for the SSL connection.  Note that the `keyfile'/`certfile'
     parameters are mutually exclusive with `ssl_context', a *note
     ValueError: 1f9. is raised if `keyfile'/`certfile' is provided
     along with `ssl_context'.

     Changed in version 3.3: `ssl_context' parameter added.

     Changed in version 3.4: The class now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

     Deprecated since version 3.6: `keyfile' and `certfile' are
     deprecated in favor of `ssl_context'.  Please use *note
     ssl.SSLContext.load_cert_chain(): a86. instead, or let *note
     ssl.create_default_context(): 8b5. select the system’s trusted CA
     certificates for you.

The second subclass allows for connections created by a child process:

 -- Class: imaplib.IMAP4_stream (command)

     This is a subclass derived from *note IMAP4: 600. that connects to
     the ‘stdin/stdout’ file descriptors created by passing `command' to
     ‘subprocess.Popen()’.

The following utility functions are defined:

 -- Function: imaplib.Internaldate2tuple (datestr)

     Parse an IMAP4 ‘INTERNALDATE’ string and return corresponding local
     time.  The return value is a *note time.struct_time: 58e. tuple or
     ‘None’ if the string has wrong format.

 -- Function: imaplib.Int2AP (num)

     Converts an integer into a string representation using characters
     from the set [‘A’ ..  ‘P’].

 -- Function: imaplib.ParseFlags (flagstr)

     Converts an IMAP4 ‘FLAGS’ response to a tuple of individual flags.

 -- Function: imaplib.Time2Internaldate (date_time)

     Convert `date_time' to an IMAP4 ‘INTERNALDATE’ representation.  The
     return value is a string in the form: ‘"DD-Mmm-YYYY HH:MM:SS
     +HHMM"’ (including double-quotes).  The `date_time' argument can be
     a number (int or float) representing seconds since epoch (as
     returned by *note time.time(): 312.), a 9-tuple representing local
     time an instance of *note time.struct_time: 58e. (as returned by
     *note time.localtime(): 17ea.), an aware instance of *note
     datetime.datetime: 194, or a double-quoted string.  In the last
     case, it is assumed to already be in the correct format.

Note that IMAP4 message numbers change as the mailbox changes; in
particular, after an ‘EXPUNGE’ command performs deletions the remaining
messages are renumbered.  So it is highly advisable to use UIDs instead,
with the UID command.

At the end of the module, there is a test section that contains a more
extensive example of usage.

See also
........

Documents describing the protocol, and sources and binaries for servers
implementing it, can all be found at the University of Washington’s
`IMAP Information Center' (‘https://www.washington.edu/imap/’).

* Menu:

* IMAP4 Objects::
* IMAP4 Example::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/imaplib.py

   (2) https://tools.ietf.org/html/rfc2060.html

   (3) https://tools.ietf.org/html/rfc1730.html


File: python.info,  Node: IMAP4 Objects,  Next: IMAP4 Example,  Up: imaplib — IMAP4 protocol client

5.22.15.1 IMAP4 Objects
.......................

All IMAP4rev1 commands are represented by methods of the same name,
either upper-case or lower-case.

All arguments to commands are converted to strings, except for
‘AUTHENTICATE’, and the last argument to ‘APPEND’ which is passed as an
IMAP4 literal.  If necessary (the string contains IMAP4
protocol-sensitive characters and isn’t enclosed with either parentheses
or double quotes) each string is quoted.  However, the `password'
argument to the ‘LOGIN’ command is always quoted.  If you want to avoid
having an argument string quoted (eg: the `flags' argument to ‘STORE’)
then enclose the string in parentheses (eg: ‘r'(\Deleted)'’).

Each command returns a tuple: ‘(type, [data, ...])’ where `type' is
usually ‘'OK'’ or ‘'NO'’, and `data' is either the text from the command
response, or mandated results from the command.  Each `data' is either a
string, or a tuple.  If a tuple, then the first part is the header of
the response, and the second part contains the data (ie: ‘literal’
value).

The `message_set' options to commands below is a string specifying one
or more messages to be acted upon.  It may be a simple message number
(‘'1'’), a range of message numbers (‘'2:4'’), or a group of
non-contiguous ranges separated by commas (‘'1:3,6:9'’).  A range can
contain an asterisk to indicate an infinite upper bound (‘'3:*'’).

An *note IMAP4: 600. instance has the following methods:

 -- Method: IMAP4.append (mailbox, flags, date_time, message)

     Append `message' to named mailbox.

 -- Method: IMAP4.authenticate (mechanism, authobject)

     Authenticate command — requires response processing.

     `mechanism' specifies which authentication mechanism is to be used
     - it should appear in the instance variable ‘capabilities’ in the
     form ‘AUTH=mechanism’.

     `authobject' must be a callable object:

          data = authobject(response)

     It will be called to process server continuation responses; the
     `response' argument it is passed will be ‘bytes’.  It should return
     ‘bytes’ `data' that will be base64 encoded and sent to the server.
     It should return ‘None’ if the client abort response ‘*’ should be
     sent instead.

     Changed in version 3.5: string usernames and passwords are now
     encoded to ‘utf-8’ instead of being limited to ASCII.

 -- Method: IMAP4.check ()

     Checkpoint mailbox on server.

 -- Method: IMAP4.close ()

     Close currently selected mailbox.  Deleted messages are removed
     from writable mailbox.  This is the recommended command before
     ‘LOGOUT’.

 -- Method: IMAP4.copy (message_set, new_mailbox)

     Copy `message_set' messages onto end of `new_mailbox'.

 -- Method: IMAP4.create (mailbox)

     Create new mailbox named `mailbox'.

 -- Method: IMAP4.delete (mailbox)

     Delete old mailbox named `mailbox'.

 -- Method: IMAP4.deleteacl (mailbox, who)

     Delete the ACLs (remove any rights) set for who on mailbox.

 -- Method: IMAP4.enable (capability)

     Enable `capability' (see RFC 5161(1)).  Most capabilities do not
     need to be enabled.  Currently only the ‘UTF8=ACCEPT’ capability is
     supported (see RFC 6855(2)).

     New in version 3.5: The *note enable(): 6de. method itself, and RFC
     6855(3) support.

 -- Method: IMAP4.expunge ()

     Permanently remove deleted items from selected mailbox.  Generates
     an ‘EXPUNGE’ response for each deleted message.  Returned data
     contains a list of ‘EXPUNGE’ message numbers in order received.

 -- Method: IMAP4.fetch (message_set, message_parts)

     Fetch (parts of) messages.  `message_parts' should be a string of
     message part names enclosed within parentheses, eg: ‘"(UID
     BODY[TEXT])"’.  Returned data are tuples of message part envelope
     and data.

 -- Method: IMAP4.getacl (mailbox)

     Get the ‘ACL’s for `mailbox'.  The method is non-standard, but is
     supported by the ‘Cyrus’ server.

 -- Method: IMAP4.getannotation (mailbox, entry, attribute)

     Retrieve the specified ‘ANNOTATION’s for `mailbox'.  The method is
     non-standard, but is supported by the ‘Cyrus’ server.

 -- Method: IMAP4.getquota (root)

     Get the ‘quota’ `root'’s resource usage and limits.  This method is
     part of the IMAP4 QUOTA extension defined in rfc2087.

 -- Method: IMAP4.getquotaroot (mailbox)

     Get the list of ‘quota’ ‘roots’ for the named `mailbox'.  This
     method is part of the IMAP4 QUOTA extension defined in rfc2087.

 -- Method: IMAP4.list ([directory[, pattern]])

     List mailbox names in `directory' matching `pattern'.  `directory'
     defaults to the top-level mail folder, and `pattern' defaults to
     match anything.  Returned data contains a list of ‘LIST’ responses.

 -- Method: IMAP4.login (user, password)

     Identify the client using a plaintext password.  The `password'
     will be quoted.

 -- Method: IMAP4.login_cram_md5 (user, password)

     Force use of ‘CRAM-MD5’ authentication when identifying the client
     to protect the password.  Will only work if the server ‘CAPABILITY’
     response includes the phrase ‘AUTH=CRAM-MD5’.

 -- Method: IMAP4.logout ()

     Shutdown connection to server.  Returns server ‘BYE’ response.

     Changed in version 3.8: The method no longer ignores silently
     arbitrary exceptions.

 -- Method: IMAP4.lsub (directory='""', pattern='*')

     List subscribed mailbox names in directory matching pattern.
     `directory' defaults to the top level directory and `pattern'
     defaults to match any mailbox.  Returned data are tuples of message
     part envelope and data.

 -- Method: IMAP4.myrights (mailbox)

     Show my ACLs for a mailbox (i.e.  the rights that I have on
     mailbox).

 -- Method: IMAP4.namespace ()

     Returns IMAP namespaces as defined in RFC 2342(4).

 -- Method: IMAP4.noop ()

     Send ‘NOOP’ to server.

 -- Method: IMAP4.open (host, port)

     Opens socket to `port' at `host'.  This method is implicitly called
     by the *note IMAP4: 600. constructor.  The connection objects
     established by this method will be used in the *note IMAP4.read():
     2ca2, *note IMAP4.readline(): 2ca3, *note IMAP4.send(): 2ca4, and
     *note IMAP4.shutdown(): 2ca5. methods.  You may override this
     method.

     Raises an *note auditing event: 1275. ‘imaplib.open’ with arguments
     ‘self’, ‘host’, ‘port’.

 -- Method: IMAP4.partial (message_num, message_part, start, length)

     Fetch truncated part of a message.  Returned data is a tuple of
     message part envelope and data.

 -- Method: IMAP4.proxyauth (user)

     Assume authentication as `user'.  Allows an authorised
     administrator to proxy into any user’s mailbox.

 -- Method: IMAP4.read (size)

     Reads `size' bytes from the remote server.  You may override this
     method.

 -- Method: IMAP4.readline ()

     Reads one line from the remote server.  You may override this
     method.

 -- Method: IMAP4.recent ()

     Prompt server for an update.  Returned data is ‘None’ if no new
     messages, else value of ‘RECENT’ response.

 -- Method: IMAP4.rename (oldmailbox, newmailbox)

     Rename mailbox named `oldmailbox' to `newmailbox'.

 -- Method: IMAP4.response (code)

     Return data for response `code' if received, or ‘None’.  Returns
     the given code, instead of the usual type.

 -- Method: IMAP4.search (charset, criterion[, ...])

     Search mailbox for matching messages.  `charset' may be ‘None’, in
     which case no ‘CHARSET’ will be specified in the request to the
     server.  The IMAP protocol requires that at least one criterion be
     specified; an exception will be raised when the server returns an
     error.  `charset' must be ‘None’ if the ‘UTF8=ACCEPT’ capability
     was enabled using the *note enable(): 6de. command.

     Example:

          # M is a connected IMAP4 instance... typ, msgnums = M.search(None, 'FROM', '"LDJ"')  # or: typ, msgnums = M.search(None, '(FROM "LDJ")')

 -- Method: IMAP4.select (mailbox='INBOX', readonly=False)

     Select a mailbox.  Returned data is the count of messages in
     `mailbox' (‘EXISTS’ response).  The default `mailbox' is ‘'INBOX'’.
     If the `readonly' flag is set, modifications to the mailbox are not
     allowed.

 -- Method: IMAP4.send (data)

     Sends ‘data’ to the remote server.  You may override this method.

     Raises an *note auditing event: 1275. ‘imaplib.send’ with arguments
     ‘self’, ‘data’.

 -- Method: IMAP4.setacl (mailbox, who, what)

     Set an ‘ACL’ for `mailbox'.  The method is non-standard, but is
     supported by the ‘Cyrus’ server.

 -- Method: IMAP4.setannotation (mailbox, entry, attribute[, ...])

     Set ‘ANNOTATION’s for `mailbox'.  The method is non-standard, but
     is supported by the ‘Cyrus’ server.

 -- Method: IMAP4.setquota (root, limits)

     Set the ‘quota’ `root'’s resource `limits'.  This method is part of
     the IMAP4 QUOTA extension defined in rfc2087.

 -- Method: IMAP4.shutdown ()

     Close connection established in ‘open’.  This method is implicitly
     called by *note IMAP4.logout(): 2c9c.  You may override this
     method.

 -- Method: IMAP4.socket ()

     Returns socket instance used to connect to server.

 -- Method: IMAP4.sort (sort_criteria, charset, search_criterion[, ...])

     The ‘sort’ command is a variant of ‘search’ with sorting semantics
     for the results.  Returned data contains a space separated list of
     matching message numbers.

     Sort has two arguments before the `search_criterion' argument(s); a
     parenthesized list of `sort_criteria', and the searching `charset'.
     Note that unlike ‘search’, the searching `charset' argument is
     mandatory.  There is also a ‘uid sort’ command which corresponds to
     ‘sort’ the way that ‘uid search’ corresponds to ‘search’.  The
     ‘sort’ command first searches the mailbox for messages that match
     the given searching criteria using the charset argument for the
     interpretation of strings in the searching criteria.  It then
     returns the numbers of matching messages.

     This is an ‘IMAP4rev1’ extension command.

 -- Method: IMAP4.starttls (ssl_context=None)

     Send a ‘STARTTLS’ command.  The `ssl_context' argument is optional
     and should be a *note ssl.SSLContext: 3d9. object.  This will
     enable encryption on the IMAP connection.  Please read *note
     Security considerations: 24f0. for best practices.

     New in version 3.2.

     Changed in version 3.4: The method now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

 -- Method: IMAP4.status (mailbox, names)

     Request named status conditions for `mailbox'.

 -- Method: IMAP4.store (message_set, command, flag_list)

     Alters flag dispositions for messages in mailbox.  `command' is
     specified by section 6.4.6 of RFC 2060(5) as being one of “FLAGS”,
     “+FLAGS”, or “-FLAGS”, optionally with a suffix of “.SILENT”.

     For example, to set the delete flag on all messages:

          typ, data = M.search(None, 'ALL') for num in data[0].split():    M.store(num, '+FLAGS', '\\Deleted') M.expunge()

          Note: Creating flags containing ‘]’ (for example: “[test]”)
          violates RFC 3501(6) (the IMAP protocol).  However, imaplib
          has historically allowed creation of such tags, and popular
          IMAP servers, such as Gmail, accept and produce such flags.
          There are non-Python programs which also create such tags.
          Although it is an RFC violation and IMAP clients and servers
          are supposed to be strict, imaplib nonetheless continues to
          allow such tags to be created for backward compatibility
          reasons, and as of Python 3.6, handles them if they are sent
          from the server, since this improves real-world compatibility.

 -- Method: IMAP4.subscribe (mailbox)

     Subscribe to new mailbox.

 -- Method: IMAP4.thread (threading_algorithm, charset,
          search_criterion[, ...])

     The ‘thread’ command is a variant of ‘search’ with threading
     semantics for the results.  Returned data contains a space
     separated list of thread members.

     Thread members consist of zero or more messages numbers, delimited
     by spaces, indicating successive parent and child.

     Thread has two arguments before the `search_criterion' argument(s);
     a `threading_algorithm', and the searching `charset'.  Note that
     unlike ‘search’, the searching `charset' argument is mandatory.
     There is also a ‘uid thread’ command which corresponds to ‘thread’
     the way that ‘uid search’ corresponds to ‘search’.  The ‘thread’
     command first searches the mailbox for messages that match the
     given searching criteria using the charset argument for the
     interpretation of strings in the searching criteria.  It then
     returns the matching messages threaded according to the specified
     threading algorithm.

     This is an ‘IMAP4rev1’ extension command.

 -- Method: IMAP4.uid (command, arg[, ...])

     Execute command args with messages identified by UID, rather than
     message number.  Returns response appropriate to command.  At least
     one argument must be supplied; if none are provided, the server
     will return an error and an exception will be raised.

 -- Method: IMAP4.unsubscribe (mailbox)

     Unsubscribe from old mailbox.

 -- Method: IMAP4.xatom (name[, ...])

     Allow simple extension commands notified by server in ‘CAPABILITY’
     response.

The following attributes are defined on instances of *note IMAP4: 600.:

 -- Attribute: IMAP4.PROTOCOL_VERSION

     The most recent supported protocol in the ‘CAPABILITY’ response
     from the server.

 -- Attribute: IMAP4.debug

     Integer value to control debugging output.  The initialize value is
     taken from the module variable ‘Debug’.  Values greater than three
     trace each command.

 -- Attribute: IMAP4.utf8_enabled

     Boolean value that is normally ‘False’, but is set to ‘True’ if an
     *note enable(): 6de. command is successfully issued for the
     ‘UTF8=ACCEPT’ capability.

     New in version 3.5.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc5161.html

   (2) https://tools.ietf.org/html/rfc6855.html

   (3) https://tools.ietf.org/html/rfc6855.html

   (4) https://tools.ietf.org/html/rfc2342.html

   (5) https://tools.ietf.org/html/rfc2060.html

   (6) https://tools.ietf.org/html/rfc3501.html


File: python.info,  Node: IMAP4 Example,  Prev: IMAP4 Objects,  Up: imaplib — IMAP4 protocol client

5.22.15.2 IMAP4 Example
.......................

Here is a minimal example (without error checking) that opens a mailbox
and retrieves and prints all messages:

     import getpass, imaplib  M = imaplib.IMAP4() M.login(getpass.getuser(), getpass.getpass()) M.select() typ, data = M.search(None, 'ALL') for num in data[0].split():     typ, data = M.fetch(num, '(RFC822)')     print('Message %s\n%s\n' % (num, data[0][1])) M.close() M.logout()


File: python.info,  Node: nntplib — NNTP protocol client,  Next: smtplib — SMTP protocol client,  Prev: imaplib — IMAP4 protocol client,  Up: Internet Protocols and Support

5.22.16 ‘nntplib’ — NNTP protocol client
----------------------------------------

`Source code:' Lib/nntplib.py(1)

__________________________________________________________________

This module defines the class *note NNTP: a21. which implements the
client side of the Network News Transfer Protocol.  It can be used to
implement a news reader or poster, or automated news processors.  It is
compatible with RFC 3977(2) as well as the older RFC 977(3) and RFC
2980(4).

Here are two small examples of how it can be used.  To list some
statistics about a newsgroup and print the subjects of the last 10
articles:

     >>> s = nntplib.NNTP('news.gmane.org') >>> resp, count, first, last, name = s.group('gmane.comp.python.committers') >>> print('Group', name, 'has', count, 'articles, range', first, 'to', last) Group gmane.comp.python.committers has 1096 articles, range 1 to 1096 >>> resp, overviews = s.over((last - 9, last)) >>> for id, over in overviews: ...     print(id, nntplib.decode_header(over['subject'])) ... 1087 Re: Commit privileges for Łukasz Langa 1088 Re: 3.2 alpha 2 freeze 1089 Re: 3.2 alpha 2 freeze 1090 Re: Commit privileges for Łukasz Langa 1091 Re: Commit privileges for Łukasz Langa 1092 Updated ssh key 1093 Re: Updated ssh key 1094 Re: Updated ssh key 1095 Hello fellow committers! 1096 Re: Hello fellow committers! >>> s.quit() '205 Bye!'

To post an article from a binary file (this assumes that the article has
valid headers, and that you have right to post on the particular
newsgroup):

     >>> s = nntplib.NNTP('news.gmane.org') >>> f = open('article.txt', 'rb') >>> s.post(f) '240 Article posted successfully.' >>> s.quit() '205 Bye!'

The module itself defines the following classes:

 -- Class: nntplib.NNTP (host, port=119, user=None, password=None,
          readermode=None, usenetrc=False[, timeout])

     Return a new *note NNTP: a21. object, representing a connection to
     the NNTP server running on host `host', listening at port `port'.
     An optional `timeout' can be specified for the socket connection.
     If the optional `user' and `password' are provided, or if suitable
     credentials are present in ‘/.netrc’ and the optional flag
     `usenetrc' is true, the ‘AUTHINFO USER’ and ‘AUTHINFO PASS’
     commands are used to identify and authenticate the user to the
     server.  If the optional flag `readermode' is true, then a ‘mode
     reader’ command is sent before authentication is performed.  Reader
     mode is sometimes necessary if you are connecting to an NNTP server
     on the local machine and intend to call reader-specific commands,
     such as ‘group’.  If you get unexpected *note NNTPPermanentError:
     2cbf.s, you might need to set `readermode'.  The *note NNTP: a21.
     class supports the *note with: 6dd. statement to unconditionally
     consume *note OSError: 1d1. exceptions and to close the NNTP
     connection when done, e.g.:

          >>> from nntplib import NNTP >>> with NNTP('news.gmane.org') as n: ...     n.group('gmane.comp.python.committers') ... # doctest: +SKIP ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers') >>>

     Raises an *note auditing event: 1275. ‘nntplib.connect’ with
     arguments ‘self’, ‘host’, ‘port’.

     All commands will raise an *note auditing event: 1275.
     ‘nntplib.putline’ with arguments ‘self’ and ‘line’, where ‘line’ is
     the bytes about to be sent to the remote host.

     Changed in version 3.2: `usenetrc' is now ‘False’ by default.

     Changed in version 3.3: Support for the *note with: 6dd. statement
     was added.

 -- Class: nntplib.NNTP_SSL (host, port=563, user=None, password=None,
          ssl_context=None, readermode=None, usenetrc=False[, timeout])

     Return a new *note NNTP_SSL: b98. object, representing an encrypted
     connection to the NNTP server running on host `host', listening at
     port `port'.  *note NNTP_SSL: b98. objects have the same methods as
     *note NNTP: a21. objects.  If `port' is omitted, port 563 (NNTPS)
     is used.  `ssl_context' is also optional, and is a *note
     SSLContext: 3d9. object.  Please read *note Security
     considerations: 24f0. for best practices.  All other parameters
     behave the same as for *note NNTP: a21.

     Note that SSL-on-563 is discouraged per RFC 4642(5), in favor of
     STARTTLS as described below.  However, some servers only support
     the former.

     Raises an *note auditing event: 1275. ‘nntplib.connect’ with
     arguments ‘self’, ‘host’, ‘port’.

     All commands will raise an *note auditing event: 1275.
     ‘nntplib.putline’ with arguments ‘self’ and ‘line’, where ‘line’ is
     the bytes about to be sent to the remote host.

     New in version 3.2.

     Changed in version 3.4: The class now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

 -- Exception: nntplib.NNTPError

     Derived from the standard exception *note Exception: 1a8, this is
     the base class for all exceptions raised by the *note nntplib: c0.
     module.  Instances of this class have the following attribute:

      -- Attribute: response

          The response of the server if available, as a *note str: 325.
          object.

 -- Exception: nntplib.NNTPReplyError

     Exception raised when an unexpected reply is received from the
     server.

 -- Exception: nntplib.NNTPTemporaryError

     Exception raised when a response code in the range 400–499 is
     received.

 -- Exception: nntplib.NNTPPermanentError

     Exception raised when a response code in the range 500–599 is
     received.

 -- Exception: nntplib.NNTPProtocolError

     Exception raised when a reply is received from the server that does
     not begin with a digit in the range 1–5.

 -- Exception: nntplib.NNTPDataError

     Exception raised when there is some error in the response data.

* Menu:

* NNTP Objects::
* Utility functions: Utility functions<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/nntplib.py

   (2) https://tools.ietf.org/html/rfc3977.html

   (3) https://tools.ietf.org/html/rfc977.html

   (4) https://tools.ietf.org/html/rfc2980.html

   (5) https://tools.ietf.org/html/rfc4642.html


File: python.info,  Node: NNTP Objects,  Next: Utility functions<2>,  Up: nntplib — NNTP protocol client

5.22.16.1 NNTP Objects
......................

When connected, *note NNTP: a21. and *note NNTP_SSL: b98. objects
support the following methods and attributes.

* Menu:

* Attributes::
* Methods: Methods<3>.


File: python.info,  Node: Attributes,  Next: Methods<3>,  Up: NNTP Objects

5.22.16.2 Attributes
....................

 -- Attribute: NNTP.nntp_version

     An integer representing the version of the NNTP protocol supported
     by the server.  In practice, this should be ‘2’ for servers
     advertising RFC 3977(1) compliance and ‘1’ for others.

     New in version 3.2.

 -- Attribute: NNTP.nntp_implementation

     A string describing the software name and version of the NNTP
     server, or *note None: 157. if not advertised by the server.

     New in version 3.2.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3977.html


File: python.info,  Node: Methods<3>,  Prev: Attributes,  Up: NNTP Objects

5.22.16.3 Methods
.................

The `response' that is returned as the first item in the return tuple of
almost all methods is the server’s response: a string beginning with a
three-digit code.  If the server’s response indicates an error, the
method raises one of the above exceptions.

Many of the following methods take an optional keyword-only argument
`file'.  When the `file' argument is supplied, it must be either a *note
file object: b35. opened for binary writing, or the name of an on-disk
file to be written to.  The method will then write any data returned by
the server (except for the response line and the terminating dot) to the
file; any list of lines, tuples or objects that the method normally
returns will be empty.

Changed in version 3.2: Many of the following methods have been reworked
and fixed, which makes them incompatible with their 3.1 counterparts.

 -- Method: NNTP.quit ()

     Send a ‘QUIT’ command and close the connection.  Once this method
     has been called, no other methods of the NNTP object should be
     called.

 -- Method: NNTP.getwelcome ()

     Return the welcome message sent by the server in reply to the
     initial connection.  (This message sometimes contains disclaimers
     or help information that may be relevant to the user.)

 -- Method: NNTP.getcapabilities ()

     Return the RFC 3977(1) capabilities advertised by the server, as a
     *note dict: 1b6. instance mapping capability names to (possibly
     empty) lists of values.  On legacy servers which don’t understand
     the ‘CAPABILITIES’ command, an empty dictionary is returned
     instead.

          >>> s = NNTP('news.gmane.org') >>> 'POST' in s.getcapabilities() True

     New in version 3.2.

 -- Method: NNTP.login (user=None, password=None, usenetrc=True)

     Send ‘AUTHINFO’ commands with the user name and password.  If
     `user' and `password' are ‘None’ and `usenetrc' is true,
     credentials from ‘~/.netrc’ will be used if possible.

     Unless intentionally delayed, login is normally performed during
     the *note NNTP: a21. object initialization and separately calling
     this function is unnecessary.  To force authentication to be
     delayed, you must not set `user' or `password' when creating the
     object, and must set `usenetrc' to False.

     New in version 3.2.

 -- Method: NNTP.starttls (context=None)

     Send a ‘STARTTLS’ command.  This will enable encryption on the NNTP
     connection.  The `context' argument is optional and should be a
     *note ssl.SSLContext: 3d9. object.  Please read *note Security
     considerations: 24f0. for best practices.

     Note that this may not be done after authentication information has
     been transmitted, and authentication occurs by default if possible
     during a *note NNTP: a21. object initialization.  See *note
     NNTP.login(): 2ccf. for information on suppressing this behavior.

     New in version 3.2.

     Changed in version 3.4: The method now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

 -- Method: NNTP.newgroups (date, *, file=None)

     Send a ‘NEWGROUPS’ command.  The `date' argument should be a *note
     datetime.date: 193. or *note datetime.datetime: 194. object.
     Return a pair ‘(response, groups)’ where `groups' is a list
     representing the groups that are new since the given `date'.  If
     `file' is supplied, though, then `groups' will be empty.

          >>> from datetime import date, timedelta >>> resp, groups = s.newgroups(date.today() - timedelta(days=3)) >>> len(groups) # doctest: +SKIP 85 >>> groups[0] # doctest: +SKIP GroupInfo(group='gmane.network.tor.devel', last='4', first='1', flag='m')

 -- Method: NNTP.newnews (group, date, *, file=None)

     Send a ‘NEWNEWS’ command.  Here, `group' is a group name or ‘'*'’,
     and `date' has the same meaning as for *note newgroups(): 2cd0.
     Return a pair ‘(response, articles)’ where `articles' is a list of
     message ids.

     This command is frequently disabled by NNTP server administrators.

 -- Method: NNTP.list (group_pattern=None, *, file=None)

     Send a ‘LIST’ or ‘LIST ACTIVE’ command.  Return a pair ‘(response,
     list)’ where `list' is a list of tuples representing all the groups
     available from this NNTP server, optionally matching the pattern
     string `group_pattern'.  Each tuple has the form ‘(group, last,
     first, flag)’, where `group' is a group name, `last' and `first'
     are the last and first article numbers, and `flag' usually takes
     one of these values:

        * ‘y’: Local postings and articles from peers are allowed.

        * ‘m’: The group is moderated and all postings must be approved.

        * ‘n’: No local postings are allowed, only articles from peers.

        * ‘j’: Articles from peers are filed in the junk group instead.

        * ‘x’: No local postings, and articles from peers are ignored.

        * ‘=foo.bar’: Articles are filed in the ‘foo.bar’ group instead.

     If `flag' has another value, then the status of the newsgroup
     should be considered unknown.

     This command can return very large results, especially if
     `group_pattern' is not specified.  It is best to cache the results
     offline unless you really need to refresh them.

     Changed in version 3.2: `group_pattern' was added.

 -- Method: NNTP.descriptions (grouppattern)

     Send a ‘LIST NEWSGROUPS’ command, where `grouppattern' is a wildmat
     string as specified in RFC 3977(2) (it’s essentially the same as
     DOS or UNIX shell wildcard strings).  Return a pair ‘(response,
     descriptions)’, where `descriptions' is a dictionary mapping group
     names to textual descriptions.

          >>> resp, descs = s.descriptions('gmane.comp.python.*') >>> len(descs) # doctest: +SKIP 295 >>> descs.popitem() # doctest: +SKIP ('gmane.comp.python.bio.general', 'BioPython discussion list (Moderated)')

 -- Method: NNTP.description (group)

     Get a description for a single group `group'.  If more than one
     group matches (if ‘group’ is a real wildmat string), return the
     first match.  If no group matches, return an empty string.

     This elides the response code from the server.  If the response
     code is needed, use *note descriptions(): 2cd3.

 -- Method: NNTP.group (name)

     Send a ‘GROUP’ command, where `name' is the group name.  The group
     is selected as the current group, if it exists.  Return a tuple
     ‘(response, count, first, last, name)’ where `count' is the
     (estimated) number of articles in the group, `first' is the first
     article number in the group, `last' is the last article number in
     the group, and `name' is the group name.

 -- Method: NNTP.over (message_spec, *, file=None)

     Send an ‘OVER’ command, or an ‘XOVER’ command on legacy servers.
     `message_spec' can be either a string representing a message id, or
     a ‘(first, last)’ tuple of numbers indicating a range of articles
     in the current group, or a ‘(first, None)’ tuple indicating a range
     of articles starting from `first' to the last article in the
     current group, or *note None: 157. to select the current article in
     the current group.

     Return a pair ‘(response, overviews)’.  `overviews' is a list of
     ‘(article_number, overview)’ tuples, one for each article selected
     by `message_spec'.  Each `overview' is a dictionary with the same
     number of items, but this number depends on the server.  These
     items are either message headers (the key is then the lower-cased
     header name) or metadata items (the key is then the metadata name
     prepended with ‘":"’).  The following items are guaranteed to be
     present by the NNTP specification:

        * the ‘subject’, ‘from’, ‘date’, ‘message-id’ and ‘references’
          headers

        * the ‘:bytes’ metadata: the number of bytes in the entire raw
          article (including headers and body)

        * the ‘:lines’ metadata: the number of lines in the article body

     The value of each item is either a string, or *note None: 157. if
     not present.

     It is advisable to use the *note decode_header(): 2cd7. function on
     header values when they may contain non-ASCII characters:

          >>> _, _, first, last, _ = s.group('gmane.comp.python.devel') >>> resp, overviews = s.over((last, last)) >>> art_num, over = overviews[0] >>> art_num 117216 >>> list(over.keys()) ['xref', 'from', ':lines', ':bytes', 'references', 'date', 'message-id', 'subject'] >>> over['from'] '=?UTF-8?B?Ik1hcnRpbiB2LiBMw7Z3aXMi?= <martin@v.loewis.de>' >>> nntplib.decode_header(over['from']) '"Martin v. Löwis" <martin@v.loewis.de>'

     New in version 3.2.

 -- Method: NNTP.help (*, file=None)

     Send a ‘HELP’ command.  Return a pair ‘(response, list)’ where
     `list' is a list of help strings.

 -- Method: NNTP.stat (message_spec=None)

     Send a ‘STAT’ command, where `message_spec' is either a message id
     (enclosed in ‘'<'’ and ‘'>'’) or an article number in the current
     group.  If `message_spec' is omitted or *note None: 157, the
     current article in the current group is considered.  Return a
     triple ‘(response, number, id)’ where `number' is the article
     number and `id' is the message id.

          >>> _, _, first, last, _ = s.group('gmane.comp.python.devel') >>> resp, number, message_id = s.stat(first) >>> number, message_id (9099, '<20030112190404.GE29873@epoch.metaslash.com>')

 -- Method: NNTP.next ()

     Send a ‘NEXT’ command.  Return as for *note stat(): 2cd9.

 -- Method: NNTP.last ()

     Send a ‘LAST’ command.  Return as for *note stat(): 2cd9.

 -- Method: NNTP.article (message_spec=None, *, file=None)

     Send an ‘ARTICLE’ command, where `message_spec' has the same
     meaning as for *note stat(): 2cd9.  Return a tuple ‘(response,
     info)’ where `info' is a *note namedtuple: 1b5. with three
     attributes `number', `message_id' and `lines' (in that order).
     `number' is the article number in the group (or 0 if the
     information is not available), `message_id' the message id as a
     string, and `lines' a list of lines (without terminating newlines)
     comprising the raw message including headers and body.

          >>> resp, info = s.article('<20030112190404.GE29873@epoch.metaslash.com>') >>> info.number 0 >>> info.message_id '<20030112190404.GE29873@epoch.metaslash.com>' >>> len(info.lines) 65 >>> info.lines[0] b'Path: main.gmane.org!not-for-mail' >>> info.lines[1] b'From: Neal Norwitz <neal@metaslash.com>' >>> info.lines[-3:] [b'There is a patch for 2.3 as well as 2.2.', b'', b'Neal']

 -- Method: NNTP.head (message_spec=None, *, file=None)

     Same as *note article(): 2cdc, but sends a ‘HEAD’ command.  The
     `lines' returned (or written to `file') will only contain the
     message headers, not the body.

 -- Method: NNTP.body (message_spec=None, *, file=None)

     Same as *note article(): 2cdc, but sends a ‘BODY’ command.  The
     `lines' returned (or written to `file') will only contain the
     message body, not the headers.

 -- Method: NNTP.post (data)

     Post an article using the ‘POST’ command.  The `data' argument is
     either a *note file object: b35. opened for binary reading, or any
     iterable of bytes objects (representing raw lines of the article to
     be posted).  It should represent a well-formed news article,
     including the required headers.  The *note post(): 2cdf. method
     automatically escapes lines beginning with ‘.’ and appends the
     termination line.

     If the method succeeds, the server’s response is returned.  If the
     server refuses posting, a *note NNTPReplyError: 2cc2. is raised.

 -- Method: NNTP.ihave (message_id, data)

     Send an ‘IHAVE’ command.  `message_id' is the id of the message to
     send to the server (enclosed in ‘'<'’ and ‘'>'’).  The `data'
     parameter and the return value are the same as for *note post():
     2cdf.

 -- Method: NNTP.date ()

     Return a pair ‘(response, date)’.  `date' is a *note datetime: 194.
     object containing the current date and time of the server.

 -- Method: NNTP.slave ()

     Send a ‘SLAVE’ command.  Return the server’s `response'.

 -- Method: NNTP.set_debuglevel (level)

     Set the instance’s debugging level.  This controls the amount of
     debugging output printed.  The default, ‘0’, produces no debugging
     output.  A value of ‘1’ produces a moderate amount of debugging
     output, generally a single line per request or response.  A value
     of ‘2’ or higher produces the maximum amount of debugging output,
     logging each line sent and received on the connection (including
     message text).

The following are optional NNTP extensions defined in RFC 2980(3).  Some
of them have been superseded by newer commands in RFC 3977(4).

 -- Method: NNTP.xhdr (hdr, str, *, file=None)

     Send an ‘XHDR’ command.  The `hdr' argument is a header keyword,
     e.g.  ‘'subject'’.  The `str' argument should have the form
     ‘'first-last'’ where `first' and `last' are the first and last
     article numbers to search.  Return a pair ‘(response, list)’, where
     `list' is a list of pairs ‘(id, text)’, where `id' is an article
     number (as a string) and `text' is the text of the requested header
     for that article.  If the `file' parameter is supplied, then the
     output of the ‘XHDR’ command is stored in a file.  If `file' is a
     string, then the method will open a file with that name, write to
     it then close it.  If `file' is a *note file object: b35, then it
     will start calling ‘write()’ on it to store the lines of the
     command output.  If `file' is supplied, then the returned `list' is
     an empty list.

 -- Method: NNTP.xover (start, end, *, file=None)

     Send an ‘XOVER’ command.  `start' and `end' are article numbers
     delimiting the range of articles to select.  The return value is
     the same of for *note over(): 2cd6.  It is recommended to use *note
     over(): 2cd6. instead, since it will automatically use the newer
     ‘OVER’ command if available.

 -- Method: NNTP.xpath (id)

     Return a pair ‘(resp, path)’, where `path' is the directory path to
     the article with message ID `id'.  Most of the time, this extension
     is not enabled by NNTP server administrators.

     Deprecated since version 3.3: The XPATH extension is not actively
     used.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3977.html

   (2) https://tools.ietf.org/html/rfc3977.html

   (3) https://tools.ietf.org/html/rfc2980.html

   (4) https://tools.ietf.org/html/rfc3977.html


File: python.info,  Node: Utility functions<2>,  Prev: NNTP Objects,  Up: nntplib — NNTP protocol client

5.22.16.4 Utility functions
...........................

The module also defines the following utility function:

 -- Function: nntplib.decode_header (header_str)

     Decode a header value, un-escaping any escaped non-ASCII
     characters.  `header_str' must be a *note str: 325. object.  The
     unescaped value is returned.  Using this function is recommended to
     display some headers in a human readable form:

          >>> decode_header("Some subject") 'Some subject' >>> decode_header("=?ISO-8859-15?Q?D=E9buter_en_Python?=") 'Débuter en Python' >>> decode_header("Re: =?UTF-8?B?cHJvYmzDqG1lIGRlIG1hdHJpY2U=?=") 'Re: problème de matrice'


File: python.info,  Node: smtplib — SMTP protocol client,  Next: smtpd — SMTP Server,  Prev: nntplib — NNTP protocol client,  Up: Internet Protocols and Support

5.22.17 ‘smtplib’ — SMTP protocol client
----------------------------------------

`Source code:' Lib/smtplib.py(1)

__________________________________________________________________

The *note smtplib: ed. module defines an SMTP client session object that
can be used to send mail to any Internet machine with an SMTP or ESMTP
listener daemon.  For details of SMTP and ESMTP operation, consult RFC
821(2) (Simple Mail Transfer Protocol) and RFC 1869(3) (SMTP Service
Extensions).

 -- Class: smtplib.SMTP (host='', port=0, local_hostname=None[,
          timeout], source_address=None)

     An *note SMTP: a76. instance encapsulates an SMTP connection.  It
     has methods that support a full repertoire of SMTP and ESMTP
     operations.  If the optional host and port parameters are given,
     the SMTP *note connect(): 2cea. method is called with those
     parameters during initialization.  If specified, `local_hostname'
     is used as the FQDN of the local host in the HELO/EHLO command.
     Otherwise, the local hostname is found using *note
     socket.getfqdn(): 25cf.  If the *note connect(): 2cea. call returns
     anything other than a success code, an *note SMTPConnectError:
     2ceb. is raised.  The optional `timeout' parameter specifies a
     timeout in seconds for blocking operations like the connection
     attempt (if not specified, the global default timeout setting will
     be used).  If the timeout expires, *note socket.timeout: c01. is
     raised.  The optional source_address parameter allows binding to
     some specific source address in a machine with multiple network
     interfaces, and/or to some specific source TCP port.  It takes a
     2-tuple (host, port), for the socket to bind to as its source
     address before connecting.  If omitted (or if host or port are ‘''’
     and/or 0 respectively) the OS default behavior will be used.

     For normal use, you should only require the initialization/connect,
     *note sendmail(): 738, and *note SMTP.quit(): 2cec. methods.  An
     example is included below.

     The *note SMTP: a76. class supports the *note with: 6dd. statement.
     When used like this, the SMTP ‘QUIT’ command is issued
     automatically when the ‘with’ statement exits.  E.g.:

          >>> from smtplib import SMTP >>> with SMTP("domain.org") as smtp: ...     smtp.noop() ... (250, b'Ok') >>>

     All commands will raise an *note auditing event: 1275.
     ‘smtplib.SMTP.send’ with arguments ‘self’ and ‘data’, where ‘data’
     is the bytes about to be sent to the remote host.

     Changed in version 3.3: Support for the *note with: 6dd. statement
     was added.

     Changed in version 3.3: source_address argument was added.

     New in version 3.5: The SMTPUTF8 extension ( RFC 6531(4)) is now
     supported.

 -- Class: smtplib.SMTP_SSL (host='', port=0, local_hostname=None,
          keyfile=None, certfile=None[, timeout], context=None,
          source_address=None)

     An *note SMTP_SSL: a77. instance behaves exactly the same as
     instances of *note SMTP: a76.  *note SMTP_SSL: a77. should be used
     for situations where SSL is required from the beginning of the
     connection and using ‘starttls()’ is not appropriate.  If `host' is
     not specified, the local host is used.  If `port' is zero, the
     standard SMTP-over-SSL port (465) is used.  The optional arguments
     `local_hostname', `timeout' and `source_address' have the same
     meaning as they do in the *note SMTP: a76. class.  `context', also
     optional, can contain a *note SSLContext: 3d9. and allows
     configuring various aspects of the secure connection.  Please read
     *note Security considerations: 24f0. for best practices.

     `keyfile' and `certfile' are a legacy alternative to `context', and
     can point to a PEM formatted private key and certificate chain file
     for the SSL connection.

     Changed in version 3.3: `context' was added.

     Changed in version 3.3: source_address argument was added.

     Changed in version 3.4: The class now supports hostname check with
     *note ssl.SSLContext.check_hostname: 2609. and `Server Name
     Indication' (see *note ssl.HAS_SNI: 261e.).

     Deprecated since version 3.6: `keyfile' and `certfile' are
     deprecated in favor of `context'.  Please use *note
     ssl.SSLContext.load_cert_chain(): a86. instead, or let *note
     ssl.create_default_context(): 8b5. select the system’s trusted CA
     certificates for you.

 -- Class: smtplib.LMTP (host='', port=LMTP_PORT, local_hostname=None,
          source_address=None)

     The LMTP protocol, which is very similar to ESMTP, is heavily based
     on the standard SMTP client.  It’s common to use Unix sockets for
     LMTP, so our ‘connect()’ method must support that as well as a
     regular host:port server.  The optional arguments local_hostname
     and source_address have the same meaning as they do in the *note
     SMTP: a76. class.  To specify a Unix socket, you must use an
     absolute path for `host', starting with a ‘/’.

     Authentication is supported, using the regular SMTP mechanism.
     When using a Unix socket, LMTP generally don’t support or require
     any authentication, but your mileage might vary.

A nice selection of exceptions is defined as well:

 -- Exception: smtplib.SMTPException

     Subclass of *note OSError: 1d1. that is the base exception class
     for all the other exceptions provided by this module.

     Changed in version 3.4: SMTPException became subclass of *note
     OSError: 1d1.

 -- Exception: smtplib.SMTPServerDisconnected

     This exception is raised when the server unexpectedly disconnects,
     or when an attempt is made to use the *note SMTP: a76. instance
     before connecting it to a server.

 -- Exception: smtplib.SMTPResponseException

     Base class for all exceptions that include an SMTP error code.
     These exceptions are generated in some instances when the SMTP
     server returns an error code.  The error code is stored in the
     ‘smtp_code’ attribute of the error, and the ‘smtp_error’ attribute
     is set to the error message.

 -- Exception: smtplib.SMTPSenderRefused

     Sender address refused.  In addition to the attributes set by on
     all *note SMTPResponseException: 2cee. exceptions, this sets
     ‘sender’ to the string that the SMTP server refused.

 -- Exception: smtplib.SMTPRecipientsRefused

     All recipient addresses refused.  The errors for each recipient are
     accessible through the attribute ‘recipients’, which is a
     dictionary of exactly the same sort as *note SMTP.sendmail(): 738.
     returns.

 -- Exception: smtplib.SMTPDataError

     The SMTP server refused to accept the message data.

 -- Exception: smtplib.SMTPConnectError

     Error occurred during establishment of a connection with the
     server.

 -- Exception: smtplib.SMTPHeloError

     The server refused our ‘HELO’ message.

 -- Exception: smtplib.SMTPNotSupportedError

     The command or option attempted is not supported by the server.

     New in version 3.5.

 -- Exception: smtplib.SMTPAuthenticationError

     SMTP authentication went wrong.  Most probably the server didn’t
     accept the username/password combination provided.

See also
........

RFC 821(5) - Simple Mail Transfer Protocol

     Protocol definition for SMTP. This document covers the model,
     operating procedure, and protocol details for SMTP.

RFC 1869(6) - SMTP Service Extensions

     Definition of the ESMTP extensions for SMTP. This describes a
     framework for extending SMTP with new commands, supporting dynamic
     discovery of the commands provided by the server, and defines a few
     additional commands.

* Menu:

* SMTP Objects::
* SMTP Example::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/smtplib.py

   (2) https://tools.ietf.org/html/rfc821.html

   (3) https://tools.ietf.org/html/rfc1869.html

   (4) https://tools.ietf.org/html/rfc6531.html

   (5) https://tools.ietf.org/html/rfc821.html

   (6) https://tools.ietf.org/html/rfc1869.html


File: python.info,  Node: SMTP Objects,  Next: SMTP Example,  Up: smtplib — SMTP protocol client

5.22.17.1 SMTP Objects
......................

An *note SMTP: a76. instance has the following methods:

 -- Method: SMTP.set_debuglevel (level)

     Set the debug output level.  A value of 1 or ‘True’ for `level'
     results in debug messages for connection and for all messages sent
     to and received from the server.  A value of 2 for `level' results
     in these messages being timestamped.

     Changed in version 3.5: Added debuglevel 2.

 -- Method: SMTP.docmd (cmd, args='')

     Send a command `cmd' to the server.  The optional argument `args'
     is simply concatenated to the command, separated by a space.

     This returns a 2-tuple composed of a numeric response code and the
     actual response line (multiline responses are joined into one long
     line.)

     In normal operation it should not be necessary to call this method
     explicitly.  It is used to implement other methods and may be
     useful for testing private extensions.

     If the connection to the server is lost while waiting for the
     reply, *note SMTPServerDisconnected: 2ced. will be raised.

 -- Method: SMTP.connect (host='localhost', port=0)

     Connect to a host on a given port.  The defaults are to connect to
     the local host at the standard SMTP port (25).  If the hostname
     ends with a colon (‘':'’) followed by a number, that suffix will be
     stripped off and the number interpreted as the port number to use.
     This method is automatically invoked by the constructor if a host
     is specified during instantiation.  Returns a 2-tuple of the
     response code and message sent by the server in its connection
     response.

     Raises an *note auditing event: 1275. ‘smtplib.connect’ with
     arguments ‘self’, ‘host’, ‘port’.

 -- Method: SMTP.helo (name='')

     Identify yourself to the SMTP server using ‘HELO’.  The hostname
     argument defaults to the fully qualified domain name of the local
     host.  The message returned by the server is stored as the
     ‘helo_resp’ attribute of the object.

     In normal operation it should not be necessary to call this method
     explicitly.  It will be implicitly called by the *note sendmail():
     738. when necessary.

 -- Method: SMTP.ehlo (name='')

     Identify yourself to an ESMTP server using ‘EHLO’.  The hostname
     argument defaults to the fully qualified domain name of the local
     host.  Examine the response for ESMTP option and store them for use
     by *note has_extn(): 2cf9.  Also sets several informational
     attributes: the message returned by the server is stored as the
     ‘ehlo_resp’ attribute, ‘does_esmtp’ is set to true or false
     depending on whether the server supports ESMTP, and
     ‘esmtp_features’ will be a dictionary containing the names of the
     SMTP service extensions this server supports, and their parameters
     (if any).

     Unless you wish to use *note has_extn(): 2cf9. before sending mail,
     it should not be necessary to call this method explicitly.  It will
     be implicitly called by *note sendmail(): 738. when necessary.

 -- Method: SMTP.ehlo_or_helo_if_needed ()

     This method calls *note ehlo(): 2cf8. and/or *note helo(): 2cf7. if
     there has been no previous ‘EHLO’ or ‘HELO’ command this session.
     It tries ESMTP ‘EHLO’ first.

     *note SMTPHeloError: 2cf2.

          The server didn’t reply properly to the ‘HELO’ greeting.

 -- Method: SMTP.has_extn (name)

     Return *note True: 48f. if `name' is in the set of SMTP service
     extensions returned by the server, *note False: 37d. otherwise.
     Case is ignored.

 -- Method: SMTP.verify (address)

     Check the validity of an address on this server using SMTP ‘VRFY’.
     Returns a tuple consisting of code 250 and a full RFC 822(1)
     address (including human name) if the user address is valid.
     Otherwise returns an SMTP error code of 400 or greater and an error
     string.

          Note: Many sites disable SMTP ‘VRFY’ in order to foil
          spammers.

 -- Method: SMTP.login (user, password, *, initial_response_ok=True)

     Log in on an SMTP server that requires authentication.  The
     arguments are the username and the password to authenticate with.
     If there has been no previous ‘EHLO’ or ‘HELO’ command this
     session, this method tries ESMTP ‘EHLO’ first.  This method will
     return normally if the authentication was successful, or may raise
     the following exceptions:

     *note SMTPHeloError: 2cf2.

          The server didn’t reply properly to the ‘HELO’ greeting.

     *note SMTPAuthenticationError: 2cf3.

          The server didn’t accept the username/password combination.

     *note SMTPNotSupportedError: e9e.

          The ‘AUTH’ command is not supported by the server.

     *note SMTPException: 8ab.

          No suitable authentication method was found.

     Each of the authentication methods supported by *note smtplib: ed.
     are tried in turn if they are advertised as supported by the
     server.  See *note auth(): 736. for a list of supported
     authentication methods.  `initial_response_ok' is passed through to
     *note auth(): 736.

     Optional keyword argument `initial_response_ok' specifies whether,
     for authentication methods that support it, an “initial response”
     as specified in RFC 4954(2) can be sent along with the ‘AUTH’
     command, rather than requiring a challenge/response.

     Changed in version 3.5: *note SMTPNotSupportedError: e9e. may be
     raised, and the `initial_response_ok' parameter was added.

 -- Method: SMTP.auth (mechanism, authobject, *,
          initial_response_ok=True)

     Issue an ‘SMTP’ ‘AUTH’ command for the specified authentication
     `mechanism', and handle the challenge response via `authobject'.

     `mechanism' specifies which authentication mechanism is to be used
     as argument to the ‘AUTH’ command; the valid values are those
     listed in the ‘auth’ element of ‘esmtp_features’.

     `authobject' must be a callable object taking an optional single
     argument:

          data = authobject(challenge=None)

     If optional keyword argument `initial_response_ok' is true,
     ‘authobject()’ will be called first with no argument.  It can
     return the RFC 4954(3) “initial response” ASCII ‘str’ which will be
     encoded and sent with the ‘AUTH’ command as below.  If the
     ‘authobject()’ does not support an initial response (e.g.  because
     it requires a challenge), it should return ‘None’ when called with
     ‘challenge=None’.  If `initial_response_ok' is false, then
     ‘authobject()’ will not be called first with ‘None’.

     If the initial response check returns ‘None’, or if
     `initial_response_ok' is false, ‘authobject()’ will be called to
     process the server’s challenge response; the `challenge' argument
     it is passed will be a ‘bytes’.  It should return ASCII ‘str’
     `data' that will be base64 encoded and sent to the server.

     The ‘SMTP’ class provides ‘authobjects’ for the ‘CRAM-MD5’,
     ‘PLAIN’, and ‘LOGIN’ mechanisms; they are named
     ‘SMTP.auth_cram_md5’, ‘SMTP.auth_plain’, and ‘SMTP.auth_login’
     respectively.  They all require that the ‘user’ and ‘password’
     properties of the ‘SMTP’ instance are set to appropriate values.

     User code does not normally need to call ‘auth’ directly, but can
     instead call the *note login(): 2cfc. method, which will try each
     of the above mechanisms in turn, in the order listed.  ‘auth’ is
     exposed to facilitate the implementation of authentication methods
     not (or not yet) supported directly by *note smtplib: ed.

     New in version 3.5.

 -- Method: SMTP.starttls (keyfile=None, certfile=None, context=None)

     Put the SMTP connection in TLS (Transport Layer Security) mode.
     All SMTP commands that follow will be encrypted.  You should then
     call *note ehlo(): 2cf8. again.

     If `keyfile' and `certfile' are provided, they are used to create
     an *note ssl.SSLContext: 3d9.

     Optional `context' parameter is an *note ssl.SSLContext: 3d9.
     object; This is an alternative to using a keyfile and a certfile
     and if specified both `keyfile' and `certfile' should be ‘None’.

     If there has been no previous ‘EHLO’ or ‘HELO’ command this
     session, this method tries ESMTP ‘EHLO’ first.

     Deprecated since version 3.6: `keyfile' and `certfile' are
     deprecated in favor of `context'.  Please use *note
     ssl.SSLContext.load_cert_chain(): a86. instead, or let *note
     ssl.create_default_context(): 8b5. select the system’s trusted CA
     certificates for you.

     *note SMTPHeloError: 2cf2.

          The server didn’t reply properly to the ‘HELO’ greeting.

     *note SMTPNotSupportedError: e9e.

          The server does not support the STARTTLS extension.

     *note RuntimeError: 2b8.

          SSL/TLS support is not available to your Python interpreter.

     Changed in version 3.3: `context' was added.

     Changed in version 3.4: The method now supports hostname check with
     ‘SSLContext.check_hostname’ and `Server Name Indicator' (see *note
     HAS_SNI: 261e.).

     Changed in version 3.5: The error raised for lack of STARTTLS
     support is now the *note SMTPNotSupportedError: e9e. subclass
     instead of the base *note SMTPException: 8ab.

 -- Method: SMTP.sendmail (from_addr, to_addrs, msg, mail_options=(),
          rcpt_options=())

     Send mail.  The required arguments are an RFC 822(4) from-address
     string, a list of RFC 822(5) to-address strings (a bare string will
     be treated as a list with 1 address), and a message string.  The
     caller may pass a list of ESMTP options (such as ‘8bitmime’) to be
     used in ‘MAIL FROM’ commands as `mail_options'.  ESMTP options
     (such as ‘DSN’ commands) that should be used with all ‘RCPT’
     commands can be passed as `rcpt_options'.  (If you need to use
     different ESMTP options to different recipients you have to use the
     low-level methods such as ‘mail()’, ‘rcpt()’ and ‘data()’ to send
     the message.)

          Note: The `from_addr' and `to_addrs' parameters are used to
          construct the message envelope used by the transport agents.
          ‘sendmail’ does not modify the message headers in any way.

     `msg' may be a string containing characters in the ASCII range, or
     a byte string.  A string is encoded to bytes using the ascii codec,
     and lone ‘\r’ and ‘\n’ characters are converted to ‘\r\n’
     characters.  A byte string is not modified.

     If there has been no previous ‘EHLO’ or ‘HELO’ command this
     session, this method tries ESMTP ‘EHLO’ first.  If the server does
     ESMTP, message size and each of the specified options will be
     passed to it (if the option is in the feature set the server
     advertises).  If ‘EHLO’ fails, ‘HELO’ will be tried and ESMTP
     options suppressed.

     This method will return normally if the mail is accepted for at
     least one recipient.  Otherwise it will raise an exception.  That
     is, if this method does not raise an exception, then someone should
     get your mail.  If this method does not raise an exception, it
     returns a dictionary, with one entry for each recipient that was
     refused.  Each entry contains a tuple of the SMTP error code and
     the accompanying error message sent by the server.

     If ‘SMTPUTF8’ is included in `mail_options', and the server
     supports it, `from_addr' and `to_addrs' may contain non-ASCII
     characters.

     This method may raise the following exceptions:

     *note SMTPRecipientsRefused: 2cf0.

          All recipients were refused.  Nobody got the mail.  The
          ‘recipients’ attribute of the exception object is a dictionary
          with information about the refused recipients (like the one
          returned when at least one recipient was accepted).

     *note SMTPHeloError: 2cf2.

          The server didn’t reply properly to the ‘HELO’ greeting.

     *note SMTPSenderRefused: 2cef.

          The server didn’t accept the `from_addr'.

     *note SMTPDataError: 2cf1.

          The server replied with an unexpected error code (other than a
          refusal of a recipient).

     *note SMTPNotSupportedError: e9e.

          ‘SMTPUTF8’ was given in the `mail_options' but is not
          supported by the server.

     Unless otherwise noted, the connection will be open even after an
     exception is raised.

     Changed in version 3.2: `msg' may be a byte string.

     Changed in version 3.5: ‘SMTPUTF8’ support added, and *note
     SMTPNotSupportedError: e9e. may be raised if ‘SMTPUTF8’ is
     specified but the server does not support it.

 -- Method: SMTP.send_message (msg, from_addr=None, to_addrs=None,
          mail_options=(), rcpt_options=())

     This is a convenience method for calling *note sendmail(): 738.
     with the message represented by an *note email.message.Message:
     536. object.  The arguments have the same meaning as for *note
     sendmail(): 738, except that `msg' is a ‘Message’ object.

     If `from_addr' is ‘None’ or `to_addrs' is ‘None’, ‘send_message’
     fills those arguments with addresses extracted from the headers of
     `msg' as specified in RFC 5322(6): `from_addr' is set to the
     ‘Sender’ field if it is present, and otherwise to the ‘From’ field.
     `to_addrs' combines the values (if any) of the ‘To’, ‘Cc’, and
     ‘Bcc’ fields from `msg'.  If exactly one set of ‘Resent-*’ headers
     appear in the message, the regular headers are ignored and the
     ‘Resent-*’ headers are used instead.  If the message contains more
     than one set of ‘Resent-*’ headers, a *note ValueError: 1f9. is
     raised, since there is no way to unambiguously detect the most
     recent set of ‘Resent-’ headers.

     ‘send_message’ serializes `msg' using *note BytesGenerator: b40.
     with ‘\r\n’ as the `linesep', and calls *note sendmail(): 738. to
     transmit the resulting message.  Regardless of the values of
     `from_addr' and `to_addrs', ‘send_message’ does not transmit any
     ‘Bcc’ or ‘Resent-Bcc’ headers that may appear in `msg'.  If any of
     the addresses in `from_addr' and `to_addrs' contain non-ASCII
     characters and the server does not advertise ‘SMTPUTF8’ support, an
     ‘SMTPNotSupported’ error is raised.  Otherwise the ‘Message’ is
     serialized with a clone of its *note policy: 75. with the *note
     utf8: 6c6. attribute set to ‘True’, and ‘SMTPUTF8’ and
     ‘BODY=8BITMIME’ are added to `mail_options'.

     New in version 3.2.

     New in version 3.5: Support for internationalized addresses
     (‘SMTPUTF8’).

 -- Method: SMTP.quit ()

     Terminate the SMTP session and close the connection.  Return the
     result of the SMTP ‘QUIT’ command.

Low-level methods corresponding to the standard SMTP/ESMTP commands
‘HELP’, ‘RSET’, ‘NOOP’, ‘MAIL’, ‘RCPT’, and ‘DATA’ are also supported.
Normally these do not need to be called directly, so they are not
documented here.  For details, consult the module code.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc822.html

   (2) https://tools.ietf.org/html/rfc4954.html

   (3) https://tools.ietf.org/html/rfc4954.html

   (4) https://tools.ietf.org/html/rfc822.html

   (5) https://tools.ietf.org/html/rfc822.html

   (6) https://tools.ietf.org/html/rfc5322.html


File: python.info,  Node: SMTP Example,  Prev: SMTP Objects,  Up: smtplib — SMTP protocol client

5.22.17.2 SMTP Example
......................

This example prompts the user for addresses needed in the message
envelope (‘To’ and ‘From’ addresses), and the message to be delivered.
Note that the headers to be included with the message must be included
in the message as entered; this example doesn’t do any processing of the
RFC 822(1) headers.  In particular, the ‘To’ and ‘From’ addresses must
be included in the message headers explicitly.

     import smtplib  def prompt(prompt):     return input(prompt).strip()  fromaddr = prompt("From: ") toaddrs  = prompt("To: ").split() print("Enter message, end with ^D (Unix) or ^Z (Windows):")  # Add the From: and To: headers at the start! msg = ("From: %s\r\nTo: %s\r\n\r\n"        % (fromaddr, ", ".join(toaddrs))) while True:     try:         line = input()     except EOFError:         break     if not line:         break     msg = msg + line  print("Message length is", len(msg))  server = smtplib.SMTP('localhost') server.set_debuglevel(1) server.sendmail(fromaddr, toaddrs, msg) server.quit()

     Note: In general, you will want to use the *note email: 69.
     package’s features to construct an email message, which you can
     then send via *note send_message(): 739.; see *note email;
     Examples: 839.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc822.html


File: python.info,  Node: smtpd — SMTP Server,  Next: telnetlib — Telnet client,  Prev: smtplib — SMTP protocol client,  Up: Internet Protocols and Support

5.22.18 ‘smtpd’ — SMTP Server
-----------------------------

`Source code:' Lib/smtpd.py(1)

__________________________________________________________________

This module offers several classes to implement SMTP (email) servers.

See also
........

The aiosmtpd(2) package is a recommended replacement for this module.
It is based on *note asyncio: a. and provides a more straightforward
API. *note smtpd: ec. should be considered deprecated.

Several server implementations are present; one is a generic do-nothing
implementation, which can be overridden, while the other two offer
specific mail-sending strategies.

Additionally the SMTPChannel may be extended to implement very specific
interaction behaviour with SMTP clients.

The code supports RFC 5321(3), plus the RFC 1870(4) SIZE and RFC 6531(5)
SMTPUTF8 extensions.

* Menu:

* SMTPServer Objects::
* DebuggingServer Objects::
* PureProxy Objects::
* MailmanProxy Objects::
* SMTPChannel Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/smtpd.py

   (2) http://aiosmtpd.readthedocs.io/

   (3) https://tools.ietf.org/html/rfc5321.html

   (4) https://tools.ietf.org/html/rfc1870.html

   (5) https://tools.ietf.org/html/rfc6531.html


File: python.info,  Node: SMTPServer Objects,  Next: DebuggingServer Objects,  Up: smtpd — SMTP Server

5.22.18.1 SMTPServer Objects
............................

 -- Class: smtpd.SMTPServer (localaddr, remoteaddr,
          data_size_limit=33554432, map=None, enable_SMTPUTF8=False,
          decode_data=False)

     Create a new *note SMTPServer: 5f7. object, which binds to local
     address `localaddr'.  It will treat `remoteaddr' as an upstream
     SMTP relayer.  Both `localaddr' and `remoteaddr' should be a *note
     (host, port): 25a8. tuple.  The object inherits from *note
     asyncore.dispatcher: bb6, and so will insert itself into *note
     asyncore: b.’s event loop on instantiation.

     `data_size_limit' specifies the maximum number of bytes that will
     be accepted in a ‘DATA’ command.  A value of ‘None’ or ‘0’ means no
     limit.

     `map' is the socket map to use for connections (an initially empty
     dictionary is a suitable value).  If not specified the *note
     asyncore: b. global socket map is used.

     `enable_SMTPUTF8' determines whether the ‘SMTPUTF8’ extension (as
     defined in RFC 6531(1)) should be enabled.  The default is ‘False’.
     When ‘True’, ‘SMTPUTF8’ is accepted as a parameter to the ‘MAIL’
     command and when present is passed to *note process_message(): 5f8.
     in the ‘kwargs['mail_options']’ list.  `decode_data' and
     `enable_SMTPUTF8' cannot be set to ‘True’ at the same time.

     `decode_data' specifies whether the data portion of the SMTP
     transaction should be decoded using UTF-8.  When `decode_data' is
     ‘False’ (the default), the server advertises the ‘8BITMIME’
     extension ( RFC 6152(2)), accepts the ‘BODY=8BITMIME’ parameter to
     the ‘MAIL’ command, and when present passes it to *note
     process_message(): 5f8. in the ‘kwargs['mail_options']’ list.
     `decode_data' and `enable_SMTPUTF8' cannot be set to ‘True’ at the
     same time.

      -- Method: process_message (peer, mailfrom, rcpttos, data,
               **kwargs)

          Raise a *note NotImplementedError: 603. exception.  Override
          this in subclasses to do something useful with this message.
          Whatever was passed in the constructor as `remoteaddr' will be
          available as the ‘_remoteaddr’ attribute.  `peer' is the
          remote host’s address, `mailfrom' is the envelope originator,
          `rcpttos' are the envelope recipients and `data' is a string
          containing the contents of the e-mail (which should be in RFC
          5321(3) format).

          If the `decode_data' constructor keyword is set to ‘True’, the
          `data' argument will be a unicode string.  If it is set to
          ‘False’, it will be a bytes object.

          `kwargs' is a dictionary containing additional information.
          It is empty if ‘decode_data=True’ was given as an init
          argument, otherwise it contains the following keys:

               `mail_options':

                    a list of all received parameters to the ‘MAIL’
                    command (the elements are uppercase strings;
                    example: ‘['BODY=8BITMIME', 'SMTPUTF8']’).

               `rcpt_options':

                    same as `mail_options' but for the ‘RCPT’ command.
                    Currently no ‘RCPT TO’ options are supported, so for
                    now this will always be an empty list.

          Implementations of ‘process_message’ should use the ‘**kwargs’
          signature to accept arbitrary keyword arguments, since future
          feature enhancements may add keys to the kwargs dictionary.

          Return ‘None’ to request a normal ‘250 Ok’ response; otherwise
          return the desired response string in RFC 5321(4) format.

      -- Attribute: channel_class

          Override this in subclasses to use a custom *note SMTPChannel:
          5f6. for managing SMTP clients.

     New in version 3.4: The `map' constructor argument.

     Changed in version 3.5: `localaddr' and `remoteaddr' may now
     contain IPv6 addresses.

     New in version 3.5: The `decode_data' and `enable_SMTPUTF8'
     constructor parameters, and the `kwargs' parameter to *note
     process_message(): 5f8. when `decode_data' is ‘False’.

     Changed in version 3.6: `decode_data' is now ‘False’ by default.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc6531.html

   (2) https://tools.ietf.org/html/rfc6152.html

   (3) https://tools.ietf.org/html/rfc5321.html

   (4) https://tools.ietf.org/html/rfc5321.html


File: python.info,  Node: DebuggingServer Objects,  Next: PureProxy Objects,  Prev: SMTPServer Objects,  Up: smtpd — SMTP Server

5.22.18.2 DebuggingServer Objects
.................................

 -- Class: smtpd.DebuggingServer (localaddr, remoteaddr)

     Create a new debugging server.  Arguments are as per *note
     SMTPServer: 5f7.  Messages will be discarded, and printed on
     stdout.


File: python.info,  Node: PureProxy Objects,  Next: MailmanProxy Objects,  Prev: DebuggingServer Objects,  Up: smtpd — SMTP Server

5.22.18.3 PureProxy Objects
...........................

 -- Class: smtpd.PureProxy (localaddr, remoteaddr)

     Create a new pure proxy server.  Arguments are as per *note
     SMTPServer: 5f7.  Everything will be relayed to `remoteaddr'.  Note
     that running this has a good chance to make you into an open relay,
     so please be careful.


File: python.info,  Node: MailmanProxy Objects,  Next: SMTPChannel Objects,  Prev: PureProxy Objects,  Up: smtpd — SMTP Server

5.22.18.4 MailmanProxy Objects
..............................

 -- Class: smtpd.MailmanProxy (localaddr, remoteaddr)

     Create a new pure proxy server.  Arguments are as per *note
     SMTPServer: 5f7.  Everything will be relayed to `remoteaddr',
     unless local mailman configurations knows about an address, in
     which case it will be handled via mailman.  Note that running this
     has a good chance to make you into an open relay, so please be
     careful.


File: python.info,  Node: SMTPChannel Objects,  Prev: MailmanProxy Objects,  Up: smtpd — SMTP Server

5.22.18.5 SMTPChannel Objects
.............................

 -- Class: smtpd.SMTPChannel (server, conn, addr,
          data_size_limit=33554432, map=None, enable_SMTPUTF8=False,
          decode_data=False)

     Create a new *note SMTPChannel: 5f6. object which manages the
     communication between the server and a single SMTP client.

     `conn' and `addr' are as per the instance variables described
     below.

     `data_size_limit' specifies the maximum number of bytes that will
     be accepted in a ‘DATA’ command.  A value of ‘None’ or ‘0’ means no
     limit.

     `enable_SMTPUTF8' determines whether the ‘SMTPUTF8’ extension (as
     defined in RFC 6531(1)) should be enabled.  The default is ‘False’.
     `decode_data' and `enable_SMTPUTF8' cannot be set to ‘True’ at the
     same time.

     A dictionary can be specified in `map' to avoid using a global
     socket map.

     `decode_data' specifies whether the data portion of the SMTP
     transaction should be decoded using UTF-8.  The default is ‘False’.
     `decode_data' and `enable_SMTPUTF8' cannot be set to ‘True’ at the
     same time.

     To use a custom SMTPChannel implementation you need to override the
     *note SMTPServer.channel_class: 2d02. of your *note SMTPServer:
     5f7.

     Changed in version 3.5: The `decode_data' and `enable_SMTPUTF8'
     parameters were added.

     Changed in version 3.6: `decode_data' is now ‘False’ by default.

     The *note SMTPChannel: 5f6. has the following instance variables:

      -- Attribute: smtp_server

          Holds the *note SMTPServer: 5f7. that spawned this channel.

      -- Attribute: conn

          Holds the socket object connecting to the client.

      -- Attribute: addr

          Holds the address of the client, the second value returned by
          *note socket.accept: 669.

      -- Attribute: received_lines

          Holds a list of the line strings (decoded using UTF-8)
          received from the client.  The lines have their ‘"\r\n"’ line
          ending translated to ‘"\n"’.

      -- Attribute: smtp_state

          Holds the current state of the channel.  This will be either
          ‘COMMAND’ initially and then ‘DATA’ after the client sends a
          “DATA” line.

      -- Attribute: seen_greeting

          Holds a string containing the greeting sent by the client in
          its “HELO”.

      -- Attribute: mailfrom

          Holds a string containing the address identified in the “MAIL
          FROM:” line from the client.

      -- Attribute: rcpttos

          Holds a list of strings containing the addresses identified in
          the “RCPT TO:” lines from the client.

      -- Attribute: received_data

          Holds a string containing all of the data sent by the client
          during the DATA state, up to but not including the terminating
          ‘"\r\n.\r\n"’.

      -- Attribute: fqdn

          Holds the fully-qualified domain name of the server as
          returned by *note socket.getfqdn(): 25cf.

      -- Attribute: peer

          Holds the name of the client peer as returned by
          ‘conn.getpeername()’ where ‘conn’ is *note conn: 2d0b.

     The *note SMTPChannel: 5f6. operates by invoking methods named
     ‘smtp_<command>’ upon reception of a command line from the client.
     Built into the base *note SMTPChannel: 5f6. class are methods for
     handling the following commands (and responding to them
     appropriately):

     Command      Action taken
                  
     -------------------------------------------------------------------------------------
                  
     HELO         Accepts the greeting from the client and stores it in
                  *note seen_greeting: 2d0f.  Sets server to base command mode.
                  
                  
     EHLO         Accepts the greeting from the client and stores it in
                  *note seen_greeting: 2d0f.  Sets server to extended command mode.
                  
                  
     NOOP         Takes no action.
                  
                  
     QUIT         Closes the connection cleanly.
                  
                  
     MAIL         Accepts the “MAIL FROM:” syntax and stores the supplied address as
                  *note mailfrom: 2d10.  In extended command mode, accepts the RFC
                  1870(2) SIZE attribute and responds appropriately based on the value
                  of `data_size_limit'.
                  
                  
     RCPT         Accepts the “RCPT TO:” syntax and stores the supplied addresses in
                  the *note rcpttos: 2d11. list.
                  
                  
     RSET         Resets the *note mailfrom: 2d10, *note rcpttos: 2d11, and
                  *note received_data: 2d12, but not the greeting.
                  
                  
     DATA         Sets the internal state to ‘DATA’ and stores remaining lines from the
                  client in *note received_data: 2d12. until the terminator
                  ‘"\r\n.\r\n"’ is received.
                  
                  
     HELP         Returns minimal information on command syntax
                  
                  
     VRFY         Returns code 252 (the server doesn’t know if the address is valid)
                  
                  
     EXPN         Reports that the command is not implemented.
                  

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc6531.html

   (2) https://tools.ietf.org/html/rfc1870.html


File: python.info,  Node: telnetlib — Telnet client,  Next: uuid — UUID objects according to RFC 4122,  Prev: smtpd — SMTP Server,  Up: Internet Protocols and Support

5.22.19 ‘telnetlib’ — Telnet client
-----------------------------------

`Source code:' Lib/telnetlib.py(1)

__________________________________________________________________

The *note telnetlib: 102. module provides a *note Telnet: 58c. class
that implements the Telnet protocol.  See RFC 854(2) for details about
the protocol.  In addition, it provides symbolic constants for the
protocol characters (see below), and for the telnet options.  The
symbolic names of the telnet options follow the definitions in
‘arpa/telnet.h’, with the leading ‘TELOPT_’ removed.  For symbolic names
of options which are traditionally not included in ‘arpa/telnet.h’, see
the module source itself.

The symbolic constants for the telnet commands are: IAC, DONT, DO, WONT,
WILL, SE (Subnegotiation End), NOP (No Operation), DM (Data Mark), BRK
(Break), IP (Interrupt process), AO (Abort output), AYT (Are You There),
EC (Erase Character), EL (Erase Line), GA (Go Ahead), SB (Subnegotiation
Begin).

 -- Class: telnetlib.Telnet (host=None, port=0[, timeout])

     *note Telnet: 58c. represents a connection to a Telnet server.  The
     instance is initially not connected by default; the *note open():
     2d17. method must be used to establish a connection.
     Alternatively, the host name and optional port number can be passed
     to the constructor too, in which case the connection to the server
     will be established before the constructor returns.  The optional
     `timeout' parameter specifies a timeout in seconds for blocking
     operations like the connection attempt (if not specified, the
     global default timeout setting will be used).

     Do not reopen an already connected instance.

     This class has many ‘read_*()’ methods.  Note that some of them
     raise *note EOFError: c5f. when the end of the connection is read,
     because they can return an empty string for other reasons.  See the
     individual descriptions below.

     A *note Telnet: 58c. object is a context manager and can be used in
     a *note with: 6dd. statement.  When the ‘with’ block ends, the
     *note close(): 2d18. method is called:

          >>> from telnetlib import Telnet >>> with Telnet('localhost', 23) as tn: ...     tn.interact() ...

     Changed in version 3.6: Context manager support added

See also
........

RFC 854(3) - Telnet Protocol Specification

     Definition of the Telnet protocol.

* Menu:

* Telnet Objects::
* Telnet Example::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/telnetlib.py

   (2) https://tools.ietf.org/html/rfc854.html

   (3) https://tools.ietf.org/html/rfc854.html


File: python.info,  Node: Telnet Objects,  Next: Telnet Example,  Up: telnetlib — Telnet client

5.22.19.1 Telnet Objects
........................

*note Telnet: 58c. instances have the following methods:

 -- Method: Telnet.read_until (expected, timeout=None)

     Read until a given byte string, `expected', is encountered or until
     `timeout' seconds have passed.

     When no match is found, return whatever is available instead,
     possibly empty bytes.  Raise *note EOFError: c5f. if the connection
     is closed and no cooked data is available.

 -- Method: Telnet.read_all ()

     Read all data until EOF as bytes; block until connection closed.

 -- Method: Telnet.read_some ()

     Read at least one byte of cooked data unless EOF is hit.  Return
     ‘b''’ if EOF is hit.  Block if no data is immediately available.

 -- Method: Telnet.read_very_eager ()

     Read everything that can be without blocking in I/O (eager).

     Raise *note EOFError: c5f. if connection closed and no cooked data
     available.  Return ‘b''’ if no cooked data available otherwise.  Do
     not block unless in the midst of an IAC sequence.

 -- Method: Telnet.read_eager ()

     Read readily available data.

     Raise *note EOFError: c5f. if connection closed and no cooked data
     available.  Return ‘b''’ if no cooked data available otherwise.  Do
     not block unless in the midst of an IAC sequence.

 -- Method: Telnet.read_lazy ()

     Process and return data already in the queues (lazy).

     Raise *note EOFError: c5f. if connection closed and no data
     available.  Return ‘b''’ if no cooked data available otherwise.  Do
     not block unless in the midst of an IAC sequence.

 -- Method: Telnet.read_very_lazy ()

     Return any data available in the cooked queue (very lazy).

     Raise *note EOFError: c5f. if connection closed and no data
     available.  Return ‘b''’ if no cooked data available otherwise.
     This method never blocks.

 -- Method: Telnet.read_sb_data ()

     Return the data collected between a SB/SE pair (suboption
     begin/end).  The callback should access these data when it was
     invoked with a ‘SE’ command.  This method never blocks.

 -- Method: Telnet.open (host, port=0[, timeout])

     Connect to a host.  The optional second argument is the port
     number, which defaults to the standard Telnet port (23).  The
     optional `timeout' parameter specifies a timeout in seconds for
     blocking operations like the connection attempt (if not specified,
     the global default timeout setting will be used).

     Do not try to reopen an already connected instance.

     Raises an *note auditing event: 1275. ‘telnetlib.Telnet.open’ with
     arguments ‘self’, ‘host’, ‘port’.

 -- Method: Telnet.msg (msg, *args)

     Print a debug message when the debug level is ‘>’ 0.  If extra
     arguments are present, they are substituted in the message using
     the standard string formatting operator.

 -- Method: Telnet.set_debuglevel (debuglevel)

     Set the debug level.  The higher the value of `debuglevel', the
     more debug output you get (on ‘sys.stdout’).

 -- Method: Telnet.close ()

     Close the connection.

 -- Method: Telnet.get_socket ()

     Return the socket object used internally.

 -- Method: Telnet.fileno ()

     Return the file descriptor of the socket object used internally.

 -- Method: Telnet.write (buffer)

     Write a byte string to the socket, doubling any IAC characters.
     This can block if the connection is blocked.  May raise *note
     OSError: 1d1. if the connection is closed.

     Raises an *note auditing event: 1275. ‘telnetlib.Telnet.write’ with
     arguments ‘self’, ‘buffer’.

     Changed in version 3.3: This method used to raise *note
     socket.error: 989, which is now an alias of *note OSError: 1d1.

 -- Method: Telnet.interact ()

     Interaction function, emulates a very dumb Telnet client.

 -- Method: Telnet.mt_interact ()

     Multithreaded version of *note interact(): 2d28.

 -- Method: Telnet.expect (list, timeout=None)

     Read until one from a list of a regular expressions matches.

     The first argument is a list of regular expressions, either
     compiled (*note regex objects: 890.) or uncompiled (byte strings).
     The optional second argument is a timeout, in seconds; the default
     is to block indefinitely.

     Return a tuple of three items: the index in the list of the first
     regular expression that matches; the match object returned; and the
     bytes read up till and including the match.

     If end of file is found and no bytes were read, raise *note
     EOFError: c5f.  Otherwise, when nothing matches, return ‘(-1, None,
     data)’ where `data' is the bytes received so far (may be empty
     bytes if a timeout happened).

     If a regular expression ends with a greedy match (such as ‘.*’) or
     if more than one expression can match the same input, the results
     are non-deterministic, and may depend on the I/O timing.

 -- Method: Telnet.set_option_negotiation_callback (callback)

     Each time a telnet option is read on the input flow, this
     `callback' (if set) is called with the following parameters:
     callback(telnet socket, command (DO/DONT/WILL/WONT), option).  No
     other action is done afterwards by telnetlib.


File: python.info,  Node: Telnet Example,  Prev: Telnet Objects,  Up: telnetlib — Telnet client

5.22.19.2 Telnet Example
........................

A simple example illustrating typical use:

     import getpass import telnetlib  HOST = "localhost" user = input("Enter your remote account: ") password = getpass.getpass()  tn = telnetlib.Telnet(HOST)  tn.read_until(b"login: ") tn.write(user.encode('ascii') + b"\n") if password:     tn.read_until(b"Password: ")     tn.write(password.encode('ascii') + b"\n")  tn.write(b"ls\n") tn.write(b"exit\n")  print(tn.read_all().decode('ascii'))


File: python.info,  Node: uuid — UUID objects according to RFC 4122,  Next: socketserver — A framework for network servers,  Prev: telnetlib — Telnet client,  Up: Internet Protocols and Support

5.22.20 ‘uuid’ — UUID objects according to
------------------------------------------

`RFC 4122'

`Source code:' Lib/uuid.py(1)

__________________________________________________________________

This module provides immutable *note UUID: 25e. objects (the *note UUID:
25e. class) and the functions *note uuid1(): 408, *note uuid3(): 2d30,
*note uuid4(): 2d31, *note uuid5(): 2d32. for generating version 1, 3,
4, and 5 UUIDs as specified in RFC 4122(2).

If all you want is a unique ID, you should probably call *note uuid1():
408. or *note uuid4(): 2d31.  Note that *note uuid1(): 408. may
compromise privacy since it creates a UUID containing the computer’s
network address.  *note uuid4(): 2d31. creates a random UUID.

Depending on support from the underlying platform, *note uuid1(): 408.
may or may not return a “safe” UUID. A safe UUID is one which is
generated using synchronization methods that ensure no two processes can
obtain the same UUID. All instances of *note UUID: 25e. have an
‘is_safe’ attribute which relays any information about the UUID’s
safety, using this enumeration:

 -- Class: uuid.SafeUUID

     New in version 3.7.

      -- Attribute: safe

          The UUID was generated by the platform in a
          multiprocessing-safe way.

      -- Attribute: unsafe

          The UUID was not generated in a multiprocessing-safe way.

      -- Attribute: unknown

          The platform does not provide information on whether the UUID
          was generated safely or not.

 -- Class: uuid.UUID (hex=None, bytes=None, bytes_le=None, fields=None,
          int=None, version=None, *, is_safe=SafeUUID.unknown)

     Create a UUID from either a string of 32 hexadecimal digits, a
     string of 16 bytes in big-endian order as the `bytes' argument, a
     string of 16 bytes in little-endian order as the `bytes_le'
     argument, a tuple of six integers (32-bit `time_low', 16-bit
     `time_mid', 16-bit `time_hi_version', 8-bit `clock_seq_hi_variant',
     8-bit `clock_seq_low', 48-bit `node') as the `fields' argument, or
     a single 128-bit integer as the `int' argument.  When a string of
     hex digits is given, curly braces, hyphens, and a URN prefix are
     all optional.  For example, these expressions all yield the same
     UUID:

          UUID('{12345678-1234-5678-1234-567812345678}') UUID('12345678123456781234567812345678') UUID('urn:uuid:12345678-1234-5678-1234-567812345678') UUID(bytes=b'\x12\x34\x56\x78'*4) UUID(bytes_le=b'\x78\x56\x34\x12\x34\x12\x78\x56' +               b'\x12\x34\x56\x78\x12\x34\x56\x78') UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678)) UUID(int=0x12345678123456781234567812345678)

     Exactly one of `hex', `bytes', `bytes_le', `fields', or `int' must
     be given.  The `version' argument is optional; if given, the
     resulting UUID will have its variant and version number set
     according to RFC 4122(3), overriding bits in the given `hex',
     `bytes', `bytes_le', `fields', or `int'.

     Comparison of UUID objects are made by way of comparing their *note
     UUID.int: 2d37. attributes.  Comparison with a non-UUID object
     raises a *note TypeError: 192.

     ‘str(uuid)’ returns a string in the form
     ‘12345678-1234-5678-1234-567812345678’ where the 32 hexadecimal
     digits represent the UUID.

*note UUID: 25e. instances have these read-only attributes:

 -- Attribute: UUID.bytes

     The UUID as a 16-byte string (containing the six integer fields in
     big-endian byte order).

 -- Attribute: UUID.bytes_le

     The UUID as a 16-byte string (with `time_low', `time_mid', and
     `time_hi_version' in little-endian byte order).

 -- Attribute: UUID.fields

     A tuple of the six integer fields of the UUID, which are also
     available as six individual attributes and two derived attributes:

     Field                              Meaning
                                        
     -----------------------------------------------------------------------
                                        
     ‘time_low’                         the first 32 bits of the UUID
                                        
                                        
     ‘time_mid’                         the next 16 bits of the UUID
                                        
                                        
     ‘time_hi_version’                  the next 16 bits of the UUID
                                        
                                        
     ‘clock_seq_hi_variant’             the next 8 bits of the UUID
                                        
                                        
     ‘clock_seq_low’                    the next 8 bits of the UUID
                                        
                                        
     ‘node’                             the last 48 bits of the UUID
                                        
                                        
     *note time: 10a.                   the 60-bit timestamp
                                        
                                        
     ‘clock_seq’                        the 14-bit sequence number
                                        

 -- Attribute: UUID.hex

     The UUID as a 32-character hexadecimal string.

 -- Attribute: UUID.int

     The UUID as a 128-bit integer.

 -- Attribute: UUID.urn

     The UUID as a URN as specified in RFC 4122(4).

 -- Attribute: UUID.variant

     The UUID variant, which determines the internal layout of the UUID.
     This will be one of the constants *note RESERVED_NCS: 2d3e, *note
     RFC_4122: 2d3f, *note RESERVED_MICROSOFT: 2d40, or *note
     RESERVED_FUTURE: 2d41.

 -- Attribute: UUID.version

     The UUID version number (1 through 5, meaningful only when the
     variant is *note RFC_4122: 2d3f.).

 -- Attribute: UUID.is_safe

     An enumeration of *note SafeUUID: 2d33. which indicates whether the
     platform generated the UUID in a multiprocessing-safe way.

     New in version 3.7.

The *note uuid: 124. module defines the following functions:

 -- Function: uuid.getnode ()

     Get the hardware address as a 48-bit positive integer.  The first
     time this runs, it may launch a separate program, which could be
     quite slow.  If all attempts to obtain the hardware address fail,
     we choose a random 48-bit number with the multicast bit (least
     significant bit of the first octet) set to 1 as recommended in RFC
     4122(5).  “Hardware address” means the MAC address of a network
     interface.  On a machine with multiple network interfaces,
     universally administered MAC addresses (i.e.  where the second
     least significant bit of the first octet is `unset') will be
     preferred over locally administered MAC addresses, but with no
     other ordering guarantees.

     Changed in version 3.7: Universally administered MAC addresses are
     preferred over locally administered MAC addresses, since the former
     are guaranteed to be globally unique, while the latter are not.

 -- Function: uuid.uuid1 (node=None, clock_seq=None)

     Generate a UUID from a host ID, sequence number, and the current
     time.  If `node' is not given, *note getnode(): 407. is used to
     obtain the hardware address.  If `clock_seq' is given, it is used
     as the sequence number; otherwise a random 14-bit sequence number
     is chosen.

 -- Function: uuid.uuid3 (namespace, name)

     Generate a UUID based on the MD5 hash of a namespace identifier
     (which is a UUID) and a name (which is a string).

 -- Function: uuid.uuid4 ()

     Generate a random UUID.

 -- Function: uuid.uuid5 (namespace, name)

     Generate a UUID based on the SHA-1 hash of a namespace identifier
     (which is a UUID) and a name (which is a string).

The *note uuid: 124. module defines the following namespace identifiers
for use with *note uuid3(): 2d30. or *note uuid5(): 2d32.

 -- Data: uuid.NAMESPACE_DNS

     When this namespace is specified, the `name' string is a
     fully-qualified domain name.

 -- Data: uuid.NAMESPACE_URL

     When this namespace is specified, the `name' string is a URL.

 -- Data: uuid.NAMESPACE_OID

     When this namespace is specified, the `name' string is an ISO OID.

 -- Data: uuid.NAMESPACE_X500

     When this namespace is specified, the `name' string is an X.500 DN
     in DER or a text output format.

The *note uuid: 124. module defines the following constants for the
possible values of the ‘variant’ attribute:

 -- Data: uuid.RESERVED_NCS

     Reserved for NCS compatibility.

 -- Data: uuid.RFC_4122

     Specifies the UUID layout given in RFC 4122(6).

 -- Data: uuid.RESERVED_MICROSOFT

     Reserved for Microsoft compatibility.

 -- Data: uuid.RESERVED_FUTURE

     Reserved for future definition.

See also
........

RFC 4122(7) - A Universally Unique IDentifier (UUID) URN Namespace

     This specification defines a Uniform Resource Name namespace for
     UUIDs, the internal format of UUIDs, and methods of generating
     UUIDs.

* Menu:

* Example: Example<13>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/uuid.py

   (2) https://tools.ietf.org/html/rfc4122.html

   (3) https://tools.ietf.org/html/rfc4122.html

   (4) https://tools.ietf.org/html/rfc4122.html

   (5) https://tools.ietf.org/html/rfc4122.html

   (6) https://tools.ietf.org/html/rfc4122.html

   (7) https://tools.ietf.org/html/rfc4122.html


File: python.info,  Node: Example<13>,  Up: uuid — UUID objects according to RFC 4122

5.22.20.1 Example
.................

Here are some examples of typical usage of the *note uuid: 124. module:

     >>> import uuid  >>> # make a UUID based on the host ID and current time >>> uuid.uuid1() UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')  >>> # make a UUID using an MD5 hash of a namespace UUID and a name >>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org') UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')  >>> # make a random UUID >>> uuid.uuid4() UUID('16fd2706-8baf-433b-82eb-8c7fada847da')  >>> # make a UUID using a SHA-1 hash of a namespace UUID and a name >>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org') UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')  >>> # make a UUID from a string of hex digits (braces and hyphens ignored) >>> x = uuid.UUID('{00010203-0405-0607-0809-0a0b0c0d0e0f}')  >>> # convert a UUID to a string of hex digits in standard form >>> str(x) '00010203-0405-0607-0809-0a0b0c0d0e0f'  >>> # get the raw 16 bytes of the UUID >>> x.bytes b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'  >>> # make a UUID from a 16-byte string >>> uuid.UUID(bytes=x.bytes) UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')


File: python.info,  Node: socketserver — A framework for network servers,  Next: http server — HTTP servers,  Prev: uuid — UUID objects according to RFC 4122,  Up: Internet Protocols and Support

5.22.21 ‘socketserver’ — A framework for network servers
--------------------------------------------------------

`Source code:' Lib/socketserver.py(1)

__________________________________________________________________

The *note socketserver: f0. module simplifies the task of writing
network servers.

There are four basic concrete server classes:

 -- Class: socketserver.TCPServer (server_address, RequestHandlerClass,
          bind_and_activate=True)

     This uses the Internet TCP protocol, which provides for continuous
     streams of data between the client and server.  If
     `bind_and_activate' is true, the constructor automatically attempts
     to invoke *note server_bind(): 2d4c. and *note server_activate():
     2d4d.  The other parameters are passed to the *note BaseServer:
     a7e. base class.

 -- Class: socketserver.UDPServer (server_address, RequestHandlerClass,
          bind_and_activate=True)

     This uses datagrams, which are discrete packets of information that
     may arrive out of order or be lost while in transit.  The
     parameters are the same as for *note TCPServer: 2d4b.

 -- Class: socketserver.UnixStreamServer (server_address,
          RequestHandlerClass, bind_and_activate=True)
 -- Class: socketserver.UnixDatagramServer (server_address,
          RequestHandlerClass, bind_and_activate=True)

     These more infrequently used classes are similar to the TCP and UDP
     classes, but use Unix domain sockets; they’re not available on
     non-Unix platforms.  The parameters are the same as for *note
     TCPServer: 2d4b.

These four classes process requests `synchronously'; each request must
be completed before the next request can be started.  This isn’t
suitable if each request takes a long time to complete, because it
requires a lot of computation, or because it returns a lot of data which
the client is slow to process.  The solution is to create a separate
process or thread to handle each request; the *note ForkingMixIn: 3ca.
and *note ThreadingMixIn: 3cb. mix-in classes can be used to support
asynchronous behaviour.

Creating a server requires several steps.  First, you must create a
request handler class by subclassing the *note BaseRequestHandler: 2d51.
class and overriding its *note handle(): 2d52. method; this method will
process incoming requests.  Second, you must instantiate one of the
server classes, passing it the server’s address and the request handler
class.  It is recommended to use the server in a *note with: 6dd.
statement.  Then call the *note handle_request(): 2d53. or *note
serve_forever(): a80. method of the server object to process one or many
requests.  Finally, call *note server_close(): 2d54. to close the socket
(unless you used a ‘with’ statement).

When inheriting from *note ThreadingMixIn: 3cb. for threaded connection
behavior, you should explicitly declare how you want your threads to
behave on an abrupt shutdown.  The *note ThreadingMixIn: 3cb. class
defines an attribute `daemon_threads', which indicates whether or not
the server should wait for thread termination.  You should set the flag
explicitly if you would like threads to behave autonomously; the default
is *note False: 37d, meaning that Python will not exit until all threads
created by *note ThreadingMixIn: 3cb. have exited.

Server classes have the same external methods and attributes, no matter
what network protocol they use.

* Menu:

* Server Creation Notes::
* Server Objects: Server Objects<2>.
* Request Handler Objects::
* Examples: Examples<23>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/socketserver.py


File: python.info,  Node: Server Creation Notes,  Next: Server Objects<2>,  Up: socketserver — A framework for network servers

5.22.21.1 Server Creation Notes
...............................

There are five classes in an inheritance diagram, four of which
represent synchronous servers of four types:

     +------------+ | BaseServer | +------------+       |       v +-----------+        +------------------+ | TCPServer |------->| UnixStreamServer | +-----------+        +------------------+       |       v +-----------+        +--------------------+ | UDPServer |------->| UnixDatagramServer | +-----------+        +--------------------+

Note that *note UnixDatagramServer: 2d50. derives from *note UDPServer:
2d4e, not from *note UnixStreamServer: 2d4f. — the only difference
between an IP and a Unix stream server is the address family, which is
simply repeated in both Unix server classes.

 -- Class: socketserver.ForkingMixIn
 -- Class: socketserver.ThreadingMixIn

     Forking and threading versions of each type of server can be
     created using these mix-in classes.  For instance, *note
     ThreadingUDPServer: 2d56. is created as follows:

          class ThreadingUDPServer(ThreadingMixIn, UDPServer):     pass

     The mix-in class comes first, since it overrides a method defined
     in *note UDPServer: 2d4e.  Setting the various attributes also
     changes the behavior of the underlying server mechanism.

     *note ForkingMixIn: 3ca. and the Forking classes mentioned below
     are only available on POSIX platforms that support *note fork():
     955.

     ‘socketserver.ForkingMixIn.server_close()’ waits until all child
     processes complete, except if
     ‘socketserver.ForkingMixIn.block_on_close’ attribute is false.

     ‘socketserver.ThreadingMixIn.server_close()’ waits until all
     non-daemon threads complete, except if
     ‘socketserver.ThreadingMixIn.block_on_close’ attribute is false.
     Use daemonic threads by setting ‘ThreadingMixIn.daemon_threads’ to
     ‘True’ to not wait until threads complete.

     Changed in version 3.7: ‘socketserver.ForkingMixIn.server_close()’
     and ‘socketserver.ThreadingMixIn.server_close()’ now waits until
     all child processes and non-daemonic threads complete.  Add a new
     ‘socketserver.ForkingMixIn.block_on_close’ class attribute to
     opt-in for the pre-3.7 behaviour.

 -- Class: socketserver.ForkingTCPServer
 -- Class: socketserver.ForkingUDPServer
 -- Class: socketserver.ThreadingTCPServer
 -- Class: socketserver.ThreadingUDPServer

     These classes are pre-defined using the mix-in classes.

To implement a service, you must derive a class from *note
BaseRequestHandler: 2d51. and redefine its *note handle(): 2d52. method.
You can then run various versions of the service by combining one of the
server classes with your request handler class.  The request handler
class must be different for datagram or stream services.  This can be
hidden by using the handler subclasses *note StreamRequestHandler: 57c.
or *note DatagramRequestHandler: 2d5a.

Of course, you still have to use your head!  For instance, it makes no
sense to use a forking server if the service contains state in memory
that can be modified by different requests, since the modifications in
the child process would never reach the initial state kept in the parent
process and passed to each child.  In this case, you can use a threading
server, but you will probably have to use locks to protect the integrity
of the shared data.

On the other hand, if you are building an HTTP server where all data is
stored externally (for instance, in the file system), a synchronous
class will essentially render the service “deaf” while one request is
being handled – which may be for a very long time if a client is slow to
receive all the data it has requested.  Here a threading or forking
server is appropriate.

In some cases, it may be appropriate to process part of a request
synchronously, but to finish processing in a forked child depending on
the request data.  This can be implemented by using a synchronous server
and doing an explicit fork in the request handler class *note handle():
2d52. method.

Another approach to handling multiple simultaneous requests in an
environment that supports neither threads nor *note fork(): 955. (or
where these are too expensive or inappropriate for the service) is to
maintain an explicit table of partially finished requests and to use
*note selectors: e6. to decide which request to work on next (or whether
to handle a new incoming request).  This is particularly important for
stream services where each client can potentially be connected for a
long time (if threads or subprocesses cannot be used).  See *note
asyncore: b. for another way to manage this.


File: python.info,  Node: Server Objects<2>,  Next: Request Handler Objects,  Prev: Server Creation Notes,  Up: socketserver — A framework for network servers

5.22.21.2 Server Objects
........................

 -- Class: socketserver.BaseServer (server_address, RequestHandlerClass)

     This is the superclass of all Server objects in the module.  It
     defines the interface, given below, but does not implement most of
     the methods, which is done in subclasses.  The two parameters are
     stored in the respective *note server_address: 2d5c. and *note
     RequestHandlerClass: 2d5d. attributes.

      -- Method: fileno ()

          Return an integer file descriptor for the socket on which the
          server is listening.  This function is most commonly passed to
          *note selectors: e6, to allow monitoring multiple servers in
          the same process.

      -- Method: handle_request ()

          Process a single request.  This function calls the following
          methods in order: *note get_request(): 2d5f, *note
          verify_request(): 2d60, and *note process_request(): 2d61.  If
          the user-provided *note handle(): 2d52. method of the handler
          class raises an exception, the server’s *note handle_error():
          5f2. method will be called.  If no request is received within
          *note timeout: 2d62. seconds, *note handle_timeout(): 2d63.
          will be called and *note handle_request(): 2d53. will return.

      -- Method: serve_forever (poll_interval=0.5)

          Handle requests until an explicit *note shutdown(): f55.
          request.  Poll for shutdown every `poll_interval' seconds.
          Ignores the *note timeout: 2d62. attribute.  It also calls
          *note service_actions(): a7f, which may be used by a subclass
          or mixin to provide actions specific to a given service.  For
          example, the *note ForkingMixIn: 3ca. class uses *note
          service_actions(): a7f. to clean up zombie child processes.

          Changed in version 3.3: Added ‘service_actions’ call to the
          ‘serve_forever’ method.

      -- Method: service_actions ()

          This is called in the *note serve_forever(): a80. loop.  This
          method can be overridden by subclasses or mixin classes to
          perform actions specific to a given service, such as cleanup
          actions.

          New in version 3.3.

      -- Method: shutdown ()

          Tell the *note serve_forever(): a80. loop to stop and wait
          until it does.

      -- Method: server_close ()

          Clean up the server.  May be overridden.

      -- Attribute: address_family

          The family of protocols to which the server’s socket belongs.
          Common examples are *note socket.AF_INET: 24eb. and *note
          socket.AF_UNIX: 24f1.

      -- Attribute: RequestHandlerClass

          The user-provided request handler class; an instance of this
          class is created for each request.

      -- Attribute: server_address

          The address on which the server is listening.  The format of
          addresses varies depending on the protocol family; see the
          documentation for the *note socket: ef. module for details.
          For Internet protocols, this is a tuple containing a string
          giving the address, and an integer port number: ‘('127.0.0.1',
          80)’, for example.

      -- Attribute: socket

          The socket object on which the server will listen for incoming
          requests.

     The server classes support the following class variables:

      -- Attribute: allow_reuse_address

          Whether the server will allow the reuse of an address.  This
          defaults to *note False: 37d, and can be set in subclasses to
          change the policy.

      -- Attribute: request_queue_size

          The size of the request queue.  If it takes a long time to
          process a single request, any requests that arrive while the
          server is busy are placed into a queue, up to *note
          request_queue_size: 2d67. requests.  Once the queue is full,
          further requests from clients will get a “Connection denied”
          error.  The default value is usually 5, but this can be
          overridden by subclasses.

      -- Attribute: socket_type

          The type of socket used by the server; *note
          socket.SOCK_STREAM: c7d. and *note socket.SOCK_DGRAM: c7c. are
          two common values.

      -- Attribute: timeout

          Timeout duration, measured in seconds, or *note None: 157. if
          no timeout is desired.  If *note handle_request(): 2d53.
          receives no incoming requests within the timeout period, the
          *note handle_timeout(): 2d63. method is called.

     There are various server methods that can be overridden by
     subclasses of base server classes like *note TCPServer: 2d4b.;
     these methods aren’t useful to external users of the server object.

      -- Method: finish_request (request, client_address)

          Actually processes the request by instantiating *note
          RequestHandlerClass: 2d5d. and calling its *note handle():
          2d52. method.

      -- Method: get_request ()

          Must accept a request from the socket, and return a 2-tuple
          containing the `new' socket object to be used to communicate
          with the client, and the client’s address.

      -- Method: handle_error (request, client_address)

          This function is called if the *note handle(): 2d52. method of
          a *note RequestHandlerClass: 2d5d. instance raises an
          exception.  The default action is to print the traceback to
          standard error and continue handling further requests.

          Changed in version 3.6: Now only called for exceptions derived
          from the *note Exception: 1a8. class.

      -- Method: handle_timeout ()

          This function is called when the *note timeout: 2d62.
          attribute has been set to a value other than *note None: 157.
          and the timeout period has passed with no requests being
          received.  The default action for forking servers is to
          collect the status of any child processes that have exited,
          while in threading servers this method does nothing.

      -- Method: process_request (request, client_address)

          Calls *note finish_request(): 2d69. to create an instance of
          the *note RequestHandlerClass: 2d5d.  If desired, this
          function can create a new process or thread to handle the
          request; the *note ForkingMixIn: 3ca. and *note
          ThreadingMixIn: 3cb. classes do this.

      -- Method: server_activate ()

          Called by the server’s constructor to activate the server.
          The default behavior for a TCP server just invokes *note
          listen(): 73f. on the server’s socket.  May be overridden.

      -- Method: server_bind ()

          Called by the server’s constructor to bind the socket to the
          desired address.  May be overridden.

      -- Method: verify_request (request, client_address)

          Must return a Boolean value; if the value is *note True: 48f,
          the request will be processed, and if it’s *note False: 37d,
          the request will be denied.  This function can be overridden
          to implement access controls for a server.  The default
          implementation always returns *note True: 48f.

     Changed in version 3.6: Support for the *note context manager: 55d.
     protocol was added.  Exiting the context manager is equivalent to
     calling *note server_close(): 2d54.


File: python.info,  Node: Request Handler Objects,  Next: Examples<23>,  Prev: Server Objects<2>,  Up: socketserver — A framework for network servers

5.22.21.3 Request Handler Objects
.................................

 -- Class: socketserver.BaseRequestHandler

     This is the superclass of all request handler objects.  It defines
     the interface, given below.  A concrete request handler subclass
     must define a new *note handle(): 2d52. method, and can override
     any of the other methods.  A new instance of the subclass is
     created for each request.

      -- Method: setup ()

          Called before the *note handle(): 2d52. method to perform any
          initialization actions required.  The default implementation
          does nothing.

      -- Method: handle ()

          This function must do all the work required to service a
          request.  The default implementation does nothing.  Several
          instance attributes are available to it; the request is
          available as ‘self.request’; the client address as
          ‘self.client_address’; and the server instance as
          ‘self.server’, in case it needs access to per-server
          information.

          The type of ‘self.request’ is different for datagram or stream
          services.  For stream services, ‘self.request’ is a socket
          object; for datagram services, ‘self.request’ is a pair of
          string and socket.

      -- Method: finish ()

          Called after the *note handle(): 2d52. method to perform any
          clean-up actions required.  The default implementation does
          nothing.  If *note setup(): 2d6b. raises an exception, this
          function will not be called.

 -- Class: socketserver.StreamRequestHandler
 -- Class: socketserver.DatagramRequestHandler

     These *note BaseRequestHandler: 2d51. subclasses override the *note
     setup(): 2d6b. and *note finish(): 2d6c. methods, and provide
     ‘self.rfile’ and ‘self.wfile’ attributes.  The ‘self.rfile’ and
     ‘self.wfile’ attributes can be read or written, respectively, to
     get the request data or return data to the client.

     The ‘rfile’ attributes of both classes support the *note
     io.BufferedIOBase: 57d. readable interface, and
     ‘DatagramRequestHandler.wfile’ supports the *note
     io.BufferedIOBase: 57d. writable interface.

     Changed in version 3.6: ‘StreamRequestHandler.wfile’ also supports
     the *note io.BufferedIOBase: 57d. writable interface.


File: python.info,  Node: Examples<23>,  Prev: Request Handler Objects,  Up: socketserver — A framework for network servers

5.22.21.4 Examples
..................

* Menu:

* socketserver.TCPServer Example: socketserver TCPServer Example.
* socketserver.UDPServer Example: socketserver UDPServer Example.
* Asynchronous Mixins::


File: python.info,  Node: socketserver TCPServer Example,  Next: socketserver UDPServer Example,  Up: Examples<23>

5.22.21.5 ‘socketserver.TCPServer’ Example
..........................................

This is the server side:

     import socketserver  class MyTCPHandler(socketserver.BaseRequestHandler):     """     The request handler class for our server.      It is instantiated once per connection to the server, and must     override the handle() method to implement communication to the     client.     """      def handle(self):         # self.request is the TCP socket connected to the client         self.data = self.request.recv(1024).strip()         print("{} wrote:".format(self.client_address[0]))         print(self.data)         # just send back the same data, but upper-cased         self.request.sendall(self.data.upper())  if __name__ == "__main__":     HOST, PORT = "localhost", 9999      # Create the server, binding to localhost on port 9999     with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:         # Activate the server; this will keep running until you         # interrupt the program with Ctrl-C         server.serve_forever()

An alternative request handler class that makes use of streams
(file-like objects that simplify communication by providing the standard
file interface):

     class MyTCPHandler(socketserver.StreamRequestHandler):      def handle(self):         # self.rfile is a file-like object created by the handler;         # we can now use e.g. readline() instead of raw recv() calls         self.data = self.rfile.readline().strip()         print("{} wrote:".format(self.client_address[0]))         print(self.data)         # Likewise, self.wfile is a file-like object used to write back         # to the client         self.wfile.write(self.data.upper())

The difference is that the ‘readline()’ call in the second handler will
call ‘recv()’ multiple times until it encounters a newline character,
while the single ‘recv()’ call in the first handler will just return
what has been sent from the client in one ‘sendall()’ call.

This is the client side:

     import socket import sys  HOST, PORT = "localhost", 9999 data = " ".join(sys.argv[1:])  # Create a socket (SOCK_STREAM means a TCP socket) with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:     # Connect to server and send data     sock.connect((HOST, PORT))     sock.sendall(bytes(data + "\n", "utf-8"))      # Receive data from the server and shut down     received = str(sock.recv(1024), "utf-8")  print("Sent:     {}".format(data)) print("Received: {}".format(received))

The output of the example should look something like this:

Server:

     $ python TCPServer.py 127.0.0.1 wrote: b'hello world with TCP' 127.0.0.1 wrote: b'python is nice'

Client:

     $ python TCPClient.py hello world with TCP Sent:     hello world with TCP Received: HELLO WORLD WITH TCP $ python TCPClient.py python is nice Sent:     python is nice Received: PYTHON IS NICE


File: python.info,  Node: socketserver UDPServer Example,  Next: Asynchronous Mixins,  Prev: socketserver TCPServer Example,  Up: Examples<23>

5.22.21.6 ‘socketserver.UDPServer’ Example
..........................................

This is the server side:

     import socketserver  class MyUDPHandler(socketserver.BaseRequestHandler):     """     This class works similar to the TCP handler class, except that     self.request consists of a pair of data and client socket, and since     there is no connection the client address must be given explicitly     when sending data back via sendto().     """      def handle(self):         data = self.request[0].strip()         socket = self.request[1]         print("{} wrote:".format(self.client_address[0]))         print(data)         socket.sendto(data.upper(), self.client_address)  if __name__ == "__main__":     HOST, PORT = "localhost", 9999     with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server:         server.serve_forever()

This is the client side:

     import socket import sys  HOST, PORT = "localhost", 9999 data = " ".join(sys.argv[1:])  # SOCK_DGRAM is the socket type to use for UDP sockets sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)  # As you can see, there is no connect() call; UDP has no connections. # Instead, data is directly sent to the recipient via sendto(). sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT)) received = str(sock.recv(1024), "utf-8")  print("Sent:     {}".format(data)) print("Received: {}".format(received))

The output of the example should look exactly like for the TCP server
example.


File: python.info,  Node: Asynchronous Mixins,  Prev: socketserver UDPServer Example,  Up: Examples<23>

5.22.21.7 Asynchronous Mixins
.............................

To build asynchronous handlers, use the *note ThreadingMixIn: 3cb. and
*note ForkingMixIn: 3ca. classes.

An example for the *note ThreadingMixIn: 3cb. class:

     import socket import threading import socketserver  class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):      def handle(self):         data = str(self.request.recv(1024), 'ascii')         cur_thread = threading.current_thread()         response = bytes("{}: {}".format(cur_thread.name, data), 'ascii')         self.request.sendall(response)  class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):     pass  def client(ip, port, message):     with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:         sock.connect((ip, port))         sock.sendall(bytes(message, 'ascii'))         response = str(sock.recv(1024), 'ascii')         print("Received: {}".format(response))  if __name__ == "__main__":     # Port 0 means to select an arbitrary unused port     HOST, PORT = "localhost", 0      server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)     with server:         ip, port = server.server_address          # Start a thread with the server -- that thread will then start one         # more thread for each request         server_thread = threading.Thread(target=server.serve_forever)         # Exit the server thread when the main thread terminates         server_thread.daemon = True         server_thread.start()         print("Server loop running in thread:", server_thread.name)          client(ip, port, "Hello World 1")         client(ip, port, "Hello World 2")         client(ip, port, "Hello World 3")          server.shutdown()

The output of the example should look something like this:

     $ python ThreadedTCPServer.py Server loop running in thread: Thread-1 Received: Thread-2: Hello World 1 Received: Thread-3: Hello World 2 Received: Thread-4: Hello World 3

The *note ForkingMixIn: 3ca. class is used in the same way, except that
the server will spawn a new process for each request.  Available only on
POSIX platforms that support *note fork(): 955.


File: python.info,  Node: http server — HTTP servers,  Next: http cookies — HTTP state management,  Prev: socketserver — A framework for network servers,  Up: Internet Protocols and Support

5.22.22 ‘http.server’ — HTTP servers
------------------------------------

`Source code:' Lib/http/server.py(1)

__________________________________________________________________

This module defines classes for implementing HTTP servers (Web servers).

     Warning: *note http.server: 97. is not recommended for production.
     It only implements basic security checks.

One class, *note HTTPServer: 2b40, is a *note socketserver.TCPServer:
2d4b. subclass.  It creates and listens at the HTTP socket, dispatching
the requests to a handler.  Code to create and run the server looks like
this:

     def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):     server_address = ('', 8000)     httpd = server_class(server_address, handler_class)     httpd.serve_forever()

 -- Class: http.server.HTTPServer (server_address, RequestHandlerClass)

     This class builds on the *note TCPServer: 2d4b. class by storing
     the server address as instance variables named ‘server_name’ and
     ‘server_port’.  The server is accessible by the handler, typically
     through the handler’s ‘server’ instance variable.

 -- Class: http.server.ThreadingHTTPServer (server_address,
          RequestHandlerClass)

     This class is identical to HTTPServer but uses threads to handle
     requests by using the *note ThreadingMixIn: 3cb.  This is useful to
     handle web browsers pre-opening sockets, on which *note HTTPServer:
     2b40. would wait indefinitely.

     New in version 3.7.

The *note HTTPServer: 2b40. and *note ThreadingHTTPServer: 38b. must be
given a `RequestHandlerClass' on instantiation, of which this module
provides three different variants:

 -- Class: http.server.BaseHTTPRequestHandler (request, client_address,
          server)

     This class is used to handle the HTTP requests that arrive at the
     server.  By itself, it cannot respond to any actual HTTP requests;
     it must be subclassed to handle each request method (e.g.  GET or
     POST). *note BaseHTTPRequestHandler: a03. provides a number of
     class and instance variables, and methods for use by subclasses.

     The handler will parse the request and the headers, then call a
     method specific to the request type.  The method name is
     constructed from the request.  For example, for the request method
     ‘SPAM’, the ‘do_SPAM()’ method will be called with no arguments.
     All of the relevant information is stored in instance variables of
     the handler.  Subclasses should not need to override or extend the
     *note __init__(): d51. method.

     *note BaseHTTPRequestHandler: a03. has the following instance
     variables:

      -- Attribute: client_address

          Contains a tuple of the form ‘(host, port)’ referring to the
          client’s address.

      -- Attribute: server

          Contains the server instance.

      -- Attribute: close_connection

          Boolean that should be set before *note handle_one_request():
          2d76. returns, indicating if another request may be expected,
          or if the connection should be shut down.

      -- Attribute: requestline

          Contains the string representation of the HTTP request line.
          The terminating CRLF is stripped.  This attribute should be
          set by *note handle_one_request(): 2d76.  If no valid request
          line was processed, it should be set to the empty string.

      -- Attribute: command

          Contains the command (request type).  For example, ‘'GET'’.

      -- Attribute: path

          Contains the request path.

      -- Attribute: request_version

          Contains the version string from the request.  For example,
          ‘'HTTP/1.0'’.

      -- Attribute: headers

          Holds an instance of the class specified by the *note
          MessageClass: 2d7b. class variable.  This instance parses and
          manages the headers in the HTTP request.  The *note
          parse_headers(): f78. function from *note http.client: 94. is
          used to parse the headers and it requires that the HTTP
          request provide a valid RFC 2822(2) style header.

      -- Attribute: rfile

          An *note io.BufferedIOBase: 57d. input stream, ready to read
          from the start of the optional input data.

      -- Attribute: wfile

          Contains the output stream for writing a response back to the
          client.  Proper adherence to the HTTP protocol must be used
          when writing to this stream in order to achieve successful
          interoperation with HTTP clients.

          Changed in version 3.6: This is an *note io.BufferedIOBase:
          57d. stream.

     *note BaseHTTPRequestHandler: a03. has the following attributes:

      -- Attribute: server_version

          Specifies the server software version.  You may want to
          override this.  The format is multiple whitespace-separated
          strings, where each string is of the form name[/version].  For
          example, ‘'BaseHTTP/0.2'’.

      -- Attribute: sys_version

          Contains the Python system version, in a form usable by the
          *note version_string: 2d80. method and the *note
          server_version: 2d7e. class variable.  For example,
          ‘'Python/1.4'’.

      -- Attribute: error_message_format

          Specifies a format string that should be used by *note
          send_error(): 850. method for building an error response to
          the client.  The string is filled by default with variables
          from *note responses: 2c0c. based on the status code that
          passed to *note send_error(): 850.

      -- Attribute: error_content_type

          Specifies the Content-Type HTTP header of error responses sent
          to the client.  The default value is ‘'text/html'’.

      -- Attribute: protocol_version

          This specifies the HTTP protocol version used in responses.
          If set to ‘'HTTP/1.1'’, the server will permit HTTP persistent
          connections; however, your server `must' then include an
          accurate ‘Content-Length’ header (using *note send_header():
          2d84.) in all of its responses to clients.  For backwards
          compatibility, the setting defaults to ‘'HTTP/1.0'’.

      -- Attribute: MessageClass

          Specifies an *note email.message.Message: 536.-like class to
          parse HTTP headers.  Typically, this is not overridden, and it
          defaults to ‘http.client.HTTPMessage’.

      -- Attribute: responses

          This attribute contains a mapping of error code integers to
          two-element tuples containing a short and long message.  For
          example, ‘{code: (shortmessage, longmessage)}’.  The
          `shortmessage' is usually used as the `message' key in an
          error response, and `longmessage' as the `explain' key.  It is
          used by *note send_response_only(): 2d85. and *note
          send_error(): 850. methods.

     A *note BaseHTTPRequestHandler: a03. instance has the following
     methods:

      -- Method: handle ()

          Calls *note handle_one_request(): 2d76. once (or, if
          persistent connections are enabled, multiple times) to handle
          incoming HTTP requests.  You should never need to override it;
          instead, implement appropriate ‘do_*()’ methods.

      -- Method: handle_one_request ()

          This method will parse and dispatch the request to the
          appropriate ‘do_*()’ method.  You should never need to
          override it.

      -- Method: handle_expect_100 ()

          When a HTTP/1.1 compliant server receives an ‘Expect:
          100-continue’ request header it responds back with a ‘100
          Continue’ followed by ‘200 OK’ headers.  This method can be
          overridden to raise an error if the server does not want the
          client to continue.  For e.g.  server can chose to send ‘417
          Expectation Failed’ as a response header and ‘return False’.

          New in version 3.2.

      -- Method: send_error (code, message=None, explain=None)

          Sends and logs a complete error reply to the client.  The
          numeric `code' specifies the HTTP error code, with `message'
          as an optional, short, human readable description of the
          error.  The `explain' argument can be used to provide more
          detailed information about the error; it will be formatted
          using the *note error_message_format: 2d81. attribute and
          emitted, after a complete set of headers, as the response
          body.  The *note responses: 2c0c. attribute holds the default
          values for `message' and `explain' that will be used if no
          value is provided; for unknown codes the default value for
          both is the string ‘???’.  The body will be empty if the
          method is HEAD or the response code is one of the following:
          ‘1xx’, ‘204 No Content’, ‘205 Reset Content’, ‘304 Not
          Modified’.

          Changed in version 3.4: The error response includes a
          Content-Length header.  Added the `explain' argument.

      -- Method: send_response (code, message=None)

          Adds a response header to the headers buffer and logs the
          accepted request.  The HTTP response line is written to the
          internal buffer, followed by `Server' and `Date' headers.  The
          values for these two headers are picked up from the *note
          version_string(): 2d80. and *note date_time_string(): 2d89.
          methods, respectively.  If the server does not intend to send
          any other headers using the *note send_header(): 2d84. method,
          then *note send_response(): 2d88. should be followed by an
          *note end_headers(): a04. call.

          Changed in version 3.3: Headers are stored to an internal
          buffer and *note end_headers(): a04. needs to be called
          explicitly.

      -- Method: send_header (keyword, value)

          Adds the HTTP header to an internal buffer which will be
          written to the output stream when either *note end_headers():
          a04. or *note flush_headers(): a05. is invoked.  `keyword'
          should specify the header keyword, with `value' specifying its
          value.  Note that, after the send_header calls are done, *note
          end_headers(): a04. MUST BE called in order to complete the
          operation.

          Changed in version 3.2: Headers are stored in an internal
          buffer.

      -- Method: send_response_only (code, message=None)

          Sends the response header only, used for the purposes when
          ‘100 Continue’ response is sent by the server to the client.
          The headers not buffered and sent directly the output
          stream.If the `message' is not specified, the HTTP message
          corresponding the response `code' is sent.

          New in version 3.2.

      -- Method: end_headers ()

          Adds a blank line (indicating the end of the HTTP headers in
          the response) to the headers buffer and calls *note
          flush_headers(): a05.

          Changed in version 3.2: The buffered headers are written to
          the output stream.

      -- Method: flush_headers ()

          Finally send the headers to the output stream and flush the
          internal headers buffer.

          New in version 3.3.

      -- Method: log_request (code='-', size='-')

          Logs an accepted (successful) request.  `code' should specify
          the numeric HTTP code associated with the response.  If a size
          of the response is available, then it should be passed as the
          `size' parameter.

      -- Method: log_error (...)

          Logs an error when a request cannot be fulfilled.  By default,
          it passes the message to *note log_message(): 2d8c, so it
          takes the same arguments (`format' and additional values).

      -- Method: log_message (format, ...)

          Logs an arbitrary message to ‘sys.stderr’.  This is typically
          overridden to create custom error logging mechanisms.  The
          `format' argument is a standard printf-style format string,
          where the additional arguments to *note log_message(): 2d8c.
          are applied as inputs to the formatting.  The client ip
          address and current date and time are prefixed to every
          message logged.

      -- Method: version_string ()

          Returns the server software’s version string.  This is a
          combination of the *note server_version: 2d7e. and *note
          sys_version: 2d7f. attributes.

      -- Method: date_time_string (timestamp=None)

          Returns the date and time given by `timestamp' (which must be
          ‘None’ or in the format returned by *note time.time(): 312.),
          formatted for a message header.  If `timestamp' is omitted, it
          uses the current date and time.

          The result looks like ‘'Sun, 06 Nov 1994 08:49:37 GMT'’.

      -- Method: log_date_time_string ()

          Returns the current date and time, formatted for logging.

      -- Method: address_string ()

          Returns the client address.

          Changed in version 3.3: Previously, a name lookup was
          performed.  To avoid name resolution delays, it now always
          returns the IP address.

 -- Class: http.server.SimpleHTTPRequestHandler (request,
          client_address, server, directory=None)

     This class serves files from the current directory and below,
     directly mapping the directory structure to HTTP requests.

     A lot of the work, such as parsing the request, is done by the base
     class *note BaseHTTPRequestHandler: a03.  This class implements the
     *note do_GET(): 2d8f. and *note do_HEAD(): 2d90. functions.

     The following are defined as class-level attributes of *note
     SimpleHTTPRequestHandler: 38a.:

      -- Attribute: server_version

          This will be ‘"SimpleHTTP/" + __version__’, where
          ‘__version__’ is defined at the module level.

      -- Attribute: extensions_map

          A dictionary mapping suffixes into MIME types.  The default is
          signified by an empty string, and is considered to be
          ‘application/octet-stream’.  The mapping is used
          case-insensitively, and so should contain only lower-cased
          keys.

      -- Attribute: directory

          If not specified, the directory to serve is the current
          working directory.

     The *note SimpleHTTPRequestHandler: 38a. class defines the
     following methods:

      -- Method: do_HEAD ()

          This method serves the ‘'HEAD'’ request type: it sends the
          headers it would send for the equivalent ‘GET’ request.  See
          the *note do_GET(): 2d8f. method for a more complete
          explanation of the possible headers.

      -- Method: do_GET ()

          The request is mapped to a local file by interpreting the
          request as a path relative to the current working directory.

          If the request was mapped to a directory, the directory is
          checked for a file named ‘index.html’ or ‘index.htm’ (in that
          order).  If found, the file’s contents are returned; otherwise
          a directory listing is generated by calling the
          ‘list_directory()’ method.  This method uses *note
          os.listdir(): a36. to scan the directory, and returns a ‘404’
          error response if the *note listdir(): a36. fails.

          If the request was mapped to a file, it is opened.  Any *note
          OSError: 1d1. exception in opening the requested file is
          mapped to a ‘404’, ‘'File not found'’ error.  If there was a
          ‘'If-Modified-Since'’ header in the request, and the file was
          not modified after this time, a ‘304’, ‘'Not Modified'’
          response is sent.  Otherwise, the content type is guessed by
          calling the ‘guess_type()’ method, which in turn uses the
          `extensions_map' variable, and the file contents are returned.

          A ‘'Content-type:'’ header with the guessed content type is
          output, followed by a ‘'Content-Length:'’ header with the
          file’s size and a ‘'Last-Modified:'’ header with the file’s
          modification time.

          Then follows a blank line signifying the end of the headers,
          and then the contents of the file are output.  If the file’s
          MIME type starts with ‘text/’ the file is opened in text mode;
          otherwise binary mode is used.

          For example usage, see the implementation of the *note test():
          105. function invocation in the *note http.server: 97. module.

          Changed in version 3.7: Support of the ‘'If-Modified-Since'’
          header.

The *note SimpleHTTPRequestHandler: 38a. class can be used in the
following manner in order to create a very basic webserver serving files
relative to the current directory:

     import http.server import socketserver  PORT = 8000  Handler = http.server.SimpleHTTPRequestHandler  with socketserver.TCPServer(("", PORT), Handler) as httpd:     print("serving at port", PORT)     httpd.serve_forever()
*note http.server: 97. can also be invoked directly using the *note -m:
32c. switch of the interpreter with a ‘port number’ argument.  Similar
to the previous example, this serves files relative to the current
directory:

     python -m http.server 8000

By default, server binds itself to all interfaces.  The option
‘-b/--bind’ specifies a specific address to which it should bind.  Both
IPv4 and IPv6 addresses are supported.  For example, the following
command causes the server to bind to localhost only:

     python -m http.server 8000 --bind 127.0.0.1

New in version 3.4: ‘--bind’ argument was introduced.

New in version 3.8: ‘--bind’ argument enhanced to support IPv6

By default, server uses the current directory.  The option
‘-d/--directory’ specifies a directory to which it should serve the
files.  For example, the following command uses a specific directory:

     python -m http.server --directory /tmp/

New in version 3.7: ‘--directory’ specify alternate directory

 -- Class: http.server.CGIHTTPRequestHandler (request, client_address,
          server)

     This class is used to serve either files or output of CGI scripts
     from the current directory and below.  Note that mapping HTTP
     hierarchic structure to local directory structure is exactly as in
     *note SimpleHTTPRequestHandler: 38a.

          Note: CGI scripts run by the *note CGIHTTPRequestHandler:
          2d94. class cannot execute redirects (HTTP code 302), because
          code 200 (script output follows) is sent prior to execution of
          the CGI script.  This pre-empts the status code.

     The class will however, run the CGI script, instead of serving it
     as a file, if it guesses it to be a CGI script.  Only
     directory-based CGI are used — the other common server
     configuration is to treat special extensions as denoting CGI
     scripts.

     The ‘do_GET()’ and ‘do_HEAD()’ functions are modified to run CGI
     scripts and serve the output, instead of serving files, if the
     request leads to somewhere below the ‘cgi_directories’ path.

     The *note CGIHTTPRequestHandler: 2d94. defines the following data
     member:

      -- Attribute: cgi_directories

          This defaults to ‘['/cgi-bin', '/htbin']’ and describes
          directories to treat as containing CGI scripts.

     The *note CGIHTTPRequestHandler: 2d94. defines the following
     method:

      -- Method: do_POST ()

          This method serves the ‘'POST'’ request type, only allowed for
          CGI scripts.  Error 501, “Can only POST to CGI scripts”, is
          output when trying to POST to a non-CGI url.

     Note that CGI scripts will be run with UID of user nobody, for
     security reasons.  Problems with the CGI script will be translated
     to error 403.

*note CGIHTTPRequestHandler: 2d94. can be enabled in the command line by
passing the ‘--cgi’ option:

     python -m http.server --cgi 8000

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/http/server.py

   (2) https://tools.ietf.org/html/rfc2822.html


File: python.info,  Node: http cookies — HTTP state management,  Next: http cookiejar — Cookie handling for HTTP clients,  Prev: http server — HTTP servers,  Up: Internet Protocols and Support

5.22.23 ‘http.cookies’ — HTTP state management
----------------------------------------------

`Source code:' Lib/http/cookies.py(1)

__________________________________________________________________

The *note http.cookies: 96. module defines classes for abstracting the
concept of cookies, an HTTP state management mechanism.  It supports
both simple string-only cookies, and provides an abstraction for having
any serializable data-type as cookie value.

The module formerly strictly applied the parsing rules described in the
RFC 2109(2) and RFC 2068(3) specifications.  It has since been
discovered that MSIE 3.0x doesn’t follow the character rules outlined in
those specs and also many current day browsers and servers have relaxed
parsing rules when comes to Cookie handling.  As a result, the parsing
rules used are a bit less strict.

The character set, *note string.ascii_letters: c4f, *note string.digits:
165d. and ‘!#$%&'*+-.^_`|~:’ denote the set of valid characters allowed
by this module in Cookie name (as *note key: 482.).

Changed in version 3.3: Allowed ‘:’ as a valid Cookie name character.

     Note: On encountering an invalid cookie, *note CookieError: 2d99.
     is raised, so if your cookie data comes from a browser you should
     always prepare for invalid data and catch *note CookieError: 2d99.
     on parsing.

 -- Exception: http.cookies.CookieError

     Exception failing because of RFC 2109(4) invalidity: incorrect
     attributes, incorrect ‘Set-Cookie’ header, etc.

 -- Class: http.cookies.BaseCookie ([input])

     This class is a dictionary-like object whose keys are strings and
     whose values are *note Morsel: 485. instances.  Note that upon
     setting a key to a value, the value is first converted to a *note
     Morsel: 485. containing the key and the value.

     If `input' is given, it is passed to the *note load(): 2d9b.
     method.

 -- Class: http.cookies.SimpleCookie ([input])

     This class derives from *note BaseCookie: 2d9a. and overrides
     ‘value_decode()’ and ‘value_encode()’.  SimpleCookie supports
     strings as cookie values.  When setting the value, SimpleCookie
     calls the builtin *note str(): 325. to convert the value to a
     string.  Values received from HTTP are kept as strings.

See also
........

Module *note http.cookiejar: 95.

     HTTP cookie handling for web `clients'.  The *note http.cookiejar:
     95. and *note http.cookies: 96. modules do not depend on each
     other.

RFC 2109(5) - HTTP State Management Mechanism

     This is the state management specification implemented by this
     module.

* Menu:

* Cookie Objects::
* Morsel Objects::
* Example: Example<14>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/http/cookies.py

   (2) https://tools.ietf.org/html/rfc2109.html

   (3) https://tools.ietf.org/html/rfc2068.html

   (4) https://tools.ietf.org/html/rfc2109.html

   (5) https://tools.ietf.org/html/rfc2109.html


File: python.info,  Node: Cookie Objects,  Next: Morsel Objects,  Up: http cookies — HTTP state management

5.22.23.1 Cookie Objects
........................

 -- Method: BaseCookie.value_decode (val)

     Return a tuple ‘(real_value, coded_value)’ from a string
     representation.  ‘real_value’ can be any type.  This method does no
     decoding in *note BaseCookie: 2d9a. — it exists so it can be
     overridden.

 -- Method: BaseCookie.value_encode (val)

     Return a tuple ‘(real_value, coded_value)’.  `val' can be any type,
     but ‘coded_value’ will always be converted to a string.  This
     method does no encoding in *note BaseCookie: 2d9a. — it exists so
     it can be overridden.

     In general, it should be the case that *note value_encode(): 2d9f.
     and *note value_decode(): 2d9e. are inverses on the range of
     `value_decode'.

 -- Method: BaseCookie.output (attrs=None, header='Set-Cookie:',
          sep='\r\n')

     Return a string representation suitable to be sent as HTTP headers.
     `attrs' and `header' are sent to each *note Morsel: 485.’s *note
     output(): 2da0. method.  `sep' is used to join the headers
     together, and is by default the combination ‘'\r\n'’ (CRLF).

 -- Method: BaseCookie.js_output (attrs=None)

     Return an embeddable JavaScript snippet, which, if run on a browser
     which supports JavaScript, will act the same as if the HTTP headers
     was sent.

     The meaning for `attrs' is the same as in *note output(): 2da0.

 -- Method: BaseCookie.load (rawdata)

     If `rawdata' is a string, parse it as an ‘HTTP_COOKIE’ and add the
     values found there as *note Morsel: 485.s.  If it is a dictionary,
     it is equivalent to:

          for k, v in rawdata.items():     cookie[k] = v


File: python.info,  Node: Morsel Objects,  Next: Example<14>,  Prev: Cookie Objects,  Up: http cookies — HTTP state management

5.22.23.2 Morsel Objects
........................

 -- Class: http.cookies.Morsel

     Abstract a key/value pair, which has some RFC 2109(1) attributes.

     Morsels are dictionary-like objects, whose set of keys is constant
     — the valid RFC 2109(2) attributes, which are

        * ‘expires’

        * ‘path’

        * ‘comment’

        * ‘domain’

        * ‘max-age’

        * ‘secure’

        * ‘version’

        * ‘httponly’

        * ‘samesite’

     The attribute ‘httponly’ specifies that the cookie is only
     transferred in HTTP requests, and is not accessible through
     JavaScript.  This is intended to mitigate some forms of cross-site
     scripting.

     The attribute ‘samesite’ specifies that the browser is not allowed
     to send the cookie along with cross-site requests.  This helps to
     mitigate CSRF attacks.  Valid values for this attribute are
     “Strict” and “Lax”.

     The keys are case-insensitive and their default value is ‘''’.

     Changed in version 3.5: ‘__eq__()’ now takes *note key: 482. and
     *note value: 483. into account.

     Changed in version 3.7: Attributes *note key: 482, *note value:
     483. and *note coded_value: 484. are read-only.  Use *note set():
     486. for setting them.

     Changed in version 3.8: Added support for the ‘samesite’ attribute.

 -- Attribute: Morsel.value

     The value of the cookie.

 -- Attribute: Morsel.coded_value

     The encoded value of the cookie — this is what should be sent.

 -- Attribute: Morsel.key

     The name of the cookie.

 -- Method: Morsel.set (key, value, coded_value)

     Set the `key', `value' and `coded_value' attributes.

 -- Method: Morsel.isReservedKey (K)

     Whether `K' is a member of the set of keys of a *note Morsel: 485.

 -- Method: Morsel.output (attrs=None, header='Set-Cookie:')

     Return a string representation of the Morsel, suitable to be sent
     as an HTTP header.  By default, all the attributes are included,
     unless `attrs' is given, in which case it should be a list of
     attributes to use.  `header' is by default ‘"Set-Cookie:"’.

 -- Method: Morsel.js_output (attrs=None)

     Return an embeddable JavaScript snippet, which, if run on a browser
     which supports JavaScript, will act the same as if the HTTP header
     was sent.

     The meaning for `attrs' is the same as in *note output(): 2da5.

 -- Method: Morsel.OutputString (attrs=None)

     Return a string representing the Morsel, without any surrounding
     HTTP or JavaScript.

     The meaning for `attrs' is the same as in *note output(): 2da5.

 -- Method: Morsel.update (values)

     Update the values in the Morsel dictionary with the values in the
     dictionary `values'.  Raise an error if any of the keys in the
     `values' dict is not a valid RFC 2109(3) attribute.

     Changed in version 3.5: an error is raised for invalid keys.

 -- Method: Morsel.copy (value)

     Return a shallow copy of the Morsel object.

     Changed in version 3.5: return a Morsel object instead of a dict.

 -- Method: Morsel.setdefault (key, value=None)

     Raise an error if key is not a valid RFC 2109(4) attribute,
     otherwise behave the same as *note dict.setdefault(): 9b3.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2109.html

   (2) https://tools.ietf.org/html/rfc2109.html

   (3) https://tools.ietf.org/html/rfc2109.html

   (4) https://tools.ietf.org/html/rfc2109.html


File: python.info,  Node: Example<14>,  Prev: Morsel Objects,  Up: http cookies — HTTP state management

5.22.23.3 Example
.................

The following example demonstrates how to use the *note http.cookies:
96. module.

     >>> from http import cookies >>> C = cookies.SimpleCookie() >>> C["fig"] = "newton" >>> C["sugar"] = "wafer" >>> print(C) # generate HTTP headers Set-Cookie: fig=newton Set-Cookie: sugar=wafer >>> print(C.output()) # same thing Set-Cookie: fig=newton Set-Cookie: sugar=wafer >>> C = cookies.SimpleCookie() >>> C["rocky"] = "road" >>> C["rocky"]["path"] = "/cookie" >>> print(C.output(header="Cookie:")) Cookie: rocky=road; Path=/cookie >>> print(C.output(attrs=[], header="Cookie:")) Cookie: rocky=road >>> C = cookies.SimpleCookie() >>> C.load("chips=ahoy; vienna=finger") # load from a string (HTTP header) >>> print(C) Set-Cookie: chips=ahoy Set-Cookie: vienna=finger >>> C = cookies.SimpleCookie() >>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";') >>> print(C) Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;" >>> C = cookies.SimpleCookie() >>> C["oreo"] = "doublestuff" >>> C["oreo"]["path"] = "/" >>> print(C) Set-Cookie: oreo=doublestuff; Path=/ >>> C = cookies.SimpleCookie() >>> C["twix"] = "none for you" >>> C["twix"].value 'none for you' >>> C = cookies.SimpleCookie() >>> C["number"] = 7 # equivalent to C["number"] = str(7) >>> C["string"] = "seven" >>> C["number"].value '7' >>> C["string"].value 'seven' >>> print(C) Set-Cookie: number=7 Set-Cookie: string=seven


File: python.info,  Node: http cookiejar — Cookie handling for HTTP clients,  Next: xmlrpc — XMLRPC server and client modules,  Prev: http cookies — HTTP state management,  Up: Internet Protocols and Support

5.22.24 ‘http.cookiejar’ — Cookie handling for HTTP clients
-----------------------------------------------------------

`Source code:' Lib/http/cookiejar.py(1)

__________________________________________________________________

The *note http.cookiejar: 95. module defines classes for automatic
handling of HTTP cookies.  It is useful for accessing web sites that
require small pieces of data – `cookies' – to be set on the client
machine by an HTTP response from a web server, and then returned to the
server in later HTTP requests.

Both the regular Netscape cookie protocol and the protocol defined by
RFC 2965(2) are handled.  RFC 2965 handling is switched off by default.
RFC 2109(3) cookies are parsed as Netscape cookies and subsequently
treated either as Netscape or RFC 2965 cookies according to the ‘policy’
in effect.  Note that the great majority of cookies on the Internet are
Netscape cookies.  *note http.cookiejar: 95. attempts to follow the
de-facto Netscape cookie protocol (which differs substantially from that
set out in the original Netscape specification), including taking note
of the ‘max-age’ and ‘port’ cookie-attributes introduced with RFC 2965.

     Note: The various named parameters found in ‘Set-Cookie’ and
     ‘Set-Cookie2’ headers (eg.  ‘domain’ and ‘expires’) are
     conventionally referred to as `attributes'.  To distinguish them
     from Python attributes, the documentation for this module uses the
     term `cookie-attribute' instead.

The module defines the following exception:

 -- Exception: http.cookiejar.LoadError

     Instances of *note FileCookieJar: 2dae. raise this exception on
     failure to load cookies from a file.  *note LoadError: 2dad. is a
     subclass of *note OSError: 1d1.

     Changed in version 3.3: LoadError was made a subclass of *note
     OSError: 1d1. instead of *note IOError: 986.

The following classes are provided:

 -- Class: http.cookiejar.CookieJar (policy=None)

     `policy' is an object implementing the *note CookiePolicy: 2daf.
     interface.

     The *note CookieJar: 2bb0. class stores HTTP cookies.  It extracts
     cookies from HTTP requests, and returns them in HTTP responses.
     *note CookieJar: 2bb0. instances automatically expire contained
     cookies when necessary.  Subclasses are also responsible for
     storing and retrieving cookies from a file or database.

 -- Class: http.cookiejar.FileCookieJar (filename, delayload=None,
          policy=None)

     `policy' is an object implementing the *note CookiePolicy: 2daf.
     interface.  For the other arguments, see the documentation for the
     corresponding attributes.

     A *note CookieJar: 2bb0. which can load cookies from, and perhaps
     save cookies to, a file on disk.  Cookies are `NOT' loaded from the
     named file until either the *note load(): 2db0. or *note revert():
     2db1. method is called.  Subclasses of this class are documented in
     section *note FileCookieJar subclasses and co-operation with web
     browsers: 2db2.

     Changed in version 3.8: The filename parameter supports a *note
     path-like object: 35f.

 -- Class: http.cookiejar.CookiePolicy

     This class is responsible for deciding whether each cookie should
     be accepted from / returned to the server.

 -- Class: http.cookiejar.DefaultCookiePolicy (blocked_domains=None,
          allowed_domains=None, netscape=True, rfc2965=False,
          rfc2109_as_netscape=None, hide_cookie2=False,
          strict_domain=False, strict_rfc2965_unverifiable=True,
          strict_ns_unverifiable=False,
          strict_ns_domain=DefaultCookiePolicy.DomainLiberal,
          strict_ns_set_initial_dollar=False, strict_ns_set_path=False,
          secure_protocols=("https", "wss"))

     Constructor arguments should be passed as keyword arguments only.
     `blocked_domains' is a sequence of domain names that we never
     accept cookies from, nor return cookies to.  `allowed_domains' if
     not *note None: 157, this is a sequence of the only domains for
     which we accept and return cookies.  `secure_protocols' is a
     sequence of protocols for which secure cookies can be added to.  By
     default `https' and `wss' (secure websocket) are considered secure
     protocols.  For all other arguments, see the documentation for
     *note CookiePolicy: 2daf. and *note DefaultCookiePolicy: f22.
     objects.

     *note DefaultCookiePolicy: f22. implements the standard accept /
     reject rules for Netscape and RFC 2965(4) cookies.  By default, RFC
     2109(5) cookies (ie.  cookies received in a ‘Set-Cookie’ header
     with a version cookie-attribute of 1) are treated according to the
     RFC 2965 rules.  However, if RFC 2965 handling is turned off or
     *note rfc2109_as_netscape: 2db3. is ‘True’, RFC 2109 cookies are
     ‘downgraded’ by the *note CookieJar: 2bb0. instance to Netscape
     cookies, by setting the ‘version’ attribute of the *note Cookie:
     2db4. instance to 0.  *note DefaultCookiePolicy: f22. also provides
     some parameters to allow some fine-tuning of policy.

 -- Class: http.cookiejar.Cookie

     This class represents Netscape, RFC 2109(6) and RFC 2965(7)
     cookies.  It is not expected that users of *note http.cookiejar:
     95. construct their own *note Cookie: 2db4. instances.  Instead, if
     necessary, call ‘make_cookies()’ on a *note CookieJar: 2bb0.
     instance.

See also
........

Module *note urllib.request: 120.

     URL opening with automatic cookie handling.

Module *note http.cookies: 96.

     HTTP cookie classes, principally useful for server-side code.  The
     *note http.cookiejar: 95. and *note http.cookies: 96. modules do
     not depend on each other.

‘https://curl.haxx.se/rfc/cookie_spec.html’

     The specification of the original Netscape cookie protocol.  Though
     this is still the dominant protocol, the ‘Netscape cookie protocol’
     implemented by all the major browsers (and *note http.cookiejar:
     95.) only bears a passing resemblance to the one sketched out in
     ‘cookie_spec.html’.

RFC 2109(8) - HTTP State Management Mechanism

     Obsoleted by RFC 2965(9).  Uses ‘Set-Cookie’ with version=1.

RFC 2965(10) - HTTP State Management Mechanism

     The Netscape protocol with the bugs fixed.  Uses ‘Set-Cookie2’ in
     place of ‘Set-Cookie’.  Not widely used.

‘http://kristol.org/cookie/errata.html’

     Unfinished errata to RFC 2965(11).

RFC 2964(12) - Use of HTTP State Management

* Menu:

* CookieJar and FileCookieJar Objects::
* FileCookieJar subclasses and co-operation with web browsers::
* CookiePolicy Objects::
* DefaultCookiePolicy Objects::
* Cookie Objects: Cookie Objects<2>.
* Examples: Examples<24>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/http/cookiejar.py

   (2) https://tools.ietf.org/html/rfc2965.html

   (3) https://tools.ietf.org/html/rfc2109.html

   (4) https://tools.ietf.org/html/rfc2965.html

   (5) https://tools.ietf.org/html/rfc2109.html

   (6) https://tools.ietf.org/html/rfc2109.html

   (7) https://tools.ietf.org/html/rfc2965.html

   (8) https://tools.ietf.org/html/rfc2109.html

   (9) https://tools.ietf.org/html/rfc2965.html

   (10) https://tools.ietf.org/html/rfc2965.html

   (11) https://tools.ietf.org/html/rfc2965.html

   (12) https://tools.ietf.org/html/rfc2964.html


File: python.info,  Node: CookieJar and FileCookieJar Objects,  Next: FileCookieJar subclasses and co-operation with web browsers,  Up: http cookiejar — Cookie handling for HTTP clients

5.22.24.1 CookieJar and FileCookieJar Objects
.............................................

*note CookieJar: 2bb0. objects support the *note iterator: f73. protocol
for iterating over contained *note Cookie: 2db4. objects.

*note CookieJar: 2bb0. has the following methods:

 -- Method: CookieJar.add_cookie_header (request)

     Add correct ‘Cookie’ header to `request'.

     If policy allows (ie.  the ‘rfc2965’ and ‘hide_cookie2’ attributes
     of the *note CookieJar: 2bb0.’s *note CookiePolicy: 2daf. instance
     are true and false respectively), the ‘Cookie2’ header is also
     added when appropriate.

     The `request' object (usually a *note urllib.request.Request: 8ea.
     instance) must support the methods ‘get_full_url()’, ‘get_host()’,
     ‘get_type()’, ‘unverifiable()’, ‘has_header()’, ‘get_header()’,
     ‘header_items()’, ‘add_unredirected_header()’ and ‘origin_req_host’
     attribute as documented by *note urllib.request: 120.

     Changed in version 3.3: `request' object needs ‘origin_req_host’
     attribute.  Dependency on a deprecated method
     ‘get_origin_req_host()’ has been removed.

 -- Method: CookieJar.extract_cookies (response, request)

     Extract cookies from HTTP `response' and store them in the *note
     CookieJar: 2bb0, where allowed by policy.

     The *note CookieJar: 2bb0. will look for allowable ‘Set-Cookie’ and
     ‘Set-Cookie2’ headers in the `response' argument, and store cookies
     as appropriate (subject to the *note CookiePolicy.set_ok(): 2db9.
     method’s approval).

     The `response' object (usually the result of a call to *note
     urllib.request.urlopen(): 780, or similar) should support an
     ‘info()’ method, which returns an *note email.message.Message: 536.
     instance.

     The `request' object (usually a *note urllib.request.Request: 8ea.
     instance) must support the methods ‘get_full_url()’, ‘get_host()’,
     ‘unverifiable()’, and ‘origin_req_host’ attribute, as documented by
     *note urllib.request: 120.  The request is used to set default
     values for cookie-attributes as well as for checking that the
     cookie is allowed to be set.

     Changed in version 3.3: `request' object needs ‘origin_req_host’
     attribute.  Dependency on a deprecated method
     ‘get_origin_req_host()’ has been removed.

 -- Method: CookieJar.set_policy (policy)

     Set the *note CookiePolicy: 2daf. instance to be used.

 -- Method: CookieJar.make_cookies (response, request)

     Return sequence of *note Cookie: 2db4. objects extracted from
     `response' object.

     See the documentation for *note extract_cookies(): 2db8. for the
     interfaces required of the `response' and `request' arguments.

 -- Method: CookieJar.set_cookie_if_ok (cookie, request)

     Set a *note Cookie: 2db4. if policy says it’s OK to do so.

 -- Method: CookieJar.set_cookie (cookie)

     Set a *note Cookie: 2db4, without checking with policy to see
     whether or not it should be set.

 -- Method: CookieJar.clear ([domain[, path[, name]]])

     Clear some cookies.

     If invoked without arguments, clear all cookies.  If given a single
     argument, only cookies belonging to that `domain' will be removed.
     If given two arguments, cookies belonging to the specified `domain'
     and URL `path' are removed.  If given three arguments, then the
     cookie with the specified `domain', `path' and `name' is removed.

     Raises *note KeyError: 2c5. if no matching cookie exists.

 -- Method: CookieJar.clear_session_cookies ()

     Discard all session cookies.

     Discards all contained cookies that have a true ‘discard’ attribute
     (usually because they had either no ‘max-age’ or ‘expires’
     cookie-attribute, or an explicit ‘discard’ cookie-attribute).  For
     interactive browsers, the end of a session usually corresponds to
     closing the browser window.

     Note that the ‘save()’ method won’t save session cookies anyway,
     unless you ask otherwise by passing a true `ignore_discard'
     argument.

*note FileCookieJar: 2dae. implements the following additional methods:

 -- Method: FileCookieJar.save (filename=None, ignore_discard=False,
          ignore_expires=False)

     Save cookies to a file.

     This base class raises *note NotImplementedError: 603.  Subclasses
     may leave this method unimplemented.

     `filename' is the name of file in which to save cookies.  If
     `filename' is not specified, ‘self.filename’ is used (whose default
     is the value passed to the constructor, if any); if ‘self.filename’
     is *note None: 157, *note ValueError: 1f9. is raised.

     `ignore_discard': save even cookies set to be discarded.
     `ignore_expires': save even cookies that have expired

     The file is overwritten if it already exists, thus wiping all the
     cookies it contains.  Saved cookies can be restored later using the
     *note load(): 2db0. or *note revert(): 2db1. methods.

 -- Method: FileCookieJar.load (filename=None, ignore_discard=False,
          ignore_expires=False)

     Load cookies from a file.

     Old cookies are kept unless overwritten by newly loaded ones.

     Arguments are as for *note save(): 2dc0.

     The named file must be in the format understood by the class, or
     *note LoadError: 2dad. will be raised.  Also, *note OSError: 1d1.
     may be raised, for example if the file does not exist.

     Changed in version 3.3: *note IOError: 986. used to be raised, it
     is now an alias of *note OSError: 1d1.

 -- Method: FileCookieJar.revert (filename=None, ignore_discard=False,
          ignore_expires=False)

     Clear all cookies and reload cookies from a saved file.

     *note revert(): 2db1. can raise the same exceptions as *note
     load(): 2db0.  If there is a failure, the object’s state will not
     be altered.

*note FileCookieJar: 2dae. instances have the following public
attributes:

 -- Attribute: FileCookieJar.filename

     Filename of default file in which to keep cookies.  This attribute
     may be assigned to.

 -- Attribute: FileCookieJar.delayload

     If true, load cookies lazily from disk.  This attribute should not
     be assigned to.  This is only a hint, since this only affects
     performance, not behaviour (unless the cookies on disk are
     changing).  A *note CookieJar: 2bb0. object may ignore it.  None of
     the *note FileCookieJar: 2dae. classes included in the standard
     library lazily loads cookies.


File: python.info,  Node: FileCookieJar subclasses and co-operation with web browsers,  Next: CookiePolicy Objects,  Prev: CookieJar and FileCookieJar Objects,  Up: http cookiejar — Cookie handling for HTTP clients

5.22.24.2 FileCookieJar subclasses and co-operation with web browsers
.....................................................................

The following *note CookieJar: 2bb0. subclasses are provided for reading
and writing.

 -- Class: http.cookiejar.MozillaCookieJar (filename, delayload=None,
          policy=None)

     A *note FileCookieJar: 2dae. that can load from and save cookies to
     disk in the Mozilla ‘cookies.txt’ file format (which is also used
     by the Lynx and Netscape browsers).

          Note: This loses information about RFC 2965(1) cookies, and
          also about newer or non-standard cookie-attributes such as
          ‘port’.

          Warning: Back up your cookies before saving if you have
          cookies whose loss / corruption would be inconvenient (there
          are some subtleties which may lead to slight changes in the
          file over a load / save round-trip).

     Also note that cookies saved while Mozilla is running will get
     clobbered by Mozilla.

 -- Class: http.cookiejar.LWPCookieJar (filename, delayload=None,
          policy=None)

     A *note FileCookieJar: 2dae. that can load from and save cookies to
     disk in format compatible with the libwww-perl library’s
     ‘Set-Cookie3’ file format.  This is convenient if you want to store
     cookies in a human-readable file.

     Changed in version 3.8: The filename parameter supports a *note
     path-like object: 35f.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2965.html


File: python.info,  Node: CookiePolicy Objects,  Next: DefaultCookiePolicy Objects,  Prev: FileCookieJar subclasses and co-operation with web browsers,  Up: http cookiejar — Cookie handling for HTTP clients

5.22.24.3 CookiePolicy Objects
..............................

Objects implementing the *note CookiePolicy: 2daf. interface have the
following methods:

 -- Method: CookiePolicy.set_ok (cookie, request)

     Return boolean value indicating whether cookie should be accepted
     from server.

     `cookie' is a *note Cookie: 2db4. instance.  `request' is an object
     implementing the interface defined by the documentation for *note
     CookieJar.extract_cookies(): 2db8.

 -- Method: CookiePolicy.return_ok (cookie, request)

     Return boolean value indicating whether cookie should be returned
     to server.

     `cookie' is a *note Cookie: 2db4. instance.  `request' is an object
     implementing the interface defined by the documentation for *note
     CookieJar.add_cookie_header(): 2db7.

 -- Method: CookiePolicy.domain_return_ok (domain, request)

     Return ‘False’ if cookies should not be returned, given cookie
     domain.

     This method is an optimization.  It removes the need for checking
     every cookie with a particular domain (which might involve reading
     many files).  Returning true from *note domain_return_ok(): 2dc9.
     and *note path_return_ok(): 2dca. leaves all the work to *note
     return_ok(): 2dc8.

     If *note domain_return_ok(): 2dc9. returns true for the cookie
     domain, *note path_return_ok(): 2dca. is called for the cookie
     path.  Otherwise, *note path_return_ok(): 2dca. and *note
     return_ok(): 2dc8. are never called for that cookie domain.  If
     *note path_return_ok(): 2dca. returns true, *note return_ok():
     2dc8. is called with the *note Cookie: 2db4. object itself for a
     full check.  Otherwise, *note return_ok(): 2dc8. is never called
     for that cookie path.

     Note that *note domain_return_ok(): 2dc9. is called for every
     `cookie' domain, not just for the `request' domain.  For example,
     the function might be called with both ‘".example.com"’ and
     ‘"www.example.com"’ if the request domain is ‘"www.example.com"’.
     The same goes for *note path_return_ok(): 2dca.

     The `request' argument is as documented for *note return_ok():
     2dc8.

 -- Method: CookiePolicy.path_return_ok (path, request)

     Return ‘False’ if cookies should not be returned, given cookie
     path.

     See the documentation for *note domain_return_ok(): 2dc9.

In addition to implementing the methods above, implementations of the
*note CookiePolicy: 2daf. interface must also supply the following
attributes, indicating which protocols should be used, and how.  All of
these attributes may be assigned to.

 -- Attribute: CookiePolicy.netscape

     Implement Netscape protocol.

 -- Attribute: CookiePolicy.rfc2965

     Implement RFC 2965(1) protocol.

 -- Attribute: CookiePolicy.hide_cookie2

     Don’t add ‘Cookie2’ header to requests (the presence of this header
     indicates to the server that we understand RFC 2965(2) cookies).

The most useful way to define a *note CookiePolicy: 2daf. class is by
subclassing from *note DefaultCookiePolicy: f22. and overriding some or
all of the methods above.  *note CookiePolicy: 2daf. itself may be used
as a ‘null policy’ to allow setting and receiving any and all cookies
(this is unlikely to be useful).

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2965.html

   (2) https://tools.ietf.org/html/rfc2965.html


File: python.info,  Node: DefaultCookiePolicy Objects,  Next: Cookie Objects<2>,  Prev: CookiePolicy Objects,  Up: http cookiejar — Cookie handling for HTTP clients

5.22.24.4 DefaultCookiePolicy Objects
.....................................

Implements the standard rules for accepting and returning cookies.

Both RFC 2965(1) and Netscape cookies are covered.  RFC 2965 handling is
switched off by default.

The easiest way to provide your own policy is to override this class and
call its methods in your overridden implementations before adding your
own additional checks:

     import http.cookiejar class MyCookiePolicy(http.cookiejar.DefaultCookiePolicy):     def set_ok(self, cookie, request):         if not http.cookiejar.DefaultCookiePolicy.set_ok(self, cookie, request):             return False         if i_dont_want_to_store_this_cookie(cookie):             return False         return True

In addition to the features required to implement the *note
CookiePolicy: 2daf. interface, this class allows you to block and allow
domains from setting and receiving cookies.  There are also some
strictness switches that allow you to tighten up the rather loose
Netscape protocol rules a little bit (at the cost of blocking some
benign cookies).

A domain blacklist and whitelist is provided (both off by default).
Only domains not in the blacklist and present in the whitelist (if the
whitelist is active) participate in cookie setting and returning.  Use
the `blocked_domains' constructor argument, and ‘blocked_domains()’ and
‘set_blocked_domains()’ methods (and the corresponding argument and
methods for `allowed_domains').  If you set a whitelist, you can turn it
off again by setting it to *note None: 157.

Domains in block or allow lists that do not start with a dot must equal
the cookie domain to be matched.  For example, ‘"example.com"’ matches a
blacklist entry of ‘"example.com"’, but ‘"www.example.com"’ does not.
Domains that do start with a dot are matched by more specific domains
too.  For example, both ‘"www.example.com"’ and
‘"www.coyote.example.com"’ match ‘".example.com"’ (but ‘"example.com"’
itself does not).  IP addresses are an exception, and must match
exactly.  For example, if blocked_domains contains ‘"192.168.1.2"’ and
‘".168.1.2"’, 192.168.1.2 is blocked, but 193.168.1.2 is not.

*note DefaultCookiePolicy: f22. implements the following additional
methods:

 -- Method: DefaultCookiePolicy.blocked_domains ()

     Return the sequence of blocked domains (as a tuple).

 -- Method: DefaultCookiePolicy.set_blocked_domains (blocked_domains)

     Set the sequence of blocked domains.

 -- Method: DefaultCookiePolicy.is_blocked (domain)

     Return whether `domain' is on the blacklist for setting or
     receiving cookies.

 -- Method: DefaultCookiePolicy.allowed_domains ()

     Return *note None: 157, or the sequence of allowed domains (as a
     tuple).

 -- Method: DefaultCookiePolicy.set_allowed_domains (allowed_domains)

     Set the sequence of allowed domains, or *note None: 157.

 -- Method: DefaultCookiePolicy.is_not_allowed (domain)

     Return whether `domain' is not on the whitelist for setting or
     receiving cookies.

*note DefaultCookiePolicy: f22. instances have the following attributes,
which are all initialised from the constructor arguments of the same
name, and which may all be assigned to.

 -- Attribute: DefaultCookiePolicy.rfc2109_as_netscape

     If true, request that the *note CookieJar: 2bb0. instance downgrade
     RFC 2109(2) cookies (ie.  cookies received in a ‘Set-Cookie’ header
     with a version cookie-attribute of 1) to Netscape cookies by
     setting the version attribute of the *note Cookie: 2db4. instance
     to 0.  The default value is *note None: 157, in which case RFC 2109
     cookies are downgraded if and only if RFC 2965(3) handling is
     turned off.  Therefore, RFC 2109 cookies are downgraded by default.

General strictness switches:

 -- Attribute: DefaultCookiePolicy.strict_domain

     Don’t allow sites to set two-component domains with country-code
     top-level domains like ‘.co.uk’, ‘.gov.uk’, ‘.co.nz’.etc.  This is
     far from perfect and isn’t guaranteed to work!

RFC 2965(4) protocol strictness switches:

 -- Attribute: DefaultCookiePolicy.strict_rfc2965_unverifiable

     Follow RFC 2965(5) rules on unverifiable transactions (usually, an
     unverifiable transaction is one resulting from a redirect or a
     request for an image hosted on another site).  If this is false,
     cookies are `never' blocked on the basis of verifiability

Netscape protocol strictness switches:

 -- Attribute: DefaultCookiePolicy.strict_ns_unverifiable

     Apply RFC 2965(6) rules on unverifiable transactions even to
     Netscape cookies.

 -- Attribute: DefaultCookiePolicy.strict_ns_domain

     Flags indicating how strict to be with domain-matching rules for
     Netscape cookies.  See below for acceptable values.

 -- Attribute: DefaultCookiePolicy.strict_ns_set_initial_dollar

     Ignore cookies in Set-Cookie: headers that have names starting with
     ‘'$'’.

 -- Attribute: DefaultCookiePolicy.strict_ns_set_path

     Don’t allow setting cookies whose path doesn’t path-match request
     URI.

‘strict_ns_domain’ is a collection of flags.  Its value is constructed
by or-ing together (for example,
‘DomainStrictNoDots|DomainStrictNonDomain’ means both flags are set).

 -- Attribute: DefaultCookiePolicy.DomainStrictNoDots

     When setting cookies, the ‘host prefix’ must not contain a dot (eg.
     ‘www.foo.bar.com’ can’t set a cookie for ‘.bar.com’, because
     ‘www.foo’ contains a dot).

 -- Attribute: DefaultCookiePolicy.DomainStrictNonDomain

     Cookies that did not explicitly specify a ‘domain’ cookie-attribute
     can only be returned to a domain equal to the domain that set the
     cookie (eg.  ‘spam.example.com’ won’t be returned cookies from
     ‘example.com’ that had no ‘domain’ cookie-attribute).

 -- Attribute: DefaultCookiePolicy.DomainRFC2965Match

     When setting cookies, require a full RFC 2965(7) domain-match.

The following attributes are provided for convenience, and are the most
useful combinations of the above flags:

 -- Attribute: DefaultCookiePolicy.DomainLiberal

     Equivalent to 0 (ie.  all of the above Netscape domain strictness
     flags switched off).

 -- Attribute: DefaultCookiePolicy.DomainStrict

     Equivalent to ‘DomainStrictNoDots|DomainStrictNonDomain’.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2965.html

   (2) https://tools.ietf.org/html/rfc2109.html

   (3) https://tools.ietf.org/html/rfc2965.html

   (4) https://tools.ietf.org/html/rfc2965.html

   (5) https://tools.ietf.org/html/rfc2965.html

   (6) https://tools.ietf.org/html/rfc2965.html

   (7) https://tools.ietf.org/html/rfc2965.html


File: python.info,  Node: Cookie Objects<2>,  Next: Examples<24>,  Prev: DefaultCookiePolicy Objects,  Up: http cookiejar — Cookie handling for HTTP clients

5.22.24.5 Cookie Objects
........................

*note Cookie: 2db4. instances have Python attributes roughly
corresponding to the standard cookie-attributes specified in the various
cookie standards.  The correspondence is not one-to-one, because there
are complicated rules for assigning default values, because the
‘max-age’ and ‘expires’ cookie-attributes contain equivalent
information, and because RFC 2109(1) cookies may be ‘downgraded’ by
*note http.cookiejar: 95. from version 1 to version 0 (Netscape)
cookies.

Assignment to these attributes should not be necessary other than in
rare circumstances in a *note CookiePolicy: 2daf. method.  The class
does not enforce internal consistency, so you should know what you’re
doing if you do that.

 -- Attribute: Cookie.version

     Integer or *note None: 157.  Netscape cookies have *note version:
     2de2. 0.  RFC 2965(2) and RFC 2109(3) cookies have a ‘version’
     cookie-attribute of 1.  However, note that *note http.cookiejar:
     95. may ‘downgrade’ RFC 2109 cookies to Netscape cookies, in which
     case *note version: 2de2. is 0.

 -- Attribute: Cookie.name

     Cookie name (a string).

 -- Attribute: Cookie.value

     Cookie value (a string), or *note None: 157.

 -- Attribute: Cookie.port

     String representing a port or a set of ports (eg.  ‘80’, or
     ‘80,8080’), or *note None: 157.

 -- Attribute: Cookie.path

     Cookie path (a string, eg.  ‘'/acme/rocket_launchers'’).

 -- Attribute: Cookie.secure

     ‘True’ if cookie should only be returned over a secure connection.

 -- Attribute: Cookie.expires

     Integer expiry date in seconds since epoch, or *note None: 157.
     See also the *note is_expired(): 2de9. method.

 -- Attribute: Cookie.discard

     ‘True’ if this is a session cookie.

 -- Attribute: Cookie.comment

     String comment from the server explaining the function of this
     cookie, or *note None: 157.

 -- Attribute: Cookie.comment_url

     URL linking to a comment from the server explaining the function of
     this cookie, or *note None: 157.

 -- Attribute: Cookie.rfc2109

     ‘True’ if this cookie was received as an RFC 2109(4) cookie (ie.
     the cookie arrived in a ‘Set-Cookie’ header, and the value of the
     Version cookie-attribute in that header was 1).  This attribute is
     provided because *note http.cookiejar: 95. may ‘downgrade’ RFC 2109
     cookies to Netscape cookies, in which case *note version: 2de2. is
     0.

 -- Attribute: Cookie.port_specified

     ‘True’ if a port or set of ports was explicitly specified by the
     server (in the ‘Set-Cookie’ / ‘Set-Cookie2’ header).

 -- Attribute: Cookie.domain_specified

     ‘True’ if a domain was explicitly specified by the server.

 -- Attribute: Cookie.domain_initial_dot

     ‘True’ if the domain explicitly specified by the server began with
     a dot (‘'.'’).

Cookies may have additional non-standard cookie-attributes.  These may
be accessed using the following methods:

 -- Method: Cookie.has_nonstandard_attr (name)

     Return ‘True’ if cookie has the named cookie-attribute.

 -- Method: Cookie.get_nonstandard_attr (name, default=None)

     If cookie has the named cookie-attribute, return its value.
     Otherwise, return `default'.

 -- Method: Cookie.set_nonstandard_attr (name, value)

     Set the value of the named cookie-attribute.

The *note Cookie: 2db4. class also defines the following method:

 -- Method: Cookie.is_expired (now=None)

     ‘True’ if cookie has passed the time at which the server requested
     it should expire.  If `now' is given (in seconds since the epoch),
     return whether the cookie has expired at the specified time.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2109.html

   (2) https://tools.ietf.org/html/rfc2965.html

   (3) https://tools.ietf.org/html/rfc2109.html

   (4) https://tools.ietf.org/html/rfc2109.html


File: python.info,  Node: Examples<24>,  Prev: Cookie Objects<2>,  Up: http cookiejar — Cookie handling for HTTP clients

5.22.24.6 Examples
..................

The first example shows the most common usage of *note http.cookiejar:
95.:

     import http.cookiejar, urllib.request cj = http.cookiejar.CookieJar() opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj)) r = opener.open("http://example.com/")

This example illustrates how to open a URL using your Netscape, Mozilla,
or Lynx cookies (assumes Unix/Netscape convention for location of the
cookies file):

     import os, http.cookiejar, urllib.request cj = http.cookiejar.MozillaCookieJar() cj.load(os.path.join(os.path.expanduser("~"), ".netscape", "cookies.txt")) opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj)) r = opener.open("http://example.com/")

The next example illustrates the use of *note DefaultCookiePolicy: f22.
Turn on RFC 2965(1) cookies, be more strict about domains when setting
and returning Netscape cookies, and block some domains from setting
cookies or having them returned:

     import urllib.request from http.cookiejar import CookieJar, DefaultCookiePolicy policy = DefaultCookiePolicy(     rfc2965=True, strict_ns_domain=Policy.DomainStrict,     blocked_domains=["ads.net", ".ads.net"]) cj = CookieJar(policy) opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj)) r = opener.open("http://example.com/")

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2965.html


File: python.info,  Node: xmlrpc — XMLRPC server and client modules,  Next: xmlrpc client — XML-RPC client access,  Prev: http cookiejar — Cookie handling for HTTP clients,  Up: Internet Protocols and Support

5.22.25 ‘xmlrpc’ — XMLRPC server and client modules
---------------------------------------------------

XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP
as a transport.  With it, a client can call methods with parameters on a
remote server (the server is named by a URI) and get back structured
data.

‘xmlrpc’ is a package that collects server and client modules
implementing XML-RPC. The modules are:

   * *note xmlrpc.client: 13f.

   * *note xmlrpc.server: 140.


File: python.info,  Node: xmlrpc client — XML-RPC client access,  Next: xmlrpc server — Basic XML-RPC servers,  Prev: xmlrpc — XMLRPC server and client modules,  Up: Internet Protocols and Support

5.22.26 ‘xmlrpc.client’ — XML-RPC client access
-----------------------------------------------

`Source code:' Lib/xmlrpc/client.py(1)

__________________________________________________________________

XML-RPC is a Remote Procedure Call method that uses XML passed via
HTTP(S) as a transport.  With it, a client can call methods with
parameters on a remote server (the server is named by a URI) and get
back structured data.  This module supports writing XML-RPC client code;
it handles all the details of translating between conformable Python
objects and XML on the wire.

     Warning: The *note xmlrpc.client: 13f. module is not secure against
     maliciously constructed data.  If you need to parse untrusted or
     unauthenticated data see *note XML vulnerabilities: 292c.

Changed in version 3.5: For HTTPS URIs, *note xmlrpc.client: 13f. now
performs all the necessary certificate and hostname checks by default.

 -- Class: xmlrpc.client.ServerProxy (uri, transport=None,
          encoding=None, verbose=False, allow_none=False,
          use_datetime=False, use_builtin_types=False, *, headers=(),
          context=None)

     A *note ServerProxy: 253. instance is an object that manages
     communication with a remote XML-RPC server.  The required first
     argument is a URI (Uniform Resource Indicator), and will normally
     be the URL of the server.  The optional second argument is a
     transport factory instance; by default it is an internal
     ‘SafeTransport’ instance for https: URLs and an internal HTTP
     ‘Transport’ instance otherwise.  The optional third argument is an
     encoding, by default UTF-8.  The optional fourth argument is a
     debugging flag.

     The following parameters govern the use of the returned proxy
     instance.  If `allow_none' is true, the Python constant ‘None’ will
     be translated into XML; the default behaviour is for ‘None’ to
     raise a *note TypeError: 192.  This is a commonly-used extension to
     the XML-RPC specification, but isn’t supported by all clients and
     servers; see http://ontosys.com/xml-rpc/extensions.php(2) for a
     description.  The `use_builtin_types' flag can be used to cause
     date/time values to be presented as *note datetime.datetime: 194.
     objects and binary data to be presented as *note bytes: 326.
     objects; this flag is false by default.  *note datetime.datetime:
     194, *note bytes: 326. and *note bytearray: 327. objects may be
     passed to calls.  The `headers' parameter is an optional sequence
     of HTTP headers to send with each request, expressed as a sequence
     of 2-tuples representing the header name and value.  (e.g.
     ‘[(‘Header-Name’, ‘value’)]’).  The obsolete `use_datetime' flag is
     similar to `use_builtin_types' but it applies only to date/time
     values.

Changed in version 3.3: The `use_builtin_types' flag was added.

Changed in version 3.8: The `headers' parameter was added.

Both the HTTP and HTTPS transports support the URL syntax extension for
HTTP Basic Authentication: ‘http://user:pass@host:port/path’.  The
‘user:pass’ portion will be base64-encoded as an HTTP ‘Authorization’
header, and sent to the remote server as part of the connection process
when invoking an XML-RPC method.  You only need to use this if the
remote server requires a Basic Authentication user and password.  If an
HTTPS URL is provided, `context' may be *note ssl.SSLContext: 3d9. and
configures the SSL settings of the underlying HTTPS connection.

The returned instance is a proxy object with methods that can be used to
invoke corresponding RPC calls on the remote server.  If the remote
server supports the introspection API, the proxy can also be used to
query the remote server for the methods it supports (service discovery)
and fetch other server-associated metadata.

Types that are conformable (e.g.  that can be marshalled through XML),
include the following (and except where noted, they are unmarshalled as
the same Python type):

XML-RPC type               Python type
                           
---------------------------------------------------------------------------------------
                           
‘boolean’                  *note bool: 183.
                           
                           
‘int’, ‘i1’, ‘i2’, ‘i4’,   *note int: 184. in range from -2147483648 to 2147483647.
‘i8’ or ‘biginteger’       Values get the ‘<int>’ tag.
                           
                           
‘double’ or ‘float’        *note float: 187.  Values get the ‘<double>’ tag.
                           
                           
‘string’                   *note str: 325.
                           
                           
‘array’                    *note list: 260. or *note tuple: 473. containing
                           conformable elements.  Arrays are returned as
                           *note lists: 260.
                           
                           
‘struct’                   *note dict: 1b6.  Keys must be strings, values may be any
                           conformable type.  Objects of user-defined classes can be
                           passed in; only their *note __dict__: 4f1. attribute is
                           transmitted.
                           
                           
‘dateTime.iso8601’         *note DateTime: 2df9. or *note datetime.datetime: 194.
                           Returned type depends on values of `use_builtin_types'
                           and `use_datetime' flags.
                           
                           
‘base64’                   *note Binary: 2dfa, *note bytes: 326. or
                           *note bytearray: 327.  Returned type depends on the value
                           of the `use_builtin_types' flag.
                           
                           
‘nil’                      The ‘None’ constant.  Passing is allowed only if
                           `allow_none' is true.
                           
                           
‘bigdecimal’               *note decimal.Decimal: 188.  Returned type only.
                           

This is the full set of data types supported by XML-RPC. Method calls
may also raise a special *note Fault: 2dfb. instance, used to signal
XML-RPC server errors, or *note ProtocolError: 2dfc. used to signal an
error in the HTTP/HTTPS transport layer.  Both *note Fault: 2dfb. and
*note ProtocolError: 2dfc. derive from a base class called ‘Error’.
Note that the xmlrpc client module currently does not marshal instances
of subclasses of built-in types.

When passing strings, characters special to XML such as ‘<’, ‘>’, and
‘&’ will be automatically escaped.  However, it’s the caller’s
responsibility to ensure that the string is free of characters that
aren’t allowed in XML, such as the control characters with ASCII values
between 0 and 31 (except, of course, tab, newline and carriage return);
failing to do this will result in an XML-RPC request that isn’t
well-formed XML. If you have to pass arbitrary bytes via XML-RPC, use
*note bytes: 326. or *note bytearray: 327. classes or the *note Binary:
2dfa. wrapper class described below.

‘Server’ is retained as an alias for *note ServerProxy: 253. for
backwards compatibility.  New code should use *note ServerProxy: 253.

Changed in version 3.5: Added the `context' argument.

Changed in version 3.6: Added support of type tags with prefixes (e.g.
‘ex:nil’).  Added support of unmarshalling additional types used by
Apache XML-RPC implementation for numerics: ‘i1’, ‘i2’, ‘i8’,
‘biginteger’, ‘float’ and ‘bigdecimal’.  See
‘http://ws.apache.org/xmlrpc/types.html’ for a description.

See also
........

XML-RPC HOWTO(3)

     A good description of XML-RPC operation and client software in
     several languages.  Contains pretty much everything an XML-RPC
     client developer needs to know.

XML-RPC Introspection(4)

     Describes the XML-RPC protocol extension for introspection.

XML-RPC Specification(5)

     The official specification.

Unofficial XML-RPC Errata(6)

     Fredrik Lundh’s “unofficial errata, intended to clarify certain
     details in the XML-RPC specification, as well as hint at ‘best
     practices’ to use when designing your own XML-RPC implementations.”

* Menu:

* ServerProxy Objects::
* DateTime Objects::
* Binary Objects::
* Fault Objects::
* ProtocolError Objects::
* MultiCall Objects::
* Convenience Functions::
* Example of Client Usage::
* Example of Client and Server Usage::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/xmlrpc/client.py

   (2) 
https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php

   (3) http://www.tldp.org/HOWTO/XML-RPC-HOWTO/index.html

   (4) http://xmlrpc-c.sourceforge.net/introspection.html

   (5) http://xmlrpc.scripting.com/spec.html

   (6) http://effbot.org/zone/xmlrpc-errata.htm


File: python.info,  Node: ServerProxy Objects,  Next: DateTime Objects,  Up: xmlrpc client — XML-RPC client access

5.22.26.1 ServerProxy Objects
.............................

A *note ServerProxy: 253. instance has a method corresponding to each
remote procedure call accepted by the XML-RPC server.  Calling the
method performs an RPC, dispatched by both name and argument signature
(e.g.  the same method name can be overloaded with multiple argument
signatures).  The RPC finishes by returning a value, which may be either
returned data in a conformant type or a *note Fault: 2dfb. or *note
ProtocolError: 2dfc. object indicating an error.

Servers that support the XML introspection API support some common
methods grouped under the reserved ‘system’ attribute:

 -- Method: ServerProxy.system.listMethods ()

     This method returns a list of strings, one for each (non-system)
     method supported by the XML-RPC server.

 -- Method: ServerProxy.system.methodSignature (name)

     This method takes one parameter, the name of a method implemented
     by the XML-RPC server.  It returns an array of possible signatures
     for this method.  A signature is an array of types.  The first of
     these types is the return type of the method, the rest are
     parameters.

     Because multiple signatures (ie.  overloading) is permitted, this
     method returns a list of signatures rather than a singleton.

     Signatures themselves are restricted to the top level parameters
     expected by a method.  For instance if a method expects one array
     of structs as a parameter, and it returns a string, its signature
     is simply “string, array”.  If it expects three integers and
     returns a string, its signature is “string, int, int, int”.

     If no signature is defined for the method, a non-array value is
     returned.  In Python this means that the type of the returned value
     will be something other than list.

 -- Method: ServerProxy.system.methodHelp (name)

     This method takes one parameter, the name of a method implemented
     by the XML-RPC server.  It returns a documentation string
     describing the use of that method.  If no such string is available,
     an empty string is returned.  The documentation string may contain
     HTML markup.

Changed in version 3.5: Instances of *note ServerProxy: 253. support the
*note context manager: 55d. protocol for closing the underlying
transport.

A working example follows.  The server code:

     from xmlrpc.server import SimpleXMLRPCServer  def is_even(n):     return n % 2 == 0  server = SimpleXMLRPCServer(("localhost", 8000)) print("Listening on port 8000...") server.register_function(is_even, "is_even") server.serve_forever()

The client code for the preceding server:

     import xmlrpc.client  with xmlrpc.client.ServerProxy("http://localhost:8000/") as proxy:     print("3 is even: %s" % str(proxy.is_even(3)))     print("100 is even: %s" % str(proxy.is_even(100)))


File: python.info,  Node: DateTime Objects,  Next: Binary Objects,  Prev: ServerProxy Objects,  Up: xmlrpc client — XML-RPC client access

5.22.26.2 DateTime Objects
..........................

 -- Class: xmlrpc.client.DateTime

     This class may be initialized with seconds since the epoch, a time
     tuple, an ISO 8601 time/date string, or a *note datetime.datetime:
     194. instance.  It has the following methods, supported mainly for
     internal use by the marshalling/unmarshalling code:

      -- Method: decode (string)

          Accept a string as the instance’s new time value.

      -- Method: encode (out)

          Write the XML-RPC encoding of this *note DateTime: 2df9. item
          to the `out' stream object.

     It also supports certain of Python’s built-in operators through
     rich comparison and *note __repr__(): 333. methods.

A working example follows.  The server code:

     import datetime from xmlrpc.server import SimpleXMLRPCServer import xmlrpc.client  def today():     today = datetime.datetime.today()     return xmlrpc.client.DateTime(today)  server = SimpleXMLRPCServer(("localhost", 8000)) print("Listening on port 8000...") server.register_function(today, "today") server.serve_forever()

The client code for the preceding server:

     import xmlrpc.client import datetime  proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")  today = proxy.today() # convert the ISO8601 string to a datetime object converted = datetime.datetime.strptime(today.value, "%Y%m%dT%H:%M:%S") print("Today: %s" % converted.strftime("%d.%m.%Y, %H:%M"))


File: python.info,  Node: Binary Objects,  Next: Fault Objects,  Prev: DateTime Objects,  Up: xmlrpc client — XML-RPC client access

5.22.26.3 Binary Objects
........................

 -- Class: xmlrpc.client.Binary

     This class may be initialized from bytes data (which may include
     NULs).  The primary access to the content of a *note Binary: 2dfa.
     object is provided by an attribute:

      -- Attribute: data

          The binary data encapsulated by the *note Binary: 2dfa.
          instance.  The data is provided as a *note bytes: 326. object.

     *note Binary: 2dfa. objects have the following methods, supported
     mainly for internal use by the marshalling/unmarshalling code:

      -- Method: decode (bytes)

          Accept a base64 *note bytes: 326. object and decode it as the
          instance’s new data.

      -- Method: encode (out)

          Write the XML-RPC base 64 encoding of this binary item to the
          `out' stream object.

          The encoded data will have newlines every 76 characters as per
          RFC 2045 section 6.8(1), which was the de facto standard
          base64 specification when the XML-RPC spec was written.

     It also supports certain of Python’s built-in operators through
     *note __eq__(): 334. and *note __ne__(): e49. methods.

Example usage of the binary objects.  We’re going to transfer an image
over XMLRPC:

     from xmlrpc.server import SimpleXMLRPCServer import xmlrpc.client  def python_logo():     with open("python_logo.jpg", "rb") as handle:         return xmlrpc.client.Binary(handle.read())  server = SimpleXMLRPCServer(("localhost", 8000)) print("Listening on port 8000...") server.register_function(python_logo, 'python_logo')  server.serve_forever()

The client gets the image and saves it to a file:

     import xmlrpc.client  proxy = xmlrpc.client.ServerProxy("http://localhost:8000/") with open("fetched_python_logo.jpg", "wb") as handle:     handle.write(proxy.python_logo().data)

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2045.html#section-6.8


File: python.info,  Node: Fault Objects,  Next: ProtocolError Objects,  Prev: Binary Objects,  Up: xmlrpc client — XML-RPC client access

5.22.26.4 Fault Objects
.......................

 -- Class: xmlrpc.client.Fault

     A *note Fault: 2dfb. object encapsulates the content of an XML-RPC
     fault tag.  Fault objects have the following attributes:

      -- Attribute: faultCode

          A string indicating the fault type.

      -- Attribute: faultString

          A string containing a diagnostic message associated with the
          fault.

In the following example we’re going to intentionally cause a *note
Fault: 2dfb. by returning a complex type object.  The server code:

     from xmlrpc.server import SimpleXMLRPCServer  # A marshalling error is going to occur because we're returning a # complex number def add(x, y):     return x+y+0j  server = SimpleXMLRPCServer(("localhost", 8000)) print("Listening on port 8000...") server.register_function(add, 'add')  server.serve_forever()

The client code for the preceding server:

     import xmlrpc.client  proxy = xmlrpc.client.ServerProxy("http://localhost:8000/") try:     proxy.add(2, 5) except xmlrpc.client.Fault as err:     print("A fault occurred")     print("Fault code: %d" % err.faultCode)     print("Fault string: %s" % err.faultString)


File: python.info,  Node: ProtocolError Objects,  Next: MultiCall Objects,  Prev: Fault Objects,  Up: xmlrpc client — XML-RPC client access

5.22.26.5 ProtocolError Objects
...............................

 -- Class: xmlrpc.client.ProtocolError

     A *note ProtocolError: 2dfc. object describes a protocol error in
     the underlying transport layer (such as a 404 ‘not found’ error if
     the server named by the URI does not exist).  It has the following
     attributes:

      -- Attribute: url

          The URI or URL that triggered the error.

      -- Attribute: errcode

          The error code.

      -- Attribute: errmsg

          The error message or diagnostic string.

      -- Attribute: headers

          A dict containing the headers of the HTTP/HTTPS request that
          triggered the error.

In the following example we’re going to intentionally cause a *note
ProtocolError: 2dfc. by providing an invalid URI:

     import xmlrpc.client  # create a ServerProxy with a URI that doesn't respond to XMLRPC requests proxy = xmlrpc.client.ServerProxy("http://google.com/")  try:     proxy.some_method() except xmlrpc.client.ProtocolError as err:     print("A protocol error occurred")     print("URL: %s" % err.url)     print("HTTP/HTTPS headers: %s" % err.headers)     print("Error code: %d" % err.errcode)     print("Error message: %s" % err.errmsg)


File: python.info,  Node: MultiCall Objects,  Next: Convenience Functions,  Prev: ProtocolError Objects,  Up: xmlrpc client — XML-RPC client access

5.22.26.6 MultiCall Objects
...........................

The *note MultiCall: 2e16. object provides a way to encapsulate multiple
calls to a remote server into a single request (1).

 -- Class: xmlrpc.client.MultiCall (server)

     Create an object used to boxcar method calls.  `server' is the
     eventual target of the call.  Calls can be made to the result
     object, but they will immediately return ‘None’, and only store the
     call name and parameters in the *note MultiCall: 2e16. object.
     Calling the object itself causes all stored calls to be transmitted
     as a single ‘system.multicall’ request.  The result of this call is
     a *note generator: 996.; iterating over this generator yields the
     individual results.

A usage example of this class follows.  The server code:

     from xmlrpc.server import SimpleXMLRPCServer  def add(x, y):     return x + y  def subtract(x, y):     return x - y  def multiply(x, y):     return x * y  def divide(x, y):     return x // y  # A simple server with simple arithmetic functions server = SimpleXMLRPCServer(("localhost", 8000)) print("Listening on port 8000...") server.register_multicall_functions() server.register_function(add, 'add') server.register_function(subtract, 'subtract') server.register_function(multiply, 'multiply') server.register_function(divide, 'divide') server.serve_forever()

The client code for the preceding server:

     import xmlrpc.client  proxy = xmlrpc.client.ServerProxy("http://localhost:8000/") multicall = xmlrpc.client.MultiCall(proxy) multicall.add(7, 3) multicall.subtract(7, 3) multicall.multiply(7, 3) multicall.divide(7, 3) result = multicall()  print("7+3=%d, 7-3=%d, 7*3=%d, 7//3=%d" % tuple(result))

   ---------- Footnotes ----------

   (1) (1) This approach has been first presented in a discussion on
xmlrpc.com
(https://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic).


File: python.info,  Node: Convenience Functions,  Next: Example of Client Usage,  Prev: MultiCall Objects,  Up: xmlrpc client — XML-RPC client access

5.22.26.7 Convenience Functions
...............................

 -- Function: xmlrpc.client.dumps (params, methodname=None,
          methodresponse=None, encoding=None, allow_none=False)

     Convert `params' into an XML-RPC request.  or into a response if
     `methodresponse' is true.  `params' can be either a tuple of
     arguments or an instance of the *note Fault: 2dfb. exception class.
     If `methodresponse' is true, only a single value can be returned,
     meaning that `params' must be of length 1.  `encoding', if
     supplied, is the encoding to use in the generated XML; the default
     is UTF-8.  Python’s *note None: 157. value cannot be used in
     standard XML-RPC; to allow using it via an extension, provide a
     true value for `allow_none'.

 -- Function: xmlrpc.client.loads (data, use_datetime=False,
          use_builtin_types=False)

     Convert an XML-RPC request or response into Python objects, a
     ‘(params, methodname)’.  `params' is a tuple of argument;
     `methodname' is a string, or ‘None’ if no method name is present in
     the packet.  If the XML-RPC packet represents a fault condition,
     this function will raise a *note Fault: 2dfb. exception.  The
     `use_builtin_types' flag can be used to cause date/time values to
     be presented as *note datetime.datetime: 194. objects and binary
     data to be presented as *note bytes: 326. objects; this flag is
     false by default.

     The obsolete `use_datetime' flag is similar to `use_builtin_types'
     but it applies only to date/time values.

     Changed in version 3.3: The `use_builtin_types' flag was added.


File: python.info,  Node: Example of Client Usage,  Next: Example of Client and Server Usage,  Prev: Convenience Functions,  Up: xmlrpc client — XML-RPC client access

5.22.26.8 Example of Client Usage
.................................

     # simple test program (from the XML-RPC specification) from xmlrpc.client import ServerProxy, Error  # server = ServerProxy("http://localhost:8000") # local server with ServerProxy("http://betty.userland.com") as proxy:      print(proxy)      try:         print(proxy.examples.getStateName(41))     except Error as v:         print("ERROR", v)

To access an XML-RPC server through a HTTP proxy, you need to define a
custom transport.  The following example shows how:

     import http.client import xmlrpc.client  class ProxiedTransport(xmlrpc.client.Transport):      def set_proxy(self, host, port=None, headers=None):         self.proxy = host, port         self.proxy_headers = headers      def make_connection(self, host):         connection = http.client.HTTPConnection(*self.proxy)         connection.set_tunnel(host, headers=self.proxy_headers)         self._connection = host, connection         return connection  transport = ProxiedTransport() transport.set_proxy('proxy-server', 8080) server = xmlrpc.client.ServerProxy('http://betty.userland.com', transport=transport) print(server.examples.getStateName(41))


File: python.info,  Node: Example of Client and Server Usage,  Prev: Example of Client Usage,  Up: xmlrpc client — XML-RPC client access

5.22.26.9 Example of Client and Server Usage
............................................

See *note SimpleXMLRPCServer Example: 2e1d.


File: python.info,  Node: xmlrpc server — Basic XML-RPC servers,  Next: ipaddress — IPv4/IPv6 manipulation library,  Prev: xmlrpc client — XML-RPC client access,  Up: Internet Protocols and Support

5.22.27 ‘xmlrpc.server’ — Basic XML-RPC servers
-----------------------------------------------

`Source code:' Lib/xmlrpc/server.py(1)

__________________________________________________________________

The *note xmlrpc.server: 140. module provides a basic server framework
for XML-RPC servers written in Python.  Servers can either be free
standing, using *note SimpleXMLRPCServer: 2e20, or embedded in a CGI
environment, using *note CGIXMLRPCRequestHandler: 2e21.

     Warning: The *note xmlrpc.server: 140. module is not secure against
     maliciously constructed data.  If you need to parse untrusted or
     unauthenticated data see *note XML vulnerabilities: 292c.

 -- Class: xmlrpc.server.SimpleXMLRPCServer (addr,
          requestHandler=SimpleXMLRPCRequestHandler, logRequests=True,
          allow_none=False, encoding=None, bind_and_activate=True,
          use_builtin_types=False)

     Create a new server instance.  This class provides methods for
     registration of functions that can be called by the XML-RPC
     protocol.  The `requestHandler' parameter should be a factory for
     request handler instances; it defaults to *note
     SimpleXMLRPCRequestHandler: 2e22.  The `addr' and `requestHandler'
     parameters are passed to the *note socketserver.TCPServer: 2d4b.
     constructor.  If `logRequests' is true (the default), requests will
     be logged; setting this parameter to false will turn off logging.
     The `allow_none' and `encoding' parameters are passed on to *note
     xmlrpc.client: 13f. and control the XML-RPC responses that will be
     returned from the server.  The `bind_and_activate' parameter
     controls whether ‘server_bind()’ and ‘server_activate()’ are called
     immediately by the constructor; it defaults to true.  Setting it to
     false allows code to manipulate the `allow_reuse_address' class
     variable before the address is bound.  The `use_builtin_types'
     parameter is passed to the *note loads(): 2e19. function and
     controls which types are processed when date/times values or binary
     data are received; it defaults to false.

     Changed in version 3.3: The `use_builtin_types' flag was added.

 -- Class: xmlrpc.server.CGIXMLRPCRequestHandler (allow_none=False,
          encoding=None, use_builtin_types=False)

     Create a new instance to handle XML-RPC requests in a CGI
     environment.  The `allow_none' and `encoding' parameters are passed
     on to *note xmlrpc.client: 13f. and control the XML-RPC responses
     that will be returned from the server.  The `use_builtin_types'
     parameter is passed to the *note loads(): 2e19. function and
     controls which types are processed when date/times values or binary
     data are received; it defaults to false.

     Changed in version 3.3: The `use_builtin_types' flag was added.

 -- Class: xmlrpc.server.SimpleXMLRPCRequestHandler

     Create a new request handler instance.  This request handler
     supports ‘POST’ requests and modifies logging so that the
     `logRequests' parameter to the *note SimpleXMLRPCServer: 2e20.
     constructor parameter is honored.

* Menu:

* SimpleXMLRPCServer Objects::
* CGIXMLRPCRequestHandler::
* Documenting XMLRPC server::
* DocXMLRPCServer Objects::
* DocCGIXMLRPCRequestHandler::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/xmlrpc/server.py


File: python.info,  Node: SimpleXMLRPCServer Objects,  Next: CGIXMLRPCRequestHandler,  Up: xmlrpc server — Basic XML-RPC servers

5.22.27.1 SimpleXMLRPCServer Objects
....................................

The *note SimpleXMLRPCServer: 2e20. class is based on *note
socketserver.TCPServer: 2d4b. and provides a means of creating simple,
stand alone XML-RPC servers.

 -- Method: SimpleXMLRPCServer.register_function (function=None,
          name=None)

     Register a function that can respond to XML-RPC requests.  If
     `name' is given, it will be the method name associated with
     `function', otherwise ‘function.__name__’ will be used.  `name' is
     a string, and may contain characters not legal in Python
     identifiers, including the period character.

     This method can also be used as a decorator.  When used as a
     decorator, `name' can only be given as a keyword argument to
     register `function' under `name'.  If no `name' is given,
     ‘function.__name__’ will be used.

     Changed in version 3.7: *note register_function(): 2e25. can be
     used as a decorator.

 -- Method: SimpleXMLRPCServer.register_instance (instance,
          allow_dotted_names=False)

     Register an object which is used to expose method names which have
     not been registered using *note register_function(): 2e25.  If
     `instance' contains a ‘_dispatch()’ method, it is called with the
     requested method name and the parameters from the request.  Its API
     is ‘def _dispatch(self, method, params)’ (note that `params' does
     not represent a variable argument list).  If it calls an underlying
     function to perform its task, that function is called as
     ‘func(*params)’, expanding the parameter list.  The return value
     from ‘_dispatch()’ is returned to the client as the result.  If
     `instance' does not have a ‘_dispatch()’ method, it is searched for
     an attribute matching the name of the requested method.

     If the optional `allow_dotted_names' argument is true and the
     instance does not have a ‘_dispatch()’ method, then if the
     requested method name contains periods, each component of the
     method name is searched for individually, with the effect that a
     simple hierarchical search is performed.  The value found from this
     search is then called with the parameters from the request, and the
     return value is passed back to the client.

          Warning: Enabling the `allow_dotted_names' option allows
          intruders to access your module’s global variables and may
          allow intruders to execute arbitrary code on your machine.
          Only use this option on a secure, closed network.

 -- Method: SimpleXMLRPCServer.register_introspection_functions ()

     Registers the XML-RPC introspection functions ‘system.listMethods’,
     ‘system.methodHelp’ and ‘system.methodSignature’.

 -- Method: SimpleXMLRPCServer.register_multicall_functions ()

     Registers the XML-RPC multicall function system.multicall.

 -- Attribute: SimpleXMLRPCRequestHandler.rpc_paths

     An attribute value that must be a tuple listing valid path portions
     of the URL for receiving XML-RPC requests.  Requests posted to
     other paths will result in a 404 “no such page” HTTP error.  If
     this tuple is empty, all paths will be considered valid.  The
     default value is ‘('/', '/RPC2')’.

* Menu:

* SimpleXMLRPCServer Example::


File: python.info,  Node: SimpleXMLRPCServer Example,  Up: SimpleXMLRPCServer Objects

5.22.27.2 SimpleXMLRPCServer Example
....................................

Server code:

     from xmlrpc.server import SimpleXMLRPCServer from xmlrpc.server import SimpleXMLRPCRequestHandler  # Restrict to a particular path. class RequestHandler(SimpleXMLRPCRequestHandler):     rpc_paths = ('/RPC2',)  # Create server with SimpleXMLRPCServer(('localhost', 8000),                         requestHandler=RequestHandler) as server:     server.register_introspection_functions()      # Register pow() function; this will use the value of     # pow.__name__ as the name, which is just 'pow'.     server.register_function(pow)      # Register a function under a different name     def adder_function(x, y):         return x + y     server.register_function(adder_function, 'add')      # Register an instance; all the methods of the instance are     # published as XML-RPC methods (in this case, just 'mul').     class MyFuncs:         def mul(self, x, y):             return x * y      server.register_instance(MyFuncs())      # Run the server's main loop     server.serve_forever()

The following client code will call the methods made available by the
preceding server:

     import xmlrpc.client  s = xmlrpc.client.ServerProxy('http://localhost:8000') print(s.pow(2,3))  # Returns 2**3 = 8 print(s.add(2,3))  # Returns 5 print(s.mul(5,2))  # Returns 5*2 = 10  # Print list of available methods print(s.system.listMethods())

‘register_function()’ can also be used as a decorator.  The previous
server example can register functions in a decorator way:

     from xmlrpc.server import SimpleXMLRPCServer from xmlrpc.server import SimpleXMLRPCRequestHandler  class RequestHandler(SimpleXMLRPCRequestHandler):     rpc_paths = ('/RPC2',)  with SimpleXMLRPCServer(('localhost', 8000),                         requestHandler=RequestHandler) as server:     server.register_introspection_functions()      # Register pow() function; this will use the value of     # pow.__name__ as the name, which is just 'pow'.     server.register_function(pow)      # Register a function under a different name, using     # register_function as a decorator. *name* can only be given     # as a keyword argument.     @server.register_function(name='add')     def adder_function(x, y):         return x + y      # Register a function under function.__name__.     @server.register_function     def mul(x, y):         return x * y      server.serve_forever()

The following example included in the ‘Lib/xmlrpc/server.py’ module
shows a server allowing dotted names and registering a multicall
function.

     Warning: Enabling the `allow_dotted_names' option allows intruders
     to access your module’s global variables and may allow intruders to
     execute arbitrary code on your machine.  Only use this example only
     within a secure, closed network.

     import datetime  class ExampleService:     def getData(self):         return '42'      class currentTime:         @staticmethod         def getCurrentTime():             return datetime.datetime.now()  with SimpleXMLRPCServer(("localhost", 8000)) as server:     server.register_function(pow)     server.register_function(lambda x,y: x+y, 'add')     server.register_instance(ExampleService(), allow_dotted_names=True)     server.register_multicall_functions()     print('Serving XML-RPC on localhost port 8000')     try:         server.serve_forever()     except KeyboardInterrupt:         print("\nKeyboard interrupt received, exiting.")         sys.exit(0)

This ExampleService demo can be invoked from the command line:

     python -m xmlrpc.server

The client that interacts with the above server is included in
‘Lib/xmlrpc/client.py’:

     server = ServerProxy("http://localhost:8000")  try:     print(server.currentTime.getCurrentTime()) except Error as v:     print("ERROR", v)  multi = MultiCall(server) multi.getData() multi.pow(2,9) multi.add(1,2) try:     for response in multi():         print(response) except Error as v:     print("ERROR", v)

This client which interacts with the demo XMLRPC server can be invoked
as:

     python -m xmlrpc.client


File: python.info,  Node: CGIXMLRPCRequestHandler,  Next: Documenting XMLRPC server,  Prev: SimpleXMLRPCServer Objects,  Up: xmlrpc server — Basic XML-RPC servers

5.22.27.3 CGIXMLRPCRequestHandler
.................................

The *note CGIXMLRPCRequestHandler: 2e21. class can be used to handle
XML-RPC requests sent to Python CGI scripts.

 -- Method: CGIXMLRPCRequestHandler.register_function (function=None,
          name=None)

     Register a function that can respond to XML-RPC requests.  If
     `name' is given, it will be the method name associated with
     `function', otherwise ‘function.__name__’ will be used.  `name' is
     a string, and may contain characters not legal in Python
     identifiers, including the period character.

     This method can also be used as a decorator.  When used as a
     decorator, `name' can only be given as a keyword argument to
     register `function' under `name'.  If no `name' is given,
     ‘function.__name__’ will be used.

     Changed in version 3.7: *note register_function(): 2e2c. can be
     used as a decorator.

 -- Method: CGIXMLRPCRequestHandler.register_instance (instance)

     Register an object which is used to expose method names which have
     not been registered using *note register_function(): 2e2c.  If
     instance contains a ‘_dispatch()’ method, it is called with the
     requested method name and the parameters from the request; the
     return value is returned to the client as the result.  If instance
     does not have a ‘_dispatch()’ method, it is searched for an
     attribute matching the name of the requested method; if the
     requested method name contains periods, each component of the
     method name is searched for individually, with the effect that a
     simple hierarchical search is performed.  The value found from this
     search is then called with the parameters from the request, and the
     return value is passed back to the client.

 -- Method: CGIXMLRPCRequestHandler.register_introspection_functions ()

     Register the XML-RPC introspection functions ‘system.listMethods’,
     ‘system.methodHelp’ and ‘system.methodSignature’.

 -- Method: CGIXMLRPCRequestHandler.register_multicall_functions ()

     Register the XML-RPC multicall function ‘system.multicall’.

 -- Method: CGIXMLRPCRequestHandler.handle_request (request_text=None)

     Handle an XML-RPC request.  If `request_text' is given, it should
     be the POST data provided by the HTTP server, otherwise the
     contents of stdin will be used.

Example:

     class MyFuncs:     def mul(self, x, y):         return x * y   handler = CGIXMLRPCRequestHandler() handler.register_function(pow) handler.register_function(lambda x,y: x+y, 'add') handler.register_introspection_functions() handler.register_instance(MyFuncs()) handler.handle_request()


File: python.info,  Node: Documenting XMLRPC server,  Next: DocXMLRPCServer Objects,  Prev: CGIXMLRPCRequestHandler,  Up: xmlrpc server — Basic XML-RPC servers

5.22.27.4 Documenting XMLRPC server
...................................

These classes extend the above classes to serve HTML documentation in
response to HTTP GET requests.  Servers can either be free standing,
using *note DocXMLRPCServer: ea8, or embedded in a CGI environment,
using *note DocCGIXMLRPCRequestHandler: 2e32.

 -- Class: xmlrpc.server.DocXMLRPCServer (addr,
          requestHandler=DocXMLRPCRequestHandler, logRequests=True,
          allow_none=False, encoding=None, bind_and_activate=True,
          use_builtin_types=True)

     Create a new server instance.  All parameters have the same meaning
     as for *note SimpleXMLRPCServer: 2e20.; `requestHandler' defaults
     to *note DocXMLRPCRequestHandler: 2e33.

     Changed in version 3.3: The `use_builtin_types' flag was added.

 -- Class: xmlrpc.server.DocCGIXMLRPCRequestHandler

     Create a new instance to handle XML-RPC requests in a CGI
     environment.

 -- Class: xmlrpc.server.DocXMLRPCRequestHandler

     Create a new request handler instance.  This request handler
     supports XML-RPC POST requests, documentation GET requests, and
     modifies logging so that the `logRequests' parameter to the *note
     DocXMLRPCServer: ea8. constructor parameter is honored.


File: python.info,  Node: DocXMLRPCServer Objects,  Next: DocCGIXMLRPCRequestHandler,  Prev: Documenting XMLRPC server,  Up: xmlrpc server — Basic XML-RPC servers

5.22.27.5 DocXMLRPCServer Objects
.................................

The *note DocXMLRPCServer: ea8. class is derived from *note
SimpleXMLRPCServer: 2e20. and provides a means of creating
self-documenting, stand alone XML-RPC servers.  HTTP POST requests are
handled as XML-RPC method calls.  HTTP GET requests are handled by
generating pydoc-style HTML documentation.  This allows a server to
provide its own web-based documentation.

 -- Method: DocXMLRPCServer.set_server_title (server_title)

     Set the title used in the generated HTML documentation.  This title
     will be used inside the HTML “title” element.

 -- Method: DocXMLRPCServer.set_server_name (server_name)

     Set the name used in the generated HTML documentation.  This name
     will appear at the top of the generated documentation inside a “h1”
     element.

 -- Method: DocXMLRPCServer.set_server_documentation
          (server_documentation)

     Set the description used in the generated HTML documentation.  This
     description will appear as a paragraph, below the server name, in
     the documentation.


File: python.info,  Node: DocCGIXMLRPCRequestHandler,  Prev: DocXMLRPCServer Objects,  Up: xmlrpc server — Basic XML-RPC servers

5.22.27.6 DocCGIXMLRPCRequestHandler
....................................

The *note DocCGIXMLRPCRequestHandler: 2e32. class is derived from *note
CGIXMLRPCRequestHandler: 2e21. and provides a means of creating
self-documenting, XML-RPC CGI scripts.  HTTP POST requests are handled
as XML-RPC method calls.  HTTP GET requests are handled by generating
pydoc-style HTML documentation.  This allows a server to provide its own
web-based documentation.

 -- Method: DocCGIXMLRPCRequestHandler.set_server_title (server_title)

     Set the title used in the generated HTML documentation.  This title
     will be used inside the HTML “title” element.

 -- Method: DocCGIXMLRPCRequestHandler.set_server_name (server_name)

     Set the name used in the generated HTML documentation.  This name
     will appear at the top of the generated documentation inside a “h1”
     element.

 -- Method: DocCGIXMLRPCRequestHandler.set_server_documentation
          (server_documentation)

     Set the description used in the generated HTML documentation.  This
     description will appear as a paragraph, below the server name, in
     the documentation.


File: python.info,  Node: ipaddress — IPv4/IPv6 manipulation library,  Prev: xmlrpc server — Basic XML-RPC servers,  Up: Internet Protocols and Support

5.22.28 ‘ipaddress’ — IPv4/IPv6 manipulation library
----------------------------------------------------

`Source code:' Lib/ipaddress.py(1)

__________________________________________________________________

*note ipaddress: a2. provides the capabilities to create, manipulate and
operate on IPv4 and IPv6 addresses and networks.

The functions and classes in this module make it straightforward to
handle various tasks related to IP addresses, including checking whether
or not two hosts are on the same subnet, iterating over all hosts in a
particular subnet, checking whether or not a string represents a valid
IP address or network definition, and so on.

This is the full module API reference—for an overview and introduction,
see *note An introduction to the ipaddress module: 2e3f.

New in version 3.3.

* Menu:

* Convenience factory functions::
* IP Addresses::
* IP Network definitions::
* Interface objects::
* Other Module Level Functions::
* Custom Exceptions::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/ipaddress.py


File: python.info,  Node: Convenience factory functions,  Next: IP Addresses,  Up: ipaddress — IPv4/IPv6 manipulation library

5.22.28.1 Convenience factory functions
.......................................

The *note ipaddress: a2. module provides factory functions to
conveniently create IP addresses, networks and interfaces:

 -- Function: ipaddress.ip_address (address)

     Return an *note IPv4Address: 2e42. or *note IPv6Address: 2e43.
     object depending on the IP address passed as argument.  Either IPv4
     or IPv6 addresses may be supplied; integers less than 2**32 will be
     considered to be IPv4 by default.  A *note ValueError: 1f9. is
     raised if `address' does not represent a valid IPv4 or IPv6
     address.

          >>> ipaddress.ip_address('192.168.0.1') IPv4Address('192.168.0.1') >>> ipaddress.ip_address('2001:db8::') IPv6Address('2001:db8::')

 -- Function: ipaddress.ip_network (address, strict=True)

     Return an *note IPv4Network: 395. or *note IPv6Network: 394. object
     depending on the IP address passed as argument.  `address' is a
     string or integer representing the IP network.  Either IPv4 or IPv6
     networks may be supplied; integers less than 2**32 will be
     considered to be IPv4 by default.  `strict' is passed to *note
     IPv4Network: 395. or *note IPv6Network: 394. constructor.  A *note
     ValueError: 1f9. is raised if `address' does not represent a valid
     IPv4 or IPv6 address, or if the network has host bits set.

          >>> ipaddress.ip_network('192.168.0.0/28') IPv4Network('192.168.0.0/28')

 -- Function: ipaddress.ip_interface (address)

     Return an *note IPv4Interface: 2e46. or *note IPv6Interface: 2e47.
     object depending on the IP address passed as argument.  `address'
     is a string or integer representing the IP address.  Either IPv4 or
     IPv6 addresses may be supplied; integers less than 2**32 will be
     considered to be IPv4 by default.  A *note ValueError: 1f9. is
     raised if `address' does not represent a valid IPv4 or IPv6
     address.

One downside of these convenience functions is that the need to handle
both IPv4 and IPv6 formats means that error messages provide minimal
information on the precise error, as the functions don’t know whether
the IPv4 or IPv6 format was intended.  More detailed error reporting can
be obtained by calling the appropriate version specific class
constructors directly.


File: python.info,  Node: IP Addresses,  Next: IP Network definitions,  Prev: Convenience factory functions,  Up: ipaddress — IPv4/IPv6 manipulation library

5.22.28.2 IP Addresses
......................

* Menu:

* Address objects::
* Conversion to Strings and Integers::
* Operators: Operators<3>.


File: python.info,  Node: Address objects,  Next: Conversion to Strings and Integers,  Up: IP Addresses

5.22.28.3 Address objects
.........................

The *note IPv4Address: 2e42. and *note IPv6Address: 2e43. objects share
a lot of common attributes.  Some attributes that are only meaningful
for IPv6 addresses are also implemented by *note IPv4Address: 2e42.
objects, in order to make it easier to write code that handles both IP
versions correctly.  Address objects are *note hashable: 1364, so they
can be used as keys in dictionaries.

 -- Class: ipaddress.IPv4Address (address)

     Construct an IPv4 address.  An *note AddressValueError: 2e4a. is
     raised if `address' is not a valid IPv4 address.

     The following constitutes a valid IPv4 address:

       1. A string in decimal-dot notation, consisting of four decimal
          integers in the inclusive range 0–255, separated by dots (e.g.
          ‘192.168.0.1’).  Each integer represents an octet (byte) in
          the address.  Leading zeroes are tolerated only for values
          less than 8 (as there is no ambiguity between the decimal and
          octal interpretations of such strings).

       2. An integer that fits into 32 bits.

       3. An integer packed into a *note bytes: 326. object of length 4
          (most significant octet first).

          >>> ipaddress.IPv4Address('192.168.0.1') IPv4Address('192.168.0.1') >>> ipaddress.IPv4Address(3232235521) IPv4Address('192.168.0.1') >>> ipaddress.IPv4Address(b'\xC0\xA8\x00\x01') IPv4Address('192.168.0.1')

      -- Attribute: version

          The appropriate version number: ‘4’ for IPv4, ‘6’ for IPv6.

      -- Attribute: max_prefixlen

          The total number of bits in the address representation for
          this version: ‘32’ for IPv4, ‘128’ for IPv6.

          The prefix defines the number of leading bits in an address
          that are compared to determine whether or not an address is
          part of a network.

      -- Attribute: compressed

      -- Attribute: exploded

          The string representation in dotted decimal notation.  Leading
          zeroes are never included in the representation.

          As IPv4 does not define a shorthand notation for addresses
          with octets set to zero, these two attributes are always the
          same as ‘str(addr)’ for IPv4 addresses.  Exposing these
          attributes makes it easier to write display code that can
          handle both IPv4 and IPv6 addresses.

      -- Attribute: packed

          The binary representation of this address - a *note bytes:
          326. object of the appropriate length (most significant octet
          first).  This is 4 bytes for IPv4 and 16 bytes for IPv6.

      -- Attribute: reverse_pointer

          The name of the reverse DNS PTR record for the IP address,
          e.g.:

               >>> ipaddress.ip_address("127.0.0.1").reverse_pointer '1.0.0.127.in-addr.arpa' >>> ipaddress.ip_address("2001:db8::1").reverse_pointer '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa'

          This is the name that could be used for performing a PTR
          lookup, not the resolved hostname itself.

          New in version 3.5.

      -- Attribute: is_multicast

          ‘True’ if the address is reserved for multicast use.  See RFC
          3171(1) (for IPv4) or RFC 2373(2) (for IPv6).

      -- Attribute: is_private

          ‘True’ if the address is allocated for private networks.  See
          iana-ipv4-special-registry(3) (for IPv4) or
          iana-ipv6-special-registry(4) (for IPv6).

      -- Attribute: is_global

          ‘True’ if the address is allocated for public networks.  See
          iana-ipv4-special-registry(5) (for IPv4) or
          iana-ipv6-special-registry(6) (for IPv6).

          New in version 3.4.

      -- Attribute: is_unspecified

          ‘True’ if the address is unspecified.  See RFC 5735(7) (for
          IPv4) or RFC 2373(8) (for IPv6).

      -- Attribute: is_reserved

          ‘True’ if the address is otherwise IETF reserved.

      -- Attribute: is_loopback

          ‘True’ if this is a loopback address.  See RFC 3330(9) (for
          IPv4) or RFC 2373(10) (for IPv6).

      -- Attribute: is_link_local

          ‘True’ if the address is reserved for link-local usage.  See
          RFC 3927(11).

 -- Class: ipaddress.IPv6Address (address)

     Construct an IPv6 address.  An *note AddressValueError: 2e4a. is
     raised if `address' is not a valid IPv6 address.

     The following constitutes a valid IPv6 address:

       1. A string consisting of eight groups of four hexadecimal
          digits, each group representing 16 bits.  The groups are
          separated by colons.  This describes an `exploded' (longhand)
          notation.  The string can also be `compressed' (shorthand
          notation) by various means.  See RFC 4291(12) for details.
          For example, ‘"0000:0000:0000:0000:0000:0abc:0007:0def"’ can
          be compressed to ‘"::abc:7:def"’.

       2. An integer that fits into 128 bits.

       3. An integer packed into a *note bytes: 326. object of length
          16, big-endian.

          >>> ipaddress.IPv6Address('2001:db8::1000') IPv6Address('2001:db8::1000')

      -- Attribute: compressed

     The short form of the address representation, with leading zeroes
     in groups omitted and the longest sequence of groups consisting
     entirely of zeroes collapsed to a single empty group.

     This is also the value returned by ‘str(addr)’ for IPv6 addresses.

      -- Attribute: exploded

     The long form of the address representation, with all leading
     zeroes and groups consisting entirely of zeroes included.

     For the following attributes, see the corresponding documentation
     of the *note IPv4Address: 2e42. class:

      -- Attribute: packed

      -- Attribute: reverse_pointer

      -- Attribute: version

      -- Attribute: max_prefixlen

      -- Attribute: is_multicast

      -- Attribute: is_private

      -- Attribute: is_global

      -- Attribute: is_unspecified

      -- Attribute: is_reserved

      -- Attribute: is_loopback

      -- Attribute: is_link_local

          New in version 3.4: is_global

      -- Attribute: is_site_local

          ‘True’ if the address is reserved for site-local usage.  Note
          that the site-local address space has been deprecated by RFC
          3879(13).  Use *note is_private: 2e52. to test if this address
          is in the space of unique local addresses as defined by RFC
          4193(14).

      -- Attribute: ipv4_mapped

          For addresses that appear to be IPv4 mapped addresses
          (starting with ‘::FFFF/96’), this property will report the
          embedded IPv4 address.  For any other address, this property
          will be ‘None’.

      -- Attribute: sixtofour

          For addresses that appear to be 6to4 addresses (starting with
          ‘2002::/16’) as defined by RFC 3056(15), this property will
          report the embedded IPv4 address.  For any other address, this
          property will be ‘None’.

      -- Attribute: teredo

          For addresses that appear to be Teredo addresses (starting
          with ‘2001::/32’) as defined by RFC 4380(16), this property
          will report the embedded ‘(server, client)’ IP address pair.
          For any other address, this property will be ‘None’.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3171.html

   (2) https://tools.ietf.org/html/rfc2373.html

   (3) 
https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml

   (4) 
https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml

   (5) 
https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml

   (6) 
https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml

   (7) https://tools.ietf.org/html/rfc5735.html

   (8) https://tools.ietf.org/html/rfc2373.html

   (9) https://tools.ietf.org/html/rfc3330.html

   (10) https://tools.ietf.org/html/rfc2373.html

   (11) https://tools.ietf.org/html/rfc3927.html

   (12) https://tools.ietf.org/html/rfc4291.html

   (13) https://tools.ietf.org/html/rfc3879.html

   (14) https://tools.ietf.org/html/rfc4193.html

   (15) https://tools.ietf.org/html/rfc3056.html

   (16) https://tools.ietf.org/html/rfc4380.html


File: python.info,  Node: Conversion to Strings and Integers,  Next: Operators<3>,  Prev: Address objects,  Up: IP Addresses

5.22.28.4 Conversion to Strings and Integers
............................................

To interoperate with networking interfaces such as the socket module,
addresses must be converted to strings or integers.  This is handled
using the *note str(): 325. and *note int(): 184. builtin functions:

     >>> str(ipaddress.IPv4Address('192.168.0.1')) '192.168.0.1' >>> int(ipaddress.IPv4Address('192.168.0.1')) 3232235521 >>> str(ipaddress.IPv6Address('::1')) '::1' >>> int(ipaddress.IPv6Address('::1')) 1


File: python.info,  Node: Operators<3>,  Prev: Conversion to Strings and Integers,  Up: IP Addresses

5.22.28.5 Operators
...................

Address objects support some operators.  Unless stated otherwise,
operators can only be applied between compatible objects (i.e.  IPv4
with IPv4, IPv6 with IPv6).

* Menu:

* Comparison operators::
* Arithmetic operators::


File: python.info,  Node: Comparison operators,  Next: Arithmetic operators,  Up: Operators<3>

5.22.28.6 Comparison operators
..............................

Address objects can be compared with the usual set of comparison
operators.  Some examples:

     >>> IPv4Address('127.0.0.2') > IPv4Address('127.0.0.1') True >>> IPv4Address('127.0.0.2') == IPv4Address('127.0.0.1') False >>> IPv4Address('127.0.0.2') != IPv4Address('127.0.0.1') True


File: python.info,  Node: Arithmetic operators,  Prev: Comparison operators,  Up: Operators<3>

5.22.28.7 Arithmetic operators
..............................

Integers can be added to or subtracted from address objects.  Some
examples:

     >>> IPv4Address('127.0.0.2') + 3 IPv4Address('127.0.0.5') >>> IPv4Address('127.0.0.2') - 3 IPv4Address('126.255.255.255') >>> IPv4Address('255.255.255.255') + 1 Traceback (most recent call last):   File "<stdin>", line 1, in <module> ipaddress.AddressValueError: 4294967296 (>= 2**32) is not permitted as an IPv4 address


File: python.info,  Node: IP Network definitions,  Next: Interface objects,  Prev: IP Addresses,  Up: ipaddress — IPv4/IPv6 manipulation library

5.22.28.8 IP Network definitions
................................

The *note IPv4Network: 395. and *note IPv6Network: 394. objects provide
a mechanism for defining and inspecting IP network definitions.  A
network definition consists of a `mask' and a `network address', and as
such defines a range of IP addresses that equal the network address when
masked (binary AND) with the mask.  For example, a network definition
with the mask ‘255.255.255.0’ and the network address ‘192.168.1.0’
consists of IP addresses in the inclusive range ‘192.168.1.0’ to
‘192.168.1.255’.

* Menu:

* Prefix, net mask and host mask: Prefix net mask and host mask.
* Network objects::
* Operators: Operators<4>.


File: python.info,  Node: Prefix net mask and host mask,  Next: Network objects,  Up: IP Network definitions

5.22.28.9 Prefix, net mask and host mask
........................................

There are several equivalent ways to specify IP network masks.  A
`prefix' ‘/<nbits>’ is a notation that denotes how many high-order bits
are set in the network mask.  A `net mask' is an IP address with some
number of high-order bits set.  Thus the prefix ‘/24’ is equivalent to
the net mask ‘255.255.255.0’ in IPv4, or ‘ffff:ff00::’ in IPv6.  In
addition, a `host mask' is the logical inverse of a `net mask', and is
sometimes used (for example in Cisco access control lists) to denote a
network mask.  The host mask equivalent to ‘/24’ in IPv4 is ‘0.0.0.255’.


File: python.info,  Node: Network objects,  Next: Operators<4>,  Prev: Prefix net mask and host mask,  Up: IP Network definitions

5.22.28.10 Network objects
..........................

All attributes implemented by address objects are implemented by network
objects as well.  In addition, network objects implement additional
attributes.  All of these are common between *note IPv4Network: 395. and
*note IPv6Network: 394, so to avoid duplication they are only documented
for *note IPv4Network: 395.  Network objects are *note hashable: 1364,
so they can be used as keys in dictionaries.

 -- Class: ipaddress.IPv4Network (address, strict=True)

     Construct an IPv4 network definition.  `address' can be one of the
     following:

       1. A string consisting of an IP address and an optional mask,
          separated by a slash (‘/’).  The IP address is the network
          address, and the mask can be either a single number, which
          means it’s a `prefix', or a string representation of an IPv4
          address.  If it’s the latter, the mask is interpreted as a
          `net mask' if it starts with a non-zero field, or as a `host
          mask' if it starts with a zero field, with the single
          exception of an all-zero mask which is treated as a `net
          mask'.  If no mask is provided, it’s considered to be ‘/32’.

          For example, the following `address' specifications are
          equivalent: ‘192.168.1.0/24’, ‘192.168.1.0/255.255.255.0’ and
          ‘192.168.1.0/0.0.0.255’.

       2. An integer that fits into 32 bits.  This is equivalent to a
          single-address network, with the network address being
          `address' and the mask being ‘/32’.

       3. An integer packed into a *note bytes: 326. object of length 4,
          big-endian.  The interpretation is similar to an integer
          `address'.

       4. A two-tuple of an address description and a netmask, where the
          address description is either a string, a 32-bits integer, a
          4-bytes packed integer, or an existing IPv4Address object; and
          the netmask is either an integer representing the prefix
          length (e.g.  ‘24’) or a string representing the prefix mask
          (e.g.  ‘255.255.255.0’).

     An *note AddressValueError: 2e4a. is raised if `address' is not a
     valid IPv4 address.  A *note NetmaskValueError: 2e6f. is raised if
     the mask is not valid for an IPv4 address.

     If `strict' is ‘True’ and host bits are set in the supplied
     address, then *note ValueError: 1f9. is raised.  Otherwise, the
     host bits are masked out to determine the appropriate network
     address.

     Unless stated otherwise, all network methods accepting other
     network/address objects will raise *note TypeError: 192. if the
     argument’s IP version is incompatible to ‘self’.

     Changed in version 3.5: Added the two-tuple form for the `address'
     constructor parameter.

      -- Attribute: version

      -- Attribute: max_prefixlen

          Refer to the corresponding attribute documentation in *note
          IPv4Address: 2e42.

      -- Attribute: is_multicast

      -- Attribute: is_private

      -- Attribute: is_unspecified

      -- Attribute: is_reserved

      -- Attribute: is_loopback

      -- Attribute: is_link_local

          These attributes are true for the network as a whole if they
          are true for both the network address and the broadcast
          address.

      -- Attribute: network_address

          The network address for the network.  The network address and
          the prefix length together uniquely define a network.

      -- Attribute: broadcast_address

          The broadcast address for the network.  Packets sent to the
          broadcast address should be received by every host on the
          network.

      -- Attribute: hostmask

          The host mask, as an *note IPv4Address: 2e42. object.

      -- Attribute: netmask

          The net mask, as an *note IPv4Address: 2e42. object.

      -- Attribute: with_prefixlen

      -- Attribute: compressed

      -- Attribute: exploded

          A string representation of the network, with the mask in
          prefix notation.

          ‘with_prefixlen’ and ‘compressed’ are always the same as
          ‘str(network)’.  ‘exploded’ uses the exploded form the network
          address.

      -- Attribute: with_netmask

          A string representation of the network, with the mask in net
          mask notation.

      -- Attribute: with_hostmask

          A string representation of the network, with the mask in host
          mask notation.

      -- Attribute: num_addresses

          The total number of addresses in the network.

      -- Attribute: prefixlen

          Length of the network prefix, in bits.

      -- Method: hosts ()

          Returns an iterator over the usable hosts in the network.  The
          usable hosts are all the IP addresses that belong to the
          network, except the network address itself and the network
          broadcast address.  For networks with a mask length of 31, the
          network address and network broadcast address are also
          included in the result.

               >>> list(ip_network('192.0.2.0/29').hosts())  #doctest: +NORMALIZE_WHITESPACE [IPv4Address('192.0.2.1'), IPv4Address('192.0.2.2'),  IPv4Address('192.0.2.3'), IPv4Address('192.0.2.4'),  IPv4Address('192.0.2.5'), IPv4Address('192.0.2.6')] >>> list(ip_network('192.0.2.0/31').hosts()) [IPv4Address('192.0.2.0'), IPv4Address('192.0.2.1')]

      -- Method: overlaps (other)

          ‘True’ if this network is partly or wholly contained in
          `other' or `other' is wholly contained in this network.

      -- Method: address_exclude (network)

          Computes the network definitions resulting from removing the
          given `network' from this one.  Returns an iterator of network
          objects.  Raises *note ValueError: 1f9. if `network' is not
          completely contained in this network.

               >>> n1 = ip_network('192.0.2.0/28') >>> n2 = ip_network('192.0.2.1/32') >>> list(n1.address_exclude(n2))  #doctest: +NORMALIZE_WHITESPACE [IPv4Network('192.0.2.8/29'), IPv4Network('192.0.2.4/30'),  IPv4Network('192.0.2.2/31'), IPv4Network('192.0.2.0/32')]

      -- Method: subnets (prefixlen_diff=1, new_prefix=None)

          The subnets that join to make the current network definition,
          depending on the argument values.  `prefixlen_diff' is the
          amount our prefix length should be increased by.  `new_prefix'
          is the desired new prefix of the subnets; it must be larger
          than our prefix.  One and only one of `prefixlen_diff' and
          `new_prefix' must be set.  Returns an iterator of network
          objects.

               >>> list(ip_network('192.0.2.0/24').subnets()) [IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')] >>> list(ip_network('192.0.2.0/24').subnets(prefixlen_diff=2))  #doctest: +NORMALIZE_WHITESPACE [IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),  IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')] >>> list(ip_network('192.0.2.0/24').subnets(new_prefix=26))  #doctest: +NORMALIZE_WHITESPACE [IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),  IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')] >>> list(ip_network('192.0.2.0/24').subnets(new_prefix=23)) Traceback (most recent call last):   File "<stdin>", line 1, in <module>     raise ValueError('new prefix must be longer') ValueError: new prefix must be longer >>> list(ip_network('192.0.2.0/24').subnets(new_prefix=25)) [IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]

      -- Method: supernet (prefixlen_diff=1, new_prefix=None)

          The supernet containing this network definition, depending on
          the argument values.  `prefixlen_diff' is the amount our
          prefix length should be decreased by.  `new_prefix' is the
          desired new prefix of the supernet; it must be smaller than
          our prefix.  One and only one of `prefixlen_diff' and
          `new_prefix' must be set.  Returns a single network object.

               >>> ip_network('192.0.2.0/24').supernet() IPv4Network('192.0.2.0/23') >>> ip_network('192.0.2.0/24').supernet(prefixlen_diff=2) IPv4Network('192.0.0.0/22') >>> ip_network('192.0.2.0/24').supernet(new_prefix=20) IPv4Network('192.0.0.0/20')

      -- Method: subnet_of (other)

          Return ‘True’ if this network is a subnet of `other'.

               >>> a = ip_network('192.168.1.0/24') >>> b = ip_network('192.168.1.128/30') >>> b.subnet_of(a) True

          New in version 3.7.

      -- Method: supernet_of (other)

          Return ‘True’ if this network is a supernet of `other'.

               >>> a = ip_network('192.168.1.0/24') >>> b = ip_network('192.168.1.128/30') >>> a.supernet_of(b) True

          New in version 3.7.

      -- Method: compare_networks (other)

          Compare this network to `other'.  In this comparison only the
          network addresses are considered; host bits aren’t.  Returns
          either ‘-1’, ‘0’ or ‘1’.

               >>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.2/32')) -1 >>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.0/32')) 1 >>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32')) 0

          Deprecated since version 3.7: It uses the same ordering and
          comparison algorithm as “<”, “==”, and “>”

 -- Class: ipaddress.IPv6Network (address, strict=True)

     Construct an IPv6 network definition.  `address' can be one of the
     following:

       1. A string consisting of an IP address and an optional prefix
          length, separated by a slash (‘/’).  The IP address is the
          network address, and the prefix length must be a single
          number, the `prefix'.  If no prefix length is provided, it’s
          considered to be ‘/128’.

          Note that currently expanded netmasks are not supported.  That
          means ‘2001:db00::0/24’ is a valid argument while
          ‘2001:db00::0/ffff:ff00::’ not.

       2. An integer that fits into 128 bits.  This is equivalent to a
          single-address network, with the network address being
          `address' and the mask being ‘/128’.

       3. An integer packed into a *note bytes: 326. object of length
          16, big-endian.  The interpretation is similar to an integer
          `address'.

       4. A two-tuple of an address description and a netmask, where the
          address description is either a string, a 128-bits integer, a
          16-bytes packed integer, or an existing IPv6Address object;
          and the netmask is an integer representing the prefix length.

     An *note AddressValueError: 2e4a. is raised if `address' is not a
     valid IPv6 address.  A *note NetmaskValueError: 2e6f. is raised if
     the mask is not valid for an IPv6 address.

     If `strict' is ‘True’ and host bits are set in the supplied
     address, then *note ValueError: 1f9. is raised.  Otherwise, the
     host bits are masked out to determine the appropriate network
     address.

     Changed in version 3.5: Added the two-tuple form for the `address'
     constructor parameter.

      -- Attribute: version

      -- Attribute: max_prefixlen

      -- Attribute: is_multicast

      -- Attribute: is_private

      -- Attribute: is_unspecified

      -- Attribute: is_reserved

      -- Attribute: is_loopback

      -- Attribute: is_link_local

      -- Attribute: network_address

      -- Attribute: broadcast_address

      -- Attribute: hostmask

      -- Attribute: netmask

      -- Attribute: with_prefixlen

      -- Attribute: compressed

      -- Attribute: exploded

      -- Attribute: with_netmask

      -- Attribute: with_hostmask

      -- Attribute: num_addresses

      -- Attribute: prefixlen

      -- Method: hosts ()

          Returns an iterator over the usable hosts in the network.  The
          usable hosts are all the IP addresses that belong to the
          network, except the Subnet-Router anycast address.  For
          networks with a mask length of 127, the Subnet-Router anycast
          address is also included in the result.

      -- Method: overlaps (other)

      -- Method: address_exclude (network)

      -- Method: subnets (prefixlen_diff=1, new_prefix=None)

      -- Method: supernet (prefixlen_diff=1, new_prefix=None)

      -- Method: subnet_of (other)

      -- Method: supernet_of (other)

      -- Method: compare_networks (other)

          Refer to the corresponding attribute documentation in *note
          IPv4Network: 395.

      -- Attribute: is_site_local

          These attribute is true for the network as a whole if it is
          true for both the network address and the broadcast address.


File: python.info,  Node: Operators<4>,  Prev: Network objects,  Up: IP Network definitions

5.22.28.11 Operators
....................

Network objects support some operators.  Unless stated otherwise,
operators can only be applied between compatible objects (i.e.  IPv4
with IPv4, IPv6 with IPv6).

* Menu:

* Logical operators::
* Iteration: Iteration<2>.
* Networks as containers of addresses::


File: python.info,  Node: Logical operators,  Next: Iteration<2>,  Up: Operators<4>

5.22.28.12 Logical operators
............................

Network objects can be compared with the usual set of logical operators.
Network objects are ordered first by network address, then by net mask.


File: python.info,  Node: Iteration<2>,  Next: Networks as containers of addresses,  Prev: Logical operators,  Up: Operators<4>

5.22.28.13 Iteration
....................

Network objects can be iterated to list all the addresses belonging to
the network.  For iteration, `all' hosts are returned, including
unusable hosts (for usable hosts, use the *note hosts(): 2e83. method).
An example:

     >>> for addr in IPv4Network('192.0.2.0/28'): ...     addr ... IPv4Address('192.0.2.0') IPv4Address('192.0.2.1') IPv4Address('192.0.2.2') IPv4Address('192.0.2.3') IPv4Address('192.0.2.4') IPv4Address('192.0.2.5') IPv4Address('192.0.2.6') IPv4Address('192.0.2.7') IPv4Address('192.0.2.8') IPv4Address('192.0.2.9') IPv4Address('192.0.2.10') IPv4Address('192.0.2.11') IPv4Address('192.0.2.12') IPv4Address('192.0.2.13') IPv4Address('192.0.2.14') IPv4Address('192.0.2.15')


File: python.info,  Node: Networks as containers of addresses,  Prev: Iteration<2>,  Up: Operators<4>

5.22.28.14 Networks as containers of addresses
..............................................

Network objects can act as containers of addresses.  Some examples:

     >>> IPv4Network('192.0.2.0/28')[0] IPv4Address('192.0.2.0') >>> IPv4Network('192.0.2.0/28')[15] IPv4Address('192.0.2.15') >>> IPv4Address('192.0.2.6') in IPv4Network('192.0.2.0/28') True >>> IPv4Address('192.0.3.6') in IPv4Network('192.0.2.0/28') False


File: python.info,  Node: Interface objects,  Next: Other Module Level Functions,  Prev: IP Network definitions,  Up: ipaddress — IPv4/IPv6 manipulation library

5.22.28.15 Interface objects
............................

Interface objects are *note hashable: 1364, so they can be used as keys
in dictionaries.

 -- Class: ipaddress.IPv4Interface (address)

     Construct an IPv4 interface.  The meaning of `address' is as in the
     constructor of *note IPv4Network: 395, except that arbitrary host
     addresses are always accepted.

     *note IPv4Interface: 2e46. is a subclass of *note IPv4Address:
     2e42, so it inherits all the attributes from that class.  In
     addition, the following attributes are available:

      -- Attribute: ip

          The address (*note IPv4Address: 2e42.) without network
          information.

               >>> interface = IPv4Interface('192.0.2.5/24') >>> interface.ip IPv4Address('192.0.2.5')

      -- Attribute: network

          The network (*note IPv4Network: 395.) this interface belongs
          to.

               >>> interface = IPv4Interface('192.0.2.5/24') >>> interface.network IPv4Network('192.0.2.0/24')

      -- Attribute: with_prefixlen

          A string representation of the interface with the mask in
          prefix notation.

               >>> interface = IPv4Interface('192.0.2.5/24') >>> interface.with_prefixlen '192.0.2.5/24'

      -- Attribute: with_netmask

          A string representation of the interface with the network as a
          net mask.

               >>> interface = IPv4Interface('192.0.2.5/24') >>> interface.with_netmask '192.0.2.5/255.255.255.0'

      -- Attribute: with_hostmask

          A string representation of the interface with the network as a
          host mask.

               >>> interface = IPv4Interface('192.0.2.5/24') >>> interface.with_hostmask '192.0.2.5/0.0.0.255'

 -- Class: ipaddress.IPv6Interface (address)

     Construct an IPv6 interface.  The meaning of `address' is as in the
     constructor of *note IPv6Network: 394, except that arbitrary host
     addresses are always accepted.

     *note IPv6Interface: 2e47. is a subclass of *note IPv6Address:
     2e43, so it inherits all the attributes from that class.  In
     addition, the following attributes are available:

      -- Attribute: ip

      -- Attribute: network

      -- Attribute: with_prefixlen

      -- Attribute: with_netmask

      -- Attribute: with_hostmask

          Refer to the corresponding attribute documentation in *note
          IPv4Interface: 2e46.

* Menu:

* Operators: Operators<5>.


File: python.info,  Node: Operators<5>,  Up: Interface objects

5.22.28.16 Operators
....................

Interface objects support some operators.  Unless stated otherwise,
operators can only be applied between compatible objects (i.e.  IPv4
with IPv4, IPv6 with IPv6).

* Menu:

* Logical operators: Logical operators<2>.


File: python.info,  Node: Logical operators<2>,  Up: Operators<5>

5.22.28.17 Logical operators
............................

Interface objects can be compared with the usual set of logical
operators.

For equality comparison (‘==’ and ‘!=’), both the IP address and network
must be the same for the objects to be equal.  An interface will not
compare equal to any address or network object.

For ordering (‘<’, ‘>’, etc) the rules are different.  Interface and
address objects with the same IP version can be compared, and the
address objects will always sort before the interface objects.  Two
interface objects are first compared by their networks and, if those are
the same, then by their IP addresses.


File: python.info,  Node: Other Module Level Functions,  Next: Custom Exceptions,  Prev: Interface objects,  Up: ipaddress — IPv4/IPv6 manipulation library

5.22.28.18 Other Module Level Functions
.......................................

The module also provides the following module level functions:

 -- Function: ipaddress.v4_int_to_packed (address)

     Represent an address as 4 packed bytes in network (big-endian)
     order.  `address' is an integer representation of an IPv4 IP
     address.  A *note ValueError: 1f9. is raised if the integer is
     negative or too large to be an IPv4 IP address.

          >>> ipaddress.ip_address(3221225985) IPv4Address('192.0.2.1') >>> ipaddress.v4_int_to_packed(3221225985) b'\xc0\x00\x02\x01'

 -- Function: ipaddress.v6_int_to_packed (address)

     Represent an address as 16 packed bytes in network (big-endian)
     order.  `address' is an integer representation of an IPv6 IP
     address.  A *note ValueError: 1f9. is raised if the integer is
     negative or too large to be an IPv6 IP address.

 -- Function: ipaddress.summarize_address_range (first, last)

     Return an iterator of the summarized network range given the first
     and last IP addresses.  `first' is the first *note IPv4Address:
     2e42. or *note IPv6Address: 2e43. in the range and `last' is the
     last *note IPv4Address: 2e42. or *note IPv6Address: 2e43. in the
     range.  A *note TypeError: 192. is raised if `first' or `last' are
     not IP addresses or are not of the same version.  A *note
     ValueError: 1f9. is raised if `last' is not greater than `first' or
     if `first' address version is not 4 or 6.

          >>> [ipaddr for ipaddr in ipaddress.summarize_address_range( ...    ipaddress.IPv4Address('192.0.2.0'), ...    ipaddress.IPv4Address('192.0.2.130'))] [IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')]

 -- Function: ipaddress.collapse_addresses (addresses)

     Return an iterator of the collapsed *note IPv4Network: 395. or
     *note IPv6Network: 394. objects.  `addresses' is an iterator of
     *note IPv4Network: 395. or *note IPv6Network: 394. objects.  A
     *note TypeError: 192. is raised if `addresses' contains mixed
     version objects.

          >>> [ipaddr for ipaddr in ... ipaddress.collapse_addresses([ipaddress.IPv4Network('192.0.2.0/25'), ... ipaddress.IPv4Network('192.0.2.128/25')])] [IPv4Network('192.0.2.0/24')]

 -- Function: ipaddress.get_mixed_type_key (obj)

     Return a key suitable for sorting between networks and addresses.
     Address and Network objects are not sortable by default; they’re
     fundamentally different, so the expression:

          IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')

     doesn’t make sense.  There are some times however, where you may
     wish to have *note ipaddress: a2. sort these anyway.  If you need
     to do this, you can use this function as the `key' argument to
     *note sorted(): 439.

     `obj' is either a network or address object.


File: python.info,  Node: Custom Exceptions,  Prev: Other Module Level Functions,  Up: ipaddress — IPv4/IPv6 manipulation library

5.22.28.19 Custom Exceptions
............................

To support more specific error reporting from class constructors, the
module defines the following exceptions:

 -- Exception: ipaddress.AddressValueError (ValueError)

     Any value error related to the address.

 -- Exception: ipaddress.NetmaskValueError (ValueError)

     Any value error related to the net mask.


File: python.info,  Node: Multimedia Services,  Next: Internationalization,  Prev: Internet Protocols and Support,  Up: The Python Standard Library

5.23 Multimedia Services
========================

The modules described in this chapter implement various algorithms or
interfaces that are mainly useful for multimedia applications.  They are
available at the discretion of the installation.  Here’s an overview:

* Menu:

* audioop — Manipulate raw audio data::
* aifc — Read and write AIFF and AIFC files::
* sunau — Read and write Sun AU files::
* wave — Read and write WAV files::
* chunk — Read IFF chunked data::
* colorsys — Conversions between color systems::
* imghdr — Determine the type of an image::
* sndhdr — Determine type of sound file::
* ossaudiodev — Access to OSS-compatible audio devices::


File: python.info,  Node: audioop — Manipulate raw audio data,  Next: aifc — Read and write AIFF and AIFC files,  Up: Multimedia Services

5.23.1 ‘audioop’ — Manipulate raw audio data
--------------------------------------------

__________________________________________________________________

The *note audioop: d. module contains some useful operations on sound
fragments.  It operates on sound fragments consisting of signed integer
samples 8, 16, 24 or 32 bits wide, stored in *note bytes-like objects:
5dd.  All scalar items are integers, unless specified otherwise.

Changed in version 3.4: Support for 24-bit samples was added.  All
functions now accept any *note bytes-like object: 5dd.  String input now
results in an immediate error.

This module provides support for a-LAW, u-LAW and Intel/DVI ADPCM
encodings.

A few of the more complicated operations only take 16-bit samples,
otherwise the sample size (in bytes) is always a parameter of the
operation.

The module defines the following variables and functions:

 -- Exception: audioop.error

     This exception is raised on all errors, such as unknown number of
     bytes per sample, etc.

 -- Function: audioop.add (fragment1, fragment2, width)

     Return a fragment which is the addition of the two samples passed
     as parameters.  `width' is the sample width in bytes, either ‘1’,
     ‘2’, ‘3’ or ‘4’.  Both fragments should have the same length.
     Samples are truncated in case of overflow.

 -- Function: audioop.adpcm2lin (adpcmfragment, width, state)

     Decode an Intel/DVI ADPCM coded fragment to a linear fragment.  See
     the description of *note lin2adpcm(): 2ec3. for details on ADPCM
     coding.  Return a tuple ‘(sample, newstate)’ where the sample has
     the width specified in `width'.

 -- Function: audioop.alaw2lin (fragment, width)

     Convert sound fragments in a-LAW encoding to linearly encoded sound
     fragments.  a-LAW encoding always uses 8 bits samples, so `width'
     refers only to the sample width of the output fragment here.

 -- Function: audioop.avg (fragment, width)

     Return the average over all samples in the fragment.

 -- Function: audioop.avgpp (fragment, width)

     Return the average peak-peak value over all samples in the
     fragment.  No filtering is done, so the usefulness of this routine
     is questionable.

 -- Function: audioop.bias (fragment, width, bias)

     Return a fragment that is the original fragment with a bias added
     to each sample.  Samples wrap around in case of overflow.

 -- Function: audioop.byteswap (fragment, width)

     “Byteswap” all samples in a fragment and returns the modified
     fragment.  Converts big-endian samples to little-endian and vice
     versa.

     New in version 3.4.

 -- Function: audioop.cross (fragment, width)

     Return the number of zero crossings in the fragment passed as an
     argument.

 -- Function: audioop.findfactor (fragment, reference)

     Return a factor `F' such that ‘rms(add(fragment, mul(reference,
     -F)))’ is minimal, i.e., return the factor with which you should
     multiply `reference' to make it match as well as possible to
     `fragment'.  The fragments should both contain 2-byte samples.

     The time taken by this routine is proportional to ‘len(fragment)’.

 -- Function: audioop.findfit (fragment, reference)

     Try to match `reference' as well as possible to a portion of
     `fragment' (which should be the longer fragment).  This is
     (conceptually) done by taking slices out of `fragment', using *note
     findfactor(): 2ec9. to compute the best match, and minimizing the
     result.  The fragments should both contain 2-byte samples.  Return
     a tuple ‘(offset, factor)’ where `offset' is the (integer) offset
     into `fragment' where the optimal match started and `factor' is the
     (floating-point) factor as per *note findfactor(): 2ec9.

 -- Function: audioop.findmax (fragment, length)

     Search `fragment' for a slice of length `length' samples (not
     bytes!)  with maximum energy, i.e., return `i' for which
     ‘rms(fragment[i*2:(i+length)*2])’ is maximal.  The fragments should
     both contain 2-byte samples.

     The routine takes time proportional to ‘len(fragment)’.

 -- Function: audioop.getsample (fragment, width, index)

     Return the value of sample `index' from the fragment.

 -- Function: audioop.lin2adpcm (fragment, width, state)

     Convert samples to 4 bit Intel/DVI ADPCM encoding.  ADPCM coding is
     an adaptive coding scheme, whereby each 4 bit number is the
     difference between one sample and the next, divided by a (varying)
     step.  The Intel/DVI ADPCM algorithm has been selected for use by
     the IMA, so it may well become a standard.

     `state' is a tuple containing the state of the coder.  The coder
     returns a tuple ‘(adpcmfrag, newstate)’, and the `newstate' should
     be passed to the next call of *note lin2adpcm(): 2ec3.  In the
     initial call, ‘None’ can be passed as the state.  `adpcmfrag' is
     the ADPCM coded fragment packed 2 4-bit values per byte.

 -- Function: audioop.lin2alaw (fragment, width)

     Convert samples in the audio fragment to a-LAW encoding and return
     this as a bytes object.  a-LAW is an audio encoding format whereby
     you get a dynamic range of about 13 bits using only 8 bit samples.
     It is used by the Sun audio hardware, among others.

 -- Function: audioop.lin2lin (fragment, width, newwidth)

     Convert samples between 1-, 2-, 3- and 4-byte formats.

          Note: In some audio formats, such as .WAV files, 16, 24 and 32
          bit samples are signed, but 8 bit samples are unsigned.  So
          when converting to 8 bit wide samples for these formats, you
          need to also add 128 to the result:

               new_frames = audioop.lin2lin(frames, old_width, 1) new_frames = audioop.bias(new_frames, 1, 128)

          The same, in reverse, has to be applied when converting from 8
          to 16, 24 or 32 bit width samples.

 -- Function: audioop.lin2ulaw (fragment, width)

     Convert samples in the audio fragment to u-LAW encoding and return
     this as a bytes object.  u-LAW is an audio encoding format whereby
     you get a dynamic range of about 14 bits using only 8 bit samples.
     It is used by the Sun audio hardware, among others.

 -- Function: audioop.max (fragment, width)

     Return the maximum of the `absolute value' of all samples in a
     fragment.

 -- Function: audioop.maxpp (fragment, width)

     Return the maximum peak-peak value in the sound fragment.

 -- Function: audioop.minmax (fragment, width)

     Return a tuple consisting of the minimum and maximum values of all
     samples in the sound fragment.

 -- Function: audioop.mul (fragment, width, factor)

     Return a fragment that has all samples in the original fragment
     multiplied by the floating-point value `factor'.  Samples are
     truncated in case of overflow.

 -- Function: audioop.ratecv (fragment, width, nchannels, inrate,
          outrate, state[, weightA[, weightB]])

     Convert the frame rate of the input fragment.

     `state' is a tuple containing the state of the converter.  The
     converter returns a tuple ‘(newfragment, newstate)’, and `newstate'
     should be passed to the next call of *note ratecv(): 2ed4.  The
     initial call should pass ‘None’ as the state.

     The `weightA' and `weightB' arguments are parameters for a simple
     digital filter and default to ‘1’ and ‘0’ respectively.

 -- Function: audioop.reverse (fragment, width)

     Reverse the samples in a fragment and returns the modified
     fragment.

 -- Function: audioop.rms (fragment, width)

     Return the root-mean-square of the fragment, i.e.
     ‘sqrt(sum(S_i^2)/n)’.

     This is a measure of the power in an audio signal.

 -- Function: audioop.tomono (fragment, width, lfactor, rfactor)

     Convert a stereo fragment to a mono fragment.  The left channel is
     multiplied by `lfactor' and the right channel by `rfactor' before
     adding the two channels to give a mono signal.

 -- Function: audioop.tostereo (fragment, width, lfactor, rfactor)

     Generate a stereo fragment from a mono fragment.  Each pair of
     samples in the stereo fragment are computed from the mono sample,
     whereby left channel samples are multiplied by `lfactor' and right
     channel samples by `rfactor'.

 -- Function: audioop.ulaw2lin (fragment, width)

     Convert sound fragments in u-LAW encoding to linearly encoded sound
     fragments.  u-LAW encoding always uses 8 bits samples, so `width'
     refers only to the sample width of the output fragment here.

Note that operations such as *note mul(): 2ed3. or *note max(): 2ed0.
make no distinction between mono and stereo fragments, i.e.  all samples
are treated equal.  If this is a problem the stereo fragment should be
split into two mono fragments first and recombined later.  Here is an
example of how to do that:

     def mul_stereo(sample, width, lfactor, rfactor):     lsample = audioop.tomono(sample, width, 1, 0)     rsample = audioop.tomono(sample, width, 0, 1)     lsample = audioop.mul(lsample, width, lfactor)     rsample = audioop.mul(rsample, width, rfactor)     lsample = audioop.tostereo(lsample, width, 1, 0)     rsample = audioop.tostereo(rsample, width, 0, 1)     return audioop.add(lsample, rsample, width)

If you use the ADPCM coder to build network packets and you want your
protocol to be stateless (i.e.  to be able to tolerate packet loss) you
should not only transmit the data but also the state.  Note that you
should send the `initial' state (the one you passed to *note
lin2adpcm(): 2ec3.) along to the decoder, not the final state (as
returned by the coder).  If you want to use *note struct.Struct: 1745.
to store the state in binary you can code the first element (the
predicted value) in 16 bits and the second (the delta index) in 8.

The ADPCM coders have never been tried against other ADPCM coders, only
against themselves.  It could well be that I misinterpreted the
standards in which case they will not be interoperable with the
respective standards.

The ‘find*()’ routines might look a bit funny at first sight.  They are
primarily meant to do echo cancellation.  A reasonably fast way to do
this is to pick the most energetic piece of the output sample, locate
that in the input sample and subtract the whole output sample from the
input sample:

     def echocancel(outputdata, inputdata):     pos = audioop.findmax(outputdata, 800)    # one tenth second     out_test = outputdata[pos*2:]     in_test = inputdata[pos*2:]     ipos, factor = audioop.findfit(in_test, out_test)     # Optional (for better cancellation):     # factor = audioop.findfactor(in_test[ipos*2:ipos*2+len(out_test)],     #              out_test)     prefill = '\0'*(pos+ipos)*2     postfill = '\0'*(len(inputdata)-len(prefill)-len(outputdata))     outputdata = prefill + audioop.mul(outputdata, 2, -factor) + postfill     return audioop.add(inputdata, outputdata, 2)


File: python.info,  Node: aifc — Read and write AIFF and AIFC files,  Next: sunau — Read and write Sun AU files,  Prev: audioop — Manipulate raw audio data,  Up: Multimedia Services

5.23.2 ‘aifc’ — Read and write AIFF and AIFC files
--------------------------------------------------

`Source code:' Lib/aifc.py(1)

__________________________________________________________________

This module provides support for reading and writing AIFF and AIFF-C
files.  AIFF is Audio Interchange File Format, a format for storing
digital audio samples in a file.  AIFF-C is a newer version of the
format that includes the ability to compress the audio data.

Audio files have a number of parameters that describe the audio data.
The sampling rate or frame rate is the number of times per second the
sound is sampled.  The number of channels indicate if the audio is mono,
stereo, or quadro.  Each frame consists of one sample per channel.  The
sample size is the size in bytes of each sample.  Thus a frame consists
of ‘nchannels * samplesize’ bytes, and a second’s worth of audio
consists of ‘nchannels * samplesize * framerate’ bytes.

For example, CD quality audio has a sample size of two bytes (16 bits),
uses two channels (stereo) and has a frame rate of 44,100 frames/second.
This gives a frame size of 4 bytes (2*2), and a second’s worth occupies
2*2*44100 bytes (176,400 bytes).

Module *note aifc: 5. defines the following function:

 -- Function: aifc.open (file, mode=None)

     Open an AIFF or AIFF-C file and return an object instance with
     methods that are described below.  The argument `file' is either a
     string naming a file or a *note file object: b35.  `mode' must be
     ‘'r'’ or ‘'rb'’ when the file must be opened for reading, or ‘'w'’
     or ‘'wb'’ when the file must be opened for writing.  If omitted,
     ‘file.mode’ is used if it exists, otherwise ‘'rb'’ is used.  When
     used for writing, the file object should be seekable, unless you
     know ahead of time how many samples you are going to write in total
     and use ‘writeframesraw()’ and ‘setnframes()’.  The *note open():
     450. function may be used in a *note with: 6dd. statement.  When
     the ‘with’ block completes, the *note close(): 810. method is
     called.

     Changed in version 3.4: Support for the *note with: 6dd. statement
     was added.

Objects returned by *note open(): 450. when a file is opened for reading
have the following methods:

 -- Method: aifc.getnchannels ()

     Return the number of audio channels (1 for mono, 2 for stereo).

 -- Method: aifc.getsampwidth ()

     Return the size in bytes of individual samples.

 -- Method: aifc.getframerate ()

     Return the sampling rate (number of audio frames per second).

 -- Method: aifc.getnframes ()

     Return the number of audio frames in the file.

 -- Method: aifc.getcomptype ()

     Return a bytes array of length 4 describing the type of compression
     used in the audio file.  For AIFF files, the returned value is
     ‘b'NONE'’.

 -- Method: aifc.getcompname ()

     Return a bytes array convertible to a human-readable description of
     the type of compression used in the audio file.  For AIFF files,
     the returned value is ‘b'not compressed'’.

 -- Method: aifc.getparams ()

     Returns a *note namedtuple(): 1b5. ‘(nchannels, sampwidth,
     framerate, nframes, comptype, compname)’, equivalent to output of
     the ‘get*()’ methods.

 -- Method: aifc.getmarkers ()

     Return a list of markers in the audio file.  A marker consists of a
     tuple of three elements.  The first is the mark ID (an integer),
     the second is the mark position in frames from the beginning of the
     data (an integer), the third is the name of the mark (a string).

 -- Method: aifc.getmark (id)

     Return the tuple as described in *note getmarkers(): 2ee2. for the
     mark with the given `id'.

 -- Method: aifc.readframes (nframes)

     Read and return the next `nframes' frames from the audio file.  The
     returned data is a string containing for each frame the
     uncompressed samples of all channels.

 -- Method: aifc.rewind ()

     Rewind the read pointer.  The next *note readframes(): 2ee4. will
     start from the beginning.

 -- Method: aifc.setpos (pos)

     Seek to the specified frame number.

 -- Method: aifc.tell ()

     Return the current frame number.

 -- Method: aifc.close ()

     Close the AIFF file.  After calling this method, the object can no
     longer be used.

Objects returned by *note open(): 450. when a file is opened for writing
have all the above methods, except for ‘readframes()’ and ‘setpos()’.
In addition the following methods exist.  The ‘get*()’ methods can only
be called after the corresponding ‘set*()’ methods have been called.
Before the first ‘writeframes()’ or ‘writeframesraw()’, all parameters
except for the number of frames must be filled in.

 -- Method: aifc.aiff ()

     Create an AIFF file.  The default is that an AIFF-C file is
     created, unless the name of the file ends in ‘'.aiff'’ in which
     case the default is an AIFF file.

 -- Method: aifc.aifc ()

     Create an AIFF-C file.  The default is that an AIFF-C file is
     created, unless the name of the file ends in ‘'.aiff'’ in which
     case the default is an AIFF file.

 -- Method: aifc.setnchannels (nchannels)

     Specify the number of channels in the audio file.

 -- Method: aifc.setsampwidth (width)

     Specify the size in bytes of audio samples.

 -- Method: aifc.setframerate (rate)

     Specify the sampling frequency in frames per second.

 -- Method: aifc.setnframes (nframes)

     Specify the number of frames that are to be written to the audio
     file.  If this parameter is not set, or not set correctly, the file
     needs to support seeking.

 -- Method: aifc.setcomptype (type, name)

     Specify the compression type.  If not specified, the audio data
     will not be compressed.  In AIFF files, compression is not
     possible.  The name parameter should be a human-readable
     description of the compression type as a bytes array, the type
     parameter should be a bytes array of length 4.  Currently the
     following compression types are supported: ‘b'NONE'’, ‘b'ULAW'’,
     ‘b'ALAW'’, ‘b'G722'’.

 -- Method: aifc.setparams (nchannels, sampwidth, framerate, comptype,
          compname)

     Set all the above parameters at once.  The argument is a tuple
     consisting of the various parameters.  This means that it is
     possible to use the result of a *note getparams(): 80f. call as
     argument to *note setparams(): 2eef.

 -- Method: aifc.setmark (id, pos, name)

     Add a mark with the given id (larger than 0), and the given name at
     the given position.  This method can be called at any time before
     *note close(): 810.

 -- Method: aifc.tell ()

     Return the current write position in the output file.  Useful in
     combination with *note setmark(): 2ef0.

 -- Method: aifc.writeframes (data)

     Write data to the output file.  This method can only be called
     after the audio file parameters have been set.

     Changed in version 3.4: Any *note bytes-like object: 5dd. is now
     accepted.

 -- Method: aifc.writeframesraw (data)

     Like *note writeframes(): 812, except that the header of the audio
     file is not updated.

     Changed in version 3.4: Any *note bytes-like object: 5dd. is now
     accepted.

 -- Method: aifc.close ()

     Close the AIFF file.  The header of the file is updated to reflect
     the actual size of the audio data.  After calling this method, the
     object can no longer be used.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/aifc.py


File: python.info,  Node: sunau — Read and write Sun AU files,  Next: wave — Read and write WAV files,  Prev: aifc — Read and write AIFF and AIFC files,  Up: Multimedia Services

5.23.3 ‘sunau’ — Read and write Sun AU files
--------------------------------------------

`Source code:' Lib/sunau.py(1)

__________________________________________________________________

The *note sunau: fa. module provides a convenient interface to the Sun
AU sound format.  Note that this module is interface-compatible with the
modules *note aifc: 5. and *note wave: 127.

An audio file consists of a header followed by the data.  The fields of
the header are:

Field               Contents
                    
------------------------------------------------------------------------
                    
magic word          The four bytes ‘.snd’.
                    
                    
header size         Size of the header, including info, in bytes.
                    
                    
data size           Physical size of the data, in bytes.
                    
                    
encoding            Indicates how the audio samples are encoded.
                    
                    
sample rate         The sampling rate.
                    
                    
# of channels       The number of channels in the samples.
                    
                    
info                ASCII string giving a description of the audio
                    file (padded with null bytes).
                    

Apart from the info field, all header fields are 4 bytes in size.  They
are all 32-bit unsigned integers encoded in big-endian byte order.

The *note sunau: fa. module defines the following functions:

 -- Function: sunau.open (file, mode)

     If `file' is a string, open the file by that name, otherwise treat
     it as a seekable file-like object.  `mode' can be any of

     ‘'r'’

          Read only mode.

     ‘'w'’

          Write only mode.

     Note that it does not allow read/write files.

     A `mode' of ‘'r'’ returns an ‘AU_read’ object, while a `mode' of
     ‘'w'’ or ‘'wb'’ returns an ‘AU_write’ object.

 -- Function: sunau.openfp (file, mode)

     A synonym for *note open(): 467, maintained for backwards
     compatibility.

     Deprecated since version 3.7, will be removed in version 3.9.

The *note sunau: fa. module defines the following exception:

 -- Exception: sunau.Error

     An error raised when something is impossible because of Sun AU
     specs or implementation deficiency.

The *note sunau: fa. module defines the following data items:

 -- Data: sunau.AUDIO_FILE_MAGIC

     An integer every valid Sun AU file begins with, stored in
     big-endian form.  This is the string ‘.snd’ interpreted as an
     integer.

 -- Data: sunau.AUDIO_FILE_ENCODING_MULAW_8
 -- Data: sunau.AUDIO_FILE_ENCODING_LINEAR_8
 -- Data: sunau.AUDIO_FILE_ENCODING_LINEAR_16
 -- Data: sunau.AUDIO_FILE_ENCODING_LINEAR_24
 -- Data: sunau.AUDIO_FILE_ENCODING_LINEAR_32
 -- Data: sunau.AUDIO_FILE_ENCODING_ALAW_8

     Values of the encoding field from the AU header which are supported
     by this module.

 -- Data: sunau.AUDIO_FILE_ENCODING_FLOAT
 -- Data: sunau.AUDIO_FILE_ENCODING_DOUBLE
 -- Data: sunau.AUDIO_FILE_ENCODING_ADPCM_G721
 -- Data: sunau.AUDIO_FILE_ENCODING_ADPCM_G722
 -- Data: sunau.AUDIO_FILE_ENCODING_ADPCM_G723_3
 -- Data: sunau.AUDIO_FILE_ENCODING_ADPCM_G723_5

     Additional known values of the encoding field from the AU header,
     but which are not supported by this module.

* Menu:

* AU_read Objects::
* AU_write Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/sunau.py


File: python.info,  Node: AU_read Objects,  Next: AU_write Objects,  Up: sunau — Read and write Sun AU files

5.23.3.1 AU_read Objects
........................

AU_read objects, as returned by *note open(): 467. above, have the
following methods:

 -- Method: AU_read.close ()

     Close the stream, and make the instance unusable.  (This is called
     automatically on deletion.)

 -- Method: AU_read.getnchannels ()

     Returns number of audio channels (1 for mono, 2 for stereo).

 -- Method: AU_read.getsampwidth ()

     Returns sample width in bytes.

 -- Method: AU_read.getframerate ()

     Returns sampling frequency.

 -- Method: AU_read.getnframes ()

     Returns number of audio frames.

 -- Method: AU_read.getcomptype ()

     Returns compression type.  Supported compression types are
     ‘'ULAW'’, ‘'ALAW'’ and ‘'NONE'’.

 -- Method: AU_read.getcompname ()

     Human-readable version of *note getcomptype(): 2f08.  The supported
     types have the respective names ‘'CCITT G.711 u-law'’, ‘'CCITT
     G.711 A-law'’ and ‘'not compressed'’.

 -- Method: AU_read.getparams ()

     Returns a *note namedtuple(): 1b5. ‘(nchannels, sampwidth,
     framerate, nframes, comptype, compname)’, equivalent to output of
     the ‘get*()’ methods.

 -- Method: AU_read.readframes (n)

     Reads and returns at most `n' frames of audio, as a *note bytes:
     326. object.  The data will be returned in linear format.  If the
     original data is in u-LAW format, it will be converted.

 -- Method: AU_read.rewind ()

     Rewind the file pointer to the beginning of the audio stream.

The following two methods define a term “position” which is compatible
between them, and is otherwise implementation dependent.

 -- Method: AU_read.setpos (pos)

     Set the file pointer to the specified position.  Only values
     returned from *note tell(): 2f0e. should be used for `pos'.

 -- Method: AU_read.tell ()

     Return current file pointer position.  Note that the returned value
     has nothing to do with the actual position in the file.

The following two functions are defined for compatibility with the *note
aifc: 5, and don’t do anything interesting.

 -- Method: AU_read.getmarkers ()

     Returns ‘None’.

 -- Method: AU_read.getmark (id)

     Raise an error.


File: python.info,  Node: AU_write Objects,  Prev: AU_read Objects,  Up: sunau — Read and write Sun AU files

5.23.3.2 AU_write Objects
.........................

AU_write objects, as returned by *note open(): 467. above, have the
following methods:

 -- Method: AU_write.setnchannels (n)

     Set the number of channels.

 -- Method: AU_write.setsampwidth (n)

     Set the sample width (in bytes.)

     Changed in version 3.4: Added support for 24-bit samples.

 -- Method: AU_write.setframerate (n)

     Set the frame rate.

 -- Method: AU_write.setnframes (n)

     Set the number of frames.  This can be later changed, when and if
     more frames are written.

 -- Method: AU_write.setcomptype (type, name)

     Set the compression type and description.  Only ‘'NONE'’ and
     ‘'ULAW'’ are supported on output.

 -- Method: AU_write.setparams (tuple)

     The `tuple' should be ‘(nchannels, sampwidth, framerate, nframes,
     comptype, compname)’, with values valid for the ‘set*()’ methods.
     Set all parameters.

 -- Method: AU_write.tell ()

     Return current position in the file, with the same disclaimer for
     the *note AU_read.tell(): 2f0e. and *note AU_read.setpos(): 2f0d.
     methods.

 -- Method: AU_write.writeframesraw (data)

     Write audio frames, without correcting `nframes'.

     Changed in version 3.4: Any *note bytes-like object: 5dd. is now
     accepted.

 -- Method: AU_write.writeframes (data)

     Write audio frames and make sure `nframes' is correct.

     Changed in version 3.4: Any *note bytes-like object: 5dd. is now
     accepted.

 -- Method: AU_write.close ()

     Make sure `nframes' is correct, and close the file.

     This method is called upon deletion.

Note that it is invalid to set any parameters after calling
‘writeframes()’ or ‘writeframesraw()’.


File: python.info,  Node: wave — Read and write WAV files,  Next: chunk — Read IFF chunked data,  Prev: sunau — Read and write Sun AU files,  Up: Multimedia Services

5.23.4 ‘wave’ — Read and write WAV files
----------------------------------------

`Source code:' Lib/wave.py(1)

__________________________________________________________________

The *note wave: 127. module provides a convenient interface to the WAV
sound format.  It does not support compression/decompression, but it
does support mono/stereo.

The *note wave: 127. module defines the following function and
exception:

 -- Function: wave.open (file, mode=None)

     If `file' is a string, open the file by that name, otherwise treat
     it as a file-like object.  `mode' can be:

     ‘'rb'’

          Read only mode.

     ‘'wb'’

          Write only mode.

     Note that it does not allow read/write WAV files.

     A `mode' of ‘'rb'’ returns a ‘Wave_read’ object, while a `mode' of
     ‘'wb'’ returns a ‘Wave_write’ object.  If `mode' is omitted and a
     file-like object is passed as `file', ‘file.mode’ is used as the
     default value for `mode'.

     If you pass in a file-like object, the wave object will not close
     it when its ‘close()’ method is called; it is the caller’s
     responsibility to close the file object.

     The *note open(): 46b. function may be used in a *note with: 6dd.
     statement.  When the ‘with’ block completes, the *note
     Wave_read.close(): 2f1c. or *note Wave_write.close(): 2f1d. method
     is called.

     Changed in version 3.4: Added support for unseekable files.

 -- Function: wave.openfp (file, mode)

     A synonym for *note open(): 46b, maintained for backwards
     compatibility.

     Deprecated since version 3.7, will be removed in version 3.9.

 -- Exception: wave.Error

     An error raised when something is impossible because it violates
     the WAV specification or hits an implementation deficiency.

* Menu:

* Wave_read Objects::
* Wave_write Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/wave.py


File: python.info,  Node: Wave_read Objects,  Next: Wave_write Objects,  Up: wave — Read and write WAV files

5.23.4.1 Wave_read Objects
..........................

Wave_read objects, as returned by *note open(): 46b, have the following
methods:

 -- Method: Wave_read.close ()

     Close the stream if it was opened by *note wave: 127, and make the
     instance unusable.  This is called automatically on object
     collection.

 -- Method: Wave_read.getnchannels ()

     Returns number of audio channels (‘1’ for mono, ‘2’ for stereo).

 -- Method: Wave_read.getsampwidth ()

     Returns sample width in bytes.

 -- Method: Wave_read.getframerate ()

     Returns sampling frequency.

 -- Method: Wave_read.getnframes ()

     Returns number of audio frames.

 -- Method: Wave_read.getcomptype ()

     Returns compression type (‘'NONE'’ is the only supported type).

 -- Method: Wave_read.getcompname ()

     Human-readable version of *note getcomptype(): 2f25.  Usually ‘'not
     compressed'’ parallels ‘'NONE'’.

 -- Method: Wave_read.getparams ()

     Returns a *note namedtuple(): 1b5. ‘(nchannels, sampwidth,
     framerate, nframes, comptype, compname)’, equivalent to output of
     the ‘get*()’ methods.

 -- Method: Wave_read.readframes (n)

     Reads and returns at most `n' frames of audio, as a *note bytes:
     326. object.

 -- Method: Wave_read.rewind ()

     Rewind the file pointer to the beginning of the audio stream.

The following two methods are defined for compatibility with the *note
aifc: 5. module, and don’t do anything interesting.

 -- Method: Wave_read.getmarkers ()

     Returns ‘None’.

 -- Method: Wave_read.getmark (id)

     Raise an error.

The following two methods define a term “position” which is compatible
between them, and is otherwise implementation dependent.

 -- Method: Wave_read.setpos (pos)

     Set the file pointer to the specified position.

 -- Method: Wave_read.tell ()

     Return current file pointer position.


File: python.info,  Node: Wave_write Objects,  Prev: Wave_read Objects,  Up: wave — Read and write WAV files

5.23.4.2 Wave_write Objects
...........................

For seekable output streams, the ‘wave’ header will automatically be
updated to reflect the number of frames actually written.  For
unseekable streams, the `nframes' value must be accurate when the first
frame data is written.  An accurate `nframes' value can be achieved
either by calling *note setnframes(): 2f2f. or *note setparams(): 2f30.
with the number of frames that will be written before *note close():
2f1d. is called and then using *note writeframesraw(): 900. to write the
frame data, or by calling *note writeframes(): 901. with all of the
frame data to be written.  In the latter case *note writeframes(): 901.
will calculate the number of frames in the data and set `nframes'
accordingly before writing the frame data.

Wave_write objects, as returned by *note open(): 46b, have the following
methods:

Changed in version 3.4: Added support for unseekable files.

 -- Method: Wave_write.close ()

     Make sure `nframes' is correct, and close the file if it was opened
     by *note wave: 127.  This method is called upon object collection.
     It will raise an exception if the output stream is not seekable and
     `nframes' does not match the number of frames actually written.

 -- Method: Wave_write.setnchannels (n)

     Set the number of channels.

 -- Method: Wave_write.setsampwidth (n)

     Set the sample width to `n' bytes.

 -- Method: Wave_write.setframerate (n)

     Set the frame rate to `n'.

     Changed in version 3.2: A non-integral input to this method is
     rounded to the nearest integer.

 -- Method: Wave_write.setnframes (n)

     Set the number of frames to `n'.  This will be changed later if the
     number of frames actually written is different (this update attempt
     will raise an error if the output stream is not seekable).

 -- Method: Wave_write.setcomptype (type, name)

     Set the compression type and description.  At the moment, only
     compression type ‘NONE’ is supported, meaning no compression.

 -- Method: Wave_write.setparams (tuple)

     The `tuple' should be ‘(nchannels, sampwidth, framerate, nframes,
     comptype, compname)’, with values valid for the ‘set*()’ methods.
     Sets all parameters.

 -- Method: Wave_write.tell ()

     Return current position in the file, with the same disclaimer for
     the *note Wave_read.tell(): 2f2d. and *note Wave_read.setpos():
     2f2c. methods.

 -- Method: Wave_write.writeframesraw (data)

     Write audio frames, without correcting `nframes'.

     Changed in version 3.4: Any *note bytes-like object: 5dd. is now
     accepted.

 -- Method: Wave_write.writeframes (data)

     Write audio frames and make sure `nframes' is correct.  It will
     raise an error if the output stream is not seekable and the total
     number of frames that have been written after `data' has been
     written does not match the previously set value for `nframes'.

     Changed in version 3.4: Any *note bytes-like object: 5dd. is now
     accepted.

Note that it is invalid to set any parameters after calling
‘writeframes()’ or ‘writeframesraw()’, and any attempt to do so will
raise *note wave.Error: 2f1e.


File: python.info,  Node: chunk — Read IFF chunked data,  Next: colorsys — Conversions between color systems,  Prev: wave — Read and write WAV files,  Up: Multimedia Services

5.23.5 ‘chunk’ — Read IFF chunked data
--------------------------------------

`Source code:' Lib/chunk.py(1)

__________________________________________________________________

This module provides an interface for reading files that use EA IFF 85
chunks.  (2) This format is used in at least the Audio Interchange File
Format (AIFF/AIFF-C) and the Real Media File Format (RMFF). The WAVE
audio file format is closely related and can also be read using this
module.

A chunk has the following structure:

Offset        Length       Contents
                           
---------------------------------------------------------------
                           
0             4            Chunk ID
                           
                           
4             4            Size of chunk in big-endian byte
                           order, not including the header
                           
                           
8             `n'          Data bytes, where `n' is the size
                           given in the preceding field
                           
                           
8 + `n'       0 or 1       Pad byte needed if `n' is odd and
                           chunk alignment is used
                           

The ID is a 4-byte string which identifies the type of chunk.

The size field (a 32-bit value, encoded using big-endian byte order)
gives the size of the chunk data, not including the 8-byte header.

Usually an IFF-type file consists of one or more chunks.  The proposed
usage of the *note Chunk: 2f38. class defined here is to instantiate an
instance at the start of each chunk and read from the instance until it
reaches the end, after which a new instance can be instantiated.  At the
end of the file, creating a new instance will fail with an *note
EOFError: c5f. exception.

 -- Class: chunk.Chunk (file, align=True, bigendian=True,
          inclheader=False)

     Class which represents a chunk.  The `file' argument is expected to
     be a file-like object.  An instance of this class is specifically
     allowed.  The only method that is needed is ‘read()’.  If the
     methods *note seek(): 1cd1. and *note tell(): 1cd2. are present and
     don’t raise an exception, they are also used.  If these methods are
     present and raise an exception, they are expected to not have
     altered the object.  If the optional argument `align' is true,
     chunks are assumed to be aligned on 2-byte boundaries.  If `align'
     is false, no alignment is assumed.  The default value is true.  If
     the optional argument `bigendian' is false, the chunk size is
     assumed to be in little-endian order.  This is needed for WAVE
     audio files.  The default value is true.  If the optional argument
     `inclheader' is true, the size given in the chunk header includes
     the size of the header.  The default value is false.

     A *note Chunk: 2f38. object supports the following methods:

      -- Method: getname ()

          Returns the name (ID) of the chunk.  This is the first 4 bytes
          of the chunk.

      -- Method: getsize ()

          Returns the size of the chunk.

      -- Method: close ()

          Close and skip to the end of the chunk.  This does not close
          the underlying file.

     The remaining methods will raise *note OSError: 1d1. if called
     after the *note close(): 2f3b. method has been called.  Before
     Python 3.3, they used to raise *note IOError: 986, now an alias of
     *note OSError: 1d1.

      -- Method: isatty ()

          Returns ‘False’.

      -- Method: seek (pos, whence=0)

          Set the chunk’s current position.  The `whence' argument is
          optional and defaults to ‘0’ (absolute file positioning);
          other values are ‘1’ (seek relative to the current position)
          and ‘2’ (seek relative to the file’s end).  There is no return
          value.  If the underlying file does not allow seek, only
          forward seeks are allowed.

      -- Method: tell ()

          Return the current position into the chunk.

      -- Method: read (size=-1)

          Read at most `size' bytes from the chunk (less if the read
          hits the end of the chunk before obtaining `size' bytes).  If
          the `size' argument is negative or omitted, read all data
          until the end of the chunk.  An empty bytes object is returned
          when the end of the chunk is encountered immediately.

      -- Method: skip ()

          Skip to the end of the chunk.  All further calls to *note
          read(): 2f3f. for the chunk will return ‘b''’.  If you are not
          interested in the contents of the chunk, this method should be
          called so that the file points to the start of the next chunk.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/chunk.py

   (2) (1) “EA IFF 85” Standard for Interchange Format Files, Jerry
Morrison, Electronic Arts, January 1985.


File: python.info,  Node: colorsys — Conversions between color systems,  Next: imghdr — Determine the type of an image,  Prev: chunk — Read IFF chunked data,  Up: Multimedia Services

5.23.6 ‘colorsys’ — Conversions between color systems
-----------------------------------------------------

`Source code:' Lib/colorsys.py(1)

__________________________________________________________________

The *note colorsys: 20. module defines bidirectional conversions of
color values between colors expressed in the RGB (Red Green Blue) color
space used in computer monitors and three other coordinate systems: YIQ,
HLS (Hue Lightness Saturation) and HSV (Hue Saturation Value).
Coordinates in all of these color spaces are floating point values.  In
the YIQ space, the Y coordinate is between 0 and 1, but the I and Q
coordinates can be positive or negative.  In all other spaces, the
coordinates are all between 0 and 1.

See also
........

More information about color spaces can be found at
‘http://poynton.ca/ColorFAQ.html’ and
‘https://www.cambridgeincolour.com/tutorials/color-spaces.htm’.

The *note colorsys: 20. module defines the following functions:

 -- Function: colorsys.rgb_to_yiq (r, g, b)

     Convert the color from RGB coordinates to YIQ coordinates.

 -- Function: colorsys.yiq_to_rgb (y, i, q)

     Convert the color from YIQ coordinates to RGB coordinates.

 -- Function: colorsys.rgb_to_hls (r, g, b)

     Convert the color from RGB coordinates to HLS coordinates.

 -- Function: colorsys.hls_to_rgb (h, l, s)

     Convert the color from HLS coordinates to RGB coordinates.

 -- Function: colorsys.rgb_to_hsv (r, g, b)

     Convert the color from RGB coordinates to HSV coordinates.

 -- Function: colorsys.hsv_to_rgb (h, s, v)

     Convert the color from HSV coordinates to RGB coordinates.

Example:

     >>> import colorsys >>> colorsys.rgb_to_hsv(0.2, 0.4, 0.4) (0.5, 0.5, 0.4) >>> colorsys.hsv_to_rgb(0.5, 0.5, 0.4) (0.2, 0.4, 0.4)

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/colorsys.py


File: python.info,  Node: imghdr — Determine the type of an image,  Next: sndhdr — Determine type of sound file,  Prev: colorsys — Conversions between color systems,  Up: Multimedia Services

5.23.7 ‘imghdr’ — Determine the type of an image
------------------------------------------------

`Source code:' Lib/imghdr.py(1)

__________________________________________________________________

The *note imghdr: 99. module determines the type of image contained in a
file or byte stream.

The *note imghdr: 99. module defines the following function:

 -- Function: imghdr.what (filename, h=None)

     Tests the image data contained in the file named by `filename', and
     returns a string describing the image type.  If optional `h' is
     provided, the `filename' is ignored and `h' is assumed to contain
     the byte stream to test.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

The following image types are recognized, as listed below with the
return value from *note what(): 6e1.:

Value            Image format
                 
---------------------------------------------------------
                 
‘'rgb'’          SGI ImgLib Files
                 
                 
‘'gif'’          GIF 87a and 89a Files
                 
                 
‘'pbm'’          Portable Bitmap Files
                 
                 
‘'pgm'’          Portable Graymap Files
                 
                 
‘'ppm'’          Portable Pixmap Files
                 
                 
‘'tiff'’         TIFF Files
                 
                 
‘'rast'’         Sun Raster Files
                 
                 
‘'xbm'’          X Bitmap Files
                 
                 
‘'jpeg'’         JPEG data in JFIF or Exif formats
                 
                 
‘'bmp'’          BMP files
                 
                 
‘'png'’          Portable Network Graphics
                 
                 
‘'webp'’         WebP files
                 
                 
‘'exr'’          OpenEXR Files
                 

New in version 3.5: The `exr' and `webp' formats were added.

You can extend the list of file types *note imghdr: 99. can recognize by
appending to this variable:

 -- Data: imghdr.tests

     A list of functions performing the individual tests.  Each function
     takes two arguments: the byte-stream and an open file-like object.
     When *note what(): 6e1. is called with a byte-stream, the file-like
     object will be ‘None’.

     The test function should return a string describing the image type
     if the test succeeded, or ‘None’ if it failed.

Example:

     >>> import imghdr >>> imghdr.what('bass.gif') 'gif'

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/imghdr.py


File: python.info,  Node: sndhdr — Determine type of sound file,  Next: ossaudiodev — Access to OSS-compatible audio devices,  Prev: imghdr — Determine the type of an image,  Up: Multimedia Services

5.23.8 ‘sndhdr’ — Determine type of sound file
----------------------------------------------

`Source code:' Lib/sndhdr.py(1)

__________________________________________________________________

The *note sndhdr: ee. provides utility functions which attempt to
determine the type of sound data which is in a file.  When these
functions are able to determine what type of sound data is stored in a
file, they return a *note namedtuple(): 1b5, containing five attributes:
(‘filetype’, ‘framerate’, ‘nchannels’, ‘nframes’, ‘sampwidth’).  The
value for `type' indicates the data type and will be one of the strings
‘'aifc'’, ‘'aiff'’, ‘'au'’, ‘'hcom'’, ‘'sndr'’, ‘'sndt'’, ‘'voc'’,
‘'wav'’, ‘'8svx'’, ‘'sb'’, ‘'ub'’, or ‘'ul'’.  The `sampling_rate' will
be either the actual value or ‘0’ if unknown or difficult to decode.
Similarly, `channels' will be either the number of channels or ‘0’ if it
cannot be determined or if the value is difficult to decode.  The value
for `frames' will be either the number of frames or ‘-1’.  The last item
in the tuple, `bits_per_sample', will either be the sample size in bits
or ‘'A'’ for A-LAW or ‘'U'’ for u-LAW.

 -- Function: sndhdr.what (filename)

     Determines the type of sound data stored in the file `filename'
     using *note whathdr(): 73c.  If it succeeds, returns a namedtuple
     as described above, otherwise ‘None’ is returned.

     Changed in version 3.5: Result changed from a tuple to a
     namedtuple.

 -- Function: sndhdr.whathdr (filename)

     Determines the type of sound data stored in a file based on the
     file header.  The name of the file is given by `filename'.  This
     function returns a namedtuple as described above on success, or
     ‘None’.

     Changed in version 3.5: Result changed from a tuple to a
     namedtuple.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/sndhdr.py


File: python.info,  Node: ossaudiodev — Access to OSS-compatible audio devices,  Prev: sndhdr — Determine type of sound file,  Up: Multimedia Services

5.23.9 ‘ossaudiodev’ — Access to OSS-compatible audio devices
-------------------------------------------------------------

__________________________________________________________________

This module allows you to access the OSS (Open Sound System) audio
interface.  OSS is available for a wide range of open-source and
commercial Unices, and is the standard audio interface for Linux and
recent versions of FreeBSD.

Changed in version 3.3: Operations in this module now raise *note
OSError: 1d1. where *note IOError: 986. was raised.

See also
........

Open Sound System Programmer’s Guide(1)

     the official documentation for the OSS C API

The module defines a large number of constants supplied by the OSS
device driver; see ‘<sys/soundcard.h>’ on either Linux or FreeBSD for a
listing.

*note ossaudiodev: c6. defines the following variables and functions:

 -- Exception: ossaudiodev.OSSAudioError

     This exception is raised on certain errors.  The argument is a
     string describing what went wrong.

     (If *note ossaudiodev: c6. receives an error from a system call
     such as ‘open()’, ‘write()’, or ‘ioctl()’, it raises *note OSError:
     1d1.  Errors detected directly by *note ossaudiodev: c6. result in
     *note OSSAudioError: 2f50.)

     (For backwards compatibility, the exception class is also available
     as ‘ossaudiodev.error’.)

 -- Function: ossaudiodev.open (mode)

 -- Function: ossaudiodev.open (device, mode)

     Open an audio device and return an OSS audio device object.  This
     object supports many file-like methods, such as ‘read()’,
     ‘write()’, and ‘fileno()’ (although there are subtle differences
     between conventional Unix read/write semantics and those of OSS
     audio devices).  It also supports a number of audio-specific
     methods; see below for the complete list of methods.

     `device' is the audio device filename to use.  If it is not
     specified, this module first looks in the environment variable
     ‘AUDIODEV’ for a device to use.  If not found, it falls back to
     ‘/dev/dsp’.

     `mode' is one of ‘'r'’ for read-only (record) access, ‘'w'’ for
     write-only (playback) access and ‘'rw'’ for both.  Since many sound
     cards only allow one process to have the recorder or player open at
     a time, it is a good idea to open the device only for the activity
     needed.  Further, some sound cards are half-duplex: they can be
     opened for reading or writing, but not both at once.

     Note the unusual calling syntax: the `first' argument is optional,
     and the second is required.  This is a historical artifact for
     compatibility with the older ‘linuxaudiodev’ module which *note
     ossaudiodev: c6. supersedes.

 -- Function: ossaudiodev.openmixer ([device])

     Open a mixer device and return an OSS mixer device object.
     `device' is the mixer device filename to use.  If it is not
     specified, this module first looks in the environment variable
     ‘MIXERDEV’ for a device to use.  If not found, it falls back to
     ‘/dev/mixer’.

* Menu:

* Audio Device Objects::
* Mixer Device Objects::

   ---------- Footnotes ----------

   (1) http://www.opensound.com/pguide/oss.pdf


File: python.info,  Node: Audio Device Objects,  Next: Mixer Device Objects,  Up: ossaudiodev — Access to OSS-compatible audio devices

5.23.9.1 Audio Device Objects
.............................

Before you can write to or read from an audio device, you must call
three methods in the correct order:

  1. ‘setfmt()’ to set the output format

  2. ‘channels()’ to set the number of channels

  3. ‘speed()’ to set the sample rate

Alternately, you can use the ‘setparameters()’ method to set all three
audio parameters at once.  This is more convenient, but may not be as
flexible in all cases.

The audio device objects returned by *note open(): 2f51. define the
following methods and (read-only) attributes:

 -- Method: oss_audio_device.close ()

     Explicitly close the audio device.  When you are done writing to or
     reading from an audio device, you should explicitly close it.  A
     closed device cannot be used again.

 -- Method: oss_audio_device.fileno ()

     Return the file descriptor associated with the device.

 -- Method: oss_audio_device.read (size)

     Read `size' bytes from the audio input and return them as a Python
     string.  Unlike most Unix device drivers, OSS audio devices in
     blocking mode (the default) will block *note read(): 2f57. until
     the entire requested amount of data is available.

 -- Method: oss_audio_device.write (data)

     Write a *note bytes-like object: 5dd. `data' to the audio device
     and return the number of bytes written.  If the audio device is in
     blocking mode (the default), the entire data is always written
     (again, this is different from usual Unix device semantics).  If
     the device is in non-blocking mode, some data may not be
     written—see *note writeall(): 2f59.

     Changed in version 3.5: Writable *note bytes-like object: 5dd. is
     now accepted.

 -- Method: oss_audio_device.writeall (data)

     Write a *note bytes-like object: 5dd. `data' to the audio device:
     waits until the audio device is able to accept data, writes as much
     data as it will accept, and repeats until `data' has been
     completely written.  If the device is in blocking mode (the
     default), this has the same effect as *note write(): 2f58.; *note
     writeall(): 2f59. is only useful in non-blocking mode.  Has no
     return value, since the amount of data written is always equal to
     the amount of data supplied.

     Changed in version 3.5: Writable *note bytes-like object: 5dd. is
     now accepted.

Changed in version 3.2: Audio device objects also support the context
management protocol, i.e.  they can be used in a *note with: 6dd.
statement.

The following methods each map to exactly one ‘ioctl()’ system call.
The correspondence is obvious: for example, ‘setfmt()’ corresponds to
the ‘SNDCTL_DSP_SETFMT’ ioctl, and ‘sync()’ to ‘SNDCTL_DSP_SYNC’ (this
can be useful when consulting the OSS documentation).  If the underlying
‘ioctl()’ fails, they all raise *note OSError: 1d1.

 -- Method: oss_audio_device.nonblock ()

     Put the device into non-blocking mode.  Once in non-blocking mode,
     there is no way to return it to blocking mode.

 -- Method: oss_audio_device.getfmts ()

     Return a bitmask of the audio output formats supported by the
     soundcard.  Some of the formats supported by OSS are:

     Format                        Description
                                   
     --------------------------------------------------------------------------------
                                   
     ‘AFMT_MU_LAW’                 a logarithmic encoding (used by Sun ‘.au’ files
                                   and ‘/dev/audio’)
                                   
                                   
     ‘AFMT_A_LAW’                  a logarithmic encoding
                                   
                                   
     ‘AFMT_IMA_ADPCM’              a 4:1 compressed format defined by the
                                   Interactive Multimedia Association
                                   
                                   
     ‘AFMT_U8’                     Unsigned, 8-bit audio
                                   
                                   
     ‘AFMT_S16_LE’                 Signed, 16-bit audio, little-endian byte order
                                   (as used by Intel processors)
                                   
                                   
     ‘AFMT_S16_BE’                 Signed, 16-bit audio, big-endian byte order (as
                                   used by 68k, PowerPC, Sparc)
                                   
                                   
     ‘AFMT_S8’                     Signed, 8 bit audio
                                   
                                   
     ‘AFMT_U16_LE’                 Unsigned, 16-bit little-endian audio
                                   
                                   
     ‘AFMT_U16_BE’                 Unsigned, 16-bit big-endian audio
                                   

     Consult the OSS documentation for a full list of audio formats, and
     note that most devices support only a subset of these formats.
     Some older devices only support ‘AFMT_U8’; the most common format
     used today is ‘AFMT_S16_LE’.

 -- Method: oss_audio_device.setfmt (format)

     Try to set the current audio format to `format'—see *note
     getfmts(): 2f5b. for a list.  Returns the audio format that the
     device was set to, which may not be the requested format.  May also
     be used to return the current audio format—do this by passing an
     “audio format” of ‘AFMT_QUERY’.

 -- Method: oss_audio_device.channels (nchannels)

     Set the number of output channels to `nchannels'.  A value of 1
     indicates monophonic sound, 2 stereophonic.  Some devices may have
     more than 2 channels, and some high-end devices may not support
     mono.  Returns the number of channels the device was set to.

 -- Method: oss_audio_device.speed (samplerate)

     Try to set the audio sampling rate to `samplerate' samples per
     second.  Returns the rate actually set.  Most sound devices don’t
     support arbitrary sampling rates.  Common rates are:

     Rate        Description
                 
     ------------------------------------------------------------
                 
     8000        default rate for ‘/dev/audio’
                 
                 
     11025       speech recording
                 
                 
     22050

     44100       CD quality audio (at 16 bits/sample and 2
                 channels)
                 
                 
     96000       DVD quality audio (at 24 bits/sample)
                 

 -- Method: oss_audio_device.sync ()

     Wait until the sound device has played every byte in its buffer.
     (This happens implicitly when the device is closed.)  The OSS
     documentation recommends closing and re-opening the device rather
     than using *note sync(): 2f5f.

 -- Method: oss_audio_device.reset ()

     Immediately stop playing or recording and return the device to a
     state where it can accept commands.  The OSS documentation
     recommends closing and re-opening the device after calling *note
     reset(): 2f60.

 -- Method: oss_audio_device.post ()

     Tell the driver that there is likely to be a pause in the output,
     making it possible for the device to handle the pause more
     intelligently.  You might use this after playing a spot sound
     effect, before waiting for user input, or before doing disk I/O.

The following convenience methods combine several ioctls, or one ioctl
and some simple calculations.

 -- Method: oss_audio_device.setparameters (format, nchannels,
          samplerate[, strict=False])

     Set the key audio sampling parameters—sample format, number of
     channels, and sampling rate—in one method call.  `format',
     `nchannels', and `samplerate' should be as specified in the *note
     setfmt(): 2f5c, *note channels(): 2f5d, and *note speed(): 2f5e.
     methods.  If `strict' is true, *note setparameters(): 2f62. checks
     to see if each parameter was actually set to the requested value,
     and raises *note OSSAudioError: 2f50. if not.  Returns a tuple
     (`format', `nchannels', `samplerate') indicating the parameter
     values that were actually set by the device driver (i.e., the same
     as the return values of *note setfmt(): 2f5c, *note channels():
     2f5d, and *note speed(): 2f5e.).

     For example,

          (fmt, channels, rate) = dsp.setparameters(fmt, channels, rate)

     is equivalent to

          fmt = dsp.setfmt(fmt) channels = dsp.channels(channels) rate = dsp.rate(rate)

 -- Method: oss_audio_device.bufsize ()

     Returns the size of the hardware buffer, in samples.

 -- Method: oss_audio_device.obufcount ()

     Returns the number of samples that are in the hardware buffer yet
     to be played.

 -- Method: oss_audio_device.obuffree ()

     Returns the number of samples that could be queued into the
     hardware buffer to be played without blocking.

Audio device objects also support several read-only attributes:

 -- Attribute: oss_audio_device.closed

     Boolean indicating whether the device has been closed.

 -- Attribute: oss_audio_device.name

     String containing the name of the device file.

 -- Attribute: oss_audio_device.mode

     The I/O mode for the file, either ‘"r"’, ‘"rw"’, or ‘"w"’.


File: python.info,  Node: Mixer Device Objects,  Prev: Audio Device Objects,  Up: ossaudiodev — Access to OSS-compatible audio devices

5.23.9.2 Mixer Device Objects
.............................

The mixer object provides two file-like methods:

 -- Method: oss_mixer_device.close ()

     This method closes the open mixer device file.  Any further
     attempts to use the mixer after this file is closed will raise an
     *note OSError: 1d1.

 -- Method: oss_mixer_device.fileno ()

     Returns the file handle number of the open mixer device file.

Changed in version 3.2: Mixer objects also support the context
management protocol.

The remaining methods are specific to audio mixing:

 -- Method: oss_mixer_device.controls ()

     This method returns a bitmask specifying the available mixer
     controls (“Control” being a specific mixable “channel”, such as
     ‘SOUND_MIXER_PCM’ or ‘SOUND_MIXER_SYNTH’).  This bitmask indicates
     a subset of all available mixer controls—the ‘SOUND_MIXER_*’
     constants defined at module level.  To determine if, for example,
     the current mixer object supports a PCM mixer, use the following
     Python code:

          mixer=ossaudiodev.openmixer() if mixer.controls() & (1 << ossaudiodev.SOUND_MIXER_PCM):     # PCM is supported     ... code ...

     For most purposes, the ‘SOUND_MIXER_VOLUME’ (master volume) and
     ‘SOUND_MIXER_PCM’ controls should suffice—but code that uses the
     mixer should be flexible when it comes to choosing mixer controls.
     On the Gravis Ultrasound, for example, ‘SOUND_MIXER_VOLUME’ does
     not exist.

 -- Method: oss_mixer_device.stereocontrols ()

     Returns a bitmask indicating stereo mixer controls.  If a bit is
     set, the corresponding control is stereo; if it is unset, the
     control is either monophonic or not supported by the mixer (use in
     combination with *note controls(): 2f6d. to determine which).

     See the code example for the *note controls(): 2f6d. function for
     an example of getting data from a bitmask.

 -- Method: oss_mixer_device.reccontrols ()

     Returns a bitmask specifying the mixer controls that may be used to
     record.  See the code example for *note controls(): 2f6d. for an
     example of reading from a bitmask.

 -- Method: oss_mixer_device.get (control)

     Returns the volume of a given mixer control.  The returned volume
     is a 2-tuple ‘(left_volume,right_volume)’.  Volumes are specified
     as numbers from 0 (silent) to 100 (full volume).  If the control is
     monophonic, a 2-tuple is still returned, but both volumes are the
     same.

     Raises *note OSSAudioError: 2f50. if an invalid control is
     specified, or *note OSError: 1d1. if an unsupported control is
     specified.

 -- Method: oss_mixer_device.set (control, (left, right))

     Sets the volume for a given mixer control to ‘(left,right)’.
     ‘left’ and ‘right’ must be ints and between 0 (silent) and 100
     (full volume).  On success, the new volume is returned as a
     2-tuple.  Note that this may not be exactly the same as the volume
     specified, because of the limited resolution of some soundcard’s
     mixers.

     Raises *note OSSAudioError: 2f50. if an invalid mixer control was
     specified, or if the specified volumes were out-of-range.

 -- Method: oss_mixer_device.get_recsrc ()

     This method returns a bitmask indicating which control(s) are
     currently being used as a recording source.

 -- Method: oss_mixer_device.set_recsrc (bitmask)

     Call this function to specify a recording source.  Returns a
     bitmask indicating the new recording source (or sources) if
     successful; raises *note OSError: 1d1. if an invalid source was
     specified.  To set the current recording source to the microphone
     input:

          mixer.setrecsrc (1 << ossaudiodev.SOUND_MIXER_MIC)


File: python.info,  Node: Internationalization,  Next: Program Frameworks,  Prev: Multimedia Services,  Up: The Python Standard Library

5.24 Internationalization
=========================

The modules described in this chapter help you write software that is
independent of language and locale by providing mechanisms for selecting
a language to be used in program messages or by tailoring output to
match local conventions.

The list of modules described in this chapter is:

* Menu:

* gettext — Multilingual internationalization services::
* locale — Internationalization services::


File: python.info,  Node: gettext — Multilingual internationalization services,  Next: locale — Internationalization services,  Up: Internationalization

5.24.1 ‘gettext’ — Multilingual internationalization services
-------------------------------------------------------------

`Source code:' Lib/gettext.py(1)

__________________________________________________________________

The *note gettext: 89. module provides internationalization (I18N) and
localization (L10N) services for your Python modules and applications.
It supports both the GNU ‘gettext’ message catalog API and a higher
level, class-based API that may be more appropriate for Python files.
The interface described below allows you to write your module and
application messages in one natural language, and provide a catalog of
translated messages for running under different natural languages.

Some hints on localizing your Python modules and applications are also
given.

* Menu:

* GNU gettext API::
* Class-based API::
* Internationalizing your programs and modules::
* Acknowledgements: Acknowledgements<9>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/gettext.py


File: python.info,  Node: GNU gettext API,  Next: Class-based API,  Up: gettext — Multilingual internationalization services

5.24.1.1 GNU ‘gettext’ API
..........................

The *note gettext: 89. module defines the following API, which is very
similar to the GNU ‘gettext’ API. If you use this API you will affect
the translation of your entire application globally.  Often this is what
you want if your application is monolingual, with the choice of language
dependent on the locale of your user.  If you are localizing a Python
module, or if your application needs to switch languages on the fly, you
probably want to use the class-based API instead.

 -- Function: gettext.bindtextdomain (domain, localedir=None)

     Bind the `domain' to the locale directory `localedir'.  More
     concretely, *note gettext: 89. will look for binary ‘.mo’ files for
     the given domain using the path (on Unix):
     ‘`localedir'/`language'/LC_MESSAGES/`domain'.mo’, where `language'
     is searched for in the environment variables ‘LANGUAGE’, ‘LC_ALL’,
     ‘LC_MESSAGES’, and ‘LANG’ respectively.

     If `localedir' is omitted or ‘None’, then the current binding for
     `domain' is returned.  (1)

 -- Function: gettext.bind_textdomain_codeset (domain, codeset=None)

     Bind the `domain' to `codeset', changing the encoding of byte
     strings returned by the *note lgettext(): 291, *note ldgettext():
     292, *note lngettext(): 293. and *note ldngettext(): 294.
     functions.  If `codeset' is omitted, then the current binding is
     returned.

     Deprecated since version 3.8, will be removed in version 3.10.

 -- Function: gettext.textdomain (domain=None)

     Change or query the current global domain.  If `domain' is ‘None’,
     then the current global domain is returned, otherwise the global
     domain is set to `domain', which is returned.

 -- Function: gettext.gettext (message)

     Return the localized translation of `message', based on the current
     global domain, language, and locale directory.  This function is
     usually aliased as ‘_()’ in the local namespace (see examples
     below).

 -- Function: gettext.dgettext (domain, message)

     Like *note gettext(): dc0, but look the message up in the specified
     `domain'.

 -- Function: gettext.ngettext (singular, plural, n)

     Like *note gettext(): dc0, but consider plural forms.  If a
     translation is found, apply the plural formula to `n', and return
     the resulting message (some languages have more than two plural
     forms).  If no translation is found, return `singular' if `n' is 1;
     return `plural' otherwise.

     The Plural formula is taken from the catalog header.  It is a C or
     Python expression that has a free variable `n'; the expression
     evaluates to the index of the plural in the catalog.  See the GNU
     gettext documentation(2) for the precise syntax to be used in ‘.po’
     files and the formulas for a variety of languages.

 -- Function: gettext.dngettext (domain, singular, plural, n)

     Like *note ngettext(): 2f7e, but look the message up in the
     specified `domain'.

 -- Function: gettext.pgettext (context, message)

 -- Function: gettext.dpgettext (domain, context, message)

 -- Function: gettext.npgettext (context, singular, plural, n)

 -- Function: gettext.dnpgettext (domain, context, singular, plural, n)

     Similar to the corresponding functions without the ‘p’ in the
     prefix (that is, *note gettext(): 89, *note dgettext(): 2f7d, *note
     ngettext(): 2f7e, *note dngettext(): 2f7f.), but the translation is
     restricted to the given message `context'.

     New in version 3.8.

 -- Function: gettext.lgettext (message)

 -- Function: gettext.ldgettext (domain, message)

 -- Function: gettext.lngettext (singular, plural, n)

 -- Function: gettext.ldngettext (domain, singular, plural, n)

     Equivalent to the corresponding functions without the ‘l’ prefix
     (*note gettext(): dc0, *note dgettext(): 2f7d, *note ngettext():
     2f7e. and *note dngettext(): 2f7f.), but the translation is
     returned as a byte string encoded in the preferred system encoding
     if no other encoding was explicitly set with *note
     bind_textdomain_codeset(): 295.

          Warning: These functions should be avoided in Python 3,
          because they return encoded bytes.  It’s much better to use
          alternatives which return Unicode strings instead, since most
          Python applications will want to manipulate human readable
          text as strings instead of bytes.  Further, it’s possible that
          you may get unexpected Unicode-related exceptions if there are
          encoding problems with the translated strings.

     Deprecated since version 3.8, will be removed in version 3.10.

Note that GNU ‘gettext’ also defines a ‘dcgettext()’ method, but this
was deemed not useful and so it is currently unimplemented.

Here’s an example of typical usage for this API:

     import gettext gettext.bindtextdomain('myapplication', '/path/to/my/language/directory') gettext.textdomain('myapplication') _ = gettext.gettext # ... print(_('This is a translatable string.'))

   ---------- Footnotes ----------

   (1) (1) The default locale directory is system dependent; for
example, on RedHat Linux it is ‘/usr/share/locale’, but on Solaris it is
‘/usr/lib/locale’.  The *note gettext: 89. module does not try to
support these system dependent defaults; instead its default is
‘`sys.prefix'/share/locale’ (see *note sys.prefix: 2f7b.).  For this
reason, it is always best to call *note bindtextdomain(): 2f7a. with an
explicit absolute path at the start of your application.

   (2) https://www.gnu.org/software/gettext/manual/gettext.html


File: python.info,  Node: Class-based API,  Next: Internationalizing your programs and modules,  Prev: GNU gettext API,  Up: gettext — Multilingual internationalization services

5.24.1.2 Class-based API
........................

The class-based API of the *note gettext: 89. module gives you more
flexibility and greater convenience than the GNU ‘gettext’ API. It is
the recommended way of localizing your Python applications and modules.
‘gettext’ defines a *note GNUTranslations: 2f84. class which implements
the parsing of GNU ‘.mo’ format files, and has methods for returning
strings.  Instances of this class can also install themselves in the
built-in namespace as the function ‘_()’.

 -- Function: gettext.find (domain, localedir=None, languages=None,
          all=False)

     This function implements the standard ‘.mo’ file search algorithm.
     It takes a `domain', identical to what *note textdomain(): 2f7c.
     takes.  Optional `localedir' is as in *note bindtextdomain(): 2f7a.
     Optional `languages' is a list of strings, where each string is a
     language code.

     If `localedir' is not given, then the default system locale
     directory is used.  (1) If `languages' is not given, then the
     following environment variables are searched: ‘LANGUAGE’, ‘LC_ALL’,
     ‘LC_MESSAGES’, and ‘LANG’.  The first one returning a non-empty
     value is used for the `languages' variable.  The environment
     variables should contain a colon separated list of languages, which
     will be split on the colon to produce the expected list of language
     code strings.

     *note find(): 2f85. then expands and normalizes the languages, and
     then iterates through them, searching for an existing file built of
     these components:

     ‘`localedir'/`language'/LC_MESSAGES/`domain'.mo’

     The first such file name that exists is returned by *note find():
     2f85.  If no such file is found, then ‘None’ is returned.  If `all'
     is given, it returns a list of all file names, in the order in
     which they appear in the languages list or the environment
     variables.

 -- Function: gettext.translation (domain, localedir=None,
          languages=None, class_=None, fallback=False, codeset=None)

     Return a ‘*Translations’ instance based on the `domain',
     `localedir', and `languages', which are first passed to *note
     find(): 2f85. to get a list of the associated ‘.mo’ file paths.
     Instances with identical ‘.mo’ file names are cached.  The actual
     class instantiated is `class_' if provided, otherwise *note
     GNUTranslations: 2f84.  The class’s constructor must take a single
     *note file object: b35. argument.  If provided, `codeset' will
     change the charset used to encode translated strings in the *note
     lgettext(): 2f86. and *note lngettext(): 2f87. methods.

     If multiple files are found, later files are used as fallbacks for
     earlier ones.  To allow setting the fallback, *note copy.copy():
     3c0. is used to clone each translation object from the cache; the
     actual instance data is still shared with the cache.

     If no ‘.mo’ file is found, this function raises *note OSError: 1d1.
     if `fallback' is false (which is the default), and returns a *note
     NullTranslations: 2f88. instance if `fallback' is true.

     Changed in version 3.3: *note IOError: 986. used to be raised
     instead of *note OSError: 1d1.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `codeset' parameter.

 -- Function: gettext.install (domain, localedir=None, codeset=None,
          names=None)

     This installs the function ‘_()’ in Python’s builtins namespace,
     based on `domain', `localedir', and `codeset' which are passed to
     the function *note translation(): 298.

     For the `names' parameter, please see the description of the
     translation object’s *note install(): 2f89. method.

     As seen below, you usually mark the strings in your application
     that are candidates for translation, by wrapping them in a call to
     the ‘_()’ function, like this:

          print(_('This string will be translated.'))

     For convenience, you want the ‘_()’ function to be installed in
     Python’s builtins namespace, so it is easily accessible in all
     modules of your application.

     Deprecated since version 3.8, will be removed in version 3.10: The
     `codeset' parameter.

* Menu:

* The NullTranslations class::
* The GNUTranslations class::
* Solaris message catalog support::
* The Catalog constructor::

   ---------- Footnotes ----------

   (1) (2) See the footnote for *note bindtextdomain(): 2f7a. above.


File: python.info,  Node: The NullTranslations class,  Next: The GNUTranslations class,  Up: Class-based API

5.24.1.3 The ‘NullTranslations’ class
.....................................

Translation classes are what actually implement the translation of
original source file message strings to translated message strings.  The
base class used by all translation classes is *note NullTranslations:
2f88.; this provides the basic interface you can use to write your own
specialized translation classes.  Here are the methods of
‘NullTranslations’:

 -- Class: gettext.NullTranslations (fp=None)

     Takes an optional *note file object: b35. `fp', which is ignored by
     the base class.  Initializes “protected” instance variables `_info'
     and `_charset' which are set by derived classes, as well as
     `_fallback', which is set through *note add_fallback(): 2f8b.  It
     then calls ‘self._parse(fp)’ if `fp' is not ‘None’.

      -- Method: _parse (fp)

          No-op in the base class, this method takes file object `fp',
          and reads the data from the file, initializing its message
          catalog.  If you have an unsupported message catalog file
          format, you should override this method to parse your format.

      -- Method: add_fallback (fallback)

          Add `fallback' as the fallback object for the current
          translation object.  A translation object should consult the
          fallback if it cannot provide a translation for a given
          message.

      -- Method: gettext (message)

          If a fallback has been set, forward ‘gettext()’ to the
          fallback.  Otherwise, return `message'.  Overridden in derived
          classes.

      -- Method: ngettext (singular, plural, n)

          If a fallback has been set, forward ‘ngettext()’ to the
          fallback.  Otherwise, return `singular' if `n' is 1; return
          `plural' otherwise.  Overridden in derived classes.

      -- Method: pgettext (context, message)

          If a fallback has been set, forward *note pgettext(): 1cd. to
          the fallback.  Otherwise, return the translated message.
          Overridden in derived classes.

          New in version 3.8.

      -- Method: npgettext (context, singular, plural, n)

          If a fallback has been set, forward *note npgettext(): 2f81.
          to the fallback.  Otherwise, return the translated message.
          Overridden in derived classes.

          New in version 3.8.

      -- Method: lgettext (message)

      -- Method: lngettext (singular, plural, n)

          Equivalent to *note gettext(): 2f8d. and *note ngettext():
          2f8e, but the translation is returned as a byte string encoded
          in the preferred system encoding if no encoding was explicitly
          set with *note set_output_charset(): 297.  Overridden in
          derived classes.

               Warning: These methods should be avoided in Python 3.
               See the warning for the *note lgettext(): 291. function.

          Deprecated since version 3.8, will be removed in version 3.10.

      -- Method: info ()

          Return the “protected” ‘_info’ variable, a dictionary
          containing the metadata found in the message catalog file.

      -- Method: charset ()

          Return the encoding of the message catalog file.

      -- Method: output_charset ()

          Return the encoding used to return translated messages in
          *note lgettext(): 2f86. and *note lngettext(): 2f87.

          Deprecated since version 3.8, will be removed in version 3.10.

      -- Method: set_output_charset (charset)

          Change the encoding used to return translated messages.

          Deprecated since version 3.8, will be removed in version 3.10.

      -- Method: install (names=None)

          This method installs *note gettext(): 2f8d. into the built-in
          namespace, binding it to ‘_’.

          If the `names' parameter is given, it must be a sequence
          containing the names of functions you want to install in the
          builtins namespace in addition to ‘_()’.  Supported names are
          ‘'gettext'’, ‘'ngettext'’, ‘'pgettext'’, ‘'npgettext'’,
          ‘'lgettext'’, and ‘'lngettext'’.

          Note that this is only one way, albeit the most convenient
          way, to make the ‘_()’ function available to your application.
          Because it affects the entire application globally, and
          specifically the built-in namespace, localized modules should
          never install ‘_()’.  Instead, they should use this code to
          make ‘_()’ available to their module:

               import gettext t = gettext.translation('mymodule', ...) _ = t.gettext

          This puts ‘_()’ only in the module’s global namespace and so
          only affects calls within this module.

          Changed in version 3.8: Added ‘'pgettext'’ and ‘'npgettext'’.


File: python.info,  Node: The GNUTranslations class,  Next: Solaris message catalog support,  Prev: The NullTranslations class,  Up: Class-based API

5.24.1.4 The ‘GNUTranslations’ class
....................................

The *note gettext: 89. module provides one additional class derived from
*note NullTranslations: 2f88.: *note GNUTranslations: 2f84.  This class
overrides ‘_parse()’ to enable reading GNU ‘gettext’ format ‘.mo’ files
in both big-endian and little-endian format.

*note GNUTranslations: 2f84. parses optional metadata out of the
translation catalog.  It is convention with GNU ‘gettext’ to include
metadata as the translation for the empty string.  This metadata is in
RFC 822(1)-style ‘key: value’ pairs, and should contain the
‘Project-Id-Version’ key.  If the key ‘Content-Type’ is found, then the
‘charset’ property is used to initialize the “protected” ‘_charset’
instance variable, defaulting to ‘None’ if not found.  If the charset
encoding is specified, then all message ids and message strings read
from the catalog are converted to Unicode using this encoding, else
ASCII is assumed.

Since message ids are read as Unicode strings too, all ‘*gettext()’
methods will assume message ids as Unicode strings, not byte strings.

The entire set of key/value pairs are placed into a dictionary and set
as the “protected” ‘_info’ instance variable.

If the ‘.mo’ file’s magic number is invalid, the major version number is
unexpected, or if other problems occur while reading the file,
instantiating a *note GNUTranslations: 2f84. class can raise *note
OSError: 1d1.

 -- Class: gettext.GNUTranslations

     The following methods are overridden from the base class
     implementation:

      -- Method: gettext (message)

          Look up the `message' id in the catalog and return the
          corresponding message string, as a Unicode string.  If there
          is no entry in the catalog for the `message' id, and a
          fallback has been set, the look up is forwarded to the
          fallback’s *note gettext(): 2f8d. method.  Otherwise, the
          `message' id is returned.

      -- Method: ngettext (singular, plural, n)

          Do a plural-forms lookup of a message id.  `singular' is used
          as the message id for purposes of lookup in the catalog, while
          `n' is used to determine which plural form to use.  The
          returned message string is a Unicode string.

          If the message id is not found in the catalog, and a fallback
          is specified, the request is forwarded to the fallback’s *note
          ngettext(): 2f8e. method.  Otherwise, when `n' is 1 `singular'
          is returned, and `plural' is returned in all other cases.

          Here is an example:

               n = len(os.listdir('.')) cat = GNUTranslations(somefile) message = cat.ngettext(     'There is %(num)d file in this directory',     'There are %(num)d files in this directory',     n) % {'num': n}

      -- Method: pgettext (context, message)

          Look up the `context' and `message' id in the catalog and
          return the corresponding message string, as a Unicode string.
          If there is no entry in the catalog for the `message' id and
          `context', and a fallback has been set, the look up is
          forwarded to the fallback’s *note pgettext(): 1cd. method.
          Otherwise, the `message' id is returned.

          New in version 3.8.

      -- Method: npgettext (context, singular, plural, n)

          Do a plural-forms lookup of a message id.  `singular' is used
          as the message id for purposes of lookup in the catalog, while
          `n' is used to determine which plural form to use.

          If the message id for `context' is not found in the catalog,
          and a fallback is specified, the request is forwarded to the
          fallback’s *note npgettext(): 2f81. method.  Otherwise, when
          `n' is 1 `singular' is returned, and `plural' is returned in
          all other cases.

          New in version 3.8.

      -- Method: lgettext (message)

      -- Method: lngettext (singular, plural, n)

          Equivalent to *note gettext(): 2f94. and *note ngettext():
          2f95, but the translation is returned as a byte string encoded
          in the preferred system encoding if no encoding was explicitly
          set with *note set_output_charset(): 297.

               Warning: These methods should be avoided in Python 3.
               See the warning for the *note lgettext(): 291. function.

          Deprecated since version 3.8, will be removed in version 3.10.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc822.html


File: python.info,  Node: Solaris message catalog support,  Next: The Catalog constructor,  Prev: The GNUTranslations class,  Up: Class-based API

5.24.1.5 Solaris message catalog support
........................................

The Solaris operating system defines its own binary ‘.mo’ file format,
but since no documentation can be found on this format, it is not
supported at this time.


File: python.info,  Node: The Catalog constructor,  Prev: Solaris message catalog support,  Up: Class-based API

5.24.1.6 The Catalog constructor
................................

GNOME uses a version of the *note gettext: 89. module by James
Henstridge, but this version has a slightly different API. Its
documented usage was:

     import gettext cat = gettext.Catalog(domain, localedir) _ = cat.gettext print(_('hello world'))

For compatibility with this older module, the function ‘Catalog()’ is an
alias for the *note translation(): 298. function described above.

One difference between this module and Henstridge’s: his catalog objects
supported access through a mapping API, but this appears to be unused
and so is not currently supported.


File: python.info,  Node: Internationalizing your programs and modules,  Next: Acknowledgements<9>,  Prev: Class-based API,  Up: gettext — Multilingual internationalization services

5.24.1.7 Internationalizing your programs and modules
.....................................................

Internationalization (I18N) refers to the operation by which a program
is made aware of multiple languages.  Localization (L10N) refers to the
adaptation of your program, once internationalized, to the local
language and cultural habits.  In order to provide multilingual messages
for your Python programs, you need to take the following steps:

  1. prepare your program or module by specially marking translatable
     strings

  2. run a suite of tools over your marked files to generate raw
     messages catalogs

  3. create language-specific translations of the message catalogs

  4. use the *note gettext: 89. module so that message strings are
     properly translated

In order to prepare your code for I18N, you need to look at all the
strings in your files.  Any string that needs to be translated should be
marked by wrapping it in ‘_('...')’ — that is, a call to the function
‘_()’.  For example:

     filename = 'mylog.txt' message = _('writing a log message') with open(filename, 'w') as fp:     fp.write(message)

In this example, the string ‘'writing a log message'’ is marked as a
candidate for translation, while the strings ‘'mylog.txt'’ and ‘'w'’ are
not.

There are a few tools to extract the strings meant for translation.  The
original GNU ‘gettext’ only supported C or C++ source code but its
extended version ‘xgettext’ scans code written in a number of languages,
including Python, to find strings marked as translatable.  Babel(1) is a
Python internationalization library that includes a ‘pybabel’ script to
extract and compile message catalogs.  François Pinard’s program called
‘xpot’ does a similar job and is available as part of his po-utils
package(2).

(Python also includes pure-Python versions of these programs, called
‘pygettext.py’ and ‘msgfmt.py’; some Python distributions will install
them for you.  ‘pygettext.py’ is similar to ‘xgettext’, but only
understands Python source code and cannot handle other programming
languages such as C or C++.  ‘pygettext.py’ supports a command-line
interface similar to ‘xgettext’; for details on its use, run
‘pygettext.py --help’.  ‘msgfmt.py’ is binary compatible with GNU
‘msgfmt’.  With these two programs, you may not need the GNU ‘gettext’
package to internationalize your Python applications.)

‘xgettext’, ‘pygettext’, and similar tools generate ‘.po’ files that are
message catalogs.  They are structured human-readable files that contain
every marked string in the source code, along with a placeholder for the
translated versions of these strings.

Copies of these ‘.po’ files are then handed over to the individual human
translators who write translations for every supported natural language.
They send back the completed language-specific versions as a
‘<language-name>.po’ file that’s compiled into a machine-readable ‘.mo’
binary catalog file using the ‘msgfmt’ program.  The ‘.mo’ files are
used by the *note gettext: 89. module for the actual translation
processing at run-time.

How you use the *note gettext: 89. module in your code depends on
whether you are internationalizing a single module or your entire
application.  The next two sections will discuss each case.

* Menu:

* Localizing your module::
* Localizing your application::
* Changing languages on the fly::
* Deferred translations::

   ---------- Footnotes ----------

   (1) http://babel.pocoo.org/

   (2) https://github.com/pinard/po-utils


File: python.info,  Node: Localizing your module,  Next: Localizing your application,  Up: Internationalizing your programs and modules

5.24.1.8 Localizing your module
...............................

If you are localizing your module, you must take care not to make global
changes, e.g.  to the built-in namespace.  You should not use the GNU
‘gettext’ API but instead the class-based API.

Let’s say your module is called “spam” and the module’s various natural
language translation ‘.mo’ files reside in ‘/usr/share/locale’ in GNU
‘gettext’ format.  Here’s what you would put at the top of your module:

     import gettext t = gettext.translation('spam', '/usr/share/locale') _ = t.gettext


File: python.info,  Node: Localizing your application,  Next: Changing languages on the fly,  Prev: Localizing your module,  Up: Internationalizing your programs and modules

5.24.1.9 Localizing your application
....................................

If you are localizing your application, you can install the ‘_()’
function globally into the built-in namespace, usually in the main
driver file of your application.  This will let all your
application-specific files just use ‘_('...')’ without having to
explicitly install it in each file.

In the simple case then, you need only add the following bit of code to
the main driver file of your application:

     import gettext gettext.install('myapplication')

If you need to set the locale directory, you can pass it into the *note
install(): 299. function:

     import gettext gettext.install('myapplication', '/usr/share/locale')


File: python.info,  Node: Changing languages on the fly,  Next: Deferred translations,  Prev: Localizing your application,  Up: Internationalizing your programs and modules

5.24.1.10 Changing languages on the fly
.......................................

If your program needs to support many languages at the same time, you
may want to create multiple translation instances and then switch
between them explicitly, like so:

     import gettext  lang1 = gettext.translation('myapplication', languages=['en']) lang2 = gettext.translation('myapplication', languages=['fr']) lang3 = gettext.translation('myapplication', languages=['de'])  # start by using language1 lang1.install()  # ... time goes by, user selects language 2 lang2.install()  # ... more time goes by, user selects language 3 lang3.install()


File: python.info,  Node: Deferred translations,  Prev: Changing languages on the fly,  Up: Internationalizing your programs and modules

5.24.1.11 Deferred translations
...............................

In most coding situations, strings are translated where they are coded.
Occasionally however, you need to mark strings for translation, but
defer actual translation until later.  A classic example is:

     animals = ['mollusk',            'albatross',            'rat',            'penguin',            'python', ] # ... for a in animals:     print(a)

Here, you want to mark the strings in the ‘animals’ list as being
translatable, but you don’t actually want to translate them until they
are printed.

Here is one way you can handle this situation:

     def _(message): return message  animals = [_('mollusk'),            _('albatross'),            _('rat'),            _('penguin'),            _('python'), ]  del _  # ... for a in animals:     print(_(a))

This works because the dummy definition of ‘_()’ simply returns the
string unchanged.  And this dummy definition will temporarily override
any definition of ‘_()’ in the built-in namespace (until the *note del:
11a8. command).  Take care, though if you have a previous definition of
‘_()’ in the local namespace.

Note that the second use of ‘_()’ will not identify “a” as being
translatable to the ‘gettext’ program, because the parameter is not a
string literal.

Another way to handle this is with the following example:

     def N_(message): return message  animals = [N_('mollusk'),            N_('albatross'),            N_('rat'),            N_('penguin'),            N_('python'), ]  # ... for a in animals:     print(_(a))

In this case, you are marking translatable strings with the function
‘N_()’, which won’t conflict with any definition of ‘_()’.  However, you
will need to teach your message extraction program to look for
translatable strings marked with ‘N_()’.  ‘xgettext’, ‘pygettext’,
‘pybabel extract’, and ‘xpot’ all support this through the use of the
‘-k’ command-line switch.  The choice of ‘N_()’ here is totally
arbitrary; it could have just as easily been
‘MarkThisStringForTranslation()’.


File: python.info,  Node: Acknowledgements<9>,  Prev: Internationalizing your programs and modules,  Up: gettext — Multilingual internationalization services

5.24.1.12 Acknowledgements
..........................

The following people contributed code, feedback, design suggestions,
previous implementations, and valuable experience to the creation of
this module:

   * Peter Funk

   * James Henstridge

   * Juan David Ibáñez Palomar

   * Marc-André Lemburg

   * Martin von Löwis

   * François Pinard

   * Barry Warsaw

   * Gustavo Niemeyer


File: python.info,  Node: locale — Internationalization services,  Prev: gettext — Multilingual internationalization services,  Up: Internationalization

5.24.2 ‘locale’ — Internationalization services
-----------------------------------------------

`Source code:' Lib/locale.py(1)

__________________________________________________________________

The *note locale: a9. module opens access to the POSIX locale database
and functionality.  The POSIX locale mechanism allows programmers to
deal with certain cultural issues in an application, without requiring
the programmer to know all the specifics of each country where the
software is executed.

The *note locale: a9. module is implemented on top of the ‘_locale’
module, which in turn uses an ANSI C locale implementation if available.

The *note locale: a9. module defines the following exception and
functions:

 -- Exception: locale.Error

     Exception raised when the locale passed to *note setlocale(): 1f48.
     is not recognized.

 -- Function: locale.setlocale (category, locale=None)

     If `locale' is given and not ‘None’, *note setlocale(): 1f48.
     modifies the locale setting for the `category'.  The available
     categories are listed in the data description below.  `locale' may
     be a string, or an iterable of two strings (language code and
     encoding).  If it’s an iterable, it’s converted to a locale name
     using the locale aliasing engine.  An empty string specifies the
     user’s default settings.  If the modification of the locale fails,
     the exception *note Error: 2fa4. is raised.  If successful, the new
     locale setting is returned.

     If `locale' is omitted or ‘None’, the current setting for
     `category' is returned.

     *note setlocale(): 1f48. is not thread-safe on most systems.
     Applications typically start with a call of

          import locale locale.setlocale(locale.LC_ALL, '')

     This sets the locale for all categories to the user’s default
     setting (typically specified in the ‘LANG’ environment variable).
     If the locale is not changed thereafter, using multithreading
     should not cause problems.

 -- Function: locale.localeconv ()

     Returns the database of the local conventions as a dictionary.
     This dictionary has the following strings as keys:

     Category                   Key                                       Meaning
                                                                          
     ----------------------------------------------------------------------------------------------------------
                                                                          
     *note LC_NUMERIC: 2fa5.    ‘'decimal_point'’                         Decimal point character.
                                                                          
                                                                          
                                ‘'grouping'’                              Sequence of numbers specifying
                                                                          which relative positions the
                                                                          ‘'thousands_sep'’ is expected.  If
                                                                          the sequence is terminated with
                                                                          *note CHAR_MAX: 2fa6, no further
                                                                          grouping is performed.  If the
                                                                          sequence terminates with a ‘0’,
                                                                          the last group size is repeatedly
                                                                          used.
                                                                          
                                                                          
                                ‘'thousands_sep'’                         Character used between groups.
                                                                          
                                                                          
     *note LC_MONETARY: 2fa7.   ‘'int_curr_symbol'’                       International currency symbol.
                                                                          
                                                                          
                                ‘'currency_symbol'’                       Local currency symbol.
                                                                          
                                                                          
                                ‘'p_cs_precedes/n_cs_precedes'’           Whether the currency symbol
                                                                          precedes the value (for positive
                                                                          resp.  negative values).
                                                                          
                                                                          
                                ‘'p_sep_by_space/n_sep_by_space'’         Whether the currency symbol is
                                                                          separated from the value by a
                                                                          space (for positive resp.
                                                                          negative values).
                                                                          
                                                                          
                                ‘'mon_decimal_point'’                     Decimal point used for monetary
                                                                          values.
                                                                          
                                                                          
                                ‘'frac_digits'’                           Number of fractional digits used
                                                                          in local formatting of monetary
                                                                          values.
                                                                          
                                                                          
                                ‘'int_frac_digits'’                       Number of fractional digits used
                                                                          in international formatting of
                                                                          monetary values.
                                                                          
                                                                          
                                ‘'mon_thousands_sep'’                     Group separator used for monetary
                                                                          values.
                                                                          
                                                                          
                                ‘'mon_grouping'’                          Equivalent to ‘'grouping'’, used
                                                                          for monetary values.
                                                                          
                                                                          
                                ‘'positive_sign'’                         Symbol used to annotate a positive
                                                                          monetary value.
                                                                          
                                                                          
                                ‘'negative_sign'’                         Symbol used to annotate a negative
                                                                          monetary value.
                                                                          
                                                                          
                                ‘'p_sign_posn/n_sign_posn'’               The position of the sign (for
                                                                          positive resp.  negative values),
                                                                          see below.
                                                                          

     All numeric values can be set to *note CHAR_MAX: 2fa6. to indicate
     that there is no value specified in this locale.

     The possible values for ‘'p_sign_posn'’ and ‘'n_sign_posn'’ are
     given below.

     Value              Explanation
                        
     -----------------------------------------------------------------
                        
     ‘0’                Currency and value are surrounded by
                        parentheses.
                        
                        
     ‘1’                The sign should precede the value and
                        currency symbol.
                        
                        
     ‘2’                The sign should follow the value and
                        currency symbol.
                        
                        
     ‘3’                The sign should immediately precede the
                        value.
                        
                        
     ‘4’                The sign should immediately follow the
                        value.
                        
                        
     ‘CHAR_MAX’         Nothing is specified in this locale.
                        

     The function sets temporarily the ‘LC_CTYPE’ locale to the
     ‘LC_NUMERIC’ locale or the ‘LC_MONETARY’ locale if locales are
     different and numeric or monetary strings are non-ASCII. This
     temporary change affects other threads.

     Changed in version 3.7: The function now sets temporarily the
     ‘LC_CTYPE’ locale to the ‘LC_NUMERIC’ locale in some cases.

 -- Function: locale.nl_langinfo (option)

     Return some locale-specific information as a string.  This function
     is not available on all systems, and the set of possible options
     might also vary across platforms.  The possible argument values are
     numbers, for which symbolic constants are available in the locale
     module.

     The *note nl_langinfo(): 2fa8. function accepts one of the
     following keys.  Most descriptions are taken from the corresponding
     description in the GNU C library.

      -- Data: locale.CODESET

          Get a string with the name of the character encoding used in
          the selected locale.

      -- Data: locale.D_T_FMT

          Get a string that can be used as a format string for *note
          time.strftime(): b58. to represent date and time in a
          locale-specific way.

      -- Data: locale.D_FMT

          Get a string that can be used as a format string for *note
          time.strftime(): b58. to represent a date in a locale-specific
          way.

      -- Data: locale.T_FMT

          Get a string that can be used as a format string for *note
          time.strftime(): b58. to represent a time in a locale-specific
          way.

      -- Data: locale.T_FMT_AMPM

          Get a format string for *note time.strftime(): b58. to
          represent time in the am/pm format.

      -- Data: DAY_1 ... DAY_7

          Get the name of the n-th day of the week.

               Note: This follows the US convention of ‘DAY_1’ being
               Sunday, not the international convention (ISO 8601) that
               Monday is the first day of the week.

      -- Data: ABDAY_1 ... ABDAY_7

          Get the abbreviated name of the n-th day of the week.

      -- Data: MON_1 ... MON_12

          Get the name of the n-th month.

      -- Data: ABMON_1 ... ABMON_12

          Get the abbreviated name of the n-th month.

      -- Data: locale.RADIXCHAR

          Get the radix character (decimal dot, decimal comma, etc.).

      -- Data: locale.THOUSEP

          Get the separator character for thousands (groups of three
          digits).

      -- Data: locale.YESEXPR

          Get a regular expression that can be used with the regex
          function to recognize a positive response to a yes/no
          question.

               Note: The expression is in the syntax suitable for the
               ‘regex()’ function from the C library, which might differ
               from the syntax used in *note re: dd.

      -- Data: locale.NOEXPR

          Get a regular expression that can be used with the regex(3)
          function to recognize a negative response to a yes/no
          question.

      -- Data: locale.CRNCYSTR

          Get the currency symbol, preceded by “-” if the symbol should
          appear before the value, “+” if the symbol should appear after
          the value, or “.” if the symbol should replace the radix
          character.

      -- Data: locale.ERA

          Get a string that represents the era used in the current
          locale.

          Most locales do not define this value.  An example of a locale
          which does define this value is the Japanese one.  In Japan,
          the traditional representation of dates includes the name of
          the era corresponding to the then-emperor’s reign.

          Normally it should not be necessary to use this value
          directly.  Specifying the ‘E’ modifier in their format strings
          causes the *note time.strftime(): b58. function to use this
          information.  The format of the returned string is not
          specified, and therefore you should not assume knowledge of it
          on different systems.

      -- Data: locale.ERA_D_T_FMT

          Get a format string for *note time.strftime(): b58. to
          represent date and time in a locale-specific era-based way.

      -- Data: locale.ERA_D_FMT

          Get a format string for *note time.strftime(): b58. to
          represent a date in a locale-specific era-based way.

      -- Data: locale.ERA_T_FMT

          Get a format string for *note time.strftime(): b58. to
          represent a time in a locale-specific era-based way.

      -- Data: locale.ALT_DIGITS

          Get a representation of up to 100 values used to represent the
          values 0 to 99.

 -- Function: locale.getdefaultlocale ([envvars])

     Tries to determine the default locale settings and returns them as
     a tuple of the form ‘(language code, encoding)’.

     According to POSIX, a program which has not called
     ‘setlocale(LC_ALL, '')’ runs using the portable ‘'C'’ locale.
     Calling ‘setlocale(LC_ALL, '')’ lets it use the default locale as
     defined by the ‘LANG’ variable.  Since we do not want to interfere
     with the current locale setting we thus emulate the behavior in the
     way described above.

     To maintain compatibility with other platforms, not only the ‘LANG’
     variable is tested, but a list of variables given as envvars
     parameter.  The first found to be defined will be used.  `envvars'
     defaults to the search path used in GNU gettext; it must always
     contain the variable name ‘'LANG'’.  The GNU gettext search path
     contains ‘'LC_ALL'’, ‘'LC_CTYPE'’, ‘'LANG'’ and ‘'LANGUAGE'’, in
     that order.

     Except for the code ‘'C'’, the language code corresponds to RFC
     1766(2).  `language code' and `encoding' may be ‘None’ if their
     values cannot be determined.

 -- Function: locale.getlocale (category=LC_CTYPE)

     Returns the current setting for the given locale category as
     sequence containing `language code', `encoding'.  `category' may be
     one of the ‘LC_*’ values except *note LC_ALL: 2fb8.  It defaults to
     *note LC_CTYPE: 2fb9.

     Except for the code ‘'C'’, the language code corresponds to RFC
     1766(3).  `language code' and `encoding' may be ‘None’ if their
     values cannot be determined.

 -- Function: locale.getpreferredencoding (do_setlocale=True)

     Return the encoding used for text data, according to user
     preferences.  User preferences are expressed differently on
     different systems, and might not be available programmatically on
     some systems, so this function only returns a guess.

     On some systems, it is necessary to invoke *note setlocale(): 1f48.
     to obtain the user preferences, so this function is not
     thread-safe.  If invoking setlocale is not necessary or desired,
     `do_setlocale' should be set to ‘False’.

     On Android or in the UTF-8 mode (*note -X: 155. ‘utf8’ option),
     always return ‘'UTF-8'’, the locale and the `do_setlocale' argument
     are ignored.

     Changed in version 3.7: The function now always returns ‘UTF-8’ on
     Android or if the UTF-8 mode is enabled.

 -- Function: locale.normalize (localename)

     Returns a normalized locale code for the given locale name.  The
     returned locale code is formatted for use with *note setlocale():
     1f48.  If normalization fails, the original name is returned
     unchanged.

     If the given encoding is not known, the function defaults to the
     default encoding for the locale code just like *note setlocale():
     1f48.

 -- Function: locale.resetlocale (category=LC_ALL)

     Sets the locale for `category' to the default setting.

     The default setting is determined by calling *note
     getdefaultlocale(): 129b.  `category' defaults to *note LC_ALL:
     2fb8.

 -- Function: locale.strcoll (string1, string2)

     Compares two strings according to the current *note LC_COLLATE:
     2fbd. setting.  As any other compare function, returns a negative,
     or a positive value, or ‘0’, depending on whether `string1'
     collates before or after `string2' or is equal to it.

 -- Function: locale.strxfrm (string)

     Transforms a string to one that can be used in locale-aware
     comparisons.  For example, ‘strxfrm(s1) < strxfrm(s2)’ is
     equivalent to ‘strcoll(s1, s2) < 0’.  This function can be used
     when the same string is compared repeatedly, e.g.  when collating a
     sequence of strings.

 -- Function: locale.format_string (format, val, grouping=False,
          monetary=False)

     Formats a number `val' according to the current *note LC_NUMERIC:
     2fa5. setting.  The format follows the conventions of the ‘%’
     operator.  For floating point values, the decimal point is modified
     if appropriate.  If `grouping' is true, also takes the grouping
     into account.

     If `monetary' is true, the conversion uses monetary thousands
     separator and grouping strings.

     Processes formatting specifiers as in ‘format % val’, but takes the
     current locale settings into account.

     Changed in version 3.7: The `monetary' keyword parameter was added.

 -- Function: locale.format (format, val, grouping=False,
          monetary=False)

     Please note that this function works like *note format_string():
     399. but will only work for exactly one ‘%char’ specifier.  For
     example, ‘'%f'’ and ‘'%.0f'’ are both valid specifiers, but ‘'%f
     KiB'’ is not.

     For whole format strings, use *note format_string(): 399.

     Deprecated since version 3.7: Use *note format_string(): 399.
     instead.

 -- Function: locale.currency (val, symbol=True, grouping=False,
          international=False)

     Formats a number `val' according to the current *note LC_MONETARY:
     2fa7. settings.

     The returned string includes the currency symbol if `symbol' is
     true, which is the default.  If `grouping' is true (which is not
     the default), grouping is done with the value.  If `international'
     is true (which is not the default), the international currency
     symbol is used.

     Note that this function will not work with the ‘C’ locale, so you
     have to set a locale via *note setlocale(): 1f48. first.

 -- Function: locale.str (float)

     Formats a floating point number using the same format as the
     built-in function ‘str(float)’, but takes the decimal point into
     account.

 -- Function: locale.delocalize (string)

     Converts a string into a normalized number string, following the
     *note LC_NUMERIC: 2fa5. settings.

     New in version 3.5.

 -- Function: locale.atof (string)

     Converts a string to a floating point number, following the *note
     LC_NUMERIC: 2fa5. settings.

 -- Function: locale.atoi (string)

     Converts a string to an integer, following the *note LC_NUMERIC:
     2fa5. conventions.

 -- Data: locale.LC_CTYPE

     Locale category for the character type functions.  Depending on the
     settings of this category, the functions of module *note string:
     f6. dealing with case change their behaviour.

 -- Data: locale.LC_COLLATE

     Locale category for sorting strings.  The functions *note
     strcoll(): 2fbc. and *note strxfrm(): 2fbe. of the *note locale:
     a9. module are affected.

 -- Data: locale.LC_TIME

     Locale category for the formatting of time.  The function *note
     time.strftime(): b58. follows these conventions.

 -- Data: locale.LC_MONETARY

     Locale category for formatting of monetary values.  The available
     options are available from the *note localeconv(): 47f. function.

 -- Data: locale.LC_MESSAGES

     Locale category for message display.  Python currently does not
     support application specific locale-aware messages.  Messages
     displayed by the operating system, like those returned by *note
     os.strerror(): 1e3f. might be affected by this category.

 -- Data: locale.LC_NUMERIC

     Locale category for formatting numbers.  The functions *note
     format(): 45d, *note atoi(): 2fc2, *note atof(): 2fc1. and *note
     str(): 2fc0. of the *note locale: a9. module are affected by that
     category.  All other numeric formatting operations are not
     affected.

 -- Data: locale.LC_ALL

     Combination of all locale settings.  If this flag is used when the
     locale is changed, setting the locale for all categories is
     attempted.  If that fails for any category, no category is changed
     at all.  When the locale is retrieved using this flag, a string
     indicating the setting for all categories is returned.  This string
     can be later used to restore the settings.

 -- Data: locale.CHAR_MAX

     This is a symbolic constant used for different values returned by
     *note localeconv(): 47f.

Example:

     >>> import locale >>> loc = locale.getlocale()  # get current locale # use German locale; name might vary with platform >>> locale.setlocale(locale.LC_ALL, 'de_DE') >>> locale.strcoll('f\xe4n', 'foo')  # compare a string containing an umlaut >>> locale.setlocale(locale.LC_ALL, '')   # use user's preferred locale >>> locale.setlocale(locale.LC_ALL, 'C')  # use default (C) locale >>> locale.setlocale(locale.LC_ALL, loc)  # restore saved locale

* Menu:

* Background, details, hints, tips and caveats: Background details hints tips and caveats.
* For extension writers and programs that embed Python::
* Access to message catalogs::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/locale.py

   (2) https://tools.ietf.org/html/rfc1766.html

   (3) https://tools.ietf.org/html/rfc1766.html


File: python.info,  Node: Background details hints tips and caveats,  Next: For extension writers and programs that embed Python,  Up: locale — Internationalization services

5.24.2.1 Background, details, hints, tips and caveats
.....................................................

The C standard defines the locale as a program-wide property that may be
relatively expensive to change.  On top of that, some implementation are
broken in such a way that frequent locale changes may cause core dumps.
This makes the locale somewhat painful to use correctly.

Initially, when a program is started, the locale is the ‘C’ locale, no
matter what the user’s preferred locale is.  There is one exception: the
*note LC_CTYPE: 2fb9. category is changed at startup to set the current
locale encoding to the user’s preferred locale encoding.  The program
must explicitly say that it wants the user’s preferred locale settings
for other categories by calling ‘setlocale(LC_ALL, '')’.

It is generally a bad idea to call *note setlocale(): 1f48. in some
library routine, since as a side effect it affects the entire program.
Saving and restoring it is almost as bad: it is expensive and affects
other threads that happen to run before the settings have been restored.

If, when coding a module for general use, you need a locale independent
version of an operation that is affected by the locale (such as certain
formats used with *note time.strftime(): b58.), you will have to find a
way to do it without using the standard library routine.  Even better is
convincing yourself that using locale settings is okay.  Only as a last
resort should you document that your module is not compatible with
non-‘C’ locale settings.

The only way to perform numeric operations according to the locale is to
use the special functions defined by this module: *note atof(): 2fc1,
*note atoi(): 2fc2, *note format(): 45d, *note str(): 2fc0.

There is no way to perform case conversions and character
classifications according to the locale.  For (Unicode) text strings
these are done according to the character value only, while for byte
strings, the conversions and classifications are done according to the
ASCII value of the byte, and bytes whose high bit is set (i.e.,
non-ASCII bytes) are never converted or considered part of a character
class such as letter or whitespace.


File: python.info,  Node: For extension writers and programs that embed Python,  Next: Access to message catalogs,  Prev: Background details hints tips and caveats,  Up: locale — Internationalization services

5.24.2.2 For extension writers and programs that embed Python
.............................................................

Extension modules should never call *note setlocale(): 1f48, except to
find out what the current locale is.  But since the return value can
only be used portably to restore it, that is not very useful (except
perhaps to find out whether or not the locale is ‘C’).

When Python code uses the *note locale: a9. module to change the locale,
this also affects the embedding application.  If the embedding
application doesn’t want this to happen, it should remove the ‘_locale’
extension module (which does all the work) from the table of built-in
modules in the ‘config.c’ file, and make sure that the ‘_locale’ module
is not accessible as a shared library.


File: python.info,  Node: Access to message catalogs,  Prev: For extension writers and programs that embed Python,  Up: locale — Internationalization services

5.24.2.3 Access to message catalogs
...................................

 -- Function: locale.gettext (msg)

 -- Function: locale.dgettext (domain, msg)

 -- Function: locale.dcgettext (domain, msg, category)

 -- Function: locale.textdomain (domain)

 -- Function: locale.bindtextdomain (domain, dir)

The locale module exposes the C library’s gettext interface on systems
that provide this interface.  It consists of the functions ‘gettext()’,
‘dgettext()’, ‘dcgettext()’, ‘textdomain()’, ‘bindtextdomain()’, and
‘bind_textdomain_codeset()’.  These are similar to the same functions in
the *note gettext: 89. module, but use the C library’s binary format for
message catalogs, and the C library’s search algorithms for locating
message catalogs.

Python applications should normally find no need to invoke these
functions, and should use *note gettext: 89. instead.  A known exception
to this rule are applications that link with additional C libraries
which internally invoke ‘gettext()’ or ‘dcgettext()’.  For these
applications, it may be necessary to bind the text domain, so that the
libraries can properly locate their message catalogs.


File: python.info,  Node: Program Frameworks,  Next: Graphical User Interfaces with Tk,  Prev: Internationalization,  Up: The Python Standard Library

5.25 Program Frameworks
=======================

The modules described in this chapter are frameworks that will largely
dictate the structure of your program.  Currently the modules described
here are all oriented toward writing command-line interfaces.

The full list of modules described in this chapter is:

* Menu:

* turtle — Turtle graphics::
* cmd — Support for line-oriented command interpreters::
* shlex — Simple lexical analysis::


File: python.info,  Node: turtle — Turtle graphics,  Next: cmd — Support for line-oriented command interpreters,  Up: Program Frameworks

5.25.1 ‘turtle’ — Turtle graphics
---------------------------------

`Source code:' Lib/turtle.py(1)

__________________________________________________________________

* Menu:

* Introduction: Introduction<11>.
* Overview of available Turtle and Screen methods::
* Methods of RawTurtle/Turtle and corresponding functions::
* Methods of TurtleScreen/Screen and corresponding functions::
* Public classes::
* Help and configuration::
* turtledemo — Demo scripts::
* Changes since Python 2.6: Changes since Python 2 6.
* Changes since Python 3.0: Changes since Python 3 0.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/turtle.py


File: python.info,  Node: Introduction<11>,  Next: Overview of available Turtle and Screen methods,  Up: turtle — Turtle graphics

5.25.1.1 Introduction
.....................

Turtle graphics is a popular way for introducing programming to kids.
It was part of the original Logo programming language developed by Wally
Feurzeig, Seymour Papert and Cynthia Solomon in 1967.

Imagine a robotic turtle starting at (0, 0) in the x-y plane.  After an
‘import turtle’, give it the command ‘turtle.forward(15)’, and it moves
(on-screen!)  15 pixels in the direction it is facing, drawing a line as
it moves.  Give it the command ‘turtle.right(25)’, and it rotates
in-place 25 degrees clockwise.

Turtle star
...........

Turtle can draw intricate shapes using programs that repeat simple
moves.

[python-figures/turtle-star]
     from turtle import * color('red', 'yellow') begin_fill() while True:     forward(200)     left(170)     if abs(pos()) < 1:         break end_fill() done()

By combining together these and similar commands, intricate shapes and
pictures can easily be drawn.

The *note turtle: 116. module is an extended reimplementation of the
same-named module from the Python standard distribution up to version
Python 2.5.

It tries to keep the merits of the old turtle module and to be (nearly)
100% compatible with it.  This means in the first place to enable the
learning programmer to use all the commands, classes and methods
interactively when using the module from within IDLE run with the ‘-n’
switch.

The turtle module provides turtle graphics primitives, in both
object-oriented and procedure-oriented ways.  Because it uses *note
tkinter: 10c. for the underlying graphics, it needs a version of Python
installed with Tk support.

The object-oriented interface uses essentially two+two classes:

  1. The *note TurtleScreen: 2fd5. class defines graphics windows as a
     playground for the drawing turtles.  Its constructor needs a
     ‘tkinter.Canvas’ or a *note ScrolledCanvas: 2fd6. as argument.  It
     should be used when *note turtle: 116. is used as part of some
     application.

     The function *note Screen(): 2fd7. returns a singleton object of a
     *note TurtleScreen: 2fd5. subclass.  This function should be used
     when *note turtle: 116. is used as a standalone tool for doing
     graphics.  As a singleton object, inheriting from its class is not
     possible.

     All methods of TurtleScreen/Screen also exist as functions, i.e.
     as part of the procedure-oriented interface.

  2. *note RawTurtle: 2fd8. (alias: *note RawPen: 2fd9.) defines Turtle
     objects which draw on a *note TurtleScreen: 2fd5.  Its constructor
     needs a Canvas, ScrolledCanvas or TurtleScreen as argument, so the
     RawTurtle objects know where to draw.

     Derived from RawTurtle is the subclass *note Turtle: 2fda. (alias:
     ‘Pen’), which draws on “the” *note Screen: 2fd7. instance which is
     automatically created, if not already present.

     All methods of RawTurtle/Turtle also exist as functions, i.e.  part
     of the procedure-oriented interface.

The procedural interface provides functions which are derived from the
methods of the classes *note Screen: 2fd7. and *note Turtle: 2fda.  They
have the same names as the corresponding methods.  A screen object is
automatically created whenever a function derived from a Screen method
is called.  An (unnamed) turtle object is automatically created whenever
any of the functions derived from a Turtle method is called.

To use multiple turtles on a screen one has to use the object-oriented
interface.

     Note: In the following documentation the argument list for
     functions is given.  Methods, of course, have the additional first
     argument `self' which is omitted here.


File: python.info,  Node: Overview of available Turtle and Screen methods,  Next: Methods of RawTurtle/Turtle and corresponding functions,  Prev: Introduction<11>,  Up: turtle — Turtle graphics

5.25.1.2 Overview of available Turtle and Screen methods
........................................................

* Menu:

* Turtle methods::
* Methods of TurtleScreen/Screen::


File: python.info,  Node: Turtle methods,  Next: Methods of TurtleScreen/Screen,  Up: Overview of available Turtle and Screen methods

5.25.1.3 Turtle methods
.......................

Turtle motion

     Move and draw

               *note forward(): 2fdd. | *note fd(): 2fde. 
               *note backward(): 2fdf. | *note bk(): 2fe0. | *note back(): 2fe1. 
               *note right(): 2fe2. | *note rt(): 2fe3. 
               *note left(): 2fe4. | *note lt(): 2fe5. 
               *note goto(): 2fe6. | *note setpos(): 2fe7. | *note setposition(): 2fe8. 
               *note setx(): 2fe9. 
               *note sety(): 2fea. 
               *note setheading(): 2feb. | *note seth(): 2fec. 
               *note home(): 2fed. 
               *note circle(): 2fee. 
               *note dot(): 2fef. 
               *note stamp(): 2ff0. 
               *note clearstamp(): 2ff1. 
               *note clearstamps(): 2ff2. 
               *note undo(): 2ff3. 
               *note speed(): 2ff4. 

     Tell Turtle’s state

               *note position(): 2ff5. | *note pos(): 2ff6. 
               *note towards(): 2ff7. 
               *note xcor(): 2ff8. 
               *note ycor(): 2ff9. 
               *note heading(): 2ffa. 
               *note distance(): 2ffb. 

     Setting and measurement

               *note degrees(): 2ffc. 
               *note radians(): 2ffd. 

Pen control

     Drawing state

               *note pendown(): 2ffe. | *note pd(): 2fff. | *note down(): 3000. 
               *note penup(): 3001. | *note pu(): 3002. | *note up(): 3003. 
               *note pensize(): 3004. | *note width(): 3005. 
               *note pen(): 3006. 
               *note isdown(): 3007. 

     Color control

               *note color(): 3008. 
               *note pencolor(): 3009. 
               *note fillcolor(): 300a. 

     Filling

               *note filling(): 300b. 
               *note begin_fill(): 300c. 
               *note end_fill(): 300d. 

     More drawing control

               *note reset(): 300e. 
               *note clear(): 300f. 
               *note write(): 3010. 

Turtle state

     Visibility

               *note showturtle(): 3011. | *note st(): 3012. 
               *note hideturtle(): 3013. | *note ht(): 3014. 
               *note isvisible(): 3015. 

     Appearance

               *note shape(): 3016. 
               *note resizemode(): 3017. 
               *note shapesize(): 3018. | *note turtlesize(): 3019. 
               *note shearfactor(): 301a. 
               *note settiltangle(): 301b. 
               *note tiltangle(): 301c. 
               *note tilt(): 301d. 
               *note shapetransform(): 301e. 
               *note get_shapepoly(): 301f. 

Using events

          *note onclick(): 3020. 
          *note onrelease(): 3021. 
          *note ondrag(): 3022. 

Special Turtle methods

          *note begin_poly(): 3023. 
          *note end_poly(): 3024. 
          *note get_poly(): 3025. 
          *note clone(): 3026. 
          *note getturtle(): 3027. | *note getpen(): 3028. 
          *note getscreen(): 3029. 
          *note setundobuffer(): 302a. 
          *note undobufferentries(): 302b. 


File: python.info,  Node: Methods of TurtleScreen/Screen,  Prev: Turtle methods,  Up: Overview of available Turtle and Screen methods

5.25.1.4 Methods of TurtleScreen/Screen
.......................................

Window control

          *note bgcolor(): 302d. 
          *note bgpic(): 302e. 
          *note clear(): 300f. | *note clearscreen(): 302f. 
          *note reset(): 300e. | *note resetscreen(): 3030. 
          *note screensize(): 3031. 
          *note setworldcoordinates(): 3032. 

Animation control

          *note delay(): 3033. 
          *note tracer(): 3034. 
          *note update(): 3035. 

Using screen events

          *note listen(): 3036. 
          *note onkey(): 3037. | *note onkeyrelease(): 3038. 
          *note onkeypress(): 3039. 
          *note onclick(): 3020. | *note onscreenclick(): 303a. 
          *note ontimer(): 303b. 
          *note mainloop(): 303c. | *note done(): 303d. 

Settings and special methods

          *note mode(): 303e. 
          *note colormode(): 303f. 
          *note getcanvas(): 3040. 
          *note getshapes(): 3041. 
          *note register_shape(): 3042. | *note addshape(): 3043. 
          *note turtles(): 3044. 
          *note window_height(): 3045. 
          *note window_width(): 3046. 

Input methods

          *note textinput(): 3047. 
          *note numinput(): 3048. 

Methods specific to Screen

          *note bye(): 3049. 
          *note exitonclick(): 304a. 
          *note setup(): 304b. 
          *note title(): 304c. 


File: python.info,  Node: Methods of RawTurtle/Turtle and corresponding functions,  Next: Methods of TurtleScreen/Screen and corresponding functions,  Prev: Overview of available Turtle and Screen methods,  Up: turtle — Turtle graphics

5.25.1.5 Methods of RawTurtle/Turtle and corresponding functions
................................................................

Most of the examples in this section refer to a Turtle instance called
‘turtle’.

* Menu:

* Turtle motion::
* Tell Turtle’s state::
* Settings for measurement::
* Pen control::
* Turtle state::
* Using events::
* Special Turtle methods::
* Compound shapes::


File: python.info,  Node: Turtle motion,  Next: Tell Turtle’s state,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.6 Turtle motion
......................

 -- Function: turtle.forward (distance)
 -- Function: turtle.fd (distance)


     Parameters: ‘distance’ – a number (integer or float)

     Move the turtle forward by the specified `distance', in the
     direction the turtle is headed.

          >>> turtle.position() (0.00,0.00) >>> turtle.forward(25) >>> turtle.position() (25.00,0.00) >>> turtle.forward(-75) >>> turtle.position() (-50.00,0.00)

 -- Function: turtle.back (distance)
 -- Function: turtle.bk (distance)
 -- Function: turtle.backward (distance)


     Parameters: ‘distance’ – a number

     Move the turtle backward by `distance', opposite to the direction
     the turtle is headed.  Do not change the turtle’s heading.

          >>> turtle.position() (0.00,0.00) >>> turtle.backward(30) >>> turtle.position() (-30.00,0.00)

 -- Function: turtle.right (angle)
 -- Function: turtle.rt (angle)


     Parameters: ‘angle’ – a number (integer or float)

     Turn turtle right by `angle' units.  (Units are by default degrees,
     but can be set via the *note degrees(): 2ffc. and *note radians():
     2ffd. functions.)  Angle orientation depends on the turtle mode,
     see *note mode(): 303e.

          >>> turtle.heading() 22.0 >>> turtle.right(45) >>> turtle.heading() 337.0

 -- Function: turtle.left (angle)
 -- Function: turtle.lt (angle)


     Parameters: ‘angle’ – a number (integer or float)

     Turn turtle left by `angle' units.  (Units are by default degrees,
     but can be set via the *note degrees(): 2ffc. and *note radians():
     2ffd. functions.)  Angle orientation depends on the turtle mode,
     see *note mode(): 303e.

          >>> turtle.heading() 22.0 >>> turtle.left(45) >>> turtle.heading() 67.0

 -- Function: turtle.goto (x, y=None)
 -- Function: turtle.setpos (x, y=None)
 -- Function: turtle.setposition (x, y=None)


     Parameters:

        * ‘x’ – a number or a pair/vector of numbers

        * ‘y’ – a number or ‘None’

     If `y' is ‘None’, `x' must be a pair of coordinates or a *note
     Vec2D: 304f. (e.g.  as returned by *note pos(): 2ff6.).

     Move turtle to an absolute position.  If the pen is down, draw
     line.  Do not change the turtle’s orientation.

           >>> tp = turtle.pos()  >>> tp  (0.00,0.00)  >>> turtle.setpos(60,30)  >>> turtle.pos()  (60.00,30.00)  >>> turtle.setpos((20,80))  >>> turtle.pos()  (20.00,80.00)  >>> turtle.setpos(tp)  >>> turtle.pos()  (0.00,0.00)

 -- Function: turtle.setx (x)


     Parameters: ‘x’ – a number (integer or float)

     Set the turtle’s first coordinate to `x', leave second coordinate
     unchanged.

          >>> turtle.position() (0.00,240.00) >>> turtle.setx(10) >>> turtle.position() (10.00,240.00)

 -- Function: turtle.sety (y)


     Parameters: ‘y’ – a number (integer or float)

     Set the turtle’s second coordinate to `y', leave first coordinate
     unchanged.

          >>> turtle.position() (0.00,40.00) >>> turtle.sety(-10) >>> turtle.position() (0.00,-10.00)

 -- Function: turtle.setheading (to_angle)
 -- Function: turtle.seth (to_angle)


     Parameters: ‘to_angle’ – a number (integer or float)

     Set the orientation of the turtle to `to_angle'.  Here are some
     common directions in degrees:

     standard mode           logo mode
                             
     -------------------------------------------------
                             
     0 - east                0 - north
                             
                             
     90 - north              90 - east
                             
                             
     180 - west              180 - south
                             
                             
     270 - south             270 - west
                             

          >>> turtle.setheading(90) >>> turtle.heading() 90.0

 -- Function: turtle.home ()

     Move turtle to the origin – coordinates (0,0) – and set its heading
     to its start-orientation (which depends on the mode, see *note
     mode(): 303e.).

          >>> turtle.heading() 90.0 >>> turtle.position() (0.00,-10.00) >>> turtle.home() >>> turtle.position() (0.00,0.00) >>> turtle.heading() 0.0

 -- Function: turtle.circle (radius, extent=None, steps=None)


     Parameters:

        * ‘radius’ – a number

        * ‘extent’ – a number (or ‘None’)

        * ‘steps’ – an integer (or ‘None’)

     Draw a circle with given `radius'.  The center is `radius' units
     left of the turtle; `extent' – an angle – determines which part of
     the circle is drawn.  If `extent' is not given, draw the entire
     circle.  If `extent' is not a full circle, one endpoint of the arc
     is the current pen position.  Draw the arc in counterclockwise
     direction if `radius' is positive, otherwise in clockwise
     direction.  Finally the direction of the turtle is changed by the
     amount of `extent'.

     As the circle is approximated by an inscribed regular polygon,
     `steps' determines the number of steps to use.  If not given, it
     will be calculated automatically.  May be used to draw regular
     polygons.

          >>> turtle.home() >>> turtle.position() (0.00,0.00) >>> turtle.heading() 0.0 >>> turtle.circle(50) >>> turtle.position() (-0.00,0.00) >>> turtle.heading() 0.0 >>> turtle.circle(120, 180)  # draw a semicircle >>> turtle.position() (0.00,240.00) >>> turtle.heading() 180.0

 -- Function: turtle.dot (size=None, *color)


     Parameters:

        * ‘size’ – an integer >= 1 (if given)

        * ‘color’ – a colorstring or a numeric color tuple

     Draw a circular dot with diameter `size', using `color'.  If `size'
     is not given, the maximum of pensize+4 and 2*pensize is used.

          >>> turtle.home() >>> turtle.dot() >>> turtle.fd(50); turtle.dot(20, "blue"); turtle.fd(50) >>> turtle.position() (100.00,-0.00) >>> turtle.heading() 0.0

 -- Function: turtle.stamp ()

     Stamp a copy of the turtle shape onto the canvas at the current
     turtle position.  Return a stamp_id for that stamp, which can be
     used to delete it by calling ‘clearstamp(stamp_id)’.

          >>> turtle.color("blue") >>> turtle.stamp() 11 >>> turtle.fd(50)

 -- Function: turtle.clearstamp (stampid)


     Parameters: ‘stampid’ – an integer, must be return value of
     previous *note stamp(): 2ff0. call

     Delete stamp with given `stampid'.

          >>> turtle.position() (150.00,-0.00) >>> turtle.color("blue") >>> astamp = turtle.stamp() >>> turtle.fd(50) >>> turtle.position() (200.00,-0.00) >>> turtle.clearstamp(astamp) >>> turtle.position() (200.00,-0.00)

 -- Function: turtle.clearstamps (n=None)


     Parameters: ‘n’ – an integer (or ‘None’)

     Delete all or first/last `n' of turtle’s stamps.  If `n' is ‘None’,
     delete all stamps, if `n' > 0 delete first `n' stamps, else if `n'
     < 0 delete last `n' stamps.

          >>> for i in range(8): ...     turtle.stamp(); turtle.fd(30) 13 14 15 16 17 18 19 20 >>> turtle.clearstamps(2) >>> turtle.clearstamps(-2) >>> turtle.clearstamps()

 -- Function: turtle.undo ()

     Undo (repeatedly) the last turtle action(s).  Number of available
     undo actions is determined by the size of the undobuffer.

          >>> for i in range(4): ...     turtle.fd(50); turtle.lt(80) ... >>> for i in range(8): ...     turtle.undo()

 -- Function: turtle.speed (speed=None)


     Parameters: ‘speed’ – an integer in the range 0..10 or a
     speedstring (see below)

     Set the turtle’s speed to an integer value in the range 0..10.  If
     no argument is given, return current speed.

     If input is a number greater than 10 or smaller than 0.5, speed is
     set to 0.  Speedstrings are mapped to speedvalues as follows:

        * “fastest”: 0

        * “fast”: 10

        * “normal”: 6

        * “slow”: 3

        * “slowest”: 1

     Speeds from 1 to 10 enforce increasingly faster animation of line
     drawing and turtle turning.

     Attention: `speed' = 0 means that `no' animation takes place.
     forward/back makes turtle jump and likewise left/right make the
     turtle turn instantly.

          >>> turtle.speed() 3 >>> turtle.speed('normal') >>> turtle.speed() 6 >>> turtle.speed(9) >>> turtle.speed() 9


File: python.info,  Node: Tell Turtle’s state,  Next: Settings for measurement,  Prev: Turtle motion,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.7 Tell Turtle’s state
............................

 -- Function: turtle.position ()
 -- Function: turtle.pos ()

     Return the turtle’s current location (x,y) (as a *note Vec2D: 304f.
     vector).

          >>> turtle.pos() (440.00,-0.00)

 -- Function: turtle.towards (x, y=None)


     Parameters:

        * ‘x’ – a number or a pair/vector of numbers or a turtle
          instance

        * ‘y’ – a number if `x' is a number, else ‘None’

     Return the angle between the line from turtle position to position
     specified by (x,y), the vector or the other turtle.  This depends
     on the turtle’s start orientation which depends on the mode -
     “standard”/”world” or “logo”).

          >>> turtle.goto(10, 10) >>> turtle.towards(0,0) 225.0

 -- Function: turtle.xcor ()

     Return the turtle’s x coordinate.

          >>> turtle.home() >>> turtle.left(50) >>> turtle.forward(100) >>> turtle.pos() (64.28,76.60) >>> print(round(turtle.xcor(), 5)) 64.27876

 -- Function: turtle.ycor ()

     Return the turtle’s y coordinate.

          >>> turtle.home() >>> turtle.left(60) >>> turtle.forward(100) >>> print(turtle.pos()) (50.00,86.60) >>> print(round(turtle.ycor(), 5)) 86.60254

 -- Function: turtle.heading ()

     Return the turtle’s current heading (value depends on the turtle
     mode, see *note mode(): 303e.).

          >>> turtle.home() >>> turtle.left(67) >>> turtle.heading() 67.0

 -- Function: turtle.distance (x, y=None)


     Parameters:

        * ‘x’ – a number or a pair/vector of numbers or a turtle
          instance

        * ‘y’ – a number if `x' is a number, else ‘None’

     Return the distance from the turtle to (x,y), the given vector, or
     the given other turtle, in turtle step units.

          >>> turtle.home() >>> turtle.distance(30,40) 50.0 >>> turtle.distance((30,40)) 50.0 >>> joe = Turtle() >>> joe.forward(77) >>> turtle.distance(joe) 77.0


File: python.info,  Node: Settings for measurement,  Next: Pen control,  Prev: Tell Turtle’s state,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.8 Settings for measurement
.................................

 -- Function: turtle.degrees (fullcircle=360.0)


     Parameters: ‘fullcircle’ – a number

     Set angle measurement units, i.e.  set number of “degrees” for a
     full circle.  Default value is 360 degrees.

          >>> turtle.home() >>> turtle.left(90) >>> turtle.heading() 90.0  Change angle measurement unit to grad (also known as gon, grade, or gradian and equals 1/100-th of the right angle.) >>> turtle.degrees(400.0) >>> turtle.heading() 100.0 >>> turtle.degrees(360) >>> turtle.heading() 90.0

 -- Function: turtle.radians ()

     Set the angle measurement units to radians.  Equivalent to
     ‘degrees(2*math.pi)’.

          >>> turtle.home() >>> turtle.left(90) >>> turtle.heading() 90.0 >>> turtle.radians() >>> turtle.heading() 1.5707963267948966


File: python.info,  Node: Pen control,  Next: Turtle state,  Prev: Settings for measurement,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.9 Pen control
....................

* Menu:

* Drawing state::
* Color control::
* Filling::
* More drawing control::


File: python.info,  Node: Drawing state,  Next: Color control,  Up: Pen control

5.25.1.10 Drawing state
.......................

 -- Function: turtle.pendown ()
 -- Function: turtle.pd ()
 -- Function: turtle.down ()

     Pull the pen down – drawing when moving.

 -- Function: turtle.penup ()
 -- Function: turtle.pu ()
 -- Function: turtle.up ()

     Pull the pen up – no drawing when moving.

 -- Function: turtle.pensize (width=None)
 -- Function: turtle.width (width=None)


     Parameters: ‘width’ – a positive number

     Set the line thickness to `width' or return it.  If resizemode is
     set to “auto” and turtleshape is a polygon, that polygon is drawn
     with the same line thickness.  If no argument is given, the current
     pensize is returned.

          >>> turtle.pensize() 1 >>> turtle.pensize(10)   # from here on lines of width 10 are drawn

 -- Function: turtle.pen (pen=None, **pendict)


     Parameters:

        * ‘pen’ – a dictionary with some or all of the below listed keys

        * ‘pendict’ – one or more keyword-arguments with the below
          listed keys as keywords

     Return or set the pen’s attributes in a “pen-dictionary” with the
     following key/value pairs:

        * “shown”: True/False

        * “pendown”: True/False

        * “pencolor”: color-string or color-tuple

        * “fillcolor”: color-string or color-tuple

        * “pensize”: positive number

        * “speed”: number in range 0..10

        * “resizemode”: “auto” or “user” or “noresize”

        * “stretchfactor”: (positive number, positive number)

        * “outline”: positive number

        * “tilt”: number

     This dictionary can be used as argument for a subsequent call to
     *note pen(): 3006. to restore the former pen-state.  Moreover one
     or more of these attributes can be provided as keyword-arguments.
     This can be used to set several pen attributes in one statement.

          >>> turtle.pen(fillcolor="black", pencolor="red", pensize=10) >>> sorted(turtle.pen().items()) [('fillcolor', 'black'), ('outline', 1), ('pencolor', 'red'),  ('pendown', True), ('pensize', 10), ('resizemode', 'noresize'),  ('shearfactor', 0.0), ('shown', True), ('speed', 9),  ('stretchfactor', (1.0, 1.0)), ('tilt', 0.0)] >>> penstate=turtle.pen() >>> turtle.color("yellow", "") >>> turtle.penup() >>> sorted(turtle.pen().items())[:3] [('fillcolor', ''), ('outline', 1), ('pencolor', 'yellow')] >>> turtle.pen(penstate, fillcolor="green") >>> sorted(turtle.pen().items())[:3] [('fillcolor', 'green'), ('outline', 1), ('pencolor', 'red')]

 -- Function: turtle.isdown ()

     Return ‘True’ if pen is down, ‘False’ if it’s up.

          >>> turtle.penup() >>> turtle.isdown() False >>> turtle.pendown() >>> turtle.isdown() True


File: python.info,  Node: Color control,  Next: Filling,  Prev: Drawing state,  Up: Pen control

5.25.1.11 Color control
.......................

 -- Function: turtle.pencolor (*args)

     Return or set the pencolor.

     Four input formats are allowed:

     ‘pencolor()’

          Return the current pencolor as color specification string or
          as a tuple (see example).  May be used as input to another
          color/pencolor/fillcolor call.

     ‘pencolor(colorstring)’

          Set pencolor to `colorstring', which is a Tk color
          specification string, such as ‘"red"’, ‘"yellow"’, or
          ‘"#33cc8c"’.

     ‘pencolor((r, g, b))’

          Set pencolor to the RGB color represented by the tuple of `r',
          `g', and `b'.  Each of `r', `g', and `b' must be in the range
          0..colormode, where colormode is either 1.0 or 255 (see *note
          colormode(): 303f.).

     ‘pencolor(r, g, b)’

               Set pencolor to the RGB color represented by `r', `g',
               and `b'.  Each of `r', `g', and `b' must be in the range
               0..colormode.

          If turtleshape is a polygon, the outline of that polygon is
          drawn with the newly set pencolor.

           >>> colormode()  1.0  >>> turtle.pencolor()  'red'  >>> turtle.pencolor("brown")  >>> turtle.pencolor()  'brown'  >>> tup = (0.2, 0.8, 0.55)  >>> turtle.pencolor(tup)  >>> turtle.pencolor()  (0.2, 0.8, 0.5490196078431373)  >>> colormode(255)  >>> turtle.pencolor()  (51.0, 204.0, 140.0)  >>> turtle.pencolor('#32c18f')  >>> turtle.pencolor()  (50.0, 193.0, 143.0)

 -- Function: turtle.fillcolor (*args)

     Return or set the fillcolor.

     Four input formats are allowed:

     ‘fillcolor()’

          Return the current fillcolor as color specification string,
          possibly in tuple format (see example).  May be used as input
          to another color/pencolor/fillcolor call.

     ‘fillcolor(colorstring)’

          Set fillcolor to `colorstring', which is a Tk color
          specification string, such as ‘"red"’, ‘"yellow"’, or
          ‘"#33cc8c"’.

     ‘fillcolor((r, g, b))’

          Set fillcolor to the RGB color represented by the tuple of
          `r', `g', and `b'.  Each of `r', `g', and `b' must be in the
          range 0..colormode, where colormode is either 1.0 or 255 (see
          *note colormode(): 303f.).

     ‘fillcolor(r, g, b)’

               Set fillcolor to the RGB color represented by `r', `g',
               and `b'.  Each of `r', `g', and `b' must be in the range
               0..colormode.

          If turtleshape is a polygon, the interior of that polygon is
          drawn with the newly set fillcolor.

           >>> turtle.fillcolor("violet")  >>> turtle.fillcolor()  'violet'  >>> turtle.pencolor()  (50.0, 193.0, 143.0)  >>> turtle.fillcolor((50, 193, 143))  # Integers, not floats  >>> turtle.fillcolor()  (50.0, 193.0, 143.0)  >>> turtle.fillcolor('#ffffff')  >>> turtle.fillcolor()  (255.0, 255.0, 255.0)

 -- Function: turtle.color (*args)

     Return or set pencolor and fillcolor.

     Several input formats are allowed.  They use 0 to 3 arguments as
     follows:

     ‘color()’

          Return the current pencolor and the current fillcolor as a
          pair of color specification strings or tuples as returned by
          *note pencolor(): 3009. and *note fillcolor(): 300a.

     ‘color(colorstring)’, ‘color((r,g,b))’, ‘color(r,g,b)’

          Inputs as in *note pencolor(): 3009, set both, fillcolor and
          pencolor, to the given value.

     ‘color(colorstring1, colorstring2)’, ‘color((r1,g1,b1), (r2,g2,b2))’

               Equivalent to ‘pencolor(colorstring1)’ and
               ‘fillcolor(colorstring2)’ and analogously if the other
               input format is used.

          If turtleshape is a polygon, outline and interior of that
          polygon is drawn with the newly set colors.

           >>> turtle.color("red", "green")  >>> turtle.color()  ('red', 'green')  >>> color("#285078", "#a0c8f0")  >>> color()  ((40.0, 80.0, 120.0), (160.0, 200.0, 240.0))

See also: Screen method *note colormode(): 303f.


File: python.info,  Node: Filling,  Next: More drawing control,  Prev: Color control,  Up: Pen control

5.25.1.12 Filling
.................

 -- Function: turtle.filling ()

     Return fillstate (‘True’ if filling, ‘False’ else).

           >>> turtle.begin_fill()  >>> if turtle.filling():  ...    turtle.pensize(5)  ... else:  ...    turtle.pensize(3)

 -- Function: turtle.begin_fill ()

     To be called just before drawing a shape to be filled.

 -- Function: turtle.end_fill ()

     Fill the shape drawn after the last call to *note begin_fill():
     300c.

          >>> turtle.color("black", "red") >>> turtle.begin_fill() >>> turtle.circle(80) >>> turtle.end_fill()


File: python.info,  Node: More drawing control,  Prev: Filling,  Up: Pen control

5.25.1.13 More drawing control
..............................

 -- Function: turtle.reset ()

     Delete the turtle’s drawings from the screen, re-center the turtle
     and set variables to the default values.

          >>> turtle.goto(0,-22) >>> turtle.left(100) >>> turtle.position() (0.00,-22.00) >>> turtle.heading() 100.0 >>> turtle.reset() >>> turtle.position() (0.00,0.00) >>> turtle.heading() 0.0

 -- Function: turtle.clear ()

     Delete the turtle’s drawings from the screen.  Do not move turtle.
     State and position of the turtle as well as drawings of other
     turtles are not affected.

 -- Function: turtle.write (arg, move=False, align="left",
          font=("Arial", 8, "normal"))


     Parameters:

        * ‘arg’ – object to be written to the TurtleScreen

        * ‘move’ – True/False

        * ‘align’ – one of the strings “left”, “center” or right”

        * ‘font’ – a triple (fontname, fontsize, fonttype)

     Write text - the string representation of `arg' - at the current
     turtle position according to `align' (“left”, “center” or right”)
     and with the given font.  If `move' is true, the pen is moved to
     the bottom-right corner of the text.  By default, `move' is
     ‘False’.

          >>> turtle.write("Home = ", True, align="center") >>> turtle.write((0,0), True)


File: python.info,  Node: Turtle state,  Next: Using events,  Prev: Pen control,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.14 Turtle state
......................

* Menu:

* Visibility::
* Appearance::


File: python.info,  Node: Visibility,  Next: Appearance,  Up: Turtle state

5.25.1.15 Visibility
....................

 -- Function: turtle.hideturtle ()
 -- Function: turtle.ht ()

     Make the turtle invisible.  It’s a good idea to do this while
     you’re in the middle of doing some complex drawing, because hiding
     the turtle speeds up the drawing observably.

          >>> turtle.hideturtle()

 -- Function: turtle.showturtle ()
 -- Function: turtle.st ()

     Make the turtle visible.

          >>> turtle.showturtle()

 -- Function: turtle.isvisible ()

     Return ‘True’ if the Turtle is shown, ‘False’ if it’s hidden.

          >>> turtle.hideturtle() >>> turtle.isvisible() False >>> turtle.showturtle() >>> turtle.isvisible() True


File: python.info,  Node: Appearance,  Prev: Visibility,  Up: Turtle state

5.25.1.16 Appearance
....................

 -- Function: turtle.shape (name=None)


     Parameters: ‘name’ – a string which is a valid shapename

     Set turtle shape to shape with given `name' or, if name is not
     given, return name of current shape.  Shape with `name' must exist
     in the TurtleScreen’s shape dictionary.  Initially there are the
     following polygon shapes: “arrow”, “turtle”, “circle”, “square”,
     “triangle”, “classic”.  To learn about how to deal with shapes see
     Screen method *note register_shape(): 3042.

          >>> turtle.shape() 'classic' >>> turtle.shape("turtle") >>> turtle.shape() 'turtle'

 -- Function: turtle.resizemode (rmode=None)


     Parameters: ‘rmode’ – one of the strings “auto”, “user”, “noresize”

     Set resizemode to one of the values: “auto”, “user”, “noresize”.
     If `rmode' is not given, return current resizemode.  Different
     resizemodes have the following effects:

        - “auto”: adapts the appearance of the turtle corresponding to
          the value of pensize.

        - “user”: adapts the appearance of the turtle according to the
          values of stretchfactor and outlinewidth (outline), which are
          set by *note shapesize(): 3018.

        - “noresize”: no adaption of the turtle’s appearance takes
          place.

     resizemode(“user”) is called by *note shapesize(): 3018. when used
     with arguments.

          >>> turtle.resizemode() 'noresize' >>> turtle.resizemode("auto") >>> turtle.resizemode() 'auto'

 -- Function: turtle.shapesize (stretch_wid=None, stretch_len=None,
          outline=None)
 -- Function: turtle.turtlesize (stretch_wid=None, stretch_len=None,
          outline=None)


     Parameters:

        * ‘stretch_wid’ – positive number

        * ‘stretch_len’ – positive number

        * ‘outline’ – positive number

     Return or set the pen’s attributes x/y-stretchfactors and/or
     outline.  Set resizemode to “user”.  If and only if resizemode is
     set to “user”, the turtle will be displayed stretched according to
     its stretchfactors: `stretch_wid' is stretchfactor perpendicular to
     its orientation, `stretch_len' is stretchfactor in direction of its
     orientation, `outline' determines the width of the shapes’s
     outline.

          >>> turtle.shapesize() (1.0, 1.0, 1) >>> turtle.resizemode("user") >>> turtle.shapesize(5, 5, 12) >>> turtle.shapesize() (5, 5, 12) >>> turtle.shapesize(outline=8) >>> turtle.shapesize() (5, 5, 8)

 -- Function: turtle.shearfactor (shear=None)


     Parameters: ‘shear’ – number (optional)

     Set or return the current shearfactor.  Shear the turtleshape
     according to the given shearfactor shear, which is the tangent of
     the shear angle.  Do `not' change the turtle’s heading (direction
     of movement).  If shear is not given: return the current
     shearfactor, i.  e.  the tangent of the shear angle, by which lines
     parallel to the heading of the turtle are sheared.

           >>> turtle.shape("circle")  >>> turtle.shapesize(5,2)  >>> turtle.shearfactor(0.5)  >>> turtle.shearfactor()  0.5

 -- Function: turtle.tilt (angle)


     Parameters: ‘angle’ – a number

     Rotate the turtleshape by `angle' from its current tilt-angle, but
     do `not' change the turtle’s heading (direction of movement).

          >>> turtle.reset() >>> turtle.shape("circle") >>> turtle.shapesize(5,2) >>> turtle.tilt(30) >>> turtle.fd(50) >>> turtle.tilt(30) >>> turtle.fd(50)

 -- Function: turtle.settiltangle (angle)


     Parameters: ‘angle’ – a number

     Rotate the turtleshape to point in the direction specified by
     `angle', regardless of its current tilt-angle.  `Do not' change the
     turtle’s heading (direction of movement).

          >>> turtle.reset() >>> turtle.shape("circle") >>> turtle.shapesize(5,2) >>> turtle.settiltangle(45) >>> turtle.fd(50) >>> turtle.settiltangle(-45) >>> turtle.fd(50)

     Deprecated since version 3.1.

 -- Function: turtle.tiltangle (angle=None)


     Parameters: ‘angle’ – a number (optional)

     Set or return the current tilt-angle.  If angle is given, rotate
     the turtleshape to point in the direction specified by angle,
     regardless of its current tilt-angle.  Do `not' change the turtle’s
     heading (direction of movement).  If angle is not given: return the
     current tilt-angle, i.  e.  the angle between the orientation of
     the turtleshape and the heading of the turtle (its direction of
     movement).

          >>> turtle.reset() >>> turtle.shape("circle") >>> turtle.shapesize(5,2) >>> turtle.tilt(45) >>> turtle.tiltangle() 45.0

 -- Function: turtle.shapetransform (t11=None, t12=None, t21=None,
          t22=None)


     Parameters:

        * ‘t11’ – a number (optional)

        * ‘t12’ – a number (optional)

        * ‘t21’ – a number (optional)

        * ‘t12’ – a number (optional)

     Set or return the current transformation matrix of the turtle
     shape.

     If none of the matrix elements are given, return the transformation
     matrix as a tuple of 4 elements.  Otherwise set the given elements
     and transform the turtleshape according to the matrix consisting of
     first row t11, t12 and second row t21, 22.  The determinant t11 *
     t22 - t12 * t21 must not be zero, otherwise an error is raised.
     Modify stretchfactor, shearfactor and tiltangle according to the
     given matrix.

          >>> turtle = Turtle() >>> turtle.shape("square") >>> turtle.shapesize(4,2) >>> turtle.shearfactor(-0.5) >>> turtle.shapetransform() (4.0, -1.0, -0.0, 2.0)

 -- Function: turtle.get_shapepoly ()

     Return the current shape polygon as tuple of coordinate pairs.
     This can be used to define a new shape or components of a compound
     shape.

          >>> turtle.shape("square") >>> turtle.shapetransform(4, -1, 0, 2) >>> turtle.get_shapepoly() ((50, -20), (30, 20), (-50, 20), (-30, -20))


File: python.info,  Node: Using events,  Next: Special Turtle methods,  Prev: Turtle state,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.17 Using events
......................

 -- Function: turtle.onclick (fun, btn=1, add=None)


     Parameters:

        * ‘fun’ – a function with two arguments which will be called
          with the coordinates of the clicked point on the canvas

        * ‘btn’ – number of the mouse-button, defaults to 1 (left mouse
          button)

        * ‘add’ – ‘True’ or ‘False’ – if ‘True’, a new binding will be
          added, otherwise it will replace a former binding

     Bind `fun' to mouse-click events on this turtle.  If `fun' is
     ‘None’, existing bindings are removed.  Example for the anonymous
     turtle, i.e.  the procedural way:

          >>> def turn(x, y): ...     left(180) ... >>> onclick(turn)  # Now clicking into the turtle will turn it. >>> onclick(None)  # event-binding will be removed

 -- Function: turtle.onrelease (fun, btn=1, add=None)


     Parameters:

        * ‘fun’ – a function with two arguments which will be called
          with the coordinates of the clicked point on the canvas

        * ‘btn’ – number of the mouse-button, defaults to 1 (left mouse
          button)

        * ‘add’ – ‘True’ or ‘False’ – if ‘True’, a new binding will be
          added, otherwise it will replace a former binding

     Bind `fun' to mouse-button-release events on this turtle.  If `fun'
     is ‘None’, existing bindings are removed.

          >>> class MyTurtle(Turtle): ...     def glow(self,x,y): ...         self.fillcolor("red") ...     def unglow(self,x,y): ...         self.fillcolor("") ... >>> turtle = MyTurtle() >>> turtle.onclick(turtle.glow)     # clicking on turtle turns fillcolor red, >>> turtle.onrelease(turtle.unglow) # releasing turns it to transparent.

 -- Function: turtle.ondrag (fun, btn=1, add=None)


     Parameters:

        * ‘fun’ – a function with two arguments which will be called
          with the coordinates of the clicked point on the canvas

        * ‘btn’ – number of the mouse-button, defaults to 1 (left mouse
          button)

        * ‘add’ – ‘True’ or ‘False’ – if ‘True’, a new binding will be
          added, otherwise it will replace a former binding

     Bind `fun' to mouse-move events on this turtle.  If `fun' is
     ‘None’, existing bindings are removed.

     Remark: Every sequence of mouse-move-events on a turtle is preceded
     by a mouse-click event on that turtle.

          >>> turtle.ondrag(turtle.goto)

     Subsequently, clicking and dragging the Turtle will move it across
     the screen thereby producing handdrawings (if pen is down).


File: python.info,  Node: Special Turtle methods,  Next: Compound shapes,  Prev: Using events,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.18 Special Turtle methods
................................

 -- Function: turtle.begin_poly ()

     Start recording the vertices of a polygon.  Current turtle position
     is first vertex of polygon.

 -- Function: turtle.end_poly ()

     Stop recording the vertices of a polygon.  Current turtle position
     is last vertex of polygon.  This will be connected with the first
     vertex.

 -- Function: turtle.get_poly ()

     Return the last recorded polygon.

          >>> turtle.home() >>> turtle.begin_poly() >>> turtle.fd(100) >>> turtle.left(20) >>> turtle.fd(30) >>> turtle.left(60) >>> turtle.fd(50) >>> turtle.end_poly() >>> p = turtle.get_poly() >>> register_shape("myFavouriteShape", p)

 -- Function: turtle.clone ()

     Create and return a clone of the turtle with same position, heading
     and turtle properties.

          >>> mick = Turtle() >>> joe = mick.clone()

 -- Function: turtle.getturtle ()
 -- Function: turtle.getpen ()

     Return the Turtle object itself.  Only reasonable use: as a
     function to return the “anonymous turtle”:

          >>> pet = getturtle() >>> pet.fd(50) >>> pet <turtle.Turtle object at 0x...>

 -- Function: turtle.getscreen ()

     Return the *note TurtleScreen: 2fd5. object the turtle is drawing
     on.  TurtleScreen methods can then be called for that object.

          >>> ts = turtle.getscreen() >>> ts <turtle._Screen object at 0x...> >>> ts.bgcolor("pink")

 -- Function: turtle.setundobuffer (size)


     Parameters: ‘size’ – an integer or ‘None’

     Set or disable undobuffer.  If `size' is an integer an empty
     undobuffer of given size is installed.  `size' gives the maximum
     number of turtle actions that can be undone by the *note undo():
     2ff3. method/function.  If `size' is ‘None’, the undobuffer is
     disabled.

          >>> turtle.setundobuffer(42)

 -- Function: turtle.undobufferentries ()

     Return number of entries in the undobuffer.

          >>> while undobufferentries(): ...     undo()


File: python.info,  Node: Compound shapes,  Prev: Special Turtle methods,  Up: Methods of RawTurtle/Turtle and corresponding functions

5.25.1.19 Compound shapes
.........................

To use compound turtle shapes, which consist of several polygons of
different color, you must use the helper class *note Shape: 305e.
explicitly as described below:

  1. Create an empty Shape object of type “compound”.

  2. Add as many components to this object as desired, using the
     ‘addcomponent()’ method.

     For example:

          >>> s = Shape("compound") >>> poly1 = ((0,0),(10,-5),(0,10),(-10,-5)) >>> s.addcomponent(poly1, "red", "blue") >>> poly2 = ((0,0),(10,-5),(-10,-5)) >>> s.addcomponent(poly2, "blue", "red")

  3. Now add the Shape to the Screen’s shapelist and use it:

          >>> register_shape("myshape", s) >>> shape("myshape")

     Note: The *note Shape: 305e. class is used internally by the *note
     register_shape(): 3042. method in different ways.  The application
     programmer has to deal with the Shape class `only' when using
     compound shapes like shown above!


File: python.info,  Node: Methods of TurtleScreen/Screen and corresponding functions,  Next: Public classes,  Prev: Methods of RawTurtle/Turtle and corresponding functions,  Up: turtle — Turtle graphics

5.25.1.20 Methods of TurtleScreen/Screen and corresponding functions
....................................................................

Most of the examples in this section refer to a TurtleScreen instance
called ‘screen’.

* Menu:

* Window control::
* Animation control::
* Using screen events::
* Input methods::
* Settings and special methods::
* Methods specific to Screen, not inherited from TurtleScreen: Methods specific to Screen not inherited from TurtleScreen.


File: python.info,  Node: Window control,  Next: Animation control,  Up: Methods of TurtleScreen/Screen and corresponding functions

5.25.1.21 Window control
........................

 -- Function: turtle.bgcolor (*args)


     Parameters: ‘args’ – a color string or three numbers in the range
     0..colormode or a 3-tuple of such numbers

     Set or return background color of the TurtleScreen.

          >>> screen.bgcolor("orange") >>> screen.bgcolor() 'orange' >>> screen.bgcolor("#800080") >>> screen.bgcolor() (128.0, 0.0, 128.0)

 -- Function: turtle.bgpic (picname=None)


     Parameters: ‘picname’ – a string, name of a gif-file or ‘"nopic"’,
     or ‘None’

     Set background image or return name of current backgroundimage.  If
     `picname' is a filename, set the corresponding image as background.
     If `picname' is ‘"nopic"’, delete background image, if present.  If
     `picname' is ‘None’, return the filename of the current
     backgroundimage.

          >>> screen.bgpic() 'nopic' >>> screen.bgpic("landscape.gif") >>> screen.bgpic() "landscape.gif"

 -- Function: turtle.clear ()
 -- Function: turtle.clearscreen ()

     Delete all drawings and all turtles from the TurtleScreen.  Reset
     the now empty TurtleScreen to its initial state: white background,
     no background image, no event bindings and tracing on.

          Note: This TurtleScreen method is available as a global
          function only under the name ‘clearscreen’.  The global
          function ‘clear’ is a different one derived from the Turtle
          method ‘clear’.

 -- Function: turtle.reset ()
 -- Function: turtle.resetscreen ()

     Reset all Turtles on the Screen to their initial state.

          Note: This TurtleScreen method is available as a global
          function only under the name ‘resetscreen’.  The global
          function ‘reset’ is another one derived from the Turtle method
          ‘reset’.

 -- Function: turtle.screensize (canvwidth=None, canvheight=None,
          bg=None)


     Parameters:

        * ‘canvwidth’ – positive integer, new width of canvas in pixels

        * ‘canvheight’ – positive integer, new height of canvas in
          pixels

        * ‘bg’ – colorstring or color-tuple, new background color

     If no arguments are given, return current (canvaswidth,
     canvasheight).  Else resize the canvas the turtles are drawing on.
     Do not alter the drawing window.  To observe hidden parts of the
     canvas, use the scrollbars.  With this method, one can make visible
     those parts of a drawing which were outside the canvas before.

          >>> screen.screensize() (400, 300) >>> screen.screensize(2000,1500) >>> screen.screensize() (2000, 1500)

     e.g.  to search for an erroneously escaped turtle ;-)

 -- Function: turtle.setworldcoordinates (llx, lly, urx, ury)


     Parameters:

        * ‘llx’ – a number, x-coordinate of lower left corner of canvas

        * ‘lly’ – a number, y-coordinate of lower left corner of canvas

        * ‘urx’ – a number, x-coordinate of upper right corner of canvas

        * ‘ury’ – a number, y-coordinate of upper right corner of canvas

     Set up user-defined coordinate system and switch to mode “world” if
     necessary.  This performs a ‘screen.reset()’.  If mode “world” is
     already active, all drawings are redrawn according to the new
     coordinates.

     `ATTENTION': in user-defined coordinate systems angles may appear
     distorted.

          >>> screen.reset() >>> screen.setworldcoordinates(-50,-7.5,50,7.5) >>> for _ in range(72): ...     left(10) ... >>> for _ in range(8): ...     left(45); fd(2)   # a regular octagon


File: python.info,  Node: Animation control,  Next: Using screen events,  Prev: Window control,  Up: Methods of TurtleScreen/Screen and corresponding functions

5.25.1.22 Animation control
...........................

 -- Function: turtle.delay (delay=None)


     Parameters: ‘delay’ – positive integer

     Set or return the drawing `delay' in milliseconds.  (This is
     approximately the time interval between two consecutive canvas
     updates.)  The longer the drawing delay, the slower the animation.

     Optional argument:

          >>> screen.delay() 10 >>> screen.delay(5) >>> screen.delay() 5

 -- Function: turtle.tracer (n=None, delay=None)


     Parameters:

        * ‘n’ – nonnegative integer

        * ‘delay’ – nonnegative integer

     Turn turtle animation on/off and set delay for update drawings.  If
     `n' is given, only each n-th regular screen update is really
     performed.  (Can be used to accelerate the drawing of complex
     graphics.)  When called without arguments, returns the currently
     stored value of n.  Second argument sets delay value (see *note
     delay(): 3033.).

          >>> screen.tracer(8, 25) >>> dist = 2 >>> for i in range(200): ...     fd(dist) ...     rt(90) ...     dist += 2

 -- Function: turtle.update ()

     Perform a TurtleScreen update.  To be used when tracer is turned
     off.

See also the RawTurtle/Turtle method *note speed(): 2ff4.


File: python.info,  Node: Using screen events,  Next: Input methods,  Prev: Animation control,  Up: Methods of TurtleScreen/Screen and corresponding functions

5.25.1.23 Using screen events
.............................

 -- Function: turtle.listen (xdummy=None, ydummy=None)

     Set focus on TurtleScreen (in order to collect key-events).  Dummy
     arguments are provided in order to be able to pass *note listen():
     3036. to the onclick method.

 -- Function: turtle.onkey (fun, key)
 -- Function: turtle.onkeyrelease (fun, key)


     Parameters:

        * ‘fun’ – a function with no arguments or ‘None’

        * ‘key’ – a string: key (e.g.  “a”) or key-symbol (e.g.
          “space”)

     Bind `fun' to key-release event of key.  If `fun' is ‘None’, event
     bindings are removed.  Remark: in order to be able to register
     key-events, TurtleScreen must have the focus.  (See method *note
     listen(): 3036.)

          >>> def f(): ...     fd(50) ...     lt(60) ... >>> screen.onkey(f, "Up") >>> screen.listen()

 -- Function: turtle.onkeypress (fun, key=None)


     Parameters:

        * ‘fun’ – a function with no arguments or ‘None’

        * ‘key’ – a string: key (e.g.  “a”) or key-symbol (e.g.
          “space”)

     Bind `fun' to key-press event of key if key is given, or to any
     key-press-event if no key is given.  Remark: in order to be able to
     register key-events, TurtleScreen must have focus.  (See method
     *note listen(): 3036.)

          >>> def f(): ...     fd(50) ... >>> screen.onkey(f, "Up") >>> screen.listen()

 -- Function: turtle.onclick (fun, btn=1, add=None)
 -- Function: turtle.onscreenclick (fun, btn=1, add=None)


     Parameters:

        * ‘fun’ – a function with two arguments which will be called
          with the coordinates of the clicked point on the canvas

        * ‘btn’ – number of the mouse-button, defaults to 1 (left mouse
          button)

        * ‘add’ – ‘True’ or ‘False’ – if ‘True’, a new binding will be
          added, otherwise it will replace a former binding

     Bind `fun' to mouse-click events on this screen.  If `fun' is
     ‘None’, existing bindings are removed.

     Example for a TurtleScreen instance named ‘screen’ and a Turtle
     instance named turtle:

          >>> screen.onclick(turtle.goto) # Subsequently clicking into the TurtleScreen will >>>                             # make the turtle move to the clicked point. >>> screen.onclick(None)        # remove event binding again

          Note: This TurtleScreen method is available as a global
          function only under the name ‘onscreenclick’.  The global
          function ‘onclick’ is another one derived from the Turtle
          method ‘onclick’.

 -- Function: turtle.ontimer (fun, t=0)


     Parameters:

        * ‘fun’ – a function with no arguments

        * ‘t’ – a number >= 0

     Install a timer that calls `fun' after `t' milliseconds.

          >>> running = True >>> def f(): ...     if running: ...         fd(50) ...         lt(60) ...         screen.ontimer(f, 250) >>> f()   ### makes the turtle march around >>> running = False

 -- Function: turtle.mainloop ()
 -- Function: turtle.done ()

     Starts event loop - calling Tkinter’s mainloop function.  Must be
     the last statement in a turtle graphics program.  Must `not' be
     used if a script is run from within IDLE in -n mode (No subprocess)
     - for interactive use of turtle graphics.

          >>> screen.mainloop()


File: python.info,  Node: Input methods,  Next: Settings and special methods,  Prev: Using screen events,  Up: Methods of TurtleScreen/Screen and corresponding functions

5.25.1.24 Input methods
.......................

 -- Function: turtle.textinput (title, prompt)


     Parameters:

        * ‘title’ – string

        * ‘prompt’ – string

     Pop up a dialog window for input of a string.  Parameter title is
     the title of the dialog window, prompt is a text mostly describing
     what information to input.  Return the string input.  If the dialog
     is canceled, return ‘None’.

          >>> screen.textinput("NIM", "Name of first player:")

 -- Function: turtle.numinput (title, prompt, default=None, minval=None,
          maxval=None)


     Parameters:

        * ‘title’ – string

        * ‘prompt’ – string

        * ‘default’ – number (optional)

        * ‘minval’ – number (optional)

        * ‘maxval’ – number (optional)

     Pop up a dialog window for input of a number.  title is the title
     of the dialog window, prompt is a text mostly describing what
     numerical information to input.  default: default value, minval:
     minimum value for input, maxval: maximum value for input The number
     input must be in the range minval ..  maxval if these are given.
     If not, a hint is issued and the dialog remains open for
     correction.  Return the number input.  If the dialog is canceled,
     return ‘None’.

          >>> screen.numinput("Poker", "Your stakes:", 1000, minval=10, maxval=10000)


File: python.info,  Node: Settings and special methods,  Next: Methods specific to Screen not inherited from TurtleScreen,  Prev: Input methods,  Up: Methods of TurtleScreen/Screen and corresponding functions

5.25.1.25 Settings and special methods
......................................

 -- Function: turtle.mode (mode=None)


     Parameters: ‘mode’ – one of the strings “standard”, “logo” or
     “world”

     Set turtle mode (“standard”, “logo” or “world”) and perform reset.
     If mode is not given, current mode is returned.

     Mode “standard” is compatible with old *note turtle: 116.  Mode
     “logo” is compatible with most Logo turtle graphics.  Mode “world”
     uses user-defined “world coordinates”.  `Attention': in this mode
     angles appear distorted if ‘x/y’ unit-ratio doesn’t equal 1.

     Mode             Initial turtle heading        positive angles
                                                    
     -----------------------------------------------------------------------
                                                    
     “standard”       to the right (east)           counterclockwise
                                                    
                                                    
     “logo”           upward (north)                clockwise
                                                    

          >>> mode("logo")   # resets turtle heading to north >>> mode() 'logo'

 -- Function: turtle.colormode (cmode=None)


     Parameters: ‘cmode’ – one of the values 1.0 or 255

     Return the colormode or set it to 1.0 or 255.  Subsequently `r',
     `g', `b' values of color triples have to be in the range
     0..`cmode'.

          >>> screen.colormode(1) >>> turtle.pencolor(240, 160, 80) Traceback (most recent call last):      ... TurtleGraphicsError: bad color sequence: (240, 160, 80) >>> screen.colormode() 1.0 >>> screen.colormode(255) >>> screen.colormode() 255 >>> turtle.pencolor(240,160,80)

 -- Function: turtle.getcanvas ()

     Return the Canvas of this TurtleScreen.  Useful for insiders who
     know what to do with a Tkinter Canvas.

          >>> cv = screen.getcanvas() >>> cv <turtle.ScrolledCanvas object ...>

 -- Function: turtle.getshapes ()

     Return a list of names of all currently available turtle shapes.

          >>> screen.getshapes() ['arrow', 'blank', 'circle', ..., 'turtle']

 -- Function: turtle.register_shape (name, shape=None)
 -- Function: turtle.addshape (name, shape=None)

     There are three different ways to call this function:

       1. `name' is the name of a gif-file and `shape' is ‘None’:
          Install the corresponding image shape.

               >>> screen.register_shape("turtle.gif")

               Note: Image shapes `do not' rotate when turning the
               turtle, so they do not display the heading of the turtle!

       2. `name' is an arbitrary string and `shape' is a tuple of pairs
          of coordinates: Install the corresponding polygon shape.

               >>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))

       3. `name' is an arbitrary string and shape is a (compound) *note
          Shape: 305e. object: Install the corresponding compound shape.

     Add a turtle shape to TurtleScreen’s shapelist.  Only thusly
     registered shapes can be used by issuing the command
     ‘shape(shapename)’.

 -- Function: turtle.turtles ()

     Return the list of turtles on the screen.

          >>> for turtle in screen.turtles(): ...     turtle.color("red")

 -- Function: turtle.window_height ()

     Return the height of the turtle window.

          >>> screen.window_height() 480

 -- Function: turtle.window_width ()

     Return the width of the turtle window.

          >>> screen.window_width() 640


File: python.info,  Node: Methods specific to Screen not inherited from TurtleScreen,  Prev: Settings and special methods,  Up: Methods of TurtleScreen/Screen and corresponding functions

5.25.1.26 Methods specific to Screen, not inherited from TurtleScreen
.....................................................................

 -- Function: turtle.bye ()

     Shut the turtlegraphics window.

 -- Function: turtle.exitonclick ()

     Bind bye() method to mouse clicks on the Screen.

     If the value “using_IDLE” in the configuration dictionary is
     ‘False’ (default value), also enter mainloop.  Remark: If IDLE with
     the ‘-n’ switch (no subprocess) is used, this value should be set
     to ‘True’ in ‘turtle.cfg’.  In this case IDLE’s own mainloop is
     active also for the client script.

 -- Function: turtle.setup (width=_CFG["width"], height=_CFG["height"],
          startx=_CFG["leftright"], starty=_CFG["topbottom"])

     Set the size and position of the main window.  Default values of
     arguments are stored in the configuration dictionary and can be
     changed via a ‘turtle.cfg’ file.


     Parameters:

        * ‘width’ – if an integer, a size in pixels, if a float, a
          fraction of the screen; default is 50% of screen

        * ‘height’ – if an integer, the height in pixels, if a float, a
          fraction of the screen; default is 75% of screen

        * ‘startx’ – if positive, starting position in pixels from the
          left edge of the screen, if negative from the right edge, if
          ‘None’, center window horizontally

        * ‘starty’ – if positive, starting position in pixels from the
          top edge of the screen, if negative from the bottom edge, if
          ‘None’, center window vertically

          >>> screen.setup (width=200, height=200, startx=0, starty=0) >>>              # sets window to 200x200 pixels, in upper left of screen >>> screen.setup(width=.75, height=0.5, startx=None, starty=None) >>>              # sets window to 75% of screen by 50% of screen and centers

 -- Function: turtle.title (titlestring)


     Parameters: ‘titlestring’ – a string that is shown in the titlebar
     of the turtle graphics window

     Set title of turtle window to `titlestring'.

          >>> screen.title("Welcome to the turtle zoo!")


File: python.info,  Node: Public classes,  Next: Help and configuration,  Prev: Methods of TurtleScreen/Screen and corresponding functions,  Up: turtle — Turtle graphics

5.25.1.27 Public classes
........................

 -- Class: turtle.RawTurtle (canvas)
 -- Class: turtle.RawPen (canvas)


     Parameters: ‘canvas’ – a ‘tkinter.Canvas’, a *note ScrolledCanvas:
     2fd6. or a *note TurtleScreen: 2fd5.

     Create a turtle.  The turtle has all methods described above as
     “methods of Turtle/RawTurtle”.

 -- Class: turtle.Turtle

     Subclass of RawTurtle, has the same interface but draws on a
     default *note Screen: 2fd7. object created automatically when
     needed for the first time.

 -- Class: turtle.TurtleScreen (cv)


     Parameters: ‘cv’ – a ‘tkinter.Canvas’

     Provides screen oriented methods like ‘setbg()’ etc.  that are
     described above.

 -- Class: turtle.Screen

     Subclass of TurtleScreen, with *note four methods added: 3066.

 -- Class: turtle.ScrolledCanvas (master)


     Parameters: ‘master’ – some Tkinter widget to contain the
     ScrolledCanvas, i.e.  a Tkinter-canvas with scrollbars added

     Used by class Screen, which thus automatically provides a
     ScrolledCanvas as playground for the turtles.

 -- Class: turtle.Shape (type_, data)


     Parameters: ‘type_’ – one of the strings “polygon”, “image”,
     “compound”

     Data structure modeling shapes.  The pair ‘(type_, data)’ must
     follow this specification:

     `type_'         `data'
                     
     -------------------------------------------------------------------------------
                     
     “polygon”       a polygon-tuple, i.e.  a tuple of pairs of coordinates
                     
                     
     “image”         an image (in this form only used internally!)
                     
                     
     “compound”      ‘None’ (a compound shape has to be constructed using the
                     *note addcomponent(): 3068. method)
                     

      -- Method: addcomponent (poly, fill, outline=None)


          Parameters:

             * ‘poly’ – a polygon, i.e.  a tuple of pairs of numbers

             * ‘fill’ – a color the `poly' will be filled with

             * ‘outline’ – a color for the poly’s outline (if given)

          Example:

               >>> poly = ((0,0),(10,-5),(0,10),(-10,-5)) >>> s = Shape("compound") >>> s.addcomponent(poly, "red", "blue") >>> # ... add more components and then use register_shape()

          See *note Compound shapes: 305d.

 -- Class: turtle.Vec2D (x, y)

     A two-dimensional vector class, used as a helper class for
     implementing turtle graphics.  May be useful for turtle graphics
     programs too.  Derived from tuple, so a vector is a tuple!

     Provides (for `a', `b' vectors, `k' number):

        * ‘a + b’ vector addition

        * ‘a - b’ vector subtraction

        * ‘a * b’ inner product

        * ‘k * a’ and ‘a * k’ multiplication with scalar

        * ‘abs(a)’ absolute value of a

        * ‘a.rotate(angle)’ rotation


File: python.info,  Node: Help and configuration,  Next: turtledemo — Demo scripts,  Prev: Public classes,  Up: turtle — Turtle graphics

5.25.1.28 Help and configuration
................................

* Menu:

* How to use help::
* Translation of docstrings into different languages::
* How to configure Screen and Turtles::


File: python.info,  Node: How to use help,  Next: Translation of docstrings into different languages,  Up: Help and configuration

5.25.1.29 How to use help
.........................

The public methods of the Screen and Turtle classes are documented
extensively via docstrings.  So these can be used as online-help via the
Python help facilities:

   - When using IDLE, tooltips show the signatures and first lines of
     the docstrings of typed in function-/method calls.

   - Calling *note help(): 567. on methods or functions displays the
     docstrings:

          >>> help(Screen.bgcolor) Help on method bgcolor in module turtle:  bgcolor(self, *args) unbound turtle.Screen method     Set or return backgroundcolor of the TurtleScreen.      Arguments (if given): a color string or three numbers     in the range 0..colormode or a 3-tuple of such numbers.         >>> screen.bgcolor("orange")       >>> screen.bgcolor()       "orange"       >>> screen.bgcolor(0.5,0,0.5)       >>> screen.bgcolor()       "#800080"  >>> help(Turtle.penup) Help on method penup in module turtle:  penup(self) unbound turtle.Turtle method     Pull the pen up -- no drawing when moving.      Aliases: penup | pu | up      No argument      >>> turtle.penup()

   - The docstrings of the functions which are derived from methods have
     a modified form:

          >>> help(bgcolor) Help on function bgcolor in module turtle:  bgcolor(*args)     Set or return backgroundcolor of the TurtleScreen.      Arguments (if given): a color string or three numbers     in the range 0..colormode or a 3-tuple of such numbers.      Example::        >>> bgcolor("orange")       >>> bgcolor()       "orange"       >>> bgcolor(0.5,0,0.5)       >>> bgcolor()       "#800080"  >>> help(penup) Help on function penup in module turtle:  penup()     Pull the pen up -- no drawing when moving.      Aliases: penup | pu | up      No argument      Example:     >>> penup()

These modified docstrings are created automatically together with the
function definitions that are derived from the methods at import time.


File: python.info,  Node: Translation of docstrings into different languages,  Next: How to configure Screen and Turtles,  Prev: How to use help,  Up: Help and configuration

5.25.1.30 Translation of docstrings into different languages
............................................................

There is a utility to create a dictionary the keys of which are the
method names and the values of which are the docstrings of the public
methods of the classes Screen and Turtle.

 -- Function: turtle.write_docstringdict
          (filename="turtle_docstringdict")


     Parameters: ‘filename’ – a string, used as filename

     Create and write docstring-dictionary to a Python script with the
     given filename.  This function has to be called explicitly (it is
     not used by the turtle graphics classes).  The docstring dictionary
     will be written to the Python script ‘`filename'.py’.  It is
     intended to serve as a template for translation of the docstrings
     into different languages.

If you (or your students) want to use *note turtle: 116. with online
help in your native language, you have to translate the docstrings and
save the resulting file as e.g.  ‘turtle_docstringdict_german.py’.

If you have an appropriate entry in your ‘turtle.cfg’ file this
dictionary will be read in at import time and will replace the original
English docstrings.

At the time of this writing there are docstring dictionaries in German
and in Italian.  (Requests please to <glingl@aon.at>.)


File: python.info,  Node: How to configure Screen and Turtles,  Prev: Translation of docstrings into different languages,  Up: Help and configuration

5.25.1.31 How to configure Screen and Turtles
.............................................

The built-in default configuration mimics the appearance and behaviour
of the old turtle module in order to retain best possible compatibility
with it.

If you want to use a different configuration which better reflects the
features of this module or which better fits to your needs, e.g.  for
use in a classroom, you can prepare a configuration file ‘turtle.cfg’
which will be read at import time and modify the configuration according
to its settings.

The built in configuration would correspond to the following turtle.cfg:

     width = 0.5 height = 0.75 leftright = None topbottom = None canvwidth = 400 canvheight = 300 mode = standard colormode = 1.0 delay = 10 undobuffersize = 1000 shape = classic pencolor = black fillcolor = black resizemode = noresize visible = True language = english exampleturtle = turtle examplescreen = screen title = Python Turtle Graphics using_IDLE = False

Short explanation of selected entries:

   - The first four lines correspond to the arguments of the
     ‘Screen.setup()’ method.

   - Line 5 and 6 correspond to the arguments of the method
     ‘Screen.screensize()’.

   - `shape' can be any of the built-in shapes, e.g: arrow, turtle, etc.
     For more info try ‘help(shape)’.

   - If you want to use no fillcolor (i.e.  make the turtle
     transparent), you have to write ‘fillcolor = ""’ (but all nonempty
     strings must not have quotes in the cfg-file).

   - If you want to reflect the turtle its state, you have to use
     ‘resizemode = auto’.

   - If you set e.g.  ‘language = italian’ the docstringdict
     ‘turtle_docstringdict_italian.py’ will be loaded at import time (if
     present on the import path, e.g.  in the same directory as *note
     turtle: 116.

   - The entries `exampleturtle' and `examplescreen' define the names of
     these objects as they occur in the docstrings.  The transformation
     of method-docstrings to function-docstrings will delete these names
     from the docstrings.

   - `using_IDLE': Set this to ‘True’ if you regularly work with IDLE
     and its -n switch (“no subprocess”).  This will prevent *note
     exitonclick(): 304a. to enter the mainloop.

There can be a ‘turtle.cfg’ file in the directory where *note turtle:
116. is stored and an additional one in the current working directory.
The latter will override the settings of the first one.

The ‘Lib/turtledemo’ directory contains a ‘turtle.cfg’ file.  You can
study it as an example and see its effects when running the demos
(preferably not from within the demo-viewer).


File: python.info,  Node: turtledemo — Demo scripts,  Next: Changes since Python 2 6,  Prev: Help and configuration,  Up: turtle — Turtle graphics

5.25.1.32 ‘turtledemo’ — Demo scripts
.....................................

The *note turtledemo: 117. package includes a set of demo scripts.
These scripts can be run and viewed using the supplied demo viewer as
follows:

     python -m turtledemo

Alternatively, you can run the demo scripts individually.  For example,

     python -m turtledemo.bytedesign

The *note turtledemo: 117. package directory contains:

   - A demo viewer ‘__main__.py’ which can be used to view the
     sourcecode of the scripts and run them at the same time.

   - Multiple scripts demonstrating different features of the *note
     turtle: 116. module.  Examples can be accessed via the Examples
     menu.  They can also be run standalone.

   - A ‘turtle.cfg’ file which serves as an example of how to write and
     use such files.

The demo scripts are:

Name                 Description                        Features
                                                        
------------------------------------------------------------------------------------
                                                        
bytedesign           complex classical turtle           ‘tracer()’, delay,
                     graphics pattern                   ‘update()’
                                                        
                                                        
chaos                graphs Verhulst dynamics, shows    world coordinates
                     that computer’s computations can   
                     generate results sometimes
                     against the common sense
                     expectations
                     
                                                        
clock                analog clock showing time of       turtles as clock’s hands,
                     your computer                      ontimer
                                                        
                                                        
colormixer           experiment with r, g, b            ‘ondrag()’
                                                        
                                                        
forest               3 breadth-first trees              randomization
                                                        
                                                        
fractalcurves        Hilbert & Koch curves              recursion
                                                        
                                                        
lindenmayer          ethnomathematics (indian kolams)   L-System
                                                        
                                                        
minimal_hanoi        Towers of Hanoi                    Rectangular Turtles as
                                                        Hanoi discs (shape,
                                                        shapesize)
                                                        
                                                        
nim                  play the classical nim game with   turtles as nimsticks,
                     three heaps of sticks against      event driven (mouse,
                     the computer.                      keyboard)
                                                        
                                                        
paint                super minimalistic drawing         ‘onclick()’
                     program                            
                     
                                                        
peace                elementary                         turtle: appearance and
                                                        animation
                                                        
                                                        
penrose              aperiodic tiling with kites and    ‘stamp()’
                     darts                              
                     
                                                        
planet_and_moon      simulation of gravitational        compound shapes, ‘Vec2D’
                     system                             
                     
                                                        
round_dance          dancing turtles rotating           compound shapes, clone
                     pairwise in opposite direction     shapesize, tilt,
                                                        get_shapepoly, update
                                                        
                                                        
sorting_animate      visual demonstration of            simple alignment,
                     different sorting methods          randomization
                                                        
                                                        
tree                 a (graphical) breadth first tree   ‘clone()’
                     (using generators)                 
                     
                                                        
two_canvases         simple design                      turtles on two canvases
                                                        
                                                        
wikipedia            a pattern from the wikipedia       ‘clone()’, ‘undo()’
                     article on turtle graphics         
                     
                                                        
yinyang              another elementary example         ‘circle()’
                                                        

Have fun!


File: python.info,  Node: Changes since Python 2 6,  Next: Changes since Python 3 0,  Prev: turtledemo — Demo scripts,  Up: turtle — Turtle graphics

5.25.1.33 Changes since Python 2.6
..................................

   - The methods ‘Turtle.tracer()’, ‘Turtle.window_width()’ and
     ‘Turtle.window_height()’ have been eliminated.  Methods with these
     names and functionality are now available only as methods of
     ‘Screen’.  The functions derived from these remain available.  (In
     fact already in Python 2.6 these methods were merely duplications
     of the corresponding ‘TurtleScreen’/‘Screen’-methods.)

   - The method ‘Turtle.fill()’ has been eliminated.  The behaviour of
     ‘begin_fill()’ and ‘end_fill()’ have changed slightly: now every
     filling-process must be completed with an ‘end_fill()’ call.

   - A method ‘Turtle.filling()’ has been added.  It returns a boolean
     value: ‘True’ if a filling process is under way, ‘False’ otherwise.
     This behaviour corresponds to a ‘fill()’ call without arguments in
     Python 2.6.


File: python.info,  Node: Changes since Python 3 0,  Prev: Changes since Python 2 6,  Up: turtle — Turtle graphics

5.25.1.34 Changes since Python 3.0
..................................

   - The methods ‘Turtle.shearfactor()’, ‘Turtle.shapetransform()’ and
     ‘Turtle.get_shapepoly()’ have been added.  Thus the full range of
     regular linear transforms is now available for transforming turtle
     shapes.  ‘Turtle.tiltangle()’ has been enhanced in functionality:
     it now can be used to get or set the tiltangle.
     ‘Turtle.settiltangle()’ has been deprecated.

   - The method ‘Screen.onkeypress()’ has been added as a complement to
     ‘Screen.onkey()’ which in fact binds actions to the keyrelease
     event.  Accordingly the latter has got an alias:
     ‘Screen.onkeyrelease()’.

   - The method ‘Screen.mainloop()’ has been added.  So when working
     only with Screen and Turtle objects one must not additionally
     import ‘mainloop()’ anymore.

   - Two input methods has been added ‘Screen.textinput()’ and
     ‘Screen.numinput()’.  These popup input dialogs and return strings
     and numbers respectively.

   - Two example scripts ‘tdemo_nim.py’ and ‘tdemo_round_dance.py’ have
     been added to the ‘Lib/turtledemo’ directory.


File: python.info,  Node: cmd — Support for line-oriented command interpreters,  Next: shlex — Simple lexical analysis,  Prev: turtle — Turtle graphics,  Up: Program Frameworks

5.25.2 ‘cmd’ — Support for line-oriented command interpreters
-------------------------------------------------------------

`Source code:' Lib/cmd.py(1)

__________________________________________________________________

The *note Cmd: 3073. class provides a simple framework for writing
line-oriented command interpreters.  These are often useful for test
harnesses, administrative tools, and prototypes that will later be
wrapped in a more sophisticated interface.

 -- Class: cmd.Cmd (completekey='tab', stdin=None, stdout=None)

     A *note Cmd: 3073. instance or subclass instance is a line-oriented
     interpreter framework.  There is no good reason to instantiate
     *note Cmd: 3073. itself; rather, it’s useful as a superclass of an
     interpreter class you define yourself in order to inherit *note
     Cmd: 3073.’s methods and encapsulate action methods.

     The optional argument `completekey' is the *note readline: de. name
     of a completion key; it defaults to ‘Tab’.  If `completekey' is not
     *note None: 157. and *note readline: de. is available, command
     completion is done automatically.

     The optional arguments `stdin' and `stdout' specify the input and
     output file objects that the Cmd instance or subclass instance will
     use for input and output.  If not specified, they will default to
     *note sys.stdin: 302. and *note sys.stdout: 303.

     If you want a given `stdin' to be used, make sure to set the
     instance’s *note use_rawinput: 3074. attribute to ‘False’,
     otherwise `stdin' will be ignored.

* Menu:

* Cmd Objects::
* Cmd Example::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/cmd.py


File: python.info,  Node: Cmd Objects,  Next: Cmd Example,  Up: cmd — Support for line-oriented command interpreters

5.25.2.1 Cmd Objects
....................

A *note Cmd: 3073. instance has the following methods:

 -- Method: Cmd.cmdloop (intro=None)

     Repeatedly issue a prompt, accept input, parse an initial prefix
     off the received input, and dispatch to action methods, passing
     them the remainder of the line as argument.

     The optional argument is a banner or intro string to be issued
     before the first prompt (this overrides the *note intro: 3078.
     class attribute).

     If the *note readline: de. module is loaded, input will
     automatically inherit ‘bash’-like history-list editing (e.g.
     ‘Control-P’ scrolls back to the last command, ‘Control-N’ forward
     to the next one, ‘Control-F’ moves the cursor to the right
     non-destructively, ‘Control-B’ moves the cursor to the left
     non-destructively, etc.).

     An end-of-file on input is passed back as the string ‘'EOF'’.

     An interpreter instance will recognize a command name ‘foo’ if and
     only if it has a method ‘do_foo()’.  As a special case, a line
     beginning with the character ‘'?'’ is dispatched to the method
     ‘do_help()’.  As another special case, a line beginning with the
     character ‘'!'’ is dispatched to the method ‘do_shell()’ (if such a
     method is defined).

     This method will return when the *note postcmd(): 3079. method
     returns a true value.  The `stop' argument to *note postcmd():
     3079. is the return value from the command’s corresponding ‘do_*()’
     method.

     If completion is enabled, completing commands will be done
     automatically, and completing of commands args is done by calling
     ‘complete_foo()’ with arguments `text', `line', `begidx', and
     `endidx'.  `text' is the string prefix we are attempting to match:
     all returned matches must begin with it.  `line' is the current
     input line with leading whitespace removed, `begidx' and `endidx'
     are the beginning and ending indexes of the prefix text, which
     could be used to provide different completion depending upon which
     position the argument is in.

     All subclasses of *note Cmd: 3073. inherit a predefined
     ‘do_help()’.  This method, called with an argument ‘'bar'’, invokes
     the corresponding method ‘help_bar()’, and if that is not present,
     prints the docstring of ‘do_bar()’, if available.  With no
     argument, ‘do_help()’ lists all available help topics (that is, all
     commands with corresponding ‘help_*()’ methods or commands that
     have docstrings), and also lists any undocumented commands.

 -- Method: Cmd.onecmd (str)

     Interpret the argument as though it had been typed in response to
     the prompt.  This may be overridden, but should not normally need
     to be; see the *note precmd(): 307b. and *note postcmd(): 3079.
     methods for useful execution hooks.  The return value is a flag
     indicating whether interpretation of commands by the interpreter
     should stop.  If there is a ‘do_*()’ method for the command `str',
     the return value of that method is returned, otherwise the return
     value from the *note default(): 307c. method is returned.

 -- Method: Cmd.emptyline ()

     Method called when an empty line is entered in response to the
     prompt.  If this method is not overridden, it repeats the last
     nonempty command entered.

 -- Method: Cmd.default (line)

     Method called on an input line when the command prefix is not
     recognized.  If this method is not overridden, it prints an error
     message and returns.

 -- Method: Cmd.completedefault (text, line, begidx, endidx)

     Method called to complete an input line when no command-specific
     ‘complete_*()’ method is available.  By default, it returns an
     empty list.

 -- Method: Cmd.precmd (line)

     Hook method executed just before the command line `line' is
     interpreted, but after the input prompt is generated and issued.
     This method is a stub in *note Cmd: 3073.; it exists to be
     overridden by subclasses.  The return value is used as the command
     which will be executed by the *note onecmd(): 307a. method; the
     *note precmd(): 307b. implementation may re-write the command or
     simply return `line' unchanged.

 -- Method: Cmd.postcmd (stop, line)

     Hook method executed just after a command dispatch is finished.
     This method is a stub in *note Cmd: 3073.; it exists to be
     overridden by subclasses.  `line' is the command line which was
     executed, and `stop' is a flag which indicates whether execution
     will be terminated after the call to *note postcmd(): 3079.; this
     will be the return value of the *note onecmd(): 307a. method.  The
     return value of this method will be used as the new value for the
     internal flag which corresponds to `stop'; returning false will
     cause interpretation to continue.

 -- Method: Cmd.preloop ()

     Hook method executed once when *note cmdloop(): 3077. is called.
     This method is a stub in *note Cmd: 3073.; it exists to be
     overridden by subclasses.

 -- Method: Cmd.postloop ()

     Hook method executed once when *note cmdloop(): 3077. is about to
     return.  This method is a stub in *note Cmd: 3073.; it exists to be
     overridden by subclasses.

Instances of *note Cmd: 3073. subclasses have some public instance
variables:

 -- Attribute: Cmd.prompt

     The prompt issued to solicit input.

 -- Attribute: Cmd.identchars

     The string of characters accepted for the command prefix.

 -- Attribute: Cmd.lastcmd

     The last nonempty command prefix seen.

 -- Attribute: Cmd.cmdqueue

     A list of queued input lines.  The cmdqueue list is checked in
     *note cmdloop(): 3077. when new input is needed; if it is nonempty,
     its elements will be processed in order, as if entered at the
     prompt.

 -- Attribute: Cmd.intro

     A string to issue as an intro or banner.  May be overridden by
     giving the *note cmdloop(): 3077. method an argument.

 -- Attribute: Cmd.doc_header

     The header to issue if the help output has a section for documented
     commands.

 -- Attribute: Cmd.misc_header

     The header to issue if the help output has a section for
     miscellaneous help topics (that is, there are ‘help_*()’ methods
     without corresponding ‘do_*()’ methods).

 -- Attribute: Cmd.undoc_header

     The header to issue if the help output has a section for
     undocumented commands (that is, there are ‘do_*()’ methods without
     corresponding ‘help_*()’ methods).

 -- Attribute: Cmd.ruler

     The character used to draw separator lines under the help-message
     headers.  If empty, no ruler line is drawn.  It defaults to ‘'='’.

 -- Attribute: Cmd.use_rawinput

     A flag, defaulting to true.  If true, *note cmdloop(): 3077. uses
     *note input(): c5e. to display a prompt and read the next command;
     if false, ‘sys.stdout.write()’ and ‘sys.stdin.readline()’ are used.
     (This means that by importing *note readline: de, on systems that
     support it, the interpreter will automatically support ‘Emacs’-like
     line editing and command-history keystrokes.)


File: python.info,  Node: Cmd Example,  Prev: Cmd Objects,  Up: cmd — Support for line-oriented command interpreters

5.25.2.2 Cmd Example
....................

The *note cmd: 1a. module is mainly useful for building custom shells
that let a user work with a program interactively.

This section presents a simple example of how to build a shell around a
few of the commands in the *note turtle: 116. module.

Basic turtle commands such as *note forward(): 2fdd. are added to a
*note Cmd: 3073. subclass with method named ‘do_forward()’.  The
argument is converted to a number and dispatched to the turtle module.
The docstring is used in the help utility provided by the shell.

The example also includes a basic record and playback facility
implemented with the *note precmd(): 307b. method which is responsible
for converting the input to lowercase and writing the commands to a
file.  The ‘do_playback()’ method reads the file and adds the recorded
commands to the ‘cmdqueue’ for immediate playback:

     import cmd, sys from turtle import *  class TurtleShell(cmd.Cmd):     intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'     prompt = '(turtle) '     file = None      # ----- basic turtle commands -----     def do_forward(self, arg):         'Move the turtle forward by the specified distance:  FORWARD 10'         forward(*parse(arg))     def do_right(self, arg):         'Turn turtle right by given number of degrees:  RIGHT 20'         right(*parse(arg))     def do_left(self, arg):         'Turn turtle left by given number of degrees:  LEFT 90'         left(*parse(arg))     def do_goto(self, arg):         'Move turtle to an absolute position with changing orientation.  GOTO 100 200'         goto(*parse(arg))     def do_home(self, arg):         'Return turtle to the home position:  HOME'         home()     def do_circle(self, arg):         'Draw circle with given radius an options extent and steps:  CIRCLE 50'         circle(*parse(arg))     def do_position(self, arg):         'Print the current turtle position:  POSITION'         print('Current position is %d %d\n' % position())     def do_heading(self, arg):         'Print the current turtle heading in degrees:  HEADING'         print('Current heading is %d\n' % (heading(),))     def do_color(self, arg):         'Set the color:  COLOR BLUE'         color(arg.lower())     def do_undo(self, arg):         'Undo (repeatedly) the last turtle action(s):  UNDO'     def do_reset(self, arg):         'Clear the screen and return turtle to center:  RESET'         reset()     def do_bye(self, arg):         'Stop recording, close the turtle window, and exit:  BYE'         print('Thank you for using Turtle')         self.close()         bye()         return True      # ----- record and playback -----     def do_record(self, arg):         'Save future commands to filename:  RECORD rose.cmd'         self.file = open(arg, 'w')     def do_playback(self, arg):         'Playback commands from a file:  PLAYBACK rose.cmd'         self.close()         with open(arg) as f:             self.cmdqueue.extend(f.read().splitlines())     def precmd(self, line):         line = line.lower()         if self.file and 'playback' not in line:             print(line, file=self.file)         return line     def close(self):         if self.file:             self.file.close()             self.file = None  def parse(arg):     'Convert a series of zero or more numbers to an argument tuple'     return tuple(map(int, arg.split()))  if __name__ == '__main__':     TurtleShell().cmdloop()

Here is a sample session with the turtle shell showing the help
functions, using blank lines to repeat commands, and the simple record
and playback facility:

     Welcome to the turtle shell.   Type help or ? to list commands.  (turtle) ?  Documented commands (type help <topic>): ======================================== bye     color    goto     home  playback  record  right circle  forward  heading  left  position  reset   undo  (turtle) help forward Move the turtle forward by the specified distance:  FORWARD 10 (turtle) record spiral.cmd (turtle) position Current position is 0 0  (turtle) heading Current heading is 0  (turtle) reset (turtle) circle 20 (turtle) right 30 (turtle) circle 40 (turtle) right 30 (turtle) circle 60 (turtle) right 30 (turtle) circle 80 (turtle) right 30 (turtle) circle 100 (turtle) right 30 (turtle) circle 120 (turtle) right 30 (turtle) circle 120 (turtle) heading Current heading is 180  (turtle) forward 100 (turtle) (turtle) right 90 (turtle) forward 100 (turtle) (turtle) right 90 (turtle) forward 400 (turtle) right 90 (turtle) forward 500 (turtle) right 90 (turtle) forward 400 (turtle) right 90 (turtle) forward 300 (turtle) playback spiral.cmd Current position is 0 0  Current heading is 0  Current heading is 180  (turtle) bye Thank you for using Turtle


File: python.info,  Node: shlex — Simple lexical analysis,  Prev: cmd — Support for line-oriented command interpreters,  Up: Program Frameworks

5.25.3 ‘shlex’ — Simple lexical analysis
----------------------------------------

`Source code:' Lib/shlex.py(1)

__________________________________________________________________

The *note shlex: 56f. class makes it easy to write lexical analyzers for
simple syntaxes resembling that of the Unix shell.  This will often be
useful for writing minilanguages, (for example, in run control files for
Python applications) or for parsing quoted strings.

The *note shlex: e8. module defines the following functions:

 -- Function: shlex.split (s, comments=False, posix=True)

     Split the string `s' using shell-like syntax.  If `comments' is
     *note False: 37d. (the default), the parsing of comments in the
     given string will be disabled (setting the *note commenters: 308d.
     attribute of the *note shlex: 56f. instance to the empty string).
     This function operates in POSIX mode by default, but uses non-POSIX
     mode if the `posix' argument is false.

          Note: Since the *note split(): 216. function instantiates a
          *note shlex: 56f. instance, passing ‘None’ for `s' will read
          the string to split from standard input.

 -- Function: shlex.join (split_command)

     Concatenate the tokens of the list `split_command' and return a
     string.  This function is the inverse of *note split(): 216.

          >>> from shlex import join >>> print(join(['echo', '-n', 'Multiple words'])) echo -n 'Multiple words'

     The returned value is shell-escaped to protect against injection
     vulnerabilities (see *note quote(): a68.).

     New in version 3.8.

 -- Function: shlex.quote (s)

     Return a shell-escaped version of the string `s'.  The returned
     value is a string that can safely be used as one token in a shell
     command line, for cases where you cannot use a list.

     This idiom would be unsafe:

          >>> filename = 'somefile; rm -rf ~' >>> command = 'ls -l {}'.format(filename) >>> print(command)  # executed by a shell: boom! ls -l somefile; rm -rf ~

     *note quote(): a68. lets you plug the security hole:

          >>> from shlex import quote >>> command = 'ls -l {}'.format(quote(filename)) >>> print(command) ls -l 'somefile; rm -rf ~' >>> remote_command = 'ssh home {}'.format(quote(command)) >>> print(remote_command) ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"''

     The quoting is compatible with UNIX shells and with *note split():
     216.:

          >>> from shlex import split >>> remote_command = split(remote_command) >>> remote_command ['ssh', 'home', "ls -l 'somefile; rm -rf ~'"] >>> command = split(remote_command[-1]) >>> command ['ls', '-l', 'somefile; rm -rf ~']

     New in version 3.3.

The *note shlex: e8. module defines the following class:

 -- Class: shlex.shlex (instream=None, infile=None, posix=False,
          punctuation_chars=False)

     A *note shlex: 56f. instance or subclass instance is a lexical
     analyzer object.  The initialization argument, if present,
     specifies where to read characters from.  It must be a
     file-/stream-like object with *note read(): 1f44. and *note
     readline(): 1b36. methods, or a string.  If no argument is given,
     input will be taken from ‘sys.stdin’.  The second optional argument
     is a filename string, which sets the initial value of the *note
     infile: 308e. attribute.  If the `instream' argument is omitted or
     equal to ‘sys.stdin’, this second argument defaults to “stdin”.
     The `posix' argument defines the operational mode: when `posix' is
     not true (default), the *note shlex: 56f. instance will operate in
     compatibility mode.  When operating in POSIX mode, *note shlex:
     56f. will try to be as close as possible to the POSIX shell parsing
     rules.  The `punctuation_chars' argument provides a way to make the
     behaviour even closer to how real shells parse.  This can take a
     number of values: the default value, ‘False’, preserves the
     behaviour seen under Python 3.5 and earlier.  If set to ‘True’,
     then parsing of the characters ‘();<>|&’ is changed: any run of
     these characters (considered punctuation characters) is returned as
     a single token.  If set to a non-empty string of characters, those
     characters will be used as the punctuation characters.  Any
     characters in the *note wordchars: 308f. attribute that appear in
     `punctuation_chars' will be removed from *note wordchars: 308f.
     See *note Improved Compatibility with Shells: 570. for more
     information.  `punctuation_chars' can be set only upon *note shlex:
     56f. instance creation and can’t be modified later.

     Changed in version 3.6: The `punctuation_chars' parameter was
     added.

See also
........

Module *note configparser: 23.

     Parser for configuration files similar to the Windows ‘.ini’ files.

* Menu:

* shlex Objects::
* Parsing Rules::
* Improved Compatibility with Shells::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/shlex.py


File: python.info,  Node: shlex Objects,  Next: Parsing Rules,  Up: shlex — Simple lexical analysis

5.25.3.1 shlex Objects
......................

A *note shlex: 56f. instance has the following methods:

 -- Method: shlex.get_token ()

     Return a token.  If tokens have been stacked using *note
     push_token(): 3093, pop a token off the stack.  Otherwise, read one
     from the input stream.  If reading encounters an immediate
     end-of-file, *note eof: 3094. is returned (the empty string (‘''’)
     in non-POSIX mode, and ‘None’ in POSIX mode).

 -- Method: shlex.push_token (str)

     Push the argument onto the token stack.

 -- Method: shlex.read_token ()

     Read a raw token.  Ignore the pushback stack, and do not interpret
     source requests.  (This is not ordinarily a useful entry point, and
     is documented here only for the sake of completeness.)

 -- Method: shlex.sourcehook (filename)

     When *note shlex: 56f. detects a source request (see *note source:
     3097. below) this method is given the following token as argument,
     and expected to return a tuple consisting of a filename and an open
     file-like object.

     Normally, this method first strips any quotes off the argument.  If
     the result is an absolute pathname, or there was no previous source
     request in effect, or the previous source was a stream (such as
     ‘sys.stdin’), the result is left alone.  Otherwise, if the result
     is a relative pathname, the directory part of the name of the file
     immediately before it on the source inclusion stack is prepended
     (this behavior is like the way the C preprocessor handles ‘#include
     "file.h"’).

     The result of the manipulations is treated as a filename, and
     returned as the first component of the tuple, with *note open():
     4e5. called on it to yield the second component.  (Note: this is
     the reverse of the order of arguments in instance initialization!)

     This hook is exposed so that you can use it to implement directory
     search paths, addition of file extensions, and other namespace
     hacks.  There is no corresponding ‘close’ hook, but a shlex
     instance will call the *note close(): f43. method of the sourced
     input stream when it returns EOF.

     For more explicit control of source stacking, use the *note
     push_source(): 3098. and *note pop_source(): 3099. methods.

 -- Method: shlex.push_source (newstream, newfile=None)

     Push an input source stream onto the input stack.  If the filename
     argument is specified it will later be available for use in error
     messages.  This is the same method used internally by the *note
     sourcehook(): 3096. method.

 -- Method: shlex.pop_source ()

     Pop the last-pushed input source from the input stack.  This is the
     same method used internally when the lexer reaches EOF on a stacked
     input stream.

 -- Method: shlex.error_leader (infile=None, lineno=None)

     This method generates an error message leader in the format of a
     Unix C compiler error label; the format is ‘'"%s", line %d: '’,
     where the ‘%s’ is replaced with the name of the current source file
     and the ‘%d’ with the current input line number (the optional
     arguments can be used to override these).

     This convenience is provided to encourage *note shlex: e8. users to
     generate error messages in the standard, parseable format
     understood by Emacs and other Unix tools.

Instances of *note shlex: 56f. subclasses have some public instance
variables which either control lexical analysis or can be used for
debugging:

 -- Attribute: shlex.commenters

     The string of characters that are recognized as comment beginners.
     All characters from the comment beginner to end of line are
     ignored.  Includes just ‘'#'’ by default.

 -- Attribute: shlex.wordchars

     The string of characters that will accumulate into multi-character
     tokens.  By default, includes all ASCII alphanumerics and
     underscore.  In POSIX mode, the accented characters in the Latin-1
     set are also included.  If *note punctuation_chars: ead. is not
     empty, the characters ‘~-./*?=’, which can appear in filename
     specifications and command line parameters, will also be included
     in this attribute, and any characters which appear in
     ‘punctuation_chars’ will be removed from ‘wordchars’ if they are
     present there.  If *note whitespace_split: 309b. is set to ‘True’,
     this will have no effect.

 -- Attribute: shlex.whitespace

     Characters that will be considered whitespace and skipped.
     Whitespace bounds tokens.  By default, includes space, tab,
     linefeed and carriage-return.

 -- Attribute: shlex.escape

     Characters that will be considered as escape.  This will be only
     used in POSIX mode, and includes just ‘'\'’ by default.

 -- Attribute: shlex.quotes

     Characters that will be considered string quotes.  The token
     accumulates until the same quote is encountered again (thus,
     different quote types protect each other as in the shell.)  By
     default, includes ASCII single and double quotes.

 -- Attribute: shlex.escapedquotes

     Characters in *note quotes: 309e. that will interpret escape
     characters defined in *note escape: 309d.  This is only used in
     POSIX mode, and includes just ‘'"'’ by default.

 -- Attribute: shlex.whitespace_split

     If ‘True’, tokens will only be split in whitespaces.  This is
     useful, for example, for parsing command lines with *note shlex:
     56f, getting tokens in a similar way to shell arguments.  When used
     in combination with *note punctuation_chars: ead, tokens will be
     split on whitespace in addition to those characters.

     Changed in version 3.8: The *note punctuation_chars: ead. attribute
     was made compatible with the *note whitespace_split: 309b.
     attribute.

 -- Attribute: shlex.infile

     The name of the current input file, as initially set at class
     instantiation time or stacked by later source requests.  It may be
     useful to examine this when constructing error messages.

 -- Attribute: shlex.instream

     The input stream from which this *note shlex: 56f. instance is
     reading characters.

 -- Attribute: shlex.source

     This attribute is ‘None’ by default.  If you assign a string to it,
     that string will be recognized as a lexical-level inclusion request
     similar to the ‘source’ keyword in various shells.  That is, the
     immediately following token will be opened as a filename and input
     will be taken from that stream until EOF, at which point the *note
     close(): f43. method of that stream will be called and the input
     source will again become the original input stream.  Source
     requests may be stacked any number of levels deep.

 -- Attribute: shlex.debug

     If this attribute is numeric and ‘1’ or more, a *note shlex: 56f.
     instance will print verbose progress output on its behavior.  If
     you need to use this, you can read the module source code to learn
     the details.

 -- Attribute: shlex.lineno

     Source line number (count of newlines seen so far plus one).

 -- Attribute: shlex.token

     The token buffer.  It may be useful to examine this when catching
     exceptions.

 -- Attribute: shlex.eof

     Token used to determine end of file.  This will be set to the empty
     string (‘''’), in non-POSIX mode, and to ‘None’ in POSIX mode.

 -- Attribute: shlex.punctuation_chars

     A read-only property.  Characters that will be considered
     punctuation.  Runs of punctuation characters will be returned as a
     single token.  However, note that no semantic validity checking
     will be performed: for example, ‘>>>’ could be returned as a token,
     even though it may not be recognised as such by shells.

     New in version 3.6.


File: python.info,  Node: Parsing Rules,  Next: Improved Compatibility with Shells,  Prev: shlex Objects,  Up: shlex — Simple lexical analysis

5.25.3.2 Parsing Rules
......................

When operating in non-POSIX mode, *note shlex: 56f. will try to obey to
the following rules.

   * Quote characters are not recognized within words (‘Do"Not"Separate’
     is parsed as the single word ‘Do"Not"Separate’);

   * Escape characters are not recognized;

   * Enclosing characters in quotes preserve the literal value of all
     characters within the quotes;

   * Closing quotes separate words (‘"Do"Separate’ is parsed as ‘"Do"’
     and ‘Separate’);

   * If *note whitespace_split: 309b. is ‘False’, any character not
     declared to be a word character, whitespace, or a quote will be
     returned as a single-character token.  If it is ‘True’, *note
     shlex: 56f. will only split words in whitespaces;

   * EOF is signaled with an empty string (‘''’);

   * It’s not possible to parse empty strings, even if quoted.

When operating in POSIX mode, *note shlex: 56f. will try to obey to the
following parsing rules.

   * Quotes are stripped out, and do not separate words
     (‘"Do"Not"Separate"’ is parsed as the single word ‘DoNotSeparate’);

   * Non-quoted escape characters (e.g.  ‘'\'’) preserve the literal
     value of the next character that follows;

   * Enclosing characters in quotes which are not part of *note
     escapedquotes: 309f. (e.g.  ‘"'"’) preserve the literal value of
     all characters within the quotes;

   * Enclosing characters in quotes which are part of *note
     escapedquotes: 309f. (e.g.  ‘'"'’) preserves the literal value of
     all characters within the quotes, with the exception of the
     characters mentioned in *note escape: 309d.  The escape characters
     retain its special meaning only when followed by the quote in use,
     or the escape character itself.  Otherwise the escape character
     will be considered a normal character.

   * EOF is signaled with a *note None: 157. value;

   * Quoted empty strings (‘''’) are allowed.


File: python.info,  Node: Improved Compatibility with Shells,  Prev: Parsing Rules,  Up: shlex — Simple lexical analysis

5.25.3.3 Improved Compatibility with Shells
...........................................

New in version 3.6.

The *note shlex: e8. class provides compatibility with the parsing
performed by common Unix shells like ‘bash’, ‘dash’, and ‘sh’.  To take
advantage of this compatibility, specify the ‘punctuation_chars’
argument in the constructor.  This defaults to ‘False’, which preserves
pre-3.6 behaviour.  However, if it is set to ‘True’, then parsing of the
characters ‘();<>|&’ is changed: any run of these characters is returned
as a single token.  While this is short of a full parser for shells
(which would be out of scope for the standard library, given the
multiplicity of shells out there), it does allow you to perform
processing of command lines more easily than you could otherwise.  To
illustrate, you can see the difference in the following snippet:

      >>> import shlex  >>> text = "a && b; c && d || e; f >'abc'; (def \"ghi\")"  >>> s = shlex.shlex(text, posix=True)  >>> s.whitespace_split = True  >>> list(s)  ['a', '&&', 'b;', 'c', '&&', 'd', '||', 'e;', 'f', '>abc;', '(def', 'ghi)']  >>> s = shlex.shlex(text, posix=True, punctuation_chars=True)  >>> s.whitespace_split = True  >>> list(s)  ['a', '&&', 'b', ';', 'c', '&&', 'd', '||', 'e', ';', 'f', '>', 'abc', ';',  '(', 'def', 'ghi', ')']

Of course, tokens will be returned which are not valid for shells, and
you’ll need to implement your own error checks on the returned tokens.

Instead of passing ‘True’ as the value for the punctuation_chars
parameter, you can pass a string with specific characters, which will be
used to determine which characters constitute punctuation.  For example:

     >>> import shlex >>> s = shlex.shlex("a && b || c", punctuation_chars="|") >>> list(s) ['a', '&', '&', 'b', '||', 'c']

     Note: When ‘punctuation_chars’ is specified, the *note wordchars:
     308f. attribute is augmented with the characters ‘~-./*?=’.  That
     is because these characters can appear in file names (including
     wildcards) and command-line arguments (e.g.  ‘--color=auto’).
     Hence:

          >>> import shlex >>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?', ...                 punctuation_chars=True) >>> list(s) ['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']

     However, to match the shell as closely as possible, it is
     recommended to always use ‘posix’ and *note whitespace_split: 309b.
     when using *note punctuation_chars: ead, which will negate *note
     wordchars: 308f. entirely.

For best effect, ‘punctuation_chars’ should be set in conjunction with
‘posix=True’.  (Note that ‘posix=False’ is the default for *note shlex:
56f.)


File: python.info,  Node: Graphical User Interfaces with Tk,  Next: Development Tools,  Prev: Program Frameworks,  Up: The Python Standard Library

5.26 Graphical User Interfaces with Tk
======================================

Tk/Tcl has long been an integral part of Python.  It provides a robust
and platform independent windowing toolkit, that is available to Python
programmers using the *note tkinter: 10c. package, and its extension,
the *note tkinter.tix: 10e. and the *note tkinter.ttk: 10f. modules.

The *note tkinter: 10c. package is a thin object-oriented layer on top
of Tcl/Tk.  To use *note tkinter: 10c, you don’t need to write Tcl code,
but you will need to consult the Tk documentation, and occasionally the
Tcl documentation.  *note tkinter: 10c. is a set of wrappers that
implement the Tk widgets as Python classes.  In addition, the internal
module ‘_tkinter’ provides a threadsafe mechanism which allows Python
and Tcl to interact.

*note tkinter: 10c.’s chief virtues are that it is fast, and that it
usually comes bundled with Python.  Although its standard documentation
is weak, good material is available, which includes: references,
tutorials, a book and others.  *note tkinter: 10c. is also famous for
having an outdated look and feel, which has been vastly improved in Tk
8.5.  Nevertheless, there are many other GUI libraries that you could be
interested in.  For more information about alternatives, see the *note
Other Graphical User Interface Packages: 30aa. section.

* Menu:

* tkinter — Python interface to Tcl/Tk::
* tkinter.ttk — Tk themed widgets: tkinter ttk — Tk themed widgets.
* tkinter.tix — Extension widgets for Tk: tkinter tix — Extension widgets for Tk.
* tkinter.scrolledtext — Scrolled Text Widget: tkinter scrolledtext — Scrolled Text Widget.
* IDLE: IDLE<41>.
* Other Graphical User Interface Packages::


File: python.info,  Node: tkinter — Python interface to Tcl/Tk,  Next: tkinter ttk — Tk themed widgets,  Up: Graphical User Interfaces with Tk

5.26.1 ‘tkinter’ — Python interface to Tcl/Tk
---------------------------------------------

`Source code:' Lib/tkinter/__init__.py(1)

__________________________________________________________________

The *note tkinter: 10c. package (“Tk interface”) is the standard Python
interface to the Tk GUI toolkit.  Both Tk and *note tkinter: 10c. are
available on most Unix platforms, as well as on Windows systems.  (Tk
itself is not part of Python; it is maintained at ActiveState.)

Running ‘python -m tkinter’ from the command line should open a window
demonstrating a simple Tk interface, letting you know that *note
tkinter: 10c. is properly installed on your system, and also showing
what version of Tcl/Tk is installed, so you can read the Tcl/Tk
documentation specific to that version.

See also
........

Tkinter documentation:

Python Tkinter Resources(2)

     The Python Tkinter Topic Guide provides a great deal of information
     on using Tk from Python and links to other sources of information
     on Tk.

TKDocs(3)

     Extensive tutorial plus friendlier widget pages for some of the
     widgets.

Tkinter 8.5 reference: a GUI for Python(4)

     On-line reference material.

Tkinter docs from effbot(5)

     Online reference for tkinter supported by effbot.org.

Programming Python(6)

     Book by Mark Lutz, has excellent coverage of Tkinter.

Modern Tkinter for Busy Python Developers(7)

     Book by Mark Roseman about building attractive and modern graphical
     user interfaces with Python and Tkinter.

Python and Tkinter Programming(8)

     Book by John Grayson (ISBN 1-884777-81-3).

Tcl/Tk documentation:

Tk commands(9)

     Most commands are available as *note tkinter: 10c. or *note
     tkinter.ttk: 10f. classes.  Change ‘8.6’ to match the version of
     your Tcl/Tk installation.

Tcl/Tk recent man pages(10)

     Recent Tcl/Tk manuals on www.tcl.tk.

ActiveState Tcl Home Page(11)

     The Tk/Tcl development is largely taking place at ActiveState.

Tcl and the Tk Toolkit(12)

     Book by John Ousterhout, the inventor of Tcl.

Practical Programming in Tcl and Tk(13)

     Brent Welch’s encyclopedic book.

* Menu:

* Tkinter Modules::
* Tkinter Life Preserver::
* A (Very) Quick Look at Tcl/Tk: A Very Quick Look at Tcl/Tk.
* Mapping Basic Tk into Tkinter::
* How Tk and Tkinter are Related::
* Handy Reference::
* File Handlers::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/tkinter/__init__.py

   (2) https://wiki.python.org/moin/TkInter

   (3) http://www.tkdocs.com/

   (4) 
https://web.archive.org/web/20190524140835/https://infohost.nmt.edu/tcc/help/pubs/tkinter/web/index.html

   (5) http://effbot.org/tkinterbook/

   (6) http://learning-python.com/about-pp4e.html

   (7) 
https://www.amazon.com/Modern-Tkinter-Python-Developers-ebook/dp/B0071QDNLO/

   (8) https://www.manning.com/books/python-and-tkinter-programming

   (9) https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm

   (10) https://www.tcl.tk/doc/

   (11) https://tcl.tk

   (12) https://www.amazon.com/exec/obidos/ASIN/020163337X

   (13) http://www.beedub.com/book/


File: python.info,  Node: Tkinter Modules,  Next: Tkinter Life Preserver,  Up: tkinter — Python interface to Tcl/Tk

5.26.1.1 Tkinter Modules
........................

Most of the time, *note tkinter: 10c. is all you really need, but a
number of additional modules are available as well.  The Tk interface is
located in a binary module named ‘_tkinter’.  This module contains the
low-level interface to Tk, and should never be used directly by
application programmers.  It is usually a shared library (or DLL), but
might in some cases be statically linked with the Python interpreter.

In addition to the Tk interface module, *note tkinter: 10c. includes a
number of Python modules, ‘tkinter.constants’ being one of the most
important.  Importing *note tkinter: 10c. will automatically import
‘tkinter.constants’, so, usually, to use Tkinter all you need is a
simple import statement:

     import tkinter

Or, more often:

     from tkinter import *

 -- Class: tkinter.Tk (screenName=None, baseName=None, className='Tk',
          useTk=1)

     The *note Tk: 30ae. class is instantiated without arguments.  This
     creates a toplevel widget of Tk which usually is the main window of
     an application.  Each instance has its own associated Tcl
     interpreter.

 -- Function: tkinter.Tcl (screenName=None, baseName=None,
          className='Tk', useTk=0)

     The *note Tcl(): 30af. function is a factory function which creates
     an object much like that created by the *note Tk: 30ae. class,
     except that it does not initialize the Tk subsystem.  This is most
     often useful when driving the Tcl interpreter in an environment
     where one doesn’t want to create extraneous toplevel windows, or
     where one cannot (such as Unix/Linux systems without an X server).
     An object created by the *note Tcl(): 30af. object can have a
     Toplevel window created (and the Tk subsystem initialized) by
     calling its ‘loadtk()’ method.

Other modules that provide Tk support include:

*note tkinter.scrolledtext: 10d.

     Text widget with a vertical scroll bar built in.

‘tkinter.colorchooser’

     Dialog to let the user choose a color.

‘tkinter.commondialog’

     Base class for the dialogs defined in the other modules listed
     here.

‘tkinter.filedialog’

     Common dialogs to allow the user to specify a file to open or save.

‘tkinter.font’

     Utilities to help work with fonts.

‘tkinter.messagebox’

     Access to standard Tk dialog boxes.

‘tkinter.simpledialog’

     Basic dialogs and convenience functions.

‘tkinter.dnd’

     Drag-and-drop support for *note tkinter: 10c.  This is experimental
     and should become deprecated when it is replaced with the Tk DND.

*note turtle: 116.

     Turtle graphics in a Tk window.


File: python.info,  Node: Tkinter Life Preserver,  Next: A Very Quick Look at Tcl/Tk,  Prev: Tkinter Modules,  Up: tkinter — Python interface to Tcl/Tk

5.26.1.2 Tkinter Life Preserver
...............................

This section is not designed to be an exhaustive tutorial on either Tk
or Tkinter.  Rather, it is intended as a stop gap, providing some
introductory orientation on the system.

Credits:

   * Tk was written by John Ousterhout while at Berkeley.

   * Tkinter was written by Steen Lumholt and Guido van Rossum.

   * This Life Preserver was written by Matt Conway at the University of
     Virginia.

   * The HTML rendering, and some liberal editing, was produced from a
     FrameMaker version by Ken Manheimer.

   * Fredrik Lundh elaborated and revised the class interface
     descriptions, to get them current with Tk 4.2.

   * Mike Clarkson converted the documentation to LaTeX, and compiled
     the User Interface chapter of the reference manual.

* Menu:

* How To Use This Section::
* A Simple Hello World Program::


File: python.info,  Node: How To Use This Section,  Next: A Simple Hello World Program,  Up: Tkinter Life Preserver

5.26.1.3 How To Use This Section
................................

This section is designed in two parts: the first half (roughly) covers
background material, while the second half can be taken to the keyboard
as a handy reference.

When trying to answer questions of the form “how do I do blah”, it is
often best to find out how to do “blah” in straight Tk, and then convert
this back into the corresponding *note tkinter: 10c. call.  Python
programmers can often guess at the correct Python command by looking at
the Tk documentation.  This means that in order to use Tkinter, you will
have to know a little bit about Tk.  This document can’t fulfill that
role, so the best we can do is point you to the best documentation that
exists.  Here are some hints:

   * The authors strongly suggest getting a copy of the Tk man pages.
     Specifically, the man pages in the ‘manN’ directory are most
     useful.  The ‘man3’ man pages describe the C interface to the Tk
     library and thus are not especially helpful for script writers.

   * Addison-Wesley publishes a book called Tcl and the Tk Toolkit by
     John Ousterhout (ISBN 0-201-63337-X) which is a good introduction
     to Tcl and Tk for the novice.  The book is not exhaustive, and for
     many details it defers to the man pages.

   * ‘tkinter/__init__.py’ is a last resort for most, but can be a good
     place to go when nothing else makes sense.


File: python.info,  Node: A Simple Hello World Program,  Prev: How To Use This Section,  Up: Tkinter Life Preserver

5.26.1.4 A Simple Hello World Program
.....................................

     import tkinter as tk  class Application(tk.Frame):     def __init__(self, master=None):         super().__init__(master)         self.master = master         self.pack()         self.create_widgets()      def create_widgets(self):         self.hi_there = tk.Button(self)         self.hi_there["text"] = "Hello World\n(click me)"         self.hi_there["command"] = self.say_hi         self.hi_there.pack(side="top")          self.quit = tk.Button(self, text="QUIT", fg="red",                               command=self.master.destroy)         self.quit.pack(side="bottom")      def say_hi(self):         print("hi there, everyone!")  root = tk.Tk() app = Application(master=root) app.mainloop()


File: python.info,  Node: A Very Quick Look at Tcl/Tk,  Next: Mapping Basic Tk into Tkinter,  Prev: Tkinter Life Preserver,  Up: tkinter — Python interface to Tcl/Tk

5.26.1.5 A (Very) Quick Look at Tcl/Tk
......................................

The class hierarchy looks complicated, but in actual practice,
application programmers almost always refer to the classes at the very
bottom of the hierarchy.

Notes:

   * These classes are provided for the purposes of organizing certain
     functions under one namespace.  They aren’t meant to be
     instantiated independently.

   * The *note Tk: 30ae. class is meant to be instantiated only once in
     an application.  Application programmers need not instantiate one
     explicitly, the system creates one whenever any of the other
     classes are instantiated.

   * The ‘Widget’ class is not meant to be instantiated, it is meant
     only for subclassing to make “real” widgets (in C++, this is called
     an ‘abstract class’).

To make use of this reference material, there will be times when you
will need to know how to read short passages of Tk and how to identify
the various parts of a Tk command.  (See section *note Mapping Basic Tk
into Tkinter: 30b4. for the *note tkinter: 10c. equivalents of what’s
below.)

Tk scripts are Tcl programs.  Like all Tcl programs, Tk scripts are just
lists of tokens separated by spaces.  A Tk widget is just its `class',
the `options' that help configure it, and the `actions' that make it do
useful things.

To make a widget in Tk, the command is always of the form:

     classCommand newPathname options

`classCommand'

     denotes which kind of widget to make (a button, a label, a menu…)

`newPathname'

     is the new name for this widget.  All names in Tk must be unique.
     To help enforce this, widgets in Tk are named with `pathnames',
     just like files in a file system.  The top level widget, the
     `root', is called ‘.’ (period) and children are delimited by more
     periods.  For example, ‘.myApp.controlPanel.okButton’ might be the
     name of a widget.

`options'

     configure the widget’s appearance and in some cases, its behavior.
     The options come in the form of a list of flags and values.  Flags
     are preceded by a ‘-‘, like Unix shell command flags, and values
     are put in quotes if they are more than one word.

For example:

     button   .fred   -fg red -text "hi there"    ^       ^     \______________________/    |       |                |  class    new            options command  widget  (-opt val -opt val ...)

Once created, the pathname to the widget becomes a new command.  This
new `widget command' is the programmer’s handle for getting the new
widget to perform some `action'.  In C, you’d express this as
someAction(fred, someOptions), in C++, you would express this as
fred.someAction(someOptions), and in Tk, you say:

     .fred someAction someOptions

Note that the object name, ‘.fred’, starts with a dot.

As you’d expect, the legal values for `someAction' will depend on the
widget’s class: ‘.fred disable’ works if fred is a button (fred gets
greyed out), but does not work if fred is a label (disabling of labels
is not supported in Tk).

The legal values of `someOptions' is action dependent.  Some actions,
like ‘disable’, require no arguments, others, like a text-entry box’s
‘delete’ command, would need arguments to specify what range of text to
delete.


File: python.info,  Node: Mapping Basic Tk into Tkinter,  Next: How Tk and Tkinter are Related,  Prev: A Very Quick Look at Tcl/Tk,  Up: tkinter — Python interface to Tcl/Tk

5.26.1.6 Mapping Basic Tk into Tkinter
......................................

Class commands in Tk correspond to class constructors in Tkinter.

     button .fred                =====>  fred = Button()

The master of an object is implicit in the new name given to it at
creation time.  In Tkinter, masters are specified explicitly.

     button .panel.fred          =====>  fred = Button(panel)

The configuration options in Tk are given in lists of hyphened tags
followed by values.  In Tkinter, options are specified as
keyword-arguments in the instance constructor, and keyword-args for
configure calls or as instance indices, in dictionary style, for
established instances.  See section *note Setting Options: 30b6. on
setting options.

     button .fred -fg red        =====>  fred = Button(panel, fg="red") .fred configure -fg red     =====>  fred["fg"] = red                             OR ==>  fred.config(fg="red")

In Tk, to perform an action on a widget, use the widget name as a
command, and follow it with an action name, possibly with arguments
(options).  In Tkinter, you call methods on the class instance to invoke
actions on the widget.  The actions (methods) that a given widget can
perform are listed in ‘tkinter/__init__.py’.

     .fred invoke                =====>  fred.invoke()

To give a widget to the packer (geometry manager), you call pack with
optional arguments.  In Tkinter, the Pack class holds all this
functionality, and the various forms of the pack command are implemented
as methods.  All widgets in *note tkinter: 10c. are subclassed from the
Packer, and so inherit all the packing methods.  See the *note
tkinter.tix: 10e. module documentation for additional information on the
Form geometry manager.

     pack .fred -side left       =====>  fred.pack(side="left")


File: python.info,  Node: How Tk and Tkinter are Related,  Next: Handy Reference,  Prev: Mapping Basic Tk into Tkinter,  Up: tkinter — Python interface to Tcl/Tk

5.26.1.7 How Tk and Tkinter are Related
.......................................

From the top down:

Your App Here (Python)

     A Python application makes a *note tkinter: 10c. call.

tkinter (Python Package)

     This call (say, for example, creating a button widget), is
     implemented in the *note tkinter: 10c. package, which is written in
     Python.  This Python function will parse the commands and the
     arguments and convert them into a form that makes them look as if
     they had come from a Tk script instead of a Python script.

_tkinter (C)

     These commands and their arguments will be passed to a C function
     in the ‘_tkinter’ - note the underscore - extension module.

Tk Widgets (C and Tcl)

     This C function is able to make calls into other C modules,
     including the C functions that make up the Tk library.  Tk is
     implemented in C and some Tcl.  The Tcl part of the Tk widgets is
     used to bind certain default behaviors to widgets, and is executed
     once at the point where the Python *note tkinter: 10c. package is
     imported.  (The user never sees this stage).

Tk (C)

     The Tk part of the Tk Widgets implement the final mapping to …

Xlib (C)

     the Xlib library to draw graphics on the screen.


File: python.info,  Node: Handy Reference,  Next: File Handlers,  Prev: How Tk and Tkinter are Related,  Up: tkinter — Python interface to Tcl/Tk

5.26.1.8 Handy Reference
........................

* Menu:

* Setting Options::
* The Packer::
* Packer Options::
* Coupling Widget Variables::
* The Window Manager::
* Tk Option Data Types::
* Bindings and Events::
* The index Parameter::
* Images::


File: python.info,  Node: Setting Options,  Next: The Packer,  Up: Handy Reference

5.26.1.9 Setting Options
........................

Options control things like the color and border width of a widget.
Options can be set in three ways:

At object creation time, using keyword arguments

          fred = Button(self, fg="red", bg="blue")

After object creation, treating the option name like a dictionary index

          fred["fg"] = "red" fred["bg"] = "blue"

Use the config() method to update multiple attrs subsequent to object creation

          fred.config(fg="red", bg="blue")

For a complete explanation of a given option and its behavior, see the
Tk man pages for the widget in question.

Note that the man pages list “STANDARD OPTIONS” and “WIDGET SPECIFIC
OPTIONS” for each widget.  The former is a list of options that are
common to many widgets, the latter are the options that are
idiosyncratic to that particular widget.  The Standard Options are
documented on the ‘options(3)’ man page.

No distinction between standard and widget-specific options is made in
this document.  Some options don’t apply to some kinds of widgets.
Whether a given widget responds to a particular option depends on the
class of the widget; buttons have a ‘command’ option, labels do not.

The options supported by a given widget are listed in that widget’s man
page, or can be queried at runtime by calling the ‘config()’ method
without arguments, or by calling the ‘keys()’ method on that widget.
The return value of these calls is a dictionary whose key is the name of
the option as a string (for example, ‘'relief'’) and whose values are
5-tuples.

Some options, like ‘bg’ are synonyms for common options with long names
(‘bg’ is shorthand for “background”).  Passing the ‘config()’ method the
name of a shorthand option will return a 2-tuple, not 5-tuple.  The
2-tuple passed back will contain the name of the synonym and the “real”
option (such as ‘('bg', 'background')’).

Index       Meaning                               Example
                                                  
---------------------------------------------------------------------
                                                  
0           option name                           ‘'relief'’
                                                  
                                                  
1           option name for database lookup       ‘'relief'’
                                                  
                                                  
2           option class for database lookup      ‘'Relief'’
                                                  
                                                  
3           default value                         ‘'raised'’
                                                  
                                                  
4           current value                         ‘'groove'’
                                                  

Example:

     >>> print(fred.config()) {'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')}

Of course, the dictionary printed will include all the options available
and their values.  This is meant only as an example.


File: python.info,  Node: The Packer,  Next: Packer Options,  Prev: Setting Options,  Up: Handy Reference

5.26.1.10 The Packer
....................

The packer is one of Tk’s geometry-management mechanisms.  Geometry
managers are used to specify the relative positioning of the positioning
of widgets within their container - their mutual `master'.  In contrast
to the more cumbersome `placer' (which is used less commonly, and we do
not cover here), the packer takes qualitative relationship specification
- `above', `to the left of', `filling', etc - and works everything out
to determine the exact placement coordinates for you.

The size of any `master' widget is determined by the size of the “slave
widgets” inside.  The packer is used to control where slave widgets
appear inside the master into which they are packed.  You can pack
widgets into frames, and frames into other frames, in order to achieve
the kind of layout you desire.  Additionally, the arrangement is
dynamically adjusted to accommodate incremental changes to the
configuration, once it is packed.

Note that widgets do not appear until they have had their geometry
specified with a geometry manager.  It’s a common early mistake to leave
out the geometry specification, and then be surprised when the widget is
created but nothing appears.  A widget will appear only after it has
had, for example, the packer’s ‘pack()’ method applied to it.

The pack() method can be called with keyword-option/value pairs that
control where the widget is to appear within its container, and how it
is to behave when the main application window is resized.  Here are some
examples:

     fred.pack()                     # defaults to side = "top" fred.pack(side="left") fred.pack(expand=1)


File: python.info,  Node: Packer Options,  Next: Coupling Widget Variables,  Prev: The Packer,  Up: Handy Reference

5.26.1.11 Packer Options
........................

For more extensive information on the packer and the options that it can
take, see the man pages and page 183 of John Ousterhout’s book.

anchor

     Anchor type.  Denotes where the packer is to place each slave in
     its parcel.

expand

     Boolean, ‘0’ or ‘1’.

fill

     Legal values: ‘'x'’, ‘'y'’, ‘'both'’, ‘'none'’.

ipadx and ipady

     A distance - designating internal padding on each side of the slave
     widget.

padx and pady

     A distance - designating external padding on each side of the slave
     widget.

side

     Legal values are: ‘'left'’, ‘'right'’, ‘'top'’, ‘'bottom'’.


File: python.info,  Node: Coupling Widget Variables,  Next: The Window Manager,  Prev: Packer Options,  Up: Handy Reference

5.26.1.12 Coupling Widget Variables
...................................

The current-value setting of some widgets (like text entry widgets) can
be connected directly to application variables by using special options.
These options are ‘variable’, ‘textvariable’, ‘onvalue’, ‘offvalue’, and
‘value’.  This connection works both ways: if the variable changes for
any reason, the widget it’s connected to will be updated to reflect the
new value.

Unfortunately, in the current implementation of *note tkinter: 10c. it
is not possible to hand over an arbitrary Python variable to a widget
through a ‘variable’ or ‘textvariable’ option.  The only kinds of
variables for which this works are variables that are subclassed from a
class called Variable, defined in *note tkinter: 10c.

There are many useful subclasses of Variable already defined:
‘StringVar’, ‘IntVar’, ‘DoubleVar’, and ‘BooleanVar’.  To read the
current value of such a variable, call the ‘get()’ method on it, and to
change its value you call the ‘set()’ method.  If you follow this
protocol, the widget will always track the value of the variable, with
no further intervention on your part.

For example:

     class App(Frame):     def __init__(self, master=None):         super().__init__(master)         self.pack()          self.entrythingy = Entry()         self.entrythingy.pack()          # here is the application variable         self.contents = StringVar()         # set it to some value         self.contents.set("this is a variable")         # tell the entry widget to watch this variable         self.entrythingy["textvariable"] = self.contents          # and here we get a callback when the user hits return.         # we will have the program print out the value of the         # application variable when the user hits return         self.entrythingy.bind('<Key-Return>',                               self.print_contents)      def print_contents(self, event):         print("hi. contents of entry is now ---->",               self.contents.get())


File: python.info,  Node: The Window Manager,  Next: Tk Option Data Types,  Prev: Coupling Widget Variables,  Up: Handy Reference

5.26.1.13 The Window Manager
............................

In Tk, there is a utility command, ‘wm’, for interacting with the window
manager.  Options to the ‘wm’ command allow you to control things like
titles, placement, icon bitmaps, and the like.  In *note tkinter: 10c,
these commands have been implemented as methods on the ‘Wm’ class.
Toplevel widgets are subclassed from the ‘Wm’ class, and so can call the
‘Wm’ methods directly.

To get at the toplevel window that contains a given widget, you can
often just refer to the widget’s master.  Of course if the widget has
been packed inside of a frame, the master won’t represent a toplevel
window.  To get at the toplevel window that contains an arbitrary
widget, you can call the ‘_root()’ method.  This method begins with an
underscore to denote the fact that this function is part of the
implementation, and not an interface to Tk functionality.

Here are some examples of typical usage:

     import tkinter as tk  class App(tk.Frame):     def __init__(self, master=None):         super().__init__(master)         self.pack()  # create the application myapp = App()  # # here are method calls to the window manager class # myapp.master.title("My Do-Nothing Application") myapp.master.maxsize(1000, 400)  # start the program myapp.mainloop()


File: python.info,  Node: Tk Option Data Types,  Next: Bindings and Events,  Prev: The Window Manager,  Up: Handy Reference

5.26.1.14 Tk Option Data Types
..............................

anchor

     Legal values are points of the compass: ‘"n"’, ‘"ne"’, ‘"e"’,
     ‘"se"’, ‘"s"’, ‘"sw"’, ‘"w"’, ‘"nw"’, and also ‘"center"’.

bitmap

     There are eight built-in, named bitmaps: ‘'error'’, ‘'gray25'’,
     ‘'gray50'’, ‘'hourglass'’, ‘'info'’, ‘'questhead'’, ‘'question'’,
     ‘'warning'’.  To specify an X bitmap filename, give the full path
     to the file, preceded with an ‘@’, as in
     ‘"@/usr/contrib/bitmap/gumby.bit"’.

boolean

     You can pass integers 0 or 1 or the strings ‘"yes"’ or ‘"no"’.

callback

     This is any Python function that takes no arguments.  For example:

          def print_it():     print("hi there") fred["command"] = print_it

color

     Colors can be given as the names of X colors in the rgb.txt file,
     or as strings representing RGB values in 4 bit: ‘"#RGB"’, 8 bit:
     ‘"#RRGGBB"’, 12 bit” ‘"#RRRGGGBBB"’, or 16 bit ‘"#RRRRGGGGBBBB"’
     ranges, where R,G,B here represent any legal hex digit.  See page
     160 of Ousterhout’s book for details.

cursor

     The standard X cursor names from ‘cursorfont.h’ can be used,
     without the ‘XC_’ prefix.  For example to get a hand cursor
     (‘XC_hand2’), use the string ‘"hand2"’.  You can also specify a
     bitmap and mask file of your own.  See page 179 of Ousterhout’s
     book.

distance

     Screen distances can be specified in either pixels or absolute
     distances.  Pixels are given as numbers and absolute distances as
     strings, with the trailing character denoting units: ‘c’ for
     centimetres, ‘i’ for inches, ‘m’ for millimetres, ‘p’ for printer’s
     points.  For example, 3.5 inches is expressed as ‘"3.5i"’.

font

     Tk uses a list font name format, such as ‘{courier 10 bold}’.  Font
     sizes with positive numbers are measured in points; sizes with
     negative numbers are measured in pixels.

geometry

     This is a string of the form ‘widthxheight’, where width and height
     are measured in pixels for most widgets (in characters for widgets
     displaying text).  For example: ‘fred["geometry"] = "200x100"’.

justify

     Legal values are the strings: ‘"left"’, ‘"center"’, ‘"right"’, and
     ‘"fill"’.

region

     This is a string with four space-delimited elements, each of which
     is a legal distance (see above).  For example: ‘"2 3 4 5"’ and ‘"3i
     2i 4.5i 2i"’ and ‘"3c 2c 4c 10.43c"’ are all legal regions.

relief

     Determines what the border style of a widget will be.  Legal values
     are: ‘"raised"’, ‘"sunken"’, ‘"flat"’, ‘"groove"’, and ‘"ridge"’.

scrollcommand

     This is almost always the ‘set()’ method of some scrollbar widget,
     but can be any widget method that takes a single argument.

wrap:

     Must be one of: ‘"none"’, ‘"char"’, or ‘"word"’.


File: python.info,  Node: Bindings and Events,  Next: The index Parameter,  Prev: Tk Option Data Types,  Up: Handy Reference

5.26.1.15 Bindings and Events
.............................

The bind method from the widget command allows you to watch for certain
events and to have a callback function trigger when that event type
occurs.  The form of the bind method is:

     def bind(self, sequence, func, add=''):

where:

sequence

     is a string that denotes the target kind of event.  (See the bind
     man page and page 201 of John Ousterhout’s book for details).

func

     is a Python function, taking one argument, to be invoked when the
     event occurs.  An Event instance will be passed as the argument.
     (Functions deployed this way are commonly known as `callbacks'.)

add

     is optional, either ‘''’ or ‘'+'’.  Passing an empty string denotes
     that this binding is to replace any other bindings that this event
     is associated with.  Passing a ‘'+'’ means that this function is to
     be added to the list of functions bound to this event type.

For example:

     def turn_red(self, event):     event.widget["activeforeground"] = "red"  self.button.bind("<Enter>", self.turn_red)

Notice how the widget field of the event is being accessed in the
‘turn_red()’ callback.  This field contains the widget that caught the X
event.  The following table lists the other event fields you can access,
and how they are denoted in Tk, which can be useful when referring to
the Tk man pages.

Tk       Tkinter Event Field       Tk       Tkinter Event Field
                                            
----------------------------------------------------------------------
                                            
%f       focus                     %A       char
                                            
                                            
%h       height                    %E       send_event
                                            
                                            
%k       keycode                   %K       keysym
                                            
                                            
%s       state                     %N       keysym_num
                                            
                                            
%t       time                      %T       type
                                            
                                            
%w       width                     %W       widget
                                            
                                            
%x       x                         %X       x_root
                                            
                                            
%y       y                         %Y       y_root
                                            


File: python.info,  Node: The index Parameter,  Next: Images,  Prev: Bindings and Events,  Up: Handy Reference

5.26.1.16 The index Parameter
.............................

A number of widgets require “index” parameters to be passed.  These are
used to point at a specific place in a Text widget, or to particular
characters in an Entry widget, or to particular menu items in a Menu
widget.

Entry widget indexes (index, view index, etc.)

     Entry widgets have options that refer to character positions in the
     text being displayed.  You can use these *note tkinter: 10c.
     functions to access these special points in text widgets:

Text widget indexes

     The index notation for Text widgets is very rich and is best
     described in the Tk man pages.

Menu indexes (menu.invoke(), menu.entryconfig(), etc.)

     Some options and methods for menus manipulate specific menu
     entries.  Anytime a menu index is needed for an option or a
     parameter, you may pass in:

        * an integer which refers to the numeric position of the entry
          in the widget, counted from the top, starting with 0;

        * the string ‘"active"’, which refers to the menu position that
          is currently under the cursor;

        * the string ‘"last"’ which refers to the last menu item;

        * An integer preceded by ‘@’, as in ‘@6’, where the integer is
          interpreted as a y pixel coordinate in the menu’s coordinate
          system;

        * the string ‘"none"’, which indicates no menu entry at all,
          most often used with menu.activate() to deactivate all
          entries, and finally,

        * a text string that is pattern matched against the label of the
          menu entry, as scanned from the top of the menu to the bottom.
          Note that this index type is considered after all the others,
          which means that matches for menu items labelled ‘last’,
          ‘active’, or ‘none’ may be interpreted as the above literals,
          instead.


File: python.info,  Node: Images,  Prev: The index Parameter,  Up: Handy Reference

5.26.1.17 Images
................

Images of different formats can be created through the corresponding
subclass of ‘tkinter.Image’:

   * ‘BitmapImage’ for images in XBM format.

   * ‘PhotoImage’ for images in PGM, PPM, GIF and PNG formats.  The
     latter is supported starting with Tk 8.6.

Either type of image is created through either the ‘file’ or the ‘data’
option (other options are available as well).

The image object can then be used wherever an ‘image’ option is
supported by some widget (e.g.  labels, buttons, menus).  In these
cases, Tk will not keep a reference to the image.  When the last Python
reference to the image object is deleted, the image data is deleted as
well, and Tk will display an empty box wherever the image was used.

See also
........

The Pillow(1) package adds support for formats such as BMP, JPEG, TIFF,
and WebP, among others.

   ---------- Footnotes ----------

   (1) http://python-pillow.org/


File: python.info,  Node: File Handlers,  Prev: Handy Reference,  Up: tkinter — Python interface to Tcl/Tk

5.26.1.18 File Handlers
.......................

Tk allows you to register and unregister a callback function which will
be called from the Tk mainloop when I/O is possible on a file
descriptor.  Only one handler may be registered per file descriptor.
Example code:

     import tkinter widget = tkinter.Tk() mask = tkinter.READABLE | tkinter.WRITABLE widget.tk.createfilehandler(file, mask, callback) ... widget.tk.deletefilehandler(file)

This feature is not available on Windows.

Since you don’t know how many bytes are available for reading, you may
not want to use the *note BufferedIOBase: 57d. or *note TextIOBase: c2c.
*note read(): 1c91. or *note readline(): 163f. methods, since these will
insist on reading a predefined number of bytes.  For sockets, the *note
recv(): 66b. or *note recvfrom(): 66c. methods will work fine; for other
files, use raw reads or ‘os.read(file.fileno(), maxbytecount)’.

 -- Method: Widget.tk.createfilehandler (file, mask, func)

     Registers the file handler callback function `func'.  The `file'
     argument may either be an object with a *note fileno(): 1e46.
     method (such as a file or socket object), or an integer file
     descriptor.  The `mask' argument is an ORed combination of any of
     the three constants below.  The callback is called as follows:

          callback(file, mask)

 -- Method: Widget.tk.deletefilehandler (file)

     Unregisters a file handler.

 -- Data: tkinter.READABLE
 -- Data: tkinter.WRITABLE
 -- Data: tkinter.EXCEPTION

     Constants used in the `mask' arguments.


File: python.info,  Node: tkinter ttk — Tk themed widgets,  Next: tkinter tix — Extension widgets for Tk,  Prev: tkinter — Python interface to Tcl/Tk,  Up: Graphical User Interfaces with Tk

5.26.2 ‘tkinter.ttk’ — Tk themed widgets
----------------------------------------

`Source code:' Lib/tkinter/ttk.py(1)

__________________________________________________________________

The *note tkinter.ttk: 10f. module provides access to the Tk themed
widget set, introduced in Tk 8.5.  If Python has not been compiled
against Tk 8.5, this module can still be accessed if `Tile' has been
installed.  The former method using Tk 8.5 provides additional benefits
including anti-aliased font rendering under X11 and window transparency
(requiring a composition window manager on X11).

The basic idea for *note tkinter.ttk: 10f. is to separate, to the extent
possible, the code implementing a widget’s behavior from the code
implementing its appearance.

See also
........

Tk Widget Styling Support(2)

     A document introducing theming support for Tk

* Menu:

* Using Ttk::
* Ttk Widgets::
* Widget::
* Combobox::
* Spinbox::
* Notebook::
* Progressbar::
* Separator::
* Sizegrip::
* Treeview::
* Ttk Styling::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tkinter/ttk.py

   (2) https://core.tcl.tk/tips/doc/trunk/tip/48.md


File: python.info,  Node: Using Ttk,  Next: Ttk Widgets,  Up: tkinter ttk — Tk themed widgets

5.26.2.1 Using Ttk
..................

To start using Ttk, import its module:

     from tkinter import ttk

To override the basic Tk widgets, the import should follow the Tk
import:

     from tkinter import * from tkinter.ttk import *

That code causes several *note tkinter.ttk: 10f. widgets (‘Button’,
‘Checkbutton’, ‘Entry’, ‘Frame’, ‘Label’, ‘LabelFrame’, ‘Menubutton’,
‘PanedWindow’, ‘Radiobutton’, ‘Scale’ and ‘Scrollbar’) to automatically
replace the Tk widgets.

This has the direct benefit of using the new widgets which gives a
better look and feel across platforms; however, the replacement widgets
are not completely compatible.  The main difference is that widget
options such as “fg”, “bg” and others related to widget styling are no
longer present in Ttk widgets.  Instead, use the ‘ttk.Style’ class for
improved styling effects.

See also
........

Converting existing applications to use Tile widgets(1)

     A monograph (using Tcl terminology) about differences typically
     encountered when moving applications to use the new widgets.

   ---------- Footnotes ----------

   (1) http://tktable.sourceforge.net/tile/doc/converting.txt


File: python.info,  Node: Ttk Widgets,  Next: Widget,  Prev: Using Ttk,  Up: tkinter ttk — Tk themed widgets

5.26.2.2 Ttk Widgets
....................

Ttk comes with 18 widgets, twelve of which already existed in tkinter:
‘Button’, ‘Checkbutton’, ‘Entry’, ‘Frame’, ‘Label’, ‘LabelFrame’,
‘Menubutton’, ‘PanedWindow’, ‘Radiobutton’, ‘Scale’, ‘Scrollbar’, and
*note Spinbox: 3f2.  The other six are new: *note Combobox: 30cd, *note
Notebook: 30ce, *note Progressbar: 30cf, ‘Separator’, ‘Sizegrip’ and
*note Treeview: 2bb.  And all them are subclasses of *note Widget: 30d0.

Using the Ttk widgets gives the application an improved look and feel.
As discussed above, there are differences in how the styling is coded.

Tk code:

     l1 = tkinter.Label(text="Test", fg="black", bg="white") l2 = tkinter.Label(text="Test", fg="black", bg="white")

Ttk code:

     style = ttk.Style() style.configure("BW.TLabel", foreground="black", background="white")  l1 = ttk.Label(text="Test", style="BW.TLabel") l2 = ttk.Label(text="Test", style="BW.TLabel")

For more information about *note TtkStyling: 30d1, see the *note Style:
30d2. class documentation.


File: python.info,  Node: Widget,  Next: Combobox,  Prev: Ttk Widgets,  Up: tkinter ttk — Tk themed widgets

5.26.2.3 Widget
...............

‘ttk.Widget’ defines standard options and methods supported by Tk themed
widgets and is not supposed to be directly instantiated.

* Menu:

* Standard Options::
* Scrollable Widget Options::
* Label Options::
* Compatibility Options::
* Widget States::
* ttk.Widget: ttk Widget.


File: python.info,  Node: Standard Options,  Next: Scrollable Widget Options,  Up: Widget

5.26.2.4 Standard Options
.........................

All the ‘ttk’ Widgets accepts the following options:

     Option          Description
                     
     -----------------------------------------------------------------------------------
                     
     class           Specifies the window class.  The class is used when querying the
                     option database for the window’s other options, to determine the
                     default bindtags for the window, and to select the widget’s
                     default layout and style.  This option is read-only, and may
                     only be specified when the window is created.
                     
                     
     cursor          Specifies the mouse cursor to be used for the widget.  If set to
                     the empty string (the default), the cursor is inherited for the
                     parent widget.
                     
                     
     takefocus       Determines whether the window accepts the focus during keyboard
                     traversal.  0, 1 or an empty string is returned.  If 0 is
                     returned, it means that the window should be skipped entirely
                     during keyboard traversal.  If 1, it means that the window
                     should receive the input focus as long as it is viewable.  And
                     an empty string means that the traversal scripts make the
                     decision about whether or not to focus on the window.
                     
                     
     style           May be used to specify a custom widget style.
                     


File: python.info,  Node: Scrollable Widget Options,  Next: Label Options,  Prev: Standard Options,  Up: Widget

5.26.2.5 Scrollable Widget Options
..................................

The following options are supported by widgets that are controlled by a
scrollbar.

     Option               Description
                          
     -----------------------------------------------------------------------------------
                          
     xscrollcommand       Used to communicate with horizontal scrollbars.
                          
                          When the view in the widget’s window change, the widget
                          will generate a Tcl command based on the scrollcommand.
                          
                          Usually this option consists of the method
                          ‘Scrollbar.set()’ of some scrollbar.  This will cause the
                          scrollbar to be updated whenever the view in the window
                          changes.
                          
                          
     yscrollcommand       Used to communicate with vertical scrollbars.  For some
                          more information, see above.
                          


File: python.info,  Node: Label Options,  Next: Compatibility Options,  Prev: Scrollable Widget Options,  Up: Widget

5.26.2.6 Label Options
......................

The following options are supported by labels, buttons and other
button-like widgets.

     Option             Description
                        
     -----------------------------------------------------------------------------------
                        
     text               Specifies a text string to be displayed inside the widget.
                        
                        
     textvariable       Specifies a name whose value will be used in place of the
                        text option resource.
                        
                        
     underline          If set, specifies the index (0-based) of a character to
                        underline in the text string.  The underline character is
                        used for mnemonic activation.
                        
                        
     image              Specifies an image to display.  This is a list of 1 or more
                        elements.  The first element is the default image name.  The
                        rest of the list if a sequence of statespec/value pairs as
                        defined by *note Style.map(): 30d7, specifying different
                        images to use when the widget is in a particular state or a
                        combination of states.  All images in the list should have
                        the same size.
                        
                        
     compound           Specifies how to display the image relative to the text, in
                        the case both text and images options are present.  Valid
                        values are:
                        
                           * text: display text only
                        
                           * image: display image only
                        
                           * top, bottom, left, right: display image above, below,
                             left of, or right of the text, respectively.
                        
                           * none: the default.  display the image if present,
                             otherwise the text.
                        
                        
     width              If greater than zero, specifies how much space, in character
                        widths, to allocate for the text label, if less than zero,
                        specifies a minimum width.  If zero or unspecified, the
                        natural width of the text label is used.
                        


File: python.info,  Node: Compatibility Options,  Next: Widget States,  Prev: Label Options,  Up: Widget

5.26.2.7 Compatibility Options
..............................

     Option       Description
                  
     ----------------------------------------------------------------------------------
                  
     state        May be set to “normal” or “disabled” to control the “disabled”
                  state bit.  This is a write-only option: setting it changes the
                  widget state, but the *note Widget.state(): 30d9. method does not
                  affect this option.
                  


File: python.info,  Node: Widget States,  Next: ttk Widget,  Prev: Compatibility Options,  Up: Widget

5.26.2.8 Widget States
......................

The widget state is a bitmap of independent state flags.

     Flag             Description
                      
     -----------------------------------------------------------------------------------
                      
     active           The mouse cursor is over the widget and pressing a mouse button
                      will cause some action to occur
                      
                      
     disabled         Widget is disabled under program control
                      
                      
     focus            Widget has keyboard focus
                      
                      
     pressed          Widget is being pressed
                      
                      
     selected         “On”, “true”, or “current” for things like Checkbuttons and
                      radiobuttons
                      
                      
     background       Windows and Mac have a notion of an “active” or foreground
                      window.  The `background' state is set for widgets in a
                      background window, and cleared for those in the foreground
                      window
                      
                      
     readonly         Widget should not allow user modification
                      
                      
     alternate        A widget-specific alternate display format
                      
                      
     invalid          The widget’s value is invalid
                      

A state specification is a sequence of state names, optionally prefixed
with an exclamation point indicating that the bit is off.


File: python.info,  Node: ttk Widget,  Prev: Widget States,  Up: Widget

5.26.2.9 ttk.Widget
...................

Besides the methods described below, the ‘ttk.Widget’ supports the
methods ‘tkinter.Widget.cget()’ and ‘tkinter.Widget.configure()’.

 -- Class: tkinter.ttk.Widget

      -- Method: identify (x, y)

          Returns the name of the element at position `x' `y', or the
          empty string if the point does not lie within any element.

          `x' and `y' are pixel coordinates relative to the widget.

      -- Method: instate (statespec, callback=None, *args, **kw)

          Test the widget’s state.  If a callback is not specified,
          returns ‘True’ if the widget state matches `statespec' and
          ‘False’ otherwise.  If callback is specified then it is called
          with args if widget state matches `statespec'.

      -- Method: state (statespec=None)

          Modify or inquire widget state.  If `statespec' is specified,
          sets the widget state according to it and return a new
          `statespec' indicating which flags were changed.  If
          `statespec' is not specified, returns the currently-enabled
          state flags.

     `statespec' will usually be a list or a tuple.


File: python.info,  Node: Combobox,  Next: Spinbox,  Prev: Widget,  Up: tkinter ttk — Tk themed widgets

5.26.2.10 Combobox
..................

The ‘ttk.Combobox’ widget combines a text field with a pop-down list of
values.  This widget is a subclass of ‘Entry’.

Besides the methods inherited from *note Widget: 30d0.: ‘Widget.cget()’,
‘Widget.configure()’, *note Widget.identify(): 30dc, *note
Widget.instate(): 30dd. and *note Widget.state(): 30d9, and the
following inherited from ‘Entry’: ‘Entry.bbox()’, ‘Entry.delete()’,
‘Entry.icursor()’, ‘Entry.index()’, ‘Entry.insert()’,
‘Entry.selection()’, ‘Entry.xview()’, it has some other methods,
described at ‘ttk.Combobox’.

* Menu:

* Options::
* Virtual events::
* ttk.Combobox: ttk Combobox.


File: python.info,  Node: Options,  Next: Virtual events,  Up: Combobox

5.26.2.11 Options
.................

This widget accepts the following specific options:

     Option                Description
                           
     -----------------------------------------------------------------------------------
                           
     exportselection       Boolean value.  If set, the widget selection is linked to
                           the Window Manager selection (which can be returned by
                           invoking Misc.selection_get, for example).
                           
                           
     justify               Specifies how the text is aligned within the widget.  One
                           of “left”, “center”, or “right”.
                           
                           
     height                Specifies the height of the pop-down listbox, in rows.
                           
                           
     postcommand           A script (possibly registered with Misc.register) that is
                           called immediately before displaying the values.  It may
                           specify which values to display.
                           
                           
     state                 One of “normal”, “readonly”, or “disabled”.  In the
                           “readonly” state, the value may not be edited directly,
                           and the user can only selection of the values from the
                           dropdown list.  In the “normal” state, the text field is
                           directly editable.  In the “disabled” state, no
                           interaction is possible.
                           
                           
     textvariable          Specifies a name whose value is linked to the widget
                           value.  Whenever the value associated with that name
                           changes, the widget value is updated, and vice versa.  See
                           ‘tkinter.StringVar’.
                           
                           
     values                Specifies the list of values to display in the drop-down
                           listbox.
                           
                           
     width                 Specifies an integer value indicating the desired width of
                           the entry window, in average-size characters of the
                           widget’s font.
                           


File: python.info,  Node: Virtual events,  Next: ttk Combobox,  Prev: Options,  Up: Combobox

5.26.2.12 Virtual events
........................

The combobox widgets generates a `<<ComboboxSelected>>' virtual event
when the user selects an element from the list of values.


File: python.info,  Node: ttk Combobox,  Prev: Virtual events,  Up: Combobox

5.26.2.13 ttk.Combobox
......................

 -- Class: tkinter.ttk.Combobox

      -- Method: current (newindex=None)

          If `newindex' is specified, sets the combobox value to the
          element position `newindex'.  Otherwise, returns the index of
          the current value or -1 if the current value is not in the
          values list.

      -- Method: get ()

          Returns the current value of the combobox.

      -- Method: set (value)

          Sets the value of the combobox to `value'.


File: python.info,  Node: Spinbox,  Next: Notebook,  Prev: Combobox,  Up: tkinter ttk — Tk themed widgets

5.26.2.14 Spinbox
.................

The ‘ttk.Spinbox’ widget is a ‘ttk.Entry’ enhanced with increment and
decrement arrows.  It can be used for numbers or lists of string values.
This widget is a subclass of ‘Entry’.

Besides the methods inherited from *note Widget: 30d0.: ‘Widget.cget()’,
‘Widget.configure()’, *note Widget.identify(): 30dc, *note
Widget.instate(): 30dd. and *note Widget.state(): 30d9, and the
following inherited from ‘Entry’: ‘Entry.bbox()’, ‘Entry.delete()’,
‘Entry.icursor()’, ‘Entry.index()’, ‘Entry.insert()’, ‘Entry.xview()’,
it has some other methods, described at ‘ttk.Spinbox’.

* Menu:

* Options: Options<2>.
* Virtual events: Virtual events<2>.
* ttk.Spinbox: ttk Spinbox.


File: python.info,  Node: Options<2>,  Next: Virtual events<2>,  Up: Spinbox

5.26.2.15 Options
.................

This widget accepts the following specific options:

Option                     Description
                           
--------------------------------------------------------------------------------------
                           
from                       Float value.  If set, this is the minimum value to which
                           the decrement button will decrement.  Must be spelled as
                           ‘from_’ when used as an argument, since ‘from’ is a
                           Python keyword.
                           
                           
to                         Float value.  If set, this is the maximum value to which
                           the increment button will increment.
                           
                           
increment                  Float value.  Specifies the amount which the
                           increment/decrement buttons change the value.  Defaults
                           to 1.0.
                           
                           
values                     Sequence of string or float values.  If specified, the
                           increment/decrement buttons will cycle through the items
                           in this sequence rather than incrementing or
                           decrementing numbers.
                           
                           
wrap                       Boolean value.  If ‘True’, increment and decrement
                           buttons will cycle from the ‘to’ value to the ‘from’
                           value or the ‘from’ value to the ‘to’ value,
                           respectively.
                           
                           
format                     String value.  This specifies the format of numbers set
                           by the increment/decrement buttons.  It must be in the
                           form “%W.Pf”, where W is the padded width of the value,
                           P is the precision, and ‘%’ and ‘f’ are literal.
                           
                           
command                    Python callable.  Will be called with no arguments
                           whenever either of the increment or decrement buttons
                           are pressed.
                           


File: python.info,  Node: Virtual events<2>,  Next: ttk Spinbox,  Prev: Options<2>,  Up: Spinbox

5.26.2.16 Virtual events
........................

The spinbox widget generates an `<<Increment>>' virtual event when the
user presses <Up>, and a `<<Decrement>>' virtual event when the user
presses <Down>.


File: python.info,  Node: ttk Spinbox,  Prev: Virtual events<2>,  Up: Spinbox

5.26.2.17 ttk.Spinbox
.....................

 -- Class: tkinter.ttk.Spinbox

      -- Method: get ()

          Returns the current value of the spinbox.

      -- Method: set (value)

          Sets the value of the spinbox to `value'.


File: python.info,  Node: Notebook,  Next: Progressbar,  Prev: Spinbox,  Up: tkinter ttk — Tk themed widgets

5.26.2.18 Notebook
..................

Ttk Notebook widget manages a collection of windows and displays a
single one at a time.  Each child window is associated with a tab, which
the user may select to change the currently-displayed window.

* Menu:

* Options: Options<3>.
* Tab Options::
* Tab Identifiers::
* Virtual Events::
* ttk.Notebook: ttk Notebook.


File: python.info,  Node: Options<3>,  Next: Tab Options,  Up: Notebook

5.26.2.19 Options
.................

This widget accepts the following specific options:

     Option        Description
                   
     -----------------------------------------------------------------------------------
                   
     height        If present and greater than zero, specifies the desired height of
                   the pane area (not including internal padding or tabs).
                   Otherwise, the maximum height of all panes is used.
                   
                   
     padding       Specifies the amount of extra space to add around the outside of
                   the notebook.  The padding is a list up to four length
                   specifications left top right bottom.  If fewer than four elements
                   are specified, bottom defaults to top, right defaults to left, and
                   top defaults to left.
                   
                   
     width         If present and greater than zero, specified the desired width of
                   the pane area (not including internal padding).  Otherwise, the
                   maximum width of all panes is used.
                   


File: python.info,  Node: Tab Options,  Next: Tab Identifiers,  Prev: Options<3>,  Up: Notebook

5.26.2.20 Tab Options
.....................

There are also specific options for tabs:

     Option          Description
                     
     -----------------------------------------------------------------------------------
                     
     state           Either “normal”, “disabled” or “hidden”.  If “disabled”, then
                     the tab is not selectable.  If “hidden”, then the tab is not
                     shown.
                     
                     
     sticky          Specifies how the child window is positioned within the pane
                     area.  Value is a string containing zero or more of the
                     characters “n”, “s”, “e” or “w”.  Each letter refers to a side
                     (north, south, east or west) that the child window will stick
                     to, as per the ‘grid()’ geometry manager.
                     
                     
     padding         Specifies the amount of extra space to add between the notebook
                     and this pane.  Syntax is the same as for the option padding
                     used by this widget.
                     
                     
     text            Specifies a text to be displayed in the tab.
                     
                     
     image           Specifies an image to display in the tab.  See the option image
                     described in *note Widget: 30d0.
                     
                     
     compound        Specifies how to display the image relative to the text, in the
                     case both options text and image are present.  See
                     *note Label Options: 30d6. for legal values.
                     
                     
     underline       Specifies the index (0-based) of a character to underline in the
                     text string.  The underlined character is used for mnemonic
                     activation if *note Notebook.enable_traversal(): 30ee. is
                     called.
                     


File: python.info,  Node: Tab Identifiers,  Next: Virtual Events,  Prev: Tab Options,  Up: Notebook

5.26.2.21 Tab Identifiers
.........................

The tab_id present in several methods of ‘ttk.Notebook’ may take any of
the following forms:

   * An integer between zero and the number of tabs

   * The name of a child window

   * A positional specification of the form “@x,y”, which identifies the
     tab

   * The literal string “current”, which identifies the
     currently-selected tab

   * The literal string “end”, which returns the number of tabs (only
     valid for *note Notebook.index(): 30f0.)


File: python.info,  Node: Virtual Events,  Next: ttk Notebook,  Prev: Tab Identifiers,  Up: Notebook

5.26.2.22 Virtual Events
........................

This widget generates a `<<NotebookTabChanged>>' virtual event after a
new tab is selected.


File: python.info,  Node: ttk Notebook,  Prev: Virtual Events,  Up: Notebook

5.26.2.23 ttk.Notebook
......................

 -- Class: tkinter.ttk.Notebook

      -- Method: add (child, **kw)

          Adds a new tab to the notebook.

          If window is currently managed by the notebook but hidden, it
          is restored to its previous position.

          See *note Tab Options: 30ed. for the list of available
          options.

      -- Method: forget (tab_id)

          Removes the tab specified by `tab_id', unmaps and unmanages
          the associated window.

      -- Method: hide (tab_id)

          Hides the tab specified by `tab_id'.

          The tab will not be displayed, but the associated window
          remains managed by the notebook and its configuration
          remembered.  Hidden tabs may be restored with the *note add():
          30f3. command.

      -- Method: identify (x, y)

          Returns the name of the tab element at position `x', `y', or
          the empty string if none.

      -- Method: index (tab_id)

          Returns the numeric index of the tab specified by `tab_id', or
          the total number of tabs if `tab_id' is the string “end”.

      -- Method: insert (pos, child, **kw)

          Inserts a pane at the specified position.

          `pos' is either the string “end”, an integer index, or the
          name of a managed child.  If `child' is already managed by the
          notebook, moves it to the specified position.

          See *note Tab Options: 30ed. for the list of available
          options.

      -- Method: select (tab_id=None)

          Selects the specified `tab_id'.

          The associated child window will be displayed, and the
          previously-selected window (if different) is unmapped.  If
          `tab_id' is omitted, returns the widget name of the currently
          selected pane.

      -- Method: tab (tab_id, option=None, **kw)

          Query or modify the options of the specific `tab_id'.

          If `kw' is not given, returns a dictionary of the tab option
          values.  If `option' is specified, returns the value of that
          `option'.  Otherwise, sets the options to the corresponding
          values.

      -- Method: tabs ()

          Returns a list of windows managed by the notebook.

      -- Method: enable_traversal ()

          Enable keyboard traversal for a toplevel window containing
          this notebook.

          This will extend the bindings for the toplevel window
          containing the notebook as follows:

             * ‘Control-Tab’: selects the tab following the currently
               selected one.

             * ‘Shift-Control-Tab’: selects the tab preceding the
               currently selected one.

             * ‘Alt-K’: where `K' is the mnemonic (underlined) character
               of any tab, will select that tab.

          Multiple notebooks in a single toplevel may be enabled for
          traversal, including nested notebooks.  However, notebook
          traversal only works properly if all panes have the notebook
          they are in as master.


File: python.info,  Node: Progressbar,  Next: Separator,  Prev: Notebook,  Up: tkinter ttk — Tk themed widgets

5.26.2.24 Progressbar
.....................

The ‘ttk.Progressbar’ widget shows the status of a long-running
operation.  It can operate in two modes: 1) the determinate mode which
shows the amount completed relative to the total amount of work to be
done and 2) the indeterminate mode which provides an animated display to
let the user know that work is progressing.

* Menu:

* Options: Options<4>.
* ttk.Progressbar: ttk Progressbar.


File: python.info,  Node: Options<4>,  Next: ttk Progressbar,  Up: Progressbar

5.26.2.25 Options
.................

This widget accepts the following specific options:

     Option         Description
                    
     -----------------------------------------------------------------------------------
                    
     orient         One of “horizontal” or “vertical”.  Specifies the orientation of
                    the progress bar.
                    
                    
     length         Specifies the length of the long axis of the progress bar (width
                    if horizontal, height if vertical).
                    
                    
     mode           One of “determinate” or “indeterminate”.
                    
                    
     maximum        A number specifying the maximum value.  Defaults to 100.
                    
                    
     value          The current value of the progress bar.  In “determinate” mode,
                    this represents the amount of work completed.  In “indeterminate”
                    mode, it is interpreted as modulo `maximum'; that is, the
                    progress bar completes one “cycle” when its value increases by
                    `maximum'.
                    
                    
     variable       A name which is linked to the option value.  If specified, the
                    value of the progress bar is automatically set to the value of
                    this name whenever the latter is modified.
                    
                    
     phase          Read-only option.  The widget periodically increments the value
                    of this option whenever its value is greater than 0 and, in
                    determinate mode, less than maximum.  This option may be used by
                    the current theme to provide additional animation effects.
                    


File: python.info,  Node: ttk Progressbar,  Prev: Options<4>,  Up: Progressbar

5.26.2.26 ttk.Progressbar
.........................

 -- Class: tkinter.ttk.Progressbar

      -- Method: start (interval=None)

          Begin autoincrement mode: schedules a recurring timer event
          that calls *note Progressbar.step(): 30ff. every `interval'
          milliseconds.  If omitted, `interval' defaults to 50
          milliseconds.

      -- Method: step (amount=None)

          Increments the progress bar’s value by `amount'.

          `amount' defaults to 1.0 if omitted.

      -- Method: stop ()

          Stop autoincrement mode: cancels any recurring timer event
          initiated by *note Progressbar.start(): 30fe. for this
          progress bar.


File: python.info,  Node: Separator,  Next: Sizegrip,  Prev: Progressbar,  Up: tkinter ttk — Tk themed widgets

5.26.2.27 Separator
...................

The ‘ttk.Separator’ widget displays a horizontal or vertical separator
bar.

It has no other methods besides the ones inherited from ‘ttk.Widget’.

* Menu:

* Options: Options<5>.


File: python.info,  Node: Options<5>,  Up: Separator

5.26.2.28 Options
.................

This widget accepts the following specific option:

     Option       Description
                  
     ----------------------------------------------------------------------------------
                  
     orient       One of “horizontal” or “vertical”.  Specifies the orientation of
                  the separator.
                  


File: python.info,  Node: Sizegrip,  Next: Treeview,  Prev: Separator,  Up: tkinter ttk — Tk themed widgets

5.26.2.29 Sizegrip
..................

The ‘ttk.Sizegrip’ widget (also known as a grow box) allows the user to
resize the containing toplevel window by pressing and dragging the grip.

This widget has neither specific options nor specific methods, besides
the ones inherited from ‘ttk.Widget’.

* Menu:

* Platform-specific notes::
* Bugs::


File: python.info,  Node: Platform-specific notes,  Next: Bugs,  Up: Sizegrip

5.26.2.30 Platform-specific notes
.................................

   * On MacOS X, toplevel windows automatically include a built-in size
     grip by default.  Adding a ‘Sizegrip’ is harmless, since the
     built-in grip will just mask the widget.


File: python.info,  Node: Bugs,  Prev: Platform-specific notes,  Up: Sizegrip

5.26.2.31 Bugs
..............

   * If the containing toplevel’s position was specified relative to the
     right or bottom of the screen (e.g.  ….), the ‘Sizegrip’ widget
     will not resize the window.

   * This widget supports only “southeast” resizing.


File: python.info,  Node: Treeview,  Next: Ttk Styling,  Prev: Sizegrip,  Up: tkinter ttk — Tk themed widgets

5.26.2.32 Treeview
..................

The ‘ttk.Treeview’ widget displays a hierarchical collection of items.
Each item has a textual label, an optional image, and an optional list
of data values.  The data values are displayed in successive columns
after the tree label.

The order in which data values are displayed may be controlled by
setting the widget option ‘displaycolumns’.  The tree widget can also
display column headings.  Columns may be accessed by number or symbolic
names listed in the widget option columns.  See *note Column
Identifiers: 3107.

Each item is identified by a unique name.  The widget will generate item
IDs if they are not supplied by the caller.  There is a distinguished
root item, named ‘{}’.  The root item itself is not displayed; its
children appear at the top level of the hierarchy.

Each item also has a list of tags, which can be used to associate event
bindings with individual items and control the appearance of the item.

The Treeview widget supports horizontal and vertical scrolling,
according to the options described in *note Scrollable Widget Options:
30d5. and the methods *note Treeview.xview(): 3108. and *note
Treeview.yview(): 3109.

* Menu:

* Options: Options<6>.
* Item Options::
* Tag Options::
* Column Identifiers::
* Virtual Events: Virtual Events<2>.
* ttk.Treeview: ttk Treeview.


File: python.info,  Node: Options<6>,  Next: Item Options,  Up: Treeview

5.26.2.33 Options
.................

This widget accepts the following specific options:

     Option               Description
                          
     ----------------------------------------------------------------------------------
                          
     columns              A list of column identifiers, specifying the number of
                          columns and their names.
                          
                          
     displaycolumns       A list of column identifiers (either symbolic or integer
                          indices) specifying which data columns are displayed and
                          the order in which they appear, or the string “#all”.
                          
                          
     height               Specifies the number of rows which should be visible.
                          Note: the requested width is determined from the sum of
                          the column widths.
                          
                          
     padding              Specifies the internal padding for the widget.  The
                          padding is a list of up to four length specifications.
                          
                          
     selectmode           Controls how the built-in class bindings manage the
                          selection.  One of “extended”, “browse” or “none”.  If set
                          to “extended” (the default), multiple items may be
                          selected.  If “browse”, only a single item will be
                          selected at a time.  If “none”, the selection will not be
                          changed.
                          
                          Note that the application code and tag bindings can set
                          the selection however they wish, regardless of the value
                          of this option.
                          
                          
     show                 A list containing zero or more of the following values,
                          specifying which elements of the tree to display.
                          
                             * tree: display tree labels in column #0.
                          
                             * headings: display the heading row.
                          
                          The default is “tree headings”, i.e., show all elements.
                          
                          `Note': Column #0 always refers to the tree column, even
                          if show=”tree” is not specified.
                          


File: python.info,  Node: Item Options,  Next: Tag Options,  Prev: Options<6>,  Up: Treeview

5.26.2.34 Item Options
......................

The following item options may be specified for items in the insert and
item widget commands.

     Option       Description
                  
     ---------------------------------------------------------------------------------
                  
     text         The textual label to display for the item.
                  
                  
     image        A Tk Image, displayed to the left of the label.
                  
                  
     values       The list of values associated with the item.
                  
                  Each item should have the same number of values as the widget
                  option columns.  If there are fewer values than columns, the
                  remaining values are assumed empty.  If there are more values
                  than columns, the extra values are ignored.
                  
                  
     open         ‘True’/‘False’ value indicating whether the item’s children
                  should be displayed or hidden.
                  
                  
     tags         A list of tags associated with this item.
                  


File: python.info,  Node: Tag Options,  Next: Column Identifiers,  Prev: Item Options,  Up: Treeview

5.26.2.35 Tag Options
.....................

The following options may be specified on tags:

     Option           Description
                      
     ---------------------------------------------------------------------------------
                      
     foreground       Specifies the text foreground color.
                      
                      
     background       Specifies the cell or item background color.
                      
                      
     font             Specifies the font to use when drawing text.
                      
                      
     image            Specifies the item image, in case the item’s image option is
                      empty.
                      


File: python.info,  Node: Column Identifiers,  Next: Virtual Events<2>,  Prev: Tag Options,  Up: Treeview

5.26.2.36 Column Identifiers
............................

Column identifiers take any of the following forms:

   * A symbolic name from the list of columns option.

   * An integer n, specifying the nth data column.

   * A string of the form #n, where n is an integer, specifying the nth
     display column.

Notes:

   * Item’s option values may be displayed in a different order than the
     order in which they are stored.

   * Column #0 always refers to the tree column, even if show=”tree” is
     not specified.

A data column number is an index into an item’s option values list; a
display column number is the column number in the tree where the values
are displayed.  Tree labels are displayed in column #0.  If option
displaycolumns is not set, then data column n is displayed in column
#n+1.  Again, `column #0 always refers to the tree column'.


File: python.info,  Node: Virtual Events<2>,  Next: ttk Treeview,  Prev: Column Identifiers,  Up: Treeview

5.26.2.37 Virtual Events
........................

The Treeview widget generates the following virtual events.

     Event                    Description
                              
     --------------------------------------------------------------------------------
                              
     <<TreeviewSelect>>       Generated whenever the selection changes.
                              
                              
     <<TreeviewOpen>>         Generated just before settings the focus item to
                              open=True.
                              
                              
     <<TreeviewClose>>        Generated just after setting the focus item to
                              open=False.
                              

The *note Treeview.focus(): 310e. and *note Treeview.selection(): 2ba.
methods can be used to determine the affected item or items.


File: python.info,  Node: ttk Treeview,  Prev: Virtual Events<2>,  Up: Treeview

5.26.2.38 ttk.Treeview
......................

 -- Class: tkinter.ttk.Treeview

      -- Method: bbox (item, column=None)

          Returns the bounding box (relative to the treeview widget’s
          window) of the specified `item' in the form (x, y, width,
          height).

          If `column' is specified, returns the bounding box of that
          cell.  If the `item' is not visible (i.e., if it is a
          descendant of a closed item or is scrolled offscreen), returns
          an empty string.

      -- Method: get_children (item=None)

          Returns the list of children belonging to `item'.

          If `item' is not specified, returns root children.

      -- Method: set_children (item, *newchildren)

          Replaces `item'’s child with `newchildren'.

          Children present in `item' that are not present in
          `newchildren' are detached from the tree.  No items in
          `newchildren' may be an ancestor of `item'.  Note that not
          specifying `newchildren' results in detaching `item'’s
          children.

      -- Method: column (column, option=None, **kw)

          Query or modify the options for the specified `column'.

          If `kw' is not given, returns a dict of the column option
          values.  If `option' is specified then the value for that
          `option' is returned.  Otherwise, sets the options to the
          corresponding values.

          The valid options/values are:

             * 
               id

                    Returns the column name.  This is a read-only
                    option.

             * 
               anchor: One of the standard Tk anchor values.

                    Specifies how the text in this column should be
                    aligned with respect to the cell.

             * 
               minwidth: width

                    The minimum width of the column in pixels.  The
                    treeview widget will not make the column any smaller
                    than specified by this option when the widget is
                    resized or the user drags a column.

             * 
               stretch: ‘True’/‘False’

                    Specifies whether the column’s width should be
                    adjusted when the widget is resized.

             * 
               width: width

                    The width of the column in pixels.

          To configure the tree column, call this with column = “#0”

      -- Method: delete (*items)

          Delete all specified `items' and all their descendants.

          The root item may not be deleted.

      -- Method: detach (*items)

          Unlinks all of the specified `items' from the tree.

          The items and all of their descendants are still present, and
          may be reinserted at another point in the tree, but will not
          be displayed.

          The root item may not be detached.

      -- Method: exists (item)

          Returns ‘True’ if the specified `item' is present in the tree.

      -- Method: focus (item=None)

          If `item' is specified, sets the focus item to `item'.
          Otherwise, returns the current focus item, or ‘’ if there is
          none.

      -- Method: heading (column, option=None, **kw)

          Query or modify the heading options for the specified
          `column'.

          If `kw' is not given, returns a dict of the heading option
          values.  If `option' is specified then the value for that
          `option' is returned.  Otherwise, sets the options to the
          corresponding values.

          The valid options/values are:

             * 
               text: text

                    The text to display in the column heading.

             * 
               image: imageName

                    Specifies an image to display to the right of the
                    column heading.

             * 
               anchor: anchor

                    Specifies how the heading text should be aligned.
                    One of the standard Tk anchor values.

             * 
               command: callback

                    A callback to be invoked when the heading label is
                    pressed.

          To configure the tree column heading, call this with column =
          “#0”.

      -- Method: identify (component, x, y)

          Returns a description of the specified `component' under the
          point given by `x' and `y', or the empty string if no such
          `component' is present at that position.

      -- Method: identify_row (y)

          Returns the item ID of the item at position `y'.

      -- Method: identify_column (x)

          Returns the data column identifier of the cell at position
          `x'.

          The tree column has ID #0.

      -- Method: identify_region (x, y)

          Returns one of:

          region          meaning
                          
          -----------------------------------------------------------
                          
          heading         Tree heading area.
                          
                          
          separator       Space between two columns headings.
                          
                          
          tree            The tree area.
                          
                          
          cell            A data cell.
                          

          Availability: Tk 8.6.

      -- Method: identify_element (x, y)

          Returns the element at position `x', `y'.

          Availability: Tk 8.6.

      -- Method: index (item)

          Returns the integer index of `item' within its parent’s list
          of children.

      -- Method: insert (parent, index, iid=None, **kw)

          Creates a new item and returns the item identifier of the
          newly created item.

          `parent' is the item ID of the parent item, or the empty
          string to create a new top-level item.  `index' is an integer,
          or the value “end”, specifying where in the list of parent’s
          children to insert the new item.  If `index' is less than or
          equal to zero, the new node is inserted at the beginning; if
          `index' is greater than or equal to the current number of
          children, it is inserted at the end.  If `iid' is specified,
          it is used as the item identifier; `iid' must not already
          exist in the tree.  Otherwise, a new unique identifier is
          generated.

          See *note Item Options: 310b. for the list of available
          points.

      -- Method: item (item, option=None, **kw)

          Query or modify the options for the specified `item'.

          If no options are given, a dict with options/values for the
          item is returned.  If `option' is specified then the value for
          that option is returned.  Otherwise, sets the options to the
          corresponding values as given by `kw'.

      -- Method: move (item, parent, index)

          Moves `item' to position `index' in `parent'’s list of
          children.

          It is illegal to move an item under one of its descendants.
          If `index' is less than or equal to zero, `item' is moved to
          the beginning; if greater than or equal to the number of
          children, it is moved to the end.  If `item' was detached it
          is reattached.

      -- Method: next (item)

          Returns the identifier of `item'’s next sibling, or ‘’ if
          `item' is the last child of its parent.

      -- Method: parent (item)

          Returns the ID of the parent of `item', or ‘’ if `item' is at
          the top level of the hierarchy.

      -- Method: prev (item)

          Returns the identifier of `item'’s previous sibling, or ‘’ if
          `item' is the first child of its parent.

      -- Method: reattach (item, parent, index)

          An alias for *note Treeview.move(): 3120.

      -- Method: see (item)

          Ensure that `item' is visible.

          Sets all of `item'’s ancestors open option to ‘True’, and
          scrolls the widget if necessary so that `item' is within the
          visible portion of the tree.

      -- Method: selection ()

          Returns a tuple of selected items.

          Changed in version 3.8: ‘selection()’ no longer takes
          arguments.  For changing the selection state use the following
          selection methods.

      -- Method: selection_set (*items)

          `items' becomes the new selection.

          Changed in version 3.6: `items' can be passed as separate
          arguments, not just as a single tuple.

      -- Method: selection_add (*items)

          Add `items' to the selection.

          Changed in version 3.6: `items' can be passed as separate
          arguments, not just as a single tuple.

      -- Method: selection_remove (*items)

          Remove `items' from the selection.

          Changed in version 3.6: `items' can be passed as separate
          arguments, not just as a single tuple.

      -- Method: selection_toggle (*items)

          Toggle the selection state of each item in `items'.

          Changed in version 3.6: `items' can be passed as separate
          arguments, not just as a single tuple.

      -- Method: set (item, column=None, value=None)

          With one argument, returns a dictionary of column/value pairs
          for the specified `item'.  With two arguments, returns the
          current value of the specified `column'.  With three
          arguments, sets the value of given `column' in given `item' to
          the specified `value'.

      -- Method: tag_bind (tagname, sequence=None, callback=None)

          Bind a callback for the given event `sequence' to the tag
          `tagname'.  When an event is delivered to an item, the
          callbacks for each of the item’s tags option are called.

      -- Method: tag_configure (tagname, option=None, **kw)

          Query or modify the options for the specified `tagname'.

          If `kw' is not given, returns a dict of the option settings
          for `tagname'.  If `option' is specified, returns the value
          for that `option' for the specified `tagname'.  Otherwise,
          sets the options to the corresponding values for the given
          `tagname'.

      -- Method: tag_has (tagname, item=None)

          If `item' is specified, returns 1 or 0 depending on whether
          the specified `item' has the given `tagname'.  Otherwise,
          returns a list of all items that have the specified tag.

          Availability: Tk 8.6

      -- Method: xview (*args)

          Query or modify horizontal position of the treeview.

      -- Method: yview (*args)

          Query or modify vertical position of the treeview.


File: python.info,  Node: Ttk Styling,  Prev: Treeview,  Up: tkinter ttk — Tk themed widgets

5.26.2.39 Ttk Styling
.....................

Each widget in ‘ttk’ is assigned a style, which specifies the set of
elements making up the widget and how they are arranged, along with
dynamic and default settings for element options.  By default the style
name is the same as the widget’s class name, but it may be overridden by
the widget’s style option.  If you don’t know the class name of a
widget, use the method ‘Misc.winfo_class()’ (somewidget.winfo_class()).

See also
........

Tcl’2004 conference presentation(1)

     This document explains how the theme engine works

 -- Class: tkinter.ttk.Style

     This class is used to manipulate the style database.

      -- Method: configure (style, query_opt=None, **kw)

          Query or set the default value of the specified option(s) in
          `style'.

          Each key in `kw' is an option and each value is a string
          identifying the value for that option.

          For example, to change every default button to be a flat
          button with some padding and a different background color:

               from tkinter import ttk import tkinter  root = tkinter.Tk()  ttk.Style().configure("TButton", padding=6, relief="flat",    background="#ccc")  btn = ttk.Button(text="Sample") btn.pack()  root.mainloop()

      -- Method: map (style, query_opt=None, **kw)

          Query or sets dynamic values of the specified option(s) in
          `style'.

          Each key in `kw' is an option and each value should be a list
          or a tuple (usually) containing statespecs grouped in tuples,
          lists, or some other preference.  A statespec is a compound of
          one or more states and then a value.

          An example may make it more understandable:

               import tkinter from tkinter import ttk  root = tkinter.Tk()  style = ttk.Style() style.map("C.TButton",     foreground=[('pressed', 'red'), ('active', 'blue')],     background=[('pressed', '!disabled', 'black'), ('active', 'white')]     )  colored_btn = ttk.Button(text="Test", style="C.TButton").pack()  root.mainloop()

          Note that the order of the (states, value) sequences for an
          option does matter, if the order is changed to ‘[('active',
          'blue'), ('pressed', 'red')]’ in the foreground option, for
          example, the result would be a blue foreground when the widget
          were in active or pressed states.

      -- Method: lookup (style, option, state=None, default=None)

          Returns the value specified for `option' in `style'.

          If `state' is specified, it is expected to be a sequence of
          one or more states.  If the `default' argument is set, it is
          used as a fallback value in case no specification for option
          is found.

          To check what font a Button uses by default:

               from tkinter import ttk  print(ttk.Style().lookup("TButton", "font"))

      -- Method: layout (style, layoutspec=None)

          Define the widget layout for given `style'.  If `layoutspec'
          is omitted, return the layout specification for given style.

          `layoutspec', if specified, is expected to be a list or some
          other sequence type (excluding strings), where each item
          should be a tuple and the first item is the layout name and
          the second item should have the format described in *note
          Layouts: 3131.

          To understand the format, see the following example (it is not
          intended to do anything useful):

               from tkinter import ttk import tkinter  root = tkinter.Tk()  style = ttk.Style() style.layout("TMenubutton", [    ("Menubutton.background", None),    ("Menubutton.button", {"children":        [("Menubutton.focus", {"children":            [("Menubutton.padding", {"children":                [("Menubutton.label", {"side": "left", "expand": 1})]            })]        })]    }), ])  mbtn = ttk.Menubutton(text='Text') mbtn.pack() root.mainloop()

      -- Method: element_create (elementname, etype, *args, **kw)

          Create a new element in the current theme, of the given
          `etype' which is expected to be either “image”, “from” or
          “vsapi”.  The latter is only available in Tk 8.6a for Windows
          XP and Vista and is not described here.

          If “image” is used, `args' should contain the default image
          name followed by statespec/value pairs (this is the
          imagespec), and `kw' may have the following options:

                  * 
                    border=padding

                         padding is a list of up to four integers,
                         specifying the left, top, right, and bottom
                         borders, respectively.

                  * 
                    height=height

                         Specifies a minimum height for the element.  If
                         less than zero, the base image’s height is used
                         as a default.

                  * 
                    padding=padding

                         Specifies the element’s interior padding.
                         Defaults to border’s value if not specified.

                  * 
                    sticky=spec

                         Specifies how the image is placed within the
                         final parcel.  spec contains zero or more
                         characters “n”, “s”, “w”, or “e”.

                  * 
                    width=width

                         Specifies a minimum width for the element.  If
                         less than zero, the base image’s width is used
                         as a default.

          If “from” is used as the value of `etype', *note
          element_create(): 3132. will clone an existing element.
          `args' is expected to contain a themename, from which the
          element will be cloned, and optionally an element to clone
          from.  If this element to clone from is not specified, an
          empty element will be used.  `kw' is discarded.

      -- Method: element_names ()

          Returns the list of elements defined in the current theme.

      -- Method: element_options (elementname)

          Returns the list of `elementname'’s options.

      -- Method: theme_create (themename, parent=None, settings=None)

          Create a new theme.

          It is an error if `themename' already exists.  If `parent' is
          specified, the new theme will inherit styles, elements and
          layouts from the parent theme.  If `settings' are present they
          are expected to have the same syntax used for *note
          theme_settings(): 3136.

      -- Method: theme_settings (themename, settings)

          Temporarily sets the current theme to `themename', apply
          specified `settings' and then restore the previous theme.

          Each key in `settings' is a style and each value may contain
          the keys ‘configure’, ‘map’, ‘layout’ and ‘element create’ and
          they are expected to have the same format as specified by the
          methods *note Style.configure(): 312e, *note Style.map():
          30d7, *note Style.layout(): 3130. and *note
          Style.element_create(): 3132. respectively.

          As an example, let’s change the Combobox for the default theme
          a bit:

               from tkinter import ttk import tkinter  root = tkinter.Tk()  style = ttk.Style() style.theme_settings("default", {    "TCombobox": {        "configure": {"padding": 5},        "map": {            "background": [("active", "green2"),                           ("!disabled", "green4")],            "fieldbackground": [("!disabled", "green3")],            "foreground": [("focus", "OliveDrab1"),                           ("!disabled", "OliveDrab2")]        }    } })  combo = ttk.Combobox().pack()  root.mainloop()

      -- Method: theme_names ()

          Returns a list of all known themes.

      -- Method: theme_use (themename=None)

          If `themename' is not given, returns the theme in use.
          Otherwise, sets the current theme to `themename', refreshes
          all widgets and emits a <<ThemeChanged>> event.

* Menu:

* Layouts::

   ---------- Footnotes ----------

   (1) http://tktable.sourceforge.net/tile/tile-tcl2004.pdf


File: python.info,  Node: Layouts,  Up: Ttk Styling

5.26.2.40 Layouts
.................

A layout can be just ‘None’, if it takes no options, or a dict of
options specifying how to arrange the element.  The layout mechanism
uses a simplified version of the pack geometry manager: given an initial
cavity, each element is allocated a parcel.  Valid options/values are:

        * 
          side: whichside

               Specifies which side of the cavity to place the element;
               one of top, right, bottom or left.  If omitted, the
               element occupies the entire cavity.

        * 
          sticky: nswe

               Specifies where the element is placed inside its
               allocated parcel.

        * 
          unit: 0 or 1

               If set to 1, causes the element and all of its
               descendants to be treated as a single element for the
               purposes of *note Widget.identify(): 30dc. et al.  It’s
               used for things like scrollbar thumbs with grips.

        * 
          children: [sublayout… ]

               Specifies a list of elements to place inside the element.
               Each element is a tuple (or other sequence type) where
               the first item is the layout name, and the other is a
               *note Layout: 3131.


File: python.info,  Node: tkinter tix — Extension widgets for Tk,  Next: tkinter scrolledtext — Scrolled Text Widget,  Prev: tkinter ttk — Tk themed widgets,  Up: Graphical User Interfaces with Tk

5.26.3 ‘tkinter.tix’ — Extension widgets for Tk
-----------------------------------------------

`Source code:' Lib/tkinter/tix.py(1)

Deprecated since version 3.6: This Tk extension is unmaintained and
should not be used in new code.  Use *note tkinter.ttk: 10f. instead.

__________________________________________________________________

The *note tkinter.tix: 10e. (Tk Interface Extension) module provides an
additional rich set of widgets.  Although the standard Tk library has
many useful widgets, they are far from complete.  The *note tkinter.tix:
10e. library provides most of the commonly needed widgets that are
missing from standard Tk: *note HList: 313d, *note ComboBox: 313e, *note
Control: 313f. (a.k.a.  SpinBox) and an assortment of scrollable
widgets.  *note tkinter.tix: 10e. also includes many more widgets that
are generally useful in a wide range of applications: *note NoteBook:
3140, *note FileEntry: 3141, *note PanedWindow: 3142, etc; there are
more than 40 of them.

With all these new widgets, you can introduce new interaction techniques
into applications, creating more useful and more intuitive user
interfaces.  You can design your application by choosing the most
appropriate widgets to match the special needs of your application and
users.

See also
........

Tix Homepage(2)

     The home page for ‘Tix’.  This includes links to additional
     documentation and downloads.

Tix Man Pages(3)

     On-line version of the man pages and reference material.

Tix Programming Guide(4)

     On-line version of the programmer’s reference material.

Tix Development Applications(5)

     Tix applications for development of Tix and Tkinter programs.  Tide
     applications work under Tk or Tkinter, and include ‘TixInspect’, an
     inspector to remotely modify and debug Tix/Tk/Tkinter applications.

* Menu:

* Using Tix::
* Tix Widgets::
* Tix Commands::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tkinter/tix.py

   (2) http://tix.sourceforge.net/

   (3) http://tix.sourceforge.net/dist/current/man/

   (4) 
http://tix.sourceforge.net/dist/current/docs/tix-book/tix.book.html

   (5) http://tix.sourceforge.net/Tixapps/src/Tide.html


File: python.info,  Node: Using Tix,  Next: Tix Widgets,  Up: tkinter tix — Extension widgets for Tk

5.26.3.1 Using Tix
..................

 -- Class: tkinter.tix.Tk (screenName=None, baseName=None,
          className='Tix')

     Toplevel widget of Tix which represents mostly the main window of
     an application.  It has an associated Tcl interpreter.

     Classes in the *note tkinter.tix: 10e. module subclasses the
     classes in the *note tkinter: 10c.  The former imports the latter,
     so to use *note tkinter.tix: 10e. with Tkinter, all you need to do
     is to import one module.  In general, you can just import *note
     tkinter.tix: 10e, and replace the toplevel call to *note
     tkinter.Tk: 30ae. with ‘tix.Tk’:

          from tkinter import tix from tkinter.constants import * root = tix.Tk()

To use *note tkinter.tix: 10e, you must have the Tix widgets installed,
usually alongside your installation of the Tk widgets.  To test your
installation, try the following:

     from tkinter import tix root = tix.Tk() root.tk.eval('package require Tix')


File: python.info,  Node: Tix Widgets,  Next: Tix Commands,  Prev: Using Tix,  Up: tkinter tix — Extension widgets for Tk

5.26.3.2 Tix Widgets
....................

Tix(1) introduces over 40 widget classes to the *note tkinter: 10c.
repertoire.

* Menu:

* Basic Widgets::
* File Selectors::
* Hierarchical ListBox::
* Tabular ListBox::
* Manager Widgets::
* Image Types::
* Miscellaneous Widgets::
* Form Geometry Manager::

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/TixIntro.htm


File: python.info,  Node: Basic Widgets,  Next: File Selectors,  Up: Tix Widgets

5.26.3.3 Basic Widgets
......................

 -- Class: tkinter.tix.Balloon

     A Balloon(1) that pops up over a widget to provide help.  When the
     user moves the cursor inside a widget to which a Balloon widget has
     been bound, a small pop-up window with a descriptive message will
     be shown on the screen.

 -- Class: tkinter.tix.ButtonBox

     The ButtonBox(2) widget creates a box of buttons, such as is
     commonly used for ‘Ok Cancel’.

 -- Class: tkinter.tix.ComboBox

     The ComboBox(3) widget is similar to the combo box control in MS
     Windows.  The user can select a choice by either typing in the
     entry subwidget or selecting from the listbox subwidget.

 -- Class: tkinter.tix.Control

     The Control(4) widget is also known as the ‘SpinBox’ widget.  The
     user can adjust the value by pressing the two arrow buttons or by
     entering the value directly into the entry.  The new value will be
     checked against the user-defined upper and lower limits.

 -- Class: tkinter.tix.LabelEntry

     The LabelEntry(5) widget packages an entry widget and a label into
     one mega widget.  It can be used to simplify the creation of
     “entry-form” type of interface.

 -- Class: tkinter.tix.LabelFrame

     The LabelFrame(6) widget packages a frame widget and a label into
     one mega widget.  To create widgets inside a LabelFrame widget, one
     creates the new widgets relative to the ‘frame’ subwidget and
     manage them inside the ‘frame’ subwidget.

 -- Class: tkinter.tix.Meter

     The Meter(7) widget can be used to show the progress of a
     background job which may take a long time to execute.

 -- Class: tkinter.tix.OptionMenu

     The OptionMenu(8) creates a menu button of options.

 -- Class: tkinter.tix.PopupMenu

     The PopupMenu(9) widget can be used as a replacement of the
     ‘tk_popup’ command.  The advantage of the ‘Tix’ *note PopupMenu:
     314d. widget is it requires less application code to manipulate.

 -- Class: tkinter.tix.Select

     The Select(10) widget is a container of button subwidgets.  It can
     be used to provide radio-box or check-box style of selection
     options for the user.

 -- Class: tkinter.tix.StdButtonBox

     The StdButtonBox(11) widget is a group of standard buttons for
     Motif-like dialog boxes.

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixBalloon.htm

   (2) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixButtonBox.htm

   (3) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixComboBox.htm

   (4) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixControl.htm

   (5) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixLabelEntry.htm

   (6) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixLabelFrame.htm

   (7) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixMeter.htm

   (8) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixOptionMenu.htm

   (9) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixPopupMenu.htm

   (10) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixSelect.htm

   (11) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixStdButtonBox.htm


File: python.info,  Node: File Selectors,  Next: Hierarchical ListBox,  Prev: Basic Widgets,  Up: Tix Widgets

5.26.3.4 File Selectors
.......................

 -- Class: tkinter.tix.DirList

     The DirList(1) widget displays a list view of a directory, its
     previous directories and its sub-directories.  The user can choose
     one of the directories displayed in the list or change to another
     directory.

 -- Class: tkinter.tix.DirTree

     The DirTree(2) widget displays a tree view of a directory, its
     previous directories and its sub-directories.  The user can choose
     one of the directories displayed in the list or change to another
     directory.

 -- Class: tkinter.tix.DirSelectDialog

     The DirSelectDialog(3) widget presents the directories in the file
     system in a dialog window.  The user can use this dialog window to
     navigate through the file system to select the desired directory.

 -- Class: tkinter.tix.DirSelectBox

     The *note DirSelectBox: 3154. is similar to the standard Motif(TM)
     directory-selection box.  It is generally used for the user to
     choose a directory.  DirSelectBox stores the directories mostly
     recently selected into a ComboBox widget so that they can be
     quickly selected again.

 -- Class: tkinter.tix.ExFileSelectBox

     The ExFileSelectBox(4) widget is usually embedded in a
     tixExFileSelectDialog widget.  It provides a convenient method for
     the user to select files.  The style of the *note ExFileSelectBox:
     3155. widget is very similar to the standard file dialog on MS
     Windows 3.1.

 -- Class: tkinter.tix.FileSelectBox

     The FileSelectBox(5) is similar to the standard Motif(TM)
     file-selection box.  It is generally used for the user to choose a
     file.  FileSelectBox stores the files mostly recently selected into
     a *note ComboBox: 313e. widget so that they can be quickly selected
     again.

 -- Class: tkinter.tix.FileEntry

     The FileEntry(6) widget can be used to input a filename.  The user
     can type in the filename manually.  Alternatively, the user can
     press the button widget that sits next to the entry, which will
     bring up a file selection dialog.

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixDirList.htm

   (2) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixDirTree.htm

   (3) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixDirSelectDialog.htm

   (4) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixExFileSelectBox.htm

   (5) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixFileSelectBox.htm

   (6) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixFileEntry.htm


File: python.info,  Node: Hierarchical ListBox,  Next: Tabular ListBox,  Prev: File Selectors,  Up: Tix Widgets

5.26.3.5 Hierarchical ListBox
.............................

 -- Class: tkinter.tix.HList

     The HList(1) widget can be used to display any data that have a
     hierarchical structure, for example, file system directory trees.
     The list entries are indented and connected by branch lines
     according to their places in the hierarchy.

 -- Class: tkinter.tix.CheckList

     The CheckList(2) widget displays a list of items to be selected by
     the user.  CheckList acts similarly to the Tk checkbutton or
     radiobutton widgets, except it is capable of handling many more
     items than checkbuttons or radiobuttons.

 -- Class: tkinter.tix.Tree

     The Tree(3) widget can be used to display hierarchical data in a
     tree form.  The user can adjust the view of the tree by opening or
     closing parts of the tree.

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixHList.htm

   (2) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixCheckList.htm

   (3) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixTree.htm


File: python.info,  Node: Tabular ListBox,  Next: Manager Widgets,  Prev: Hierarchical ListBox,  Up: Tix Widgets

5.26.3.6 Tabular ListBox
........................

 -- Class: tkinter.tix.TList

     The TList(1) widget can be used to display data in a tabular
     format.  The list entries of a *note TList: 315b. widget are
     similar to the entries in the Tk listbox widget.  The main
     differences are (1) the *note TList: 315b. widget can display the
     list entries in a two dimensional format and (2) you can use
     graphical images as well as multiple colors and fonts for the list
     entries.

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixTList.htm


File: python.info,  Node: Manager Widgets,  Next: Image Types,  Prev: Tabular ListBox,  Up: Tix Widgets

5.26.3.7 Manager Widgets
........................

 -- Class: tkinter.tix.PanedWindow

     The PanedWindow(1) widget allows the user to interactively
     manipulate the sizes of several panes.  The panes can be arranged
     either vertically or horizontally.  The user changes the sizes of
     the panes by dragging the resize handle between two panes.

 -- Class: tkinter.tix.ListNoteBook

     The ListNoteBook(2) widget is very similar to the ‘TixNoteBook’
     widget: it can be used to display many windows in a limited space
     using a notebook metaphor.  The notebook is divided into a stack of
     pages (windows).  At one time only one of these pages can be shown.
     The user can navigate through these pages by choosing the name of
     the desired page in the ‘hlist’ subwidget.

 -- Class: tkinter.tix.NoteBook

     The NoteBook(3) widget can be used to display many windows in a
     limited space using a notebook metaphor.  The notebook is divided
     into a stack of pages.  At one time only one of these pages can be
     shown.  The user can navigate through these pages by choosing the
     visual “tabs” at the top of the NoteBook widget.

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixPanedWindow.htm

   (2) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixListNoteBook.htm

   (3) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixNoteBook.htm


File: python.info,  Node: Image Types,  Next: Miscellaneous Widgets,  Prev: Manager Widgets,  Up: Tix Widgets

5.26.3.8 Image Types
....................

The *note tkinter.tix: 10e. module adds:

   * pixmap(1) capabilities to all *note tkinter.tix: 10e. and *note
     tkinter: 10c. widgets to create color images from XPM files.

   * Compound(2) image types can be used to create images that consists
     of multiple horizontal lines; each line is composed of a series of
     items (texts, bitmaps, images or spaces) arranged from left to
     right.  For example, a compound image can be used to display a
     bitmap and a text string simultaneously in a Tk ‘Button’ widget.

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/pixmap.htm

   (2) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/compound.htm


File: python.info,  Node: Miscellaneous Widgets,  Next: Form Geometry Manager,  Prev: Image Types,  Up: Tix Widgets

5.26.3.9 Miscellaneous Widgets
..............................

 -- Class: tkinter.tix.InputOnly

     The InputOnly(1) widgets are to accept inputs from the user, which
     can be done with the ‘bind’ command (Unix only).

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixInputOnly.htm


File: python.info,  Node: Form Geometry Manager,  Prev: Miscellaneous Widgets,  Up: Tix Widgets

5.26.3.10 Form Geometry Manager
...............................

In addition, *note tkinter.tix: 10e. augments *note tkinter: 10c. by
providing:

 -- Class: tkinter.tix.Form

     The Form(1) geometry manager based on attachment rules for all Tk
     widgets.

   ---------- Footnotes ----------

   (1) 
http://tix.sourceforge.net/dist/current/man/html/TixCmd/tixForm.htm


File: python.info,  Node: Tix Commands,  Prev: Tix Widgets,  Up: tkinter tix — Extension widgets for Tk

5.26.3.11 Tix Commands
......................

 -- Class: tkinter.tix.tixCommand

     The tix commands(1) provide access to miscellaneous elements of
     ‘Tix’’s internal state and the ‘Tix’ application context.  Most of
     the information manipulated by these methods pertains to the
     application as a whole, or to a screen or display, rather than to a
     particular window.

     To view the current settings, the common usage is:

          from tkinter import tix root = tix.Tk() print(root.tix_configure())

 -- Method: tixCommand.tix_configure (cnf=None, **kw)

     Query or modify the configuration options of the Tix application
     context.  If no option is specified, returns a dictionary all of
     the available options.  If option is specified with no value, then
     the method returns a list describing the one named option (this
     list will be identical to the corresponding sublist of the value
     returned if no option is specified).  If one or more option-value
     pairs are specified, then the method modifies the given option(s)
     to have the given value(s); in this case the method returns an
     empty string.  Option may be any of the configuration options.

 -- Method: tixCommand.tix_cget (option)

     Returns the current value of the configuration option given by
     `option'.  Option may be any of the configuration options.

 -- Method: tixCommand.tix_getbitmap (name)

     Locates a bitmap file of the name ‘name.xpm’ or ‘name’ in one of
     the bitmap directories (see the *note tix_addbitmapdir(): 3168.
     method).  By using *note tix_getbitmap(): 3167, you can avoid hard
     coding the pathnames of the bitmap files in your application.  When
     successful, it returns the complete pathname of the bitmap file,
     prefixed with the character ‘@’.  The returned value can be used to
     configure the ‘bitmap’ option of the Tk and Tix widgets.

 -- Method: tixCommand.tix_addbitmapdir (directory)

     Tix maintains a list of directories under which the *note
     tix_getimage(): 3169. and *note tix_getbitmap(): 3167. methods will
     search for image files.  The standard bitmap directory is
     ‘$TIX_LIBRARY/bitmaps’.  The *note tix_addbitmapdir(): 3168. method
     adds `directory' into this list.  By using this method, the image
     files of an applications can also be located using the *note
     tix_getimage(): 3169. or *note tix_getbitmap(): 3167. method.

 -- Method: tixCommand.tix_filedialog ([dlgclass])

     Returns the file selection dialog that may be shared among
     different calls from this application.  This method will create a
     file selection dialog widget when it is called the first time.
     This dialog will be returned by all subsequent calls to *note
     tix_filedialog(): 316a.  An optional dlgclass parameter can be
     passed as a string to specified what type of file selection dialog
     widget is desired.  Possible options are ‘tix’, ‘FileSelectDialog’
     or ‘tixExFileSelectDialog’.

 -- Method: tixCommand.tix_getimage (self, name)

     Locates an image file of the name ‘name.xpm’, ‘name.xbm’ or
     ‘name.ppm’ in one of the bitmap directories (see the *note
     tix_addbitmapdir(): 3168. method above).  If more than one file
     with the same name (but different extensions) exist, then the image
     type is chosen according to the depth of the X display: xbm images
     are chosen on monochrome displays and color images are chosen on
     color displays.  By using *note tix_getimage(): 3169, you can avoid
     hard coding the pathnames of the image files in your application.
     When successful, this method returns the name of the newly created
     image, which can be used to configure the ‘image’ option of the Tk
     and Tix widgets.

 -- Method: tixCommand.tix_option_get (name)

     Gets the options maintained by the Tix scheme mechanism.

 -- Method: tixCommand.tix_resetoptions (newScheme, newFontSet[,
          newScmPrio])

     Resets the scheme and fontset of the Tix application to `newScheme'
     and `newFontSet', respectively.  This affects only those widgets
     created after this call.  Therefore, it is best to call the
     resetoptions method before the creation of any widgets in a Tix
     application.

     The optional parameter `newScmPrio' can be given to reset the
     priority level of the Tk options set by the Tix schemes.

     Because of the way Tk handles the X option database, after Tix has
     been has imported and inited, it is not possible to reset the color
     schemes and font sets using the ‘tix_config()’ method.  Instead,
     the *note tix_resetoptions(): 316c. method must be used.

   ---------- Footnotes ----------

   (1) http://tix.sourceforge.net/dist/current/man/html/TixCmd/tix.htm


File: python.info,  Node: tkinter scrolledtext — Scrolled Text Widget,  Next: IDLE<41>,  Prev: tkinter tix — Extension widgets for Tk,  Up: Graphical User Interfaces with Tk

5.26.4 ‘tkinter.scrolledtext’ — Scrolled Text Widget
----------------------------------------------------

`Source code:' Lib/tkinter/scrolledtext.py(1)

__________________________________________________________________

The *note tkinter.scrolledtext: 10d. module provides a class of the same
name which implements a basic text widget which has a vertical scroll
bar configured to do the “right thing.” Using the ‘ScrolledText’ class
is a lot easier than setting up a text widget and scroll bar directly.
The constructor is the same as that of the ‘tkinter.Text’ class.

The text widget and scrollbar are packed together in a ‘Frame’, and the
methods of the ‘Grid’ and ‘Pack’ geometry managers are acquired from the
‘Frame’ object.  This allows the ‘ScrolledText’ widget to be used
directly to achieve most normal geometry management behavior.

Should more specific control be necessary, the following attributes are
available:

 -- Attribute: ScrolledText.frame

     The frame which surrounds the text and scroll bar widgets.

 -- Attribute: ScrolledText.vbar

     The scroll bar widget.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/tkinter/scrolledtext.py


File: python.info,  Node: IDLE<41>,  Next: Other Graphical User Interface Packages,  Prev: tkinter scrolledtext — Scrolled Text Widget,  Up: Graphical User Interfaces with Tk

5.26.5 IDLE
-----------

`Source code:' Lib/idlelib/(1)

__________________________________________________________________

IDLE is Python’s Integrated Development and Learning Environment.

IDLE has the following features:

   * coded in 100% pure Python, using the *note tkinter: 10c. GUI
     toolkit

   * cross-platform: works mostly the same on Windows, Unix, and macOS

   * Python shell window (interactive interpreter) with colorizing of
     code input, output, and error messages

   * multi-window text editor with multiple undo, Python colorizing,
     smart indent, call tips, auto completion, and other features

   * search within any window, replace within editor windows, and search
     through multiple files (grep)

   * debugger with persistent breakpoints, stepping, and viewing of
     global and local namespaces

   * configuration, browsers, and other dialogs

* Menu:

* Menus::
* Editing and navigation::
* Startup and code execution::
* Help and preferences::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/idlelib/


File: python.info,  Node: Menus,  Next: Editing and navigation,  Up: IDLE<41>

5.26.5.1 Menus
..............

IDLE has two main window types, the Shell window and the Editor window.
It is possible to have multiple editor windows simultaneously.  On
Windows and Linux, each has its own top menu.  Each menu documented
below indicates which window type it is associated with.

Output windows, such as used for Edit => Find in Files, are a subtype of
editor window.  They currently have the same top menu but a different
default title and context menu.

On macOS, there is one application menu.  It dynamically changes
according to the window currently selected.  It has an IDLE menu, and
some entries described below are moved around to conform to Apple
guidelines.

* Menu:

* File menu (Shell and Editor): File menu Shell and Editor.
* Edit menu (Shell and Editor): Edit menu Shell and Editor.
* Format menu (Editor window only): Format menu Editor window only.
* Run menu (Editor window only): Run menu Editor window only.
* Shell menu (Shell window only): Shell menu Shell window only.
* Debug menu (Shell window only): Debug menu Shell window only.
* Options menu (Shell and Editor): Options menu Shell and Editor.
* Window menu (Shell and Editor): Window menu Shell and Editor.
* Help menu (Shell and Editor): Help menu Shell and Editor.
* Context Menus::


File: python.info,  Node: File menu Shell and Editor,  Next: Edit menu Shell and Editor,  Up: Menus

5.26.5.2 File menu (Shell and Editor)
.....................................

New File

     Create a new file editing window.

Open…

     Open an existing file with an Open dialog.

Recent Files

     Open a list of recent files.  Click one to open it.

Open Module…

     Open an existing module (searches sys.path).

Class Browser

     Show functions, classes, and methods in the current Editor file in
     a tree structure.  In the shell, open a module first.

Path Browser

     Show sys.path directories, modules, functions, classes and methods
     in a tree structure.

Save

     Save the current window to the associated file, if there is one.
     Windows that have been changed since being opened or last saved
     have a * before and after the window title.  If there is no
     associated file, do Save As instead.

Save As…

     Save the current window with a Save As dialog.  The file saved
     becomes the new associated file for the window.

Save Copy As…

     Save the current window to different file without changing the
     associated file.

Print Window

     Print the current window to the default printer.

Close

     Close the current window (ask to save if unsaved).

Exit

     Close all windows and quit IDLE (ask to save unsaved windows).


File: python.info,  Node: Edit menu Shell and Editor,  Next: Format menu Editor window only,  Prev: File menu Shell and Editor,  Up: Menus

5.26.5.3 Edit menu (Shell and Editor)
.....................................

Undo

     Undo the last change to the current window.  A maximum of 1000
     changes may be undone.

Redo

     Redo the last undone change to the current window.

Cut

     Copy selection into the system-wide clipboard; then delete the
     selection.

Copy

     Copy selection into the system-wide clipboard.

Paste

     Insert contents of the system-wide clipboard into the current
     window.

The clipboard functions are also available in context menus.

Select All

     Select the entire contents of the current window.

Find…

     Open a search dialog with many options

Find Again

     Repeat the last search, if there is one.

Find Selection

     Search for the currently selected string, if there is one.

Find in Files…

     Open a file search dialog.  Put results in a new output window.

Replace…

     Open a search-and-replace dialog.

Go to Line

     Move cursor to the line number requested and make that line
     visible.

Show Completions

     Open a scrollable list allowing selection of keywords and
     attributes.  See *note Completions: 3176. in the Editing and
     navigation section below.

Expand Word

     Expand a prefix you have typed to match a full word in the same
     window; repeat to get a different expansion.

Show call tip

     After an unclosed parenthesis for a function, open a small window
     with function parameter hints.  See *note Calltips: 3177. in the
     Editing and navigation section below.

Show surrounding parens

     Highlight the surrounding parenthesis.


File: python.info,  Node: Format menu Editor window only,  Next: Run menu Editor window only,  Prev: Edit menu Shell and Editor,  Up: Menus

5.26.5.4 Format menu (Editor window only)
.........................................

Indent Region

     Shift selected lines right by the indent width (default 4 spaces).

Dedent Region

     Shift selected lines left by the indent width (default 4 spaces).

Comment Out Region

     Insert ## in front of selected lines.

Uncomment Region

     Remove leading # or ## from selected lines.

Tabify Region

     Turn `leading' stretches of spaces into tabs.  (Note: We recommend
     using 4 space blocks to indent Python code.)

Untabify Region

     Turn `all' tabs into the correct number of spaces.

Toggle Tabs

     Open a dialog to switch between indenting with spaces and tabs.

New Indent Width

     Open a dialog to change indent width.  The accepted default by the
     Python community is 4 spaces.

Format Paragraph

     Reformat the current blank-line-delimited paragraph in comment
     block or multiline string or selected line in a string.  All lines
     in the paragraph will be formatted to less than N columns, where N
     defaults to 72.

Strip trailing whitespace

     Remove trailing space and other whitespace characters after the
     last non-whitespace character of a line by applying str.rstrip to
     each line, including lines within multiline strings.  Except for
     Shell windows, remove extra newlines at the end of the file.


File: python.info,  Node: Run menu Editor window only,  Next: Shell menu Shell window only,  Prev: Format menu Editor window only,  Up: Menus

5.26.5.5 Run menu (Editor window only)
......................................

Run Module

     Do *note Check Module: 317c.  If no error, restart the shell to
     clean the environment, then execute the module.  Output is
     displayed in the Shell window.  Note that output requires use of
     ‘print’ or ‘write’.  When execution is complete, the Shell retains
     focus and displays a prompt.  At this point, one may interactively
     explore the result of execution.  This is similar to executing a
     file with ‘python -i file’ at a command line.

Run… Customized

     Same as *note Run Module: 317b, but run the module with customized
     settings.  `Command Line Arguments' extend *note sys.argv: bee. as
     if passed on a command line.  The module can be run in the Shell
     without restarting.

Check Module

     Check the syntax of the module currently open in the Editor window.
     If the module has not been saved IDLE will either prompt the user
     to save or autosave, as selected in the General tab of the Idle
     Settings dialog.  If there is a syntax error, the approximate
     location is indicated in the Editor window.

Python Shell

     Open or wake up the Python Shell window.


File: python.info,  Node: Shell menu Shell window only,  Next: Debug menu Shell window only,  Prev: Run menu Editor window only,  Up: Menus

5.26.5.6 Shell menu (Shell window only)
.......................................

View Last Restart

     Scroll the shell window to the last Shell restart.

Restart Shell

     Restart the shell to clean the environment.

Previous History

     Cycle through earlier commands in history which match the current
     entry.

Next History

     Cycle through later commands in history which match the current
     entry.

Interrupt Execution

     Stop a running program.


File: python.info,  Node: Debug menu Shell window only,  Next: Options menu Shell and Editor,  Prev: Shell menu Shell window only,  Up: Menus

5.26.5.7 Debug menu (Shell window only)
.......................................

Go to File/Line

     Look on the current line.  with the cursor, and the line above for
     a filename and line number.  If found, open the file if not already
     open, and show the line.  Use this to view source lines referenced
     in an exception traceback and lines found by Find in Files.  Also
     available in the context menu of the Shell window and Output
     windows.

Debugger (toggle)

     When activated, code entered in the Shell or run from an Editor
     will run under the debugger.  In the Editor, breakpoints can be set
     with the context menu.  This feature is still incomplete and
     somewhat experimental.

Stack Viewer

     Show the stack traceback of the last exception in a tree widget,
     with access to locals and globals.

Auto-open Stack Viewer

     Toggle automatically opening the stack viewer on an unhandled
     exception.


File: python.info,  Node: Options menu Shell and Editor,  Next: Window menu Shell and Editor,  Prev: Debug menu Shell window only,  Up: Menus

5.26.5.8 Options menu (Shell and Editor)
........................................

Configure IDLE

     Open a configuration dialog and change preferences for the
     following: fonts, indentation, keybindings, text color themes,
     startup windows and size, additional help sources, and extensions.
     On macOS, open the configuration dialog by selecting Preferences in
     the application menu.  For more details, see *note Setting
     preferences: 3182. under Help and preferences.

Most configuration options apply to all windows or all future windows.
The option items below only apply to the active window.

Show/Hide Code Context (Editor Window only)

     Open a pane at the top of the edit window which shows the block
     context of the code which has scrolled above the top of the window.
     See *note Code Context: 3183. in the Editing and Navigation section
     below.

Show/Hide Line Numbers (Editor Window only)

     Open a column to the left of the edit window which shows the number
     of each line of text.  The default is off, which may be changed in
     the preferences (see *note Setting preferences: 3182.).

Zoom/Restore Height

     Toggles the window between normal size and maximum height.  The
     initial size defaults to 40 lines by 80 chars unless changed on the
     General tab of the Configure IDLE dialog.  The maximum height for a
     screen is determined by momentarily maximizing a window the first
     time one is zoomed on the screen.  Changing screen settings may
     invalidate the saved height.  This toggle has no effect when a
     window is maximized.


File: python.info,  Node: Window menu Shell and Editor,  Next: Help menu Shell and Editor,  Prev: Options menu Shell and Editor,  Up: Menus

5.26.5.9 Window menu (Shell and Editor)
.......................................

Lists the names of all open windows; select one to bring it to the
foreground (deiconifying it if necessary).


File: python.info,  Node: Help menu Shell and Editor,  Next: Context Menus,  Prev: Window menu Shell and Editor,  Up: Menus

5.26.5.10 Help menu (Shell and Editor)
......................................

About IDLE

     Display version, copyright, license, credits, and more.

IDLE Help

     Display this IDLE document, detailing the menu options, basic
     editing and navigation, and other tips.

Python Docs

     Access local Python documentation, if installed, or start a web
     browser and open docs.python.org showing the latest Python
     documentation.

Turtle Demo

     Run the turtledemo module with example Python code and turtle
     drawings.

Additional help sources may be added here with the Configure IDLE dialog
under the General tab.  See the *note Help sources: 3186. subsection
below for more on Help menu choices.


File: python.info,  Node: Context Menus,  Prev: Help menu Shell and Editor,  Up: Menus

5.26.5.11 Context Menus
.......................

Open a context menu by right-clicking in a window (Control-click on
macOS). Context menus have the standard clipboard functions also on the
Edit menu.

Cut

     Copy selection into the system-wide clipboard; then delete the
     selection.

Copy

     Copy selection into the system-wide clipboard.

Paste

     Insert contents of the system-wide clipboard into the current
     window.

Editor windows also have breakpoint functions.  Lines with a breakpoint
set are specially marked.  Breakpoints only have an effect when running
under the debugger.  Breakpoints for a file are saved in the user’s
.idlerc directory.

Set Breakpoint

     Set a breakpoint on the current line.

Clear Breakpoint

     Clear the breakpoint on that line.

Shell and Output windows also have the following.

Go to file/line

     Same as in Debug menu.

The Shell window also has an output squeezing facility explained in the
`Python Shell window' subsection below.

Squeeze

     If the cursor is over an output line, squeeze all the output
     between the code above and the prompt below down to a ‘Squeezed
     text’ label.


File: python.info,  Node: Editing and navigation,  Next: Startup and code execution,  Prev: Menus,  Up: IDLE<41>

5.26.5.12 Editing and navigation
................................

* Menu:

* Editor windows::
* Key bindings::
* Automatic indentation::
* Completions::
* Calltips::
* Code Context::
* Python Shell window::
* Text colors::


File: python.info,  Node: Editor windows,  Next: Key bindings,  Up: Editing and navigation

5.26.5.13 Editor windows
........................

IDLE may open editor windows when it starts, depending on settings and
how you start IDLE. Thereafter, use the File menu.  There can be only
one open editor window for a given file.

The title bar contains the name of the file, the full path, and the
version of Python and IDLE running the window.  The status bar contains
the line number (‘Ln’) and column number (‘Col’).  Line numbers start
with 1; column numbers with 0.

IDLE assumes that files with a known .py* extension contain Python code
and that other files do not.  Run Python code with the Run menu.


File: python.info,  Node: Key bindings,  Next: Automatic indentation,  Prev: Editor windows,  Up: Editing and navigation

5.26.5.14 Key bindings
......................

In this section, ‘C’ refers to the ‘Control’ key on Windows and Unix and
the ‘Command’ key on macOS.

   * ‘Backspace’ deletes to the left; ‘Del’ deletes to the right

   * ‘C-Backspace’ delete word left; ‘C-Del’ delete word to the right

   * Arrow keys and ‘Page Up’/‘Page Down’ to move around

   * ‘C-LeftArrow’ and ‘C-RightArrow’ moves by words

   * ‘Home’/‘End’ go to begin/end of line

   * ‘C-Home’/‘C-End’ go to begin/end of file

   * Some useful Emacs bindings are inherited from Tcl/Tk:

             * ‘C-a’ beginning of line

             * ‘C-e’ end of line

             * ‘C-k’ kill line (but doesn’t put it in clipboard)

             * ‘C-l’ center window around the insertion point

             * ‘C-b’ go backward one character without deleting (usually
               you can also use the cursor key for this)

             * ‘C-f’ go forward one character without deleting (usually
               you can also use the cursor key for this)

             * ‘C-p’ go up one line (usually you can also use the cursor
               key for this)

             * ‘C-d’ delete next character

Standard keybindings (like ‘C-c’ to copy and ‘C-v’ to paste) may work.
Keybindings are selected in the Configure IDLE dialog.


File: python.info,  Node: Automatic indentation,  Next: Completions,  Prev: Key bindings,  Up: Editing and navigation

5.26.5.15 Automatic indentation
...............................

After a block-opening statement, the next line is indented by 4 spaces
(in the Python Shell window by one tab).  After certain keywords (break,
return etc.)  the next line is dedented.  In leading indentation,
‘Backspace’ deletes up to 4 spaces if they are there.  ‘Tab’ inserts
spaces (in the Python Shell window one tab), number depends on Indent
width.  Currently, tabs are restricted to four spaces due to Tcl/Tk
limitations.

See also the indent/dedent region commands on the *note Format menu:
3178.


File: python.info,  Node: Completions,  Next: Calltips,  Prev: Automatic indentation,  Up: Editing and navigation

5.26.5.16 Completions
.....................

Completions are supplied for functions, classes, and attributes of
classes, both built-in and user-defined.  Completions are also provided
for filenames.

The AutoCompleteWindow (ACW) will open after a predefined delay (default
is two seconds) after a ‘.’ or (in a string) an os.sep is typed.  If
after one of those characters (plus zero or more other characters) a tab
is typed the ACW will open immediately if a possible continuation is
found.

If there is only one possible completion for the characters entered, a
‘Tab’ will supply that completion without opening the ACW.

‘Show Completions’ will force open a completions window, by default the
‘C-space’ will open a completions window.  In an empty string, this will
contain the files in the current directory.  On a blank line, it will
contain the built-in and user-defined functions and classes in the
current namespaces, plus any modules imported.  If some characters have
been entered, the ACW will attempt to be more specific.

If a string of characters is typed, the ACW selection will jump to the
entry most closely matching those characters.  Entering a ‘tab’ will
cause the longest non-ambiguous match to be entered in the Editor window
or Shell.  Two ‘tab’ in a row will supply the current ACW selection, as
will return or a double click.  Cursor keys, Page Up/Down, mouse
selection, and the scroll wheel all operate on the ACW.

“Hidden” attributes can be accessed by typing the beginning of hidden
name after a ‘.’, e.g.  ‘_’.  This allows access to modules with
‘__all__’ set, or to class-private attributes.

Completions and the ‘Expand Word’ facility can save a lot of typing!

Completions are currently limited to those in the namespaces.  Names in
an Editor window which are not via ‘__main__’ and *note sys.modules:
13eb. will not be found.  Run the module once with your imports to
correct this situation.  Note that IDLE itself places quite a few
modules in sys.modules, so much can be found by default, e.g.  the re
module.

If you don’t like the ACW popping up unbidden, simply make the delay
longer or disable the extension.


File: python.info,  Node: Calltips,  Next: Code Context,  Prev: Completions,  Up: Editing and navigation

5.26.5.17 Calltips
..................

A calltip is shown when one types ‘(’ after the name of an `accessible'
function.  A name expression may include dots and subscripts.  A calltip
remains until it is clicked, the cursor is moved out of the argument
area, or ‘)’ is typed.  When the cursor is in the argument part of a
definition, the menu or shortcut display a calltip.

A calltip consists of the function signature and the first line of the
docstring.  For builtins without an accessible signature, the calltip
consists of all lines up the fifth line or the first blank line.  These
details may change.

The set of `accessible' functions depends on what modules have been
imported into the user process, including those imported by Idle itself,
and what definitions have been run, all since the last restart.

For example, restart the Shell and enter ‘itertools.count(’.  A calltip
appears because Idle imports itertools into the user process for its own
use.  (This could change.)  Enter ‘turtle.write(’ and nothing appears.
Idle does not import turtle.  The menu or shortcut do nothing either.
Enter ‘import turtle’ and then ‘turtle.write(’ will work.

In an editor, import statements have no effect until one runs the file.
One might want to run a file after writing the import statements at the
top, or immediately run an existing file before editing.


File: python.info,  Node: Code Context,  Next: Python Shell window,  Prev: Calltips,  Up: Editing and navigation

5.26.5.18 Code Context
......................

Within an editor window containing Python code, code context can be
toggled in order to show or hide a pane at the top of the window.  When
shown, this pane freezes the opening lines for block code, such as those
beginning with ‘class’, ‘def’, or ‘if’ keywords, that would have
otherwise scrolled out of view.  The size of the pane will be expanded
and contracted as needed to show the all current levels of context, up
to the maximum number of lines defined in the Configure IDLE dialog
(which defaults to 15).  If there are no current context lines and the
feature is toggled on, a single blank line will display.  Clicking on a
line in the context pane will move that line to the top of the editor.

The text and background colors for the context pane can be configured
under the Highlights tab in the Configure IDLE dialog.


File: python.info,  Node: Python Shell window,  Next: Text colors,  Prev: Code Context,  Up: Editing and navigation

5.26.5.19 Python Shell window
.............................

With IDLE’s Shell, one enters, edits, and recalls complete statements.
Most consoles and terminals only work with a single physical line at a
time.

When one pastes code into Shell, it is not compiled and possibly
executed until one hits ‘Return’.  One may edit pasted code first.  If
one pastes more that one statement into Shell, the result will be a
*note SyntaxError: 44d. when multiple statements are compiled as if they
were one.

The editing features described in previous subsections work when
entering code interactively.  IDLE’s Shell window also responds to the
following keys.

   * ‘C-c’ interrupts executing command

   * ‘C-d’ sends end-of-file; closes window if typed at a ‘>>>’ prompt

   * ‘Alt-/’ (Expand word) is also useful to reduce typing

     Command history

        * ‘Alt-p’ retrieves previous command matching what you have
          typed.  On macOS use ‘C-p’.

        * ‘Alt-n’ retrieves next.  On macOS use ‘C-n’.

        * ‘Return’ while on any previous command retrieves that command


File: python.info,  Node: Text colors,  Prev: Python Shell window,  Up: Editing and navigation

5.26.5.20 Text colors
.....................

Idle defaults to black on white text, but colors text with special
meanings.  For the shell, these are shell output, shell error, user
output, and user error.  For Python code, at the shell prompt or in an
editor, these are keywords, builtin class and function names, names
following ‘class’ and ‘def’, strings, and comments.  For any text
window, these are the cursor (when present), found text (when possible),
and selected text.

Text coloring is done in the background, so uncolorized text is
occasionally visible.  To change the color scheme, use the Configure
IDLE dialog Highlighting tab.  The marking of debugger breakpoint lines
in the editor and text in popups and dialogs is not user-configurable.


File: python.info,  Node: Startup and code execution,  Next: Help and preferences,  Prev: Editing and navigation,  Up: IDLE<41>

5.26.5.21 Startup and code execution
....................................

Upon startup with the ‘-s’ option, IDLE will execute the file referenced
by the environment variables ‘IDLESTARTUP’ or *note PYTHONSTARTUP: 8d9.
IDLE first checks for ‘IDLESTARTUP’; if ‘IDLESTARTUP’ is present the
file referenced is run.  If ‘IDLESTARTUP’ is not present, IDLE checks
for ‘PYTHONSTARTUP’.  Files referenced by these environment variables
are convenient places to store functions that are used frequently from
the IDLE shell, or for executing import statements to import common
modules.

In addition, ‘Tk’ also loads a startup file if it is present.  Note that
the Tk file is loaded unconditionally.  This additional file is
‘.Idle.py’ and is looked for in the user’s home directory.  Statements
in this file will be executed in the Tk namespace, so this file is not
useful for importing functions to be used from IDLE’s Python shell.

* Menu:

* Command line usage::
* Startup failure::
* Running user code::
* User output in Shell::
* Developing tkinter applications::
* Running without a subprocess::


File: python.info,  Node: Command line usage,  Next: Startup failure,  Up: Startup and code execution

5.26.5.22 Command line usage
............................

     idle.py [-c command] [-d] [-e] [-h] [-i] [-r file] [-s] [-t title] [-] [arg] ...  -c command  run command in the shell window -d          enable debugger and open shell window -e          open editor window -h          print help message with legal combinations and exit -i          open shell window -r file     run file in shell window -s          run $IDLESTARTUP or $PYTHONSTARTUP first, in shell window -t title    set title of shell window -           run stdin in shell (- must be last option before args)

If there are arguments:

   * If ‘-’, ‘-c’, or ‘r’ is used, all arguments are placed in
     ‘sys.argv[1:...]’ and ‘sys.argv[0]’ is set to ‘''’, ‘'-c'’, or
     ‘'-r'’.  No editor window is opened, even if that is the default
     set in the Options dialog.

   * Otherwise, arguments are files opened for editing and ‘sys.argv’
     reflects the arguments passed to IDLE itself.


File: python.info,  Node: Startup failure,  Next: Running user code,  Prev: Command line usage,  Up: Startup and code execution

5.26.5.23 Startup failure
.........................

IDLE uses a socket to communicate between the IDLE GUI process and the
user code execution process.  A connection must be established whenever
the Shell starts or restarts.  (The latter is indicated by a divider
line that says ‘RESTART’).  If the user process fails to connect to the
GUI process, it displays a ‘Tk’ error box with a ‘cannot connect’
message that directs the user here.  It then exits.

A common cause of failure is a user-written file with the same name as a
standard library module, such as `random.py' and `tkinter.py'.  When
such a file is located in the same directory as a file that is about to
be run, IDLE cannot import the stdlib file.  The current fix is to
rename the user file.

Though less common than in the past, an antivirus or firewall program
may stop the connection.  If the program cannot be taught to allow the
connection, then it must be turned off for IDLE to work.  It is safe to
allow this internal connection because no data is visible on external
ports.  A similar problem is a network mis-configuration that blocks
connections.

Python installation issues occasionally stop IDLE: multiple versions can
clash, or a single installation might need admin access.  If one undo
the clash, or cannot or does not want to run as admin, it might be
easiest to completely remove Python and start over.

A zombie pythonw.exe process could be a problem.  On Windows, use Task
Manager to detect and stop one.  Sometimes a restart initiated by a
program crash or Keyboard Interrupt (control-C) may fail to connect.
Dismissing the error box or Restart Shell on the Shell menu may fix a
temporary problem.

When IDLE first starts, it attempts to read user configuration files in
~/.idlerc/ (~ is one’s home directory).  If there is a problem, an error
message should be displayed.  Leaving aside random disk glitches, this
can be prevented by never editing the files by hand, using the
configuration dialog, under Options, instead Options.  Once it happens,
the solution may be to delete one or more of the configuration files.

If IDLE quits with no message, and it was not started from a console,
try starting from a console (‘python -m idlelib)’ and see if a message
appears.


File: python.info,  Node: Running user code,  Next: User output in Shell,  Prev: Startup failure,  Up: Startup and code execution

5.26.5.24 Running user code
...........................

With rare exceptions, the result of executing Python code with IDLE is
intended to be the same as executing the same code by the default
method, directly with Python in a text-mode system console or terminal
window.  However, the different interface and operation occasionally
affect visible results.  For instance, ‘sys.modules’ starts with more
entries, and ‘threading.activeCount()’ returns 2 instead of 1.

By default, IDLE runs user code in a separate OS process rather than in
the user interface process that runs the shell and editor.  In the
execution process, it replaces ‘sys.stdin’, ‘sys.stdout’, and
‘sys.stderr’ with objects that get input from and send output to the
Shell window.  The original values stored in ‘sys.__stdin__’,
‘sys.__stdout__’, and ‘sys.__stderr__’ are not touched, but may be
‘None’.

When Shell has the focus, it controls the keyboard and screen.  This is
normally transparent, but functions that directly access the keyboard
and screen will not work.  These include system-specific functions that
determine whether a key has been pressed and if so, which.

IDLE’s standard stream replacements are not inherited by subprocesses
created in the execution process, whether directly by user code or by
modules such as multiprocessing.  If such subprocess use ‘input’ from
sys.stdin or ‘print’ or ‘write’ to sys.stdout or sys.stderr, IDLE should
be started in a command line window.  The secondary subprocess will then
be attached to that window for input and output.

The IDLE code running in the execution process adds frames to the call
stack that would not be there otherwise.  IDLE wraps
‘sys.getrecursionlimit’ and ‘sys.setrecursionlimit’ to reduce the effect
of the additional stack frames.

If ‘sys’ is reset by user code, such as with ‘importlib.reload(sys)’,
IDLE’s changes are lost and input from the keyboard and output to the
screen will not work correctly.

When user code raises SystemExit either directly or by calling sys.exit,
IDLE returns to a Shell prompt instead of exiting.


File: python.info,  Node: User output in Shell,  Next: Developing tkinter applications,  Prev: Running user code,  Up: Startup and code execution

5.26.5.25 User output in Shell
..............................

When a program outputs text, the result is determined by the
corresponding output device.  When IDLE executes user code, ‘sys.stdout’
and ‘sys.stderr’ are connected to the display area of IDLE’s Shell.
Some of its features are inherited from the underlying Tk Text widget.
Others are programmed additions.  Where it matters, Shell is designed
for development rather than production runs.

For instance, Shell never throws away output.  A program that sends
unlimited output to Shell will eventually fill memory, resulting in a
memory error.  In contrast, some system text windows only keep the last
n lines of output.  A Windows console, for instance, keeps a
user-settable 1 to 9999 lines, with 300 the default.

A Tk Text widget, and hence IDLE’s Shell, displays characters
(codepoints) in the BMP (Basic Multilingual Plane) subset of Unicode.
Which characters are displayed with a proper glyph and which with a
replacement box depends on the operating system and installed fonts.
Tab characters cause the following text to begin after the next tab
stop.  (They occur every 8 ‘characters’).  Newline characters cause
following text to appear on a new line.  Other control characters are
ignored or displayed as a space, box, or something else, depending on
the operating system and font.  (Moving the text cursor through such
output with arrow keys may exhibit some surprising spacing behavior.)

     >>> s = 'a\tb\a<\x02><\r>\bc\nd'  # Enter 22 chars. >>> len(s) 14 >>> s  # Display repr(s) 'a\tb\x07<\x02><\r>\x08c\nd' >>> print(s, end='')  # Display s as is. # Result varies by OS and font.  Try it.

The ‘repr’ function is used for interactive echo of expression values.
It returns an altered version of the input string in which control
codes, some BMP codepoints, and all non-BMP codepoints are replaced with
escape codes.  As demonstrated above, it allows one to identify the
characters in a string, regardless of how they are displayed.

Normal and error output are generally kept separate (on separate lines)
from code input and each other.  They each get different highlight
colors.

For SyntaxError tracebacks, the normal ‘^’ marking where the error was
detected is replaced by coloring the text with an error highlight.  When
code run from a file causes other exceptions, one may right click on a
traceback line to jump to the corresponding line in an IDLE editor.  The
file will be opened if necessary.

Shell has a special facility for squeezing output lines down to a
‘Squeezed text’ label.  This is done automatically for output over N
lines (N = 50 by default).  N can be changed in the PyShell section of
the General page of the Settings dialog.  Output with fewer lines can be
squeezed by right clicking on the output.  This can be useful lines long
enough to slow down scrolling.

Squeezed output is expanded in place by double-clicking the label.  It
can also be sent to the clipboard or a separate view window by
right-clicking the label.


File: python.info,  Node: Developing tkinter applications,  Next: Running without a subprocess,  Prev: User output in Shell,  Up: Startup and code execution

5.26.5.26 Developing tkinter applications
.........................................

IDLE is intentionally different from standard Python in order to
facilitate development of tkinter programs.  Enter ‘import tkinter as
tk; root = tk.Tk()’ in standard Python and nothing appears.  Enter the
same in IDLE and a tk window appears.  In standard Python, one must also
enter ‘root.update()’ to see the window.  IDLE does the equivalent in
the background, about 20 times a second, which is about every 50
milliseconds.  Next enter ‘b = tk.Button(root, text='button');
b.pack()’.  Again, nothing visibly changes in standard Python until one
enters ‘root.update()’.

Most tkinter programs run ‘root.mainloop()’, which usually does not
return until the tk app is destroyed.  If the program is run with
‘python -i’ or from an IDLE editor, a ‘>>>’ shell prompt does not appear
until ‘mainloop()’ returns, at which time there is nothing left to
interact with.

When running a tkinter program from an IDLE editor, one can comment out
the mainloop call.  One then gets a shell prompt immediately and can
interact with the live application.  One just has to remember to
re-enable the mainloop call when running in standard Python.


File: python.info,  Node: Running without a subprocess,  Prev: Developing tkinter applications,  Up: Startup and code execution

5.26.5.27 Running without a subprocess
......................................

By default, IDLE executes user code in a separate subprocess via a
socket, which uses the internal loopback interface.  This connection is
not externally visible and no data is sent to or received from the
Internet.  If firewall software complains anyway, you can ignore it.

If the attempt to make the socket connection fails, Idle will notify
you.  Such failures are sometimes transient, but if persistent, the
problem may be either a firewall blocking the connection or
misconfiguration of a particular system.  Until the problem is fixed,
one can run Idle with the -n command line switch.

If IDLE is started with the -n command line switch it will run in a
single process and will not create the subprocess which runs the RPC
Python execution server.  This can be useful if Python cannot create the
subprocess or the RPC socket interface on your platform.  However, in
this mode user code is not isolated from IDLE itself.  Also, the
environment is not restarted when Run/Run Module (F5) is selected.  If
your code has been modified, you must reload() the affected modules and
re-import any specific items (e.g.  from foo import baz) if the changes
are to take effect.  For these reasons, it is preferable to run IDLE
with the default subprocess if at all possible.

Deprecated since version 3.4.


File: python.info,  Node: Help and preferences,  Prev: Startup and code execution,  Up: IDLE<41>

5.26.5.28 Help and preferences
..............................

* Menu:

* Help sources::
* Setting preferences::
* IDLE on macOS::
* Extensions::


File: python.info,  Node: Help sources,  Next: Setting preferences,  Up: Help and preferences

5.26.5.29 Help sources
......................

Help menu entry “IDLE Help” displays a formatted html version of the
IDLE chapter of the Library Reference.  The result, in a read-only
tkinter text window, is close to what one sees in a web browser.
Navigate through the text with a mousewheel, the scrollbar, or up and
down arrow keys held down.  Or click the TOC (Table of Contents) button
and select a section header in the opened box.

Help menu entry “Python Docs” opens the extensive sources of help,
including tutorials, available at docs.python.org/x.y, where ‘x.y’ is
the currently running Python version.  If your system has an off-line
copy of the docs (this may be an installation option), that will be
opened instead.

Selected URLs can be added or removed from the help menu at any time
using the General tab of the Configure IDLE dialog .


File: python.info,  Node: Setting preferences,  Next: IDLE on macOS,  Prev: Help sources,  Up: Help and preferences

5.26.5.30 Setting preferences
.............................

The font preferences, highlighting, keys, and general preferences can be
changed via Configure IDLE on the Option menu.  Non-default user
settings are saved in a .idlerc directory in the user’s home directory.
Problems caused by bad user configuration files are solved by editing or
deleting one or more of the files in .idlerc.

On the Font tab, see the text sample for the effect of font face and
size on multiple characters in multiple languages.  Edit the sample to
add other characters of personal interest.  Use the sample to select
monospaced fonts.  If particular characters have problems in Shell or an
editor, add them to the top of the sample and try changing first size
and then font.

On the Highlights and Keys tab, select a built-in or custom color theme
and key set.  To use a newer built-in color theme or key set with older
IDLEs, save it as a new custom theme or key set and it well be
accessible to older IDLEs.


File: python.info,  Node: IDLE on macOS,  Next: Extensions,  Prev: Setting preferences,  Up: Help and preferences

5.26.5.31 IDLE on macOS
.......................

Under System Preferences: Dock, one can set “Prefer tabs when opening
documents” to “Always”.  This setting is not compatible with the
tk/tkinter GUI framework used by IDLE, and it breaks a few IDLE
features.


File: python.info,  Node: Extensions,  Prev: IDLE on macOS,  Up: Help and preferences

5.26.5.32 Extensions
....................

IDLE contains an extension facility.  Preferences for extensions can be
changed with the Extensions tab of the preferences dialog.  See the
beginning of config-extensions.def in the idlelib directory for further
information.  The only current default extension is zzdummy, an example
also used for testing.


File: python.info,  Node: Other Graphical User Interface Packages,  Prev: IDLE<41>,  Up: Graphical User Interfaces with Tk

5.26.6 Other Graphical User Interface Packages
----------------------------------------------

Major cross-platform (Windows, Mac OS X, Unix-like) GUI toolkits are
available for Python:

See also
........

PyGObject(1)

     PyGObject provides introspection bindings for C libraries using
     GObject(2).  One of these libraries is the GTK+ 3(3) widget set.
     GTK+ comes with many more widgets than Tkinter provides.  An online
     Python GTK+ 3 Tutorial(4) is available.

PyGTK(5)

     PyGTK provides bindings for an older version of the library, GTK+
     2.  It provides an object oriented interface that is slightly
     higher level than the C one.  There are also bindings to GNOME(6).
     An online tutorial(7) is available.

PyQt(8)

     PyQt is a ‘sip’-wrapped binding to the Qt toolkit.  Qt is an
     extensive C++ GUI application development framework that is
     available for Unix, Windows and Mac OS X. ‘sip’ is a tool for
     generating bindings for C++ libraries as Python classes, and is
     specifically designed for Python.

PySide(9)

     PySide is a newer binding to the Qt toolkit, provided by Nokia.
     Compared to PyQt, its licensing scheme is friendlier to non-open
     source applications.

wxPython(10)

     wxPython is a cross-platform GUI toolkit for Python that is built
     around the popular wxWidgets(11) (formerly wxWindows) C++ toolkit.
     It provides a native look and feel for applications on Windows, Mac
     OS X, and Unix systems by using each platform’s native widgets
     where ever possible, (GTK+ on Unix-like systems).  In addition to
     an extensive set of widgets, wxPython provides classes for online
     documentation and context sensitive help, printing, HTML viewing,
     low-level device context drawing, drag and drop, system clipboard
     access, an XML-based resource format and more, including an ever
     growing library of user-contributed modules.

PyGTK, PyQt, and wxPython, all have a modern look and feel and more
widgets than Tkinter.  In addition, there are many other GUI toolkits
for Python, both cross-platform, and platform-specific.  See the GUI
Programming(12) page in the Python Wiki for a much more complete list,
and also for links to documents where the different GUI toolkits are
compared.

   ---------- Footnotes ----------

   (1) https://wiki.gnome.org/Projects/PyGObject

   (2) https://developer.gnome.org/gobject/stable/

   (3) https://www.gtk.org/

   (4) https://python-gtk-3-tutorial.readthedocs.io/

   (5) http://www.pygtk.org/

   (6) https://www.gnome.org/

   (7) http://www.pygtk.org/pygtk2tutorial/index.html

   (8) https://riverbankcomputing.com/software/pyqt/intro

   (9) https://wiki.qt.io/PySide

   (10) https://www.wxpython.org

   (11) https://www.wxwidgets.org/

   (12) https://wiki.python.org/moin/GuiProgramming


File: python.info,  Node: Development Tools,  Next: Debugging and Profiling,  Prev: Graphical User Interfaces with Tk,  Up: The Python Standard Library

5.27 Development Tools
======================

The modules described in this chapter help you write software.  For
example, the *note pydoc: d9. module takes a module and generates
documentation based on the module’s contents.  The *note doctest: 67.
and *note unittest: 11b. modules contains frameworks for writing unit
tests that automatically exercise code and verify that the expected
output is produced.  ‘2to3’ can translate Python 2.x source code into
valid Python 3.x code.

The list of modules described in this chapter is:

* Menu:

* typing — Support for type hints::
* pydoc — Documentation generator and online help system::
* doctest — Test interactive Python examples::
* unittest — Unit testing framework::
* unittest.mock — mock object library: unittest mock — mock object library.
* unittest.mock — getting started: unittest mock — getting started.
* 2to3 - Automated Python 2 to 3 code translation::
* test — Regression tests package for Python::
* test.support — Utilities for the Python test suite: test support — Utilities for the Python test suite.
* test.support.script_helper — Utilities for the Python execution tests: test support script_helper — Utilities for the Python execution tests.


File: python.info,  Node: typing — Support for type hints,  Next: pydoc — Documentation generator and online help system,  Up: Development Tools

5.27.1 ‘typing’ — Support for type hints
----------------------------------------

New in version 3.5.

`Source code:' Lib/typing.py(1)

     Note: The Python runtime does not enforce function and variable
     type annotations.  They can be used by third party tools such as
     type checkers, IDEs, linters, etc.

__________________________________________________________________

This module provides runtime support for type hints as specified by PEP
484(2), PEP 526(3), PEP 544(4), PEP 586(5), PEP 589(6), and PEP 591(7).
The most fundamental support consists of the types *note Any: 646, *note
Union: f6c, *note Tuple: 31a5, *note Callable: 31a6, *note TypeVar:
31a7, and *note Generic: 31a8.  For full specification please see PEP
484(8).  For a simplified introduction to type hints see PEP 483(9).

The function below takes and returns a string and is annotated as
follows:

     def greeting(name: str) -> str:     return 'Hello ' + name

In the function ‘greeting’, the argument ‘name’ is expected to be of
type *note str: 325. and the return type *note str: 325.  Subtypes are
accepted as arguments.

* Menu:

* Type aliases::
* NewType::
* Callable::
* Generics::
* User-defined generic types::
* The Any type::
* Nominal vs structural subtyping::
* Classes, functions, and decorators: Classes functions and decorators.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/typing.py

   (2) https://www.python.org/dev/peps/pep-0484

   (3) https://www.python.org/dev/peps/pep-0526

   (4) https://www.python.org/dev/peps/pep-0544

   (5) https://www.python.org/dev/peps/pep-0586

   (6) https://www.python.org/dev/peps/pep-0589

   (7) https://www.python.org/dev/peps/pep-0591

   (8) https://www.python.org/dev/peps/pep-0484

   (9) https://www.python.org/dev/peps/pep-0483


File: python.info,  Node: Type aliases,  Next: NewType,  Up: typing — Support for type hints

5.27.1.1 Type aliases
.....................

A type alias is defined by assigning the type to the alias.  In this
example, ‘Vector’ and ‘List[float]’ will be treated as interchangeable
synonyms:

     from typing import List Vector = List[float]  def scale(scalar: float, vector: Vector) -> Vector:     return [scalar * num for num in vector]  # typechecks; a list of floats qualifies as a Vector. new_vector = scale(2.0, [1.0, -4.2, 5.4])

Type aliases are useful for simplifying complex type signatures.  For
example:

     from typing import Dict, Tuple, Sequence  ConnectionOptions = Dict[str, str] Address = Tuple[str, int] Server = Tuple[Address, ConnectionOptions]  def broadcast_message(message: str, servers: Sequence[Server]) -> None:     ...  # The static type checker will treat the previous type signature as # being exactly equivalent to this one. def broadcast_message(         message: str,         servers: Sequence[Tuple[Tuple[str, int], Dict[str, str]]]) -> None:     ...

Note that ‘None’ as a type hint is a special case and is replaced by
‘type(None)’.


File: python.info,  Node: NewType,  Next: Callable,  Prev: Type aliases,  Up: typing — Support for type hints

5.27.1.2 NewType
................

Use the *note NewType(): 59a. helper function to create distinct types:

     from typing import NewType  UserId = NewType('UserId', int) some_id = UserId(524313)

The static type checker will treat the new type as if it were a subclass
of the original type.  This is useful in helping catch logical errors:

     def get_user_name(user_id: UserId) -> str:     ...  # typechecks user_a = get_user_name(UserId(42351))  # does not typecheck; an int is not a UserId user_b = get_user_name(-1)

You may still perform all ‘int’ operations on a variable of type
‘UserId’, but the result will always be of type ‘int’.  This lets you
pass in a ‘UserId’ wherever an ‘int’ might be expected, but will prevent
you from accidentally creating a ‘UserId’ in an invalid way:

     # 'output' is of type 'int', not 'UserId' output = UserId(23413) + UserId(54341)

Note that these checks are enforced only by the static type checker.  At
runtime, the statement ‘Derived = NewType('Derived', Base)’ will make
‘Derived’ a function that immediately returns whatever parameter you
pass it.  That means the expression ‘Derived(some_value)’ does not
create a new class or introduce any overhead beyond that of a regular
function call.

More precisely, the expression ‘some_value is Derived(some_value)’ is
always true at runtime.

This also means that it is not possible to create a subtype of ‘Derived’
since it is an identity function at runtime, not an actual type:

     from typing import NewType  UserId = NewType('UserId', int)  # Fails at runtime and does not typecheck class AdminUserId(UserId): pass

However, it is possible to create a *note NewType(): 59a. based on a
‘derived’ ‘NewType’:

     from typing import NewType  UserId = NewType('UserId', int)  ProUserId = NewType('ProUserId', UserId)

and typechecking for ‘ProUserId’ will work as expected.

See PEP 484(1) for more details.

     Note: Recall that the use of a type alias declares two types to be
     `equivalent' to one another.  Doing ‘Alias = Original’ will make
     the static type checker treat ‘Alias’ as being `exactly equivalent'
     to ‘Original’ in all cases.  This is useful when you want to
     simplify complex type signatures.

     In contrast, ‘NewType’ declares one type to be a `subtype' of
     another.  Doing ‘Derived = NewType('Derived', Original)’ will make
     the static type checker treat ‘Derived’ as a `subclass' of
     ‘Original’, which means a value of type ‘Original’ cannot be used
     in places where a value of type ‘Derived’ is expected.  This is
     useful when you want to prevent logic errors with minimal runtime
     cost.

New in version 3.5.2.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484


File: python.info,  Node: Callable,  Next: Generics,  Prev: NewType,  Up: typing — Support for type hints

5.27.1.3 Callable
.................

Frameworks expecting callback functions of specific signatures might be
type hinted using ‘Callable[[Arg1Type, Arg2Type], ReturnType]’.

For example:

     from typing import Callable  def feeder(get_next_item: Callable[[], str]) -> None:     # Body  def async_query(on_success: Callable[[int], None],                 on_error: Callable[[int, Exception], None]) -> None:     # Body

It is possible to declare the return type of a callable without
specifying the call signature by substituting a literal ellipsis for the
list of arguments in the type hint: ‘Callable[..., ReturnType]’.


File: python.info,  Node: Generics,  Next: User-defined generic types,  Prev: Callable,  Up: typing — Support for type hints

5.27.1.4 Generics
.................

Since type information about objects kept in containers cannot be
statically inferred in a generic way, abstract base classes have been
extended to support subscription to denote expected types for container
elements.

     from typing import Mapping, Sequence  def notify_by_email(employees: Sequence[Employee],                     overrides: Mapping[str, str]) -> None: ...

Generics can be parameterized by using a new factory available in typing
called *note TypeVar: 31a7.

     from typing import Sequence, TypeVar  T = TypeVar('T')      # Declare type variable  def first(l: Sequence[T]) -> T:   # Generic function     return l[0]


File: python.info,  Node: User-defined generic types,  Next: The Any type,  Prev: Generics,  Up: typing — Support for type hints

5.27.1.5 User-defined generic types
...................................

A user-defined class can be defined as a generic class.

     from typing import TypeVar, Generic from logging import Logger  T = TypeVar('T')  class LoggedVar(Generic[T]):     def __init__(self, value: T, name: str, logger: Logger) -> None:         self.name = name         self.logger = logger         self.value = value      def set(self, new: T) -> None:         self.log('Set ' + repr(self.value))         self.value = new      def get(self) -> T:         self.log('Get ' + repr(self.value))         return self.value      def log(self, message: str) -> None:         self.logger.info('%s: %s', self.name, message)

‘Generic[T]’ as a base class defines that the class ‘LoggedVar’ takes a
single type parameter ‘T’ .  This also makes ‘T’ valid as a type within
the class body.

The *note Generic: 31a8. base class defines *note __class_getitem__():
31c. so that ‘LoggedVar[t]’ is valid as a type:

     from typing import Iterable  def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:     for var in vars:         var.set(0)

A generic type can have any number of type variables, and type variables
may be constrained:

     from typing import TypeVar, Generic ...  T = TypeVar('T') S = TypeVar('S', int, str)  class StrangePair(Generic[T, S]):     ...

Each type variable argument to *note Generic: 31a8. must be distinct.
This is thus invalid:

     from typing import TypeVar, Generic ...  T = TypeVar('T')  class Pair(Generic[T, T]):   # INVALID     ...

You can use multiple inheritance with *note Generic: 31a8.:

     from typing import TypeVar, Generic, Sized  T = TypeVar('T')  class LinkedList(Sized, Generic[T]):     ...

When inheriting from generic classes, some type variables could be
fixed:

     from typing import TypeVar, Mapping  T = TypeVar('T')  class MyDict(Mapping[str, T]):     ...

In this case ‘MyDict’ has a single parameter, ‘T’.

Using a generic class without specifying type parameters assumes *note
Any: 646. for each position.  In the following example, ‘MyIterable’ is
not generic but implicitly inherits from ‘Iterable[Any]’:

     from typing import Iterable  class MyIterable(Iterable): # Same as Iterable[Any]

User defined generic type aliases are also supported.  Examples:

     from typing import TypeVar, Iterable, Tuple, Union S = TypeVar('S') Response = Union[Iterable[S], int]  # Return type here is same as Union[Iterable[str], int] def response(query: str) -> Response[str]:     ...  T = TypeVar('T', int, float, complex) Vec = Iterable[Tuple[T, T]]  def inproduct(v: Vec[T]) -> T: # Same as Iterable[Tuple[T, T]]     return sum(x*y for x, y in v)

Changed in version 3.7: *note Generic: 31a8. no longer has a custom
metaclass.

A user-defined generic class can have ABCs as base classes without a
metaclass conflict.  Generic metaclasses are not supported.  The outcome
of parameterizing generics is cached, and most types in the typing
module are hashable and comparable for equality.


File: python.info,  Node: The Any type,  Next: Nominal vs structural subtyping,  Prev: User-defined generic types,  Up: typing — Support for type hints

5.27.1.6 The ‘Any’ type
.......................

A special kind of type is *note Any: 646.  A static type checker will
treat every type as being compatible with *note Any: 646. and *note Any:
646. as being compatible with every type.

This means that it is possible to perform any operation or method call
on a value of type on *note Any: 646. and assign it to any variable:

     from typing import Any  a = None    # type: Any a = []      # OK a = 2       # OK  s = ''      # type: str s = a       # OK  def foo(item: Any) -> int:     # Typechecks; 'item' could be any type,     # and that type might have a 'bar' method     item.bar()     ...

Notice that no typechecking is performed when assigning a value of type
*note Any: 646. to a more precise type.  For example, the static type
checker did not report an error when assigning ‘a’ to ‘s’ even though
‘s’ was declared to be of type *note str: 325. and receives an *note
int: 184. value at runtime!

Furthermore, all functions without a return type or parameter types will
implicitly default to using *note Any: 646.:

     def legacy_parser(text):     ...     return data  # A static type checker will treat the above # as having the same signature as: def legacy_parser(text: Any) -> Any:     ...     return data

This behavior allows *note Any: 646. to be used as an `escape hatch'
when you need to mix dynamically and statically typed code.

Contrast the behavior of *note Any: 646. with the behavior of *note
object: 2ae.  Similar to *note Any: 646, every type is a subtype of
*note object: 2ae.  However, unlike *note Any: 646, the reverse is not
true: *note object: 2ae. is `not' a subtype of every other type.

That means when the type of a value is *note object: 2ae, a type checker
will reject almost all operations on it, and assigning it to a variable
(or using it as a return value) of a more specialized type is a type
error.  For example:

     def hash_a(item: object) -> int:     # Fails; an object does not have a 'magic' method.     item.magic()     ...  def hash_b(item: Any) -> int:     # Typechecks     item.magic()     ...  # Typechecks, since ints and strs are subclasses of object hash_a(42) hash_a("foo")  # Typechecks, since Any is compatible with all types hash_b(42) hash_b("foo")

Use *note object: 2ae. to indicate that a value could be any type in a
typesafe manner.  Use *note Any: 646. to indicate that a value is
dynamically typed.


File: python.info,  Node: Nominal vs structural subtyping,  Next: Classes functions and decorators,  Prev: The Any type,  Up: typing — Support for type hints

5.27.1.7 Nominal vs structural subtyping
........................................

Initially PEP 484(1) defined Python static type system as using `nominal
subtyping'.  This means that a class ‘A’ is allowed where a class ‘B’ is
expected if and only if ‘A’ is a subclass of ‘B’.

This requirement previously also applied to abstract base classes, such
as *note Iterable: 31b2.  The problem with this approach is that a class
had to be explicitly marked to support them, which is unpythonic and
unlike what one would normally do in idiomatic dynamically typed Python
code.  For example, this conforms to the PEP 484(2):

     from typing import Sized, Iterable, Iterator  class Bucket(Sized, Iterable[int]):     ...     def __len__(self) -> int: ...     def __iter__(self) -> Iterator[int]: ...

PEP 544(3) allows to solve this problem by allowing users to write the
above code without explicit base classes in the class definition,
allowing ‘Bucket’ to be implicitly considered a subtype of both ‘Sized’
and ‘Iterable[int]’ by static type checkers.  This is known as
`structural subtyping' (or static duck-typing):

     from typing import Iterator, Iterable  class Bucket:  # Note: no base classes     ...     def __len__(self) -> int: ...     def __iter__(self) -> Iterator[int]: ...  def collect(items: Iterable[int]) -> int: ... result = collect(Bucket())  # Passes type check

Moreover, by subclassing a special class *note Protocol: 23d, a user can
define new custom protocols to fully enjoy structural subtyping (see
examples below).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484

   (2) https://www.python.org/dev/peps/pep-0484

   (3) https://www.python.org/dev/peps/pep-0544


File: python.info,  Node: Classes functions and decorators,  Prev: Nominal vs structural subtyping,  Up: typing — Support for type hints

5.27.1.8 Classes, functions, and decorators
...........................................

The module defines the following classes, functions and decorators:

 -- Class: typing.TypeVar

     Type variable.

     Usage:

          T = TypeVar('T')  # Can be anything A = TypeVar('A', str, bytes)  # Must be str or bytes

     Type variables exist primarily for the benefit of static type
     checkers.  They serve as the parameters for generic types as well
     as for generic function definitions.  See class Generic for more
     information on generic types.  Generic functions work as follows:

          def repeat(x: T, n: int) -> Sequence[T]:     """Return a list containing n references to x."""     return [x]*n  def longest(x: A, y: A) -> A:     """Return the longest of two strings."""     return x if len(x) >= len(y) else y

     The latter example’s signature is essentially the overloading of
     ‘(str, str) -> str’ and ‘(bytes, bytes) -> bytes’.  Also note that
     if the arguments are instances of some subclass of *note str: 325,
     the return type is still plain *note str: 325.

     At runtime, ‘isinstance(x, T)’ will raise *note TypeError: 192.  In
     general, *note isinstance(): 444. and *note issubclass(): 445.
     should not be used with types.

     Type variables may be marked covariant or contravariant by passing
     ‘covariant=True’ or ‘contravariant=True’.  See PEP 484(1) for more
     details.  By default type variables are invariant.  Alternatively,
     a type variable may specify an upper bound using ‘bound=<type>’.
     This means that an actual type substituted (explicitly or
     implicitly) for the type variable must be a subclass of the
     boundary type, see PEP 484(2).

 -- Class: typing.Generic

     Abstract base class for generic types.

     A generic type is typically declared by inheriting from an
     instantiation of this class with one or more type variables.  For
     example, a generic mapping type might be defined as:

          class Mapping(Generic[KT, VT]):     def __getitem__(self, key: KT) -> VT:         ...         # Etc.

     This class can then be used as follows:

          X = TypeVar('X') Y = TypeVar('Y')  def lookup_name(mapping: Mapping[X, Y], key: X, default: Y) -> Y:     try:         return mapping[key]     except KeyError:         return default

 -- Class: typing.Protocol (Generic)

     Base class for protocol classes.  Protocol classes are defined like
     this:

          class Proto(Protocol):     def meth(self) -> int:         ...

     Such classes are primarily used with static type checkers that
     recognize structural subtyping (static duck-typing), for example:

          class C:     def meth(self) -> int:         return 0  def func(x: Proto) -> int:     return x.meth()  func(C())  # Passes static type check

     See PEP 544(3) for details.  Protocol classes decorated with *note
     runtime_checkable(): 23e. (described later) act as simple-minded
     runtime protocols that check only the presence of given attributes,
     ignoring their type signatures.

     Protocol classes can be generic, for example:

          class GenProto(Protocol[T]):     def meth(self) -> T:         ...

     New in version 3.8.

 -- Class: typing.Type (Generic[CT_co])

     A variable annotated with ‘C’ may accept a value of type ‘C’.  In
     contrast, a variable annotated with ‘Type[C]’ may accept values
     that are classes themselves – specifically, it will accept the
     `class object' of ‘C’.  For example:

          a = 3         # Has type 'int' b = int       # Has type 'Type[int]' c = type(a)   # Also has type 'Type[int]'

     Note that ‘Type[C]’ is covariant:

          class User: ... class BasicUser(User): ... class ProUser(User): ... class TeamUser(User): ...  # Accepts User, BasicUser, ProUser, TeamUser, ... def make_new_user(user_class: Type[User]) -> User:     # ...     return user_class()

     The fact that ‘Type[C]’ is covariant implies that all subclasses of
     ‘C’ should implement the same constructor signature and class
     method signatures as ‘C’.  The type checker should flag violations
     of this, but should also allow constructor calls in subclasses that
     match the constructor calls in the indicated base class.  How the
     type checker is required to handle this particular case may change
     in future revisions of PEP 484(4).

     The only legal parameters for *note Type: 31b4. are classes, *note
     Any: 646, *note type variables: 31ad, and unions of any of these
     types.  For example:

          def new_non_team_user(user_class: Type[Union[BaseUser, ProUser]]): ...

     ‘Type[Any]’ is equivalent to ‘Type’ which in turn is equivalent to
     ‘type’, which is the root of Python’s metaclass hierarchy.

     New in version 3.5.2.

 -- Class: typing.Iterable (Generic[T_co])

     A generic version of *note collections.abc.Iterable: 188b.

 -- Class: typing.Iterator (Iterable[T_co])

     A generic version of *note collections.abc.Iterator: 188c.

 -- Class: typing.Reversible (Iterable[T_co])

     A generic version of *note collections.abc.Reversible: 523.

 -- Class: typing.SupportsInt

     An ABC with one abstract method ‘__int__’.

 -- Class: typing.SupportsFloat

     An ABC with one abstract method ‘__float__’.

 -- Class: typing.SupportsComplex

     An ABC with one abstract method ‘__complex__’.

 -- Class: typing.SupportsBytes

     An ABC with one abstract method ‘__bytes__’.

 -- Class: typing.SupportsIndex

     An ABC with one abstract method ‘__index__’.

     New in version 3.8.

 -- Class: typing.SupportsAbs

     An ABC with one abstract method ‘__abs__’ that is covariant in its
     return type.

 -- Class: typing.SupportsRound

     An ABC with one abstract method ‘__round__’ that is covariant in
     its return type.

 -- Class: typing.Container (Generic[T_co])

     A generic version of *note collections.abc.Container: 1889.

 -- Class: typing.Hashable

     An alias to *note collections.abc.Hashable: 188a.

 -- Class: typing.Sized

     An alias to *note collections.abc.Sized: 188d.

 -- Class: typing.Collection (Sized, Iterable[T_co], Container[T_co])

     A generic version of *note collections.abc.Collection: 522.

     New in version 3.6.0.

 -- Class: typing.AbstractSet (Sized, Collection[T_co])

     A generic version of *note collections.abc.Set: 1616.

 -- Class: typing.MutableSet (AbstractSet[T])

     A generic version of *note collections.abc.MutableSet: 1890.

 -- Class: typing.Mapping (Sized, Collection[KT], Generic[VT_co])

     A generic version of *note collections.abc.Mapping: 187d.  This
     type can be used as follows:

          def get_position_in_index(word_list: Mapping[str, int], word: str) -> int:     return word_list[word]

 -- Class: typing.MutableMapping (Mapping[KT, VT])

     A generic version of *note collections.abc.MutableMapping: 9e3.

 -- Class: typing.Sequence (Reversible[T_co], Collection[T_co])

     A generic version of *note collections.abc.Sequence: 156b.

 -- Class: typing.MutableSequence (Sequence[T])

     A generic version of *note collections.abc.MutableSequence: 6a0.

 -- Class: typing.ByteString (Sequence[int])

     A generic version of *note collections.abc.ByteString: 188f.

     This type represents the types *note bytes: 326, *note bytearray:
     327, and *note memoryview: 25a.

     As a shorthand for this type, *note bytes: 326. can be used to
     annotate arguments of any of the types mentioned above.

 -- Class: typing.Deque (deque, MutableSequence[T])

     A generic version of *note collections.deque: 526.

     New in version 3.5.4.

     New in version 3.6.1.

 -- Class: typing.List (list, MutableSequence[T])

     Generic version of *note list: 260.  Useful for annotating return
     types.  To annotate arguments it is preferred to use an abstract
     collection type such as *note Sequence: 31c3. or *note Iterable:
     31b2.

     This type may be used as follows:

          T = TypeVar('T', int, float)  def vec2(x: T, y: T) -> List[T]:     return [x, y]  def keep_positives(vector: Sequence[T]) -> List[T]:     return [item for item in vector if item > 0]

 -- Class: typing.Set (set, MutableSet[T])

     A generic version of *note builtins.set: b62.  Useful for
     annotating return types.  To annotate arguments it is preferred to
     use an abstract collection type such as *note AbstractSet: 31bf.

 -- Class: typing.FrozenSet (frozenset, AbstractSet[T_co])

     A generic version of *note builtins.frozenset: be1.

 -- Class: typing.MappingView (Sized, Iterable[T_co])

     A generic version of *note collections.abc.MappingView: 1891.

 -- Class: typing.KeysView (MappingView[KT_co], AbstractSet[KT_co])

     A generic version of *note collections.abc.KeysView: 1893.

 -- Class: typing.ItemsView (MappingView, Generic[KT_co, VT_co])

     A generic version of *note collections.abc.ItemsView: 1892.

 -- Class: typing.ValuesView (MappingView[VT_co])

     A generic version of *note collections.abc.ValuesView: 1894.

 -- Class: typing.Awaitable (Generic[T_co])

     A generic version of *note collections.abc.Awaitable: 6aa.

     New in version 3.5.2.

 -- Class: typing.Coroutine (Awaitable[V_co], Generic[T_co T_contra,
          V_co])

     A generic version of *note collections.abc.Coroutine: 6ab.  The
     variance and order of type variables correspond to those of *note
     Generator: 31d0, for example:

          from typing import List, Coroutine c = None # type: Coroutine[List[str], str, int] ... x = c.send('hi') # type: List[str] async def bar() -> None:     x = await c # type: int

     New in version 3.5.3.

 -- Class: typing.AsyncIterable (Generic[T_co])

     A generic version of *note collections.abc.AsyncIterable: 6ad.

     New in version 3.5.2.

 -- Class: typing.AsyncIterator (AsyncIterable[T_co])

     A generic version of *note collections.abc.AsyncIterator: 6ac.

     New in version 3.5.2.

 -- Class: typing.ContextManager (Generic[T_co])

     A generic version of *note contextlib.AbstractContextManager: 529.

     New in version 3.5.4.

     New in version 3.6.0.

 -- Class: typing.AsyncContextManager (Generic[T_co])

     A generic version of *note contextlib.AbstractAsyncContextManager:
     36d.

     New in version 3.5.4.

     New in version 3.6.2.

 -- Class: typing.Dict (dict, MutableMapping[KT, VT])

     A generic version of *note dict: 1b6.  Useful for annotating return
     types.  To annotate arguments it is preferred to use an abstract
     collection type such as *note Mapping: 31c1.

     This type can be used as follows:

          def count_words(text: str) -> Dict[str, int]:     ...

 -- Class: typing.DefaultDict (collections.defaultdict,
          MutableMapping[KT, VT])

     A generic version of *note collections.defaultdict: b2d.

     New in version 3.5.2.

 -- Class: typing.OrderedDict (collections.OrderedDict,
          MutableMapping[KT, VT])

     A generic version of *note collections.OrderedDict: 1b7.

     New in version 3.7.2.

 -- Class: typing.Counter (collections.Counter, Dict[T, int])

     A generic version of *note collections.Counter: 9ce.

     New in version 3.5.4.

     New in version 3.6.1.

 -- Class: typing.ChainMap (collections.ChainMap, MutableMapping[KT,
          VT])

     A generic version of *note collections.ChainMap: 49f.

     New in version 3.5.4.

     New in version 3.6.1.

 -- Class: typing.Generator (Iterator[T_co], Generic[T_co, T_contra,
          V_co])

     A generator can be annotated by the generic type
     ‘Generator[YieldType, SendType, ReturnType]’.  For example:

          def echo_round() -> Generator[int, float, str]:     sent = yield 0     while sent >= 0:         sent = yield round(sent)     return 'Done'

     Note that unlike many other generics in the typing module, the
     ‘SendType’ of *note Generator: 31d0. behaves contravariantly, not
     covariantly or invariantly.

     If your generator will only yield values, set the ‘SendType’ and
     ‘ReturnType’ to ‘None’:

          def infinite_stream(start: int) -> Generator[int, None, None]:     while True:         yield start         start += 1

     Alternatively, annotate your generator as having a return type of
     either ‘Iterable[YieldType]’ or ‘Iterator[YieldType]’:

          def infinite_stream(start: int) -> Iterator[int]:     while True:         yield start         start += 1

 -- Class: typing.AsyncGenerator (AsyncIterator[T_co], Generic[T_co,
          T_contra])

     An async generator can be annotated by the generic type
     ‘AsyncGenerator[YieldType, SendType]’.  For example:

          async def echo_round() -> AsyncGenerator[int, float]:     sent = yield 0     while sent >= 0.0:         rounded = await round(sent)         sent = yield rounded

     Unlike normal generators, async generators cannot return a value,
     so there is no ‘ReturnType’ type parameter.  As with *note
     Generator: 31d0, the ‘SendType’ behaves contravariantly.

     If your generator will only yield values, set the ‘SendType’ to
     ‘None’:

          async def infinite_stream(start: int) -> AsyncGenerator[int, None]:     while True:         yield start         start = await increment(start)

     Alternatively, annotate your generator as having a return type of
     either ‘AsyncIterable[YieldType]’ or ‘AsyncIterator[YieldType]’:

          async def infinite_stream(start: int) -> AsyncIterator[int]:     while True:         yield start         start = await increment(start)

     New in version 3.6.1.

 -- Class: typing.Text

     ‘Text’ is an alias for ‘str’.  It is provided to supply a forward
     compatible path for Python 2 code: in Python 2, ‘Text’ is an alias
     for ‘unicode’.

     Use ‘Text’ to indicate that a value must contain a unicode string
     in a manner that is compatible with both Python 2 and Python 3:

          def add_unicode_checkmark(text: Text) -> Text:     return text + u' \u2713'

     New in version 3.5.2.

 -- Class: typing.IO
 -- Class: typing.TextIO
 -- Class: typing.BinaryIO

     Generic type ‘IO[AnyStr]’ and its subclasses ‘TextIO(IO[str])’ and
     ‘BinaryIO(IO[bytes])’ represent the types of I/O streams such as
     returned by *note open(): 4e5.

 -- Class: typing.Pattern
 -- Class: typing.Match

     These type aliases correspond to the return types from *note
     re.compile(): 43f. and *note re.match(): ba6.  These types (and the
     corresponding functions) are generic in ‘AnyStr’ and can be made
     specific by writing ‘Pattern[str]’, ‘Pattern[bytes]’, ‘Match[str]’,
     or ‘Match[bytes]’.

 -- Class: typing.NamedTuple

     Typed version of *note collections.namedtuple(): 1b5.

     Usage:

          class Employee(NamedTuple):     name: str     id: int

     This is equivalent to:

          Employee = collections.namedtuple('Employee', ['name', 'id'])

     To give a field a default value, you can assign to it in the class
     body:

          class Employee(NamedTuple):     name: str     id: int = 3  employee = Employee('Guido') assert employee.id == 3

     Fields with a default value must come after any fields without a
     default.

     The resulting class has an extra attribute ‘__annotations__’ giving
     a dict that maps the field names to the field types.  (The field
     names are in the ‘_fields’ attribute and the default values are in
     the ‘_field_defaults’ attribute both of which are part of the
     namedtuple API.)

     ‘NamedTuple’ subclasses can also have docstrings and methods:

          class Employee(NamedTuple):     """Represents an employee."""     name: str     id: int = 3      def __repr__(self) -> str:         return f'<Employee {self.name}, id={self.id}>'

     Backward-compatible usage:

          Employee = NamedTuple('Employee', [('name', str), ('id', int)])

     Changed in version 3.6: Added support for PEP 526(5) variable
     annotation syntax.

     Changed in version 3.6.1: Added support for default values,
     methods, and docstrings.

     Changed in version 3.8: Deprecated the ‘_field_types’ attribute in
     favor of the more standard ‘__annotations__’ attribute which has
     the same information.

     Changed in version 3.8: The ‘_field_types’ and ‘__annotations__’
     attributes are now regular dictionaries instead of instances of
     ‘OrderedDict’.

 -- Class: typing.TypedDict (dict)

     A simple typed namespace.  At runtime it is equivalent to a plain
     *note dict: 1b6.

     ‘TypedDict’ creates a dictionary type that expects all of its
     instances to have a certain set of keys, where each key is
     associated with a value of a consistent type.  This expectation is
     not checked at runtime but is only enforced by type checkers.
     Usage:

          class Point2D(TypedDict):     x: int     y: int     label: str  a: Point2D = {'x': 1, 'y': 2, 'label': 'good'}  # OK b: Point2D = {'z': 3, 'label': 'bad'}           # Fails type check  assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')

     The type info for introspection can be accessed via
     ‘Point2D.__annotations__’ and ‘Point2D.__total__’.  To allow using
     this feature with older versions of Python that do not support PEP
     526(6), ‘TypedDict’ supports two additional equivalent syntactic
     forms:

          Point2D = TypedDict('Point2D', x=int, y=int, label=str) Point2D = TypedDict('Point2D', {'x': int, 'y': int, 'label': str})

     See PEP 589(7) for more examples and detailed rules of using
     ‘TypedDict’ with type checkers.

     New in version 3.8.

 -- Class: typing.ForwardRef

     A class used for internal typing representation of string forward
     references.  For example, ‘List["SomeClass"]’ is implicitly
     transformed into ‘List[ForwardRef("SomeClass")]’.  This class
     should not be instantiated by a user, but may be used by
     introspection tools.

 -- Function: typing.NewType (typ)

     A helper function to indicate a distinct types to a typechecker,
     see *note NewType: 31aa.  At runtime it returns a function that
     returns its argument.  Usage:

          UserId = NewType('UserId', int) first_user = UserId(1)

     New in version 3.5.2.

 -- Function: typing.cast (typ, val)

     Cast a value to a type.

     This returns the value unchanged.  To the type checker this signals
     that the return value has the designated type, but at runtime we
     intentionally don’t check anything (we want this to be as fast as
     possible).

 -- Function: typing.get_type_hints (obj[, globals[, locals]])

     Return a dictionary containing type hints for a function, method,
     module or class object.

     This is often the same as ‘obj.__annotations__’.  In addition,
     forward references encoded as string literals are handled by
     evaluating them in ‘globals’ and ‘locals’ namespaces.  If
     necessary, ‘Optional[t]’ is added for function and method
     annotations if a default value equal to ‘None’ is set.  For a class
     ‘C’, return a dictionary constructed by merging all the
     ‘__annotations__’ along ‘C.__mro__’ in reverse order.

 -- Function: typing.get_origin (tp)

 -- Function: typing.get_args (tp)

     Provide basic introspection for generic types and special typing
     forms.

     For a typing object of the form ‘X[Y, Z, ...]’ these functions
     return ‘X’ and ‘(Y, Z, ...)’.  If ‘X’ is a generic alias for a
     builtin or *note collections: 1e. class, it gets normalized to the
     original class.  For unsupported objects return ‘None’ and ‘()’
     correspondingly.  Examples:

          assert get_origin(Dict[str, int]) is dict assert get_args(Dict[int, str]) == (int, str)  assert get_origin(Union[int, str]) is Union assert get_args(Union[int, str]) == (int, str)

     New in version 3.8.

 -- Function: @typing.overload

     The ‘@overload’ decorator allows describing functions and methods
     that support multiple different combinations of argument types.  A
     series of ‘@overload’-decorated definitions must be followed by
     exactly one non-‘@overload’-decorated definition (for the same
     function/method).  The ‘@overload’-decorated definitions are for
     the benefit of the type checker only, since they will be
     overwritten by the non-‘@overload’-decorated definition, while the
     latter is used at runtime but should be ignored by a type checker.
     At runtime, calling a ‘@overload’-decorated function directly will
     raise *note NotImplementedError: 603.  An example of overload that
     gives a more precise type than can be expressed using a union or a
     type variable:

          @overload def process(response: None) -> None:     ... @overload def process(response: int) -> Tuple[int, str]:     ... @overload def process(response: bytes) -> str:     ... def process(response):     <actual implementation>

     See PEP 484(8) for details and comparison with other typing
     semantics.

 -- Function: @typing.final

     A decorator to indicate to type checkers that the decorated method
     cannot be overridden, and the decorated class cannot be subclassed.
     For example:

          class Base:     @final     def done(self) -> None:         ... class Sub(Base):     def done(self) -> None:  # Error reported by type checker           ...  @final class Leaf:     ... class Other(Leaf):  # Error reported by type checker     ...

     There is no runtime checking of these properties.  See PEP 591(9)
     for more details.

     New in version 3.8.

 -- Function: @typing.no_type_check

     Decorator to indicate that annotations are not type hints.

     This works as class or function *note decorator: 281.  With a
     class, it applies recursively to all methods defined in that class
     (but not to methods defined in its superclasses or subclasses).

     This mutates the function(s) in place.

 -- Function: @typing.no_type_check_decorator

     Decorator to give another decorator the *note no_type_check():
     31e3. effect.

     This wraps the decorator with something that wraps the decorated
     function in *note no_type_check(): 31e3.

 -- Function: @typing.type_check_only

     Decorator to mark a class or function to be unavailable at runtime.

     This decorator is itself not available at runtime.  It is mainly
     intended to mark classes that are defined in type stub files if an
     implementation returns an instance of a private class:

          @type_check_only class Response:  # private or not available at runtime     code: int     def get_header(self, name: str) -> str: ...  def fetch_response() -> Response: ...

     Note that returning instances of private classes is not
     recommended.  It is usually preferable to make such classes public.

 -- Function: @typing.runtime_checkable

     Mark a protocol class as a runtime protocol.

     Such a protocol can be used with *note isinstance(): 444. and *note
     issubclass(): 445.  This raises *note TypeError: 192. when applied
     to a non-protocol class.  This allows a simple-minded structural
     check, very similar to “one trick ponies” in *note collections.abc:
     1f. such as *note Iterable: 31b2.  For example:

          @runtime_checkable class Closable(Protocol):     def close(self): ...  assert isinstance(open('/some/file'), Closable)

     `Warning:' this will check only the presence of the required
     methods, not their type signatures!

     New in version 3.8.

 -- Data: typing.Any

     Special type indicating an unconstrained type.

        * Every type is compatible with *note Any: 646.

        * *note Any: 646. is compatible with every type.

 -- Data: typing.NoReturn

     Special type indicating that a function never returns.  For
     example:

          from typing import NoReturn  def stop() -> NoReturn:     raise RuntimeError('no way')

     New in version 3.5.4.

     New in version 3.6.2.

 -- Data: typing.Union

     Union type; ‘Union[X, Y]’ means either X or Y.

     To define a union, use e.g.  ‘Union[int, str]’.  Details:

        * The arguments must be types and there must be at least one.

        * Unions of unions are flattened, e.g.:

               Union[Union[int, str], float] == Union[int, str, float]

        * Unions of a single argument vanish, e.g.:

               Union[int] == int  # The constructor actually returns int

        * Redundant arguments are skipped, e.g.:

               Union[int, str, int] == Union[int, str]

        * When comparing unions, the argument order is ignored, e.g.:

               Union[int, str] == Union[str, int]

        * You cannot subclass or instantiate a union.

        * You cannot write ‘Union[X][Y]’.

        * You can use ‘Optional[X]’ as a shorthand for ‘Union[X, None]’.

     Changed in version 3.7: Don’t remove explicit subclasses from
     unions at runtime.

 -- Data: typing.Optional

     Optional type.

     ‘Optional[X]’ is equivalent to ‘Union[X, None]’.

     Note that this is not the same concept as an optional argument,
     which is one that has a default.  An optional argument with a
     default does not require the ‘Optional’ qualifier on its type
     annotation just because it is optional.  For example:

          def foo(arg: int = 0) -> None:     ...

     On the other hand, if an explicit value of ‘None’ is allowed, the
     use of ‘Optional’ is appropriate, whether the argument is optional
     or not.  For example:

          def foo(arg: Optional[int] = None) -> None:     ...

 -- Data: typing.Tuple

     Tuple type; ‘Tuple[X, Y]’ is the type of a tuple of two items with
     the first item of type X and the second of type Y. The type of the
     empty tuple can be written as ‘Tuple[()]’.

     Example: ‘Tuple[T1, T2]’ is a tuple of two elements corresponding
     to type variables T1 and T2.  ‘Tuple[int, float, str]’ is a tuple
     of an int, a float and a string.

     To specify a variable-length tuple of homogeneous type, use literal
     ellipsis, e.g.  ‘Tuple[int, ...]’.  A plain *note Tuple: 31a5. is
     equivalent to ‘Tuple[Any, ...]’, and in turn to *note tuple: 473.

 -- Data: typing.Callable

     Callable type; ‘Callable[[int], str]’ is a function of (int) ->
     str.

     The subscription syntax must always be used with exactly two
     values: the argument list and the return type.  The argument list
     must be a list of types or an ellipsis; the return type must be a
     single type.

     There is no syntax to indicate optional or keyword arguments; such
     function types are rarely used as callback types.  ‘Callable[...,
     ReturnType]’ (literal ellipsis) can be used to type hint a callable
     taking any number of arguments and returning ‘ReturnType’.  A plain
     *note Callable: 31a6. is equivalent to ‘Callable[..., Any]’, and in
     turn to *note collections.abc.Callable: 188e.

 -- Data: typing.Literal

     A type that can be used to indicate to type checkers that the
     corresponding variable or function parameter has a value equivalent
     to the provided literal (or one of several literals).  For example:

          def validate_simple(data: Any) -> Literal[True]:  # always returns True     ...  MODE = Literal['r', 'rb', 'w', 'wb'] def open_helper(file: str, mode: MODE) -> str:     ...  open_helper('/some/path', 'r')  # Passes type check open_helper('/other/path', 'typo')  # Error in type checker

     ‘Literal[...]’ cannot be subclassed.  At runtime, an arbitrary
     value is allowed as type argument to ‘Literal[...]’, but type
     checkers may impose restrictions.  See PEP 586(10) for more details
     about literal types.

     New in version 3.8.

 -- Data: typing.ClassVar

     Special type construct to mark class variables.

     As introduced in PEP 526(11), a variable annotation wrapped in
     ClassVar indicates that a given attribute is intended to be used as
     a class variable and should not be set on instances of that class.
     Usage:

          class Starship:     stats: ClassVar[Dict[str, int]] = {} # class variable     damage: int = 10                     # instance variable

     *note ClassVar: 598. accepts only types and cannot be further
     subscribed.

     *note ClassVar: 598. is not a class itself, and should not be used
     with *note isinstance(): 444. or *note issubclass(): 445.  *note
     ClassVar: 598. does not change Python runtime behavior, but it can
     be used by third-party type checkers.  For example, a type checker
     might flag the following code as an error:

          enterprise_d = Starship(3000) enterprise_d.stats = {} # Error, setting class variable on instance Starship.stats = {}     # This is OK

     New in version 3.5.3.

 -- Data: typing.Final

     A special typing construct to indicate to type checkers that a name
     cannot be re-assigned or overridden in a subclass.  For example:

          MAX_SIZE: Final = 9000 MAX_SIZE += 1  # Error reported by type checker  class Connection:     TIMEOUT: Final[int] = 10  class FastConnector(Connection):     TIMEOUT = 1  # Error reported by type checker

     There is no runtime checking of these properties.  See PEP 591(12)
     for more details.

     New in version 3.8.

 -- Data: typing.AnyStr

     ‘AnyStr’ is a type variable defined as ‘AnyStr = TypeVar('AnyStr',
     str, bytes)’.

     It is meant to be used for functions that may accept any kind of
     string without allowing different kinds of strings to mix.  For
     example:

          def concat(a: AnyStr, b: AnyStr) -> AnyStr:     return a + b  concat(u"foo", u"bar")  # Ok, output has type 'unicode' concat(b"foo", b"bar")  # Ok, output has type 'bytes' concat(u"foo", b"bar")  # Error, cannot mix unicode and bytes

 -- Data: typing.TYPE_CHECKING

     A special constant that is assumed to be ‘True’ by 3rd party static
     type checkers.  It is ‘False’ at runtime.  Usage:

          if TYPE_CHECKING:     import expensive_mod  def fun(arg: 'expensive_mod.SomeType') -> None:     local_var: expensive_mod.AnotherType = other_fun()

     Note that the first type annotation must be enclosed in quotes,
     making it a “forward reference”, to hide the ‘expensive_mod’
     reference from the interpreter runtime.  Type annotations for local
     variables are not evaluated, so the second annotation does not need
     to be enclosed in quotes.

     New in version 3.5.2.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484

   (2) https://www.python.org/dev/peps/pep-0484

   (3) https://www.python.org/dev/peps/pep-0544

   (4) https://www.python.org/dev/peps/pep-0484

   (5) https://www.python.org/dev/peps/pep-0526

   (6) https://www.python.org/dev/peps/pep-0526

   (7) https://www.python.org/dev/peps/pep-0589

   (8) https://www.python.org/dev/peps/pep-0484

   (9) https://www.python.org/dev/peps/pep-0591

   (10) https://www.python.org/dev/peps/pep-0586

   (11) https://www.python.org/dev/peps/pep-0526

   (12) https://www.python.org/dev/peps/pep-0591


File: python.info,  Node: pydoc — Documentation generator and online help system,  Next: doctest — Test interactive Python examples,  Prev: typing — Support for type hints,  Up: Development Tools

5.27.2 ‘pydoc’ — Documentation generator and online help system
---------------------------------------------------------------

`Source code:' Lib/pydoc.py(1)

__________________________________________________________________

The *note pydoc: d9. module automatically generates documentation from
Python modules.  The documentation can be presented as pages of text on
the console, served to a Web browser, or saved to HTML files.

For modules, classes, functions and methods, the displayed documentation
is derived from the docstring (i.e.  the ‘__doc__’ attribute) of the
object, and recursively of its documentable members.  If there is no
docstring, *note pydoc: d9. tries to obtain a description from the block
of comment lines just above the definition of the class, function or
method in the source file, or at the top of the module (see *note
inspect.getcomments(): 31eb.).

The built-in function *note help(): 567. invokes the online help system
in the interactive interpreter, which uses *note pydoc: d9. to generate
its documentation as text on the console.  The same text documentation
can also be viewed from outside the Python interpreter by running
‘pydoc’ as a script at the operating system’s command prompt.  For
example, running

     pydoc sys

at a shell prompt will display documentation on the *note sys: fd.
module, in a style similar to the manual pages shown by the Unix ‘man’
command.  The argument to ‘pydoc’ can be the name of a function, module,
or package, or a dotted reference to a class, method, or function within
a module or module in a package.  If the argument to ‘pydoc’ looks like
a path (that is, it contains the path separator for your operating
system, such as a slash in Unix), and refers to an existing Python
source file, then documentation is produced for that file.

     Note: In order to find objects and their documentation, *note
     pydoc: d9. imports the module(s) to be documented.  Therefore, any
     code on module level will be executed on that occasion.  Use an ‘if
     __name__ == '__main__':’ guard to only execute code when a file is
     invoked as a script and not just imported.

When printing output to the console, ‘pydoc’ attempts to paginate the
output for easier reading.  If the ‘PAGER’ environment variable is set,
‘pydoc’ will use its value as a pagination program.

Specifying a ‘-w’ flag before the argument will cause HTML documentation
to be written out to a file in the current directory, instead of
displaying text on the console.

Specifying a ‘-k’ flag before the argument will search the synopsis
lines of all available modules for the keyword given as the argument,
again in a manner similar to the Unix ‘man’ command.  The synopsis line
of a module is the first line of its documentation string.

You can also use ‘pydoc’ to start an HTTP server on the local machine
that will serve documentation to visiting Web browsers.  ‘pydoc -p 1234’
will start a HTTP server on port 1234, allowing you to browse the
documentation at ‘http://localhost:1234/’ in your preferred Web browser.
Specifying ‘0’ as the port number will select an arbitrary unused port.

‘pydoc -n <hostname>’ will start the server listening at the given
hostname.  By default the hostname is ‘localhost’ but if you want the
server to be reached from other machines, you may want to change the
host name that the server responds to.  During development this is
especially useful if you want to run pydoc from within a container.

‘pydoc -b’ will start the server and additionally open a web browser to
a module index page.  Each served page has a navigation bar at the top
where you can `Get' help on an individual item, `Search' all modules
with a keyword in their synopsis line, and go to the `Module index',
`Topics' and `Keywords' pages.

When ‘pydoc’ generates documentation, it uses the current environment
and path to locate modules.  Thus, invoking ‘pydoc spam’ documents
precisely the version of the module you would get if you started the
Python interpreter and typed ‘import spam’.

Module docs for core modules are assumed to reside in
‘https://docs.python.org/X.Y/library/’ where ‘X’ and ‘Y’ are the major
and minor version numbers of the Python interpreter.  This can be
overridden by setting the ‘PYTHONDOCS’ environment variable to a
different URL or to a local directory containing the Library Reference
Manual pages.

Changed in version 3.2: Added the ‘-b’ option.

Changed in version 3.3: The ‘-g’ command line option was removed.

Changed in version 3.4: *note pydoc: d9. now uses *note
inspect.signature(): 550. rather than *note inspect.getfullargspec():
552. to extract signature information from callables.

Changed in version 3.7: Added the ‘-n’ option.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pydoc.py


File: python.info,  Node: doctest — Test interactive Python examples,  Next: unittest — Unit testing framework,  Prev: pydoc — Documentation generator and online help system,  Up: Development Tools

5.27.3 ‘doctest’ — Test interactive Python examples
---------------------------------------------------

`Source code:' Lib/doctest.py(1)

__________________________________________________________________

The *note doctest: 67. module searches for pieces of text that look like
interactive Python sessions, and then executes those sessions to verify
that they work exactly as shown.  There are several common ways to use
doctest:

   * To check that a module’s docstrings are up-to-date by verifying
     that all interactive examples still work as documented.

   * To perform regression testing by verifying that interactive
     examples from a test file or a test object work as expected.

   * To write tutorial documentation for a package, liberally
     illustrated with input-output examples.  Depending on whether the
     examples or the expository text are emphasized, this has the flavor
     of “literate testing” or “executable documentation”.

Here’s a complete but small example module:

     """ This is the "example" module.  The example module supplies one function, factorial().  For example,  >>> factorial(5) 120 """  def factorial(n):     """Return the factorial of n, an exact integer >= 0.      >>> [factorial(n) for n in range(6)]     [1, 1, 2, 6, 24, 120]     >>> factorial(30)     265252859812191058636308480000000     >>> factorial(-1)     Traceback (most recent call last):         ...     ValueError: n must be >= 0      Factorials of floats are OK, but the float must be an exact integer:     >>> factorial(30.1)     Traceback (most recent call last):         ...     ValueError: n must be exact integer     >>> factorial(30.0)     265252859812191058636308480000000      It must also not be ridiculously large:     >>> factorial(1e100)     Traceback (most recent call last):         ...     OverflowError: n too large     """      import math     if not n >= 0:         raise ValueError("n must be >= 0")     if math.floor(n) != n:         raise ValueError("n must be exact integer")     if n+1 == n:  # catch a value like 1e300         raise OverflowError("n too large")     result = 1     factor = 2     while factor <= n:         result *= factor         factor += 1     return result   if __name__ == "__main__":     import doctest     doctest.testmod()

If you run ‘example.py’ directly from the command line, *note doctest:
67. works its magic:

     $ python example.py $

There’s no output!  That’s normal, and it means all the examples worked.
Pass ‘-v’ to the script, and *note doctest: 67. prints a detailed log of
what it’s trying, and prints a summary at the end:

     $ python example.py -v Trying:     factorial(5) Expecting:     120 ok Trying:     [factorial(n) for n in range(6)] Expecting:     [1, 1, 2, 6, 24, 120] ok

And so on, eventually ending with:

     Trying:     factorial(1e100) Expecting:     Traceback (most recent call last):         ...     OverflowError: n too large ok 2 items passed all tests:    1 tests in __main__    8 tests in __main__.factorial 9 tests in 2 items. 9 passed and 0 failed. Test passed. $

That’s all you need to know to start making productive use of *note
doctest: 67.!  Jump in.  The following sections provide full details.
Note that there are many examples of doctests in the standard Python
test suite and libraries.  Especially useful examples can be found in
the standard test file ‘Lib/test/test_doctest.py’.

* Menu:

* Simple Usage; Checking Examples in Docstrings: Simple Usage Checking Examples in Docstrings.
* Simple Usage; Checking Examples in a Text File: Simple Usage Checking Examples in a Text File.
* How It Works::
* Basic API::
* Unittest API::
* Advanced API::
* Debugging::
* Soapbox::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/doctest.py


File: python.info,  Node: Simple Usage Checking Examples in Docstrings,  Next: Simple Usage Checking Examples in a Text File,  Up: doctest — Test interactive Python examples

5.27.3.1 Simple Usage: Checking Examples in Docstrings
......................................................

The simplest way to start using doctest (but not necessarily the way
you’ll continue to do it) is to end each module ‘M’ with:

     if __name__ == "__main__":     import doctest     doctest.testmod()

*note doctest: 67. then examines docstrings in module ‘M’.

Running the module as a script causes the examples in the docstrings to
get executed and verified:

     python M.py

This won’t display anything unless an example fails, in which case the
failing example(s) and the cause(s) of the failure(s) are printed to
stdout, and the final line of output is ‘***Test Failed*** N failures.’,
where `N' is the number of examples that failed.

Run it with the ‘-v’ switch instead:

     python M.py -v

and a detailed report of all examples tried is printed to standard
output, along with assorted summaries at the end.

You can force verbose mode by passing ‘verbose=True’ to *note testmod():
dc3, or prohibit it by passing ‘verbose=False’.  In either of those
cases, ‘sys.argv’ is not examined by *note testmod(): dc3. (so passing
‘-v’ or not has no effect).

There is also a command line shortcut for running *note testmod(): dc3.
You can instruct the Python interpreter to run the doctest module
directly from the standard library and pass the module name(s) on the
command line:

     python -m doctest -v example.py

This will import ‘example.py’ as a standalone module and run *note
testmod(): dc3. on it.  Note that this may not work correctly if the
file is part of a package and imports other submodules from that
package.

For more information on *note testmod(): dc3, see section *note Basic
API: 31f0.


File: python.info,  Node: Simple Usage Checking Examples in a Text File,  Next: How It Works,  Prev: Simple Usage Checking Examples in Docstrings,  Up: doctest — Test interactive Python examples

5.27.3.2 Simple Usage: Checking Examples in a Text File
.......................................................

Another simple application of doctest is testing interactive examples in
a text file.  This can be done with the *note testfile(): 31f3.
function:

     import doctest doctest.testfile("example.txt")

That short script executes and verifies any interactive Python examples
contained in the file ‘example.txt’.  The file content is treated as if
it were a single giant docstring; the file doesn’t need to contain a
Python program!  For example, perhaps ‘example.txt’ contains this:

     The ``example`` module ======================  Using ``factorial`` -------------------  This is an example text file in reStructuredText format.  First import ``factorial`` from the ``example`` module:      >>> from example import factorial  Now use it:      >>> factorial(6)     120

Running ‘doctest.testfile("example.txt")’ then finds the error in this
documentation:

     File "./example.txt", line 14, in example.txt Failed example:     factorial(6) Expected:     120 Got:     720

As with *note testmod(): dc3, *note testfile(): 31f3. won’t display
anything unless an example fails.  If an example does fail, then the
failing example(s) and the cause(s) of the failure(s) are printed to
stdout, using the same format as *note testmod(): dc3.

By default, *note testfile(): 31f3. looks for files in the calling
module’s directory.  See section *note Basic API: 31f0. for a
description of the optional arguments that can be used to tell it to
look for files in other locations.

Like *note testmod(): dc3, *note testfile(): 31f3.’s verbosity can be
set with the ‘-v’ command-line switch or with the optional keyword
argument `verbose'.

There is also a command line shortcut for running *note testfile():
31f3.  You can instruct the Python interpreter to run the doctest module
directly from the standard library and pass the file name(s) on the
command line:

     python -m doctest -v example.txt

Because the file name does not end with ‘.py’, *note doctest: 67. infers
that it must be run with *note testfile(): 31f3, not *note testmod():
dc3.

For more information on *note testfile(): 31f3, see section *note Basic
API: 31f0.


File: python.info,  Node: How It Works,  Next: Basic API,  Prev: Simple Usage Checking Examples in a Text File,  Up: doctest — Test interactive Python examples

5.27.3.3 How It Works
.....................

This section examines in detail how doctest works: which docstrings it
looks at, how it finds interactive examples, what execution context it
uses, how it handles exceptions, and how option flags can be used to
control its behavior.  This is the information that you need to know to
write doctest examples; for information about actually running doctest
on these examples, see the following sections.

* Menu:

* Which Docstrings Are Examined?::
* How are Docstring Examples Recognized?::
* What’s the Execution Context?::
* What About Exceptions?::
* Option Flags::
* Directives::
* Warnings: Warnings<2>.


File: python.info,  Node: Which Docstrings Are Examined?,  Next: How are Docstring Examples Recognized?,  Up: How It Works

5.27.3.4 Which Docstrings Are Examined?
.......................................

The module docstring, and all function, class and method docstrings are
searched.  Objects imported into the module are not searched.

In addition, if ‘M.__test__’ exists and “is true”, it must be a dict,
and each entry maps a (string) name to a function object, class object,
or string.  Function and class object docstrings found from ‘M.__test__’
are searched, and strings are treated as if they were docstrings.  In
output, a key ‘K’ in ‘M.__test__’ appears with name

     <name of M>.__test__.K

Any classes found are recursively searched similarly, to test docstrings
in their contained methods and nested classes.

`CPython implementation detail:' Prior to version 3.4, extension modules
written in C were not fully searched by doctest.


File: python.info,  Node: How are Docstring Examples Recognized?,  Next: What’s the Execution Context?,  Prev: Which Docstrings Are Examined?,  Up: How It Works

5.27.3.5 How are Docstring Examples Recognized?
...............................................

In most cases a copy-and-paste of an interactive console session works
fine, but doctest isn’t trying to do an exact emulation of any specific
Python shell.

     >>> # comments are ignored >>> x = 12 >>> x 12 >>> if x == 13: ...     print("yes") ... else: ...     print("no") ...     print("NO") ...     print("NO!!!") ... no NO NO!!! >>>

Any expected output must immediately follow the final ‘'>>> '’ or ‘'...
'’ line containing the code, and the expected output (if any) extends to
the next ‘'>>> '’ or all-whitespace line.

The fine print:

   * Expected output cannot contain an all-whitespace line, since such a
     line is taken to signal the end of expected output.  If expected
     output does contain a blank line, put ‘<BLANKLINE>’ in your doctest
     example each place a blank line is expected.

   * All hard tab characters are expanded to spaces, using 8-column tab
     stops.  Tabs in output generated by the tested code are not
     modified.  Because any hard tabs in the sample output `are'
     expanded, this means that if the code output includes hard tabs,
     the only way the doctest can pass is if the *note
     NORMALIZE_WHITESPACE: 31fa. option or *note directive: 31fb. is in
     effect.  Alternatively, the test can be rewritten to capture the
     output and compare it to an expected value as part of the test.
     This handling of tabs in the source was arrived at through trial
     and error, and has proven to be the least error prone way of
     handling them.  It is possible to use a different algorithm for
     handling tabs by writing a custom *note DocTestParser: 31fc. class.

   * Output to stdout is captured, but not output to stderr (exception
     tracebacks are captured via a different means).

   * If you continue a line via backslashing in an interactive session,
     or for any other reason use a backslash, you should use a raw
     docstring, which will preserve your backslashes exactly as you type
     them:

          >>> def f(x): ...     r'''Backslashes in a raw docstring: m\n''' >>> print(f.__doc__) Backslashes in a raw docstring: m\n

     Otherwise, the backslash will be interpreted as part of the string.
     For example, the ‘\n’ above would be interpreted as a newline
     character.  Alternatively, you can double each backslash in the
     doctest version (and not use a raw string):

          >>> def f(x): ...     '''Backslashes in a raw docstring: m\\n''' >>> print(f.__doc__) Backslashes in a raw docstring: m\n

   * The starting column doesn’t matter:

          >>> assert "Easy!"       >>> import math           >>> math.floor(1.9)           1

     and as many leading whitespace characters are stripped from the
     expected output as appeared in the initial ‘'>>> '’ line that
     started the example.


File: python.info,  Node: What’s the Execution Context?,  Next: What About Exceptions?,  Prev: How are Docstring Examples Recognized?,  Up: How It Works

5.27.3.6 What’s the Execution Context?
......................................

By default, each time *note doctest: 67. finds a docstring to test, it
uses a `shallow copy' of ‘M’’s globals, so that running tests doesn’t
change the module’s real globals, and so that one test in ‘M’ can’t
leave behind crumbs that accidentally allow another test to work.  This
means examples can freely use any names defined at top-level in ‘M’, and
names defined earlier in the docstring being run.  Examples cannot see
names defined in other docstrings.

You can force use of your own dict as the execution context by passing
‘globs=your_dict’ to *note testmod(): dc3. or *note testfile(): 31f3.
instead.


File: python.info,  Node: What About Exceptions?,  Next: Option Flags,  Prev: What’s the Execution Context?,  Up: How It Works

5.27.3.7 What About Exceptions?
...............................

No problem, provided that the traceback is the only output produced by
the example: just paste in the traceback.  (1) Since tracebacks contain
details that are likely to change rapidly (for example, exact file paths
and line numbers), this is one case where doctest works hard to be
flexible in what it accepts.

Simple example:

     >>> [1, 2, 3].remove(42) Traceback (most recent call last):   File "<stdin>", line 1, in <module> ValueError: list.remove(x): x not in list

That doctest succeeds if *note ValueError: 1f9. is raised, with the
‘list.remove(x): x not in list’ detail as shown.

The expected output for an exception must start with a traceback header,
which may be either of the following two lines, indented the same as the
first line of the example:

     Traceback (most recent call last): Traceback (innermost last):

The traceback header is followed by an optional traceback stack, whose
contents are ignored by doctest.  The traceback stack is typically
omitted, or copied verbatim from an interactive session.

The traceback stack is followed by the most interesting part: the
line(s) containing the exception type and detail.  This is usually the
last line of a traceback, but can extend across multiple lines if the
exception has a multi-line detail:

     >>> raise ValueError('multi\n    line\ndetail') Traceback (most recent call last):   File "<stdin>", line 1, in <module> ValueError: multi     line detail

The last three lines (starting with *note ValueError: 1f9.) are compared
against the exception’s type and detail, and the rest are ignored.

Best practice is to omit the traceback stack, unless it adds significant
documentation value to the example.  So the last example is probably
better as:

     >>> raise ValueError('multi\n    line\ndetail') Traceback (most recent call last):     ... ValueError: multi     line detail

Note that tracebacks are treated very specially.  In particular, in the
rewritten example, the use of ‘...’ is independent of doctest’s *note
ELLIPSIS: dc4. option.  The ellipsis in that example could be left out,
or could just as well be three (or three hundred) commas or digits, or
an indented transcript of a Monty Python skit.

Some details you should read once, but won’t need to remember:

   * Doctest can’t guess whether your expected output came from an
     exception traceback or from ordinary printing.  So, e.g., an
     example that expects ‘ValueError: 42 is prime’ will pass whether
     *note ValueError: 1f9. is actually raised or if the example merely
     prints that traceback text.  In practice, ordinary output rarely
     begins with a traceback header line, so this doesn’t create real
     problems.

   * Each line of the traceback stack (if present) must be indented
     further than the first line of the example, `or' start with a
     non-alphanumeric character.  The first line following the traceback
     header indented the same and starting with an alphanumeric is taken
     to be the start of the exception detail.  Of course this does the
     right thing for genuine tracebacks.

   * When the *note IGNORE_EXCEPTION_DETAIL: 3201. doctest option is
     specified, everything following the leftmost colon and any module
     information in the exception name is ignored.

   * The interactive shell omits the traceback header line for some
     *note SyntaxError: 44d.s.  But doctest uses the traceback header
     line to distinguish exceptions from non-exceptions.  So in the rare
     case where you need to test a *note SyntaxError: 44d. that omits
     the traceback header, you will need to manually add the traceback
     header line to your test example.

   * For some *note SyntaxError: 44d.s, Python displays the character
     position of the syntax error, using a ‘^’ marker:

          >>> 1 1   File "<stdin>", line 1     1 1       ^ SyntaxError: invalid syntax

     Since the lines showing the position of the error come before the
     exception type and detail, they are not checked by doctest.  For
     example, the following test would pass, even though it puts the ‘^’
     marker in the wrong location:

          >>> 1 1 Traceback (most recent call last):   File "<stdin>", line 1     1 1     ^ SyntaxError: invalid syntax

   ---------- Footnotes ----------

   (1) (1) Examples containing both expected output and an exception are
not supported.  Trying to guess where one ends and the other begins is
too error-prone, and that also makes for a confusing test.


File: python.info,  Node: Option Flags,  Next: Directives,  Prev: What About Exceptions?,  Up: How It Works

5.27.3.8 Option Flags
.....................

A number of option flags control various aspects of doctest’s behavior.
Symbolic names for the flags are supplied as module constants, which can
be *note bitwise ORed: 147b. together and passed to various functions.
The names can also be used in *note doctest directives: 31fb, and may be
passed to the doctest command line interface via the ‘-o’ option.

New in version 3.4: The ‘-o’ command line option.

The first group of options define test semantics, controlling aspects of
how doctest decides whether actual output matches an example’s expected
output:

 -- Data: doctest.DONT_ACCEPT_TRUE_FOR_1

     By default, if an expected output block contains just ‘1’, an
     actual output block containing just ‘1’ or just ‘True’ is
     considered to be a match, and similarly for ‘0’ versus ‘False’.
     When *note DONT_ACCEPT_TRUE_FOR_1: 3204. is specified, neither
     substitution is allowed.  The default behavior caters to that
     Python changed the return type of many functions from integer to
     boolean; doctests expecting “little integer” output still work in
     these cases.  This option will probably go away, but not for
     several years.

 -- Data: doctest.DONT_ACCEPT_BLANKLINE

     By default, if an expected output block contains a line containing
     only the string ‘<BLANKLINE>’, then that line will match a blank
     line in the actual output.  Because a genuinely blank line delimits
     the expected output, this is the only way to communicate that a
     blank line is expected.  When *note DONT_ACCEPT_BLANKLINE: 3205. is
     specified, this substitution is not allowed.

 -- Data: doctest.NORMALIZE_WHITESPACE

     When specified, all sequences of whitespace (blanks and newlines)
     are treated as equal.  Any sequence of whitespace within the
     expected output will match any sequence of whitespace within the
     actual output.  By default, whitespace must match exactly.  *note
     NORMALIZE_WHITESPACE: 31fa. is especially useful when a line of
     expected output is very long, and you want to wrap it across
     multiple lines in your source.

 -- Data: doctest.ELLIPSIS

     When specified, an ellipsis marker (‘...’) in the expected output
     can match any substring in the actual output.  This includes
     substrings that span line boundaries, and empty substrings, so it’s
     best to keep usage of this simple.  Complicated uses can lead to
     the same kinds of “oops, it matched too much!” surprises that ‘.*’
     is prone to in regular expressions.

 -- Data: doctest.IGNORE_EXCEPTION_DETAIL

     When specified, an example that expects an exception passes if an
     exception of the expected type is raised, even if the exception
     detail does not match.  For example, an example expecting
     ‘ValueError: 42’ will pass if the actual exception raised is
     ‘ValueError: 3*14’, but will fail, e.g., if *note TypeError: 192.
     is raised.

     It will also ignore the module name used in Python 3 doctest
     reports.  Hence both of these variations will work with the flag
     specified, regardless of whether the test is run under Python 2.7
     or Python 3.2 (or later versions):

          >>> raise CustomError('message') Traceback (most recent call last): CustomError: message  >>> raise CustomError('message') Traceback (most recent call last): my_module.CustomError: message

     Note that *note ELLIPSIS: dc4. can also be used to ignore the
     details of the exception message, but such a test may still fail
     based on whether or not the module details are printed as part of
     the exception name.  Using *note IGNORE_EXCEPTION_DETAIL: 3201. and
     the details from Python 2.3 is also the only clear way to write a
     doctest that doesn’t care about the exception detail yet continues
     to pass under Python 2.3 or earlier (those releases do not support
     *note doctest directives: 31fb. and ignore them as irrelevant
     comments).  For example:

          >>> (1, 2)[3] = 'moo' Traceback (most recent call last):   File "<stdin>", line 1, in <module> TypeError: object doesn't support item assignment

     passes under Python 2.3 and later Python versions with the flag
     specified, even though the detail changed in Python 2.4 to say
     “does not” instead of “doesn’t”.

     Changed in version 3.2: *note IGNORE_EXCEPTION_DETAIL: 3201. now
     also ignores any information relating to the module containing the
     exception under test.

 -- Data: doctest.SKIP

     When specified, do not run the example at all.  This can be useful
     in contexts where doctest examples serve as both documentation and
     test cases, and an example should be included for documentation
     purposes, but should not be checked.  E.g., the example’s output
     might be random; or the example might depend on resources which
     would be unavailable to the test driver.

     The SKIP flag can also be used for temporarily “commenting out”
     examples.

 -- Data: doctest.COMPARISON_FLAGS

     A bitmask or’ing together all the comparison flags above.

The second group of options controls how test failures are reported:

 -- Data: doctest.REPORT_UDIFF

     When specified, failures that involve multi-line expected and
     actual outputs are displayed using a unified diff.

 -- Data: doctest.REPORT_CDIFF

     When specified, failures that involve multi-line expected and
     actual outputs will be displayed using a context diff.

 -- Data: doctest.REPORT_NDIFF

     When specified, differences are computed by ‘difflib.Differ’, using
     the same algorithm as the popular ‘ndiff.py’ utility.  This is the
     only method that marks differences within lines as well as across
     lines.  For example, if a line of expected output contains digit
     ‘1’ where actual output contains letter ‘l’, a line is inserted
     with a caret marking the mismatching column positions.

 -- Data: doctest.REPORT_ONLY_FIRST_FAILURE

     When specified, display the first failing example in each doctest,
     but suppress output for all remaining examples.  This will prevent
     doctest from reporting correct examples that break because of
     earlier failures; but it might also hide incorrect examples that
     fail independently of the first failure.  When *note
     REPORT_ONLY_FIRST_FAILURE: 3208. is specified, the remaining
     examples are still run, and still count towards the total number of
     failures reported; only the output is suppressed.

 -- Data: doctest.FAIL_FAST

     When specified, exit after the first failing example and don’t
     attempt to run the remaining examples.  Thus, the number of
     failures reported will be at most 1.  This flag may be useful
     during debugging, since examples after the first failure won’t even
     produce debugging output.

     The doctest command line accepts the option ‘-f’ as a shorthand for
     ‘-o FAIL_FAST’.

     New in version 3.4.

 -- Data: doctest.REPORTING_FLAGS

     A bitmask or’ing together all the reporting flags above.

There is also a way to register new option flag names, though this isn’t
useful unless you intend to extend *note doctest: 67. internals via
subclassing:

 -- Function: doctest.register_optionflag (name)

     Create a new option flag with a given name, and return the new
     flag’s integer value.  *note register_optionflag(): 320a. can be
     used when subclassing *note OutputChecker: 320b. or *note
     DocTestRunner: 320c. to create new options that are supported by
     your subclasses.  *note register_optionflag(): 320a. should always
     be called using the following idiom:

          MY_FLAG = register_optionflag('MY_FLAG')


File: python.info,  Node: Directives,  Next: Warnings<2>,  Prev: Option Flags,  Up: How It Works

5.27.3.9 Directives
...................

Doctest directives may be used to modify the *note option flags: 830.
for an individual example.  Doctest directives are special Python
comments following an example’s source code:

     directive             ::= "#" "doctest:" directive_options
     directive_options     ::= directive_option ("," directive_option)\*
     directive_option      ::= on_or_off directive_option_name
     on_or_off             ::= "+" \| "-"
     directive_option_name ::= "DONT_ACCEPT_BLANKLINE" \| "NORMALIZE_WHITESPACE" \| ...

Whitespace is not allowed between the ‘+’ or ‘-’ and the directive
option name.  The directive option name can be any of the option flag
names explained above.

An example’s doctest directives modify doctest’s behavior for that
single example.  Use ‘+’ to enable the named behavior, or ‘-’ to disable
it.

For example, this test passes:

     >>> print(list(range(20)))  [0,   1,  2,  3,  4,  5,  6,  7,  8,  9, 10,  11, 12, 13, 14, 15, 16, 17, 18, 19]

Without the directive it would fail, both because the actual output
doesn’t have two blanks before the single-digit list elements, and
because the actual output is on a single line.  This test also passes,
and also requires a directive to do so:

     >>> print(list(range(20)))  [0, 1, ..., 18, 19]

Multiple directives can be used on a single physical line, separated by
commas:

     >>> print(list(range(20)))  [0,    1, ...,   18,    19]

If multiple directive comments are used for a single example, then they
are combined:

     >>> print(list(range(20)))  ...                         [0,    1, ...,   18,    19]

As the previous example shows, you can add ‘...’ lines to your example
containing only directives.  This can be useful when an example is too
long for a directive to comfortably fit on the same line:

     >>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40))) ...  [0, ..., 4, 10, ..., 19, 30, ..., 39]

Note that since all options are disabled by default, and directives
apply only to the example they appear in, enabling options (via ‘+’ in a
directive) is usually the only meaningful choice.  However, option flags
can also be passed to functions that run doctests, establishing
different defaults.  In such cases, disabling an option via ‘-’ in a
directive can be useful.


File: python.info,  Node: Warnings<2>,  Prev: Directives,  Up: How It Works

5.27.3.10 Warnings
..................

*note doctest: 67. is serious about requiring exact matches in expected
output.  If even a single character doesn’t match, the test fails.  This
will probably surprise you a few times, as you learn exactly what Python
does and doesn’t guarantee about output.  For example, when printing a
set, Python doesn’t guarantee that the element is printed in any
particular order, so a test like

     >>> foo() {"Hermione", "Harry"}

is vulnerable!  One workaround is to do

     >>> foo() == {"Hermione", "Harry"} True

instead.  Another is to do

     >>> d = sorted(foo()) >>> d ['Harry', 'Hermione']

     Note: Before Python 3.6, when printing a dict, Python did not
     guarantee that the key-value pairs was printed in any particular
     order.

There are others, but you get the idea.

Another bad idea is to print things that embed an object address, like

     >>> id(1.0) # certain to fail some of the time 7948648 >>> class C: pass >>> C()   # the default repr() for instances embeds an address <__main__.C instance at 0x00AC18F0>

The *note ELLIPSIS: dc4. directive gives a nice approach for the last
example:

     >>> C()  <__main__.C instance at 0x...>

Floating-point numbers are also subject to small output variations
across platforms, because Python defers to the platform C library for
float formatting, and C libraries vary widely in quality here.

     >>> 1./7  # risky 0.14285714285714285 >>> print(1./7) # safer 0.142857142857 >>> print(round(1./7, 6)) # much safer 0.142857

Numbers of the form ‘I/2.**J’ are safe across all platforms, and I often
contrive doctest examples to produce numbers of that form:

     >>> 3./4  # utterly safe 0.75

Simple fractions are also easier for people to understand, and that
makes for better documentation.


File: python.info,  Node: Basic API,  Next: Unittest API,  Prev: How It Works,  Up: doctest — Test interactive Python examples

5.27.3.11 Basic API
...................

The functions *note testmod(): dc3. and *note testfile(): 31f3. provide
a simple interface to doctest that should be sufficient for most basic
uses.  For a less formal introduction to these two functions, see
sections *note Simple Usage; Checking Examples in Docstrings: 31ee. and
*note Simple Usage; Checking Examples in a Text File: 31f1.

 -- Function: doctest.testfile (filename, module_relative=True,
          name=None, package=None, globs=None, verbose=None,
          report=True, optionflags=0, extraglobs=None,
          raise_on_error=False, parser=DocTestParser(), encoding=None)

     All arguments except `filename' are optional, and should be
     specified in keyword form.

     Test examples in the file named `filename'.  Return
     ‘(failure_count, test_count)’.

     Optional argument `module_relative' specifies how the filename
     should be interpreted:

        * If `module_relative' is ‘True’ (the default), then `filename'
          specifies an OS-independent module-relative path.  By default,
          this path is relative to the calling module’s directory; but
          if the `package' argument is specified, then it is relative to
          that package.  To ensure OS-independence, `filename' should
          use ‘/’ characters to separate path segments, and may not be
          an absolute path (i.e., it may not begin with ‘/’).

        * If `module_relative' is ‘False’, then `filename' specifies an
          OS-specific path.  The path may be absolute or relative;
          relative paths are resolved with respect to the current
          working directory.

     Optional argument `name' gives the name of the test; by default, or
     if ‘None’, ‘os.path.basename(filename)’ is used.

     Optional argument `package' is a Python package or the name of a
     Python package whose directory should be used as the base directory
     for a module-relative filename.  If no package is specified, then
     the calling module’s directory is used as the base directory for
     module-relative filenames.  It is an error to specify `package' if
     `module_relative' is ‘False’.

     Optional argument `globs' gives a dict to be used as the globals
     when executing examples.  A new shallow copy of this dict is
     created for the doctest, so its examples start with a clean slate.
     By default, or if ‘None’, a new empty dict is used.

     Optional argument `extraglobs' gives a dict merged into the globals
     used to execute examples.  This works like *note dict.update():
     dbc.: if `globs' and `extraglobs' have a common key, the associated
     value in `extraglobs' appears in the combined dict.  By default, or
     if ‘None’, no extra globals are used.  This is an advanced feature
     that allows parameterization of doctests.  For example, a doctest
     can be written for a base class, using a generic name for the
     class, then reused to test any number of subclasses by passing an
     `extraglobs' dict mapping the generic name to the subclass to be
     tested.

     Optional argument `verbose' prints lots of stuff if true, and
     prints only failures if false; by default, or if ‘None’, it’s true
     if and only if ‘'-v'’ is in ‘sys.argv’.

     Optional argument `report' prints a summary at the end when true,
     else prints nothing at the end.  In verbose mode, the summary is
     detailed, else the summary is very brief (in fact, empty if all
     tests passed).

     Optional argument `optionflags' (default value 0) takes the *note
     bitwise OR: 147b. of option flags.  See section *note Option Flags:
     830.

     Optional argument `raise_on_error' defaults to false.  If true, an
     exception is raised upon the first failure or unexpected exception
     in an example.  This allows failures to be post-mortem debugged.
     Default behavior is to continue running examples.

     Optional argument `parser' specifies a *note DocTestParser: 31fc.
     (or subclass) that should be used to extract tests from the files.
     It defaults to a normal parser (i.e., ‘DocTestParser()’).

     Optional argument `encoding' specifies an encoding that should be
     used to convert the file to unicode.

 -- Function: doctest.testmod (m=None, name=None, globs=None,
          verbose=None, report=True, optionflags=0, extraglobs=None,
          raise_on_error=False, exclude_empty=False)

     All arguments are optional, and all except for `m' should be
     specified in keyword form.

     Test examples in docstrings in functions and classes reachable from
     module `m' (or module *note __main__: 1. if `m' is not supplied or
     is ‘None’), starting with ‘m.__doc__’.

     Also test examples reachable from dict ‘m.__test__’, if it exists
     and is not ‘None’.  ‘m.__test__’ maps names (strings) to functions,
     classes and strings; function and class docstrings are searched for
     examples; strings are searched directly, as if they were
     docstrings.

     Only docstrings attached to objects belonging to module `m' are
     searched.

     Return ‘(failure_count, test_count)’.

     Optional argument `name' gives the name of the module; by default,
     or if ‘None’, ‘m.__name__’ is used.

     Optional argument `exclude_empty' defaults to false.  If true,
     objects for which no doctests are found are excluded from
     consideration.  The default is a backward compatibility hack, so
     that code still using ‘doctest.master.summarize()’ in conjunction
     with *note testmod(): dc3. continues to get output for objects with
     no tests.  The `exclude_empty' argument to the newer *note
     DocTestFinder: 3216. constructor defaults to true.

     Optional arguments `extraglobs', `verbose', `report',
     `optionflags', `raise_on_error', and `globs' are the same as for
     function *note testfile(): 31f3. above, except that `globs'
     defaults to ‘m.__dict__’.

 -- Function: doctest.run_docstring_examples (f, globs, verbose=False,
          name="NoName", compileflags=None, optionflags=0)

     Test examples associated with object `f'; for example, `f' may be a
     string, a module, a function, or a class object.

     A shallow copy of dictionary argument `globs' is used for the
     execution context.

     Optional argument `name' is used in failure messages, and defaults
     to ‘"NoName"’.

     If optional argument `verbose' is true, output is generated even if
     there are no failures.  By default, output is generated only in
     case of an example failure.

     Optional argument `compileflags' gives the set of flags that should
     be used by the Python compiler when running the examples.  By
     default, or if ‘None’, flags are deduced corresponding to the set
     of future features found in `globs'.

     Optional argument `optionflags' works as for function *note
     testfile(): 31f3. above.


File: python.info,  Node: Unittest API,  Next: Advanced API,  Prev: Basic API,  Up: doctest — Test interactive Python examples

5.27.3.12 Unittest API
......................

As your collection of doctest’ed modules grows, you’ll want a way to run
all their doctests systematically.  *note doctest: 67. provides two
functions that can be used to create *note unittest: 11b. test suites
from modules and text files containing doctests.  To integrate with
*note unittest: 11b. test discovery, include a ‘load_tests()’ function
in your test module:

     import unittest import doctest import my_module_with_doctests  def load_tests(loader, tests, ignore):     tests.addTests(doctest.DocTestSuite(my_module_with_doctests))     return tests

There are two main functions for creating *note unittest.TestSuite: 6c2.
instances from text files and modules with doctests:

 -- Function: doctest.DocFileSuite (*paths, module_relative=True,
          package=None, setUp=None, tearDown=None, globs=None,
          optionflags=0, parser=DocTestParser(), encoding=None)

     Convert doctest tests from one or more text files to a *note
     unittest.TestSuite: 6c2.

     The returned *note unittest.TestSuite: 6c2. is to be run by the
     unittest framework and runs the interactive examples in each file.
     If an example in any file fails, then the synthesized unit test
     fails, and a ‘failureException’ exception is raised showing the
     name of the file containing the test and a (sometimes approximate)
     line number.

     Pass one or more paths (as strings) to text files to be examined.

     Options may be provided as keyword arguments:

     Optional argument `module_relative' specifies how the filenames in
     `paths' should be interpreted:

        * If `module_relative' is ‘True’ (the default), then each
          filename in `paths' specifies an OS-independent
          module-relative path.  By default, this path is relative to
          the calling module’s directory; but if the `package' argument
          is specified, then it is relative to that package.  To ensure
          OS-independence, each filename should use ‘/’ characters to
          separate path segments, and may not be an absolute path (i.e.,
          it may not begin with ‘/’).

        * If `module_relative' is ‘False’, then each filename in `paths'
          specifies an OS-specific path.  The path may be absolute or
          relative; relative paths are resolved with respect to the
          current working directory.

     Optional argument `package' is a Python package or the name of a
     Python package whose directory should be used as the base directory
     for module-relative filenames in `paths'.  If no package is
     specified, then the calling module’s directory is used as the base
     directory for module-relative filenames.  It is an error to specify
     `package' if `module_relative' is ‘False’.

     Optional argument `setUp' specifies a set-up function for the test
     suite.  This is called before running the tests in each file.  The
     `setUp' function will be passed a *note DocTest: 321b. object.  The
     setUp function can access the test globals as the `globs' attribute
     of the test passed.

     Optional argument `tearDown' specifies a tear-down function for the
     test suite.  This is called after running the tests in each file.
     The `tearDown' function will be passed a *note DocTest: 321b.
     object.  The setUp function can access the test globals as the
     `globs' attribute of the test passed.

     Optional argument `globs' is a dictionary containing the initial
     global variables for the tests.  A new copy of this dictionary is
     created for each test.  By default, `globs' is a new empty
     dictionary.

     Optional argument `optionflags' specifies the default doctest
     options for the tests, created by or-ing together individual option
     flags.  See section *note Option Flags: 830.  See function *note
     set_unittest_reportflags(): 321c. below for a better way to set
     reporting options.

     Optional argument `parser' specifies a *note DocTestParser: 31fc.
     (or subclass) that should be used to extract tests from the files.
     It defaults to a normal parser (i.e., ‘DocTestParser()’).

     Optional argument `encoding' specifies an encoding that should be
     used to convert the file to unicode.

     The global ‘__file__’ is added to the globals provided to doctests
     loaded from a text file using *note DocFileSuite(): 321a.

 -- Function: doctest.DocTestSuite (module=None, globs=None,
          extraglobs=None, test_finder=None, setUp=None, tearDown=None,
          checker=None)

     Convert doctest tests for a module to a *note unittest.TestSuite:
     6c2.

     The returned *note unittest.TestSuite: 6c2. is to be run by the
     unittest framework and runs each doctest in the module.  If any of
     the doctests fail, then the synthesized unit test fails, and a
     ‘failureException’ exception is raised showing the name of the file
     containing the test and a (sometimes approximate) line number.

     Optional argument `module' provides the module to be tested.  It
     can be a module object or a (possibly dotted) module name.  If not
     specified, the module calling this function is used.

     Optional argument `globs' is a dictionary containing the initial
     global variables for the tests.  A new copy of this dictionary is
     created for each test.  By default, `globs' is a new empty
     dictionary.

     Optional argument `extraglobs' specifies an extra set of global
     variables, which is merged into `globs'.  By default, no extra
     globals are used.

     Optional argument `test_finder' is the *note DocTestFinder: 3216.
     object (or a drop-in replacement) that is used to extract doctests
     from the module.

     Optional arguments `setUp', `tearDown', and `optionflags' are the
     same as for function *note DocFileSuite(): 321a. above.

     This function uses the same search technique as *note testmod():
     dc3.

     Changed in version 3.5: *note DocTestSuite(): 6c1. returns an empty
     *note unittest.TestSuite: 6c2. if `module' contains no docstrings
     instead of raising *note ValueError: 1f9.

Under the covers, *note DocTestSuite(): 6c1. creates a *note
unittest.TestSuite: 6c2. out of ‘doctest.DocTestCase’ instances, and
‘DocTestCase’ is a subclass of *note unittest.TestCase: 8f3.
‘DocTestCase’ isn’t documented here (it’s an internal detail), but
studying its code can answer questions about the exact details of *note
unittest: 11b. integration.

Similarly, *note DocFileSuite(): 321a. creates a *note
unittest.TestSuite: 6c2. out of ‘doctest.DocFileCase’ instances, and
‘DocFileCase’ is a subclass of ‘DocTestCase’.

So both ways of creating a *note unittest.TestSuite: 6c2. run instances
of ‘DocTestCase’.  This is important for a subtle reason: when you run
*note doctest: 67. functions yourself, you can control the *note
doctest: 67. options in use directly, by passing option flags to *note
doctest: 67. functions.  However, if you’re writing a *note unittest:
11b. framework, *note unittest: 11b. ultimately controls when and how
tests get run.  The framework author typically wants to control *note
doctest: 67. reporting options (perhaps, e.g., specified by command line
options), but there’s no way to pass options through *note unittest:
11b. to *note doctest: 67. test runners.

For this reason, *note doctest: 67. also supports a notion of *note
doctest: 67. reporting flags specific to *note unittest: 11b. support,
via this function:

 -- Function: doctest.set_unittest_reportflags (flags)

     Set the *note doctest: 67. reporting flags to use.

     Argument `flags' takes the *note bitwise OR: 147b. of option flags.
     See section *note Option Flags: 830.  Only “reporting flags” can be
     used.

     This is a module-global setting, and affects all future doctests
     run by module *note unittest: 11b.: the ‘runTest()’ method of
     ‘DocTestCase’ looks at the option flags specified for the test case
     when the ‘DocTestCase’ instance was constructed.  If no reporting
     flags were specified (which is the typical and expected case),
     *note doctest: 67.’s *note unittest: 11b. reporting flags are *note
     bitwise ORed: 147b. into the option flags, and the option flags so
     augmented are passed to the *note DocTestRunner: 320c. instance
     created to run the doctest.  If any reporting flags were specified
     when the ‘DocTestCase’ instance was constructed, *note doctest:
     67.’s *note unittest: 11b. reporting flags are ignored.

     The value of the *note unittest: 11b. reporting flags in effect
     before the function was called is returned by the function.


File: python.info,  Node: Advanced API,  Next: Debugging,  Prev: Unittest API,  Up: doctest — Test interactive Python examples

5.27.3.13 Advanced API
......................

The basic API is a simple wrapper that’s intended to make doctest easy
to use.  It is fairly flexible, and should meet most users’ needs;
however, if you require more fine-grained control over testing, or wish
to extend doctest’s capabilities, then you should use the advanced API.

The advanced API revolves around two container classes, which are used
to store the interactive examples extracted from doctest cases:

   * *note Example: 321f.: A single Python *note statement: 1aca, paired
     with its expected output.

   * *note DocTest: 321b.: A collection of *note Example: 321f.s,
     typically extracted from a single docstring or text file.

Additional processing classes are defined to find, parse, and run, and
check doctest examples:

   * *note DocTestFinder: 3216.: Finds all docstrings in a given module,
     and uses a *note DocTestParser: 31fc. to create a *note DocTest:
     321b. from every docstring that contains interactive examples.

   * *note DocTestParser: 31fc.: Creates a *note DocTest: 321b. object
     from a string (such as an object’s docstring).

   * *note DocTestRunner: 320c.: Executes the examples in a *note
     DocTest: 321b, and uses an *note OutputChecker: 320b. to verify
     their output.

   * *note OutputChecker: 320b.: Compares the actual output from a
     doctest example with the expected output, and decides whether they
     match.

The relationships among these processing classes are summarized in the
following diagram:

                                 list of: +------+                   +---------+ |module| --DocTestFinder-> | DocTest | --DocTestRunner-> results +------+    |        ^     +---------+     |       ^    (printed)             |        |     | Example |     |       |             v        |     |   ...   |     v       |            DocTestParser   | Example |   OutputChecker                            +---------+

* Menu:

* DocTest Objects::
* Example Objects::
* DocTestFinder objects::
* DocTestParser objects::
* DocTestRunner objects::
* OutputChecker objects::


File: python.info,  Node: DocTest Objects,  Next: Example Objects,  Up: Advanced API

5.27.3.14 DocTest Objects
.........................

 -- Class: doctest.DocTest (examples, globs, name, filename, lineno,
          docstring)

     A collection of doctest examples that should be run in a single
     namespace.  The constructor arguments are used to initialize the
     attributes of the same names.

     *note DocTest: 321b. defines the following attributes.  They are
     initialized by the constructor, and should not be modified
     directly.

      -- Attribute: examples

          A list of *note Example: 321f. objects encoding the individual
          interactive Python examples that should be run by this test.

      -- Attribute: globs

          The namespace (aka globals) that the examples should be run
          in.  This is a dictionary mapping names to values.  Any
          changes to the namespace made by the examples (such as binding
          new variables) will be reflected in *note globs: 3223. after
          the test is run.

      -- Attribute: name

          A string name identifying the *note DocTest: 321b.  Typically,
          this is the name of the object or file that the test was
          extracted from.

      -- Attribute: filename

          The name of the file that this *note DocTest: 321b. was
          extracted from; or ‘None’ if the filename is unknown, or if
          the *note DocTest: 321b. was not extracted from a file.

      -- Attribute: lineno

          The line number within *note filename: 3225. where this *note
          DocTest: 321b. begins, or ‘None’ if the line number is
          unavailable.  This line number is zero-based with respect to
          the beginning of the file.

      -- Attribute: docstring

          The string that the test was extracted from, or ‘None’ if the
          string is unavailable, or if the test was not extracted from a
          string.


File: python.info,  Node: Example Objects,  Next: DocTestFinder objects,  Prev: DocTest Objects,  Up: Advanced API

5.27.3.15 Example Objects
.........................

 -- Class: doctest.Example (source, want, exc_msg=None, lineno=0,
          indent=0, options=None)

     A single interactive example, consisting of a Python statement and
     its expected output.  The constructor arguments are used to
     initialize the attributes of the same names.

     *note Example: 321f. defines the following attributes.  They are
     initialized by the constructor, and should not be modified
     directly.

      -- Attribute: source

          A string containing the example’s source code.  This source
          code consists of a single Python statement, and always ends
          with a newline; the constructor adds a newline when necessary.

      -- Attribute: want

          The expected output from running the example’s source code
          (either from stdout, or a traceback in case of exception).
          *note want: 322b. ends with a newline unless no output is
          expected, in which case it’s an empty string.  The constructor
          adds a newline when necessary.

      -- Attribute: exc_msg

          The exception message generated by the example, if the example
          is expected to generate an exception; or ‘None’ if it is not
          expected to generate an exception.  This exception message is
          compared against the return value of *note
          traceback.format_exception_only(): 322d.  *note exc_msg: 322c.
          ends with a newline unless it’s ‘None’.  The constructor adds
          a newline if needed.

      -- Attribute: lineno

          The line number within the string containing this example
          where the example begins.  This line number is zero-based with
          respect to the beginning of the containing string.

      -- Attribute: indent

          The example’s indentation in the containing string, i.e., the
          number of space characters that precede the example’s first
          prompt.

      -- Attribute: options

          A dictionary mapping from option flags to ‘True’ or ‘False’,
          which is used to override default options for this example.
          Any option flags not contained in this dictionary are left at
          their default value (as specified by the *note DocTestRunner:
          320c.’s ‘optionflags’).  By default, no options are set.


File: python.info,  Node: DocTestFinder objects,  Next: DocTestParser objects,  Prev: Example Objects,  Up: Advanced API

5.27.3.16 DocTestFinder objects
...............................

 -- Class: doctest.DocTestFinder (verbose=False, parser=DocTestParser(),
          recurse=True, exclude_empty=True)

     A processing class used to extract the *note DocTest: 321b.s that
     are relevant to a given object, from its docstring and the
     docstrings of its contained objects.  *note DocTest: 321b.s can be
     extracted from modules, classes, functions, methods, staticmethods,
     classmethods, and properties.

     The optional argument `verbose' can be used to display the objects
     searched by the finder.  It defaults to ‘False’ (no output).

     The optional argument `parser' specifies the *note DocTestParser:
     31fc. object (or a drop-in replacement) that is used to extract
     doctests from docstrings.

     If the optional argument `recurse' is false, then *note
     DocTestFinder.find(): 3233. will only examine the given object, and
     not any contained objects.

     If the optional argument `exclude_empty' is false, then *note
     DocTestFinder.find(): 3233. will include tests for objects with
     empty docstrings.

     *note DocTestFinder: 3216. defines the following method:

      -- Method: find (obj[, name][, module][, globs][, extraglobs])

          Return a list of the *note DocTest: 321b.s that are defined by
          `obj'’s docstring, or by any of its contained objects’
          docstrings.

          The optional argument `name' specifies the object’s name; this
          name will be used to construct names for the returned *note
          DocTest: 321b.s.  If `name' is not specified, then
          ‘obj.__name__’ is used.

          The optional parameter `module' is the module that contains
          the given object.  If the module is not specified or is
          ‘None’, then the test finder will attempt to automatically
          determine the correct module.  The object’s module is used:

             * As a default namespace, if `globs' is not specified.

             * To prevent the DocTestFinder from extracting DocTests
               from objects that are imported from other modules.
               (Contained objects with modules other than `module' are
               ignored.)

             * To find the name of the file containing the object.

             * To help find the line number of the object within its
               file.

          If `module' is ‘False’, no attempt to find the module will be
          made.  This is obscure, of use mostly in testing doctest
          itself: if `module' is ‘False’, or is ‘None’ but cannot be
          found automatically, then all objects are considered to belong
          to the (non-existent) module, so all contained objects will
          (recursively) be searched for doctests.

          The globals for each *note DocTest: 321b. is formed by
          combining `globs' and `extraglobs' (bindings in `extraglobs'
          override bindings in `globs').  A new shallow copy of the
          globals dictionary is created for each *note DocTest: 321b.
          If `globs' is not specified, then it defaults to the module’s
          `__dict__', if specified, or ‘{}’ otherwise.  If `extraglobs'
          is not specified, then it defaults to ‘{}’.


File: python.info,  Node: DocTestParser objects,  Next: DocTestRunner objects,  Prev: DocTestFinder objects,  Up: Advanced API

5.27.3.17 DocTestParser objects
...............................

 -- Class: doctest.DocTestParser

     A processing class used to extract interactive examples from a
     string, and use them to create a *note DocTest: 321b. object.

     *note DocTestParser: 31fc. defines the following methods:

      -- Method: get_doctest (string, globs, name, filename, lineno)

          Extract all doctest examples from the given string, and
          collect them into a *note DocTest: 321b. object.

          `globs', `name', `filename', and `lineno' are attributes for
          the new *note DocTest: 321b. object.  See the documentation
          for *note DocTest: 321b. for more information.

      -- Method: get_examples (string, name='<string>')

          Extract all doctest examples from the given string, and return
          them as a list of *note Example: 321f. objects.  Line numbers
          are 0-based.  The optional argument `name' is a name
          identifying this string, and is only used for error messages.

      -- Method: parse (string, name='<string>')

          Divide the given string into examples and intervening text,
          and return them as a list of alternating *note Example: 321f.s
          and strings.  Line numbers for the *note Example: 321f.s are
          0-based.  The optional argument `name' is a name identifying
          this string, and is only used for error messages.


File: python.info,  Node: DocTestRunner objects,  Next: OutputChecker objects,  Prev: DocTestParser objects,  Up: Advanced API

5.27.3.18 DocTestRunner objects
...............................

 -- Class: doctest.DocTestRunner (checker=None, verbose=None,
          optionflags=0)

     A processing class used to execute and verify the interactive
     examples in a *note DocTest: 321b.

     The comparison between expected outputs and actual outputs is done
     by an *note OutputChecker: 320b.  This comparison may be customized
     with a number of option flags; see section *note Option Flags: 830.
     for more information.  If the option flags are insufficient, then
     the comparison may also be customized by passing a subclass of
     *note OutputChecker: 320b. to the constructor.

     The test runner’s display output can be controlled in two ways.
     First, an output function can be passed to ‘TestRunner.run()’; this
     function will be called with strings that should be displayed.  It
     defaults to ‘sys.stdout.write’.  If capturing the output is not
     sufficient, then the display output can be also customized by
     subclassing DocTestRunner, and overriding the methods *note
     report_start(): 323b, *note report_success(): 323c, *note
     report_unexpected_exception(): 323d, and *note report_failure():
     323e.

     The optional keyword argument `checker' specifies the *note
     OutputChecker: 320b. object (or drop-in replacement) that should be
     used to compare the expected outputs to the actual outputs of
     doctest examples.

     The optional keyword argument `verbose' controls the *note
     DocTestRunner: 320c.’s verbosity.  If `verbose' is ‘True’, then
     information is printed about each example, as it is run.  If
     `verbose' is ‘False’, then only failures are printed.  If `verbose'
     is unspecified, or ‘None’, then verbose output is used iff the
     command-line switch ‘-v’ is used.

     The optional keyword argument `optionflags' can be used to control
     how the test runner compares expected output to actual output, and
     how it displays failures.  For more information, see section *note
     Option Flags: 830.

     *note DocTestParser: 31fc. defines the following methods:

      -- Method: report_start (out, test, example)

          Report that the test runner is about to process the given
          example.  This method is provided to allow subclasses of *note
          DocTestRunner: 320c. to customize their output; it should not
          be called directly.

          `example' is the example about to be processed.  `test' is the
          test `containing example'.  `out' is the output function that
          was passed to *note DocTestRunner.run(): 323f.

      -- Method: report_success (out, test, example, got)

          Report that the given example ran successfully.  This method
          is provided to allow subclasses of *note DocTestRunner: 320c.
          to customize their output; it should not be called directly.

          `example' is the example about to be processed.  `got' is the
          actual output from the example.  `test' is the test containing
          `example'.  `out' is the output function that was passed to
          *note DocTestRunner.run(): 323f.

      -- Method: report_failure (out, test, example, got)

          Report that the given example failed.  This method is provided
          to allow subclasses of *note DocTestRunner: 320c. to customize
          their output; it should not be called directly.

          `example' is the example about to be processed.  `got' is the
          actual output from the example.  `test' is the test containing
          `example'.  `out' is the output function that was passed to
          *note DocTestRunner.run(): 323f.

      -- Method: report_unexpected_exception (out, test, example,
               exc_info)

          Report that the given example raised an unexpected exception.
          This method is provided to allow subclasses of *note
          DocTestRunner: 320c. to customize their output; it should not
          be called directly.

          `example' is the example about to be processed.  `exc_info' is
          a tuple containing information about the unexpected exception
          (as returned by *note sys.exc_info(): c52.).  `test' is the
          test containing `example'.  `out' is the output function that
          was passed to *note DocTestRunner.run(): 323f.

      -- Method: run (test, compileflags=None, out=None,
               clear_globs=True)

          Run the examples in `test' (a *note DocTest: 321b. object),
          and display the results using the writer function `out'.

          The examples are run in the namespace ‘test.globs’.  If
          `clear_globs' is true (the default), then this namespace will
          be cleared after the test runs, to help with garbage
          collection.  If you would like to examine the namespace after
          the test completes, then use `clear_globs=False'.

          `compileflags' gives the set of flags that should be used by
          the Python compiler when running the examples.  If not
          specified, then it will default to the set of future-import
          flags that apply to `globs'.

          The output of each example is checked using the *note
          DocTestRunner: 320c.’s output checker, and the results are
          formatted by the ‘DocTestRunner.report_*()’ methods.

      -- Method: summarize (verbose=None)

          Print a summary of all the test cases that have been run by
          this DocTestRunner, and return a *note named tuple: a98.
          ‘TestResults(failed, attempted)’.

          The optional `verbose' argument controls how detailed the
          summary is.  If the verbosity is not specified, then the *note
          DocTestRunner: 320c.’s verbosity is used.


File: python.info,  Node: OutputChecker objects,  Prev: DocTestRunner objects,  Up: Advanced API

5.27.3.19 OutputChecker objects
...............................

 -- Class: doctest.OutputChecker

     A class used to check the whether the actual output from a doctest
     example matches the expected output.  *note OutputChecker: 320b.
     defines two methods: *note check_output(): 3243, which compares a
     given pair of outputs, and returns ‘True’ if they match; and *note
     output_difference(): 3244, which returns a string describing the
     differences between two outputs.

     *note OutputChecker: 320b. defines the following methods:

      -- Method: check_output (want, got, optionflags)

          Return ‘True’ iff the actual output from an example (`got')
          matches the expected output (`want').  These strings are
          always considered to match if they are identical; but
          depending on what option flags the test runner is using,
          several non-exact match types are also possible.  See section
          *note Option Flags: 830. for more information about option
          flags.

      -- Method: output_difference (example, got, optionflags)

          Return a string describing the differences between the
          expected output for a given example (`example') and the actual
          output (`got').  `optionflags' is the set of option flags used
          to compare `want' and `got'.


File: python.info,  Node: Debugging,  Next: Soapbox,  Prev: Advanced API,  Up: doctest — Test interactive Python examples

5.27.3.20 Debugging
...................

Doctest provides several mechanisms for debugging doctest examples:

   * Several functions convert doctests to executable Python programs,
     which can be run under the Python debugger, *note pdb: c9.

   * The *note DebugRunner: 3247. class is a subclass of *note
     DocTestRunner: 320c. that raises an exception for the first failing
     example, containing information about that example.  This
     information can be used to perform post-mortem debugging on the
     example.

   * The *note unittest: 11b. cases generated by *note DocTestSuite():
     6c1. support the *note debug(): 3248. method defined by *note
     unittest.TestCase: 8f3.

   * You can add a call to *note pdb.set_trace(): 3b7. in a doctest
     example, and you’ll drop into the Python debugger when that line is
     executed.  Then you can inspect current values of variables, and so
     on.  For example, suppose ‘a.py’ contains just this module
     docstring:

          """ >>> def f(x): ...     g(x*2) >>> def g(x): ...     print(x+3) ...     import pdb; pdb.set_trace() >>> f(3) 9 """

     Then an interactive Python session may look like this:

          >>> import a, doctest >>> doctest.testmod(a) --Return-- > <doctest a[1]>(3)g()->None -> import pdb; pdb.set_trace() (Pdb) list   1     def g(x):   2         print(x+3)   3  ->     import pdb; pdb.set_trace() [EOF] (Pdb) p x 6 (Pdb) step --Return-- > <doctest a[0]>(2)f()->None -> g(x*2) (Pdb) list   1     def f(x):   2  ->     g(x*2) [EOF] (Pdb) p x 3 (Pdb) step --Return-- > <doctest a[2]>(1)?()->None -> f(3) (Pdb) cont (0, 3) >>>

Functions that convert doctests to Python code, and possibly run the
synthesized code under the debugger:

 -- Function: doctest.script_from_examples (s)

     Convert text with examples to a script.

     Argument `s' is a string containing doctest examples.  The string
     is converted to a Python script, where doctest examples in `s' are
     converted to regular code, and everything else is converted to
     Python comments.  The generated script is returned as a string.
     For example,

          import doctest print(doctest.script_from_examples(r"""     Set x and y to 1 and 2.     >>> x, y = 1, 2      Print their sum:     >>> print(x+y)     3 """))

     displays:

          # Set x and y to 1 and 2. x, y = 1, 2 # # Print their sum: print(x+y) # Expected: ## 3

     This function is used internally by other functions (see below),
     but can also be useful when you want to transform an interactive
     Python session into a Python script.

 -- Function: doctest.testsource (module, name)

     Convert the doctest for an object to a script.

     Argument `module' is a module object, or dotted name of a module,
     containing the object whose doctests are of interest.  Argument
     `name' is the name (within the module) of the object with the
     doctests of interest.  The result is a string, containing the
     object’s docstring converted to a Python script, as described for
     *note script_from_examples(): 3249. above.  For example, if module
     ‘a.py’ contains a top-level function ‘f()’, then

          import a, doctest print(doctest.testsource(a, "a.f"))

     prints a script version of function ‘f()’’s docstring, with
     doctests converted to code, and the rest placed in comments.

 -- Function: doctest.debug (module, name, pm=False)

     Debug the doctests for an object.

     The `module' and `name' arguments are the same as for function
     *note testsource(): 324a. above.  The synthesized Python script for
     the named object’s docstring is written to a temporary file, and
     then that file is run under the control of the Python debugger,
     *note pdb: c9.

     A shallow copy of ‘module.__dict__’ is used for both local and
     global execution context.

     Optional argument `pm' controls whether post-mortem debugging is
     used.  If `pm' has a true value, the script file is run directly,
     and the debugger gets involved only if the script terminates via
     raising an unhandled exception.  If it does, then post-mortem
     debugging is invoked, via *note pdb.post_mortem(): d38, passing the
     traceback object from the unhandled exception.  If `pm' is not
     specified, or is false, the script is run under the debugger from
     the start, via passing an appropriate *note exec(): c37. call to
     *note pdb.run(): 324b.

 -- Function: doctest.debug_src (src, pm=False, globs=None)

     Debug the doctests in a string.

     This is like function *note debug(): 3248. above, except that a
     string containing doctest examples is specified directly, via the
     `src' argument.

     Optional argument `pm' has the same meaning as in function *note
     debug(): 3248. above.

     Optional argument `globs' gives a dictionary to use as both local
     and global execution context.  If not specified, or ‘None’, an
     empty dictionary is used.  If specified, a shallow copy of the
     dictionary is used.

The *note DebugRunner: 3247. class, and the special exceptions it may
raise, are of most interest to testing framework authors, and will only
be sketched here.  See the source code, and especially *note
DebugRunner: 3247.’s docstring (which is a doctest!)  for more details:

 -- Class: doctest.DebugRunner (checker=None, verbose=None,
          optionflags=0)

     A subclass of *note DocTestRunner: 320c. that raises an exception
     as soon as a failure is encountered.  If an unexpected exception
     occurs, an *note UnexpectedException: 324d. exception is raised,
     containing the test, the example, and the original exception.  If
     the output doesn’t match, then a *note DocTestFailure: 324e.
     exception is raised, containing the test, the example, and the
     actual output.

     For information about the constructor parameters and methods, see
     the documentation for *note DocTestRunner: 320c. in section *note
     Advanced API: 321e.

There are two exceptions that may be raised by *note DebugRunner: 3247.
instances:

 -- Exception: doctest.DocTestFailure (test, example, got)

     An exception raised by *note DocTestRunner: 320c. to signal that a
     doctest example’s actual output did not match its expected output.
     The constructor arguments are used to initialize the attributes of
     the same names.

*note DocTestFailure: 324e. defines the following attributes:

 -- Attribute: DocTestFailure.test

     The *note DocTest: 321b. object that was being run when the example
     failed.

 -- Attribute: DocTestFailure.example

     The *note Example: 321f. that failed.

 -- Attribute: DocTestFailure.got

     The example’s actual output.

 -- Exception: doctest.UnexpectedException (test, example, exc_info)

     An exception raised by *note DocTestRunner: 320c. to signal that a
     doctest example raised an unexpected exception.  The constructor
     arguments are used to initialize the attributes of the same names.

*note UnexpectedException: 324d. defines the following attributes:

 -- Attribute: UnexpectedException.test

     The *note DocTest: 321b. object that was being run when the example
     failed.

 -- Attribute: UnexpectedException.example

     The *note Example: 321f. that failed.

 -- Attribute: UnexpectedException.exc_info

     A tuple containing information about the unexpected exception, as
     returned by *note sys.exc_info(): c52.


File: python.info,  Node: Soapbox,  Prev: Debugging,  Up: doctest — Test interactive Python examples

5.27.3.21 Soapbox
.................

As mentioned in the introduction, *note doctest: 67. has grown to have
three primary uses:

  1. Checking examples in docstrings.

  2. Regression testing.

  3. Executable documentation / literate testing.

These uses have different requirements, and it is important to
distinguish them.  In particular, filling your docstrings with obscure
test cases makes for bad documentation.

When writing a docstring, choose docstring examples with care.  There’s
an art to this that needs to be learned—it may not be natural at first.
Examples should add genuine value to the documentation.  A good example
can often be worth many words.  If done with care, the examples will be
invaluable for your users, and will pay back the time it takes to
collect them many times over as the years go by and things change.  I’m
still amazed at how often one of my *note doctest: 67. examples stops
working after a “harmless” change.

Doctest also makes an excellent tool for regression testing, especially
if you don’t skimp on explanatory text.  By interleaving prose and
examples, it becomes much easier to keep track of what’s actually being
tested, and why.  When a test fails, good prose can make it much easier
to figure out what the problem is, and how it should be fixed.  It’s
true that you could write extensive comments in code-based testing, but
few programmers do.  Many have found that using doctest approaches
instead leads to much clearer tests.  Perhaps this is simply because
doctest makes writing prose a little easier than writing code, while
writing comments in code is a little harder.  I think it goes deeper
than just that: the natural attitude when writing a doctest-based test
is that you want to explain the fine points of your software, and
illustrate them with examples.  This in turn naturally leads to test
files that start with the simplest features, and logically progress to
complications and edge cases.  A coherent narrative is the result,
instead of a collection of isolated functions that test isolated bits of
functionality seemingly at random.  It’s a different attitude, and
produces different results, blurring the distinction between testing and
explaining.

Regression testing is best confined to dedicated objects or files.
There are several options for organizing tests:

   * Write text files containing test cases as interactive examples, and
     test the files using *note testfile(): 31f3. or *note
     DocFileSuite(): 321a.  This is recommended, although is easiest to
     do for new projects, designed from the start to use doctest.

   * Define functions named ‘_regrtest_topic’ that consist of single
     docstrings, containing test cases for the named topics.  These
     functions can be included in the same file as the module, or
     separated out into a separate test file.

   * Define a ‘__test__’ dictionary mapping from regression test topics
     to docstrings containing test cases.

When you have placed your tests in a module, the module can itself be
the test runner.  When a test fails, you can arrange for your test
runner to re-run only the failing doctest while you debug the problem.
Here is a minimal example of such a test runner:

     if __name__ == '__main__':     import doctest     flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST     if len(sys.argv) > 1:         name = sys.argv[1]         if name in globals():             obj = globals()[name]         else:             obj = __test__[name]         doctest.run_docstring_examples(obj, globals(), name=name,                                        optionflags=flags)     else:         fail, total = doctest.testmod(optionflags=flags)         print("{} failures out of {} tests".format(fail, total))


File: python.info,  Node: unittest — Unit testing framework,  Next: unittest mock — mock object library,  Prev: doctest — Test interactive Python examples,  Up: Development Tools

5.27.4 ‘unittest’ — Unit testing framework
------------------------------------------

`Source code:' Lib/unittest/__init__.py(1)

__________________________________________________________________

(If you are already familiar with the basic concepts of testing, you
might want to skip to *note the list of assert methods: 3259.)

The *note unittest: 11b. unit testing framework was originally inspired
by JUnit and has a similar flavor as major unit testing frameworks in
other languages.  It supports test automation, sharing of setup and
shutdown code for tests, aggregation of tests into collections, and
independence of the tests from the reporting framework.

To achieve this, *note unittest: 11b. supports some important concepts
in an object-oriented way:

test fixture

     A `test fixture' represents the preparation needed to perform one
     or more tests, and any associated cleanup actions.  This may
     involve, for example, creating temporary or proxy databases,
     directories, or starting a server process.

test case

     A `test case' is the individual unit of testing.  It checks for a
     specific response to a particular set of inputs.  *note unittest:
     11b. provides a base class, *note TestCase: 8f3, which may be used
     to create new test cases.

test suite

     A `test suite' is a collection of test cases, test suites, or both.
     It is used to aggregate tests that should be executed together.

test runner

     A `test runner' is a component which orchestrates the execution of
     tests and provides the outcome to the user.  The runner may use a
     graphical interface, a textual interface, or return a special value
     to indicate the results of executing the tests.

See also
........

Module *note doctest: 67.

     Another test-support module with a very different flavor.

Simple Smalltalk Testing: With Patterns(2)

     Kent Beck’s original paper on testing frameworks using the pattern
     shared by *note unittest: 11b.

pytest(3)

     Third-party unittest framework with a lighter-weight syntax for
     writing tests.  For example, ‘assert func(10) == 42’.

The Python Testing Tools Taxonomy(4)

     An extensive list of Python testing tools including functional
     testing frameworks and mock object libraries.

Testing in Python Mailing List(5)

     A special-interest-group for discussion of testing, and testing
     tools, in Python.

The script ‘Tools/unittestgui/unittestgui.py’ in the Python source
distribution is a GUI tool for test discovery and execution.  This is
intended largely for ease of use for those new to unit testing.  For
production environments it is recommended that tests be driven by a
continuous integration system such as Buildbot(6), Jenkins(7) or
Hudson(8).

* Menu:

* Basic example::
* Command-Line Interface: Command-Line Interface<3>.
* Test Discovery::
* Organizing test code::
* Re-using old test code::
* Skipping tests and expected failures::
* Distinguishing test iterations using subtests::
* Classes and functions::
* Class and Module Fixtures::
* Signal Handling::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/unittest/__init__.py

   (2) 
https://web.archive.org/web/20150315073817/http://www.xprogramming.com/testfram.htm

   (3) https://docs.pytest.org/

   (4) https://wiki.python.org/moin/PythonTestingToolsTaxonomy

   (5) http://lists.idyll.org/listinfo/testing-in-python

   (6) https://buildbot.net/

   (7) https://jenkins.io/

   (8) http://hudson-ci.org/


File: python.info,  Node: Basic example,  Next: Command-Line Interface<3>,  Up: unittest — Unit testing framework

5.27.4.1 Basic example
......................

The *note unittest: 11b. module provides a rich set of tools for
constructing and running tests.  This section demonstrates that a small
subset of the tools suffice to meet the needs of most users.

Here is a short script to test three string methods:

     import unittest  class TestStringMethods(unittest.TestCase):      def test_upper(self):         self.assertEqual('foo'.upper(), 'FOO')      def test_isupper(self):         self.assertTrue('FOO'.isupper())         self.assertFalse('Foo'.isupper())      def test_split(self):         s = 'hello world'         self.assertEqual(s.split(), ['hello', 'world'])         # check that s.split fails when the separator is not a string         with self.assertRaises(TypeError):             s.split(2)  if __name__ == '__main__':     unittest.main()

A testcase is created by subclassing *note unittest.TestCase: 8f3.  The
three individual tests are defined with methods whose names start with
the letters ‘test’.  This naming convention informs the test runner
about which methods represent tests.

The crux of each test is a call to *note assertEqual(): ba8. to check
for an expected result; *note assertTrue(): ba7. or *note assertFalse():
cba. to verify a condition; or *note assertRaises(): aaf. to verify that
a specific exception gets raised.  These methods are used instead of the
*note assert: df9. statement so the test runner can accumulate all test
results and produce a report.

The *note setUp(): cbe. and *note tearDown(): cbf. methods allow you to
define instructions that will be executed before and after each test
method.  They are covered in more detail in the section *note Organizing
test code: 325c.

The final block shows a simple way to run the tests.  *note
unittest.main(): 8f6. provides a command-line interface to the test
script.  When run from the command line, the above script produces an
output that looks like this:

     ... ---------------------------------------------------------------------- Ran 3 tests in 0.000s  OK

Passing the ‘-v’ option to your test script will instruct *note
unittest.main(): 8f6. to enable a higher level of verbosity, and produce
the following output:

     test_isupper (__main__.TestStringMethods) ... ok test_split (__main__.TestStringMethods) ... ok test_upper (__main__.TestStringMethods) ... ok  ---------------------------------------------------------------------- Ran 3 tests in 0.001s  OK

The above examples show the most commonly used *note unittest: 11b.
features which are sufficient to meet many everyday testing needs.  The
remainder of the documentation explores the full feature set from first
principles.


File: python.info,  Node: Command-Line Interface<3>,  Next: Test Discovery,  Prev: Basic example,  Up: unittest — Unit testing framework

5.27.4.2 Command-Line Interface
...............................

The unittest module can be used from the command line to run tests from
modules, classes or even individual test methods:

     python -m unittest test_module1 test_module2 python -m unittest test_module.TestClass python -m unittest test_module.TestClass.test_method

You can pass in a list with any combination of module names, and fully
qualified class or method names.

Test modules can be specified by file path as well:

     python -m unittest tests/test_something.py

This allows you to use the shell filename completion to specify the test
module.  The file specified must still be importable as a module.  The
path is converted to a module name by removing the ‘.py’ and converting
path separators into ‘.’.  If you want to execute a test file that isn’t
importable as a module you should execute the file directly instead.

You can run tests with more detail (higher verbosity) by passing in the
-v flag:

     python -m unittest -v test_module

When executed without arguments *note Test Discovery: 325f. is started:

     python -m unittest

For a list of all the command-line options:

     python -m unittest -h

Changed in version 3.2: In earlier versions it was only possible to run
individual test methods and not modules or classes.

* Menu:

* Command-line options: Command-line options<3>.


File: python.info,  Node: Command-line options<3>,  Up: Command-Line Interface<3>

5.27.4.3 Command-line options
.............................

‘unittest’ supports these command-line options:

 -- Program Option: -b, --buffer

     The standard output and standard error streams are buffered during
     the test run.  Output during a passing test is discarded.  Output
     is echoed normally on test fail or error and is added to the
     failure messages.

 -- Program Option: -c, --catch

     ‘Control-C’ during the test run waits for the current test to end
     and then reports all the results so far.  A second ‘Control-C’
     raises the normal *note KeyboardInterrupt: 197. exception.

     See *note Signal Handling: 3261. for the functions that provide
     this functionality.

 -- Program Option: -f, --failfast

     Stop the test run on the first error or failure.

 -- Program Option: -k

     Only run test methods and classes that match the pattern or
     substring.  This option may be used multiple times, in which case
     all test cases that match of the given patterns are included.

     Patterns that contain a wildcard character (‘*’) are matched
     against the test name using *note fnmatch.fnmatchcase(): 1bb5.;
     otherwise simple case-sensitive substring matching is used.

     Patterns are matched against the fully qualified test method name
     as imported by the test loader.

     For example, ‘-k foo’ matches ‘foo_tests.SomeTest.test_something’,
     ‘bar_tests.SomeTest.test_foo’, but not
     ‘bar_tests.FooTest.test_something’.

 -- Program Option: --locals

     Show local variables in tracebacks.

New in version 3.2: The command-line options ‘-b’, ‘-c’ and ‘-f’ were
added.

New in version 3.5: The command-line option ‘--locals’.

New in version 3.7: The command-line option ‘-k’.

The command line can also be used for test discovery, for running all of
the tests in a project or just a subset.


File: python.info,  Node: Test Discovery,  Next: Organizing test code,  Prev: Command-Line Interface<3>,  Up: unittest — Unit testing framework

5.27.4.4 Test Discovery
.......................

New in version 3.2.

Unittest supports simple test discovery.  In order to be compatible with
test discovery, all of the test files must be *note modules: 11b6. or
*note packages: 11c3. (including *note namespace packages: 13f1.)
importable from the top-level directory of the project (this means that
their filenames must be valid *note identifiers: 130d.).

Test discovery is implemented in *note TestLoader.discover(): 8f8, but
can also be used from the command line.  The basic command-line usage
is:

     cd project_directory python -m unittest discover

     Note: As a shortcut, ‘python -m unittest’ is the equivalent of
     ‘python -m unittest discover’.  If you want to pass arguments to
     test discovery the ‘discover’ sub-command must be used explicitly.

The ‘discover’ sub-command has the following options:

 -- Program Option: -v, --verbose

     Verbose output

 -- Program Option: -s, --start-directory directory

     Directory to start discovery (‘.’ default)

 -- Program Option: -p, --pattern pattern

     Pattern to match test files (‘test*.py’ default)

 -- Program Option: -t, --top-level-directory directory

     Top level directory of project (defaults to start directory)

The *note -s: 3266, *note -p: 3267, and *note -t: 3268. options can be
passed in as positional arguments in that order.  The following two
command lines are equivalent:

     python -m unittest discover -s project_directory -p "*_test.py" python -m unittest discover project_directory "*_test.py"

As well as being a path it is possible to pass a package name, for
example ‘myproject.subpackage.test’, as the start directory.  The
package name you supply will then be imported and its location on the
filesystem will be used as the start directory.

     Caution: Test discovery loads tests by importing them.  Once test
     discovery has found all the test files from the start directory you
     specify it turns the paths into package names to import.  For
     example ‘foo/bar/baz.py’ will be imported as ‘foo.bar.baz’.

     If you have a package installed globally and attempt test discovery
     on a different copy of the package then the import `could' happen
     from the wrong place.  If this happens test discovery will warn you
     and exit.

     If you supply the start directory as a package name rather than a
     path to a directory then discover assumes that whichever location
     it imports from is the location you intended, so you will not get
     the warning.

Test modules and packages can customize test loading and discovery by
through the *note load_tests protocol: 3269.

Changed in version 3.4: Test discovery supports *note namespace
packages: 13f1.


File: python.info,  Node: Organizing test code,  Next: Re-using old test code,  Prev: Test Discovery,  Up: unittest — Unit testing framework

5.27.4.5 Organizing test code
.............................

The basic building blocks of unit testing are `test cases' — single
scenarios that must be set up and checked for correctness.  In *note
unittest: 11b, test cases are represented by *note unittest.TestCase:
8f3. instances.  To make your own test cases you must write subclasses
of *note TestCase: 8f3. or use *note FunctionTestCase: 326b.

The testing code of a *note TestCase: 8f3. instance should be entirely
self contained, such that it can be run either in isolation or in
arbitrary combination with any number of other test cases.

The simplest *note TestCase: 8f3. subclass will simply implement a test
method (i.e.  a method whose name starts with ‘test’) in order to
perform specific testing code:

     import unittest  class DefaultWidgetSizeTestCase(unittest.TestCase):     def test_default_widget_size(self):         widget = Widget('The widget')         self.assertEqual(widget.size(), (50, 50))

Note that in order to test something, we use one of the ‘assert*()’
methods provided by the *note TestCase: 8f3. base class.  If the test
fails, an exception will be raised with an explanatory message, and
*note unittest: 11b. will identify the test case as a `failure'.  Any
other exceptions will be treated as `errors'.

Tests can be numerous, and their set-up can be repetitive.  Luckily, we
can factor out set-up code by implementing a method called *note
setUp(): cbe, which the testing framework will automatically call for
every single test we run:

     import unittest  class WidgetTestCase(unittest.TestCase):     def setUp(self):         self.widget = Widget('The widget')      def test_default_widget_size(self):         self.assertEqual(self.widget.size(), (50,50),                          'incorrect default size')      def test_widget_resize(self):         self.widget.resize(100,150)         self.assertEqual(self.widget.size(), (100,150),                          'wrong size after resize')

     Note: The order in which the various tests will be run is
     determined by sorting the test method names with respect to the
     built-in ordering for strings.

If the *note setUp(): cbe. method raises an exception while the test is
running, the framework will consider the test to have suffered an error,
and the test method will not be executed.

Similarly, we can provide a *note tearDown(): cbf. method that tidies up
after the test method has been run:

     import unittest  class WidgetTestCase(unittest.TestCase):     def setUp(self):         self.widget = Widget('The widget')      def tearDown(self):         self.widget.dispose()

If *note setUp(): cbe. succeeded, *note tearDown(): cbf. will be run
whether the test method succeeded or not.

Such a working environment for the testing code is called a `test
fixture'.  A new TestCase instance is created as a unique test fixture
used to execute each individual test method.  Thus *note setUp(): cbe,
*note tearDown(): cbf, and ‘__init__()’ will be called once per test.

It is recommended that you use TestCase implementations to group tests
together according to the features they test.  *note unittest: 11b.
provides a mechanism for this: the `test suite', represented by *note
unittest: 11b.’s *note TestSuite: 6c2. class.  In most cases, calling
*note unittest.main(): 8f6. will do the right thing and collect all the
module’s test cases for you and execute them.

However, should you want to customize the building of your test suite,
you can do it yourself:

     def suite():     suite = unittest.TestSuite()     suite.addTest(WidgetTestCase('test_default_widget_size'))     suite.addTest(WidgetTestCase('test_widget_resize'))     return suite  if __name__ == '__main__':     runner = unittest.TextTestRunner()     runner.run(suite())

You can place the definitions of test cases and test suites in the same
modules as the code they are to test (such as ‘widget.py’), but there
are several advantages to placing the test code in a separate module,
such as ‘test_widget.py’:

   * The test module can be run standalone from the command line.

   * The test code can more easily be separated from shipped code.

   * There is less temptation to change test code to fit the code it
     tests without a good reason.

   * Test code should be modified much less frequently than the code it
     tests.

   * Tested code can be refactored more easily.

   * Tests for modules written in C must be in separate modules anyway,
     so why not be consistent?

   * If the testing strategy changes, there is no need to change the
     source code.


File: python.info,  Node: Re-using old test code,  Next: Skipping tests and expected failures,  Prev: Organizing test code,  Up: unittest — Unit testing framework

5.27.4.6 Re-using old test code
...............................

Some users will find that they have existing test code that they would
like to run from *note unittest: 11b, without converting every old test
function to a *note TestCase: 8f3. subclass.

For this reason, *note unittest: 11b. provides a *note FunctionTestCase:
326b. class.  This subclass of *note TestCase: 8f3. can be used to wrap
an existing test function.  Set-up and tear-down functions can also be
provided.

Given the following test function:

     def testSomething():     something = makeSomething()     assert something.name is not None     # ...

one can create an equivalent test case instance as follows, with
optional set-up and tear-down methods:

     testcase = unittest.FunctionTestCase(testSomething,                                      setUp=makeSomethingDB,                                      tearDown=deleteSomethingDB)

     Note: Even though *note FunctionTestCase: 326b. can be used to
     quickly convert an existing test base over to a *note unittest:
     11b.-based system, this approach is not recommended.  Taking the
     time to set up proper *note TestCase: 8f3. subclasses will make
     future test refactorings infinitely easier.

In some cases, the existing tests may have been written using the *note
doctest: 67. module.  If so, *note doctest: 67. provides a
‘DocTestSuite’ class that can automatically build *note
unittest.TestSuite: 6c2. instances from the existing *note doctest:
67.-based tests.


File: python.info,  Node: Skipping tests and expected failures,  Next: Distinguishing test iterations using subtests,  Prev: Re-using old test code,  Up: unittest — Unit testing framework

5.27.4.7 Skipping tests and expected failures
.............................................

New in version 3.1.

Unittest supports skipping individual test methods and even whole
classes of tests.  In addition, it supports marking a test as an
“expected failure,” a test that is broken and will fail, but shouldn’t
be counted as a failure on a *note TestResult: ab4.

Skipping a test is simply a matter of using the *note skip(): eb1. *note
decorator: 281. or one of its conditional variants, calling *note
TestCase.skipTest(): 3270. within a *note setUp(): cbe. or test method,
or raising *note SkipTest: 8f7. directly.

Basic skipping looks like this:

     class MyTestCase(unittest.TestCase):      @unittest.skip("demonstrating skipping")     def test_nothing(self):         self.fail("shouldn't happen")      @unittest.skipIf(mylib.__version__ < (1, 3),                      "not supported in this library version")     def test_format(self):         # Tests that work for only a certain version of the library.         pass      @unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")     def test_windows_support(self):         # windows specific testing code         pass      def test_maybe_skipped(self):         if not external_resource_available():             self.skipTest("external resource not available")         # test code that depends on the external resource         pass

This is the output of running the example above in verbose mode:

     test_format (__main__.MyTestCase) ... skipped 'not supported in this library version' test_nothing (__main__.MyTestCase) ... skipped 'demonstrating skipping' test_maybe_skipped (__main__.MyTestCase) ... skipped 'external resource not available' test_windows_support (__main__.MyTestCase) ... skipped 'requires Windows'  ---------------------------------------------------------------------- Ran 4 tests in 0.005s  OK (skipped=4)

Classes can be skipped just like methods:

     @unittest.skip("showing class skipping") class MySkippedTestCase(unittest.TestCase):     def test_not_run(self):         pass

*note TestCase.setUp(): cbe. can also skip the test.  This is useful
when a resource that needs to be set up is not available.

Expected failures use the *note expectedFailure(): 3271. decorator.

     class ExpectedFailureTestCase(unittest.TestCase):     @unittest.expectedFailure     def test_fail(self):         self.assertEqual(1, 0, "broken")

It’s easy to roll your own skipping decorators by making a decorator
that calls *note skip(): eb1. on the test when it wants it to be
skipped.  This decorator skips the test unless the passed object has a
certain attribute:

     def skipUnlessHasattr(obj, attr):     if hasattr(obj, attr):         return lambda func: func     return unittest.skip("{!r} doesn't have {!r}".format(obj, attr))

The following decorators and exception implement test skipping and
expected failures:

 -- Function: @unittest.skip (reason)

     Unconditionally skip the decorated test.  `reason' should describe
     why the test is being skipped.

 -- Function: @unittest.skipIf (condition, reason)

     Skip the decorated test if `condition' is true.

 -- Function: @unittest.skipUnless (condition, reason)

     Skip the decorated test unless `condition' is true.

 -- Function: @unittest.expectedFailure

     Mark the test as an expected failure.  If the test fails it will be
     considered a success.  If the test passes, it will be considered a
     failure.

 -- Exception: unittest.SkipTest (reason)

     This exception is raised to skip a test.

     Usually you can use *note TestCase.skipTest(): 3270. or one of the
     skipping decorators instead of raising this directly.

Skipped tests will not have *note setUp(): cbe. or *note tearDown():
cbf. run around them.  Skipped classes will not have *note setUpClass():
24a. or *note tearDownClass(): cbc. run.  Skipped modules will not have
‘setUpModule()’ or ‘tearDownModule()’ run.


File: python.info,  Node: Distinguishing test iterations using subtests,  Next: Classes and functions,  Prev: Skipping tests and expected failures,  Up: unittest — Unit testing framework

5.27.4.8 Distinguishing test iterations using subtests
......................................................

New in version 3.4.

When there are very small differences among your tests, for instance
some parameters, unittest allows you to distinguish them inside the body
of a test method using the *note subTest(): 8f4. context manager.

For example, the following test:

     class NumbersTest(unittest.TestCase):      def test_even(self):         """         Test that numbers between 0 and 5 are all even.         """         for i in range(0, 6):             with self.subTest(i=i):                 self.assertEqual(i % 2, 0)

will produce the following output:

     ====================================================================== FAIL: test_even (__main__.NumbersTest) (i=1) ---------------------------------------------------------------------- Traceback (most recent call last):   File "subtests.py", line 32, in test_even     self.assertEqual(i % 2, 0) AssertionError: 1 != 0  ====================================================================== FAIL: test_even (__main__.NumbersTest) (i=3) ---------------------------------------------------------------------- Traceback (most recent call last):   File "subtests.py", line 32, in test_even     self.assertEqual(i % 2, 0) AssertionError: 1 != 0  ====================================================================== FAIL: test_even (__main__.NumbersTest) (i=5) ---------------------------------------------------------------------- Traceback (most recent call last):   File "subtests.py", line 32, in test_even     self.assertEqual(i % 2, 0) AssertionError: 1 != 0

Without using a subtest, execution would stop after the first failure,
and the error would be less easy to diagnose because the value of ‘i’
wouldn’t be displayed:

     ====================================================================== FAIL: test_even (__main__.NumbersTest) ---------------------------------------------------------------------- Traceback (most recent call last):   File "subtests.py", line 32, in test_even     self.assertEqual(i % 2, 0) AssertionError: 1 != 0


File: python.info,  Node: Classes and functions,  Next: Class and Module Fixtures,  Prev: Distinguishing test iterations using subtests,  Up: unittest — Unit testing framework

5.27.4.9 Classes and functions
..............................

This section describes in depth the API of *note unittest: 11b.

* Menu:

* Test cases::
* Grouping tests::
* Loading and running tests::


File: python.info,  Node: Test cases,  Next: Grouping tests,  Up: Classes and functions

5.27.4.10 Test cases
....................

 -- Class: unittest.TestCase (methodName='runTest')

     Instances of the *note TestCase: 8f3. class represent the logical
     test units in the *note unittest: 11b. universe.  This class is
     intended to be used as a base class, with specific tests being
     implemented by concrete subclasses.  This class implements the
     interface needed by the test runner to allow it to drive the tests,
     and methods that the test code can use to check for and report
     various kinds of failure.

     Each instance of *note TestCase: 8f3. will run a single base
     method: the method named `methodName'.  In most uses of *note
     TestCase: 8f3, you will neither change the `methodName' nor
     reimplement the default ‘runTest()’ method.

     Changed in version 3.2: *note TestCase: 8f3. can be instantiated
     successfully without providing a `methodName'.  This makes it
     easier to experiment with *note TestCase: 8f3. from the interactive
     interpreter.

     *note TestCase: 8f3. instances provide three groups of methods: one
     group used to run the test, another used by the test implementation
     to check conditions and report failures, and some inquiry methods
     allowing information about the test itself to be gathered.

     Methods in the first group (running the test) are:

      -- Method: setUp ()

          Method called to prepare the test fixture.  This is called
          immediately before calling the test method; other than *note
          AssertionError: f66. or *note SkipTest: 8f7, any exception
          raised by this method will be considered an error rather than
          a test failure.  The default implementation does nothing.

      -- Method: tearDown ()

          Method called immediately after the test method has been
          called and the result recorded.  This is called even if the
          test method raised an exception, so the implementation in
          subclasses may need to be particularly careful about checking
          internal state.  Any exception, other than *note
          AssertionError: f66. or *note SkipTest: 8f7, raised by this
          method will be considered an additional error rather than a
          test failure (thus increasing the total number of reported
          errors).  This method will only be called if the *note
          setUp(): cbe. succeeds, regardless of the outcome of the test
          method.  The default implementation does nothing.

      -- Method: setUpClass ()

          A class method called before tests in an individual class are
          run.  ‘setUpClass’ is called with the class as the only
          argument and must be decorated as a *note classmethod(): 1d6.:

               @classmethod def setUpClass(cls):     ...

          See *note Class and Module Fixtures: 3279. for more details.

          New in version 3.2.

      -- Method: tearDownClass ()

          A class method called after tests in an individual class have
          run.  ‘tearDownClass’ is called with the class as the only
          argument and must be decorated as a *note classmethod(): 1d6.:

               @classmethod def tearDownClass(cls):     ...

          See *note Class and Module Fixtures: 3279. for more details.

          New in version 3.2.

      -- Method: run (result=None)

          Run the test, collecting the result into the *note TestResult:
          ab4. object passed as `result'.  If `result' is omitted or
          ‘None’, a temporary result object is created (by calling the
          *note defaultTestResult(): 327a. method) and used.  The result
          object is returned to *note run(): ab3.’s caller.

          The same effect may be had by simply calling the *note
          TestCase: 8f3. instance.

          Changed in version 3.3: Previous versions of ‘run’ did not
          return the result.  Neither did calling an instance.

      -- Method: skipTest (reason)

          Calling this during a test method or *note setUp(): cbe. skips
          the current test.  See *note Skipping tests and expected
          failures: 326f. for more information.

          New in version 3.1.

      -- Method: subTest (msg=None, **params)

          Return a context manager which executes the enclosed code
          block as a subtest.  `msg' and `params' are optional,
          arbitrary values which are displayed whenever a subtest fails,
          allowing you to identify them clearly.

          A test case can contain any number of subtest declarations,
          and they can be arbitrarily nested.

          See *note Distinguishing test iterations using subtests: 8f5.
          for more information.

          New in version 3.4.

      -- Method: debug ()

          Run the test without collecting the result.  This allows
          exceptions raised by the test to be propagated to the caller,
          and can be used to support running tests under a debugger.
     The *note TestCase: 8f3. class provides several assert methods to
     check for and report failures.  The following table lists the most
     commonly used methods (see the tables below for more assert
     methods):

     Method                                        Checks that                       New in
                                                                                     
     ----------------------------------------------------------------------------------------------------
                                                                                     
     *note assertEqual(a, b): ba8.                 ‘a == b’
                                                   
                                                                                     
     *note assertNotEqual(a, b): ba9.              ‘a != b’
                                                   
                                                                                     
     *note assertTrue(x): ba7.                     ‘bool(x) is True’
                                                   
                                                                                     
     *note assertFalse(x): cba.                    ‘bool(x) is False’
                                                   
                                                                                     
     *note assertIs(a, b): cc2.                    ‘a is b’                          3.1
                                                                                     
                                                                                     
     *note assertIsNot(a, b): cc3.                 ‘a is not b’                      3.1
                                                                                     
                                                                                     
     *note assertIsNone(x): cc0.                   ‘x is None’                       3.1
                                                                                     
                                                                                     
     *note assertIsNotNone(x): cc1.                ‘x is not None’                   3.1
                                                                                     
                                                                                     
     *note assertIn(a, b): ccb.                    ‘a in b’                          3.1
                                                                                     
                                                                                     
     *note assertNotIn(a, b): ccc.                 ‘a not in b’                      3.1
                                                                                     
                                                                                     
     *note assertIsInstance(a, b): cc4.            ‘isinstance(a, b)’                3.2
                                                                                     
                                                                                     
     *note assertNotIsInstance(a, b): cc5.         ‘not isinstance(a, b)’            3.2
                                                                                     

     All the assert methods accept a `msg' argument that, if specified,
     is used as the error message on failure (see also *note
     longMessage: cbb.).  Note that the `msg' keyword argument can be
     passed to *note assertRaises(): aaf, *note assertRaisesRegex():
     ab0, *note assertWarns(): ab1, *note assertWarnsRegex(): ab2. only
     when they are used as a context manager.

      -- Method: assertEqual (first, second, msg=None)

          Test that `first' and `second' are equal.  If the values do
          not compare equal, the test will fail.

          In addition, if `first' and `second' are the exact same type
          and one of list, tuple, dict, set, frozenset or str or any
          type that a subclass registers with *note
          addTypeEqualityFunc(): cd4. the type-specific equality
          function will be called in order to generate a more useful
          default error message (see also the *note list of
          type-specific methods: 327b.).

          Changed in version 3.1: Added the automatic calling of
          type-specific equality function.

          Changed in version 3.2: *note assertMultiLineEqual(): cca.
          added as the default type equality function for comparing
          strings.

      -- Method: assertNotEqual (first, second, msg=None)

          Test that `first' and `second' are not equal.  If the values
          do compare equal, the test will fail.

      -- Method: assertTrue (expr, msg=None)
      -- Method: assertFalse (expr, msg=None)

          Test that `expr' is true (or false).

          Note that this is equivalent to ‘bool(expr) is True’ and not
          to ‘expr is True’ (use ‘assertIs(expr, True)’ for the latter).
          This method should also be avoided when more specific methods
          are available (e.g.  ‘assertEqual(a, b)’ instead of
          ‘assertTrue(a == b)’), because they provide a better error
          message in case of failure.

      -- Method: assertIs (first, second, msg=None)
      -- Method: assertIsNot (first, second, msg=None)

          Test that `first' and `second' evaluate (or don’t evaluate) to
          the same object.

          New in version 3.1.

      -- Method: assertIsNone (expr, msg=None)
      -- Method: assertIsNotNone (expr, msg=None)

          Test that `expr' is (or is not) ‘None’.

          New in version 3.1.

      -- Method: assertIn (first, second, msg=None)
      -- Method: assertNotIn (first, second, msg=None)

          Test that `first' is (or is not) in `second'.

          New in version 3.1.

      -- Method: assertIsInstance (obj, cls, msg=None)
      -- Method: assertNotIsInstance (obj, cls, msg=None)

          Test that `obj' is (or is not) an instance of `cls' (which can
          be a class or a tuple of classes, as supported by *note
          isinstance(): 444.).  To check for the exact type, use *note
          assertIs(type(obj), cls): cc2.

          New in version 3.2.

     It is also possible to check the production of exceptions,
     warnings, and log messages using the following methods:

     Method                                                        Checks that                                New in
                                                                                                              
     --------------------------------------------------------------------------------------------------------------------------
                                                                                                              
     *note assertRaises(exc, fun, *args, **kwds): aaf.             ‘fun(*args, **kwds)’ raises `exc'
                                                                   
                                                                                                              
     *note assertRaisesRegex(exc, r, fun, *args, **kwds): ab0.     ‘fun(*args, **kwds)’ raises `exc' and      3.1
                                                                   the message matches regex `r'              
                                                                   
                                                                                                              
     *note assertWarns(warn, fun, *args, **kwds): ab1.             ‘fun(*args, **kwds)’ raises `warn'         3.2
                                                                                                              
                                                                                                              
     *note assertWarnsRegex(warn, r, fun, *args, **kwds): ab2.     ‘fun(*args, **kwds)’ raises `warn' and     3.2
                                                                   the message matches regex `r'              
                                                                   
                                                                                                              
     *note assertLogs(logger, level): 8f9.                         The ‘with’ block logs on `logger' with     3.4
                                                                   minimum `level'                            
                                                                   

      -- Method: assertRaises (exception, callable, *args, **kwds)

      -- Method: assertRaises (exception, *, msg=None)

          Test that an exception is raised when `callable' is called
          with any positional or keyword arguments that are also passed
          to *note assertRaises(): aaf.  The test passes if `exception'
          is raised, is an error if another exception is raised, or
          fails if no exception is raised.  To catch any of a group of
          exceptions, a tuple containing the exception classes may be
          passed as `exception'.

          If only the `exception' and possibly the `msg' arguments are
          given, return a context manager so that the code under test
          can be written inline rather than as a function:

               with self.assertRaises(SomeException):     do_something()

          When used as a context manager, *note assertRaises(): aaf.
          accepts the additional keyword argument `msg'.

          The context manager will store the caught exception object in
          its ‘exception’ attribute.  This can be useful if the
          intention is to perform additional checks on the exception
          raised:

               with self.assertRaises(SomeException) as cm:     do_something()  the_exception = cm.exception self.assertEqual(the_exception.error_code, 3)

          Changed in version 3.1: Added the ability to use *note
          assertRaises(): aaf. as a context manager.

          Changed in version 3.2: Added the ‘exception’ attribute.

          Changed in version 3.3: Added the `msg' keyword argument when
          used as a context manager.

      -- Method: assertRaisesRegex (exception, regex, callable, *args,
               **kwds)

      -- Method: assertRaisesRegex (exception, regex, *, msg=None)

          Like *note assertRaises(): aaf. but also tests that `regex'
          matches on the string representation of the raised exception.
          `regex' may be a regular expression object or a string
          containing a regular expression suitable for use by *note
          re.search(): ba5.  Examples:

               self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",                        int, 'XYZ')

          or:

               with self.assertRaisesRegex(ValueError, 'literal'):    int('XYZ')

          New in version 3.1: Added under the name ‘assertRaisesRegexp’.

          Changed in version 3.2: Renamed to *note assertRaisesRegex():
          ab0.

          Changed in version 3.3: Added the `msg' keyword argument when
          used as a context manager.

      -- Method: assertWarns (warning, callable, *args, **kwds)

      -- Method: assertWarns (warning, *, msg=None)

          Test that a warning is triggered when `callable' is called
          with any positional or keyword arguments that are also passed
          to *note assertWarns(): ab1.  The test passes if `warning' is
          triggered and fails if it isn’t.  Any exception is an error.
          To catch any of a group of warnings, a tuple containing the
          warning classes may be passed as `warnings'.

          If only the `warning' and possibly the `msg' arguments are
          given, return a context manager so that the code under test
          can be written inline rather than as a function:

               with self.assertWarns(SomeWarning):     do_something()

          When used as a context manager, *note assertWarns(): ab1.
          accepts the additional keyword argument `msg'.

          The context manager will store the caught warning object in
          its ‘warning’ attribute, and the source line which triggered
          the warnings in the ‘filename’ and ‘lineno’ attributes.  This
          can be useful if the intention is to perform additional checks
          on the warning caught:

               with self.assertWarns(SomeWarning) as cm:     do_something()  self.assertIn('myfile.py', cm.filename) self.assertEqual(320, cm.lineno)

          This method works regardless of the warning filters in place
          when it is called.

          New in version 3.2.

          Changed in version 3.3: Added the `msg' keyword argument when
          used as a context manager.

      -- Method: assertWarnsRegex (warning, regex, callable, *args,
               **kwds)

      -- Method: assertWarnsRegex (warning, regex, *, msg=None)

          Like *note assertWarns(): ab1. but also tests that `regex'
          matches on the message of the triggered warning.  `regex' may
          be a regular expression object or a string containing a
          regular expression suitable for use by *note re.search(): ba5.
          Example:

               self.assertWarnsRegex(DeprecationWarning,                       r'legacy_function\(\) is deprecated',                       legacy_function, 'XYZ')

          or:

               with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):     frobnicate('/etc/passwd')

          New in version 3.2.

          Changed in version 3.3: Added the `msg' keyword argument when
          used as a context manager.

      -- Method: assertLogs (logger=None, level=None)

          A context manager to test that at least one message is logged
          on the `logger' or one of its children, with at least the
          given `level'.

          If given, `logger' should be a *note logging.Logger: 39c.
          object or a *note str: 325. giving the name of a logger.  The
          default is the root logger, which will catch all messages.

          If given, `level' should be either a numeric logging level or
          its string equivalent (for example either ‘"ERROR"’ or
          ‘logging.ERROR’).  The default is ‘logging.INFO’.

          The test passes if at least one message emitted inside the
          ‘with’ block matches the `logger' and `level' conditions,
          otherwise it fails.

          The object returned by the context manager is a recording
          helper which keeps tracks of the matching log messages.  It
          has two attributes:

           -- Attribute: records

               A list of *note logging.LogRecord: 8fa. objects of the
               matching log messages.

           -- Attribute: output

               A list of *note str: 325. objects with the formatted
               output of matching messages.

          Example:

               with self.assertLogs('foo', level='INFO') as cm:    logging.getLogger('foo').info('first message')    logging.getLogger('foo.bar').error('second message') self.assertEqual(cm.output, ['INFO:foo:first message',                              'ERROR:foo.bar:second message'])

          New in version 3.4.

     There are also other methods used to perform more specific checks,
     such as:

     Method                                      Checks that                          New in
                                                                                      
     ----------------------------------------------------------------------------------------------------
                                                                                      
     *note assertAlmostEqual(a, b): baa.         ‘round(a-b, 7) == 0’
                                                 
                                                                                      
     *note assertNotAlmostEqual(a, b): bab.      ‘round(a-b, 7) != 0’
                                                 
                                                                                      
     *note assertGreater(a, b): cc6.             ‘a > b’                              3.1
                                                                                      
                                                                                      
     *note assertGreaterEqual(a, b): cc7.        ‘a >= b’                             3.1
                                                                                      
                                                                                      
     *note assertLess(a, b): cc8.                ‘a < b’                              3.1
                                                                                      
                                                                                      
     *note assertLessEqual(a, b): cc9.           ‘a <= b’                             3.1
                                                                                      
                                                                                      
     *note assertRegex(s, r): ba4.               ‘r.search(s)’                        3.1
                                                                                      
                                                                                      
     *note assertNotRegex(s, r): 327e.           ‘not r.search(s)’                    3.2
                                                                                      
                                                                                      
     *note assertCountEqual(a, b): ba2.          `a' and `b' have the same elements   3.2
                                                 in the same number, regardless of    
                                                 their order.
                                                 

      -- Method: assertAlmostEqual (first, second, places=7, msg=None,
               delta=None)
      -- Method: assertNotAlmostEqual (first, second, places=7,
               msg=None, delta=None)

          Test that `first' and `second' are approximately (or not
          approximately) equal by computing the difference, rounding to
          the given number of decimal `places' (default 7), and
          comparing to zero.  Note that these methods round the values
          to the given number of `decimal places' (i.e.  like the *note
          round(): c60. function) and not `significant digits'.

          If `delta' is supplied instead of `places' then the difference
          between `first' and `second' must be less or equal to (or
          greater than) `delta'.

          Supplying both `delta' and `places' raises a *note TypeError:
          192.

          Changed in version 3.2: *note assertAlmostEqual(): baa.
          automatically considers almost equal objects that compare
          equal.  *note assertNotAlmostEqual(): bab. automatically fails
          if the objects compare equal.  Added the `delta' keyword
          argument.

      -- Method: assertGreater (first, second, msg=None)
      -- Method: assertGreaterEqual (first, second, msg=None)
      -- Method: assertLess (first, second, msg=None)
      -- Method: assertLessEqual (first, second, msg=None)

          Test that `first' is respectively >, >=, < or <= than `second'
          depending on the method name.  If not, the test will fail:

               >>> self.assertGreaterEqual(3, 4) AssertionError: "3" unexpectedly not greater than or equal to "4"

          New in version 3.1.

      -- Method: assertRegex (text, regex, msg=None)
      -- Method: assertNotRegex (text, regex, msg=None)

          Test that a `regex' search matches (or does not match) `text'.
          In case of failure, the error message will include the pattern
          and the `text' (or the pattern and the part of `text' that
          unexpectedly matched).  `regex' may be a regular expression
          object or a string containing a regular expression suitable
          for use by *note re.search(): ba5.

          New in version 3.1: Added under the name
          ‘assertRegexpMatches’.

          Changed in version 3.2: The method ‘assertRegexpMatches()’ has
          been renamed to *note assertRegex(): ba4.

          New in version 3.2: *note assertNotRegex(): 327e.

          New in version 3.5: The name ‘assertNotRegexpMatches’ is a
          deprecated alias for *note assertNotRegex(): 327e.

      -- Method: assertCountEqual (first, second, msg=None)

          Test that sequence `first' contains the same elements as
          `second', regardless of their order.  When they don’t, an
          error message listing the differences between the sequences
          will be generated.

          Duplicate elements are `not' ignored when comparing `first'
          and `second'.  It verifies whether each element has the same
          count in both sequences.  Equivalent to:
          ‘assertEqual(Counter(list(first)), Counter(list(second)))’ but
          works with sequences of unhashable objects as well.

          New in version 3.2.

     The *note assertEqual(): ba8. method dispatches the equality check
     for objects of the same type to different type-specific methods.
     These methods are already implemented for most of the built-in
     types, but it’s also possible to register new methods using *note
     addTypeEqualityFunc(): cd4.:

      -- Method: addTypeEqualityFunc (typeobj, function)

          Registers a type-specific method called by *note
          assertEqual(): ba8. to check if two objects of exactly the
          same `typeobj' (not subclasses) compare equal.  `function'
          must take two positional arguments and a third msg=None
          keyword argument just as *note assertEqual(): ba8. does.  It
          must raise *note self.failureException(msg): 327f. when
          inequality between the first two parameters is detected –
          possibly providing useful information and explaining the
          inequalities in details in the error message.

          New in version 3.1.

     The list of type-specific methods automatically used by *note
     assertEqual(): ba8. are summarized in the following table.  Note
     that it’s usually not necessary to invoke these methods directly.

     Method                                        Used to compare                   New in
                                                                                     
     ---------------------------------------------------------------------------------------------------
                                                                                     
     *note assertMultiLineEqual(a, b): cca.        strings                           3.1
                                                                                     
                                                                                     
     *note assertSequenceEqual(a, b): cd0.         sequences                         3.1
                                                                                     
                                                                                     
     *note assertListEqual(a, b): cce.             lists                             3.1
                                                                                     
                                                                                     
     *note assertTupleEqual(a, b): ccf.            tuples                            3.1
                                                                                     
                                                                                     
     *note assertSetEqual(a, b): ccd.              sets or frozensets                3.1
                                                                                     
                                                                                     
     *note assertDictEqual(a, b): cd1.             dicts                             3.1
                                                                                     

      -- Method: assertMultiLineEqual (first, second, msg=None)

          Test that the multiline string `first' is equal to the string
          `second'.  When not equal a diff of the two strings
          highlighting the differences will be included in the error
          message.  This method is used by default when comparing
          strings with *note assertEqual(): ba8.

          New in version 3.1.

      -- Method: assertSequenceEqual (first, second, msg=None,
               seq_type=None)

          Tests that two sequences are equal.  If a `seq_type' is
          supplied, both `first' and `second' must be instances of
          `seq_type' or a failure will be raised.  If the sequences are
          different an error message is constructed that shows the
          difference between the two.

          This method is not called directly by *note assertEqual():
          ba8, but it’s used to implement *note assertListEqual(): cce.
          and *note assertTupleEqual(): ccf.

          New in version 3.1.

      -- Method: assertListEqual (first, second, msg=None)
      -- Method: assertTupleEqual (first, second, msg=None)

          Tests that two lists or tuples are equal.  If not, an error
          message is constructed that shows only the differences between
          the two.  An error is also raised if either of the parameters
          are of the wrong type.  These methods are used by default when
          comparing lists or tuples with *note assertEqual(): ba8.

          New in version 3.1.

      -- Method: assertSetEqual (first, second, msg=None)

          Tests that two sets are equal.  If not, an error message is
          constructed that lists the differences between the sets.  This
          method is used by default when comparing sets or frozensets
          with *note assertEqual(): ba8.

          Fails if either of `first' or `second' does not have a
          ‘set.difference()’ method.

          New in version 3.1.

      -- Method: assertDictEqual (first, second, msg=None)

          Test that two dictionaries are equal.  If not, an error
          message is constructed that shows the differences in the
          dictionaries.  This method will be used by default to compare
          dictionaries in calls to *note assertEqual(): ba8.

          New in version 3.1.

     Finally the *note TestCase: 8f3. provides the following methods and
     attributes:

      -- Method: fail (msg=None)

          Signals a test failure unconditionally, with `msg' or ‘None’
          for the error message.

      -- Attribute: failureException

          This class attribute gives the exception raised by the test
          method.  If a test framework needs to use a specialized
          exception, possibly to carry additional information, it must
          subclass this exception in order to “play fair” with the
          framework.  The initial value of this attribute is *note
          AssertionError: f66.

      -- Attribute: longMessage

          This class attribute determines what happens when a custom
          failure message is passed as the msg argument to an assertXYY
          call that fails.  ‘True’ is the default value.  In this case,
          the custom message is appended to the end of the standard
          failure message.  When set to ‘False’, the custom message
          replaces the standard message.

          The class setting can be overridden in individual test methods
          by assigning an instance attribute, self.longMessage, to
          ‘True’ or ‘False’ before calling the assert methods.

          The class setting gets reset before each test call.

          New in version 3.1.

      -- Attribute: maxDiff

          This attribute controls the maximum length of diffs output by
          assert methods that report diffs on failure.  It defaults to
          80*8 characters.  Assert methods affected by this attribute
          are *note assertSequenceEqual(): cd0. (including all the
          sequence comparison methods that delegate to it), *note
          assertDictEqual(): cd1. and *note assertMultiLineEqual(): cca.

          Setting ‘maxDiff’ to ‘None’ means that there is no maximum
          length of diffs.

          New in version 3.2.

     Testing frameworks can use the following methods to collect
     information on the test:

      -- Method: countTestCases ()

          Return the number of tests represented by this test object.
          For *note TestCase: 8f3. instances, this will always be ‘1’.

      -- Method: defaultTestResult ()

          Return an instance of the test result class that should be
          used for this test case class (if no other result instance is
          provided to the *note run(): ab3. method).

          For *note TestCase: 8f3. instances, this will always be an
          instance of *note TestResult: ab4.; subclasses of *note
          TestCase: 8f3. should override this as necessary.

      -- Method: id ()

          Return a string identifying the specific test case.  This is
          usually the full name of the test method, including the module
          and class name.

      -- Method: shortDescription ()

          Returns a description of the test, or ‘None’ if no description
          has been provided.  The default implementation of this method
          returns the first line of the test method’s docstring, if
          available, or ‘None’.

          Changed in version 3.1: In 3.1 this was changed to add the
          test name to the short description even in the presence of a
          docstring.  This caused compatibility issues with unittest
          extensions and adding the test name was moved to the *note
          TextTestResult: 3285. in Python 3.2.

      -- Method: addCleanup (function, *args, **kwargs)

          Add a function to be called after *note tearDown(): cbf. to
          cleanup resources used during the test.  Functions will be
          called in reverse order to the order they are added (LIFO).
          They are called with any arguments and keyword arguments
          passed into *note addCleanup(): 2a0. when they are added.

          If *note setUp(): cbe. fails, meaning that *note tearDown():
          cbf. is not called, then any cleanup functions added will
          still be called.

          New in version 3.1.

      -- Method: doCleanups ()

          This method is called unconditionally after *note tearDown():
          cbf, or after *note setUp(): cbe. if *note setUp(): cbe.
          raises an exception.

          It is responsible for calling all the cleanup functions added
          by *note addCleanup(): 2a0.  If you need cleanup functions to
          be called `prior' to *note tearDown(): cbf. then you can call
          *note doCleanups(): cbd. yourself.

          *note doCleanups(): cbd. pops methods off the stack of cleanup
          functions one at a time, so it can be called at any time.

          New in version 3.1.

      -- Class Method: addClassCleanup (function, /, *args, **kwargs)

          Add a function to be called after *note tearDownClass(): cbc.
          to cleanup resources used during the test class.  Functions
          will be called in reverse order to the order they are added
          (LIFO).  They are called with any arguments and keyword
          arguments passed into *note addClassCleanup(): 249. when they
          are added.

          If *note setUpClass(): 24a. fails, meaning that *note
          tearDownClass(): cbc. is not called, then any cleanup
          functions added will still be called.

          New in version 3.8.

      -- Class Method: doClassCleanups ()

          This method is called unconditionally after *note
          tearDownClass(): cbc, or after *note setUpClass(): 24a. if
          *note setUpClass(): 24a. raises an exception.

          It is responsible for calling all the cleanup functions added
          by ‘addCleanupClass()’.  If you need cleanup functions to be
          called `prior' to *note tearDownClass(): cbc. then you can
          call ‘doCleanupsClass()’ yourself.

          ‘doCleanupsClass()’ pops methods off the stack of cleanup
          functions one at a time, so it can be called at any time.

          New in version 3.8.

 -- Class: unittest.IsolatedAsyncioTestCase (methodName='runTest')

     This class provides an API similar to *note TestCase: 8f3. and also
     accepts coroutines as test functions.

     New in version 3.8.

      -- Method: coroutine asyncSetUp ()

          Method called to prepare the test fixture.  This is called
          after ‘setUp()’.  This is called immediately before calling
          the test method; other than *note AssertionError: f66. or
          *note SkipTest: 8f7, any exception raised by this method will
          be considered an error rather than a test failure.  The
          default implementation does nothing.

      -- Method: coroutine asyncTearDown ()

          Method called immediately after the test method has been
          called and the result recorded.  This is called before
          ‘tearDown()’.  This is called even if the test method raised
          an exception, so the implementation in subclasses may need to
          be particularly careful about checking internal state.  Any
          exception, other than *note AssertionError: f66. or *note
          SkipTest: 8f7, raised by this method will be considered an
          additional error rather than a test failure (thus increasing
          the total number of reported errors).  This method will only
          be called if the *note asyncSetUp(): 3287. succeeds,
          regardless of the outcome of the test method.  The default
          implementation does nothing.

      -- Method: addAsyncCleanup (function, /, *args, **kwargs)

          This method accepts a coroutine that can be used as a cleanup
          function.

      -- Method: run (result=None)

          Sets up a new event loop to run the test, collecting the
          result into the *note TestResult: ab4. object passed as
          `result'.  If `result' is omitted or ‘None’, a temporary
          result object is created (by calling the ‘defaultTestResult()’
          method) and used.  The result object is returned to *note
          run(): 328a.’s caller.  At the end of the test all the tasks
          in the event loop are cancelled.

     An example illustrating the order:

          from unittest import IsolatedAsyncioTestCase  events = []   class Test(IsolatedAsyncioTestCase):       def setUp(self):         events.append("setUp")      async def asyncSetUp(self):         self._async_connection = await AsyncConnection()         events.append("asyncSetUp")      async def test_response(self):         events.append("test_response")         response = await self._async_connection.get("https://example.com")         self.assertEqual(response.status_code, 200)         self.addAsyncCleanup(self.on_cleanup)      def tearDown(self):         events.append("tearDown")      async def asyncTearDown(self):         await self._async_connection.close()         events.append("asyncTearDown")      async def on_cleanup(self):         events.append("cleanup")  if __name__ == "__main__":     unittest.main()

     After running the test, ‘events’ would contain ‘["setUp",
     "asyncSetUp", "test_response", "asyncTearDown", "tearDown",
     "cleanup"]’.

 -- Class: unittest.FunctionTestCase (testFunc, setUp=None,
          tearDown=None, description=None)

     This class implements the portion of the *note TestCase: 8f3.
     interface which allows the test runner to drive the test, but does
     not provide the methods which test code can use to check and report
     errors.  This is used to create test cases using legacy test code,
     allowing it to be integrated into a *note unittest: 11b.-based test
     framework.

* Menu:

* Deprecated aliases::


File: python.info,  Node: Deprecated aliases,  Up: Test cases

5.27.4.11 Deprecated aliases
............................

For historical reasons, some of the *note TestCase: 8f3. methods had one
or more aliases that are now deprecated.  The following table lists the
correct names along with their deprecated aliases:

     Method Name                        Deprecated alias           Deprecated alias
                                                                   
     ------------------------------------------------------------------------------------------
                                                                   
     *note assertEqual(): ba8.          failUnlessEqual            assertEquals
                                                                   
                                                                   
     *note assertNotEqual(): ba9.       failIfEqual                assertNotEquals
                                                                   
                                                                   
     *note assertTrue(): ba7.           failUnless                 assert_
                                                                   
                                                                   
     *note assertFalse(): cba.          failIf
                                        
                                                                   
     *note assertRaises(): aaf.         failUnlessRaises
                                        
                                                                   
     *note assertAlmostEqual(): baa.    failUnlessAlmostEqual      assertAlmostEquals
                                                                   
                                                                   
     *note assertNotAlmostEqual(): bab. failIfAlmostEqual          assertNotAlmostEquals
                                                                   
                                                                   
     *note assertRegex(): ba4.                                     assertRegexpMatches
                                                                   
                                                                   
     *note assertNotRegex(): 327e.                                 assertNotRegexpMatches
                                                                   
                                                                   
     *note assertRaisesRegex(): ab0.                               assertRaisesRegexp
                                                                   

     Deprecated since version 3.1: The fail* aliases listed in the
     second column have been deprecated.

     Deprecated since version 3.2: The assert* aliases listed in the
     third column have been deprecated.

     Deprecated since version 3.2: ‘assertRegexpMatches’ and
     ‘assertRaisesRegexp’ have been renamed to *note assertRegex(): ba4.
     and *note assertRaisesRegex(): ab0.

     Deprecated since version 3.5: The ‘assertNotRegexpMatches’ name is
     deprecated in favor of *note assertNotRegex(): 327e.


File: python.info,  Node: Grouping tests,  Next: Loading and running tests,  Prev: Test cases,  Up: Classes and functions

5.27.4.12 Grouping tests
........................

 -- Class: unittest.TestSuite (tests=())

     This class represents an aggregation of individual test cases and
     test suites.  The class presents the interface needed by the test
     runner to allow it to be run as any other test case.  Running a
     *note TestSuite: 6c2. instance is the same as iterating over the
     suite, running each test individually.

     If `tests' is given, it must be an iterable of individual test
     cases or other test suites that will be used to build the suite
     initially.  Additional methods are provided to add test cases and
     suites to the collection later on.

     *note TestSuite: 6c2. objects behave much like *note TestCase: 8f3.
     objects, except they do not actually implement a test.  Instead,
     they are used to aggregate tests into groups of tests that should
     be run together.  Some additional methods are available to add
     tests to *note TestSuite: 6c2. instances:

      -- Method: addTest (test)

          Add a *note TestCase: 8f3. or *note TestSuite: 6c2. to the
          suite.

      -- Method: addTests (tests)

          Add all the tests from an iterable of *note TestCase: 8f3. and
          *note TestSuite: 6c2. instances to this test suite.

          This is equivalent to iterating over `tests', calling *note
          addTest(): 328e. for each element.

     *note TestSuite: 6c2. shares the following methods with *note
     TestCase: 8f3.:

      -- Method: run (result)

          Run the tests associated with this suite, collecting the
          result into the test result object passed as `result'.  Note
          that unlike *note TestCase.run(): ab3, *note TestSuite.run():
          3290. requires the result object to be passed in.

      -- Method: debug ()

          Run the tests associated with this suite without collecting
          the result.  This allows exceptions raised by the test to be
          propagated to the caller and can be used to support running
          tests under a debugger.

      -- Method: countTestCases ()

          Return the number of tests represented by this test object,
          including all individual tests and sub-suites.

      -- Method: __iter__ ()

          Tests grouped by a *note TestSuite: 6c2. are always accessed
          by iteration.  Subclasses can lazily provide tests by
          overriding *note __iter__(): 956.  Note that this method may
          be called several times on a single suite (for example when
          counting tests or comparing for equality) so the tests
          returned by repeated iterations before *note TestSuite.run():
          3290. must be the same for each call iteration.  After *note
          TestSuite.run(): 3290, callers should not rely on the tests
          returned by this method unless the caller uses a subclass that
          overrides ‘TestSuite._removeTestAtIndex()’ to preserve test
          references.

          Changed in version 3.2: In earlier versions the *note
          TestSuite: 6c2. accessed tests directly rather than through
          iteration, so overriding *note __iter__(): 956. wasn’t
          sufficient for providing tests.

          Changed in version 3.4: In earlier versions the *note
          TestSuite: 6c2. held references to each *note TestCase: 8f3.
          after *note TestSuite.run(): 3290.  Subclasses can restore
          that behavior by overriding ‘TestSuite._removeTestAtIndex()’.

     In the typical usage of a *note TestSuite: 6c2. object, the *note
     run(): 3290. method is invoked by a ‘TestRunner’ rather than by the
     end-user test harness.


File: python.info,  Node: Loading and running tests,  Prev: Grouping tests,  Up: Classes and functions

5.27.4.13 Loading and running tests
...................................

 -- Class: unittest.TestLoader

     The *note TestLoader: 776. class is used to create test suites from
     classes and modules.  Normally, there is no need to create an
     instance of this class; the *note unittest: 11b. module provides an
     instance that can be shared as *note unittest.defaultTestLoader:
     3294.  Using a subclass or instance, however, allows customization
     of some configurable properties.

     *note TestLoader: 776. objects have the following attributes:

      -- Attribute: errors

          A list of the non-fatal errors encountered while loading
          tests.  Not reset by the loader at any point.  Fatal errors
          are signalled by the relevant a method raising an exception to
          the caller.  Non-fatal errors are also indicated by a
          synthetic test that will raise the original error when run.

          New in version 3.5.

     *note TestLoader: 776. objects have the following methods:

      -- Method: loadTestsFromTestCase (testCaseClass)

          Return a suite of all test cases contained in the *note
          TestCase: 8f3.-derived ‘testCaseClass’.

          A test case instance is created for each method named by *note
          getTestCaseNames(): 3296.  By default these are the method
          names beginning with ‘test’.  If *note getTestCaseNames():
          3296. returns no methods, but the ‘runTest()’ method is
          implemented, a single test case is created for that method
          instead.

      -- Method: loadTestsFromModule (module, pattern=None)

          Return a suite of all test cases contained in the given
          module.  This method searches `module' for classes derived
          from *note TestCase: 8f3. and creates an instance of the class
          for each test method defined for the class.

               Note: While using a hierarchy of *note TestCase:
               8f3.-derived classes can be convenient in sharing
               fixtures and helper functions, defining test methods on
               base classes that are not intended to be instantiated
               directly does not play well with this method.  Doing so,
               however, can be useful when the fixtures are different
               and defined in subclasses.

          If a module provides a ‘load_tests’ function it will be called
          to load the tests.  This allows modules to customize test
          loading.  This is the *note load_tests protocol: 3269.  The
          `pattern' argument is passed as the third argument to
          ‘load_tests’.

          Changed in version 3.2: Support for ‘load_tests’ added.

          Changed in version 3.5: The undocumented and unofficial
          `use_load_tests' default argument is deprecated and ignored,
          although it is still accepted for backward compatibility.  The
          method also now accepts a keyword-only argument `pattern'
          which is passed to ‘load_tests’ as the third argument.

      -- Method: loadTestsFromName (name, module=None)

          Return a suite of all test cases given a string specifier.

          The specifier `name' is a “dotted name” that may resolve
          either to a module, a test case class, a test method within a
          test case class, a *note TestSuite: 6c2. instance, or a
          callable object which returns a *note TestCase: 8f3. or *note
          TestSuite: 6c2. instance.  These checks are applied in the
          order listed here; that is, a method on a possible test case
          class will be picked up as “a test method within a test case
          class”, rather than “a callable object”.

          For example, if you have a module ‘SampleTests’ containing a
          *note TestCase: 8f3.-derived class ‘SampleTestCase’ with three
          test methods (‘test_one()’, ‘test_two()’, and ‘test_three()’),
          the specifier ‘'SampleTests.SampleTestCase'’ would cause this
          method to return a suite which will run all three test
          methods.  Using the specifier
          ‘'SampleTests.SampleTestCase.test_two'’ would cause it to
          return a test suite which will run only the ‘test_two()’ test
          method.  The specifier can refer to modules and packages which
          have not been imported; they will be imported as a
          side-effect.

          The method optionally resolves `name' relative to the given
          `module'.

          Changed in version 3.5: If an *note ImportError: 329. or *note
          AttributeError: 390. occurs while traversing `name' then a
          synthetic test that raises that error when run will be
          returned.  These errors are included in the errors accumulated
          by self.errors.

      -- Method: loadTestsFromNames (names, module=None)

          Similar to *note loadTestsFromName(): cd2, but takes a
          sequence of names rather than a single name.  The return value
          is a test suite which supports all the tests defined for each
          name.

      -- Method: getTestCaseNames (testCaseClass)

          Return a sorted sequence of method names found within
          `testCaseClass'; this should be a subclass of *note TestCase:
          8f3.

      -- Method: discover (start_dir, pattern='test*.py',
               top_level_dir=None)

          Find all the test modules by recursing into subdirectories
          from the specified start directory, and return a TestSuite
          object containing them.  Only test files that match `pattern'
          will be loaded.  (Using shell style pattern matching.)  Only
          module names that are importable (i.e.  are valid Python
          identifiers) will be loaded.

          All test modules must be importable from the top level of the
          project.  If the start directory is not the top level
          directory then the top level directory must be specified
          separately.

          If importing a module fails, for example due to a syntax
          error, then this will be recorded as a single error and
          discovery will continue.  If the import failure is due to
          *note SkipTest: 8f7. being raised, it will be recorded as a
          skip instead of an error.

          If a package (a directory containing a file named
          ‘__init__.py’) is found, the package will be checked for a
          ‘load_tests’ function.  If this exists then it will be called
          ‘package.load_tests(loader, tests, pattern)’.  Test discovery
          takes care to ensure that a package is only checked for tests
          once during an invocation, even if the load_tests function
          itself calls ‘loader.discover’.

          If ‘load_tests’ exists then discovery does `not' recurse into
          the package, ‘load_tests’ is responsible for loading all tests
          in the package.

          The pattern is deliberately not stored as a loader attribute
          so that packages can continue discovery themselves.
          `top_level_dir' is stored so ‘load_tests’ does not need to
          pass this argument in to ‘loader.discover()’.

          `start_dir' can be a dotted module name as well as a
          directory.

          New in version 3.2.

          Changed in version 3.4: Modules that raise *note SkipTest:
          8f7. on import are recorded as skips, not errors.  Discovery
          works for *note namespace packages: 13f1.  Paths are sorted
          before being imported so that execution order is the same even
          if the underlying file system’s ordering is not dependent on
          file name.

          Changed in version 3.5: Found packages are now checked for
          ‘load_tests’ regardless of whether their path matches
          `pattern', because it is impossible for a package name to
          match the default pattern.

     The following attributes of a *note TestLoader: 776. can be
     configured either by subclassing or assignment on an instance:

      -- Attribute: testMethodPrefix

          String giving the prefix of method names which will be
          interpreted as test methods.  The default value is ‘'test'’.

          This affects *note getTestCaseNames(): 3296. and all the
          ‘loadTestsFrom*()’ methods.

      -- Attribute: sortTestMethodsUsing

          Function to be used to compare method names when sorting them
          in *note getTestCaseNames(): 3296. and all the
          ‘loadTestsFrom*()’ methods.

      -- Attribute: suiteClass

          Callable object that constructs a test suite from a list of
          tests.  No methods on the resulting object are needed.  The
          default value is the *note TestSuite: 6c2. class.

          This affects all the ‘loadTestsFrom*()’ methods.

      -- Attribute: testNamePatterns

          List of Unix shell-style wildcard test name patterns that test
          methods have to match to be included in test suites (see ‘-v’
          option).

          If this attribute is not ‘None’ (the default), all test
          methods to be included in test suites must match one of the
          patterns in this list.  Note that matches are always performed
          using *note fnmatch.fnmatchcase(): 1bb5, so unlike patterns
          passed to the ‘-v’ option, simple substring patterns will have
          to be converted using ‘*’ wildcards.

          This affects all the ‘loadTestsFrom*()’ methods.

          New in version 3.7.

 -- Class: unittest.TestResult

     This class is used to compile information about which tests have
     succeeded and which have failed.

     A *note TestResult: ab4. object stores the results of a set of
     tests.  The *note TestCase: 8f3. and *note TestSuite: 6c2. classes
     ensure that results are properly recorded; test authors do not need
     to worry about recording the outcome of tests.

     Testing frameworks built on top of *note unittest: 11b. may want
     access to the *note TestResult: ab4. object generated by running a
     set of tests for reporting purposes; a *note TestResult: ab4.
     instance is returned by the ‘TestRunner.run()’ method for this
     purpose.

     *note TestResult: ab4. instances have the following attributes that
     will be of interest when inspecting the results of running a set of
     tests:

      -- Attribute: errors

          A list containing 2-tuples of *note TestCase: 8f3. instances
          and strings holding formatted tracebacks.  Each tuple
          represents a test which raised an unexpected exception.

      -- Attribute: failures

          A list containing 2-tuples of *note TestCase: 8f3. instances
          and strings holding formatted tracebacks.  Each tuple
          represents a test where a failure was explicitly signalled
          using the ‘TestCase.assert*()’ methods.

      -- Attribute: skipped

          A list containing 2-tuples of *note TestCase: 8f3. instances
          and strings holding the reason for skipping the test.

          New in version 3.1.

      -- Attribute: expectedFailures

          A list containing 2-tuples of *note TestCase: 8f3. instances
          and strings holding formatted tracebacks.  Each tuple
          represents an expected failure of the test case.

      -- Attribute: unexpectedSuccesses

          A list containing *note TestCase: 8f3. instances that were
          marked as expected failures, but succeeded.

      -- Attribute: shouldStop

          Set to ‘True’ when the execution of tests should stop by *note
          stop(): 32a1.

      -- Attribute: testsRun

          The total number of tests run so far.

      -- Attribute: buffer

          If set to true, ‘sys.stdout’ and ‘sys.stderr’ will be buffered
          in between *note startTest(): 32a4. and *note stopTest():
          32a5. being called.  Collected output will only be echoed onto
          the real ‘sys.stdout’ and ‘sys.stderr’ if the test fails or
          errors.  Any output is also attached to the failure / error
          message.

          New in version 3.2.

      -- Attribute: failfast

          If set to true *note stop(): 32a1. will be called on the first
          failure or error, halting the test run.

          New in version 3.2.

      -- Attribute: tb_locals

          If set to true then local variables will be shown in
          tracebacks.

          New in version 3.5.

      -- Method: wasSuccessful ()

          Return ‘True’ if all tests run so far have passed, otherwise
          returns ‘False’.

          Changed in version 3.4: Returns ‘False’ if there were any
          *note unexpectedSuccesses: 329f. from tests marked with the
          *note expectedFailure(): 3271. decorator.

      -- Method: stop ()

          This method can be called to signal that the set of tests
          being run should be aborted by setting the *note shouldStop:
          32a0. attribute to ‘True’.  ‘TestRunner’ objects should
          respect this flag and return without running any additional
          tests.

          For example, this feature is used by the *note TextTestRunner:
          32a9. class to stop the test framework when the user signals
          an interrupt from the keyboard.  Interactive tools which
          provide ‘TestRunner’ implementations can use this in a similar
          manner.

     The following methods of the *note TestResult: ab4. class are used
     to maintain the internal data structures, and may be extended in
     subclasses to support additional reporting requirements.  This is
     particularly useful in building tools which support interactive
     reporting while tests are being run.

      -- Method: startTest (test)

          Called when the test case `test' is about to be run.

      -- Method: stopTest (test)

          Called after the test case `test' has been executed,
          regardless of the outcome.

      -- Method: startTestRun ()

          Called once before any tests are executed.

          New in version 3.1.

      -- Method: stopTestRun ()

          Called once after all tests are executed.

          New in version 3.1.

      -- Method: addError (test, err)

          Called when the test case `test' raises an unexpected
          exception.  `err' is a tuple of the form returned by *note
          sys.exc_info(): c52.: ‘(type, value, traceback)’.

          The default implementation appends a tuple ‘(test,
          formatted_err)’ to the instance’s *note errors: 329b.
          attribute, where `formatted_err' is a formatted traceback
          derived from `err'.

      -- Method: addFailure (test, err)

          Called when the test case `test' signals a failure.  `err' is
          a tuple of the form returned by *note sys.exc_info(): c52.:
          ‘(type, value, traceback)’.

          The default implementation appends a tuple ‘(test,
          formatted_err)’ to the instance’s *note failures: 329c.
          attribute, where `formatted_err' is a formatted traceback
          derived from `err'.

      -- Method: addSuccess (test)

          Called when the test case `test' succeeds.

          The default implementation does nothing.

      -- Method: addSkip (test, reason)

          Called when the test case `test' is skipped.  `reason' is the
          reason the test gave for skipping.

          The default implementation appends a tuple ‘(test, reason)’ to
          the instance’s *note skipped: 329d. attribute.

      -- Method: addExpectedFailure (test, err)

          Called when the test case `test' fails, but was marked with
          the *note expectedFailure(): 3271. decorator.

          The default implementation appends a tuple ‘(test,
          formatted_err)’ to the instance’s *note expectedFailures:
          329e. attribute, where `formatted_err' is a formatted
          traceback derived from `err'.

      -- Method: addUnexpectedSuccess (test)

          Called when the test case `test' was marked with the *note
          expectedFailure(): 3271. decorator, but succeeded.

          The default implementation appends the test to the instance’s
          *note unexpectedSuccesses: 329f. attribute.

      -- Method: addSubTest (test, subtest, outcome)

          Called when a subtest finishes.  `test' is the test case
          corresponding to the test method.  `subtest' is a custom *note
          TestCase: 8f3. instance describing the subtest.

          If `outcome' is *note None: 157, the subtest succeeded.
          Otherwise, it failed with an exception where `outcome' is a
          tuple of the form returned by *note sys.exc_info(): c52.:
          ‘(type, value, traceback)’.

          The default implementation does nothing when the outcome is a
          success, and records subtest failures as normal failures.

          New in version 3.4.

 -- Class: unittest.TextTestResult (stream, descriptions, verbosity)

     A concrete implementation of *note TestResult: ab4. used by the
     *note TextTestRunner: 32a9.

     New in version 3.2: This class was previously named
     ‘_TextTestResult’.  The old name still exists as an alias but is
     deprecated.

 -- Data: unittest.defaultTestLoader

     Instance of the *note TestLoader: 776. class intended to be shared.
     If no customization of the *note TestLoader: 776. is needed, this
     instance can be used instead of repeatedly creating new instances.

 -- Class: unittest.TextTestRunner (stream=None, descriptions=True,
          verbosity=1, failfast=False, buffer=False, resultclass=None,
          warnings=None, *, tb_locals=False)

     A basic test runner implementation that outputs results to a
     stream.  If `stream' is ‘None’, the default, *note sys.stderr: 304.
     is used as the output stream.  This class has a few configurable
     parameters, but is essentially very simple.  Graphical applications
     which run test suites should provide alternate implementations.
     Such implementations should accept ‘**kwargs’ as the interface to
     construct runners changes when features are added to unittest.

     By default this runner shows *note DeprecationWarning: 276, *note
     PendingDeprecationWarning: 277, *note ResourceWarning: 4c5. and
     *note ImportWarning: 5cd. even if they are *note ignored by
     default: 32b1.  Deprecation warnings caused by *note deprecated
     unittest methods: bac. are also special-cased and, when the warning
     filters are ‘'default'’ or ‘'always'’, they will appear only once
     per-module, in order to avoid too many warning messages.  This
     behavior can be overridden using Python’s ‘-Wd’ or ‘-Wa’ options
     (see *note Warning control: 1286.) and leaving `warnings' to
     ‘None’.

     Changed in version 3.2: Added the ‘warnings’ argument.

     Changed in version 3.2: The default stream is set to *note
     sys.stderr: 304. at instantiation time rather than import time.

     Changed in version 3.5: Added the tb_locals parameter.

      -- Method: _makeResult ()

          This method returns the instance of ‘TestResult’ used by *note
          run(): 32b3.  It is not intended to be called directly, but
          can be overridden in subclasses to provide a custom
          ‘TestResult’.

          ‘_makeResult()’ instantiates the class or callable passed in
          the ‘TextTestRunner’ constructor as the ‘resultclass’
          argument.  It defaults to *note TextTestResult: 3285. if no
          ‘resultclass’ is provided.  The result class is instantiated
          with the following arguments:

               stream, descriptions, verbosity

      -- Method: run (test)

          This method is the main public interface to the
          ‘TextTestRunner’.  This method takes a *note TestSuite: 6c2.
          or *note TestCase: 8f3. instance.  A *note TestResult: ab4. is
          created by calling *note _makeResult(): 32b2. and the test(s)
          are run and the results printed to stdout.

 -- Function: unittest.main (module='__main__', defaultTest=None,
          argv=None, testRunner=None,
          testLoader=unittest.defaultTestLoader, exit=True, verbosity=1,
          failfast=None, catchbreak=None, buffer=None, warnings=None)

     A command-line program that loads a set of tests from `module' and
     runs them; this is primarily for making test modules conveniently
     executable.  The simplest use for this function is to include the
     following line at the end of a test script:

          if __name__ == '__main__':     unittest.main()

     You can run tests with more detailed information by passing in the
     verbosity argument:

          if __name__ == '__main__':     unittest.main(verbosity=2)

     The `defaultTest' argument is either the name of a single test or
     an iterable of test names to run if no test names are specified via
     `argv'.  If not specified or ‘None’ and no test names are provided
     via `argv', all tests found in `module' are run.

     The `argv' argument can be a list of options passed to the program,
     with the first element being the program name.  If not specified or
     ‘None’, the values of *note sys.argv: bee. are used.

     The `testRunner' argument can either be a test runner class or an
     already created instance of it.  By default ‘main’ calls *note
     sys.exit(): cd5. with an exit code indicating success or failure of
     the tests run.

     The `testLoader' argument has to be a *note TestLoader: 776.
     instance, and defaults to *note defaultTestLoader: 3294.

     ‘main’ supports being used from the interactive interpreter by
     passing in the argument ‘exit=False’.  This displays the result on
     standard output without calling *note sys.exit(): cd5.:

          >>> from unittest import main >>> main(module='test_module', exit=False)

     The `failfast', `catchbreak' and `buffer' parameters have the same
     effect as the same-name *note command-line options: 3260.

     The `warnings' argument specifies the *note warning filter: 1287.
     that should be used while running the tests.  If it’s not
     specified, it will remain ‘None’ if a ‘-W’ option is passed to
     ‘python’ (see *note Warning control: 1286.), otherwise it will be
     set to ‘'default'’.

     Calling ‘main’ actually returns an instance of the ‘TestProgram’
     class.  This stores the result of the tests run as the ‘result’
     attribute.

     Changed in version 3.1: The `exit' parameter was added.

     Changed in version 3.2: The `verbosity', `failfast', `catchbreak',
     `buffer' and `warnings' parameters were added.

     Changed in version 3.4: The `defaultTest' parameter was changed to
     also accept an iterable of test names.

* Menu:

* load_tests Protocol::


File: python.info,  Node: load_tests Protocol,  Up: Loading and running tests

5.27.4.14 load_tests Protocol
.............................

New in version 3.2.

Modules or packages can customize how tests are loaded from them during
normal test runs or test discovery by implementing a function called
‘load_tests’.

If a test module defines ‘load_tests’ it will be called by *note
TestLoader.loadTestsFromModule(): 774. with the following arguments:

     load_tests(loader, standard_tests, pattern)

where `pattern' is passed straight through from ‘loadTestsFromModule’.
It defaults to ‘None’.

It should return a *note TestSuite: 6c2.

`loader' is the instance of *note TestLoader: 776. doing the loading.
`standard_tests' are the tests that would be loaded by default from the
module.  It is common for test modules to only want to add or remove
tests from the standard set of tests.  The third argument is used when
loading packages as part of test discovery.

A typical ‘load_tests’ function that loads tests from a specific set of
*note TestCase: 8f3. classes may look like:

     test_cases = (TestCase1, TestCase2, TestCase3)  def load_tests(loader, tests, pattern):     suite = TestSuite()     for test_class in test_cases:         tests = loader.loadTestsFromTestCase(test_class)         suite.addTests(tests)     return suite

If discovery is started in a directory containing a package, either from
the command line or by calling *note TestLoader.discover(): 8f8, then
the package ‘__init__.py’ will be checked for ‘load_tests’.  If that
function does not exist, discovery will recurse into the package as
though it were just another directory.  Otherwise, discovery of the
package’s tests will be left up to ‘load_tests’ which is called with the
following arguments:

     load_tests(loader, standard_tests, pattern)

This should return a *note TestSuite: 6c2. representing all the tests
from the package.  (‘standard_tests’ will only contain tests collected
from ‘__init__.py’.)

Because the pattern is passed into ‘load_tests’ the package is free to
continue (and potentially modify) test discovery.  A ‘do nothing’
‘load_tests’ function for a test package would look like:

     def load_tests(loader, standard_tests, pattern):     # top level directory cached on loader instance     this_dir = os.path.dirname(__file__)     package_tests = loader.discover(start_dir=this_dir, pattern=pattern)     standard_tests.addTests(package_tests)     return standard_tests

Changed in version 3.5: Discovery no longer checks package names for
matching `pattern' due to the impossibility of package names matching
the default pattern.


File: python.info,  Node: Class and Module Fixtures,  Next: Signal Handling,  Prev: Classes and functions,  Up: unittest — Unit testing framework

5.27.4.15 Class and Module Fixtures
...................................

Class and module level fixtures are implemented in *note TestSuite: 6c2.
When the test suite encounters a test from a new class then
‘tearDownClass()’ from the previous class (if there is one) is called,
followed by ‘setUpClass()’ from the new class.

Similarly if a test is from a different module from the previous test
then ‘tearDownModule’ from the previous module is run, followed by
‘setUpModule’ from the new module.

After all the tests have run the final ‘tearDownClass’ and
‘tearDownModule’ are run.

Note that shared fixtures do not play well with [potential] features
like test parallelization and they break test isolation.  They should be
used with care.

The default ordering of tests created by the unittest test loaders is to
group all tests from the same modules and classes together.  This will
lead to ‘setUpClass’ / ‘setUpModule’ (etc) being called exactly once per
class and module.  If you randomize the order, so that tests from
different modules and classes are adjacent to each other, then these
shared fixture functions may be called multiple times in a single test
run.

Shared fixtures are not intended to work with suites with non-standard
ordering.  A ‘BaseTestSuite’ still exists for frameworks that don’t want
to support shared fixtures.

If there are any exceptions raised during one of the shared fixture
functions the test is reported as an error.  Because there is no
corresponding test instance an ‘_ErrorHolder’ object (that has the same
interface as a *note TestCase: 8f3.) is created to represent the error.
If you are just using the standard unittest test runner then this detail
doesn’t matter, but if you are a framework author it may be relevant.

* Menu:

* setUpClass and tearDownClass::
* setUpModule and tearDownModule::


File: python.info,  Node: setUpClass and tearDownClass,  Next: setUpModule and tearDownModule,  Up: Class and Module Fixtures

5.27.4.16 setUpClass and tearDownClass
......................................

These must be implemented as class methods:

     import unittest  class Test(unittest.TestCase):     @classmethod     def setUpClass(cls):         cls._connection = createExpensiveConnectionObject()      @classmethod     def tearDownClass(cls):         cls._connection.destroy()

If you want the ‘setUpClass’ and ‘tearDownClass’ on base classes called
then you must call up to them yourself.  The implementations in *note
TestCase: 8f3. are empty.

If an exception is raised during a ‘setUpClass’ then the tests in the
class are not run and the ‘tearDownClass’ is not run.  Skipped classes
will not have ‘setUpClass’ or ‘tearDownClass’ run.  If the exception is
a *note SkipTest: 8f7. exception then the class will be reported as
having been skipped instead of as an error.


File: python.info,  Node: setUpModule and tearDownModule,  Prev: setUpClass and tearDownClass,  Up: Class and Module Fixtures

5.27.4.17 setUpModule and tearDownModule
........................................

These should be implemented as functions:

     def setUpModule():     createConnection()  def tearDownModule():     closeConnection()

If an exception is raised in a ‘setUpModule’ then none of the tests in
the module will be run and the ‘tearDownModule’ will not be run.  If the
exception is a *note SkipTest: 8f7. exception then the module will be
reported as having been skipped instead of as an error.

To add cleanup code that must be run even in the case of an exception,
use ‘addModuleCleanup’:

 -- Function: unittest.addModuleCleanup (function, /, *args, **kwargs)

     Add a function to be called after ‘tearDownModule()’ to cleanup
     resources used during the test class.  Functions will be called in
     reverse order to the order they are added (LIFO).  They are called
     with any arguments and keyword arguments passed into *note
     addModuleCleanup(): 248. when they are added.

     If ‘setUpModule()’ fails, meaning that ‘tearDownModule()’ is not
     called, then any cleanup functions added will still be called.

     New in version 3.8.

 -- Function: unittest.doModuleCleanups ()

     This function is called unconditionally after ‘tearDownModule()’,
     or after ‘setUpModule()’ if ‘setUpModule()’ raises an exception.

     It is responsible for calling all the cleanup functions added by
     ‘addCleanupModule()’.  If you need cleanup functions to be called
     `prior' to ‘tearDownModule()’ then you can call *note
     doModuleCleanups(): 32b6. yourself.

     *note doModuleCleanups(): 32b6. pops methods off the stack of
     cleanup functions one at a time, so it can be called at any time.

     New in version 3.8.


File: python.info,  Node: Signal Handling,  Prev: Class and Module Fixtures,  Up: unittest — Unit testing framework

5.27.4.18 Signal Handling
.........................

New in version 3.2.

The *note -c/–catch: cb7. command-line option to unittest, along with
the ‘catchbreak’ parameter to *note unittest.main(): 8f6, provide more
friendly handling of control-C during a test run.  With catch break
behavior enabled control-C will allow the currently running test to
complete, and the test run will then end and report all the results so
far.  A second control-c will raise a *note KeyboardInterrupt: 197. in
the usual way.

The control-c handling signal handler attempts to remain compatible with
code or tests that install their own ‘signal.SIGINT’ handler.  If the
‘unittest’ handler is called but `isn’t' the installed ‘signal.SIGINT’
handler, i.e.  it has been replaced by the system under test and
delegated to, then it calls the default handler.  This will normally be
the expected behavior by code that replaces an installed handler and
delegates to it.  For individual tests that need ‘unittest’ control-c
handling disabled the *note removeHandler(): cb8. decorator can be used.

There are a few utility functions for framework authors to enable
control-c handling functionality within test frameworks.

 -- Function: unittest.installHandler ()

     Install the control-c handler.  When a ‘signal.SIGINT’ is received
     (usually in response to the user pressing control-c) all registered
     results have *note stop(): 32a1. called.

 -- Function: unittest.registerResult (result)

     Register a *note TestResult: ab4. object for control-c handling.
     Registering a result stores a weak reference to it, so it doesn’t
     prevent the result from being garbage collected.

     Registering a *note TestResult: ab4. object has no side-effects if
     control-c handling is not enabled, so test frameworks can
     unconditionally register all results they create independently of
     whether or not handling is enabled.

 -- Function: unittest.removeResult (result)

     Remove a registered result.  Once a result has been removed then
     *note stop(): 32a1. will no longer be called on that result object
     in response to a control-c.

 -- Function: unittest.removeHandler (function=None)

     When called without arguments this function removes the control-c
     handler if it has been installed.  This function can also be used
     as a test decorator to temporarily remove the handler while the
     test is being executed:

          @unittest.removeHandler def test_signal_handling(self):     ...


File: python.info,  Node: unittest mock — mock object library,  Next: unittest mock — getting started,  Prev: unittest — Unit testing framework,  Up: Development Tools

5.27.5 ‘unittest.mock’ — mock object library
--------------------------------------------

New in version 3.3.

`Source code:' Lib/unittest/mock.py(1)

__________________________________________________________________

*note unittest.mock: 11c. is a library for testing in Python.  It allows
you to replace parts of your system under test with mock objects and
make assertions about how they have been used.

*note unittest.mock: 11c. provides a core *note Mock: 247. class
removing the need to create a host of stubs throughout your test suite.
After performing an action, you can make assertions about which methods
/ attributes were used and arguments they were called with.  You can
also specify return values and set needed attributes in the normal way.

Additionally, mock provides a *note patch(): 77c. decorator that handles
patching module and class level attributes within the scope of a test,
along with *note sentinel: 3ff. for creating unique objects.  See the
*note quick guide: 32bc. for some examples of how to use *note Mock:
247, *note MagicMock: 779. and *note patch(): 77c.

Mock is very easy to use and is designed for use with *note unittest:
11b.  Mock is based on the ‘action -> assertion’ pattern instead of
‘record -> replay’ used by many mocking frameworks.

There is a backport of *note unittest.mock: 11c. for earlier versions of
Python, available as mock on PyPI(2).

* Menu:

* Quick Guide::
* The Mock Class::
* The patchers::
* MagicMock and magic method support::
* Helpers::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/unittest/mock.py

   (2) https://pypi.org/project/mock


File: python.info,  Node: Quick Guide,  Next: The Mock Class,  Up: unittest mock — mock object library

5.27.5.1 Quick Guide
....................

*note Mock: 247. and *note MagicMock: 779. objects create all attributes
and methods as you access them and store details of how they have been
used.  You can configure them, to specify return values or limit what
attributes are available, and then make assertions about how they have
been used:

     >>> from unittest.mock import MagicMock >>> thing = ProductionClass() >>> thing.method = MagicMock(return_value=3) >>> thing.method(3, 4, 5, key='value') 3 >>> thing.method.assert_called_with(3, 4, 5, key='value')

‘side_effect’ allows you to perform side effects, including raising an
exception when a mock is called:

     >>> mock = Mock(side_effect=KeyError('foo')) >>> mock() Traceback (most recent call last):  ... KeyError: 'foo'

     >>> values = {'a': 1, 'b': 2, 'c': 3} >>> def side_effect(arg): ...     return values[arg] ... >>> mock.side_effect = side_effect >>> mock('a'), mock('b'), mock('c') (1, 2, 3) >>> mock.side_effect = [5, 4, 3, 2, 1] >>> mock(), mock(), mock() (5, 4, 3)

Mock has many other ways you can configure it and control its behaviour.
For example the `spec' argument configures the mock to take its
specification from another object.  Attempting to access attributes or
methods on the mock that don’t exist on the spec will fail with an *note
AttributeError: 390.

The *note patch(): 77c. decorator / context manager makes it easy to
mock classes or objects in a module under test.  The object you specify
will be replaced with a mock (or other object) during the test and
restored when the test ends:

     >>> from unittest.mock import patch >>> @patch('module.ClassName2') ... @patch('module.ClassName1') ... def test(MockClass1, MockClass2): ...     module.ClassName1() ...     module.ClassName2() ...     assert MockClass1 is module.ClassName1 ...     assert MockClass2 is module.ClassName2 ...     assert MockClass1.called ...     assert MockClass2.called ... >>> test()

     Note: When you nest patch decorators the mocks are passed in to the
     decorated function in the same order they applied (the normal
     `Python' order that decorators are applied).  This means from the
     bottom up, so in the example above the mock for ‘module.ClassName1’
     is passed in first.

     With *note patch(): 77c. it matters that you patch objects in the
     namespace where they are looked up.  This is normally
     straightforward, but for a quick guide read *note where to patch:
     32bd.

As well as a decorator *note patch(): 77c. can be used as a context
manager in a with statement:

     >>> with patch.object(ProductionClass, 'method', return_value=None) as mock_method: ...     thing = ProductionClass() ...     thing.method(1, 2, 3) ... >>> mock_method.assert_called_once_with(1, 2, 3)

There is also *note patch.dict(): f01. for setting values in a
dictionary just during a scope and restoring the dictionary to its
original state when the test ends:

     >>> foo = {'key': 'value'} >>> original = foo.copy() >>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True): ...     assert foo == {'newkey': 'newvalue'} ... >>> assert foo == original

Mock supports the mocking of Python *note magic methods: 32be.  The
easiest way of using magic methods is with the *note MagicMock: 779.
class.  It allows you to do things like:

     >>> mock = MagicMock() >>> mock.__str__.return_value = 'foobarbaz' >>> str(mock) 'foobarbaz' >>> mock.__str__.assert_called_with()

Mock allows you to assign functions (or other Mock instances) to magic
methods and they will be called appropriately.  The *note MagicMock:
779. class is just a Mock variant that has all of the magic methods
pre-created for you (well, all the useful ones anyway).

The following is an example of using magic methods with the ordinary
Mock class:

     >>> mock = Mock() >>> mock.__str__ = Mock(return_value='wheeeeee') >>> str(mock) 'wheeeeee'

For ensuring that the mock objects in your tests have the same api as
the objects they are replacing, you can use *note auto-speccing: 32bf.
Auto-speccing can be done through the `autospec' argument to patch, or
the *note create_autospec(): f14. function.  Auto-speccing creates mock
objects that have the same attributes and methods as the objects they
are replacing, and any functions and methods (including constructors)
have the same call signature as the real object.

This ensures that your mocks will fail in the same way as your
production code if they are used incorrectly:

     >>> from unittest.mock import create_autospec >>> def function(a, b, c): ...     pass ... >>> mock_function = create_autospec(function, return_value='fishy') >>> mock_function(1, 2, 3) 'fishy' >>> mock_function.assert_called_once_with(1, 2, 3) >>> mock_function('wrong arguments') Traceback (most recent call last):  ... TypeError: <lambda>() takes exactly 3 arguments (1 given)

*note create_autospec(): f14. can also be used on classes, where it
copies the signature of the ‘__init__’ method, and on callable objects
where it copies the signature of the ‘__call__’ method.


File: python.info,  Node: The Mock Class,  Next: The patchers,  Prev: Quick Guide,  Up: unittest mock — mock object library

5.27.5.2 The Mock Class
.......................

*note Mock: 247. is a flexible mock object intended to replace the use
of stubs and test doubles throughout your code.  Mocks are callable and
create attributes as new mocks when you access them (1).  Accessing the
same attribute will always return the same mock.  Mocks record how you
use them, allowing you to make assertions about what your code has done
to them.

*note MagicMock: 779. is a subclass of *note Mock: 247. with all the
magic methods pre-created and ready to use.  There are also non-callable
variants, useful when you are mocking out objects that aren’t callable:
*note NonCallableMock: 32c1. and *note NonCallableMagicMock: 32c2.

The *note patch(): 77c. decorators makes it easy to temporarily replace
classes in a particular module with a *note Mock: 247. object.  By
default *note patch(): 77c. will create a *note MagicMock: 779. for you.
You can specify an alternative class of *note Mock: 247. using the
`new_callable' argument to *note patch(): 77c.

 -- Class: unittest.mock.Mock (spec=None, side_effect=None,
          return_value=DEFAULT, wraps=None, name=None, spec_set=None,
          unsafe=False, **kwargs)

     Create a new *note Mock: 247. object.  *note Mock: 247. takes
     several optional arguments that specify the behaviour of the Mock
     object:

        * `spec': This can be either a list of strings or an existing
          object (a class or instance) that acts as the specification
          for the mock object.  If you pass in an object then a list of
          strings is formed by calling dir on the object (excluding
          unsupported magic attributes and methods).  Accessing any
          attribute not in this list will raise an *note AttributeError:
          390.

          If `spec' is an object (rather than a list of strings) then
          *note __class__: dfd. returns the class of the spec object.
          This allows mocks to pass *note isinstance(): 444. tests.

        * `spec_set': A stricter variant of `spec'.  If used, attempting
          to `set' or get an attribute on the mock that isn’t on the
          object passed as `spec_set' will raise an *note
          AttributeError: 390.

        * `side_effect': A function to be called whenever the Mock is
          called.  See the *note side_effect: 32c3. attribute.  Useful
          for raising exceptions or dynamically changing return values.
          The function is called with the same arguments as the mock,
          and unless it returns *note DEFAULT: 32c4, the return value of
          this function is used as the return value.

          Alternatively `side_effect' can be an exception class or
          instance.  In this case the exception will be raised when the
          mock is called.

          If `side_effect' is an iterable then each call to the mock
          will return the next value from the iterable.

          A `side_effect' can be cleared by setting it to ‘None’.

        * `return_value': The value returned when the mock is called.
          By default this is a new Mock (created on first access).  See
          the *note return_value: 32c5. attribute.

        * `unsafe': By default if any attribute starts with `assert' or
          `assret' will raise an *note AttributeError: 390.  Passing
          ‘unsafe=True’ will allow access to these attributes.

          New in version 3.5.

        * `wraps': Item for the mock object to wrap.  If `wraps' is not
          ‘None’ then calling the Mock will pass the call through to the
          wrapped object (returning the real result).  Attribute access
          on the mock will return a Mock object that wraps the
          corresponding attribute of the wrapped object (so attempting
          to access an attribute that doesn’t exist will raise an *note
          AttributeError: 390.).

          If the mock has an explicit `return_value' set then calls are
          not passed to the wrapped object and the `return_value' is
          returned instead.

        * `name': If the mock has a name then it will be used in the
          repr of the mock.  This can be useful for debugging.  The name
          is propagated to child mocks.

     Mocks can also be called with arbitrary keyword arguments.  These
     will be used to set attributes on the mock after it is created.
     See the *note configure_mock(): 32c6. method for details.

      -- Method: assert_called ()

          Assert that the mock was called at least once.

               >>> mock = Mock() >>> mock.method() <Mock name='mock.method()' id='...'> >>> mock.method.assert_called()

          New in version 3.6.

      -- Method: assert_called_once ()

          Assert that the mock was called exactly once.

               >>> mock = Mock() >>> mock.method() <Mock name='mock.method()' id='...'> >>> mock.method.assert_called_once() >>> mock.method() <Mock name='mock.method()' id='...'> >>> mock.method.assert_called_once() Traceback (most recent call last): ... AssertionError: Expected 'method' to have been called once. Called 2 times.

          New in version 3.6.

      -- Method: assert_called_with (*args, **kwargs)

          This method is a convenient way of asserting that the last
          call has been made in a particular way:

               >>> mock = Mock() >>> mock.method(1, 2, 3, test='wow') <Mock name='mock.method()' id='...'> >>> mock.method.assert_called_with(1, 2, 3, test='wow')

      -- Method: assert_called_once_with (*args, **kwargs)

          Assert that the mock was called exactly once and that that
          call was with the specified arguments.

               >>> mock = Mock(return_value=None) >>> mock('foo', bar='baz') >>> mock.assert_called_once_with('foo', bar='baz') >>> mock('other', bar='values') >>> mock.assert_called_once_with('other', bar='values') Traceback (most recent call last):   ... AssertionError: Expected 'mock' to be called once. Called 2 times.

      -- Method: assert_any_call (*args, **kwargs)

          assert the mock has been called with the specified arguments.

          The assert passes if the mock has `ever' been called, unlike
          *note assert_called_with(): f33. and *note
          assert_called_once_with(): 32c7. that only pass if the call is
          the most recent one, and in the case of *note
          assert_called_once_with(): 32c7. it must also be the only
          call.

               >>> mock = Mock(return_value=None) >>> mock(1, 2, arg='thing') >>> mock('some', 'thing', 'else') >>> mock.assert_any_call(1, 2, arg='thing')

      -- Method: assert_has_calls (calls, any_order=False)

          assert the mock has been called with the specified calls.  The
          *note mock_calls: 32ca. list is checked for the calls.

          If `any_order' is false then the calls must be sequential.
          There can be extra calls before or after the specified calls.

          If `any_order' is true then the calls can be in any order, but
          they must all appear in *note mock_calls: 32ca.

               >>> mock = Mock(return_value=None) >>> mock(1) >>> mock(2) >>> mock(3) >>> mock(4) >>> calls = [call(2), call(3)] >>> mock.assert_has_calls(calls) >>> calls = [call(4), call(2), call(3)] >>> mock.assert_has_calls(calls, any_order=True)

      -- Method: assert_not_called ()

          Assert the mock was never called.

               >>> m = Mock() >>> m.hello.assert_not_called() >>> obj = m.hello() >>> m.hello.assert_not_called() Traceback (most recent call last):   ... AssertionError: Expected 'hello' to not have been called. Called 1 times.

          New in version 3.5.

      -- Method: reset_mock (*, return_value=False, side_effect=False)

          The reset_mock method resets all the call attributes on a mock
          object:

               >>> mock = Mock(return_value=None) >>> mock('hello') >>> mock.called True >>> mock.reset_mock() >>> mock.called False

          Changed in version 3.6: Added two keyword only argument to the
          reset_mock function.

          This can be useful where you want to make a series of
          assertions that reuse the same object.  Note that *note
          reset_mock(): 59f. `doesn’t' clear the return value, *note
          side_effect: 32c3. or any child attributes you have set using
          normal assignment by default.  In case you want to reset
          `return_value' or *note side_effect: 32c3, then pass the
          corresponding parameter as ‘True’.  Child mocks and the return
          value mock (if any) are reset as well.

               Note: `return_value', and *note side_effect: 32c3. are
               keyword only argument.

      -- Method: mock_add_spec (spec, spec_set=False)

          Add a spec to a mock.  `spec' can either be an object or a
          list of strings.  Only attributes on the `spec' can be fetched
          as attributes from the mock.

          If `spec_set' is true then only attributes on the spec can be
          set.

      -- Method: attach_mock (mock, attribute)

          Attach a mock as an attribute of this one, replacing its name
          and parent.  Calls to the attached mock will be recorded in
          the *note method_calls: 32cd. and *note mock_calls: 32ca.
          attributes of this one.

      -- Method: configure_mock (**kwargs)

          Set attributes on the mock through keyword arguments.

          Attributes plus return values and side effects can be set on
          child mocks using standard dot notation and unpacking a
          dictionary in the method call:

               >>> mock = Mock() >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError} >>> mock.configure_mock(**attrs) >>> mock.method() 3 >>> mock.other() Traceback (most recent call last):   ... KeyError

          The same thing can be achieved in the constructor call to
          mocks:

               >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError} >>> mock = Mock(some_attribute='eggs', **attrs) >>> mock.some_attribute 'eggs' >>> mock.method() 3 >>> mock.other() Traceback (most recent call last):   ... KeyError

          *note configure_mock(): 32c6. exists to make it easier to do
          configuration after the mock has been created.

      -- Method: __dir__ ()

          *note Mock: 247. objects limit the results of ‘dir(some_mock)’
          to useful results.  For mocks with a `spec' this includes all
          the permitted attributes for the mock.

          See *note FILTER_DIR: 32cf. for what this filtering does, and
          how to switch it off.

      -- Method: _get_child_mock (**kw)

          Create the child mocks for attributes and return value.  By
          default child mocks will be the same type as the parent.
          Subclasses of Mock may want to override this to customize the
          way child mocks are made.

          For non-callable mocks the callable variant will be used
          (rather than any custom subclass).

      -- Attribute: called

          A boolean representing whether or not the mock object has been
          called:

               >>> mock = Mock(return_value=None) >>> mock.called False >>> mock() >>> mock.called True

      -- Attribute: call_count

          An integer telling you how many times the mock object has been
          called:

               >>> mock = Mock(return_value=None) >>> mock.call_count 0 >>> mock() >>> mock() >>> mock.call_count 2

      -- Attribute: return_value

          Set this to configure the value returned by calling the mock:

               >>> mock = Mock() >>> mock.return_value = 'fish' >>> mock() 'fish'

          The default return value is a mock object and you can
          configure it in the normal way:

               >>> mock = Mock() >>> mock.return_value.attribute = sentinel.Attribute >>> mock.return_value() <Mock name='mock()()' id='...'> >>> mock.return_value.assert_called_with()

          *note return_value: 32c5. can also be set in the constructor:

               >>> mock = Mock(return_value=3) >>> mock.return_value 3 >>> mock() 3

      -- Attribute: side_effect

          This can either be a function to be called when the mock is
          called, an iterable or an exception (class or instance) to be
          raised.

          If you pass in a function it will be called with same
          arguments as the mock and unless the function returns the
          *note DEFAULT: 32c4. singleton the call to the mock will then
          return whatever the function returns.  If the function returns
          *note DEFAULT: 32c4. then the mock will return its normal
          value (from the *note return_value: 32c5.).

          If you pass in an iterable, it is used to retrieve an iterator
          which must yield a value on every call.  This value can either
          be an exception instance to be raised, or a value to be
          returned from the call to the mock (*note DEFAULT: 32c4.
          handling is identical to the function case).

          An example of a mock that raises an exception (to test
          exception handling of an API):

               >>> mock = Mock() >>> mock.side_effect = Exception('Boom!') >>> mock() Traceback (most recent call last):   ... Exception: Boom!

          Using *note side_effect: 32c3. to return a sequence of values:

               >>> mock = Mock() >>> mock.side_effect = [3, 2, 1] >>> mock(), mock(), mock() (3, 2, 1)

          Using a callable:

               >>> mock = Mock(return_value=3) >>> def side_effect(*args, **kwargs): ...     return DEFAULT ... >>> mock.side_effect = side_effect >>> mock() 3

          *note side_effect: 32c3. can be set in the constructor.
          Here’s an example that adds one to the value the mock is
          called with and returns it:

               >>> side_effect = lambda value: value + 1 >>> mock = Mock(side_effect=side_effect) >>> mock(3) 4 >>> mock(-8) -7

          Setting *note side_effect: 32c3. to ‘None’ clears it:

               >>> m = Mock(side_effect=KeyError, return_value=3) >>> m() Traceback (most recent call last):  ... KeyError >>> m.side_effect = None >>> m() 3

      -- Attribute: call_args

          This is either ‘None’ (if the mock hasn’t been called), or the
          arguments that the mock was last called with.  This will be in
          the form of a tuple: the first member, which can also be
          accessed through the ‘args’ property, is any ordered arguments
          the mock was called with (or an empty tuple) and the second
          member, which can also be accessed through the ‘kwargs’
          property, is any keyword arguments (or an empty dictionary).

               >>> mock = Mock(return_value=None) >>> print(mock.call_args) None >>> mock() >>> mock.call_args call() >>> mock.call_args == () True >>> mock(3, 4) >>> mock.call_args call(3, 4) >>> mock.call_args == ((3, 4),) True >>> mock.call_args.args (3, 4) >>> mock.call_args.kwargs {} >>> mock(3, 4, 5, key='fish', next='w00t!') >>> mock.call_args call(3, 4, 5, key='fish', next='w00t!') >>> mock.call_args.args (3, 4, 5) >>> mock.call_args.kwargs {'key': 'fish', 'next': 'w00t!'}

          *note call_args: 32d3, along with members of the lists *note
          call_args_list: 32d4, *note method_calls: 32cd. and *note
          mock_calls: 32ca. are *note call: eab. objects.  These are
          tuples, so they can be unpacked to get at the individual
          arguments and make more complex assertions.  See *note calls
          as tuples: 32d5.

      -- Attribute: call_args_list

          This is a list of all the calls made to the mock object in
          sequence (so the length of the list is the number of times it
          has been called).  Before any calls have been made it is an
          empty list.  The *note call: eab. object can be used for
          conveniently constructing lists of calls to compare with *note
          call_args_list: 32d4.

               >>> mock = Mock(return_value=None) >>> mock() >>> mock(3, 4) >>> mock(key='fish', next='w00t!') >>> mock.call_args_list [call(), call(3, 4), call(key='fish', next='w00t!')] >>> expected = [(), ((3, 4),), ({'key': 'fish', 'next': 'w00t!'},)] >>> mock.call_args_list == expected True

          Members of *note call_args_list: 32d4. are *note call: eab.
          objects.  These can be unpacked as tuples to get at the
          individual arguments.  See *note calls as tuples: 32d5.

      -- Attribute: method_calls

          As well as tracking calls to themselves, mocks also track
          calls to methods and attributes, and `their' methods and
          attributes:

               >>> mock = Mock() >>> mock.method() <Mock name='mock.method()' id='...'> >>> mock.property.method.attribute() <Mock name='mock.property.method.attribute()' id='...'> >>> mock.method_calls [call.method(), call.property.method.attribute()]

          Members of *note method_calls: 32cd. are *note call: eab.
          objects.  These can be unpacked as tuples to get at the
          individual arguments.  See *note calls as tuples: 32d5.

      -- Attribute: mock_calls

          *note mock_calls: 32ca. records `all' calls to the mock
          object, its methods, magic methods `and' return value mocks.

               >>> mock = MagicMock() >>> result = mock(1, 2, 3) >>> mock.first(a=3) <MagicMock name='mock.first()' id='...'> >>> mock.second() <MagicMock name='mock.second()' id='...'> >>> int(mock) 1 >>> result(1) <MagicMock name='mock()()' id='...'> >>> expected = [call(1, 2, 3), call.first(a=3), call.second(), ... call.__int__(), call()(1)] >>> mock.mock_calls == expected True

          Members of *note mock_calls: 32ca. are *note call: eab.
          objects.  These can be unpacked as tuples to get at the
          individual arguments.  See *note calls as tuples: 32d5.

               Note: The way *note mock_calls: 32ca. are recorded means
               that where nested calls are made, the parameters of
               ancestor calls are not recorded and so will always
               compare equal:

                    >>> mock = MagicMock() >>> mock.top(a=3).bottom() <MagicMock name='mock.top().bottom()' id='...'> >>> mock.mock_calls [call.top(a=3), call.top().bottom()] >>> mock.mock_calls[-1] == call.top(a=-1).bottom() True

      -- Attribute: __class__

          Normally the *note __class__: 32d6. attribute of an object
          will return its type.  For a mock object with a ‘spec’,
          ‘__class__’ returns the spec class instead.  This allows mock
          objects to pass *note isinstance(): 444. tests for the object
          they are replacing / masquerading as:

               >>> mock = Mock(spec=3) >>> isinstance(mock, int) True

          *note __class__: 32d6. is assignable to, this allows a mock to
          pass an *note isinstance(): 444. check without forcing you to
          use a spec:

               >>> mock = Mock() >>> mock.__class__ = dict >>> isinstance(mock, dict) True

 -- Class: unittest.mock.NonCallableMock (spec=None, wraps=None,
          name=None, spec_set=None, **kwargs)

     A non-callable version of *note Mock: 247.  The constructor
     parameters have the same meaning of *note Mock: 247, with the
     exception of `return_value' and `side_effect' which have no meaning
     on a non-callable mock.

Mock objects that use a class or an instance as a ‘spec’ or ‘spec_set’
are able to pass *note isinstance(): 444. tests:

     >>> mock = Mock(spec=SomeClass) >>> isinstance(mock, SomeClass) True >>> mock = Mock(spec_set=SomeClass()) >>> isinstance(mock, SomeClass) True

The *note Mock: 247. classes have support for mocking magic methods.
See *note magic methods: 32be. for the full details.

The mock classes and the *note patch(): 77c. decorators all take
arbitrary keyword arguments for configuration.  For the *note patch():
77c. decorators the keywords are passed to the constructor of the mock
being created.  The keyword arguments are for configuring attributes of
the mock:

     >>> m = MagicMock(attribute=3, other='fish') >>> m.attribute 3 >>> m.other 'fish'

The return value and side effect of child mocks can be set in the same
way, using dotted notation.  As you can’t use dotted names directly in a
call you have to create a dictionary and unpack it using ‘**’:

     >>> attrs = {'method.return_value': 3, 'other.side_effect': KeyError} >>> mock = Mock(some_attribute='eggs', **attrs) >>> mock.some_attribute 'eggs' >>> mock.method() 3 >>> mock.other() Traceback (most recent call last):   ... KeyError

A callable mock which was created with a `spec' (or a `spec_set') will
introspect the specification object’s signature when matching calls to
the mock.  Therefore, it can match the actual call’s arguments
regardless of whether they were passed positionally or by name:

     >>> def f(a, b, c): pass ... >>> mock = Mock(spec=f) >>> mock(1, 2, c=3) <Mock name='mock()' id='140161580456576'> >>> mock.assert_called_with(1, 2, 3) >>> mock.assert_called_with(a=1, b=2, c=3)

This applies to *note assert_called_with(): f33, *note
assert_called_once_with(): 32c7, *note assert_has_calls(): 32c9. and
*note assert_any_call(): 32c8.  When *note Autospeccing: 32bf, it will
also apply to method calls on the mock object.

     Changed in version 3.4: Added signature introspection on specced
     and autospecced mock objects.

 -- Class: unittest.mock.PropertyMock (*args, **kwargs)

     A mock intended to be used as a property, or other descriptor, on a
     class.  *note PropertyMock: 32d7. provides *note __get__(): 1377.
     and *note __set__(): 137b. methods so you can specify a return
     value when it is fetched.

     Fetching a *note PropertyMock: 32d7. instance from an object calls
     the mock, with no args.  Setting it calls the mock with the value
     being set.

          >>> class Foo: ...     @property ...     def foo(self): ...         return 'something' ...     @foo.setter ...     def foo(self, value): ...         pass ... >>> with patch('__main__.Foo.foo', new_callable=PropertyMock) as mock_foo: ...     mock_foo.return_value = 'mockity-mock' ...     this_foo = Foo() ...     print(this_foo.foo) ...     this_foo.foo = 6 ... mockity-mock >>> mock_foo.mock_calls [call(), call(6)]

Because of the way mock attributes are stored you can’t directly attach
a *note PropertyMock: 32d7. to a mock object.  Instead you can attach it
to the mock type object:

     >>> m = MagicMock() >>> p = PropertyMock(return_value=3) >>> type(m).foo = p >>> m.foo 3 >>> p.assert_called_once_with()

 -- Class: unittest.mock.AsyncMock (spec=None, side_effect=None,
          return_value=DEFAULT, wraps=None, name=None, spec_set=None,
          unsafe=False, **kwargs)

     An asynchronous version of *note Mock: 247.  The *note AsyncMock:
     246. object will behave so the object is recognized as an async
     function, and the result of a call is an awaitable.

          >>> mock = AsyncMock() >>> asyncio.iscoroutinefunction(mock) True >>> inspect.isawaitable(mock())  # doctest: +SKIP True

     The result of ‘mock()’ is an async function which will have the
     outcome of ‘side_effect’ or ‘return_value’ after it has been
     awaited:

        - if ‘side_effect’ is a function, the async function will return
          the result of that function,

        - if ‘side_effect’ is an exception, the async function will
          raise the exception,

        - if ‘side_effect’ is an iterable, the async function will
          return the next value of the iterable, however, if the
          sequence of result is exhausted, ‘StopAsyncIteration’ is
          raised immediately,

        - if ‘side_effect’ is not defined, the async function will
          return the value defined by ‘return_value’, hence, by default,
          the async function returns a new *note AsyncMock: 246. object.

     Setting the `spec' of a *note Mock: 247. or *note MagicMock: 779.
     to an async function will result in a coroutine object being
     returned after calling.

          >>> async def async_func(): pass ... >>> mock = MagicMock(async_func) >>> mock <MagicMock spec='function' id='...'> >>> mock()  # doctest: +SKIP <coroutine object AsyncMockMixin._mock_call at ...>

     Setting the `spec' of a *note Mock: 247, *note MagicMock: 779, or
     *note AsyncMock: 246. to a class with asynchronous and synchronous
     functions will automatically detect the synchronous functions and
     set them as *note MagicMock: 779. (if the parent mock is *note
     AsyncMock: 246. or *note MagicMock: 779.) or *note Mock: 247. (if
     the parent mock is *note Mock: 247.).  All asynchronous functions
     will be *note AsyncMock: 246.

          >>> class ExampleClass: ...     def sync_foo(): ...         pass ...     async def async_foo(): ...         pass ... >>> a_mock = AsyncMock(ExampleClass) >>> a_mock.sync_foo <MagicMock name='mock.sync_foo' id='...'> >>> a_mock.async_foo <AsyncMock name='mock.async_foo' id='...'> >>> mock = Mock(ExampleClass) >>> mock.sync_foo <Mock name='mock.sync_foo' id='...'> >>> mock.async_foo <AsyncMock name='mock.async_foo' id='...'>

      -- Method: assert_awaited ()

          Assert that the mock was awaited at least once.  Note that
          this is separate from the object having been called, the
          ‘await’ keyword must be used:

               >>> mock = AsyncMock() >>> async def main(coroutine_mock): ...     await coroutine_mock ... >>> coroutine_mock = mock() >>> mock.called True >>> mock.assert_awaited() Traceback (most recent call last): ... AssertionError: Expected mock to have been awaited. >>> asyncio.run(main(coroutine_mock)) >>> mock.assert_awaited()

      -- Method: assert_awaited_once ()

          Assert that the mock was awaited exactly once.

               >>> mock = AsyncMock() >>> async def main(): ...     await mock() ... >>> asyncio.run(main()) >>> mock.assert_awaited_once() >>> asyncio.run(main()) >>> mock.method.assert_awaited_once() Traceback (most recent call last): ... AssertionError: Expected mock to have been awaited once. Awaited 2 times.

      -- Method: assert_awaited_with (*args, **kwargs)

          Assert that the last await was with the specified arguments.

               >>> mock = AsyncMock() >>> async def main(*args, **kwargs): ...     await mock(*args, **kwargs) ... >>> asyncio.run(main('foo', bar='bar')) >>> mock.assert_awaited_with('foo', bar='bar') >>> mock.assert_awaited_with('other') Traceback (most recent call last): ... AssertionError: expected call not found. Expected: mock('other') Actual: mock('foo', bar='bar')

      -- Method: assert_awaited_once_with (*args, **kwargs)

          Assert that the mock was awaited exactly once and with the
          specified arguments.

               >>> mock = AsyncMock() >>> async def main(*args, **kwargs): ...     await mock(*args, **kwargs) ... >>> asyncio.run(main('foo', bar='bar')) >>> mock.assert_awaited_once_with('foo', bar='bar') >>> asyncio.run(main('foo', bar='bar')) >>> mock.assert_awaited_once_with('foo', bar='bar') Traceback (most recent call last): ... AssertionError: Expected mock to have been awaited once. Awaited 2 times.

      -- Method: assert_any_await (*args, **kwargs)

          Assert the mock has ever been awaited with the specified
          arguments.

               >>> mock = AsyncMock() >>> async def main(*args, **kwargs): ...     await mock(*args, **kwargs) ... >>> asyncio.run(main('foo', bar='bar')) >>> asyncio.run(main('hello')) >>> mock.assert_any_await('foo', bar='bar') >>> mock.assert_any_await('other') Traceback (most recent call last): ... AssertionError: mock('other') await not found

      -- Method: assert_has_awaits (calls, any_order=False)

          Assert the mock has been awaited with the specified calls.
          The *note await_args_list: 32de. list is checked for the
          awaits.

          If `any_order' is false then the awaits must be sequential.
          There can be extra calls before or after the specified awaits.

          If `any_order' is true then the awaits can be in any order,
          but they must all appear in *note await_args_list: 32de.

               >>> mock = AsyncMock() >>> async def main(*args, **kwargs): ...     await mock(*args, **kwargs) ... >>> calls = [call("foo"), call("bar")] >>> mock.assert_has_awaits(calls) Traceback (most recent call last): ... AssertionError: Awaits not found. Expected: [call('foo'), call('bar')] Actual: [] >>> asyncio.run(main('foo')) >>> asyncio.run(main('bar')) >>> mock.assert_has_awaits(calls)

      -- Method: assert_not_awaited ()

          Assert that the mock was never awaited.

               >>> mock = AsyncMock() >>> mock.assert_not_awaited()

      -- Method: reset_mock (*args, **kwargs)

          See *note Mock.reset_mock(): 59f.  Also sets *note
          await_count: 32e1. to 0, *note await_args: 32e2. to None, and
          clears the *note await_args_list: 32de.

      -- Attribute: await_count

          An integer keeping track of how many times the mock object has
          been awaited.

               >>> mock = AsyncMock() >>> async def main(): ...     await mock() ... >>> asyncio.run(main()) >>> mock.await_count 1 >>> asyncio.run(main()) >>> mock.await_count 2

      -- Attribute: await_args

          This is either ‘None’ (if the mock hasn’t been awaited), or
          the arguments that the mock was last awaited with.  Functions
          the same as *note Mock.call_args: 32d3.

               >>> mock = AsyncMock() >>> async def main(*args): ...     await mock(*args) ... >>> mock.await_args >>> asyncio.run(main('foo')) >>> mock.await_args call('foo') >>> asyncio.run(main('bar')) >>> mock.await_args call('bar')

      -- Attribute: await_args_list

          This is a list of all the awaits made to the mock object in
          sequence (so the length of the list is the number of times it
          has been awaited).  Before any awaits have been made it is an
          empty list.

               >>> mock = AsyncMock() >>> async def main(*args): ...     await mock(*args) ... >>> mock.await_args_list [] >>> asyncio.run(main('foo')) >>> mock.await_args_list [call('foo')] >>> asyncio.run(main('bar')) >>> mock.await_args_list [call('foo'), call('bar')]

* Menu:

* Calling::
* Deleting Attributes::
* Mock names and the name attribute::
* Attaching Mocks as Attributes::

   ---------- Footnotes ----------

   (1) (1) The only exceptions are magic methods and attributes (those
that have leading and trailing double underscores).  Mock doesn’t create
these but instead raises an *note AttributeError: 390.  This is because
the interpreter will often implicitly request these methods, and gets
`very' confused to get a new Mock object when it expects a magic method.
If you need magic method support see *note magic methods: 32be.


File: python.info,  Node: Calling,  Next: Deleting Attributes,  Up: The Mock Class

5.27.5.3 Calling
................

Mock objects are callable.  The call will return the value set as the
*note return_value: 32c5. attribute.  The default return value is a new
Mock object; it is created the first time the return value is accessed
(either explicitly or by calling the Mock) - but it is stored and the
same one returned each time.

Calls made to the object will be recorded in the attributes like *note
call_args: 32d3. and *note call_args_list: 32d4.

If *note side_effect: 32c3. is set then it will be called after the call
has been recorded, so if ‘side_effect’ raises an exception the call is
still recorded.

The simplest way to make a mock raise an exception when called is to
make *note side_effect: 32c3. an exception class or instance:

     >>> m = MagicMock(side_effect=IndexError) >>> m(1, 2, 3) Traceback (most recent call last):   ... IndexError >>> m.mock_calls [call(1, 2, 3)] >>> m.side_effect = KeyError('Bang!') >>> m('two', 'three', 'four') Traceback (most recent call last):   ... KeyError: 'Bang!' >>> m.mock_calls [call(1, 2, 3), call('two', 'three', 'four')]

If ‘side_effect’ is a function then whatever that function returns is
what calls to the mock return.  The ‘side_effect’ function is called
with the same arguments as the mock.  This allows you to vary the return
value of the call dynamically, based on the input:

     >>> def side_effect(value): ...     return value + 1 ... >>> m = MagicMock(side_effect=side_effect) >>> m(1) 2 >>> m(2) 3 >>> m.mock_calls [call(1), call(2)]

If you want the mock to still return the default return value (a new
mock), or any set return value, then there are two ways of doing this.
Either return ‘mock.return_value’ from inside ‘side_effect’, or return
*note DEFAULT: 32c4.:

     >>> m = MagicMock() >>> def side_effect(*args, **kwargs): ...     return m.return_value ... >>> m.side_effect = side_effect >>> m.return_value = 3 >>> m() 3 >>> def side_effect(*args, **kwargs): ...     return DEFAULT ... >>> m.side_effect = side_effect >>> m() 3

To remove a ‘side_effect’, and return to the default behaviour, set the
‘side_effect’ to ‘None’:

     >>> m = MagicMock(return_value=6) >>> def side_effect(*args, **kwargs): ...     return 3 ... >>> m.side_effect = side_effect >>> m() 3 >>> m.side_effect = None >>> m() 6

The ‘side_effect’ can also be any iterable object.  Repeated calls to
the mock will return values from the iterable (until the iterable is
exhausted and a *note StopIteration: 47b. is raised):

     >>> m = MagicMock(side_effect=[1, 2, 3]) >>> m() 1 >>> m() 2 >>> m() 3 >>> m() Traceback (most recent call last):   ... StopIteration

If any members of the iterable are exceptions they will be raised
instead of returned:

     >>> iterable = (33, ValueError, 66) >>> m = MagicMock(side_effect=iterable) >>> m() 33 >>> m() Traceback (most recent call last):  ... ValueError >>> m() 66


File: python.info,  Node: Deleting Attributes,  Next: Mock names and the name attribute,  Prev: Calling,  Up: The Mock Class

5.27.5.4 Deleting Attributes
............................

Mock objects create attributes on demand.  This allows them to pretend
to be objects of any type.

You may want a mock object to return ‘False’ to a *note hasattr(): 43c.
call, or raise an *note AttributeError: 390. when an attribute is
fetched.  You can do this by providing an object as a ‘spec’ for a mock,
but that isn’t always convenient.

You “block” attributes by deleting them.  Once deleted, accessing an
attribute will raise an *note AttributeError: 390.

     >>> mock = MagicMock() >>> hasattr(mock, 'm') True >>> del mock.m >>> hasattr(mock, 'm') False >>> del mock.f >>> mock.f Traceback (most recent call last):     ... AttributeError: f


File: python.info,  Node: Mock names and the name attribute,  Next: Attaching Mocks as Attributes,  Prev: Deleting Attributes,  Up: The Mock Class

5.27.5.5 Mock names and the name attribute
..........................................

Since “name” is an argument to the *note Mock: 247. constructor, if you
want your mock object to have a “name” attribute you can’t just pass it
in at creation time.  There are two alternatives.  One option is to use
*note configure_mock(): 32c6.:

     >>> mock = MagicMock() >>> mock.configure_mock(name='my_name') >>> mock.name 'my_name'

A simpler option is to simply set the “name” attribute after mock
creation:

     >>> mock = MagicMock() >>> mock.name = "foo"


File: python.info,  Node: Attaching Mocks as Attributes,  Prev: Mock names and the name attribute,  Up: The Mock Class

5.27.5.6 Attaching Mocks as Attributes
......................................

When you attach a mock as an attribute of another mock (or as the return
value) it becomes a “child” of that mock.  Calls to the child are
recorded in the *note method_calls: 32cd. and *note mock_calls: 32ca.
attributes of the parent.  This is useful for configuring child mocks
and then attaching them to the parent, or for attaching mocks to a
parent that records all calls to the children and allows you to make
assertions about the order of calls between mocks:

     >>> parent = MagicMock() >>> child1 = MagicMock(return_value=None) >>> child2 = MagicMock(return_value=None) >>> parent.child1 = child1 >>> parent.child2 = child2 >>> child1(1) >>> child2(2) >>> parent.mock_calls [call.child1(1), call.child2(2)]

The exception to this is if the mock has a name.  This allows you to
prevent the “parenting” if for some reason you don’t want it to happen.

     >>> mock = MagicMock() >>> not_a_child = MagicMock(name='not-a-child') >>> mock.attribute = not_a_child >>> mock.attribute() <MagicMock name='not-a-child()' id='...'> >>> mock.mock_calls []

Mocks created for you by *note patch(): 77c. are automatically given
names.  To attach mocks that have names to a parent you use the *note
attach_mock(): 32cc. method:

     >>> thing1 = object() >>> thing2 = object() >>> parent = MagicMock() >>> with patch('__main__.thing1', return_value=None) as child1: ...     with patch('__main__.thing2', return_value=None) as child2: ...         parent.attach_mock(child1, 'child1') ...         parent.attach_mock(child2, 'child2') ...         child1('one') ...         child2('two') ... >>> parent.mock_calls [call.child1('one'), call.child2('two')]


File: python.info,  Node: The patchers,  Next: MagicMock and magic method support,  Prev: The Mock Class,  Up: unittest mock — mock object library

5.27.5.7 The patchers
.....................

The patch decorators are used for patching objects only within the scope
of the function they decorate.  They automatically handle the unpatching
for you, even if exceptions are raised.  All of these functions can also
be used in with statements or as class decorators.

* Menu:

* patch::
* patch.object: patch object.
* patch.dict: patch dict.
* patch.multiple: patch multiple.
* patch methods; start and stop: patch methods start and stop.
* patch builtins::
* TEST_PREFIX::
* Nesting Patch Decorators::
* Where to patch::
* Patching Descriptors and Proxy Objects::


File: python.info,  Node: patch,  Next: patch object,  Up: The patchers

5.27.5.8 patch
..............

     Note: *note patch(): 77c. is straightforward to use.  The key is to
     do the patching in the right namespace.  See the section *note
     where to patch: 32ea.

 -- Function: unittest.mock.patch (target, new=DEFAULT, spec=None,
          create=False, spec_set=None, autospec=None, new_callable=None,
          **kwargs)

     *note patch(): 77c. acts as a function decorator, class decorator
     or a context manager.  Inside the body of the function or with
     statement, the `target' is patched with a `new' object.  When the
     function/with statement exits the patch is undone.

     If `new' is omitted, then the target is replaced with an *note
     AsyncMock: 246. if the patched object is an async function or a
     *note MagicMock: 779. otherwise.  If *note patch(): 77c. is used as
     a decorator and `new' is omitted, the created mock is passed in as
     an extra argument to the decorated function.  If *note patch():
     77c. is used as a context manager the created mock is returned by
     the context manager.

     `target' should be a string in the form
     ‘'package.module.ClassName'’.  The `target' is imported and the
     specified object replaced with the `new' object, so the `target'
     must be importable from the environment you are calling *note
     patch(): 77c. from.  The target is imported when the decorated
     function is executed, not at decoration time.

     The `spec' and `spec_set' keyword arguments are passed to the *note
     MagicMock: 779. if patch is creating one for you.

     In addition you can pass ‘spec=True’ or ‘spec_set=True’, which
     causes patch to pass in the object being mocked as the
     spec/spec_set object.

     `new_callable' allows you to specify a different class, or callable
     object, that will be called to create the `new' object.  By default
     *note AsyncMock: 246. is used for async functions and *note
     MagicMock: 779. for the rest.

     A more powerful form of `spec' is `autospec'.  If you set
     ‘autospec=True’ then the mock will be created with a spec from the
     object being replaced.  All attributes of the mock will also have
     the spec of the corresponding attribute of the object being
     replaced.  Methods and functions being mocked will have their
     arguments checked and will raise a *note TypeError: 192. if they
     are called with the wrong signature.  For mocks replacing a class,
     their return value (the ‘instance’) will have the same spec as the
     class.  See the *note create_autospec(): f14. function and *note
     Autospeccing: 32bf.

     Instead of ‘autospec=True’ you can pass ‘autospec=some_object’ to
     use an arbitrary object as the spec instead of the one being
     replaced.

     By default *note patch(): 77c. will fail to replace attributes that
     don’t exist.  If you pass in ‘create=True’, and the attribute
     doesn’t exist, patch will create the attribute for you when the
     patched function is called, and delete it again after the patched
     function has exited.  This is useful for writing tests against
     attributes that your production code creates at runtime.  It is off
     by default because it can be dangerous.  With it switched on you
     can write passing tests against APIs that don’t actually exist!

          Note: 
          Changed in version 3.5: If you are patching builtins in a
          module then you don’t need to pass ‘create=True’, it will be
          added by default.

     Patch can be used as a ‘TestCase’ class decorator.  It works by
     decorating each test method in the class.  This reduces the
     boilerplate code when your test methods share a common patchings
     set.  *note patch(): 77c. finds tests by looking for method names
     that start with ‘patch.TEST_PREFIX’.  By default this is ‘'test'’,
     which matches the way *note unittest: 11b. finds tests.  You can
     specify an alternative prefix by setting ‘patch.TEST_PREFIX’.

     Patch can be used as a context manager, with the with statement.
     Here the patching applies to the indented block after the with
     statement.  If you use “as” then the patched object will be bound
     to the name after the “as”; very useful if *note patch(): 77c. is
     creating a mock object for you.

     *note patch(): 77c. takes arbitrary keyword arguments.  These will
     be passed to the *note Mock: 247. (or `new_callable') on
     construction.

     ‘patch.dict(...)’, ‘patch.multiple(...)’ and ‘patch.object(...)’
     are available for alternate use-cases.

*note patch(): 77c. as function decorator, creating the mock for you and
passing it into the decorated function:

     >>> @patch('__main__.SomeClass') ... def function(normal_argument, mock_class): ...     print(mock_class is SomeClass) ... >>> function(None) True

Patching a class replaces the class with a *note MagicMock: 779.
`instance'.  If the class is instantiated in the code under test then it
will be the *note return_value: 32c5. of the mock that will be used.

If the class is instantiated multiple times you could use *note
side_effect: 32c3. to return a new mock each time.  Alternatively you
can set the `return_value' to be anything you want.

To configure return values on methods of `instances' on the patched
class you must do this on the ‘return_value’.  For example:

     >>> class Class: ...     def method(self): ...         pass ... >>> with patch('__main__.Class') as MockClass: ...     instance = MockClass.return_value ...     instance.method.return_value = 'foo' ...     assert Class() is instance ...     assert Class().method() == 'foo' ...

If you use `spec' or `spec_set' and *note patch(): 77c. is replacing a
`class', then the return value of the created mock will have the same
spec.

     >>> Original = Class >>> patcher = patch('__main__.Class', spec=True) >>> MockClass = patcher.start() >>> instance = MockClass() >>> assert isinstance(instance, Original) >>> patcher.stop()

The `new_callable' argument is useful where you want to use an
alternative class to the default *note MagicMock: 779. for the created
mock.  For example, if you wanted a *note NonCallableMock: 32c1. to be
used:

     >>> thing = object() >>> with patch('__main__.thing', new_callable=NonCallableMock) as mock_thing: ...     assert thing is mock_thing ...     thing() ... Traceback (most recent call last):   ... TypeError: 'NonCallableMock' object is not callable

Another use case might be to replace an object with an *note
io.StringIO: 821. instance:

     >>> from io import StringIO >>> def foo(): ...     print('Something') ... >>> @patch('sys.stdout', new_callable=StringIO) ... def test(mock_stdout): ...     foo() ...     assert mock_stdout.getvalue() == 'Something\n' ... >>> test()

When *note patch(): 77c. is creating a mock for you, it is common that
the first thing you need to do is to configure the mock.  Some of that
configuration can be done in the call to patch.  Any arbitrary keywords
you pass into the call will be used to set attributes on the created
mock:

     >>> patcher = patch('__main__.thing', first='one', second='two') >>> mock_thing = patcher.start() >>> mock_thing.first 'one' >>> mock_thing.second 'two'

As well as attributes on the created mock attributes, like the *note
return_value: 32c5. and *note side_effect: 32c3, of child mocks can also
be configured.  These aren’t syntactically valid to pass in directly as
keyword arguments, but a dictionary with these as keys can still be
expanded into a *note patch(): 77c. call using ‘**’:

     >>> config = {'method.return_value': 3, 'other.side_effect': KeyError} >>> patcher = patch('__main__.thing', **config) >>> mock_thing = patcher.start() >>> mock_thing.method() 3 >>> mock_thing.other() Traceback (most recent call last):   ... KeyError

By default, attempting to patch a function in a module (or a method or
an attribute in a class) that does not exist will fail with *note
AttributeError: 390.:

     >>> @patch('sys.non_existing_attribute', 42) ... def test(): ...     assert sys.non_existing_attribute == 42 ... >>> test() Traceback (most recent call last):   ... AttributeError: <module 'sys' (built-in)> does not have the attribute 'non_existing'

but adding ‘create=True’ in the call to *note patch(): 77c. will make
the previous example work as expected:

     >>> @patch('sys.non_existing_attribute', 42, create=True) ... def test(mock_stdout): ...     assert sys.non_existing_attribute == 42 ... >>> test()

Changed in version 3.8: *note patch(): 77c. now returns an *note
AsyncMock: 246. if the target is an async function.


File: python.info,  Node: patch object,  Next: patch dict,  Prev: patch,  Up: The patchers

5.27.5.9 patch.object
.....................

 -- Function: patch.object (target, attribute, new=DEFAULT, spec=None,
          create=False, spec_set=None, autospec=None, new_callable=None,
          **kwargs)

     patch the named member (`attribute') on an object (`target') with a
     mock object.

     *note patch.object(): e90. can be used as a decorator, class
     decorator or a context manager.  Arguments `new', `spec', `create',
     `spec_set', `autospec' and `new_callable' have the same meaning as
     for *note patch(): 77c.  Like *note patch(): 77c, *note
     patch.object(): e90. takes arbitrary keyword arguments for
     configuring the mock object it creates.

     When used as a class decorator *note patch.object(): e90. honours
     ‘patch.TEST_PREFIX’ for choosing which methods to wrap.

You can either call *note patch.object(): e90. with three arguments or
two arguments.  The three argument form takes the object to be patched,
the attribute name and the object to replace the attribute with.

When calling with the two argument form you omit the replacement object,
and a mock is created for you and passed in as an extra argument to the
decorated function:

     >>> @patch.object(SomeClass, 'class_method') ... def test(mock_method): ...     SomeClass.class_method(3) ...     mock_method.assert_called_with(3) ... >>> test()

`spec', `create' and the other arguments to *note patch.object(): e90.
have the same meaning as they do for *note patch(): 77c.


File: python.info,  Node: patch dict,  Next: patch multiple,  Prev: patch object,  Up: The patchers

5.27.5.10 patch.dict
....................

 -- Function: patch.dict (in_dict, values=(), clear=False, **kwargs)

     Patch a dictionary, or dictionary like object, and restore the
     dictionary to its original state after the test.

     `in_dict' can be a dictionary or a mapping like container.  If it
     is a mapping then it must at least support getting, setting and
     deleting items plus iterating over keys.

     `in_dict' can also be a string specifying the name of the
     dictionary, which will then be fetched by importing it.

     `values' can be a dictionary of values to set in the dictionary.
     `values' can also be an iterable of ‘(key, value)’ pairs.

     If `clear' is true then the dictionary will be cleared before the
     new values are set.

     *note patch.dict(): f01. can also be called with arbitrary keyword
     arguments to set values in the dictionary.

     Changed in version 3.8: *note patch.dict(): f01. now returns the
     patched dictionary when used as a context manager.

*note patch.dict(): f01. can be used as a context manager, decorator or
class decorator:

     >>> foo = {} >>> @patch.dict(foo, {'newkey': 'newvalue'}) ... def test(): ...     assert foo == {'newkey': 'newvalue'} >>> test() >>> assert foo == {}

When used as a class decorator *note patch.dict(): f01. honours
‘patch.TEST_PREFIX’ (default to ‘'test'’) for choosing which methods to
wrap:

     >>> import os >>> import unittest >>> from unittest.mock import patch >>> @patch.dict('os.environ', {'newkey': 'newvalue'}) ... class TestSample(unittest.TestCase): ...     def test_sample(self): ...         self.assertEqual(os.environ['newkey'], 'newvalue')

If you want to use a different prefix for your test, you can inform the
patchers of the different prefix by setting ‘patch.TEST_PREFIX’.  For
more details about how to change the value of see *note TEST_PREFIX:
32ed.

*note patch.dict(): f01. can be used to add members to a dictionary, or
simply let a test change a dictionary, and ensure the dictionary is
restored when the test ends.

     >>> foo = {} >>> with patch.dict(foo, {'newkey': 'newvalue'}) as patched_foo: ...     assert foo == {'newkey': 'newvalue'} ...     assert patched_foo == {'newkey': 'newvalue'} ...     # You can add, update or delete keys of foo (or patched_foo, it's the same dict) ...     patched_foo['spam'] = 'eggs' ... >>> assert foo == {} >>> assert patched_foo == {}

     >>> import os >>> with patch.dict('os.environ', {'newkey': 'newvalue'}): ...     print(os.environ['newkey']) ... newvalue >>> assert 'newkey' not in os.environ

Keywords can be used in the *note patch.dict(): f01. call to set values
in the dictionary:

     >>> mymodule = MagicMock() >>> mymodule.function.return_value = 'fish' >>> with patch.dict('sys.modules', mymodule=mymodule): ...     import mymodule ...     mymodule.function('some', 'args') ... 'fish'

*note patch.dict(): f01. can be used with dictionary like objects that
aren’t actually dictionaries.  At the very minimum they must support
item getting, setting, deleting and either iteration or membership test.
This corresponds to the magic methods *note __getitem__(): 27a, *note
__setitem__(): c55, *note __delitem__(): c56. and either *note
__iter__(): 504. or *note __contains__(): d1b.

     >>> class Container: ...     def __init__(self): ...         self.values = {} ...     def __getitem__(self, name): ...         return self.values[name] ...     def __setitem__(self, name, value): ...         self.values[name] = value ...     def __delitem__(self, name): ...         del self.values[name] ...     def __iter__(self): ...         return iter(self.values) ... >>> thing = Container() >>> thing['one'] = 1 >>> with patch.dict(thing, one=2, two=3): ...     assert thing['one'] == 2 ...     assert thing['two'] == 3 ... >>> assert thing['one'] == 1 >>> assert list(thing) == ['one']


File: python.info,  Node: patch multiple,  Next: patch methods start and stop,  Prev: patch dict,  Up: The patchers

5.27.5.11 patch.multiple
........................

 -- Function: patch.multiple (target, spec=None, create=False,
          spec_set=None, autospec=None, new_callable=None, **kwargs)

     Perform multiple patches in a single call.  It takes the object to
     be patched (either as an object or a string to fetch the object by
     importing) and keyword arguments for the patches:

          with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):     ...

     Use *note DEFAULT: 32c4. as the value if you want *note
     patch.multiple(): 32ef. to create mocks for you.  In this case the
     created mocks are passed into a decorated function by keyword, and
     a dictionary is returned when *note patch.multiple(): 32ef. is used
     as a context manager.

     *note patch.multiple(): 32ef. can be used as a decorator, class
     decorator or a context manager.  The arguments `spec', `spec_set',
     `create', `autospec' and `new_callable' have the same meaning as
     for *note patch(): 77c.  These arguments will be applied to `all'
     patches done by *note patch.multiple(): 32ef.

     When used as a class decorator *note patch.multiple(): 32ef.
     honours ‘patch.TEST_PREFIX’ for choosing which methods to wrap.

If you want *note patch.multiple(): 32ef. to create mocks for you, then
you can use *note DEFAULT: 32c4. as the value.  If you use *note
patch.multiple(): 32ef. as a decorator then the created mocks are passed
into the decorated function by keyword.

     >>> thing = object() >>> other = object()  >>> @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) ... def test_function(thing, other): ...     assert isinstance(thing, MagicMock) ...     assert isinstance(other, MagicMock) ... >>> test_function()

*note patch.multiple(): 32ef. can be nested with other ‘patch’
decorators, but put arguments passed by keyword `after' any of the
standard arguments created by *note patch(): 77c.:

     >>> @patch('sys.exit') ... @patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) ... def test_function(mock_exit, other, thing): ...     assert 'other' in repr(other) ...     assert 'thing' in repr(thing) ...     assert 'exit' in repr(mock_exit) ... >>> test_function()

If *note patch.multiple(): 32ef. is used as a context manager, the value
returned by the context manager is a dictionary where created mocks are
keyed by name:

     >>> with patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) as values: ...     assert 'other' in repr(values['other']) ...     assert 'thing' in repr(values['thing']) ...     assert values['thing'] is thing ...     assert values['other'] is other ...


File: python.info,  Node: patch methods start and stop,  Next: patch builtins,  Prev: patch multiple,  Up: The patchers

5.27.5.12 patch methods: start and stop
.......................................

All the patchers have ‘start()’ and ‘stop()’ methods.  These make it
simpler to do patching in ‘setUp’ methods or where you want to do
multiple patches without nesting decorators or with statements.

To use them call *note patch(): 77c, *note patch.object(): e90. or *note
patch.dict(): f01. as normal and keep a reference to the returned
‘patcher’ object.  You can then call ‘start()’ to put the patch in place
and ‘stop()’ to undo it.

If you are using *note patch(): 77c. to create a mock for you then it
will be returned by the call to ‘patcher.start’.

     >>> patcher = patch('package.module.ClassName') >>> from package import module >>> original = module.ClassName >>> new_mock = patcher.start() >>> assert module.ClassName is not original >>> assert module.ClassName is new_mock >>> patcher.stop() >>> assert module.ClassName is original >>> assert module.ClassName is not new_mock

A typical use case for this might be for doing multiple patches in the
‘setUp’ method of a ‘TestCase’:

     >>> class MyTest(unittest.TestCase): ...     def setUp(self): ...         self.patcher1 = patch('package.module.Class1') ...         self.patcher2 = patch('package.module.Class2') ...         self.MockClass1 = self.patcher1.start() ...         self.MockClass2 = self.patcher2.start() ... ...     def tearDown(self): ...         self.patcher1.stop() ...         self.patcher2.stop() ... ...     def test_something(self): ...         assert package.module.Class1 is self.MockClass1 ...         assert package.module.Class2 is self.MockClass2 ... >>> MyTest('test_something').run()

     Caution: If you use this technique you must ensure that the
     patching is “undone” by calling ‘stop’.  This can be fiddlier than
     you might think, because if an exception is raised in the ‘setUp’
     then ‘tearDown’ is not called.  *note
     unittest.TestCase.addCleanup(): 2a0. makes this easier:

          >>> class MyTest(unittest.TestCase): ...     def setUp(self): ...         patcher = patch('package.module.Class') ...         self.MockClass = patcher.start() ...         self.addCleanup(patcher.stop) ... ...     def test_something(self): ...         assert package.module.Class is self.MockClass ...

     As an added bonus you no longer need to keep a reference to the
     ‘patcher’ object.

It is also possible to stop all patches which have been started by using
*note patch.stopall(): 32f2.

 -- Function: patch.stopall ()

     Stop all active patches.  Only stops patches started with ‘start’.


File: python.info,  Node: patch builtins,  Next: TEST_PREFIX,  Prev: patch methods start and stop,  Up: The patchers

5.27.5.13 patch builtins
........................

You can patch any builtins within a module.  The following example
patches builtin *note ord(): 1362.:

     >>> @patch('__main__.ord') ... def test(mock_ord): ...     mock_ord.return_value = 101 ...     print(ord('c')) ... >>> test() 101


File: python.info,  Node: TEST_PREFIX,  Next: Nesting Patch Decorators,  Prev: patch builtins,  Up: The patchers

5.27.5.14 TEST_PREFIX
.....................

All of the patchers can be used as class decorators.  When used in this
way they wrap every test method on the class.  The patchers recognise
methods that start with ‘'test'’ as being test methods.  This is the
same way that the *note unittest.TestLoader: 776. finds test methods by
default.

It is possible that you want to use a different prefix for your tests.
You can inform the patchers of the different prefix by setting
‘patch.TEST_PREFIX’:

     >>> patch.TEST_PREFIX = 'foo' >>> value = 3 >>> >>> @patch('__main__.value', 'not three') ... class Thing: ...     def foo_one(self): ...         print(value) ...     def foo_two(self): ...         print(value) ... >>> >>> Thing().foo_one() not three >>> Thing().foo_two() not three >>> value 3


File: python.info,  Node: Nesting Patch Decorators,  Next: Where to patch,  Prev: TEST_PREFIX,  Up: The patchers

5.27.5.15 Nesting Patch Decorators
..................................

If you want to perform multiple patches then you can simply stack up the
decorators.

You can stack up multiple patch decorators using this pattern:

     >>> @patch.object(SomeClass, 'class_method') ... @patch.object(SomeClass, 'static_method') ... def test(mock1, mock2): ...     assert SomeClass.static_method is mock1 ...     assert SomeClass.class_method is mock2 ...     SomeClass.static_method('foo') ...     SomeClass.class_method('bar') ...     return mock1, mock2 ... >>> mock1, mock2 = test() >>> mock1.assert_called_once_with('foo') >>> mock2.assert_called_once_with('bar')

Note that the decorators are applied from the bottom upwards.  This is
the standard way that Python applies decorators.  The order of the
created mocks passed into your test function matches this order.


File: python.info,  Node: Where to patch,  Next: Patching Descriptors and Proxy Objects,  Prev: Nesting Patch Decorators,  Up: The patchers

5.27.5.16 Where to patch
........................

*note patch(): 77c. works by (temporarily) changing the object that a
`name' points to with another one.  There can be many names pointing to
any individual object, so for patching to work you must ensure that you
patch the name used by the system under test.

The basic principle is that you patch where an object is `looked up',
which is not necessarily the same place as where it is defined.  A
couple of examples will help to clarify this.

Imagine we have a project that we want to test with the following
structure:

     a.py     -> Defines SomeClass  b.py     -> from a import SomeClass     -> some_function instantiates SomeClass

Now we want to test ‘some_function’ but we want to mock out ‘SomeClass’
using *note patch(): 77c.  The problem is that when we import module b,
which we will have to do then it imports ‘SomeClass’ from module a.  If
we use *note patch(): 77c. to mock out ‘a.SomeClass’ then it will have
no effect on our test; module b already has a reference to the `real'
‘SomeClass’ and it looks like our patching had no effect.

The key is to patch out ‘SomeClass’ where it is used (or where it is
looked up).  In this case ‘some_function’ will actually look up
‘SomeClass’ in module b, where we have imported it.  The patching should
look like:

     @patch('b.SomeClass')

However, consider the alternative scenario where instead of ‘from a
import SomeClass’ module b does ‘import a’ and ‘some_function’ uses
‘a.SomeClass’.  Both of these import forms are common.  In this case the
class we want to patch is being looked up in the module and so we have
to patch ‘a.SomeClass’ instead:

     @patch('a.SomeClass')


File: python.info,  Node: Patching Descriptors and Proxy Objects,  Prev: Where to patch,  Up: The patchers

5.27.5.17 Patching Descriptors and Proxy Objects
................................................

Both *note patch: 32e9. and *note patch.object: 32eb. correctly patch
and restore descriptors: class methods, static methods and properties.
You should patch these on the `class' rather than an instance.  They
also work with `some' objects that proxy attribute access, like the
django settings object(1).

   ---------- Footnotes ----------

   (1) 
http://www.voidspace.org.uk/python/weblog/arch_d7_2010_12_04.shtml#e1198


File: python.info,  Node: MagicMock and magic method support,  Next: Helpers,  Prev: The patchers,  Up: unittest mock — mock object library

5.27.5.18 MagicMock and magic method support
............................................

* Menu:

* Mocking Magic Methods::
* Magic Mock::


File: python.info,  Node: Mocking Magic Methods,  Next: Magic Mock,  Up: MagicMock and magic method support

5.27.5.19 Mocking Magic Methods
...............................

*note Mock: 247. supports mocking the Python protocol methods, also
known as “magic methods”.  This allows mock objects to replace
containers or other objects that implement Python protocols.

Because magic methods are looked up differently from normal methods (1),
this support has been specially implemented.  This means that only
specific magic methods are supported.  The supported list includes
`almost' all of them.  If there are any missing that you need please let
us know.

You mock magic methods by setting the method you are interested in to a
function or a mock instance.  If you are using a function then it `must'
take ‘self’ as the first argument (2).

     >>> def __str__(self): ...     return 'fooble' ... >>> mock = Mock() >>> mock.__str__ = __str__ >>> str(mock) 'fooble'

     >>> mock = Mock() >>> mock.__str__ = Mock() >>> mock.__str__.return_value = 'fooble' >>> str(mock) 'fooble'

     >>> mock = Mock() >>> mock.__iter__ = Mock(return_value=iter([])) >>> list(mock) []

One use case for this is for mocking objects used as context managers in
a *note with: 6dd. statement:

     >>> mock = Mock() >>> mock.__enter__ = Mock(return_value='foo') >>> mock.__exit__ = Mock(return_value=False) >>> with mock as m: ...     assert m == 'foo' ... >>> mock.__enter__.assert_called_with() >>> mock.__exit__.assert_called_with(None, None, None)

Calls to magic methods do not appear in *note method_calls: 32cd, but
they are recorded in *note mock_calls: 32ca.

     Note: If you use the `spec' keyword argument to create a mock then
     attempting to set a magic method that isn’t in the spec will raise
     an *note AttributeError: 390.

The full list of supported magic methods is:

   * ‘__hash__’, ‘__sizeof__’, ‘__repr__’ and ‘__str__’

   * ‘__dir__’, ‘__format__’ and ‘__subclasses__’

   * ‘__round__’, ‘__floor__’, ‘__trunc__’ and ‘__ceil__’

   * Comparisons: ‘__lt__’, ‘__gt__’, ‘__le__’, ‘__ge__’, ‘__eq__’ and
     ‘__ne__’

   * Container methods: ‘__getitem__’, ‘__setitem__’, ‘__delitem__’,
     ‘__contains__’, ‘__len__’, ‘__iter__’, ‘__reversed__’ and
     ‘__missing__’

   * Context manager: ‘__enter__’, ‘__exit__’, ‘__aenter__’ and
     ‘__aexit__’

   * Unary numeric methods: ‘__neg__’, ‘__pos__’ and ‘__invert__’

   * The numeric methods (including right hand and in-place variants):
     ‘__add__’, ‘__sub__’, ‘__mul__’, ‘__matmul__’, ‘__div__’,
     ‘__truediv__’, ‘__floordiv__’, ‘__mod__’, ‘__divmod__’,
     ‘__lshift__’, ‘__rshift__’, ‘__and__’, ‘__xor__’, ‘__or__’, and
     ‘__pow__’

   * Numeric conversion methods: ‘__complex__’, ‘__int__’, ‘__float__’
     and ‘__index__’

   * Descriptor methods: ‘__get__’, ‘__set__’ and ‘__delete__’

   * Pickling: ‘__reduce__’, ‘__reduce_ex__’, ‘__getinitargs__’,
     ‘__getnewargs__’, ‘__getstate__’ and ‘__setstate__’

   * File system path representation: ‘__fspath__’

   * Asynchronous iteration methods: ‘__aiter__’ and ‘__anext__’

Changed in version 3.8: Added support for *note
os.PathLike.__fspath__(): 4e1.

Changed in version 3.8: Added support for ‘__aenter__’, ‘__aexit__’,
‘__aiter__’ and ‘__anext__’.

The following methods exist but are `not' supported as they are either
in use by mock, can’t be set dynamically, or can cause problems:

   * ‘__getattr__’, ‘__setattr__’, ‘__init__’ and ‘__new__’

   * ‘__prepare__’, ‘__instancecheck__’, ‘__subclasscheck__’, ‘__del__’

   ---------- Footnotes ----------

   (1) (2) Magic methods `should' be looked up on the class rather than
the instance.  Different versions of Python are inconsistent about
applying this rule.  The supported protocol methods should work with all
supported versions of Python.

   (2) (3) The function is basically hooked up to the class, but each
‘Mock’ instance is kept isolated from the others.


File: python.info,  Node: Magic Mock,  Prev: Mocking Magic Methods,  Up: MagicMock and magic method support

5.27.5.20 Magic Mock
....................

There are two ‘MagicMock’ variants: *note MagicMock: 779. and *note
NonCallableMagicMock: 32c2.

 -- Class: unittest.mock.MagicMock (*args, **kw)

     ‘MagicMock’ is a subclass of *note Mock: 247. with default
     implementations of most of the magic methods.  You can use
     ‘MagicMock’ without having to configure the magic methods yourself.

     The constructor parameters have the same meaning as for *note Mock:
     247.

     If you use the `spec' or `spec_set' arguments then `only' magic
     methods that exist in the spec will be created.

 -- Class: unittest.mock.NonCallableMagicMock (*args, **kw)

     A non-callable version of *note MagicMock: 779.

     The constructor parameters have the same meaning as for *note
     MagicMock: 779, with the exception of `return_value' and
     `side_effect' which have no meaning on a non-callable mock.

The magic methods are setup with *note MagicMock: 779. objects, so you
can configure them and use them in the usual way:

     >>> mock = MagicMock() >>> mock[3] = 'fish' >>> mock.__setitem__.assert_called_with(3, 'fish') >>> mock.__getitem__.return_value = 'result' >>> mock[2] 'result'

By default many of the protocol methods are required to return objects
of a specific type.  These methods are preconfigured with a default
return value, so that they can be used without you having to do anything
if you aren’t interested in the return value.  You can still `set' the
return value manually if you want to change the default.

Methods and their defaults:

   * ‘__lt__’: ‘NotImplemented’

   * ‘__gt__’: ‘NotImplemented’

   * ‘__le__’: ‘NotImplemented’

   * ‘__ge__’: ‘NotImplemented’

   * ‘__int__’: ‘1’

   * ‘__contains__’: ‘False’

   * ‘__len__’: ‘0’

   * ‘__iter__’: ‘iter([])’

   * ‘__exit__’: ‘False’

   * ‘__aexit__’: ‘False’

   * ‘__complex__’: ‘1j’

   * ‘__float__’: ‘1.0’

   * ‘__bool__’: ‘True’

   * ‘__index__’: ‘1’

   * ‘__hash__’: default hash for the mock

   * ‘__str__’: default str for the mock

   * ‘__sizeof__’: default sizeof for the mock

For example:

     >>> mock = MagicMock() >>> int(mock) 1 >>> len(mock) 0 >>> list(mock) [] >>> object() in mock False

The two equality methods, *note __eq__(): 334. and *note __ne__(): e49,
are special.  They do the default equality comparison on identity, using
the *note side_effect: 32c3. attribute, unless you change their return
value to return something else:

     >>> MagicMock() == 3 False >>> MagicMock() != 3 True >>> mock = MagicMock() >>> mock.__eq__.return_value = True >>> mock == 3 True

The return value of ‘MagicMock.__iter__()’ can be any iterable object
and isn’t required to be an iterator:

     >>> mock = MagicMock() >>> mock.__iter__.return_value = ['a', 'b', 'c'] >>> list(mock) ['a', 'b', 'c'] >>> list(mock) ['a', 'b', 'c']

If the return value `is' an iterator, then iterating over it once will
consume it and subsequent iterations will result in an empty list:

     >>> mock.__iter__.return_value = iter(['a', 'b', 'c']) >>> list(mock) ['a', 'b', 'c'] >>> list(mock) []

‘MagicMock’ has all of the supported magic methods configured except for
some of the obscure and obsolete ones.  You can still set these up if
you want.

Magic methods that are supported but not setup by default in ‘MagicMock’
are:

   * ‘__subclasses__’

   * ‘__dir__’

   * ‘__format__’

   * ‘__get__’, ‘__set__’ and ‘__delete__’

   * ‘__reversed__’ and ‘__missing__’

   * ‘__reduce__’, ‘__reduce_ex__’, ‘__getinitargs__’, ‘__getnewargs__’,
     ‘__getstate__’ and ‘__setstate__’

   * ‘__getformat__’ and ‘__setformat__’


File: python.info,  Node: Helpers,  Prev: MagicMock and magic method support,  Up: unittest mock — mock object library

5.27.5.21 Helpers
.................

* Menu:

* sentinel::
* DEFAULT::
* call::
* create_autospec::
* ANY::
* FILTER_DIR::
* mock_open::
* Autospeccing::
* Sealing mocks::


File: python.info,  Node: sentinel,  Next: DEFAULT,  Up: Helpers

5.27.5.22 sentinel
..................

 -- Data: unittest.mock.sentinel

     The ‘sentinel’ object provides a convenient way of providing unique
     objects for your tests.

     Attributes are created on demand when you access them by name.
     Accessing the same attribute will always return the same object.
     The objects returned have a sensible repr so that test failure
     messages are readable.

     Changed in version 3.7: The ‘sentinel’ attributes now preserve
     their identity when they are *note copied: 26. or *note pickled:
     ca.

Sometimes when testing you need to test that a specific object is passed
as an argument to another method, or returned.  It can be common to
create named sentinel objects to test this.  *note sentinel: 3ff.
provides a convenient way of creating and testing the identity of
objects like this.

In this example we monkey patch ‘method’ to return
‘sentinel.some_object’:

     >>> real = ProductionClass() >>> real.method = Mock(name="method") >>> real.method.return_value = sentinel.some_object >>> result = real.method() >>> assert result is sentinel.some_object >>> sentinel.some_object sentinel.some_object


File: python.info,  Node: DEFAULT,  Next: call,  Prev: sentinel,  Up: Helpers

5.27.5.23 DEFAULT
.................

 -- Data: unittest.mock.DEFAULT

     The *note DEFAULT: 32c4. object is a pre-created sentinel (actually
     ‘sentinel.DEFAULT’).  It can be used by *note side_effect: 32c3.
     functions to indicate that the normal return value should be used.


File: python.info,  Node: call,  Next: create_autospec,  Prev: DEFAULT,  Up: Helpers

5.27.5.24 call
..............

 -- Function: unittest.mock.call (*args, **kwargs)

     *note call(): eab. is a helper object for making simpler
     assertions, for comparing with *note call_args: 32d3, *note
     call_args_list: 32d4, *note mock_calls: 32ca. and *note
     method_calls: 32cd.  *note call(): eab. can also be used with *note
     assert_has_calls(): 32c9.

          >>> m = MagicMock(return_value=None) >>> m(1, 2, a='foo', b='bar') >>> m() >>> m.call_args_list == [call(1, 2, a='foo', b='bar'), call()] True

 -- Method: call.call_list ()

     For a call object that represents multiple calls, *note
     call_list(): 32ff. returns a list of all the intermediate calls as
     well as the final call.

‘call_list’ is particularly useful for making assertions on “chained
calls”.  A chained call is multiple calls on a single line of code.
This results in multiple entries in *note mock_calls: 32ca. on a mock.
Manually constructing the sequence of calls can be tedious.

*note call_list(): 32ff. can construct the sequence of calls from the
same chained call:

     >>> m = MagicMock() >>> m(1).method(arg='foo').other('bar')(2.0) <MagicMock name='mock().method().other()()' id='...'> >>> kall = call(1).method(arg='foo').other('bar')(2.0) >>> kall.call_list() [call(1),  call().method(arg='foo'),  call().method().other('bar'),  call().method().other()(2.0)] >>> m.mock_calls == kall.call_list() True
A ‘call’ object is either a tuple of (positional args, keyword args) or
(name, positional args, keyword args) depending on how it was
constructed.  When you construct them yourself this isn’t particularly
interesting, but the ‘call’ objects that are in the *note
Mock.call_args: 32d3, *note Mock.call_args_list: 32d4. and *note
Mock.mock_calls: 32ca. attributes can be introspected to get at the
individual arguments they contain.

The ‘call’ objects in *note Mock.call_args: 32d3. and *note
Mock.call_args_list: 32d4. are two-tuples of (positional args, keyword
args) whereas the ‘call’ objects in *note Mock.mock_calls: 32ca, along
with ones you construct yourself, are three-tuples of (name, positional
args, keyword args).

You can use their “tupleness” to pull out the individual arguments for
more complex introspection and assertions.  The positional arguments are
a tuple (an empty tuple if there are no positional arguments) and the
keyword arguments are a dictionary:

     >>> m = MagicMock(return_value=None) >>> m(1, 2, 3, arg='one', arg2='two') >>> kall = m.call_args >>> kall.args (1, 2, 3) >>> kall.kwargs {'arg': 'one', 'arg2': 'two'} >>> kall.args is kall[0] True >>> kall.kwargs is kall[1] True

     >>> m = MagicMock() >>> m.foo(4, 5, 6, arg='two', arg2='three') <MagicMock name='mock.foo()' id='...'> >>> kall = m.mock_calls[0] >>> name, args, kwargs = kall >>> name 'foo' >>> args (4, 5, 6) >>> kwargs {'arg': 'two', 'arg2': 'three'} >>> name is m.mock_calls[0][0] True


File: python.info,  Node: create_autospec,  Next: ANY,  Prev: call,  Up: Helpers

5.27.5.25 create_autospec
.........................

 -- Function: unittest.mock.create_autospec (spec, spec_set=False,
          instance=False, **kwargs)

     Create a mock object using another object as a spec.  Attributes on
     the mock will use the corresponding attribute on the `spec' object
     as their spec.

     Functions or methods being mocked will have their arguments checked
     to ensure that they are called with the correct signature.

     If `spec_set' is ‘True’ then attempting to set attributes that
     don’t exist on the spec object will raise an *note AttributeError:
     390.

     If a class is used as a spec then the return value of the mock (the
     instance of the class) will have the same spec.  You can use a
     class as the spec for an instance object by passing
     ‘instance=True’.  The returned mock will only be callable if
     instances of the mock are callable.

     *note create_autospec(): f14. also takes arbitrary keyword
     arguments that are passed to the constructor of the created mock.

See *note Autospeccing: 32bf. for examples of how to use auto-speccing
with *note create_autospec(): f14. and the `autospec' argument to *note
patch(): 77c.

Changed in version 3.8: *note create_autospec(): f14. now returns an
*note AsyncMock: 246. if the target is an async function.


File: python.info,  Node: ANY,  Next: FILTER_DIR,  Prev: create_autospec,  Up: Helpers

5.27.5.26 ANY
.............

 -- Data: unittest.mock.ANY

Sometimes you may need to make assertions about `some' of the arguments
in a call to mock, but either not care about some of the arguments or
want to pull them individually out of *note call_args: 32d3. and make
more complex assertions on them.

To ignore certain arguments you can pass in objects that compare equal
to `everything'.  Calls to *note assert_called_with(): f33. and *note
assert_called_once_with(): 32c7. will then succeed no matter what was
passed in.

     >>> mock = Mock(return_value=None) >>> mock('foo', bar=object()) >>> mock.assert_called_once_with('foo', bar=ANY)

*note ANY: 3302. can also be used in comparisons with call lists like
*note mock_calls: 32ca.:

     >>> m = MagicMock(return_value=None) >>> m(1) >>> m(1, 2) >>> m(object()) >>> m.mock_calls == [call(1), call(1, 2), ANY] True


File: python.info,  Node: FILTER_DIR,  Next: mock_open,  Prev: ANY,  Up: Helpers

5.27.5.27 FILTER_DIR
....................

 -- Data: unittest.mock.FILTER_DIR

*note FILTER_DIR: 32cf. is a module level variable that controls the way
mock objects respond to *note dir(): d26. (only for Python 2.6 or more
recent).  The default is ‘True’, which uses the filtering described
below, to only show useful members.  If you dislike this filtering, or
need to switch it off for diagnostic purposes, then set ‘mock.FILTER_DIR
= False’.

With filtering on, ‘dir(some_mock)’ shows only useful attributes and
will include any dynamically created attributes that wouldn’t normally
be shown.  If the mock was created with a `spec' (or `autospec' of
course) then all the attributes from the original are shown, even if
they haven’t been accessed yet:

     >>> dir(Mock()) ['assert_any_call',  'assert_called',  'assert_called_once',  'assert_called_once_with',  'assert_called_with',  'assert_has_calls',  'assert_not_called',  'attach_mock',  ... >>> from urllib import request >>> dir(Mock(spec=request)) ['AbstractBasicAuthHandler',  'AbstractDigestAuthHandler',  'AbstractHTTPHandler',  'BaseHandler',  ...

Many of the not-very-useful (private to *note Mock: 247. rather than the
thing being mocked) underscore and double underscore prefixed attributes
have been filtered from the result of calling *note dir(): d26. on a
*note Mock: 247.  If you dislike this behaviour you can switch it off by
setting the module level switch *note FILTER_DIR: 32cf.:

     >>> from unittest import mock >>> mock.FILTER_DIR = False >>> dir(mock.Mock()) ['_NonCallableMock__get_return_value',  '_NonCallableMock__get_side_effect',  '_NonCallableMock__return_value_doc',  '_NonCallableMock__set_return_value',  '_NonCallableMock__set_side_effect',  '__call__',  '__class__',  ...

Alternatively you can just use ‘vars(my_mock)’ (instance members) and
‘dir(type(my_mock))’ (type members) to bypass the filtering irrespective
of ‘mock.FILTER_DIR’.


File: python.info,  Node: mock_open,  Next: Autospeccing,  Prev: FILTER_DIR,  Up: Helpers

5.27.5.28 mock_open
...................

 -- Function: unittest.mock.mock_open (mock=None, read_data=None)

     A helper function to create a mock to replace the use of *note
     open(): 4e5.  It works for *note open(): 4e5. called directly or
     used as a context manager.

     The `mock' argument is the mock object to configure.  If ‘None’
     (the default) then a *note MagicMock: 779. will be created for you,
     with the API limited to methods or attributes available on standard
     file handles.

     `read_data' is a string for the ‘read()’, *note readline(): 163f,
     and *note readlines(): 16c8. methods of the file handle to return.
     Calls to those methods will take data from `read_data' until it is
     depleted.  The mock of these methods is pretty simplistic: every
     time the `mock' is called, the `read_data' is rewound to the start.
     If you need more control over the data that you are feeding to the
     tested code you will need to customize this mock for yourself.
     When that is insufficient, one of the in-memory filesystem packages
     on PyPI(1) can offer a realistic filesystem for testing.

     Changed in version 3.4: Added *note readline(): 163f. and *note
     readlines(): 16c8. support.  The mock of ‘read()’ changed to
     consume `read_data' rather than returning it on each call.

     Changed in version 3.5: `read_data' is now reset on each call to
     the `mock'.

     Changed in version 3.8: Added *note __iter__(): 504. to
     implementation so that iteration (such as in for loops) correctly
     consumes `read_data'.

Using *note open(): 4e5. as a context manager is a great way to ensure
your file handles are closed properly and is becoming common:

     with open('/some/path', 'w') as f:     f.write('something')

The issue is that even if you mock out the call to *note open(): 4e5. it
is the `returned object' that is used as a context manager (and has
*note __enter__(): c88. and *note __exit__(): c89. called).

Mocking context managers with a *note MagicMock: 779. is common enough
and fiddly enough that a helper function is useful.

     >>> m = mock_open() >>> with patch('__main__.open', m): ...     with open('foo', 'w') as h: ...         h.write('some stuff') ... >>> m.mock_calls [call('foo', 'w'),  call().__enter__(),  call().write('some stuff'),  call().__exit__(None, None, None)] >>> m.assert_called_once_with('foo', 'w') >>> handle = m() >>> handle.write.assert_called_once_with('some stuff')

And for reading files:

     >>> with patch('__main__.open', mock_open(read_data='bibble')) as m: ...     with open('foo') as h: ...         result = h.read() ... >>> m.assert_called_once_with('foo') >>> assert result == 'bibble'

   ---------- Footnotes ----------

   (1) https://pypi.org


File: python.info,  Node: Autospeccing,  Next: Sealing mocks,  Prev: mock_open,  Up: Helpers

5.27.5.29 Autospeccing
......................

Autospeccing is based on the existing ‘spec’ feature of mock.  It limits
the api of mocks to the api of an original object (the spec), but it is
recursive (implemented lazily) so that attributes of mocks only have the
same api as the attributes of the spec.  In addition mocked functions /
methods have the same call signature as the original so they raise a
*note TypeError: 192. if they are called incorrectly.

Before I explain how auto-speccing works, here’s why it is needed.

*note Mock: 247. is a very powerful and flexible object, but it suffers
from two flaws when used to mock out objects from a system under test.
One of these flaws is specific to the *note Mock: 247. api and the other
is a more general problem with using mock objects.

First the problem specific to *note Mock: 247.  *note Mock: 247. has two
assert methods that are extremely handy: *note assert_called_with():
f33. and *note assert_called_once_with(): 32c7.

     >>> mock = Mock(name='Thing', return_value=None) >>> mock(1, 2, 3) >>> mock.assert_called_once_with(1, 2, 3) >>> mock(1, 2, 3) >>> mock.assert_called_once_with(1, 2, 3) Traceback (most recent call last):  ... AssertionError: Expected 'mock' to be called once. Called 2 times.

Because mocks auto-create attributes on demand, and allow you to call
them with arbitrary arguments, if you misspell one of these assert
methods then your assertion is gone:

     >>> mock = Mock(name='Thing', return_value=None) >>> mock(1, 2, 3) >>> mock.assret_called_once_with(4, 5, 6)

Your tests can pass silently and incorrectly because of the typo.

The second issue is more general to mocking.  If you refactor some of
your code, rename members and so on, any tests for code that is still
using the `old api' but uses mocks instead of the real objects will
still pass.  This means your tests can all pass even though your code is
broken.

Note that this is another reason why you need integration tests as well
as unit tests.  Testing everything in isolation is all fine and dandy,
but if you don’t test how your units are “wired together” there is still
lots of room for bugs that tests might have caught.

‘mock’ already provides a feature to help with this, called speccing.
If you use a class or instance as the ‘spec’ for a mock then you can
only access attributes on the mock that exist on the real class:

     >>> from urllib import request >>> mock = Mock(spec=request.Request) >>> mock.assret_called_with Traceback (most recent call last):  ... AttributeError: Mock object has no attribute 'assret_called_with'

The spec only applies to the mock itself, so we still have the same
issue with any methods on the mock:

     >>> mock.has_data() <mock.Mock object at 0x...> >>> mock.has_data.assret_called_with()

Auto-speccing solves this problem.  You can either pass ‘autospec=True’
to *note patch(): 77c. / *note patch.object(): e90. or use the *note
create_autospec(): f14. function to create a mock with a spec.  If you
use the ‘autospec=True’ argument to *note patch(): 77c. then the object
that is being replaced will be used as the spec object.  Because the
speccing is done “lazily” (the spec is created as attributes on the mock
are accessed) you can use it with very complex or deeply nested objects
(like modules that import modules that import modules) without a big
performance hit.

Here’s an example of it in use:

     >>> from urllib import request >>> patcher = patch('__main__.request', autospec=True) >>> mock_request = patcher.start() >>> request is mock_request True >>> mock_request.Request <MagicMock name='request.Request' spec='Request' id='...'>

You can see that ‘request.Request’ has a spec.  ‘request.Request’ takes
two arguments in the constructor (one of which is `self').  Here’s what
happens if we try to call it incorrectly:

     >>> req = request.Request() Traceback (most recent call last):  ... TypeError: <lambda>() takes at least 2 arguments (1 given)

The spec also applies to instantiated classes (i.e.  the return value of
specced mocks):

     >>> req = request.Request('foo') >>> req <NonCallableMagicMock name='request.Request()' spec='Request' id='...'>

‘Request’ objects are not callable, so the return value of instantiating
our mocked out ‘request.Request’ is a non-callable mock.  With the spec
in place any typos in our asserts will raise the correct error:

     >>> req.add_header('spam', 'eggs') <MagicMock name='request.Request().add_header()' id='...'> >>> req.add_header.assret_called_with Traceback (most recent call last):  ... AttributeError: Mock object has no attribute 'assret_called_with' >>> req.add_header.assert_called_with('spam', 'eggs')

In many cases you will just be able to add ‘autospec=True’ to your
existing *note patch(): 77c. calls and then be protected against bugs
due to typos and api changes.

As well as using `autospec' through *note patch(): 77c. there is a *note
create_autospec(): f14. for creating autospecced mocks directly:

     >>> from urllib import request >>> mock_request = create_autospec(request) >>> mock_request.Request('foo', 'bar') <NonCallableMagicMock name='mock.Request()' spec='Request' id='...'>

This isn’t without caveats and limitations however, which is why it is
not the default behaviour.  In order to know what attributes are
available on the spec object, autospec has to introspect (access
attributes) the spec.  As you traverse attributes on the mock a
corresponding traversal of the original object is happening under the
hood.  If any of your specced objects have properties or descriptors
that can trigger code execution then you may not be able to use
autospec.  On the other hand it is much better to design your objects so
that introspection is safe (1).

A more serious problem is that it is common for instance attributes to
be created in the *note __init__(): d51. method and not to exist on the
class at all.  `autospec' can’t know about any dynamically created
attributes and restricts the api to visible attributes.

     >>> class Something: ...   def __init__(self): ...     self.a = 33 ... >>> with patch('__main__.Something', autospec=True): ...   thing = Something() ...   thing.a ... Traceback (most recent call last):   ... AttributeError: Mock object has no attribute 'a'

There are a few different ways of resolving this problem.  The easiest,
but not necessarily the least annoying, way is to simply set the
required attributes on the mock after creation.  Just because `autospec'
doesn’t allow you to fetch attributes that don’t exist on the spec it
doesn’t prevent you setting them:

     >>> with patch('__main__.Something', autospec=True): ...   thing = Something() ...   thing.a = 33 ...

There is a more aggressive version of both `spec' and `autospec' that
`does' prevent you setting non-existent attributes.  This is useful if
you want to ensure your code only `sets' valid attributes too, but
obviously it prevents this particular scenario:

     >>> with patch('__main__.Something', autospec=True, spec_set=True): ...   thing = Something() ...   thing.a = 33 ... Traceback (most recent call last):  ... AttributeError: Mock object has no attribute 'a'

Probably the best way of solving the problem is to add class attributes
as default values for instance members initialised in *note __init__():
d51.  Note that if you are only setting default attributes in *note
__init__(): d51. then providing them via class attributes (shared
between instances of course) is faster too.  e.g.

     class Something:     a = 33

This brings up another issue.  It is relatively common to provide a
default value of ‘None’ for members that will later be an object of a
different type.  ‘None’ would be useless as a spec because it wouldn’t
let you access `any' attributes or methods on it.  As ‘None’ is `never'
going to be useful as a spec, and probably indicates a member that will
normally of some other type, autospec doesn’t use a spec for members
that are set to ‘None’.  These will just be ordinary mocks (well -
MagicMocks):

     >>> class Something: ...     member = None ... >>> mock = create_autospec(Something) >>> mock.member.foo.bar.baz() <MagicMock name='mock.member.foo.bar.baz()' id='...'>

If modifying your production classes to add defaults isn’t to your
liking then there are more options.  One of these is simply to use an
instance as the spec rather than the class.  The other is to create a
subclass of the production class and add the defaults to the subclass
without affecting the production class.  Both of these require you to
use an alternative object as the spec.  Thankfully *note patch(): 77c.
supports this - you can simply pass the alternative object as the
`autospec' argument:

     >>> class Something: ...   def __init__(self): ...     self.a = 33 ... >>> class SomethingForTest(Something): ...   a = 33 ... >>> p = patch('__main__.Something', autospec=SomethingForTest) >>> mock = p.start() >>> mock.a <NonCallableMagicMock name='Something.a' spec='int' id='...'>

   ---------- Footnotes ----------

   (1) (4) This only applies to classes or already instantiated objects.
Calling a mocked class to create a mock instance `does not' create a
real instance.  It is only attribute lookups - along with calls to *note
dir(): d26. - that are done.


File: python.info,  Node: Sealing mocks,  Prev: Autospeccing,  Up: Helpers

5.27.5.30 Sealing mocks
.......................

 -- Function: unittest.mock.seal (mock)

     Seal will disable the automatic creation of mocks when accessing an
     attribute of the mock being sealed or any of its attributes that
     are already mocks recursively.

     If a mock instance with a name or a spec is assigned to an
     attribute it won’t be considered in the sealing chain.  This allows
     one to prevent seal from fixing part of the mock object.

          >>> mock = Mock() >>> mock.submock.attribute1 = 2 >>> mock.not_submock = mock.Mock(name="sample_name") >>> seal(mock) >>> mock.new_attribute  # This will raise AttributeError. >>> mock.submock.attribute2  # This will raise AttributeError. >>> mock.not_submock.attribute2  # This won't raise.

     New in version 3.7.


File: python.info,  Node: unittest mock — getting started,  Next: 2to3 - Automated Python 2 to 3 code translation,  Prev: unittest mock — mock object library,  Up: Development Tools

5.27.6 ‘unittest.mock’ — getting started
----------------------------------------

New in version 3.3.

* Menu:

* Using Mock::
* Patch Decorators::
* Further Examples::


File: python.info,  Node: Using Mock,  Next: Patch Decorators,  Up: unittest mock — getting started

5.27.6.1 Using Mock
...................

* Menu:

* Mock Patching Methods::
* Mock for Method Calls on an Object::
* Mocking Classes::
* Naming your mocks::
* Tracking all Calls::
* Setting Return Values and Attributes::
* Raising exceptions with mocks::
* Side effect functions and iterables::
* Mocking asynchronous iterators::
* Mocking asynchronous context manager::
* Creating a Mock from an Existing Object::


File: python.info,  Node: Mock Patching Methods,  Next: Mock for Method Calls on an Object,  Up: Using Mock

5.27.6.2 Mock Patching Methods
..............................

Common uses for *note Mock: 247. objects include:

   * Patching methods

   * Recording method calls on objects

You might want to replace a method on an object to check that it is
called with the correct arguments by another part of the system:

     >>> real = SomeClass() >>> real.method = MagicMock(name='method') >>> real.method(3, 4, 5, key='value') <MagicMock name='method()' id='...'>

Once our mock has been used (‘real.method’ in this example) it has
methods and attributes that allow you to make assertions about how it
has been used.

     Note: In most of these examples the *note Mock: 247. and *note
     MagicMock: 779. classes are interchangeable.  As the ‘MagicMock’ is
     the more capable class it makes a sensible one to use by default.

Once the mock has been called its *note called: 32d1. attribute is set
to ‘True’.  More importantly we can use the *note assert_called_with():
f33. or *note assert_called_once_with(): 32c7. method to check that it
was called with the correct arguments.

This example tests that calling ‘ProductionClass().method’ results in a
call to the ‘something’ method:

     >>> class ProductionClass: ...     def method(self): ...         self.something(1, 2, 3) ...     def something(self, a, b, c): ...         pass ... >>> real = ProductionClass() >>> real.something = MagicMock() >>> real.method() >>> real.something.assert_called_once_with(1, 2, 3)


File: python.info,  Node: Mock for Method Calls on an Object,  Next: Mocking Classes,  Prev: Mock Patching Methods,  Up: Using Mock

5.27.6.3 Mock for Method Calls on an Object
...........................................

In the last example we patched a method directly on an object to check
that it was called correctly.  Another common use case is to pass an
object into a method (or some part of the system under test) and then
check that it is used in the correct way.

The simple ‘ProductionClass’ below has a ‘closer’ method.  If it is
called with an object then it calls ‘close’ on it.

     >>> class ProductionClass: ...     def closer(self, something): ...         something.close() ...

So to test it we need to pass in an object with a ‘close’ method and
check that it was called correctly.

     >>> real = ProductionClass() >>> mock = Mock() >>> real.closer(mock) >>> mock.close.assert_called_with()

We don’t have to do any work to provide the ‘close’ method on our mock.
Accessing close creates it.  So, if ‘close’ hasn’t already been called
then accessing it in the test will create it, but *note
assert_called_with(): f33. will raise a failure exception.


File: python.info,  Node: Mocking Classes,  Next: Naming your mocks,  Prev: Mock for Method Calls on an Object,  Up: Using Mock

5.27.6.4 Mocking Classes
........................

A common use case is to mock out classes instantiated by your code under
test.  When you patch a class, then that class is replaced with a mock.
Instances are created by `calling the class'.  This means you access the
“mock instance” by looking at the return value of the mocked class.

In the example below we have a function ‘some_function’ that
instantiates ‘Foo’ and calls a method on it.  The call to *note patch():
77c. replaces the class ‘Foo’ with a mock.  The ‘Foo’ instance is the
result of calling the mock, so it is configured by modifying the mock
*note return_value: 32c5.

     >>> def some_function(): ...     instance = module.Foo() ...     return instance.method() ... >>> with patch('module.Foo') as mock: ...     instance = mock.return_value ...     instance.method.return_value = 'the result' ...     result = some_function() ...     assert result == 'the result'


File: python.info,  Node: Naming your mocks,  Next: Tracking all Calls,  Prev: Mocking Classes,  Up: Using Mock

5.27.6.5 Naming your mocks
..........................

It can be useful to give your mocks a name.  The name is shown in the
repr of the mock and can be helpful when the mock appears in test
failure messages.  The name is also propagated to attributes or methods
of the mock:

     >>> mock = MagicMock(name='foo') >>> mock <MagicMock name='foo' id='...'> >>> mock.method <MagicMock name='foo.method' id='...'>


File: python.info,  Node: Tracking all Calls,  Next: Setting Return Values and Attributes,  Prev: Naming your mocks,  Up: Using Mock

5.27.6.6 Tracking all Calls
...........................

Often you want to track more than a single call to a method.  The *note
mock_calls: 32ca. attribute records all calls to child attributes of the
mock - and also to their children.

     >>> mock = MagicMock() >>> mock.method() <MagicMock name='mock.method()' id='...'> >>> mock.attribute.method(10, x=53) <MagicMock name='mock.attribute.method()' id='...'> >>> mock.mock_calls [call.method(), call.attribute.method(10, x=53)]

If you make an assertion about ‘mock_calls’ and any unexpected methods
have been called, then the assertion will fail.  This is useful because
as well as asserting that the calls you expected have been made, you are
also checking that they were made in the right order and with no
additional calls:

You use the *note call: eab. object to construct lists for comparing
with ‘mock_calls’:

     >>> expected = [call.method(), call.attribute.method(10, x=53)] >>> mock.mock_calls == expected True

However, parameters to calls that return mocks are not recorded, which
means it is not possible to track nested calls where the parameters used
to create ancestors are important:

     >>> m = Mock() >>> m.factory(important=True).deliver() <Mock name='mock.factory().deliver()' id='...'> >>> m.mock_calls[-1] == call.factory(important=False).deliver() True


File: python.info,  Node: Setting Return Values and Attributes,  Next: Raising exceptions with mocks,  Prev: Tracking all Calls,  Up: Using Mock

5.27.6.7 Setting Return Values and Attributes
.............................................

Setting the return values on a mock object is trivially easy:

     >>> mock = Mock() >>> mock.return_value = 3 >>> mock() 3

Of course you can do the same for methods on the mock:

     >>> mock = Mock() >>> mock.method.return_value = 3 >>> mock.method() 3

The return value can also be set in the constructor:

     >>> mock = Mock(return_value=3) >>> mock() 3

If you need an attribute setting on your mock, just do it:

     >>> mock = Mock() >>> mock.x = 3 >>> mock.x 3

Sometimes you want to mock up a more complex situation, like for example
‘mock.connection.cursor().execute("SELECT 1")’.  If we wanted this call
to return a list, then we have to configure the result of the nested
call.

We can use *note call: eab. to construct the set of calls in a “chained
call” like this for easy assertion afterwards:

     >>> mock = Mock() >>> cursor = mock.connection.cursor.return_value >>> cursor.execute.return_value = ['foo'] >>> mock.connection.cursor().execute("SELECT 1") ['foo'] >>> expected = call.connection.cursor().execute("SELECT 1").call_list() >>> mock.mock_calls [call.connection.cursor(), call.connection.cursor().execute('SELECT 1')] >>> mock.mock_calls == expected True

It is the call to ‘.call_list()’ that turns our call object into a list
of calls representing the chained calls.


File: python.info,  Node: Raising exceptions with mocks,  Next: Side effect functions and iterables,  Prev: Setting Return Values and Attributes,  Up: Using Mock

5.27.6.8 Raising exceptions with mocks
......................................

A useful attribute is *note side_effect: 32c3.  If you set this to an
exception class or instance then the exception will be raised when the
mock is called.

     >>> mock = Mock(side_effect=Exception('Boom!')) >>> mock() Traceback (most recent call last):   ... Exception: Boom!


File: python.info,  Node: Side effect functions and iterables,  Next: Mocking asynchronous iterators,  Prev: Raising exceptions with mocks,  Up: Using Mock

5.27.6.9 Side effect functions and iterables
............................................

‘side_effect’ can also be set to a function or an iterable.  The use
case for ‘side_effect’ as an iterable is where your mock is going to be
called several times, and you want each call to return a different
value.  When you set ‘side_effect’ to an iterable every call to the mock
returns the next value from the iterable:

     >>> mock = MagicMock(side_effect=[4, 5, 6]) >>> mock() 4 >>> mock() 5 >>> mock() 6

For more advanced use cases, like dynamically varying the return values
depending on what the mock is called with, ‘side_effect’ can be a
function.  The function will be called with the same arguments as the
mock.  Whatever the function returns is what the call returns:

     >>> vals = {(1, 2): 1, (2, 3): 2} >>> def side_effect(*args): ...     return vals[args] ... >>> mock = MagicMock(side_effect=side_effect) >>> mock(1, 2) 1 >>> mock(2, 3) 2


File: python.info,  Node: Mocking asynchronous iterators,  Next: Mocking asynchronous context manager,  Prev: Side effect functions and iterables,  Up: Using Mock

5.27.6.10 Mocking asynchronous iterators
........................................

Since Python 3.8, ‘AsyncMock’ and ‘MagicMock’ have support to mock *note
Asynchronous Iterators: 63a. through ‘__aiter__’.  The *note
return_value: 32c5. attribute of ‘__aiter__’ can be used to set the
return values to be used for iteration.

     >>> mock = MagicMock()  # AsyncMock also works here >>> mock.__aiter__.return_value = [1, 2, 3] >>> async def main(): ...     return [i async for i in mock] ... >>> asyncio.run(main()) [1, 2, 3]


File: python.info,  Node: Mocking asynchronous context manager,  Next: Creating a Mock from an Existing Object,  Prev: Mocking asynchronous iterators,  Up: Using Mock

5.27.6.11 Mocking asynchronous context manager
..............................................

Since Python 3.8, ‘AsyncMock’ and ‘MagicMock’ have support to mock *note
Asynchronous Context Managers: 13d2. through ‘__aenter__’ and
‘__aexit__’.  By default, ‘__aenter__’ and ‘__aexit__’ are ‘AsyncMock’
instances that return an async function.

     >>> class AsyncContextManager: ...     async def __aenter__(self): ...         return self ...     async def __aexit__(self, exc_type, exc, tb): ...         pass ... >>> mock_instance = MagicMock(AsyncContextManager())  # AsyncMock also works here >>> async def main(): ...     async with mock_instance as result: ...         pass ... >>> asyncio.run(main()) >>> mock_instance.__aenter__.assert_awaited_once() >>> mock_instance.__aexit__.assert_awaited_once()


File: python.info,  Node: Creating a Mock from an Existing Object,  Prev: Mocking asynchronous context manager,  Up: Using Mock

5.27.6.12 Creating a Mock from an Existing Object
.................................................

One problem with over use of mocking is that it couples your tests to
the implementation of your mocks rather than your real code.  Suppose
you have a class that implements ‘some_method’.  In a test for another
class, you provide a mock of this object that `also' provides
‘some_method’.  If later you refactor the first class, so that it no
longer has ‘some_method’ - then your tests will continue to pass even
though your code is now broken!

*note Mock: 247. allows you to provide an object as a specification for
the mock, using the `spec' keyword argument.  Accessing methods /
attributes on the mock that don’t exist on your specification object
will immediately raise an attribute error.  If you change the
implementation of your specification, then tests that use that class
will start failing immediately without you having to instantiate the
class in those tests.

     >>> mock = Mock(spec=SomeClass) >>> mock.old_method() Traceback (most recent call last):    ... AttributeError: object has no attribute 'old_method'

Using a specification also enables a smarter matching of calls made to
the mock, regardless of whether some parameters were passed as
positional or named arguments:

     >>> def f(a, b, c): pass ... >>> mock = Mock(spec=f) >>> mock(1, 2, 3) <Mock name='mock()' id='140161580456576'> >>> mock.assert_called_with(a=1, b=2, c=3)

If you want this smarter matching to also work with method calls on the
mock, you can use *note auto-speccing: 32bf.

If you want a stronger form of specification that prevents the setting
of arbitrary attributes as well as the getting of them then you can use
`spec_set' instead of `spec'.


File: python.info,  Node: Patch Decorators,  Next: Further Examples,  Prev: Using Mock,  Up: unittest mock — getting started

5.27.6.13 Patch Decorators
..........................

     Note: With *note patch(): 77c. it matters that you patch objects in
     the namespace where they are looked up.  This is normally
     straightforward, but for a quick guide read *note where to patch:
     32bd.

A common need in tests is to patch a class attribute or a module
attribute, for example patching a builtin or patching a class in a
module to test that it is instantiated.  Modules and classes are
effectively global, so patching on them has to be undone after the test
or the patch will persist into other tests and cause hard to diagnose
problems.

mock provides three convenient decorators for this: *note patch(): 77c,
*note patch.object(): e90. and *note patch.dict(): f01.  ‘patch’ takes a
single string, of the form ‘package.module.Class.attribute’ to specify
the attribute you are patching.  It also optionally takes a value that
you want the attribute (or class or whatever) to be replaced with.
‘patch.object’ takes an object and the name of the attribute you would
like patched, plus optionally the value to patch it with.

‘patch.object’:

     >>> original = SomeClass.attribute >>> @patch.object(SomeClass, 'attribute', sentinel.attribute) ... def test(): ...     assert SomeClass.attribute == sentinel.attribute ... >>> test() >>> assert SomeClass.attribute == original  >>> @patch('package.module.attribute', sentinel.attribute) ... def test(): ...     from package.module import attribute ...     assert attribute is sentinel.attribute ... >>> test()

If you are patching a module (including *note builtins: 13.) then use
*note patch(): 77c. instead of *note patch.object(): e90.:

     >>> mock = MagicMock(return_value=sentinel.file_handle) >>> with patch('builtins.open', mock): ...     handle = open('filename', 'r') ... >>> mock.assert_called_with('filename', 'r') >>> assert handle == sentinel.file_handle, "incorrect file handle returned"

The module name can be ‘dotted’, in the form ‘package.module’ if needed:

     >>> @patch('package.module.ClassName.attribute', sentinel.attribute) ... def test(): ...     from package.module import ClassName ...     assert ClassName.attribute == sentinel.attribute ... >>> test()

A nice pattern is to actually decorate test methods themselves:

     >>> class MyTest(unittest.TestCase): ...     @patch.object(SomeClass, 'attribute', sentinel.attribute) ...     def test_something(self): ...         self.assertEqual(SomeClass.attribute, sentinel.attribute) ... >>> original = SomeClass.attribute >>> MyTest('test_something').test_something() >>> assert SomeClass.attribute == original

If you want to patch with a Mock, you can use *note patch(): 77c. with
only one argument (or *note patch.object(): e90. with two arguments).
The mock will be created for you and passed into the test function /
method:

     >>> class MyTest(unittest.TestCase): ...     @patch.object(SomeClass, 'static_method') ...     def test_something(self, mock_method): ...         SomeClass.static_method() ...         mock_method.assert_called_with() ... >>> MyTest('test_something').test_something()

You can stack up multiple patch decorators using this pattern:

     >>> class MyTest(unittest.TestCase): ...     @patch('package.module.ClassName1') ...     @patch('package.module.ClassName2') ...     def test_something(self, MockClass2, MockClass1): ...         self.assertIs(package.module.ClassName1, MockClass1) ...         self.assertIs(package.module.ClassName2, MockClass2) ... >>> MyTest('test_something').test_something()

When you nest patch decorators the mocks are passed in to the decorated
function in the same order they applied (the normal `Python' order that
decorators are applied).  This means from the bottom up, so in the
example above the mock for ‘test_module.ClassName2’ is passed in first.

There is also *note patch.dict(): f01. for setting values in a
dictionary just during a scope and restoring the dictionary to its
original state when the test ends:

     >>> foo = {'key': 'value'} >>> original = foo.copy() >>> with patch.dict(foo, {'newkey': 'newvalue'}, clear=True): ...     assert foo == {'newkey': 'newvalue'} ... >>> assert foo == original

‘patch’, ‘patch.object’ and ‘patch.dict’ can all be used as context
managers.

Where you use *note patch(): 77c. to create a mock for you, you can get
a reference to the mock using the “as” form of the with statement:

     >>> class ProductionClass: ...     def method(self): ...         pass ... >>> with patch.object(ProductionClass, 'method') as mock_method: ...     mock_method.return_value = None ...     real = ProductionClass() ...     real.method(1, 2, 3) ... >>> mock_method.assert_called_with(1, 2, 3)

As an alternative ‘patch’, ‘patch.object’ and ‘patch.dict’ can be used
as class decorators.  When used in this way it is the same as applying
the decorator individually to every method whose name starts with
“test”.


File: python.info,  Node: Further Examples,  Prev: Patch Decorators,  Up: unittest mock — getting started

5.27.6.14 Further Examples
..........................

Here are some more examples for some slightly more advanced scenarios.

* Menu:

* Mocking chained calls::
* Partial mocking::
* Mocking a Generator Method::
* Applying the same patch to every test method::
* Mocking Unbound Methods::
* Checking multiple calls with mock::
* Coping with mutable arguments::
* Nesting Patches::
* Mocking a dictionary with MagicMock::
* Mock subclasses and their attributes::
* Mocking imports with patch.dict: Mocking imports with patch dict.
* Tracking order of calls and less verbose call assertions::
* More complex argument matching::


File: python.info,  Node: Mocking chained calls,  Next: Partial mocking,  Up: Further Examples

5.27.6.15 Mocking chained calls
...............................

Mocking chained calls is actually straightforward with mock once you
understand the *note return_value: 32c5. attribute.  When a mock is
called for the first time, or you fetch its ‘return_value’ before it has
been called, a new *note Mock: 247. is created.

This means that you can see how the object returned from a call to a
mocked object has been used by interrogating the ‘return_value’ mock:

     >>> mock = Mock() >>> mock().foo(a=2, b=3) <Mock name='mock().foo()' id='...'> >>> mock.return_value.foo.assert_called_with(a=2, b=3)

From here it is a simple step to configure and then make assertions
about chained calls.  Of course another alternative is writing your code
in a more testable way in the first place…

So, suppose we have some code that looks a little bit like this:

     >>> class Something: ...     def __init__(self): ...         self.backend = BackendProvider() ...     def method(self): ...         response = self.backend.get_endpoint('foobar').create_call('spam', 'eggs').start_call() ...         # more code

Assuming that ‘BackendProvider’ is already well tested, how do we test
‘method()’?  Specifically, we want to test that the code section ‘# more
code’ uses the response object in the correct way.

As this chain of calls is made from an instance attribute we can monkey
patch the ‘backend’ attribute on a ‘Something’ instance.  In this
particular case we are only interested in the return value from the
final call to ‘start_call’ so we don’t have much configuration to do.
Let’s assume the object it returns is ‘file-like’, so we’ll ensure that
our response object uses the builtin *note open(): 4e5. as its ‘spec’.

To do this we create a mock instance as our mock backend and create a
mock response object for it.  To set the response as the return value
for that final ‘start_call’ we could do this:

     mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response

We can do that in a slightly nicer way using the *note configure_mock():
32c6. method to directly set the return value for us:

     >>> something = Something() >>> mock_response = Mock(spec=open) >>> mock_backend = Mock() >>> config = {'get_endpoint.return_value.create_call.return_value.start_call.return_value': mock_response} >>> mock_backend.configure_mock(**config)

With these we monkey patch the “mock backend” in place and can make the
real call:

     >>> something.backend = mock_backend >>> something.method()

Using *note mock_calls: 32ca. we can check the chained call with a
single assert.  A chained call is several calls in one line of code, so
there will be several entries in ‘mock_calls’.  We can use *note
call.call_list(): 32ff. to create this list of calls for us:

     >>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call() >>> call_list = chained.call_list() >>> assert mock_backend.mock_calls == call_list


File: python.info,  Node: Partial mocking,  Next: Mocking a Generator Method,  Prev: Mocking chained calls,  Up: Further Examples

5.27.6.16 Partial mocking
.........................

In some tests I wanted to mock out a call to *note
datetime.date.today(): 17e0. to return a known date, but I didn’t want
to prevent the code under test from creating new date objects.
Unfortunately *note datetime.date: 193. is written in C, and so I
couldn’t just monkey-patch out the static ‘date.today()’ method.

I found a simple way of doing this that involved effectively wrapping
the date class with a mock, but passing through calls to the constructor
to the real class (and returning real instances).

The *note patch decorator: 77c. is used here to mock out the ‘date’
class in the module under test.  The ‘side_effect’ attribute on the mock
date class is then set to a lambda function that returns a real date.
When the mock date class is called a real date will be constructed and
returned by ‘side_effect’.

     >>> from datetime import date >>> with patch('mymodule.date') as mock_date: ...     mock_date.today.return_value = date(2010, 10, 8) ...     mock_date.side_effect = lambda *args, **kw: date(*args, **kw) ... ...     assert mymodule.date.today() == date(2010, 10, 8) ...     assert mymodule.date(2009, 6, 8) == date(2009, 6, 8)

Note that we don’t patch *note datetime.date: 193. globally, we patch
‘date’ in the module that `uses' it.  See *note where to patch: 32bd.

When ‘date.today()’ is called a known date is returned, but calls to the
‘date(...)’ constructor still return normal dates.  Without this you can
find yourself having to calculate an expected result using exactly the
same algorithm as the code under test, which is a classic testing
anti-pattern.

Calls to the date constructor are recorded in the ‘mock_date’ attributes
(‘call_count’ and friends) which may also be useful for your tests.

An alternative way of dealing with mocking dates, or other builtin
classes, is discussed in this blog entry(1).

   ---------- Footnotes ----------

   (1) 
https://williambert.online/2011/07/how-to-unit-testing-in-django-with-mocking-and-patching/


File: python.info,  Node: Mocking a Generator Method,  Next: Applying the same patch to every test method,  Prev: Partial mocking,  Up: Further Examples

5.27.6.17 Mocking a Generator Method
....................................

A Python generator is a function or method that uses the *note yield:
18f. statement to return a series of values when iterated over (1).

A generator method / function is called to return the generator object.
It is the generator object that is then iterated over.  The protocol
method for iteration is *note __iter__(): 1564, so we can mock this
using a *note MagicMock: 779.

Here’s an example class with an “iter” method implemented as a
generator:

     >>> class Foo: ...     def iter(self): ...         for i in [1, 2, 3]: ...             yield i ... >>> foo = Foo() >>> list(foo.iter()) [1, 2, 3]

How would we mock this class, and in particular its “iter” method?

To configure the values returned from the iteration (implicit in the
call to *note list: 260.), we need to configure the object returned by
the call to ‘foo.iter()’.

     >>> mock_foo = MagicMock() >>> mock_foo.iter.return_value = iter([1, 2, 3]) >>> list(mock_foo.iter()) [1, 2, 3]

   ---------- Footnotes ----------

   (1) (1) There are also generator expressions and more advanced uses
(http://www.dabeaz.com/coroutines/index.html) of generators, but we
aren’t concerned about them here.  A very good introduction to
generators and how powerful they are is: Generator Tricks for Systems
Programmers (http://www.dabeaz.com/generators/).


File: python.info,  Node: Applying the same patch to every test method,  Next: Mocking Unbound Methods,  Prev: Mocking a Generator Method,  Up: Further Examples

5.27.6.18 Applying the same patch to every test method
......................................................

If you want several patches in place for multiple test methods the
obvious way is to apply the patch decorators to every method.  This can
feel like unnecessary repetition.  For Python 2.6 or more recent you can
use *note patch(): 77c. (in all its various forms) as a class decorator.
This applies the patches to all test methods on the class.  A test
method is identified by methods whose names start with ‘test’:

     >>> @patch('mymodule.SomeClass') ... class MyTest(unittest.TestCase): ... ...     def test_one(self, MockSomeClass): ...         self.assertIs(mymodule.SomeClass, MockSomeClass) ... ...     def test_two(self, MockSomeClass): ...         self.assertIs(mymodule.SomeClass, MockSomeClass) ... ...     def not_a_test(self): ...         return 'something' ... >>> MyTest('test_one').test_one() >>> MyTest('test_two').test_two() >>> MyTest('test_two').not_a_test() 'something'

An alternative way of managing patches is to use the *note patch
methods; start and stop: 32f1.  These allow you to move the patching
into your ‘setUp’ and ‘tearDown’ methods.

     >>> class MyTest(unittest.TestCase): ...     def setUp(self): ...         self.patcher = patch('mymodule.foo') ...         self.mock_foo = self.patcher.start() ... ...     def test_foo(self): ...         self.assertIs(mymodule.foo, self.mock_foo) ... ...     def tearDown(self): ...         self.patcher.stop() ... >>> MyTest('test_foo').run()

If you use this technique you must ensure that the patching is “undone”
by calling ‘stop’.  This can be fiddlier than you might think, because
if an exception is raised in the setUp then tearDown is not called.
*note unittest.TestCase.addCleanup(): 2a0. makes this easier:

     >>> class MyTest(unittest.TestCase): ...     def setUp(self): ...         patcher = patch('mymodule.foo') ...         self.addCleanup(patcher.stop) ...         self.mock_foo = patcher.start() ... ...     def test_foo(self): ...         self.assertIs(mymodule.foo, self.mock_foo) ... >>> MyTest('test_foo').run()


File: python.info,  Node: Mocking Unbound Methods,  Next: Checking multiple calls with mock,  Prev: Applying the same patch to every test method,  Up: Further Examples

5.27.6.19 Mocking Unbound Methods
.................................

Whilst writing tests today I needed to patch an `unbound method'
(patching the method on the class rather than on the instance).  I
needed self to be passed in as the first argument because I want to make
asserts about which objects were calling this particular method.  The
issue is that you can’t patch with a mock for this, because if you
replace an unbound method with a mock it doesn’t become a bound method
when fetched from the instance, and so it doesn’t get self passed in.
The workaround is to patch the unbound method with a real function
instead.  The *note patch(): 77c. decorator makes it so simple to patch
out methods with a mock that having to create a real function becomes a
nuisance.

If you pass ‘autospec=True’ to patch then it does the patching with a
`real' function object.  This function object has the same signature as
the one it is replacing, but delegates to a mock under the hood.  You
still get your mock auto-created in exactly the same way as before.
What it means though, is that if you use it to patch out an unbound
method on a class the mocked function will be turned into a bound method
if it is fetched from an instance.  It will have ‘self’ passed in as the
first argument, which is exactly what I wanted:

     >>> class Foo: ...   def foo(self): ...     pass ... >>> with patch.object(Foo, 'foo', autospec=True) as mock_foo: ...   mock_foo.return_value = 'foo' ...   foo = Foo() ...   foo.foo() ... 'foo' >>> mock_foo.assert_called_once_with(foo)

If we don’t use ‘autospec=True’ then the unbound method is patched out
with a Mock instance instead, and isn’t called with ‘self’.


File: python.info,  Node: Checking multiple calls with mock,  Next: Coping with mutable arguments,  Prev: Mocking Unbound Methods,  Up: Further Examples

5.27.6.20 Checking multiple calls with mock
...........................................

mock has a nice API for making assertions about how your mock objects
are used.

     >>> mock = Mock() >>> mock.foo_bar.return_value = None >>> mock.foo_bar('baz', spam='eggs') >>> mock.foo_bar.assert_called_with('baz', spam='eggs')

If your mock is only being called once you can use the
‘assert_called_once_with()’ method that also asserts that the
‘call_count’ is one.

     >>> mock.foo_bar.assert_called_once_with('baz', spam='eggs') >>> mock.foo_bar() >>> mock.foo_bar.assert_called_once_with('baz', spam='eggs') Traceback (most recent call last):     ... AssertionError: Expected to be called once. Called 2 times.

Both ‘assert_called_with’ and ‘assert_called_once_with’ make assertions
about the `most recent' call.  If your mock is going to be called
several times, and you want to make assertions about `all' those calls
you can use *note call_args_list: 32d4.:

     >>> mock = Mock(return_value=None) >>> mock(1, 2, 3) >>> mock(4, 5, 6) >>> mock() >>> mock.call_args_list [call(1, 2, 3), call(4, 5, 6), call()]

The *note call: eab. helper makes it easy to make assertions about these
calls.  You can build up a list of expected calls and compare it to
‘call_args_list’.  This looks remarkably similar to the repr of the
‘call_args_list’:

     >>> expected = [call(1, 2, 3), call(4, 5, 6), call()] >>> mock.call_args_list == expected True


File: python.info,  Node: Coping with mutable arguments,  Next: Nesting Patches,  Prev: Checking multiple calls with mock,  Up: Further Examples

5.27.6.21 Coping with mutable arguments
.......................................

Another situation is rare, but can bite you, is when your mock is called
with mutable arguments.  ‘call_args’ and ‘call_args_list’ store
`references' to the arguments.  If the arguments are mutated by the code
under test then you can no longer make assertions about what the values
were when the mock was called.

Here’s some example code that shows the problem.  Imagine the following
functions defined in ‘mymodule’:

     def frob(val):     pass  def grob(val):     "First frob and then clear val"     frob(val)     val.clear()

When we try to test that ‘grob’ calls ‘frob’ with the correct argument
look what happens:

     >>> with patch('mymodule.frob') as mock_frob: ...     val = {6} ...     mymodule.grob(val) ... >>> val set() >>> mock_frob.assert_called_with({6}) Traceback (most recent call last):     ... AssertionError: Expected: (({6},), {}) Called with: ((set(),), {})

One possibility would be for mock to copy the arguments you pass in.
This could then cause problems if you do assertions that rely on object
identity for equality.

Here’s one solution that uses the ‘side_effect’ functionality.  If you
provide a ‘side_effect’ function for a mock then ‘side_effect’ will be
called with the same args as the mock.  This gives us an opportunity to
copy the arguments and store them for later assertions.  In this example
I’m using `another' mock to store the arguments so that I can use the
mock methods for doing the assertion.  Again a helper function sets this
up for me.

     >>> from copy import deepcopy >>> from unittest.mock import Mock, patch, DEFAULT >>> def copy_call_args(mock): ...     new_mock = Mock() ...     def side_effect(*args, **kwargs): ...         args = deepcopy(args) ...         kwargs = deepcopy(kwargs) ...         new_mock(*args, **kwargs) ...         return DEFAULT ...     mock.side_effect = side_effect ...     return new_mock ... >>> with patch('mymodule.frob') as mock_frob: ...     new_mock = copy_call_args(mock_frob) ...     val = {6} ...     mymodule.grob(val) ... >>> new_mock.assert_called_with({6}) >>> new_mock.call_args call({6})

‘copy_call_args’ is called with the mock that will be called.  It
returns a new mock that we do the assertion on.  The ‘side_effect’
function makes a copy of the args and calls our ‘new_mock’ with the
copy.

     Note: If your mock is only going to be used once there is an easier
     way of checking arguments at the point they are called.  You can
     simply do the checking inside a ‘side_effect’ function.

          >>> def side_effect(arg): ...     assert arg == {6} ... >>> mock = Mock(side_effect=side_effect) >>> mock({6}) >>> mock(set()) Traceback (most recent call last):     ... AssertionError

An alternative approach is to create a subclass of *note Mock: 247. or
*note MagicMock: 779. that copies (using *note copy.deepcopy(): 3c1.)
the arguments.  Here’s an example implementation:

     >>> from copy import deepcopy >>> class CopyingMock(MagicMock): ...     def __call__(self, /, *args, **kwargs): ...         args = deepcopy(args) ...         kwargs = deepcopy(kwargs) ...         return super(CopyingMock, self).__call__(*args, **kwargs) ... >>> c = CopyingMock(return_value=None) >>> arg = set() >>> c(arg) >>> arg.add(1) >>> c.assert_called_with(set()) >>> c.assert_called_with(arg) Traceback (most recent call last):     ... AssertionError: Expected call: mock({1}) Actual call: mock(set()) >>> c.foo <CopyingMock name='mock.foo' id='...'>

When you subclass ‘Mock’ or ‘MagicMock’ all dynamically created
attributes, and the ‘return_value’ will use your subclass automatically.
That means all children of a ‘CopyingMock’ will also have the type
‘CopyingMock’.


File: python.info,  Node: Nesting Patches,  Next: Mocking a dictionary with MagicMock,  Prev: Coping with mutable arguments,  Up: Further Examples

5.27.6.22 Nesting Patches
.........................

Using patch as a context manager is nice, but if you do multiple patches
you can end up with nested with statements indenting further and further
to the right:

     >>> class MyTest(unittest.TestCase): ... ...     def test_foo(self): ...         with patch('mymodule.Foo') as mock_foo: ...             with patch('mymodule.Bar') as mock_bar: ...                 with patch('mymodule.Spam') as mock_spam: ...                     assert mymodule.Foo is mock_foo ...                     assert mymodule.Bar is mock_bar ...                     assert mymodule.Spam is mock_spam ... >>> original = mymodule.Foo >>> MyTest('test_foo').test_foo() >>> assert mymodule.Foo is original

With unittest ‘cleanup’ functions and the *note patch methods; start and
stop: 32f1. we can achieve the same effect without the nested
indentation.  A simple helper method, ‘create_patch’, puts the patch in
place and returns the created mock for us:

     >>> class MyTest(unittest.TestCase): ... ...     def create_patch(self, name): ...         patcher = patch(name) ...         thing = patcher.start() ...         self.addCleanup(patcher.stop) ...         return thing ... ...     def test_foo(self): ...         mock_foo = self.create_patch('mymodule.Foo') ...         mock_bar = self.create_patch('mymodule.Bar') ...         mock_spam = self.create_patch('mymodule.Spam') ... ...         assert mymodule.Foo is mock_foo ...         assert mymodule.Bar is mock_bar ...         assert mymodule.Spam is mock_spam ... >>> original = mymodule.Foo >>> MyTest('test_foo').run() >>> assert mymodule.Foo is original


File: python.info,  Node: Mocking a dictionary with MagicMock,  Next: Mock subclasses and their attributes,  Prev: Nesting Patches,  Up: Further Examples

5.27.6.23 Mocking a dictionary with MagicMock
.............................................

You may want to mock a dictionary, or other container object, recording
all access to it whilst having it still behave like a dictionary.

We can do this with *note MagicMock: 779, which will behave like a
dictionary, and using *note side_effect: 32c3. to delegate dictionary
access to a real underlying dictionary that is under our control.

When the *note __getitem__(): 27a. and *note __setitem__(): c55. methods
of our ‘MagicMock’ are called (normal dictionary access) then
‘side_effect’ is called with the key (and in the case of ‘__setitem__’
the value too).  We can also control what is returned.

After the ‘MagicMock’ has been used we can use attributes like *note
call_args_list: 32d4. to assert about how the dictionary was used:

     >>> my_dict = {'a': 1, 'b': 2, 'c': 3} >>> def getitem(name): ...      return my_dict[name] ... >>> def setitem(name, val): ...     my_dict[name] = val ... >>> mock = MagicMock() >>> mock.__getitem__.side_effect = getitem >>> mock.__setitem__.side_effect = setitem

     Note: An alternative to using ‘MagicMock’ is to use ‘Mock’ and
     `only' provide the magic methods you specifically want:

          >>> mock = Mock() >>> mock.__getitem__ = Mock(side_effect=getitem) >>> mock.__setitem__ = Mock(side_effect=setitem)

     A `third' option is to use ‘MagicMock’ but passing in ‘dict’ as the
     `spec' (or `spec_set') argument so that the ‘MagicMock’ created
     only has dictionary magic methods available:

          >>> mock = MagicMock(spec_set=dict) >>> mock.__getitem__.side_effect = getitem >>> mock.__setitem__.side_effect = setitem

With these side effect functions in place, the ‘mock’ will behave like a
normal dictionary but recording the access.  It even raises a *note
KeyError: 2c5. if you try to access a key that doesn’t exist.

     >>> mock['a'] 1 >>> mock['c'] 3 >>> mock['d'] Traceback (most recent call last):     ... KeyError: 'd' >>> mock['b'] = 'fish' >>> mock['d'] = 'eggs' >>> mock['b'] 'fish' >>> mock['d'] 'eggs'

After it has been used you can make assertions about the access using
the normal mock methods and attributes:

     >>> mock.__getitem__.call_args_list [call('a'), call('c'), call('d'), call('b'), call('d')] >>> mock.__setitem__.call_args_list [call('b', 'fish'), call('d', 'eggs')] >>> my_dict {'a': 1, 'b': 'fish', 'c': 3, 'd': 'eggs'}


File: python.info,  Node: Mock subclasses and their attributes,  Next: Mocking imports with patch dict,  Prev: Mocking a dictionary with MagicMock,  Up: Further Examples

5.27.6.24 Mock subclasses and their attributes
..............................................

There are various reasons why you might want to subclass *note Mock:
247.  One reason might be to add helper methods.  Here’s a silly
example:

     >>> class MyMock(MagicMock): ...     def has_been_called(self): ...         return self.called ... >>> mymock = MyMock(return_value=None) >>> mymock <MyMock id='...'> >>> mymock.has_been_called() False >>> mymock() >>> mymock.has_been_called() True

The standard behaviour for ‘Mock’ instances is that attributes and the
return value mocks are of the same type as the mock they are accessed
on.  This ensures that ‘Mock’ attributes are ‘Mocks’ and ‘MagicMock’
attributes are ‘MagicMocks’ (1).  So if you’re subclassing to add helper
methods then they’ll also be available on the attributes and return
value mock of instances of your subclass.

     >>> mymock.foo <MyMock name='mock.foo' id='...'> >>> mymock.foo.has_been_called() False >>> mymock.foo() <MyMock name='mock.foo()' id='...'> >>> mymock.foo.has_been_called() True

Sometimes this is inconvenient.  For example, one user(2) is subclassing
mock to created a Twisted adaptor(3).  Having this applied to attributes
too actually causes errors.

‘Mock’ (in all its flavours) uses a method called ‘_get_child_mock’ to
create these “sub-mocks” for attributes and return values.  You can
prevent your subclass being used for attributes by overriding this
method.  The signature is that it takes arbitrary keyword arguments
(‘**kwargs’) which are then passed onto the mock constructor:

     >>> class Subclass(MagicMock): ...     def _get_child_mock(self, /, **kwargs): ...         return MagicMock(**kwargs) ... >>> mymock = Subclass() >>> mymock.foo <MagicMock name='mock.foo' id='...'> >>> assert isinstance(mymock, Subclass) >>> assert not isinstance(mymock.foo, Subclass) >>> assert not isinstance(mymock(), Subclass)

   ---------- Footnotes ----------

   (1) (2) An exception to this rule are the non-callable mocks.
Attributes use the callable variant because otherwise non-callable mocks
couldn’t have callable methods.

   (2) https://code.google.com/archive/p/mock/issues/105

   (3) 
https://twistedmatrix.com/documents/11.0.0/api/twisted.python.components.html


File: python.info,  Node: Mocking imports with patch dict,  Next: Tracking order of calls and less verbose call assertions,  Prev: Mock subclasses and their attributes,  Up: Further Examples

5.27.6.25 Mocking imports with patch.dict
.........................................

One situation where mocking can be hard is where you have a local import
inside a function.  These are harder to mock because they aren’t using
an object from the module namespace that we can patch out.

Generally local imports are to be avoided.  They are sometimes done to
prevent circular dependencies, for which there is `usually' a much
better way to solve the problem (refactor the code) or to prevent “up
front costs” by delaying the import.  This can also be solved in better
ways than an unconditional local import (store the module as a class or
module attribute and only do the import on first use).

That aside there is a way to use ‘mock’ to affect the results of an
import.  Importing fetches an `object' from the *note sys.modules: 13eb.
dictionary.  Note that it fetches an `object', which need not be a
module.  Importing a module for the first time results in a module
object being put in ‘sys.modules’, so usually when you import something
you get a module back.  This need not be the case however.

This means you can use *note patch.dict(): f01. to `temporarily' put a
mock in place in *note sys.modules: 13eb.  Any imports whilst this patch
is active will fetch the mock.  When the patch is complete (the
decorated function exits, the with statement body is complete or
‘patcher.stop()’ is called) then whatever was there previously will be
restored safely.

Here’s an example that mocks out the ‘fooble’ module.

     >>> import sys >>> mock = Mock() >>> with patch.dict('sys.modules', {'fooble': mock}): ...    import fooble ...    fooble.blob() ... <Mock name='mock.blob()' id='...'> >>> assert 'fooble' not in sys.modules >>> mock.blob.assert_called_once_with()

As you can see the ‘import fooble’ succeeds, but on exit there is no
‘fooble’ left in *note sys.modules: 13eb.

This also works for the ‘from module import name’ form:

     >>> mock = Mock() >>> with patch.dict('sys.modules', {'fooble': mock}): ...    from fooble import blob ...    blob.blip() ... <Mock name='mock.blob.blip()' id='...'> >>> mock.blob.blip.assert_called_once_with()

With slightly more work you can also mock package imports:

     >>> mock = Mock() >>> modules = {'package': mock, 'package.module': mock.module} >>> with patch.dict('sys.modules', modules): ...    from package.module import fooble ...    fooble() ... <Mock name='mock.module.fooble()' id='...'> >>> mock.module.fooble.assert_called_once_with()


File: python.info,  Node: Tracking order of calls and less verbose call assertions,  Next: More complex argument matching,  Prev: Mocking imports with patch dict,  Up: Further Examples

5.27.6.26 Tracking order of calls and less verbose call assertions
..................................................................

The *note Mock: 247. class allows you to track the `order' of method
calls on your mock objects through the *note method_calls: 32cd.
attribute.  This doesn’t allow you to track the order of calls between
separate mock objects, however we can use *note mock_calls: 32ca. to
achieve the same effect.

Because mocks track calls to child mocks in ‘mock_calls’, and accessing
an arbitrary attribute of a mock creates a child mock, we can create our
separate mocks from a parent one.  Calls to those child mock will then
all be recorded, in order, in the ‘mock_calls’ of the parent:

     >>> manager = Mock() >>> mock_foo = manager.foo >>> mock_bar = manager.bar

     >>> mock_foo.something() <Mock name='mock.foo.something()' id='...'> >>> mock_bar.other.thing() <Mock name='mock.bar.other.thing()' id='...'>

     >>> manager.mock_calls [call.foo.something(), call.bar.other.thing()]

We can then assert about the calls, including the order, by comparing
with the ‘mock_calls’ attribute on the manager mock:

     >>> expected_calls = [call.foo.something(), call.bar.other.thing()] >>> manager.mock_calls == expected_calls True

If ‘patch’ is creating, and putting in place, your mocks then you can
attach them to a manager mock using the *note attach_mock(): 32cc.
method.  After attaching calls will be recorded in ‘mock_calls’ of the
manager.

     >>> manager = MagicMock() >>> with patch('mymodule.Class1') as MockClass1: ...     with patch('mymodule.Class2') as MockClass2: ...         manager.attach_mock(MockClass1, 'MockClass1') ...         manager.attach_mock(MockClass2, 'MockClass2') ...         MockClass1().foo() ...         MockClass2().bar() <MagicMock name='mock.MockClass1().foo()' id='...'> <MagicMock name='mock.MockClass2().bar()' id='...'> >>> manager.mock_calls [call.MockClass1(), call.MockClass1().foo(), call.MockClass2(), call.MockClass2().bar()]

If many calls have been made, but you’re only interested in a particular
sequence of them then an alternative is to use the *note
assert_has_calls(): 32c9. method.  This takes a list of calls
(constructed with the *note call: eab. object).  If that sequence of
calls are in *note mock_calls: 32ca. then the assert succeeds.

     >>> m = MagicMock() >>> m().foo().bar().baz() <MagicMock name='mock().foo().bar().baz()' id='...'> >>> m.one().two().three() <MagicMock name='mock.one().two().three()' id='...'> >>> calls = call.one().two().three().call_list() >>> m.assert_has_calls(calls)

Even though the chained call ‘m.one().two().three()’ aren’t the only
calls that have been made to the mock, the assert still succeeds.

Sometimes a mock may have several calls made to it, and you are only
interested in asserting about `some' of those calls.  You may not even
care about the order.  In this case you can pass ‘any_order=True’ to
‘assert_has_calls’:

     >>> m = MagicMock() >>> m(1), m.two(2, 3), m.seven(7), m.fifty('50') (...) >>> calls = [call.fifty('50'), call(1), call.seven(7)] >>> m.assert_has_calls(calls, any_order=True)


File: python.info,  Node: More complex argument matching,  Prev: Tracking order of calls and less verbose call assertions,  Up: Further Examples

5.27.6.27 More complex argument matching
........................................

Using the same basic concept as *note ANY: 3302. we can implement
matchers to do more complex assertions on objects used as arguments to
mocks.

Suppose we expect some object to be passed to a mock that by default
compares equal based on object identity (which is the Python default for
user defined classes).  To use *note assert_called_with(): f33. we would
need to pass in the exact same object.  If we are only interested in
some of the attributes of this object then we can create a matcher that
will check these attributes for us.

You can see in this example how a ‘standard’ call to
‘assert_called_with’ isn’t sufficient:

     >>> class Foo: ...     def __init__(self, a, b): ...         self.a, self.b = a, b ... >>> mock = Mock(return_value=None) >>> mock(Foo(1, 2)) >>> mock.assert_called_with(Foo(1, 2)) Traceback (most recent call last):     ... AssertionError: Expected: call(<__main__.Foo object at 0x...>) Actual call: call(<__main__.Foo object at 0x...>)

A comparison function for our ‘Foo’ class might look something like
this:

     >>> def compare(self, other): ...     if not type(self) == type(other): ...         return False ...     if self.a != other.a: ...         return False ...     if self.b != other.b: ...         return False ...     return True ...

And a matcher object that can use comparison functions like this for its
equality operation would look something like this:

     >>> class Matcher: ...     def __init__(self, compare, some_obj): ...         self.compare = compare ...         self.some_obj = some_obj ...     def __eq__(self, other): ...         return self.compare(self.some_obj, other) ...

Putting all this together:

     >>> match_foo = Matcher(compare, Foo(1, 2)) >>> mock.assert_called_with(match_foo)

The ‘Matcher’ is instantiated with our compare function and the ‘Foo’
object we want to compare against.  In ‘assert_called_with’ the
‘Matcher’ equality method will be called, which compares the object the
mock was called with against the one we created our matcher with.  If
they match then ‘assert_called_with’ passes, and if they don’t an *note
AssertionError: f66. is raised:

     >>> match_wrong = Matcher(compare, Foo(3, 4)) >>> mock.assert_called_with(match_wrong) Traceback (most recent call last):     ... AssertionError: Expected: ((<Matcher object at 0x...>,), {}) Called with: ((<Foo object at 0x...>,), {})

With a bit of tweaking you could have the comparison function raise the
*note AssertionError: f66. directly and provide a more useful failure
message.

As of version 1.5, the Python testing library PyHamcrest(1) provides
similar functionality, that may be useful here, in the form of its
equality matcher (hamcrest.library.integration.match_equality(2)).

   ---------- Footnotes ----------

   (1) https://pyhamcrest.readthedocs.io/

   (2) 
https://pyhamcrest.readthedocs.io/en/release-1.8/integration/#module-hamcrest.library.integration.match_equality


File: python.info,  Node: 2to3 - Automated Python 2 to 3 code translation,  Next: test — Regression tests package for Python,  Prev: unittest mock — getting started,  Up: Development Tools

5.27.7 2to3 - Automated Python 2 to 3 code translation
------------------------------------------------------

2to3 is a Python program that reads Python 2.x source code and applies a
series of `fixers' to transform it into valid Python 3.x code.  The
standard library contains a rich set of fixers that will handle almost
all code.  2to3 supporting library *note lib2to3: a7. is, however, a
flexible and generic library, so it is possible to write your own fixers
for 2to3.  *note lib2to3: a7. could also be adapted to custom
applications in which Python code needs to be edited automatically.

* Menu:

* Using 2to3::
* Fixers::
* lib2to3 - 2to3’s library::


File: python.info,  Node: Using 2to3,  Next: Fixers,  Up: 2to3 - Automated Python 2 to 3 code translation

5.27.7.1 Using 2to3
...................

2to3 will usually be installed with the Python interpreter as a script.
It is also located in the ‘Tools/scripts’ directory of the Python root.

2to3’s basic arguments are a list of files or directories to transform.
The directories are recursively traversed for Python sources.

Here is a sample Python 2.x source file, ‘example.py’:

     def greet(name):     print "Hello, {0}!".format(name) print "What's your name?" name = raw_input() greet(name)

It can be converted to Python 3.x code via 2to3 on the command line:

     $ 2to3 example.py

A diff against the original source file is printed.  2to3 can also write
the needed modifications right back to the source file.  (A backup of
the original file is made unless ‘-n’ is also given.)  Writing the
changes back is enabled with the ‘-w’ flag:

     $ 2to3 -w example.py

After transformation, ‘example.py’ looks like this:

     def greet(name):     print("Hello, {0}!".format(name)) print("What's your name?") name = input() greet(name)

Comments and exact indentation are preserved throughout the translation
process.

By default, 2to3 runs a set of *note predefined fixers: 332a.  The ‘-l’
flag lists all available fixers.  An explicit set of fixers to run can
be given with ‘-f’.  Likewise the ‘-x’ explicitly disables a fixer.  The
following example runs only the ‘imports’ and ‘has_key’ fixers:

     $ 2to3 -f imports -f has_key example.py

This command runs every fixer except the ‘apply’ fixer:

     $ 2to3 -x apply example.py

Some fixers are `explicit', meaning they aren’t run by default and must
be listed on the command line to be run.  Here, in addition to the
default fixers, the ‘idioms’ fixer is run:

     $ 2to3 -f all -f idioms example.py

Notice how passing ‘all’ enables all default fixers.

Sometimes 2to3 will find a place in your source code that needs to be
changed, but 2to3 cannot fix automatically.  In this case, 2to3 will
print a warning beneath the diff for a file.  You should address the
warning in order to have compliant 3.x code.

2to3 can also refactor doctests.  To enable this mode, use the ‘-d’
flag.  Note that `only' doctests will be refactored.  This also doesn’t
require the module to be valid Python.  For example, doctest like
examples in a reST document could also be refactored with this option.

The ‘-v’ option enables output of more information on the translation
process.

Since some print statements can be parsed as function calls or
statements, 2to3 cannot always read files containing the print function.
When 2to3 detects the presence of the ‘from __future__ import
print_function’ compiler directive, it modifies its internal grammar to
interpret *note print(): 87a. as a function.  This change can also be
enabled manually with the ‘-p’ flag.  Use ‘-p’ to run fixers on code
that already has had its print statements converted.

The ‘-o’ or ‘--output-dir’ option allows specification of an alternate
directory for processed output files to be written to.  The ‘-n’ flag is
required when using this as backup files do not make sense when not
overwriting the input files.

New in version 3.2.3: The ‘-o’ option was added.

The ‘-W’ or ‘--write-unchanged-files’ flag tells 2to3 to always write
output files even if no changes were required to the file.  This is most
useful with ‘-o’ so that an entire Python source tree is copied with
translation from one directory to another.  This option implies the ‘-w’
flag as it would not make sense otherwise.

New in version 3.2.3: The ‘-W’ flag was added.

The ‘--add-suffix’ option specifies a string to append to all output
filenames.  The ‘-n’ flag is required when specifying this as backups
are not necessary when writing to different filenames.  Example:

     $ 2to3 -n -W --add-suffix=3 example.py

Will cause a converted file named ‘example.py3’ to be written.

New in version 3.2.3: The ‘--add-suffix’ option was added.

To translate an entire project from one directory tree to another use:

     $ 2to3 --output-dir=python3-version/mycode -W -n python2-version/mycode


File: python.info,  Node: Fixers,  Next: lib2to3 - 2to3’s library,  Prev: Using 2to3,  Up: 2to3 - Automated Python 2 to 3 code translation

5.27.7.2 Fixers
...............

Each step of transforming code is encapsulated in a fixer.  The command
‘2to3 -l’ lists them.  As *note documented above: 3328, each can be
turned on and off individually.  They are described here in more detail.

 -- 2to3fixer: apply

     Removes usage of ‘apply()’.  For example ‘apply(function, *args,
     **kwargs)’ is converted to ‘function(*args, **kwargs)’.

 -- 2to3fixer: asserts

     Replaces deprecated *note unittest: 11b. method names with the
     correct ones.

     From                                 To
                                          
     ------------------------------------------------------------------------------------
                                          
     ‘failUnlessEqual(a, b)’              *note assertEqual(a, b): ba8.
                                          
                                          
     ‘assertEquals(a, b)’                 *note assertEqual(a, b): ba8.
                                          
                                          
     ‘failIfEqual(a, b)’                  *note assertNotEqual(a, b): ba9.
                                          
                                          
     ‘assertNotEquals(a, b)’              *note assertNotEqual(a, b): ba9.
                                          
                                          
     ‘failUnless(a)’                      *note assertTrue(a): ba7.
                                          
                                          
     ‘assert_(a)’                         *note assertTrue(a): ba7.
                                          
                                          
     ‘failIf(a)’                          *note assertFalse(a): cba.
                                          
                                          
     ‘failUnlessRaises(exc, cal)’         *note assertRaises(exc, cal): aaf.
                                          
                                          
     ‘failUnlessAlmostEqual(a, b)’        *note assertAlmostEqual(a, b): baa.
                                          
                                          
     ‘assertAlmostEquals(a, b)’           *note assertAlmostEqual(a, b): baa.
                                          
                                          
     ‘failIfAlmostEqual(a, b)’            *note assertNotAlmostEqual(a, b): bab.
                                          
                                          
     ‘assertNotAlmostEquals(a, b)’        *note assertNotAlmostEqual(a, b): bab.
                                          

 -- 2to3fixer: basestring

     Converts ‘basestring’ to *note str: 325.

 -- 2to3fixer: buffer

     Converts ‘buffer’ to *note memoryview: 25a.  This fixer is optional
     because the *note memoryview: 25a. API is similar but not exactly
     the same as that of ‘buffer’.

 -- 2to3fixer: dict

     Fixes dictionary iteration methods.  ‘dict.iteritems()’ is
     converted to *note dict.items(): c1e, ‘dict.iterkeys()’ to *note
     dict.keys(): c1d, and ‘dict.itervalues()’ to *note dict.values():
     c1f.  Similarly, ‘dict.viewitems()’, ‘dict.viewkeys()’ and
     ‘dict.viewvalues()’ are converted respectively to *note
     dict.items(): c1e, *note dict.keys(): c1d. and *note dict.values():
     c1f.  It also wraps existing usages of *note dict.items(): c1e,
     *note dict.keys(): c1d, and *note dict.values(): c1f. in a call to
     *note list: 260.

 -- 2to3fixer: except

     Converts ‘except X, T’ to ‘except X as T’.

 -- 2to3fixer: exec

     Converts the ‘exec’ statement to the *note exec(): c37. function.

 -- 2to3fixer: execfile

     Removes usage of ‘execfile()’.  The argument to ‘execfile()’ is
     wrapped in calls to *note open(): 4e5, *note compile(): 1b2, and
     *note exec(): c37.

 -- 2to3fixer: exitfunc

     Changes assignment of ‘sys.exitfunc’ to use of the *note atexit: c.
     module.

 -- 2to3fixer: filter

     Wraps *note filter(): c21. usage in a *note list: 260. call.

 -- 2to3fixer: funcattrs

     Fixes function attributes that have been renamed.  For example,
     ‘my_function.func_closure’ is converted to
     ‘my_function.__closure__’.

 -- 2to3fixer: future

     Removes ‘from __future__ import new_feature’ statements.

 -- 2to3fixer: getcwdu

     Renames ‘os.getcwdu()’ to *note os.getcwd(): f11.

 -- 2to3fixer: has_key

     Changes ‘dict.has_key(key)’ to ‘key in dict’.

 -- 2to3fixer: idioms

     This optional fixer performs several transformations that make
     Python code more idiomatic.  Type comparisons like ‘type(x) is
     SomeClass’ and ‘type(x) == SomeClass’ are converted to
     ‘isinstance(x, SomeClass)’.  ‘while 1’ becomes ‘while True’.  This
     fixer also tries to make use of *note sorted(): 439. in appropriate
     places.  For example, this block

          L = list(some_iterable) L.sort()

     is changed to

          L = sorted(some_iterable)

 -- 2to3fixer: import

     Detects sibling imports and converts them to relative imports.

 -- 2to3fixer: imports

     Handles module renames in the standard library.

 -- 2to3fixer: imports2

     Handles other modules renames in the standard library.  It is
     separate from the *note imports: 333b. fixer only because of
     technical limitations.

 -- 2to3fixer: input

     Converts ‘input(prompt)’ to ‘eval(input(prompt))’.

 -- 2to3fixer: intern

     Converts ‘intern()’ to *note sys.intern(): c61.

 -- 2to3fixer: isinstance

     Fixes duplicate types in the second argument of *note isinstance():
     444.  For example, ‘isinstance(x, (int, int))’ is converted to
     ‘isinstance(x, int)’ and ‘isinstance(x, (int, float, int))’ is
     converted to ‘isinstance(x, (int, float))’.

 -- 2to3fixer: itertools_imports

     Removes imports of ‘itertools.ifilter()’, ‘itertools.izip()’, and
     ‘itertools.imap()’.  Imports of ‘itertools.ifilterfalse()’ are also
     changed to *note itertools.filterfalse(): 1527.

 -- 2to3fixer: itertools

     Changes usage of ‘itertools.ifilter()’, ‘itertools.izip()’, and
     ‘itertools.imap()’ to their built-in equivalents.
     ‘itertools.ifilterfalse()’ is changed to *note
     itertools.filterfalse(): 1527.

 -- 2to3fixer: long

     Renames ‘long’ to *note int: 184.

 -- 2to3fixer: map

     Wraps *note map(): c20. in a *note list: 260. call.  It also
     changes ‘map(None, x)’ to ‘list(x)’.  Using ‘from future_builtins
     import map’ disables this fixer.

 -- 2to3fixer: metaclass

     Converts the old metaclass syntax (‘__metaclass__ = Meta’ in the
     class body) to the new (‘class X(metaclass=Meta)’).

 -- 2to3fixer: methodattrs

     Fixes old method attribute names.  For example, ‘meth.im_func’ is
     converted to ‘meth.__func__’.

 -- 2to3fixer: ne

     Converts the old not-equal syntax, ‘<>’, to ‘!=’.

 -- 2to3fixer: next

     Converts the use of iterator’s ‘next()’ methods to the *note
     next(): 676. function.  It also renames *note next(): 676. methods
     to *note __next__(): c57.

 -- 2to3fixer: nonzero

     Renames ‘__nonzero__()’ to *note __bool__(): c5b.

 -- 2to3fixer: numliterals

     Converts octal literals into the new syntax.

 -- 2to3fixer: operator

     Converts calls to various functions in the *note operator: c2.
     module to other, but equivalent, function calls.  When needed, the
     appropriate ‘import’ statements are added, e.g.  ‘import
     collections.abc’.  The following mapping are made:

     From                                   To
                                            
     -----------------------------------------------------------------------------------------
                                            
     ‘operator.isCallable(obj)’             ‘callable(obj)’
                                            
                                            
     ‘operator.sequenceIncludes(obj)’       ‘operator.contains(obj)’
                                            
                                            
     ‘operator.isSequenceType(obj)’         ‘isinstance(obj, collections.abc.Sequence)’
                                            
                                            
     ‘operator.isMappingType(obj)’          ‘isinstance(obj, collections.abc.Mapping)’
                                            
                                            
     ‘operator.isNumberType(obj)’           ‘isinstance(obj, numbers.Number)’
                                            
                                            
     ‘operator.repeat(obj, n)’              ‘operator.mul(obj, n)’
                                            
                                            
     ‘operator.irepeat(obj, n)’             ‘operator.imul(obj, n)’
                                            

 -- 2to3fixer: paren

     Add extra parenthesis where they are required in list
     comprehensions.  For example, ‘[x for x in 1, 2]’ becomes ‘[x for x
     in (1, 2)]’.

 -- 2to3fixer: print

     Converts the ‘print’ statement to the *note print(): 87a. function.

 -- 2to3fixer: raise

     Converts ‘raise E, V’ to ‘raise E(V)’, and ‘raise E, V, T’ to
     ‘raise E(V).with_traceback(T)’.  If ‘E’ is a tuple, the translation
     will be incorrect because substituting tuples for exceptions has
     been removed in 3.0.

 -- 2to3fixer: raw_input

     Converts ‘raw_input()’ to *note input(): c5e.

 -- 2to3fixer: reduce

     Handles the move of ‘reduce()’ to *note functools.reduce(): c62.

 -- 2to3fixer: reload

     Converts ‘reload()’ to *note importlib.reload(): 38e.

 -- 2to3fixer: renames

     Changes ‘sys.maxint’ to *note sys.maxsize: b36.

 -- 2to3fixer: repr

     Replaces backtick repr with the *note repr(): 7c0. function.

 -- 2to3fixer: set_literal

     Replaces use of the *note set: b62. constructor with set literals.
     This fixer is optional.

 -- 2to3fixer: standarderror

     Renames ‘StandardError’ to *note Exception: 1a8.

 -- 2to3fixer: sys_exc

     Changes the deprecated ‘sys.exc_value’, ‘sys.exc_type’,
     ‘sys.exc_traceback’ to use *note sys.exc_info(): c52.

 -- 2to3fixer: throw

     Fixes the API change in generator’s ‘throw()’ method.

 -- 2to3fixer: tuple_params

     Removes implicit tuple parameter unpacking.  This fixer inserts
     temporary variables.

 -- 2to3fixer: types

     Fixes code broken from the removal of some members in the *note
     types: 118. module.

 -- 2to3fixer: unicode

     Renames ‘unicode’ to *note str: 325.

 -- 2to3fixer: urllib

     Handles the rename of *note urllib: 11d. and ‘urllib2’ to the *note
     urllib: 11d. package.

 -- 2to3fixer: ws_comma

     Removes excess whitespace from comma separated items.  This fixer
     is optional.

 -- 2to3fixer: xrange

     Renames ‘xrange()’ to *note range(): 9b2. and wraps existing *note
     range(): 9b2. calls with *note list: 260.

 -- 2to3fixer: xreadlines

     Changes ‘for x in file.xreadlines()’ to ‘for x in file’.

 -- 2to3fixer: zip

     Wraps *note zip(): c25. usage in a *note list: 260. call.  This is
     disabled when ‘from future_builtins import zip’ appears.


File: python.info,  Node: lib2to3 - 2to3’s library,  Prev: Fixers,  Up: 2to3 - Automated Python 2 to 3 code translation

5.27.7.3 ‘lib2to3’ - 2to3’s library
...................................

`Source code:' Lib/lib2to3/(1)

__________________________________________________________________

     Note: The *note lib2to3: a7. API should be considered unstable and
     may change drastically in the future.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/lib2to3/


File: python.info,  Node: test — Regression tests package for Python,  Next: test support — Utilities for the Python test suite,  Prev: 2to3 - Automated Python 2 to 3 code translation,  Up: Development Tools

5.27.8 ‘test’ — Regression tests package for Python
---------------------------------------------------

     Note: The *note test: 105. package is meant for internal use by
     Python only.  It is documented for the benefit of the core
     developers of Python.  Any use of this package outside of Python’s
     standard library is discouraged as code mentioned here can change
     or be removed without notice between releases of Python.

__________________________________________________________________

The *note test: 105. package contains all regression tests for Python as
well as the modules *note test.support: 106. and ‘test.regrtest’.  *note
test.support: 106. is used to enhance your tests while ‘test.regrtest’
drives the testing suite.

Each module in the *note test: 105. package whose name starts with
‘test_’ is a testing suite for a specific module or feature.  All new
tests should be written using the *note unittest: 11b. or *note doctest:
67. module.  Some older tests are written using a “traditional” testing
style that compares output printed to ‘sys.stdout’; this style of test
is considered deprecated.

See also
........

Module *note unittest: 11b.

     Writing PyUnit regression tests.

Module *note doctest: 67.

     Tests embedded in documentation strings.

* Menu:

* Writing Unit Tests for the test package::
* Running tests using the command-line interface::


File: python.info,  Node: Writing Unit Tests for the test package,  Next: Running tests using the command-line interface,  Up: test — Regression tests package for Python

5.27.8.1 Writing Unit Tests for the ‘test’ package
..................................................

It is preferred that tests that use the *note unittest: 11b. module
follow a few guidelines.  One is to name the test module by starting it
with ‘test_’ and end it with the name of the module being tested.  The
test methods in the test module should start with ‘test_’ and end with a
description of what the method is testing.  This is needed so that the
methods are recognized by the test driver as test methods.  Also, no
documentation string for the method should be included.  A comment (such
as ‘# Tests function returns only True or False’) should be used to
provide documentation for test methods.  This is done because
documentation strings get printed out if they exist and thus what test
is being run is not stated.

A basic boilerplate is often used:

     import unittest from test import support  class MyTestCase1(unittest.TestCase):      # Only use setUp() and tearDown() if necessary      def setUp(self):         ... code to execute in preparation for tests ...      def tearDown(self):         ... code to execute to clean up after tests ...      def test_feature_one(self):         # Test feature one.         ... testing code ...      def test_feature_two(self):         # Test feature two.         ... testing code ...      ... more test methods ...  class MyTestCase2(unittest.TestCase):     ... same structure as MyTestCase1 ...  ... more test classes ...  if __name__ == '__main__':     unittest.main()

This code pattern allows the testing suite to be run by ‘test.regrtest’,
on its own as a script that supports the *note unittest: 11b. CLI, or
via the ‘python -m unittest’ CLI.

The goal for regression testing is to try to break code.  This leads to
a few guidelines to be followed:

   * The testing suite should exercise all classes, functions, and
     constants.  This includes not just the external API that is to be
     presented to the outside world but also “private” code.

   * Whitebox testing (examining the code being tested when the tests
     are being written) is preferred.  Blackbox testing (testing only
     the published user interface) is not complete enough to make sure
     all boundary and edge cases are tested.

   * Make sure all possible values are tested including invalid ones.
     This makes sure that not only all valid values are acceptable but
     also that improper values are handled correctly.

   * Exhaust as many code paths as possible.  Test where branching
     occurs and thus tailor input to make sure as many different paths
     through the code are taken.

   * Add an explicit test for any bugs discovered for the tested code.
     This will make sure that the error does not crop up again if the
     code is changed in the future.

   * Make sure to clean up after your tests (such as close and remove
     all temporary files).

   * If a test is dependent on a specific condition of the operating
     system then verify the condition already exists before attempting
     the test.

   * Import as few modules as possible and do it as soon as possible.
     This minimizes external dependencies of tests and also minimizes
     possible anomalous behavior from side-effects of importing a
     module.

   * Try to maximize code reuse.  On occasion, tests will vary by
     something as small as what type of input is used.  Minimize code
     duplication by subclassing a basic test class with a class that
     specifies the input:

          class TestFuncAcceptsSequencesMixin:      func = mySuperWhammyFunction      def test_func(self):         self.func(self.arg)  class AcceptLists(TestFuncAcceptsSequencesMixin, unittest.TestCase):     arg = [1, 2, 3]  class AcceptStrings(TestFuncAcceptsSequencesMixin, unittest.TestCase):     arg = 'abc'  class AcceptTuples(TestFuncAcceptsSequencesMixin, unittest.TestCase):     arg = (1, 2, 3)

     When using this pattern, remember that all classes that inherit
     from *note unittest.TestCase: 8f3. are run as tests.  The ‘Mixin’
     class in the example above does not have any data and so can’t be
     run by itself, thus it does not inherit from *note
     unittest.TestCase: 8f3.

See also
........

Test Driven Development

     A book by Kent Beck on writing tests before code.


File: python.info,  Node: Running tests using the command-line interface,  Prev: Writing Unit Tests for the test package,  Up: test — Regression tests package for Python

5.27.8.2 Running tests using the command-line interface
.......................................................

The *note test: 105. package can be run as a script to drive Python’s
regression test suite, thanks to the *note -m: 32c. option: ‘python -m
test’.  Under the hood, it uses ‘test.regrtest’; the call ‘python -m
test.regrtest’ used in previous Python versions still works.  Running
the script by itself automatically starts running all regression tests
in the *note test: 105. package.  It does this by finding all modules in
the package whose name starts with ‘test_’, importing them, and
executing the function ‘test_main()’ if present or loading the tests via
unittest.TestLoader.loadTestsFromModule if ‘test_main’ does not exist.
The names of tests to execute may also be passed to the script.
Specifying a single regression test (‘python -m test test_spam’) will
minimize output and only print whether the test passed or failed.

Running *note test: 105. directly allows what resources are available
for tests to use to be set.  You do this by using the ‘-u’ command-line
option.  Specifying ‘all’ as the value for the ‘-u’ option enables all
possible resources: ‘python -m test -uall’.  If all but one resource is
desired (a more common case), a comma-separated list of resources that
are not desired may be listed after ‘all’.  The command ‘python -m test
-uall,-audio,-largefile’ will run *note test: 105. with all resources
except the ‘audio’ and ‘largefile’ resources.  For a list of all
resources and more command-line options, run ‘python -m test -h’.

Some other ways to execute the regression tests depend on what platform
the tests are being executed on.  On Unix, you can run ‘make test’ at
the top-level directory where Python was built.  On Windows, executing
‘rt.bat’ from your ‘PCbuild’ directory will run all regression tests.


File: python.info,  Node: test support — Utilities for the Python test suite,  Next: test support script_helper — Utilities for the Python execution tests,  Prev: test — Regression tests package for Python,  Up: Development Tools

5.27.9 ‘test.support’ — Utilities for the Python test suite
-----------------------------------------------------------

The *note test.support: 106. module provides support for Python’s
regression test suite.

     Note: *note test.support: 106. is not a public module.  It is
     documented here to help Python developers write tests.  The API of
     this module is subject to change without backwards compatibility
     concerns between releases.

This module defines the following exceptions:

 -- Exception: test.support.TestFailed

     Exception to be raised when a test fails.  This is deprecated in
     favor of *note unittest: 11b.-based tests and *note
     unittest.TestCase: 8f3.’s assertion methods.

 -- Exception: test.support.ResourceDenied

     Subclass of *note unittest.SkipTest: 8f7.  Raised when a resource
     (such as a network connection) is not available.  Raised by the
     *note requires(): 3367. function.

The *note test.support: 106. module defines the following constants:

 -- Data: test.support.verbose

     ‘True’ when verbose output is enabled.  Should be checked when more
     detailed information is desired about a running test.  `verbose' is
     set by ‘test.regrtest’.

 -- Data: test.support.is_jython

     ‘True’ if the running interpreter is Jython.

 -- Data: test.support.is_android

     ‘True’ if the system is Android.

 -- Data: test.support.unix_shell

     Path for shell if not on Windows; otherwise ‘None’.

 -- Data: test.support.FS_NONASCII

     A non-ASCII character encodable by *note os.fsencode(): 4e4.

 -- Data: test.support.TESTFN

     Set to a name that is safe to use as the name of a temporary file.
     Any temporary file that is created should be closed and unlinked
     (removed).

 -- Data: test.support.TESTFN_UNICODE

     Set to a non-ASCII name for a temporary file.

 -- Data: test.support.TESTFN_ENCODING

     Set to *note sys.getfilesystemencoding(): 4eb.

 -- Data: test.support.TESTFN_UNENCODABLE

     Set to a filename (str type) that should not be able to be encoded
     by file system encoding in strict mode.  It may be ‘None’ if it’s
     not possible to generate such a filename.

 -- Data: test.support.TESTFN_UNDECODABLE

     Set to a filename (bytes type) that should not be able to be
     decoded by file system encoding in strict mode.  It may be ‘None’
     if it’s not possible to generate such a filename.

 -- Data: test.support.TESTFN_NONASCII

     Set to a filename containing the *note FS_NONASCII: 336c.
     character.

 -- Data: test.support.IPV6_ENABLED

     Set to ‘True’ if IPV6 is enabled on this host, ‘False’ otherwise.

 -- Data: test.support.SAVEDCWD

     Set to *note os.getcwd(): f11.

 -- Data: test.support.PGO

     Set when tests can be skipped when they are not useful for PGO.

 -- Data: test.support.PIPE_MAX_SIZE

     A constant that is likely larger than the underlying OS pipe buffer
     size, to make writes blocking.

 -- Data: test.support.SOCK_MAX_SIZE

     A constant that is likely larger than the underlying OS socket
     buffer size, to make writes blocking.

 -- Data: test.support.TEST_SUPPORT_DIR

     Set to the top level directory that contains *note test.support:
     106.

 -- Data: test.support.TEST_HOME_DIR

     Set to the top level directory for the test package.

 -- Data: test.support.TEST_DATA_DIR

     Set to the ‘data’ directory within the test package.

 -- Data: test.support.MAX_Py_ssize_t

     Set to *note sys.maxsize: b36. for big memory tests.

 -- Data: test.support.max_memuse

     Set by *note set_memlimit(): 337d. as the memory limit for big
     memory tests.  Limited by *note MAX_Py_ssize_t: 337b.

 -- Data: test.support.real_max_memuse

     Set by *note set_memlimit(): 337d. as the memory limit for big
     memory tests.  Not limited by *note MAX_Py_ssize_t: 337b.

 -- Data: test.support.MISSING_C_DOCSTRINGS

     Return ‘True’ if running on CPython, not on Windows, and
     configuration not set with ‘WITH_DOC_STRINGS’.

 -- Data: test.support.HAVE_DOCSTRINGS

     Check for presence of docstrings.

 -- Data: test.support.TEST_HTTP_URL

     Define the URL of a dedicated HTTP server for the network tests.

 -- Data: test.support.ALWAYS_EQ

     Object that is equal to anything.  Used to test mixed type
     comparison.

 -- Data: test.support.LARGEST

     Object that is greater than anything (except itself).  Used to test
     mixed type comparison.

 -- Data: test.support.SMALLEST

     Object that is less than anything (except itself).  Used to test
     mixed type comparison.

The *note test.support: 106. module defines the following functions:

 -- Function: test.support.forget (module_name)

     Remove the module named `module_name' from ‘sys.modules’ and delete
     any byte-compiled files of the module.

 -- Function: test.support.unload (name)

     Delete `name' from ‘sys.modules’.

 -- Function: test.support.unlink (filename)

     Call *note os.unlink(): a31. on `filename'.  On Windows platforms,
     this is wrapped with a wait loop that checks for the existence fo
     the file.

 -- Function: test.support.rmdir (filename)

     Call *note os.rmdir(): a2f. on `filename'.  On Windows platforms,
     this is wrapped with a wait loop that checks for the existence of
     the file.

 -- Function: test.support.rmtree (path)

     Call *note shutil.rmtree(): 21a. on `path' or call *note
     os.lstat(): 1f0. and *note os.rmdir(): a2f. to remove a path and
     its contents.  On Windows platforms, this is wrapped with a wait
     loop that checks for the existence of the files.

 -- Function: test.support.make_legacy_pyc (source)

     Move a PEP 3147(1)/ PEP 488(2) pyc file to its legacy pyc location
     and return the file system path to the legacy pyc file.  The
     `source' value is the file system path to the source file.  It does
     not need to exist, however the PEP 3147/488 pyc file must exist.

 -- Function: test.support.is_resource_enabled (resource)

     Return ‘True’ if `resource' is enabled and available.  The list of
     available resources is only set when ‘test.regrtest’ is executing
     the tests.

 -- Function: test.support.python_is_optimized ()

     Return ‘True’ if Python was not built with ‘-O0’ or ‘-Og’.

 -- Function: test.support.with_pymalloc ()

     Return ‘_testcapi.WITH_PYMALLOC’.

 -- Function: test.support.requires (resource, msg=None)

     Raise *note ResourceDenied: 3366. if `resource' is not available.
     `msg' is the argument to *note ResourceDenied: 3366. if it is
     raised.  Always returns ‘True’ if called by a function whose
     ‘__name__’ is ‘'__main__'’.  Used when tests are executed by
     ‘test.regrtest’.

 -- Function: test.support.system_must_validate_cert (f)

     Raise *note unittest.SkipTest: 8f7. on TLS certification validation
     failures.

 -- Function: test.support.sortdict (dict)

     Return a repr of `dict' with keys sorted.

 -- Function: test.support.findfile (filename, subdir=None)

     Return the path to the file named `filename'.  If no match is found
     `filename' is returned.  This does not equal a failure since it
     could be the path to the file.

     Setting `subdir' indicates a relative path to use to find the file
     rather than looking directly in the path directories.

 -- Function: test.support.create_empty_file (filename)

     Create an empty file with `filename'.  If it already exists,
     truncate it.

 -- Function: test.support.fd_count ()

     Count the number of open file descriptors.

 -- Function: test.support.match_test (test)

     Match `test' to patterns set in *note set_match_tests(): 3394.

 -- Function: test.support.set_match_tests (patterns)

     Define match test with regular expression `patterns'.

 -- Function: test.support.run_unittest (*classes)

     Execute *note unittest.TestCase: 8f3. subclasses passed to the
     function.  The function scans the classes for methods starting with
     the prefix ‘test_’ and executes the tests individually.

     It is also legal to pass strings as parameters; these should be
     keys in ‘sys.modules’.  Each associated module will be scanned by
     ‘unittest.TestLoader.loadTestsFromModule()’.  This is usually seen
     in the following ‘test_main()’ function:

          def test_main():     support.run_unittest(__name__)

     This will run all tests defined in the named module.

 -- Function: test.support.run_doctest (module, verbosity=None,
          optionflags=0)

     Run *note doctest.testmod(): dc3. on the given `module'.  Return
     ‘(failure_count, test_count)’.

     If `verbosity' is ‘None’, *note doctest.testmod(): dc3. is run with
     verbosity set to *note verbose: 3368.  Otherwise, it is run with
     verbosity set to ‘None’.  `optionflags' is passed as ‘optionflags’
     to *note doctest.testmod(): dc3.

 -- Function: test.support.setswitchinterval (interval)

     Set the *note sys.setswitchinterval(): bde. to the given
     `interval'.  Defines a minimum interval for Android systems to
     prevent the system from hanging.

 -- Function: test.support.check_impl_detail (**guards)

     Use this check to guard CPython’s implementation-specific tests or
     to run them only on the implementations guarded by the arguments:

          check_impl_detail()               # Only on CPython (default). check_impl_detail(jython=True)    # Only on Jython. check_impl_detail(cpython=False)  # Everywhere except CPython.

 -- Function: test.support.check_warnings (*filters, quiet=True)

     A convenience wrapper for *note warnings.catch_warnings(): 3399.
     that makes it easier to test that a warning was correctly raised.
     It is approximately equivalent to calling
     ‘warnings.catch_warnings(record=True)’ with *note
     warnings.simplefilter(): 339a. set to ‘always’ and with the option
     to automatically validate the results that are recorded.

     ‘check_warnings’ accepts 2-tuples of the form ‘("message regexp",
     WarningCategory)’ as positional arguments.  If one or more
     `filters' are provided, or if the optional keyword argument `quiet'
     is ‘False’, it checks to make sure the warnings are as expected:
     each specified filter must match at least one of the warnings
     raised by the enclosed code or the test fails, and if any warnings
     are raised that do not match any of the specified filters the test
     fails.  To disable the first of these checks, set `quiet' to
     ‘True’.

     If no arguments are specified, it defaults to:

          check_warnings(("", Warning), quiet=True)

     In this case all warnings are caught and no errors are raised.

     On entry to the context manager, a ‘WarningRecorder’ instance is
     returned.  The underlying warnings list from *note
     catch_warnings(): 3399. is available via the recorder object’s
     *note warnings: 126. attribute.  As a convenience, the attributes
     of the object representing the most recent warning can also be
     accessed directly through the recorder object (see example below).
     If no warning has been raised, then any of the attributes that
     would otherwise be expected on an object representing a warning
     will return ‘None’.

     The recorder object also has a ‘reset()’ method, which clears the
     warnings list.

     The context manager is designed to be used like this:

          with check_warnings(("assertion is always true", SyntaxWarning),                     ("", UserWarning)):     exec('assert(False, "Hey!")')     warnings.warn(UserWarning("Hide me!"))

     In this case if either warning was not raised, or some other
     warning was raised, *note check_warnings(): 3398. would raise an
     error.

     When a test needs to look more deeply into the warnings, rather
     than just checking whether or not they occurred, code like this can
     be used:

          with check_warnings(quiet=True) as w:     warnings.warn("foo")     assert str(w.args[0]) == "foo"     warnings.warn("bar")     assert str(w.args[0]) == "bar"     assert str(w.warnings[0].args[0]) == "foo"     assert str(w.warnings[1].args[0]) == "bar"     w.reset()     assert len(w.warnings) == 0

     Here all warnings will be caught, and the test code tests the
     captured warnings directly.

     Changed in version 3.2: New optional arguments `filters' and
     `quiet'.

 -- Function: test.support.check_no_resource_warning (testcase)

     Context manager to check that no *note ResourceWarning: 4c5. was
     raised.  You must remove the object which may emit *note
     ResourceWarning: 4c5. before the end of the context manager.

 -- Function: test.support.set_memlimit (limit)

     Set the values for *note max_memuse: 337c. and *note
     real_max_memuse: 337e. for big memory tests.

 -- Function: test.support.record_original_stdout (stdout)

     Store the value from `stdout'.  It is meant to hold the stdout at
     the time the regrtest began.

 -- Function: test.support.get_original_stdout ()

     Return the original stdout set by *note record_original_stdout():
     339c. or ‘sys.stdout’ if it’s not set.

 -- Function: test.support.strip_python_strerr (stderr)

     Strip the `stderr' of a Python process from potential debug output
     emitted by the interpreter.  This will typically be run on the
     result of *note subprocess.Popen.communicate(): 2397.

 -- Function: test.support.args_from_interpreter_flags ()

     Return a list of command line arguments reproducing the current
     settings in ‘sys.flags’ and ‘sys.warnoptions’.

 -- Function: test.support.optim_args_from_interpreter_flags ()

     Return a list of command line arguments reproducing the current
     optimization settings in ‘sys.flags’.

 -- Function: test.support.captured_stdin ()
 -- Function: test.support.captured_stdout ()
 -- Function: test.support.captured_stderr ()

     A context managers that temporarily replaces the named stream with
     *note io.StringIO: 821. object.

     Example use with output streams:

          with captured_stdout() as stdout, captured_stderr() as stderr:     print("hello")     print("error", file=sys.stderr) assert stdout.getvalue() == "hello\n" assert stderr.getvalue() == "error\n"

     Example use with input stream:

          with captured_stdin() as stdin:     stdin.write('hello\n')     stdin.seek(0)     # call test code that consumes from sys.stdin     captured = input() self.assertEqual(captured, "hello")

 -- Function: test.support.temp_dir (path=None, quiet=False)

     A context manager that creates a temporary directory at `path' and
     yields the directory.

     If `path' is ‘None’, the temporary directory is created using *note
     tempfile.mkdtemp(): 1ba1.  If `quiet' is ‘False’, the context
     manager raises an exception on error.  Otherwise, if `path' is
     specified and cannot be created, only a warning is issued.

 -- Function: test.support.change_cwd (path, quiet=False)

     A context manager that temporarily changes the current working
     directory to `path' and yields the directory.

     If `quiet' is ‘False’, the context manager raises an exception on
     error.  Otherwise, it issues only a warning and keeps the current
     working directory the same.

 -- Function: test.support.temp_cwd (name='tempcwd', quiet=False)

     A context manager that temporarily creates a new directory and
     changes the current working directory (CWD).

     The context manager creates a temporary directory in the current
     directory with name `name' before temporarily changing the current
     working directory.  If `name' is ‘None’, the temporary directory is
     created using *note tempfile.mkdtemp(): 1ba1.

     If `quiet' is ‘False’ and it is not possible to create or change
     the CWD, an error is raised.  Otherwise, only a warning is raised
     and the original CWD is used.

 -- Function: test.support.temp_umask (umask)

     A context manager that temporarily sets the process umask.

 -- Function: test.support.transient_internet (resource_name, *,
          timeout=30.0, errnos=())

     A context manager that raises *note ResourceDenied: 3366. when
     various issues with the internet connection manifest themselves as
     exceptions.

 -- Function: test.support.disable_faulthandler ()

     A context manager that replaces ‘sys.stderr’ with ‘sys.__stderr__’.

 -- Function: test.support.gc_collect ()

     Force as many objects as possible to be collected.  This is needed
     because timely deallocation is not guaranteed by the garbage
     collector.  This means that ‘__del__’ methods may be called later
     than expected and weakrefs may remain alive for longer than
     expected.

 -- Function: test.support.disable_gc ()

     A context manager that disables the garbage collector upon entry
     and reenables it upon exit.

 -- Function: test.support.swap_attr (obj, attr, new_val)

     Context manager to swap out an attribute with a new object.

     Usage:

          with swap_attr(obj, "attr", 5):     ...

     This will set ‘obj.attr’ to 5 for the duration of the ‘with’ block,
     restoring the old value at the end of the block.  If ‘attr’ doesn’t
     exist on ‘obj’, it will be created and then deleted at the end of
     the block.

     The old value (or ‘None’ if it doesn’t exist) will be assigned to
     the target of the “as” clause, if there is one.

 -- Function: test.support.swap_item (obj, attr, new_val)

     Context manager to swap out an item with a new object.

     Usage:

          with swap_item(obj, "item", 5):     ...

     This will set ‘obj["item"]’ to 5 for the duration of the ‘with’
     block, restoring the old value at the end of the block.  If ‘item’
     doesn’t exist on ‘obj’, it will be created and then deleted at the
     end of the block.

     The old value (or ‘None’ if it doesn’t exist) will be assigned to
     the target of the “as” clause, if there is one.

 -- Function: test.support.wait_threads_exit (timeout=60.0)

     Context manager to wait until all threads created in the ‘with’
     statement exit.

 -- Function: test.support.start_threads (threads, unlock=None)

     Context manager to start `threads'.  It attempts to join the
     threads upon exit.

 -- Function: test.support.calcobjsize (fmt)

     Return *note struct.calcsize(): 1748. for ‘nP{fmt}0n’ or, if
     ‘gettotalrefcount’ exists, ‘2PnP{fmt}0P’.

 -- Function: test.support.calcvobjsize (fmt)

     Return *note struct.calcsize(): 1748. for ‘nPn{fmt}0n’ or, if
     ‘gettotalrefcount’ exists, ‘2PnPn{fmt}0P’.

 -- Function: test.support.checksizeof (test, o, size)

     For testcase `test', assert that the ‘sys.getsizeof’ for `o' plus
     the GC header size equals `size'.

 -- Function: test.support.can_symlink ()

     Return ‘True’ if the OS supports symbolic links, ‘False’ otherwise.

 -- Function: test.support.can_xattr ()

     Return ‘True’ if the OS supports xattr, ‘False’ otherwise.

 -- Function: @test.support.skip_unless_symlink

     A decorator for running tests that require support for symbolic
     links.

 -- Function: @test.support.skip_unless_xattr

     A decorator for running tests that require support for xattr.

 -- Function: @test.support.skip_unless_bind_unix_socket

     A decorator for running tests that require a functional bind() for
     Unix sockets.

 -- Function: @test.support.anticipate_failure (condition)

     A decorator to conditionally mark tests with *note
     unittest.expectedFailure(): 3271.  Any use of this decorator should
     have an associated comment identifying the relevant tracker issue.

 -- Function: @test.support.run_with_locale (catstr, *locales)

     A decorator for running a function in a different locale, correctly
     resetting it after it has finished.  `catstr' is the locale
     category as a string (for example ‘"LC_ALL"’).  The `locales'
     passed will be tried sequentially, and the first valid locale will
     be used.

 -- Function: @test.support.run_with_tz (tz)

     A decorator for running a function in a specific timezone,
     correctly resetting it after it has finished.

 -- Function: @test.support.requires_freebsd_version (*min_version)

     Decorator for the minimum version when running test on FreeBSD. If
     the FreeBSD version is less than the minimum, raise *note
     unittest.SkipTest: 8f7.

 -- Function: @test.support.requires_linux_version (*min_version)

     Decorator for the minimum version when running test on Linux.  If
     the Linux version is less than the minimum, raise *note
     unittest.SkipTest: 8f7.

 -- Function: @test.support.requires_mac_version (*min_version)

     Decorator for the minimum version when running test on Mac OS X. If
     the MAC OS X version is less than the minimum, raise *note
     unittest.SkipTest: 8f7.

 -- Function: @test.support.requires_IEEE_754

     Decorator for skipping tests on non-IEEE 754 platforms.

 -- Function: @test.support.requires_zlib

     Decorator for skipping tests if *note zlib: 144. doesn’t exist.

 -- Function: @test.support.requires_gzip

     Decorator for skipping tests if *note gzip: 8c. doesn’t exist.

 -- Function: @test.support.requires_bz2

     Decorator for skipping tests if *note bz2: 14. doesn’t exist.

 -- Function: @test.support.requires_lzma

     Decorator for skipping tests if *note lzma: ad. doesn’t exist.

 -- Function: @test.support.requires_resource (resource)

     Decorator for skipping tests if `resource' is not available.

 -- Function: @test.support.requires_docstrings

     Decorator for only running the test if *note HAVE_DOCSTRINGS: 3380.

 -- Function: @test.support.cpython_only (test)

     Decorator for tests only applicable to CPython.

 -- Function: @test.support.impl_detail (msg=None, **guards)

     Decorator for invoking *note check_impl_detail(): 3397. on
     `guards'.  If that returns ‘False’, then uses `msg' as the reason
     for skipping the test.

 -- Function: @test.support.no_tracing (func)

     Decorator to temporarily turn off tracing for the duration of the
     test.

 -- Function: @test.support.refcount_test (test)

     Decorator for tests which involve reference counting.  The
     decorator does not run the test if it is not run by CPython.  Any
     trace function is unset for the duration of the test to prevent
     unexpected refcounts caused by the trace function.

 -- Function: @test.support.reap_threads (func)

     Decorator to ensure the threads are cleaned up even if the test
     fails.

 -- Function: @test.support.bigmemtest (size, memuse, dry_run=True)

     Decorator for bigmem tests.

     `size' is a requested size for the test (in arbitrary,
     test-interpreted units.)  `memuse' is the number of bytes per unit
     for the test, or a good estimate of it.  For example, a test that
     needs two byte buffers, of 4 GiB each, could be decorated with
     ‘@bigmemtest(size=_4G, memuse=2)’.

     The `size' argument is normally passed to the decorated test method
     as an extra argument.  If `dry_run' is ‘True’, the value passed to
     the test method may be less than the requested value.  If `dry_run'
     is ‘False’, it means the test doesn’t support dummy runs when ‘-M’
     is not specified.

 -- Function: @test.support.bigaddrspacetest (f)

     Decorator for tests that fill the address space.  `f' is the
     function to wrap.

 -- Function: test.support.make_bad_fd ()

     Create an invalid file descriptor by opening and closing a
     temporary file, and returning its descriptor.

 -- Function: test.support.check_syntax_error (testcase, statement,
          errtext='', *, lineno=None, offset=None)

     Test for syntax errors in `statement' by attempting to compile
     `statement'.  `testcase' is the *note unittest: 11b. instance for
     the test.  `errtext' is the regular expression which should match
     the string representation of the raised *note SyntaxError: 44d.  If
     `lineno' is not ‘None’, compares to the line of the exception.  If
     `offset' is not ‘None’, compares to the offset of the exception.

 -- Function: test.support.check_syntax_warning (testcase, statement,
          errtext='', *, lineno=1, offset=None)

     Test for syntax warning in `statement' by attempting to compile
     `statement'.  Test also that the *note SyntaxWarning: 191. is
     emitted only once, and that it will be converted to a *note
     SyntaxError: 44d. when turned into error.  `testcase' is the *note
     unittest: 11b. instance for the test.  `errtext' is the regular
     expression which should match the string representation of the
     emitted *note SyntaxWarning: 191. and raised *note SyntaxError:
     44d.  If `lineno' is not ‘None’, compares to the line of the
     warning and exception.  If `offset' is not ‘None’, compares to the
     offset of the exception.

     New in version 3.8.

 -- Function: test.support.open_urlresource (url, *args, **kw)

     Open `url'.  If open fails, raises *note TestFailed: 3365.

 -- Function: test.support.import_module (name, deprecated=False, *,
          required_on())

     This function imports and returns the named module.  Unlike a
     normal import, this function raises *note unittest.SkipTest: 8f7.
     if the module cannot be imported.

     Module and package deprecation messages are suppressed during this
     import if `deprecated' is ‘True’.  If a module is required on a
     platform but optional for others, set `required_on' to an iterable
     of platform prefixes which will be compared against *note
     sys.platform: 2af.

     New in version 3.1.

 -- Function: test.support.import_fresh_module (name, fresh=(),
          blocked=(), deprecated=False)

     This function imports and returns a fresh copy of the named Python
     module by removing the named module from ‘sys.modules’ before doing
     the import.  Note that unlike ‘reload()’, the original module is
     not affected by this operation.

     `fresh' is an iterable of additional module names that are also
     removed from the ‘sys.modules’ cache before doing the import.

     `blocked' is an iterable of module names that are replaced with
     ‘None’ in the module cache during the import to ensure that
     attempts to import them raise *note ImportError: 329.

     The named module and any modules named in the `fresh' and `blocked'
     parameters are saved before starting the import and then reinserted
     into ‘sys.modules’ when the fresh import is complete.

     Module and package deprecation messages are suppressed during this
     import if `deprecated' is ‘True’.

     This function will raise *note ImportError: 329. if the named
     module cannot be imported.

     Example use:

          # Get copies of the warnings module for testing without affecting the # version being used by the rest of the test suite. One copy uses the # C implementation, the other is forced to use the pure Python fallback # implementation py_warnings = import_fresh_module('warnings', blocked=['_warnings']) c_warnings = import_fresh_module('warnings', fresh=['_warnings'])

     New in version 3.1.

 -- Function: test.support.modules_setup ()

     Return a copy of *note sys.modules: 13eb.

 -- Function: test.support.modules_cleanup (oldmodules)

     Remove modules except for `oldmodules' and ‘encodings’ in order to
     preserve internal cache.

 -- Function: test.support.threading_setup ()

     Return current thread count and copy of dangling threads.

 -- Function: test.support.threading_cleanup (*original_values)

     Cleanup up threads not specified in `original_values'.  Designed to
     emit a warning if a test leaves running threads in the background.

 -- Function: test.support.join_thread (thread, timeout=30.0)

     Join a `thread' within `timeout'.  Raise an *note AssertionError:
     f66. if thread is still alive after `timeout' seconds.

 -- Function: test.support.reap_children ()

     Use this at the end of ‘test_main’ whenever sub-processes are
     started.  This will help ensure that no extra children (zombies)
     stick around to hog resources and create problems when looking for
     refleaks.

 -- Function: test.support.get_attribute (obj, name)

     Get an attribute, raising *note unittest.SkipTest: 8f7. if *note
     AttributeError: 390. is raised.

 -- Function: test.support.bind_port (sock, host=HOST)

     Bind the socket to a free port and return the port number.  Relies
     on ephemeral ports in order to ensure we are using an unbound port.
     This is important as many tests may be running simultaneously,
     especially in a buildbot environment.  This method raises an
     exception if the ‘sock.family’ is *note AF_INET: 24eb. and
     ‘sock.type’ is *note SOCK_STREAM: c7d, and the socket has
     ‘SO_REUSEADDR’ or ‘SO_REUSEPORT’ set on it.  Tests should never set
     these socket options for TCP/IP sockets.  The only case for setting
     these options is testing multicasting via multiple UDP sockets.

     Additionally, if the ‘SO_EXCLUSIVEADDRUSE’ socket option is
     available (i.e.  on Windows), it will be set on the socket.  This
     will prevent anyone else from binding to our host/port for the
     duration of the test.

 -- Function: test.support.bind_unix_socket (sock, addr)

     Bind a unix socket, raising *note unittest.SkipTest: 8f7. if *note
     PermissionError: 5f4. is raised.

 -- Function: test.support.catch_threading_exception ()

     Context manager catching *note threading.Thread: 233. exception
     using *note threading.excepthook(): 22f.

     Attributes set when an exception is catched:

        * ‘exc_type’

        * ‘exc_value’

        * ‘exc_traceback’

        * ‘thread’

     See *note threading.excepthook(): 22f. documentation.

     These attributes are deleted at the context manager exit.

     Usage:

          with support.catch_threading_exception() as cm:     # code spawning a thread which raises an exception     ...      # check the thread exception, use cm attributes:     # exc_type, exc_value, exc_traceback, thread     ...  # exc_type, exc_value, exc_traceback, thread attributes of cm no longer # exists at this point # (to avoid reference cycles)

     New in version 3.8.

 -- Function: test.support.catch_unraisable_exception ()

     Context manager catching unraisable exception using *note
     sys.unraisablehook(): 22b.

     Storing the exception value (‘cm.unraisable.exc_value’) creates a
     reference cycle.  The reference cycle is broken explicitly when the
     context manager exits.

     Storing the object (‘cm.unraisable.object’) can resurrect it if it
     is set to an object which is being finalized.  Exiting the context
     manager clears the stored object.

     Usage:

          with support.catch_unraisable_exception() as cm:     # code creating an "unraisable exception"     ...      # check the unraisable exception: use cm.unraisable     ...  # cm.unraisable attribute no longer exists at this point # (to break a reference cycle)

     New in version 3.8.

 -- Function: test.support.find_unused_port (family=socket.AF_INET,
          socktype=socket.SOCK_STREAM)

     Returns an unused port that should be suitable for binding.  This
     is achieved by creating a temporary socket with the same family and
     type as the ‘sock’ parameter (default is *note AF_INET: 24eb, *note
     SOCK_STREAM: c7d.), and binding it to the specified host address
     (defaults to ‘0.0.0.0’) with the port set to 0, eliciting an unused
     ephemeral port from the OS. The temporary socket is then closed and
     deleted, and the ephemeral port is returned.

     Either this method or *note bind_port(): 33d7. should be used for
     any tests where a server socket needs to be bound to a particular
     port for the duration of the test.  Which one to use depends on
     whether the calling code is creating a Python socket, or if an
     unused port needs to be provided in a constructor or passed to an
     external program (i.e.  the ‘-accept’ argument to openssl’s
     s_server mode).  Always prefer *note bind_port(): 33d7. over *note
     find_unused_port(): 33d9. where possible.  Using a hard coded port
     is discouraged since it can make multiple instances of the test
     impossible to run simultaneously, which is a problem for buildbots.

 -- Function: test.support.load_package_tests (pkg_dir, loader,
          standard_tests, pattern)

     Generic implementation of the *note unittest: 11b. ‘load_tests’
     protocol for use in test packages.  `pkg_dir' is the root directory
     of the package; `loader', `standard_tests', and `pattern' are the
     arguments expected by ‘load_tests’.  In simple cases, the test
     package’s ‘__init__.py’ can be the following:

          import os from test.support import load_package_tests  def load_tests(*args):     return load_package_tests(os.path.dirname(__file__), *args)

 -- Function: test.support.fs_is_case_insensitive (directory)

     Return ‘True’ if the file system for `directory' is
     case-insensitive.

 -- Function: test.support.detect_api_mismatch (ref_api, other_api, *,
          ignore=())

     Returns the set of attributes, functions or methods of `ref_api'
     not found on `other_api', except for a defined list of items to be
     ignored in this check specified in `ignore'.

     By default this skips private attributes beginning with ‘_’ but
     includes all magic methods, i.e.  those starting and ending in
     ‘__’.

     New in version 3.5.

 -- Function: test.support.patch (test_instance, object_to_patch,
          attr_name, new_value)

     Override `object_to_patch.attr_name' with `new_value'.  Also add
     cleanup procedure to `test_instance' to restore `object_to_patch'
     for `attr_name'.  The `attr_name' should be a valid attribute for
     `object_to_patch'.

 -- Function: test.support.run_in_subinterp (code)

     Run `code' in subinterpreter.  Raise *note unittest.SkipTest: 8f7.
     if *note tracemalloc: 114. is enabled.

 -- Function: test.support.check_free_after_iterating (test, iter, cls,
          args=())

     Assert that `iter' is deallocated after iterating.

 -- Function: test.support.missing_compiler_executable (cmd_names=[])

     Check for the existence of the compiler executables whose names are
     listed in `cmd_names' or all the compiler executables when
     `cmd_names' is empty and return the first missing executable or
     ‘None’ when none is found missing.

 -- Function: test.support.check__all__ (test_case, module,
          name_of_module=None, extra=(), blacklist=())

     Assert that the ‘__all__’ variable of `module' contains all public
     names.

     The module’s public names (its API) are detected automatically
     based on whether they match the public name convention and were
     defined in `module'.

     The `name_of_module' argument can specify (as a string or tuple
     thereof) what module(s) an API could be defined in order to be
     detected as a public API. One case for this is when `module'
     imports part of its public API from other modules, possibly a C
     backend (like ‘csv’ and its ‘_csv’).

     The `extra' argument can be a set of names that wouldn’t otherwise
     be automatically detected as “public”, like objects without a
     proper ‘__module__’ attribute.  If provided, it will be added to
     the automatically detected ones.

     The `blacklist' argument can be a set of names that must not be
     treated as part of the public API even though their names indicate
     otherwise.

     Example use:

          import bar import foo import unittest from test import support  class MiscTestCase(unittest.TestCase):     def test__all__(self):         support.check__all__(self, foo)  class OtherTestCase(unittest.TestCase):     def test__all__(self):         extra = {'BAR_CONST', 'FOO_CONST'}         blacklist = {'baz'}  # Undocumented name.         # bar imports part of its API from _bar.         support.check__all__(self, bar, ('bar', '_bar'),                              extra=extra, blacklist=blacklist)

     New in version 3.6.

The *note test.support: 106. module defines the following classes:

 -- Class: test.support.TransientResource (exc, **kwargs)

     Instances are a context manager that raises *note ResourceDenied:
     3366. if the specified exception type is raised.  Any keyword
     arguments are treated as attribute/value pairs to be compared
     against any exception raised within the *note with: 6dd. statement.
     Only if all pairs match properly against attributes on the
     exception is *note ResourceDenied: 3366. raised.

 -- Class: test.support.EnvironmentVarGuard

     Class used to temporarily set or unset environment variables.
     Instances can be used as a context manager and have a complete
     dictionary interface for querying/modifying the underlying
     ‘os.environ’.  After exit from the context manager all changes to
     environment variables done through this instance will be rolled
     back.

     Changed in version 3.1: Added dictionary interface.

 -- Method: EnvironmentVarGuard.set (envvar, value)

     Temporarily set the environment variable ‘envvar’ to the value of
     ‘value’.

 -- Method: EnvironmentVarGuard.unset (envvar)

     Temporarily unset the environment variable ‘envvar’.

 -- Class: test.support.SuppressCrashReport

     A context manager used to try to prevent crash dialog popups on
     tests that are expected to crash a subprocess.

     On Windows, it disables Windows Error Reporting dialogs using
     SetErrorMode(3).

     On UNIX, *note resource.setrlimit(): 33e7. is used to set *note
     resource.RLIMIT_CORE: 33e8.’s soft limit to 0 to prevent coredump
     file creation.

     On both platforms, the old value is restored by *note __exit__():
     c89.

 -- Class: test.support.CleanImport (*module_names)

     A context manager to force import to return a new module reference.
     This is useful for testing module-level behaviors, such as the
     emission of a DeprecationWarning on import.  Example usage:

          with CleanImport('foo'):     importlib.import_module('foo')  # New reference.

 -- Class: test.support.DirsOnSysPath (*paths)

     A context manager to temporarily add directories to sys.path.

     This makes a copy of *note sys.path: 47d, appends any directories
     given as positional arguments, then reverts *note sys.path: 47d. to
     the copied settings when the context ends.

     Note that `all' *note sys.path: 47d. modifications in the body of
     the context manager, including replacement of the object, will be
     reverted at the end of the block.

 -- Class: test.support.SaveSignals

     Class to save and restore signal handlers registered by the Python
     signal handler.

 -- Class: test.support.Matcher

      -- Method: matches (self, d, **kwargs)

          Try to match a single dict with the supplied arguments.

      -- Method: match_value (self, k, dv, v)

          Try to match a single stored value (`dv') with a supplied
          value (`v').

 -- Class: test.support.WarningsRecorder

     Class used to record warnings for unit tests.  See documentation of
     *note check_warnings(): 3398. above for more details.

 -- Class: test.support.BasicTestRunner

      -- Method: run (test)

          Run `test' and return the result.

 -- Class: test.support.TestHandler (logging.handlers.BufferingHandler)

     Class for logging support.

 -- Class: test.support.FakePath (path)

     Simple *note path-like object: 35f.  It implements the
     ‘__fspath__()’ method which just returns the `path' argument.  If
     `path' is an exception, it will be raised in ‘__fspath__()’.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147

   (2) https://www.python.org/dev/peps/pep-0488

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/ms680621.aspx


File: python.info,  Node: test support script_helper — Utilities for the Python execution tests,  Prev: test support — Utilities for the Python test suite,  Up: Development Tools

5.27.10 ‘test.support.script_helper’ — Utilities for the Python execution tests
-------------------------------------------------------------------------------

The *note test.support.script_helper: 107. module provides support for
Python’s script execution tests.

 -- Function:
          test.support.script_helper.interpreter_requires_environment ()

     Return ‘True’ if ‘sys.executable interpreter’ requires environment
     variables in order to be able to run at all.

     This is designed to be used with ‘@unittest.skipIf()’ to annotate
     tests that need to use an ‘assert_python*()’ function to launch an
     isolated mode (‘-I’) or no environment mode (‘-E’) sub-interpreter
     process.

     A normal build & test does not run into this situation but it can
     happen when trying to run the standard library test suite from an
     interpreter that doesn’t have an obvious home with Python’s current
     home finding logic.

     Setting *note PYTHONHOME: 4cb. is one way to get most of the
     testsuite to run in that situation.  *note PYTHONPATH: 947. or
     ‘PYTHONUSERSITE’ are other common environment variables that might
     impact whether or not the interpreter can start.

 -- Function: test.support.script_helper.run_python_until_end (*args,
          **env_vars)

     Set up the environment based on `env_vars' for running the
     interpreter in a subprocess.  The values can include ‘__isolated’,
     ‘__cleanenv’, ‘__cwd’, and ‘TERM’.

 -- Function: test.support.script_helper.assert_python_ok (*args,
          **env_vars)

     Assert that running the interpreter with `args' and optional
     environment variables `env_vars' succeeds (‘rc == 0’) and return a
     ‘(return code, stdout, stderr)’ tuple.

     If the ‘__cleanenv’ keyword is set, `env_vars' is used as a fresh
     environment.

     Python is started in isolated mode (command line option ‘-I’),
     except if the ‘__isolated’ keyword is set to ‘False’.

 -- Function: test.support.script_helper.assert_python_failure (*args,
          **env_vars)

     Assert that running the interpreter with `args' and optional
     environment variables `env_vars' fails (‘rc != 0’) and return a
     ‘(return code, stdout, stderr)’ tuple.

     See *note assert_python_ok(): 33f7. for more options.

 -- Function: test.support.script_helper.spawn_python (*args,
          stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw)

     Run a Python subprocess with the given arguments.

     `kw' is extra keyword args to pass to *note subprocess.Popen():
     2b7.  Returns a *note subprocess.Popen: 2b7. object.

 -- Function: test.support.script_helper.kill_python (p)

     Run the given *note subprocess.Popen: 2b7. process until completion
     and return stdout.

 -- Function: test.support.script_helper.make_script (script_dir,
          script_basename, source, omit_suffix=False)

     Create script containing `source' in path `script_dir' and
     `script_basename'.  If `omit_suffix' is ‘False’, append ‘.py’ to
     the name.  Return the full script path.

 -- Function: test.support.script_helper.make_zip_script (zip_dir,
          zip_basename, script_name, name_in_zip=None)

     Create zip file at `zip_dir' and `zip_basename' with extension
     ‘zip’ which contains the files in `script_name'.  `name_in_zip' is
     the archive name.  Return a tuple containing ‘(full path, full path
     of archive name)’.

 -- Function: test.support.script_helper.make_pkg (pkg_dir,
          init_source='')

     Create a directory named `pkg_dir' containing an ‘__init__’ file
     with `init_source' as its contents.

 -- Function: test.support.script_helper.make_zip_pkg (zip_dir,
          zip_basename, pkg_name, script_basename, source, depth=1,
          compiled=False)

     Create a zip package directory with a path of `zip_dir' and
     `zip_basename' containing an empty ‘__init__’ file and a file
     `script_basename' containing the `source'.  If `compiled' is
     ‘True’, both source files will be compiled and added to the zip
     package.  Return a tuple of the full zip path and the archive name
     for the zip file.

See also the Python development mode: the *note -X: 155. ‘dev’ option
and *note PYTHONDEVMODE: 321. environment variable.


File: python.info,  Node: Debugging and Profiling,  Next: Software Packaging and Distribution,  Prev: Development Tools,  Up: The Python Standard Library

5.28 Debugging and Profiling
============================

These libraries help you with Python development: the debugger enables
you to step through code, analyze stack frames and set breakpoints etc.,
and the profilers run code and give you a detailed breakdown of
execution times, allowing you to identify bottlenecks in your programs.
Auditing events provide visibility into runtime behaviors that would
otherwise require intrusive debugging or patching.

* Menu:

* Audit events table::
* bdb — Debugger framework::
* faulthandler — Dump the Python traceback::
* pdb — The Python Debugger::
* The Python Profilers::
* timeit — Measure execution time of small code snippets::
* trace — Trace or track Python statement execution::
* tracemalloc — Trace memory allocations::


File: python.info,  Node: Audit events table,  Next: bdb — Debugger framework,  Up: Debugging and Profiling

5.28.1 Audit events table
-------------------------

This table contains all events raised by *note sys.audit(): 3404. or
*note PySys_Audit(): e81. calls throughout the CPython runtime and the
standard library.  These calls were added in 3.8.0 or later.

See *note sys.addaudithook(): 3405. and *note PySys_AddAuditHook():
3406. for information on handling these events.

`CPython implementation detail:' This table is generated from the
CPython documentation, and may not represent events raised by other
implementations.  See your runtime specific documentation for actual
events raised.

Audit event                        Arguments                                                   References
                                                                                               
-------------------------------------------------------------------------------------------------------------------
                                                                                               
array.__new__                      ‘typecode’, ‘initializer’                                   *note [1]: 446.
                                                                                               
                                                                                               
builtins.breakpoint                ‘breakpointhook’                                            *note [1]: 2ee.
                                                                                               
                                                                                               
builtins.input                     ‘prompt’                                                    *note [1]: c5e.
                                                                                               
                                                                                               
builtins.input/result              ‘result’                                                    *note [1]: c5e.
                                                                                               
                                                                                               
code.__new__                       ‘code’, ‘filename’, ‘name’, ‘argcount’,                     *note [1]: 3407.
                                   ‘posonlyargcount’, ‘kwonlyargcount’, ‘nlocals’,             
                                   ‘stacksize’, ‘flags’
                                   
                                                                                               
compile                            ‘source’, ‘filename’                                        *note [1]: 1b2.
                                                                                               
                                                                                               
cpython.PyInterpreterState_Clear                                                               *note [1]: 3408.
                                                                                               
                                                                                               
cpython.PyInterpreterState_New                                                                 *note [1]: 3409.
                                                                                               
                                                                                               
cpython._PySys_ClearAuditHooks                                                                 *note [1]: 5be.
                                                                                               
                                                                                               
cpython.run_command                ‘command’                                                   *note [1]: 1145.
                                                                                               
                                                                                               
cpython.run_file                   ‘filename’                                                  *note [1]: 340a.
                                                                                               
                                                                                               
cpython.run_interactivehook        ‘hook’                                                      *note [1]: 8d8.
                                                                                               
                                                                                               
cpython.run_module                 ‘module-name’                                               *note [1]: 32c.
                                                                                               
                                                                                               
cpython.run_startup                ‘filename’                                                  *note [1]: 340b.
                                                                                               
                                                                                               
cpython.run_stdin                                                                              *note [1]: 340c.
                                                                                               
                                                                                               
ctypes.addressof                   ‘obj’                                                       *note [1]: 225e.
                                                                                               
                                                                                               
ctypes.call_function               ‘func_pointer’, ‘arguments’                                 *note [1]: 340d.
                                                                                               
                                                                                               
ctypes.cdata                       ‘address’                                                   *note [1]: 2270.
                                                                                               
                                                                                               
ctypes.cdata/buffer                ‘pointer’, ‘size’, ‘offset’                                 *note [1]: 226e.*note [2]: 226f.
                                                                                               
                                                                                               
ctypes.create_string_buffer        ‘init’, ‘size’                                              *note [1]: 2210.
                                                                                               
                                                                                               
ctypes.create_unicode_buffer       ‘init’, ‘size’                                              *note [1]: ede.
                                                                                               
                                                                                               
ctypes.dlopen                      ‘name’                                                      *note [1]: 2250.
                                                                                               
                                                                                               
ctypes.dlsym                       ‘library’, ‘name’                                           *note [1]: 2250.
                                                                                               
                                                                                               
ctypes.dlsym/handle                ‘handle’, ‘name’                                            *note [1]: 2250.
                                                                                               
                                                                                               
ctypes.get_errno                                                                               *note [1]: 224a.
                                                                                               
                                                                                               
ctypes.get_last_error                                                                          *note [1]: 224c.
                                                                                               
                                                                                               
ctypes.seh_exception               ‘code’                                                      *note [1]: 2253.
                                                                                               
                                                                                               
ctypes.set_errno                   ‘errno’                                                     *note [1]: 224b.
                                                                                               
                                                                                               
ctypes.set_last_error              ‘error’                                                     *note [1]: 224d.
                                                                                               
                                                                                               
ctypes.string_at                   ‘address’, ‘size’                                           *note [1]: 2267.
                                                                                               
                                                                                               
ctypes.wstring_at                  ‘address’, ‘size’                                           *note [1]: 2269.
                                                                                               
                                                                                               
ensurepip.bootstrap                ‘root’                                                      *note [1]: 340e.
                                                                                               
                                                                                               
exec                               ‘code_object’                                               *note [1]: b83.*note [2]: c37.
                                                                                               
                                                                                               
ftplib.connect                     ‘self’, ‘host’, ‘port’                                      *note [1]: 2c51.
                                                                                               
                                                                                               
ftplib.sendcmd                     ‘self’, ‘cmd’                                               *note [1]: 2c55.*note [2]: 2c56.
                                                                                               
                                                                                               
glob.glob                          ‘pathname’, ‘recursive’                                     *note [1]: 5bb.*note [2]: 5bc.
                                                                                               
                                                                                               
imaplib.open                       ‘self’, ‘host’, ‘port’                                      *note [1]: 2ca1.
                                                                                               
                                                                                               
imaplib.send                       ‘self’, ‘data’                                              *note [1]: 2ca4.
                                                                                               
                                                                                               
import                             ‘module’, ‘filename’, ‘sys.path’, ‘sys.meta_path’,          *note [1]: c10.
                                   ‘sys.path_hooks’                                            
                                   
                                                                                               
mmap.__new__                       ‘fileno’, ‘length’, ‘access’, ‘offset’                      *note [1]: 1ea.
                                                                                               
                                                                                               
nntplib.connect                    ‘self’, ‘host’, ‘port’                                      *note [1]: a21.*note [2]: b98.
                                                                                               
                                                                                               
nntplib.putline                    ‘self’, ‘line’                                              *note [1]: a21.*note [2]: b98.
                                                                                               
                                                                                               
open                               ‘file’, ‘mode’, ‘flags’                                     *note [1]: 4e5.*note [2]: 64e.*note [3]: 659.
                                                                                               
                                                                                               
os.listdir                         ‘path’                                                      *note [1]: a36.
                                                                                               
                                                                                               
os.scandir                         ‘path’                                                      *note [1]: 25d.
                                                                                               
                                                                                               
os.system                          ‘command’                                                   *note [1]: db4.
                                                                                               
                                                                                               
os.truncate                        ‘fd’, ‘length’                                              *note [1]: 656.*note [2]: 718.
                                                                                               
                                                                                               
pdb.Pdb                                                                                        *note [1]: 561.
                                                                                               
                                                                                               
pickle.find_class                  ‘module’, ‘name’                                            *note [1]: 1bf7.
                                                                                               
                                                                                               
poplib.connect                     ‘self’, ‘host’, ‘port’                                      *note [1]: 2c6c.*note [2]: bb4.
                                                                                               
                                                                                               
poplib.putline                     ‘self’, ‘line’                                              *note [1]: 2c6c.*note [2]: 340f.
                                                                                               
                                                                                               
shutil.copytree                    ‘src’, ‘dst’                                                *note [1]: 218.
                                                                                               
                                                                                               
shutil.make_archive                ‘base_name’, ‘format’, ‘root_dir’, ‘base_dir’               *note [1]: 219.
                                                                                               
                                                                                               
shutil.rmtree                      ‘path’                                                      *note [1]: 21a.
                                                                                               
                                                                                               
smtplib.connect                    ‘self’, ‘host’, ‘port’                                      *note [1]: 2cea.
                                                                                               
                                                                                               
smtplib.send                       ‘self’, ‘data’                                              *note [1]: a76.
                                                                                               
                                                                                               
socket.__new__                     ‘self’, ‘family’, ‘type’, ‘protocol’                        *note [1]: 668.
                                                                                               
                                                                                               
socket.bind                        ‘self’, ‘address’                                           *note [1]: 25d9.
                                                                                               
                                                                                               
socket.connect                     ‘self’, ‘address’                                           *note [1]: 66a.*note [2]: 25db.
                                                                                               
                                                                                               
socket.getaddrinfo                 ‘host’, ‘port’, ‘family’, ‘type’, ‘protocol’                *note [1]: 24ff.
                                                                                               
                                                                                               
socket.gethostbyaddr               ‘ip_address’                                                *note [1]: 25b2.
                                                                                               
                                                                                               
socket.gethostbyname               ‘hostname’                                                  *note [1]: 25d0.*note [2]: 25b1.
                                                                                               
                                                                                               
socket.gethostname                                                                             *note [1]: 1e41.
                                                                                               
                                                                                               
socket.getnameinfo                 ‘sockaddr’                                                  *note [1]: 2500.
                                                                                               
                                                                                               
socket.getservbyname               ‘servicename’, ‘protocolname’                               *note [1]: 25d2.
                                                                                               
                                                                                               
socket.getservbyport               ‘port’, ‘protocolname’                                      *note [1]: 25d3.
                                                                                               
                                                                                               
socket.sendmsg                     ‘self’, ‘address’                                           *note [1]: 670.
                                                                                               
                                                                                               
socket.sendto                      ‘self’, ‘address’                                           *note [1]: 671.
                                                                                               
                                                                                               
socket.sethostname                 ‘name’                                                      *note [1]: a7c.
                                                                                               
                                                                                               
sqlite3.connect                    ‘database’                                                  *note [1]: 3cf.
                                                                                               
                                                                                               
subprocess.Popen                   ‘executable’, ‘args’, ‘cwd’, ‘env’                          *note [1]: 2b7.
                                                                                               
                                                                                               
sys._current_frames                                                                            *note [1]: d8e.
                                                                                               
                                                                                               
sys._getframe                                                                                  *note [1]: e58.
                                                                                               
                                                                                               
sys.addaudithook                                                                               *note [1]: 3406.*note [2]: 3405.
                                                                                               
                                                                                               
sys.excepthook                     ‘hook’, ‘type’, ‘value’, ‘traceback’                        *note [1]: e57.
                                                                                               
                                                                                               
sys.set_asyncgen_hooks_finalizer                                                               *note [1]: 144a.
                                                                                               
                                                                                               
sys.set_asyncgen_hooks_firstiter                                                               *note [1]: 144a.
                                                                                               
                                                                                               
sys.setprofile                                                                                 *note [1]: e30.
                                                                                               
                                                                                               
sys.settrace                                                                                   *note [1]: e31.
                                                                                               
                                                                                               
sys.unraisablehook                 ‘hook’, ‘unraisable’                                        *note [1]: 22b.
                                                                                               
                                                                                               
telnetlib.Telnet.open              ‘self’, ‘host’, ‘port’                                      *note [1]: 2d17.
                                                                                               
                                                                                               
telnetlib.Telnet.write             ‘self’, ‘buffer’                                            *note [1]: 2d27.
                                                                                               
                                                                                               
tempfile.mkdtemp                   ‘fullpath’                                                  *note [1]: bbb.*note [2]: 1ba1.
                                                                                               
                                                                                               
tempfile.mkstemp                   ‘fullpath’                                                  *note [1]: d3c.*note [2]: 1b9f.*note [3]: 1ba0.
                                                                                               
                                                                                               
urllib.Request                     ‘fullurl’, ‘data’, ‘headers’, ‘method’                      *note [1]: 780.
                                                                                               
                                                                                               
webbrowser.open                    ‘url’                                                       *note [1]: 2b06.
                                                                                               
                                                                                               
winreg.ConnectRegistry             ‘computer_name’, ‘key’                                      *note [1]: 3410.
                                                                                               
                                                                                               
winreg.CreateKey                   ‘key’, ‘sub_key’, ‘access’                                  *note [1]: 3411.*note [2]: 3412.
                                                                                               
                                                                                               
winreg.DeleteKey                   ‘key’, ‘sub_key’, ‘access’                                  *note [1]: 3413.*note [2]: 3414.
                                                                                               
                                                                                               
winreg.DeleteValue                 ‘key’, ‘value’                                              *note [1]: 3415.
                                                                                               
                                                                                               
winreg.DisableReflectionKey        ‘key’                                                       *note [1]: 3416.
                                                                                               
                                                                                               
winreg.EnableReflectionKey         ‘key’                                                       *note [1]: 3417.
                                                                                               
                                                                                               
winreg.EnumKey                     ‘key’, ‘index’                                              *note [1]: 3418.
                                                                                               
                                                                                               
winreg.EnumValue                   ‘key’, ‘index’                                              *note [1]: 3419.
                                                                                               
                                                                                               
winreg.ExpandEnvironmentStrings    ‘str’                                                       *note [1]: 341a.
                                                                                               
                                                                                               
winreg.LoadKey                     ‘key’, ‘sub_key’, ‘file_name’                               *note [1]: 341b.
                                                                                               
                                                                                               
winreg.OpenKey                     ‘key’, ‘sub_key’, ‘access’                                  *note [1]: 341c.
                                                                                               
                                                                                               
winreg.OpenKey/result              ‘key’                                                       *note [1]: 3411.*note [2]: 3412.*note [3]: 341c.
                                                                                               
                                                                                               
winreg.PyHKEY.Detach               ‘key’                                                       *note [1]: 341d.
                                                                                               
                                                                                               
winreg.QueryInfoKey                ‘key’                                                       *note [1]: 341e.
                                                                                               
                                                                                               
winreg.QueryReflectionKey          ‘key’                                                       *note [1]: 341f.
                                                                                               
                                                                                               
winreg.QueryValue                  ‘key’, ‘sub_key’, ‘value_name’                              *note [1]: 3420.*note [2]: 3421.
                                                                                               
                                                                                               
winreg.SaveKey                     ‘key’, ‘file_name’                                          *note [1]: 3422.
                                                                                               
                                                                                               
winreg.SetValue                    ‘key’, ‘sub_key’, ‘type’, ‘value’                           *note [1]: 3423.*note [2]: 3424.
                                                                                               


File: python.info,  Node: bdb — Debugger framework,  Next: faulthandler — Dump the Python traceback,  Prev: Audit events table,  Up: Debugging and Profiling

5.28.2 ‘bdb’ — Debugger framework
---------------------------------

`Source code:' Lib/bdb.py(1)

__________________________________________________________________

The *note bdb: f. module handles basic debugger functions, like setting
breakpoints or managing execution via the debugger.

The following exception is defined:

 -- Exception: bdb.BdbQuit

     Exception raised by the *note Bdb: c8b. class for quitting the
     debugger.

The *note bdb: f. module also defines two classes:

 -- Class: bdb.Breakpoint (self, file, line, temporary=0, cond=None,
          funcname=None)

     This class implements temporary breakpoints, ignore counts,
     disabling and (re-)enabling, and conditionals.

     Breakpoints are indexed by number through a list called
     ‘bpbynumber’ and by ‘(file, line)’ pairs through ‘bplist’.  The
     former points to a single instance of class *note Breakpoint: 3428.
     The latter points to a list of such instances since there may be
     more than one breakpoint per line.

     When creating a breakpoint, its associated filename should be in
     canonical form.  If a `funcname' is defined, a breakpoint hit will
     be counted when the first line of that function is executed.  A
     conditional breakpoint always counts a hit.

     *note Breakpoint: 3428. instances have the following methods:

      -- Method: deleteMe ()

          Delete the breakpoint from the list associated to a file/line.
          If it is the last breakpoint in that position, it also deletes
          the entry for the file/line.

      -- Method: enable ()

          Mark the breakpoint as enabled.

      -- Method: disable ()

          Mark the breakpoint as disabled.

      -- Method: bpformat ()

          Return a string with all the information about the breakpoint,
          nicely formatted:

             * The breakpoint number.

             * If it is temporary or not.

             * Its file,line position.

             * The condition that causes a break.

             * If it must be ignored the next N times.

             * The breakpoint hit count.

          New in version 3.2.

      -- Method: bpprint (out=None)

          Print the output of *note bpformat(): 342c. to the file `out',
          or if it is ‘None’, to standard output.

 -- Class: bdb.Bdb (skip=None)

     The *note Bdb: c8b. class acts as a generic Python debugger base
     class.

     This class takes care of the details of the trace facility; a
     derived class should implement user interaction.  The standard
     debugger class (*note pdb.Pdb: 561.) is an example.

     The `skip' argument, if given, must be an iterable of glob-style
     module name patterns.  The debugger will not step into frames that
     originate in a module that matches one of these patterns.  Whether
     a frame is considered to originate in a certain module is
     determined by the ‘__name__’ in the frame globals.

     New in version 3.1: The `skip' argument.

     The following methods of *note Bdb: c8b. normally don’t need to be
     overridden.

      -- Method: canonic (filename)

          Auxiliary method for getting a filename in a canonical form,
          that is, as a case-normalized (on case-insensitive
          filesystems) absolute path, stripped of surrounding angle
          brackets.

      -- Method: reset ()

          Set the ‘botframe’, ‘stopframe’, ‘returnframe’ and ‘quitting’
          attributes with values ready to start debugging.

      -- Method: trace_dispatch (frame, event, arg)

          This function is installed as the trace function of debugged
          frames.  Its return value is the new trace function (in most
          cases, that is, itself).

          The default implementation decides how to dispatch a frame,
          depending on the type of event (passed as a string) that is
          about to be executed.  `event' can be one of the following:

             * ‘"line"’: A new line of code is going to be executed.

             * ‘"call"’: A function is about to be called, or another
               code block entered.

             * ‘"return"’: A function or other code block is about to
               return.

             * ‘"exception"’: An exception has occurred.

             * ‘"c_call"’: A C function is about to be called.

             * ‘"c_return"’: A C function has returned.

             * ‘"c_exception"’: A C function has raised an exception.

          For the Python events, specialized functions (see below) are
          called.  For the C events, no action is taken.

          The `arg' parameter depends on the previous event.

          See the documentation for *note sys.settrace(): e31. for more
          information on the trace function.  For more information on
          code and frame objects, refer to *note The standard type
          hierarchy: 135c.

      -- Method: dispatch_line (frame)

          If the debugger should stop on the current line, invoke the
          *note user_line(): 3432. method (which should be overridden in
          subclasses).  Raise a *note BdbQuit: 3427. exception if the
          ‘Bdb.quitting’ flag is set (which can be set from *note
          user_line(): 3432.).  Return a reference to the *note
          trace_dispatch(): 3430. method for further tracing in that
          scope.

      -- Method: dispatch_call (frame, arg)

          If the debugger should stop on this function call, invoke the
          *note user_call(): 3434. method (which should be overridden in
          subclasses).  Raise a *note BdbQuit: 3427. exception if the
          ‘Bdb.quitting’ flag is set (which can be set from *note
          user_call(): 3434.).  Return a reference to the *note
          trace_dispatch(): 3430. method for further tracing in that
          scope.

      -- Method: dispatch_return (frame, arg)

          If the debugger should stop on this function return, invoke
          the *note user_return(): 3436. method (which should be
          overridden in subclasses).  Raise a *note BdbQuit: 3427.
          exception if the ‘Bdb.quitting’ flag is set (which can be set
          from *note user_return(): 3436.).  Return a reference to the
          *note trace_dispatch(): 3430. method for further tracing in
          that scope.

      -- Method: dispatch_exception (frame, arg)

          If the debugger should stop at this exception, invokes the
          *note user_exception(): 3438. method (which should be
          overridden in subclasses).  Raise a *note BdbQuit: 3427.
          exception if the ‘Bdb.quitting’ flag is set (which can be set
          from *note user_exception(): 3438.).  Return a reference to
          the *note trace_dispatch(): 3430. method for further tracing
          in that scope.

     Normally derived classes don’t override the following methods, but
     they may if they want to redefine the definition of stopping and
     breakpoints.

      -- Method: stop_here (frame)

          This method checks if the `frame' is somewhere below
          ‘botframe’ in the call stack.  ‘botframe’ is the frame in
          which debugging started.

      -- Method: break_here (frame)

          This method checks if there is a breakpoint in the filename
          and line belonging to `frame' or, at least, in the current
          function.  If the breakpoint is a temporary one, this method
          deletes it.

      -- Method: break_anywhere (frame)

          This method checks if there is a breakpoint in the filename of
          the current frame.

     Derived classes should override these methods to gain control over
     debugger operation.

      -- Method: user_call (frame, argument_list)

          This method is called from *note dispatch_call(): 3433. when
          there is the possibility that a break might be necessary
          anywhere inside the called function.

      -- Method: user_line (frame)

          This method is called from *note dispatch_line(): 3431. when
          either *note stop_here(): 3439. or *note break_here(): 343a.
          yields ‘True’.

      -- Method: user_return (frame, return_value)

          This method is called from *note dispatch_return(): 3435. when
          *note stop_here(): 3439. yields ‘True’.

      -- Method: user_exception (frame, exc_info)

          This method is called from *note dispatch_exception(): 3437.
          when *note stop_here(): 3439. yields ‘True’.

      -- Method: do_clear (arg)

          Handle how a breakpoint must be removed when it is a temporary
          one.

          This method must be implemented by derived classes.

     Derived classes and clients can call the following methods to
     affect the stepping state.

      -- Method: set_step ()

          Stop after one line of code.

      -- Method: set_next (frame)

          Stop on the next line in or below the given frame.

      -- Method: set_return (frame)

          Stop when returning from the given frame.

      -- Method: set_until (frame)

          Stop when the line with the line no greater than the current
          one is reached or when returning from current frame.

      -- Method: set_trace ([frame])

          Start debugging from `frame'.  If `frame' is not specified,
          debugging starts from caller’s frame.

      -- Method: set_continue ()

          Stop only at breakpoints or when finished.  If there are no
          breakpoints, set the system trace function to ‘None’.

      -- Method: set_quit ()

          Set the ‘quitting’ attribute to ‘True’.  This raises *note
          BdbQuit: 3427. in the next call to one of the ‘dispatch_*()’
          methods.

     Derived classes and clients can call the following methods to
     manipulate breakpoints.  These methods return a string containing
     an error message if something went wrong, or ‘None’ if all is well.

      -- Method: set_break (filename, lineno, temporary=0, cond,
               funcname)

          Set a new breakpoint.  If the `lineno' line doesn’t exist for
          the `filename' passed as argument, return an error message.
          The `filename' should be in canonical form, as described in
          the *note canonic(): 342e. method.

      -- Method: clear_break (filename, lineno)

          Delete the breakpoints in `filename' and `lineno'.  If none
          were set, an error message is returned.

      -- Method: clear_bpbynumber (arg)

          Delete the breakpoint which has the index `arg' in the
          ‘Breakpoint.bpbynumber’.  If `arg' is not numeric or out of
          range, return an error message.

      -- Method: clear_all_file_breaks (filename)

          Delete all breakpoints in `filename'.  If none were set, an
          error message is returned.

      -- Method: clear_all_breaks ()

          Delete all existing breakpoints.

      -- Method: get_bpbynumber (arg)

          Return a breakpoint specified by the given number.  If `arg'
          is a string, it will be converted to a number.  If `arg' is a
          non-numeric string, if the given breakpoint never existed or
          has been deleted, a *note ValueError: 1f9. is raised.

          New in version 3.2.

      -- Method: get_break (filename, lineno)

          Check if there is a breakpoint for `lineno' of `filename'.

      -- Method: get_breaks (filename, lineno)

          Return all breakpoints for `lineno' in `filename', or an empty
          list if none are set.

      -- Method: get_file_breaks (filename)

          Return all breakpoints in `filename', or an empty list if none
          are set.

      -- Method: get_all_breaks ()

          Return all breakpoints that are set.

     Derived classes and clients can call the following methods to get a
     data structure representing a stack trace.

      -- Method: get_stack (f, t)

          Get a list of records for a frame and all higher (calling) and
          lower frames, and the size of the higher part.

      -- Method: format_stack_entry (frame_lineno, lprefix=': ')

          Return a string with information about a stack entry,
          identified by a ‘(frame, lineno)’ tuple:

             * The canonical form of the filename which contains the
               frame.

             * The function name, or ‘"<lambda>"’.

             * The input arguments.

             * The return value.

             * The line of code (if it exists).

     The following two methods can be called by clients to use a
     debugger to debug a *note statement: 1aca, given as a string.

      -- Method: run (cmd, globals=None, locals=None)

          Debug a statement executed via the *note exec(): c37.
          function.  `globals' defaults to ‘__main__.__dict__’, `locals'
          defaults to `globals'.

      -- Method: runeval (expr, globals=None, locals=None)

          Debug an expression executed via the *note eval(): b83.
          function.  `globals' and `locals' have the same meaning as in
          *note run(): 3450.

      -- Method: runctx (cmd, globals, locals)

          For backwards compatibility.  Calls the *note run(): 3450.
          method.

      -- Method: runcall (func, *args, **kwds)

          Debug a single function call, and return its result.

Finally, the module defines the following functions:

 -- Function: bdb.checkfuncname (b, frame)

     Check whether we should break here, depending on the way the
     breakpoint `b' was set.

     If it was set via line number, it checks if ‘b.line’ is the same as
     the one in the frame also passed as argument.  If the breakpoint
     was set via function name, we have to check we are in the right
     frame (the right function) and if we are in its first executable
     line.

 -- Function: bdb.effective (file, line, frame)

     Determine if there is an effective (active) breakpoint at this line
     of code.  Return a tuple of the breakpoint and a boolean that
     indicates if it is ok to delete a temporary breakpoint.  Return
     ‘(None, None)’ if there is no matching breakpoint.

 -- Function: bdb.set_trace ()

     Start debugging with a *note Bdb: c8b. instance from caller’s
     frame.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/bdb.py


File: python.info,  Node: faulthandler — Dump the Python traceback,  Next: pdb — The Python Debugger,  Prev: bdb — Debugger framework,  Up: Debugging and Profiling

5.28.3 ‘faulthandler’ — Dump the Python traceback
-------------------------------------------------

New in version 3.3.

__________________________________________________________________

This module contains functions to dump Python tracebacks explicitly, on
a fault, after a timeout, or on a user signal.  Call *note
faulthandler.enable(): 53d. to install fault handlers for the ‘SIGSEGV’,
‘SIGFPE’, ‘SIGABRT’, ‘SIGBUS’, and ‘SIGILL’ signals.  You can also
enable them at startup by setting the *note PYTHONFAULTHANDLER: 9bc.
environment variable or by using the *note -X: 155. ‘faulthandler’
command line option.

The fault handler is compatible with system fault handlers like Apport
or the Windows fault handler.  The module uses an alternative stack for
signal handlers if the ‘sigaltstack()’ function is available.  This
allows it to dump the traceback even on a stack overflow.

The fault handler is called on catastrophic cases and therefore can only
use signal-safe functions (e.g.  it cannot allocate memory on the heap).
Because of this limitation traceback dumping is minimal compared to
normal Python tracebacks:

   * Only ASCII is supported.  The ‘backslashreplace’ error handler is
     used on encoding.

   * Each string is limited to 500 characters.

   * Only the filename, the function name and the line number are
     displayed.  (no source code)

   * It is limited to 100 frames and 100 threads.

   * The order is reversed: the most recent call is shown first.

By default, the Python traceback is written to *note sys.stderr: 304.
To see tracebacks, applications must be run in the terminal.  A log file
can alternatively be passed to *note faulthandler.enable(): 53d.

The module is implemented in C, so tracebacks can be dumped on a crash
or when Python is deadlocked.

* Menu:

* Dumping the traceback::
* Fault handler state::
* Dumping the tracebacks after a timeout::
* Dumping the traceback on a user signal::
* Issue with file descriptors::
* Example: Example<15>.


File: python.info,  Node: Dumping the traceback,  Next: Fault handler state,  Up: faulthandler — Dump the Python traceback

5.28.3.1 Dumping the traceback
..............................

 -- Function: faulthandler.dump_traceback (file=sys.stderr,
          all_threads=True)

     Dump the tracebacks of all threads into `file'.  If `all_threads'
     is ‘False’, dump only the current thread.

     Changed in version 3.5: Added support for passing file descriptor
     to this function.


File: python.info,  Node: Fault handler state,  Next: Dumping the tracebacks after a timeout,  Prev: Dumping the traceback,  Up: faulthandler — Dump the Python traceback

5.28.3.2 Fault handler state
............................

 -- Function: faulthandler.enable (file=sys.stderr, all_threads=True)

     Enable the fault handler: install handlers for the ‘SIGSEGV’,
     ‘SIGFPE’, ‘SIGABRT’, ‘SIGBUS’ and ‘SIGILL’ signals to dump the
     Python traceback.  If `all_threads' is ‘True’, produce tracebacks
     for every running thread.  Otherwise, dump only the current thread.

     The `file' must be kept open until the fault handler is disabled:
     see *note issue with file descriptors: 345a.

     Changed in version 3.5: Added support for passing file descriptor
     to this function.

     Changed in version 3.6: On Windows, a handler for Windows exception
     is also installed.

 -- Function: faulthandler.disable ()

     Disable the fault handler: uninstall the signal handlers installed
     by *note enable(): 53d.

 -- Function: faulthandler.is_enabled ()

     Check if the fault handler is enabled.


File: python.info,  Node: Dumping the tracebacks after a timeout,  Next: Dumping the traceback on a user signal,  Prev: Fault handler state,  Up: faulthandler — Dump the Python traceback

5.28.3.3 Dumping the tracebacks after a timeout
...............................................

 -- Function: faulthandler.dump_traceback_later (timeout, repeat=False,
          file=sys.stderr, exit=False)

     Dump the tracebacks of all threads, after a timeout of `timeout'
     seconds, or every `timeout' seconds if `repeat' is ‘True’.  If
     `exit' is ‘True’, call ‘_exit()’ with status=1 after dumping the
     tracebacks.  (Note ‘_exit()’ exits the process immediately, which
     means it doesn’t do any cleanup like flushing file buffers.)  If
     the function is called twice, the new call replaces previous
     parameters and resets the timeout.  The timer has a sub-second
     resolution.

     The `file' must be kept open until the traceback is dumped or *note
     cancel_dump_traceback_later(): 345e. is called: see *note issue
     with file descriptors: 345a.

     This function is implemented using a watchdog thread.

     Changed in version 3.7: This function is now always available.

     Changed in version 3.5: Added support for passing file descriptor
     to this function.

 -- Function: faulthandler.cancel_dump_traceback_later ()

     Cancel the last call to *note dump_traceback_later(): 6cd.


File: python.info,  Node: Dumping the traceback on a user signal,  Next: Issue with file descriptors,  Prev: Dumping the tracebacks after a timeout,  Up: faulthandler — Dump the Python traceback

5.28.3.4 Dumping the traceback on a user signal
...............................................

 -- Function: faulthandler.register (signum, file=sys.stderr,
          all_threads=True, chain=False)

     Register a user signal: install a handler for the `signum' signal
     to dump the traceback of all threads, or of the current thread if
     `all_threads' is ‘False’, into `file'.  Call the previous handler
     if chain is ‘True’.

     The `file' must be kept open until the signal is unregistered by
     *note unregister(): 3460.: see *note issue with file descriptors:
     345a.

     Not available on Windows.

     Changed in version 3.5: Added support for passing file descriptor
     to this function.

 -- Function: faulthandler.unregister (signum)

     Unregister a user signal: uninstall the handler of the `signum'
     signal installed by *note register(): 6cb.  Return ‘True’ if the
     signal was registered, ‘False’ otherwise.

     Not available on Windows.


File: python.info,  Node: Issue with file descriptors,  Next: Example<15>,  Prev: Dumping the traceback on a user signal,  Up: faulthandler — Dump the Python traceback

5.28.3.5 Issue with file descriptors
....................................

*note enable(): 53d, *note dump_traceback_later(): 6cd. and *note
register(): 6cb. keep the file descriptor of their `file' argument.  If
the file is closed and its file descriptor is reused by a new file, or
if *note os.dup2(): 3b3. is used to replace the file descriptor, the
traceback will be written into a different file.  Call these functions
again each time that the file is replaced.


File: python.info,  Node: Example<15>,  Prev: Issue with file descriptors,  Up: faulthandler — Dump the Python traceback

5.28.3.6 Example
................

Example of a segmentation fault on Linux with and without enabling the
fault handler:

     $ python3 -c "import ctypes; ctypes.string_at(0)" Segmentation fault  $ python3 -q -X faulthandler >>> import ctypes >>> ctypes.string_at(0) Fatal Python error: Segmentation fault  Current thread 0x00007fb899f39700 (most recent call first):   File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at   File "<stdin>", line 1 in <module> Segmentation fault


File: python.info,  Node: pdb — The Python Debugger,  Next: The Python Profilers,  Prev: faulthandler — Dump the Python traceback,  Up: Debugging and Profiling

5.28.4 ‘pdb’ — The Python Debugger
----------------------------------

`Source code:' Lib/pdb.py(1)

__________________________________________________________________

The module *note pdb: c9. defines an interactive source code debugger
for Python programs.  It supports setting (conditional) breakpoints and
single stepping at the source line level, inspection of stack frames,
source code listing, and evaluation of arbitrary Python code in the
context of any stack frame.  It also supports post-mortem debugging and
can be called under program control.

The debugger is extensible – it is actually defined as the class *note
Pdb: 561.  This is currently undocumented but easily understood by
reading the source.  The extension interface uses the modules *note bdb:
f. and *note cmd: 1a.

The debugger’s prompt is ‘(Pdb)’.  Typical usage to run a program under
control of the debugger is:

     >>> import pdb >>> import mymodule >>> pdb.run('mymodule.test()') > <string>(0)?() (Pdb) continue > <string>(1)?() (Pdb) continue NameError: 'spam' > <string>(1)?() (Pdb)

Changed in version 3.3: Tab-completion via the *note readline: de.
module is available for commands and command arguments, e.g.  the
current global and local names are offered as arguments of the ‘p’
command.

‘pdb.py’ can also be invoked as a script to debug other scripts.  For
example:

     python3 -m pdb myscript.py

When invoked as a script, pdb will automatically enter post-mortem
debugging if the program being debugged exits abnormally.  After
post-mortem debugging (or after normal exit of the program), pdb will
restart the program.  Automatic restarting preserves pdb’s state (such
as breakpoints) and in most cases is more useful than quitting the
debugger upon program’s exit.

New in version 3.2: ‘pdb.py’ now accepts a ‘-c’ option that executes
commands as if given in a ‘.pdbrc’ file, see *note Debugger Commands:
3466.

New in version 3.7: ‘pdb.py’ now accepts a ‘-m’ option that execute
modules similar to the way ‘python3 -m’ does.  As with a script, the
debugger will pause execution just before the first line of the module.

The typical usage to break into the debugger from a running program is
to insert

     import pdb; pdb.set_trace()

at the location you want to break into the debugger.  You can then step
through the code following this statement, and continue running without
the debugger using the *note continue: 3467. command.

New in version 3.7: The built-in *note breakpoint(): 2ee, when called
with defaults, can be used instead of ‘import pdb; pdb.set_trace()’.

The typical usage to inspect a crashed program is:

     >>> import pdb >>> import mymodule >>> mymodule.test() Traceback (most recent call last):   File "<stdin>", line 1, in <module>   File "./mymodule.py", line 4, in test     test2()   File "./mymodule.py", line 3, in test2     print(spam) NameError: spam >>> pdb.pm() > ./mymodule.py(3)test2() -> print(spam) (Pdb)

The module defines the following functions; each enters the debugger in
a slightly different way:

 -- Function: pdb.run (statement, globals=None, locals=None)

     Execute the `statement' (given as a string or a code object) under
     debugger control.  The debugger prompt appears before any code is
     executed; you can set breakpoints and type *note continue: 3467, or
     you can step through the statement using *note step: 3468. or *note
     next: 3469. (all these commands are explained below).  The optional
     `globals' and `locals' arguments specify the environment in which
     the code is executed; by default the dictionary of the module *note
     __main__: 1. is used.  (See the explanation of the built-in *note
     exec(): c37. or *note eval(): b83. functions.)

 -- Function: pdb.runeval (expression, globals=None, locals=None)

     Evaluate the `expression' (given as a string or a code object)
     under debugger control.  When *note runeval(): 346a. returns, it
     returns the value of the expression.  Otherwise this function is
     similar to *note run(): 324b.

 -- Function: pdb.runcall (function, *args, **kwds)

     Call the `function' (a function or method object, not a string)
     with the given arguments.  When *note runcall(): 346b. returns, it
     returns whatever the function call returned.  The debugger prompt
     appears as soon as the function is entered.

 -- Function: pdb.set_trace (*, header=None)

     Enter the debugger at the calling stack frame.  This is useful to
     hard-code a breakpoint at a given point in a program, even if the
     code is not otherwise being debugged (e.g.  when an assertion
     fails).  If given, `header' is printed to the console just before
     debugging begins.

     Changed in version 3.7: The keyword-only argument `header'.

 -- Function: pdb.post_mortem (traceback=None)

     Enter post-mortem debugging of the given `traceback' object.  If no
     `traceback' is given, it uses the one of the exception that is
     currently being handled (an exception must be being handled if the
     default is to be used).

 -- Function: pdb.pm ()

     Enter post-mortem debugging of the traceback found in *note
     sys.last_traceback: 346d.

The ‘run*’ functions and *note set_trace(): 3b7. are aliases for
instantiating the *note Pdb: 561. class and calling the method of the
same name.  If you want to access further features, you have to do this
yourself:

 -- Class: pdb.Pdb (completekey='tab', stdin=None, stdout=None,
          skip=None, nosigint=False, readrc=True)

     *note Pdb: 561. is the debugger class.

     The `completekey', `stdin' and `stdout' arguments are passed to the
     underlying *note cmd.Cmd: 3073. class; see the description there.

     The `skip' argument, if given, must be an iterable of glob-style
     module name patterns.  The debugger will not step into frames that
     originate in a module that matches one of these patterns.  (2)

     By default, Pdb sets a handler for the SIGINT signal (which is sent
     when the user presses ‘Ctrl-C’ on the console) when you give a
     ‘continue’ command.  This allows you to break into the debugger
     again by pressing ‘Ctrl-C’.  If you want Pdb not to touch the
     SIGINT handler, set `nosigint' to true.

     The `readrc' argument defaults to true and controls whether Pdb
     will load .pdbrc files from the filesystem.

     Example call to enable tracing with `skip':

          import pdb; pdb.Pdb(skip=['django.*']).set_trace()

     Raises an *note auditing event: 1275. ‘pdb.Pdb’ with no arguments.

     New in version 3.1: The `skip' argument.

     New in version 3.2: The `nosigint' argument.  Previously, a SIGINT
     handler was never set by Pdb.

     Changed in version 3.6: The `readrc' argument.

      -- Method: run (statement, globals=None, locals=None)
      -- Method: runeval (expression, globals=None, locals=None)
      -- Method: runcall (function, *args, **kwds)
      -- Method: set_trace ()

          See the documentation for the functions explained above.

* Menu:

* Debugger Commands::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pdb.py

   (2) (1) Whether a frame is considered to originate in a certain
module is determined by the ‘__name__’ in the frame globals.


File: python.info,  Node: Debugger Commands,  Up: pdb — The Python Debugger

5.28.4.1 Debugger Commands
..........................

The commands recognized by the debugger are listed below.  Most commands
can be abbreviated to one or two letters as indicated; e.g.  ‘h(elp)’
means that either ‘h’ or ‘help’ can be used to enter the help command
(but not ‘he’ or ‘hel’, nor ‘H’ or ‘Help’ or ‘HELP’).  Arguments to
commands must be separated by whitespace (spaces or tabs).  Optional
arguments are enclosed in square brackets (‘[]’) in the command syntax;
the square brackets must not be typed.  Alternatives in the command
syntax are separated by a vertical bar (‘|’).

Entering a blank line repeats the last command entered.  Exception: if
the last command was a *note list: 3473. command, the next 11 lines are
listed.

Commands that the debugger doesn’t recognize are assumed to be Python
statements and are executed in the context of the program being
debugged.  Python statements can also be prefixed with an exclamation
point (‘!’).  This is a powerful way to inspect the program being
debugged; it is even possible to change a variable or call a function.
When an exception occurs in such a statement, the exception name is
printed but the debugger’s state is not changed.

The debugger supports *note aliases: 3474.  Aliases can have parameters
which allows one a certain level of adaptability to the context under
examination.

Multiple commands may be entered on a single line, separated by ‘;;’.
(A single ‘;’ is not used as it is the separator for multiple commands
in a line that is passed to the Python parser.)  No intelligence is
applied to separating the commands; the input is split at the first ‘;;’
pair, even if it is in the middle of a quoted string.

If a file ‘.pdbrc’ exists in the user’s home directory or in the current
directory, it is read in and executed as if it had been typed at the
debugger prompt.  This is particularly useful for aliases.  If both
files exist, the one in the home directory is read first and aliases
defined there can be overridden by the local file.

Changed in version 3.2: ‘.pdbrc’ can now contain commands that continue
debugging, such as *note continue: 3467. or *note next: 3469.
Previously, these commands had no effect.

 -- Pdbcommand: h(elp) [command]

     Without argument, print the list of available commands.  With a
     `command' as argument, print help about that command.  ‘help pdb’
     displays the full documentation (the docstring of the *note pdb:
     c9. module).  Since the `command' argument must be an identifier,
     ‘help exec’ must be entered to get help on the ‘!’ command.

 -- Pdbcommand: w(here)

     Print a stack trace, with the most recent frame at the bottom.  An
     arrow indicates the current frame, which determines the context of
     most commands.

 -- Pdbcommand: d(own) [count]

     Move the current frame `count' (default one) levels down in the
     stack trace (to a newer frame).

 -- Pdbcommand: u(p) [count]

     Move the current frame `count' (default one) levels up in the stack
     trace (to an older frame).

 -- Pdbcommand: b(reak) [([filename:]lineno | function) [, condition]]

     With a `lineno' argument, set a break there in the current file.
     With a `function' argument, set a break at the first executable
     statement within that function.  The line number may be prefixed
     with a filename and a colon, to specify a breakpoint in another
     file (probably one that hasn’t been loaded yet).  The file is
     searched on *note sys.path: 47d.  Note that each breakpoint is
     assigned a number to which all the other breakpoint commands refer.

     If a second argument is present, it is an expression which must
     evaluate to true before the breakpoint is honored.

     Without argument, list all breaks, including for each breakpoint,
     the number of times that breakpoint has been hit, the current
     ignore count, and the associated condition if any.

 -- Pdbcommand: tbreak [([filename:]lineno | function) [, condition]]

     Temporary breakpoint, which is removed automatically when it is
     first hit.  The arguments are the same as for *note break: 3479.

 -- Pdbcommand: cl(ear) [filename:lineno | bpnumber [bpnumber ...]]

     With a `filename:lineno' argument, clear all the breakpoints at
     this line.  With a space separated list of breakpoint numbers,
     clear those breakpoints.  Without argument, clear all breaks (but
     first ask confirmation).

 -- Pdbcommand: disable [bpnumber [bpnumber ...]]

     Disable the breakpoints given as a space separated list of
     breakpoint numbers.  Disabling a breakpoint means it cannot cause
     the program to stop execution, but unlike clearing a breakpoint, it
     remains in the list of breakpoints and can be (re-)enabled.

 -- Pdbcommand: enable [bpnumber [bpnumber ...]]

     Enable the breakpoints specified.

 -- Pdbcommand: ignore bpnumber [count]

     Set the ignore count for the given breakpoint number.  If count is
     omitted, the ignore count is set to 0.  A breakpoint becomes active
     when the ignore count is zero.  When non-zero, the count is
     decremented each time the breakpoint is reached and the breakpoint
     is not disabled and any associated condition evaluates to true.

 -- Pdbcommand: condition bpnumber [condition]

     Set a new `condition' for the breakpoint, an expression which must
     evaluate to true before the breakpoint is honored.  If `condition'
     is absent, any existing condition is removed; i.e., the breakpoint
     is made unconditional.

 -- Pdbcommand: commands [bpnumber]

     Specify a list of commands for breakpoint number `bpnumber'.  The
     commands themselves appear on the following lines.  Type a line
     containing just ‘end’ to terminate the commands.  An example:

          (Pdb) commands 1 (com) p some_variable (com) end (Pdb)

     To remove all commands from a breakpoint, type ‘commands’ and
     follow it immediately with ‘end’; that is, give no commands.

     With no `bpnumber' argument, ‘commands’ refers to the last
     breakpoint set.

     You can use breakpoint commands to start your program up again.
     Simply use the *note continue: 3467. command, or *note step: 3468,
     or any other command that resumes execution.

     Specifying any command resuming execution (currently *note
     continue: 3467, *note step: 3468, *note next: 3469, *note return:
     3481, *note jump: 3482, *note quit: 3483. and their abbreviations)
     terminates the command list (as if that command was immediately
     followed by end).  This is because any time you resume execution
     (even with a simple next or step), you may encounter another
     breakpoint—which could have its own command list, leading to
     ambiguities about which list to execute.

     If you use the ‘silent’ command in the command list, the usual
     message about stopping at a breakpoint is not printed.  This may be
     desirable for breakpoints that are to print a specific message and
     then continue.  If none of the other commands print anything, you
     see no sign that the breakpoint was reached.

 -- Pdbcommand: s(tep)

     Execute the current line, stop at the first possible occasion
     (either in a function that is called or on the next line in the
     current function).

 -- Pdbcommand: n(ext)

     Continue execution until the next line in the current function is
     reached or it returns.  (The difference between *note next: 3469.
     and *note step: 3468. is that *note step: 3468. stops inside a
     called function, while *note next: 3469. executes called functions
     at (nearly) full speed, only stopping at the next line in the
     current function.)

 -- Pdbcommand: unt(il) [lineno]

     Without argument, continue execution until the line with a number
     greater than the current one is reached.

     With a line number, continue execution until a line with a number
     greater or equal to that is reached.  In both cases, also stop when
     the current frame returns.

     Changed in version 3.2: Allow giving an explicit line number.

 -- Pdbcommand: r(eturn)

     Continue execution until the current function returns.

 -- Pdbcommand: c(ont(inue))

     Continue execution, only stop when a breakpoint is encountered.

 -- Pdbcommand: j(ump) lineno

     Set the next line that will be executed.  Only available in the
     bottom-most frame.  This lets you jump back and execute code again,
     or jump forward to skip code that you don’t want to run.

     It should be noted that not all jumps are allowed – for instance it
     is not possible to jump into the middle of a *note for: c23. loop
     or out of a *note finally: 182. clause.

 -- Pdbcommand: l(ist) [first[, last]]

     List source code for the current file.  Without arguments, list 11
     lines around the current line or continue the previous listing.
     With ‘.’ as argument, list 11 lines around the current line.  With
     one argument, list 11 lines around at that line.  With two
     arguments, list the given range; if the second argument is less
     than the first, it is interpreted as a count.

     The current line in the current frame is indicated by ‘->’.  If an
     exception is being debugged, the line where the exception was
     originally raised or propagated is indicated by ‘>>’, if it differs
     from the current line.

     New in version 3.2: The ‘>>’ marker.

 -- Pdbcommand: ll | longlist

     List all source code for the current function or frame.
     Interesting lines are marked as for *note list: 3473.

     New in version 3.2.

 -- Pdbcommand: a(rgs)

     Print the argument list of the current function.

 -- Pdbcommand: p expression

     Evaluate the `expression' in the current context and print its
     value.

          Note: ‘print()’ can also be used, but is not a debugger
          command — this executes the Python *note print(): 87a.
          function.

 -- Pdbcommand: pp expression

     Like the *note p: 87b. command, except the value of the expression
     is pretty-printed using the *note pprint: d2. module.

 -- Pdbcommand: whatis expression

     Print the type of the `expression'.

 -- Pdbcommand: source expression

     Try to get source code for the given object and display it.

     New in version 3.2.

 -- Pdbcommand: display [expression]

     Display the value of the expression if it changed, each time
     execution stops in the current frame.

     Without expression, list all display expressions for the current
     frame.

     New in version 3.2.

 -- Pdbcommand: undisplay [expression]

     Do not display the expression any more in the current frame.
     Without expression, clear all display expressions for the current
     frame.

     New in version 3.2.

 -- Pdbcommand: interact

     Start an interactive interpreter (using the *note code: 1b. module)
     whose global namespace contains all the (global and local) names
     found in the current scope.

     New in version 3.2.

 -- Pdbcommand: alias [name [command]]

     Create an alias called `name' that executes `command'.  The command
     must `not' be enclosed in quotes.  Replaceable parameters can be
     indicated by ‘%1’, ‘%2’, and so on, while ‘%*’ is replaced by all
     the parameters.  If no command is given, the current alias for
     `name' is shown.  If no arguments are given, all aliases are
     listed.

     Aliases may be nested and can contain anything that can be legally
     typed at the pdb prompt.  Note that internal pdb commands `can' be
     overridden by aliases.  Such a command is then hidden until the
     alias is removed.  Aliasing is recursively applied to the first
     word of the command line; all other words in the line are left
     alone.

     As an example, here are two useful aliases (especially when placed
     in the ‘.pdbrc’ file):

          # Print instance variables (usage "pi classInst") alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k]) # Print instance variables in self alias ps pi self

 -- Pdbcommand: unalias name

     Delete the specified alias.

 -- Pdbcommand: ! statement

     Execute the (one-line) `statement' in the context of the current
     stack frame.  The exclamation point can be omitted unless the first
     word of the statement resembles a debugger command.  To set a
     global variable, you can prefix the assignment command with a *note
     global: 117e. statement on the same line, e.g.:

          (Pdb) global list_options; list_options = ['-l'] (Pdb)

 -- Pdbcommand: run [args ...]
 -- Pdbcommand: restart [args ...]

     Restart the debugged Python program.  If an argument is supplied,
     it is split with *note shlex: e8. and the result is used as the new
     *note sys.argv: bee.  History, breakpoints, actions and debugger
     options are preserved.  *note restart: 3491. is an alias for *note
     run: 3490.

 -- Pdbcommand: q(uit)

     Quit from the debugger.  The program being executed is aborted.

 -- Pdbcommand: debug code

     Enter a recursive debugger that steps through the code argument
     (which is an arbitrary expression or statement to be executed in
     the current environment).

 -- Pdbcommand: retval

 -- Pdbcommand: Print the return value for the last return of a
          function.


File: python.info,  Node: The Python Profilers,  Next: timeit — Measure execution time of small code snippets,  Prev: pdb — The Python Debugger,  Up: Debugging and Profiling

5.28.5 The Python Profilers
---------------------------

`Source code:' Lib/profile.py(1) and Lib/pstats.py(2)

__________________________________________________________________

* Menu:

* Introduction to the profilers::
* Instant User’s Manual::
* profile and cProfile Module Reference::
* The Stats Class::
* What Is Deterministic Profiling?::
* Limitations::
* Calibration::
* Using a custom timer::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/profile.py

   (2) https://github.com/python/cpython/tree/3.8/Lib/pstats.py


File: python.info,  Node: Introduction to the profilers,  Next: Instant User’s Manual,  Up: The Python Profilers

5.28.5.1 Introduction to the profilers
......................................

*note cProfile: 28. and *note profile: d3. provide `deterministic
profiling' of Python programs.  A `profile' is a set of statistics that
describes how often and for how long various parts of the program
executed.  These statistics can be formatted into reports via the *note
pstats: d4. module.

The Python standard library provides two different implementations of
the same profiling interface:

  1. *note cProfile: 28. is recommended for most users; it’s a C
     extension with reasonable overhead that makes it suitable for
     profiling long-running programs.  Based on ‘lsprof’, contributed by
     Brett Rosen and Ted Czotter.

  2. *note profile: d3, a pure Python module whose interface is imitated
     by *note cProfile: 28, but which adds significant overhead to
     profiled programs.  If you’re trying to extend the profiler in some
     way, the task might be easier with this module.  Originally
     designed and written by Jim Roskind.

     Note: The profiler modules are designed to provide an execution
     profile for a given program, not for benchmarking purposes (for
     that, there is *note timeit: 10b. for reasonably accurate results).
     This particularly applies to benchmarking Python code against C
     code: the profilers introduce overhead for Python code, but not for
     C-level functions, and so the C code would seem faster than any
     Python one.


File: python.info,  Node: Instant User’s Manual,  Next: profile and cProfile Module Reference,  Prev: Introduction to the profilers,  Up: The Python Profilers

5.28.5.2 Instant User’s Manual
..............................

This section is provided for users that “don’t want to read the manual.”
It provides a very brief overview, and allows a user to rapidly perform
profiling on an existing application.

To profile a function that takes a single argument, you can do:

     import cProfile import re cProfile.run('re.compile("foo|bar")')

(Use *note profile: d3. instead of *note cProfile: 28. if the latter is
not available on your system.)

The above action would run *note re.compile(): 43f. and print profile
results like the following:

           197 function calls (192 primitive calls) in 0.002 seconds  Ordered by: standard name  ncalls  tottime  percall  cumtime  percall filename:lineno(function)      1    0.000    0.000    0.001    0.001 <string>:1(<module>)      1    0.000    0.000    0.001    0.001 re.py:212(compile)      1    0.000    0.000    0.001    0.001 re.py:268(_compile)      1    0.000    0.000    0.000    0.000 sre_compile.py:172(_compile_charset)      1    0.000    0.000    0.000    0.000 sre_compile.py:201(_optimize_charset)      4    0.000    0.000    0.000    0.000 sre_compile.py:25(_identityfunction)    3/1    0.000    0.000    0.000    0.000 sre_compile.py:33(_compile)

The first line indicates that 197 calls were monitored.  Of those calls,
192 were `primitive', meaning that the call was not induced via
recursion.  The next line: ‘Ordered by: standard name’, indicates that
the text string in the far right column was used to sort the output.
The column headings include:

ncalls

     for the number of calls.

tottime

     for the total time spent in the given function (and excluding time
     made in calls to sub-functions)

percall

     is the quotient of ‘tottime’ divided by ‘ncalls’

cumtime

     is the cumulative time spent in this and all subfunctions (from
     invocation till exit).  This figure is accurate `even' for
     recursive functions.

percall

     is the quotient of ‘cumtime’ divided by primitive calls

filename:lineno(function)

     provides the respective data of each function

When there are two numbers in the first column (for example ‘3/1’), it
means that the function recursed.  The second value is the number of
primitive calls and the former is the total number of calls.  Note that
when the function does not recurse, these two values are the same, and
only the single figure is printed.

Instead of printing the output at the end of the profile run, you can
save the results to a file by specifying a filename to the ‘run()’
function:

     import cProfile import re cProfile.run('re.compile("foo|bar")', 'restats')

The *note pstats.Stats: 349b. class reads profile results from a file
and formats them in various ways.

The files *note cProfile: 28. and *note profile: d3. can also be invoked
as a script to profile another script.  For example:

     python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py)

‘-o’ writes the profile results to a file instead of to stdout

‘-s’ specifies one of the *note sort_stats(): 349c. sort values to sort
the output by.  This only applies when ‘-o’ is not supplied.

‘-m’ specifies that a module is being profiled instead of a script.

     New in version 3.7: Added the ‘-m’ option to *note cProfile: 28.

     New in version 3.8: Added the ‘-m’ option to *note profile: d3.

The *note pstats: d4. module’s *note Stats: 349b. class has a variety of
methods for manipulating and printing the data saved into a profile
results file:

     import pstats from pstats import SortKey p = pstats.Stats('restats') p.strip_dirs().sort_stats(-1).print_stats()

The *note strip_dirs(): 349d. method removed the extraneous path from
all the module names.  The *note sort_stats(): 349c. method sorted all
the entries according to the standard module/line/name string that is
printed.  The *note print_stats(): 349e. method printed out all the
statistics.  You might try the following sort calls:

     p.sort_stats(SortKey.NAME) p.print_stats()

The first call will actually sort the list by function name, and the
second call will print out the statistics.  The following are some
interesting calls to experiment with:

     p.sort_stats(SortKey.CUMULATIVE).print_stats(10)

This sorts the profile by cumulative time in a function, and then only
prints the ten most significant lines.  If you want to understand what
algorithms are taking time, the above line is what you would use.

If you were looking to see what functions were looping a lot, and taking
a lot of time, you would do:

     p.sort_stats(SortKey.TIME).print_stats(10)

to sort according to time spent within each function, and then print the
statistics for the top ten functions.

You might also try:

     p.sort_stats(SortKey.FILENAME).print_stats('__init__')

This will sort all the statistics by file name, and then print out
statistics for only the class init methods (since they are spelled with
‘__init__’ in them).  As one final example, you could try:

     p.sort_stats(SortKey.TIME, SortKey.CUMULATIVE).print_stats(.5, 'init')

This line sorts statistics with a primary key of time, and a secondary
key of cumulative time, and then prints out some of the statistics.  To
be specific, the list is first culled down to 50% (re: ‘.5’) of its
original size, then only lines containing ‘init’ are maintained, and
that sub-sub-list is printed.

If you wondered what functions called the above functions, you could now
(‘p’ is still sorted according to the last criteria) do:

     p.print_callers(.5, 'init')

and you would get a list of callers for each of the listed functions.

If you want more functionality, you’re going to have to read the manual,
or guess what the following functions do:

     p.print_callees() p.add('restats')

Invoked as a script, the *note pstats: d4. module is a statistics
browser for reading and examining profile dumps.  It has a simple
line-oriented interface (implemented using *note cmd: 1a.) and
interactive help.


File: python.info,  Node: profile and cProfile Module Reference,  Next: The Stats Class,  Prev: Instant User’s Manual,  Up: The Python Profilers

5.28.5.3 ‘profile’ and ‘cProfile’ Module Reference
..................................................

Both the *note profile: d3. and *note cProfile: 28. modules provide the
following functions:

 -- Function: profile.run (command, filename=None, sort=-1)

     This function takes a single argument that can be passed to the
     *note exec(): c37. function, and an optional file name.  In all
     cases this routine executes:

          exec(command, __main__.__dict__, __main__.__dict__)

     and gathers profiling statistics from the execution.  If no file
     name is present, then this function automatically creates a *note
     Stats: 349b. instance and prints a simple profiling report.  If the
     sort value is specified, it is passed to this *note Stats: 349b.
     instance to control how the results are sorted.

 -- Function: profile.runctx (command, globals, locals, filename=None,
          sort=-1)

     This function is similar to *note run(): 34a0, with added arguments
     to supply the globals and locals dictionaries for the `command'
     string.  This routine executes:

          exec(command, globals, locals)

     and gathers profiling statistics as in the *note run(): 34a0.
     function above.

 -- Class: profile.Profile (timer=None, timeunit=0.0, subcalls=True,
          builtins=True)

     This class is normally only used if more precise control over
     profiling is needed than what the ‘cProfile.run()’ function
     provides.

     A custom timer can be supplied for measuring how long code takes to
     run via the `timer' argument.  This must be a function that returns
     a single number representing the current time.  If the number is an
     integer, the `timeunit' specifies a multiplier that specifies the
     duration of each unit of time.  For example, if the timer returns
     times measured in thousands of seconds, the time unit would be
     ‘.001’.

     Directly using the *note Profile: 1b9. class allows formatting
     profile results without writing the profile data to a file:

          import cProfile, pstats, io from pstats import SortKey pr = cProfile.Profile() pr.enable() # ... do something ... pr.disable() s = io.StringIO() sortby = SortKey.CUMULATIVE ps = pstats.Stats(pr, stream=s).sort_stats(sortby) ps.print_stats() print(s.getvalue())

     The *note Profile: 1b9. class can also be used as a context manager
     (supported only in *note cProfile: 28. module.  see *note Context
     Manager Types: 13c4.):

          import cProfile  with cProfile.Profile() as pr:     # ... do something ...  pr.print_stats()

     Changed in version 3.8: Added context manager support.

      -- Method: enable ()

          Start collecting profiling data.  Only in *note cProfile: 28.

      -- Method: disable ()

          Stop collecting profiling data.  Only in *note cProfile: 28.

      -- Method: create_stats ()

          Stop collecting profiling data and record the results
          internally as the current profile.

      -- Method: print_stats (sort=-1)

          Create a *note Stats: 349b. object based on the current
          profile and print the results to stdout.

      -- Method: dump_stats (filename)

          Write the results of the current profile to `filename'.

      -- Method: run (cmd)

          Profile the cmd via *note exec(): c37.

      -- Method: runctx (cmd, globals, locals)

          Profile the cmd via *note exec(): c37. with the specified
          global and local environment.

      -- Method: runcall (func, *args, **kwargs)

          Profile ‘func(*args, **kwargs)’

Note that profiling will only work if the called command/function
actually returns.  If the interpreter is terminated (e.g.  via a *note
sys.exit(): cd5. call during the called command/function execution) no
profiling results will be printed.


File: python.info,  Node: The Stats Class,  Next: What Is Deterministic Profiling?,  Prev: profile and cProfile Module Reference,  Up: The Python Profilers

5.28.5.4 The ‘Stats’ Class
..........................

Analysis of the profiler data is done using the *note Stats: 349b.
class.

 -- Class: pstats.Stats (*filenames or profile, stream=sys.stdout)

     This class constructor creates an instance of a “statistics object”
     from a `filename' (or list of filenames) or from a ‘Profile’
     instance.  Output will be printed to the stream specified by
     `stream'.

     The file selected by the above constructor must have been created
     by the corresponding version of *note profile: d3. or *note
     cProfile: 28.  To be specific, there is `no' file compatibility
     guaranteed with future versions of this profiler, and there is no
     compatibility with files produced by other profilers, or the same
     profiler run on a different operating system.  If several files are
     provided, all the statistics for identical functions will be
     coalesced, so that an overall view of several processes can be
     considered in a single report.  If additional files need to be
     combined with data in an existing *note Stats: 349b. object, the
     *note add(): 34ab. method can be used.

     Instead of reading the profile data from a file, a
     ‘cProfile.Profile’ or *note profile.Profile: 1b9. object can be
     used as the profile data source.

     *note Stats: 349b. objects have the following methods:

      -- Method: strip_dirs ()

          This method for the *note Stats: 349b. class removes all
          leading path information from file names.  It is very useful
          in reducing the size of the printout to fit within (close to)
          80 columns.  This method modifies the object, and the stripped
          information is lost.  After performing a strip operation, the
          object is considered to have its entries in a “random” order,
          as it was just after object initialization and loading.  If
          *note strip_dirs(): 349d. causes two function names to be
          indistinguishable (they are on the same line of the same
          filename, and have the same function name), then the
          statistics for these two entries are accumulated into a single
          entry.

      -- Method: add (*filenames)

          This method of the *note Stats: 349b. class accumulates
          additional profiling information into the current profiling
          object.  Its arguments should refer to filenames created by
          the corresponding version of *note profile.run(): 34a0. or
          ‘cProfile.run()’.  Statistics for identically named (re: file,
          line, name) functions are automatically accumulated into
          single function statistics.

      -- Method: dump_stats (filename)

          Save the data loaded into the *note Stats: 349b. object to a
          file named `filename'.  The file is created if it does not
          exist, and is overwritten if it already exists.  This is
          equivalent to the method of the same name on the *note
          profile.Profile: 1b9. and ‘cProfile.Profile’ classes.

      -- Method: sort_stats (*keys)

          This method modifies the *note Stats: 349b. object by sorting
          it according to the supplied criteria.  The argument can be
          either a string or a SortKey enum identifying the basis of a
          sort (example: ‘'time'’, ‘'name'’, ‘SortKey.TIME’ or
          ‘SortKey.NAME’).  The SortKey enums argument have advantage
          over the string argument in that it is more robust and less
          error prone.

          When more than one key is provided, then additional keys are
          used as secondary criteria when there is equality in all keys
          selected before them.  For example, ‘sort_stats(SortKey.NAME,
          SortKey.FILE)’ will sort all the entries according to their
          function name, and resolve all ties (identical function names)
          by sorting by file name.

          For the string argument, abbreviations can be used for any key
          names, as long as the abbreviation is unambiguous.

          The following are the valid string and SortKey:

          Valid String Arg       Valid enum Arg            Meaning
                                                           
          ----------------------------------------------------------------------------
                                                           
          ‘'calls'’              SortKey.CALLS             call count
                                                           
                                                           
          ‘'cumulative'’         SortKey.CUMULATIVE        cumulative time
                                                           
                                                           
          ‘'cumtime'’            N/A                       cumulative time
                                                           
                                                           
          ‘'file'’               N/A                       file name
                                                           
                                                           
          ‘'filename'’           SortKey.FILENAME          file name
                                                           
                                                           
          ‘'module'’             N/A                       file name
                                                           
                                                           
          ‘'ncalls'’             N/A                       call count
                                                           
                                                           
          ‘'pcalls'’             SortKey.PCALLS            primitive call count
                                                           
                                                           
          ‘'line'’               SortKey.LINE              line number
                                                           
                                                           
          ‘'name'’               SortKey.NAME              function name
                                                           
                                                           
          ‘'nfl'’                SortKey.NFL               name/file/line
                                                           
                                                           
          ‘'stdname'’            SortKey.STDNAME           standard name
                                                           
                                                           
          ‘'time'’               SortKey.TIME              internal time
                                                           
                                                           
          ‘'tottime'’            N/A                       internal time
                                                           

          Note that all sorts on statistics are in descending order
          (placing most time consuming items first), where as name,
          file, and line number searches are in ascending order
          (alphabetical).  The subtle distinction between ‘SortKey.NFL’
          and ‘SortKey.STDNAME’ is that the standard name is a sort of
          the name as printed, which means that the embedded line
          numbers get compared in an odd way.  For example, lines 3, 20,
          and 40 would (if the file names were the same) appear in the
          string order 20, 3 and 40.  In contrast, ‘SortKey.NFL’ does a
          numeric compare of the line numbers.  In fact,
          ‘sort_stats(SortKey.NFL)’ is the same as
          ‘sort_stats(SortKey.NAME, SortKey.FILENAME, SortKey.LINE)’.

          For backward-compatibility reasons, the numeric arguments
          ‘-1’, ‘0’, ‘1’, and ‘2’ are permitted.  They are interpreted
          as ‘'stdname'’, ‘'calls'’, ‘'time'’, and ‘'cumulative'’
          respectively.  If this old style format (numeric) is used,
          only one sort key (the numeric key) will be used, and
          additional arguments will be silently ignored.

          New in version 3.7: Added the SortKey enum.

      -- Method: reverse_order ()

          This method for the *note Stats: 349b. class reverses the
          ordering of the basic list within the object.  Note that by
          default ascending vs descending order is properly selected
          based on the sort key of choice.

      -- Method: print_stats (*restrictions)

          This method for the *note Stats: 349b. class prints out a
          report as described in the *note profile.run(): 34a0.
          definition.

          The order of the printing is based on the last *note
          sort_stats(): 349c. operation done on the object (subject to
          caveats in *note add(): 34ab. and *note strip_dirs(): 349d.).

          The arguments provided (if any) can be used to limit the list
          down to the significant entries.  Initially, the list is taken
          to be the complete set of profiled functions.  Each
          restriction is either an integer (to select a count of lines),
          or a decimal fraction between 0.0 and 1.0 inclusive (to select
          a percentage of lines), or a string that will interpreted as a
          regular expression (to pattern match the standard name that is
          printed).  If several restrictions are provided, then they are
          applied sequentially.  For example:

               print_stats(.1, 'foo:')

          would first limit the printing to first 10% of list, and then
          only print functions that were part of filename ‘.*foo:’.  In
          contrast, the command:

               print_stats('foo:', .1)

          would limit the list to all functions having file names
          ‘.*foo:’, and then proceed to only print the first 10% of
          them.

      -- Method: print_callers (*restrictions)

          This method for the *note Stats: 349b. class prints a list of
          all functions that called each function in the profiled
          database.  The ordering is identical to that provided by *note
          print_stats(): 349e, and the definition of the restricting
          argument is also identical.  Each caller is reported on its
          own line.  The format differs slightly depending on the
          profiler that produced the stats:

             * With *note profile: d3, a number is shown in parentheses
               after each caller to show how many times this specific
               call was made.  For convenience, a second
               non-parenthesized number repeats the cumulative time
               spent in the function at the right.

             * With *note cProfile: 28, each caller is preceded by three
               numbers: the number of times this specific call was made,
               and the total and cumulative times spent in the current
               function while it was invoked by this specific caller.

      -- Method: print_callees (*restrictions)

          This method for the *note Stats: 349b. class prints a list of
          all function that were called by the indicated function.
          Aside from this reversal of direction of calls (re: called vs
          was called by), the arguments and ordering are identical to
          the *note print_callers(): 34ae. method.


File: python.info,  Node: What Is Deterministic Profiling?,  Next: Limitations,  Prev: The Stats Class,  Up: The Python Profilers

5.28.5.5 What Is Deterministic Profiling?
.........................................

`Deterministic profiling' is meant to reflect the fact that all
`function call', `function return', and `exception' events are
monitored, and precise timings are made for the intervals between these
events (during which time the user’s code is executing).  In contrast,
`statistical profiling' (which is not done by this module) randomly
samples the effective instruction pointer, and deduces where time is
being spent.  The latter technique traditionally involves less overhead
(as the code does not need to be instrumented), but provides only
relative indications of where time is being spent.

In Python, since there is an interpreter active during execution, the
presence of instrumented code is not required in order to do
deterministic profiling.  Python automatically provides a `hook'
(optional callback) for each event.  In addition, the interpreted nature
of Python tends to add so much overhead to execution, that deterministic
profiling tends to only add small processing overhead in typical
applications.  The result is that deterministic profiling is not that
expensive, yet provides extensive run time statistics about the
execution of a Python program.

Call count statistics can be used to identify bugs in code (surprising
counts), and to identify possible inline-expansion points (high call
counts).  Internal time statistics can be used to identify “hot loops”
that should be carefully optimized.  Cumulative time statistics should
be used to identify high level errors in the selection of algorithms.
Note that the unusual handling of cumulative times in this profiler
allows statistics for recursive implementations of algorithms to be
directly compared to iterative implementations.


File: python.info,  Node: Limitations,  Next: Calibration,  Prev: What Is Deterministic Profiling?,  Up: The Python Profilers

5.28.5.6 Limitations
....................

One limitation has to do with accuracy of timing information.  There is
a fundamental problem with deterministic profilers involving accuracy.
The most obvious restriction is that the underlying “clock” is only
ticking at a rate (typically) of about .001 seconds.  Hence no
measurements will be more accurate than the underlying clock.  If enough
measurements are taken, then the “error” will tend to average out.
Unfortunately, removing this first error induces a second source of
error.

The second problem is that it “takes a while” from when an event is
dispatched until the profiler’s call to get the time actually `gets' the
state of the clock.  Similarly, there is a certain lag when exiting the
profiler event handler from the time that the clock’s value was obtained
(and then squirreled away), until the user’s code is once again
executing.  As a result, functions that are called many times, or call
many functions, will typically accumulate this error.  The error that
accumulates in this fashion is typically less than the accuracy of the
clock (less than one clock tick), but it `can' accumulate and become
very significant.

The problem is more important with *note profile: d3. than with the
lower-overhead *note cProfile: 28.  For this reason, *note profile: d3.
provides a means of calibrating itself for a given platform so that this
error can be probabilistically (on the average) removed.  After the
profiler is calibrated, it will be more accurate (in a least square
sense), but it will sometimes produce negative numbers (when call counts
are exceptionally low, and the gods of probability work against you :-).
)  Do `not' be alarmed by negative numbers in the profile.  They should
`only' appear if you have calibrated your profiler, and the results are
actually better than without calibration.


File: python.info,  Node: Calibration,  Next: Using a custom timer,  Prev: Limitations,  Up: The Python Profilers

5.28.5.7 Calibration
....................

The profiler of the *note profile: d3. module subtracts a constant from
each event handling time to compensate for the overhead of calling the
time function, and socking away the results.  By default, the constant
is 0.  The following procedure can be used to obtain a better constant
for a given platform (see *note Limitations: 34b3.).

     import profile pr = profile.Profile() for i in range(5):     print(pr.calibrate(10000))

The method executes the number of Python calls given by the argument,
directly and again under the profiler, measuring the time for both.  It
then computes the hidden overhead per profiler event, and returns that
as a float.  For example, on a 1.8Ghz Intel Core i5 running Mac OS X,
and using Python’s time.process_time() as the timer, the magical number
is about 4.04e-6.

The object of this exercise is to get a fairly consistent result.  If
your computer is `very' fast, or your timer function has poor
resolution, you might have to pass 100000, or even 1000000, to get
consistent results.

When you have a consistent answer, there are three ways you can use it:

     import profile  # 1. Apply computed bias to all Profile instances created hereafter. profile.Profile.bias = your_computed_bias  # 2. Apply computed bias to a specific Profile instance. pr = profile.Profile() pr.bias = your_computed_bias  # 3. Specify computed bias in instance constructor. pr = profile.Profile(bias=your_computed_bias)

If you have a choice, you are better off choosing a smaller constant,
and then your results will “less often” show up as negative in profile
statistics.


File: python.info,  Node: Using a custom timer,  Prev: Calibration,  Up: The Python Profilers

5.28.5.8 Using a custom timer
.............................

If you want to change how current time is determined (for example, to
force use of wall-clock time or elapsed process time), pass the timing
function you want to the ‘Profile’ class constructor:

     pr = profile.Profile(your_time_func)

The resulting profiler will then call ‘your_time_func’.  Depending on
whether you are using *note profile.Profile: 1b9. or ‘cProfile.Profile’,
‘your_time_func’’s return value will be interpreted differently:

*note profile.Profile: 1b9.

     ‘your_time_func’ should return a single number, or a list of
     numbers whose sum is the current time (like what *note os.times():
     a51. returns).  If the function returns a single time number, or
     the list of returned numbers has length 2, then you will get an
     especially fast version of the dispatch routine.

     Be warned that you should calibrate the profiler class for the
     timer function that you choose (see *note Calibration: 34b5.).  For
     most machines, a timer that returns a lone integer value will
     provide the best results in terms of low overhead during profiling.
     (*note os.times(): a51. is `pretty' bad, as it returns a tuple of
     floating point values).  If you want to substitute a better timer
     in the cleanest fashion, derive a class and hardwire a replacement
     dispatch method that best handles your timer call, along with the
     appropriate calibration constant.

‘cProfile.Profile’

     ‘your_time_func’ should return a single number.  If it returns
     integers, you can also invoke the class constructor with a second
     argument specifying the real duration of one unit of time.  For
     example, if ‘your_integer_time_func’ returns times measured in
     thousands of seconds, you would construct the ‘Profile’ instance as
     follows:

          pr = cProfile.Profile(your_integer_time_func, 0.001)

     As the ‘cProfile.Profile’ class cannot be calibrated, custom timer
     functions should be used with care and should be as fast as
     possible.  For the best results with a custom timer, it might be
     necessary to hard-code it in the C source of the internal ‘_lsprof’
     module.

Python 3.3 adds several new functions in *note time: 10a. that can be
used to make precise measurements of process or wall-clock time.  For
example, see *note time.perf_counter(): 2a8.


File: python.info,  Node: timeit — Measure execution time of small code snippets,  Next: trace — Trace or track Python statement execution,  Prev: The Python Profilers,  Up: Debugging and Profiling

5.28.6 ‘timeit’ — Measure execution time of small code snippets
---------------------------------------------------------------

`Source code:' Lib/timeit.py(1)

__________________________________________________________________

This module provides a simple way to time small bits of Python code.  It
has both a *note Command-Line Interface: 34ba. as well as a *note
callable: 34bb. one.  It avoids a number of common traps for measuring
execution times.  See also Tim Peters’ introduction to the “Algorithms”
chapter in the `Python Cookbook', published by O’Reilly.

* Menu:

* Basic Examples: Basic Examples<2>.
* Python Interface::
* Command-Line Interface: Command-Line Interface<4>.
* Examples: Examples<25>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/timeit.py


File: python.info,  Node: Basic Examples<2>,  Next: Python Interface,  Up: timeit — Measure execution time of small code snippets

5.28.6.1 Basic Examples
.......................

The following example shows how the *note Command-Line Interface: 34ba.
can be used to compare three different expressions:

     $ python3 -m timeit '"-".join(str(n) for n in range(100))' 10000 loops, best of 5: 30.2 usec per loop $ python3 -m timeit '"-".join([str(n) for n in range(100)])' 10000 loops, best of 5: 27.5 usec per loop $ python3 -m timeit '"-".join(map(str, range(100)))' 10000 loops, best of 5: 23.2 usec per loop

This can be achieved from the *note Python Interface: 34bb. with:

     >>> import timeit >>> timeit.timeit('"-".join(str(n) for n in range(100))', number=10000) 0.3018611848820001 >>> timeit.timeit('"-".join([str(n) for n in range(100)])', number=10000) 0.2727368790656328 >>> timeit.timeit('"-".join(map(str, range(100)))', number=10000) 0.23702679807320237

A callable can also be passed from the *note Python Interface: 34bb.:

     >>> timeit.timeit(lambda: "-".join(map(str, range(100))), number=10000) 0.19665591977536678

Note however that *note timeit(): 765. will automatically determine the
number of repetitions only when the command-line interface is used.  In
the *note Examples: 34bd. section you can find more advanced examples.


File: python.info,  Node: Python Interface,  Next: Command-Line Interface<4>,  Prev: Basic Examples<2>,  Up: timeit — Measure execution time of small code snippets

5.28.6.2 Python Interface
.........................

The module defines three convenience functions and a public class:

 -- Function: timeit.timeit (stmt='pass', setup='pass', timer=<default
          timer>, number=1000000, globals=None)

     Create a *note Timer: 34bf. instance with the given statement,
     `setup' code and `timer' function and run its *note timeit(): 591.
     method with `number' executions.  The optional `globals' argument
     specifies a namespace in which to execute the code.

     Changed in version 3.5: The optional `globals' parameter was added.

 -- Function: timeit.repeat (stmt='pass', setup='pass', timer=<default
          timer>, repeat=5, number=1000000, globals=None)

     Create a *note Timer: 34bf. instance with the given statement,
     `setup' code and `timer' function and run its *note repeat(): 34c1.
     method with the given `repeat' count and `number' executions.  The
     optional `globals' argument specifies a namespace in which to
     execute the code.

     Changed in version 3.5: The optional `globals' parameter was added.

     Changed in version 3.7: Default value of `repeat' changed from 3 to
     5.

 -- Function: timeit.default_timer ()

     The default timer, which is always *note time.perf_counter(): 2a8.

     Changed in version 3.3: *note time.perf_counter(): 2a8. is now the
     default timer.

 -- Class: timeit.Timer (stmt='pass', setup='pass', timer=<timer
          function>, globals=None)

     Class for timing execution speed of small code snippets.

     The constructor takes a statement to be timed, an additional
     statement used for setup, and a timer function.  Both statements
     default to ‘'pass'’; the timer function is platform-dependent (see
     the module doc string).  `stmt' and `setup' may also contain
     multiple statements separated by ‘;’ or newlines, as long as they
     don’t contain multi-line string literals.  The statement will by
     default be executed within timeit’s namespace; this behavior can be
     controlled by passing a namespace to `globals'.

     To measure the execution time of the first statement, use the *note
     timeit(): 591. method.  The *note repeat(): 34c1. and *note
     autorange(): 590. methods are convenience methods to call *note
     timeit(): 591. multiple times.

     The execution time of `setup' is excluded from the overall timed
     execution run.

     The `stmt' and `setup' parameters can also take objects that are
     callable without arguments.  This will embed calls to them in a
     timer function that will then be executed by *note timeit(): 591.
     Note that the timing overhead is a little larger in this case
     because of the extra function calls.

     Changed in version 3.5: The optional `globals' parameter was added.

      -- Method: timeit (number=1000000)

          Time `number' executions of the main statement.  This executes
          the setup statement once, and then returns the time it takes
          to execute the main statement a number of times, measured in
          seconds as a float.  The argument is the number of times
          through the loop, defaulting to one million.  The main
          statement, the setup statement and the timer function to be
          used are passed to the constructor.

               Note: By default, *note timeit(): 591. temporarily turns
               off *note garbage collection: 1243. during the timing.
               The advantage of this approach is that it makes
               independent timings more comparable.  The disadvantage is
               that GC may be an important component of the performance
               of the function being measured.  If so, GC can be
               re-enabled as the first statement in the `setup' string.
               For example:

                    timeit.Timer('for i in range(10): oct(i)', 'gc.enable()').timeit()

      -- Method: autorange (callback=None)

          Automatically determine how many times to call *note timeit():
          591.

          This is a convenience function that calls *note timeit(): 591.
          repeatedly so that the total time >= 0.2 second, returning the
          eventual (number of loops, time taken for that number of
          loops).  It calls *note timeit(): 591. with increasing numbers
          from the sequence 1, 2, 5, 10, 20, 50, … until the time taken
          is at least 0.2 second.

          If `callback' is given and is not ‘None’, it will be called
          after each trial with two arguments: ‘callback(number,
          time_taken)’.

          New in version 3.6.

      -- Method: repeat (repeat=5, number=1000000)

          Call *note timeit(): 591. a few times.

          This is a convenience function that calls the *note timeit():
          591. repeatedly, returning a list of results.  The first
          argument specifies how many times to call *note timeit(): 591.
          The second argument specifies the `number' argument for *note
          timeit(): 591.

               Note: It’s tempting to calculate mean and standard
               deviation from the result vector and report these.
               However, this is not very useful.  In a typical case, the
               lowest value gives a lower bound for how fast your
               machine can run the given code snippet; higher values in
               the result vector are typically not caused by variability
               in Python’s speed, but by other processes interfering
               with your timing accuracy.  So the *note min(): 7fd. of
               the result is probably the only number you should be
               interested in.  After that, you should look at the entire
               vector and apply common sense rather than statistics.

          Changed in version 3.7: Default value of `repeat' changed from
          3 to 5.

      -- Method: print_exc (file=None)

          Helper to print a traceback from the timed code.

          Typical use:

               t = Timer(...)       # outside the try/except try:     t.timeit(...)    # or t.repeat(...) except Exception:     t.print_exc()

          The advantage over the standard traceback is that source lines
          in the compiled template will be displayed.  The optional
          `file' argument directs where the traceback is sent; it
          defaults to *note sys.stderr: 304.


File: python.info,  Node: Command-Line Interface<4>,  Next: Examples<25>,  Prev: Python Interface,  Up: timeit — Measure execution time of small code snippets

5.28.6.3 Command-Line Interface
...............................

When called as a program from the command line, the following form is
used:

     python -m timeit [-n N] [-r N] [-u U] [-s S] [-h] [statement ...]

Where the following options are understood:

 -- Program Option: -n N, --number=N

     how many times to execute ‘statement’

 -- Program Option: -r N, --repeat=N

     how many times to repeat the timer (default 5)

 -- Program Option: -s S, --setup=S

     statement to be executed once initially (default ‘pass’)

 -- Program Option: -p, --process

     measure process time, not wallclock time, using *note
     time.process_time(): 2a9. instead of *note time.perf_counter():
     2a8, which is the default

     New in version 3.3.

 -- Program Option: -u, --unit=U

          specify a time unit for timer output; can select nsec, usec,
          msec, or sec

     New in version 3.5.

 -- Program Option: -v, --verbose

     print raw timing results; repeat for more digits precision

 -- Program Option: -h, --help

     print a short usage message and exit

A multi-line statement may be given by specifying each line as a
separate statement argument; indented lines are possible by enclosing an
argument in quotes and using leading spaces.  Multiple *note -s: 34c7.
options are treated similarly.

If *note -n: 34c5. is not given, a suitable number of loops is
calculated by trying successive powers of 10 until the total time is at
least 0.2 seconds.

*note default_timer(): 34c2. measurements can be affected by other
programs running on the same machine, so the best thing to do when
accurate timing is necessary is to repeat the timing a few times and use
the best time.  The *note -r: 34c6. option is good for this; the default
of 5 repetitions is probably enough in most cases.  You can use *note
time.process_time(): 2a9. to measure CPU time.

     Note: There is a certain baseline overhead associated with
     executing a pass statement.  The code here doesn’t try to hide it,
     but you should be aware of it.  The baseline overhead can be
     measured by invoking the program without arguments, and it might
     differ between Python versions.


File: python.info,  Node: Examples<25>,  Prev: Command-Line Interface<4>,  Up: timeit — Measure execution time of small code snippets

5.28.6.4 Examples
.................

It is possible to provide a setup statement that is executed only once
at the beginning:

     $ python -m timeit -s 'text = "sample string"; char = "g"'  'char in text' 5000000 loops, best of 5: 0.0877 usec per loop $ python -m timeit -s 'text = "sample string"; char = "g"'  'text.find(char)' 1000000 loops, best of 5: 0.342 usec per loop

     >>> import timeit >>> timeit.timeit('char in text', setup='text = "sample string"; char = "g"') 0.41440500499993504 >>> timeit.timeit('text.find(char)', setup='text = "sample string"; char = "g"') 1.7246671520006203

The same can be done using the *note Timer: 34bf. class and its methods:

     >>> import timeit >>> t = timeit.Timer('char in text', setup='text = "sample string"; char = "g"') >>> t.timeit() 0.3955516149999312 >>> t.repeat() [0.40183617287970225, 0.37027556854118704, 0.38344867356679524, 0.3712595970846668, 0.37866875250654886]

The following examples show how to time expressions that contain
multiple lines.  Here we compare the cost of using *note hasattr(): 43c.
vs.  *note try: d65./*note except: b31. to test for missing and present
object attributes:

     $ python -m timeit 'try:' '  str.__bool__' 'except AttributeError:' '  pass' 20000 loops, best of 5: 15.7 usec per loop $ python -m timeit 'if hasattr(str, "__bool__"): pass' 50000 loops, best of 5: 4.26 usec per loop  $ python -m timeit 'try:' '  int.__bool__' 'except AttributeError:' '  pass' 200000 loops, best of 5: 1.43 usec per loop $ python -m timeit 'if hasattr(int, "__bool__"): pass' 100000 loops, best of 5: 2.23 usec per loop

     >>> import timeit >>> # attribute is missing >>> s = """\ ... try: ...     str.__bool__ ... except AttributeError: ...     pass ... """ >>> timeit.timeit(stmt=s, number=100000) 0.9138244460009446 >>> s = "if hasattr(str, '__bool__'): pass" >>> timeit.timeit(stmt=s, number=100000) 0.5829014980008651 >>> >>> # attribute is present >>> s = """\ ... try: ...     int.__bool__ ... except AttributeError: ...     pass ... """ >>> timeit.timeit(stmt=s, number=100000) 0.04215312199994514 >>> s = "if hasattr(int, '__bool__'): pass" >>> timeit.timeit(stmt=s, number=100000) 0.08588060699912603

To give the *note timeit: 10b. module access to functions you define,
you can pass a `setup' parameter which contains an import statement:

     def test():     """Stupid test function"""     L = [i for i in range(100)]  if __name__ == '__main__':     import timeit     print(timeit.timeit("test()", setup="from __main__ import test"))

Another option is to pass *note globals(): 151e. to the `globals'
parameter, which will cause the code to be executed within your current
global namespace.  This can be more convenient than individually
specifying imports:

     def f(x):     return x**2 def g(x):     return x**4 def h(x):     return x**8  import timeit print(timeit.timeit('[func(42) for func in (f,g,h)]', globals=globals()))


File: python.info,  Node: trace — Trace or track Python statement execution,  Next: tracemalloc — Trace memory allocations,  Prev: timeit — Measure execution time of small code snippets,  Up: Debugging and Profiling

5.28.7 ‘trace’ — Trace or track Python statement execution
----------------------------------------------------------

`Source code:' Lib/trace.py(1)

__________________________________________________________________

The *note trace: 112. module allows you to trace program execution,
generate annotated statement coverage listings, print caller/callee
relationships and list functions executed during a program run.  It can
be used in another program or from the command line.

See also
........

Coverage.py(2)

     A popular third-party coverage tool that provides HTML output along
     with advanced features such as branch coverage.

* Menu:

* Command-Line Usage::
* Programmatic Interface::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/trace.py

   (2) https://coverage.readthedocs.io/


File: python.info,  Node: Command-Line Usage,  Next: Programmatic Interface,  Up: trace — Trace or track Python statement execution

5.28.7.1 Command-Line Usage
...........................

The *note trace: 112. module can be invoked from the command line.  It
can be as simple as

     python -m trace --count -C . somefile.py ...

The above will execute ‘somefile.py’ and generate annotated listings of
all Python modules imported during the execution into the current
directory.

 -- Program Option: --help

     Display usage and exit.

 -- Program Option: --version

     Display the version of the module and exit.

New in version 3.8: Added ‘--module’ option that allows to run an
executable module.

* Menu:

* Main options::
* Modifiers::
* Filters::


File: python.info,  Node: Main options,  Next: Modifiers,  Up: Command-Line Usage

5.28.7.2 Main options
.....................

At least one of the following options must be specified when invoking
*note trace: 112.  The *note –listfuncs: 34d4. option is mutually
exclusive with the *note –trace: 34d5. and *note –count: 34d6. options.
When *note –listfuncs: 34d4. is provided, neither *note –count: 34d6.
nor *note –trace: 34d5. are accepted, and vice versa.

 -- Program Option: -c, --count

     Produce a set of annotated listing files upon program completion
     that shows how many times each statement was executed.  See also
     *note –coverdir: 34d7, *note –file: 34d8. and *note –no-report:
     34d9. below.

 -- Program Option: -t, --trace

     Display lines as they are executed.

 -- Program Option: -l, --listfuncs

     Display the functions executed by running the program.

 -- Program Option: -r, --report

     Produce an annotated list from an earlier program run that used the
     *note –count: 34d6. and *note –file: 34d8. option.  This does not
     execute any code.

 -- Program Option: -T, --trackcalls

     Display the calling relationships exposed by running the program.


File: python.info,  Node: Modifiers,  Next: Filters,  Prev: Main options,  Up: Command-Line Usage

5.28.7.3 Modifiers
..................

 -- Program Option: -f, --file=<file>

     Name of a file to accumulate counts over several tracing runs.
     Should be used with the *note –count: 34d6. option.

 -- Program Option: -C, --coverdir=<dir>

     Directory where the report files go.  The coverage report for
     ‘package.module’ is written to file
     ‘`dir'/`package'/`module'.cover’.

 -- Program Option: -m, --missing

     When generating annotated listings, mark lines which were not
     executed with ‘>>>>>>’.

 -- Program Option: -s, --summary

     When using *note –count: 34d6. or *note –report: 34da, write a
     brief summary to stdout for each file processed.

 -- Program Option: -R, --no-report

     Do not generate annotated listings.  This is useful if you intend
     to make several runs with *note –count: 34d6, and then produce a
     single set of annotated listings at the end.

 -- Program Option: -g, --timing

     Prefix each line with the time since the program started.  Only
     used while tracing.


File: python.info,  Node: Filters,  Prev: Modifiers,  Up: Command-Line Usage

5.28.7.4 Filters
................

These options may be repeated multiple times.

 -- Program Option: --ignore-module=<mod>

     Ignore each of the given module names and its submodules (if it is
     a package).  The argument can be a list of names separated by a
     comma.

 -- Program Option: --ignore-dir=<dir>

     Ignore all modules and packages in the named directory and
     subdirectories.  The argument can be a list of directories
     separated by *note os.pathsep: 1290.


File: python.info,  Node: Programmatic Interface,  Prev: Command-Line Usage,  Up: trace — Trace or track Python statement execution

5.28.7.5 Programmatic Interface
...............................

 -- Class: trace.Trace (count=1, trace=1, countfuncs=0, countcallers=0,
          ignoremods=(), ignoredirs=(), infile=None, outfile=None,
          timing=False)

     Create an object to trace execution of a single statement or
     expression.  All parameters are optional.  `count' enables counting
     of line numbers.  `trace' enables line execution tracing.
     `countfuncs' enables listing of the functions called during the
     run.  `countcallers' enables call relationship tracking.
     `ignoremods' is a list of modules or packages to ignore.
     `ignoredirs' is a list of directories whose modules or packages
     should be ignored.  `infile' is the name of the file from which to
     read stored count information.  `outfile' is the name of the file
     in which to write updated count information.  `timing' enables a
     timestamp relative to when tracing was started to be displayed.

           -- Method: run (cmd)

               Execute the command and gather statistics from the
               execution with the current tracing parameters.  `cmd'
               must be a string or code object, suitable for passing
               into *note exec(): c37.

           -- Method: runctx (cmd, globals=None, locals=None)

               Execute the command and gather statistics from the
               execution with the current tracing parameters, in the
               defined global and local environments.  If not defined,
               `globals' and `locals' default to empty dictionaries.

           -- Method: runfunc (func, *args, **kwds)

               Call `func' with the given arguments under control of the
               *note Trace: 34e5. object with the current tracing
               parameters.

           -- Method: results ()

               Return a *note CoverageResults: 34e9. object that
               contains the cumulative results of all previous calls to
               ‘run’, ‘runctx’ and ‘runfunc’ for the given *note Trace:
               34e5. instance.  Does not reset the accumulated trace
               results.

 -- Class: trace.CoverageResults

     A container for coverage results, created by *note Trace.results():
     34e8.  Should not be created directly by the user.

           -- Method: update (other)

               Merge in data from another *note CoverageResults: 34e9.
               object.

           -- Method: write_results (show_missing=True, summary=False,
                    coverdir=None)

               Write coverage results.  Set `show_missing' to show lines
               that had no hits.  Set `summary' to include in the output
               the coverage summary per module.  `coverdir' specifies
               the directory into which the coverage result files will
               be output.  If ‘None’, the results for each source file
               are placed in its directory.

A simple example demonstrating the use of the programmatic interface:

     import sys import trace  # create a Trace object, telling it what to ignore, and whether to # do tracing or line-counting or both. tracer = trace.Trace(     ignoredirs=[sys.prefix, sys.exec_prefix],     trace=0,     count=1)  # run the new command using the given tracer tracer.run('main()')  # make a report, placing output in the current directory r = tracer.results() r.write_results(show_missing=True, coverdir=".")


File: python.info,  Node: tracemalloc — Trace memory allocations,  Prev: trace — Trace or track Python statement execution,  Up: Debugging and Profiling

5.28.8 ‘tracemalloc’ — Trace memory allocations
-----------------------------------------------

New in version 3.4.

`Source code:' Lib/tracemalloc.py(1)

__________________________________________________________________

The tracemalloc module is a debug tool to trace memory blocks allocated
by Python.  It provides the following information:

   * Traceback where an object was allocated

   * Statistics on allocated memory blocks per filename and per line
     number: total size, number and average size of allocated memory
     blocks

   * Compute the differences between two snapshots to detect memory
     leaks

To trace most memory blocks allocated by Python, the module should be
started as early as possible by setting the *note PYTHONTRACEMALLOC:
1296. environment variable to ‘1’, or by using *note -X: 155.
‘tracemalloc’ command line option.  The *note tracemalloc.start(): 128a.
function can be called at runtime to start tracing Python memory
allocations.

By default, a trace of an allocated memory block only stores the most
recent frame (1 frame).  To store 25 frames at startup: set the *note
PYTHONTRACEMALLOC: 1296. environment variable to ‘25’, or use the *note
-X: 155. ‘tracemalloc=25’ command line option.

* Menu:

* Examples: Examples<26>.
* API::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tracemalloc.py


File: python.info,  Node: Examples<26>,  Next: API,  Up: tracemalloc — Trace memory allocations

5.28.8.1 Examples
.................

* Menu:

* Display the top 10::
* Compute differences::
* Get the traceback of a memory block::
* Pretty top::


File: python.info,  Node: Display the top 10,  Next: Compute differences,  Up: Examples<26>

5.28.8.2 Display the top 10
...........................

Display the 10 files allocating the most memory:

     import tracemalloc  tracemalloc.start()  # ... run your application ...  snapshot = tracemalloc.take_snapshot() top_stats = snapshot.statistics('lineno')  print("[ Top 10 ]") for stat in top_stats[:10]:     print(stat)

Example of output of the Python test suite:

     [ Top 10 ] <frozen importlib._bootstrap>:716: size=4855 KiB, count=39328, average=126 B <frozen importlib._bootstrap>:284: size=521 KiB, count=3199, average=167 B /usr/lib/python3.4/collections/__init__.py:368: size=244 KiB, count=2315, average=108 B /usr/lib/python3.4/unittest/case.py:381: size=185 KiB, count=779, average=243 B /usr/lib/python3.4/unittest/case.py:402: size=154 KiB, count=378, average=416 B /usr/lib/python3.4/abc.py:133: size=88.7 KiB, count=347, average=262 B <frozen importlib._bootstrap>:1446: size=70.4 KiB, count=911, average=79 B <frozen importlib._bootstrap>:1454: size=52.0 KiB, count=25, average=2131 B <string>:5: size=49.7 KiB, count=148, average=344 B /usr/lib/python3.4/sysconfig.py:411: size=48.0 KiB, count=1, average=48.0 KiB

We can see that Python loaded ‘4855 KiB’ data (bytecode and constants)
from modules and that the *note collections: 1e. module allocated ‘244
KiB’ to build *note namedtuple: 1b5. types.

See *note Snapshot.statistics(): 34f0. for more options.


File: python.info,  Node: Compute differences,  Next: Get the traceback of a memory block,  Prev: Display the top 10,  Up: Examples<26>

5.28.8.3 Compute differences
............................

Take two snapshots and display the differences:

     import tracemalloc tracemalloc.start() # ... start your application ...  snapshot1 = tracemalloc.take_snapshot() # ... call the function leaking memory ... snapshot2 = tracemalloc.take_snapshot()  top_stats = snapshot2.compare_to(snapshot1, 'lineno')  print("[ Top 10 differences ]") for stat in top_stats[:10]:     print(stat)

Example of output before/after running some tests of the Python test
suite:

     [ Top 10 differences ] <frozen importlib._bootstrap>:716: size=8173 KiB (+4428 KiB), count=71332 (+39369), average=117 B /usr/lib/python3.4/linecache.py:127: size=940 KiB (+940 KiB), count=8106 (+8106), average=119 B /usr/lib/python3.4/unittest/case.py:571: size=298 KiB (+298 KiB), count=589 (+589), average=519 B <frozen importlib._bootstrap>:284: size=1005 KiB (+166 KiB), count=7423 (+1526), average=139 B /usr/lib/python3.4/mimetypes.py:217: size=112 KiB (+112 KiB), count=1334 (+1334), average=86 B /usr/lib/python3.4/http/server.py:848: size=96.0 KiB (+96.0 KiB), count=1 (+1), average=96.0 KiB /usr/lib/python3.4/inspect.py:1465: size=83.5 KiB (+83.5 KiB), count=109 (+109), average=784 B /usr/lib/python3.4/unittest/mock.py:491: size=77.7 KiB (+77.7 KiB), count=143 (+143), average=557 B /usr/lib/python3.4/urllib/parse.py:476: size=71.8 KiB (+71.8 KiB), count=969 (+969), average=76 B /usr/lib/python3.4/contextlib.py:38: size=67.2 KiB (+67.2 KiB), count=126 (+126), average=546 B

We can see that Python has loaded ‘8173 KiB’ of module data (bytecode
and constants), and that this is ‘4428 KiB’ more than had been loaded
before the tests, when the previous snapshot was taken.  Similarly, the
*note linecache: a8. module has cached ‘940 KiB’ of Python source code
to format tracebacks, all of it since the previous snapshot.

If the system has little free memory, snapshots can be written on disk
using the *note Snapshot.dump(): 34f2. method to analyze the snapshot
offline.  Then use the *note Snapshot.load(): 34f3. method reload the
snapshot.


File: python.info,  Node: Get the traceback of a memory block,  Next: Pretty top,  Prev: Compute differences,  Up: Examples<26>

5.28.8.4 Get the traceback of a memory block
............................................

Code to display the traceback of the biggest memory block:

     import tracemalloc  # Store 25 frames tracemalloc.start(25)  # ... run your application ...  snapshot = tracemalloc.take_snapshot() top_stats = snapshot.statistics('traceback')  # pick the biggest memory block stat = top_stats[0] print("%s memory blocks: %.1f KiB" % (stat.count, stat.size / 1024)) for line in stat.traceback.format():     print(line)

Example of output of the Python test suite (traceback limited to 25
frames):

     903 memory blocks: 870.1 KiB   File "<frozen importlib._bootstrap>", line 716   File "<frozen importlib._bootstrap>", line 1036   File "<frozen importlib._bootstrap>", line 934   File "<frozen importlib._bootstrap>", line 1068   File "<frozen importlib._bootstrap>", line 619   File "<frozen importlib._bootstrap>", line 1581   File "<frozen importlib._bootstrap>", line 1614   File "/usr/lib/python3.4/doctest.py", line 101     import pdb   File "<frozen importlib._bootstrap>", line 284   File "<frozen importlib._bootstrap>", line 938   File "<frozen importlib._bootstrap>", line 1068   File "<frozen importlib._bootstrap>", line 619   File "<frozen importlib._bootstrap>", line 1581   File "<frozen importlib._bootstrap>", line 1614   File "/usr/lib/python3.4/test/support/__init__.py", line 1728     import doctest   File "/usr/lib/python3.4/test/test_pickletools.py", line 21     support.run_doctest(pickletools)   File "/usr/lib/python3.4/test/regrtest.py", line 1276     test_runner()   File "/usr/lib/python3.4/test/regrtest.py", line 976     display_failure=not verbose)   File "/usr/lib/python3.4/test/regrtest.py", line 761     match_tests=ns.match_tests)   File "/usr/lib/python3.4/test/regrtest.py", line 1563     main()   File "/usr/lib/python3.4/test/__main__.py", line 3     regrtest.main_in_temp_cwd()   File "/usr/lib/python3.4/runpy.py", line 73     exec(code, run_globals)   File "/usr/lib/python3.4/runpy.py", line 160     "__main__", fname, loader, pkg_name)

We can see that the most memory was allocated in the *note importlib:
9b. module to load data (bytecode and constants) from modules: ‘870.1
KiB’.  The traceback is where the *note importlib: 9b. loaded data most
recently: on the ‘import pdb’ line of the *note doctest: 67. module.
The traceback may change if a new module is loaded.


File: python.info,  Node: Pretty top,  Prev: Get the traceback of a memory block,  Up: Examples<26>

5.28.8.5 Pretty top
...................

Code to display the 10 lines allocating the most memory with a pretty
output, ignoring ‘<frozen importlib._bootstrap>’ and ‘<unknown>’ files:

     import linecache import os import tracemalloc  def display_top(snapshot, key_type='lineno', limit=10):     snapshot = snapshot.filter_traces((         tracemalloc.Filter(False, "<frozen importlib._bootstrap>"),         tracemalloc.Filter(False, "<unknown>"),     ))     top_stats = snapshot.statistics(key_type)      print("Top %s lines" % limit)     for index, stat in enumerate(top_stats[:limit], 1):         frame = stat.traceback[0]         # replace "/path/to/module/file.py" with "module/file.py"         filename = os.sep.join(frame.filename.split(os.sep)[-2:])         print("#%s: %s:%s: %.1f KiB"               % (index, filename, frame.lineno, stat.size / 1024))         line = linecache.getline(frame.filename, frame.lineno).strip()         if line:             print('    %s' % line)      other = top_stats[limit:]     if other:         size = sum(stat.size for stat in other)         print("%s other: %.1f KiB" % (len(other), size / 1024))     total = sum(stat.size for stat in top_stats)     print("Total allocated size: %.1f KiB" % (total / 1024))  tracemalloc.start()  # ... run your application ...  snapshot = tracemalloc.take_snapshot() display_top(snapshot)

Example of output of the Python test suite:

     Top 10 lines #1: Lib/base64.py:414: 419.8 KiB     _b85chars2 = [(a + b) for a in _b85chars for b in _b85chars] #2: Lib/base64.py:306: 419.8 KiB     _a85chars2 = [(a + b) for a in _a85chars for b in _a85chars] #3: collections/__init__.py:368: 293.6 KiB     exec(class_definition, namespace) #4: Lib/abc.py:133: 115.2 KiB     cls = super().__new__(mcls, name, bases, namespace) #5: unittest/case.py:574: 103.1 KiB     testMethod() #6: Lib/linecache.py:127: 95.4 KiB     lines = fp.readlines() #7: urllib/parse.py:476: 71.8 KiB     for a in _hexdig for b in _hexdig} #8: <string>:5: 62.0 KiB #9: Lib/_weakrefset.py:37: 60.0 KiB     self.data = set() #10: Lib/base64.py:142: 59.8 KiB     _b32tab2 = [a + b for a in _b32tab for b in _b32tab] 6220 other: 3602.8 KiB Total allocated size: 5303.1 KiB

See *note Snapshot.statistics(): 34f0. for more options.


File: python.info,  Node: API,  Prev: Examples<26>,  Up: tracemalloc — Trace memory allocations

5.28.8.6 API
............

* Menu:

* Functions: Functions<9>.
* DomainFilter::
* Filter::
* Frame::
* Snapshot::
* Statistic::
* StatisticDiff::
* Trace::
* Traceback::


File: python.info,  Node: Functions<9>,  Next: DomainFilter,  Up: API

5.28.8.7 Functions
..................

 -- Function: tracemalloc.clear_traces ()

     Clear traces of memory blocks allocated by Python.

     See also *note stop(): 34f9.

 -- Function: tracemalloc.get_object_traceback (obj)

     Get the traceback where the Python object `obj' was allocated.
     Return a *note Traceback: 3f4. instance, or ‘None’ if the *note
     tracemalloc: 114. module is not tracing memory allocations or did
     not trace the allocation of the object.

     See also *note gc.get_referrers(): 34fa. and *note sys.getsizeof():
     34fb. functions.

 -- Function: tracemalloc.get_traceback_limit ()

     Get the maximum number of frames stored in the traceback of a
     trace.

     The *note tracemalloc: 114. module must be tracing memory
     allocations to get the limit, otherwise an exception is raised.

     The limit is set by the *note start(): 128a. function.

 -- Function: tracemalloc.get_traced_memory ()

     Get the current size and peak size of memory blocks traced by the
     *note tracemalloc: 114. module as a tuple: ‘(current: int, peak:
     int)’.

 -- Function: tracemalloc.get_tracemalloc_memory ()

     Get the memory usage in bytes of the *note tracemalloc: 114. module
     used to store traces of memory blocks.  Return an *note int: 184.

 -- Function: tracemalloc.is_tracing ()

     ‘True’ if the *note tracemalloc: 114. module is tracing Python
     memory allocations, ‘False’ otherwise.

     See also *note start(): 128a. and *note stop(): 34f9. functions.

 -- Function: tracemalloc.start (nframe: int=1)

     Start tracing Python memory allocations: install hooks on Python
     memory allocators.  Collected tracebacks of traces will be limited
     to `nframe' frames.  By default, a trace of a memory block only
     stores the most recent frame: the limit is ‘1’.  `nframe' must be
     greater or equal to ‘1’.

     Storing more than ‘1’ frame is only useful to compute statistics
     grouped by ‘'traceback'’ or to compute cumulative statistics: see
     the *note Snapshot.compare_to(): 3500. and *note
     Snapshot.statistics(): 34f0. methods.

     Storing more frames increases the memory and CPU overhead of the
     *note tracemalloc: 114. module.  Use the *note
     get_tracemalloc_memory(): 34fe. function to measure how much memory
     is used by the *note tracemalloc: 114. module.

     The *note PYTHONTRACEMALLOC: 1296. environment variable
     (‘PYTHONTRACEMALLOC=NFRAME’) and the *note -X: 155.
     ‘tracemalloc=NFRAME’ command line option can be used to start
     tracing at startup.

     See also *note stop(): 34f9, *note is_tracing(): 34ff. and *note
     get_traceback_limit(): 34fc. functions.

 -- Function: tracemalloc.stop ()

     Stop tracing Python memory allocations: uninstall hooks on Python
     memory allocators.  Also clears all previously collected traces of
     memory blocks allocated by Python.

     Call *note take_snapshot(): 3501. function to take a snapshot of
     traces before clearing them.

     See also *note start(): 128a, *note is_tracing(): 34ff. and *note
     clear_traces(): 34f8. functions.

 -- Function: tracemalloc.take_snapshot ()

     Take a snapshot of traces of memory blocks allocated by Python.
     Return a new *note Snapshot: 3502. instance.

     The snapshot does not include memory blocks allocated before the
     *note tracemalloc: 114. module started to trace memory allocations.

     Tracebacks of traces are limited to *note get_traceback_limit():
     34fc. frames.  Use the `nframe' parameter of the *note start():
     128a. function to store more frames.

     The *note tracemalloc: 114. module must be tracing memory
     allocations to take a snapshot, see the *note start(): 128a.
     function.

     See also the *note get_object_traceback(): 109f. function.


File: python.info,  Node: DomainFilter,  Next: Filter,  Prev: Functions<9>,  Up: API

5.28.8.8 DomainFilter
.....................

 -- Class: tracemalloc.DomainFilter (inclusive: bool, domain: int)

     Filter traces of memory blocks by their address space (domain).

     New in version 3.6.

      -- Attribute: inclusive

          If `inclusive' is ‘True’ (include), match memory blocks
          allocated in the address space *note domain: 3505.

          If `inclusive' is ‘False’ (exclude), match memory blocks not
          allocated in the address space *note domain: 3505.

      -- Attribute: domain

          Address space of a memory block (‘int’).  Read-only property.


File: python.info,  Node: Filter,  Next: Frame,  Prev: DomainFilter,  Up: API

5.28.8.9 Filter
...............

 -- Class: tracemalloc.Filter (inclusive: bool, filename_pattern: str,
          lineno: int=None, all_frames: bool=False, domain: int=None)

     Filter on traces of memory blocks.

     See the *note fnmatch.fnmatch(): 1baf. function for the syntax of
     `filename_pattern'.  The ‘'.pyc'’ file extension is replaced with
     ‘'.py'’.

     Examples:

        * ‘Filter(True, subprocess.__file__)’ only includes traces of
          the *note subprocess: f9. module

        * ‘Filter(False, tracemalloc.__file__)’ excludes traces of the
          *note tracemalloc: 114. module

        * ‘Filter(False, "<unknown>")’ excludes empty tracebacks

     Changed in version 3.5: The ‘'.pyo'’ file extension is no longer
     replaced with ‘'.py'’.

     Changed in version 3.6: Added the *note domain: 3508. attribute.

      -- Attribute: domain

          Address space of a memory block (‘int’ or ‘None’).

          tracemalloc uses the domain ‘0’ to trace memory allocations
          made by Python.  C extensions can use other domains to trace
          other resources.

      -- Attribute: inclusive

          If `inclusive' is ‘True’ (include), only match memory blocks
          allocated in a file with a name matching *note
          filename_pattern: 350a. at line number *note lineno: 350b.

          If `inclusive' is ‘False’ (exclude), ignore memory blocks
          allocated in a file with a name matching *note
          filename_pattern: 350a. at line number *note lineno: 350b.

      -- Attribute: lineno

          Line number (‘int’) of the filter.  If `lineno' is ‘None’, the
          filter matches any line number.

      -- Attribute: filename_pattern

          Filename pattern of the filter (‘str’).  Read-only property.

      -- Attribute: all_frames

          If `all_frames' is ‘True’, all frames of the traceback are
          checked.  If `all_frames' is ‘False’, only the most recent
          frame is checked.

          This attribute has no effect if the traceback limit is ‘1’.
          See the *note get_traceback_limit(): 34fc. function and *note
          Snapshot.traceback_limit: 350d. attribute.


File: python.info,  Node: Frame,  Next: Snapshot,  Prev: Filter,  Up: API

5.28.8.10 Frame
...............

 -- Class: tracemalloc.Frame

     Frame of a traceback.

     The *note Traceback: 3f4. class is a sequence of *note Frame: 350f.
     instances.

      -- Attribute: filename

          Filename (‘str’).

      -- Attribute: lineno

          Line number (‘int’).


File: python.info,  Node: Snapshot,  Next: Statistic,  Prev: Frame,  Up: API

5.28.8.11 Snapshot
..................

 -- Class: tracemalloc.Snapshot

     Snapshot of traces of memory blocks allocated by Python.

     The *note take_snapshot(): 3501. function creates a snapshot
     instance.

      -- Method: compare_to (old_snapshot: Snapshot, key_type: str,
               cumulative: bool=False)

          Compute the differences with an old snapshot.  Get statistics
          as a sorted list of *note StatisticDiff: 3513. instances
          grouped by `key_type'.

          See the *note Snapshot.statistics(): 34f0. method for
          `key_type' and `cumulative' parameters.

          The result is sorted from the biggest to the smallest by:
          absolute value of *note StatisticDiff.size_diff: 3514, *note
          StatisticDiff.size: 3515, absolute value of *note
          StatisticDiff.count_diff: 3516, *note Statistic.count: 3517.
          and then by *note StatisticDiff.traceback: 3518.

      -- Method: dump (filename)

          Write the snapshot into a file.

          Use *note load(): 34f3. to reload the snapshot.

      -- Method: filter_traces (filters)

          Create a new *note Snapshot: 3502. instance with a filtered
          *note traces: 351a. sequence, `filters' is a list of *note
          DomainFilter: 595. and *note Filter: 3507. instances.  If
          `filters' is an empty list, return a new *note Snapshot: 3502.
          instance with a copy of the traces.

          All inclusive filters are applied at once, a trace is ignored
          if no inclusive filters match it.  A trace is ignored if at
          least one exclusive filter matches it.

          Changed in version 3.6: *note DomainFilter: 595. instances are
          now also accepted in `filters'.

      -- Class Method: load (filename)

          Load a snapshot from a file.

          See also *note dump(): 34f2.

      -- Method: statistics (key_type: str, cumulative: bool=False)

          Get statistics as a sorted list of *note Statistic: 351b.
          instances grouped by `key_type':

          key_type                  description
                                    
          -------------------------------------------------------
                                    
          ‘'filename'’              filename
                                    
                                    
          ‘'lineno'’                filename and line number
                                    
                                    
          ‘'traceback'’             traceback
                                    

          If `cumulative' is ‘True’, cumulate size and count of memory
          blocks of all frames of the traceback of a trace, not only the
          most recent frame.  The cumulative mode can only be used with
          `key_type' equals to ‘'filename'’ and ‘'lineno'’.

          The result is sorted from the biggest to the smallest by:
          *note Statistic.size: 351c, *note Statistic.count: 3517. and
          then by *note Statistic.traceback: 351d.

      -- Attribute: traceback_limit

          Maximum number of frames stored in the traceback of *note
          traces: 351a.: result of the *note get_traceback_limit():
          34fc. when the snapshot was taken.

      -- Attribute: traces

          Traces of all memory blocks allocated by Python: sequence of
          *note Trace: 351e. instances.

          The sequence has an undefined order.  Use the *note
          Snapshot.statistics(): 34f0. method to get a sorted list of
          statistics.


File: python.info,  Node: Statistic,  Next: StatisticDiff,  Prev: Snapshot,  Up: API

5.28.8.12 Statistic
...................

 -- Class: tracemalloc.Statistic

     Statistic on memory allocations.

     *note Snapshot.statistics(): 34f0. returns a list of *note
     Statistic: 351b. instances.

     See also the *note StatisticDiff: 3513. class.

      -- Attribute: count

          Number of memory blocks (‘int’).

      -- Attribute: size

          Total size of memory blocks in bytes (‘int’).

      -- Attribute: traceback

          Traceback where the memory block was allocated, *note
          Traceback: 3f4. instance.


File: python.info,  Node: StatisticDiff,  Next: Trace,  Prev: Statistic,  Up: API

5.28.8.13 StatisticDiff
.......................

 -- Class: tracemalloc.StatisticDiff

     Statistic difference on memory allocations between an old and a new
     *note Snapshot: 3502. instance.

     *note Snapshot.compare_to(): 3500. returns a list of *note
     StatisticDiff: 3513. instances.  See also the *note Statistic:
     351b. class.

      -- Attribute: count

          Number of memory blocks in the new snapshot (‘int’): ‘0’ if
          the memory blocks have been released in the new snapshot.

      -- Attribute: count_diff

          Difference of number of memory blocks between the old and the
          new snapshots (‘int’): ‘0’ if the memory blocks have been
          allocated in the new snapshot.

      -- Attribute: size

          Total size of memory blocks in bytes in the new snapshot
          (‘int’): ‘0’ if the memory blocks have been released in the
          new snapshot.

      -- Attribute: size_diff

          Difference of total size of memory blocks in bytes between the
          old and the new snapshots (‘int’): ‘0’ if the memory blocks
          have been allocated in the new snapshot.

      -- Attribute: traceback

          Traceback where the memory blocks were allocated, *note
          Traceback: 3f4. instance.


File: python.info,  Node: Trace,  Next: Traceback,  Prev: StatisticDiff,  Up: API

5.28.8.14 Trace
...............

 -- Class: tracemalloc.Trace

     Trace of a memory block.

     The *note Snapshot.traces: 351a. attribute is a sequence of *note
     Trace: 351e. instances.

     Changed in version 3.6: Added the *note domain: 3523. attribute.

      -- Attribute: domain

          Address space of a memory block (‘int’).  Read-only property.

          tracemalloc uses the domain ‘0’ to trace memory allocations
          made by Python.  C extensions can use other domains to trace
          other resources.

      -- Attribute: size

          Size of the memory block in bytes (‘int’).

      -- Attribute: traceback

          Traceback where the memory block was allocated, *note
          Traceback: 3f4. instance.


File: python.info,  Node: Traceback,  Prev: Trace,  Up: API

5.28.8.15 Traceback
...................

 -- Class: tracemalloc.Traceback

     Sequence of *note Frame: 350f. instances sorted from the oldest
     frame to the most recent frame.

     A traceback contains at least ‘1’ frame.  If the ‘tracemalloc’
     module failed to get a frame, the filename ‘"<unknown>"’ at line
     number ‘0’ is used.

     When a snapshot is taken, tracebacks of traces are limited to *note
     get_traceback_limit(): 34fc. frames.  See the *note
     take_snapshot(): 3501. function.

     The *note Trace.traceback: 3525. attribute is an instance of *note
     Traceback: 3f4. instance.

     Changed in version 3.7: Frames are now sorted from the oldest to
     the most recent, instead of most recent to oldest.

      -- Method: format (limit=None, most_recent_first=False)

          Format the traceback as a list of lines with newlines.  Use
          the *note linecache: a8. module to retrieve lines from the
          source code.  If `limit' is set, format the `limit' most
          recent frames if `limit' is positive.  Otherwise, format the
          ‘abs(limit)’ oldest frames.  If `most_recent_first' is ‘True’,
          the order of the formatted frames is reversed, returning the
          most recent frame first instead of last.

          Similar to the *note traceback.format_tb(): 3527. function,
          except that *note format(): 3f5. does not include newlines.

          Example:

               print("Traceback (most recent call first):") for line in traceback:     print(line)

          Output:

               Traceback (most recent call first):   File "test.py", line 9     obj = Object()   File "test.py", line 12     tb = tracemalloc.get_object_traceback(f())


File: python.info,  Node: Software Packaging and Distribution,  Next: Python Runtime Services,  Prev: Debugging and Profiling,  Up: The Python Standard Library

5.29 Software Packaging and Distribution
========================================

These libraries help you with publishing and installing Python software.
While these modules are designed to work in conjunction with the Python
Package Index(1), they can also be used with a local index server, or
without any index server at all.

* Menu:

* distutils — Building and installing Python modules::
* ensurepip — Bootstrapping the pip installer::
* venv — Creation of virtual environments::
* zipapp — Manage executable Python zip archives::

   ---------- Footnotes ----------

   (1) https://pypi.org


File: python.info,  Node: distutils — Building and installing Python modules,  Next: ensurepip — Bootstrapping the pip installer,  Up: Software Packaging and Distribution

5.29.1 ‘distutils’ — Building and installing Python modules
-----------------------------------------------------------

__________________________________________________________________

The *note distutils: 39. package provides support for building and
installing additional modules into a Python installation.  The new
modules may be either 100%-pure Python, or may be extension modules
written in C, or may be collections of Python packages which include
modules coded in both Python and C.

Most Python users will `not' want to use this module directly, but
instead use the cross-version tools maintained by the Python Packaging
Authority.  In particular, setuptools(1) is an enhanced alternative to
*note distutils: 39. that provides:

   * support for declaring project dependencies

   * additional mechanisms for configuring which files to include in
     source releases (including plugins for integration with version
     control systems)

   * the ability to declare project “entry points”, which can be used as
     the basis for application plugin systems

   * the ability to automatically generate Windows command line
     executables at installation time rather than needing to prebuild
     them

   * consistent behaviour across all supported Python versions

The recommended pip(2) installer runs all ‘setup.py’ scripts with
‘setuptools’, even if the script itself only imports ‘distutils’.  Refer
to the Python Packaging User Guide(3) for more information.

For the benefits of packaging tool authors and users seeking a deeper
understanding of the details of the current packaging and distribution
system, the legacy *note distutils: 39. based user documentation and API
reference remain available:

   * *note Installing Python Modules (Legacy version): 7eb.

   * *note Distributing Python Modules (Legacy version): 7ec.

   ---------- Footnotes ----------

   (1) https://setuptools.readthedocs.io/en/latest/

   (2) https://pip.pypa.io/

   (3) https://packaging.python.org


File: python.info,  Node: ensurepip — Bootstrapping the pip installer,  Next: venv — Creation of virtual environments,  Prev: distutils — Building and installing Python modules,  Up: Software Packaging and Distribution

5.29.2 ‘ensurepip’ — Bootstrapping the ‘pip’ installer
------------------------------------------------------

New in version 3.4.

__________________________________________________________________

The *note ensurepip: 7a. package provides support for bootstrapping the
‘pip’ installer into an existing Python installation or virtual
environment.  This bootstrapping approach reflects the fact that ‘pip’
is an independent project with its own release cycle, and the latest
available stable version is bundled with maintenance and feature
releases of the CPython reference interpreter.

In most cases, end users of Python shouldn’t need to invoke this module
directly (as ‘pip’ should be bootstrapped by default), but it may be
needed if installing ‘pip’ was skipped when installing Python (or when
creating a virtual environment) or after explicitly uninstalling ‘pip’.

     Note: This module `does not' access the internet.  All of the
     components needed to bootstrap ‘pip’ are included as internal parts
     of the package.

See also
........

*note Installing Python Modules: 7e9.

     The end user guide for installing Python packages

PEP 453(1): Explicit bootstrapping of pip in Python installations

     The original rationale and specification for this module.

* Menu:

* Command line interface::
* Module API::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0453


File: python.info,  Node: Command line interface,  Next: Module API,  Up: ensurepip — Bootstrapping the pip installer

5.29.2.1 Command line interface
...............................

The command line interface is invoked using the interpreter’s ‘-m’
switch.

The simplest possible invocation is:

     python -m ensurepip

This invocation will install ‘pip’ if it is not already installed, but
otherwise does nothing.  To ensure the installed version of ‘pip’ is at
least as recent as the one bundled with ‘ensurepip’, pass the
‘--upgrade’ option:

     python -m ensurepip --upgrade

By default, ‘pip’ is installed into the current virtual environment (if
one is active) or into the system site packages (if there is no active
virtual environment).  The installation location can be controlled
through two additional command line options:

   * ‘--root <dir>’: Installs ‘pip’ relative to the given root directory
     rather than the root of the currently active virtual environment
     (if any) or the default root for the current Python installation.

   * ‘--user’: Installs ‘pip’ into the user site packages directory
     rather than globally for the current Python installation (this
     option is not permitted inside an active virtual environment).

By default, the scripts ‘pipX’ and ‘pipX.Y’ will be installed (where X.Y
stands for the version of Python used to invoke ‘ensurepip’).  The
scripts installed can be controlled through two additional command line
options:

   * ‘--altinstall’: if an alternate installation is requested, the
     ‘pipX’ script will `not' be installed.

   * 
     ‘--default-pip’: if a “default pip” installation is requested, the

          ‘pip’ script will be installed in addition to the two regular
          scripts.

Providing both of the script selection options will trigger an
exception.


File: python.info,  Node: Module API,  Prev: Command line interface,  Up: ensurepip — Bootstrapping the pip installer

5.29.2.2 Module API
...................

*note ensurepip: 7a. exposes two functions for programmatic use:

 -- Function: ensurepip.version ()

     Returns a string specifying the bundled version of pip that will be
     installed when bootstrapping an environment.

 -- Function: ensurepip.bootstrap (root=None, upgrade=False, user=False,
          altinstall=False, default_pip=False, verbosity=0)

     Bootstraps ‘pip’ into the current or designated environment.

     `root' specifies an alternative root directory to install relative
     to.  If `root' is ‘None’, then installation uses the default
     install location for the current environment.

     `upgrade' indicates whether or not to upgrade an existing
     installation of an earlier version of ‘pip’ to the bundled version.

     `user' indicates whether to use the user scheme rather than
     installing globally.

     By default, the scripts ‘pipX’ and ‘pipX.Y’ will be installed
     (where X.Y stands for the current version of Python).

     If `altinstall' is set, then ‘pipX’ will `not' be installed.

     If `default_pip' is set, then ‘pip’ will be installed in addition
     to the two regular scripts.

     Setting both `altinstall' and `default_pip' will trigger *note
     ValueError: 1f9.

     `verbosity' controls the level of output to *note sys.stdout: 303.
     from the bootstrapping operation.

     Raises an *note auditing event: 1275. ‘ensurepip.bootstrap’ with
     argument ‘root’.

          Note: The bootstrapping process has side effects on both
          ‘sys.path’ and ‘os.environ’.  Invoking the command line
          interface in a subprocess instead allows these side effects to
          be avoided.

          Note: The bootstrapping process may install additional modules
          required by ‘pip’, but other software should not assume those
          dependencies will always be present by default (as the
          dependencies may be removed in a future version of ‘pip’).


File: python.info,  Node: venv — Creation of virtual environments,  Next: zipapp — Manage executable Python zip archives,  Prev: ensurepip — Bootstrapping the pip installer,  Up: Software Packaging and Distribution

5.29.3 ‘venv’ — Creation of virtual environments
------------------------------------------------

New in version 3.3.

`Source code:' Lib/venv/(1)

__________________________________________________________________

The *note venv: 125. module provides support for creating lightweight
“virtual environments” with their own site directories, optionally
isolated from system site directories.  Each virtual environment has its
own Python binary (which matches the version of the binary that was used
to create this environment) and can have its own independent set of
installed Python packages in its site directories.

See PEP 405(2) for more information about Python virtual environments.

See also
........

Python Packaging User Guide: Creating and using virtual environments(3)

* Menu:

* Creating virtual environments::
* API: API<2>.
* An example of extending EnvBuilder::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/venv/

   (2) https://www.python.org/dev/peps/pep-0405

   (3) 
https://packaging.python.org/installing/#creating-virtual-environments


File: python.info,  Node: Creating virtual environments,  Next: API<2>,  Up: venv — Creation of virtual environments

5.29.3.1 Creating virtual environments
......................................

Creation of *note virtual environments: 3534. is done by executing the
command ‘venv’:

     python3 -m venv /path/to/new/virtual/environment

Running this command creates the target directory (creating any parent
directories that don’t exist already) and places a ‘pyvenv.cfg’ file in
it with a ‘home’ key pointing to the Python installation from which the
command was run (a common name for the target directory is ‘.venv’).  It
also creates a ‘bin’ (or ‘Scripts’ on Windows) subdirectory containing a
copy/symlink of the Python binary/binaries (as appropriate for the
platform or arguments used at environment creation time).  It also
creates an (initially empty) ‘lib/pythonX.Y/site-packages’ subdirectory
(on Windows, this is ‘Lib\site-packages’).  If an existing directory is
specified, it will be re-used.

Deprecated since version 3.6: ‘pyvenv’ was the recommended tool for
creating virtual environments for Python 3.3 and 3.4, and is deprecated
in Python 3.6(1).

Changed in version 3.5: The use of ‘venv’ is now recommended for
creating virtual environments.

On Windows, invoke the ‘venv’ command as follows:

     c:\>c:\Python35\python -m venv c:\path\to\myenv

Alternatively, if you configured the ‘PATH’ and ‘PATHEXT’ variables for
your *note Python installation: 2d7.:

     c:\>python -m venv c:\path\to\myenv

The command, if run with ‘-h’, will show the available options:

     usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]             [--upgrade] [--without-pip] [--prompt PROMPT]             ENV_DIR [ENV_DIR ...]  Creates virtual Python environments in one or more target directories.  positional arguments:   ENV_DIR               A directory to create the environment in.  optional arguments:   -h, --help            show this help message and exit   --system-site-packages                         Give the virtual environment access to the system                         site-packages dir.   --symlinks            Try to use symlinks rather than copies, when symlinks                         are not the default for the platform.   --copies              Try to use copies rather than symlinks, even when                         symlinks are the default for the platform.   --clear               Delete the contents of the environment directory if it                         already exists, before environment creation.   --upgrade             Upgrade the environment directory to use this version                         of Python, assuming Python has been upgraded in-place.   --without-pip         Skips installing or upgrading pip in the virtual                         environment (pip is bootstrapped by default)   --prompt PROMPT       Provides an alternative prompt prefix for this                         environment.  Once an environment has been created, you may wish to activate it, e.g. by sourcing an activate script in its bin directory.

Changed in version 3.4: Installs pip by default, added the
‘--without-pip’ and ‘--copies’ options

Changed in version 3.4: In earlier versions, if the target directory
already existed, an error was raised, unless the ‘--clear’ or
‘--upgrade’ option was provided.

     Note: While symlinks are supported on Windows, they are not
     recommended.  Of particular note is that double-clicking
     ‘python.exe’ in File Explorer will resolve the symlink eagerly and
     ignore the virtual environment.

The created ‘pyvenv.cfg’ file also includes the
‘include-system-site-packages’ key, set to ‘true’ if ‘venv’ is run with
the ‘--system-site-packages’ option, ‘false’ otherwise.

Unless the ‘--without-pip’ option is given, *note ensurepip: 7a. will be
invoked to bootstrap ‘pip’ into the virtual environment.

Multiple paths can be given to ‘venv’, in which case an identical
virtual environment will be created, according to the given options, at
each provided path.

Once a virtual environment has been created, it can be “activated” using
a script in the virtual environment’s binary directory.  The invocation
of the script is platform-specific (‘<venv>’ must be replaced by the
path of the directory containing the virtual environment):

Platform          Shell                 Command to activate virtual environment
                                        
--------------------------------------------------------------------------------------
                                        
POSIX             bash/zsh              $ source <venv>/bin/activate
                                        
                                        
                  fish                  $ .  <venv>/bin/activate.fish
                                        
                                        
                  csh/tcsh              $ source <venv>/bin/activate.csh
                                        
                                        
                  PowerShell Core       $ <venv>/bin/Activate.ps1
                                        
                                        
Windows           cmd.exe               C:\> <venv>\Scripts\activate.bat
                                        
                                        
                  PowerShell            PS C:\> <venv>\Scripts\Activate.ps1
                                        

You don’t specifically `need' to activate an environment; activation
just prepends the virtual environment’s binary directory to your path,
so that “python” invokes the virtual environment’s Python interpreter
and you can run installed scripts without having to use their full path.
However, all scripts installed in a virtual environment should be
runnable without activating it, and run with the virtual environment’s
Python automatically.

You can deactivate a virtual environment by typing “deactivate” in your
shell.  The exact mechanism is platform-specific and is an internal
implementation detail (typically a script or shell function will be
used).

New in version 3.4: ‘fish’ and ‘csh’ activation scripts.

New in version 3.8: PowerShell activation scripts installed under POSIX
for PowerShell Core support.

     Note: A virtual environment is a Python environment such that the
     Python interpreter, libraries and scripts installed into it are
     isolated from those installed in other virtual environments, and
     (by default) any libraries installed in a “system” Python, i.e.,
     one which is installed as part of your operating system.

     A virtual environment is a directory tree which contains Python
     executable files and other files which indicate that it is a
     virtual environment.

     Common installation tools such as setuptools(2) and pip(3) work as
     expected with virtual environments.  In other words, when a virtual
     environment is active, they install Python packages into the
     virtual environment without needing to be told to do so explicitly.

     When a virtual environment is active (i.e., the virtual
     environment’s Python interpreter is running), the attributes *note
     sys.prefix: 2f7b. and *note sys.exec_prefix: 3535. point to the
     base directory of the virtual environment, whereas *note
     sys.base_prefix: 3536. and *note sys.base_exec_prefix: 3537. point
     to the non-virtual environment Python installation which was used
     to create the virtual environment.  If a virtual environment is not
     active, then *note sys.prefix: 2f7b. is the same as *note
     sys.base_prefix: 3536. and *note sys.exec_prefix: 3535. is the same
     as *note sys.base_exec_prefix: 3537. (they all point to a
     non-virtual environment Python installation).

     When a virtual environment is active, any options that change the
     installation path will be ignored from all *note distutils: 39.
     configuration files to prevent projects being inadvertently
     installed outside of the virtual environment.

     When working in a command shell, users can make a virtual
     environment active by running an ‘activate’ script in the virtual
     environment’s executables directory (the precise filename and
     command to use the file is shell-dependent), which prepends the
     virtual environment’s directory for executables to the ‘PATH’
     environment variable for the running shell.  There should be no
     need in other circumstances to activate a virtual environment;
     scripts installed into virtual environments have a “shebang” line
     which points to the virtual environment’s Python interpreter.  This
     means that the script will run with that interpreter regardless of
     the value of ‘PATH’.  On Windows, “shebang” line processing is
     supported if you have the Python Launcher for Windows installed
     (this was added to Python in 3.3 - see PEP 397(4) for more
     details).  Thus, double-clicking an installed script in a Windows
     Explorer window should run the script with the correct interpreter
     without there needing to be any reference to its virtual
     environment in ‘PATH’.

   ---------- Footnotes ----------

   (1) https://docs.python.org/dev/whatsnew/3.6.html#deprecated-features

   (2) https://pypi.org/project/setuptools/

   (3) https://pypi.org/project/pip/

   (4) https://www.python.org/dev/peps/pep-0397


File: python.info,  Node: API<2>,  Next: An example of extending EnvBuilder,  Prev: Creating virtual environments,  Up: venv — Creation of virtual environments

5.29.3.2 API
............

The high-level method described above makes use of a simple API which
provides mechanisms for third-party virtual environment creators to
customize environment creation according to their needs, the *note
EnvBuilder: 8fc. class.

 -- Class: venv.EnvBuilder (system_site_packages=False, clear=False,
          symlinks=False, upgrade=False, with_pip=False, prompt=None)

     The *note EnvBuilder: 8fc. class accepts the following keyword
     arguments on instantiation:

        * ‘system_site_packages’ – a Boolean value indicating that the
          system Python site-packages should be available to the
          environment (defaults to ‘False’).

        * ‘clear’ – a Boolean value which, if true, will delete the
          contents of any existing target directory, before creating the
          environment.

        * ‘symlinks’ – a Boolean value indicating whether to attempt to
          symlink the Python binary rather than copying.

        * ‘upgrade’ – a Boolean value which, if true, will upgrade an
          existing environment with the running Python - for use when
          that Python has been upgraded in-place (defaults to ‘False’).

        * ‘with_pip’ – a Boolean value which, if true, ensures pip is
          installed in the virtual environment.  This uses *note
          ensurepip: 7a. with the ‘--default-pip’ option.

        * ‘prompt’ – a String to be used after virtual environment is
          activated (defaults to ‘None’ which means directory name of
          the environment would be used).

     Changed in version 3.4: Added the ‘with_pip’ parameter

     New in version 3.6: Added the ‘prompt’ parameter

     Creators of third-party virtual environment tools will be free to
     use the provided *note EnvBuilder: 8fc. class as a base class.

     The returned env-builder is an object which has a method, ‘create’:

      -- Method: create (env_dir)

          Create a virtual environment by specifying the target
          directory (absolute or relative to the current directory)
          which is to contain the virtual environment.  The ‘create’
          method will either create the environment in the specified
          directory, or raise an appropriate exception.

          The ‘create’ method of the *note EnvBuilder: 8fc. class
          illustrates the hooks available for subclass customization:

               def create(self, env_dir):     """     Create a virtualized Python environment in a directory.     env_dir is the target directory to create an environment in.     """     env_dir = os.path.abspath(env_dir)     context = self.ensure_directories(env_dir)     self.create_configuration(context)     self.setup_python(context)     self.setup_scripts(context)     self.post_setup(context)

          Each of the methods *note ensure_directories(): 353a, *note
          create_configuration(): 353b, *note setup_python(): 353c,
          *note setup_scripts(): 353d. and *note post_setup(): 353e. can
          be overridden.

      -- Method: ensure_directories (env_dir)

          Creates the environment directory and all necessary
          directories, and returns a context object.  This is just a
          holder for attributes (such as paths), for use by the other
          methods.  The directories are allowed to exist already, as
          long as either ‘clear’ or ‘upgrade’ were specified to allow
          operating on an existing environment directory.

      -- Method: create_configuration (context)

          Creates the ‘pyvenv.cfg’ configuration file in the
          environment.

      -- Method: setup_python (context)

          Creates a copy or symlink to the Python executable in the
          environment.  On POSIX systems, if a specific executable
          ‘python3.x’ was used, symlinks to ‘python’ and ‘python3’ will
          be created pointing to that executable, unless files with
          those names already exist.

      -- Method: setup_scripts (context)

          Installs activation scripts appropriate to the platform into
          the virtual environment.

      -- Method: post_setup (context)

          A placeholder method which can be overridden in third party
          implementations to pre-install packages in the virtual
          environment or perform other post-creation steps.

     Changed in version 3.7.2: Windows now uses redirector scripts for
     ‘python[w].exe’ instead of copying the actual binaries.  In 3.7.2
     only *note setup_python(): 353c. does nothing unless running from a
     build in the source tree.

     Changed in version 3.7.3: Windows copies the redirector scripts as
     part of *note setup_python(): 353c. instead of *note
     setup_scripts(): 353d.  This was not the case in 3.7.2.  When using
     symlinks, the original executables will be linked.

     In addition, *note EnvBuilder: 8fc. provides this utility method
     that can be called from *note setup_scripts(): 353d. or *note
     post_setup(): 353e. in subclasses to assist in installing custom
     scripts into the virtual environment.

      -- Method: install_scripts (context, path)

          `path' is the path to a directory that should contain
          subdirectories “common”, “posix”, “nt”, each containing
          scripts destined for the bin directory in the environment.
          The contents of “common” and the directory corresponding to
          *note os.name: 1e1b. are copied after some text replacement of
          placeholders:

             * ‘__VENV_DIR__’ is replaced with the absolute path of the
               environment directory.

             * ‘__VENV_NAME__’ is replaced with the environment name
               (final path segment of environment directory).

             * ‘__VENV_PROMPT__’ is replaced with the prompt (the
               environment name surrounded by parentheses and with a
               following space)

             * ‘__VENV_BIN_NAME__’ is replaced with the name of the bin
               directory (either ‘bin’ or ‘Scripts’).

             * ‘__VENV_PYTHON__’ is replaced with the absolute path of
               the environment’s executable.

          The directories are allowed to exist (for when an existing
          environment is being upgraded).

There is also a module-level convenience function:

 -- Function: venv.create (env_dir, system_site_packages=False,
          clear=False, symlinks=False, with_pip=False, prompt=None)

     Create an *note EnvBuilder: 8fc. with the given keyword arguments,
     and call its *note create(): 3539. method with the `env_dir'
     argument.

     New in version 3.3.

     Changed in version 3.4: Added the ‘with_pip’ parameter

     Changed in version 3.6: Added the ‘prompt’ parameter


File: python.info,  Node: An example of extending EnvBuilder,  Prev: API<2>,  Up: venv — Creation of virtual environments

5.29.3.3 An example of extending ‘EnvBuilder’
.............................................

The following script shows how to extend *note EnvBuilder: 8fc. by
implementing a subclass which installs setuptools and pip into a created
virtual environment:

     import os import os.path from subprocess import Popen, PIPE import sys from threading import Thread from urllib.parse import urlparse from urllib.request import urlretrieve import venv  class ExtendedEnvBuilder(venv.EnvBuilder):     """     This builder installs setuptools and pip so that you can pip or     easy_install other packages into the created virtual environment.      :param nodist: If true, setuptools and pip are not installed into the                    created virtual environment.     :param nopip: If true, pip is not installed into the created                   virtual environment.     :param progress: If setuptools or pip are installed, the progress of the                      installation can be monitored by passing a progress                      callable. If specified, it is called with two                      arguments: a string indicating some progress, and a                      context indicating where the string is coming from.                      The context argument can have one of three values:                      'main', indicating that it is called from virtualize()                      itself, and 'stdout' and 'stderr', which are obtained                      by reading lines from the output streams of a subprocess                      which is used to install the app.                       If a callable is not specified, default progress                      information is output to sys.stderr.     """      def __init__(self, *args, **kwargs):         self.nodist = kwargs.pop('nodist', False)         self.nopip = kwargs.pop('nopip', False)         self.progress = kwargs.pop('progress', None)         self.verbose = kwargs.pop('verbose', False)         super().__init__(*args, **kwargs)      def post_setup(self, context):         """         Set up any packages which need to be pre-installed into the         virtual environment being created.          :param context: The information for the virtual environment                         creation request being processed.         """         os.environ['VIRTUAL_ENV'] = context.env_dir         if not self.nodist:             self.install_setuptools(context)         # Can't install pip without setuptools         if not self.nopip and not self.nodist:             self.install_pip(context)      def reader(self, stream, context):         """         Read lines from a subprocess' output stream and either pass to a progress         callable (if specified) or write progress information to sys.stderr.         """         progress = self.progress         while True:             s = stream.readline()             if not s:                 break             if progress is not None:                 progress(s, context)             else:                 if not self.verbose:                     sys.stderr.write('.')                 else:                     sys.stderr.write(s.decode('utf-8'))                 sys.stderr.flush()         stream.close()      def install_script(self, context, name, url):         _, _, path, _, _, _ = urlparse(url)         fn = os.path.split(path)[-1]         binpath = context.bin_path         distpath = os.path.join(binpath, fn)         # Download script into the virtual environment's binaries folder         urlretrieve(url, distpath)         progress = self.progress         if self.verbose:             term = '\n'         else:             term = ''         if progress is not None:             progress('Installing %s ...%s' % (name, term), 'main')         else:             sys.stderr.write('Installing %s ...%s' % (name, term))             sys.stderr.flush()         # Install in the virtual environment         args = [context.env_exe, fn]         p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)         t1 = Thread(target=self.reader, args=(p.stdout, 'stdout'))         t1.start()         t2 = Thread(target=self.reader, args=(p.stderr, 'stderr'))         t2.start()         p.wait()         t1.join()         t2.join()         if progress is not None:             progress('done.', 'main')         else:             sys.stderr.write('done.\n')         # Clean up - no longer needed         os.unlink(distpath)      def install_setuptools(self, context):         """         Install setuptools in the virtual environment.          :param context: The information for the virtual environment                         creation request being processed.         """         url = 'https://bitbucket.org/pypa/setuptools/downloads/ez_setup.py'         self.install_script(context, 'setuptools', url)         # clear up the setuptools archive which gets downloaded         pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz')         files = filter(pred, os.listdir(context.bin_path))         for f in files:             f = os.path.join(context.bin_path, f)             os.unlink(f)      def install_pip(self, context):         """         Install pip in the virtual environment.          :param context: The information for the virtual environment                         creation request being processed.         """         url = 'https://raw.github.com/pypa/pip/master/contrib/get-pip.py'         self.install_script(context, 'pip', url)  def main(args=None):     compatible = True     if sys.version_info < (3, 3):         compatible = False     elif not hasattr(sys, 'base_prefix'):         compatible = False     if not compatible:         raise ValueError('This script is only for use with '                          'Python 3.3 or later')     else:         import argparse          parser = argparse.ArgumentParser(prog=__name__,                                          description='Creates virtual Python '                                                      'environments in one or '                                                      'more target '                                                      'directories.')         parser.add_argument('dirs', metavar='ENV_DIR', nargs='+',                             help='A directory in which to create the                                  'virtual environment.')         parser.add_argument('--no-setuptools', default=False,                             action='store_true', dest='nodist',                             help="Don't install setuptools or pip in the "                                  "virtual environment.")         parser.add_argument('--no-pip', default=False,                             action='store_true', dest='nopip',                             help="Don't install pip in the virtual "                                  "environment.")         parser.add_argument('--system-site-packages', default=False,                             action='store_true', dest='system_site',                             help='Give the virtual environment access to the '                                  'system site-packages dir.')         if os.name == 'nt':             use_symlinks = False         else:             use_symlinks = True         parser.add_argument('--symlinks', default=use_symlinks,                             action='store_true', dest='symlinks',                             help='Try to use symlinks rather than copies, '                                  'when symlinks are not the default for '                                  'the platform.')         parser.add_argument('--clear', default=False, action='store_true',                             dest='clear', help='Delete the contents of the '                                                'virtual environment '                                                'directory if it already '                                                'exists, before virtual '                                                'environment creation.')         parser.add_argument('--upgrade', default=False, action='store_true',                             dest='upgrade', help='Upgrade the virtual '                                                  'environment directory to '                                                  'use this version of '                                                  'Python, assuming Python '                                                  'has been upgraded '                                                  'in-place.')         parser.add_argument('--verbose', default=False, action='store_true',                             dest='verbose', help='Display the output '                                                'from the scripts which '                                                'install setuptools and pip.')         options = parser.parse_args(args)         if options.upgrade and options.clear:             raise ValueError('you cannot supply --upgrade and --clear together.')         builder = ExtendedEnvBuilder(system_site_packages=options.system_site,                                        clear=options.clear,                                        symlinks=options.symlinks,                                        upgrade=options.upgrade,                                        nodist=options.nodist,                                        nopip=options.nopip,                                        verbose=options.verbose)         for d in options.dirs:             builder.create(d)  if __name__ == '__main__':     rc = 1     try:         main()         rc = 0     except Exception as e:         print('Error: %s' % e, file=sys.stderr)     sys.exit(rc)

This script is also available for download online(1).

   ---------- Footnotes ----------

   (1) https://gist.github.com/vsajip/4673395


File: python.info,  Node: zipapp — Manage executable Python zip archives,  Prev: venv — Creation of virtual environments,  Up: Software Packaging and Distribution

5.29.4 ‘zipapp’ — Manage executable Python zip archives
-------------------------------------------------------

New in version 3.5.

`Source code:' Lib/zipapp.py(1)

__________________________________________________________________

This module provides tools to manage the creation of zip files
containing Python code, which can be *note executed directly by the
Python interpreter: 1274.  The module provides both a *note Command-Line
Interface: 3544. and a *note Python API: 3545.

* Menu:

* Basic Example::
* Command-Line Interface: Command-Line Interface<5>.
* Python API::
* Examples: Examples<27>.
* Specifying the Interpreter::
* Creating Standalone Applications with zipapp::
* The Python Zip Application Archive Format::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/zipapp.py


File: python.info,  Node: Basic Example,  Next: Command-Line Interface<5>,  Up: zipapp — Manage executable Python zip archives

5.29.4.1 Basic Example
......................

The following example shows how the *note Command-Line Interface: 3544.
can be used to create an executable archive from a directory containing
Python code.  When run, the archive will execute the ‘main’ function
from the module ‘myapp’ in the archive.

     $ python -m zipapp myapp -m "myapp:main" $ python myapp.pyz <output from myapp>


File: python.info,  Node: Command-Line Interface<5>,  Next: Python API,  Prev: Basic Example,  Up: zipapp — Manage executable Python zip archives

5.29.4.2 Command-Line Interface
...............................

When called as a program from the command line, the following form is
used:

     $ python -m zipapp source [options]

If `source' is a directory, this will create an archive from the
contents of `source'.  If `source' is a file, it should be an archive,
and it will be copied to the target archive (or the contents of its
shebang line will be displayed if the –info option is specified).

The following options are understood:

 -- Program Option: -o <output>, --output=<output>

     Write the output to a file named `output'.  If this option is not
     specified, the output filename will be the same as the input
     `source', with the extension ‘.pyz’ added.  If an explicit filename
     is given, it is used as is (so a ‘.pyz’ extension should be
     included if required).

     An output filename must be specified if the `source' is an archive
     (and in that case, `output' must not be the same as `source').

 -- Program Option: -p <interpreter>, --python=<interpreter>

     Add a ‘#!’ line to the archive specifying `interpreter' as the
     command to run.  Also, on POSIX, make the archive executable.  The
     default is to write no ‘#!’ line, and not make the file executable.

 -- Program Option: -m <mainfn>, --main=<mainfn>

     Write a ‘__main__.py’ file to the archive that executes `mainfn'.
     The `mainfn' argument should have the form “pkg.mod:fn”, where
     “pkg.mod” is a package/module in the archive, and “fn” is a
     callable in the given module.  The ‘__main__.py’ file will execute
     that callable.

     *note –main: 354a. cannot be specified when copying an archive.

 -- Program Option: -c, --compress

     Compress files with the deflate method, reducing the size of the
     output file.  By default, files are stored uncompressed in the
     archive.

     *note –compress: 354b. has no effect when copying an archive.

     New in version 3.7.

 -- Program Option: --info

     Display the interpreter embedded in the archive, for diagnostic
     purposes.  In this case, any other options are ignored and SOURCE
     must be an archive, not a directory.

 -- Program Option: -h, --help

     Print a short usage message and exit.


File: python.info,  Node: Python API,  Next: Examples<27>,  Prev: Command-Line Interface<5>,  Up: zipapp — Manage executable Python zip archives

5.29.4.3 Python API
...................

The module defines two convenience functions:

 -- Function: zipapp.create_archive (source, target=None,
          interpreter=None, main=None, filter=None, compressed=False)

     Create an application archive from `source'.  The source can be any
     of the following:

        * The name of a directory, or a *note path-like object: 35f.
          referring to a directory, in which case a new application
          archive will be created from the content of that directory.

        * The name of an existing application archive file, or a *note
          path-like object: 35f. referring to such a file, in which case
          the file is copied to the target (modifying it to reflect the
          value given for the `interpreter' argument).  The file name
          should include the ‘.pyz’ extension, if required.

        * A file object open for reading in bytes mode.  The content of
          the file should be an application archive, and the file object
          is assumed to be positioned at the start of the archive.

     The `target' argument determines where the resulting archive will
     be written:

        * If it is the name of a file, or a *note path-like object: 35f,
          the archive will be written to that file.

        * If it is an open file object, the archive will be written to
          that file object, which must be open for writing in bytes
          mode.

        * If the target is omitted (or ‘None’), the source must be a
          directory and the target will be a file with the same name as
          the source, with a ‘.pyz’ extension added.

     The `interpreter' argument specifies the name of the Python
     interpreter with which the archive will be executed.  It is written
     as a “shebang” line at the start of the archive.  On POSIX, this
     will be interpreted by the OS, and on Windows it will be handled by
     the Python launcher.  Omitting the `interpreter' results in no
     shebang line being written.  If an interpreter is specified, and
     the target is a filename, the executable bit of the target file
     will be set.

     The `main' argument specifies the name of a callable which will be
     used as the main program for the archive.  It can only be specified
     if the source is a directory, and the source does not already
     contain a ‘__main__.py’ file.  The `main' argument should take the
     form “pkg.module:callable” and the archive will be run by importing
     “pkg.module” and executing the given callable with no arguments.
     It is an error to omit `main' if the source is a directory and does
     not contain a ‘__main__.py’ file, as otherwise the resulting
     archive would not be executable.

     The optional `filter' argument specifies a callback function that
     is passed a Path object representing the path to the file being
     added (relative to the source directory).  It should return ‘True’
     if the file is to be added.

     The optional `compressed' argument determines whether files are
     compressed.  If set to ‘True’, files in the archive are compressed
     with the deflate method; otherwise, files are stored uncompressed.
     This argument has no effect when copying an existing archive.

     If a file object is specified for `source' or `target', it is the
     caller’s responsibility to close it after calling create_archive.

     When copying an existing archive, file objects supplied only need
     ‘read’ and ‘readline’, or ‘write’ methods.  When creating an
     archive from a directory, if the target is a file object it will be
     passed to the ‘zipfile.ZipFile’ class, and must supply the methods
     needed by that class.

     New in version 3.7: Added the `filter' and `compressed' arguments.

 -- Function: zipapp.get_interpreter (archive)

     Return the interpreter specified in the ‘#!’ line at the start of
     the archive.  If there is no ‘#!’ line, return *note None: 157.
     The `archive' argument can be a filename or a file-like object open
     for reading in bytes mode.  It is assumed to be at the start of the
     archive.


File: python.info,  Node: Examples<27>,  Next: Specifying the Interpreter,  Prev: Python API,  Up: zipapp — Manage executable Python zip archives

5.29.4.4 Examples
.................

Pack up a directory into an archive, and run it.

     $ python -m zipapp myapp $ python myapp.pyz <output from myapp>

The same can be done using the *note create_archive(): 412. function:

     >>> import zipapp >>> zipapp.create_archive('myapp.pyz', 'myapp')

To make the application directly executable on POSIX, specify an
interpreter to use.

     $ python -m zipapp myapp -p "/usr/bin/env python" $ ./myapp.pyz <output from myapp>

To replace the shebang line on an existing archive, create a modified
archive using the *note create_archive(): 412. function:

     >>> import zipapp >>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3')

To update the file in place, do the replacement in memory using a
‘BytesIO’ object, and then overwrite the source afterwards.  Note that
there is a risk when overwriting a file in place that an error will
result in the loss of the original file.  This code does not protect
against such errors, but production code should do so.  Also, this
method will only work if the archive fits in memory:

     >>> import zipapp >>> import io >>> temp = io.BytesIO() >>> zipapp.create_archive('myapp.pyz', temp, '/usr/bin/python2') >>> with open('myapp.pyz', 'wb') as f: >>>     f.write(temp.getvalue())


File: python.info,  Node: Specifying the Interpreter,  Next: Creating Standalone Applications with zipapp,  Prev: Examples<27>,  Up: zipapp — Manage executable Python zip archives

5.29.4.5 Specifying the Interpreter
...................................

Note that if you specify an interpreter and then distribute your
application archive, you need to ensure that the interpreter used is
portable.  The Python launcher for Windows supports most common forms of
POSIX ‘#!’ line, but there are other issues to consider:

   * If you use “/usr/bin/env python” (or other forms of the “python”
     command, such as “/usr/bin/python”), you need to consider that your
     users may have either Python 2 or Python 3 as their default, and
     write your code to work under both versions.

   * If you use an explicit version, for example “/usr/bin/env python3”
     your application will not work for users who do not have that
     version.  (This may be what you want if you have not made your code
     Python 2 compatible).

   * There is no way to say “python X.Y or later”, so be careful of
     using an exact version like “/usr/bin/env python3.4” as you will
     need to change your shebang line for users of Python 3.5, for
     example.

Typically, you should use an “/usr/bin/env python2” or “/usr/bin/env
python3”, depending on whether your code is written for Python 2 or 3.


File: python.info,  Node: Creating Standalone Applications with zipapp,  Next: The Python Zip Application Archive Format,  Prev: Specifying the Interpreter,  Up: zipapp — Manage executable Python zip archives

5.29.4.6 Creating Standalone Applications with zipapp
.....................................................

Using the *note zipapp: 141. module, it is possible to create
self-contained Python programs, which can be distributed to end users
who only need to have a suitable version of Python installed on their
system.  The key to doing this is to bundle all of the application’s
dependencies into the archive, along with the application code.

The steps to create a standalone archive are as follows:

  1. Create your application in a directory as normal, so you have a
     ‘myapp’ directory containing a ‘__main__.py’ file, and any
     supporting application code.

  2. Install all of your application’s dependencies into the ‘myapp’
     directory, using pip:

          $ python -m pip install -r requirements.txt --target myapp

     (this assumes you have your project requirements in a
     ‘requirements.txt’ file - if not, you can just list the
     dependencies manually on the pip command line).

  3. Optionally, delete the ‘.dist-info’ directories created by pip in
     the ‘myapp’ directory.  These hold metadata for pip to manage the
     packages, and as you won’t be making any further use of pip they
     aren’t required - although it won’t do any harm if you leave them.

  4. Package the application using:

          $ python -m zipapp -p "interpreter" myapp

This will produce a standalone executable, which can be run on any
machine with the appropriate interpreter available.  See *note
Specifying the Interpreter: 3553. for details.  It can be shipped to
users as a single file.

On Unix, the ‘myapp.pyz’ file is executable as it stands.  You can
rename the file to remove the ‘.pyz’ extension if you prefer a “plain”
command name.  On Windows, the ‘myapp.pyz[w]’ file is executable by
virtue of the fact that the Python interpreter registers the ‘.pyz’ and
‘.pyzw’ file extensions when installed.

* Menu:

* Making a Windows executable::
* Caveats::


File: python.info,  Node: Making a Windows executable,  Next: Caveats,  Up: Creating Standalone Applications with zipapp

5.29.4.7 Making a Windows executable
....................................

On Windows, registration of the ‘.pyz’ extension is optional, and
furthermore, there are certain places that don’t recognise registered
extensions “transparently” (the simplest example is that
‘subprocess.run(['myapp'])’ won’t find your application - you need to
explicitly specify the extension).

On Windows, therefore, it is often preferable to create an executable
from the zipapp.  This is relatively easy, although it does require a C
compiler.  The basic approach relies on the fact that zipfiles can have
arbitrary data prepended, and Windows exe files can have arbitrary data
appended.  So by creating a suitable launcher and tacking the ‘.pyz’
file onto the end of it, you end up with a single-file executable that
runs your application.

A suitable launcher can be as simple as the following:

     #define Py_LIMITED_API 1 #include "Python.h"  #define WIN32_LEAN_AND_MEAN #include <windows.h>  #ifdef WINDOWS int WINAPI wWinMain(     HINSTANCE hInstance,      /* handle to current instance */     HINSTANCE hPrevInstance,  /* handle to previous instance */     LPWSTR lpCmdLine,         /* pointer to command line */     int nCmdShow              /* show state of window */ ) #else int wmain() #endif {     wchar_t **myargv = _alloca((__argc + 1) * sizeof(wchar_t*));     myargv[0] = __wargv[0];     memcpy(myargv + 1, __wargv, __argc * sizeof(wchar_t *));     return Py_Main(__argc+1, myargv); }

If you define the ‘WINDOWS’ preprocessor symbol, this will generate a
GUI executable, and without it, a console executable.

To compile the executable, you can either just use the standard MSVC
command line tools, or you can take advantage of the fact that distutils
knows how to compile Python source:

     >>> from distutils.ccompiler import new_compiler >>> import distutils.sysconfig >>> import sys >>> import os >>> from pathlib import Path  >>> def compile(src): >>>     src = Path(src) >>>     cc = new_compiler() >>>     exe = src.stem >>>     cc.add_include_dir(distutils.sysconfig.get_python_inc()) >>>     cc.add_library_dir(os.path.join(sys.base_exec_prefix, 'libs')) >>>     # First the CLI executable >>>     objs = cc.compile([str(src)]) >>>     cc.link_executable(objs, exe) >>>     # Now the GUI executable >>>     cc.define_macro('WINDOWS') >>>     objs = cc.compile([str(src)]) >>>     cc.link_executable(objs, exe + 'w')  >>> if __name__ == "__main__": >>>     compile("zastub.c")

The resulting launcher uses the “Limited ABI”, so it will run unchanged
with any version of Python 3.x.  All it needs is for Python
(‘python3.dll’) to be on the user’s ‘PATH’.

For a fully standalone distribution, you can distribute the launcher
with your application appended, bundled with the Python “embedded”
distribution.  This will run on any PC with the appropriate architecture
(32 bit or 64 bit).


File: python.info,  Node: Caveats,  Prev: Making a Windows executable,  Up: Creating Standalone Applications with zipapp

5.29.4.8 Caveats
................

There are some limitations to the process of bundling your application
into a single file.  In most, if not all, cases they can be addressed
without needing major changes to your application.

  1. If your application depends on a package that includes a C
     extension, that package cannot be run from a zip file (this is an
     OS limitation, as executable code must be present in the filesystem
     for the OS loader to load it).  In this case, you can exclude that
     dependency from the zipfile, and either require your users to have
     it installed, or ship it alongside your zipfile and add code to
     your ‘__main__.py’ to include the directory containing the unzipped
     module in ‘sys.path’.  In this case, you will need to make sure to
     ship appropriate binaries for your target architecture(s) (and
     potentially pick the correct version to add to ‘sys.path’ at
     runtime, based on the user’s machine).

  2. If you are shipping a Windows executable as described above, you
     either need to ensure that your users have ‘python3.dll’ on their
     PATH (which is not the default behaviour of the installer) or you
     should bundle your application with the embedded distribution.

  3. The suggested launcher above uses the Python embedding API. This
     means that in your application, ‘sys.executable’ will be your
     application, and `not' a conventional Python interpreter.  Your
     code and its dependencies need to be prepared for this possibility.
     For example, if your application uses the *note multiprocessing:
     b7. module, it will need to call *note
     multiprocessing.set_executable(): 230d. to let the module know
     where to find the standard Python interpreter.


File: python.info,  Node: The Python Zip Application Archive Format,  Prev: Creating Standalone Applications with zipapp,  Up: zipapp — Manage executable Python zip archives

5.29.4.9 The Python Zip Application Archive Format
..................................................

Python has been able to execute zip files which contain a ‘__main__.py’
file since version 2.6.  In order to be executed by Python, an
application archive simply has to be a standard zip file containing a
‘__main__.py’ file which will be run as the entry point for the
application.  As usual for any Python script, the parent of the script
(in this case the zip file) will be placed on *note sys.path: 47d. and
thus further modules can be imported from the zip file.

The zip file format allows arbitrary data to be prepended to a zip file.
The zip application format uses this ability to prepend a standard POSIX
“shebang” line to the file (‘#!/path/to/interpreter’).

Formally, the Python zip application format is therefore:

  1. An optional shebang line, containing the characters ‘b'#!'’
     followed by an interpreter name, and then a newline (‘b'\n'’)
     character.  The interpreter name can be anything acceptable to the
     OS “shebang” processing, or the Python launcher on Windows.  The
     interpreter should be encoded in UTF-8 on Windows, and in *note
     sys.getfilesystemencoding(): 4eb. on POSIX.

  2. Standard zipfile data, as generated by the *note zipfile: 142.
     module.  The zipfile content `must' include a file called
     ‘__main__.py’ (which must be in the “root” of the zipfile - i.e.,
     it cannot be in a subdirectory).  The zipfile data can be
     compressed or uncompressed.

If an application archive has a shebang line, it may have the executable
bit set on POSIX systems, to allow it to be executed directly.

There is no requirement that the tools in this module are used to create
application archives - the module is a convenience, but archives in the
above format created by any means are acceptable to Python.


File: python.info,  Node: Python Runtime Services,  Next: Custom Python Interpreters,  Prev: Software Packaging and Distribution,  Up: The Python Standard Library

5.30 Python Runtime Services
============================

The modules described in this chapter provide a wide range of services
related to the Python interpreter and its interaction with its
environment.  Here’s an overview:

* Menu:

* sys — System-specific parameters and functions::
* sysconfig — Provide access to Python’s configuration information::
* builtins — Built-in objects::
* __main__ — Top-level script environment::
* warnings — Warning control::
* dataclasses — Data Classes::
* contextlib — Utilities for with-statement contexts::
* abc — Abstract Base Classes::
* atexit — Exit handlers::
* traceback — Print or retrieve a stack traceback::
* __future__ — Future statement definitions::
* gc — Garbage Collector interface::
* inspect — Inspect live objects::
* site — Site-specific configuration hook::


File: python.info,  Node: sys — System-specific parameters and functions,  Next: sysconfig — Provide access to Python’s configuration information,  Up: Python Runtime Services

5.30.1 ‘sys’ — System-specific parameters and functions
-------------------------------------------------------

__________________________________________________________________

This module provides access to some variables used or maintained by the
interpreter and to functions that interact strongly with the
interpreter.  It is always available.

 -- Data: sys.abiflags

     On POSIX systems where Python was built with the standard
     ‘configure’ script, this contains the ABI flags as specified by PEP
     3149(1).

     Changed in version 3.8: Default flags became an empty string (‘m’
     flag for pymalloc has been removed).

     New in version 3.2.

 -- Function: sys.addaudithook (hook)

     Append the callable `hook' to the list of active auditing hooks for
     the current interpreter.

     When an auditing event is raised through the *note sys.audit():
     3404. function, each hook will be called in the order it was added
     with the event name and the tuple of arguments.  Native hooks added
     by *note PySys_AddAuditHook(): 3406. are called first, followed by
     hooks added in the current interpreter.

     Raise an auditing event ‘sys.addaudithook’ with no arguments.  If
     any existing hooks raise an exception derived from *note
     RuntimeError: 2b8, the new hook will not be added and the exception
     suppressed.  As a result, callers cannot assume that their hook has
     been added unless they control all existing hooks.

     New in version 3.8.

     Changed in version 3.8.1: Exceptions derived from *note Exception:
     1a8. but not *note RuntimeError: 2b8. are no longer suppressed.

     `CPython implementation detail:' When tracing is enabled (see *note
     settrace(): e31.), Python hooks are only traced if the callable has
     a ‘__cantrace__’ member that is set to a true value.  Otherwise,
     trace functions will skip the hook.

 -- Data: sys.argv

     The list of command line arguments passed to a Python script.
     ‘argv[0]’ is the script name (it is operating system dependent
     whether this is a full pathname or not).  If the command was
     executed using the *note -c: 1145. command line option to the
     interpreter, ‘argv[0]’ is set to the string ‘'-c'’.  If no script
     name was passed to the Python interpreter, ‘argv[0]’ is the empty
     string.

     To loop over the standard input, or the list of files given on the
     command line, see the *note fileinput: 80. module.

          Note: On Unix, command line arguments are passed by bytes from
          OS. Python decodes them with filesystem encoding and
          “surrogateescape” error handler.  When you need original
          bytes, you can get it by ‘[os.fsencode(arg) for arg in
          sys.argv]’.
 -- Function: sys.audit (event, *args)

     Raise an auditing event with any active hooks.  The event name is a
     string identifying the event and its associated schema, which is
     the number and types of arguments.  The schema for a given event is
     considered public and stable API and should not be modified between
     releases.

     This function will raise the first exception raised by any hook.
     In general, these errors should not be handled and should terminate
     the process as quickly as possible.

     Hooks are added using the *note sys.addaudithook(): 3405. or *note
     PySys_AddAuditHook(): 3406. functions.

     The native equivalent of this function is *note PySys_Audit(): e81.
     Using the native function is preferred when possible.

     See the *note audit events table: 3401. for all events raised by
     CPython.

     New in version 3.8.

 -- Data: sys.base_exec_prefix

     Set during Python startup, before ‘site.py’ is run, to the same
     value as *note exec_prefix: 3535.  If not running in a *note
     virtual environment: 3534, the values will stay the same; if
     ‘site.py’ finds that a virtual environment is in use, the values of
     *note prefix: 2f7b. and *note exec_prefix: 3535. will be changed to
     point to the virtual environment, whereas *note base_prefix: 3536.
     and *note base_exec_prefix: 3537. will remain pointing to the base
     Python installation (the one which the virtual environment was
     created from).

     New in version 3.3.

 -- Data: sys.base_prefix

     Set during Python startup, before ‘site.py’ is run, to the same
     value as *note prefix: 2f7b.  If not running in a *note virtual
     environment: 3534, the values will stay the same; if ‘site.py’
     finds that a virtual environment is in use, the values of *note
     prefix: 2f7b. and *note exec_prefix: 3535. will be changed to point
     to the virtual environment, whereas *note base_prefix: 3536. and
     *note base_exec_prefix: 3537. will remain pointing to the base
     Python installation (the one which the virtual environment was
     created from).

     New in version 3.3.

 -- Data: sys.byteorder

     An indicator of the native byte order.  This will have the value
     ‘'big'’ on big-endian (most-significant byte first) platforms, and
     ‘'little'’ on little-endian (least-significant byte first)
     platforms.

 -- Data: sys.builtin_module_names

     A tuple of strings giving the names of all modules that are
     compiled into this Python interpreter.  (This information is not
     available in any other way — ‘modules.keys()’ only lists the
     imported modules.)

 -- Function: sys.call_tracing (func, args)

     Call ‘func(*args)’, while tracing is enabled.  The tracing state is
     saved, and restored afterwards.  This is intended to be called from
     a debugger from a checkpoint, to recursively debug some other code.

 -- Data: sys.copyright

     A string containing the copyright pertaining to the Python
     interpreter.

 -- Function: sys._clear_type_cache ()

     Clear the internal type cache.  The type cache is used to speed up
     attribute and method lookups.  Use the function `only' to drop
     unnecessary references during reference leak debugging.

     This function should be used for internal and specialized purposes
     only.

 -- Function: sys._current_frames ()

     Return a dictionary mapping each thread’s identifier to the topmost
     stack frame currently active in that thread at the time the
     function is called.  Note that functions in the *note traceback:
     113. module can build the call stack given such a frame.

     This is most useful for debugging deadlock: this function does not
     require the deadlocked threads’ cooperation, and such threads’ call
     stacks are frozen for as long as they remain deadlocked.  The frame
     returned for a non-deadlocked thread may bear no relationship to
     that thread’s current activity by the time calling code examines
     the frame.

     This function should be used for internal and specialized purposes
     only.

     Raises an *note auditing event: 1275. ‘sys._current_frames’ with no
     arguments.

 -- Function: sys.breakpointhook ()

     This hook function is called by built-in *note breakpoint(): 2ee.
     By default, it drops you into the *note pdb: c9. debugger, but it
     can be set to any other function so that you can choose which
     debugger gets used.

     The signature of this function is dependent on what it calls.  For
     example, the default binding (e.g.  ‘pdb.set_trace()’) expects no
     arguments, but you might bind it to a function that expects
     additional arguments (positional and/or keyword).  The built-in
     ‘breakpoint()’ function passes its ‘*args’ and ‘**kws’ straight
     through.  Whatever ‘breakpointhooks()’ returns is returned from
     ‘breakpoint()’.

     The default implementation first consults the environment variable
     *note PYTHONBREAKPOINT: 309.  If that is set to ‘"0"’ then this
     function returns immediately; i.e.  it is a no-op.  If the
     environment variable is not set, or is set to the empty string,
     ‘pdb.set_trace()’ is called.  Otherwise this variable should name a
     function to run, using Python’s dotted-import nomenclature, e.g.
     ‘package.subpackage.module.function’.  In this case,
     ‘package.subpackage.module’ would be imported and the resulting
     module must have a callable named ‘function()’.  This is run,
     passing in ‘*args’ and ‘**kws’, and whatever ‘function()’ returns,
     ‘sys.breakpointhook()’ returns to the built-in *note breakpoint():
     2ee. function.

     Note that if anything goes wrong while importing the callable named
     by *note PYTHONBREAKPOINT: 309, a *note RuntimeWarning: 2be. is
     reported and the breakpoint is ignored.

     Also note that if ‘sys.breakpointhook()’ is overridden
     programmatically, *note PYTHONBREAKPOINT: 309. is `not' consulted.

     New in version 3.7.

 -- Function: sys._debugmallocstats ()

     Print low-level information to stderr about the state of CPython’s
     memory allocator.

     If Python is configured –with-pydebug, it also performs some
     expensive internal consistency checks.

     New in version 3.3.

     `CPython implementation detail:' This function is specific to
     CPython.  The exact output format is not defined here, and may
     change.

 -- Data: sys.dllhandle

     Integer specifying the handle of the Python DLL.

     *note Availability: 129a.: Windows.

 -- Function: sys.displayhook (value)

     If `value' is not ‘None’, this function prints ‘repr(value)’ to
     ‘sys.stdout’, and saves `value' in ‘builtins._’.  If ‘repr(value)’
     is not encodable to ‘sys.stdout.encoding’ with ‘sys.stdout.errors’
     error handler (which is probably ‘'strict'’), encode it to
     ‘sys.stdout.encoding’ with ‘'backslashreplace'’ error handler.

     ‘sys.displayhook’ is called on the result of evaluating an *note
     expression: 3563. entered in an interactive Python session.  The
     display of these values can be customized by assigning another
     one-argument function to ‘sys.displayhook’.

     Pseudo-code:

          def displayhook(value):     if value is None:         return     # Set '_' to None to avoid recursion     builtins._ = None     text = repr(value)     try:         sys.stdout.write(text)     except UnicodeEncodeError:         bytes = text.encode(sys.stdout.encoding, 'backslashreplace')         if hasattr(sys.stdout, 'buffer'):             sys.stdout.buffer.write(bytes)         else:             text = bytes.decode(sys.stdout.encoding, 'strict')             sys.stdout.write(text)     sys.stdout.write("\n")     builtins._ = value

     Changed in version 3.2: Use ‘'backslashreplace'’ error handler on
     *note UnicodeEncodeError: 1fa.

 -- Data: sys.dont_write_bytecode

     If this is true, Python won’t try to write ‘.pyc’ files on the
     import of source modules.  This value is initially set to ‘True’ or
     ‘False’ depending on the *note -B: d2b. command line option and the
     *note PYTHONDONTWRITEBYTECODE: d2c. environment variable, but you
     can set it yourself to control bytecode file generation.

 -- Data: sys.pycache_prefix

     If this is set (not ‘None’), Python will write bytecode-cache
     ‘.pyc’ files to (and read them from) a parallel directory tree
     rooted at this directory, rather than from ‘__pycache__’
     directories in the source code tree.  Any ‘__pycache__’ directories
     in the source code tree will be ignored and new ‘.pyc’ files
     written within the pycache prefix.  Thus if you use *note
     compileall: 21. as a pre-build step, you must ensure you run it
     with the same pycache prefix (if any) that you will use at runtime.

     A relative path is interpreted relative to the current working
     directory.

     This value is initially set based on the value of the *note -X:
     155. ‘pycache_prefix=PATH’ command-line option or the *note
     PYTHONPYCACHEPREFIX: 154. environment variable (command-line takes
     precedence).  If neither are set, it is ‘None’.

     New in version 3.8.

 -- Function: sys.excepthook (type, value, traceback)

     This function prints out a given traceback and exception to
     ‘sys.stderr’.

     When an exception is raised and uncaught, the interpreter calls
     ‘sys.excepthook’ with three arguments, the exception class,
     exception instance, and a traceback object.  In an interactive
     session this happens just before control is returned to the prompt;
     in a Python program this happens just before the program exits.
     The handling of such top-level exceptions can be customized by
     assigning another three-argument function to ‘sys.excepthook’.

     Raise an auditing event ‘sys.excepthook’ with arguments ‘hook’,
     ‘type’, ‘value’, ‘traceback’ when an uncaught exception occurs.  If
     no hook has been set, ‘hook’ may be ‘None’.  If any hook raises an
     exception derived from *note RuntimeError: 2b8. the call to the
     hook will be suppressed.  Otherwise, the audit hook exception will
     be reported as unraisable and ‘sys.excepthook’ will be called.

     See also
     ........

     The *note sys.unraisablehook(): 22b. function handles unraisable
     exceptions and the *note threading.excepthook(): 22f. function
     handles exception raised by *note threading.Thread.run(): 230.

 -- Data: sys.__breakpointhook__
 -- Data: sys.__displayhook__
 -- Data: sys.__excepthook__
 -- Data: sys.__unraisablehook__

     These objects contain the original values of ‘breakpointhook’,
     ‘displayhook’, ‘excepthook’, and ‘unraisablehook’ at the start of
     the program.  They are saved so that ‘breakpointhook’,
     ‘displayhook’ and ‘excepthook’, ‘unraisablehook’ can be restored in
     case they happen to get replaced with broken or alternative
     objects.

     New in version 3.7: __breakpointhook__

 -- Function: sys.exc_info ()

     This function returns a tuple of three values that give information
     about the exception that is currently being handled.  The
     information returned is specific both to the current thread and to
     the current stack frame.  If the current stack frame is not
     handling an exception, the information is taken from the calling
     stack frame, or its caller, and so on until a stack frame is found
     that is handling an exception.  Here, “handling an exception” is
     defined as “executing an except clause.” For any stack frame, only
     information about the exception being currently handled is
     accessible.

     If no exception is being handled anywhere on the stack, a tuple
     containing three ‘None’ values is returned.  Otherwise, the values
     returned are ‘(type, value, traceback)’.  Their meaning is: `type'
     gets the type of the exception being handled (a subclass of *note
     BaseException: 1a7.); `value' gets the exception instance (an
     instance of the exception type); `traceback' gets a *note traceback
     object: 32b. which encapsulates the call stack at the point where
     the exception originally occurred.

 -- Data: sys.exec_prefix

     A string giving the site-specific directory prefix where the
     platform-dependent Python files are installed; by default, this is
     also ‘'/usr/local'’.  This can be set at build time with the
     ‘--exec-prefix’ argument to the ‘configure’ script.  Specifically,
     all configuration files (e.g.  the ‘pyconfig.h’ header file) are
     installed in the directory ‘`exec_prefix'/lib/python`X.Y'/config’,
     and shared library modules are installed in
     ‘`exec_prefix'/lib/python`X.Y'/lib-dynload’, where `X.Y' is the
     version number of Python, for example ‘3.2’.

          Note: If a *note virtual environment: 3534. is in effect, this
          value will be changed in ‘site.py’ to point to the virtual
          environment.  The value for the Python installation will still
          be available, via *note base_exec_prefix: 3537.

 -- Data: sys.executable

     A string giving the absolute path of the executable binary for the
     Python interpreter, on systems where this makes sense.  If Python
     is unable to retrieve the real path to its executable, *note
     sys.executable: 272. will be an empty string or ‘None’.

 -- Function: sys.exit ([arg])

     Exit from Python.  This is implemented by raising the *note
     SystemExit: 5f1. exception, so cleanup actions specified by finally
     clauses of *note try: d65. statements are honored, and it is
     possible to intercept the exit attempt at an outer level.

     The optional argument `arg' can be an integer giving the exit
     status (defaulting to zero), or another type of object.  If it is
     an integer, zero is considered “successful termination” and any
     nonzero value is considered “abnormal termination” by shells and
     the like.  Most systems require it to be in the range 0–127, and
     produce undefined results otherwise.  Some systems have a
     convention for assigning specific meanings to specific exit codes,
     but these are generally underdeveloped; Unix programs generally use
     2 for command line syntax errors and 1 for all other kind of
     errors.  If another type of object is passed, ‘None’ is equivalent
     to passing zero, and any other object is printed to *note stderr:
     304. and results in an exit code of 1.  In particular,
     ‘sys.exit("some error message")’ is a quick way to exit a program
     when an error occurs.

     Since *note exit(): 154a. ultimately “only” raises an exception, it
     will only exit the process when called from the main thread, and
     the exception is not intercepted.

     Changed in version 3.6: If an error occurs in the cleanup after the
     Python interpreter has caught *note SystemExit: 5f1. (such as an
     error flushing buffered data in the standard streams), the exit
     status is changed to 120.

 -- Data: sys.flags

     The *note named tuple: a98. `flags' exposes the status of command
     line flags.  The attributes are read only.

     attribute                         flag
                                       
     --------------------------------------------------------------------
                                       
     ‘debug’                           *note -d: 127d.
                                       
                                       
     *note inspect: a0.                *note -i: e12.
                                       
                                       
     ‘interactive’                     *note -i: e12.
                                       
                                       
     ‘isolated’                        *note -I: f3c.
                                       
                                       
     ‘optimize’                        *note -O: 67f. or
                                       *note -OO: 680.
                                       
                                       
     *note dont_write_bytecode: 3564.  *note -B: d2b.
                                       
                                       
     ‘no_user_site’                    *note -s: d08.
                                       
                                       
     ‘no_site’                         *note -S: b17.
                                       
                                       
     ‘ignore_environment’              *note -E: f3d.
                                       
                                       
     ‘verbose’                         *note -v: d7b.
                                       
                                       
     ‘bytes_warning’                   *note -b: 40a.
                                       
                                       
     ‘quiet’                           *note -q: 1280.
                                       
                                       
     ‘hash_randomization’              *note -R: fcc.
                                       
                                       
     ‘dev_mode’                        *note -X: 155. ‘dev’
                                       
                                       
     ‘utf8_mode’                       *note -X: 155. ‘utf8’
                                       

     Changed in version 3.2: Added ‘quiet’ attribute for the new *note
     -q: 1280. flag.

     New in version 3.2.3: The ‘hash_randomization’ attribute.

     Changed in version 3.3: Removed obsolete ‘division_warning’
     attribute.

     Changed in version 3.4: Added ‘isolated’ attribute for *note -I:
     f3c. ‘isolated’ flag.

     Changed in version 3.7: Added ‘dev_mode’ attribute for the new
     *note -X: 155. ‘dev’ flag and ‘utf8_mode’ attribute for the new
     *note -X: 155. ‘utf8’ flag.

 -- Data: sys.float_info

     A *note named tuple: a98. holding information about the float type.
     It contains low level information about the precision and internal
     representation.  The values correspond to the various
     floating-point constants defined in the standard header file
     ‘float.h’ for the ‘C’ programming language; see section 5.2.4.2.2
     of the 1999 ISO/IEC C standard *note [C99]: 3569, ‘Characteristics
     of floating types’, for details.

     attribute                 float.h macro        explanation
                                                    
     ------------------------------------------------------------------------------------------------------
                                                    
     ‘epsilon’                 DBL_EPSILON          difference between 1 and the least value greater
                                                    than 1 that is representable as a float
                                                    
                                                    
     ‘dig’                     DBL_DIG              maximum number of decimal digits that can be
                                                    faithfully represented in a float; see below
                                                    
                                                    
     ‘mant_dig’                DBL_MANT_DIG         float precision: the number of base-‘radix’ digits
                                                    in the significand of a float
                                                    
                                                    
     *note max: 7fe.           DBL_MAX              maximum representable finite float
                                                    
                                                    
     ‘max_exp’                 DBL_MAX_EXP          maximum integer e such that ‘radix**(e-1)’ is a
                                                    representable finite float
                                                    
                                                    
     ‘max_10_exp’              DBL_MAX_10_EXP       maximum integer e such that ‘10**e’ is in the range
                                                    of representable finite floats
                                                    
                                                    
     *note min: 7fd.           DBL_MIN              minimum positive normalized float
                                                    
                                                    
     ‘min_exp’                 DBL_MIN_EXP          minimum integer e such that ‘radix**(e-1)’ is a
                                                    normalized float
                                                    
                                                    
     ‘min_10_exp’              DBL_MIN_10_EXP       minimum integer e such that ‘10**e’ is a normalized
                                                    float
                                                    
                                                    
     ‘radix’                   FLT_RADIX            radix of exponent representation
                                                    
                                                    
     ‘rounds’                  FLT_ROUNDS           integer constant representing the rounding mode used
                                                    for arithmetic operations.  This reflects the value
                                                    of the system FLT_ROUNDS macro at interpreter
                                                    startup time.  See section 5.2.4.2.2 of the C99
                                                    standard for an explanation of the possible values
                                                    and their meanings.
                                                    

     The attribute ‘sys.float_info.dig’ needs further explanation.  If
     ‘s’ is any string representing a decimal number with at most
     ‘sys.float_info.dig’ significant digits, then converting ‘s’ to a
     float and back again will recover a string representing the same
     decimal value:

          >>> import sys >>> sys.float_info.dig 15 >>> s = '3.14159265358979'    # decimal string with 15 significant digits >>> format(float(s), '.15g')  # convert to float and back -> same value '3.14159265358979'

     But for strings with more than ‘sys.float_info.dig’ significant
     digits, this isn’t always true:

          >>> s = '9876543211234567'    # 16 significant digits is too many! >>> format(float(s), '.16g')  # conversion changes value '9876543211234568'

 -- Data: sys.float_repr_style

     A string indicating how the *note repr(): 7c0. function behaves for
     floats.  If the string has value ‘'short'’ then for a finite float
     ‘x’, ‘repr(x)’ aims to produce a short string with the property
     that ‘float(repr(x)) == x’.  This is the usual behaviour in Python
     3.1 and later.  Otherwise, ‘float_repr_style’ has value ‘'legacy'’
     and ‘repr(x)’ behaves in the same way as it did in versions of
     Python prior to 3.1.

     New in version 3.1.

 -- Function: sys.getallocatedblocks ()

     Return the number of memory blocks currently allocated by the
     interpreter, regardless of their size.  This function is mainly
     useful for tracking and debugging memory leaks.  Because of the
     interpreter’s internal caches, the result can vary from call to
     call; you may have to call *note _clear_type_cache(): 3560. and
     *note gc.collect(): 22c. to get more predictable results.

     If a Python build or implementation cannot reasonably compute this
     information, *note getallocatedblocks(): 8d6. is allowed to return
     0 instead.

     New in version 3.4.

 -- Function: sys.getandroidapilevel ()

     Return the build time API version of Android as an integer.

     *note Availability: 129a.: Android.

     New in version 3.7.

 -- Function: sys.getcheckinterval ()

     Return the interpreter’s “check interval”; see *note
     setcheckinterval(): 356a.

     Deprecated since version 3.2: Use *note getswitchinterval(): 356b.
     instead.

 -- Function: sys.getdefaultencoding ()

     Return the name of the current default string encoding used by the
     Unicode implementation.

 -- Function: sys.getdlopenflags ()

     Return the current value of the flags that are used for ‘dlopen()’
     calls.  Symbolic names for the flag values can be found in the
     *note os: c4. module (‘RTLD_xxx’ constants, e.g.  *note
     os.RTLD_LAZY: a54.).

     *note Availability: 129a.: Unix.

 -- Function: sys.getfilesystemencoding ()

     Return the name of the encoding used to convert between Unicode
     filenames and bytes filenames.  For best compatibility, str should
     be used for filenames in all cases, although representing filenames
     as bytes is also supported.  Functions accepting or returning
     filenames should support either str or bytes and internally convert
     to the system’s preferred representation.

     This encoding is always ASCII-compatible.

     *note os.fsencode(): 4e4. and *note os.fsdecode(): 4e3. should be
     used to ensure that the correct encoding and errors mode are used.

        * In the UTF-8 mode, the encoding is ‘utf-8’ on any platform.

        * On macOS, the encoding is ‘'utf-8'’.

        * On Unix, the encoding is the locale encoding.

        * On Windows, the encoding may be ‘'utf-8'’ or ‘'mbcs'’,
          depending on user configuration.

        * On Android, the encoding is ‘'utf-8'’.

        * On VxWorks, the encoding is ‘'utf-8'’.

     Changed in version 3.2: *note getfilesystemencoding(): 4eb. result
     cannot be ‘None’ anymore.

     Changed in version 3.6: Windows is no longer guaranteed to return
     ‘'mbcs'’.  See PEP 529(2) and *note
     _enablelegacywindowsfsencoding(): 4ed. for more information.

     Changed in version 3.7: Return ‘utf-8’ in the UTF-8 mode.

 -- Function: sys.getfilesystemencodeerrors ()

     Return the name of the error mode used to convert between Unicode
     filenames and bytes filenames.  The encoding name is returned from
     *note getfilesystemencoding(): 4eb.

     *note os.fsencode(): 4e4. and *note os.fsdecode(): 4e3. should be
     used to ensure that the correct encoding and errors mode are used.

     New in version 3.6.

 -- Function: sys.getrefcount (object)

     Return the reference count of the `object'.  The count returned is
     generally one higher than you might expect, because it includes the
     (temporary) reference as an argument to *note getrefcount(): 356d.

 -- Function: sys.getrecursionlimit ()

     Return the current value of the recursion limit, the maximum depth
     of the Python interpreter stack.  This limit prevents infinite
     recursion from causing an overflow of the C stack and crashing
     Python.  It can be set by *note setrecursionlimit(): e6f.

 -- Function: sys.getsizeof (object[, default])

     Return the size of an object in bytes.  The object can be any type
     of object.  All built-in objects will return correct results, but
     this does not have to hold true for third-party extensions as it is
     implementation specific.

     Only the memory consumption directly attributed to the object is
     accounted for, not the memory consumption of objects it refers to.

     If given, `default' will be returned if the object does not provide
     means to retrieve the size.  Otherwise a *note TypeError: 192. will
     be raised.

     *note getsizeof(): 34fb. calls the object’s ‘__sizeof__’ method and
     adds an additional garbage collector overhead if the object is
     managed by the garbage collector.

     See recursive sizeof recipe(3) for an example of using *note
     getsizeof(): 34fb. recursively to find the size of containers and
     all their contents.

 -- Function: sys.getswitchinterval ()

     Return the interpreter’s “thread switch interval”; see *note
     setswitchinterval(): bde.

     New in version 3.2.

 -- Function: sys._getframe ([depth])

     Return a frame object from the call stack.  If optional integer
     `depth' is given, return the frame object that many calls below the
     top of the stack.  If that is deeper than the call stack, *note
     ValueError: 1f9. is raised.  The default for `depth' is zero,
     returning the frame at the top of the call stack.

     Raises an *note auditing event: 1275. ‘sys._getframe’ with no
     arguments.

     `CPython implementation detail:' This function should be used for
     internal and specialized purposes only.  It is not guaranteed to
     exist in all implementations of Python.

 -- Function: sys.getprofile ()

     Get the profiler function as set by *note setprofile(): e30.

 -- Function: sys.gettrace ()

     Get the trace function as set by *note settrace(): e31.

     `CPython implementation detail:' The *note gettrace(): d3b.
     function is intended only for implementing debuggers, profilers,
     coverage tools and the like.  Its behavior is part of the
     implementation platform, rather than part of the language
     definition, and thus may not be available in all Python
     implementations.

 -- Function: sys.getwindowsversion ()

     Return a named tuple describing the Windows version currently
     running.  The named elements are `major', `minor', `build',
     `platform', `service_pack', `service_pack_minor',
     `service_pack_major', `suite_mask', `product_type' and
     `platform_version'.  `service_pack' contains a string,
     `platform_version' a 3-tuple and all other values are integers.
     The components can also be accessed by name, so
     ‘sys.getwindowsversion()[0]’ is equivalent to
     ‘sys.getwindowsversion().major’.  For compatibility with prior
     versions, only the first 5 elements are retrievable by indexing.

     `platform' will be ‘2 (VER_PLATFORM_WIN32_NT)’.

     `product_type' may be one of the following values:

     Constant                                    Meaning
                                                 
     ----------------------------------------------------------------------------------
                                                 
     ‘1 (VER_NT_WORKSTATION)’                    The system is a workstation.
                                                 
                                                 
     ‘2 (VER_NT_DOMAIN_CONTROLLER)’              The system is a domain controller.
                                                 
                                                 
     ‘3 (VER_NT_SERVER)’                         The system is a server, but not a
                                                 domain controller.
                                                 

     This function wraps the Win32 ‘GetVersionEx()’ function; see the
     Microsoft documentation on ‘OSVERSIONINFOEX()’ for more information
     about these fields.

     `platform_version' returns the accurate major version, minor
     version and build number of the current operating system, rather
     than the version that is being emulated for the process.  It is
     intended for use in logging rather than for feature detection.

     *note Availability: 129a.: Windows.

     Changed in version 3.2: Changed to a named tuple and added
     `service_pack_minor', `service_pack_major', `suite_mask', and
     `product_type'.

     Changed in version 3.6: Added `platform_version'

 -- Function: sys.get_asyncgen_hooks ()

     Returns an `asyncgen_hooks' object, which is similar to a *note
     namedtuple: 1b5. of the form ‘(firstiter, finalizer)’, where
     `firstiter' and `finalizer' are expected to be either ‘None’ or
     functions which take an *note asynchronous generator iterator:
     356f. as an argument, and are used to schedule finalization of an
     asynchronous generator by an event loop.

     New in version 3.6: See PEP 525(4) for more details.

          Note: This function has been added on a provisional basis (see
          PEP 411(5) for details.)

 -- Function: sys.get_coroutine_origin_tracking_depth ()

     Get the current coroutine origin tracking depth, as set by *note
     set_coroutine_origin_tracking_depth(): 3e8.

     New in version 3.7.

          Note: This function has been added on a provisional basis (see
          PEP 411(6) for details.)  Use it only for debugging purposes.

 -- Data: sys.hash_info

     A *note named tuple: a98. giving parameters of the numeric hash
     implementation.  For more details about hashing of numeric types,
     see *note Hashing of numeric types: 1562.

     attribute                 explanation
                               
     ---------------------------------------------------------------------------------
                               
     ‘width’                   width in bits used for hash values
                               
                               
     ‘modulus’                 prime modulus P used for numeric hash scheme
                               
                               
     ‘inf’                     hash value returned for a positive infinity
                               
                               
     ‘nan’                     hash value returned for a nan
                               
                               
     ‘imag’                    multiplier used for the imaginary part of a complex
                               number
                               
                               
     ‘algorithm’               name of the algorithm for hashing of str, bytes, and
                               memoryview
                               
                               
     ‘hash_bits’               internal output size of the hash algorithm
                               
                               
     ‘seed_bits’               size of the seed key of the hash algorithm
                               

     New in version 3.2.

     Changed in version 3.4: Added `algorithm', `hash_bits' and
     `seed_bits'

 -- Data: sys.hexversion

     The version number encoded as a single integer.  This is guaranteed
     to increase with each version, including proper support for
     non-production releases.  For example, to test that the Python
     interpreter is at least version 1.5.2, use:

          if sys.hexversion >= 0x010502F0:     # use some advanced feature     ... else:     # use an alternative implementation or warn the user     ...

     This is called ‘hexversion’ since it only really looks meaningful
     when viewed as the result of passing it to the built-in *note
     hex(): c59. function.  The *note named tuple: a98. *note
     sys.version_info: b0d. may be used for a more human-friendly
     encoding of the same information.

     More details of ‘hexversion’ can be found at *note API and ABI
     Versioning: 3571.

 -- Data: sys.implementation

     An object containing information about the implementation of the
     currently running Python interpreter.  The following attributes are
     required to exist in all Python implementations.

     `name' is the implementation’s identifier, e.g.  ‘'cpython'’.  The
     actual string is defined by the Python implementation, but it is
     guaranteed to be lower case.

     `version' is a named tuple, in the same format as *note
     sys.version_info: b0d.  It represents the version of the Python
     `implementation'.  This has a distinct meaning from the specific
     version of the Python `language' to which the currently running
     interpreter conforms, which ‘sys.version_info’ represents.  For
     example, for PyPy 1.8 ‘sys.implementation.version’ might be
     ‘sys.version_info(1, 8, 0, 'final', 0)’, whereas ‘sys.version_info’
     would be ‘sys.version_info(2, 7, 2, 'final', 0)’.  For CPython they
     are the same value, since it is the reference implementation.

     `hexversion' is the implementation version in hexadecimal format,
     like *note sys.hexversion: 3570.

     `cache_tag' is the tag used by the import machinery in the
     filenames of cached modules.  By convention, it would be a
     composite of the implementation’s name and version, like
     ‘'cpython-33'’.  However, a Python implementation may use some
     other value if appropriate.  If ‘cache_tag’ is set to ‘None’, it
     indicates that module caching should be disabled.

     *note sys.implementation: 99e. may contain additional attributes
     specific to the Python implementation.  These non-standard
     attributes must start with an underscore, and are not described
     here.  Regardless of its contents, *note sys.implementation: 99e.
     will not change during a run of the interpreter, nor between
     implementation versions.  (It may change between Python language
     versions, however.)  See PEP 421(7) for more information.

     New in version 3.3.

          Note: The addition of new required attributes must go through
          the normal PEP process.  See PEP 421(8) for more information.

 -- Data: sys.int_info

     A *note named tuple: a98. that holds information about Python’s
     internal representation of integers.  The attributes are read only.

     Attribute                     Explanation
                                   
     ---------------------------------------------------------------------------------
                                   
     ‘bits_per_digit’              number of bits held in each digit.  Python
                                   integers are stored internally in base
                                   ‘2**int_info.bits_per_digit’
                                   
                                   
     ‘sizeof_digit’                size in bytes of the C type used to represent a
                                   digit
                                   

     New in version 3.1.

 -- Data: sys.__interactivehook__

     When this attribute exists, its value is automatically called (with
     no arguments) when the interpreter is launched in *note interactive
     mode: 8d7.  This is done after the *note PYTHONSTARTUP: 8d9. file
     is read, so that you can set this hook there.  The *note site: eb.
     module *note sets this: 8da.

     Raises an *note auditing event: 1275. ‘cpython.run_interactivehook’
     with the hook object as the argument when the hook is called on
     startup.

     New in version 3.4.

 -- Function: sys.intern (string)

     Enter `string' in the table of “interned” strings and return the
     interned string – which is `string' itself or a copy.  Interning
     strings is useful to gain a little performance on dictionary lookup
     – if the keys in a dictionary are interned, and the lookup key is
     interned, the key comparisons (after hashing) can be done by a
     pointer compare instead of a string compare.  Normally, the names
     used in Python programs are automatically interned, and the
     dictionaries used to hold module, class or instance attributes have
     interned keys.

     Interned strings are not immortal; you must keep a reference to the
     return value of *note intern(): c61. around to benefit from it.

 -- Function: sys.is_finalizing ()

     Return *note True: 48f. if the Python interpreter is *note shutting
     down: 757, *note False: 37d. otherwise.

     New in version 3.5.

 -- Data: sys.last_type
 -- Data: sys.last_value
 -- Data: sys.last_traceback

     These three variables are not always defined; they are set when an
     exception is not handled and the interpreter prints an error
     message and a stack traceback.  Their intended use is to allow an
     interactive user to import a debugger module and engage in
     post-mortem debugging without having to re-execute the command that
     caused the error.  (Typical use is ‘import pdb; pdb.pm()’ to enter
     the post-mortem debugger; see *note pdb: c9. module for more
     information.)

     The meaning of the variables is the same as that of the return
     values from *note exc_info(): c52. above.

 -- Data: sys.maxsize

     An integer giving the maximum value a variable of type ‘Py_ssize_t’
     can take.  It’s usually ‘2**31 - 1’ on a 32-bit platform and ‘2**63
     - 1’ on a 64-bit platform.

 -- Data: sys.maxunicode

     An integer giving the value of the largest Unicode code point, i.e.
     ‘1114111’ (‘0x10FFFF’ in hexadecimal).

     Changed in version 3.3: Before PEP 393(9), ‘sys.maxunicode’ used to
     be either ‘0xFFFF’ or ‘0x10FFFF’, depending on the configuration
     option that specified whether Unicode characters were stored as
     UCS-2 or UCS-4.

 -- Data: sys.meta_path

     A list of *note meta path finder: 9a5. objects that have their
     *note find_spec(): 458. methods called to see if one of the objects
     can find the module to be imported.  The *note find_spec(): 458.
     method is called with at least the absolute name of the module
     being imported.  If the module to be imported is contained in a
     package, then the parent package’s *note __path__: 11c8. attribute
     is passed in as a second argument.  The method returns a *note
     module spec: 3573, or ‘None’ if the module cannot be found.

     See also
     ........

     *note importlib.abc.MetaPathFinder: 9a7.

          The abstract base class defining the interface of finder
          objects on *note meta_path: 5db.

     *note importlib.machinery.ModuleSpec: 1403.

          The concrete class which *note find_spec(): 458. should return
          instances of.

     Changed in version 3.4: *note Module specs: 3573. were introduced
     in Python 3.4, by PEP 451(10).  Earlier versions of Python looked
     for a method called *note find_module(): 457.  This is still called
     as a fallback if a *note meta_path: 5db. entry doesn’t have a *note
     find_spec(): 458. method.

 -- Data: sys.modules

     This is a dictionary that maps module names to modules which have
     already been loaded.  This can be manipulated to force reloading of
     modules and other tricks.  However, replacing the dictionary will
     not necessarily work as expected and deleting essential items from
     the dictionary may cause Python to fail.

 -- Data: sys.path

     A list of strings that specifies the search path for modules.
     Initialized from the environment variable *note PYTHONPATH: 947,
     plus an installation-dependent default.

     As initialized upon program startup, the first item of this list,
     ‘path[0]’, is the directory containing the script that was used to
     invoke the Python interpreter.  If the script directory is not
     available (e.g.  if the interpreter is invoked interactively or if
     the script is read from standard input), ‘path[0]’ is the empty
     string, which directs Python to search modules in the current
     directory first.  Notice that the script directory is inserted
     `before' the entries inserted as a result of *note PYTHONPATH: 947.

     A program is free to modify this list for its own purposes.  Only
     strings and bytes should be added to *note sys.path: 47d.; all
     other data types are ignored during import.

     See also
     ........

     Module *note site: eb. This describes how to use .pth files to
     extend *note sys.path: 47d.

 -- Data: sys.path_hooks

     A list of callables that take a path argument to try to create a
     *note finder: 13f7. for the path.  If a finder can be created, it
     is to be returned by the callable, else raise *note ImportError:
     329.

     Originally specified in PEP 302(11).

 -- Data: sys.path_importer_cache

     A dictionary acting as a cache for *note finder: 13f7. objects.
     The keys are paths that have been passed to *note sys.path_hooks:
     950. and the values are the finders that are found.  If a path is a
     valid file system path but no finder is found on *note
     sys.path_hooks: 950. then ‘None’ is stored.

     Originally specified in PEP 302(12).

     Changed in version 3.3: ‘None’ is stored instead of *note
     imp.NullImporter: 9af. when no finder is found.

 -- Data: sys.platform

     This string contains a platform identifier that can be used to
     append platform-specific components to *note sys.path: 47d, for
     instance.

     For Unix systems, except on Linux and AIX, this is the lowercased
     OS name as returned by ‘uname -s’ with the first part of the
     version as returned by ‘uname -r’ appended, e.g.  ‘'sunos5'’ or
     ‘'freebsd8'’, `at the time when Python was built'.  Unless you want
     to test for a specific system version, it is therefore recommended
     to use the following idiom:

          if sys.platform.startswith('freebsd'):     # FreeBSD-specific code here... elif sys.platform.startswith('linux'):     # Linux-specific code here... elif sys.platform.startswith('aix'):     # AIX-specific code here...

     For other systems, the values are:

     System               ‘platform’ value
                          
     -----------------------------------------------------
                          
     AIX                  ‘'aix'’
                          
                          
     Linux                ‘'linux'’
                          
                          
     Windows              ‘'win32'’
                          
                          
     Windows/Cygwin       ‘'cygwin'’
                          
                          
     macOS                ‘'darwin'’
                          

     Changed in version 3.3: On Linux, *note sys.platform: 2af. doesn’t
     contain the major version anymore.  It is always ‘'linux'’, instead
     of ‘'linux2'’ or ‘'linux3'’.  Since older Python versions include
     the version number, it is recommended to always use the
     ‘startswith’ idiom presented above.

     Changed in version 3.8: On AIX, *note sys.platform: 2af. doesn’t
     contain the major version anymore.  It is always ‘'aix'’, instead
     of ‘'aix5'’ or ‘'aix7'’.  Since older Python versions include the
     version number, it is recommended to always use the ‘startswith’
     idiom presented above.

     See also
     ........

     *note os.name: 1e1b. has a coarser granularity.  *note os.uname():
     a52. gives system-dependent version information.

     The *note platform: ce. module provides detailed checks for the
     system’s identity.

 -- Data: sys.prefix

     A string giving the site-specific directory prefix where the
     platform independent Python files are installed; by default, this
     is the string ‘'/usr/local'’.  This can be set at build time with
     the ‘--prefix’ argument to the ‘configure’ script.  The main
     collection of Python library modules is installed in the directory
     ‘`prefix'/lib/python`X.Y'’ while the platform independent header
     files (all except ‘pyconfig.h’) are stored in
     ‘`prefix'/include/python`X.Y'’, where `X.Y' is the version number
     of Python, for example ‘3.2’.

          Note: If a *note virtual environment: 3534. is in effect, this
          value will be changed in ‘site.py’ to point to the virtual
          environment.  The value for the Python installation will still
          be available, via *note base_prefix: 3536.

 -- Data: sys.ps1
 -- Data: sys.ps2

     Strings specifying the primary and secondary prompt of the
     interpreter.  These are only defined if the interpreter is in
     interactive mode.  Their initial values in this case are ‘'>>> '’
     and ‘'... '’.  If a non-string object is assigned to either
     variable, its *note str(): 325. is re-evaluated each time the
     interpreter prepares to read a new interactive command; this can be
     used to implement a dynamic prompt.

 -- Function: sys.setcheckinterval (interval)

     Set the interpreter’s “check interval”.  This integer value
     determines how often the interpreter checks for periodic things
     such as thread switches and signal handlers.  The default is ‘100’,
     meaning the check is performed every 100 Python virtual
     instructions.  Setting it to a larger value may increase
     performance for programs using threads.  Setting it to a value ‘<=’
     0 checks every virtual instruction, maximizing responsiveness as
     well as overhead.

     Deprecated since version 3.2: This function doesn’t have an effect
     anymore, as the internal logic for thread switching and
     asynchronous tasks has been rewritten.  Use *note
     setswitchinterval(): bde. instead.

 -- Function: sys.setdlopenflags (n)

     Set the flags used by the interpreter for ‘dlopen()’ calls, such as
     when the interpreter loads extension modules.  Among other things,
     this will enable a lazy resolving of symbols when importing a
     module, if called as ‘sys.setdlopenflags(0)’.  To share symbols
     across extension modules, call as
     ‘sys.setdlopenflags(os.RTLD_GLOBAL)’.  Symbolic names for the flag
     values can be found in the *note os: c4. module (‘RTLD_xxx’
     constants, e.g.  *note os.RTLD_LAZY: a54.).

     *note Availability: 129a.: Unix.

 -- Function: sys.setprofile (profilefunc)

     Set the system’s profile function, which allows you to implement a
     Python source code profiler in Python.  See chapter *note The
     Python Profilers: 3495. for more information on the Python
     profiler.  The system’s profile function is called similarly to the
     system’s trace function (see *note settrace(): e31.), but it is
     called with different events, for example it isn’t called for each
     executed line of code (only on call and return, but the return
     event is reported even when an exception has been set).  The
     function is thread-specific, but there is no way for the profiler
     to know about context switches between threads, so it does not make
     sense to use this in the presence of multiple threads.  Also, its
     return value is not used, so it can simply return ‘None’.  Error in
     the profile function will cause itself unset.

     Profile functions should have three arguments: `frame', `event',
     and `arg'.  `frame' is the current stack frame.  `event' is a
     string: ‘'call'’, ‘'return'’, ‘'c_call'’, ‘'c_return'’, or
     ‘'c_exception'’.  `arg' depends on the event type.

     Raises an *note auditing event: 1275. ‘sys.setprofile’ with no
     arguments.

     The events have the following meaning:

     ‘'call'’

          A function is called (or some other code block entered).  The
          profile function is called; `arg' is ‘None’.

     ‘'return'’

          A function (or other code block) is about to return.  The
          profile function is called; `arg' is the value that will be
          returned, or ‘None’ if the event is caused by an exception
          being raised.

     ‘'c_call'’

          A C function is about to be called.  This may be an extension
          function or a built-in.  `arg' is the C function object.

     ‘'c_return'’

          A C function has returned.  `arg' is the C function object.

     ‘'c_exception'’

          A C function has raised an exception.  `arg' is the C function
          object.

 -- Function: sys.setrecursionlimit (limit)

     Set the maximum depth of the Python interpreter stack to `limit'.
     This limit prevents infinite recursion from causing an overflow of
     the C stack and crashing Python.

     The highest possible limit is platform-dependent.  A user may need
     to set the limit higher when they have a program that requires deep
     recursion and a platform that supports a higher limit.  This should
     be done with care, because a too-high limit can lead to a crash.

     If the new limit is too low at the current recursion depth, a *note
     RecursionError: 628. exception is raised.

     Changed in version 3.5.1: A *note RecursionError: 628. exception is
     now raised if the new limit is too low at the current recursion
     depth.

 -- Function: sys.setswitchinterval (interval)

     Set the interpreter’s thread switch interval (in seconds).  This
     floating-point value determines the ideal duration of the
     “timeslices” allocated to concurrently running Python threads.
     Please note that the actual value can be higher, especially if
     long-running internal functions or methods are used.  Also, which
     thread becomes scheduled at the end of the interval is the
     operating system’s decision.  The interpreter doesn’t have its own
     scheduler.

     New in version 3.2.

 -- Function: sys.settrace (tracefunc)

     Set the system’s trace function, which allows you to implement a
     Python source code debugger in Python.  The function is
     thread-specific; for a debugger to support multiple threads, it
     must register a trace function using *note settrace(): e31. for
     each thread being debugged or use *note threading.settrace(): 2295.

     Trace functions should have three arguments: `frame', `event', and
     `arg'.  `frame' is the current stack frame.  `event' is a string:
     ‘'call'’, ‘'line'’, ‘'return'’, ‘'exception'’ or ‘'opcode'’.  `arg'
     depends on the event type.

     The trace function is invoked (with `event' set to ‘'call'’)
     whenever a new local scope is entered; it should return a reference
     to a local trace function to be used for the new scope, or ‘None’
     if the scope shouldn’t be traced.

     The local trace function should return a reference to itself (or to
     another function for further tracing in that scope), or ‘None’ to
     turn off tracing in that scope.

     If there is any error occurred in the trace function, it will be
     unset, just like ‘settrace(None)’ is called.

     The events have the following meaning:

     ‘'call'’

          A function is called (or some other code block entered).  The
          global trace function is called; `arg' is ‘None’; the return
          value specifies the local trace function.

     ‘'line'’

          The interpreter is about to execute a new line of code or
          re-execute the condition of a loop.  The local trace function
          is called; `arg' is ‘None’; the return value specifies the new
          local trace function.  See ‘Objects/lnotab_notes.txt’ for a
          detailed explanation of how this works.  Per-line events may
          be disabled for a frame by setting ‘f_trace_lines’ to *note
          False: 37d. on that frame.

     ‘'return'’

          A function (or other code block) is about to return.  The
          local trace function is called; `arg' is the value that will
          be returned, or ‘None’ if the event is caused by an exception
          being raised.  The trace function’s return value is ignored.

     ‘'exception'’

          An exception has occurred.  The local trace function is
          called; `arg' is a tuple ‘(exception, value, traceback)’; the
          return value specifies the new local trace function.

     ‘'opcode'’

          The interpreter is about to execute a new opcode (see *note
          dis: 38. for opcode details).  The local trace function is
          called; `arg' is ‘None’; the return value specifies the new
          local trace function.  Per-opcode events are not emitted by
          default: they must be explicitly requested by setting
          ‘f_trace_opcodes’ to *note True: 48f. on the frame.

     Note that as an exception is propagated down the chain of callers,
     an ‘'exception'’ event is generated at each level.

     For more fine-grained usage, it’s possible to set a trace function
     by assigning ‘frame.f_trace = tracefunc’ explicitly, rather than
     relying on it being set indirectly via the return value from an
     already installed trace function.  This is also required for
     activating the trace function on the current frame, which *note
     settrace(): e31. doesn’t do.  Note that in order for this to work,
     a global tracing function must have been installed with *note
     settrace(): e31. in order to enable the runtime tracing machinery,
     but it doesn’t need to be the same tracing function (e.g.  it could
     be a low overhead tracing function that simply returns ‘None’ to
     disable itself immediately on each frame).

     For more information on code and frame objects, refer to *note The
     standard type hierarchy: 135c.

     Raises an *note auditing event: 1275. ‘sys.settrace’ with no
     arguments.

     `CPython implementation detail:' The *note settrace(): e31.
     function is intended only for implementing debuggers, profilers,
     coverage tools and the like.  Its behavior is part of the
     implementation platform, rather than part of the language
     definition, and thus may not be available in all Python
     implementations.

     Changed in version 3.7: ‘'opcode'’ event type added;
     ‘f_trace_lines’ and ‘f_trace_opcodes’ attributes added to frames

 -- Function: sys.set_asyncgen_hooks (firstiter, finalizer)

     Accepts two optional keyword arguments which are callables that
     accept an *note asynchronous generator iterator: 356f. as an
     argument.  The `firstiter' callable will be called when an
     asynchronous generator is iterated for the first time.  The
     `finalizer' will be called when an asynchronous generator is about
     to be garbage collected.

     Raises an *note auditing event: 1275.
     ‘sys.set_asyncgen_hooks_firstiter’ with no arguments.

     Raises an *note auditing event: 1275.
     ‘sys.set_asyncgen_hooks_finalizer’ with no arguments.

     Two auditing events are raised because the underlying API consists
     of two calls, each of which must raise its own event.

     New in version 3.6: See PEP 525(13) for more details, and for a
     reference example of a `finalizer' method see the implementation of
     ‘asyncio.Loop.shutdown_asyncgens’ in Lib/asyncio/base_events.py(14)

          Note: This function has been added on a provisional basis (see
          PEP 411(15) for details.)

 -- Function: sys.set_coroutine_origin_tracking_depth (depth)

     Allows enabling or disabling coroutine origin tracking.  When
     enabled, the ‘cr_origin’ attribute on coroutine objects will
     contain a tuple of (filename, line number, function name) tuples
     describing the traceback where the coroutine object was created,
     with the most recent call first.  When disabled, ‘cr_origin’ will
     be None.

     To enable, pass a `depth' value greater than zero; this sets the
     number of frames whose information will be captured.  To disable,
     pass set `depth' to zero.

     This setting is thread-specific.

     New in version 3.7.

          Note: This function has been added on a provisional basis (see
          PEP 411(16) for details.)  Use it only for debugging purposes.

 -- Function: sys._enablelegacywindowsfsencoding ()

     Changes the default filesystem encoding and errors mode to ‘mbcs’
     and ‘replace’ respectively, for consistency with versions of Python
     prior to 3.6.

     This is equivalent to defining the *note
     PYTHONLEGACYWINDOWSFSENCODING: 4ec. environment variable before
     launching Python.

     *note Availability: 129a.: Windows.

     New in version 3.6: See PEP 529(17) for more details.

 -- Data: sys.stdin
 -- Data: sys.stdout
 -- Data: sys.stderr

     *note File objects: b35. used by the interpreter for standard
     input, output and errors:

        * ‘stdin’ is used for all interactive input (including calls to
          *note input(): c5e.);

        * ‘stdout’ is used for the output of *note print(): 87a. and
          *note expression: 3563. statements and for the prompts of
          *note input(): c5e.;

        * The interpreter’s own prompts and its error messages go to
          ‘stderr’.

     These streams are regular *note text files: 11de. like those
     returned by the *note open(): 4e5. function.  Their parameters are
     chosen as follows:

        * The character encoding is platform-dependent.  Non-Windows
          platforms use the locale encoding (see *note
          locale.getpreferredencoding(): 39a.).

          On Windows, UTF-8 is used for the console device.
          Non-character devices such as disk files and pipes use the
          system locale encoding (i.e.  the ANSI codepage).  Non-console
          character devices such as NUL (i.e.  where ‘isatty()’ returns
          ‘True’) use the value of the console input and output
          codepages at startup, respectively for stdin and
          stdout/stderr.  This defaults to the system locale encoding if
          the process is not initially attached to a console.

          The special behaviour of the console can be overridden by
          setting the environment variable PYTHONLEGACYWINDOWSSTDIO
          before starting Python.  In that case, the console codepages
          are used as for any other character device.

          Under all platforms, you can override the character encoding
          by setting the *note PYTHONIOENCODING: 923. environment
          variable before starting Python or by using the new *note -X:
          155. ‘utf8’ command line option and *note PYTHONUTF8: 306.
          environment variable.  However, for the Windows console, this
          only applies when *note PYTHONLEGACYWINDOWSSTDIO: 4ef. is also
          set.

        * When interactive, ‘stdout’ and ‘stderr’ streams are
          line-buffered.  Otherwise, they are block-buffered like
          regular text files.  You can override this value with the
          *note -u: 1283. command-line option.

          Note: To write or read binary data from/to the standard
          streams, use the underlying binary *note buffer: c2d. object.
          For example, to write bytes to *note stdout: 303, use
          ‘sys.stdout.buffer.write(b'abc')’.

          However, if you are writing a library (and do not control in
          which context its code will be executed), be aware that the
          standard streams may be replaced with file-like objects like
          *note io.StringIO: 821. which do not support the ‘buffer’
          attribute.

 -- Data: sys.__stdin__
 -- Data: sys.__stdout__
 -- Data: sys.__stderr__

     These objects contain the original values of ‘stdin’, ‘stderr’ and
     ‘stdout’ at the start of the program.  They are used during
     finalization, and could be useful to print to the actual standard
     stream no matter if the ‘sys.std*’ object has been redirected.

     It can also be used to restore the actual files to known working
     file objects in case they have been overwritten with a broken
     object.  However, the preferred way to do this is to explicitly
     save the previous stream before replacing it, and restore the saved
     object.

          Note: Under some conditions ‘stdin’, ‘stdout’ and ‘stderr’ as
          well as the original values ‘__stdin__’, ‘__stdout__’ and
          ‘__stderr__’ can be ‘None’.  It is usually the case for
          Windows GUI apps that aren’t connected to a console and Python
          apps started with ‘pythonw’.

 -- Data: sys.thread_info

     A *note named tuple: a98. holding information about the thread
     implementation.

     Attribute              Explanation
                            
     -------------------------------------------------------------------------------------
                            
     ‘name’                 Name of the thread implementation:
                            
                                    * ‘'nt'’: Windows threads
                            
                                    * ‘'pthread'’: POSIX threads
                            
                                    * ‘'solaris'’: Solaris threads
                            
                            
     ‘lock’                 Name of the lock implementation:
                            
                                    * ‘'semaphore'’: a lock uses a semaphore
                            
                                    * ‘'mutex+cond'’: a lock uses a mutex and a
                                      condition variable
                            
                                    * ‘None’ if this information is unknown
                            
                            
     *note version: 5c8.    Name and version of the thread library.  It is a string, or
                            ‘None’ if this information is unknown.
                            

     New in version 3.3.

 -- Data: sys.tracebacklimit

     When this variable is set to an integer value, it determines the
     maximum number of levels of traceback information printed when an
     unhandled exception occurs.  The default is ‘1000’.  When set to
     ‘0’ or less, all traceback information is suppressed and only the
     exception type and value are printed.

 -- Function: sys.unraisablehook (unraisable, /)

     Handle an unraisable exception.

     Called when an exception has occurred but there is no way for
     Python to handle it.  For example, when a destructor raises an
     exception or during garbage collection (*note gc.collect(): 22c.).

     The `unraisable' argument has the following attributes:

        * `exc_type': Exception type.

        * `exc_value': Exception value, can be ‘None’.

        * `exc_traceback': Exception traceback, can be ‘None’.

        * `err_msg': Error message, can be ‘None’.

        * `object': Object causing the exception, can be ‘None’.

     The default hook formats `err_msg' and `object' as: ‘f'{err_msg}:
     {object!r}'’; use “Exception ignored in” error message if `err_msg'
     is ‘None’.

     *note sys.unraisablehook(): 22b. can be overridden to control how
     unraisable exceptions are handled.

     Storing `exc_value' using a custom hook can create a reference
     cycle.  It should be cleared explicitly to break the reference
     cycle when the exception is no longer needed.

     Storing `object' using a custom hook can resurrect it if it is set
     to an object which is being finalized.  Avoid storing `object'
     after the custom hook completes to avoid resurrecting objects.

     See also *note excepthook(): e57. which handles uncaught
     exceptions.

     Raise an auditing event ‘sys.unraisablehook’ with arguments ‘hook’,
     ‘unraisable’ when an exception that cannot be handled occurs.  The
     ‘unraisable’ object is the same as what will be passed to the hook.
     If no hook has been set, ‘hook’ may be ‘None’.

     New in version 3.8.

 -- Data: sys.version

     A string containing the version number of the Python interpreter
     plus additional information on the build number and compiler used.
     This string is displayed when the interactive interpreter is
     started.  Do not extract version information out of it, rather, use
     *note version_info: b0d. and the functions provided by the *note
     platform: ce. module.

 -- Data: sys.api_version

     The C API version for this interpreter.  Programmers may find this
     useful when debugging version conflicts between Python and
     extension modules.

 -- Data: sys.version_info

     A tuple containing the five components of the version number:
     `major', `minor', `micro', `releaselevel', and `serial'.  All
     values except `releaselevel' are integers; the release level is
     ‘'alpha'’, ‘'beta'’, ‘'candidate'’, or ‘'final'’.  The
     ‘version_info’ value corresponding to the Python version 2.0 is
     ‘(2, 0, 0, 'final', 0)’.  The components can also be accessed by
     name, so ‘sys.version_info[0]’ is equivalent to
     ‘sys.version_info.major’ and so on.

     Changed in version 3.1: Added named component attributes.

 -- Data: sys.warnoptions

     This is an implementation detail of the warnings framework; do not
     modify this value.  Refer to the *note warnings: 126. module for
     more information on the warnings framework.

 -- Data: sys.winver

     The version number used to form registry keys on Windows platforms.
     This is stored as string resource 1000 in the Python DLL. The value
     is normally the first three characters of *note version: 5c8.  It
     is provided in the *note sys: fd. module for informational
     purposes; modifying this value has no effect on the registry keys
     used by Python.

     *note Availability: 129a.: Windows.

 -- Data: sys._xoptions

     A dictionary of the various implementation-specific flags passed
     through the *note -X: 155. command-line option.  Option names are
     either mapped to their values, if given explicitly, or to *note
     True: 48f.  Example:

          $ ./python -Xa=b -Xc Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50) [GCC 4.4.3] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import sys >>> sys._xoptions {'a': 'b', 'c': True}

     `CPython implementation detail:' This is a CPython-specific way of
     accessing options passed through *note -X: 155.  Other
     implementations may export them through other means, or not at all.

     New in version 3.2.

Citations
.........

(C99) ISO/IEC 9899:1999.  “Programming languages – C.” A public draft of
this standard is available at
‘http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf’.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3149

   (2) https://www.python.org/dev/peps/pep-0529

   (3) https://code.activestate.com/recipes/577504

   (4) https://www.python.org/dev/peps/pep-0525

   (5) https://www.python.org/dev/peps/pep-0411

   (6) https://www.python.org/dev/peps/pep-0411

   (7) https://www.python.org/dev/peps/pep-0421

   (8) https://www.python.org/dev/peps/pep-0421

   (9) https://www.python.org/dev/peps/pep-0393

   (10) https://www.python.org/dev/peps/pep-0451

   (11) https://www.python.org/dev/peps/pep-0302

   (12) https://www.python.org/dev/peps/pep-0302

   (13) https://www.python.org/dev/peps/pep-0525

   (14) 
https://github.com/python/cpython/tree/3.8/Lib/asyncio/base_events.py

   (15) https://www.python.org/dev/peps/pep-0411

   (16) https://www.python.org/dev/peps/pep-0411

   (17) https://www.python.org/dev/peps/pep-0529


File: python.info,  Node: sysconfig — Provide access to Python’s configuration information,  Next: builtins — Built-in objects,  Prev: sys — System-specific parameters and functions,  Up: Python Runtime Services

5.30.2 ‘sysconfig’ — Provide access to Python’s configuration information
-------------------------------------------------------------------------

New in version 3.2.

`Source code:' Lib/sysconfig.py(1)

__________________________________________________________________

The *note sysconfig: fe. module provides access to Python’s
configuration information like the list of installation paths and the
configuration variables relevant for the current platform.

* Menu:

* Configuration variables::
* Installation paths::
* Other functions: Other functions<3>.
* Using sysconfig as a script::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/sysconfig.py


File: python.info,  Node: Configuration variables,  Next: Installation paths,  Up: sysconfig — Provide access to Python’s configuration information

5.30.2.1 Configuration variables
................................

A Python distribution contains a ‘Makefile’ and a ‘pyconfig.h’ header
file that are necessary to build both the Python binary itself and
third-party C extensions compiled using *note distutils: 39.

*note sysconfig: fe. puts all variables found in these files in a
dictionary that can be accessed using *note get_config_vars(): 959. or
*note get_config_var(): 958.

Notice that on Windows, it’s a much smaller set.

 -- Function: sysconfig.get_config_vars (*args)

     With no arguments, return a dictionary of all configuration
     variables relevant for the current platform.

     With arguments, return a list of values that result from looking up
     each argument in the configuration variable dictionary.

     For each argument, if the value is not found, return ‘None’.

 -- Function: sysconfig.get_config_var (name)

     Return the value of a single variable `name'.  Equivalent to
     ‘get_config_vars().get(name)’.

     If `name' is not found, return ‘None’.

Example of usage:

     >>> import sysconfig >>> sysconfig.get_config_var('Py_ENABLE_SHARED') 0 >>> sysconfig.get_config_var('LIBDIR') '/usr/local/lib' >>> sysconfig.get_config_vars('AR', 'CXX') ['ar', 'g++']


File: python.info,  Node: Installation paths,  Next: Other functions<3>,  Prev: Configuration variables,  Up: sysconfig — Provide access to Python’s configuration information

5.30.2.2 Installation paths
...........................

Python uses an installation scheme that differs depending on the
platform and on the installation options.  These schemes are stored in
*note sysconfig: fe. under unique identifiers based on the value
returned by *note os.name: 1e1b.

Every new component that is installed using *note distutils: 39. or a
Distutils-based system will follow the same scheme to copy its file in
the right places.

Python currently supports seven schemes:

   - `posix_prefix': scheme for Posix platforms like Linux or Mac OS X.
     This is the default scheme used when Python or a component is
     installed.

   - `posix_home': scheme for Posix platforms used when a `home' option
     is used upon installation.  This scheme is used when a component is
     installed through Distutils with a specific home prefix.

   - `posix_user': scheme for Posix platforms used when a component is
     installed through Distutils and the `user' option is used.  This
     scheme defines paths located under the user home directory.

   - `nt': scheme for NT platforms like Windows.

   - `nt_user': scheme for NT platforms, when the `user' option is used.

Each scheme is itself composed of a series of paths and each path has a
unique identifier.  Python currently uses eight paths:

   - `stdlib': directory containing the standard Python library files
     that are not platform-specific.

   - `platstdlib': directory containing the standard Python library
     files that are platform-specific.

   - `platlib': directory for site-specific, platform-specific files.

   - `purelib': directory for site-specific, non-platform-specific
     files.

   - `include': directory for non-platform-specific header files.

   - `platinclude': directory for platform-specific header files.

   - `scripts': directory for script files.

   - `data': directory for data files.

*note sysconfig: fe. provides some functions to determine these paths.

 -- Function: sysconfig.get_scheme_names ()

     Return a tuple containing all schemes currently supported in *note
     sysconfig: fe.

 -- Function: sysconfig.get_path_names ()

     Return a tuple containing all path names currently supported in
     *note sysconfig: fe.

 -- Function: sysconfig.get_path (name[, scheme[, vars[, expand]]])

     Return an installation path corresponding to the path `name', from
     the install scheme named `scheme'.

     `name' has to be a value from the list returned by *note
     get_path_names(): 357e.

     *note sysconfig: fe. stores installation paths corresponding to
     each path name, for each platform, with variables to be expanded.
     For instance the `stdlib' path for the `nt' scheme is:
     ‘{base}/Lib’.

     *note get_path(): cb1. will use the variables returned by *note
     get_config_vars(): 959. to expand the path.  All variables have
     default values for each platform so one may call this function and
     get the default value.

     If `scheme' is provided, it must be a value from the list returned
     by *note get_scheme_names(): 357d.  Otherwise, the default scheme
     for the current platform is used.

     If `vars' is provided, it must be a dictionary of variables that
     will update the dictionary return by *note get_config_vars(): 959.

     If `expand' is set to ‘False’, the path will not be expanded using
     the variables.

     If `name' is not found, return ‘None’.

 -- Function: sysconfig.get_paths ([scheme[, vars[, expand]]])

     Return a dictionary containing all installation paths corresponding
     to an installation scheme.  See *note get_path(): cb1. for more
     information.

     If `scheme' is not provided, will use the default scheme for the
     current platform.

     If `vars' is provided, it must be a dictionary of variables that
     will update the dictionary used to expand the paths.

     If `expand' is set to false, the paths will not be expanded.

     If `scheme' is not an existing scheme, *note get_paths(): bcc. will
     raise a *note KeyError: 2c5.


File: python.info,  Node: Other functions<3>,  Next: Using sysconfig as a script,  Prev: Installation paths,  Up: sysconfig — Provide access to Python’s configuration information

5.30.2.3 Other functions
........................

 -- Function: sysconfig.get_python_version ()

     Return the ‘MAJOR.MINOR’ Python version number as a string.
     Similar to ‘'%d.%d' % sys.version_info[:2]’.

 -- Function: sysconfig.get_platform ()

     Return a string that identifies the current platform.

     This is used mainly to distinguish platform-specific build
     directories and platform-specific built distributions.  Typically
     includes the OS name and version and the architecture (as supplied
     by ‘os.uname()’), although the exact information included depends
     on the OS; e.g., on Linux, the kernel version isn’t particularly
     important.

     Examples of returned values:

        - linux-i586

        - linux-alpha (?)

        - solaris-2.6-sun4u

     Windows will return one of:

        - win-amd64 (64bit Windows on AMD64, aka x86_64, Intel64, and
          EM64T)

        - win32 (all others - specifically, sys.platform is returned)

     Mac OS X can return:

        - macosx-10.6-ppc

        - macosx-10.4-ppc64

        - macosx-10.3-i386

        - macosx-10.4-fat

     For other non-POSIX platforms, currently just returns *note
     sys.platform: 2af.

 -- Function: sysconfig.is_python_build ()

     Return ‘True’ if the running Python interpreter was built from
     source and is being run from its built location, and not from a
     location resulting from e.g.  running ‘make install’ or installing
     via a binary installer.

 -- Function: sysconfig.parse_config_h (fp[, vars])

     Parse a ‘config.h’-style file.

     `fp' is a file-like object pointing to the ‘config.h’-like file.

     A dictionary containing name/value pairs is returned.  If an
     optional dictionary is passed in as the second argument, it is used
     instead of a new dictionary, and updated with the values read in
     the file.

 -- Function: sysconfig.get_config_h_filename ()

     Return the path of ‘pyconfig.h’.

 -- Function: sysconfig.get_makefile_filename ()

     Return the path of ‘Makefile’.


File: python.info,  Node: Using sysconfig as a script,  Prev: Other functions<3>,  Up: sysconfig — Provide access to Python’s configuration information

5.30.2.4 Using ‘sysconfig’ as a script
......................................

You can use *note sysconfig: fe. as a script with Python’s `-m' option:

     $ python -m sysconfig Platform: "macosx-10.4-i386" Python version: "3.2" Current installation scheme: "posix_prefix"  Paths:         data = "/usr/local"         include = "/Users/tarek/Dev/svn.python.org/py3k/Include"         platinclude = "."         platlib = "/usr/local/lib/python3.2/site-packages"         platstdlib = "/usr/local/lib/python3.2"         purelib = "/usr/local/lib/python3.2/site-packages"         scripts = "/usr/local/bin"         stdlib = "/usr/local/lib/python3.2"  Variables:         AC_APPLE_UNIVERSAL_BUILD = "0"         AIX_GENUINE_CPLUSPLUS = "0"         AR = "ar"         ARFLAGS = "rc"         ...

This call will print in the standard output the information returned by
*note get_platform(): bca, *note get_python_version(): bcb, *note
get_path(): cb1. and *note get_config_vars(): 959.


File: python.info,  Node: builtins — Built-in objects,  Next: __main__ — Top-level script environment,  Prev: sysconfig — Provide access to Python’s configuration information,  Up: Python Runtime Services

5.30.3 ‘builtins’ — Built-in objects
------------------------------------

__________________________________________________________________

This module provides direct access to all ‘built-in’ identifiers of
Python; for example, ‘builtins.open’ is the full name for the built-in
function *note open(): 4e5.  See *note Built-in Functions: be6. and
*note Built-in Constants: 1546. for documentation.

This module is not normally accessed explicitly by most applications,
but can be useful in modules that provide objects with the same name as
a built-in value, but in which the built-in of that name is also needed.
For example, in a module that wants to implement an *note open(): 4e5.
function that wraps the built-in *note open(): 4e5, this module can be
used directly:

     import builtins  def open(path):     f = builtins.open(path, 'r')     return UpperCaser(f)  class UpperCaser:     '''Wrapper around a file that converts output to upper-case.'''      def __init__(self, f):         self._f = f      def read(self, count=-1):         return self._f.read(count).upper()      # ...

As an implementation detail, most modules have the name ‘__builtins__’
made available as part of their globals.  The value of ‘__builtins__’ is
normally either this module or the value of this module’s *note
__dict__: 4f1. attribute.  Since this is an implementation detail, it
may not be used by alternate implementations of Python.


File: python.info,  Node: __main__ — Top-level script environment,  Next: warnings — Warning control,  Prev: builtins — Built-in objects,  Up: Python Runtime Services

5.30.4 ‘__main__’ — Top-level script environment
------------------------------------------------

__________________________________________________________________

‘'__main__'’ is the name of the scope in which top-level code executes.
A module’s __name__ is set equal to ‘'__main__'’ when read from standard
input, a script, or from an interactive prompt.

A module can discover whether or not it is running in the main scope by
checking its own ‘__name__’, which allows a common idiom for
conditionally executing code in a module when it is run as a script or
with ‘python -m’ but not when it is imported:

     if __name__ == "__main__":     # execute only if run as a script     main()

For a package, the same effect can be achieved by including a
‘__main__.py’ module, the contents of which will be executed when the
module is run with ‘-m’.


File: python.info,  Node: warnings — Warning control,  Next: dataclasses — Data Classes,  Prev: __main__ — Top-level script environment,  Up: Python Runtime Services

5.30.5 ‘warnings’ — Warning control
-----------------------------------

`Source code:' Lib/warnings.py(1)

__________________________________________________________________

Warning messages are typically issued in situations where it is useful
to alert the user of some condition in a program, where that condition
(normally) doesn’t warrant raising an exception and terminating the
program.  For example, one might want to issue a warning when a program
uses an obsolete module.

Python programmers issue warnings by calling the *note warn(): e4b.
function defined in this module.  (C programmers use *note
PyErr_WarnEx(): da4.; see *note Exception Handling: 358a. for details).

Warning messages are normally written to *note sys.stderr: 304, but
their disposition can be changed flexibly, from ignoring all warnings to
turning them into exceptions.  The disposition of warnings can vary
based on the *note warning category: 1651, the text of the warning
message, and the source location where it is issued.  Repetitions of a
particular warning for the same source location are typically
suppressed.

There are two stages in warning control: first, each time a warning is
issued, a determination is made whether a message should be issued or
not; next, if a message is to be issued, it is formatted and printed
using a user-settable hook.

The determination whether to issue a warning message is controlled by
the *note warning filter: 1287, which is a sequence of matching rules
and actions.  Rules can be added to the filter by calling *note
filterwarnings(): dfa. and reset to its default state by calling *note
resetwarnings(): 358b.

The printing of warning messages is done by calling *note showwarning():
358c, which may be overridden; the default implementation of this
function formats the message by calling *note formatwarning(): f26,
which is also available for use by custom implementations.

See also
........

*note logging.captureWarnings(): 200f. allows you to handle all warnings
with the standard logging infrastructure.

* Menu:

* Warning Categories::
* The Warnings Filter::
* Temporarily Suppressing Warnings::
* Testing Warnings::
* Updating Code For New Versions of Dependencies::
* Available Functions::
* Available Context Managers::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/warnings.py


File: python.info,  Node: Warning Categories,  Next: The Warnings Filter,  Up: warnings — Warning control

5.30.5.1 Warning Categories
...........................

There are a number of built-in exceptions that represent warning
categories.  This categorization is useful to be able to filter out
groups of warnings.

While these are technically *note built-in exceptions: 164f, they are
documented here, because conceptually they belong to the warnings
mechanism.

User code can define additional warning categories by subclassing one of
the standard warning categories.  A warning category must always be a
subclass of the *note Warning: 1652. class.

The following warnings category classes are currently defined:

Class                                  Description
                                       
-------------------------------------------------------------------------------------------
                                       
*note Warning: 1652.                   This is the base class of all warning category
                                       classes.  It is a subclass of
                                       *note Exception: 1a8.
                                       
                                       
*note UserWarning: 1653.               The default category for *note warn(): e4b.
                                       
                                       
*note DeprecationWarning: 276.         Base category for warnings about deprecated
                                       features when those warnings are intended for
                                       other Python developers (ignored by default,
                                       unless triggered by code in ‘__main__’).
                                       
                                       
*note SyntaxWarning: 191.              Base category for warnings about dubious
                                       syntactic features.
                                       
                                       
*note RuntimeWarning: 2be.             Base category for warnings about dubious runtime
                                       features.
                                       
                                       
*note FutureWarning: 31a.              Base category for warnings about deprecated
                                       features when those warnings are intended for end
                                       users of applications that are written in Python.
                                       
                                       
*note PendingDeprecationWarning: 277.  Base category for warnings about features that
                                       will be deprecated in the future (ignored by
                                       default).
                                       
                                       
*note ImportWarning: 5cd.              Base category for warnings triggered during the
                                       process of importing a module (ignored by
                                       default).
                                       
                                       
*note UnicodeWarning: d7a.             Base category for warnings related to Unicode.
                                       
                                       
*note BytesWarning: 4ab.               Base category for warnings related to
                                       *note bytes: 326. and *note bytearray: 327.
                                       
                                       
*note ResourceWarning: 4c5.            Base category for warnings related to resource
                                       usage.
                                       

Changed in version 3.7: Previously *note DeprecationWarning: 276. and
*note FutureWarning: 31a. were distinguished based on whether a feature
was being removed entirely or changing its behaviour.  They are now
distinguished based on their intended audience and the way they’re
handled by the default warnings filters.


File: python.info,  Node: The Warnings Filter,  Next: Temporarily Suppressing Warnings,  Prev: Warning Categories,  Up: warnings — Warning control

5.30.5.2 The Warnings Filter
............................

The warnings filter controls whether warnings are ignored, displayed, or
turned into errors (raising an exception).

Conceptually, the warnings filter maintains an ordered list of filter
specifications; any specific warning is matched against each filter
specification in the list in turn until a match is found; the filter
determines the disposition of the match.  Each entry is a tuple of the
form (`action', `message', `category', `module', `lineno'), where:

   * `action' is one of the following strings:

     Value               Disposition
                         
     -----------------------------------------------------------------------
                         
     ‘"default"’         print the first occurrence of matching warnings
                         for each location (module + line number) where
                         the warning is issued
                         
                         
     ‘"error"’           turn matching warnings into exceptions
                         
                         
     ‘"ignore"’          never print matching warnings
                         
                         
     ‘"always"’          always print matching warnings
                         
                         
     ‘"module"’          print the first occurrence of matching warnings
                         for each module where the warning is issued
                         (regardless of line number)
                         
                         
     ‘"once"’            print only the first occurrence of matching
                         warnings, regardless of location
                         

   * `message' is a string containing a regular expression that the
     start of the warning message must match.  The expression is
     compiled to always be case-insensitive.

   * `category' is a class (a subclass of *note Warning: 1652.) of which
     the warning category must be a subclass in order to match.

   * `module' is a string containing a regular expression that the
     module name must match.  The expression is compiled to be
     case-sensitive.

   * `lineno' is an integer that the line number where the warning
     occurred must match, or ‘0’ to match all line numbers.

Since the *note Warning: 1652. class is derived from the built-in *note
Exception: 1a8. class, to turn a warning into an error we simply raise
‘category(message)’.

If a warning is reported and doesn’t match any registered filter then
the “default” action is applied (hence its name).

* Menu:

* Describing Warning Filters::
* Default Warning Filter::
* Overriding the default filter::


File: python.info,  Node: Describing Warning Filters,  Next: Default Warning Filter,  Up: The Warnings Filter

5.30.5.3 Describing Warning Filters
...................................

The warnings filter is initialized by *note -W: 40c. options passed to
the Python interpreter command line and the *note PYTHONWARNINGS: 40d.
environment variable.  The interpreter saves the arguments for all
supplied entries without interpretation in *note sys.warnoptions: 40b.;
the *note warnings: 126. module parses these when it is first imported
(invalid options are ignored, after printing a message to *note
sys.stderr: 304.).

Individual warnings filters are specified as a sequence of fields
separated by colons:

     action:message:category:module:line

The meaning of each of these fields is as described in *note The
Warnings Filter: 1287.  When listing multiple filters on a single line
(as for *note PYTHONWARNINGS: 40d.), the individual filters are
separated by commas and the filters listed later take precedence over
those listed before them (as they’re applied left-to-right, and the most
recently applied filters take precedence over earlier ones).

Commonly used warning filters apply to either all warnings, warnings in
a particular category, or warnings raised by particular modules or
packages.  Some examples:

     default                      # Show all warnings (even those ignored by default) ignore                       # Ignore all warnings error                        # Convert all warnings to errors error::ResourceWarning       # Treat ResourceWarning messages as errors default::DeprecationWarning  # Show DeprecationWarning messages ignore,default:::mymodule    # Only report warnings triggered by "mymodule" error:::mymodule[.*]         # Convert warnings to errors in "mymodule"                              # and any subpackages of "mymodule"


File: python.info,  Node: Default Warning Filter,  Next: Overriding the default filter,  Prev: Describing Warning Filters,  Up: The Warnings Filter

5.30.5.4 Default Warning Filter
...............................

By default, Python installs several warning filters, which can be
overridden by the *note -W: 40c. command-line option, the *note
PYTHONWARNINGS: 40d. environment variable and calls to *note
filterwarnings(): dfa.

In regular release builds, the default warning filter has the following
entries (in order of precedence):

     default::DeprecationWarning:__main__ ignore::DeprecationWarning ignore::PendingDeprecationWarning ignore::ImportWarning ignore::ResourceWarning

In debug builds, the list of default warning filters is empty.

Changed in version 3.2: *note DeprecationWarning: 276. is now ignored by
default in addition to *note PendingDeprecationWarning: 277.

Changed in version 3.7: *note DeprecationWarning: 276. is once again
shown by default when triggered directly by code in ‘__main__’.

Changed in version 3.7: *note BytesWarning: 4ab. no longer appears in
the default filter list and is instead configured via *note
sys.warnoptions: 40b. when *note -b: 40a. is specified twice.


File: python.info,  Node: Overriding the default filter,  Prev: Default Warning Filter,  Up: The Warnings Filter

5.30.5.5 Overriding the default filter
......................................

Developers of applications written in Python may wish to hide `all'
Python level warnings from their users by default, and only display them
when running tests or otherwise working on the application.  The *note
sys.warnoptions: 40b. attribute used to pass filter configurations to
the interpreter can be used as a marker to indicate whether or not
warnings should be disabled:

     import sys  if not sys.warnoptions:     import warnings     warnings.simplefilter("ignore")

Developers of test runners for Python code are advised to instead ensure
that `all' warnings are displayed by default for the code under test,
using code like:

     import sys  if not sys.warnoptions:     import os, warnings     warnings.simplefilter("default") # Change the filter in this process     os.environ["PYTHONWARNINGS"] = "default" # Also affect subprocesses

Finally, developers of interactive shells that run user code in a
namespace other than ‘__main__’ are advised to ensure that *note
DeprecationWarning: 276. messages are made visible by default, using
code like the following (where ‘user_ns’ is the module used to execute
code entered interactively):

     import warnings warnings.filterwarnings("default", category=DeprecationWarning,                                    module=user_ns.get("__name__"))


File: python.info,  Node: Temporarily Suppressing Warnings,  Next: Testing Warnings,  Prev: The Warnings Filter,  Up: warnings — Warning control

5.30.5.6 Temporarily Suppressing Warnings
.........................................

If you are using code that you know will raise a warning, such as a
deprecated function, but do not want to see the warning (even when
warnings have been explicitly configured via the command line), then it
is possible to suppress the warning using the *note catch_warnings:
3399. context manager:

     import warnings  def fxn():     warnings.warn("deprecated", DeprecationWarning)  with warnings.catch_warnings():     warnings.simplefilter("ignore")     fxn()

While within the context manager all warnings will simply be ignored.
This allows you to use known-deprecated code without having to see the
warning while not suppressing the warning for other code that might not
be aware of its use of deprecated code.  Note: this can only be
guaranteed in a single-threaded application.  If two or more threads use
the *note catch_warnings: 3399. context manager at the same time, the
behavior is undefined.


File: python.info,  Node: Testing Warnings,  Next: Updating Code For New Versions of Dependencies,  Prev: Temporarily Suppressing Warnings,  Up: warnings — Warning control

5.30.5.7 Testing Warnings
.........................

To test warnings raised by code, use the *note catch_warnings: 3399.
context manager.  With it you can temporarily mutate the warnings filter
to facilitate your testing.  For instance, do the following to capture
all raised warnings to check:

     import warnings  def fxn():     warnings.warn("deprecated", DeprecationWarning)  with warnings.catch_warnings(record=True) as w:     # Cause all warnings to always be triggered.     warnings.simplefilter("always")     # Trigger a warning.     fxn()     # Verify some things     assert len(w) == 1     assert issubclass(w[-1].category, DeprecationWarning)     assert "deprecated" in str(w[-1].message)

One can also cause all warnings to be exceptions by using ‘error’
instead of ‘always’.  One thing to be aware of is that if a warning has
already been raised because of a ‘once’/‘default’ rule, then no matter
what filters are set the warning will not be seen again unless the
warnings registry related to the warning has been cleared.

Once the context manager exits, the warnings filter is restored to its
state when the context was entered.  This prevents tests from changing
the warnings filter in unexpected ways between tests and leading to
indeterminate test results.  The *note showwarning(): 358c. function in
the module is also restored to its original value.  Note: this can only
be guaranteed in a single-threaded application.  If two or more threads
use the *note catch_warnings: 3399. context manager at the same time,
the behavior is undefined.

When testing multiple operations that raise the same kind of warning, it
is important to test them in a manner that confirms each operation is
raising a new warning (e.g.  set warnings to be raised as exceptions and
check the operations raise exceptions, check that the length of the
warning list continues to increase after each operation, or else delete
the previous entries from the warnings list before each new operation).


File: python.info,  Node: Updating Code For New Versions of Dependencies,  Next: Available Functions,  Prev: Testing Warnings,  Up: warnings — Warning control

5.30.5.8 Updating Code For New Versions of Dependencies
.......................................................

Warning categories that are primarily of interest to Python developers
(rather than end users of applications written in Python) are ignored by
default.

Notably, this “ignored by default” list includes *note
DeprecationWarning: 276. (for every module except ‘__main__’), which
means developers should make sure to test their code with typically
ignored warnings made visible in order to receive timely notifications
of future breaking API changes (whether in the standard library or third
party packages).

In the ideal case, the code will have a suitable test suite, and the
test runner will take care of implicitly enabling all warnings when
running tests (the test runner provided by the *note unittest: 11b.
module does this).

In less ideal cases, applications can be checked for use of deprecated
interfaces by passing *note -Wd: 40c. to the Python interpreter (this is
shorthand for ‘-W default’) or setting ‘PYTHONWARNINGS=default’ in the
environment.  This enables default handling for all warnings, including
those that are ignored by default.  To change what action is taken for
encountered warnings you can change what argument is passed to *note -W:
40c. (e.g.  ‘-W error’).  See the *note -W: 40c. flag for more details
on what is possible.


File: python.info,  Node: Available Functions,  Next: Available Context Managers,  Prev: Updating Code For New Versions of Dependencies,  Up: warnings — Warning control

5.30.5.9 Available Functions
............................

 -- Function: warnings.warn (message, category=None, stacklevel=1,
          source=None)

     Issue a warning, or maybe ignore it or raise an exception.  The
     `category' argument, if given, must be a *note warning category
     class: 1651.; it defaults to *note UserWarning: 1653.
     Alternatively, `message' can be a *note Warning: 1652. instance, in
     which case `category' will be ignored and ‘message.__class__’ will
     be used.  In this case, the message text will be ‘str(message)’.
     This function raises an exception if the particular warning issued
     is changed into an error by the *note warnings filter: 1287.  The
     `stacklevel' argument can be used by wrapper functions written in
     Python, like this:

          def deprecation(message):     warnings.warn(message, DeprecationWarning, stacklevel=2)

     This makes the warning refer to ‘deprecation()’’s caller, rather
     than to the source of ‘deprecation()’ itself (since the latter
     would defeat the purpose of the warning message).

     `source', if supplied, is the destroyed object which emitted a
     *note ResourceWarning: 4c5.

     Changed in version 3.6: Added `source' parameter.

 -- Function: warnings.warn_explicit (message, category, filename,
          lineno, module=None, registry=None, module_globals=None,
          source=None)

     This is a low-level interface to the functionality of *note warn():
     e4b, passing in explicitly the message, category, filename and line
     number, and optionally the module name and the registry (which
     should be the ‘__warningregistry__’ dictionary of the module).  The
     module name defaults to the filename with ‘.py’ stripped; if no
     registry is passed, the warning is never suppressed.  `message'
     must be a string and `category' a subclass of *note Warning: 1652.
     or `message' may be a *note Warning: 1652. instance, in which case
     `category' will be ignored.

     `module_globals', if supplied, should be the global namespace in
     use by the code for which the warning is issued.  (This argument is
     used to support displaying source for modules found in zipfiles or
     other non-filesystem import sources).

     `source', if supplied, is the destroyed object which emitted a
     *note ResourceWarning: 4c5.

     Changed in version 3.6: Add the `source' parameter.

 -- Function: warnings.showwarning (message, category, filename, lineno,
          file=None, line=None)

     Write a warning to a file.  The default implementation calls
     ‘formatwarning(message, category, filename, lineno, line)’ and
     writes the resulting string to `file', which defaults to *note
     sys.stderr: 304.  You may replace this function with any callable
     by assigning to ‘warnings.showwarning’.  `line' is a line of source
     code to be included in the warning message; if `line' is not
     supplied, *note showwarning(): 358c. will try to read the line
     specified by `filename' and `lineno'.

 -- Function: warnings.formatwarning (message, category, filename,
          lineno, line=None)

     Format a warning the standard way.  This returns a string which may
     contain embedded newlines and ends in a newline.  `line' is a line
     of source code to be included in the warning message; if `line' is
     not supplied, *note formatwarning(): f26. will try to read the line
     specified by `filename' and `lineno'.

 -- Function: warnings.filterwarnings (action, message='',
          category=Warning, module='', lineno=0, append=False)

     Insert an entry into the list of *note warnings filter
     specifications: 1287.  The entry is inserted at the front by
     default; if `append' is true, it is inserted at the end.  This
     checks the types of the arguments, compiles the `message' and
     `module' regular expressions, and inserts them as a tuple in the
     list of warnings filters.  Entries closer to the front of the list
     override entries later in the list, if both match a particular
     warning.  Omitted arguments default to a value that matches
     everything.

 -- Function: warnings.simplefilter (action, category=Warning, lineno=0,
          append=False)

     Insert a simple entry into the list of *note warnings filter
     specifications: 1287.  The meaning of the function parameters is as
     for *note filterwarnings(): dfa, but regular expressions are not
     needed as the filter inserted always matches any message in any
     module as long as the category and line number match.

 -- Function: warnings.resetwarnings ()

     Reset the warnings filter.  This discards the effect of all
     previous calls to *note filterwarnings(): dfa, including that of
     the *note -W: 40c. command line options and calls to *note
     simplefilter(): 339a.


File: python.info,  Node: Available Context Managers,  Prev: Available Functions,  Up: warnings — Warning control

5.30.5.10 Available Context Managers
....................................

 -- Class: warnings.catch_warnings (*, record=False, module=None)

     A context manager that copies and, upon exit, restores the warnings
     filter and the *note showwarning(): 358c. function.  If the
     `record' argument is *note False: 37d. (the default) the context
     manager returns *note None: 157. on entry.  If `record' is *note
     True: 48f, a list is returned that is progressively populated with
     objects as seen by a custom *note showwarning(): 358c. function
     (which also suppresses output to ‘sys.stdout’).  Each object in the
     list has attributes with the same names as the arguments to *note
     showwarning(): 358c.

     The `module' argument takes a module that will be used instead of
     the module returned when you import *note warnings: 126. whose
     filter will be protected.  This argument exists primarily for
     testing the *note warnings: 126. module itself.

          Note: The *note catch_warnings: 3399. manager works by
          replacing and then later restoring the module’s *note
          showwarning(): 358c. function and internal list of filter
          specifications.  This means the context manager is modifying
          global state and therefore is not thread-safe.


File: python.info,  Node: dataclasses — Data Classes,  Next: contextlib — Utilities for with-statement contexts,  Prev: warnings — Warning control,  Up: Python Runtime Services

5.30.6 ‘dataclasses’ — Data Classes
-----------------------------------

`Source code:' Lib/dataclasses.py(1)

__________________________________________________________________

This module provides a decorator and functions for automatically adding
generated *note special method: 359e.s such as *note __init__(): d51.
and *note __repr__(): 333. to user-defined classes.  It was originally
described in PEP 557(2).

The member variables to use in these generated methods are defined using
PEP 526(3) type annotations.  For example this code:

     @dataclass class InventoryItem:     '''Class for keeping track of an item in inventory.'''     name: str     unit_price: float     quantity_on_hand: int = 0      def total_cost(self) -> float:         return self.unit_price * self.quantity_on_hand

Will add, among other things, a *note __init__(): d51. that looks like:

     def __init__(self, name: str, unit_price: float, quantity_on_hand: int=0):     self.name = name     self.unit_price = unit_price     self.quantity_on_hand = quantity_on_hand

Note that this method is automatically added to the class: it is not
directly specified in the ‘InventoryItem’ definition shown above.

New in version 3.7.

* Menu:

* Module-level decorators, classes, and functions: Module-level decorators classes and functions.
* Post-init processing::
* Class variables::
* Init-only variables::
* Frozen instances::
* Inheritance: Inheritance<2>.
* Default factory functions::
* Mutable default values::
* Exceptions: Exceptions<17>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/dataclasses.py

   (2) https://www.python.org/dev/peps/pep-0557

   (3) https://www.python.org/dev/peps/pep-0526


File: python.info,  Node: Module-level decorators classes and functions,  Next: Post-init processing,  Up: dataclasses — Data Classes

5.30.6.1 Module-level decorators, classes, and functions
........................................................

 -- Function: @dataclasses.dataclass (*, init=True, repr=True, eq=True,
          order=False, unsafe_hash=False, frozen=False)

     This function is a *note decorator: 281. that is used to add
     generated *note special method: 359e.s to classes, as described
     below.

     The *note dataclass(): 332. decorator examines the class to find
     ‘field’s.  A ‘field’ is defined as class variable that has a *note
     type annotation: 614.  With two exceptions described below, nothing
     in *note dataclass(): 332. examines the type specified in the
     variable annotation.

     The order of the fields in all of the generated methods is the
     order in which they appear in the class definition.

     The *note dataclass(): 332. decorator will add various “dunder”
     methods to the class, described below.  If any of the added methods
     already exist on the class, a *note TypeError: 192. will be raised.
     The decorator returns the same class that is called on: no new
     class is created.

     If *note dataclass(): 332. is used just as a simple decorator with
     no parameters, it acts as if it has the default values documented
     in this signature.  That is, these three uses of *note dataclass():
     332. are equivalent:

          @dataclass class C:     ...  @dataclass() class C:     ...  @dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False) class C:    ...

     The parameters to *note dataclass(): 332. are:

        - ‘init’: If true (the default), a *note __init__(): d51. method
          will be generated.

          If the class already defines *note __init__(): d51, this
          parameter is ignored.

        - ‘repr’: If true (the default), a *note __repr__(): 333. method
          will be generated.  The generated repr string will have the
          class name and the name and repr of each field, in the order
          they are defined in the class.  Fields that are marked as
          being excluded from the repr are not included.  For example:
          ‘InventoryItem(name='widget', unit_price=3.0,
          quantity_on_hand=10)’.

          If the class already defines *note __repr__(): 333, this
          parameter is ignored.

        - ‘eq’: If true (the default), an *note __eq__(): 334. method
          will be generated.  This method compares the class as if it
          were a tuple of its fields, in order.  Both instances in the
          comparison must be of the identical type.

          If the class already defines *note __eq__(): 334, this
          parameter is ignored.

        - ‘order’: If true (the default is ‘False’), *note __lt__():
          c27, *note __le__(): c93, *note __gt__(): c94, and *note
          __ge__(): c95. methods will be generated.  These compare the
          class as if it were a tuple of its fields, in order.  Both
          instances in the comparison must be of the identical type.  If
          ‘order’ is true and ‘eq’ is false, a *note ValueError: 1f9. is
          raised.

          If the class already defines any of *note __lt__(): c27, *note
          __le__(): c93, *note __gt__(): c94, or *note __ge__(): c95,
          then *note ValueError: 1f9. is raised.

        - ‘unsafe_hash’: If ‘False’ (the default), a *note __hash__():
          335. method is generated according to how ‘eq’ and ‘frozen’
          are set.

          *note __hash__(): 335. is used by built-in *note hash(): 9b8,
          and when objects are added to hashed collections such as
          dictionaries and sets.  Having a *note __hash__(): 335.
          implies that instances of the class are immutable.  Mutability
          is a complicated property that depends on the programmer’s
          intent, the existence and behavior of *note __eq__(): 334, and
          the values of the ‘eq’ and ‘frozen’ flags in the *note
          dataclass(): 332. decorator.

          By default, *note dataclass(): 332. will not implicitly add a
          *note __hash__(): 335. method unless it is safe to do so.
          Neither will it add or change an existing explicitly defined
          *note __hash__(): 335. method.  Setting the class attribute
          ‘__hash__ = None’ has a specific meaning to Python, as
          described in the *note __hash__(): 335. documentation.

          If *note __hash__(): 335. is not explicit defined, or if it is
          set to ‘None’, then *note dataclass(): 332. `may' add an
          implicit *note __hash__(): 335. method.  Although not
          recommended, you can force *note dataclass(): 332. to create a
          *note __hash__(): 335. method with ‘unsafe_hash=True’.  This
          might be the case if your class is logically immutable but can
          nonetheless be mutated.  This is a specialized use case and
          should be considered carefully.

          Here are the rules governing implicit creation of a *note
          __hash__(): 335. method.  Note that you cannot both have an
          explicit *note __hash__(): 335. method in your dataclass and
          set ‘unsafe_hash=True’; this will result in a *note TypeError:
          192.

          If ‘eq’ and ‘frozen’ are both true, by default *note
          dataclass(): 332. will generate a *note __hash__(): 335.
          method for you.  If ‘eq’ is true and ‘frozen’ is false, *note
          __hash__(): 335. will be set to ‘None’, marking it unhashable
          (which it is, since it is mutable).  If ‘eq’ is false, *note
          __hash__(): 335. will be left untouched meaning the *note
          __hash__(): 335. method of the superclass will be used (if the
          superclass is *note object: 2ae, this means it will fall back
          to id-based hashing).

        - ‘frozen’: If true (the default is ‘False’), assigning to
          fields will generate an exception.  This emulates read-only
          frozen instances.  If *note __setattr__(): e1f. or *note
          __delattr__(): 136c. is defined in the class, then *note
          TypeError: 192. is raised.  See the discussion below.

     ‘field’s may optionally specify a default value, using normal
     Python syntax:

          @dataclass class C:     a: int       # 'a' has no default value     b: int = 0   # assign a default value for 'b'

     In this example, both ‘a’ and ‘b’ will be included in the added
     *note __init__(): d51. method, which will be defined as:

          def __init__(self, a: int, b: int = 0):

     *note TypeError: 192. will be raised if a field without a default
     value follows a field with a default value.  This is true either
     when this occurs in a single class, or as a result of class
     inheritance.

 -- Function: dataclasses.field (*, default=MISSING,
          default_factory=MISSING, repr=True, hash=None, init=True,
          compare=True, metadata=None)

     For common and simple use cases, no other functionality is
     required.  There are, however, some dataclass features that require
     additional per-field information.  To satisfy this need for
     additional information, you can replace the default field value
     with a call to the provided *note field(): f32. function.  For
     example:

          @dataclass class C:     mylist: List[int] = field(default_factory=list)  c = C() c.mylist += [1, 2, 3]

     As shown above, the ‘MISSING’ value is a sentinel object used to
     detect if the ‘default’ and ‘default_factory’ parameters are
     provided.  This sentinel is used because ‘None’ is a valid value
     for ‘default’.  No code should directly use the ‘MISSING’ value.

     The parameters to *note field(): f32. are:

        - ‘default’: If provided, this will be the default value for
          this field.  This is needed because the *note field(): f32.
          call itself replaces the normal position of the default value.

        - ‘default_factory’: If provided, it must be a zero-argument
          callable that will be called when a default value is needed
          for this field.  Among other purposes, this can be used to
          specify fields with mutable default values, as discussed
          below.  It is an error to specify both ‘default’ and
          ‘default_factory’.

        - ‘init’: If true (the default), this field is included as a
          parameter to the generated *note __init__(): d51. method.

        - ‘repr’: If true (the default), this field is included in the
          string returned by the generated *note __repr__(): 333.
          method.

        - ‘compare’: If true (the default), this field is included in
          the generated equality and comparison methods (*note __eq__():
          334, *note __gt__(): c94, et al.).

        - ‘hash’: This can be a bool or ‘None’.  If true, this field is
          included in the generated *note __hash__(): 335. method.  If
          ‘None’ (the default), use the value of ‘compare’: this would
          normally be the expected behavior.  A field should be
          considered in the hash if it’s used for comparisons.  Setting
          this value to anything other than ‘None’ is discouraged.

          One possible reason to set ‘hash=False’ but ‘compare=True’
          would be if a field is expensive to compute a hash value for,
          that field is needed for equality testing, and there are other
          fields that contribute to the type’s hash value.  Even if a
          field is excluded from the hash, it will still be used for
          comparisons.

        - ‘metadata’: This can be a mapping or None.  None is treated as
          an empty dict.  This value is wrapped in *note
          MappingProxyType(): aab. to make it read-only, and exposed on
          the *note Field: 35a0. object.  It is not used at all by Data
          Classes, and is provided as a third-party extension mechanism.
          Multiple third-parties can each have their own key, to use as
          a namespace in the metadata.

     If the default value of a field is specified by a call to *note
     field(): f32, then the class attribute for this field will be
     replaced by the specified ‘default’ value.  If no ‘default’ is
     provided, then the class attribute will be deleted.  The intent is
     that after the *note dataclass(): 332. decorator runs, the class
     attributes will all contain the default values for the fields, just
     as if the default value itself were specified.  For example, after:

          @dataclass class C:     x: int     y: int = field(repr=False)     z: int = field(repr=False, default=10)     t: int = 20

     The class attribute ‘C.z’ will be ‘10’, the class attribute ‘C.t’
     will be ‘20’, and the class attributes ‘C.x’ and ‘C.y’ will not be
     set.

 -- Class: dataclasses.Field

     *note Field: 35a0. objects describe each defined field.  These
     objects are created internally, and are returned by the *note
     fields(): 35a1. module-level method (see below).  Users should
     never instantiate a *note Field: 35a0. object directly.  Its
     documented attributes are:

             - ‘name’: The name of the field.

             - ‘type’: The type of the field.

             - ‘default’, ‘default_factory’, ‘init’, ‘repr’, ‘hash’,
               ‘compare’, and ‘metadata’ have the identical meaning and
               values as they do in the *note field(): f32. declaration.

     Other attributes may exist, but they are private and must not be
     inspected or relied on.

 -- Function: dataclasses.fields (class_or_instance)

     Returns a tuple of *note Field: 35a0. objects that define the
     fields for this dataclass.  Accepts either a dataclass, or an
     instance of a dataclass.  Raises *note TypeError: 192. if not
     passed a dataclass or instance of one.  Does not return
     pseudo-fields which are ‘ClassVar’ or ‘InitVar’.

 -- Function: dataclasses.asdict (instance, *, dict_factory=dict)

     Converts the dataclass ‘instance’ to a dict (by using the factory
     function ‘dict_factory’).  Each dataclass is converted to a dict of
     its fields, as ‘name: value’ pairs.  dataclasses, dicts, lists, and
     tuples are recursed into.  For example:

          @dataclass class Point:      x: int      y: int  @dataclass class C:      mylist: List[Point]  p = Point(10, 20) assert asdict(p) == {'x': 10, 'y': 20}  c = C([Point(0, 0), Point(10, 4)]) assert asdict(c) == {'mylist': [{'x': 0, 'y': 0}, {'x': 10, 'y': 4}]}

     Raises *note TypeError: 192. if ‘instance’ is not a dataclass
     instance.

 -- Function: dataclasses.astuple (instance, *, tuple_factory=tuple)

     Converts the dataclass ‘instance’ to a tuple (by using the factory
     function ‘tuple_factory’).  Each dataclass is converted to a tuple
     of its field values.  dataclasses, dicts, lists, and tuples are
     recursed into.

     Continuing from the previous example:

          assert astuple(p) == (10, 20) assert astuple(c) == ([(0, 0), (10, 4)],)

     Raises *note TypeError: 192. if ‘instance’ is not a dataclass
     instance.

 -- Function: dataclasses.make_dataclass (cls_name, fields, *, bases=(),
          namespace=None, init=True, repr=True, eq=True, order=False,
          unsafe_hash=False, frozen=False)

     Creates a new dataclass with name ‘cls_name’, fields as defined in
     ‘fields’, base classes as given in ‘bases’, and initialized with a
     namespace as given in ‘namespace’.  ‘fields’ is an iterable whose
     elements are each either ‘name’, ‘(name, type)’, or ‘(name, type,
     Field)’.  If just ‘name’ is supplied, ‘typing.Any’ is used for
     ‘type’.  The values of ‘init’, ‘repr’, ‘eq’, ‘order’,
     ‘unsafe_hash’, and ‘frozen’ have the same meaning as they do in
     *note dataclass(): 332.

     This function is not strictly required, because any Python
     mechanism for creating a new class with ‘__annotations__’ can then
     apply the *note dataclass(): 332. function to convert that class to
     a dataclass.  This function is provided as a convenience.  For
     example:

          C = make_dataclass('C',                    [('x', int),                      'y',                     ('z', int, field(default=5))],                    namespace={'add_one': lambda self: self.x + 1})

     Is equivalent to:

          @dataclass class C:     x: int     y: 'typing.Any'     z: int = 5      def add_one(self):         return self.x + 1

 -- Function: dataclasses.replace (instance, **changes)

     Creates a new object of the same type of ‘instance’, replacing
     fields with values from ‘changes’.  If ‘instance’ is not a Data
     Class, raises *note TypeError: 192.  If values in ‘changes’ do not
     specify fields, raises *note TypeError: 192.

     The newly returned object is created by calling the *note
     __init__(): d51. method of the dataclass.  This ensures that
     ‘__post_init__()’, if present, is also called.

     Init-only variables without default values, if any exist, must be
     specified on the call to *note replace(): edf. so that they can be
     passed to *note __init__(): d51. and ‘__post_init__()’.

     It is an error for ‘changes’ to contain any fields that are defined
     as having ‘init=False’.  A *note ValueError: 1f9. will be raised in
     this case.

     Be forewarned about how ‘init=False’ fields work during a call to
     *note replace(): edf.  They are not copied from the source object,
     but rather are initialized in ‘__post_init__()’, if they’re
     initialized at all.  It is expected that ‘init=False’ fields will
     be rarely and judiciously used.  If they are used, it might be wise
     to have alternate class constructors, or perhaps a custom
     ‘replace()’ (or similarly named) method which handles instance
     copying.

 -- Function: dataclasses.is_dataclass (class_or_instance)

     Return ‘True’ if its parameter is a dataclass or an instance of
     one, otherwise return ‘False’.

     If you need to know if a class is an instance of a dataclass (and
     not a dataclass itself), then add a further check for ‘not
     isinstance(obj, type)’:

          def is_dataclass_instance(obj):     return is_dataclass(obj) and not isinstance(obj, type)


File: python.info,  Node: Post-init processing,  Next: Class variables,  Prev: Module-level decorators classes and functions,  Up: dataclasses — Data Classes

5.30.6.2 Post-init processing
.............................

The generated *note __init__(): d51. code will call a method named
‘__post_init__()’, if ‘__post_init__()’ is defined on the class.  It
will normally be called as ‘self.__post_init__()’.  However, if any
‘InitVar’ fields are defined, they will also be passed to
‘__post_init__()’ in the order they were defined in the class.  If no
*note __init__(): d51. method is generated, then ‘__post_init__()’ will
not automatically be called.

Among other uses, this allows for initializing field values that depend
on one or more other fields.  For example:

     @dataclass class C:     a: float     b: float     c: float = field(init=False)      def __post_init__(self):         self.c = self.a + self.b

See the section below on init-only variables for ways to pass parameters
to ‘__post_init__()’.  Also see the warning about how *note replace():
edf. handles ‘init=False’ fields.


File: python.info,  Node: Class variables,  Next: Init-only variables,  Prev: Post-init processing,  Up: dataclasses — Data Classes

5.30.6.3 Class variables
........................

One of two places where *note dataclass(): 332. actually inspects the
type of a field is to determine if a field is a class variable as
defined in PEP 526(1).  It does this by checking if the type of the
field is ‘typing.ClassVar’.  If a field is a ‘ClassVar’, it is excluded
from consideration as a field and is ignored by the dataclass
mechanisms.  Such ‘ClassVar’ pseudo-fields are not returned by the
module-level *note fields(): 35a1. function.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0526


File: python.info,  Node: Init-only variables,  Next: Frozen instances,  Prev: Class variables,  Up: dataclasses — Data Classes

5.30.6.4 Init-only variables
............................

The other place where *note dataclass(): 332. inspects a type annotation
is to determine if a field is an init-only variable.  It does this by
seeing if the type of a field is of type ‘dataclasses.InitVar’.  If a
field is an ‘InitVar’, it is considered a pseudo-field called an
init-only field.  As it is not a true field, it is not returned by the
module-level *note fields(): 35a1. function.  Init-only fields are added
as parameters to the generated *note __init__(): d51. method, and are
passed to the optional ‘__post_init__()’ method.  They are not otherwise
used by dataclasses.

For example, suppose a field will be initialized from a database, if a
value is not provided when creating the class:

     @dataclass class C:     i: int     j: int = None     database: InitVar[DatabaseType] = None      def __post_init__(self, database):         if self.j is None and database is not None:             self.j = database.lookup('j')  c = C(10, database=my_database)

In this case, *note fields(): 35a1. will return *note Field: 35a0.
objects for ‘i’ and ‘j’, but not for ‘database’.


File: python.info,  Node: Frozen instances,  Next: Inheritance<2>,  Prev: Init-only variables,  Up: dataclasses — Data Classes

5.30.6.5 Frozen instances
.........................

It is not possible to create truly immutable Python objects.  However,
by passing ‘frozen=True’ to the *note dataclass(): 332. decorator you
can emulate immutability.  In that case, dataclasses will add *note
__setattr__(): e1f. and *note __delattr__(): 136c. methods to the class.
These methods will raise a *note FrozenInstanceError: 35aa. when
invoked.

There is a tiny performance penalty when using ‘frozen=True’: *note
__init__(): d51. cannot use simple assignment to initialize fields, and
must use *note object.__setattr__(): e1f.


File: python.info,  Node: Inheritance<2>,  Next: Default factory functions,  Prev: Frozen instances,  Up: dataclasses — Data Classes

5.30.6.6 Inheritance
....................

When the dataclass is being created by the *note dataclass(): 332.
decorator, it looks through all of the class’s base classes in reverse
MRO (that is, starting at *note object: 2ae.) and, for each dataclass
that it finds, adds the fields from that base class to an ordered
mapping of fields.  After all of the base class fields are added, it
adds its own fields to the ordered mapping.  All of the generated
methods will use this combined, calculated ordered mapping of fields.
Because the fields are in insertion order, derived classes override base
classes.  An example:

     @dataclass class Base:     x: Any = 15.0     y: int = 0  @dataclass class C(Base):     z: int = 10     x: int = 15

The final list of fields is, in order, ‘x’, ‘y’, ‘z’.  The final type of
‘x’ is ‘int’, as specified in class ‘C’.

The generated *note __init__(): d51. method for ‘C’ will look like:

     def __init__(self, x: int = 15, y: int = 0, z: int = 10):


File: python.info,  Node: Default factory functions,  Next: Mutable default values,  Prev: Inheritance<2>,  Up: dataclasses — Data Classes

5.30.6.7 Default factory functions
..................................

     If a *note field(): f32. specifies a ‘default_factory’, it is
     called with zero arguments when a default value for the field is
     needed.  For example, to create a new instance of a list, use:

          mylist: list = field(default_factory=list)

     If a field is excluded from *note __init__(): d51. (using
     ‘init=False’) and the field also specifies ‘default_factory’, then
     the default factory function will always be called from the
     generated *note __init__(): d51. function.  This happens because
     there is no other way to give the field an initial value.


File: python.info,  Node: Mutable default values,  Next: Exceptions<17>,  Prev: Default factory functions,  Up: dataclasses — Data Classes

5.30.6.8 Mutable default values
...............................

     Python stores default member variable values in class attributes.
     Consider this example, not using dataclasses:

          class C:     x = []     def add(self, element):         self.x.append(element)  o1 = C() o2 = C() o1.add(1) o2.add(2) assert o1.x == [1, 2] assert o1.x is o2.x

     Note that the two instances of class ‘C’ share the same class
     variable ‘x’, as expected.

     Using dataclasses, `if' this code was valid:

          @dataclass class D:     x: List = []     def add(self, element):         self.x += element

     it would generate code similar to:

          class D:     x = []     def __init__(self, x=x):         self.x = x     def add(self, element):         self.x += element  assert D().x is D().x

     This has the same issue as the original example using class ‘C’.
     That is, two instances of class ‘D’ that do not specify a value for
     ‘x’ when creating a class instance will share the same copy of ‘x’.
     Because dataclasses just use normal Python class creation they also
     share this behavior.  There is no general way for Data Classes to
     detect this condition.  Instead, dataclasses will raise a *note
     TypeError: 192. if it detects a default parameter of type ‘list’,
     ‘dict’, or ‘set’.  This is a partial solution, but it does protect
     against many common errors.

     Using default factory functions is a way to create new instances of
     mutable types as default values for fields:

          @dataclass class D:     x: list = field(default_factory=list)  assert D().x is not D().x


File: python.info,  Node: Exceptions<17>,  Prev: Mutable default values,  Up: dataclasses — Data Classes

5.30.6.9 Exceptions
...................

 -- Exception: dataclasses.FrozenInstanceError

     Raised when an implicitly defined *note __setattr__(): e1f. or
     *note __delattr__(): 136c. is called on a dataclass which was
     defined with ‘frozen=True’.


File: python.info,  Node: contextlib — Utilities for with-statement contexts,  Next: abc — Abstract Base Classes,  Prev: dataclasses — Data Classes,  Up: Python Runtime Services

5.30.7 ‘contextlib’ — Utilities for ‘with’-statement contexts
-------------------------------------------------------------

`Source code:' Lib/contextlib.py(1)

__________________________________________________________________

This module provides utilities for common tasks involving the *note
with: 6dd. statement.  For more information see also *note Context
Manager Types: 13c4. and *note With Statement Context Managers: 13c2.

* Menu:

* Utilities::
* Examples and Recipes: Examples and Recipes<2>.
* Single use, reusable and reentrant context managers: Single use reusable and reentrant context managers.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/contextlib.py


File: python.info,  Node: Utilities,  Next: Examples and Recipes<2>,  Up: contextlib — Utilities for with-statement contexts

5.30.7.1 Utilities
..................

Functions and classes provided:

 -- Class: contextlib.AbstractContextManager

     An *note abstract base class: b26. for classes that implement *note
     object.__enter__(): c88. and *note object.__exit__(): c89.  A
     default implementation for *note object.__enter__(): c88. is
     provided which returns ‘self’ while *note object.__exit__(): c89.
     is an abstract method which by default returns ‘None’.  See also
     the definition of *note Context Manager Types: 13c4.

     New in version 3.6.

 -- Class: contextlib.AbstractAsyncContextManager

     An *note abstract base class: b26. for classes that implement *note
     object.__aenter__(): 13d4. and *note object.__aexit__(): 13d5.  A
     default implementation for *note object.__aenter__(): 13d4. is
     provided which returns ‘self’ while *note object.__aexit__(): 13d5.
     is an abstract method which by default returns ‘None’.  See also
     the definition of *note Asynchronous Context Managers: 13d2.

     New in version 3.7.

 -- Function: @contextlib.contextmanager

     This function is a *note decorator: 281. that can be used to define
     a factory function for *note with: 6dd. statement context managers,
     without needing to create a class or separate *note __enter__():
     c88. and *note __exit__(): c89. methods.

     While many objects natively support use in with statements,
     sometimes a resource needs to be managed that isn’t a context
     manager in its own right, and doesn’t implement a ‘close()’ method
     for use with ‘contextlib.closing’

     An abstract example would be the following to ensure correct
     resource management:

          from contextlib import contextmanager  @contextmanager def managed_resource(*args, **kwds):     # Code to acquire resource, e.g.:     resource = acquire_resource(*args, **kwds)     try:         yield resource     finally:         # Code to release resource, e.g.:         release_resource(resource)  >>> with managed_resource(timeout=3600) as resource: ...     # Resource is released at the end of this block, ...     # even if code in the block raises an exception

     The function being decorated must return a *note generator:
     996.-iterator when called.  This iterator must yield exactly one
     value, which will be bound to the targets in the *note with: 6dd.
     statement’s ‘as’ clause, if any.

     At the point where the generator yields, the block nested in the
     *note with: 6dd. statement is executed.  The generator is then
     resumed after the block is exited.  If an unhandled exception
     occurs in the block, it is reraised inside the generator at the
     point where the yield occurred.  Thus, you can use a *note try:
     d65.…*note except: b31.…*note finally: 182. statement to trap the
     error (if any), or ensure that some cleanup takes place.  If an
     exception is trapped merely in order to log it or to perform some
     action (rather than to suppress it entirely), the generator must
     reraise that exception.  Otherwise the generator context manager
     will indicate to the ‘with’ statement that the exception has been
     handled, and execution will resume with the statement immediately
     following the ‘with’ statement.

     *note contextmanager(): b71. uses *note ContextDecorator: b70. so
     the context managers it creates can be used as decorators as well
     as in *note with: 6dd. statements.  When used as a decorator, a new
     generator instance is implicitly created on each function call
     (this allows the otherwise “one-shot” context managers created by
     *note contextmanager(): b71. to meet the requirement that context
     managers support multiple invocations in order to be used as
     decorators).

     Changed in version 3.2: Use of *note ContextDecorator: b70.

 -- Function: @contextlib.asynccontextmanager

     Similar to *note contextmanager(): b71, but creates an *note
     asynchronous context manager: 13d2.

     This function is a *note decorator: 281. that can be used to define
     a factory function for *note async with: 637. statement
     asynchronous context managers, without needing to create a class or
     separate *note __aenter__(): 13d4. and *note __aexit__(): 13d5.
     methods.  It must be applied to an *note asynchronous generator:
     1441. function.

     A simple example:

          from contextlib import asynccontextmanager  @asynccontextmanager async def get_connection():     conn = await acquire_db_connection()     try:         yield conn     finally:         await release_db_connection(conn)  async def get_all_users():     async with get_connection() as conn:         return conn.query('SELECT ...')

     New in version 3.7.

 -- Function: contextlib.closing (thing)

     Return a context manager that closes `thing' upon completion of the
     block.  This is basically equivalent to:

          from contextlib import contextmanager  @contextmanager def closing(thing):     try:         yield thing     finally:         thing.close()

     And lets you write code like this:

          from contextlib import closing from urllib.request import urlopen  with closing(urlopen('http://www.python.org')) as page:     for line in page:         print(line)

     without needing to explicitly close ‘page’.  Even if an error
     occurs, ‘page.close()’ will be called when the *note with: 6dd.
     block is exited.
 -- Function: contextlib.nullcontext (enter_result=None)

     Return a context manager that returns `enter_result' from
     ‘__enter__’, but otherwise does nothing.  It is intended to be used
     as a stand-in for an optional context manager, for example:

          def myfunction(arg, ignore_exceptions=False):     if ignore_exceptions:         # Use suppress to ignore all exceptions.         cm = contextlib.suppress(Exception)     else:         # Do not ignore any exceptions, cm has no effect.         cm = contextlib.nullcontext()     with cm:         # Do something

     An example using `enter_result':

          def process_file(file_or_path):     if isinstance(file_or_path, str):         # If string, open file         cm = open(file_or_path)     else:         # Caller is responsible for closing file         cm = nullcontext(file_or_path)      with cm as file:         # Perform processing on the file

     New in version 3.7.

 -- Function: contextlib.suppress (*exceptions)

     Return a context manager that suppresses any of the specified
     exceptions if they occur in the body of a with statement and then
     resumes execution with the first statement following the end of the
     with statement.

     As with any other mechanism that completely suppresses exceptions,
     this context manager should be used only to cover very specific
     errors where silently continuing with program execution is known to
     be the right thing to do.

     For example:

          from contextlib import suppress  with suppress(FileNotFoundError):     os.remove('somefile.tmp')  with suppress(FileNotFoundError):     os.remove('someotherfile.tmp')

     This code is equivalent to:

          try:     os.remove('somefile.tmp') except FileNotFoundError:     pass  try:     os.remove('someotherfile.tmp') except FileNotFoundError:     pass

     This context manager is *note reentrant: 35b4.

     New in version 3.4.

 -- Function: contextlib.redirect_stdout (new_target)

     Context manager for temporarily redirecting *note sys.stdout: 303.
     to another file or file-like object.

     This tool adds flexibility to existing functions or classes whose
     output is hardwired to stdout.

     For example, the output of *note help(): 567. normally is sent to
     `sys.stdout'.  You can capture that output in a string by
     redirecting the output to an *note io.StringIO: 821. object:

          f = io.StringIO() with redirect_stdout(f):     help(pow) s = f.getvalue()

     To send the output of *note help(): 567. to a file on disk,
     redirect the output to a regular file:

          with open('help.txt', 'w') as f:     with redirect_stdout(f):         help(pow)

     To send the output of *note help(): 567. to `sys.stderr':

          with redirect_stdout(sys.stderr):     help(pow)

     Note that the global side effect on *note sys.stdout: 303. means
     that this context manager is not suitable for use in library code
     and most threaded applications.  It also has no effect on the
     output of subprocesses.  However, it is still a useful approach for
     many utility scripts.

     This context manager is *note reentrant: 35b4.

     New in version 3.4.

 -- Function: contextlib.redirect_stderr (new_target)

     Similar to *note redirect_stdout(): 6b6. but redirecting *note
     sys.stderr: 304. to another file or file-like object.

     This context manager is *note reentrant: 35b4.

     New in version 3.5.

 -- Class: contextlib.ContextDecorator

     A base class that enables a context manager to also be used as a
     decorator.

     Context managers inheriting from ‘ContextDecorator’ have to
     implement ‘__enter__’ and ‘__exit__’ as normal.  ‘__exit__’ retains
     its optional exception handling even when used as a decorator.

     ‘ContextDecorator’ is used by *note contextmanager(): b71, so you
     get this functionality automatically.

     Example of ‘ContextDecorator’:

          from contextlib import ContextDecorator  class mycontext(ContextDecorator):     def __enter__(self):         print('Starting')         return self      def __exit__(self, *exc):         print('Finishing')         return False  >>> @mycontext() ... def function(): ...     print('The bit in the middle') ... >>> function() Starting The bit in the middle Finishing  >>> with mycontext(): ...     print('The bit in the middle') ... Starting The bit in the middle Finishing

     This change is just syntactic sugar for any construct of the
     following form:

          def f():     with cm():         # Do stuff

     ‘ContextDecorator’ lets you instead write:

          @cm() def f():     # Do stuff

     It makes it clear that the ‘cm’ applies to the whole function,
     rather than just a piece of it (and saving an indentation level is
     nice, too).

     Existing context managers that already have a base class can be
     extended by using ‘ContextDecorator’ as a mixin class:

          from contextlib import ContextDecorator  class mycontext(ContextBaseClass, ContextDecorator):     def __enter__(self):         return self      def __exit__(self, *exc):         return False

          Note: As the decorated function must be able to be called
          multiple times, the underlying context manager must support
          use in multiple *note with: 6dd. statements.  If this is not
          the case, then the original construct with the explicit ‘with’
          statement inside the function should be used.

     New in version 3.2.

 -- Class: contextlib.ExitStack

     A context manager that is designed to make it easy to
     programmatically combine other context managers and cleanup
     functions, especially those that are optional or otherwise driven
     by input data.

     For example, a set of files may easily be handled in a single with
     statement as follows:

          with ExitStack() as stack:     files = [stack.enter_context(open(fname)) for fname in filenames]     # All opened files will automatically be closed at the end of     # the with statement, even if attempts to open files later     # in the list raise an exception

     Each instance maintains a stack of registered callbacks that are
     called in reverse order when the instance is closed (either
     explicitly or implicitly at the end of a *note with: 6dd.
     statement).  Note that callbacks are `not' invoked implicitly when
     the context stack instance is garbage collected.

     This stack model is used so that context managers that acquire
     their resources in their ‘__init__’ method (such as file objects)
     can be handled correctly.

     Since registered callbacks are invoked in the reverse order of
     registration, this ends up behaving as if multiple nested *note
     with: 6dd. statements had been used with the registered set of
     callbacks.  This even extends to exception handling - if an inner
     callback suppresses or replaces an exception, then outer callbacks
     will be passed arguments based on that updated state.

     This is a relatively low level API that takes care of the details
     of correctly unwinding the stack of exit callbacks.  It provides a
     suitable foundation for higher level context managers that
     manipulate the exit stack in application specific ways.

     New in version 3.3.

      -- Method: enter_context (cm)

          Enters a new context manager and adds its *note __exit__():
          c89. method to the callback stack.  The return value is the
          result of the context manager’s own *note __enter__(): c88.
          method.

          These context managers may suppress exceptions just as they
          normally would if used directly as part of a *note with: 6dd.
          statement.

      -- Method: push (exit)

          Adds a context manager’s *note __exit__(): c89. method to the
          callback stack.

          As ‘__enter__’ is `not' invoked, this method can be used to
          cover part of an *note __enter__(): c88. implementation with a
          context manager’s own *note __exit__(): c89. method.

          If passed an object that is not a context manager, this method
          assumes it is a callback with the same signature as a context
          manager’s *note __exit__(): c89. method and adds it directly
          to the callback stack.

          By returning true values, these callbacks can suppress
          exceptions the same way context manager *note __exit__(): c89.
          methods can.

          The passed in object is returned from the function, allowing
          this method to be used as a function decorator.

      -- Method: callback (callback, *args, **kwds)

          Accepts an arbitrary callback function and arguments and adds
          it to the callback stack.

          Unlike the other methods, callbacks added this way cannot
          suppress exceptions (as they are never passed the exception
          details).

          The passed in callback is returned from the function, allowing
          this method to be used as a function decorator.

      -- Method: pop_all ()

          Transfers the callback stack to a fresh *note ExitStack: 36b.
          instance and returns it.  No callbacks are invoked by this
          operation - instead, they will now be invoked when the new
          stack is closed (either explicitly or implicitly at the end of
          a *note with: 6dd. statement).

          For example, a group of files can be opened as an “all or
          nothing” operation as follows:

               with ExitStack() as stack:     files = [stack.enter_context(open(fname)) for fname in filenames]     # Hold onto the close method, but don't call it yet.     close_files = stack.pop_all().close     # If opening any file fails, all previously opened files will be     # closed automatically. If all files are opened successfully,     # they will remain open even after the with statement ends.     # close_files() can then be invoked explicitly to close them all.

      -- Method: close ()

          Immediately unwinds the callback stack, invoking callbacks in
          the reverse order of registration.  For any context managers
          and exit callbacks registered, the arguments passed in will
          indicate that no exception occurred.

 -- Class: contextlib.AsyncExitStack

     An *note asynchronous context manager: 13d2, similar to *note
     ExitStack: 36b, that supports combining both synchronous and
     asynchronous context managers, as well as having coroutines for
     cleanup logic.

     The ‘close()’ method is not implemented, *note aclose(): 35b9. must
     be used instead.

      -- Method: enter_async_context (cm)

          Similar to ‘enter_context()’ but expects an asynchronous
          context manager.

      -- Method: push_async_exit (exit)

          Similar to ‘push()’ but expects either an asynchronous context
          manager or a coroutine function.

      -- Method: push_async_callback (callback, *args, **kwds)

          Similar to ‘callback()’ but expects a coroutine function.

      -- Method: aclose ()

          Similar to ‘close()’ but properly handles awaitables.

     Continuing the example for *note asynccontextmanager(): 36c.:

          async with AsyncExitStack() as stack:     connections = [await stack.enter_async_context(get_connection())         for i in range(5)]     # All opened connections will automatically be released at the end of     # the async with statement, even if attempts to open a connection     # later in the list raise an exception.

     New in version 3.7.


File: python.info,  Node: Examples and Recipes<2>,  Next: Single use reusable and reentrant context managers,  Prev: Utilities,  Up: contextlib — Utilities for with-statement contexts

5.30.7.2 Examples and Recipes
.............................

This section describes some examples and recipes for making effective
use of the tools provided by *note contextlib: 24.

* Menu:

* Supporting a variable number of context managers::
* Catching exceptions from __enter__ methods::
* Cleaning up in an __enter__ implementation::
* Replacing any use of try-finally and flag variables::
* Using a context manager as a function decorator::


File: python.info,  Node: Supporting a variable number of context managers,  Next: Catching exceptions from __enter__ methods,  Up: Examples and Recipes<2>

5.30.7.3 Supporting a variable number of context managers
.........................................................

The primary use case for *note ExitStack: 36b. is the one given in the
class documentation: supporting a variable number of context managers
and other cleanup operations in a single *note with: 6dd. statement.
The variability may come from the number of context managers needed
being driven by user input (such as opening a user specified collection
of files), or from some of the context managers being optional:

     with ExitStack() as stack:     for resource in resources:         stack.enter_context(resource)     if need_special_resource():         special = acquire_special_resource()         stack.callback(release_special_resource, special)     # Perform operations that use the acquired resources

As shown, *note ExitStack: 36b. also makes it quite easy to use *note
with: 6dd. statements to manage arbitrary resources that don’t natively
support the context management protocol.


File: python.info,  Node: Catching exceptions from __enter__ methods,  Next: Cleaning up in an __enter__ implementation,  Prev: Supporting a variable number of context managers,  Up: Examples and Recipes<2>

5.30.7.4 Catching exceptions from ‘__enter__’ methods
.....................................................

It is occasionally desirable to catch exceptions from an ‘__enter__’
method implementation, `without' inadvertently catching exceptions from
the *note with: 6dd. statement body or the context manager’s ‘__exit__’
method.  By using *note ExitStack: 36b. the steps in the context
management protocol can be separated slightly in order to allow this:

     stack = ExitStack() try:     x = stack.enter_context(cm) except Exception:     # handle __enter__ exception else:     with stack:         # Handle normal case

Actually needing to do this is likely to indicate that the underlying
API should be providing a direct resource management interface for use
with *note try: d65./*note except: b31./*note finally: 182. statements,
but not all APIs are well designed in that regard.  When a context
manager is the only resource management API provided, then *note
ExitStack: 36b. can make it easier to handle various situations that
can’t be handled directly in a *note with: 6dd. statement.


File: python.info,  Node: Cleaning up in an __enter__ implementation,  Next: Replacing any use of try-finally and flag variables,  Prev: Catching exceptions from __enter__ methods,  Up: Examples and Recipes<2>

5.30.7.5 Cleaning up in an ‘__enter__’ implementation
.....................................................

As noted in the documentation of *note ExitStack.push(): 35b6, this
method can be useful in cleaning up an already allocated resource if
later steps in the *note __enter__(): c88. implementation fail.

Here’s an example of doing this for a context manager that accepts
resource acquisition and release functions, along with an optional
validation function, and maps them to the context management protocol:

     from contextlib import contextmanager, AbstractContextManager, ExitStack  class ResourceManager(AbstractContextManager):      def __init__(self, acquire_resource, release_resource, check_resource_ok=None):         self.acquire_resource = acquire_resource         self.release_resource = release_resource         if check_resource_ok is None:             def check_resource_ok(resource):                 return True         self.check_resource_ok = check_resource_ok      @contextmanager     def _cleanup_on_error(self):         with ExitStack() as stack:             stack.push(self)             yield             # The validation check passed and didn't raise an exception             # Accordingly, we want to keep the resource, and pass it             # back to our caller             stack.pop_all()      def __enter__(self):         resource = self.acquire_resource()         with self._cleanup_on_error():             if not self.check_resource_ok(resource):                 msg = "Failed validation for {!r}"                 raise RuntimeError(msg.format(resource))         return resource      def __exit__(self, *exc_details):         # We don't need to duplicate any of our resource release logic         self.release_resource()


File: python.info,  Node: Replacing any use of try-finally and flag variables,  Next: Using a context manager as a function decorator,  Prev: Cleaning up in an __enter__ implementation,  Up: Examples and Recipes<2>

5.30.7.6 Replacing any use of ‘try-finally’ and flag variables
..............................................................

A pattern you will sometimes see is a ‘try-finally’ statement with a
flag variable to indicate whether or not the body of the ‘finally’
clause should be executed.  In its simplest form (that can’t already be
handled just by using an ‘except’ clause instead), it looks something
like this:

     cleanup_needed = True try:     result = perform_operation()     if result:         cleanup_needed = False finally:     if cleanup_needed:         cleanup_resources()

As with any ‘try’ statement based code, this can cause problems for
development and review, because the setup code and the cleanup code can
end up being separated by arbitrarily long sections of code.

*note ExitStack: 36b. makes it possible to instead register a callback
for execution at the end of a ‘with’ statement, and then later decide to
skip executing that callback:

     from contextlib import ExitStack  with ExitStack() as stack:     stack.callback(cleanup_resources)     result = perform_operation()     if result:         stack.pop_all()

This allows the intended cleanup up behaviour to be made explicit up
front, rather than requiring a separate flag variable.

If a particular application uses this pattern a lot, it can be
simplified even further by means of a small helper class:

     from contextlib import ExitStack  class Callback(ExitStack):     def __init__(self, callback, /, *args, **kwds):         super(Callback, self).__init__()         self.callback(callback, *args, **kwds)      def cancel(self):         self.pop_all()  with Callback(cleanup_resources) as cb:     result = perform_operation()     if result:         cb.cancel()

If the resource cleanup isn’t already neatly bundled into a standalone
function, then it is still possible to use the decorator form of *note
ExitStack.callback(): 2a3. to declare the resource cleanup in advance:

     from contextlib import ExitStack  with ExitStack() as stack:     @stack.callback     def cleanup_resources():         ...     result = perform_operation()     if result:         stack.pop_all()

Due to the way the decorator protocol works, a callback function
declared this way cannot take any parameters.  Instead, any resources to
be released must be accessed as closure variables.


File: python.info,  Node: Using a context manager as a function decorator,  Prev: Replacing any use of try-finally and flag variables,  Up: Examples and Recipes<2>

5.30.7.7 Using a context manager as a function decorator
........................................................

*note ContextDecorator: b70. makes it possible to use a context manager
in both an ordinary ‘with’ statement and also as a function decorator.

For example, it is sometimes useful to wrap functions or groups of
statements with a logger that can track the time of entry and time of
exit.  Rather than writing both a function decorator and a context
manager for the task, inheriting from *note ContextDecorator: b70.
provides both capabilities in a single definition:

     from contextlib import ContextDecorator import logging  logging.basicConfig(level=logging.INFO)  class track_entry_and_exit(ContextDecorator):     def __init__(self, name):         self.name = name      def __enter__(self):         logging.info('Entering: %s', self.name)      def __exit__(self, exc_type, exc, exc_tb):         logging.info('Exiting: %s', self.name)

Instances of this class can be used as both a context manager:

     with track_entry_and_exit('widget loader'):     print('Some time consuming activity goes here')     load_widget()

And also as a function decorator:

     @track_entry_and_exit('widget loader') def activity():     print('Some time consuming activity goes here')     load_widget()

Note that there is one additional limitation when using context managers
as function decorators: there’s no way to access the return value of
*note __enter__(): c88.  If that value is needed, then it is still
necessary to use an explicit ‘with’ statement.

See also
........

PEP 343(1) - The “with” statement

     The specification, background, and examples for the Python *note
     with: 6dd. statement.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0343


File: python.info,  Node: Single use reusable and reentrant context managers,  Prev: Examples and Recipes<2>,  Up: contextlib — Utilities for with-statement contexts

5.30.7.8 Single use, reusable and reentrant context managers
............................................................

Most context managers are written in a way that means they can only be
used effectively in a *note with: 6dd. statement once.  These single use
context managers must be created afresh each time they’re used -
attempting to use them a second time will trigger an exception or
otherwise not work correctly.

This common limitation means that it is generally advisable to create
context managers directly in the header of the *note with: 6dd.
statement where they are used (as shown in all of the usage examples
above).

Files are an example of effectively single use context managers, since
the first *note with: 6dd. statement will close the file, preventing any
further IO operations using that file object.

Context managers created using *note contextmanager(): b71. are also
single use context managers, and will complain about the underlying
generator failing to yield if an attempt is made to use them a second
time:

     >>> from contextlib import contextmanager >>> @contextmanager ... def singleuse(): ...     print("Before") ...     yield ...     print("After") ... >>> cm = singleuse() >>> with cm: ...     pass ... Before After >>> with cm: ...     pass ... Traceback (most recent call last):     ... RuntimeError: generator didn't yield

* Menu:

* Reentrant context managers::
* Reusable context managers::


File: python.info,  Node: Reentrant context managers,  Next: Reusable context managers,  Up: Single use reusable and reentrant context managers

5.30.7.9 Reentrant context managers
...................................

More sophisticated context managers may be “reentrant”.  These context
managers can not only be used in multiple *note with: 6dd. statements,
but may also be used `inside' a ‘with’ statement that is already using
the same context manager.

*note threading.RLock: be2. is an example of a reentrant context
manager, as are *note suppress(): 820. and *note redirect_stdout(): 6b6.
Here’s a very simple example of reentrant use:

     >>> from contextlib import redirect_stdout >>> from io import StringIO >>> stream = StringIO() >>> write_to_stream = redirect_stdout(stream) >>> with write_to_stream: ...     print("This is written to the stream rather than stdout") ...     with write_to_stream: ...         print("This is also written to the stream") ... >>> print("This is written directly to stdout") This is written directly to stdout >>> print(stream.getvalue()) This is written to the stream rather than stdout This is also written to the stream

Real world examples of reentrancy are more likely to involve multiple
functions calling each other and hence be far more complicated than this
example.

Note also that being reentrant is `not' the same thing as being thread
safe.  *note redirect_stdout(): 6b6, for example, is definitely not
thread safe, as it makes a global modification to the system state by
binding *note sys.stdout: 303. to a different stream.


File: python.info,  Node: Reusable context managers,  Prev: Reentrant context managers,  Up: Single use reusable and reentrant context managers

5.30.7.10 Reusable context managers
...................................

Distinct from both single use and reentrant context managers are
“reusable” context managers (or, to be completely explicit, “reusable,
but not reentrant” context managers, since reentrant context managers
are also reusable).  These context managers support being used multiple
times, but will fail (or otherwise not work correctly) if the specific
context manager instance has already been used in a containing with
statement.

*note threading.Lock: 22a8. is an example of a reusable, but not
reentrant, context manager (for a reentrant lock, it is necessary to use
*note threading.RLock: be2. instead).

Another example of a reusable, but not reentrant, context manager is
*note ExitStack: 36b, as it invokes `all' currently registered callbacks
when leaving any with statement, regardless of where those callbacks
were added:

     >>> from contextlib import ExitStack >>> stack = ExitStack() >>> with stack: ...     stack.callback(print, "Callback: from first context") ...     print("Leaving first context") ... Leaving first context Callback: from first context >>> with stack: ...     stack.callback(print, "Callback: from second context") ...     print("Leaving second context") ... Leaving second context Callback: from second context >>> with stack: ...     stack.callback(print, "Callback: from outer context") ...     with stack: ...         stack.callback(print, "Callback: from inner context") ...         print("Leaving inner context") ...     print("Leaving outer context") ... Leaving inner context Callback: from inner context Callback: from outer context Leaving outer context

As the output from the example shows, reusing a single stack object
across multiple with statements works correctly, but attempting to nest
them will cause the stack to be cleared at the end of the innermost with
statement, which is unlikely to be desirable behaviour.

Using separate *note ExitStack: 36b. instances instead of reusing a
single instance avoids that problem:

     >>> from contextlib import ExitStack >>> with ExitStack() as outer_stack: ...     outer_stack.callback(print, "Callback: from outer context") ...     with ExitStack() as inner_stack: ...         inner_stack.callback(print, "Callback: from inner context") ...         print("Leaving inner context") ...     print("Leaving outer context") ... Leaving inner context Callback: from inner context Leaving outer context Callback: from outer context


File: python.info,  Node: abc — Abstract Base Classes,  Next: atexit — Exit handlers,  Prev: contextlib — Utilities for with-statement contexts,  Up: Python Runtime Services

5.30.8 ‘abc’ — Abstract Base Classes
------------------------------------

`Source code:' Lib/abc.py(1)

__________________________________________________________________

This module provides the infrastructure for defining *note abstract base
classes: b26. (ABCs) in Python, as outlined in PEP 3119(2); see the PEP
for why this was added to Python.  (See also PEP 3141(3) and the *note
numbers: c1. module regarding a type hierarchy for numbers based on
ABCs.)

The *note collections: 1e. module has some concrete classes that derive
from ABCs; these can, of course, be further derived.  In addition, the
*note collections.abc: 1f. submodule has some ABCs that can be used to
test whether a class or instance provides a particular interface, for
example, if it is hashable or if it is a mapping.

This module provides the metaclass *note ABCMeta: 80d. for defining ABCs
and a helper class *note ABC: 80c. to alternatively define ABCs through
inheritance:

 -- Class: abc.ABC

     A helper class that has *note ABCMeta: 80d. as its metaclass.  With
     this class, an abstract base class can be created by simply
     deriving from *note ABC: 80c. avoiding sometimes confusing
     metaclass usage, for example:

          from abc import ABC  class MyABC(ABC):     pass

     Note that the type of *note ABC: 80c. is still *note ABCMeta: 80d,
     therefore inheriting from *note ABC: 80c. requires the usual
     precautions regarding metaclass usage, as multiple inheritance may
     lead to metaclass conflicts.  One may also define an abstract base
     class by passing the metaclass keyword and using *note ABCMeta:
     80d. directly, for example:

          from abc import ABCMeta  class MyABC(metaclass=ABCMeta):     pass

     New in version 3.4.

 -- Class: abc.ABCMeta

     Metaclass for defining Abstract Base Classes (ABCs).

     Use this metaclass to create an ABC. An ABC can be subclassed
     directly, and then acts as a mix-in class.  You can also register
     unrelated concrete classes (even built-in classes) and unrelated
     ABCs as “virtual subclasses” – these and their descendants will be
     considered subclasses of the registering ABC by the built-in *note
     issubclass(): 445. function, but the registering ABC won’t show up
     in their MRO (Method Resolution Order) nor will method
     implementations defined by the registering ABC be callable (not
     even via *note super(): 4d7.).  (4)

     Classes created with a metaclass of *note ABCMeta: 80d. have the
     following method:

      -- Method: register (subclass)

          Register `subclass' as a “virtual subclass” of this ABC. For
          example:

               from abc import ABC  class MyABC(ABC):     pass  MyABC.register(tuple)  assert issubclass(tuple, MyABC) assert isinstance((), MyABC)

          Changed in version 3.3: Returns the registered subclass, to
          allow usage as a class decorator.

          Changed in version 3.4: To detect calls to *note register():
          9c5, you can use the *note get_cache_token(): 80b. function.

     You can also override this method in an abstract base class:

      -- Method: __subclasshook__ (subclass)

          (Must be defined as a class method.)

          Check whether `subclass' is considered a subclass of this ABC.
          This means that you can customize the behavior of ‘issubclass’
          further without the need to call *note register(): 9c5. on
          every class you want to consider a subclass of the ABC. (This
          class method is called from the ‘__subclasscheck__()’ method
          of the ABC.)

          This method should return ‘True’, ‘False’ or ‘NotImplemented’.
          If it returns ‘True’, the `subclass' is considered a subclass
          of this ABC. If it returns ‘False’, the `subclass' is not
          considered a subclass of this ABC, even if it would normally
          be one.  If it returns ‘NotImplemented’, the subclass check is
          continued with the usual mechanism.

     For a demonstration of these concepts, look at this example ABC
     definition:

          class Foo:     def __getitem__(self, index):         ...     def __len__(self):         ...     def get_iterator(self):         return iter(self)  class MyIterable(ABC):      @abstractmethod     def __iter__(self):         while False:             yield None      def get_iterator(self):         return self.__iter__()      @classmethod     def __subclasshook__(cls, C):         if cls is MyIterable:             if any("__iter__" in B.__dict__ for B in C.__mro__):                 return True         return NotImplemented  MyIterable.register(Foo)

     The ABC ‘MyIterable’ defines the standard iterable method, *note
     __iter__(): 1565, as an abstract method.  The implementation given
     here can still be called from subclasses.  The ‘get_iterator()’
     method is also part of the ‘MyIterable’ abstract base class, but it
     does not have to be overridden in non-abstract derived classes.

     The *note __subclasshook__(): 35c8. class method defined here says
     that any class that has an *note __iter__(): 1565. method in its
     *note __dict__: 4f1. (or in that of one of its base classes,
     accessed via the *note __mro__: 1540. list) is considered a
     ‘MyIterable’ too.

     Finally, the last line makes ‘Foo’ a virtual subclass of
     ‘MyIterable’, even though it does not define an *note __iter__():
     1565. method (it uses the old-style iterable protocol, defined in
     terms of *note __len__(): dbe. and *note __getitem__(): 27a.).
     Note that this will not make ‘get_iterator’ available as a method
     of ‘Foo’, so it is provided separately.

The *note abc: 4. module also provides the following decorator:

 -- Function: @abc.abstractmethod

     A decorator indicating abstract methods.

     Using this decorator requires that the class’s metaclass is *note
     ABCMeta: 80d. or is derived from it.  A class that has a metaclass
     derived from *note ABCMeta: 80d. cannot be instantiated unless all
     of its abstract methods and properties are overridden.  The
     abstract methods can be called using any of the normal ‘super’ call
     mechanisms.  *note abstractmethod(): 9c2. may be used to declare
     abstract methods for properties and descriptors.

     Dynamically adding abstract methods to a class, or attempting to
     modify the abstraction status of a method or class once it is
     created, are not supported.  The *note abstractmethod(): 9c2. only
     affects subclasses derived using regular inheritance; “virtual
     subclasses” registered with the ABC’s ‘register()’ method are not
     affected.

     When *note abstractmethod(): 9c2. is applied in combination with
     other method descriptors, it should be applied as the innermost
     decorator, as shown in the following usage examples:

          class C(ABC):     @abstractmethod     def my_abstract_method(self, ...):         ...     @classmethod     @abstractmethod     def my_abstract_classmethod(cls, ...):         ...     @staticmethod     @abstractmethod     def my_abstract_staticmethod(...):         ...      @property     @abstractmethod     def my_abstract_property(self):         ...     @my_abstract_property.setter     @abstractmethod     def my_abstract_property(self, val):         ...      @abstractmethod     def _get_x(self):         ...     @abstractmethod     def _set_x(self, val):         ...     x = property(_get_x, _set_x)

     In order to correctly interoperate with the abstract base class
     machinery, the descriptor must identify itself as abstract using
     ‘__isabstractmethod__’.  In general, this attribute should be
     ‘True’ if any of the methods used to compose the descriptor are
     abstract.  For example, Python’s built-in *note property: 1d5. does
     the equivalent of:

          class Descriptor:     ...     @property     def __isabstractmethod__(self):         return any(getattr(f, '__isabstractmethod__', False) for                    f in (self._fget, self._fset, self._fdel))

          Note: Unlike Java abstract methods, these abstract methods may
          have an implementation.  This implementation can be called via
          the *note super(): 4d7. mechanism from the class that
          overrides it.  This could be useful as an end-point for a
          super-call in a framework that uses cooperative
          multiple-inheritance.

The *note abc: 4. module also supports the following legacy decorators:

 -- Function: @abc.abstractclassmethod

     New in version 3.2.

     Deprecated since version 3.3: It is now possible to use *note
     classmethod: 1d6. with *note abstractmethod(): 9c2, making this
     decorator redundant.

     A subclass of the built-in *note classmethod(): 1d6, indicating an
     abstract classmethod.  Otherwise it is similar to *note
     abstractmethod(): 9c2.

     This special case is deprecated, as the *note classmethod(): 1d6.
     decorator is now correctly identified as abstract when applied to
     an abstract method:

          class C(ABC):     @classmethod     @abstractmethod     def my_abstract_classmethod(cls, ...):         ...

 -- Function: @abc.abstractstaticmethod

     New in version 3.2.

     Deprecated since version 3.3: It is now possible to use *note
     staticmethod: 1d7. with *note abstractmethod(): 9c2, making this
     decorator redundant.

     A subclass of the built-in *note staticmethod(): 1d7, indicating an
     abstract staticmethod.  Otherwise it is similar to *note
     abstractmethod(): 9c2.

     This special case is deprecated, as the *note staticmethod(): 1d7.
     decorator is now correctly identified as abstract when applied to
     an abstract method:

          class C(ABC):     @staticmethod     @abstractmethod     def my_abstract_staticmethod(...):         ...

 -- Function: @abc.abstractproperty

     Deprecated since version 3.3: It is now possible to use *note
     property: 1d5, ‘property.getter()’, ‘property.setter()’ and
     ‘property.deleter()’ with *note abstractmethod(): 9c2, making this
     decorator redundant.

     A subclass of the built-in *note property(): 1d5, indicating an
     abstract property.

     This special case is deprecated, as the *note property(): 1d5.
     decorator is now correctly identified as abstract when applied to
     an abstract method:

          class C(ABC):     @property     @abstractmethod     def my_abstract_property(self):         ...

     The above example defines a read-only property; you can also define
     a read-write abstract property by appropriately marking one or more
     of the underlying methods as abstract:

          class C(ABC):     @property     def x(self):         ...      @x.setter     @abstractmethod     def x(self, val):         ...

     If only some components are abstract, only those components need to
     be updated to create a concrete property in a subclass:

          class D(C):     @C.x.setter     def x(self, val):         ...

The *note abc: 4. module also provides the following functions:

 -- Function: abc.get_cache_token ()

     Returns the current abstract base class cache token.

     The token is an opaque object (that supports equality testing)
     identifying the current version of the abstract base class cache
     for virtual subclasses.  The token changes with every call to *note
     ABCMeta.register(): 9c5. on any ABC.

     New in version 3.4.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/abc.py

   (2) https://www.python.org/dev/peps/pep-3119

   (3) https://www.python.org/dev/peps/pep-3141

   (4) (1) C++ programmers should note that Python’s virtual base class
concept is not the same as C++’s.


File: python.info,  Node: atexit — Exit handlers,  Next: traceback — Print or retrieve a stack traceback,  Prev: abc — Abstract Base Classes,  Up: Python Runtime Services

5.30.9 ‘atexit’ — Exit handlers
-------------------------------

__________________________________________________________________

The *note atexit: c. module defines functions to register and unregister
cleanup functions.  Functions thus registered are automatically executed
upon normal interpreter termination.  *note atexit: c. runs these
functions in the `reverse' order in which they were registered; if you
register ‘A’, ‘B’, and ‘C’, at interpreter termination time they will be
run in the order ‘C’, ‘B’, ‘A’.

`Note:' The functions registered via this module are not called when the
program is killed by a signal not handled by Python, when a Python fatal
internal error is detected, or when *note os._exit(): 1646. is called.

Changed in version 3.7: When used with C-API subinterpreters, registered
functions are local to the interpreter they were registered in.

 -- Function: atexit.register (func, *args, **kwargs)

     Register `func' as a function to be executed at termination.  Any
     optional arguments that are to be passed to `func' must be passed
     as arguments to *note register(): e79.  It is possible to register
     the same function and arguments more than once.

     At normal program termination (for instance, if *note sys.exit():
     cd5. is called or the main module’s execution completes), all
     functions registered are called in last in, first out order.  The
     assumption is that lower level modules will normally be imported
     before higher level modules and thus must be cleaned up later.

     If an exception is raised during execution of the exit handlers, a
     traceback is printed (unless *note SystemExit: 5f1. is raised) and
     the exception information is saved.  After all exit handlers have
     had a chance to run the last exception to be raised is re-raised.

     This function returns `func', which makes it possible to use it as
     a decorator.

 -- Function: atexit.unregister (func)

     Remove `func' from the list of functions to be run at interpreter
     shutdown.  After calling *note unregister(): 35cb, `func' is
     guaranteed not to be called when the interpreter shuts down, even
     if it was registered more than once.  *note unregister(): 35cb.
     silently does nothing if `func' was not previously registered.

See also
........

Module *note readline: de.

     Useful example of *note atexit: c. to read and write *note
     readline: de. history files.

* Menu:

* atexit Example::


File: python.info,  Node: atexit Example,  Up: atexit — Exit handlers

5.30.9.1 ‘atexit’ Example
.........................

The following simple example demonstrates how a module can initialize a
counter from a file when it is imported and save the counter’s updated
value automatically when the program terminates without relying on the
application making an explicit call into this module at termination.

     try:     with open("counterfile") as infile:         _count = int(infile.read()) except FileNotFoundError:     _count = 0  def incrcounter(n):     global _count     _count = _count + n  def savecounter():     with open("counterfile", "w") as outfile:         outfile.write("%d" % _count)  import atexit atexit.register(savecounter)

Positional and keyword arguments may also be passed to *note register():
e79. to be passed along to the registered function when it is called:

     def goodbye(name, adjective):     print('Goodbye, %s, it was %s to meet you.' % (name, adjective))  import atexit atexit.register(goodbye, 'Donny', 'nice')  # or: atexit.register(goodbye, adjective='nice', name='Donny')

Usage as a *note decorator: 281.:

     import atexit  @atexit.register def goodbye():     print("You are now leaving the Python sector.")

This only works with functions that can be called without arguments.


File: python.info,  Node: traceback — Print or retrieve a stack traceback,  Next: __future__ — Future statement definitions,  Prev: atexit — Exit handlers,  Up: Python Runtime Services

5.30.10 ‘traceback’ — Print or retrieve a stack traceback
---------------------------------------------------------

`Source code:' Lib/traceback.py(1)

__________________________________________________________________

This module provides a standard interface to extract, format and print
stack traces of Python programs.  It exactly mimics the behavior of the
Python interpreter when it prints a stack trace.  This is useful when
you want to print stack traces under program control, such as in a
“wrapper” around the interpreter.

The module uses traceback objects — this is the object type that is
stored in the *note sys.last_traceback: 346d. variable and returned as
the third item from *note sys.exc_info(): c52.

The module defines the following functions:

 -- Function: traceback.print_tb (tb, limit=None, file=None)

     Print up to `limit' stack trace entries from traceback object `tb'
     (starting from the caller’s frame) if `limit' is positive.
     Otherwise, print the last ‘abs(limit)’ entries.  If `limit' is
     omitted or ‘None’, all entries are printed.  If `file' is omitted
     or ‘None’, the output goes to ‘sys.stderr’; otherwise it should be
     an open file or file-like object to receive the output.

     Changed in version 3.5: Added negative `limit' support.

 -- Function: traceback.print_exception (etype, value, tb, limit=None,
          file=None, chain=True)

     Print exception information and stack trace entries from traceback
     object `tb' to `file'.  This differs from *note print_tb(): 76d. in
     the following ways:

        * if `tb' is not ‘None’, it prints a header ‘Traceback (most
          recent call last):’

        * it prints the exception `etype' and `value' after the stack
          trace

        * if `type(value)' is *note SyntaxError: 44d. and `value' has
          the appropriate format, it prints the line where the syntax
          error occurred with a caret indicating the approximate
          position of the error.

     The optional `limit' argument has the same meaning as for *note
     print_tb(): 76d.  If `chain' is true (the default), then chained
     exceptions (the ‘__cause__’ or ‘__context__’ attributes of the
     exception) will be printed as well, like the interpreter itself
     does when printing an unhandled exception.

     Changed in version 3.5: The `etype' argument is ignored and
     inferred from the type of `value'.

 -- Function: traceback.print_exc (limit=None, file=None, chain=True)

     This is a shorthand for ‘print_exception(*sys.exc_info(), limit,
     file, chain)’.

 -- Function: traceback.print_last (limit=None, file=None, chain=True)

     This is a shorthand for ‘print_exception(sys.last_type,
     sys.last_value, sys.last_traceback, limit, file, chain)’.  In
     general it will work only after an exception has reached an
     interactive prompt (see *note sys.last_type: c4d.).

 -- Function: traceback.print_stack (f=None, limit=None, file=None)

     Print up to `limit' stack trace entries (starting from the
     invocation point) if `limit' is positive.  Otherwise, print the
     last ‘abs(limit)’ entries.  If `limit' is omitted or ‘None’, all
     entries are printed.  The optional `f' argument can be used to
     specify an alternate stack frame to start.  The optional `file'
     argument has the same meaning as for *note print_tb(): 76d.

     Changed in version 3.5: Added negative `limit' support.

 -- Function: traceback.extract_tb (tb, limit=None)

     Return a *note StackSummary: 76b. object representing a list of
     “pre-processed” stack trace entries extracted from the traceback
     object `tb'.  It is useful for alternate formatting of stack
     traces.  The optional `limit' argument has the same meaning as for
     *note print_tb(): 76d.  A “pre-processed” stack trace entry is a
     *note FrameSummary: 76c. object containing attributes ‘filename’,
     ‘lineno’, ‘name’, and ‘line’ representing the information that is
     usually printed for a stack trace.  The ‘line’ is a string with
     leading and trailing whitespace stripped; if the source is not
     available it is ‘None’.

 -- Function: traceback.extract_stack (f=None, limit=None)

     Extract the raw traceback from the current stack frame.  The return
     value has the same format as for *note extract_tb(): 35d2.  The
     optional `f' and `limit' arguments have the same meaning as for
     *note print_stack(): 76e.

 -- Function: traceback.format_list (extracted_list)

     Given a list of tuples or *note FrameSummary: 76c. objects as
     returned by *note extract_tb(): 35d2. or *note extract_stack():
     35d3, return a list of strings ready for printing.  Each string in
     the resulting list corresponds to the item with the same index in
     the argument list.  Each string ends in a newline; the strings may
     contain internal newlines as well, for those items whose source
     text line is not ‘None’.

 -- Function: traceback.format_exception_only (etype, value)

     Format the exception part of a traceback.  The arguments are the
     exception type and value such as given by ‘sys.last_type’ and
     ‘sys.last_value’.  The return value is a list of strings, each
     ending in a newline.  Normally, the list contains a single string;
     however, for *note SyntaxError: 44d. exceptions, it contains
     several lines that (when printed) display detailed information
     about where the syntax error occurred.  The message indicating
     which exception occurred is the always last string in the list.

 -- Function: traceback.format_exception (etype, value, tb, limit=None,
          chain=True)

     Format a stack trace and the exception information.  The arguments
     have the same meaning as the corresponding arguments to *note
     print_exception(): 1fee.  The return value is a list of strings,
     each ending in a newline and some containing internal newlines.
     When these lines are concatenated and printed, exactly the same
     text is printed as does *note print_exception(): 1fee.

     Changed in version 3.5: The `etype' argument is ignored and
     inferred from the type of `value'.

 -- Function: traceback.format_exc (limit=None, chain=True)

     This is like ‘print_exc(limit)’ but returns a string instead of
     printing to a file.

 -- Function: traceback.format_tb (tb, limit=None)

     A shorthand for ‘format_list(extract_tb(tb, limit))’.

 -- Function: traceback.format_stack (f=None, limit=None)

     A shorthand for ‘format_list(extract_stack(f, limit))’.

 -- Function: traceback.clear_frames (tb)

     Clears the local variables of all the stack frames in a traceback
     `tb' by calling the ‘clear()’ method of each frame object.

     New in version 3.4.

 -- Function: traceback.walk_stack (f)

     Walk a stack following ‘f.f_back’ from the given frame, yielding
     the frame and line number for each frame.  If `f' is ‘None’, the
     current stack is used.  This helper is used with *note
     StackSummary.extract(): 35d8.

     New in version 3.5.

 -- Function: traceback.walk_tb (tb)

     Walk a traceback following ‘tb_next’ yielding the frame and line
     number for each frame.  This helper is used with *note
     StackSummary.extract(): 35d8.

     New in version 3.5.

The module also defines the following classes:

* Menu:

* TracebackException Objects::
* StackSummary Objects::
* FrameSummary Objects::
* Traceback Examples::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/traceback.py


File: python.info,  Node: TracebackException Objects,  Next: StackSummary Objects,  Up: traceback — Print or retrieve a stack traceback

5.30.10.1 ‘TracebackException’ Objects
......................................

New in version 3.5.

*note TracebackException: 76a. objects are created from actual
exceptions to capture data for later printing in a lightweight fashion.

 -- Class: traceback.TracebackException (exc_type, exc_value,
          exc_traceback, *, limit=None, lookup_lines=True,
          capture_locals=False)

     Capture an exception for later rendering.  `limit', `lookup_lines'
     and `capture_locals' are as for the *note StackSummary: 76b. class.

     Note that when locals are captured, they are also shown in the
     traceback.

      -- Attribute: __cause__

          A *note TracebackException: 76a. of the original ‘__cause__’.

      -- Attribute: __context__

          A *note TracebackException: 76a. of the original
          ‘__context__’.

      -- Attribute: __suppress_context__

          The ‘__suppress_context__’ value from the original exception.

      -- Attribute: stack

          A *note StackSummary: 76b. representing the traceback.

      -- Attribute: exc_type

          The class of the original traceback.

      -- Attribute: filename

          For syntax errors - the file name where the error occurred.

      -- Attribute: lineno

          For syntax errors - the line number where the error occurred.

      -- Attribute: text

          For syntax errors - the text where the error occurred.

      -- Attribute: offset

          For syntax errors - the offset into the text where the error
          occurred.

      -- Attribute: msg

          For syntax errors - the compiler error message.

      -- Class Method: from_exception (exc, *, limit=None,
               lookup_lines=True, capture_locals=False)

          Capture an exception for later rendering.  `limit',
          `lookup_lines' and `capture_locals' are as for the *note
          StackSummary: 76b. class.

          Note that when locals are captured, they are also shown in the
          traceback.

      -- Method: format (*, chain=True)

          Format the exception.

          If `chain' is not ‘True’, ‘__cause__’ and ‘__context__’ will
          not be formatted.

          The return value is a generator of strings, each ending in a
          newline and some containing internal newlines.  *note
          print_exception(): 1fee. is a wrapper around this method which
          just prints the lines to a file.

          The message indicating which exception occurred is always the
          last string in the output.

      -- Method: format_exception_only ()

          Format the exception part of the traceback.

          The return value is a generator of strings, each ending in a
          newline.

          Normally, the generator emits a single string; however, for
          *note SyntaxError: 44d. exceptions, it emits several lines
          that (when printed) display detailed information about where
          the syntax error occurred.

          The message indicating which exception occurred is always the
          last string in the output.


File: python.info,  Node: StackSummary Objects,  Next: FrameSummary Objects,  Prev: TracebackException Objects,  Up: traceback — Print or retrieve a stack traceback

5.30.10.2 ‘StackSummary’ Objects
................................

New in version 3.5.

*note StackSummary: 76b. objects represent a call stack ready for
formatting.

 -- Class: traceback.StackSummary

      -- Class Method: extract (frame_gen, *, limit=None,
               lookup_lines=True, capture_locals=False)

          Construct a *note StackSummary: 76b. object from a frame
          generator (such as is returned by *note walk_stack(): 768. or
          *note walk_tb(): 769.).

          If `limit' is supplied, only this many frames are taken from
          `frame_gen'.  If `lookup_lines' is ‘False’, the returned *note
          FrameSummary: 76c. objects will not have read their lines in
          yet, making the cost of creating the *note StackSummary: 76b.
          cheaper (which may be valuable if it may not actually get
          formatted).  If `capture_locals' is ‘True’ the local variables
          in each *note FrameSummary: 76c. are captured as object
          representations.

      -- Class Method: from_list (a_list)

          Construct a *note StackSummary: 76b. object from a supplied
          list of *note FrameSummary: 76c. objects or old-style list of
          tuples.  Each tuple should be a 4-tuple with filename, lineno,
          name, line as the elements.

      -- Method: format ()

          Returns a list of strings ready for printing.  Each string in
          the resulting list corresponds to a single frame from the
          stack.  Each string ends in a newline; the strings may contain
          internal newlines as well, for those items with source text
          lines.

          For long sequences of the same frame and line, the first few
          repetitions are shown, followed by a summary line stating the
          exact number of further repetitions.

          Changed in version 3.6: Long sequences of repeated frames are
          now abbreviated.


File: python.info,  Node: FrameSummary Objects,  Next: Traceback Examples,  Prev: StackSummary Objects,  Up: traceback — Print or retrieve a stack traceback

5.30.10.3 ‘FrameSummary’ Objects
................................

New in version 3.5.

*note FrameSummary: 76c. objects represent a single frame in a
traceback.

 -- Class: traceback.FrameSummary (filename, lineno, name,
          lookup_line=True, locals=None, line=None)

     Represent a single frame in the traceback or stack that is being
     formatted or printed.  It may optionally have a stringified version
     of the frames locals included in it.  If `lookup_line' is ‘False’,
     the source code is not looked up until the *note FrameSummary: 76c.
     has the ‘line’ attribute accessed (which also happens when casting
     it to a tuple).  ‘line’ may be directly provided, and will prevent
     line lookups happening at all.  `locals' is an optional local
     variable dictionary, and if supplied the variable representations
     are stored in the summary for later display.


File: python.info,  Node: Traceback Examples,  Prev: FrameSummary Objects,  Up: traceback — Print or retrieve a stack traceback

5.30.10.4 Traceback Examples
............................

This simple example implements a basic read-eval-print loop, similar to
(but less useful than) the standard Python interactive interpreter loop.
For a more complete implementation of the interpreter loop, refer to the
*note code: 1b. module.

     import sys, traceback  def run_user_code(envdir):     source = input(">>> ")     try:         exec(source, envdir)     except Exception:         print("Exception in user code:")         print("-"*60)         traceback.print_exc(file=sys.stdout)         print("-"*60)  envdir = {} while True:     run_user_code(envdir)

The following example demonstrates the different ways to print and
format the exception and traceback:

     import sys, traceback  def lumberjack():     bright_side_of_death()  def bright_side_of_death():     return tuple()[0]  try:     lumberjack() except IndexError:     exc_type, exc_value, exc_traceback = sys.exc_info()     print("*** print_tb:")     traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)     print("*** print_exception:")     # exc_type below is ignored on 3.5 and later     traceback.print_exception(exc_type, exc_value, exc_traceback,                               limit=2, file=sys.stdout)     print("*** print_exc:")     traceback.print_exc(limit=2, file=sys.stdout)     print("*** format_exc, first and last line:")     formatted_lines = traceback.format_exc().splitlines()     print(formatted_lines[0])     print(formatted_lines[-1])     print("*** format_exception:")     # exc_type below is ignored on 3.5 and later     print(repr(traceback.format_exception(exc_type, exc_value,                                           exc_traceback)))     print("*** extract_tb:")     print(repr(traceback.extract_tb(exc_traceback)))     print("*** format_tb:")     print(repr(traceback.format_tb(exc_traceback)))     print("*** tb_lineno:", exc_traceback.tb_lineno)

The output for the example would look similar to this:

     *** print_tb:   File "<doctest...>", line 10, in <module>     lumberjack() *** print_exception: Traceback (most recent call last):   File "<doctest...>", line 10, in <module>     lumberjack()   File "<doctest...>", line 4, in lumberjack     bright_side_of_death() IndexError: tuple index out of range *** print_exc: Traceback (most recent call last):   File "<doctest...>", line 10, in <module>     lumberjack()   File "<doctest...>", line 4, in lumberjack     bright_side_of_death() IndexError: tuple index out of range *** format_exc, first and last line: Traceback (most recent call last): IndexError: tuple index out of range *** format_exception: ['Traceback (most recent call last):\n',  '  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',  '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',  '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n',  'IndexError: tuple index out of range\n'] *** extract_tb: [<FrameSummary file <doctest...>, line 10 in <module>>,  <FrameSummary file <doctest...>, line 4 in lumberjack>,  <FrameSummary file <doctest...>, line 7 in bright_side_of_death>] *** format_tb: ['  File "<doctest...>", line 10, in <module>\n    lumberjack()\n',  '  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n',  '  File "<doctest...>", line 7, in bright_side_of_death\n    return tuple()[0]\n'] *** tb_lineno: 10

The following example shows the different ways to print and format the
stack:

     >>> import traceback >>> def another_function(): ...     lumberstack() ... >>> def lumberstack(): ...     traceback.print_stack() ...     print(repr(traceback.extract_stack())) ...     print(repr(traceback.format_stack())) ... >>> another_function()   File "<doctest>", line 10, in <module>     another_function()   File "<doctest>", line 3, in another_function     lumberstack()   File "<doctest>", line 6, in lumberstack     traceback.print_stack() [('<doctest>', 10, '<module>', 'another_function()'),  ('<doctest>', 3, 'another_function', 'lumberstack()'),  ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')] ['  File "<doctest>", line 10, in <module>\n    another_function()\n',  '  File "<doctest>", line 3, in another_function\n    lumberstack()\n',  '  File "<doctest>", line 8, in lumberstack\n    print(repr(traceback.format_stack()))\n']

This last example demonstrates the final few formatting functions:

     >>> import traceback >>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'), ...                        ('eggs.py', 42, 'eggs', 'return "bacon"')]) ['  File "spam.py", line 3, in <module>\n    spam.eggs()\n',  '  File "eggs.py", line 42, in eggs\n    return "bacon"\n'] >>> an_error = IndexError('tuple index out of range') >>> traceback.format_exception_only(type(an_error), an_error) ['IndexError: tuple index out of range\n']


File: python.info,  Node: __future__ — Future statement definitions,  Next: gc — Garbage Collector interface,  Prev: traceback — Print or retrieve a stack traceback,  Up: Python Runtime Services

5.30.11 ‘__future__’ — Future statement definitions
---------------------------------------------------

`Source code:' Lib/__future__.py(1)

__________________________________________________________________

*note __future__: 0. is a real module, and serves three purposes:

   * To avoid confusing existing tools that analyze import statements
     and expect to find the modules they’re importing.

   * To ensure that *note future statements: 14c9. run under releases
     prior to 2.1 at least yield runtime exceptions (the import of *note
     __future__: 0. will fail, because there was no module of that name
     prior to 2.1).

   * To document when incompatible changes were introduced, and when
     they will be — or were — made mandatory.  This is a form of
     executable documentation, and can be inspected programmatically via
     importing *note __future__: 0. and examining its contents.

Each statement in ‘__future__.py’ is of the form:

     FeatureName = _Feature(OptionalRelease, MandatoryRelease,                        CompilerFlag)

where, normally, `OptionalRelease' is less than `MandatoryRelease', and
both are 5-tuples of the same form as *note sys.version_info: b0d.:

     (PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int  PY_MINOR_VERSION, # the 1; an int  PY_MICRO_VERSION, # the 0; an int  PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" or "final"; string  PY_RELEASE_SERIAL # the 3; an int )

`OptionalRelease' records the first release in which the feature was
accepted.

In the case of a `MandatoryRelease' that has not yet occurred,
`MandatoryRelease' predicts the release in which the feature will become
part of the language.

Else `MandatoryRelease' records when the feature became part of the
language; in releases at or after that, modules no longer need a future
statement to use the feature in question, but may continue to use such
imports.

`MandatoryRelease' may also be ‘None’, meaning that a planned feature
got dropped.

Instances of class ‘_Feature’ have two corresponding methods,
‘getOptionalRelease()’ and ‘getMandatoryRelease()’.

`CompilerFlag' is the (bitfield) flag that should be passed in the
fourth argument to the built-in function *note compile(): 1b2. to enable
the feature in dynamically compiled code.  This flag is stored in the
‘compiler_flag’ attribute on ‘_Feature’ instances.

No feature description will ever be deleted from *note __future__: 0.
Since its introduction in Python 2.1 the following features have found
their way into the language using this mechanism:

feature                optional in       mandatory in       effect
                                                            
--------------------------------------------------------------------------------------------------------------
                                                            
nested_scopes          2.1.0b1           2.2                PEP 227(2): `Statically Nested Scopes'
                                                            
                                                            
generators             2.2.0a1           2.3                PEP 255(3): `Simple Generators'
                                                            
                                                            
division               2.2.0a2           3.0                PEP 238(4): `Changing the Division Operator'
                                                            
                                                            
absolute_import        2.5.0a1           3.0                PEP 328(5): `Imports: Multi-Line and
                                                            Absolute/Relative'
                                                            
                                                            
with_statement         2.5.0a1           2.6                PEP 343(6): `The “with” Statement'
                                                            
                                                            
print_function         2.6.0a2           3.0                PEP 3105(7): `Make print a function'
                                                            
                                                            
unicode_literals       2.6.0a2           3.0                PEP 3112(8): `Bytes literals in Python 3000'
                                                            
                                                            
generator_stop         3.5.0b1           3.7                PEP 479(9): `StopIteration handling inside
                                                            generators'
                                                            
                                                            
annotations            3.7.0b1           4.0                PEP 563(10): `Postponed evaluation of
                                                            annotations'
                                                            

See also
........

*note Future statements: 14c9.

     How the compiler treats future imports.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/__future__.py

   (2) https://www.python.org/dev/peps/pep-0227

   (3) https://www.python.org/dev/peps/pep-0255

   (4) https://www.python.org/dev/peps/pep-0238

   (5) https://www.python.org/dev/peps/pep-0328

   (6) https://www.python.org/dev/peps/pep-0343

   (7) https://www.python.org/dev/peps/pep-3105

   (8) https://www.python.org/dev/peps/pep-3112

   (9) https://www.python.org/dev/peps/pep-0479

   (10) https://www.python.org/dev/peps/pep-0563


File: python.info,  Node: gc — Garbage Collector interface,  Next: inspect — Inspect live objects,  Prev: __future__ — Future statement definitions,  Up: Python Runtime Services

5.30.12 ‘gc’ — Garbage Collector interface
------------------------------------------

__________________________________________________________________

This module provides an interface to the optional garbage collector.  It
provides the ability to disable the collector, tune the collection
frequency, and set debugging options.  It also provides access to
unreachable objects that the collector found but cannot free.  Since the
collector supplements the reference counting already used in Python, you
can disable the collector if you are sure your program does not create
reference cycles.  Automatic collection can be disabled by calling
‘gc.disable()’.  To debug a leaking program call
‘gc.set_debug(gc.DEBUG_LEAK)’.  Notice that this includes
‘gc.DEBUG_SAVEALL’, causing garbage-collected objects to be saved in
gc.garbage for inspection.

The *note gc: 86. module provides the following functions:

 -- Function: gc.enable ()

     Enable automatic garbage collection.

 -- Function: gc.disable ()

     Disable automatic garbage collection.

 -- Function: gc.isenabled ()

     Return ‘True’ if automatic collection is enabled.

 -- Function: gc.collect (generation=2)

     With no arguments, run a full collection.  The optional argument
     `generation' may be an integer specifying which generation to
     collect (from 0 to 2).  A *note ValueError: 1f9. is raised if the
     generation number is invalid.  The number of unreachable objects
     found is returned.

     The free lists maintained for a number of built-in types are
     cleared whenever a full collection or collection of the highest
     generation (2) is run.  Not all items in some free lists may be
     freed due to the particular implementation, in particular *note
     float: 187.

 -- Function: gc.set_debug (flags)

     Set the garbage collection debugging flags.  Debugging information
     will be written to ‘sys.stderr’.  See below for a list of debugging
     flags which can be combined using bit operations to control
     debugging.

 -- Function: gc.get_debug ()

     Return the debugging flags currently set.

 -- Function: gc.get_objects (generation=None)

     Returns a list of all objects tracked by the collector, excluding
     the list returned.  If `generation' is not None, return only the
     objects tracked by the collector that are in that generation.

     Changed in version 3.8: New `generation' parameter.

 -- Function: gc.get_stats ()

     Return a list of three per-generation dictionaries containing
     collection statistics since interpreter start.  The number of keys
     may change in the future, but currently each dictionary will
     contain the following items:

        * ‘collections’ is the number of times this generation was
          collected;

        * ‘collected’ is the total number of objects collected inside
          this generation;

        * ‘uncollectable’ is the total number of objects which were
          found to be uncollectable (and were therefore moved to the
          *note garbage: b33. list) inside this generation.

     New in version 3.4.

 -- Function: gc.set_threshold (threshold0[, threshold1[, threshold2]])

     Set the garbage collection thresholds (the collection frequency).
     Setting `threshold0' to zero disables collection.

     The GC classifies objects into three generations depending on how
     many collection sweeps they have survived.  New objects are placed
     in the youngest generation (generation ‘0’).  If an object survives
     a collection it is moved into the next older generation.  Since
     generation ‘2’ is the oldest generation, objects in that generation
     remain there after a collection.  In order to decide when to run,
     the collector keeps track of the number object allocations and
     deallocations since the last collection.  When the number of
     allocations minus the number of deallocations exceeds `threshold0',
     collection starts.  Initially only generation ‘0’ is examined.  If
     generation ‘0’ has been examined more than `threshold1' times since
     generation ‘1’ has been examined, then generation ‘1’ is examined
     as well.  Similarly, `threshold2' controls the number of
     collections of generation ‘1’ before collecting generation ‘2’.

 -- Function: gc.get_count ()

     Return the current collection counts as a tuple of ‘(count0,
     count1, count2)’.

 -- Function: gc.get_threshold ()

     Return the current collection thresholds as a tuple of
     ‘(threshold0, threshold1, threshold2)’.

 -- Function: gc.get_referrers (*objs)

     Return the list of objects that directly refer to any of objs.
     This function will only locate those containers which support
     garbage collection; extension types which do refer to other objects
     but do not support garbage collection will not be found.

     Note that objects which have already been dereferenced, but which
     live in cycles and have not yet been collected by the garbage
     collector can be listed among the resulting referrers.  To get only
     currently live objects, call *note collect(): 22c. before calling
     *note get_referrers(): 34fa.

     Care must be taken when using objects returned by *note
     get_referrers(): 34fa. because some of them could still be under
     construction and hence in a temporarily invalid state.  Avoid using
     *note get_referrers(): 34fa. for any purpose other than debugging.

 -- Function: gc.get_referents (*objs)

     Return a list of objects directly referred to by any of the
     arguments.  The referents returned are those objects visited by the
     arguments’ C-level *note tp_traverse: 35fa. methods (if any), and
     may not be all objects actually directly reachable.  *note
     tp_traverse: 35fa. methods are supported only by objects that
     support garbage collection, and are only required to visit objects
     that may be involved in a cycle.  So, for example, if an integer is
     directly reachable from an argument, that integer object may or may
     not appear in the result list.

 -- Function: gc.is_tracked (obj)

     Returns ‘True’ if the object is currently tracked by the garbage
     collector, ‘False’ otherwise.  As a general rule, instances of
     atomic types aren’t tracked and instances of non-atomic types
     (containers, user-defined objects…) are.  However, some
     type-specific optimizations can be present in order to suppress the
     garbage collector footprint of simple instances (e.g.  dicts
     containing only atomic keys and values):

          >>> gc.is_tracked(0) False >>> gc.is_tracked("a") False >>> gc.is_tracked([]) True >>> gc.is_tracked({}) False >>> gc.is_tracked({"a": 1}) False >>> gc.is_tracked({"a": []}) True

     New in version 3.1.

 -- Function: gc.freeze ()

     Freeze all the objects tracked by gc - move them to a permanent
     generation and ignore all the future collections.  This can be used
     before a POSIX fork() call to make the gc copy-on-write friendly or
     to speed up collection.  Also collection before a POSIX fork() call
     may free pages for future allocation which can cause copy-on-write
     too so it’s advised to disable gc in parent process and freeze
     before fork and enable gc in child process.

     New in version 3.7.

 -- Function: gc.unfreeze ()

     Unfreeze the objects in the permanent generation, put them back
     into the oldest generation.

     New in version 3.7.

 -- Function: gc.get_freeze_count ()

     Return the number of objects in the permanent generation.

     New in version 3.7.

The following variables are provided for read-only access (you can
mutate the values but should not rebind them):

 -- Data: gc.garbage

     A list of objects which the collector found to be unreachable but
     could not be freed (uncollectable objects).  Starting with Python
     3.4, this list should be empty most of the time, except when using
     instances of C extension types with a non-‘NULL’ ‘tp_del’ slot.

     If *note DEBUG_SAVEALL: 35fb. is set, then all unreachable objects
     will be added to this list rather than freed.

     Changed in version 3.2: If this list is non-empty at *note
     interpreter shutdown: 757, a *note ResourceWarning: 4c5. is
     emitted, which is silent by default.  If *note DEBUG_UNCOLLECTABLE:
     b34. is set, in addition all uncollectable objects are printed.

     Changed in version 3.4: Following PEP 442(1), objects with a *note
     __del__(): 913. method don’t end up in *note gc.garbage: b33.
     anymore.

 -- Data: gc.callbacks

     A list of callbacks that will be invoked by the garbage collector
     before and after collection.  The callbacks will be called with two
     arguments, `phase' and `info'.

     `phase' can be one of two values:

          “start”: The garbage collection is about to start.

          “stop”: The garbage collection has finished.

     `info' is a dict providing more information for the callback.  The
     following keys are currently defined:

          “generation”: The oldest generation being collected.

          “collected”: When `phase' is “stop”, the number of objects
          successfully collected.

          “uncollectable”: When `phase' is “stop”, the number of objects
          that could not be collected and were put in *note garbage:
          b33.

     Applications can add their own callbacks to this list.  The primary
     use cases are:

          Gathering statistics about garbage collection, such as how
          often various generations are collected, and how long the
          collection takes.

          Allowing applications to identify and clear their own
          uncollectable types when they appear in *note garbage: b33.

     New in version 3.3.

The following constants are provided for use with *note set_debug():
35f4.:

 -- Data: gc.DEBUG_STATS

     Print statistics during collection.  This information can be useful
     when tuning the collection frequency.

 -- Data: gc.DEBUG_COLLECTABLE

     Print information on collectable objects found.

 -- Data: gc.DEBUG_UNCOLLECTABLE

     Print information of uncollectable objects found (objects which are
     not reachable but cannot be freed by the collector).  These objects
     will be added to the ‘garbage’ list.

     Changed in version 3.2: Also print the contents of the *note
     garbage: b33. list at *note interpreter shutdown: 757, if it isn’t
     empty.

 -- Data: gc.DEBUG_SAVEALL

     When set, all unreachable objects found will be appended to
     `garbage' rather than being freed.  This can be useful for
     debugging a leaking program.

 -- Data: gc.DEBUG_LEAK

     The debugging flags necessary for the collector to print
     information about a leaking program (equal to ‘DEBUG_COLLECTABLE |
     DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL’).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0442


File: python.info,  Node: inspect — Inspect live objects,  Next: site — Site-specific configuration hook,  Prev: gc — Garbage Collector interface,  Up: Python Runtime Services

5.30.13 ‘inspect’ — Inspect live objects
----------------------------------------

`Source code:' Lib/inspect.py(1)

__________________________________________________________________

The *note inspect: a0. module provides several useful functions to help
get information about live objects such as modules, classes, methods,
functions, tracebacks, frame objects, and code objects.  For example, it
can help you examine the contents of a class, retrieve the source code
of a method, extract and format the argument list for a function, or get
all the information you need to display a detailed traceback.

There are four main kinds of services provided by this module: type
checking, getting source code, inspecting classes and functions, and
examining the interpreter stack.

* Menu:

* Types and members::
* Retrieving source code::
* Introspecting callables with the Signature object::
* Classes and functions: Classes and functions<2>.
* The interpreter stack::
* Fetching attributes statically::
* Current State of Generators and Coroutines::
* Code Objects Bit Flags::
* Command Line Interface: Command Line Interface<3>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/inspect.py


File: python.info,  Node: Types and members,  Next: Retrieving source code,  Up: inspect — Inspect live objects

5.30.13.1 Types and members
...........................

The *note getmembers(): 3603. function retrieves the members of an
object such as a class or module.  The functions whose names begin with
“is” are mainly provided as convenient choices for the second argument
to *note getmembers(): 3603.  They also help you determine when you can
expect to find the following special attributes:

Type            Attribute               Description
                                        
------------------------------------------------------------------------
                                        
module          __doc__                 documentation string
                                        
                                        
                __file__                filename (missing for
                                        built-in modules)
                                        
                                        
class           __doc__                 documentation string
                                        
                                        
                __name__                name with which this class
                                        was defined
                                        
                                        
                __qualname__            qualified name
                                        
                                        
                __module__              name of module in which this
                                        class was defined
                                        
                                        
method          __doc__                 documentation string
                                        
                                        
                __name__                name with which this method
                                        was defined
                                        
                                        
                __qualname__            qualified name
                                        
                                        
                __func__                function object containing
                                        implementation of method
                                        
                                        
                __self__                instance to which this method
                                        is bound, or ‘None’
                                        
                                        
function        __doc__                 documentation string
                                        
                                        
                __name__                name with which this function
                                        was defined
                                        
                                        
                __qualname__            qualified name
                                        
                                        
                __code__                code object containing
                                        compiled function
                                        *note bytecode: 609.
                                        
                                        
                __defaults__            tuple of any default values
                                        for positional or keyword
                                        parameters
                                        
                                        
                __kwdefaults__          mapping of any default values
                                        for keyword-only parameters
                                        
                                        
                __globals__             global namespace in which
                                        this function was defined
                                        
                                        
                __annotations__         mapping of parameters names
                                        to annotations; ‘"return"’
                                        key is reserved for return
                                        annotations.
                                        
                                        
traceback       tb_frame                frame object at this level
                                        
                                        
                tb_lasti                index of last attempted
                                        instruction in bytecode
                                        
                                        
                tb_lineno               current line number in Python
                                        source code
                                        
                                        
                tb_next                 next inner traceback object
                                        (called by this level)
                                        
                                        
frame           f_back                  next outer frame object (this
                                        frame’s caller)
                                        
                                        
                f_builtins              builtins namespace seen by
                                        this frame
                                        
                                        
                f_code                  code object being executed in
                                        this frame
                                        
                                        
                f_globals               global namespace seen by this
                                        frame
                                        
                                        
                f_lasti                 index of last attempted
                                        instruction in bytecode
                                        
                                        
                f_lineno                current line number in Python
                                        source code
                                        
                                        
                f_locals                local namespace seen by this
                                        frame
                                        
                                        
                f_trace                 tracing function for this
                                        frame, or ‘None’
                                        
                                        
code            co_argcount             number of arguments (not
                                        including keyword only
                                        arguments, * or ** args)
                                        
                                        
                co_code                 string of raw compiled
                                        bytecode
                                        
                                        
                co_cellvars             tuple of names of cell
                                        variables (referenced by
                                        containing scopes)
                                        
                                        
                co_consts               tuple of constants used in
                                        the bytecode
                                        
                                        
                co_filename             name of file in which this
                                        code object was created
                                        
                                        
                co_firstlineno          number of first line in
                                        Python source code
                                        
                                        
                co_flags                bitmap of ‘CO_*’ flags, read
                                        more *note here: 3604.
                                        
                                        
                co_lnotab               encoded mapping of line
                                        numbers to bytecode indices
                                        
                                        
                co_freevars             tuple of names of free
                                        variables (referenced via a
                                        function’s closure)
                                        
                                        
                co_posonlyargcount      number of positional only
                                        arguments
                                        
                                        
                co_kwonlyargcount       number of keyword only
                                        arguments (not including **
                                        arg)
                                        
                                        
                co_name                 name with which this code
                                        object was defined
                                        
                                        
                co_names                tuple of names of local
                                        variables
                                        
                                        
                co_nlocals              number of local variables
                                        
                                        
                co_stacksize            virtual machine stack space
                                        required
                                        
                                        
                co_varnames             tuple of names of arguments
                                        and local variables
                                        
                                        
generator       __name__                name
                                        
                                        
                __qualname__            qualified name
                                        
                                        
                gi_frame                frame
                                        
                                        
                gi_running              is the generator running?
                                        
                                        
                gi_code                 code
                                        
                                        
                gi_yieldfrom            object being iterated by
                                        ‘yield from’, or ‘None’
                                        
                                        
coroutine       __name__                name
                                        
                                        
                __qualname__            qualified name
                                        
                                        
                cr_await                object being awaited on, or
                                        ‘None’
                                        
                                        
                cr_frame                frame
                                        
                                        
                cr_running              is the coroutine running?
                                        
                                        
                cr_code                 code
                                        
                                        
                cr_origin               where coroutine was created,
                                        or ‘None’.  See
                                        *note sys.set_coroutine_origin_tracking_depth(): 3e8.
                                        
                                        
builtin         __doc__                 documentation string
                                        
                                        
                __name__                original name of this
                                        function or method
                                        
                                        
                __qualname__            qualified name
                                        
                                        
                __self__                instance to which a method is
                                        bound, or ‘None’
                                        

Changed in version 3.5: Add ‘__qualname__’ and ‘gi_yieldfrom’ attributes
to generators.

The ‘__name__’ attribute of generators is now set from the function
name, instead of the code name, and it can now be modified.

Changed in version 3.7: Add ‘cr_origin’ attribute to coroutines.

 -- Function: inspect.getmembers (object[, predicate])

     Return all the members of an object in a list of ‘(name, value)’
     pairs sorted by name.  If the optional `predicate' argument—which
     will be called with the ‘value’ object of each member—is supplied,
     only members for which the predicate returns a true value are
     included.

          Note: *note getmembers(): 3603. will only return class
          attributes defined in the metaclass when the argument is a
          class and those attributes have been listed in the metaclass’
          custom *note __dir__(): 310.

 -- Function: inspect.getmodulename (path)

     Return the name of the module named by the file `path', without
     including the names of enclosing packages.  The file extension is
     checked against all of the entries in *note
     importlib.machinery.all_suffixes(): 3605.  If it matches, the final
     path component is returned with the extension removed.  Otherwise,
     ‘None’ is returned.

     Note that this function `only' returns a meaningful name for actual
     Python modules - paths that potentially refer to Python packages
     will still return ‘None’.

     Changed in version 3.3: The function is based directly on *note
     importlib: 9b.

 -- Function: inspect.ismodule (object)

     Return ‘True’ if the object is a module.

 -- Function: inspect.isclass (object)

     Return ‘True’ if the object is a class, whether built-in or created
     in Python code.

 -- Function: inspect.ismethod (object)

     Return ‘True’ if the object is a bound method written in Python.

 -- Function: inspect.isfunction (object)

     Return ‘True’ if the object is a Python function, which includes
     functions created by a *note lambda: 360a. expression.

 -- Function: inspect.isgeneratorfunction (object)

     Return ‘True’ if the object is a Python generator function.

     Changed in version 3.8: Functions wrapped in *note
     functools.partial(): 7bc. now return ‘True’ if the wrapped function
     is a Python generator function.

 -- Function: inspect.isgenerator (object)

     Return ‘True’ if the object is a generator.

 -- Function: inspect.iscoroutinefunction (object)

     Return ‘True’ if the object is a *note coroutine function: 633. (a
     function defined with an *note async def: 282. syntax).

     New in version 3.5.

     Changed in version 3.8: Functions wrapped in *note
     functools.partial(): 7bc. now return ‘True’ if the wrapped function
     is a *note coroutine function: 633.

 -- Function: inspect.iscoroutine (object)

     Return ‘True’ if the object is a *note coroutine: 1a5. created by
     an *note async def: 282. function.

     New in version 3.5.

 -- Function: inspect.isawaitable (object)

     Return ‘True’ if the object can be used in *note await: 1a2.
     expression.

     Can also be used to distinguish generator-based coroutines from
     regular generators:

          def gen():     yield @types.coroutine def gen_coro():     yield  assert not isawaitable(gen()) assert isawaitable(gen_coro())

     New in version 3.5.

 -- Function: inspect.isasyncgenfunction (object)

     Return ‘True’ if the object is an *note asynchronous generator:
     1441. function, for example:

          >>> async def agen(): ...     yield 1 ... >>> inspect.isasyncgenfunction(agen) True

     New in version 3.6.

     Changed in version 3.8: Functions wrapped in *note
     functools.partial(): 7bc. now return ‘True’ if the wrapped function
     is a *note asynchronous generator: 1441. function.

 -- Function: inspect.isasyncgen (object)

     Return ‘True’ if the object is an *note asynchronous generator
     iterator: 356f. created by an *note asynchronous generator: 1441.
     function.

     New in version 3.6.

 -- Function: inspect.istraceback (object)

     Return ‘True’ if the object is a traceback.

 -- Function: inspect.isframe (object)

     Return ‘True’ if the object is a frame.

 -- Function: inspect.iscode (object)

     Return ‘True’ if the object is a code.

 -- Function: inspect.isbuiltin (object)

     Return ‘True’ if the object is a built-in function or a bound
     built-in method.

 -- Function: inspect.isroutine (object)

     Return ‘True’ if the object is a user-defined or built-in function
     or method.

 -- Function: inspect.isabstract (object)

     Return ‘True’ if the object is an abstract base class.

 -- Function: inspect.ismethoddescriptor (object)

     Return ‘True’ if the object is a method descriptor, but not if
     *note ismethod(): 3608, *note isclass(): 3607, *note isfunction():
     3609. or *note isbuiltin(): 3610. are true.

     This, for example, is true of ‘int.__add__’.  An object passing
     this test has a *note __get__(): 1377. method but not a *note
     __set__(): 137b. method, but beyond that the set of attributes
     varies.  A *note __name__: c5a. attribute is usually sensible, and
     ‘__doc__’ often is.

     Methods implemented via descriptors that also pass one of the other
     tests return ‘False’ from the *note ismethoddescriptor(): 3613.
     test, simply because the other tests promise more – you can, e.g.,
     count on having the ‘__func__’ attribute (etc) when an object
     passes *note ismethod(): 3608.

 -- Function: inspect.isdatadescriptor (object)

     Return ‘True’ if the object is a data descriptor.

     Data descriptors have a *note __set__: 137b. or a *note __delete__:
     137c. method.  Examples are properties (defined in Python),
     getsets, and members.  The latter two are defined in C and there
     are more specific tests available for those types, which is robust
     across Python implementations.  Typically, data descriptors will
     also have *note __name__: c5a. and ‘__doc__’ attributes
     (properties, getsets, and members have both of these attributes),
     but this is not guaranteed.

 -- Function: inspect.isgetsetdescriptor (object)

     Return ‘True’ if the object is a getset descriptor.

     `CPython implementation detail:' getsets are attributes defined in
     extension modules via *note PyGetSetDef: 41c. structures.  For
     Python implementations without such types, this method will always
     return ‘False’.

 -- Function: inspect.ismemberdescriptor (object)

     Return ‘True’ if the object is a member descriptor.

     `CPython implementation detail:' Member descriptors are attributes
     defined in extension modules via *note PyMemberDef: 41b.
     structures.  For Python implementations without such types, this
     method will always return ‘False’.


File: python.info,  Node: Retrieving source code,  Next: Introspecting callables with the Signature object,  Prev: Types and members,  Up: inspect — Inspect live objects

5.30.13.2 Retrieving source code
................................

 -- Function: inspect.getdoc (object)

     Get the documentation string for an object, cleaned up with *note
     cleandoc(): 3619.  If the documentation string for an object is not
     provided and the object is a class, a method, a property or a
     descriptor, retrieve the documentation string from the inheritance
     hierarchy.

     Changed in version 3.5: Documentation strings are now inherited if
     not overridden.

 -- Function: inspect.getcomments (object)

     Return in a single string any lines of comments immediately
     preceding the object’s source code (for a class, function, or
     method), or at the top of the Python source file (if the object is
     a module).  If the object’s source code is unavailable, return
     ‘None’.  This could happen if the object has been defined in C or
     the interactive shell.

 -- Function: inspect.getfile (object)

     Return the name of the (text or binary) file in which an object was
     defined.  This will fail with a *note TypeError: 192. if the object
     is a built-in module, class, or function.

 -- Function: inspect.getmodule (object)

     Try to guess which module an object was defined in.

 -- Function: inspect.getsourcefile (object)

     Return the name of the Python source file in which an object was
     defined.  This will fail with a *note TypeError: 192. if the object
     is a built-in module, class, or function.

 -- Function: inspect.getsourcelines (object)

     Return a list of source lines and starting line number for an
     object.  The argument may be a module, class, method, function,
     traceback, frame, or code object.  The source code is returned as a
     list of the lines corresponding to the object and the line number
     indicates where in the original source file the first line of code
     was found.  An *note OSError: 1d1. is raised if the source code
     cannot be retrieved.

     Changed in version 3.3: *note OSError: 1d1. is raised instead of
     *note IOError: 986, now an alias of the former.

 -- Function: inspect.getsource (object)

     Return the text of the source code for an object.  The argument may
     be a module, class, method, function, traceback, frame, or code
     object.  The source code is returned as a single string.  An *note
     OSError: 1d1. is raised if the source code cannot be retrieved.

     Changed in version 3.3: *note OSError: 1d1. is raised instead of
     *note IOError: 986, now an alias of the former.

 -- Function: inspect.cleandoc (doc)

     Clean up indentation from docstrings that are indented to line up
     with blocks of code.

     All leading whitespace is removed from the first line.  Any leading
     whitespace that can be uniformly removed from the second line
     onwards is removed.  Empty lines at the beginning and end are
     subsequently removed.  Also, all tabs are expanded to spaces.


File: python.info,  Node: Introspecting callables with the Signature object,  Next: Classes and functions<2>,  Prev: Retrieving source code,  Up: inspect — Inspect live objects

5.30.13.3 Introspecting callables with the Signature object
...........................................................

New in version 3.3.

The Signature object represents the call signature of a callable object
and its return annotation.  To retrieve a Signature object, use the
*note signature(): 550. function.

 -- Function: inspect.signature (callable, *, follow_wrapped=True)

     Return a *note Signature: 6e7. object for the given ‘callable’:

          >>> from inspect import signature >>> def foo(a, *, b:int, **kwargs): ...     pass  >>> sig = signature(foo)  >>> str(sig) '(a, *, b:int, **kwargs)'  >>> str(sig.parameters['b']) 'b:int'  >>> sig.parameters['b'].annotation <class 'int'>

     Accepts a wide range of Python callables, from plain functions and
     classes to *note functools.partial(): 7bc. objects.

     Raises *note ValueError: 1f9. if no signature can be provided, and
     *note TypeError: 192. if that type of object is not supported.

     A slash(/) in the signature of a function denotes that the
     parameters prior to it are positional-only.  For more info, see
     *note the FAQ entry on positional-only parameters: 152e.

     New in version 3.5: ‘follow_wrapped’ parameter.  Pass ‘False’ to
     get a signature of ‘callable’ specifically (‘callable.__wrapped__’
     will not be used to unwrap decorated callables.)

          Note: Some callables may not be introspectable in certain
          implementations of Python.  For example, in CPython, some
          built-in functions defined in C provide no metadata about
          their arguments.

 -- Class: inspect.Signature (parameters=None, *,
          return_annotation=Signature.empty)

     A Signature object represents the call signature of a function and
     its return annotation.  For each parameter accepted by the function
     it stores a *note Parameter: 6e8. object in its *note parameters:
     361f. collection.

     The optional `parameters' argument is a sequence of *note
     Parameter: 6e8. objects, which is validated to check that there are
     no parameters with duplicate names, and that the parameters are in
     the right order, i.e.  positional-only first, then
     positional-or-keyword, and that parameters with defaults follow
     parameters without defaults.

     The optional `return_annotation' argument, can be an arbitrary
     Python object, is the “return” annotation of the callable.

     Signature objects are `immutable'.  Use *note Signature.replace():
     3620. to make a modified copy.

     Changed in version 3.5: Signature objects are picklable and
     hashable.

      -- Attribute: empty

          A special class-level marker to specify absence of a return
          annotation.

      -- Attribute: parameters

          An ordered mapping of parameters’ names to the corresponding
          *note Parameter: 6e8. objects.  Parameters appear in strict
          definition order, including keyword-only parameters.

          Changed in version 3.7: Python only explicitly guaranteed that
          it preserved the declaration order of keyword-only parameters
          as of version 3.7, although in practice this order had always
          been preserved in Python 3.

      -- Attribute: return_annotation

          The “return” annotation for the callable.  If the callable has
          no “return” annotation, this attribute is set to *note
          Signature.empty: 3621.

      -- Method: bind (*args, **kwargs)

          Create a mapping from positional and keyword arguments to
          parameters.  Returns *note BoundArguments: 99c. if ‘*args’ and
          ‘**kwargs’ match the signature, or raises a *note TypeError:
          192.

      -- Method: bind_partial (*args, **kwargs)

          Works the same way as *note Signature.bind(): 3623, but allows
          the omission of some required arguments (mimics *note
          functools.partial(): 7bc. behavior.)  Returns *note
          BoundArguments: 99c, or raises a *note TypeError: 192. if the
          passed arguments do not match the signature.

      -- Method: replace (*[, parameters][, return_annotation])

          Create a new Signature instance based on the instance replace
          was invoked on.  It is possible to pass different ‘parameters’
          and/or ‘return_annotation’ to override the corresponding
          properties of the base signature.  To remove return_annotation
          from the copied Signature, pass in *note Signature.empty:
          3621.

               >>> def test(a, b): ...     pass >>> sig = signature(test) >>> new_sig = sig.replace(return_annotation="new return anno") >>> str(new_sig) "(a, b) -> 'new return anno'"

      -- Class Method: from_callable (obj, *, follow_wrapped=True)

          Return a *note Signature: 6e7. (or its subclass) object for a
          given callable ‘obj’.  Pass ‘follow_wrapped=False’ to get a
          signature of ‘obj’ without unwrapping its ‘__wrapped__’ chain.

          This method simplifies subclassing of *note Signature: 6e7.:

               class MySignature(Signature):     pass sig = MySignature.from_callable(min) assert isinstance(sig, MySignature)

          New in version 3.5.

 -- Class: inspect.Parameter (name, kind, *, default=Parameter.empty,
          annotation=Parameter.empty)

     Parameter objects are `immutable'.  Instead of modifying a
     Parameter object, you can use *note Parameter.replace(): 3625. to
     create a modified copy.

     Changed in version 3.5: Parameter objects are picklable and
     hashable.

      -- Attribute: empty

          A special class-level marker to specify absence of default
          values and annotations.

      -- Attribute: name

          The name of the parameter as a string.  The name must be a
          valid Python identifier.

          `CPython implementation detail:' CPython generates implicit
          parameter names of the form ‘.0’ on the code objects used to
          implement comprehensions and generator expressions.

          Changed in version 3.6: These parameter names are exposed by
          this module as names like ‘implicit0’.

      -- Attribute: default

          The default value for the parameter.  If the parameter has no
          default value, this attribute is set to *note Parameter.empty:
          3626.

      -- Attribute: annotation

          The annotation for the parameter.  If the parameter has no
          annotation, this attribute is set to *note Parameter.empty:
          3626.

      -- Attribute: kind

          Describes how argument values are bound to the parameter.
          Possible values (accessible via *note Parameter: 6e8, like
          ‘Parameter.KEYWORD_ONLY’):

          Name                         Meaning
                                       
          --------------------------------------------------------------------------------
                                       
          `POSITIONAL_ONLY'            Value must be supplied as a positional argument.
                                       Positional only parameters are those which
                                       appear before a ‘/’ entry (if present) in a
                                       Python function definition.
                                       
                                       
          `POSITIONAL_OR_KEYWORD'      Value may be supplied as either a keyword or
                                       positional argument (this is the standard
                                       binding behaviour for functions implemented in
                                       Python.)
                                       
                                       
          `VAR_POSITIONAL'             A tuple of positional arguments that aren’t
                                       bound to any other parameter.  This corresponds
                                       to a ‘*args’ parameter in a Python function
                                       definition.
                                       
                                       
          `KEYWORD_ONLY'               Value must be supplied as a keyword argument.
                                       Keyword only parameters are those which appear
                                       after a ‘*’ or ‘*args’ entry in a Python
                                       function definition.
                                       
                                       
          `VAR_KEYWORD'                A dict of keyword arguments that aren’t bound to
                                       any other parameter.  This corresponds to a
                                       ‘**kwargs’ parameter in a Python function
                                       definition.
                                       

          Example: print all keyword-only arguments without default
          values:

               >>> def foo(a, b, *, c, d=10): ...     pass  >>> sig = signature(foo) >>> for param in sig.parameters.values(): ...     if (param.kind == param.KEYWORD_ONLY and ...                        param.default is param.empty): ...         print('Parameter:', param) Parameter: c

      -- Attribute: kind.description

          Describes a enum value of Parameter.kind.

          New in version 3.8.

          Example: print all descriptions of arguments:

               >>> def foo(a, b, *, c, d=10): ...     pass  >>> sig = signature(foo) >>> for param in sig.parameters.values(): ...     print(param.kind.description) positional or keyword positional or keyword keyword-only keyword-only

      -- Method: replace (*[, name][, kind][, default][, annotation])

               Create a new Parameter instance based on the instance
               replaced was invoked on.  To override a *note Parameter:
               6e8. attribute, pass the corresponding argument.  To
               remove a default value or/and an annotation from a
               Parameter, pass *note Parameter.empty: 3626.

                    >>> from inspect import Parameter >>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42) >>> str(param) 'foo=42'  >>> str(param.replace()) # Will create a shallow copy of 'param' 'foo=42'  >>> str(param.replace(default=Parameter.empty, annotation='spam')) "foo:'spam'"

          Changed in version 3.4: In Python 3.3 Parameter objects were
          allowed to have ‘name’ set to ‘None’ if their ‘kind’ was set
          to ‘POSITIONAL_ONLY’.  This is no longer permitted.

 -- Class: inspect.BoundArguments

     Result of a *note Signature.bind(): 3623. or *note
     Signature.bind_partial(): 3624. call.  Holds the mapping of
     arguments to the function’s parameters.

      -- Attribute: arguments

          An ordered, mutable mapping (*note collections.OrderedDict:
          1b7.) of parameters’ names to arguments’ values.  Contains
          only explicitly bound arguments.  Changes in *note arguments:
          362c. will reflect in *note args: 362d. and *note kwargs:
          362e.

          Should be used in conjunction with *note Signature.parameters:
          361f. for any argument processing purposes.

               Note: Arguments for which *note Signature.bind(): 3623.
               or *note Signature.bind_partial(): 3624. relied on a
               default value are skipped.  However, if needed, use *note
               BoundArguments.apply_defaults(): 6e9. to add them.

      -- Attribute: args

          A tuple of positional arguments values.  Dynamically computed
          from the *note arguments: 362c. attribute.

      -- Attribute: kwargs

          A dict of keyword arguments values.  Dynamically computed from
          the *note arguments: 362c. attribute.

      -- Attribute: signature

          A reference to the parent *note Signature: 6e7. object.

      -- Method: apply_defaults ()

          Set default values for missing arguments.

          For variable-positional arguments (‘*args’) the default is an
          empty tuple.

          For variable-keyword arguments (‘**kwargs’) the default is an
          empty dict.

               >>> def foo(a, b='ham', *args): pass >>> ba = inspect.signature(foo).bind('spam') >>> ba.apply_defaults() >>> ba.arguments OrderedDict([('a', 'spam'), ('b', 'ham'), ('args', ())])

          New in version 3.5.

     The *note args: 362d. and *note kwargs: 362e. properties can be
     used to invoke functions:

          def test(a, *, b):     ...  sig = signature(test) ba = sig.bind(10, b=20) test(*ba.args, **ba.kwargs)

See also
........

PEP 362(1) - Function Signature Object.

     The detailed specification, implementation details and examples.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0362


File: python.info,  Node: Classes and functions<2>,  Next: The interpreter stack,  Prev: Introspecting callables with the Signature object,  Up: inspect — Inspect live objects

5.30.13.4 Classes and functions
...............................

 -- Function: inspect.getclasstree (classes, unique=False)

     Arrange the given list of classes into a hierarchy of nested lists.
     Where a nested list appears, it contains classes derived from the
     class whose entry immediately precedes the list.  Each entry is a
     2-tuple containing a class and a tuple of its base classes.  If the
     `unique' argument is true, exactly one entry appears in the
     returned structure for each class in the given list.  Otherwise,
     classes using multiple inheritance and their descendants will
     appear multiple times.

 -- Function: inspect.getargspec (func)

     Get the names and default values of a Python function’s parameters.
     A *note named tuple: a98. ‘ArgSpec(args, varargs, keywords,
     defaults)’ is returned.  `args' is a list of the parameter names.
     `varargs' and `keywords' are the names of the ‘*’ and ‘**’
     parameters or ‘None’.  `defaults' is a tuple of default argument
     values or ‘None’ if there are no default arguments; if this tuple
     has `n' elements, they correspond to the last `n' elements listed
     in `args'.

     Deprecated since version 3.0: Use *note getfullargspec(): 552. for
     an updated API that is usually a drop-in replacement, but also
     correctly handles function annotations and keyword-only parameters.

     Alternatively, use *note signature(): 550. and *note Signature
     Object: 361d, which provide a more structured introspection API for
     callables.

 -- Function: inspect.getfullargspec (func)

     Get the names and default values of a Python function’s parameters.
     A *note named tuple: a98. is returned:

     ‘FullArgSpec(args, varargs, varkw, defaults, kwonlyargs,
     kwonlydefaults, annotations)’

     `args' is a list of the positional parameter names.  `varargs' is
     the name of the ‘*’ parameter or ‘None’ if arbitrary positional
     arguments are not accepted.  `varkw' is the name of the ‘**’
     parameter or ‘None’ if arbitrary keyword arguments are not
     accepted.  `defaults' is an `n'-tuple of default argument values
     corresponding to the last `n' positional parameters, or ‘None’ if
     there are no such defaults defined.  `kwonlyargs' is a list of
     keyword-only parameter names in declaration order.
     `kwonlydefaults' is a dictionary mapping parameter names from
     `kwonlyargs' to the default values used if no argument is supplied.
     `annotations' is a dictionary mapping parameter names to
     annotations.  The special key ‘"return"’ is used to report the
     function return value annotation (if any).

     Note that *note signature(): 550. and *note Signature Object: 361d.
     provide the recommended API for callable introspection, and support
     additional behaviours (like positional-only arguments) that are
     sometimes encountered in extension module APIs.  This function is
     retained primarily for use in code that needs to maintain
     compatibility with the Python 2 ‘inspect’ module API.

     Changed in version 3.4: This function is now based on *note
     signature(): 550, but still ignores ‘__wrapped__’ attributes and
     includes the already bound first parameter in the signature output
     for bound methods.

     Changed in version 3.6: This method was previously documented as
     deprecated in favour of *note signature(): 550. in Python 3.5, but
     that decision has been reversed in order to restore a clearly
     supported standard interface for single-source Python 2/3 code
     migrating away from the legacy *note getargspec(): 551. API.

     Changed in version 3.7: Python only explicitly guaranteed that it
     preserved the declaration order of keyword-only parameters as of
     version 3.7, although in practice this order had always been
     preserved in Python 3.

 -- Function: inspect.getargvalues (frame)

     Get information about arguments passed into a particular frame.  A
     *note named tuple: a98. ‘ArgInfo(args, varargs, keywords, locals)’
     is returned.  `args' is a list of the argument names.  `varargs'
     and `keywords' are the names of the ‘*’ and ‘**’ arguments or
     ‘None’.  `locals' is the locals dictionary of the given frame.

          Note: This function was inadvertently marked as deprecated in
          Python 3.5.

 -- Function: inspect.formatargspec (args[, varargs, varkw, defaults,
          kwonlyargs, kwonlydefaults, annotations[, formatarg,
          formatvarargs, formatvarkw, formatvalue, formatreturns,
          formatannotations]])

     Format a pretty argument spec from the values returned by *note
     getfullargspec(): 552.

     The first seven arguments are (‘args’, ‘varargs’, ‘varkw’,
     ‘defaults’, ‘kwonlyargs’, ‘kwonlydefaults’, ‘annotations’).

     The other six arguments are functions that are called to turn
     argument names, ‘*’ argument name, ‘**’ argument name, default
     values, return annotation and individual annotations into strings,
     respectively.

     For example:

          >>> from inspect import formatargspec, getfullargspec >>> def f(a: int, b: float): ...     pass ... >>> formatargspec(*getfullargspec(f)) '(a: int, b: float)'

     Deprecated since version 3.5: Use *note signature(): 550. and *note
     Signature Object: 361d, which provide a better introspecting API
     for callables.

 -- Function: inspect.formatargvalues (args[, varargs, varkw, locals,
          formatarg, formatvarargs, formatvarkw, formatvalue])

     Format a pretty argument spec from the four values returned by
     *note getargvalues(): 7ac.  The format* arguments are the
     corresponding optional formatting functions that are called to turn
     names and values into strings.

          Note: This function was inadvertently marked as deprecated in
          Python 3.5.

 -- Function: inspect.getmro (cls)

     Return a tuple of class cls’s base classes, including cls, in
     method resolution order.  No class appears more than once in this
     tuple.  Note that the method resolution order depends on cls’s
     type.  Unless a very peculiar user-defined metatype is in use, cls
     will be the first element of the tuple.

 -- Function: inspect.getcallargs (func, /, *args, **kwds)

     Bind the `args' and `kwds' to the argument names of the Python
     function or method `func', as if it was called with them.  For
     bound methods, bind also the first argument (typically named
     ‘self’) to the associated instance.  A dict is returned, mapping
     the argument names (including the names of the ‘*’ and ‘**’
     arguments, if any) to their values from `args' and `kwds'.  In case
     of invoking `func' incorrectly, i.e.  whenever ‘func(*args,
     **kwds)’ would raise an exception because of incompatible
     signature, an exception of the same type and the same or similar
     message is raised.  For example:

          >>> from inspect import getcallargs >>> def f(a, b=1, *pos, **named): ...     pass >>> getcallargs(f, 1, 2, 3) == {'a': 1, 'named': {}, 'b': 2, 'pos': (3,)} True >>> getcallargs(f, a=2, x=4) == {'a': 2, 'named': {'x': 4}, 'b': 1, 'pos': ()} True >>> getcallargs(f) Traceback (most recent call last): ... TypeError: f() missing 1 required positional argument: 'a'

     New in version 3.2.

     Deprecated since version 3.5: Use *note Signature.bind(): 3623. and
     *note Signature.bind_partial(): 3624. instead.

 -- Function: inspect.getclosurevars (func)

     Get the mapping of external name references in a Python function or
     method `func' to their current values.  A *note named tuple: a98.
     ‘ClosureVars(nonlocals, globals, builtins, unbound)’ is returned.
     `nonlocals' maps referenced names to lexical closure variables,
     `globals' to the function’s module globals and `builtins' to the
     builtins visible from the function body.  `unbound' is the set of
     names referenced in the function that could not be resolved at all
     given the current module globals and builtins.

     *note TypeError: 192. is raised if `func' is not a Python function
     or method.

     New in version 3.3.

 -- Function: inspect.unwrap (func, *, stop=None)

     Get the object wrapped by `func'.  It follows the chain of
     ‘__wrapped__’ attributes returning the last object in the chain.

     `stop' is an optional callback accepting an object in the wrapper
     chain as its sole argument that allows the unwrapping to be
     terminated early if the callback returns a true value.  If the
     callback never returns a true value, the last object in the chain
     is returned as usual.  For example, *note signature(): 550. uses
     this to stop unwrapping if any object in the chain has a
     ‘__signature__’ attribute defined.

     *note ValueError: 1f9. is raised if a cycle is encountered.

     New in version 3.4.


File: python.info,  Node: The interpreter stack,  Next: Fetching attributes statically,  Prev: Classes and functions<2>,  Up: inspect — Inspect live objects

5.30.13.5 The interpreter stack
...............................

When the following functions return “frame records,” each record is a
*note named tuple: a98. ‘FrameInfo(frame, filename, lineno, function,
code_context, index)’.  The tuple contains the frame object, the
filename, the line number of the current line, the function name, a list
of lines of context from the source code, and the index of the current
line within that list.

Changed in version 3.5: Return a named tuple instead of a tuple.

     Note: Keeping references to frame objects, as found in the first
     element of the frame records these functions return, can cause your
     program to create reference cycles.  Once a reference cycle has
     been created, the lifespan of all objects which can be accessed
     from the objects which form the cycle can become much longer even
     if Python’s optional cycle detector is enabled.  If such cycles
     must be created, it is important to ensure they are explicitly
     broken to avoid the delayed destruction of objects and increased
     memory consumption which occurs.

     Though the cycle detector will catch these, destruction of the
     frames (and local variables) can be made deterministic by removing
     the cycle in a *note finally: 182. clause.  This is also important
     if the cycle detector was disabled when Python was compiled or
     using *note gc.disable(): 35f2.  For example:

          def handle_stackframe_without_leak():     frame = inspect.currentframe()     try:         # do something with the frame     finally:         del frame

     If you want to keep the frame around (for example to print a
     traceback later), you can also break reference cycles by using the
     *note frame.clear(): 7ff. method.

The optional `context' argument supported by most of these functions
specifies the number of lines of context to return, which are centered
around the current line.

 -- Function: inspect.getframeinfo (frame, context=1)

     Get information about a frame or traceback object.  A *note named
     tuple: a98. ‘Traceback(filename, lineno, function, code_context,
     index)’ is returned.

 -- Function: inspect.getouterframes (frame, context=1)

     Get a list of frame records for a frame and all outer frames.
     These frames represent the calls that lead to the creation of
     `frame'.  The first entry in the returned list represents `frame';
     the last entry represents the outermost call on `frame'’s stack.

     Changed in version 3.5: A list of *note named tuples: a98.
     ‘FrameInfo(frame, filename, lineno, function, code_context, index)’
     is returned.

 -- Function: inspect.getinnerframes (traceback, context=1)

     Get a list of frame records for a traceback’s frame and all inner
     frames.  These frames represent calls made as a consequence of
     `frame'.  The first entry in the list represents `traceback'; the
     last entry represents where the exception was raised.

     Changed in version 3.5: A list of *note named tuples: a98.
     ‘FrameInfo(frame, filename, lineno, function, code_context, index)’
     is returned.

 -- Function: inspect.currentframe ()

     Return the frame object for the caller’s stack frame.

     `CPython implementation detail:' This function relies on Python
     stack frame support in the interpreter, which isn’t guaranteed to
     exist in all implementations of Python.  If running in an
     implementation without Python stack frame support this function
     returns ‘None’.

 -- Function: inspect.stack (context=1)

     Return a list of frame records for the caller’s stack.  The first
     entry in the returned list represents the caller; the last entry
     represents the outermost call on the stack.

     Changed in version 3.5: A list of *note named tuples: a98.
     ‘FrameInfo(frame, filename, lineno, function, code_context, index)’
     is returned.

 -- Function: inspect.trace (context=1)

     Return a list of frame records for the stack between the current
     frame and the frame in which an exception currently being handled
     was raised in.  The first entry in the list represents the caller;
     the last entry represents where the exception was raised.

     Changed in version 3.5: A list of *note named tuples: a98.
     ‘FrameInfo(frame, filename, lineno, function, code_context, index)’
     is returned.


File: python.info,  Node: Fetching attributes statically,  Next: Current State of Generators and Coroutines,  Prev: The interpreter stack,  Up: inspect — Inspect live objects

5.30.13.6 Fetching attributes statically
........................................

Both *note getattr(): 43d. and *note hasattr(): 43c. can trigger code
execution when fetching or checking for the existence of attributes.
Descriptors, like properties, will be invoked and *note __getattr__():
30f. and *note __getattribute__(): 43e. may be called.

For cases where you want passive introspection, like documentation
tools, this can be inconvenient.  *note getattr_static(): bbe. has the
same signature as *note getattr(): 43d. but avoids executing code when
it fetches attributes.

 -- Function: inspect.getattr_static (obj, attr, default=None)

     Retrieve attributes without triggering dynamic lookup via the
     descriptor protocol, *note __getattr__(): 30f. or *note
     __getattribute__(): 43e.

     Note: this function may not be able to retrieve all attributes that
     getattr can fetch (like dynamically created attributes) and may
     find attributes that getattr can’t (like descriptors that raise
     AttributeError).  It can also return descriptors objects instead of
     instance members.

     If the instance *note __dict__: 4f1. is shadowed by another member
     (for example a property) then this function will be unable to find
     instance members.

     New in version 3.2.

*note getattr_static(): bbe. does not resolve descriptors, for example
slot descriptors or getset descriptors on objects implemented in C. The
descriptor object is returned instead of the underlying attribute.

You can handle these with code like the following.  Note that for
arbitrary getset descriptors invoking these may trigger code execution:

     # example code for resolving the builtin descriptor types class _foo:     __slots__ = ['foo']  slot_descriptor = type(_foo.foo) getset_descriptor = type(type(open(__file__)).name) wrapper_descriptor = type(str.__dict__['__add__']) descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)  result = getattr_static(some_object, 'foo') if type(result) in descriptor_types:     try:         result = result.__get__()     except AttributeError:         # descriptors can raise AttributeError to         # indicate there is no underlying value         # in which case the descriptor itself will         # have to do         pass


File: python.info,  Node: Current State of Generators and Coroutines,  Next: Code Objects Bit Flags,  Prev: Fetching attributes statically,  Up: inspect — Inspect live objects

5.30.13.7 Current State of Generators and Coroutines
....................................................

When implementing coroutine schedulers and for other advanced uses of
generators, it is useful to determine whether a generator is currently
executing, is waiting to start or resume or execution, or has already
terminated.  *note getgeneratorstate(): bbd. allows the current state of
a generator to be determined easily.

 -- Function: inspect.getgeneratorstate (generator)

     Get current state of a generator-iterator.

     Possible states are:

             * GEN_CREATED: Waiting to start execution.

             * GEN_RUNNING: Currently being executed by the interpreter.

             * GEN_SUSPENDED: Currently suspended at a yield expression.

             * GEN_CLOSED: Execution has completed.

     New in version 3.2.

 -- Function: inspect.getcoroutinestate (coroutine)

     Get current state of a coroutine object.  The function is intended
     to be used with coroutine objects created by *note async def: 282.
     functions, but will accept any coroutine-like object that has
     ‘cr_running’ and ‘cr_frame’ attributes.

     Possible states are:

             * CORO_CREATED: Waiting to start execution.

             * CORO_RUNNING: Currently being executed by the
               interpreter.

             * CORO_SUSPENDED: Currently suspended at an await
               expression.

             * CORO_CLOSED: Execution has completed.

     New in version 3.5.

The current internal state of the generator can also be queried.  This
is mostly useful for testing purposes, to ensure that internal state is
being updated as expected:

 -- Function: inspect.getgeneratorlocals (generator)

     Get the mapping of live local variables in `generator' to their
     current values.  A dictionary is returned that maps from variable
     names to values.  This is the equivalent of calling *note locals():
     44a. in the body of the generator, and all the same caveats apply.

     If `generator' is a *note generator: 996. with no currently
     associated frame, then an empty dictionary is returned.  *note
     TypeError: 192. is raised if `generator' is not a Python generator
     object.

     `CPython implementation detail:' This function relies on the
     generator exposing a Python stack frame for introspection, which
     isn’t guaranteed to be the case in all implementations of Python.
     In such cases, this function will always return an empty
     dictionary.

     New in version 3.3.

 -- Function: inspect.getcoroutinelocals (coroutine)

     This function is analogous to *note getgeneratorlocals(): a0f, but
     works for coroutine objects created by *note async def: 282.
     functions.

     New in version 3.5.


File: python.info,  Node: Code Objects Bit Flags,  Next: Command Line Interface<3>,  Prev: Current State of Generators and Coroutines,  Up: inspect — Inspect live objects

5.30.13.8 Code Objects Bit Flags
................................

Python code objects have a ‘co_flags’ attribute, which is a bitmap of
the following flags:

 -- Data: inspect.CO_OPTIMIZED

     The code object is optimized, using fast locals.

 -- Data: inspect.CO_NEWLOCALS

     If set, a new dict will be created for the frame’s ‘f_locals’ when
     the code object is executed.

 -- Data: inspect.CO_VARARGS

     The code object has a variable positional parameter (‘*args’-like).

 -- Data: inspect.CO_VARKEYWORDS

     The code object has a variable keyword parameter (‘**kwargs’-like).

 -- Data: inspect.CO_NESTED

     The flag is set when the code object is a nested function.

 -- Data: inspect.CO_GENERATOR

     The flag is set when the code object is a generator function, i.e.
     a generator object is returned when the code object is executed.

 -- Data: inspect.CO_NOFREE

     The flag is set if there are no free or cell variables.

 -- Data: inspect.CO_COROUTINE

     The flag is set when the code object is a coroutine function.  When
     the code object is executed it returns a coroutine object.  See PEP
     492(1) for more details.

     New in version 3.5.

 -- Data: inspect.CO_ITERABLE_COROUTINE

     The flag is used to transform generators into generator-based
     coroutines.  Generator objects with this flag can be used in
     ‘await’ expression, and can ‘yield from’ coroutine objects.  See
     PEP 492(2) for more details.

     New in version 3.5.

 -- Data: inspect.CO_ASYNC_GENERATOR

     The flag is set when the code object is an asynchronous generator
     function.  When the code object is executed it returns an
     asynchronous generator object.  See PEP 525(3) for more details.

     New in version 3.6.

     Note: The flags are specific to CPython, and may not be defined in
     other Python implementations.  Furthermore, the flags are an
     implementation detail, and can be removed or deprecated in future
     Python releases.  It’s recommended to use public APIs from the
     *note inspect: a0. module for any introspection needs.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0492

   (2) https://www.python.org/dev/peps/pep-0492

   (3) https://www.python.org/dev/peps/pep-0525


File: python.info,  Node: Command Line Interface<3>,  Prev: Code Objects Bit Flags,  Up: inspect — Inspect live objects

5.30.13.9 Command Line Interface
................................

The *note inspect: a0. module also provides a basic introspection
capability from the command line.

By default, accepts the name of a module and prints the source of that
module.  A class or function within the module can be printed instead by
appended a colon and the qualified name of the target object.

 -- Program Option: --details

     Print information about the specified object rather than the source
     code


File: python.info,  Node: site — Site-specific configuration hook,  Prev: inspect — Inspect live objects,  Up: Python Runtime Services

5.30.14 ‘site’ — Site-specific configuration hook
-------------------------------------------------

`Source code:' Lib/site.py(1)

__________________________________________________________________

`This module is automatically imported during initialization.'  The
automatic import can be suppressed using the interpreter’s *note -S:
b17. option.

Importing this module will append site-specific paths to the module
search path and add a few builtins, unless *note -S: b17. was used.  In
that case, this module can be safely imported with no automatic
modifications to the module search path or additions to the builtins.
To explicitly trigger the usual site-specific additions, call the *note
site.main(): 1282. function.

Changed in version 3.3: Importing the module used to trigger paths
manipulation even when using *note -S: b17.

It starts by constructing up to four directories from a head and a tail
part.  For the head part, it uses ‘sys.prefix’ and ‘sys.exec_prefix’;
empty heads are skipped.  For the tail part, it uses the empty string
and then ‘lib/site-packages’ (on Windows) or
‘lib/python`X.Y'/site-packages’ (on Unix and Macintosh).  For each of
the distinct head-tail combinations, it sees if it refers to an existing
directory, and if so, adds it to ‘sys.path’ and also inspects the newly
added path for configuration files.

Changed in version 3.5: Support for the “site-python” directory has been
removed.

If a file named “pyvenv.cfg” exists one directory above sys.executable,
sys.prefix and sys.exec_prefix are set to that directory and it is also
checked for site-packages (sys.base_prefix and sys.base_exec_prefix will
always be the “real” prefixes of the Python installation).  If
“pyvenv.cfg” (a bootstrap configuration file) contains the key
“include-system-site-packages” set to anything other than “true”
(case-insensitive), the system-level prefixes will not be searched for
site-packages; otherwise they will.

A path configuration file is a file whose name has the form ‘`name'.pth’
and exists in one of the four directories mentioned above; its contents
are additional items (one per line) to be added to ‘sys.path’.
Non-existing items are never added to ‘sys.path’, and no check is made
that the item refers to a directory rather than a file.  No item is
added to ‘sys.path’ more than once.  Blank lines and lines beginning
with ‘#’ are skipped.  Lines starting with ‘import’ (followed by space
or tab) are executed.

     Note: An executable line in a ‘.pth’ file is run at every Python
     startup, regardless of whether a particular module is actually
     going to be used.  Its impact should thus be kept to a minimum.
     The primary intended purpose of executable lines is to make the
     corresponding module(s) importable (load 3rd-party import hooks,
     adjust ‘PATH’ etc).  Any other initialization is supposed to be
     done upon a module’s actual import, if and when it happens.
     Limiting a code chunk to a single line is a deliberate measure to
     discourage putting anything more complex here.

For example, suppose ‘sys.prefix’ and ‘sys.exec_prefix’ are set to
‘/usr/local’.  The Python X.Y library is then installed in
‘/usr/local/lib/python`X.Y'’.  Suppose this has a subdirectory
‘/usr/local/lib/python`X.Y'/site-packages’ with three subsubdirectories,
‘foo’, ‘bar’ and ‘spam’, and two path configuration files, ‘foo.pth’ and
‘bar.pth’.  Assume ‘foo.pth’ contains the following:

     # foo package configuration  foo bar bletch

and ‘bar.pth’ contains:

     # bar package configuration  bar

Then the following version-specific directories are added to ‘sys.path’,
in this order:

     /usr/local/lib/pythonX.Y/site-packages/bar /usr/local/lib/pythonX.Y/site-packages/foo

Note that ‘bletch’ is omitted because it doesn’t exist; the ‘bar’
directory precedes the ‘foo’ directory because ‘bar.pth’ comes
alphabetically before ‘foo.pth’; and ‘spam’ is omitted because it is not
mentioned in either path configuration file.

After these path manipulations, an attempt is made to import a module
named ‘sitecustomize’, which can perform arbitrary site-specific
customizations.  It is typically created by a system administrator in
the site-packages directory.  If this import fails with an *note
ImportError: 329. or its subclass exception, and the exception’s ‘name’
attribute equals to ‘'sitecustomize'’, it is silently ignored.  If
Python is started without output streams available, as with
‘pythonw.exe’ on Windows (which is used by default to start IDLE),
attempted output from ‘sitecustomize’ is ignored.  Any other exception
causes a silent and perhaps mysterious failure of the process.

After this, an attempt is made to import a module named ‘usercustomize’,
which can perform arbitrary user-specific customizations, if *note
ENABLE_USER_SITE: 3649. is true.  This file is intended to be created in
the user site-packages directory (see below), which is part of
‘sys.path’ unless disabled by *note -s: d08.  If this import fails with
an *note ImportError: 329. or its subclass exception, and the
exception’s ‘name’ attribute equals to ‘'usercustomize'’, it is silently
ignored.

Note that for some non-Unix systems, ‘sys.prefix’ and ‘sys.exec_prefix’
are empty, and the path manipulations are skipped; however the import of
‘sitecustomize’ and ‘usercustomize’ is still attempted.

* Menu:

* Readline configuration::
* Module contents: Module contents<3>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/site.py


File: python.info,  Node: Readline configuration,  Next: Module contents<3>,  Up: site — Site-specific configuration hook

5.30.14.1 Readline configuration
................................

On systems that support *note readline: de, this module will also import
and configure the *note rlcompleter: e1. module, if Python is started in
*note interactive mode: 8d7. and without the *note -S: b17. option.  The
default behavior is enable tab-completion and to use ‘~/.python_history’
as the history save file.  To disable it, delete (or override) the *note
sys.__interactivehook__: 8d8. attribute in your ‘sitecustomize’ or
‘usercustomize’ module or your *note PYTHONSTARTUP: 8d9. file.

Changed in version 3.4: Activation of rlcompleter and history was made
automatic.


File: python.info,  Node: Module contents<3>,  Prev: Readline configuration,  Up: site — Site-specific configuration hook

5.30.14.2 Module contents
.........................

 -- Data: site.PREFIXES

     A list of prefixes for site-packages directories.

 -- Data: site.ENABLE_USER_SITE

     Flag showing the status of the user site-packages directory.
     ‘True’ means that it is enabled and was added to ‘sys.path’.
     ‘False’ means that it was disabled by user request (with *note -s:
     d08. or *note PYTHONNOUSERSITE: d09.).  ‘None’ means it was
     disabled for security reasons (mismatch between user or group id
     and effective id) or by an administrator.

 -- Data: site.USER_SITE

     Path to the user site-packages for the running Python.  Can be
     ‘None’ if *note getusersitepackages(): bc8. hasn’t been called yet.
     Default value is ‘~/.local/lib/python`X.Y'/site-packages’ for UNIX
     and non-framework Mac OS X builds,
     ‘~/Library/Python/`X.Y'/lib/python/site-packages’ for Mac framework
     builds, and ‘`%APPDATA%'\Python\Python`XY'\site-packages’ on
     Windows.  This directory is a site directory, which means that
     ‘.pth’ files in it will be processed.

 -- Data: site.USER_BASE

     Path to the base directory for the user site-packages.  Can be
     ‘None’ if *note getuserbase(): bc7. hasn’t been called yet.
     Default value is ‘~/.local’ for UNIX and Mac OS X non-framework
     builds, ‘~/Library/Python/`X.Y'’ for Mac framework builds, and
     ‘`%APPDATA%'\Python’ for Windows.  This value is used by Distutils
     to compute the installation directories for scripts, data files,
     Python modules, etc.  for the *note user installation scheme: 1294.
     See also *note PYTHONUSERBASE: d07.

 -- Function: site.main ()

     Adds all the standard site-specific directories to the module
     search path.  This function is called automatically when this
     module is imported, unless the Python interpreter was started with
     the *note -S: b17. flag.

     Changed in version 3.3: This function used to be called
     unconditionally.

 -- Function: site.addsitedir (sitedir, known_paths=None)

     Add a directory to sys.path and process its ‘.pth’ files.
     Typically used in ‘sitecustomize’ or ‘usercustomize’ (see above).

 -- Function: site.getsitepackages ()

     Return a list containing all global site-packages directories.

     New in version 3.2.

 -- Function: site.getuserbase ()

     Return the path of the user base directory, *note USER_BASE: 1293.
     If it is not initialized yet, this function will also set it,
     respecting *note PYTHONUSERBASE: d07.

     New in version 3.2.

 -- Function: site.getusersitepackages ()

     Return the path of the user-specific site-packages directory, *note
     USER_SITE: 1281.  If it is not initialized yet, this function will
     also set it, respecting *note PYTHONNOUSERSITE: d09. and *note
     USER_BASE: 1293.

     New in version 3.2.

The *note site: eb. module also provides a way to get the user
directories from the command line:

     $ python3 -m site --user-site /home/user/.local/lib/python3.3/site-packages

If it is called without arguments, it will print the contents of *note
sys.path: 47d. on the standard output, followed by the value of *note
USER_BASE: 1293. and whether the directory exists, then the same thing
for *note USER_SITE: 1281, and finally the value of *note
ENABLE_USER_SITE: 3649.

 -- Program Option: --user-base

     Print the path to the user base directory.

 -- Program Option: --user-site

     Print the path to the user site-packages directory.

If both options are given, user base and user site will be printed
(always in this order), separated by *note os.pathsep: 1290.

If any option is given, the script will exit with one of these values:
‘0’ if the user site-packages directory is enabled, ‘1’ if it was
disabled by the user, ‘2’ if it is disabled for security reasons or by
an administrator, and a value greater than 2 if there is an error.

See also
........

PEP 370(1) – Per user site-packages directory

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0370


File: python.info,  Node: Custom Python Interpreters,  Next: Importing Modules,  Prev: Python Runtime Services,  Up: The Python Standard Library

5.31 Custom Python Interpreters
===============================

The modules described in this chapter allow writing interfaces similar
to Python’s interactive interpreter.  If you want a Python interpreter
that supports some special feature in addition to the Python language,
you should look at the *note code: 1b. module.  (The *note codeop: 1d.
module is lower-level, used to support compiling a possibly-incomplete
chunk of Python code.)

The full list of modules described in this chapter is:

* Menu:

* code — Interpreter base classes::
* codeop — Compile Python code::


File: python.info,  Node: code — Interpreter base classes,  Next: codeop — Compile Python code,  Up: Custom Python Interpreters

5.31.1 ‘code’ — Interpreter base classes
----------------------------------------

`Source code:' Lib/code.py(1)

__________________________________________________________________

The ‘code’ module provides facilities to implement read-eval-print loops
in Python.  Two classes and convenience functions are included which can
be used to build applications which provide an interactive interpreter
prompt.

 -- Class: code.InteractiveInterpreter (locals=None)

     This class deals with parsing and interpreter state (the user’s
     namespace); it does not deal with input buffering or prompting or
     input file naming (the filename is always passed in explicitly).
     The optional `locals' argument specifies the dictionary in which
     code will be executed; it defaults to a newly created dictionary
     with key ‘'__name__'’ set to ‘'__console__'’ and key ‘'__doc__'’
     set to ‘None’.

 -- Class: code.InteractiveConsole (locals=None, filename="<console>")

     Closely emulate the behavior of the interactive Python interpreter.
     This class builds on *note InteractiveInterpreter: 3655. and adds
     prompting using the familiar ‘sys.ps1’ and ‘sys.ps2’, and input
     buffering.

 -- Function: code.interact (banner=None, readfunc=None, local=None,
          exitmsg=None)

     Convenience function to run a read-eval-print loop.  This creates a
     new instance of *note InteractiveConsole: 1739. and sets `readfunc'
     to be used as the *note InteractiveConsole.raw_input(): 3657.
     method, if provided.  If `local' is provided, it is passed to the
     *note InteractiveConsole: 1739. constructor for use as the default
     namespace for the interpreter loop.  The *note interact(): 3656.
     method of the instance is then run with `banner' and `exitmsg'
     passed as the banner and exit message to use, if provided.  The
     console object is discarded after use.

     Changed in version 3.6: Added `exitmsg' parameter.

 -- Function: code.compile_command (source, filename="<input>",
          symbol="single")

     This function is useful for programs that want to emulate Python’s
     interpreter main loop (a.k.a.  the read-eval-print loop).  The
     tricky part is to determine when the user has entered an incomplete
     command that can be completed by entering more text (as opposed to
     a complete command or a syntax error).  This function `almost'
     always makes the same decision as the real interpreter main loop.

     `source' is the source string; `filename' is the optional filename
     from which source was read, defaulting to ‘'<input>'’; and `symbol'
     is the optional grammar start symbol, which should be either
     ‘'single'’ (the default) or ‘'eval'’.

     Returns a code object (the same as ‘compile(source, filename,
     symbol)’) if the command is complete and valid; ‘None’ if the
     command is incomplete; raises *note SyntaxError: 44d. if the
     command is complete and contains a syntax error, or raises *note
     OverflowError: 954. or *note ValueError: 1f9. if the command
     contains an invalid literal.

* Menu:

* Interactive Interpreter Objects::
* Interactive Console Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/code.py


File: python.info,  Node: Interactive Interpreter Objects,  Next: Interactive Console Objects,  Up: code — Interpreter base classes

5.31.1.1 Interactive Interpreter Objects
........................................

 -- Method: InteractiveInterpreter.runsource (source,
          filename="<input>", symbol="single")

     Compile and run some source in the interpreter.  Arguments are the
     same as for *note compile_command(): 3658.; the default for
     `filename' is ‘'<input>'’, and for `symbol' is ‘'single'’.  One
     several things can happen:

        * The input is incorrect; *note compile_command(): 3658. raised
          an exception (*note SyntaxError: 44d. or *note OverflowError:
          954.).  A syntax traceback will be printed by calling the
          *note showsyntaxerror(): 365c. method.  *note runsource():
          365b. returns ‘False’.

        * The input is incomplete, and more input is required; *note
          compile_command(): 3658. returned ‘None’.  *note runsource():
          365b. returns ‘True’.

        * The input is complete; *note compile_command(): 3658. returned
          a code object.  The code is executed by calling the *note
          runcode(): 365d. (which also handles run-time exceptions,
          except for *note SystemExit: 5f1.).  *note runsource(): 365b.
          returns ‘False’.

     The return value can be used to decide whether to use ‘sys.ps1’ or
     ‘sys.ps2’ to prompt the next line.

 -- Method: InteractiveInterpreter.runcode (code)

     Execute a code object.  When an exception occurs, *note
     showtraceback(): 69b. is called to display a traceback.  All
     exceptions are caught except *note SystemExit: 5f1, which is
     allowed to propagate.

     A note about *note KeyboardInterrupt: 197.: this exception may
     occur elsewhere in this code, and may not always be caught.  The
     caller should be prepared to deal with it.

 -- Method: InteractiveInterpreter.showsyntaxerror (filename=None)

     Display the syntax error that just occurred.  This does not display
     a stack trace because there isn’t one for syntax errors.  If
     `filename' is given, it is stuffed into the exception instead of
     the default filename provided by Python’s parser, because it always
     uses ‘'<string>'’ when reading from a string.  The output is
     written by the *note write(): 365e. method.

 -- Method: InteractiveInterpreter.showtraceback ()

     Display the exception that just occurred.  We remove the first
     stack item because it is within the interpreter object
     implementation.  The output is written by the *note write(): 365e.
     method.

     Changed in version 3.5: The full chained traceback is displayed
     instead of just the primary traceback.

 -- Method: InteractiveInterpreter.write (data)

     Write a string to the standard error stream (‘sys.stderr’).
     Derived classes should override this to provide the appropriate
     output handling as needed.


File: python.info,  Node: Interactive Console Objects,  Prev: Interactive Interpreter Objects,  Up: code — Interpreter base classes

5.31.1.2 Interactive Console Objects
....................................

The *note InteractiveConsole: 1739. class is a subclass of *note
InteractiveInterpreter: 3655, and so offers all the methods of the
interpreter objects as well as the following additions.

 -- Method: InteractiveConsole.interact (banner=None, exitmsg=None)

     Closely emulate the interactive Python console.  The optional
     `banner' argument specify the banner to print before the first
     interaction; by default it prints a banner similar to the one
     printed by the standard Python interpreter, followed by the class
     name of the console object in parentheses (so as not to confuse
     this with the real interpreter – since it’s so close!).

     The optional `exitmsg' argument specifies an exit message printed
     when exiting.  Pass the empty string to suppress the exit message.
     If `exitmsg' is not given or ‘None’, a default message is printed.

     Changed in version 3.4: To suppress printing any banner, pass an
     empty string.

     Changed in version 3.6: Print an exit message when exiting.

 -- Method: InteractiveConsole.push (line)

     Push a line of source text to the interpreter.  The line should not
     have a trailing newline; it may have internal newlines.  The line
     is appended to a buffer and the interpreter’s ‘runsource()’ method
     is called with the concatenated contents of the buffer as source.
     If this indicates that the command was executed or invalid, the
     buffer is reset; otherwise, the command is incomplete, and the
     buffer is left as it was after the line was appended.  The return
     value is ‘True’ if more input is required, ‘False’ if the line was
     dealt with in some way (this is the same as ‘runsource()’).

 -- Method: InteractiveConsole.resetbuffer ()

     Remove any unhandled source text from the input buffer.

 -- Method: InteractiveConsole.raw_input (prompt="")

     Write a prompt and read a line.  The returned line does not include
     the trailing newline.  When the user enters the EOF key sequence,
     *note EOFError: c5f. is raised.  The base implementation reads from
     ‘sys.stdin’; a subclass may replace this with a different
     implementation.


File: python.info,  Node: codeop — Compile Python code,  Prev: code — Interpreter base classes,  Up: Custom Python Interpreters

5.31.2 ‘codeop’ — Compile Python code
-------------------------------------

`Source code:' Lib/codeop.py(1)

__________________________________________________________________

The *note codeop: 1d. module provides utilities upon which the Python
read-eval-print loop can be emulated, as is done in the *note code: 1b.
module.  As a result, you probably don’t want to use the module
directly; if you want to include such a loop in your program you
probably want to use the *note code: 1b. module instead.

There are two parts to this job:

  1. Being able to tell if a line of input completes a Python statement:
     in short, telling whether to print ‘‘>>>’’ or ‘‘...’’ next.

  2. Remembering which future statements the user has entered, so
     subsequent input can be compiled with these in effect.

The *note codeop: 1d. module provides a way of doing each of these
things, and a way of doing them both.

To do just the former:

 -- Function: codeop.compile_command (source, filename="<input>",
          symbol="single")

     Tries to compile `source', which should be a string of Python code
     and return a code object if `source' is valid Python code.  In that
     case, the filename attribute of the code object will be `filename',
     which defaults to ‘'<input>'’.  Returns ‘None’ if `source' is `not'
     valid Python code, but is a prefix of valid Python code.

     If there is a problem with `source', an exception will be raised.
     *note SyntaxError: 44d. is raised if there is invalid Python
     syntax, and *note OverflowError: 954. or *note ValueError: 1f9. if
     there is an invalid literal.

     The `symbol' argument determines whether `source' is compiled as a
     statement (‘'single'’, the default) or as an *note expression:
     3563. (‘'eval'’).  Any other value will cause *note ValueError:
     1f9. to be raised.

          Note: It is possible (but not likely) that the parser stops
          parsing with a successful outcome before reaching the end of
          the source; in this case, trailing symbols may be ignored
          instead of causing an error.  For example, a backslash
          followed by two newlines may be followed by arbitrary garbage.
          This will be fixed once the API for the parser is better.

 -- Class: codeop.Compile

     Instances of this class have *note __call__(): 1369. methods
     identical in signature to the built-in function *note compile():
     1b2, but with the difference that if the instance compiles program
     text containing a *note __future__: 0. statement, the instance
     ‘remembers’ and compiles all subsequent program texts with the
     statement in force.

 -- Class: codeop.CommandCompiler

     Instances of this class have *note __call__(): 1369. methods
     identical in signature to *note compile_command(): 3666.; the
     difference is that if the instance compiles program text containing
     a ‘__future__’ statement, the instance ‘remembers’ and compiles all
     subsequent program texts with the statement in force.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/codeop.py


File: python.info,  Node: Importing Modules,  Next: Python Language Services,  Prev: Custom Python Interpreters,  Up: The Python Standard Library

5.32 Importing Modules
======================

The modules described in this chapter provide new ways to import other
Python modules and hooks for customizing the import process.

The full list of modules described in this chapter is:

* Menu:

* zipimport — Import modules from Zip archives::
* pkgutil — Package extension utility::
* modulefinder — Find modules used by a script::
* runpy — Locating and executing Python modules::
* importlib — The implementation of import::
* Using importlib.metadata: Using importlib metadata.


File: python.info,  Node: zipimport — Import modules from Zip archives,  Next: pkgutil — Package extension utility,  Up: Importing Modules

5.32.1 ‘zipimport’ — Import modules from Zip archives
-----------------------------------------------------

`Source code:' Lib/zipimport.py(1)

__________________________________________________________________

This module adds the ability to import Python modules (‘*.py’, ‘*.pyc’)
and packages from ZIP-format archives.  It is usually not needed to use
the *note zipimport: 143. module explicitly; it is automatically used by
the built-in *note import: c10. mechanism for *note sys.path: 47d. items
that are paths to ZIP archives.

Typically, *note sys.path: 47d. is a list of directory names as strings.
This module also allows an item of *note sys.path: 47d. to be a string
naming a ZIP file archive.  The ZIP archive can contain a subdirectory
structure to support package imports, and a path within the archive can
be specified to only import from a subdirectory.  For example, the path
‘example.zip/lib/’ would only import from the ‘lib/’ subdirectory within
the archive.

Any files may be present in the ZIP archive, but only files ‘.py’ and
‘.pyc’ are available for import.  ZIP import of dynamic modules (‘.pyd’,
‘.so’) is disallowed.  Note that if an archive only contains ‘.py’
files, Python will not attempt to modify the archive by adding the
corresponding ‘.pyc’ file, meaning that if a ZIP archive doesn’t contain
‘.pyc’ files, importing may be rather slow.

Changed in version 3.8: Previously, ZIP archives with an archive comment
were not supported.

See also
........

PKZIP Application Note(2)

     Documentation on the ZIP file format by Phil Katz, the creator of
     the format and algorithms used.

PEP 273(3) - Import Modules from Zip Archives

     Written by James C. Ahlstrom, who also provided an implementation.
     Python 2.3 follows the specification in PEP 273(4), but uses an
     implementation written by Just van Rossum that uses the import
     hooks described in PEP 302(5).

PEP 302(6) - New Import Hooks

     The PEP to add the import hooks that help this module work.

This module defines an exception:

 -- Exception: zipimport.ZipImportError

     Exception raised by zipimporter objects.  It’s a subclass of *note
     ImportError: 329, so it can be caught as *note ImportError: 329,
     too.

* Menu:

* zipimporter Objects::
* Examples: Examples<28>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/zipimport.py

   (2) https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT

   (3) https://www.python.org/dev/peps/pep-0273

   (4) https://www.python.org/dev/peps/pep-0273

   (5) https://www.python.org/dev/peps/pep-0302

   (6) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: zipimporter Objects,  Next: Examples<28>,  Up: zipimport — Import modules from Zip archives

5.32.1.1 zipimporter Objects
............................

*note zipimporter: 3671. is the class for importing ZIP files.

 -- Class: zipimport.zipimporter (archivepath)

     Create a new zipimporter instance.  `archivepath' must be a path to
     a ZIP file, or to a specific path within a ZIP file.  For example,
     an `archivepath' of ‘foo/bar.zip/lib’ will look for modules in the
     ‘lib’ directory inside the ZIP file ‘foo/bar.zip’ (provided that it
     exists).

     *note ZipImportError: 366e. is raised if `archivepath' doesn’t
     point to a valid ZIP archive.

      -- Method: find_module (fullname[, path])

          Search for a module specified by `fullname'.  `fullname' must
          be the fully qualified (dotted) module name.  It returns the
          zipimporter instance itself if the module was found, or *note
          None: 157. if it wasn’t.  The optional `path' argument is
          ignored—it’s there for compatibility with the importer
          protocol.

      -- Method: get_code (fullname)

          Return the code object for the specified module.  Raise *note
          ZipImportError: 366e. if the module couldn’t be found.

      -- Method: get_data (pathname)

          Return the data associated with `pathname'.  Raise *note
          OSError: 1d1. if the file wasn’t found.

          Changed in version 3.3: *note IOError: 986. used to be raised
          instead of *note OSError: 1d1.

      -- Method: get_filename (fullname)

          Return the value ‘__file__’ would be set to if the specified
          module was imported.  Raise *note ZipImportError: 366e. if the
          module couldn’t be found.

          New in version 3.1.

      -- Method: get_source (fullname)

          Return the source code for the specified module.  Raise *note
          ZipImportError: 366e. if the module couldn’t be found, return
          *note None: 157. if the archive does contain the module, but
          has no source for it.

      -- Method: is_package (fullname)

          Return ‘True’ if the module specified by `fullname' is a
          package.  Raise *note ZipImportError: 366e. if the module
          couldn’t be found.

      -- Method: load_module (fullname)

          Load the module specified by `fullname'.  `fullname' must be
          the fully qualified (dotted) module name.  It returns the
          imported module, or raises *note ZipImportError: 366e. if it
          wasn’t found.

      -- Attribute: archive

          The file name of the importer’s associated ZIP file, without a
          possible subpath.

      -- Attribute: prefix

          The subpath within the ZIP file where modules are searched.
          This is the empty string for zipimporter objects which point
          to the root of the ZIP file.

     The *note archive: 3678. and *note prefix: 3679. attributes, when
     combined with a slash, equal the original `archivepath' argument
     given to the *note zipimporter: 3671. constructor.


File: python.info,  Node: Examples<28>,  Prev: zipimporter Objects,  Up: zipimport — Import modules from Zip archives

5.32.1.2 Examples
.................

Here is an example that imports a module from a ZIP archive - note that
the *note zipimport: 143. module is not explicitly used.

     $ unzip -l example.zip Archive:  example.zip   Length     Date   Time    Name  --------    ----   ----    ----      8467  11-26-02 22:30   jwzthreading.py  --------                   -------      8467                   1 file $ ./python Python 2.3 (#1, Aug 1 2003, 19:54:32) >>> import sys >>> sys.path.insert(0, 'example.zip')  # Add .zip file to front of path >>> import jwzthreading >>> jwzthreading.__file__ 'example.zip/jwzthreading.py'


File: python.info,  Node: pkgutil — Package extension utility,  Next: modulefinder — Find modules used by a script,  Prev: zipimport — Import modules from Zip archives,  Up: Importing Modules

5.32.2 ‘pkgutil’ — Package extension utility
--------------------------------------------

`Source code:' Lib/pkgutil.py(1)

__________________________________________________________________

This module provides utilities for the import system, in particular
package support.

 -- Class: pkgutil.ModuleInfo (module_finder, name, ispkg)

     A namedtuple that holds a brief summary of a module’s info.

     New in version 3.6.

 -- Function: pkgutil.extend_path (path, name)

     Extend the search path for the modules which comprise a package.
     Intended use is to place the following code in a package’s
     ‘__init__.py’:

          from pkgutil import extend_path __path__ = extend_path(__path__, __name__)

     This will add to the package’s ‘__path__’ all subdirectories of
     directories on ‘sys.path’ named after the package.  This is useful
     if one wants to distribute different parts of a single logical
     package as multiple directories.

     It also looks for ‘*.pkg’ files beginning where ‘*’ matches the
     `name' argument.  This feature is similar to ‘*.pth’ files (see the
     *note site: eb. module for more information), except that it
     doesn’t special-case lines starting with ‘import’.  A ‘*.pkg’ file
     is trusted at face value: apart from checking for duplicates, all
     entries found in a ‘*.pkg’ file are added to the path, regardless
     of whether they exist on the filesystem.  (This is a feature.)

     If the input path is not a list (as is the case for frozen
     packages) it is returned unchanged.  The input path is not
     modified; an extended copy is returned.  Items are only appended to
     the copy at the end.

     It is assumed that *note sys.path: 47d. is a sequence.  Items of
     *note sys.path: 47d. that are not strings referring to existing
     directories are ignored.  Unicode items on *note sys.path: 47d.
     that cause errors when used as filenames may cause this function to
     raise an exception (in line with *note os.path.isdir(): 1f6.
     behavior).

 -- Class: pkgutil.ImpImporter (dirname=None)

     PEP 302(2) Finder that wraps Python’s “classic” import algorithm.

     If `dirname' is a string, a PEP 302(3) finder is created that
     searches that directory.  If `dirname' is ‘None’, a PEP 302(4)
     finder is created that searches the current *note sys.path: 47d,
     plus any modules that are frozen or built-in.

     Note that *note ImpImporter: 367f. does not currently support being
     used by placement on *note sys.meta_path: 5db.

     Deprecated since version 3.3: This emulation is no longer needed,
     as the standard import mechanism is now fully PEP 302(5) compliant
     and available in *note importlib: 9b.

 -- Class: pkgutil.ImpLoader (fullname, file, filename, etc)

     *note Loader: 13f8. that wraps Python’s “classic” import algorithm.

     Deprecated since version 3.3: This emulation is no longer needed,
     as the standard import mechanism is now fully PEP 302(6) compliant
     and available in *note importlib: 9b.

 -- Function: pkgutil.find_loader (fullname)

     Retrieve a module *note loader: 13f8. for the given `fullname'.

     This is a backwards compatibility wrapper around *note
     importlib.util.find_spec(): 92c. that converts most failures to
     *note ImportError: 329. and only returns the loader rather than the
     full ‘ModuleSpec’.

     Changed in version 3.3: Updated to be based directly on *note
     importlib: 9b. rather than relying on the package internal PEP
     302(7) import emulation.

     Changed in version 3.4: Updated to be based on PEP 451(8)

 -- Function: pkgutil.get_importer (path_item)

     Retrieve a *note finder: 13f7. for the given `path_item'.

     The returned finder is cached in *note sys.path_importer_cache:
     493. if it was newly created by a path hook.

     The cache (or part of it) can be cleared manually if a rescan of
     *note sys.path_hooks: 950. is necessary.

     Changed in version 3.3: Updated to be based directly on *note
     importlib: 9b. rather than relying on the package internal PEP
     302(9) import emulation.

 -- Function: pkgutil.get_loader (module_or_name)

     Get a *note loader: 13f8. object for `module_or_name'.

     If the module or package is accessible via the normal import
     mechanism, a wrapper around the relevant part of that machinery is
     returned.  Returns ‘None’ if the module cannot be found or
     imported.  If the named module is not already imported, its
     containing package (if any) is imported, in order to establish the
     package ‘__path__’.

     Changed in version 3.3: Updated to be based directly on *note
     importlib: 9b. rather than relying on the package internal PEP
     302(10) import emulation.

     Changed in version 3.4: Updated to be based on PEP 451(11)

 -- Function: pkgutil.iter_importers (fullname='')

     Yield *note finder: 13f7. objects for the given module name.

     If fullname contains a ‘.’, the finders will be for the package
     containing fullname, otherwise they will be all registered top
     level finders (i.e.  those on both sys.meta_path and
     sys.path_hooks).

     If the named module is in a package, that package is imported as a
     side effect of invoking this function.

     If no module name is specified, all top level finders are produced.

     Changed in version 3.3: Updated to be based directly on *note
     importlib: 9b. rather than relying on the package internal PEP
     302(12) import emulation.

 -- Function: pkgutil.iter_modules (path=None, prefix='')

     Yields *note ModuleInfo: 602. for all submodules on `path', or, if
     `path' is ‘None’, all top-level modules on ‘sys.path’.

     `path' should be either ‘None’ or a list of paths to look for
     modules in.

     `prefix' is a string to output on the front of every module name on
     output.

          Note: Only works for a *note finder: 13f7. which defines an
          ‘iter_modules()’ method.  This interface is non-standard, so
          the module also provides implementations for *note
          importlib.machinery.FileFinder: 9aa. and *note
          zipimport.zipimporter: 3671.

     Changed in version 3.3: Updated to be based directly on *note
     importlib: 9b. rather than relying on the package internal PEP
     302(13) import emulation.

 -- Function: pkgutil.walk_packages (path=None, prefix='', onerror=None)

     Yields *note ModuleInfo: 602. for all modules recursively on
     `path', or, if `path' is ‘None’, all accessible modules.

     `path' should be either ‘None’ or a list of paths to look for
     modules in.

     `prefix' is a string to output on the front of every module name on
     output.

     Note that this function must import all `packages' (`not' all
     modules!)  on the given `path', in order to access the ‘__path__’
     attribute to find submodules.

     `onerror' is a function which gets called with one argument (the
     name of the package which was being imported) if any exception
     occurs while trying to import a package.  If no `onerror' function
     is supplied, *note ImportError: 329.s are caught and ignored, while
     all other exceptions are propagated, terminating the search.

     Examples:

          # list all modules python can access walk_packages()  # list all submodules of ctypes walk_packages(ctypes.__path__, ctypes.__name__ + '.')

          Note: Only works for a *note finder: 13f7. which defines an
          ‘iter_modules()’ method.  This interface is non-standard, so
          the module also provides implementations for *note
          importlib.machinery.FileFinder: 9aa. and *note
          zipimport.zipimporter: 3671.

     Changed in version 3.3: Updated to be based directly on *note
     importlib: 9b. rather than relying on the package internal PEP
     302(14) import emulation.

 -- Function: pkgutil.get_data (package, resource)

     Get a resource from a package.

     This is a wrapper for the *note loader: 13f8. *note get_data: 3685.
     API. The `package' argument should be the name of a package, in
     standard module format (‘foo.bar’).  The `resource' argument should
     be in the form of a relative filename, using ‘/’ as the path
     separator.  The parent directory name ‘..’ is not allowed, and nor
     is a rooted name (starting with a ‘/’).

     The function returns a binary string that is the contents of the
     specified resource.

     For packages located in the filesystem, which have already been
     imported, this is the rough equivalent of:

          d = os.path.dirname(sys.modules[package].__file__) data = open(os.path.join(d, resource), 'rb').read()

     If the package cannot be located or loaded, or it uses a *note
     loader: 13f8. which does not support *note get_data: 3685, then
     ‘None’ is returned.  In particular, the *note loader: 13f8. for
     *note namespace packages: 13f1. does not support *note get_data:
     3685.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pkgutil.py

   (2) https://www.python.org/dev/peps/pep-0302

   (3) https://www.python.org/dev/peps/pep-0302

   (4) https://www.python.org/dev/peps/pep-0302

   (5) https://www.python.org/dev/peps/pep-0302

   (6) https://www.python.org/dev/peps/pep-0302

   (7) https://www.python.org/dev/peps/pep-0302

   (8) https://www.python.org/dev/peps/pep-0451

   (9) https://www.python.org/dev/peps/pep-0302

   (10) https://www.python.org/dev/peps/pep-0302

   (11) https://www.python.org/dev/peps/pep-0451

   (12) https://www.python.org/dev/peps/pep-0302

   (13) https://www.python.org/dev/peps/pep-0302

   (14) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: modulefinder — Find modules used by a script,  Next: runpy — Locating and executing Python modules,  Prev: pkgutil — Package extension utility,  Up: Importing Modules

5.32.3 ‘modulefinder’ — Find modules used by a script
-----------------------------------------------------

`Source code:' Lib/modulefinder.py(1)

__________________________________________________________________

This module provides a *note ModuleFinder: f13. class that can be used
to determine the set of modules imported by a script.  ‘modulefinder.py’
can also be run as a script, giving the filename of a Python script as
its argument, after which a report of the imported modules will be
printed.

 -- Function: modulefinder.AddPackagePath (pkg_name, path)

     Record that the package named `pkg_name' can be found in the
     specified `path'.

 -- Function: modulefinder.ReplacePackage (oldname, newname)

     Allows specifying that the module named `oldname' is in fact the
     package named `newname'.

 -- Class: modulefinder.ModuleFinder (path=None, debug=0, excludes=[],
          replace_paths=[])

     This class provides *note run_script(): 368a. and *note report():
     368b. methods to determine the set of modules imported by a script.
     `path' can be a list of directories to search for modules; if not
     specified, ‘sys.path’ is used.  `debug' sets the debugging level;
     higher values make the class print debugging messages about what
     it’s doing.  `excludes' is a list of module names to exclude from
     the analysis.  `replace_paths' is a list of ‘(oldpath, newpath)’
     tuples that will be replaced in module paths.

      -- Method: report ()

          Print a report to standard output that lists the modules
          imported by the script and their paths, as well as modules
          that are missing or seem to be missing.

      -- Method: run_script (pathname)

          Analyze the contents of the `pathname' file, which must
          contain Python code.

      -- Attribute: modules

          A dictionary mapping module names to modules.  See *note
          Example usage of ModuleFinder: 368d.

* Menu:

* Example usage of ModuleFinder::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/modulefinder.py


File: python.info,  Node: Example usage of ModuleFinder,  Up: modulefinder — Find modules used by a script

5.32.3.1 Example usage of ‘ModuleFinder’
........................................

The script that is going to get analyzed later on (bacon.py):

     import re, itertools  try:     import baconhameggs except ImportError:     pass  try:     import guido.python.ham except ImportError:     pass

The script that will output the report of bacon.py:

     from modulefinder import ModuleFinder  finder = ModuleFinder() finder.run_script('bacon.py')  print('Loaded modules:') for name, mod in finder.modules.items():     print('%s: ' % name, end='')     print(','.join(list(mod.globalnames.keys())[:3]))  print('-'*50) print('Modules not imported:') print('\n'.join(finder.badmodules.keys()))

Sample output (may vary depending on the architecture):

     Loaded modules: _types: copyreg:  _inverted_registry,_slotnames,__all__ sre_compile:  isstring,_sre,_optimize_unicode _sre: sre_constants:  REPEAT_ONE,makedict,AT_END_LINE sys: re:  __module__,finditer,_expand itertools: __main__:  re,itertools,baconhameggs sre_parse:  _PATTERNENDERS,SRE_FLAG_UNICODE array: types:  __module__,IntType,TypeType --------------------------------------------------- Modules not imported: guido.python.ham baconhameggs


File: python.info,  Node: runpy — Locating and executing Python modules,  Next: importlib — The implementation of import,  Prev: modulefinder — Find modules used by a script,  Up: Importing Modules

5.32.4 ‘runpy’ — Locating and executing Python modules
------------------------------------------------------

`Source code:' Lib/runpy.py(1)

__________________________________________________________________

The *note runpy: e2. module is used to locate and run Python modules
without importing them first.  Its main use is to implement the *note
-m: 32c. command line switch that allows scripts to be located using the
Python module namespace rather than the filesystem.

Note that this is `not' a sandbox module - all code is executed in the
current process, and any side effects (such as cached imports of other
modules) will remain in place after the functions have returned.

Furthermore, any functions and classes defined by the executed code are
not guaranteed to work correctly after a *note runpy: e2. function has
returned.  If that limitation is not acceptable for a given use case,
*note importlib: 9b. is likely to be a more suitable choice than this
module.

The *note runpy: e2. module provides two functions:

 -- Function: runpy.run_module (mod_name, init_globals=None,
          run_name=None, alter_sys=False)

     Execute the code of the specified module and return the resulting
     module globals dictionary.  The module’s code is first located
     using the standard import mechanism (refer to PEP 302(2) for
     details) and then executed in a fresh module namespace.

     The `mod_name' argument should be an absolute module name.  If the
     module name refers to a package rather than a normal module, then
     that package is imported and the ‘__main__’ submodule within that
     package is then executed and the resulting module globals
     dictionary returned.

     The optional dictionary argument `init_globals' may be used to
     pre-populate the module’s globals dictionary before the code is
     executed.  The supplied dictionary will not be modified.  If any of
     the special global variables below are defined in the supplied
     dictionary, those definitions are overridden by *note run_module():
     1276.

     The special global variables ‘__name__’, ‘__spec__’, ‘__file__’,
     ‘__cached__’, ‘__loader__’ and ‘__package__’ are set in the globals
     dictionary before the module code is executed (Note that this is a
     minimal set of variables - other variables may be set implicitly as
     an interpreter implementation detail).

     ‘__name__’ is set to `run_name' if this optional argument is not
     *note None: 157, to ‘mod_name + '.__main__'’ if the named module is
     a package and to the `mod_name' argument otherwise.

     ‘__spec__’ will be set appropriately for the `actually' imported
     module (that is, ‘__spec__.name’ will always be `mod_name' or
     ‘mod_name + '.__main__’, never `run_name').

     ‘__file__’, ‘__cached__’, ‘__loader__’ and ‘__package__’ are *note
     set as normal: 13ff. based on the module spec.

     If the argument `alter_sys' is supplied and evaluates to *note
     True: 48f, then ‘sys.argv[0]’ is updated with the value of
     ‘__file__’ and ‘sys.modules[__name__]’ is updated with a temporary
     module object for the module being executed.  Both ‘sys.argv[0]’
     and ‘sys.modules[__name__]’ are restored to their original values
     before the function returns.

     Note that this manipulation of *note sys: fd. is not thread-safe.
     Other threads may see the partially initialised module, as well as
     the altered list of arguments.  It is recommended that the *note
     sys: fd. module be left alone when invoking this function from
     threaded code.

     See also
     ........

     The *note -m: 32c. option offering equivalent functionality from
     the command line.

     Changed in version 3.1: Added ability to execute packages by
     looking for a ‘__main__’ submodule.

     Changed in version 3.2: Added ‘__cached__’ global variable (see PEP
     3147(3)).

     Changed in version 3.4: Updated to take advantage of the module
     spec feature added by PEP 451(4).  This allows ‘__cached__’ to be
     set correctly for modules run this way, as well as ensuring the
     real module name is always accessible as ‘__spec__.name’.

 -- Function: runpy.run_path (file_path, init_globals=None,
          run_name=None)

     Execute the code at the named filesystem location and return the
     resulting module globals dictionary.  As with a script name
     supplied to the CPython command line, the supplied path may refer
     to a Python source file, a compiled bytecode file or a valid
     sys.path entry containing a ‘__main__’ module (e.g.  a zipfile
     containing a top-level ‘__main__.py’ file).

     For a simple script, the specified code is simply executed in a
     fresh module namespace.  For a valid sys.path entry (typically a
     zipfile or directory), the entry is first added to the beginning of
     ‘sys.path’.  The function then looks for and executes a *note
     __main__: 1. module using the updated path.  Note that there is no
     special protection against invoking an existing *note __main__: 1.
     entry located elsewhere on ‘sys.path’ if there is no such module at
     the specified location.

     The optional dictionary argument `init_globals' may be used to
     pre-populate the module’s globals dictionary before the code is
     executed.  The supplied dictionary will not be modified.  If any of
     the special global variables below are defined in the supplied
     dictionary, those definitions are overridden by *note run_path():
     ca4.

     The special global variables ‘__name__’, ‘__spec__’, ‘__file__’,
     ‘__cached__’, ‘__loader__’ and ‘__package__’ are set in the globals
     dictionary before the module code is executed (Note that this is a
     minimal set of variables - other variables may be set implicitly as
     an interpreter implementation detail).

     ‘__name__’ is set to `run_name' if this optional argument is not
     *note None: 157. and to ‘'<run_path>'’ otherwise.

     If the supplied path directly references a script file (whether as
     source or as precompiled byte code), then ‘__file__’ will be set to
     the supplied path, and ‘__spec__’, ‘__cached__’, ‘__loader__’ and
     ‘__package__’ will all be set to *note None: 157.

     If the supplied path is a reference to a valid sys.path entry, then
     ‘__spec__’ will be set appropriately for the imported ‘__main__’
     module (that is, ‘__spec__.name’ will always be ‘__main__’).
     ‘__file__’, ‘__cached__’, ‘__loader__’ and ‘__package__’ will be
     *note set as normal: 13ff. based on the module spec.

     A number of alterations are also made to the *note sys: fd. module.
     Firstly, ‘sys.path’ may be altered as described above.
     ‘sys.argv[0]’ is updated with the value of ‘file_path’ and
     ‘sys.modules[__name__]’ is updated with a temporary module object
     for the module being executed.  All modifications to items in *note
     sys: fd. are reverted before the function returns.

     Note that, unlike *note run_module(): 1276, the alterations made to
     *note sys: fd. are not optional in this function as these
     adjustments are essential to allowing the execution of sys.path
     entries.  As the thread-safety limitations still apply, use of this
     function in threaded code should be either serialised with the
     import lock or delegated to a separate process.

     See also
     ........

     *note Interface options: 1274. for equivalent functionality on the
     command line (‘python path/to/script’).

     New in version 3.2.

     Changed in version 3.4: Updated to take advantage of the module
     spec feature added by PEP 451(5).  This allows ‘__cached__’ to be
     set correctly in the case where ‘__main__’ is imported from a valid
     sys.path entry rather than being executed directly.

See also
........

PEP 338(6) – Executing modules as scripts

     PEP written and implemented by Nick Coghlan.

PEP 366(7) – Main module explicit relative imports

     PEP written and implemented by Nick Coghlan.

PEP 451(8) – A ModuleSpec Type for the Import System

     PEP written and implemented by Eric Snow

*note Command line and environment: edb. - CPython command line details

The *note importlib.import_module(): b06. function

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/runpy.py

   (2) https://www.python.org/dev/peps/pep-0302

   (3) https://www.python.org/dev/peps/pep-3147

   (4) https://www.python.org/dev/peps/pep-0451

   (5) https://www.python.org/dev/peps/pep-0451

   (6) https://www.python.org/dev/peps/pep-0338

   (7) https://www.python.org/dev/peps/pep-0366

   (8) https://www.python.org/dev/peps/pep-0451


File: python.info,  Node: importlib — The implementation of import,  Next: Using importlib metadata,  Prev: runpy — Locating and executing Python modules,  Up: Importing Modules

5.32.5 ‘importlib’ — The implementation of ‘import’
---------------------------------------------------

New in version 3.1.

`Source code:' Lib/importlib/__init__.py(1)

__________________________________________________________________

* Menu:

* Introduction: Introduction<12>.
* Functions: Functions<10>.
* importlib.abc – Abstract base classes related to import: importlib abc – Abstract base classes related to import.
* importlib.resources – Resources: importlib resources – Resources.
* importlib.machinery – Importers and path hooks: importlib machinery – Importers and path hooks.
* importlib.util – Utility code for importers: importlib util – Utility code for importers.
* Examples: Examples<29>.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/importlib/__init__.py


File: python.info,  Node: Introduction<12>,  Next: Functions<10>,  Up: importlib — The implementation of import

5.32.5.1 Introduction
.....................

The purpose of the *note importlib: 9b. package is two-fold.  One is to
provide the implementation of the *note import: c10. statement (and
thus, by extension, the *note __import__(): 605. function) in Python
source code.  This provides an implementation of ‘import’ which is
portable to any Python interpreter.  This also provides an
implementation which is easier to comprehend than one implemented in a
programming language other than Python.

Two, the components to implement *note import: c10. are exposed in this
package, making it easier for users to create their own custom objects
(known generically as an *note importer: 13f9.) to participate in the
import process.

See also
........

*note The import statement: c10.

     The language reference for the *note import: c10. statement.

Packages specification(1)

     Original specification of packages.  Some semantics have changed
     since the writing of this document (e.g.  redirecting based on
     ‘None’ in *note sys.modules: 13eb.).

The *note __import__(): 9a2. function

     The *note import: c10. statement is syntactic sugar for this
     function.

PEP 235(2)

     Import on Case-Insensitive Platforms

PEP 263(3)

     Defining Python Source Code Encodings

PEP 302(4)

     New Import Hooks

PEP 328(5)

     Imports: Multi-Line and Absolute/Relative

PEP 366(6)

     Main module explicit relative imports

PEP 420(7)

     Implicit namespace packages

PEP 451(8)

     A ModuleSpec Type for the Import System

PEP 488(9)

     Elimination of PYO files

PEP 489(10)

     Multi-phase extension module initialization

PEP 552(11)

     Deterministic pycs

PEP 3120(12)

     Using UTF-8 as the Default Source Encoding

PEP 3147(13)

     PYC Repository Directories

   ---------- Footnotes ----------

   (1) https://www.python.org/doc/essays/packages/

   (2) https://www.python.org/dev/peps/pep-0235

   (3) https://www.python.org/dev/peps/pep-0263

   (4) https://www.python.org/dev/peps/pep-0302

   (5) https://www.python.org/dev/peps/pep-0328

   (6) https://www.python.org/dev/peps/pep-0366

   (7) https://www.python.org/dev/peps/pep-0420

   (8) https://www.python.org/dev/peps/pep-0451

   (9) https://www.python.org/dev/peps/pep-0488

   (10) https://www.python.org/dev/peps/pep-0489

   (11) https://www.python.org/dev/peps/pep-0552

   (12) https://www.python.org/dev/peps/pep-3120

   (13) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: Functions<10>,  Next: importlib abc – Abstract base classes related to import,  Prev: Introduction<12>,  Up: importlib — The implementation of import

5.32.5.2 Functions
..................

 -- Function: importlib.__import__ (name, globals=None, locals=None,
          fromlist=(), level=0)

     An implementation of the built-in *note __import__(): 605.
     function.

          Note: Programmatic importing of modules should use *note
          import_module(): b06. instead of this function.

 -- Function: importlib.import_module (name, package=None)

     Import a module.  The `name' argument specifies what module to
     import in absolute or relative terms (e.g.  either ‘pkg.mod’ or
     ‘..mod’).  If the name is specified in relative terms, then the
     `package' argument must be set to the name of the package which is
     to act as the anchor for resolving the package name (e.g.
     ‘import_module('..mod', 'pkg.subpkg')’ will import ‘pkg.mod’).

     The *note import_module(): b06. function acts as a simplifying
     wrapper around *note importlib.__import__(): 9a2.  This means all
     semantics of the function are derived from *note
     importlib.__import__(): 9a2.  The most important difference between
     these two functions is that *note import_module(): b06. returns the
     specified package or module (e.g.  ‘pkg.mod’), while *note
     __import__(): 605. returns the top-level package or module (e.g.
     ‘pkg’).

     If you are dynamically importing a module that was created since
     the interpreter began execution (e.g., created a Python source
     file), you may need to call *note invalidate_caches(): 492. in
     order for the new module to be noticed by the import system.

     Changed in version 3.3: Parent packages are automatically imported.

 -- Function: importlib.find_loader (name, path=None)

     Find the loader for a module, optionally within the specified
     `path'.  If the module is in *note sys.modules: 13eb, then
     ‘sys.modules[name].__loader__’ is returned (unless the loader would
     be ‘None’ or is not set, in which case *note ValueError: 1f9. is
     raised).  Otherwise a search using *note sys.meta_path: 5db. is
     done.  ‘None’ is returned if no loader is found.

     A dotted name does not have its parents implicitly imported as that
     requires loading them and that may not be desired.  To properly
     import a submodule you will need to import all parent packages of
     the submodule and use the correct argument to `path'.

     New in version 3.3.

     Changed in version 3.4: If ‘__loader__’ is not set, raise *note
     ValueError: 1f9, just like when the attribute is set to ‘None’.

     Deprecated since version 3.4: Use *note importlib.util.find_spec():
     92c. instead.

 -- Function: importlib.invalidate_caches ()

     Invalidate the internal caches of finders stored at *note
     sys.meta_path: 5db.  If a finder implements ‘invalidate_caches()’
     then it will be called to perform the invalidation.  This function
     should be called if any modules are created/installed while your
     program is running to guarantee all finders will notice the new
     module’s existence.

     New in version 3.3.

 -- Function: importlib.reload (module)

     Reload a previously imported `module'.  The argument must be a
     module object, so it must have been successfully imported before.
     This is useful if you have edited the module source file using an
     external editor and want to try out the new version without leaving
     the Python interpreter.  The return value is the module object
     (which can be different if re-importing causes a different object
     to be placed in *note sys.modules: 13eb.).

     When *note reload(): 38e. is executed:

        * Python module’s code is recompiled and the module-level code
          re-executed, defining a new set of objects which are bound to
          names in the module’s dictionary by reusing the *note loader:
          13f8. which originally loaded the module.  The ‘init’ function
          of extension modules is not called a second time.

        * As with all other objects in Python the old objects are only
          reclaimed after their reference counts drop to zero.

        * The names in the module namespace are updated to point to any
          new or changed objects.

        * Other references to the old objects (such as names external to
          the module) are not rebound to refer to the new objects and
          must be updated in each namespace where they occur if that is
          desired.

     There are a number of other caveats:

     When a module is reloaded, its dictionary (containing the module’s
     global variables) is retained.  Redefinitions of names will
     override the old definitions, so this is generally not a problem.
     If the new version of a module does not define a name that was
     defined by the old version, the old definition remains.  This
     feature can be used to the module’s advantage if it maintains a
     global table or cache of objects — with a *note try: d65. statement
     it can test for the table’s presence and skip its initialization if
     desired:

          try:     cache except NameError:     cache = {}

     It is generally not very useful to reload built-in or dynamically
     loaded modules.  Reloading *note sys: fd, *note __main__: 1, *note
     builtins: 13. and other key modules is not recommended.  In many
     cases extension modules are not designed to be initialized more
     than once, and may fail in arbitrary ways when reloaded.

     If a module imports objects from another module using *note from:
     c38. … *note import: c10. …, calling *note reload(): 38e. for the
     other module does not redefine the objects imported from it — one
     way around this is to re-execute the ‘from’ statement, another is
     to use ‘import’ and qualified names (`module.name') instead.

     If a module instantiates instances of a class, reloading the module
     that defines the class does not affect the method definitions of
     the instances — they continue to use the old class definition.  The
     same is true for derived classes.

     New in version 3.4.

     Changed in version 3.7: *note ModuleNotFoundError: 38f. is raised
     when the module being reloaded lacks a ‘ModuleSpec’.


File: python.info,  Node: importlib abc – Abstract base classes related to import,  Next: importlib resources – Resources,  Prev: Functions<10>,  Up: importlib — The implementation of import

5.32.5.3 ‘importlib.abc’ – Abstract base classes related to import
..................................................................

`Source code:' Lib/importlib/abc.py(1)

__________________________________________________________________

The *note importlib.abc: 9c. module contains all of the core abstract
base classes used by *note import: c10.  Some subclasses of the core
abstract base classes are also provided to help in implementing the core
ABCs.

ABC hierarchy:

     object  +-- Finder (deprecated)  |    +-- MetaPathFinder  |    +-- PathEntryFinder  +-- Loader       +-- ResourceLoader --------+       +-- InspectLoader          |            +-- ExecutionLoader --+                                  +-- FileLoader                                  +-- SourceLoader

 -- Class: importlib.abc.Finder

     An abstract base class representing a *note finder: 13f7.

     Deprecated since version 3.3: Use *note MetaPathFinder: 9a7. or
     *note PathEntryFinder: 9a8. instead.

      -- Method: abstractmethod find_module (fullname, path=None)

          An abstract method for finding a *note loader: 13f8. for the
          specified module.  Originally specified in PEP 302(2), this
          method was meant for use in *note sys.meta_path: 5db. and in
          the path-based import subsystem.

          Changed in version 3.4: Returns ‘None’ when called instead of
          raising *note NotImplementedError: 603.

 -- Class: importlib.abc.MetaPathFinder

     An abstract base class representing a *note meta path finder: 9a5.
     For compatibility, this is a subclass of *note Finder: 9a9.

     New in version 3.3.

      -- Method: find_spec (fullname, path, target=None)

          An abstract method for finding a *note spec: 3573. for the
          specified module.  If this is a top-level import, `path' will
          be ‘None’.  Otherwise, this is a search for a subpackage or
          module and `path' will be the value of *note __path__: 11c8.
          from the parent package.  If a spec cannot be found, ‘None’ is
          returned.  When passed in, ‘target’ is a module object that
          the finder may use to make a more educated guess about what
          spec to return.  *note importlib.util.spec_from_loader():
          3697. may be useful for implementing concrete
          ‘MetaPathFinders’.

          New in version 3.4.

      -- Method: find_module (fullname, path)

          A legacy method for finding a *note loader: 13f8. for the
          specified module.  If this is a top-level import, `path' will
          be ‘None’.  Otherwise, this is a search for a subpackage or
          module and `path' will be the value of *note __path__: 11c8.
          from the parent package.  If a loader cannot be found, ‘None’
          is returned.

          If *note find_spec(): 458. is defined, backwards-compatible
          functionality is provided.

          Changed in version 3.4: Returns ‘None’ when called instead of
          raising *note NotImplementedError: 603.  Can use *note
          find_spec(): 458. to provide functionality.

          Deprecated since version 3.4: Use *note find_spec(): 458.
          instead.

      -- Method: invalidate_caches ()

          An optional method which, when called, should invalidate any
          internal cache used by the finder.  Used by *note
          importlib.invalidate_caches(): 492. when invalidating the
          caches of all finders on *note sys.meta_path: 5db.

          Changed in version 3.4: Returns ‘None’ when called instead of
          ‘NotImplemented’.

 -- Class: importlib.abc.PathEntryFinder

     An abstract base class representing a *note path entry finder: 9a6.
     Though it bears some similarities to *note MetaPathFinder: 9a7,
     ‘PathEntryFinder’ is meant for use only within the path-based
     import subsystem provided by ‘PathFinder’.  This ABC is a subclass
     of *note Finder: 9a9. for compatibility reasons only.

     New in version 3.3.

      -- Method: find_spec (fullname, target=None)

          An abstract method for finding a *note spec: 3573. for the
          specified module.  The finder will search for the module only
          within the *note path entry: 140d. to which it is assigned.
          If a spec cannot be found, ‘None’ is returned.  When passed
          in, ‘target’ is a module object that the finder may use to
          make a more educated guess about what spec to return.  *note
          importlib.util.spec_from_loader(): 3697. may be useful for
          implementing concrete ‘PathEntryFinders’.

          New in version 3.4.

      -- Method: find_loader (fullname)

          A legacy method for finding a *note loader: 13f8. for the
          specified module.  Returns a 2-tuple of ‘(loader, portion)’
          where ‘portion’ is a sequence of file system locations
          contributing to part of a namespace package.  The loader may
          be ‘None’ while specifying ‘portion’ to signify the
          contribution of the file system locations to a namespace
          package.  An empty list can be used for ‘portion’ to signify
          the loader is not part of a namespace package.  If ‘loader’ is
          ‘None’ and ‘portion’ is the empty list then no loader or
          location for a namespace package were found (i.e.  failure to
          find anything for the module).

          If *note find_spec(): 45a. is defined then
          backwards-compatible functionality is provided.

          Changed in version 3.4: Returns ‘(None, [])’ instead of
          raising *note NotImplementedError: 603.  Uses *note
          find_spec(): 45a. when available to provide functionality.

          Deprecated since version 3.4: Use *note find_spec(): 45a.
          instead.

      -- Method: find_module (fullname)

          A concrete implementation of *note Finder.find_module(): 3696.
          which is equivalent to ‘self.find_loader(fullname)[0]’.

          Deprecated since version 3.4: Use *note find_spec(): 45a.
          instead.

      -- Method: invalidate_caches ()

          An optional method which, when called, should invalidate any
          internal cache used by the finder.  Used by
          ‘PathFinder.invalidate_caches()’ when invalidating the caches
          of all cached finders.

 -- Class: importlib.abc.Loader

     An abstract base class for a *note loader: 13f8.  See PEP 302(3)
     for the exact definition for a loader.

     Loaders that wish to support resource reading should implement a
     ‘get_resource_reader(fullname)’ method as specified by *note
     importlib.abc.ResourceReader: 337.

     Changed in version 3.7: Introduced the optional
     ‘get_resource_reader()’ method.

      -- Method: create_module (spec)

          A method that returns the module object to use when importing
          a module.  This method may return ‘None’, indicating that
          default module creation semantics should take place.

          New in version 3.4.

          Changed in version 3.5: Starting in Python 3.6, this method
          will not be optional when *note exec_module(): 5d9. is
          defined.

      -- Method: exec_module (module)

          An abstract method that executes the module in its own
          namespace when a module is imported or reloaded.  The module
          should already be initialized when ‘exec_module()’ is called.
          When this method exists, *note create_module(): 549. must be
          defined.

          New in version 3.4.

          Changed in version 3.6: *note create_module(): 549. must also
          be defined.

      -- Method: load_module (fullname)

          A legacy method for loading a module.  If the module cannot be
          loaded, *note ImportError: 329. is raised, otherwise the
          loaded module is returned.

          If the requested module already exists in *note sys.modules:
          13eb, that module should be used and reloaded.  Otherwise the
          loader should create a new module and insert it into *note
          sys.modules: 13eb. before any loading begins, to prevent
          recursion from the import.  If the loader inserted a module
          and the load fails, it must be removed by the loader from
          *note sys.modules: 13eb.; modules already in *note
          sys.modules: 13eb. before the loader began execution should be
          left alone (see *note importlib.util.module_for_loader():
          936.).

          The loader should set several attributes on the module.  (Note
          that some of these attributes can change when a module is
          reloaded):

             - 
               *note __name__: d05.

                    The name of the module.

             - 
               *note __file__: 136b.

                    The path to where the module data is stored (not set
                    for built-in modules).

             - 
               *note __cached__: b25.

                    The path to where a compiled version of the module
                    is/should be stored (not set when the attribute
                    would be inappropriate).

             - 
               *note __path__: 11c8.

                    A list of strings specifying the search path within
                    a package.  This attribute is not set on modules.

             - 
               *note __package__: 949.

                    The parent package for the module/package.  If the
                    module is top-level then it has a value of the empty
                    string.  The *note
                    importlib.util.module_for_loader(): 936. decorator
                    can handle the details for *note __package__: 949.

             - 
               *note __loader__: 94a.

                    The loader used to load the module.  The *note
                    importlib.util.module_for_loader(): 936. decorator
                    can handle the details for *note __package__: 949.

          When *note exec_module(): 5d9. is available then
          backwards-compatible functionality is provided.

          Changed in version 3.4: Raise *note ImportError: 329. when
          called instead of *note NotImplementedError: 603.
          Functionality provided when *note exec_module(): 5d9. is
          available.

          Deprecated since version 3.4: The recommended API for loading
          a module is *note exec_module(): 5d9. (and *note
          create_module(): 549.).  Loaders should implement it instead
          of load_module().  The import machinery takes care of all the
          other responsibilities of load_module() when exec_module() is
          implemented.

      -- Method: module_repr (module)

          A legacy method which when implemented calculates and returns
          the given module’s repr, as a string.  The module type’s
          default repr() will use the result of this method as
          appropriate.

          New in version 3.3.

          Changed in version 3.4: Made optional instead of an
          abstractmethod.

          Deprecated since version 3.4: The import machinery now takes
          care of this automatically.

 -- Class: importlib.abc.ResourceReader

     An *note abstract base class: b26. to provide the ability to read
     `resources'.

     From the perspective of this ABC, a `resource' is a binary artifact
     that is shipped within a package.  Typically this is something like
     a data file that lives next to the ‘__init__.py’ file of the
     package.  The purpose of this class is to help abstract out the
     accessing of such data files so that it does not matter if the
     package and its data file(s) are stored in a e.g.  zip file versus
     on the file system.

     For any of methods of this class, a `resource' argument is expected
     to be a *note path-like object: 35f. which represents conceptually
     just a file name.  This means that no subdirectory paths should be
     included in the `resource' argument.  This is because the location
     of the package the reader is for, acts as the “directory”.  Hence
     the metaphor for directories and file names is packages and
     resources, respectively.  This is also why instances of this class
     are expected to directly correlate to a specific package (instead
     of potentially representing multiple packages or a module).

     Loaders that wish to support resource reading are expected to
     provide a method called ‘get_resource_reader(fullname)’ which
     returns an object implementing this ABC’s interface.  If the module
     specified by fullname is not a package, this method should return
     *note None: 157.  An object compatible with this ABC should only be
     returned when the specified module is a package.

     New in version 3.7.

      -- Method: abstractmethod open_resource (resource)

          Returns an opened, *note file-like object: 1ba2. for binary
          reading of the `resource'.

          If the resource cannot be found, *note FileNotFoundError: 7b4.
          is raised.

      -- Method: abstractmethod resource_path (resource)

          Returns the file system path to the `resource'.

          If the resource does not concretely exist on the file system,
          raise *note FileNotFoundError: 7b4.

      -- Method: abstractmethod is_resource (name)

          Returns ‘True’ if the named `name' is considered a resource.
          *note FileNotFoundError: 7b4. is raised if `name' does not
          exist.

      -- Method: abstractmethod contents ()

          Returns an *note iterable: b9f. of strings over the contents
          of the package.  Do note that it is not required that all
          names returned by the iterator be actual resources, e.g.  it
          is acceptable to return names for which *note is_resource():
          369c. would be false.

          Allowing non-resource names to be returned is to allow for
          situations where how a package and its resources are stored
          are known a priori and the non-resource names would be useful.
          For instance, returning subdirectory names is allowed so that
          when it is known that the package and resources are stored on
          the file system then those subdirectory names can be used
          directly.

          The abstract method returns an iterable of no items.

 -- Class: importlib.abc.ResourceLoader

     An abstract base class for a *note loader: 13f8. which implements
     the optional PEP 302(4) protocol for loading arbitrary resources
     from the storage back-end.

     Deprecated since version 3.7: This ABC is deprecated in favour of
     supporting resource loading through *note
     importlib.abc.ResourceReader: 337.

      -- Method: abstractmethod get_data (path)

          An abstract method to return the bytes for the data located at
          `path'.  Loaders that have a file-like storage back-end that
          allows storing arbitrary data can implement this abstract
          method to give direct access to the data stored.  *note
          OSError: 1d1. is to be raised if the `path' cannot be found.
          The `path' is expected to be constructed using a module’s
          *note __file__: 136b. attribute or an item from a package’s
          *note __path__: 11c8.

          Changed in version 3.4: Raises *note OSError: 1d1. instead of
          *note NotImplementedError: 603.

 -- Class: importlib.abc.InspectLoader

     An abstract base class for a *note loader: 13f8. which implements
     the optional PEP 302(5) protocol for loaders that inspect modules.

      -- Method: get_code (fullname)

          Return the code object for a module, or ‘None’ if the module
          does not have a code object (as would be the case, for
          example, for a built-in module).  Raise an *note ImportError:
          329. if loader cannot find the requested module.

               Note: While the method has a default implementation, it
               is suggested that it be overridden if possible for
               performance.

          Changed in version 3.4: No longer abstract and a concrete
          implementation is provided.

      -- Method: abstractmethod get_source (fullname)

          An abstract method to return the source of a module.  It is
          returned as a text string using *note universal newlines: 5e9,
          translating all recognized line separators into ‘'\n'’
          characters.  Returns ‘None’ if no source is available (e.g.  a
          built-in module).  Raises *note ImportError: 329. if the
          loader cannot find the module specified.

          Changed in version 3.4: Raises *note ImportError: 329. instead
          of *note NotImplementedError: 603.

      -- Method: is_package (fullname)

          An abstract method to return a true value if the module is a
          package, a false value otherwise.  *note ImportError: 329. is
          raised if the *note loader: 13f8. cannot find the module.

          Changed in version 3.4: Raises *note ImportError: 329. instead
          of *note NotImplementedError: 603.

      -- Static Method: source_to_code (data, path='<string>')

          Create a code object from Python source.

          The `data' argument can be whatever the *note compile(): 1b2.
          function supports (i.e.  string or bytes).  The `path'
          argument should be the “path” to where the source code
          originated from, which can be an abstract concept (e.g.
          location in a zip file).

          With the subsequent code object one can execute it in a module
          by running ‘exec(code, module.__dict__)’.

          New in version 3.4.

          Changed in version 3.5: Made the method static.

      -- Method: exec_module (module)

          Implementation of *note Loader.exec_module(): 5d9.

          New in version 3.4.

      -- Method: load_module (fullname)

          Implementation of *note Loader.load_module(): 5d8.

          Deprecated since version 3.4: use *note exec_module(): 933.
          instead.

 -- Class: importlib.abc.ExecutionLoader

     An abstract base class which inherits from *note InspectLoader:
     854. that, when implemented, helps a module to be executed as a
     script.  The ABC represents an optional PEP 302(6) protocol.

      -- Method: abstractmethod get_filename (fullname)

          An abstract method that is to return the value of *note
          __file__: 136b. for the specified module.  If no path is
          available, *note ImportError: 329. is raised.

          If source code is available, then the method should return the
          path to the source file, regardless of whether a bytecode was
          used to load the module.

          Changed in version 3.4: Raises *note ImportError: 329. instead
          of *note NotImplementedError: 603.

 -- Class: importlib.abc.FileLoader (fullname, path)

     An abstract base class which inherits from *note ResourceLoader:
     45b. and *note ExecutionLoader: 369e, providing concrete
     implementations of *note ResourceLoader.get_data(): 3685. and *note
     ExecutionLoader.get_filename(): 369f.

     The `fullname' argument is a fully resolved name of the module the
     loader is to handle.  The `path' argument is the path to the file
     for the module.

     New in version 3.3.

      -- Attribute: name

          The name of the module the loader can handle.

      -- Attribute: path

          Path to the file of the module.

      -- Method: load_module (fullname)

          Calls super’s ‘load_module()’.

          Deprecated since version 3.4: Use *note Loader.exec_module():
          5d9. instead.

      -- Method: abstractmethod get_filename (fullname)

          Returns *note path: 36a1.

      -- Method: abstractmethod get_data (path)

          Reads `path' as a binary file and returns the bytes from it.

 -- Class: importlib.abc.SourceLoader

     An abstract base class for implementing source (and optionally
     bytecode) file loading.  The class inherits from both *note
     ResourceLoader: 45b. and *note ExecutionLoader: 369e, requiring the
     implementation of:

        * *note ResourceLoader.get_data(): 3685.

        * 
          *note ExecutionLoader.get_filename(): 369f.

               Should only return the path to the source file;
               sourceless loading is not supported.

     The abstract methods defined by this class are to add optional
     bytecode file support.  Not implementing these optional methods (or
     causing them to raise *note NotImplementedError: 603.) causes the
     loader to only work with source code.  Implementing the methods
     allows the loader to work with source `and' bytecode files; it does
     not allow for `sourceless' loading where only bytecode is provided.
     Bytecode files are an optimization to speed up loading by removing
     the parsing step of Python’s compiler, and so no bytecode-specific
     API is exposed.

      -- Method: path_stats (path)

          Optional abstract method which returns a *note dict: 1b6.
          containing metadata about the specified path.  Supported
          dictionary keys are:

             - ‘'mtime'’ (mandatory): an integer or floating-point
               number representing the modification time of the source
               code;

             - ‘'size'’ (optional): the size in bytes of the source
               code.

          Any other keys in the dictionary are ignored, to allow for
          future extensions.  If the path cannot be handled, *note
          OSError: 1d1. is raised.

          New in version 3.3.

          Changed in version 3.4: Raise *note OSError: 1d1. instead of
          *note NotImplementedError: 603.

      -- Method: path_mtime (path)

          Optional abstract method which returns the modification time
          for the specified path.

          Deprecated since version 3.3: This method is deprecated in
          favour of *note path_stats(): ae1.  You don’t have to
          implement it, but it is still available for compatibility
          purposes.  Raise *note OSError: 1d1. if the path cannot be
          handled.

          Changed in version 3.4: Raise *note OSError: 1d1. instead of
          *note NotImplementedError: 603.

      -- Method: set_data (path, data)

          Optional abstract method which writes the specified bytes to a
          file path.  Any intermediate directories which do not exist
          are to be created automatically.

          When writing to the path fails because the path is read-only
          (*note errno.EACCES: 2185./*note PermissionError: 5f4.), do
          not propagate the exception.

          Changed in version 3.4: No longer raises *note
          NotImplementedError: 603. when called.

      -- Method: get_code (fullname)

          Concrete implementation of *note InspectLoader.get_code():
          855.

      -- Method: exec_module (module)

          Concrete implementation of *note Loader.exec_module(): 5d9.

          New in version 3.4.

      -- Method: load_module (fullname)

          Concrete implementation of *note Loader.load_module(): 5d8.

          Deprecated since version 3.4: Use *note exec_module(): 934.
          instead.

      -- Method: get_source (fullname)

          Concrete implementation of *note InspectLoader.get_source():
          859.

      -- Method: is_package (fullname)

          Concrete implementation of *note InspectLoader.is_package():
          369d.  A module is determined to be a package if its file path
          (as provided by *note ExecutionLoader.get_filename(): 369f.)
          is a file named ‘__init__’ when the file extension is removed
          `and' the module name itself does not end in ‘__init__’.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/importlib/abc.py

   (2) https://www.python.org/dev/peps/pep-0302

   (3) https://www.python.org/dev/peps/pep-0302

   (4) https://www.python.org/dev/peps/pep-0302

   (5) https://www.python.org/dev/peps/pep-0302

   (6) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: importlib resources – Resources,  Next: importlib machinery – Importers and path hooks,  Prev: importlib abc – Abstract base classes related to import,  Up: importlib — The implementation of import

5.32.5.4 ‘importlib.resources’ – Resources
..........................................

`Source code:' Lib/importlib/resources.py(1)

__________________________________________________________________

New in version 3.7.

This module leverages Python’s import system to provide access to
`resources' within `packages'.  If you can import a package, you can
access resources within that package.  Resources can be opened or read,
in either binary or text mode.

Resources are roughly akin to files inside directories, though it’s
important to keep in mind that this is just a metaphor.  Resources and
packages `do not' have to exist as physical files and directories on the
file system.

     Note: This module provides functionality similar to
     pkg_resources(2) Basic Resource Access(3) without the performance
     overhead of that package.  This makes reading resources included in
     packages easier, with more stable and consistent semantics.

     The standalone backport of this module provides more information on
     using importlib.resources(4) and migrating from pkg_resources to
     importlib.resources(5).

Loaders that wish to support resource reading should implement a
‘get_resource_reader(fullname)’ method as specified by *note
importlib.abc.ResourceReader: 337.

The following types are defined.

 -- Data: importlib.resources.Package

     The ‘Package’ type is defined as ‘Union[str, ModuleType]’.  This
     means that where the function describes accepting a ‘Package’, you
     can pass in either a string or a module.  Module objects must have
     a resolvable ‘__spec__.submodule_search_locations’ that is not
     ‘None’.

 -- Data: importlib.resources.Resource

     This type describes the resource names passed into the various
     functions in this package.  This is defined as ‘Union[str,
     os.PathLike]’.

The following functions are available.

 -- Function: importlib.resources.open_binary (package, resource)

     Open for binary reading the `resource' within `package'.

     `package' is either a name or a module object which conforms to the
     ‘Package’ requirements.  `resource' is the name of the resource to
     open within `package'; it may not contain path separators and it
     may not have sub-resources (i.e.  it cannot be a directory).  This
     function returns a ‘typing.BinaryIO’ instance, a binary I/O stream
     open for reading.

 -- Function: importlib.resources.open_text (package, resource,
          encoding='utf-8', errors='strict')

     Open for text reading the `resource' within `package'.  By default,
     the resource is opened for reading as UTF-8.

     `package' is either a name or a module object which conforms to the
     ‘Package’ requirements.  `resource' is the name of the resource to
     open within `package'; it may not contain path separators and it
     may not have sub-resources (i.e.  it cannot be a directory).
     `encoding' and `errors' have the same meaning as with built-in
     *note open(): 4e5.

     This function returns a ‘typing.TextIO’ instance, a text I/O stream
     open for reading.

 -- Function: importlib.resources.read_binary (package, resource)

     Read and return the contents of the `resource' within `package' as
     ‘bytes’.

     `package' is either a name or a module object which conforms to the
     ‘Package’ requirements.  `resource' is the name of the resource to
     open within `package'; it may not contain path separators and it
     may not have sub-resources (i.e.  it cannot be a directory).  This
     function returns the contents of the resource as *note bytes: 326.

 -- Function: importlib.resources.read_text (package, resource,
          encoding='utf-8', errors='strict')

     Read and return the contents of `resource' within `package' as a
     ‘str’.  By default, the contents are read as strict UTF-8.

     `package' is either a name or a module object which conforms to the
     ‘Package’ requirements.  `resource' is the name of the resource to
     open within `package'; it may not contain path separators and it
     may not have sub-resources (i.e.  it cannot be a directory).
     `encoding' and `errors' have the same meaning as with built-in
     *note open(): 4e5.  This function returns the contents of the
     resource as *note str: 325.

 -- Function: importlib.resources.path (package, resource)

     Return the path to the `resource' as an actual file system path.
     This function returns a context manager for use in a *note with:
     6dd. statement.  The context manager provides a *note pathlib.Path:
     1ff. object.

     Exiting the context manager cleans up any temporary file created
     when the resource needs to be extracted from e.g.  a zip file.

     `package' is either a name or a module object which conforms to the
     ‘Package’ requirements.  `resource' is the name of the resource to
     open within `package'; it may not contain path separators and it
     may not have sub-resources (i.e.  it cannot be a directory).

 -- Function: importlib.resources.is_resource (package, name)

     Return ‘True’ if there is a resource named `name' in the package,
     otherwise ‘False’.  Remember that directories are `not' resources!
     `package' is either a name or a module object which conforms to the
     ‘Package’ requirements.

 -- Function: importlib.resources.contents (package)

     Return an iterable over the named items within the package.  The
     iterable returns *note str: 325. resources (e.g.  files) and
     non-resources (e.g.  directories).  The iterable does not recurse
     into subdirectories.

     `package' is either a name or a module object which conforms to the
     ‘Package’ requirements.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/importlib/resources.py

   (2) https://setuptools.readthedocs.io/en/latest/pkg_resources.html

   (3) 
http://setuptools.readthedocs.io/en/latest/pkg_resources.html#basic-resource-access

   (4) http://importlib-resources.readthedocs.io/en/latest/using.html

   (5) 
http://importlib-resources.readthedocs.io/en/latest/migration.html


File: python.info,  Node: importlib machinery – Importers and path hooks,  Next: importlib util – Utility code for importers,  Prev: importlib resources – Resources,  Up: importlib — The implementation of import

5.32.5.5 ‘importlib.machinery’ – Importers and path hooks
.........................................................

`Source code:' Lib/importlib/machinery.py(1)

__________________________________________________________________

This module contains the various objects that help *note import: c10.
find and load modules.

 -- Attribute: importlib.machinery.SOURCE_SUFFIXES

     A list of strings representing the recognized file suffixes for
     source modules.

     New in version 3.3.

 -- Attribute: importlib.machinery.DEBUG_BYTECODE_SUFFIXES

     A list of strings representing the file suffixes for non-optimized
     bytecode modules.

     New in version 3.3.

     Deprecated since version 3.5: Use *note BYTECODE_SUFFIXES: 36b4.
     instead.

 -- Attribute: importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES

     A list of strings representing the file suffixes for optimized
     bytecode modules.

     New in version 3.3.

     Deprecated since version 3.5: Use *note BYTECODE_SUFFIXES: 36b4.
     instead.

 -- Attribute: importlib.machinery.BYTECODE_SUFFIXES

     A list of strings representing the recognized file suffixes for
     bytecode modules (including the leading dot).

     New in version 3.3.

     Changed in version 3.5: The value is no longer dependent on
     ‘__debug__’.

 -- Attribute: importlib.machinery.EXTENSION_SUFFIXES

     A list of strings representing the recognized file suffixes for
     extension modules.

     New in version 3.3.

 -- Function: importlib.machinery.all_suffixes ()

     Returns a combined list of strings representing all file suffixes
     for modules recognized by the standard import machinery.  This is a
     helper for code which simply needs to know if a filesystem path
     potentially refers to a module without needing any details on the
     kind of module (for example, *note inspect.getmodulename(): 5e7.).

     New in version 3.3.

 -- Class: importlib.machinery.BuiltinImporter

     An *note importer: 13f9. for built-in modules.  All known built-in
     modules are listed in *note sys.builtin_module_names: 355d.  This
     class implements the *note importlib.abc.MetaPathFinder: 9a7. and
     *note importlib.abc.InspectLoader: 854. ABCs.

     Only class methods are defined by this class to alleviate the need
     for instantiation.

     Changed in version 3.5: As part of PEP 489(2), the builtin importer
     now implements ‘Loader.create_module()’ and ‘Loader.exec_module()’

 -- Class: importlib.machinery.FrozenImporter

     An *note importer: 13f9. for frozen modules.  This class implements
     the *note importlib.abc.MetaPathFinder: 9a7. and *note
     importlib.abc.InspectLoader: 854. ABCs.

     Only class methods are defined by this class to alleviate the need
     for instantiation.

 -- Class: importlib.machinery.WindowsRegistryFinder

     *note Finder: 13f7. for modules declared in the Windows registry.
     This class implements the *note importlib.abc.MetaPathFinder: 9a7.
     ABC.

     Only class methods are defined by this class to alleviate the need
     for instantiation.

     New in version 3.3.

     Deprecated since version 3.6: Use *note site: eb. configuration
     instead.  Future versions of Python may not enable this finder by
     default.

 -- Class: importlib.machinery.PathFinder

     A *note Finder: 13f7. for *note sys.path: 47d. and package
     ‘__path__’ attributes.  This class implements the *note
     importlib.abc.MetaPathFinder: 9a7. ABC.

     Only class methods are defined by this class to alleviate the need
     for instantiation.

      -- Class Method: find_spec (fullname, path=None, target=None)

          Class method that attempts to find a *note spec: 3573. for the
          module specified by `fullname' on *note sys.path: 47d. or, if
          defined, on `path'.  For each path entry that is searched,
          *note sys.path_importer_cache: 493. is checked.  If a
          non-false object is found then it is used as the *note path
          entry finder: 9a6. to look for the module being searched for.
          If no entry is found in *note sys.path_importer_cache: 493,
          then *note sys.path_hooks: 950. is searched for a finder for
          the path entry and, if found, is stored in *note
          sys.path_importer_cache: 493. along with being queried about
          the module.  If no finder is ever found then ‘None’ is both
          stored in the cache and returned.

          New in version 3.4.

          Changed in version 3.5: If the current working directory –
          represented by an empty string – is no longer valid then
          ‘None’ is returned but no value is cached in *note
          sys.path_importer_cache: 493.

      -- Class Method: find_module (fullname, path=None)

          A legacy wrapper around *note find_spec(): 92e.

          Deprecated since version 3.4: Use *note find_spec(): 92e.
          instead.

      -- Class Method: invalidate_caches ()

          Calls *note importlib.abc.PathEntryFinder.invalidate_caches():
          3699. on all finders stored in *note sys.path_importer_cache:
          493. that define the method.  Otherwise entries in *note
          sys.path_importer_cache: 493. set to ‘None’ are deleted.

          Changed in version 3.7: Entries of ‘None’ in *note
          sys.path_importer_cache: 493. are deleted.

     Changed in version 3.4: Calls objects in *note sys.path_hooks: 950.
     with the current working directory for ‘''’ (i.e.  the empty
     string).

 -- Class: importlib.machinery.FileFinder (path, *loader_details)

     A concrete implementation of *note importlib.abc.PathEntryFinder:
     9a8. which caches results from the file system.

     The `path' argument is the directory for which the finder is in
     charge of searching.

     The `loader_details' argument is a variable number of 2-item tuples
     each containing a loader and a sequence of file suffixes the loader
     recognizes.  The loaders are expected to be callables which accept
     two arguments of the module’s name and the path to the file found.

     The finder will cache the directory contents as necessary, making
     stat calls for each module search to verify the cache is not
     outdated.  Because cache staleness relies upon the granularity of
     the operating system’s state information of the file system, there
     is a potential race condition of searching for a module, creating a
     new file, and then searching for the module the new file
     represents.  If the operations happen fast enough to fit within the
     granularity of stat calls, then the module search will fail.  To
     prevent this from happening, when you create a module dynamically,
     make sure to call *note importlib.invalidate_caches(): 492.

     New in version 3.3.

      -- Attribute: path

          The path the finder will search in.

      -- Method: find_spec (fullname, target=None)

          Attempt to find the spec to handle `fullname' within *note
          path: 36b7.

          New in version 3.4.

      -- Method: find_loader (fullname)

          Attempt to find the loader to handle `fullname' within *note
          path: 36b7.

      -- Method: invalidate_caches ()

          Clear out the internal cache.

      -- Class Method: path_hook (*loader_details)

          A class method which returns a closure for use on *note
          sys.path_hooks: 950.  An instance of *note FileFinder: 9aa. is
          returned by the closure using the path argument given to the
          closure directly and `loader_details' indirectly.

          If the argument to the closure is not an existing directory,
          *note ImportError: 329. is raised.

 -- Class: importlib.machinery.SourceFileLoader (fullname, path)

     A concrete implementation of *note importlib.abc.SourceLoader:
     36a4. by subclassing *note importlib.abc.FileLoader: 9ab. and
     providing some concrete implementations of other methods.

     New in version 3.3.

      -- Attribute: name

          The name of the module that this loader will handle.

      -- Attribute: path

          The path to the source file.

      -- Method: is_package (fullname)

          Return ‘True’ if *note path: 36bc. appears to be for a
          package.

      -- Method: path_stats (path)

          Concrete implementation of *note
          importlib.abc.SourceLoader.path_stats(): ae1.

      -- Method: set_data (path, data)

          Concrete implementation of *note
          importlib.abc.SourceLoader.set_data(): 36a5.

      -- Method: load_module (name=None)

          Concrete implementation of *note
          importlib.abc.Loader.load_module(): 5d8. where specifying the
          name of the module to load is optional.

          Deprecated since version 3.6: Use *note
          importlib.abc.Loader.exec_module(): 5d9. instead.

 -- Class: importlib.machinery.SourcelessFileLoader (fullname, path)

     A concrete implementation of *note importlib.abc.FileLoader: 9ab.
     which can import bytecode files (i.e.  no source code files exist).

     Please note that direct use of bytecode files (and thus not source
     code files) inhibits your modules from being usable by all Python
     implementations or new versions of Python which change the bytecode
     format.

     New in version 3.3.

      -- Attribute: name

          The name of the module the loader will handle.

      -- Attribute: path

          The path to the bytecode file.

      -- Method: is_package (fullname)

          Determines if the module is a package based on *note path:
          36c1.

      -- Method: get_code (fullname)

          Returns the code object for *note name: 36c0. created from
          *note path: 36c1.

      -- Method: get_source (fullname)

          Returns ‘None’ as bytecode files have no source when this
          loader is used.

      -- Method: load_module (name=None)

     Concrete implementation of *note
     importlib.abc.Loader.load_module(): 5d8. where specifying the name
     of the module to load is optional.

     Deprecated since version 3.6: Use *note
     importlib.abc.Loader.exec_module(): 5d9. instead.

 -- Class: importlib.machinery.ExtensionFileLoader (fullname, path)

     A concrete implementation of *note importlib.abc.ExecutionLoader:
     369e. for extension modules.

     The `fullname' argument specifies the name of the module the loader
     is to support.  The `path' argument is the path to the extension
     module’s file.

     New in version 3.3.

      -- Attribute: name

          Name of the module the loader supports.

      -- Attribute: path

          Path to the extension module.

      -- Method: create_module (spec)

          Creates the module object from the given specification in
          accordance with PEP 489(3).

          New in version 3.5.

      -- Method: exec_module (module)

          Initializes the given module object in accordance with PEP
          489(4).

          New in version 3.5.

      -- Method: is_package (fullname)

          Returns ‘True’ if the file path points to a package’s
          ‘__init__’ module based on *note EXTENSION_SUFFIXES: 36b6.

      -- Method: get_code (fullname)

          Returns ‘None’ as extension modules lack a code object.

      -- Method: get_source (fullname)

          Returns ‘None’ as extension modules do not have source code.

      -- Method: get_filename (fullname)

          Returns *note path: 36c6.

          New in version 3.4.

 -- Class: importlib.machinery.ModuleSpec (name, loader, *, origin=None,
          loader_state=None, is_package=None)

     A specification for a module’s import-system-related state.  This
     is typically exposed as the module’s ‘__spec__’ attribute.  In the
     descriptions below, the names in parentheses give the corresponding
     attribute available directly on the module object.  E.g.
     ‘module.__spec__.origin == module.__file__’.  Note however that
     while the `values' are usually equivalent, they can differ since
     there is no synchronization between the two objects.  Thus it is
     possible to update the module’s ‘__path__’ at runtime, and this
     will not be automatically reflected in
     ‘__spec__.submodule_search_locations’.

     New in version 3.4.

      -- Attribute: name

     (‘__name__’)

     A string for the fully-qualified name of the module.

      -- Attribute: loader

     (‘__loader__’)

     The loader to use for loading.  For namespace packages this should
     be set to ‘None’.

      -- Attribute: origin

     (‘__file__’)

     Name of the place from which the module is loaded, e.g.  “builtin”
     for built-in modules and the filename for modules loaded from
     source.  Normally “origin” should be set, but it may be ‘None’ (the
     default) which indicates it is unspecified (e.g.  for namespace
     packages).

      -- Attribute: submodule_search_locations

     (‘__path__’)

     List of strings for where to find submodules, if a package (‘None’
     otherwise).

      -- Attribute: loader_state

     Container of extra module-specific data for use during loading (or
     ‘None’).

      -- Attribute: cached

     (‘__cached__’)

     String for where the compiled module should be stored (or ‘None’).

      -- Attribute: parent

     (‘__package__’)

     (Read-only) Fully-qualified name of the package to which the module
     belongs as a submodule (or ‘None’).

      -- Attribute: has_location

     Boolean indicating whether or not the module’s “origin” attribute
     refers to a loadable location.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/importlib/machinery.py

   (2) https://www.python.org/dev/peps/pep-0489

   (3) https://www.python.org/dev/peps/pep-0489

   (4) https://www.python.org/dev/peps/pep-0489


File: python.info,  Node: importlib util – Utility code for importers,  Next: Examples<29>,  Prev: importlib machinery – Importers and path hooks,  Up: importlib — The implementation of import

5.32.5.6 ‘importlib.util’ – Utility code for importers
......................................................

`Source code:' Lib/importlib/util.py(1)

__________________________________________________________________

This module contains the various objects that help in the construction
of an *note importer: 13f9.

 -- Attribute: importlib.util.MAGIC_NUMBER

     The bytes which represent the bytecode version number.  If you need
     help with loading/writing bytecode then consider *note
     importlib.abc.SourceLoader: 36a4.

     New in version 3.4.

 -- Function: importlib.util.cache_from_source (path,
          debug_override=None, *, optimization=None)

     Return the PEP 3147(2)/ PEP 488(3) path to the byte-compiled file
     associated with the source `path'.  For example, if `path' is
     ‘/foo/bar/baz.py’ the return value would be
     ‘/foo/bar/__pycache__/baz.cpython-32.pyc’ for Python 3.2.  The
     ‘cpython-32’ string comes from the current magic tag (see
     ‘get_tag()’; if ‘sys.implementation.cache_tag’ is not defined then
     *note NotImplementedError: 603. will be raised).

     The `optimization' parameter is used to specify the optimization
     level of the bytecode file.  An empty string represents no
     optimization, so ‘/foo/bar/baz.py’ with an `optimization' of ‘''’
     will result in a bytecode path of
     ‘/foo/bar/__pycache__/baz.cpython-32.pyc’.  ‘None’ causes the
     interpreter’s optimization level to be used.  Any other value’s
     string representation is used, so ‘/foo/bar/baz.py’ with an
     `optimization' of ‘2’ will lead to the bytecode path of
     ‘/foo/bar/__pycache__/baz.cpython-32.opt-2.pyc’.  The string
     representation of `optimization' can only be alphanumeric, else
     *note ValueError: 1f9. is raised.

     The `debug_override' parameter is deprecated and can be used to
     override the system’s value for ‘__debug__’.  A ‘True’ value is the
     equivalent of setting `optimization' to the empty string.  A
     ‘False’ value is the same as setting `optimization' to ‘1’.  If
     both `debug_override' an `optimization' are not ‘None’ then *note
     TypeError: 192. is raised.

     New in version 3.4.

     Changed in version 3.5: The `optimization' parameter was added and
     the `debug_override' parameter was deprecated.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: importlib.util.source_from_cache (path)

     Given the `path' to a PEP 3147(4) file name, return the associated
     source code file path.  For example, if `path' is
     ‘/foo/bar/__pycache__/baz.cpython-32.pyc’ the returned path would
     be ‘/foo/bar/baz.py’.  `path' need not exist, however if it does
     not conform to PEP 3147(5) or PEP 488(6) format, a *note
     ValueError: 1f9. is raised.  If ‘sys.implementation.cache_tag’ is
     not defined, *note NotImplementedError: 603. is raised.

     New in version 3.4.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: importlib.util.decode_source (source_bytes)

     Decode the given bytes representing source code and return it as a
     string with universal newlines (as required by *note
     importlib.abc.InspectLoader.get_source(): 859.).

     New in version 3.4.

 -- Function: importlib.util.resolve_name (name, package)

     Resolve a relative module name to an absolute one.

     If `name' has no leading dots, then `name' is simply returned.
     This allows for usage such as ‘importlib.util.resolve_name('sys',
     __package__)’ without doing a check to see if the `package'
     argument is needed.

     *note ValueError: 1f9. is raised if `name' is a relative module
     name but package is a false value (e.g.  ‘None’ or the empty
     string).  *note ValueError: 1f9. is also raised a relative name
     would escape its containing package (e.g.  requesting ‘..bacon’
     from within the ‘spam’ package).

     New in version 3.3.

 -- Function: importlib.util.find_spec (name, package=None)

     Find the *note spec: 3573. for a module, optionally relative to the
     specified `package' name.  If the module is in *note sys.modules:
     13eb, then ‘sys.modules[name].__spec__’ is returned (unless the
     spec would be ‘None’ or is not set, in which case *note ValueError:
     1f9. is raised).  Otherwise a search using *note sys.meta_path:
     5db. is done.  ‘None’ is returned if no spec is found.

     If `name' is for a submodule (contains a dot), the parent module is
     automatically imported.

     `name' and `package' work the same as for ‘import_module()’.

     New in version 3.4.

     Changed in version 3.7: Raises *note ModuleNotFoundError: 38f.
     instead of *note AttributeError: 390. if `package' is in fact not a
     package (i.e.  lacks a *note __path__: 11c8. attribute).

 -- Function: importlib.util.module_from_spec (spec)

     Create a new module based on `spec' and *note
     spec.loader.create_module: 549.

     If *note spec.loader.create_module: 549. does not return ‘None’,
     then any pre-existing attributes will not be reset.  Also, no *note
     AttributeError: 390. will be raised if triggered while accessing
     `spec' or setting an attribute on the module.

     This function is preferred over using *note types.ModuleType: 6e5.
     to create a new module as `spec' is used to set as many
     import-controlled attributes on the module as possible.

     New in version 3.5.

 -- Function: @importlib.util.module_for_loader

     A *note decorator: 281. for *note
     importlib.abc.Loader.load_module(): 5d8. to handle selecting the
     proper module object to load with.  The decorated method is
     expected to have a call signature taking two positional arguments
     (e.g.  ‘load_module(self, module)’) for which the second argument
     will be the module `object' to be used by the loader.  Note that
     the decorator will not work on static methods because of the
     assumption of two arguments.

     The decorated method will take in the `name' of the module to be
     loaded as expected for a *note loader: 13f8.  If the module is not
     found in *note sys.modules: 13eb. then a new one is constructed.
     Regardless of where the module came from, *note __loader__: 94a.
     set to `self' and *note __package__: 949. is set based on what
     *note importlib.abc.InspectLoader.is_package(): 369d. returns (if
     available).  These attributes are set unconditionally to support
     reloading.

     If an exception is raised by the decorated method and a module was
     added to *note sys.modules: 13eb, then the module will be removed
     to prevent a partially initialized module from being in left in
     *note sys.modules: 13eb.  If the module was already in *note
     sys.modules: 13eb. then it is left alone.

     Changed in version 3.3: *note __loader__: 94a. and *note
     __package__: 949. are automatically set (when possible).

     Changed in version 3.4: Set *note __name__: d05, *note __loader__:
     94a. *note __package__: 949. unconditionally to support reloading.

     Deprecated since version 3.4: The import machinery now directly
     performs all the functionality provided by this function.

 -- Function: @importlib.util.set_loader

     A *note decorator: 281. for *note
     importlib.abc.Loader.load_module(): 5d8. to set the *note
     __loader__: 94a. attribute on the returned module.  If the
     attribute is already set the decorator does nothing.  It is assumed
     that the first positional argument to the wrapped method (i.e.
     ‘self’) is what *note __loader__: 94a. should be set to.

     Changed in version 3.4: Set ‘__loader__’ if set to ‘None’, as if
     the attribute does not exist.

     Deprecated since version 3.4: The import machinery takes care of
     this automatically.

 -- Function: @importlib.util.set_package

     A *note decorator: 281. for *note
     importlib.abc.Loader.load_module(): 5d8. to set the *note
     __package__: 949. attribute on the returned module.  If *note
     __package__: 949. is set and has a value other than ‘None’ it will
     not be changed.

     Deprecated since version 3.4: The import machinery takes care of
     this automatically.

 -- Function: importlib.util.spec_from_loader (name, loader, *,
          origin=None, is_package=None)

     A factory function for creating a ‘ModuleSpec’ instance based on a
     loader.  The parameters have the same meaning as they do for
     ModuleSpec.  The function uses available *note loader: 13f8. APIs,
     such as ‘InspectLoader.is_package()’, to fill in any missing
     information on the spec.

     New in version 3.4.

 -- Function: importlib.util.spec_from_file_location (name, location, *,
          loader=None, submodule_search_locations=None)

     A factory function for creating a ‘ModuleSpec’ instance based on
     the path to a file.  Missing information will be filled in on the
     spec by making use of loader APIs and by the implication that the
     module will be file-based.

     New in version 3.4.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- Function: importlib.util.source_hash (source_bytes)

     Return the hash of `source_bytes' as bytes.  A hash-based ‘.pyc’
     file embeds the *note source_hash(): 36d6. of the corresponding
     source file’s contents in its header.

     New in version 3.7.

 -- Class: importlib.util.LazyLoader (loader)

     A class which postpones the execution of the loader of a module
     until the module has an attribute accessed.

     This class `only' works with loaders that define *note
     exec_module(): 5d9. as control over what module type is used for
     the module is required.  For those same reasons, the loader’s *note
     create_module(): 549. method must return ‘None’ or a type for which
     its ‘__class__’ attribute can be mutated along with not using *note
     slots: 36d7.  Finally, modules which substitute the object placed
     into *note sys.modules: 13eb. will not work as there is no way to
     properly replace the module references throughout the interpreter
     safely; *note ValueError: 1f9. is raised if such a substitution is
     detected.

          Note: For projects where startup time is critical, this class
          allows for potentially minimizing the cost of loading a module
          if it is never used.  For projects where startup time is not
          essential then use of this class is `heavily' discouraged due
          to error messages created during loading being postponed and
          thus occurring out of context.

     New in version 3.5.

     Changed in version 3.6: Began calling *note create_module(): 549,
     removing the compatibility warning for *note
     importlib.machinery.BuiltinImporter: 54a. and *note
     importlib.machinery.ExtensionFileLoader: 54b.

      -- Class Method: factory (loader)

          A static method which returns a callable that creates a lazy
          loader.  This is meant to be used in situations where the
          loader is passed by class instead of by instance.

               suffixes = importlib.machinery.SOURCE_SUFFIXES loader = importlib.machinery.SourceFileLoader lazy_loader = importlib.util.LazyLoader.factory(loader) finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes))

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/importlib/util.py

   (2) https://www.python.org/dev/peps/pep-3147

   (3) https://www.python.org/dev/peps/pep-0488

   (4) https://www.python.org/dev/peps/pep-3147

   (5) https://www.python.org/dev/peps/pep-3147

   (6) https://www.python.org/dev/peps/pep-0488


File: python.info,  Node: Examples<29>,  Prev: importlib util – Utility code for importers,  Up: importlib — The implementation of import

5.32.5.7 Examples
.................

* Menu:

* Importing programmatically::
* Checking if a module can be imported::
* Importing a source file directly::
* Setting up an importer::
* Approximating importlib.import_module(): Approximating importlib import_module.


File: python.info,  Node: Importing programmatically,  Next: Checking if a module can be imported,  Up: Examples<29>

5.32.5.8 Importing programmatically
...................................

To programmatically import a module, use *note
importlib.import_module(): b06.

     import importlib  itertools = importlib.import_module('itertools')


File: python.info,  Node: Checking if a module can be imported,  Next: Importing a source file directly,  Prev: Importing programmatically,  Up: Examples<29>

5.32.5.9 Checking if a module can be imported
.............................................

If you need to find out if a module can be imported without actually
doing the import, then you should use *note importlib.util.find_spec():
92c.

     import importlib.util import sys  # For illustrative purposes. name = 'itertools'  if name in sys.modules:     print(f"{name!r} already in sys.modules") elif (spec := importlib.util.find_spec(name)) is not None:     # If you chose to perform the actual import ...     module = importlib.util.module_from_spec(spec)     sys.modules[name] = module     spec.loader.exec_module(module)     print(f"{name!r} has been imported") else:     print(f"can't find the {name!r} module")


File: python.info,  Node: Importing a source file directly,  Next: Setting up an importer,  Prev: Checking if a module can be imported,  Up: Examples<29>

5.32.5.10 Importing a source file directly
..........................................

To import a Python source file directly, use the following recipe
(Python 3.5 and newer only):

     import importlib.util import sys  # For illustrative purposes. import tokenize file_path = tokenize.__file__ module_name = tokenize.__name__  spec = importlib.util.spec_from_file_location(module_name, file_path) module = importlib.util.module_from_spec(spec) sys.modules[module_name] = module spec.loader.exec_module(module)


File: python.info,  Node: Setting up an importer,  Next: Approximating importlib import_module,  Prev: Importing a source file directly,  Up: Examples<29>

5.32.5.11 Setting up an importer
................................

For deep customizations of import, you typically want to implement an
*note importer: 13f9.  This means managing both the *note finder: 13f7.
and *note loader: 13f8. side of things.  For finders there are two
flavours to choose from depending on your needs: a *note meta path
finder: 9a5. or a *note path entry finder: 9a6.  The former is what you
would put on *note sys.meta_path: 5db. while the latter is what you
create using a *note path entry hook: 140f. on *note sys.path_hooks:
950. which works with *note sys.path: 47d. entries to potentially create
a finder.  This example will show you how to register your own importers
so that import will use them (for creating an importer for yourself,
read the documentation for the appropriate classes defined within this
package):

     import importlib.machinery import sys  # For illustrative purposes only. SpamMetaPathFinder = importlib.machinery.PathFinder SpamPathEntryFinder = importlib.machinery.FileFinder loader_details = (importlib.machinery.SourceFileLoader,                   importlib.machinery.SOURCE_SUFFIXES)  # Setting up a meta path finder. # Make sure to put the finder in the proper location in the list in terms of # priority. sys.meta_path.append(SpamMetaPathFinder)  # Setting up a path entry finder. # Make sure to put the path hook in the proper location in the list in terms # of priority. sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details))


File: python.info,  Node: Approximating importlib import_module,  Prev: Setting up an importer,  Up: Examples<29>

5.32.5.12 Approximating ‘importlib.import_module()’
...................................................

Import itself is implemented in Python code, making it possible to
expose most of the import machinery through importlib.  The following
helps illustrate the various APIs that importlib exposes by providing an
approximate implementation of *note importlib.import_module(): b06.
(Python 3.4 and newer for the importlib usage, Python 3.6 and newer for
other parts of the code).

     import importlib.util import sys  def import_module(name, package=None):     """An approximate implementation of import."""     absolute_name = importlib.util.resolve_name(name, package)     try:         return sys.modules[absolute_name]     except KeyError:         pass      path = None     if '.' in absolute_name:         parent_name, _, child_name = absolute_name.rpartition('.')         parent_module = import_module(parent_name)         path = parent_module.__spec__.submodule_search_locations     for finder in sys.meta_path:         spec = finder.find_spec(absolute_name, path)         if spec is not None:             break     else:         msg = f'No module named {absolute_name!r}'         raise ModuleNotFoundError(msg, name=absolute_name)     module = importlib.util.module_from_spec(spec)     sys.modules[absolute_name] = module     spec.loader.exec_module(module)     if path is not None:         setattr(parent_module, child_name, module)     return module


File: python.info,  Node: Using importlib metadata,  Prev: importlib — The implementation of import,  Up: Importing Modules

5.32.6 Using importlib.metadata
-------------------------------

     Note: This functionality is provisional and may deviate from the
     usual version semantics of the standard library.

‘importlib.metadata’ is a library that provides for access to installed
package metadata.  Built in part on Python’s import system, this library
intends to replace similar functionality in the entry point API(1) and
metadata API(2) of ‘pkg_resources’.  Along with ‘importlib.resources’ in
Python 3.7 and newer(3) (backported as importlib_resources(4) for older
versions of Python), this can eliminate the need to use the older and
less efficient ‘pkg_resources’ package.

By “installed package” we generally mean a third-party package installed
into Python’s ‘site-packages’ directory via tools such as pip(5).
Specifically, it means a package with either a discoverable ‘dist-info’
or ‘egg-info’ directory, and metadata defined by PEP 566(6) or its older
specifications.  By default, package metadata can live on the file
system or in zip archives on ‘sys.path’.  Through an extension
mechanism, the metadata can live almost anywhere.

* Menu:

* Overview: Overview<2>.
* Functional API: Functional API<2>.
* Distributions::
* Extending the search algorithm::

   ---------- Footnotes ----------

   (1) 
https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points

   (2) 
https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api

   (3) 
https://docs.python.org/3/library/importlib.html#module-importlib.resources

   (4) https://importlib-resources.readthedocs.io/en/latest/index.html

   (5) https://pypi.org/project/pip/

   (6) https://www.python.org/dev/peps/pep-0566/


File: python.info,  Node: Overview<2>,  Next: Functional API<2>,  Up: Using importlib metadata

5.32.6.1 Overview
.................

Let’s say you wanted to get the version string for a package you’ve
installed using ‘pip’.  We start by creating a virtual environment and
installing something into it:

     $ python3 -m venv example $ source example/bin/activate (example) $ pip install wheel

You can get the version string for ‘wheel’ by running the following:

     (example) $ python >>> from importlib.metadata import version   >>> version('wheel')   '0.32.3'

You can also get the set of entry points keyed by group, such as
‘console_scripts’, ‘distutils.commands’ and others.  Each group contains
a sequence of *note EntryPoint: 36e4. objects.

You can get the *note metadata for a distribution: 36e5.:

     >>> list(metadata('wheel'))   ['Metadata-Version', 'Name', 'Version', 'Summary', 'Home-page', 'Author', 'Author-email', 'Maintainer', 'Maintainer-email', 'License', 'Project-URL', 'Project-URL', 'Project-URL', 'Keywords', 'Platform', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Requires-Python', 'Provides-Extra', 'Requires-Dist', 'Requires-Dist']

You can also get a *note distribution’s version number: 36e6, list its
*note constituent files: 36e7, and get a list of the distribution’s
*note Distribution requirements: 36e8.


File: python.info,  Node: Functional API<2>,  Next: Distributions,  Prev: Overview<2>,  Up: Using importlib metadata

5.32.6.2 Functional API
.......................

This package provides the following functionality via its public API.

* Menu:

* Entry points::
* Distribution metadata::
* Distribution versions::
* Distribution files::
* Distribution requirements::


File: python.info,  Node: Entry points,  Next: Distribution metadata,  Up: Functional API<2>

5.32.6.3 Entry points
.....................

The ‘entry_points()’ function returns a dictionary of all entry points,
keyed by group.  Entry points are represented by ‘EntryPoint’ instances;
each ‘EntryPoint’ has a ‘.name’, ‘.group’, and ‘.value’ attributes and a
‘.load()’ method to resolve the value.

     >>> eps = entry_points()  # doctest: +SKIP >>> list(eps)  # doctest: +SKIP ['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation'] >>> scripts = eps['console_scripts']  # doctest: +SKIP >>> wheel = [ep for ep in scripts if ep.name == 'wheel'][0]  # doctest: +SKIP >>> wheel  # doctest: +SKIP EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts') >>> main = wheel.load()  # doctest: +SKIP >>> main  # doctest: +SKIP <function main at 0x103528488>

The ‘group’ and ‘name’ are arbitrary values defined by the package
author and usually a client will wish to resolve all entry points for a
particular group.  Read the setuptools docs(1) for more information on
entrypoints, their definition, and usage.

   ---------- Footnotes ----------

   (1) 
https://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins


File: python.info,  Node: Distribution metadata,  Next: Distribution versions,  Prev: Entry points,  Up: Functional API<2>

5.32.6.4 Distribution metadata
..............................

Every distribution includes some metadata, which you can extract using
the ‘metadata()’ function:

     >>> wheel_metadata = metadata('wheel')

The keys of the returned data structure (1) name the metadata keywords,
and their values are returned unparsed from the distribution metadata:

     >>> wheel_metadata['Requires-Python']   '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

   ---------- Footnotes ----------

   (1) (1) Technically, the returned distribution metadata object is an
email.message.Message
(https://docs.python.org/3/library/email.message.html#email.message.EmailMessage)
instance, but this is an implementation detail, and not part of the
stable API. You should only use dictionary-like methods and syntax to
access the metadata contents.


File: python.info,  Node: Distribution versions,  Next: Distribution files,  Prev: Distribution metadata,  Up: Functional API<2>

5.32.6.5 Distribution versions
..............................

The ‘version()’ function is the quickest way to get a distribution’s
version number, as a string:

     >>> version('wheel')   '0.32.3'


File: python.info,  Node: Distribution files,  Next: Distribution requirements,  Prev: Distribution versions,  Up: Functional API<2>

5.32.6.6 Distribution files
...........................

You can also get the full set of files contained within a distribution.
The ‘files()’ function takes a distribution package name and returns all
of the files installed by this distribution.  Each file object returned
is a ‘PackagePath’, a pathlib.Path(1) derived object with additional
‘dist’, ‘size’, and ‘hash’ properties as indicated by the metadata.  For
example:

     >>> util = [p for p in files('wheel') if 'util.py' in str(p)][0]   >>> util   PackagePath('wheel/util.py') >>> util.size   859 >>> util.dist   <importlib.metadata._hooks.PathDistribution object at 0x101e0cef0> >>> util.hash   <FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI>

Once you have the file, you can also read its contents:

     >>> print(util.read_text())   import base64 import sys ... def as_bytes(s):     if isinstance(s, text_type):         return s.encode('utf-8')     return s

In the case where the metadata file listing files (RECORD or
SOURCES.txt) is missing, ‘files()’ will return ‘None’.  The caller may
wish to wrap calls to ‘files()’ in always_iterable(2) or otherwise guard
against this condition if the target distribution is not known to have
the metadata present.

   ---------- Footnotes ----------

   (1) https://docs.python.org/3/library/pathlib.html#pathlib.Path

   (2) 
https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable


File: python.info,  Node: Distribution requirements,  Prev: Distribution files,  Up: Functional API<2>

5.32.6.7 Distribution requirements
..................................

To get the full set of requirements for a distribution, use the
‘requires()’ function:

     >>> requires('wheel')   ["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]


File: python.info,  Node: Distributions,  Next: Extending the search algorithm,  Prev: Functional API<2>,  Up: Using importlib metadata

5.32.6.8 Distributions
......................

While the above API is the most common and convenient usage, you can get
all of that information from the ‘Distribution’ class.  A ‘Distribution’
is an abstract object that represents the metadata for a Python package.
You can get the ‘Distribution’ instance:

     >>> from importlib.metadata import distribution   >>> dist = distribution('wheel')

Thus, an alternative way to get the version number is through the
‘Distribution’ instance:

     >>> dist.version   '0.32.3'

There are all kinds of additional metadata available on the
‘Distribution’ instance:

     >>> d.metadata['Requires-Python']   '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*' >>> d.metadata['License']   'MIT'

The full set of available metadata is not described here.  See PEP
566(1) for additional details.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0566/


File: python.info,  Node: Extending the search algorithm,  Prev: Distributions,  Up: Using importlib metadata

5.32.6.9 Extending the search algorithm
.......................................

Because package metadata is not available through ‘sys.path’ searches,
or package loaders directly, the metadata for a package is found through
import system finders(1).  To find a distribution package’s metadata,
‘importlib.metadata’ queries the list of meta path finders(2) on
sys.meta_path(3).

The default ‘PathFinder’ for Python includes a hook that calls into
‘importlib.metadata.MetadataPathFinder’ for finding distributions loaded
from typical file-system-based paths.

The abstract class *note importlib.abc.MetaPathFinder: 9a7. defines the
interface expected of finders by Python’s import system.
‘importlib.metadata’ extends this protocol by looking for an optional
‘find_distributions’ callable on the finders from ‘sys.meta_path’ and
presents this extended interface as the ‘DistributionFinder’ abstract
base class, which defines this abstract method:

     @abc.abstractmethod def find_distributions(context=DistributionFinder.Context()):     """Return an iterable of all Distribution instances capable of     loading the metadata for packages for the indicated ``context``.     """

The ‘DistributionFinder.Context’ object provides ‘.path’ and ‘.name’
properties indicating the path to search and names to match and may
supply other relevant context.

What this means in practice is that to support finding distribution
package metadata in locations other than the file system, subclass
‘Distribution’ and implement the abstract methods.  Then from a custom
finder, return instances of this derived ‘Distribution’ in the
‘find_distributions()’ method.

   ---------- Footnotes ----------

   (1) 
https://docs.python.org/3/reference/import.html#finders-and-loaders

   (2) https://docs.python.org/3/glossary.html#term-meta-path-finder

   (3) https://docs.python.org/3/library/sys.html#sys.meta_path


File: python.info,  Node: Python Language Services,  Next: Miscellaneous Services,  Prev: Importing Modules,  Up: The Python Standard Library

5.33 Python Language Services
=============================

Python provides a number of modules to assist in working with the Python
language.  These modules support tokenizing, parsing, syntax analysis,
bytecode disassembly, and various other facilities.

These modules include:

* Menu:

* parser — Access Python parse trees::
* ast — Abstract Syntax Trees::
* symtable — Access to the compiler’s symbol tables::
* symbol — Constants used with Python parse trees::
* token — Constants used with Python parse trees::
* keyword — Testing for Python keywords::
* tokenize — Tokenizer for Python source::
* tabnanny — Detection of ambiguous indentation::
* pyclbr — Python class browser support::
* py_compile — Compile Python source files::
* compileall — Byte-compile Python libraries::
* dis — Disassembler for Python bytecode::
* pickletools — Tools for pickle developers::


File: python.info,  Node: parser — Access Python parse trees,  Next: ast — Abstract Syntax Trees,  Up: Python Language Services

5.33.1 ‘parser’ — Access Python parse trees
-------------------------------------------

__________________________________________________________________

The *note parser: c7. module provides an interface to Python’s internal
parser and byte-code compiler.  The primary purpose for this interface
is to allow Python code to edit the parse tree of a Python expression
and create executable code from this.  This is better than trying to
parse and modify an arbitrary Python code fragment as a string because
parsing is performed in a manner identical to the code forming the
application.  It is also faster.

     Note: From Python 2.5 onward, it’s much more convenient to cut in
     at the Abstract Syntax Tree (AST) generation and compilation stage,
     using the *note ast: 8. module.

There are a few things to note about this module which are important to
making use of the data structures created.  This is not a tutorial on
editing the parse trees for Python code, but some examples of using the
*note parser: c7. module are presented.

Most importantly, a good understanding of the Python grammar processed
by the internal parser is required.  For full information on the
language syntax, refer to *note The Python Language Reference: 1136.
The parser itself is created from a grammar specification defined in the
file ‘Grammar/Grammar’ in the standard Python distribution.  The parse
trees stored in the ST objects created by this module are the actual
output from the internal parser when created by the *note expr(): 36f6.
or *note suite(): 36f7. functions, described below.  The ST objects
created by *note sequence2st(): 36f8. faithfully simulate those
structures.  Be aware that the values of the sequences which are
considered “correct” will vary from one version of Python to another as
the formal grammar for the language is revised.  However, transporting
code from one Python version to another as source text will always allow
correct parse trees to be created in the target version, with the only
restriction being that migrating to an older version of the interpreter
will not support more recent language constructs.  The parse trees are
not typically compatible from one version to another, though source code
has usually been forward-compatible within a major release series.

Each element of the sequences returned by *note st2list(): 36f9. or
*note st2tuple(): 36fa. has a simple form.  Sequences representing
non-terminal elements in the grammar always have a length greater than
one.  The first element is an integer which identifies a production in
the grammar.  These integers are given symbolic names in the C header
file ‘Include/graminit.h’ and the Python module *note symbol: fb.  Each
additional element of the sequence represents a component of the
production as recognized in the input string: these are always sequences
which have the same form as the parent.  An important aspect of this
structure which should be noted is that keywords used to identify the
parent node type, such as the keyword *note if: dda. in an ‘if_stmt’,
are included in the node tree without any special treatment.  For
example, the ‘if’ keyword is represented by the tuple ‘(1, 'if')’, where
‘1’ is the numeric value associated with all ‘NAME’ tokens, including
variable and function names defined by the user.  In an alternate form
returned when line number information is requested, the same token might
be represented as ‘(1, 'if', 12)’, where the ‘12’ represents the line
number at which the terminal symbol was found.

Terminal elements are represented in much the same way, but without any
child elements and the addition of the source text which was identified.
The example of the *note if: dda. keyword above is representative.  The
various types of terminal symbols are defined in the C header file
‘Include/token.h’ and the Python module *note token: 110.

The ST objects are not required to support the functionality of this
module, but are provided for three purposes: to allow an application to
amortize the cost of processing complex parse trees, to provide a parse
tree representation which conserves memory space when compared to the
Python list or tuple representation, and to ease the creation of
additional modules in C which manipulate parse trees.  A simple
“wrapper” class may be created in Python to hide the use of ST objects.

The *note parser: c7. module defines functions for a few distinct
purposes.  The most important purposes are to create ST objects and to
convert ST objects to other representations such as parse trees and
compiled code objects, but there are also functions which serve to query
the type of parse tree represented by an ST object.

See also
........

Module *note symbol: fb.

     Useful constants representing internal nodes of the parse tree.

Module *note token: 110.

     Useful constants representing leaf nodes of the parse tree and
     functions for testing node values.

* Menu:

* Creating ST Objects::
* Converting ST Objects::
* Queries on ST Objects::
* Exceptions and Error Handling::
* ST Objects::
* Example; Emulation of compile(): Example Emulation of compile.


File: python.info,  Node: Creating ST Objects,  Next: Converting ST Objects,  Up: parser — Access Python parse trees

5.33.1.1 Creating ST Objects
............................

ST objects may be created from source code or from a parse tree.  When
creating an ST object from source, different functions are used to
create the ‘'eval'’ and ‘'exec'’ forms.

 -- Function: parser.expr (source)

     The *note expr(): 36f6. function parses the parameter `source' as
     if it were an input to ‘compile(source, 'file.py', 'eval')’.  If
     the parse succeeds, an ST object is created to hold the internal
     parse tree representation, otherwise an appropriate exception is
     raised.

 -- Function: parser.suite (source)

     The *note suite(): 36f7. function parses the parameter `source' as
     if it were an input to ‘compile(source, 'file.py', 'exec')’.  If
     the parse succeeds, an ST object is created to hold the internal
     parse tree representation, otherwise an appropriate exception is
     raised.

 -- Function: parser.sequence2st (sequence)

     This function accepts a parse tree represented as a sequence and
     builds an internal representation if possible.  If it can validate
     that the tree conforms to the Python grammar and all nodes are
     valid node types in the host version of Python, an ST object is
     created from the internal representation and returned to the
     called.  If there is a problem creating the internal
     representation, or if the tree cannot be validated, a *note
     ParserError: 36fd. exception is raised.  An ST object created this
     way should not be assumed to compile correctly; normal exceptions
     raised by compilation may still be initiated when the ST object is
     passed to *note compilest(): 36fe.  This may indicate problems not
     related to syntax (such as a *note MemoryError: f42. exception),
     but may also be due to constructs such as the result of parsing
     ‘del f(0)’, which escapes the Python parser but is checked by the
     bytecode compiler.

     Sequences representing terminal tokens may be represented as either
     two-element lists of the form ‘(1, 'name')’ or as three-element
     lists of the form ‘(1, 'name', 56)’.  If the third element is
     present, it is assumed to be a valid line number.  The line number
     may be specified for any subset of the terminal symbols in the
     input tree.

 -- Function: parser.tuple2st (sequence)

     This is the same function as *note sequence2st(): 36f8.  This entry
     point is maintained for backward compatibility.


File: python.info,  Node: Converting ST Objects,  Next: Queries on ST Objects,  Prev: Creating ST Objects,  Up: parser — Access Python parse trees

5.33.1.2 Converting ST Objects
..............................

ST objects, regardless of the input used to create them, may be
converted to parse trees represented as list- or tuple- trees, or may be
compiled into executable code objects.  Parse trees may be extracted
with or without line numbering information.

 -- Function: parser.st2list (st, line_info=False, col_info=False)

     This function accepts an ST object from the caller in `st' and
     returns a Python list representing the equivalent parse tree.  The
     resulting list representation can be used for inspection or the
     creation of a new parse tree in list form.  This function does not
     fail so long as memory is available to build the list
     representation.  If the parse tree will only be used for
     inspection, *note st2tuple(): 36fa. should be used instead to
     reduce memory consumption and fragmentation.  When the list
     representation is required, this function is significantly faster
     than retrieving a tuple representation and converting that to
     nested lists.

     If `line_info' is true, line number information will be included
     for all terminal tokens as a third element of the list representing
     the token.  Note that the line number provided specifies the line
     on which the token `ends'.  This information is omitted if the flag
     is false or omitted.

 -- Function: parser.st2tuple (st, line_info=False, col_info=False)

     This function accepts an ST object from the caller in `st' and
     returns a Python tuple representing the equivalent parse tree.
     Other than returning a tuple instead of a list, this function is
     identical to *note st2list(): 36f9.

     If `line_info' is true, line number information will be included
     for all terminal tokens as a third element of the list representing
     the token.  This information is omitted if the flag is false or
     omitted.

 -- Function: parser.compilest (st, filename='<syntax-tree>')

     The Python byte compiler can be invoked on an ST object to produce
     code objects which can be used as part of a call to the built-in
     *note exec(): c37. or *note eval(): b83. functions.  This function
     provides the interface to the compiler, passing the internal parse
     tree from `st' to the parser, using the source file name specified
     by the `filename' parameter.  The default value supplied for
     `filename' indicates that the source was an ST object.

     Compiling an ST object may result in exceptions related to
     compilation; an example would be a *note SyntaxError: 44d. caused
     by the parse tree for ‘del f(0)’: this statement is considered
     legal within the formal grammar for Python but is not a legal
     language construct.  The *note SyntaxError: 44d. raised for this
     condition is actually generated by the Python byte-compiler
     normally, which is why it can be raised at this point by the *note
     parser: c7. module.  Most causes of compilation failure can be
     diagnosed programmatically by inspection of the parse tree.


File: python.info,  Node: Queries on ST Objects,  Next: Exceptions and Error Handling,  Prev: Converting ST Objects,  Up: parser — Access Python parse trees

5.33.1.3 Queries on ST Objects
..............................

Two functions are provided which allow an application to determine if an
ST was created as an expression or a suite.  Neither of these functions
can be used to determine if an ST was created from source code via *note
expr(): 36f6. or *note suite(): 36f7. or from a parse tree via *note
sequence2st(): 36f8.

 -- Function: parser.isexpr (st)

     When `st' represents an ‘'eval'’ form, this function returns
     ‘True’, otherwise it returns ‘False’.  This is useful, since code
     objects normally cannot be queried for this information using
     existing built-in functions.  Note that the code objects created by
     *note compilest(): 36fe. cannot be queried like this either, and
     are identical to those created by the built-in *note compile():
     1b2. function.

 -- Function: parser.issuite (st)

     This function mirrors *note isexpr(): 3704. in that it reports
     whether an ST object represents an ‘'exec'’ form, commonly known as
     a “suite.” It is not safe to assume that this function is
     equivalent to ‘not isexpr(st)’, as additional syntactic fragments
     may be supported in the future.


File: python.info,  Node: Exceptions and Error Handling,  Next: ST Objects,  Prev: Queries on ST Objects,  Up: parser — Access Python parse trees

5.33.1.4 Exceptions and Error Handling
......................................

The parser module defines a single exception, but may also pass other
built-in exceptions from other portions of the Python runtime
environment.  See each function for information about the exceptions it
can raise.

 -- Exception: parser.ParserError

     Exception raised when a failure occurs within the parser module.
     This is generally produced for validation failures rather than the
     built-in *note SyntaxError: 44d. raised during normal parsing.  The
     exception argument is either a string describing the reason of the
     failure or a tuple containing a sequence causing the failure from a
     parse tree passed to *note sequence2st(): 36f8. and an explanatory
     string.  Calls to *note sequence2st(): 36f8. need to be able to
     handle either type of exception, while calls to other functions in
     the module will only need to be aware of the simple string values.

Note that the functions *note compilest(): 36fe, *note expr(): 36f6, and
*note suite(): 36f7. may raise exceptions which are normally raised by
the parsing and compilation process.  These include the built in
exceptions *note MemoryError: f42, *note OverflowError: 954, *note
SyntaxError: 44d, and *note SystemError: 5f0.  In these cases, these
exceptions carry all the meaning normally associated with them.  Refer
to the descriptions of each function for detailed information.


File: python.info,  Node: ST Objects,  Next: Example Emulation of compile,  Prev: Exceptions and Error Handling,  Up: parser — Access Python parse trees

5.33.1.5 ST Objects
...................

Ordered and equality comparisons are supported between ST objects.
Pickling of ST objects (using the *note pickle: ca. module) is also
supported.

 -- Data: parser.STType

     The type of the objects returned by *note expr(): 36f6, *note
     suite(): 36f7. and *note sequence2st(): 36f8.

ST objects have the following methods:

 -- Method: ST.compile (filename='<syntax-tree>')

     Same as ‘compilest(st, filename)’.

 -- Method: ST.isexpr ()

     Same as ‘isexpr(st)’.

 -- Method: ST.issuite ()

     Same as ‘issuite(st)’.

 -- Method: ST.tolist (line_info=False, col_info=False)

     Same as ‘st2list(st, line_info, col_info)’.

 -- Method: ST.totuple (line_info=False, col_info=False)

     Same as ‘st2tuple(st, line_info, col_info)’.


File: python.info,  Node: Example Emulation of compile,  Prev: ST Objects,  Up: parser — Access Python parse trees

5.33.1.6 Example: Emulation of ‘compile()’
..........................................

While many useful operations may take place between parsing and bytecode
generation, the simplest operation is to do nothing.  For this purpose,
using the *note parser: c7. module to produce an intermediate data
structure is equivalent to the code

     >>> code = compile('a + 5', 'file.py', 'eval') >>> a = 5 >>> eval(code) 10

The equivalent operation using the *note parser: c7. module is somewhat
longer, and allows the intermediate internal parse tree to be retained
as an ST object:

     >>> import parser >>> st = parser.expr('a + 5') >>> code = st.compile('file.py') >>> a = 5 >>> eval(code) 10

An application which needs both ST and code objects can package this
code into readily available functions:

     import parser  def load_suite(source_string):     st = parser.suite(source_string)     return st, st.compile()  def load_expression(source_string):     st = parser.expr(source_string)     return st, st.compile()


File: python.info,  Node: ast — Abstract Syntax Trees,  Next: symtable — Access to the compiler’s symbol tables,  Prev: parser — Access Python parse trees,  Up: Python Language Services

5.33.2 ‘ast’ — Abstract Syntax Trees
------------------------------------

`Source code:' Lib/ast.py(1)

__________________________________________________________________

The *note ast: 8. module helps Python applications to process trees of
the Python abstract syntax grammar.  The abstract syntax itself might
change with each Python release; this module helps to find out
programmatically what the current grammar looks like.

An abstract syntax tree can be generated by passing ‘ast.PyCF_ONLY_AST’
as a flag to the *note compile(): 1b2. built-in function, or using the
*note parse(): 1a0. helper provided in this module.  The result will be
a tree of objects whose classes all inherit from *note ast.AST: 3713.
An abstract syntax tree can be compiled into a Python code object using
the built-in *note compile(): 1b2. function.

* Menu:

* Node classes::
* Abstract Grammar::
* ast Helpers::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/ast.py


File: python.info,  Node: Node classes,  Next: Abstract Grammar,  Up: ast — Abstract Syntax Trees

5.33.2.1 Node classes
.....................

 -- Class: ast.AST

     This is the base of all AST node classes.  The actual node classes
     are derived from the ‘Parser/Python.asdl’ file, which is reproduced
     *note below: 3715.  They are defined in the ‘_ast’ C module and
     re-exported in *note ast: 8.

     There is one class defined for each left-hand side symbol in the
     abstract grammar (for example, ‘ast.stmt’ or ‘ast.expr’).  In
     addition, there is one class defined for each constructor on the
     right-hand side; these classes inherit from the classes for the
     left-hand side trees.  For example, ‘ast.BinOp’ inherits from
     ‘ast.expr’.  For production rules with alternatives (aka “sums”),
     the left-hand side class is abstract: only instances of specific
     constructor nodes are ever created.

      -- Attribute: _fields

          Each concrete class has an attribute *note _fields: 3716.
          which gives the names of all child nodes.

          Each instance of a concrete class has one attribute for each
          child node, of the type as defined in the grammar.  For
          example, ‘ast.BinOp’ instances have an attribute ‘left’ of
          type ‘ast.expr’.

          If these attributes are marked as optional in the grammar
          (using a question mark), the value might be ‘None’.  If the
          attributes can have zero-or-more values (marked with an
          asterisk), the values are represented as Python lists.  All
          possible attributes must be present and have valid values when
          compiling an AST with *note compile(): 1b2.

      -- Attribute: lineno
      -- Attribute: col_offset
      -- Attribute: end_lineno
      -- Attribute: end_col_offset

          Instances of ‘ast.expr’ and ‘ast.stmt’ subclasses have *note
          lineno: 3717, *note col_offset: 3718, *note lineno: 3717, and
          *note col_offset: 3718. attributes.  The *note lineno: 3717.
          and *note end_lineno: 3719. are the first and last line
          numbers of source text span (1-indexed so the first line is
          line 1) and the *note col_offset: 3718. and *note
          end_col_offset: 371a. are the corresponding UTF-8 byte offsets
          of the first and last tokens that generated the node.  The
          UTF-8 offset is recorded because the parser uses UTF-8
          internally.

          Note that the end positions are not required by the compiler
          and are therefore optional.  The end offset is `after' the
          last symbol, for example one can get the source segment of a
          one-line expression node using ‘source_line[node.col_offset :
          node.end_col_offset]’.

     The constructor of a class ‘ast.T’ parses its arguments as follows:

        * If there are positional arguments, there must be as many as
          there are items in ‘T._fields’; they will be assigned as
          attributes of these names.

        * If there are keyword arguments, they will set the attributes
          of the same names to the given values.

     For example, to create and populate an ‘ast.UnaryOp’ node, you
     could use

          node = ast.UnaryOp() node.op = ast.USub() node.operand = ast.Constant() node.operand.value = 5 node.operand.lineno = 0 node.operand.col_offset = 0 node.lineno = 0 node.col_offset = 0

     or the more compact

          node = ast.UnaryOp(ast.USub(), ast.Constant(5, lineno=0, col_offset=0),                    lineno=0, col_offset=0)

Deprecated since version 3.8: Class ‘ast.Constant’ is now used for all
constants.  Old classes ‘ast.Num’, ‘ast.Str’, ‘ast.Bytes’,
‘ast.NameConstant’ and ‘ast.Ellipsis’ are still available, but they will
be removed in future Python releases.


File: python.info,  Node: Abstract Grammar,  Next: ast Helpers,  Prev: Node classes,  Up: ast — Abstract Syntax Trees

5.33.2.2 Abstract Grammar
.........................

The abstract grammar is currently defined as follows:

     -- ASDL's 5 builtin types are: -- identifier, int, string, object, constant  module Python {     mod = Module(stmt* body, type_ignore *type_ignores)         | Interactive(stmt* body)         | Expression(expr body)         | FunctionType(expr* argtypes, expr returns)          -- not really an actual node but useful in Jython's typesystem.         | Suite(stmt* body)      stmt = FunctionDef(identifier name, arguments args,                        stmt* body, expr* decorator_list, expr? returns,                        string? type_comment)           | AsyncFunctionDef(identifier name, arguments args,                              stmt* body, expr* decorator_list, expr? returns,                              string? type_comment)            | ClassDef(identifier name,              expr* bases,              keyword* keywords,              stmt* body,              expr* decorator_list)           | Return(expr? value)            | Delete(expr* targets)           | Assign(expr* targets, expr value, string? type_comment)           | AugAssign(expr target, operator op, expr value)           -- 'simple' indicates that we annotate simple name without parens           | AnnAssign(expr target, expr annotation, expr? value, int simple)            -- use 'orelse' because else is a keyword in target languages           | For(expr target, expr iter, stmt* body, stmt* orelse, string? type_comment)           | AsyncFor(expr target, expr iter, stmt* body, stmt* orelse, string? type_comment)           | While(expr test, stmt* body, stmt* orelse)           | If(expr test, stmt* body, stmt* orelse)           | With(withitem* items, stmt* body, string? type_comment)           | AsyncWith(withitem* items, stmt* body, string? type_comment)            | Raise(expr? exc, expr? cause)           | Try(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)           | Assert(expr test, expr? msg)            | Import(alias* names)           | ImportFrom(identifier? module, alias* names, int? level)            | Global(identifier* names)           | Nonlocal(identifier* names)           | Expr(expr value)           | Pass | Break | Continue            -- XXX Jython will be different           -- col_offset is the byte offset in the utf8 string the parser uses           attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)            -- BoolOp() can use left & right?     expr = BoolOp(boolop op, expr* values)          | NamedExpr(expr target, expr value)          | BinOp(expr left, operator op, expr right)          | UnaryOp(unaryop op, expr operand)          | Lambda(arguments args, expr body)          | IfExp(expr test, expr body, expr orelse)          | Dict(expr* keys, expr* values)          | Set(expr* elts)          | ListComp(expr elt, comprehension* generators)          | SetComp(expr elt, comprehension* generators)          | DictComp(expr key, expr value, comprehension* generators)          | GeneratorExp(expr elt, comprehension* generators)          -- the grammar constrains where yield expressions can occur          | Await(expr value)          | Yield(expr? value)          | YieldFrom(expr value)          -- need sequences for compare to distinguish between          -- x < 4 < 3 and (x < 4) < 3          | Compare(expr left, cmpop* ops, expr* comparators)          | Call(expr func, expr* args, keyword* keywords)          | FormattedValue(expr value, int? conversion, expr? format_spec)          | JoinedStr(expr* values)          | Constant(constant value, string? kind)           -- the following expression can appear in assignment context          | Attribute(expr value, identifier attr, expr_context ctx)          | Subscript(expr value, slice slice, expr_context ctx)          | Starred(expr value, expr_context ctx)          | Name(identifier id, expr_context ctx)          | List(expr* elts, expr_context ctx)          | Tuple(expr* elts, expr_context ctx)            -- col_offset is the byte offset in the utf8 string the parser uses           attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)      expr_context = Load | Store | Del | AugLoad | AugStore | Param      slice = Slice(expr? lower, expr? upper, expr? step)           | ExtSlice(slice* dims)           | Index(expr value)      boolop = And | Or      operator = Add | Sub | Mult | MatMult | Div | Mod | Pow | LShift                  | RShift | BitOr | BitXor | BitAnd | FloorDiv      unaryop = Invert | Not | UAdd | USub      cmpop = Eq | NotEq | Lt | LtE | Gt | GtE | Is | IsNot | In | NotIn      comprehension = (expr target, expr iter, expr* ifs, int is_async)      excepthandler = ExceptHandler(expr? type, identifier? name, stmt* body)                     attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)      arguments = (arg* posonlyargs, arg* args, arg? vararg, arg* kwonlyargs,                  expr* kw_defaults, arg? kwarg, expr* defaults)      arg = (identifier arg, expr? annotation, string? type_comment)            attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)      -- keyword arguments supplied to call (NULL identifier for **kwargs)     keyword = (identifier? arg, expr value)      -- import name with optional 'as' alias.     alias = (identifier name, identifier? asname)      withitem = (expr context_expr, expr? optional_vars)      type_ignore = TypeIgnore(int lineno, string tag) }


File: python.info,  Node: ast Helpers,  Prev: Abstract Grammar,  Up: ast — Abstract Syntax Trees

5.33.2.3 ‘ast’ Helpers
......................

Apart from the node classes, the *note ast: 8. module defines these
utility functions and classes for traversing abstract syntax trees:

 -- Function: ast.parse (source, filename='<unknown>', mode='exec', *,
          type_comments=False, feature_version=None)

     Parse the source into an AST node.  Equivalent to ‘compile(source,
     filename, mode, ast.PyCF_ONLY_AST)’.

     If ‘type_comments=True’ is given, the parser is modified to check
     and return type comments as specified by PEP 484(1) and PEP 526(2).
     This is equivalent to adding ‘ast.PyCF_TYPE_COMMENTS’ to the flags
     passed to *note compile(): 1b2.  This will report syntax errors for
     misplaced type comments.  Without this flag, type comments will be
     ignored, and the ‘type_comment’ field on selected AST nodes will
     always be ‘None’.  In addition, the locations of ‘# type: ignore’
     comments will be returned as the ‘type_ignores’ attribute of
     ‘Module’ (otherwise it is always an empty list).

     In addition, if ‘mode’ is ‘'func_type'’, the input syntax is
     modified to correspond to PEP 484(3) “signature type comments”,
     e.g.  ‘(str, int) -> List[str]’.

     Also, setting ‘feature_version’ to a tuple ‘(major, minor)’ will
     attempt to parse using that Python version’s grammar.  Currently
     ‘major’ must equal to ‘3’.  For example, setting
     ‘feature_version=(3, 4)’ will allow the use of ‘async’ and ‘await’
     as variable names.  The lowest supported version is ‘(3, 4)’; the
     highest is ‘sys.version_info[0:2]’.

          Warning: It is possible to crash the Python interpreter with a
          sufficiently large/complex string due to stack depth
          limitations in Python’s AST compiler.

     Changed in version 3.8: Added ‘type_comments’, ‘mode='func_type'’
     and ‘feature_version’.

 -- Function: ast.literal_eval (node_or_string)

     Safely evaluate an expression node or a string containing a Python
     literal or container display.  The string or node provided may only
     consist of the following Python literal structures: strings, bytes,
     numbers, tuples, lists, dicts, sets, booleans, and ‘None’.

     This can be used for safely evaluating strings containing Python
     values from untrusted sources without the need to parse the values
     oneself.  It is not capable of evaluating arbitrarily complex
     expressions, for example involving operators or indexing.

          Warning: It is possible to crash the Python interpreter with a
          sufficiently large/complex string due to stack depth
          limitations in Python’s AST compiler.

     Changed in version 3.2: Now allows bytes and set literals.

 -- Function: ast.get_docstring (node, clean=True)

     Return the docstring of the given `node' (which must be a
     ‘FunctionDef’, ‘AsyncFunctionDef’, ‘ClassDef’, or ‘Module’ node),
     or ‘None’ if it has no docstring.  If `clean' is true, clean up the
     docstring’s indentation with *note inspect.cleandoc(): 3619.

     Changed in version 3.5: ‘AsyncFunctionDef’ is now supported.

 -- Function: ast.get_source_segment (source, node, *, padded=False)

     Get source code segment of the `source' that generated `node'.  If
     some location information (‘lineno’, ‘end_lineno’, ‘col_offset’, or
     ‘end_col_offset’) is missing, return ‘None’.

     If `padded' is ‘True’, the first line of a multi-line statement
     will be padded with spaces to match its original position.

     New in version 3.8.

 -- Function: ast.fix_missing_locations (node)

     When you compile a node tree with *note compile(): 1b2, the
     compiler expects ‘lineno’ and ‘col_offset’ attributes for every
     node that supports them.  This is rather tedious to fill in for
     generated nodes, so this helper adds these attributes recursively
     where not already set, by setting them to the values of the parent
     node.  It works recursively starting at `node'.

 -- Function: ast.increment_lineno (node, n=1)

     Increment the line number and end line number of each node in the
     tree starting at `node' by `n'.  This is useful to “move code” to a
     different location in a file.

 -- Function: ast.copy_location (new_node, old_node)

     Copy source location (‘lineno’, ‘col_offset’, ‘end_lineno’, and
     ‘end_col_offset’) from `old_node' to `new_node' if possible, and
     return `new_node'.

 -- Function: ast.iter_fields (node)

     Yield a tuple of ‘(fieldname, value)’ for each field in
     ‘node._fields’ that is present on `node'.

 -- Function: ast.iter_child_nodes (node)

     Yield all direct child nodes of `node', that is, all fields that
     are nodes and all items of fields that are lists of nodes.

 -- Function: ast.walk (node)

     Recursively yield all descendant nodes in the tree starting at
     `node' (including `node' itself), in no specified order.  This is
     useful if you only want to modify nodes in place and don’t care
     about the context.

 -- Class: ast.NodeVisitor

     A node visitor base class that walks the abstract syntax tree and
     calls a visitor function for every node found.  This function may
     return a value which is forwarded by the *note visit(): 3723.
     method.

     This class is meant to be subclassed, with the subclass adding
     visitor methods.

      -- Method: visit (node)

          Visit a node.  The default implementation calls the method
          called ‘self.visit_`classname'’ where `classname' is the name
          of the node class, or *note generic_visit(): 3724. if that
          method doesn’t exist.

      -- Method: generic_visit (node)

          This visitor calls *note visit(): 3723. on all children of the
          node.

          Note that child nodes of nodes that have a custom visitor
          method won’t be visited unless the visitor calls *note
          generic_visit(): 3724. or visits them itself.

     Don’t use the *note NodeVisitor: 27f. if you want to apply changes
     to nodes during traversal.  For this a special visitor exists
     (*note NodeTransformer: 3725.) that allows modifications.

     Deprecated since version 3.8: Methods ‘visit_Num()’, ‘visit_Str()’,
     ‘visit_Bytes()’, ‘visit_NameConstant()’ and ‘visit_Ellipsis()’ are
     deprecated now and will not be called in future Python versions.
     Add the ‘visit_Constant()’ method to handle all constant nodes.

 -- Class: ast.NodeTransformer

     A *note NodeVisitor: 27f. subclass that walks the abstract syntax
     tree and allows modification of nodes.

     The *note NodeTransformer: 3725. will walk the AST and use the
     return value of the visitor methods to replace or remove the old
     node.  If the return value of the visitor method is ‘None’, the
     node will be removed from its location, otherwise it is replaced
     with the return value.  The return value may be the original node
     in which case no replacement takes place.

     Here is an example transformer that rewrites all occurrences of
     name lookups (‘foo’) to ‘data['foo']’:

          class RewriteName(NodeTransformer):      def visit_Name(self, node):         return copy_location(Subscript(             value=Name(id='data', ctx=Load()),             slice=Index(value=Constant(value=node.id)),             ctx=node.ctx         ), node)

     Keep in mind that if the node you’re operating on has child nodes
     you must either transform the child nodes yourself or call the
     ‘generic_visit()’ method for the node first.

     For nodes that were part of a collection of statements (that
     applies to all statement nodes), the visitor may also return a list
     of nodes rather than just a single node.

     Usually you use the transformer like this:

          node = YourTransformer().visit(node)

 -- Function: ast.dump (node, annotate_fields=True,
          include_attributes=False)

     Return a formatted dump of the tree in `node'.  This is mainly
     useful for debugging purposes.  If `annotate_fields' is true (by
     default), the returned string will show the names and the values
     for fields.  If `annotate_fields' is false, the result string will
     be more compact by omitting unambiguous field names.  Attributes
     such as line numbers and column offsets are not dumped by default.
     If this is wanted, `include_attributes' can be set to true.

See also
........

Green Tree Snakes(4), an external documentation resource, has good
details on working with Python ASTs.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484

   (2) https://www.python.org/dev/peps/pep-0526

   (3) https://www.python.org/dev/peps/pep-0484

   (4) https://greentreesnakes.readthedocs.io/


File: python.info,  Node: symtable — Access to the compiler’s symbol tables,  Next: symbol — Constants used with Python parse trees,  Prev: ast — Abstract Syntax Trees,  Up: Python Language Services

5.33.3 ‘symtable’ — Access to the compiler’s symbol tables
----------------------------------------------------------

`Source code:' Lib/symtable.py(1)

__________________________________________________________________

Symbol tables are generated by the compiler from AST just before
bytecode is generated.  The symbol table is responsible for calculating
the scope of every identifier in the code.  *note symtable: fc. provides
an interface to examine these tables.

* Menu:

* Generating Symbol Tables::
* Examining Symbol Tables::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/symtable.py


File: python.info,  Node: Generating Symbol Tables,  Next: Examining Symbol Tables,  Up: symtable — Access to the compiler’s symbol tables

5.33.3.1 Generating Symbol Tables
.................................

 -- Function: symtable.symtable (code, filename, compile_type)

     Return the toplevel *note SymbolTable: 3729. for the Python source
     `code'.  `filename' is the name of the file containing the code.
     `compile_type' is like the `mode' argument to *note compile(): 1b2.


File: python.info,  Node: Examining Symbol Tables,  Prev: Generating Symbol Tables,  Up: symtable — Access to the compiler’s symbol tables

5.33.3.2 Examining Symbol Tables
................................

 -- Class: symtable.SymbolTable

     A namespace table for a block.  The constructor is not public.

      -- Method: get_type ()

          Return the type of the symbol table.  Possible values are
          ‘'class'’, ‘'module'’, and ‘'function'’.

      -- Method: get_id ()

          Return the table’s identifier.

      -- Method: get_name ()

          Return the table’s name.  This is the name of the class if the
          table is for a class, the name of the function if the table is
          for a function, or ‘'top'’ if the table is global (*note
          get_type(): 372b. returns ‘'module'’).

      -- Method: get_lineno ()

          Return the number of the first line in the block this table
          represents.

      -- Method: is_optimized ()

          Return ‘True’ if the locals in this table can be optimized.

      -- Method: is_nested ()

          Return ‘True’ if the block is a nested class or function.

      -- Method: has_children ()

          Return ‘True’ if the block has nested namespaces within it.
          These can be obtained with *note get_children(): 3732.

      -- Method: has_exec ()

          Return ‘True’ if the block uses ‘exec’.

      -- Method: get_identifiers ()

          Return a list of names of symbols in this table.

      -- Method: lookup (name)

          Lookup `name' in the table and return a *note Symbol: 3736.
          instance.

      -- Method: get_symbols ()

          Return a list of *note Symbol: 3736. instances for names in
          the table.

      -- Method: get_children ()

          Return a list of the nested symbol tables.

 -- Class: symtable.Function

     A namespace for a function or method.  This class inherits *note
     SymbolTable: 3729.

      -- Method: get_parameters ()

          Return a tuple containing names of parameters to this
          function.

      -- Method: get_locals ()

          Return a tuple containing names of locals in this function.

      -- Method: get_globals ()

          Return a tuple containing names of globals in this function.

      -- Method: get_nonlocals ()

          Return a tuple containing names of nonlocals in this function.

      -- Method: get_frees ()

          Return a tuple containing names of free variables in this
          function.

 -- Class: symtable.Class

     A namespace of a class.  This class inherits *note SymbolTable:
     3729.

      -- Method: get_methods ()

          Return a tuple containing the names of methods declared in the
          class.

 -- Class: symtable.Symbol

     An entry in a *note SymbolTable: 3729. corresponding to an
     identifier in the source.  The constructor is not public.

      -- Method: get_name ()

          Return the symbol’s name.

      -- Method: is_referenced ()

          Return ‘True’ if the symbol is used in its block.

      -- Method: is_imported ()

          Return ‘True’ if the symbol is created from an import
          statement.

      -- Method: is_parameter ()

          Return ‘True’ if the symbol is a parameter.

      -- Method: is_global ()

          Return ‘True’ if the symbol is global.

      -- Method: is_nonlocal ()

          Return ‘True’ if the symbol is nonlocal.

      -- Method: is_declared_global ()

          Return ‘True’ if the symbol is declared global with a global
          statement.

      -- Method: is_local ()

          Return ‘True’ if the symbol is local to its block.

      -- Method: is_free ()

          Return ‘True’ if the symbol is referenced in its block, but
          not assigned to.

      -- Method: is_assigned ()

          Return ‘True’ if the symbol is assigned to in its block.

      -- Method: is_namespace ()

          Return ‘True’ if name binding introduces new namespace.

          If the name is used as the target of a function or class
          statement, this will be true.

          For example:

               >>> table = symtable.symtable("def some_func(): pass", "string", "exec") >>> table.lookup("some_func").is_namespace() True

          Note that a single name can be bound to multiple objects.  If
          the result is ‘True’, the name may also be bound to other
          objects, like an int or list, that does not introduce a new
          namespace.

      -- Method: get_namespaces ()

          Return a list of namespaces bound to this name.

      -- Method: get_namespace ()

          Return the namespace bound to this name.  If more than one
          namespace is bound, *note ValueError: 1f9. is raised.


File: python.info,  Node: symbol — Constants used with Python parse trees,  Next: token — Constants used with Python parse trees,  Prev: symtable — Access to the compiler’s symbol tables,  Up: Python Language Services

5.33.4 ‘symbol’ — Constants used with Python parse trees
--------------------------------------------------------

`Source code:' Lib/symbol.py(1)

__________________________________________________________________

This module provides constants which represent the numeric values of
internal nodes of the parse tree.  Unlike most Python constants, these
use lower-case names.  Refer to the file ‘Grammar/Grammar’ in the Python
distribution for the definitions of the names in the context of the
language grammar.  The specific numeric values which the names map to
may change between Python versions.

This module also provides one additional data object:

 -- Data: symbol.sym_name

     Dictionary mapping the numeric values of the constants defined in
     this module back to name strings, allowing more human-readable
     representation of parse trees to be generated.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/symbol.py


File: python.info,  Node: token — Constants used with Python parse trees,  Next: keyword — Testing for Python keywords,  Prev: symbol — Constants used with Python parse trees,  Up: Python Language Services

5.33.5 ‘token’ — Constants used with Python parse trees
-------------------------------------------------------

`Source code:' Lib/token.py(1)

__________________________________________________________________

This module provides constants which represent the numeric values of
leaf nodes of the parse tree (terminal tokens).  Refer to the file
‘Grammar/Grammar’ in the Python distribution for the definitions of the
names in the context of the language grammar.  The specific numeric
values which the names map to may change between Python versions.

The module also provides a mapping from numeric codes to names and some
functions.  The functions mirror definitions in the Python C header
files.

 -- Data: token.tok_name

     Dictionary mapping the numeric values of the constants defined in
     this module back to name strings, allowing more human-readable
     representation of parse trees to be generated.

 -- Function: token.ISTERMINAL (x)

     Return ‘True’ for terminal token values.

 -- Function: token.ISNONTERMINAL (x)

     Return ‘True’ for non-terminal token values.

 -- Function: token.ISEOF (x)

     Return ‘True’ if `x' is the marker indicating the end of input.

The token constants are:

 -- Data: token.ENDMARKER

 -- Data: token.NAME

 -- Data: token.NUMBER

 -- Data: token.STRING

 -- Data: token.NEWLINE

 -- Data: token.INDENT

 -- Data: token.DEDENT

 -- Data: token.LPAR

     Token value for ‘"("’.

 -- Data: token.RPAR

     Token value for ‘")"’.

 -- Data: token.LSQB

     Token value for ‘"["’.

 -- Data: token.RSQB

     Token value for ‘"]"’.

 -- Data: token.COLON

     Token value for ‘":"’.

 -- Data: token.COMMA

     Token value for ‘","’.

 -- Data: token.SEMI

     Token value for ‘";"’.

 -- Data: token.PLUS

     Token value for ‘"+"’.

 -- Data: token.MINUS

     Token value for ‘"-"’.

 -- Data: token.STAR

     Token value for ‘"*"’.

 -- Data: token.SLASH

     Token value for ‘"/"’.

 -- Data: token.VBAR

     Token value for ‘"|"’.

 -- Data: token.AMPER

     Token value for ‘"&"’.

 -- Data: token.LESS

     Token value for ‘"<"’.

 -- Data: token.GREATER

     Token value for ‘">"’.

 -- Data: token.EQUAL

     Token value for ‘"="’.

 -- Data: token.DOT

     Token value for ‘"."’.

 -- Data: token.PERCENT

     Token value for ‘"%"’.

 -- Data: token.LBRACE

     Token value for ‘"{"’.

 -- Data: token.RBRACE

     Token value for ‘"}"’.

 -- Data: token.EQEQUAL

     Token value for ‘"=="’.

 -- Data: token.NOTEQUAL

     Token value for ‘"!="’.

 -- Data: token.LESSEQUAL

     Token value for ‘"<="’.

 -- Data: token.GREATEREQUAL

     Token value for ‘">="’.

 -- Data: token.TILDE

     Token value for ‘"~"’.

 -- Data: token.CIRCUMFLEX

     Token value for ‘"^"’.

 -- Data: token.LEFTSHIFT

     Token value for ‘"<<"’.

 -- Data: token.RIGHTSHIFT

     Token value for ‘">>"’.

 -- Data: token.DOUBLESTAR

     Token value for ‘"**"’.

 -- Data: token.PLUSEQUAL

     Token value for ‘"+="’.

 -- Data: token.MINEQUAL

     Token value for ‘"-="’.

 -- Data: token.STAREQUAL

     Token value for ‘"*="’.

 -- Data: token.SLASHEQUAL

     Token value for ‘"/="’.

 -- Data: token.PERCENTEQUAL

     Token value for ‘"%="’.

 -- Data: token.AMPEREQUAL

     Token value for ‘"&="’.

 -- Data: token.VBAREQUAL

     Token value for ‘"|="’.

 -- Data: token.CIRCUMFLEXEQUAL

     Token value for ‘"^="’.

 -- Data: token.LEFTSHIFTEQUAL

     Token value for ‘"<<="’.

 -- Data: token.RIGHTSHIFTEQUAL

     Token value for ‘">>="’.

 -- Data: token.DOUBLESTAREQUAL

     Token value for ‘"**="’.

 -- Data: token.DOUBLESLASH

     Token value for ‘"//"’.

 -- Data: token.DOUBLESLASHEQUAL

     Token value for ‘"//="’.

 -- Data: token.AT

     Token value for ‘"@"’.

 -- Data: token.ATEQUAL

     Token value for ‘"@="’.

 -- Data: token.RARROW

     Token value for ‘"->"’.

 -- Data: token.ELLIPSIS

     Token value for ‘"..."’.

 -- Data: token.COLONEQUAL

     Token value for ‘":="’.

 -- Data: token.OP

 -- Data: token.AWAIT

 -- Data: token.ASYNC

 -- Data: token.TYPE_IGNORE

 -- Data: token.TYPE_COMMENT

 -- Data: token.ERRORTOKEN

 -- Data: token.N_TOKENS

 -- Data: token.NT_OFFSET

The following token type values aren’t used by the C tokenizer but are
needed for the *note tokenize: 111. module.

 -- Data: token.COMMENT

     Token value used to indicate a comment.

 -- Data: token.NL

     Token value used to indicate a non-terminating newline.  The *note
     NEWLINE: 3758. token indicates the end of a logical line of Python
     code; ‘NL’ tokens are generated when a logical line of code is
     continued over multiple physical lines.

 -- Data: token.ENCODING

     Token value that indicates the encoding used to decode the source
     bytes into text.  The first token returned by *note
     tokenize.tokenize(): c4e. will always be an ‘ENCODING’ token.

 -- Data: token.TYPE_COMMENT

     Token value indicating that a type comment was recognized.  Such
     tokens are only produced when *note ast.parse(): 1a0. is invoked
     with ‘type_comments=True’.

Changed in version 3.5: Added *note AWAIT: 378b. and *note ASYNC: 378c.
tokens.

Changed in version 3.7: Added *note COMMENT: 3792, *note NL: 3793. and
*note ENCODING: 3794. tokens.

Changed in version 3.7: Removed *note AWAIT: 378b. and *note ASYNC:
378c. tokens.  “async” and “await” are now tokenized as *note NAME:
3755. tokens.

Changed in version 3.8: Added *note TYPE_COMMENT: 378e.  Added *note
AWAIT: 378b. and *note ASYNC: 378c. tokens back (they’re needed to
support parsing older Python versions for *note ast.parse(): 1a0. with
‘feature_version’ set to 6 or lower).

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/token.py


File: python.info,  Node: keyword — Testing for Python keywords,  Next: tokenize — Tokenizer for Python source,  Prev: token — Constants used with Python parse trees,  Up: Python Language Services

5.33.6 ‘keyword’ — Testing for Python keywords
----------------------------------------------

`Source code:' Lib/keyword.py(1)

__________________________________________________________________

This module allows a Python program to determine if a string is a
keyword.

 -- Function: keyword.iskeyword (s)

     Return ‘True’ if `s' is a Python keyword.

 -- Data: keyword.kwlist

     Sequence containing all the keywords defined for the interpreter.
     If any keywords are defined to only be active when particular *note
     __future__: 0. statements are in effect, these will be included as
     well.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/keyword.py


File: python.info,  Node: tokenize — Tokenizer for Python source,  Next: tabnanny — Detection of ambiguous indentation,  Prev: keyword — Testing for Python keywords,  Up: Python Language Services

5.33.7 ‘tokenize’ — Tokenizer for Python source
-----------------------------------------------

`Source code:' Lib/tokenize.py(1)

__________________________________________________________________

The *note tokenize: 111. module provides a lexical scanner for Python
source code, implemented in Python.  The scanner in this module returns
comments as tokens as well, making it useful for implementing
“pretty-printers,” including colorizers for on-screen displays.

To simplify token stream handling, all *note operator: 1352. and *note
delimiter: 1353. tokens and *note Ellipsis: 1547. are returned using the
generic *note OP: 378a. token type.  The exact type can be determined by
checking the ‘exact_type’ property on the *note named tuple: a98.
returned from *note tokenize.tokenize(): c4e.

* Menu:

* Tokenizing Input::
* Command-Line Usage: Command-Line Usage<2>.
* Examples: Examples<30>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tokenize.py


File: python.info,  Node: Tokenizing Input,  Next: Command-Line Usage<2>,  Up: tokenize — Tokenizer for Python source

5.33.7.1 Tokenizing Input
.........................

The primary entry point is a *note generator: 996.:

 -- Function: tokenize.tokenize (readline)

     The *note tokenize(): c4e. generator requires one argument,
     `readline', which must be a callable object which provides the same
     interface as the *note io.IOBase.readline(): 163f. method of file
     objects.  Each call to the function should return one line of input
     as bytes.

     The generator produces 5-tuples with these members: the token type;
     the token string; a 2-tuple ‘(srow, scol)’ of ints specifying the
     row and column where the token begins in the source; a 2-tuple
     ‘(erow, ecol)’ of ints specifying the row and column where the
     token ends in the source; and the line on which the token was
     found.  The line passed (the last tuple item) is the `physical'
     line.  The 5 tuple is returned as a *note named tuple: a98. with
     the field names: ‘type string start end line’.

     The returned *note named tuple: a98. has an additional property
     named ‘exact_type’ that contains the exact operator type for *note
     OP: 378a. tokens.  For all other token types ‘exact_type’ equals
     the named tuple ‘type’ field.

     Changed in version 3.1: Added support for named tuples.

     Changed in version 3.3: Added support for ‘exact_type’.

     *note tokenize(): c4e. determines the source encoding of the file
     by looking for a UTF-8 BOM or encoding cookie, according to PEP
     263(1).

 -- Function: tokenize.generate_tokens (readline)

     Tokenize a source reading unicode strings instead of bytes.

     Like *note tokenize(): c4e, the `readline' argument is a callable
     returning a single line of input.  However, *note
     generate_tokens(): f6d. expects `readline' to return a str object
     rather than bytes.

     The result is an iterator yielding named tuples, exactly like *note
     tokenize(): c4e.  It does not yield an *note ENCODING: 3794. token.

All constants from the *note token: 110. module are also exported from
*note tokenize: 111.

Another function is provided to reverse the tokenization process.  This
is useful for creating tools that tokenize a script, modify the token
stream, and write back the modified script.

 -- Function: tokenize.untokenize (iterable)

     Converts tokens back into Python source code.  The `iterable' must
     return sequences with at least two elements, the token type and the
     token string.  Any additional sequence elements are ignored.

     The reconstructed script is returned as a single string.  The
     result is guaranteed to tokenize back to match the input so that
     the conversion is lossless and round-trips are assured.  The
     guarantee applies only to the token type and token string as the
     spacing between tokens (column positions) may change.

     It returns bytes, encoded using the *note ENCODING: 3794. token,
     which is the first token sequence output by *note tokenize(): c4e.
     If there is no encoding token in the input, it returns a str
     instead.

*note tokenize(): c4e. needs to detect the encoding of source files it
tokenizes.  The function it uses to do this is available:

 -- Function: tokenize.detect_encoding (readline)

     The *note detect_encoding(): 1bb9. function is used to detect the
     encoding that should be used to decode a Python source file.  It
     requires one argument, readline, in the same way as the *note
     tokenize(): c4e. generator.

     It will call readline a maximum of twice, and return the encoding
     used (as a string) and a list of any lines (not decoded from bytes)
     it has read in.

     It detects the encoding from the presence of a UTF-8 BOM or an
     encoding cookie as specified in PEP 263(2).  If both a BOM and a
     cookie are present, but disagree, a *note SyntaxError: 44d. will be
     raised.  Note that if the BOM is found, ‘'utf-8-sig'’ will be
     returned as an encoding.

     If no encoding is specified, then the default of ‘'utf-8'’ will be
     returned.

     Use *note open(): 1bb8. to open Python source files: it uses *note
     detect_encoding(): 1bb9. to detect the file encoding.

 -- Function: tokenize.open (filename)

     Open a file in read only mode using the encoding detected by *note
     detect_encoding(): 1bb9.

     New in version 3.2.

 -- Exception: tokenize.TokenError

     Raised when either a docstring or expression that may be split over
     several lines is not completed anywhere in the file, for example:

          """Beginning of docstring

     or:

          [1,  2,  3

Note that unclosed single-quoted strings do not cause an error to be
raised.  They are tokenized as *note ERRORTOKEN: 378f, followed by the
tokenization of their contents.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0263

   (2) https://www.python.org/dev/peps/pep-0263


File: python.info,  Node: Command-Line Usage<2>,  Next: Examples<30>,  Prev: Tokenizing Input,  Up: tokenize — Tokenizer for Python source

5.33.7.2 Command-Line Usage
...........................

New in version 3.3.

The *note tokenize: 111. module can be executed as a script from the
command line.  It is as simple as:

     python -m tokenize [-e] [filename.py]

The following options are accepted:

 -- Program Option: -h, --help

     show this help message and exit

 -- Program Option: -e, --exact

     display token names using the exact type

If ‘filename.py’ is specified its contents are tokenized to stdout.
Otherwise, tokenization is performed on stdin.


File: python.info,  Node: Examples<30>,  Prev: Command-Line Usage<2>,  Up: tokenize — Tokenizer for Python source

5.33.7.3 Examples
.................

Example of a script rewriter that transforms float literals into Decimal
objects:

     from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP from io import BytesIO  def decistmt(s):     """Substitute Decimals for floats in a string of statements.      >>> from decimal import Decimal     >>> s = 'print(+21.3e-5*-.1234/81.7)'     >>> decistmt(s)     "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))"      The format of the exponent is inherited from the platform C library.     Known cases are "e-007" (Windows) and "e-07" (not Windows).  Since     we're only showing 12 digits, and the 13th isn't close to 5, the     rest of the output should be platform-independent.      >>> exec(s)  #doctest: +ELLIPSIS     -3.21716034272e-0...7      Output from calculations with Decimal should be identical across all     platforms.      >>> exec(decistmt(s))     -3.217160342717258261933904529E-7     """     result = []     g = tokenize(BytesIO(s.encode('utf-8')).readline)  # tokenize the string     for toknum, tokval, _, _, _ in g:         if toknum == NUMBER and '.' in tokval:  # replace NUMBER tokens             result.extend([                 (NAME, 'Decimal'),                 (OP, '('),                 (STRING, repr(tokval)),                 (OP, ')')             ])         else:             result.append((toknum, tokval))     return untokenize(result).decode('utf-8')

Example of tokenizing from the command line.  The script:

     def say_hello():     print("Hello, World!")  say_hello()

will be tokenized to the following output where the first column is the
range of the line/column coordinates where the token is found, the
second column is the name of the token, and the final column is the
value of the token (if any)

     $ python -m tokenize hello.py 0,0-0,0:            ENCODING       'utf-8' 1,0-1,3:            NAME           'def' 1,4-1,13:           NAME           'say_hello' 1,13-1,14:          OP             '(' 1,14-1,15:          OP             ')' 1,15-1,16:          OP             ':' 1,16-1,17:          NEWLINE        '\n' 2,0-2,4:            INDENT         '    ' 2,4-2,9:            NAME           'print' 2,9-2,10:           OP             '(' 2,10-2,25:          STRING         '"Hello, World!"' 2,25-2,26:          OP             ')' 2,26-2,27:          NEWLINE        '\n' 3,0-3,1:            NL             '\n' 4,0-4,0:            DEDENT         '' 4,0-4,9:            NAME           'say_hello' 4,9-4,10:           OP             '(' 4,10-4,11:          OP             ')' 4,11-4,12:          NEWLINE        '\n' 5,0-5,0:            ENDMARKER      ''

The exact token type names can be displayed using the *note -e: 37a0.
option:

     $ python -m tokenize -e hello.py 0,0-0,0:            ENCODING       'utf-8' 1,0-1,3:            NAME           'def' 1,4-1,13:           NAME           'say_hello' 1,13-1,14:          LPAR           '(' 1,14-1,15:          RPAR           ')' 1,15-1,16:          COLON          ':' 1,16-1,17:          NEWLINE        '\n' 2,0-2,4:            INDENT         '    ' 2,4-2,9:            NAME           'print' 2,9-2,10:           LPAR           '(' 2,10-2,25:          STRING         '"Hello, World!"' 2,25-2,26:          RPAR           ')' 2,26-2,27:          NEWLINE        '\n' 3,0-3,1:            NL             '\n' 4,0-4,0:            DEDENT         '' 4,0-4,9:            NAME           'say_hello' 4,9-4,10:           LPAR           '(' 4,10-4,11:          RPAR           ')' 4,11-4,12:          NEWLINE        '\n' 5,0-5,0:            ENDMARKER      ''


File: python.info,  Node: tabnanny — Detection of ambiguous indentation,  Next: pyclbr — Python class browser support,  Prev: tokenize — Tokenizer for Python source,  Up: Python Language Services

5.33.8 ‘tabnanny’ — Detection of ambiguous indentation
------------------------------------------------------

`Source code:' Lib/tabnanny.py(1)

__________________________________________________________________

For the time being this module is intended to be called as a script.
However it is possible to import it into an IDE and use the function
*note check(): 37a4. described below.

     Note: The API provided by this module is likely to change in future
     releases; such changes may not be backward compatible.

 -- Function: tabnanny.check (file_or_dir)

     If `file_or_dir' is a directory and not a symbolic link, then
     recursively descend the directory tree named by `file_or_dir',
     checking all ‘.py’ files along the way.  If `file_or_dir' is an
     ordinary Python source file, it is checked for whitespace related
     problems.  The diagnostic messages are written to standard output
     using the *note print(): 87a. function.

 -- Data: tabnanny.verbose

     Flag indicating whether to print verbose messages.  This is
     incremented by the ‘-v’ option if called as a script.

 -- Data: tabnanny.filename_only

     Flag indicating whether to print only the filenames of files
     containing whitespace related problems.  This is set to true by the
     ‘-q’ option if called as a script.

 -- Exception: tabnanny.NannyNag

     Raised by *note process_tokens(): 37a8. if detecting an ambiguous
     indent.  Captured and handled in *note check(): 37a4.

 -- Function: tabnanny.process_tokens (tokens)

     This function is used by *note check(): 37a4. to process tokens
     generated by the *note tokenize: 111. module.

See also
........

Module *note tokenize: 111.

     Lexical scanner for Python source code.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tabnanny.py


File: python.info,  Node: pyclbr — Python class browser support,  Next: py_compile — Compile Python source files,  Prev: tabnanny — Detection of ambiguous indentation,  Up: Python Language Services

5.33.9 ‘pyclbr’ — Python class browser support
----------------------------------------------

`Source code:' Lib/pyclbr.py(1)

__________________________________________________________________

The *note pyclbr: d8. module provides limited information about the
functions, classes, and methods defined in a Python-coded module.  The
information is sufficient to implement a module browser.  The
information is extracted from the Python source code rather than by
importing the module, so this module is safe to use with untrusted code.
This restriction makes it impossible to use this module with modules not
implemented in Python, including all standard and optional extension
modules.

 -- Function: pyclbr.readmodule (module, path=None)

     Return a dictionary mapping module-level class names to class
     descriptors.  If possible, descriptors for imported base classes
     are included.  Parameter `module' is a string with the name of the
     module to read; it may be the name of a module within a package.
     If given, `path' is a sequence of directory paths prepended to
     ‘sys.path’, which is used to locate the module source code.

 -- Function: pyclbr.readmodule_ex (module, path=None)

     Return a dictionary-based tree containing a function or class
     descriptors for each function and class defined in the module with
     a ‘def’ or ‘class’ statement.  The returned dictionary maps
     module-level function and class names to their descriptors.  Nested
     objects are entered into the children dictionary of their parent.
     As with readmodule, `module' names the module to be read and `path'
     is prepended to sys.path.  If the module being read is a package,
     the returned dictionary has a key ‘'__path__'’ whose value is a
     list containing the package search path.

New in version 3.7: Descriptors for nested definitions.  They are
accessed through the new children attribute.  Each has a new parent
attribute.

The descriptors returned by these functions are instances of Function
and Class classes.  Users are not expected to create instances of these
classes.

* Menu:

* Function Objects::
* Class Objects: Class Objects<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pyclbr.py


File: python.info,  Node: Function Objects,  Next: Class Objects<2>,  Up: pyclbr — Python class browser support

5.33.9.1 Function Objects
.........................

Class ‘Function’ instances describe functions defined by def statements.
They have the following attributes:

 -- Attribute: Function.file

     Name of the file in which the function is defined.

 -- Attribute: Function.module

     The name of the module defining the function described.

 -- Attribute: Function.name

     The name of the function.

 -- Attribute: Function.lineno

     The line number in the file where the definition starts.

 -- Attribute: Function.parent

     For top-level functions, None.  For nested functions, the parent.

     New in version 3.7.

 -- Attribute: Function.children

     A dictionary mapping names to descriptors for nested functions and
     classes.

     New in version 3.7.


File: python.info,  Node: Class Objects<2>,  Prev: Function Objects,  Up: pyclbr — Python class browser support

5.33.9.2 Class Objects
......................

Class ‘Class’ instances describe classes defined by class statements.
They have the same attributes as Functions and two more.

 -- Attribute: Class.file

     Name of the file in which the class is defined.

 -- Attribute: Class.module

     The name of the module defining the class described.

 -- Attribute: Class.name

     The name of the class.

 -- Attribute: Class.lineno

     The line number in the file where the definition starts.

 -- Attribute: Class.parent

     For top-level classes, None.  For nested classes, the parent.

     New in version 3.7.

 -- Attribute: Class.children

     A dictionary mapping names to descriptors for nested functions and
     classes.

     New in version 3.7.

 -- Attribute: Class.super

     A list of ‘Class’ objects which describe the immediate base classes
     of the class being described.  Classes which are named as
     superclasses but which are not discoverable by *note
     readmodule_ex(): 10a3. are listed as a string with the class name
     instead of as ‘Class’ objects.

 -- Attribute: Class.methods

     A dictionary mapping method names to line numbers.  This can be
     derived from the newer children dictionary, but remains for
     back-compatibility.


File: python.info,  Node: py_compile — Compile Python source files,  Next: compileall — Byte-compile Python libraries,  Prev: pyclbr — Python class browser support,  Up: Python Language Services

5.33.10 ‘py_compile’ — Compile Python source files
--------------------------------------------------

`Source code:' Lib/py_compile.py(1)

__________________________________________________________________

The *note py_compile: d7. module provides a function to generate a
byte-code file from a source file, and another function used when the
module source file is invoked as a script.

Though not often needed, this function can be useful when installing
modules for shared use, especially if some of the users may not have
permission to write the byte-code cache files in the directory
containing the source code.

 -- Exception: py_compile.PyCompileError

     Exception raised when an error occurs while attempting to compile
     the file.

 -- Function: py_compile.compile (file, cfile=None, dfile=None,
          doraise=False, optimize=-1,
          invalidation_mode=PycInvalidationMode.TIMESTAMP)

     Compile a source file to byte-code and write out the byte-code
     cache file.  The source code is loaded from the file named `file'.
     The byte-code is written to `cfile', which defaults to the PEP
     3147(2)/ PEP 488(3) path, ending in ‘.pyc’.  For example, if `file'
     is ‘/foo/bar/baz.py’ `cfile' will default to
     ‘/foo/bar/__pycache__/baz.cpython-32.pyc’ for Python 3.2.  If
     `dfile' is specified, it is used as the name of the source file in
     error messages when instead of `file'.  If `doraise' is true, a
     *note PyCompileError: 37bf. is raised when an error is encountered
     while compiling `file'.  If `doraise' is false (the default), an
     error string is written to ‘sys.stderr’, but no exception is
     raised.  This function returns the path to byte-compiled file, i.e.
     whatever `cfile' value was used.

     The `doraise' and `quiet' arguments determine how errors are
     handled while compiling file.  If `quiet' is 0 or 1, and `doraise'
     is false, the default behaviour is enabled: an error string is
     written to ‘sys.stderr’, and the function returns ‘None’ instead of
     a path.  If `doraise' is true, a *note PyCompileError: 37bf. is
     raised instead.  However if `quiet' is 2, no message is written,
     and `doraise' has no effect.

     If the path that `cfile' becomes (either explicitly specified or
     computed) is a symlink or non-regular file, *note FileExistsError:
     94c. will be raised.  This is to act as a warning that import will
     turn those paths into regular files if it is allowed to write
     byte-compiled files to those paths.  This is a side-effect of
     import using file renaming to place the final byte-compiled file
     into place to prevent concurrent file writing issues.

     `optimize' controls the optimization level and is passed to the
     built-in *note compile(): 1b2. function.  The default of ‘-1’
     selects the optimization level of the current interpreter.

     `invalidation_mode' should be a member of the *note
     PycInvalidationMode: 37c0. enum and controls how the generated
     bytecode cache is invalidated at runtime.  The default is *note
     PycInvalidationMode.CHECKED_HASH: 37c1. if the ‘SOURCE_DATE_EPOCH’
     environment variable is set, otherwise the default is *note
     PycInvalidationMode.TIMESTAMP: 37c2.

     Changed in version 3.2: Changed default value of `cfile' to be PEP
     3147(4)-compliant.  Previous default was `file' + ‘'c'’ (‘'o'’ if
     optimization was enabled).  Also added the `optimize' parameter.

     Changed in version 3.4: Changed code to use *note importlib: 9b.
     for the byte-code cache file writing.  This means file
     creation/writing semantics now match what *note importlib: 9b.
     does, e.g.  permissions, write-and-move semantics, etc.  Also added
     the caveat that *note FileExistsError: 94c. is raised if `cfile' is
     a symlink or non-regular file.

     Changed in version 3.7: The `invalidation_mode' parameter was added
     as specified in PEP 552(5).  If the ‘SOURCE_DATE_EPOCH’ environment
     variable is set, `invalidation_mode' will be forced to *note
     PycInvalidationMode.CHECKED_HASH: 37c1.

     Changed in version 3.7.2: The ‘SOURCE_DATE_EPOCH’ environment
     variable no longer overrides the value of the `invalidation_mode'
     argument, and determines its default value instead.

     Changed in version 3.8: The `quiet' parameter was added.

 -- Class: py_compile.PycInvalidationMode

     A enumeration of possible methods the interpreter can use to
     determine whether a bytecode file is up to date with a source file.
     The ‘.pyc’ file indicates the desired invalidation mode in its
     header.  See *note Cached bytecode invalidation: 31e. for more
     information on how Python invalidates ‘.pyc’ files at runtime.

     New in version 3.7.

      -- Attribute: TIMESTAMP

          The ‘.pyc’ file includes the timestamp and size of the source
          file, which Python will compare against the metadata of the
          source file at runtime to determine if the ‘.pyc’ file needs
          to be regenerated.

      -- Attribute: CHECKED_HASH

          The ‘.pyc’ file includes a hash of the source file content,
          which Python will compare against the source at runtime to
          determine if the ‘.pyc’ file needs to be regenerated.

      -- Attribute: UNCHECKED_HASH

          Like *note CHECKED_HASH: 37c1, the ‘.pyc’ file includes a hash
          of the source file content.  However, Python will at runtime
          assume the ‘.pyc’ file is up to date and not validate the
          ‘.pyc’ against the source file at all.

          This option is useful when the ‘.pycs’ are kept up to date by
          some system external to Python like a build system.

 -- Function: py_compile.main (args=None)

     Compile several source files.  The files named in `args' (or on the
     command line, if `args' is ‘None’) are compiled and the resulting
     byte-code is cached in the normal manner.  This function does not
     search a directory structure to locate source files; it only
     compiles files named explicitly.  If ‘'-'’ is the only parameter in
     args, the list of files is taken from standard input.

     Changed in version 3.2: Added support for ‘'-'’.

When this module is run as a script, the *note main(): 37c4. is used to
compile all the files named on the command line.  The exit status is
nonzero if one of the files could not be compiled.

See also
........

Module *note compileall: 21.

     Utilities to compile all Python source files in a directory tree.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/py_compile.py

   (2) https://www.python.org/dev/peps/pep-3147

   (3) https://www.python.org/dev/peps/pep-0488

   (4) https://www.python.org/dev/peps/pep-3147

   (5) https://www.python.org/dev/peps/pep-0552


File: python.info,  Node: compileall — Byte-compile Python libraries,  Next: dis — Disassembler for Python bytecode,  Prev: py_compile — Compile Python source files,  Up: Python Language Services

5.33.11 ‘compileall’ — Byte-compile Python libraries
----------------------------------------------------

`Source code:' Lib/compileall.py(1)

__________________________________________________________________

This module provides some utility functions to support installing Python
libraries.  These functions compile Python source files in a directory
tree.  This module can be used to create the cached byte-code files at
library installation time, which makes them available for use even by
users who don’t have write permission to the library directories.

* Menu:

* Command-line use::
* Public functions::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/compileall.py


File: python.info,  Node: Command-line use,  Next: Public functions,  Up: compileall — Byte-compile Python libraries

5.33.11.1 Command-line use
..........................

This module can work as a script (using ‘python -m compileall’) to
compile Python sources.

 -- Program Option: directory ...
 -- Program Option: file ...

     Positional arguments are files to compile or directories that
     contain source files, traversed recursively.  If no argument is
     given, behave as if the command line was ‘-l <directories from
     sys.path>’.

 -- Program Option: -l

     Do not recurse into subdirectories, only compile source code files
     directly contained in the named or implied directories.

 -- Program Option: -f

     Force rebuild even if timestamps are up-to-date.

 -- Program Option: -q

     Do not print the list of files compiled.  If passed once, error
     messages will still be printed.  If passed twice (‘-qq’), all
     output is suppressed.

 -- Program Option: -d destdir

     Directory prepended to the path to each file being compiled.  This
     will appear in compilation time tracebacks, and is also compiled in
     to the byte-code file, where it will be used in tracebacks and
     other messages in cases where the source file does not exist at the
     time the byte-code file is executed.

 -- Program Option: -x regex

     regex is used to search the full path to each file considered for
     compilation, and if the regex produces a match, the file is
     skipped.

 -- Program Option: -i list

     Read the file ‘list’ and add each line that it contains to the list
     of files and directories to compile.  If ‘list’ is ‘-’, read lines
     from ‘stdin’.

 -- Program Option: -b

     Write the byte-code files to their legacy locations and names,
     which may overwrite byte-code files created by another version of
     Python.  The default is to write files to their PEP 3147(1)
     locations and names, which allows byte-code files from multiple
     versions of Python to coexist.

 -- Program Option: -r

     Control the maximum recursion level for subdirectories.  If this is
     given, then ‘-l’ option will not be taken into account.  ‘python -m
     compileall <directory> -r 0’ is equivalent to ‘python -m compileall
     <directory> -l’.

 -- Program Option: -j N

     Use `N' workers to compile the files within the given directory.
     If ‘0’ is used, then the result of *note os.cpu_count(): 873. will
     be used.

 -- Program Option: --invalidation-mode
          [timestamp|checked-hash|unchecked-hash]

     Control how the generated byte-code files are invalidated at
     runtime.  The ‘timestamp’ value, means that ‘.pyc’ files with the
     source timestamp and size embedded will be generated.  The
     ‘checked-hash’ and ‘unchecked-hash’ values cause hash-based pycs to
     be generated.  Hash-based pycs embed a hash of the source file
     contents rather than a timestamp.  See *note Cached bytecode
     invalidation: 31e. for more information on how Python validates
     bytecode cache files at runtime.  The default is ‘timestamp’ if the
     ‘SOURCE_DATE_EPOCH’ environment variable is not set, and
     ‘checked-hash’ if the ‘SOURCE_DATE_EPOCH’ environment variable is
     set.

Changed in version 3.2: Added the ‘-i’, ‘-b’ and ‘-h’ options.

Changed in version 3.5: Added the ‘-j’, ‘-r’, and ‘-qq’ options.  ‘-q’
option was changed to a multilevel value.  ‘-b’ will always produce a
byte-code file ending in ‘.pyc’, never ‘.pyo’.

Changed in version 3.7: Added the ‘--invalidation-mode’ option.

There is no command-line option to control the optimization level used
by the *note compile(): 1b2. function, because the Python interpreter
itself already provides the option: ‘python -O -m compileall’.

Similarly, the *note compile(): 1b2. function respects the *note
sys.pycache_prefix: 156. setting.  The generated bytecode cache will
only be useful if *note compile(): 1b2. is run with the same *note
sys.pycache_prefix: 156. (if any) that will be used at runtime.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: Public functions,  Prev: Command-line use,  Up: compileall — Byte-compile Python libraries

5.33.11.2 Public functions
..........................

 -- Function: compileall.compile_dir (dir, maxlevels=10, ddir=None,
          force=False, rx=None, quiet=0, legacy=False, optimize=-1,
          workers=1, invalidation_mode=None)

     Recursively descend the directory tree named by `dir', compiling
     all ‘.py’ files along the way.  Return a true value if all the
     files compiled successfully, and a false value otherwise.

     The `maxlevels' parameter is used to limit the depth of the
     recursion; it defaults to ‘10’.

     If `ddir' is given, it is prepended to the path to each file being
     compiled for use in compilation time tracebacks, and is also
     compiled in to the byte-code file, where it will be used in
     tracebacks and other messages in cases where the source file does
     not exist at the time the byte-code file is executed.

     If `force' is true, modules are re-compiled even if the timestamps
     are up to date.

     If `rx' is given, its search method is called on the complete path
     to each file considered for compilation, and if it returns a true
     value, the file is skipped.

     If `quiet' is ‘False’ or ‘0’ (the default), the filenames and other
     information are printed to standard out.  Set to ‘1’, only errors
     are printed.  Set to ‘2’, all output is suppressed.

     If `legacy' is true, byte-code files are written to their legacy
     locations and names, which may overwrite byte-code files created by
     another version of Python.  The default is to write files to their
     PEP 3147(1) locations and names, which allows byte-code files from
     multiple versions of Python to coexist.

     `optimize' specifies the optimization level for the compiler.  It
     is passed to the built-in *note compile(): 1b2. function.

     The argument `workers' specifies how many workers are used to
     compile files in parallel.  The default is to not use multiple
     workers.  If the platform can’t use multiple workers and `workers'
     argument is given, then sequential compilation will be used as a
     fallback.  If `workers' is 0, the number of cores in the system is
     used.  If `workers' is lower than ‘0’, a *note ValueError: 1f9.
     will be raised.

     `invalidation_mode' should be a member of the *note
     py_compile.PycInvalidationMode: 37c0. enum and controls how the
     generated pycs are invalidated at runtime.

     Changed in version 3.2: Added the `legacy' and `optimize'
     parameter.

     Changed in version 3.5: Added the `workers' parameter.

     Changed in version 3.5: `quiet' parameter was changed to a
     multilevel value.

     Changed in version 3.5: The `legacy' parameter only writes out
     ‘.pyc’ files, not ‘.pyo’ files no matter what the value of
     `optimize' is.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

     Changed in version 3.7: The `invalidation_mode' parameter was
     added.

     Changed in version 3.7.2: The `invalidation_mode' parameter’s
     default value is updated to None.

     Changed in version 3.8: Setting `workers' to 0 now chooses the
     optimal number of cores.

 -- Function: compileall.compile_file (fullname, ddir=None, force=False,
          rx=None, quiet=0, legacy=False, optimize=-1,
          invalidation_mode=None)

     Compile the file with path `fullname'.  Return a true value if the
     file compiled successfully, and a false value otherwise.

     If `ddir' is given, it is prepended to the path to the file being
     compiled for use in compilation time tracebacks, and is also
     compiled in to the byte-code file, where it will be used in
     tracebacks and other messages in cases where the source file does
     not exist at the time the byte-code file is executed.

     If `rx' is given, its search method is passed the full path name to
     the file being compiled, and if it returns a true value, the file
     is not compiled and ‘True’ is returned.

     If `quiet' is ‘False’ or ‘0’ (the default), the filenames and other
     information are printed to standard out.  Set to ‘1’, only errors
     are printed.  Set to ‘2’, all output is suppressed.

     If `legacy' is true, byte-code files are written to their legacy
     locations and names, which may overwrite byte-code files created by
     another version of Python.  The default is to write files to their
     PEP 3147(2) locations and names, which allows byte-code files from
     multiple versions of Python to coexist.

     `optimize' specifies the optimization level for the compiler.  It
     is passed to the built-in *note compile(): 1b2. function.

     `invalidation_mode' should be a member of the *note
     py_compile.PycInvalidationMode: 37c0. enum and controls how the
     generated pycs are invalidated at runtime.

     New in version 3.2.

     Changed in version 3.5: `quiet' parameter was changed to a
     multilevel value.

     Changed in version 3.5: The `legacy' parameter only writes out
     ‘.pyc’ files, not ‘.pyo’ files no matter what the value of
     `optimize' is.

     Changed in version 3.7: The `invalidation_mode' parameter was
     added.

     Changed in version 3.7.2: The `invalidation_mode' parameter’s
     default value is updated to None.

 -- Function: compileall.compile_path (skip_curdir=True, maxlevels=0,
          force=False, quiet=0, legacy=False, optimize=-1,
          invalidation_mode=None)

     Byte-compile all the ‘.py’ files found along ‘sys.path’.  Return a
     true value if all the files compiled successfully, and a false
     value otherwise.

     If `skip_curdir' is true (the default), the current directory is
     not included in the search.  All other parameters are passed to the
     *note compile_dir(): 367. function.  Note that unlike the other
     compile functions, ‘maxlevels’ defaults to ‘0’.

     Changed in version 3.2: Added the `legacy' and `optimize'
     parameter.

     Changed in version 3.5: `quiet' parameter was changed to a
     multilevel value.

     Changed in version 3.5: The `legacy' parameter only writes out
     ‘.pyc’ files, not ‘.pyo’ files no matter what the value of
     `optimize' is.

     Changed in version 3.7: The `invalidation_mode' parameter was
     added.

     Changed in version 3.7.2: The `invalidation_mode' parameter’s
     default value is updated to None.

To force a recompile of all the ‘.py’ files in the ‘Lib/’ subdirectory
and all its subdirectories:

     import compileall  compileall.compile_dir('Lib/', force=True)  # Perform same compilation, excluding files in .svn directories. import re compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True)  # pathlib.Path objects can also be used. import pathlib compileall.compile_dir(pathlib.Path('Lib/'), force=True)

See also
........

Module *note py_compile: d7.

     Byte-compile a single source file.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147

   (2) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: dis — Disassembler for Python bytecode,  Next: pickletools — Tools for pickle developers,  Prev: compileall — Byte-compile Python libraries,  Up: Python Language Services

5.33.12 ‘dis’ — Disassembler for Python bytecode
------------------------------------------------

`Source code:' Lib/dis.py(1)

__________________________________________________________________

The *note dis: 38. module supports the analysis of CPython *note
bytecode: 609. by disassembling it.  The CPython bytecode which this
module takes as an input is defined in the file ‘Include/opcode.h’ and
used by the compiler and the interpreter.

`CPython implementation detail:' Bytecode is an implementation detail of
the CPython interpreter.  No guarantees are made that bytecode will not
be added, removed, or changed between versions of Python.  Use of this
module should not be considered to work across Python VMs or Python
releases.

Changed in version 3.6: Use 2 bytes for each instruction.  Previously
the number of bytes varied by instruction.

Example: Given the function ‘myfunc()’:

     def myfunc(alist):     return len(alist)

the following command can be used to display the disassembly of
‘myfunc()’:

     >>> dis.dis(myfunc)   2           0 LOAD_GLOBAL              0 (len)               2 LOAD_FAST                0 (alist)               4 CALL_FUNCTION            1               6 RETURN_VALUE

(The “2” is a line number).

* Menu:

* Bytecode analysis::
* Analysis functions::
* Python Bytecode Instructions::
* Opcode collections::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/dis.py


File: python.info,  Node: Bytecode analysis,  Next: Analysis functions,  Up: dis — Disassembler for Python bytecode

5.33.12.1 Bytecode analysis
...........................

New in version 3.4.

The bytecode analysis API allows pieces of Python code to be wrapped in
a *note Bytecode: 82b. object that provides easy access to details of
the compiled code.

 -- Class: dis.Bytecode (x, *, first_line=None, current_offset=None)

     Analyse the bytecode corresponding to a function, generator,
     asynchronous generator, coroutine, method, string of source code,
     or a code object (as returned by *note compile(): 1b2.).

     This is a convenience wrapper around many of the functions listed
     below, most notably *note get_instructions(): 82a, as iterating
     over a *note Bytecode: 82b. instance yields the bytecode operations
     as *note Instruction: 829. instances.

     If `first_line' is not ‘None’, it indicates the line number that
     should be reported for the first source line in the disassembled
     code.  Otherwise, the source line information (if any) is taken
     directly from the disassembled code object.

     If `current_offset' is not ‘None’, it refers to an instruction
     offset in the disassembled code.  Setting this means *note dis():
     82c. will display a “current instruction” marker against the
     specified opcode.

      -- Class Method: from_traceback (tb)

          Construct a *note Bytecode: 82b. instance from the given
          traceback, setting `current_offset' to the instruction
          responsible for the exception.

      -- Data: codeobj

          The compiled code object.

      -- Data: first_line

          The first source line of the code object (if available)

      -- Method: dis ()

          Return a formatted view of the bytecode operations (the same
          as printed by *note dis.dis(): 379, but returned as a
          multi-line string).

      -- Method: info ()

          Return a formatted multi-line string with detailed information
          about the code object, like *note code_info(): bc1.

     Changed in version 3.7: This can now handle coroutine and
     asynchronous generator objects.

Example:

     >>> bytecode = dis.Bytecode(myfunc) >>> for instr in bytecode: ...     print(instr.opname) ... LOAD_GLOBAL LOAD_FAST CALL_FUNCTION RETURN_VALUE


File: python.info,  Node: Analysis functions,  Next: Python Bytecode Instructions,  Prev: Bytecode analysis,  Up: dis — Disassembler for Python bytecode

5.33.12.2 Analysis functions
............................

The *note dis: 38. module also defines the following analysis functions
that convert the input directly to the desired output.  They can be
useful if only a single operation is being performed, so the
intermediate analysis object isn’t useful:

 -- Function: dis.code_info (x)

     Return a formatted multi-line string with detailed code object
     information for the supplied function, generator, asynchronous
     generator, coroutine, method, source code string or code object.

     Note that the exact contents of code info strings are highly
     implementation dependent and they may change arbitrarily across
     Python VMs or Python releases.

     New in version 3.2.

     Changed in version 3.7: This can now handle coroutine and
     asynchronous generator objects.

 -- Function: dis.show_code (x, *, file=None)

     Print detailed code object information for the supplied function,
     method, source code string or code object to `file' (or
     ‘sys.stdout’ if `file' is not specified).

     This is a convenient shorthand for ‘print(code_info(x),
     file=file)’, intended for interactive exploration at the
     interpreter prompt.

     New in version 3.2.

     Changed in version 3.4: Added `file' parameter.

 -- Function: dis.dis (x=None, *, file=None, depth=None)

     Disassemble the `x' object.  `x' can denote either a module, a
     class, a method, a function, a generator, an asynchronous
     generator, a coroutine, a code object, a string of source code or a
     byte sequence of raw bytecode.  For a module, it disassembles all
     functions.  For a class, it disassembles all methods (including
     class and static methods).  For a code object or sequence of raw
     bytecode, it prints one line per bytecode instruction.  It also
     recursively disassembles nested code objects (the code of
     comprehensions, generator expressions and nested functions, and the
     code used for building nested classes).  Strings are first compiled
     to code objects with the *note compile(): 1b2. built-in function
     before being disassembled.  If no object is provided, this function
     disassembles the last traceback.

     The disassembly is written as text to the supplied `file' argument
     if provided and to ‘sys.stdout’ otherwise.

     The maximal depth of recursion is limited by `depth' unless it is
     ‘None’.  ‘depth=0’ means no recursion.

     Changed in version 3.4: Added `file' parameter.

     Changed in version 3.7: Implemented recursive disassembling and
     added `depth' parameter.

     Changed in version 3.7: This can now handle coroutine and
     asynchronous generator objects.

 -- Function: dis.distb (tb=None, *, file=None)

     Disassemble the top-of-stack function of a traceback, using the
     last traceback if none was passed.  The instruction causing the
     exception is indicated.

     The disassembly is written as text to the supplied `file' argument
     if provided and to ‘sys.stdout’ otherwise.

     Changed in version 3.4: Added `file' parameter.

 -- Function: dis.disassemble (code, lasti=-1, *, file=None)
 -- Function: dis.disco (code, lasti=-1, *, file=None)

     Disassemble a code object, indicating the last instruction if
     `lasti' was provided.  The output is divided in the following
     columns:

       1. the line number, for the first instruction of each line

       2. the current instruction, indicated as ‘-->’,

       3. a labelled instruction, indicated with ‘>>’,

       4. the address of the instruction,

       5. the operation code name,

       6. operation parameters, and

       7. interpretation of the parameters in parentheses.

     The parameter interpretation recognizes local and global variable
     names, constant values, branch targets, and compare operators.

     The disassembly is written as text to the supplied `file' argument
     if provided and to ‘sys.stdout’ otherwise.

     Changed in version 3.4: Added `file' parameter.

 -- Function: dis.get_instructions (x, *, first_line=None)

     Return an iterator over the instructions in the supplied function,
     method, source code string or code object.

     The iterator generates a series of *note Instruction: 829. named
     tuples giving the details of each operation in the supplied code.

     If `first_line' is not ‘None’, it indicates the line number that
     should be reported for the first source line in the disassembled
     code.  Otherwise, the source line information (if any) is taken
     directly from the disassembled code object.

     New in version 3.4.

 -- Function: dis.findlinestarts (code)

     This generator function uses the ‘co_firstlineno’ and ‘co_lnotab’
     attributes of the code object `code' to find the offsets which are
     starts of lines in the source code.  They are generated as
     ‘(offset, lineno)’ pairs.  See Objects/lnotab_notes.txt(1) for the
     ‘co_lnotab’ format and how to decode it.

     Changed in version 3.6: Line numbers can be decreasing.  Before,
     they were always increasing.

 -- Function: dis.findlabels (code)

     Detect all offsets in the code object `code' which are jump
     targets, and return a list of these offsets.

 -- Function: dis.stack_effect (opcode, oparg=None, *, jump=None)

     Compute the stack effect of `opcode' with argument `oparg'.

     If the code has a jump target and `jump' is ‘True’, *note
     stack_effect(): 82e. will return the stack effect of jumping.  If
     `jump' is ‘False’, it will return the stack effect of not jumping.
     And if `jump' is ‘None’ (default), it will return the maximal stack
     effect of both cases.

     New in version 3.4.

     Changed in version 3.8: Added `jump' parameter.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Objects/lnotab_notes.txt


File: python.info,  Node: Python Bytecode Instructions,  Next: Opcode collections,  Prev: Analysis functions,  Up: dis — Disassembler for Python bytecode

5.33.12.3 Python Bytecode Instructions
......................................

The *note get_instructions(): 82a. function and *note Bytecode: 82b.
class provide details of bytecode instructions as *note Instruction:
829. instances:

 -- Class: dis.Instruction

     Details for a bytecode operation

      -- Data: opcode

          numeric code for operation, corresponding to the opcode values
          listed below and the bytecode values in the *note Opcode
          collections: 37e2.

      -- Data: opname

          human readable name for operation

      -- Data: arg

          numeric argument to operation (if any), otherwise ‘None’

      -- Data: argval

          resolved arg value (if known), otherwise same as arg

      -- Data: argrepr

          human readable description of operation argument

      -- Data: offset

          start index of operation within bytecode sequence

      -- Data: starts_line

          line started by this opcode (if any), otherwise ‘None’

      -- Data: is_jump_target

          ‘True’ if other code jumps to here, otherwise ‘False’

     New in version 3.4.

The Python compiler currently generates the following bytecode
instructions.

`General instructions'

 -- Opcode: NOP

     Do nothing code.  Used as a placeholder by the bytecode optimizer.

 -- Opcode: POP_TOP

     Removes the top-of-stack (TOS) item.

 -- Opcode: ROT_TWO

     Swaps the two top-most stack items.

 -- Opcode: ROT_THREE

     Lifts second and third stack item one position up, moves top down
     to position three.

 -- Opcode: ROT_FOUR

     Lifts second, third and forth stack items one position up, moves
     top down to position four.

     New in version 3.8.

 -- Opcode: DUP_TOP

     Duplicates the reference on top of the stack.

     New in version 3.2.

 -- Opcode: DUP_TOP_TWO

     Duplicates the two references on top of the stack, leaving them in
     the same order.

     New in version 3.2.

`Unary operations'

Unary operations take the top of the stack, apply the operation, and
push the result back on the stack.

 -- Opcode: UNARY_POSITIVE

     Implements ‘TOS = +TOS’.

 -- Opcode: UNARY_NEGATIVE

     Implements ‘TOS = -TOS’.

 -- Opcode: UNARY_NOT

     Implements ‘TOS = not TOS’.

 -- Opcode: UNARY_INVERT

     Implements ‘TOS = ~TOS’.

 -- Opcode: GET_ITER

     Implements ‘TOS = iter(TOS)’.

 -- Opcode: GET_YIELD_FROM_ITER

     If ‘TOS’ is a *note generator iterator: 44c. or *note coroutine:
     1a5. object it is left as is.  Otherwise, implements ‘TOS =
     iter(TOS)’.

     New in version 3.5.

`Binary operations'

Binary operations remove the top of the stack (TOS) and the second
top-most stack item (TOS1) from the stack.  They perform the operation,
and put the result back on the stack.

 -- Opcode: BINARY_POWER

     Implements ‘TOS = TOS1 ** TOS’.

 -- Opcode: BINARY_MULTIPLY

     Implements ‘TOS = TOS1 * TOS’.

 -- Opcode: BINARY_MATRIX_MULTIPLY

     Implements ‘TOS = TOS1 @ TOS’.

     New in version 3.5.

 -- Opcode: BINARY_FLOOR_DIVIDE

     Implements ‘TOS = TOS1 // TOS’.

 -- Opcode: BINARY_TRUE_DIVIDE

     Implements ‘TOS = TOS1 / TOS’.

 -- Opcode: BINARY_MODULO

     Implements ‘TOS = TOS1 % TOS’.

 -- Opcode: BINARY_ADD

     Implements ‘TOS = TOS1 + TOS’.

 -- Opcode: BINARY_SUBTRACT

     Implements ‘TOS = TOS1 - TOS’.

 -- Opcode: BINARY_SUBSCR

     Implements ‘TOS = TOS1[TOS]’.

 -- Opcode: BINARY_LSHIFT

     Implements ‘TOS = TOS1 << TOS’.

 -- Opcode: BINARY_RSHIFT

     Implements ‘TOS = TOS1 >> TOS’.

 -- Opcode: BINARY_AND

     Implements ‘TOS = TOS1 & TOS’.

 -- Opcode: BINARY_XOR

     Implements ‘TOS = TOS1 ^ TOS’.

 -- Opcode: BINARY_OR

     Implements ‘TOS = TOS1 | TOS’.

`In-place operations'

In-place operations are like binary operations, in that they remove TOS
and TOS1, and push the result back on the stack, but the operation is
done in-place when TOS1 supports it, and the resulting TOS may be (but
does not have to be) the original TOS1.

 -- Opcode: INPLACE_POWER

     Implements in-place ‘TOS = TOS1 ** TOS’.

 -- Opcode: INPLACE_MULTIPLY

     Implements in-place ‘TOS = TOS1 * TOS’.

 -- Opcode: INPLACE_MATRIX_MULTIPLY

     Implements in-place ‘TOS = TOS1 @ TOS’.

     New in version 3.5.

 -- Opcode: INPLACE_FLOOR_DIVIDE

     Implements in-place ‘TOS = TOS1 // TOS’.

 -- Opcode: INPLACE_TRUE_DIVIDE

     Implements in-place ‘TOS = TOS1 / TOS’.

 -- Opcode: INPLACE_MODULO

     Implements in-place ‘TOS = TOS1 % TOS’.

 -- Opcode: INPLACE_ADD

     Implements in-place ‘TOS = TOS1 + TOS’.

 -- Opcode: INPLACE_SUBTRACT

     Implements in-place ‘TOS = TOS1 - TOS’.

 -- Opcode: INPLACE_LSHIFT

     Implements in-place ‘TOS = TOS1 << TOS’.

 -- Opcode: INPLACE_RSHIFT

     Implements in-place ‘TOS = TOS1 >> TOS’.

 -- Opcode: INPLACE_AND

     Implements in-place ‘TOS = TOS1 & TOS’.

 -- Opcode: INPLACE_XOR

     Implements in-place ‘TOS = TOS1 ^ TOS’.

 -- Opcode: INPLACE_OR

     Implements in-place ‘TOS = TOS1 | TOS’.

 -- Opcode: STORE_SUBSCR

     Implements ‘TOS1[TOS] = TOS2’.

 -- Opcode: DELETE_SUBSCR

     Implements ‘del TOS1[TOS]’.

`Coroutine opcodes'

 -- Opcode: GET_AWAITABLE

     Implements ‘TOS = get_awaitable(TOS)’, where ‘get_awaitable(o)’
     returns ‘o’ if ‘o’ is a coroutine object or a generator object with
     the CO_ITERABLE_COROUTINE flag, or resolves ‘o.__await__’.

     New in version 3.5.

 -- Opcode: GET_AITER

     Implements ‘TOS = TOS.__aiter__()’.

     New in version 3.5.

     Changed in version 3.7: Returning awaitable objects from
     ‘__aiter__’ is no longer supported.

 -- Opcode: GET_ANEXT

     Implements ‘PUSH(get_awaitable(TOS.__anext__()))’.  See
     ‘GET_AWAITABLE’ for details about ‘get_awaitable’

     New in version 3.5.

 -- Opcode: END_ASYNC_FOR

     Terminates an *note async for: 2e1. loop.  Handles an exception
     raised when awaiting a next item.  If TOS is *note
     StopAsyncIteration: f49. pop 7 values from the stack and restore
     the exception state using the second three of them.  Otherwise
     re-raise the exception using the three values from the stack.  An
     exception handler block is removed from the block stack.

     New in version 3.8.

 -- Opcode: BEFORE_ASYNC_WITH

     Resolves ‘__aenter__’ and ‘__aexit__’ from the object on top of the
     stack.  Pushes ‘__aexit__’ and result of ‘__aenter__()’ to the
     stack.

     New in version 3.5.

 -- Opcode: SETUP_ASYNC_WITH

     Creates a new frame object.

     New in version 3.5.

`Miscellaneous opcodes'

 -- Opcode: PRINT_EXPR

     Implements the expression statement for the interactive mode.  TOS
     is removed from the stack and printed.  In non-interactive mode, an
     expression statement is terminated with *note POP_TOP: 37eb.

 -- Opcode: SET_ADD (i)

     Calls ‘set.add(TOS1[-i], TOS)’.  Used to implement set
     comprehensions.

 -- Opcode: LIST_APPEND (i)

     Calls ‘list.append(TOS[-i], TOS)’.  Used to implement list
     comprehensions.

 -- Opcode: MAP_ADD (i)

     Calls ‘dict.__setitem__(TOS1[-i], TOS1, TOS)’.  Used to implement
     dict comprehensions.

     New in version 3.1.

     Changed in version 3.8: Map value is TOS and map key is TOS1.
     Before, those were reversed.

For all of the *note SET_ADD: 3819, *note LIST_APPEND: 381a. and *note
MAP_ADD: 2e2. instructions, while the added value or key/value pair is
popped off, the container object remains on the stack so that it is
available for further iterations of the loop.

 -- Opcode: RETURN_VALUE

     Returns with TOS to the caller of the function.

 -- Opcode: YIELD_VALUE

     Pops TOS and yields it from a *note generator: 996.

 -- Opcode: YIELD_FROM

     Pops TOS and delegates to it as a subiterator from a *note
     generator: 996.

     New in version 3.3.

 -- Opcode: SETUP_ANNOTATIONS

     Checks whether ‘__annotations__’ is defined in ‘locals()’, if not
     it is set up to an empty ‘dict’.  This opcode is only emitted if a
     class or module body contains *note variable annotations: 614.
     statically.

     New in version 3.6.

 -- Opcode: IMPORT_STAR

     Loads all symbols not starting with ‘'_'’ directly from the module
     TOS to the local namespace.  The module is popped after loading all
     names.  This opcode implements ‘from module import *’.

 -- Opcode: POP_BLOCK

     Removes one block from the block stack.  Per frame, there is a
     stack of blocks, denoting *note try: d65. statements, and such.

 -- Opcode: POP_EXCEPT

     Removes one block from the block stack.  The popped block must be
     an exception handler block, as implicitly created when entering an
     except handler.  In addition to popping extraneous values from the
     frame stack, the last three popped values are used to restore the
     exception state.

 -- Opcode: POP_FINALLY (preserve_tos)

     Cleans up the value stack and the block stack.  If `preserve_tos'
     is not ‘0’ TOS first is popped from the stack and pushed on the
     stack after performing other stack operations:

        * If TOS is ‘NULL’ or an integer (pushed by *note BEGIN_FINALLY:
          2db. or *note CALL_FINALLY: 2dc.) it is popped from the stack.

        * If TOS is an exception type (pushed when an exception has been
          raised) 6 values are popped from the stack, the last three
          popped values are used to restore the exception state.  An
          exception handler block is removed from the block stack.

     It is similar to *note END_FINALLY: 2de, but doesn’t change the
     bytecode counter nor raise an exception.  Used for implementing
     *note break: 2d9, *note continue: 181. and *note return: 190. in
     the *note finally: 182. block.

     New in version 3.8.

 -- Opcode: BEGIN_FINALLY

     Pushes ‘NULL’ onto the stack for using it in *note END_FINALLY:
     2de, *note POP_FINALLY: 2dd, *note WITH_CLEANUP_START: 2df. and
     *note WITH_CLEANUP_FINISH: 3821.  Starts the *note finally: 182.
     block.

     New in version 3.8.

 -- Opcode: END_FINALLY

     Terminates a *note finally: 182. clause.  The interpreter recalls
     whether the exception has to be re-raised or execution has to be
     continued depending on the value of TOS.

        * If TOS is ‘NULL’ (pushed by *note BEGIN_FINALLY: 2db.)
          continue from the next instruction.  TOS is popped.

        * If TOS is an integer (pushed by *note CALL_FINALLY: 2dc.),
          sets the bytecode counter to TOS. TOS is popped.

        * If TOS is an exception type (pushed when an exception has been
          raised) 6 values are popped from the stack, the first three
          popped values are used to re-raise the exception and the last
          three popped values are used to restore the exception state.
          An exception handler block is removed from the block stack.

 -- Opcode: LOAD_BUILD_CLASS

     Pushes ‘builtins.__build_class__()’ onto the stack.  It is later
     called by *note CALL_FUNCTION: 60e. to construct a class.

 -- Opcode: SETUP_WITH (delta)

     This opcode performs several operations before a with block starts.
     First, it loads *note __exit__(): c89. from the context manager and
     pushes it onto the stack for later use by *note WITH_CLEANUP_START:
     2df.  Then, *note __enter__(): c88. is called, and a finally block
     pointing to `delta' is pushed.  Finally, the result of calling the
     ‘__enter__()’ method is pushed onto the stack.  The next opcode
     will either ignore it (*note POP_TOP: 37eb.), or store it in (a)
     variable(s) (*note STORE_FAST: 3824, *note STORE_NAME: 3825, or
     *note UNPACK_SEQUENCE: 3826.).

     New in version 3.2.

 -- Opcode: WITH_CLEANUP_START

     Starts cleaning up the stack when a *note with: 6dd. statement
     block exits.

     At the top of the stack are either ‘NULL’ (pushed by *note
     BEGIN_FINALLY: 2db.) or 6 values pushed if an exception has been
     raised in the with block.  Below is the context manager’s *note
     __exit__(): c89. or *note __aexit__(): 13d5. bound method.

     If TOS is ‘NULL’, calls ‘SECOND(None, None, None)’, removes the
     function from the stack, leaving TOS, and pushes ‘None’ to the
     stack.  Otherwise calls ‘SEVENTH(TOP, SECOND, THIRD)’, shifts the
     bottom 3 values of the stack down, replaces the empty spot with
     ‘NULL’ and pushes TOS. Finally pushes the result of the call.

 -- Opcode: WITH_CLEANUP_FINISH

     Finishes cleaning up the stack when a *note with: 6dd. statement
     block exits.

     TOS is result of ‘__exit__()’ or ‘__aexit__()’ function call pushed
     by *note WITH_CLEANUP_START: 2df.  SECOND is ‘None’ or an exception
     type (pushed when an exception has been raised).

     Pops two values from the stack.  If SECOND is not None and TOS is
     true unwinds the EXCEPT_HANDLER block which was created when the
     exception was caught and pushes ‘NULL’ to the stack.

All of the following opcodes use their arguments.

 -- Opcode: STORE_NAME (namei)

     Implements ‘name = TOS’.  `namei' is the index of `name' in the
     attribute ‘co_names’ of the code object.  The compiler tries to use
     *note STORE_FAST: 3824. or *note STORE_GLOBAL: 3827. if possible.

 -- Opcode: DELETE_NAME (namei)

     Implements ‘del name’, where `namei' is the index into ‘co_names’
     attribute of the code object.

 -- Opcode: UNPACK_SEQUENCE (count)

     Unpacks TOS into `count' individual values, which are put onto the
     stack right-to-left.

 -- Opcode: UNPACK_EX (counts)

     Implements assignment with a starred target: Unpacks an iterable in
     TOS into individual values, where the total number of values can be
     smaller than the number of items in the iterable: one of the new
     values will be a list of all leftover items.

     The low byte of `counts' is the number of values before the list
     value, the high byte of `counts' the number of values after it.
     The resulting values are put onto the stack right-to-left.

 -- Opcode: STORE_ATTR (namei)

     Implements ‘TOS.name = TOS1’, where `namei' is the index of name in
     ‘co_names’.

 -- Opcode: DELETE_ATTR (namei)

     Implements ‘del TOS.name’, using `namei' as index into ‘co_names’.

 -- Opcode: STORE_GLOBAL (namei)

     Works as *note STORE_NAME: 3825, but stores the name as a global.

 -- Opcode: DELETE_GLOBAL (namei)

     Works as *note DELETE_NAME: 3828, but deletes a global name.

 -- Opcode: LOAD_CONST (consti)

     Pushes ‘co_consts[consti]’ onto the stack.

 -- Opcode: LOAD_NAME (namei)

     Pushes the value associated with ‘co_names[namei]’ onto the stack.

 -- Opcode: BUILD_TUPLE (count)

     Creates a tuple consuming `count' items from the stack, and pushes
     the resulting tuple onto the stack.

 -- Opcode: BUILD_LIST (count)

     Works as *note BUILD_TUPLE: 382f, but creates a list.

 -- Opcode: BUILD_SET (count)

     Works as *note BUILD_TUPLE: 382f, but creates a set.

 -- Opcode: BUILD_MAP (count)

     Pushes a new dictionary object onto the stack.  Pops ‘2 * count’
     items so that the dictionary holds `count' entries: ‘{..., TOS3:
     TOS2, TOS1: TOS}’.

     Changed in version 3.5: The dictionary is created from stack items
     instead of creating an empty dictionary pre-sized to hold `count'
     items.

 -- Opcode: BUILD_CONST_KEY_MAP (count)

     The version of *note BUILD_MAP: 3832. specialized for constant
     keys.  `count' values are consumed from the stack.  The top element
     on the stack contains a tuple of keys.

     New in version 3.6.

 -- Opcode: BUILD_STRING (count)

     Concatenates `count' strings from the stack and pushes the
     resulting string onto the stack.

     New in version 3.6.

 -- Opcode: BUILD_TUPLE_UNPACK (count)

     Pops `count' iterables from the stack, joins them in a single
     tuple, and pushes the result.  Implements iterable unpacking in
     tuple displays ‘(*x, *y, *z)’.

     New in version 3.5.

 -- Opcode: BUILD_TUPLE_UNPACK_WITH_CALL (count)

     This is similar to *note BUILD_TUPLE_UNPACK: 3833, but is used for
     ‘f(*x, *y, *z)’ call syntax.  The stack item at position ‘count +
     1’ should be the corresponding callable ‘f’.

     New in version 3.6.

 -- Opcode: BUILD_LIST_UNPACK (count)

     This is similar to *note BUILD_TUPLE_UNPACK: 3833, but pushes a
     list instead of tuple.  Implements iterable unpacking in list
     displays ‘[*x, *y, *z]’.

     New in version 3.5.

 -- Opcode: BUILD_SET_UNPACK (count)

     This is similar to *note BUILD_TUPLE_UNPACK: 3833, but pushes a set
     instead of tuple.  Implements iterable unpacking in set displays
     ‘{*x, *y, *z}’.

     New in version 3.5.

 -- Opcode: BUILD_MAP_UNPACK (count)

     Pops `count' mappings from the stack, merges them into a single
     dictionary, and pushes the result.  Implements dictionary unpacking
     in dictionary displays ‘{**x, **y, **z}’.

     New in version 3.5.

 -- Opcode: BUILD_MAP_UNPACK_WITH_CALL (count)

     This is similar to *note BUILD_MAP_UNPACK: 3836, but is used for
     ‘f(**x, **y, **z)’ call syntax.  The stack item at position ‘count
     + 2’ should be the corresponding callable ‘f’.

     New in version 3.5.

     Changed in version 3.6: The position of the callable is determined
     by adding 2 to the opcode argument instead of encoding it in the
     second byte of the argument.

 -- Opcode: LOAD_ATTR (namei)

     Replaces TOS with ‘getattr(TOS, co_names[namei])’.

 -- Opcode: COMPARE_OP (opname)

     Performs a Boolean operation.  The operation name can be found in
     ‘cmp_op[opname]’.

 -- Opcode: IMPORT_NAME (namei)

     Imports the module ‘co_names[namei]’.  TOS and TOS1 are popped and
     provide the `fromlist' and `level' arguments of *note __import__():
     605.  The module object is pushed onto the stack.  The current
     namespace is not affected: for a proper import statement, a
     subsequent *note STORE_FAST: 3824. instruction modifies the
     namespace.

 -- Opcode: IMPORT_FROM (namei)

     Loads the attribute ‘co_names[namei]’ from the module found in TOS.
     The resulting object is pushed onto the stack, to be subsequently
     stored by a *note STORE_FAST: 3824. instruction.

 -- Opcode: JUMP_FORWARD (delta)

     Increments bytecode counter by `delta'.

 -- Opcode: POP_JUMP_IF_TRUE (target)

     If TOS is true, sets the bytecode counter to `target'.  TOS is
     popped.

     New in version 3.1.

 -- Opcode: POP_JUMP_IF_FALSE (target)

     If TOS is false, sets the bytecode counter to `target'.  TOS is
     popped.

     New in version 3.1.

 -- Opcode: JUMP_IF_TRUE_OR_POP (target)

     If TOS is true, sets the bytecode counter to `target' and leaves
     TOS on the stack.  Otherwise (TOS is false), TOS is popped.

     New in version 3.1.

 -- Opcode: JUMP_IF_FALSE_OR_POP (target)

     If TOS is false, sets the bytecode counter to `target' and leaves
     TOS on the stack.  Otherwise (TOS is true), TOS is popped.

     New in version 3.1.

 -- Opcode: JUMP_ABSOLUTE (target)

     Set bytecode counter to `target'.

 -- Opcode: FOR_ITER (delta)

     TOS is an *note iterator: f73.  Call its *note __next__(): c57.
     method.  If this yields a new value, push it on the stack (leaving
     the iterator below it).  If the iterator indicates it is exhausted
     TOS is popped, and the byte code counter is incremented by `delta'.

 -- Opcode: LOAD_GLOBAL (namei)

     Loads the global named ‘co_names[namei]’ onto the stack.

 -- Opcode: SETUP_FINALLY (delta)

     Pushes a try block from a try-finally or try-except clause onto the
     block stack.  `delta' points to the finally block or the first
     except block.

 -- Opcode: CALL_FINALLY (delta)

     Pushes the address of the next instruction onto the stack and
     increments bytecode counter by `delta'.  Used for calling the
     finally block as a “subroutine”.

     New in version 3.8.

 -- Opcode: LOAD_FAST (var_num)

     Pushes a reference to the local ‘co_varnames[var_num]’ onto the
     stack.

 -- Opcode: STORE_FAST (var_num)

     Stores TOS into the local ‘co_varnames[var_num]’.

 -- Opcode: DELETE_FAST (var_num)

     Deletes local ‘co_varnames[var_num]’.

 -- Opcode: LOAD_CLOSURE (i)

     Pushes a reference to the cell contained in slot `i' of the cell
     and free variable storage.  The name of the variable is
     ‘co_cellvars[i]’ if `i' is less than the length of `co_cellvars'.
     Otherwise it is ‘co_freevars[i - len(co_cellvars)]’.

 -- Opcode: LOAD_DEREF (i)

     Loads the cell contained in slot `i' of the cell and free variable
     storage.  Pushes a reference to the object the cell contains on the
     stack.

 -- Opcode: LOAD_CLASSDEREF (i)

     Much like *note LOAD_DEREF: 3847. but first checks the locals
     dictionary before consulting the cell.  This is used for loading
     free variables in class bodies.

     New in version 3.4.

 -- Opcode: STORE_DEREF (i)

     Stores TOS into the cell contained in slot `i' of the cell and free
     variable storage.

 -- Opcode: DELETE_DEREF (i)

     Empties the cell contained in slot `i' of the cell and free
     variable storage.  Used by the *note del: 11a8. statement.

     New in version 3.2.

 -- Opcode: RAISE_VARARGS (argc)

     Raises an exception using one of the 3 forms of the ‘raise’
     statement, depending on the value of `argc':

        * 0: ‘raise’ (re-raise previous exception)

        * 1: ‘raise TOS’ (raise exception instance or type at ‘TOS’)

        * 2: ‘raise TOS1 from TOS’ (raise exception instance or type at
          ‘TOS1’ with ‘__cause__’ set to ‘TOS’)

 -- Opcode: CALL_FUNCTION (argc)

     Calls a callable object with positional arguments.  `argc'
     indicates the number of positional arguments.  The top of the stack
     contains positional arguments, with the right-most argument on top.
     Below the arguments is a callable object to call.  ‘CALL_FUNCTION’
     pops all arguments and the callable object off the stack, calls the
     callable object with those arguments, and pushes the return value
     returned by the callable object.

     Changed in version 3.6: This opcode is used only for calls with
     positional arguments.

 -- Opcode: CALL_FUNCTION_KW (argc)

     Calls a callable object with positional (if any) and keyword
     arguments.  `argc' indicates the total number of positional and
     keyword arguments.  The top element on the stack contains a tuple
     of keyword argument names.  Below that are keyword arguments in the
     order corresponding to the tuple.  Below that are positional
     arguments, with the right-most parameter on top.  Below the
     arguments is a callable object to call.  ‘CALL_FUNCTION_KW’ pops
     all arguments and the callable object off the stack, calls the
     callable object with those arguments, and pushes the return value
     returned by the callable object.

     Changed in version 3.6: Keyword arguments are packed in a tuple
     instead of a dictionary, `argc' indicates the total number of
     arguments.

 -- Opcode: CALL_FUNCTION_EX (flags)

     Calls a callable object with variable set of positional and keyword
     arguments.  If the lowest bit of `flags' is set, the top of the
     stack contains a mapping object containing additional keyword
     arguments.  Below that is an iterable object containing positional
     arguments and a callable object to call.  *note
     BUILD_MAP_UNPACK_WITH_CALL: 610. and *note
     BUILD_TUPLE_UNPACK_WITH_CALL: 612. can be used for merging multiple
     mapping objects and iterables containing arguments.  Before the
     callable is called, the mapping object and iterable object are each
     “unpacked” and their contents passed in as keyword and positional
     arguments respectively.  ‘CALL_FUNCTION_EX’ pops all arguments and
     the callable object off the stack, calls the callable object with
     those arguments, and pushes the return value returned by the
     callable object.

     New in version 3.6.

 -- Opcode: LOAD_METHOD (namei)

     Loads a method named ‘co_names[namei]’ from TOS object.  TOS is
     popped and method and TOS are pushed when interpreter can call
     unbound method directly.  TOS will be used as the first argument
     (‘self’) by *note CALL_METHOD: 4a4.  Otherwise, ‘NULL’ and method
     is pushed (method is bound method or something else).

     New in version 3.7.

 -- Opcode: CALL_METHOD (argc)

     Calls a method.  `argc' is number of positional arguments.  Keyword
     arguments are not supported.  This opcode is designed to be used
     with *note LOAD_METHOD: 4a3.  Positional arguments are on top of
     the stack.  Below them, two items described in *note LOAD_METHOD:
     4a3. on the stack.  All of them are popped and return value is
     pushed.

     New in version 3.7.

 -- Opcode: MAKE_FUNCTION (argc)

     Pushes a new function object on the stack.  From bottom to top, the
     consumed stack must consist of values if the argument carries a
     specified flag value

        * ‘0x01’ a tuple of default values for positional-only and
          positional-or-keyword parameters in positional order

        * ‘0x02’ a dictionary of keyword-only parameters’ default values

        * ‘0x04’ an annotation dictionary

        * ‘0x08’ a tuple containing cells for free variables, making a
          closure

        * the code associated with the function (at TOS1)

        * the *note qualified name: 1366. of the function (at TOS)

 -- Opcode: BUILD_SLICE (argc)

     Pushes a slice object on the stack.  `argc' must be 2 or 3.  If it
     is 2, ‘slice(TOS1, TOS)’ is pushed; if it is 3, ‘slice(TOS2, TOS1,
     TOS)’ is pushed.  See the *note slice(): df7. built-in function for
     more information.

 -- Opcode: EXTENDED_ARG (ext)

     Prefixes any opcode which has an argument too big to fit into the
     default one byte.  `ext' holds an additional byte which act as
     higher bits in the argument.  For each opcode, at most three
     prefixal ‘EXTENDED_ARG’ are allowed, forming an argument from
     two-byte to four-byte.

 -- Opcode: FORMAT_VALUE (flags)

     Used for implementing formatted literal strings (f-strings).  Pops
     an optional `fmt_spec' from the stack, then a required `value'.
     `flags' is interpreted as follows:

        * ‘(flags & 0x03) == 0x00’: `value' is formatted as-is.

        * ‘(flags & 0x03) == 0x01’: call *note str(): 325. on `value'
          before formatting it.

        * ‘(flags & 0x03) == 0x02’: call *note repr(): 7c0. on `value'
          before formatting it.

        * ‘(flags & 0x03) == 0x03’: call *note ascii(): d3f. on `value'
          before formatting it.

        * ‘(flags & 0x04) == 0x04’: pop `fmt_spec' from the stack and
          use it, else use an empty `fmt_spec'.

     Formatting is performed using ‘PyObject_Format()’.  The result is
     pushed on the stack.

     New in version 3.6.

 -- Opcode: HAVE_ARGUMENT

     This is not really an opcode.  It identifies the dividing line
     between opcodes which don’t use their argument and those that do
     (‘< HAVE_ARGUMENT’ and ‘>= HAVE_ARGUMENT’, respectively).

     Changed in version 3.6: Now every instruction has an argument, but
     opcodes ‘< HAVE_ARGUMENT’ ignore it.  Before, only opcodes ‘>=
     HAVE_ARGUMENT’ had an argument.


File: python.info,  Node: Opcode collections,  Prev: Python Bytecode Instructions,  Up: dis — Disassembler for Python bytecode

5.33.12.4 Opcode collections
............................

These collections are provided for automatic introspection of bytecode
instructions:

 -- Data: dis.opname

     Sequence of operation names, indexable using the bytecode.

 -- Data: dis.opmap

     Dictionary mapping operation names to bytecodes.

 -- Data: dis.cmp_op

     Sequence of all compare operation names.

 -- Data: dis.hasconst

     Sequence of bytecodes that access a constant.

 -- Data: dis.hasfree

     Sequence of bytecodes that access a free variable (note that ‘free’
     in this context refers to names in the current scope that are
     referenced by inner scopes or names in outer scopes that are
     referenced from this scope.  It does `not' include references to
     global or builtin scopes).

 -- Data: dis.hasname

     Sequence of bytecodes that access an attribute by name.

 -- Data: dis.hasjrel

     Sequence of bytecodes that have a relative jump target.

 -- Data: dis.hasjabs

     Sequence of bytecodes that have an absolute jump target.

 -- Data: dis.haslocal

     Sequence of bytecodes that access a local variable.

 -- Data: dis.hascompare

     Sequence of bytecodes of Boolean operations.


File: python.info,  Node: pickletools — Tools for pickle developers,  Prev: dis — Disassembler for Python bytecode,  Up: Python Language Services

5.33.13 ‘pickletools’ — Tools for pickle developers
---------------------------------------------------

`Source code:' Lib/pickletools.py(1)

__________________________________________________________________

This module contains various constants relating to the intimate details
of the *note pickle: ca. module, some lengthy comments about the
implementation, and a few useful functions for analyzing pickled data.
The contents of this module are useful for Python core developers who
are working on the *note pickle: ca.; ordinary users of the *note
pickle: ca. module probably won’t find the *note pickletools: cb. module
relevant.

* Menu:

* Command line usage: Command line usage<2>.
* Programmatic Interface: Programmatic Interface<2>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pickletools.py


File: python.info,  Node: Command line usage<2>,  Next: Programmatic Interface<2>,  Up: pickletools — Tools for pickle developers

5.33.13.1 Command line usage
............................

New in version 3.2.

When invoked from the command line, ‘python -m pickletools’ will
disassemble the contents of one or more pickle files.  Note that if you
want to see the Python object stored in the pickle rather than the
details of pickle format, you may want to use ‘-m pickle’ instead.
However, when the pickle file that you want to examine comes from an
untrusted source, ‘-m pickletools’ is a safer option because it does not
execute pickle bytecode.

For example, with a tuple ‘(1, 2)’ pickled in file ‘x.pickle’:

     $ python -m pickle x.pickle (1, 2)  $ python -m pickletools x.pickle     0: \x80 PROTO      3     2: K    BININT1    1     4: K    BININT1    2     6: \x86 TUPLE2     7: q    BINPUT     0     9: .    STOP highest protocol among opcodes = 2

* Menu:

* Command line options: Command line options<3>.


File: python.info,  Node: Command line options<3>,  Up: Command line usage<2>

5.33.13.2 Command line options
..............................

 -- Program Option: -a, --annotate

     Annotate each line with a short opcode description.

 -- Program Option: -o, --output=<file>

     Name of a file where the output should be written.

 -- Program Option: -l, --indentlevel=<num>

     The number of blanks by which to indent a new MARK level.

 -- Program Option: -m, --memo

     When multiple objects are disassembled, preserve memo between
     disassemblies.

 -- Program Option: -p, --preamble=<preamble>

     When more than one pickle file are specified, print given preamble
     before each disassembly.


File: python.info,  Node: Programmatic Interface<2>,  Prev: Command line usage<2>,  Up: pickletools — Tools for pickle developers

5.33.13.3 Programmatic Interface
................................

 -- Function: pickletools.dis (pickle, out=None, memo=None,
          indentlevel=4, annotate=0)

     Outputs a symbolic disassembly of the pickle to the file-like
     object `out', defaulting to ‘sys.stdout’.  `pickle' can be a string
     or a file-like object.  `memo' can be a Python dictionary that will
     be used as the pickle’s memo; it can be used to perform
     disassemblies across multiple pickles created by the same pickler.
     Successive levels, indicated by ‘MARK’ opcodes in the stream, are
     indented by `indentlevel' spaces.  If a nonzero value is given to
     `annotate', each opcode in the output is annotated with a short
     description.  The value of `annotate' is used as a hint for the
     column where annotation should start.

     New in version 3.2: The `annotate' argument.

 -- Function: pickletools.genops (pickle)

     Provides an *note iterator: f73. over all of the opcodes in a
     pickle, returning a sequence of ‘(opcode, arg, pos)’ triples.
     `opcode' is an instance of an ‘OpcodeInfo’ class; `arg' is the
     decoded value, as a Python object, of the opcode’s argument; `pos'
     is the position at which this opcode is located.  `pickle' can be a
     string or a file-like object.

 -- Function: pickletools.optimize (picklestring)

     Returns a new equivalent pickle string after eliminating unused
     ‘PUT’ opcodes.  The optimized pickle is shorter, takes less
     transmission time, requires less storage space, and unpickles more
     efficiently.


File: python.info,  Node: Miscellaneous Services,  Next: MS Windows Specific Services,  Prev: Python Language Services,  Up: The Python Standard Library

5.34 Miscellaneous Services
===========================

The modules described in this chapter provide miscellaneous services
that are available in all Python versions.  Here’s an overview:

* Menu:

* formatter — Generic output formatting::


File: python.info,  Node: formatter — Generic output formatting,  Up: Miscellaneous Services

5.34.1 ‘formatter’ — Generic output formatting
----------------------------------------------

Deprecated since version 3.4: Due to lack of usage, the formatter module
has been deprecated.

__________________________________________________________________

This module supports two interface definitions, each with multiple
implementations: The `formatter' interface, and the `writer' interface
which is required by the formatter interface.

Formatter objects transform an abstract flow of formatting events into
specific output events on writer objects.  Formatters manage several
stack structures to allow various properties of a writer object to be
changed and restored; writers need not be able to handle relative
changes nor any sort of “change back” operation.  Specific writer
properties which may be controlled via formatter objects are horizontal
alignment, font, and left margin indentations.  A mechanism is provided
which supports providing arbitrary, non-exclusive style settings to a
writer as well.  Additional interfaces facilitate formatting events
which are not reversible, such as paragraph separation.

Writer objects encapsulate device interfaces.  Abstract devices, such as
file formats, are supported as well as physical devices.  The provided
implementations all work with abstract devices.  The interface makes
available mechanisms for setting the properties which formatter objects
manage and inserting data into the output.

* Menu:

* The Formatter Interface::
* Formatter Implementations::
* The Writer Interface::
* Writer Implementations::


File: python.info,  Node: The Formatter Interface,  Next: Formatter Implementations,  Up: formatter — Generic output formatting

5.34.1.1 The Formatter Interface
................................

Interfaces to create formatters are dependent on the specific formatter
class being instantiated.  The interfaces described below are the
required interfaces which all formatters must support once initialized.

One data element is defined at the module level:

 -- Data: formatter.AS_IS

     Value which can be used in the font specification passed to the
     ‘push_font()’ method described below, or as the new value to any
     other ‘push_property()’ method.  Pushing the ‘AS_IS’ value allows
     the corresponding ‘pop_property()’ method to be called without
     having to track whether the property was changed.

The following attributes are defined for formatter instance objects:

 -- Attribute: formatter.writer

     The writer instance with which the formatter interacts.

 -- Method: formatter.end_paragraph (blanklines)

     Close any open paragraphs and insert at least `blanklines' before
     the next paragraph.

 -- Method: formatter.add_line_break ()

     Add a hard line break if one does not already exist.  This does not
     break the logical paragraph.

 -- Method: formatter.add_hor_rule (*args, **kw)

     Insert a horizontal rule in the output.  A hard break is inserted
     if there is data in the current paragraph, but the logical
     paragraph is not broken.  The arguments and keywords are passed on
     to the writer’s ‘send_line_break()’ method.

 -- Method: formatter.add_flowing_data (data)

     Provide data which should be formatted with collapsed whitespace.
     Whitespace from preceding and successive calls to *note
     add_flowing_data(): 3870. is considered as well when the whitespace
     collapse is performed.  The data which is passed to this method is
     expected to be word-wrapped by the output device.  Note that any
     word-wrapping still must be performed by the writer object due to
     the need to rely on device and font information.

 -- Method: formatter.add_literal_data (data)

     Provide data which should be passed to the writer unchanged.
     Whitespace, including newline and tab characters, are considered
     legal in the value of `data'.

 -- Method: formatter.add_label_data (format, counter)

     Insert a label which should be placed to the left of the current
     left margin.  This should be used for constructing bulleted or
     numbered lists.  If the `format' value is a string, it is
     interpreted as a format specification for `counter', which should
     be an integer.  The result of this formatting becomes the value of
     the label; if `format' is not a string it is used as the label
     value directly.  The label value is passed as the only argument to
     the writer’s ‘send_label_data()’ method.  Interpretation of
     non-string label values is dependent on the associated writer.

     Format specifications are strings which, in combination with a
     counter value, are used to compute label values.  Each character in
     the format string is copied to the label value, with some
     characters recognized to indicate a transform on the counter value.
     Specifically, the character ‘'1'’ represents the counter value
     formatter as an Arabic number, the characters ‘'A'’ and ‘'a'’
     represent alphabetic representations of the counter value in upper
     and lower case, respectively, and ‘'I'’ and ‘'i'’ represent the
     counter value in Roman numerals, in upper and lower case.  Note
     that the alphabetic and roman transforms require that the counter
     value be greater than zero.

 -- Method: formatter.flush_softspace ()

     Send any pending whitespace buffered from a previous call to *note
     add_flowing_data(): 3870. to the associated writer object.  This
     should be called before any direct manipulation of the writer
     object.

 -- Method: formatter.push_alignment (align)

     Push a new alignment setting onto the alignment stack.  This may be
     *note AS_IS: 386b. if no change is desired.  If the alignment value
     is changed from the previous setting, the writer’s
     ‘new_alignment()’ method is called with the `align' value.

 -- Method: formatter.pop_alignment ()

     Restore the previous alignment.

 -- Method: formatter.push_font ((size, italic, bold, teletype))

     Change some or all font properties of the writer object.
     Properties which are not set to *note AS_IS: 386b. are set to the
     values passed in while others are maintained at their current
     settings.  The writer’s ‘new_font()’ method is called with the
     fully resolved font specification.

 -- Method: formatter.pop_font ()

     Restore the previous font.

 -- Method: formatter.push_margin (margin)

     Increase the number of left margin indentations by one, associating
     the logical tag `margin' with the new indentation.  The initial
     margin level is ‘0’.  Changed values of the logical tag must be
     true values; false values other than *note AS_IS: 386b. are not
     sufficient to change the margin.

 -- Method: formatter.pop_margin ()

     Restore the previous margin.

 -- Method: formatter.push_style (*styles)

     Push any number of arbitrary style specifications.  All styles are
     pushed onto the styles stack in order.  A tuple representing the
     entire stack, including *note AS_IS: 386b. values, is passed to the
     writer’s ‘new_styles()’ method.

 -- Method: formatter.pop_style (n=1)

     Pop the last `n' style specifications passed to *note push_style():
     387a.  A tuple representing the revised stack, including *note
     AS_IS: 386b. values, is passed to the writer’s ‘new_styles()’
     method.

 -- Method: formatter.set_spacing (spacing)

     Set the spacing style for the writer.

 -- Method: formatter.assert_line_data (flag=1)

     Inform the formatter that data has been added to the current
     paragraph out-of-band.  This should be used when the writer has
     been manipulated directly.  The optional `flag' argument can be set
     to false if the writer manipulations produced a hard line break at
     the end of the output.


File: python.info,  Node: Formatter Implementations,  Next: The Writer Interface,  Prev: The Formatter Interface,  Up: formatter — Generic output formatting

5.34.1.2 Formatter Implementations
..................................

Two implementations of formatter objects are provided by this module.
Most applications may use one of these classes without modification or
subclassing.

 -- Class: formatter.NullFormatter (writer=None)

     A formatter which does nothing.  If `writer' is omitted, a *note
     NullWriter: 3881. instance is created.  No methods of the writer
     are called by *note NullFormatter: 3880. instances.
     Implementations should inherit from this class if implementing a
     writer interface but don’t need to inherit any implementation.

 -- Class: formatter.AbstractFormatter (writer)

     The standard formatter.  This implementation has demonstrated wide
     applicability to many writers, and may be used directly in most
     circumstances.  It has been used to implement a full-featured World
     Wide Web browser.


File: python.info,  Node: The Writer Interface,  Next: Writer Implementations,  Prev: Formatter Implementations,  Up: formatter — Generic output formatting

5.34.1.3 The Writer Interface
.............................

Interfaces to create writers are dependent on the specific writer class
being instantiated.  The interfaces described below are the required
interfaces which all writers must support once initialized.  Note that
while most applications can use the *note AbstractFormatter: 3882. class
as a formatter, the writer must typically be provided by the
application.

 -- Method: writer.flush ()

     Flush any buffered output or device control events.

 -- Method: writer.new_alignment (align)

     Set the alignment style.  The `align' value can be any object, but
     by convention is a string or ‘None’, where ‘None’ indicates that
     the writer’s “preferred” alignment should be used.  Conventional
     `align' values are ‘'left'’, ‘'center'’, ‘'right'’, and
     ‘'justify'’.

 -- Method: writer.new_font (font)

     Set the font style.  The value of `font' will be ‘None’, indicating
     that the device’s default font should be used, or a tuple of the
     form ‘(size, italic, bold, teletype)’.  Size will be a string
     indicating the size of font that should be used; specific strings
     and their interpretation must be defined by the application.  The
     `italic', `bold', and `teletype' values are Boolean values
     specifying which of those font attributes should be used.

 -- Method: writer.new_margin (margin, level)

     Set the margin level to the integer `level' and the logical tag to
     `margin'.  Interpretation of the logical tag is at the writer’s
     discretion; the only restriction on the value of the logical tag is
     that it not be a false value for non-zero values of `level'.

 -- Method: writer.new_spacing (spacing)

     Set the spacing style to `spacing'.

 -- Method: writer.new_styles (styles)

     Set additional styles.  The `styles' value is a tuple of arbitrary
     values; the value *note AS_IS: 386b. should be ignored.  The
     `styles' tuple may be interpreted either as a set or as a stack
     depending on the requirements of the application and writer
     implementation.

 -- Method: writer.send_line_break ()

     Break the current line.

 -- Method: writer.send_paragraph (blankline)

     Produce a paragraph separation of at least `blankline' blank lines,
     or the equivalent.  The `blankline' value will be an integer.  Note
     that the implementation will receive a call to *note
     send_line_break(): 388b. before this call if a line break is
     needed; this method should not include ending the last line of the
     paragraph.  It is only responsible for vertical spacing between
     paragraphs.

 -- Method: writer.send_hor_rule (*args, **kw)

     Display a horizontal rule on the output device.  The arguments to
     this method are entirely application- and writer-specific, and
     should be interpreted with care.  The method implementation may
     assume that a line break has already been issued via *note
     send_line_break(): 388b.

 -- Method: writer.send_flowing_data (data)

     Output character data which may be word-wrapped and re-flowed as
     needed.  Within any sequence of calls to this method, the writer
     may assume that spans of multiple whitespace characters have been
     collapsed to single space characters.

 -- Method: writer.send_literal_data (data)

     Output character data which has already been formatted for display.
     Generally, this should be interpreted to mean that line breaks
     indicated by newline characters should be preserved and no new line
     breaks should be introduced.  The data may contain embedded newline
     and tab characters, unlike data provided to the
     ‘send_formatted_data()’ interface.

 -- Method: writer.send_label_data (data)

     Set `data' to the left of the current left margin, if possible.
     The value of `data' is not restricted; treatment of non-string
     values is entirely application- and writer-dependent.  This method
     will only be called at the beginning of a line.


File: python.info,  Node: Writer Implementations,  Prev: The Writer Interface,  Up: formatter — Generic output formatting

5.34.1.4 Writer Implementations
...............................

Three implementations of the writer object interface are provided as
examples by this module.  Most applications will need to derive new
writer classes from the *note NullWriter: 3881. class.

 -- Class: formatter.NullWriter

     A writer which only provides the interface definition; no actions
     are taken on any methods.  This should be the base class for all
     writers which do not need to inherit any implementation methods.

 -- Class: formatter.AbstractWriter

     A writer which can be used in debugging formatters, but not much
     else.  Each method simply announces itself by printing its name and
     arguments on standard output.

 -- Class: formatter.DumbWriter (file=None, maxcol=72)

     Simple writer class which writes output on the *note file object:
     b35. passed in as `file' or, if `file' is omitted, on standard
     output.  The output is simply word-wrapped to the number of columns
     specified by `maxcol'.  This class is suitable for reflowing a
     sequence of paragraphs.


File: python.info,  Node: MS Windows Specific Services,  Next: Unix Specific Services,  Prev: Miscellaneous Services,  Up: The Python Standard Library

5.35 MS Windows Specific Services
=================================

This chapter describes modules that are only available on MS Windows
platforms.

* Menu:

* msilib — Read and write Microsoft Installer files::
* msvcrt — Useful routines from the MS VC++ runtime::
* winreg — Windows registry access::
* winsound — Sound-playing interface for Windows::


File: python.info,  Node: msilib — Read and write Microsoft Installer files,  Next: msvcrt — Useful routines from the MS VC++ runtime,  Up: MS Windows Specific Services

5.35.1 ‘msilib’ — Read and write Microsoft Installer files
----------------------------------------------------------

`Source code:' Lib/msilib/__init__.py(1)

__________________________________________________________________

The *note msilib: b5. supports the creation of Microsoft Installer
(‘.msi’) files.  Because these files often contain an embedded “cabinet”
file (‘.cab’), it also exposes an API to create CAB files.  Support for
reading ‘.cab’ files is currently not implemented; read support for the
‘.msi’ database is possible.

This package aims to provide complete access to all tables in an ‘.msi’
file, therefore, it is a fairly low-level API. Two primary applications
of this package are the *note distutils: 39. command ‘bdist_msi’, and
the creation of Python installer package itself (although that currently
uses a different version of ‘msilib’).

The package contents can be roughly split into four parts: low-level CAB
routines, low-level MSI routines, higher-level MSI routines, and
standard table structures.

 -- Function: msilib.FCICreate (cabname, files)

     Create a new CAB file named `cabname'.  `files' must be a list of
     tuples, each containing the name of the file on disk, and the name
     of the file inside the CAB file.

     The files are added to the CAB file in the order they appear in the
     list.  All files are added into a single CAB file, using the MSZIP
     compression algorithm.

     Callbacks to Python for the various steps of MSI creation are
     currently not exposed.

 -- Function: msilib.UuidCreate ()

     Return the string representation of a new unique identifier.  This
     wraps the Windows API functions ‘UuidCreate()’ and
     ‘UuidToString()’.

 -- Function: msilib.OpenDatabase (path, persist)

     Return a new database object by calling MsiOpenDatabase.  `path' is
     the file name of the MSI file; `persist' can be one of the
     constants ‘MSIDBOPEN_CREATEDIRECT’, ‘MSIDBOPEN_CREATE’,
     ‘MSIDBOPEN_DIRECT’, ‘MSIDBOPEN_READONLY’, or ‘MSIDBOPEN_TRANSACT’,
     and may include the flag ‘MSIDBOPEN_PATCHFILE’.  See the Microsoft
     documentation for the meaning of these flags; depending on the
     flags, an existing database is opened, or a new one created.

 -- Function: msilib.CreateRecord (count)

     Return a new record object by calling ‘MSICreateRecord()’.  `count'
     is the number of fields of the record.

 -- Function: msilib.init_database (name, schema, ProductName,
          ProductCode, ProductVersion, Manufacturer)

     Create and return a new database `name', initialize it with
     `schema', and set the properties `ProductName', `ProductCode',
     `ProductVersion', and `Manufacturer'.

     `schema' must be a module object containing ‘tables’ and
     ‘_Validation_records’ attributes; typically, *note msilib.schema:
     389d. should be used.

     The database will contain just the schema and the validation
     records when this function returns.

 -- Function: msilib.add_data (database, table, records)

     Add all `records' to the table named `table' in `database'.

     The `table' argument must be one of the predefined tables in the
     MSI schema, e.g.  ‘'Feature'’, ‘'File'’, ‘'Component'’, ‘'Dialog'’,
     ‘'Control'’, etc.

     `records' should be a list of tuples, each one containing all
     fields of a record according to the schema of the table.  For
     optional fields, ‘None’ can be passed.

     Field values can be ints, strings, or instances of the Binary
     class.

 -- Class: msilib.Binary (filename)

     Represents entries in the Binary table; inserting such an object
     using *note add_data(): 389e. reads the file named `filename' into
     the table.

 -- Function: msilib.add_tables (database, module)

     Add all table content from `module' to `database'.  `module' must
     contain an attribute `tables' listing all tables for which content
     should be added, and one attribute per table that has the actual
     content.

     This is typically used to install the sequence tables.

 -- Function: msilib.add_stream (database, name, path)

     Add the file `path' into the ‘_Stream’ table of `database', with
     the stream name `name'.

 -- Function: msilib.gen_uuid ()

     Return a new UUID, in the format that MSI typically requires (i.e.
     in curly braces, and with all hexdigits in upper-case).

See also
........

FCICreate(2) UuidCreate(3) UuidToString(4)

* Menu:

* Database Objects::
* View Objects::
* Summary Information Objects::
* Record Objects::
* Errors::
* CAB Objects::
* Directory Objects::
* Features: Features<3>.
* GUI classes::
* Precomputed tables::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/msilib/__init__.py

   (2) https://msdn.microsoft.com/en-us/library/bb432265.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa379205.aspx

   (4) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa379352.aspx


File: python.info,  Node: Database Objects,  Next: View Objects,  Up: msilib — Read and write Microsoft Installer files

5.35.1.1 Database Objects
.........................

 -- Method: Database.OpenView (sql)

     Return a view object, by calling ‘MSIDatabaseOpenView()’.  `sql' is
     the SQL statement to execute.

 -- Method: Database.Commit ()

     Commit the changes pending in the current transaction, by calling
     ‘MSIDatabaseCommit()’.

 -- Method: Database.GetSummaryInformation (count)

     Return a new summary information object, by calling
     ‘MsiGetSummaryInformation()’.  `count' is the maximum number of
     updated values.

 -- Method: Database.Close ()

     Close the database object, through ‘MsiCloseHandle()’.

     New in version 3.7.

See also
........

MSIDatabaseOpenView(1) MSIDatabaseCommit(2) MSIGetSummaryInformation(3)
MsiCloseHandle(4)

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370082.aspx

   (2) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370075.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370301.aspx

   (4) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370067.aspx


File: python.info,  Node: View Objects,  Next: Summary Information Objects,  Prev: Database Objects,  Up: msilib — Read and write Microsoft Installer files

5.35.1.2 View Objects
.....................

 -- Method: View.Execute (params)

     Execute the SQL query of the view, through ‘MSIViewExecute()’.  If
     `params' is not ‘None’, it is a record describing actual values of
     the parameter tokens in the query.

 -- Method: View.GetColumnInfo (kind)

     Return a record describing the columns of the view, through calling
     ‘MsiViewGetColumnInfo()’.  `kind' can be either ‘MSICOLINFO_NAMES’
     or ‘MSICOLINFO_TYPES’.

 -- Method: View.Fetch ()

     Return a result record of the query, through calling
     ‘MsiViewFetch()’.

 -- Method: View.Modify (kind, data)

     Modify the view, by calling ‘MsiViewModify()’.  `kind' can be one
     of ‘MSIMODIFY_SEEK’, ‘MSIMODIFY_REFRESH’, ‘MSIMODIFY_INSERT’,
     ‘MSIMODIFY_UPDATE’, ‘MSIMODIFY_ASSIGN’, ‘MSIMODIFY_REPLACE’,
     ‘MSIMODIFY_MERGE’, ‘MSIMODIFY_DELETE’,
     ‘MSIMODIFY_INSERT_TEMPORARY’, ‘MSIMODIFY_VALIDATE’,
     ‘MSIMODIFY_VALIDATE_NEW’, ‘MSIMODIFY_VALIDATE_FIELD’, or
     ‘MSIMODIFY_VALIDATE_DELETE’.

     `data' must be a record describing the new data.

 -- Method: View.Close ()

     Close the view, through ‘MsiViewClose()’.

See also
........

MsiViewExecute(1) MSIViewGetColumnInfo(2) MsiViewFetch(3)
MsiViewModify(4) MsiViewClose(5)

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370513.aspx

   (2) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370516.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370514.aspx

   (4) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370519.aspx

   (5) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370510.aspx


File: python.info,  Node: Summary Information Objects,  Next: Record Objects,  Prev: View Objects,  Up: msilib — Read and write Microsoft Installer files

5.35.1.3 Summary Information Objects
....................................

 -- Method: SummaryInformation.GetProperty (field)

     Return a property of the summary, through
     ‘MsiSummaryInfoGetProperty()’.  `field' is the name of the
     property, and can be one of the constants ‘PID_CODEPAGE’,
     ‘PID_TITLE’, ‘PID_SUBJECT’, ‘PID_AUTHOR’, ‘PID_KEYWORDS’,
     ‘PID_COMMENTS’, ‘PID_TEMPLATE’, ‘PID_LASTAUTHOR’, ‘PID_REVNUMBER’,
     ‘PID_LASTPRINTED’, ‘PID_CREATE_DTM’, ‘PID_LASTSAVE_DTM’,
     ‘PID_PAGECOUNT’, ‘PID_WORDCOUNT’, ‘PID_CHARCOUNT’, ‘PID_APPNAME’,
     or ‘PID_SECURITY’.

 -- Method: SummaryInformation.GetPropertyCount ()

     Return the number of summary properties, through
     ‘MsiSummaryInfoGetPropertyCount()’.

 -- Method: SummaryInformation.SetProperty (field, value)

     Set a property through ‘MsiSummaryInfoSetProperty()’.  `field' can
     have the same values as in *note GetProperty(): ef5, `value' is the
     new value of the property.  Possible value types are integer and
     string.

 -- Method: SummaryInformation.Persist ()

     Write the modified properties to the summary information stream,
     using ‘MsiSummaryInfoPersist()’.

See also
........

MsiSummaryInfoGetProperty(1) MsiSummaryInfoGetPropertyCount(2)
MsiSummaryInfoSetProperty(3) MsiSummaryInfoPersist(4)

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370409.aspx

   (2) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370488.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370491.aspx

   (4) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370490.aspx


File: python.info,  Node: Record Objects,  Next: Errors,  Prev: Summary Information Objects,  Up: msilib — Read and write Microsoft Installer files

5.35.1.4 Record Objects
.......................

 -- Method: Record.GetFieldCount ()

     Return the number of fields of the record, through
     ‘MsiRecordGetFieldCount()’.

 -- Method: Record.GetInteger (field)

     Return the value of `field' as an integer where possible.  `field'
     must be an integer.

 -- Method: Record.GetString (field)

     Return the value of `field' as a string where possible.  `field'
     must be an integer.

 -- Method: Record.SetString (field, value)

     Set `field' to `value' through ‘MsiRecordSetString()’.  `field'
     must be an integer; `value' a string.

 -- Method: Record.SetStream (field, value)

     Set `field' to the contents of the file named `value', through
     ‘MsiRecordSetStream()’.  `field' must be an integer; `value' a
     string.

 -- Method: Record.SetInteger (field, value)

     Set `field' to `value' through ‘MsiRecordSetInteger()’.  Both
     `field' and `value' must be an integer.

 -- Method: Record.ClearData ()

     Set all fields of the record to 0, through ‘MsiRecordClearData()’.

See also
........

MsiRecordGetFieldCount(1) MsiRecordSetString(2) MsiRecordSetStream(3)
MsiRecordSetInteger(4) MsiRecordClearData(5)

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370366.aspx

   (2) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370373.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370372.aspx

   (4) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370371.aspx

   (5) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370364.aspx


File: python.info,  Node: Errors,  Next: CAB Objects,  Prev: Record Objects,  Up: msilib — Read and write Microsoft Installer files

5.35.1.5 Errors
...............

All wrappers around MSI functions raise ‘MSIError’; the string inside
the exception will contain more detail.


File: python.info,  Node: CAB Objects,  Next: Directory Objects,  Prev: Errors,  Up: msilib — Read and write Microsoft Installer files

5.35.1.6 CAB Objects
....................

 -- Class: msilib.CAB (name)

     The class *note CAB: 38c1. represents a CAB file.  During MSI
     construction, files will be added simultaneously to the ‘Files’
     table, and to a CAB file.  Then, when all files have been added,
     the CAB file can be written, then added to the MSI file.

     `name' is the name of the CAB file in the MSI file.

      -- Method: append (full, file, logical)

          Add the file with the pathname `full' to the CAB file, under
          the name `logical'.  If there is already a file named
          `logical', a new file name is created.

          Return the index of the file in the CAB file, and the new name
          of the file inside the CAB file.

      -- Method: commit (database)

          Generate a CAB file, add it as a stream to the MSI file, put
          it into the ‘Media’ table, and remove the generated file from
          the disk.


File: python.info,  Node: Directory Objects,  Next: Features<3>,  Prev: CAB Objects,  Up: msilib — Read and write Microsoft Installer files

5.35.1.7 Directory Objects
..........................

 -- Class: msilib.Directory (database, cab, basedir, physical, logical,
          default[, componentflags])

     Create a new directory in the Directory table.  There is a current
     component at each point in time for the directory, which is either
     explicitly created through *note start_component(): ef6, or
     implicitly when files are added for the first time.  Files are
     added into the current component, and into the cab file.  To create
     a directory, a base directory object needs to be specified (can be
     ‘None’), the path to the physical directory, and a logical
     directory name.  `default' specifies the DefaultDir slot in the
     directory table.  `componentflags' specifies the default flags that
     new components get.

      -- Method: start_component (component=None, feature=None,
               flags=None, keyfile=None, uuid=None)

          Add an entry to the Component table, and make this component
          the current component for this directory.  If no component
          name is given, the directory name is used.  If no `feature' is
          given, the current feature is used.  If no `flags' are given,
          the directory’s default flags are used.  If no `keyfile' is
          given, the KeyPath is left null in the Component table.

      -- Method: add_file (file, src=None, version=None, language=None)

          Add a file to the current component of the directory, starting
          a new one if there is no current component.  By default, the
          file name in the source and the file table will be identical.
          If the `src' file is specified, it is interpreted relative to
          the current directory.  Optionally, a `version' and a
          `language' can be specified for the entry in the File table.

      -- Method: glob (pattern, exclude=None)

          Add a list of files to the current component as specified in
          the glob pattern.  Individual files can be excluded in the
          `exclude' list.

      -- Method: remove_pyc ()

          Remove ‘.pyc’ files on uninstall.

See also
........

Directory Table(1) File Table(2) Component Table(3) FeatureComponents
Table(4)

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368295.aspx

   (2) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368596.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368007.aspx

   (4) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368579.aspx


File: python.info,  Node: Features<3>,  Next: GUI classes,  Prev: Directory Objects,  Up: msilib — Read and write Microsoft Installer files

5.35.1.8 Features
.................

 -- Class: msilib.Feature (db, id, title, desc, display, level=1,
          parent=None, directory=None, attributes=0)

     Add a new record to the ‘Feature’ table, using the values `id',
     `parent.id', `title', `desc', `display', `level', `directory', and
     `attributes'.  The resulting feature object can be passed to the
     ‘start_component()’ method of *note Directory: 38c6.

      -- Method: set_current ()

          Make this feature the current feature of *note msilib: b5.
          New components are automatically added to the default feature,
          unless a feature is explicitly specified.

See also
........

Feature Table(1)

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368585.aspx


File: python.info,  Node: GUI classes,  Next: Precomputed tables,  Prev: Features<3>,  Up: msilib — Read and write Microsoft Installer files

5.35.1.9 GUI classes
....................

*note msilib: b5. provides several classes that wrap the GUI tables in
an MSI database.  However, no standard user interface is provided; use
*note bdist_msi: 41. to create MSI files with a user-interface for
installing Python packages.

 -- Class: msilib.Control (dlg, name)

     Base class of the dialog controls.  `dlg' is the dialog object the
     control belongs to, and `name' is the control’s name.

      -- Method: event (event, argument, condition=1, ordering=None)

          Make an entry into the ‘ControlEvent’ table for this control.

      -- Method: mapping (event, attribute)

          Make an entry into the ‘EventMapping’ table for this control.

      -- Method: condition (action, condition)

          Make an entry into the ‘ControlCondition’ table for this
          control.

 -- Class: msilib.RadioButtonGroup (dlg, name, property)

     Create a radio button control named `name'.  `property' is the
     installer property that gets set when a radio button is selected.

      -- Method: add (name, x, y, width, height, text, value=None)

          Add a radio button named `name' to the group, at the
          coordinates `x', `y', `width', `height', and with the label
          `text'.  If `value' is ‘None’, it defaults to `name'.

 -- Class: msilib.Dialog (db, name, x, y, w, h, attr, title, first,
          default, cancel)

     Return a new *note Dialog: 38d6. object.  An entry in the ‘Dialog’
     table is made, with the specified coordinates, dialog attributes,
     title, name of the first, default, and cancel controls.

      -- Method: control (name, type, x, y, width, height, attributes,
               property, text, control_next, help)

          Return a new *note Control: 38d0. object.  An entry in the
          ‘Control’ table is made with the specified parameters.

          This is a generic method; for specific types, specialized
          methods are provided.

      -- Method: text (name, x, y, width, height, attributes, text)

          Add and return a ‘Text’ control.

      -- Method: bitmap (name, x, y, width, height, text)

          Add and return a ‘Bitmap’ control.

      -- Method: line (name, x, y, width, height)

          Add and return a ‘Line’ control.

      -- Method: pushbutton (name, x, y, width, height, attributes,
               text, next_control)

          Add and return a ‘PushButton’ control.

      -- Method: radiogroup (name, x, y, width, height, attributes,
               property, text, next_control)

          Add and return a ‘RadioButtonGroup’ control.

      -- Method: checkbox (name, x, y, width, height, attributes,
               property, text, next_control)

          Add and return a ‘CheckBox’ control.

See also
........

Dialog Table(1) Control Table(2) Control Types(3) ControlCondition
Table(4) ControlEvent Table(5) EventMapping Table(6) RadioButton
Table(7)

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368286.aspx

   (2) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368044.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368039.aspx

   (4) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368035.aspx

   (5) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368037.aspx

   (6) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa368559.aspx

   (7) 
https://msdn.microsoft.com/en-us/library/windows/desktop/aa370962.aspx


File: python.info,  Node: Precomputed tables,  Prev: GUI classes,  Up: msilib — Read and write Microsoft Installer files

5.35.1.10 Precomputed tables
............................

*note msilib: b5. provides a few subpackages that contain only schema
and table definitions.  Currently, these definitions are based on MSI
version 2.0.

 -- Data: msilib.schema

     This is the standard MSI schema for MSI 2.0, with the `tables'
     variable providing a list of table definitions, and
     `_Validation_records' providing the data for MSI validation.

 -- Data: msilib.sequence

     This module contains table contents for the standard sequence
     tables: `AdminExecuteSequence', `AdminUISequence',
     `AdvtExecuteSequence', `InstallExecuteSequence', and
     `InstallUISequence'.

 -- Data: msilib.text

     This module contains definitions for the UIText and ActionText
     tables, for the standard installer actions.


File: python.info,  Node: msvcrt — Useful routines from the MS VC++ runtime,  Next: winreg — Windows registry access,  Prev: msilib — Read and write Microsoft Installer files,  Up: MS Windows Specific Services

5.35.2 ‘msvcrt’ — Useful routines from the MS VC++ runtime
----------------------------------------------------------

__________________________________________________________________

These functions provide access to some useful capabilities on Windows
platforms.  Some higher-level modules use these functions to build the
Windows implementations of their services.  For example, the *note
getpass: 88. module uses this in the implementation of the *note
getpass(): 88. function.

Further documentation on these functions can be found in the Platform
API documentation.

The module implements both the normal and wide char variants of the
console I/O api.  The normal API deals only with ASCII characters and is
of limited use for internationalized applications.  The wide char API
should be used where ever possible.

Changed in version 3.3: Operations in this module now raise *note
OSError: 1d1. where *note IOError: 986. was raised.

* Menu:

* File Operations::
* Console I/O::
* Other Functions::


File: python.info,  Node: File Operations,  Next: Console I/O,  Up: msvcrt — Useful routines from the MS VC++ runtime

5.35.2.1 File Operations
........................

 -- Function: msvcrt.locking (fd, mode, nbytes)

     Lock part of a file based on file descriptor `fd' from the C
     runtime.  Raises *note OSError: 1d1. on failure.  The locked region
     of the file extends from the current file position for `nbytes'
     bytes, and may continue beyond the end of the file.  `mode' must be
     one of the ‘LK_*’ constants listed below.  Multiple regions in a
     file may be locked at the same time, but may not overlap.  Adjacent
     regions are not merged; they must be unlocked individually.

 -- Data: msvcrt.LK_LOCK
 -- Data: msvcrt.LK_RLCK

     Locks the specified bytes.  If the bytes cannot be locked, the
     program immediately tries again after 1 second.  If, after 10
     attempts, the bytes cannot be locked, *note OSError: 1d1. is
     raised.

 -- Data: msvcrt.LK_NBLCK
 -- Data: msvcrt.LK_NBRLCK

     Locks the specified bytes.  If the bytes cannot be locked, *note
     OSError: 1d1. is raised.

 -- Data: msvcrt.LK_UNLCK

     Unlocks the specified bytes, which must have been previously
     locked.

 -- Function: msvcrt.setmode (fd, flags)

     Set the line-end translation mode for the file descriptor `fd'.  To
     set it to text mode, `flags' should be *note os.O_TEXT: 1e64.; for
     binary, it should be *note os.O_BINARY: 1e55.

 -- Function: msvcrt.open_osfhandle (handle, flags)

     Create a C runtime file descriptor from the file handle `handle'.
     The `flags' parameter should be a bitwise OR of *note os.O_APPEND:
     1e57, *note os.O_RDONLY: 1e53, and *note os.O_TEXT: 1e64.  The
     returned file descriptor may be used as a parameter to *note
     os.fdopen(): 136d. to create a file object.

 -- Function: msvcrt.get_osfhandle (fd)

     Return the file handle for the file descriptor `fd'.  Raises *note
     OSError: 1d1. if `fd' is not recognized.


File: python.info,  Node: Console I/O,  Next: Other Functions,  Prev: File Operations,  Up: msvcrt — Useful routines from the MS VC++ runtime

5.35.2.2 Console I/O
....................

 -- Function: msvcrt.kbhit ()

     Return ‘True’ if a keypress is waiting to be read.

 -- Function: msvcrt.getch ()

     Read a keypress and return the resulting character as a byte
     string.  Nothing is echoed to the console.  This call will block if
     a keypress is not already available, but will not wait for ‘Enter’
     to be pressed.  If the pressed key was a special function key, this
     will return ‘'\000'’ or ‘'\xe0'’; the next call will return the
     keycode.  The ‘Control-C’ keypress cannot be read with this
     function.

 -- Function: msvcrt.getwch ()

     Wide char variant of *note getch(): 38f2, returning a Unicode
     value.

 -- Function: msvcrt.getche ()

     Similar to *note getch(): 38f2, but the keypress will be echoed if
     it represents a printable character.

 -- Function: msvcrt.getwche ()

     Wide char variant of *note getche(): 38f4, returning a Unicode
     value.

 -- Function: msvcrt.putch (char)

     Print the byte string `char' to the console without buffering.

 -- Function: msvcrt.putwch (unicode_char)

     Wide char variant of *note putch(): 38f6, accepting a Unicode
     value.

 -- Function: msvcrt.ungetch (char)

     Cause the byte string `char' to be “pushed back” into the console
     buffer; it will be the next character read by *note getch(): 38f2.
     or *note getche(): 38f4.

 -- Function: msvcrt.ungetwch (unicode_char)

     Wide char variant of *note ungetch(): 38f8, accepting a Unicode
     value.


File: python.info,  Node: Other Functions,  Prev: Console I/O,  Up: msvcrt — Useful routines from the MS VC++ runtime

5.35.2.3 Other Functions
........................

 -- Function: msvcrt.heapmin ()

     Force the ‘malloc()’ heap to clean itself up and return unused
     blocks to the operating system.  On failure, this raises *note
     OSError: 1d1.


File: python.info,  Node: winreg — Windows registry access,  Next: winsound — Sound-playing interface for Windows,  Prev: msvcrt — Useful routines from the MS VC++ runtime,  Up: MS Windows Specific Services

5.35.3 ‘winreg’ — Windows registry access
-----------------------------------------

__________________________________________________________________

These functions expose the Windows registry API to Python.  Instead of
using an integer as the registry handle, a *note handle object: 38ff. is
used to ensure that the handles are closed correctly, even if the
programmer neglects to explicitly close them.

Changed in version 3.3: Several functions in this module used to raise a
*note WindowsError: 988, which is now an alias of *note OSError: 1d1.

* Menu:

* Functions: Functions<11>.
* Constants: Constants<10>.
* Registry Handle Objects::


File: python.info,  Node: Functions<11>,  Next: Constants<10>,  Up: winreg — Windows registry access

5.35.3.1 Functions
..................

This module offers the following functions:

 -- Function: winreg.CloseKey (hkey)

     Closes a previously opened registry key.  The `hkey' argument
     specifies a previously opened key.

          Note: If `hkey' is not closed using this method (or via *note
          hkey.Close(): 3904.), it is closed when the `hkey' object is
          destroyed by Python.

 -- Function: winreg.ConnectRegistry (computer_name, key)

     Establishes a connection to a predefined registry handle on another
     computer, and returns a *note handle object: 38ff.

     `computer_name' is the name of the remote computer, of the form
     ‘r"\\computername"’.  If ‘None’, the local computer is used.

     `key' is the predefined handle to connect to.

     The return value is the handle of the opened key.  If the function
     fails, an *note OSError: 1d1. exception is raised.

     Raises an *note auditing event: 1275. ‘winreg.ConnectRegistry’ with
     arguments ‘computer_name’, ‘key’.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.CreateKey (key, sub_key)

     Creates or opens the specified key, returning a *note handle
     object: 38ff.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `sub_key' is a string that names the key this method opens or
     creates.

     If `key' is one of the predefined keys, `sub_key' may be ‘None’.
     In that case, the handle returned is the same key handle passed in
     to the function.

     If the key already exists, this function opens the existing key.

     The return value is the handle of the opened key.  If the function
     fails, an *note OSError: 1d1. exception is raised.

     Raises an *note auditing event: 1275. ‘winreg.CreateKey’ with
     arguments ‘key’, ‘sub_key’, ‘access’.

     Raises an *note auditing event: 1275. ‘winreg.OpenKey/result’ with
     argument ‘key’.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.CreateKeyEx (key, sub_key, reserved=0,
          access=KEY_WRITE)

     Creates or opens the specified key, returning a *note handle
     object: 38ff.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `sub_key' is a string that names the key this method opens or
     creates.

     `reserved' is a reserved integer, and must be zero.  The default is
     zero.

     `access' is an integer that specifies an access mask that describes
     the desired security access for the key.  Default is *note
     KEY_WRITE: 3906.  See *note Access Rights: 3907. for other allowed
     values.

     If `key' is one of the predefined keys, `sub_key' may be ‘None’.
     In that case, the handle returned is the same key handle passed in
     to the function.

     If the key already exists, this function opens the existing key.

     The return value is the handle of the opened key.  If the function
     fails, an *note OSError: 1d1. exception is raised.

     Raises an *note auditing event: 1275. ‘winreg.CreateKey’ with
     arguments ‘key’, ‘sub_key’, ‘access’.

     Raises an *note auditing event: 1275. ‘winreg.OpenKey/result’ with
     argument ‘key’.

     New in version 3.2.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.DeleteKey (key, sub_key)

     Deletes the specified key.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `sub_key' is a string that must be a subkey of the key identified
     by the `key' parameter.  This value must not be ‘None’, and the key
     may not have subkeys.

     `This method can not delete keys with subkeys.'

     If the method succeeds, the entire key, including all of its
     values, is removed.  If the method fails, an *note OSError: 1d1.
     exception is raised.

     Raises an *note auditing event: 1275. ‘winreg.DeleteKey’ with
     arguments ‘key’, ‘sub_key’, ‘access’.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.DeleteKeyEx (key, sub_key, access=KEY_WOW64_64KEY,
          reserved=0)

     Deletes the specified key.

          Note: The *note DeleteKeyEx(): 3414. function is implemented
          with the RegDeleteKeyEx Windows API function, which is
          specific to 64-bit versions of Windows.  See the
          RegDeleteKeyEx documentation(1).

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `sub_key' is a string that must be a subkey of the key identified
     by the `key' parameter.  This value must not be ‘None’, and the key
     may not have subkeys.

     `reserved' is a reserved integer, and must be zero.  The default is
     zero.

     `access' is an integer that specifies an access mask that describes
     the desired security access for the key.  Default is *note
     KEY_WOW64_64KEY: 3908.  See *note Access Rights: 3907. for other
     allowed values.

     `This method can not delete keys with subkeys.'

     If the method succeeds, the entire key, including all of its
     values, is removed.  If the method fails, an *note OSError: 1d1.
     exception is raised.

     On unsupported Windows versions, *note NotImplementedError: 603. is
     raised.

     Raises an *note auditing event: 1275. ‘winreg.DeleteKey’ with
     arguments ‘key’, ‘sub_key’, ‘access’.

     New in version 3.2.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.DeleteValue (key, value)

     Removes a named value from a registry key.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `value' is a string that identifies the value to remove.

     Raises an *note auditing event: 1275. ‘winreg.DeleteValue’ with
     arguments ‘key’, ‘value’.

 -- Function: winreg.EnumKey (key, index)

     Enumerates subkeys of an open registry key, returning a string.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `index' is an integer that identifies the index of the key to
     retrieve.

     The function retrieves the name of one subkey each time it is
     called.  It is typically called repeatedly until an *note OSError:
     1d1. exception is raised, indicating, no more values are available.

     Raises an *note auditing event: 1275. ‘winreg.EnumKey’ with
     arguments ‘key’, ‘index’.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.EnumValue (key, index)

     Enumerates values of an open registry key, returning a tuple.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `index' is an integer that identifies the index of the value to
     retrieve.

     The function retrieves the name of one subkey each time it is
     called.  It is typically called repeatedly, until an *note OSError:
     1d1. exception is raised, indicating no more values.

     The result is a tuple of 3 items:

     Index       Meaning
                 
     -------------------------------------------------------------
                 
     ‘0’         A string that identifies the value name
                 
                 
     ‘1’         An object that holds the value data, and whose
                 type depends on the underlying registry type
                 
                 
     ‘2’         An integer that identifies the type of the
                 value data (see table in docs for
                 *note SetValueEx(): 3424.)
                 

     Raises an *note auditing event: 1275. ‘winreg.EnumValue’ with
     arguments ‘key’, ‘index’.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.ExpandEnvironmentStrings (str)

     Expands environment variable placeholders ‘%NAME%’ in strings like
     *note REG_EXPAND_SZ: 3909.:

          >>> ExpandEnvironmentStrings('%windir%') 'C:\\Windows'

     Raises an *note auditing event: 1275.
     ‘winreg.ExpandEnvironmentStrings’ with argument ‘str’.

 -- Function: winreg.FlushKey (key)

     Writes all the attributes of a key to the registry.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     It is not necessary to call *note FlushKey(): 390a. to change a
     key.  Registry changes are flushed to disk by the registry using
     its lazy flusher.  Registry changes are also flushed to disk at
     system shutdown.  Unlike *note CloseKey(): 3903, the *note
     FlushKey(): 390a. method returns only when all the data has been
     written to the registry.  An application should only call *note
     FlushKey(): 390a. if it requires absolute certainty that registry
     changes are on disk.

          Note: If you don’t know whether a *note FlushKey(): 390a. call
          is required, it probably isn’t.

 -- Function: winreg.LoadKey (key, sub_key, file_name)

     Creates a subkey under the specified key and stores registration
     information from a specified file into that subkey.

     `key' is a handle returned by *note ConnectRegistry(): 3410. or one
     of the constants *note HKEY_USERS: 390b. or *note
     HKEY_LOCAL_MACHINE: 390c.

     `sub_key' is a string that identifies the subkey to load.

     `file_name' is the name of the file to load registry data from.
     This file must have been created with the *note SaveKey(): 3422.
     function.  Under the file allocation table (FAT) file system, the
     filename may not have an extension.

     A call to *note LoadKey(): 341b. fails if the calling process does
     not have the ‘SE_RESTORE_PRIVILEGE’ privilege.  Note that
     privileges are different from permissions – see the RegLoadKey
     documentation(2) for more details.

     If `key' is a handle returned by *note ConnectRegistry(): 3410,
     then the path specified in `file_name' is relative to the remote
     computer.

     Raises an *note auditing event: 1275. ‘winreg.LoadKey’ with
     arguments ‘key’, ‘sub_key’, ‘file_name’.

 -- Function: winreg.OpenKey (key, sub_key, reserved=0, access=KEY_READ)
 -- Function: winreg.OpenKeyEx (key, sub_key, reserved=0,
          access=KEY_READ)

     Opens the specified key, returning a *note handle object: 38ff.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `sub_key' is a string that identifies the sub_key to open.

     `reserved' is a reserved integer, and must be zero.  The default is
     zero.

     `access' is an integer that specifies an access mask that describes
     the desired security access for the key.  Default is *note
     KEY_READ: 390e.  See *note Access Rights: 3907. for other allowed
     values.

     The result is a new handle to the specified key.

     If the function fails, *note OSError: 1d1. is raised.

     Raises an *note auditing event: 1275. ‘winreg.OpenKey’ with
     arguments ‘key’, ‘sub_key’, ‘access’.

     Raises an *note auditing event: 1275. ‘winreg.OpenKey/result’ with
     argument ‘key’.

     Changed in version 3.2: Allow the use of named arguments.

     Changed in version 3.3: See *note above: 3900.

 -- Function: winreg.QueryInfoKey (key)

     Returns information about a key, as a tuple.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     The result is a tuple of 3 items:

     Index       Meaning
                 
     --------------------------------------------------------------
                 
     ‘0’         An integer giving the number of sub keys this
                 key has.
                 
                 
     ‘1’         An integer giving the number of values this key
                 has.
                 
                 
     ‘2’         An integer giving when the key was last
                 modified (if available) as 100’s of nanoseconds
                 since Jan 1, 1601.
                 

     Raises an *note auditing event: 1275. ‘winreg.QueryInfoKey’ with
     argument ‘key’.

 -- Function: winreg.QueryValue (key, sub_key)

     Retrieves the unnamed value for a key, as a string.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `sub_key' is a string that holds the name of the subkey with which
     the value is associated.  If this parameter is ‘None’ or empty, the
     function retrieves the value set by the *note SetValue(): 3423.
     method for the key identified by `key'.

     Values in the registry have name, type, and data components.  This
     method retrieves the data for a key’s first value that has a ‘NULL’
     name.  But the underlying API call doesn’t return the type, so
     always use *note QueryValueEx(): 3421. if possible.

     Raises an *note auditing event: 1275. ‘winreg.QueryValue’ with
     arguments ‘key’, ‘sub_key’, ‘value_name’.

 -- Function: winreg.QueryValueEx (key, value_name)

     Retrieves the type and data for a specified value name associated
     with an open registry key.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `value_name' is a string indicating the value to query.

     The result is a tuple of 2 items:

     Index       Meaning
                 
     ----------------------------------------------------------
                 
     ‘0’         The value of the registry item.
                 
                 
     ‘1’         An integer giving the registry type for
                 this value (see table in docs for
                 *note SetValueEx(): 3424.)
                 

     Raises an *note auditing event: 1275. ‘winreg.QueryValue’ with
     arguments ‘key’, ‘sub_key’, ‘value_name’.

 -- Function: winreg.SaveKey (key, file_name)

     Saves the specified key, and all its subkeys to the specified file.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `file_name' is the name of the file to save registry data to.  This
     file cannot already exist.  If this filename includes an extension,
     it cannot be used on file allocation table (FAT) file systems by
     the *note LoadKey(): 341b. method.

     If `key' represents a key on a remote computer, the path described
     by `file_name' is relative to the remote computer.  The caller of
     this method must possess the ‘SeBackupPrivilege’ security
     privilege.  Note that privileges are different than permissions –
     see the Conflicts Between User Rights and Permissions
     documentation(3) for more details.

     This function passes ‘NULL’ for `security_attributes' to the API.

     Raises an *note auditing event: 1275. ‘winreg.SaveKey’ with
     arguments ‘key’, ‘file_name’.

 -- Function: winreg.SetValue (key, sub_key, type, value)

     Associates a value with a specified key.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `sub_key' is a string that names the subkey with which the value is
     associated.

     `type' is an integer that specifies the type of the data.
     Currently this must be *note REG_SZ: 390f, meaning only strings are
     supported.  Use the *note SetValueEx(): 3424. function for support
     for other data types.

     `value' is a string that specifies the new value.

     If the key specified by the `sub_key' parameter does not exist, the
     SetValue function creates it.

     Value lengths are limited by available memory.  Long values (more
     than 2048 bytes) should be stored as files with the filenames
     stored in the configuration registry.  This helps the registry
     perform efficiently.

     The key identified by the `key' parameter must have been opened
     with *note KEY_SET_VALUE: 3910. access.

     Raises an *note auditing event: 1275. ‘winreg.SetValue’ with
     arguments ‘key’, ‘sub_key’, ‘type’, ‘value’.

 -- Function: winreg.SetValueEx (key, value_name, reserved, type, value)

     Stores data in the value field of an open registry key.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     `value_name' is a string that names the subkey with which the value
     is associated.

     `reserved' can be anything – zero is always passed to the API.

     `type' is an integer that specifies the type of the data.  See
     *note Value Types: 3911. for the available types.

     `value' is a string that specifies the new value.

     This method can also set additional value and type information for
     the specified key.  The key identified by the key parameter must
     have been opened with *note KEY_SET_VALUE: 3910. access.

     To open the key, use the *note CreateKey(): 3411. or *note
     OpenKey(): 341c. methods.

     Value lengths are limited by available memory.  Long values (more
     than 2048 bytes) should be stored as files with the filenames
     stored in the configuration registry.  This helps the registry
     perform efficiently.

     Raises an *note auditing event: 1275. ‘winreg.SetValue’ with
     arguments ‘key’, ‘sub_key’, ‘type’, ‘value’.

 -- Function: winreg.DisableReflectionKey (key)

     Disables registry reflection for 32-bit processes running on a
     64-bit operating system.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     Will generally raise *note NotImplementedError: 603. if executed on
     a 32-bit operating system.

     If the key is not on the reflection list, the function succeeds but
     has no effect.  Disabling reflection for a key does not affect
     reflection of any subkeys.

     Raises an *note auditing event: 1275. ‘winreg.DisableReflectionKey’
     with argument ‘key’.

 -- Function: winreg.EnableReflectionKey (key)

     Restores registry reflection for the specified disabled key.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     Will generally raise *note NotImplementedError: 603. if executed on
     a 32-bit operating system.

     Restoring reflection for a key does not affect reflection of any
     subkeys.

     Raises an *note auditing event: 1275. ‘winreg.EnableReflectionKey’
     with argument ‘key’.

 -- Function: winreg.QueryReflectionKey (key)

     Determines the reflection state for the specified key.

     `key' is an already open key, or one of the predefined *note HKEY_*
     constants: 3905.

     Returns ‘True’ if reflection is disabled.

     Will generally raise *note NotImplementedError: 603. if executed on
     a 32-bit operating system.

     Raises an *note auditing event: 1275. ‘winreg.QueryReflectionKey’
     with argument ‘key’.

   ---------- Footnotes ----------

   (1) https://msdn.microsoft.com/en-us/library/ms724847%28VS.85%29.aspx

   (2) 
https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx

   (3) 
https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx


File: python.info,  Node: Constants<10>,  Next: Registry Handle Objects,  Prev: Functions<11>,  Up: winreg — Windows registry access

5.35.3.2 Constants
..................

The following constants are defined for use in many ‘_winreg’ functions.

* Menu:

* HKEY_* Constants::
* Access Rights::
* Value Types::


File: python.info,  Node: HKEY_* Constants,  Next: Access Rights,  Up: Constants<10>

5.35.3.3 HKEY_* Constants
.........................

 -- Data: winreg.HKEY_CLASSES_ROOT

     Registry entries subordinate to this key define types (or classes)
     of documents and the properties associated with those types.  Shell
     and COM applications use the information stored under this key.

 -- Data: winreg.HKEY_CURRENT_USER

     Registry entries subordinate to this key define the preferences of
     the current user.  These preferences include the settings of
     environment variables, data about program groups, colors, printers,
     network connections, and application preferences.

 -- Data: winreg.HKEY_LOCAL_MACHINE

     Registry entries subordinate to this key define the physical state
     of the computer, including data about the bus type, system memory,
     and installed hardware and software.

 -- Data: winreg.HKEY_USERS

     Registry entries subordinate to this key define the default user
     configuration for new users on the local computer and the user
     configuration for the current user.

 -- Data: winreg.HKEY_PERFORMANCE_DATA

     Registry entries subordinate to this key allow you to access
     performance data.  The data is not actually stored in the registry;
     the registry functions cause the system to collect the data from
     its source.

 -- Data: winreg.HKEY_CURRENT_CONFIG

     Contains information about the current hardware profile of the
     local computer system.

 -- Data: winreg.HKEY_DYN_DATA

     This key is not used in versions of Windows after 98.


File: python.info,  Node: Access Rights,  Next: Value Types,  Prev: HKEY_* Constants,  Up: Constants<10>

5.35.3.4 Access Rights
......................

For more information, see Registry Key Security and Access(1).

 -- Data: winreg.KEY_ALL_ACCESS

     Combines the STANDARD_RIGHTS_REQUIRED, *note KEY_QUERY_VALUE: 391c,
     *note KEY_SET_VALUE: 3910, *note KEY_CREATE_SUB_KEY: 391d, *note
     KEY_ENUMERATE_SUB_KEYS: 391e, *note KEY_NOTIFY: 391f, and *note
     KEY_CREATE_LINK: 3920. access rights.

 -- Data: winreg.KEY_WRITE

     Combines the STANDARD_RIGHTS_WRITE, *note KEY_SET_VALUE: 3910, and
     *note KEY_CREATE_SUB_KEY: 391d. access rights.

 -- Data: winreg.KEY_READ

     Combines the STANDARD_RIGHTS_READ, *note KEY_QUERY_VALUE: 391c,
     *note KEY_ENUMERATE_SUB_KEYS: 391e, and *note KEY_NOTIFY: 391f.
     values.

 -- Data: winreg.KEY_EXECUTE

     Equivalent to *note KEY_READ: 390e.

 -- Data: winreg.KEY_QUERY_VALUE

     Required to query the values of a registry key.

 -- Data: winreg.KEY_SET_VALUE

     Required to create, delete, or set a registry value.

 -- Data: winreg.KEY_CREATE_SUB_KEY

     Required to create a subkey of a registry key.

 -- Data: winreg.KEY_ENUMERATE_SUB_KEYS

     Required to enumerate the subkeys of a registry key.

 -- Data: winreg.KEY_NOTIFY

     Required to request change notifications for a registry key or for
     subkeys of a registry key.

 -- Data: winreg.KEY_CREATE_LINK

     Reserved for system use.

* Menu:

* 64-bit Specific::

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx


File: python.info,  Node: 64-bit Specific,  Up: Access Rights

5.35.3.5 64-bit Specific
........................

For more information, see Accessing an Alternate Registry View(1).

 -- Data: winreg.KEY_WOW64_64KEY

     Indicates that an application on 64-bit Windows should operate on
     the 64-bit registry view.

 -- Data: winreg.KEY_WOW64_32KEY

     Indicates that an application on 64-bit Windows should operate on
     the 32-bit registry view.

   ---------- Footnotes ----------

   (1) https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx


File: python.info,  Node: Value Types,  Prev: Access Rights,  Up: Constants<10>

5.35.3.6 Value Types
....................

For more information, see Registry Value Types(1).

 -- Data: winreg.REG_BINARY

     Binary data in any form.

 -- Data: winreg.REG_DWORD

     32-bit number.

 -- Data: winreg.REG_DWORD_LITTLE_ENDIAN

     A 32-bit number in little-endian format.  Equivalent to *note
     REG_DWORD: 3927.

 -- Data: winreg.REG_DWORD_BIG_ENDIAN

     A 32-bit number in big-endian format.

 -- Data: winreg.REG_EXPAND_SZ

     Null-terminated string containing references to environment
     variables (‘%PATH%’).

 -- Data: winreg.REG_LINK

     A Unicode symbolic link.

 -- Data: winreg.REG_MULTI_SZ

     A sequence of null-terminated strings, terminated by two null
     characters.  (Python handles this termination automatically.)

 -- Data: winreg.REG_NONE

     No defined value type.

 -- Data: winreg.REG_QWORD

     A 64-bit number.

     New in version 3.6.

 -- Data: winreg.REG_QWORD_LITTLE_ENDIAN

     A 64-bit number in little-endian format.  Equivalent to *note
     REG_QWORD: 5a7.

     New in version 3.6.

 -- Data: winreg.REG_RESOURCE_LIST

     A device-driver resource list.

 -- Data: winreg.REG_FULL_RESOURCE_DESCRIPTOR

     A hardware setting.

 -- Data: winreg.REG_RESOURCE_REQUIREMENTS_LIST

     A hardware resource list.

 -- Data: winreg.REG_SZ

     A null-terminated string.

   ---------- Footnotes ----------

   (1) 
https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx


File: python.info,  Node: Registry Handle Objects,  Prev: Constants<10>,  Up: winreg — Windows registry access

5.35.3.7 Registry Handle Objects
................................

This object wraps a Windows HKEY object, automatically closing it when
the object is destroyed.  To guarantee cleanup, you can call either the
*note Close(): 3904. method on the object, or the *note CloseKey():
3903. function.

All registry functions in this module return one of these objects.

All registry functions in this module which accept a handle object also
accept an integer, however, use of the handle object is encouraged.

Handle objects provide semantics for *note __bool__(): c5b. – thus

     if handle:     print("Yes")

will print ‘Yes’ if the handle is currently valid (has not been closed
or detached).

The object also support comparison semantics, so handle objects will
compare true if they both reference the same underlying Windows handle
value.

Handle objects can be converted to an integer (e.g., using the built-in
*note int(): 184. function), in which case the underlying Windows handle
value is returned.  You can also use the *note Detach(): 341d. method to
return the integer handle, and also disconnect the Windows handle from
the handle object.

 -- Method: PyHKEY.Close ()

     Closes the underlying Windows handle.

     If the handle is already closed, no error is raised.

 -- Method: PyHKEY.Detach ()

     Detaches the Windows handle from the handle object.

     The result is an integer that holds the value of the handle before
     it is detached.  If the handle is already detached or closed, this
     will return zero.

     After calling this function, the handle is effectively invalidated,
     but the handle is not closed.  You would call this function when
     you need the underlying Win32 handle to exist beyond the lifetime
     of the handle object.

     Raises an *note auditing event: 1275. ‘winreg.PyHKEY.Detach’ with
     argument ‘key’.

 -- Method: PyHKEY.__enter__ ()
 -- Method: PyHKEY.__exit__ (*exc_info)

     The HKEY object implements *note __enter__(): c88. and *note
     __exit__(): c89. and thus supports the context protocol for the
     *note with: 6dd. statement:

          with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:     ...  # work with key

     will automatically close `key' when control leaves the *note with:
     6dd. block.


File: python.info,  Node: winsound — Sound-playing interface for Windows,  Prev: winreg — Windows registry access,  Up: MS Windows Specific Services

5.35.4 ‘winsound’ — Sound-playing interface for Windows
-------------------------------------------------------

__________________________________________________________________

The *note winsound: 12b. module provides access to the basic
sound-playing machinery provided by Windows platforms.  It includes
functions and several constants.

 -- Function: winsound.Beep (frequency, duration)

     Beep the PC’s speaker.  The `frequency' parameter specifies
     frequency, in hertz, of the sound, and must be in the range 37
     through 32,767.  The `duration' parameter specifies the number of
     milliseconds the sound should last.  If the system is not able to
     beep the speaker, *note RuntimeError: 2b8. is raised.

 -- Function: winsound.PlaySound (sound, flags)

     Call the underlying ‘PlaySound()’ function from the Platform API.
     The `sound' parameter may be a filename, a system sound alias,
     audio data as a *note bytes-like object: 5dd, or ‘None’.  Its
     interpretation depends on the value of `flags', which can be a
     bitwise ORed combination of the constants described below.  If the
     `sound' parameter is ‘None’, any currently playing waveform sound
     is stopped.  If the system indicates an error, *note RuntimeError:
     2b8. is raised.

 -- Function: winsound.MessageBeep (type=MB_OK)

     Call the underlying ‘MessageBeep()’ function from the Platform API.
     This plays a sound as specified in the registry.  The `type'
     argument specifies which sound to play; possible values are ‘-1’,
     ‘MB_ICONASTERISK’, ‘MB_ICONEXCLAMATION’, ‘MB_ICONHAND’,
     ‘MB_ICONQUESTION’, and ‘MB_OK’, all described below.  The value
     ‘-1’ produces a “simple beep”; this is the final fallback if a
     sound cannot be played otherwise.  If the system indicates an
     error, *note RuntimeError: 2b8. is raised.

 -- Data: winsound.SND_FILENAME

     The `sound' parameter is the name of a WAV file.  Do not use with
     *note SND_ALIAS: 3936.

 -- Data: winsound.SND_ALIAS

     The `sound' parameter is a sound association name from the
     registry.  If the registry contains no such name, play the system
     default sound unless *note SND_NODEFAULT: 3937. is also specified.
     If no default sound is registered, raise *note RuntimeError: 2b8.
     Do not use with *note SND_FILENAME: 3935.

     All Win32 systems support at least the following; most systems
     support many more:

     *note PlaySound(): 5ab.        Corresponding Control Panel Sound name
     `name'                         

     ----------------------------------------------------------------------------
                                    
     ‘'SystemAsterisk'’             Asterisk
                                    
                                    
     ‘'SystemExclamation'’          Exclamation
                                    
                                    
     ‘'SystemExit'’                 Exit Windows
                                    
                                    
     ‘'SystemHand'’                 Critical Stop
                                    
                                    
     ‘'SystemQuestion'’             Question
                                    

     For example:

          import winsound # Play Windows exit sound. winsound.PlaySound("SystemExit", winsound.SND_ALIAS)  # Probably play Windows default sound, if any is registered (because # "*" probably isn't the registered name of any sound). winsound.PlaySound("*", winsound.SND_ALIAS)

 -- Data: winsound.SND_LOOP

     Play the sound repeatedly.  The *note SND_ASYNC: 3939. flag must
     also be used to avoid blocking.  Cannot be used with *note
     SND_MEMORY: 393a.

 -- Data: winsound.SND_MEMORY

     The `sound' parameter to *note PlaySound(): 5ab. is a memory image
     of a WAV file, as a *note bytes-like object: 5dd.

          Note: This module does not support playing from a memory image
          asynchronously, so a combination of this flag and *note
          SND_ASYNC: 3939. will raise *note RuntimeError: 2b8.

 -- Data: winsound.SND_PURGE

     Stop playing all instances of the specified sound.

          Note: This flag is not supported on modern Windows platforms.

 -- Data: winsound.SND_ASYNC

     Return immediately, allowing sounds to play asynchronously.

 -- Data: winsound.SND_NODEFAULT

     If the specified sound cannot be found, do not play the system
     default sound.

 -- Data: winsound.SND_NOSTOP

     Do not interrupt sounds currently playing.

 -- Data: winsound.SND_NOWAIT

     Return immediately if the sound driver is busy.

          Note: This flag is not supported on modern Windows platforms.

 -- Data: winsound.MB_ICONASTERISK

     Play the ‘SystemDefault’ sound.

 -- Data: winsound.MB_ICONEXCLAMATION

     Play the ‘SystemExclamation’ sound.

 -- Data: winsound.MB_ICONHAND

     Play the ‘SystemHand’ sound.

 -- Data: winsound.MB_ICONQUESTION

     Play the ‘SystemQuestion’ sound.

 -- Data: winsound.MB_OK

     Play the ‘SystemDefault’ sound.


File: python.info,  Node: Unix Specific Services,  Next: Superseded Modules,  Prev: MS Windows Specific Services,  Up: The Python Standard Library

5.36 Unix Specific Services
===========================

The modules described in this chapter provide interfaces to features
that are unique to the Unix operating system, or in some cases to some
or many variants of it.  Here’s an overview:

* Menu:

* posix — The most common POSIX system calls::
* pwd — The password database::
* spwd — The shadow password database::
* grp — The group database::
* crypt — Function to check Unix passwords::
* termios — POSIX style tty control::
* tty — Terminal control functions::
* pty — Pseudo-terminal utilities::
* fcntl — The fcntl and ioctl system calls::
* pipes — Interface to shell pipelines::
* resource — Resource usage information::
* nis — Interface to Sun’s NIS (Yellow Pages): nis — Interface to Sun’s NIS Yellow Pages.
* syslog — Unix syslog library routines::


File: python.info,  Node: posix — The most common POSIX system calls,  Next: pwd — The password database,  Up: Unix Specific Services

5.36.1 ‘posix’ — The most common POSIX system calls
---------------------------------------------------

__________________________________________________________________

This module provides access to operating system functionality that is
standardized by the C Standard and the POSIX standard (a thinly
disguised Unix interface).

`Do not import this module directly.'  Instead, import the module *note
os: c4, which provides a `portable' version of this interface.  On Unix,
the *note os: c4. module provides a superset of the *note posix: d1.
interface.  On non-Unix operating systems the *note posix: d1. module is
not available, but a subset is always available through the *note os:
c4. interface.  Once *note os: c4. is imported, there is `no'
performance penalty in using it instead of *note posix: d1.  In
addition, *note os: c4. provides some additional functionality, such as
automatically calling *note putenv(): 1e21. when an entry in
‘os.environ’ is changed.

Errors are reported as exceptions; the usual exceptions are given for
type errors, while errors reported by the system calls raise *note
OSError: 1d1.

* Menu:

* Large File Support::
* Notable Module Contents::


File: python.info,  Node: Large File Support,  Next: Notable Module Contents,  Up: posix — The most common POSIX system calls

5.36.1.1 Large File Support
...........................

Several operating systems (including AIX, HP-UX, Irix and Solaris)
provide support for files that are larger than 2 GiB from a C
programming model where ‘int’ and ‘long’ are 32-bit values.  This is
typically accomplished by defining the relevant size and offset types as
64-bit values.  Such files are sometimes referred to as `large files'.

Large file support is enabled in Python when the size of an ‘off_t’ is
larger than a ‘long’ and the ‘long long’ is at least as large as an
‘off_t’.  It may be necessary to configure and compile Python with
certain compiler flags to enable this mode.  For example, it is enabled
by default with recent versions of Irix, but with Solaris 2.6 and 2.7
you need to do something like:

     CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \         ./configure

On large-file-capable Linux systems, this might work:

     CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \         ./configure


File: python.info,  Node: Notable Module Contents,  Prev: Large File Support,  Up: posix — The most common POSIX system calls

5.36.1.2 Notable Module Contents
................................

In addition to many functions described in the *note os: c4. module
documentation, *note posix: d1. defines the following data item:

 -- Data: posix.environ

     A dictionary representing the string environment at the time the
     interpreter was started.  Keys and values are bytes on Unix and str
     on Windows.  For example, ‘environ[b'HOME']’ (‘environ['HOME']’ on
     Windows) is the pathname of your home directory, equivalent to
     ‘getenv("HOME")’ in C.

     Modifying this dictionary does not affect the string environment
     passed on by *note execv(): 1e34, *note popen(): 2a7. or *note
     system(): db4.; if you need to change the environment, pass
     ‘environ’ to *note execve(): a35. or add variable assignments and
     export statements to the command string for *note system(): db4. or
     *note popen(): 2a7.

     Changed in version 3.2: On Unix, keys and values are bytes.

          Note: The *note os: c4. module provides an alternate
          implementation of ‘environ’ which updates the environment on
          modification.  Note also that updating *note os.environ: b2a.
          will render this dictionary obsolete.  Use of the *note os:
          c4. module version of this is recommended over direct access
          to the *note posix: d1. module.


File: python.info,  Node: pwd — The password database,  Next: spwd — The shadow password database,  Prev: posix — The most common POSIX system calls,  Up: Unix Specific Services

5.36.2 ‘pwd’ — The password database
------------------------------------

__________________________________________________________________

This module provides access to the Unix user account and password
database.  It is available on all Unix versions.

Password database entries are reported as a tuple-like object, whose
attributes correspond to the members of the ‘passwd’ structure
(Attribute field below, see ‘<pwd.h>’):

Index       Attribute           Meaning
                                
------------------------------------------------------------------
                                
0           ‘pw_name’           Login name
                                
                                
1           ‘pw_passwd’         Optional encrypted password
                                
                                
2           ‘pw_uid’            Numerical user ID
                                
                                
3           ‘pw_gid’            Numerical group ID
                                
                                
4           ‘pw_gecos’          User name or comment field
                                
                                
5           ‘pw_dir’            User home directory
                                
                                
6           ‘pw_shell’          User command interpreter
                                

The uid and gid items are integers, all others are strings.  *note
KeyError: 2c5. is raised if the entry asked for cannot be found.

     Note: 
     In traditional Unix the field ‘pw_passwd’ usually contains a
     password encrypted with a DES derived algorithm (see module *note
     crypt: 29.).  However most modern unices use a so-called `shadow
     password' system.  On those unices the `pw_passwd' field only
     contains an asterisk (‘'*'’) or the letter ‘'x'’ where the
     encrypted password is stored in a file ‘/etc/shadow’ which is not
     world readable.  Whether the `pw_passwd' field contains anything
     useful is system-dependent.  If available, the *note spwd: f1.
     module should be used where access to the encrypted password is
     required.

It defines the following items:

 -- Function: pwd.getpwuid (uid)

     Return the password database entry for the given numeric user ID.

 -- Function: pwd.getpwnam (name)

     Return the password database entry for the given user name.

 -- Function: pwd.getpwall ()

     Return a list of all available password database entries, in
     arbitrary order.

See also
........

Module *note grp: 8b.

     An interface to the group database, similar to this.

Module *note spwd: f1.

     An interface to the shadow password database, similar to this.


File: python.info,  Node: spwd — The shadow password database,  Next: grp — The group database,  Prev: pwd — The password database,  Up: Unix Specific Services

5.36.3 ‘spwd’ — The shadow password database
--------------------------------------------

__________________________________________________________________

This module provides access to the Unix shadow password database.  It is
available on various Unix versions.

You must have enough privileges to access the shadow password database
(this usually means you have to be root).

Shadow password database entries are reported as a tuple-like object,
whose attributes correspond to the members of the ‘spwd’ structure
(Attribute field below, see ‘<shadow.h>’):

Index       Attribute           Meaning
                                
----------------------------------------------------------------------
                                
0           ‘sp_namp’           Login name
                                
                                
1           ‘sp_pwdp’           Encrypted password
                                
                                
2           ‘sp_lstchg’         Date of last change
                                
                                
3           ‘sp_min’            Minimal number of days between
                                changes
                                
                                
4           ‘sp_max’            Maximum number of days between
                                changes
                                
                                
5           ‘sp_warn’           Number of days before password
                                expires to warn user about it
                                
                                
6           ‘sp_inact’          Number of days after password
                                expires until account is disabled
                                
                                
7           ‘sp_expire’         Number of days since 1970-01-01
                                when account expires
                                
                                
8           ‘sp_flag’           Reserved
                                

The sp_namp and sp_pwdp items are strings, all others are integers.
*note KeyError: 2c5. is raised if the entry asked for cannot be found.

The following functions are defined:

 -- Function: spwd.getspnam (name)

     Return the shadow password database entry for the given user name.

     Changed in version 3.6: Raises a *note PermissionError: 5f4.
     instead of *note KeyError: 2c5. if the user doesn’t have
     privileges.

 -- Function: spwd.getspall ()

     Return a list of all available shadow password database entries, in
     arbitrary order.

See also
........

Module *note grp: 8b.

     An interface to the group database, similar to this.

Module *note pwd: d6.

     An interface to the normal password database, similar to this.


File: python.info,  Node: grp — The group database,  Next: crypt — Function to check Unix passwords,  Prev: spwd — The shadow password database,  Up: Unix Specific Services

5.36.4 ‘grp’ — The group database
---------------------------------

__________________________________________________________________

This module provides access to the Unix group database.  It is available
on all Unix versions.

Group database entries are reported as a tuple-like object, whose
attributes correspond to the members of the ‘group’ structure (Attribute
field below, see ‘<pwd.h>’):

Index       Attribute       Meaning
                            
------------------------------------------------------------------
                            
0           gr_name         the name of the group
                            
                            
1           gr_passwd       the (encrypted) group password;
                            often empty
                            
                            
2           gr_gid          the numerical group ID
                            
                            
3           gr_mem          all the group member’s user names
                            

The gid is an integer, name and password are strings, and the member
list is a list of strings.  (Note that most users are not explicitly
listed as members of the group they are in according to the password
database.  Check both databases to get complete membership information.
Also note that a ‘gr_name’ that starts with a ‘+’ or ‘-’ is likely to be
a YP/NIS reference and may not be accessible via *note getgrnam(): f63.
or *note getgrgid(): 5d4.)

It defines the following items:

 -- Function: grp.getgrgid (gid)

     Return the group database entry for the given numeric group ID.
     *note KeyError: 2c5. is raised if the entry asked for cannot be
     found.

     Deprecated since version 3.6: Since Python 3.6 the support of
     non-integer arguments like floats or strings in *note getgrgid():
     5d4. is deprecated.

 -- Function: grp.getgrnam (name)

     Return the group database entry for the given group name.  *note
     KeyError: 2c5. is raised if the entry asked for cannot be found.

 -- Function: grp.getgrall ()

     Return a list of all available group entries, in arbitrary order.

See also
........

Module *note pwd: d6.

     An interface to the user database, similar to this.

Module *note spwd: f1.

     An interface to the shadow password database, similar to this.


File: python.info,  Node: crypt — Function to check Unix passwords,  Next: termios — POSIX style tty control,  Prev: grp — The group database,  Up: Unix Specific Services

5.36.5 ‘crypt’ — Function to check Unix passwords
-------------------------------------------------

`Source code:' Lib/crypt.py(1)

__________________________________________________________________

This module implements an interface to the ‘crypt(3)’ routine, which is
a one-way hash function based upon a modified DES algorithm; see the
Unix man page for further details.  Possible uses include storing hashed
passwords so you can check passwords without storing the actual
password, or attempting to crack Unix passwords with a dictionary.

Notice that the behavior of this module depends on the actual
implementation of the ‘crypt(3)’ routine in the running system.
Therefore, any extensions available on the current implementation will
also be available on this module.

*note Availability: 129a.: Unix.  Not available on VxWorks.

* Menu:

* Hashing Methods::
* Module Attributes::
* Module Functions: Module Functions<2>.
* Examples: Examples<31>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/crypt.py


File: python.info,  Node: Hashing Methods,  Next: Module Attributes,  Up: crypt — Function to check Unix passwords

5.36.5.1 Hashing Methods
........................

New in version 3.3.

The *note crypt: 29. module defines the list of hashing methods (not all
methods are available on all platforms):

 -- Data: crypt.METHOD_SHA512

     A Modular Crypt Format method with 16 character salt and 86
     character hash based on the SHA-512 hash function.  This is the
     strongest method.

 -- Data: crypt.METHOD_SHA256

     Another Modular Crypt Format method with 16 character salt and 43
     character hash based on the SHA-256 hash function.

 -- Data: crypt.METHOD_BLOWFISH

     Another Modular Crypt Format method with 22 character salt and 31
     character hash based on the Blowfish cipher.

     New in version 3.7.

 -- Data: crypt.METHOD_MD5

     Another Modular Crypt Format method with 8 character salt and 22
     character hash based on the MD5 hash function.

 -- Data: crypt.METHOD_CRYPT

     The traditional method with a 2 character salt and 13 characters of
     hash.  This is the weakest method.


File: python.info,  Node: Module Attributes,  Next: Module Functions<2>,  Prev: Hashing Methods,  Up: crypt — Function to check Unix passwords

5.36.5.2 Module Attributes
..........................

New in version 3.3.

 -- Attribute: crypt.methods

     A list of available password hashing algorithms, as
     ‘crypt.METHOD_*’ objects.  This list is sorted from strongest to
     weakest.


File: python.info,  Node: Module Functions<2>,  Next: Examples<31>,  Prev: Module Attributes,  Up: crypt — Function to check Unix passwords

5.36.5.3 Module Functions
.........................

The *note crypt: 29. module defines the following functions:

 -- Function: crypt.crypt (word, salt=None)

     `word' will usually be a user’s password as typed at a prompt or in
     a graphical interface.  The optional `salt' is either a string as
     returned from *note mksalt(): 371, one of the ‘crypt.METHOD_*’
     values (though not all may be available on all platforms), or a
     full encrypted password including salt, as returned by this
     function.  If `salt' is not provided, the strongest method will be
     used (as returned by *note methods(): 395e.).

     Checking a password is usually done by passing the plain-text
     password as `word' and the full results of a previous *note
     crypt(): 29. call, which should be the same as the results of this
     call.

     `salt' (either a random 2 or 16 character string, possibly prefixed
     with ‘$digit$’ to indicate the method) which will be used to
     perturb the encryption algorithm.  The characters in `salt' must be
     in the set ‘[./a-zA-Z0-9]’, with the exception of Modular Crypt
     Format which prefixes a ‘$digit$’.

     Returns the hashed password as a string, which will be composed of
     characters from the same alphabet as the salt.

     Since a few ‘crypt(3)’ extensions allow different values, with
     different sizes in the `salt', it is recommended to use the full
     crypted password as salt when checking for a password.

     Changed in version 3.3: Accept ‘crypt.METHOD_*’ values in addition
     to strings for `salt'.

 -- Function: crypt.mksalt (method=None, *, rounds=None)

     Return a randomly generated salt of the specified method.  If no
     `method' is given, the strongest method available as returned by
     *note methods(): 395e. is used.

     The return value is a string suitable for passing as the `salt'
     argument to *note crypt(): 29.

     `rounds' specifies the number of rounds for ‘METHOD_SHA256’,
     ‘METHOD_SHA512’ and ‘METHOD_BLOWFISH’.  For ‘METHOD_SHA256’ and
     ‘METHOD_SHA512’ it must be an integer between ‘1000’ and
     ‘999_999_999’, the default is ‘5000’.  For ‘METHOD_BLOWFISH’ it
     must be a power of two between ‘16’ (2^4) and ‘2_147_483_648’
     (2^31), the default is ‘4096’ (2^12).

     New in version 3.3.

     Changed in version 3.7: Added the `rounds' parameter.


File: python.info,  Node: Examples<31>,  Prev: Module Functions<2>,  Up: crypt — Function to check Unix passwords

5.36.5.4 Examples
.................

A simple example illustrating typical use (a constant-time comparison
operation is needed to limit exposure to timing attacks.  *note
hmac.compare_digest(): a01. is suitable for this purpose):

     import pwd import crypt import getpass from hmac import compare_digest as compare_hash  def login():     username = input('Python login: ')     cryptedpasswd = pwd.getpwnam(username)[1]     if cryptedpasswd:         if cryptedpasswd == 'x' or cryptedpasswd == '*':             raise ValueError('no support for shadow passwords')         cleartext = getpass.getpass()         return compare_hash(crypt.crypt(cleartext, cryptedpasswd), cryptedpasswd)     else:         return True

To generate a hash of a password using the strongest available method
and check it against the original:

     import crypt from hmac import compare_digest as compare_hash  hashed = crypt.crypt(plaintext) if not compare_hash(hashed, crypt.crypt(plaintext, hashed)):     raise ValueError("hashed version doesn't validate against original")


File: python.info,  Node: termios — POSIX style tty control,  Next: tty — Terminal control functions,  Prev: crypt — Function to check Unix passwords,  Up: Unix Specific Services

5.36.6 ‘termios’ — POSIX style tty control
------------------------------------------

__________________________________________________________________

This module provides an interface to the POSIX calls for tty I/O
control.  For a complete description of these calls, see ‘termios(3)’
Unix manual page.  It is only available for those Unix versions that
support POSIX `termios' style tty I/O control configured during
installation.

All functions in this module take a file descriptor `fd' as their first
argument.  This can be an integer file descriptor, such as returned by
‘sys.stdin.fileno()’, or a *note file object: b35, such as ‘sys.stdin’
itself.

This module also defines all the constants needed to work with the
functions provided here; these have the same name as their counterparts
in C. Please refer to your system documentation for more information on
using these terminal control interfaces.

The module defines the following functions:

 -- Function: termios.tcgetattr (fd)

     Return a list containing the tty attributes for file descriptor
     `fd', as follows: ‘[iflag, oflag, cflag, lflag, ispeed, ospeed,
     cc]’ where `cc' is a list of the tty special characters (each a
     string of length 1, except the items with indices ‘VMIN’ and
     ‘VTIME’, which are integers when these fields are defined).  The
     interpretation of the flags and the speeds as well as the indexing
     in the `cc' array must be done using the symbolic constants defined
     in the *note termios: 104. module.

 -- Function: termios.tcsetattr (fd, when, attributes)

     Set the tty attributes for file descriptor `fd' from the
     `attributes', which is a list like the one returned by *note
     tcgetattr(): 3964.  The `when' argument determines when the
     attributes are changed: ‘TCSANOW’ to change immediately,
     ‘TCSADRAIN’ to change after transmitting all queued output, or
     ‘TCSAFLUSH’ to change after transmitting all queued output and
     discarding all queued input.

 -- Function: termios.tcsendbreak (fd, duration)

     Send a break on file descriptor `fd'.  A zero `duration' sends a
     break for 0.25–0.5 seconds; a nonzero `duration' has a system
     dependent meaning.

 -- Function: termios.tcdrain (fd)

     Wait until all output written to file descriptor `fd' has been
     transmitted.

 -- Function: termios.tcflush (fd, queue)

     Discard queued data on file descriptor `fd'.  The `queue' selector
     specifies which queue: ‘TCIFLUSH’ for the input queue, ‘TCOFLUSH’
     for the output queue, or ‘TCIOFLUSH’ for both queues.

 -- Function: termios.tcflow (fd, action)

     Suspend or resume input or output on file descriptor `fd'.  The
     `action' argument can be ‘TCOOFF’ to suspend output, ‘TCOON’ to
     restart output, ‘TCIOFF’ to suspend input, or ‘TCION’ to restart
     input.

See also
........

Module *note tty: 115.

     Convenience functions for common terminal control operations.

* Menu:

* Example: Example<16>.


File: python.info,  Node: Example<16>,  Up: termios — POSIX style tty control

5.36.6.1 Example
................

Here’s a function that prompts for a password with echoing turned off.
Note the technique using a separate *note tcgetattr(): 3964. call and a
*note try: d65. … *note finally: 182. statement to ensure that the old
tty attributes are restored exactly no matter what happens:

     def getpass(prompt="Password: "):     import termios, sys     fd = sys.stdin.fileno()     old = termios.tcgetattr(fd)     new = termios.tcgetattr(fd)     new[3] = new[3] & ~termios.ECHO          # lflags     try:         termios.tcsetattr(fd, termios.TCSADRAIN, new)         passwd = input(prompt)     finally:         termios.tcsetattr(fd, termios.TCSADRAIN, old)     return passwd


File: python.info,  Node: tty — Terminal control functions,  Next: pty — Pseudo-terminal utilities,  Prev: termios — POSIX style tty control,  Up: Unix Specific Services

5.36.7 ‘tty’ — Terminal control functions
-----------------------------------------

`Source code:' Lib/tty.py(1)

__________________________________________________________________

The *note tty: 115. module defines functions for putting the tty into
cbreak and raw modes.

Because it requires the *note termios: 104. module, it will work only on
Unix.

The *note tty: 115. module defines the following functions:

 -- Function: tty.setraw (fd, when=termios.TCSAFLUSH)

     Change the mode of the file descriptor `fd' to raw.  If `when' is
     omitted, it defaults to ‘termios.TCSAFLUSH’, and is passed to *note
     termios.tcsetattr(): 3965.

 -- Function: tty.setcbreak (fd, when=termios.TCSAFLUSH)

     Change the mode of file descriptor `fd' to cbreak.  If `when' is
     omitted, it defaults to ‘termios.TCSAFLUSH’, and is passed to *note
     termios.tcsetattr(): 3965.

See also
........

Module *note termios: 104.

     Low-level terminal control interface.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/tty.py


File: python.info,  Node: pty — Pseudo-terminal utilities,  Next: fcntl — The fcntl and ioctl system calls,  Prev: tty — Terminal control functions,  Up: Unix Specific Services

5.36.8 ‘pty’ — Pseudo-terminal utilities
----------------------------------------

`Source code:' Lib/pty.py(1)

__________________________________________________________________

The *note pty: d5. module defines operations for handling the
pseudo-terminal concept: starting another process and being able to
write to and read from its controlling terminal programmatically.

Because pseudo-terminal handling is highly platform dependent, there is
code to do it only for Linux.  (The Linux code is supposed to work on
other platforms, but hasn’t been tested yet.)

The *note pty: d5. module defines the following functions:

 -- Function: pty.fork ()

     Fork.  Connect the child’s controlling terminal to a
     pseudo-terminal.  Return value is ‘(pid, fd)’.  Note that the child
     gets `pid' 0, and the `fd' is `invalid'.  The parent’s return value
     is the `pid' of the child, and `fd' is a file descriptor connected
     to the child’s controlling terminal (and also to the child’s
     standard input and output).

 -- Function: pty.openpty ()

     Open a new pseudo-terminal pair, using *note os.openpty(): 1e6a. if
     possible, or emulation code for generic Unix systems.  Return a
     pair of file descriptors ‘(master, slave)’, for the master and the
     slave end, respectively.

 -- Function: pty.spawn (argv[, master_read[, stdin_read]])

     Spawn a process, and connect its controlling terminal with the
     current process’s standard io.  This is often used to baffle
     programs which insist on reading from the controlling terminal.  It
     is expected that the process spawned behind the pty will eventually
     terminate, and when it does `spawn' will return.

     The functions `master_read' and `stdin_read' are passed a file
     descriptor which they should read from, and they should always
     return a byte string.  In order to force spawn to return before the
     child process exits an *note OSError: 1d1. should be thrown.

     The default implementation for both functions will read and return
     up to 1024 bytes each time the function is called.  The
     `master_read' callback is passed the pseudoterminal’s master file
     descriptor to read output from the child process, and `stdin_read'
     is passed file descriptor 0, to read from the parent process’s
     standard input.

     Returning an empty byte string from either callback is interpreted
     as an end-of-file (EOF) condition, and that callback will not be
     called after that.  If `stdin_read' signals EOF the controlling
     terminal can no longer communicate with the parent process OR the
     child process.  Unless the child process will quit without any
     input, `spawn' will then loop forever.  If `master_read' signals
     EOF the same behavior results (on linux at least).

     If both callbacks signal EOF then `spawn' will probably never
     return, unless `select' throws an error on your platform when
     passed three empty lists.  This is a bug, documented in issue
     26228(2).

     Changed in version 3.4: *note spawn(): 88c. now returns the status
     value from *note os.waitpid(): 661. on the child process.

* Menu:

* Example: Example<17>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pty.py

   (2) https://bugs.python.org/issue26228


File: python.info,  Node: Example<17>,  Up: pty — Pseudo-terminal utilities

5.36.8.1 Example
................

The following program acts like the Unix command ‘script(1)’, using a
pseudo-terminal to record all input and output of a terminal session in
a “typescript”.

     import argparse import os import pty import sys import time  parser = argparse.ArgumentParser() parser.add_argument('-a', dest='append', action='store_true') parser.add_argument('-p', dest='use_python', action='store_true') parser.add_argument('filename', nargs='?', default='typescript') options = parser.parse_args()  shell = sys.executable if options.use_python else os.environ.get('SHELL', 'sh') filename = options.filename mode = 'ab' if options.append else 'wb'  with open(filename, mode) as script:     def read(fd):         data = os.read(fd, 1024)         script.write(data)         return data      print('Script started, file is', filename)     script.write(('Script started on %s\n' % time.asctime()).encode())      pty.spawn(shell, read)      script.write(('Script done on %s\n' % time.asctime()).encode())     print('Script done, file is', filename)


File: python.info,  Node: fcntl — The fcntl and ioctl system calls,  Next: pipes — Interface to shell pipelines,  Prev: pty — Pseudo-terminal utilities,  Up: Unix Specific Services

5.36.9 ‘fcntl’ — The ‘fcntl’ and ‘ioctl’ system calls
-----------------------------------------------------

__________________________________________________________________

This module performs file control and I/O control on file descriptors.
It is an interface to the ‘fcntl()’ and ‘ioctl()’ Unix routines.  For a
complete description of these calls, see ‘fcntl(2)’ and ‘ioctl(2)’ Unix
manual pages.

All functions in this module take a file descriptor `fd' as their first
argument.  This can be an integer file descriptor, such as returned by
‘sys.stdin.fileno()’, or an *note io.IOBase: 1d9. object, such as
‘sys.stdin’ itself, which provides a *note fileno(): 1e46. that returns
a genuine file descriptor.

Changed in version 3.3: Operations in this module used to raise an *note
IOError: 986. where they now raise an *note OSError: 1d1.

Changed in version 3.8: The fcntl module now contains ‘F_ADD_SEALS’,
‘F_GET_SEALS’, and ‘F_SEAL_*’ constants for sealing of *note
os.memfd_create(): 1ee. file descriptors.

The module defines the following functions:

 -- Function: fcntl.fcntl (fd, cmd, arg=0)

     Perform the operation `cmd' on file descriptor `fd' (file objects
     providing a *note fileno(): 1e46. method are accepted as well).
     The values used for `cmd' are operating system dependent, and are
     available as constants in the *note fcntl: 7e. module, using the
     same names as used in the relevant C header files.  The argument
     `arg' can either be an integer value, or a *note bytes: 326.
     object.  With an integer value, the return value of this function
     is the integer return value of the C ‘fcntl()’ call.  When the
     argument is bytes it represents a binary structure, e.g.  created
     by *note struct.pack(): bfe.  The binary data is copied to a buffer
     whose address is passed to the C ‘fcntl()’ call.  The return value
     after a successful call is the contents of the buffer, converted to
     a *note bytes: 326. object.  The length of the returned object will
     be the same as the length of the `arg' argument.  This is limited
     to 1024 bytes.  If the information returned in the buffer by the
     operating system is larger than 1024 bytes, this is most likely to
     result in a segmentation violation or a more subtle data
     corruption.

     If the ‘fcntl()’ fails, an *note OSError: 1d1. is raised.

 -- Function: fcntl.ioctl (fd, request, arg=0, mutate_flag=True)

     This function is identical to the *note fcntl(): 25df. function,
     except that the argument handling is even more complicated.

     The `request' parameter is limited to values that can fit in
     32-bits.  Additional constants of interest for use as the `request'
     argument can be found in the *note termios: 104. module, under the
     same names as used in the relevant C header files.

     The parameter `arg' can be one of an integer, an object supporting
     the read-only buffer interface (like *note bytes: 326.) or an
     object supporting the read-write buffer interface (like *note
     bytearray: 327.).

     In all but the last case, behaviour is as for the *note fcntl():
     25df. function.

     If a mutable buffer is passed, then the behaviour is determined by
     the value of the `mutate_flag' parameter.

     If it is false, the buffer’s mutability is ignored and behaviour is
     as for a read-only buffer, except that the 1024 byte limit
     mentioned above is avoided – so long as the buffer you pass is at
     least as long as what the operating system wants to put there,
     things should work.

     If `mutate_flag' is true (the default), then the buffer is (in
     effect) passed to the underlying *note ioctl(): dd1. system call,
     the latter’s return code is passed back to the calling Python, and
     the buffer’s new contents reflect the action of the *note ioctl():
     dd1.  This is a slight simplification, because if the supplied
     buffer is less than 1024 bytes long it is first copied into a
     static buffer 1024 bytes long which is then passed to *note
     ioctl(): dd1. and copied back into the supplied buffer.

     If the ‘ioctl()’ fails, an *note OSError: 1d1. exception is raised.

     An example:

          >>> import array, fcntl, struct, termios, os >>> os.getpgrp() 13341 >>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, "  "))[0] 13341 >>> buf = array.array('h', [0]) >>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1) 0 >>> buf array('h', [13341])

 -- Function: fcntl.flock (fd, operation)

     Perform the lock operation `operation' on file descriptor `fd'
     (file objects providing a *note fileno(): 1e46. method are accepted
     as well).  See the Unix manual ‘flock(2)’ for details.  (On some
     systems, this function is emulated using ‘fcntl()’.)

     If the ‘flock()’ fails, an *note OSError: 1d1. exception is raised.

 -- Function: fcntl.lockf (fd, cmd, len=0, start=0, whence=0)

     This is essentially a wrapper around the *note fcntl(): 25df.
     locking calls.  `fd' is the file descriptor (file objects providing
     a *note fileno(): 1e46. method are accepted as well) of the file to
     lock or unlock, and `cmd' is one of the following values:

        * ‘LOCK_UN’ – unlock

        * ‘LOCK_SH’ – acquire a shared lock

        * ‘LOCK_EX’ – acquire an exclusive lock

     When `cmd' is ‘LOCK_SH’ or ‘LOCK_EX’, it can also be bitwise ORed
     with ‘LOCK_NB’ to avoid blocking on lock acquisition.  If ‘LOCK_NB’
     is used and the lock cannot be acquired, an *note OSError: 1d1.
     will be raised and the exception will have an `errno' attribute set
     to ‘EACCES’ or ‘EAGAIN’ (depending on the operating system; for
     portability, check for both values).  On at least some systems,
     ‘LOCK_EX’ can only be used if the file descriptor refers to a file
     opened for writing.

     `len' is the number of bytes to lock, `start' is the byte offset at
     which the lock starts, relative to `whence', and `whence' is as
     with *note io.IOBase.seek(): 1cd1, specifically:

        * ‘0’ – relative to the start of the file (*note os.SEEK_SET:
          d87.)

        * ‘1’ – relative to the current buffer position (*note
          os.SEEK_CUR: d88.)

        * ‘2’ – relative to the end of the file (*note os.SEEK_END:
          d89.)

     The default for `start' is 0, which means to start at the beginning
     of the file.  The default for `len' is 0 which means to lock to the
     end of the file.  The default for `whence' is also 0.

Examples (all on a SVR4 compliant system):

     import struct, fcntl, os  f = open(...) rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY)  lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0) rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata)

Note that in the first example the return value variable `rv' will hold
an integer value; in the second example it will hold a *note bytes: 326.
object.  The structure lay-out for the `lockdata' variable is system
dependent — therefore using the *note flock(): 3977. call may be better.

See also
........

Module *note os: c4.

     If the locking flags *note O_SHLOCK: d8a. and *note O_EXLOCK: d8b.
     are present in the *note os: c4. module (on BSD only), the *note
     os.open(): 659. function provides an alternative to the *note
     lockf(): d45. and *note flock(): 3977. functions.


File: python.info,  Node: pipes — Interface to shell pipelines,  Next: resource — Resource usage information,  Prev: fcntl — The fcntl and ioctl system calls,  Up: Unix Specific Services

5.36.10 ‘pipes’ — Interface to shell pipelines
----------------------------------------------

`Source code:' Lib/pipes.py(1)

__________________________________________________________________

The *note pipes: cc. module defines a class to abstract the concept of a
`pipeline' — a sequence of converters from one file to another.

Because the module uses ‘/bin/sh’ command lines, a POSIX or compatible
shell for *note os.system(): db4. and *note os.popen(): 2a7. is
required.

The *note pipes: cc. module defines the following class:

 -- Class: pipes.Template

     An abstraction of a pipeline.

Example:

     >>> import pipes >>> t = pipes.Template() >>> t.append('tr a-z A-Z', '--') >>> f = t.open('pipefile', 'w') >>> f.write('hello world') >>> f.close() >>> open('pipefile').read() 'HELLO WORLD'

* Menu:

* Template Objects::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/pipes.py


File: python.info,  Node: Template Objects,  Up: pipes — Interface to shell pipelines

5.36.10.1 Template Objects
..........................

Template objects following methods:

 -- Method: Template.reset ()

     Restore a pipeline template to its initial state.

 -- Method: Template.clone ()

     Return a new, equivalent, pipeline template.

 -- Method: Template.debug (flag)

     If `flag' is true, turn debugging on.  Otherwise, turn debugging
     off.  When debugging is on, commands to be executed are printed,
     and the shell is given ‘set -x’ command to be more verbose.

 -- Method: Template.append (cmd, kind)

     Append a new action at the end.  The `cmd' variable must be a valid
     bourne shell command.  The `kind' variable consists of two letters.

     The first letter can be either of ‘'-'’ (which means the command
     reads its standard input), ‘'f'’ (which means the commands reads a
     given file on the command line) or ‘'.'’ (which means the commands
     reads no input, and hence must be first.)

     Similarly, the second letter can be either of ‘'-'’ (which means
     the command writes to standard output), ‘'f'’ (which means the
     command writes a file on the command line) or ‘'.'’ (which means
     the command does not write anything, and hence must be last.)

 -- Method: Template.prepend (cmd, kind)

     Add a new action at the beginning.  See *note append(): 3980. for
     explanations of the arguments.

 -- Method: Template.open (file, mode)

     Return a file-like object, open to `file', but read from or written
     to by the pipeline.  Note that only one of ‘'r'’, ‘'w'’ may be
     given.

 -- Method: Template.copy (infile, outfile)

     Copy `infile' to `outfile' through the pipe.


File: python.info,  Node: resource — Resource usage information,  Next: nis — Interface to Sun’s NIS Yellow Pages,  Prev: pipes — Interface to shell pipelines,  Up: Unix Specific Services

5.36.11 ‘resource’ — Resource usage information
-----------------------------------------------

__________________________________________________________________

This module provides basic mechanisms for measuring and controlling
system resources utilized by a program.

Symbolic constants are used to specify particular system resources and
to request usage information about either the current process or its
children.

An *note OSError: 1d1. is raised on syscall failure.

 -- Exception: resource.error

     A deprecated alias of *note OSError: 1d1.

     Changed in version 3.3: Following PEP 3151(1), this class was made
     an alias of *note OSError: 1d1.

* Menu:

* Resource Limits::
* Resource Usage::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3151


File: python.info,  Node: Resource Limits,  Next: Resource Usage,  Up: resource — Resource usage information

5.36.11.1 Resource Limits
.........................

Resources usage can be limited using the *note setrlimit(): 33e7.
function described below.  Each resource is controlled by a pair of
limits: a soft limit and a hard limit.  The soft limit is the current
limit, and may be lowered or raised by a process over time.  The soft
limit can never exceed the hard limit.  The hard limit can be lowered to
any value greater than the soft limit, but not raised.  (Only processes
with the effective UID of the super-user can raise a hard limit.)

The specific resources that can be limited are system dependent.  They
are described in the ‘getrlimit(2)’ man page.  The resources listed
below are supported when the underlying operating system supports them;
resources which cannot be checked or controlled by the operating system
are not defined in this module for those platforms.

 -- Data: resource.RLIM_INFINITY

     Constant used to represent the limit for an unlimited resource.

 -- Function: resource.getrlimit (resource)

     Returns a tuple ‘(soft, hard)’ with the current soft and hard
     limits of `resource'.  Raises *note ValueError: 1f9. if an invalid
     resource is specified, or *note error: 3986. if the underlying
     system call fails unexpectedly.

 -- Function: resource.setrlimit (resource, limits)

     Sets new limits of consumption of `resource'.  The `limits'
     argument must be a tuple ‘(soft, hard)’ of two integers describing
     the new limits.  A value of *note RLIM_INFINITY: 3988. can be used
     to request a limit that is unlimited.

     Raises *note ValueError: 1f9. if an invalid resource is specified,
     if the new soft limit exceeds the hard limit, or if a process tries
     to raise its hard limit.  Specifying a limit of *note
     RLIM_INFINITY: 3988. when the hard or system limit for that
     resource is not unlimited will result in a *note ValueError: 1f9.
     A process with the effective UID of super-user can request any
     valid limit value, including unlimited, but *note ValueError: 1f9.
     will still be raised if the requested limit exceeds the system
     imposed limit.

     ‘setrlimit’ may also raise *note error: 3986. if the underlying
     system call fails.

     VxWorks only supports setting *note RLIMIT_NOFILE: 398a.

 -- Function: resource.prlimit (pid, resource[, limits])

     Combines *note setrlimit(): 33e7. and *note getrlimit(): 3989. in
     one function and supports to get and set the resources limits of an
     arbitrary process.  If `pid' is 0, then the call applies to the
     current process.  `resource' and `limits' have the same meaning as
     in *note setrlimit(): 33e7, except that `limits' is optional.

     When `limits' is not given the function returns the `resource'
     limit of the process `pid'.  When `limits' is given the `resource'
     limit of the process is set and the former resource limit is
     returned.

     Raises *note ProcessLookupError: 98f. when `pid' can’t be found and
     *note PermissionError: 5f4. when the user doesn’t have
     ‘CAP_SYS_RESOURCE’ for the process.

     *note Availability: 129a.: Linux 2.6.36 or later with glibc 2.13 or
     later.

     New in version 3.4.

These symbols define resources whose consumption can be controlled using
the *note setrlimit(): 33e7. and *note getrlimit(): 3989. functions
described below.  The values of these symbols are exactly the constants
used by C programs.

The Unix man page for ‘getrlimit(2)’ lists the available resources.
Note that not all systems use the same symbol or same value to denote
the same resource.  This module does not attempt to mask platform
differences — symbols not defined for a platform will not be available
from this module on that platform.

 -- Data: resource.RLIMIT_CORE

     The maximum size (in bytes) of a core file that the current process
     can create.  This may result in the creation of a partial core file
     if a larger core would be required to contain the entire process
     image.

 -- Data: resource.RLIMIT_CPU

     The maximum amount of processor time (in seconds) that a process
     can use.  If this limit is exceeded, a ‘SIGXCPU’ signal is sent to
     the process.  (See the *note signal: ea. module documentation for
     information about how to catch this signal and do something useful,
     e.g.  flush open files to disk.)

 -- Data: resource.RLIMIT_FSIZE

     The maximum size of a file which the process may create.

 -- Data: resource.RLIMIT_DATA

     The maximum size (in bytes) of the process’s heap.

 -- Data: resource.RLIMIT_STACK

     The maximum size (in bytes) of the call stack for the current
     process.  This only affects the stack of the main thread in a
     multi-threaded process.

 -- Data: resource.RLIMIT_RSS

     The maximum resident set size that should be made available to the
     process.

 -- Data: resource.RLIMIT_NPROC

     The maximum number of processes the current process may create.

 -- Data: resource.RLIMIT_NOFILE

     The maximum number of open file descriptors for the current
     process.

 -- Data: resource.RLIMIT_OFILE

     The BSD name for *note RLIMIT_NOFILE: 398a.

 -- Data: resource.RLIMIT_MEMLOCK

     The maximum address space which may be locked in memory.

 -- Data: resource.RLIMIT_VMEM

     The largest area of mapped memory which the process may occupy.

 -- Data: resource.RLIMIT_AS

     The maximum area (in bytes) of address space which may be taken by
     the process.

 -- Data: resource.RLIMIT_MSGQUEUE

     The number of bytes that can be allocated for POSIX message queues.

     *note Availability: 129a.: Linux 2.6.8 or later.

     New in version 3.4.

 -- Data: resource.RLIMIT_NICE

     The ceiling for the process’s nice level (calculated as 20 -
     rlim_cur).

     *note Availability: 129a.: Linux 2.6.12 or later.

     New in version 3.4.

 -- Data: resource.RLIMIT_RTPRIO

     The ceiling of the real-time priority.

     *note Availability: 129a.: Linux 2.6.12 or later.

     New in version 3.4.

 -- Data: resource.RLIMIT_RTTIME

     The time limit (in microseconds) on CPU time that a process can
     spend under real-time scheduling without making a blocking syscall.

     *note Availability: 129a.: Linux 2.6.25 or later.

     New in version 3.4.

 -- Data: resource.RLIMIT_SIGPENDING

     The number of signals which the process may queue.

     *note Availability: 129a.: Linux 2.6.8 or later.

     New in version 3.4.

 -- Data: resource.RLIMIT_SBSIZE

     The maximum size (in bytes) of socket buffer usage for this user.
     This limits the amount of network memory, and hence the amount of
     mbufs, that this user may hold at any time.

     *note Availability: 129a.: FreeBSD 9 or later.

     New in version 3.4.

 -- Data: resource.RLIMIT_SWAP

     The maximum size (in bytes) of the swap space that may be reserved
     or used by all of this user id’s processes.  This limit is enforced
     only if bit 1 of the vm.overcommit sysctl is set.  Please see
     ‘tuning(7)’ for a complete description of this sysctl.

     *note Availability: 129a.: FreeBSD 9 or later.

     New in version 3.4.

 -- Data: resource.RLIMIT_NPTS

     The maximum number of pseudo-terminals created by this user id.

     *note Availability: 129a.: FreeBSD 9 or later.

     New in version 3.4.


File: python.info,  Node: Resource Usage,  Prev: Resource Limits,  Up: resource — Resource usage information

5.36.11.2 Resource Usage
........................

These functions are used to retrieve resource usage information:

 -- Function: resource.getrusage (who)

     This function returns an object that describes the resources
     consumed by either the current process or its children, as
     specified by the `who' parameter.  The `who' parameter should be
     specified using one of the ‘RUSAGE_*’ constants described below.

     A simple example:

          from resource import * import time  # a non CPU-bound task time.sleep(3) print(getrusage(RUSAGE_SELF))  # a CPU-bound task for i in range(10 ** 8):    _ = 1 + 1 print(getrusage(RUSAGE_SELF))

     The fields of the return value each describe how a particular
     system resource has been used, e.g.  amount of time spent running
     is user mode or number of times the process was swapped out of main
     memory.  Some values are dependent on the clock tick internal, e.g.
     the amount of memory the process is using.

     For backward compatibility, the return value is also accessible as
     a tuple of 16 elements.

     The fields ‘ru_utime’ and ‘ru_stime’ of the return value are
     floating point values representing the amount of time spent
     executing in user mode and the amount of time spent executing in
     system mode, respectively.  The remaining values are integers.
     Consult the ‘getrusage(2)’ man page for detailed information about
     these values.  A brief summary is presented here:

     Index        Field                     Resource
                                            
     -----------------------------------------------------------------------------------
                                            
     ‘0’          ‘ru_utime’                time in user mode (float seconds)
                                            
                                            
     ‘1’          ‘ru_stime’                time in system mode (float seconds)
                                            
                                            
     ‘2’          ‘ru_maxrss’               maximum resident set size
                                            
                                            
     ‘3’          ‘ru_ixrss’                shared memory size
                                            
                                            
     ‘4’          ‘ru_idrss’                unshared memory size
                                            
                                            
     ‘5’          ‘ru_isrss’                unshared stack size
                                            
                                            
     ‘6’          ‘ru_minflt’               page faults not requiring I/O
                                            
                                            
     ‘7’          ‘ru_majflt’               page faults requiring I/O
                                            
                                            
     ‘8’          ‘ru_nswap’                number of swap outs
                                            
                                            
     ‘9’          ‘ru_inblock’              block input operations
                                            
                                            
     ‘10’         ‘ru_oublock’              block output operations
                                            
                                            
     ‘11’         ‘ru_msgsnd’               messages sent
                                            
                                            
     ‘12’         ‘ru_msgrcv’               messages received
                                            
                                            
     ‘13’         ‘ru_nsignals’             signals received
                                            
                                            
     ‘14’         ‘ru_nvcsw’                voluntary context switches
                                            
                                            
     ‘15’         ‘ru_nivcsw’               involuntary context switches
                                            

     This function will raise a *note ValueError: 1f9. if an invalid
     `who' parameter is specified.  It may also raise *note error: 3986.
     exception in unusual circumstances.

 -- Function: resource.getpagesize ()

     Returns the number of bytes in a system page.  (This need not be
     the same as the hardware page size.)

The following ‘RUSAGE_*’ symbols are passed to the *note getrusage():
d8c. function to specify which processes information should be provided
for.

 -- Data: resource.RUSAGE_SELF

     Pass to *note getrusage(): d8c. to request resources consumed by
     the calling process, which is the sum of resources used by all
     threads in the process.

 -- Data: resource.RUSAGE_CHILDREN

     Pass to *note getrusage(): d8c. to request resources consumed by
     child processes of the calling process which have been terminated
     and waited for.

 -- Data: resource.RUSAGE_BOTH

     Pass to *note getrusage(): d8c. to request resources consumed by
     both the current process and child processes.  May not be available
     on all systems.

 -- Data: resource.RUSAGE_THREAD

     Pass to *note getrusage(): d8c. to request resources consumed by
     the current thread.  May not be available on all systems.

     New in version 3.2.


File: python.info,  Node: nis — Interface to Sun’s NIS Yellow Pages,  Next: syslog — Unix syslog library routines,  Prev: resource — Resource usage information,  Up: Unix Specific Services

5.36.12 ‘nis’ — Interface to Sun’s NIS (Yellow Pages)
-----------------------------------------------------

__________________________________________________________________

The *note nis: bf. module gives a thin wrapper around the NIS library,
useful for central administration of several hosts.

Because NIS exists only on Unix systems, this module is only available
for Unix.

The *note nis: bf. module defines the following functions:

 -- Function: nis.match (key, mapname, domain=default_domain)

     Return the match for `key' in map `mapname', or raise an error
     (*note nis.error: 399d.) if there is none.  Both should be strings,
     `key' is 8-bit clean.  Return value is an arbitrary array of bytes
     (may contain ‘NULL’ and other joys).

     Note that `mapname' is first checked if it is an alias to another
     name.

     The `domain' argument allows overriding the NIS domain used for the
     lookup.  If unspecified, lookup is in the default NIS domain.

 -- Function: nis.cat (mapname, domain=default_domain)

     Return a dictionary mapping `key' to `value' such that ‘match(key,
     mapname)==value’.  Note that both keys and values of the dictionary
     are arbitrary arrays of bytes.

     Note that `mapname' is first checked if it is an alias to another
     name.

     The `domain' argument allows overriding the NIS domain used for the
     lookup.  If unspecified, lookup is in the default NIS domain.

 -- Function: nis.maps (domain=default_domain)

     Return a list of all valid maps.

     The `domain' argument allows overriding the NIS domain used for the
     lookup.  If unspecified, lookup is in the default NIS domain.

 -- Function: nis.get_default_domain ()

     Return the system default NIS domain.

The *note nis: bf. module defines the following exception:

 -- Exception: nis.error

     An error raised when a NIS function returns an error code.


File: python.info,  Node: syslog — Unix syslog library routines,  Prev: nis — Interface to Sun’s NIS Yellow Pages,  Up: Unix Specific Services

5.36.13 ‘syslog’ — Unix syslog library routines
-----------------------------------------------

__________________________________________________________________

This module provides an interface to the Unix ‘syslog’ library routines.
Refer to the Unix manual pages for a detailed description of the
‘syslog’ facility.

This module wraps the system ‘syslog’ family of routines.  A pure Python
library that can speak to a syslog server is available in the *note
logging.handlers: ac. module as ‘SysLogHandler’.

The module defines the following functions:

 -- Function: syslog.syslog (message)

 -- Function: syslog.syslog (priority, message)

     Send the string `message' to the system logger.  A trailing newline
     is added if necessary.  Each message is tagged with a priority
     composed of a `facility' and a `level'.  The optional `priority'
     argument, which defaults to ‘LOG_INFO’, determines the message
     priority.  If the facility is not encoded in `priority' using
     logical-or (‘LOG_INFO | LOG_USER’), the value given in the *note
     openlog(): 39a3. call is used.

     If *note openlog(): 39a3. has not been called prior to the call to
     *note syslog(): ff, ‘openlog()’ will be called with no arguments.

 -- Function: syslog.openlog ([ident[, logoption[, facility]]])

     Logging options of subsequent *note syslog(): ff. calls can be set
     by calling *note openlog(): 39a3.  *note syslog(): ff. will call
     *note openlog(): 39a3. with no arguments if the log is not
     currently open.

     The optional `ident' keyword argument is a string which is
     prepended to every message, and defaults to ‘sys.argv[0]’ with
     leading path components stripped.  The optional `logoption' keyword
     argument (default is 0) is a bit field – see below for possible
     values to combine.  The optional `facility' keyword argument
     (default is ‘LOG_USER’) sets the default facility for messages
     which do not have a facility explicitly encoded.

     Changed in version 3.2: In previous versions, keyword arguments
     were not allowed, and `ident' was required.  The default for
     `ident' was dependent on the system libraries, and often was
     ‘python’ instead of the name of the Python program file.

 -- Function: syslog.closelog ()

     Reset the syslog module values and call the system library
     ‘closelog()’.

     This causes the module to behave as it does when initially
     imported.  For example, *note openlog(): 39a3. will be called on
     the first *note syslog(): ff. call (if *note openlog(): 39a3.
     hasn’t already been called), and `ident' and other *note openlog():
     39a3. parameters are reset to defaults.

 -- Function: syslog.setlogmask (maskpri)

     Set the priority mask to `maskpri' and return the previous mask
     value.  Calls to *note syslog(): ff. with a priority level not set
     in `maskpri' are ignored.  The default is to log all priorities.
     The function ‘LOG_MASK(pri)’ calculates the mask for the individual
     priority `pri'.  The function ‘LOG_UPTO(pri)’ calculates the mask
     for all priorities up to and including `pri'.

The module defines the following constants:

Priority levels (high to low):

     ‘LOG_EMERG’, ‘LOG_ALERT’, ‘LOG_CRIT’, ‘LOG_ERR’, ‘LOG_WARNING’,
     ‘LOG_NOTICE’, ‘LOG_INFO’, ‘LOG_DEBUG’.

Facilities:

     ‘LOG_KERN’, ‘LOG_USER’, ‘LOG_MAIL’, ‘LOG_DAEMON’, ‘LOG_AUTH’,
     ‘LOG_LPR’, ‘LOG_NEWS’, ‘LOG_UUCP’, ‘LOG_CRON’, ‘LOG_SYSLOG’,
     ‘LOG_LOCAL0’ to ‘LOG_LOCAL7’, and, if defined in ‘<syslog.h>’,
     ‘LOG_AUTHPRIV’.

Log options:

     ‘LOG_PID’, ‘LOG_CONS’, ‘LOG_NDELAY’, and, if defined in
     ‘<syslog.h>’, ‘LOG_ODELAY’, ‘LOG_NOWAIT’, and ‘LOG_PERROR’.

* Menu:

* Examples: Examples<32>.


File: python.info,  Node: Examples<32>,  Up: syslog — Unix syslog library routines

5.36.13.1 Examples
..................

* Menu:

* Simple example::


File: python.info,  Node: Simple example,  Up: Examples<32>

5.36.13.2 Simple example
........................

A simple set of examples:

     import syslog  syslog.syslog('Processing started') if error:     syslog.syslog(syslog.LOG_ERR, 'Processing started')

An example of setting some log options, these would include the process
ID in logged messages, and write the messages to the destination
facility used for mail logging:

     syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL) syslog.syslog('E-mail processing initiated...')


File: python.info,  Node: Superseded Modules,  Next: Undocumented Modules,  Prev: Unix Specific Services,  Up: The Python Standard Library

5.37 Superseded Modules
=======================

The modules described in this chapter are deprecated and only kept for
backwards compatibility.  They have been superseded by other modules.

* Menu:

* optparse — Parser for command line options::
* imp — Access the import internals::


File: python.info,  Node: optparse — Parser for command line options,  Next: imp — Access the import internals,  Up: Superseded Modules

5.37.1 ‘optparse’ — Parser for command line options
---------------------------------------------------

`Source code:' Lib/optparse.py(1)

Deprecated since version 3.2: The *note optparse: c3. module is
deprecated and will not be developed further; development will continue
with the *note argparse: 6. module.

__________________________________________________________________

*note optparse: c3. is a more convenient, flexible, and powerful library
for parsing command-line options than the old *note getopt: 87. module.
*note optparse: c3. uses a more declarative style of command-line
parsing: you create an instance of *note OptionParser: 39ad, populate it
with options, and parse the command line.  *note optparse: c3. allows
users to specify options in the conventional GNU/POSIX syntax, and
additionally generates usage and help messages for you.

Here’s an example of using *note optparse: c3. in a simple script:

     from optparse import OptionParser ... parser = OptionParser() parser.add_option("-f", "--file", dest="filename",                   help="write report to FILE", metavar="FILE") parser.add_option("-q", "--quiet",                   action="store_false", dest="verbose", default=True,                   help="don't print status messages to stdout")  (options, args) = parser.parse_args()

With these few lines of code, users of your script can now do the “usual
thing” on the command-line, for example:

     <yourscript> --file=outfile -q

As it parses the command line, *note optparse: c3. sets attributes of
the ‘options’ object returned by ‘parse_args()’ based on user-supplied
command-line values.  When ‘parse_args()’ returns from parsing this
command line, ‘options.filename’ will be ‘"outfile"’ and
‘options.verbose’ will be ‘False’.  *note optparse: c3. supports both
long and short options, allows short options to be merged together, and
allows options to be associated with their arguments in a variety of
ways.  Thus, the following command lines are all equivalent to the above
example:

     <yourscript> -f outfile --quiet <yourscript> --quiet --file outfile <yourscript> -q -foutfile <yourscript> -qfoutfile

Additionally, users can run one of

     <yourscript> -h <yourscript> --help

and *note optparse: c3. will print out a brief summary of your script’s
options:

     Usage: <yourscript> [options]  Options:   -h, --help            show this help message and exit   -f FILE, --file=FILE  write report to FILE   -q, --quiet           don't print status messages to stdout

where the value of `yourscript' is determined at runtime (normally from
‘sys.argv[0]’).

* Menu:

* Background::
* Tutorial: Tutorial<2>.
* Reference Guide::
* Option Callbacks::
* Extending optparse::

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/optparse.py


File: python.info,  Node: Background,  Next: Tutorial<2>,  Up: optparse — Parser for command line options

5.37.1.1 Background
...................

*note optparse: c3. was explicitly designed to encourage the creation of
programs with straightforward, conventional command-line interfaces.  To
that end, it supports only the most common command-line syntax and
semantics conventionally used under Unix.  If you are unfamiliar with
these conventions, read this section to acquaint yourself with them.

* Menu:

* Terminology::
* What are options for?::
* What are positional arguments for?::


File: python.info,  Node: Terminology,  Next: What are options for?,  Up: Background

5.37.1.2 Terminology
....................

argument

     a string entered on the command-line, and passed by the shell to
     ‘execl()’ or ‘execv()’.  In Python, arguments are elements of
     ‘sys.argv[1:]’ (‘sys.argv[0]’ is the name of the program being
     executed).  Unix shells also use the term “word”.

     It is occasionally desirable to substitute an argument list other
     than ‘sys.argv[1:]’, so you should read “argument” as “an element
     of ‘sys.argv[1:]’, or of some other list provided as a substitute
     for ‘sys.argv[1:]’”.

option

     an argument used to supply extra information to guide or customize
     the execution of a program.  There are many different syntaxes for
     options; the traditional Unix syntax is a hyphen (“-“) followed by
     a single letter, e.g.  ‘-x’ or ‘-F’.  Also, traditional Unix syntax
     allows multiple options to be merged into a single argument, e.g.
     ‘-x -F’ is equivalent to ‘-xF’.  The GNU project introduced ‘--’
     followed by a series of hyphen-separated words, e.g.  ‘--file’ or
     ‘--dry-run’.  These are the only two option syntaxes provided by
     *note optparse: c3.

     Some other option syntaxes that the world has seen include:

        * a hyphen followed by a few letters, e.g.  ‘-pf’ (this is `not'
          the same as multiple options merged into a single argument)

        * a hyphen followed by a whole word, e.g.  ‘-file’ (this is
          technically equivalent to the previous syntax, but they aren’t
          usually seen in the same program)

        * a plus sign followed by a single letter, or a few letters, or
          a word, e.g.  ‘+f’, ‘+rgb’

        * a slash followed by a letter, or a few letters, or a word,
          e.g.  ‘/f’, ‘/file’

     These option syntaxes are not supported by *note optparse: c3, and
     they never will be.  This is deliberate: the first three are
     non-standard on any environment, and the last only makes sense if
     you’re exclusively targeting VMS, MS-DOS, and/or Windows.

option argument

     an argument that follows an option, is closely associated with that
     option, and is consumed from the argument list when that option is.
     With *note optparse: c3, option arguments may either be in a
     separate argument from their option:

          -f foo --file foo

     or included in the same argument:

          -ffoo --file=foo

     Typically, a given option either takes an argument or it doesn’t.
     Lots of people want an “optional option arguments” feature, meaning
     that some options will take an argument if they see it, and won’t
     if they don’t.  This is somewhat controversial, because it makes
     parsing ambiguous: if ‘-a’ takes an optional argument and ‘-b’ is
     another option entirely, how do we interpret ‘-ab’?  Because of
     this ambiguity, *note optparse: c3. does not support this feature.

positional argument

     something leftover in the argument list after options have been
     parsed, i.e.  after options and their arguments have been parsed
     and removed from the argument list.

required option

     an option that must be supplied on the command-line; note that the
     phrase “required option” is self-contradictory in English.  *note
     optparse: c3. doesn’t prevent you from implementing required
     options, but doesn’t give you much help at it either.

For example, consider this hypothetical command-line:

     prog -v --report report.txt foo bar

‘-v’ and ‘--report’ are both options.  Assuming that ‘--report’ takes
one argument, ‘report.txt’ is an option argument.  ‘foo’ and ‘bar’ are
positional arguments.


File: python.info,  Node: What are options for?,  Next: What are positional arguments for?,  Prev: Terminology,  Up: Background

5.37.1.3 What are options for?
..............................

Options are used to provide extra information to tune or customize the
execution of a program.  In case it wasn’t clear, options are usually
`optional'.  A program should be able to run just fine with no options
whatsoever.  (Pick a random program from the Unix or GNU toolsets.  Can
it run without any options at all and still make sense?  The main
exceptions are ‘find’, ‘tar’, and ‘dd’—all of which are mutant oddballs
that have been rightly criticized for their non-standard syntax and
confusing interfaces.)

Lots of people want their programs to have “required options”.  Think
about it.  If it’s required, then it’s `not optional'!  If there is a
piece of information that your program absolutely requires in order to
run successfully, that’s what positional arguments are for.

As an example of good command-line interface design, consider the humble
‘cp’ utility, for copying files.  It doesn’t make much sense to try to
copy files without supplying a destination and at least one source.
Hence, ‘cp’ fails if you run it with no arguments.  However, it has a
flexible, useful syntax that does not require any options at all:

     cp SOURCE DEST cp SOURCE ... DEST-DIR

You can get pretty far with just that.  Most ‘cp’ implementations
provide a bunch of options to tweak exactly how the files are copied:
you can preserve mode and modification time, avoid following symlinks,
ask before clobbering existing files, etc.  But none of this distracts
from the core mission of ‘cp’, which is to copy either one file to
another, or several files to another directory.


File: python.info,  Node: What are positional arguments for?,  Prev: What are options for?,  Up: Background

5.37.1.4 What are positional arguments for?
...........................................

Positional arguments are for those pieces of information that your
program absolutely, positively requires to run.

A good user interface should have as few absolute requirements as
possible.  If your program requires 17 distinct pieces of information in
order to run successfully, it doesn’t much matter `how' you get that
information from the user—most people will give up and walk away before
they successfully run the program.  This applies whether the user
interface is a command-line, a configuration file, or a GUI: if you make
that many demands on your users, most of them will simply give up.

In short, try to minimize the amount of information that users are
absolutely required to supply—use sensible defaults whenever possible.
Of course, you also want to make your programs reasonably flexible.
That’s what options are for.  Again, it doesn’t matter if they are
entries in a config file, widgets in the “Preferences” dialog of a GUI,
or command-line options—the more options you implement, the more
flexible your program is, and the more complicated its implementation
becomes.  Too much flexibility has drawbacks as well, of course; too
many options can overwhelm users and make your code much harder to
maintain.


File: python.info,  Node: Tutorial<2>,  Next: Reference Guide,  Prev: Background,  Up: optparse — Parser for command line options

5.37.1.5 Tutorial
.................

While *note optparse: c3. is quite flexible and powerful, it’s also
straightforward to use in most cases.  This section covers the code
patterns that are common to any *note optparse: c3.-based program.

First, you need to import the OptionParser class; then, early in the
main program, create an OptionParser instance:

     from optparse import OptionParser ... parser = OptionParser()

Then you can start defining options.  The basic syntax is:

     parser.add_option(opt_str, ...,                   attr=value, ...)

Each option has one or more option strings, such as ‘-f’ or ‘--file’,
and several option attributes that tell *note optparse: c3. what to
expect and what to do when it encounters that option on the command
line.

Typically, each option will have one short option string and one long
option string, e.g.:

     parser.add_option("-f", "--file", ...)

You’re free to define as many short option strings and as many long
option strings as you like (including zero), as long as there is at
least one option string overall.

The option strings passed to *note OptionParser.add_option(): 1fb2. are
effectively labels for the option defined by that call.  For brevity, we
will frequently refer to `encountering an option' on the command line;
in reality, *note optparse: c3. encounters `option strings' and looks up
options from them.

Once all of your options are defined, instruct *note optparse: c3. to
parse your program’s command line:

     (options, args) = parser.parse_args()

(If you like, you can pass a custom argument list to ‘parse_args()’, but
that’s rarely necessary: by default it uses ‘sys.argv[1:]’.)

‘parse_args()’ returns two values:

   * ‘options’, an object containing values for all of your options—e.g.
     if ‘--file’ takes a single string argument, then ‘options.file’
     will be the filename supplied by the user, or ‘None’ if the user
     did not supply that option

   * ‘args’, the list of positional arguments leftover after parsing
     options

This tutorial section only covers the four most important option
attributes: *note action: 39b8, *note type: 39b9, *note dest: 39ba.
(destination), and *note help: 39bb.  Of these, *note action: 39b8. is
the most fundamental.

* Menu:

* Understanding option actions::
* The store action::
* Handling boolean (flag) options: Handling boolean flag options.
* Other actions::
* Default values::
* Generating help::
* Printing a version string::
* How optparse handles errors::
* Putting it all together::


File: python.info,  Node: Understanding option actions,  Next: The store action,  Up: Tutorial<2>

5.37.1.6 Understanding option actions
.....................................

Actions tell *note optparse: c3. what to do when it encounters an option
on the command line.  There is a fixed set of actions hard-coded into
*note optparse: c3.; adding new actions is an advanced topic covered in
section *note Extending optparse: 39be.  Most actions tell *note
optparse: c3. to store a value in some variable—for example, take a
string from the command line and store it in an attribute of ‘options’.

If you don’t specify an option action, *note optparse: c3. defaults to
‘store’.


File: python.info,  Node: The store action,  Next: Handling boolean flag options,  Prev: Understanding option actions,  Up: Tutorial<2>

5.37.1.7 The store action
.........................

The most common option action is ‘store’, which tells *note optparse:
c3. to take the next argument (or the remainder of the current
argument), ensure that it is of the correct type, and store it to your
chosen destination.

For example:

     parser.add_option("-f", "--file",                   action="store", type="string", dest="filename")

Now let’s make up a fake command line and ask *note optparse: c3. to
parse it:

     args = ["-f", "foo.txt"] (options, args) = parser.parse_args(args)

When *note optparse: c3. sees the option string ‘-f’, it consumes the
next argument, ‘foo.txt’, and stores it in ‘options.filename’.  So,
after this call to ‘parse_args()’, ‘options.filename’ is ‘"foo.txt"’.

Some other option types supported by *note optparse: c3. are ‘int’ and
‘float’.  Here’s an option that expects an integer argument:

     parser.add_option("-n", type="int", dest="num")

Note that this option has no long option string, which is perfectly
acceptable.  Also, there’s no explicit action, since the default is
‘store’.

Let’s parse another fake command-line.  This time, we’ll jam the option
argument right up against the option: since ‘-n42’ (one argument) is
equivalent to ‘-n 42’ (two arguments), the code

     (options, args) = parser.parse_args(["-n42"]) print(options.num)

will print ‘42’.

If you don’t specify a type, *note optparse: c3. assumes ‘string’.
Combined with the fact that the default action is ‘store’, that means
our first example can be a lot shorter:

     parser.add_option("-f", "--file", dest="filename")

If you don’t supply a destination, *note optparse: c3. figures out a
sensible default from the option strings: if the first long option
string is ‘--foo-bar’, then the default destination is ‘foo_bar’.  If
there are no long option strings, *note optparse: c3. looks at the first
short option string: the default destination for ‘-f’ is ‘f’.

*note optparse: c3. also includes the built-in ‘complex’ type.  Adding
types is covered in section *note Extending optparse: 39be.


File: python.info,  Node: Handling boolean flag options,  Next: Other actions,  Prev: The store action,  Up: Tutorial<2>

5.37.1.8 Handling boolean (flag) options
........................................

Flag options—set a variable to true or false when a particular option is
seen—are quite common.  *note optparse: c3. supports them with two
separate actions, ‘store_true’ and ‘store_false’.  For example, you
might have a ‘verbose’ flag that is turned on with ‘-v’ and off with
‘-q’:

     parser.add_option("-v", action="store_true", dest="verbose") parser.add_option("-q", action="store_false", dest="verbose")

Here we have two different options with the same destination, which is
perfectly OK. (It just means you have to be a bit careful when setting
default values—see below.)

When *note optparse: c3. encounters ‘-v’ on the command line, it sets
‘options.verbose’ to ‘True’; when it encounters ‘-q’, ‘options.verbose’
is set to ‘False’.


File: python.info,  Node: Other actions,  Next: Default values,  Prev: Handling boolean flag options,  Up: Tutorial<2>

5.37.1.9 Other actions
......................

Some other actions supported by *note optparse: c3. are:

‘"store_const"’

     store a constant value

‘"append"’

     append this option’s argument to a list

‘"count"’

     increment a counter by one

‘"callback"’

     call a specified function

These are covered in section *note Reference Guide: 39c5, and section
*note Option Callbacks: 39c6.


File: python.info,  Node: Default values,  Next: Generating help,  Prev: Other actions,  Up: Tutorial<2>

5.37.1.10 Default values
........................

All of the above examples involve setting some variable (the
“destination”) when certain command-line options are seen.  What happens
if those options are never seen?  Since we didn’t supply any defaults,
they are all set to ‘None’.  This is usually fine, but sometimes you
want more control.  *note optparse: c3. lets you supply a default value
for each destination, which is assigned before the command line is
parsed.

First, consider the verbose/quiet example.  If we want *note optparse:
c3. to set ‘verbose’ to ‘True’ unless ‘-q’ is seen, then we can do this:

     parser.add_option("-v", action="store_true", dest="verbose", default=True) parser.add_option("-q", action="store_false", dest="verbose")

Since default values apply to the `destination' rather than to any
particular option, and these two options happen to have the same
destination, this is exactly equivalent:

     parser.add_option("-v", action="store_true", dest="verbose") parser.add_option("-q", action="store_false", dest="verbose", default=True)

Consider this:

     parser.add_option("-v", action="store_true", dest="verbose", default=False) parser.add_option("-q", action="store_false", dest="verbose", default=True)

Again, the default value for ‘verbose’ will be ‘True’: the last default
value supplied for any particular destination is the one that counts.

A clearer way to specify default values is the ‘set_defaults()’ method
of OptionParser, which you can call at any time before calling
‘parse_args()’:

     parser.set_defaults(verbose=True) parser.add_option(...) (options, args) = parser.parse_args()

As before, the last value specified for a given option destination is
the one that counts.  For clarity, try to use one method or the other of
setting default values, not both.


File: python.info,  Node: Generating help,  Next: Printing a version string,  Prev: Default values,  Up: Tutorial<2>

5.37.1.11 Generating help
.........................

*note optparse: c3.’s ability to generate help and usage text
automatically is useful for creating user-friendly command-line
interfaces.  All you have to do is supply a *note help: 39bb. value for
each option, and optionally a short usage message for your whole
program.  Here’s an OptionParser populated with user-friendly
(documented) options:

     usage = "usage: %prog [options] arg1 arg2" parser = OptionParser(usage=usage) parser.add_option("-v", "--verbose",                   action="store_true", dest="verbose", default=True,                   help="make lots of noise [default]") parser.add_option("-q", "--quiet",                   action="store_false", dest="verbose",                   help="be vewwy quiet (I'm hunting wabbits)") parser.add_option("-f", "--filename",                   metavar="FILE", help="write output to FILE") parser.add_option("-m", "--mode",                   default="intermediate",                   help="interaction mode: novice, intermediate, "                        "or expert [default: %default]")

If *note optparse: c3. encounters either ‘-h’ or ‘--help’ on the
command-line, or if you just call ‘parser.print_help()’, it prints the
following to standard output:

     Usage: <yourscript> [options] arg1 arg2  Options:   -h, --help            show this help message and exit   -v, --verbose         make lots of noise [default]   -q, --quiet           be vewwy quiet (I'm hunting wabbits)   -f FILE, --filename=FILE                         write output to FILE   -m MODE, --mode=MODE  interaction mode: novice, intermediate, or                         expert [default: intermediate]

(If the help output is triggered by a help option, *note optparse: c3.
exits after printing the help text.)

There’s a lot going on here to help *note optparse: c3. generate the
best possible help message:

   * the script defines its own usage message:

          usage = "usage: %prog [options] arg1 arg2"

     *note optparse: c3. expands ‘%prog’ in the usage string to the name
     of the current program, i.e.  ‘os.path.basename(sys.argv[0])’.  The
     expanded string is then printed before the detailed option help.

     If you don’t supply a usage string, *note optparse: c3. uses a
     bland but sensible default: ‘"Usage: %prog [options]"’, which is
     fine if your script doesn’t take any positional arguments.

   * every option defines a help string, and doesn’t worry about
     line-wrapping—*note optparse: c3. takes care of wrapping lines and
     making the help output look good.

   * options that take a value indicate this fact in their
     automatically-generated help message, e.g.  for the “mode” option:

          -m MODE, --mode=MODE

     Here, “MODE” is called the meta-variable: it stands for the
     argument that the user is expected to supply to ‘-m’/‘--mode’.  By
     default, *note optparse: c3. converts the destination variable name
     to uppercase and uses that for the meta-variable.  Sometimes,
     that’s not what you want—for example, the ‘--filename’ option
     explicitly sets ‘metavar="FILE"’, resulting in this
     automatically-generated option description:

          -f FILE, --filename=FILE

     This is important for more than just saving space, though: the
     manually written help text uses the meta-variable ‘FILE’ to clue
     the user in that there’s a connection between the semi-formal
     syntax ‘-f FILE’ and the informal semantic description “write
     output to FILE”.  This is a simple but effective way to make your
     help text a lot clearer and more useful for end users.

   * options that have a default value can include ‘%default’ in the
     help string—*note optparse: c3. will replace it with *note str():
     325. of the option’s default value.  If an option has no default
     value (or the default value is ‘None’), ‘%default’ expands to
     ‘none’.

* Menu:

* Grouping Options::


File: python.info,  Node: Grouping Options,  Up: Generating help

5.37.1.12 Grouping Options
..........................

When dealing with many options, it is convenient to group these options
for better help output.  An *note OptionParser: 39ad. can contain
several option groups, each of which can contain several options.

An option group is obtained using the class *note OptionGroup: 39cc.:

 -- Class: optparse.OptionGroup (parser, title, description=None)

     where

        * parser is the *note OptionParser: 39ad. instance the group
          will be inserted in to

        * title is the group title

        * description, optional, is a long description of the group

*note OptionGroup: 39cc. inherits from ‘OptionContainer’ (like *note
OptionParser: 39ad.) and so the ‘add_option()’ method can be used to add
an option to the group.

Once all the options are declared, using the *note OptionParser: 39ad.
method ‘add_option_group()’ the group is added to the previously defined
parser.

Continuing with the parser defined in the previous section, adding an
*note OptionGroup: 39cc. to a parser is easy:

     group = OptionGroup(parser, "Dangerous Options",                     "Caution: use these options at your own risk.  "                     "It is believed that some of them bite.") group.add_option("-g", action="store_true", help="Group option.") parser.add_option_group(group)

This would result in the following help output:

     Usage: <yourscript> [options] arg1 arg2  Options:   -h, --help            show this help message and exit   -v, --verbose         make lots of noise [default]   -q, --quiet           be vewwy quiet (I'm hunting wabbits)   -f FILE, --filename=FILE                         write output to FILE   -m MODE, --mode=MODE  interaction mode: novice, intermediate, or                         expert [default: intermediate]    Dangerous Options:     Caution: use these options at your own risk.  It is believed that some     of them bite.      -g                  Group option.

A bit more complete example might involve using more than one group:
still extending the previous example:

     group = OptionGroup(parser, "Dangerous Options",                     "Caution: use these options at your own risk.  "                     "It is believed that some of them bite.") group.add_option("-g", action="store_true", help="Group option.") parser.add_option_group(group)  group = OptionGroup(parser, "Debug Options") group.add_option("-d", "--debug", action="store_true",                  help="Print debug information") group.add_option("-s", "--sql", action="store_true",                  help="Print all SQL statements executed") group.add_option("-e", action="store_true", help="Print every action done") parser.add_option_group(group)

that results in the following output:

     Usage: <yourscript> [options] arg1 arg2  Options:   -h, --help            show this help message and exit   -v, --verbose         make lots of noise [default]   -q, --quiet           be vewwy quiet (I'm hunting wabbits)   -f FILE, --filename=FILE                         write output to FILE   -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert                         [default: intermediate]    Dangerous Options:     Caution: use these options at your own risk.  It is believed that some     of them bite.      -g                  Group option.    Debug Options:     -d, --debug         Print debug information     -s, --sql           Print all SQL statements executed     -e                  Print every action done

Another interesting method, in particular when working programmatically
with option groups is:

 -- Method: OptionParser.get_option_group (opt_str)

     Return the *note OptionGroup: 39cc. to which the short or long
     option string `opt_str' (e.g.  ‘'-o'’ or ‘'--option'’) belongs.  If
     there’s no such *note OptionGroup: 39cc, return ‘None’.


File: python.info,  Node: Printing a version string,  Next: How optparse handles errors,  Prev: Generating help,  Up: Tutorial<2>

5.37.1.13 Printing a version string
...................................

Similar to the brief usage string, *note optparse: c3. can also print a
version string for your program.  You have to supply the string as the
‘version’ argument to OptionParser:

     parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")

‘%prog’ is expanded just like it is in ‘usage’.  Apart from that,
‘version’ can contain anything you like.  When you supply it, *note
optparse: c3. automatically adds a ‘--version’ option to your parser.
If it encounters this option on the command line, it expands your
‘version’ string (by replacing ‘%prog’), prints it to stdout, and exits.

For example, if your script is called ‘/usr/bin/foo’:

     $ /usr/bin/foo --version foo 1.0

The following two methods can be used to print and get the ‘version’
string:

 -- Method: OptionParser.print_version (file=None)

     Print the version message for the current program (‘self.version’)
     to `file' (default stdout).  As with *note print_usage(): 39d1, any
     occurrence of ‘%prog’ in ‘self.version’ is replaced with the name
     of the current program.  Does nothing if ‘self.version’ is empty or
     undefined.

 -- Method: OptionParser.get_version ()

     Same as *note print_version(): 39d0. but returns the version string
     instead of printing it.


File: python.info,  Node: How optparse handles errors,  Next: Putting it all together,  Prev: Printing a version string,  Up: Tutorial<2>

5.37.1.14 How ‘optparse’ handles errors
.......................................

There are two broad classes of errors that *note optparse: c3. has to
worry about: programmer errors and user errors.  Programmer errors are
usually erroneous calls to *note OptionParser.add_option(): 1fb2, e.g.
invalid option strings, unknown option attributes, missing option
attributes, etc.  These are dealt with in the usual way: raise an
exception (either ‘optparse.OptionError’ or *note TypeError: 192.) and
let the program crash.

Handling user errors is much more important, since they are guaranteed
to happen no matter how stable your code is.  *note optparse: c3. can
automatically detect some user errors, such as bad option arguments
(passing ‘-n 4x’ where ‘-n’ takes an integer argument), missing
arguments (‘-n’ at the end of the command line, where ‘-n’ takes an
argument of any type).  Also, you can call ‘OptionParser.error()’ to
signal an application-defined error condition:

     (options, args) = parser.parse_args() ... if options.a and options.b:     parser.error("options -a and -b are mutually exclusive")

In either case, *note optparse: c3. handles the error the same way: it
prints the program’s usage message and an error message to standard
error and exits with error status 2.

Consider the first example above, where the user passes ‘4x’ to an
option that takes an integer:

     $ /usr/bin/foo -n 4x Usage: foo [options]  foo: error: option -n: invalid integer value: '4x'

Or, where the user fails to pass a value at all:

     $ /usr/bin/foo -n Usage: foo [options]  foo: error: -n option requires an argument

*note optparse: c3.-generated error messages take care always to mention
the option involved in the error; be sure to do the same when calling
‘OptionParser.error()’ from your application code.

If *note optparse: c3.’s default error-handling behaviour does not suit
your needs, you’ll need to subclass OptionParser and override its
‘exit()’ and/or ‘error()’ methods.


File: python.info,  Node: Putting it all together,  Prev: How optparse handles errors,  Up: Tutorial<2>

5.37.1.15 Putting it all together
.................................

Here’s what *note optparse: c3.-based scripts usually look like:

     from optparse import OptionParser ... def main():     usage = "usage: %prog [options] arg"     parser = OptionParser(usage)     parser.add_option("-f", "--file", dest="filename",                       help="read data from FILENAME")     parser.add_option("-v", "--verbose",                       action="store_true", dest="verbose")     parser.add_option("-q", "--quiet",                       action="store_false", dest="verbose")     ...     (options, args) = parser.parse_args()     if len(args) != 1:         parser.error("incorrect number of arguments")     if options.verbose:         print("reading %s..." % options.filename)     ...  if __name__ == "__main__":     main()


File: python.info,  Node: Reference Guide,  Next: Option Callbacks,  Prev: Tutorial<2>,  Up: optparse — Parser for command line options

5.37.1.16 Reference Guide
.........................

* Menu:

* Creating the parser::
* Populating the parser::
* Defining options::
* Option attributes::
* Standard option actions::
* Standard option types::
* Parsing arguments: Parsing arguments<2>.
* Querying and manipulating your option parser::
* Conflicts between options::
* Cleanup: Cleanup<2>.
* Other methods::


File: python.info,  Node: Creating the parser,  Next: Populating the parser,  Up: Reference Guide

5.37.1.17 Creating the parser
.............................

The first step in using *note optparse: c3. is to create an OptionParser
instance.

 -- Class: optparse.OptionParser (...)

     The OptionParser constructor has no required arguments, but a
     number of optional keyword arguments.  You should always pass them
     as keyword arguments, i.e.  do not rely on the order in which the
     arguments are declared.

     ‘usage’ (default: ‘"%prog [options]"’)

          The usage summary to print when your program is run
          incorrectly or with a help option.  When *note optparse: c3.
          prints the usage string, it expands ‘%prog’ to
          ‘os.path.basename(sys.argv[0])’ (or to ‘prog’ if you passed
          that keyword argument).  To suppress a usage message, pass the
          special value ‘optparse.SUPPRESS_USAGE’.

     ‘option_list’ (default: ‘[]’)

          A list of Option objects to populate the parser with.  The
          options in ‘option_list’ are added after any options in
          ‘standard_option_list’ (a class attribute that may be set by
          OptionParser subclasses), but before any version or help
          options.  Deprecated; use *note add_option(): 1fb2. after
          creating the parser instead.

     ‘option_class’ (default: optparse.Option)

          Class to use when adding options to the parser in *note
          add_option(): 1fb2.

     ‘version’ (default: ‘None’)

          A version string to print when the user supplies a version
          option.  If you supply a true value for ‘version’, *note
          optparse: c3. automatically adds a version option with the
          single option string ‘--version’.  The substring ‘%prog’ is
          expanded the same as for ‘usage’.

     ‘conflict_handler’ (default: ‘"error"’)

          Specifies what to do when options with conflicting option
          strings are added to the parser; see section *note Conflicts
          between options: 39da.

     ‘description’ (default: ‘None’)

          A paragraph of text giving a brief overview of your program.
          *note optparse: c3. reformats this paragraph to fit the
          current terminal width and prints it when the user requests
          help (after ‘usage’, but before the list of options).

     ‘formatter’ (default: a new ‘IndentedHelpFormatter’)

          An instance of optparse.HelpFormatter that will be used for
          printing help text.  *note optparse: c3. provides two concrete
          classes for this purpose: IndentedHelpFormatter and
          TitledHelpFormatter.

     ‘add_help_option’ (default: ‘True’)

          If true, *note optparse: c3. will add a help option (with
          option strings ‘-h’ and ‘--help’) to the parser.

     ‘prog’

          The string to use when expanding ‘%prog’ in ‘usage’ and
          ‘version’ instead of ‘os.path.basename(sys.argv[0])’.

     ‘epilog’ (default: ‘None’)

          A paragraph of help text to print after the option help.


File: python.info,  Node: Populating the parser,  Next: Defining options,  Prev: Creating the parser,  Up: Reference Guide

5.37.1.18 Populating the parser
...............................

There are several ways to populate the parser with options.  The
preferred way is by using *note OptionParser.add_option(): 1fb2, as
shown in section *note Tutorial: 39b6.  ‘add_option()’ can be called in
one of two ways:

   * pass it an Option instance (as returned by ‘make_option()’)

   * pass it any combination of positional and keyword arguments that
     are acceptable to ‘make_option()’ (i.e., to the Option
     constructor), and it will create the Option instance for you

The other alternative is to pass a list of pre-constructed Option
instances to the OptionParser constructor, as in:

     option_list = [     make_option("-f", "--filename",                 action="store", type="string", dest="filename"),     make_option("-q", "--quiet",                 action="store_false", dest="verbose"),     ] parser = OptionParser(option_list=option_list)

(‘make_option()’ is a factory function for creating Option instances;
currently it is an alias for the Option constructor.  A future version
of *note optparse: c3. may split Option into several classes, and
‘make_option()’ will pick the right class to instantiate.  Do not
instantiate Option directly.)


File: python.info,  Node: Defining options,  Next: Option attributes,  Prev: Populating the parser,  Up: Reference Guide

5.37.1.19 Defining options
..........................

Each Option instance represents a set of synonymous command-line option
strings, e.g.  ‘-f’ and ‘--file’.  You can specify any number of short
or long option strings, but you must specify at least one overall option
string.

The canonical way to create an ‘Option’ instance is with the
‘add_option()’ method of *note OptionParser: 39ad.

 -- Method: OptionParser.add_option (option)

 -- Method: OptionParser.add_option (*opt_str, attr=value, ...)

     To define an option with only a short option string:

          parser.add_option("-f", attr=value, ...)

     And to define an option with only a long option string:

          parser.add_option("--foo", attr=value, ...)

     The keyword arguments define attributes of the new Option object.
     The most important option attribute is *note action: 39b8, and it
     largely determines which other attributes are relevant or required.
     If you pass irrelevant option attributes, or fail to pass required
     ones, *note optparse: c3. raises an ‘OptionError’ exception
     explaining your mistake.

     An option’s `action' determines what *note optparse: c3. does when
     it encounters this option on the command-line.  The standard option
     actions hard-coded into *note optparse: c3. are:

     ‘"store"’

          store this option’s argument (default)

     ‘"store_const"’

          store a constant value

     ‘"store_true"’

          store ‘True’

     ‘"store_false"’

          store ‘False’

     ‘"append"’

          append this option’s argument to a list

     ‘"append_const"’

          append a constant value to a list

     ‘"count"’

          increment a counter by one

     ‘"callback"’

          call a specified function

     ‘"help"’

          print a usage message including all options and the
          documentation for them

     (If you don’t supply an action, the default is ‘"store"’.  For this
     action, you may also supply *note type: 39b9. and *note dest: 39ba.
     option attributes; see *note Standard option actions: 39df.)

As you can see, most actions involve storing or updating a value
somewhere.  *note optparse: c3. always creates a special object for
this, conventionally called ‘options’ (it happens to be an instance of
‘optparse.Values’).  Option arguments (and various other values) are
stored as attributes of this object, according to the *note dest: 39ba.
(destination) option attribute.

For example, when you call

     parser.parse_args()

one of the first things *note optparse: c3. does is create the ‘options’
object:

     options = Values()

If one of the options in this parser is defined with

     parser.add_option("-f", "--file", action="store", type="string", dest="filename")

and the command-line being parsed includes any of the following:

     -ffoo -f foo --file=foo --file foo

then *note optparse: c3, on seeing this option, will do the equivalent
of

     options.filename = "foo"

The *note type: 39b9. and *note dest: 39ba. option attributes are almost
as important as *note action: 39b8, but *note action: 39b8. is the only
one that makes sense for `all' options.


File: python.info,  Node: Option attributes,  Next: Standard option actions,  Prev: Defining options,  Up: Reference Guide

5.37.1.20 Option attributes
...........................

The following option attributes may be passed as keyword arguments to
*note OptionParser.add_option(): 1fb2.  If you pass an option attribute
that is not relevant to a particular option, or fail to pass a required
option attribute, *note optparse: c3. raises ‘OptionError’.

 -- Attribute: Option.action

     (default: ‘"store"’)

     Determines *note optparse: c3.’s behaviour when this option is seen
     on the command line; the available options are documented *note
     here: 39df.

 -- Attribute: Option.type

     (default: ‘"string"’)

     The argument type expected by this option (e.g., ‘"string"’ or
     ‘"int"’); the available option types are documented *note here:
     39e2.

 -- Attribute: Option.dest

     (default: derived from option strings)

     If the option’s action implies writing or modifying a value
     somewhere, this tells *note optparse: c3. where to write it: *note
     dest: 39ba. names an attribute of the ‘options’ object that *note
     optparse: c3. builds as it parses the command line.

 -- Attribute: Option.default

     The value to use for this option’s destination if the option is not
     seen on the command line.  See also *note
     OptionParser.set_defaults(): 39e4.

 -- Attribute: Option.nargs

     (default: 1)

     How many arguments of type *note type: 39b9. should be consumed
     when this option is seen.  If > 1, *note optparse: c3. will store a
     tuple of values to *note dest: 39ba.

 -- Attribute: Option.const

     For actions that store a constant value, the constant value to
     store.

 -- Attribute: Option.choices

     For options of type ‘"choice"’, the list of strings the user may
     choose from.

 -- Attribute: Option.callback

     For options with action ‘"callback"’, the callable to call when
     this option is seen.  See section *note Option Callbacks: 39c6. for
     detail on the arguments passed to the callable.

 -- Attribute: Option.callback_args
 -- Attribute: Option.callback_kwargs

     Additional positional and keyword arguments to pass to ‘callback’
     after the four standard callback arguments.

 -- Attribute: Option.help

     Help text to print for this option when listing all available
     options after the user supplies a *note help: 39bb. option (such as
     ‘--help’).  If no help text is supplied, the option will be listed
     without help text.  To hide this option, use the special value
     ‘optparse.SUPPRESS_HELP’.

 -- Attribute: Option.metavar

     (default: derived from option strings)

     Stand-in for the option argument(s) to use when printing help text.
     See section *note Tutorial: 39b6. for an example.


File: python.info,  Node: Standard option actions,  Next: Standard option types,  Prev: Option attributes,  Up: Reference Guide

5.37.1.21 Standard option actions
.................................

The various option actions all have slightly different requirements and
effects.  Most actions have several relevant option attributes which you
may specify to guide *note optparse: c3.’s behaviour; a few have
required attributes, which you must specify for any option using that
action.

   * ‘"store"’ [relevant: *note type: 39b9, *note dest: 39ba, *note
     nargs: 39e5, *note choices: 39e7.]

     The option must be followed by an argument, which is converted to a
     value according to *note type: 39b9. and stored in *note dest:
     39ba.  If *note nargs: 39e5. > 1, multiple arguments will be
     consumed from the command line; all will be converted according to
     *note type: 39b9. and stored to *note dest: 39ba. as a tuple.  See
     the *note Standard option types: 39e2. section.

     If *note choices: 39e7. is supplied (a list or tuple of strings),
     the type defaults to ‘"choice"’.

     If *note type: 39b9. is not supplied, it defaults to ‘"string"’.

     If *note dest: 39ba. is not supplied, *note optparse: c3. derives a
     destination from the first long option string (e.g., ‘--foo-bar’
     implies ‘foo_bar’).  If there are no long option strings, *note
     optparse: c3. derives a destination from the first short option
     string (e.g., ‘-f’ implies ‘f’).

     Example:

          parser.add_option("-f") parser.add_option("-p", type="float", nargs=3, dest="point")

     As it parses the command line

          -f foo.txt -p 1 -3.5 4 -fbar.txt

     *note optparse: c3. will set

          options.f = "foo.txt" options.point = (1.0, -3.5, 4.0) options.f = "bar.txt"

   * ‘"store_const"’ [required: *note const: 39e6.; relevant: *note
     dest: 39ba.]

     The value *note const: 39e6. is stored in *note dest: 39ba.

     Example:

          parser.add_option("-q", "--quiet",                   action="store_const", const=0, dest="verbose") parser.add_option("-v", "--verbose",                   action="store_const", const=1, dest="verbose") parser.add_option("--noisy",                   action="store_const", const=2, dest="verbose")

     If ‘--noisy’ is seen, *note optparse: c3. will set

          options.verbose = 2

   * ‘"store_true"’ [relevant: *note dest: 39ba.]

     A special case of ‘"store_const"’ that stores ‘True’ to *note dest:
     39ba.

   * ‘"store_false"’ [relevant: *note dest: 39ba.]

     Like ‘"store_true"’, but stores ‘False’.

     Example:

          parser.add_option("--clobber", action="store_true", dest="clobber") parser.add_option("--no-clobber", action="store_false", dest="clobber")

   * ‘"append"’ [relevant: *note type: 39b9, *note dest: 39ba, *note
     nargs: 39e5, *note choices: 39e7.]

     The option must be followed by an argument, which is appended to
     the list in *note dest: 39ba.  If no default value for *note dest:
     39ba. is supplied, an empty list is automatically created when
     *note optparse: c3. first encounters this option on the
     command-line.  If *note nargs: 39e5. > 1, multiple arguments are
     consumed, and a tuple of length *note nargs: 39e5. is appended to
     *note dest: 39ba.

     The defaults for *note type: 39b9. and *note dest: 39ba. are the
     same as for the ‘"store"’ action.

     Example:

          parser.add_option("-t", "--tracks", action="append", type="int")

     If ‘-t3’ is seen on the command-line, *note optparse: c3. does the
     equivalent of:

          options.tracks = [] options.tracks.append(int("3"))

     If, a little later on, ‘--tracks=4’ is seen, it does:

          options.tracks.append(int("4"))

     The ‘append’ action calls the ‘append’ method on the current value
     of the option.  This means that any default value specified must
     have an ‘append’ method.  It also means that if the default value
     is non-empty, the default elements will be present in the parsed
     value for the option, with any values from the command line
     appended after those default values:

          >>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults']) >>> opts, args = parser.parse_args(['--files', 'overrides.mypkg']) >>> opts.files ['~/.mypkg/defaults', 'overrides.mypkg']

   * ‘"append_const"’ [required: *note const: 39e6.; relevant: *note
     dest: 39ba.]

     Like ‘"store_const"’, but the value *note const: 39e6. is appended
     to *note dest: 39ba.; as with ‘"append"’, *note dest: 39ba.
     defaults to ‘None’, and an empty list is automatically created the
     first time the option is encountered.

   * ‘"count"’ [relevant: *note dest: 39ba.]

     Increment the integer stored at *note dest: 39ba.  If no default
     value is supplied, *note dest: 39ba. is set to zero before being
     incremented the first time.

     Example:

          parser.add_option("-v", action="count", dest="verbosity")

     The first time ‘-v’ is seen on the command line, *note optparse:
     c3. does the equivalent of:

          options.verbosity = 0 options.verbosity += 1

     Every subsequent occurrence of ‘-v’ results in

          options.verbosity += 1

   * ‘"callback"’ [required: *note callback: 39e8.; relevant: *note
     type: 39b9, *note nargs: 39e5, *note callback_args: 39e9, *note
     callback_kwargs: 39ea.]

     Call the function specified by *note callback: 39e8, which is
     called as

          func(option, opt_str, value, parser, *args, **kwargs)

     See section *note Option Callbacks: 39c6. for more detail.

   * ‘"help"’

     Prints a complete help message for all the options in the current
     option parser.  The help message is constructed from the ‘usage’
     string passed to OptionParser’s constructor and the *note help:
     39bb. string passed to every option.

     If no *note help: 39bb. string is supplied for an option, it will
     still be listed in the help message.  To omit an option entirely,
     use the special value ‘optparse.SUPPRESS_HELP’.

     *note optparse: c3. automatically adds a *note help: 39bb. option
     to all OptionParsers, so you do not normally need to create one.

     Example:

          from optparse import OptionParser, SUPPRESS_HELP  # usually, a help option is added automatically, but that can # be suppressed using the add_help_option argument parser = OptionParser(add_help_option=False)  parser.add_option("-h", "--help", action="help") parser.add_option("-v", action="store_true", dest="verbose",                   help="Be moderately verbose") parser.add_option("--file", dest="filename",                   help="Input file to read data from") parser.add_option("--secret", help=SUPPRESS_HELP)

     If *note optparse: c3. sees either ‘-h’ or ‘--help’ on the command
     line, it will print something like the following help message to
     stdout (assuming ‘sys.argv[0]’ is ‘"foo.py"’):

          Usage: foo.py [options]  Options:   -h, --help        Show this help message and exit   -v                Be moderately verbose   --file=FILENAME   Input file to read data from

     After printing the help message, *note optparse: c3. terminates
     your process with ‘sys.exit(0)’.

   * ‘"version"’

     Prints the version number supplied to the OptionParser to stdout
     and exits.  The version number is actually formatted and printed by
     the ‘print_version()’ method of OptionParser.  Generally only
     relevant if the ‘version’ argument is supplied to the OptionParser
     constructor.  As with *note help: 39bb. options, you will rarely
     create ‘version’ options, since *note optparse: c3. automatically
     adds them when needed.


File: python.info,  Node: Standard option types,  Next: Parsing arguments<2>,  Prev: Standard option actions,  Up: Reference Guide

5.37.1.22 Standard option types
...............................

*note optparse: c3. has five built-in option types: ‘"string"’, ‘"int"’,
‘"choice"’, ‘"float"’ and ‘"complex"’.  If you need to add new option
types, see section *note Extending optparse: 39be.

Arguments to string options are not checked or converted in any way: the
text on the command line is stored in the destination (or passed to the
callback) as-is.

Integer arguments (type ‘"int"’) are parsed as follows:

   * if the number starts with ‘0x’, it is parsed as a hexadecimal
     number

   * if the number starts with ‘0’, it is parsed as an octal number

   * if the number starts with ‘0b’, it is parsed as a binary number

   * otherwise, the number is parsed as a decimal number

The conversion is done by calling *note int(): 184. with the appropriate
base (2, 8, 10, or 16).  If this fails, so will *note optparse: c3,
although with a more useful error message.

‘"float"’ and ‘"complex"’ option arguments are converted directly with
*note float(): 187. and *note complex(): 189, with similar
error-handling.

‘"choice"’ options are a subtype of ‘"string"’ options.  The *note
choices: 39e7. option attribute (a sequence of strings) defines the set
of allowed option arguments.  ‘optparse.check_choice()’ compares
user-supplied option arguments against this master list and raises
‘OptionValueError’ if an invalid string is given.


File: python.info,  Node: Parsing arguments<2>,  Next: Querying and manipulating your option parser,  Prev: Standard option types,  Up: Reference Guide

5.37.1.23 Parsing arguments
...........................

The whole point of creating and populating an OptionParser is to call
its ‘parse_args()’ method:

     (options, args) = parser.parse_args(args=None, values=None)

where the input parameters are

‘args’

     the list of arguments to process (default: ‘sys.argv[1:]’)

‘values’

     an ‘optparse.Values’ object to store option arguments in (default:
     a new instance of ‘Values’) – if you give an existing object, the
     option defaults will not be initialized on it

and the return values are

‘options’

     the same object that was passed in as ‘values’, or the
     optparse.Values instance created by *note optparse: c3.

‘args’

     the leftover positional arguments after all options have been
     processed

The most common usage is to supply neither keyword argument.  If you
supply ‘values’, it will be modified with repeated *note setattr():
1518. calls (roughly one for every option argument stored to an option
destination) and returned by ‘parse_args()’.

If ‘parse_args()’ encounters any errors in the argument list, it calls
the OptionParser’s ‘error()’ method with an appropriate end-user error
message.  This ultimately terminates your process with an exit status of
2 (the traditional Unix exit status for command-line errors).


File: python.info,  Node: Querying and manipulating your option parser,  Next: Conflicts between options,  Prev: Parsing arguments<2>,  Up: Reference Guide

5.37.1.24 Querying and manipulating your option parser
......................................................

The default behavior of the option parser can be customized slightly,
and you can also poke around your option parser and see what’s there.
OptionParser provides several methods to help you out:

 -- Method: OptionParser.disable_interspersed_args ()

     Set parsing to stop on the first non-option.  For example, if ‘-a’
     and ‘-b’ are both simple options that take no arguments, *note
     optparse: c3. normally accepts this syntax:

          prog -a arg1 -b arg2

     and treats it as equivalent to

          prog -a -b arg1 arg2

     To disable this feature, call *note disable_interspersed_args():
     1fb3.  This restores traditional Unix syntax, where option parsing
     stops with the first non-option argument.

     Use this if you have a command processor which runs another command
     which has options of its own and you want to make sure these
     options don’t get confused.  For example, each command might have a
     different set of options.

 -- Method: OptionParser.enable_interspersed_args ()

     Set parsing to not stop on the first non-option, allowing
     interspersing switches with command arguments.  This is the default
     behavior.

 -- Method: OptionParser.get_option (opt_str)

     Returns the Option instance with the option string `opt_str', or
     ‘None’ if no options have that option string.

 -- Method: OptionParser.has_option (opt_str)

     Return ‘True’ if the OptionParser has an option with option string
     `opt_str' (e.g., ‘-q’ or ‘--verbose’).

 -- Method: OptionParser.remove_option (opt_str)

     If the *note OptionParser: 39ad. has an option corresponding to
     `opt_str', that option is removed.  If that option provided any
     other option strings, all of those option strings become invalid.
     If `opt_str' does not occur in any option belonging to this *note
     OptionParser: 39ad, raises *note ValueError: 1f9.


File: python.info,  Node: Conflicts between options,  Next: Cleanup<2>,  Prev: Querying and manipulating your option parser,  Up: Reference Guide

5.37.1.25 Conflicts between options
...................................

If you’re not careful, it’s easy to define options with conflicting
option strings:

     parser.add_option("-n", "--dry-run", ...) ... parser.add_option("-n", "--noisy", ...)

(This is particularly true if you’ve defined your own OptionParser
subclass with some standard options.)

Every time you add an option, *note optparse: c3. checks for conflicts
with existing options.  If it finds any, it invokes the current
conflict-handling mechanism.  You can set the conflict-handling
mechanism either in the constructor:

     parser = OptionParser(..., conflict_handler=handler)

or with a separate call:

     parser.set_conflict_handler(handler)

The available conflict handlers are:

     ‘"error"’ (default)

          assume option conflicts are a programming error and raise
          ‘OptionConflictError’

     ‘"resolve"’

          resolve option conflicts intelligently (see below)

As an example, let’s define an *note OptionParser: 39ad. that resolves
conflicts intelligently and add conflicting options to it:

     parser = OptionParser(conflict_handler="resolve") parser.add_option("-n", "--dry-run", ..., help="do no harm") parser.add_option("-n", "--noisy", ..., help="be noisy")

At this point, *note optparse: c3. detects that a previously-added
option is already using the ‘-n’ option string.  Since
‘conflict_handler’ is ‘"resolve"’, it resolves the situation by removing
‘-n’ from the earlier option’s list of option strings.  Now ‘--dry-run’
is the only way for the user to activate that option.  If the user asks
for help, the help message will reflect that:

     Options:   --dry-run     do no harm   ...   -n, --noisy   be noisy

It’s possible to whittle away the option strings for a previously-added
option until there are none left, and the user has no way of invoking
that option from the command-line.  In that case, *note optparse: c3.
removes that option completely, so it doesn’t show up in help text or
anywhere else.  Carrying on with our existing OptionParser:

     parser.add_option("--dry-run", ..., help="new dry-run option")

At this point, the original ‘-n’/‘--dry-run’ option is no longer
accessible, so *note optparse: c3. removes it, leaving this help text:

     Options:   ...   -n, --noisy   be noisy   --dry-run     new dry-run option


File: python.info,  Node: Cleanup<2>,  Next: Other methods,  Prev: Conflicts between options,  Up: Reference Guide

5.37.1.26 Cleanup
.................

OptionParser instances have several cyclic references.  This should not
be a problem for Python’s garbage collector, but you may wish to break
the cyclic references explicitly by calling ‘destroy()’ on your
OptionParser once you are done with it.  This is particularly useful in
long-running applications where large object graphs are reachable from
your OptionParser.


File: python.info,  Node: Other methods,  Prev: Cleanup<2>,  Up: Reference Guide

5.37.1.27 Other methods
.......................

OptionParser supports several other public methods:

 -- Method: OptionParser.set_usage (usage)

     Set the usage string according to the rules described above for the
     ‘usage’ constructor keyword argument.  Passing ‘None’ sets the
     default usage string; use ‘optparse.SUPPRESS_USAGE’ to suppress a
     usage message.

 -- Method: OptionParser.print_usage (file=None)

     Print the usage message for the current program (‘self.usage’) to
     `file' (default stdout).  Any occurrence of the string ‘%prog’ in
     ‘self.usage’ is replaced with the name of the current program.
     Does nothing if ‘self.usage’ is empty or not defined.

 -- Method: OptionParser.get_usage ()

     Same as *note print_usage(): 39d1. but returns the usage string
     instead of printing it.

 -- Method: OptionParser.set_defaults (dest=value, ...)

     Set default values for several option destinations at once.  Using
     *note set_defaults(): 39e4. is the preferred way to set default
     values for options, since multiple options can share the same
     destination.  For example, if several “mode” options all set the
     same destination, any one of them can set the default, and the last
     one wins:

          parser.add_option("--advanced", action="store_const",                   dest="mode", const="advanced",                   default="novice")    # overridden below parser.add_option("--novice", action="store_const",                   dest="mode", const="novice",                   default="advanced")  # overrides above setting

     To avoid this confusion, use *note set_defaults(): 39e4.:

          parser.set_defaults(mode="advanced") parser.add_option("--advanced", action="store_const",                   dest="mode", const="advanced") parser.add_option("--novice", action="store_const",                   dest="mode", const="novice")


File: python.info,  Node: Option Callbacks,  Next: Extending optparse,  Prev: Reference Guide,  Up: optparse — Parser for command line options

5.37.1.28 Option Callbacks
..........................

When *note optparse: c3.’s built-in actions and types aren’t quite
enough for your needs, you have two choices: extend *note optparse: c3.
or define a callback option.  Extending *note optparse: c3. is more
general, but overkill for a lot of simple cases.  Quite often a simple
callback is all you need.

There are two steps to defining a callback option:

   * define the option itself using the ‘"callback"’ action

   * write the callback; this is a function (or method) that takes at
     least four arguments, as described below

* Menu:

* Defining a callback option::
* How callbacks are called::
* Raising errors in a callback::
* Callback example 1; trivial callback: Callback example 1 trivial callback.
* Callback example 2; check option order: Callback example 2 check option order.
* Callback example 3; check option order (generalized): Callback example 3 check option order generalized.
* Callback example 4; check arbitrary condition: Callback example 4 check arbitrary condition.
* Callback example 5; fixed arguments: Callback example 5 fixed arguments.
* Callback example 6; variable arguments: Callback example 6 variable arguments.


File: python.info,  Node: Defining a callback option,  Next: How callbacks are called,  Up: Option Callbacks

5.37.1.29 Defining a callback option
....................................

As always, the easiest way to define a callback option is by using the
*note OptionParser.add_option(): 1fb2. method.  Apart from *note action:
39b8, the only option attribute you must specify is ‘callback’, the
function to call:

     parser.add_option("-c", action="callback", callback=my_callback)

‘callback’ is a function (or other callable object), so you must have
already defined ‘my_callback()’ when you create this callback option.
In this simple case, *note optparse: c3. doesn’t even know if ‘-c’ takes
any arguments, which usually means that the option takes no
arguments—the mere presence of ‘-c’ on the command-line is all it needs
to know.  In some circumstances, though, you might want your callback to
consume an arbitrary number of command-line arguments.  This is where
writing callbacks gets tricky; it’s covered later in this section.

*note optparse: c3. always passes four particular arguments to your
callback, and it will only pass additional arguments if you specify them
via *note callback_args: 39e9. and *note callback_kwargs: 39ea.  Thus,
the minimal callback function signature is:

     def my_callback(option, opt, value, parser):

The four arguments to a callback are described below.

There are several other option attributes that you can supply when you
define a callback option:

*note type: 39b9.

     has its usual meaning: as with the ‘"store"’ or ‘"append"’ actions,
     it instructs *note optparse: c3. to consume one argument and
     convert it to *note type: 39b9.  Rather than storing the converted
     value(s) anywhere, though, *note optparse: c3. passes it to your
     callback function.

*note nargs: 39e5.

     also has its usual meaning: if it is supplied and > 1, *note
     optparse: c3. will consume *note nargs: 39e5. arguments, each of
     which must be convertible to *note type: 39b9.  It then passes a
     tuple of converted values to your callback.

*note callback_args: 39e9.

     a tuple of extra positional arguments to pass to the callback

*note callback_kwargs: 39ea.

     a dictionary of extra keyword arguments to pass to the callback


File: python.info,  Node: How callbacks are called,  Next: Raising errors in a callback,  Prev: Defining a callback option,  Up: Option Callbacks

5.37.1.30 How callbacks are called
..................................

All callbacks are called as follows:

     func(option, opt_str, value, parser, *args, **kwargs)

where

‘option’

     is the Option instance that’s calling the callback

‘opt_str’

     is the option string seen on the command-line that’s triggering the
     callback.  (If an abbreviated long option was used, ‘opt_str’ will
     be the full, canonical option string—e.g.  if the user puts ‘--foo’
     on the command-line as an abbreviation for ‘--foobar’, then
     ‘opt_str’ will be ‘"--foobar"’.)

‘value’

     is the argument to this option seen on the command-line.  *note
     optparse: c3. will only expect an argument if *note type: 39b9. is
     set; the type of ‘value’ will be the type implied by the option’s
     type.  If *note type: 39b9. for this option is ‘None’ (no argument
     expected), then ‘value’ will be ‘None’.  If *note nargs: 39e5. > 1,
     ‘value’ will be a tuple of values of the appropriate type.

‘parser’

     is the OptionParser instance driving the whole thing, mainly useful
     because you can access some other interesting data through its
     instance attributes:

     ‘parser.largs’

          the current list of leftover arguments, ie.  arguments that
          have been consumed but are neither options nor option
          arguments.  Feel free to modify ‘parser.largs’, e.g.  by
          adding more arguments to it.  (This list will become ‘args’,
          the second return value of ‘parse_args()’.)

     ‘parser.rargs’

          the current list of remaining arguments, ie.  with ‘opt_str’
          and ‘value’ (if applicable) removed, and only the arguments
          following them still there.  Feel free to modify
          ‘parser.rargs’, e.g.  by consuming more arguments.

     ‘parser.values’

          the object where option values are by default stored (an
          instance of optparse.OptionValues).  This lets callbacks use
          the same mechanism as the rest of *note optparse: c3. for
          storing option values; you don’t need to mess around with
          globals or closures.  You can also access or modify the
          value(s) of any options already encountered on the
          command-line.

‘args’

     is a tuple of arbitrary positional arguments supplied via the *note
     callback_args: 39e9. option attribute.

‘kwargs’

     is a dictionary of arbitrary keyword arguments supplied via *note
     callback_kwargs: 39ea.


File: python.info,  Node: Raising errors in a callback,  Next: Callback example 1 trivial callback,  Prev: How callbacks are called,  Up: Option Callbacks

5.37.1.31 Raising errors in a callback
......................................

The callback function should raise ‘OptionValueError’ if there are any
problems with the option or its argument(s).  *note optparse: c3.
catches this and terminates the program, printing the error message you
supply to stderr.  Your message should be clear, concise, accurate, and
mention the option at fault.  Otherwise, the user will have a hard time
figuring out what they did wrong.


File: python.info,  Node: Callback example 1 trivial callback,  Next: Callback example 2 check option order,  Prev: Raising errors in a callback,  Up: Option Callbacks

5.37.1.32 Callback example 1: trivial callback
..............................................

Here’s an example of a callback option that takes no arguments, and
simply records that the option was seen:

     def record_foo_seen(option, opt_str, value, parser):     parser.values.saw_foo = True  parser.add_option("--foo", action="callback", callback=record_foo_seen)

Of course, you could do that with the ‘"store_true"’ action.


File: python.info,  Node: Callback example 2 check option order,  Next: Callback example 3 check option order generalized,  Prev: Callback example 1 trivial callback,  Up: Option Callbacks

5.37.1.33 Callback example 2: check option order
................................................

Here’s a slightly more interesting example: record the fact that ‘-a’ is
seen, but blow up if it comes after ‘-b’ in the command-line.

     def check_order(option, opt_str, value, parser):     if parser.values.b:         raise OptionValueError("can't use -a after -b")     parser.values.a = 1 ... parser.add_option("-a", action="callback", callback=check_order) parser.add_option("-b", action="store_true", dest="b")


File: python.info,  Node: Callback example 3 check option order generalized,  Next: Callback example 4 check arbitrary condition,  Prev: Callback example 2 check option order,  Up: Option Callbacks

5.37.1.34 Callback example 3: check option order (generalized)
..............................................................

If you want to re-use this callback for several similar options (set a
flag, but blow up if ‘-b’ has already been seen), it needs a bit of
work: the error message and the flag that it sets must be generalized.

     def check_order(option, opt_str, value, parser):     if parser.values.b:         raise OptionValueError("can't use %s after -b" % opt_str)     setattr(parser.values, option.dest, 1) ... parser.add_option("-a", action="callback", callback=check_order, dest='a') parser.add_option("-b", action="store_true", dest="b") parser.add_option("-c", action="callback", callback=check_order, dest='c')


File: python.info,  Node: Callback example 4 check arbitrary condition,  Next: Callback example 5 fixed arguments,  Prev: Callback example 3 check option order generalized,  Up: Option Callbacks

5.37.1.35 Callback example 4: check arbitrary condition
.......................................................

Of course, you could put any condition in there—you’re not limited to
checking the values of already-defined options.  For example, if you
have options that should not be called when the moon is full, all you
have to do is this:

     def check_moon(option, opt_str, value, parser):     if is_moon_full():         raise OptionValueError("%s option invalid when moon is full"                                % opt_str)     setattr(parser.values, option.dest, 1) ... parser.add_option("--foo",                   action="callback", callback=check_moon, dest="foo")

(The definition of ‘is_moon_full()’ is left as an exercise for the
reader.)


File: python.info,  Node: Callback example 5 fixed arguments,  Next: Callback example 6 variable arguments,  Prev: Callback example 4 check arbitrary condition,  Up: Option Callbacks

5.37.1.36 Callback example 5: fixed arguments
.............................................

Things get slightly more interesting when you define callback options
that take a fixed number of arguments.  Specifying that a callback
option takes arguments is similar to defining a ‘"store"’ or ‘"append"’
option: if you define *note type: 39b9, then the option takes one
argument that must be convertible to that type; if you further define
*note nargs: 39e5, then the option takes *note nargs: 39e5. arguments.

Here’s an example that just emulates the standard ‘"store"’ action:

     def store_value(option, opt_str, value, parser):     setattr(parser.values, option.dest, value) ... parser.add_option("--foo",                   action="callback", callback=store_value,                   type="int", nargs=3, dest="foo")

Note that *note optparse: c3. takes care of consuming 3 arguments and
converting them to integers for you; all you have to do is store them.
(Or whatever; obviously you don’t need a callback for this example.)


File: python.info,  Node: Callback example 6 variable arguments,  Prev: Callback example 5 fixed arguments,  Up: Option Callbacks

5.37.1.37 Callback example 6: variable arguments
................................................

Things get hairy when you want an option to take a variable number of
arguments.  For this case, you must write a callback, as *note optparse:
c3. doesn’t provide any built-in capabilities for it.  And you have to
deal with certain intricacies of conventional Unix command-line parsing
that *note optparse: c3. normally handles for you.  In particular,
callbacks should implement the conventional rules for bare ‘--’ and ‘-’
arguments:

   * either ‘--’ or ‘-’ can be option arguments

   * bare ‘--’ (if not the argument to some option): halt command-line
     processing and discard the ‘--’

   * bare ‘-’ (if not the argument to some option): halt command-line
     processing but keep the ‘-’ (append it to ‘parser.largs’)

If you want an option that takes a variable number of arguments, there
are several subtle, tricky issues to worry about.  The exact
implementation you choose will be based on which trade-offs you’re
willing to make for your application (which is why *note optparse: c3.
doesn’t support this sort of thing directly).

Nevertheless, here’s a stab at a callback for an option with variable
arguments:

     def vararg_callback(option, opt_str, value, parser):     assert value is None     value = []      def floatable(str):         try:             float(str)             return True         except ValueError:             return False      for arg in parser.rargs:         # stop on --foo like options         if arg[:2] == "--" and len(arg) > 2:             break         # stop on -a, but not on -3 or -3.0         if arg[:1] == "-" and len(arg) > 1 and not floatable(arg):             break         value.append(arg)      del parser.rargs[:len(value)]     setattr(parser.values, option.dest, value)  ... parser.add_option("-c", "--callback", dest="vararg_attr",                   action="callback", callback=vararg_callback)


File: python.info,  Node: Extending optparse,  Prev: Option Callbacks,  Up: optparse — Parser for command line options

5.37.1.38 Extending ‘optparse’
..............................

Since the two major controlling factors in how *note optparse: c3.
interprets command-line options are the action and type of each option,
the most likely direction of extension is to add new actions and new
types.

* Menu:

* Adding new types::
* Adding new actions::


File: python.info,  Node: Adding new types,  Next: Adding new actions,  Up: Extending optparse

5.37.1.39 Adding new types
..........................

To add new types, you need to define your own subclass of *note
optparse: c3.’s ‘Option’ class.  This class has a couple of attributes
that define *note optparse: c3.’s types: *note TYPES: 3a13. and *note
TYPE_CHECKER: 3a14.

 -- Attribute: Option.TYPES

     A tuple of type names; in your subclass, simply define a new tuple
     *note TYPES: 3a13. that builds on the standard one.

 -- Attribute: Option.TYPE_CHECKER

     A dictionary mapping type names to type-checking functions.  A
     type-checking function has the following signature:

          def check_mytype(option, opt, value)

     where ‘option’ is an ‘Option’ instance, ‘opt’ is an option string
     (e.g., ‘-f’), and ‘value’ is the string from the command line that
     must be checked and converted to your desired type.
     ‘check_mytype()’ should return an object of the hypothetical type
     ‘mytype’.  The value returned by a type-checking function will wind
     up in the OptionValues instance returned by
     ‘OptionParser.parse_args()’, or be passed to a callback as the
     ‘value’ parameter.

     Your type-checking function should raise ‘OptionValueError’ if it
     encounters any problems.  ‘OptionValueError’ takes a single string
     argument, which is passed as-is to *note OptionParser: 39ad.’s
     ‘error()’ method, which in turn prepends the program name and the
     string ‘"error:"’ and prints everything to stderr before
     terminating the process.

Here’s a silly example that demonstrates adding a ‘"complex"’ option
type to parse Python-style complex numbers on the command line.  (This
is even sillier than it used to be, because *note optparse: c3. 1.3
added built-in support for complex numbers, but never mind.)

First, the necessary imports:

     from copy import copy from optparse import Option, OptionValueError

You need to define your type-checker first, since it’s referred to later
(in the *note TYPE_CHECKER: 3a14. class attribute of your Option
subclass):

     def check_complex(option, opt, value):     try:         return complex(value)     except ValueError:         raise OptionValueError(             "option %s: invalid complex value: %r" % (opt, value))

Finally, the Option subclass:

     class MyOption (Option):     TYPES = Option.TYPES + ("complex",)     TYPE_CHECKER = copy(Option.TYPE_CHECKER)     TYPE_CHECKER["complex"] = check_complex

(If we didn’t make a *note copy(): 26. of *note Option.TYPE_CHECKER:
3a14, we would end up modifying the *note TYPE_CHECKER: 3a14. attribute
of *note optparse: c3.’s Option class.  This being Python, nothing stops
you from doing that except good manners and common sense.)

That’s it!  Now you can write a script that uses the new option type
just like any other *note optparse: c3.-based script, except you have to
instruct your OptionParser to use MyOption instead of Option:

     parser = OptionParser(option_class=MyOption) parser.add_option("-c", type="complex")

Alternately, you can build your own option list and pass it to
OptionParser; if you don’t use ‘add_option()’ in the above way, you
don’t need to tell OptionParser which option class to use:

     option_list = [MyOption("-c", action="store", type="complex", dest="c")] parser = OptionParser(option_list=option_list)


File: python.info,  Node: Adding new actions,  Prev: Adding new types,  Up: Extending optparse

5.37.1.40 Adding new actions
............................

Adding new actions is a bit trickier, because you have to understand
that *note optparse: c3. has a couple of classifications for actions:

“store” actions

     actions that result in *note optparse: c3. storing a value to an
     attribute of the current OptionValues instance; these options
     require a *note dest: 39ba. attribute to be supplied to the Option
     constructor.

“typed” actions

     actions that take a value from the command line and expect it to be
     of a certain type; or rather, a string that can be converted to a
     certain type.  These options require a *note type: 39b9. attribute
     to the Option constructor.

These are overlapping sets: some default “store” actions are ‘"store"’,
‘"store_const"’, ‘"append"’, and ‘"count"’, while the default “typed”
actions are ‘"store"’, ‘"append"’, and ‘"callback"’.

When you add an action, you need to categorize it by listing it in at
least one of the following class attributes of Option (all are lists of
strings):

 -- Attribute: Option.ACTIONS

     All actions must be listed in ACTIONS.

 -- Attribute: Option.STORE_ACTIONS

     “store” actions are additionally listed here.

 -- Attribute: Option.TYPED_ACTIONS

     “typed” actions are additionally listed here.

 -- Attribute: Option.ALWAYS_TYPED_ACTIONS

     Actions that always take a type (i.e.  whose options always take a
     value) are additionally listed here.  The only effect of this is
     that *note optparse: c3. assigns the default type, ‘"string"’, to
     options with no explicit type whose action is listed in *note
     ALWAYS_TYPED_ACTIONS: 3a1a.

In order to actually implement your new action, you must override
Option’s ‘take_action()’ method and add a case that recognizes your
action.

For example, let’s add an ‘"extend"’ action.  This is similar to the
standard ‘"append"’ action, but instead of taking a single value from
the command-line and appending it to an existing list, ‘"extend"’ will
take multiple values in a single comma-delimited string, and extend an
existing list with them.  That is, if ‘--names’ is an ‘"extend"’ option
of type ‘"string"’, the command line

     --names=foo,bar --names blah --names ding,dong

would result in a list

     ["foo", "bar", "blah", "ding", "dong"]

Again we define a subclass of Option:

     class MyOption(Option):      ACTIONS = Option.ACTIONS + ("extend",)     STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)     TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",)     ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",)      def take_action(self, action, dest, opt, value, values, parser):         if action == "extend":             lvalue = value.split(",")             values.ensure_value(dest, []).extend(lvalue)         else:             Option.take_action(                 self, action, dest, opt, value, values, parser)

Features of note:

   * ‘"extend"’ both expects a value on the command-line and stores that
     value somewhere, so it goes in both *note STORE_ACTIONS: 3a18. and
     *note TYPED_ACTIONS: 3a19.

   * to ensure that *note optparse: c3. assigns the default type of
     ‘"string"’ to ‘"extend"’ actions, we put the ‘"extend"’ action in
     *note ALWAYS_TYPED_ACTIONS: 3a1a. as well.

   * ‘MyOption.take_action()’ implements just this one new action, and
     passes control back to ‘Option.take_action()’ for the standard
     *note optparse: c3. actions.

   * ‘values’ is an instance of the optparse_parser.Values class, which
     provides the very useful ‘ensure_value()’ method.  ‘ensure_value()’
     is essentially *note getattr(): 43d. with a safety valve; it is
     called as

          values.ensure_value(attr, value)

     If the ‘attr’ attribute of ‘values’ doesn’t exist or is ‘None’,
     then ensure_value() first sets it to ‘value’, and then returns
     ‘value.  This is very handy for actions like ‘"extend"’,
     ‘"append"’, and ‘"count"’, all of which accumulate data in a
     variable and expect that variable to be of a certain type (a list
     for the first two, an integer for the latter).  Using
     ‘ensure_value()’ means that scripts using your action don’t have to
     worry about setting a default value for the option destinations in
     question; they can just leave the default as ‘None’ and
     ‘ensure_value()’ will take care of getting it right when it’s
     needed.


File: python.info,  Node: imp — Access the import internals,  Prev: optparse — Parser for command line options,  Up: Superseded Modules

5.37.2 ‘imp’ — Access the import internals
------------------------------------------

`Source code:' Lib/imp.py(1)

Deprecated since version 3.4: The *note imp: 9a. package is pending
deprecation in favor of *note importlib: 9b.

__________________________________________________________________

This module provides an interface to the mechanisms used to implement
the *note import: c10. statement.  It defines the following constants
and functions:

 -- Function: imp.get_magic ()

     Return the magic string value used to recognize byte-compiled code
     files (‘.pyc’ files).  (This value may be different for each Python
     version.)

     Deprecated since version 3.4: Use *note
     importlib.util.MAGIC_NUMBER: 856. instead.

 -- Function: imp.get_suffixes ()

     Return a list of 3-element tuples, each describing a particular
     type of module.  Each triple has the form ‘(suffix, mode, type)’,
     where `suffix' is a string to be appended to the module name to
     form the filename to search for, `mode' is the mode string to pass
     to the built-in *note open(): 4e5. function to open the file (this
     can be ‘'r'’ for text files or ‘'rb'’ for binary files), and `type'
     is the file type, which has one of the values *note PY_SOURCE:
     3a1e, *note PY_COMPILED: 3a1f, or *note C_EXTENSION: 3a20,
     described below.

     Deprecated since version 3.3: Use the constants defined on *note
     importlib.machinery: 9d. instead.

 -- Function: imp.find_module (name[, path])

     Try to find the module `name'.  If `path' is omitted or ‘None’, the
     list of directory names given by ‘sys.path’ is searched, but first
     a few special places are searched: the function tries to find a
     built-in module with the given name (*note C_BUILTIN: 3a22.), then
     a frozen module (*note PY_FROZEN: 3a23.), and on some systems some
     other places are looked in as well (on Windows, it looks in the
     registry which may point to a specific file).

     Otherwise, `path' must be a list of directory names; each directory
     is searched for files with any of the suffixes returned by *note
     get_suffixes(): 3a1d. above.  Invalid names in the list are
     silently ignored (but all list items must be strings).

     If search is successful, the return value is a 3-element tuple
     ‘(file, pathname, description)’:

     `file' is an open *note file object: b35. positioned at the
     beginning, `pathname' is the pathname of the file found, and
     `description' is a 3-element tuple as contained in the list
     returned by *note get_suffixes(): 3a1d. describing the kind of
     module found.

     If the module is built-in or frozen then `file' and `pathname' are
     both ‘None’ and the `description' tuple contains empty strings for
     its suffix and mode; the module type is indicated as given in
     parentheses above.  If the search is unsuccessful, *note
     ImportError: 329. is raised.  Other exceptions indicate problems
     with the arguments or environment.

     If the module is a package, `file' is ‘None’, `pathname' is the
     package path and the last item in the `description' tuple is *note
     PKG_DIRECTORY: 3a24.

     This function does not handle hierarchical module names (names
     containing dots).  In order to find `P.M', that is, submodule `M'
     of package `P', use *note find_module(): 3a21. and *note
     load_module(): 3a25. to find and load package `P', and then use
     *note find_module(): 3a21. with the `path' argument set to
     ‘P.__path__’.  When `P' itself has a dotted name, apply this recipe
     recursively.

     Deprecated since version 3.3: Use *note importlib.util.find_spec():
     92c. instead unless Python 3.3 compatibility is required, in which
     case use *note importlib.find_loader(): 92b.  For example usage of
     the former case, see the *note Examples: 36da. section of the *note
     importlib: 9b. documentation.

 -- Function: imp.load_module (name, file, pathname, description)

     Load a module that was previously found by *note find_module():
     3a21. (or by an otherwise conducted search yielding compatible
     results).  This function does more than importing the module: if
     the module was already imported, it will reload the module!  The
     `name' argument indicates the full module name (including the
     package name, if this is a submodule of a package).  The `file'
     argument is an open file, and `pathname' is the corresponding file
     name; these can be ‘None’ and ‘''’, respectively, when the module
     is a package or not being loaded from a file.  The `description'
     argument is a tuple, as would be returned by *note get_suffixes():
     3a1d, describing what kind of module must be loaded.

     If the load is successful, the return value is the module object;
     otherwise, an exception (usually *note ImportError: 329.) is
     raised.

     `Important:' the caller is responsible for closing the `file'
     argument, if it was not ‘None’, even when an exception is raised.
     This is best done using a *note try: d65. … *note finally: 182.
     statement.

     Deprecated since version 3.3: If previously used in conjunction
     with *note imp.find_module(): 3a21. then consider using *note
     importlib.import_module(): b06, otherwise use the loader returned
     by the replacement you chose for *note imp.find_module(): 3a21.  If
     you called *note imp.load_module(): 3a25. and related functions
     directly with file path arguments then use a combination of *note
     importlib.util.spec_from_file_location(): 54e. and *note
     importlib.util.module_from_spec(): 6e4.  See the *note Examples:
     36da. section of the *note importlib: 9b. documentation for details
     of the various approaches.

 -- Function: imp.new_module (name)

     Return a new empty module object called `name'.  This object is
     `not' inserted in ‘sys.modules’.

     Deprecated since version 3.4: Use *note
     importlib.util.module_from_spec(): 6e4. instead.

 -- Function: imp.reload (module)

     Reload a previously imported `module'.  The argument must be a
     module object, so it must have been successfully imported before.
     This is useful if you have edited the module source file using an
     external editor and want to try out the new version without leaving
     the Python interpreter.  The return value is the module object (the
     same as the `module' argument).

     When ‘reload(module)’ is executed:

        * Python modules’ code is recompiled and the module-level code
          reexecuted, defining a new set of objects which are bound to
          names in the module’s dictionary.  The ‘init’ function of
          extension modules is not called a second time.

        * As with all other objects in Python the old objects are only
          reclaimed after their reference counts drop to zero.

        * The names in the module namespace are updated to point to any
          new or changed objects.

        * Other references to the old objects (such as names external to
          the module) are not rebound to refer to the new objects and
          must be updated in each namespace where they occur if that is
          desired.

     There are a number of other caveats:

     When a module is reloaded, its dictionary (containing the module’s
     global variables) is retained.  Redefinitions of names will
     override the old definitions, so this is generally not a problem.
     If the new version of a module does not define a name that was
     defined by the old version, the old definition remains.  This
     feature can be used to the module’s advantage if it maintains a
     global table or cache of objects — with a *note try: d65. statement
     it can test for the table’s presence and skip its initialization if
     desired:

          try:     cache except NameError:     cache = {}

     It is legal though generally not very useful to reload built-in or
     dynamically loaded modules, except for *note sys: fd, *note
     __main__: 1. and *note builtins: 13.  In many cases, however,
     extension modules are not designed to be initialized more than
     once, and may fail in arbitrary ways when reloaded.

     If a module imports objects from another module using *note from:
     c38. … *note import: c10. …, calling *note reload(): c63. for the
     other module does not redefine the objects imported from it — one
     way around this is to re-execute the ‘from’ statement, another is
     to use ‘import’ and qualified names (`module'.*name*) instead.

     If a module instantiates instances of a class, reloading the module
     that defines the class does not affect the method definitions of
     the instances — they continue to use the old class definition.  The
     same is true for derived classes.

     Changed in version 3.3: Relies on both ‘__name__’ and ‘__loader__’
     being defined on the module being reloaded instead of just
     ‘__name__’.

     Deprecated since version 3.4: Use *note importlib.reload(): 38e.
     instead.

The following functions are conveniences for handling PEP 3147(2)
byte-compiled file paths.

New in version 3.2.

 -- Function: imp.cache_from_source (path, debug_override=None)

     Return the PEP 3147(3) path to the byte-compiled file associated
     with the source `path'.  For example, if `path' is
     ‘/foo/bar/baz.py’ the return value would be
     ‘/foo/bar/__pycache__/baz.cpython-32.pyc’ for Python 3.2.  The
     ‘cpython-32’ string comes from the current magic tag (see *note
     get_tag(): 3a28.; if ‘sys.implementation.cache_tag’ is not defined
     then *note NotImplementedError: 603. will be raised).  By passing
     in ‘True’ or ‘False’ for `debug_override' you can override the
     system’s value for ‘__debug__’, leading to optimized bytecode.

     `path' need not exist.

     Changed in version 3.3: If ‘sys.implementation.cache_tag’ is
     ‘None’, then *note NotImplementedError: 603. is raised.

     Deprecated since version 3.4: Use *note
     importlib.util.cache_from_source(): 54c. instead.

     Changed in version 3.5: The `debug_override' parameter no longer
     creates a ‘.pyo’ file.

 -- Function: imp.source_from_cache (path)

     Given the `path' to a PEP 3147(4) file name, return the associated
     source code file path.  For example, if `path' is
     ‘/foo/bar/__pycache__/baz.cpython-32.pyc’ the returned path would
     be ‘/foo/bar/baz.py’.  `path' need not exist, however if it does
     not conform to PEP 3147(5) format, a *note ValueError: 1f9. is
     raised.  If ‘sys.implementation.cache_tag’ is not defined, *note
     NotImplementedError: 603. is raised.

     Changed in version 3.3: Raise *note NotImplementedError: 603. when
     ‘sys.implementation.cache_tag’ is not defined.

     Deprecated since version 3.4: Use *note
     importlib.util.source_from_cache(): 54d. instead.

 -- Function: imp.get_tag ()

     Return the PEP 3147(6) magic tag string matching this version of
     Python’s magic number, as returned by *note get_magic(): 857.

     Deprecated since version 3.4: Use ‘sys.implementation.cache_tag’
     directly starting in Python 3.3.

The following functions help interact with the import system’s internal
locking mechanism.  Locking semantics of imports are an implementation
detail which may vary from release to release.  However, Python ensures
that circular imports work without any deadlocks.

 -- Function: imp.lock_held ()

     Return ‘True’ if the global import lock is currently held, else
     ‘False’.  On platforms without threads, always return ‘False’.

     On platforms with threads, a thread executing an import first holds
     a global import lock, then sets up a per-module lock for the rest
     of the import.  This blocks other threads from importing the same
     module until the original import completes, preventing other
     threads from seeing incomplete module objects constructed by the
     original thread.  An exception is made for circular imports, which
     by construction have to expose an incomplete module object at some
     point.

     Changed in version 3.3: The locking scheme has changed to
     per-module locks for the most part.  A global import lock is kept
     for some critical tasks, such as initializing the per-module locks.

     Deprecated since version 3.4.

 -- Function: imp.acquire_lock ()

     Acquire the interpreter’s global import lock for the current
     thread.  This lock should be used by import hooks to ensure
     thread-safety when importing modules.

     Once a thread has acquired the import lock, the same thread may
     acquire it again without blocking; the thread must release it once
     for each time it has acquired it.

     On platforms without threads, this function does nothing.

     Changed in version 3.3: The locking scheme has changed to
     per-module locks for the most part.  A global import lock is kept
     for some critical tasks, such as initializing the per-module locks.

     Deprecated since version 3.4.

 -- Function: imp.release_lock ()

     Release the interpreter’s global import lock.  On platforms without
     threads, this function does nothing.

     Changed in version 3.3: The locking scheme has changed to
     per-module locks for the most part.  A global import lock is kept
     for some critical tasks, such as initializing the per-module locks.

     Deprecated since version 3.4.

The following constants with integer values, defined in this module, are
used to indicate the search result of *note find_module(): 3a21.

 -- Data: imp.PY_SOURCE

     The module was found as a source file.

     Deprecated since version 3.3.

 -- Data: imp.PY_COMPILED

     The module was found as a compiled code object file.

     Deprecated since version 3.3.

 -- Data: imp.C_EXTENSION

     The module was found as dynamically loadable shared library.

     Deprecated since version 3.3.

 -- Data: imp.PKG_DIRECTORY

     The module was found as a package directory.

     Deprecated since version 3.3.

 -- Data: imp.C_BUILTIN

     The module was found as a built-in module.

     Deprecated since version 3.3.

 -- Data: imp.PY_FROZEN

     The module was found as a frozen module.

     Deprecated since version 3.3.

 -- Class: imp.NullImporter (path_string)

     The *note NullImporter: 9af. type is a PEP 302(7) import hook that
     handles non-directory path strings by failing to find any modules.
     Calling this type with an existing directory or empty string raises
     *note ImportError: 329.  Otherwise, a *note NullImporter: 9af.
     instance is returned.

     Instances have only one method:

      -- Method: find_module (fullname[, path])

          This method always returns ‘None’, indicating that the
          requested module could not be found.

     Changed in version 3.3: ‘None’ is inserted into
     ‘sys.path_importer_cache’ instead of an instance of *note
     NullImporter: 9af.

     Deprecated since version 3.4: Insert ‘None’ into
     ‘sys.path_importer_cache’ instead.

* Menu:

* Examples: Examples<33>.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Lib/imp.py

   (2) https://www.python.org/dev/peps/pep-3147

   (3) https://www.python.org/dev/peps/pep-3147

   (4) https://www.python.org/dev/peps/pep-3147

   (5) https://www.python.org/dev/peps/pep-3147

   (6) https://www.python.org/dev/peps/pep-3147

   (7) https://www.python.org/dev/peps/pep-0302


File: python.info,  Node: Examples<33>,  Up: imp — Access the import internals

5.37.2.1 Examples
.................

The following function emulates what was the standard import statement
up to Python 1.4 (no hierarchical module names).  (This `implementation'
wouldn’t work in that version, since *note find_module(): 3a21. has been
extended and *note load_module(): 3a25. has been added in 1.4.)

     import imp import sys  def __import__(name, globals=None, locals=None, fromlist=None):     # Fast path: see if the module has already been imported.     try:         return sys.modules[name]     except KeyError:         pass      # If any of the following calls raises an exception,     # there's a problem we can't handle -- let the caller handle it.      fp, pathname, description = imp.find_module(name)      try:         return imp.load_module(name, fp, pathname, description)     finally:         # Since we may exit via an exception, close fp explicitly.         if fp:             fp.close()


File: python.info,  Node: Undocumented Modules,  Prev: Superseded Modules,  Up: The Python Standard Library

5.38 Undocumented Modules
=========================

Here’s a quick listing of modules that are currently undocumented, but
that should be documented.  Feel free to contribute documentation for
them!  (Send via email to <docs@python.org>.)

The idea and original contents for this chapter were taken from a
posting by Fredrik Lundh; the specific contents of this chapter have
been substantially revised.

* Menu:

* Platform specific modules::


File: python.info,  Node: Platform specific modules,  Up: Undocumented Modules

5.38.1 Platform specific modules
--------------------------------

These modules are used to implement the *note os.path: c5. module, and
are not documented beyond this mention.  There’s little need to document
these.

‘ntpath’

     — Implementation of *note os.path: c5. on Win32 and Win64
     platforms.

‘posixpath’

     — Implementation of *note os.path: c5. on POSIX.


File: python.info,  Node: Extending and Embedding the Python Interpreter,  Next: Python/C API Reference Manual,  Prev: The Python Standard Library,  Up: Top

6 Extending and Embedding the Python Interpreter
************************************************

This document describes how to write modules in C or C++ to extend the
Python interpreter with new modules.  Those modules can not only define
new functions but also new object types and their methods.  The document
also describes how to embed the Python interpreter in another
application, for use as an extension language.  Finally, it shows how to
compile and link extension modules so that they can be loaded
dynamically (at run time) into the interpreter, if the underlying
operating system supports this feature.

This document assumes basic knowledge about Python.  For an informal
introduction to the language, see *note The Python Tutorial: 1134.
*note The Python Language Reference: 1136. gives a more formal
definition of the language.  *note The Python Standard Library: 1135.
documents the existing object types, functions and modules (both
built-in and written in Python) that give the language its wide
application range.

For a detailed description of the whole Python/C API, see the separate
*note Python/C API Reference Manual: 1138.

* Menu:

* Recommended third party tools::
* Creating extensions without third party tools::
* Embedding the CPython runtime in a larger application::


File: python.info,  Node: Recommended third party tools,  Next: Creating extensions without third party tools,  Up: Extending and Embedding the Python Interpreter

6.1 Recommended third party tools
=================================

This guide only covers the basic tools for creating extensions provided
as part of this version of CPython.  Third party tools like Cython(1),
cffi(2), SWIG(3) and Numba(4) offer both simpler and more sophisticated
approaches to creating C and C++ extensions for Python.

See also
........

Python Packaging User Guide: Binary Extensions(5)

     The Python Packaging User Guide not only covers several available
     tools that simplify the creation of binary extensions, but also
     discusses the various reasons why creating an extension module may
     be desirable in the first place.

   ---------- Footnotes ----------

   (1) http://cython.org/

   (2) https://cffi.readthedocs.io

   (3) http://www.swig.org

   (4) https://numba.pydata.org/

   (5) https://packaging.python.org/guides/packaging-binary-extensions/


File: python.info,  Node: Creating extensions without third party tools,  Next: Embedding the CPython runtime in a larger application,  Prev: Recommended third party tools,  Up: Extending and Embedding the Python Interpreter

6.2 Creating extensions without third party tools
=================================================

This section of the guide covers creating C and C++ extensions without
assistance from third party tools.  It is intended primarily for
creators of those tools, rather than being a recommended way to create
your own C extensions.

* Menu:

* Extending Python with C or C++::
* Defining Extension Types; Tutorial: Defining Extension Types Tutorial.
* Defining Extension Types; Assorted Topics: Defining Extension Types Assorted Topics.
* Building C and C++ Extensions::
* Building C and C++ Extensions on Windows::


File: python.info,  Node: Extending Python with C or C++,  Next: Defining Extension Types Tutorial,  Up: Creating extensions without third party tools

6.2.1 Extending Python with C or C++
------------------------------------

It is quite easy to add new built-in modules to Python, if you know how
to program in C. Such `extension modules' can do two things that can’t
be done directly in Python: they can implement new built-in object
types, and they can call C library functions and system calls.

To support extensions, the Python API (Application Programmers
Interface) defines a set of functions, macros and variables that provide
access to most aspects of the Python run-time system.  The Python API is
incorporated in a C source file by including the header ‘"Python.h"’.

The compilation of an extension module depends on its intended use as
well as on your system setup; details are given in later chapters.

     Note: The C extension interface is specific to CPython, and
     extension modules do not work on other Python implementations.  In
     many cases, it is possible to avoid writing C extensions and
     preserve portability to other implementations.  For example, if
     your use case is calling C library functions or system calls, you
     should consider using the *note ctypes: 2b. module or the cffi(1)
     library rather than writing custom C code.  These modules let you
     write Python code to interface with C code and are more portable
     between implementations of Python than writing and compiling a C
     extension module.

* Menu:

* A Simple Example::
* Intermezzo; Errors and Exceptions: Intermezzo Errors and Exceptions.
* Back to the Example::
* The Module’s Method Table and Initialization Function::
* Compilation and Linkage::
* Calling Python Functions from C::
* Extracting Parameters in Extension Functions::
* Keyword Parameters for Extension Functions::
* Building Arbitrary Values::
* Reference Counts::
* Writing Extensions in C++::
* Providing a C API for an Extension Module::

   ---------- Footnotes ----------

   (1) https://cffi.readthedocs.io/


File: python.info,  Node: A Simple Example,  Next: Intermezzo Errors and Exceptions,  Up: Extending Python with C or C++

6.2.1.1 A Simple Example
........................

Let’s create an extension module called ‘spam’ (the favorite food of
Monty Python fans…) and let’s say we want to create a Python interface
to the C library function ‘system()’ (1).  This function takes a
null-terminated character string as argument and returns an integer.  We
want this function to be callable from Python as follows:

     >>> import spam >>> status = spam.system("ls -l")

Begin by creating a file ‘spammodule.c’.  (Historically, if a module is
called ‘spam’, the C file containing its implementation is called
‘spammodule.c’; if the module name is very long, like ‘spammify’, the
module name can be just ‘spammify.c’.)

The first two lines of our file can be:

     #define PY_SSIZE_T_CLEAN #include <Python.h>

which pulls in the Python API (you can add a comment describing the
purpose of the module and a copyright notice if you like).

     Note: Since Python may define some pre-processor definitions which
     affect the standard headers on some systems, you `must' include
     ‘Python.h’ before any standard headers are included.

     It is recommended to always define ‘PY_SSIZE_T_CLEAN’ before
     including ‘Python.h’.  See *note Extracting Parameters in Extension
     Functions: 3a3d. for a description of this macro.

All user-visible symbols defined by ‘Python.h’ have a prefix of ‘Py’ or
‘PY’, except those defined in standard header files.  For convenience,
and since they are used extensively by the Python interpreter,
‘"Python.h"’ includes a few standard header files: ‘<stdio.h>’,
‘<string.h>’, ‘<errno.h>’, and ‘<stdlib.h>’.  If the latter header file
does not exist on your system, it declares the functions ‘malloc()’,
‘free()’ and ‘realloc()’ directly.

The next thing we add to our module file is the C function that will be
called when the Python expression ‘spam.system(string)’ is evaluated
(we’ll see shortly how it ends up being called):

     static PyObject * spam_system(PyObject *self, PyObject *args) {     const char *command;     int sts;      if (!PyArg_ParseTuple(args, "s", &command))         return NULL;     sts = system(command);     return PyLong_FromLong(sts); }

There is a straightforward translation from the argument list in Python
(for example, the single expression ‘"ls -l"’) to the arguments passed
to the C function.  The C function always has two arguments,
conventionally named `self' and `args'.

The `self' argument points to the module object for module-level
functions; for a method it would point to the object instance.

The `args' argument will be a pointer to a Python tuple object
containing the arguments.  Each item of the tuple corresponds to an
argument in the call’s argument list.  The arguments are Python objects
— in order to do anything with them in our C function we have to convert
them to C values.  The function *note PyArg_ParseTuple(): 268. in the
Python API checks the argument types and converts them to C values.  It
uses a template string to determine the required types of the arguments
as well as the types of the C variables into which to store the
converted values.  More about this later.

*note PyArg_ParseTuple(): 268. returns true (nonzero) if all arguments
have the right type and its components have been stored in the variables
whose addresses are passed.  It returns false (zero) if an invalid
argument list was passed.  In the latter case it also raises an
appropriate exception so the calling function can return ‘NULL’
immediately (as we saw in the example).

   ---------- Footnotes ----------

   (1) (1) An interface for this function already exists in the standard
module *note os: c4. — it was chosen as a simple and straightforward
example.


File: python.info,  Node: Intermezzo Errors and Exceptions,  Next: Back to the Example,  Prev: A Simple Example,  Up: Extending Python with C or C++

6.2.1.2 Intermezzo: Errors and Exceptions
.........................................

An important convention throughout the Python interpreter is the
following: when a function fails, it should set an exception condition
and return an error value (usually a ‘NULL’ pointer).  Exceptions are
stored in a static global variable inside the interpreter; if this
variable is ‘NULL’ no exception has occurred.  A second global variable
stores the “associated value” of the exception (the second argument to
*note raise: c35.).  A third variable contains the stack traceback in
case the error originated in Python code.  These three variables are the
C equivalents of the result in Python of *note sys.exc_info(): c52. (see
the section on module *note sys: fd. in the Python Library Reference).
It is important to know about them to understand how errors are passed
around.

The Python API defines a number of functions to set various types of
exceptions.

The most common one is *note PyErr_SetString(): 3a40.  Its arguments are
an exception object and a C string.  The exception object is usually a
predefined object like ‘PyExc_ZeroDivisionError’.  The C string
indicates the cause of the error and is converted to a Python string
object and stored as the “associated value” of the exception.

Another useful function is *note PyErr_SetFromErrno(): 3a41, which only
takes an exception argument and constructs the associated value by
inspection of the global variable ‘errno’.  The most general function is
*note PyErr_SetObject(): 3a42, which takes two object arguments, the
exception and its associated value.  You don’t need to *note
Py_INCREF(): 263. the objects passed to any of these functions.

You can test non-destructively whether an exception has been set with
*note PyErr_Occurred(): 3a43.  This returns the current exception
object, or ‘NULL’ if no exception has occurred.  You normally don’t need
to call *note PyErr_Occurred(): 3a43. to see whether an error occurred
in a function call, since you should be able to tell from the return
value.

When a function `f' that calls another function `g' detects that the
latter fails, `f' should itself return an error value (usually ‘NULL’ or
‘-1’).  It should `not' call one of the ‘PyErr_*()’ functions — one has
already been called by `g'.  `f'’s caller is then supposed to also
return an error indication to `its' caller, again `without' calling
‘PyErr_*()’, and so on — the most detailed cause of the error was
already reported by the function that first detected it.  Once the error
reaches the Python interpreter’s main loop, this aborts the currently
executing Python code and tries to find an exception handler specified
by the Python programmer.

(There are situations where a module can actually give a more detailed
error message by calling another ‘PyErr_*()’ function, and in such cases
it is fine to do so.  As a general rule, however, this is not necessary,
and can cause information about the cause of the error to be lost: most
operations can fail for a variety of reasons.)

To ignore an exception set by a function call that failed, the exception
condition must be cleared explicitly by calling *note PyErr_Clear():
95f.  The only time C code should call *note PyErr_Clear(): 95f. is if
it doesn’t want to pass the error on to the interpreter but wants to
handle it completely by itself (possibly by trying something else, or
pretending nothing went wrong).

Every failing ‘malloc()’ call must be turned into an exception — the
direct caller of ‘malloc()’ (or ‘realloc()’) must call *note
PyErr_NoMemory(): 3a44. and return a failure indicator itself.  All the
object-creating functions (for example, *note PyLong_FromLong(): 3a45.)
already do this, so this note is only relevant to those who call
‘malloc()’ directly.

Also note that, with the important exception of *note
PyArg_ParseTuple(): 268. and friends, functions that return an integer
status usually return a positive value or zero for success and ‘-1’ for
failure, like Unix system calls.

Finally, be careful to clean up garbage (by making *note Py_XDECREF():
266. or *note Py_DECREF(): 264. calls for objects you have already
created) when you return an error indicator!

The choice of which exception to raise is entirely yours.  There are
predeclared C objects corresponding to all built-in Python exceptions,
such as ‘PyExc_ZeroDivisionError’, which you can use directly.  Of
course, you should choose exceptions wisely — don’t use
‘PyExc_TypeError’ to mean that a file couldn’t be opened (that should
probably be ‘PyExc_IOError’).  If something’s wrong with the argument
list, the *note PyArg_ParseTuple(): 268. function usually raises
‘PyExc_TypeError’.  If you have an argument whose value must be in a
particular range or must satisfy other conditions, ‘PyExc_ValueError’ is
appropriate.

You can also define a new exception that is unique to your module.  For
this, you usually declare a static object variable at the beginning of
your file:

     static PyObject *SpamError;

and initialize it in your module’s initialization function
(‘PyInit_spam()’) with an exception object:

     PyMODINIT_FUNC PyInit_spam(void) {     PyObject *m;      m = PyModule_Create(&spammodule);     if (m == NULL)         return NULL;      SpamError = PyErr_NewException("spam.error", NULL, NULL);     Py_XINCREF(SpamError);     if (PyModule_AddObject(m, "error", SpamError) < 0) {         Py_XDECREF(SpamError);         Py_CLEAR(SpamError);         Py_DECREF(m);         return NULL;     }      return m; }

Note that the Python name for the exception object is ‘spam.error’.  The
*note PyErr_NewException(): bf3. function may create a class with the
base class being *note Exception: 1a8. (unless another class is passed
in instead of ‘NULL’), described in *note Built-in Exceptions: 11e7.

Note also that the ‘SpamError’ variable retains a reference to the newly
created exception class; this is intentional!  Since the exception could
be removed from the module by external code, an owned reference to the
class is needed to ensure that it will not be discarded, causing
‘SpamError’ to become a dangling pointer.  Should it become a dangling
pointer, C code which raises the exception could cause a core dump or
other unintended side effects.

We discuss the use of ‘PyMODINIT_FUNC’ as a function return type later
in this sample.

The ‘spam.error’ exception can be raised in your extension module using
a call to *note PyErr_SetString(): 3a40. as shown below:

     static PyObject * spam_system(PyObject *self, PyObject *args) {     const char *command;     int sts;      if (!PyArg_ParseTuple(args, "s", &command))         return NULL;     sts = system(command);     if (sts < 0) {         PyErr_SetString(SpamError, "System command failed");         return NULL;     }     return PyLong_FromLong(sts); }


File: python.info,  Node: Back to the Example,  Next: The Module’s Method Table and Initialization Function,  Prev: Intermezzo Errors and Exceptions,  Up: Extending Python with C or C++

6.2.1.3 Back to the Example
...........................

Going back to our example function, you should now be able to understand
this statement:

     if (!PyArg_ParseTuple(args, "s", &command))     return NULL;

It returns ‘NULL’ (the error indicator for functions returning object
pointers) if an error is detected in the argument list, relying on the
exception set by *note PyArg_ParseTuple(): 268.  Otherwise the string
value of the argument has been copied to the local variable ‘command’.
This is a pointer assignment and you are not supposed to modify the
string to which it points (so in Standard C, the variable ‘command’
should properly be declared as ‘const char *command’).

The next statement is a call to the Unix function ‘system()’, passing it
the string we just got from *note PyArg_ParseTuple(): 268.:

     sts = system(command);

Our ‘spam.system()’ function must return the value of ‘sts’ as a Python
object.  This is done using the function *note PyLong_FromLong(): 3a45.

     return PyLong_FromLong(sts);

In this case, it will return an integer object.  (Yes, even integers are
objects on the heap in Python!)

If you have a C function that returns no useful argument (a function
returning ‘void’), the corresponding Python function must return ‘None’.
You need this idiom to do so (which is implemented by the *note
Py_RETURN_NONE: dc9. macro):

     Py_INCREF(Py_None); return Py_None;

*note Py_None: 3a48. is the C name for the special Python object ‘None’.
It is a genuine Python object rather than a ‘NULL’ pointer, which means
“error” in most contexts, as we have seen.


File: python.info,  Node: The Module’s Method Table and Initialization Function,  Next: Compilation and Linkage,  Prev: Back to the Example,  Up: Extending Python with C or C++

6.2.1.4 The Module’s Method Table and Initialization Function
.............................................................

I promised to show how ‘spam_system()’ is called from Python programs.
First, we need to list its name and address in a “method table”:

     static PyMethodDef SpamMethods[] = {     ...     {"system",  spam_system, METH_VARARGS,      "Execute a shell command."},     ...     {NULL, NULL, 0, NULL}        /* Sentinel */ };

Note the third entry (‘METH_VARARGS’).  This is a flag telling the
interpreter the calling convention to be used for the C function.  It
should normally always be ‘METH_VARARGS’ or ‘METH_VARARGS |
METH_KEYWORDS’; a value of ‘0’ means that an obsolete variant of *note
PyArg_ParseTuple(): 268. is used.

When using only ‘METH_VARARGS’, the function should expect the
Python-level parameters to be passed in as a tuple acceptable for
parsing via *note PyArg_ParseTuple(): 268.; more information on this
function is provided below.

The ‘METH_KEYWORDS’ bit may be set in the third field if keyword
arguments should be passed to the function.  In this case, the C
function should accept a third ‘PyObject *’ parameter which will be a
dictionary of keywords.  Use *note PyArg_ParseTupleAndKeywords(): 5bf.
to parse the arguments to such a function.

The method table must be referenced in the module definition structure:

     static struct PyModuleDef spammodule = {     PyModuleDef_HEAD_INIT,     "spam",   /* name of module */     spam_doc, /* module documentation, may be NULL */     -1,       /* size of per-interpreter state of the module,                  or -1 if the module keeps state in global variables. */     SpamMethods };

This structure, in turn, must be passed to the interpreter in the
module’s initialization function.  The initialization function must be
named ‘PyInit_name()’, where `name' is the name of the module, and
should be the only non-‘static’ item defined in the module file:

     PyMODINIT_FUNC PyInit_spam(void) {     return PyModule_Create(&spammodule); }

Note that PyMODINIT_FUNC declares the function as ‘PyObject *’ return
type, declares any special linkage declarations required by the
platform, and for C++ declares the function as ‘extern "C"’.

When the Python program imports module ‘spam’ for the first time,
‘PyInit_spam()’ is called.  (See below for comments about embedding
Python.)  It calls *note PyModule_Create(): 3a4b, which returns a module
object, and inserts built-in function objects into the newly created
module based upon the table (an array of *note PyMethodDef: e0e.
structures) found in the module definition.  *note PyModule_Create():
3a4b. returns a pointer to the module object that it creates.  It may
abort with a fatal error for certain errors, or return ‘NULL’ if the
module could not be initialized satisfactorily.  The init function must
return the module object to its caller, so that it then gets inserted
into ‘sys.modules’.

When embedding Python, the ‘PyInit_spam()’ function is not called
automatically unless there’s an entry in the ‘PyImport_Inittab’ table.
To add the module to the initialization table, use *note
PyImport_AppendInittab(): 3a4c, optionally followed by an import of the
module:

     int main(int argc, char *argv[]) {     wchar_t *program = Py_DecodeLocale(argv[0], NULL);     if (program == NULL) {         fprintf(stderr, "Fatal error: cannot decode argv[0]\n");         exit(1);     }      /* Add a built-in module, before Py_Initialize */     PyImport_AppendInittab("spam", PyInit_spam);      /* Pass argv[0] to the Python interpreter */     Py_SetProgramName(program);      /* Initialize the Python interpreter.  Required. */     Py_Initialize();      /* Optionally import the module; alternatively,        import can be deferred until the embedded script        imports it. */     PyImport_ImportModule("spam");      ...      PyMem_RawFree(program);     return 0; }

     Note: Removing entries from ‘sys.modules’ or importing compiled
     modules into multiple interpreters within a process (or following a
     ‘fork()’ without an intervening ‘exec()’) can create problems for
     some extension modules.  Extension module authors should exercise
     caution when initializing internal data structures.

A more substantial example module is included in the Python source
distribution as ‘Modules/xxmodule.c’.  This file may be used as a
template or simply read as an example.

     Note: Unlike our ‘spam’ example, ‘xxmodule’ uses `multi-phase
     initialization' (new in Python 3.5), where a PyModuleDef structure
     is returned from ‘PyInit_spam’, and creation of the module is left
     to the import machinery.  For details on multi-phase
     initialization, see PEP 489(1).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0489


File: python.info,  Node: Compilation and Linkage,  Next: Calling Python Functions from C,  Prev: The Module’s Method Table and Initialization Function,  Up: Extending Python with C or C++

6.2.1.5 Compilation and Linkage
...............................

There are two more things to do before you can use your new extension:
compiling and linking it with the Python system.  If you use dynamic
loading, the details may depend on the style of dynamic loading your
system uses; see the chapters about building extension modules (chapter
*note Building C and C++ Extensions: 3a4f.) and additional information
that pertains only to building on Windows (chapter *note Building C and
C++ Extensions on Windows: 12d5.) for more information about this.

If you can’t use dynamic loading, or if you want to make your module a
permanent part of the Python interpreter, you will have to change the
configuration setup and rebuild the interpreter.  Luckily, this is very
simple on Unix: just place your file (‘spammodule.c’ for example) in the
‘Modules/’ directory of an unpacked source distribution, add a line to
the file ‘Modules/Setup.local’ describing your file:

     spam spammodule.o

and rebuild the interpreter by running ‘make’ in the toplevel directory.
You can also run ‘make’ in the ‘Modules/’ subdirectory, but then you
must first rebuild ‘Makefile’ there by running ‘‘make’ Makefile’.  (This
is necessary each time you change the ‘Setup’ file.)

If your module requires additional libraries to link with, these can be
listed on the line in the configuration file as well, for instance:

     spam spammodule.o -lX11


File: python.info,  Node: Calling Python Functions from C,  Next: Extracting Parameters in Extension Functions,  Prev: Compilation and Linkage,  Up: Extending Python with C or C++

6.2.1.6 Calling Python Functions from C
.......................................

So far we have concentrated on making C functions callable from Python.
The reverse is also useful: calling Python functions from C. This is
especially the case for libraries that support so-called “callback”
functions.  If a C interface makes use of callbacks, the equivalent
Python often needs to provide a callback mechanism to the Python
programmer; the implementation will require calling the Python callback
functions from a C callback.  Other uses are also imaginable.

Fortunately, the Python interpreter is easily called recursively, and
there is a standard interface to call a Python function.  (I won’t dwell
on how to call the Python parser with a particular string as input — if
you’re interested, have a look at the implementation of the *note -c:
1145. command line option in ‘Modules/main.c’ from the Python source
code.)

Calling a Python function is easy.  First, the Python program must
somehow pass you the Python function object.  You should provide a
function (or some other interface) to do this.  When this function is
called, save a pointer to the Python function object (be careful to
*note Py_INCREF(): 263. it!)  in a global variable — or wherever you see
fit.  For example, the following function might be part of a module
definition:

     static PyObject *my_callback = NULL;  static PyObject * my_set_callback(PyObject *dummy, PyObject *args) {     PyObject *result = NULL;     PyObject *temp;      if (PyArg_ParseTuple(args, "O:set_callback", &temp)) {         if (!PyCallable_Check(temp)) {             PyErr_SetString(PyExc_TypeError, "parameter must be callable");             return NULL;         }         Py_XINCREF(temp);         /* Add a reference to new callback */         Py_XDECREF(my_callback);  /* Dispose of previous callback */         my_callback = temp;       /* Remember new callback */         /* Boilerplate to return "None" */         Py_INCREF(Py_None);         result = Py_None;     }     return result; }

This function must be registered with the interpreter using the *note
METH_VARARGS: e3b. flag; this is described in section *note The Module’s
Method Table and Initialization Function: 3a49.  The *note
PyArg_ParseTuple(): 268. function and its arguments are documented in
section *note Extracting Parameters in Extension Functions: 3a3d.

The macros *note Py_XINCREF(): 265. and *note Py_XDECREF(): 266.
increment/decrement the reference count of an object and are safe in the
presence of ‘NULL’ pointers (but note that `temp' will not be ‘NULL’ in
this context).  More info on them in section *note Reference Counts:
3a52.

Later, when it is time to call the function, you call the C function
*note PyObject_CallObject(): 3a53.  This function has two arguments,
both pointers to arbitrary Python objects: the Python function, and the
argument list.  The argument list must always be a tuple object, whose
length is the number of arguments.  To call the Python function with no
arguments, pass in ‘NULL’, or an empty tuple; to call it with one
argument, pass a singleton tuple.  *note Py_BuildValue(): 2cc. returns a
tuple when its format string consists of zero or more format codes
between parentheses.  For example:

     int arg; PyObject *arglist; PyObject *result; ... arg = 123; ... /* Time to call the callback */ arglist = Py_BuildValue("(i)", arg); result = PyObject_CallObject(my_callback, arglist); Py_DECREF(arglist);

*note PyObject_CallObject(): 3a53. returns a Python object pointer: this
is the return value of the Python function.  *note
PyObject_CallObject(): 3a53. is “reference-count-neutral” with respect
to its arguments.  In the example a new tuple was created to serve as
the argument list, which is *note Py_DECREF(): 264.-ed immediately after
the *note PyObject_CallObject(): 3a53. call.

The return value of *note PyObject_CallObject(): 3a53. is “new”: either
it is a brand new object, or it is an existing object whose reference
count has been incremented.  So, unless you want to save it in a global
variable, you should somehow *note Py_DECREF(): 264. the result, even
(especially!)  if you are not interested in its value.

Before you do this, however, it is important to check that the return
value isn’t ‘NULL’.  If it is, the Python function terminated by raising
an exception.  If the C code that called *note PyObject_CallObject():
3a53. is called from Python, it should now return an error indication to
its Python caller, so the interpreter can print a stack trace, or the
calling Python code can handle the exception.  If this is not possible
or desirable, the exception should be cleared by calling *note
PyErr_Clear(): 95f.  For example:

     if (result == NULL)     return NULL; /* Pass error back */ ...use result... Py_DECREF(result);

Depending on the desired interface to the Python callback function, you
may also have to provide an argument list to *note
PyObject_CallObject(): 3a53.  In some cases the argument list is also
provided by the Python program, through the same interface that
specified the callback function.  It can then be saved and used in the
same manner as the function object.  In other cases, you may have to
construct a new tuple to pass as the argument list.  The simplest way to
do this is to call *note Py_BuildValue(): 2cc.  For example, if you want
to pass an integral event code, you might use the following code:

     PyObject *arglist; ... arglist = Py_BuildValue("(l)", eventcode); result = PyObject_CallObject(my_callback, arglist); Py_DECREF(arglist); if (result == NULL)     return NULL; /* Pass error back */ /* Here maybe use the result */ Py_DECREF(result);

Note the placement of ‘Py_DECREF(arglist)’ immediately after the call,
before the error check!  Also note that strictly speaking this code is
not complete: *note Py_BuildValue(): 2cc. may run out of memory, and
this should be checked.

You may also call a function with keyword arguments by using *note
PyObject_Call(): 3a54, which supports arguments and keyword arguments.
As in the above example, we use *note Py_BuildValue(): 2cc. to construct
the dictionary.

     PyObject *dict; ... dict = Py_BuildValue("{s:i}", "name", val); result = PyObject_Call(my_callback, NULL, dict); Py_DECREF(dict); if (result == NULL)     return NULL; /* Pass error back */ /* Here maybe use the result */ Py_DECREF(result);


File: python.info,  Node: Extracting Parameters in Extension Functions,  Next: Keyword Parameters for Extension Functions,  Prev: Calling Python Functions from C,  Up: Extending Python with C or C++

6.2.1.7 Extracting Parameters in Extension Functions
....................................................

The *note PyArg_ParseTuple(): 268. function is declared as follows:

     int PyArg_ParseTuple(PyObject *arg, const char *format, ...);

The `arg' argument must be a tuple object containing an argument list
passed from Python to a C function.  The `format' argument must be a
format string, whose syntax is explained in *note Parsing arguments and
building values: 2ce. in the Python/C API Reference Manual.  The
remaining arguments must be addresses of variables whose type is
determined by the format string.

Note that while *note PyArg_ParseTuple(): 268. checks that the Python
arguments have the required types, it cannot check the validity of the
addresses of C variables passed to the call: if you make mistakes there,
your code will probably crash or at least overwrite random bits in
memory.  So be careful!

Note that any Python object references which are provided to the caller
are `borrowed' references; do not decrement their reference count!

Some example calls:

     #define PY_SSIZE_T_CLEAN  /* Make "s#" use Py_ssize_t rather than int. */ #include <Python.h>

     int ok; int i, j; long k, l; const char *s; Py_ssize_t size;  ok = PyArg_ParseTuple(args, ""); /* No arguments */     /* Python call: f() */

     ok = PyArg_ParseTuple(args, "s", &s); /* A string */     /* Possible Python call: f('whoops!') */

     ok = PyArg_ParseTuple(args, "lls", &k, &l, &s); /* Two longs and a string */     /* Possible Python call: f(1, 2, 'three') */

     ok = PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size);     /* A pair of ints and a string, whose size is also returned */     /* Possible Python call: f((1, 2), 'three') */

     {     const char *file;     const char *mode = "r";     int bufsize = 0;     ok = PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize);     /* A string, and optionally another string and an integer */     /* Possible Python calls:        f('spam')        f('spam', 'w')        f('spam', 'wb', 100000) */ }

     {     int left, top, right, bottom, h, v;     ok = PyArg_ParseTuple(args, "((ii)(ii))(ii)",              &left, &top, &right, &bottom, &h, &v);     /* A rectangle and a point */     /* Possible Python call:        f(((0, 0), (400, 300)), (10, 10)) */ }

     {     Py_complex c;     ok = PyArg_ParseTuple(args, "D:myfunction", &c);     /* a complex, also providing a function name for errors */     /* Possible Python call: myfunction(1+2j) */ }


File: python.info,  Node: Keyword Parameters for Extension Functions,  Next: Building Arbitrary Values,  Prev: Extracting Parameters in Extension Functions,  Up: Extending Python with C or C++

6.2.1.8 Keyword Parameters for Extension Functions
..................................................

The *note PyArg_ParseTupleAndKeywords(): 5bf. function is declared as
follows:

     int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,                                 const char *format, char *kwlist[], ...);

The `arg' and `format' parameters are identical to those of the *note
PyArg_ParseTuple(): 268. function.  The `kwdict' parameter is the
dictionary of keywords received as the third parameter from the Python
runtime.  The `kwlist' parameter is a ‘NULL’-terminated list of strings
which identify the parameters; the names are matched with the type
information from `format' from left to right.  On success, *note
PyArg_ParseTupleAndKeywords(): 5bf. returns true, otherwise it returns
false and raises an appropriate exception.

     Note: Nested tuples cannot be parsed when using keyword arguments!
     Keyword parameters passed in which are not present in the `kwlist'
     will cause *note TypeError: 192. to be raised.

Here is an example module which uses keywords, based on an example by
Geoff Philbrick (<philbrick@hks.com>):

     #define PY_SSIZE_T_CLEAN  /* Make "s#" use Py_ssize_t rather than int. */ #include <Python.h>  static PyObject * keywdarg_parrot(PyObject *self, PyObject *args, PyObject *keywds) {     int voltage;     const char *state = "a stiff";     const char *action = "voom";     const char *type = "Norwegian Blue";      static char *kwlist[] = {"voltage", "state", "action", "type", NULL};      if (!PyArg_ParseTupleAndKeywords(args, keywds, "i|sss", kwlist,                                      &voltage, &state, &action, &type))         return NULL;      printf("-- This parrot wouldn't %s if you put %i Volts through it.\n",            action, voltage);     printf("-- Lovely plumage, the %s -- It's %s!\n", type, state);      Py_RETURN_NONE; }  static PyMethodDef keywdarg_methods[] = {     /* The cast of the function is necessary since PyCFunction values      * only take two PyObject* parameters, and keywdarg_parrot() takes      * three.      */     {"parrot", (PyCFunction)(void(*)(void))keywdarg_parrot, METH_VARARGS | METH_KEYWORDS,      "Print a lovely skit to standard output."},     {NULL, NULL, 0, NULL}   /* sentinel */ };  static struct PyModuleDef keywdargmodule = {     PyModuleDef_HEAD_INIT,     "keywdarg",     NULL,     -1,     keywdarg_methods };  PyMODINIT_FUNC PyInit_keywdarg(void) {     return PyModule_Create(&keywdargmodule); }


File: python.info,  Node: Building Arbitrary Values,  Next: Reference Counts,  Prev: Keyword Parameters for Extension Functions,  Up: Extending Python with C or C++

6.2.1.9 Building Arbitrary Values
.................................

This function is the counterpart to *note PyArg_ParseTuple(): 268.  It
is declared as follows:

     PyObject *Py_BuildValue(const char *format, ...);

It recognizes a set of format units similar to the ones recognized by
*note PyArg_ParseTuple(): 268, but the arguments (which are input to the
function, not output) must not be pointers, just values.  It returns a
new Python object, suitable for returning from a C function called from
Python.

One difference with *note PyArg_ParseTuple(): 268.: while the latter
requires its first argument to be a tuple (since Python argument lists
are always represented as tuples internally), *note Py_BuildValue():
2cc. does not always build a tuple.  It builds a tuple only if its
format string contains two or more format units.  If the format string
is empty, it returns ‘None’; if it contains exactly one format unit, it
returns whatever object is described by that format unit.  To force it
to return a tuple of size 0 or one, parenthesize the format string.

Examples (to the left the call, to the right the resulting Python
value):

     Py_BuildValue("")                        None Py_BuildValue("i", 123)                  123 Py_BuildValue("iii", 123, 456, 789)      (123, 456, 789) Py_BuildValue("s", "hello")              'hello' Py_BuildValue("y", "hello")              b'hello' Py_BuildValue("ss", "hello", "world")    ('hello', 'world') Py_BuildValue("s#", "hello", 4)          'hell' Py_BuildValue("y#", "hello", 4)          b'hell' Py_BuildValue("()")                      () Py_BuildValue("(i)", 123)                (123,) Py_BuildValue("(ii)", 123, 456)          (123, 456) Py_BuildValue("(i,i)", 123, 456)         (123, 456) Py_BuildValue("[i,i]", 123, 456)         [123, 456] Py_BuildValue("{s:i,s:i}",               "abc", 123, "def", 456)    {'abc': 123, 'def': 456} Py_BuildValue("((ii)(ii)) (ii)",               1, 2, 3, 4, 5, 6)          (((1, 2), (3, 4)), (5, 6))


File: python.info,  Node: Reference Counts,  Next: Writing Extensions in C++,  Prev: Building Arbitrary Values,  Up: Extending Python with C or C++

6.2.1.10 Reference Counts
.........................

In languages like C or C++, the programmer is responsible for dynamic
allocation and deallocation of memory on the heap.  In C, this is done
using the functions ‘malloc()’ and ‘free()’.  In C++, the operators
‘new’ and ‘delete’ are used with essentially the same meaning and we’ll
restrict the following discussion to the C case.

Every block of memory allocated with ‘malloc()’ should eventually be
returned to the pool of available memory by exactly one call to
‘free()’.  It is important to call ‘free()’ at the right time.  If a
block’s address is forgotten but ‘free()’ is not called for it, the
memory it occupies cannot be reused until the program terminates.  This
is called a `memory leak'.  On the other hand, if a program calls
‘free()’ for a block and then continues to use the block, it creates a
conflict with re-use of the block through another ‘malloc()’ call.  This
is called `using freed memory'.  It has the same bad consequences as
referencing uninitialized data — core dumps, wrong results, mysterious
crashes.

Common causes of memory leaks are unusual paths through the code.  For
instance, a function may allocate a block of memory, do some
calculation, and then free the block again.  Now a change in the
requirements for the function may add a test to the calculation that
detects an error condition and can return prematurely from the function.
It’s easy to forget to free the allocated memory block when taking this
premature exit, especially when it is added later to the code.  Such
leaks, once introduced, often go undetected for a long time: the error
exit is taken only in a small fraction of all calls, and most modern
machines have plenty of virtual memory, so the leak only becomes
apparent in a long-running process that uses the leaking function
frequently.  Therefore, it’s important to prevent leaks from happening
by having a coding convention or strategy that minimizes this kind of
errors.

Since Python makes heavy use of ‘malloc()’ and ‘free()’, it needs a
strategy to avoid memory leaks as well as the use of freed memory.  The
chosen method is called `reference counting'.  The principle is simple:
every object contains a counter, which is incremented when a reference
to the object is stored somewhere, and which is decremented when a
reference to it is deleted.  When the counter reaches zero, the last
reference to the object has been deleted and the object is freed.

An alternative strategy is called `automatic garbage collection'.
(Sometimes, reference counting is also referred to as a garbage
collection strategy, hence my use of “automatic” to distinguish the
two.)  The big advantage of automatic garbage collection is that the
user doesn’t need to call ‘free()’ explicitly.  (Another claimed
advantage is an improvement in speed or memory usage — this is no hard
fact however.)  The disadvantage is that for C, there is no truly
portable automatic garbage collector, while reference counting can be
implemented portably (as long as the functions ‘malloc()’ and ‘free()’
are available — which the C Standard guarantees).  Maybe some day a
sufficiently portable automatic garbage collector will be available for
C. Until then, we’ll have to live with reference counts.

While Python uses the traditional reference counting implementation, it
also offers a cycle detector that works to detect reference cycles.
This allows applications to not worry about creating direct or indirect
circular references; these are the weakness of garbage collection
implemented using only reference counting.  Reference cycles consist of
objects which contain (possibly indirect) references to themselves, so
that each object in the cycle has a reference count which is non-zero.
Typical reference counting implementations are not able to reclaim the
memory belonging to any objects in a reference cycle, or referenced from
the objects in the cycle, even though there are no further references to
the cycle itself.

The cycle detector is able to detect garbage cycles and can reclaim
them.  The *note gc: 86. module exposes a way to run the detector (the
*note collect(): 22c. function), as well as configuration interfaces and
the ability to disable the detector at runtime.  The cycle detector is
considered an optional component; though it is included by default, it
can be disabled at build time using the ‘--without-cycle-gc’ option to
the ‘configure’ script on Unix platforms (including Mac OS X). If the
cycle detector is disabled in this way, the *note gc: 86. module will
not be available.

* Menu:

* Reference Counting in Python::
* Ownership Rules::
* Thin Ice::
* NULL Pointers::


File: python.info,  Node: Reference Counting in Python,  Next: Ownership Rules,  Up: Reference Counts

6.2.1.11 Reference Counting in Python
.....................................

There are two macros, ‘Py_INCREF(x)’ and ‘Py_DECREF(x)’, which handle
the incrementing and decrementing of the reference count.  *note
Py_DECREF(): 264. also frees the object when the count reaches zero.
For flexibility, it doesn’t call ‘free()’ directly — rather, it makes a
call through a function pointer in the object’s `type object'.  For this
purpose (and others), every object also contains a pointer to its type
object.

The big question now remains: when to use ‘Py_INCREF(x)’ and
‘Py_DECREF(x)’?  Let’s first introduce some terms.  Nobody “owns” an
object; however, you can `own a reference' to an object.  An object’s
reference count is now defined as the number of owned references to it.
The owner of a reference is responsible for calling *note Py_DECREF():
264. when the reference is no longer needed.  Ownership of a reference
can be transferred.  There are three ways to dispose of an owned
reference: pass it on, store it, or call *note Py_DECREF(): 264.
Forgetting to dispose of an owned reference creates a memory leak.

It is also possible to `borrow' (1) a reference to an object.  The
borrower of a reference should not call *note Py_DECREF(): 264.  The
borrower must not hold on to the object longer than the owner from which
it was borrowed.  Using a borrowed reference after the owner has
disposed of it risks using freed memory and should be avoided completely
(2).

The advantage of borrowing over owning a reference is that you don’t
need to take care of disposing of the reference on all possible paths
through the code — in other words, with a borrowed reference you don’t
run the risk of leaking when a premature exit is taken.  The
disadvantage of borrowing over owning is that there are some subtle
situations where in seemingly correct code a borrowed reference can be
used after the owner from which it was borrowed has in fact disposed of
it.

A borrowed reference can be changed into an owned reference by calling
*note Py_INCREF(): 263.  This does not affect the status of the owner
from which the reference was borrowed — it creates a new owned
reference, and gives full owner responsibilities (the new owner must
dispose of the reference properly, as well as the previous owner).

   ---------- Footnotes ----------

   (1) (2) The metaphor of “borrowing” a reference is not completely
correct: the owner still has a copy of the reference.

   (2) (3) Checking that the reference count is at least 1 `does not
work' — the reference count itself could be in freed memory and may thus
be reused for another object!


File: python.info,  Node: Ownership Rules,  Next: Thin Ice,  Prev: Reference Counting in Python,  Up: Reference Counts

6.2.1.12 Ownership Rules
........................

Whenever an object reference is passed into or out of a function, it is
part of the function’s interface specification whether ownership is
transferred with the reference or not.

Most functions that return a reference to an object pass on ownership
with the reference.  In particular, all functions whose function it is
to create a new object, such as *note PyLong_FromLong(): 3a45. and *note
Py_BuildValue(): 2cc, pass ownership to the receiver.  Even if the
object is not actually new, you still receive ownership of a new
reference to that object.  For instance, *note PyLong_FromLong(): 3a45.
maintains a cache of popular values and can return a reference to a
cached item.

Many functions that extract objects from other objects also transfer
ownership with the reference, for instance *note
PyObject_GetAttrString(): 3a5f.  The picture is less clear, here,
however, since a few common routines are exceptions: *note
PyTuple_GetItem(): 3a60, *note PyList_GetItem(): 3a61, *note
PyDict_GetItem(): 3a62, and *note PyDict_GetItemString(): 3a63. all
return references that you borrow from the tuple, list or dictionary.

The function *note PyImport_AddModule(): 3a64. also returns a borrowed
reference, even though it may actually create the object it returns:
this is possible because an owned reference to the object is stored in
‘sys.modules’.

When you pass an object reference into another function, in general, the
function borrows the reference from you — if it needs to store it, it
will use *note Py_INCREF(): 263. to become an independent owner.  There
are exactly two important exceptions to this rule: *note
PyTuple_SetItem(): 3a65. and *note PyList_SetItem(): 3a66.  These
functions take over ownership of the item passed to them — even if they
fail!  (Note that *note PyDict_SetItem(): 3a67. and friends don’t take
over ownership — they are “normal.”)

When a C function is called from Python, it borrows references to its
arguments from the caller.  The caller owns a reference to the object,
so the borrowed reference’s lifetime is guaranteed until the function
returns.  Only when such a borrowed reference must be stored or passed
on, it must be turned into an owned reference by calling *note
Py_INCREF(): 263.

The object reference returned from a C function that is called from
Python must be an owned reference — ownership is transferred from the
function to its caller.


File: python.info,  Node: Thin Ice,  Next: NULL Pointers,  Prev: Ownership Rules,  Up: Reference Counts

6.2.1.13 Thin Ice
.................

There are a few situations where seemingly harmless use of a borrowed
reference can lead to problems.  These all have to do with implicit
invocations of the interpreter, which can cause the owner of a reference
to dispose of it.

The first and most important case to know about is using *note
Py_DECREF(): 264. on an unrelated object while borrowing a reference to
a list item.  For instance:

     void bug(PyObject *list) {     PyObject *item = PyList_GetItem(list, 0);      PyList_SetItem(list, 1, PyLong_FromLong(0L));     PyObject_Print(item, stdout, 0); /* BUG! */ }

This function first borrows a reference to ‘list[0]’, then replaces
‘list[1]’ with the value ‘0’, and finally prints the borrowed reference.
Looks harmless, right?  But it’s not!

Let’s follow the control flow into *note PyList_SetItem(): 3a66.  The
list owns references to all its items, so when item 1 is replaced, it
has to dispose of the original item 1.  Now let’s suppose the original
item 1 was an instance of a user-defined class, and let’s further
suppose that the class defined a *note __del__(): 913. method.  If this
class instance has a reference count of 1, disposing of it will call its
*note __del__(): 913. method.

Since it is written in Python, the *note __del__(): 913. method can
execute arbitrary Python code.  Could it perhaps do something to
invalidate the reference to ‘item’ in ‘bug()’?  You bet!  Assuming that
the list passed into ‘bug()’ is accessible to the *note __del__(): 913.
method, it could execute a statement to the effect of ‘del list[0]’, and
assuming this was the last reference to that object, it would free the
memory associated with it, thereby invalidating ‘item’.

The solution, once you know the source of the problem, is easy:
temporarily increment the reference count.  The correct version of the
function reads:

     void no_bug(PyObject *list) {     PyObject *item = PyList_GetItem(list, 0);      Py_INCREF(item);     PyList_SetItem(list, 1, PyLong_FromLong(0L));     PyObject_Print(item, stdout, 0);     Py_DECREF(item); }

This is a true story.  An older version of Python contained variants of
this bug and someone spent a considerable amount of time in a C debugger
to figure out why his *note __del__(): 913. methods would fail…

The second case of problems with a borrowed reference is a variant
involving threads.  Normally, multiple threads in the Python interpreter
can’t get in each other’s way, because there is a global lock protecting
Python’s entire object space.  However, it is possible to temporarily
release this lock using the macro *note Py_BEGIN_ALLOW_THREADS: 3a6a,
and to re-acquire it using *note Py_END_ALLOW_THREADS: 2b3.  This is
common around blocking I/O calls, to let other threads use the processor
while waiting for the I/O to complete.  Obviously, the following
function has the same problem as the previous one:

     void bug(PyObject *list) {     PyObject *item = PyList_GetItem(list, 0);     Py_BEGIN_ALLOW_THREADS     ...some blocking I/O call...     Py_END_ALLOW_THREADS     PyObject_Print(item, stdout, 0); /* BUG! */ }


File: python.info,  Node: NULL Pointers,  Prev: Thin Ice,  Up: Reference Counts

6.2.1.14 NULL Pointers
......................

In general, functions that take object references as arguments do not
expect you to pass them ‘NULL’ pointers, and will dump core (or cause
later core dumps) if you do so.  Functions that return object references
generally return ‘NULL’ only to indicate that an exception occurred.
The reason for not testing for ‘NULL’ arguments is that functions often
pass the objects they receive on to other function — if each function
were to test for ‘NULL’, there would be a lot of redundant tests and the
code would run more slowly.

It is better to test for ‘NULL’ only at the “source:” when a pointer
that may be ‘NULL’ is received, for example, from ‘malloc()’ or from a
function that may raise an exception.

The macros *note Py_INCREF(): 263. and *note Py_DECREF(): 264. do not
check for ‘NULL’ pointers — however, their variants *note Py_XINCREF():
265. and *note Py_XDECREF(): 266. do.

The macros for checking for a particular object type (‘Pytype_Check()’)
don’t check for ‘NULL’ pointers — again, there is much code that calls
several of these in a row to test an object against various different
expected types, and this would generate redundant tests.  There are no
variants with ‘NULL’ checking.

The C function calling mechanism guarantees that the argument list
passed to C functions (‘args’ in the examples) is never ‘NULL’ — in fact
it guarantees that it is always a tuple (1).

It is a severe error to ever let a ‘NULL’ pointer “escape” to the Python
user.

   ---------- Footnotes ----------

   (1) (4) These guarantees don’t hold when you use the “old” style
calling convention — this is still found in much existing code.


File: python.info,  Node: Writing Extensions in C++,  Next: Providing a C API for an Extension Module,  Prev: Reference Counts,  Up: Extending Python with C or C++

6.2.1.15 Writing Extensions in C++
..................................

It is possible to write extension modules in C++.  Some restrictions
apply.  If the main program (the Python interpreter) is compiled and
linked by the C compiler, global or static objects with constructors
cannot be used.  This is not a problem if the main program is linked by
the C++ compiler.  Functions that will be called by the Python
interpreter (in particular, module initialization functions) have to be
declared using ‘extern "C"’.  It is unnecessary to enclose the Python
header files in ‘extern "C" {...}’ — they use this form already if the
symbol ‘__cplusplus’ is defined (all recent C++ compilers define this
symbol).


File: python.info,  Node: Providing a C API for an Extension Module,  Prev: Writing Extensions in C++,  Up: Extending Python with C or C++

6.2.1.16 Providing a C API for an Extension Module
..................................................

Many extension modules just provide new functions and types to be used
from Python, but sometimes the code in an extension module can be useful
for other extension modules.  For example, an extension module could
implement a type “collection” which works like lists without order.
Just like the standard Python list type has a C API which permits
extension modules to create and manipulate lists, this new collection
type should have a set of C functions for direct manipulation from other
extension modules.

At first sight this seems easy: just write the functions (without
declaring them ‘static’, of course), provide an appropriate header file,
and document the C API. And in fact this would work if all extension
modules were always linked statically with the Python interpreter.  When
modules are used as shared libraries, however, the symbols defined in
one module may not be visible to another module.  The details of
visibility depend on the operating system; some systems use one global
namespace for the Python interpreter and all extension modules (Windows,
for example), whereas others require an explicit list of imported
symbols at module link time (AIX is one example), or offer a choice of
different strategies (most Unices).  And even if symbols are globally
visible, the module whose functions one wishes to call might not have
been loaded yet!

Portability therefore requires not to make any assumptions about symbol
visibility.  This means that all symbols in extension modules should be
declared ‘static’, except for the module’s initialization function, in
order to avoid name clashes with other extension modules (as discussed
in section *note The Module’s Method Table and Initialization Function:
3a49.).  And it means that symbols that `should' be accessible from
other extension modules must be exported in a different way.

Python provides a special mechanism to pass C-level information
(pointers) from one extension module to another one: Capsules.  A
Capsule is a Python data type which stores a pointer (‘void *’).
Capsules can only be created and accessed via their C API, but they can
be passed around like any other Python object.  In particular, they can
be assigned to a name in an extension module’s namespace.  Other
extension modules can then import this module, retrieve the value of
this name, and then retrieve the pointer from the Capsule.

There are many ways in which Capsules can be used to export the C API of
an extension module.  Each function could get its own Capsule, or all C
API pointers could be stored in an array whose address is published in a
Capsule.  And the various tasks of storing and retrieving the pointers
can be distributed in different ways between the module providing the
code and the client modules.

Whichever method you choose, it’s important to name your Capsules
properly.  The function *note PyCapsule_New(): 3a70. takes a name
parameter (‘const char *’); you’re permitted to pass in a ‘NULL’ name,
but we strongly encourage you to specify a name.  Properly named
Capsules provide a degree of runtime type-safety; there is no feasible
way to tell one unnamed Capsule from another.

In particular, Capsules used to expose C APIs should be given a name
following this convention:

     modulename.attributename

The convenience function *note PyCapsule_Import(): 3a71. makes it easy
to load a C API provided via a Capsule, but only if the Capsule’s name
matches this convention.  This behavior gives C API users a high degree
of certainty that the Capsule they load contains the correct C API.

The following example demonstrates an approach that puts most of the
burden on the writer of the exporting module, which is appropriate for
commonly used library modules.  It stores all C API pointers (just one
in the example!)  in an array of ‘void’ pointers which becomes the value
of a Capsule.  The header file corresponding to the module provides a
macro that takes care of importing the module and retrieving its C API
pointers; client modules only have to call this macro before accessing
the C API.

The exporting module is a modification of the ‘spam’ module from section
*note A Simple Example: 3a3c.  The function ‘spam.system()’ does not
call the C library function ‘system()’ directly, but a function
‘PySpam_System()’, which would of course do something more complicated
in reality (such as adding “spam” to every command).  This function
‘PySpam_System()’ is also exported to other extension modules.

The function ‘PySpam_System()’ is a plain C function, declared ‘static’
like everything else:

     static int PySpam_System(const char *command) {     return system(command); }

The function ‘spam_system()’ is modified in a trivial way:

     static PyObject * spam_system(PyObject *self, PyObject *args) {     const char *command;     int sts;      if (!PyArg_ParseTuple(args, "s", &command))         return NULL;     sts = PySpam_System(command);     return PyLong_FromLong(sts); }

In the beginning of the module, right after the line

     #include <Python.h>

two more lines must be added:

     #define SPAM_MODULE #include "spammodule.h"

The ‘#define’ is used to tell the header file that it is being included
in the exporting module, not a client module.  Finally, the module’s
initialization function must take care of initializing the C API pointer
array:

     PyMODINIT_FUNC PyInit_spam(void) {     PyObject *m;     static void *PySpam_API[PySpam_API_pointers];     PyObject *c_api_object;      m = PyModule_Create(&spammodule);     if (m == NULL)         return NULL;      /* Initialize the C API pointer array */     PySpam_API[PySpam_System_NUM] = (void *)PySpam_System;      /* Create a Capsule containing the API pointer array's address */     c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL);      if (PyModule_AddObject(m, "_C_API", c_api_object) < 0) {         Py_XDECREF(c_api_object);         Py_DECREF(m);         return NULL;     }      return m; }

Note that ‘PySpam_API’ is declared ‘static’; otherwise the pointer array
would disappear when ‘PyInit_spam()’ terminates!

The bulk of the work is in the header file ‘spammodule.h’, which looks
like this:

     #ifndef Py_SPAMMODULE_H #define Py_SPAMMODULE_H #ifdef __cplusplus extern "C" { #endif  /* Header file for spammodule */  /* C API functions */ #define PySpam_System_NUM 0 #define PySpam_System_RETURN int #define PySpam_System_PROTO (const char *command)  /* Total number of C API pointers */ #define PySpam_API_pointers 1   #ifdef SPAM_MODULE /* This section is used when compiling spammodule.c */  static PySpam_System_RETURN PySpam_System PySpam_System_PROTO;  #else /* This section is used in modules that use spammodule's API */  static void **PySpam_API;  #define PySpam_System \  (*(PySpam_System_RETURN (*)PySpam_System_PROTO) PySpam_API[PySpam_System_NUM])  /* Return -1 on error, 0 on success.  * PyCapsule_Import will set an exception if there's an error.  */ static int import_spam(void) {     PySpam_API = (void **)PyCapsule_Import("spam._C_API", 0);     return (PySpam_API != NULL) ? 0 : -1; }  #endif  #ifdef __cplusplus } #endif  #endif /* !defined(Py_SPAMMODULE_H) */

All that a client module must do in order to have access to the function
‘PySpam_System()’ is to call the function (or rather macro)
‘import_spam()’ in its initialization function:

     PyMODINIT_FUNC PyInit_client(void) {     PyObject *m;      m = PyModule_Create(&clientmodule);     if (m == NULL)         return NULL;     if (import_spam() < 0)         return NULL;     /* additional initialization can happen here */     return m; }

The main disadvantage of this approach is that the file ‘spammodule.h’
is rather complicated.  However, the basic structure is the same for
each function that is exported, so it has to be learned only once.

Finally it should be mentioned that Capsules offer additional
functionality, which is especially useful for memory allocation and
deallocation of the pointer stored in a Capsule.  The details are
described in the Python/C API Reference Manual in the section *note
Capsules: 3a72. and in the implementation of Capsules (files
‘Include/pycapsule.h’ and ‘Objects/pycapsule.c’ in the Python source
code distribution).


File: python.info,  Node: Defining Extension Types Tutorial,  Next: Defining Extension Types Assorted Topics,  Prev: Extending Python with C or C++,  Up: Creating extensions without third party tools

6.2.2 Defining Extension Types: Tutorial
----------------------------------------

Python allows the writer of a C extension module to define new types
that can be manipulated from Python code, much like the built-in *note
str: 325. and *note list: 260. types.  The code for all extension types
follows a pattern, but there are some details that you need to
understand before you can get started.  This document is a gentle
introduction to the topic.

* Menu:

* The Basics::
* Adding data and methods to the Basic example::
* Providing finer control over data attributes::
* Supporting cyclic garbage collection::
* Subclassing other types::


File: python.info,  Node: The Basics,  Next: Adding data and methods to the Basic example,  Up: Defining Extension Types Tutorial

6.2.2.1 The Basics
..................

The *note CPython: 1372. runtime sees all Python objects as variables of
type *note PyObject*: 4b0, which serves as a “base type” for all Python
objects.  The *note PyObject: 4b0. structure itself only contains the
object’s *note reference count: 3a78. and a pointer to the object’s
“type object”.  This is where the action is; the type object determines
which (C) functions get called by the interpreter when, for instance, an
attribute gets looked up on an object, a method called, or it is
multiplied by another object.  These C functions are called “type
methods”.

So, if you want to define a new extension type, you need to create a new
type object.

This sort of thing can only be explained by example, so here’s a
minimal, but complete, module that defines a new type named ‘Custom’
inside a C extension module ‘custom’:

     Note: What we’re showing here is the traditional way of defining
     `static' extension types.  It should be adequate for most uses.
     The C API also allows defining heap-allocated extension types using
     the *note PyType_FromSpec(): 2cf. function, which isn’t covered in
     this tutorial.

     #define PY_SSIZE_T_CLEAN #include <Python.h>  typedef struct {     PyObject_HEAD     /* Type-specific fields go here. */ } CustomObject;  static PyTypeObject CustomType = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "custom.Custom",     .tp_doc = "Custom objects",     .tp_basicsize = sizeof(CustomObject),     .tp_itemsize = 0,     .tp_flags = Py_TPFLAGS_DEFAULT,     .tp_new = PyType_GenericNew, };  static PyModuleDef custommodule = {     PyModuleDef_HEAD_INIT,     .m_name = "custom",     .m_doc = "Example module that creates an extension type.",     .m_size = -1, };  PyMODINIT_FUNC PyInit_custom(void) {     PyObject *m;     if (PyType_Ready(&CustomType) < 0)         return NULL;      m = PyModule_Create(&custommodule);     if (m == NULL)         return NULL;      Py_INCREF(&CustomType);     if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {         Py_DECREF(&CustomType);         PY_DECREF(m);         return NULL;     }      return m; }

Now that’s quite a bit to take in at once, but hopefully bits will seem
familiar from the previous chapter.  This file defines three things:

  1. What a ‘Custom’ `object' contains: this is the ‘CustomObject’
     struct, which is allocated once for each ‘Custom’ instance.

  2. How the ‘Custom’ `type' behaves: this is the ‘CustomType’ struct,
     which defines a set of flags and function pointers that the
     interpreter inspects when specific operations are requested.

  3. How to initialize the ‘custom’ module: this is the ‘PyInit_custom’
     function and the associated ‘custommodule’ struct.

The first bit is:

     typedef struct {     PyObject_HEAD } CustomObject;

This is what a Custom object will contain.  ‘PyObject_HEAD’ is mandatory
at the start of each object struct and defines a field called ‘ob_base’
of type *note PyObject: 4b0, containing a pointer to a type object and a
reference count (these can be accessed using the macros *note Py_REFCNT:
3a79. and *note Py_TYPE: 3a7a. respectively).  The reason for the macro
is to abstract away the layout and to enable additional fields in debug
builds.

     Note: There is no semicolon above after the *note PyObject_HEAD:
     c65. macro.  Be wary of adding one by accident: some compilers will
     complain.

Of course, objects generally store additional data besides the standard
‘PyObject_HEAD’ boilerplate; for example, here is the definition for
standard Python floats:

     typedef struct {     PyObject_HEAD     double ob_fval; } PyFloatObject;

The second bit is the definition of the type object.

     static PyTypeObject CustomType = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "custom.Custom",     .tp_doc = "Custom objects",     .tp_basicsize = sizeof(CustomObject),     .tp_itemsize = 0,     .tp_flags = Py_TPFLAGS_DEFAULT,     .tp_new = PyType_GenericNew, };

     Note: We recommend using C99-style designated initializers as
     above, to avoid listing all the *note PyTypeObject: 2d4. fields
     that you don’t care about and also to avoid caring about the
     fields’ declaration order.

The actual definition of *note PyTypeObject: 2d4. in ‘object.h’ has many
more *note fields: 3a7b. than the definition above.  The remaining
fields will be filled with zeros by the C compiler, and it’s common
practice to not specify them explicitly unless you need them.

We’re going to pick it apart, one field at a time:

     PyVarObject_HEAD_INIT(NULL, 0)

This line is mandatory boilerplate to initialize the ‘ob_base’ field
mentioned above.

     .tp_name = "custom.Custom",

The name of our type.  This will appear in the default textual
representation of our objects and in some error messages, for example:

     >>> "" + custom.Custom() Traceback (most recent call last):   File "<stdin>", line 1, in <module> TypeError: can only concatenate str (not "custom.Custom") to str

Note that the name is a dotted name that includes both the module name
and the name of the type within the module.  The module in this case is
‘custom’ and the type is ‘Custom’, so we set the type name to
‘custom.Custom’.  Using the real dotted import path is important to make
your type compatible with the *note pydoc: d9. and *note pickle: ca.
modules.

     .tp_basicsize = sizeof(CustomObject), .tp_itemsize = 0,

This is so that Python knows how much memory to allocate when creating
new ‘Custom’ instances.  *note tp_itemsize: 3a7c. is only used for
variable-sized objects and should otherwise be zero.

     Note: If you want your type to be subclassable from Python, and
     your type has the same *note tp_basicsize: 3a7d. as its base type,
     you may have problems with multiple inheritance.  A Python subclass
     of your type will have to list your type first in its *note
     __bases__: dfc, or else it will not be able to call your type’s
     *note __new__(): 87d. method without getting an error.  You can
     avoid this problem by ensuring that your type has a larger value
     for *note tp_basicsize: 3a7d. than its base type does.  Most of the
     time, this will be true anyway, because either your base type will
     be *note object: 2ae, or else you will be adding data members to
     your base type, and therefore increasing its size.

We set the class flags to *note Py_TPFLAGS_DEFAULT: 3a7e.

     .tp_flags = Py_TPFLAGS_DEFAULT,

All types should include this constant in their flags.  It enables all
of the members defined until at least Python 3.3.  If you need further
members, you will need to OR the corresponding flags.

We provide a doc string for the type in *note tp_doc: 3a7f.

     .tp_doc = "Custom objects",

To enable object creation, we have to provide a *note tp_new: 3a80.
handler.  This is the equivalent of the Python method *note __new__():
87d, but has to be specified explicitly.  In this case, we can just use
the default implementation provided by the API function *note
PyType_GenericNew(): 3a81.

     .tp_new = PyType_GenericNew,

Everything else in the file should be familiar, except for some code in
‘PyInit_custom()’:

     if (PyType_Ready(&CustomType) < 0)     return;

This initializes the ‘Custom’ type, filling in a number of members to
the appropriate default values, including ‘ob_type’ that we initially
set to ‘NULL’.

     Py_INCREF(&CustomType); if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {     Py_DECREF(&CustomType);     Py_DECREF(m);     return NULL; }

This adds the type to the module dictionary.  This allows us to create
‘Custom’ instances by calling the ‘Custom’ class:

     >>> import custom >>> mycustom = custom.Custom()

That’s it!  All that remains is to build it; put the above code in a
file called ‘custom.c’ and:

     from distutils.core import setup, Extension setup(name="custom", version="1.0",       ext_modules=[Extension("custom", ["custom.c"])])

in a file called ‘setup.py’; then typing

     $ python setup.py build

at a shell should produce a file ‘custom.so’ in a subdirectory; move to
that directory and fire up Python — you should be able to ‘import
custom’ and play around with Custom objects.

That wasn’t so hard, was it?

Of course, the current Custom type is pretty uninteresting.  It has no
data and doesn’t do anything.  It can’t even be subclassed.

     Note: While this documentation showcases the standard *note
     distutils: 39. module for building C extensions, it is recommended
     in real-world use cases to use the newer and better-maintained
     ‘setuptools’ library.  Documentation on how to do this is out of
     scope for this document and can be found in the Python Packaging
     User’s Guide(1).

   ---------- Footnotes ----------

   (1) https://packaging.python.org/tutorials/distributing-packages/


File: python.info,  Node: Adding data and methods to the Basic example,  Next: Providing finer control over data attributes,  Prev: The Basics,  Up: Defining Extension Types Tutorial

6.2.2.2 Adding data and methods to the Basic example
....................................................

Let’s extend the basic example to add some data and methods.  Let’s also
make the type usable as a base class.  We’ll create a new module,
‘custom2’ that adds these capabilities:

     #define PY_SSIZE_T_CLEAN #include <Python.h> #include "structmember.h"  typedef struct {     PyObject_HEAD     PyObject *first; /* first name */     PyObject *last;  /* last name */     int number; } CustomObject;  static void Custom_dealloc(CustomObject *self) {     Py_XDECREF(self->first);     Py_XDECREF(self->last);     Py_TYPE(self)->tp_free((PyObject *) self); }  static PyObject * Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {     CustomObject *self;     self = (CustomObject *) type->tp_alloc(type, 0);     if (self != NULL) {         self->first = PyUnicode_FromString("");         if (self->first == NULL) {             Py_DECREF(self);             return NULL;         }         self->last = PyUnicode_FromString("");         if (self->last == NULL) {             Py_DECREF(self);             return NULL;         }         self->number = 0;     }     return (PyObject *) self; }  static int Custom_init(CustomObject *self, PyObject *args, PyObject *kwds) {     static char *kwlist[] = {"first", "last", "number", NULL};     PyObject *first = NULL, *last = NULL, *tmp;      if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,                                      &first, &last,                                      &self->number))         return -1;      if (first) {         tmp = self->first;         Py_INCREF(first);         self->first = first;         Py_XDECREF(tmp);     }     if (last) {         tmp = self->last;         Py_INCREF(last);         self->last = last;         Py_XDECREF(tmp);     }     return 0; }  static PyMemberDef Custom_members[] = {     {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,      "first name"},     {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,      "last name"},     {"number", T_INT, offsetof(CustomObject, number), 0,      "custom number"},     {NULL}  /* Sentinel */ };  static PyObject * Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored)) {     if (self->first == NULL) {         PyErr_SetString(PyExc_AttributeError, "first");         return NULL;     }     if (self->last == NULL) {         PyErr_SetString(PyExc_AttributeError, "last");         return NULL;     }     return PyUnicode_FromFormat("%S %S", self->first, self->last); }  static PyMethodDef Custom_methods[] = {     {"name", (PyCFunction) Custom_name, METH_NOARGS,      "Return the name, combining the first and last name"     },     {NULL}  /* Sentinel */ };  static PyTypeObject CustomType = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "custom2.Custom",     .tp_doc = "Custom objects",     .tp_basicsize = sizeof(CustomObject),     .tp_itemsize = 0,     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,     .tp_new = Custom_new,     .tp_init = (initproc) Custom_init,     .tp_dealloc = (destructor) Custom_dealloc,     .tp_members = Custom_members,     .tp_methods = Custom_methods, };  static PyModuleDef custommodule = {     PyModuleDef_HEAD_INIT,     .m_name = "custom2",     .m_doc = "Example module that creates an extension type.",     .m_size = -1, };  PyMODINIT_FUNC PyInit_custom2(void) {     PyObject *m;     if (PyType_Ready(&CustomType) < 0)         return NULL;      m = PyModule_Create(&custommodule);     if (m == NULL)         return NULL;      Py_INCREF(&CustomType);     if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {         Py_DECREF(&CustomType);         Py_DECREF(m);         return NULL;     }      return m; }

This version of the module has a number of changes.

We’ve added an extra include:

     #include <structmember.h>

This include provides declarations that we use to handle attributes, as
described a bit later.

The ‘Custom’ type now has three data attributes in its C struct,
`first', `last', and `number'.  The `first' and `last' variables are
Python strings containing first and last names.  The `number' attribute
is a C integer.

The object structure is updated accordingly:

     typedef struct {     PyObject_HEAD     PyObject *first; /* first name */     PyObject *last;  /* last name */     int number; } CustomObject;

Because we now have data to manage, we have to be more careful about
object allocation and deallocation.  At a minimum, we need a
deallocation method:

     static void Custom_dealloc(CustomObject *self) {     Py_XDECREF(self->first);     Py_XDECREF(self->last);     Py_TYPE(self)->tp_free((PyObject *) self); }

which is assigned to the *note tp_dealloc: 3a83. member:

     .tp_dealloc = (destructor) Custom_dealloc,

This method first clears the reference counts of the two Python
attributes.  *note Py_XDECREF(): 266. correctly handles the case where
its argument is ‘NULL’ (which might happen here if ‘tp_new’ failed
midway).  It then calls the *note tp_free: 3a84. member of the object’s
type (computed by ‘Py_TYPE(self)’) to free the object’s memory.  Note
that the object’s type might not be ‘CustomType’, because the object may
be an instance of a subclass.

     Note: The explicit cast to ‘destructor’ above is needed because we
     defined ‘Custom_dealloc’ to take a ‘CustomObject *’ argument, but
     the ‘tp_dealloc’ function pointer expects to receive a ‘PyObject *’
     argument.  Otherwise, the compiler will emit a warning.  This is
     object-oriented polymorphism, in C!

We want to make sure that the first and last names are initialized to
empty strings, so we provide a ‘tp_new’ implementation:

     static PyObject * Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {     CustomObject *self;     self = (CustomObject *) type->tp_alloc(type, 0);     if (self != NULL) {         self->first = PyUnicode_FromString("");         if (self->first == NULL) {             Py_DECREF(self);             return NULL;         }         self->last = PyUnicode_FromString("");         if (self->last == NULL) {             Py_DECREF(self);             return NULL;         }         self->number = 0;     }     return (PyObject *) self; }

and install it in the *note tp_new: 3a80. member:

     .tp_new = Custom_new,

The ‘tp_new’ handler is responsible for creating (as opposed to
initializing) objects of the type.  It is exposed in Python as the *note
__new__(): 87d. method.  It is not required to define a ‘tp_new’ member,
and indeed many extension types will simply reuse *note
PyType_GenericNew(): 3a81. as done in the first version of the ‘Custom’
type above.  In this case, we use the ‘tp_new’ handler to initialize the
‘first’ and ‘last’ attributes to non-‘NULL’ default values.

‘tp_new’ is passed the type being instantiated (not necessarily
‘CustomType’, if a subclass is instantiated) and any arguments passed
when the type was called, and is expected to return the instance
created.  ‘tp_new’ handlers always accept positional and keyword
arguments, but they often ignore the arguments, leaving the argument
handling to initializer (a.k.a.  ‘tp_init’ in C or ‘__init__’ in Python)
methods.

     Note: ‘tp_new’ shouldn’t call ‘tp_init’ explicitly, as the
     interpreter will do it itself.

The ‘tp_new’ implementation calls the *note tp_alloc: 3a85. slot to
allocate memory:

     self = (CustomObject *) type->tp_alloc(type, 0);

Since memory allocation may fail, we must check the *note tp_alloc:
3a85. result against ‘NULL’ before proceeding.

     Note: We didn’t fill the *note tp_alloc: 3a85. slot ourselves.
     Rather *note PyType_Ready(): 3a86. fills it for us by inheriting it
     from our base class, which is *note object: 2ae. by default.  Most
     types use the default allocation strategy.

     Note: If you are creating a co-operative *note tp_new: 3a80. (one
     that calls a base type’s *note tp_new: 3a80. or *note __new__():
     87d.), you must `not' try to determine what method to call using
     method resolution order at runtime.  Always statically determine
     what type you are going to call, and call its *note tp_new: 3a80.
     directly, or via ‘type->tp_base->tp_new’.  If you do not do this,
     Python subclasses of your type that also inherit from other
     Python-defined classes may not work correctly.  (Specifically, you
     may not be able to create instances of such subclasses without
     getting a *note TypeError: 192.)

We also define an initialization function which accepts arguments to
provide initial values for our instance:

     static int Custom_init(CustomObject *self, PyObject *args, PyObject *kwds) {     static char *kwlist[] = {"first", "last", "number", NULL};     PyObject *first = NULL, *last = NULL, *tmp;      if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,                                      &first, &last,                                      &self->number))         return -1;      if (first) {         tmp = self->first;         Py_INCREF(first);         self->first = first;         Py_XDECREF(tmp);     }     if (last) {         tmp = self->last;         Py_INCREF(last);         self->last = last;         Py_XDECREF(tmp);     }     return 0; }

by filling the *note tp_init: 3a87. slot.

     .tp_init = (initproc) Custom_init,

The *note tp_init: 3a87. slot is exposed in Python as the *note
__init__(): d51. method.  It is used to initialize an object after it’s
created.  Initializers always accept positional and keyword arguments,
and they should return either ‘0’ on success or ‘-1’ on error.

Unlike the ‘tp_new’ handler, there is no guarantee that ‘tp_init’ is
called at all (for example, the *note pickle: ca. module by default
doesn’t call *note __init__(): d51. on unpickled instances).  It can
also be called multiple times.  Anyone can call the *note __init__():
d51. method on our objects.  For this reason, we have to be extra
careful when assigning the new attribute values.  We might be tempted,
for example to assign the ‘first’ member like this:

     if (first) {     Py_XDECREF(self->first);     Py_INCREF(first);     self->first = first; }

But this would be risky.  Our type doesn’t restrict the type of the
‘first’ member, so it could be any kind of object.  It could have a
destructor that causes code to be executed that tries to access the
‘first’ member; or that destructor could release the *note Global
interpreter Lock: 4fb. and let arbitrary code run in other threads that
accesses and modifies our object.

To be paranoid and protect ourselves against this possibility, we almost
always reassign members before decrementing their reference counts.
When don’t we have to do this?

   * when we absolutely know that the reference count is greater than 1;

   * when we know that deallocation of the object (1) will neither
     release the *note GIL: bdd. nor cause any calls back into our
     type’s code;

   * when decrementing a reference count in a *note tp_dealloc: 3a83.
     handler on a type which doesn’t support cyclic garbage collection
     (2).

We want to expose our instance variables as attributes.  There are a
number of ways to do that.  The simplest way is to define member
definitions:

     static PyMemberDef Custom_members[] = {     {"first", T_OBJECT_EX, offsetof(CustomObject, first), 0,      "first name"},     {"last", T_OBJECT_EX, offsetof(CustomObject, last), 0,      "last name"},     {"number", T_INT, offsetof(CustomObject, number), 0,      "custom number"},     {NULL}  /* Sentinel */ };

and put the definitions in the *note tp_members: 3a88. slot:

     .tp_members = Custom_members,

Each member definition has a member name, type, offset, access flags and
documentation string.  See the *note Generic Attribute Management: 3a89.
section below for details.

A disadvantage of this approach is that it doesn’t provide a way to
restrict the types of objects that can be assigned to the Python
attributes.  We expect the first and last names to be strings, but any
Python objects can be assigned.  Further, the attributes can be deleted,
setting the C pointers to ‘NULL’.  Even though we can make sure the
members are initialized to non-‘NULL’ values, the members can be set to
‘NULL’ if the attributes are deleted.

We define a single method, ‘Custom.name()’, that outputs the objects
name as the concatenation of the first and last names.

     static PyObject * Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored)) {     if (self->first == NULL) {         PyErr_SetString(PyExc_AttributeError, "first");         return NULL;     }     if (self->last == NULL) {         PyErr_SetString(PyExc_AttributeError, "last");         return NULL;     }     return PyUnicode_FromFormat("%S %S", self->first, self->last); }

The method is implemented as a C function that takes a ‘Custom’ (or
‘Custom’ subclass) instance as the first argument.  Methods always take
an instance as the first argument.  Methods often take positional and
keyword arguments as well, but in this case we don’t take any and don’t
need to accept a positional argument tuple or keyword argument
dictionary.  This method is equivalent to the Python method:

     def name(self):     return "%s %s" % (self.first, self.last)

Note that we have to check for the possibility that our ‘first’ and
‘last’ members are ‘NULL’.  This is because they can be deleted, in
which case they are set to ‘NULL’.  It would be better to prevent
deletion of these attributes and to restrict the attribute values to be
strings.  We’ll see how to do that in the next section.

Now that we’ve defined the method, we need to create an array of method
definitions:

     static PyMethodDef Custom_methods[] = {     {"name", (PyCFunction) Custom_name, METH_NOARGS,      "Return the name, combining the first and last name"     },     {NULL}  /* Sentinel */ };

(note that we used the *note METH_NOARGS: e0b. flag to indicate that the
method is expecting no arguments other than `self')

and assign it to the *note tp_methods: 3a8a. slot:

     .tp_methods = Custom_methods,

Finally, we’ll make our type usable as a base class for subclassing.
We’ve written our methods carefully so far so that they don’t make any
assumptions about the type of the object being created or used, so all
we need to do is to add the *note Py_TPFLAGS_BASETYPE: 3a8b. to our
class flag definition:

     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,

We rename ‘PyInit_custom()’ to ‘PyInit_custom2()’, update the module
name in the *note PyModuleDef: 3a8c. struct, and update the full class
name in the *note PyTypeObject: 2d4. struct.

Finally, we update our ‘setup.py’ file to build the new module:

     from distutils.core import setup, Extension setup(name="custom", version="1.0",       ext_modules=[          Extension("custom", ["custom.c"]),          Extension("custom2", ["custom2.c"]),          ])

   ---------- Footnotes ----------

   (1) (1) This is true when we know that the object is a basic type,
like a string or a float.

   (2) (2) We relied on this in the *note tp_dealloc: 3a83. handler in
this example, because our type doesn’t support garbage collection.


File: python.info,  Node: Providing finer control over data attributes,  Next: Supporting cyclic garbage collection,  Prev: Adding data and methods to the Basic example,  Up: Defining Extension Types Tutorial

6.2.2.3 Providing finer control over data attributes
....................................................

In this section, we’ll provide finer control over how the ‘first’ and
‘last’ attributes are set in the ‘Custom’ example.  In the previous
version of our module, the instance variables ‘first’ and ‘last’ could
be set to non-string values or even deleted.  We want to make sure that
these attributes always contain strings.

     #define PY_SSIZE_T_CLEAN #include <Python.h> #include "structmember.h"  typedef struct {     PyObject_HEAD     PyObject *first; /* first name */     PyObject *last;  /* last name */     int number; } CustomObject;  static void Custom_dealloc(CustomObject *self) {     Py_XDECREF(self->first);     Py_XDECREF(self->last);     Py_TYPE(self)->tp_free((PyObject *) self); }  static PyObject * Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {     CustomObject *self;     self = (CustomObject *) type->tp_alloc(type, 0);     if (self != NULL) {         self->first = PyUnicode_FromString("");         if (self->first == NULL) {             Py_DECREF(self);             return NULL;         }         self->last = PyUnicode_FromString("");         if (self->last == NULL) {             Py_DECREF(self);             return NULL;         }         self->number = 0;     }     return (PyObject *) self; }  static int Custom_init(CustomObject *self, PyObject *args, PyObject *kwds) {     static char *kwlist[] = {"first", "last", "number", NULL};     PyObject *first = NULL, *last = NULL, *tmp;      if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,                                      &first, &last,                                      &self->number))         return -1;      if (first) {         tmp = self->first;         Py_INCREF(first);         self->first = first;         Py_DECREF(tmp);     }     if (last) {         tmp = self->last;         Py_INCREF(last);         self->last = last;         Py_DECREF(tmp);     }     return 0; }  static PyMemberDef Custom_members[] = {     {"number", T_INT, offsetof(CustomObject, number), 0,      "custom number"},     {NULL}  /* Sentinel */ };  static PyObject * Custom_getfirst(CustomObject *self, void *closure) {     Py_INCREF(self->first);     return self->first; }  static int Custom_setfirst(CustomObject *self, PyObject *value, void *closure) {     PyObject *tmp;     if (value == NULL) {         PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");         return -1;     }     if (!PyUnicode_Check(value)) {         PyErr_SetString(PyExc_TypeError,                         "The first attribute value must be a string");         return -1;     }     tmp = self->first;     Py_INCREF(value);     self->first = value;     Py_DECREF(tmp);     return 0; }  static PyObject * Custom_getlast(CustomObject *self, void *closure) {     Py_INCREF(self->last);     return self->last; }  static int Custom_setlast(CustomObject *self, PyObject *value, void *closure) {     PyObject *tmp;     if (value == NULL) {         PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");         return -1;     }     if (!PyUnicode_Check(value)) {         PyErr_SetString(PyExc_TypeError,                         "The last attribute value must be a string");         return -1;     }     tmp = self->last;     Py_INCREF(value);     self->last = value;     Py_DECREF(tmp);     return 0; }  static PyGetSetDef Custom_getsetters[] = {     {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,      "first name", NULL},     {"last", (getter) Custom_getlast, (setter) Custom_setlast,      "last name", NULL},     {NULL}  /* Sentinel */ };  static PyObject * Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored)) {     return PyUnicode_FromFormat("%S %S", self->first, self->last); }  static PyMethodDef Custom_methods[] = {     {"name", (PyCFunction) Custom_name, METH_NOARGS,      "Return the name, combining the first and last name"     },     {NULL}  /* Sentinel */ };  static PyTypeObject CustomType = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "custom3.Custom",     .tp_doc = "Custom objects",     .tp_basicsize = sizeof(CustomObject),     .tp_itemsize = 0,     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,     .tp_new = Custom_new,     .tp_init = (initproc) Custom_init,     .tp_dealloc = (destructor) Custom_dealloc,     .tp_members = Custom_members,     .tp_methods = Custom_methods,     .tp_getset = Custom_getsetters, };  static PyModuleDef custommodule = {     PyModuleDef_HEAD_INIT,     .m_name = "custom3",     .m_doc = "Example module that creates an extension type.",     .m_size = -1, };  PyMODINIT_FUNC PyInit_custom3(void) {     PyObject *m;     if (PyType_Ready(&CustomType) < 0)         return NULL;      m = PyModule_Create(&custommodule);     if (m == NULL)         return NULL;      Py_INCREF(&CustomType);     if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {         Py_DECREF(&CustomType);         Py_DECREF(m);         return NULL;     }      return m; }

To provide greater control, over the ‘first’ and ‘last’ attributes,
we’ll use custom getter and setter functions.  Here are the functions
for getting and setting the ‘first’ attribute:

     static PyObject * Custom_getfirst(CustomObject *self, void *closure) {     Py_INCREF(self->first);     return self->first; }  static int Custom_setfirst(CustomObject *self, PyObject *value, void *closure) {     PyObject *tmp;     if (value == NULL) {         PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");         return -1;     }     if (!PyUnicode_Check(value)) {         PyErr_SetString(PyExc_TypeError,                         "The first attribute value must be a string");         return -1;     }     tmp = self->first;     Py_INCREF(value);     self->first = value;     Py_DECREF(tmp);     return 0; }

The getter function is passed a ‘Custom’ object and a “closure”, which
is a void pointer.  In this case, the closure is ignored.  (The closure
supports an advanced usage in which definition data is passed to the
getter and setter.  This could, for example, be used to allow a single
set of getter and setter functions that decide the attribute to get or
set based on data in the closure.)

The setter function is passed the ‘Custom’ object, the new value, and
the closure.  The new value may be ‘NULL’, in which case the attribute
is being deleted.  In our setter, we raise an error if the attribute is
deleted or if its new value is not a string.

We create an array of *note PyGetSetDef: 41c. structures:

     static PyGetSetDef Custom_getsetters[] = {     {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,      "first name", NULL},     {"last", (getter) Custom_getlast, (setter) Custom_setlast,      "last name", NULL},     {NULL}  /* Sentinel */ };

and register it in the *note tp_getset: 3a8e. slot:

     .tp_getset = Custom_getsetters,

The last item in a *note PyGetSetDef: 41c. structure is the “closure”
mentioned above.  In this case, we aren’t using a closure, so we just
pass ‘NULL’.

We also remove the member definitions for these attributes:

     static PyMemberDef Custom_members[] = {     {"number", T_INT, offsetof(CustomObject, number), 0,      "custom number"},     {NULL}  /* Sentinel */ };

We also need to update the *note tp_init: 3a87. handler to only allow
strings (1) to be passed:

     static int Custom_init(CustomObject *self, PyObject *args, PyObject *kwds) {     static char *kwlist[] = {"first", "last", "number", NULL};     PyObject *first = NULL, *last = NULL, *tmp;      if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,                                      &first, &last,                                      &self->number))         return -1;      if (first) {         tmp = self->first;         Py_INCREF(first);         self->first = first;         Py_DECREF(tmp);     }     if (last) {         tmp = self->last;         Py_INCREF(last);         self->last = last;         Py_DECREF(tmp);     }     return 0; }

With these changes, we can assure that the ‘first’ and ‘last’ members
are never ‘NULL’ so we can remove checks for ‘NULL’ values in almost all
cases.  This means that most of the *note Py_XDECREF(): 266. calls can
be converted to *note Py_DECREF(): 264. calls.  The only place we can’t
change these calls is in the ‘tp_dealloc’ implementation, where there is
the possibility that the initialization of these members failed in
‘tp_new’.

We also rename the module initialization function and module name in the
initialization function, as we did before, and we add an extra
definition to the ‘setup.py’ file.

   ---------- Footnotes ----------

   (1) (3) We now know that the first and last members are strings, so
perhaps we could be less careful about decrementing their reference
counts, however, we accept instances of string subclasses.  Even though
deallocating normal strings won’t call back into our objects, we can’t
guarantee that deallocating an instance of a string subclass won’t call
back into our objects.


File: python.info,  Node: Supporting cyclic garbage collection,  Next: Subclassing other types,  Prev: Providing finer control over data attributes,  Up: Defining Extension Types Tutorial

6.2.2.4 Supporting cyclic garbage collection
............................................

Python has a *note cyclic garbage collector (GC): 1243. that can
identify unneeded objects even when their reference counts are not zero.
This can happen when objects are involved in cycles.  For example,
consider:

     >>> l = [] >>> l.append(l) >>> del l

In this example, we create a list that contains itself.  When we delete
it, it still has a reference from itself.  Its reference count doesn’t
drop to zero.  Fortunately, Python’s cyclic garbage collector will
eventually figure out that the list is garbage and free it.

In the second version of the ‘Custom’ example, we allowed any kind of
object to be stored in the ‘first’ or ‘last’ attributes (1).  Besides,
in the second and third versions, we allowed subclassing ‘Custom’, and
subclasses may add arbitrary attributes.  For any of those two reasons,
‘Custom’ objects can participate in cycles:

     >>> import custom3 >>> class Derived(custom3.Custom): pass ... >>> n = Derived() >>> n.some_attribute = n

To allow a ‘Custom’ instance participating in a reference cycle to be
properly detected and collected by the cyclic GC, our ‘Custom’ type
needs to fill two additional slots and to enable a flag that enables
these slots:

     #define PY_SSIZE_T_CLEAN #include <Python.h> #include "structmember.h"  typedef struct {     PyObject_HEAD     PyObject *first; /* first name */     PyObject *last;  /* last name */     int number; } CustomObject;  static int Custom_traverse(CustomObject *self, visitproc visit, void *arg) {     Py_VISIT(self->first);     Py_VISIT(self->last);     return 0; }  static int Custom_clear(CustomObject *self) {     Py_CLEAR(self->first);     Py_CLEAR(self->last);     return 0; }  static void Custom_dealloc(CustomObject *self) {     PyObject_GC_UnTrack(self);     Custom_clear(self);     Py_TYPE(self)->tp_free((PyObject *) self); }  static PyObject * Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds) {     CustomObject *self;     self = (CustomObject *) type->tp_alloc(type, 0);     if (self != NULL) {         self->first = PyUnicode_FromString("");         if (self->first == NULL) {             Py_DECREF(self);             return NULL;         }         self->last = PyUnicode_FromString("");         if (self->last == NULL) {             Py_DECREF(self);             return NULL;         }         self->number = 0;     }     return (PyObject *) self; }  static int Custom_init(CustomObject *self, PyObject *args, PyObject *kwds) {     static char *kwlist[] = {"first", "last", "number", NULL};     PyObject *first = NULL, *last = NULL, *tmp;      if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,                                      &first, &last,                                      &self->number))         return -1;      if (first) {         tmp = self->first;         Py_INCREF(first);         self->first = first;         Py_DECREF(tmp);     }     if (last) {         tmp = self->last;         Py_INCREF(last);         self->last = last;         Py_DECREF(tmp);     }     return 0; }  static PyMemberDef Custom_members[] = {     {"number", T_INT, offsetof(CustomObject, number), 0,      "custom number"},     {NULL}  /* Sentinel */ };  static PyObject * Custom_getfirst(CustomObject *self, void *closure) {     Py_INCREF(self->first);     return self->first; }  static int Custom_setfirst(CustomObject *self, PyObject *value, void *closure) {     if (value == NULL) {         PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");         return -1;     }     if (!PyUnicode_Check(value)) {         PyErr_SetString(PyExc_TypeError,                         "The first attribute value must be a string");         return -1;     }     Py_INCREF(value);     Py_CLEAR(self->first);     self->first = value;     return 0; }  static PyObject * Custom_getlast(CustomObject *self, void *closure) {     Py_INCREF(self->last);     return self->last; }  static int Custom_setlast(CustomObject *self, PyObject *value, void *closure) {     if (value == NULL) {         PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");         return -1;     }     if (!PyUnicode_Check(value)) {         PyErr_SetString(PyExc_TypeError,                         "The last attribute value must be a string");         return -1;     }     Py_INCREF(value);     Py_CLEAR(self->last);     self->last = value;     return 0; }  static PyGetSetDef Custom_getsetters[] = {     {"first", (getter) Custom_getfirst, (setter) Custom_setfirst,      "first name", NULL},     {"last", (getter) Custom_getlast, (setter) Custom_setlast,      "last name", NULL},     {NULL}  /* Sentinel */ };  static PyObject * Custom_name(CustomObject *self, PyObject *Py_UNUSED(ignored)) {     return PyUnicode_FromFormat("%S %S", self->first, self->last); }  static PyMethodDef Custom_methods[] = {     {"name", (PyCFunction) Custom_name, METH_NOARGS,      "Return the name, combining the first and last name"     },     {NULL}  /* Sentinel */ };  static PyTypeObject CustomType = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "custom4.Custom",     .tp_doc = "Custom objects",     .tp_basicsize = sizeof(CustomObject),     .tp_itemsize = 0,     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,     .tp_new = Custom_new,     .tp_init = (initproc) Custom_init,     .tp_dealloc = (destructor) Custom_dealloc,     .tp_traverse = (traverseproc) Custom_traverse,     .tp_clear = (inquiry) Custom_clear,     .tp_members = Custom_members,     .tp_methods = Custom_methods,     .tp_getset = Custom_getsetters, };  static PyModuleDef custommodule = {     PyModuleDef_HEAD_INIT,     .m_name = "custom4",     .m_doc = "Example module that creates an extension type.",     .m_size = -1, };  PyMODINIT_FUNC PyInit_custom4(void) {     PyObject *m;     if (PyType_Ready(&CustomType) < 0)         return NULL;      m = PyModule_Create(&custommodule);     if (m == NULL)         return NULL;      Py_INCREF(&CustomType);     if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {         Py_DECREF(&CustomType);         Py_DECREF(m);         return NULL;     }      return m; }

First, the traversal method lets the cyclic GC know about subobjects
that could participate in cycles:

     static int Custom_traverse(CustomObject *self, visitproc visit, void *arg) {     int vret;     if (self->first) {         vret = visit(self->first, arg);         if (vret != 0)             return vret;     }     if (self->last) {         vret = visit(self->last, arg);         if (vret != 0)             return vret;     }     return 0; }

For each subobject that can participate in cycles, we need to call the
‘visit()’ function, which is passed to the traversal method.  The
‘visit()’ function takes as arguments the subobject and the extra
argument `arg' passed to the traversal method.  It returns an integer
value that must be returned if it is non-zero.

Python provides a *note Py_VISIT(): 3a90. macro that automates calling
visit functions.  With *note Py_VISIT(): 3a90, we can minimize the
amount of boilerplate in ‘Custom_traverse’:

     static int Custom_traverse(CustomObject *self, visitproc visit, void *arg) {     Py_VISIT(self->first);     Py_VISIT(self->last);     return 0; }

     Note: The *note tp_traverse: 35fa. implementation must name its
     arguments exactly `visit' and `arg' in order to use *note
     Py_VISIT(): 3a90.

Second, we need to provide a method for clearing any subobjects that can
participate in cycles:

     static int Custom_clear(CustomObject *self) {     Py_CLEAR(self->first);     Py_CLEAR(self->last);     return 0; }

Notice the use of the *note Py_CLEAR(): 3a91. macro.  It is the
recommended and safe way to clear data attributes of arbitrary types
while decrementing their reference counts.  If you were to call *note
Py_XDECREF(): 266. instead on the attribute before setting it to ‘NULL’,
there is a possibility that the attribute’s destructor would call back
into code that reads the attribute again (`especially' if there is a
reference cycle).

     Note: You could emulate *note Py_CLEAR(): 3a91. by writing:

          PyObject *tmp; tmp = self->first; self->first = NULL; Py_XDECREF(tmp);

     Nevertheless, it is much easier and less error-prone to always use
     *note Py_CLEAR(): 3a91. when deleting an attribute.  Don’t try to
     micro-optimize at the expense of robustness!

The deallocator ‘Custom_dealloc’ may call arbitrary code when clearing
attributes.  It means the circular GC can be triggered inside the
function.  Since the GC assumes reference count is not zero, we need to
untrack the object from the GC by calling *note PyObject_GC_UnTrack():
e38. before clearing members.  Here is our reimplemented deallocator
using *note PyObject_GC_UnTrack(): e38. and ‘Custom_clear’:

     static void Custom_dealloc(CustomObject *self) {     PyObject_GC_UnTrack(self);     Custom_clear(self);     Py_TYPE(self)->tp_free((PyObject *) self); }

Finally, we add the *note Py_TPFLAGS_HAVE_GC: 3a92. flag to the class
flags:

     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,

That’s pretty much it.  If we had written custom *note tp_alloc: 3a85.
or *note tp_free: 3a84. handlers, we’d need to modify them for cyclic
garbage collection.  Most extensions will use the versions automatically
provided.

   ---------- Footnotes ----------

   (1) (4) Also, even with our attributes restricted to strings
instances, the user could pass arbitrary *note str: 325. subclasses and
therefore still create reference cycles.


File: python.info,  Node: Subclassing other types,  Prev: Supporting cyclic garbage collection,  Up: Defining Extension Types Tutorial

6.2.2.5 Subclassing other types
...............................

It is possible to create new extension types that are derived from
existing types.  It is easiest to inherit from the built in types, since
an extension can easily use the *note PyTypeObject: 2d4. it needs.  It
can be difficult to share these *note PyTypeObject: 2d4. structures
between extension modules.

In this example we will create a ‘SubList’ type that inherits from the
built-in *note list: 260. type.  The new type will be completely
compatible with regular lists, but will have an additional ‘increment()’
method that increases an internal counter:

     >>> import sublist >>> s = sublist.SubList(range(3)) >>> s.extend(s) >>> print(len(s)) 6 >>> print(s.increment()) 1 >>> print(s.increment()) 2

     #define PY_SSIZE_T_CLEAN #include <Python.h>  typedef struct {     PyListObject list;     int state; } SubListObject;  static PyObject * SubList_increment(SubListObject *self, PyObject *unused) {     self->state++;     return PyLong_FromLong(self->state); }  static PyMethodDef SubList_methods[] = {     {"increment", (PyCFunction) SubList_increment, METH_NOARGS,      PyDoc_STR("increment state counter")},     {NULL}, };  static int SubList_init(SubListObject *self, PyObject *args, PyObject *kwds) {     if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)         return -1;     self->state = 0;     return 0; }  static PyTypeObject SubListType = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "sublist.SubList",     .tp_doc = "SubList objects",     .tp_basicsize = sizeof(SubListObject),     .tp_itemsize = 0,     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,     .tp_init = (initproc) SubList_init,     .tp_methods = SubList_methods, };  static PyModuleDef sublistmodule = {     PyModuleDef_HEAD_INIT,     .m_name = "sublist",     .m_doc = "Example module that creates an extension type.",     .m_size = -1, };  PyMODINIT_FUNC PyInit_sublist(void) {     PyObject *m;     SubListType.tp_base = &PyList_Type;     if (PyType_Ready(&SubListType) < 0)         return NULL;      m = PyModule_Create(&sublistmodule);     if (m == NULL)         return NULL;      Py_INCREF(&SubListType);     if (PyModule_AddObject(m, "SubList", (PyObject *) &SubListType) < 0) {         Py_DECREF(&SubListType);         Py_DECREF(m);         return NULL;     }      return m; }

As you can see, the source code closely resembles the ‘Custom’ examples
in previous sections.  We will break down the main differences between
them.

     typedef struct {     PyListObject list;     int state; } SubListObject;

The primary difference for derived type objects is that the base type’s
object structure must be the first value.  The base type will already
include the *note PyObject_HEAD(): c65. at the beginning of its
structure.

When a Python object is a ‘SubList’ instance, its ‘PyObject *’ pointer
can be safely cast to both ‘PyListObject *’ and ‘SubListObject *’:

     static int SubList_init(SubListObject *self, PyObject *args, PyObject *kwds) {     if (PyList_Type.tp_init((PyObject *) self, args, kwds) < 0)         return -1;     self->state = 0;     return 0; }

We see above how to call through to the ‘__init__’ method of the base
type.

This pattern is important when writing a type with custom *note tp_new:
3a80. and *note tp_dealloc: 3a83. members.  The *note tp_new: 3a80.
handler should not actually create the memory for the object with its
*note tp_alloc: 3a85, but let the base class handle it by calling its
own *note tp_new: 3a80.

The *note PyTypeObject: 2d4. struct supports a *note tp_base: 3a94.
specifying the type’s concrete base class.  Due to cross-platform
compiler issues, you can’t fill that field directly with a reference to
*note PyList_Type: 3a95.; it should be done later in the module
initialization function:

     PyMODINIT_FUNC PyInit_sublist(void) {     PyObject* m;     SubListType.tp_base = &PyList_Type;     if (PyType_Ready(&SubListType) < 0)         return NULL;      m = PyModule_Create(&sublistmodule);     if (m == NULL)         return NULL;      Py_INCREF(&SubListType);     if (PyModule_AddObject(m, "SubList", (PyObject *) &SubListType) < 0) {         Py_DECREF(&SubListType);         Py_DECREF(m);         return NULL;     }      return m; }

Before calling *note PyType_Ready(): 3a86, the type structure must have
the *note tp_base: 3a94. slot filled in.  When we are deriving an
existing type, it is not necessary to fill out the *note tp_alloc: 3a85.
slot with *note PyType_GenericNew(): 3a81. – the allocation function
from the base type will be inherited.

After that, calling *note PyType_Ready(): 3a86. and adding the type
object to the module is the same as with the basic ‘Custom’ examples.


File: python.info,  Node: Defining Extension Types Assorted Topics,  Next: Building C and C++ Extensions,  Prev: Defining Extension Types Tutorial,  Up: Creating extensions without third party tools

6.2.3 Defining Extension Types: Assorted Topics
-----------------------------------------------

This section aims to give a quick fly-by on the various type methods you
can implement and what they do.

Here is the definition of *note PyTypeObject: 2d4, with some fields only
used in debug builds omitted:

     typedef struct _typeobject {     PyObject_VAR_HEAD     const char *tp_name; /* For printing, in format "<module>.<name>" */     Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */      /* Methods to implement standard operations */      destructor tp_dealloc;     Py_ssize_t tp_vectorcall_offset;     getattrfunc tp_getattr;     setattrfunc tp_setattr;     PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)                                     or tp_reserved (Python 3) */     reprfunc tp_repr;      /* Method suites for standard classes */      PyNumberMethods *tp_as_number;     PySequenceMethods *tp_as_sequence;     PyMappingMethods *tp_as_mapping;      /* More standard operations (here for binary compatibility) */      hashfunc tp_hash;     ternaryfunc tp_call;     reprfunc tp_str;     getattrofunc tp_getattro;     setattrofunc tp_setattro;      /* Functions to access object as input/output buffer */     PyBufferProcs *tp_as_buffer;      /* Flags to define presence of optional/expanded features */     unsigned long tp_flags;      const char *tp_doc; /* Documentation string */      /* call function for all accessible objects */     traverseproc tp_traverse;      /* delete references to contained objects */     inquiry tp_clear;      /* rich comparisons */     richcmpfunc tp_richcompare;      /* weak reference enabler */     Py_ssize_t tp_weaklistoffset;      /* Iterators */     getiterfunc tp_iter;     iternextfunc tp_iternext;      /* Attribute descriptor and subclassing stuff */     struct PyMethodDef *tp_methods;     struct PyMemberDef *tp_members;     struct PyGetSetDef *tp_getset;     struct _typeobject *tp_base;     PyObject *tp_dict;     descrgetfunc tp_descr_get;     descrsetfunc tp_descr_set;     Py_ssize_t tp_dictoffset;     initproc tp_init;     allocfunc tp_alloc;     newfunc tp_new;     freefunc tp_free; /* Low-level free-memory routine */     inquiry tp_is_gc; /* For PyObject_IS_GC */     PyObject *tp_bases;     PyObject *tp_mro; /* method resolution order */     PyObject *tp_cache;     PyObject *tp_subclasses;     PyObject *tp_weaklist;     destructor tp_del;      /* Type attribute cache version tag. Added in version 2.6 */     unsigned int tp_version_tag;      destructor tp_finalize;  } PyTypeObject;

Now that’s a `lot' of methods.  Don’t worry too much though – if you
have a type you want to define, the chances are very good that you will
only implement a handful of these.

As you probably expect by now, we’re going to go over this and give more
information about the various handlers.  We won’t go in the order they
are defined in the structure, because there is a lot of historical
baggage that impacts the ordering of the fields.  It’s often easiest to
find an example that includes the fields you need and then change the
values to suit your new type.

     const char *tp_name; /* For printing */

The name of the type – as mentioned in the previous chapter, this will
appear in various places, almost entirely for diagnostic purposes.  Try
to choose something that will be helpful in such a situation!

     Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */

These fields tell the runtime how much memory to allocate when new
objects of this type are created.  Python has some built-in support for
variable length structures (think: strings, tuples) which is where the
*note tp_itemsize: 3a7c. field comes in.  This will be dealt with later.

     const char *tp_doc;

Here you can put a string (or its address) that you want returned when
the Python script references ‘obj.__doc__’ to retrieve the doc string.

Now we come to the basic type methods – the ones most extension types
will implement.

* Menu:

* Finalization and De-allocation::
* Object Presentation::
* Attribute Management::
* Object Comparison::
* Abstract Protocol Support::
* Weak Reference Support::
* More Suggestions::


File: python.info,  Node: Finalization and De-allocation,  Next: Object Presentation,  Up: Defining Extension Types Assorted Topics

6.2.3.1 Finalization and De-allocation
......................................

     destructor tp_dealloc;

This function is called when the reference count of the instance of your
type is reduced to zero and the Python interpreter wants to reclaim it.
If your type has memory to free or other clean-up to perform, you can
put it here.  The object itself needs to be freed here as well.  Here is
an example of this function:

     static void newdatatype_dealloc(newdatatypeobject *obj) {     free(obj->obj_UnderlyingDatatypePtr);     Py_TYPE(obj)->tp_free(obj); }

One important requirement of the deallocator function is that it leaves
any pending exceptions alone.  This is important since deallocators are
frequently called as the interpreter unwinds the Python stack; when the
stack is unwound due to an exception (rather than normal returns),
nothing is done to protect the deallocators from seeing that an
exception has already been set.  Any actions which a deallocator
performs which may cause additional Python code to be executed may
detect that an exception has been set.  This can lead to misleading
errors from the interpreter.  The proper way to protect against this is
to save a pending exception before performing the unsafe action, and
restoring it when done.  This can be done using the *note PyErr_Fetch():
95e. and *note PyErr_Restore(): 3a9b. functions:

     static void my_dealloc(PyObject *obj) {     MyObject *self = (MyObject *) obj;     PyObject *cbresult;      if (self->my_callback != NULL) {         PyObject *err_type, *err_value, *err_traceback;          /* This saves the current exception state */         PyErr_Fetch(&err_type, &err_value, &err_traceback);          cbresult = PyObject_CallObject(self->my_callback, NULL);         if (cbresult == NULL)             PyErr_WriteUnraisable(self->my_callback);         else             Py_DECREF(cbresult);          /* This restores the saved exception state */         PyErr_Restore(err_type, err_value, err_traceback);          Py_DECREF(self->my_callback);     }     Py_TYPE(obj)->tp_free((PyObject*)self); }

     Note: There are limitations to what you can safely do in a
     deallocator function.  First, if your type supports garbage
     collection (using *note tp_traverse: 35fa. and/or *note tp_clear:
     3a9c.), some of the object’s members can have been cleared or
     finalized by the time *note tp_dealloc: 3a83. is called.  Second,
     in *note tp_dealloc: 3a83, your object is in an unstable state: its
     reference count is equal to zero.  Any call to a non-trivial object
     or API (as in the example above) might end up calling *note
     tp_dealloc: 3a83. again, causing a double free and a crash.

     Starting with Python 3.4, it is recommended not to put any complex
     finalization code in *note tp_dealloc: 3a83, and instead use the
     new *note tp_finalize: 2d5. type method.

     See also
     ........

     PEP 442(1) explains the new finalization scheme.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0442


File: python.info,  Node: Object Presentation,  Next: Attribute Management,  Prev: Finalization and De-allocation,  Up: Defining Extension Types Assorted Topics

6.2.3.2 Object Presentation
...........................

In Python, there are two ways to generate a textual representation of an
object: the *note repr(): 7c0. function, and the *note str(): 325.
function.  (The *note print(): 87a. function just calls *note str():
325.)  These handlers are both optional.

     reprfunc tp_repr; reprfunc tp_str;

The *note tp_repr: 3a9e. handler should return a string object
containing a representation of the instance for which it is called.
Here is a simple example:

     static PyObject * newdatatype_repr(newdatatypeobject * obj) {     return PyUnicode_FromFormat("Repr-ified_newdatatype{{size:%d}}",                                 obj->obj_UnderlyingDatatypePtr->size); }

If no *note tp_repr: 3a9e. handler is specified, the interpreter will
supply a representation that uses the type’s *note tp_name: 3a9f. and a
uniquely-identifying value for the object.

The *note tp_str: 3aa0. handler is to *note str(): 325. what the *note
tp_repr: 3a9e. handler described above is to *note repr(): 7c0.; that
is, it is called when Python code calls *note str(): 325. on an instance
of your object.  Its implementation is very similar to the *note
tp_repr: 3a9e. function, but the resulting string is intended for human
consumption.  If *note tp_str: 3aa0. is not specified, the *note
tp_repr: 3a9e. handler is used instead.

Here is a simple example:

     static PyObject * newdatatype_str(newdatatypeobject * obj) {     return PyUnicode_FromFormat("Stringified_newdatatype{{size:%d}}",                                 obj->obj_UnderlyingDatatypePtr->size); }


File: python.info,  Node: Attribute Management,  Next: Object Comparison,  Prev: Object Presentation,  Up: Defining Extension Types Assorted Topics

6.2.3.3 Attribute Management
............................

For every object which can support attributes, the corresponding type
must provide the functions that control how the attributes are resolved.
There needs to be a function which can retrieve attributes (if any are
defined), and another to set attributes (if setting attributes is
allowed).  Removing an attribute is a special case, for which the new
value passed to the handler is ‘NULL’.

Python supports two pairs of attribute handlers; a type that supports
attributes only needs to implement the functions for one pair.  The
difference is that one pair takes the name of the attribute as a
‘char*’, while the other accepts a *note PyObject*: 4b0.  Each type can
use whichever pair makes more sense for the implementation’s
convenience.

     getattrfunc  tp_getattr;        /* char * version */ setattrfunc  tp_setattr; /* ... */ getattrofunc tp_getattro;       /* PyObject * version */ setattrofunc tp_setattro;

If accessing attributes of an object is always a simple operation (this
will be explained shortly), there are generic implementations which can
be used to provide the *note PyObject*: 4b0. version of the attribute
management functions.  The actual need for type-specific attribute
handlers almost completely disappeared starting with Python 2.2, though
there are many examples which have not been updated to use some of the
new generic mechanism that is available.

* Menu:

* Generic Attribute Management::
* Type-specific Attribute Management::


File: python.info,  Node: Generic Attribute Management,  Next: Type-specific Attribute Management,  Up: Attribute Management

6.2.3.4 Generic Attribute Management
....................................

Most extension types only use `simple' attributes.  So, what makes the
attributes simple?  There are only a couple of conditions that must be
met:

  1. The name of the attributes must be known when *note PyType_Ready():
     3a86. is called.

  2. No special processing is needed to record that an attribute was
     looked up or set, nor do actions need to be taken based on the
     value.

Note that this list does not place any restrictions on the values of the
attributes, when the values are computed, or how relevant data is
stored.

When *note PyType_Ready(): 3a86. is called, it uses three tables
referenced by the type object to create *note descriptor: 1541.s which
are placed in the dictionary of the type object.  Each descriptor
controls access to one attribute of the instance object.  Each of the
tables is optional; if all three are ‘NULL’, instances of the type will
only have attributes that are inherited from their base type, and should
leave the *note tp_getattro: 3aa3. and *note tp_setattro: 3aa4. fields
‘NULL’ as well, allowing the base type to handle attributes.

The tables are declared as three fields of the type object:

     struct PyMethodDef *tp_methods; struct PyMemberDef *tp_members; struct PyGetSetDef *tp_getset;

If *note tp_methods: 3a8a. is not ‘NULL’, it must refer to an array of
*note PyMethodDef: e0e. structures.  Each entry in the table is an
instance of this structure:

     typedef struct PyMethodDef {     const char  *ml_name;       /* method name */     PyCFunction  ml_meth;       /* implementation function */     int          ml_flags;      /* flags */     const char  *ml_doc;        /* docstring */ } PyMethodDef;

One entry should be defined for each method provided by the type; no
entries are needed for methods inherited from a base type.  One
additional entry is needed at the end; it is a sentinel that marks the
end of the array.  The ‘ml_name’ field of the sentinel must be ‘NULL’.

The second table is used to define attributes which map directly to data
stored in the instance.  A variety of primitive C types are supported,
and access may be read-only or read-write.  The structures in the table
are defined as:

     typedef struct PyMemberDef {     const char *name;     int         type;     int         offset;     int         flags;     const char *doc; } PyMemberDef;

For each entry in the table, a *note descriptor: 1541. will be
constructed and added to the type which will be able to extract a value
from the instance structure.  The *note type: 5fd. field should contain
one of the type codes defined in the ‘structmember.h’ header; the value
will be used to determine how to convert Python values to and from C
values.  The ‘flags’ field is used to store flags which control how the
attribute can be accessed.

The following flag constants are defined in ‘structmember.h’; they may
be combined using bitwise-OR.

Constant                        Meaning
                                
-----------------------------------------------------------------------------------
                                
‘READONLY’                      Never writable.
                                
                                
‘READ_RESTRICTED’               Not readable in restricted mode.
                                
                                
‘WRITE_RESTRICTED’              Not writable in restricted mode.
                                
                                
‘RESTRICTED’                    Not readable or writable in restricted mode.
                                

An interesting advantage of using the *note tp_members: 3a88. table to
build descriptors that are used at runtime is that any attribute defined
this way can have an associated doc string simply by providing the text
in the table.  An application can use the introspection API to retrieve
the descriptor from the class object, and get the doc string using its
‘__doc__’ attribute.

As with the *note tp_methods: 3a8a. table, a sentinel entry with a
‘name’ value of ‘NULL’ is required.


File: python.info,  Node: Type-specific Attribute Management,  Prev: Generic Attribute Management,  Up: Attribute Management

6.2.3.5 Type-specific Attribute Management
..........................................

For simplicity, only the ‘char*’ version will be demonstrated here; the
type of the name parameter is the only difference between the ‘char*’
and *note PyObject*: 4b0. flavors of the interface.  This example
effectively does the same thing as the generic example above, but does
not use the generic support added in Python 2.2.  It explains how the
handler functions are called, so that if you do need to extend their
functionality, you’ll understand what needs to be done.

The *note tp_getattr: 3aa6. handler is called when the object requires
an attribute look-up.  It is called in the same situations where the
*note __getattr__(): 30f. method of a class would be called.

Here is an example:

     static PyObject * newdatatype_getattr(newdatatypeobject *obj, char *name) {     if (strcmp(name, "data") == 0)     {         return PyLong_FromLong(obj->data);     }      PyErr_Format(PyExc_AttributeError,                  "'%.50s' object has no attribute '%.400s'",                  tp->tp_name, name);     return NULL; }

The *note tp_setattr: 3aa7. handler is called when the *note
__setattr__(): e1f. or *note __delattr__(): 136c. method of a class
instance would be called.  When an attribute should be deleted, the
third parameter will be ‘NULL’.  Here is an example that simply raises
an exception; if this were really all you wanted, the *note tp_setattr:
3aa7. handler should be set to ‘NULL’.

     static int newdatatype_setattr(newdatatypeobject *obj, char *name, PyObject *v) {     PyErr_Format(PyExc_RuntimeError, "Read-only attribute: %s", name);     return -1; }


File: python.info,  Node: Object Comparison,  Next: Abstract Protocol Support,  Prev: Attribute Management,  Up: Defining Extension Types Assorted Topics

6.2.3.6 Object Comparison
.........................

     richcmpfunc tp_richcompare;

The *note tp_richcompare: 3aa9. handler is called when comparisons are
needed.  It is analogous to the *note rich comparison methods: 1374,
like *note __lt__(): c27, and also called by *note
PyObject_RichCompare(): 3aaa. and *note PyObject_RichCompareBool():
3aab.

This function is called with two Python objects and the operator as
arguments, where the operator is one of ‘Py_EQ’, ‘Py_NE’, ‘Py_LE’,
‘Py_GT’, ‘Py_LT’ or ‘Py_GT’.  It should compare the two objects with
respect to the specified operator and return ‘Py_True’ or ‘Py_False’ if
the comparison is successful, ‘Py_NotImplemented’ to indicate that
comparison is not implemented and the other object’s comparison method
should be tried, or ‘NULL’ if an exception was set.

Here is a sample implementation, for a datatype that is considered equal
if the size of an internal pointer is equal:

     static PyObject * newdatatype_richcmp(PyObject *obj1, PyObject *obj2, int op) {     PyObject *result;     int c, size1, size2;      /* code to make sure that both arguments are of type        newdatatype omitted */      size1 = obj1->obj_UnderlyingDatatypePtr->size;     size2 = obj2->obj_UnderlyingDatatypePtr->size;      switch (op) {     case Py_LT: c = size1 <  size2; break;     case Py_LE: c = size1 <= size2; break;     case Py_EQ: c = size1 == size2; break;     case Py_NE: c = size1 != size2; break;     case Py_GT: c = size1 >  size2; break;     case Py_GE: c = size1 >= size2; break;     }     result = c ? Py_True : Py_False;     Py_INCREF(result);     return result;  }


File: python.info,  Node: Abstract Protocol Support,  Next: Weak Reference Support,  Prev: Object Comparison,  Up: Defining Extension Types Assorted Topics

6.2.3.7 Abstract Protocol Support
.................................

Python supports a variety of `abstract' ‘protocols;’ the specific
interfaces provided to use these interfaces are documented in *note
Abstract Objects Layer: 3aad.

A number of these abstract interfaces were defined early in the
development of the Python implementation.  In particular, the number,
mapping, and sequence protocols have been part of Python since the
beginning.  Other protocols have been added over time.  For protocols
which depend on several handler routines from the type implementation,
the older protocols have been defined as optional blocks of handlers
referenced by the type object.  For newer protocols there are additional
slots in the main type object, with a flag bit being set to indicate
that the slots are present and should be checked by the interpreter.
(The flag bit does not indicate that the slot values are non-‘NULL’.
The flag may be set to indicate the presence of a slot, but a slot may
still be unfilled.)

     PyNumberMethods   *tp_as_number; PySequenceMethods *tp_as_sequence; PyMappingMethods  *tp_as_mapping;

If you wish your object to be able to act like a number, a sequence, or
a mapping object, then you place the address of a structure that
implements the C type *note PyNumberMethods: d74, *note
PySequenceMethods: 3aae, or *note PyMappingMethods: 3aaf, respectively.
It is up to you to fill in this structure with appropriate values.  You
can find examples of the use of each of these in the ‘Objects’ directory
of the Python source distribution.

     hashfunc tp_hash;

This function, if you choose to provide it, should return a hash number
for an instance of your data type.  Here is a simple example:

     static Py_hash_t newdatatype_hash(newdatatypeobject *obj) {     Py_hash_t result;     result = obj->some_size + 32767 * obj->some_number;     if (result == -1)        result = -2;     return result; }

‘Py_hash_t’ is a signed integer type with a platform-varying width.
Returning ‘-1’ from *note tp_hash: 3ab0. indicates an error, which is
why you should be careful to avoid returning it when hash computation is
successful, as seen above.

     ternaryfunc tp_call;

This function is called when an instance of your data type is “called”,
for example, if ‘obj1’ is an instance of your data type and the Python
script contains ‘obj1('hello')’, the *note tp_call: 3ab1. handler is
invoked.

This function takes three arguments:

  1. `self' is the instance of the data type which is the subject of the
     call.  If the call is ‘obj1('hello')’, then `self' is ‘obj1’.

  2. `args' is a tuple containing the arguments to the call.  You can
     use *note PyArg_ParseTuple(): 268. to extract the arguments.

  3. `kwds' is a dictionary of keyword arguments that were passed.  If
     this is non-‘NULL’ and you support keyword arguments, use *note
     PyArg_ParseTupleAndKeywords(): 5bf. to extract the arguments.  If
     you do not want to support keyword arguments and this is
     non-‘NULL’, raise a *note TypeError: 192. with a message saying
     that keyword arguments are not supported.

Here is a toy ‘tp_call’ implementation:

     static PyObject * newdatatype_call(newdatatypeobject *self, PyObject *args, PyObject *kwds) {     PyObject *result;     const char *arg1;     const char *arg2;     const char *arg3;      if (!PyArg_ParseTuple(args, "sss:call", &arg1, &arg2, &arg3)) {         return NULL;     }     result = PyUnicode_FromFormat(         "Returning -- value: [%d] arg1: [%s] arg2: [%s] arg3: [%s]\n",         obj->obj_UnderlyingDatatypePtr->size,         arg1, arg2, arg3);     return result; }

     /* Iterators */ getiterfunc tp_iter; iternextfunc tp_iternext;

These functions provide support for the iterator protocol.  Both
handlers take exactly one parameter, the instance for which they are
being called, and return a new reference.  In the case of an error, they
should set an exception and return ‘NULL’.  *note tp_iter: e23.
corresponds to the Python *note __iter__(): 504. method, while *note
tp_iternext: e24. corresponds to the Python *note __next__(): c57.
method.

Any *note iterable: b9f. object must implement the *note tp_iter: e23.
handler, which must return an *note iterator: f73. object.  Here the
same guidelines apply as for Python classes:

   * For collections (such as lists and tuples) which can support
     multiple independent iterators, a new iterator should be created
     and returned by each call to *note tp_iter: e23.

   * Objects which can only be iterated over once (usually due to side
     effects of iteration, such as file objects) can implement *note
     tp_iter: e23. by returning a new reference to themselves – and
     should also therefore implement the *note tp_iternext: e24.
     handler.

Any *note iterator: f73. object should implement both *note tp_iter:
e23. and *note tp_iternext: e24.  An iterator’s *note tp_iter: e23.
handler should return a new reference to the iterator.  Its *note
tp_iternext: e24. handler should return a new reference to the next
object in the iteration, if there is one.  If the iteration has reached
the end, *note tp_iternext: e24. may return ‘NULL’ without setting an
exception, or it may set *note StopIteration: 47b. `in addition' to
returning ‘NULL’; avoiding the exception can yield slightly better
performance.  If an actual error occurs, *note tp_iternext: e24. should
always set an exception and return ‘NULL’.


File: python.info,  Node: Weak Reference Support,  Next: More Suggestions,  Prev: Abstract Protocol Support,  Up: Defining Extension Types Assorted Topics

6.2.3.8 Weak Reference Support
..............................

One of the goals of Python’s weak reference implementation is to allow
any type to participate in the weak reference mechanism without
incurring the overhead on performance-critical objects (such as
numbers).

See also
........

Documentation for the *note weakref: 128. module.

For an object to be weakly referencable, the extension type must do two
things:

  1. Include a *note PyObject*: 4b0. field in the C object structure
     dedicated to the weak reference mechanism.  The object’s
     constructor should leave it ‘NULL’ (which is automatic when using
     the default *note tp_alloc: 3a85.).

  2. Set the *note tp_weaklistoffset: 3ab3. type member to the offset of
     the aforementioned field in the C object structure, so that the
     interpreter knows how to access and modify that field.

Concretely, here is how a trivial object structure would be augmented
with the required field:

     typedef struct {     PyObject_HEAD     PyObject *weakreflist;  /* List of weak references */ } TrivialObject;

And the corresponding member in the statically-declared type object:

     static PyTypeObject TrivialType = {     PyVarObject_HEAD_INIT(NULL, 0)     /* ... other members omitted for brevity ... */     .tp_weaklistoffset = offsetof(TrivialObject, weakreflist), };

The only further addition is that ‘tp_dealloc’ needs to clear any weak
references (by calling ‘PyObject_ClearWeakRefs()’) if the field is
non-‘NULL’:

     static void Trivial_dealloc(TrivialObject *self) {     /* Clear weakrefs first before calling any destructors */     if (self->weakreflist != NULL)         PyObject_ClearWeakRefs((PyObject *) self);     /* ... remainder of destruction code omitted for brevity ... */     Py_TYPE(self)->tp_free((PyObject *) self); }


File: python.info,  Node: More Suggestions,  Prev: Weak Reference Support,  Up: Defining Extension Types Assorted Topics

6.2.3.9 More Suggestions
........................

In order to learn how to implement any specific method for your new data
type, get the *note CPython: 1372. source code.  Go to the ‘Objects’
directory, then search the C source files for ‘tp_’ plus the function
you want (for example, ‘tp_richcompare’).  You will find examples of the
function you want to implement.

When you need to verify that an object is a concrete instance of the
type you are implementing, use the *note PyObject_TypeCheck(): 3ab5.
function.  A sample of its use might be something like the following:

     if (!PyObject_TypeCheck(some_object, &MyType)) {     PyErr_SetString(PyExc_TypeError, "arg #1 not a mything");     return NULL; }

See also
........

Download CPython source releases.

     ‘https://www.python.org/downloads/source/’

The CPython project on GitHub, where the CPython source code is developed.

     ‘https://github.com/python/cpython’


File: python.info,  Node: Building C and C++ Extensions,  Next: Building C and C++ Extensions on Windows,  Prev: Defining Extension Types Assorted Topics,  Up: Creating extensions without third party tools

6.2.4 Building C and C++ Extensions
-----------------------------------

A C extension for CPython is a shared library (e.g.  a ‘.so’ file on
Linux, ‘.pyd’ on Windows), which exports an `initialization function'.

To be importable, the shared library must be available on *note
PYTHONPATH: 947, and must be named after the module name, with an
appropriate extension.  When using distutils, the correct filename is
generated automatically.

The initialization function has the signature:

 -- C Function: PyObject* PyInit_modulename (void)

It returns either a fully-initialized module, or a *note PyModuleDef:
3a8c. instance.  See *note Initializing C modules: 3ab9. for details.

For modules with ASCII-only names, the function must be named
‘PyInit_<modulename>’, with ‘<modulename>’ replaced by the name of the
module.  When using *note Multi-phase initialization: 3aba, non-ASCII
module names are allowed.  In this case, the initialization function
name is ‘PyInitU_<modulename>’, with ‘<modulename>’ encoded using
Python’s `punycode' encoding with hyphens replaced by underscores.  In
Python:

     def initfunc_name(name):     try:         suffix = b'_' + name.encode('ascii')     except UnicodeEncodeError:         suffix = b'U_' + name.encode('punycode').replace(b'-', b'_')     return b'PyInit' + suffix

It is possible to export multiple modules from a single shared library
by defining multiple initialization functions.  However, importing them
requires using symbolic links or a custom importer, because by default
only the function corresponding to the filename is found.  See the
`“Multiple modules in one library”' section in PEP 489(1) for details.

* Menu:

* Building C and C++ Extensions with distutils::
* Distributing your extension modules::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0489


File: python.info,  Node: Building C and C++ Extensions with distutils,  Next: Distributing your extension modules,  Up: Building C and C++ Extensions

6.2.4.1 Building C and C++ Extensions with distutils
....................................................

Extension modules can be built using distutils, which is included in
Python.  Since distutils also supports creation of binary packages,
users don’t necessarily need a compiler and distutils to install the
extension.

A distutils package contains a driver script, ‘setup.py’.  This is a
plain Python file, which, in the most simple case, could look like this:

     from distutils.core import setup, Extension  module1 = Extension('demo',                     sources = ['demo.c'])  setup (name = 'PackageName',        version = '1.0',        description = 'This is a demo package',        ext_modules = [module1])

With this ‘setup.py’, and a file ‘demo.c’, running

     python setup.py build

will compile ‘demo.c’, and produce an extension module named ‘demo’ in
the ‘build’ directory.  Depending on the system, the module file will
end up in a subdirectory ‘build/lib.system’, and may have a name like
‘demo.so’ or ‘demo.pyd’.

In the ‘setup.py’, all execution is performed by calling the ‘setup’
function.  This takes a variable number of keyword arguments, of which
the example above uses only a subset.  Specifically, the example
specifies meta-information to build packages, and it specifies the
contents of the package.  Normally, a package will contain additional
modules, like Python source modules, documentation, subpackages, etc.
Please refer to the distutils documentation in *note Distributing Python
Modules (Legacy version): 7ec. to learn more about the features of
distutils; this section explains building extension modules only.

It is common to pre-compute arguments to ‘setup()’, to better structure
the driver script.  In the example above, the ‘ext_modules’ argument to
*note setup(): 3abc. is a list of extension modules, each of which is an
instance of the ‘Extension’.  In the example, the instance defines an
extension named ‘demo’ which is build by compiling a single source file,
‘demo.c’.

In many cases, building an extension is more complex, since additional
preprocessor defines and libraries may be needed.  This is demonstrated
in the example below.

     from distutils.core import setup, Extension  module1 = Extension('demo',                     define_macros = [('MAJOR_VERSION', '1'),                                      ('MINOR_VERSION', '0')],                     include_dirs = ['/usr/local/include'],                     libraries = ['tcl83'],                     library_dirs = ['/usr/local/lib'],                     sources = ['demo.c'])  setup (name = 'PackageName',        version = '1.0',        description = 'This is a demo package',        author = 'Martin v. Loewis',        author_email = 'martin@v.loewis.de',        url = 'https://docs.python.org/extending/building',        long_description = ''' This is really just a demo package. ''',        ext_modules = [module1])

In this example, *note setup(): 3abc. is called with additional
meta-information, which is recommended when distribution packages have
to be built.  For the extension itself, it specifies preprocessor
defines, include directories, library directories, and libraries.
Depending on the compiler, distutils passes this information in
different ways to the compiler.  For example, on Unix, this may result
in the compilation commands

     gcc -DNDEBUG -g -O3 -Wall -Wstrict-prototypes -fPIC -DMAJOR_VERSION=1 -DMINOR_VERSION=0 -I/usr/local/include -I/usr/local/include/python2.2 -c demo.c -o build/temp.linux-i686-2.2/demo.o  gcc -shared build/temp.linux-i686-2.2/demo.o -L/usr/local/lib -ltcl83 -o build/lib.linux-i686-2.2/demo.so

These lines are for demonstration purposes only; distutils users should
trust that distutils gets the invocations right.


File: python.info,  Node: Distributing your extension modules,  Prev: Building C and C++ Extensions with distutils,  Up: Building C and C++ Extensions

6.2.4.2 Distributing your extension modules
...........................................

When an extension has been successfully built, there are three ways to
use it.

End-users will typically want to install the module, they do so by
running

     python setup.py install

Module maintainers should produce source packages; to do so, they run

     python setup.py sdist

In some cases, additional files need to be included in a source
distribution; this is done through a ‘MANIFEST.in’ file; see *note
Specifying the files to distribute: 3abf. for details.

If the source distribution has been built successfully, maintainers can
also create binary distributions.  Depending on the platform, one of the
following commands can be used to do so.

     python setup.py bdist_wininst python setup.py bdist_rpm python setup.py bdist_dumb


File: python.info,  Node: Building C and C++ Extensions on Windows,  Prev: Building C and C++ Extensions,  Up: Creating extensions without third party tools

6.2.5 Building C and C++ Extensions on Windows
----------------------------------------------

This chapter briefly explains how to create a Windows extension module
for Python using Microsoft Visual C++, and follows with more detailed
background information on how it works.  The explanatory material is
useful for both the Windows programmer learning to build Python
extensions and the Unix programmer interested in producing software
which can be successfully built on both Unix and Windows.

Module authors are encouraged to use the distutils approach for building
extension modules, instead of the one described in this section.  You
will still need the C compiler that was used to build Python; typically
Microsoft Visual C++.

     Note: This chapter mentions a number of filenames that include an
     encoded Python version number.  These filenames are represented
     with the version number shown as ‘XY’; in practice, ‘'X'’ will be
     the major version number and ‘'Y'’ will be the minor version number
     of the Python release you’re working with.  For example, if you are
     using Python 2.2.1, ‘XY’ will actually be ‘22’.

* Menu:

* A Cookbook Approach::
* Differences Between Unix and Windows::
* Using DLLs in Practice::


File: python.info,  Node: A Cookbook Approach,  Next: Differences Between Unix and Windows,  Up: Building C and C++ Extensions on Windows

6.2.5.1 A Cookbook Approach
...........................

There are two approaches to building extension modules on Windows, just
as there are on Unix: use the *note distutils: 39. package to control
the build process, or do things manually.  The distutils approach works
well for most extensions; documentation on using *note distutils: 39. to
build and package extension modules is available in *note Distributing
Python Modules (Legacy version): 7ec.  If you find you really need to do
things manually, it may be instructive to study the project file for the
winsound(1) standard library module.

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/PCbuild/winsound.vcxproj


File: python.info,  Node: Differences Between Unix and Windows,  Next: Using DLLs in Practice,  Prev: A Cookbook Approach,  Up: Building C and C++ Extensions on Windows

6.2.5.2 Differences Between Unix and Windows
............................................

Unix and Windows use completely different paradigms for run-time loading
of code.  Before you try to build a module that can be dynamically
loaded, be aware of how your system works.

In Unix, a shared object (‘.so’) file contains code to be used by the
program, and also the names of functions and data that it expects to
find in the program.  When the file is joined to the program, all
references to those functions and data in the file’s code are changed to
point to the actual locations in the program where the functions and
data are placed in memory.  This is basically a link operation.

In Windows, a dynamic-link library (‘.dll’) file has no dangling
references.  Instead, an access to functions or data goes through a
lookup table.  So the DLL code does not have to be fixed up at runtime
to refer to the program’s memory; instead, the code already uses the
DLL’s lookup table, and the lookup table is modified at runtime to point
to the functions and data.

In Unix, there is only one type of library file (‘.a’) which contains
code from several object files (‘.o’).  During the link step to create a
shared object file (‘.so’), the linker may find that it doesn’t know
where an identifier is defined.  The linker will look for it in the
object files in the libraries; if it finds it, it will include all the
code from that object file.

In Windows, there are two types of library, a static library and an
import library (both called ‘.lib’).  A static library is like a Unix
‘.a’ file; it contains code to be included as necessary.  An import
library is basically used only to reassure the linker that a certain
identifier is legal, and will be present in the program when the DLL is
loaded.  So the linker uses the information from the import library to
build the lookup table for using identifiers that are not included in
the DLL. When an application or a DLL is linked, an import library may
be generated, which will need to be used for all future DLLs that depend
on the symbols in the application or DLL.

Suppose you are building two dynamic-load modules, B and C, which should
share another block of code A. On Unix, you would `not' pass ‘A.a’ to
the linker for ‘B.so’ and ‘C.so’; that would cause it to be included
twice, so that B and C would each have their own copy.  In Windows,
building ‘A.dll’ will also build ‘A.lib’.  You `do' pass ‘A.lib’ to the
linker for B and C. ‘A.lib’ does not contain code; it just contains
information which will be used at runtime to access A’s code.

In Windows, using an import library is sort of like using ‘import spam’;
it gives you access to spam’s names, but does not create a separate
copy.  On Unix, linking with a library is more like ‘from spam import
*’; it does create a separate copy.


File: python.info,  Node: Using DLLs in Practice,  Prev: Differences Between Unix and Windows,  Up: Building C and C++ Extensions on Windows

6.2.5.3 Using DLLs in Practice
..............................

Windows Python is built in Microsoft Visual C++; using other compilers
may or may not work (though Borland seems to).  The rest of this section
is MSVC++ specific.

When creating DLLs in Windows, you must pass ‘pythonXY.lib’ to the
linker.  To build two DLLs, spam and ni (which uses C functions found in
spam), you could use these commands:

     cl /LD /I/python/include spam.c ../libs/pythonXY.lib cl /LD /I/python/include ni.c spam.lib ../libs/pythonXY.lib

The first command created three files: ‘spam.obj’, ‘spam.dll’ and
‘spam.lib’.  ‘Spam.dll’ does not contain any Python functions (such as
*note PyArg_ParseTuple(): 268.), but it does know how to find the Python
code thanks to ‘pythonXY.lib’.

The second command created ‘ni.dll’ (and ‘.obj’ and ‘.lib’), which knows
how to find the necessary functions from spam, and also from the Python
executable.

Not every identifier is exported to the lookup table.  If you want any
other modules (including Python) to be able to see your identifiers, you
have to say ‘_declspec(dllexport)’, as in ‘void _declspec(dllexport)
initspam(void)’ or ‘PyObject _declspec(dllexport) *NiGetSpamData(void)’.

Developer Studio will throw in a lot of import libraries that you do not
really need, adding about 100K to your executable.  To get rid of them,
use the Project Settings dialog, Link tab, to specify `ignore default
libraries'.  Add the correct ‘msvcrtxx.lib’ to the list of libraries.


File: python.info,  Node: Embedding the CPython runtime in a larger application,  Prev: Creating extensions without third party tools,  Up: Extending and Embedding the Python Interpreter

6.3 Embedding the CPython runtime in a larger application
=========================================================

Sometimes, rather than creating an extension that runs inside the Python
interpreter as the main application, it is desirable to instead embed
the CPython runtime inside a larger application.  This section covers
some of the details involved in doing that successfully.

* Menu:

* Embedding Python in Another Application::


File: python.info,  Node: Embedding Python in Another Application,  Up: Embedding the CPython runtime in a larger application

6.3.1 Embedding Python in Another Application
---------------------------------------------

The previous chapters discussed how to extend Python, that is, how to
extend the functionality of Python by attaching a library of C functions
to it.  It is also possible to do it the other way around: enrich your
C/C++ application by embedding Python in it.  Embedding provides your
application with the ability to implement some of the functionality of
your application in Python rather than C or C++.  This can be used for
many purposes; one example would be to allow users to tailor the
application to their needs by writing some scripts in Python.  You can
also use it yourself if some of the functionality can be written in
Python more easily.

Embedding Python is similar to extending it, but not quite.  The
difference is that when you extend Python, the main program of the
application is still the Python interpreter, while if you embed Python,
the main program may have nothing to do with Python — instead, some
parts of the application occasionally call the Python interpreter to run
some Python code.

So if you are embedding Python, you are providing your own main program.
One of the things this main program has to do is initialize the Python
interpreter.  At the very least, you have to call the function *note
Py_Initialize(): 42e.  There are optional calls to pass command line
arguments to Python.  Then later you can call the interpreter from any
part of the application.

There are several different ways to call the interpreter: you can pass a
string containing Python statements to *note PyRun_SimpleString(): 3acc,
or you can pass a stdio file pointer and a file name (for identification
in error messages only) to *note PyRun_SimpleFile(): 3acd.  You can also
call the lower-level operations described in the previous chapters to
construct and use Python objects.

See also
........

*note Python/C API Reference Manual: 1138.

     The details of Python’s C interface are given in this manual.  A
     great deal of necessary information can be found here.

* Menu:

* Very High Level Embedding::
* Beyond Very High Level Embedding; An overview: Beyond Very High Level Embedding An overview.
* Pure Embedding::
* Extending Embedded Python::
* Embedding Python in C++::
* Compiling and Linking under Unix-like systems::


File: python.info,  Node: Very High Level Embedding,  Next: Beyond Very High Level Embedding An overview,  Up: Embedding Python in Another Application

6.3.1.1 Very High Level Embedding
.................................

The simplest form of embedding Python is the use of the very high level
interface.  This interface is intended to execute a Python script
without needing to interact with the application directly.  This can for
example be used to perform some operation on a file.

     #define PY_SSIZE_T_CLEAN #include <Python.h>  int main(int argc, char *argv[]) {     wchar_t *program = Py_DecodeLocale(argv[0], NULL);     if (program == NULL) {         fprintf(stderr, "Fatal error: cannot decode argv[0]\n");         exit(1);     }     Py_SetProgramName(program);  /* optional but recommended */     Py_Initialize();     PyRun_SimpleString("from time import time,ctime\n"                        "print('Today is', ctime(time()))\n");     if (Py_FinalizeEx() < 0) {         exit(120);     }     PyMem_RawFree(program);     return 0; }

The *note Py_SetProgramName(): eba. function should be called before
*note Py_Initialize(): 42e. to inform the interpreter about paths to
Python run-time libraries.  Next, the Python interpreter is initialized
with *note Py_Initialize(): 42e, followed by the execution of a
hard-coded Python script that prints the date and time.  Afterwards, the
*note Py_FinalizeEx(): 5be. call shuts the interpreter down, followed by
the end of the program.  In a real program, you may want to get the
Python script from another source, perhaps a text-editor routine, a
file, or a database.  Getting the Python code from a file can better be
done by using the *note PyRun_SimpleFile(): 3acd. function, which saves
you the trouble of allocating memory space and loading the file
contents.


File: python.info,  Node: Beyond Very High Level Embedding An overview,  Next: Pure Embedding,  Prev: Very High Level Embedding,  Up: Embedding Python in Another Application

6.3.1.2 Beyond Very High Level Embedding: An overview
.....................................................

The high level interface gives you the ability to execute arbitrary
pieces of Python code from your application, but exchanging data values
is quite cumbersome to say the least.  If you want that, you should use
lower level calls.  At the cost of having to write more C code, you can
achieve almost anything.

It should be noted that extending Python and embedding Python is quite
the same activity, despite the different intent.  Most topics discussed
in the previous chapters are still valid.  To show this, consider what
the extension code from Python to C really does:

  1. Convert data values from Python to C,

  2. Perform a function call to a C routine using the converted values,
     and

  3. Convert the data values from the call from C to Python.

When embedding Python, the interface code does:

  1. Convert data values from C to Python,

  2. Perform a function call to a Python interface routine using the
     converted values, and

  3. Convert the data values from the call from Python to C.

As you can see, the data conversion steps are simply swapped to
accommodate the different direction of the cross-language transfer.  The
only difference is the routine that you call between both data
conversions.  When extending, you call a C routine, when embedding, you
call a Python routine.

This chapter will not discuss how to convert data from Python to C and
vice versa.  Also, proper use of references and dealing with errors is
assumed to be understood.  Since these aspects do not differ from
extending the interpreter, you can refer to earlier chapters for the
required information.


File: python.info,  Node: Pure Embedding,  Next: Extending Embedded Python,  Prev: Beyond Very High Level Embedding An overview,  Up: Embedding Python in Another Application

6.3.1.3 Pure Embedding
......................

The first program aims to execute a function in a Python script.  Like
in the section about the very high level interface, the Python
interpreter does not directly interact with the application (but that
will change in the next section).

The code to run a function defined in a Python script is:

     #define PY_SSIZE_T_CLEAN #include <Python.h>  int main(int argc, char *argv[]) {     PyObject *pName, *pModule, *pFunc;     PyObject *pArgs, *pValue;     int i;      if (argc < 3) {         fprintf(stderr,"Usage: call pythonfile funcname [args]\n");         return 1;     }      Py_Initialize();     pName = PyUnicode_DecodeFSDefault(argv[1]);     /* Error checking of pName left out */      pModule = PyImport_Import(pName);     Py_DECREF(pName);      if (pModule != NULL) {         pFunc = PyObject_GetAttrString(pModule, argv[2]);         /* pFunc is a new reference */          if (pFunc && PyCallable_Check(pFunc)) {             pArgs = PyTuple_New(argc - 3);             for (i = 0; i < argc - 3; ++i) {                 pValue = PyLong_FromLong(atoi(argv[i + 3]));                 if (!pValue) {                     Py_DECREF(pArgs);                     Py_DECREF(pModule);                     fprintf(stderr, "Cannot convert argument\n");                     return 1;                 }                 /* pValue reference stolen here: */                 PyTuple_SetItem(pArgs, i, pValue);             }             pValue = PyObject_CallObject(pFunc, pArgs);             Py_DECREF(pArgs);             if (pValue != NULL) {                 printf("Result of call: %ld\n", PyLong_AsLong(pValue));                 Py_DECREF(pValue);             }             else {                 Py_DECREF(pFunc);                 Py_DECREF(pModule);                 PyErr_Print();                 fprintf(stderr,"Call failed\n");                 return 1;             }         }         else {             if (PyErr_Occurred())                 PyErr_Print();             fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);         }         Py_XDECREF(pFunc);         Py_DECREF(pModule);     }     else {         PyErr_Print();         fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);         return 1;     }     if (Py_FinalizeEx() < 0) {         return 120;     }     return 0; }

This code loads a Python script using ‘argv[1]’, and calls the function
named in ‘argv[2]’.  Its integer arguments are the other values of the
‘argv’ array.  If you *note compile and link: 3ad4. this program (let’s
call the finished executable ‘call’), and use it to execute a Python
script, such as:

     def multiply(a,b):     print("Will compute", a, "times", b)     c = 0     for i in range(0, a):         c = c + b     return c

then the result should be:

     $ call multiply multiply 3 2 Will compute 3 times 2 Result of call: 6

Although the program is quite large for its functionality, most of the
code is for data conversion between Python and C, and for error
reporting.  The interesting part with respect to embedding Python starts
with

     Py_Initialize(); pName = PyUnicode_DecodeFSDefault(argv[1]); /* Error checking of pName left out */ pModule = PyImport_Import(pName);

After initializing the interpreter, the script is loaded using *note
PyImport_Import(): d52.  This routine needs a Python string as its
argument, which is constructed using the *note PyUnicode_FromString():
3ad5. data conversion routine.

     pFunc = PyObject_GetAttrString(pModule, argv[2]); /* pFunc is a new reference */  if (pFunc && PyCallable_Check(pFunc)) {     ... } Py_XDECREF(pFunc);

Once the script is loaded, the name we’re looking for is retrieved using
*note PyObject_GetAttrString(): 3a5f.  If the name exists, and the
object returned is callable, you can safely assume that it is a
function.  The program then proceeds by constructing a tuple of
arguments as normal.  The call to the Python function is then made with:

     pValue = PyObject_CallObject(pFunc, pArgs);

Upon return of the function, ‘pValue’ is either ‘NULL’ or it contains a
reference to the return value of the function.  Be sure to release the
reference after examining the value.


File: python.info,  Node: Extending Embedded Python,  Next: Embedding Python in C++,  Prev: Pure Embedding,  Up: Embedding Python in Another Application

6.3.1.4 Extending Embedded Python
.................................

Until now, the embedded Python interpreter had no access to
functionality from the application itself.  The Python API allows this
by extending the embedded interpreter.  That is, the embedded
interpreter gets extended with routines provided by the application.
While it sounds complex, it is not so bad.  Simply forget for a while
that the application starts the Python interpreter.  Instead, consider
the application to be a set of subroutines, and write some glue code
that gives Python access to those routines, just like you would write a
normal Python extension.  For example:

     static int numargs=0;  /* Return the number of arguments of the application command line */ static PyObject* emb_numargs(PyObject *self, PyObject *args) {     if(!PyArg_ParseTuple(args, ":numargs"))         return NULL;     return PyLong_FromLong(numargs); }  static PyMethodDef EmbMethods[] = {     {"numargs", emb_numargs, METH_VARARGS,      "Return the number of arguments received by the process."},     {NULL, NULL, 0, NULL} };  static PyModuleDef EmbModule = {     PyModuleDef_HEAD_INIT, "emb", NULL, -1, EmbMethods,     NULL, NULL, NULL, NULL };  static PyObject* PyInit_emb(void) {     return PyModule_Create(&EmbModule); }

Insert the above code just above the ‘main()’ function.  Also, insert
the following two statements before the call to *note Py_Initialize():
42e.:

     numargs = argc; PyImport_AppendInittab("emb", &PyInit_emb);

These two lines initialize the ‘numargs’ variable, and make the
‘emb.numargs()’ function accessible to the embedded Python interpreter.
With these extensions, the Python script can do things like

     import emb print("Number of arguments", emb.numargs())

In a real application, the methods will expose an API of the application
to Python.


File: python.info,  Node: Embedding Python in C++,  Next: Compiling and Linking under Unix-like systems,  Prev: Extending Embedded Python,  Up: Embedding Python in Another Application

6.3.1.5 Embedding Python in C++
...............................

It is also possible to embed Python in a C++ program; precisely how this
is done will depend on the details of the C++ system used; in general
you will need to write the main program in C++, and use the C++ compiler
to compile and link your program.  There is no need to recompile Python
itself using C++.


File: python.info,  Node: Compiling and Linking under Unix-like systems,  Prev: Embedding Python in C++,  Up: Embedding Python in Another Application

6.3.1.6 Compiling and Linking under Unix-like systems
.....................................................

It is not necessarily trivial to find the right flags to pass to your
compiler (and linker) in order to embed the Python interpreter into your
application, particularly because Python needs to load library modules
implemented as C dynamic extensions (‘.so’ files) linked against it.

To find out the required compiler and linker flags, you can execute the
‘python`X.Y'-config’ script which is generated as part of the
installation process (a ‘python3-config’ script may also be available).
This script has several options, of which the following will be directly
useful to you:

   * ‘pythonX.Y-config --cflags’ will give you the recommended flags
     when compiling:

          $ /opt/bin/python3.4-config --cflags -I/opt/include/python3.4m -I/opt/include/python3.4m -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes

   * ‘pythonX.Y-config --ldflags’ will give you the recommended flags
     when linking:

          $ /opt/bin/python3.4-config --ldflags -L/opt/lib/python3.4/config-3.4m -lpthread -ldl -lutil -lm -lpython3.4m -Xlinker -export-dynamic

     Note: To avoid confusion between several Python installations (and
     especially between the system Python and your own compiled Python),
     it is recommended that you use the absolute path to
     ‘python`X.Y'-config’, as in the above example.

If this procedure doesn’t work for you (it is not guaranteed to work for
all Unix-like platforms; however, we welcome *note bug reports: 3adb.)
you will have to read your system’s documentation about dynamic linking
and/or examine Python’s ‘Makefile’ (use *note
sysconfig.get_makefile_filename(): 3582. to find its location) and
compilation options.  In this case, the *note sysconfig: fe. module is a
useful tool to programmatically extract the configuration values that
you will want to combine together.  For example:

     >>> import sysconfig >>> sysconfig.get_config_var('LIBS') '-lpthread -ldl  -lutil' >>> sysconfig.get_config_var('LINKFORSHARED') '-Xlinker -export-dynamic'


File: python.info,  Node: Python/C API Reference Manual,  Next: Distributing Python Modules,  Prev: Extending and Embedding the Python Interpreter,  Up: Top

7 Python/C API Reference Manual
*******************************

This manual documents the API used by C and C++ programmers who want to
write extension modules or embed Python.  It is a companion to *note
Extending and Embedding the Python Interpreter: 1137, which describes
the general principles of extension writing but does not document the
API functions in detail.

* Menu:

* Introduction: Introduction<13>.
* Stable Application Binary Interface::
* The Very High Level Layer::
* Reference Counting::
* Exception Handling::
* Utilities: Utilities<2>.
* Abstract Objects Layer::
* Concrete Objects Layer::
* Initialization, Finalization, and Threads: Initialization Finalization and Threads.
* Python Initialization Configuration::
* Memory Management::
* Object Implementation Support::
* API and ABI Versioning::


File: python.info,  Node: Introduction<13>,  Next: Stable Application Binary Interface,  Up: Python/C API Reference Manual

7.1 Introduction
================

The Application Programmer’s Interface to Python gives C and C++
programmers access to the Python interpreter at a variety of levels.
The API is equally usable from C++, but for brevity it is generally
referred to as the Python/C API. There are two fundamentally different
reasons for using the Python/C API. The first reason is to write
`extension modules' for specific purposes; these are C modules that
extend the Python interpreter.  This is probably the most common use.
The second reason is to use Python as a component in a larger
application; this technique is generally referred to as `embedding'
Python in an application.

Writing an extension module is a relatively well-understood process,
where a “cookbook” approach works well.  There are several tools that
automate the process to some extent.  While people have embedded Python
in other applications since its early existence, the process of
embedding Python is less straightforward than writing an extension.

Many API functions are useful independent of whether you’re embedding or
extending Python; moreover, most applications that embed Python will
need to provide a custom extension as well, so it’s probably a good idea
to become familiar with writing an extension before attempting to embed
Python in a real application.

* Menu:

* Coding standards::
* Include Files::
* Useful macros::
* Objects, Types and Reference Counts: Objects Types and Reference Counts.
* Exceptions: Exceptions<18>.
* Embedding Python: Embedding Python<2>.
* Debugging Builds::


File: python.info,  Node: Coding standards,  Next: Include Files,  Up: Introduction<13>

7.1.1 Coding standards
----------------------

If you’re writing C code for inclusion in CPython, you `must' follow the
guidelines and standards defined in PEP 7(1).  These guidelines apply
regardless of the version of Python you are contributing to.  Following
these conventions is not necessary for your own third party extension
modules, unless you eventually expect to contribute them to Python.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0007


File: python.info,  Node: Include Files,  Next: Useful macros,  Prev: Coding standards,  Up: Introduction<13>

7.1.2 Include Files
-------------------

All function, type and macro definitions needed to use the Python/C API
are included in your code by the following line:

     #define PY_SSIZE_T_CLEAN #include <Python.h>

This implies inclusion of the following standard headers: ‘<stdio.h>’,
‘<string.h>’, ‘<errno.h>’, ‘<limits.h>’, ‘<assert.h>’ and ‘<stdlib.h>’
(if available).

     Note: Since Python may define some pre-processor definitions which
     affect the standard headers on some systems, you `must' include
     ‘Python.h’ before any standard headers are included.

     It is recommended to always define ‘PY_SSIZE_T_CLEAN’ before
     including ‘Python.h’.  See *note Parsing arguments and building
     values: 2ce. for a description of this macro.

All user visible names defined by Python.h (except those defined by the
included standard headers) have one of the prefixes ‘Py’ or ‘_Py’.
Names beginning with ‘_Py’ are for internal use by the Python
implementation and should not be used by extension writers.  Structure
member names do not have a reserved prefix.

     Note: User code should never define names that begin with ‘Py’ or
     ‘_Py’.  This confuses the reader, and jeopardizes the portability
     of the user code to future Python versions, which may define
     additional names beginning with one of these prefixes.

The header files are typically installed with Python.  On Unix, these
are located in the directories ‘`prefix'/include/pythonversion/’ and
‘`exec_prefix'/include/pythonversion/’, where ‘prefix’ and ‘exec_prefix’
are defined by the corresponding parameters to Python’s ‘configure’
script and `version' is ‘'%d.%d' % sys.version_info[:2]’.  On Windows,
the headers are installed in ‘`prefix'/include’, where ‘prefix’ is the
installation directory specified to the installer.

To include the headers, place both directories (if different) on your
compiler’s search path for includes.  Do `not' place the parent
directories on the search path and then use ‘#include
<pythonX.Y/Python.h>’; this will break on multi-platform builds since
the platform independent headers under ‘prefix’ include the platform
specific headers from ‘exec_prefix’.

C++ users should note that although the API is defined entirely using C,
the header files properly declare the entry points to be ‘extern "C"’.
As a result, there is no need to do anything special to use the API from
C++.


File: python.info,  Node: Useful macros,  Next: Objects Types and Reference Counts,  Prev: Include Files,  Up: Introduction<13>

7.1.3 Useful macros
-------------------

Several useful macros are defined in the Python header files.  Many are
defined closer to where they are useful (e.g.  *note Py_RETURN_NONE:
dc9.).  Others of a more general utility are defined here.  This is not
necessarily a complete listing.

 -- C Macro: Py_UNREACHABLE ()

     Use this when you have a code path that you do not expect to be
     reached.  For example, in the ‘default:’ clause in a ‘switch’
     statement for which all possible values are covered in ‘case’
     statements.  Use this in places where you might be tempted to put
     an ‘assert(0)’ or ‘abort()’ call.

     New in version 3.7.

 -- C Macro: Py_ABS (x)

     Return the absolute value of ‘x’.

     New in version 3.3.

 -- C Macro: Py_MIN (x, y)

     Return the minimum value between ‘x’ and ‘y’.

     New in version 3.3.

 -- C Macro: Py_MAX (x, y)

     Return the maximum value between ‘x’ and ‘y’.

     New in version 3.3.

 -- C Macro: Py_STRINGIFY (x)

     Convert ‘x’ to a C string.  E.g.  ‘Py_STRINGIFY(123)’ returns
     ‘"123"’.

     New in version 3.4.

 -- C Macro: Py_MEMBER_SIZE (type, member)

     Return the size of a structure (‘type’) ‘member’ in bytes.

     New in version 3.6.

 -- C Macro: Py_CHARMASK (c)

     Argument must be a character or an integer in the range [-128, 127]
     or [0, 255].  This macro returns ‘c’ cast to an ‘unsigned char’.

 -- C Macro: Py_GETENV (s)

     Like ‘getenv(s)’, but returns ‘NULL’ if *note -E: f3d. was passed
     on the command line (i.e.  if ‘Py_IgnoreEnvironmentFlag’ is set).

 -- C Macro: Py_UNUSED (arg)

     Use this for unused arguments in a function definition to silence
     compiler warnings.  Example: ‘int func(int a, int Py_UNUSED(b)) {
     return a; }’.

     New in version 3.4.

 -- C Macro: Py_DEPRECATED (version)

     Use this for deprecated declarations.  The macro must be placed
     before the symbol name.

     Example:

          Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);

     Changed in version 3.8: MSVC support was added.


File: python.info,  Node: Objects Types and Reference Counts,  Next: Exceptions<18>,  Prev: Useful macros,  Up: Introduction<13>

7.1.4 Objects, Types and Reference Counts
-----------------------------------------

Most Python/C API functions have one or more arguments as well as a
return value of type *note PyObject*: 4b0.  This type is a pointer to an
opaque data type representing an arbitrary Python object.  Since all
Python object types are treated the same way by the Python language in
most situations (e.g., assignments, scope rules, and argument passing),
it is only fitting that they should be represented by a single C type.
Almost all Python objects live on the heap: you never declare an
automatic or static variable of type *note PyObject: 4b0, only pointer
variables of type *note PyObject*: 4b0. can be declared.  The sole
exception are the type objects; since these must never be deallocated,
they are typically static *note PyTypeObject: 2d4. objects.

All Python objects (even Python integers) have a `type' and a `reference
count'.  An object’s type determines what kind of object it is (e.g., an
integer, a list, or a user-defined function; there are many more as
explained in *note The standard type hierarchy: 135c.).  For each of the
well-known types there is a macro to check whether an object is of that
type; for instance, ‘PyList_Check(a)’ is true if (and only if) the
object pointed to by `a' is a Python list.

* Menu:

* Reference Counts: Reference Counts<2>.
* Types::


File: python.info,  Node: Reference Counts<2>,  Next: Types,  Up: Objects Types and Reference Counts

7.1.4.1 Reference Counts
........................

The reference count is important because today’s computers have a finite
(and often severely limited) memory size; it counts how many different
places there are that have a reference to an object.  Such a place could
be another object, or a global (or static) C variable, or a local
variable in some C function.  When an object’s reference count becomes
zero, the object is deallocated.  If it contains references to other
objects, their reference count is decremented.  Those other objects may
be deallocated in turn, if this decrement makes their reference count
become zero, and so on.  (There’s an obvious problem with objects that
reference each other here; for now, the solution is “don’t do that.”)

Reference counts are always manipulated explicitly.  The normal way is
to use the macro *note Py_INCREF(): 263. to increment an object’s
reference count by one, and *note Py_DECREF(): 264. to decrement it by
one.  The *note Py_DECREF(): 264. macro is considerably more complex
than the incref one, since it must check whether the reference count
becomes zero and then cause the object’s deallocator to be called.  The
deallocator is a function pointer contained in the object’s type
structure.  The type-specific deallocator takes care of decrementing the
reference counts for other objects contained in the object if this is a
compound object type, such as a list, as well as performing any
additional finalization that’s needed.  There’s no chance that the
reference count can overflow; at least as many bits are used to hold the
reference count as there are distinct memory locations in virtual memory
(assuming ‘sizeof(Py_ssize_t) >= sizeof(void*)’).  Thus, the reference
count increment is a simple operation.

It is not necessary to increment an object’s reference count for every
local variable that contains a pointer to an object.  In theory, the
object’s reference count goes up by one when the variable is made to
point to it and it goes down by one when the variable goes out of scope.
However, these two cancel each other out, so at the end the reference
count hasn’t changed.  The only real reason to use the reference count
is to prevent the object from being deallocated as long as our variable
is pointing to it.  If we know that there is at least one other
reference to the object that lives at least as long as our variable,
there is no need to increment the reference count temporarily.  An
important situation where this arises is in objects that are passed as
arguments to C functions in an extension module that are called from
Python; the call mechanism guarantees to hold a reference to every
argument for the duration of the call.

However, a common pitfall is to extract an object from a list and hold
on to it for a while without incrementing its reference count.  Some
other operation might conceivably remove the object from the list,
decrementing its reference count and possibly deallocating it.  The real
danger is that innocent-looking operations may invoke arbitrary Python
code which could do this; there is a code path which allows control to
flow back to the user from a *note Py_DECREF(): 264, so almost any
operation is potentially dangerous.

A safe approach is to always use the generic operations (functions whose
name begins with ‘PyObject_’, ‘PyNumber_’, ‘PySequence_’ or
‘PyMapping_’).  These operations always increment the reference count of
the object they return.  This leaves the caller with the responsibility
to call *note Py_DECREF(): 264. when they are done with the result; this
soon becomes second nature.

* Menu:

* Reference Count Details::


File: python.info,  Node: Reference Count Details,  Up: Reference Counts<2>

7.1.4.2 Reference Count Details
...............................

The reference count behavior of functions in the Python/C API is best
explained in terms of `ownership of references'.  Ownership pertains to
references, never to objects (objects are not owned: they are always
shared).  “Owning a reference” means being responsible for calling
Py_DECREF on it when the reference is no longer needed.  Ownership can
also be transferred, meaning that the code that receives ownership of
the reference then becomes responsible for eventually decref’ing it by
calling *note Py_DECREF(): 264. or *note Py_XDECREF(): 266. when it’s no
longer needed—or passing on this responsibility (usually to its caller).
When a function passes ownership of a reference on to its caller, the
caller is said to receive a `new' reference.  When no ownership is
transferred, the caller is said to `borrow' the reference.  Nothing
needs to be done for a borrowed reference.

Conversely, when a calling function passes in a reference to an object,
there are two possibilities: the function `steals' a reference to the
object, or it does not.  `Stealing a reference' means that when you pass
a reference to a function, that function assumes that it now owns that
reference, and you are not responsible for it any longer.

Few functions steal references; the two notable exceptions are *note
PyList_SetItem(): 3a66. and *note PyTuple_SetItem(): 3a65, which steal a
reference to the item (but not to the tuple or list into which the item
is put!).  These functions were designed to steal a reference because of
a common idiom for populating a tuple or list with newly created
objects; for example, the code to create the tuple ‘(1, 2, "three")’
could look like this (forgetting about error handling for the moment; a
better way to code this is shown below):

     PyObject *t;  t = PyTuple_New(3); PyTuple_SetItem(t, 0, PyLong_FromLong(1L)); PyTuple_SetItem(t, 1, PyLong_FromLong(2L)); PyTuple_SetItem(t, 2, PyUnicode_FromString("three"));

Here, *note PyLong_FromLong(): 3a45. returns a new reference which is
immediately stolen by *note PyTuple_SetItem(): 3a65.  When you want to
keep using an object although the reference to it will be stolen, use
*note Py_INCREF(): 263. to grab another reference before calling the
reference-stealing function.

Incidentally, *note PyTuple_SetItem(): 3a65. is the `only' way to set
tuple items; *note PySequence_SetItem(): f87. and *note
PyObject_SetItem(): 3af4. refuse to do this since tuples are an
immutable data type.  You should only use *note PyTuple_SetItem(): 3a65.
for tuples that you are creating yourself.

Equivalent code for populating a list can be written using *note
PyList_New(): 3af5. and *note PyList_SetItem(): 3a66.

However, in practice, you will rarely use these ways of creating and
populating a tuple or list.  There’s a generic function, *note
Py_BuildValue(): 2cc, that can create most common objects from C values,
directed by a `format string'.  For example, the above two blocks of
code could be replaced by the following (which also takes care of the
error checking):

     PyObject *tuple, *list;  tuple = Py_BuildValue("(iis)", 1, 2, "three"); list = Py_BuildValue("[iis]", 1, 2, "three");

It is much more common to use *note PyObject_SetItem(): 3af4. and
friends with items whose references you are only borrowing, like
arguments that were passed in to the function you are writing.  In that
case, their behaviour regarding reference counts is much saner, since
you don’t have to increment a reference count so you can give a
reference away (“have it be stolen”).  For example, this function sets
all items of a list (actually, any mutable sequence) to a given item:

     int set_all(PyObject *target, PyObject *item) {     Py_ssize_t i, n;      n = PyObject_Length(target);     if (n < 0)         return -1;     for (i = 0; i < n; i++) {         PyObject *index = PyLong_FromSsize_t(i);         if (!index)             return -1;         if (PyObject_SetItem(target, index, item) < 0) {             Py_DECREF(index);             return -1;         }         Py_DECREF(index);     }     return 0; }

The situation is slightly different for function return values.  While
passing a reference to most functions does not change your ownership
responsibilities for that reference, many functions that return a
reference to an object give you ownership of the reference.  The reason
is simple: in many cases, the returned object is created on the fly, and
the reference you get is the only reference to the object.  Therefore,
the generic functions that return object references, like *note
PyObject_GetItem(): 3af6. and *note PySequence_GetItem(): f86, always
return a new reference (the caller becomes the owner of the reference).

It is important to realize that whether you own a reference returned by
a function depends on which function you call only — `the plumage' (the
type of the object passed as an argument to the function) `doesn’t enter
into it!'  Thus, if you extract an item from a list using *note
PyList_GetItem(): 3a61, you don’t own the reference — but if you obtain
the same item from the same list using *note PySequence_GetItem(): f86.
(which happens to take exactly the same arguments), you do own a
reference to the returned object.

Here is an example of how you could write a function that computes the
sum of the items in a list of integers; once using *note
PyList_GetItem(): 3a61, and once using *note PySequence_GetItem(): f86.

     long sum_list(PyObject *list) {     Py_ssize_t i, n;     long total = 0, value;     PyObject *item;      n = PyList_Size(list);     if (n < 0)         return -1; /* Not a list */     for (i = 0; i < n; i++) {         item = PyList_GetItem(list, i); /* Can't fail */         if (!PyLong_Check(item)) continue; /* Skip non-integers */         value = PyLong_AsLong(item);         if (value == -1 && PyErr_Occurred())             /* Integer too big to fit in a C long, bail out */             return -1;         total += value;     }     return total; }

     long sum_sequence(PyObject *sequence) {     Py_ssize_t i, n;     long total = 0, value;     PyObject *item;     n = PySequence_Length(sequence);     if (n < 0)         return -1; /* Has no length */     for (i = 0; i < n; i++) {         item = PySequence_GetItem(sequence, i);         if (item == NULL)             return -1; /* Not a sequence, or other failure */         if (PyLong_Check(item)) {             value = PyLong_AsLong(item);             Py_DECREF(item);             if (value == -1 && PyErr_Occurred())                 /* Integer too big to fit in a C long, bail out */                 return -1;             total += value;         }         else {             Py_DECREF(item); /* Discard reference ownership */         }     }     return total; }


File: python.info,  Node: Types,  Prev: Reference Counts<2>,  Up: Objects Types and Reference Counts

7.1.4.3 Types
.............

There are few other data types that play a significant role in the
Python/C API; most are simple C types such as ‘int’, ‘long’, ‘double’
and ‘char*’.  A few structure types are used to describe static tables
used to list the functions exported by a module or the data attributes
of a new object type, and another is used to describe the value of a
complex number.  These will be discussed together with the functions
that use them.


File: python.info,  Node: Exceptions<18>,  Next: Embedding Python<2>,  Prev: Objects Types and Reference Counts,  Up: Introduction<13>

7.1.5 Exceptions
----------------

The Python programmer only needs to deal with exceptions if specific
error handling is required; unhandled exceptions are automatically
propagated to the caller, then to the caller’s caller, and so on, until
they reach the top-level interpreter, where they are reported to the
user accompanied by a stack traceback.

For C programmers, however, error checking always has to be explicit.
All functions in the Python/C API can raise exceptions, unless an
explicit claim is made otherwise in a function’s documentation.  In
general, when a function encounters an error, it sets an exception,
discards any object references that it owns, and returns an error
indicator.  If not documented otherwise, this indicator is either ‘NULL’
or ‘-1’, depending on the function’s return type.  A few functions
return a Boolean true/false result, with false indicating an error.
Very few functions return no explicit error indicator or have an
ambiguous return value, and require explicit testing for errors with
*note PyErr_Occurred(): 3a43.  These exceptions are always explicitly
documented.

Exception state is maintained in per-thread storage (this is equivalent
to using global storage in an unthreaded application).  A thread can be
in one of two states: an exception has occurred, or not.  The function
*note PyErr_Occurred(): 3a43. can be used to check for this: it returns
a borrowed reference to the exception type object when an exception has
occurred, and ‘NULL’ otherwise.  There are a number of functions to set
the exception state: *note PyErr_SetString(): 3a40. is the most common
(though not the most general) function to set the exception state, and
*note PyErr_Clear(): 95f. clears the exception state.

The full exception state consists of three objects (all of which can be
‘NULL’): the exception type, the corresponding exception value, and the
traceback.  These have the same meanings as the Python result of
‘sys.exc_info()’; however, they are not the same: the Python objects
represent the last exception being handled by a Python *note try: d65. …
*note except: b31. statement, while the C level exception state only
exists while an exception is being passed on between C functions until
it reaches the Python bytecode interpreter’s main loop, which takes care
of transferring it to ‘sys.exc_info()’ and friends.

Note that starting with Python 1.5, the preferred, thread-safe way to
access the exception state from Python code is to call the function
*note sys.exc_info(): c52, which returns the per-thread exception state
for Python code.  Also, the semantics of both ways to access the
exception state have changed so that a function which catches an
exception will save and restore its thread’s exception state so as to
preserve the exception state of its caller.  This prevents common bugs
in exception handling code caused by an innocent-looking function
overwriting the exception being handled; it also reduces the often
unwanted lifetime extension for objects that are referenced by the stack
frames in the traceback.

As a general principle, a function that calls another function to
perform some task should check whether the called function raised an
exception, and if so, pass the exception state on to its caller.  It
should discard any object references that it owns, and return an error
indicator, but it should `not' set another exception — that would
overwrite the exception that was just raised, and lose important
information about the exact cause of the error.

A simple example of detecting exceptions and passing them on is shown in
the ‘sum_sequence()’ example above.  It so happens that this example
doesn’t need to clean up any owned references when it detects an error.
The following example function shows some error cleanup.  First, to
remind you why you like Python, we show the equivalent Python code:

     def incr_item(dict, key):     try:         item = dict[key]     except KeyError:         item = 0     dict[key] = item + 1

Here is the corresponding C code, in all its glory:

     int incr_item(PyObject *dict, PyObject *key) {     /* Objects all initialized to NULL for Py_XDECREF */     PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;     int rv = -1; /* Return value initialized to -1 (failure) */      item = PyObject_GetItem(dict, key);     if (item == NULL) {         /* Handle KeyError only: */         if (!PyErr_ExceptionMatches(PyExc_KeyError))             goto error;          /* Clear the error and use zero: */         PyErr_Clear();         item = PyLong_FromLong(0L);         if (item == NULL)             goto error;     }     const_one = PyLong_FromLong(1L);     if (const_one == NULL)         goto error;      incremented_item = PyNumber_Add(item, const_one);     if (incremented_item == NULL)         goto error;      if (PyObject_SetItem(dict, key, incremented_item) < 0)         goto error;     rv = 0; /* Success */     /* Continue with cleanup code */   error:     /* Cleanup code, shared by success and failure path */      /* Use Py_XDECREF() to ignore NULL references */     Py_XDECREF(item);     Py_XDECREF(const_one);     Py_XDECREF(incremented_item);      return rv; /* -1 for error, 0 for success */ }

This example represents an endorsed use of the ‘goto’ statement in C! It
illustrates the use of *note PyErr_ExceptionMatches(): 3afb. and *note
PyErr_Clear(): 95f. to handle specific exceptions, and the use of *note
Py_XDECREF(): 266. to dispose of owned references that may be ‘NULL’
(note the ‘'X'’ in the name; *note Py_DECREF(): 264. would crash when
confronted with a ‘NULL’ reference).  It is important that the variables
used to hold owned references are initialized to ‘NULL’ for this to
work; likewise, the proposed return value is initialized to ‘-1’
(failure) and only set to success after the final call made is
successful.


File: python.info,  Node: Embedding Python<2>,  Next: Debugging Builds,  Prev: Exceptions<18>,  Up: Introduction<13>

7.1.6 Embedding Python
----------------------

The one important task that only embedders (as opposed to extension
writers) of the Python interpreter have to worry about is the
initialization, and possibly the finalization, of the Python
interpreter.  Most functionality of the interpreter can only be used
after the interpreter has been initialized.

The basic initialization function is *note Py_Initialize(): 42e.  This
initializes the table of loaded modules, and creates the fundamental
modules *note builtins: 13, *note __main__: 1, and *note sys: fd.  It
also initializes the module search path (‘sys.path’).

*note Py_Initialize(): 42e. does not set the “script argument list”
(‘sys.argv’).  If this variable is needed by Python code that will be
executed later, it must be set explicitly with a call to
‘PySys_SetArgvEx(argc, argv, updatepath)’ after the call to *note
Py_Initialize(): 42e.

On most systems (in particular, on Unix and Windows, although the
details are slightly different), *note Py_Initialize(): 42e. calculates
the module search path based upon its best guess for the location of the
standard Python interpreter executable, assuming that the Python library
is found in a fixed location relative to the Python interpreter
executable.  In particular, it looks for a directory named
‘lib/python`X.Y'’ relative to the parent directory where the executable
named ‘python’ is found on the shell command search path (the
environment variable ‘PATH’).

For instance, if the Python executable is found in
‘/usr/local/bin/python’, it will assume that the libraries are in
‘/usr/local/lib/python`X.Y'’.  (In fact, this particular path is also
the “fallback” location, used when no executable file named ‘python’ is
found along ‘PATH’.)  The user can override this behavior by setting the
environment variable *note PYTHONHOME: 4cb, or insert additional
directories in front of the standard path by setting *note PYTHONPATH:
947.

The embedding application can steer the search by calling
‘Py_SetProgramName(file)’ `before' calling *note Py_Initialize(): 42e.
Note that *note PYTHONHOME: 4cb. still overrides this and *note
PYTHONPATH: 947. is still inserted in front of the standard path.  An
application that requires total control has to provide its own
implementation of *note Py_GetPath(): 3afe, *note Py_GetPrefix(): 3aff,
*note Py_GetExecPrefix(): 3b00, and *note Py_GetProgramFullPath(): 273.
(all defined in ‘Modules/getpath.c’).

Sometimes, it is desirable to “uninitialize” Python.  For instance, the
application may want to start over (make another call to *note
Py_Initialize(): 42e.) or the application is simply done with its use of
Python and wants to free memory allocated by Python.  This can be
accomplished by calling *note Py_FinalizeEx(): 5be.  The function *note
Py_IsInitialized(): 3b01. returns true if Python is currently in the
initialized state.  More information about these functions is given in a
later chapter.  Notice that *note Py_FinalizeEx(): 5be. does `not' free
all memory allocated by the Python interpreter, e.g.  memory allocated
by extension modules currently cannot be released.


File: python.info,  Node: Debugging Builds,  Prev: Embedding Python<2>,  Up: Introduction<13>

7.1.7 Debugging Builds
----------------------

Python can be built with several macros to enable extra checks of the
interpreter and extension modules.  These checks tend to add a large
amount of overhead to the runtime so they are not enabled by default.

A full list of the various types of debugging builds is in the file
‘Misc/SpecialBuilds.txt’ in the Python source distribution.  Builds are
available that support tracing of reference counts, debugging the memory
allocator, or low-level profiling of the main interpreter loop.  Only
the most frequently-used builds will be described in the remainder of
this section.

Compiling the interpreter with the ‘Py_DEBUG’ macro defined produces
what is generally meant by “a debug build” of Python.  ‘Py_DEBUG’ is
enabled in the Unix build by adding ‘--with-pydebug’ to the
‘./configure’ command.  It is also implied by the presence of the
not-Python-specific ‘_DEBUG’ macro.  When ‘Py_DEBUG’ is enabled in the
Unix build, compiler optimization is disabled.

In addition to the reference count debugging described below, the
following extra checks are performed:

   * Extra checks are added to the object allocator.

   * Extra checks are added to the parser and compiler.

   * Downcasts from wide types to narrow types are checked for loss of
     information.

   * A number of assertions are added to the dictionary and set
     implementations.  In addition, the set object acquires a
     ‘test_c_api()’ method.

   * Sanity checks of the input arguments are added to frame creation.

   * The storage for ints is initialized with a known invalid pattern to
     catch reference to uninitialized digits.

   * Low-level tracing and extra exception checking are added to the
     runtime virtual machine.

   * Extra checks are added to the memory arena implementation.

   * Extra debugging is added to the thread module.

There may be additional checks not mentioned here.

Defining ‘Py_TRACE_REFS’ enables reference tracing.  When defined, a
circular doubly linked list of active objects is maintained by adding
two extra fields to every *note PyObject: 4b0.  Total allocations are
tracked as well.  Upon exit, all existing references are printed.  (In
interactive mode this happens after every statement run by the
interpreter.)  Implied by ‘Py_DEBUG’.

Please refer to ‘Misc/SpecialBuilds.txt’ in the Python source
distribution for more detailed information.


File: python.info,  Node: Stable Application Binary Interface,  Next: The Very High Level Layer,  Prev: Introduction<13>,  Up: Python/C API Reference Manual

7.2 Stable Application Binary Interface
=======================================

Traditionally, the C API of Python will change with every release.  Most
changes will be source-compatible, typically by only adding API, rather
than changing existing API or removing API (although some interfaces do
get removed after being deprecated first).

Unfortunately, the API compatibility does not extend to binary
compatibility (the ABI). The reason is primarily the evolution of struct
definitions, where addition of a new field, or changing the type of a
field, might not break the API, but can break the ABI. As a consequence,
extension modules need to be recompiled for every Python release
(although an exception is possible on Unix when none of the affected
interfaces are used).  In addition, on Windows, extension modules link
with a specific pythonXY.dll and need to be recompiled to link with a
newer one.

Since Python 3.2, a subset of the API has been declared to guarantee a
stable ABI. Extension modules wishing to use this API (called “limited
API”) need to define ‘Py_LIMITED_API’.  A number of interpreter details
then become hidden from the extension module; in return, a module is
built that works on any 3.x version (x>=2) without recompilation.

In some cases, the stable ABI needs to be extended with new functions.
Extension modules wishing to use these new APIs need to set
‘Py_LIMITED_API’ to the ‘PY_VERSION_HEX’ value (see *note API and ABI
Versioning: 3571.) of the minimum Python version they want to support
(e.g.  ‘0x03030000’ for Python 3.3).  Such modules will work on all
subsequent Python releases, but fail to load (because of missing
symbols) on the older releases.

As of Python 3.2, the set of functions available to the limited API is
documented in PEP 384(1).  In the C API documentation, API elements that
are not part of the limited API are marked as “Not part of the limited
API.”

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0384


File: python.info,  Node: The Very High Level Layer,  Next: Reference Counting,  Prev: Stable Application Binary Interface,  Up: Python/C API Reference Manual

7.3 The Very High Level Layer
=============================

The functions in this chapter will let you execute Python source code
given in a file or a buffer, but they will not let you interact in a
more detailed way with the interpreter.

Several of these functions accept a start symbol from the grammar as a
parameter.  The available start symbols are ‘Py_eval_input’,
‘Py_file_input’, and ‘Py_single_input’.  These are described following
the functions which accept them as parameters.

Note also that several of these functions take ‘FILE*’ parameters.  One
particular issue which needs to be handled carefully is that the ‘FILE’
structure for different C libraries can be different and incompatible.
Under Windows (at least), it is possible for dynamically linked
extensions to actually use different libraries, so care should be taken
that ‘FILE*’ parameters are only passed to these functions if it is
certain that they were created by the same library that the Python
runtime is using.

 -- C Function: int Py_Main (int argc, wchar_t **argv)

     The main program for the standard interpreter.  This is made
     available for programs which embed Python.  The `argc' and `argv'
     parameters should be prepared exactly as those which are passed to
     a C program’s ‘main()’ function (converted to wchar_t according to
     the user’s locale).  It is important to note that the argument list
     may be modified (but the contents of the strings pointed to by the
     argument list are not).  The return value will be ‘0’ if the
     interpreter exits normally (i.e., without an exception), ‘1’ if the
     interpreter exits due to an exception, or ‘2’ if the parameter list
     does not represent a valid Python command line.

     Note that if an otherwise unhandled *note SystemExit: 5f1. is
     raised, this function will not return ‘1’, but exit the process, as
     long as ‘Py_InspectFlag’ is not set.

 -- C Function: int Py_BytesMain (int argc, char **argv)

     Similar to *note Py_Main(): 4ad. but `argv' is an array of bytes
     strings.

     New in version 3.8.

 -- C Function: int PyRun_AnyFile (FILE *fp, const char *filename)

     This is a simplified interface to *note PyRun_AnyFileExFlags():
     3b0b. below, leaving `closeit' set to ‘0’ and `flags' set to
     ‘NULL’.

 -- C Function: int PyRun_AnyFileFlags (FILE *fp, const char *filename,
          PyCompilerFlags *flags)

     This is a simplified interface to *note PyRun_AnyFileExFlags():
     3b0b. below, leaving the `closeit' argument set to ‘0’.

 -- C Function: int PyRun_AnyFileEx (FILE *fp, const char *filename,
          int closeit)

     This is a simplified interface to *note PyRun_AnyFileExFlags():
     3b0b. below, leaving the `flags' argument set to ‘NULL’.

 -- C Function: int PyRun_AnyFileExFlags (FILE *fp, const
          char *filename, int closeit, PyCompilerFlags *flags)

     If `fp' refers to a file associated with an interactive device
     (console or terminal input or Unix pseudo-terminal), return the
     value of *note PyRun_InteractiveLoop(): 3b0e, otherwise return the
     result of *note PyRun_SimpleFile(): 3acd.  `filename' is decoded
     from the filesystem encoding (*note sys.getfilesystemencoding():
     4eb.).  If `filename' is ‘NULL’, this function uses ‘"???"’ as the
     filename.

 -- C Function: int PyRun_SimpleString (const char *command)

     This is a simplified interface to *note PyRun_SimpleStringFlags():
     3b0f. below, leaving the *note PyCompilerFlags: 2ca.* argument set
     to ‘NULL’.

 -- C Function: int PyRun_SimpleStringFlags (const char *command,
          PyCompilerFlags *flags)

     Executes the Python source code from `command' in the *note
     __main__: 1. module according to the `flags' argument.  If *note
     __main__: 1. does not already exist, it is created.  Returns ‘0’ on
     success or ‘-1’ if an exception was raised.  If there was an error,
     there is no way to get the exception information.  For the meaning
     of `flags', see below.

     Note that if an otherwise unhandled *note SystemExit: 5f1. is
     raised, this function will not return ‘-1’, but exit the process,
     as long as ‘Py_InspectFlag’ is not set.

 -- C Function: int PyRun_SimpleFile (FILE *fp, const char *filename)

     This is a simplified interface to *note PyRun_SimpleFileExFlags():
     f45. below, leaving `closeit' set to ‘0’ and `flags' set to ‘NULL’.

 -- C Function: int PyRun_SimpleFileEx (FILE *fp, const char *filename,
          int closeit)

     This is a simplified interface to *note PyRun_SimpleFileExFlags():
     f45. below, leaving `flags' set to ‘NULL’.

 -- C Function: int PyRun_SimpleFileExFlags (FILE *fp, const
          char *filename, int closeit, PyCompilerFlags *flags)

     Similar to *note PyRun_SimpleStringFlags(): 3b0f, but the Python
     source code is read from `fp' instead of an in-memory string.
     `filename' should be the name of the file, it is decoded from the
     filesystem encoding (*note sys.getfilesystemencoding(): 4eb.).  If
     `closeit' is true, the file is closed before
     PyRun_SimpleFileExFlags returns.

          Note: On Windows, `fp' should be opened as binary mode (e.g.
          ‘fopen(filename, "rb")’.  Otherwise, Python may not handle
          script file with LF line ending correctly.

 -- C Function: int PyRun_InteractiveOne (FILE *fp, const
          char *filename)

     This is a simplified interface to *note
     PyRun_InteractiveOneFlags(): 3b12. below, leaving `flags' set to
     ‘NULL’.

 -- C Function: int PyRun_InteractiveOneFlags (FILE *fp, const
          char *filename, PyCompilerFlags *flags)

     Read and execute a single statement from a file associated with an
     interactive device according to the `flags' argument.  The user
     will be prompted using ‘sys.ps1’ and ‘sys.ps2’.  `filename' is
     decoded from the filesystem encoding (*note
     sys.getfilesystemencoding(): 4eb.).

     Returns ‘0’ when the input was executed successfully, ‘-1’ if there
     was an exception, or an error code from the ‘errcode.h’ include
     file distributed as part of Python if there was a parse error.
     (Note that ‘errcode.h’ is not included by ‘Python.h’, so must be
     included specifically if needed.)

 -- C Function: int PyRun_InteractiveLoop (FILE *fp, const
          char *filename)

     This is a simplified interface to *note
     PyRun_InteractiveLoopFlags(): 3b13. below, leaving `flags' set to
     ‘NULL’.

 -- C Function: int PyRun_InteractiveLoopFlags (FILE *fp, const
          char *filename, PyCompilerFlags *flags)

     Read and execute statements from a file associated with an
     interactive device until EOF is reached.  The user will be prompted
     using ‘sys.ps1’ and ‘sys.ps2’.  `filename' is decoded from the
     filesystem encoding (*note sys.getfilesystemencoding(): 4eb.).
     Returns ‘0’ at EOF or a negative number upon failure.

 -- C Variable: int (*PyOS_InputHook) (void)

     Can be set to point to a function with the prototype ‘int
     func(void)’.  The function will be called when Python’s interpreter
     prompt is about to become idle and wait for user input from the
     terminal.  The return value is ignored.  Overriding this hook can
     be used to integrate the interpreter’s prompt with other event
     loops, as done in the ‘Modules/_tkinter.c’ in the Python source
     code.

 -- C Variable: char* (*PyOS_ReadlineFunctionPointer) (FILE *, FILE *,
          const char *)

     Can be set to point to a function with the prototype ‘char
     *func(FILE *stdin, FILE *stdout, char *prompt)’, overriding the
     default function used to read a single line of input at the
     interpreter’s prompt.  The function is expected to output the
     string `prompt' if it’s not ‘NULL’, and then read a line of input
     from the provided standard input file, returning the resulting
     string.  For example, The *note readline: de. module sets this hook
     to provide line-editing and tab-completion features.

     The result must be a string allocated by *note PyMem_RawMalloc():
     961. or *note PyMem_RawRealloc(): 962, or ‘NULL’ if an error
     occurred.

     Changed in version 3.4: The result must be allocated by *note
     PyMem_RawMalloc(): 961. or *note PyMem_RawRealloc(): 962, instead
     of being allocated by *note PyMem_Malloc(): 4fa. or *note
     PyMem_Realloc(): 963.

 -- C Function: struct _node* PyParser_SimpleParseString (const
          char *str, int start)

     This is a simplified interface to *note
     PyParser_SimpleParseStringFlagsFilename(): 3b16. below, leaving
     `filename' set to ‘NULL’ and `flags' set to ‘0’.

 -- C Function: struct _node* PyParser_SimpleParseStringFlags (const
          char *str, int start, int flags)

     This is a simplified interface to *note
     PyParser_SimpleParseStringFlagsFilename(): 3b16. below, leaving
     `filename' set to ‘NULL’.

 -- C Function: struct _node* PyParser_SimpleParseStringFlagsFilename
          (const char *str, const char *filename, int start, int flags)

     Parse Python source code from `str' using the start token `start'
     according to the `flags' argument.  The result can be used to
     create a code object which can be evaluated efficiently.  This is
     useful if a code fragment must be evaluated many times.  `filename'
     is decoded from the filesystem encoding (*note
     sys.getfilesystemencoding(): 4eb.).

 -- C Function: struct _node* PyParser_SimpleParseFile (FILE *fp, const
          char *filename, int start)

     This is a simplified interface to *note
     PyParser_SimpleParseFileFlags(): 3b19. below, leaving `flags' set
     to ‘0’.

 -- C Function: struct _node* PyParser_SimpleParseFileFlags (FILE *fp,
          const char *filename, int start, int flags)

     Similar to *note PyParser_SimpleParseStringFlagsFilename(): 3b16,
     but the Python source code is read from `fp' instead of an
     in-memory string.

 -- C Function: PyObject* PyRun_String (const char *str, int start,
          PyObject *globals, PyObject *locals)
     `Return value: New reference.'  This is a simplified interface to
     *note PyRun_StringFlags(): 3b1a. below, leaving `flags' set to
     ‘NULL’.

 -- C Function: PyObject* PyRun_StringFlags (const char *str, int start,
          PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
     `Return value: New reference.'  Execute Python source code from
     `str' in the context specified by the objects `globals' and
     `locals' with the compiler flags specified by `flags'.  `globals'
     must be a dictionary; `locals' can be any object that implements
     the mapping protocol.  The parameter `start' specifies the start
     token that should be used to parse the source code.

     Returns the result of executing the code as a Python object, or
     ‘NULL’ if an exception was raised.

 -- C Function: PyObject* PyRun_File (FILE *fp, const char *filename,
          int start, PyObject *globals, PyObject *locals)
     `Return value: New reference.'  This is a simplified interface to
     *note PyRun_FileExFlags(): 3b1c. below, leaving `closeit' set to
     ‘0’ and `flags' set to ‘NULL’.

 -- C Function: PyObject* PyRun_FileEx (FILE *fp, const char *filename,
          int start, PyObject *globals, PyObject *locals, int closeit)
     `Return value: New reference.'  This is a simplified interface to
     *note PyRun_FileExFlags(): 3b1c. below, leaving `flags' set to
     ‘NULL’.

 -- C Function: PyObject* PyRun_FileFlags (FILE *fp, const
          char *filename, int start, PyObject *globals,
          PyObject *locals, PyCompilerFlags *flags)
     `Return value: New reference.'  This is a simplified interface to
     *note PyRun_FileExFlags(): 3b1c. below, leaving `closeit' set to
     ‘0’.

 -- C Function: PyObject* PyRun_FileExFlags (FILE *fp, const
          char *filename, int start, PyObject *globals,
          PyObject *locals, int closeit, PyCompilerFlags *flags)
     `Return value: New reference.'  Similar to *note
     PyRun_StringFlags(): 3b1a, but the Python source code is read from
     `fp' instead of an in-memory string.  `filename' should be the name
     of the file, it is decoded from the filesystem encoding (*note
     sys.getfilesystemencoding(): 4eb.).  If `closeit' is true, the file
     is closed before *note PyRun_FileExFlags(): 3b1c. returns.

 -- C Function: PyObject* Py_CompileString (const char *str, const
          char *filename, int start)
     `Return value: New reference.'  This is a simplified interface to
     *note Py_CompileStringFlags(): 3b20. below, leaving `flags' set to
     ‘NULL’.

 -- C Function: PyObject* Py_CompileStringFlags (const char *str, const
          char *filename, int start, PyCompilerFlags *flags)
     `Return value: New reference.'  This is a simplified interface to
     *note Py_CompileStringExFlags(): 3b21. below, with `optimize' set
     to ‘-1’.

 -- C Function: PyObject* Py_CompileStringObject (const char *str,
          PyObject *filename, int start, PyCompilerFlags *flags,
          int optimize)
     `Return value: New reference.'  Parse and compile the Python source
     code in `str', returning the resulting code object.  The start
     token is given by `start'; this can be used to constrain the code
     which can be compiled and should be ‘Py_eval_input’,
     ‘Py_file_input’, or ‘Py_single_input’.  The filename specified by
     `filename' is used to construct the code object and may appear in
     tracebacks or *note SyntaxError: 44d. exception messages.  This
     returns ‘NULL’ if the code cannot be parsed or compiled.

     The integer `optimize' specifies the optimization level of the
     compiler; a value of ‘-1’ selects the optimization level of the
     interpreter as given by *note -O: 67f. options.  Explicit levels
     are ‘0’ (no optimization; ‘__debug__’ is true), ‘1’ (asserts are
     removed, ‘__debug__’ is false) or ‘2’ (docstrings are removed too).

     New in version 3.4.

 -- C Function: PyObject* Py_CompileStringExFlags (const char *str,
          const char *filename, int start, PyCompilerFlags *flags,
          int optimize)
     `Return value: New reference.'  Like *note
     Py_CompileStringObject(): 3b22, but `filename' is a byte string
     decoded from the filesystem encoding (*note os.fsdecode(): 4e3.).

     New in version 3.2.

 -- C Function: PyObject* PyEval_EvalCode (PyObject *co,
          PyObject *globals, PyObject *locals)
     `Return value: New reference.'  This is a simplified interface to
     *note PyEval_EvalCodeEx(): 3b24, with just the code object, and
     global and local variables.  The other arguments are set to ‘NULL’.

 -- C Function: PyObject* PyEval_EvalCodeEx (PyObject *co,
          PyObject *globals, PyObject *locals, PyObject *const *args,
          int argcount, PyObject *const *kws, int kwcount, PyObject
          *const *defs, int defcount, PyObject *kwdefs,
          PyObject *closure)
     `Return value: New reference.'  Evaluate a precompiled code object,
     given a particular environment for its evaluation.  This
     environment consists of a dictionary of global variables, a mapping
     object of local variables, arrays of arguments, keywords and
     defaults, a dictionary of default values for *note keyword-only:
     2aa. arguments and a closure tuple of cells.

 -- C Type: PyFrameObject

     The C structure of the objects used to describe frame objects.  The
     fields of this type are subject to change at any time.

 -- C Function: PyObject* PyEval_EvalFrame (PyFrameObject *f)
     `Return value: New reference.'  Evaluate an execution frame.  This
     is a simplified interface to *note PyEval_EvalFrameEx(): 95b, for
     backward compatibility.

 -- C Function: PyObject* PyEval_EvalFrameEx (PyFrameObject *f,
          int throwflag)
     `Return value: New reference.'  This is the main, unvarnished
     function of Python interpretation.  The code object associated with
     the execution frame `f' is executed, interpreting bytecode and
     executing calls as needed.  The additional `throwflag' parameter
     can mostly be ignored - if true, then it causes an exception to
     immediately be thrown; this is used for the *note throw(): 13cd.
     methods of generator objects.

     Changed in version 3.4: This function now includes a debug
     assertion to help ensure that it does not silently discard an
     active exception.

 -- C Function: int PyEval_MergeCompilerFlags (PyCompilerFlags *cf)

     This function changes the flags of the current evaluation frame,
     and returns true on success, false on failure.

 -- C Variable: int Py_eval_input

     The start symbol from the Python grammar for isolated expressions;
     for use with *note Py_CompileString(): 3b1f.

 -- C Variable: int Py_file_input

     The start symbol from the Python grammar for sequences of
     statements as read from a file or other source; for use with *note
     Py_CompileString(): 3b1f.  This is the symbol to use when compiling
     arbitrarily long Python source code.

 -- C Variable: int Py_single_input

     The start symbol from the Python grammar for a single statement;
     for use with *note Py_CompileString(): 3b1f.  This is the symbol
     used for the interactive interpreter loop.

 -- C Type: struct PyCompilerFlags

     This is the structure used to hold compiler flags.  In cases where
     code is only being compiled, it is passed as ‘int flags’, and in
     cases where code is being executed, it is passed as
     ‘PyCompilerFlags *flags’.  In this case, ‘from __future__ import’
     can modify `flags'.

     Whenever ‘PyCompilerFlags *flags’ is ‘NULL’, ‘cf_flags’ is treated
     as equal to ‘0’, and any modification due to ‘from __future__
     import’ is discarded.

      -- C Member: int cf_flags

          Compiler flags.

      -- C Member: int cf_feature_version

          `cf_feature_version' is the minor Python version.  It should
          be initialized to ‘PY_MINOR_VERSION’.

          The field is ignored by default, it is used if and only if
          ‘PyCF_ONLY_AST’ flag is set in `cf_flags'.

     Changed in version 3.8: Added `cf_feature_version' field.

 -- C Variable: int CO_FUTURE_DIVISION

     This bit can be set in `flags' to cause division operator ‘/’ to be
     interpreted as “true division” according to PEP 238(1).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0238


File: python.info,  Node: Reference Counting,  Next: Exception Handling,  Prev: The Very High Level Layer,  Up: Python/C API Reference Manual

7.4 Reference Counting
======================

The macros in this section are used for managing reference counts of
Python objects.

 -- C Function: void Py_INCREF (PyObject *o)

     Increment the reference count for object `o'.  The object must not
     be ‘NULL’; if you aren’t sure that it isn’t ‘NULL’, use *note
     Py_XINCREF(): 265.

 -- C Function: void Py_XINCREF (PyObject *o)

     Increment the reference count for object `o'.  The object may be
     ‘NULL’, in which case the macro has no effect.

 -- C Function: void Py_DECREF (PyObject *o)

     Decrement the reference count for object `o'.  The object must not
     be ‘NULL’; if you aren’t sure that it isn’t ‘NULL’, use *note
     Py_XDECREF(): 266.  If the reference count reaches zero, the
     object’s type’s deallocation function (which must not be ‘NULL’) is
     invoked.

          Warning: The deallocation function can cause arbitrary Python
          code to be invoked (e.g.  when a class instance with a *note
          __del__(): 913. method is deallocated).  While exceptions in
          such code are not propagated, the executed code has free
          access to all Python global variables.  This means that any
          object that is reachable from a global variable should be in a
          consistent state before *note Py_DECREF(): 264. is invoked.
          For example, code to delete an object from a list should copy
          a reference to the deleted object in a temporary variable,
          update the list data structure, and then call *note
          Py_DECREF(): 264. for the temporary variable.

 -- C Function: void Py_XDECREF (PyObject *o)

     Decrement the reference count for object `o'.  The object may be
     ‘NULL’, in which case the macro has no effect; otherwise the effect
     is the same as for *note Py_DECREF(): 264, and the same warning
     applies.

 -- C Function: void Py_CLEAR (PyObject *o)

     Decrement the reference count for object `o'.  The object may be
     ‘NULL’, in which case the macro has no effect; otherwise the effect
     is the same as for *note Py_DECREF(): 264, except that the argument
     is also set to ‘NULL’.  The warning for *note Py_DECREF(): 264.
     does not apply with respect to the object passed because the macro
     carefully uses a temporary variable and sets the argument to ‘NULL’
     before decrementing its reference count.

     It is a good idea to use this macro whenever decrementing the
     reference count of an object that might be traversed during garbage
     collection.

The following functions are for runtime dynamic embedding of Python:
‘Py_IncRef(PyObject *o)’, ‘Py_DecRef(PyObject *o)’.  They are simply
exported function versions of *note Py_XINCREF(): 265. and *note
Py_XDECREF(): 266, respectively.

The following functions or macros are only for use within the
interpreter core: ‘_Py_Dealloc()’, ‘_Py_ForgetReference()’,
‘_Py_NewReference()’, as well as the global variable ‘_Py_RefTotal’.


File: python.info,  Node: Exception Handling,  Next: Utilities<2>,  Prev: Reference Counting,  Up: Python/C API Reference Manual

7.5 Exception Handling
======================

The functions described in this chapter will let you handle and raise
Python exceptions.  It is important to understand some of the basics of
Python exception handling.  It works somewhat like the POSIX ‘errno’
variable: there is a global indicator (per thread) of the last error
that occurred.  Most C API functions don’t clear this on success, but
will set it to indicate the cause of the error on failure.  Most C API
functions also return an error indicator, usually ‘NULL’ if they are
supposed to return a pointer, or ‘-1’ if they return an integer
(exception: the ‘PyArg_*()’ functions return ‘1’ for success and ‘0’ for
failure).

Concretely, the error indicator consists of three object pointers: the
exception’s type, the exception’s value, and the traceback object.  Any
of those pointers can be ‘NULL’ if non-set (although some combinations
are forbidden, for example you can’t have a non-‘NULL’ traceback if the
exception type is ‘NULL’).

When a function must fail because some function it called failed, it
generally doesn’t set the error indicator; the function it called
already set it.  It is responsible for either handling the error and
clearing the exception or returning after cleaning up any resources it
holds (such as object references or memory allocations); it should `not'
continue normally if it is not prepared to handle the error.  If
returning due to an error, it is important to indicate to the caller
that an error has been set.  If the error is not handled or carefully
propagated, additional calls into the Python/C API may not behave as
intended and may fail in mysterious ways.

     Note: The error indicator is `not' the result of *note
     sys.exc_info(): c52.  The former corresponds to an exception that
     is not yet caught (and is therefore still propagating), while the
     latter returns an exception after it is caught (and has therefore
     stopped propagating).

* Menu:

* Printing and clearing::
* Raising exceptions::
* Issuing warnings::
* Querying the error indicator::
* Signal Handling: Signal Handling<2>.
* Exception Classes::
* Exception Objects::
* Unicode Exception Objects::
* Recursion Control::
* Standard Exceptions::
* Standard Warning Categories::


File: python.info,  Node: Printing and clearing,  Next: Raising exceptions,  Up: Exception Handling

7.5.1 Printing and clearing
---------------------------

 -- C Function: void PyErr_Clear ()

     Clear the error indicator.  If the error indicator is not set,
     there is no effect.

 -- C Function: void PyErr_PrintEx (int set_sys_last_vars)

     Print a standard traceback to ‘sys.stderr’ and clear the error
     indicator.  `Unless' the error is a ‘SystemExit’, in that case no
     traceback is printed and the Python process will exit with the
     error code specified by the ‘SystemExit’ instance.

     Call this function `only' when the error indicator is set.
     Otherwise it will cause a fatal error!

     If `set_sys_last_vars' is nonzero, the variables *note
     sys.last_type: c4d, *note sys.last_value: 3572. and *note
     sys.last_traceback: 346d. will be set to the type, value and
     traceback of the printed exception, respectively.

 -- C Function: void PyErr_Print ()

     Alias for ‘PyErr_PrintEx(1)’.

 -- C Function: void PyErr_WriteUnraisable (PyObject *obj)

     Call *note sys.unraisablehook(): 22b. using the current exception
     and `obj' argument.

     This utility function prints a warning message to ‘sys.stderr’ when
     an exception has been set but it is impossible for the interpreter
     to actually raise the exception.  It is used, for example, when an
     exception occurs in an *note __del__(): 913. method.

     The function is called with a single argument `obj' that identifies
     the context in which the unraisable exception occurred.  If
     possible, the repr of `obj' will be printed in the warning message.

     An exception must be set when calling this function.


File: python.info,  Node: Raising exceptions,  Next: Issuing warnings,  Prev: Printing and clearing,  Up: Exception Handling

7.5.2 Raising exceptions
------------------------

These functions help you set the current thread’s error indicator.  For
convenience, some of these functions will always return a ‘NULL’ pointer
for use in a ‘return’ statement.

 -- C Function: void PyErr_SetString (PyObject *type, const
          char *message)

     This is the most common way to set the error indicator.  The first
     argument specifies the exception type; it is normally one of the
     standard exceptions, e.g.  ‘PyExc_RuntimeError’.  You need not
     increment its reference count.  The second argument is an error
     message; it is decoded from ‘'utf-8’’.

 -- C Function: void PyErr_SetObject (PyObject *type, PyObject *value)

     This function is similar to *note PyErr_SetString(): 3a40. but lets
     you specify an arbitrary Python object for the “value” of the
     exception.

 -- C Function: PyObject* PyErr_Format (PyObject *exception, const
          char *format, ...)
     `Return value: Always NULL.' This function sets the error indicator
     and returns ‘NULL’.  `exception' should be a Python exception
     class.  The `format' and subsequent parameters help format the
     error message; they have the same meaning and values as in *note
     PyUnicode_FromFormat(): 7bf.  `format' is an ASCII-encoded string.

 -- C Function: PyObject* PyErr_FormatV (PyObject *exception, const
          char *format, va_list vargs)
     `Return value: Always NULL.' Same as *note PyErr_Format(): 79e, but
     taking a ‘va_list’ argument rather than a variable number of
     arguments.

     New in version 3.5.

 -- C Function: void PyErr_SetNone (PyObject *type)

     This is a shorthand for ‘PyErr_SetObject(type, Py_None)’.

 -- C Function: int PyErr_BadArgument ()

     This is a shorthand for ‘PyErr_SetString(PyExc_TypeError,
     message)’, where `message' indicates that a built-in operation was
     invoked with an illegal argument.  It is mostly for internal use.

 -- C Function: PyObject* PyErr_NoMemory ()
     `Return value: Always NULL.' This is a shorthand for
     ‘PyErr_SetNone(PyExc_MemoryError)’; it returns ‘NULL’ so an object
     allocation function can write ‘return PyErr_NoMemory();’ when it
     runs out of memory.

 -- C Function: PyObject* PyErr_SetFromErrno (PyObject *type)
     `Return value: Always NULL.'

     This is a convenience function to raise an exception when a C
     library function has returned an error and set the C variable
     ‘errno’.  It constructs a tuple object whose first item is the
     integer ‘errno’ value and whose second item is the corresponding
     error message (gotten from ‘strerror()’), and then calls
     ‘PyErr_SetObject(type, object)’.  On Unix, when the ‘errno’ value
     is ‘EINTR’, indicating an interrupted system call, this calls *note
     PyErr_CheckSignals(): 3b37, and if that set the error indicator,
     leaves it set to that.  The function always returns ‘NULL’, so a
     wrapper function around a system call can write ‘return
     PyErr_SetFromErrno(type);’ when the system call returns an error.

 -- C Function: PyObject* PyErr_SetFromErrnoWithFilenameObject
          (PyObject *type, PyObject *filenameObject)
     `Return value: Always NULL.' Similar to *note PyErr_SetFromErrno():
     3a41, with the additional behavior that if `filenameObject' is not
     ‘NULL’, it is passed to the constructor of `type' as a third
     parameter.  In the case of *note OSError: 1d1. exception, this is
     used to define the ‘filename’ attribute of the exception instance.

 -- C Function: PyObject* PyErr_SetFromErrnoWithFilenameObjects
          (PyObject *type, PyObject *filenameObject,
          PyObject *filenameObject2)
     `Return value: Always NULL.' Similar to *note
     PyErr_SetFromErrnoWithFilenameObject(): 3b38, but takes a second
     filename object, for raising errors when a function that takes two
     filenames fails.

     New in version 3.4.

 -- C Function: PyObject* PyErr_SetFromErrnoWithFilename
          (PyObject *type, const char *filename)
     `Return value: Always NULL.' Similar to *note
     PyErr_SetFromErrnoWithFilenameObject(): 3b38, but the filename is
     given as a C string.  `filename' is decoded from the filesystem
     encoding (*note os.fsdecode(): 4e3.).

 -- C Function: PyObject* PyErr_SetFromWindowsErr (int ierr)
     `Return value: Always NULL.' This is a convenience function to
     raise *note WindowsError: 988.  If called with `ierr' of ‘0’, the
     error code returned by a call to ‘GetLastError()’ is used instead.
     It calls the Win32 function ‘FormatMessage()’ to retrieve the
     Windows description of error code given by `ierr' or
     ‘GetLastError()’, then it constructs a tuple object whose first
     item is the `ierr' value and whose second item is the corresponding
     error message (gotten from ‘FormatMessage()’), and then calls
     ‘PyErr_SetObject(PyExc_WindowsError, object)’.  This function
     always returns ‘NULL’.

     *note Availability: 129a.: Windows.

 -- C Function: PyObject* PyErr_SetExcFromWindowsErr (PyObject *type,
          int ierr)
     `Return value: Always NULL.' Similar to *note
     PyErr_SetFromWindowsErr(): 3b3b, with an additional parameter
     specifying the exception type to be raised.

     *note Availability: 129a.: Windows.

 -- C Function: PyObject* PyErr_SetFromWindowsErrWithFilename (int ierr,
          const char *filename)
     `Return value: Always NULL.' Similar to
     ‘PyErr_SetFromWindowsErrWithFilenameObject()’, but the filename is
     given as a C string.  `filename' is decoded from the filesystem
     encoding (*note os.fsdecode(): 4e3.).

     *note Availability: 129a.: Windows.

 -- C Function: PyObject* PyErr_SetExcFromWindowsErrWithFilenameObject
          (PyObject *type, int ierr, PyObject *filename)
     `Return value: Always NULL.' Similar to
     ‘PyErr_SetFromWindowsErrWithFilenameObject()’, with an additional
     parameter specifying the exception type to be raised.

     *note Availability: 129a.: Windows.

 -- C Function: PyObject* PyErr_SetExcFromWindowsErrWithFilenameObjects
          (PyObject *type, int ierr, PyObject *filename,
          PyObject *filename2)
     `Return value: Always NULL.' Similar to *note
     PyErr_SetExcFromWindowsErrWithFilenameObject(): 3b3e, but accepts a
     second filename object.

     *note Availability: 129a.: Windows.

     New in version 3.4.

 -- C Function: PyObject* PyErr_SetExcFromWindowsErrWithFilename
          (PyObject *type, int ierr, const char *filename)
     `Return value: Always NULL.' Similar to *note
     PyErr_SetFromWindowsErrWithFilename(): 3b3d, with an additional
     parameter specifying the exception type to be raised.

     *note Availability: 129a.: Windows.

 -- C Function: PyObject* PyErr_SetImportError (PyObject *msg,
          PyObject *name, PyObject *path)
     `Return value: Always NULL.' This is a convenience function to
     raise *note ImportError: 329.  `msg' will be set as the exception’s
     message string.  `name' and `path', both of which can be ‘NULL’,
     will be set as the *note ImportError: 329.’s respective ‘name’ and
     ‘path’ attributes.

     New in version 3.3.

 -- C Function: void PyErr_SyntaxLocationObject (PyObject *filename,
          int lineno, int col_offset)

     Set file, line, and offset information for the current exception.
     If the current exception is not a *note SyntaxError: 44d, then it
     sets additional attributes, which make the exception printing
     subsystem think the exception is a *note SyntaxError: 44d.

     New in version 3.4.

 -- C Function: void PyErr_SyntaxLocationEx (const char *filename,
          int lineno, int col_offset)

     Like *note PyErr_SyntaxLocationObject(): 3b41, but `filename' is a
     byte string decoded from the filesystem encoding (*note
     os.fsdecode(): 4e3.).

     New in version 3.2.

 -- C Function: void PyErr_SyntaxLocation (const char *filename,
          int lineno)

     Like *note PyErr_SyntaxLocationEx(): 3b42, but the col_offset
     parameter is omitted.

 -- C Function: void PyErr_BadInternalCall ()

     This is a shorthand for ‘PyErr_SetString(PyExc_SystemError,
     message)’, where `message' indicates that an internal operation
     (e.g.  a Python/C API function) was invoked with an illegal
     argument.  It is mostly for internal use.


File: python.info,  Node: Issuing warnings,  Next: Querying the error indicator,  Prev: Raising exceptions,  Up: Exception Handling

7.5.3 Issuing warnings
----------------------

Use these functions to issue warnings from C code.  They mirror similar
functions exported by the Python *note warnings: 126. module.  They
normally print a warning message to `sys.stderr'; however, it is also
possible that the user has specified that warnings are to be turned into
errors, and in that case they will raise an exception.  It is also
possible that the functions raise an exception because of a problem with
the warning machinery.  The return value is ‘0’ if no exception is
raised, or ‘-1’ if an exception is raised.  (It is not possible to
determine whether a warning message is actually printed, nor what the
reason is for the exception; this is intentional.)  If an exception is
raised, the caller should do its normal exception handling (for example,
*note Py_DECREF(): 264. owned references and return an error value).

 -- C Function: int PyErr_WarnEx (PyObject *category, const
          char *message, Py_ssize_t stack_level)

     Issue a warning message.  The `category' argument is a warning
     category (see below) or ‘NULL’; the `message' argument is a UTF-8
     encoded string.  `stack_level' is a positive number giving a number
     of stack frames; the warning will be issued from the currently
     executing line of code in that stack frame.  A `stack_level' of 1
     is the function calling *note PyErr_WarnEx(): da4, 2 is the
     function above that, and so forth.

     Warning categories must be subclasses of ‘PyExc_Warning’;
     ‘PyExc_Warning’ is a subclass of ‘PyExc_Exception’; the default
     warning category is ‘PyExc_RuntimeWarning’.  The standard Python
     warning categories are available as global variables whose names
     are enumerated at *note Standard Warning Categories: 3b46.

     For information about warning control, see the documentation for
     the *note warnings: 126. module and the *note -W: 40c. option in
     the command line documentation.  There is no C API for warning
     control.

 -- C Function: PyObject* PyErr_SetImportErrorSubclass
          (PyObject *exception, PyObject *msg, PyObject *name,
          PyObject *path)
     `Return value: Always NULL.' Much like *note
     PyErr_SetImportError(): 5ed. but this function allows for
     specifying a subclass of *note ImportError: 329. to raise.

     New in version 3.6.

 -- C Function: int PyErr_WarnExplicitObject (PyObject *category,
          PyObject *message, PyObject *filename, int lineno,
          PyObject *module, PyObject *registry)

     Issue a warning message with explicit control over all warning
     attributes.  This is a straightforward wrapper around the Python
     function *note warnings.warn_explicit(): 5a5, see there for more
     information.  The `module' and `registry' arguments may be set to
     ‘NULL’ to get the default effect described there.

     New in version 3.4.

 -- C Function: int PyErr_WarnExplicit (PyObject *category, const
          char *message, const char *filename, int lineno, const
          char *module, PyObject *registry)

     Similar to *note PyErr_WarnExplicitObject(): 3b47. except that
     `message' and `module' are UTF-8 encoded strings, and `filename' is
     decoded from the filesystem encoding (*note os.fsdecode(): 4e3.).

 -- C Function: int PyErr_WarnFormat (PyObject *category,
          Py_ssize_t stack_level, const char *format, ...)

     Function similar to *note PyErr_WarnEx(): da4, but use *note
     PyUnicode_FromFormat(): 7bf. to format the warning message.
     `format' is an ASCII-encoded string.

     New in version 3.2.

 -- C Function: int PyErr_ResourceWarning (PyObject *source,
          Py_ssize_t stack_level, const char *format, ...)

     Function similar to *note PyErr_WarnFormat(): 3b49, but `category'
     is *note ResourceWarning: 4c5. and pass `source' to
     ‘warnings.WarningMessage()’.

     New in version 3.6.


File: python.info,  Node: Querying the error indicator,  Next: Signal Handling<2>,  Prev: Issuing warnings,  Up: Exception Handling

7.5.4 Querying the error indicator
----------------------------------

 -- C Function: PyObject* PyErr_Occurred ()
     `Return value: Borrowed reference.'  Test whether the error
     indicator is set.  If set, return the exception `type' (the first
     argument to the last call to one of the ‘PyErr_Set*()’ functions or
     to *note PyErr_Restore(): 3a9b.).  If not set, return ‘NULL’.  You
     do not own a reference to the return value, so you do not need to
     *note Py_DECREF(): 264. it.

          Note: Do not compare the return value to a specific exception;
          use *note PyErr_ExceptionMatches(): 3afb. instead, shown
          below.  (The comparison could easily fail since the exception
          may be an instance instead of a class, in the case of a class
          exception, or it may be a subclass of the expected exception.)

 -- C Function: int PyErr_ExceptionMatches (PyObject *exc)

     Equivalent to ‘PyErr_GivenExceptionMatches(PyErr_Occurred(), exc)’.
     This should only be called when an exception is actually set; a
     memory access violation will occur if no exception has been raised.

 -- C Function: int PyErr_GivenExceptionMatches (PyObject *given,
          PyObject *exc)

     Return true if the `given' exception matches the exception type in
     `exc'.  If `exc' is a class object, this also returns true when
     `given' is an instance of a subclass.  If `exc' is a tuple, all
     exception types in the tuple (and recursively in subtuples) are
     searched for a match.

 -- C Function: void PyErr_Fetch (PyObject **ptype, PyObject **pvalue,
          PyObject **ptraceback)

     Retrieve the error indicator into three variables whose addresses
     are passed.  If the error indicator is not set, set all three
     variables to ‘NULL’.  If it is set, it will be cleared and you own
     a reference to each object retrieved.  The value and traceback
     object may be ‘NULL’ even when the type object is not.

          Note: This function is normally only used by code that needs
          to catch exceptions or by code that needs to save and restore
          the error indicator temporarily, e.g.:

               {    PyObject *type, *value, *traceback;    PyErr_Fetch(&type, &value, &traceback);     /* ... code that might produce other errors ... */     PyErr_Restore(type, value, traceback); }

 -- C Function: void PyErr_Restore (PyObject *type, PyObject *value,
          PyObject *traceback)

     Set the error indicator from the three objects.  If the error
     indicator is already set, it is cleared first.  If the objects are
     ‘NULL’, the error indicator is cleared.  Do not pass a ‘NULL’ type
     and non-‘NULL’ value or traceback.  The exception type should be a
     class.  Do not pass an invalid exception type or value.  (Violating
     these rules will cause subtle problems later.)  This call takes
     away a reference to each object: you must own a reference to each
     object before the call and after the call you no longer own these
     references.  (If you don’t understand this, don’t use this
     function.  I warned you.)

          Note: This function is normally only used by code that needs
          to save and restore the error indicator temporarily.  Use
          *note PyErr_Fetch(): 95e. to save the current error indicator.

 -- C Function: void PyErr_NormalizeException (PyObject**exc,
          PyObject**val, PyObject**tb)

     Under certain circumstances, the values returned by *note
     PyErr_Fetch(): 95e. below can be “unnormalized”, meaning that
     ‘*exc’ is a class object but ‘*val’ is not an instance of the same
     class.  This function can be used to instantiate the class in that
     case.  If the values are already normalized, nothing happens.  The
     delayed normalization is implemented to improve performance.

          Note: This function `does not' implicitly set the
          ‘__traceback__’ attribute on the exception value.  If setting
          the traceback appropriately is desired, the following
          additional snippet is needed:

               if (tb != NULL) {   PyException_SetTraceback(val, tb); }

 -- C Function: void PyErr_GetExcInfo (PyObject **ptype,
          PyObject **pvalue, PyObject **ptraceback)

     Retrieve the exception info, as known from ‘sys.exc_info()’.  This
     refers to an exception that was `already caught', not to an
     exception that was freshly raised.  Returns new references for the
     three objects, any of which may be ‘NULL’.  Does not modify the
     exception info state.

          Note: This function is not normally used by code that wants to
          handle exceptions.  Rather, it can be used when code needs to
          save and restore the exception state temporarily.  Use *note
          PyErr_SetExcInfo(): 3b4d. to restore or clear the exception
          state.

     New in version 3.3.

 -- C Function: void PyErr_SetExcInfo (PyObject *type, PyObject *value,
          PyObject *traceback)

     Set the exception info, as known from ‘sys.exc_info()’.  This
     refers to an exception that was `already caught', not to an
     exception that was freshly raised.  This function steals the
     references of the arguments.  To clear the exception state, pass
     ‘NULL’ for all three arguments.  For general rules about the three
     arguments, see *note PyErr_Restore(): 3a9b.

          Note: This function is not normally used by code that wants to
          handle exceptions.  Rather, it can be used when code needs to
          save and restore the exception state temporarily.  Use *note
          PyErr_GetExcInfo(): 3b4c. to read the exception state.

     New in version 3.3.


File: python.info,  Node: Signal Handling<2>,  Next: Exception Classes,  Prev: Querying the error indicator,  Up: Exception Handling

7.5.5 Signal Handling
---------------------

 -- C Function: int PyErr_CheckSignals ()

     This function interacts with Python’s signal handling.  It checks
     whether a signal has been sent to the processes and if so, invokes
     the corresponding signal handler.  If the *note signal: ea. module
     is supported, this can invoke a signal handler written in Python.
     In all cases, the default effect for ‘SIGINT’ is to raise the *note
     KeyboardInterrupt: 197. exception.  If an exception is raised the
     error indicator is set and the function returns ‘-1’; otherwise the
     function returns ‘0’.  The error indicator may or may not be
     cleared if it was previously set.

 -- C Function: void PyErr_SetInterrupt ()

     Simulate the effect of a ‘SIGINT’ signal arriving.  The next time
     *note PyErr_CheckSignals(): 3b37. is called, the Python signal
     handler for ‘SIGINT’ will be called.

     If ‘SIGINT’ isn’t handled by Python (it was set to *note
     signal.SIG_DFL: 2401. or *note signal.SIG_IGN: 2402.), this
     function does nothing.

 -- C Function: int PySignal_SetWakeupFd (int fd)

     This utility function specifies a file descriptor to which the
     signal number is written as a single byte whenever a signal is
     received.  `fd' must be non-blocking.  It returns the previous such
     file descriptor.

     The value ‘-1’ disables the feature; this is the initial state.
     This is equivalent to *note signal.set_wakeup_fd(): 3c3. in Python,
     but without any error checking.  `fd' should be a valid file
     descriptor.  The function should only be called from the main
     thread.

     Changed in version 3.5: On Windows, the function now also supports
     socket handles.


File: python.info,  Node: Exception Classes,  Next: Exception Objects,  Prev: Signal Handling<2>,  Up: Exception Handling

7.5.6 Exception Classes
-----------------------

 -- C Function: PyObject* PyErr_NewException (const char *name,
          PyObject *base, PyObject *dict)
     `Return value: New reference.'  This utility function creates and
     returns a new exception class.  The `name' argument must be the
     name of the new exception, a C string of the form
     ‘module.classname’.  The `base' and `dict' arguments are normally
     ‘NULL’.  This creates a class object derived from *note Exception:
     1a8. (accessible in C as ‘PyExc_Exception’).

     The ‘__module__’ attribute of the new class is set to the first
     part (up to the last dot) of the `name' argument, and the class
     name is set to the last part (after the last dot).  The `base'
     argument can be used to specify alternate base classes; it can
     either be only one class or a tuple of classes.  The `dict'
     argument can be used to specify a dictionary of class variables and
     methods.

 -- C Function: PyObject* PyErr_NewExceptionWithDoc (const char *name,
          const char *doc, PyObject *base, PyObject *dict)
     `Return value: New reference.'  Same as *note PyErr_NewException():
     bf3, except that the new exception class can easily be given a
     docstring: If `doc' is non-‘NULL’, it will be used as the docstring
     for the exception class.

     New in version 3.2.


File: python.info,  Node: Exception Objects,  Next: Unicode Exception Objects,  Prev: Exception Classes,  Up: Exception Handling

7.5.7 Exception Objects
-----------------------

 -- C Function: PyObject* PyException_GetTraceback (PyObject *ex)
     `Return value: New reference.'  Return the traceback associated
     with the exception as a new reference, as accessible from Python
     through ‘__traceback__’.  If there is no traceback associated, this
     returns ‘NULL’.

 -- C Function: int PyException_SetTraceback (PyObject *ex,
          PyObject *tb)

     Set the traceback associated with the exception to `tb'.  Use
     ‘Py_None’ to clear it.

 -- C Function: PyObject* PyException_GetContext (PyObject *ex)
     `Return value: New reference.'  Return the context (another
     exception instance during whose handling `ex' was raised)
     associated with the exception as a new reference, as accessible
     from Python through ‘__context__’.  If there is no context
     associated, this returns ‘NULL’.

 -- C Function: void PyException_SetContext (PyObject *ex,
          PyObject *ctx)

     Set the context associated with the exception to `ctx'.  Use ‘NULL’
     to clear it.  There is no type check to make sure that `ctx' is an
     exception instance.  This steals a reference to `ctx'.

 -- C Function: PyObject* PyException_GetCause (PyObject *ex)
     `Return value: New reference.'  Return the cause (either an
     exception instance, or *note None: 157, set by ‘raise ... from
     ...’) associated with the exception as a new reference, as
     accessible from Python through ‘__cause__’.

 -- C Function: void PyException_SetCause (PyObject *ex,
          PyObject *cause)

     Set the cause associated with the exception to `cause'.  Use ‘NULL’
     to clear it.  There is no type check to make sure that `cause' is
     either an exception instance or *note None: 157.  This steals a
     reference to `cause'.

     ‘__suppress_context__’ is implicitly set to ‘True’ by this
     function.


File: python.info,  Node: Unicode Exception Objects,  Next: Recursion Control,  Prev: Exception Objects,  Up: Exception Handling

7.5.8 Unicode Exception Objects
-------------------------------

The following functions are used to create and modify Unicode exceptions
from C.

 -- C Function: PyObject* PyUnicodeDecodeError_Create (const
          char *encoding, const char *object, Py_ssize_t length,
          Py_ssize_t start, Py_ssize_t end, const char *reason)
     `Return value: New reference.'  Create a *note UnicodeDecodeError:
     1fb. object with the attributes `encoding', `object', `length',
     `start', `end' and `reason'.  `encoding' and `reason' are UTF-8
     encoded strings.

 -- C Function: PyObject* PyUnicodeEncodeError_Create (const
          char *encoding, const Py_UNICODE *object, Py_ssize_t length,
          Py_ssize_t start, Py_ssize_t end, const char *reason)
     `Return value: New reference.'  Create a *note UnicodeEncodeError:
     1fa. object with the attributes `encoding', `object', `length',
     `start', `end' and `reason'.  `encoding' and `reason' are UTF-8
     encoded strings.

 -- C Function: PyObject* PyUnicodeTranslateError_Create (const
          Py_UNICODE *object, Py_ssize_t length, Py_ssize_t start,
          Py_ssize_t end, const char *reason)
     `Return value: New reference.'  Create a *note
     UnicodeTranslateError: 164d. object with the attributes `object',
     `length', `start', `end' and `reason'.  `reason' is a UTF-8 encoded
     string.

 -- C Function: PyObject* PyUnicodeDecodeError_GetEncoding
          (PyObject *exc)
 -- C Function: PyObject* PyUnicodeEncodeError_GetEncoding
          (PyObject *exc)
     `Return value: New reference.'  Return the `encoding' attribute of
     the given exception object.

 -- C Function: PyObject* PyUnicodeDecodeError_GetObject (PyObject *exc)
 -- C Function: PyObject* PyUnicodeEncodeError_GetObject (PyObject *exc)
 -- C Function: PyObject* PyUnicodeTranslateError_GetObject
          (PyObject *exc)
     `Return value: New reference.'  Return the `object' attribute of
     the given exception object.

 -- C Function: int PyUnicodeDecodeError_GetStart (PyObject *exc,
          Py_ssize_t *start)
 -- C Function: int PyUnicodeEncodeError_GetStart (PyObject *exc,
          Py_ssize_t *start)
 -- C Function: int PyUnicodeTranslateError_GetStart (PyObject *exc,
          Py_ssize_t *start)

     Get the `start' attribute of the given exception object and place
     it into `*start'.  `start' must not be ‘NULL’.  Return ‘0’ on
     success, ‘-1’ on failure.

 -- C Function: int PyUnicodeDecodeError_SetStart (PyObject *exc,
          Py_ssize_t start)
 -- C Function: int PyUnicodeEncodeError_SetStart (PyObject *exc,
          Py_ssize_t start)
 -- C Function: int PyUnicodeTranslateError_SetStart (PyObject *exc,
          Py_ssize_t start)

     Set the `start' attribute of the given exception object to `start'.
     Return ‘0’ on success, ‘-1’ on failure.

 -- C Function: int PyUnicodeDecodeError_GetEnd (PyObject *exc,
          Py_ssize_t *end)
 -- C Function: int PyUnicodeEncodeError_GetEnd (PyObject *exc,
          Py_ssize_t *end)
 -- C Function: int PyUnicodeTranslateError_GetEnd (PyObject *exc,
          Py_ssize_t *end)

     Get the `end' attribute of the given exception object and place it
     into `*end'.  `end' must not be ‘NULL’.  Return ‘0’ on success,
     ‘-1’ on failure.

 -- C Function: int PyUnicodeDecodeError_SetEnd (PyObject *exc,
          Py_ssize_t end)
 -- C Function: int PyUnicodeEncodeError_SetEnd (PyObject *exc,
          Py_ssize_t end)
 -- C Function: int PyUnicodeTranslateError_SetEnd (PyObject *exc,
          Py_ssize_t end)

     Set the `end' attribute of the given exception object to `end'.
     Return ‘0’ on success, ‘-1’ on failure.

 -- C Function: PyObject* PyUnicodeDecodeError_GetReason (PyObject *exc)
 -- C Function: PyObject* PyUnicodeEncodeError_GetReason (PyObject *exc)
 -- C Function: PyObject* PyUnicodeTranslateError_GetReason
          (PyObject *exc)
     `Return value: New reference.'  Return the `reason' attribute of
     the given exception object.

 -- C Function: int PyUnicodeDecodeError_SetReason (PyObject *exc, const
          char *reason)
 -- C Function: int PyUnicodeEncodeError_SetReason (PyObject *exc, const
          char *reason)
 -- C Function: int PyUnicodeTranslateError_SetReason (PyObject *exc,
          const char *reason)

     Set the `reason' attribute of the given exception object to
     `reason'.  Return ‘0’ on success, ‘-1’ on failure.


File: python.info,  Node: Recursion Control,  Next: Standard Exceptions,  Prev: Unicode Exception Objects,  Up: Exception Handling

7.5.9 Recursion Control
-----------------------

These two functions provide a way to perform safe recursive calls at the
C level, both in the core and in extension modules.  They are needed if
the recursive code does not necessarily invoke Python code (which tracks
its recursion depth automatically).

 -- C Function: int Py_EnterRecursiveCall (const char *where)

     Marks a point where a recursive C-level call is about to be
     performed.

     If ‘USE_STACKCHECK’ is defined, this function checks if the OS
     stack overflowed using *note PyOS_CheckStack(): 3b75.  In this is
     the case, it sets a *note MemoryError: f42. and returns a nonzero
     value.

     The function then checks if the recursion limit is reached.  If
     this is the case, a *note RecursionError: 628. is set and a nonzero
     value is returned.  Otherwise, zero is returned.

     `where' should be a string such as ‘" in instance check"’ to be
     concatenated to the *note RecursionError: 628. message caused by
     the recursion depth limit.

 -- C Function: void Py_LeaveRecursiveCall ()

     Ends a *note Py_EnterRecursiveCall(): 3b74.  Must be called once
     for each `successful' invocation of *note Py_EnterRecursiveCall():
     3b74.

Properly implementing *note tp_repr: 3a9e. for container types requires
special recursion handling.  In addition to protecting the stack, *note
tp_repr: 3a9e. also needs to track objects to prevent cycles.  The
following two functions facilitate this functionality.  Effectively,
these are the C equivalent to *note reprlib.recursive_repr(): b63.

 -- C Function: int Py_ReprEnter (PyObject *object)

     Called at the beginning of the *note tp_repr: 3a9e. implementation
     to detect cycles.

     If the object has already been processed, the function returns a
     positive integer.  In that case the *note tp_repr: 3a9e.
     implementation should return a string object indicating a cycle.
     As examples, *note dict: 1b6. objects return ‘{...}’ and *note
     list: 260. objects return ‘[...]’.

     The function will return a negative integer if the recursion limit
     is reached.  In that case the *note tp_repr: 3a9e. implementation
     should typically return ‘NULL’.

     Otherwise, the function returns zero and the *note tp_repr: 3a9e.
     implementation can continue normally.

 -- C Function: void Py_ReprLeave (PyObject *object)

     Ends a *note Py_ReprEnter(): 3b77.  Must be called once for each
     invocation of *note Py_ReprEnter(): 3b77. that returns zero.


File: python.info,  Node: Standard Exceptions,  Next: Standard Warning Categories,  Prev: Recursion Control,  Up: Exception Handling

7.5.10 Standard Exceptions
--------------------------

All standard Python exceptions are available as global variables whose
names are ‘PyExc_’ followed by the Python exception name.  These have
the type *note PyObject*: 4b0.; they are all class objects.  For
completeness, here are all the variables:

C Name                                        Python Name                           Notes
                                                                                    
---------------------------------------------------------------------------------------------------
                                                                                    
‘PyExc_BaseException’                         *note BaseException: 1a7.             (1)
                                                                                    
                                                                                    
‘PyExc_Exception’                             *note Exception: 1a8.                 (1)
                                                                                    
                                                                                    
‘PyExc_ArithmeticError’                       *note ArithmeticError: 163a.          (1)
                                                                                    
                                                                                    
‘PyExc_AssertionError’                        *note AssertionError: f66.
                                              
                                                                                    
‘PyExc_AttributeError’                        *note AttributeError: 390.
                                              
                                                                                    
‘PyExc_BlockingIOError’                       *note BlockingIOError: 98b.
                                              
                                                                                    
‘PyExc_BrokenPipeError’                       *note BrokenPipeError: 991.
                                              
                                                                                    
‘PyExc_BufferError’                           *note BufferError: 163c.
                                              
                                                                                    
‘PyExc_ChildProcessError’                     *note ChildProcessError: 98c.
                                              
                                                                                    
‘PyExc_ConnectionAbortedError’                *note ConnectionAbortedError: 992.
                                              
                                                                                    
‘PyExc_ConnectionError’                       *note ConnectionError: 6da.
                                              
                                                                                    
‘PyExc_ConnectionRefusedError’                *note ConnectionRefusedError: 993.
                                              
                                                                                    
‘PyExc_ConnectionResetError’                  *note ConnectionResetError: 994.
                                              
                                                                                    
‘PyExc_EOFError’                              *note EOFError: c5f.
                                              
                                                                                    
‘PyExc_FileExistsError’                       *note FileExistsError: 94c.
                                              
                                                                                    
‘PyExc_FileNotFoundError’                     *note FileNotFoundError: 7b4.
                                              
                                                                                    
‘PyExc_FloatingPointError’                    *note FloatingPointError: 163b.
                                              
                                                                                    
‘PyExc_GeneratorExit’                         *note GeneratorExit: d25.
                                              
                                                                                    
‘PyExc_ImportError’                           *note ImportError: 329.
                                              
                                                                                    
‘PyExc_IndentationError’                      *note IndentationError: e6c.
                                              
                                                                                    
‘PyExc_IndexError’                            *note IndexError: e69.
                                              
                                                                                    
‘PyExc_InterruptedError’                      *note InterruptedError: 64d.
                                              
                                                                                    
‘PyExc_IsADirectoryError’                     *note IsADirectoryError: 98d.
                                              
                                                                                    
‘PyExc_KeyError’                              *note KeyError: 2c5.
                                              
                                                                                    
‘PyExc_KeyboardInterrupt’                     *note KeyboardInterrupt: 197.
                                              
                                                                                    
‘PyExc_LookupError’                           *note LookupError: 1599.              (1)
                                                                                    
                                                                                    
‘PyExc_MemoryError’                           *note MemoryError: f42.
                                              
                                                                                    
‘PyExc_ModuleNotFoundError’                   *note ModuleNotFoundError: 38f.
                                              
                                                                                    
‘PyExc_NameError’                             *note NameError: d6e.
                                              
                                                                                    
‘PyExc_NotADirectoryError’                    *note NotADirectoryError: 98e.
                                              
                                                                                    
‘PyExc_NotImplementedError’                   *note NotImplementedError: 603.
                                              
                                                                                    
‘PyExc_OSError’                               *note OSError: 1d1.                   (1)
                                                                                    
                                                                                    
‘PyExc_OverflowError’                         *note OverflowError: 954.
                                              
                                                                                    
‘PyExc_PermissionError’                       *note PermissionError: 5f4.
                                              
                                                                                    
‘PyExc_ProcessLookupError’                    *note ProcessLookupError: 98f.
                                              
                                                                                    
‘PyExc_RecursionError’                        *note RecursionError: 628.
                                              
                                                                                    
‘PyExc_ReferenceError’                        *note ReferenceError: e40.            (2)
                                                                                    
                                                                                    
‘PyExc_RuntimeError’                          *note RuntimeError: 2b8.
                                              
                                                                                    
‘PyExc_StopAsyncIteration’                    *note StopAsyncIteration: f49.
                                              
                                                                                    
‘PyExc_StopIteration’                         *note StopIteration: 47b.
                                              
                                                                                    
‘PyExc_SyntaxError’                           *note SyntaxError: 44d.
                                              
                                                                                    
‘PyExc_SystemError’                           *note SystemError: 5f0.
                                              
                                                                                    
‘PyExc_SystemExit’                            *note SystemExit: 5f1.
                                              
                                                                                    
‘PyExc_TabError’                              *note TabError: e6b.
                                              
                                                                                    
‘PyExc_TimeoutError’                          *note TimeoutError: 990.
                                              
                                                                                    
‘PyExc_TypeError’                             *note TypeError: 192.
                                              
                                                                                    
‘PyExc_UnboundLocalError’                     *note UnboundLocalError: e6a.
                                              
                                                                                    
‘PyExc_UnicodeDecodeError’                    *note UnicodeDecodeError: 1fb.
                                              
                                                                                    
‘PyExc_UnicodeEncodeError’                    *note UnicodeEncodeError: 1fa.
                                              
                                                                                    
‘PyExc_UnicodeError’                          *note UnicodeError: c2e.
                                              
                                                                                    
‘PyExc_UnicodeTranslateError’                 *note UnicodeTranslateError: 164d.
                                              
                                                                                    
‘PyExc_ValueError’                            *note ValueError: 1f9.
                                              
                                                                                    
‘PyExc_ZeroDivisionError’                     *note ZeroDivisionError: 11e6.
                                              

New in version 3.3: ‘PyExc_BlockingIOError’, ‘PyExc_BrokenPipeError’,
‘PyExc_ChildProcessError’, ‘PyExc_ConnectionError’,
‘PyExc_ConnectionAbortedError’, ‘PyExc_ConnectionRefusedError’,
‘PyExc_ConnectionResetError’, ‘PyExc_FileExistsError’,
‘PyExc_FileNotFoundError’, ‘PyExc_InterruptedError’,
‘PyExc_IsADirectoryError’, ‘PyExc_NotADirectoryError’,
‘PyExc_PermissionError’, ‘PyExc_ProcessLookupError’ and
‘PyExc_TimeoutError’ were introduced following PEP 3151(1).

New in version 3.5: ‘PyExc_StopAsyncIteration’ and
‘PyExc_RecursionError’.

New in version 3.6: ‘PyExc_ModuleNotFoundError’.

These are compatibility aliases to ‘PyExc_OSError’:

C Name                                    Notes
                                          
---------------------------------------------------------
                                          
‘PyExc_EnvironmentError’

‘PyExc_IOError’

‘PyExc_WindowsError’                      (3)
                                          

Changed in version 3.3: These aliases used to be separate exception
types.

Notes:

  1. This is a base class for other standard exceptions.

  2. This is the same as *note weakref.ReferenceError: e4e.

  3. Only defined on Windows; protect code that uses this by testing
     that the preprocessor macro ‘MS_WINDOWS’ is defined.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3151


File: python.info,  Node: Standard Warning Categories,  Prev: Standard Exceptions,  Up: Exception Handling

7.5.11 Standard Warning Categories
----------------------------------

All standard Python warning categories are available as global variables
whose names are ‘PyExc_’ followed by the Python exception name.  These
have the type *note PyObject*: 4b0.; they are all class objects.  For
completeness, here are all the variables:

C Name                                         Python Name                           Notes
                                                                                     
----------------------------------------------------------------------------------------------------
                                                                                     
‘PyExc_Warning’                                *note Warning: 1652.                  (1)
                                                                                     
                                                                                     
‘PyExc_BytesWarning’                           *note BytesWarning: 4ab.
                                               
                                                                                     
‘PyExc_DeprecationWarning’                     *note DeprecationWarning: 276.
                                               
                                                                                     
‘PyExc_FutureWarning’                          *note FutureWarning: 31a.
                                               
                                                                                     
‘PyExc_ImportWarning’                          *note ImportWarning: 5cd.
                                               
                                                                                     
‘PyExc_PendingDeprecationWarning’              *note PendingDeprecationWarning: 277.
                                               
                                                                                     
‘PyExc_ResourceWarning’                        *note ResourceWarning: 4c5.
                                               
                                                                                     
‘PyExc_RuntimeWarning’                         *note RuntimeWarning: 2be.
                                               
                                                                                     
‘PyExc_SyntaxWarning’                          *note SyntaxWarning: 191.
                                               
                                                                                     
‘PyExc_UnicodeWarning’                         *note UnicodeWarning: d7a.
                                               
                                                                                     
‘PyExc_UserWarning’                            *note UserWarning: 1653.
                                               

New in version 3.2: ‘PyExc_ResourceWarning’.

Notes:

  1. This is a base class for other standard warning categories.


File: python.info,  Node: Utilities<2>,  Next: Abstract Objects Layer,  Prev: Exception Handling,  Up: Python/C API Reference Manual

7.6 Utilities
=============

The functions in this chapter perform various utility tasks, ranging
from helping C code be more portable across platforms, using Python
modules from C, and parsing function arguments and constructing Python
values from C values.

* Menu:

* Operating System Utilities::
* System Functions::
* Process Control::
* Importing Modules: Importing Modules<2>.
* Data marshalling support::
* Parsing arguments and building values::
* String conversion and formatting::
* Reflection::
* Codec registry and support functions::


File: python.info,  Node: Operating System Utilities,  Next: System Functions,  Up: Utilities<2>

7.6.1 Operating System Utilities
--------------------------------

 -- C Function: PyObject* PyOS_FSPath (PyObject *path)
     `Return value: New reference.'  Return the file system
     representation for `path'.  If the object is a *note str: 325. or
     *note bytes: 326. object, then its reference count is incremented.
     If the object implements the *note os.PathLike: 4e0. interface,
     then *note __fspath__(): 4e1. is returned as long as it is a *note
     str: 325. or *note bytes: 326. object.  Otherwise *note TypeError:
     192. is raised and ‘NULL’ is returned.

     New in version 3.6.

 -- C Function: int Py_FdIsInteractive (FILE *fp, const char *filename)

     Return true (nonzero) if the standard I/O file `fp' with name
     `filename' is deemed interactive.  This is the case for files for
     which ‘isatty(fileno(fp))’ is true.  If the global flag *note
     Py_InteractiveFlag: 3b83. is true, this function also returns true
     if the `filename' pointer is ‘NULL’ or if the name is equal to one
     of the strings ‘'<stdin>'’ or ‘'???'’.

 -- C Function: void PyOS_BeforeFork ()

     Function to prepare some internal state before a process fork.
     This should be called before calling ‘fork()’ or any similar
     function that clones the current process.  Only available on
     systems where ‘fork()’ is defined.

          Warning: The C ‘fork()’ call should only be made from the
          *note “main” thread: 3b84. (of the *note “main” interpreter:
          3b85.).  The same is true for ‘PyOS_BeforeFork()’.

     New in version 3.7.

 -- C Function: void PyOS_AfterFork_Parent ()

     Function to update some internal state after a process fork.  This
     should be called from the parent process after calling ‘fork()’ or
     any similar function that clones the current process, regardless of
     whether process cloning was successful.  Only available on systems
     where ‘fork()’ is defined.

          Warning: The C ‘fork()’ call should only be made from the
          *note “main” thread: 3b84. (of the *note “main” interpreter:
          3b85.).  The same is true for ‘PyOS_AfterFork_Parent()’.

     New in version 3.7.

 -- C Function: void PyOS_AfterFork_Child ()

     Function to update internal interpreter state after a process fork.
     This must be called from the child process after calling ‘fork()’,
     or any similar function that clones the current process, if there
     is any chance the process will call back into the Python
     interpreter.  Only available on systems where ‘fork()’ is defined.

          Warning: The C ‘fork()’ call should only be made from the
          *note “main” thread: 3b84. (of the *note “main” interpreter:
          3b85.).  The same is true for ‘PyOS_AfterFork_Child()’.

     New in version 3.7.

     See also
     ........

     *note os.register_at_fork(): 3ab. allows registering custom Python
     functions to be called by *note PyOS_BeforeFork(): 427, *note
     PyOS_AfterFork_Parent(): 428. and *note PyOS_AfterFork_Child():
     2cb.

 -- C Function: void PyOS_AfterFork ()

     Function to update some internal state after a process fork; this
     should be called in the new process if the Python interpreter will
     continue to be used.  If a new executable is loaded into the new
     process, this function does not need to be called.

     Deprecated since version 3.7: This function is superseded by *note
     PyOS_AfterFork_Child(): 2cb.

 -- C Function: int PyOS_CheckStack ()

     Return true when the interpreter runs out of stack space.  This is
     a reliable check, but is only available when ‘USE_STACKCHECK’ is
     defined (currently on Windows using the Microsoft Visual C++
     compiler).  ‘USE_STACKCHECK’ will be defined automatically; you
     should never change the definition in your own code.

 -- C Function: PyOS_sighandler_t PyOS_getsig (int i)

     Return the current signal handler for signal `i'.  This is a thin
     wrapper around either ‘sigaction()’ or ‘signal()’.  Do not call
     those functions directly!  ‘PyOS_sighandler_t’ is a typedef alias
     for ‘void (*)(int)’.

 -- C Function: PyOS_sighandler_t PyOS_setsig (int i,
          PyOS_sighandler_t h)

     Set the signal handler for signal `i' to be `h'; return the old
     signal handler.  This is a thin wrapper around either ‘sigaction()’
     or ‘signal()’.  Do not call those functions directly!
     ‘PyOS_sighandler_t’ is a typedef alias for ‘void (*)(int)’.

 -- C Function: wchar_t* Py_DecodeLocale (const char* arg, size_t *size)

     Decode a byte string from the locale encoding with the *note
     surrogateescape error handler: 1780.: undecodable bytes are decoded
     as characters in range U+DC80..U+DCFF. If a byte sequence can be
     decoded as a surrogate character, escape the bytes using the
     surrogateescape error handler instead of decoding them.

     Encoding, highest priority to lowest priority:

        * ‘UTF-8’ on macOS, Android, and VxWorks;

        * ‘UTF-8’ on Windows if *note Py_LegacyWindowsFSEncodingFlag:
          3b88. is zero;

        * ‘UTF-8’ if the Python UTF-8 mode is enabled;

        * ‘ASCII’ if the ‘LC_CTYPE’ locale is ‘"C"’,
          ‘nl_langinfo(CODESET)’ returns the ‘ASCII’ encoding (or an
          alias), and ‘mbstowcs()’ and ‘wcstombs()’ functions uses the
          ‘ISO-8859-1’ encoding.

        * the current locale encoding.

     Return a pointer to a newly allocated wide character string, use
     *note PyMem_RawFree(): 3b89. to free the memory.  If size is not
     ‘NULL’, write the number of wide characters excluding the null
     character into ‘*size’

     Return ‘NULL’ on decoding error or memory allocation error.  If
     `size' is not ‘NULL’, ‘*size’ is set to ‘(size_t)-1’ on memory
     error or set to ‘(size_t)-2’ on decoding error.

     Decoding errors should never happen, unless there is a bug in the C
     library.

     Use the *note Py_EncodeLocale(): 432. function to encode the
     character string back to a byte string.

     See also
     ........

     The *note PyUnicode_DecodeFSDefaultAndSize(): 3b8a. and *note
     PyUnicode_DecodeLocaleAndSize(): 433. functions.

     New in version 3.5.

     Changed in version 3.7: The function now uses the UTF-8 encoding in
     the UTF-8 mode.

     Changed in version 3.8: The function now uses the UTF-8 encoding on
     Windows if *note Py_LegacyWindowsFSEncodingFlag: 3b88. is zero;

 -- C Function: char* Py_EncodeLocale (const wchar_t *text,
          size_t *error_pos)

     Encode a wide character string to the locale encoding with the
     *note surrogateescape error handler: 1780.: surrogate characters in
     the range U+DC80..U+DCFF are converted to bytes 0x80..0xFF.

     Encoding, highest priority to lowest priority:

        * ‘UTF-8’ on macOS, Android, and VxWorks;

        * ‘UTF-8’ on Windows if *note Py_LegacyWindowsFSEncodingFlag:
          3b88. is zero;

        * ‘UTF-8’ if the Python UTF-8 mode is enabled;

        * ‘ASCII’ if the ‘LC_CTYPE’ locale is ‘"C"’,
          ‘nl_langinfo(CODESET)’ returns the ‘ASCII’ encoding (or an
          alias), and ‘mbstowcs()’ and ‘wcstombs()’ functions uses the
          ‘ISO-8859-1’ encoding.

        * the current locale encoding.

     The function uses the UTF-8 encoding in the Python UTF-8 mode.

     Return a pointer to a newly allocated byte string, use *note
     PyMem_Free(): d9c. to free the memory.  Return ‘NULL’ on encoding
     error or memory allocation error

     If error_pos is not ‘NULL’, ‘*error_pos’ is set to ‘(size_t)-1’ on
     success, or set to the index of the invalid character on encoding
     error.

     Use the *note Py_DecodeLocale(): 431. function to decode the bytes
     string back to a wide character string.

     See also
     ........

     The *note PyUnicode_EncodeFSDefault(): f83. and *note
     PyUnicode_EncodeLocale(): 434. functions.

     New in version 3.5.

     Changed in version 3.7: The function now uses the UTF-8 encoding in
     the UTF-8 mode.

     Changed in version 3.8: The function now uses the UTF-8 encoding on
     Windows if *note Py_LegacyWindowsFSEncodingFlag: 3b88. is zero;


File: python.info,  Node: System Functions,  Next: Process Control,  Prev: Operating System Utilities,  Up: Utilities<2>

7.6.2 System Functions
----------------------

These are utility functions that make functionality from the *note sys:
fd. module accessible to C code.  They all work with the current
interpreter thread’s *note sys: fd. module’s dict, which is contained in
the internal thread state structure.

 -- C Function: PyObject *PySys_GetObject (const char *name)
     `Return value: Borrowed reference.'  Return the object `name' from
     the *note sys: fd. module or ‘NULL’ if it does not exist, without
     setting an exception.

 -- C Function: int PySys_SetObject (const char *name, PyObject *v)

     Set `name' in the *note sys: fd. module to `v' unless `v' is
     ‘NULL’, in which case `name' is deleted from the sys module.
     Returns ‘0’ on success, ‘-1’ on error.

 -- C Function: void PySys_ResetWarnOptions ()

     Reset *note sys.warnoptions: 40b. to an empty list.  This function
     may be called prior to *note Py_Initialize(): 42e.

 -- C Function: void PySys_AddWarnOption (const wchar_t *s)

     Append `s' to *note sys.warnoptions: 40b.  This function must be
     called prior to *note Py_Initialize(): 42e. in order to affect the
     warnings filter list.

 -- C Function: void PySys_AddWarnOptionUnicode (PyObject *unicode)

     Append `unicode' to *note sys.warnoptions: 40b.

     Note: this function is not currently usable from outside the
     CPython implementation, as it must be called prior to the implicit
     import of *note warnings: 126. in *note Py_Initialize(): 42e. to be
     effective, but can’t be called until enough of the runtime has been
     initialized to permit the creation of Unicode objects.

 -- C Function: void PySys_SetPath (const wchar_t *path)

     Set *note sys.path: 47d. to a list object of paths found in `path'
     which should be a list of paths separated with the platform’s
     search path delimiter (‘:’ on Unix, ‘;’ on Windows).

 -- C Function: void PySys_WriteStdout (const char *format, ...)

     Write the output string described by `format' to *note sys.stdout:
     303.  No exceptions are raised, even if truncation occurs (see
     below).

     `format' should limit the total size of the formatted output string
     to 1000 bytes or less – after 1000 bytes, the output string is
     truncated.  In particular, this means that no unrestricted “%s”
     formats should occur; these should be limited using “%.<N>s” where
     <N> is a decimal number calculated so that <N> plus the maximum
     size of other formatted text does not exceed 1000 bytes.  Also
     watch out for “%f”, which can print hundreds of digits for very
     large numbers.

     If a problem occurs, or *note sys.stdout: 303. is unset, the
     formatted message is written to the real (C level) `stdout'.

 -- C Function: void PySys_WriteStderr (const char *format, ...)

     As *note PySys_WriteStdout(): 3b91, but write to *note sys.stderr:
     304. or `stderr' instead.

 -- C Function: void PySys_FormatStdout (const char *format, ...)

     Function similar to PySys_WriteStdout() but format the message
     using *note PyUnicode_FromFormatV(): 3b94. and don’t truncate the
     message to an arbitrary length.

     New in version 3.2.

 -- C Function: void PySys_FormatStderr (const char *format, ...)

     As *note PySys_FormatStdout(): 3b93, but write to *note sys.stderr:
     304. or `stderr' instead.

     New in version 3.2.

 -- C Function: void PySys_AddXOption (const wchar_t *s)

     Parse `s' as a set of *note -X: 155. options and add them to the
     current options mapping as returned by *note PySys_GetXOptions():
     3b97.  This function may be called prior to *note Py_Initialize():
     42e.

     New in version 3.2.

 -- C Function: PyObject *PySys_GetXOptions ()
     `Return value: Borrowed reference.'  Return the current dictionary
     of *note -X: 155. options, similarly to *note sys._xoptions: 128c.
     On error, ‘NULL’ is returned and an exception is set.

     New in version 3.2.

 -- C Function: int PySys_Audit (const char *event, const char *format,
          ...)

     Raise an auditing event with any active hooks.  Return zero for
     success and non-zero with an exception set on failure.

     If any hooks have been added, `format' and other arguments will be
     used to construct a tuple to pass.  Apart from ‘N’, the same format
     characters as used in *note Py_BuildValue(): 2cc. are available.
     If the built value is not a tuple, it will be added into a
     single-element tuple.  (The ‘N’ format option consumes a reference,
     but since there is no way to know whether arguments to this
     function will be consumed, using it may cause reference leaks.)

     Note that ‘#’ format characters should always be treated as
     ‘Py_ssize_t’, regardless of whether ‘PY_SSIZE_T_CLEAN’ was defined.

     *note sys.audit(): 3404. performs the same function from Python
     code.

     New in version 3.8.

     Changed in version 3.8.2: Require ‘Py_ssize_t’ for ‘#’ format
     characters.  Previously, an unavoidable deprecation warning was
     raised.

 -- C Function: int PySys_AddAuditHook (Py_AuditHookFunction hook,
          void *userData)

     Append the callable `hook' to the list of active auditing hooks.
     Return zero for success and non-zero on failure.  If the runtime
     has been initialized, also set an error on failure.  Hooks added
     through this API are called for all interpreters created by the
     runtime.

     The `userData' pointer is passed into the hook function.  Since
     hook functions may be called from different runtimes, this pointer
     should not refer directly to Python state.

     This function is safe to call before *note Py_Initialize(): 42e.
     When called after runtime initialization, existing audit hooks are
     notified and may silently abort the operation by raising an error
     subclassed from *note Exception: 1a8. (other errors will not be
     silenced).

     The hook function is of type ‘int (*)(const char *event, PyObject
     *args, void *userData)’, where `args' is guaranteed to be a *note
     PyTupleObject: 3b98.  The hook function is always called with the
     GIL held by the Python interpreter that raised the event.

     See PEP 578(1) for a detailed description of auditing.  Functions
     in the runtime and standard library that raise events are listed in
     the *note audit events table: 3401.  Details are in each function’s
     documentation.

     If the interpreter is initialized, this function raises a auditing
     event ‘sys.addaudithook’ with no arguments.  If any existing hooks
     raise an exception derived from *note Exception: 1a8, the new hook
     will not be added and the exception is cleared.  As a result,
     callers cannot assume that their hook has been added unless they
     control all existing hooks.

     New in version 3.8.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0578


File: python.info,  Node: Process Control,  Next: Importing Modules<2>,  Prev: System Functions,  Up: Utilities<2>

7.6.3 Process Control
---------------------

 -- C Function: void Py_FatalError (const char *message)

     Print a fatal error message and kill the process.  No cleanup is
     performed.  This function should only be invoked when a condition
     is detected that would make it dangerous to continue using the
     Python interpreter; e.g., when the object administration appears to
     be corrupted.  On Unix, the standard C library function ‘abort()’
     is called which will attempt to produce a ‘core’ file.

 -- C Function: void Py_Exit (int status)

     Exit the current process.  This calls *note Py_FinalizeEx(): 5be.
     and then calls the standard C library function ‘exit(status)’.  If
     *note Py_FinalizeEx(): 5be. indicates an error, the exit status is
     set to 120.

     Changed in version 3.6: Errors from finalization no longer ignored.

 -- C Function: int Py_AtExit (void (*func)())

     Register a cleanup function to be called by *note Py_FinalizeEx():
     5be.  The cleanup function will be called with no arguments and
     should return no value.  At most 32 cleanup functions can be
     registered.  When the registration is successful, *note
     Py_AtExit(): 3b9b. returns ‘0’; on failure, it returns ‘-1’.  The
     cleanup function registered last is called first.  Each cleanup
     function will be called at most once.  Since Python’s internal
     finalization will have completed before the cleanup function, no
     Python APIs should be called by `func'.


File: python.info,  Node: Importing Modules<2>,  Next: Data marshalling support,  Prev: Process Control,  Up: Utilities<2>

7.6.4 Importing Modules
-----------------------

 -- C Function: PyObject* PyImport_ImportModule (const char *name)
     `Return value: New reference.'

     This is a simplified interface to *note PyImport_ImportModuleEx():
     b14. below, leaving the `globals' and `locals' arguments set to
     ‘NULL’ and `level' set to 0.  When the `name' argument contains a
     dot (when it specifies a submodule of a package), the `fromlist'
     argument is set to the list ‘['*']’ so that the return value is the
     named module rather than the top-level package containing it as
     would otherwise be the case.  (Unfortunately, this has an
     additional side effect when `name' in fact specifies a subpackage
     instead of a submodule: the submodules specified in the package’s
     ‘__all__’ variable are loaded.)  Return a new reference to the
     imported module, or ‘NULL’ with an exception set on failure.  A
     failing import of a module doesn’t leave the module in *note
     sys.modules: 13eb.

     This function always uses absolute imports.

 -- C Function: PyObject* PyImport_ImportModuleNoBlock (const
          char *name)
     `Return value: New reference.'  This function is a deprecated alias
     of *note PyImport_ImportModule(): c66.

     Changed in version 3.3: This function used to fail immediately when
     the import lock was held by another thread.  In Python 3.3 though,
     the locking scheme switched to per-module locks for most purposes,
     so this function’s special behaviour isn’t needed anymore.

 -- C Function: PyObject* PyImport_ImportModuleEx (const char *name,
          PyObject *globals, PyObject *locals, PyObject *fromlist)
     `Return value: New reference.'

     Import a module.  This is best described by referring to the
     built-in Python function *note __import__(): 605.

     The return value is a new reference to the imported module or
     top-level package, or ‘NULL’ with an exception set on failure.
     Like for *note __import__(): 605, the return value when a submodule
     of a package was requested is normally the top-level package,
     unless a non-empty `fromlist' was given.

     Failing imports remove incomplete module objects, like with *note
     PyImport_ImportModule(): c66.

 -- C Function: PyObject* PyImport_ImportModuleLevelObject
          (PyObject *name, PyObject *globals, PyObject *locals,
          PyObject *fromlist, int level)
     `Return value: New reference.'  Import a module.  This is best
     described by referring to the built-in Python function *note
     __import__(): 605, as the standard *note __import__(): 605.
     function calls this function directly.

     The return value is a new reference to the imported module or
     top-level package, or ‘NULL’ with an exception set on failure.
     Like for *note __import__(): 605, the return value when a submodule
     of a package was requested is normally the top-level package,
     unless a non-empty `fromlist' was given.

     New in version 3.3.

 -- C Function: PyObject* PyImport_ImportModuleLevel (const char *name,
          PyObject *globals, PyObject *locals, PyObject *fromlist,
          int level)
     `Return value: New reference.'  Similar to *note
     PyImport_ImportModuleLevelObject(): 3b9f, but the name is a UTF-8
     encoded string instead of a Unicode object.

     Changed in version 3.3: Negative values for `level' are no longer
     accepted.

 -- C Function: PyObject* PyImport_Import (PyObject *name)
     `Return value: New reference.'  This is a higher-level interface
     that calls the current “import hook function” (with an explicit
     `level' of 0, meaning absolute import).  It invokes the *note
     __import__(): 605. function from the ‘__builtins__’ of the current
     globals.  This means that the import is done using whatever import
     hooks are installed in the current environment.

     This function always uses absolute imports.

 -- C Function: PyObject* PyImport_ReloadModule (PyObject *m)
     `Return value: New reference.'  Reload a module.  Return a new
     reference to the reloaded module, or ‘NULL’ with an exception set
     on failure (the module still exists in this case).

 -- C Function: PyObject* PyImport_AddModuleObject (PyObject *name)
     `Return value: Borrowed reference.'  Return the module object
     corresponding to a module name.  The `name' argument may be of the
     form ‘package.module’.  First check the modules dictionary if
     there’s one there, and if not, create a new one and insert it in
     the modules dictionary.  Return ‘NULL’ with an exception set on
     failure.

          Note: This function does not load or import the module; if the
          module wasn’t already loaded, you will get an empty module
          object.  Use *note PyImport_ImportModule(): c66. or one of its
          variants to import a module.  Package structures implied by a
          dotted name for `name' are not created if not already present.

     New in version 3.3.

 -- C Function: PyObject* PyImport_AddModule (const char *name)
     `Return value: Borrowed reference.'  Similar to *note
     PyImport_AddModuleObject(): 3ba1, but the name is a UTF-8 encoded
     string instead of a Unicode object.

 -- C Function: PyObject* PyImport_ExecCodeModule (const char *name,
          PyObject *co)
     `Return value: New reference.'

     Given a module name (possibly of the form ‘package.module’) and a
     code object read from a Python bytecode file or obtained from the
     built-in function *note compile(): 1b2, load the module.  Return a
     new reference to the module object, or ‘NULL’ with an exception set
     if an error occurred.  `name' is removed from *note sys.modules:
     13eb. in error cases, even if `name' was already in *note
     sys.modules: 13eb. on entry to *note PyImport_ExecCodeModule():
     3ba2.  Leaving incompletely initialized modules in *note
     sys.modules: 13eb. is dangerous, as imports of such modules have no
     way to know that the module object is an unknown (and probably
     damaged with respect to the module author’s intents) state.

     The module’s *note __spec__: 1405. and *note __loader__: 94a. will
     be set, if not set already, with the appropriate values.  The
     spec’s loader will be set to the module’s ‘__loader__’ (if set) and
     to an instance of ‘SourceFileLoader’ otherwise.

     The module’s *note __file__: 136b. attribute will be set to the
     code object’s ‘co_filename’.  If applicable, *note __cached__: b25.
     will also be set.

     This function will reload the module if it was already imported.
     See *note PyImport_ReloadModule(): 3ba0. for the intended way to
     reload a module.

     If `name' points to a dotted name of the form ‘package.module’, any
     package structures not already created will still not be created.

     See also *note PyImport_ExecCodeModuleEx(): 3ba3. and *note
     PyImport_ExecCodeModuleWithPathnames(): 3ba4.

 -- C Function: PyObject* PyImport_ExecCodeModuleEx (const char *name,
          PyObject *co, const char *pathname)
     `Return value: New reference.'  Like *note
     PyImport_ExecCodeModule(): 3ba2, but the *note __file__: 136b.
     attribute of the module object is set to `pathname' if it is
     non-‘NULL’.

     See also *note PyImport_ExecCodeModuleWithPathnames(): 3ba4.

 -- C Function: PyObject* PyImport_ExecCodeModuleObject (PyObject *name,
          PyObject *co, PyObject *pathname, PyObject *cpathname)
     `Return value: New reference.'  Like *note
     PyImport_ExecCodeModuleEx(): 3ba3, but the *note __cached__: b25.
     attribute of the module object is set to `cpathname' if it is
     non-‘NULL’.  Of the three functions, this is the preferred one to
     use.

     New in version 3.3.

 -- C Function: PyObject* PyImport_ExecCodeModuleWithPathnames (const
          char *name, PyObject *co, const char *pathname, const
          char *cpathname)
     `Return value: New reference.'  Like *note
     PyImport_ExecCodeModuleObject(): 3ba5, but `name', `pathname' and
     `cpathname' are UTF-8 encoded strings.  Attempts are also made to
     figure out what the value for `pathname' should be from `cpathname'
     if the former is set to ‘NULL’.

     New in version 3.2.

     Changed in version 3.3: Uses *note imp.source_from_cache(): 3a29.
     in calculating the source path if only the bytecode path is
     provided.

 -- C Function: long PyImport_GetMagicNumber ()

     Return the magic number for Python bytecode files (a.k.a.  ‘.pyc’
     file).  The magic number should be present in the first four bytes
     of the bytecode file, in little-endian byte order.  Returns ‘-1’ on
     error.

     Changed in version 3.3: Return value of ‘-1’ upon failure.

 -- C Function: const char * PyImport_GetMagicTag ()

     Return the magic tag string for PEP 3147(1) format Python bytecode
     file names.  Keep in mind that the value at
     ‘sys.implementation.cache_tag’ is authoritative and should be used
     instead of this function.

     New in version 3.2.

 -- C Function: PyObject* PyImport_GetModuleDict ()
     `Return value: Borrowed reference.'  Return the dictionary used for
     the module administration (a.k.a.  ‘sys.modules’).  Note that this
     is a per-interpreter variable.

 -- C Function: PyObject* PyImport_GetModule (PyObject *name)
     `Return value: New reference.'  Return the already imported module
     with the given name.  If the module has not been imported yet then
     returns ‘NULL’ but does not set an error.  Returns ‘NULL’ and sets
     an error if the lookup failed.

     New in version 3.7.

 -- C Function: PyObject* PyImport_GetImporter (PyObject *path)
     `Return value: New reference.'  Return a finder object for a *note
     sys.path: 47d./‘pkg.__path__’ item `path', possibly by fetching it
     from the *note sys.path_importer_cache: 493. dict.  If it wasn’t
     yet cached, traverse *note sys.path_hooks: 950. until a hook is
     found that can handle the path item.  Return ‘None’ if no hook
     could; this tells our caller that the *note path based finder:
     13fd. could not find a finder for this path item.  Cache the result
     in *note sys.path_importer_cache: 493.  Return a new reference to
     the finder object.

 -- C Function: void _PyImport_Init ()

     Initialize the import mechanism.  For internal use only.

 -- C Function: void PyImport_Cleanup ()

     Empty the module table.  For internal use only.

 -- C Function: void _PyImport_Fini ()

     Finalize the import mechanism.  For internal use only.

 -- C Function: int PyImport_ImportFrozenModuleObject (PyObject *name)
     `Return value: New reference.'  Load a frozen module named `name'.
     Return ‘1’ for success, ‘0’ if the module is not found, and ‘-1’
     with an exception set if the initialization failed.  To access the
     imported module on a successful load, use *note
     PyImport_ImportModule(): c66.  (Note the misnomer — this function
     would reload the module if it was already imported.)

     New in version 3.3.

     Changed in version 3.4: The ‘__file__’ attribute is no longer set
     on the module.

 -- C Function: int PyImport_ImportFrozenModule (const char *name)

     Similar to *note PyImport_ImportFrozenModuleObject(): 3bac, but the
     name is a UTF-8 encoded string instead of a Unicode object.

 -- C Type: struct _frozen

     This is the structure type definition for frozen module
     descriptors, as generated by the ‘freeze’ utility (see
     ‘Tools/freeze/’ in the Python source distribution).  Its
     definition, found in ‘Include/import.h’, is:

          struct _frozen {     const char *name;     const unsigned char *code;     int size; };

 -- C Variable: const struct _frozen* PyImport_FrozenModules

     This pointer is initialized to point to an array of ‘struct
     _frozen’ records, terminated by one whose members are all ‘NULL’ or
     zero.  When a frozen module is imported, it is searched in this
     table.  Third-party code could play tricks with this to provide a
     dynamically created collection of frozen modules.

 -- C Function: int PyImport_AppendInittab (const char *name, PyObject*
          (*initfunc)(void))

     Add a single module to the existing table of built-in modules.
     This is a convenience wrapper around *note
     PyImport_ExtendInittab(): 3baf, returning ‘-1’ if the table could
     not be extended.  The new module can be imported by the name
     `name', and uses the function `initfunc' as the initialization
     function called on the first attempted import.  This should be
     called before *note Py_Initialize(): 42e.

 -- C Type: struct _inittab

     Structure describing a single entry in the list of built-in
     modules.  Each of these structures gives the name and
     initialization function for a module built into the interpreter.
     The name is an ASCII encoded string.  Programs which embed Python
     may use an array of these structures in conjunction with *note
     PyImport_ExtendInittab(): 3baf. to provide additional built-in
     modules.  The structure is defined in ‘Include/import.h’ as:

          struct _inittab {     const char *name;           /* ASCII encoded string */     PyObject* (*initfunc)(void); };

 -- C Function: int PyImport_ExtendInittab (struct _inittab *newtab)

     Add a collection of modules to the table of built-in modules.  The
     `newtab' array must end with a sentinel entry which contains ‘NULL’
     for the ‘name’ field; failure to provide the sentinel value can
     result in a memory fault.  Returns ‘0’ on success or ‘-1’ if
     insufficient memory could be allocated to extend the internal
     table.  In the event of failure, no modules are added to the
     internal table.  This should be called before *note
     Py_Initialize(): 42e.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: Data marshalling support,  Next: Parsing arguments and building values,  Prev: Importing Modules<2>,  Up: Utilities<2>

7.6.5 Data marshalling support
------------------------------

These routines allow C code to work with serialized objects using the
same data format as the *note marshal: b0. module.  There are functions
to write data into the serialization format, and additional functions
that can be used to read the data back.  Files used to store marshalled
data must be opened in binary mode.

Numeric values are stored with the least significant byte first.

The module supports two versions of the data format: version 0 is the
historical version, version 1 shares interned strings in the file, and
upon unmarshalling.  Version 2 uses a binary format for floating point
numbers.  ‘Py_MARSHAL_VERSION’ indicates the current file format
(currently 2).

 -- C Function: void PyMarshal_WriteLongToFile (long value, FILE *file,
          int version)

     Marshal a ‘long’ integer, `value', to `file'.  This will only write
     the least-significant 32 bits of `value'; regardless of the size of
     the native ‘long’ type.  `version' indicates the file format.

 -- C Function: void PyMarshal_WriteObjectToFile (PyObject *value,
          FILE *file, int version)

     Marshal a Python object, `value', to `file'.  `version' indicates
     the file format.

 -- C Function: PyObject* PyMarshal_WriteObjectToString
          (PyObject *value, int version)
     `Return value: New reference.'  Return a bytes object containing
     the marshalled representation of `value'.  `version' indicates the
     file format.

The following functions allow marshalled values to be read back in.

 -- C Function: long PyMarshal_ReadLongFromFile (FILE *file)

     Return a C ‘long’ from the data stream in a ‘FILE*’ opened for
     reading.  Only a 32-bit value can be read in using this function,
     regardless of the native size of ‘long’.

     On error, sets the appropriate exception (*note EOFError: c5f.) and
     returns ‘-1’.

 -- C Function: int PyMarshal_ReadShortFromFile (FILE *file)

     Return a C ‘short’ from the data stream in a ‘FILE*’ opened for
     reading.  Only a 16-bit value can be read in using this function,
     regardless of the native size of ‘short’.

     On error, sets the appropriate exception (*note EOFError: c5f.) and
     returns ‘-1’.

 -- C Function: PyObject* PyMarshal_ReadObjectFromFile (FILE *file)
     `Return value: New reference.'  Return a Python object from the
     data stream in a ‘FILE*’ opened for reading.

     On error, sets the appropriate exception (*note EOFError: c5f,
     *note ValueError: 1f9. or *note TypeError: 192.) and returns
     ‘NULL’.

 -- C Function: PyObject* PyMarshal_ReadLastObjectFromFile (FILE *file)
     `Return value: New reference.'  Return a Python object from the
     data stream in a ‘FILE*’ opened for reading.  Unlike *note
     PyMarshal_ReadObjectFromFile(): 3bb9, this function assumes that no
     further objects will be read from the file, allowing it to
     aggressively load file data into memory so that the
     de-serialization can operate from data in memory rather than
     reading a byte at a time from the file.  Only use these variant if
     you are certain that you won’t be reading anything else from the
     file.

     On error, sets the appropriate exception (*note EOFError: c5f,
     *note ValueError: 1f9. or *note TypeError: 192.) and returns
     ‘NULL’.

 -- C Function: PyObject* PyMarshal_ReadObjectFromString (const
          char *data, Py_ssize_t len)
     `Return value: New reference.'  Return a Python object from the
     data stream in a byte buffer containing `len' bytes pointed to by
     `data'.

     On error, sets the appropriate exception (*note EOFError: c5f,
     *note ValueError: 1f9. or *note TypeError: 192.) and returns
     ‘NULL’.


File: python.info,  Node: Parsing arguments and building values,  Next: String conversion and formatting,  Prev: Data marshalling support,  Up: Utilities<2>

7.6.6 Parsing arguments and building values
-------------------------------------------

These functions are useful when creating your own extensions functions
and methods.  Additional information and examples are available in *note
Extending and Embedding the Python Interpreter: 1137.

The first three of these functions described, *note PyArg_ParseTuple():
268, *note PyArg_ParseTupleAndKeywords(): 5bf, and *note PyArg_Parse():
e96, all use `format strings' which are used to tell the function about
the expected arguments.  The format strings use the same syntax for each
of these functions.

* Menu:

* Parsing arguments: Parsing arguments<3>.
* Building values::


File: python.info,  Node: Parsing arguments<3>,  Next: Building values,  Up: Parsing arguments and building values

7.6.6.1 Parsing arguments
.........................

A format string consists of zero or more “format units.” A format unit
describes one Python object; it is usually a single character or a
parenthesized sequence of format units.  With a few exceptions, a format
unit that is not a parenthesized sequence normally corresponds to a
single address argument to these functions.  In the following
description, the quoted form is the format unit; the entry in (round)
parentheses is the Python object type that matches the format unit; and
the entry in [square] brackets is the type of the C variable(s) whose
address should be passed.

* Menu:

* Strings and buffers::
* Numbers: Numbers<2>.
* Other objects::
* API Functions::


File: python.info,  Node: Strings and buffers,  Next: Numbers<2>,  Up: Parsing arguments<3>

7.6.6.2 Strings and buffers
...........................

These formats allow accessing an object as a contiguous chunk of memory.
You don’t have to provide raw storage for the returned unicode or bytes
area.

In general, when a format sets a pointer to a buffer, the buffer is
managed by the corresponding Python object, and the buffer shares the
lifetime of this object.  You won’t have to release any memory yourself.
The only exceptions are ‘es’, ‘es#’, ‘et’ and ‘et#’.

However, when a *note Py_buffer: b0e. structure gets filled, the
underlying buffer is locked so that the caller can subsequently use the
buffer even inside a *note Py_BEGIN_ALLOW_THREADS: 3a6a. block without
the risk of mutable data being resized or destroyed.  As a result, `you
have to call' *note PyBuffer_Release(): d47. after you have finished
processing the data (or in any early abort case).

Unless otherwise stated, buffers are not NUL-terminated.

Some formats require a read-only *note bytes-like object: 5dd, and set a
pointer instead of a buffer structure.  They work by checking that the
object’s *note PyBufferProcs.bf_releasebuffer: 3bc0. field is ‘NULL’,
which disallows mutable objects such as *note bytearray: 327.

     Note: For all ‘#’ variants of formats (‘s#’, ‘y#’, etc.), the type
     of the length argument (int or ‘Py_ssize_t’) is controlled by
     defining the macro ‘PY_SSIZE_T_CLEAN’ before including ‘Python.h’.
     If the macro was defined, length is a ‘Py_ssize_t’ rather than an
     ‘int’.  This behavior will change in a future Python version to
     only support ‘Py_ssize_t’ and drop ‘int’ support.  It is best to
     always define ‘PY_SSIZE_T_CLEAN’.

‘s’ (*note str: 325.) [const char *]

     Convert a Unicode object to a C pointer to a character string.  A
     pointer to an existing string is stored in the character pointer
     variable whose address you pass.  The C string is NUL-terminated.
     The Python string must not contain embedded null code points; if it
     does, a *note ValueError: 1f9. exception is raised.  Unicode
     objects are converted to C strings using ‘'utf-8'’ encoding.  If
     this conversion fails, a *note UnicodeError: c2e. is raised.

          Note: This format does not accept *note bytes-like objects:
          5dd.  If you want to accept filesystem paths and convert them
          to C character strings, it is preferable to use the ‘O&’
          format with *note PyUnicode_FSConverter(): 5c3. as
          `converter'.

     Changed in version 3.5: Previously, *note TypeError: 192. was
     raised when embedded null code points were encountered in the
     Python string.

‘s*’ (*note str: 325. or *note bytes-like object: 5dd.) [Py_buffer]

     This format accepts Unicode objects as well as bytes-like objects.
     It fills a *note Py_buffer: b0e. structure provided by the caller.
     In this case the resulting C string may contain embedded NUL bytes.
     Unicode objects are converted to C strings using ‘'utf-8'’
     encoding.

‘s#’ (*note str: 325, read-only *note bytes-like object: 5dd.) [const char *, int or ‘Py_ssize_t’]

     Like ‘s*’, except that it doesn’t accept mutable objects.  The
     result is stored into two C variables, the first one a pointer to a
     C string, the second one its length.  The string may contain
     embedded null bytes.  Unicode objects are converted to C strings
     using ‘'utf-8'’ encoding.

‘z’ (*note str: 325. or ‘None’) [const char *]

     Like ‘s’, but the Python object may also be ‘None’, in which case
     the C pointer is set to ‘NULL’.

‘z*’ (*note str: 325, *note bytes-like object: 5dd. or ‘None’) [Py_buffer]

     Like ‘s*’, but the Python object may also be ‘None’, in which case
     the ‘buf’ member of the *note Py_buffer: b0e. structure is set to
     ‘NULL’.

‘z#’ (*note str: 325, read-only *note bytes-like object: 5dd. or ‘None’) [const char *, int]

     Like ‘s#’, but the Python object may also be ‘None’, in which case
     the C pointer is set to ‘NULL’.

‘y’ (read-only *note bytes-like object: 5dd.) [const char *]

     This format converts a bytes-like object to a C pointer to a
     character string; it does not accept Unicode objects.  The bytes
     buffer must not contain embedded null bytes; if it does, a *note
     ValueError: 1f9. exception is raised.

     Changed in version 3.5: Previously, *note TypeError: 192. was
     raised when embedded null bytes were encountered in the bytes
     buffer.

‘y*’ (*note bytes-like object: 5dd.) [Py_buffer]

     This variant on ‘s*’ doesn’t accept Unicode objects, only
     bytes-like objects.  `This is the recommended way to accept binary
     data.'

‘y#’ (read-only *note bytes-like object: 5dd.) [const char *, int]

     This variant on ‘s#’ doesn’t accept Unicode objects, only
     bytes-like objects.

‘S’ (*note bytes: 326.) [PyBytesObject *]

     Requires that the Python object is a *note bytes: 326. object,
     without attempting any conversion.  Raises *note TypeError: 192. if
     the object is not a bytes object.  The C variable may also be
     declared as *note PyObject*: 4b0.

‘Y’ (*note bytearray: 327.) [PyByteArrayObject *]

     Requires that the Python object is a *note bytearray: 327. object,
     without attempting any conversion.  Raises *note TypeError: 192. if
     the object is not a *note bytearray: 327. object.  The C variable
     may also be declared as *note PyObject*: 4b0.

‘u’ (*note str: 325.) [const Py_UNICODE *]

     Convert a Python Unicode object to a C pointer to a NUL-terminated
     buffer of Unicode characters.  You must pass the address of a *note
     Py_UNICODE: ae3. pointer variable, which will be filled with the
     pointer to an existing Unicode buffer.  Please note that the width
     of a *note Py_UNICODE: ae3. character depends on compilation
     options (it is either 16 or 32 bits).  The Python string must not
     contain embedded null code points; if it does, a *note ValueError:
     1f9. exception is raised.

     Changed in version 3.5: Previously, *note TypeError: 192. was
     raised when embedded null code points were encountered in the
     Python string.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsWideCharString(): 42d.

‘u#’ (*note str: 325.) [const Py_UNICODE *, int]

     This variant on ‘u’ stores into two C variables, the first one a
     pointer to a Unicode data buffer, the second one its length.  This
     variant allows null code points.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsWideCharString(): 42d.

‘Z’ (*note str: 325. or ‘None’) [const Py_UNICODE *]

     Like ‘u’, but the Python object may also be ‘None’, in which case
     the *note Py_UNICODE: ae3. pointer is set to ‘NULL’.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsWideCharString(): 42d.

‘Z#’ (*note str: 325. or ‘None’) [const Py_UNICODE *, int]

     Like ‘u#’, but the Python object may also be ‘None’, in which case
     the *note Py_UNICODE: ae3. pointer is set to ‘NULL’.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsWideCharString(): 42d.

‘U’ (*note str: 325.) [PyObject *]

     Requires that the Python object is a Unicode object, without
     attempting any conversion.  Raises *note TypeError: 192. if the
     object is not a Unicode object.  The C variable may also be
     declared as *note PyObject*: 4b0.

‘w*’ (read-write *note bytes-like object: 5dd.) [Py_buffer]

     This format accepts any object which implements the read-write
     buffer interface.  It fills a *note Py_buffer: b0e. structure
     provided by the caller.  The buffer may contain embedded null
     bytes.  The caller have to call *note PyBuffer_Release(): d47. when
     it is done with the buffer.

‘es’ (*note str: 325.) [const char *encoding, char **buffer]

     This variant on ‘s’ is used for encoding Unicode into a character
     buffer.  It only works for encoded data without embedded NUL bytes.

     This format requires two arguments.  The first is only used as
     input, and must be a ‘const char*’ which points to the name of an
     encoding as a NUL-terminated string, or ‘NULL’, in which case
     ‘'utf-8'’ encoding is used.  An exception is raised if the named
     encoding is not known to Python.  The second argument must be a
     ‘char**’; the value of the pointer it references will be set to a
     buffer with the contents of the argument text.  The text will be
     encoded in the encoding specified by the first argument.

     *note PyArg_ParseTuple(): 268. will allocate a buffer of the needed
     size, copy the encoded data into this buffer and adjust `*buffer'
     to reference the newly allocated storage.  The caller is
     responsible for calling *note PyMem_Free(): d9c. to free the
     allocated buffer after use.

‘et’ (*note str: 325, *note bytes: 326. or *note bytearray: 327.) [const char *encoding, char **buffer]

     Same as ‘es’ except that byte string objects are passed through
     without recoding them.  Instead, the implementation assumes that
     the byte string object uses the encoding passed in as parameter.

‘es#’ (*note str: 325.) [const char *encoding, char **buffer, int *buffer_length]

     This variant on ‘s#’ is used for encoding Unicode into a character
     buffer.  Unlike the ‘es’ format, this variant allows input data
     which contains NUL characters.

     It requires three arguments.  The first is only used as input, and
     must be a ‘const char*’ which points to the name of an encoding as
     a NUL-terminated string, or ‘NULL’, in which case ‘'utf-8'’
     encoding is used.  An exception is raised if the named encoding is
     not known to Python.  The second argument must be a ‘char**’; the
     value of the pointer it references will be set to a buffer with the
     contents of the argument text.  The text will be encoded in the
     encoding specified by the first argument.  The third argument must
     be a pointer to an integer; the referenced integer will be set to
     the number of bytes in the output buffer.

     There are two modes of operation:

     If `*buffer' points a ‘NULL’ pointer, the function will allocate a
     buffer of the needed size, copy the encoded data into this buffer
     and set `*buffer' to reference the newly allocated storage.  The
     caller is responsible for calling *note PyMem_Free(): d9c. to free
     the allocated buffer after usage.

     If `*buffer' points to a non-‘NULL’ pointer (an already allocated
     buffer), *note PyArg_ParseTuple(): 268. will use this location as
     the buffer and interpret the initial value of `*buffer_length' as
     the buffer size.  It will then copy the encoded data into the
     buffer and NUL-terminate it.  If the buffer is not large enough, a
     *note ValueError: 1f9. will be set.

     In both cases, `*buffer_length' is set to the length of the encoded
     data without the trailing NUL byte.

‘et#’ (*note str: 325, *note bytes: 326. or *note bytearray: 327.) [const char *encoding, char **buffer, int *buffer_length]

     Same as ‘es#’ except that byte string objects are passed through
     without recoding them.  Instead, the implementation assumes that
     the byte string object uses the encoding passed in as parameter.


File: python.info,  Node: Numbers<2>,  Next: Other objects,  Prev: Strings and buffers,  Up: Parsing arguments<3>

7.6.6.3 Numbers
...............

‘b’ (*note int: 184.) [unsigned char]

     Convert a nonnegative Python integer to an unsigned tiny int,
     stored in a C ‘unsigned char’.

‘B’ (*note int: 184.) [unsigned char]

     Convert a Python integer to a tiny int without overflow checking,
     stored in a C ‘unsigned char’.

‘h’ (*note int: 184.) [short int]

     Convert a Python integer to a C ‘short int’.

‘H’ (*note int: 184.) [unsigned short int]

     Convert a Python integer to a C ‘unsigned short int’, without
     overflow checking.

‘i’ (*note int: 184.) [int]

     Convert a Python integer to a plain C ‘int’.

‘I’ (*note int: 184.) [unsigned int]

     Convert a Python integer to a C ‘unsigned int’, without overflow
     checking.

‘l’ (*note int: 184.) [long int]

     Convert a Python integer to a C ‘long int’.

‘k’ (*note int: 184.) [unsigned long]

     Convert a Python integer to a C ‘unsigned long’ without overflow
     checking.

‘L’ (*note int: 184.) [long long]

     Convert a Python integer to a C ‘long long’.

‘K’ (*note int: 184.) [unsigned long long]

     Convert a Python integer to a C ‘unsigned long long’ without
     overflow checking.

‘n’ (*note int: 184.) [Py_ssize_t]

     Convert a Python integer to a C ‘Py_ssize_t’.

‘c’ (*note bytes: 326. or *note bytearray: 327. of length 1) [char]

     Convert a Python byte, represented as a *note bytes: 326. or *note
     bytearray: 327. object of length 1, to a C ‘char’.

     Changed in version 3.3: Allow *note bytearray: 327. objects.

‘C’ (*note str: 325. of length 1) [int]

     Convert a Python character, represented as a *note str: 325. object
     of length 1, to a C ‘int’.

‘f’ (*note float: 187.) [float]

     Convert a Python floating point number to a C ‘float’.

‘d’ (*note float: 187.) [double]

     Convert a Python floating point number to a C ‘double’.

‘D’ (*note complex: 189.) [Py_complex]

     Convert a Python complex number to a C *note Py_complex: 3bc2.
     structure.


File: python.info,  Node: Other objects,  Next: API Functions,  Prev: Numbers<2>,  Up: Parsing arguments<3>

7.6.6.4 Other objects
.....................

‘O’ (object) [PyObject *]

     Store a Python object (without any conversion) in a C object
     pointer.  The C program thus receives the actual object that was
     passed.  The object’s reference count is not increased.  The
     pointer stored is not ‘NULL’.

‘O!’ (object) [`typeobject', PyObject *]

     Store a Python object in a C object pointer.  This is similar to
     ‘O’, but takes two C arguments: the first is the address of a
     Python type object, the second is the address of the C variable (of
     type *note PyObject*: 4b0.) into which the object pointer is
     stored.  If the Python object does not have the required type,
     *note TypeError: 192. is raised.

‘O&’ (object) [`converter', `anything']

     Convert a Python object to a C variable through a `converter'
     function.  This takes two arguments: the first is a function, the
     second is the address of a C variable (of arbitrary type),
     converted to ‘void *’.  The `converter' function in turn is called
     as follows:

          status = converter(object, address);

     where `object' is the Python object to be converted and `address'
     is the ‘void*’ argument that was passed to the *note
     PyArg_Parse*(): e96. function.  The returned `status' should be ‘1’
     for a successful conversion and ‘0’ if the conversion has failed.
     When the conversion fails, the `converter' function should raise an
     exception and leave the content of `address' unmodified.

     If the `converter' returns ‘Py_CLEANUP_SUPPORTED’, it may get
     called a second time if the argument parsing eventually fails,
     giving the converter a chance to release any memory that it had
     already allocated.  In this second call, the `object' parameter
     will be ‘NULL’; `address' will have the same value as in the
     original call.

     Changed in version 3.1: ‘Py_CLEANUP_SUPPORTED’ was added.

‘p’ (*note bool: 183.) [int]

     Tests the value passed in for truth (a boolean `p'redicate) and
     converts the result to its equivalent C true/false integer value.
     Sets the int to ‘1’ if the expression was true and ‘0’ if it was
     false.  This accepts any valid Python value.  See *note Truth Value
     Testing: 151f. for more information about how Python tests values
     for truth.

     New in version 3.3.

‘(items)’ (*note tuple: 473.) [`matching-items']

     The object must be a Python sequence whose length is the number of
     format units in `items'.  The C arguments must correspond to the
     individual format units in `items'.  Format units for sequences may
     be nested.

It is possible to pass “long” integers (integers whose value exceeds the
platform’s ‘LONG_MAX’) however no proper range checking is done — the
most significant bits are silently truncated when the receiving field is
too small to receive the value (actually, the semantics are inherited
from downcasts in C — your mileage may vary).

A few other characters have a meaning in a format string.  These may not
occur inside nested parentheses.  They are:

‘|’

     Indicates that the remaining arguments in the Python argument list
     are optional.  The C variables corresponding to optional arguments
     should be initialized to their default value — when an optional
     argument is not specified, *note PyArg_ParseTuple(): 268. does not
     touch the contents of the corresponding C variable(s).

‘$’

     *note PyArg_ParseTupleAndKeywords(): 5bf. only: Indicates that the
     remaining arguments in the Python argument list are keyword-only.
     Currently, all keyword-only arguments must also be optional
     arguments, so ‘|’ must always be specified before ‘$’ in the format
     string.

     New in version 3.3.

‘:’

     The list of format units ends here; the string after the colon is
     used as the function name in error messages (the “associated value”
     of the exception that *note PyArg_ParseTuple(): 268. raises).

‘;’

     The list of format units ends here; the string after the semicolon
     is used as the error message `instead' of the default error
     message.  ‘:’ and ‘;’ mutually exclude each other.

Note that any Python object references which are provided to the caller
are `borrowed' references; do not decrement their reference count!

Additional arguments passed to these functions must be addresses of
variables whose type is determined by the format string; these are used
to store values from the input tuple.  There are a few cases, as
described in the list of format units above, where these parameters are
used as input values; they should match what is specified for the
corresponding format unit in that case.

For the conversion to succeed, the `arg' object must match the format
and the format must be exhausted.  On success, the *note PyArg_Parse*():
e96. functions return true, otherwise they return false and raise an
appropriate exception.  When the *note PyArg_Parse*(): e96. functions
fail due to conversion failure in one of the format units, the variables
at the addresses corresponding to that and the following format units
are left untouched.


File: python.info,  Node: API Functions,  Prev: Other objects,  Up: Parsing arguments<3>

7.6.6.5 API Functions
.....................

 -- C Function: int PyArg_ParseTuple (PyObject *args, const
          char *format, ...)

     Parse the parameters of a function that takes only positional
     parameters into local variables.  Returns true on success; on
     failure, it returns false and raises the appropriate exception.

 -- C Function: int PyArg_VaParse (PyObject *args, const char *format,
          va_list vargs)

     Identical to *note PyArg_ParseTuple(): 268, except that it accepts
     a va_list rather than a variable number of arguments.

 -- C Function: int PyArg_ParseTupleAndKeywords (PyObject *args,
          PyObject *kw, const char *format, char *keywords[], ...)

     Parse the parameters of a function that takes both positional and
     keyword parameters into local variables.  The `keywords' argument
     is a ‘NULL’-terminated array of keyword parameter names.  Empty
     names denote *note positional-only parameters: 2a5.  Returns true
     on success; on failure, it returns false and raises the appropriate
     exception.

     Changed in version 3.6: Added support for *note positional-only
     parameters: 2a5.

 -- C Function: int PyArg_VaParseTupleAndKeywords (PyObject *args,
          PyObject *kw, const char *format, char *keywords[],
          va_list vargs)

     Identical to *note PyArg_ParseTupleAndKeywords(): 5bf, except that
     it accepts a va_list rather than a variable number of arguments.

 -- C Function: int PyArg_ValidateKeywordArguments (PyObject *)

     Ensure that the keys in the keywords argument dictionary are
     strings.  This is only needed if *note
     PyArg_ParseTupleAndKeywords(): 5bf. is not used, since the latter
     already does this check.

     New in version 3.2.

 -- C Function: int PyArg_Parse (PyObject *args, const char *format,
          ...)

     Function used to deconstruct the argument lists of “old-style”
     functions — these are functions which use the ‘METH_OLDARGS’
     parameter parsing method, which has been removed in Python 3.  This
     is not recommended for use in parameter parsing in new code, and
     most code in the standard interpreter has been modified to no
     longer use this for that purpose.  It does remain a convenient way
     to decompose other tuples, however, and may continue to be used for
     that purpose.

 -- C Function: int PyArg_UnpackTuple (PyObject *args, const char *name,
          Py_ssize_t min, Py_ssize_t max, ...)

     A simpler form of parameter retrieval which does not use a format
     string to specify the types of the arguments.  Functions which use
     this method to retrieve their parameters should be declared as
     *note METH_VARARGS: e3b. in function or method tables.  The tuple
     containing the actual parameters should be passed as `args'; it
     must actually be a tuple.  The length of the tuple must be at least
     `min' and no more than `max'; `min' and `max' may be equal.
     Additional arguments must be passed to the function, each of which
     should be a pointer to a *note PyObject*: 4b0. variable; these will
     be filled in with the values from `args'; they will contain
     borrowed references.  The variables which correspond to optional
     parameters not given by `args' will not be filled in; these should
     be initialized by the caller.  This function returns true on
     success and false if `args' is not a tuple or contains the wrong
     number of elements; an exception will be set if there was a
     failure.

     This is an example of the use of this function, taken from the
     sources for the ‘_weakref’ helper module for weak references:

          static PyObject * weakref_ref(PyObject *self, PyObject *args) {     PyObject *object;     PyObject *callback = NULL;     PyObject *result = NULL;      if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) {         result = PyWeakref_NewRef(object, callback);     }     return result; }

     The call to *note PyArg_UnpackTuple(): e39. in this example is
     entirely equivalent to this call to *note PyArg_ParseTuple(): 268.:

          PyArg_ParseTuple(args, "O|O:ref", &object, &callback)


File: python.info,  Node: Building values,  Prev: Parsing arguments<3>,  Up: Parsing arguments and building values

7.6.6.6 Building values
.......................

 -- C Function: PyObject* Py_BuildValue (const char *format, ...)
     `Return value: New reference.'  Create a new value based on a
     format string similar to those accepted by the *note
     PyArg_Parse*(): e96. family of functions and a sequence of values.
     Returns the value or ‘NULL’ in the case of an error; an exception
     will be raised if ‘NULL’ is returned.

     *note Py_BuildValue(): 2cc. does not always build a tuple.  It
     builds a tuple only if its format string contains two or more
     format units.  If the format string is empty, it returns ‘None’; if
     it contains exactly one format unit, it returns whatever object is
     described by that format unit.  To force it to return a tuple of
     size 0 or one, parenthesize the format string.

     When memory buffers are passed as parameters to supply data to
     build objects, as for the ‘s’ and ‘s#’ formats, the required data
     is copied.  Buffers provided by the caller are never referenced by
     the objects created by *note Py_BuildValue(): 2cc.  In other words,
     if your code invokes ‘malloc()’ and passes the allocated memory to
     *note Py_BuildValue(): 2cc, your code is responsible for calling
     ‘free()’ for that memory once *note Py_BuildValue(): 2cc. returns.

     In the following description, the quoted form is the format unit;
     the entry in (round) parentheses is the Python object type that the
     format unit will return; and the entry in [square] brackets is the
     type of the C value(s) to be passed.

     The characters space, tab, colon and comma are ignored in format
     strings (but not within format units such as ‘s#’).  This can be
     used to make long format strings a tad more readable.

     ‘s’ (*note str: 325. or ‘None’) [const char *]

          Convert a null-terminated C string to a Python *note str: 325.
          object using ‘'utf-8'’ encoding.  If the C string pointer is
          ‘NULL’, ‘None’ is used.

     ‘s#’ (*note str: 325. or ‘None’) [const char *, int]

          Convert a C string and its length to a Python *note str: 325.
          object using ‘'utf-8'’ encoding.  If the C string pointer is
          ‘NULL’, the length is ignored and ‘None’ is returned.

     ‘y’ (*note bytes: 326.) [const char *]

          This converts a C string to a Python *note bytes: 326. object.
          If the C string pointer is ‘NULL’, ‘None’ is returned.

     ‘y#’ (*note bytes: 326.) [const char *, int]

          This converts a C string and its lengths to a Python object.
          If the C string pointer is ‘NULL’, ‘None’ is returned.

     ‘z’ (*note str: 325. or ‘None’) [const char *]

          Same as ‘s’.

     ‘z#’ (*note str: 325. or ‘None’) [const char *, int]

          Same as ‘s#’.

     ‘u’ (*note str: 325.) [const wchar_t *]

          Convert a null-terminated ‘wchar_t’ buffer of Unicode (UTF-16
          or UCS-4) data to a Python Unicode object.  If the Unicode
          buffer pointer is ‘NULL’, ‘None’ is returned.

     ‘u#’ (*note str: 325.) [const wchar_t *, int]

          Convert a Unicode (UTF-16 or UCS-4) data buffer and its length
          to a Python Unicode object.  If the Unicode buffer pointer is
          ‘NULL’, the length is ignored and ‘None’ is returned.

     ‘U’ (*note str: 325. or ‘None’) [const char *]

          Same as ‘s’.

     ‘U#’ (*note str: 325. or ‘None’) [const char *, int]

          Same as ‘s#’.

     ‘i’ (*note int: 184.) [int]

          Convert a plain C ‘int’ to a Python integer object.

     ‘b’ (*note int: 184.) [char]

          Convert a plain C ‘char’ to a Python integer object.

     ‘h’ (*note int: 184.) [short int]

          Convert a plain C ‘short int’ to a Python integer object.

     ‘l’ (*note int: 184.) [long int]

          Convert a C ‘long int’ to a Python integer object.

     ‘B’ (*note int: 184.) [unsigned char]

          Convert a C ‘unsigned char’ to a Python integer object.

     ‘H’ (*note int: 184.) [unsigned short int]

          Convert a C ‘unsigned short int’ to a Python integer object.

     ‘I’ (*note int: 184.) [unsigned int]

          Convert a C ‘unsigned int’ to a Python integer object.

     ‘k’ (*note int: 184.) [unsigned long]

          Convert a C ‘unsigned long’ to a Python integer object.

     ‘L’ (*note int: 184.) [long long]

          Convert a C ‘long long’ to a Python integer object.

     ‘K’ (*note int: 184.) [unsigned long long]

          Convert a C ‘unsigned long long’ to a Python integer object.

     ‘n’ (*note int: 184.) [Py_ssize_t]

          Convert a C ‘Py_ssize_t’ to a Python integer.

     ‘c’ (*note bytes: 326. of length 1) [char]

          Convert a C ‘int’ representing a byte to a Python *note bytes:
          326. object of length 1.

     ‘C’ (*note str: 325. of length 1) [int]

          Convert a C ‘int’ representing a character to Python *note
          str: 325. object of length 1.

     ‘d’ (*note float: 187.) [double]

          Convert a C ‘double’ to a Python floating point number.

     ‘f’ (*note float: 187.) [float]

          Convert a C ‘float’ to a Python floating point number.

     ‘D’ (*note complex: 189.) [Py_complex *]

          Convert a C *note Py_complex: 3bc2. structure to a Python
          complex number.

     ‘O’ (object) [PyObject *]

          Pass a Python object untouched (except for its reference
          count, which is incremented by one).  If the object passed in
          is a ‘NULL’ pointer, it is assumed that this was caused
          because the call producing the argument found an error and set
          an exception.  Therefore, *note Py_BuildValue(): 2cc. will
          return ‘NULL’ but won’t raise an exception.  If no exception
          has been raised yet, *note SystemError: 5f0. is set.

     ‘S’ (object) [PyObject *]

          Same as ‘O’.

     ‘N’ (object) [PyObject *]

          Same as ‘O’, except it doesn’t increment the reference count
          on the object.  Useful when the object is created by a call to
          an object constructor in the argument list.

     ‘O&’ (object) [`converter', `anything']

          Convert `anything' to a Python object through a `converter'
          function.  The function is called with `anything' (which
          should be compatible with ‘void *’) as its argument and should
          return a “new” Python object, or ‘NULL’ if an error occurred.

     ‘(items)’ (*note tuple: 473.) [`matching-items']

          Convert a sequence of C values to a Python tuple with the same
          number of items.

     ‘[items]’ (*note list: 260.) [`matching-items']

          Convert a sequence of C values to a Python list with the same
          number of items.

     ‘{items}’ (*note dict: 1b6.) [`matching-items']

          Convert a sequence of C values to a Python dictionary.  Each
          pair of consecutive C values adds one item to the dictionary,
          serving as key and value, respectively.

     If there is an error in the format string, the *note SystemError:
     5f0. exception is set and ‘NULL’ returned.

 -- C Function: PyObject* Py_VaBuildValue (const char *format,
          va_list vargs)
     `Return value: New reference.'  Identical to *note Py_BuildValue():
     2cc, except that it accepts a va_list rather than a variable number
     of arguments.


File: python.info,  Node: String conversion and formatting,  Next: Reflection,  Prev: Parsing arguments and building values,  Up: Utilities<2>

7.6.7 String conversion and formatting
--------------------------------------

Functions for number conversion and formatted string output.

 -- C Function: int PyOS_snprintf (char *str, size_t size, const
          char *format, ...)

     Output not more than `size' bytes to `str' according to the format
     string `format' and the extra arguments.  See the Unix man page
     ‘snprintf(2)’.

 -- C Function: int PyOS_vsnprintf (char *str, size_t size, const
          char *format, va_list va)

     Output not more than `size' bytes to `str' according to the format
     string `format' and the variable argument list `va'.  Unix man page
     ‘vsnprintf(2)’.

*note PyOS_snprintf(): e3c. and *note PyOS_vsnprintf(): e3d. wrap the
Standard C library functions ‘snprintf()’ and ‘vsnprintf()’.  Their
purpose is to guarantee consistent behavior in corner cases, which the
Standard C functions do not.

The wrappers ensure that `str*[*size'-1] is always ‘'\0'’ upon return.
They never write more than `size' bytes (including the trailing ‘'\0'’)
into str.  Both functions require that ‘str != NULL’, ‘size > 0’ and
‘format != NULL’.

If the platform doesn’t have ‘vsnprintf()’ and the buffer size needed to
avoid truncation exceeds `size' by more than 512 bytes, Python aborts
with a *note Py_FatalError(): ebb.

The return value (`rv') for these functions should be interpreted as
follows:

   * When ‘0 <= rv < size’, the output conversion was successful and
     `rv' characters were written to `str' (excluding the trailing
     ‘'\0'’ byte at `str*[*rv']).

   * When ‘rv >= size’, the output conversion was truncated and a buffer
     with ‘rv + 1’ bytes would have been needed to succeed.
     `str*[*size'-1] is ‘'\0'’ in this case.

   * When ‘rv < 0’, “something bad happened.” `str*[*size'-1] is ‘'\0'’
     in this case too, but the rest of `str' is undefined.  The exact
     cause of the error depends on the underlying platform.

The following functions provide locale-independent string to number
conversions.

 -- C Function: double PyOS_string_to_double (const char *s,
          char **endptr, PyObject *overflow_exception)

     Convert a string ‘s’ to a ‘double’, raising a Python exception on
     failure.  The set of accepted strings corresponds to the set of
     strings accepted by Python’s *note float(): 187. constructor,
     except that ‘s’ must not have leading or trailing whitespace.  The
     conversion is independent of the current locale.

     If ‘endptr’ is ‘NULL’, convert the whole string.  Raise *note
     ValueError: 1f9. and return ‘-1.0’ if the string is not a valid
     representation of a floating-point number.

     If endptr is not ‘NULL’, convert as much of the string as possible
     and set ‘*endptr’ to point to the first unconverted character.  If
     no initial segment of the string is the valid representation of a
     floating-point number, set ‘*endptr’ to point to the beginning of
     the string, raise ValueError, and return ‘-1.0’.

     If ‘s’ represents a value that is too large to store in a float
     (for example, ‘"1e500"’ is such a string on many platforms) then if
     ‘overflow_exception’ is ‘NULL’ return ‘Py_HUGE_VAL’ (with an
     appropriate sign) and don’t set any exception.  Otherwise,
     ‘overflow_exception’ must point to a Python exception object; raise
     that exception and return ‘-1.0’.  In both cases, set ‘*endptr’ to
     point to the first character after the converted value.

     If any other error occurs during the conversion (for example an
     out-of-memory error), set the appropriate Python exception and
     return ‘-1.0’.

     New in version 3.1.

 -- C Function: char* PyOS_double_to_string (double val,
          char format_code, int precision, int flags, int *ptype)

     Convert a ‘double’ `val' to a string using supplied `format_code',
     `precision', and `flags'.

     `format_code' must be one of ‘'e'’, ‘'E'’, ‘'f'’, ‘'F'’, ‘'g'’,
     ‘'G'’ or ‘'r'’.  For ‘'r'’, the supplied `precision' must be 0 and
     is ignored.  The ‘'r'’ format code specifies the standard *note
     repr(): 7c0. format.

     `flags' can be zero or more of the values ‘Py_DTSF_SIGN’,
     ‘Py_DTSF_ADD_DOT_0’, or ‘Py_DTSF_ALT’, or-ed together:

        * ‘Py_DTSF_SIGN’ means to always precede the returned string
          with a sign character, even if `val' is non-negative.

        * ‘Py_DTSF_ADD_DOT_0’ means to ensure that the returned string
          will not look like an integer.

        * ‘Py_DTSF_ALT’ means to apply “alternate” formatting rules.
          See the documentation for the *note PyOS_snprintf(): e3c.
          ‘'#'’ specifier for details.

     If `ptype' is non-‘NULL’, then the value it points to will be set
     to one of ‘Py_DTST_FINITE’, ‘Py_DTST_INFINITE’, or ‘Py_DTST_NAN’,
     signifying that `val' is a finite number, an infinite number, or
     not a number, respectively.

     The return value is a pointer to `buffer' with the converted string
     or ‘NULL’ if the conversion failed.  The caller is responsible for
     freeing the returned string by calling *note PyMem_Free(): d9c.

     New in version 3.1.

 -- C Function: int PyOS_stricmp (const char *s1, const char *s2)

     Case insensitive comparison of strings.  The function works almost
     identically to ‘strcmp()’ except that it ignores the case.

 -- C Function: int PyOS_strnicmp (const char *s1, const char *s2,
          Py_ssize_t  size)

     Case insensitive comparison of strings.  The function works almost
     identically to ‘strncmp()’ except that it ignores the case.


File: python.info,  Node: Reflection,  Next: Codec registry and support functions,  Prev: String conversion and formatting,  Up: Utilities<2>

7.6.8 Reflection
----------------

 -- C Function: PyObject* PyEval_GetBuiltins ()
     `Return value: Borrowed reference.'  Return a dictionary of the
     builtins in the current execution frame, or the interpreter of the
     thread state if no frame is currently executing.

 -- C Function: PyObject* PyEval_GetLocals ()
     `Return value: Borrowed reference.'  Return a dictionary of the
     local variables in the current execution frame, or ‘NULL’ if no
     frame is currently executing.

 -- C Function: PyObject* PyEval_GetGlobals ()
     `Return value: Borrowed reference.'  Return a dictionary of the
     global variables in the current execution frame, or ‘NULL’ if no
     frame is currently executing.

 -- C Function: PyFrameObject* PyEval_GetFrame ()
     `Return value: Borrowed reference.'  Return the current thread
     state’s frame, which is ‘NULL’ if no frame is currently executing.

 -- C Function: int PyFrame_GetLineNumber (PyFrameObject *frame)

     Return the line number that `frame' is currently executing.

 -- C Function: const char* PyEval_GetFuncName (PyObject *func)

     Return the name of `func' if it is a function, class or instance
     object, else the name of `func's type.

 -- C Function: const char* PyEval_GetFuncDesc (PyObject *func)

     Return a description string, depending on the type of `func'.
     Return values include “()” for functions and methods, ”
     constructor”, ” instance”, and ” object”.  Concatenated with the
     result of *note PyEval_GetFuncName(): 3bd7, the result will be a
     description of `func'.


File: python.info,  Node: Codec registry and support functions,  Prev: Reflection,  Up: Utilities<2>

7.6.9 Codec registry and support functions
------------------------------------------

 -- C Function: int PyCodec_Register (PyObject *search_function)

     Register a new codec search function.

     As side effect, this tries to load the ‘encodings’ package, if not
     yet done, to make sure that it is always first in the list of
     search functions.

 -- C Function: int PyCodec_KnownEncoding (const char *encoding)

     Return ‘1’ or ‘0’ depending on whether there is a registered codec
     for the given `encoding'.  This function always succeeds.

 -- C Function: PyObject* PyCodec_Encode (PyObject *object, const
          char *encoding, const char *errors)
     `Return value: New reference.'  Generic codec based encoding API.

     `object' is passed through the encoder function found for the given
     `encoding' using the error handling method defined by `errors'.
     `errors' may be ‘NULL’ to use the default method defined for the
     codec.  Raises a *note LookupError: 1599. if no encoder can be
     found.

 -- C Function: PyObject* PyCodec_Decode (PyObject *object, const
          char *encoding, const char *errors)
     `Return value: New reference.'  Generic codec based decoding API.

     `object' is passed through the decoder function found for the given
     `encoding' using the error handling method defined by `errors'.
     `errors' may be ‘NULL’ to use the default method defined for the
     codec.  Raises a *note LookupError: 1599. if no encoder can be
     found.

* Menu:

* Codec lookup API::
* Registry API for Unicode encoding error handlers::


File: python.info,  Node: Codec lookup API,  Next: Registry API for Unicode encoding error handlers,  Up: Codec registry and support functions

7.6.9.1 Codec lookup API
........................

In the following functions, the `encoding' string is looked up converted
to all lower-case characters, which makes encodings looked up through
this mechanism effectively case-insensitive.  If no codec is found, a
*note KeyError: 2c5. is set and ‘NULL’ returned.

 -- C Function: PyObject* PyCodec_Encoder (const char *encoding)
     `Return value: New reference.'  Get an encoder function for the
     given `encoding'.

 -- C Function: PyObject* PyCodec_Decoder (const char *encoding)
     `Return value: New reference.'  Get a decoder function for the
     given `encoding'.

 -- C Function: PyObject* PyCodec_IncrementalEncoder (const
          char *encoding, const char *errors)
     `Return value: New reference.'  Get an *note IncrementalEncoder:
     1764. object for the given `encoding'.

 -- C Function: PyObject* PyCodec_IncrementalDecoder (const
          char *encoding, const char *errors)
     `Return value: New reference.'  Get an *note IncrementalDecoder:
     1765. object for the given `encoding'.

 -- C Function: PyObject* PyCodec_StreamReader (const char *encoding,
          PyObject *stream, const char *errors)
     `Return value: New reference.'  Get a *note StreamReader: 1769.
     factory function for the given `encoding'.

 -- C Function: PyObject* PyCodec_StreamWriter (const char *encoding,
          PyObject *stream, const char *errors)
     `Return value: New reference.'  Get a *note StreamWriter: 1768.
     factory function for the given `encoding'.


File: python.info,  Node: Registry API for Unicode encoding error handlers,  Prev: Codec lookup API,  Up: Codec registry and support functions

7.6.9.2 Registry API for Unicode encoding error handlers
........................................................

 -- C Function: int PyCodec_RegisterError (const char *name,
          PyObject *error)

     Register the error handling callback function `error' under the
     given `name'.  This callback function will be called by a codec
     when it encounters unencodable characters/undecodable bytes and
     `name' is specified as the error parameter in the call to the
     encode/decode function.

     The callback gets a single argument, an instance of *note
     UnicodeEncodeError: 1fa, *note UnicodeDecodeError: 1fb. or *note
     UnicodeTranslateError: 164d. that holds information about the
     problematic sequence of characters or bytes and their offset in the
     original string (see *note Unicode Exception Objects: 3b58. for
     functions to extract this information).  The callback must either
     raise the given exception, or return a two-item tuple containing
     the replacement for the problematic sequence, and an integer giving
     the offset in the original string at which encoding/decoding should
     be resumed.

     Return ‘0’ on success, ‘-1’ on error.

 -- C Function: PyObject* PyCodec_LookupError (const char *name)
     `Return value: New reference.'  Lookup the error handling callback
     function registered under `name'.  As a special case ‘NULL’ can be
     passed, in which case the error handling callback for “strict” will
     be returned.

 -- C Function: PyObject* PyCodec_StrictErrors (PyObject *exc)
     `Return value: Always NULL.' Raise `exc' as an exception.

 -- C Function: PyObject* PyCodec_IgnoreErrors (PyObject *exc)
     `Return value: New reference.'  Ignore the unicode error, skipping
     the faulty input.

 -- C Function: PyObject* PyCodec_ReplaceErrors (PyObject *exc)
     `Return value: New reference.'  Replace the unicode encode error
     with ‘?’ or ‘U+FFFD’.

 -- C Function: PyObject* PyCodec_XMLCharRefReplaceErrors
          (PyObject *exc)
     `Return value: New reference.'  Replace the unicode encode error
     with XML character references.

 -- C Function: PyObject* PyCodec_BackslashReplaceErrors (PyObject *exc)
     `Return value: New reference.'  Replace the unicode encode error
     with backslash escapes (‘\x’, ‘\u’ and ‘\U’).

 -- C Function: PyObject* PyCodec_NameReplaceErrors (PyObject *exc)
     `Return value: New reference.'  Replace the unicode encode error
     with ‘\N{...}’ escapes.

     New in version 3.5.


File: python.info,  Node: Abstract Objects Layer,  Next: Concrete Objects Layer,  Prev: Utilities<2>,  Up: Python/C API Reference Manual

7.7 Abstract Objects Layer
==========================

The functions in this chapter interact with Python objects regardless of
their type, or with wide classes of object types (e.g.  all numerical
types, or all sequence types).  When used on object types for which they
do not apply, they will raise a Python exception.

It is not possible to use these functions on objects that are not
properly initialized, such as a list object that has been created by
*note PyList_New(): 3af5, but whose items have not been set to some
non-‘NULL’ value yet.

* Menu:

* Object Protocol::
* Number Protocol::
* Sequence Protocol::
* Mapping Protocol::
* Iterator Protocol::
* Buffer Protocol::
* Old Buffer Protocol::


File: python.info,  Node: Object Protocol,  Next: Number Protocol,  Up: Abstract Objects Layer

7.7.1 Object Protocol
---------------------

 -- C Variable: PyObject* Py_NotImplemented

     The ‘NotImplemented’ singleton, used to signal that an operation is
     not implemented for the given type combination.

 -- C Macro: Py_RETURN_NOTIMPLEMENTED

     Properly handle returning *note Py_NotImplemented: 3bf3. from
     within a C function (that is, increment the reference count of
     NotImplemented and return it).

 -- C Function: int PyObject_Print (PyObject *o, FILE *fp, int flags)

     Print an object `o', on file `fp'.  Returns ‘-1’ on error.  The
     flags argument is used to enable certain printing options.  The
     only option currently supported is ‘Py_PRINT_RAW’; if given, the
     *note str(): 325. of the object is written instead of the *note
     repr(): 7c0.

 -- C Function: int PyObject_HasAttr (PyObject *o, PyObject *attr_name)

     Returns ‘1’ if `o' has the attribute `attr_name', and ‘0’
     otherwise.  This is equivalent to the Python expression ‘hasattr(o,
     attr_name)’.  This function always succeeds.

     Note that exceptions which occur while calling *note __getattr__():
     30f. and *note __getattribute__(): 43e. methods will get
     suppressed.  To get error reporting use *note PyObject_GetAttr():
     3bf6. instead.

 -- C Function: int PyObject_HasAttrString (PyObject *o, const
          char *attr_name)

     Returns ‘1’ if `o' has the attribute `attr_name', and ‘0’
     otherwise.  This is equivalent to the Python expression ‘hasattr(o,
     attr_name)’.  This function always succeeds.

     Note that exceptions which occur while calling *note __getattr__():
     30f. and *note __getattribute__(): 43e. methods and creating a
     temporary string object will get suppressed.  To get error
     reporting use *note PyObject_GetAttrString(): 3a5f. instead.

 -- C Function: PyObject* PyObject_GetAttr (PyObject *o,
          PyObject *attr_name)
     `Return value: New reference.'  Retrieve an attribute named
     `attr_name' from object `o'.  Returns the attribute value on
     success, or ‘NULL’ on failure.  This is the equivalent of the
     Python expression ‘o.attr_name’.

 -- C Function: PyObject* PyObject_GetAttrString (PyObject *o, const
          char *attr_name)
     `Return value: New reference.'  Retrieve an attribute named
     `attr_name' from object `o'.  Returns the attribute value on
     success, or ‘NULL’ on failure.  This is the equivalent of the
     Python expression ‘o.attr_name’.

 -- C Function: PyObject* PyObject_GenericGetAttr (PyObject *o,
          PyObject *name)
     `Return value: New reference.'  Generic attribute getter function
     that is meant to be put into a type object’s ‘tp_getattro’ slot.
     It looks for a descriptor in the dictionary of classes in the
     object’s MRO as well as an attribute in the object’s *note
     __dict__: 4f1. (if present).  As outlined in *note Implementing
     Descriptors: 4de, data descriptors take preference over instance
     attributes, while non-data descriptors don’t.  Otherwise, an *note
     AttributeError: 390. is raised.

 -- C Function: int PyObject_SetAttr (PyObject *o, PyObject *attr_name,
          PyObject *v)

     Set the value of the attribute named `attr_name', for object `o',
     to the value `v'.  Raise an exception and return ‘-1’ on failure;
     return ‘0’ on success.  This is the equivalent of the Python
     statement ‘o.attr_name = v’.

     If `v' is ‘NULL’, the attribute is deleted, however this feature is
     deprecated in favour of using *note PyObject_DelAttr(): 3bfa.

 -- C Function: int PyObject_SetAttrString (PyObject *o, const
          char *attr_name, PyObject *v)

     Set the value of the attribute named `attr_name', for object `o',
     to the value `v'.  Raise an exception and return ‘-1’ on failure;
     return ‘0’ on success.  This is the equivalent of the Python
     statement ‘o.attr_name = v’.

     If `v' is ‘NULL’, the attribute is deleted, however this feature is
     deprecated in favour of using *note PyObject_DelAttrString(): 3bfc.

 -- C Function: int PyObject_GenericSetAttr (PyObject *o,
          PyObject *name, PyObject *value)

     Generic attribute setter and deleter function that is meant to be
     put into a type object’s *note tp_setattro: 3aa4. slot.  It looks
     for a data descriptor in the dictionary of classes in the object’s
     MRO, and if found it takes preference over setting or deleting the
     attribute in the instance dictionary.  Otherwise, the attribute is
     set or deleted in the object’s *note __dict__: 4f1. (if present).
     On success, ‘0’ is returned, otherwise an *note AttributeError:
     390. is raised and ‘-1’ is returned.

 -- C Function: int PyObject_DelAttr (PyObject *o, PyObject *attr_name)

     Delete attribute named `attr_name', for object `o'.  Returns ‘-1’
     on failure.  This is the equivalent of the Python statement ‘del
     o.attr_name’.

 -- C Function: int PyObject_DelAttrString (PyObject *o, const
          char *attr_name)

     Delete attribute named `attr_name', for object `o'.  Returns ‘-1’
     on failure.  This is the equivalent of the Python statement ‘del
     o.attr_name’.

 -- C Function: PyObject* PyObject_GenericGetDict (PyObject *o,
          void *context)
     `Return value: New reference.'  A generic implementation for the
     getter of a ‘__dict__’ descriptor.  It creates the dictionary if
     necessary.

     New in version 3.3.

 -- C Function: int PyObject_GenericSetDict (PyObject *o, void *context)

     A generic implementation for the setter of a ‘__dict__’ descriptor.
     This implementation does not allow the dictionary to be deleted.

     New in version 3.3.

 -- C Function: PyObject* PyObject_RichCompare (PyObject *o1,
          PyObject *o2, int opid)
     `Return value: New reference.'  Compare the values of `o1' and `o2'
     using the operation specified by `opid', which must be one of
     ‘Py_LT’, ‘Py_LE’, ‘Py_EQ’, ‘Py_NE’, ‘Py_GT’, or ‘Py_GE’,
     corresponding to ‘<’, ‘<=’, ‘==’, ‘!=’, ‘>’, or ‘>=’ respectively.
     This is the equivalent of the Python expression ‘o1 op o2’, where
     ‘op’ is the operator corresponding to `opid'.  Returns the value of
     the comparison on success, or ‘NULL’ on failure.

 -- C Function: int PyObject_RichCompareBool (PyObject *o1,
          PyObject *o2, int opid)

     Compare the values of `o1' and `o2' using the operation specified
     by `opid', which must be one of ‘Py_LT’, ‘Py_LE’, ‘Py_EQ’, ‘Py_NE’,
     ‘Py_GT’, or ‘Py_GE’, corresponding to ‘<’, ‘<=’, ‘==’, ‘!=’, ‘>’,
     or ‘>=’ respectively.  Returns ‘-1’ on error, ‘0’ if the result is
     false, ‘1’ otherwise.  This is the equivalent of the Python
     expression ‘o1 op o2’, where ‘op’ is the operator corresponding to
     `opid'.

     Note: If `o1' and `o2' are the same object, *note
     PyObject_RichCompareBool(): 3aab. will always return ‘1’ for
     ‘Py_EQ’ and ‘0’ for ‘Py_NE’.

 -- C Function: PyObject* PyObject_Repr (PyObject *o)
     `Return value: New reference.'

     Compute a string representation of object `o'.  Returns the string
     representation on success, ‘NULL’ on failure.  This is the
     equivalent of the Python expression ‘repr(o)’.  Called by the *note
     repr(): 7c0. built-in function.

     Changed in version 3.4: This function now includes a debug
     assertion to help ensure that it does not silently discard an
     active exception.

 -- C Function: PyObject* PyObject_ASCII (PyObject *o)
     `Return value: New reference.'

     As *note PyObject_Repr(): 95c, compute a string representation of
     object `o', but escape the non-ASCII characters in the string
     returned by *note PyObject_Repr(): 95c. with ‘\x’, ‘\u’ or ‘\U’
     escapes.  This generates a string similar to that returned by *note
     PyObject_Repr(): 95c. in Python 2.  Called by the *note ascii():
     d3f. built-in function.

 -- C Function: PyObject* PyObject_Str (PyObject *o)
     `Return value: New reference.'  Compute a string representation of
     object `o'.  Returns the string representation on success, ‘NULL’
     on failure.  This is the equivalent of the Python expression
     ‘str(o)’.  Called by the *note str(): 325. built-in function and,
     therefore, by the *note print(): 87a. function.

     Changed in version 3.4: This function now includes a debug
     assertion to help ensure that it does not silently discard an
     active exception.

 -- C Function: PyObject* PyObject_Bytes (PyObject *o)
     `Return value: New reference.'

     Compute a bytes representation of object `o'.  ‘NULL’ is returned
     on failure and a bytes object on success.  This is equivalent to
     the Python expression ‘bytes(o)’, when `o' is not an integer.
     Unlike ‘bytes(o)’, a TypeError is raised when `o' is an integer
     instead of a zero-initialized bytes object.

 -- C Function: int PyObject_IsSubclass (PyObject *derived,
          PyObject *cls)

     Return ‘1’ if the class `derived' is identical to or derived from
     the class `cls', otherwise return ‘0’.  In case of an error, return
     ‘-1’.

     If `cls' is a tuple, the check will be done against every entry in
     `cls'.  The result will be ‘1’ when at least one of the checks
     returns ‘1’, otherwise it will be ‘0’.

     If `cls' has a *note __subclasscheck__(): 138d. method, it will be
     called to determine the subclass status as described in PEP
     3119(1).  Otherwise, `derived' is a subclass of `cls' if it is a
     direct or indirect subclass, i.e.  contained in ‘cls.__mro__’.

     Normally only class objects, i.e.  instances of *note type: 5fd. or
     a derived class, are considered classes.  However, objects can
     override this by having a ‘__bases__’ attribute (which must be a
     tuple of base classes).

 -- C Function: int PyObject_IsInstance (PyObject *inst, PyObject *cls)

     Return ‘1’ if `inst' is an instance of the class `cls' or a
     subclass of `cls', or ‘0’ if not.  On error, returns ‘-1’ and sets
     an exception.

     If `cls' is a tuple, the check will be done against every entry in
     `cls'.  The result will be ‘1’ when at least one of the checks
     returns ‘1’, otherwise it will be ‘0’.

     If `cls' has a *note __instancecheck__(): 138c. method, it will be
     called to determine the subclass status as described in PEP
     3119(2).  Otherwise, `inst' is an instance of `cls' if its class is
     a subclass of `cls'.

     An instance `inst' can override what is considered its class by
     having a ‘__class__’ attribute.

     An object `cls' can override if it is considered a class, and what
     its base classes are, by having a ‘__bases__’ attribute (which must
     be a tuple of base classes).

 -- C Function: int PyCallable_Check (PyObject *o)

     Determine if the object `o' is callable.  Return ‘1’ if the object
     is callable and ‘0’ otherwise.  This function always succeeds.

 -- C Function: PyObject* PyObject_Call (PyObject *callable,
          PyObject *args, PyObject *kwargs)
     `Return value: New reference.'  Call a callable Python object
     `callable', with arguments given by the tuple `args', and named
     arguments given by the dictionary `kwargs'.

     `args' must not be ‘NULL’, use an empty tuple if no arguments are
     needed.  If no named arguments are needed, `kwargs' can be ‘NULL’.

     Return the result of the call on success, or raise an exception and
     return ‘NULL’ on failure.

     This is the equivalent of the Python expression: ‘callable(*args,
     **kwargs)’.

 -- C Function: PyObject* PyObject_CallObject (PyObject *callable,
          PyObject *args)
     `Return value: New reference.'  Call a callable Python object
     `callable', with arguments given by the tuple `args'.  If no
     arguments are needed, then `args' can be ‘NULL’.

     Return the result of the call on success, or raise an exception and
     return ‘NULL’ on failure.

     This is the equivalent of the Python expression: ‘callable(*args)’.

 -- C Function: PyObject* PyObject_CallFunction (PyObject *callable,
          const char *format, ...)
     `Return value: New reference.'  Call a callable Python object
     `callable', with a variable number of C arguments.  The C arguments
     are described using a *note Py_BuildValue(): 2cc. style format
     string.  The format can be ‘NULL’, indicating that no arguments are
     provided.

     Return the result of the call on success, or raise an exception and
     return ‘NULL’ on failure.

     This is the equivalent of the Python expression: ‘callable(*args)’.

     Note that if you only pass *note PyObject *: 4b0. args, *note
     PyObject_CallFunctionObjArgs(): 3c03. is a faster alternative.

     Changed in version 3.4: The type of `format' was changed from ‘char
     *’.

 -- C Function: PyObject* PyObject_CallMethod (PyObject *obj, const
          char *name, const char *format, ...)
     `Return value: New reference.'  Call the method named `name' of
     object `obj' with a variable number of C arguments.  The C
     arguments are described by a *note Py_BuildValue(): 2cc. format
     string that should produce a tuple.

     The format can be ‘NULL’, indicating that no arguments are
     provided.

     Return the result of the call on success, or raise an exception and
     return ‘NULL’ on failure.

     This is the equivalent of the Python expression: ‘obj.name(arg1,
     arg2, ...)’.

     Note that if you only pass *note PyObject *: 4b0. args, *note
     PyObject_CallMethodObjArgs(): f0b. is a faster alternative.

     Changed in version 3.4: The types of `name' and `format' were
     changed from ‘char *’.

 -- C Function: PyObject* PyObject_CallFunctionObjArgs
          (PyObject *callable, ..., NULL)
     `Return value: New reference.'  Call a callable Python object
     `callable', with a variable number of *note PyObject*: 4b0.
     arguments.  The arguments are provided as a variable number of
     parameters followed by ‘NULL’.

     Return the result of the call on success, or raise an exception and
     return ‘NULL’ on failure.

     This is the equivalent of the Python expression: ‘callable(arg1,
     arg2, ...)’.

 -- C Function: PyObject* PyObject_CallMethodObjArgs (PyObject *obj,
          PyObject *name, ..., NULL)
     `Return value: New reference.'  Calls a method of the Python object
     `obj', where the name of the method is given as a Python string
     object in `name'.  It is called with a variable number of *note
     PyObject*: 4b0. arguments.  The arguments are provided as a
     variable number of parameters followed by ‘NULL’.

     Return the result of the call on success, or raise an exception and
     return ‘NULL’ on failure.

 -- C Function: PyObject* _PyObject_Vectorcall (PyObject *callable,
          PyObject *const *args, size_t nargsf, PyObject *kwnames)

     Call a callable Python object `callable', using *note vectorcall:
     3c06. if possible.

     `args' is a C array with the positional arguments.

     `nargsf' is the number of positional arguments plus optionally the
     flag ‘PY_VECTORCALL_ARGUMENTS_OFFSET’ (see below).  To get actual
     number of arguments, use *note PyVectorcall_NARGS(nargsf): 3c07.

     `kwnames' can be either ‘NULL’ (no keyword arguments) or a tuple of
     keyword names.  In the latter case, the values of the keyword
     arguments are stored in `args' after the positional arguments.  The
     number of keyword arguments does not influence `nargsf'.

     `kwnames' must contain only objects of type ‘str’ (not a subclass),
     and all keys must be unique.

     Return the result of the call on success, or raise an exception and
     return ‘NULL’ on failure.

     This uses the vectorcall protocol if the callable supports it;
     otherwise, the arguments are converted to use *note tp_call: 3ab1.

          Note: This function is provisional and expected to become
          public in Python 3.9, with a different name and, possibly,
          changed semantics.  If you use the function, plan for updating
          your code for Python 3.9.

     New in version 3.8.

 -- C Variable: PY_VECTORCALL_ARGUMENTS_OFFSET

     If set in a vectorcall `nargsf' argument, the callee is allowed to
     temporarily change ‘args[-1]’.  In other words, `args' points to
     argument 1 (not 0) in the allocated vector.  The callee must
     restore the value of ‘args[-1]’ before returning.

     Whenever they can do so cheaply (without additional allocation),
     callers are encouraged to use ‘PY_VECTORCALL_ARGUMENTS_OFFSET’.
     Doing so will allow callables such as bound methods to make their
     onward calls (which include a prepended `self' argument) cheaply.

     New in version 3.8.

 -- C Function: Py_ssize_t PyVectorcall_NARGS (size_t nargsf)

     Given a vectorcall `nargsf' argument, return the actual number of
     arguments.  Currently equivalent to ‘nargsf &
     ~PY_VECTORCALL_ARGUMENTS_OFFSET’.

     New in version 3.8.

 -- C Function: PyObject* _PyObject_FastCallDict (PyObject *callable,
          PyObject *const *args, size_t nargsf, PyObject *kwdict)

     Same as *note _PyObject_Vectorcall(): 3c05. except that the keyword
     arguments are passed as a dictionary in `kwdict'.  This may be
     ‘NULL’ if there are no keyword arguments.

     For callables supporting *note vectorcall: 3c06, the arguments are
     internally converted to the vectorcall convention.  Therefore, this
     function adds some overhead compared to *note
     _PyObject_Vectorcall(): 3c05.  It should only be used if the caller
     already has a dictionary ready to use.

          Note: This function is provisional and expected to become
          public in Python 3.9, with a different name and, possibly,
          changed semantics.  If you use the function, plan for updating
          your code for Python 3.9.

     New in version 3.8.

 -- C Function: Py_hash_t PyObject_Hash (PyObject *o)

     Compute and return the hash value of an object `o'.  On failure,
     return ‘-1’.  This is the equivalent of the Python expression
     ‘hash(o)’.

     Changed in version 3.2: The return type is now Py_hash_t.  This is
     a signed integer the same size as Py_ssize_t.

 -- C Function: Py_hash_t PyObject_HashNotImplemented (PyObject *o)

     Set a *note TypeError: 192. indicating that ‘type(o)’ is not
     hashable and return ‘-1’.  This function receives special treatment
     when stored in a ‘tp_hash’ slot, allowing a type to explicitly
     indicate to the interpreter that it is not hashable.

 -- C Function: int PyObject_IsTrue (PyObject *o)

     Returns ‘1’ if the object `o' is considered to be true, and ‘0’
     otherwise.  This is equivalent to the Python expression ‘not not
     o’.  On failure, return ‘-1’.

 -- C Function: int PyObject_Not (PyObject *o)

     Returns ‘0’ if the object `o' is considered to be true, and ‘1’
     otherwise.  This is equivalent to the Python expression ‘not o’.
     On failure, return ‘-1’.

 -- C Function: PyObject* PyObject_Type (PyObject *o)
     `Return value: New reference.'

     When `o' is non-‘NULL’, returns a type object corresponding to the
     object type of object `o'.  On failure, raises *note SystemError:
     5f0. and returns ‘NULL’.  This is equivalent to the Python
     expression ‘type(o)’.  This function increments the reference count
     of the return value.  There’s really no reason to use this function
     instead of the common expression ‘o->ob_type’, which returns a
     pointer of type *note PyTypeObject*: 2d4, except when the
     incremented reference count is needed.

 -- C Function: int PyObject_TypeCheck (PyObject *o, PyTypeObject *type)

     Return true if the object `o' is of type `type' or a subtype of
     `type'.  Both parameters must be non-‘NULL’.

 -- C Function: Py_ssize_t PyObject_Size (PyObject *o)
 -- C Function: Py_ssize_t PyObject_Length (PyObject *o)

     Return the length of object `o'.  If the object `o' provides either
     the sequence and mapping protocols, the sequence length is
     returned.  On error, ‘-1’ is returned.  This is the equivalent to
     the Python expression ‘len(o)’.

 -- C Function: Py_ssize_t PyObject_LengthHint (PyObject *o,
          Py_ssize_t default)

     Return an estimated length for the object `o'.  First try to return
     its actual length, then an estimate using *note __length_hint__():
     800, and finally return the default value.  On error return ‘-1’.
     This is the equivalent to the Python expression
     ‘operator.length_hint(o, default)’.

     New in version 3.4.

 -- C Function: PyObject* PyObject_GetItem (PyObject *o, PyObject *key)
     `Return value: New reference.'  Return element of `o' corresponding
     to the object `key' or ‘NULL’ on failure.  This is the equivalent
     of the Python expression ‘o[key]’.

 -- C Function: int PyObject_SetItem (PyObject *o, PyObject *key,
          PyObject *v)

     Map the object `key' to the value `v'.  Raise an exception and
     return ‘-1’ on failure; return ‘0’ on success.  This is the
     equivalent of the Python statement ‘o[key] = v’.

 -- C Function: int PyObject_DelItem (PyObject *o, PyObject *key)

     Remove the mapping for the object `key' from the object `o'.
     Return ‘-1’ on failure.  This is equivalent to the Python statement
     ‘del o[key]’.

 -- C Function: PyObject* PyObject_Dir (PyObject *o)
     `Return value: New reference.'  This is equivalent to the Python
     expression ‘dir(o)’, returning a (possibly empty) list of strings
     appropriate for the object argument, or ‘NULL’ if there was an
     error.  If the argument is ‘NULL’, this is like the Python ‘dir()’,
     returning the names of the current locals; in this case, if no
     execution frame is active then ‘NULL’ is returned but *note
     PyErr_Occurred(): 3a43. will return false.

 -- C Function: PyObject* PyObject_GetIter (PyObject *o)
     `Return value: New reference.'  This is equivalent to the Python
     expression ‘iter(o)’.  It returns a new iterator for the object
     argument, or the object itself if the object is already an
     iterator.  Raises *note TypeError: 192. and returns ‘NULL’ if the
     object cannot be iterated.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3119

   (2) https://www.python.org/dev/peps/pep-3119


File: python.info,  Node: Number Protocol,  Next: Sequence Protocol,  Prev: Object Protocol,  Up: Abstract Objects Layer

7.7.2 Number Protocol
---------------------

 -- C Function: int PyNumber_Check (PyObject *o)

     Returns ‘1’ if the object `o' provides numeric protocols, and false
     otherwise.  This function always succeeds.

     Changed in version 3.8: Returns ‘1’ if `o' is an index integer.

 -- C Function: PyObject* PyNumber_Add (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the result of adding `o1'
     and `o2', or ‘NULL’ on failure.  This is the equivalent of the
     Python expression ‘o1 + o2’.

 -- C Function: PyObject* PyNumber_Subtract (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the result of subtracting
     `o2' from `o1', or ‘NULL’ on failure.  This is the equivalent of
     the Python expression ‘o1 - o2’.

 -- C Function: PyObject* PyNumber_Multiply (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the result of multiplying
     `o1' and `o2', or ‘NULL’ on failure.  This is the equivalent of the
     Python expression ‘o1 * o2’.

 -- C Function: PyObject* PyNumber_MatrixMultiply (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the result of matrix
     multiplication on `o1' and `o2', or ‘NULL’ on failure.  This is the
     equivalent of the Python expression ‘o1 @ o2’.

     New in version 3.5.

 -- C Function: PyObject* PyNumber_FloorDivide (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Return the floor of `o1' divided by
     `o2', or ‘NULL’ on failure.  This is equivalent to the “classic”
     division of integers.

 -- C Function: PyObject* PyNumber_TrueDivide (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Return a reasonable approximation
     for the mathematical value of `o1' divided by `o2', or ‘NULL’ on
     failure.  The return value is “approximate” because binary floating
     point numbers are approximate; it is not possible to represent all
     real numbers in base two.  This function can return a floating
     point value when passed two integers.

 -- C Function: PyObject* PyNumber_Remainder (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the remainder of dividing
     `o1' by `o2', or ‘NULL’ on failure.  This is the equivalent of the
     Python expression ‘o1 % o2’.

 -- C Function: PyObject* PyNumber_Divmod (PyObject *o1, PyObject *o2)
     `Return value: New reference.'

     See the built-in function *note divmod(): f4d.  Returns ‘NULL’ on
     failure.  This is the equivalent of the Python expression
     ‘divmod(o1, o2)’.

 -- C Function: PyObject* PyNumber_Power (PyObject *o1, PyObject *o2,
          PyObject *o3)
     `Return value: New reference.'

     See the built-in function *note pow(): 152.  Returns ‘NULL’ on
     failure.  This is the equivalent of the Python expression ‘pow(o1,
     o2, o3)’, where `o3' is optional.  If `o3' is to be ignored, pass
     *note Py_None: 3a48. in its place (passing ‘NULL’ for `o3' would
     cause an illegal memory access).

 -- C Function: PyObject* PyNumber_Negative (PyObject *o)
     `Return value: New reference.'  Returns the negation of `o' on
     success, or ‘NULL’ on failure.  This is the equivalent of the
     Python expression ‘-o’.

 -- C Function: PyObject* PyNumber_Positive (PyObject *o)
     `Return value: New reference.'  Returns `o' on success, or ‘NULL’
     on failure.  This is the equivalent of the Python expression ‘+o’.

 -- C Function: PyObject* PyNumber_Absolute (PyObject *o)
     `Return value: New reference.'

     Returns the absolute value of `o', or ‘NULL’ on failure.  This is
     the equivalent of the Python expression ‘abs(o)’.

 -- C Function: PyObject* PyNumber_Invert (PyObject *o)
     `Return value: New reference.'  Returns the bitwise negation of `o'
     on success, or ‘NULL’ on failure.  This is the equivalent of the
     Python expression ‘~o’.

 -- C Function: PyObject* PyNumber_Lshift (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the result of left shifting
     `o1' by `o2' on success, or ‘NULL’ on failure.  This is the
     equivalent of the Python expression ‘o1 << o2’.

 -- C Function: PyObject* PyNumber_Rshift (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the result of right
     shifting `o1' by `o2' on success, or ‘NULL’ on failure.  This is
     the equivalent of the Python expression ‘o1 >> o2’.

 -- C Function: PyObject* PyNumber_And (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the “bitwise and” of `o1'
     and `o2' on success and ‘NULL’ on failure.  This is the equivalent
     of the Python expression ‘o1 & o2’.

 -- C Function: PyObject* PyNumber_Xor (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the “bitwise exclusive or”
     of `o1' by `o2' on success, or ‘NULL’ on failure.  This is the
     equivalent of the Python expression ‘o1 ^ o2’.

 -- C Function: PyObject* PyNumber_Or (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Returns the “bitwise or” of `o1'
     and `o2' on success, or ‘NULL’ on failure.  This is the equivalent
     of the Python expression ‘o1 | o2’.

 -- C Function: PyObject* PyNumber_InPlaceAdd (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the result of adding `o1'
     and `o2', or ‘NULL’ on failure.  The operation is done `in-place'
     when `o1' supports it.  This is the equivalent of the Python
     statement ‘o1 += o2’.

 -- C Function: PyObject* PyNumber_InPlaceSubtract (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the result of subtracting
     `o2' from `o1', or ‘NULL’ on failure.  The operation is done
     `in-place' when `o1' supports it.  This is the equivalent of the
     Python statement ‘o1 -= o2’.

 -- C Function: PyObject* PyNumber_InPlaceMultiply (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the result of multiplying
     `o1' and `o2', or ‘NULL’ on failure.  The operation is done
     `in-place' when `o1' supports it.  This is the equivalent of the
     Python statement ‘o1 *= o2’.

 -- C Function: PyObject* PyNumber_InPlaceMatrixMultiply (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the result of matrix
     multiplication on `o1' and `o2', or ‘NULL’ on failure.  The
     operation is done `in-place' when `o1' supports it.  This is the
     equivalent of the Python statement ‘o1 @= o2’.

     New in version 3.5.

 -- C Function: PyObject* PyNumber_InPlaceFloorDivide (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the mathematical floor of
     dividing `o1' by `o2', or ‘NULL’ on failure.  The operation is done
     `in-place' when `o1' supports it.  This is the equivalent of the
     Python statement ‘o1 //= o2’.

 -- C Function: PyObject* PyNumber_InPlaceTrueDivide (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Return a reasonable approximation
     for the mathematical value of `o1' divided by `o2', or ‘NULL’ on
     failure.  The return value is “approximate” because binary floating
     point numbers are approximate; it is not possible to represent all
     real numbers in base two.  This function can return a floating
     point value when passed two integers.  The operation is done
     `in-place' when `o1' supports it.

 -- C Function: PyObject* PyNumber_InPlaceRemainder (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the remainder of dividing
     `o1' by `o2', or ‘NULL’ on failure.  The operation is done
     `in-place' when `o1' supports it.  This is the equivalent of the
     Python statement ‘o1 %= o2’.

 -- C Function: PyObject* PyNumber_InPlacePower (PyObject *o1,
          PyObject *o2, PyObject *o3)
     `Return value: New reference.'

     See the built-in function *note pow(): 152.  Returns ‘NULL’ on
     failure.  The operation is done `in-place' when `o1' supports it.
     This is the equivalent of the Python statement ‘o1 **= o2’ when o3
     is *note Py_None: 3a48, or an in-place variant of ‘pow(o1, o2, o3)’
     otherwise.  If `o3' is to be ignored, pass *note Py_None: 3a48. in
     its place (passing ‘NULL’ for `o3' would cause an illegal memory
     access).

 -- C Function: PyObject* PyNumber_InPlaceLshift (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the result of left shifting
     `o1' by `o2' on success, or ‘NULL’ on failure.  The operation is
     done `in-place' when `o1' supports it.  This is the equivalent of
     the Python statement ‘o1 <<= o2’.

 -- C Function: PyObject* PyNumber_InPlaceRshift (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the result of right
     shifting `o1' by `o2' on success, or ‘NULL’ on failure.  The
     operation is done `in-place' when `o1' supports it.  This is the
     equivalent of the Python statement ‘o1 >>= o2’.

 -- C Function: PyObject* PyNumber_InPlaceAnd (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the “bitwise and” of `o1'
     and `o2' on success and ‘NULL’ on failure.  The operation is done
     `in-place' when `o1' supports it.  This is the equivalent of the
     Python statement ‘o1 &= o2’.

 -- C Function: PyObject* PyNumber_InPlaceXor (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the “bitwise exclusive or”
     of `o1' by `o2' on success, or ‘NULL’ on failure.  The operation is
     done `in-place' when `o1' supports it.  This is the equivalent of
     the Python statement ‘o1 ^= o2’.

 -- C Function: PyObject* PyNumber_InPlaceOr (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Returns the “bitwise or” of `o1'
     and `o2' on success, or ‘NULL’ on failure.  The operation is done
     `in-place' when `o1' supports it.  This is the equivalent of the
     Python statement ‘o1 |= o2’.

 -- C Function: PyObject* PyNumber_Long (PyObject *o)
     `Return value: New reference.'

     Returns the `o' converted to an integer object on success, or
     ‘NULL’ on failure.  This is the equivalent of the Python expression
     ‘int(o)’.

 -- C Function: PyObject* PyNumber_Float (PyObject *o)
     `Return value: New reference.'

     Returns the `o' converted to a float object on success, or ‘NULL’
     on failure.  This is the equivalent of the Python expression
     ‘float(o)’.

 -- C Function: PyObject* PyNumber_Index (PyObject *o)
     `Return value: New reference.'  Returns the `o' converted to a
     Python int on success or ‘NULL’ with a *note TypeError: 192.
     exception raised on failure.

 -- C Function: PyObject* PyNumber_ToBase (PyObject *n, int base)
     `Return value: New reference.'  Returns the integer `n' converted
     to base `base' as a string.  The `base' argument must be one of 2,
     8, 10, or 16.  For base 2, 8, or 16, the returned string is
     prefixed with a base marker of ‘'0b'’, ‘'0o'’, or ‘'0x'’,
     respectively.  If `n' is not a Python int, it is converted with
     *note PyNumber_Index(): 3c33. first.

 -- C Function: Py_ssize_t PyNumber_AsSsize_t (PyObject *o,
          PyObject *exc)

     Returns `o' converted to a Py_ssize_t value if `o' can be
     interpreted as an integer.  If the call fails, an exception is
     raised and ‘-1’ is returned.

     If `o' can be converted to a Python int but the attempt to convert
     to a Py_ssize_t value would raise an *note OverflowError: 954, then
     the `exc' argument is the type of exception that will be raised
     (usually *note IndexError: e69. or *note OverflowError: 954.).  If
     `exc' is ‘NULL’, then the exception is cleared and the value is
     clipped to ‘PY_SSIZE_T_MIN’ for a negative integer or
     ‘PY_SSIZE_T_MAX’ for a positive integer.

 -- C Function: int PyIndex_Check (PyObject *o)

     Returns ‘1’ if `o' is an index integer (has the nb_index slot of
     the tp_as_number structure filled in), and ‘0’ otherwise.  This
     function always succeeds.


File: python.info,  Node: Sequence Protocol,  Next: Mapping Protocol,  Prev: Number Protocol,  Up: Abstract Objects Layer

7.7.3 Sequence Protocol
-----------------------

 -- C Function: int PySequence_Check (PyObject *o)

     Return ‘1’ if the object provides sequence protocol, and ‘0’
     otherwise.  Note that it returns ‘1’ for Python classes with a
     *note __getitem__(): 27a. method unless they are *note dict: 1b6.
     subclasses since in general case it is impossible to determine what
     the type of keys it supports.  This function always succeeds.

 -- C Function: Py_ssize_t PySequence_Size (PyObject *o)
 -- C Function: Py_ssize_t PySequence_Length (PyObject *o)

     Returns the number of objects in sequence `o' on success, and ‘-1’
     on failure.  This is equivalent to the Python expression ‘len(o)’.

 -- C Function: PyObject* PySequence_Concat (PyObject *o1, PyObject *o2)
     `Return value: New reference.'  Return the concatenation of `o1'
     and `o2' on success, and ‘NULL’ on failure.  This is the equivalent
     of the Python expression ‘o1 + o2’.

 -- C Function: PyObject* PySequence_Repeat (PyObject *o,
          Py_ssize_t count)
     `Return value: New reference.'  Return the result of repeating
     sequence object `o' `count' times, or ‘NULL’ on failure.  This is
     the equivalent of the Python expression ‘o * count’.

 -- C Function: PyObject* PySequence_InPlaceConcat (PyObject *o1,
          PyObject *o2)
     `Return value: New reference.'  Return the concatenation of `o1'
     and `o2' on success, and ‘NULL’ on failure.  The operation is done
     `in-place' when `o1' supports it.  This is the equivalent of the
     Python expression ‘o1 += o2’.

 -- C Function: PyObject* PySequence_InPlaceRepeat (PyObject *o,
          Py_ssize_t count)
     `Return value: New reference.'  Return the result of repeating
     sequence object `o' `count' times, or ‘NULL’ on failure.  The
     operation is done `in-place' when `o' supports it.  This is the
     equivalent of the Python expression ‘o *= count’.

 -- C Function: PyObject* PySequence_GetItem (PyObject *o, Py_ssize_t i)
     `Return value: New reference.'  Return the `i'th element of `o', or
     ‘NULL’ on failure.  This is the equivalent of the Python expression
     ‘o[i]’.

 -- C Function: PyObject* PySequence_GetSlice (PyObject *o,
          Py_ssize_t i1, Py_ssize_t i2)
     `Return value: New reference.'  Return the slice of sequence object
     `o' between `i1' and `i2', or ‘NULL’ on failure.  This is the
     equivalent of the Python expression ‘o[i1:i2]’.

 -- C Function: int PySequence_SetItem (PyObject *o, Py_ssize_t i,
          PyObject *v)

     Assign object `v' to the `i'th element of `o'.  Raise an exception
     and return ‘-1’ on failure; return ‘0’ on success.  This is the
     equivalent of the Python statement ‘o[i] = v’.  This function `does
     not' steal a reference to `v'.

     If `v' is ‘NULL’, the element is deleted, however this feature is
     deprecated in favour of using *note PySequence_DelItem(): f88.

 -- C Function: int PySequence_DelItem (PyObject *o, Py_ssize_t i)

     Delete the `i'th element of object `o'.  Returns ‘-1’ on failure.
     This is the equivalent of the Python statement ‘del o[i]’.

 -- C Function: int PySequence_SetSlice (PyObject *o, Py_ssize_t i1,
          Py_ssize_t i2, PyObject *v)

     Assign the sequence object `v' to the slice in sequence object `o'
     from `i1' to `i2'.  This is the equivalent of the Python statement
     ‘o[i1:i2] = v’.

 -- C Function: int PySequence_DelSlice (PyObject *o, Py_ssize_t i1,
          Py_ssize_t i2)

     Delete the slice in sequence object `o' from `i1' to `i2'.  Returns
     ‘-1’ on failure.  This is the equivalent of the Python statement
     ‘del o[i1:i2]’.

 -- C Function: Py_ssize_t PySequence_Count (PyObject *o,
          PyObject *value)

     Return the number of occurrences of `value' in `o', that is, return
     the number of keys for which ‘o[key] == value’.  On failure, return
     ‘-1’.  This is equivalent to the Python expression
     ‘o.count(value)’.

 -- C Function: int PySequence_Contains (PyObject *o, PyObject *value)

     Determine if `o' contains `value'.  If an item in `o' is equal to
     `value', return ‘1’, otherwise return ‘0’.  On error, return ‘-1’.
     This is equivalent to the Python expression ‘value in o’.

 -- C Function: Py_ssize_t PySequence_Index (PyObject *o,
          PyObject *value)

     Return the first index `i' for which ‘o[i] == value’.  On error,
     return ‘-1’.  This is equivalent to the Python expression
     ‘o.index(value)’.

 -- C Function: PyObject* PySequence_List (PyObject *o)
     `Return value: New reference.'  Return a list object with the same
     contents as the sequence or iterable `o', or ‘NULL’ on failure.
     The returned list is guaranteed to be new.  This is equivalent to
     the Python expression ‘list(o)’.

 -- C Function: PyObject* PySequence_Tuple (PyObject *o)
     `Return value: New reference.'

     Return a tuple object with the same contents as the sequence or
     iterable `o', or ‘NULL’ on failure.  If `o' is a tuple, a new
     reference will be returned, otherwise a tuple will be constructed
     with the appropriate contents.  This is equivalent to the Python
     expression ‘tuple(o)’.

 -- C Function: PyObject* PySequence_Fast (PyObject *o, const char *m)
     `Return value: New reference.'  Return the sequence or iterable `o'
     as an object usable by the other ‘PySequence_Fast*’ family of
     functions.  If the object is not a sequence or iterable, raises
     *note TypeError: 192. with `m' as the message text.  Returns ‘NULL’
     on failure.

     The ‘PySequence_Fast*’ functions are thus named because they assume
     `o' is a *note PyTupleObject: 3b98. or a *note PyListObject: 3c48.
     and access the data fields of `o' directly.

     As a CPython implementation detail, if `o' is already a sequence or
     list, it will be returned.

 -- C Function: Py_ssize_t PySequence_Fast_GET_SIZE (PyObject *o)

     Returns the length of `o', assuming that `o' was returned by *note
     PySequence_Fast(): 3c47. and that `o' is not ‘NULL’.  The size can
     also be gotten by calling *note PySequence_Size(): f85. on `o', but
     *note PySequence_Fast_GET_SIZE(): 3c49. is faster because it can
     assume `o' is a list or tuple.

 -- C Function: PyObject* PySequence_Fast_GET_ITEM (PyObject *o,
          Py_ssize_t i)
     `Return value: Borrowed reference.'  Return the `i'th element of
     `o', assuming that `o' was returned by *note PySequence_Fast():
     3c47, `o' is not ‘NULL’, and that `i' is within bounds.

 -- C Function: PyObject** PySequence_Fast_ITEMS (PyObject *o)

     Return the underlying array of PyObject pointers.  Assumes that `o'
     was returned by *note PySequence_Fast(): 3c47. and `o' is not
     ‘NULL’.

     Note, if a list gets resized, the reallocation may relocate the
     items array.  So, only use the underlying array pointer in contexts
     where the sequence cannot change.

 -- C Function: PyObject* PySequence_ITEM (PyObject *o, Py_ssize_t i)
     `Return value: New reference.'  Return the `i'th element of `o' or
     ‘NULL’ on failure.  Faster form of *note PySequence_GetItem(): f86.
     but without checking that *note PySequence_Check(): 3c39. on `o' is
     true and without adjustment for negative indices.


File: python.info,  Node: Mapping Protocol,  Next: Iterator Protocol,  Prev: Sequence Protocol,  Up: Abstract Objects Layer

7.7.4 Mapping Protocol
----------------------

See also *note PyObject_GetItem(): 3af6, *note PyObject_SetItem(): 3af4.
and *note PyObject_DelItem(): 3c10.

 -- C Function: int PyMapping_Check (PyObject *o)

     Return ‘1’ if the object provides mapping protocol or supports
     slicing, and ‘0’ otherwise.  Note that it returns ‘1’ for Python
     classes with a *note __getitem__(): 27a. method since in general
     case it is impossible to determine what type of keys it supports.
     This function always succeeds.

 -- C Function: Py_ssize_t PyMapping_Size (PyObject *o)
 -- C Function: Py_ssize_t PyMapping_Length (PyObject *o)

     Returns the number of keys in object `o' on success, and ‘-1’ on
     failure.  This is equivalent to the Python expression ‘len(o)’.

 -- C Function: PyObject* PyMapping_GetItemString (PyObject *o, const
          char *key)
     `Return value: New reference.'  Return element of `o' corresponding
     to the string `key' or ‘NULL’ on failure.  This is the equivalent
     of the Python expression ‘o[key]’.  See also *note
     PyObject_GetItem(): 3af6.

 -- C Function: int PyMapping_SetItemString (PyObject *o, const
          char *key, PyObject *v)

     Map the string `key' to the value `v' in object `o'.  Returns ‘-1’
     on failure.  This is the equivalent of the Python statement ‘o[key]
     = v’.  See also *note PyObject_SetItem(): 3af4.

 -- C Function: int PyMapping_DelItem (PyObject *o, PyObject *key)

     Remove the mapping for the object `key' from the object `o'.
     Return ‘-1’ on failure.  This is equivalent to the Python statement
     ‘del o[key]’.  This is an alias of *note PyObject_DelItem(): 3c10.

 -- C Function: int PyMapping_DelItemString (PyObject *o, const
          char *key)

     Remove the mapping for the string `key' from the object `o'.
     Return ‘-1’ on failure.  This is equivalent to the Python statement
     ‘del o[key]’.

 -- C Function: int PyMapping_HasKey (PyObject *o, PyObject *key)

     Return ‘1’ if the mapping object has the key `key' and ‘0’
     otherwise.  This is equivalent to the Python expression ‘key in o’.
     This function always succeeds.

     Note that exceptions which occur while calling the *note
     __getitem__(): 27a. method will get suppressed.  To get error
     reporting use *note PyObject_GetItem(): 3af6. instead.

 -- C Function: int PyMapping_HasKeyString (PyObject *o, const
          char *key)

     Return ‘1’ if the mapping object has the key `key' and ‘0’
     otherwise.  This is equivalent to the Python expression ‘key in o’.
     This function always succeeds.

     Note that exceptions which occur while calling the *note
     __getitem__(): 27a. method and creating a temporary string object
     will get suppressed.  To get error reporting use *note
     PyMapping_GetItemString(): 3c52. instead.

 -- C Function: PyObject* PyMapping_Keys (PyObject *o)
     `Return value: New reference.'  On success, return a list of the
     keys in object `o'.  On failure, return ‘NULL’.

     Changed in version 3.7: Previously, the function returned a list or
     a tuple.

 -- C Function: PyObject* PyMapping_Values (PyObject *o)
     `Return value: New reference.'  On success, return a list of the
     values in object `o'.  On failure, return ‘NULL’.

     Changed in version 3.7: Previously, the function returned a list or
     a tuple.

 -- C Function: PyObject* PyMapping_Items (PyObject *o)
     `Return value: New reference.'  On success, return a list of the
     items in object `o', where each item is a tuple containing a
     key-value pair.  On failure, return ‘NULL’.

     Changed in version 3.7: Previously, the function returned a list or
     a tuple.


File: python.info,  Node: Iterator Protocol,  Next: Buffer Protocol,  Prev: Mapping Protocol,  Up: Abstract Objects Layer

7.7.5 Iterator Protocol
-----------------------

There are two functions specifically for working with iterators.

 -- C Function: int PyIter_Check (PyObject *o)

     Return true if the object `o' supports the iterator protocol.

 -- C Function: PyObject* PyIter_Next (PyObject *o)
     `Return value: New reference.'  Return the next value from the
     iteration `o'.  The object must be an iterator (it is up to the
     caller to check this).  If there are no remaining values, returns
     ‘NULL’ with no exception set.  If an error occurs while retrieving
     the item, returns ‘NULL’ and passes along the exception.

To write a loop which iterates over an iterator, the C code should look
something like this:

     PyObject *iterator = PyObject_GetIter(obj); PyObject *item;  if (iterator == NULL) {     /* propagate error */ }  while (item = PyIter_Next(iterator)) {     /* do something with item */     ...     /* release reference when done */     Py_DECREF(item); }  Py_DECREF(iterator);  if (PyErr_Occurred()) {     /* propagate error */ } else {     /* continue doing useful work */ }


File: python.info,  Node: Buffer Protocol,  Next: Old Buffer Protocol,  Prev: Iterator Protocol,  Up: Abstract Objects Layer

7.7.6 Buffer Protocol
---------------------

Certain objects available in Python wrap access to an underlying memory
array or `buffer'.  Such objects include the built-in *note bytes: 326.
and *note bytearray: 327, and some extension types like *note
array.array: 446.  Third-party libraries may define their own types for
special purposes, such as image processing or numeric analysis.

While each of these types have their own semantics, they share the
common characteristic of being backed by a possibly large memory buffer.
It is then desirable, in some situations, to access that buffer directly
and without intermediate copying.

Python provides such a facility at the C level in the form of the *note
buffer protocol: 1579.  This protocol has two sides:

   - on the producer side, a type can export a “buffer interface” which
     allows objects of that type to expose information about their
     underlying buffer.  This interface is described in the section
     *note Buffer Object Structures: 3c5e.;

   - on the consumer side, several means are available to obtain a
     pointer to the raw underlying data of an object (for example a
     method parameter).

Simple objects such as *note bytes: 326. and *note bytearray: 327.
expose their underlying buffer in byte-oriented form.  Other forms are
possible; for example, the elements exposed by an *note array.array:
446. can be multi-byte values.

An example consumer of the buffer interface is the *note write(): 57e.
method of file objects: any object that can export a series of bytes
through the buffer interface can be written to a file.  While ‘write()’
only needs read-only access to the internal contents of the object
passed to it, other methods such as *note readinto(): 1f32. need write
access to the contents of their argument.  The buffer interface allows
objects to selectively allow or reject exporting of read-write and
read-only buffers.

There are two ways for a consumer of the buffer interface to acquire a
buffer over a target object:

   * call *note PyObject_GetBuffer(): d18. with the right parameters;

   * call *note PyArg_ParseTuple(): 268. (or one of its siblings) with
     one of the ‘y*’, ‘w*’ or ‘s*’ *note format codes: 2ce.

In both cases, *note PyBuffer_Release(): d47. must be called when the
buffer isn’t needed anymore.  Failure to do so could lead to various
issues such as resource leaks.

* Menu:

* Buffer structure::
* Buffer request types::
* Complex arrays::
* Buffer-related functions::


File: python.info,  Node: Buffer structure,  Next: Buffer request types,  Up: Buffer Protocol

7.7.6.1 Buffer structure
........................

Buffer structures (or simply “buffers”) are useful as a way to expose
the binary data from another object to the Python programmer.  They can
also be used as a zero-copy slicing mechanism.  Using their ability to
reference a block of memory, it is possible to expose any data to the
Python programmer quite easily.  The memory could be a large, constant
array in a C extension, it could be a raw block of memory for
manipulation before passing to an operating system library, or it could
be used to pass around structured data in its native, in-memory format.

Contrary to most data types exposed by the Python interpreter, buffers
are not *note PyObject: 4b0. pointers but rather simple C structures.
This allows them to be created and copied very simply.  When a generic
wrapper around a buffer is needed, a *note memoryview: 3c61. object can
be created.

For short instructions how to write an exporting object, see *note
Buffer Object Structures: 3c5e.  For obtaining a buffer, see *note
PyObject_GetBuffer(): d18.

 -- C Type: Py_buffer

      -- C Member: void *buf

          A pointer to the start of the logical structure described by
          the buffer fields.  This can be any location within the
          underlying physical memory block of the exporter.  For
          example, with negative *note strides: 3c63. the value may
          point to the end of the memory block.

          For *note contiguous: 15f1. arrays, the value points to the
          beginning of the memory block.

      -- C Member: void *obj

          A new reference to the exporting object.  The reference is
          owned by the consumer and automatically decremented and set to
          ‘NULL’ by *note PyBuffer_Release(): d47.  The field is the
          equivalent of the return value of any standard C-API function.

          As a special case, for `temporary' buffers that are wrapped by
          *note PyMemoryView_FromBuffer(): 3c65. or *note
          PyBuffer_FillInfo(): 3c66. this field is ‘NULL’.  In general,
          exporting objects MUST NOT use this scheme.

      -- C Member: Py_ssize_t len

          ‘product(shape) * itemsize’.  For contiguous arrays, this is
          the length of the underlying memory block.  For non-contiguous
          arrays, it is the length that the logical structure would have
          if it were copied to a contiguous representation.

          Accessing ‘((char *)buf)[0] up to ((char *)buf)[len-1]’ is
          only valid if the buffer has been obtained by a request that
          guarantees contiguity.  In most cases such a request will be
          *note PyBUF_SIMPLE: 3c68. or *note PyBUF_WRITABLE: 3c69.

      -- C Member: int readonly

          An indicator of whether the buffer is read-only.  This field
          is controlled by the *note PyBUF_WRITABLE: 3c69. flag.

      -- C Member: Py_ssize_t itemsize

          Item size in bytes of a single element.  Same as the value of
          *note struct.calcsize(): 1748. called on non-‘NULL’ *note
          format: 3c6c. values.

          Important exception: If a consumer requests a buffer without
          the *note PyBUF_FORMAT: 3c6d. flag, *note format: 3c6c. will
          be set to ‘NULL’, but *note itemsize: 3c6b. still has the
          value for the original format.

          If *note shape: 3c6e. is present, the equality ‘product(shape)
          * itemsize == len’ still holds and the consumer can use *note
          itemsize: 3c6b. to navigate the buffer.

          If *note shape: 3c6e. is ‘NULL’ as a result of a *note
          PyBUF_SIMPLE: 3c68. or a *note PyBUF_WRITABLE: 3c69. request,
          the consumer must disregard *note itemsize: 3c6b. and assume
          ‘itemsize == 1’.

      -- C Member: const char *format

          A `NUL' terminated string in *note struct: f8. module style
          syntax describing the contents of a single item.  If this is
          ‘NULL’, ‘"B"’ (unsigned bytes) is assumed.

          This field is controlled by the *note PyBUF_FORMAT: 3c6d.
          flag.

      -- C Member: int ndim

          The number of dimensions the memory represents as an
          n-dimensional array.  If it is ‘0’, *note buf: 3c62. points to
          a single item representing a scalar.  In this case, *note
          shape: 3c6e, *note strides: 3c63. and *note suboffsets: 3c70.
          MUST be ‘NULL’.

          The macro ‘PyBUF_MAX_NDIM’ limits the maximum number of
          dimensions to 64.  Exporters MUST respect this limit,
          consumers of multi-dimensional buffers SHOULD be able to
          handle up to ‘PyBUF_MAX_NDIM’ dimensions.

      -- C Member: Py_ssize_t *shape

          An array of ‘Py_ssize_t’ of length *note ndim: 3c6f.
          indicating the shape of the memory as an n-dimensional array.
          Note that ‘shape[0] * ... * shape[ndim-1] * itemsize’ MUST be
          equal to *note len: 3c67.

          Shape values are restricted to ‘shape[n] >= 0’.  The case
          ‘shape[n] == 0’ requires special attention.  See *note complex
          arrays: 3c71. for further information.

          The shape array is read-only for the consumer.

      -- C Member: Py_ssize_t *strides

          An array of ‘Py_ssize_t’ of length *note ndim: 3c6f. giving
          the number of bytes to skip to get to a new element in each
          dimension.

          Stride values can be any integer.  For regular arrays, strides
          are usually positive, but a consumer MUST be able to handle
          the case ‘strides[n] <= 0’.  See *note complex arrays: 3c71.
          for further information.

          The strides array is read-only for the consumer.

      -- C Member: Py_ssize_t *suboffsets

          An array of ‘Py_ssize_t’ of length *note ndim: 3c6f.  If
          ‘suboffsets[n] >= 0’, the values stored along the nth
          dimension are pointers and the suboffset value dictates how
          many bytes to add to each pointer after de-referencing.  A
          suboffset value that is negative indicates that no
          de-referencing should occur (striding in a contiguous memory
          block).

          If all suboffsets are negative (i.e.  no de-referencing is
          needed), then this field must be ‘NULL’ (the default value).

          This type of array representation is used by the Python
          Imaging Library (PIL). See *note complex arrays: 3c71. for
          further information how to access elements of such an array.

          The suboffsets array is read-only for the consumer.

      -- C Member: void *internal

          This is for use internally by the exporting object.  For
          example, this might be re-cast as an integer by the exporter
          and used to store flags about whether or not the shape,
          strides, and suboffsets arrays must be freed when the buffer
          is released.  The consumer MUST NOT alter this value.


File: python.info,  Node: Buffer request types,  Next: Complex arrays,  Prev: Buffer structure,  Up: Buffer Protocol

7.7.6.2 Buffer request types
............................

Buffers are usually obtained by sending a buffer request to an exporting
object via *note PyObject_GetBuffer(): d18.  Since the complexity of the
logical structure of the memory can vary drastically, the consumer uses
the `flags' argument to specify the exact buffer type it can handle.

All *note Py_buffer: b0e. fields are unambiguously defined by the
request type.

* Menu:

* request-independent fields::
* readonly, format: readonly format.
* shape, strides, suboffsets: shape strides suboffsets.
* contiguity requests::
* compound requests::


File: python.info,  Node: request-independent fields,  Next: readonly format,  Up: Buffer request types

7.7.6.3 request-independent fields
..................................

The following fields are not influenced by `flags' and must always be
filled in with the correct values: *note obj: 3c64, *note buf: 3c62,
*note len: 3c67, *note itemsize: 3c6b, *note ndim: 3c6f.


File: python.info,  Node: readonly format,  Next: shape strides suboffsets,  Prev: request-independent fields,  Up: Buffer request types

7.7.6.4 readonly, format
........................

      -- C Macro: PyBUF_WRITABLE

          Controls the *note readonly: 3c6a. field.  If set, the
          exporter MUST provide a writable buffer or else report
          failure.  Otherwise, the exporter MAY provide either a
          read-only or writable buffer, but the choice MUST be
          consistent for all consumers.

      -- C Macro: PyBUF_FORMAT

          Controls the *note format: 3c6c. field.  If set, this field
          MUST be filled in correctly.  Otherwise, this field MUST be
          ‘NULL’.

*note PyBUF_WRITABLE: 3c69. can be |’d to any of the flags in the next
section.  Since *note PyBUF_SIMPLE: 3c68. is defined as 0, *note
PyBUF_WRITABLE: 3c69. can be used as a stand-alone flag to request a
simple writable buffer.

*note PyBUF_FORMAT: 3c6d. can be |’d to any of the flags except *note
PyBUF_SIMPLE: 3c68.  The latter already implies format ‘B’ (unsigned
bytes).


File: python.info,  Node: shape strides suboffsets,  Next: contiguity requests,  Prev: readonly format,  Up: Buffer request types

7.7.6.5 shape, strides, suboffsets
..................................

The flags that control the logical structure of the memory are listed in
decreasing order of complexity.  Note that each flag contains all bits
of the flags below it.

Request                           shape       strides       suboffsets
                                                            
-----------------------------------------------------------------------------
                                                            
 -- C Macro: PyBUF_INDIRECT       yes         yes           if needed
                                                            
                                                            
 -- C Macro: PyBUF_STRIDES        yes         yes           NULL
                                                            
                                                            
 -- C Macro: PyBUF_ND             yes         NULL          NULL
                                                            
                                                            
 -- C Macro: PyBUF_SIMPLE         NULL        NULL          NULL
                                                            


File: python.info,  Node: contiguity requests,  Next: compound requests,  Prev: shape strides suboffsets,  Up: Buffer request types

7.7.6.6 contiguity requests
...........................

C or Fortran *note contiguity: 15f1. can be explicitly requested, with
and without stride information.  Without stride information, the buffer
must be C-contiguous.

Request                                 shape       strides       suboffsets       contig
                                                                                   
------------------------------------------------------------------------------------------------
                                                                                   
 -- C Macro: PyBUF_C_CONTIGUOUS         yes         yes           NULL             C
                                                                                   
                                                                                   
 -- C Macro: PyBUF_F_CONTIGUOUS         yes         yes           NULL             F
                                                                                   
                                                                                   
 -- C Macro: PyBUF_ANY_CONTIGUOUS       yes         yes           NULL             C or F
                                                                                   
                                                                                   
 -- C Macro: PyBUF_ND                   yes         NULL          NULL             C
                                                                                   


File: python.info,  Node: compound requests,  Prev: contiguity requests,  Up: Buffer request types

7.7.6.7 compound requests
.........................

All possible requests are fully defined by some combination of the flags
in the previous section.  For convenience, the buffer protocol provides
frequently used combinations as single flags.

In the following table `U' stands for undefined contiguity.  The
consumer would have to call *note PyBuffer_IsContiguous(): 3c80. to
determine contiguity.

Request                             shape       strides       suboffsets       contig       readonly       format
                                                                                                           
------------------------------------------------------------------------------------------------------------------------
                                                                                                           
 -- C Macro: PyBUF_FULL             yes         yes           if needed        U            0              yes
                                                                                                           
                                                                                                           
 -- C Macro: PyBUF_FULL_RO          yes         yes           if needed        U            1 or 0         yes
                                                                                                           
                                                                                                           
 -- C Macro: PyBUF_RECORDS          yes         yes           NULL             U            0              yes
                                                                                                           
                                                                                                           
 -- C Macro: PyBUF_RECORDS_RO       yes         yes           NULL             U            1 or 0         yes
                                                                                                           
                                                                                                           
 -- C Macro: PyBUF_STRIDED          yes         yes           NULL             U            0              NULL
                                                                                                           
                                                                                                           
 -- C Macro: PyBUF_STRIDED_RO       yes         yes           NULL             U            1 or 0         NULL
                                                                                                           
                                                                                                           
 -- C Macro: PyBUF_CONTIG           yes         NULL          NULL             C            0              NULL
                                                                                                           
                                                                                                           
 -- C Macro: PyBUF_CONTIG_RO        yes         NULL          NULL             C            1 or 0         NULL
                                                                                                           


File: python.info,  Node: Complex arrays,  Next: Buffer-related functions,  Prev: Buffer request types,  Up: Buffer Protocol

7.7.6.8 Complex arrays
......................

* Menu:

* NumPy-style; shape and strides: NumPy-style shape and strides.
* PIL-style; shape, strides and suboffsets: PIL-style shape strides and suboffsets.


File: python.info,  Node: NumPy-style shape and strides,  Next: PIL-style shape strides and suboffsets,  Up: Complex arrays

7.7.6.9 NumPy-style: shape and strides
......................................

The logical structure of NumPy-style arrays is defined by *note
itemsize: 3c6b, *note ndim: 3c6f, *note shape: 3c6e. and *note strides:
3c63.

If ‘ndim == 0’, the memory location pointed to by *note buf: 3c62. is
interpreted as a scalar of size *note itemsize: 3c6b.  In that case,
both *note shape: 3c6e. and *note strides: 3c63. are ‘NULL’.

If *note strides: 3c63. is ‘NULL’, the array is interpreted as a
standard n-dimensional C-array.  Otherwise, the consumer must access an
n-dimensional array as follows:

     ptr = (char *)buf + indices[0] * strides[0] + ... + indices[n-1] * strides[n-1]; item = *((typeof(item) *)ptr);

As noted above, *note buf: 3c62. can point to any location within the
actual memory block.  An exporter can check the validity of a buffer
with this function:

     def verify_structure(memlen, itemsize, ndim, shape, strides, offset):     """Verify that the parameters represent a valid array within        the bounds of the allocated memory:            char *mem: start of the physical memory block            memlen: length of the physical memory block            offset: (char *)buf - mem     """     if offset % itemsize:         return False     if offset < 0 or offset+itemsize > memlen:         return False     if any(v % itemsize for v in strides):         return False      if ndim <= 0:         return ndim == 0 and not shape and not strides     if 0 in shape:         return True      imin = sum(strides[j]*(shape[j]-1) for j in range(ndim)                if strides[j] <= 0)     imax = sum(strides[j]*(shape[j]-1) for j in range(ndim)                if strides[j] > 0)      return 0 <= offset+imin and offset+imax+itemsize <= memlen


File: python.info,  Node: PIL-style shape strides and suboffsets,  Prev: NumPy-style shape and strides,  Up: Complex arrays

7.7.6.10 PIL-style: shape, strides and suboffsets
.................................................

In addition to the regular items, PIL-style arrays can contain pointers
that must be followed in order to get to the next element in a
dimension.  For example, the regular three-dimensional C-array ‘char
v[2][2][3]’ can also be viewed as an array of 2 pointers to 2
two-dimensional arrays: ‘char (*v[2])[2][3]’.  In suboffsets
representation, those two pointers can be embedded at the start of *note
buf: 3c62, pointing to two ‘char x[2][3]’ arrays that can be located
anywhere in memory.

Here is a function that returns a pointer to the element in an N-D array
pointed to by an N-dimensional index when there are both non-‘NULL’
strides and suboffsets:

     void *get_item_pointer(int ndim, void *buf, Py_ssize_t *strides,                        Py_ssize_t *suboffsets, Py_ssize_t *indices) {     char *pointer = (char*)buf;     int i;     for (i = 0; i < ndim; i++) {         pointer += strides[i] * indices[i];         if (suboffsets[i] >=0 ) {             pointer = *((char**)pointer) + suboffsets[i];         }     }     return (void*)pointer; }


File: python.info,  Node: Buffer-related functions,  Prev: Complex arrays,  Up: Buffer Protocol

7.7.6.11 Buffer-related functions
.................................

 -- C Function: int PyObject_CheckBuffer (PyObject *obj)

     Return ‘1’ if `obj' supports the buffer interface otherwise ‘0’.
     When ‘1’ is returned, it doesn’t guarantee that *note
     PyObject_GetBuffer(): d18. will succeed.  This function always
     succeeds.

 -- C Function: int PyObject_GetBuffer (PyObject *exporter,
          Py_buffer *view, int flags)

     Send a request to `exporter' to fill in `view' as specified by
     `flags'.  If the exporter cannot provide a buffer of the exact
     type, it MUST raise ‘PyExc_BufferError’, set ‘view->obj’ to ‘NULL’
     and return ‘-1’.

     On success, fill in `view', set ‘view->obj’ to a new reference to
     `exporter' and return 0.  In the case of chained buffer providers
     that redirect requests to a single object, ‘view->obj’ MAY refer to
     this object instead of `exporter' (See *note Buffer Object
     Structures: 3c5e.).

     Successful calls to *note PyObject_GetBuffer(): d18. must be paired
     with calls to *note PyBuffer_Release(): d47, similar to ‘malloc()’
     and ‘free()’.  Thus, after the consumer is done with the buffer,
     *note PyBuffer_Release(): d47. must be called exactly once.

 -- C Function: void PyBuffer_Release (Py_buffer *view)

     Release the buffer `view' and decrement the reference count for
     ‘view->obj’.  This function MUST be called when the buffer is no
     longer being used, otherwise reference leaks may occur.

     It is an error to call this function on a buffer that was not
     obtained via *note PyObject_GetBuffer(): d18.

 -- C Function: Py_ssize_t PyBuffer_SizeFromFormat (const char *)

     Return the implied *note itemsize: 3c6b. from *note format: 3c6c.
     This function is not yet implemented.

 -- C Function: int PyBuffer_IsContiguous (Py_buffer *view, char order)

     Return ‘1’ if the memory defined by the `view' is C-style (`order'
     is ‘'C'’) or Fortran-style (`order' is ‘'F'’) *note contiguous:
     15f1. or either one (`order' is ‘'A'’).  Return ‘0’ otherwise.
     This function always succeeds.

 -- C Function: void* PyBuffer_GetPointer (Py_buffer *view,
          Py_ssize_t *indices)

     Get the memory area pointed to by the `indices' inside the given
     `view'.  `indices' must point to an array of ‘view->ndim’ indices.

 -- C Function: int PyBuffer_FromContiguous (Py_buffer *view, void *buf,
          Py_ssize_t len, char fort)

     Copy contiguous `len' bytes from `buf' to `view'.  `fort' can be
     ‘'C'’ or ‘'F'’ (for C-style or Fortran-style ordering).  ‘0’ is
     returned on success, ‘-1’ on error.

 -- C Function: int PyBuffer_ToContiguous (void *buf, Py_buffer *src,
          Py_ssize_t len, char order)

     Copy `len' bytes from `src' to its contiguous representation in
     `buf'.  `order' can be ‘'C'’ or ‘'F'’ or ‘'A'’ (for C-style or
     Fortran-style ordering or either one).  ‘0’ is returned on success,
     ‘-1’ on error.

     This function fails if `len' != `src->len'.

 -- C Function: void PyBuffer_FillContiguousStrides (int ndims,
          Py_ssize_t *shape, Py_ssize_t *strides, int itemsize,
          char order)

     Fill the `strides' array with byte-strides of a *note contiguous:
     15f1. (C-style if `order' is ‘'C'’ or Fortran-style if `order' is
     ‘'F'’) array of the given shape with the given number of bytes per
     element.

 -- C Function: int PyBuffer_FillInfo (Py_buffer *view,
          PyObject *exporter, void *buf, Py_ssize_t len, int readonly,
          int flags)

     Handle buffer requests for an exporter that wants to expose `buf'
     of size `len' with writability set according to `readonly'.  `buf'
     is interpreted as a sequence of unsigned bytes.

     The `flags' argument indicates the request type.  This function
     always fills in `view' as specified by flags, unless `buf' has been
     designated as read-only and *note PyBUF_WRITABLE: 3c69. is set in
     `flags'.

     On success, set ‘view->obj’ to a new reference to `exporter' and
     return 0.  Otherwise, raise ‘PyExc_BufferError’, set ‘view->obj’ to
     ‘NULL’ and return ‘-1’;

     If this function is used as part of a *note getbufferproc: 3c5e,
     `exporter' MUST be set to the exporting object and `flags' must be
     passed unmodified.  Otherwise, `exporter' MUST be ‘NULL’.


File: python.info,  Node: Old Buffer Protocol,  Prev: Buffer Protocol,  Up: Abstract Objects Layer

7.7.7 Old Buffer Protocol
-------------------------

Deprecated since version 3.0.

These functions were part of the “old buffer protocol” API in Python 2.
In Python 3, this protocol doesn’t exist anymore but the functions are
still exposed to ease porting 2.x code.  They act as a compatibility
wrapper around the *note new buffer protocol: 1579, but they don’t give
you control over the lifetime of the resources acquired when a buffer is
exported.

Therefore, it is recommended that you call *note PyObject_GetBuffer():
d18. (or the ‘y*’ or ‘w*’ *note format codes: 2ce. with the *note
PyArg_ParseTuple(): 268. family of functions) to get a buffer view over
an object, and *note PyBuffer_Release(): d47. when the buffer view can
be released.

 -- C Function: int PyObject_AsCharBuffer (PyObject *obj, const
          char **buffer, Py_ssize_t *buffer_len)

     Returns a pointer to a read-only memory location usable as
     character-based input.  The `obj' argument must support the
     single-segment character buffer interface.  On success, returns
     ‘0’, sets `buffer' to the memory location and `buffer_len' to the
     buffer length.  Returns ‘-1’ and sets a *note TypeError: 192. on
     error.

 -- C Function: int PyObject_AsReadBuffer (PyObject *obj, const
          void **buffer, Py_ssize_t *buffer_len)

     Returns a pointer to a read-only memory location containing
     arbitrary data.  The `obj' argument must support the single-segment
     readable buffer interface.  On success, returns ‘0’, sets `buffer'
     to the memory location and `buffer_len' to the buffer length.
     Returns ‘-1’ and sets a *note TypeError: 192. on error.

 -- C Function: int PyObject_CheckReadBuffer (PyObject *o)

     Returns ‘1’ if `o' supports the single-segment readable buffer
     interface.  Otherwise returns ‘0’.  This function always succeeds.

     Note that this function tries to get and release a buffer, and
     exceptions which occur while calling corresponding functions will
     get suppressed.  To get error reporting use *note
     PyObject_GetBuffer(): d18. instead.

 -- C Function: int PyObject_AsWriteBuffer (PyObject *obj,
          void **buffer, Py_ssize_t *buffer_len)

     Returns a pointer to a writable memory location.  The `obj'
     argument must support the single-segment, character buffer
     interface.  On success, returns ‘0’, sets `buffer' to the memory
     location and `buffer_len' to the buffer length.  Returns ‘-1’ and
     sets a *note TypeError: 192. on error.


File: python.info,  Node: Concrete Objects Layer,  Next: Initialization Finalization and Threads,  Prev: Abstract Objects Layer,  Up: Python/C API Reference Manual

7.8 Concrete Objects Layer
==========================

The functions in this chapter are specific to certain Python object
types.  Passing them an object of the wrong type is not a good idea; if
you receive an object from a Python program and you are not sure that it
has the right type, you must perform a type check first; for example, to
check that an object is a dictionary, use *note PyDict_Check(): 3c9b.
The chapter is structured like the “family tree” of Python object types.

     Warning: While the functions described in this chapter carefully
     check the type of the objects which are passed in, many of them do
     not check for ‘NULL’ being passed instead of a valid object.
     Allowing ‘NULL’ to be passed in can cause memory access violations
     and immediate termination of the interpreter.

* Menu:

* Fundamental Objects::
* Numeric Objects::
* Sequence Objects::
* Container Objects::
* Function Objects: Function Objects<2>.
* Other Objects::


File: python.info,  Node: Fundamental Objects,  Next: Numeric Objects,  Up: Concrete Objects Layer

7.8.1 Fundamental Objects
-------------------------

This section describes Python type objects and the singleton object
‘None’.

* Menu:

* Type Objects: Type Objects<2>.
* The None Object::


File: python.info,  Node: Type Objects<2>,  Next: The None Object,  Up: Fundamental Objects

7.8.1.1 Type Objects
....................

 -- C Type: PyTypeObject

     The C structure of the objects used to describe built-in types.

 -- C Variable: PyObject* PyType_Type

     This is the type object for type objects; it is the same object as
     *note type: 5fd. in the Python layer.

 -- C Function: int PyType_Check (PyObject *o)

     Return true if the object `o' is a type object, including instances
     of types derived from the standard type object.  Return false in
     all other cases.

 -- C Function: int PyType_CheckExact (PyObject *o)

     Return true if the object `o' is a type object, but not a subtype
     of the standard type object.  Return false in all other cases.

 -- C Function: unsigned int PyType_ClearCache ()

     Clear the internal lookup cache.  Return the current version tag.

 -- C Function: unsigned long PyType_GetFlags (PyTypeObject* type)

     Return the *note tp_flags: 3ca6. member of `type'.  This function
     is primarily meant for use with ‘Py_LIMITED_API’; the individual
     flag bits are guaranteed to be stable across Python releases, but
     access to *note tp_flags: 3ca6. itself is not part of the limited
     API.

     New in version 3.2.

     Changed in version 3.4: The return type is now ‘unsigned long’
     rather than ‘long’.

 -- C Function: void PyType_Modified (PyTypeObject *type)

     Invalidate the internal lookup cache for the type and all of its
     subtypes.  This function must be called after any manual
     modification of the attributes or base classes of the type.

 -- C Function: int PyType_HasFeature (PyTypeObject *o, int feature)

     Return true if the type object `o' sets the feature `feature'.
     Type features are denoted by single bit flags.

 -- C Function: int PyType_IS_GC (PyTypeObject *o)

     Return true if the type object includes support for the cycle
     detector; this tests the type flag *note Py_TPFLAGS_HAVE_GC: 3a92.

 -- C Function: int PyType_IsSubtype (PyTypeObject *a, PyTypeObject *b)

     Return true if `a' is a subtype of `b'.

     This function only checks for actual subtypes, which means that
     *note __subclasscheck__(): 138d. is not called on `b'.  Call *note
     PyObject_IsSubclass(): 792. to do the same check that *note
     issubclass(): 445. would do.

 -- C Function: PyObject* PyType_GenericAlloc (PyTypeObject *type,
          Py_ssize_t nitems)
     `Return value: New reference.'  Generic handler for the *note
     tp_alloc: 3a85. slot of a type object.  Use Python’s default memory
     allocation mechanism to allocate a new instance and initialize all
     its contents to ‘NULL’.

 -- C Function: PyObject* PyType_GenericNew (PyTypeObject *type,
          PyObject *args, PyObject *kwds)
     `Return value: New reference.'  Generic handler for the *note
     tp_new: 3a80. slot of a type object.  Create a new instance using
     the type’s *note tp_alloc: 3a85. slot.

 -- C Function: int PyType_Ready (PyTypeObject *type)

     Finalize a type object.  This should be called on all type objects
     to finish their initialization.  This function is responsible for
     adding inherited slots from a type’s base class.  Return ‘0’ on
     success, or return ‘-1’ and sets an exception on error.

 -- C Function: void* PyType_GetSlot (PyTypeObject *type, int slot)

     Return the function pointer stored in the given slot.  If the
     result is ‘NULL’, this indicates that either the slot is ‘NULL’, or
     that the function was called with invalid parameters.  Callers will
     typically cast the result pointer into the appropriate function
     type.

     See ‘PyType_Slot.slot’ for possible values of the `slot' argument.

     An exception is raised if `type' is not a heap type.

     New in version 3.4.

* Menu:

* Creating Heap-Allocated Types::


File: python.info,  Node: Creating Heap-Allocated Types,  Up: Type Objects<2>

7.8.1.2 Creating Heap-Allocated Types
.....................................

The following functions and structs are used to create *note heap types:
3cac.

 -- C Function: PyObject* PyType_FromSpecWithBases (PyType_Spec *spec,
          PyObject *bases)
     `Return value: New reference.'  Creates and returns a heap type
     object from the `spec' (*note Py_TPFLAGS_HEAPTYPE: 3cae.).

     If `bases' is a tuple, the created heap type contains all types
     contained in it as base types.

     If `bases' is ‘NULL’, the `Py_tp_base' slot is used instead.  If
     that also is ‘NULL’, the new type derives from *note object: 2ae.

     This function calls *note PyType_Ready(): 3a86. on the new type.

     New in version 3.3.

 -- C Function: PyObject* PyType_FromSpec (PyType_Spec *spec)
     `Return value: New reference.'  Equivalent to
     ‘PyType_FromSpecWithBases(spec, NULL)’.

 -- C Type: PyType_Spec

     Structure defining a type’s behavior.

      -- C Member: const char* PyType_Spec.name

          Name of the type, used to set *note PyTypeObject.tp_name:
          3a9f.

      -- C Member: int PyType_Spec.basicsize

      -- C Member: int PyType_Spec.itemsize

          Size of the instance in bytes, used to set *note
          PyTypeObject.tp_basicsize: 3a7d. and *note
          PyTypeObject.tp_itemsize: 3a7c.

      -- C Member: int PyType_Spec.flags

          Type flags, used to set *note PyTypeObject.tp_flags: 3ca6.

          If the ‘Py_TPFLAGS_HEAPTYPE’ flag is not set, *note
          PyType_FromSpecWithBases(): 3cad. sets it automatically.

      -- C Member: PyType_Slot *PyType_Spec.slots

          Array of *note PyType_Slot: 3cb5. structures.  Terminated by
          the special slot value ‘{0, NULL}’.

 -- C Type: PyType_Slot

     Structure defining optional functionality of a type, containing a
     slot ID and a value pointer.

      -- C Member: int PyType_Slot.slot

          A slot ID.

          Slot IDs are named like the field names of the structures
          *note PyTypeObject: 2d4, *note PyNumberMethods: d74, *note
          PySequenceMethods: 3aae, *note PyMappingMethods: 3aaf. and
          *note PyAsyncMethods: 3cb7. with an added ‘Py_’ prefix.  For
          example, use:

             * ‘Py_tp_dealloc’ to set *note PyTypeObject.tp_dealloc:
               3a83.

             * ‘Py_nb_add’ to set *note PyNumberMethods.nb_add: 3cb8.

             * ‘Py_sq_length’ to set *note PySequenceMethods.sq_length:
               3cb9.

          The following fields cannot be set using *note PyType_Spec:
          3caf. and *note PyType_Slot: 3cb5.:

             * *note tp_dict: 3cba.

             * *note tp_mro: 3cbb.

             * *note tp_cache: 3cbc.

             * *note tp_subclasses: 3cbd.

             * *note tp_weaklist: 3cbe.

             * ‘tp_print’

             * *note tp_weaklistoffset: 3ab3.

             * *note tp_dictoffset: 3cbf.

             * *note bf_getbuffer: 3cc0.

             * *note bf_releasebuffer: 3bc0.

          Setting ‘Py_tp_bases’ may be problematic on some platforms.
          To avoid issues, use the `bases' argument of
          ‘PyType_FromSpecWithBases()’ instead.

      -- C Member: void *PyType_Slot.pfunc

          The desired value of the slot.  In most cases, this is a
          pointer to a function.

          May not be ‘NULL’.


File: python.info,  Node: The None Object,  Prev: Type Objects<2>,  Up: Fundamental Objects

7.8.1.3 The ‘None’ Object
.........................

Note that the *note PyTypeObject: 2d4. for ‘None’ is not directly
exposed in the Python/C API. Since ‘None’ is a singleton, testing for
object identity (using ‘==’ in C) is sufficient.  There is no
‘PyNone_Check()’ function for the same reason.

 -- C Variable: PyObject* Py_None

     The Python ‘None’ object, denoting lack of value.  This object has
     no methods.  It needs to be treated just like any other object with
     respect to reference counts.

 -- C Macro: Py_RETURN_NONE

     Properly handle returning *note Py_None: 3a48. from within a C
     function (that is, increment the reference count of ‘None’ and
     return it.)


File: python.info,  Node: Numeric Objects,  Next: Sequence Objects,  Prev: Fundamental Objects,  Up: Concrete Objects Layer

7.8.2 Numeric Objects
---------------------

* Menu:

* Integer Objects::
* Boolean Objects::
* Floating Point Objects::
* Complex Number Objects::


File: python.info,  Node: Integer Objects,  Next: Boolean Objects,  Up: Numeric Objects

7.8.2.1 Integer Objects
.......................

All integers are implemented as “long” integer objects of arbitrary
size.

On error, most ‘PyLong_As*’ APIs return ‘(return type)-1’ which cannot
be distinguished from a number.  Use *note PyErr_Occurred(): 3a43. to
disambiguate.

 -- C Type: PyLongObject

     This subtype of *note PyObject: 4b0. represents a Python integer
     object.

 -- C Variable: PyTypeObject PyLong_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     integer type.  This is the same object as *note int: 184. in the
     Python layer.

 -- C Function: int PyLong_Check (PyObject *p)

     Return true if its argument is a *note PyLongObject: 3cca. or a
     subtype of *note PyLongObject: 3cca.

 -- C Function: int PyLong_CheckExact (PyObject *p)

     Return true if its argument is a *note PyLongObject: 3cca, but not
     a subtype of *note PyLongObject: 3cca.

 -- C Function: PyObject* PyLong_FromLong (long v)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. object from `v', or ‘NULL’ on failure.

     The current implementation keeps an array of integer objects for
     all integers between ‘-5’ and ‘256’, when you create an int in that
     range you actually just get back a reference to the existing
     object.  So it should be possible to change the value of ‘1’.  I
     suspect the behaviour of Python in this case is undefined.  :-)

 -- C Function: PyObject* PyLong_FromUnsignedLong (unsigned long v)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. object from a C ‘unsigned long’, or ‘NULL’ on failure.

 -- C Function: PyObject* PyLong_FromSsize_t (Py_ssize_t v)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. object from a C ‘Py_ssize_t’, or ‘NULL’ on failure.

 -- C Function: PyObject* PyLong_FromSize_t (size_t v)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. object from a C ‘size_t’, or ‘NULL’ on failure.

 -- C Function: PyObject* PyLong_FromLongLong (long long v)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. object from a C ‘long long’, or ‘NULL’ on failure.

 -- C Function: PyObject* PyLong_FromUnsignedLongLong (unsigned long
          long v)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. object from a C ‘unsigned long long’, or ‘NULL’ on failure.

 -- C Function: PyObject* PyLong_FromDouble (double v)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. object from the integer part of `v', or ‘NULL’ on failure.

 -- C Function: PyObject* PyLong_FromString (const char *str,
          char **pend, int base)
     `Return value: New reference.'  Return a new *note PyLongObject:
     3cca. based on the string value in `str', which is interpreted
     according to the radix in `base'.  If `pend' is non-‘NULL’, `*pend'
     will point to the first character in `str' which follows the
     representation of the number.  If `base' is ‘0’, `str' is
     interpreted using the *note Integer literals: 133b. definition; in
     this case, leading zeros in a non-zero decimal number raises a
     *note ValueError: 1f9.  If `base' is not ‘0’, it must be between
     ‘2’ and ‘36’, inclusive.  Leading spaces and single underscores
     after a base specifier and between digits are ignored.  If there
     are no digits, *note ValueError: 1f9. will be raised.

 -- C Function: PyObject* PyLong_FromUnicode (Py_UNICODE *u,
          Py_ssize_t length, int base)
     `Return value: New reference.'  Convert a sequence of Unicode
     digits to a Python integer value.  The Unicode string is first
     encoded to a byte string using ‘PyUnicode_EncodeDecimal()’ and then
     converted using *note PyLong_FromString(): 3cd4.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyLong_FromUnicodeObject(): 3cd6.

 -- C Function: PyObject* PyLong_FromUnicodeObject (PyObject *u,
          int base)
     `Return value: New reference.'  Convert a sequence of Unicode
     digits in the string `u' to a Python integer value.  The Unicode
     string is first encoded to a byte string using
     ‘PyUnicode_EncodeDecimal()’ and then converted using *note
     PyLong_FromString(): 3cd4.

     New in version 3.3.

 -- C Function: PyObject* PyLong_FromVoidPtr (void *p)
     `Return value: New reference.'  Create a Python integer from the
     pointer `p'.  The pointer value can be retrieved from the resulting
     value using *note PyLong_AsVoidPtr(): 3cd8.

 -- C Function: long PyLong_AsLong (PyObject *obj)

     Return a C ‘long’ representation of `obj'.  If `obj' is not an
     instance of *note PyLongObject: 3cca, first call its *note
     __index__(): 18a. or *note __int__(): 18b. method (if present) to
     convert it to a *note PyLongObject: 3cca.

     Raise *note OverflowError: 954. if the value of `obj' is out of
     range for a ‘long’.

     Returns ‘-1’ on error.  Use *note PyErr_Occurred(): 3a43. to
     disambiguate.

     Changed in version 3.8: Use *note __index__(): 18a. if available.

     Deprecated since version 3.8: Using *note __int__(): 18b. is
     deprecated.

 -- C Function: long PyLong_AsLongAndOverflow (PyObject *obj,
          int *overflow)

     Return a C ‘long’ representation of `obj'.  If `obj' is not an
     instance of *note PyLongObject: 3cca, first call its *note
     __index__(): 18a. or *note __int__(): 18b. method (if present) to
     convert it to a *note PyLongObject: 3cca.

     If the value of `obj' is greater than ‘LONG_MAX’ or less than
     ‘LONG_MIN’, set `*overflow' to ‘1’ or ‘-1’, respectively, and
     return ‘-1’; otherwise, set `*overflow' to ‘0’.  If any other
     exception occurs set `*overflow' to ‘0’ and return ‘-1’ as usual.

     Returns ‘-1’ on error.  Use *note PyErr_Occurred(): 3a43. to
     disambiguate.

     Changed in version 3.8: Use *note __index__(): 18a. if available.

     Deprecated since version 3.8: Using *note __int__(): 18b. is
     deprecated.

 -- C Function: long long PyLong_AsLongLong (PyObject *obj)

     Return a C ‘long long’ representation of `obj'.  If `obj' is not an
     instance of *note PyLongObject: 3cca, first call its *note
     __index__(): 18a. or *note __int__(): 18b. method (if present) to
     convert it to a *note PyLongObject: 3cca.

     Raise *note OverflowError: 954. if the value of `obj' is out of
     range for a ‘long’.

     Returns ‘-1’ on error.  Use *note PyErr_Occurred(): 3a43. to
     disambiguate.

     Changed in version 3.8: Use *note __index__(): 18a. if available.

     Deprecated since version 3.8: Using *note __int__(): 18b. is
     deprecated.

 -- C Function: long long PyLong_AsLongLongAndOverflow (PyObject *obj,
          int *overflow)

     Return a C ‘long long’ representation of `obj'.  If `obj' is not an
     instance of *note PyLongObject: 3cca, first call its *note
     __index__(): 18a. or *note __int__(): 18b. method (if present) to
     convert it to a *note PyLongObject: 3cca.

     If the value of `obj' is greater than ‘PY_LLONG_MAX’ or less than
     ‘PY_LLONG_MIN’, set `*overflow' to ‘1’ or ‘-1’, respectively, and
     return ‘-1’; otherwise, set `*overflow' to ‘0’.  If any other
     exception occurs set `*overflow' to ‘0’ and return ‘-1’ as usual.

     Returns ‘-1’ on error.  Use *note PyErr_Occurred(): 3a43. to
     disambiguate.

     New in version 3.2.

     Changed in version 3.8: Use *note __index__(): 18a. if available.

     Deprecated since version 3.8: Using *note __int__(): 18b. is
     deprecated.

 -- C Function: Py_ssize_t PyLong_AsSsize_t (PyObject *pylong)

     Return a C ‘Py_ssize_t’ representation of `pylong'.  `pylong' must
     be an instance of *note PyLongObject: 3cca.

     Raise *note OverflowError: 954. if the value of `pylong' is out of
     range for a ‘Py_ssize_t’.

     Returns ‘-1’ on error.  Use *note PyErr_Occurred(): 3a43. to
     disambiguate.

 -- C Function: unsigned long PyLong_AsUnsignedLong (PyObject *pylong)

     Return a C ‘unsigned long’ representation of `pylong'.  `pylong'
     must be an instance of *note PyLongObject: 3cca.

     Raise *note OverflowError: 954. if the value of `pylong' is out of
     range for a ‘unsigned long’.

     Returns ‘(unsigned long)-1’ on error.  Use *note PyErr_Occurred():
     3a43. to disambiguate.

 -- C Function: size_t PyLong_AsSize_t (PyObject *pylong)

     Return a C ‘size_t’ representation of `pylong'.  `pylong' must be
     an instance of *note PyLongObject: 3cca.

     Raise *note OverflowError: 954. if the value of `pylong' is out of
     range for a ‘size_t’.

     Returns ‘(size_t)-1’ on error.  Use *note PyErr_Occurred(): 3a43.
     to disambiguate.

 -- C Function: unsigned long long PyLong_AsUnsignedLongLong
          (PyObject *pylong)

     Return a C ‘unsigned long long’ representation of `pylong'.
     `pylong' must be an instance of *note PyLongObject: 3cca.

     Raise *note OverflowError: 954. if the value of `pylong' is out of
     range for an ‘unsigned long long’.

     Returns ‘(unsigned long long)-1’ on error.  Use *note
     PyErr_Occurred(): 3a43. to disambiguate.

     Changed in version 3.1: A negative `pylong' now raises *note
     OverflowError: 954, not *note TypeError: 192.

 -- C Function: unsigned long PyLong_AsUnsignedLongMask (PyObject *obj)

     Return a C ‘unsigned long’ representation of `obj'.  If `obj' is
     not an instance of *note PyLongObject: 3cca, first call its *note
     __index__(): 18a. or *note __int__(): 18b. method (if present) to
     convert it to a *note PyLongObject: 3cca.

     If the value of `obj' is out of range for an ‘unsigned long’,
     return the reduction of that value modulo ‘ULONG_MAX + 1’.

     Returns ‘(unsigned long)-1’ on error.  Use *note PyErr_Occurred():
     3a43. to disambiguate.

     Changed in version 3.8: Use *note __index__(): 18a. if available.

     Deprecated since version 3.8: Using *note __int__(): 18b. is
     deprecated.

 -- C Function: unsigned long long PyLong_AsUnsignedLongLongMask
          (PyObject *obj)

     Return a C ‘unsigned long long’ representation of `obj'.  If `obj'
     is not an instance of *note PyLongObject: 3cca, first call its
     *note __index__(): 18a. or *note __int__(): 18b. method (if
     present) to convert it to a *note PyLongObject: 3cca.

     If the value of `obj' is out of range for an ‘unsigned long long’,
     return the reduction of that value modulo ‘PY_ULLONG_MAX + 1’.

     Returns ‘(unsigned long long)-1’ on error.  Use *note
     PyErr_Occurred(): 3a43. to disambiguate.

     Changed in version 3.8: Use *note __index__(): 18a. if available.

     Deprecated since version 3.8: Using *note __int__(): 18b. is
     deprecated.

 -- C Function: double PyLong_AsDouble (PyObject *pylong)

     Return a C ‘double’ representation of `pylong'.  `pylong' must be
     an instance of *note PyLongObject: 3cca.

     Raise *note OverflowError: 954. if the value of `pylong' is out of
     range for a ‘double’.

     Returns ‘-1.0’ on error.  Use *note PyErr_Occurred(): 3a43. to
     disambiguate.

 -- C Function: void* PyLong_AsVoidPtr (PyObject *pylong)

     Convert a Python integer `pylong' to a C ‘void’ pointer.  If
     `pylong' cannot be converted, an *note OverflowError: 954. will be
     raised.  This is only assured to produce a usable ‘void’ pointer
     for values created with *note PyLong_FromVoidPtr(): 3cd7.

     Returns ‘NULL’ on error.  Use *note PyErr_Occurred(): 3a43. to
     disambiguate.


File: python.info,  Node: Boolean Objects,  Next: Floating Point Objects,  Prev: Integer Objects,  Up: Numeric Objects

7.8.2.2 Boolean Objects
.......................

Booleans in Python are implemented as a subclass of integers.  There are
only two booleans, ‘Py_False’ and ‘Py_True’.  As such, the normal
creation and deletion functions don’t apply to booleans.  The following
macros are available, however.

 -- C Function: int PyBool_Check (PyObject *o)

     Return true if `o' is of type ‘PyBool_Type’.

 -- C Variable: PyObject* Py_False

     The Python ‘False’ object.  This object has no methods.  It needs
     to be treated just like any other object with respect to reference
     counts.

 -- C Variable: PyObject* Py_True

     The Python ‘True’ object.  This object has no methods.  It needs to
     be treated just like any other object with respect to reference
     counts.

 -- C Macro: Py_RETURN_FALSE

     Return ‘Py_False’ from a function, properly incrementing its
     reference count.

 -- C Macro: Py_RETURN_TRUE

     Return ‘Py_True’ from a function, properly incrementing its
     reference count.

 -- C Function: PyObject* PyBool_FromLong (long v)
     `Return value: New reference.'  Return a new reference to ‘Py_True’
     or ‘Py_False’ depending on the truth value of `v'.


File: python.info,  Node: Floating Point Objects,  Next: Complex Number Objects,  Prev: Boolean Objects,  Up: Numeric Objects

7.8.2.3 Floating Point Objects
..............................

 -- C Type: PyFloatObject

     This subtype of *note PyObject: 4b0. represents a Python floating
     point object.

 -- C Variable: PyTypeObject PyFloat_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     floating point type.  This is the same object as *note float: 187.
     in the Python layer.

 -- C Function: int PyFloat_Check (PyObject *p)

     Return true if its argument is a *note PyFloatObject: 3ce9. or a
     subtype of *note PyFloatObject: 3ce9.

 -- C Function: int PyFloat_CheckExact (PyObject *p)

     Return true if its argument is a *note PyFloatObject: 3ce9, but not
     a subtype of *note PyFloatObject: 3ce9.

 -- C Function: PyObject* PyFloat_FromString (PyObject *str)
     `Return value: New reference.'  Create a *note PyFloatObject: 3ce9.
     object based on the string value in `str', or ‘NULL’ on failure.

 -- C Function: PyObject* PyFloat_FromDouble (double v)
     `Return value: New reference.'  Create a *note PyFloatObject: 3ce9.
     object from `v', or ‘NULL’ on failure.

 -- C Function: double PyFloat_AsDouble (PyObject *pyfloat)

     Return a C ‘double’ representation of the contents of `pyfloat'.
     If `pyfloat' is not a Python floating point object but has a *note
     __float__(): 18c. method, this method will first be called to
     convert `pyfloat' into a float.  If ‘__float__()’ is not defined
     then it falls back to *note __index__(): 18a.  This method returns
     ‘-1.0’ upon failure, so one should call *note PyErr_Occurred():
     3a43. to check for errors.

     Changed in version 3.8: Use *note __index__(): 18a. if available.

 -- C Function: double PyFloat_AS_DOUBLE (PyObject *pyfloat)

     Return a C ‘double’ representation of the contents of `pyfloat',
     but without error checking.

 -- C Function: PyObject* PyFloat_GetInfo (void)
     `Return value: New reference.'  Return a structseq instance which
     contains information about the precision, minimum and maximum
     values of a float.  It’s a thin wrapper around the header file
     ‘float.h’.

 -- C Function: double PyFloat_GetMax ()

     Return the maximum representable finite float `DBL_MAX' as C
     ‘double’.

 -- C Function: double PyFloat_GetMin ()

     Return the minimum normalized positive float `DBL_MIN' as C
     ‘double’.

 -- C Function: int PyFloat_ClearFreeList ()

     Clear the float free list.  Return the number of items that could
     not be freed.


File: python.info,  Node: Complex Number Objects,  Prev: Floating Point Objects,  Up: Numeric Objects

7.8.2.4 Complex Number Objects
..............................

Python’s complex number objects are implemented as two distinct types
when viewed from the C API: one is the Python object exposed to Python
programs, and the other is a C structure which represents the actual
complex number value.  The API provides functions for working with both.

* Menu:

* Complex Numbers as C Structures::
* Complex Numbers as Python Objects::


File: python.info,  Node: Complex Numbers as C Structures,  Next: Complex Numbers as Python Objects,  Up: Complex Number Objects

7.8.2.5 Complex Numbers as C Structures
.......................................

Note that the functions which accept these structures as parameters and
return them as results do so `by value' rather than dereferencing them
through pointers.  This is consistent throughout the API.

 -- C Type: Py_complex

     The C structure which corresponds to the value portion of a Python
     complex number object.  Most of the functions for dealing with
     complex number objects use structures of this type as input or
     output values, as appropriate.  It is defined as:

          typedef struct {    double real;    double imag; } Py_complex;

 -- C Function: Py_complex _Py_c_sum (Py_complex left, Py_complex right)

     Return the sum of two complex numbers, using the C *note
     Py_complex: 3bc2. representation.

 -- C Function: Py_complex _Py_c_diff (Py_complex left,
          Py_complex right)

     Return the difference between two complex numbers, using the C
     *note Py_complex: 3bc2. representation.

 -- C Function: Py_complex _Py_c_neg (Py_complex complex)

     Return the negation of the complex number `complex', using the C
     *note Py_complex: 3bc2. representation.

 -- C Function: Py_complex _Py_c_prod (Py_complex left,
          Py_complex right)

     Return the product of two complex numbers, using the C *note
     Py_complex: 3bc2. representation.

 -- C Function: Py_complex _Py_c_quot (Py_complex dividend,
          Py_complex divisor)

     Return the quotient of two complex numbers, using the C *note
     Py_complex: 3bc2. representation.

     If `divisor' is null, this method returns zero and sets ‘errno’ to
     ‘EDOM’.

 -- C Function: Py_complex _Py_c_pow (Py_complex num, Py_complex exp)

     Return the exponentiation of `num' by `exp', using the C *note
     Py_complex: 3bc2. representation.

     If `num' is null and `exp' is not a positive real number, this
     method returns zero and sets ‘errno’ to ‘EDOM’.


File: python.info,  Node: Complex Numbers as Python Objects,  Prev: Complex Numbers as C Structures,  Up: Complex Number Objects

7.8.2.6 Complex Numbers as Python Objects
.........................................

 -- C Type: PyComplexObject

     This subtype of *note PyObject: 4b0. represents a Python complex
     number object.

 -- C Variable: PyTypeObject PyComplex_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     complex number type.  It is the same object as *note complex: 189.
     in the Python layer.

 -- C Function: int PyComplex_Check (PyObject *p)

     Return true if its argument is a *note PyComplexObject: 3cfc. or a
     subtype of *note PyComplexObject: 3cfc.

 -- C Function: int PyComplex_CheckExact (PyObject *p)

     Return true if its argument is a *note PyComplexObject: 3cfc, but
     not a subtype of *note PyComplexObject: 3cfc.

 -- C Function: PyObject* PyComplex_FromCComplex (Py_complex v)
     `Return value: New reference.'  Create a new Python complex number
     object from a C *note Py_complex: 3bc2. value.

 -- C Function: PyObject* PyComplex_FromDoubles (double real,
          double imag)
     `Return value: New reference.'  Return a new *note PyComplexObject:
     3cfc. object from `real' and `imag'.

 -- C Function: double PyComplex_RealAsDouble (PyObject *op)

     Return the real part of `op' as a C ‘double’.

 -- C Function: double PyComplex_ImagAsDouble (PyObject *op)

     Return the imaginary part of `op' as a C ‘double’.

 -- C Function: Py_complex PyComplex_AsCComplex (PyObject *op)

     Return the *note Py_complex: 3bc2. value of the complex number
     `op'.

     If `op' is not a Python complex number object but has a *note
     __complex__(): 18d. method, this method will first be called to
     convert `op' to a Python complex number object.  If ‘__complex__()’
     is not defined then it falls back to *note __float__(): 18c.  If
     ‘__float__()’ is not defined then it falls back to *note
     __index__(): 18a.  Upon failure, this method returns ‘-1.0’ as a
     real value.

     Changed in version 3.8: Use *note __index__(): 18a. if available.


File: python.info,  Node: Sequence Objects,  Next: Container Objects,  Prev: Numeric Objects,  Up: Concrete Objects Layer

7.8.3 Sequence Objects
----------------------

Generic operations on sequence objects were discussed in the previous
chapter; this section deals with the specific kinds of sequence objects
that are intrinsic to the Python language.

* Menu:

* Bytes Objects: Bytes Objects<2>.
* Byte Array Objects::
* Unicode Objects and Codecs::
* Tuple Objects::
* Struct Sequence Objects::
* List Objects::


File: python.info,  Node: Bytes Objects<2>,  Next: Byte Array Objects,  Up: Sequence Objects

7.8.3.1 Bytes Objects
.....................

These functions raise *note TypeError: 192. when expecting a bytes
parameter and are called with a non-bytes parameter.

 -- C Type: PyBytesObject

     This subtype of *note PyObject: 4b0. represents a Python bytes
     object.

 -- C Variable: PyTypeObject PyBytes_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     bytes type; it is the same object as *note bytes: 326. in the
     Python layer.

 -- C Function: int PyBytes_Check (PyObject *o)

     Return true if the object `o' is a bytes object or an instance of a
     subtype of the bytes type.

 -- C Function: int PyBytes_CheckExact (PyObject *o)

     Return true if the object `o' is a bytes object, but not an
     instance of a subtype of the bytes type.

 -- C Function: PyObject* PyBytes_FromString (const char *v)
     `Return value: New reference.'  Return a new bytes object with a
     copy of the string `v' as value on success, and ‘NULL’ on failure.
     The parameter `v' must not be ‘NULL’; it will not be checked.

 -- C Function: PyObject* PyBytes_FromStringAndSize (const char *v,
          Py_ssize_t len)
     `Return value: New reference.'  Return a new bytes object with a
     copy of the string `v' as value and length `len' on success, and
     ‘NULL’ on failure.  If `v' is ‘NULL’, the contents of the bytes
     object are uninitialized.

 -- C Function: PyObject* PyBytes_FromFormat (const char *format, ...)
     `Return value: New reference.'  Take a C ‘printf()’-style `format'
     string and a variable number of arguments, calculate the size of
     the resulting Python bytes object and return a bytes object with
     the values formatted into it.  The variable arguments must be C
     types and must correspond exactly to the format characters in the
     `format' string.  The following format characters are allowed:

     Format Characters       Type                Comment
                                                 
     ---------------------------------------------------------------------------------
                                                 
     ‘%%’                    `n/a'               The literal % character.
                                                 
                                                 
     ‘%c’                    int                 A single byte, represented as a C
                                                 int.
                                                 
                                                 
     ‘%d’                    int                 Equivalent to ‘printf("%d")’.  (1)
                                                 
                                                 
     ‘%u’                    unsigned int        Equivalent to ‘printf("%u")’.  (2)
                                                 
                                                 
     ‘%ld’                   long                Equivalent to ‘printf("%ld")’.
                                                 (3)
                                                 
                                                 
     ‘%lu’                   unsigned long       Equivalent to ‘printf("%lu")’.
                                                 (4)
                                                 
                                                 
     ‘%zd’                   Py_ssize_t          Equivalent to ‘printf("%zd")’.
                                                 (5)
                                                 
                                                 
     ‘%zu’                   size_t              Equivalent to ‘printf("%zu")’.
                                                 (6)
                                                 
                                                 
     ‘%i’                    int                 Equivalent to ‘printf("%i")’.  (7)
                                                 
                                                 
     ‘%x’                    int                 Equivalent to ‘printf("%x")’.  (8)
                                                 
                                                 
     ‘%s’                    const char*         A null-terminated C character
                                                 array.
                                                 
                                                 
     ‘%p’                    const void*         The hex representation of a C
                                                 pointer.  Mostly equivalent to
                                                 ‘printf("%p")’ except that it is
                                                 guaranteed to start with the
                                                 literal ‘0x’ regardless of what
                                                 the platform’s ‘printf’ yields.
                                                 

     An unrecognized format character causes all the rest of the format
     string to be copied as-is to the result object, and any extra
     arguments discarded.

 -- C Function: PyObject* PyBytes_FromFormatV (const char *format,
          va_list vargs)
     `Return value: New reference.'  Identical to *note
     PyBytes_FromFormat(): f3f. except that it takes exactly two
     arguments.

 -- C Function: PyObject* PyBytes_FromObject (PyObject *o)
     `Return value: New reference.'  Return the bytes representation of
     object `o' that implements the buffer protocol.

 -- C Function: Py_ssize_t PyBytes_Size (PyObject *o)

     Return the length of the bytes in bytes object `o'.

 -- C Function: Py_ssize_t PyBytes_GET_SIZE (PyObject *o)

     Macro form of *note PyBytes_Size(): 3d0e. but without error
     checking.

 -- C Function: char* PyBytes_AsString (PyObject *o)

     Return a pointer to the contents of `o'.  The pointer refers to the
     internal buffer of `o', which consists of ‘len(o) + 1’ bytes.  The
     last byte in the buffer is always null, regardless of whether there
     are any other null bytes.  The data must not be modified in any
     way, unless the object was just created using
     ‘PyBytes_FromStringAndSize(NULL, size)’.  It must not be
     deallocated.  If `o' is not a bytes object at all, *note
     PyBytes_AsString(): 3d10. returns ‘NULL’ and raises *note
     TypeError: 192.

 -- C Function: char* PyBytes_AS_STRING (PyObject *string)

     Macro form of *note PyBytes_AsString(): 3d10. but without error
     checking.

 -- C Function: int PyBytes_AsStringAndSize (PyObject *obj,
          char **buffer, Py_ssize_t *length)

     Return the null-terminated contents of the object `obj' through the
     output variables `buffer' and `length'.

     If `length' is ‘NULL’, the bytes object may not contain embedded
     null bytes; if it does, the function returns ‘-1’ and a *note
     ValueError: 1f9. is raised.

     The buffer refers to an internal buffer of `obj', which includes an
     additional null byte at the end (not counted in `length').  The
     data must not be modified in any way, unless the object was just
     created using ‘PyBytes_FromStringAndSize(NULL, size)’.  It must not
     be deallocated.  If `obj' is not a bytes object at all, *note
     PyBytes_AsStringAndSize(): 3d12. returns ‘-1’ and raises *note
     TypeError: 192.

     Changed in version 3.5: Previously, *note TypeError: 192. was
     raised when embedded null bytes were encountered in the bytes
     object.

 -- C Function: void PyBytes_Concat (PyObject **bytes,
          PyObject *newpart)

     Create a new bytes object in `*bytes' containing the contents of
     `newpart' appended to `bytes'; the caller will own the new
     reference.  The reference to the old value of `bytes' will be
     stolen.  If the new object cannot be created, the old reference to
     `bytes' will still be discarded and the value of `*bytes' will be
     set to ‘NULL’; the appropriate exception will be set.

 -- C Function: void PyBytes_ConcatAndDel (PyObject **bytes,
          PyObject *newpart)

     Create a new bytes object in `*bytes' containing the contents of
     `newpart' appended to `bytes'.  This version decrements the
     reference count of `newpart'.

 -- C Function: int _PyBytes_Resize (PyObject **bytes,
          Py_ssize_t newsize)

     A way to resize a bytes object even though it is “immutable”.  Only
     use this to build up a brand new bytes object; don’t use this if
     the bytes may already be known in other parts of the code.  It is
     an error to call this function if the refcount on the input bytes
     object is not one.  Pass the address of an existing bytes object as
     an lvalue (it may be written into), and the new size desired.  On
     success, `*bytes' holds the resized bytes object and ‘0’ is
     returned; the address in `*bytes' may differ from its input value.
     If the reallocation fails, the original bytes object at `*bytes' is
     deallocated, `*bytes' is set to ‘NULL’, *note MemoryError: f42. is
     set, and ‘-1’ is returned.

   ---------- Footnotes ----------

   (1) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.

   (2) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.

   (3) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.

   (4) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.

   (5) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.

   (6) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.

   (7) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.

   (8) (1) For integer specifiers (d, u, ld, lu, zd, zu, i, x): the
0-conversion flag has effect even when a precision is given.


File: python.info,  Node: Byte Array Objects,  Next: Unicode Objects and Codecs,  Prev: Bytes Objects<2>,  Up: Sequence Objects

7.8.3.2 Byte Array Objects
..........................

 -- C Type: PyByteArrayObject

     This subtype of *note PyObject: 4b0. represents a Python bytearray
     object.

 -- C Variable: PyTypeObject PyByteArray_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     bytearray type; it is the same object as *note bytearray: 327. in
     the Python layer.

* Menu:

* Type check macros::
* Direct API functions::
* Macros::


File: python.info,  Node: Type check macros,  Next: Direct API functions,  Up: Byte Array Objects

7.8.3.3 Type check macros
.........................

 -- C Function: int PyByteArray_Check (PyObject *o)

     Return true if the object `o' is a bytearray object or an instance
     of a subtype of the bytearray type.

 -- C Function: int PyByteArray_CheckExact (PyObject *o)

     Return true if the object `o' is a bytearray object, but not an
     instance of a subtype of the bytearray type.


File: python.info,  Node: Direct API functions,  Next: Macros,  Prev: Type check macros,  Up: Byte Array Objects

7.8.3.4 Direct API functions
............................

 -- C Function: PyObject* PyByteArray_FromObject (PyObject *o)
     `Return value: New reference.'  Return a new bytearray object from
     any object, `o', that implements the *note buffer protocol: 1579.

 -- C Function: PyObject* PyByteArray_FromStringAndSize (const
          char *string, Py_ssize_t len)
     `Return value: New reference.'  Create a new bytearray object from
     `string' and its length, `len'.  On failure, ‘NULL’ is returned.

 -- C Function: PyObject* PyByteArray_Concat (PyObject *a, PyObject *b)
     `Return value: New reference.'  Concat bytearrays `a' and `b' and
     return a new bytearray with the result.

 -- C Function: Py_ssize_t PyByteArray_Size (PyObject *bytearray)

     Return the size of `bytearray' after checking for a ‘NULL’ pointer.

 -- C Function: char* PyByteArray_AsString (PyObject *bytearray)

     Return the contents of `bytearray' as a char array after checking
     for a ‘NULL’ pointer.  The returned array always has an extra null
     byte appended.

 -- C Function: int PyByteArray_Resize (PyObject *bytearray,
          Py_ssize_t len)

     Resize the internal buffer of `bytearray' to `len'.


File: python.info,  Node: Macros,  Prev: Direct API functions,  Up: Byte Array Objects

7.8.3.5 Macros
..............

These macros trade safety for speed and they don’t check pointers.

 -- C Function: char* PyByteArray_AS_STRING (PyObject *bytearray)

     Macro version of *note PyByteArray_AsString(): 3d20.

 -- C Function: Py_ssize_t PyByteArray_GET_SIZE (PyObject *bytearray)

     Macro version of *note PyByteArray_Size(): 3d1f.


File: python.info,  Node: Unicode Objects and Codecs,  Next: Tuple Objects,  Prev: Byte Array Objects,  Up: Sequence Objects

7.8.3.6 Unicode Objects and Codecs
..................................

* Menu:

* Unicode Objects::
* Built-in Codecs::
* Methods and Slot Functions::


File: python.info,  Node: Unicode Objects,  Next: Built-in Codecs,  Up: Unicode Objects and Codecs

7.8.3.7 Unicode Objects
.......................

Since the implementation of PEP 393(1) in Python 3.3, Unicode objects
internally use a variety of representations, in order to allow handling
the complete range of Unicode characters while staying memory efficient.
There are special cases for strings where all code points are below 128,
256, or 65536; otherwise, code points must be below 1114112 (which is
the full Unicode range).

*note Py_UNICODE*: ae3. and UTF-8 representations are created on demand
and cached in the Unicode object.  The *note Py_UNICODE*: ae3.
representation is deprecated and inefficient; it should be avoided in
performance- or memory-sensitive situations.

Due to the transition between the old APIs and the new APIs, Unicode
objects can internally be in two states depending on how they were
created:

   * “canonical” Unicode objects are all objects created by a
     non-deprecated Unicode API. They use the most efficient
     representation allowed by the implementation.

   * “legacy” Unicode objects have been created through one of the
     deprecated APIs (typically *note PyUnicode_FromUnicode(): ae4.) and
     only bear the *note Py_UNICODE*: ae3. representation; you will have
     to call *note PyUnicode_READY(): acb. on them before calling any
     other API.

* Menu:

* Unicode Type::
* Unicode Character Properties::
* Creating and accessing Unicode strings::
* Deprecated Py_UNICODE APIs::
* Locale Encoding::
* File System Encoding::
* wchar_t Support::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393


File: python.info,  Node: Unicode Type,  Next: Unicode Character Properties,  Up: Unicode Objects

7.8.3.8 Unicode Type
....................

These are the basic Unicode object types used for the Unicode
implementation in Python:

 -- C Type: Py_UCS4
 -- C Type: Py_UCS2
 -- C Type: Py_UCS1

     These types are typedefs for unsigned integer types wide enough to
     contain characters of 32 bits, 16 bits and 8 bits, respectively.
     When dealing with single Unicode characters, use *note Py_UCS4:
     ac8.

     New in version 3.3.

 -- C Type: Py_UNICODE

     This is a typedef of ‘wchar_t’, which is a 16-bit type or 32-bit
     type depending on the platform.

     Changed in version 3.3: In previous versions, this was a 16-bit
     type or a 32-bit type depending on whether you selected a “narrow”
     or “wide” Unicode version of Python at build time.

 -- C Type: PyASCIIObject
 -- C Type: PyCompactUnicodeObject
 -- C Type: PyUnicodeObject

     These subtypes of *note PyObject: 4b0. represent a Python Unicode
     object.  In almost all cases, they shouldn’t be used directly,
     since all API functions that deal with Unicode objects take and
     return *note PyObject: 4b0. pointers.

     New in version 3.3.

 -- C Variable: PyTypeObject PyUnicode_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     Unicode type.  It is exposed to Python code as ‘str’.

The following APIs are really C macros and can be used to do fast checks
and to access internal read-only data of Unicode objects:

 -- C Function: int PyUnicode_Check (PyObject *o)

     Return true if the object `o' is a Unicode object or an instance of
     a Unicode subtype.

 -- C Function: int PyUnicode_CheckExact (PyObject *o)

     Return true if the object `o' is a Unicode object, but not an
     instance of a subtype.

 -- C Function: int PyUnicode_READY (PyObject *o)

     Ensure the string object `o' is in the “canonical” representation.
     This is required before using any of the access macros described
     below.

     Returns ‘0’ on success and ‘-1’ with an exception set on failure,
     which in particular happens if memory allocation fails.

     New in version 3.3.

 -- C Function: Py_ssize_t PyUnicode_GET_LENGTH (PyObject *o)

     Return the length of the Unicode string, in code points.  `o' has
     to be a Unicode object in the “canonical” representation (not
     checked).

     New in version 3.3.

 -- C Function: Py_UCS1* PyUnicode_1BYTE_DATA (PyObject *o)
 -- C Function: Py_UCS2* PyUnicode_2BYTE_DATA (PyObject *o)
 -- C Function: Py_UCS4* PyUnicode_4BYTE_DATA (PyObject *o)

     Return a pointer to the canonical representation cast to UCS1, UCS2
     or UCS4 integer types for direct character access.  No checks are
     performed if the canonical representation has the correct character
     size; use *note PyUnicode_KIND(): ad3. to select the right macro.
     Make sure *note PyUnicode_READY(): acb. has been called before
     accessing this.

     New in version 3.3.

 -- C Macro: PyUnicode_WCHAR_KIND
 -- C Macro: PyUnicode_1BYTE_KIND
 -- C Macro: PyUnicode_2BYTE_KIND
 -- C Macro: PyUnicode_4BYTE_KIND

     Return values of the *note PyUnicode_KIND(): ad3. macro.

     New in version 3.3.

 -- C Function: int PyUnicode_KIND (PyObject *o)

     Return one of the PyUnicode kind constants (see above) that
     indicate how many bytes per character this Unicode object uses to
     store its data.  `o' has to be a Unicode object in the “canonical”
     representation (not checked).

     New in version 3.3.

 -- C Function: void* PyUnicode_DATA (PyObject *o)

     Return a void pointer to the raw Unicode buffer.  `o' has to be a
     Unicode object in the “canonical” representation (not checked).

     New in version 3.3.

 -- C Function: void PyUnicode_WRITE (int kind, void *data,
          Py_ssize_t index, Py_UCS4 value)

     Write into a canonical representation `data' (as obtained with
     *note PyUnicode_DATA(): acf.).  This macro does not do any sanity
     checks and is intended for usage in loops.  The caller should cache
     the `kind' value and `data' pointer as obtained from other macro
     calls.  `index' is the index in the string (starts at 0) and
     `value' is the new code point value which should be written to that
     location.

     New in version 3.3.

 -- C Function: Py_UCS4 PyUnicode_READ (int kind, void *data,
          Py_ssize_t index)

     Read a code point from a canonical representation `data' (as
     obtained with *note PyUnicode_DATA(): acf.).  No checks or ready
     calls are performed.

     New in version 3.3.

 -- C Function: Py_UCS4 PyUnicode_READ_CHAR (PyObject *o,
          Py_ssize_t index)

     Read a character from a Unicode object `o', which must be in the
     “canonical” representation.  This is less efficient than *note
     PyUnicode_READ(): ad8. if you do multiple consecutive reads.

     New in version 3.3.

 -- C Function: PyUnicode_MAX_CHAR_VALUE (PyObject *o)

     Return the maximum code point that is suitable for creating another
     string based on `o', which must be in the “canonical”
     representation.  This is always an approximation but more efficient
     than iterating over the string.

     New in version 3.3.

 -- C Function: int PyUnicode_ClearFreeList ()

     Clear the free list.  Return the total number of freed items.

 -- C Function: Py_ssize_t PyUnicode_GET_SIZE (PyObject *o)

     Return the size of the deprecated *note Py_UNICODE: ae3.
     representation, in code units (this includes surrogate pairs as 2
     units).  `o' has to be a Unicode object (not checked).

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style Unicode API, please migrate to using *note
     PyUnicode_GET_LENGTH(): ac1.

 -- C Function: Py_ssize_t PyUnicode_GET_DATA_SIZE (PyObject *o)

     Return the size of the deprecated *note Py_UNICODE: ae3.
     representation in bytes.  `o' has to be a Unicode object (not
     checked).

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style Unicode API, please migrate to using *note
     PyUnicode_GET_LENGTH(): ac1.

 -- C Function: Py_UNICODE* PyUnicode_AS_UNICODE (PyObject *o)
 -- C Function: const char* PyUnicode_AS_DATA (PyObject *o)

     Return a pointer to a *note Py_UNICODE: ae3. representation of the
     object.  The returned buffer is always terminated with an extra
     null code point.  It may also contain embedded null code points,
     which would cause the string to be truncated when used in most C
     functions.  The ‘AS_DATA’ form casts the pointer to ‘const char *’.
     The `o' argument has to be a Unicode object (not checked).

     Changed in version 3.3: This macro is now inefficient – because in
     many cases the *note Py_UNICODE: ae3. representation does not exist
     and needs to be created – and can fail (return ‘NULL’ with an
     exception set).  Try to port the code to use the new
     ‘PyUnicode_nBYTE_DATA()’ macros or use *note PyUnicode_WRITE():
     ada. or *note PyUnicode_READ(): ad8.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style Unicode API, please migrate to using the
     ‘PyUnicode_nBYTE_DATA()’ family of macros.


File: python.info,  Node: Unicode Character Properties,  Next: Creating and accessing Unicode strings,  Prev: Unicode Type,  Up: Unicode Objects

7.8.3.9 Unicode Character Properties
....................................

Unicode provides many different character properties.  The most often
needed ones are available through these macros which are mapped to C
functions depending on the Python configuration.

 -- C Function: int Py_UNICODE_ISSPACE (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a whitespace
     character.

 -- C Function: int Py_UNICODE_ISLOWER (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a lowercase
     character.

 -- C Function: int Py_UNICODE_ISUPPER (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is an uppercase
     character.

 -- C Function: int Py_UNICODE_ISTITLE (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a titlecase
     character.

 -- C Function: int Py_UNICODE_ISLINEBREAK (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a linebreak
     character.

 -- C Function: int Py_UNICODE_ISDECIMAL (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a decimal character.

 -- C Function: int Py_UNICODE_ISDIGIT (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a digit character.

 -- C Function: int Py_UNICODE_ISNUMERIC (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a numeric character.

 -- C Function: int Py_UNICODE_ISALPHA (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is an alphabetic
     character.

 -- C Function: int Py_UNICODE_ISALNUM (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is an alphanumeric
     character.

 -- C Function: int Py_UNICODE_ISPRINTABLE (Py_UNICODE ch)

     Return ‘1’ or ‘0’ depending on whether `ch' is a printable
     character.  Nonprintable characters are those characters defined in
     the Unicode character database as “Other” or “Separator”, excepting
     the ASCII space (0x20) which is considered printable.  (Note that
     printable characters in this context are those which should not be
     escaped when *note repr(): 7c0. is invoked on a string.  It has no
     bearing on the handling of strings written to *note sys.stdout:
     303. or *note sys.stderr: 304.)

These APIs can be used for fast direct character conversions:

 -- C Function: Py_UNICODE Py_UNICODE_TOLOWER (Py_UNICODE ch)

     Return the character `ch' converted to lower case.

     Deprecated since version 3.3: This function uses simple case
     mappings.

 -- C Function: Py_UNICODE Py_UNICODE_TOUPPER (Py_UNICODE ch)

     Return the character `ch' converted to upper case.

     Deprecated since version 3.3: This function uses simple case
     mappings.

 -- C Function: Py_UNICODE Py_UNICODE_TOTITLE (Py_UNICODE ch)

     Return the character `ch' converted to title case.

     Deprecated since version 3.3: This function uses simple case
     mappings.

 -- C Function: int Py_UNICODE_TODECIMAL (Py_UNICODE ch)

     Return the character `ch' converted to a decimal positive integer.
     Return ‘-1’ if this is not possible.  This macro does not raise
     exceptions.

 -- C Function: int Py_UNICODE_TODIGIT (Py_UNICODE ch)

     Return the character `ch' converted to a single digit integer.
     Return ‘-1’ if this is not possible.  This macro does not raise
     exceptions.

 -- C Function: double Py_UNICODE_TONUMERIC (Py_UNICODE ch)

     Return the character `ch' converted to a double.  Return ‘-1.0’ if
     this is not possible.  This macro does not raise exceptions.

These APIs can be used to work with surrogates:

 -- C Macro: Py_UNICODE_IS_SURROGATE (ch)

     Check if `ch' is a surrogate (‘0xD800 <= ch <= 0xDFFF’).

 -- C Macro: Py_UNICODE_IS_HIGH_SURROGATE (ch)

     Check if `ch' is a high surrogate (‘0xD800 <= ch <= 0xDBFF’).

 -- C Macro: Py_UNICODE_IS_LOW_SURROGATE (ch)

     Check if `ch' is a low surrogate (‘0xDC00 <= ch <= 0xDFFF’).

 -- C Macro: Py_UNICODE_JOIN_SURROGATES (high, low)

     Join two surrogate characters and return a single Py_UCS4 value.
     `high' and `low' are respectively the leading and trailing
     surrogates in a surrogate pair.


File: python.info,  Node: Creating and accessing Unicode strings,  Next: Deprecated Py_UNICODE APIs,  Prev: Unicode Character Properties,  Up: Unicode Objects

7.8.3.10 Creating and accessing Unicode strings
...............................................

To create Unicode objects and access their basic sequence properties,
use these APIs:

 -- C Function: PyObject* PyUnicode_New (Py_ssize_t size,
          Py_UCS4 maxchar)
     `Return value: New reference.'  Create a new Unicode object.
     `maxchar' should be the true maximum code point to be placed in the
     string.  As an approximation, it can be rounded up to the nearest
     value in the sequence 127, 255, 65535, 1114111.

     This is the recommended way to allocate a new Unicode object.
     Objects created using this function are not resizable.

     New in version 3.3.

 -- C Function: PyObject* PyUnicode_FromKindAndData (int kind, const
          void *buffer, Py_ssize_t size)
     `Return value: New reference.'  Create a new Unicode object with
     the given `kind' (possible values are *note PyUnicode_1BYTE_KIND:
     ad5. etc., as returned by *note PyUnicode_KIND(): ad3.).  The
     `buffer' must point to an array of `size' units of 1, 2 or 4 bytes
     per character, as given by the kind.

     New in version 3.3.

 -- C Function: PyObject* PyUnicode_FromStringAndSize (const char *u,
          Py_ssize_t size)
     `Return value: New reference.'  Create a Unicode object from the
     char buffer `u'.  The bytes will be interpreted as being UTF-8
     encoded.  The buffer is copied into the new object.  If the buffer
     is not ‘NULL’, the return value might be a shared object, i.e.
     modification of the data is not allowed.

     If `u' is ‘NULL’, this function behaves like *note
     PyUnicode_FromUnicode(): ae4. with the buffer set to ‘NULL’.  This
     usage is deprecated in favor of *note PyUnicode_New(): ac2.

 -- C Function: PyObject *PyUnicode_FromString (const char *u)
     `Return value: New reference.'  Create a Unicode object from a
     UTF-8 encoded null-terminated char buffer `u'.

 -- C Function: PyObject* PyUnicode_FromFormat (const char *format, ...)
     `Return value: New reference.'  Take a C ‘printf()’-style `format'
     string and a variable number of arguments, calculate the size of
     the resulting Python Unicode string and return a string with the
     values formatted into it.  The variable arguments must be C types
     and must correspond exactly to the format characters in the
     `format' ASCII-encoded string.  The following format characters are
     allowed:

     Format Characters       Type                      Comment
                                                       
     -----------------------------------------------------------------------------------------
                                                       
     ‘%%’                    `n/a'                     The literal % character.
                                                       
                                                       
     ‘%c’                    int                       A single character, represented as a
                                                       C int.
                                                       
                                                       
     ‘%d’                    int                       Equivalent to ‘printf("%d")’.  (1)
                                                       
                                                       
     ‘%u’                    unsigned int              Equivalent to ‘printf("%u")’.  (2)
                                                       
                                                       
     ‘%ld’                   long                      Equivalent to ‘printf("%ld")’.  (3)
                                                       
                                                       
     ‘%li’                   long                      Equivalent to ‘printf("%li")’.  (4)
                                                       
                                                       
     ‘%lu’                   unsigned long             Equivalent to ‘printf("%lu")’.  (5)
                                                       
                                                       
     ‘%lld’                  long long                 Equivalent to ‘printf("%lld")’.  (6)
                                                       
                                                       
     ‘%lli’                  long long                 Equivalent to ‘printf("%lli")’.  (7)
                                                       
                                                       
     ‘%llu’                  unsigned long long        Equivalent to ‘printf("%llu")’.  (8)
                                                       
                                                       
     ‘%zd’                   Py_ssize_t                Equivalent to ‘printf("%zd")’.  (9)
                                                       
                                                       
     ‘%zi’                   Py_ssize_t                Equivalent to ‘printf("%zi")’.  (10)
                                                       
                                                       
     ‘%zu’                   size_t                    Equivalent to ‘printf("%zu")’.  (11)
                                                       
                                                       
     ‘%i’                    int                       Equivalent to ‘printf("%i")’.  (12)
                                                       
                                                       
     ‘%x’                    int                       Equivalent to ‘printf("%x")’.  (13)
                                                       
                                                       
     ‘%s’                    const char*               A null-terminated C character array.
                                                       
                                                       
     ‘%p’                    const void*               The hex representation of a C
                                                       pointer.  Mostly equivalent to
                                                       ‘printf("%p")’ except that it is
                                                       guaranteed to start with the literal
                                                       ‘0x’ regardless of what the
                                                       platform’s ‘printf’ yields.
                                                       
                                                       
     ‘%A’                    PyObject*                 The result of calling
                                                       *note ascii(): d3f.
                                                       
                                                       
     ‘%U’                    PyObject*                 A Unicode object.
                                                       
                                                       
     ‘%V’                    PyObject*, const char*    A Unicode object (which may be
                                                       ‘NULL’) and a null-terminated C
                                                       character array as a second
                                                       parameter (which will be used, if
                                                       the first parameter is ‘NULL’).
                                                       
                                                       
     ‘%S’                    PyObject*                 The result of calling
                                                       *note PyObject_Str(): 95d.
                                                       
                                                       
     ‘%R’                    PyObject*                 The result of calling
                                                       *note PyObject_Repr(): 95c.
                                                       

     An unrecognized format character causes all the rest of the format
     string to be copied as-is to the result string, and any extra
     arguments discarded.

          Note: The width formatter unit is number of characters rather
          than bytes.  The precision formatter unit is number of bytes
          for ‘"%s"’ and ‘"%V"’ (if the ‘PyObject*’ argument is ‘NULL’),
          and a number of characters for ‘"%A"’, ‘"%U"’, ‘"%S"’, ‘"%R"’
          and ‘"%V"’ (if the ‘PyObject*’ argument is not ‘NULL’).

     Changed in version 3.2: Support for ‘"%lld"’ and ‘"%llu"’ added.

     Changed in version 3.3: Support for ‘"%li"’, ‘"%lli"’ and ‘"%zi"’
     added.

     Changed in version 3.4: Support width and precision formatter for
     ‘"%s"’, ‘"%A"’, ‘"%U"’, ‘"%V"’, ‘"%S"’, ‘"%R"’ added.

 -- C Function: PyObject* PyUnicode_FromFormatV (const char *format,
          va_list vargs)
     `Return value: New reference.'  Identical to *note
     PyUnicode_FromFormat(): 7bf. except that it takes exactly two
     arguments.

 -- C Function: PyObject* PyUnicode_FromEncodedObject (PyObject *obj,
          const char *encoding, const char *errors)
     `Return value: New reference.'  Decode an encoded object `obj' to a
     Unicode object.

     *note bytes: 326, *note bytearray: 327. and other *note bytes-like
     objects: 5dd. are decoded according to the given `encoding' and
     using the error handling defined by `errors'.  Both can be ‘NULL’
     to have the interface use the default values (see *note Built-in
     Codecs: 3d47. for details).

     All other objects, including Unicode objects, cause a *note
     TypeError: 192. to be set.

     The API returns ‘NULL’ if there was an error.  The caller is
     responsible for decref’ing the returned objects.

 -- C Function: Py_ssize_t PyUnicode_GetLength (PyObject *unicode)

     Return the length of the Unicode object, in code points.

     New in version 3.3.

 -- C Function: Py_ssize_t PyUnicode_CopyCharacters (PyObject *to,
          Py_ssize_t to_start, PyObject *from, Py_ssize_t from_start,
          Py_ssize_t how_many)

     Copy characters from one Unicode object into another.  This
     function performs character conversion when necessary and falls
     back to ‘memcpy()’ if possible.  Returns ‘-1’ and sets an exception
     on error, otherwise returns the number of copied characters.

     New in version 3.3.

 -- C Function: Py_ssize_t PyUnicode_Fill (PyObject *unicode,
          Py_ssize_t start, Py_ssize_t length, Py_UCS4 fill_char)

     Fill a string with a character: write `fill_char' into
     ‘unicode[start:start+length]’.

     Fail if `fill_char' is bigger than the string maximum character, or
     if the string has more than 1 reference.

     Return the number of written character, or return ‘-1’ and raise an
     exception on error.

     New in version 3.3.

 -- C Function: int PyUnicode_WriteChar (PyObject *unicode,
          Py_ssize_t index, Py_UCS4 character)

     Write a character to a string.  The string must have been created
     through *note PyUnicode_New(): ac2.  Since Unicode strings are
     supposed to be immutable, the string must not be shared, or have
     been hashed yet.

     This function checks that `unicode' is a Unicode object, that the
     index is not out of bounds, and that the object can be modified
     safely (i.e.  that it its reference count is one).

     New in version 3.3.

 -- C Function: Py_UCS4 PyUnicode_ReadChar (PyObject *unicode,
          Py_ssize_t index)

     Read a character from a string.  This function checks that
     `unicode' is a Unicode object and the index is not out of bounds,
     in contrast to the macro version *note PyUnicode_READ_CHAR(): ad9.

     New in version 3.3.

 -- C Function: PyObject* PyUnicode_Substring (PyObject *str,
          Py_ssize_t start, Py_ssize_t end)
     `Return value: New reference.'  Return a substring of `str', from
     character index `start' (included) to character index `end'
     (excluded).  Negative indices are not supported.

     New in version 3.3.

 -- C Function: Py_UCS4* PyUnicode_AsUCS4 (PyObject *u, Py_UCS4 *buffer,
          Py_ssize_t buflen, int copy_null)

     Copy the string `u' into a UCS4 buffer, including a null character,
     if `copy_null' is set.  Returns ‘NULL’ and sets an exception on
     error (in particular, a *note SystemError: 5f0. if `buflen' is
     smaller than the length of `u').  `buffer' is returned on success.

     New in version 3.3.

 -- C Function: Py_UCS4* PyUnicode_AsUCS4Copy (PyObject *u)

     Copy the string `u' into a new UCS4 buffer that is allocated using
     *note PyMem_Malloc(): 4fa.  If this fails, ‘NULL’ is returned with
     a *note MemoryError: f42. set.  The returned buffer always has an
     extra null code point appended.

     New in version 3.3.

   ---------- Footnotes ----------

   (1) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (2) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (3) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (4) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (5) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (6) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (7) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (8) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (9) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (10) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (11) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (12) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.

   (13) (1) For integer specifiers (d, u, ld, li, lu, lld, lli, llu, zd,
zi, zu, i, x): the 0-conversion flag has effect even when a precision is
given.


File: python.info,  Node: Deprecated Py_UNICODE APIs,  Next: Locale Encoding,  Prev: Creating and accessing Unicode strings,  Up: Unicode Objects

7.8.3.11 Deprecated Py_UNICODE APIs
...................................

Deprecated since version 3.3, will be removed in version 4.0.

These API functions are deprecated with the implementation of PEP
393(1).  Extension modules can continue using them, as they will not be
removed in Python 3.x, but need to be aware that their use can now cause
performance and memory hits.

 -- C Function: PyObject* PyUnicode_FromUnicode (const Py_UNICODE *u,
          Py_ssize_t size)
     `Return value: New reference.'  Create a Unicode object from the
     Py_UNICODE buffer `u' of the given size.  `u' may be ‘NULL’ which
     causes the contents to be undefined.  It is the user’s
     responsibility to fill in the needed data.  The buffer is copied
     into the new object.

     If the buffer is not ‘NULL’, the return value might be a shared
     object.  Therefore, modification of the resulting Unicode object is
     only allowed when `u' is ‘NULL’.

     If the buffer is ‘NULL’, *note PyUnicode_READY(): acb. must be
     called once the string content has been filled before using any of
     the access macros such as *note PyUnicode_KIND(): ad3.

     Please migrate to using *note PyUnicode_FromKindAndData(): acc,
     *note PyUnicode_FromWideChar(): ae5. or *note PyUnicode_New(): ac2.

 -- C Function: Py_UNICODE* PyUnicode_AsUnicode (PyObject *unicode)

     Return a read-only pointer to the Unicode object’s internal *note
     Py_UNICODE: ae3. buffer, or ‘NULL’ on error.  This will create the
     *note Py_UNICODE*: ae3. representation of the object if it is not
     yet available.  The buffer is always terminated with an extra null
     code point.  Note that the resulting *note Py_UNICODE: ae3. string
     may also contain embedded null code points, which would cause the
     string to be truncated when used in most C functions.

     Please migrate to using *note PyUnicode_AsUCS4(): acd, *note
     PyUnicode_AsWideChar(): f8a, *note PyUnicode_ReadChar(): ac4. or
     similar new APIs.

 -- C Function: PyObject* PyUnicode_TransformDecimalToASCII
          (Py_UNICODE *s, Py_ssize_t size)
     `Return value: New reference.'  Create a Unicode object by
     replacing all decimal digits in *note Py_UNICODE: ae3. buffer of
     the given `size' by ASCII digits 0–9 according to their decimal
     value.  Return ‘NULL’ if an exception occurs.

 -- C Function: Py_UNICODE* PyUnicode_AsUnicodeAndSize
          (PyObject *unicode, Py_ssize_t *size)

     Like *note PyUnicode_AsUnicode(): ae7, but also saves the *note
     Py_UNICODE(): ae3. array length (excluding the extra null
     terminator) in `size'.  Note that the resulting *note Py_UNICODE*:
     ae3. string may contain embedded null code points, which would
     cause the string to be truncated when used in most C functions.

     New in version 3.3.

 -- C Function: Py_UNICODE* PyUnicode_AsUnicodeCopy (PyObject *unicode)

     Create a copy of a Unicode string ending with a null code point.
     Return ‘NULL’ and raise a *note MemoryError: f42. exception on
     memory allocation failure, otherwise return a new allocated buffer
     (use *note PyMem_Free(): d9c. to free the buffer).  Note that the
     resulting *note Py_UNICODE*: ae3. string may contain embedded null
     code points, which would cause the string to be truncated when used
     in most C functions.

     New in version 3.2.

     Please migrate to using *note PyUnicode_AsUCS4Copy(): ace. or
     similar new APIs.

 -- C Function: Py_ssize_t PyUnicode_GetSize (PyObject *unicode)

     Return the size of the deprecated *note Py_UNICODE: ae3.
     representation, in code units (this includes surrogate pairs as 2
     units).

     Please migrate to using *note PyUnicode_GetLength(): ac0.

 -- C Function: PyObject* PyUnicode_FromObject (PyObject *obj)
     `Return value: New reference.'  Copy an instance of a Unicode
     subtype to a new true Unicode object if necessary.  If `obj' is
     already a true Unicode object (not a subtype), return the reference
     with incremented refcount.

     Objects other than Unicode or its subtypes will cause a *note
     TypeError: 192.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0393


File: python.info,  Node: Locale Encoding,  Next: File System Encoding,  Prev: Deprecated Py_UNICODE APIs,  Up: Unicode Objects

7.8.3.12 Locale Encoding
........................

The current locale encoding can be used to decode text from the
operating system.

 -- C Function: PyObject* PyUnicode_DecodeLocaleAndSize (const
          char *str, Py_ssize_t len, const char *errors)
     `Return value: New reference.'  Decode a string from UTF-8 on
     Android and VxWorks, or from the current locale encoding on other
     platforms.  The supported error handlers are ‘"strict"’ and
     ‘"surrogateescape"’ ( PEP 383(1)).  The decoder uses ‘"strict"’
     error handler if `errors' is ‘NULL’.  `str' must end with a null
     character but cannot contain embedded null characters.

     Use *note PyUnicode_DecodeFSDefaultAndSize(): 3b8a. to decode a
     string from ‘Py_FileSystemDefaultEncoding’ (the locale encoding
     read at Python startup).

     This function ignores the Python UTF-8 mode.

     See also
     ........

     The *note Py_DecodeLocale(): 431. function.

     New in version 3.3.

     Changed in version 3.7: The function now also uses the current
     locale encoding for the ‘surrogateescape’ error handler, except on
     Android.  Previously, *note Py_DecodeLocale(): 431. was used for
     the ‘surrogateescape’, and the current locale encoding was used for
     ‘strict’.

 -- C Function: PyObject* PyUnicode_DecodeLocale (const char *str, const
          char *errors)
     `Return value: New reference.'  Similar to *note
     PyUnicode_DecodeLocaleAndSize(): 433, but compute the string length
     using ‘strlen()’.

     New in version 3.3.

 -- C Function: PyObject* PyUnicode_EncodeLocale (PyObject *unicode,
          const char *errors)
     `Return value: New reference.'  Encode a Unicode object to UTF-8 on
     Android and VxWorks, or to the current locale encoding on other
     platforms.  The supported error handlers are ‘"strict"’ and
     ‘"surrogateescape"’ ( PEP 383(2)).  The encoder uses ‘"strict"’
     error handler if `errors' is ‘NULL’.  Return a *note bytes: 326.
     object.  `unicode' cannot contain embedded null characters.

     Use *note PyUnicode_EncodeFSDefault(): f83. to encode a string to
     ‘Py_FileSystemDefaultEncoding’ (the locale encoding read at Python
     startup).

     This function ignores the Python UTF-8 mode.

     See also
     ........

     The *note Py_EncodeLocale(): 432. function.

     New in version 3.3.

     Changed in version 3.7: The function now also uses the current
     locale encoding for the ‘surrogateescape’ error handler, except on
     Android.  Previously, *note Py_EncodeLocale(): 432. was used for
     the ‘surrogateescape’, and the current locale encoding was used for
     ‘strict’.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0383

   (2) https://www.python.org/dev/peps/pep-0383


File: python.info,  Node: File System Encoding,  Next: wchar_t Support,  Prev: Locale Encoding,  Up: Unicode Objects

7.8.3.13 File System Encoding
.............................

To encode and decode file names and other environment strings,
‘Py_FileSystemDefaultEncoding’ should be used as the encoding, and
‘Py_FileSystemDefaultEncodeErrors’ should be used as the error handler (
PEP 383(1) and PEP 529(2)).  To encode file names to *note bytes: 326.
during argument parsing, the ‘"O&"’ converter should be used, passing
*note PyUnicode_FSConverter(): 5c3. as the conversion function:

 -- C Function: int PyUnicode_FSConverter (PyObject* obj, void* result)

     ParseTuple converter: encode *note str: 325. objects – obtained
     directly or through the *note os.PathLike: 4e0. interface – to
     *note bytes: 326. using *note PyUnicode_EncodeFSDefault(): f83.;
     *note bytes: 326. objects are output as-is.  `result' must be a
     *note PyBytesObject*: d11. which must be released when it is no
     longer used.

     New in version 3.1.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

To decode file names to *note str: 325. during argument parsing, the
‘"O&"’ converter should be used, passing *note PyUnicode_FSDecoder():
5c4. as the conversion function:

 -- C Function: int PyUnicode_FSDecoder (PyObject* obj, void* result)

     ParseTuple converter: decode *note bytes: 326. objects – obtained
     either directly or indirectly through the *note os.PathLike: 4e0.
     interface – to *note str: 325. using *note
     PyUnicode_DecodeFSDefaultAndSize(): 3b8a.; *note str: 325. objects
     are output as-is.  `result' must be a *note PyUnicodeObject*: 3d29.
     which must be released when it is no longer used.

     New in version 3.2.

     Changed in version 3.6: Accepts a *note path-like object: 35f.

 -- C Function: PyObject* PyUnicode_DecodeFSDefaultAndSize (const
          char *s, Py_ssize_t size)
     `Return value: New reference.'  Decode a string using
     ‘Py_FileSystemDefaultEncoding’ and the
     ‘Py_FileSystemDefaultEncodeErrors’ error handler.

     If ‘Py_FileSystemDefaultEncoding’ is not set, fall back to the
     locale encoding.

     ‘Py_FileSystemDefaultEncoding’ is initialized at startup from the
     locale encoding and cannot be modified later.  If you need to
     decode a string from the current locale encoding, use *note
     PyUnicode_DecodeLocaleAndSize(): 433.

     See also
     ........

     The *note Py_DecodeLocale(): 431. function.

     Changed in version 3.6: Use ‘Py_FileSystemDefaultEncodeErrors’
     error handler.

 -- C Function: PyObject* PyUnicode_DecodeFSDefault (const char *s)
     `Return value: New reference.'  Decode a null-terminated string
     using ‘Py_FileSystemDefaultEncoding’ and the
     ‘Py_FileSystemDefaultEncodeErrors’ error handler.

     If ‘Py_FileSystemDefaultEncoding’ is not set, fall back to the
     locale encoding.

     Use *note PyUnicode_DecodeFSDefaultAndSize(): 3b8a. if you know the
     string length.

     Changed in version 3.6: Use ‘Py_FileSystemDefaultEncodeErrors’
     error handler.

 -- C Function: PyObject* PyUnicode_EncodeFSDefault (PyObject *unicode)
     `Return value: New reference.'  Encode a Unicode object to
     ‘Py_FileSystemDefaultEncoding’ with the
     ‘Py_FileSystemDefaultEncodeErrors’ error handler, and return *note
     bytes: 326.  Note that the resulting *note bytes: 326. object may
     contain null bytes.

     If ‘Py_FileSystemDefaultEncoding’ is not set, fall back to the
     locale encoding.

     ‘Py_FileSystemDefaultEncoding’ is initialized at startup from the
     locale encoding and cannot be modified later.  If you need to
     encode a string to the current locale encoding, use *note
     PyUnicode_EncodeLocale(): 434.

     See also
     ........

     The *note Py_EncodeLocale(): 432. function.

     New in version 3.2.

     Changed in version 3.6: Use ‘Py_FileSystemDefaultEncodeErrors’
     error handler.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0383

   (2) https://www.python.org/dev/peps/pep-0529


File: python.info,  Node: wchar_t Support,  Prev: File System Encoding,  Up: Unicode Objects

7.8.3.14 wchar_t Support
........................

‘wchar_t’ support for platforms which support it:

 -- C Function: PyObject* PyUnicode_FromWideChar (const wchar_t *w,
          Py_ssize_t size)
     `Return value: New reference.'  Create a Unicode object from the
     ‘wchar_t’ buffer `w' of the given `size'.  Passing ‘-1’ as the
     `size' indicates that the function must itself compute the length,
     using wcslen.  Return ‘NULL’ on failure.

 -- C Function: Py_ssize_t PyUnicode_AsWideChar (PyObject *unicode,
          wchar_t *w, Py_ssize_t size)

     Copy the Unicode object contents into the ‘wchar_t’ buffer `w'.  At
     most `size' ‘wchar_t’ characters are copied (excluding a possibly
     trailing null termination character).  Return the number of
     ‘wchar_t’ characters copied or ‘-1’ in case of an error.  Note that
     the resulting ‘wchar_t*’ string may or may not be null-terminated.
     It is the responsibility of the caller to make sure that the
     ‘wchar_t*’ string is null-terminated in case this is required by
     the application.  Also, note that the ‘wchar_t*’ string might
     contain null characters, which would cause the string to be
     truncated when used with most C functions.

 -- C Function: wchar_t* PyUnicode_AsWideCharString (PyObject *unicode,
          Py_ssize_t *size)

     Convert the Unicode object to a wide character string.  The output
     string always ends with a null character.  If `size' is not ‘NULL’,
     write the number of wide characters (excluding the trailing null
     termination character) into `*size'.  Note that the resulting
     ‘wchar_t’ string might contain null characters, which would cause
     the string to be truncated when used with most C functions.  If
     `size' is ‘NULL’ and the ‘wchar_t*’ string contains null characters
     a *note ValueError: 1f9. is raised.

     Returns a buffer allocated by ‘PyMem_Alloc()’ (use *note
     PyMem_Free(): d9c. to free it) on success.  On error, returns
     ‘NULL’ and `*size' is undefined.  Raises a *note MemoryError: f42.
     if memory allocation is failed.

     New in version 3.2.

     Changed in version 3.7: Raises a *note ValueError: 1f9. if `size'
     is ‘NULL’ and the ‘wchar_t*’ string contains null characters.


File: python.info,  Node: Built-in Codecs,  Next: Methods and Slot Functions,  Prev: Unicode Objects,  Up: Unicode Objects and Codecs

7.8.3.15 Built-in Codecs
........................

Python provides a set of built-in codecs which are written in C for
speed.  All of these codecs are directly usable via the following
functions.

Many of the following APIs take two arguments encoding and errors, and
they have the same semantics as the ones of the built-in *note str():
325. string object constructor.

Setting encoding to ‘NULL’ causes the default encoding to be used which
is ASCII. The file system calls should use *note
PyUnicode_FSConverter(): 5c3. for encoding file names.  This uses the
variable ‘Py_FileSystemDefaultEncoding’ internally.  This variable
should be treated as read-only: on some systems, it will be a pointer to
a static string, on others, it will change at run-time (such as when the
application invokes setlocale).

Error handling is set by errors which may also be set to ‘NULL’ meaning
to use the default handling defined for the codec.  Default error
handling for all built-in codecs is “strict” (*note ValueError: 1f9. is
raised).

The codecs all use a similar interface.  Only deviation from the
following generic ones are documented for simplicity.

* Menu:

* Generic Codecs::
* UTF-8 Codecs::
* UTF-32 Codecs::
* UTF-16 Codecs::
* UTF-7 Codecs::
* Unicode-Escape Codecs::
* Raw-Unicode-Escape Codecs::
* Latin-1 Codecs::
* ASCII Codecs::
* Character Map Codecs::
* MBCS codecs for Windows::
* Methods & Slots::


File: python.info,  Node: Generic Codecs,  Next: UTF-8 Codecs,  Up: Built-in Codecs

7.8.3.16 Generic Codecs
.......................

These are the generic codec APIs:

 -- C Function: PyObject* PyUnicode_Decode (const char *s,
          Py_ssize_t size, const char *encoding, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the encoded string `s'.  `encoding' and `errors'
     have the same meaning as the parameters of the same name in the
     *note str(): 325. built-in function.  The codec to be used is
     looked up using the Python codec registry.  Return ‘NULL’ if an
     exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_AsEncodedString (PyObject *unicode,
          const char *encoding, const char *errors)
     `Return value: New reference.'  Encode a Unicode object and return
     the result as Python bytes object.  `encoding' and `errors' have
     the same meaning as the parameters of the same name in the Unicode
     *note encode(): c2a. method.  The codec to be used is looked up
     using the Python codec registry.  Return ‘NULL’ if an exception was
     raised by the codec.

 -- C Function: PyObject* PyUnicode_Encode (const Py_UNICODE *s,
          Py_ssize_t size, const char *encoding, const char *errors)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer `s' of the given `size' and return a Python bytes object.
     `encoding' and `errors' have the same meaning as the parameters of
     the same name in the Unicode *note encode(): c2a. method.  The
     codec to be used is looked up using the Python codec registry.
     Return ‘NULL’ if an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: UTF-8 Codecs,  Next: UTF-32 Codecs,  Prev: Generic Codecs,  Up: Built-in Codecs

7.8.3.17 UTF-8 Codecs
.....................

These are the UTF-8 codec APIs:

 -- C Function: PyObject* PyUnicode_DecodeUTF8 (const char *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the UTF-8 encoded string `s'.  Return ‘NULL’ if an
     exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_DecodeUTF8Stateful (const char *s,
          Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
     `Return value: New reference.'  If `consumed' is ‘NULL’, behave
     like *note PyUnicode_DecodeUTF8(): 3d53.  If `consumed' is not
     ‘NULL’, trailing incomplete UTF-8 byte sequences will not be
     treated as an error.  Those bytes will not be decoded and the
     number of bytes that have been decoded will be stored in
     `consumed'.

 -- C Function: PyObject* PyUnicode_AsUTF8String (PyObject *unicode)
     `Return value: New reference.'  Encode a Unicode object using UTF-8
     and return the result as Python bytes object.  Error handling is
     “strict”.  Return ‘NULL’ if an exception was raised by the codec.

 -- C Function: const char* PyUnicode_AsUTF8AndSize (PyObject *unicode,
          Py_ssize_t *size)

     Return a pointer to the UTF-8 encoding of the Unicode object, and
     store the size of the encoded representation (in bytes) in `size'.
     The `size' argument can be ‘NULL’; in this case no size will be
     stored.  The returned buffer always has an extra null byte appended
     (not included in `size'), regardless of whether there are any other
     null code points.

     In the case of an error, ‘NULL’ is returned with an exception set
     and no `size' is stored.

     This caches the UTF-8 representation of the string in the Unicode
     object, and subsequent calls will return a pointer to the same
     buffer.  The caller is not responsible for deallocating the buffer.

     New in version 3.3.

     Changed in version 3.7: The return type is now ‘const char *’
     rather of ‘char *’.

 -- C Function: const char* PyUnicode_AsUTF8 (PyObject *unicode)

     As *note PyUnicode_AsUTF8AndSize(): 41f, but does not store the
     size.

     New in version 3.3.

     Changed in version 3.7: The return type is now ‘const char *’
     rather of ‘char *’.

 -- C Function: PyObject* PyUnicode_EncodeUTF8 (const Py_UNICODE *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer `s' of the given `size' using UTF-8 and return a Python
     bytes object.  Return ‘NULL’ if an exception was raised by the
     codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsUTF8String(): af4, *note
     PyUnicode_AsUTF8AndSize(): 41f. or *note
     PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: UTF-32 Codecs,  Next: UTF-16 Codecs,  Prev: UTF-8 Codecs,  Up: Built-in Codecs

7.8.3.18 UTF-32 Codecs
......................

These are the UTF-32 codec APIs:

 -- C Function: PyObject* PyUnicode_DecodeUTF32 (const char *s,
          Py_ssize_t size, const char *errors, int *byteorder)
     `Return value: New reference.'  Decode `size' bytes from a UTF-32
     encoded buffer string and return the corresponding Unicode object.
     `errors' (if non-‘NULL’) defines the error handling.  It defaults
     to “strict”.

     If `byteorder' is non-‘NULL’, the decoder starts decoding using the
     given byte order:

          *byteorder == -1: little endian *byteorder == 0:  native order *byteorder == 1:  big endian

     If ‘*byteorder’ is zero, and the first four bytes of the input data
     are a byte order mark (BOM), the decoder switches to this byte
     order and the BOM is not copied into the resulting Unicode string.
     If ‘*byteorder’ is ‘-1’ or ‘1’, any byte order mark is copied to
     the output.

     After completion, `*byteorder' is set to the current byte order at
     the end of input data.

     If `byteorder' is ‘NULL’, the codec starts in native order mode.

     Return ‘NULL’ if an exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_DecodeUTF32Stateful (const char *s,
          Py_ssize_t size, const char *errors, int *byteorder,
          Py_ssize_t *consumed)
     `Return value: New reference.'  If `consumed' is ‘NULL’, behave
     like *note PyUnicode_DecodeUTF32(): 3d56.  If `consumed' is not
     ‘NULL’, *note PyUnicode_DecodeUTF32Stateful(): 3d57. will not treat
     trailing incomplete UTF-32 byte sequences (such as a number of
     bytes not divisible by four) as an error.  Those bytes will not be
     decoded and the number of bytes that have been decoded will be
     stored in `consumed'.

 -- C Function: PyObject* PyUnicode_AsUTF32String (PyObject *unicode)
     `Return value: New reference.'  Return a Python byte string using
     the UTF-32 encoding in native byte order.  The string always starts
     with a BOM mark.  Error handling is “strict”.  Return ‘NULL’ if an
     exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_EncodeUTF32 (const Py_UNICODE *s,
          Py_ssize_t size, const char *errors, int byteorder)
     `Return value: New reference.'  Return a Python bytes object
     holding the UTF-32 encoded value of the Unicode data in `s'.
     Output is written according to the following byte order:

          byteorder == -1: little endian byteorder == 0:  native byte order (writes a BOM mark) byteorder == 1:  big endian

     If byteorder is ‘0’, the output string will always start with the
     Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is
     prepended.

     If ‘Py_UNICODE_WIDE’ is not defined, surrogate pairs will be output
     as a single code point.

     Return ‘NULL’ if an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsUTF32String(): 3d58. or *note
     PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: UTF-16 Codecs,  Next: UTF-7 Codecs,  Prev: UTF-32 Codecs,  Up: Built-in Codecs

7.8.3.19 UTF-16 Codecs
......................

These are the UTF-16 codec APIs:

 -- C Function: PyObject* PyUnicode_DecodeUTF16 (const char *s,
          Py_ssize_t size, const char *errors, int *byteorder)
     `Return value: New reference.'  Decode `size' bytes from a UTF-16
     encoded buffer string and return the corresponding Unicode object.
     `errors' (if non-‘NULL’) defines the error handling.  It defaults
     to “strict”.

     If `byteorder' is non-‘NULL’, the decoder starts decoding using the
     given byte order:

          *byteorder == -1: little endian *byteorder == 0:  native order *byteorder == 1:  big endian

     If ‘*byteorder’ is zero, and the first two bytes of the input data
     are a byte order mark (BOM), the decoder switches to this byte
     order and the BOM is not copied into the resulting Unicode string.
     If ‘*byteorder’ is ‘-1’ or ‘1’, any byte order mark is copied to
     the output (where it will result in either a ‘\ufeff’ or a ‘\ufffe’
     character).

     After completion, `*byteorder' is set to the current byte order at
     the end of input data.

     If `byteorder' is ‘NULL’, the codec starts in native order mode.

     Return ‘NULL’ if an exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_DecodeUTF16Stateful (const char *s,
          Py_ssize_t size, const char *errors, int *byteorder,
          Py_ssize_t *consumed)
     `Return value: New reference.'  If `consumed' is ‘NULL’, behave
     like *note PyUnicode_DecodeUTF16(): 3d5a.  If `consumed' is not
     ‘NULL’, *note PyUnicode_DecodeUTF16Stateful(): 3d5b. will not treat
     trailing incomplete UTF-16 byte sequences (such as an odd number of
     bytes or a split surrogate pair) as an error.  Those bytes will not
     be decoded and the number of bytes that have been decoded will be
     stored in `consumed'.

 -- C Function: PyObject* PyUnicode_AsUTF16String (PyObject *unicode)
     `Return value: New reference.'  Return a Python byte string using
     the UTF-16 encoding in native byte order.  The string always starts
     with a BOM mark.  Error handling is “strict”.  Return ‘NULL’ if an
     exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_EncodeUTF16 (const Py_UNICODE *s,
          Py_ssize_t size, const char *errors, int byteorder)
     `Return value: New reference.'  Return a Python bytes object
     holding the UTF-16 encoded value of the Unicode data in `s'.
     Output is written according to the following byte order:

          byteorder == -1: little endian byteorder == 0:  native byte order (writes a BOM mark) byteorder == 1:  big endian

     If byteorder is ‘0’, the output string will always start with the
     Unicode BOM mark (U+FEFF). In the other two modes, no BOM mark is
     prepended.

     If ‘Py_UNICODE_WIDE’ is defined, a single *note Py_UNICODE: ae3.
     value may get represented as a surrogate pair.  If it is not
     defined, each *note Py_UNICODE: ae3. values is interpreted as a
     UCS-2 character.

     Return ‘NULL’ if an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsUTF16String(): 3d5c. or *note
     PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: UTF-7 Codecs,  Next: Unicode-Escape Codecs,  Prev: UTF-16 Codecs,  Up: Built-in Codecs

7.8.3.20 UTF-7 Codecs
.....................

These are the UTF-7 codec APIs:

 -- C Function: PyObject* PyUnicode_DecodeUTF7 (const char *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the UTF-7 encoded string `s'.  Return ‘NULL’ if an
     exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_DecodeUTF7Stateful (const char *s,
          Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
     `Return value: New reference.'  If `consumed' is ‘NULL’, behave
     like *note PyUnicode_DecodeUTF7(): 3d5e.  If `consumed' is not
     ‘NULL’, trailing incomplete UTF-7 base-64 sections will not be
     treated as an error.  Those bytes will not be decoded and the
     number of bytes that have been decoded will be stored in
     `consumed'.

 -- C Function: PyObject* PyUnicode_EncodeUTF7 (const Py_UNICODE *s,
          Py_ssize_t size, int base64SetO, int base64WhiteSpace, const
          char *errors)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer of the given size using UTF-7 and return a Python bytes
     object.  Return ‘NULL’ if an exception was raised by the codec.

     If `base64SetO' is nonzero, “Set O” (punctuation that has no
     otherwise special meaning) will be encoded in base-64.  If
     `base64WhiteSpace' is nonzero, whitespace will be encoded in
     base-64.  Both are set to zero for the Python “utf-7” codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: Unicode-Escape Codecs,  Next: Raw-Unicode-Escape Codecs,  Prev: UTF-7 Codecs,  Up: Built-in Codecs

7.8.3.21 Unicode-Escape Codecs
..............................

These are the “Unicode Escape” codec APIs:

 -- C Function: PyObject* PyUnicode_DecodeUnicodeEscape (const char *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the Unicode-Escape encoded string `s'.  Return
     ‘NULL’ if an exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_AsUnicodeEscapeString
          (PyObject *unicode)
     `Return value: New reference.'  Encode a Unicode object using
     Unicode-Escape and return the result as a bytes object.  Error
     handling is “strict”.  Return ‘NULL’ if an exception was raised by
     the codec.

 -- C Function: PyObject* PyUnicode_EncodeUnicodeEscape (const
          Py_UNICODE *s, Py_ssize_t size)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer of the given `size' using Unicode-Escape and return a bytes
     object.  Return ‘NULL’ if an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsUnicodeEscapeString(): af7.


File: python.info,  Node: Raw-Unicode-Escape Codecs,  Next: Latin-1 Codecs,  Prev: Unicode-Escape Codecs,  Up: Built-in Codecs

7.8.3.22 Raw-Unicode-Escape Codecs
..................................

These are the “Raw Unicode Escape” codec APIs:

 -- C Function: PyObject* PyUnicode_DecodeRawUnicodeEscape (const
          char *s, Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the Raw-Unicode-Escape encoded string `s'.  Return
     ‘NULL’ if an exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_AsRawUnicodeEscapeString
          (PyObject *unicode)
     `Return value: New reference.'  Encode a Unicode object using
     Raw-Unicode-Escape and return the result as a bytes object.  Error
     handling is “strict”.  Return ‘NULL’ if an exception was raised by
     the codec.

 -- C Function: PyObject* PyUnicode_EncodeRawUnicodeEscape (const
          Py_UNICODE *s, Py_ssize_t size)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer of the given `size' using Raw-Unicode-Escape and return a
     bytes object.  Return ‘NULL’ if an exception was raised by the
     codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsRawUnicodeEscapeString(): af8. or *note
     PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: Latin-1 Codecs,  Next: ASCII Codecs,  Prev: Raw-Unicode-Escape Codecs,  Up: Built-in Codecs

7.8.3.23 Latin-1 Codecs
.......................

These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256
Unicode ordinals and only these are accepted by the codecs during
encoding.

 -- C Function: PyObject* PyUnicode_DecodeLatin1 (const char *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the Latin-1 encoded string `s'.  Return ‘NULL’ if
     an exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_AsLatin1String (PyObject *unicode)
     `Return value: New reference.'  Encode a Unicode object using
     Latin-1 and return the result as Python bytes object.  Error
     handling is “strict”.  Return ‘NULL’ if an exception was raised by
     the codec.

 -- C Function: PyObject* PyUnicode_EncodeLatin1 (const Py_UNICODE *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer of the given `size' using Latin-1 and return a Python bytes
     object.  Return ‘NULL’ if an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsLatin1String(): afa. or *note
     PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: ASCII Codecs,  Next: Character Map Codecs,  Prev: Latin-1 Codecs,  Up: Built-in Codecs

7.8.3.24 ASCII Codecs
.....................

These are the ASCII codec APIs.  Only 7-bit ASCII data is accepted.  All
other codes generate errors.

 -- C Function: PyObject* PyUnicode_DecodeASCII (const char *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the ASCII encoded string `s'.  Return ‘NULL’ if an
     exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_AsASCIIString (PyObject *unicode)
     `Return value: New reference.'  Encode a Unicode object using ASCII
     and return the result as Python bytes object.  Error handling is
     “strict”.  Return ‘NULL’ if an exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_EncodeASCII (const Py_UNICODE *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer of the given `size' using ASCII and return a Python bytes
     object.  Return ‘NULL’ if an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsASCIIString(): afc. or *note
     PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: Character Map Codecs,  Next: MBCS codecs for Windows,  Prev: ASCII Codecs,  Up: Built-in Codecs

7.8.3.25 Character Map Codecs
.............................

This codec is special in that it can be used to implement many different
codecs (and this is in fact what was done to obtain most of the standard
codecs included in the ‘encodings’ package).  The codec uses mapping to
encode and decode characters.  The mapping objects provided must support
the *note __getitem__(): 27a. mapping interface; dictionaries and
sequences work well.

These are the mapping codec APIs:

 -- C Function: PyObject* PyUnicode_DecodeCharmap (const char *data,
          Py_ssize_t size, PyObject *mapping, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the encoded string `s' using the given `mapping'
     object.  Return ‘NULL’ if an exception was raised by the codec.

     If `mapping' is ‘NULL’, Latin-1 decoding will be applied.  Else
     `mapping' must map bytes ordinals (integers in the range from 0 to
     255) to Unicode strings, integers (which are then interpreted as
     Unicode ordinals) or ‘None’.  Unmapped data bytes – ones which
     cause a *note LookupError: 1599, as well as ones which get mapped
     to ‘None’, ‘0xFFFE’ or ‘'\ufffe'’, are treated as undefined
     mappings and cause an error.

 -- C Function: PyObject* PyUnicode_AsCharmapString (PyObject *unicode,
          PyObject *mapping)
     `Return value: New reference.'  Encode a Unicode object using the
     given `mapping' object and return the result as a bytes object.
     Error handling is “strict”.  Return ‘NULL’ if an exception was
     raised by the codec.

     The `mapping' object must map Unicode ordinal integers to bytes
     objects, integers in the range from 0 to 255 or ‘None’.  Unmapped
     character ordinals (ones which cause a *note LookupError: 1599.) as
     well as mapped to ‘None’ are treated as “undefined mapping” and
     cause an error.

 -- C Function: PyObject* PyUnicode_EncodeCharmap (const Py_UNICODE *s,
          Py_ssize_t size, PyObject *mapping, const char *errors)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer of the given `size' using the given `mapping' object and
     return the result as a bytes object.  Return ‘NULL’ if an exception
     was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsCharmapString(): 3d6c. or *note
     PyUnicode_AsEncodedString(): 3d51.

The following codec API is special in that maps Unicode to Unicode.

 -- C Function: PyObject* PyUnicode_Translate (PyObject *unicode,
          PyObject *mapping, const char *errors)
     `Return value: New reference.'  Translate a Unicode object using
     the given `mapping' object and return the resulting Unicode object.
     Return ‘NULL’ if an exception was raised by the codec.

     The `mapping' object must map Unicode ordinal integers to Unicode
     strings, integers (which are then interpreted as Unicode ordinals)
     or ‘None’ (causing deletion of the character).  Unmapped character
     ordinals (ones which cause a *note LookupError: 1599.) are left
     untouched and are copied as-is.

 -- C Function: PyObject* PyUnicode_TranslateCharmap (const
          Py_UNICODE *s, Py_ssize_t size, PyObject *mapping, const
          char *errors)
     `Return value: New reference.'  Translate a *note Py_UNICODE: ae3.
     buffer of the given `size' by applying a character `mapping' table
     to it and return the resulting Unicode object.  Return ‘NULL’ when
     an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_Translate(): 3d6d.  or *note generic codec
     based API: 5e3.


File: python.info,  Node: MBCS codecs for Windows,  Next: Methods & Slots,  Prev: Character Map Codecs,  Up: Built-in Codecs

7.8.3.26 MBCS codecs for Windows
................................

These are the MBCS codec APIs.  They are currently only available on
Windows and use the Win32 MBCS converters to implement the conversions.
Note that MBCS (or DBCS) is a class of encodings, not just one.  The
target encoding is defined by the user settings on the machine running
the codec.

 -- C Function: PyObject* PyUnicode_DecodeMBCS (const char *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Create a Unicode object by decoding
     `size' bytes of the MBCS encoded string `s'.  Return ‘NULL’ if an
     exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_DecodeMBCSStateful (const char *s,
          Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
     `Return value: New reference.'  If `consumed' is ‘NULL’, behave
     like *note PyUnicode_DecodeMBCS(): 3d6f.  If `consumed' is not
     ‘NULL’, *note PyUnicode_DecodeMBCSStateful(): 3d70. will not decode
     trailing lead byte and the number of bytes that have been decoded
     will be stored in `consumed'.

 -- C Function: PyObject* PyUnicode_AsMBCSString (PyObject *unicode)
     `Return value: New reference.'  Encode a Unicode object using MBCS
     and return the result as Python bytes object.  Error handling is
     “strict”.  Return ‘NULL’ if an exception was raised by the codec.

 -- C Function: PyObject* PyUnicode_EncodeCodePage (int code_page,
          PyObject *unicode, const char *errors)
     `Return value: New reference.'  Encode the Unicode object using the
     specified code page and return a Python bytes object.  Return
     ‘NULL’ if an exception was raised by the codec.  Use ‘CP_ACP’ code
     page to get the MBCS encoder.

     New in version 3.3.

 -- C Function: PyObject* PyUnicode_EncodeMBCS (const Py_UNICODE *s,
          Py_ssize_t size, const char *errors)
     `Return value: New reference.'  Encode the *note Py_UNICODE: ae3.
     buffer of the given `size' using MBCS and return a Python bytes
     object.  Return ‘NULL’ if an exception was raised by the codec.

     Deprecated since version 3.3, will be removed in version 4.0: Part
     of the old-style *note Py_UNICODE: ae3. API; please migrate to
     using *note PyUnicode_AsMBCSString(): b00, *note
     PyUnicode_EncodeCodePage(): b01. or *note
     PyUnicode_AsEncodedString(): 3d51.


File: python.info,  Node: Methods & Slots,  Prev: MBCS codecs for Windows,  Up: Built-in Codecs

7.8.3.27 Methods & Slots
........................


File: python.info,  Node: Methods and Slot Functions,  Prev: Built-in Codecs,  Up: Unicode Objects and Codecs

7.8.3.28 Methods and Slot Functions
...................................

The following APIs are capable of handling Unicode objects and strings
on input (we refer to them as strings in the descriptions) and return
Unicode objects or integers as appropriate.

They all return ‘NULL’ or ‘-1’ if an exception occurs.

 -- C Function: PyObject* PyUnicode_Concat (PyObject *left,
          PyObject *right)
     `Return value: New reference.'  Concat two strings giving a new
     Unicode string.

 -- C Function: PyObject* PyUnicode_Split (PyObject *s, PyObject *sep,
          Py_ssize_t maxsplit)
     `Return value: New reference.'  Split a string giving a list of
     Unicode strings.  If `sep' is ‘NULL’, splitting will be done at all
     whitespace substrings.  Otherwise, splits occur at the given
     separator.  At most `maxsplit' splits will be done.  If negative,
     no limit is set.  Separators are not included in the resulting
     list.

 -- C Function: PyObject* PyUnicode_Splitlines (PyObject *s,
          int keepend)
     `Return value: New reference.'  Split a Unicode string at line
     breaks, returning a list of Unicode strings.  CRLF is considered to
     be one line break.  If `keepend' is ‘0’, the Line break characters
     are not included in the resulting strings.

 -- C Function: PyObject* PyUnicode_Translate (PyObject *str,
          PyObject *table, const char *errors)

     Translate a string by applying a character mapping table to it and
     return the resulting Unicode object.

     The mapping table must map Unicode ordinal integers to Unicode
     ordinal integers or ‘None’ (causing deletion of the character).

     Mapping tables need only provide the *note __getitem__(): 27a.
     interface; dictionaries and sequences work well.  Unmapped
     character ordinals (ones which cause a *note LookupError: 1599.)
     are left untouched and are copied as-is.

     `errors' has the usual meaning for codecs.  It may be ‘NULL’ which
     indicates to use the default error handling.

 -- C Function: PyObject* PyUnicode_Join (PyObject *separator,
          PyObject *seq)
     `Return value: New reference.'  Join a sequence of strings using
     the given `separator' and return the resulting Unicode string.

 -- C Function: Py_ssize_t PyUnicode_Tailmatch (PyObject *str,
          PyObject *substr, Py_ssize_t start, Py_ssize_t end,
          int direction)

     Return ‘1’ if `substr' matches ‘str[start:end]’ at the given tail
     end (`direction' == ‘-1’ means to do a prefix match, `direction' ==
     ‘1’ a suffix match), ‘0’ otherwise.  Return ‘-1’ if an error
     occurred.

 -- C Function: Py_ssize_t PyUnicode_Find (PyObject *str,
          PyObject *substr, Py_ssize_t start, Py_ssize_t end,
          int direction)

     Return the first position of `substr' in ‘str[start:end]’ using the
     given `direction' (`direction' == ‘1’ means to do a forward search,
     `direction' == ‘-1’ a backward search).  The return value is the
     index of the first match; a value of ‘-1’ indicates that no match
     was found, and ‘-2’ indicates that an error occurred and an
     exception has been set.

 -- C Function: Py_ssize_t PyUnicode_FindChar (PyObject *str,
          Py_UCS4 ch, Py_ssize_t start, Py_ssize_t end, int direction)

     Return the first position of the character `ch' in ‘str[start:end]’
     using the given `direction' (`direction' == ‘1’ means to do a
     forward search, `direction' == ‘-1’ a backward search).  The return
     value is the index of the first match; a value of ‘-1’ indicates
     that no match was found, and ‘-2’ indicates that an error occurred
     and an exception has been set.

     New in version 3.3.

     Changed in version 3.7: `start' and `end' are now adjusted to
     behave like ‘str[start:end]’.

 -- C Function: Py_ssize_t PyUnicode_Count (PyObject *str,
          PyObject *substr, Py_ssize_t start, Py_ssize_t end)

     Return the number of non-overlapping occurrences of `substr' in
     ‘str[start:end]’.  Return ‘-1’ if an error occurred.

 -- C Function: PyObject* PyUnicode_Replace (PyObject *str,
          PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)
     `Return value: New reference.'  Replace at most `maxcount'
     occurrences of `substr' in `str' with `replstr' and return the
     resulting Unicode object.  `maxcount' == ‘-1’ means replace all
     occurrences.

 -- C Function: int PyUnicode_Compare (PyObject *left, PyObject *right)

     Compare two strings and return ‘-1’, ‘0’, ‘1’ for less than, equal,
     and greater than, respectively.

     This function returns ‘-1’ upon failure, so one should call *note
     PyErr_Occurred(): 3a43. to check for errors.

 -- C Function: int PyUnicode_CompareWithASCIIString (PyObject *uni,
          const char *string)

     Compare a Unicode object, `uni', with `string' and return ‘-1’,
     ‘0’, ‘1’ for less than, equal, and greater than, respectively.  It
     is best to pass only ASCII-encoded strings, but the function
     interprets the input string as ISO-8859-1 if it contains non-ASCII
     characters.

     This function does not raise exceptions.

 -- C Function: PyObject* PyUnicode_RichCompare (PyObject *left,
          PyObject *right, int op)
     `Return value: New reference.'  Rich compare two Unicode strings
     and return one of the following:

        * ‘NULL’ in case an exception was raised

        * ‘Py_True’ or ‘Py_False’ for successful comparisons

        * ‘Py_NotImplemented’ in case the type combination is unknown

     Possible values for `op' are ‘Py_GT’, ‘Py_GE’, ‘Py_EQ’, ‘Py_NE’,
     ‘Py_LT’, and ‘Py_LE’.

 -- C Function: PyObject* PyUnicode_Format (PyObject *format,
          PyObject *args)
     `Return value: New reference.'  Return a new string object from
     `format' and `args'; this is analogous to ‘format % args’.

 -- C Function: int PyUnicode_Contains (PyObject *container,
          PyObject *element)

     Check whether `element' is contained in `container' and return true
     or false accordingly.

     `element' has to coerce to a one element Unicode string.  ‘-1’ is
     returned if there was an error.

 -- C Function: void PyUnicode_InternInPlace (PyObject **string)

     Intern the argument `*string' in place.  The argument must be the
     address of a pointer variable pointing to a Python Unicode string
     object.  If there is an existing interned string that is the same
     as `*string', it sets `*string' to it (decrementing the reference
     count of the old string object and incrementing the reference count
     of the interned string object), otherwise it leaves `*string' alone
     and interns it (incrementing its reference count).  (Clarification:
     even though there is a lot of talk about reference counts, think of
     this function as reference-count-neutral; you own the object after
     the call if and only if you owned it before the call.)

 -- C Function: PyObject* PyUnicode_InternFromString (const char *v)
     `Return value: New reference.'  A combination of *note
     PyUnicode_FromString(): 3ad5. and *note PyUnicode_InternInPlace():
     3d7c, returning either a new Unicode string object that has been
     interned, or a new (“owned”) reference to an earlier interned
     string object with the same value.


File: python.info,  Node: Tuple Objects,  Next: Struct Sequence Objects,  Prev: Unicode Objects and Codecs,  Up: Sequence Objects

7.8.3.29 Tuple Objects
......................

 -- C Type: PyTupleObject

     This subtype of *note PyObject: 4b0. represents a Python tuple
     object.

 -- C Variable: PyTypeObject PyTuple_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     tuple type; it is the same object as *note tuple: 473. in the
     Python layer.

 -- C Function: int PyTuple_Check (PyObject *p)

     Return true if `p' is a tuple object or an instance of a subtype of
     the tuple type.

 -- C Function: int PyTuple_CheckExact (PyObject *p)

     Return true if `p' is a tuple object, but not an instance of a
     subtype of the tuple type.

 -- C Function: PyObject* PyTuple_New (Py_ssize_t len)
     `Return value: New reference.'  Return a new tuple object of size
     `len', or ‘NULL’ on failure.

 -- C Function: PyObject* PyTuple_Pack (Py_ssize_t n, ...)
     `Return value: New reference.'  Return a new tuple object of size
     `n', or ‘NULL’ on failure.  The tuple values are initialized to the
     subsequent `n' C arguments pointing to Python objects.
     ‘PyTuple_Pack(2, a, b)’ is equivalent to ‘Py_BuildValue("(OO)", a,
     b)’.

 -- C Function: Py_ssize_t PyTuple_Size (PyObject *p)

     Take a pointer to a tuple object, and return the size of that
     tuple.

 -- C Function: Py_ssize_t PyTuple_GET_SIZE (PyObject *p)

     Return the size of the tuple `p', which must be non-‘NULL’ and
     point to a tuple; no error checking is performed.

 -- C Function: PyObject* PyTuple_GetItem (PyObject *p, Py_ssize_t pos)
     `Return value: Borrowed reference.'  Return the object at position
     `pos' in the tuple pointed to by `p'.  If `pos' is out of bounds,
     return ‘NULL’ and set an *note IndexError: e69. exception.

 -- C Function: PyObject* PyTuple_GET_ITEM (PyObject *p, Py_ssize_t pos)
     `Return value: Borrowed reference.'  Like *note PyTuple_GetItem():
     3a60, but does no checking of its arguments.

 -- C Function: PyObject* PyTuple_GetSlice (PyObject *p, Py_ssize_t low,
          Py_ssize_t high)
     `Return value: New reference.'  Return the slice of the tuple
     pointed to by `p' between `low' and `high', or ‘NULL’ on failure.
     This is the equivalent of the Python expression ‘p[low:high]’.
     Indexing from the end of the list is not supported.

 -- C Function: int PyTuple_SetItem (PyObject *p, Py_ssize_t pos,
          PyObject *o)

     Insert a reference to object `o' at position `pos' of the tuple
     pointed to by `p'.  Return ‘0’ on success.  If `pos' is out of
     bounds, return ‘-1’ and set an *note IndexError: e69. exception.

          Note: This function “steals” a reference to `o' and discards a
          reference to an item already in the tuple at the affected
          position.

 -- C Function: void PyTuple_SET_ITEM (PyObject *p, Py_ssize_t pos,
          PyObject *o)

     Like *note PyTuple_SetItem(): 3a65, but does no error checking, and
     should `only' be used to fill in brand new tuples.

          Note: This macro “steals” a reference to `o', and, unlike
          *note PyTuple_SetItem(): 3a65, does `not' discard a reference
          to any item that is being replaced; any reference in the tuple
          at position `pos' will be leaked.

 -- C Function: int _PyTuple_Resize (PyObject **p, Py_ssize_t newsize)

     Can be used to resize a tuple.  `newsize' will be the new length of
     the tuple.  Because tuples are `supposed' to be immutable, this
     should only be used if there is only one reference to the object.
     Do `not' use this if the tuple may already be known to some other
     part of the code.  The tuple will always grow or shrink at the end.
     Think of this as destroying the old tuple and creating a new one,
     only more efficiently.  Returns ‘0’ on success.  Client code should
     never assume that the resulting value of ‘*p’ will be the same as
     before calling this function.  If the object referenced by ‘*p’ is
     replaced, the original ‘*p’ is destroyed.  On failure, returns ‘-1’
     and sets ‘*p’ to ‘NULL’, and raises *note MemoryError: f42. or
     *note SystemError: 5f0.

 -- C Function: int PyTuple_ClearFreeList ()

     Clear the free list.  Return the total number of freed items.


File: python.info,  Node: Struct Sequence Objects,  Next: List Objects,  Prev: Tuple Objects,  Up: Sequence Objects

7.8.3.30 Struct Sequence Objects
................................

Struct sequence objects are the C equivalent of *note namedtuple(): 1b5.
objects, i.e.  a sequence whose items can also be accessed through
attributes.  To create a struct sequence, you first have to create a
specific struct sequence type.

 -- C Function: PyTypeObject* PyStructSequence_NewType
          (PyStructSequence_Desc *desc)
     `Return value: New reference.'  Create a new struct sequence type
     from the data in `desc', described below.  Instances of the
     resulting type can be created with *note PyStructSequence_New():
     3d8e.

 -- C Function: void PyStructSequence_InitType (PyTypeObject *type,
          PyStructSequence_Desc *desc)

     Initializes a struct sequence type `type' from `desc' in place.

 -- C Function: int PyStructSequence_InitType2 (PyTypeObject *type,
          PyStructSequence_Desc *desc)

     The same as ‘PyStructSequence_InitType’, but returns ‘0’ on success
     and ‘-1’ on failure.

     New in version 3.4.

 -- C Type: PyStructSequence_Desc

     Contains the meta information of a struct sequence type to create.

     Field                   C Type                             Meaning
                                                                
     ------------------------------------------------------------------------------------------------------
                                                                
     ‘name’                  ‘const char *’                     name of the struct sequence type
                                                                
                                                                
     ‘doc’                   ‘const char *’                     pointer to docstring for the type or
                                                                ‘NULL’ to omit
                                                                
                                                                
     ‘fields’                ‘PyStructSequence_Field *’         pointer to ‘NULL’-terminated array with
                                                                field names of the new type
                                                                
                                                                
     ‘n_in_sequence’         ‘int’                              number of fields visible to the Python
                                                                side (if used as tuple)
                                                                

 -- C Type: PyStructSequence_Field

     Describes a field of a struct sequence.  As a struct sequence is
     modeled as a tuple, all fields are typed as *note PyObject*: 4b0.
     The index in the ‘fields’ array of the *note PyStructSequence_Desc:
     41e. determines which field of the struct sequence is described.

     Field           C Type                 Meaning
                                            
     -------------------------------------------------------------------------------------
                                            
     ‘name’          ‘const char *’         name for the field or ‘NULL’ to end the
                                            list of named fields, set to
                                            *note PyStructSequence_UnnamedField: 3d8f.
                                            to leave unnamed
                                            
                                            
     ‘doc’           ‘const char *’         field docstring or ‘NULL’ to omit
                                            

 -- C Variable: char* PyStructSequence_UnnamedField

     Special value for a field name to leave it unnamed.

 -- C Function: PyObject* PyStructSequence_New (PyTypeObject *type)
     `Return value: New reference.'  Creates an instance of `type',
     which must have been created with *note PyStructSequence_NewType():
     3d8d.

 -- C Function: PyObject* PyStructSequence_GetItem (PyObject *p,
          Py_ssize_t pos)
     `Return value: Borrowed reference.'  Return the object at position
     `pos' in the struct sequence pointed to by `p'.  No bounds checking
     is performed.

 -- C Function: PyObject* PyStructSequence_GET_ITEM (PyObject *p,
          Py_ssize_t pos)
     `Return value: Borrowed reference.'  Macro equivalent of *note
     PyStructSequence_GetItem(): 3d90.

 -- C Function: void PyStructSequence_SetItem (PyObject *p,
          Py_ssize_t pos, PyObject *o)

     Sets the field at index `pos' of the struct sequence `p' to value
     `o'.  Like *note PyTuple_SET_ITEM(): 3d8a, this should only be used
     to fill in brand new instances.

          Note: This function “steals” a reference to `o'.

 -- C Function: void PyStructSequence_SET_ITEM (PyObject *p,
          Py_ssize_t *pos, PyObject *o)

     Macro equivalent of *note PyStructSequence_SetItem(): 3d92.

          Note: This function “steals” a reference to `o'.


File: python.info,  Node: List Objects,  Prev: Struct Sequence Objects,  Up: Sequence Objects

7.8.3.31 List Objects
.....................

 -- C Type: PyListObject

     This subtype of *note PyObject: 4b0. represents a Python list
     object.

 -- C Variable: PyTypeObject PyList_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     list type.  This is the same object as *note list: 260. in the
     Python layer.

 -- C Function: int PyList_Check (PyObject *p)

     Return true if `p' is a list object or an instance of a subtype of
     the list type.

 -- C Function: int PyList_CheckExact (PyObject *p)

     Return true if `p' is a list object, but not an instance of a
     subtype of the list type.

 -- C Function: PyObject* PyList_New (Py_ssize_t len)
     `Return value: New reference.'  Return a new list of length `len'
     on success, or ‘NULL’ on failure.

          Note: If `len' is greater than zero, the returned list
          object’s items are set to ‘NULL’.  Thus you cannot use
          abstract API functions such as *note PySequence_SetItem():
          f87. or expose the object to Python code before setting all
          items to a real object with *note PyList_SetItem(): 3a66.

 -- C Function: Py_ssize_t PyList_Size (PyObject *list)

     Return the length of the list object in `list'; this is equivalent
     to ‘len(list)’ on a list object.

 -- C Function: Py_ssize_t PyList_GET_SIZE (PyObject *list)

     Macro form of *note PyList_Size(): d71. without error checking.

 -- C Function: PyObject* PyList_GetItem (PyObject *list,
          Py_ssize_t index)
     `Return value: Borrowed reference.'  Return the object at position
     `index' in the list pointed to by `list'.  The position must be
     non-negative; indexing from the end of the list is not supported.
     If `index' is out of bounds (<0 or >=len(list)), return ‘NULL’ and
     set an *note IndexError: e69. exception.

 -- C Function: PyObject* PyList_GET_ITEM (PyObject *list, Py_ssize_t i)
     `Return value: Borrowed reference.'  Macro form of *note
     PyList_GetItem(): 3a61. without error checking.

 -- C Function: int PyList_SetItem (PyObject *list, Py_ssize_t index,
          PyObject *item)

     Set the item at index `index' in list to `item'.  Return ‘0’ on
     success.  If `index' is out of bounds, return ‘-1’ and set an *note
     IndexError: e69. exception.

          Note: This function “steals” a reference to `item' and
          discards a reference to an item already in the list at the
          affected position.

 -- C Function: void PyList_SET_ITEM (PyObject *list, Py_ssize_t i,
          PyObject *o)

     Macro form of *note PyList_SetItem(): 3a66. without error checking.
     This is normally only used to fill in new lists where there is no
     previous content.

          Note: This macro “steals” a reference to `item', and, unlike
          *note PyList_SetItem(): 3a66, does `not' discard a reference
          to any item that is being replaced; any reference in `list' at
          position `i' will be leaked.

 -- C Function: int PyList_Insert (PyObject *list, Py_ssize_t index,
          PyObject *item)

     Insert the item `item' into list `list' in front of index `index'.
     Return ‘0’ if successful; return ‘-1’ and set an exception if
     unsuccessful.  Analogous to ‘list.insert(index, item)’.

 -- C Function: int PyList_Append (PyObject *list, PyObject *item)

     Append the object `item' at the end of list `list'.  Return ‘0’ if
     successful; return ‘-1’ and set an exception if unsuccessful.
     Analogous to ‘list.append(item)’.

 -- C Function: PyObject* PyList_GetSlice (PyObject *list,
          Py_ssize_t low, Py_ssize_t high)
     `Return value: New reference.'  Return a list of the objects in
     `list' containing the objects `between' `low' and `high'.  Return
     ‘NULL’ and set an exception if unsuccessful.  Analogous to
     ‘list[low:high]’.  Indexing from the end of the list is not
     supported.

 -- C Function: int PyList_SetSlice (PyObject *list, Py_ssize_t low,
          Py_ssize_t high, PyObject *itemlist)

     Set the slice of `list' between `low' and `high' to the contents of
     `itemlist'.  Analogous to ‘list[low:high] = itemlist’.  The
     `itemlist' may be ‘NULL’, indicating the assignment of an empty
     list (slice deletion).  Return ‘0’ on success, ‘-1’ on failure.
     Indexing from the end of the list is not supported.

 -- C Function: int PyList_Sort (PyObject *list)

     Sort the items of `list' in place.  Return ‘0’ on success, ‘-1’ on
     failure.  This is equivalent to ‘list.sort()’.

 -- C Function: int PyList_Reverse (PyObject *list)

     Reverse the items of `list' in place.  Return ‘0’ on success, ‘-1’
     on failure.  This is the equivalent of ‘list.reverse()’.

 -- C Function: PyObject* PyList_AsTuple (PyObject *list)
     `Return value: New reference.'

     Return a new tuple object containing the contents of `list';
     equivalent to ‘tuple(list)’.

 -- C Function: int PyList_ClearFreeList ()

     Clear the free list.  Return the total number of freed items.

     New in version 3.3.


File: python.info,  Node: Container Objects,  Next: Function Objects<2>,  Prev: Sequence Objects,  Up: Concrete Objects Layer

7.8.4 Container Objects
-----------------------

* Menu:

* Dictionary Objects::
* Set Objects::


File: python.info,  Node: Dictionary Objects,  Next: Set Objects,  Up: Container Objects

7.8.4.1 Dictionary Objects
..........................

 -- C Type: PyDictObject

     This subtype of *note PyObject: 4b0. represents a Python dictionary
     object.

 -- C Variable: PyTypeObject PyDict_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     dictionary type.  This is the same object as *note dict: 1b6. in
     the Python layer.

 -- C Function: int PyDict_Check (PyObject *p)

     Return true if `p' is a dict object or an instance of a subtype of
     the dict type.

 -- C Function: int PyDict_CheckExact (PyObject *p)

     Return true if `p' is a dict object, but not an instance of a
     subtype of the dict type.

 -- C Function: PyObject* PyDict_New ()
     `Return value: New reference.'  Return a new empty dictionary, or
     ‘NULL’ on failure.

 -- C Function: PyObject* PyDictProxy_New (PyObject *mapping)
     `Return value: New reference.'  Return a *note
     types.MappingProxyType: aab. object for a mapping which enforces
     read-only behavior.  This is normally used to create a view to
     prevent modification of the dictionary for non-dynamic class types.

 -- C Function: void PyDict_Clear (PyObject *p)

     Empty an existing dictionary of all key-value pairs.

 -- C Function: int PyDict_Contains (PyObject *p, PyObject *key)

     Determine if dictionary `p' contains `key'.  If an item in `p' is
     matches `key', return ‘1’, otherwise return ‘0’.  On error, return
     ‘-1’.  This is equivalent to the Python expression ‘key in p’.

 -- C Function: PyObject* PyDict_Copy (PyObject *p)
     `Return value: New reference.'  Return a new dictionary that
     contains the same key-value pairs as `p'.

 -- C Function: int PyDict_SetItem (PyObject *p, PyObject *key,
          PyObject *val)

     Insert `value' into the dictionary `p' with a key of `key'.  `key'
     must be *note hashable: 1364.; if it isn’t, *note TypeError: 192.
     will be raised.  Return ‘0’ on success or ‘-1’ on failure.

 -- C Function: int PyDict_SetItemString (PyObject *p, const char *key,
          PyObject *val)

     Insert `value' into the dictionary `p' using `key' as a key.  `key'
     should be a ‘const char*’.  The key object is created using
     ‘PyUnicode_FromString(key)’.  Return ‘0’ on success or ‘-1’ on
     failure.

 -- C Function: int PyDict_DelItem (PyObject *p, PyObject *key)

     Remove the entry in dictionary `p' with key `key'.  `key' must be
     hashable; if it isn’t, *note TypeError: 192. is raised.  Return ‘0’
     on success or ‘-1’ on failure.

 -- C Function: int PyDict_DelItemString (PyObject *p, const char *key)

     Remove the entry in dictionary `p' which has a key specified by the
     string `key'.  Return ‘0’ on success or ‘-1’ on failure.

 -- C Function: PyObject* PyDict_GetItem (PyObject *p, PyObject *key)
     `Return value: Borrowed reference.'  Return the object from
     dictionary `p' which has a key `key'.  Return ‘NULL’ if the key
     `key' is not present, but `without' setting an exception.

     Note that exceptions which occur while calling *note __hash__():
     335. and *note __eq__(): 334. methods will get suppressed.  To get
     error reporting use *note PyDict_GetItemWithError(): 3db4. instead.

 -- C Function: PyObject* PyDict_GetItemWithError (PyObject *p,
          PyObject *key)
     `Return value: Borrowed reference.'  Variant of *note
     PyDict_GetItem(): 3a62. that does not suppress exceptions.  Return
     ‘NULL’ `with' an exception set if an exception occurred.  Return
     ‘NULL’ `without' an exception set if the key wasn’t present.

 -- C Function: PyObject* PyDict_GetItemString (PyObject *p, const
          char *key)
     `Return value: Borrowed reference.'  This is the same as *note
     PyDict_GetItem(): 3a62, but `key' is specified as a ‘const char*’,
     rather than a *note PyObject*: 4b0.

     Note that exceptions which occur while calling *note __hash__():
     335. and *note __eq__(): 334. methods and creating a temporary
     string object will get suppressed.  To get error reporting use
     *note PyDict_GetItemWithError(): 3db4. instead.

 -- C Function: PyObject* PyDict_SetDefault (PyObject *p, PyObject *key,
          PyObject *defaultobj)
     `Return value: Borrowed reference.'  This is the same as the
     Python-level *note dict.setdefault(): 9b3.  If present, it returns
     the value corresponding to `key' from the dictionary `p'.  If the
     key is not in the dict, it is inserted with value `defaultobj' and
     `defaultobj' is returned.  This function evaluates the hash
     function of `key' only once, instead of evaluating it independently
     for the lookup and the insertion.

     New in version 3.4.

 -- C Function: PyObject* PyDict_Items (PyObject *p)
     `Return value: New reference.'  Return a *note PyListObject: 3c48.
     containing all the items from the dictionary.

 -- C Function: PyObject* PyDict_Keys (PyObject *p)
     `Return value: New reference.'  Return a *note PyListObject: 3c48.
     containing all the keys from the dictionary.

 -- C Function: PyObject* PyDict_Values (PyObject *p)
     `Return value: New reference.'  Return a *note PyListObject: 3c48.
     containing all the values from the dictionary `p'.

 -- C Function: Py_ssize_t PyDict_Size (PyObject *p)

     Return the number of items in the dictionary.  This is equivalent
     to ‘len(p)’ on a dictionary.

 -- C Function: int PyDict_Next (PyObject *p, Py_ssize_t *ppos,
          PyObject **pkey, PyObject **pvalue)

     Iterate over all key-value pairs in the dictionary `p'.  The
     ‘Py_ssize_t’ referred to by `ppos' must be initialized to ‘0’ prior
     to the first call to this function to start the iteration; the
     function returns true for each pair in the dictionary, and false
     once all pairs have been reported.  The parameters `pkey' and
     `pvalue' should either point to *note PyObject*: 4b0. variables
     that will be filled in with each key and value, respectively, or
     may be ‘NULL’.  Any references returned through them are borrowed.
     `ppos' should not be altered during iteration.  Its value
     represents offsets within the internal dictionary structure, and
     since the structure is sparse, the offsets are not consecutive.

     For example:

          PyObject *key, *value; Py_ssize_t pos = 0;  while (PyDict_Next(self->dict, &pos, &key, &value)) {     /* do something interesting with the values... */     ... }

     The dictionary `p' should not be mutated during iteration.  It is
     safe to modify the values of the keys as you iterate over the
     dictionary, but only so long as the set of keys does not change.
     For example:

          PyObject *key, *value; Py_ssize_t pos = 0;  while (PyDict_Next(self->dict, &pos, &key, &value)) {     long i = PyLong_AsLong(value);     if (i == -1 && PyErr_Occurred()) {         return -1;     }     PyObject *o = PyLong_FromLong(i + 1);     if (o == NULL)         return -1;     if (PyDict_SetItem(self->dict, key, o) < 0) {         Py_DECREF(o);         return -1;     }     Py_DECREF(o); }

 -- C Function: int PyDict_Merge (PyObject *a, PyObject *b,
          int override)

     Iterate over mapping object `b' adding key-value pairs to
     dictionary `a'.  `b' may be a dictionary, or any object supporting
     *note PyMapping_Keys(): 421. and *note PyObject_GetItem(): 3af6.
     If `override' is true, existing pairs in `a' will be replaced if a
     matching key is found in `b', otherwise pairs will only be added if
     there is not a matching key in `a'.  Return ‘0’ on success or ‘-1’
     if an exception was raised.

 -- C Function: int PyDict_Update (PyObject *a, PyObject *b)

     This is the same as ‘PyDict_Merge(a, b, 1)’ in C, and is similar to
     ‘a.update(b)’ in Python except that *note PyDict_Update(): 3dbc.
     doesn’t fall back to the iterating over a sequence of key value
     pairs if the second argument has no “keys” attribute.  Return ‘0’
     on success or ‘-1’ if an exception was raised.

 -- C Function: int PyDict_MergeFromSeq2 (PyObject *a, PyObject *seq2,
          int override)

     Update or merge into dictionary `a', from the key-value pairs in
     `seq2'.  `seq2' must be an iterable object producing iterable
     objects of length 2, viewed as key-value pairs.  In case of
     duplicate keys, the last wins if `override' is true, else the first
     wins.  Return ‘0’ on success or ‘-1’ if an exception was raised.
     Equivalent Python (except for the return value):

          def PyDict_MergeFromSeq2(a, seq2, override):     for key, value in seq2:         if override or key not in a:             a[key] = value

 -- C Function: int PyDict_ClearFreeList ()

     Clear the free list.  Return the total number of freed items.

     New in version 3.3.


File: python.info,  Node: Set Objects,  Prev: Dictionary Objects,  Up: Container Objects

7.8.4.2 Set Objects
...................

This section details the public API for *note set: b62. and *note
frozenset: be1. objects.  Any functionality not listed below is best
accessed using the either the abstract object protocol (including *note
PyObject_CallMethod(): 3c04, *note PyObject_RichCompareBool(): 3aab,
*note PyObject_Hash(): 3c0a, *note PyObject_Repr(): 95c, *note
PyObject_IsTrue(): 3c0b, *note PyObject_Print(): f84, and *note
PyObject_GetIter(): 3c12.) or the abstract number protocol (including
*note PyNumber_And(): 3c24, *note PyNumber_Subtract(): 3c17, *note
PyNumber_Or(): 3c26, *note PyNumber_Xor(): 3c25, *note
PyNumber_InPlaceAnd(): 3c30, *note PyNumber_InPlaceSubtract(): 3c28,
*note PyNumber_InPlaceOr(): 3c32, and *note PyNumber_InPlaceXor():
3c31.).

 -- C Type: PySetObject

     This subtype of *note PyObject: 4b0. is used to hold the internal
     data for both *note set: b62. and *note frozenset: be1. objects.
     It is like a *note PyDictObject: 3da9. in that it is a fixed size
     for small sets (much like tuple storage) and will point to a
     separate, variable sized block of memory for medium and large sized
     sets (much like list storage).  None of the fields of this
     structure should be considered public and are subject to change.
     All access should be done through the documented API rather than by
     manipulating the values in the structure.

 -- C Variable: PyTypeObject PySet_Type

     This is an instance of *note PyTypeObject: 2d4. representing the
     Python *note set: b62. type.

 -- C Variable: PyTypeObject PyFrozenSet_Type

     This is an instance of *note PyTypeObject: 2d4. representing the
     Python *note frozenset: be1. type.

The following type check macros work on pointers to any Python object.
Likewise, the constructor functions work with any iterable Python
object.

 -- C Function: int PySet_Check (PyObject *p)

     Return true if `p' is a *note set: b62. object or an instance of a
     subtype.

 -- C Function: int PyFrozenSet_Check (PyObject *p)

     Return true if `p' is a *note frozenset: be1. object or an instance
     of a subtype.

 -- C Function: int PyAnySet_Check (PyObject *p)

     Return true if `p' is a *note set: b62. object, a *note frozenset:
     be1. object, or an instance of a subtype.

 -- C Function: int PyAnySet_CheckExact (PyObject *p)

     Return true if `p' is a *note set: b62. object or a *note
     frozenset: be1. object but not an instance of a subtype.

 -- C Function: int PyFrozenSet_CheckExact (PyObject *p)

     Return true if `p' is a *note frozenset: be1. object but not an
     instance of a subtype.

 -- C Function: PyObject* PySet_New (PyObject *iterable)
     `Return value: New reference.'  Return a new *note set: b62.
     containing objects returned by the `iterable'.  The `iterable' may
     be ‘NULL’ to create a new empty set.  Return the new set on success
     or ‘NULL’ on failure.  Raise *note TypeError: 192. if `iterable' is
     not actually iterable.  The constructor is also useful for copying
     a set (‘c=set(s)’).

 -- C Function: PyObject* PyFrozenSet_New (PyObject *iterable)
     `Return value: New reference.'  Return a new *note frozenset: be1.
     containing objects returned by the `iterable'.  The `iterable' may
     be ‘NULL’ to create a new empty frozenset.  Return the new set on
     success or ‘NULL’ on failure.  Raise *note TypeError: 192. if
     `iterable' is not actually iterable.

The following functions and macros are available for instances of *note
set: b62. or *note frozenset: be1. or instances of their subtypes.

 -- C Function: Py_ssize_t PySet_Size (PyObject *anyset)

     Return the length of a *note set: b62. or *note frozenset: be1.
     object.  Equivalent to ‘len(anyset)’.  Raises a ‘PyExc_SystemError’
     if `anyset' is not a *note set: b62, *note frozenset: be1, or an
     instance of a subtype.

 -- C Function: Py_ssize_t PySet_GET_SIZE (PyObject *anyset)

     Macro form of *note PySet_Size(): da3. without error checking.

 -- C Function: int PySet_Contains (PyObject *anyset, PyObject *key)

     Return ‘1’ if found, ‘0’ if not found, and ‘-1’ if an error is
     encountered.  Unlike the Python *note __contains__(): d1b. method,
     this function does not automatically convert unhashable sets into
     temporary frozensets.  Raise a *note TypeError: 192. if the `key'
     is unhashable.  Raise ‘PyExc_SystemError’ if `anyset' is not a
     *note set: b62, *note frozenset: be1, or an instance of a subtype.

 -- C Function: int PySet_Add (PyObject *set, PyObject *key)

     Add `key' to a *note set: b62. instance.  Also works with *note
     frozenset: be1. instances (like *note PyTuple_SetItem(): 3a65. it
     can be used to fill-in the values of brand new frozensets before
     they are exposed to other code).  Return ‘0’ on success or ‘-1’ on
     failure.  Raise a *note TypeError: 192. if the `key' is unhashable.
     Raise a *note MemoryError: f42. if there is no room to grow.  Raise
     a *note SystemError: 5f0. if `set' is not an instance of *note set:
     b62. or its subtype.

The following functions are available for instances of *note set: b62.
or its subtypes but not for instances of *note frozenset: be1. or its
subtypes.

 -- C Function: int PySet_Discard (PyObject *set, PyObject *key)

     Return ‘1’ if found and removed, ‘0’ if not found (no action
     taken), and ‘-1’ if an error is encountered.  Does not raise *note
     KeyError: 2c5. for missing keys.  Raise a *note TypeError: 192. if
     the `key' is unhashable.  Unlike the Python ‘discard()’ method,
     this function does not automatically convert unhashable sets into
     temporary frozensets.  Raise ‘PyExc_SystemError’ if `set' is not an
     instance of *note set: b62. or its subtype.

 -- C Function: PyObject* PySet_Pop (PyObject *set)
     `Return value: New reference.'  Return a new reference to an
     arbitrary object in the `set', and removes the object from the
     `set'.  Return ‘NULL’ on failure.  Raise *note KeyError: 2c5. if
     the set is empty.  Raise a *note SystemError: 5f0. if `set' is not
     an instance of *note set: b62. or its subtype.

 -- C Function: int PySet_Clear (PyObject *set)

     Empty an existing set of all elements.

 -- C Function: int PySet_ClearFreeList ()

     Clear the free list.  Return the total number of freed items.

     New in version 3.3.


File: python.info,  Node: Function Objects<2>,  Next: Other Objects,  Prev: Container Objects,  Up: Concrete Objects Layer

7.8.5 Function Objects
----------------------

* Menu:

* Function Objects: Function Objects<3>.
* Instance Method Objects::
* Method Objects: Method Objects<2>.
* Cell Objects::
* Code Objects: Code Objects<2>.


File: python.info,  Node: Function Objects<3>,  Next: Instance Method Objects,  Up: Function Objects<2>

7.8.5.1 Function Objects
........................

There are a few functions specific to Python functions.

 -- C Type: PyFunctionObject

     The C structure used for functions.

 -- C Variable: PyTypeObject PyFunction_Type

     This is an instance of *note PyTypeObject: 2d4. and represents the
     Python function type.  It is exposed to Python programmers as
     ‘types.FunctionType’.

 -- C Function: int PyFunction_Check (PyObject *o)

     Return true if `o' is a function object (has type *note
     PyFunction_Type: 3dd4.).  The parameter must not be ‘NULL’.

 -- C Function: PyObject* PyFunction_New (PyObject *code,
          PyObject *globals)
     `Return value: New reference.'  Return a new function object
     associated with the code object `code'.  `globals' must be a
     dictionary with the global variables accessible to the function.

     The function’s docstring and name are retrieved from the code
     object.  `__module__' is retrieved from `globals'.  The argument
     defaults, annotations and closure are set to ‘NULL’.
     `__qualname__' is set to the same value as the function’s name.

 -- C Function: PyObject* PyFunction_NewWithQualName (PyObject *code,
          PyObject *globals, PyObject *qualname)
     `Return value: New reference.'  As *note PyFunction_New(): 3dd6,
     but also allows setting the function object’s ‘__qualname__’
     attribute.  `qualname' should be a unicode object or ‘NULL’; if
     ‘NULL’, the ‘__qualname__’ attribute is set to the same value as
     its ‘__name__’ attribute.

     New in version 3.3.

 -- C Function: PyObject* PyFunction_GetCode (PyObject *op)
     `Return value: Borrowed reference.'  Return the code object
     associated with the function object `op'.

 -- C Function: PyObject* PyFunction_GetGlobals (PyObject *op)
     `Return value: Borrowed reference.'  Return the globals dictionary
     associated with the function object `op'.

 -- C Function: PyObject* PyFunction_GetModule (PyObject *op)
     `Return value: Borrowed reference.'  Return the `__module__'
     attribute of the function object `op'.  This is normally a string
     containing the module name, but can be set to any other object by
     Python code.

 -- C Function: PyObject* PyFunction_GetDefaults (PyObject *op)
     `Return value: Borrowed reference.'  Return the argument default
     values of the function object `op'.  This can be a tuple of
     arguments or ‘NULL’.

 -- C Function: int PyFunction_SetDefaults (PyObject *op,
          PyObject *defaults)

     Set the argument default values for the function object `op'.
     `defaults' must be ‘Py_None’ or a tuple.

     Raises *note SystemError: 5f0. and returns ‘-1’ on failure.

 -- C Function: PyObject* PyFunction_GetClosure (PyObject *op)
     `Return value: Borrowed reference.'  Return the closure associated
     with the function object `op'.  This can be ‘NULL’ or a tuple of
     cell objects.

 -- C Function: int PyFunction_SetClosure (PyObject *op,
          PyObject *closure)

     Set the closure associated with the function object `op'.
     `closure' must be ‘Py_None’ or a tuple of cell objects.

     Raises *note SystemError: 5f0. and returns ‘-1’ on failure.

 -- C Function: PyObject *PyFunction_GetAnnotations (PyObject *op)
     `Return value: Borrowed reference.'  Return the annotations of the
     function object `op'.  This can be a mutable dictionary or ‘NULL’.

 -- C Function: int PyFunction_SetAnnotations (PyObject *op,
          PyObject *annotations)

     Set the annotations for the function object `op'.  `annotations'
     must be a dictionary or ‘Py_None’.

     Raises *note SystemError: 5f0. and returns ‘-1’ on failure.


File: python.info,  Node: Instance Method Objects,  Next: Method Objects<2>,  Prev: Function Objects<3>,  Up: Function Objects<2>

7.8.5.2 Instance Method Objects
...............................

An instance method is a wrapper for a *note PyCFunction: dce. and the
new way to bind a *note PyCFunction: dce. to a class object.  It
replaces the former call ‘PyMethod_New(func, NULL, class)’.

 -- C Variable: PyTypeObject PyInstanceMethod_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     instance method type.  It is not exposed to Python programs.

 -- C Function: int PyInstanceMethod_Check (PyObject *o)

     Return true if `o' is an instance method object (has type *note
     PyInstanceMethod_Type: 3de4.).  The parameter must not be ‘NULL’.

 -- C Function: PyObject* PyInstanceMethod_New (PyObject *func)
     `Return value: New reference.'  Return a new instance method
     object, with `func' being any callable object `func' is the
     function that will be called when the instance method is called.

 -- C Function: PyObject* PyInstanceMethod_Function (PyObject *im)
     `Return value: Borrowed reference.'  Return the function object
     associated with the instance method `im'.

 -- C Function: PyObject* PyInstanceMethod_GET_FUNCTION (PyObject *im)
     `Return value: Borrowed reference.'  Macro version of *note
     PyInstanceMethod_Function(): 3de7. which avoids error checking.


File: python.info,  Node: Method Objects<2>,  Next: Cell Objects,  Prev: Instance Method Objects,  Up: Function Objects<2>

7.8.5.3 Method Objects
......................

Methods are bound function objects.  Methods are always bound to an
instance of a user-defined class.  Unbound methods (methods bound to a
class object) are no longer available.

 -- C Variable: PyTypeObject PyMethod_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     method type.  This is exposed to Python programs as
     ‘types.MethodType’.

 -- C Function: int PyMethod_Check (PyObject *o)

     Return true if `o' is a method object (has type *note
     PyMethod_Type: 3deb.).  The parameter must not be ‘NULL’.

 -- C Function: PyObject* PyMethod_New (PyObject *func, PyObject *self)
     `Return value: New reference.'  Return a new method object, with
     `func' being any callable object and `self' the instance the method
     should be bound.  `func' is the function that will be called when
     the method is called.  `self' must not be ‘NULL’.

 -- C Function: PyObject* PyMethod_Function (PyObject *meth)
     `Return value: Borrowed reference.'  Return the function object
     associated with the method `meth'.

 -- C Function: PyObject* PyMethod_GET_FUNCTION (PyObject *meth)
     `Return value: Borrowed reference.'  Macro version of *note
     PyMethod_Function(): 3dee. which avoids error checking.

 -- C Function: PyObject* PyMethod_Self (PyObject *meth)
     `Return value: Borrowed reference.'  Return the instance associated
     with the method `meth'.

 -- C Function: PyObject* PyMethod_GET_SELF (PyObject *meth)
     `Return value: Borrowed reference.'  Macro version of *note
     PyMethod_Self(): 3df0. which avoids error checking.

 -- C Function: int PyMethod_ClearFreeList ()

     Clear the free list.  Return the total number of freed items.


File: python.info,  Node: Cell Objects,  Next: Code Objects<2>,  Prev: Method Objects<2>,  Up: Function Objects<2>

7.8.5.4 Cell Objects
....................

“Cell” objects are used to implement variables referenced by multiple
scopes.  For each such variable, a cell object is created to store the
value; the local variables of each stack frame that references the value
contains a reference to the cells from outer scopes which also use that
variable.  When the value is accessed, the value contained in the cell
is used instead of the cell object itself.  This de-referencing of the
cell object requires support from the generated byte-code; these are not
automatically de-referenced when accessed.  Cell objects are not likely
to be useful elsewhere.

 -- C Type: PyCellObject

     The C structure used for cell objects.

 -- C Variable: PyTypeObject PyCell_Type

     The type object corresponding to cell objects.

 -- C Function: int PyCell_Check (ob)

     Return true if `ob' is a cell object; `ob' must not be ‘NULL’.

 -- C Function: PyObject* PyCell_New (PyObject *ob)
     `Return value: New reference.'  Create and return a new cell object
     containing the value `ob'.  The parameter may be ‘NULL’.

 -- C Function: PyObject* PyCell_Get (PyObject *cell)
     `Return value: New reference.'  Return the contents of the cell
     `cell'.

 -- C Function: PyObject* PyCell_GET (PyObject *cell)
     `Return value: Borrowed reference.'  Return the contents of the
     cell `cell', but without checking that `cell' is non-‘NULL’ and a
     cell object.

 -- C Function: int PyCell_Set (PyObject *cell, PyObject *value)

     Set the contents of the cell object `cell' to `value'.  This
     releases the reference to any current content of the cell.  `value'
     may be ‘NULL’.  `cell' must be non-‘NULL’; if it is not a cell
     object, ‘-1’ will be returned.  On success, ‘0’ will be returned.

 -- C Function: void PyCell_SET (PyObject *cell, PyObject *value)

     Sets the value of the cell object `cell' to `value'.  No reference
     counts are adjusted, and no checks are made for safety; `cell' must
     be non-‘NULL’ and must be a cell object.


File: python.info,  Node: Code Objects<2>,  Prev: Cell Objects,  Up: Function Objects<2>

7.8.5.5 Code Objects
....................

Code objects are a low-level detail of the CPython implementation.  Each
one represents a chunk of executable code that hasn’t yet been bound
into a function.

 -- C Type: PyCodeObject

     The C structure of the objects used to describe code objects.  The
     fields of this type are subject to change at any time.

 -- C Variable: PyTypeObject PyCode_Type

     This is an instance of *note PyTypeObject: 2d4. representing the
     Python *note code: 1b. type.

 -- C Function: int PyCode_Check (PyObject *co)

     Return true if `co' is a *note code: 1b. object.

 -- C Function: int PyCode_GetNumFree (PyCodeObject *co)

     Return the number of free variables in `co'.

 -- C Function: PyCodeObject* PyCode_New (int argcount,
          int kwonlyargcount, int nlocals, int stacksize, int flags,
          PyObject *code, PyObject *consts, PyObject *names,
          PyObject *varnames, PyObject *freevars, PyObject *cellvars,
          PyObject *filename, PyObject *name, int firstlineno,
          PyObject *lnotab)
     `Return value: New reference.'  Return a new code object.  If you
     need a dummy code object to create a frame, use *note
     PyCode_NewEmpty(): cdd. instead.  Calling *note PyCode_New(): 270.
     directly can bind you to a precise Python version since the
     definition of the bytecode changes often.

 -- C Function: PyCodeObject* PyCode_NewWithPosOnlyArgs (int argcount,
          int posonlyargcount, int kwonlyargcount, int nlocals,
          int stacksize, int flags, PyObject *code, PyObject *consts,
          PyObject *names, PyObject *varnames, PyObject *freevars,
          PyObject *cellvars, PyObject *filename, PyObject *name,
          int firstlineno, PyObject *lnotab)
     `Return value: New reference.'  Similar to *note PyCode_New(): 270,
     but with an extra “posonlyargcount” for positonal-only arguments.

     New in version 3.8.

 -- C Function: PyCodeObject* PyCode_NewEmpty (const char *filename,
          const char *funcname, int firstlineno)
     `Return value: New reference.'  Return a new empty code object with
     the specified filename, function name, and first line number.  It
     is illegal to *note exec(): c37. or *note eval(): b83. the
     resulting code object.


File: python.info,  Node: Other Objects,  Prev: Function Objects<2>,  Up: Concrete Objects Layer

7.8.6 Other Objects
-------------------

* Menu:

* File Objects::
* Module Objects::
* Iterator Objects::
* Descriptor Objects::
* Slice Objects::
* Ellipsis Object::
* MemoryView objects::
* Weak Reference Objects: Weak Reference Objects<2>.
* Capsules: Capsules<2>.
* Generator Objects::
* Coroutine Objects: Coroutine Objects<2>.
* Context Variables Objects::
* DateTime Objects: DateTime Objects<2>.


File: python.info,  Node: File Objects,  Next: Module Objects,  Up: Other Objects

7.8.6.1 File Objects
....................

These APIs are a minimal emulation of the Python 2 C API for built-in
file objects, which used to rely on the buffered I/O (‘FILE*’) support
from the C standard library.  In Python 3, files and streams use the new
*note io: a1. module, which defines several layers over the low-level
unbuffered I/O of the operating system.  The functions described below
are convenience C wrappers over these new APIs, and meant mostly for
internal error reporting in the interpreter; third-party code is advised
to access the *note io: a1. APIs instead.

 -- C Function: PyFile_FromFd (int fd, const char *name, const
          char *mode, int buffering, const char *encoding, const
          char *errors, const char *newline, int closefd)
     `Return value: New reference.'  Create a Python file object from
     the file descriptor of an already opened file `fd'.  The arguments
     `name', `encoding', `errors' and `newline' can be ‘NULL’ to use the
     defaults; `buffering' can be `-1' to use the default.  `name' is
     ignored and kept for backward compatibility.  Return ‘NULL’ on
     failure.  For a more comprehensive description of the arguments,
     please refer to the *note io.open(): 64e. function documentation.

          Warning: Since Python streams have their own buffering layer,
          mixing them with OS-level file descriptors can produce various
          issues (such as unexpected ordering of data).

     Changed in version 3.2: Ignore `name' attribute.

 -- C Function: int PyObject_AsFileDescriptor (PyObject *p)

     Return the file descriptor associated with `p' as an ‘int’.  If the
     object is an integer, its value is returned.  If not, the object’s
     *note fileno(): 1e46. method is called if it exists; the method
     must return an integer, which is returned as the file descriptor
     value.  Sets an exception and returns ‘-1’ on failure.

 -- C Function: PyObject* PyFile_GetLine (PyObject *p, int n)
     `Return value: New reference.'

     Equivalent to ‘p.readline([n])’, this function reads one line from
     the object `p'.  `p' may be a file object or any object with a
     *note readline(): 163f. method.  If `n' is ‘0’, exactly one line is
     read, regardless of the length of the line.  If `n' is greater than
     ‘0’, no more than `n' bytes will be read from the file; a partial
     line can be returned.  In both cases, an empty string is returned
     if the end of the file is reached immediately.  If `n' is less than
     ‘0’, however, one line is read regardless of length, but *note
     EOFError: c5f. is raised if the end of the file is reached
     immediately.

 -- C Function: int PyFile_SetOpenCodeHook
          (Py_OpenCodeHookFunction handler)

     Overrides the normal behavior of *note io.open_code(): e89. to pass
     its parameter through the provided handler.

     The handler is a function of type ‘PyObject *(*)(PyObject *path,
     void *userData)’, where `path' is guaranteed to be *note
     PyUnicodeObject: 3d29.

     The `userData' pointer is passed into the hook function.  Since
     hook functions may be called from different runtimes, this pointer
     should not refer directly to Python state.

     As this hook is intentionally used during import, avoid importing
     new modules during its execution unless they are known to be frozen
     or available in ‘sys.modules’.

     Once a hook has been set, it cannot be removed or replaced, and
     later calls to *note PyFile_SetOpenCodeHook(): 1f24. will fail.  On
     failure, the function returns -1 and sets an exception if the
     interpreter has been initialized.

     This function is safe to call before *note Py_Initialize(): 42e.

     New in version 3.8.

 -- C Function: int PyFile_WriteObject (PyObject *obj, PyObject *p,
          int flags)

     Write object `obj' to file object `p'.  The only supported flag for
     `flags' is ‘Py_PRINT_RAW’; if given, the *note str(): 325. of the
     object is written instead of the *note repr(): 7c0.  Return ‘0’ on
     success or ‘-1’ on failure; the appropriate exception will be set.

 -- C Function: int PyFile_WriteString (const char *s, PyObject *p)

     Write string `s' to file object `p'.  Return ‘0’ on success or ‘-1’
     on failure; the appropriate exception will be set.


File: python.info,  Node: Module Objects,  Next: Iterator Objects,  Prev: File Objects,  Up: Other Objects

7.8.6.2 Module Objects
......................

 -- C Variable: PyTypeObject PyModule_Type

     This instance of *note PyTypeObject: 2d4. represents the Python
     module type.  This is exposed to Python programs as
     ‘types.ModuleType’.

 -- C Function: int PyModule_Check (PyObject *p)

     Return true if `p' is a module object, or a subtype of a module
     object.

 -- C Function: int PyModule_CheckExact (PyObject *p)

     Return true if `p' is a module object, but not a subtype of *note
     PyModule_Type: 3e11.

 -- C Function: PyObject* PyModule_NewObject (PyObject *name)
     `Return value: New reference.'

     Return a new module object with the *note __name__: d05. attribute
     set to `name'.  The module’s *note __name__: d05, ‘__doc__’, *note
     __package__: 949, and *note __loader__: 94a. attributes are filled
     in (all but *note __name__: d05. are set to ‘None’); the caller is
     responsible for providing a *note __file__: 136b. attribute.

     New in version 3.3.

     Changed in version 3.4: *note __package__: 949. and *note
     __loader__: 94a. are set to ‘None’.

 -- C Function: PyObject* PyModule_New (const char *name)
     `Return value: New reference.'  Similar to *note
     PyModule_NewObject(): 3e14, but the name is a UTF-8 encoded string
     instead of a Unicode object.

 -- C Function: PyObject* PyModule_GetDict (PyObject *module)
     `Return value: Borrowed reference.'

     Return the dictionary object that implements `module'’s namespace;
     this object is the same as the *note __dict__: 4f1. attribute of
     the module object.  If `module' is not a module object (or a
     subtype of a module object), *note SystemError: 5f0. is raised and
     ‘NULL’ is returned.

     It is recommended extensions use other ‘PyModule_*()’ and
     ‘PyObject_*()’ functions rather than directly manipulate a module’s
     *note __dict__: 4f1.

 -- C Function: PyObject* PyModule_GetNameObject (PyObject *module)
     `Return value: New reference.'

     Return `module'’s *note __name__: d05. value.  If the module does
     not provide one, or if it is not a string, *note SystemError: 5f0.
     is raised and ‘NULL’ is returned.

     New in version 3.3.

 -- C Function: const char* PyModule_GetName (PyObject *module)

     Similar to *note PyModule_GetNameObject(): 3e17. but return the
     name encoded to ‘'utf-8'’.

 -- C Function: void* PyModule_GetState (PyObject *module)

     Return the “state” of the module, that is, a pointer to the block
     of memory allocated at module creation time, or ‘NULL’.  See *note
     PyModuleDef.m_size: 3e1a.

 -- C Function: PyModuleDef* PyModule_GetDef (PyObject *module)

     Return a pointer to the *note PyModuleDef: 3a8c. struct from which
     the module was created, or ‘NULL’ if the module wasn’t created from
     a definition.

 -- C Function: PyObject* PyModule_GetFilenameObject (PyObject *module)
     `Return value: New reference.'

     Return the name of the file from which `module' was loaded using
     `module'’s *note __file__: 136b. attribute.  If this is not
     defined, or if it is not a unicode string, raise *note SystemError:
     5f0. and return ‘NULL’; otherwise return a reference to a Unicode
     object.

     New in version 3.2.

 -- C Function: const char* PyModule_GetFilename (PyObject *module)

     Similar to *note PyModule_GetFilenameObject(): 3e1c. but return the
     filename encoded to ‘utf-8’.

     Deprecated since version 3.2: *note PyModule_GetFilename(): 3e1d.
     raises ‘UnicodeEncodeError’ on unencodable filenames, use *note
     PyModule_GetFilenameObject(): 3e1c. instead.

* Menu:

* Initializing C modules::
* Module lookup::


File: python.info,  Node: Initializing C modules,  Next: Module lookup,  Up: Module Objects

7.8.6.3 Initializing C modules
..............................

Modules objects are usually created from extension modules (shared
libraries which export an initialization function), or compiled-in
modules (where the initialization function is added using *note
PyImport_AppendInittab(): 3a4c.).  See *note Building C and C++
Extensions: 3a4f. or *note Extending Embedded Python: 3ad7. for details.

The initialization function can either pass a module definition instance
to *note PyModule_Create(): 3a4b, and return the resulting module
object, or request “multi-phase initialization” by returning the
definition struct itself.

 -- C Type: PyModuleDef

     The module definition struct, which holds all information needed to
     create a module object.  There is usually only one statically
     initialized variable of this type for each module.

      -- C Member: PyModuleDef_Base m_base

          Always initialize this member to ‘PyModuleDef_HEAD_INIT’.

      -- C Member: const char *m_name

          Name for the new module.

      -- C Member: const char *m_doc

          Docstring for the module; usually a docstring variable created
          with ‘PyDoc_STRVAR()’ is used.

      -- C Member: Py_ssize_t m_size

          Module state may be kept in a per-module memory area that can
          be retrieved with *note PyModule_GetState(): 3e19, rather than
          in static globals.  This makes modules safe for use in
          multiple sub-interpreters.

          This memory area is allocated based on `m_size' on module
          creation, and freed when the module object is deallocated,
          after the ‘m_free’ function has been called, if present.

          Setting ‘m_size’ to ‘-1’ means that the module does not
          support sub-interpreters, because it has global state.

          Setting it to a non-negative value means that the module can
          be re-initialized and specifies the additional amount of
          memory it requires for its state.  Non-negative ‘m_size’ is
          required for multi-phase initialization.

          See PEP 3121(1) for more details.

      -- C Member: PyMethodDef* m_methods

          A pointer to a table of module-level functions, described by
          *note PyMethodDef: e0e. values.  Can be ‘NULL’ if no functions
          are present.

      -- C Member: PyModuleDef_Slot* m_slots

          An array of slot definitions for multi-phase initialization,
          terminated by a ‘{0, NULL}’ entry.  When using single-phase
          initialization, `m_slots' must be ‘NULL’.

          Changed in version 3.5: Prior to version 3.5, this member was
          always set to ‘NULL’, and was defined as:

                -- C Member: inquiry m_reload

      -- C Member: traverseproc m_traverse

          A traversal function to call during GC traversal of the module
          object, or ‘NULL’ if not needed.  This function may be called
          before module state is allocated (*note PyModule_GetState():
          3e19. may return ‘NULL’), and before the *note Py_mod_exec:
          3e26. function is executed.

      -- C Member: inquiry m_clear

          A clear function to call during GC clearing of the module
          object, or ‘NULL’ if not needed.  This function may be called
          before module state is allocated (*note PyModule_GetState():
          3e19. may return ‘NULL’), and before the *note Py_mod_exec:
          3e26. function is executed.

      -- C Member: freefunc m_free

          A function to call during deallocation of the module object,
          or ‘NULL’ if not needed.  This function may be called before
          module state is allocated (*note PyModule_GetState(): 3e19.
          may return ‘NULL’), and before the *note Py_mod_exec: 3e26.
          function is executed.

* Menu:

* Single-phase initialization::
* Multi-phase initialization::
* Low-level module creation functions::
* Support functions::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3121


File: python.info,  Node: Single-phase initialization,  Next: Multi-phase initialization,  Up: Initializing C modules

7.8.6.4 Single-phase initialization
...................................

The module initialization function may create and return the module
object directly.  This is referred to as “single-phase initialization”,
and uses one of the following two module creation functions:

 -- C Function: PyObject* PyModule_Create (PyModuleDef *def)
     `Return value: New reference.'  Create a new module object, given
     the definition in `def'.  This behaves like *note
     PyModule_Create2(): 3e2a. with `module_api_version' set to
     ‘PYTHON_API_VERSION’.

 -- C Function: PyObject* PyModule_Create2 (PyModuleDef *def,
          int module_api_version)
     `Return value: New reference.'  Create a new module object, given
     the definition in `def', assuming the API version
     `module_api_version'.  If that version does not match the version
     of the running interpreter, a *note RuntimeWarning: 2be. is
     emitted.

          Note: Most uses of this function should be using *note
          PyModule_Create(): 3a4b. instead; only use this if you are
          sure you need it.

Before it is returned from in the initialization function, the resulting
module object is typically populated using functions like *note
PyModule_AddObject(): eaf.


File: python.info,  Node: Multi-phase initialization,  Next: Low-level module creation functions,  Prev: Single-phase initialization,  Up: Initializing C modules

7.8.6.5 Multi-phase initialization
..................................

An alternate way to specify extensions is to request “multi-phase
initialization”.  Extension modules created this way behave more like
Python modules: the initialization is split between the `creation
phase', when the module object is created, and the `execution phase',
when it is populated.  The distinction is similar to the *note
__new__(): 87d. and *note __init__(): d51. methods of classes.

Unlike modules created using single-phase initialization, these modules
are not singletons: if the `sys.modules' entry is removed and the module
is re-imported, a new module object is created, and the old module is
subject to normal garbage collection – as with Python modules.  By
default, multiple modules created from the same definition should be
independent: changes to one should not affect the others.  This means
that all state should be specific to the module object (using e.g.
using *note PyModule_GetState(): 3e19.), or its contents (such as the
module’s ‘__dict__’ or individual classes created with *note
PyType_FromSpec(): 2cf.).

All modules created using multi-phase initialization are expected to
support *note sub-interpreters: 3b85.  Making sure multiple modules are
independent is typically enough to achieve this.

To request multi-phase initialization, the initialization function
(PyInit_modulename) returns a *note PyModuleDef: 3a8c. instance with
non-empty *note m_slots: 3e23.  Before it is returned, the ‘PyModuleDef’
instance must be initialized with the following function:

 -- C Function: PyObject* PyModuleDef_Init (PyModuleDef *def)
     `Return value: Borrowed reference.'  Ensures a module definition is
     a properly initialized Python object that correctly reports its
     type and reference count.

     Returns `def' cast to ‘PyObject*’, or ‘NULL’ if an error occurred.

     New in version 3.5.

The `m_slots' member of the module definition must point to an array of
‘PyModuleDef_Slot’ structures:

 -- C Type: PyModuleDef_Slot

      -- C Member: int slot

          A slot ID, chosen from the available values explained below.

      -- C Member: void* value

          Value of the slot, whose meaning depends on the slot ID.

     New in version 3.5.

The `m_slots' array must be terminated by a slot with id 0.

The available slot types are:

 -- C Variable: Py_mod_create

     Specifies a function that is called to create the module object
     itself.  The `value' pointer of this slot must point to a function
     of the signature:

      -- C Function: PyObject* create_module (PyObject *spec,
               PyModuleDef *def)

     The function receives a *note ModuleSpec: 1403. instance, as
     defined in PEP 451(1), and the module definition.  It should return
     a new module object, or set an error and return ‘NULL’.

     This function should be kept minimal.  In particular, it should not
     call arbitrary Python code, as trying to import the same module
     again may result in an infinite loop.

     Multiple ‘Py_mod_create’ slots may not be specified in one module
     definition.

     If ‘Py_mod_create’ is not specified, the import machinery will
     create a normal module object using *note PyModule_New(): 3e15.
     The name is taken from `spec', not the definition, to allow
     extension modules to dynamically adjust to their place in the
     module hierarchy and be imported under different names through
     symlinks, all while sharing a single module definition.

     There is no requirement for the returned object to be an instance
     of *note PyModule_Type: 3e11.  Any type can be used, as long as it
     supports setting and getting import-related attributes.  However,
     only ‘PyModule_Type’ instances may be returned if the ‘PyModuleDef’
     has non-‘NULL’ ‘m_traverse’, ‘m_clear’, ‘m_free’; non-zero
     ‘m_size’; or slots other than ‘Py_mod_create’.

 -- C Variable: Py_mod_exec

     Specifies a function that is called to `execute' the module.  This
     is equivalent to executing the code of a Python module: typically,
     this function adds classes and constants to the module.  The
     signature of the function is:

      -- C Function: int exec_module (PyObject* module)

     If multiple ‘Py_mod_exec’ slots are specified, they are processed
     in the order they appear in the `m_slots' array.

See PEP 489(2) for more details on multi-phase initialization.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0451

   (2) https://www.python.org/dev/peps/pep-0489


File: python.info,  Node: Low-level module creation functions,  Next: Support functions,  Prev: Multi-phase initialization,  Up: Initializing C modules

7.8.6.6 Low-level module creation functions
...........................................

The following functions are called under the hood when using multi-phase
initialization.  They can be used directly, for example when creating
module objects dynamically.  Note that both ‘PyModule_FromDefAndSpec’
and ‘PyModule_ExecDef’ must be called to fully initialize a module.

 -- C Function: PyObject * PyModule_FromDefAndSpec (PyModuleDef *def,
          PyObject *spec)
     `Return value: New reference.'  Create a new module object, given
     the definition in `module' and the ModuleSpec `spec'.  This behaves
     like *note PyModule_FromDefAndSpec2(): 7a0. with
     `module_api_version' set to ‘PYTHON_API_VERSION’.

     New in version 3.5.

 -- C Function: PyObject * PyModule_FromDefAndSpec2 (PyModuleDef *def,
          PyObject *spec, int module_api_version)
     `Return value: New reference.'  Create a new module object, given
     the definition in `module' and the ModuleSpec `spec', assuming the
     API version `module_api_version'.  If that version does not match
     the version of the running interpreter, a *note RuntimeWarning:
     2be. is emitted.

          Note: Most uses of this function should be using *note
          PyModule_FromDefAndSpec(): 79f. instead; only use this if you
          are sure you need it.

     New in version 3.5.

 -- C Function: int PyModule_ExecDef (PyObject *module,
          PyModuleDef *def)

     Process any execution slots (*note Py_mod_exec: 3e26.) given in
     `def'.

     New in version 3.5.

 -- C Function: int PyModule_SetDocString (PyObject *module, const
          char *docstring)

     Set the docstring for `module' to `docstring'.  This function is
     called automatically when creating a module from ‘PyModuleDef’,
     using either ‘PyModule_Create’ or ‘PyModule_FromDefAndSpec’.

     New in version 3.5.

 -- C Function: int PyModule_AddFunctions (PyObject *module,
          PyMethodDef *functions)

     Add the functions from the ‘NULL’ terminated `functions' array to
     `module'.  Refer to the *note PyMethodDef: e0e. documentation for
     details on individual entries (due to the lack of a shared module
     namespace, module level “functions” implemented in C typically
     receive the module as their first parameter, making them similar to
     instance methods on Python classes).  This function is called
     automatically when creating a module from ‘PyModuleDef’, using
     either ‘PyModule_Create’ or ‘PyModule_FromDefAndSpec’.

     New in version 3.5.


File: python.info,  Node: Support functions,  Prev: Low-level module creation functions,  Up: Initializing C modules

7.8.6.7 Support functions
.........................

The module initialization function (if using single phase
initialization) or a function called from a module execution slot (if
using multi-phase initialization), can use the following functions to
help initialize the module state:

 -- C Function: int PyModule_AddObject (PyObject *module, const
          char *name, PyObject *value)

     Add an object to `module' as `name'.  This is a convenience
     function which can be used from the module’s initialization
     function.  This steals a reference to `value' on success.  Return
     ‘-1’ on error, ‘0’ on success.

          Note: Unlike other functions that steal references,
          ‘PyModule_AddObject()’ only decrements the reference count of
          `value' `on success'.

          This means that its return value must be checked, and calling
          code must *note Py_DECREF(): 264. `value' manually on error.
          Example usage:

               Py_INCREF(spam); if (PyModule_AddObject(module, "spam", spam) < 0) {     Py_DECREF(module);     Py_DECREF(spam);     return NULL; }

 -- C Function: int PyModule_AddIntConstant (PyObject *module, const
          char *name, long value)

     Add an integer constant to `module' as `name'.  This convenience
     function can be used from the module’s initialization function.
     Return ‘-1’ on error, ‘0’ on success.

 -- C Function: int PyModule_AddStringConstant (PyObject *module, const
          char *name, const char *value)

     Add a string constant to `module' as `name'.  This convenience
     function can be used from the module’s initialization function.
     The string `value' must be ‘NULL’-terminated.  Return ‘-1’ on
     error, ‘0’ on success.

 -- C Function: int PyModule_AddIntMacro (PyObject *module, macro)

     Add an int constant to `module'.  The name and the value are taken
     from `macro'.  For example ‘PyModule_AddIntMacro(module, AF_INET)’
     adds the int constant `AF_INET' with the value of `AF_INET' to
     `module'.  Return ‘-1’ on error, ‘0’ on success.

 -- C Function: int PyModule_AddStringMacro (PyObject *module, macro)

     Add a string constant to `module'.


File: python.info,  Node: Module lookup,  Prev: Initializing C modules,  Up: Module Objects

7.8.6.8 Module lookup
.....................

Single-phase initialization creates singleton modules that can be looked
up in the context of the current interpreter.  This allows the module
object to be retrieved later with only a reference to the module
definition.

These functions will not work on modules created using multi-phase
initialization, since multiple such modules can be created from a single
definition.

 -- C Function: PyObject* PyState_FindModule (PyModuleDef *def)
     `Return value: Borrowed reference.'  Returns the module object that
     was created from `def' for the current interpreter.  This method
     requires that the module object has been attached to the
     interpreter state with *note PyState_AddModule(): 3e3c. beforehand.
     In case the corresponding module object is not found or has not
     been attached to the interpreter state yet, it returns ‘NULL’.

 -- C Function: int PyState_AddModule (PyObject *module,
          PyModuleDef *def)

     Attaches the module object passed to the function to the
     interpreter state.  This allows the module object to be accessible
     via *note PyState_FindModule(): 3e3b.

     Only effective on modules created using single-phase
     initialization.

     Python calls ‘PyState_AddModule’ automatically after importing a
     module, so it is unnecessary (but harmless) to call it from module
     initialization code.  An explicit call is needed only if the
     module’s own init code subsequently calls ‘PyState_FindModule’.
     The function is mainly intended for implementing alternative import
     mechanisms (either by calling it directly, or by referring to its
     implementation for details of the required state updates).

     Return 0 on success or -1 on failure.

     New in version 3.3.

 -- C Function: int PyState_RemoveModule (PyModuleDef *def)

     Removes the module object created from `def' from the interpreter
     state.  Return 0 on success or -1 on failure.

     New in version 3.3.


File: python.info,  Node: Iterator Objects,  Next: Descriptor Objects,  Prev: Module Objects,  Up: Other Objects

7.8.6.9 Iterator Objects
........................

Python provides two general-purpose iterator objects.  The first, a
sequence iterator, works with an arbitrary sequence supporting the *note
__getitem__(): 27a. method.  The second works with a callable object and
a sentinel value, calling the callable for each item in the sequence,
and ending the iteration when the sentinel value is returned.

 -- C Variable: PyTypeObject PySeqIter_Type

     Type object for iterator objects returned by *note PySeqIter_New():
     3e42. and the one-argument form of the *note iter(): d1a. built-in
     function for built-in sequence types.

 -- C Function: int PySeqIter_Check (op)

     Return true if the type of `op' is *note PySeqIter_Type: 3e41.

 -- C Function: PyObject* PySeqIter_New (PyObject *seq)
     `Return value: New reference.'  Return an iterator that works with
     a general sequence object, `seq'.  The iteration ends when the
     sequence raises *note IndexError: e69. for the subscripting
     operation.

 -- C Variable: PyTypeObject PyCallIter_Type

     Type object for iterator objects returned by *note
     PyCallIter_New(): 3e45. and the two-argument form of the *note
     iter(): d1a. built-in function.

 -- C Function: int PyCallIter_Check (op)

     Return true if the type of `op' is *note PyCallIter_Type: 3e44.

 -- C Function: PyObject* PyCallIter_New (PyObject *callable,
          PyObject *sentinel)
     `Return value: New reference.'  Return a new iterator.  The first
     parameter, `callable', can be any Python callable object that can
     be called with no parameters; each call to it should return the
     next item in the iteration.  When `callable' returns a value equal
     to `sentinel', the iteration will be terminated.


File: python.info,  Node: Descriptor Objects,  Next: Slice Objects,  Prev: Iterator Objects,  Up: Other Objects

7.8.6.10 Descriptor Objects
...........................

“Descriptors” are objects that describe some attribute of an object.
They are found in the dictionary of type objects.

 -- C Variable: PyTypeObject PyProperty_Type

     The type object for the built-in descriptor types.

 -- C Function: PyObject* PyDescr_NewGetSet (PyTypeObject *type, struct
          PyGetSetDef *getset)
     `Return value: New reference.'

 -- C Function: PyObject* PyDescr_NewMember (PyTypeObject *type, struct
          PyMemberDef *meth)
     `Return value: New reference.'

 -- C Function: PyObject* PyDescr_NewMethod (PyTypeObject *type, struct
          PyMethodDef *meth)
     `Return value: New reference.'

 -- C Function: PyObject* PyDescr_NewWrapper (PyTypeObject *type, struct
          wrapperbase *wrapper, void *wrapped)
     `Return value: New reference.'

 -- C Function: PyObject* PyDescr_NewClassMethod (PyTypeObject *type,
          PyMethodDef *method)
     `Return value: New reference.'

 -- C Function: int PyDescr_IsData (PyObject *descr)

     Return true if the descriptor objects `descr' describes a data
     attribute, or false if it describes a method.  `descr' must be a
     descriptor object; there is no error checking.

 -- C Function: PyObject* PyWrapper_New (PyObject *, PyObject *)
     `Return value: New reference.'


File: python.info,  Node: Slice Objects,  Next: Ellipsis Object,  Prev: Descriptor Objects,  Up: Other Objects

7.8.6.11 Slice Objects
......................

 -- C Variable: PyTypeObject PySlice_Type

     The type object for slice objects.  This is the same as *note
     slice: df7. in the Python layer.

 -- C Function: int PySlice_Check (PyObject *ob)

     Return true if `ob' is a slice object; `ob' must not be ‘NULL’.

 -- C Function: PyObject* PySlice_New (PyObject *start, PyObject *stop,
          PyObject *step)
     `Return value: New reference.'  Return a new slice object with the
     given values.  The `start', `stop', and `step' parameters are used
     as the values of the slice object attributes of the same names.
     Any of the values may be ‘NULL’, in which case the ‘None’ will be
     used for the corresponding attribute.  Return ‘NULL’ if the new
     object could not be allocated.

 -- C Function: int PySlice_GetIndices (PyObject *slice,
          Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop,
          Py_ssize_t *step)

     Retrieve the start, stop and step indices from the slice object
     `slice', assuming a sequence of length `length'.  Treats indices
     greater than `length' as errors.

     Returns ‘0’ on success and ‘-1’ on error with no exception set
     (unless one of the indices was not *note None: 157. and failed to
     be converted to an integer, in which case ‘-1’ is returned with an
     exception set).

     You probably do not want to use this function.

     Changed in version 3.2: The parameter type for the `slice'
     parameter was ‘PySliceObject*’ before.

 -- C Function: int PySlice_GetIndicesEx (PyObject *slice,
          Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop,
          Py_ssize_t *step, Py_ssize_t *slicelength)

     Usable replacement for *note PySlice_GetIndices(): 3e58.  Retrieve
     the start, stop, and step indices from the slice object `slice'
     assuming a sequence of length `length', and store the length of the
     slice in `slicelength'.  Out of bounds indices are clipped in a
     manner consistent with the handling of normal slices.

     Returns ‘0’ on success and ‘-1’ on error with exception set.

          Note: This function is considered not safe for resizable
          sequences.  Its invocation should be replaced by a combination
          of *note PySlice_Unpack(): 424. and *note
          PySlice_AdjustIndices(): 425. where

               if (PySlice_GetIndicesEx(slice, length, &start, &stop, &step, &slicelength) < 0) {     // return error }

          is replaced by

               if (PySlice_Unpack(slice, &start, &stop, &step) < 0) {     // return error } slicelength = PySlice_AdjustIndices(length, &start, &stop, step);

     Changed in version 3.2: The parameter type for the `slice'
     parameter was ‘PySliceObject*’ before.

     Changed in version 3.6.1: If ‘Py_LIMITED_API’ is not set or set to
     the value between ‘0x03050400’ and ‘0x03060000’ (not including) or
     ‘0x03060100’ or higher ‘PySlice_GetIndicesEx()’ is implemented as a
     macro using ‘PySlice_Unpack()’ and ‘PySlice_AdjustIndices()’.
     Arguments `start', `stop' and `step' are evaluated more than once.

     Deprecated since version 3.6.1: If ‘Py_LIMITED_API’ is set to the
     value less than ‘0x03050400’ or between ‘0x03060000’ and
     ‘0x03060100’ (not including) ‘PySlice_GetIndicesEx()’ is a
     deprecated function.

 -- C Function: int PySlice_Unpack (PyObject *slice, Py_ssize_t *start,
          Py_ssize_t *stop, Py_ssize_t *step)

     Extract the start, stop and step data members from a slice object
     as C integers.  Silently reduce values larger than ‘PY_SSIZE_T_MAX’
     to ‘PY_SSIZE_T_MAX’, silently boost the start and stop values less
     than ‘PY_SSIZE_T_MIN’ to ‘PY_SSIZE_T_MIN’, and silently boost the
     step values less than ‘-PY_SSIZE_T_MAX’ to ‘-PY_SSIZE_T_MAX’.

     Return ‘-1’ on error, ‘0’ on success.

     New in version 3.6.1.

 -- C Function: Py_ssize_t PySlice_AdjustIndices (Py_ssize_t length,
          Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t step)

     Adjust start/end slice indices assuming a sequence of the specified
     length.  Out of bounds indices are clipped in a manner consistent
     with the handling of normal slices.

     Return the length of the slice.  Always successful.  Doesn’t call
     Python code.

     New in version 3.6.1.


File: python.info,  Node: Ellipsis Object,  Next: MemoryView objects,  Prev: Slice Objects,  Up: Other Objects

7.8.6.12 Ellipsis Object
........................

 -- C Variable: PyObject *Py_Ellipsis

     The Python ‘Ellipsis’ object.  This object has no methods.  It
     needs to be treated just like any other object with respect to
     reference counts.  Like *note Py_None: 3a48. it is a singleton
     object.


File: python.info,  Node: MemoryView objects,  Next: Weak Reference Objects<2>,  Prev: Ellipsis Object,  Up: Other Objects

7.8.6.13 MemoryView objects
...........................

A *note memoryview: 25a. object exposes the C level *note buffer
interface: 1579. as a Python object which can then be passed around like
any other object.

 -- C Function: PyObject *PyMemoryView_FromObject (PyObject *obj)
     `Return value: New reference.'  Create a memoryview object from an
     object that provides the buffer interface.  If `obj' supports
     writable buffer exports, the memoryview object will be read/write,
     otherwise it may be either read-only or read/write at the
     discretion of the exporter.

 -- C Function: PyObject *PyMemoryView_FromMemory (char *mem,
          Py_ssize_t size, int flags)
     `Return value: New reference.'  Create a memoryview object using
     `mem' as the underlying buffer.  `flags' can be one of ‘PyBUF_READ’
     or ‘PyBUF_WRITE’.

     New in version 3.3.

 -- C Function: PyObject *PyMemoryView_FromBuffer (Py_buffer *view)
     `Return value: New reference.'  Create a memoryview object wrapping
     the given buffer structure `view'.  For simple byte buffers, *note
     PyMemoryView_FromMemory(): abe. is the preferred function.

 -- C Function: PyObject *PyMemoryView_GetContiguous (PyObject *obj,
          int buffertype, char order)
     `Return value: New reference.'  Create a memoryview object to a
     *note contiguous: 15f1. chunk of memory (in either ‘C’ or ‘F’ortran
     `order') from an object that defines the buffer interface.  If
     memory is contiguous, the memoryview object points to the original
     memory.  Otherwise, a copy is made and the memoryview points to a
     new bytes object.

 -- C Function: int PyMemoryView_Check (PyObject *obj)

     Return true if the object `obj' is a memoryview object.  It is not
     currently allowed to create subclasses of *note memoryview: 25a.

 -- C Function: Py_buffer *PyMemoryView_GET_BUFFER (PyObject *mview)

     Return a pointer to the memoryview’s private copy of the exporter’s
     buffer.  `mview' `must' be a memoryview instance; this macro
     doesn’t check its type, you must do it yourself or you will risk
     crashes.

 -- C Function: Py_buffer *PyMemoryView_GET_BASE (PyObject *mview)

     Return either a pointer to the exporting object that the memoryview
     is based on or ‘NULL’ if the memoryview has been created by one of
     the functions *note PyMemoryView_FromMemory(): abe. or *note
     PyMemoryView_FromBuffer(): 3c65.  `mview' `must' be a memoryview
     instance.


File: python.info,  Node: Weak Reference Objects<2>,  Next: Capsules<2>,  Prev: MemoryView objects,  Up: Other Objects

7.8.6.14 Weak Reference Objects
...............................

Python supports `weak references' as first-class objects.  There are two
specific object types which directly implement weak references.  The
first is a simple reference object, and the second acts as a proxy for
the original object as much as it can.

 -- C Function: int PyWeakref_Check (ob)

     Return true if `ob' is either a reference or proxy object.

 -- C Function: int PyWeakref_CheckRef (ob)

     Return true if `ob' is a reference object.

 -- C Function: int PyWeakref_CheckProxy (ob)

     Return true if `ob' is a proxy object.

 -- C Function: PyObject* PyWeakref_NewRef (PyObject *ob,
          PyObject *callback)
     `Return value: New reference.'  Return a weak reference object for
     the object `ob'.  This will always return a new reference, but is
     not guaranteed to create a new object; an existing reference object
     may be returned.  The second parameter, `callback', can be a
     callable object that receives notification when `ob' is garbage
     collected; it should accept a single parameter, which will be the
     weak reference object itself.  `callback' may also be ‘None’ or
     ‘NULL’.  If `ob' is not a weakly-referencable object, or if
     `callback' is not callable, ‘None’, or ‘NULL’, this will return
     ‘NULL’ and raise *note TypeError: 192.

 -- C Function: PyObject* PyWeakref_NewProxy (PyObject *ob,
          PyObject *callback)
     `Return value: New reference.'  Return a weak reference proxy
     object for the object `ob'.  This will always return a new
     reference, but is not guaranteed to create a new object; an
     existing proxy object may be returned.  The second parameter,
     `callback', can be a callable object that receives notification
     when `ob' is garbage collected; it should accept a single
     parameter, which will be the weak reference object itself.
     `callback' may also be ‘None’ or ‘NULL’.  If `ob' is not a
     weakly-referencable object, or if `callback' is not callable,
     ‘None’, or ‘NULL’, this will return ‘NULL’ and raise *note
     TypeError: 192.

 -- C Function: PyObject* PyWeakref_GetObject (PyObject *ref)
     `Return value: Borrowed reference.'  Return the referenced object
     from a weak reference, `ref'.  If the referent is no longer live,
     returns ‘Py_None’.

          Note: This function returns a `borrowed reference' to the
          referenced object.  This means that you should always call
          *note Py_INCREF(): 263. on the object except if you know that
          it cannot be destroyed while you are still using it.

 -- C Function: PyObject* PyWeakref_GET_OBJECT (PyObject *ref)
     `Return value: Borrowed reference.'  Similar to *note
     PyWeakref_GetObject(): 3e6a, but implemented as a macro that does
     no error checking.


File: python.info,  Node: Capsules<2>,  Next: Generator Objects,  Prev: Weak Reference Objects<2>,  Up: Other Objects

7.8.6.15 Capsules
.................

Refer to *note Providing a C API for an Extension Module: ce4. for more
information on using these objects.

New in version 3.1.

 -- C Type: PyCapsule

     This subtype of *note PyObject: 4b0. represents an opaque value,
     useful for C extension modules who need to pass an opaque value (as
     a ‘void*’ pointer) through Python code to other C code.  It is
     often used to make a C function pointer defined in one module
     available to other modules, so the regular import mechanism can be
     used to access C APIs defined in dynamically loaded modules.

 -- C Type: PyCapsule_Destructor

     The type of a destructor callback for a capsule.  Defined as:

          typedef void (*PyCapsule_Destructor)(PyObject *);

     See *note PyCapsule_New(): 3a70. for the semantics of
     PyCapsule_Destructor callbacks.

 -- C Function: int PyCapsule_CheckExact (PyObject *p)

     Return true if its argument is a *note PyCapsule: bfa.

 -- C Function: PyObject* PyCapsule_New (void *pointer, const
          char *name, PyCapsule_Destructor destructor)
     `Return value: New reference.'  Create a *note PyCapsule: bfa.
     encapsulating the `pointer'.  The `pointer' argument may not be
     ‘NULL’.

     On failure, set an exception and return ‘NULL’.

     The `name' string may either be ‘NULL’ or a pointer to a valid C
     string.  If non-‘NULL’, this string must outlive the capsule.
     (Though it is permitted to free it inside the `destructor'.)

     If the `destructor' argument is not ‘NULL’, it will be called with
     the capsule as its argument when it is destroyed.

     If this capsule will be stored as an attribute of a module, the
     `name' should be specified as ‘modulename.attributename’.  This
     will enable other modules to import the capsule using *note
     PyCapsule_Import(): 3a71.

 -- C Function: void* PyCapsule_GetPointer (PyObject *capsule, const
          char *name)

     Retrieve the `pointer' stored in the capsule.  On failure, set an
     exception and return ‘NULL’.

     The `name' parameter must compare exactly to the name stored in the
     capsule.  If the name stored in the capsule is ‘NULL’, the `name'
     passed in must also be ‘NULL’.  Python uses the C function
     ‘strcmp()’ to compare capsule names.

 -- C Function: PyCapsule_Destructor PyCapsule_GetDestructor
          (PyObject *capsule)

     Return the current destructor stored in the capsule.  On failure,
     set an exception and return ‘NULL’.

     It is legal for a capsule to have a ‘NULL’ destructor.  This makes
     a ‘NULL’ return code somewhat ambiguous; use *note
     PyCapsule_IsValid(): ce3. or *note PyErr_Occurred(): 3a43. to
     disambiguate.

 -- C Function: void* PyCapsule_GetContext (PyObject *capsule)

     Return the current context stored in the capsule.  On failure, set
     an exception and return ‘NULL’.

     It is legal for a capsule to have a ‘NULL’ context.  This makes a
     ‘NULL’ return code somewhat ambiguous; use *note
     PyCapsule_IsValid(): ce3. or *note PyErr_Occurred(): 3a43. to
     disambiguate.

 -- C Function: const char* PyCapsule_GetName (PyObject *capsule)

     Return the current name stored in the capsule.  On failure, set an
     exception and return ‘NULL’.

     It is legal for a capsule to have a ‘NULL’ name.  This makes a
     ‘NULL’ return code somewhat ambiguous; use *note
     PyCapsule_IsValid(): ce3. or *note PyErr_Occurred(): 3a43. to
     disambiguate.

 -- C Function: void* PyCapsule_Import (const char *name, int no_block)

     Import a pointer to a C object from a capsule attribute in a
     module.  The `name' parameter should specify the full name to the
     attribute, as in ‘module.attribute’.  The `name' stored in the
     capsule must match this string exactly.  If `no_block' is true,
     import the module without blocking (using *note
     PyImport_ImportModuleNoBlock(): 9b5.).  If `no_block' is false,
     import the module conventionally (using *note
     PyImport_ImportModule(): c66.).

     Return the capsule’s internal `pointer' on success.  On failure,
     set an exception and return ‘NULL’.

 -- C Function: int PyCapsule_IsValid (PyObject *capsule, const
          char *name)

     Determines whether or not `capsule' is a valid capsule.  A valid
     capsule is non-‘NULL’, passes *note PyCapsule_CheckExact(): 3e6f,
     has a non-‘NULL’ pointer stored in it, and its internal name
     matches the `name' parameter.  (See *note PyCapsule_GetPointer():
     3e70. for information on how capsule names are compared.)

     In other words, if *note PyCapsule_IsValid(): ce3. returns a true
     value, calls to any of the accessors (any function starting with
     ‘PyCapsule_Get()’) are guaranteed to succeed.

     Return a nonzero value if the object is valid and matches the name
     passed in.  Return ‘0’ otherwise.  This function will not fail.

 -- C Function: int PyCapsule_SetContext (PyObject *capsule,
          void *context)

     Set the context pointer inside `capsule' to `context'.

     Return ‘0’ on success.  Return nonzero and set an exception on
     failure.

 -- C Function: int PyCapsule_SetDestructor (PyObject *capsule,
          PyCapsule_Destructor destructor)

     Set the destructor inside `capsule' to `destructor'.

     Return ‘0’ on success.  Return nonzero and set an exception on
     failure.

 -- C Function: int PyCapsule_SetName (PyObject *capsule, const
          char *name)

     Set the name inside `capsule' to `name'.  If non-‘NULL’, the name
     must outlive the capsule.  If the previous `name' stored in the
     capsule was not ‘NULL’, no attempt is made to free it.

     Return ‘0’ on success.  Return nonzero and set an exception on
     failure.

 -- C Function: int PyCapsule_SetPointer (PyObject *capsule,
          void *pointer)

     Set the void pointer inside `capsule' to `pointer'.  The pointer
     may not be ‘NULL’.

     Return ‘0’ on success.  Return nonzero and set an exception on
     failure.


File: python.info,  Node: Generator Objects,  Next: Coroutine Objects<2>,  Prev: Capsules<2>,  Up: Other Objects

7.8.6.16 Generator Objects
..........................

Generator objects are what Python uses to implement generator iterators.
They are normally created by iterating over a function that yields
values, rather than explicitly calling *note PyGen_New(): 3e7b. or *note
PyGen_NewWithQualName(): 3e7c.

 -- C Type: PyGenObject

     The C structure used for generator objects.

 -- C Variable: PyTypeObject PyGen_Type

     The type object corresponding to generator objects.

 -- C Function: int PyGen_Check (PyObject *ob)

     Return true if `ob' is a generator object; `ob' must not be ‘NULL’.

 -- C Function: int PyGen_CheckExact (PyObject *ob)

     Return true if `ob'’s type is *note PyGen_Type: 3e7e.; `ob' must
     not be ‘NULL’.

 -- C Function: PyObject* PyGen_New (PyFrameObject *frame)
     `Return value: New reference.'  Create and return a new generator
     object based on the `frame' object.  A reference to `frame' is
     stolen by this function.  The argument must not be ‘NULL’.

 -- C Function: PyObject* PyGen_NewWithQualName (PyFrameObject *frame,
          PyObject *name, PyObject *qualname)
     `Return value: New reference.'  Create and return a new generator
     object based on the `frame' object, with ‘__name__’ and
     ‘__qualname__’ set to `name' and `qualname'.  A reference to
     `frame' is stolen by this function.  The `frame' argument must not
     be ‘NULL’.


File: python.info,  Node: Coroutine Objects<2>,  Next: Context Variables Objects,  Prev: Generator Objects,  Up: Other Objects

7.8.6.17 Coroutine Objects
..........................

New in version 3.5.

Coroutine objects are what functions declared with an ‘async’ keyword
return.

 -- C Type: PyCoroObject

     The C structure used for coroutine objects.

 -- C Variable: PyTypeObject PyCoro_Type

     The type object corresponding to coroutine objects.

 -- C Function: int PyCoro_CheckExact (PyObject *ob)

     Return true if `ob'’s type is *note PyCoro_Type: 3e84.; `ob' must
     not be ‘NULL’.

 -- C Function: PyObject* PyCoro_New (PyFrameObject *frame,
          PyObject *name, PyObject *qualname)
     `Return value: New reference.'  Create and return a new coroutine
     object based on the `frame' object, with ‘__name__’ and
     ‘__qualname__’ set to `name' and `qualname'.  A reference to
     `frame' is stolen by this function.  The `frame' argument must not
     be ‘NULL’.


File: python.info,  Node: Context Variables Objects,  Next: DateTime Objects<2>,  Prev: Coroutine Objects<2>,  Up: Other Objects

7.8.6.18 Context Variables Objects
..................................

     Note Changed in version 3.7.1:: In Python 3.7.1 the signatures of
     all context variables C APIs were `changed' to use *note PyObject:
     4b0. pointers instead of *note PyContext: 3e89, *note PyContextVar:
     3e8a, and *note PyContextToken: 3e8b, e.g.:

          // in 3.7.0: PyContext *PyContext_New(void);  // in 3.7.1+: PyObject *PyContext_New(void);

     See bpo-34762(1) for more details.

New in version 3.7.

This section details the public C API for the *note contextvars: 25.
module.

 -- C Type: PyContext

     The C structure used to represent a *note contextvars.Context:
     2414. object.

 -- C Type: PyContextVar

     The C structure used to represent a *note contextvars.ContextVar:
     2412. object.

 -- C Type: PyContextToken

     The C structure used to represent a ‘contextvars.Token’ object.

 -- C Variable: PyTypeObject PyContext_Type

     The type object representing the `context' type.

 -- C Variable: PyTypeObject PyContextVar_Type

     The type object representing the `context variable' type.

 -- C Variable: PyTypeObject PyContextToken_Type

     The type object representing the `context variable token' type.

Type-check macros:

 -- C Function: int PyContext_CheckExact (PyObject *o)

     Return true if `o' is of type *note PyContext_Type: 3e8c.  `o' must
     not be ‘NULL’.  This function always succeeds.

 -- C Function: int PyContextVar_CheckExact (PyObject *o)

     Return true if `o' is of type *note PyContextVar_Type: 3e8d.  `o'
     must not be ‘NULL’.  This function always succeeds.

 -- C Function: int PyContextToken_CheckExact (PyObject *o)

     Return true if `o' is of type *note PyContextToken_Type: 3e8e.  `o'
     must not be ‘NULL’.  This function always succeeds.

Context object management functions:

 -- C Function: PyObject *PyContext_New (void)
     `Return value: New reference.'  Create a new empty context object.
     Returns ‘NULL’ if an error has occurred.

 -- C Function: PyObject *PyContext_Copy (PyObject *ctx)
     `Return value: New reference.'  Create a shallow copy of the passed
     `ctx' context object.  Returns ‘NULL’ if an error has occurred.

 -- C Function: PyObject *PyContext_CopyCurrent (void)
     `Return value: New reference.'  Create a shallow copy of the
     current thread context.  Returns ‘NULL’ if an error has occurred.

 -- C Function: int PyContext_Enter (PyObject *ctx)

     Set `ctx' as the current context for the current thread.  Returns
     ‘0’ on success, and ‘-1’ on error.

 -- C Function: int PyContext_Exit (PyObject *ctx)

     Deactivate the `ctx' context and restore the previous context as
     the current context for the current thread.  Returns ‘0’ on
     success, and ‘-1’ on error.

 -- C Function: int PyContext_ClearFreeList ()

     Clear the context variable free list.  Return the total number of
     freed items.  This function always succeeds.

Context variable functions:

 -- C Function: PyObject *PyContextVar_New (const char *name,
          PyObject *def)
     `Return value: New reference.'  Create a new ‘ContextVar’ object.
     The `name' parameter is used for introspection and debug purposes.
     The `def' parameter may optionally specify the default value for
     the context variable.  If an error has occurred, this function
     returns ‘NULL’.

 -- C Function: int PyContextVar_Get (PyObject *var,
          PyObject *default_value, PyObject **value)

     Get the value of a context variable.  Returns ‘-1’ if an error has
     occurred during lookup, and ‘0’ if no error occurred, whether or
     not a value was found.

     If the context variable was found, `value' will be a pointer to it.
     If the context variable was `not' found, `value' will point to:

        - `default_value', if not ‘NULL’;

        - the default value of `var', if not ‘NULL’;

        - ‘NULL’

     If the value was found, the function will create a new reference to
     it.

 -- C Function: PyObject *PyContextVar_Set (PyObject *var,
          PyObject *value)
     `Return value: New reference.'  Set the value of `var' to `value'
     in the current context.  Returns a pointer to a *note PyObject:
     4b0. object, or ‘NULL’ if an error has occurred.

 -- C Function: int PyContextVar_Reset (PyObject *var, PyObject *token)

     Reset the state of the `var' context variable to that it was in
     before *note PyContextVar_Set(): 3e9a. that returned the `token'
     was called.  This function returns ‘0’ on success and ‘-1’ on
     error.

   ---------- Footnotes ----------

   (1) https://bugs.python.org/issue34762


File: python.info,  Node: DateTime Objects<2>,  Prev: Context Variables Objects,  Up: Other Objects

7.8.6.19 DateTime Objects
.........................

Various date and time objects are supplied by the *note datetime: 31.
module.  Before using any of these functions, the header file
‘datetime.h’ must be included in your source (note that this is not
included by ‘Python.h’), and the macro ‘PyDateTime_IMPORT’ must be
invoked, usually as part of the module initialisation function.  The
macro puts a pointer to a C structure into a static variable,
‘PyDateTimeAPI’, that is used by the following macros.

Macro for access to the UTC singleton:

 -- C Variable: PyObject* PyDateTime_TimeZone_UTC

     Returns the time zone singleton representing UTC, the same object
     as *note datetime.timezone.utc: 1823.

     New in version 3.7.

Type-check macros:

 -- C Function: int PyDate_Check (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_DateType’ or a subtype
     of ‘PyDateTime_DateType’.  `ob' must not be ‘NULL’.

 -- C Function: int PyDate_CheckExact (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_DateType’.  `ob' must
     not be ‘NULL’.

 -- C Function: int PyDateTime_Check (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_DateTimeType’ or a
     subtype of ‘PyDateTime_DateTimeType’.  `ob' must not be ‘NULL’.

 -- C Function: int PyDateTime_CheckExact (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_DateTimeType’.  `ob'
     must not be ‘NULL’.

 -- C Function: int PyTime_Check (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_TimeType’ or a subtype
     of ‘PyDateTime_TimeType’.  `ob' must not be ‘NULL’.

 -- C Function: int PyTime_CheckExact (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_TimeType’.  `ob' must
     not be ‘NULL’.

 -- C Function: int PyDelta_Check (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_DeltaType’ or a subtype
     of ‘PyDateTime_DeltaType’.  `ob' must not be ‘NULL’.

 -- C Function: int PyDelta_CheckExact (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_DeltaType’.  `ob' must
     not be ‘NULL’.

 -- C Function: int PyTZInfo_Check (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_TZInfoType’ or a subtype
     of ‘PyDateTime_TZInfoType’.  `ob' must not be ‘NULL’.

 -- C Function: int PyTZInfo_CheckExact (PyObject *ob)

     Return true if `ob' is of type ‘PyDateTime_TZInfoType’.  `ob' must
     not be ‘NULL’.

Macros to create objects:

 -- C Function: PyObject* PyDate_FromDate (int year, int month, int day)
     `Return value: New reference.'  Return a *note datetime.date: 193.
     object with the specified year, month and day.

 -- C Function: PyObject* PyDateTime_FromDateAndTime (int year,
          int month, int day, int hour, int minute, int second,
          int usecond)
     `Return value: New reference.'  Return a *note datetime.datetime:
     194. object with the specified year, month, day, hour, minute,
     second and microsecond.

 -- C Function: PyObject* PyDateTime_FromDateAndTimeAndFold (int year,
          int month, int day, int hour, int minute, int second,
          int usecond, int fold)
     `Return value: New reference.'  Return a *note datetime.datetime:
     194. object with the specified year, month, day, hour, minute,
     second, microsecond and fold.

     New in version 3.6.

 -- C Function: PyObject* PyTime_FromTime (int hour, int minute,
          int second, int usecond)
     `Return value: New reference.'  Return a *note datetime.time: 4e8.
     object with the specified hour, minute, second and microsecond.

 -- C Function: PyObject* PyTime_FromTimeAndFold (int hour, int minute,
          int second, int usecond, int fold)
     `Return value: New reference.'  Return a *note datetime.time: 4e8.
     object with the specified hour, minute, second, microsecond and
     fold.

     New in version 3.6.

 -- C Function: PyObject* PyDelta_FromDSU (int days, int seconds,
          int useconds)
     `Return value: New reference.'  Return a *note datetime.timedelta:
     195. object representing the given number of days, seconds and
     microseconds.  Normalization is performed so that the resulting
     number of microseconds and seconds lie in the ranges documented for
     *note datetime.timedelta: 195. objects.

 -- C Function: PyObject* PyTimeZone_FromOffset
          (PyDateTime_DeltaType* offset)
     `Return value: New reference.'  Return a *note datetime.timezone:
     9f5. object with an unnamed fixed offset represented by the
     `offset' argument.

     New in version 3.7.

 -- C Function: PyObject* PyTimeZone_FromOffsetAndName
          (PyDateTime_DeltaType* offset, PyUnicode* name)
     `Return value: New reference.'  Return a *note datetime.timezone:
     9f5. object with a fixed offset represented by the `offset'
     argument and with tzname `name'.

     New in version 3.7.

Macros to extract fields from date objects.  The argument must be an
instance of ‘PyDateTime_Date’, including subclasses (such as
‘PyDateTime_DateTime’).  The argument must not be ‘NULL’, and the type
is not checked:

 -- C Function: int PyDateTime_GET_YEAR (PyDateTime_Date *o)

     Return the year, as a positive int.

 -- C Function: int PyDateTime_GET_MONTH (PyDateTime_Date *o)

     Return the month, as an int from 1 through 12.

 -- C Function: int PyDateTime_GET_DAY (PyDateTime_Date *o)

     Return the day, as an int from 1 through 31.

Macros to extract fields from datetime objects.  The argument must be an
instance of ‘PyDateTime_DateTime’, including subclasses.  The argument
must not be ‘NULL’, and the type is not checked:

 -- C Function: int PyDateTime_DATE_GET_HOUR (PyDateTime_DateTime *o)

     Return the hour, as an int from 0 through 23.

 -- C Function: int PyDateTime_DATE_GET_MINUTE (PyDateTime_DateTime *o)

     Return the minute, as an int from 0 through 59.

 -- C Function: int PyDateTime_DATE_GET_SECOND (PyDateTime_DateTime *o)

     Return the second, as an int from 0 through 59.

 -- C Function: int PyDateTime_DATE_GET_MICROSECOND
          (PyDateTime_DateTime *o)

     Return the microsecond, as an int from 0 through 999999.

Macros to extract fields from time objects.  The argument must be an
instance of ‘PyDateTime_Time’, including subclasses.  The argument must
not be ‘NULL’, and the type is not checked:

 -- C Function: int PyDateTime_TIME_GET_HOUR (PyDateTime_Time *o)

     Return the hour, as an int from 0 through 23.

 -- C Function: int PyDateTime_TIME_GET_MINUTE (PyDateTime_Time *o)

     Return the minute, as an int from 0 through 59.

 -- C Function: int PyDateTime_TIME_GET_SECOND (PyDateTime_Time *o)

     Return the second, as an int from 0 through 59.

 -- C Function: int PyDateTime_TIME_GET_MICROSECOND (PyDateTime_Time *o)

     Return the microsecond, as an int from 0 through 999999.

Macros to extract fields from time delta objects.  The argument must be
an instance of ‘PyDateTime_Delta’, including subclasses.  The argument
must not be ‘NULL’, and the type is not checked:

 -- C Function: int PyDateTime_DELTA_GET_DAYS (PyDateTime_Delta *o)

     Return the number of days, as an int from -999999999 to 999999999.

     New in version 3.3.

 -- C Function: int PyDateTime_DELTA_GET_SECONDS (PyDateTime_Delta *o)

     Return the number of seconds, as an int from 0 through 86399.

     New in version 3.3.

 -- C Function: int PyDateTime_DELTA_GET_MICROSECONDS
          (PyDateTime_Delta *o)

     Return the number of microseconds, as an int from 0 through 999999.

     New in version 3.3.

Macros for the convenience of modules implementing the DB API:

 -- C Function: PyObject* PyDateTime_FromTimestamp (PyObject *args)
     `Return value: New reference.'  Create and return a new *note
     datetime.datetime: 194. object given an argument tuple suitable for
     passing to *note datetime.datetime.fromtimestamp(): fc3.

 -- C Function: PyObject* PyDate_FromTimestamp (PyObject *args)
     `Return value: New reference.'  Create and return a new *note
     datetime.date: 193. object given an argument tuple suitable for
     passing to *note datetime.date.fromtimestamp(): 17e1.


File: python.info,  Node: Initialization Finalization and Threads,  Next: Python Initialization Configuration,  Prev: Concrete Objects Layer,  Up: Python/C API Reference Manual

7.9 Initialization, Finalization, and Threads
=============================================

See also *note Python Initialization Configuration: 17d.

* Menu:

* Before Python Initialization::
* Global configuration variables::
* Initializing and finalizing the interpreter::
* Process-wide parameters::
* Thread State and the Global Interpreter Lock::
* Sub-interpreter support::
* Asynchronous Notifications::
* Profiling and Tracing::
* Advanced Debugger Support::
* Thread Local Storage Support::


File: python.info,  Node: Before Python Initialization,  Next: Global configuration variables,  Up: Initialization Finalization and Threads

7.9.1 Before Python Initialization
----------------------------------

In an application embedding Python, the *note Py_Initialize(): 42e.
function must be called before using any other Python/C API functions;
with the exception of a few functions and the *note global configuration
variables: 3ec2.

The following functions can be safely called before Python is
initialized:

   * Configuration functions:

        * *note PyImport_AppendInittab(): 3a4c.

        * *note PyImport_ExtendInittab(): 3baf.

        * ‘PyInitFrozenExtensions()’

        * *note PyMem_SetAllocator(): 3ec3.

        * *note PyMem_SetupDebugHooks(): 4ff.

        * *note PyObject_SetArenaAllocator(): 3ec4.

        * *note Py_SetPath(): 271.

        * *note Py_SetProgramName(): eba.

        * *note Py_SetPythonHome(): eb9.

        * *note Py_SetStandardStreamEncoding(): 919.

        * *note PySys_AddWarnOption(): 4a9.

        * *note PySys_AddXOption(): 3b96.

        * *note PySys_ResetWarnOptions(): 3b8f.

   * Informative functions:

        * *note Py_IsInitialized(): 3b01.

        * *note PyMem_GetAllocator(): 3ec5.

        * *note PyObject_GetArenaAllocator(): 3ec6.

        * *note Py_GetBuildInfo(): d8d.

        * *note Py_GetCompiler(): 3ec7.

        * *note Py_GetCopyright(): 3ec8.

        * *note Py_GetPlatform(): 3ec9.

        * *note Py_GetVersion(): 3eca.

   * Utilities:

        * *note Py_DecodeLocale(): 431.

   * Memory allocators:

        * *note PyMem_RawMalloc(): 961.

        * *note PyMem_RawRealloc(): 962.

        * *note PyMem_RawCalloc(): 799.

        * *note PyMem_RawFree(): 3b89.

     Note: The following functions `should not be called' before *note
     Py_Initialize(): 42e.: *note Py_EncodeLocale(): 432, *note
     Py_GetPath(): 3afe, *note Py_GetPrefix(): 3aff, *note
     Py_GetExecPrefix(): 3b00, *note Py_GetProgramFullPath(): 273, *note
     Py_GetPythonHome(): 3ecb, *note Py_GetProgramName(): 274. and *note
     PyEval_InitThreads(): c05.


File: python.info,  Node: Global configuration variables,  Next: Initializing and finalizing the interpreter,  Prev: Before Python Initialization,  Up: Initialization Finalization and Threads

7.9.2 Global configuration variables
------------------------------------

Python has variables for the global configuration to control different
features and options.  By default, these flags are controlled by *note
command line options: 1274.

When a flag is set by an option, the value of the flag is the number of
times that the option was set.  For example, ‘-b’ sets *note
Py_BytesWarningFlag: 4aa. to 1 and ‘-bb’ sets *note Py_BytesWarningFlag:
4aa. to 2.

 -- C Variable: Py_BytesWarningFlag

     Issue a warning when comparing *note bytes: 326. or *note
     bytearray: 327. with *note str: 325. or *note bytes: 326. with
     *note int: 184.  Issue an error if greater or equal to ‘2’.

     Set by the *note -b: 40a. option.

 -- C Variable: Py_DebugFlag

     Turn on parser debugging output (for expert only, depending on
     compilation options).

     Set by the *note -d: 127d. option and the *note PYTHONDEBUG: 127e.
     environment variable.

 -- C Variable: Py_DontWriteBytecodeFlag

     If set to non-zero, Python won’t try to write ‘.pyc’ files on the
     import of source modules.

     Set by the *note -B: d2b. option and the *note
     PYTHONDONTWRITEBYTECODE: d2c. environment variable.

 -- C Variable: Py_FrozenFlag

     Suppress error messages when calculating the module search path in
     *note Py_GetPath(): 3afe.

     Private flag used by ‘_freeze_importlib’ and ‘frozenmain’ programs.

 -- C Variable: Py_HashRandomizationFlag

     Set to ‘1’ if the *note PYTHONHASHSEED: 9b9. environment variable
     is set to a non-empty string.

     If the flag is non-zero, read the *note PYTHONHASHSEED: 9b9.
     environment variable to initialize the secret hash seed.

 -- C Variable: Py_IgnoreEnvironmentFlag

     Ignore all ‘PYTHON*’ environment variables, e.g.  *note PYTHONPATH:
     947. and *note PYTHONHOME: 4cb, that might be set.

     Set by the *note -E: f3d. and *note -I: f3c. options.

 -- C Variable: Py_InspectFlag

     When a script is passed as first argument or the *note -c: 1145.
     option is used, enter interactive mode after executing the script
     or the command, even when *note sys.stdin: 302. does not appear to
     be a terminal.

     Set by the *note -i: e12. option and the *note PYTHONINSPECT: e11.
     environment variable.

 -- C Variable: Py_InteractiveFlag

     Set by the *note -i: e12. option.

 -- C Variable: Py_IsolatedFlag

     Run Python in isolated mode.  In isolated mode *note sys.path: 47d.
     contains neither the script’s directory nor the user’s
     site-packages directory.

     Set by the *note -I: f3c. option.

     New in version 3.4.

 -- C Variable: Py_LegacyWindowsFSEncodingFlag

     If the flag is non-zero, use the ‘mbcs’ encoding instead of the
     UTF-8 encoding for the filesystem encoding.

     Set to ‘1’ if the *note PYTHONLEGACYWINDOWSFSENCODING: 4ec.
     environment variable is set to a non-empty string.

     See PEP 529(1) for more details.

     *note Availability: 129a.: Windows.

 -- C Variable: Py_LegacyWindowsStdioFlag

     If the flag is non-zero, use *note io.FileIO: c97. instead of
     ‘WindowsConsoleIO’ for *note sys: fd. standard streams.

     Set to ‘1’ if the *note PYTHONLEGACYWINDOWSSTDIO: 4ef. environment
     variable is set to a non-empty string.

     See PEP 528(2) for more details.

     *note Availability: 129a.: Windows.

 -- C Variable: Py_NoSiteFlag

     Disable the import of the module *note site: eb. and the
     site-dependent manipulations of *note sys.path: 47d. that it
     entails.  Also disable these manipulations if *note site: eb. is
     explicitly imported later (call *note site.main(): 1282. if you
     want them to be triggered).

     Set by the *note -S: b17. option.

 -- C Variable: Py_NoUserSiteDirectory

     Don’t add the *note user site-packages directory: 1281. to *note
     sys.path: 47d.

     Set by the *note -s: d08. and *note -I: f3c. options, and the *note
     PYTHONNOUSERSITE: d09. environment variable.

 -- C Variable: Py_OptimizeFlag

     Set by the *note -O: 67f. option and the *note PYTHONOPTIMIZE:
     127f. environment variable.

 -- C Variable: Py_QuietFlag

     Don’t display the copyright and version messages even in
     interactive mode.

     Set by the *note -q: 1280. option.

     New in version 3.2.

 -- C Variable: Py_UnbufferedStdioFlag

     Force the stdout and stderr streams to be unbuffered.

     Set by the *note -u: 1283. option and the *note PYTHONUNBUFFERED:
     1284. environment variable.

 -- C Variable: Py_VerboseFlag

     Print a message each time a module is initialized, showing the
     place (filename or built-in module) from which it is loaded.  If
     greater or equal to ‘2’, print a message for each file that is
     checked for when searching for a module.  Also provides information
     on module cleanup at exit.

     Set by the *note -v: d7b. option and the *note PYTHONVERBOSE: 1285.
     environment variable.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0529

   (2) https://www.python.org/dev/peps/pep-0528


File: python.info,  Node: Initializing and finalizing the interpreter,  Next: Process-wide parameters,  Prev: Global configuration variables,  Up: Initialization Finalization and Threads

7.9.3 Initializing and finalizing the interpreter
-------------------------------------------------

 -- C Function: void Py_Initialize ()

     Initialize the Python interpreter.  In an application embedding
     Python, this should be called before using any other Python/C API
     functions; see *note Before Python Initialization: 42f. for the few
     exceptions.

     This initializes the table of loaded modules (‘sys.modules’), and
     creates the fundamental modules *note builtins: 13, *note __main__:
     1. and *note sys: fd.  It also initializes the module search path
     (‘sys.path’).  It does not set ‘sys.argv’; use *note
     PySys_SetArgvEx(): bed. for that.  This is a no-op when called for
     a second time (without calling *note Py_FinalizeEx(): 5be. first).
     There is no return value; it is a fatal error if the initialization
     fails.

          Note: On Windows, changes the console mode from ‘O_TEXT’ to
          ‘O_BINARY’, which will also affect non-Python uses of the
          console using the C Runtime.

 -- C Function: void Py_InitializeEx (int initsigs)

     This function works like *note Py_Initialize(): 42e. if `initsigs'
     is ‘1’.  If `initsigs' is ‘0’, it skips initialization registration
     of signal handlers, which might be useful when Python is embedded.

 -- C Function: int Py_IsInitialized ()

     Return true (nonzero) when the Python interpreter has been
     initialized, false (zero) if not.  After *note Py_FinalizeEx():
     5be. is called, this returns false until *note Py_Initialize():
     42e. is called again.

 -- C Function: int Py_FinalizeEx ()

     Undo all initializations made by *note Py_Initialize(): 42e. and
     subsequent use of Python/C API functions, and destroy all
     sub-interpreters (see *note Py_NewInterpreter(): 3edb. below) that
     were created and not yet destroyed since the last call to *note
     Py_Initialize(): 42e.  Ideally, this frees all memory allocated by
     the Python interpreter.  This is a no-op when called for a second
     time (without calling *note Py_Initialize(): 42e. again first).
     Normally the return value is ‘0’.  If there were errors during
     finalization (flushing buffered data), ‘-1’ is returned.

     This function is provided for a number of reasons.  An embedding
     application might want to restart Python without having to restart
     the application itself.  An application that has loaded the Python
     interpreter from a dynamically loadable library (or DLL) might want
     to free all memory allocated by Python before unloading the DLL.
     During a hunt for memory leaks in an application a developer might
     want to free all memory allocated by Python before exiting from the
     application.

     `Bugs and caveats:' The destruction of modules and objects in
     modules is done in random order; this may cause destructors (*note
     __del__(): 913. methods) to fail when they depend on other objects
     (even functions) or modules.  Dynamically loaded extension modules
     loaded by Python are not unloaded.  Small amounts of memory
     allocated by the Python interpreter may not be freed (if you find a
     leak, please report it).  Memory tied up in circular references
     between objects is not freed.  Some memory allocated by extension
     modules may not be freed.  Some extensions may not work properly if
     their initialization routine is called more than once; this can
     happen if an application calls *note Py_Initialize(): 42e. and
     *note Py_FinalizeEx(): 5be. more than once.

     Raises an *note auditing event: 1275.
     ‘cpython._PySys_ClearAuditHooks’ with no arguments.

     New in version 3.6.

 -- C Function: void Py_Finalize ()

     This is a backwards-compatible version of *note Py_FinalizeEx():
     5be. that disregards the return value.


File: python.info,  Node: Process-wide parameters,  Next: Thread State and the Global Interpreter Lock,  Prev: Initializing and finalizing the interpreter,  Up: Initialization Finalization and Threads

7.9.4 Process-wide parameters
-----------------------------

 -- C Function: int Py_SetStandardStreamEncoding (const char *encoding,
          const char *errors)

     This function should be called before *note Py_Initialize(): 42e,
     if it is called at all.  It specifies which encoding and error
     handling to use with standard IO, with the same meanings as in
     *note str.encode(): c2a.

     It overrides *note PYTHONIOENCODING: 923. values, and allows
     embedding code to control IO encoding when the environment variable
     does not work.

     `encoding' and/or `errors' may be ‘NULL’ to use *note
     PYTHONIOENCODING: 923. and/or default values (depending on other
     settings).

     Note that *note sys.stderr: 304. always uses the “backslashreplace”
     error handler, regardless of this (or any other) setting.

     If *note Py_FinalizeEx(): 5be. is called, this function will need
     to be called again in order to affect subsequent calls to *note
     Py_Initialize(): 42e.

     Returns ‘0’ if successful, a nonzero value on error (e.g.  calling
     after the interpreter has already been initialized).

     New in version 3.4.

 -- C Function: void Py_SetProgramName (const wchar_t *name)

     This function should be called before *note Py_Initialize(): 42e.
     is called for the first time, if it is called at all.  It tells the
     interpreter the value of the ‘argv[0]’ argument to the ‘main()’
     function of the program (converted to wide characters).  This is
     used by *note Py_GetPath(): 3afe. and some other functions below to
     find the Python run-time libraries relative to the interpreter
     executable.  The default value is ‘'python'’.  The argument should
     point to a zero-terminated wide character string in static storage
     whose contents will not change for the duration of the program’s
     execution.  No code in the Python interpreter will change the
     contents of this storage.

     Use *note Py_DecodeLocale(): 431. to decode a bytes string to get a
     ‘wchar_*’ string.

 -- C Function: wchar* Py_GetProgramName ()

     Return the program name set with *note Py_SetProgramName(): eba, or
     the default.  The returned string points into static storage; the
     caller should not modify its value.

 -- C Function: wchar_t* Py_GetPrefix ()

     Return the `prefix' for installed platform-independent files.  This
     is derived through a number of complicated rules from the program
     name set with *note Py_SetProgramName(): eba. and some environment
     variables; for example, if the program name is
     ‘'/usr/local/bin/python'’, the prefix is ‘'/usr/local'’.  The
     returned string points into static storage; the caller should not
     modify its value.  This corresponds to the ‘prefix’ variable in the
     top-level ‘Makefile’ and the ‘--prefix’ argument to the ‘configure’
     script at build time.  The value is available to Python code as
     ‘sys.prefix’.  It is only useful on Unix.  See also the next
     function.

 -- C Function: wchar_t* Py_GetExecPrefix ()

     Return the `exec-prefix' for installed platform-`dependent' files.
     This is derived through a number of complicated rules from the
     program name set with *note Py_SetProgramName(): eba. and some
     environment variables; for example, if the program name is
     ‘'/usr/local/bin/python'’, the exec-prefix is ‘'/usr/local'’.  The
     returned string points into static storage; the caller should not
     modify its value.  This corresponds to the ‘exec_prefix’ variable
     in the top-level ‘Makefile’ and the ‘--exec-prefix’ argument to the
     ‘configure’ script at build time.  The value is available to Python
     code as ‘sys.exec_prefix’.  It is only useful on Unix.

     Background: The exec-prefix differs from the prefix when platform
     dependent files (such as executables and shared libraries) are
     installed in a different directory tree.  In a typical
     installation, platform dependent files may be installed in the
     ‘/usr/local/plat’ subtree while platform independent may be
     installed in ‘/usr/local’.

     Generally speaking, a platform is a combination of hardware and
     software families, e.g.  Sparc machines running the Solaris 2.x
     operating system are considered the same platform, but Intel
     machines running Solaris 2.x are another platform, and Intel
     machines running Linux are yet another platform.  Different major
     revisions of the same operating system generally also form
     different platforms.  Non-Unix operating systems are a different
     story; the installation strategies on those systems are so
     different that the prefix and exec-prefix are meaningless, and set
     to the empty string.  Note that compiled Python bytecode files are
     platform independent (but not independent from the Python version
     by which they were compiled!).

     System administrators will know how to configure the ‘mount’ or
     ‘automount’ programs to share ‘/usr/local’ between platforms while
     having ‘/usr/local/plat’ be a different filesystem for each
     platform.

 -- C Function: wchar_t* Py_GetProgramFullPath ()

     Return the full program name of the Python executable; this is
     computed as a side-effect of deriving the default module search
     path from the program name (set by *note Py_SetProgramName(): eba.
     above).  The returned string points into static storage; the caller
     should not modify its value.  The value is available to Python code
     as ‘sys.executable’.

 -- C Function: wchar_t* Py_GetPath ()

     Return the default module search path; this is computed from the
     program name (set by *note Py_SetProgramName(): eba. above) and
     some environment variables.  The returned string consists of a
     series of directory names separated by a platform dependent
     delimiter character.  The delimiter character is ‘':'’ on Unix and
     Mac OS X, ‘';'’ on Windows.  The returned string points into static
     storage; the caller should not modify its value.  The list *note
     sys.path: 47d. is initialized with this value on interpreter
     startup; it can be (and usually is) modified later to change the
     search path for loading modules.

 -- C Function: void Py_SetPath (const wchar_t *)

     Set the default module search path.  If this function is called
     before *note Py_Initialize(): 42e, then *note Py_GetPath(): 3afe.
     won’t attempt to compute a default search path but uses the one
     provided instead.  This is useful if Python is embedded by an
     application that has full knowledge of the location of all modules.
     The path components should be separated by the platform dependent
     delimiter character, which is ‘':'’ on Unix and Mac OS X, ‘';'’ on
     Windows.

     This also causes *note sys.executable: 272. to be set to the
     program full path (see *note Py_GetProgramFullPath(): 273.) and for
     *note sys.prefix: 2f7b. and *note sys.exec_prefix: 3535. to be
     empty.  It is up to the caller to modify these if required after
     calling *note Py_Initialize(): 42e.

     Use *note Py_DecodeLocale(): 431. to decode a bytes string to get a
     ‘wchar_*’ string.

     The path argument is copied internally, so the caller may free it
     after the call completes.

     Changed in version 3.8: The program full path is now used for *note
     sys.executable: 272, instead of the program name.

 -- C Function: const char* Py_GetVersion ()

     Return the version of this Python interpreter.  This is a string
     that looks something like

          "3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"

     The first word (up to the first space character) is the current
     Python version; the first three characters are the major and minor
     version separated by a period.  The returned string points into
     static storage; the caller should not modify its value.  The value
     is available to Python code as *note sys.version: 5c8.

 -- C Function: const char* Py_GetPlatform ()

     Return the platform identifier for the current platform.  On Unix,
     this is formed from the “official” name of the operating system,
     converted to lower case, followed by the major revision number;
     e.g., for Solaris 2.x, which is also known as SunOS 5.x, the value
     is ‘'sunos5'’.  On Mac OS X, it is ‘'darwin'’.  On Windows, it is
     ‘'win'’.  The returned string points into static storage; the
     caller should not modify its value.  The value is available to
     Python code as ‘sys.platform’.

 -- C Function: const char* Py_GetCopyright ()

     Return the official copyright string for the current Python
     version, for example

     ‘'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'’

     The returned string points into static storage; the caller should
     not modify its value.  The value is available to Python code as
     ‘sys.copyright’.

 -- C Function: const char* Py_GetCompiler ()

     Return an indication of the compiler used to build the current
     Python version, in square brackets, for example:

          "[GCC 2.7.2.2]"

     The returned string points into static storage; the caller should
     not modify its value.  The value is available to Python code as
     part of the variable ‘sys.version’.

 -- C Function: const char* Py_GetBuildInfo ()

     Return information about the sequence number and build date and
     time of the current Python interpreter instance, for example

          "#67, Aug  1 1997, 22:34:28"

     The returned string points into static storage; the caller should
     not modify its value.  The value is available to Python code as
     part of the variable ‘sys.version’.

 -- C Function: void PySys_SetArgvEx (int argc, wchar_t **argv,
          int updatepath)

     Set *note sys.argv: bee. based on `argc' and `argv'.  These
     parameters are similar to those passed to the program’s ‘main()’
     function with the difference that the first entry should refer to
     the script file to be executed rather than the executable hosting
     the Python interpreter.  If there isn’t a script that will be run,
     the first entry in `argv' can be an empty string.  If this function
     fails to initialize *note sys.argv: bee, a fatal condition is
     signalled using *note Py_FatalError(): ebb.

     If `updatepath' is zero, this is all the function does.  If
     `updatepath' is non-zero, the function also modifies *note
     sys.path: 47d. according to the following algorithm:

        - If the name of an existing script is passed in ‘argv[0]’, the
          absolute path of the directory where the script is located is
          prepended to *note sys.path: 47d.

        - Otherwise (that is, if `argc' is ‘0’ or ‘argv[0]’ doesn’t
          point to an existing file name), an empty string is prepended
          to *note sys.path: 47d, which is the same as prepending the
          current working directory (‘"."’).

     Use *note Py_DecodeLocale(): 431. to decode a bytes string to get a
     ‘wchar_*’ string.

          Note: It is recommended that applications embedding the Python
          interpreter for purposes other than executing a single script
          pass ‘0’ as `updatepath', and update *note sys.path: 47d.
          themselves if desired.  See CVE-2008-5983(1).

          On versions before 3.1.3, you can achieve the same effect by
          manually popping the first *note sys.path: 47d. element after
          having called *note PySys_SetArgv(): cdf, for example using:

               PyRun_SimpleString("import sys; sys.path.pop(0)\n");

     New in version 3.1.3.

 -- C Function: void PySys_SetArgv (int argc, wchar_t **argv)

     This function works like *note PySys_SetArgvEx(): bed. with
     `updatepath' set to ‘1’ unless the ‘python’ interpreter was started
     with the *note -I: f3c.

     Use *note Py_DecodeLocale(): 431. to decode a bytes string to get a
     ‘wchar_*’ string.

     Changed in version 3.4: The `updatepath' value depends on *note -I:
     f3c.

 -- C Function: void Py_SetPythonHome (const wchar_t *home)

     Set the default “home” directory, that is, the location of the
     standard Python libraries.  See *note PYTHONHOME: 4cb. for the
     meaning of the argument string.

     The argument should point to a zero-terminated character string in
     static storage whose contents will not change for the duration of
     the program’s execution.  No code in the Python interpreter will
     change the contents of this storage.

     Use *note Py_DecodeLocale(): 431. to decode a bytes string to get a
     ‘wchar_*’ string.

 -- C Function: w_char* Py_GetPythonHome ()

     Return the default “home”, that is, the value set by a previous
     call to *note Py_SetPythonHome(): eb9, or the value of the *note
     PYTHONHOME: 4cb. environment variable if it is set.

   ---------- Footnotes ----------

   (1) https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2008-5983


File: python.info,  Node: Thread State and the Global Interpreter Lock,  Next: Sub-interpreter support,  Prev: Process-wide parameters,  Up: Initialization Finalization and Threads

7.9.5 Thread State and the Global Interpreter Lock
--------------------------------------------------

The Python interpreter is not fully thread-safe.  In order to support
multi-threaded Python programs, there’s a global lock, called the *note
global interpreter lock: 4fb. or *note GIL: bdd, that must be held by
the current thread before it can safely access Python objects.  Without
the lock, even the simplest operations could cause problems in a
multi-threaded program: for example, when two threads simultaneously
increment the reference count of the same object, the reference count
could end up being incremented only once instead of twice.

Therefore, the rule exists that only the thread that has acquired the
*note GIL: bdd. may operate on Python objects or call Python/C API
functions.  In order to emulate concurrency of execution, the
interpreter regularly tries to switch threads (see *note
sys.setswitchinterval(): bde.).  The lock is also released around
potentially blocking I/O operations like reading or writing a file, so
that other Python threads can run in the meantime.

The Python interpreter keeps some thread-specific bookkeeping
information inside a data structure called *note PyThreadState: 3edf.
There’s also one global variable pointing to the current *note
PyThreadState: 3edf.: it can be retrieved using *note
PyThreadState_Get(): 3ee0.

* Menu:

* Releasing the GIL from extension code::
* Non-Python created threads::
* Cautions about fork(): Cautions about fork.
* High-level API::
* Low-level API::


File: python.info,  Node: Releasing the GIL from extension code,  Next: Non-Python created threads,  Up: Thread State and the Global Interpreter Lock

7.9.5.1 Releasing the GIL from extension code
.............................................

Most extension code manipulating the *note GIL: bdd. has the following
simple structure:

     Save the thread state in a local variable. Release the global interpreter lock. ... Do some blocking I/O operation ... Reacquire the global interpreter lock. Restore the thread state from the local variable.

This is so common that a pair of macros exists to simplify it:

     Py_BEGIN_ALLOW_THREADS ... Do some blocking I/O operation ... Py_END_ALLOW_THREADS

The *note Py_BEGIN_ALLOW_THREADS: 3a6a. macro opens a new block and
declares a hidden local variable; the *note Py_END_ALLOW_THREADS: 2b3.
macro closes the block.

The block above expands to the following code:

     PyThreadState *_save;  _save = PyEval_SaveThread(); ... Do some blocking I/O operation ... PyEval_RestoreThread(_save);

Here is how these functions work: the global interpreter lock is used to
protect the pointer to the current thread state.  When releasing the
lock and saving the thread state, the current thread state pointer must
be retrieved before the lock is released (since another thread could
immediately acquire the lock and store its own thread state in the
global variable).  Conversely, when acquiring the lock and restoring the
thread state, the lock must be acquired before storing the thread state
pointer.

     Note: Calling system I/O functions is the most common use case for
     releasing the GIL, but it can also be useful before calling
     long-running computations which don’t need access to Python
     objects, such as compression or cryptographic functions operating
     over memory buffers.  For example, the standard *note zlib: 144.
     and *note hashlib: 8d. modules release the GIL when compressing or
     hashing data.


File: python.info,  Node: Non-Python created threads,  Next: Cautions about fork,  Prev: Releasing the GIL from extension code,  Up: Thread State and the Global Interpreter Lock

7.9.5.2 Non-Python created threads
..................................

When threads are created using the dedicated Python APIs (such as the
*note threading: 109. module), a thread state is automatically
associated to them and the code showed above is therefore correct.
However, when threads are created from C (for example by a third-party
library with its own thread management), they don’t hold the GIL, nor is
there a thread state structure for them.

If you need to call Python code from these threads (often this will be
part of a callback API provided by the aforementioned third-party
library), you must first register these threads with the interpreter by
creating a thread state data structure, then acquiring the GIL, and
finally storing their thread state pointer, before you can start using
the Python/C API. When you are done, you should reset the thread state
pointer, release the GIL, and finally free the thread state data
structure.

The *note PyGILState_Ensure(): 2b4. and *note PyGILState_Release():
3ee4. functions do all of the above automatically.  The typical idiom
for calling into Python from a C thread is:

     PyGILState_STATE gstate; gstate = PyGILState_Ensure();  /* Perform Python actions here. */ result = CallSomeFunction(); /* evaluate result or handle exception */  /* Release the thread. No Python API allowed beyond this point. */ PyGILState_Release(gstate);

Note that the ‘PyGILState_*()’ functions assume there is only one global
interpreter (created automatically by *note Py_Initialize(): 42e.).
Python supports the creation of additional interpreters (using *note
Py_NewInterpreter(): 3edb.), but mixing multiple interpreters and the
‘PyGILState_*()’ API is unsupported.


File: python.info,  Node: Cautions about fork,  Next: High-level API,  Prev: Non-Python created threads,  Up: Thread State and the Global Interpreter Lock

7.9.5.3 Cautions about fork()
.............................

Another important thing to note about threads is their behaviour in the
face of the C ‘fork()’ call.  On most systems with ‘fork()’, after a
process forks only the thread that issued the fork will exist.  This has
a concrete impact both on how locks must be handled and on all stored
state in CPython’s runtime.

The fact that only the “current” thread remains means any locks held by
other threads will never be released.  Python solves this for *note
os.fork(): 955. by acquiring the locks it uses internally before the
fork, and releasing them afterwards.  In addition, it resets any *note
Lock Objects: 22a5. in the child.  When extending or embedding Python,
there is no way to inform Python of additional (non-Python) locks that
need to be acquired before or reset after a fork.  OS facilities such as
‘pthread_atfork()’ would need to be used to accomplish the same thing.
Additionally, when extending or embedding Python, calling ‘fork()’
directly rather than through *note os.fork(): 955. (and returning to or
calling into Python) may result in a deadlock by one of Python’s
internal locks being held by a thread that is defunct after the fork.
*note PyOS_AfterFork_Child(): 2cb. tries to reset the necessary locks,
but is not always able to.

The fact that all other threads go away also means that CPython’s
runtime state there must be cleaned up properly, which *note os.fork():
955. does.  This means finalizing all other *note PyThreadState: 3edf.
objects belonging to the current interpreter and all other *note
PyInterpreterState: 2c0. objects.  Due to this and the special nature of
the *note “main” interpreter: 3b85, ‘fork()’ should only be called in
that interpreter’s “main” thread, where the CPython global runtime was
originally initialized.  The only exception is if ‘exec()’ will be
called immediately after.


File: python.info,  Node: High-level API,  Next: Low-level API,  Prev: Cautions about fork,  Up: Thread State and the Global Interpreter Lock

7.9.5.4 High-level API
......................

These are the most commonly used types and functions when writing C
extension code, or when embedding the Python interpreter:

 -- C Type: PyInterpreterState

     This data structure represents the state shared by a number of
     cooperating threads.  Threads belonging to the same interpreter
     share their module administration and a few other internal items.
     There are no public members in this structure.

     Threads belonging to different interpreters initially share
     nothing, except process state like available memory, open file
     descriptors and such.  The global interpreter lock is also shared
     by all threads, regardless of to which interpreter they belong.

 -- C Type: PyThreadState

     This data structure represents the state of a single thread.  The
     only public data member is *note PyInterpreterState *:
     2c0.‘interp’, which points to this thread’s interpreter state.

 -- C Function: void PyEval_InitThreads ()

     Initialize and acquire the global interpreter lock.  It should be
     called in the main thread before creating a second thread or
     engaging in any other thread operations such as
     ‘PyEval_ReleaseThread(tstate)’.  It is not needed before calling
     *note PyEval_SaveThread(): c04. or *note PyEval_RestoreThread():
     2b2.

     This is a no-op when called for a second time.

     Changed in version 3.7: This function is now called by *note
     Py_Initialize(): 42e, so you don’t have to call it yourself
     anymore.

     Changed in version 3.2: This function cannot be called before *note
     Py_Initialize(): 42e. anymore.

 -- C Function: int PyEval_ThreadsInitialized ()

     Returns a non-zero value if *note PyEval_InitThreads(): c05. has
     been called.  This function can be called without holding the GIL,
     and therefore can be used to avoid calls to the locking API when
     running single-threaded.

     Changed in version 3.7: The *note GIL: bdd. is now initialized by
     *note Py_Initialize(): 42e.

 -- C Function: PyThreadState* PyEval_SaveThread ()

     Release the global interpreter lock (if it has been created) and
     reset the thread state to ‘NULL’, returning the previous thread
     state (which is not ‘NULL’).  If the lock has been created, the
     current thread must have acquired it.

 -- C Function: void PyEval_RestoreThread (PyThreadState *tstate)

     Acquire the global interpreter lock (if it has been created) and
     set the thread state to `tstate', which must not be ‘NULL’.  If the
     lock has been created, the current thread must not have acquired
     it, otherwise deadlock ensues.

          Note: Calling this function from a thread when the runtime is
          finalizing will terminate the thread, even if the thread was
          not created by Python.  You can use ‘_Py_IsFinalizing()’ or
          *note sys.is_finalizing(): 756. to check if the interpreter is
          in process of being finalized before calling this function to
          avoid unwanted termination.

 -- C Function: PyThreadState* PyThreadState_Get ()

     Return the current thread state.  The global interpreter lock must
     be held.  When the current thread state is ‘NULL’, this issues a
     fatal error (so that the caller needn’t check for ‘NULL’).

 -- C Function: PyThreadState* PyThreadState_Swap
          (PyThreadState *tstate)

     Swap the current thread state with the thread state given by the
     argument `tstate', which may be ‘NULL’.  The global interpreter
     lock must be held and is not released.

The following functions use thread-local storage, and are not compatible
with sub-interpreters:

 -- C Function: PyGILState_STATE PyGILState_Ensure ()

     Ensure that the current thread is ready to call the Python C API
     regardless of the current state of Python, or of the global
     interpreter lock.  This may be called as many times as desired by a
     thread as long as each call is matched with a call to *note
     PyGILState_Release(): 3ee4.  In general, other thread-related APIs
     may be used between *note PyGILState_Ensure(): 2b4. and *note
     PyGILState_Release(): 3ee4. calls as long as the thread state is
     restored to its previous state before the Release().  For example,
     normal usage of the *note Py_BEGIN_ALLOW_THREADS: 3a6a. and *note
     Py_END_ALLOW_THREADS: 2b3. macros is acceptable.

     The return value is an opaque “handle” to the thread state when
     *note PyGILState_Ensure(): 2b4. was called, and must be passed to
     *note PyGILState_Release(): 3ee4. to ensure Python is left in the
     same state.  Even though recursive calls are allowed, these handles
     `cannot' be shared - each unique call to *note PyGILState_Ensure():
     2b4. must save the handle for its call to *note
     PyGILState_Release(): 3ee4.

     When the function returns, the current thread will hold the GIL and
     be able to call arbitrary Python code.  Failure is a fatal error.

          Note: Calling this function from a thread when the runtime is
          finalizing will terminate the thread, even if the thread was
          not created by Python.  You can use ‘_Py_IsFinalizing()’ or
          *note sys.is_finalizing(): 756. to check if the interpreter is
          in process of being finalized before calling this function to
          avoid unwanted termination.

 -- C Function: void PyGILState_Release (PyGILState_STATE)

     Release any resources previously acquired.  After this call,
     Python’s state will be the same as it was prior to the
     corresponding *note PyGILState_Ensure(): 2b4. call (but generally
     this state will be unknown to the caller, hence the use of the
     GILState API).

     Every call to *note PyGILState_Ensure(): 2b4. must be matched by a
     call to *note PyGILState_Release(): 3ee4. on the same thread.

 -- C Function: PyThreadState* PyGILState_GetThisThreadState ()

     Get the current thread state for this thread.  May return ‘NULL’ if
     no GILState API has been used on the current thread.  Note that the
     main thread always has such a thread-state, even if no
     auto-thread-state call has been made on the main thread.  This is
     mainly a helper/diagnostic function.

 -- C Function: int PyGILState_Check ()

     Return ‘1’ if the current thread is holding the GIL and ‘0’
     otherwise.  This function can be called from any thread at any
     time.  Only if it has had its Python thread state initialized and
     currently is holding the GIL will it return ‘1’.  This is mainly a
     helper/diagnostic function.  It can be useful for example in
     callback contexts or memory allocation functions when knowing that
     the GIL is locked can allow the caller to perform sensitive actions
     or otherwise behave differently.

     New in version 3.4.

The following macros are normally used without a trailing semicolon;
look for example usage in the Python source distribution.

 -- C Macro: Py_BEGIN_ALLOW_THREADS

     This macro expands to ‘{ PyThreadState *_save; _save =
     PyEval_SaveThread();’.  Note that it contains an opening brace; it
     must be matched with a following *note Py_END_ALLOW_THREADS: 2b3.
     macro.  See above for further discussion of this macro.

 -- C Macro: Py_END_ALLOW_THREADS

     This macro expands to ‘PyEval_RestoreThread(_save); }’.  Note that
     it contains a closing brace; it must be matched with an earlier
     *note Py_BEGIN_ALLOW_THREADS: 3a6a. macro.  See above for further
     discussion of this macro.

 -- C Macro: Py_BLOCK_THREADS

     This macro expands to ‘PyEval_RestoreThread(_save);’: it is
     equivalent to *note Py_END_ALLOW_THREADS: 2b3. without the closing
     brace.

 -- C Macro: Py_UNBLOCK_THREADS

     This macro expands to ‘_save = PyEval_SaveThread();’: it is
     equivalent to *note Py_BEGIN_ALLOW_THREADS: 3a6a. without the
     opening brace and variable declaration.


File: python.info,  Node: Low-level API,  Prev: High-level API,  Up: Thread State and the Global Interpreter Lock

7.9.5.5 Low-level API
.....................

All of the following functions must be called after *note
Py_Initialize(): 42e.

Changed in version 3.7: *note Py_Initialize(): 42e. now initializes the
*note GIL: bdd.

 -- C Function: PyInterpreterState* PyInterpreterState_New ()

     Create a new interpreter state object.  The global interpreter lock
     need not be held, but may be held if it is necessary to serialize
     calls to this function.

     Raises an *note auditing event: 1275.
     ‘cpython.PyInterpreterState_New’ with no arguments.

 -- C Function: void PyInterpreterState_Clear
          (PyInterpreterState *interp)

     Reset all information in an interpreter state object.  The global
     interpreter lock must be held.

     Raises an *note auditing event: 1275.
     ‘cpython.PyInterpreterState_Clear’ with no arguments.

 -- C Function: void PyInterpreterState_Delete
          (PyInterpreterState *interp)

     Destroy an interpreter state object.  The global interpreter lock
     need not be held.  The interpreter state must have been reset with
     a previous call to *note PyInterpreterState_Clear(): 3408.

 -- C Function: PyThreadState* PyThreadState_New
          (PyInterpreterState *interp)

     Create a new thread state object belonging to the given interpreter
     object.  The global interpreter lock need not be held, but may be
     held if it is necessary to serialize calls to this function.

 -- C Function: void PyThreadState_Clear (PyThreadState *tstate)

     Reset all information in a thread state object.  The global
     interpreter lock must be held.

 -- C Function: void PyThreadState_Delete (PyThreadState *tstate)

     Destroy a thread state object.  The global interpreter lock need
     not be held.  The thread state must have been reset with a previous
     call to *note PyThreadState_Clear(): 3eef.

 -- C Function: PY_INT64_T PyInterpreterState_GetID
          (PyInterpreterState *interp)

     Return the interpreter’s unique ID. If there was any error in doing
     so then ‘-1’ is returned and an error is set.

     New in version 3.7.

 -- C Function: PyObject* PyInterpreterState_GetDict
          (PyInterpreterState *interp)

     Return a dictionary in which interpreter-specific data may be
     stored.  If this function returns ‘NULL’ then no exception has been
     raised and the caller should assume no interpreter-specific dict is
     available.

     This is not a replacement for *note PyModule_GetState(): 3e19,
     which extensions should use to store interpreter-specific state
     information.

     New in version 3.8.

 -- C Function: PyObject* PyThreadState_GetDict ()
     `Return value: Borrowed reference.'  Return a dictionary in which
     extensions can store thread-specific state information.  Each
     extension should use a unique key to use to store state in the
     dictionary.  It is okay to call this function when no current
     thread state is available.  If this function returns ‘NULL’, no
     exception has been raised and the caller should assume no current
     thread state is available.

 -- C Function: int PyThreadState_SetAsyncExc (unsigned long id,
          PyObject *exc)

     Asynchronously raise an exception in a thread.  The `id' argument
     is the thread id of the target thread; `exc' is the exception
     object to be raised.  This function does not steal any references
     to `exc'.  To prevent naive misuse, you must write your own C
     extension to call this.  Must be called with the GIL held.  Returns
     the number of thread states modified; this is normally one, but
     will be zero if the thread id isn’t found.  If `exc' is ‘NULL’, the
     pending exception (if any) for the thread is cleared.  This raises
     no exceptions.

     Changed in version 3.7: The type of the `id' parameter changed from
     ‘long’ to ‘unsigned long’.

 -- C Function: void PyEval_AcquireThread (PyThreadState *tstate)

     Acquire the global interpreter lock and set the current thread
     state to `tstate', which should not be ‘NULL’.  The lock must have
     been created earlier.  If this thread already has the lock,
     deadlock ensues.

          Note: Calling this function from a thread when the runtime is
          finalizing will terminate the thread, even if the thread was
          not created by Python.  You can use ‘_Py_IsFinalizing()’ or
          *note sys.is_finalizing(): 756. to check if the interpreter is
          in process of being finalized before calling this function to
          avoid unwanted termination.

     Changed in version 3.8: Updated to be consistent with *note
     PyEval_RestoreThread(): 2b2, *note Py_END_ALLOW_THREADS(): 2b3, and
     *note PyGILState_Ensure(): 2b4, and terminate the current thread if
     called while the interpreter is finalizing.

     *note PyEval_RestoreThread(): 2b2. is a higher-level function which
     is always available (even when threads have not been initialized).

 -- C Function: void PyEval_ReleaseThread (PyThreadState *tstate)

     Reset the current thread state to ‘NULL’ and release the global
     interpreter lock.  The lock must have been created earlier and must
     be held by the current thread.  The `tstate' argument, which must
     not be ‘NULL’, is only used to check that it represents the current
     thread state — if it isn’t, a fatal error is reported.

     *note PyEval_SaveThread(): c04. is a higher-level function which is
     always available (even when threads have not been initialized).

 -- C Function: void PyEval_AcquireLock ()

     Acquire the global interpreter lock.  The lock must have been
     created earlier.  If this thread already has the lock, a deadlock
     ensues.

     Deprecated since version 3.2: This function does not update the
     current thread state.  Please use *note PyEval_RestoreThread():
     2b2. or *note PyEval_AcquireThread(): 2b1. instead.

          Note: Calling this function from a thread when the runtime is
          finalizing will terminate the thread, even if the thread was
          not created by Python.  You can use ‘_Py_IsFinalizing()’ or
          *note sys.is_finalizing(): 756. to check if the interpreter is
          in process of being finalized before calling this function to
          avoid unwanted termination.

     Changed in version 3.8: Updated to be consistent with *note
     PyEval_RestoreThread(): 2b2, *note Py_END_ALLOW_THREADS(): 2b3, and
     *note PyGILState_Ensure(): 2b4, and terminate the current thread if
     called while the interpreter is finalizing.

 -- C Function: void PyEval_ReleaseLock ()

     Release the global interpreter lock.  The lock must have been
     created earlier.

     Deprecated since version 3.2: This function does not update the
     current thread state.  Please use *note PyEval_SaveThread(): c04.
     or *note PyEval_ReleaseThread(): 3ef3. instead.


File: python.info,  Node: Sub-interpreter support,  Next: Asynchronous Notifications,  Prev: Thread State and the Global Interpreter Lock,  Up: Initialization Finalization and Threads

7.9.6 Sub-interpreter support
-----------------------------

While in most uses, you will only embed a single Python interpreter,
there are cases where you need to create several independent
interpreters in the same process and perhaps even in the same thread.
Sub-interpreters allow you to do that.

The “main” interpreter is the first one created when the runtime
initializes.  It is usually the only Python interpreter in a process.
Unlike sub-interpreters, the main interpreter has unique process-global
responsibilities like signal handling.  It is also responsible for
execution during runtime initialization and is usually the active
interpreter during runtime finalization.  The *note
PyInterpreterState_Main(): 3ef5. funtion returns a pointer to its state.

You can switch between sub-interpreters using the *note
PyThreadState_Swap(): 3ee7. function.  You can create and destroy them
using the following functions:

 -- C Function: PyThreadState* Py_NewInterpreter ()

     Create a new sub-interpreter.  This is an (almost) totally separate
     environment for the execution of Python code.  In particular, the
     new interpreter has separate, independent versions of all imported
     modules, including the fundamental modules *note builtins: 13,
     *note __main__: 1. and *note sys: fd.  The table of loaded modules
     (‘sys.modules’) and the module search path (‘sys.path’) are also
     separate.  The new environment has no ‘sys.argv’ variable.  It has
     new standard I/O stream file objects ‘sys.stdin’, ‘sys.stdout’ and
     ‘sys.stderr’ (however these refer to the same underlying file
     descriptors).

     The return value points to the first thread state created in the
     new sub-interpreter.  This thread state is made in the current
     thread state.  Note that no actual thread is created; see the
     discussion of thread states below.  If creation of the new
     interpreter is unsuccessful, ‘NULL’ is returned; no exception is
     set since the exception state is stored in the current thread state
     and there may not be a current thread state.  (Like all other
     Python/C API functions, the global interpreter lock must be held
     before calling this function and is still held when it returns;
     however, unlike most other Python/C API functions, there needn’t be
     a current thread state on entry.)

     Extension modules are shared between (sub-)interpreters as follows:
     the first time a particular extension is imported, it is
     initialized normally, and a (shallow) copy of its module’s
     dictionary is squirreled away.  When the same extension is imported
     by another (sub-)interpreter, a new module is initialized and
     filled with the contents of this copy; the extension’s ‘init’
     function is not called.  Note that this is different from what
     happens when an extension is imported after the interpreter has
     been completely re-initialized by calling *note Py_FinalizeEx():
     5be. and *note Py_Initialize(): 42e.; in that case, the extension’s
     ‘initmodule’ function `is' called again.

 -- C Function: void Py_EndInterpreter (PyThreadState *tstate)

     Destroy the (sub-)interpreter represented by the given thread
     state.  The given thread state must be the current thread state.
     See the discussion of thread states below.  When the call returns,
     the current thread state is ‘NULL’.  All thread states associated
     with this interpreter are destroyed.  (The global interpreter lock
     must be held before calling this function and is still held when it
     returns.)  *note Py_FinalizeEx(): 5be. will destroy all
     sub-interpreters that haven’t been explicitly destroyed at that
     point.

* Menu:

* Bugs and caveats::


File: python.info,  Node: Bugs and caveats,  Up: Sub-interpreter support

7.9.6.1 Bugs and caveats
........................

Because sub-interpreters (and the main interpreter) are part of the same
process, the insulation between them isn’t perfect — for example, using
low-level file operations like *note os.close(): 3c7. they can
(accidentally or maliciously) affect each other’s open files.  Because
of the way extensions are shared between (sub-)interpreters, some
extensions may not work properly; this is especially likely when the
extension makes use of (static) global variables, or when the extension
manipulates its module’s dictionary after its initialization.  It is
possible to insert objects created in one sub-interpreter into a
namespace of another sub-interpreter; this should be done with great
care to avoid sharing user-defined functions, methods, instances or
classes between sub-interpreters, since import operations executed by
such objects may affect the wrong (sub-)interpreter’s dictionary of
loaded modules.

Also note that combining this functionality with ‘PyGILState_*()’ APIs
is delicate, because these APIs assume a bijection between Python thread
states and OS-level threads, an assumption broken by the presence of
sub-interpreters.  It is highly recommended that you don’t switch
sub-interpreters between a pair of matching *note PyGILState_Ensure():
2b4. and *note PyGILState_Release(): 3ee4. calls.  Furthermore,
extensions (such as *note ctypes: 2b.) using these APIs to allow calling
of Python code from non-Python created threads will probably be broken
when using sub-interpreters.


File: python.info,  Node: Asynchronous Notifications,  Next: Profiling and Tracing,  Prev: Sub-interpreter support,  Up: Initialization Finalization and Threads

7.9.7 Asynchronous Notifications
--------------------------------

A mechanism is provided to make asynchronous notifications to the main
interpreter thread.  These notifications take the form of a function
pointer and a void pointer argument.

 -- C Function: int Py_AddPendingCall (int (*func)(void *), void *arg)

     Schedule a function to be called from the main interpreter thread.
     On success, ‘0’ is returned and `func' is queued for being called
     in the main thread.  On failure, ‘-1’ is returned without setting
     any exception.

     When successfully queued, `func' will be `eventually' called from
     the main interpreter thread with the argument `arg'.  It will be
     called asynchronously with respect to normally running Python code,
     but with both these conditions met:

        * on a *note bytecode: 609. boundary;

        * with the main thread holding the *note global interpreter
          lock: 4fb. (`func' can therefore use the full C API).

     `func' must return ‘0’ on success, or ‘-1’ on failure with an
     exception set.  `func' won’t be interrupted to perform another
     asynchronous notification recursively, but it can still be
     interrupted to switch threads if the global interpreter lock is
     released.

     This function doesn’t need a current thread state to run, and it
     doesn’t need the global interpreter lock.

          Warning: This is a low-level function, only useful for very
          special cases.  There is no guarantee that `func' will be
          called as quick as possible.  If the main thread is busy
          executing a system call, `func' won’t be called before the
          system call returns.  This function is generally `not'
          suitable for calling Python code from arbitrary C threads.
          Instead, use the *note PyGILState API: 3ee2.

     New in version 3.1.


File: python.info,  Node: Profiling and Tracing,  Next: Advanced Debugger Support,  Prev: Asynchronous Notifications,  Up: Initialization Finalization and Threads

7.9.8 Profiling and Tracing
---------------------------

The Python interpreter provides some low-level support for attaching
profiling and execution tracing facilities.  These are used for
profiling, debugging, and coverage analysis tools.

This C interface allows the profiling or tracing code to avoid the
overhead of calling through Python-level callable objects, making a
direct C function call instead.  The essential attributes of the
facility have not changed; the interface allows trace functions to be
installed per-thread, and the basic events reported to the trace
function are the same as had been reported to the Python-level trace
functions in previous versions.

 -- C Type: int (*Py_tracefunc) (PyObject *obj, PyFrameObject *frame,
          int what, PyObject *arg)

     The type of the trace function registered using *note
     PyEval_SetProfile(): e2e. and *note PyEval_SetTrace(): e2f.  The
     first parameter is the object passed to the registration function
     as `obj', `frame' is the frame object to which the event pertains,
     `what' is one of the constants ‘PyTrace_CALL’, ‘PyTrace_EXCEPTION’,
     ‘PyTrace_LINE’, ‘PyTrace_RETURN’, ‘PyTrace_C_CALL’,
     ‘PyTrace_C_EXCEPTION’, ‘PyTrace_C_RETURN’, or ‘PyTrace_OPCODE’, and
     `arg' depends on the value of `what':

     Value of `what'                    Meaning of `arg'
                                        
     --------------------------------------------------------------------------------
                                        
     ‘PyTrace_CALL’                     Always *note Py_None: 3a48.
                                        
                                        
     ‘PyTrace_EXCEPTION’                Exception information as returned by
                                        *note sys.exc_info(): c52.
                                        
                                        
     ‘PyTrace_LINE’                     Always *note Py_None: 3a48.
                                        
                                        
     ‘PyTrace_RETURN’                   Value being returned to the caller, or
                                        ‘NULL’ if caused by an exception.
                                        
                                        
     ‘PyTrace_C_CALL’                   Function object being called.
                                        
                                        
     ‘PyTrace_C_EXCEPTION’              Function object being called.
                                        
                                        
     ‘PyTrace_C_RETURN’                 Function object being called.
                                        
                                        
     ‘PyTrace_OPCODE’                   Always *note Py_None: 3a48.
                                        

 -- C Variable: int PyTrace_CALL

     The value of the `what' parameter to a *note Py_tracefunc: 3efb.
     function when a new call to a function or method is being reported,
     or a new entry into a generator.  Note that the creation of the
     iterator for a generator function is not reported as there is no
     control transfer to the Python bytecode in the corresponding frame.

 -- C Variable: int PyTrace_EXCEPTION

     The value of the `what' parameter to a *note Py_tracefunc: 3efb.
     function when an exception has been raised.  The callback function
     is called with this value for `what' when after any bytecode is
     processed after which the exception becomes set within the frame
     being executed.  The effect of this is that as exception
     propagation causes the Python stack to unwind, the callback is
     called upon return to each frame as the exception propagates.  Only
     trace functions receives these events; they are not needed by the
     profiler.

 -- C Variable: int PyTrace_LINE

     The value passed as the `what' parameter to a *note Py_tracefunc:
     3efb. function (but not a profiling function) when a line-number
     event is being reported.  It may be disabled for a frame by setting
     ‘f_trace_lines’ to `0' on that frame.

 -- C Variable: int PyTrace_RETURN

     The value for the `what' parameter to *note Py_tracefunc: 3efb.
     functions when a call is about to return.

 -- C Variable: int PyTrace_C_CALL

     The value for the `what' parameter to *note Py_tracefunc: 3efb.
     functions when a C function is about to be called.

 -- C Variable: int PyTrace_C_EXCEPTION

     The value for the `what' parameter to *note Py_tracefunc: 3efb.
     functions when a C function has raised an exception.

 -- C Variable: int PyTrace_C_RETURN

     The value for the `what' parameter to *note Py_tracefunc: 3efb.
     functions when a C function has returned.

 -- C Variable: int PyTrace_OPCODE

     The value for the `what' parameter to *note Py_tracefunc: 3efb.
     functions (but not profiling functions) when a new opcode is about
     to be executed.  This event is not emitted by default: it must be
     explicitly requested by setting ‘f_trace_opcodes’ to `1' on the
     frame.

 -- C Function: void PyEval_SetProfile (Py_tracefunc func,
          PyObject *obj)

     Set the profiler function to `func'.  The `obj' parameter is passed
     to the function as its first parameter, and may be any Python
     object, or ‘NULL’.  If the profile function needs to maintain
     state, using a different value for `obj' for each thread provides a
     convenient and thread-safe place to store it.  The profile function
     is called for all monitored events except ‘PyTrace_LINE’
     ‘PyTrace_OPCODE’ and ‘PyTrace_EXCEPTION’.

 -- C Function: void PyEval_SetTrace (Py_tracefunc func, PyObject *obj)

     Set the tracing function to `func'.  This is similar to *note
     PyEval_SetProfile(): e2e, except the tracing function does receive
     line-number events and per-opcode events, but does not receive any
     event related to C function objects being called.  Any trace
     function registered using *note PyEval_SetTrace(): e2f. will not
     receive ‘PyTrace_C_CALL’, ‘PyTrace_C_EXCEPTION’ or
     ‘PyTrace_C_RETURN’ as a value for the `what' parameter.


File: python.info,  Node: Advanced Debugger Support,  Next: Thread Local Storage Support,  Prev: Profiling and Tracing,  Up: Initialization Finalization and Threads

7.9.9 Advanced Debugger Support
-------------------------------

These functions are only intended to be used by advanced debugging
tools.

 -- C Function: PyInterpreterState* PyInterpreterState_Head ()

     Return the interpreter state object at the head of the list of all
     such objects.

 -- C Function: PyInterpreterState* PyInterpreterState_Main ()

     Return the main interpreter state object.

 -- C Function: PyInterpreterState* PyInterpreterState_Next
          (PyInterpreterState *interp)

     Return the next interpreter state object after `interp' from the
     list of all such objects.

 -- C Function: PyThreadState * PyInterpreterState_ThreadHead
          (PyInterpreterState *interp)

     Return the pointer to the first *note PyThreadState: 3edf. object
     in the list of threads associated with the interpreter `interp'.

 -- C Function: PyThreadState* PyThreadState_Next
          (PyThreadState *tstate)

     Return the next thread state object after `tstate' from the list of
     all such objects belonging to the same *note PyInterpreterState:
     2c0. object.


File: python.info,  Node: Thread Local Storage Support,  Prev: Advanced Debugger Support,  Up: Initialization Finalization and Threads

7.9.10 Thread Local Storage Support
-----------------------------------

The Python interpreter provides low-level support for thread-local
storage (TLS) which wraps the underlying native TLS implementation to
support the Python-level thread local storage API (*note
threading.local: 2236.).  The CPython C level APIs are similar to those
offered by pthreads and Windows: use a thread key and functions to
associate a ‘void*’ value per thread.

The GIL does `not' need to be held when calling these functions; they
supply their own locking.

Note that ‘Python.h’ does not include the declaration of the TLS APIs,
you need to include ‘pythread.h’ to use thread-local storage.

     Note: None of these API functions handle memory management on
     behalf of the ‘void*’ values.  You need to allocate and deallocate
     them yourself.  If the ‘void*’ values happen to be *note PyObject*:
     4b0, these functions don’t do refcount operations on them either.

* Menu:

* Thread Specific Storage (TSS) API: Thread Specific Storage TSS API.
* Thread Local Storage (TLS) API: Thread Local Storage TLS API.


File: python.info,  Node: Thread Specific Storage TSS API,  Next: Thread Local Storage TLS API,  Up: Thread Local Storage Support

7.9.10.1 Thread Specific Storage (TSS) API
..........................................

TSS API is introduced to supersede the use of the existing TLS API
within the CPython interpreter.  This API uses a new type *note
Py_tss_t: 30d. instead of ‘int’ to represent thread keys.

New in version 3.7.

See also
........

“A New C-API for Thread-Local Storage in CPython” ( PEP 539(1))

 -- C Type: Py_tss_t

     This data structure represents the state of a thread key, the
     definition of which may depend on the underlying TLS
     implementation, and it has an internal field representing the key’s
     initialization state.  There are no public members in this
     structure.

     When *note Py_LIMITED_API: 3b05. is not defined, static allocation
     of this type by *note Py_tss_NEEDS_INIT: 3f09. is allowed.

 -- C Macro: Py_tss_NEEDS_INIT

     This macro expands to the initializer for *note Py_tss_t: 30d.
     variables.  Note that this macro won’t be defined with *note
     Py_LIMITED_API: 3b05.

* Menu:

* Dynamic Allocation::
* Methods: Methods<4>.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0539


File: python.info,  Node: Dynamic Allocation,  Next: Methods<4>,  Up: Thread Specific Storage TSS API

7.9.10.2 Dynamic Allocation
...........................

Dynamic allocation of the *note Py_tss_t: 30d, required in extension
modules built with *note Py_LIMITED_API: 3b05, where static allocation
of this type is not possible due to its implementation being opaque at
build time.

 -- C Function: Py_tss_t* PyThread_tss_alloc ()

     Return a value which is the same state as a value initialized with
     *note Py_tss_NEEDS_INIT: 3f09, or ‘NULL’ in the case of dynamic
     allocation failure.

 -- C Function: void PyThread_tss_free (Py_tss_t *key)

     Free the given `key' allocated by *note PyThread_tss_alloc(): 3f0b,
     after first calling *note PyThread_tss_delete(): 3f0d. to ensure
     any associated thread locals have been unassigned.  This is a no-op
     if the `key' argument is ‘NULL’.

          Note: A freed key becomes a dangling pointer, you should reset
          the key to ‘NULL’.


File: python.info,  Node: Methods<4>,  Prev: Dynamic Allocation,  Up: Thread Specific Storage TSS API

7.9.10.3 Methods
................

The parameter `key' of these functions must not be ‘NULL’.  Moreover,
the behaviors of *note PyThread_tss_set(): 3f0f. and *note
PyThread_tss_get(): 3f10. are undefined if the given *note Py_tss_t:
30d. has not been initialized by *note PyThread_tss_create(): 3f11.

 -- C Function: int PyThread_tss_is_created (Py_tss_t *key)

     Return a non-zero value if the given *note Py_tss_t: 30d. has been
     initialized by *note PyThread_tss_create(): 3f11.

 -- C Function: int PyThread_tss_create (Py_tss_t *key)

     Return a zero value on successful initialization of a TSS key.  The
     behavior is undefined if the value pointed to by the `key' argument
     is not initialized by *note Py_tss_NEEDS_INIT: 3f09.  This function
     can be called repeatedly on the same key – calling it on an already
     initialized key is a no-op and immediately returns success.

 -- C Function: void PyThread_tss_delete (Py_tss_t *key)

     Destroy a TSS key to forget the values associated with the key
     across all threads, and change the key’s initialization state to
     uninitialized.  A destroyed key is able to be initialized again by
     *note PyThread_tss_create(): 3f11.  This function can be called
     repeatedly on the same key – calling it on an already destroyed key
     is a no-op.

 -- C Function: int PyThread_tss_set (Py_tss_t *key, void *value)

     Return a zero value to indicate successfully associating a ‘void*’
     value with a TSS key in the current thread.  Each thread has a
     distinct mapping of the key to a ‘void*’ value.

 -- C Function: void* PyThread_tss_get (Py_tss_t *key)

     Return the ‘void*’ value associated with a TSS key in the current
     thread.  This returns ‘NULL’ if no value is associated with the key
     in the current thread.


File: python.info,  Node: Thread Local Storage TLS API,  Prev: Thread Specific Storage TSS API,  Up: Thread Local Storage Support

7.9.10.4 Thread Local Storage (TLS) API
.......................................

Deprecated since version 3.7: This API is superseded by *note Thread
Specific Storage (TSS) API: 30c.

     Note: This version of the API does not support platforms where the
     native TLS key is defined in a way that cannot be safely cast to
     ‘int’.  On such platforms, *note PyThread_create_key(): 3f14. will
     return immediately with a failure status, and the other TLS
     functions will all be no-ops on such platforms.

Due to the compatibility problem noted above, this version of the API
should not be used in new code.

 -- C Function: int PyThread_create_key ()

 -- C Function: void PyThread_delete_key (int key)

 -- C Function: int PyThread_set_key_value (int key, void *value)

 -- C Function: void* PyThread_get_key_value (int key)

 -- C Function: void PyThread_delete_key_value (int key)

 -- C Function: void PyThread_ReInitTLS ()


File: python.info,  Node: Python Initialization Configuration,  Next: Memory Management,  Prev: Initialization Finalization and Threads,  Up: Python/C API Reference Manual

7.10 Python Initialization Configuration
========================================

New in version 3.8.

Structures:

   * *note PyConfig: 15f.

   * *note PyPreConfig: 160.

   * *note PyStatus: 161.

   * *note PyWideStringList: 162.

Functions:

   * *note PyConfig_Clear(): 163.

   * *note PyConfig_InitIsolatedConfig(): 164.

   * *note PyConfig_InitPythonConfig(): 165.

   * *note PyConfig_Read(): 166.

   * *note PyConfig_SetArgv(): 167.

   * *note PyConfig_SetBytesArgv(): 168.

   * *note PyConfig_SetBytesString(): 169.

   * *note PyConfig_SetString(): 16a.

   * *note PyConfig_SetWideStringList(): 3f1b.

   * *note PyPreConfig_InitIsolatedConfig(): 16b.

   * *note PyPreConfig_InitPythonConfig(): 16c.

   * *note PyStatus_Error(): 16d.

   * *note PyStatus_Exception(): 16e.

   * *note PyStatus_Exit(): 16f.

   * *note PyStatus_IsError(): 170.

   * *note PyStatus_IsExit(): 171.

   * *note PyStatus_NoMemory(): 172.

   * *note PyStatus_Ok(): 173.

   * *note PyWideStringList_Append(): 174.

   * *note PyWideStringList_Insert(): 175.

   * *note Py_ExitStatusException(): 177.

   * *note Py_InitializeFromConfig(): 178.

   * *note Py_PreInitialize(): 179.

   * *note Py_PreInitializeFromArgs(): 17a.

   * *note Py_PreInitializeFromBytesArgs(): 17b.

   * *note Py_RunMain(): 17c.

The preconfiguration (‘PyPreConfig’ type) is stored in
‘_PyRuntime.preconfig’ and the configuration (‘PyConfig’ type) is stored
in ‘PyInterpreterState.config’.

See also *note Initialization, Finalization, and Threads: 3ebf.

See also
........

PEP 587(1) “Python Initialization Configuration”.

* Menu:

* PyWideStringList::
* PyStatus::
* PyPreConfig::
* Preinitialization with PyPreConfig::
* PyConfig::
* Initialization with PyConfig::
* Isolated Configuration::
* Python Configuration::
* Path Configuration::
* Py_RunMain(): Py_RunMain.
* Multi-Phase Initialization Private Provisional API::

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0587


File: python.info,  Node: PyWideStringList,  Next: PyStatus,  Up: Python Initialization Configuration

7.10.1 PyWideStringList
-----------------------

 -- C Type: PyWideStringList

     List of ‘wchar_t*’ strings.

     If `length' is non-zero, `items' must be non-‘NULL’ and all strings
     must be non-‘NULL’.

     Methods:

      -- C Function: PyStatus PyWideStringList_Append
               (PyWideStringList *list, const wchar_t *item)

          Append `item' to `list'.

          Python must be preinitialized to call this function.

      -- C Function: PyStatus PyWideStringList_Insert
               (PyWideStringList *list, Py_ssize_t index, const
               wchar_t *item)

          Insert `item' into `list' at `index'.

          If `index' is greater than or equal to `list' length, append
          `item' to `list'.

          `index' must be greater than or equal to 0.

          Python must be preinitialized to call this function.

     Structure fields:

      -- C Member: Py_ssize_t length

          List length.

      -- C Member: wchar_t** items

          List items.


File: python.info,  Node: PyStatus,  Next: PyPreConfig,  Prev: PyWideStringList,  Up: Python Initialization Configuration

7.10.2 PyStatus
---------------

 -- C Type: PyStatus

     Structure to store an initialization function status: success,
     error or exit.

     For an error, it can store the C function name which created the
     error.

     Structure fields:

      -- C Member: int exitcode

          Exit code.  Argument passed to ‘exit()’.

      -- C Member: const char *err_msg

          Error message.

      -- C Member: const char *func

          Name of the function which created an error, can be ‘NULL’.

     Functions to create a status:

      -- C Function: PyStatus PyStatus_Ok (void)

          Success.

      -- C Function: PyStatus PyStatus_Error (const char *err_msg)

          Initialization error with a message.

      -- C Function: PyStatus PyStatus_NoMemory (void)

          Memory allocation failure (out of memory).

      -- C Function: PyStatus PyStatus_Exit (int exitcode)

          Exit Python with the specified exit code.

     Functions to handle a status:

      -- C Function: int PyStatus_Exception (PyStatus status)

          Is the status an error or an exit?  If true, the exception
          must be handled; by calling *note Py_ExitStatusException():
          177. for example.

      -- C Function: int PyStatus_IsError (PyStatus status)

          Is the result an error?

      -- C Function: int PyStatus_IsExit (PyStatus status)

          Is the result an exit?

      -- C Function: void Py_ExitStatusException (PyStatus status)

          Call ‘exit(exitcode)’ if `status' is an exit.  Print the error
          message and exit with a non-zero exit code if `status' is an
          error.  Must only be called if ‘PyStatus_Exception(status)’ is
          non-zero.

     Note: Internally, Python uses macros which set ‘PyStatus.func’,
     whereas functions to create a status set ‘func’ to ‘NULL’.

Example:

     PyStatus alloc(void **ptr, size_t size) {     *ptr = PyMem_RawMalloc(size);     if (*ptr == NULL) {         return PyStatus_NoMemory();     }     return PyStatus_Ok(); }  int main(int argc, char **argv) {     void *ptr;     PyStatus status = alloc(&ptr, 16);     if (PyStatus_Exception(status)) {         Py_ExitStatusException(status);     }     PyMem_Free(ptr);     return 0; }


File: python.info,  Node: PyPreConfig,  Next: Preinitialization with PyPreConfig,  Prev: PyStatus,  Up: Python Initialization Configuration

7.10.3 PyPreConfig
------------------

 -- C Type: PyPreConfig

     Structure used to preinitialize Python:

        * Set the Python memory allocator

        * Configure the LC_CTYPE locale

        * Set the UTF-8 mode

     Function to initialize a preconfiguration:

      -- C Function: void PyPreConfig_InitIsolatedConfig
               (PyPreConfig *preconfig)

          Initialize the preconfiguration with *note Python
          Configuration: 3f24.

      -- C Function: void PyPreConfig_InitPythonConfig
               (PyPreConfig *preconfig)

          Initialize the preconfiguration with *note Isolated
          Configuration: 3f25.

     Structure fields:

      -- C Member: int allocator

          Name of the memory allocator:

             * ‘PYMEM_ALLOCATOR_NOT_SET’ (‘0’): don’t change memory
               allocators (use defaults)

             * ‘PYMEM_ALLOCATOR_DEFAULT’ (‘1’): default memory
               allocators

             * ‘PYMEM_ALLOCATOR_DEBUG’ (‘2’): default memory allocators
               with debug hooks

             * ‘PYMEM_ALLOCATOR_MALLOC’ (‘3’): force usage of ‘malloc()’

             * ‘PYMEM_ALLOCATOR_MALLOC_DEBUG’ (‘4’): force usage of
               ‘malloc()’ with debug hooks

             * ‘PYMEM_ALLOCATOR_PYMALLOC’ (‘5’): *note Python pymalloc
               memory allocator: 5b6.

             * ‘PYMEM_ALLOCATOR_PYMALLOC_DEBUG’ (‘6’): *note Python
               pymalloc memory allocator: 5b6. with debug hooks

          ‘PYMEM_ALLOCATOR_PYMALLOC’ and
          ‘PYMEM_ALLOCATOR_PYMALLOC_DEBUG’ are not supported if Python
          is configured using ‘--without-pymalloc’

          See *note Memory Management: 3f27.

      -- C Member: int configure_locale

          Set the LC_CTYPE locale to the user preferred locale?  If
          equals to 0, set ‘coerce_c_locale’ and ‘coerce_c_locale_warn’
          to 0.

      -- C Member: int coerce_c_locale

          If equals to 2, coerce the C locale; if equals to 1, read the
          LC_CTYPE locale to decide if it should be coerced.

      -- C Member: int coerce_c_locale_warn

          If non-zero, emit a warning if the C locale is coerced.

      -- C Member: int dev_mode

          See *note PyConfig.dev_mode: 3f2c.

      -- C Member: int isolated

          See *note PyConfig.isolated: 3f2e.

      -- C Member: int legacy_windows_fs_encoding (Windows only)

          If non-zero, disable UTF-8 Mode, set the Python filesystem
          encoding to ‘mbcs’, set the filesystem error handler to
          ‘replace’.

          Only available on Windows.  ‘#ifdef MS_WINDOWS’ macro can be
          used for Windows specific code.

      -- C Member: int parse_argv

          If non-zero, *note Py_PreInitializeFromArgs(): 17a. and *note
          Py_PreInitializeFromBytesArgs(): 17b. parse their ‘argv’
          argument the same way the regular Python parses command line
          arguments: see *note Command Line Arguments: 91f.

      -- C Member: int use_environment

          See *note PyConfig.use_environment: 3f32.

      -- C Member: int utf8_mode

          If non-zero, enable the UTF-8 mode.


File: python.info,  Node: Preinitialization with PyPreConfig,  Next: PyConfig,  Prev: PyPreConfig,  Up: Python Initialization Configuration

7.10.4 Preinitialization with PyPreConfig
-----------------------------------------

Functions to preinitialize Python:

 -- C Function: PyStatus Py_PreInitialize (const PyPreConfig *preconfig)

     Preinitialize Python from `preconfig' preconfiguration.

 -- C Function: PyStatus Py_PreInitializeFromBytesArgs (const
          PyPreConfig *preconfig, int argc, char * const *argv)

     Preinitialize Python from `preconfig' preconfiguration and command
     line arguments (bytes strings).

 -- C Function: PyStatus Py_PreInitializeFromArgs (const
          PyPreConfig *preconfig, int argc, wchar_t * const * argv)

     Preinitialize Python from `preconfig' preconfiguration and command
     line arguments (wide strings).

The caller is responsible to handle exceptions (error or exit) using
*note PyStatus_Exception(): 16e. and *note Py_ExitStatusException():
177.

For *note Python Configuration: 3f24. (*note
PyPreConfig_InitPythonConfig(): 16c.), if Python is initialized with
command line arguments, the command line arguments must also be passed
to preinitialize Python, since they have an effect on the
pre-configuration like encodings.  For example, the *note -X utf8: 155.
command line option enables the UTF-8 Mode.

‘PyMem_SetAllocator()’ can be called after *note Py_PreInitialize():
179. and before *note Py_InitializeFromConfig(): 178. to install a
custom memory allocator.  It can be called before *note
Py_PreInitialize(): 179. if *note PyPreConfig.allocator: 3f26. is set to
‘PYMEM_ALLOCATOR_NOT_SET’.

Python memory allocation functions like *note PyMem_RawMalloc(): 961.
must not be used before Python preinitialization, whereas calling
directly ‘malloc()’ and ‘free()’ is always safe.  *note
Py_DecodeLocale(): 431. must not be called before the preinitialization.

Example using the preinitialization to enable the UTF-8 Mode:

     PyStatus status; PyPreConfig preconfig; PyPreConfig_InitPythonConfig(&preconfig);  preconfig.utf8_mode = 1;  status = Py_PreInitialize(&preconfig); if (PyStatus_Exception(status)) {     Py_ExitStatusException(status); }  /* at this point, Python will speak UTF-8 */  Py_Initialize(); /* ... use Python API here ... */ Py_Finalize();


File: python.info,  Node: PyConfig,  Next: Initialization with PyConfig,  Prev: Preinitialization with PyPreConfig,  Up: Python Initialization Configuration

7.10.5 PyConfig
---------------

 -- C Type: PyConfig

     Structure containing most parameters to configure Python.

     Structure methods:

      -- C Function: void PyConfig_InitPythonConfig (PyConfig *config)

          Initialize configuration with *note Python Configuration:
          3f24.

      -- C Function: void PyConfig_InitIsolatedConfig (PyConfig *config)

          Initialize configuration with *note Isolated Configuration:
          3f25.

      -- C Function: PyStatus PyConfig_SetString (PyConfig *config,
               wchar_t * const *config_str, const wchar_t *str)

          Copy the wide character string `str' into ‘*config_str’.

          Preinitialize Python if needed.

      -- C Function: PyStatus PyConfig_SetBytesString (PyConfig *config,
               wchar_t * const *config_str, const char *str)

          Decode `str' using ‘Py_DecodeLocale()’ and set the result into
          ‘*config_str’.

          Preinitialize Python if needed.

      -- C Function: PyStatus PyConfig_SetArgv (PyConfig *config,
               int argc, wchar_t * const *argv)

          Set command line arguments from wide character strings.

          Preinitialize Python if needed.

      -- C Function: PyStatus PyConfig_SetBytesArgv (PyConfig *config,
               int argc, char * const *argv)

          Set command line arguments: decode bytes using *note
          Py_DecodeLocale(): 431.

          Preinitialize Python if needed.

      -- C Function: PyStatus PyConfig_SetWideStringList
               (PyConfig *config, PyWideStringList *list,
               Py_ssize_t length, wchar_t **items)

          Set the list of wide strings `list' to `length' and `items'.

          Preinitialize Python if needed.

      -- C Function: PyStatus PyConfig_Read (PyConfig *config)

          Read all Python configuration.

          Fields which are already initialized are left unchanged.

          Preinitialize Python if needed.

      -- C Function: void PyConfig_Clear (PyConfig *config)

          Release configuration memory.

     Most ‘PyConfig’ methods preinitialize Python if needed.  In that
     case, the Python preinitialization configuration in based on the
     *note PyConfig: 15f.  If configuration fields which are in common
     with *note PyPreConfig: 160. are tuned, they must be set before
     calling a *note PyConfig: 15f. method:

        * *note dev_mode: 3f2c.

        * *note isolated: 3f2e.

        * *note parse_argv: 3f36.

        * *note use_environment: 3f32.

     Moreover, if *note PyConfig_SetArgv(): 167. or *note
     PyConfig_SetBytesArgv(): 168. is used, this method must be called
     first, before other methods, since the preinitialization
     configuration depends on command line arguments (if ‘parse_argv’ is
     non-zero).

     The caller of these methods is responsible to handle exceptions
     (error or exit) using ‘PyStatus_Exception()’ and
     ‘Py_ExitStatusException()’.

     Structure fields:

      -- C Member: PyWideStringList argv

          Command line arguments, *note sys.argv: bee.  See *note
          parse_argv: 3f36. to parse *note argv: 3f37. the same way the
          regular Python parses Python command line arguments.  If *note
          argv: 3f37. is empty, an empty string is added to ensure that
          *note sys.argv: bee. always exists and is never empty.

      -- C Member: wchar_t* base_exec_prefix

          *note sys.base_exec_prefix: 3537.

      -- C Member: wchar_t* base_executable

          ‘sys._base_executable’: ‘__PYVENV_LAUNCHER__’ environment
          variable value, or copy of *note PyConfig.executable: 3f3a.

      -- C Member: wchar_t* base_prefix

          *note sys.base_prefix: 3536.

      -- C Member: int buffered_stdio

          If equals to 0, enable unbuffered mode, making the stdout and
          stderr streams unbuffered.

          stdin is always opened in buffered mode.

      -- C Member: int bytes_warning

          If equals to 1, issue a warning when comparing *note bytes:
          326. or *note bytearray: 327. with *note str: 325, or
          comparing *note bytes: 326. with *note int: 184.  If equal or
          greater to 2, raise a *note BytesWarning: 4ab. exception.

      -- C Member: wchar_t* check_hash_pycs_mode

          Control the validation behavior of hash-based ‘.pyc’ files
          (see PEP 552(1)): *note –check-hash-based-pycs: 127c. command
          line option value.

          Valid values: ‘always’, ‘never’ and ‘default’.

          The default value is: ‘default’.

      -- C Member: int configure_c_stdio

          If non-zero, configure C standard streams (‘stdio’, ‘stdout’,
          ‘stdout’).  For example, set their mode to ‘O_BINARY’ on
          Windows.

      -- C Member: int dev_mode

          Development mode: see *note -X dev: 155.

      -- C Member: int dump_refs

          If non-zero, dump all objects which are still alive at exit.

          Require a debug build of Python (‘Py_REF_DEBUG’ macro must be
          defined).

      -- C Member: wchar_t* exec_prefix

          *note sys.exec_prefix: 3535.

      -- C Member: wchar_t* executable

          *note sys.executable: 272.

      -- C Member: int faulthandler

          If non-zero, call *note faulthandler.enable(): 53d. at
          startup.

      -- C Member: wchar_t* filesystem_encoding

          Filesystem encoding, *note sys.getfilesystemencoding(): 4eb.

      -- C Member: wchar_t* filesystem_errors

          Filesystem encoding errors, *note
          sys.getfilesystemencodeerrors(): 589.

      -- C Member: unsigned long hash_seed

      -- C Member: int use_hash_seed

          Randomized hash function seed.

          If *note use_hash_seed: 3f46. is zero, a seed is chosen
          randomly at Pythonstartup, and *note hash_seed: 3f45. is
          ignored.

      -- C Member: wchar_t* home

          Python home directory.

          Initialized from *note PYTHONHOME: 4cb. environment variable
          value by default.

      -- C Member: int import_time

          If non-zero, profile import time.

      -- C Member: int inspect

          Enter interactive mode after executing a script or a command.

      -- C Member: int install_signal_handlers

          Install signal handlers?

      -- C Member: int interactive

          Interactive mode.

      -- C Member: int isolated

          If greater than 0, enable isolated mode:

             * *note sys.path: 47d. contains neither the script’s
               directory (computed from ‘argv[0]’ or the current
               directory) nor the user’s site-packages directory.

             * Python REPL doesn’t import *note readline: de. nor enable
               default readline configuration on interactive prompts.

             * Set *note use_environment: 3f32. and *note
               user_site_directory: 3f4c. to 0.

      -- C Member: int legacy_windows_stdio

          If non-zero, use *note io.FileIO: c97. instead of
          ‘io.WindowsConsoleIO’ for *note sys.stdin: 302, *note
          sys.stdout: 303. and *note sys.stderr: 304.

          Only available on Windows.  ‘#ifdef MS_WINDOWS’ macro can be
          used for Windows specific code.

      -- C Member: int malloc_stats

          If non-zero, dump statistics on *note Python pymalloc memory
          allocator: 5b6. at exit.

          The option is ignored if Python is built using
          ‘--without-pymalloc’.

      -- C Member: wchar_t* pythonpath_env

          Module search paths as a string separated by ‘DELIM’
          (‘os.path.pathsep’).

          Initialized from *note PYTHONPATH: 947. environment variable
          value by default.

      -- C Member: PyWideStringList module_search_paths

      -- C Member: int module_search_paths_set

          *note sys.path: 47d.  If *note module_search_paths_set: 3f51.
          is equal to 0, the *note module_search_paths: 3f50. is
          overridden by the function calculating the *note Path
          Configuration: 3f52.

      -- C Member: int optimization_level

          Compilation optimization level:

             * 0: Peephole optimizer (and ‘__debug__’ is set to ‘True’)

             * 1: Remove assertions, set ‘__debug__’ to ‘False’

             * 2: Strip docstrings

      -- C Member: int parse_argv

          If non-zero, parse *note argv: 3f37. the same way the regular
          Python command line arguments, and strip Python arguments from
          *note argv: 3f37.: see *note Command Line Arguments: 91f.

      -- C Member: int parser_debug

          If non-zero, turn on parser debugging output (for expert only,
          depending on compilation options).

      -- C Member: int pathconfig_warnings

          If equal to 0, suppress warnings when calculating the *note
          Path Configuration: 3f52. (Unix only, Windows does not log any
          warning).  Otherwise, warnings are written into ‘stderr’.

      -- C Member: wchar_t* prefix

          *note sys.prefix: 2f7b.

      -- C Member: wchar_t* program_name

          Program name.  Used to initialize *note executable: 3f3a, and
          in early error messages.

      -- C Member: wchar_t* pycache_prefix

          *note sys.pycache_prefix: 156.: ‘.pyc’ cache prefix.

          If ‘NULL’, *note sys.pycache_prefix: 156. is set to ‘None’.

      -- C Member: int quiet

          Quiet mode.  For example, don’t display the copyright and
          version messages in interactive mode.

      -- C Member: wchar_t* run_command

          ‘python3 -c COMMAND’ argument.  Used by *note Py_RunMain():
          17c.

      -- C Member: wchar_t* run_filename

          ‘python3 FILENAME’ argument.  Used by *note Py_RunMain(): 17c.

      -- C Member: wchar_t* run_module

          ‘python3 -m MODULE’ argument.  Used by *note Py_RunMain():
          17c.

      -- C Member: int show_alloc_count

          Show allocation counts at exit?

          Set to 1 by *note -X showalloccount: 155. command line option.

          Need a special Python build with ‘COUNT_ALLOCS’ macro defined.

      -- C Member: int show_ref_count

          Show total reference count at exit?

          Set to 1 by *note -X showrefcount: 155. command line option.

          Need a debug build of Python (‘Py_REF_DEBUG’ macro must be
          defined).

      -- C Member: int site_import

          Import the *note site: eb. module at startup?

      -- C Member: int skip_source_first_line

          Skip the first line of the source?

      -- C Member: wchar_t* stdio_encoding

      -- C Member: wchar_t* stdio_errors

          Encoding and encoding errors of *note sys.stdin: 302, *note
          sys.stdout: 303. and *note sys.stderr: 304.

      -- C Member: int tracemalloc

          If non-zero, call *note tracemalloc.start(): 128a. at startup.

      -- C Member: int use_environment

          If greater than 0, use *note environment variables: 128f.

      -- C Member: int user_site_directory

          If non-zero, add user site directory to *note sys.path: 47d.

      -- C Member: int verbose

          If non-zero, enable verbose mode.

      -- C Member: PyWideStringList warnoptions

          *note sys.warnoptions: 40b.: options of the *note warnings:
          126. module to build warnings filters: lowest to highest
          priority.

          The *note warnings: 126. module adds *note sys.warnoptions:
          40b. in the reverse order: the last *note
          PyConfig.warnoptions: 3f65. item becomes the first item of
          ‘warnings.filters’ which is checked first (highest priority).

      -- C Member: int write_bytecode

          If non-zero, write ‘.pyc’ files.

          *note sys.dont_write_bytecode: 3564. is initialized to the
          inverted value of *note write_bytecode: 3f66.

      -- C Member: PyWideStringList xoptions

          *note sys._xoptions: 128c.

If ‘parse_argv’ is non-zero, ‘argv’ arguments are parsed the same way
the regular Python parses command line arguments, and Python arguments
are stripped from ‘argv’: see *note Command Line Arguments: 91f.

The ‘xoptions’ options are parsed to set other options: see *note -X:
155. option.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0552


File: python.info,  Node: Initialization with PyConfig,  Next: Isolated Configuration,  Prev: PyConfig,  Up: Python Initialization Configuration

7.10.6 Initialization with PyConfig
-----------------------------------

Function to initialize Python:

 -- C Function: PyStatus Py_InitializeFromConfig (const
          PyConfig *config)

     Initialize Python from `config' configuration.

The caller is responsible to handle exceptions (error or exit) using
*note PyStatus_Exception(): 16e. and *note Py_ExitStatusException():
177.

If ‘PyImport_FrozenModules’, ‘PyImport_AppendInittab()’ or
‘PyImport_ExtendInittab()’ are used, they must be set or called after
Python preinitialization and before the Python initialization.

Example setting the program name:

     void init_python(void) {     PyStatus status;      PyConfig config;     PyConfig_InitPythonConfig(&config);      /* Set the program name. Implicitly preinitialize Python. */     status = PyConfig_SetString(&config, &config.program_name,                                 L"/path/to/my_program");     if (PyStatus_Exception(status)) {         goto fail;     }      status = Py_InitializeFromConfig(&config);     if (PyStatus_Exception(status)) {         goto fail;     }     PyConfig_Clear(&config);     return;  fail:     PyConfig_Clear(&config);     Py_ExitStatusException(status); }

More complete example modifying the default configuration, read the
configuration, and then override some parameters:

     PyStatus init_python(const char *program_name) {     PyStatus status;      PyConfig config;     PyConfig_InitPythonConfig(&config);      /* Set the program name before reading the configuraton        (decode byte string from the locale encoding).         Implicitly preinitialize Python. */     status = PyConfig_SetBytesString(&config, &config.program_name,                                   program_name);     if (PyStatus_Exception(status)) {         goto done;     }      /* Read all configuration at once */     status = PyConfig_Read(&config);     if (PyStatus_Exception(status)) {         goto done;     }      /* Append our custom search path to sys.path */     status = PyWideStringList_Append(&config.module_search_paths,                                      L"/path/to/more/modules");     if (PyStatus_Exception(status)) {         goto done;     }      /* Override executable computed by PyConfig_Read() */     status = PyConfig_SetString(&config, &config.executable,                                 L"/path/to/my_executable");     if (PyStatus_Exception(status)) {         goto done;     }      status = Py_InitializeFromConfig(&config);  done:     PyConfig_Clear(&config);     return status; }


File: python.info,  Node: Isolated Configuration,  Next: Python Configuration,  Prev: Initialization with PyConfig,  Up: Python Initialization Configuration

7.10.7 Isolated Configuration
-----------------------------

*note PyPreConfig_InitIsolatedConfig(): 16b. and *note
PyConfig_InitIsolatedConfig(): 164. functions create a configuration to
isolate Python from the system.  For example, to embed Python into an
application.

This configuration ignores global configuration variables, environments
variables, command line arguments (*note PyConfig.argv: 3f37. is not
parsed) and user site directory.  The C standard streams (ex: ‘stdout’)
and the LC_CTYPE locale are left unchanged.  Signal handlers are not
installed.

Configuration files are still used with this configuration.  Set the
*note Path Configuration: 3f52. (“output fields”) to ignore these
configuration files and avoid the function computing the default path
configuration.


File: python.info,  Node: Python Configuration,  Next: Path Configuration,  Prev: Isolated Configuration,  Up: Python Initialization Configuration

7.10.8 Python Configuration
---------------------------

*note PyPreConfig_InitPythonConfig(): 16c. and *note
PyConfig_InitPythonConfig(): 165. functions create a configuration to
build a customized Python which behaves as the regular Python.

Environments variables and command line arguments are used to configure
Python, whereas global configuration variables are ignored.

This function enables C locale coercion ( PEP 538(1)) and UTF-8 Mode (
PEP 540(2)) depending on the LC_CTYPE locale, *note PYTHONUTF8: 306. and
*note PYTHONCOERCECLOCALE: 301. environment variables.

Example of customized Python always running in isolated mode:

     int main(int argc, char **argv) {     PyStatus status;      PyConfig config;     PyConfig_InitPythonConfig(&config);     config.isolated = 1;      /* Decode command line arguments.        Implicitly preinitialize Python (in isolated mode). */     status = PyConfig_SetBytesArgv(&config, argc, argv);     if (PyStatus_Exception(status)) {         goto fail;     }      status = Py_InitializeFromConfig(&config);     if (PyStatus_Exception(status)) {         goto fail;     }     PyConfig_Clear(&config);      return Py_RunMain();  fail:     PyConfig_Clear(&config);     if (PyStatus_IsExit(status)) {         return status.exitcode;     }     /* Display the error message and exit the process with        non-zero exit code */     Py_ExitStatusException(status); }

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0538

   (2) https://www.python.org/dev/peps/pep-0540


File: python.info,  Node: Path Configuration,  Next: Py_RunMain,  Prev: Python Configuration,  Up: Python Initialization Configuration

7.10.9 Path Configuration
-------------------------

*note PyConfig: 15f. contains multiple fields for the path
configuration:

   * Path configuration inputs:

        * *note PyConfig.home: 3f47.

        * *note PyConfig.pathconfig_warnings: 3f55.

        * *note PyConfig.program_name: 3f57.

        * *note PyConfig.pythonpath_env: 3f4f.

        * current working directory: to get absolute paths

        * ‘PATH’ environment variable to get the program full path (from
          *note PyConfig.program_name: 3f57.)

        * ‘__PYVENV_LAUNCHER__’ environment variable

        * (Windows only) Application paths in the registry under
          “SoftwarePythonPythonCoreX.YPythonPath” of HKEY_CURRENT_USER
          and HKEY_LOCAL_MACHINE (where X.Y is the Python version).

   * Path configuration output fields:

        * *note PyConfig.base_exec_prefix: 3f38.

        * *note PyConfig.base_executable: 3f39.

        * *note PyConfig.base_prefix: 3f3b.

        * *note PyConfig.exec_prefix: 3f41.

        * *note PyConfig.executable: 3f3a.

        * *note PyConfig.module_search_paths_set: 3f51, *note
          PyConfig.module_search_paths: 3f50.

        * *note PyConfig.prefix: 3f56.

If at least one “output field” is not set, Python calculates the path
configuration to fill unset fields.  If *note module_search_paths_set:
3f51. is equal to 0, *note module_search_paths: 3f50. is overridden and
*note module_search_paths_set: 3f51. is set to 1.

It is possible to completely ignore the function calculating the default
path configuration by setting explicitly all path configuration output
fields listed above.  A string is considered as set even if it is
non-empty.  ‘module_search_paths’ is considered as set if
‘module_search_paths_set’ is set to 1.  In this case, path configuration
input fields are ignored as well.

Set *note pathconfig_warnings: 3f55. to 0 to suppress warnings when
calculating the path configuration (Unix only, Windows does not log any
warning).

If *note base_prefix: 3f3b. or *note base_exec_prefix: 3f38. fields are
not set, they inherit their value from *note prefix: 3f56. and *note
exec_prefix: 3f41. respectively.

*note Py_RunMain(): 17c. and *note Py_Main(): 4ad. modify *note
sys.path: 47d.:

   * If *note run_filename: 3f5b. is set and is a directory which
     contains a ‘__main__.py’ script, prepend *note run_filename: 3f5b.
     to *note sys.path: 47d.

   * If *note isolated: 3f2e. is zero:

        * If *note run_module: 3f5c. is set, prepend the current
          directory to *note sys.path: 47d.  Do nothing if the current
          directory cannot be read.

        * If *note run_filename: 3f5b. is set, prepend the directory of
          the filename to *note sys.path: 47d.

        * Otherwise, prepend an empty string to *note sys.path: 47d.

If *note site_import: 3f5f. is non-zero, *note sys.path: 47d. can be
modified by the *note site: eb. module.  If *note user_site_directory:
3f4c. is non-zero and the user’s site-package directory exists, the
*note site: eb. module appends the user’s site-package directory to
*note sys.path: 47d.

The following configuration files are used by the path configuration:

   * ‘pyvenv.cfg’

   * ‘python._pth’ (Windows only)

   * ‘pybuilddir.txt’ (Unix only)

The ‘__PYVENV_LAUNCHER__’ environment variable is used to set *note
PyConfig.base_executable: 3f39.


File: python.info,  Node: Py_RunMain,  Next: Multi-Phase Initialization Private Provisional API,  Prev: Path Configuration,  Up: Python Initialization Configuration

7.10.10 Py_RunMain()
--------------------

 -- C Function: int Py_RunMain (void)

     Execute the command (*note PyConfig.run_command: 3f5a.), the script
     (*note PyConfig.run_filename: 3f5b.) or the module (*note
     PyConfig.run_module: 3f5c.) specified on the command line or in the
     configuration.

     By default and when if *note -i: e12. option is used, run the REPL.

     Finally, finalizes Python and returns an exit status that can be
     passed to the ‘exit()’ function.

See *note Python Configuration: 3f24. for an example of customized
Python always running in isolated mode using *note Py_RunMain(): 17c.


File: python.info,  Node: Multi-Phase Initialization Private Provisional API,  Prev: Py_RunMain,  Up: Python Initialization Configuration

7.10.11 Multi-Phase Initialization Private Provisional API
----------------------------------------------------------

This section is a private provisional API introducing multi-phase
initialization, the core feature of the PEP 432(1):

   * “Core” initialization phase, “bare minimum Python”:

        * Builtin types;

        * Builtin exceptions;

        * Builtin and frozen modules;

        * The *note sys: fd. module is only partially initialized (ex:
          *note sys.path: 47d. doesn’t exist yet).

   * “Main” initialization phase, Python is fully initialized:

        * Install and configure *note importlib: 9b.;

        * Apply the *note Path Configuration: 3f52.;

        * Install signal handlers;

        * Finish *note sys: fd. module initialization (ex: create *note
          sys.stdout: 303. and *note sys.path: 47d.);

        * Enable optional features like *note faulthandler: 7d. and
          *note tracemalloc: 114.;

        * Import the *note site: eb. module;

        * etc.

Private provisional API:

   * ‘PyConfig._init_main’: if set to 0, *note
     Py_InitializeFromConfig(): 178. stops at the “Core” initialization
     phase.

 -- C Function: PyStatus _Py_InitializeMain (void)

     Move to the “Main” initialization phase, finish the Python
     initialization.

No module is imported during the “Core” phase and the ‘importlib’ module
is not configured: the *note Path Configuration: 3f52. is only applied
during the “Main” phase.  It may allow to customize Python in Python to
override or tune the *note Path Configuration: 3f52, maybe install a
custom *note sys.meta_path: 5db. importer or an import hook, etc.

It may become possible to calculatin the *note Path Configuration: 3f52.
in Python, after the Core phase and before the Main phase, which is one
of the PEP 432(2) motivation.

The “Core” phase is not properly defined: what should be and what should
not be available at this phase is not specified yet.  The API is marked
as private and provisional: the API can be modified or even be removed
anytime until a proper public API is designed.

Example running Python code between “Core” and “Main” initialization
phases:

     void init_python(void) {     PyStatus status;      PyConfig config;     PyConfig_InitPythonConfig(&config);     config._init_main = 0;      /* ... customize 'config' configuration ... */      status = Py_InitializeFromConfig(&config);     PyConfig_Clear(&config);     if (PyStatus_Exception(status)) {         Py_ExitStatusException(status);     }      /* Use sys.stderr because sys.stdout is only created        by _Py_InitializeMain() */     int res = PyRun_SimpleString(         "import sys; "         "print('Run Python code before _Py_InitializeMain', "                "file=sys.stderr)");     if (res < 0) {         exit(1);     }      /* ... put more configuration code here ... */      status = _Py_InitializeMain();     if (PyStatus_Exception(status)) {         Py_ExitStatusException(status);     } }

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0432

   (2) https://www.python.org/dev/peps/pep-0432


File: python.info,  Node: Memory Management,  Next: Object Implementation Support,  Prev: Python Initialization Configuration,  Up: Python/C API Reference Manual

7.11 Memory Management
======================

* Menu:

* Overview: Overview<3>.
* Raw Memory Interface::
* Memory Interface::
* Object allocators::
* Default Memory Allocators::
* Customize Memory Allocators::
* The pymalloc allocator::
* tracemalloc C API::
* Examples: Examples<34>.


File: python.info,  Node: Overview<3>,  Next: Raw Memory Interface,  Up: Memory Management

7.11.1 Overview
---------------

Memory management in Python involves a private heap containing all
Python objects and data structures.  The management of this private heap
is ensured internally by the `Python memory manager'.  The Python memory
manager has different components which deal with various dynamic storage
management aspects, like sharing, segmentation, preallocation or
caching.

At the lowest level, a raw memory allocator ensures that there is enough
room in the private heap for storing all Python-related data by
interacting with the memory manager of the operating system.  On top of
the raw memory allocator, several object-specific allocators operate on
the same heap and implement distinct memory management policies adapted
to the peculiarities of every object type.  For example, integer objects
are managed differently within the heap than strings, tuples or
dictionaries because integers imply different storage requirements and
speed/space tradeoffs.  The Python memory manager thus delegates some of
the work to the object-specific allocators, but ensures that the latter
operate within the bounds of the private heap.

It is important to understand that the management of the Python heap is
performed by the interpreter itself and that the user has no control
over it, even if they regularly manipulate object pointers to memory
blocks inside that heap.  The allocation of heap space for Python
objects and other internal buffers is performed on demand by the Python
memory manager through the Python/C API functions listed in this
document.

To avoid memory corruption, extension writers should never try to
operate on Python objects with the functions exported by the C library:
‘malloc()’, ‘calloc()’, ‘realloc()’ and ‘free()’.  This will result in
mixed calls between the C allocator and the Python memory manager with
fatal consequences, because they implement different algorithms and
operate on different heaps.  However, one may safely allocate and
release memory blocks with the C library allocator for individual
purposes, as shown in the following example:

     PyObject *res; char *buf = (char *) malloc(BUFSIZ); /* for I/O */  if (buf == NULL)     return PyErr_NoMemory(); ...Do some I/O operation involving buf... res = PyBytes_FromString(buf); free(buf); /* malloc'ed */ return res;

In this example, the memory request for the I/O buffer is handled by the
C library allocator.  The Python memory manager is involved only in the
allocation of the bytes object returned as a result.

In most situations, however, it is recommended to allocate memory from
the Python heap specifically because the latter is under control of the
Python memory manager.  For example, this is required when the
interpreter is extended with new object types written in C. Another
reason for using the Python heap is the desire to `inform' the Python
memory manager about the memory needs of the extension module.  Even
when the requested memory is used exclusively for internal,
highly-specific purposes, delegating all memory requests to the Python
memory manager causes the interpreter to have a more accurate image of
its memory footprint as a whole.  Consequently, under certain
circumstances, the Python memory manager may or may not trigger
appropriate actions, like garbage collection, memory compaction or other
preventive procedures.  Note that by using the C library allocator as
shown in the previous example, the allocated memory for the I/O buffer
escapes completely the Python memory manager.

See also
........

The *note PYTHONMALLOC: 4f8. environment variable can be used to
configure the memory allocators used by Python.

The *note PYTHONMALLOCSTATS: 109b. environment variable can be used to
print statistics of the *note pymalloc memory allocator: 5b6. every time
a new pymalloc object arena is created, and on shutdown.


File: python.info,  Node: Raw Memory Interface,  Next: Memory Interface,  Prev: Overview<3>,  Up: Memory Management

7.11.2 Raw Memory Interface
---------------------------

The following function sets are wrappers to the system allocator.  These
functions are thread-safe, the *note GIL: 4fb. does not need to be held.

The *note default raw memory allocator: 1298. uses the following
functions: ‘malloc()’, ‘calloc()’, ‘realloc()’ and ‘free()’; call
‘malloc(1)’ (or ‘calloc(1, 1)’) when requesting zero bytes.

New in version 3.4.

 -- C Function: void* PyMem_RawMalloc (size_t n)

     Allocates `n' bytes and returns a pointer of type ‘void*’ to the
     allocated memory, or ‘NULL’ if the request fails.

     Requesting zero bytes returns a distinct non-‘NULL’ pointer if
     possible, as if ‘PyMem_RawMalloc(1)’ had been called instead.  The
     memory will not have been initialized in any way.

 -- C Function: void* PyMem_RawCalloc (size_t nelem, size_t elsize)

     Allocates `nelem' elements each whose size in bytes is `elsize' and
     returns a pointer of type ‘void*’ to the allocated memory, or
     ‘NULL’ if the request fails.  The memory is initialized to zeros.

     Requesting zero elements or elements of size zero bytes returns a
     distinct non-‘NULL’ pointer if possible, as if ‘PyMem_RawCalloc(1,
     1)’ had been called instead.

     New in version 3.5.

 -- C Function: void* PyMem_RawRealloc (void *p, size_t n)

     Resizes the memory block pointed to by `p' to `n' bytes.  The
     contents will be unchanged to the minimum of the old and the new
     sizes.

     If `p' is ‘NULL’, the call is equivalent to ‘PyMem_RawMalloc(n)’;
     else if `n' is equal to zero, the memory block is resized but is
     not freed, and the returned pointer is non-‘NULL’.

     Unless `p' is ‘NULL’, it must have been returned by a previous call
     to *note PyMem_RawMalloc(): 961, *note PyMem_RawRealloc(): 962. or
     *note PyMem_RawCalloc(): 799.

     If the request fails, *note PyMem_RawRealloc(): 962. returns ‘NULL’
     and `p' remains a valid pointer to the previous memory area.

 -- C Function: void PyMem_RawFree (void *p)

     Frees the memory block pointed to by `p', which must have been
     returned by a previous call to *note PyMem_RawMalloc(): 961, *note
     PyMem_RawRealloc(): 962. or *note PyMem_RawCalloc(): 799.
     Otherwise, or if ‘PyMem_RawFree(p)’ has been called before,
     undefined behavior occurs.

     If `p' is ‘NULL’, no operation is performed.


File: python.info,  Node: Memory Interface,  Next: Object allocators,  Prev: Raw Memory Interface,  Up: Memory Management

7.11.3 Memory Interface
-----------------------

The following function sets, modeled after the ANSI C standard, but
specifying behavior when requesting zero bytes, are available for
allocating and releasing memory from the Python heap.

The *note default memory allocator: 1298. uses the *note pymalloc memory
allocator: 5b6.

     Warning: The *note GIL: 4fb. must be held when using these
     functions.

Changed in version 3.6: The default allocator is now pymalloc instead of
system ‘malloc()’.

 -- C Function: void* PyMem_Malloc (size_t n)

     Allocates `n' bytes and returns a pointer of type ‘void*’ to the
     allocated memory, or ‘NULL’ if the request fails.

     Requesting zero bytes returns a distinct non-‘NULL’ pointer if
     possible, as if ‘PyMem_Malloc(1)’ had been called instead.  The
     memory will not have been initialized in any way.

 -- C Function: void* PyMem_Calloc (size_t nelem, size_t elsize)

     Allocates `nelem' elements each whose size in bytes is `elsize' and
     returns a pointer of type ‘void*’ to the allocated memory, or
     ‘NULL’ if the request fails.  The memory is initialized to zeros.

     Requesting zero elements or elements of size zero bytes returns a
     distinct non-‘NULL’ pointer if possible, as if ‘PyMem_Calloc(1, 1)’
     had been called instead.

     New in version 3.5.

 -- C Function: void* PyMem_Realloc (void *p, size_t n)

     Resizes the memory block pointed to by `p' to `n' bytes.  The
     contents will be unchanged to the minimum of the old and the new
     sizes.

     If `p' is ‘NULL’, the call is equivalent to ‘PyMem_Malloc(n)’; else
     if `n' is equal to zero, the memory block is resized but is not
     freed, and the returned pointer is non-‘NULL’.

     Unless `p' is ‘NULL’, it must have been returned by a previous call
     to *note PyMem_Malloc(): 4fa, *note PyMem_Realloc(): 963. or *note
     PyMem_Calloc(): 79a.

     If the request fails, *note PyMem_Realloc(): 963. returns ‘NULL’
     and `p' remains a valid pointer to the previous memory area.

 -- C Function: void PyMem_Free (void *p)

     Frees the memory block pointed to by `p', which must have been
     returned by a previous call to *note PyMem_Malloc(): 4fa, *note
     PyMem_Realloc(): 963. or *note PyMem_Calloc(): 79a.  Otherwise, or
     if ‘PyMem_Free(p)’ has been called before, undefined behavior
     occurs.

     If `p' is ‘NULL’, no operation is performed.

The following type-oriented macros are provided for convenience.  Note
that `TYPE' refers to any C type.

 -- C Function: TYPE* PyMem_New (TYPE, size_t n)

     Same as *note PyMem_Malloc(): 4fa, but allocates ‘(n *
     sizeof(TYPE))’ bytes of memory.  Returns a pointer cast to ‘TYPE*’.
     The memory will not have been initialized in any way.

 -- C Function: TYPE* PyMem_Resize (void *p, TYPE, size_t n)

     Same as *note PyMem_Realloc(): 963, but the memory block is resized
     to ‘(n * sizeof(TYPE))’ bytes.  Returns a pointer cast to ‘TYPE*’.
     On return, `p' will be a pointer to the new memory area, or ‘NULL’
     in the event of failure.

     This is a C preprocessor macro; `p' is always reassigned.  Save the
     original value of `p' to avoid losing memory when handling errors.

 -- C Function: void PyMem_Del (void *p)

     Same as *note PyMem_Free(): d9c.

In addition, the following macro sets are provided for calling the
Python memory allocator directly, without involving the C API functions
listed above.  However, note that their use does not preserve binary
compatibility across Python versions and is therefore deprecated in
extension modules.

   * ‘PyMem_MALLOC(size)’

   * ‘PyMem_NEW(type, size)’

   * ‘PyMem_REALLOC(ptr, size)’

   * ‘PyMem_RESIZE(ptr, type, size)’

   * ‘PyMem_FREE(ptr)’

   * ‘PyMem_DEL(ptr)’


File: python.info,  Node: Object allocators,  Next: Default Memory Allocators,  Prev: Memory Interface,  Up: Memory Management

7.11.4 Object allocators
------------------------

The following function sets, modeled after the ANSI C standard, but
specifying behavior when requesting zero bytes, are available for
allocating and releasing memory from the Python heap.

The *note default object allocator: 1298. uses the *note pymalloc memory
allocator: 5b6.

     Warning: The *note GIL: 4fb. must be held when using these
     functions.

 -- C Function: void* PyObject_Malloc (size_t n)

     Allocates `n' bytes and returns a pointer of type ‘void*’ to the
     allocated memory, or ‘NULL’ if the request fails.

     Requesting zero bytes returns a distinct non-‘NULL’ pointer if
     possible, as if ‘PyObject_Malloc(1)’ had been called instead.  The
     memory will not have been initialized in any way.

 -- C Function: void* PyObject_Calloc (size_t nelem, size_t elsize)

     Allocates `nelem' elements each whose size in bytes is `elsize' and
     returns a pointer of type ‘void*’ to the allocated memory, or
     ‘NULL’ if the request fails.  The memory is initialized to zeros.

     Requesting zero elements or elements of size zero bytes returns a
     distinct non-‘NULL’ pointer if possible, as if ‘PyObject_Calloc(1,
     1)’ had been called instead.

     New in version 3.5.

 -- C Function: void* PyObject_Realloc (void *p, size_t n)

     Resizes the memory block pointed to by `p' to `n' bytes.  The
     contents will be unchanged to the minimum of the old and the new
     sizes.

     If `p' is ‘NULL’, the call is equivalent to ‘PyObject_Malloc(n)’;
     else if `n' is equal to zero, the memory block is resized but is
     not freed, and the returned pointer is non-‘NULL’.

     Unless `p' is ‘NULL’, it must have been returned by a previous call
     to *note PyObject_Malloc(): 4fd, *note PyObject_Realloc(): d9d. or
     *note PyObject_Calloc(): 79b.

     If the request fails, *note PyObject_Realloc(): d9d. returns ‘NULL’
     and `p' remains a valid pointer to the previous memory area.

 -- C Function: void PyObject_Free (void *p)

     Frees the memory block pointed to by `p', which must have been
     returned by a previous call to *note PyObject_Malloc(): 4fd, *note
     PyObject_Realloc(): d9d. or *note PyObject_Calloc(): 79b.
     Otherwise, or if ‘PyObject_Free(p)’ has been called before,
     undefined behavior occurs.

     If `p' is ‘NULL’, no operation is performed.


File: python.info,  Node: Default Memory Allocators,  Next: Customize Memory Allocators,  Prev: Object allocators,  Up: Memory Management

7.11.5 Default Memory Allocators
--------------------------------

Default memory allocators:

Configuration                       Name                     PyMem_RawMalloc        PyMem_Malloc              PyObject_Malloc
                                                                                                              
---------------------------------------------------------------------------------------------------------------------------------------
                                                                                                              
Release build                       ‘"pymalloc"’             ‘malloc’               ‘pymalloc’                ‘pymalloc’
                                                                                                              
                                                                                                              
Debug build                         ‘"pymalloc_debug"’       ‘malloc’ + debug       ‘pymalloc’ + debug        ‘pymalloc’ + debug
                                                                                                              
                                                                                                              
Release build, without pymalloc     ‘"malloc"’               ‘malloc’               ‘malloc’                  ‘malloc’
                                                                                                              
                                                                                                              
Debug build, without pymalloc       ‘"malloc_debug"’         ‘malloc’ + debug       ‘malloc’ + debug          ‘malloc’ + debug
                                                                                                              

Legend:

   * Name: value for *note PYTHONMALLOC: 4f8. environment variable

   * ‘malloc’: system allocators from the standard C library, C
     functions: ‘malloc()’, ‘calloc()’, ‘realloc()’ and ‘free()’

   * ‘pymalloc’: *note pymalloc memory allocator: 5b6.

   * “+ debug”: with debug hooks installed by *note
     PyMem_SetupDebugHooks(): 4ff.


File: python.info,  Node: Customize Memory Allocators,  Next: The pymalloc allocator,  Prev: Default Memory Allocators,  Up: Memory Management

7.11.6 Customize Memory Allocators
----------------------------------

New in version 3.4.

 -- C Type: PyMemAllocatorEx

     Structure used to describe a memory block allocator.  The structure
     has four fields:

     Field                                                          Meaning
                                                                    
     -----------------------------------------------------------------------------------------------------------
                                                                    
     ‘void *ctx’                                                    user context passed as first argument
                                                                    
                                                                    
     ‘void* malloc(void *ctx, size_t size)’                         allocate a memory block
                                                                    
                                                                    
     ‘void* calloc(void *ctx, size_t nelem, size_t elsize)’         allocate a memory block initialized with
                                                                    zeros
                                                                    
                                                                    
     ‘void* realloc(void *ctx, void *ptr, size_t new_size)’         allocate or resize a memory block
                                                                    
                                                                    
     ‘void free(void *ctx, void *ptr)’                              free a memory block
                                                                    

     Changed in version 3.5: The ‘PyMemAllocator’ structure was renamed
     to *note PyMemAllocatorEx: 7be. and a new ‘calloc’ field was added.

 -- C Type: PyMemAllocatorDomain

     Enum used to identify an allocator domain.  Domains:

      -- C Variable: PYMEM_DOMAIN_RAW

          Functions:

             * *note PyMem_RawMalloc(): 961.

             * *note PyMem_RawRealloc(): 962.

             * *note PyMem_RawCalloc(): 799.

             * *note PyMem_RawFree(): 3b89.

      -- C Variable: PYMEM_DOMAIN_MEM

          Functions:

             * *note PyMem_Malloc(): 4fa,

             * *note PyMem_Realloc(): 963.

             * *note PyMem_Calloc(): 79a.

             * *note PyMem_Free(): d9c.

      -- C Variable: PYMEM_DOMAIN_OBJ

          Functions:

             * *note PyObject_Malloc(): 4fd.

             * *note PyObject_Realloc(): d9d.

             * *note PyObject_Calloc(): 79b.

             * *note PyObject_Free(): 4f9.

 -- C Function: void PyMem_GetAllocator (PyMemAllocatorDomain domain,
          PyMemAllocatorEx *allocator)

     Get the memory block allocator of the specified domain.

 -- C Function: void PyMem_SetAllocator (PyMemAllocatorDomain domain,
          PyMemAllocatorEx *allocator)

     Set the memory block allocator of the specified domain.

     The new allocator must return a distinct non-‘NULL’ pointer when
     requesting zero bytes.

     For the *note PYMEM_DOMAIN_RAW: 1299. domain, the allocator must be
     thread-safe: the *note GIL: 4fb. is not held when the allocator is
     called.

     If the new allocator is not a hook (does not call the previous
     allocator), the *note PyMem_SetupDebugHooks(): 4ff. function must
     be called to reinstall the debug hooks on top on the new allocator.

 -- C Function: void PyMem_SetupDebugHooks (void)

     Setup hooks to detect bugs in the Python memory allocator
     functions.

     Newly allocated memory is filled with the byte ‘0xCD’
     (‘CLEANBYTE’), freed memory is filled with the byte ‘0xDD’
     (‘DEADBYTE’).  Memory blocks are surrounded by “forbidden bytes”
     (‘FORBIDDENBYTE’: byte ‘0xFD’).

     Runtime checks:

        - Detect API violations, ex: *note PyObject_Free(): 4f9. called
          on a buffer allocated by *note PyMem_Malloc(): 4fa.

        - Detect write before the start of the buffer (buffer underflow)

        - Detect write after the end of the buffer (buffer overflow)

        - Check that the *note GIL: 4fb. is held when allocator
          functions of *note PYMEM_DOMAIN_OBJ: 4fc. (ex: *note
          PyObject_Malloc(): 4fd.) and *note PYMEM_DOMAIN_MEM: 4fe. (ex:
          *note PyMem_Malloc(): 4fa.) domains are called

     On error, the debug hooks use the *note tracemalloc: 114. module to
     get the traceback where a memory block was allocated.  The
     traceback is only displayed if *note tracemalloc: 114. is tracing
     Python memory allocations and the memory block was traced.

     These hooks are *note installed by default: 1298. if Python is
     compiled in debug mode.  The *note PYTHONMALLOC: 4f8. environment
     variable can be used to install debug hooks on a Python compiled in
     release mode.

     Changed in version 3.6: This function now also works on Python
     compiled in release mode.  On error, the debug hooks now use *note
     tracemalloc: 114. to get the traceback where a memory block was
     allocated.  The debug hooks now also check if the GIL is held when
     functions of *note PYMEM_DOMAIN_OBJ: 4fc. and *note
     PYMEM_DOMAIN_MEM: 4fe. domains are called.

     Changed in version 3.8: Byte patterns ‘0xCB’ (‘CLEANBYTE’), ‘0xDB’
     (‘DEADBYTE’) and ‘0xFB’ (‘FORBIDDENBYTE’) have been replaced with
     ‘0xCD’, ‘0xDD’ and ‘0xFD’ to use the same values than Windows CRT
     debug ‘malloc()’ and ‘free()’.


File: python.info,  Node: The pymalloc allocator,  Next: tracemalloc C API,  Prev: Customize Memory Allocators,  Up: Memory Management

7.11.7 The pymalloc allocator
-----------------------------

Python has a `pymalloc' allocator optimized for small objects (smaller
or equal to 512 bytes) with a short lifetime.  It uses memory mappings
called “arenas” with a fixed size of 256 KiB. It falls back to *note
PyMem_RawMalloc(): 961. and *note PyMem_RawRealloc(): 962. for
allocations larger than 512 bytes.

`pymalloc' is the *note default allocator: 1298. of the *note
PYMEM_DOMAIN_MEM: 4fe. (ex: *note PyMem_Malloc(): 4fa.) and *note
PYMEM_DOMAIN_OBJ: 4fc. (ex: *note PyObject_Malloc(): 4fd.) domains.

The arena allocator uses the following functions:

   * ‘VirtualAlloc()’ and ‘VirtualFree()’ on Windows,

   * ‘mmap()’ and ‘munmap()’ if available,

   * ‘malloc()’ and ‘free()’ otherwise.

* Menu:

* Customize pymalloc Arena Allocator::


File: python.info,  Node: Customize pymalloc Arena Allocator,  Up: The pymalloc allocator

7.11.7.1 Customize pymalloc Arena Allocator
...........................................

New in version 3.4.

 -- C Type: PyObjectArenaAllocator

     Structure used to describe an arena allocator.  The structure has
     three fields:

     Field                                                  Meaning
                                                            
     ---------------------------------------------------------------------------------------------------
                                                            
     ‘void *ctx’                                            user context passed as first argument
                                                            
                                                            
     ‘void* alloc(void *ctx, size_t size)’                  allocate an arena of size bytes
                                                            
                                                            
     ‘void free(void *ctx, size_t size, void *ptr)’         free an arena
                                                            

 -- C Function: PyObject_GetArenaAllocator
          (PyObjectArenaAllocator *allocator)

     Get the arena allocator.

 -- C Function: PyObject_SetArenaAllocator
          (PyObjectArenaAllocator *allocator)

     Set the arena allocator.


File: python.info,  Node: tracemalloc C API,  Next: Examples<34>,  Prev: The pymalloc allocator,  Up: Memory Management

7.11.8 tracemalloc C API
------------------------

New in version 3.7.


File: python.info,  Node: Examples<34>,  Prev: tracemalloc C API,  Up: Memory Management

7.11.9 Examples
---------------

Here is the example from section *note Overview: 3f71, rewritten so that
the I/O buffer is allocated from the Python heap by using the first
function set:

     PyObject *res; char *buf = (char *) PyMem_Malloc(BUFSIZ); /* for I/O */  if (buf == NULL)     return PyErr_NoMemory(); /* ...Do some I/O operation involving buf... */ res = PyBytes_FromString(buf); PyMem_Free(buf); /* allocated with PyMem_Malloc */ return res;

The same code using the type-oriented function set:

     PyObject *res; char *buf = PyMem_New(char, BUFSIZ); /* for I/O */  if (buf == NULL)     return PyErr_NoMemory(); /* ...Do some I/O operation involving buf... */ res = PyBytes_FromString(buf); PyMem_Del(buf); /* allocated with PyMem_New */ return res;

Note that in the two examples above, the buffer is always manipulated
via functions belonging to the same set.  Indeed, it is required to use
the same memory API family for a given memory block, so that the risk of
mixing different allocators is reduced to a minimum.  The following code
sequence contains two errors, one of which is labeled as `fatal' because
it mixes two different allocators operating on different heaps.

     char *buf1 = PyMem_New(char, BUFSIZ); char *buf2 = (char *) malloc(BUFSIZ); char *buf3 = (char *) PyMem_Malloc(BUFSIZ); ... PyMem_Del(buf3);  /* Wrong -- should be PyMem_Free() */ free(buf2);       /* Right -- allocated via malloc() */ free(buf1);       /* Fatal -- should be PyMem_Del()  */

In addition to the functions aimed at handling raw memory blocks from
the Python heap, objects in Python are allocated and released with *note
PyObject_New(): 2d0, *note PyObject_NewVar(): 2d1. and *note
PyObject_Del(): e09.

These will be explained in the next chapter on defining and implementing
new object types in C.


File: python.info,  Node: Object Implementation Support,  Next: API and ABI Versioning,  Prev: Memory Management,  Up: Python/C API Reference Manual

7.12 Object Implementation Support
==================================

This chapter describes the functions, types, and macros used when
defining new object types.

* Menu:

* Allocating Objects on the Heap::
* Common Object Structures::
* Type Objects: Type Objects<3>.
* Number Object Structures::
* Mapping Object Structures::
* Sequence Object Structures::
* Buffer Object Structures::
* Async Object Structures::
* Slot Type typedefs::
* Examples: Examples<35>.
* Supporting Cyclic Garbage Collection::


File: python.info,  Node: Allocating Objects on the Heap,  Next: Common Object Structures,  Up: Object Implementation Support

7.12.1 Allocating Objects on the Heap
-------------------------------------

 -- C Function: PyObject* _PyObject_New (PyTypeObject *type)
     `Return value: New reference.'

 -- C Function: PyVarObject* _PyObject_NewVar (PyTypeObject *type,
          Py_ssize_t size)
     `Return value: New reference.'

 -- C Function: PyObject* PyObject_Init (PyObject *op,
          PyTypeObject *type)
     `Return value: Borrowed reference.'  Initialize a newly-allocated
     object `op' with its type and initial reference.  Returns the
     initialized object.  If `type' indicates that the object
     participates in the cyclic garbage detector, it is added to the
     detector’s set of observed objects.  Other fields of the object are
     not affected.

 -- C Function: PyVarObject* PyObject_InitVar (PyVarObject *op,
          PyTypeObject *type, Py_ssize_t size)
     `Return value: Borrowed reference.'  This does everything *note
     PyObject_Init(): 26d. does, and also initializes the length
     information for a variable-size object.

 -- C Function: TYPE* PyObject_New (TYPE, PyTypeObject *type)
     `Return value: New reference.'  Allocate a new Python object using
     the C structure type `TYPE' and the Python type object `type'.
     Fields not defined by the Python object header are not initialized;
     the object’s reference count will be one.  The size of the memory
     allocation is determined from the *note tp_basicsize: 3a7d. field
     of the type object.

 -- C Function: TYPE* PyObject_NewVar (TYPE, PyTypeObject *type,
          Py_ssize_t size)
     `Return value: New reference.'  Allocate a new Python object using
     the C structure type `TYPE' and the Python type object `type'.
     Fields not defined by the Python object header are not initialized.
     The allocated memory allows for the `TYPE' structure plus `size'
     fields of the size given by the *note tp_itemsize: 3a7c. field of
     `type'.  This is useful for implementing objects like tuples, which
     are able to determine their size at construction time.  Embedding
     the array of fields into the same allocation decreases the number
     of allocations, improving the memory management efficiency.

 -- C Function: void PyObject_Del (void *op)

     Releases memory allocated to an object using *note PyObject_New():
     2d0. or *note PyObject_NewVar(): 2d1.  This is normally called from
     the *note tp_dealloc: 3a83. handler specified in the object’s type.
     The fields of the object should not be accessed after this call as
     the memory is no longer a valid Python object.

 -- C Variable: PyObject _Py_NoneStruct

     Object which is visible in Python as ‘None’.  This should only be
     accessed using the *note Py_None: 3a48. macro, which evaluates to a
     pointer to this object.

See also
........

*note PyModule_Create(): 3a4b.

     To allocate and create extension modules.


File: python.info,  Node: Common Object Structures,  Next: Type Objects<3>,  Prev: Allocating Objects on the Heap,  Up: Object Implementation Support

7.12.2 Common Object Structures
-------------------------------

There are a large number of structures which are used in the definition
of object types for Python.  This section describes these structures and
how they are used.

All Python objects ultimately share a small number of fields at the
beginning of the object’s representation in memory.  These are
represented by the *note PyObject: 4b0. and *note PyVarObject: 3f90.
types, which are defined, in turn, by the expansions of some macros also
used, whether directly or indirectly, in the definition of all other
Python objects.

 -- C Type: PyObject

     All object types are extensions of this type.  This is a type which
     contains the information Python needs to treat a pointer to an
     object as an object.  In a normal “release” build, it contains only
     the object’s reference count and a pointer to the corresponding
     type object.  Nothing is actually declared to be a *note PyObject:
     4b0, but every pointer to a Python object can be cast to a *note
     PyObject*: 4b0.  Access to the members must be done by using the
     macros *note Py_REFCNT: 3a79. and *note Py_TYPE: 3a7a.

 -- C Type: PyVarObject

     This is an extension of *note PyObject: 4b0. that adds the
     ‘ob_size’ field.  This is only used for objects that have some
     notion of `length'.  This type does not often appear in the
     Python/C API. Access to the members must be done by using the
     macros *note Py_REFCNT: 3a79, *note Py_TYPE: 3a7a, and *note
     Py_SIZE: 3f91.

 -- C Macro: PyObject_HEAD

     This is a macro used when declaring new types which represent
     objects without a varying length.  The PyObject_HEAD macro expands
     to:

          PyObject ob_base;

     See documentation of *note PyObject: 4b0. above.

 -- C Macro: PyObject_VAR_HEAD

     This is a macro used when declaring new types which represent
     objects with a length that varies from instance to instance.  The
     PyObject_VAR_HEAD macro expands to:

          PyVarObject ob_base;

     See documentation of *note PyVarObject: 3f90. above.

 -- C Macro: Py_TYPE (o)

     This macro is used to access the ‘ob_type’ member of a Python
     object.  It expands to:

          (((PyObject*)(o))->ob_type)

 -- C Macro: Py_REFCNT (o)

     This macro is used to access the ‘ob_refcnt’ member of a Python
     object.  It expands to:

          (((PyObject*)(o))->ob_refcnt)

 -- C Macro: Py_SIZE (o)

     This macro is used to access the ‘ob_size’ member of a Python
     object.  It expands to:

          (((PyVarObject*)(o))->ob_size)

 -- C Macro: PyObject_HEAD_INIT (type)

     This is a macro which expands to initialization values for a new
     *note PyObject: 4b0. type.  This macro expands to:

          _PyObject_EXTRA_INIT 1, type,

 -- C Macro: PyVarObject_HEAD_INIT (type, size)

     This is a macro which expands to initialization values for a new
     *note PyVarObject: 3f90. type, including the ‘ob_size’ field.  This
     macro expands to:

          _PyObject_EXTRA_INIT 1, type, size,

 -- C Type: PyCFunction

     Type of the functions used to implement most Python callables in C.
     Functions of this type take two *note PyObject*: 4b0. parameters
     and return one such value.  If the return value is ‘NULL’, an
     exception shall have been set.  If not ‘NULL’, the return value is
     interpreted as the return value of the function as exposed in
     Python.  The function must return a new reference.

 -- C Type: PyCFunctionWithKeywords

     Type of the functions used to implement Python callables in C with
     signature ‘METH_VARARGS | METH_KEYWORDS’.

 -- C Type: _PyCFunctionFast

     Type of the functions used to implement Python callables in C with
     signature *note METH_FASTCALL: eea.

 -- C Type: _PyCFunctionFastWithKeywords

     Type of the functions used to implement Python callables in C with
     signature ‘METH_FASTCALL | METH_KEYWORDS’.

 -- C Type: PyMethodDef

     Structure used to describe a method of an extension type.  This
     structure has four fields:

     Field                  C Type              Meaning
                                                
     -------------------------------------------------------------------------------
                                                
     ‘ml_name’              const char *        name of the method
                                                
                                                
     ‘ml_meth’              PyCFunction         pointer to the C implementation
                                                
                                                
     ‘ml_flags’             int                 flag bits indicating how the call
                                                should be constructed
                                                
                                                
     ‘ml_doc’               const char *        points to the contents of the
                                                docstring
                                                

The ‘ml_meth’ is a C function pointer.  The functions may be of
different types, but they always return *note PyObject*: 4b0.  If the
function is not of the *note PyCFunction: dce, the compiler will require
a cast in the method table.  Even though *note PyCFunction: dce. defines
the first parameter as *note PyObject*: 4b0, it is common that the
method implementation uses the specific C type of the `self' object.

The ‘ml_flags’ field is a bitfield which can include the following
flags.  The individual flags indicate either a calling convention or a
binding convention.

There are four basic calling conventions for positional arguments and
two of them can be combined with ‘METH_KEYWORDS’ to support also keyword
arguments.  So there are a total of 6 calling conventions:

 -- Data: METH_VARARGS

     This is the typical calling convention, where the methods have the
     type *note PyCFunction: dce.  The function expects two *note
     PyObject*: 4b0. values.  The first one is the `self' object for
     methods; for module functions, it is the module object.  The second
     parameter (often called `args') is a tuple object representing all
     arguments.  This parameter is typically processed using *note
     PyArg_ParseTuple(): 268. or *note PyArg_UnpackTuple(): e39.

 -- Data: METH_VARARGS | METH_KEYWORDS

     Methods with these flags must be of type *note
     PyCFunctionWithKeywords: 3f95.  The function expects three
     parameters: `self', `args', `kwargs' where `kwargs' is a dictionary
     of all the keyword arguments or possibly ‘NULL’ if there are no
     keyword arguments.  The parameters are typically processed using
     *note PyArg_ParseTupleAndKeywords(): 5bf.

 -- Data: METH_FASTCALL

     Fast calling convention supporting only positional arguments.  The
     methods have the type *note _PyCFunctionFast: 3f96.  The first
     parameter is `self', the second parameter is a C array of *note
     PyObject*: 4b0. values indicating the arguments and the third
     parameter is the number of arguments (the length of the array).

     This is not part of the *note limited API: 3b05.

     New in version 3.7.

 -- Data: METH_FASTCALL | METH_KEYWORDS

     Extension of *note METH_FASTCALL: eea. supporting also keyword
     arguments, with methods of type *note _PyCFunctionFastWithKeywords:
     3f97.  Keyword arguments are passed the same way as in the
     vectorcall protocol: there is an additional fourth *note PyObject*:
     4b0. parameter which is a tuple representing the names of the
     keyword arguments or possibly ‘NULL’ if there are no keywords.  The
     values of the keyword arguments are stored in the `args' array,
     after the positional arguments.

     This is not part of the *note limited API: 3b05.

     New in version 3.7.

 -- Data: METH_NOARGS

     Methods without parameters don’t need to check whether arguments
     are given if they are listed with the *note METH_NOARGS: e0b. flag.
     They need to be of type *note PyCFunction: dce.  The first
     parameter is typically named `self' and will hold a reference to
     the module or object instance.  In all cases the second parameter
     will be ‘NULL’.

 -- Data: METH_O

     Methods with a single object argument can be listed with the *note
     METH_O: e3a. flag, instead of invoking *note PyArg_ParseTuple():
     268. with a ‘"O"’ argument.  They have the type *note PyCFunction:
     dce, with the `self' parameter, and a *note PyObject*: 4b0.
     parameter representing the single argument.

These two constants are not used to indicate the calling convention but
the binding when use with methods of classes.  These may not be used for
functions defined for modules.  At most one of these flags may be set
for any given method.

 -- Data: METH_CLASS

     The method will be passed the type object as the first parameter
     rather than an instance of the type.  This is used to create `class
     methods', similar to what is created when using the *note
     classmethod(): 1d6. built-in function.

 -- Data: METH_STATIC

     The method will be passed ‘NULL’ as the first parameter rather than
     an instance of the type.  This is used to create `static methods',
     similar to what is created when using the *note staticmethod():
     1d7. built-in function.

One other constant controls whether a method is loaded in place of
another definition with the same method name.

 -- Data: METH_COEXIST

     The method will be loaded in place of existing definitions.
     Without `METH_COEXIST', the default is to skip repeated
     definitions.  Since slot wrappers are loaded before the method
     table, the existence of a `sq_contains' slot, for example, would
     generate a wrapped method named *note __contains__(): d1b. and
     preclude the loading of a corresponding PyCFunction with the same
     name.  With the flag defined, the PyCFunction will be loaded in
     place of the wrapper object and will co-exist with the slot.  This
     is helpful because calls to PyCFunctions are optimized more than
     wrapper object calls.

 -- C Type: PyMemberDef

     Structure which describes an attribute of a type which corresponds
     to a C struct member.  Its fields are:

     Field                  C Type              Meaning
                                                
     -------------------------------------------------------------------------------
                                                
     ‘name’                 const char *        name of the member
                                                
                                                
     ‘type’                 int                 the type of the member in the C
                                                struct
                                                
                                                
     ‘offset’               Py_ssize_t          the offset in bytes that the
                                                member is located on the type’s
                                                object struct
                                                
                                                
     ‘flags’                int                 flag bits indicating if the field
                                                should be read-only or writable
                                                
                                                
     ‘doc’                  const char *        points to the contents of the
                                                docstring
                                                

     ‘type’ can be one of many ‘T_’ macros corresponding to various C
     types.  When the member is accessed in Python, it will be converted
     to the equivalent Python type.

     Macro name          C type
                         
     -------------------------------------------
                         
     T_SHORT             short
                         
                         
     T_INT               int
                         
                         
     T_LONG              long
                         
                         
     T_FLOAT             float
                         
                         
     T_DOUBLE            double
                         
                         
     T_STRING            const char *
                         
                         
     T_OBJECT            PyObject *
                         
                         
     T_OBJECT_EX         PyObject *
                         
                         
     T_CHAR              char
                         
                         
     T_BYTE              char
                         
                         
     T_UBYTE             unsigned char
                         
                         
     T_UINT              unsigned int
                         
                         
     T_USHORT            unsigned short
                         
                         
     T_ULONG             unsigned long
                         
                         
     T_BOOL              char
                         
                         
     T_LONGLONG          long long
                         
                         
     T_ULONGLONG         unsigned long long
                         
                         
     T_PYSSIZET          Py_ssize_t
                         

     ‘T_OBJECT’ and ‘T_OBJECT_EX’ differ in that ‘T_OBJECT’ returns
     ‘None’ if the member is ‘NULL’ and ‘T_OBJECT_EX’ raises an *note
     AttributeError: 390.  Try to use ‘T_OBJECT_EX’ over ‘T_OBJECT’
     because ‘T_OBJECT_EX’ handles use of the *note del: 11a8. statement
     on that attribute more correctly than ‘T_OBJECT’.

     ‘flags’ can be ‘0’ for write and read access or ‘READONLY’ for
     read-only access.  Using ‘T_STRING’ for *note type: 5fd. implies
     ‘READONLY’.  ‘T_STRING’ data is interpreted as UTF-8.  Only
     ‘T_OBJECT’ and ‘T_OBJECT_EX’ members can be deleted.  (They are set
     to ‘NULL’).

 -- C Type: PyGetSetDef

     Structure to define property-like access for a type.  See also
     description of the *note PyTypeObject.tp_getset: 3a8e. slot.

     Field             C Type                 Meaning
                                              
     ---------------------------------------------------------------------------------
                                              
     name              const char *           attribute name
                                              
                                              
     get               getter                 C Function to get the attribute
                                              
                                              
     set               setter                 optional C function to set or delete
                                              the attribute, if omitted the
                                              attribute is readonly
                                              
                                              
     doc               const char *           optional docstring
                                              
                                              
     closure           void *                 optional function pointer, providing
                                              additional data for getter and setter
                                              

     The ‘get’ function takes one *note PyObject*: 4b0. parameter (the
     instance) and a function pointer (the associated ‘closure’):

          typedef PyObject *(*getter)(PyObject *, void *);

     It should return a new reference on success or ‘NULL’ with a set
     exception on failure.

     ‘set’ functions take two *note PyObject*: 4b0. parameters (the
     instance and the value to be set) and a function pointer (the
     associated ‘closure’):

          typedef int (*setter)(PyObject *, PyObject *, void *);

     In case the attribute should be deleted the second parameter is
     ‘NULL’.  Should return ‘0’ on success or ‘-1’ with a set exception
     on failure.


File: python.info,  Node: Type Objects<3>,  Next: Number Object Structures,  Prev: Common Object Structures,  Up: Object Implementation Support

7.12.3 Type Objects
-------------------

Perhaps one of the most important structures of the Python object system
is the structure that defines a new type: the *note PyTypeObject: 2d4.
structure.  Type objects can be handled using any of the ‘PyObject_*()’
or ‘PyType_*()’ functions, but do not offer much that’s interesting to
most Python applications.  These objects are fundamental to how objects
behave, so they are very important to the interpreter itself and to any
extension module that implements new types.

Type objects are fairly large compared to most of the standard types.
The reason for the size is that each type object stores a large number
of values, mostly C function pointers, each of which implements a small
part of the type’s functionality.  The fields of the type object are
examined in detail in this section.  The fields will be described in the
order in which they occur in the structure.

In addition to the following quick reference, the *note Examples: 3f9b.
section provides at-a-glance insight into the meaning and use of *note
PyTypeObject: 2d4.

* Menu:

* Quick Reference::
* PyTypeObject Definition::
* PyObject Slots::
* PyVarObject Slots::
* PyTypeObject Slots::
* Heap Types::


File: python.info,  Node: Quick Reference,  Next: PyTypeObject Definition,  Up: Type Objects<3>

7.12.3.1 Quick Reference
........................

* Menu:

* “tp slots”::
* sub-slots::
* slot typedefs::


File: python.info,  Node: “tp slots”,  Next: sub-slots,  Up: Quick Reference

7.12.3.2 “tp slots”
...................

PyTypeObject Slot      *note Type: 3f9f.      special                Info
(1)                                           methods/attrs          (2)
                                                                     
---------------------------------------------------------------------------------------------
                                                                     
O                      T                      D                      I
                                                                     
                                                                                       
<R>                    const char *           __name__               X     X
*note tp_name: 3a9f.                                                       

*note tp_basicsize: 3a7d.Py_ssize_t                                  X     X           X
                                                                                       
                                                                                       
*note tp_itemsize: 3a7c.Py_ssize_t                                         X           X
                                                                                       
                                                                                       
*note tp_dealloc: 3a83.*note destructor: 3fa0.                       X     X           X
                                                                                       
                                                                                       
*note tp_vectorcall_offset: 3c06.Py_ssize_t                                            ?
                                                                                       
                                                                                       
(*note tp_getattr: 3aa6.)*note getattrfunc: 3fa1.__getattribute__,                     G
                                              __getattr__                              
                                              
                                                                                       
(*note tp_setattr: 3aa7.)*note setattrfunc: 3fa2.__setattr__,                          G
                                              __delattr__                              
                                              
                                                                                       
*note tp_as_async: 3fa3.*note PyAsyncMethods: 3cb7.*note sub-slots: 3fa4.              %
                       *                                                               
                       
                                                                                       
*note tp_repr: 3a9e.   *note reprfunc: 3fa5.  __repr__               X     X           X
                                                                                       
                                                                                       
*note tp_as_number: 3fa6.*note PyNumberMethods: d74.*note sub-slots: 3fa4.             %
                       *                                                               
                       
                                                                                       
*note tp_as_sequence: 3fa7.*note PySequenceMethods: 3aae.*note sub-slots: 3fa4.        %
                       *                                                               
                       
                                                                                       
*note tp_as_mapping: 3fa8.*note PyMappingMethods: 3aaf.*note sub-slots: 3fa4.          %
                       *                                                               
                       
                                                                                       
*note tp_hash: 3ab0.   *note hashfunc: 3fa9.  __hash__               X                 G
                                                                                       
                                                                                       
*note tp_call: 3ab1.   *note ternaryfunc: 3faa.__call__                    X           X
                                                                                       
                                                                                       
*note tp_str: 3aa0.    *note reprfunc: 3fa5.  __str__                X                 X
                                                                                       
                                                                                       
*note tp_getattro: 3aa3.*note getattrofunc: 3fab.__getattribute__,   X     X           G
                                              __getattr__                              
                                              
                                                                                       
*note tp_setattro: 3aa4.*note setattrofunc: 3fac.__setattr__,        X     X           G
                                              __delattr__                              
                                              
                                                                                       
*note tp_as_buffer: 3fad.*note PyBufferProcs: 3fae.                                    %
                       *                                                               
                       
                                                                                       
*note tp_flags: 3ca6.  unsigned long                                 X     X           ?
                                                                                       
                                                                                       
*note tp_doc: 3a7f.    const char *           __doc__                X     X
                                                                           
                                                                                       
*note tp_traverse: 35fa.*note traverseproc: 3faf.                          X           G
                                                                                       
                                                                                       
*note tp_clear: 3a9c.  *note inquiry: 3fb0.                                X           G
                                                                                       
                                                                                       
*note tp_richcompare: 3aa9.*note richcmpfunc: 3fb1.__lt__, __le__,   X                 G
                                              __eq__, __ne__,                          
                                              __gt__, __ge__
                                              
                                                                                       
*note tp_weaklistoffset: 3ab3.Py_ssize_t                                   X           ?
                                                                                       
                                                                                       
*note tp_iter: e23.    *note getiterfunc: 3fb2.__iter__                                X
                                                                                       
                                                                                       
*note tp_iternext: e24.*note iternextfunc: 3fb3.__next__                               X
                                                                                       
                                                                                       
*note tp_methods: 3a8a.*note PyMethodDef: e0e.                       X     X
                       []                                                  
                       
                                                                                       
*note tp_members: 3a88.*note PyMemberDef: 41b.                             X
                       []                                                  
                       
                                                                                       
*note tp_getset: 3a8e. *note PyGetSetDef: 41c.                       X     X
                       []                                                  
                       
                                                                                       
*note tp_base: 3a94.   *note PyTypeObject: 2d4.__base__                          X
                       *                                                         
                       
                                                                                       
*note tp_dict: 3cba.   *note PyObject: 4b0.   __dict__                           ?
                       *                                                         
                       
                                                                                       
*note tp_descr_get: 3fb4.*note descrgetfunc: 3fb5.__get__                              X
                                                                                       
                                                                                       
*note tp_descr_set: 3fb6.*note descrsetfunc: 3fb7.__set__, __delete__                  X
                                                                                       
                                                                                       
*note tp_dictoffset: 3cbf.Py_ssize_t                                       X           ?
                                                                                       
                                                                                       
*note tp_init: 3a87.   *note initproc: 3fb8.  __init__               X     X           X
                                                                                       
                                                                                       
*note tp_alloc: 3a85.  *note allocfunc: 3fb9.                        X           ?     ?
                                                                                       
                                                                                       
*note tp_new: 3a80.    *note newfunc: 3fba.   __new__                X     X     ?     ?
                                                                                       
                                                                                       
*note tp_free: 3a84.   *note freefunc: 3fbb.                         X     X     ?     ?
                                                                                       
                                                                                       
*note tp_is_gc: 3fbc.  *note inquiry: 3fb0.                                X           X
                                                                                       
                                                                                       
<*note tp_bases: 3fbd.>*note PyObject: 4b0.   __bases__                          ~
                       *                                                         
                       
                                                                                       
<*note tp_mro: 3cbb.>  *note PyObject: 4b0.   __mro__                            ~
                       *                                                         
                       
                                                                                       
[*note tp_cache: 3cbc.]*note PyObject: 4b0.
                       *
                       
                                                                                       
[*note tp_subclasses: 3cbd.]*note PyObject: 4b0.__subclasses__
                       *                      
                       
                                                                                       
[*note tp_weaklist: 3cbe.]*note PyObject: 4b0.
                       *
                       
                                                                                       
(*note tp_del: 3fbe.)  *note destructor: 3fa0.
                       
                                                                                       
[*note tp_version_tag: 3fbf.]unsigned int
                       
                                                                                       
*note tp_finalize: 2d5.*note destructor: 3fa0.__del__                                  X
                                                                                       

If ‘COUNT_ALLOCS’ is defined then the following (internal-only) fields
exist as well:

   * *note tp_allocs: 3fc0.

   * *note tp_frees: 3fc1.

   * *note tp_maxalloc: 3fc2.

   * *note tp_prev: 3fc3.

   * *note tp_next: 3fc4.

   ---------- Footnotes ----------

   (1) (1) A slot name in parentheses indicates it is (effectively)
deprecated.  Names in angle brackets should be treated as read-only.
Names in square brackets are for internal use only.  “<R>” (as a prefix)
means the field is required (must be non-‘NULL’).

   (2) (2) Columns:

`“O”': set on ‘PyBaseObject_Type’

`“T”': set on *note PyType_Type: 3ca1.

`“D”': default (if slot is set to ‘NULL’)

     X - PyType_Ready sets this value if it is NULL ~ - PyType_Ready always sets this value (it should be NULL) ? - PyType_Ready may set this value depending on other slots  Also see the inheritance column ("I").

`“I”': inheritance

     X - type slot is inherited via PyType_Ready if defined with a NULL value % - the slots of the sub-struct are inherited individually G - inherited, but only in combination with other slots; see the slot's description ? - it's complicated; see the slot's description

Note that some slots are effectively inherited through the normal
attribute lookup chain.


File: python.info,  Node: sub-slots,  Next: slot typedefs,  Prev: “tp slots”,  Up: Quick Reference

7.12.3.3 sub-slots
..................

Slot                           *note Type: 3f9f.     special
                                                     methods
                                                     
----------------------------------------------------------------------
                                                     
*note am_await: 3fc6.          *note unaryfunc: 3fc7.__await__
                                                     
                                                     
*note am_aiter: 3fc8.          *note unaryfunc: 3fc7.__aiter__
                                                     
                                                     
*note am_anext: 3fc9.          *note unaryfunc: 3fc7.__anext__
                                                     
                                                     
                                                     
*note nb_add: 3cb8.            *note binaryfunc: 3fca.__add__
                                                     __radd__
                                                     
                                                     
*note nb_inplace_add: 3fcb.    *note binaryfunc: 3fca.__iadd__
                                                     
                                                     
*note nb_subtract: 3fcc.       *note binaryfunc: 3fca.__sub__
                                                     __rsub__
                                                     
                                                     
*note nb_inplace_subtract: 3fcd.*note binaryfunc: 3fca.__sub__
                                                     
                                                     
*note nb_multiply: 3fce.       *note binaryfunc: 3fca.__mul__
                                                     __rmul__
                                                     
                                                     
*note nb_inplace_multiply: 3fcf.*note binaryfunc: 3fca.__mul__
                                                     
                                                     
*note nb_remainder: 3fd0.      *note binaryfunc: 3fca.__mod__
                                                     __rmod__
                                                     
                                                     
*note nb_inplace_remainder: 3fd1.*note binaryfunc: 3fca.__mod__
                                                     
                                                     
*note nb_divmod: 3fd2.         *note binaryfunc: 3fca.__divmod__
                                                     __rdivmod__
                                                     
                                                     
*note nb_power: 3fd3.          *note ternaryfunc: 3faa.__pow__
                                                     __rpow__
                                                     
                                                     
*note nb_inplace_power: 3fd4.  *note ternaryfunc: 3faa.__pow__
                                                     
                                                     
*note nb_negative: 3fd5.       *note unaryfunc: 3fc7.__neg__
                                                     
                                                     
*note nb_positive: 3fd6.       *note unaryfunc: 3fc7.__pos__
                                                     
                                                     
*note nb_absolute: 3fd7.       *note unaryfunc: 3fc7.__abs__
                                                     
                                                     
*note nb_bool: 3fd8.           *note inquiry: 3fb0.  __bool__
                                                     
                                                     
*note nb_invert: 3fd9.         *note unaryfunc: 3fc7.__invert__
                                                     
                                                     
*note nb_lshift: 3fda.         *note binaryfunc: 3fca.__lshift__
                                                     __rlshift__
                                                     
                                                     
*note nb_inplace_lshift: 3fdb. *note binaryfunc: 3fca.__lshift__
                                                     
                                                     
*note nb_rshift: 3fdc.         *note binaryfunc: 3fca.__rshift__
                                                     __rrshift__
                                                     
                                                     
*note nb_inplace_rshift: 3fdd. *note binaryfunc: 3fca.__rshift__
                                                     
                                                     
*note nb_and: 3fde.            *note binaryfunc: 3fca.__and__
                                                     __rand__
                                                     
                                                     
*note nb_inplace_and: 3fdf.    *note binaryfunc: 3fca.__and__
                                                     
                                                     
*note nb_xor: 3fe0.            *note binaryfunc: 3fca.__xor__
                                                     __rxor__
                                                     
                                                     
*note nb_inplace_xor: 3fe1.    *note binaryfunc: 3fca.__xor__
                                                     
                                                     
*note nb_or: 3fe2.             *note binaryfunc: 3fca.__or__ __ror__
                                                     
                                                     
*note nb_inplace_or: 3fe3.     *note binaryfunc: 3fca.__or__
                                                     
                                                     
*note nb_int: 3fe4.            *note unaryfunc: 3fc7.__int__
                                                     
                                                     
*note nb_reserved: 3fe5.       void *
                               
                                                     
*note nb_float: 3fe6.          *note unaryfunc: 3fc7.__float__
                                                     
                                                     
*note nb_floor_divide: 3fe7.   *note binaryfunc: 3fca.__floordiv__
                                                     
                                                     
*note nb_inplace_floor_divide: 3fe8.*note binaryfunc: 3fca.__floordiv__
                                                     
                                                     
*note nb_true_divide: 3fe9.    *note binaryfunc: 3fca.__truediv__
                                                     
                                                     
*note nb_inplace_true_divide: 3fea.*note binaryfunc: 3fca.__truediv__
                                                     
                                                     
*note nb_index: 3feb.          *note unaryfunc: 3fc7.__index__
                                                     
                                                     
*note nb_matrix_multiply: 3fec.*note binaryfunc: 3fca.__matmul__
                                                     __rmatmul__
                                                     
                                                     
*note nb_inplace_matrix_multiply: 3fed.*note binaryfunc: 3fca.__matmul__
                                                     
                                                     
                                                     
*note mp_length: 3fee.         *note lenfunc: 3fef.  __len__
                                                     
                                                     
*note mp_subscript: 3ff0.      *note binaryfunc: 3fca.__getitem__
                                                     
                                                     
*note mp_ass_subscript: 3ff1.  *note objobjargproc: 3ff2.__setitem__,
                                                     __delitem__
                                                     
                                                     
                                                     
*note sq_length: 3cb9.         *note lenfunc: 3fef.  __len__
                                                     
                                                     
*note sq_concat: 3ff3.         *note binaryfunc: 3fca.__add__
                                                     
                                                     
*note sq_repeat: 3ff4.         *note ssizeargfunc: 3ff5.__mul__
                                                     
                                                     
*note sq_item: 3ff6.           *note ssizeargfunc: 3ff5.__getitem__
                                                     
                                                     
*note sq_ass_item: 3ff7.       *note ssizeobjargproc: 3ff8.__setitem__
                                                     __delitem__
                                                     
                                                     
*note sq_contains: 3ff9.       *note objobjproc: 3ffa.__contains__
                                                     
                                                     
*note sq_inplace_concat: 3ffb. *note binaryfunc: 3fca.__iadd__
                                                     
                                                     
*note sq_inplace_repeat: 3ffc. *note ssizeargfunc: 3ff5.__imul__
                                                     
                                                     
                                                     
*note bf_getbuffer: 3cc0.      *note getbufferproc(): 3ffd.
                               
                                                     
*note bf_releasebuffer: 3bc0.  *note releasebufferproc(): 3ffe.
                               


File: python.info,  Node: slot typedefs,  Prev: sub-slots,  Up: Quick Reference

7.12.3.4 slot typedefs
......................

typedef                           Parameter Types                   Return Type
                                                                    
-----------------------------------------------------------------------------------------------
                                                                    
*note allocfunc: 3fb9.                 *note PyTypeObject: 2d4. *   *note PyObject: 4b0. *
                                       Py_ssize_t                   
                                  
                                                                    
*note destructor: 3fa0.           void *                            void
                                                                    
                                                                    
*note freefunc: 3fbb.             void *                            void
                                                                    
                                                                    
*note traverseproc: 3faf.              void *                       int
                                       *note visitproc: 4000.       
                                       void * 
                                  
                                                                    
*note newfunc: 3fba.                   *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       *note PyObject: 4b0. *       
                                       *note PyObject: 4b0. * 
                                  
                                                                    
*note initproc: 3fb8.                  *note PyObject: 4b0. *       int
                                       *note PyObject: 4b0. *       
                                       *note PyObject: 4b0. * 
                                  
                                                                    
*note reprfunc: 3fa5.             *note PyObject: 4b0. *            *note PyObject: 4b0. *
                                                                    
                                                                    
*note getattrfunc: 3fa1.               *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       const char *                 
                                  
                                                                    
*note setattrfunc: 3fa2.               *note PyObject: 4b0. *       int
                                       const char *                 
                                       *note PyObject: 4b0. * 
                                  
                                                                    
*note getattrofunc: 3fab.              *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       *note PyObject: 4b0. *       
                                  
                                                                    
*note setattrofunc: 3fac.              *note PyObject: 4b0. *       int
                                       *note PyObject: 4b0. *       
                                       *note PyObject: 4b0. * 
                                  
                                                                    
*note descrgetfunc: 3fb5.              *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       *note PyObject: 4b0. *       
                                       *note PyObject: 4b0. * 
                                  
                                                                    
*note descrsetfunc: 3fb7.              *note PyObject: 4b0. *       int
                                       *note PyObject: 4b0. *       
                                       *note PyObject: 4b0. * 
                                  
                                                                    
*note hashfunc: 3fa9.             *note PyObject: 4b0. *            Py_hash_t
                                                                    
                                                                    
*note richcmpfunc: 3fb1.               *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       *note PyObject: 4b0. *       
                                       int 
                                  
                                                                    
*note getiterfunc: 3fb2.          *note PyObject: 4b0. *            *note PyObject: 4b0. *
                                                                    
                                                                    
*note iternextfunc: 3fb3.         *note PyObject: 4b0. *            *note PyObject: 4b0. *
                                                                    
                                                                    
*note lenfunc: 3fef.              *note PyObject: 4b0. *            Py_ssize_t
                                                                    
                                                                    
*note getbufferproc: 3ffd.             *note PyObject: 4b0. *       int
                                       *note Py_buffer: b0e. *      
                                       int 
                                  
                                                                    
*note releasebufferproc: 3ffe.         *note PyObject: 4b0. *       void
                                       *note Py_buffer: b0e. *      
                                  
                                                                    
*note inquiry: 3fb0.              void *                            int
                                                                    
                                                                    
*note unaryfunc: 3fc7.                 *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                                                    
                                                                    
*note binaryfunc: 3fca.                *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       *note PyObject: 4b0. *       
                                  
                                                                    
*note ternaryfunc: 3faa.               *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       *note PyObject: 4b0. *       
                                       *note PyObject: 4b0. * 
                                  
                                                                    
*note ssizeargfunc: 3ff5.              *note PyObject: 4b0. *       *note PyObject: 4b0. *
                                       Py_ssize_t                   
                                  
                                                                    
*note ssizeobjargproc: 3ff8.           *note PyObject: 4b0. *       int
                                       Py_ssize_t                   
                                  
                                                                    
*note objobjproc: 3ffa.                *note PyObject: 4b0. *       int
                                       *note PyObject: 4b0. *       
                                  
                                                                    
*note objobjargproc: 3ff2.             *note PyObject: 4b0. *       int
                                       *note PyObject: 4b0. *       
                                       *note PyObject: 4b0. * 
                                  

See *note Slot Type typedefs: 4001. below for more detail.


File: python.info,  Node: PyTypeObject Definition,  Next: PyObject Slots,  Prev: Quick Reference,  Up: Type Objects<3>

7.12.3.5 PyTypeObject Definition
................................

The structure definition for *note PyTypeObject: 2d4. can be found in
‘Include/object.h’.  For convenience of reference, this repeats the
definition found there:

     typedef struct _typeobject {     PyObject_VAR_HEAD     const char *tp_name; /* For printing, in format "<module>.<name>" */     Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */      /* Methods to implement standard operations */      destructor tp_dealloc;     Py_ssize_t tp_vectorcall_offset;     getattrfunc tp_getattr;     setattrfunc tp_setattr;     PyAsyncMethods *tp_as_async; /* formerly known as tp_compare (Python 2)                                     or tp_reserved (Python 3) */     reprfunc tp_repr;      /* Method suites for standard classes */      PyNumberMethods *tp_as_number;     PySequenceMethods *tp_as_sequence;     PyMappingMethods *tp_as_mapping;      /* More standard operations (here for binary compatibility) */      hashfunc tp_hash;     ternaryfunc tp_call;     reprfunc tp_str;     getattrofunc tp_getattro;     setattrofunc tp_setattro;      /* Functions to access object as input/output buffer */     PyBufferProcs *tp_as_buffer;      /* Flags to define presence of optional/expanded features */     unsigned long tp_flags;      const char *tp_doc; /* Documentation string */      /* call function for all accessible objects */     traverseproc tp_traverse;      /* delete references to contained objects */     inquiry tp_clear;      /* rich comparisons */     richcmpfunc tp_richcompare;      /* weak reference enabler */     Py_ssize_t tp_weaklistoffset;      /* Iterators */     getiterfunc tp_iter;     iternextfunc tp_iternext;      /* Attribute descriptor and subclassing stuff */     struct PyMethodDef *tp_methods;     struct PyMemberDef *tp_members;     struct PyGetSetDef *tp_getset;     struct _typeobject *tp_base;     PyObject *tp_dict;     descrgetfunc tp_descr_get;     descrsetfunc tp_descr_set;     Py_ssize_t tp_dictoffset;     initproc tp_init;     allocfunc tp_alloc;     newfunc tp_new;     freefunc tp_free; /* Low-level free-memory routine */     inquiry tp_is_gc; /* For PyObject_IS_GC */     PyObject *tp_bases;     PyObject *tp_mro; /* method resolution order */     PyObject *tp_cache;     PyObject *tp_subclasses;     PyObject *tp_weaklist;     destructor tp_del;      /* Type attribute cache version tag. Added in version 2.6 */     unsigned int tp_version_tag;      destructor tp_finalize;  } PyTypeObject;


File: python.info,  Node: PyObject Slots,  Next: PyVarObject Slots,  Prev: PyTypeObject Definition,  Up: Type Objects<3>

7.12.3.6 PyObject Slots
.......................

The type object structure extends the *note PyVarObject: 3f90.
structure.  The ‘ob_size’ field is used for dynamic types (created by
‘type_new()’, usually called from a class statement).  Note that *note
PyType_Type: 3ca1. (the metatype) initializes *note tp_itemsize: 3a7c,
which means that its instances (i.e.  type objects) `must' have the
‘ob_size’ field.

 -- C Member: PyObject* PyObject._ob_next
 -- C Member: PyObject* PyObject._ob_prev

     These fields are only present when the macro ‘Py_TRACE_REFS’ is
     defined.  Their initialization to ‘NULL’ is taken care of by the
     ‘PyObject_HEAD_INIT’ macro.  For statically allocated objects,
     these fields always remain ‘NULL’.  For dynamically allocated
     objects, these two fields are used to link the object into a
     doubly-linked list of `all' live objects on the heap.  This could
     be used for various debugging purposes; currently the only use is
     to print the objects that are still alive at the end of a run when
     the environment variable *note PYTHONDUMPREFS: 159. is set.

     `Inheritance:'

     These fields are not inherited by subtypes.

 -- C Member: Py_ssize_t PyObject.ob_refcnt

     This is the type object’s reference count, initialized to ‘1’ by
     the ‘PyObject_HEAD_INIT’ macro.  Note that for statically allocated
     type objects, the type’s instances (objects whose ‘ob_type’ points
     back to the type) do `not' count as references.  But for
     dynamically allocated type objects, the instances `do' count as
     references.

     `Inheritance:'

     This field is not inherited by subtypes.

 -- C Member: PyTypeObject* PyObject.ob_type

     This is the type’s type, in other words its metatype.  It is
     initialized by the argument to the ‘PyObject_HEAD_INIT’ macro, and
     its value should normally be ‘&PyType_Type’.  However, for
     dynamically loadable extension modules that must be usable on
     Windows (at least), the compiler complains that this is not a valid
     initializer.  Therefore, the convention is to pass ‘NULL’ to the
     ‘PyObject_HEAD_INIT’ macro and to initialize this field explicitly
     at the start of the module’s initialization function, before doing
     anything else.  This is typically done like this:

          Foo_Type.ob_type = &PyType_Type;

     This should be done before any instances of the type are created.
     *note PyType_Ready(): 3a86. checks if ‘ob_type’ is ‘NULL’, and if
     so, initializes it to the ‘ob_type’ field of the base class.  *note
     PyType_Ready(): 3a86. will not change this field if it is non-zero.

     `Inheritance:'

     This field is inherited by subtypes.


File: python.info,  Node: PyVarObject Slots,  Next: PyTypeObject Slots,  Prev: PyObject Slots,  Up: Type Objects<3>

7.12.3.7 PyVarObject Slots
..........................

 -- C Member: Py_ssize_t PyVarObject.ob_size

     For statically allocated type objects, this should be initialized
     to zero.  For dynamically allocated type objects, this field has a
     special internal meaning.

     `Inheritance:'

     This field is not inherited by subtypes.


File: python.info,  Node: PyTypeObject Slots,  Next: Heap Types,  Prev: PyVarObject Slots,  Up: Type Objects<3>

7.12.3.8 PyTypeObject Slots
...........................

Each slot has a section describing inheritance.  If *note
PyType_Ready(): 3a86. may set a value when the field is set to ‘NULL’
then there will also be a “Default” section.  (Note that many fields set
on ‘PyBaseObject_Type’ and *note PyType_Type: 3ca1. effectively act as
defaults.)

 -- C Member: const char* PyTypeObject.tp_name

     Pointer to a NUL-terminated string containing the name of the type.
     For types that are accessible as module globals, the string should
     be the full module name, followed by a dot, followed by the type
     name; for built-in types, it should be just the type name.  If the
     module is a submodule of a package, the full package name is part
     of the full module name.  For example, a type named ‘T’ defined in
     module ‘M’ in subpackage ‘Q’ in package ‘P’ should have the *note
     tp_name: 3a9f. initializer ‘"P.Q.M.T"’.

     For dynamically allocated type objects, this should just be the
     type name, and the module name explicitly stored in the type dict
     as the value for key ‘'__module__'’.

     For statically allocated type objects, the tp_name field should
     contain a dot.  Everything before the last dot is made accessible
     as the ‘__module__’ attribute, and everything after the last dot is
     made accessible as the *note __name__: c5a. attribute.

     If no dot is present, the entire *note tp_name: 3a9f. field is made
     accessible as the *note __name__: c5a. attribute, and the
     ‘__module__’ attribute is undefined (unless explicitly set in the
     dictionary, as explained above).  This means your type will be
     impossible to pickle.  Additionally, it will not be listed in
     module documentations created with pydoc.

     This field must not be ‘NULL’.  It is the only required field in
     *note PyTypeObject(): 2d4. (other than potentially *note
     tp_itemsize: 3a7c.).

     `Inheritance:'

     This field is not inherited by subtypes.

 -- C Member: Py_ssize_t PyTypeObject.tp_basicsize
 -- C Member: Py_ssize_t PyTypeObject.tp_itemsize

     These fields allow calculating the size in bytes of instances of
     the type.

     There are two kinds of types: types with fixed-length instances
     have a zero *note tp_itemsize: 3a7c. field, types with
     variable-length instances have a non-zero *note tp_itemsize: 3a7c.
     field.  For a type with fixed-length instances, all instances have
     the same size, given in *note tp_basicsize: 3a7d.

     For a type with variable-length instances, the instances must have
     an ‘ob_size’ field, and the instance size is *note tp_basicsize:
     3a7d. plus N times *note tp_itemsize: 3a7c, where N is the “length”
     of the object.  The value of N is typically stored in the
     instance’s ‘ob_size’ field.  There are exceptions: for example,
     ints use a negative ‘ob_size’ to indicate a negative number, and N
     is ‘abs(ob_size)’ there.  Also, the presence of an ‘ob_size’ field
     in the instance layout doesn’t mean that the instance structure is
     variable-length (for example, the structure for the list type has
     fixed-length instances, yet those instances have a meaningful
     ‘ob_size’ field).

     The basic size includes the fields in the instance declared by the
     macro *note PyObject_HEAD: c65. or *note PyObject_VAR_HEAD: 3f92.
     (whichever is used to declare the instance struct) and this in turn
     includes the ‘_ob_prev’ and ‘_ob_next’ fields if they are present.
     This means that the only correct way to get an initializer for the
     *note tp_basicsize: 3a7d. is to use the ‘sizeof’ operator on the
     struct used to declare the instance layout.  The basic size does
     not include the GC header size.

     A note about alignment: if the variable items require a particular
     alignment, this should be taken care of by the value of *note
     tp_basicsize: 3a7d.  Example: suppose a type implements an array of
     ‘double’.  *note tp_itemsize: 3a7c. is ‘sizeof(double)’.  It is the
     programmer’s responsibility that *note tp_basicsize: 3a7d. is a
     multiple of ‘sizeof(double)’ (assuming this is the alignment
     requirement for ‘double’).

     For any type with variable-length instances, this field must not be
     ‘NULL’.

     `Inheritance:'

     These fields are inherited separately by subtypes.  If the base
     type has a non-zero *note tp_itemsize: 3a7c, it is generally not
     safe to set *note tp_itemsize: 3a7c. to a different non-zero value
     in a subtype (though this depends on the implementation of the base
     type).

 -- C Member: destructor PyTypeObject.tp_dealloc

     A pointer to the instance destructor function.  This function must
     be defined unless the type guarantees that its instances will never
     be deallocated (as is the case for the singletons ‘None’ and
     ‘Ellipsis’).  The function signature is:

          void tp_dealloc(PyObject *self);

     The destructor function is called by the *note Py_DECREF(): 264.
     and *note Py_XDECREF(): 266. macros when the new reference count is
     zero.  At this point, the instance is still in existence, but there
     are no references to it.  The destructor function should free all
     references which the instance owns, free all memory buffers owned
     by the instance (using the freeing function corresponding to the
     allocation function used to allocate the buffer), and call the
     type’s *note tp_free: 3a84. function.  If the type is not
     subtypable (doesn’t have the *note Py_TPFLAGS_BASETYPE: 3a8b. flag
     bit set), it is permissible to call the object deallocator directly
     instead of via *note tp_free: 3a84.  The object deallocator should
     be the one used to allocate the instance; this is normally *note
     PyObject_Del(): e09. if the instance was allocated using *note
     PyObject_New(): 2d0. or ‘PyObject_VarNew()’, or *note
     PyObject_GC_Del(): e36. if the instance was allocated using *note
     PyObject_GC_New(): 2d2. or *note PyObject_GC_NewVar(): 2d3.

     Finally, if the type is heap allocated (*note Py_TPFLAGS_HEAPTYPE:
     3cae.), the deallocator should decrement the reference count for
     its type object after calling the type deallocator.  In order to
     avoid dangling pointers, the recommended way to achieve this is:

          static void foo_dealloc(foo_object *self) {     PyTypeObject *tp = Py_TYPE(self);     // free references and buffers here     tp->tp_free(self);     Py_DECREF(tp); }

     `Inheritance:'

     This field is inherited by subtypes.

 -- C Member: Py_ssize_t PyTypeObject.tp_vectorcall_offset

     An optional offset to a per-instance function that implements
     calling the object using the `vectorcall' protocol, a more
     efficient alternative of the simpler *note tp_call: 3ab1.

     This field is only used if the flag *note
     _Py_TPFLAGS_HAVE_VECTORCALL: 400b. is set.  If so, this must be a
     positive integer containing the offset in the instance of a *note
     vectorcallfunc: 400c. pointer.  The signature is the same as for
     *note _PyObject_Vectorcall(): 3c05.:

          PyObject *vectorcallfunc(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)

     The `vectorcallfunc' pointer may be zero, in which case the
     instance behaves as if *note _Py_TPFLAGS_HAVE_VECTORCALL: 400b. was
     not set: calling the instance falls back to *note tp_call: 3ab1.

     Any class that sets ‘_Py_TPFLAGS_HAVE_VECTORCALL’ must also set
     *note tp_call: 3ab1. and make sure its behaviour is consistent with
     the `vectorcallfunc' function.  This can be done by setting
     `tp_call' to ‘PyVectorcall_Call’:

      -- C Function: PyObject *PyVectorcall_Call (PyObject *callable,
               PyObject *tuple, PyObject *dict)

          Call `callable'’s `vectorcallfunc' with positional and keyword
          arguments given in a tuple and dict, respectively.

          This function is intended to be used in the ‘tp_call’ slot.
          It does not fall back to ‘tp_call’ and it currently does not
          check the ‘_Py_TPFLAGS_HAVE_VECTORCALL’ flag.  To call an
          object, use one of the *note PyObject_Call: 3a54. functions
          instead.

          Note: It is not recommended for *note heap types: 3cac. to
          implement the vectorcall protocol.  When a user sets
          ‘__call__’ in Python code, only ‘tp_call’ is updated, possibly
          making it inconsistent with the vectorcall function.

          Note: The semantics of the ‘tp_vectorcall_offset’ slot are
          provisional and expected to be finalized in Python 3.9.  If
          you use vectorcall, plan for updating your code for Python
          3.9.

     Changed in version 3.8: This slot was used for print formatting in
     Python 2.x.  In Python 3.0 to 3.7, it was reserved and named
     ‘tp_print’.

     `Inheritance:'

     This field is inherited by subtypes together with *note tp_call:
     3ab1.: a subtype inherits *note tp_vectorcall_offset: 3c06. from
     its base type when the subtype’s *note tp_call: 3ab1. is ‘NULL’.

     Note that *note heap types: 400e. (including subclasses defined in
     Python) do not inherit the *note _Py_TPFLAGS_HAVE_VECTORCALL: 400b.
     flag.

 -- C Member: getattrfunc PyTypeObject.tp_getattr

     An optional pointer to the get-attribute-string function.

     This field is deprecated.  When it is defined, it should point to a
     function that acts the same as the *note tp_getattro: 3aa3.
     function, but taking a C string instead of a Python string object
     to give the attribute name.

     `Inheritance:'

     Group: ‘tp_getattr’, ‘tp_getattro’

     This field is inherited by subtypes together with *note
     tp_getattro: 3aa3.: a subtype inherits both *note tp_getattr: 3aa6.
     and *note tp_getattro: 3aa3. from its base type when the subtype’s
     *note tp_getattr: 3aa6. and *note tp_getattro: 3aa3. are both
     ‘NULL’.

 -- C Member: setattrfunc PyTypeObject.tp_setattr

     An optional pointer to the function for setting and deleting
     attributes.

     This field is deprecated.  When it is defined, it should point to a
     function that acts the same as the *note tp_setattro: 3aa4.
     function, but taking a C string instead of a Python string object
     to give the attribute name.

     `Inheritance:'

     Group: ‘tp_setattr’, ‘tp_setattro’

     This field is inherited by subtypes together with *note
     tp_setattro: 3aa4.: a subtype inherits both *note tp_setattr: 3aa7.
     and *note tp_setattro: 3aa4. from its base type when the subtype’s
     *note tp_setattr: 3aa7. and *note tp_setattro: 3aa4. are both
     ‘NULL’.

 -- C Member: PyAsyncMethods* PyTypeObject.tp_as_async

     Pointer to an additional structure that contains fields relevant
     only to objects which implement *note awaitable: 50e. and *note
     asynchronous iterator: 639. protocols at the C-level.  See *note
     Async Object Structures: 400f. for details.

     New in version 3.5: Formerly known as ‘tp_compare’ and
     ‘tp_reserved’.

     `Inheritance:'

     The *note tp_as_async: 3fa3. field is not inherited, but the
     contained fields are inherited individually.

 -- C Member: reprfunc PyTypeObject.tp_repr

     An optional pointer to a function that implements the built-in
     function *note repr(): 7c0.

     The signature is the same as for *note PyObject_Repr(): 95c.:

          PyObject *tp_repr(PyObject *self);

     The function must return a string or a Unicode object.  Ideally,
     this function should return a string that, when passed to *note
     eval(): b83, given a suitable environment, returns an object with
     the same value.  If this is not feasible, it should return a string
     starting with ‘'<'’ and ending with ‘'>'’ from which both the type
     and the value of the object can be deduced.

     `Inheritance:'

     This field is inherited by subtypes.

     `Default:'

     When this field is not set, a string of the form ‘<%s object at
     %p>’ is returned, where ‘%s’ is replaced by the type name, and ‘%p’
     by the object’s memory address.

 -- C Member: PyNumberMethods* PyTypeObject.tp_as_number

     Pointer to an additional structure that contains fields relevant
     only to objects which implement the number protocol.  These fields
     are documented in *note Number Object Structures: 4010.

     `Inheritance:'

     The *note tp_as_number: 3fa6. field is not inherited, but the
     contained fields are inherited individually.

 -- C Member: PySequenceMethods* PyTypeObject.tp_as_sequence

     Pointer to an additional structure that contains fields relevant
     only to objects which implement the sequence protocol.  These
     fields are documented in *note Sequence Object Structures: 4011.

     `Inheritance:'

     The *note tp_as_sequence: 3fa7. field is not inherited, but the
     contained fields are inherited individually.

 -- C Member: PyMappingMethods* PyTypeObject.tp_as_mapping

     Pointer to an additional structure that contains fields relevant
     only to objects which implement the mapping protocol.  These fields
     are documented in *note Mapping Object Structures: 4012.

     `Inheritance:'

     The *note tp_as_mapping: 3fa8. field is not inherited, but the
     contained fields are inherited individually.

 -- C Member: hashfunc PyTypeObject.tp_hash

     An optional pointer to a function that implements the built-in
     function *note hash(): 9b8.

     The signature is the same as for *note PyObject_Hash(): 3c0a.:

          Py_hash_t tp_hash(PyObject *);

     The value ‘-1’ should not be returned as a normal return value;
     when an error occurs during the computation of the hash value, the
     function should set an exception and return ‘-1’.

     When this field is not set (`and' ‘tp_richcompare’ is not set), an
     attempt to take the hash of the object raises *note TypeError: 192.
     This is the same as setting it to *note
     PyObject_HashNotImplemented(): d24.

     This field can be set explicitly to *note
     PyObject_HashNotImplemented(): d24. to block inheritance of the
     hash method from a parent type.  This is interpreted as the
     equivalent of ‘__hash__ = None’ at the Python level, causing
     ‘isinstance(o, collections.Hashable)’ to correctly return ‘False’.
     Note that the converse is also true - setting ‘__hash__ = None’ on
     a class at the Python level will result in the ‘tp_hash’ slot being
     set to *note PyObject_HashNotImplemented(): d24.

     `Inheritance:'

     Group: ‘tp_hash’, ‘tp_richcompare’

     This field is inherited by subtypes together with *note
     tp_richcompare: 3aa9.: a subtype inherits both of *note
     tp_richcompare: 3aa9. and *note tp_hash: 3ab0, when the subtype’s
     *note tp_richcompare: 3aa9. and *note tp_hash: 3ab0. are both
     ‘NULL’.

 -- C Member: ternaryfunc PyTypeObject.tp_call

     An optional pointer to a function that implements calling the
     object.  This should be ‘NULL’ if the object is not callable.  The
     signature is the same as for *note PyObject_Call(): 3a54.:

          PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);

     `Inheritance:'

     This field is inherited by subtypes.

 -- C Member: reprfunc PyTypeObject.tp_str

     An optional pointer to a function that implements the built-in
     operation *note str(): 325.  (Note that *note str: 325. is a type
     now, and *note str(): 325. calls the constructor for that type.
     This constructor calls *note PyObject_Str(): 95d. to do the actual
     work, and *note PyObject_Str(): 95d. will call this handler.)

     The signature is the same as for *note PyObject_Str(): 95d.:

          PyObject *tp_str(PyObject *self);

     The function must return a string or a Unicode object.  It should
     be a “friendly” string representation of the object, as this is the
     representation that will be used, among other things, by the *note
     print(): 87a. function.

     `Inheritance:'

     This field is inherited by subtypes.

     `Default:'

     When this field is not set, *note PyObject_Repr(): 95c. is called
     to return a string representation.

 -- C Member: getattrofunc PyTypeObject.tp_getattro

     An optional pointer to the get-attribute function.

     The signature is the same as for *note PyObject_GetAttr(): 3bf6.:

          PyObject *tp_getattro(PyObject *self, PyObject *attr);

     It is usually convenient to set this field to *note
     PyObject_GenericGetAttr(): 3bf8, which implements the normal way of
     looking for object attributes.

     `Inheritance:'

     Group: ‘tp_getattr’, ‘tp_getattro’

     This field is inherited by subtypes together with *note tp_getattr:
     3aa6.: a subtype inherits both *note tp_getattr: 3aa6. and *note
     tp_getattro: 3aa3. from its base type when the subtype’s *note
     tp_getattr: 3aa6. and *note tp_getattro: 3aa3. are both ‘NULL’.

     `Default:'

     ‘PyBaseObject_Type’ uses *note PyObject_GenericGetAttr(): 3bf8.

 -- C Member: setattrofunc PyTypeObject.tp_setattro

     An optional pointer to the function for setting and deleting
     attributes.

     The signature is the same as for *note PyObject_SetAttr(): 3bf9.:

          PyObject *tp_setattro(PyObject *self, PyObject *attr, PyObject *value);

     In addition, setting `value' to ‘NULL’ to delete an attribute must
     be supported.  It is usually convenient to set this field to *note
     PyObject_GenericSetAttr(): 3bfd, which implements the normal way of
     setting object attributes.

     `Inheritance:'

     Group: ‘tp_setattr’, ‘tp_setattro’

     This field is inherited by subtypes together with *note tp_setattr:
     3aa7.: a subtype inherits both *note tp_setattr: 3aa7. and *note
     tp_setattro: 3aa4. from its base type when the subtype’s *note
     tp_setattr: 3aa7. and *note tp_setattro: 3aa4. are both ‘NULL’.

     `Default:'

     ‘PyBaseObject_Type’ uses *note PyObject_GenericSetAttr(): 3bfd.

 -- C Member: PyBufferProcs* PyTypeObject.tp_as_buffer

     Pointer to an additional structure that contains fields relevant
     only to objects which implement the buffer interface.  These fields
     are documented in *note Buffer Object Structures: 3c5e.

     `Inheritance:'

     The *note tp_as_buffer: 3fad. field is not inherited, but the
     contained fields are inherited individually.

 -- C Member: unsigned long PyTypeObject.tp_flags

     This field is a bit mask of various flags.  Some flags indicate
     variant semantics for certain situations; others are used to
     indicate that certain fields in the type object (or in the
     extension structures referenced via *note tp_as_number: 3fa6, *note
     tp_as_sequence: 3fa7, *note tp_as_mapping: 3fa8, and *note
     tp_as_buffer: 3fad.) that were historically not always present are
     valid; if such a flag bit is clear, the type fields it guards must
     not be accessed and must be considered to have a zero or ‘NULL’
     value instead.

     `Inheritance:'

     Inheritance of this field is complicated.  Most flag bits are
     inherited individually, i.e.  if the base type has a flag bit set,
     the subtype inherits this flag bit.  The flag bits that pertain to
     extension structures are strictly inherited if the extension
     structure is inherited, i.e.  the base type’s value of the flag bit
     is copied into the subtype together with a pointer to the extension
     structure.  The *note Py_TPFLAGS_HAVE_GC: 3a92. flag bit is
     inherited together with the *note tp_traverse: 35fa. and *note
     tp_clear: 3a9c. fields, i.e.  if the *note Py_TPFLAGS_HAVE_GC:
     3a92. flag bit is clear in the subtype and the *note tp_traverse:
     35fa. and *note tp_clear: 3a9c. fields in the subtype exist and
     have ‘NULL’ values.

     `Default:'

     ‘PyBaseObject_Type’ uses ‘Py_TPFLAGS_DEFAULT |
     Py_TPFLAGS_BASETYPE’.

     `Bit Masks:'

     The following bit masks are currently defined; these can be ORed
     together using the ‘|’ operator to form the value of the *note
     tp_flags: 3ca6. field.  The macro *note PyType_HasFeature(): 3ca8.
     takes a type and a flags value, `tp' and `f', and checks whether
     ‘tp->tp_flags & f’ is non-zero.

      -- Data: Py_TPFLAGS_HEAPTYPE

          This bit is set when the type object itself is allocated on
          the heap, for example, types created dynamically using *note
          PyType_FromSpec(): 2cf.  In this case, the ‘ob_type’ field of
          its instances is considered a reference to the type, and the
          type object is INCREF’ed when a new instance is created, and
          DECREF’ed when an instance is destroyed (this does not apply
          to instances of subtypes; only the type referenced by the
          instance’s ob_type gets INCREF’ed or DECREF’ed).

          `Inheritance:'

          ???

      -- Data: Py_TPFLAGS_BASETYPE

          This bit is set when the type can be used as the base type of
          another type.  If this bit is clear, the type cannot be
          subtyped (similar to a “final” class in Java).

          `Inheritance:'

          ???

      -- Data: Py_TPFLAGS_READY

          This bit is set when the type object has been fully
          initialized by *note PyType_Ready(): 3a86.

          `Inheritance:'

          ???

      -- Data: Py_TPFLAGS_READYING

          This bit is set while *note PyType_Ready(): 3a86. is in the
          process of initializing the type object.

          `Inheritance:'

          ???

      -- Data: Py_TPFLAGS_HAVE_GC

          This bit is set when the object supports garbage collection.
          If this bit is set, instances must be created using *note
          PyObject_GC_New(): 2d2. and destroyed using *note
          PyObject_GC_Del(): e36.  More information in section *note
          Supporting Cyclic Garbage Collection: 4015.  This bit also
          implies that the GC-related fields *note tp_traverse: 35fa.
          and *note tp_clear: 3a9c. are present in the type object.

          `Inheritance:'

          Group: *note Py_TPFLAGS_HAVE_GC: 3a92, ‘tp_traverse’,
          ‘tp_clear’

          The *note Py_TPFLAGS_HAVE_GC: 3a92. flag bit is inherited
          together with the ‘tp_traverse’ and ‘tp_clear’ fields, i.e.
          if the *note Py_TPFLAGS_HAVE_GC: 3a92. flag bit is clear in
          the subtype and the ‘tp_traverse’ and ‘tp_clear’ fields in the
          subtype exist and have ‘NULL’ values.

      -- Data: Py_TPFLAGS_DEFAULT

          This is a bitmask of all the bits that pertain to the
          existence of certain fields in the type object and its
          extension structures.  Currently, it includes the following
          bits: ‘Py_TPFLAGS_HAVE_STACKLESS_EXTENSION’,
          ‘Py_TPFLAGS_HAVE_VERSION_TAG’.

          `Inheritance:'

          ???

      -- Data: Py_TPFLAGS_METHOD_DESCRIPTOR

          This bit indicates that objects behave like unbound methods.

          If this flag is set for ‘type(meth)’, then:

             - ‘meth.__get__(obj, cls)(*args, **kwds)’ (with ‘obj’ not
               None) must be equivalent to ‘meth(obj, *args, **kwds)’.

             - ‘meth.__get__(None, cls)(*args, **kwds)’ must be
               equivalent to ‘meth(*args, **kwds)’.

          This flag enables an optimization for typical method calls
          like ‘obj.meth()’: it avoids creating a temporary “bound
          method” object for ‘obj.meth’.

          New in version 3.8.

          `Inheritance:'

          This flag is never inherited by heap types.  For extension
          types, it is inherited whenever *note tp_descr_get: 3fb4. is
          inherited.

      -- Data: Py_TPFLAGS_LONG_SUBCLASS

      -- Data: Py_TPFLAGS_LIST_SUBCLASS

      -- Data: Py_TPFLAGS_TUPLE_SUBCLASS

      -- Data: Py_TPFLAGS_BYTES_SUBCLASS

      -- Data: Py_TPFLAGS_UNICODE_SUBCLASS

      -- Data: Py_TPFLAGS_DICT_SUBCLASS

      -- Data: Py_TPFLAGS_BASE_EXC_SUBCLASS

      -- Data: Py_TPFLAGS_TYPE_SUBCLASS

          These flags are used by functions such as *note
          PyLong_Check(): 3ccc. to quickly determine if a type is a
          subclass of a built-in type; such specific checks are faster
          than a generic check, like *note PyObject_IsInstance(): 791.
          Custom types that inherit from built-ins should have their
          *note tp_flags: 3ca6. set appropriately, or the code that
          interacts with such types will behave differently depending on
          what kind of check is used.

      -- Data: Py_TPFLAGS_HAVE_FINALIZE

          This bit is set when the *note tp_finalize: 2d5. slot is
          present in the type structure.

          New in version 3.4.

          Deprecated since version 3.8: This flag isn’t necessary
          anymore, as the interpreter assumes the *note tp_finalize:
          2d5. slot is always present in the type structure.

      -- Data: _Py_TPFLAGS_HAVE_VECTORCALL

          This bit is set when the class implements the vectorcall
          protocol.  See *note tp_vectorcall_offset: 3c06. for details.

          `Inheritance:'

          This bit is set on `static' subtypes if ‘tp_flags’ is not
          overridden: a subtype inherits ‘_Py_TPFLAGS_HAVE_VECTORCALL’
          from its base type when the subtype’s *note tp_call: 3ab1. is
          ‘NULL’ and the subtype’s ‘Py_TPFLAGS_HEAPTYPE’ is not set.

          *note Heap types: 400e. do not inherit
          ‘_Py_TPFLAGS_HAVE_VECTORCALL’.

               Note: This flag is provisional and expected to become
               public in Python 3.9, with a different name and,
               possibly, changed semantics.  If you use vectorcall, plan
               for updating your code for Python 3.9.

          New in version 3.8.

 -- C Member: const char* PyTypeObject.tp_doc

     An optional pointer to a NUL-terminated C string giving the
     docstring for this type object.  This is exposed as the ‘__doc__’
     attribute on the type and instances of the type.

     `Inheritance:'

     This field is `not' inherited by subtypes.

 -- C Member: traverseproc PyTypeObject.tp_traverse

     An optional pointer to a traversal function for the garbage
     collector.  This is only used if the *note Py_TPFLAGS_HAVE_GC:
     3a92. flag bit is set.  The signature is:

          int tp_traverse(PyObject *self, visitproc visit, void *arg);

     More information about Python’s garbage collection scheme can be
     found in section *note Supporting Cyclic Garbage Collection: 4015.

     The *note tp_traverse: 35fa. pointer is used by the garbage
     collector to detect reference cycles.  A typical implementation of
     a *note tp_traverse: 35fa. function simply calls *note Py_VISIT():
     3a90. on each of the instance’s members that are Python objects.
     For example, this is function ‘local_traverse()’ from the *note
     _thread: 3. extension module:

          static int local_traverse(localobject *self, visitproc visit, void *arg) {     Py_VISIT(self->args);     Py_VISIT(self->kw);     Py_VISIT(self->dict);     return 0; }

     Note that *note Py_VISIT(): 3a90. is called only on those members
     that can participate in reference cycles.  Although there is also a
     ‘self->key’ member, it can only be ‘NULL’ or a Python string and
     therefore cannot be part of a reference cycle.

     On the other hand, even if you know a member can never be part of a
     cycle, as a debugging aid you may want to visit it anyway just so
     the *note gc: 86. module’s *note get_referents(): 35f9. function
     will include it.

     Note that *note Py_VISIT(): 3a90. requires the `visit' and `arg'
     parameters to ‘local_traverse()’ to have these specific names;
     don’t name them just anything.

     `Inheritance:'

     Group: *note Py_TPFLAGS_HAVE_GC: 3a92, ‘tp_traverse’, ‘tp_clear’

     This field is inherited by subtypes together with *note tp_clear:
     3a9c. and the *note Py_TPFLAGS_HAVE_GC: 3a92. flag bit: the flag
     bit, *note tp_traverse: 35fa, and *note tp_clear: 3a9c. are all
     inherited from the base type if they are all zero in the subtype.

 -- C Member: inquiry PyTypeObject.tp_clear

     An optional pointer to a clear function for the garbage collector.
     This is only used if the *note Py_TPFLAGS_HAVE_GC: 3a92. flag bit
     is set.  The signature is:

          int tp_clear(PyObject *);

     The *note tp_clear: 3a9c. member function is used to break
     reference cycles in cyclic garbage detected by the garbage
     collector.  Taken together, all *note tp_clear: 3a9c. functions in
     the system must combine to break all reference cycles.  This is
     subtle, and if in any doubt supply a *note tp_clear: 3a9c.
     function.  For example, the tuple type does not implement a *note
     tp_clear: 3a9c. function, because it’s possible to prove that no
     reference cycle can be composed entirely of tuples.  Therefore the
     *note tp_clear: 3a9c. functions of other types must be sufficient
     to break any cycle containing a tuple.  This isn’t immediately
     obvious, and there’s rarely a good reason to avoid implementing
     *note tp_clear: 3a9c.

     Implementations of *note tp_clear: 3a9c. should drop the instance’s
     references to those of its members that may be Python objects, and
     set its pointers to those members to ‘NULL’, as in the following
     example:

          static int local_clear(localobject *self) {     Py_CLEAR(self->key);     Py_CLEAR(self->args);     Py_CLEAR(self->kw);     Py_CLEAR(self->dict);     return 0; }

     The *note Py_CLEAR(): 3a91. macro should be used, because clearing
     references is delicate: the reference to the contained object must
     not be decremented until after the pointer to the contained object
     is set to ‘NULL’.  This is because decrementing the reference count
     may cause the contained object to become trash, triggering a chain
     of reclamation activity that may include invoking arbitrary Python
     code (due to finalizers, or weakref callbacks, associated with the
     contained object).  If it’s possible for such code to reference
     `self' again, it’s important that the pointer to the contained
     object be ‘NULL’ at that time, so that `self' knows the contained
     object can no longer be used.  The *note Py_CLEAR(): 3a91. macro
     performs the operations in a safe order.

     Because the goal of *note tp_clear: 3a9c. functions is to break
     reference cycles, it’s not necessary to clear contained objects
     like Python strings or Python integers, which can’t participate in
     reference cycles.  On the other hand, it may be convenient to clear
     all contained Python objects, and write the type’s *note
     tp_dealloc: 3a83. function to invoke *note tp_clear: 3a9c.

     More information about Python’s garbage collection scheme can be
     found in section *note Supporting Cyclic Garbage Collection: 4015.

     `Inheritance:'

     Group: *note Py_TPFLAGS_HAVE_GC: 3a92, ‘tp_traverse’, ‘tp_clear’

     This field is inherited by subtypes together with *note
     tp_traverse: 35fa. and the *note Py_TPFLAGS_HAVE_GC: 3a92. flag
     bit: the flag bit, *note tp_traverse: 35fa, and *note tp_clear:
     3a9c. are all inherited from the base type if they are all zero in
     the subtype.

 -- C Member: richcmpfunc PyTypeObject.tp_richcompare

     An optional pointer to the rich comparison function, whose
     signature is:

          PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);

     The first parameter is guaranteed to be an instance of the type
     that is defined by *note PyTypeObject: 2d4.

     The function should return the result of the comparison (usually
     ‘Py_True’ or ‘Py_False’).  If the comparison is undefined, it must
     return ‘Py_NotImplemented’, if another error occurred it must
     return ‘NULL’ and set an exception condition.

     The following constants are defined to be used as the third
     argument for *note tp_richcompare: 3aa9. and for *note
     PyObject_RichCompare(): 3aaa.:

     Constant             Comparison
                          
     --------------------------------------
                          
     ‘Py_LT’              ‘<’
                          
                          
     ‘Py_LE’              ‘<=’
                          
                          
     ‘Py_EQ’              ‘==’
                          
                          
     ‘Py_NE’              ‘!=’
                          
                          
     ‘Py_GT’              ‘>’
                          
                          
     ‘Py_GE’              ‘>=’
                          

     The following macro is defined to ease writing rich comparison
     functions:

      -- C Function: PyObject *Py_RETURN_RICHCOMPARE (VAL_A, VAL_B,
               int op)

          Return ‘Py_True’ or ‘Py_False’ from the function, depending on
          the result of a comparison.  VAL_A and VAL_B must be orderable
          by C comparison operators (for example, they may be C ints or
          floats).  The third argument specifies the requested
          operation, as for *note PyObject_RichCompare(): 3aaa.

          The return value’s reference count is properly incremented.

          On error, sets an exception and returns ‘NULL’ from the
          function.

          New in version 3.7.

     `Inheritance:'

     Group: ‘tp_hash’, ‘tp_richcompare’

     This field is inherited by subtypes together with *note tp_hash:
     3ab0.: a subtype inherits *note tp_richcompare: 3aa9. and *note
     tp_hash: 3ab0. when the subtype’s *note tp_richcompare: 3aa9. and
     *note tp_hash: 3ab0. are both ‘NULL’.

     `Default:'

     ‘PyBaseObject_Type’ provides a ‘tp_richcompare’ implementation,
     which may be inherited.  However, if only ‘tp_hash’ is defined, not
     even the inherited function is used and instances of the type will
     not be able to participate in any comparisons.

 -- C Member: Py_ssize_t PyTypeObject.tp_weaklistoffset

     If the instances of this type are weakly referenceable, this field
     is greater than zero and contains the offset in the instance
     structure of the weak reference list head (ignoring the GC header,
     if present); this offset is used by ‘PyObject_ClearWeakRefs()’ and
     the ‘PyWeakref_*()’ functions.  The instance structure needs to
     include a field of type *note PyObject*: 4b0. which is initialized
     to ‘NULL’.

     Do not confuse this field with *note tp_weaklist: 3cbe.; that is
     the list head for weak references to the type object itself.

     `Inheritance:'

     This field is inherited by subtypes, but see the rules listed
     below.  A subtype may override this offset; this means that the
     subtype uses a different weak reference list head than the base
     type.  Since the list head is always found via *note
     tp_weaklistoffset: 3ab3, this should not be a problem.

     When a type defined by a class statement has no *note __slots__:
     e20. declaration, and none of its base types are weakly
     referenceable, the type is made weakly referenceable by adding a
     weak reference list head slot to the instance layout and setting
     the *note tp_weaklistoffset: 3ab3. of that slot’s offset.

     When a type’s ‘__slots__’ declaration contains a slot named
     ‘__weakref__’, that slot becomes the weak reference list head for
     instances of the type, and the slot’s offset is stored in the
     type’s *note tp_weaklistoffset: 3ab3.

     When a type’s ‘__slots__’ declaration does not contain a slot named
     ‘__weakref__’, the type inherits its *note tp_weaklistoffset: 3ab3.
     from its base type.

 -- C Member: getiterfunc PyTypeObject.tp_iter

     An optional pointer to a function that returns an iterator for the
     object.  Its presence normally signals that the instances of this
     type are iterable (although sequences may be iterable without this
     function).

     This function has the same signature as *note PyObject_GetIter():
     3c12.:

          PyObject *tp_iter(PyObject *self);

     `Inheritance:'

     This field is inherited by subtypes.

 -- C Member: iternextfunc PyTypeObject.tp_iternext

     An optional pointer to a function that returns the next item in an
     iterator.  The signature is:

          PyObject *tp_iternext(PyObject *self);

     When the iterator is exhausted, it must return ‘NULL’; a *note
     StopIteration: 47b. exception may or may not be set.  When another
     error occurs, it must return ‘NULL’ too.  Its presence signals that
     the instances of this type are iterators.

     Iterator types should also define the *note tp_iter: e23. function,
     and that function should return the iterator instance itself (not a
     new iterator instance).

     This function has the same signature as *note PyIter_Next(): 3c5b.

     `Inheritance:'

     This field is inherited by subtypes.

 -- C Member: struct PyMethodDef* PyTypeObject.tp_methods

     An optional pointer to a static ‘NULL’-terminated array of *note
     PyMethodDef: e0e. structures, declaring regular methods of this
     type.

     For each entry in the array, an entry is added to the type’s
     dictionary (see *note tp_dict: 3cba. below) containing a method
     descriptor.

     `Inheritance:'

     This field is not inherited by subtypes (methods are inherited
     through a different mechanism).

 -- C Member: struct PyMemberDef* PyTypeObject.tp_members

     An optional pointer to a static ‘NULL’-terminated array of *note
     PyMemberDef: 41b. structures, declaring regular data members
     (fields or slots) of instances of this type.

     For each entry in the array, an entry is added to the type’s
     dictionary (see *note tp_dict: 3cba. below) containing a member
     descriptor.

     `Inheritance:'

     This field is not inherited by subtypes (members are inherited
     through a different mechanism).

 -- C Member: struct PyGetSetDef* PyTypeObject.tp_getset

     An optional pointer to a static ‘NULL’-terminated array of *note
     PyGetSetDef: 41c. structures, declaring computed attributes of
     instances of this type.

     For each entry in the array, an entry is added to the type’s
     dictionary (see *note tp_dict: 3cba. below) containing a getset
     descriptor.

     `Inheritance:'

     This field is not inherited by subtypes (computed attributes are
     inherited through a different mechanism).

 -- C Member: PyTypeObject* PyTypeObject.tp_base

     An optional pointer to a base type from which type properties are
     inherited.  At this level, only single inheritance is supported;
     multiple inheritance require dynamically creating a type object by
     calling the metatype.

          Note: 
          Slot initialization is subject to the rules of initializing
          globals.  C99 requires the initializers to be “address
          constants”.  Function designators like *note
          PyType_GenericNew(): 3a81, with implicit conversion to a
          pointer, are valid C99 address constants.

          However, the unary ‘&’ operator applied to a non-static
          variable like ‘PyBaseObject_Type()’ is not required to produce
          an address constant.  Compilers may support this (gcc does),
          MSVC does not.  Both compilers are strictly standard
          conforming in this particular behavior.

          Consequently, *note tp_base: 3a94. should be set in the
          extension module’s init function.

     `Inheritance:'

     This field is not inherited by subtypes (obviously).

     `Default:'

     This field defaults to ‘&PyBaseObject_Type’ (which to Python
     programmers is known as the type *note object: 2ae.).

 -- C Member: PyObject* PyTypeObject.tp_dict

     The type’s dictionary is stored here by *note PyType_Ready(): 3a86.

     This field should normally be initialized to ‘NULL’ before
     PyType_Ready is called; it may also be initialized to a dictionary
     containing initial attributes for the type.  Once *note
     PyType_Ready(): 3a86. has initialized the type, extra attributes
     for the type may be added to this dictionary only if they don’t
     correspond to overloaded operations (like *note __add__(): 1393.).

     `Inheritance:'

     This field is not inherited by subtypes (though the attributes
     defined in here are inherited through a different mechanism).

     `Default:'

     If this field is ‘NULL’, *note PyType_Ready(): 3a86. will assign a
     new dictionary to it.

          Warning: It is not safe to use *note PyDict_SetItem(): 3a67.
          on or otherwise modify *note tp_dict: 3cba. with the
          dictionary C-API.

 -- C Member: descrgetfunc PyTypeObject.tp_descr_get

     An optional pointer to a “descriptor get” function.

     The function signature is:

          PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);

     `Inheritance:'

     This field is inherited by subtypes.

 -- C Member: descrsetfunc PyTypeObject.tp_descr_set

     An optional pointer to a function for setting and deleting a
     descriptor’s value.

     The function signature is:

          int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);

     The `value' argument is set to ‘NULL’ to delete the value.

     `Inheritance:'

     This field is inherited by subtypes.

 -- C Member: Py_ssize_t PyTypeObject.tp_dictoffset

     If the instances of this type have a dictionary containing instance
     variables, this field is non-zero and contains the offset in the
     instances of the type of the instance variable dictionary; this
     offset is used by *note PyObject_GenericGetAttr(): 3bf8.

     Do not confuse this field with *note tp_dict: 3cba.; that is the
     dictionary for attributes of the type object itself.

     If the value of this field is greater than zero, it specifies the
     offset from the start of the instance structure.  If the value is
     less than zero, it specifies the offset from the `end' of the
     instance structure.  A negative offset is more expensive to use,
     and should only be used when the instance structure contains a
     variable-length part.  This is used for example to add an instance
     variable dictionary to subtypes of *note str: 325. or *note tuple:
     473.  Note that the *note tp_basicsize: 3a7d. field should account
     for the dictionary added to the end in that case, even though the
     dictionary is not included in the basic object layout.  On a system
     with a pointer size of 4 bytes, *note tp_dictoffset: 3cbf. should
     be set to ‘-4’ to indicate that the dictionary is at the very end
     of the structure.

     The real dictionary offset in an instance can be computed from a
     negative *note tp_dictoffset: 3cbf. as follows:

          dictoffset = tp_basicsize + abs(ob_size)*tp_itemsize + tp_dictoffset if dictoffset is not aligned on sizeof(void*):     round up to sizeof(void*)

     where *note tp_basicsize: 3a7d, *note tp_itemsize: 3a7c. and *note
     tp_dictoffset: 3cbf. are taken from the type object, and ‘ob_size’
     is taken from the instance.  The absolute value is taken because
     ints use the sign of ‘ob_size’ to store the sign of the number.
     (There’s never a need to do this calculation yourself; it is done
     for you by ‘_PyObject_GetDictPtr()’.)

     `Inheritance:'

     This field is inherited by subtypes, but see the rules listed
     below.  A subtype may override this offset; this means that the
     subtype instances store the dictionary at a difference offset than
     the base type.  Since the dictionary is always found via *note
     tp_dictoffset: 3cbf, this should not be a problem.

     When a type defined by a class statement has no *note __slots__:
     e20. declaration, and none of its base types has an instance
     variable dictionary, a dictionary slot is added to the instance
     layout and the *note tp_dictoffset: 3cbf. is set to that slot’s
     offset.

     When a type defined by a class statement has a ‘__slots__’
     declaration, the type inherits its *note tp_dictoffset: 3cbf. from
     its base type.

     (Adding a slot named *note __dict__: 4f1. to the ‘__slots__’
     declaration does not have the expected effect, it just causes
     confusion.  Maybe this should be added as a feature just like
     ‘__weakref__’ though.)

     `Default:'

     This slot has no default.  For static types, if the field is ‘NULL’
     then no ‘__dict__’ gets created for instances.

 -- C Member: initproc PyTypeObject.tp_init

     An optional pointer to an instance initialization function.

     This function corresponds to the *note __init__(): d51. method of
     classes.  Like *note __init__(): d51, it is possible to create an
     instance without calling *note __init__(): d51, and it is possible
     to reinitialize an instance by calling its *note __init__(): d51.
     method again.

     The function signature is:

          int tp_init(PyObject *self, PyObject *args, PyObject *kwds);

     The self argument is the instance to be initialized; the `args' and
     `kwds' arguments represent positional and keyword arguments of the
     call to *note __init__(): d51.

     The *note tp_init: 3a87. function, if not ‘NULL’, is called when an
     instance is created normally by calling its type, after the type’s
     *note tp_new: 3a80. function has returned an instance of the type.
     If the *note tp_new: 3a80. function returns an instance of some
     other type that is not a subtype of the original type, no *note
     tp_init: 3a87. function is called; if *note tp_new: 3a80. returns
     an instance of a subtype of the original type, the subtype’s *note
     tp_init: 3a87. is called.

     Returns ‘0’ on success, ‘-1’ and sets an exception on error.

     `Inheritance:'

     This field is inherited by subtypes.

     `Default:'

     For static types this field does not have a default.

 -- C Member: allocfunc PyTypeObject.tp_alloc

     An optional pointer to an instance allocation function.

     The function signature is:

          PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);

     `Inheritance:'

     This field is inherited by static subtypes, but not by dynamic
     subtypes (subtypes created by a class statement).

     `Default:'

     For dynamic subtypes, this field is always set to *note
     PyType_GenericAlloc(): 26e, to force a standard heap allocation
     strategy.

     For static subtypes, ‘PyBaseObject_Type’ uses *note
     PyType_GenericAlloc(): 26e.  That is the recommended value for all
     statically defined types.

 -- C Member: newfunc PyTypeObject.tp_new

     An optional pointer to an instance creation function.

     The function signature is:

          PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);

     The subtype argument is the type of the object being created; the
     `args' and `kwds' arguments represent positional and keyword
     arguments of the call to the type.  Note that subtype doesn’t have
     to equal the type whose *note tp_new: 3a80. function is called; it
     may be a subtype of that type (but not an unrelated type).

     The *note tp_new: 3a80. function should call
     ‘subtype->tp_alloc(subtype, nitems)’ to allocate space for the
     object, and then do only as much further initialization as is
     absolutely necessary.  Initialization that can safely be ignored or
     repeated should be placed in the *note tp_init: 3a87. handler.  A
     good rule of thumb is that for immutable types, all initialization
     should take place in *note tp_new: 3a80, while for mutable types,
     most initialization should be deferred to *note tp_init: 3a87.

     `Inheritance:'

     This field is inherited by subtypes, except it is not inherited by
     static types whose *note tp_base: 3a94. is ‘NULL’ or
     ‘&PyBaseObject_Type’.

     `Default:'

     For static types this field has no default.  This means if the slot
     is defined as ‘NULL’, the type cannot be called to create new
     instances; presumably there is some other way to create instances,
     like a factory function.

 -- C Member: freefunc PyTypeObject.tp_free

     An optional pointer to an instance deallocation function.  Its
     signature is:

          void tp_free(void *self);

     An initializer that is compatible with this signature is *note
     PyObject_Free(): 4f9.

     `Inheritance:'

     This field is inherited by static subtypes, but not by dynamic
     subtypes (subtypes created by a class statement)

     `Default:'

     In dynamic subtypes, this field is set to a deallocator suitable to
     match *note PyType_GenericAlloc(): 26e. and the value of the *note
     Py_TPFLAGS_HAVE_GC: 3a92. flag bit.

     For static subtypes, ‘PyBaseObject_Type’ uses PyObject_Del.

 -- C Member: inquiry PyTypeObject.tp_is_gc

     An optional pointer to a function called by the garbage collector.

     The garbage collector needs to know whether a particular object is
     collectible or not.  Normally, it is sufficient to look at the
     object’s type’s *note tp_flags: 3ca6. field, and check the *note
     Py_TPFLAGS_HAVE_GC: 3a92. flag bit.  But some types have a mixture
     of statically and dynamically allocated instances, and the
     statically allocated instances are not collectible.  Such types
     should define this function; it should return ‘1’ for a collectible
     instance, and ‘0’ for a non-collectible instance.  The signature
     is:

          int tp_is_gc(PyObject *self);

     (The only example of this are types themselves.  The metatype,
     *note PyType_Type: 3ca1, defines this function to distinguish
     between statically and dynamically allocated types.)

     `Inheritance:'

     This field is inherited by subtypes.

     `Default:'

     This slot has no default.  If this field is ‘NULL’, *note
     Py_TPFLAGS_HAVE_GC: 3a92. is used as the functional equivalent.

 -- C Member: PyObject* PyTypeObject.tp_bases

     Tuple of base types.

     This is set for types created by a class statement.  It should be
     ‘NULL’ for statically defined types.

     `Inheritance:'

     This field is not inherited.

 -- C Member: PyObject* PyTypeObject.tp_mro

     Tuple containing the expanded set of base types, starting with the
     type itself and ending with *note object: 2ae, in Method Resolution
     Order.

     `Inheritance:'

     This field is not inherited; it is calculated fresh by *note
     PyType_Ready(): 3a86.

 -- C Member: PyObject* PyTypeObject.tp_cache

     Unused.  Internal use only.

     `Inheritance:'

     This field is not inherited.

 -- C Member: PyObject* PyTypeObject.tp_subclasses

     List of weak references to subclasses.  Internal use only.

     `Inheritance:'

     This field is not inherited.

 -- C Member: PyObject* PyTypeObject.tp_weaklist

     Weak reference list head, for weak references to this type object.
     Not inherited.  Internal use only.

     `Inheritance:'

     This field is not inherited.

 -- C Member: destructor PyTypeObject.tp_del

     This field is deprecated.  Use *note tp_finalize: 2d5. instead.

 -- C Member: unsigned int PyTypeObject.tp_version_tag

     Used to index into the method cache.  Internal use only.

     `Inheritance:'

     This field is not inherited.

 -- C Member: destructor PyTypeObject.tp_finalize

     An optional pointer to an instance finalization function.  Its
     signature is:

          void tp_finalize(PyObject *self);

     If *note tp_finalize: 2d5. is set, the interpreter calls it once
     when finalizing an instance.  It is called either from the garbage
     collector (if the instance is part of an isolated reference cycle)
     or just before the object is deallocated.  Either way, it is
     guaranteed to be called before attempting to break reference
     cycles, ensuring that it finds the object in a sane state.

     *note tp_finalize: 2d5. should not mutate the current exception
     status; therefore, a recommended way to write a non-trivial
     finalizer is:

          static void local_finalize(PyObject *self) {     PyObject *error_type, *error_value, *error_traceback;      /* Save the current exception, if any. */     PyErr_Fetch(&error_type, &error_value, &error_traceback);      /* ... */      /* Restore the saved exception. */     PyErr_Restore(error_type, error_value, error_traceback); }

     For this field to be taken into account (even through inheritance),
     you must also set the *note Py_TPFLAGS_HAVE_FINALIZE: 2d6. flags
     bit.

     `Inheritance:'

     This field is inherited by subtypes.

     New in version 3.4.

     See also
     ........

     “Safe object finalization” ( PEP 442(1))

The remaining fields are only defined if the feature test macro
‘COUNT_ALLOCS’ is defined, and are for internal use only.  They are
documented here for completeness.  None of these fields are inherited by
subtypes.

 -- C Member: Py_ssize_t PyTypeObject.tp_allocs

     Number of allocations.

 -- C Member: Py_ssize_t PyTypeObject.tp_frees

     Number of frees.

 -- C Member: Py_ssize_t PyTypeObject.tp_maxalloc

     Maximum simultaneously allocated objects.

 -- C Member: PyTypeObject* PyTypeObject.tp_prev

     Pointer to the previous type object with a non-zero *note
     tp_allocs: 3fc0. field.

 -- C Member: PyTypeObject* PyTypeObject.tp_next

     Pointer to the next type object with a non-zero *note tp_allocs:
     3fc0. field.

Also, note that, in a garbage collected Python, *note tp_dealloc: 3a83.
may be called from any Python thread, not just the thread which created
the object (if the object becomes part of a refcount cycle, that cycle
might be collected by a garbage collection on any thread).  This is not
a problem for Python API calls, since the thread on which tp_dealloc is
called will own the Global Interpreter Lock (GIL). However, if the
object being destroyed in turn destroys objects from some other C or C++
library, care should be taken to ensure that destroying those objects on
the thread which called tp_dealloc will not violate any assumptions of
the library.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0442


File: python.info,  Node: Heap Types,  Prev: PyTypeObject Slots,  Up: Type Objects<3>

7.12.3.9 Heap Types
...................

Traditionally, types defined in C code are `static', that is, a static
*note PyTypeObject: 2d4. structure is defined directly in code and
initialized using *note PyType_Ready(): 3a86.

This results in types that are limited relative to types defined in
Python:

   * Static types are limited to one base, i.e.  they cannot use
     multiple inheritance.

   * Static type objects (but not necessarily their instances) are
     immutable.  It is not possible to add or modify the type object’s
     attributes from Python.

   * Static type objects are shared across *note sub-interpreters: 3b85,
     so they should not include any subinterpreter-specific state.

Also, since *note PyTypeObject: 2d4. is not part of the *note stable
ABI: 3b05, any extension modules using static types must be compiled for
a specific Python minor version.

An alternative to static types is `heap-allocated types', or `heap
types' for short, which correspond closely to classes created by
Python’s ‘class’ statement.

This is done by filling a *note PyType_Spec: 3caf. structure and calling
*note PyType_FromSpecWithBases(): 3cad.


File: python.info,  Node: Number Object Structures,  Next: Mapping Object Structures,  Prev: Type Objects<3>,  Up: Object Implementation Support

7.12.4 Number Object Structures
-------------------------------

 -- C Type: PyNumberMethods

     This structure holds pointers to the functions which an object uses
     to implement the number protocol.  Each function is used by the
     function of similar name documented in the *note Number Protocol:
     3c14. section.

     Here is the structure definition:

          typedef struct {      binaryfunc nb_add;      binaryfunc nb_subtract;      binaryfunc nb_multiply;      binaryfunc nb_remainder;      binaryfunc nb_divmod;      ternaryfunc nb_power;      unaryfunc nb_negative;      unaryfunc nb_positive;      unaryfunc nb_absolute;      inquiry nb_bool;      unaryfunc nb_invert;      binaryfunc nb_lshift;      binaryfunc nb_rshift;      binaryfunc nb_and;      binaryfunc nb_xor;      binaryfunc nb_or;      unaryfunc nb_int;      void *nb_reserved;      unaryfunc nb_float;       binaryfunc nb_inplace_add;      binaryfunc nb_inplace_subtract;      binaryfunc nb_inplace_multiply;      binaryfunc nb_inplace_remainder;      ternaryfunc nb_inplace_power;      binaryfunc nb_inplace_lshift;      binaryfunc nb_inplace_rshift;      binaryfunc nb_inplace_and;      binaryfunc nb_inplace_xor;      binaryfunc nb_inplace_or;       binaryfunc nb_floor_divide;      binaryfunc nb_true_divide;      binaryfunc nb_inplace_floor_divide;      binaryfunc nb_inplace_true_divide;       unaryfunc nb_index;       binaryfunc nb_matrix_multiply;      binaryfunc nb_inplace_matrix_multiply; } PyNumberMethods;

          Note: Binary and ternary functions must check the type of all
          their operands, and implement the necessary conversions (at
          least one of the operands is an instance of the defined type).
          If the operation is not defined for the given operands, binary
          and ternary functions must return ‘Py_NotImplemented’, if
          another error occurred they must return ‘NULL’ and set an
          exception.

          Note: The ‘nb_reserved’ field should always be ‘NULL’.  It was
          previously called ‘nb_long’, and was renamed in Python 3.0.1.

 -- C Member: binaryfunc PyNumberMethods.nb_add

 -- C Member: binaryfunc PyNumberMethods.nb_subtract

 -- C Member: binaryfunc PyNumberMethods.nb_multiply

 -- C Member: binaryfunc PyNumberMethods.nb_remainder

 -- C Member: binaryfunc PyNumberMethods.nb_divmod

 -- C Member: ternaryfunc PyNumberMethods.nb_power

 -- C Member: unaryfunc PyNumberMethods.nb_negative

 -- C Member: unaryfunc PyNumberMethods.nb_positive

 -- C Member: unaryfunc PyNumberMethods.nb_absolute

 -- C Member: inquiry PyNumberMethods.nb_bool

 -- C Member: unaryfunc PyNumberMethods.nb_invert

 -- C Member: binaryfunc PyNumberMethods.nb_lshift

 -- C Member: binaryfunc PyNumberMethods.nb_rshift

 -- C Member: binaryfunc PyNumberMethods.nb_and

 -- C Member: binaryfunc PyNumberMethods.nb_xor

 -- C Member: binaryfunc PyNumberMethods.nb_or

 -- C Member: unaryfunc PyNumberMethods.nb_int

 -- C Member: void *PyNumberMethods.nb_reserved

 -- C Member: unaryfunc PyNumberMethods.nb_float

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_add

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_subtract

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_multiply

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_remainder

 -- C Member: ternaryfunc PyNumberMethods.nb_inplace_power

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_lshift

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_rshift

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_and

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_xor

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_or

 -- C Member: binaryfunc PyNumberMethods.nb_floor_divide

 -- C Member: binaryfunc PyNumberMethods.nb_true_divide

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_floor_divide

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_true_divide

 -- C Member: unaryfunc PyNumberMethods.nb_index

 -- C Member: binaryfunc PyNumberMethods.nb_matrix_multiply

 -- C Member: binaryfunc PyNumberMethods.nb_inplace_matrix_multiply


File: python.info,  Node: Mapping Object Structures,  Next: Sequence Object Structures,  Prev: Number Object Structures,  Up: Object Implementation Support

7.12.5 Mapping Object Structures
--------------------------------

 -- C Type: PyMappingMethods

     This structure holds pointers to the functions which an object uses
     to implement the mapping protocol.  It has three members:

 -- C Member: lenfunc PyMappingMethods.mp_length

     This function is used by *note PyMapping_Size(): f89. and *note
     PyObject_Size(): 3c0e, and has the same signature.  This slot may
     be set to ‘NULL’ if the object has no defined length.

 -- C Member: binaryfunc PyMappingMethods.mp_subscript

     This function is used by *note PyObject_GetItem(): 3af6. and *note
     PySequence_GetSlice(): 3c3f, and has the same signature as
     ‘PyObject_GetItem()’.  This slot must be filled for the *note
     PyMapping_Check(): 3c50. function to return ‘1’, it can be ‘NULL’
     otherwise.

 -- C Member: objobjargproc PyMappingMethods.mp_ass_subscript

     This function is used by *note PyObject_SetItem(): 3af4, *note
     PyObject_DelItem(): 3c10, ‘PyObject_SetSlice()’ and
     ‘PyObject_DelSlice()’.  It has the same signature as
     ‘PyObject_SetItem()’, but `v' can also be set to ‘NULL’ to delete
     an item.  If this slot is ‘NULL’, the object does not support item
     assignment and deletion.


File: python.info,  Node: Sequence Object Structures,  Next: Buffer Object Structures,  Prev: Mapping Object Structures,  Up: Object Implementation Support

7.12.6 Sequence Object Structures
---------------------------------

 -- C Type: PySequenceMethods

     This structure holds pointers to the functions which an object uses
     to implement the sequence protocol.

 -- C Member: lenfunc PySequenceMethods.sq_length

     This function is used by *note PySequence_Size(): f85. and *note
     PyObject_Size(): 3c0e, and has the same signature.  It is also used
     for handling negative indices via the *note sq_item: 3ff6. and the
     *note sq_ass_item: 3ff7. slots.

 -- C Member: binaryfunc PySequenceMethods.sq_concat

     This function is used by *note PySequence_Concat(): 3c3b. and has
     the same signature.  It is also used by the ‘+’ operator, after
     trying the numeric addition via the *note nb_add: 3cb8. slot.

 -- C Member: ssizeargfunc PySequenceMethods.sq_repeat

     This function is used by *note PySequence_Repeat(): 3c3c. and has
     the same signature.  It is also used by the ‘*’ operator, after
     trying numeric multiplication via the *note nb_multiply: 3fce.
     slot.

 -- C Member: ssizeargfunc PySequenceMethods.sq_item

     This function is used by *note PySequence_GetItem(): f86. and has
     the same signature.  It is also used by *note PyObject_GetItem():
     3af6, after trying the subscription via the *note mp_subscript:
     3ff0. slot.  This slot must be filled for the *note
     PySequence_Check(): 3c39. function to return ‘1’, it can be ‘NULL’
     otherwise.

     Negative indexes are handled as follows: if the ‘sq_length’ slot is
     filled, it is called and the sequence length is used to compute a
     positive index which is passed to ‘sq_item’.  If ‘sq_length’ is
     ‘NULL’, the index is passed as is to the function.

 -- C Member: ssizeobjargproc PySequenceMethods.sq_ass_item

     This function is used by *note PySequence_SetItem(): f87. and has
     the same signature.  It is also used by *note PyObject_SetItem():
     3af4. and *note PyObject_DelItem(): 3c10, after trying the item
     assignment and deletion via the *note mp_ass_subscript: 3ff1. slot.
     This slot may be left to ‘NULL’ if the object does not support item
     assignment and deletion.

 -- C Member: objobjproc PySequenceMethods.sq_contains

     This function may be used by *note PySequence_Contains(): 3c43. and
     has the same signature.  This slot may be left to ‘NULL’, in this
     case ‘PySequence_Contains()’ simply traverses the sequence until it
     finds a match.

 -- C Member: binaryfunc PySequenceMethods.sq_inplace_concat

     This function is used by *note PySequence_InPlaceConcat(): 3c3d.
     and has the same signature.  It should modify its first operand,
     and return it.  This slot may be left to ‘NULL’, in this case
     ‘PySequence_InPlaceConcat()’ will fall back to *note
     PySequence_Concat(): 3c3b.  It is also used by the augmented
     assignment ‘+=’, after trying numeric in-place addition via the
     *note nb_inplace_add: 3fcb. slot.

 -- C Member: ssizeargfunc PySequenceMethods.sq_inplace_repeat

     This function is used by *note PySequence_InPlaceRepeat(): 3c3e.
     and has the same signature.  It should modify its first operand,
     and return it.  This slot may be left to ‘NULL’, in this case
     ‘PySequence_InPlaceRepeat()’ will fall back to *note
     PySequence_Repeat(): 3c3c.  It is also used by the augmented
     assignment ‘*=’, after trying numeric in-place multiplication via
     the *note nb_inplace_multiply: 3fcf. slot.


File: python.info,  Node: Buffer Object Structures,  Next: Async Object Structures,  Prev: Sequence Object Structures,  Up: Object Implementation Support

7.12.7 Buffer Object Structures
-------------------------------

 -- C Type: PyBufferProcs

     This structure holds pointers to the functions required by the
     *note Buffer protocol: 1579.  The protocol defines how an exporter
     object can expose its internal data to consumer objects.

 -- C Member: getbufferproc PyBufferProcs.bf_getbuffer

     The signature of this function is:

          int (PyObject *exporter, Py_buffer *view, int flags);

     Handle a request to `exporter' to fill in `view' as specified by
     `flags'.  Except for point (3), an implementation of this function
     MUST take these steps:

       1. Check if the request can be met.  If not, raise
          ‘PyExc_BufferError’, set ‘view->obj’ to ‘NULL’ and return
          ‘-1’.

       2. Fill in the requested fields.

       3. Increment an internal counter for the number of exports.

       4. Set ‘view->obj’ to `exporter' and increment ‘view->obj’.

       5. Return ‘0’.

     If `exporter' is part of a chain or tree of buffer providers, two
     main schemes can be used:

        * Re-export: Each member of the tree acts as the exporting
          object and sets ‘view->obj’ to a new reference to itself.

        * Redirect: The buffer request is redirected to the root object
          of the tree.  Here, ‘view->obj’ will be a new reference to the
          root object.

     The individual fields of `view' are described in section *note
     Buffer structure: 3c5f, the rules how an exporter must react to
     specific requests are in section *note Buffer request types: 3c73.

     All memory pointed to in the *note Py_buffer: b0e. structure
     belongs to the exporter and must remain valid until there are no
     consumers left.  *note format: 3c6c, *note shape: 3c6e, *note
     strides: 3c63, *note suboffsets: 3c70. and *note internal: 3c72.
     are read-only for the consumer.

     *note PyBuffer_FillInfo(): 3c66. provides an easy way of exposing a
     simple bytes buffer while dealing correctly with all request types.

     *note PyObject_GetBuffer(): d18. is the interface for the consumer
     that wraps this function.

 -- C Member: releasebufferproc PyBufferProcs.bf_releasebuffer

     The signature of this function is:

          void (PyObject *exporter, Py_buffer *view);

     Handle a request to release the resources of the buffer.  If no
     resources need to be released, *note
     PyBufferProcs.bf_releasebuffer: 3bc0. may be ‘NULL’.  Otherwise, a
     standard implementation of this function will take these optional
     steps:

       1. Decrement an internal counter for the number of exports.

       2. If the counter is ‘0’, free all memory associated with `view'.

     The exporter MUST use the *note internal: 3c72. field to keep track
     of buffer-specific resources.  This field is guaranteed to remain
     constant, while a consumer MAY pass a copy of the original buffer
     as the `view' argument.

     This function MUST NOT decrement ‘view->obj’, since that is done
     automatically in *note PyBuffer_Release(): d47. (this scheme is
     useful for breaking reference cycles).

     *note PyBuffer_Release(): d47. is the interface for the consumer
     that wraps this function.


File: python.info,  Node: Async Object Structures,  Next: Slot Type typedefs,  Prev: Buffer Object Structures,  Up: Object Implementation Support

7.12.8 Async Object Structures
------------------------------

New in version 3.5.

 -- C Type: PyAsyncMethods

     This structure holds pointers to the functions required to
     implement *note awaitable: 50e. and *note asynchronous iterator:
     639. objects.

     Here is the structure definition:

          typedef struct {     unaryfunc am_await;     unaryfunc am_aiter;     unaryfunc am_anext; } PyAsyncMethods;

 -- C Member: unaryfunc PyAsyncMethods.am_await

     The signature of this function is:

          PyObject *am_await(PyObject *self);

     The returned object must be an iterator, i.e.  *note
     PyIter_Check(): f47. must return ‘1’ for it.

     This slot may be set to ‘NULL’ if an object is not an *note
     awaitable: 50e.

 -- C Member: unaryfunc PyAsyncMethods.am_aiter

     The signature of this function is:

          PyObject *am_aiter(PyObject *self);

     Must return an *note awaitable: 50e. object.  See *note
     __anext__(): 13d1. for details.

     This slot may be set to ‘NULL’ if an object does not implement
     asynchronous iteration protocol.

 -- C Member: unaryfunc PyAsyncMethods.am_anext

     The signature of this function is:

          PyObject *am_anext(PyObject *self);

     Must return an *note awaitable: 50e. object.  See *note
     __anext__(): 13d1. for details.  This slot may be set to ‘NULL’.


File: python.info,  Node: Slot Type typedefs,  Next: Examples<35>,  Prev: Async Object Structures,  Up: Object Implementation Support

7.12.9 Slot Type typedefs
-------------------------

 -- C Type: PyObject *(*allocfunc) (PyTypeObject *cls,
          Py_ssize_t nitems)

     The purpose of this function is to separate memory allocation from
     memory initialization.  It should return a pointer to a block of
     memory of adequate length for the instance, suitably aligned, and
     initialized to zeros, but with ‘ob_refcnt’ set to ‘1’ and ‘ob_type’
     set to the type argument.  If the type’s *note tp_itemsize: 3a7c.
     is non-zero, the object’s ‘ob_size’ field should be initialized to
     `nitems' and the length of the allocated memory block should be
     ‘tp_basicsize + nitems*tp_itemsize’, rounded up to a multiple of
     ‘sizeof(void*)’; otherwise, `nitems' is not used and the length of
     the block should be *note tp_basicsize: 3a7d.

     This function should not do any other instance initialization, not
     even to allocate additional memory; that should be done by *note
     tp_new: 3a80.

 -- C Type: void (*destructor) (PyObject *)

 -- C Type: PyObject *(*vectorcallfunc) (PyObject *callable, PyObject
          *const *args, size_t nargsf, PyObject *kwnames)

     See *note tp_vectorcall_offset: 3c06.

     Arguments to ‘vectorcallfunc’ are the same as for *note
     _PyObject_Vectorcall(): 3c05.

     New in version 3.8.

 -- C Type: void (*freefunc) (void *)

     See *note tp_free: 3a84.

 -- C Type: PyObject *(*newfunc) (PyObject *, PyObject *, PyObject *)

     See *note tp_new: 3a80.

 -- C Type: int (*initproc) (PyObject *, PyObject *, PyObject *)

     See *note tp_init: 3a87.

 -- C Type: PyObject *(*reprfunc) (PyObject *)

     See *note tp_repr: 3a9e.

 -- C Type: PyObject *(*getattrfunc) (PyObject *self, char *attr)

     Return the value of the named attribute for the object.

 -- C Type: int (*setattrfunc) (PyObject *self, char *attr,
          PyObject *value)

     Set the value of the named attribute for the object.  The value
     argument is set to ‘NULL’ to delete the attribute.

 -- C Type: PyObject *(*getattrofunc) (PyObject *self, PyObject *attr)

     Return the value of the named attribute for the object.

     See *note tp_getattro: 3aa3.

 -- C Type: int (*setattrofunc) (PyObject *self, PyObject *attr,
          PyObject *value)

     Set the value of the named attribute for the object.  The value
     argument is set to ‘NULL’ to delete the attribute.

     See *note tp_setattro: 3aa4.

 -- C Type: PyObject *(*descrgetfunc) (PyObject *, PyObject *,
          PyObject *)

     See ‘tp_descrget’.

 -- C Type: int (*descrsetfunc) (PyObject *, PyObject *, PyObject *)

     See ‘tp_descrset’.

 -- C Type: Py_hash_t (*hashfunc) (PyObject *)

     See *note tp_hash: 3ab0.

 -- C Type: PyObject *(*richcmpfunc) (PyObject *, PyObject *, int)

     See *note tp_richcompare: 3aa9.

 -- C Type: PyObject *(*getiterfunc) (PyObject *)

     See *note tp_iter: e23.

 -- C Type: PyObject *(*iternextfunc) (PyObject *)

     See *note tp_iternext: e24.

 -- C Type: Py_ssize_t (*lenfunc) (PyObject *)

 -- C Type: int (*getbufferproc) (PyObject *, Py_buffer *, int)

 -- C Type: void (*releasebufferproc) (PyObject *, Py_buffer *)

 -- C Type: PyObject *(*unaryfunc) (PyObject *)

 -- C Type: PyObject *(*binaryfunc) (PyObject *, PyObject *)

 -- C Type: PyObject *(*ternaryfunc) (PyObject *, PyObject *,
          PyObject *)

 -- C Type: PyObject *(*ssizeargfunc) (PyObject *, Py_ssize_t)

 -- C Type: int (*ssizeobjargproc) (PyObject *, Py_ssize_t)

 -- C Type: int (*objobjproc) (PyObject *, PyObject *)

 -- C Type: int (*objobjargproc) (PyObject *, PyObject *, PyObject *)


File: python.info,  Node: Examples<35>,  Next: Supporting Cyclic Garbage Collection,  Prev: Slot Type typedefs,  Up: Object Implementation Support

7.12.10 Examples
----------------

The following are simple examples of Python type definitions.  They
include common usage you may encounter.  Some demonstrate tricky corner
cases.  For more examples, practical info, and a tutorial, see *note
Defining Extension Types; Tutorial: 3a75. and *note Defining Extension
Types; Assorted Topics: 3a98.

A basic static type:

     typedef struct {     PyObject_HEAD     const char *data; } MyObject;  static PyTypeObject MyObject_Type = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "mymod.MyObject",     .tp_basicsize = sizeof(MyObject),     .tp_doc = "My objects",     .tp_new = myobj_new,     .tp_dealloc = (destructor)myobj_dealloc,     .tp_repr = (reprfunc)myobj_repr, };

You may also find older code (especially in the CPython code base) with
a more verbose initializer:

     static PyTypeObject MyObject_Type = {     PyVarObject_HEAD_INIT(NULL, 0)     "mymod.MyObject",               /* tp_name */     sizeof(MyObject),               /* tp_basicsize */     0,                              /* tp_itemsize */     (destructor)myobj_dealloc,      /* tp_dealloc */     0,                              /* tp_vectorcall_offset */     0,                              /* tp_getattr */     0,                              /* tp_setattr */     0,                              /* tp_as_async */     (reprfunc)myobj_repr,           /* tp_repr */     0,                              /* tp_as_number */     0,                              /* tp_as_sequence */     0,                              /* tp_as_mapping */     0,                              /* tp_hash */     0,                              /* tp_call */     0,                              /* tp_str */     0,                              /* tp_getattro */     0,                              /* tp_setattro */     0,                              /* tp_as_buffer */     0,                              /* tp_flags */     "My objects",                   /* tp_doc */     0,                              /* tp_traverse */     0,                              /* tp_clear */     0,                              /* tp_richcompare */     0,                              /* tp_weaklistoffset */     0,                              /* tp_iter */     0,                              /* tp_iternext */     0,                              /* tp_methods */     0,                              /* tp_members */     0,                              /* tp_getset */     0,                              /* tp_base */     0,                              /* tp_dict */     0,                              /* tp_descr_get */     0,                              /* tp_descr_set */     0,                              /* tp_dictoffset */     0,                              /* tp_init */     0,                              /* tp_alloc */     myobj_new,                      /* tp_new */ };

A type that supports weakrefs, instance dicts, and hashing:

     typedef struct {     PyObject_HEAD     const char *data;     PyObject *inst_dict;     PyObject *weakreflist; } MyObject;  static PyTypeObject MyObject_Type = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "mymod.MyObject",     .tp_basicsize = sizeof(MyObject),     .tp_doc = "My objects",     .tp_weaklistoffset = offsetof(MyObject, weakreflist),     .tp_dictoffset = offsetof(MyObject, inst_dict),     .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,     .tp_new = myobj_new,     .tp_traverse = (traverseproc)myobj_traverse,     .tp_clear = (inquiry)myobj_clear,     .tp_alloc = PyType_GenericNew,     .tp_dealloc = (destructor)myobj_dealloc,     .tp_repr = (reprfunc)myobj_repr,     .tp_hash = (hashfunc)myobj_hash,     .tp_richcompare = PyBaseObject_Type.tp_richcompare, };

A str subclass that cannot be subclassed and cannot be called to create
instances (e.g.  uses a separate factory func):

     typedef struct {     PyUnicodeObject raw;     char *extra; } MyStr;  static PyTypeObject MyStr_Type = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "mymod.MyStr",     .tp_basicsize = sizeof(MyStr),     .tp_base = NULL,  // set to &PyUnicode_Type in module init     .tp_doc = "my custom str",     .tp_flags = Py_TPFLAGS_DEFAULT,     .tp_new = NULL,     .tp_repr = (reprfunc)myobj_repr, };

The simplest static type (with fixed-length instances):

     typedef struct {     PyObject_HEAD } MyObject;  static PyTypeObject MyObject_Type = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "mymod.MyObject", };

The simplest static type (with variable-length instances):

     typedef struct {     PyObject_VAR_HEAD     const char *data[1]; } MyObject;  static PyTypeObject MyObject_Type = {     PyVarObject_HEAD_INIT(NULL, 0)     .tp_name = "mymod.MyObject",     .tp_basicsize = sizeof(MyObject) - sizeof(char *),     .tp_itemsize = sizeof(char *), };


File: python.info,  Node: Supporting Cyclic Garbage Collection,  Prev: Examples<35>,  Up: Object Implementation Support

7.12.11 Supporting Cyclic Garbage Collection
--------------------------------------------

Python’s support for detecting and collecting garbage which involves
circular references requires support from object types which are
“containers” for other objects which may also be containers.  Types
which do not store references to other objects, or which only store
references to atomic types (such as numbers or strings), do not need to
provide any explicit support for garbage collection.

To create a container type, the *note tp_flags: 3ca6. field of the type
object must include the *note Py_TPFLAGS_HAVE_GC: 3a92. and provide an
implementation of the *note tp_traverse: 35fa. handler.  If instances of
the type are mutable, a *note tp_clear: 3a9c. implementation must also
be provided.

 -- Data: Py_TPFLAGS_HAVE_GC

     Objects with a type with this flag set must conform with the rules
     documented here.  For convenience these objects will be referred to
     as container objects.

Constructors for container types must conform to two rules:

  1. The memory for the object must be allocated using *note
     PyObject_GC_New(): 2d2. or *note PyObject_GC_NewVar(): 2d3.

  2. Once all the fields which may contain references to other
     containers are initialized, it must call *note PyObject_GC_Track():
     e37.

 -- C Function: TYPE* PyObject_GC_New (TYPE, PyTypeObject *type)

     Analogous to *note PyObject_New(): 2d0. but for container objects
     with the *note Py_TPFLAGS_HAVE_GC: 3a92. flag set.

 -- C Function: TYPE* PyObject_GC_NewVar (TYPE, PyTypeObject *type,
          Py_ssize_t size)

     Analogous to *note PyObject_NewVar(): 2d1. but for container
     objects with the *note Py_TPFLAGS_HAVE_GC: 3a92. flag set.

 -- C Function: TYPE* PyObject_GC_Resize (TYPE, PyVarObject *op,
          Py_ssize_t newsize)

     Resize an object allocated by *note PyObject_NewVar(): 2d1.
     Returns the resized object or ‘NULL’ on failure.  `op' must not be
     tracked by the collector yet.

 -- C Function: void PyObject_GC_Track (PyObject *op)

     Adds the object `op' to the set of container objects tracked by the
     collector.  The collector can run at unexpected times so objects
     must be valid while being tracked.  This should be called once all
     the fields followed by the *note tp_traverse: 35fa. handler become
     valid, usually near the end of the constructor.

Similarly, the deallocator for the object must conform to a similar pair
of rules:

  1. Before fields which refer to other containers are invalidated,
     *note PyObject_GC_UnTrack(): e38. must be called.

  2. The object’s memory must be deallocated using *note
     PyObject_GC_Del(): e36.

 -- C Function: void PyObject_GC_Del (void *op)

     Releases memory allocated to an object using *note
     PyObject_GC_New(): 2d2. or *note PyObject_GC_NewVar(): 2d3.

 -- C Function: void PyObject_GC_UnTrack (void *op)

     Remove the object `op' from the set of container objects tracked by
     the collector.  Note that *note PyObject_GC_Track(): e37. can be
     called again on this object to add it back to the set of tracked
     objects.  The deallocator (*note tp_dealloc: 3a83. handler) should
     call this for the object before any of the fields used by the *note
     tp_traverse: 35fa. handler become invalid.

Changed in version 3.8: The ‘_PyObject_GC_TRACK()’ and
‘_PyObject_GC_UNTRACK()’ macros have been removed from the public C API.

The *note tp_traverse: 35fa. handler accepts a function parameter of
this type:

 -- C Type: int (*visitproc) (PyObject *object, void *arg)

     Type of the visitor function passed to the *note tp_traverse: 35fa.
     handler.  The function should be called with an object to traverse
     as `object' and the third parameter to the *note tp_traverse: 35fa.
     handler as `arg'.  The Python core uses several visitor functions
     to implement cyclic garbage detection; it’s not expected that users
     will need to write their own visitor functions.

The *note tp_traverse: 35fa. handler must have the following type:

 -- C Type: int (*traverseproc) (PyObject *self, visitproc visit,
          void *arg)

     Traversal function for a container object.  Implementations must
     call the `visit' function for each object directly contained by
     `self', with the parameters to `visit' being the contained object
     and the `arg' value passed to the handler.  The `visit' function
     must not be called with a ‘NULL’ object argument.  If `visit'
     returns a non-zero value that value should be returned immediately.

To simplify writing *note tp_traverse: 35fa. handlers, a *note
Py_VISIT(): 3a90. macro is provided.  In order to use this macro, the
*note tp_traverse: 35fa. implementation must name its arguments exactly
`visit' and `arg':

 -- C Function: void Py_VISIT (PyObject *o)

     If `o' is not ‘NULL’, call the `visit' callback, with arguments `o'
     and `arg'.  If `visit' returns a non-zero value, then return it.
     Using this macro, *note tp_traverse: 35fa. handlers look like:

          static int my_traverse(Noddy *self, visitproc visit, void *arg) {     Py_VISIT(self->foo);     Py_VISIT(self->bar);     return 0; }

The *note tp_clear: 3a9c. handler must be of the *note inquiry: 3fb0.
type, or ‘NULL’ if the object is immutable.

 -- C Type: int (*inquiry) (PyObject *self)

     Drop references that may have created reference cycles.  Immutable
     objects do not have to define this method since they can never
     directly create reference cycles.  Note that the object must still
     be valid after calling this method (don’t just call *note
     Py_DECREF(): 264. on a reference).  The collector will call this
     method if it detects that this object is involved in a reference
     cycle.


File: python.info,  Node: API and ABI Versioning,  Prev: Object Implementation Support,  Up: Python/C API Reference Manual

7.13 API and ABI Versioning
===========================

‘PY_VERSION_HEX’ is the Python version number encoded in a single
integer.

For example if the ‘PY_VERSION_HEX’ is set to ‘0x030401a2’, the
underlying version information can be found by treating it as a 32 bit
number in the following manner:

     Bytes       Bits (big endian order)       Meaning
                                               
     -----------------------------------------------------------------------------------------------
                                               
     ‘1’         ‘1-8’                         ‘PY_MAJOR_VERSION’ (the ‘3’ in ‘3.4.1a2’)
                                               
                                               
     ‘2’         ‘9-16’                        ‘PY_MINOR_VERSION’ (the ‘4’ in ‘3.4.1a2’)
                                               
                                               
     ‘3’         ‘17-24’                       ‘PY_MICRO_VERSION’ (the ‘1’ in ‘3.4.1a2’)
                                               
                                               
     ‘4’         ‘25-28’                       ‘PY_RELEASE_LEVEL’ (‘0xA’ for alpha, ‘0xB’ for
                                               beta, ‘0xC’ for release candidate and ‘0xF’ for
                                               final), in this case it is alpha.
                                               
                                               
                 ‘29-32’                       ‘PY_RELEASE_SERIAL’ (the ‘2’ in ‘3.4.1a2’, zero
                                               for final releases)
                                               

Thus ‘3.4.1a2’ is hexversion ‘0x030401a2’.

All the given macros are defined in Include/patchlevel.h(1).

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Include/patchlevel.h


File: python.info,  Node: Distributing Python Modules,  Next: Installing Python Modules,  Prev: Python/C API Reference Manual,  Up: Top

8 Distributing Python Modules
*****************************


Email: <distutils-sig@python.org>

As a popular open source development project, Python has an active
supporting community of contributors and users that also make their
software available for other Python developers to use under open source
license terms.

This allows Python users to share and collaborate effectively,
benefiting from the solutions others have already created to common (and
sometimes even rare!)  problems, as well as potentially contributing
their own solutions to the common pool.

This guide covers the distribution part of the process.  For a guide to
installing other Python projects, refer to the *note installation guide:
7e9.

     Note: For corporate and other institutional users, be aware that
     many organisations have their own policies around using and
     contributing to open source software.  Please take such policies
     into account when making use of the distribution and installation
     tools provided with Python.

* Menu:

* Key terms::
* Open source licensing and collaboration::
* Installing the tools::
* Reading the Python Packaging User Guide::
* How do I…?::


File: python.info,  Node: Key terms,  Next: Open source licensing and collaboration,  Up: Distributing Python Modules

8.1 Key terms
=============

   * the Python Packaging Index(1) is a public repository of open source
     licensed packages made available for use by other Python users

   * the Python Packaging Authority(2) are the group of developers and
     documentation authors responsible for the maintenance and evolution
     of the standard packaging tools and the associated metadata and
     file format standards.  They maintain a variety of tools,
     documentation and issue trackers on both GitHub(3) and
     Bitbucket(4).

   * *note distutils: 39. is the original build and distribution system
     first added to the Python standard library in 1998.  While direct
     use of *note distutils: 39. is being phased out, it still laid the
     foundation for the current packaging and distribution
     infrastructure, and it not only remains part of the standard
     library, but its name lives on in other ways (such as the name of
     the mailing list used to coordinate Python packaging standards
     development).

   * setuptools(5) is a (largely) drop-in replacement for *note
     distutils: 39. first published in 2004.  Its most notable addition
     over the unmodified *note distutils: 39. tools was the ability to
     declare dependencies on other packages.  It is currently
     recommended as a more regularly updated alternative to *note
     distutils: 39. that offers consistent support for more recent
     packaging standards across a wide range of Python versions.

   * wheel(6) (in this context) is a project that adds the ‘bdist_wheel’
     command to *note distutils: 39./setuptools(7).  This produces a
     cross platform binary packaging format (called “wheels” or “wheel
     files” and defined in PEP 427(8)) that allows Python libraries,
     even those including binary extensions, to be installed on a system
     without needing to be built locally.

   ---------- Footnotes ----------

   (1) https://pypi.org

   (2) https://www.pypa.io/

   (3) https://github.com/pypa

   (4) https://bitbucket.org/pypa/

   (5) https://setuptools.readthedocs.io/en/latest/

   (6) https://wheel.readthedocs.io/

   (7) https://setuptools.readthedocs.io/en/latest/

   (8) https://www.python.org/dev/peps/pep-0427


File: python.info,  Node: Open source licensing and collaboration,  Next: Installing the tools,  Prev: Key terms,  Up: Distributing Python Modules

8.2 Open source licensing and collaboration
===========================================

In most parts of the world, software is automatically covered by
copyright.  This means that other developers require explicit permission
to copy, use, modify and redistribute the software.

Open source licensing is a way of explicitly granting such permission in
a relatively consistent way, allowing developers to share and
collaborate efficiently by making common solutions to various problems
freely available.  This leaves many developers free to spend more time
focusing on the problems that are relatively unique to their specific
situation.

The distribution tools provided with Python are designed to make it
reasonably straightforward for developers to make their own
contributions back to that common pool of software if they choose to do
so.

The same distribution tools can also be used to distribute software
within an organisation, regardless of whether that software is published
as open source software or not.


File: python.info,  Node: Installing the tools,  Next: Reading the Python Packaging User Guide,  Prev: Open source licensing and collaboration,  Up: Distributing Python Modules

8.3 Installing the tools
========================

The standard library does not include build tools that support modern
Python packaging standards, as the core development team has found that
it is important to have standard tools that work consistently, even on
older versions of Python.

The currently recommended build and distribution tools can be installed
by invoking the ‘pip’ module at the command line:

     python -m pip install setuptools wheel twine

     Note: For POSIX users (including Mac OS X and Linux users), these
     instructions assume the use of a *note virtual environment: 124c.

     For Windows users, these instructions assume that the option to
     adjust the system PATH environment variable was selected when
     installing Python.

The Python Packaging User Guide includes more details on the currently
recommended tools(1).

   ---------- Footnotes ----------

   (1) 
https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations


File: python.info,  Node: Reading the Python Packaging User Guide,  Next: How do I…?,  Prev: Installing the tools,  Up: Distributing Python Modules

8.4 Reading the Python Packaging User Guide
===========================================

The Python Packaging User Guide covers the various key steps and
elements involved in creating and publishing a project:

   * Project structure(1)

   * Building and packaging the project(2)

   * Uploading the project to the Python Packaging Index(3)

   ---------- Footnotes ----------

   (1) https://packaging.python.org/tutorials/distributing-packages/

   (2) 
https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project

   (3) 
https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi


File: python.info,  Node: How do I…?,  Prev: Reading the Python Packaging User Guide,  Up: Distributing Python Modules

8.5 How do I…?
==============

These are quick answers or links for some common tasks.

* Menu:

* … choose a name for my project?::
* … create and distribute binary extensions?::


File: python.info,  Node: … choose a name for my project?,  Next: … create and distribute binary extensions?,  Up: How do I…?

8.5.1 … choose a name for my project?
-------------------------------------

This isn’t an easy topic, but here are a few tips:

   * check the Python Packaging Index to see if the name is already in
     use

   * check popular hosting sites like GitHub, Bitbucket, etc to see if
     there is already a project with that name

   * check what comes up in a web search for the name you’re considering

   * avoid particularly common words, especially ones with multiple
     meanings, as they can make it difficult for users to find your
     software when searching for it


File: python.info,  Node: … create and distribute binary extensions?,  Prev: … choose a name for my project?,  Up: How do I…?

8.5.2 … create and distribute binary extensions?
------------------------------------------------

This is actually quite a complex topic, with a variety of alternatives
available depending on exactly what you’re aiming to achieve.  See the
Python Packaging User Guide for more information and recommendations.

See also
........

Python Packaging User Guide: Binary Extensions(1)

   ---------- Footnotes ----------

   (1) https://packaging.python.org/guides/packaging-binary-extensions/


File: python.info,  Node: Installing Python Modules,  Next: Python HOWTOs,  Prev: Distributing Python Modules,  Up: Top

9 Installing Python Modules
***************************


Email: <distutils-sig@python.org>

As a popular open source development project, Python has an active
supporting community of contributors and users that also make their
software available for other Python developers to use under open source
license terms.

This allows Python users to share and collaborate effectively,
benefiting from the solutions others have already created to common (and
sometimes even rare!)  problems, as well as potentially contributing
their own solutions to the common pool.

This guide covers the installation part of the process.  For a guide to
creating and sharing your own Python projects, refer to the *note
distribution guide: 7ea.

     Note: For corporate and other institutional users, be aware that
     many organisations have their own policies around using and
     contributing to open source software.  Please take such policies
     into account when making use of the distribution and installation
     tools provided with Python.

* Menu:

* Key terms: Key terms<2>.
* Basic usage::
* How do I …?::
* Common installation issues::


File: python.info,  Node: Key terms<2>,  Next: Basic usage,  Up: Installing Python Modules

9.1 Key terms
=============

   * ‘pip’ is the preferred installer program.  Starting with Python
     3.4, it is included by default with the Python binary installers.

   * A `virtual environment' is a semi-isolated Python environment that
     allows packages to be installed for use by a particular
     application, rather than being installed system wide.

   * ‘venv’ is the standard tool for creating virtual environments, and
     has been part of Python since Python 3.3.  Starting with Python
     3.4, it defaults to installing ‘pip’ into all created virtual
     environments.

   * ‘virtualenv’ is a third party alternative (and predecessor) to
     ‘venv’.  It allows virtual environments to be used on versions of
     Python prior to 3.4, which either don’t provide ‘venv’ at all, or
     aren’t able to automatically install ‘pip’ into created
     environments.

   * The Python Packaging Index(1) is a public repository of open source
     licensed packages made available for use by other Python users.

   * the Python Packaging Authority(2) is the group of developers and
     documentation authors responsible for the maintenance and evolution
     of the standard packaging tools and the associated metadata and
     file format standards.  They maintain a variety of tools,
     documentation, and issue trackers on both GitHub(3) and
     Bitbucket(4).

   * ‘distutils’ is the original build and distribution system first
     added to the Python standard library in 1998.  While direct use of
     ‘distutils’ is being phased out, it still laid the foundation for
     the current packaging and distribution infrastructure, and it not
     only remains part of the standard library, but its name lives on in
     other ways (such as the name of the mailing list used to coordinate
     Python packaging standards development).

Changed in version 3.5: The use of ‘venv’ is now recommended for
creating virtual environments.

See also
........

Python Packaging User Guide: Creating and using virtual environments(5)

   ---------- Footnotes ----------

   (1) https://pypi.org

   (2) https://www.pypa.io/

   (3) https://github.com/pypa

   (4) https://bitbucket.org/pypa/

   (5) 
https://packaging.python.org/installing/#creating-virtual-environments


File: python.info,  Node: Basic usage,  Next: How do I …?,  Prev: Key terms<2>,  Up: Installing Python Modules

9.2 Basic usage
===============

The standard packaging tools are all designed to be used from the
command line.

The following command will install the latest version of a module and
its dependencies from the Python Packaging Index:

     python -m pip install SomePackage

     Note: For POSIX users (including Mac OS X and Linux users), the
     examples in this guide assume the use of a *note virtual
     environment: 124c.

     For Windows users, the examples in this guide assume that the
     option to adjust the system PATH environment variable was selected
     when installing Python.

It’s also possible to specify an exact or minimum version directly on
the command line.  When using comparator operators such as ‘>’, ‘<’ or
some other special character which get interpreted by shell, the package
name and the version should be enclosed within double quotes:

     python -m pip install SomePackage==1.0.4    # specific version python -m pip install "SomePackage>=1.0.4"  # minimum version

Normally, if a suitable module is already installed, attempting to
install it again will have no effect.  Upgrading existing modules must
be requested explicitly:

     python -m pip install --upgrade SomePackage

More information and resources regarding ‘pip’ and its capabilities can
be found in the Python Packaging User Guide(1).

Creation of virtual environments is done through the *note venv: 125.
module.  Installing packages into an active virtual environment uses the
commands shown above.

See also
........

Python Packaging User Guide: Installing Python Distribution Packages(2)

   ---------- Footnotes ----------

   (1) https://packaging.python.org

   (2) https://packaging.python.org/installing/


File: python.info,  Node: How do I …?,  Next: Common installation issues,  Prev: Basic usage,  Up: Installing Python Modules

9.3 How do I …?
===============

These are quick answers or links for some common tasks.

* Menu:

* … install pip in versions of Python prior to Python 3.4?: … install pip in versions of Python prior to Python 3 4?.
* … install packages just for the current user?::
* … install scientific Python packages?::
* … work with multiple versions of Python installed in parallel?::


File: python.info,  Node: … install pip in versions of Python prior to Python 3 4?,  Next: … install packages just for the current user?,  Up: How do I …?

9.3.1 … install ‘pip’ in versions of Python prior to Python 3.4?
----------------------------------------------------------------

Python only started bundling ‘pip’ with Python 3.4.  For earlier
versions, ‘pip’ needs to be “bootstrapped” as described in the Python
Packaging User Guide.

See also
........

Python Packaging User Guide: Requirements for Installing Packages(1)

   ---------- Footnotes ----------

   (1) 
https://packaging.python.org/installing/#requirements-for-installing-packages


File: python.info,  Node: … install packages just for the current user?,  Next: … install scientific Python packages?,  Prev: … install pip in versions of Python prior to Python 3 4?,  Up: How do I …?

9.3.2 … install packages just for the current user?
---------------------------------------------------

Passing the ‘--user’ option to ‘python -m pip install’ will install a
package just for the current user, rather than for all users of the
system.


File: python.info,  Node: … install scientific Python packages?,  Next: … work with multiple versions of Python installed in parallel?,  Prev: … install packages just for the current user?,  Up: How do I …?

9.3.3 … install scientific Python packages?
-------------------------------------------

A number of scientific Python packages have complex binary dependencies,
and aren’t currently easy to install using ‘pip’ directly.  At this
point in time, it will often be easier for users to install these
packages by other means(1) rather than attempting to install them with
‘pip’.

See also
........

Python Packaging User Guide: Installing Scientific Packages(2)

   ---------- Footnotes ----------

   (1) https://packaging.python.org/science/

   (2) https://packaging.python.org/science/


File: python.info,  Node: … work with multiple versions of Python installed in parallel?,  Prev: … install scientific Python packages?,  Up: How do I …?

9.3.4 … work with multiple versions of Python installed in parallel?
--------------------------------------------------------------------

On Linux, Mac OS X, and other POSIX systems, use the versioned Python
commands in combination with the ‘-m’ switch to run the appropriate copy
of ‘pip’:

     python2   -m pip install SomePackage  # default Python 2 python2.7 -m pip install SomePackage  # specifically Python 2.7 python3   -m pip install SomePackage  # default Python 3 python3.4 -m pip install SomePackage  # specifically Python 3.4

Appropriately versioned ‘pip’ commands may also be available.

On Windows, use the ‘py’ Python launcher in combination with the ‘-m’
switch:

     py -2   -m pip install SomePackage  # default Python 2 py -2.7 -m pip install SomePackage  # specifically Python 2.7 py -3   -m pip install SomePackage  # default Python 3 py -3.4 -m pip install SomePackage  # specifically Python 3.4


File: python.info,  Node: Common installation issues,  Prev: How do I …?,  Up: Installing Python Modules

9.4 Common installation issues
==============================

* Menu:

* Installing into the system Python on Linux::
* Pip not installed::
* Installing binary extensions::


File: python.info,  Node: Installing into the system Python on Linux,  Next: Pip not installed,  Up: Common installation issues

9.4.1 Installing into the system Python on Linux
------------------------------------------------

On Linux systems, a Python installation will typically be included as
part of the distribution.  Installing into this Python installation
requires root access to the system, and may interfere with the operation
of the system package manager and other components of the system if a
component is unexpectedly upgraded using ‘pip’.

On such systems, it is often better to use a virtual environment or a
per-user installation when installing packages with ‘pip’.


File: python.info,  Node: Pip not installed,  Next: Installing binary extensions,  Prev: Installing into the system Python on Linux,  Up: Common installation issues

9.4.2 Pip not installed
-----------------------

It is possible that ‘pip’ does not get installed by default.  One
potential fix is:

     python -m ensurepip --default-pip

There are also additional resources for installing pip.(1)

   ---------- Footnotes ----------

   (1) 
https://packaging.python.org/tutorials/installing-packages/#install-pip-setuptools-and-wheel


File: python.info,  Node: Installing binary extensions,  Prev: Pip not installed,  Up: Common installation issues

9.4.3 Installing binary extensions
----------------------------------

Python has typically relied heavily on source based distribution, with
end users being expected to compile extension modules from source as
part of the installation process.

With the introduction of support for the binary ‘wheel’ format, and the
ability to publish wheels for at least Windows and Mac OS X through the
Python Packaging Index, this problem is expected to diminish over time,
as users are more regularly able to install pre-built extensions rather
than needing to build them themselves.

Some of the solutions for installing scientific software(1) that are not
yet available as pre-built ‘wheel’ files may also help with obtaining
other binary extensions without needing to build them locally.

See also
........

Python Packaging User Guide: Binary Extensions(2)

   ---------- Footnotes ----------

   (1) https://packaging.python.org/science/

   (2) https://packaging.python.org/extensions/


File: python.info,  Node: Python HOWTOs,  Next: Python Frequently Asked Questions,  Prev: Installing Python Modules,  Up: Top

10 Python HOWTOs
****************

Python HOWTOs are documents that cover a single, specific topic, and
attempt to cover it fairly completely.  Modelled on the Linux
Documentation Project’s HOWTO collection, this collection is an effort
to foster documentation that’s more detailed than the Python Library
Reference.

Currently, the HOWTOs are:

* Menu:

* Porting Python 2 Code to Python 3::
* Porting Extension Modules to Python 3::
* Curses Programming with Python::
* Descriptor HowTo Guide::
* Functional Programming HOWTO::
* Logging HOWTO::
* Logging Cookbook::
* Regular Expression HOWTO::
* Socket Programming HOWTO::
* Sorting HOW TO::
* Unicode HOWTO::
* HOWTO Fetch Internet Resources Using The urllib Package::
* Argparse Tutorial::
* An introduction to the ipaddress module::
* Argument Clinic How-To::
* Instrumenting CPython with DTrace and SystemTap::


File: python.info,  Node: Porting Python 2 Code to Python 3,  Next: Porting Extension Modules to Python 3,  Up: Python HOWTOs

10.1 Porting Python 2 Code to Python 3
======================================


author: Brett Cannon

Abstract
........

With Python 3 being the future of Python while Python 2 is still in
active use, it is good to have your project available for both major
releases of Python.  This guide is meant to help you figure out how best
to support both Python 2 & 3 simultaneously.

If you are looking to port an extension module instead of pure Python
code, please see *note Porting Extension Modules to Python 3: c6a.

If you would like to read one core Python developer’s take on why Python
3 came into existence, you can read Nick Coghlan’s Python 3 Q & A(1) or
Brett Cannon’s Why Python 3 exists(2).

For help with porting, you can email the python-porting(3) mailing list
with questions.

* Menu:

* The Short Explanation::
* Details::

   ---------- Footnotes ----------

   (1) 
https://ncoghlan-devs-python-notes.readthedocs.io/en/latest/python3/questions_and_answers.html

   (2) https://snarky.ca/why-python-3-exists

   (3) https://mail.python.org/mailman/listinfo/python-porting


File: python.info,  Node: The Short Explanation,  Next: Details,  Up: Porting Python 2 Code to Python 3

10.1.1 The Short Explanation
----------------------------

To make your project be single-source Python 2/3 compatible, the basic
steps are:

  1. Only worry about supporting Python 2.7

  2. Make sure you have good test coverage (coverage.py(1) can help;
     ‘pip install coverage’)

  3. Learn the differences between Python 2 & 3

  4. Use Futurize(2) (or Modernize(3)) to update your code (e.g.  ‘pip
     install future’)

  5. Use Pylint(4) to help make sure you don’t regress on your Python 3
     support (‘pip install pylint’)

  6. Use caniusepython3(5) to find out which of your dependencies are
     blocking your use of Python 3 (‘pip install caniusepython3’)

  7. Once your dependencies are no longer blocking you, use continuous
     integration to make sure you stay compatible with Python 2 & 3
     (tox(6) can help test against multiple versions of Python; ‘pip
     install tox’)

  8. Consider using optional static type checking to make sure your type
     usage works in both Python 2 & 3 (e.g.  use mypy(7) to check your
     typing under both Python 2 & Python 3).

   ---------- Footnotes ----------

   (1) https://pypi.org/project/coverage

   (2) http://python-future.org/automatic_conversion.html

   (3) https://python-modernize.readthedocs.io/

   (4) https://pypi.org/project/pylint

   (5) https://pypi.org/project/caniusepython3

   (6) https://pypi.org/project/tox

   (7) http://mypy-lang.org/


File: python.info,  Node: Details,  Prev: The Short Explanation,  Up: Porting Python 2 Code to Python 3

10.1.2 Details
--------------

A key point about supporting Python 2 & 3 simultaneously is that you can
start `today'!  Even if your dependencies are not supporting Python 3
yet that does not mean you can’t modernize your code `now' to support
Python 3.  Most changes required to support Python 3 lead to cleaner
code using newer practices even in Python 2 code.

Another key point is that modernizing your Python 2 code to also support
Python 3 is largely automated for you.  While you might have to make
some API decisions thanks to Python 3 clarifying text data versus binary
data, the lower-level work is now mostly done for you and thus can at
least benefit from the automated changes immediately.

Keep those key points in mind while you read on about the details of
porting your code to support Python 2 & 3 simultaneously.

* Menu:

* Drop support for Python 2.6 and older: Drop support for Python 2 6 and older.
* Make sure you specify the proper version support in your setup.py file: Make sure you specify the proper version support in your setup py file.
* 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.py file to denote Python 3 compatibility: Update your setup py file to denote Python 3 compatibility.
* Use continuous integration to stay compatible::
* Consider using optional static type checking::


File: python.info,  Node: Drop support for Python 2 6 and older,  Next: Make sure you specify the proper version support in your setup py file,  Up: Details

10.1.2.1 Drop support for Python 2.6 and older
..............................................

While you can make Python 2.5 work with Python 3, it is `much' easier if
you only have to work with Python 2.7.  If dropping Python 2.5 is not an
option then the six(1) project can help you support Python 2.5 & 3
simultaneously (‘pip install six’).  Do realize, though, that nearly all
the projects listed in this HOWTO will not be available to you.

If you are able to skip Python 2.5 and older, then the required changes
to your code should continue to look and feel like idiomatic Python
code.  At worst you will have to use a function instead of a method in
some instances or have to import a function instead of using a built-in
one, but otherwise the overall transformation should not feel foreign to
you.

But you should aim for only supporting Python 2.7.  Python 2.6 is no
longer freely supported and thus is not receiving bugfixes.  This means
`you' will have to work around any issues you come across with Python
2.6.  There are also some tools mentioned in this HOWTO which do not
support Python 2.6 (e.g., Pylint(2)), and this will become more
commonplace as time goes on.  It will simply be easier for you if you
only support the versions of Python that you have to support.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/six

   (2) https://pypi.org/project/pylint


File: python.info,  Node: Make sure you specify the proper version support in your setup py file,  Next: Have good test coverage,  Prev: Drop support for Python 2 6 and older,  Up: Details

10.1.2.2 Make sure you specify the proper version support in your ‘setup.py’ file
.................................................................................

In your ‘setup.py’ file you should have the proper trove classifier(1)
specifying what versions of Python you support.  As your project does
not support Python 3 yet you should at least have ‘Programming Language
:: Python :: 2 :: Only’ specified.  Ideally you should also specify each
major/minor version of Python that you do support, e.g.  ‘Programming
Language :: Python :: 2.7’.

   ---------- Footnotes ----------

   (1) https://pypi.org/classifiers


File: python.info,  Node: Have good test coverage,  Next: Learn the differences between Python 2 & 3,  Prev: Make sure you specify the proper version support in your setup py file,  Up: Details

10.1.2.3 Have good test coverage
................................

Once you have your code supporting the oldest version of Python 2 you
want it to, you will want to make sure your test suite has good
coverage.  A good rule of thumb is that if you want to be confident
enough in your test suite that any failures that appear after having
tools rewrite your code are actual bugs in the tools and not in your
code.  If you want a number to aim for, try to get over 80% coverage
(and don’t feel bad if you find it hard to get better than 90%
coverage).  If you don’t already have a tool to measure test coverage
then coverage.py(1) is recommended.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/coverage


File: python.info,  Node: Learn the differences between Python 2 & 3,  Next: Update your code,  Prev: Have good test coverage,  Up: Details

10.1.2.4 Learn the differences between Python 2 & 3
...................................................

Once you have your code well-tested you are ready to begin porting your
code to Python 3!  But to fully understand how your code is going to
change and what you want to look out for while you code, you will want
to learn what changes Python 3 makes in terms of Python 2.  Typically
the two best ways of doing that is reading the "What’s New"(1) doc for
each release of Python 3 and the Porting to Python 3(2) book (which is
free online).  There is also a handy cheat sheet(3) from the
Python-Future project.

   ---------- Footnotes ----------

   (1) https://docs.python.org/3/whatsnew/index.html

   (2) http://python3porting.com/

   (3) http://python-future.org/compatible_idioms.html


File: python.info,  Node: Update your code,  Next: Prevent compatibility regressions,  Prev: Learn the differences between Python 2 & 3,  Up: Details

10.1.2.5 Update your code
.........................

Once you feel like you know what is different in Python 3 compared to
Python 2, it’s time to update your code!  You have a choice between two
tools in porting your code automatically: Futurize(1) and Modernize(2).
Which tool you choose will depend on how much like Python 3 you want
your code to be.  Futurize(3) does its best to make Python 3 idioms and
practices exist in Python 2, e.g.  backporting the ‘bytes’ type from
Python 3 so that you have semantic parity between the major versions of
Python.  Modernize(4), on the other hand, is more conservative and
targets a Python 2/3 subset of Python, directly relying on six(5) to
help provide compatibility.  As Python 3 is the future, it might be best
to consider Futurize to begin adjusting to any new practices that Python
3 introduces which you are not accustomed to yet.

Regardless of which tool you choose, they will update your code to run
under Python 3 while staying compatible with the version of Python 2 you
started with.  Depending on how conservative you want to be, you may
want to run the tool over your test suite first and visually inspect the
diff to make sure the transformation is accurate.  After you have
transformed your test suite and verified that all the tests still pass
as expected, then you can transform your application code knowing that
any tests which fail is a translation failure.

Unfortunately the tools can’t automate everything to make your code work
under Python 3 and so there are a handful of things you will need to
update manually to get full Python 3 support (which of these steps are
necessary vary between the tools).  Read the documentation for the tool
you choose to use to see what it fixes by default and what it can do
optionally to know what will (not) be fixed for you and what you may
have to fix on your own (e.g.  using ‘io.open()’ over the built-in
‘open()’ function is off by default in Modernize).  Luckily, though,
there are only a couple of things to watch out for which can be
considered large issues that may be hard to debug if not watched for.

* Menu:

* Division::
* Text versus binary data::
* Use feature detection instead of version detection::

   ---------- Footnotes ----------

   (1) http://python-future.org/automatic_conversion.html

   (2) https://python-modernize.readthedocs.io/

   (3) http://python-future.org/automatic_conversion.html

   (4) https://python-modernize.readthedocs.io/

   (5) https://pypi.org/project/six


File: python.info,  Node: Division,  Next: Text versus binary data,  Up: Update your code

10.1.2.6 Division
.................

In Python 3, ‘5 / 2 == 2.5’ and not ‘2’; all division between ‘int’
values result in a ‘float’.  This change has actually been planned since
Python 2.2 which was released in 2002.  Since then users have been
encouraged to add ‘from __future__ import division’ to any and all files
which use the ‘/’ and ‘//’ operators or to be running the interpreter
with the ‘-Q’ flag.  If you have not been doing this then you will need
to go through your code and do two things:

  1. Add ‘from __future__ import division’ to your files

  2. Update any division operator as necessary to either use ‘//’ to use
     floor division or continue using ‘/’ and expect a float

The reason that ‘/’ isn’t simply translated to ‘//’ automatically is
that if an object defines a ‘__truediv__’ method but not ‘__floordiv__’
then your code would begin to fail (e.g.  a user-defined class that uses
‘/’ to signify some operation but not ‘//’ for the same thing or at
all).


File: python.info,  Node: Text versus binary data,  Next: Use feature detection instead of version detection,  Prev: Division,  Up: Update your code

10.1.2.7 Text versus binary data
................................

In Python 2 you could use the ‘str’ type for both text and binary data.
Unfortunately this confluence of two different concepts could lead to
brittle code which sometimes worked for either kind of data, sometimes
not.  It also could lead to confusing APIs if people didn’t explicitly
state that something that accepted ‘str’ accepted either text or binary
data instead of one specific type.  This complicated the situation
especially for anyone supporting multiple languages as APIs wouldn’t
bother explicitly supporting ‘unicode’ when they claimed text data
support.

To make the distinction between text and binary data clearer and more
pronounced, Python 3 did what most languages created in the age of the
internet have done and made text and binary data distinct types that
cannot blindly be mixed together (Python predates widespread access to
the internet).  For any code that deals only with text or only binary
data, this separation doesn’t pose an issue.  But for code that has to
deal with both, it does mean you might have to now care about when you
are using text compared to binary data, which is why this cannot be
entirely automated.

To start, you will need to decide which APIs take text and which take
binary (it is `highly' recommended you don’t design APIs that can take
both due to the difficulty of keeping the code working; as stated
earlier it is difficult to do well).  In Python 2 this means making sure
the APIs that take text can work with ‘unicode’ and those that work with
binary data work with the ‘bytes’ type from Python 3 (which is a subset
of ‘str’ in Python 2 and acts as an alias for ‘bytes’ type in Python 2).
Usually the biggest issue is realizing which methods exist on which
types in Python 2 & 3 simultaneously (for text that’s ‘unicode’ in
Python 2 and ‘str’ in Python 3, for binary that’s ‘str’/‘bytes’ in
Python 2 and ‘bytes’ in Python 3).  The following table lists the
`unique' methods of each data type across Python 2 & 3 (e.g., the
‘decode()’ method is usable on the equivalent binary data type in either
Python 2 or 3, but it can’t be used by the textual data type
consistently between Python 2 and 3 because ‘str’ in Python 3 doesn’t
have the method).  Do note that as of Python 3.5 the ‘__mod__’ method
was added to the bytes type.

`Text data'                  `Binary data'
                             
                             
                             decode
                             
                             
encode

format

isdecimal

isnumeric

Making the distinction easier to handle can be accomplished by encoding
and decoding between binary data and text at the edge of your code.
This means that when you receive text in binary data, you should
immediately decode it.  And if your code needs to send text as binary
data then encode it as late as possible.  This allows your code to work
with only text internally and thus eliminates having to keep track of
what type of data you are working with.

The next issue is making sure you know whether the string literals in
your code represent text or binary data.  You should add a ‘b’ prefix to
any literal that presents binary data.  For text you should add a ‘u’
prefix to the text literal.  (there is a *note __future__: 0. import to
force all unspecified literals to be Unicode, but usage has shown it
isn’t as effective as adding a ‘b’ or ‘u’ prefix to all literals
explicitly)

As part of this dichotomy you also need to be careful about opening
files.  Unless you have been working on Windows, there is a chance you
have not always bothered to add the ‘b’ mode when opening a binary file
(e.g., ‘rb’ for binary reading).  Under Python 3, binary files and text
files are clearly distinct and mutually incompatible; see the *note io:
a1. module for details.  Therefore, you `must' make a decision of
whether a file will be used for binary access (allowing binary data to
be read and/or written) or textual access (allowing text data to be read
and/or written).  You should also use *note io.open(): 64e. for opening
files instead of the built-in *note open(): 4e5. function as the *note
io: a1. module is consistent from Python 2 to 3 while the built-in *note
open(): 4e5. function is not (in Python 3 it’s actually *note io.open():
64e.).  Do not bother with the outdated practice of using *note
codecs.open(): 129d. as that’s only necessary for keeping compatibility
with Python 2.5.

The constructors of both ‘str’ and ‘bytes’ have different semantics for
the same arguments between Python 2 & 3.  Passing an integer to ‘bytes’
in Python 2 will give you the string representation of the integer:
‘bytes(3) == '3'’.  But in Python 3, an integer argument to ‘bytes’ will
give you a bytes object as long as the integer specified, filled with
null bytes: ‘bytes(3) == b'\x00\x00\x00'’.  A similar worry is necessary
when passing a bytes object to ‘str’.  In Python 2 you just get the
bytes object back: ‘str(b'3') == b'3'’.  But in Python 3 you get the
string representation of the bytes object: ‘str(b'3') == "b'3'"’.

Finally, the indexing of binary data requires careful handling (slicing
does `not' require any special handling).  In Python 2, ‘b'123'[1] ==
b'2'’ while in Python 3 ‘b'123'[1] == 50’.  Because binary data is
simply a collection of binary numbers, Python 3 returns the integer
value for the byte you index on.  But in Python 2 because ‘bytes ==
str’, indexing returns a one-item slice of bytes.  The six(1) project
has a function named ‘six.indexbytes()’ which will return an integer
like in Python 3: ‘six.indexbytes(b'123', 1)’.

To summarize:

  1. Decide which of your APIs take text and which take binary data

  2. Make sure that your code that works with text also works with
     ‘unicode’ and code for binary data works with ‘bytes’ in Python 2
     (see the table above for what methods you cannot use for each type)

  3. Mark all binary literals with a ‘b’ prefix, textual literals with a
     ‘u’ prefix

  4. Decode binary data to text as soon as possible, encode text as
     binary data as late as possible

  5. Open files using *note io.open(): 64e. and make sure to specify the
     ‘b’ mode when appropriate

  6. Be careful when indexing into binary data

   ---------- Footnotes ----------

   (1) https://pypi.org/project/six


File: python.info,  Node: Use feature detection instead of version detection,  Prev: Text versus binary data,  Up: Update your code

10.1.2.8 Use feature detection instead of version detection
...........................................................

Inevitably you will have code that has to choose what to do based on
what version of Python is running.  The best way to do this is with
feature detection of whether the version of Python you’re running under
supports what you need.  If for some reason that doesn’t work then you
should make the version check be against Python 2 and not Python 3.  To
help explain this, let’s look at an example.

Let’s pretend that you need access to a feature of importlib(1) that is
available in Python’s standard library since Python 3.3 and available
for Python 2 through importlib2(2) on PyPI. You might be tempted to
write code to access e.g.  the ‘importlib.abc’ module by doing the
following:

     import sys  if sys.version_info[0] == 3:     from importlib import abc else:     from importlib2 import abc

The problem with this code is what happens when Python 4 comes out?  It
would be better to treat Python 2 as the exceptional case instead of
Python 3 and assume that future Python versions will be more compatible
with Python 3 than Python 2:

     import sys  if sys.version_info[0] > 2:     from importlib import abc else:     from importlib2 import abc

The best solution, though, is to do no version detection at all and
instead rely on feature detection.  That avoids any potential issues of
getting the version detection wrong and helps keep you
future-compatible:

     try:     from importlib import abc except ImportError:     from importlib2 import abc

   ---------- Footnotes ----------

   (1) https://docs.python.org/3/library/importlib.html#module-importlib

   (2) https://pypi.org/project/importlib2


File: python.info,  Node: Prevent compatibility regressions,  Next: Check which dependencies block your transition,  Prev: Update your code,  Up: Details

10.1.2.9 Prevent compatibility regressions
..........................................

Once you have fully translated your code to be compatible with Python 3,
you will want to make sure your code doesn’t regress and stop working
under Python 3.  This is especially true if you have a dependency which
is blocking you from actually running under Python 3 at the moment.

To help with staying compatible, any new modules you create should have
at least the following block of code at the top of it:

     from __future__ import absolute_import from __future__ import division from __future__ import print_function

You can also run Python 2 with the ‘-3’ flag to be warned about various
compatibility issues your code triggers during execution.  If you turn
warnings into errors with ‘-Werror’ then you can make sure that you
don’t accidentally miss a warning.

You can also use the Pylint(1) project and its ‘--py3k’ flag to lint
your code to receive warnings when your code begins to deviate from
Python 3 compatibility.  This also prevents you from having to run
Modernize(2) or Futurize(3) over your code regularly to catch
compatibility regressions.  This does require you only support Python
2.7 and Python 3.4 or newer as that is Pylint’s minimum Python version
support.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/pylint

   (2) https://python-modernize.readthedocs.io/

   (3) http://python-future.org/automatic_conversion.html


File: python.info,  Node: Check which dependencies block your transition,  Next: Update your setup py file to denote Python 3 compatibility,  Prev: Prevent compatibility regressions,  Up: Details

10.1.2.10 Check which dependencies block your transition
........................................................

`After' you have made your code compatible with Python 3 you should
begin to care about whether your dependencies have also been ported.
The caniusepython3(1) project was created to help you determine which
projects – directly or indirectly – are blocking you from supporting
Python 3.  There is both a command-line tool as well as a web interface
at ‘https://caniusepython3.com’.

The project also provides code which you can integrate into your test
suite so that you will have a failing test when you no longer have
dependencies blocking you from using Python 3.  This allows you to avoid
having to manually check your dependencies and to be notified quickly
when you can start running on Python 3.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/caniusepython3


File: python.info,  Node: Update your setup py file to denote Python 3 compatibility,  Next: Use continuous integration to stay compatible,  Prev: Check which dependencies block your transition,  Up: Details

10.1.2.11 Update your ‘setup.py’ file to denote Python 3 compatibility
......................................................................

Once your code works under Python 3, you should update the classifiers
in your ‘setup.py’ to contain ‘Programming Language :: Python :: 3’ and
to not specify sole Python 2 support.  This will tell anyone using your
code that you support Python 2 `and' 3.  Ideally you will also want to
add classifiers for each major/minor version of Python you now support.


File: python.info,  Node: Use continuous integration to stay compatible,  Next: Consider using optional static type checking,  Prev: Update your setup py file to denote Python 3 compatibility,  Up: Details

10.1.2.12 Use continuous integration to stay compatible
.......................................................

Once you are able to fully run under Python 3 you will want to make sure
your code always works under both Python 2 & 3.  Probably the best tool
for running your tests under multiple Python interpreters is tox(1).
You can then integrate tox with your continuous integration system so
that you never accidentally break Python 2 or 3 support.

You may also want to use the ‘-bb’ flag with the Python 3 interpreter to
trigger an exception when you are comparing bytes to strings or bytes to
an int (the latter is available starting in Python 3.5).  By default
type-differing comparisons simply return ‘False’, but if you made a
mistake in your separation of text/binary data handling or indexing on
bytes you wouldn’t easily find the mistake.  This flag will raise an
exception when these kinds of comparisons occur, making the mistake much
easier to track down.

And that’s mostly it!  At this point your code base is compatible with
both Python 2 and 3 simultaneously.  Your testing will also be set up so
that you don’t accidentally break Python 2 or 3 compatibility regardless
of which version you typically run your tests under while developing.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/tox


File: python.info,  Node: Consider using optional static type checking,  Prev: Use continuous integration to stay compatible,  Up: Details

10.1.2.13 Consider using optional static type checking
......................................................

Another way to help port your code is to use a static type checker like
mypy(1) or pytype(2) on your code.  These tools can be used to analyze
your code as if it’s being run under Python 2, then you can run the tool
a second time as if your code is running under Python 3.  By running a
static type checker twice like this you can discover if you’re e.g.
misusing binary data type in one version of Python compared to another.
If you add optional type hints to your code you can also explicitly
state whether your APIs use textual or binary data, helping to make sure
everything functions as expected in both versions of Python.

   ---------- Footnotes ----------

   (1) http://mypy-lang.org/

   (2) https://github.com/google/pytype


File: python.info,  Node: Porting Extension Modules to Python 3,  Next: Curses Programming with Python,  Prev: Porting Python 2 Code to Python 3,  Up: Python HOWTOs

10.2 Porting Extension Modules to Python 3
==========================================

We recommend the following resources for porting extension modules to
Python 3:

   * The Migrating C extensions(1) chapter from `Supporting Python 3: An
     in-depth guide', a book on moving from Python 2 to Python 3 in
     general, guides the reader through porting an extension module.

   * The Porting guide(2) from the `py3c' project provides opinionated
     suggestions with supporting code.

   * The Cython(3) and CFFI(4) libraries offer abstractions over
     Python’s C API. Extensions generally need to be re-written to use
     one of them, but the library then handles differences between
     various Python versions and implementations.

   ---------- Footnotes ----------

   (1) http://python3porting.com/cextensions.html

   (2) https://py3c.readthedocs.io/en/latest/guide.html

   (3) http://cython.org/

   (4) https://cffi.readthedocs.io/en/latest/


File: python.info,  Node: Curses Programming with Python,  Next: Descriptor HowTo Guide,  Prev: Porting Extension Modules to Python 3,  Up: Python HOWTOs

10.3 Curses Programming with Python
===================================


Author: A.M. Kuchling, Eric S. Raymond


Release: 2.04

Abstract
........

This document describes how to use the *note curses: 2c. extension
module to control text-mode displays.

* Menu:

* What is curses?::
* Starting and ending a curses application::
* Windows and Pads::
* Displaying Text::
* User Input::
* For More Information::


File: python.info,  Node: What is curses?,  Next: Starting and ending a curses application,  Up: Curses Programming with Python

10.3.1 What is curses?
----------------------

The curses library supplies a terminal-independent screen-painting and
keyboard-handling facility for text-based terminals; such terminals
include VT100s, the Linux console, and the simulated terminal provided
by various programs.  Display terminals support various control codes to
perform common operations such as moving the cursor, scrolling the
screen, and erasing areas.  Different terminals use widely differing
codes, and often have their own minor quirks.

In a world of graphical displays, one might ask “why bother”?  It’s true
that character-cell display terminals are an obsolete technology, but
there are niches in which being able to do fancy things with them are
still valuable.  One niche is on small-footprint or embedded Unixes that
don’t run an X server.  Another is tools such as OS installers and
kernel configurators that may have to run before any graphical support
is available.

The curses library provides fairly basic functionality, providing the
programmer with an abstraction of a display containing multiple
non-overlapping windows of text.  The contents of a window can be
changed in various ways—adding text, erasing it, changing its
appearance—and the curses library will figure out what control codes
need to be sent to the terminal to produce the right output.  curses
doesn’t provide many user-interface concepts such as buttons,
checkboxes, or dialogs; if you need such features, consider a user
interface library such as Urwid(1).

The curses library was originally written for BSD Unix; the later System
V versions of Unix from AT&T added many enhancements and new functions.
BSD curses is no longer maintained, having been replaced by ncurses,
which is an open-source implementation of the AT&T interface.  If you’re
using an open-source Unix such as Linux or FreeBSD, your system almost
certainly uses ncurses.  Since most current commercial Unix versions are
based on System V code, all the functions described here will probably
be available.  The older versions of curses carried by some proprietary
Unixes may not support everything, though.

The Windows version of Python doesn’t include the *note curses: 2c.
module.  A ported version called UniCurses(2) is available.  You could
also try the Console module(3) written by Fredrik Lundh, which doesn’t
use the same API as curses but provides cursor-addressable text output
and full support for mouse and keyboard input.

* Menu:

* The Python curses module::

   ---------- Footnotes ----------

   (1) https://pypi.org/project/urwid/

   (2) https://pypi.org/project/UniCurses

   (3) http://effbot.org/zone/console-index.htm


File: python.info,  Node: The Python curses module,  Up: What is curses?

10.3.1.1 The Python curses module
.................................

The Python module is a fairly simple wrapper over the C functions
provided by curses; if you’re already familiar with curses programming
in C, it’s really easy to transfer that knowledge to Python.  The
biggest difference is that the Python interface makes things simpler by
merging different C functions such as ‘addstr()’, ‘mvaddstr()’, and
‘mvwaddstr()’ into a single *note addstr(): 20a4. method.  You’ll see
this covered in more detail later.

This HOWTO is an introduction to writing text-mode programs with curses
and Python.  It doesn’t attempt to be a complete guide to the curses
API; for that, see the Python library guide’s section on ncurses, and
the C manual pages for ncurses.  It will, however, give you the basic
ideas.


File: python.info,  Node: Starting and ending a curses application,  Next: Windows and Pads,  Prev: What is curses?,  Up: Curses Programming with Python

10.3.2 Starting and ending a curses application
-----------------------------------------------

Before doing anything, curses must be initialized.  This is done by
calling the *note initscr(): 20aa. function, which will determine the
terminal type, send any required setup codes to the terminal, and create
various internal data structures.  If successful, ‘initscr()’ returns a
window object representing the entire screen; this is usually called
‘stdscr’ after the name of the corresponding C variable.

     import curses stdscr = curses.initscr()

Usually curses applications turn off automatic echoing of keys to the
screen, in order to be able to read keys and only display them under
certain circumstances.  This requires calling the *note noecho(): 20c8.
function.

     curses.noecho()

Applications will also commonly need to react to keys instantly, without
requiring the Enter key to be pressed; this is called cbreak mode, as
opposed to the usual buffered input mode.

     curses.cbreak()

Terminals usually return special keys, such as the cursor keys or
navigation keys such as Page Up and Home, as a multibyte escape
sequence.  While you could write your application to expect such
sequences and process them accordingly, curses can do it for you,
returning a special value such as ‘curses.KEY_LEFT’.  To get curses to
do the job, you’ll have to enable keypad mode.

     stdscr.keypad(True)

Terminating a curses application is much easier than starting one.
You’ll need to call:

     curses.nocbreak() stdscr.keypad(False) curses.echo()

to reverse the curses-friendly terminal settings.  Then call the *note
endwin(): 20a7. function to restore the terminal to its original
operating mode.

     curses.endwin()

A common problem when debugging a curses application is to get your
terminal messed up when the application dies without restoring the
terminal to its previous state.  In Python this commonly happens when
your code is buggy and raises an uncaught exception.  Keys are no longer
echoed to the screen when you type them, for example, which makes using
the shell difficult.

In Python you can avoid these complications and make debugging much
easier by importing the *note curses.wrapper(): 29f. function and using
it like this:

     from curses import wrapper  def main(stdscr):     # Clear screen     stdscr.clear()      # This raises ZeroDivisionError when i == 10.     for i in range(0, 11):         v = i-10         stdscr.addstr(i, 0, '10 divided by {} is {}'.format(v, 10/v))      stdscr.refresh()     stdscr.getkey()  wrapper(main)

The *note wrapper(): 29f. function takes a callable object and does the
initializations described above, also initializing colors if color
support is present.  ‘wrapper()’ then runs your provided callable.  Once
the callable returns, ‘wrapper()’ will restore the original state of the
terminal.  The callable is called inside a *note try: d65.…*note except:
b31. that catches exceptions, restores the state of the terminal, and
then re-raises the exception.  Therefore your terminal won’t be left in
a funny state on exception and you’ll be able to read the exception’s
message and traceback.


File: python.info,  Node: Windows and Pads,  Next: Displaying Text,  Prev: Starting and ending a curses application,  Up: Curses Programming with Python

10.3.3 Windows and Pads
-----------------------

Windows are the basic abstraction in curses.  A window object represents
a rectangular area of the screen, and supports methods to display text,
erase it, allow the user to input strings, and so forth.

The ‘stdscr’ object returned by the *note initscr(): 20aa. function is a
window object that covers the entire screen.  Many programs may need
only this single window, but you might wish to divide the screen into
smaller windows, in order to redraw or clear them separately.  The *note
newwin(): 20c6. function creates a new window of a given size, returning
the new window object.

     begin_x = 20; begin_y = 7 height = 5; width = 40 win = curses.newwin(height, width, begin_y, begin_x)

Note that the coordinate system used in curses is unusual.  Coordinates
are always passed in the order `y,x', and the top-left corner of a
window is coordinate (0,0).  This breaks the normal convention for
handling coordinates where the `x' coordinate comes first.  This is an
unfortunate difference from most other computer applications, but it’s
been part of curses since it was first written, and it’s too late to
change things now.

Your application can determine the size of the screen by using the
‘curses.LINES’ and ‘curses.COLS’ variables to obtain the `y' and `x'
sizes.  Legal coordinates will then extend from ‘(0,0)’ to
‘(curses.LINES - 1, curses.COLS - 1)’.

When you call a method to display or erase text, the effect doesn’t
immediately show up on the display.  Instead you must call the *note
refresh(): 20a5. method of window objects to update the screen.

This is because curses was originally written with slow 300-baud
terminal connections in mind; with these terminals, minimizing the time
required to redraw the screen was very important.  Instead curses
accumulates changes to the screen and displays them in the most
efficient manner when you call ‘refresh()’.  For example, if your
program displays some text in a window and then clears the window,
there’s no need to send the original text because they’re never visible.

In practice, explicitly telling curses to redraw a window doesn’t really
complicate programming with curses much.  Most programs go into a flurry
of activity, and then pause waiting for a keypress or some other action
on the part of the user.  All you have to do is to be sure that the
screen has been redrawn before pausing to wait for user input, by first
calling ‘stdscr.refresh()’ or the ‘refresh()’ method of some other
relevant window.

A pad is a special case of a window; it can be larger than the actual
display screen, and only a portion of the pad displayed at a time.
Creating a pad requires the pad’s height and width, while refreshing a
pad requires giving the coordinates of the on-screen area where a
subsection of the pad will be displayed.

     pad = curses.newpad(100, 100) # These loops fill the pad with letters; addch() is # explained in the next section for y in range(0, 99):     for x in range(0, 99):         pad.addch(y,x, ord('a') + (x*x+y*y) % 26)  # Displays a section of the pad in the middle of the screen. # (0,0) : coordinate of upper-left corner of pad area to display. # (5,5) : coordinate of upper-left corner of window area to be filled #         with pad content. # (20, 75) : coordinate of lower-right corner of window area to be #          : filled with pad content. pad.refresh( 0,0, 5,5, 20,75)

The ‘refresh()’ call displays a section of the pad in the rectangle
extending from coordinate (5,5) to coordinate (20,75) on the screen; the
upper left corner of the displayed section is coordinate (0,0) on the
pad.  Beyond that difference, pads are exactly like ordinary windows and
support the same methods.

If you have multiple windows and pads on screen there is a more
efficient way to update the screen and prevent annoying screen flicker
as each part of the screen gets updated.  ‘refresh()’ actually does two
things:

  1. Calls the *note noutrefresh(): 20a3. method of each window to
     update an underlying data structure representing the desired state
     of the screen.

  2. Calls the function *note doupdate(): 20a2. function to change the
     physical screen to match the desired state recorded in the data
     structure.

Instead you can call ‘noutrefresh()’ on a number of windows to update
the data structure, and then call ‘doupdate()’ to update the screen.


File: python.info,  Node: Displaying Text,  Next: User Input,  Prev: Windows and Pads,  Up: Curses Programming with Python

10.3.4 Displaying Text
----------------------

From a C programmer’s point of view, curses may sometimes look like a
twisty maze of functions, all subtly different.  For example, ‘addstr()’
displays a string at the current cursor location in the ‘stdscr’ window,
while ‘mvaddstr()’ moves to a given y,x coordinate first before
displaying the string.  ‘waddstr()’ is just like ‘addstr()’, but allows
specifying a window to use instead of using ‘stdscr’ by default.
‘mvwaddstr()’ allows specifying both a window and a coordinate.

Fortunately the Python interface hides all these details.  ‘stdscr’ is a
window object like any other, and methods such as *note addstr(): 20a4.
accept multiple argument forms.  Usually there are four different forms.

Form                                  Description
                                      
------------------------------------------------------------------------------------------
                                      
`str' or `ch'                         Display the string `str' or character `ch' at the
                                      current position
                                      
                                      
`str' or `ch', `attr'                 Display the string `str' or character `ch', using
                                      attribute `attr' at the current position
                                      
                                      
`y', `x', `str' or `ch'               Move to position `y,x' within the window, and
                                      display `str' or `ch'
                                      
                                      
`y', `x', `str' or `ch', `attr'       Move to position `y,x' within the window, and
                                      display `str' or `ch', using attribute `attr'
                                      

Attributes allow displaying text in highlighted forms such as boldface,
underline, reverse code, or in color.  They’ll be explained in more
detail in the next subsection.

The *note addstr(): 20a4. method takes a Python string or bytestring as
the value to be displayed.  The contents of bytestrings are sent to the
terminal as-is.  Strings are encoded to bytes using the value of the
window’s ‘encoding’ attribute; this defaults to the default system
encoding as returned by *note locale.getpreferredencoding(): 39a.

The *note addch(): 20e2. methods take a character, which can be either a
string of length 1, a bytestring of length 1, or an integer.

Constants are provided for extension characters; these constants are
integers greater than 255.  For example, ‘ACS_PLMINUS’ is a +/- symbol,
and ‘ACS_ULCORNER’ is the upper left corner of a box (handy for drawing
borders).  You can also use the appropriate Unicode character.

Windows remember where the cursor was left after the last operation, so
if you leave out the `y,x' coordinates, the string or character will be
displayed wherever the last operation left off.  You can also move the
cursor with the ‘move(y,x)’ method.  Because some terminals always
display a flashing cursor, you may want to ensure that the cursor is
positioned in some location where it won’t be distracting; it can be
confusing to have the cursor blinking at some apparently random
location.

If your application doesn’t need a blinking cursor at all, you can call
‘curs_set(False)’ to make it invisible.  For compatibility with older
curses versions, there’s a ‘leaveok(bool)’ function that’s a synonym for
*note curs_set(): 209c.  When `bool' is true, the curses library will
attempt to suppress the flashing cursor, and you won’t need to worry
about leaving it in odd locations.

* Menu:

* Attributes and Color::


File: python.info,  Node: Attributes and Color,  Up: Displaying Text

10.3.4.1 Attributes and Color
.............................

Characters can be displayed in different ways.  Status lines in a
text-based application are commonly shown in reverse video, or a text
viewer may need to highlight certain words.  curses supports this by
allowing you to specify an attribute for each cell on the screen.

An attribute is an integer, each bit representing a different attribute.
You can try to display text with multiple attribute bits set, but curses
doesn’t guarantee that all the possible combinations are available, or
that they’re all visually distinct.  That depends on the ability of the
terminal being used, so it’s safest to stick to the most commonly
available attributes, listed here.

Attribute                  Description
                           
----------------------------------------------------------------------
                           
‘A_BLINK’                  Blinking text
                           
                           
‘A_BOLD’                   Extra bright or bold text
                           
                           
‘A_DIM’                    Half bright text
                           
                           
‘A_REVERSE’                Reverse-video text
                           
                           
‘A_STANDOUT’               The best highlighting mode available
                           
                           
‘A_UNDERLINE’              Underlined text
                           

So, to display a reverse-video status line on the top line of the
screen, you could code:

     stdscr.addstr(0, 0, "Current mode: Typing mode",               curses.A_REVERSE) stdscr.refresh()

The curses library also supports color on those terminals that provide
it.  The most common such terminal is probably the Linux console,
followed by color xterms.

To use color, you must call the *note start_color(): 20d4. function soon
after calling *note initscr(): 20aa, to initialize the default color set
(the *note curses.wrapper(): 29f. function does this automatically).
Once that’s done, the *note has_colors(): 20b2. function returns TRUE if
the terminal in use can actually display color.  (Note: curses uses the
American spelling ‘color’, instead of the Canadian/British spelling
‘colour’.  If you’re used to the British spelling, you’ll have to resign
yourself to misspelling it for the sake of these functions.)

The curses library maintains a finite number of color pairs, containing
a foreground (or text) color and a background color.  You can get the
attribute value corresponding to a color pair with the *note
color_pair(): 209a. function; this can be bitwise-OR’ed with other
attributes such as ‘A_REVERSE’, but again, such combinations are not
guaranteed to work on all terminals.

An example, which displays a line of text using color pair 1:

     stdscr.addstr("Pretty text", curses.color_pair(1)) stdscr.refresh()

As I said before, a color pair consists of a foreground and background
color.  The ‘init_pair(n, f, b)’ function changes the definition of
color pair `n', to foreground color f and background color b.  Color
pair 0 is hard-wired to white on black, and cannot be changed.

Colors are numbered, and ‘start_color()’ initializes 8 basic colors when
it activates color mode.  They are: 0:black, 1:red, 2:green, 3:yellow,
4:blue, 5:magenta, 6:cyan, and 7:white.  The *note curses: 2c. module
defines named constants for each of these colors: ‘curses.COLOR_BLACK’,
‘curses.COLOR_RED’, and so forth.

Let’s put all this together.  To change color 1 to red text on a white
background, you would call:

     curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE)

When you change a color pair, any text already displayed using that
color pair will change to the new colors.  You can also display new text
in this color with:

     stdscr.addstr(0,0, "RED ALERT!", curses.color_pair(1))

Very fancy terminals can change the definitions of the actual colors to
a given RGB value.  This lets you change color 1, which is usually red,
to purple or blue or any other color you like.  Unfortunately, the Linux
console doesn’t support this, so I’m unable to try it out, and can’t
provide any examples.  You can check if your terminal can do this by
calling *note can_change_color(): 2096, which returns ‘True’ if the
capability is there.  If you’re lucky enough to have such a talented
terminal, consult your system’s man pages for more information.


File: python.info,  Node: User Input,  Next: For More Information,  Prev: Displaying Text,  Up: Curses Programming with Python

10.3.5 User Input
-----------------

The C curses library offers only very simple input mechanisms.  Python’s
*note curses: 2c. module adds a basic text-input widget.  (Other
libraries such as Urwid(1) have more extensive collections of widgets.)

There are two methods for getting input from a window:

   * *note getch(): 20ae. refreshes the screen and then waits for the
     user to hit a key, displaying the key if *note echo(): 20a6. has
     been called earlier.  You can optionally specify a coordinate to
     which the cursor should be moved before pausing.

   * *note getkey(): 20fb. does the same thing but converts the integer
     to a string.  Individual characters are returned as 1-character
     strings, and special keys such as function keys return longer
     strings containing a key name such as ‘KEY_UP’ or ‘^G’.

It’s possible to not wait for the user using the *note nodelay(): 2111.
window method.  After ‘nodelay(True)’, ‘getch()’ and ‘getkey()’ for the
window become non-blocking.  To signal that no input is ready, ‘getch()’
returns ‘curses.ERR’ (a value of -1) and ‘getkey()’ raises an exception.
There’s also a *note halfdelay(): 20b6. function, which can be used to
(in effect) set a timer on each ‘getch()’; if no input becomes available
within a specified delay (measured in tenths of a second), curses raises
an exception.

The ‘getch()’ method returns an integer; if it’s between 0 and 255, it
represents the ASCII code of the key pressed.  Values greater than 255
are special keys such as Page Up, Home, or the cursor keys.  You can
compare the value returned to constants such as ‘curses.KEY_PPAGE’,
‘curses.KEY_HOME’, or ‘curses.KEY_LEFT’.  The main loop of your program
may look something like this:

     while True:     c = stdscr.getch()     if c == ord('p'):         PrintDocument()     elif c == ord('q'):         break  # Exit the while loop     elif c == curses.KEY_HOME:         x = y = 0

The *note curses.ascii: 2d. module supplies ASCII class membership
functions that take either integer or 1-character string arguments;
these may be useful in writing more readable tests for such loops.  It
also supplies conversion functions that take either integer or
1-character-string arguments and return the same type.  For example,
*note curses.ascii.ctrl(): 2145. returns the control character
corresponding to its argument.

There’s also a method to retrieve an entire string, *note getstr():
20fe.  It isn’t used very often, because its functionality is quite
limited; the only editing keys available are the backspace key and the
Enter key, which terminates the string.  It can optionally be limited to
a fixed number of characters.

     curses.echo()            # Enable echoing of characters  # Get a 15-character string, with the cursor on the top line s = stdscr.getstr(0,0, 15)

The *note curses.textpad: 2f. module supplies a text box that supports
an Emacs-like set of keybindings.  Various methods of the *note Textbox:
212b. class support editing with input validation and gathering the edit
results either with or without trailing spaces.  Here’s an example:

     import curses from curses.textpad import Textbox, rectangle  def main(stdscr):     stdscr.addstr(0, 0, "Enter IM message: (hit Ctrl-G to send)")      editwin = curses.newwin(5,30, 2,1)     rectangle(stdscr, 1,0, 1+5+1, 1+30+1)     stdscr.refresh()      box = Textbox(editwin)      # Let the user edit until Ctrl-G is struck.     box.edit()      # Get resulting contents     message = box.gather()

See the library documentation on *note curses.textpad: 2f. for more
details.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/urwid/


File: python.info,  Node: For More Information,  Prev: User Input,  Up: Curses Programming with Python

10.3.6 For More Information
---------------------------

This HOWTO doesn’t cover some advanced topics, such as reading the
contents of the screen or capturing mouse events from an xterm instance,
but the Python library page for the *note curses: 2c. module is now
reasonably complete.  You should browse it next.

If you’re in doubt about the detailed behavior of the curses functions,
consult the manual pages for your curses implementation, whether it’s
ncurses or a proprietary Unix vendor’s.  The manual pages will document
any quirks, and provide complete lists of all the functions, attributes,
and ‘ACS_*’ characters available to you.

Because the curses API is so large, some functions aren’t supported in
the Python interface.  Often this isn’t because they’re difficult to
implement, but because no one has needed them yet.  Also, Python doesn’t
yet support the menu library associated with ncurses.  Patches adding
support for these would be welcome; see the Python Developer’s Guide(1)
to learn more about submitting patches to Python.

   * Writing Programs with NCURSES(2): a lengthy tutorial for C
     programmers.

   * The ncurses man page(3)

   * The ncurses FAQ(4)

   * "Use curses...  don’t swear"(5): video of a PyCon 2013 talk on
     controlling terminals using curses or Urwid.

   * "Console Applications with Urwid"(6): video of a PyCon CA 2012 talk
     demonstrating some applications written using Urwid.

   ---------- Footnotes ----------

   (1) https://devguide.python.org/

   (2) http://invisible-island.net/ncurses/ncurses-intro.html

   (3) https://linux.die.net/man/3/ncurses

   (4) http://invisible-island.net/ncurses/ncurses.faq.html

   (5) https://www.youtube.com/watch?v=eN1eZtjLEnU

   (6) http://www.pyvideo.org/video/1568/console-applications-with-urwid


File: python.info,  Node: Descriptor HowTo Guide,  Next: Functional Programming HOWTO,  Prev: Curses Programming with Python,  Up: Python HOWTOs

10.4 Descriptor HowTo Guide
===========================


Author: Raymond Hettinger


Contact: <python at rcn dot com>

* Menu:

* Abstract::
* Definition and Introduction::
* Descriptor Protocol::
* Invoking Descriptors: Invoking Descriptors<2>.
* Descriptor Example::
* Properties::
* Functions and Methods::
* Static Methods and Class Methods::


File: python.info,  Node: Abstract,  Next: Definition and Introduction,  Up: Descriptor HowTo Guide

10.4.1 Abstract
---------------

Defines descriptors, summarizes the protocol, and shows how descriptors
are called.  Examines a custom descriptor and several built-in Python
descriptors including functions, properties, static methods, and class
methods.  Shows how each works by giving a pure Python equivalent and a
sample application.

Learning about descriptors not only provides access to a larger toolset,
it creates a deeper understanding of how Python works and an
appreciation for the elegance of its design.


File: python.info,  Node: Definition and Introduction,  Next: Descriptor Protocol,  Prev: Abstract,  Up: Descriptor HowTo Guide

10.4.2 Definition and Introduction
----------------------------------

In general, a descriptor is an object attribute with “binding behavior”,
one whose attribute access has been overridden by methods in the
descriptor protocol.  Those methods are *note __get__(): 1377, *note
__set__(): 137b, and *note __delete__(): 137c.  If any of those methods
are defined for an object, it is said to be a descriptor.

The default behavior for attribute access is to get, set, or delete the
attribute from an object’s dictionary.  For instance, ‘a.x’ has a lookup
chain starting with ‘a.__dict__['x']’, then ‘type(a).__dict__['x']’, and
continuing through the base classes of ‘type(a)’ excluding metaclasses.
If the looked-up value is an object defining one of the descriptor
methods, then Python may override the default behavior and invoke the
descriptor method instead.  Where this occurs in the precedence chain
depends on which descriptor methods were defined.

Descriptors are a powerful, general purpose protocol.  They are the
mechanism behind properties, methods, static methods, class methods, and
*note super(): 4d7.  They are used throughout Python itself to implement
the new style classes introduced in version 2.2.  Descriptors simplify
the underlying C-code and offer a flexible set of new tools for everyday
Python programs.


File: python.info,  Node: Descriptor Protocol,  Next: Invoking Descriptors<2>,  Prev: Definition and Introduction,  Up: Descriptor HowTo Guide

10.4.3 Descriptor Protocol
--------------------------

‘descr.__get__(self, obj, type=None) -> value’

‘descr.__set__(self, obj, value) -> None’

‘descr.__delete__(self, obj) -> None’

That is all there is to it.  Define any of these methods and an object
is considered a descriptor and can override default behavior upon being
looked up as an attribute.

If an object defines *note __set__(): 137b. or *note __delete__(): 137c,
it is considered a data descriptor.  Descriptors that only define *note
__get__(): 1377. are called non-data descriptors (they are typically
used for methods but other uses are possible).

Data and non-data descriptors differ in how overrides are calculated
with respect to entries in an instance’s dictionary.  If an instance’s
dictionary has an entry with the same name as a data descriptor, the
data descriptor takes precedence.  If an instance’s dictionary has an
entry with the same name as a non-data descriptor, the dictionary entry
takes precedence.

To make a read-only data descriptor, define both *note __get__(): 1377.
and *note __set__(): 137b. with the *note __set__(): 137b. raising an
*note AttributeError: 390. when called.  Defining the *note __set__():
137b. method with an exception raising placeholder is enough to make it
a data descriptor.


File: python.info,  Node: Invoking Descriptors<2>,  Next: Descriptor Example,  Prev: Descriptor Protocol,  Up: Descriptor HowTo Guide

10.4.4 Invoking Descriptors
---------------------------

A descriptor can be called directly by its method name.  For example,
‘d.__get__(obj)’.

Alternatively, it is more common for a descriptor to be invoked
automatically upon attribute access.  For example, ‘obj.d’ looks up ‘d’
in the dictionary of ‘obj’.  If ‘d’ defines the method *note __get__():
1377, then ‘d.__get__(obj)’ is invoked according to the precedence rules
listed below.

The details of invocation depend on whether ‘obj’ is an object or a
class.

For objects, the machinery is in *note object.__getattribute__(): 43e.
which transforms ‘b.x’ into ‘type(b).__dict__['x'].__get__(b, type(b))’.
The implementation works through a precedence chain that gives data
descriptors priority over instance variables, instance variables
priority over non-data descriptors, and assigns lowest priority to *note
__getattr__(): 30f. if provided.  The full C implementation can be found
in *note PyObject_GenericGetAttr(): 3bf8. in Objects/object.c(1).

For classes, the machinery is in ‘type.__getattribute__()’ which
transforms ‘B.x’ into ‘B.__dict__['x'].__get__(None, B)’.  In pure
Python, it looks like:

     def __getattribute__(self, key):     "Emulate type_getattro() in Objects/typeobject.c"     v = object.__getattribute__(self, key)     if hasattr(v, '__get__'):         return v.__get__(None, self)     return v

The important points to remember are:

   * descriptors are invoked by the *note __getattribute__(): 43e.
     method

   * overriding *note __getattribute__(): 43e. prevents automatic
     descriptor calls

   * *note object.__getattribute__(): 43e. and ‘type.__getattribute__()’
     make different calls to *note __get__(): 1377.

   * data descriptors always override instance dictionaries.

   * non-data descriptors may be overridden by instance dictionaries.

The object returned by ‘super()’ also has a custom *note
__getattribute__(): 43e. method for invoking descriptors.  The attribute
lookup ‘super(B, obj).m’ searches ‘obj.__class__.__mro__’ for the base
class ‘A’ immediately following ‘B’ and then returns
‘A.__dict__['m'].__get__(obj, B)’.  If not a descriptor, ‘m’ is returned
unchanged.  If not in the dictionary, ‘m’ reverts to a search using
*note object.__getattribute__(): 43e.

The implementation details are in ‘super_getattro()’ in
Objects/typeobject.c(2).  and a pure Python equivalent can be found in
Guido’s Tutorial(3).

The details above show that the mechanism for descriptors is embedded in
the *note __getattribute__(): 43e. methods for *note object: 2ae, *note
type: 5fd, and *note super(): 4d7.  Classes inherit this machinery when
they derive from *note object: 2ae. or if they have a meta-class
providing similar functionality.  Likewise, classes can turn-off
descriptor invocation by overriding *note __getattribute__(): 43e.

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Objects/object.c

   (2) https://github.com/python/cpython/tree/3.8/Objects/typeobject.c

   (3) 
https://www.python.org/download/releases/2.2.3/descrintro/#cooperation


File: python.info,  Node: Descriptor Example,  Next: Properties,  Prev: Invoking Descriptors<2>,  Up: Descriptor HowTo Guide

10.4.5 Descriptor Example
-------------------------

The following code creates a class whose objects are data descriptors
which print a message for each get or set.  Overriding *note
__getattribute__(): 43e. is alternate approach that could do this for
every attribute.  However, this descriptor is useful for monitoring just
a few chosen attributes:

     class RevealAccess(object):     """A data descriptor that sets and returns values        normally and prints a message logging their access.     """      def __init__(self, initval=None, name='var'):         self.val = initval         self.name = name      def __get__(self, obj, objtype):         print('Retrieving', self.name)         return self.val      def __set__(self, obj, val):         print('Updating', self.name)         self.val = val  >>> class MyClass(object): ...     x = RevealAccess(10, 'var "x"') ...     y = 5 ... >>> m = MyClass() >>> m.x Retrieving var "x" 10 >>> m.x = 20 Updating var "x" >>> m.x Retrieving var "x" 20 >>> m.y 5

The protocol is simple and offers exciting possibilities.  Several use
cases are so common that they have been packaged into individual
function calls.  Properties, bound methods, static methods, and class
methods are all based on the descriptor protocol.


File: python.info,  Node: Properties,  Next: Functions and Methods,  Prev: Descriptor Example,  Up: Descriptor HowTo Guide

10.4.6 Properties
-----------------

Calling *note property(): 1d5. is a succinct way of building a data
descriptor that triggers function calls upon access to an attribute.
Its signature is:

     property(fget=None, fset=None, fdel=None, doc=None) -> property attribute

The documentation shows a typical use to define a managed attribute ‘x’:

     class C(object):     def getx(self): return self.__x     def setx(self, value): self.__x = value     def delx(self): del self.__x     x = property(getx, setx, delx, "I'm the 'x' property.")

To see how *note property(): 1d5. is implemented in terms of the
descriptor protocol, here is a pure Python equivalent:

     class Property(object):     "Emulate PyProperty_Type() in Objects/descrobject.c"      def __init__(self, fget=None, fset=None, fdel=None, doc=None):         self.fget = fget         self.fset = fset         self.fdel = fdel         if doc is None and fget is not None:             doc = fget.__doc__         self.__doc__ = doc      def __get__(self, obj, objtype=None):         if obj is None:             return self         if self.fget is None:             raise AttributeError("unreadable attribute")         return self.fget(obj)      def __set__(self, obj, value):         if self.fset is None:             raise AttributeError("can't set attribute")         self.fset(obj, value)      def __delete__(self, obj):         if self.fdel is None:             raise AttributeError("can't delete attribute")         self.fdel(obj)      def getter(self, fget):         return type(self)(fget, self.fset, self.fdel, self.__doc__)      def setter(self, fset):         return type(self)(self.fget, fset, self.fdel, self.__doc__)      def deleter(self, fdel):         return type(self)(self.fget, self.fset, fdel, self.__doc__)

The *note property(): 1d5. builtin helps whenever a user interface has
granted attribute access and then subsequent changes require the
intervention of a method.

For instance, a spreadsheet class may grant access to a cell value
through ‘Cell('b10').value’.  Subsequent improvements to the program
require the cell to be recalculated on every access; however, the
programmer does not want to affect existing client code accessing the
attribute directly.  The solution is to wrap access to the value
attribute in a property data descriptor:

     class Cell(object):     . . .     def getvalue(self):         "Recalculate the cell before returning value"         self.recalc()         return self._value     value = property(getvalue)


File: python.info,  Node: Functions and Methods,  Next: Static Methods and Class Methods,  Prev: Properties,  Up: Descriptor HowTo Guide

10.4.7 Functions and Methods
----------------------------

Python’s object oriented features are built upon a function based
environment.  Using non-data descriptors, the two are merged seamlessly.

Class dictionaries store methods as functions.  In a class definition,
methods are written using *note def: db1. or *note lambda: c22, the
usual tools for creating functions.  Methods only differ from regular
functions in that the first argument is reserved for the object
instance.  By Python convention, the instance reference is called `self'
but may be called `this' or any other variable name.

To support method calls, functions include the *note __get__(): 1377.
method for binding methods during attribute access.  This means that all
functions are non-data descriptors which return bound methods when they
are invoked from an object.  In pure Python, it works like this:

     class Function(object):     . . .     def __get__(self, obj, objtype=None):         "Simulate func_descr_get() in Objects/funcobject.c"         if obj is None:             return self         return types.MethodType(self, obj)

Running the interpreter shows how the function descriptor works in
practice:

     >>> class D(object): ...     def f(self, x): ...         return x ... >>> d = D()  # Access through the class dictionary does not invoke __get__. # It just returns the underlying function object. >>> D.__dict__['f'] <function D.f at 0x00C45070>  # Dotted access from a class calls __get__() which just returns # the underlying function unchanged. >>> D.f <function D.f at 0x00C45070>  # The function has a __qualname__ attribute to support introspection >>> D.f.__qualname__ 'D.f'  # Dotted access from an instance calls __get__() which returns the # function wrapped in a bound method object >>> d.f <bound method D.f of <__main__.D object at 0x00B18C90>>  # Internally, the bound method stores the underlying function, # the bound instance, and the class of the bound instance. >>> d.f.__func__ <function D.f at 0x1012e5ae8> >>> d.f.__self__ <__main__.D object at 0x1012e1f98> >>> d.f.__class__ <class 'method'>


File: python.info,  Node: Static Methods and Class Methods,  Prev: Functions and Methods,  Up: Descriptor HowTo Guide

10.4.8 Static Methods and Class Methods
---------------------------------------

Non-data descriptors provide a simple mechanism for variations on the
usual patterns of binding functions into methods.

To recap, functions have a *note __get__(): 1377. method so that they
can be converted to a method when accessed as attributes.  The non-data
descriptor transforms an ‘obj.f(*args)’ call into ‘f(obj, *args)’.
Calling ‘klass.f(*args)’ becomes ‘f(*args)’.

This chart summarizes the binding and its two most useful variants:

     Transformation        Called from an Object      Called from a Class
                                                      
     ------------------------------------------------------------------------
                                                      
     function              f(obj, *args)              f(*args)
                                                      
                                                      
     staticmethod          f(*args)                   f(*args)
                                                      
                                                      
     classmethod           f(type(obj), *args)        f(klass, *args)
                                                      

Static methods return the underlying function without changes.  Calling
either ‘c.f’ or ‘C.f’ is the equivalent of a direct lookup into
‘object.__getattribute__(c, "f")’ or ‘object.__getattribute__(C, "f")’.
As a result, the function becomes identically accessible from either an
object or a class.

Good candidates for static methods are methods that do not reference the
‘self’ variable.

For instance, a statistics package may include a container class for
experimental data.  The class provides normal methods for computing the
average, mean, median, and other descriptive statistics that depend on
the data.  However, there may be useful functions which are conceptually
related but do not depend on the data.  For instance, ‘erf(x)’ is handy
conversion routine that comes up in statistical work but does not
directly depend on a particular dataset.  It can be called either from
an object or the class: ‘s.erf(1.5) --> .9332’ or ‘Sample.erf(1.5) -->
.9332’.

Since staticmethods return the underlying function with no changes, the
example calls are unexciting:

     >>> class E(object): ...     def f(x): ...         print(x) ...     f = staticmethod(f) ... >>> E.f(3) 3 >>> E().f(3) 3

Using the non-data descriptor protocol, a pure Python version of *note
staticmethod(): 1d7. would look like this:

     class StaticMethod(object):     "Emulate PyStaticMethod_Type() in Objects/funcobject.c"      def __init__(self, f):         self.f = f      def __get__(self, obj, objtype=None):         return self.f

Unlike static methods, class methods prepend the class reference to the
argument list before calling the function.  This format is the same for
whether the caller is an object or a class:

     >>> class E(object): ...     def f(klass, x): ...         return klass.__name__, x ...     f = classmethod(f) ... >>> print(E.f(3)) ('E', 3) >>> print(E().f(3)) ('E', 3)

This behavior is useful whenever the function only needs to have a class
reference and does not care about any underlying data.  One use for
classmethods is to create alternate class constructors.  In Python 2.3,
the classmethod *note dict.fromkeys(): 1610. creates a new dictionary
from a list of keys.  The pure Python equivalent is:

     class Dict(object):     . . .     def fromkeys(klass, iterable, value=None):         "Emulate dict_fromkeys() in Objects/dictobject.c"         d = klass()         for key in iterable:             d[key] = value         return d     fromkeys = classmethod(fromkeys)

Now a new dictionary of unique keys can be constructed like this:

     >>> Dict.fromkeys('abracadabra') {'a': None, 'r': None, 'b': None, 'c': None, 'd': None}

Using the non-data descriptor protocol, a pure Python version of *note
classmethod(): 1d6. would look like this:

     class ClassMethod(object):     "Emulate PyClassMethod_Type() in Objects/funcobject.c"      def __init__(self, f):         self.f = f      def __get__(self, obj, klass=None):         if klass is None:             klass = type(obj)         def newfunc(*args):             return self.f(klass, *args)         return newfunc


File: python.info,  Node: Functional Programming HOWTO,  Next: Logging HOWTO,  Prev: Descriptor HowTo Guide,  Up: Python HOWTOs

10.5 Functional Programming HOWTO
=================================


Author: A. M. Kuchling


Release: 0.32

In this document, we’ll take a tour of Python’s features suitable for
implementing programs in a functional style.  After an introduction to
the concepts of functional programming, we’ll look at language features
such as *note iterator: f73.s and *note generator: 996.s and relevant
library modules such as *note itertools: a3. and *note functools: 85.

* Menu:

* Introduction: Introduction<14>.
* Iterators: Iterators<2>.
* Generator expressions and list comprehensions::
* Generators: Generators<2>.
* Built-in functions::
* The itertools module::
* The functools module::
* Small functions and the lambda expression::
* Revision History and Acknowledgements::
* References: References<2>.


File: python.info,  Node: Introduction<14>,  Next: Iterators<2>,  Up: Functional Programming HOWTO

10.5.1 Introduction
-------------------

This section explains the basic concept of functional programming; if
you’re just interested in learning about Python language features, skip
to the next section on *note Iterators: 4072.

Programming languages support decomposing problems in several different
ways:

   * Most programming languages are `procedural': programs are lists of
     instructions that tell the computer what to do with the program’s
     input.  C, Pascal, and even Unix shells are procedural languages.

   * In `declarative' languages, you write a specification that
     describes the problem to be solved, and the language implementation
     figures out how to perform the computation efficiently.  SQL is the
     declarative language you’re most likely to be familiar with; a SQL
     query describes the data set you want to retrieve, and the SQL
     engine decides whether to scan tables or use indexes, which
     subclauses should be performed first, etc.

   * `Object-oriented' programs manipulate collections of objects.
     Objects have internal state and support methods that query or
     modify this internal state in some way.  Smalltalk and Java are
     object-oriented languages.  C++ and Python are languages that
     support object-oriented programming, but don’t force the use of
     object-oriented features.

   * `Functional' programming decomposes a problem into a set of
     functions.  Ideally, functions only take inputs and produce
     outputs, and don’t have any internal state that affects the output
     produced for a given input.  Well-known functional languages
     include the ML family (Standard ML, OCaml, and other variants) and
     Haskell.

The designers of some computer languages choose to emphasize one
particular approach to programming.  This often makes it difficult to
write programs that use a different approach.  Other languages are
multi-paradigm languages that support several different approaches.
Lisp, C++, and Python are multi-paradigm; you can write programs or
libraries that are largely procedural, object-oriented, or functional in
all of these languages.  In a large program, different sections might be
written using different approaches; the GUI might be object-oriented
while the processing logic is procedural or functional, for example.

In a functional program, input flows through a set of functions.  Each
function operates on its input and produces some output.  Functional
style discourages functions with side effects that modify internal state
or make other changes that aren’t visible in the function’s return
value.  Functions that have no side effects at all are called `purely
functional'.  Avoiding side effects means not using data structures that
get updated as a program runs; every function’s output must only depend
on its input.

Some languages are very strict about purity and don’t even have
assignment statements such as ‘a=3’ or ‘c = a + b’, but it’s difficult
to avoid all side effects.  Printing to the screen or writing to a disk
file are side effects, for example.  For example, in Python a call to
the *note print(): 87a. or *note time.sleep(): 674. function both return
no useful value; they’re only called for their side effects of sending
some text to the screen or pausing execution for a second.

Python programs written in functional style usually won’t go to the
extreme of avoiding all I/O or all assignments; instead, they’ll provide
a functional-appearing interface but will use non-functional features
internally.  For example, the implementation of a function will still
use assignments to local variables, but won’t modify global variables or
have other side effects.

Functional programming can be considered the opposite of object-oriented
programming.  Objects are little capsules containing some internal state
along with a collection of method calls that let you modify this state,
and programs consist of making the right set of state changes.
Functional programming wants to avoid state changes as much as possible
and works with data flowing between functions.  In Python you might
combine the two approaches by writing functions that take and return
instances representing objects in your application (e-mail messages,
transactions, etc.).

Functional design may seem like an odd constraint to work under.  Why
should you avoid objects and side effects?  There are theoretical and
practical advantages to the functional style:

   * Formal provability.

   * Modularity.

   * Composability.

   * Ease of debugging and testing.

* Menu:

* Formal provability::
* Modularity::
* Ease of debugging and testing::
* Composability::


File: python.info,  Node: Formal provability,  Next: Modularity,  Up: Introduction<14>

10.5.1.1 Formal provability
...........................

A theoretical benefit is that it’s easier to construct a mathematical
proof that a functional program is correct.

For a long time researchers have been interested in finding ways to
mathematically prove programs correct.  This is different from testing a
program on numerous inputs and concluding that its output is usually
correct, or reading a program’s source code and concluding that the code
looks right; the goal is instead a rigorous proof that a program
produces the right result for all possible inputs.

The technique used to prove programs correct is to write down
`invariants', properties of the input data and of the program’s
variables that are always true.  For each line of code, you then show
that if invariants X and Y are true `before' the line is executed, the
slightly different invariants X’ and Y’ are true `after' the line is
executed.  This continues until you reach the end of the program, at
which point the invariants should match the desired conditions on the
program’s output.

Functional programming’s avoidance of assignments arose because
assignments are difficult to handle with this technique; assignments can
break invariants that were true before the assignment without producing
any new invariants that can be propagated onward.

Unfortunately, proving programs correct is largely impractical and not
relevant to Python software.  Even trivial programs require proofs that
are several pages long; the proof of correctness for a moderately
complicated program would be enormous, and few or none of the programs
you use daily (the Python interpreter, your XML parser, your web
browser) could be proven correct.  Even if you wrote down or generated a
proof, there would then be the question of verifying the proof; maybe
there’s an error in it, and you wrongly believe you’ve proved the
program correct.


File: python.info,  Node: Modularity,  Next: Ease of debugging and testing,  Prev: Formal provability,  Up: Introduction<14>

10.5.1.2 Modularity
...................

A more practical benefit of functional programming is that it forces you
to break apart your problem into small pieces.  Programs are more
modular as a result.  It’s easier to specify and write a small function
that does one thing than a large function that performs a complicated
transformation.  Small functions are also easier to read and to check
for errors.


File: python.info,  Node: Ease of debugging and testing,  Next: Composability,  Prev: Modularity,  Up: Introduction<14>

10.5.1.3 Ease of debugging and testing
......................................

Testing and debugging a functional-style program is easier.

Debugging is simplified because functions are generally small and
clearly specified.  When a program doesn’t work, each function is an
interface point where you can check that the data are correct.  You can
look at the intermediate inputs and outputs to quickly isolate the
function that’s responsible for a bug.

Testing is easier because each function is a potential subject for a
unit test.  Functions don’t depend on system state that needs to be
replicated before running a test; instead you only have to synthesize
the right input and then check that the output matches expectations.


File: python.info,  Node: Composability,  Prev: Ease of debugging and testing,  Up: Introduction<14>

10.5.1.4 Composability
......................

As you work on a functional-style program, you’ll write a number of
functions with varying inputs and outputs.  Some of these functions will
be unavoidably specialized to a particular application, but others will
be useful in a wide variety of programs.  For example, a function that
takes a directory path and returns all the XML files in the directory,
or a function that takes a filename and returns its contents, can be
applied to many different situations.

Over time you’ll form a personal library of utilities.  Often you’ll
assemble new programs by arranging existing functions in a new
configuration and writing a few functions specialized for the current
task.


File: python.info,  Node: Iterators<2>,  Next: Generator expressions and list comprehensions,  Prev: Introduction<14>,  Up: Functional Programming HOWTO

10.5.2 Iterators
----------------

I’ll start by looking at a Python language feature that’s an important
foundation for writing functional-style programs: iterators.

An iterator is an object representing a stream of data; this object
returns the data one element at a time.  A Python iterator must support
a method called *note __next__(): c57. that takes no arguments and
always returns the next element of the stream.  If there are no more
elements in the stream, *note __next__(): c57. must raise the *note
StopIteration: 47b. exception.  Iterators don’t have to be finite,
though; it’s perfectly reasonable to write an iterator that produces an
infinite stream of data.

The built-in *note iter(): d1a. function takes an arbitrary object and
tries to return an iterator that will return the object’s contents or
elements, raising *note TypeError: 192. if the object doesn’t support
iteration.  Several of Python’s built-in data types support iteration,
the most common being lists and dictionaries.  An object is called *note
iterable: b9f. if you can get an iterator for it.

You can experiment with the iteration interface manually:

     >>> L = [1, 2, 3] >>> it = iter(L) >>> it  #doctest: +ELLIPSIS <...iterator object at ...> >>> it.__next__()  # same as next(it) 1 >>> next(it) 2 >>> next(it) 3 >>> next(it) Traceback (most recent call last):   File "<stdin>", line 1, in <module> StopIteration >>>

Python expects iterable objects in several different contexts, the most
important being the *note for: c23. statement.  In the statement ‘for X
in Y’, Y must be an iterator or some object for which *note iter(): d1a.
can create an iterator.  These two statements are equivalent:

     for i in iter(obj):     print(i)  for i in obj:     print(i)

Iterators can be materialized as lists or tuples by using the *note
list(): 260. or *note tuple(): 473. constructor functions:

     >>> L = [1, 2, 3] >>> iterator = iter(L) >>> t = tuple(iterator) >>> t (1, 2, 3)

Sequence unpacking also supports iterators: if you know an iterator will
return N elements, you can unpack them into an N-tuple:

     >>> L = [1, 2, 3] >>> iterator = iter(L) >>> a, b, c = iterator >>> a, b, c (1, 2, 3)

Built-in functions such as *note max(): 7fe. and *note min(): 7fd. can
take a single iterator argument and will return the largest or smallest
element.  The ‘"in"’ and ‘"not in"’ operators also support iterators: ‘X
in iterator’ is true if X is found in the stream returned by the
iterator.  You’ll run into obvious problems if the iterator is infinite;
*note max(): 7fe, *note min(): 7fd. will never return, and if the
element X never appears in the stream, the ‘"in"’ and ‘"not in"’
operators won’t return either.

Note that you can only go forward in an iterator; there’s no way to get
the previous element, reset the iterator, or make a copy of it.
Iterator objects can optionally provide these additional capabilities,
but the iterator protocol only specifies the *note __next__(): c57.
method.  Functions may therefore consume all of the iterator’s output,
and if you need to do something different with the same stream, you’ll
have to create a new iterator.

* Menu:

* Data Types That Support Iterators::


File: python.info,  Node: Data Types That Support Iterators,  Up: Iterators<2>

10.5.2.1 Data Types That Support Iterators
..........................................

We’ve already seen how lists and tuples support iterators.  In fact, any
Python sequence type, such as strings, will automatically support
creation of an iterator.

Calling *note iter(): d1a. on a dictionary returns an iterator that will
loop over the dictionary’s keys:

     >>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6, ...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12} >>> for key in m: ...     print(key, m[key]) Jan 1 Feb 2 Mar 3 Apr 4 May 5 Jun 6 Jul 7 Aug 8 Sep 9 Oct 10 Nov 11 Dec 12

Note that starting with Python 3.7, dictionary iteration order is
guaranteed to be the same as the insertion order.  In earlier versions,
the behaviour was unspecified and could vary between implementations.

Applying *note iter(): d1a. to a dictionary always loops over the keys,
but dictionaries have methods that return other iterators.  If you want
to iterate over values or key/value pairs, you can explicitly call the
*note values(): c1f. or *note items(): c1e. methods to get an
appropriate iterator.

The *note dict(): 1b6. constructor can accept an iterator that returns a
finite stream of ‘(key, value)’ tuples:

     >>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')] >>> dict(iter(L)) {'Italy': 'Rome', 'France': 'Paris', 'US': 'Washington DC'}

Files also support iteration by calling the *note readline(): 1b36.
method until there are no more lines in the file.  This means you can
read each line of a file like this:

     for line in file:     # do something for each line     ...

Sets can take their contents from an iterable and let you iterate over
the set’s elements:

     S = {2, 3, 5, 7, 11, 13} for i in S:     print(i)


File: python.info,  Node: Generator expressions and list comprehensions,  Next: Generators<2>,  Prev: Iterators<2>,  Up: Functional Programming HOWTO

10.5.3 Generator expressions and list comprehensions
----------------------------------------------------

Two common operations on an iterator’s output are 1) performing some
operation for every element, 2) selecting a subset of elements that meet
some condition.  For example, given a list of strings, you might want to
strip off trailing whitespace from each line or extract all the strings
containing a given substring.

List comprehensions and generator expressions (short form: “listcomps”
and “genexps”) are a concise notation for such operations, borrowed from
the functional programming language Haskell
(‘https://www.haskell.org/’).  You can strip all the whitespace from a
stream of strings with the following code:

     line_list = ['  line 1\n', 'line 2  \n', ...]  # Generator expression -- returns iterator stripped_iter = (line.strip() for line in line_list)  # List comprehension -- returns list stripped_list = [line.strip() for line in line_list]

You can select only certain elements by adding an ‘"if"’ condition:

     stripped_list = [line.strip() for line in line_list                  if line != ""]

With a list comprehension, you get back a Python list; ‘stripped_list’
is a list containing the resulting lines, not an iterator.  Generator
expressions return an iterator that computes the values as necessary,
not needing to materialize all the values at once.  This means that list
comprehensions aren’t useful if you’re working with iterators that
return an infinite stream or a very large amount of data.  Generator
expressions are preferable in these situations.

Generator expressions are surrounded by parentheses (“()”) and list
comprehensions are surrounded by square brackets (“[]”).  Generator
expressions have the form:

     ( expression for expr in sequence1              if condition1              for expr2 in sequence2              if condition2              for expr3 in sequence3 ...              if condition3              for exprN in sequenceN              if conditionN )

Again, for a list comprehension only the outside brackets are different
(square brackets instead of parentheses).

The elements of the generated output will be the successive values of
‘expression’.  The ‘if’ clauses are all optional; if present,
‘expression’ is only evaluated and added to the result when ‘condition’
is true.

Generator expressions always have to be written inside parentheses, but
the parentheses signalling a function call also count.  If you want to
create an iterator that will be immediately passed to a function you can
write:

     obj_total = sum(obj.count for obj in list_all_objects())

The ‘for...in’ clauses contain the sequences to be iterated over.  The
sequences do not have to be the same length, because they are iterated
over from left to right, `not' in parallel.  For each element in
‘sequence1’, ‘sequence2’ is looped over from the beginning.  ‘sequence3’
is then looped over for each resulting pair of elements from ‘sequence1’
and ‘sequence2’.

To put it another way, a list comprehension or generator expression is
equivalent to the following Python code:

     for expr1 in sequence1:     if not (condition1):         continue   # Skip this element     for expr2 in sequence2:         if not (condition2):             continue   # Skip this element         ...         for exprN in sequenceN:             if not (conditionN):                 continue   # Skip this element              # Output the value of             # the expression.

This means that when there are multiple ‘for...in’ clauses but no ‘if’
clauses, the length of the resulting output will be equal to the product
of the lengths of all the sequences.  If you have two lists of length 3,
the output list is 9 elements long:

     >>> seq1 = 'abc' >>> seq2 = (1, 2, 3) >>> [(x, y) for x in seq1 for y in seq2]  #doctest: +NORMALIZE_WHITESPACE [('a', 1), ('a', 2), ('a', 3),  ('b', 1), ('b', 2), ('b', 3),  ('c', 1), ('c', 2), ('c', 3)]

To avoid introducing an ambiguity into Python’s grammar, if ‘expression’
is creating a tuple, it must be surrounded with parentheses.  The first
list comprehension below is a syntax error, while the second one is
correct:

     # Syntax error [x, y for x in seq1 for y in seq2] # Correct [(x, y) for x in seq1 for y in seq2]


File: python.info,  Node: Generators<2>,  Next: Built-in functions,  Prev: Generator expressions and list comprehensions,  Up: Functional Programming HOWTO

10.5.4 Generators
-----------------

Generators are a special class of functions that simplify the task of
writing iterators.  Regular functions compute a value and return it, but
generators return an iterator that returns a stream of values.

You’re doubtless familiar with how regular function calls work in Python
or C. When you call a function, it gets a private namespace where its
local variables are created.  When the function reaches a ‘return’
statement, the local variables are destroyed and the value is returned
to the caller.  A later call to the same function creates a new private
namespace and a fresh set of local variables.  But, what if the local
variables weren’t thrown away on exiting a function?  What if you could
later resume the function where it left off?  This is what generators
provide; they can be thought of as resumable functions.

Here’s the simplest example of a generator function:

     >>> def generate_ints(N): ...    for i in range(N): ...        yield i

Any function containing a *note yield: 18f. keyword is a generator
function; this is detected by Python’s *note bytecode: 609. compiler
which compiles the function specially as a result.

When you call a generator function, it doesn’t return a single value;
instead it returns a generator object that supports the iterator
protocol.  On executing the ‘yield’ expression, the generator outputs
the value of ‘i’, similar to a ‘return’ statement.  The big difference
between ‘yield’ and a ‘return’ statement is that on reaching a ‘yield’
the generator’s state of execution is suspended and local variables are
preserved.  On the next call to the generator’s *note __next__(): 1213.
method, the function will resume executing.

Here’s a sample usage of the ‘generate_ints()’ generator:

     >>> gen = generate_ints(3) >>> gen  #doctest: +ELLIPSIS <generator object generate_ints at ...> >>> next(gen) 0 >>> next(gen) 1 >>> next(gen) 2 >>> next(gen) Traceback (most recent call last):   File "stdin", line 1, in <module>   File "stdin", line 2, in generate_ints StopIteration

You could equally write ‘for i in generate_ints(5)’, or ‘a, b, c =
generate_ints(3)’.

Inside a generator function, ‘return value’ causes
‘StopIteration(value)’ to be raised from the *note __next__(): 1213.
method.  Once this happens, or the bottom of the function is reached,
the procession of values ends and the generator cannot yield any further
values.

You could achieve the effect of generators manually by writing your own
class and storing all the local variables of the generator as instance
variables.  For example, returning a list of integers could be done by
setting ‘self.count’ to 0, and having the *note __next__(): c57. method
increment ‘self.count’ and return it.  However, for a moderately
complicated generator, writing a corresponding class can be much
messier.

The test suite included with Python’s library,
Lib/test/test_generators.py(1), contains a number of more interesting
examples.  Here’s one generator that implements an in-order traversal of
a tree using generators recursively.

     # A recursive generator that generates Tree leaves in in-order. def inorder(t):     if t:         for x in inorder(t.left):             yield x          yield t.label          for x in inorder(t.right):             yield x

Two other examples in ‘test_generators.py’ produce solutions for the
N-Queens problem (placing N queens on an NxN chess board so that no
queen threatens another) and the Knight’s Tour (finding a route that
takes a knight to every square of an NxN chessboard without visiting any
square twice).

* Menu:

* Passing values into a generator::

   ---------- Footnotes ----------

   (1) 
https://github.com/python/cpython/tree/3.8/Lib/test/test_generators.py


File: python.info,  Node: Passing values into a generator,  Up: Generators<2>

10.5.4.1 Passing values into a generator
........................................

In Python 2.4 and earlier, generators only produced output.  Once a
generator’s code was invoked to create an iterator, there was no way to
pass any new information into the function when its execution is
resumed.  You could hack together this ability by making the generator
look at a global variable or by passing in some mutable object that
callers then modify, but these approaches are messy.

In Python 2.5 there’s a simple way to pass values into a generator.
*note yield: 18f. became an expression, returning a value that can be
assigned to a variable or otherwise operated on:

     val = (yield i)

I recommend that you `always' put parentheses around a ‘yield’
expression when you’re doing something with the returned value, as in
the above example.  The parentheses aren’t always necessary, but it’s
easier to always add them instead of having to remember when they’re
needed.

( PEP 342(1) explains the exact rules, which are that a
‘yield’-expression must always be parenthesized except when it occurs at
the top-level expression on the right-hand side of an assignment.  This
means you can write ‘val = yield i’ but have to use parentheses when
there’s an operation, as in ‘val = (yield i) + 12’.)

Values are sent into a generator by calling its *note send(value): 13cb.
method.  This method resumes the generator’s code and the ‘yield’
expression returns the specified value.  If the regular *note
__next__(): 1213. method is called, the ‘yield’ returns ‘None’.

Here’s a simple counter that increments by 1 and allows changing the
value of the internal counter.

     def counter(maximum):     i = 0     while i < maximum:         val = (yield i)         # If value provided, change counter         if val is not None:             i = val         else:             i += 1

And here’s an example of changing the counter:

     >>> it = counter(10)  #doctest: +SKIP >>> next(it)  #doctest: +SKIP 0 >>> next(it)  #doctest: +SKIP 1 >>> it.send(8)  #doctest: +SKIP 8 >>> next(it)  #doctest: +SKIP 9 >>> next(it)  #doctest: +SKIP Traceback (most recent call last):   File "t.py", line 15, in <module>     it.next() StopIteration

Because ‘yield’ will often be returning ‘None’, you should always check
for this case.  Don’t just use its value in expressions unless you’re
sure that the *note send(): 13cb. method will be the only method used to
resume your generator function.

In addition to *note send(): 13cb, there are two other methods on
generators:

   * *note throw(type, value=None, traceback=None): 13cd. is used to
     raise an exception inside the generator; the exception is raised by
     the ‘yield’ expression where the generator’s execution is paused.

   * *note close(): 13cf. raises a *note GeneratorExit: d25. exception
     inside the generator to terminate the iteration.  On receiving this
     exception, the generator’s code must either raise *note
     GeneratorExit: d25. or *note StopIteration: 47b.; catching the
     exception and doing anything else is illegal and will trigger a
     *note RuntimeError: 2b8.  *note close(): 13cf. will also be called
     by Python’s garbage collector when the generator is
     garbage-collected.

     If you need to run cleanup code when a *note GeneratorExit: d25.
     occurs, I suggest using a ‘try: ... finally:’ suite instead of
     catching *note GeneratorExit: d25.

The cumulative effect of these changes is to turn generators from
one-way producers of information into both producers and consumers.

Generators also become `coroutines', a more generalized form of
subroutines.  Subroutines are entered at one point and exited at another
point (the top of the function, and a ‘return’ statement), but
coroutines can be entered, exited, and resumed at many different points
(the ‘yield’ statements).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0342


File: python.info,  Node: Built-in functions,  Next: The itertools module,  Prev: Generators<2>,  Up: Functional Programming HOWTO

10.5.5 Built-in functions
-------------------------

Let’s look in more detail at built-in functions often used with
iterators.

Two of Python’s built-in functions, *note map(): c20. and *note
filter(): c21. duplicate the features of generator expressions:

*note map(f, iterA, iterB, ...): c20. returns an iterator over the sequence

     ‘f(iterA[0], iterB[0]), f(iterA[1], iterB[1]), f(iterA[2],
     iterB[2]), ...’.

          >>> def upper(s): ...     return s.upper()

          >>> list(map(upper, ['sentence', 'fragment'])) ['SENTENCE', 'FRAGMENT'] >>> [upper(s) for s in ['sentence', 'fragment']] ['SENTENCE', 'FRAGMENT']

You can of course achieve the same effect with a list comprehension.

*note filter(predicate, iter): c21. returns an iterator over all the
sequence elements that meet a certain condition, and is similarly
duplicated by list comprehensions.  A `predicate' is a function that
returns the truth value of some condition; for use with *note filter():
c21, the predicate must take a single value.

     >>> def is_even(x): ...     return (x % 2) == 0

     >>> list(filter(is_even, range(10))) [0, 2, 4, 6, 8]

This can also be written as a list comprehension:

     >>> list(x for x in range(10) if is_even(x)) [0, 2, 4, 6, 8]

*note enumerate(iter, start=0): dd6. counts off the elements in the
iterable returning 2-tuples containing the count (from `start') and each
element.

     >>> for item in enumerate(['subject', 'verb', 'object']): ...     print(item) (0, 'subject') (1, 'verb') (2, 'object')

*note enumerate(): dd6. is often used when looping through a list and
recording the indexes at which certain conditions are met:

     f = open('data.txt', 'r') for i, line in enumerate(f):     if line.strip() == '':         print('Blank line at line #%i' % i)

*note sorted(iterable, key=None, reverse=False): 439. collects all the
elements of the iterable into a list, sorts the list, and returns the
sorted result.  The `key' and `reverse' arguments are passed through to
the constructed list’s *note sort(): 43a. method.

     >>> import random >>> # Generate 8 random numbers between [0, 10000) >>> rand_list = random.sample(range(10000), 8) >>> rand_list   [769, 7953, 9828, 6431, 8442, 9878, 6213, 2207] >>> sorted(rand_list)   [769, 2207, 6213, 6431, 7953, 8442, 9828, 9878] >>> sorted(rand_list, reverse=True)   [9878, 9828, 8442, 7953, 6431, 6213, 2207, 769]

(For a more detailed discussion of sorting, see the *note Sorting HOW
TO: 153c.)

The *note any(iter): d77. and *note all(iter): d78. built-ins look at
the truth values of an iterable’s contents.  *note any(): d77. returns
‘True’ if any element in the iterable is a true value, and *note all():
d78. returns ‘True’ if all of the elements are true values:

     >>> any([0, 1, 0]) True >>> any([0, 0, 0]) False >>> any([1, 1, 1]) True >>> all([0, 1, 0]) False >>> all([0, 0, 0]) False >>> all([1, 1, 1]) True

*note zip(iterA, iterB, ...): c25. takes one element from each iterable
and returns them in a tuple:

     zip(['a', 'b', 'c'], (1, 2, 3)) =>   ('a', 1), ('b', 2), ('c', 3)

It doesn’t construct an in-memory list and exhaust all the input
iterators before returning; instead tuples are constructed and returned
only if they’re requested.  (The technical term for this behaviour is
lazy evaluation(1).)

This iterator is intended to be used with iterables that are all of the
same length.  If the iterables are of different lengths, the resulting
stream will be the same length as the shortest iterable.

     zip(['a', 'b'], (1, 2, 3)) =>   ('a', 1), ('b', 2)

You should avoid doing this, though, because an element may be taken
from the longer iterators and discarded.  This means you can’t go on to
use the iterators further because you risk skipping a discarded element.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Lazy_evaluation


File: python.info,  Node: The itertools module,  Next: The functools module,  Prev: Built-in functions,  Up: Functional Programming HOWTO

10.5.6 The itertools module
---------------------------

The *note itertools: a3. module contains a number of commonly-used
iterators as well as functions for combining several iterators.  This
section will introduce the module’s contents by showing small examples.

The module’s functions fall into a few broad classes:

   * Functions that create a new iterator based on an existing iterator.

   * Functions for treating an iterator’s elements as function
     arguments.

   * Functions for selecting portions of an iterator’s output.

   * A function for grouping an iterator’s output.

* Menu:

* Creating new iterators::
* Calling functions on elements::
* Selecting elements::
* Combinatoric functions::
* Grouping elements::


File: python.info,  Node: Creating new iterators,  Next: Calling functions on elements,  Up: The itertools module

10.5.6.1 Creating new iterators
...............................

*note itertools.count(start, step): c0e. returns an infinite stream of
evenly spaced values.  You can optionally supply the starting number,
which defaults to 0, and the interval between numbers, which defaults to
1:

     itertools.count() =>   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... itertools.count(10) =>   10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ... itertools.count(10, 5) =>   10, 15, 20, 25, 30, 35, 40, 45, 50, 55, ...

*note itertools.cycle(iter): 1a73. saves a copy of the contents of a
provided iterable and returns a new iterator that returns its elements
from first to last.  The new iterator will repeat these elements
infinitely.

     itertools.cycle([1, 2, 3, 4, 5]) =>   1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ...

*note itertools.repeat(elem, [n]): feb. returns the provided element `n'
times, or returns the element endlessly if `n' is not provided.

     itertools.repeat('abc') =>   abc, abc, abc, abc, abc, abc, abc, abc, abc, abc, ... itertools.repeat('abc', 5) =>   abc, abc, abc, abc, abc

*note itertools.chain(iterA, iterB, ...): 153e. takes an arbitrary
number of iterables as input, and returns all the elements of the first
iterator, then all the elements of the second, and so on, until all of
the iterables have been exhausted.

     itertools.chain(['a', 'b', 'c'], (1, 2, 3)) =>   a, b, c, 1, 2, 3

*note itertools.islice(iter, [start], stop, [step]): 397. returns a
stream that’s a slice of the iterator.  With a single `stop' argument,
it will return the first `stop' elements.  If you supply a starting
index, you’ll get `stop-start' elements, and if you supply a value for
`step', elements will be skipped accordingly.  Unlike Python’s string
and list slicing, you can’t use negative values for `start', `stop', or
`step'.

     itertools.islice(range(10), 8) =>   0, 1, 2, 3, 4, 5, 6, 7 itertools.islice(range(10), 2, 8) =>   2, 3, 4, 5, 6, 7 itertools.islice(range(10), 2, 8, 2) =>   2, 4, 6

*note itertools.tee(iter, [n]): 1a78. replicates an iterator; it returns
`n' independent iterators that will all return the contents of the
source iterator.  If you don’t supply a value for `n', the default is 2.
Replicating iterators requires saving some of the contents of the source
iterator, so this can consume significant memory if the iterator is
large and one of the new iterators is consumed more than the others.

     itertools.tee( itertools.count() ) =>    iterA, iterB  where iterA ->    0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...  and   iterB ->    0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...


File: python.info,  Node: Calling functions on elements,  Next: Selecting elements,  Prev: Creating new iterators,  Up: The itertools module

10.5.6.2 Calling functions on elements
......................................

The *note operator: c2. module contains a set of functions corresponding
to Python’s operators.  Some examples are *note operator.add(a, b):
1a9a. (adds two values), *note operator.ne(a, b): 1a8a. (same as ‘a !=
b’), and *note operator.attrgetter(’id’): 70f. (returns a callable that
fetches the ‘.id’ attribute).

*note itertools.starmap(func, iter): a1d. assumes that the iterable will
return a stream of tuples, and calls `func' using these tuples as the
arguments:

     itertools.starmap(os.path.join,                   [('/bin', 'python'), ('/usr', 'bin', 'java'),                    ('/usr', 'bin', 'perl'), ('/usr', 'bin', 'ruby')]) =>   /bin/python, /usr/bin/java, /usr/bin/perl, /usr/bin/ruby


File: python.info,  Node: Selecting elements,  Next: Combinatoric functions,  Prev: Calling functions on elements,  Up: The itertools module

10.5.6.3 Selecting elements
...........................

Another group of functions chooses a subset of an iterator’s elements
based on a predicate.

*note itertools.filterfalse(predicate, iter): 1527. is the opposite of
*note filter(): c21, returning all elements for which the predicate
returns false:

     itertools.filterfalse(is_even, itertools.count()) =>   1, 3, 5, 7, 9, 11, 13, 15, ...

*note itertools.takewhile(predicate, iter): 1a77. returns elements for
as long as the predicate returns true.  Once the predicate returns
false, the iterator will signal the end of its results.

     def less_than_10(x):     return x < 10  itertools.takewhile(less_than_10, itertools.count()) =>   0, 1, 2, 3, 4, 5, 6, 7, 8, 9  itertools.takewhile(is_even, itertools.count()) =>   0

*note itertools.dropwhile(predicate, iter): 1a75. discards elements
while the predicate returns true, and then returns the rest of the
iterable’s results.

     itertools.dropwhile(less_than_10, itertools.count()) =>   10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ...  itertools.dropwhile(is_even, itertools.count()) =>   1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...

*note itertools.compress(data, selectors): c0d. takes two iterators and
returns only those elements of `data' for which the corresponding
element of `selectors' is true, stopping whenever either one is
exhausted:

     itertools.compress([1, 2, 3, 4, 5], [True, True, False, False, True]) =>    1, 2, 5


File: python.info,  Node: Combinatoric functions,  Next: Grouping elements,  Prev: Selecting elements,  Up: The itertools module

10.5.6.4 Combinatoric functions
...............................

The *note itertools.combinations(iterable, r): c99. returns an iterator
giving all possible `r'-tuple combinations of the elements contained in
`iterable'.

     itertools.combinations([1, 2, 3, 4, 5], 2) =>   (1, 2), (1, 3), (1, 4), (1, 5),   (2, 3), (2, 4), (2, 5),   (3, 4), (3, 5),   (4, 5)  itertools.combinations([1, 2, 3, 4, 5], 3) =>   (1, 2, 3), (1, 2, 4), (1, 2, 5), (1, 3, 4), (1, 3, 5), (1, 4, 5),   (2, 3, 4), (2, 3, 5), (2, 4, 5),   (3, 4, 5)

The elements within each tuple remain in the same order as `iterable'
returned them.  For example, the number 1 is always before 2, 3, 4, or 5
in the examples above.  A similar function, *note
itertools.permutations(iterable, r=None): 1a79, removes this constraint
on the order, returning all possible arrangements of length `r':

     itertools.permutations([1, 2, 3, 4, 5], 2) =>   (1, 2), (1, 3), (1, 4), (1, 5),   (2, 1), (2, 3), (2, 4), (2, 5),   (3, 1), (3, 2), (3, 4), (3, 5),   (4, 1), (4, 2), (4, 3), (4, 5),   (5, 1), (5, 2), (5, 3), (5, 4)  itertools.permutations([1, 2, 3, 4, 5]) =>   (1, 2, 3, 4, 5), (1, 2, 3, 5, 4), (1, 2, 4, 3, 5),   ...   (5, 4, 3, 2, 1)

If you don’t supply a value for `r' the length of the iterable is used,
meaning that all the elements are permuted.

Note that these functions produce all of the possible combinations by
position and don’t require that the contents of `iterable' are unique:

     itertools.permutations('aba', 3) =>   ('a', 'b', 'a'), ('a', 'a', 'b'), ('b', 'a', 'a'),   ('b', 'a', 'a'), ('a', 'a', 'b'), ('a', 'b', 'a')

The identical tuple ‘('a', 'a', 'b')’ occurs twice, but the two ‘a’
strings came from different positions.

The *note itertools.combinations_with_replacement(iterable, r): c0c.
function relaxes a different constraint: elements can be repeated within
a single tuple.  Conceptually an element is selected for the first
position of each tuple and then is replaced before the second element is
selected.

     itertools.combinations_with_replacement([1, 2, 3, 4, 5], 2) =>   (1, 1), (1, 2), (1, 3), (1, 4), (1, 5),   (2, 2), (2, 3), (2, 4), (2, 5),   (3, 3), (3, 4), (3, 5),   (4, 4), (4, 5),   (5, 5)


File: python.info,  Node: Grouping elements,  Prev: Combinatoric functions,  Up: The itertools module

10.5.6.5 Grouping elements
..........................

The last function I’ll discuss, *note itertools.groupby(iter,
key_func=None): 1a76, is the most complicated.  ‘key_func(elem)’ is a
function that can compute a key value for each element returned by the
iterable.  If you don’t supply a key function, the key is simply each
element itself.

*note groupby(): 1a76. collects all the consecutive elements from the
underlying iterable that have the same key value, and returns a stream
of 2-tuples containing a key value and an iterator for the elements with
that key.

     city_list = [('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL'),              ('Anchorage', 'AK'), ('Nome', 'AK'),              ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ'),              ...             ]  def get_state(city_state):     return city_state[1]  itertools.groupby(city_list, get_state) =>   ('AL', iterator-1),   ('AK', iterator-2),   ('AZ', iterator-3), ...  where iterator-1 =>   ('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL') iterator-2 =>   ('Anchorage', 'AK'), ('Nome', 'AK') iterator-3 =>   ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ')

*note groupby(): 1a76. assumes that the underlying iterable’s contents
will already be sorted based on the key.  Note that the returned
iterators also use the underlying iterable, so you have to consume the
results of iterator-1 before requesting iterator-2 and its corresponding
key.


File: python.info,  Node: The functools module,  Next: Small functions and the lambda expression,  Prev: The itertools module,  Up: Functional Programming HOWTO

10.5.7 The functools module
---------------------------

The *note functools: 85. module in Python 2.5 contains some higher-order
functions.  A `higher-order function' takes one or more functions as
input and returns a new function.  The most useful tool in this module
is the *note functools.partial(): 7bc. function.

For programs written in a functional style, you’ll sometimes want to
construct variants of existing functions that have some of the
parameters filled in.  Consider a Python function ‘f(a, b, c)’; you may
wish to create a new function ‘g(b, c)’ that’s equivalent to ‘f(1, b,
c)’; you’re filling in a value for one of ‘f()’’s parameters.  This is
called “partial function application”.

The constructor for *note partial(): 7bc. takes the arguments
‘(function, arg1, arg2, ..., kwarg1=value1, kwarg2=value2)’.  The
resulting object is callable, so you can just call it to invoke
‘function’ with the filled-in arguments.

Here’s a small but realistic example:

     import functools  def log(message, subsystem):     """Write the contents of 'message' to the specified subsystem."""     print('%s: %s' % (subsystem, message))     ...  server_log = functools.partial(log, subsystem='server') server_log('Unable to open socket')

*note functools.reduce(func, iter, [initial_value]): c62. cumulatively
performs an operation on all the iterable’s elements and, therefore,
can’t be applied to infinite iterables.  `func' must be a function that
takes two elements and returns a single value.  *note
functools.reduce(): c62. takes the first two elements A and B returned
by the iterator and calculates ‘func(A, B)’.  It then requests the third
element, C, calculates ‘func(func(A, B), C)’, combines this result with
the fourth element returned, and continues until the iterable is
exhausted.  If the iterable returns no values at all, a *note TypeError:
192. exception is raised.  If the initial value is supplied, it’s used
as a starting point and ‘func(initial_value, A)’ is the first
calculation.

     >>> import operator, functools >>> functools.reduce(operator.concat, ['A', 'BB', 'C']) 'ABBC' >>> functools.reduce(operator.concat, []) Traceback (most recent call last):   ... TypeError: reduce() of empty sequence with no initial value >>> functools.reduce(operator.mul, [1, 2, 3], 1) 6 >>> functools.reduce(operator.mul, [], 1) 1

If you use *note operator.add(): 1a9a. with *note functools.reduce():
c62, you’ll add up all the elements of the iterable.  This case is so
common that there’s a special built-in called *note sum(): 1e3. to
compute it:

     >>> import functools, operator >>> functools.reduce(operator.add, [1, 2, 3, 4], 0) 10 >>> sum([1, 2, 3, 4]) 10 >>> sum([]) 0

For many uses of *note functools.reduce(): c62, though, it can be
clearer to just write the obvious *note for: c23. loop:

     import functools # Instead of: product = functools.reduce(operator.mul, [1, 2, 3], 1)  # You can write: product = 1 for i in [1, 2, 3]:     product *= i

A related function is *note itertools.accumulate(iterable,
func=operator.add): 1db.  It performs the same calculation, but instead
of returning only the final result, ‘accumulate()’ returns an iterator
that also yields each partial result:

     itertools.accumulate([1, 2, 3, 4, 5]) =>   1, 3, 6, 10, 15  itertools.accumulate([1, 2, 3, 4, 5], operator.mul) =>   1, 2, 6, 24, 120

* Menu:

* The operator module::


File: python.info,  Node: The operator module,  Up: The functools module

10.5.7.1 The operator module
............................

The *note operator: c2. module was mentioned earlier.  It contains a set
of functions corresponding to Python’s operators.  These functions are
often useful in functional-style code because they save you from writing
trivial functions that perform a single operation.

Some of the functions in this module are:

   * Math operations: ‘add()’, ‘sub()’, ‘mul()’, ‘floordiv()’, ‘abs()’,
     …

   * Logical operations: ‘not_()’, ‘truth()’.

   * Bitwise operations: ‘and_()’, ‘or_()’, ‘invert()’.

   * Comparisons: ‘eq()’, ‘ne()’, ‘lt()’, ‘le()’, ‘gt()’, and ‘ge()’.

   * Object identity: ‘is_()’, ‘is_not()’.

Consult the operator module’s documentation for a complete list.


File: python.info,  Node: Small functions and the lambda expression,  Next: Revision History and Acknowledgements,  Prev: The functools module,  Up: Functional Programming HOWTO

10.5.8 Small functions and the lambda expression
------------------------------------------------

When writing functional-style programs, you’ll often need little
functions that act as predicates or that combine elements in some way.

If there’s a Python built-in or a module function that’s suitable, you
don’t need to define a new function at all:

     stripped_lines = [line.strip() for line in lines] existing_files = filter(os.path.exists, file_list)

If the function you need doesn’t exist, you need to write it.  One way
to write small functions is to use the *note lambda: c22. expression.
‘lambda’ takes a number of parameters and an expression combining these
parameters, and creates an anonymous function that returns the value of
the expression:

     adder = lambda x, y: x+y  print_assign = lambda name, value: name + '=' + str(value)

An alternative is to just use the ‘def’ statement and define a function
in the usual way:

     def adder(x, y):     return x + y  def print_assign(name, value):     return name + '=' + str(value)

Which alternative is preferable?  That’s a style question; my usual
course is to avoid using ‘lambda’.

One reason for my preference is that ‘lambda’ is quite limited in the
functions it can define.  The result has to be computable as a single
expression, which means you can’t have multiway ‘if... elif... else’
comparisons or ‘try... except’ statements.  If you try to do too much in
a ‘lambda’ statement, you’ll end up with an overly complicated
expression that’s hard to read.  Quick, what’s the following code doing?

     import functools total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1]

You can figure it out, but it takes time to disentangle the expression
to figure out what’s going on.  Using a short nested ‘def’ statements
makes things a little bit better:

     import functools def combine(a, b):     return 0, a[1] + b[1]  total = functools.reduce(combine, items)[1]

But it would be best of all if I had simply used a ‘for’ loop:

     total = 0 for a, b in items:     total += b

Or the *note sum(): 1e3. built-in and a generator expression:

     total = sum(b for a, b in items)

Many uses of *note functools.reduce(): c62. are clearer when written as
‘for’ loops.

Fredrik Lundh once suggested the following set of rules for refactoring
uses of ‘lambda’:

  1. Write a lambda function.

  2. Write a comment explaining what the heck that lambda does.

  3. Study the comment for a while, and think of a name that captures
     the essence of the comment.

  4. Convert the lambda to a def statement, using that name.

  5. Remove the comment.

I really like these rules, but you’re free to disagree about whether
this lambda-free style is better.


File: python.info,  Node: Revision History and Acknowledgements,  Next: References<2>,  Prev: Small functions and the lambda expression,  Up: Functional Programming HOWTO

10.5.9 Revision History and Acknowledgements
--------------------------------------------

The author would like to thank the following people for offering
suggestions, corrections and assistance with various drafts of this
article: Ian Bicking, Nick Coghlan, Nick Efford, Raymond Hettinger, Jim
Jewett, Mike Krell, Leandro Lameiro, Jussi Salmela, Collin Winter, Blake
Winton.

Version 0.1: posted June 30 2006.

Version 0.11: posted July 1 2006.  Typo fixes.

Version 0.2: posted July 10 2006.  Merged genexp and listcomp sections
into one.  Typo fixes.

Version 0.21: Added more references suggested on the tutor mailing list.

Version 0.30: Adds a section on the ‘functional’ module written by
Collin Winter; adds short section on the operator module; a few other
edits.


File: python.info,  Node: References<2>,  Prev: Revision History and Acknowledgements,  Up: Functional Programming HOWTO

10.5.10 References
------------------

* Menu:

* General::
* Python-specific::
* Python documentation::


File: python.info,  Node: General,  Next: Python-specific,  Up: References<2>

10.5.10.1 General
.................

`Structure and Interpretation of Computer Programs', by Harold Abelson
and Gerald Jay Sussman with Julie Sussman.  Full text at
‘https://mitpress.mit.edu/sicp/’.  In this classic textbook of computer
science, chapters 2 and 3 discuss the use of sequences and streams to
organize the data flow inside a program.  The book uses Scheme for its
examples, but many of the design approaches described in these chapters
are applicable to functional-style Python code.

‘http://www.defmacro.org/ramblings/fp.html’: A general introduction to
functional programming that uses Java examples and has a lengthy
historical introduction.

‘https://en.wikipedia.org/wiki/Functional_programming’: General
Wikipedia entry describing functional programming.

‘https://en.wikipedia.org/wiki/Coroutine’: Entry for coroutines.

‘https://en.wikipedia.org/wiki/Currying’: Entry for the concept of
currying.


File: python.info,  Node: Python-specific,  Next: Python documentation,  Prev: General,  Up: References<2>

10.5.10.2 Python-specific
.........................

‘http://gnosis.cx/TPiP/’: The first chapter of David Mertz’s book ‘Text
Processing in Python’ discusses functional programming for text
processing, in the section titled “Utilizing Higher-Order Functions in
Text Processing”.

Mertz also wrote a 3-part series of articles on functional programming
for IBM’s DeveloperWorks site; see part 1(1), part 2(2), and part 3(3),

   ---------- Footnotes ----------

   (1) 
https://www.ibm.com/developerworks/linux/library/l-prog/index.html

   (2) 
https://www.ibm.com/developerworks/linux/library/l-prog2/index.html

   (3) 
https://www.ibm.com/developerworks/linux/library/l-prog3/index.html


File: python.info,  Node: Python documentation,  Prev: Python-specific,  Up: References<2>

10.5.10.3 Python documentation
..............................

Documentation for the *note itertools: a3. module.

Documentation for the *note functools: 85. module.

Documentation for the *note operator: c2. module.

PEP 289(1): “Generator Expressions”

PEP 342(2): “Coroutines via Enhanced Generators” describes the new
generator features in Python 2.5.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0289

   (2) https://www.python.org/dev/peps/pep-0342


File: python.info,  Node: Logging HOWTO,  Next: Logging Cookbook,  Prev: Functional Programming HOWTO,  Up: Python HOWTOs

10.6 Logging HOWTO
==================


Author: Vinay Sajip <vinay_sajip at red-dove dot com>

* Menu:

* Basic Logging Tutorial::
* Advanced Logging Tutorial::
* Logging Levels: Logging Levels<2>.
* Useful Handlers::
* Exceptions raised during logging::
* Using arbitrary objects as messages::
* Optimization::


File: python.info,  Node: Basic Logging Tutorial,  Next: Advanced Logging Tutorial,  Up: Logging HOWTO

10.6.1 Basic Logging Tutorial
-----------------------------

Logging is a means of tracking events that happen when some software
runs.  The software’s developer adds logging calls to their code to
indicate that certain events have occurred.  An event is described by a
descriptive message which can optionally contain variable data (i.e.
data that is potentially different for each occurrence of the event).
Events also have an importance which the developer ascribes to the
event; the importance can also be called the `level' or `severity'.

* Menu:

* When to use logging::
* A simple example::
* Logging to a file::
* Logging from multiple modules::
* Logging variable data::
* Changing the format of displayed messages::
* Displaying the date/time in messages::
* Next Steps::


File: python.info,  Node: When to use logging,  Next: A simple example,  Up: Basic Logging Tutorial

10.6.1.1 When to use logging
............................

Logging provides a set of convenience functions for simple logging
usage.  These are *note debug(): 1fc7, *note info(): 1ff2, *note
warning(): 2004, *note error(): 2005. and *note critical(): 2006.  To
determine when to use logging, see the table below, which states, for
each of a set of common tasks, the best tool to use for it.

Task you want to perform                  The best tool for the task
                                          
-------------------------------------------------------------------------------------
                                          
Display console output for ordinary       *note print(): 87a.
usage of a command line script or         
program

Report events that occur during normal    *note logging.info(): 1ff2. (or
operation of a program (e.g.  for         *note logging.debug(): 1fc7. for very
status monitoring or fault                detailed output for diagnostic purposes)
investigation)                            

Issue a warning regarding a particular    *note warnings.warn(): e4b. in library
runtime event                             code if the issue is avoidable and the
                                          client application should be modified to
                                          eliminate the warning
                                          
                                          *note logging.warning(): 2004. if there
                                          is nothing the client application can do
                                          about the situation, but the event
                                          should still be noted
                                          
                                          
Report an error regarding a particular    Raise an exception
runtime event                             

Report suppression of an error without    *note logging.error(): 2005,
raising an exception (e.g.  error         *note logging.exception(): 2007. or
handler in a long-running server          *note logging.critical(): 2006. as
process)                                  appropriate for the specific error and
                                          application domain
                                          

The logging functions are named after the level or severity of the
events they are used to track.  The standard levels and their
applicability are described below (in increasing order of severity):

Level              When it’s used
                   
---------------------------------------------------------------------
                   
‘DEBUG’            Detailed information, typically of interest
                   only when diagnosing problems.
                   
                   
‘INFO’             Confirmation that things are working as
                   expected.
                   
                   
‘WARNING’          An indication that something unexpected
                   happened, or indicative of some problem in the
                   near future (e.g.  ‘disk space low’).  The
                   software is still working as expected.
                   
                   
‘ERROR’            Due to a more serious problem, the software has
                   not been able to perform some function.
                   
                   
‘CRITICAL’         A serious error, indicating that the program
                   itself may be unable to continue running.
                   

The default level is ‘WARNING’, which means that only events of this
level and above will be tracked, unless the logging package is
configured to do otherwise.

Events that are tracked can be handled in different ways.  The simplest
way of handling tracked events is to print them to the console.  Another
common way is to write them to a disk file.


File: python.info,  Node: A simple example,  Next: Logging to a file,  Prev: When to use logging,  Up: Basic Logging Tutorial

10.6.1.2 A simple example
.........................

A very simple example is:

     import logging logging.warning('Watch out!')  # will print a message to the console logging.info('I told you so')  # will not print anything

If you type these lines into a script and run it, you’ll see:

     WARNING:root:Watch out!

printed out on the console.  The ‘INFO’ message doesn’t appear because
the default level is ‘WARNING’.  The printed message includes the
indication of the level and the description of the event provided in the
logging call, i.e.  ‘Watch out!’.  Don’t worry about the ‘root’ part for
now: it will be explained later.  The actual output can be formatted
quite flexibly if you need that; formatting options will also be
explained later.


File: python.info,  Node: Logging to a file,  Next: Logging from multiple modules,  Prev: A simple example,  Up: Basic Logging Tutorial

10.6.1.3 Logging to a file
..........................

A very common situation is that of recording logging events in a file,
so let’s look at that next.  Be sure to try the following in a
newly-started Python interpreter, and don’t just continue from the
session described above:

     import logging logging.basicConfig(filename='example.log',level=logging.DEBUG) logging.debug('This message should go to the log file') logging.info('So should this') logging.warning('And this, too')

And now if we open the file and look at what we have, we should find the
log messages:

     DEBUG:root:This message should go to the log file INFO:root:So should this WARNING:root:And this, too

This example also shows how you can set the logging level which acts as
the threshold for tracking.  In this case, because we set the threshold
to ‘DEBUG’, all of the messages were printed.

If you want to set the logging level from a command-line option such as:

     --log=INFO

and you have the value of the parameter passed for ‘--log’ in some
variable `loglevel', you can use:

     getattr(logging, loglevel.upper())

to get the value which you’ll pass to *note basicConfig(): 1de. via the
`level' argument.  You may want to error check any user input value,
perhaps as in the following example:

     # assuming loglevel is bound to the string value obtained from the # command line argument. Convert to upper case to allow the user to # specify --log=DEBUG or --log=debug numeric_level = getattr(logging, loglevel.upper(), None) if not isinstance(numeric_level, int):     raise ValueError('Invalid log level: %s' % loglevel) logging.basicConfig(level=numeric_level, ...)

The call to *note basicConfig(): 1de. should come `before' any calls to
*note debug(): 1fc7, *note info(): 1ff2. etc.  As it’s intended as a
one-off simple configuration facility, only the first call will actually
do anything: subsequent calls are effectively no-ops.

If you run the above script several times, the messages from successive
runs are appended to the file `example.log'.  If you want each run to
start afresh, not remembering the messages from earlier runs, you can
specify the `filemode' argument, by changing the call in the above
example to:

     logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)

The output will be the same as before, but the log file is no longer
appended to, so the messages from earlier runs are lost.


File: python.info,  Node: Logging from multiple modules,  Next: Logging variable data,  Prev: Logging to a file,  Up: Basic Logging Tutorial

10.6.1.4 Logging from multiple modules
......................................

If your program consists of multiple modules, here’s an example of how
you could organize logging in it:

     # myapp.py import logging import mylib  def main():     logging.basicConfig(filename='myapp.log', level=logging.INFO)     logging.info('Started')     mylib.do_something()     logging.info('Finished')  if __name__ == '__main__':     main()

     # mylib.py import logging  def do_something():     logging.info('Doing something')

If you run `myapp.py', you should see this in `myapp.log':

     INFO:root:Started INFO:root:Doing something INFO:root:Finished

which is hopefully what you were expecting to see.  You can generalize
this to multiple modules, using the pattern in `mylib.py'.  Note that
for this simple usage pattern, you won’t know, by looking in the log
file, `where' in your application your messages came from, apart from
looking at the event description.  If you want to track the location of
your messages, you’ll need to refer to the documentation beyond the
tutorial level – see *note Advanced Logging Tutorial: b66.


File: python.info,  Node: Logging variable data,  Next: Changing the format of displayed messages,  Prev: Logging from multiple modules,  Up: Basic Logging Tutorial

10.6.1.5 Logging variable data
..............................

To log variable data, use a format string for the event description
message and append the variable data as arguments.  For example:

     import logging logging.warning('%s before you %s', 'Look', 'leap!')

will display:

     WARNING:root:Look before you leap!

As you can see, merging of variable data into the event description
message uses the old, %-style of string formatting.  This is for
backwards compatibility: the logging package pre-dates newer formatting
options such as *note str.format(): 4cf. and *note string.Template: 3e0.
These newer formatting options `are' supported, but exploring them is
outside the scope of this tutorial: see *note Using particular
formatting styles throughout your application: 1fea. for more
information.


File: python.info,  Node: Changing the format of displayed messages,  Next: Displaying the date/time in messages,  Prev: Logging variable data,  Up: Basic Logging Tutorial

10.6.1.6 Changing the format of displayed messages
..................................................

To change the format which is used to display messages, you need to
specify the format you want to use:

     import logging logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG) logging.debug('This message should appear on the console') logging.info('So should this') logging.warning('And this, too')

which would print:

     DEBUG:This message should appear on the console INFO:So should this WARNING:And this, too

Notice that the ‘root’ which appeared in earlier examples has
disappeared.  For a full set of things that can appear in format
strings, you can refer to the documentation for *note LogRecord
attributes: 1fe8, but for simple usage, you just need the `levelname'
(severity), `message' (event description, including variable data) and
perhaps to display when the event occurred.  This is described in the
next section.


File: python.info,  Node: Displaying the date/time in messages,  Next: Next Steps,  Prev: Changing the format of displayed messages,  Up: Basic Logging Tutorial

10.6.1.7 Displaying the date/time in messages
.............................................

To display the date and time of an event, you would place ‘%(asctime)s’
in your format string:

     import logging logging.basicConfig(format='%(asctime)s %(message)s') logging.warning('is when this event was logged.')

which should print something like this:

     2010-12-12 11:41:42,612 is when this event was logged.

The default format for date/time display (shown above) is like ISO8601
or RFC 3339(1).  If you need more control over the formatting of the
date/time, provide a `datefmt' argument to ‘basicConfig’, as in this
example:

     import logging logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p') logging.warning('is when this event was logged.')

which would display something like this:

     12/12/2010 11:46:36 AM is when this event was logged.

The format of the `datefmt' argument is the same as supported by *note
time.strftime(): b58.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc3339.html


File: python.info,  Node: Next Steps,  Prev: Displaying the date/time in messages,  Up: Basic Logging Tutorial

10.6.1.8 Next Steps
...................

That concludes the basic tutorial.  It should be enough to get you up
and running with logging.  There’s a lot more that the logging package
offers, but to get the best out of it, you’ll need to invest a little
more of your time in reading the following sections.  If you’re ready
for that, grab some of your favourite beverage and carry on.

If your logging needs are simple, then use the above examples to
incorporate logging into your own scripts, and if you run into problems
or don’t understand something, please post a question on the
comp.lang.python Usenet group (available at
‘https://groups.google.com/forum/#!forum/comp.lang.python’) and you
should receive help before too long.

Still here?  You can carry on reading the next few sections, which
provide a slightly more advanced/in-depth tutorial than the basic one
above.  After that, you can take a look at the *note Logging Cookbook:
b67.


File: python.info,  Node: Advanced Logging Tutorial,  Next: Logging Levels<2>,  Prev: Basic Logging Tutorial,  Up: Logging HOWTO

10.6.2 Advanced Logging Tutorial
--------------------------------

The logging library takes a modular approach and offers several
categories of components: loggers, handlers, filters, and formatters.

   * Loggers expose the interface that application code directly uses.

   * Handlers send the log records (created by loggers) to the
     appropriate destination.

   * Filters provide a finer grained facility for determining which log
     records to output.

   * Formatters specify the layout of log records in the final output.

Log event information is passed between loggers, handlers, filters and
formatters in a *note LogRecord: 8fa. instance.

Logging is performed by calling methods on instances of the *note
Logger: 39c. class (hereafter called `loggers').  Each instance has a
name, and they are conceptually arranged in a namespace hierarchy using
dots (periods) as separators.  For example, a logger named ‘scan’ is the
parent of loggers ‘scan.text’, ‘scan.html’ and ‘scan.pdf’.  Logger names
can be anything you want, and indicate the area of an application in
which a logged message originates.

A good convention to use when naming loggers is to use a module-level
logger, in each module which uses logging, named as follows:

     logger = logging.getLogger(__name__)

This means that logger names track the package/module hierarchy, and
it’s intuitively obvious where events are logged just from the logger
name.

The root of the hierarchy of loggers is called the root logger.  That’s
the logger used by the functions *note debug(): 1fc7, *note info():
1ff2, *note warning(): 2004, *note error(): 2005. and *note critical():
2006, which just call the same-named method of the root logger.  The
functions and the methods have the same signatures.  The root logger’s
name is printed as ‘root’ in the logged output.

It is, of course, possible to log messages to different destinations.
Support is included in the package for writing log messages to files,
HTTP GET/POST locations, email via SMTP, generic sockets, queues, or
OS-specific logging mechanisms such as syslog or the Windows NT event
log.  Destinations are served by `handler' classes.  You can create your
own log destination class if you have special requirements not met by
any of the built-in handler classes.

By default, no destination is set for any logging messages.  You can
specify a destination (such as console or file) by using *note
basicConfig(): 1de. as in the tutorial examples.  If you call the
functions *note debug(): 1fc7, *note info(): 1ff2, *note warning():
2004, *note error(): 2005. and *note critical(): 2006, they will check
to see if no destination is set; and if one is not set, they will set a
destination of the console (‘sys.stderr’) and a default format for the
displayed message before delegating to the root logger to do the actual
message output.

The default format set by *note basicConfig(): 1de. for messages is:

     severity:logger name:message

You can change this by passing a format string to *note basicConfig():
1de. with the `format' keyword argument.  For all options regarding how
a format string is constructed, see *note Formatter Objects: 1fe6.

* Menu:

* Logging Flow::
* Loggers::
* Handlers::
* Formatters::
* Configuring Logging::
* What happens if no configuration is provided::
* Configuring Logging for a Library::


File: python.info,  Node: Logging Flow,  Next: Loggers,  Up: Advanced Logging Tutorial

10.6.2.1 Logging Flow
.....................

The flow of log event information in loggers and handlers is illustrated
in the following diagram.

[python-figures/logging_flow]

File: python.info,  Node: Loggers,  Next: Handlers,  Prev: Logging Flow,  Up: Advanced Logging Tutorial

10.6.2.2 Loggers
................

*note Logger: 39c. objects have a threefold job.  First, they expose
several methods to application code so that applications can log
messages at runtime.  Second, logger objects determine which log
messages to act upon based upon severity (the default filtering
facility) or filter objects.  Third, logger objects pass along relevant
log messages to all interested log handlers.

The most widely used methods on logger objects fall into two categories:
configuration and message sending.

These are the most common configuration methods:

   * *note Logger.setLevel(): 1fc0. specifies the lowest-severity log
     message a logger will handle, where debug is the lowest built-in
     severity level and critical is the highest built-in severity.  For
     example, if the severity level is INFO, the logger will handle only
     INFO, WARNING, ERROR, and CRITICAL messages and will ignore DEBUG
     messages.

   * *note Logger.addHandler(): 1fcd. and *note Logger.removeHandler():
     1fce. add and remove handler objects from the logger object.
     Handlers are covered in more detail in *note Handlers: 409a.

   * *note Logger.addFilter(): 1fca. and *note Logger.removeFilter():
     1fcb. add and remove filter objects from the logger object.
     Filters are covered in more detail in *note Filter Objects: 1fef.

You don’t need to always call these methods on every logger you create.
See the last two paragraphs in this section.

With the logger object configured, the following methods create log
messages:

   * *note Logger.debug(): 704, *note Logger.info(): 1fc6, *note
     Logger.warning(): 1fc8, *note Logger.error(): 1fc9, and *note
     Logger.critical(): 703. all create log records with a message and a
     level that corresponds to their respective method names.  The
     message is actually a format string, which may contain the standard
     string substitution syntax of ‘%s’, ‘%d’, ‘%f’, and so on.  The
     rest of their arguments is a list of objects that correspond with
     the substitution fields in the message.  With regard to ‘**kwargs’,
     the logging methods care only about a keyword of ‘exc_info’ and use
     it to determine whether to log exception information.

   * *note Logger.exception(): 702. creates a log message similar to
     *note Logger.error(): 1fc9.  The difference is that *note
     Logger.exception(): 702. dumps a stack trace along with it.  Call
     this method only from an exception handler.

   * *note Logger.log(): 701. takes a log level as an explicit argument.
     This is a little more verbose for logging messages than using the
     log level convenience methods listed above, but this is how to log
     at custom log levels.

*note getLogger(): 1fbe. returns a reference to a logger instance with
the specified name if it is provided, or ‘root’ if not.  The names are
period-separated hierarchical structures.  Multiple calls to *note
getLogger(): 1fbe. with the same name will return a reference to the
same logger object.  Loggers that are further down in the hierarchical
list are children of loggers higher up in the list.  For example, given
a logger with a name of ‘foo’, loggers with names of ‘foo.bar’,
‘foo.bar.baz’, and ‘foo.bam’ are all descendants of ‘foo’.

Loggers have a concept of `effective level'.  If a level is not
explicitly set on a logger, the level of its parent is used instead as
its effective level.  If the parent has no explicit level set, `its'
parent is examined, and so on - all ancestors are searched until an
explicitly set level is found.  The root logger always has an explicit
level set (‘WARNING’ by default).  When deciding whether to process an
event, the effective level of the logger is used to determine whether
the event is passed to the logger’s handlers.

Child loggers propagate messages up to the handlers associated with
their ancestor loggers.  Because of this, it is unnecessary to define
and configure handlers for all the loggers an application uses.  It is
sufficient to configure handlers for a top-level logger and create child
loggers as needed.  (You can, however, turn off propagation by setting
the `propagate' attribute of a logger to ‘False’.)


File: python.info,  Node: Handlers,  Next: Formatters,  Prev: Loggers,  Up: Advanced Logging Tutorial

10.6.2.3 Handlers
.................

*note Handler: 1fc5. objects are responsible for dispatching the
appropriate log messages (based on the log messages’ severity) to the
handler’s specified destination.  *note Logger: 39c. objects can add
zero or more handler objects to themselves with an *note addHandler():
1fcd. method.  As an example scenario, an application may want to send
all log messages to a log file, all log messages of error or higher to
stdout, and all messages of critical to an email address.  This scenario
requires three individual handlers where each handler is responsible for
sending messages of a specific severity to a specific location.

The standard library includes quite a few handler types (see *note
Useful Handlers: 409c.); the tutorials use mainly *note StreamHandler:
b68. and *note FileHandler: 202a. in its examples.

There are very few methods in a handler for application developers to
concern themselves with.  The only handler methods that seem relevant
for application developers who are using the built-in handler objects
(that is, not creating custom handlers) are the following configuration
methods:

   * The *note setLevel(): 1fda. method, just as in logger objects,
     specifies the lowest severity that will be dispatched to the
     appropriate destination.  Why are there two ‘setLevel()’ methods?
     The level set in the logger determines which severity of messages
     it will pass to its handlers.  The level set in each handler
     determines which messages that handler will send on.

   * *note setFormatter(): 1fdb. selects a Formatter object for this
     handler to use.

   * *note addFilter(): 1fdc. and *note removeFilter(): 1fdd.
     respectively configure and deconfigure filter objects on handlers.

Application code should not directly instantiate and use instances of
*note Handler: 1fc5.  Instead, the *note Handler: 1fc5. class is a base
class that defines the interface that all handlers should have and
establishes some default behavior that child classes can use (or
override).


File: python.info,  Node: Formatters,  Next: Configuring Logging,  Prev: Handlers,  Up: Advanced Logging Tutorial

10.6.2.4 Formatters
...................

Formatter objects configure the final order, structure, and contents of
the log message.  Unlike the base *note logging.Handler: 1fc5. class,
application code may instantiate formatter classes, although you could
likely subclass the formatter if your application needs special
behavior.  The constructor takes three optional arguments – a message
format string, a date format string and a style indicator.

 -- Method: logging.Formatter.__init__ (fmt=None, datefmt=None,
          style='%')

If there is no message format string, the default is to use the raw
message.  If there is no date format string, the default date format is:

     %Y-%m-%d %H:%M:%S

with the milliseconds tacked on at the end.  The ‘style’ is one of ‘%’,
‘{‘ or ‘$’.  If one of these is not specified, then ‘%’ will be used.

If the ‘style’ is ‘%’, the message format string uses ‘%(<dictionary
key>)s’ styled string substitution; the possible keys are documented in
*note LogRecord attributes: 1fe8.  If the style is ‘{‘, the message
format string is assumed to be compatible with *note str.format(): 4cf.
(using keyword arguments), while if the style is ‘$’ then the message
format string should conform to what is expected by *note
string.Template.substitute(): 1238.

Changed in version 3.2: Added the ‘style’ parameter.

The following message format string will log the time in a
human-readable format, the severity of the message, and the contents of
the message, in that order:

     '%(asctime)s - %(levelname)s - %(message)s'

Formatters use a user-configurable function to convert the creation time
of a record to a tuple.  By default, *note time.localtime(): 17ea. is
used; to change this for a particular formatter instance, set the
‘converter’ attribute of the instance to a function with the same
signature as *note time.localtime(): 17ea. or *note time.gmtime(): b32.
To change it for all formatters, for example if you want all logging
times to be shown in GMT, set the ‘converter’ attribute in the Formatter
class (to ‘time.gmtime’ for GMT display).


File: python.info,  Node: Configuring Logging,  Next: What happens if no configuration is provided,  Prev: Formatters,  Up: Advanced Logging Tutorial

10.6.2.5 Configuring Logging
............................

Programmers can configure logging in three ways:

  1. Creating loggers, handlers, and formatters explicitly using Python
     code that calls the configuration methods listed above.

  2. Creating a logging config file and reading it using the *note
     fileConfig(): 39e. function.

  3. Creating a dictionary of configuration information and passing it
     to the *note dictConfig(): b1e. function.

For the reference documentation on the last two options, see *note
Configuration functions: c7b.  The following example configures a very
simple logger, a console handler, and a simple formatter using Python
code:

     import logging  # create logger logger = logging.getLogger('simple_example') logger.setLevel(logging.DEBUG)  # create console handler and set level to debug ch = logging.StreamHandler() ch.setLevel(logging.DEBUG)  # create formatter formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')  # add formatter to ch ch.setFormatter(formatter)  # add ch to logger logger.addHandler(ch)  # 'application' code logger.debug('debug message') logger.info('info message') logger.warning('warn message') logger.error('error message') logger.critical('critical message')

Running this module from the command line produces the following output:

     $ python simple_logging_module.py 2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message 2005-03-19 15:10:26,620 - simple_example - INFO - info message 2005-03-19 15:10:26,695 - simple_example - WARNING - warn message 2005-03-19 15:10:26,697 - simple_example - ERROR - error message 2005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message

The following Python module creates a logger, handler, and formatter
nearly identical to those in the example listed above, with the only
difference being the names of the objects:

     import logging import logging.config  logging.config.fileConfig('logging.conf')  # create logger logger = logging.getLogger('simpleExample')  # 'application' code logger.debug('debug message') logger.info('info message') logger.warning('warn message') logger.error('error message') logger.critical('critical message')

Here is the logging.conf file:

     [loggers] keys=root,simpleExample  [handlers] keys=consoleHandler  [formatters] keys=simpleFormatter  [logger_root] level=DEBUG handlers=consoleHandler  [logger_simpleExample] level=DEBUG handlers=consoleHandler qualname=simpleExample propagate=0  [handler_consoleHandler] class=StreamHandler level=DEBUG formatter=simpleFormatter args=(sys.stdout,)  [formatter_simpleFormatter] format=%(asctime)s - %(name)s - %(levelname)s - %(message)s datefmt=

The output is nearly identical to that of the non-config-file-based
example:

     $ python simple_logging_config.py 2005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message 2005-03-19 15:38:55,979 - simpleExample - INFO - info message 2005-03-19 15:38:56,054 - simpleExample - WARNING - warn message 2005-03-19 15:38:56,055 - simpleExample - ERROR - error message 2005-03-19 15:38:56,130 - simpleExample - CRITICAL - critical message

You can see that the config file approach has a few advantages over the
Python code approach, mainly separation of configuration and code and
the ability of noncoders to easily modify the logging properties.

     Warning: The *note fileConfig(): 39e. function takes a default
     parameter, ‘disable_existing_loggers’, which defaults to ‘True’ for
     reasons of backward compatibility.  This may or may not be what you
     want, since it will cause any non-root loggers existing before the
     *note fileConfig(): 39e. call to be disabled unless they (or an
     ancestor) are explicitly named in the configuration.  Please refer
     to the reference documentation for more information, and specify
     ‘False’ for this parameter if you wish.

     The dictionary passed to *note dictConfig(): b1e. can also specify
     a Boolean value with key ‘disable_existing_loggers’, which if not
     specified explicitly in the dictionary also defaults to being
     interpreted as ‘True’.  This leads to the logger-disabling
     behaviour described above, which may not be what you want - in
     which case, provide the key explicitly with a value of ‘False’.

Note that the class names referenced in config files need to be either
relative to the logging module, or absolute values which can be resolved
using normal import mechanisms.  Thus, you could use either *note
WatchedFileHandler: 203b. (relative to the logging module) or
‘mypackage.mymodule.MyHandler’ (for a class defined in package
‘mypackage’ and module ‘mymodule’, where ‘mypackage’ is available on the
Python import path).

In Python 3.2, a new means of configuring logging has been introduced,
using dictionaries to hold configuration information.  This provides a
superset of the functionality of the config-file-based approach outlined
above, and is the recommended configuration method for new applications
and deployments.  Because a Python dictionary is used to hold
configuration information, and since you can populate that dictionary
using different means, you have more options for configuration.  For
example, you can use a configuration file in JSON format, or, if you
have access to YAML processing functionality, a file in YAML format, to
populate the configuration dictionary.  Or, of course, you can construct
the dictionary in Python code, receive it in pickled form over a socket,
or use whatever approach makes sense for your application.

Here’s an example of the same configuration as above, in YAML format for
the new dictionary-based approach:

     version: 1 formatters:   simple:     format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s' handlers:   console:     class: logging.StreamHandler     level: DEBUG     formatter: simple     stream: ext://sys.stdout loggers:   simpleExample:     level: DEBUG     handlers: [console]     propagate: no root:   level: DEBUG   handlers: [console]

For more information about logging using a dictionary, see *note
Configuration functions: c7b.


File: python.info,  Node: What happens if no configuration is provided,  Next: Configuring Logging for a Library,  Prev: Configuring Logging,  Up: Advanced Logging Tutorial

10.6.2.6 What happens if no configuration is provided
.....................................................

If no logging configuration is provided, it is possible to have a
situation where a logging event needs to be output, but no handlers can
be found to output the event.  The behaviour of the logging package in
these circumstances is dependent on the Python version.

For versions of Python prior to 3.2, the behaviour is as follows:

   * If `logging.raiseExceptions' is ‘False’ (production mode), the
     event is silently dropped.

   * If `logging.raiseExceptions' is ‘True’ (development mode), a
     message ‘No handlers could be found for logger X.Y.Z’ is printed
     once.

In Python 3.2 and later, the behaviour is as follows:

   * The event is output using a ‘handler of last resort’, stored in
     ‘logging.lastResort’.  This internal handler is not associated with
     any logger, and acts like a *note StreamHandler: b68. which writes
     the event description message to the current value of ‘sys.stderr’
     (therefore respecting any redirections which may be in effect).  No
     formatting is done on the message - just the bare event description
     message is printed.  The handler’s level is set to ‘WARNING’, so
     all events at this and greater severities will be output.

To obtain the pre-3.2 behaviour, ‘logging.lastResort’ can be set to
‘None’.


File: python.info,  Node: Configuring Logging for a Library,  Prev: What happens if no configuration is provided,  Up: Advanced Logging Tutorial

10.6.2.7 Configuring Logging for a Library
..........................................

When developing a library which uses logging, you should take care to
document how the library uses logging - for example, the names of
loggers used.  Some consideration also needs to be given to its logging
configuration.  If the using application does not use logging, and
library code makes logging calls, then (as described in the previous
section) events of severity ‘WARNING’ and greater will be printed to
‘sys.stderr’.  This is regarded as the best default behaviour.

If for some reason you `don’t' want these messages printed in the
absence of any logging configuration, you can attach a do-nothing
handler to the top-level logger for your library.  This avoids the
message being printed, since a handler will always be found for the
library’s events: it just doesn’t produce any output.  If the library
user configures logging for application use, presumably that
configuration will add some handlers, and if levels are suitably
configured then logging calls made in library code will send output to
those handlers, as normal.

A do-nothing handler is included in the logging package: *note
NullHandler: c0f. (since Python 3.1).  An instance of this handler could
be added to the top-level logger of the logging namespace used by the
library (`if' you want to prevent your library’s logged events being
output to ‘sys.stderr’ in the absence of logging configuration).  If all
logging by a library `foo' is done using loggers with names matching
‘foo.x’, ‘foo.x.y’, etc.  then the code:

     import logging logging.getLogger('foo').addHandler(logging.NullHandler())

should have the desired effect.  If an organisation produces a number of
libraries, then the logger name specified can be ‘orgname.foo’ rather
than just ‘foo’.

     Note: It is strongly advised that you `do not add any handlers
     other than' *note NullHandler: c0f. `to your library’s loggers'.
     This is because the configuration of handlers is the prerogative of
     the application developer who uses your library.  The application
     developer knows their target audience and what handlers are most
     appropriate for their application: if you add handlers ‘under the
     hood’, you might well interfere with their ability to carry out
     unit tests and deliver logs which suit their requirements.


File: python.info,  Node: Logging Levels<2>,  Next: Useful Handlers,  Prev: Advanced Logging Tutorial,  Up: Logging HOWTO

10.6.3 Logging Levels
---------------------

The numeric values of logging levels are given in the following table.
These are primarily of interest if you want to define your own levels,
and need them to have specific values relative to the predefined levels.
If you define a level with the same numeric value, it overwrites the
predefined value; the predefined name is lost.

Level              Numeric value
                   
---------------------------------------
                   
‘CRITICAL’         50
                   
                   
‘ERROR’            40
                   
                   
‘WARNING’          30
                   
                   
‘INFO’             20
                   
                   
‘DEBUG’            10
                   
                   
‘NOTSET’           0
                   

Levels can also be associated with loggers, being set either by the
developer or through loading a saved logging configuration.  When a
logging method is called on a logger, the logger compares its own level
with the level associated with the method call.  If the logger’s level
is higher than the method call’s, no logging message is actually
generated.  This is the basic mechanism controlling the verbosity of
logging output.

Logging messages are encoded as instances of the *note LogRecord: 8fa.
class.  When a logger decides to actually log an event, a *note
LogRecord: 8fa. instance is created from the logging message.

Logging messages are subjected to a dispatch mechanism through the use
of `handlers', which are instances of subclasses of the *note Handler:
1fc5. class.  Handlers are responsible for ensuring that a logged
message (in the form of a *note LogRecord: 8fa.) ends up in a particular
location (or set of locations) which is useful for the target audience
for that message (such as end users, support desk staff, system
administrators, developers).  Handlers are passed *note LogRecord: 8fa.
instances intended for particular destinations.  Each logger can have
zero, one or more handlers associated with it (via the *note
addHandler(): 1fcd. method of *note Logger: 39c.).  In addition to any
handlers directly associated with a logger, `all handlers associated
with all ancestors of the logger' are called to dispatch the message
(unless the `propagate' flag for a logger is set to a false value, at
which point the passing to ancestor handlers stops).

Just as for loggers, handlers can have levels associated with them.  A
handler’s level acts as a filter in the same way as a logger’s level
does.  If a handler decides to actually dispatch an event, the *note
emit(): 1fe4. method is used to send the message to its destination.
Most user-defined subclasses of *note Handler: 1fc5. will need to
override this *note emit(): 1fe4.

* Menu:

* Custom Levels::


File: python.info,  Node: Custom Levels,  Up: Logging Levels<2>

10.6.3.1 Custom Levels
......................

Defining your own levels is possible, but should not be necessary, as
the existing levels have been chosen on the basis of practical
experience.  However, if you are convinced that you need custom levels,
great care should be exercised when doing this, and it is possibly `a
very bad idea to define custom levels if you are developing a library'.
That’s because if multiple library authors all define their own custom
levels, there is a chance that the logging output from such multiple
libraries used together will be difficult for the using developer to
control and/or interpret, because a given numeric value might mean
different things for different libraries.


File: python.info,  Node: Useful Handlers,  Next: Exceptions raised during logging,  Prev: Logging Levels<2>,  Up: Logging HOWTO

10.6.4 Useful Handlers
----------------------

In addition to the base *note Handler: 1fc5. class, many useful
subclasses are provided:

  1. *note StreamHandler: b68. instances send messages to streams
     (file-like objects).

  2. *note FileHandler: 202a. instances send messages to disk files.

  3. *note BaseRotatingHandler: 203f. is the base class for handlers
     that rotate log files at a certain point.  It is not meant to be
     instantiated directly.  Instead, use *note RotatingFileHandler:
     201b. or *note TimedRotatingFileHandler: 862.

  4. *note RotatingFileHandler: 201b. instances send messages to disk
     files, with support for maximum log file sizes and log file
     rotation.

  5. *note TimedRotatingFileHandler: 862. instances send messages to
     disk files, rotating the log file at certain timed intervals.

  6. *note SocketHandler: 863. instances send messages to TCP/IP
     sockets.  Since 3.4, Unix domain sockets are also supported.

  7. *note DatagramHandler: 864. instances send messages to UDP sockets.
     Since 3.4, Unix domain sockets are also supported.

  8. *note SMTPHandler: 206b. instances send messages to a designated
     email address.

  9. *note SysLogHandler: a13. instances send messages to a Unix syslog
     daemon, possibly on a remote machine.

  10. *note NTEventLogHandler: 2063. instances send messages to a
     Windows NT/2000/XP event log.

  11. *note MemoryHandler: 2024. instances send messages to a buffer in
     memory, which is flushed whenever specific criteria are met.

  12. *note HTTPHandler: 705. instances send messages to an HTTP server
     using either ‘GET’ or ‘POST’ semantics.

  13. *note WatchedFileHandler: 203b. instances watch the file they are
     logging to.  If the file changes, it is closed and reopened using
     the file name.  This handler is only useful on Unix-like systems;
     Windows does not support the underlying mechanism used.

  14. *note QueueHandler: 207e. instances send messages to a queue, such
     as those implemented in the *note queue: da. or *note
     multiprocessing: b7. modules.

  15. *note NullHandler: c0f. instances do nothing with error messages.
     They are used by library developers who want to use logging, but
     want to avoid the ‘No handlers could be found for logger XXX’
     message which can be displayed if the library user has not
     configured logging.  See *note Configuring Logging for a Library:
     2038. for more information.

New in version 3.1: The *note NullHandler: c0f. class.

New in version 3.2: The *note QueueHandler: 207e. class.

The *note NullHandler: c0f, *note StreamHandler: b68. and *note
FileHandler: 202a. classes are defined in the core logging package.  The
other handlers are defined in a sub-module, *note logging.handlers: ac.
(There is also another sub-module, *note logging.config: ab, for
configuration functionality.)

Logged messages are formatted for presentation through instances of the
*note Formatter: 1fc4. class.  They are initialized with a format string
suitable for use with the % operator and a dictionary.

For formatting multiple messages in a batch, instances of
‘BufferingFormatter’ can be used.  In addition to the format string
(which is applied to each message in the batch), there is provision for
header and trailer format strings.

When filtering based on logger level and/or handler level is not enough,
instances of *note Filter: b6a. can be added to both *note Logger: 39c.
and *note Handler: 1fc5. instances (through their *note addFilter():
1fdc. method).  Before deciding to process a message further, both
loggers and handlers consult all their filters for permission.  If any
filter returns a false value, the message is not processed further.

The basic *note Filter: b6a. functionality allows filtering by specific
logger name.  If this feature is used, messages sent to the named logger
and its children are allowed through the filter, and all others dropped.


File: python.info,  Node: Exceptions raised during logging,  Next: Using arbitrary objects as messages,  Prev: Useful Handlers,  Up: Logging HOWTO

10.6.5 Exceptions raised during logging
---------------------------------------

The logging package is designed to swallow exceptions which occur while
logging in production.  This is so that errors which occur while
handling logging events - such as logging misconfiguration, network or
other similar errors - do not cause the application using logging to
terminate prematurely.

*note SystemExit: 5f1. and *note KeyboardInterrupt: 197. exceptions are
never swallowed.  Other exceptions which occur during the *note emit():
1fe4. method of a *note Handler: 1fc5. subclass are passed to its *note
handleError(): 1fe3. method.

The default implementation of *note handleError(): 1fe3. in *note
Handler: 1fc5. checks to see if a module-level variable,
‘raiseExceptions’, is set.  If set, a traceback is printed to *note
sys.stderr: 304.  If not set, the exception is swallowed.

     Note: The default value of ‘raiseExceptions’ is ‘True’.  This is
     because during development, you typically want to be notified of
     any exceptions that occur.  It’s advised that you set
     ‘raiseExceptions’ to ‘False’ for production usage.


File: python.info,  Node: Using arbitrary objects as messages,  Next: Optimization,  Prev: Exceptions raised during logging,  Up: Logging HOWTO

10.6.6 Using arbitrary objects as messages
------------------------------------------

In the preceding sections and examples, it has been assumed that the
message passed when logging the event is a string.  However, this is not
the only possibility.  You can pass an arbitrary object as a message,
and its *note __str__(): e2a. method will be called when the logging
system needs to convert it to a string representation.  In fact, if you
want to, you can avoid computing a string representation altogether -
for example, the *note SocketHandler: 863. emits an event by pickling it
and sending it over the wire.


File: python.info,  Node: Optimization,  Prev: Using arbitrary objects as messages,  Up: Logging HOWTO

10.6.7 Optimization
-------------------

Formatting of message arguments is deferred until it cannot be avoided.
However, computing the arguments passed to the logging method can also
be expensive, and you may want to avoid doing it if the logger will just
throw away your event.  To decide what to do, you can call the *note
isEnabledFor(): 1fc3. method which takes a level argument and returns
true if the event would be created by the Logger for that level of call.
You can write code like this:

     if logger.isEnabledFor(logging.DEBUG):     logger.debug('Message with %s, %s', expensive_func1(),                                         expensive_func2())

so that if the logger’s threshold is set above ‘DEBUG’, the calls to
‘expensive_func1()’ and ‘expensive_func2()’ are never made.

     Note: In some cases, *note isEnabledFor(): 1fc3. can itself be more
     expensive than you’d like (e.g.  for deeply nested loggers where an
     explicit level is only set high up in the logger hierarchy).  In
     such cases (or if you want to avoid calling a method in tight
     loops), you can cache the result of a call to *note isEnabledFor():
     1fc3. in a local or instance variable, and use that instead of
     calling the method each time.  Such a cached value would only need
     to be recomputed when the logging configuration changes dynamically
     while the application is running (which is not all that common).

There are other optimizations which can be made for specific
applications which need more precise control over what logging
information is collected.  Here’s a list of things you can do to avoid
processing during logging which you don’t need:

What you don’t want to collect                      How to avoid collecting it
                                                    
-------------------------------------------------------------------------------------------------
                                                    
Information about where calls were made from.       Set ‘logging._srcfile’ to ‘None’.  This
                                                    avoids calling *note sys._getframe(): e58,
                                                    which may help to speed up your code in
                                                    environments like PyPy (which can’t speed
                                                    up code that uses
                                                    *note sys._getframe(): e58.), if and when
                                                    PyPy supports Python 3.x.
                                                    
                                                    
Threading information.                              Set ‘logging.logThreads’ to ‘0’.
                                                    
                                                    
Process information.                                Set ‘logging.logProcesses’ to ‘0’.
                                                    

Also note that the core logging module only includes the basic handlers.
If you don’t import *note logging.handlers: ac. and *note
logging.config: ab, they won’t take up any memory.

See also
........

Module *note logging: aa.

     API reference for the logging module.

Module *note logging.config: ab.

     Configuration API for the logging module.

Module *note logging.handlers: ac.

     Useful handlers included with the logging module.

*note A logging cookbook: b67.


File: python.info,  Node: Logging Cookbook,  Next: Regular Expression HOWTO,  Prev: Logging HOWTO,  Up: Python HOWTOs

10.7 Logging Cookbook
=====================


Author: Vinay Sajip <vinay_sajip at red-dove dot com>

This page contains a number of recipes related to logging, which have
been found useful in the past.

* Menu:

* Using logging in multiple modules::
* Logging from multiple threads::
* Multiple handlers and formatters::
* Logging to multiple destinations::
* Configuration server example::
* Dealing with handlers that block::
* 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::
* Use of alternative formatting styles::
* Customizing LogRecord::
* Subclassing QueueHandler - a ZeroMQ example::
* Subclassing QueueListener - a ZeroMQ example::
* An example dictionary-based configuration::
* Using a rotator and namer to customize log rotation processing::
* A more elaborate multiprocessing example::
* Inserting a BOM into messages sent to a SysLogHandler::
* Implementing structured logging::
* Customizing handlers with dictConfig(): Customizing handlers with dictConfig.
* Using particular formatting styles throughout your application::
* Configuring filters 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: Formatting times using UTC GMT via configuration.
* Using a context manager for selective logging::
* A CLI application starter template::
* A Qt GUI for logging::


File: python.info,  Node: Using logging in multiple modules,  Next: Logging from multiple threads,  Up: Logging Cookbook

10.7.1 Using logging in multiple modules
----------------------------------------

Multiple calls to ‘logging.getLogger('someLogger')’ return a reference
to the same logger object.  This is true not only within the same
module, but also across modules as long as it is in the same Python
interpreter process.  It is true for references to the same object;
additionally, application code can define and configure a parent logger
in one module and create (but not configure) a child logger in a
separate module, and all logger calls to the child will pass up to the
parent.  Here is a main module:

     import logging import auxiliary_module  # create logger with 'spam_application' logger = logging.getLogger('spam_application') logger.setLevel(logging.DEBUG) # create file handler which logs even debug messages fh = logging.FileHandler('spam.log') fh.setLevel(logging.DEBUG) # create console handler with a higher log level ch = logging.StreamHandler() ch.setLevel(logging.ERROR) # create formatter and add it to the handlers formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') fh.setFormatter(formatter) ch.setFormatter(formatter) # add the handlers to the logger logger.addHandler(fh) logger.addHandler(ch)  logger.info('creating an instance of auxiliary_module.Auxiliary') a = auxiliary_module.Auxiliary() logger.info('created an instance of auxiliary_module.Auxiliary') logger.info('calling auxiliary_module.Auxiliary.do_something') a.do_something() logger.info('finished auxiliary_module.Auxiliary.do_something') logger.info('calling auxiliary_module.some_function()') auxiliary_module.some_function() logger.info('done with auxiliary_module.some_function()')

Here is the auxiliary module:

     import logging  # create logger module_logger = logging.getLogger('spam_application.auxiliary')  class Auxiliary:     def __init__(self):         self.logger = logging.getLogger('spam_application.auxiliary.Auxiliary')         self.logger.info('creating an instance of Auxiliary')      def do_something(self):         self.logger.info('doing something')         a = 1 + 1         self.logger.info('done doing something')  def some_function():     module_logger.info('received a call to "some_function"')

The output looks like this:

     2005-03-23 23:47:11,663 - spam_application - INFO -    creating an instance of auxiliary_module.Auxiliary 2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO -    creating an instance of Auxiliary 2005-03-23 23:47:11,665 - spam_application - INFO -    created an instance of auxiliary_module.Auxiliary 2005-03-23 23:47:11,668 - spam_application - INFO -    calling auxiliary_module.Auxiliary.do_something 2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO -    doing something 2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO -    done doing something 2005-03-23 23:47:11,670 - spam_application - INFO -    finished auxiliary_module.Auxiliary.do_something 2005-03-23 23:47:11,671 - spam_application - INFO -    calling auxiliary_module.some_function() 2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO -    received a call to 'some_function' 2005-03-23 23:47:11,673 - spam_application - INFO -    done with auxiliary_module.some_function()


File: python.info,  Node: Logging from multiple threads,  Next: Multiple handlers and formatters,  Prev: Using logging in multiple modules,  Up: Logging Cookbook

10.7.2 Logging from multiple threads
------------------------------------

Logging from multiple threads requires no special effort.  The following
example shows logging from the main (initial) thread and another thread:

     import logging import threading import time  def worker(arg):     while not arg['stop']:         logging.debug('Hi from myfunc')         time.sleep(0.5)  def main():     logging.basicConfig(level=logging.DEBUG, format='%(relativeCreated)6d %(threadName)s %(message)s')     info = {'stop': False}     thread = threading.Thread(target=worker, args=(info,))     thread.start()     while True:         try:             logging.debug('Hello from main')             time.sleep(0.75)         except KeyboardInterrupt:             info['stop'] = True             break     thread.join()  if __name__ == '__main__':     main()

When run, the script should print something like the following:

        0 Thread-1 Hi from myfunc    3 MainThread Hello from main  505 Thread-1 Hi from myfunc  755 MainThread Hello from main 1007 Thread-1 Hi from myfunc 1507 MainThread Hello from main 1508 Thread-1 Hi from myfunc 2010 Thread-1 Hi from myfunc 2258 MainThread Hello from main 2512 Thread-1 Hi from myfunc 3009 MainThread Hello from main 3013 Thread-1 Hi from myfunc 3515 Thread-1 Hi from myfunc 3761 MainThread Hello from main 4017 Thread-1 Hi from myfunc 4513 MainThread Hello from main 4518 Thread-1 Hi from myfunc

This shows the logging output interspersed as one might expect.  This
approach works for more threads than shown here, of course.


File: python.info,  Node: Multiple handlers and formatters,  Next: Logging to multiple destinations,  Prev: Logging from multiple threads,  Up: Logging Cookbook

10.7.3 Multiple handlers and formatters
---------------------------------------

Loggers are plain Python objects.  The *note addHandler(): 1fcd. method
has no minimum or maximum quota for the number of handlers you may add.
Sometimes it will be beneficial for an application to log all messages
of all severities to a text file while simultaneously logging errors or
above to the console.  To set this up, simply configure the appropriate
handlers.  The logging calls in the application code will remain
unchanged.  Here is a slight modification to the previous simple
module-based configuration example:

     import logging  logger = logging.getLogger('simple_example') logger.setLevel(logging.DEBUG) # create file handler which logs even debug messages fh = logging.FileHandler('spam.log') fh.setLevel(logging.DEBUG) # create console handler with a higher log level ch = logging.StreamHandler() ch.setLevel(logging.ERROR) # create formatter and add it to the handlers formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') ch.setFormatter(formatter) fh.setFormatter(formatter) # add the handlers to logger logger.addHandler(ch) logger.addHandler(fh)  # 'application' code logger.debug('debug message') logger.info('info message') logger.warning('warn message') logger.error('error message') logger.critical('critical message')

Notice that the ‘application’ code does not care about multiple
handlers.  All that changed was the addition and configuration of a new
handler named `fh'.

The ability to create new handlers with higher- or lower-severity
filters can be very helpful when writing and testing an application.
Instead of using many ‘print’ statements for debugging, use
‘logger.debug’: Unlike the print statements, which you will have to
delete or comment out later, the logger.debug statements can remain
intact in the source code and remain dormant until you need them again.
At that time, the only change that needs to happen is to modify the
severity level of the logger and/or handler to debug.


File: python.info,  Node: Logging to multiple destinations,  Next: Configuration server example,  Prev: Multiple handlers and formatters,  Up: Logging Cookbook

10.7.4 Logging to multiple destinations
---------------------------------------

Let’s say you want to log to console and file with different message
formats and in differing circumstances.  Say you want to log messages
with levels of DEBUG and higher to file, and those messages at level
INFO and higher to the console.  Let’s also assume that the file should
contain timestamps, but the console messages should not.  Here’s how you
can achieve this:

     import logging  # set up logging to file - see previous section for more details logging.basicConfig(level=logging.DEBUG,                     format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',                     datefmt='%m-%d %H:%M',                     filename='/temp/myapp.log',                     filemode='w') # define a Handler which writes INFO messages or higher to the sys.stderr console = logging.StreamHandler() console.setLevel(logging.INFO) # set a format which is simpler for console use formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s') # tell the handler to use this format console.setFormatter(formatter) # add the handler to the root logger logging.getLogger('').addHandler(console)  # Now, we can log to the root logger, or any other logger. First the root... logging.info('Jackdaws love my big sphinx of quartz.')  # Now, define a couple of other loggers which might represent areas in your # application:  logger1 = logging.getLogger('myapp.area1') logger2 = logging.getLogger('myapp.area2')  logger1.debug('Quick zephyrs blow, vexing daft Jim.') logger1.info('How quickly daft jumping zebras vex.') logger2.warning('Jail zesty vixen who grabbed pay from quack.') logger2.error('The five boxing wizards jump quickly.')

When you run this, on the console you will see

     root        : INFO     Jackdaws love my big sphinx of quartz. myapp.area1 : INFO     How quickly daft jumping zebras vex. myapp.area2 : WARNING  Jail zesty vixen who grabbed pay from quack. myapp.area2 : ERROR    The five boxing wizards jump quickly.

and in the file you will see something like

     10-22 22:19 root         INFO     Jackdaws love my big sphinx of quartz. 10-22 22:19 myapp.area1  DEBUG    Quick zephyrs blow, vexing daft Jim. 10-22 22:19 myapp.area1  INFO     How quickly daft jumping zebras vex. 10-22 22:19 myapp.area2  WARNING  Jail zesty vixen who grabbed pay from quack. 10-22 22:19 myapp.area2  ERROR    The five boxing wizards jump quickly.

As you can see, the DEBUG message only shows up in the file.  The other
messages are sent to both destinations.

This example uses console and file handlers, but you can use any number
and combination of handlers you choose.


File: python.info,  Node: Configuration server example,  Next: Dealing with handlers that block,  Prev: Logging to multiple destinations,  Up: Logging Cookbook

10.7.5 Configuration server example
-----------------------------------

Here is an example of a module using the logging configuration server:

     import logging import logging.config import time import os  # read initial config file logging.config.fileConfig('logging.conf')  # create and start listener on port 9999 t = logging.config.listen(9999) t.start()  logger = logging.getLogger('simpleExample')  try:     # loop through logging calls to see the difference     # new configurations make, until Ctrl+C is pressed     while True:         logger.debug('debug message')         logger.info('info message')         logger.warning('warn message')         logger.error('error message')         logger.critical('critical message')         time.sleep(5) except KeyboardInterrupt:     # cleanup     logging.config.stopListening()     t.join()

And here is a script that takes a filename and sends that file to the
server, properly preceded with the binary-encoded length, as the new
logging configuration:

     #!/usr/bin/env python import socket, sys, struct  with open(sys.argv[1], 'rb') as f:     data_to_send = f.read()  HOST = 'localhost' PORT = 9999 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) print('connecting...') s.connect((HOST, PORT)) print('sending config...') s.send(struct.pack('>L', len(data_to_send))) s.send(data_to_send) s.close() print('complete')


File: python.info,  Node: Dealing with handlers that block,  Next: Sending and receiving logging events across a network,  Prev: Configuration server example,  Up: Logging Cookbook

10.7.6 Dealing with handlers that block
---------------------------------------

Sometimes you have to get your logging handlers to do their work without
blocking the thread you’re logging from.  This is common in Web
applications, though of course it also occurs in other scenarios.

A common culprit which demonstrates sluggish behaviour is the *note
SMTPHandler: 206b.: sending emails can take a long time, for a number of
reasons outside the developer’s control (for example, a poorly
performing mail or network infrastructure).  But almost any
network-based handler can block: Even a *note SocketHandler: 863.
operation may do a DNS query under the hood which is too slow (and this
query can be deep in the socket library code, below the Python layer,
and outside your control).

One solution is to use a two-part approach.  For the first part, attach
only a *note QueueHandler: 207e. to those loggers which are accessed
from performance-critical threads.  They simply write to their queue,
which can be sized to a large enough capacity or initialized with no
upper bound to their size.  The write to the queue will typically be
accepted quickly, though you will probably need to catch the *note
queue.Full: 22f9. exception as a precaution in your code.  If you are a
library developer who has performance-critical threads in their code, be
sure to document this (together with a suggestion to attach only
‘QueueHandlers’ to your loggers) for the benefit of other developers who
will use your code.

The second part of the solution is *note QueueListener: 706, which has
been designed as the counterpart to *note QueueHandler: 207e.  A *note
QueueListener: 706. is very simple: it’s passed a queue and some
handlers, and it fires up an internal thread which listens to its queue
for LogRecords sent from ‘QueueHandlers’ (or any other source of
‘LogRecords’, for that matter).  The ‘LogRecords’ are removed from the
queue and passed to the handlers for processing.

The advantage of having a separate *note QueueListener: 706. class is
that you can use the same instance to service multiple ‘QueueHandlers’.
This is more resource-friendly than, say, having threaded versions of
the existing handler classes, which would eat up one thread per handler
for no particular benefit.

An example of using these two classes follows (imports omitted):

     que = queue.Queue(-1)  # no limit on size queue_handler = QueueHandler(que) handler = logging.StreamHandler() listener = QueueListener(que, handler) root = logging.getLogger() root.addHandler(queue_handler) formatter = logging.Formatter('%(threadName)s: %(message)s') handler.setFormatter(formatter) listener.start() # The log output will display the thread which generated # the event (the main thread) rather than the internal # thread which monitors the internal queue. This is what # you want to happen. root.warning('Look out!') listener.stop()

which, when run, will produce:

     MainThread: Look out!

Changed in version 3.5: Prior to Python 3.5, the *note QueueListener:
706. always passed every message received from the queue to every
handler it was initialized with.  (This was because it was assumed that
level filtering was all done on the other side, where the queue is
filled.)  From 3.5 onwards, this behaviour can be changed by passing a
keyword argument ‘respect_handler_level=True’ to the listener’s
constructor.  When this is done, the listener compares the level of each
message with the handler’s level, and only passes a message to a handler
if it’s appropriate to do so.


File: python.info,  Node: Sending and receiving logging events across a network,  Next: Adding contextual information to your logging output,  Prev: Dealing with handlers that block,  Up: Logging Cookbook

10.7.7 Sending and receiving logging events across a network
------------------------------------------------------------

Let’s say you want to send logging events across a network, and handle
them at the receiving end.  A simple way of doing this is attaching a
*note SocketHandler: 863. instance to the root logger at the sending
end:

     import logging, logging.handlers  rootLogger = logging.getLogger('') rootLogger.setLevel(logging.DEBUG) socketHandler = logging.handlers.SocketHandler('localhost',                     logging.handlers.DEFAULT_TCP_LOGGING_PORT) # don't bother with a formatter, since a socket handler sends the event as # an unformatted pickle rootLogger.addHandler(socketHandler)  # Now, we can log to the root logger, or any other logger. First the root... logging.info('Jackdaws love my big sphinx of quartz.')  # Now, define a couple of other loggers which might represent areas in your # application:  logger1 = logging.getLogger('myapp.area1') logger2 = logging.getLogger('myapp.area2')  logger1.debug('Quick zephyrs blow, vexing daft Jim.') logger1.info('How quickly daft jumping zebras vex.') logger2.warning('Jail zesty vixen who grabbed pay from quack.') logger2.error('The five boxing wizards jump quickly.')

At the receiving end, you can set up a receiver using the *note
socketserver: f0. module.  Here is a basic working example:

     import pickle import logging import logging.handlers import socketserver import struct   class LogRecordStreamHandler(socketserver.StreamRequestHandler):     """Handler for a streaming logging request.      This basically logs the record using whatever logging policy is     configured locally.     """      def handle(self):         """         Handle multiple requests - each expected to be a 4-byte length,         followed by the LogRecord in pickle format. Logs the record         according to whatever policy is configured locally.         """         while True:             chunk = self.connection.recv(4)             if len(chunk) < 4:                 break             slen = struct.unpack('>L', chunk)[0]             chunk = self.connection.recv(slen)             while len(chunk) < slen:                 chunk = chunk + self.connection.recv(slen - len(chunk))             obj = self.unPickle(chunk)             record = logging.makeLogRecord(obj)             self.handleLogRecord(record)      def unPickle(self, data):         return pickle.loads(data)      def handleLogRecord(self, record):         # if a name is specified, we use the named logger rather than the one         # implied by the record.         if self.server.logname is not None:             name = self.server.logname         else:             name = record.name         logger = logging.getLogger(name)         # N.B. EVERY record gets logged. This is because Logger.handle         # is normally called AFTER logger-level filtering. If you want         # to do filtering, do it at the client end to save wasting         # cycles and network bandwidth!         logger.handle(record)  class LogRecordSocketReceiver(socketserver.ThreadingTCPServer):     """     Simple TCP socket-based logging receiver suitable for testing.     """      allow_reuse_address = True      def __init__(self, host='localhost',                  port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,                  handler=LogRecordStreamHandler):         socketserver.ThreadingTCPServer.__init__(self, (host, port), handler)         self.abort = 0         self.timeout = 1         self.logname = None      def serve_until_stopped(self):         import select         abort = 0         while not abort:             rd, wr, ex = select.select([self.socket.fileno()],                                        [], [],                                        self.timeout)             if rd:                 self.handle_request()             abort = self.abort  def main():     logging.basicConfig(         format='%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s')     tcpserver = LogRecordSocketReceiver()     print('About to start TCP server...')     tcpserver.serve_until_stopped()  if __name__ == '__main__':     main()

First run the server, and then the client.  On the client side, nothing
is printed on the console; on the server side, you should see something
like:

     About to start TCP server...    59 root            INFO     Jackdaws love my big sphinx of quartz.    59 myapp.area1     DEBUG    Quick zephyrs blow, vexing daft Jim.    69 myapp.area1     INFO     How quickly daft jumping zebras vex.    69 myapp.area2     WARNING  Jail zesty vixen who grabbed pay from quack.    69 myapp.area2     ERROR    The five boxing wizards jump quickly.

Note that there are some security issues with pickle in some scenarios.
If these affect you, you can use an alternative serialization scheme by
overriding the ‘makePickle()’ method and implementing your alternative
there, as well as adapting the above script to use your alternative
serialization.


File: python.info,  Node: Adding contextual information to your logging output,  Next: Logging to a single file from multiple processes,  Prev: Sending and receiving logging events across a network,  Up: Logging Cookbook

10.7.8 Adding contextual information to your logging output
-----------------------------------------------------------

Sometimes you want logging output to contain contextual information in
addition to the parameters passed to the logging call.  For example, in
a networked application, it may be desirable to log client-specific
information in the log (e.g.  remote client’s username, or IP address).
Although you could use the `extra' parameter to achieve this, it’s not
always convenient to pass the information in this way.  While it might
be tempting to create ‘Logger’ instances on a per-connection basis, this
is not a good idea because these instances are not garbage collected.
While this is not a problem in practice, when the number of ‘Logger’
instances is dependent on the level of granularity you want to use in
logging an application, it could be hard to manage if the number of
‘Logger’ instances becomes effectively unbounded.

* Menu:

* Using LoggerAdapters to impart contextual information::
* Using Filters to impart contextual information::


File: python.info,  Node: Using LoggerAdapters to impart contextual information,  Next: Using Filters to impart contextual information,  Up: Adding contextual information to your logging output

10.7.8.1 Using LoggerAdapters to impart contextual information
..............................................................

An easy way in which you can pass contextual information to be output
along with logging event information is to use the ‘LoggerAdapter’
class.  This class is designed to look like a ‘Logger’, so that you can
call ‘debug()’, ‘info()’, ‘warning()’, ‘error()’, ‘exception()’,
‘critical()’ and ‘log()’.  These methods have the same signatures as
their counterparts in ‘Logger’, so you can use the two types of
instances interchangeably.

When you create an instance of ‘LoggerAdapter’, you pass it a ‘Logger’
instance and a dict-like object which contains your contextual
information.  When you call one of the logging methods on an instance of
‘LoggerAdapter’, it delegates the call to the underlying instance of
‘Logger’ passed to its constructor, and arranges to pass the contextual
information in the delegated call.  Here’s a snippet from the code of
‘LoggerAdapter’:

     def debug(self, msg, /, *args, **kwargs):     """     Delegate a debug call to the underlying logger, after adding     contextual information from this adapter instance.     """     msg, kwargs = self.process(msg, kwargs)     self.logger.debug(msg, *args, **kwargs)

The ‘process()’ method of ‘LoggerAdapter’ is where the contextual
information is added to the logging output.  It’s passed the message and
keyword arguments of the logging call, and it passes back (potentially)
modified versions of these to use in the call to the underlying logger.
The default implementation of this method leaves the message alone, but
inserts an ‘extra’ key in the keyword argument whose value is the
dict-like object passed to the constructor.  Of course, if you had
passed an ‘extra’ keyword argument in the call to the adapter, it will
be silently overwritten.

The advantage of using ‘extra’ is that the values in the dict-like
object are merged into the ‘LogRecord’ instance’s __dict__, allowing you
to use customized strings with your ‘Formatter’ instances which know
about the keys of the dict-like object.  If you need a different method,
e.g.  if you want to prepend or append the contextual information to the
message string, you just need to subclass ‘LoggerAdapter’ and override
‘process()’ to do what you need.  Here is a simple example:

     class CustomAdapter(logging.LoggerAdapter):     """     This example adapter expects the passed in dict-like object to have a     'connid' key, whose value in brackets is prepended to the log message.     """     def process(self, msg, kwargs):         return '[%s] %s' % (self.extra['connid'], msg), kwargs

which you can use like this:

     logger = logging.getLogger(__name__) adapter = CustomAdapter(logger, {'connid': some_conn_id})

Then any events that you log to the adapter will have the value of
‘some_conn_id’ prepended to the log messages.

* Menu:

* Using objects other than dicts to pass contextual information::


File: python.info,  Node: Using objects other than dicts to pass contextual information,  Up: Using LoggerAdapters to impart contextual information

10.7.8.2 Using objects other than dicts to pass contextual information
......................................................................

You don’t need to pass an actual dict to a ‘LoggerAdapter’ - you could
pass an instance of a class which implements ‘__getitem__’ and
‘__iter__’ so that it looks like a dict to logging.  This would be
useful if you want to generate values dynamically (whereas the values in
a dict would be constant).


File: python.info,  Node: Using Filters to impart contextual information,  Prev: Using LoggerAdapters to impart contextual information,  Up: Adding contextual information to your logging output

10.7.8.3 Using Filters to impart contextual information
.......................................................

You can also add contextual information to log output using a
user-defined ‘Filter’.  ‘Filter’ instances are allowed to modify the
‘LogRecords’ passed to them, including adding additional attributes
which can then be output using a suitable format string, or if needed a
custom ‘Formatter’.

For example in a web application, the request being processed (or at
least, the interesting parts of it) can be stored in a threadlocal
(*note threading.local: 2236.) variable, and then accessed from a
‘Filter’ to add, say, information from the request - say, the remote IP
address and remote user’s username - to the ‘LogRecord’, using the
attribute names ‘ip’ and ‘user’ as in the ‘LoggerAdapter’ example above.
In that case, the same format string can be used to get similar output
to that shown above.  Here’s an example script:

     import logging from random import choice  class ContextFilter(logging.Filter):     """     This is a filter which injects contextual information into the log.      Rather than use actual contextual information, we just use random     data in this demo.     """      USERS = ['jim', 'fred', 'sheila']     IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1']      def filter(self, record):          record.ip = choice(ContextFilter.IPS)         record.user = choice(ContextFilter.USERS)         return True  if __name__ == '__main__':     levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)     logging.basicConfig(level=logging.DEBUG,                         format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s')     a1 = logging.getLogger('a.b.c')     a2 = logging.getLogger('d.e.f')      f = ContextFilter()     a1.addFilter(f)     a2.addFilter(f)     a1.debug('A debug message')     a1.info('An info message with %s', 'some parameters')     for x in range(10):         lvl = choice(levels)         lvlname = logging.getLevelName(lvl)         a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters')

which, when run, produces something like:

     2010-09-06 22:38:15,292 a.b.c DEBUG    IP: 123.231.231.123 User: fred     A debug message 2010-09-06 22:38:15,300 a.b.c INFO     IP: 192.168.0.1     User: sheila   An info message with some parameters 2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters 2010-09-06 22:38:15,300 d.e.f ERROR    IP: 127.0.0.1       User: jim      A message at ERROR level with 2 parameters 2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 127.0.0.1       User: sheila   A message at DEBUG level with 2 parameters 2010-09-06 22:38:15,300 d.e.f ERROR    IP: 123.231.231.123 User: fred     A message at ERROR level with 2 parameters 2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 192.168.0.1     User: jim      A message at CRITICAL level with 2 parameters 2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters 2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 192.168.0.1     User: jim      A message at DEBUG level with 2 parameters 2010-09-06 22:38:15,301 d.e.f ERROR    IP: 127.0.0.1       User: sheila   A message at ERROR level with 2 parameters 2010-09-06 22:38:15,301 d.e.f DEBUG    IP: 123.231.231.123 User: fred     A message at DEBUG level with 2 parameters 2010-09-06 22:38:15,301 d.e.f INFO     IP: 123.231.231.123 User: fred     A message at INFO level with 2 parameters


File: python.info,  Node: Logging to a single file from multiple processes,  Next: Using file rotation,  Prev: Adding contextual information to your logging output,  Up: Logging Cookbook

10.7.9 Logging to a single file from multiple processes
-------------------------------------------------------

Although logging is thread-safe, and logging to a single file from
multiple threads in a single process `is' supported, logging to a single
file from `multiple processes' is `not' supported, because there is no
standard way to serialize access to a single file across multiple
processes in Python.  If you need to log to a single file from multiple
processes, one way of doing this is to have all the processes log to a
‘SocketHandler’, and have a separate process which implements a socket
server which reads from the socket and logs to file.  (If you prefer,
you can dedicate one thread in one of the existing processes to perform
this function.)  *note This section: 40b2. documents this approach in
more detail and includes a working socket receiver which can be used as
a starting point for you to adapt in your own applications.

You could also write your own handler which uses the *note Lock: 22da.
class from the *note multiprocessing: b7. module to serialize access to
the file from your processes.  The existing ‘FileHandler’ and subclasses
do not make use of *note multiprocessing: b7. at present, though they
may do so in the future.  Note that at present, the *note
multiprocessing: b7. module does not provide working lock functionality
on all platforms (see ‘https://bugs.python.org/issue3770’).

Alternatively, you can use a ‘Queue’ and a *note QueueHandler: 207e. to
send all logging events to one of the processes in your multi-process
application.  The following example script demonstrates how you can do
this; in the example a separate listener process listens for events sent
by other processes and logs them according to its own logging
configuration.  Although the example only demonstrates one way of doing
it (for example, you may want to use a listener thread rather than a
separate listener process – the implementation would be analogous) it
does allow for completely different logging configurations for the
listener and the other processes in your application, and can be used as
the basis for code meeting your own specific requirements:

     # You'll need these imports in your own code import logging import logging.handlers import multiprocessing  # Next two import lines for this demo only from random import choice, random import time  # # Because you'll want to define the logging configurations for listener and workers, the # listener and worker process functions take a configurer parameter which is a callable # for configuring logging for that process. These functions are also passed the queue, # which they use for communication. # # In practice, you can configure the listener however you want, but note that in this # simple example, the listener does not apply level or filter logic to received records. # In practice, you would probably want to do this logic in the worker processes, to avoid # sending events which would be filtered out between processes. # # The size of the rotated files is made small so you can see the results easily. def listener_configurer():     root = logging.getLogger()     h = logging.handlers.RotatingFileHandler('mptest.log', 'a', 300, 10)     f = logging.Formatter('%(asctime)s %(processName)-10s %(name)s %(levelname)-8s %(message)s')     h.setFormatter(f)     root.addHandler(h)  # This is the listener process top-level loop: wait for logging events # (LogRecords)on the queue and handle them, quit when you get a None for a # LogRecord. def listener_process(queue, configurer):     configurer()     while True:         try:             record = queue.get()             if record is None:  # We send this as a sentinel to tell the listener to quit.                 break             logger = logging.getLogger(record.name)             logger.handle(record)  # No level or filter logic applied - just do it!         except Exception:             import sys, traceback             print('Whoops! Problem:', file=sys.stderr)             traceback.print_exc(file=sys.stderr)  # Arrays used for random selections in this demo  LEVELS = [logging.DEBUG, logging.INFO, logging.WARNING,           logging.ERROR, logging.CRITICAL]  LOGGERS = ['a.b.c', 'd.e.f']  MESSAGES = [     'Random message #1',     'Random message #2',     'Random message #3', ]  # The worker configuration is done at the start of the worker process run. # Note that on Windows you can't rely on fork semantics, so each process # will run the logging configuration code when it starts. def worker_configurer(queue):     h = logging.handlers.QueueHandler(queue)  # Just the one handler needed     root = logging.getLogger()     root.addHandler(h)     # send all messages, for demo; no other level or filter logic applied.     root.setLevel(logging.DEBUG)  # This is the worker process top-level loop, which just logs ten events with # random intervening delays before terminating. # The print messages are just so you know it's doing something! def worker_process(queue, configurer):     configurer(queue)     name = multiprocessing.current_process().name     print('Worker started: %s' % name)     for i in range(10):         time.sleep(random())         logger = logging.getLogger(choice(LOGGERS))         level = choice(LEVELS)         message = choice(MESSAGES)         logger.log(level, message)     print('Worker finished: %s' % name)  # Here's where the demo gets orchestrated. Create the queue, create and start # the listener, create ten workers and start them, wait for them to finish, # then send a None to the queue to tell the listener to finish. def main():     queue = multiprocessing.Queue(-1)     listener = multiprocessing.Process(target=listener_process,                                        args=(queue, listener_configurer))     listener.start()     workers = []     for i in range(10):         worker = multiprocessing.Process(target=worker_process,                                          args=(queue, worker_configurer))         workers.append(worker)         worker.start()     for w in workers:         w.join()     queue.put_nowait(None)     listener.join()  if __name__ == '__main__':     main()

A variant of the above script keeps the logging in the main process, in
a separate thread:

     import logging import logging.config import logging.handlers from multiprocessing import Process, Queue import random import threading import time  def logger_thread(q):     while True:         record = q.get()         if record is None:             break         logger = logging.getLogger(record.name)         logger.handle(record)   def worker_process(q):     qh = logging.handlers.QueueHandler(q)     root = logging.getLogger()     root.setLevel(logging.DEBUG)     root.addHandler(qh)     levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,               logging.CRITICAL]     loggers = ['foo', 'foo.bar', 'foo.bar.baz',                'spam', 'spam.ham', 'spam.ham.eggs']     for i in range(100):         lvl = random.choice(levels)         logger = logging.getLogger(random.choice(loggers))         logger.log(lvl, 'Message no. %d', i)  if __name__ == '__main__':     q = Queue()     d = {         'version': 1,         'formatters': {             'detailed': {                 'class': 'logging.Formatter',                 'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'             }         },         'handlers': {             'console': {                 'class': 'logging.StreamHandler',                 'level': 'INFO',             },             'file': {                 'class': 'logging.FileHandler',                 'filename': 'mplog.log',                 'mode': 'w',                 'formatter': 'detailed',             },             'foofile': {                 'class': 'logging.FileHandler',                 'filename': 'mplog-foo.log',                 'mode': 'w',                 'formatter': 'detailed',             },             'errors': {                 'class': 'logging.FileHandler',                 'filename': 'mplog-errors.log',                 'mode': 'w',                 'level': 'ERROR',                 'formatter': 'detailed',             },         },         'loggers': {             'foo': {                 'handlers': ['foofile']             }         },         'root': {             'level': 'DEBUG',             'handlers': ['console', 'file', 'errors']         },     }     workers = []     for i in range(5):         wp = Process(target=worker_process, name='worker %d' % (i + 1), args=(q,))         workers.append(wp)         wp.start()     logging.config.dictConfig(d)     lp = threading.Thread(target=logger_thread, args=(q,))     lp.start()     # At this point, the main process could do some useful work of its own     # Once it's done that, it can wait for the workers to terminate...     for wp in workers:         wp.join()     # And now tell the logging thread to finish up, too     q.put(None)     lp.join()

This variant shows how you can e.g.  apply configuration for particular
loggers - e.g.  the ‘foo’ logger has a special handler which stores all
events in the ‘foo’ subsystem in a file ‘mplog-foo.log’.  This will be
used by the logging machinery in the main process (even though the
logging events are generated in the worker processes) to direct the
messages to the appropriate destinations.

* Menu:

* Using concurrent.futures.ProcessPoolExecutor: Using concurrent futures ProcessPoolExecutor.


File: python.info,  Node: Using concurrent futures ProcessPoolExecutor,  Up: Logging to a single file from multiple processes

10.7.9.1 Using concurrent.futures.ProcessPoolExecutor
.....................................................

If you want to use *note concurrent.futures.ProcessPoolExecutor: 2a2. to
start your worker processes, you need to create the queue slightly
differently.  Instead of

     queue = multiprocessing.Queue(-1)

you should use

     queue = multiprocessing.Manager().Queue(-1)  # also works with the examples above

and you can then replace the worker creation from this:

     workers = [] for i in range(10):     worker = multiprocessing.Process(target=worker_process,                                      args=(queue, worker_configurer))     workers.append(worker)     worker.start() for w in workers:     w.join()

to this (remembering to first import *note concurrent.futures: 22.):

     with concurrent.futures.ProcessPoolExecutor(max_workers=10) as executor:     for i in range(10):         executor.submit(worker_process, queue, worker_configurer)


File: python.info,  Node: Using file rotation,  Next: Use of alternative formatting styles,  Prev: Logging to a single file from multiple processes,  Up: Logging Cookbook

10.7.10 Using file rotation
---------------------------

Sometimes you want to let a log file grow to a certain size, then open a
new file and log to that.  You may want to keep a certain number of
these files, and when that many files have been created, rotate the
files so that the number of files and the size of the files both remain
bounded.  For this usage pattern, the logging package provides a
‘RotatingFileHandler’:

     import glob import logging import logging.handlers  LOG_FILENAME = 'logging_rotatingfile_example.out'  # Set up a specific logger with our desired output level my_logger = logging.getLogger('MyLogger') my_logger.setLevel(logging.DEBUG)  # Add the log message handler to the logger handler = logging.handlers.RotatingFileHandler(               LOG_FILENAME, maxBytes=20, backupCount=5)  my_logger.addHandler(handler)  # Log some messages for i in range(20):     my_logger.debug('i = %d' % i)  # See what files are created logfiles = glob.glob('%s*' % LOG_FILENAME)  for filename in logfiles:     print(filename)

The result should be 6 separate files, each with part of the log history
for the application:

     logging_rotatingfile_example.out logging_rotatingfile_example.out.1 logging_rotatingfile_example.out.2 logging_rotatingfile_example.out.3 logging_rotatingfile_example.out.4 logging_rotatingfile_example.out.5

The most current file is always ‘logging_rotatingfile_example.out’, and
each time it reaches the size limit it is renamed with the suffix ‘.1’.
Each of the existing backup files is renamed to increment the suffix
(‘.1’ becomes ‘.2’, etc.)  and the ‘.6’ file is erased.

Obviously this example sets the log length much too small as an extreme
example.  You would want to set `maxBytes' to an appropriate value.


File: python.info,  Node: Use of alternative formatting styles,  Next: Customizing LogRecord,  Prev: Using file rotation,  Up: Logging Cookbook

10.7.11 Use of alternative formatting styles
--------------------------------------------

When logging was added to the Python standard library, the only way of
formatting messages with variable content was to use the %-formatting
method.  Since then, Python has gained two new formatting approaches:
*note string.Template: 3e0. (added in Python 2.4) and *note
str.format(): 4cf. (added in Python 2.6).

Logging (as of 3.2) provides improved support for these two additional
formatting styles.  The ‘Formatter’ class been enhanced to take an
additional, optional keyword parameter named ‘style’.  This defaults to
‘'%'’, but other possible values are ‘'{'’ and ‘'$'’, which correspond
to the other two formatting styles.  Backwards compatibility is
maintained by default (as you would expect), but by explicitly
specifying a style parameter, you get the ability to specify format
strings which work with *note str.format(): 4cf. or *note
string.Template: 3e0.  Here’s an example console session to show the
possibilities:

     >>> import logging >>> root = logging.getLogger() >>> root.setLevel(logging.DEBUG) >>> handler = logging.StreamHandler() >>> bf = logging.Formatter('{asctime} {name} {levelname:8s} {message}', ...                        style='{') >>> handler.setFormatter(bf) >>> root.addHandler(handler) >>> logger = logging.getLogger('foo.bar') >>> logger.debug('This is a DEBUG message') 2010-10-28 15:11:55,341 foo.bar DEBUG    This is a DEBUG message >>> logger.critical('This is a CRITICAL message') 2010-10-28 15:12:11,526 foo.bar CRITICAL This is a CRITICAL message >>> df = logging.Formatter('$asctime $name ${levelname} $message', ...                        style='$') >>> handler.setFormatter(df) >>> logger.debug('This is a DEBUG message') 2010-10-28 15:13:06,924 foo.bar DEBUG This is a DEBUG message >>> logger.critical('This is a CRITICAL message') 2010-10-28 15:13:11,494 foo.bar CRITICAL This is a CRITICAL message >>>

Note that the formatting of logging messages for final output to logs is
completely independent of how an individual logging message is
constructed.  That can still use %-formatting, as shown here:

     >>> logger.error('This is an%s %s %s', 'other,', 'ERROR,', 'message') 2010-10-28 15:19:29,833 foo.bar ERROR This is another, ERROR, message >>>

Logging calls (‘logger.debug()’, ‘logger.info()’ etc.)  only take
positional parameters for the actual logging message itself, with
keyword parameters used only for determining options for how to handle
the actual logging call (e.g.  the ‘exc_info’ keyword parameter to
indicate that traceback information should be logged, or the ‘extra’
keyword parameter to indicate additional contextual information to be
added to the log).  So you cannot directly make logging calls using
*note str.format(): 4cf. or *note string.Template: 3e0. syntax, because
internally the logging package uses %-formatting to merge the format
string and the variable arguments.  There would be no changing this
while preserving backward compatibility, since all logging calls which
are out there in existing code will be using %-format strings.

There is, however, a way that you can use {}- and $- formatting to
construct your individual log messages.  Recall that for a message you
can use an arbitrary object as a message format string, and that the
logging package will call ‘str()’ on that object to get the actual
format string.  Consider the following two classes:

     class BraceMessage:     def __init__(self, fmt, /, *args, **kwargs):         self.fmt = fmt         self.args = args         self.kwargs = kwargs      def __str__(self):         return self.fmt.format(*self.args, **self.kwargs)  class DollarMessage:     def __init__(self, fmt, /, **kwargs):         self.fmt = fmt         self.kwargs = kwargs      def __str__(self):         from string import Template         return Template(self.fmt).substitute(**self.kwargs)

Either of these can be used in place of a format string, to allow {}- or
$-formatting to be used to build the actual “message” part which appears
in the formatted log output in place of “%(message)s” or “{message}” or
“$message”.  It’s a little unwieldy to use the class names whenever you
want to log something, but it’s quite palatable if you use an alias such
as __ (double underscore — not to be confused with _, the single
underscore used as a synonym/alias for *note gettext.gettext(): dc0. or
its brethren).

The above classes are not included in Python, though they’re easy enough
to copy and paste into your own code.  They can be used as follows
(assuming that they’re declared in a module called ‘wherever’):

     >>> from wherever import BraceMessage as __ >>> print(__('Message with {0} {name}', 2, name='placeholders')) Message with 2 placeholders >>> class Point: pass ... >>> p = Point() >>> p.x = 0.5 >>> p.y = 0.5 >>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})', ...       point=p)) Message with coordinates: (0.50, 0.50) >>> from wherever import DollarMessage as __ >>> print(__('Message with $num $what', num=2, what='placeholders')) Message with 2 placeholders >>>

While the above examples use ‘print()’ to show how the formatting works,
you would of course use ‘logger.debug()’ or similar to actually log
using this approach.

One thing to note is that you pay no significant performance penalty
with this approach: the actual formatting happens not when you make the
logging call, but when (and if) the logged message is actually about to
be output to a log by a handler.  So the only slightly unusual thing
which might trip you up is that the parentheses go around the format
string and the arguments, not just the format string.  That’s because
the __ notation is just syntax sugar for a constructor call to one of
the XXXMessage classes.

If you prefer, you can use a ‘LoggerAdapter’ to achieve a similar effect
to the above, as in the following example:

     import logging  class Message:     def __init__(self, fmt, args):         self.fmt = fmt         self.args = args      def __str__(self):         return self.fmt.format(*self.args)  class StyleAdapter(logging.LoggerAdapter):     def __init__(self, logger, extra=None):         super(StyleAdapter, self).__init__(logger, extra or {})      def log(self, level, msg, /, *args, **kwargs):         if self.isEnabledFor(level):             msg, kwargs = self.process(msg, kwargs)             self.logger._log(level, Message(msg, args), (), **kwargs)  logger = StyleAdapter(logging.getLogger(__name__))  def main():     logger.debug('Hello, {}', 'world!')  if __name__ == '__main__':     logging.basicConfig(level=logging.DEBUG)     main()

The above script should log the message ‘Hello, world!’ when run with
Python 3.2 or later.


File: python.info,  Node: Customizing LogRecord,  Next: Subclassing QueueHandler - a ZeroMQ example,  Prev: Use of alternative formatting styles,  Up: Logging Cookbook

10.7.12 Customizing ‘LogRecord’
-------------------------------

Every logging event is represented by a *note LogRecord: 8fa. instance.
When an event is logged and not filtered out by a logger’s level, a
*note LogRecord: 8fa. is created, populated with information about the
event and then passed to the handlers for that logger (and its
ancestors, up to and including the logger where further propagation up
the hierarchy is disabled).  Before Python 3.2, there were only two
places where this creation was done:

   * *note Logger.makeRecord(): 1fd1, which is called in the normal
     process of logging an event.  This invoked *note LogRecord: 8fa.
     directly to create an instance.

   * *note makeLogRecord(): 1ff6, which is called with a dictionary
     containing attributes to be added to the LogRecord.  This is
     typically invoked when a suitable dictionary has been received over
     the network (e.g.  in pickle form via a *note SocketHandler: 863,
     or in JSON form via an *note HTTPHandler: 705.).

This has usually meant that if you need to do anything special with a
*note LogRecord: 8fa, you’ve had to do one of the following.

   * Create your own *note Logger: 39c. subclass, which overrides *note
     Logger.makeRecord(): 1fd1, and set it using *note setLoggerClass():
     2003. before any loggers that you care about are instantiated.

   * Add a *note Filter: b6a. to a logger or handler, which does the
     necessary special manipulation you need when its *note filter():
     1ff1. method is called.

The first approach would be a little unwieldy in the scenario where
(say) several different libraries wanted to do different things.  Each
would attempt to set its own *note Logger: 39c. subclass, and the one
which did this last would win.

The second approach works reasonably well for many cases, but does not
allow you to e.g.  use a specialized subclass of *note LogRecord: 8fa.
Library developers can set a suitable filter on their loggers, but they
would have to remember to do this every time they introduced a new
logger (which they would do simply by adding new packages or modules and
doing

     logger = logging.getLogger(__name__)

at module level).  It’s probably one too many things to think about.
Developers could also add the filter to a *note NullHandler: c0f.
attached to their top-level logger, but this would not be invoked if an
application developer attached a handler to a lower-level library logger
— so output from that handler would not reflect the intentions of the
library developer.

In Python 3.2 and later, *note LogRecord: 8fa. creation is done through
a factory, which you can specify.  The factory is just a callable you
can set with *note setLogRecordFactory(): 1ff9, and interrogate with
*note getLogRecordFactory(): 1ff8.  The factory is invoked with the same
signature as the *note LogRecord: 8fa. constructor, as *note LogRecord:
8fa. is the default setting for the factory.

This approach allows a custom factory to control all aspects of
LogRecord creation.  For example, you could return a subclass, or just
add some additional attributes to the record once created, using a
pattern similar to this:

     old_factory = logging.getLogRecordFactory()  def record_factory(*args, **kwargs):     record = old_factory(*args, **kwargs)     record.custom_attribute = 0xdecafbad     return record  logging.setLogRecordFactory(record_factory)

This pattern allows different libraries to chain factories together, and
as long as they don’t overwrite each other’s attributes or
unintentionally overwrite the attributes provided as standard, there
should be no surprises.  However, it should be borne in mind that each
link in the chain adds run-time overhead to all logging operations, and
the technique should only be used when the use of a *note Filter: b6a.
does not provide the desired result.


File: python.info,  Node: Subclassing QueueHandler - a ZeroMQ example,  Next: Subclassing QueueListener - a ZeroMQ example,  Prev: Customizing LogRecord,  Up: Logging Cookbook

10.7.13 Subclassing QueueHandler - a ZeroMQ example
---------------------------------------------------

You can use a ‘QueueHandler’ subclass to send messages to other kinds of
queues, for example a ZeroMQ ‘publish’ socket.  In the example below,the
socket is created separately and passed to the handler (as its ‘queue’):

     import zmq   # using pyzmq, the Python binding for ZeroMQ import json  # for serializing records portably  ctx = zmq.Context() sock = zmq.Socket(ctx, zmq.PUB)  # or zmq.PUSH, or other suitable value sock.bind('tcp://*:5556')        # or wherever  class ZeroMQSocketHandler(QueueHandler):     def enqueue(self, record):         self.queue.send_json(record.__dict__)   handler = ZeroMQSocketHandler(sock)

Of course there are other ways of organizing this, for example passing
in the data needed by the handler to create the socket:

     class ZeroMQSocketHandler(QueueHandler):     def __init__(self, uri, socktype=zmq.PUB, ctx=None):         self.ctx = ctx or zmq.Context()         socket = zmq.Socket(self.ctx, socktype)         socket.bind(uri)         super().__init__(socket)      def enqueue(self, record):         self.queue.send_json(record.__dict__)      def close(self):         self.queue.close()


File: python.info,  Node: Subclassing QueueListener - a ZeroMQ example,  Next: An example dictionary-based configuration,  Prev: Subclassing QueueHandler - a ZeroMQ example,  Up: Logging Cookbook

10.7.14 Subclassing QueueListener - a ZeroMQ example
----------------------------------------------------

You can also subclass ‘QueueListener’ to get messages from other kinds
of queues, for example a ZeroMQ ‘subscribe’ socket.  Here’s an example:

     class ZeroMQSocketListener(QueueListener):     def __init__(self, uri, /, *handlers, **kwargs):         self.ctx = kwargs.get('ctx') or zmq.Context()         socket = zmq.Socket(self.ctx, zmq.SUB)         socket.setsockopt_string(zmq.SUBSCRIBE, '')  # subscribe to everything         socket.connect(uri)         super().__init__(socket, *handlers, **kwargs)      def dequeue(self):         msg = self.queue.recv_json()         return logging.makeLogRecord(msg)

See also
........

Module *note logging: aa.

     API reference for the logging module.

Module *note logging.config: ab.

     Configuration API for the logging module.

Module *note logging.handlers: ac.

     Useful handlers included with the logging module.

*note A basic logging tutorial: b65.

*note A more advanced logging tutorial: b66.


File: python.info,  Node: An example dictionary-based configuration,  Next: Using a rotator and namer to customize log rotation processing,  Prev: Subclassing QueueListener - a ZeroMQ example,  Up: Logging Cookbook

10.7.15 An example dictionary-based configuration
-------------------------------------------------

Below is an example of a logging configuration dictionary - it’s taken
from the documentation on the Django project(1).  This dictionary is
passed to *note dictConfig(): b1e. to put the configuration into effect:

     LOGGING = {     'version': 1,     'disable_existing_loggers': True,     'formatters': {         'verbose': {             'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'         },         'simple': {             'format': '%(levelname)s %(message)s'         },     },     'filters': {         'special': {             '()': 'project.logging.SpecialFilter',             'foo': 'bar',         }     },     'handlers': {         'null': {             'level':'DEBUG',             'class':'django.utils.log.NullHandler',         },         'console':{             'level':'DEBUG',             'class':'logging.StreamHandler',             'formatter': 'simple'         },         'mail_admins': {             'level': 'ERROR',             'class': 'django.utils.log.AdminEmailHandler',             'filters': ['special']         }     },     'loggers': {         'django': {             'handlers':['null'],             'propagate': True,             'level':'INFO',         },         'django.request': {             'handlers': ['mail_admins'],             'level': 'ERROR',             'propagate': False,         },         'myproject.custom': {             'handlers': ['console', 'mail_admins'],             'level': 'INFO',             'filters': ['special']         }     } }

For more information about this configuration, you can see the relevant
section(2) of the Django documentation.

   ---------- Footnotes ----------

   (1) 
https://docs.djangoproject.com/en/1.9/topics/logging/#configuring-logging

   (2) 
https://docs.djangoproject.com/en/1.9/topics/logging/#configuring-logging


File: python.info,  Node: Using a rotator and namer to customize log rotation processing,  Next: A more elaborate multiprocessing example,  Prev: An example dictionary-based configuration,  Up: Logging Cookbook

10.7.16 Using a rotator and namer to customize log rotation processing
----------------------------------------------------------------------

An example of how you can define a namer and rotator is given in the
following snippet, which shows zlib-based compression of the log file:

     def namer(name):     return name + ".gz"  def rotator(source, dest):     with open(source, "rb") as sf:         data = sf.read()         compressed = zlib.compress(data, 9)         with open(dest, "wb") as df:             df.write(compressed)     os.remove(source)  rh = logging.handlers.RotatingFileHandler(...) rh.rotator = rotator rh.namer = namer

These are not “true” .gz files, as they are bare compressed data, with
no “container” such as you’d find in an actual gzip file.  This snippet
is just for illustration purposes.


File: python.info,  Node: A more elaborate multiprocessing example,  Next: Inserting a BOM into messages sent to a SysLogHandler,  Prev: Using a rotator and namer to customize log rotation processing,  Up: Logging Cookbook

10.7.17 A more elaborate multiprocessing example
------------------------------------------------

The following working example shows how logging can be used with
multiprocessing using configuration files.  The configurations are
fairly simple, but serve to illustrate how more complex ones could be
implemented in a real multiprocessing scenario.

In the example, the main process spawns a listener process and some
worker processes.  Each of the main process, the listener and the
workers have three separate configurations (the workers all share the
same configuration).  We can see logging in the main process, how the
workers log to a QueueHandler and how the listener implements a
QueueListener and a more complex logging configuration, and arranges to
dispatch events received via the queue to the handlers specified in the
configuration.  Note that these configurations are purely illustrative,
but you should be able to adapt this example to your own scenario.

Here’s the script - the docstrings and the comments hopefully explain
how it works:

     import logging import logging.config import logging.handlers from multiprocessing import Process, Queue, Event, current_process import os import random import time  class MyHandler:     """     A simple handler for logging events. It runs in the listener process and     dispatches events to loggers based on the name in the received record,     which then get dispatched, by the logging system, to the handlers     configured for those loggers.     """      def handle(self, record):         if record.name == "root":             logger = logging.getLogger()         else:             logger = logging.getLogger(record.name)          if logger.isEnabledFor(record.levelno):             # The process name is transformed just to show that it's the listener             # doing the logging to files and console             record.processName = '%s (for %s)' % (current_process().name, record.processName)             logger.handle(record)  def listener_process(q, stop_event, config):     """     This could be done in the main process, but is just done in a separate     process for illustrative purposes.      This initialises logging according to the specified configuration,     starts the listener and waits for the main process to signal completion     via the event. The listener is then stopped, and the process exits.     """     logging.config.dictConfig(config)     listener = logging.handlers.QueueListener(q, MyHandler())     listener.start()     if os.name == 'posix':         # On POSIX, the setup logger will have been configured in the         # parent process, but should have been disabled following the         # dictConfig call.         # On Windows, since fork isn't used, the setup logger won't         # exist in the child, so it would be created and the message         # would appear - hence the "if posix" clause.         logger = logging.getLogger('setup')         logger.critical('Should not appear, because of disabled logger ...')     stop_event.wait()     listener.stop()  def worker_process(config):     """     A number of these are spawned for the purpose of illustration. In     practice, they could be a heterogeneous bunch of processes rather than     ones which are identical to each other.      This initialises logging according to the specified configuration,     and logs a hundred messages with random levels to randomly selected     loggers.      A small sleep is added to allow other processes a chance to run. This     is not strictly needed, but it mixes the output from the different     processes a bit more than if it's left out.     """     logging.config.dictConfig(config)     levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,               logging.CRITICAL]     loggers = ['foo', 'foo.bar', 'foo.bar.baz',                'spam', 'spam.ham', 'spam.ham.eggs']     if os.name == 'posix':         # On POSIX, the setup logger will have been configured in the         # parent process, but should have been disabled following the         # dictConfig call.         # On Windows, since fork isn't used, the setup logger won't         # exist in the child, so it would be created and the message         # would appear - hence the "if posix" clause.         logger = logging.getLogger('setup')         logger.critical('Should not appear, because of disabled logger ...')     for i in range(100):         lvl = random.choice(levels)         logger = logging.getLogger(random.choice(loggers))         logger.log(lvl, 'Message no. %d', i)         time.sleep(0.01)  def main():     q = Queue()     # The main process gets a simple configuration which prints to the console.     config_initial = {         'version': 1,         'handlers': {             'console': {                 'class': 'logging.StreamHandler',                 'level': 'INFO'             }         },         'root': {             'handlers': ['console'],             'level': 'DEBUG'         }     }     # The worker process configuration is just a QueueHandler attached to the     # root logger, which allows all messages to be sent to the queue.     # We disable existing loggers to disable the "setup" logger used in the     # parent process. This is needed on POSIX because the logger will     # be there in the child following a fork().     config_worker = {         'version': 1,         'disable_existing_loggers': True,         'handlers': {             'queue': {                 'class': 'logging.handlers.QueueHandler',                 'queue': q             }         },         'root': {             'handlers': ['queue'],             'level': 'DEBUG'         }     }     # The listener process configuration shows that the full flexibility of     # logging configuration is available to dispatch events to handlers however     # you want.     # We disable existing loggers to disable the "setup" logger used in the     # parent process. This is needed on POSIX because the logger will     # be there in the child following a fork().     config_listener = {         'version': 1,         'disable_existing_loggers': True,         'formatters': {             'detailed': {                 'class': 'logging.Formatter',                 'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'             },             'simple': {                 'class': 'logging.Formatter',                 'format': '%(name)-15s %(levelname)-8s %(processName)-10s %(message)s'             }         },         'handlers': {             'console': {                 'class': 'logging.StreamHandler',                 'formatter': 'simple',                 'level': 'INFO'             },             'file': {                 'class': 'logging.FileHandler',                 'filename': 'mplog.log',                 'mode': 'w',                 'formatter': 'detailed'             },             'foofile': {                 'class': 'logging.FileHandler',                 'filename': 'mplog-foo.log',                 'mode': 'w',                 'formatter': 'detailed'             },             'errors': {                 'class': 'logging.FileHandler',                 'filename': 'mplog-errors.log',                 'mode': 'w',                 'formatter': 'detailed',                 'level': 'ERROR'             }         },         'loggers': {             'foo': {                 'handlers': ['foofile']             }         },         'root': {             'handlers': ['console', 'file', 'errors'],             'level': 'DEBUG'         }     }     # Log some initial events, just to show that logging in the parent works     # normally.     logging.config.dictConfig(config_initial)     logger = logging.getLogger('setup')     logger.info('About to create workers ...')     workers = []     for i in range(5):         wp = Process(target=worker_process, name='worker %d' % (i + 1),                      args=(config_worker,))         workers.append(wp)         wp.start()         logger.info('Started worker: %s', wp.name)     logger.info('About to create listener ...')     stop_event = Event()     lp = Process(target=listener_process, name='listener',                  args=(q, stop_event, config_listener))     lp.start()     logger.info('Started listener')     # We now hang around for the workers to finish their work.     for wp in workers:         wp.join()     # Workers all done, listening can now stop.     # Logging in the parent still works normally.     logger.info('Telling listener to stop ...')     stop_event.set()     lp.join()     logger.info('All done.')  if __name__ == '__main__':     main()


File: python.info,  Node: Inserting a BOM into messages sent to a SysLogHandler,  Next: Implementing structured logging,  Prev: A more elaborate multiprocessing example,  Up: Logging Cookbook

10.7.18 Inserting a BOM into messages sent to a SysLogHandler
-------------------------------------------------------------

RFC 5424(1) requires that a Unicode message be sent to a syslog daemon
as a set of bytes which have the following structure: an optional
pure-ASCII component, followed by a UTF-8 Byte Order Mark (BOM),
followed by Unicode encoded using UTF-8.  (See the relevant section of
the specification(2).)

In Python 3.1, code was added to *note SysLogHandler: a13. to insert a
BOM into the message, but unfortunately, it was implemented incorrectly,
with the BOM appearing at the beginning of the message and hence not
allowing any pure-ASCII component to appear before it.

As this behaviour is broken, the incorrect BOM insertion code is being
removed from Python 3.2.4 and later.  However, it is not being replaced,
and if you want to produce RFC 5424(3)-compliant messages which include
a BOM, an optional pure-ASCII sequence before it and arbitrary Unicode
after it, encoded using UTF-8, then you need to do the following:

  1. Attach a *note Formatter: 1fc4. instance to your *note
     SysLogHandler: a13. instance, with a format string such as:

          'ASCII section\ufeffUnicode section'

     The Unicode code point U+FEFF, when encoded using UTF-8, will be
     encoded as a UTF-8 BOM – the byte-string ‘b'\xef\xbb\xbf'’.

  2. Replace the ASCII section with whatever placeholders you like, but
     make sure that the data that appears in there after substitution is
     always ASCII (that way, it will remain unchanged after UTF-8
     encoding).

  3. Replace the Unicode section with whatever placeholders you like; if
     the data which appears there after substitution contains characters
     outside the ASCII range, that’s fine – it will be encoded using
     UTF-8.

The formatted message `will' be encoded using UTF-8 encoding by
‘SysLogHandler’.  If you follow the above rules, you should be able to
produce RFC 5424(4)-compliant messages.  If you don’t, logging may not
complain, but your messages will not be RFC 5424-compliant, and your
syslog daemon may complain.

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc5424.html

   (2) https://tools.ietf.org/html/rfc5424.html#section-6

   (3) https://tools.ietf.org/html/rfc5424.html

   (4) https://tools.ietf.org/html/rfc5424.html


File: python.info,  Node: Implementing structured logging,  Next: Customizing handlers with dictConfig,  Prev: Inserting a BOM into messages sent to a SysLogHandler,  Up: Logging Cookbook

10.7.19 Implementing structured logging
---------------------------------------

Although most logging messages are intended for reading by humans, and
thus not readily machine-parseable, there might be circumstances where
you want to output messages in a structured format which `is' capable of
being parsed by a program (without needing complex regular expressions
to parse the log message).  This is straightforward to achieve using the
logging package.  There are a number of ways in which this could be
achieved, but the following is a simple approach which uses JSON to
serialise the event in a machine-parseable manner:

     import json import logging  class StructuredMessage:     def __init__(self, message, /, **kwargs):         self.message = message         self.kwargs = kwargs      def __str__(self):         return '%s >>> %s' % (self.message, json.dumps(self.kwargs))  _ = StructuredMessage   # optional, to improve readability  logging.basicConfig(level=logging.INFO, format='%(message)s') logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456))

If the above script is run, it prints:

     message 1 >>> {"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"}

Note that the order of items might be different according to the version
of Python used.

If you need more specialised processing, you can use a custom JSON
encoder, as in the following complete example:

     from __future__ import unicode_literals  import json import logging  # This next bit is to ensure the script runs unchanged on 2.x and 3.x try:     unicode except NameError:     unicode = str  class Encoder(json.JSONEncoder):     def default(self, o):         if isinstance(o, set):             return tuple(o)         elif isinstance(o, unicode):             return o.encode('unicode_escape').decode('ascii')         return super(Encoder, self).default(o)  class StructuredMessage:     def __init__(self, message, /, **kwargs):         self.message = message         self.kwargs = kwargs      def __str__(self):         s = Encoder().encode(self.kwargs)         return '%s >>> %s' % (self.message, s)  _ = StructuredMessage   # optional, to improve readability  def main():     logging.basicConfig(level=logging.INFO, format='%(message)s')     logging.info(_('message 1', set_value={1, 2, 3}, snowman='\u2603'))  if __name__ == '__main__':     main()

When the above script is run, it prints:

     message 1 >>> {"snowman": "\u2603", "set_value": [1, 2, 3]}

Note that the order of items might be different according to the version
of Python used.


File: python.info,  Node: Customizing handlers with dictConfig,  Next: Using particular formatting styles throughout your application,  Prev: Implementing structured logging,  Up: Logging Cookbook

10.7.20 Customizing handlers with ‘dictConfig()’
------------------------------------------------

There are times when you want to customize logging handlers in
particular ways, and if you use *note dictConfig(): b1e. you may be able
to do this without subclassing.  As an example, consider that you may
want to set the ownership of a log file.  On POSIX, this is easily done
using *note shutil.chown(): a6b, but the file handlers in the stdlib
don’t offer built-in support.  You can customize handler creation using
a plain function such as:

     def owned_file_handler(filename, mode='a', encoding=None, owner=None):     if owner:         if not os.path.exists(filename):             open(filename, 'a').close()         shutil.chown(filename, *owner)     return logging.FileHandler(filename, mode, encoding)

You can then specify, in a logging configuration passed to *note
dictConfig(): b1e, that a logging handler be created by calling this
function:

     LOGGING = {     'version': 1,     'disable_existing_loggers': False,     'formatters': {         'default': {             'format': '%(asctime)s %(levelname)s %(name)s %(message)s'         },     },     'handlers': {         'file':{             # The values below are popped from this dictionary and             # used to create the handler, set the handler's level and             # its formatter.             '()': owned_file_handler,             'level':'DEBUG',             'formatter': 'default',             # The values below are passed to the handler creator callable             # as keyword arguments.             'owner': ['pulse', 'pulse'],             'filename': 'chowntest.log',             'mode': 'w',             'encoding': 'utf-8',         },     },     'root': {         'handlers': ['file'],         'level': 'DEBUG',     }, }

In this example I am setting the ownership using the ‘pulse’ user and
group, just for the purposes of illustration.  Putting it together into
a working script, ‘chowntest.py’:

     import logging, logging.config, os, shutil  def owned_file_handler(filename, mode='a', encoding=None, owner=None):     if owner:         if not os.path.exists(filename):             open(filename, 'a').close()         shutil.chown(filename, *owner)     return logging.FileHandler(filename, mode, encoding)  LOGGING = {     'version': 1,     'disable_existing_loggers': False,     'formatters': {         'default': {             'format': '%(asctime)s %(levelname)s %(name)s %(message)s'         },     },     'handlers': {         'file':{             # The values below are popped from this dictionary and             # used to create the handler, set the handler's level and             # its formatter.             '()': owned_file_handler,             'level':'DEBUG',             'formatter': 'default',             # The values below are passed to the handler creator callable             # as keyword arguments.             'owner': ['pulse', 'pulse'],             'filename': 'chowntest.log',             'mode': 'w',             'encoding': 'utf-8',         },     },     'root': {         'handlers': ['file'],         'level': 'DEBUG',     }, }  logging.config.dictConfig(LOGGING) logger = logging.getLogger('mylogger') logger.debug('A debug message')

To run this, you will probably need to run as ‘root’:

     $ sudo python3.3 chowntest.py $ cat chowntest.log 2013-11-05 09:34:51,128 DEBUG mylogger A debug message $ ls -l chowntest.log -rw-r--r-- 1 pulse pulse 55 2013-11-05 09:34 chowntest.log

Note that this example uses Python 3.3 because that’s where *note
shutil.chown(): a6b. makes an appearance.  This approach should work
with any Python version that supports *note dictConfig(): b1e. - namely,
Python 2.7, 3.2 or later.  With pre-3.3 versions, you would need to
implement the actual ownership change using e.g.  *note os.chown(): a29.

In practice, the handler-creating function may be in a utility module
somewhere in your project.  Instead of the line in the configuration:

     '()': owned_file_handler,

you could use e.g.:

     '()': 'ext://project.util.owned_file_handler',

where ‘project.util’ can be replaced with the actual name of the package
where the function resides.  In the above working script, using
‘'ext://__main__.owned_file_handler'’ should work.  Here, the actual
callable is resolved by *note dictConfig(): b1e. from the ‘ext://’
specification.

This example hopefully also points the way to how you could implement
other types of file change - e.g.  setting specific POSIX permission
bits - in the same way, using *note os.chmod(): a28.

Of course, the approach could also be extended to types of handler other
than a *note FileHandler: 202a. - for example, one of the rotating file
handlers, or a different type of handler altogether.


File: python.info,  Node: Using particular formatting styles throughout your application,  Next: Configuring filters with dictConfig,  Prev: Customizing handlers with dictConfig,  Up: Logging Cookbook

10.7.21 Using particular formatting styles throughout your application
----------------------------------------------------------------------

In Python 3.2, the *note Formatter: 1fc4. gained a ‘style’ keyword
parameter which, while defaulting to ‘%’ for backward compatibility,
allowed the specification of ‘{’ or ‘$’ to support the formatting
approaches supported by *note str.format(): 4cf. and *note
string.Template: 3e0.  Note that this governs the formatting of logging
messages for final output to logs, and is completely orthogonal to how
an individual logging message is constructed.

Logging calls (*note debug(): 704, *note info(): 1fc6. etc.)  only take
positional parameters for the actual logging message itself, with
keyword parameters used only for determining options for how to handle
the logging call (e.g.  the ‘exc_info’ keyword parameter to indicate
that traceback information should be logged, or the ‘extra’ keyword
parameter to indicate additional contextual information to be added to
the log).  So you cannot directly make logging calls using *note
str.format(): 4cf. or *note string.Template: 3e0. syntax, because
internally the logging package uses %-formatting to merge the format
string and the variable arguments.  There would no changing this while
preserving backward compatibility, since all logging calls which are out
there in existing code will be using %-format strings.

There have been suggestions to associate format styles with specific
loggers, but that approach also runs into backward compatibility
problems because any existing code could be using a given logger name
and using %-formatting.

For logging to work interoperably between any third-party libraries and
your code, decisions about formatting need to be made at the level of
the individual logging call.  This opens up a couple of ways in which
alternative formatting styles can be accommodated.

* Menu:

* Using LogRecord factories::
* Using custom message objects::


File: python.info,  Node: Using LogRecord factories,  Next: Using custom message objects,  Up: Using particular formatting styles throughout your application

10.7.21.1 Using LogRecord factories
...................................

In Python 3.2, along with the *note Formatter: 1fc4. changes mentioned
above, the logging package gained the ability to allow users to set
their own *note LogRecord: 8fa. subclasses, using the *note
setLogRecordFactory(): 1ff9. function.  You can use this to set your own
subclass of *note LogRecord: 8fa, which does the Right Thing by
overriding the *note getMessage(): 1ff7. method.  The base class
implementation of this method is where the ‘msg % args’ formatting
happens, and where you can substitute your alternate formatting;
however, you should be careful to support all formatting styles and
allow %-formatting as the default, to ensure interoperability with other
code.  Care should also be taken to call ‘str(self.msg)’, just as the
base implementation does.

Refer to the reference documentation on *note setLogRecordFactory():
1ff9. and *note LogRecord: 8fa. for more information.


File: python.info,  Node: Using custom message objects,  Prev: Using LogRecord factories,  Up: Using particular formatting styles throughout your application

10.7.21.2 Using custom message objects
......................................

There is another, perhaps simpler way that you can use {}- and $-
formatting to construct your individual log messages.  You may recall
(from *note Using arbitrary objects as messages: 1ffb.) that when
logging you can use an arbitrary object as a message format string, and
that the logging package will call *note str(): 325. on that object to
get the actual format string.  Consider the following two classes:

     class BraceMessage:     def __init__(self, fmt, /, *args, **kwargs):         self.fmt = fmt         self.args = args         self.kwargs = kwargs      def __str__(self):         return self.fmt.format(*self.args, **self.kwargs)  class DollarMessage:     def __init__(self, fmt, /, **kwargs):         self.fmt = fmt         self.kwargs = kwargs      def __str__(self):         from string import Template         return Template(self.fmt).substitute(**self.kwargs)

Either of these can be used in place of a format string, to allow {}- or
$-formatting to be used to build the actual “message” part which appears
in the formatted log output in place of “%(message)s” or “{message}” or
“$message”.  If you find it a little unwieldy to use the class names
whenever you want to log something, you can make it more palatable if
you use an alias such as ‘M’ or ‘_’ for the message (or perhaps ‘__’, if
you are using ‘_’ for localization).

Examples of this approach are given below.  Firstly, formatting with
*note str.format(): 4cf.:

     >>> __ = BraceMessage >>> print(__('Message with {0} {1}', 2, 'placeholders')) Message with 2 placeholders >>> class Point: pass ... >>> p = Point() >>> p.x = 0.5 >>> p.y = 0.5 >>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})', point=p)) Message with coordinates: (0.50, 0.50)

Secondly, formatting with *note string.Template: 3e0.:

     >>> __ = DollarMessage >>> print(__('Message with $num $what', num=2, what='placeholders')) Message with 2 placeholders >>>

One thing to note is that you pay no significant performance penalty
with this approach: the actual formatting happens not when you make the
logging call, but when (and if) the logged message is actually about to
be output to a log by a handler.  So the only slightly unusual thing
which might trip you up is that the parentheses go around the format
string and the arguments, not just the format string.  That’s because
the __ notation is just syntax sugar for a constructor call to one of
the ‘XXXMessage’ classes shown above.


File: python.info,  Node: Configuring filters with dictConfig,  Next: Customized exception formatting,  Prev: Using particular formatting styles throughout your application,  Up: Logging Cookbook

10.7.22 Configuring filters with ‘dictConfig()’
-----------------------------------------------

You `can' configure filters using *note dictConfig(): b1e, though it
might not be obvious at first glance how to do it (hence this recipe).
Since *note Filter: b6a. is the only filter class included in the
standard library, and it is unlikely to cater to many requirements (it’s
only there as a base class), you will typically need to define your own
*note Filter: b6a. subclass with an overridden *note filter(): 1ff1.
method.  To do this, specify the ‘()’ key in the configuration
dictionary for the filter, specifying a callable which will be used to
create the filter (a class is the most obvious, but you can provide any
callable which returns a *note Filter: b6a. instance).  Here is a
complete example:

     import logging import logging.config import sys  class MyFilter(logging.Filter):     def __init__(self, param=None):         self.param = param      def filter(self, record):         if self.param is None:             allow = True         else:             allow = self.param not in record.msg         if allow:             record.msg = 'changed: ' + record.msg         return allow  LOGGING = {     'version': 1,     'filters': {         'myfilter': {             '()': MyFilter,             'param': 'noshow',         }     },     'handlers': {         'console': {             'class': 'logging.StreamHandler',             'filters': ['myfilter']         }     },     'root': {         'level': 'DEBUG',         'handlers': ['console']     }, }  if __name__ == '__main__':     logging.config.dictConfig(LOGGING)     logging.debug('hello')     logging.debug('hello - noshow')

This example shows how you can pass configuration data to the callable
which constructs the instance, in the form of keyword parameters.  When
run, the above script will print:

     changed: hello

which shows that the filter is working as configured.

A couple of extra points to note:

   * If you can’t refer to the callable directly in the configuration
     (e.g.  if it lives in a different module, and you can’t import it
     directly where the configuration dictionary is), you can use the
     form ‘ext://...’ as described in *note Access to external objects:
     2021.  For example, you could have used the text
     ‘'ext://__main__.MyFilter'’ instead of ‘MyFilter’ in the above
     example.

   * As well as for filters, this technique can also be used to
     configure custom handlers and formatters.  See *note User-defined
     objects: 201a. for more information on how logging supports using
     user-defined objects in its configuration, and see the other
     cookbook recipe *note Customizing handlers with dictConfig(): 40c8.
     above.


File: python.info,  Node: Customized exception formatting,  Next: Speaking logging messages,  Prev: Configuring filters with dictConfig,  Up: Logging Cookbook

10.7.23 Customized exception formatting
---------------------------------------

There might be times when you want to do customized exception formatting
- for argument’s sake, let’s say you want exactly one line per logged
event, even when exception information is present.  You can do this with
a custom formatter class, as shown in the following example:

     import logging  class OneLineExceptionFormatter(logging.Formatter):     def formatException(self, exc_info):         """         Format an exception so that it prints on a single line.         """         result = super(OneLineExceptionFormatter, self).formatException(exc_info)         return repr(result)  # or format into one line however you want to      def format(self, record):         s = super(OneLineExceptionFormatter, self).format(record)         if record.exc_text:             s = s.replace('\n', '') + '|'         return s  def configure_logging():     fh = logging.FileHandler('output.txt', 'w')     f = OneLineExceptionFormatter('%(asctime)s|%(levelname)s|%(message)s|',                                   '%d/%m/%Y %H:%M:%S')     fh.setFormatter(f)     root = logging.getLogger()     root.setLevel(logging.DEBUG)     root.addHandler(fh)  def main():     configure_logging()     logging.info('Sample message')     try:         x = 1 / 0     except ZeroDivisionError as e:         logging.exception('ZeroDivisionError: %s', e)  if __name__ == '__main__':     main()

When run, this produces a file with exactly two lines:

     28/01/2015 07:21:23|INFO|Sample message| 28/01/2015 07:21:23|ERROR|ZeroDivisionError: integer division or modulo by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: integer division or modulo by zero'|

While the above treatment is simplistic, it points the way to how
exception information can be formatted to your liking.  The *note
traceback: 113. module may be helpful for more specialized needs.


File: python.info,  Node: Speaking logging messages,  Next: Buffering logging messages and outputting them conditionally,  Prev: Customized exception formatting,  Up: Logging Cookbook

10.7.24 Speaking logging messages
---------------------------------

There might be situations when it is desirable to have logging messages
rendered in an audible rather than a visible format.  This is easy to do
if you have text-to-speech (TTS) functionality available in your system,
even if it doesn’t have a Python binding.  Most TTS systems have a
command line program you can run, and this can be invoked from a handler
using *note subprocess: f9.  It’s assumed here that TTS command line
programs won’t expect to interact with users or take a long time to
complete, and that the frequency of logged messages will be not so high
as to swamp the user with messages, and that it’s acceptable to have the
messages spoken one at a time rather than concurrently, The example
implementation below waits for one message to be spoken before the next
is processed, and this might cause other handlers to be kept waiting.
Here is a short example showing the approach, which assumes that the
‘espeak’ TTS package is available:

     import logging import subprocess import sys  class TTSHandler(logging.Handler):     def emit(self, record):         msg = self.format(record)         # Speak slowly in a female English voice         cmd = ['espeak', '-s150', '-ven+f3', msg]         p = subprocess.Popen(cmd, stdout=subprocess.PIPE,                              stderr=subprocess.STDOUT)         # wait for the program to finish         p.communicate()  def configure_logging():     h = TTSHandler()     root = logging.getLogger()     root.addHandler(h)     # the default formatter just returns the message     root.setLevel(logging.DEBUG)  def main():     logging.info('Hello')     logging.debug('Goodbye')  if __name__ == '__main__':     configure_logging()     sys.exit(main())

When run, this script should say “Hello” and then “Goodbye” in a female
voice.

The above approach can, of course, be adapted to other TTS systems and
even other systems altogether which can process messages via external
programs run from a command line.


File: python.info,  Node: Buffering logging messages and outputting them conditionally,  Next: Formatting times using UTC GMT via configuration,  Prev: Speaking logging messages,  Up: Logging Cookbook

10.7.25 Buffering logging messages and outputting them conditionally
--------------------------------------------------------------------

There might be situations where you want to log messages in a temporary
area and only output them if a certain condition occurs.  For example,
you may want to start logging debug events in a function, and if the
function completes without errors, you don’t want to clutter the log
with the collected debug information, but if there is an error, you want
all the debug information to be output as well as the error.

Here is an example which shows how you could do this using a decorator
for your functions where you want logging to behave this way.  It makes
use of the *note logging.handlers.MemoryHandler: 2024, which allows
buffering of logged events until some condition occurs, at which point
the buffered events are ‘flushed’ - passed to another handler (the
‘target’ handler) for processing.  By default, the ‘MemoryHandler’
flushed when its buffer gets filled up or an event whose level is
greater than or equal to a specified threshold is seen.  You can use
this recipe with a more specialised subclass of ‘MemoryHandler’ if you
want custom flushing behavior.

The example script has a simple function, ‘foo’, which just cycles
through all the logging levels, writing to ‘sys.stderr’ to say what
level it’s about to log at, and then actually logging a message at that
level.  You can pass a parameter to ‘foo’ which, if true, will log at
ERROR and CRITICAL levels - otherwise, it only logs at DEBUG, INFO and
WARNING levels.

The script just arranges to decorate ‘foo’ with a decorator which will
do the conditional logging that’s required.  The decorator takes a
logger as a parameter and attaches a memory handler for the duration of
the call to the decorated function.  The decorator can be additionally
parameterised using a target handler, a level at which flushing should
occur, and a capacity for the buffer (number of records buffered).
These default to a *note StreamHandler: b68. which writes to
‘sys.stderr’, ‘logging.ERROR’ and ‘100’ respectively.

Here’s the script:

     import logging from logging.handlers import MemoryHandler import sys  logger = logging.getLogger(__name__) logger.addHandler(logging.NullHandler())  def log_if_errors(logger, target_handler=None, flush_level=None, capacity=None):     if target_handler is None:         target_handler = logging.StreamHandler()     if flush_level is None:         flush_level = logging.ERROR     if capacity is None:         capacity = 100     handler = MemoryHandler(capacity, flushLevel=flush_level, target=target_handler)      def decorator(fn):         def wrapper(*args, **kwargs):             logger.addHandler(handler)             try:                 return fn(*args, **kwargs)             except Exception:                 logger.exception('call failed')                 raise             finally:                 super(MemoryHandler, handler).flush()                 logger.removeHandler(handler)         return wrapper      return decorator  def write_line(s):     sys.stderr.write('%s\n' % s)  def foo(fail=False):     write_line('about to log at DEBUG ...')     logger.debug('Actually logged at DEBUG')     write_line('about to log at INFO ...')     logger.info('Actually logged at INFO')     write_line('about to log at WARNING ...')     logger.warning('Actually logged at WARNING')     if fail:         write_line('about to log at ERROR ...')         logger.error('Actually logged at ERROR')         write_line('about to log at CRITICAL ...')         logger.critical('Actually logged at CRITICAL')     return fail  decorated_foo = log_if_errors(logger)(foo)  if __name__ == '__main__':     logger.setLevel(logging.DEBUG)     write_line('Calling undecorated foo with False')     assert not foo(False)     write_line('Calling undecorated foo with True')     assert foo(True)     write_line('Calling decorated foo with False')     assert not decorated_foo(False)     write_line('Calling decorated foo with True')     assert decorated_foo(True)

When this script is run, the following output should be observed:

     Calling undecorated foo with False about to log at DEBUG ... about to log at INFO ... about to log at WARNING ... Calling undecorated foo with True about to log at DEBUG ... about to log at INFO ... about to log at WARNING ... about to log at ERROR ... about to log at CRITICAL ... Calling decorated foo with False about to log at DEBUG ... about to log at INFO ... about to log at WARNING ... Calling decorated foo with True about to log at DEBUG ... about to log at INFO ... about to log at WARNING ... about to log at ERROR ... Actually logged at DEBUG Actually logged at INFO Actually logged at WARNING Actually logged at ERROR about to log at CRITICAL ... Actually logged at CRITICAL

As you can see, actual logging output only occurs when an event is
logged whose severity is ERROR or greater, but in that case, any
previous events at lower severities are also logged.

You can of course use the conventional means of decoration:

     @log_if_errors(logger) def foo(fail=False):     ...


File: python.info,  Node: Formatting times using UTC GMT via configuration,  Next: Using a context manager for selective logging,  Prev: Buffering logging messages and outputting them conditionally,  Up: Logging Cookbook

10.7.26 Formatting times using UTC (GMT) via configuration
----------------------------------------------------------

Sometimes you want to format times using UTC, which can be done using a
class such as ‘UTCFormatter’, shown below:

     import logging import time  class UTCFormatter(logging.Formatter):     converter = time.gmtime

and you can then use the ‘UTCFormatter’ in your code instead of *note
Formatter: 1fc4.  If you want to do that via configuration, you can use
the *note dictConfig(): b1e. API with an approach illustrated by the
following complete example:

     import logging import logging.config import time  class UTCFormatter(logging.Formatter):     converter = time.gmtime  LOGGING = {     'version': 1,     'disable_existing_loggers': False,     'formatters': {         'utc': {             '()': UTCFormatter,             'format': '%(asctime)s %(message)s',         },         'local': {             'format': '%(asctime)s %(message)s',         }     },     'handlers': {         'console1': {             'class': 'logging.StreamHandler',             'formatter': 'utc',         },         'console2': {             'class': 'logging.StreamHandler',             'formatter': 'local',         },     },     'root': {         'handlers': ['console1', 'console2'],    } }  if __name__ == '__main__':     logging.config.dictConfig(LOGGING)     logging.warning('The local time is %s', time.asctime())

When this script is run, it should print something like:

     2015-10-17 12:53:29,501 The local time is Sat Oct 17 13:53:29 2015 2015-10-17 13:53:29,501 The local time is Sat Oct 17 13:53:29 2015

showing how the time is formatted both as local time and UTC, one for
each handler.


File: python.info,  Node: Using a context manager for selective logging,  Next: A CLI application starter template,  Prev: Formatting times using UTC GMT via configuration,  Up: Logging Cookbook

10.7.27 Using a context manager for selective logging
-----------------------------------------------------

There are times when it would be useful to temporarily change the
logging configuration and revert it back after doing something.  For
this, a context manager is the most obvious way of saving and restoring
the logging context.  Here is a simple example of such a context
manager, which allows you to optionally change the logging level and add
a logging handler purely in the scope of the context manager:

     import logging import sys  class LoggingContext:     def __init__(self, logger, level=None, handler=None, close=True):         self.logger = logger         self.level = level         self.handler = handler         self.close = close      def __enter__(self):         if self.level is not None:             self.old_level = self.logger.level             self.logger.setLevel(self.level)         if self.handler:             self.logger.addHandler(self.handler)      def __exit__(self, et, ev, tb):         if self.level is not None:             self.logger.setLevel(self.old_level)         if self.handler:             self.logger.removeHandler(self.handler)         if self.handler and self.close:             self.handler.close()         # implicit return of None => don't swallow exceptions

If you specify a level value, the logger’s level is set to that value in
the scope of the with block covered by the context manager.  If you
specify a handler, it is added to the logger on entry to the block and
removed on exit from the block.  You can also ask the manager to close
the handler for you on block exit - you could do this if you don’t need
the handler any more.

To illustrate how it works, we can add the following block of code to
the above:

     if __name__ == '__main__':     logger = logging.getLogger('foo')     logger.addHandler(logging.StreamHandler())     logger.setLevel(logging.INFO)     logger.info('1. This should appear just once on stderr.')     logger.debug('2. This should not appear.')     with LoggingContext(logger, level=logging.DEBUG):         logger.debug('3. This should appear once on stderr.')     logger.debug('4. This should not appear.')     h = logging.StreamHandler(sys.stdout)     with LoggingContext(logger, level=logging.DEBUG, handler=h, close=True):         logger.debug('5. This should appear twice - once on stderr and once on stdout.')     logger.info('6. This should appear just once on stderr.')     logger.debug('7. This should not appear.')

We initially set the logger’s level to ‘INFO’, so message #1 appears and
message #2 doesn’t.  We then change the level to ‘DEBUG’ temporarily in
the following ‘with’ block, and so message #3 appears.  After the block
exits, the logger’s level is restored to ‘INFO’ and so message #4
doesn’t appear.  In the next ‘with’ block, we set the level to ‘DEBUG’
again but also add a handler writing to ‘sys.stdout’.  Thus, message #5
appears twice on the console (once via ‘stderr’ and once via ‘stdout’).
After the ‘with’ statement’s completion, the status is as it was before
so message #6 appears (like message #1) whereas message #7 doesn’t (just
like message #2).

If we run the resulting script, the result is as follows:

     $ python logctx.py 1. This should appear just once on stderr. 3. This should appear once on stderr. 5. This should appear twice - once on stderr and once on stdout. 5. This should appear twice - once on stderr and once on stdout. 6. This should appear just once on stderr.

If we run it again, but pipe ‘stderr’ to ‘/dev/null’, we see the
following, which is the only message written to ‘stdout’:

     $ python logctx.py 2>/dev/null 5. This should appear twice - once on stderr and once on stdout.

Once again, but piping ‘stdout’ to ‘/dev/null’, we get:

     $ python logctx.py >/dev/null 1. This should appear just once on stderr. 3. This should appear once on stderr. 5. This should appear twice - once on stderr and once on stdout. 6. This should appear just once on stderr.

In this case, the message #5 printed to ‘stdout’ doesn’t appear, as
expected.

Of course, the approach described here can be generalised, for example
to attach logging filters temporarily.  Note that the above code works
in Python 2 as well as Python 3.


File: python.info,  Node: A CLI application starter template,  Next: A Qt GUI for logging,  Prev: Using a context manager for selective logging,  Up: Logging Cookbook

10.7.28 A CLI application starter template
------------------------------------------

Here’s an example which shows how you can:

   * Use a logging level based on command-line arguments

   * Dispatch to multiple subcommands in separate files, all logging at
     the same level in a consistent way

   * Make use of simple, minimal configuration

Suppose we have a command-line application whose job is to stop, start
or restart some services.  This could be organised for the purposes of
illustration as a file ‘app.py’ that is the main script for the
application, with individual commands implemented in ‘start.py’,
‘stop.py’ and ‘restart.py’.  Suppose further that we want to control the
verbosity of the application via a command-line argument, defaulting to
‘logging.INFO’.  Here’s one way that ‘app.py’ could be written:

     import argparse import importlib import logging import os import sys  def main(args=None):     scriptname = os.path.basename(__file__)     parser = argparse.ArgumentParser(scriptname)     levels = ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')     parser.add_argument('--log-level', default='INFO', choices=levels)     subparsers = parser.add_subparsers(dest='command',                                        help='Available commands:')     start_cmd = subparsers.add_parser('start', help='Start a service')     start_cmd.add_argument('name', metavar='NAME',                            help='Name of service to start')     stop_cmd = subparsers.add_parser('stop',                                      help='Stop one or more services')     stop_cmd.add_argument('names', metavar='NAME', nargs='+',                           help='Name of service to stop')     restart_cmd = subparsers.add_parser('restart',                                         help='Restart one or more services')     restart_cmd.add_argument('names', metavar='NAME', nargs='+',                              help='Name of service to restart')     options = parser.parse_args()     # the code to dispatch commands could all be in this file. For the purposes     # of illustration only, we implement each command in a separate module.     try:         mod = importlib.import_module(options.command)         cmd = getattr(mod, 'command')     except (ImportError, AttributeError):         print('Unable to find the code for command \'%s\'' % options.command)         return 1     # Could get fancy here and load configuration from file or dictionary     logging.basicConfig(level=options.log_level,                         format='%(levelname)s %(name)s %(message)s')     cmd(options)  if __name__ == '__main__':     sys.exit(main())

And the ‘start’, ‘stop’ and ‘restart’ commands can be implemented in
separate modules, like so for starting:

     # start.py import logging  logger = logging.getLogger(__name__)  def command(options):     logger.debug('About to start %s', options.name)     # actually do the command processing here ...     logger.info('Started the \'%s\' service.', options.name)

and thus for stopping:

     # stop.py import logging  logger = logging.getLogger(__name__)  def command(options):     n = len(options.names)     if n == 1:         plural = ''         services = '\'%s\'' % options.names[0]     else:         plural = 's'         services = ', '.join('\'%s\'' % name for name in options.names)         i = services.rfind(', ')         services = services[:i] + ' and ' + services[i + 2:]     logger.debug('About to stop %s', services)     # actually do the command processing here ...     logger.info('Stopped the %s service%s.', services, plural)

and similarly for restarting:

     # restart.py import logging  logger = logging.getLogger(__name__)  def command(options):     n = len(options.names)     if n == 1:         plural = ''         services = '\'%s\'' % options.names[0]     else:         plural = 's'         services = ', '.join('\'%s\'' % name for name in options.names)         i = services.rfind(', ')         services = services[:i] + ' and ' + services[i + 2:]     logger.debug('About to restart %s', services)     # actually do the command processing here ...     logger.info('Restarted the %s service%s.', services, plural)

If we run this application with the default log level, we get output
like this:

     $ python app.py start foo INFO start Started the 'foo' service.  $ python app.py stop foo bar INFO stop Stopped the 'foo' and 'bar' services.  $ python app.py restart foo bar baz INFO restart Restarted the 'foo', 'bar' and 'baz' services.

The first word is the logging level, and the second word is the module
or package name of the place where the event was logged.

If we change the logging level, then we can change the information sent
to the log.  For example, if we want more information:

     $ python app.py --log-level DEBUG start foo DEBUG start About to start foo INFO start Started the 'foo' service.  $ python app.py --log-level DEBUG stop foo bar DEBUG stop About to stop 'foo' and 'bar' INFO stop Stopped the 'foo' and 'bar' services.  $ python app.py --log-level DEBUG restart foo bar baz DEBUG restart About to restart 'foo', 'bar' and 'baz' INFO restart Restarted the 'foo', 'bar' and 'baz' services.

And if we want less:

     $ python app.py --log-level WARNING start foo $ python app.py --log-level WARNING stop foo bar $ python app.py --log-level WARNING restart foo bar baz

In this case, the commands don’t print anything to the console, since
nothing at ‘WARNING’ level or above is logged by them.


File: python.info,  Node: A Qt GUI for logging,  Prev: A CLI application starter template,  Up: Logging Cookbook

10.7.29 A Qt GUI for logging
----------------------------

A question that comes up from time to time is about how to log to a GUI
application.  The Qt(1) framework is a popular cross-platform UI
framework with Python bindings using PySide2(2) or PyQt5(3) libraries.

The following example shows how to log to a Qt GUI. This introduces a
simple ‘QtHandler’ class which takes a callable, which should be a slot
in the main thread that does GUI updates.  A worker thread is also
created to show how you can log to the GUI from both the UI itself (via
a button for manual logging) as well as a worker thread doing work in
the background (here, just logging messages at random levels with random
short delays in between).

The worker thread is implemented using Qt’s ‘QThread’ class rather than
the *note threading: 109. module, as there are circumstances where one
has to use ‘QThread’, which offers better integration with other ‘Qt’
components.

The code should work with recent releases of either ‘PySide2’ or
‘PyQt5’.  You should be able to adapt the approach to earlier versions
of Qt.  Please refer to the comments in the code snippet for more
detailed information.

     import datetime import logging import random import sys import time  # Deal with minor differences between PySide2 and PyQt5 try:     from PySide2 import QtCore, QtGui, QtWidgets     Signal = QtCore.Signal     Slot = QtCore.Slot except ImportError:     from PyQt5 import QtCore, QtGui, QtWidgets     Signal = QtCore.pyqtSignal     Slot = QtCore.pyqtSlot   logger = logging.getLogger(__name__)   # # Signals need to be contained in a QObject or subclass in order to be correctly # initialized. # class Signaller(QtCore.QObject):     signal = Signal(str, logging.LogRecord)  # # Output to a Qt GUI is only supposed to happen on the main thread. So, this # handler is designed to take a slot function which is set up to run in the main # thread. In this example, the function takes a string argument which is a # formatted log message, and the log record which generated it. The formatted # string is just a convenience - you could format a string for output any way # you like in the slot function itself. # # You specify the slot function to do whatever GUI updates you want. The handler # doesn't know or care about specific UI elements. # class QtHandler(logging.Handler):     def __init__(self, slotfunc, *args, **kwargs):         super(QtHandler, self).__init__(*args, **kwargs)         self.signaller = Signaller()         self.signaller.signal.connect(slotfunc)      def emit(self, record):         s = self.format(record)         self.signaller.signal.emit(s, record)  # # This example uses QThreads, which means that the threads at the Python level # are named something like "Dummy-1". The function below gets the Qt name of the # current thread. # def ctname():     return QtCore.QThread.currentThread().objectName()   # # Used to generate random levels for logging. # LEVELS = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,           logging.CRITICAL)  # # This worker class represents work that is done in a thread separate to the # main thread. The way the thread is kicked off to do work is via a button press # that connects to a slot in the worker. # # Because the default threadName value in the LogRecord isn't much use, we add # a qThreadName which contains the QThread name as computed above, and pass that # value in an "extra" dictionary which is used to update the LogRecord with the # QThread name. # # This example worker just outputs messages sequentially, interspersed with # random delays of the order of a few seconds. # class Worker(QtCore.QObject):     @Slot()     def start(self):         extra = {'qThreadName': ctname() }         logger.debug('Started work', extra=extra)         i = 1         # Let the thread run until interrupted. This allows reasonably clean         # thread termination.         while not QtCore.QThread.currentThread().isInterruptionRequested():             delay = 0.5 + random.random() * 2             time.sleep(delay)             level = random.choice(LEVELS)             logger.log(level, 'Message after delay of %3.1f: %d', delay, i, extra=extra)             i += 1  # # Implement a simple UI for this cookbook example. This contains: # # * A read-only text edit window which holds formatted log messages # * A button to start work and log stuff in a separate thread # * A button to log something from the main thread # * A button to clear the log window # class Window(QtWidgets.QWidget):      COLORS = {         logging.DEBUG: 'black',         logging.INFO: 'blue',         logging.WARNING: 'orange',         logging.ERROR: 'red',         logging.CRITICAL: 'purple',     }      def __init__(self, app):         super(Window, self).__init__()         self.app = app         self.textedit = te = QtWidgets.QPlainTextEdit(self)         # Set whatever the default monospace font is for the platform         f = QtGui.QFont('nosuchfont')         f.setStyleHint(f.Monospace)         te.setFont(f)         te.setReadOnly(True)         PB = QtWidgets.QPushButton         self.work_button = PB('Start background work', self)         self.log_button = PB('Log a message at a random level', self)         self.clear_button = PB('Clear log window', self)         self.handler = h = QtHandler(self.update_status)         # Remember to use qThreadName rather than threadName in the format string.         fs = '%(asctime)s %(qThreadName)-12s %(levelname)-8s %(message)s'         formatter = logging.Formatter(fs)         h.setFormatter(formatter)         logger.addHandler(h)         # Set up to terminate the QThread when we exit         app.aboutToQuit.connect(self.force_quit)          # Lay out all the widgets         layout = QtWidgets.QVBoxLayout(self)         layout.addWidget(te)         layout.addWidget(self.work_button)         layout.addWidget(self.log_button)         layout.addWidget(self.clear_button)         self.setFixedSize(900, 400)          # Connect the non-worker slots and signals         self.log_button.clicked.connect(self.manual_update)         self.clear_button.clicked.connect(self.clear_display)          # Start a new worker thread and connect the slots for the worker         self.start_thread()         self.work_button.clicked.connect(self.worker.start)         # Once started, the button should be disabled         self.work_button.clicked.connect(lambda : self.work_button.setEnabled(False))      def start_thread(self):         self.worker = Worker()         self.worker_thread = QtCore.QThread()         self.worker.setObjectName('Worker')         self.worker_thread.setObjectName('WorkerThread')  # for qThreadName         self.worker.moveToThread(self.worker_thread)         # This will start an event loop in the worker thread         self.worker_thread.start()      def kill_thread(self):         # Just tell the worker to stop, then tell it to quit and wait for that         # to happen         self.worker_thread.requestInterruption()         if self.worker_thread.isRunning():             self.worker_thread.quit()             self.worker_thread.wait()         else:             print('worker has already exited.')      def force_quit(self):         # For use when the window is closed         if self.worker_thread.isRunning():             self.kill_thread()      # The functions below update the UI and run in the main thread because     # that's where the slots are set up      @Slot(str, logging.LogRecord)     def update_status(self, status, record):         color = self.COLORS.get(record.levelno, 'black')         s = '<pre><font color="%s">%s</font></pre>' % (color, status)         self.textedit.appendHtml(s)      @Slot()     def manual_update(self):         # This function uses the formatted message passed in, but also uses         # information from the record to format the message in an appropriate         # color according to its severity (level).         level = random.choice(LEVELS)         extra = {'qThreadName': ctname() }         logger.log(level, 'Manually logged!', extra=extra)      @Slot()     def clear_display(self):         self.textedit.clear()   def main():     QtCore.QThread.currentThread().setObjectName('MainThread')     logging.getLogger().setLevel(logging.DEBUG)     app = QtWidgets.QApplication(sys.argv)     example = Window(app)     example.show()     sys.exit(app.exec_())  if __name__=='__main__':     main()

   ---------- Footnotes ----------

   (1) https://www.qt.io/

   (2) https://pypi.org/project/PySide2/

   (3) https://pypi.org/project/PyQt5/


File: python.info,  Node: Regular Expression HOWTO,  Next: Socket Programming HOWTO,  Prev: Logging Cookbook,  Up: Python HOWTOs

10.8 Regular Expression HOWTO
=============================


Author: A.M. Kuchling <<amk@amk.ca>>

Abstract
........

This document is an introductory tutorial to using regular expressions
in Python with the *note re: dd. module.  It provides a gentler
introduction than the corresponding section in the Library Reference.

* Menu:

* Introduction: Introduction<15>.
* Simple Patterns::
* Using Regular Expressions::
* More Pattern Power::
* Modifying Strings::
* Common Problems::
* Feedback::


File: python.info,  Node: Introduction<15>,  Next: Simple Patterns,  Up: Regular Expression HOWTO

10.8.1 Introduction
-------------------

Regular expressions (called REs, or regexes, or regex patterns) are
essentially a tiny, highly specialized programming language embedded
inside Python and made available through the *note re: dd. module.
Using this little language, you specify the rules for the set of
possible strings that you want to match; this set might contain English
sentences, or e-mail addresses, or TeX commands, or anything you like.
You can then ask questions such as “Does this string match the
pattern?”, or “Is there a match for the pattern anywhere in this
string?”.  You can also use REs to modify a string or to split it apart
in various ways.

Regular expression patterns are compiled into a series of bytecodes
which are then executed by a matching engine written in C. For advanced
use, it may be necessary to pay careful attention to how the engine will
execute a given RE, and write the RE in a certain way in order to
produce bytecode that runs faster.  Optimization isn’t covered in this
document, because it requires that you have a good understanding of the
matching engine’s internals.

The regular expression language is relatively small and restricted, so
not all possible string processing tasks can be done using regular
expressions.  There are also tasks that `can' be done with regular
expressions, but the expressions turn out to be very complicated.  In
these cases, you may be better off writing Python code to do the
processing; while Python code will be slower than an elaborate regular
expression, it will also probably be more understandable.


File: python.info,  Node: Simple Patterns,  Next: Using Regular Expressions,  Prev: Introduction<15>,  Up: Regular Expression HOWTO

10.8.2 Simple Patterns
----------------------

We’ll start by learning about the simplest possible regular expressions.
Since regular expressions are used to operate on strings, we’ll begin
with the most common task: matching characters.

For a detailed explanation of the computer science underlying regular
expressions (deterministic and non-deterministic finite automata), you
can refer to almost any textbook on writing compilers.

* Menu:

* Matching Characters::
* Repeating Things::


File: python.info,  Node: Matching Characters,  Next: Repeating Things,  Up: Simple Patterns

10.8.2.1 Matching Characters
............................

Most letters and characters will simply match themselves.  For example,
the regular expression ‘test’ will match the string ‘test’ exactly.
(You can enable a case-insensitive mode that would let this RE match
‘Test’ or ‘TEST’ as well; more about this later.)

There are exceptions to this rule; some characters are special
`metacharacters', and don’t match themselves.  Instead, they signal that
some out-of-the-ordinary thing should be matched, or they affect other
portions of the RE by repeating them or changing their meaning.  Much of
this document is devoted to discussing various metacharacters and what
they do.

Here’s a complete list of the metacharacters; their meanings will be
discussed in the rest of this HOWTO.

     . ^ $ * + ? { } [ ] \ | ( )

The first metacharacters we’ll look at are ‘[’ and ‘]’.  They’re used
for specifying a character class, which is a set of characters that you
wish to match.  Characters can be listed individually, or a range of
characters can be indicated by giving two characters and separating them
by a ‘'-'’.  For example, ‘[abc]’ will match any of the characters ‘a’,
‘b’, or ‘c’; this is the same as ‘[a-c]’, which uses a range to express
the same set of characters.  If you wanted to match only lowercase
letters, your RE would be ‘[a-z]’.

Metacharacters are not active inside classes.  For example, ‘[akm$]’
will match any of the characters ‘'a'’, ‘'k'’, ‘'m'’, or ‘'$'’; ‘'$'’ is
usually a metacharacter, but inside a character class it’s stripped of
its special nature.

You can match the characters not listed within the class by
`complementing' the set.  This is indicated by including a ‘'^'’ as the
first character of the class.  For example, ‘[^5]’ will match any
character except ‘'5'’.  If the caret appears elsewhere in a character
class, it does not have special meaning.  For example: ‘[5^]’ will match
either a ‘'5'’ or a ‘'^'’.

Perhaps the most important metacharacter is the backslash, ‘\’.  As in
Python string literals, the backslash can be followed by various
characters to signal various special sequences.  It’s also used to
escape all the metacharacters so you can still match them in patterns;
for example, if you need to match a ‘[’ or ‘\’, you can precede them
with a backslash to remove their special meaning: ‘\[’ or ‘\\’.

Some of the special sequences beginning with ‘'\'’ represent predefined
sets of characters that are often useful, such as the set of digits, the
set of letters, or the set of anything that isn’t whitespace.

Let’s take an example: ‘\w’ matches any alphanumeric character.  If the
regex pattern is expressed in bytes, this is equivalent to the class
‘[a-zA-Z0-9_]’.  If the regex pattern is a string, ‘\w’ will match all
the characters marked as letters in the Unicode database provided by the
*note unicodedata: 11a. module.  You can use the more restricted
definition of ‘\w’ in a string pattern by supplying the *note re.ASCII:
3bd. flag when compiling the regular expression.

The following list of special sequences isn’t complete.  For a complete
list of sequences and expanded class definitions for Unicode string
patterns, see the last part of *note Regular Expression Syntax: 1685. in
the Standard Library reference.  In general, the Unicode versions match
any character that’s in the appropriate category in the Unicode
database.

‘\d’

     Matches any decimal digit; this is equivalent to the class ‘[0-9]’.

‘\D’

     Matches any non-digit character; this is equivalent to the class
     ‘[^0-9]’.

‘\s’

     Matches any whitespace character; this is equivalent to the class
     ‘[ \t\n\r\f\v]’.

‘\S’

     Matches any non-whitespace character; this is equivalent to the
     class ‘[^ \t\n\r\f\v]’.

‘\w’

     Matches any alphanumeric character; this is equivalent to the class
     ‘[a-zA-Z0-9_]’.

‘\W’

     Matches any non-alphanumeric character; this is equivalent to the
     class ‘[^a-zA-Z0-9_]’.

These sequences can be included inside a character class.  For example,
‘[\s,.]’ is a character class that will match any whitespace character,
or ‘','’ or ‘'.'’.

The final metacharacter in this section is ‘.’.  It matches anything
except a newline character, and there’s an alternate mode (*note
re.DOTALL: 1689.) where it will match even a newline.  ‘.’ is often used
where you want to match “any character”.


File: python.info,  Node: Repeating Things,  Prev: Matching Characters,  Up: Simple Patterns

10.8.2.2 Repeating Things
.........................

Being able to match varying sets of characters is the first thing
regular expressions can do that isn’t already possible with the methods
available on strings.  However, if that was the only additional
capability of regexes, they wouldn’t be much of an advance.  Another
capability is that you can specify that portions of the RE must be
repeated a certain number of times.

The first metacharacter for repeating things that we’ll look at is ‘*’.
‘*’ doesn’t match the literal character ‘'*'’; instead, it specifies
that the previous character can be matched zero or more times, instead
of exactly once.

For example, ‘ca*t’ will match ‘'ct'’ (0 ‘'a'’ characters), ‘'cat'’ (1
‘'a'’), ‘'caaat'’ (3 ‘'a'’ characters), and so forth.

Repetitions such as ‘*’ are `greedy'; when repeating a RE, the matching
engine will try to repeat it as many times as possible.  If later
portions of the pattern don’t match, the matching engine will then back
up and try again with fewer repetitions.

A step-by-step example will make this more obvious.  Let’s consider the
expression ‘a[bcd]*b’.  This matches the letter ‘'a'’, zero or more
letters from the class ‘[bcd]’, and finally ends with a ‘'b'’.  Now
imagine matching this RE against the string ‘'abcbd'’.

Step       Matched         Explanation
                           
-----------------------------------------------------------------
                           
1          ‘a’             The ‘a’ in the RE matches.
                           
                           
2          ‘abcbd’         The engine matches ‘[bcd]*’, going
                           as far as it can, which is to the
                           end of the string.
                           
                           
3          `Failure'       The engine tries to match ‘b’, but
                           the current position is at the end
                           of the string, so it fails.
                           
                           
4          ‘abcb’          Back up, so that ‘[bcd]*’ matches
                           one less character.
                           
                           
5          `Failure'       Try ‘b’ again, but the current
                           position is at the last character,
                           which is a ‘'d'’.
                           
                           
6          ‘abc’           Back up again, so that ‘[bcd]*’ is
                           only matching ‘bc’.
                           
                           
6          ‘abcb’          Try ‘b’ again.  This time the
                           character at the current position
                           is ‘'b'’, so it succeeds.
                           

The end of the RE has now been reached, and it has matched ‘'abcb'’.
This demonstrates how the matching engine goes as far as it can at
first, and if no match is found it will then progressively back up and
retry the rest of the RE again and again.  It will back up until it has
tried zero matches for ‘[bcd]*’, and if that subsequently fails, the
engine will conclude that the string doesn’t match the RE at all.

Another repeating metacharacter is ‘+’, which matches one or more times.
Pay careful attention to the difference between ‘*’ and ‘+’; ‘*’ matches
`zero' or more times, so whatever’s being repeated may not be present at
all, while ‘+’ requires at least `one' occurrence.  To use a similar
example, ‘ca+t’ will match ‘'cat'’ (1 ‘'a'’), ‘'caaat'’ (3 ‘'a'’s), but
won’t match ‘'ct'’.

There are two more repeating qualifiers.  The question mark character,
‘?’, matches either once or zero times; you can think of it as marking
something as being optional.  For example, ‘home-?brew’ matches either
‘'homebrew'’ or ‘'home-brew'’.

The most complicated repeated qualifier is ‘{m,n}’, where `m' and `n'
are decimal integers.  This qualifier means there must be at least `m'
repetitions, and at most `n'.  For example, ‘a/{1,3}b’ will match
‘'a/b'’, ‘'a//b'’, and ‘'a///b'’.  It won’t match ‘'ab'’, which has no
slashes, or ‘'a////b'’, which has four.

You can omit either `m' or `n'; in that case, a reasonable value is
assumed for the missing value.  Omitting `m' is interpreted as a lower
limit of 0, while omitting `n' results in an upper bound of infinity.

Readers of a reductionist bent may notice that the three other
qualifiers can all be expressed using this notation.  ‘{0,}’ is the same
as ‘*’, ‘{1,}’ is equivalent to ‘+’, and ‘{0,1}’ is the same as ‘?’.
It’s better to use ‘*’, ‘+’, or ‘?’ when you can, simply because they’re
shorter and easier to read.


File: python.info,  Node: Using Regular Expressions,  Next: More Pattern Power,  Prev: Simple Patterns,  Up: Regular Expression HOWTO

10.8.3 Using Regular Expressions
--------------------------------

Now that we’ve looked at some simple regular expressions, how do we
actually use them in Python?  The *note re: dd. module provides an
interface to the regular expression engine, allowing you to compile REs
into objects and then perform matches with them.

* Menu:

* Compiling Regular Expressions::
* The Backslash Plague::
* Performing Matches::
* Module-Level Functions: Module-Level Functions<2>.
* Compilation Flags::


File: python.info,  Node: Compiling Regular Expressions,  Next: The Backslash Plague,  Up: Using Regular Expressions

10.8.3.1 Compiling Regular Expressions
......................................

Regular expressions are compiled into pattern objects, which have
methods for various operations such as searching for pattern matches or
performing string substitutions.

     >>> import re >>> p = re.compile('ab*') >>> p re.compile('ab*')

*note re.compile(): 43f. also accepts an optional `flags' argument, used
to enable various special features and syntax variations.  We’ll go over
the available settings later, but for now a single example will do:

     >>> p = re.compile('ab*', re.IGNORECASE)

The RE is passed to *note re.compile(): 43f. as a string.  REs are
handled as strings because regular expressions aren’t part of the core
Python language, and no special syntax was created for expressing them.
(There are applications that don’t need REs at all, so there’s no need
to bloat the language specification by including them.)  Instead, the
*note re: dd. module is simply a C extension module included with
Python, just like the *note socket: ef. or *note zlib: 144. modules.

Putting REs in strings keeps the Python language simpler, but has one
disadvantage which is the topic of the next section.


File: python.info,  Node: The Backslash Plague,  Next: Performing Matches,  Prev: Compiling Regular Expressions,  Up: Using Regular Expressions

10.8.3.2 The Backslash Plague
.............................

As stated earlier, regular expressions use the backslash character
(‘'\'’) to indicate special forms or to allow special characters to be
used without invoking their special meaning.  This conflicts with
Python’s usage of the same character for the same purpose in string
literals.

Let’s say you want to write a RE that matches the string ‘\section’,
which might be found in a LaTeX file.  To figure out what to write in
the program code, start with the desired string to be matched.  Next,
you must escape any backslashes and other metacharacters by preceding
them with a backslash, resulting in the string ‘\\section’.  The
resulting string that must be passed to *note re.compile(): 43f. must be
‘\\section’.  However, to express this as a Python string literal, both
backslashes must be escaped `again'.

Characters              Stage
                        
-----------------------------------------------------------------------
                        
‘\section’              Text string to be matched
                        
                        
‘\\section’             Escaped backslash for
                        *note re.compile(): 43f.
                        
                        
‘"\\\\section"’         Escaped backslashes for a string literal
                        

In short, to match a literal backslash, one has to write ‘'\\\\'’ as the
RE string, because the regular expression must be ‘\\’, and each
backslash must be expressed as ‘\\’ inside a regular Python string
literal.  In REs that feature backslashes repeatedly, this leads to lots
of repeated backslashes and makes the resulting strings difficult to
understand.

The solution is to use Python’s raw string notation for regular
expressions; backslashes are not handled in any special way in a string
literal prefixed with ‘'r'’, so ‘r"\n"’ is a two-character string
containing ‘'\'’ and ‘'n'’, while ‘"\n"’ is a one-character string
containing a newline.  Regular expressions will often be written in
Python code using this raw string notation.

In addition, special escape sequences that are valid in regular
expressions, but not valid as Python string literals, now result in a
*note DeprecationWarning: 276. and will eventually become a *note
SyntaxError: 44d, which means the sequences will be invalid if raw
string notation or escaping the backslashes isn’t used.

Regular String          Raw string
                        
-----------------------------------------------
                        
‘"ab*"’                 ‘r"ab*"’
                        
                        
‘"\\\\section"’         ‘r"\\section"’
                        
                        
‘"\\w+\\s+\\1"’         ‘r"\w+\s+\1"’
                        


File: python.info,  Node: Performing Matches,  Next: Module-Level Functions<2>,  Prev: The Backslash Plague,  Up: Using Regular Expressions

10.8.3.3 Performing Matches
...........................

Once you have an object representing a compiled regular expression, what
do you do with it?  Pattern objects have several methods and attributes.
Only the most significant ones will be covered here; consult the *note
re: dd. docs for a complete listing.

Method/Attribute       Purpose
                       
---------------------------------------------------------------------------
                       
‘match()’              Determine if the RE matches at the beginning of
                       the string.
                       
                       
‘search()’             Scan through a string, looking for any location
                       where this RE matches.
                       
                       
‘findall()’            Find all substrings where the RE matches, and
                       returns them as a list.
                       
                       
‘finditer()’           Find all substrings where the RE matches, and
                       returns them as an *note iterator: f73.
                       

*note match(): 1694. and *note search(): 1695. return ‘None’ if no match
can be found.  If they’re successful, a *note match object: 891.
instance is returned, containing information about the match: where it
starts and ends, the substring it matched, and more.

You can learn about this by interactively experimenting with the *note
re: dd. module.  If you have *note tkinter: 10c. available, you may also
want to look at Tools/demo/redemo.py(1), a demonstration program
included with the Python distribution.  It allows you to enter REs and
strings, and displays whether the RE matches or fails.  ‘redemo.py’ can
be quite useful when trying to debug a complicated RE.

This HOWTO uses the standard Python interpreter for its examples.
First, run the Python interpreter, import the *note re: dd. module, and
compile a RE:

     >>> import re >>> p = re.compile('[a-z]+') >>> p re.compile('[a-z]+')

Now, you can try matching various strings against the RE ‘[a-z]+’.  An
empty string shouldn’t match at all, since ‘+’ means ‘one or more
repetitions’.  *note match(): 1694. should return ‘None’ in this case,
which will cause the interpreter to print no output.  You can explicitly
print the result of ‘match()’ to make this clear.

     >>> p.match("") >>> print(p.match("")) None

Now, let’s try it on a string that it should match, such as ‘tempo’.  In
this case, *note match(): 1694. will return a *note match object: 891,
so you should store the result in a variable for later use.

     >>> m = p.match('tempo') >>> m <re.Match object; span=(0, 5), match='tempo'>

Now you can query the *note match object: 891. for information about the
matching string.  Match object instances also have several methods and
attributes; the most important ones are:

Method/Attribute       Purpose
                       
------------------------------------------------------------------------
                       
‘group()’              Return the string matched by the RE
                       
                       
‘start()’              Return the starting position of the match
                       
                       
‘end()’                Return the ending position of the match
                       
                       
‘span()’               Return a tuple containing the (start, end)
                       positions of the match
                       

Trying these methods will soon clarify their meaning:

     >>> m.group() 'tempo' >>> m.start(), m.end() (0, 5) >>> m.span() (0, 5)

*note group(): 16a9. returns the substring that was matched by the RE.
*note start(): 16ad. and *note end(): 16ae. return the starting and
ending index of the match.  *note span(): 16af. returns both start and
end indexes in a single tuple.  Since the *note match(): 1694. method
only checks if the RE matches at the start of a string, ‘start()’ will
always be zero.  However, the *note search(): 1695. method of patterns
scans through the string, so the match may not start at zero in that
case.

     >>> print(p.match('::: message')) None >>> m = p.search('::: message'); print(m) <re.Match object; span=(4, 11), match='message'> >>> m.group() 'message' >>> m.span() (4, 11)

In actual programs, the most common style is to store the *note match
object: 891. in a variable, and then check if it was ‘None’.  This
usually looks like:

     p = re.compile( ... ) m = p.match( 'string goes here' ) if m:     print('Match found: ', m.group()) else:     print('No match')

Two pattern methods return all of the matches for a pattern.  *note
findall(): 169f. returns a list of matching strings:

     >>> p = re.compile(r'\d+') >>> p.findall('12 drummers drumming, 11 pipers piping, 10 lords a-leaping') ['12', '11', '10']

The ‘r’ prefix, making the literal a raw string literal, is needed in
this example because escape sequences in a normal “cooked” string
literal that are not recognized by Python, as opposed to regular
expressions, now result in a *note DeprecationWarning: 276. and will
eventually become a *note SyntaxError: 44d.  See *note The Backslash
Plague: 40e6.

*note findall(): 169f. has to create the entire list before it can be
returned as the result.  The *note finditer(): 16a0. method returns a
sequence of *note match object: 891. instances as an *note iterator:
f73.:

     >>> iterator = p.finditer('12 drummers drumming, 11 ... 10 ...') >>> iterator   <callable_iterator object at 0x...> >>> for match in iterator: ...     print(match.span()) ... (0, 2) (22, 24) (29, 31)

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Tools/demo/redemo.py


File: python.info,  Node: Module-Level Functions<2>,  Next: Compilation Flags,  Prev: Performing Matches,  Up: Using Regular Expressions

10.8.3.4 Module-Level Functions
...............................

You don’t have to create a pattern object and call its methods; the
*note re: dd. module also provides top-level functions called *note
match(): ba6, *note search(): ba5, *note findall(): 957, *note sub():
470, and so forth.  These functions take the same arguments as the
corresponding pattern method with the RE string added as the first
argument, and still return either ‘None’ or a *note match object: 891.
instance.

     >>> print(re.match(r'From\s+', 'Fromage amk')) None >>> re.match(r'From\s+', 'From amk Thu May 14 19:12:10 1998')   <re.Match object; span=(0, 5), match='From '>

Under the hood, these functions simply create a pattern object for you
and call the appropriate method on it.  They also store the compiled
object in a cache, so future calls using the same RE won’t need to parse
the pattern again and again.

Should you use these module-level functions, or should you get the
pattern and call its methods yourself?  If you’re accessing a regex
within a loop, pre-compiling it will save a few function calls.  Outside
of loops, there’s not much difference thanks to the internal cache.


File: python.info,  Node: Compilation Flags,  Prev: Module-Level Functions<2>,  Up: Using Regular Expressions

10.8.3.5 Compilation Flags
..........................

Compilation flags let you modify some aspects of how regular expressions
work.  Flags are available in the *note re: dd. module under two names,
a long name such as ‘IGNORECASE’ and a short, one-letter form such as
‘I’.  (If you’re familiar with Perl’s pattern modifiers, the one-letter
forms use the same letters; the short form of *note re.VERBOSE: 1698. is
*note re.X: 1690, for example.)  Multiple flags can be specified by
bitwise OR-ing them; ‘re.I | re.M’ sets both the ‘I’ and ‘M’ flags, for
example.

Here’s a table of the available flags, followed by a more detailed
explanation of each one.

Flag                                  Meaning
                                      
---------------------------------------------------------------------------------------
                                      
‘ASCII’, ‘A’                          Makes several escapes like ‘\w’, ‘\b’, ‘\s’
                                      and ‘\d’ match only on ASCII characters with
                                      the respective property.
                                      
                                      
‘DOTALL’, ‘S’                         Make ‘.’ match any character, including
                                      newlines.
                                      
                                      
‘IGNORECASE’, ‘I’                     Do case-insensitive matches.
                                      
                                      
‘LOCALE’, ‘L’                         Do a locale-aware match.
                                      
                                      
‘MULTILINE’, ‘M’                      Multi-line matching, affecting ‘^’ and ‘$’.
                                      
                                      
‘VERBOSE’, ‘X’ (for ‘extended’)       Enable verbose REs, which can be organized
                                      more cleanly and understandably.
                                      

 -- Data: I

 -- Data: IGNORECASE

     Perform case-insensitive matching; character class and literal
     strings will match letters by ignoring case.  For example, ‘[A-Z]’
     will match lowercase letters, too.  Full Unicode matching also
     works unless the ‘ASCII’ flag is used to disable non-ASCII matches.
     When the Unicode patterns ‘[a-z]’ or ‘[A-Z]’ are used in
     combination with the ‘IGNORECASE’ flag, they will match the 52
     ASCII letters and 4 additional non-ASCII letters: ‘İ’ (U+0130,
     Latin capital letter I with dot above), ‘ı’ (U+0131, Latin small
     letter dotless i), ‘ſ’ (U+017F, Latin small letter long s) and ‘K’
     (U+212A, Kelvin sign).  ‘Spam’ will match ‘'Spam'’, ‘'spam'’,
     ‘'spAM'’, or ‘'ſpam'’ (the latter is matched only in Unicode mode).
     This lowercasing doesn’t take the current locale into account; it
     will if you also set the ‘LOCALE’ flag.

 -- Data: L

 -- Data: LOCALE

     Make ‘\w’, ‘\W’, ‘\b’, ‘\B’ and case-insensitive matching dependent
     on the current locale instead of the Unicode database.

     Locales are a feature of the C library intended to help in writing
     programs that take account of language differences.  For example,
     if you’re processing encoded French text, you’d want to be able to
     write ‘\w+’ to match words, but ‘\w’ only matches the character
     class ‘[A-Za-z]’ in bytes patterns; it won’t match bytes
     corresponding to ‘é’ or ‘ç’.  If your system is configured properly
     and a French locale is selected, certain C functions will tell the
     program that the byte corresponding to ‘é’ should also be
     considered a letter.  Setting the ‘LOCALE’ flag when compiling a
     regular expression will cause the resulting compiled object to use
     these C functions for ‘\w’; this is slower, but also enables ‘\w+’
     to match French words as you’d expect.  The use of this flag is
     discouraged in Python 3 as the locale mechanism is very unreliable,
     it only handles one “culture” at a time, and it only works with
     8-bit locales.  Unicode matching is already enabled by default in
     Python 3 for Unicode (str) patterns, and it is able to handle
     different locales/languages.

 -- Data: M

 -- Data: MULTILINE

     (‘^’ and ‘$’ haven’t been explained yet; they’ll be introduced in
     section *note More Metacharacters: 40ea.)

     Usually ‘^’ matches only at the beginning of the string, and ‘$’
     matches only at the end of the string and immediately before the
     newline (if any) at the end of the string.  When this flag is
     specified, ‘^’ matches at the beginning of the string and at the
     beginning of each line within the string, immediately following
     each newline.  Similarly, the ‘$’ metacharacter matches either at
     the end of the string and at the end of each line (immediately
     preceding each newline).

 -- Data: S

 -- Data: DOTALL

     Makes the ‘'.'’ special character match any character at all,
     including a newline; without this flag, ‘'.'’ will match anything
     `except' a newline.

 -- Data: A

 -- Data: ASCII

     Make ‘\w’, ‘\W’, ‘\b’, ‘\B’, ‘\s’ and ‘\S’ perform ASCII-only
     matching instead of full Unicode matching.  This is only meaningful
     for Unicode patterns, and is ignored for byte patterns.

 -- Data: X

 -- Data: VERBOSE

     This flag allows you to write regular expressions that are more
     readable by granting you more flexibility in how you can format
     them.  When this flag has been specified, whitespace within the RE
     string is ignored, except when the whitespace is in a character
     class or preceded by an unescaped backslash; this lets you organize
     and indent the RE more clearly.  This flag also lets you put
     comments within a RE that will be ignored by the engine; comments
     are marked by a ‘'#'’ that’s neither in a character class or
     preceded by an unescaped backslash.

     For example, here’s a RE that uses *note re.VERBOSE: 1698.; see how
     much easier it is to read?

          charref = re.compile(r"""  &[#]                # Start of a numeric entity reference  (      0[0-7]+         # Octal form    | [0-9]+          # Decimal form    | x[0-9a-fA-F]+   # Hexadecimal form  )  ;                   # Trailing semicolon """, re.VERBOSE)

     Without the verbose setting, the RE would look like this:

          charref = re.compile("&#(0[0-7]+"                      "|[0-9]+"                      "|x[0-9a-fA-F]+);")

     In the above example, Python’s automatic concatenation of string
     literals has been used to break up the RE into smaller pieces, but
     it’s still more difficult to understand than the version using
     *note re.VERBOSE: 1698.


File: python.info,  Node: More Pattern Power,  Next: Modifying Strings,  Prev: Using Regular Expressions,  Up: Regular Expression HOWTO

10.8.4 More Pattern Power
-------------------------

So far we’ve only covered a part of the features of regular expressions.
In this section, we’ll cover some new metacharacters, and how to use
groups to retrieve portions of the text that was matched.

* Menu:

* More Metacharacters::
* Grouping::
* Non-capturing and Named Groups::
* Lookahead Assertions::


File: python.info,  Node: More Metacharacters,  Next: Grouping,  Up: More Pattern Power

10.8.4.1 More Metacharacters
............................

There are some metacharacters that we haven’t covered yet.  Most of them
will be covered in this section.

Some of the remaining metacharacters to be discussed are `zero-width
assertions'.  They don’t cause the engine to advance through the string;
instead, they consume no characters at all, and simply succeed or fail.
For example, ‘\b’ is an assertion that the current position is located
at a word boundary; the position isn’t changed by the ‘\b’ at all.  This
means that zero-width assertions should never be repeated, because if
they match once at a given location, they can obviously be matched an
infinite number of times.

‘|’

     Alternation, or the “or” operator.  If `A' and `B' are regular
     expressions, ‘A|B’ will match any string that matches either `A' or
     `B'. ‘|’ has very low precedence in order to make it work
     reasonably when you’re alternating multi-character strings.
     ‘Crow|Servo’ will match either ‘'Crow'’ or ‘'Servo'’, not ‘'Cro'’,
     a ‘'w'’ or an ‘'S'’, and ‘'ervo'’.

     To match a literal ‘'|'’, use ‘\|’, or enclose it inside a
     character class, as in ‘[|]’.

‘^’

     Matches at the beginning of lines.  Unless the ‘MULTILINE’ flag has
     been set, this will only match at the beginning of the string.  In
     ‘MULTILINE’ mode, this also matches immediately after each newline
     within the string.

     For example, if you wish to match the word ‘From’ only at the
     beginning of a line, the RE to use is ‘^From’.

          >>> print(re.search('^From', 'From Here to Eternity'))   <re.Match object; span=(0, 4), match='From'> >>> print(re.search('^From', 'Reciting From Memory')) None

     To match a literal ‘'^'’, use ‘\^’.

‘$’

     Matches at the end of a line, which is defined as either the end of
     the string, or any location followed by a newline character.

          >>> print(re.search('}$', '{block}'))   <re.Match object; span=(6, 7), match='}'> >>> print(re.search('}$', '{block} ')) None >>> print(re.search('}$', '{block}\n'))   <re.Match object; span=(6, 7), match='}'>

     To match a literal ‘'$'’, use ‘\$’ or enclose it inside a character
     class, as in ‘[$]’.

‘\A’

     Matches only at the start of the string.  When not in ‘MULTILINE’
     mode, ‘\A’ and ‘^’ are effectively the same.  In ‘MULTILINE’ mode,
     they’re different: ‘\A’ still matches only at the beginning of the
     string, but ‘^’ may match at any location inside the string that
     follows a newline character.

‘\Z’

     Matches only at the end of the string.

‘\b’

     Word boundary.  This is a zero-width assertion that matches only at
     the beginning or end of a word.  A word is defined as a sequence of
     alphanumeric characters, so the end of a word is indicated by
     whitespace or a non-alphanumeric character.

     The following example matches ‘class’ only when it’s a complete
     word; it won’t match when it’s contained inside another word.

          >>> p = re.compile(r'\bclass\b') >>> print(p.search('no class at all')) <re.Match object; span=(3, 8), match='class'> >>> print(p.search('the declassified algorithm')) None >>> print(p.search('one subclass is')) None

     There are two subtleties you should remember when using this
     special sequence.  First, this is the worst collision between
     Python’s string literals and regular expression sequences.  In
     Python’s string literals, ‘\b’ is the backspace character, ASCII
     value 8.  If you’re not using raw strings, then Python will convert
     the ‘\b’ to a backspace, and your RE won’t match as you expect it
     to.  The following example looks the same as our previous RE, but
     omits the ‘'r'’ in front of the RE string.

          >>> p = re.compile('\bclass\b') >>> print(p.search('no class at all')) None >>> print(p.search('\b' + 'class' + '\b')) <re.Match object; span=(0, 7), match='\x08class\x08'>

     Second, inside a character class, where there’s no use for this
     assertion, ‘\b’ represents the backspace character, for
     compatibility with Python’s string literals.

‘\B’

     Another zero-width assertion, this is the opposite of ‘\b’, only
     matching when the current position is not at a word boundary.


File: python.info,  Node: Grouping,  Next: Non-capturing and Named Groups,  Prev: More Metacharacters,  Up: More Pattern Power

10.8.4.2 Grouping
.................

Frequently you need to obtain more information than just whether the RE
matched or not.  Regular expressions are often used to dissect strings
by writing a RE divided into several subgroups which match different
components of interest.  For example, an RFC-822 header line is divided
into a header name and a value, separated by a ‘':'’, like this:

     From: author@example.com User-Agent: Thunderbird 1.5.0.9 (X11/20061227) MIME-Version: 1.0 To: editor@example.com

This can be handled by writing a regular expression which matches an
entire header line, and has one group which matches the header name, and
another group which matches the header’s value.

Groups are marked by the ‘'('’, ‘')'’ metacharacters.  ‘'('’ and ‘')'’
have much the same meaning as they do in mathematical expressions; they
group together the expressions contained inside them, and you can repeat
the contents of a group with a repeating qualifier, such as ‘*’, ‘+’,
‘?’, or ‘{m,n}’.  For example, ‘(ab)*’ will match zero or more
repetitions of ‘ab’.

     >>> p = re.compile('(ab)*') >>> print(p.match('ababababab').span()) (0, 10)

Groups indicated with ‘'('’, ‘')'’ also capture the starting and ending
index of the text that they match; this can be retrieved by passing an
argument to *note group(): 16a9, *note start(): 16ad, *note end(): 16ae,
and *note span(): 16af.  Groups are numbered starting with 0.  Group 0
is always present; it’s the whole RE, so *note match object: 891.
methods all have group 0 as their default argument.  Later we’ll see how
to express groups that don’t capture the span of text that they match.

     >>> p = re.compile('(a)b') >>> m = p.match('ab') >>> m.group() 'ab' >>> m.group(0) 'ab'

Subgroups are numbered from left to right, from 1 upward.  Groups can be
nested; to determine the number, just count the opening parenthesis
characters, going from left to right.

     >>> p = re.compile('(a(b)c)d') >>> m = p.match('abcd') >>> m.group(0) 'abcd' >>> m.group(1) 'abc' >>> m.group(2) 'b'

*note group(): 16a9. can be passed multiple group numbers at a time, in
which case it will return a tuple containing the corresponding values
for those groups.

     >>> m.group(2,1,2) ('b', 'abc', 'b')

The *note groups(): 16ab. method returns a tuple containing the strings
for all the subgroups, from 1 up to however many there are.

     >>> m.groups() ('abc', 'b')

Backreferences in a pattern allow you to specify that the contents of an
earlier capturing group must also be found at the current location in
the string.  For example, ‘\1’ will succeed if the exact contents of
group 1 can be found at the current position, and fails otherwise.
Remember that Python’s string literals also use a backslash followed by
numbers to allow including arbitrary characters in a string, so be sure
to use a raw string when incorporating backreferences in a RE.

For example, the following RE detects doubled words in a string.

     >>> p = re.compile(r'\b(\w+)\s+\1\b') >>> p.search('Paris in the the spring').group() 'the the'

Backreferences like this aren’t often useful for just searching through
a string — there are few text formats which repeat data in this way —
but you’ll soon find out that they’re `very' useful when performing
string substitutions.


File: python.info,  Node: Non-capturing and Named Groups,  Next: Lookahead Assertions,  Prev: Grouping,  Up: More Pattern Power

10.8.4.3 Non-capturing and Named Groups
.......................................

Elaborate REs may use many groups, both to capture substrings of
interest, and to group and structure the RE itself.  In complex REs, it
becomes difficult to keep track of the group numbers.  There are two
features which help with this problem.  Both of them use a common syntax
for regular expression extensions, so we’ll look at that first.

Perl 5 is well known for its powerful additions to standard regular
expressions.  For these new features the Perl developers couldn’t choose
new single-keystroke metacharacters or new special sequences beginning
with ‘\’ without making Perl’s regular expressions confusingly different
from standard REs.  If they chose ‘&’ as a new metacharacter, for
example, old expressions would be assuming that ‘&’ was a regular
character and wouldn’t have escaped it by writing ‘\&’ or ‘[&]’.

The solution chosen by the Perl developers was to use ‘(?...)’ as the
extension syntax.  ‘?’ immediately after a parenthesis was a syntax
error because the ‘?’ would have nothing to repeat, so this didn’t
introduce any compatibility problems.  The characters immediately after
the ‘?’ indicate what extension is being used, so ‘(?=foo)’ is one thing
(a positive lookahead assertion) and ‘(?:foo)’ is something else (a
non-capturing group containing the subexpression ‘foo’).

Python supports several of Perl’s extensions and adds an extension
syntax to Perl’s extension syntax.  If the first character after the
question mark is a ‘P’, you know that it’s an extension that’s specific
to Python.

Now that we’ve looked at the general extension syntax, we can return to
the features that simplify working with groups in complex REs.

Sometimes you’ll want to use a group to denote a part of a regular
expression, but aren’t interested in retrieving the group’s contents.
You can make this fact explicit by using a non-capturing group:
‘(?:...)’, where you can replace the ‘...’ with any other regular
expression.

     >>> m = re.match("([abc])+", "abc") >>> m.groups() ('c',) >>> m = re.match("(?:[abc])+", "abc") >>> m.groups() ()

Except for the fact that you can’t retrieve the contents of what the
group matched, a non-capturing group behaves exactly the same as a
capturing group; you can put anything inside it, repeat it with a
repetition metacharacter such as ‘*’, and nest it within other groups
(capturing or non-capturing).  ‘(?:...)’ is particularly useful when
modifying an existing pattern, since you can add new groups without
changing how all the other groups are numbered.  It should be mentioned
that there’s no performance difference in searching between capturing
and non-capturing groups; neither form is any faster than the other.

A more significant feature is named groups: instead of referring to them
by numbers, groups can be referenced by a name.

The syntax for a named group is one of the Python-specific extensions:
‘(?P<name>...)’.  `name' is, obviously, the name of the group.  Named
groups behave exactly like capturing groups, and additionally associate
a name with a group.  The *note match object: 891. methods that deal
with capturing groups all accept either integers that refer to the group
by number or strings that contain the desired group’s name.  Named
groups are still given numbers, so you can retrieve information about a
group in two ways:

     >>> p = re.compile(r'(?P<word>\b\w+\b)') >>> m = p.search( '(((( Lots of punctuation )))' ) >>> m.group('word') 'Lots' >>> m.group(1) 'Lots'

Additionally, you can retrieve named groups as a dictionary with *note
groupdict(): 16ac.:

     >>> m = re.match(r'(?P<first>\w+) (?P<last>\w+)', 'Jane Doe') >>> m.groupdict() {'first': 'Jane', 'last': 'Doe'}

Named groups are handy because they let you use easily-remembered names,
instead of having to remember numbers.  Here’s an example RE from the
*note imaplib: 98. module:

     InternalDate = re.compile(r'INTERNALDATE "'         r'(?P<day>[ 123][0-9])-(?P<mon>[A-Z][a-z][a-z])-'         r'(?P<year>[0-9][0-9][0-9][0-9])'         r' (?P<hour>[0-9][0-9]):(?P<min>[0-9][0-9]):(?P<sec>[0-9][0-9])'         r' (?P<zonen>[-+])(?P<zoneh>[0-9][0-9])(?P<zonem>[0-9][0-9])'         r'"')

It’s obviously much easier to retrieve ‘m.group('zonem')’, instead of
having to remember to retrieve group 9.

The syntax for backreferences in an expression such as ‘(...)\1’ refers
to the number of the group.  There’s naturally a variant that uses the
group name instead of the number.  This is another Python extension:
‘(?P=name)’ indicates that the contents of the group called `name'
should again be matched at the current point.  The regular expression
for finding doubled words, ‘\b(\w+)\s+\1\b’ can also be written as
‘\b(?P<word>\w+)\s+(?P=word)\b’:

     >>> p = re.compile(r'\b(?P<word>\w+)\s+(?P=word)\b') >>> p.search('Paris in the the spring').group() 'the the'


File: python.info,  Node: Lookahead Assertions,  Prev: Non-capturing and Named Groups,  Up: More Pattern Power

10.8.4.4 Lookahead Assertions
.............................

Another zero-width assertion is the lookahead assertion.  Lookahead
assertions are available in both positive and negative form, and look
like this:

‘(?=...)’

     Positive lookahead assertion.  This succeeds if the contained
     regular expression, represented here by ‘...’, successfully matches
     at the current location, and fails otherwise.  But, once the
     contained expression has been tried, the matching engine doesn’t
     advance at all; the rest of the pattern is tried right where the
     assertion started.

‘(?!...)’

     Negative lookahead assertion.  This is the opposite of the positive
     assertion; it succeeds if the contained expression `doesn’t' match
     at the current position in the string.

To make this concrete, let’s look at a case where a lookahead is useful.
Consider a simple pattern to match a filename and split it apart into a
base name and an extension, separated by a ‘.’.  For example, in
‘news.rc’, ‘news’ is the base name, and ‘rc’ is the filename’s
extension.

The pattern to match this is quite simple:

‘.*[.].*$’

Notice that the ‘.’ needs to be treated specially because it’s a
metacharacter, so it’s inside a character class to only match that
specific character.  Also notice the trailing ‘$’; this is added to
ensure that all the rest of the string must be included in the
extension.  This regular expression matches ‘foo.bar’ and ‘autoexec.bat’
and ‘sendmail.cf’ and ‘printers.conf’.

Now, consider complicating the problem a bit; what if you want to match
filenames where the extension is not ‘bat’?  Some incorrect attempts:

‘.*[.][^b].*$’ The first attempt above tries to exclude ‘bat’ by
requiring that the first character of the extension is not a ‘b’.  This
is wrong, because the pattern also doesn’t match ‘foo.bar’.

‘.*[.]([^b]..|.[^a].|..[^t])$’

The expression gets messier when you try to patch up the first solution
by requiring one of the following cases to match: the first character of
the extension isn’t ‘b’; the second character isn’t ‘a’; or the third
character isn’t ‘t’.  This accepts ‘foo.bar’ and rejects ‘autoexec.bat’,
but it requires a three-letter extension and won’t accept a filename
with a two-letter extension such as ‘sendmail.cf’.  We’ll complicate the
pattern again in an effort to fix it.

‘.*[.]([^b].?.?|.[^a]?.?|..?[^t]?)$’

In the third attempt, the second and third letters are all made optional
in order to allow matching extensions shorter than three characters,
such as ‘sendmail.cf’.

The pattern’s getting really complicated now, which makes it hard to
read and understand.  Worse, if the problem changes and you want to
exclude both ‘bat’ and ‘exe’ as extensions, the pattern would get even
more complicated and confusing.

A negative lookahead cuts through all this confusion:

‘.*[.](?!bat$)[^.]*$’ The negative lookahead means: if the expression
‘bat’ doesn’t match at this point, try the rest of the pattern; if
‘bat$’ does match, the whole pattern will fail.  The trailing ‘$’ is
required to ensure that something like ‘sample.batch’, where the
extension only starts with ‘bat’, will be allowed.  The ‘[^.]*’ makes
sure that the pattern works when there are multiple dots in the
filename.

Excluding another filename extension is now easy; simply add it as an
alternative inside the assertion.  The following pattern excludes
filenames that end in either ‘bat’ or ‘exe’:

‘.*[.](?!bat$|exe$)[^.]*$’


File: python.info,  Node: Modifying Strings,  Next: Common Problems,  Prev: More Pattern Power,  Up: Regular Expression HOWTO

10.8.5 Modifying Strings
------------------------

Up to this point, we’ve simply performed searches against a static
string.  Regular expressions are also commonly used to modify strings in
various ways, using the following pattern methods:

Method/Attribute       Purpose
                       
---------------------------------------------------------------------------
                       
‘split()’              Split the string into a list, splitting it
                       wherever the RE matches
                       
                       
‘sub()’                Find all substrings where the RE matches, and
                       replace them with a different string
                       
                       
‘subn()’               Does the same thing as ‘sub()’, but returns the
                       new string and the number of replacements
                       

* Menu:

* Splitting Strings::
* Search and Replace::


File: python.info,  Node: Splitting Strings,  Next: Search and Replace,  Up: Modifying Strings

10.8.5.1 Splitting Strings
..........................

The *note split(): 169e. method of a pattern splits a string apart
wherever the RE matches, returning a list of the pieces.  It’s similar
to the *note split(): 795. method of strings but provides much more
generality in the delimiters that you can split by; string ‘split()’
only supports splitting by whitespace or by a fixed string.  As you’d
expect, there’s a module-level *note re.split(): 3bf. function, too.

 -- Method: .split (string[, maxsplit=0])

     Split `string' by the matches of the regular expression.  If
     capturing parentheses are used in the RE, then their contents will
     also be returned as part of the resulting list.  If `maxsplit' is
     nonzero, at most `maxsplit' splits are performed.

You can limit the number of splits made, by passing a value for
`maxsplit'.  When `maxsplit' is nonzero, at most `maxsplit' splits will
be made, and the remainder of the string is returned as the final
element of the list.  In the following example, the delimiter is any
sequence of non-alphanumeric characters.

     >>> p = re.compile(r'\W+') >>> p.split('This is a test, short and sweet, of split().') ['This', 'is', 'a', 'test', 'short', 'and', 'sweet', 'of', 'split', ''] >>> p.split('This is a test, short and sweet, of split().', 3) ['This', 'is', 'a', 'test, short and sweet, of split().']

Sometimes you’re not only interested in what the text between delimiters
is, but also need to know what the delimiter was.  If capturing
parentheses are used in the RE, then their values are also returned as
part of the list.  Compare the following calls:

     >>> p = re.compile(r'\W+') >>> p2 = re.compile(r'(\W+)') >>> p.split('This... is a test.') ['This', 'is', 'a', 'test', ''] >>> p2.split('This... is a test.') ['This', '... ', 'is', ' ', 'a', ' ', 'test', '.', '']

The module-level function *note re.split(): 3bf. adds the RE to be used
as the first argument, but is otherwise the same.

     >>> re.split(r'[\W]+', 'Words, words, words.') ['Words', 'words', 'words', ''] >>> re.split(r'([\W]+)', 'Words, words, words.') ['Words', ', ', 'words', ', ', 'words', '.', ''] >>> re.split(r'[\W]+', 'Words, words, words.', 1) ['Words', 'words, words.']


File: python.info,  Node: Search and Replace,  Prev: Splitting Strings,  Up: Modifying Strings

10.8.5.2 Search and Replace
...........................

Another common task is to find all the matches for a pattern, and
replace them with a different string.  The *note sub(): 16a1. method
takes a replacement value, which can be either a string or a function,
and the string to be processed.

 -- Method: .sub (replacement, string[, count=0])

     Returns the string obtained by replacing the leftmost
     non-overlapping occurrences of the RE in `string' by the
     replacement `replacement'.  If the pattern isn’t found, `string' is
     returned unchanged.

     The optional argument `count' is the maximum number of pattern
     occurrences to be replaced; `count' must be a non-negative integer.
     The default value of 0 means to replace all occurrences.

Here’s a simple example of using the *note sub(): 16a1. method.  It
replaces colour names with the word ‘colour’:

     >>> p = re.compile('(blue|white|red)') >>> p.sub('colour', 'blue socks and red shoes') 'colour socks and colour shoes' >>> p.sub('colour', 'blue socks and red shoes', count=1) 'colour socks and red shoes'

The *note subn(): 16a2. method does the same work, but returns a 2-tuple
containing the new string value and the number of replacements that were
performed:

     >>> p = re.compile('(blue|white|red)') >>> p.subn('colour', 'blue socks and red shoes') ('colour socks and colour shoes', 2) >>> p.subn('colour', 'no colours at all') ('no colours at all', 0)

Empty matches are replaced only when they’re not adjacent to a previous
empty match.

     >>> p = re.compile('x*') >>> p.sub('-', 'abxd') '-a-b--d-'

If `replacement' is a string, any backslash escapes in it are processed.
That is, ‘\n’ is converted to a single newline character, ‘\r’ is
converted to a carriage return, and so forth.  Unknown escapes such as
‘\&’ are left alone.  Backreferences, such as ‘\6’, are replaced with
the substring matched by the corresponding group in the RE. This lets
you incorporate portions of the original text in the resulting
replacement string.

This example matches the word ‘section’ followed by a string enclosed in
‘{’, ‘}’, and changes ‘section’ to ‘subsection’:

     >>> p = re.compile('section{ ( [^}]* ) }', re.VERBOSE) >>> p.sub(r'subsection{\1}','section{First} section{second}') 'subsection{First} subsection{second}'

There’s also a syntax for referring to named groups as defined by the
‘(?P<name>...)’ syntax.  ‘\g<name>’ will use the substring matched by
the group named ‘name’, and ‘\g<number>’ uses the corresponding group
number.  ‘\g<2>’ is therefore equivalent to ‘\2’, but isn’t ambiguous in
a replacement string such as ‘\g<2>0’.  (‘\20’ would be interpreted as a
reference to group 20, not a reference to group 2 followed by the
literal character ‘'0'’.)  The following substitutions are all
equivalent, but use all three variations of the replacement string.

     >>> p = re.compile('section{ (?P<name> [^}]* ) }', re.VERBOSE) >>> p.sub(r'subsection{\1}','section{First}') 'subsection{First}' >>> p.sub(r'subsection{\g<1>}','section{First}') 'subsection{First}' >>> p.sub(r'subsection{\g<name>}','section{First}') 'subsection{First}'

`replacement' can also be a function, which gives you even more control.
If `replacement' is a function, the function is called for every
non-overlapping occurrence of `pattern'.  On each call, the function is
passed a *note match object: 891. argument for the match and can use
this information to compute the desired replacement string and return
it.

In the following example, the replacement function translates decimals
into hexadecimal:

     >>> def hexrepl(match): ...     "Return the hex string for a decimal number" ...     value = int(match.group()) ...     return hex(value) ... >>> p = re.compile(r'\d+') >>> p.sub(hexrepl, 'Call 65490 for printing, 49152 for user code.') 'Call 0xffd2 for printing, 0xc000 for user code.'

When using the module-level *note re.sub(): 470. function, the pattern
is passed as the first argument.  The pattern may be provided as an
object or as a string; if you need to specify regular expression flags,
you must either use a pattern object as the first parameter, or use
embedded modifiers in the pattern string, e.g.  ‘sub("(?i)b+", "x",
"bbbb BBBB")’ returns ‘'x x'’.


File: python.info,  Node: Common Problems,  Next: Feedback,  Prev: Modifying Strings,  Up: Regular Expression HOWTO

10.8.6 Common Problems
----------------------

Regular expressions are a powerful tool for some applications, but in
some ways their behaviour isn’t intuitive and at times they don’t behave
the way you may expect them to.  This section will point out some of the
most common pitfalls.

* Menu:

* Use String Methods::
* match() versus search(): match versus search.
* Greedy versus Non-Greedy::
* Using re.VERBOSE: Using re VERBOSE.


File: python.info,  Node: Use String Methods,  Next: match versus search,  Up: Common Problems

10.8.6.1 Use String Methods
...........................

Sometimes using the *note re: dd. module is a mistake.  If you’re
matching a fixed string, or a single character class, and you’re not
using any *note re: dd. features such as the *note IGNORECASE: 1697.
flag, then the full power of regular expressions may not be required.
Strings have several methods for performing operations with fixed
strings and they’re usually much faster, because the implementation is a
single small C loop that’s been optimized for the purpose, instead of
the large, more generalized regular expression engine.

One example might be replacing a single fixed string with another one;
for example, you might replace ‘word’ with ‘deed’.  *note re.sub(): 470.
seems like the function to use for this, but consider the *note
replace(): 1590. method.  Note that ‘replace()’ will also replace ‘word’
inside words, turning ‘swordfish’ into ‘sdeedfish’, but the naive RE
‘word’ would have done that, too.  (To avoid performing the substitution
on parts of words, the pattern would have to be ‘\bword\b’, in order to
require that ‘word’ have a word boundary on either side.  This takes the
job beyond ‘replace()’’s abilities.)

Another common task is deleting every occurrence of a single character
from a string or replacing it with another single character.  You might
do this with something like ‘re.sub('\n', ' ', S)’, but *note
translate(): 158f. is capable of doing both tasks and will be faster
than any regular expression operation can be.

In short, before turning to the *note re: dd. module, consider whether
your problem can be solved with a faster and simpler string method.


File: python.info,  Node: match versus search,  Next: Greedy versus Non-Greedy,  Prev: Use String Methods,  Up: Common Problems

10.8.6.2 match() versus search()
................................

The *note match(): ba6. function only checks if the RE matches at the
beginning of the string while *note search(): ba5. will scan forward
through the string for a match.  It’s important to keep this distinction
in mind.  Remember, ‘match()’ will only report a successful match which
will start at 0; if the match wouldn’t start at zero, ‘match()’ will
`not' report it.

     >>> print(re.match('super', 'superstition').span()) (0, 5) >>> print(re.match('super', 'insuperable')) None

On the other hand, *note search(): ba5. will scan forward through the
string, reporting the first match it finds.

     >>> print(re.search('super', 'superstition').span()) (0, 5) >>> print(re.search('super', 'insuperable').span()) (2, 7)

Sometimes you’ll be tempted to keep using *note re.match(): ba6, and
just add ‘.*’ to the front of your RE. Resist this temptation and use
*note re.search(): ba5. instead.  The regular expression compiler does
some analysis of REs in order to speed up the process of looking for a
match.  One such analysis figures out what the first character of a
match must be; for example, a pattern starting with ‘Crow’ must match
starting with a ‘'C'’.  The analysis lets the engine quickly scan
through the string looking for the starting character, only trying the
full match if a ‘'C'’ is found.

Adding ‘.*’ defeats this optimization, requiring scanning to the end of
the string and then backtracking to find a match for the rest of the RE.
Use *note re.search(): ba5. instead.


File: python.info,  Node: Greedy versus Non-Greedy,  Next: Using re VERBOSE,  Prev: match versus search,  Up: Common Problems

10.8.6.3 Greedy versus Non-Greedy
.................................

When repeating a regular expression, as in ‘a*’, the resulting action is
to consume as much of the pattern as possible.  This fact often bites
you when you’re trying to match a pair of balanced delimiters, such as
the angle brackets surrounding an HTML tag.  The naive pattern for
matching a single HTML tag doesn’t work because of the greedy nature of
‘.*’.

     >>> s = '<html><head><title>Title</title>' >>> len(s) 32 >>> print(re.match('<.*>', s).span()) (0, 32) >>> print(re.match('<.*>', s).group()) <html><head><title>Title</title>

The RE matches the ‘'<'’ in ‘'<html>'’, and the ‘.*’ consumes the rest
of the string.  There’s still more left in the RE, though, and the ‘>’
can’t match at the end of the string, so the regular expression engine
has to backtrack character by character until it finds a match for the
‘>’.  The final match extends from the ‘'<'’ in ‘'<html>'’ to the ‘'>'’
in ‘'</title>'’, which isn’t what you want.

In this case, the solution is to use the non-greedy qualifiers ‘*?’,
‘+?’, ‘??’, or ‘{m,n}?’, which match as `little' text as possible.  In
the above example, the ‘'>'’ is tried immediately after the first ‘'<'’
matches, and when it fails, the engine advances a character at a time,
retrying the ‘'>'’ at every step.  This produces just the right result:

     >>> print(re.match('<.*?>', s).group()) <html>

(Note that parsing HTML or XML with regular expressions is painful.
Quick-and-dirty patterns will handle common cases, but HTML and XML have
special cases that will break the obvious regular expression; by the
time you’ve written a regular expression that handles all of the
possible cases, the patterns will be `very' complicated.  Use an HTML or
XML parser module for such tasks.)


File: python.info,  Node: Using re VERBOSE,  Prev: Greedy versus Non-Greedy,  Up: Common Problems

10.8.6.4 Using re.VERBOSE
.........................

By now you’ve probably noticed that regular expressions are a very
compact notation, but they’re not terribly readable.  REs of moderate
complexity can become lengthy collections of backslashes, parentheses,
and metacharacters, making them difficult to read and understand.

For such REs, specifying the *note re.VERBOSE: 1698. flag when compiling
the regular expression can be helpful, because it allows you to format
the regular expression more clearly.

The ‘re.VERBOSE’ flag has several effects.  Whitespace in the regular
expression that `isn’t' inside a character class is ignored.  This means
that an expression such as ‘dog | cat’ is equivalent to the less
readable ‘dog|cat’, but ‘[a b]’ will still match the characters ‘'a'’,
‘'b'’, or a space.  In addition, you can also put comments inside a RE;
comments extend from a ‘#’ character to the next newline.  When used
with triple-quoted strings, this enables REs to be formatted more
neatly:

     pat = re.compile(r"""  \s*                 # Skip leading whitespace  (?P<header>[^:]+)   # Header name  \s* :               # Whitespace, and a colon  (?P<value>.*?)      # The header's value -- *? used to                      # lose the following trailing whitespace  \s*$                # Trailing whitespace to end-of-line """, re.VERBOSE)

This is far more readable than:

     pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")


File: python.info,  Node: Feedback,  Prev: Common Problems,  Up: Regular Expression HOWTO

10.8.7 Feedback
---------------

Regular expressions are a complicated topic.  Did this document help you
understand them?  Were there parts that were unclear, or Problems you
encountered that weren’t covered here?  If so, please send suggestions
for improvements to the author.

The most complete book on regular expressions is almost certainly
Jeffrey Friedl’s Mastering Regular Expressions, published by O’Reilly.
Unfortunately, it exclusively concentrates on Perl and Java’s flavours
of regular expressions, and doesn’t contain any Python material at all,
so it won’t be useful as a reference for programming in Python.  (The
first edition covered Python’s now-removed ‘regex’ module, which won’t
help you much.)  Consider checking it out from your library.


File: python.info,  Node: Socket Programming HOWTO,  Next: Sorting HOW TO,  Prev: Regular Expression HOWTO,  Up: Python HOWTOs

10.9 Socket Programming HOWTO
=============================


Author: Gordon McMillan

Abstract
........

Sockets are used nearly everywhere, but are one of the most severely
misunderstood technologies around.  This is a 10,000 foot overview of
sockets.  It’s not really a tutorial - you’ll still have work to do in
getting things operational.  It doesn’t cover the fine points (and there
are a lot of them), but I hope it will give you enough background to
begin using them decently.

* Menu:

* Sockets::
* Creating a Socket::
* Using a Socket::
* Disconnecting::
* Non-blocking Sockets::


File: python.info,  Node: Sockets,  Next: Creating a Socket,  Up: Socket Programming HOWTO

10.9.1 Sockets
--------------

I’m only going to talk about INET (i.e.  IPv4) sockets, but they account
for at least 99% of the sockets in use.  And I’ll only talk about STREAM
(i.e.  TCP) sockets - unless you really know what you’re doing (in which
case this HOWTO isn’t for you!), you’ll get better behavior and
performance from a STREAM socket than anything else.  I will try to
clear up the mystery of what a socket is, as well as some hints on how
to work with blocking and non-blocking sockets.  But I’ll start by
talking about blocking sockets.  You’ll need to know how they work
before dealing with non-blocking sockets.

Part of the trouble with understanding these things is that “socket” can
mean a number of subtly different things, depending on context.  So
first, let’s make a distinction between a “client” socket - an endpoint
of a conversation, and a “server” socket, which is more like a
switchboard operator.  The client application (your browser, for
example) uses “client” sockets exclusively; the web server it’s talking
to uses both “server” sockets and “client” sockets.

* Menu:

* History::


File: python.info,  Node: History,  Up: Sockets

10.9.1.1 History
................

Of the various forms of IPC (Inter Process Communication), sockets are
by far the most popular.  On any given platform, there are likely to be
other forms of IPC that are faster, but for cross-platform
communication, sockets are about the only game in town.

They were invented in Berkeley as part of the BSD flavor of Unix.  They
spread like wildfire with the Internet.  With good reason — the
combination of sockets with INET makes talking to arbitrary machines
around the world unbelievably easy (at least compared to other schemes).


File: python.info,  Node: Creating a Socket,  Next: Using a Socket,  Prev: Sockets,  Up: Socket Programming HOWTO

10.9.2 Creating a Socket
------------------------

Roughly speaking, when you clicked on the link that brought you to this
page, your browser did something like the following:

     # create an INET, STREAMing socket s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) # now connect to the web server on port 80 - the normal http port s.connect(("www.python.org", 80))

When the ‘connect’ completes, the socket ‘s’ can be used to send in a
request for the text of the page.  The same socket will read the reply,
and then be destroyed.  That’s right, destroyed.  Client sockets are
normally only used for one exchange (or a small set of sequential
exchanges).

What happens in the web server is a bit more complex.  First, the web
server creates a “server socket”:

     # create an INET, STREAMing socket serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) # bind the socket to a public host, and a well-known port serversocket.bind((socket.gethostname(), 80)) # become a server socket serversocket.listen(5)

A couple things to notice: we used ‘socket.gethostname()’ so that the
socket would be visible to the outside world.  If we had used
‘s.bind(('localhost', 80))’ or ‘s.bind(('127.0.0.1', 80))’ we would
still have a “server” socket, but one that was only visible within the
same machine.  ‘s.bind(('', 80))’ specifies that the socket is reachable
by any address the machine happens to have.

A second thing to note: low number ports are usually reserved for “well
known” services (HTTP, SNMP etc).  If you’re playing around, use a nice
high number (4 digits).

Finally, the argument to ‘listen’ tells the socket library that we want
it to queue up as many as 5 connect requests (the normal max) before
refusing outside connections.  If the rest of the code is written
properly, that should be plenty.

Now that we have a “server” socket, listening on port 80, we can enter
the mainloop of the web server:

     while True:     # accept connections from outside     (clientsocket, address) = serversocket.accept()     # now do something with the clientsocket     # in this case, we'll pretend this is a threaded server     ct = client_thread(clientsocket)     ct.run()

There’s actually 3 general ways in which this loop could work -
dispatching a thread to handle ‘clientsocket’, create a new process to
handle ‘clientsocket’, or restructure this app to use non-blocking
sockets, and multiplex between our “server” socket and any active
‘clientsocket’s using ‘select’.  More about that later.  The important
thing to understand now is this: this is `all' a “server” socket does.
It doesn’t send any data.  It doesn’t receive any data.  It just
produces “client” sockets.  Each ‘clientsocket’ is created in response
to some `other' “client” socket doing a ‘connect()’ to the host and port
we’re bound to.  As soon as we’ve created that ‘clientsocket’, we go
back to listening for more connections.  The two “clients” are free to
chat it up - they are using some dynamically allocated port which will
be recycled when the conversation ends.

* Menu:

* IPC::


File: python.info,  Node: IPC,  Up: Creating a Socket

10.9.2.1 IPC
............

If you need fast IPC between two processes on one machine, you should
look into pipes or shared memory.  If you do decide to use AF_INET
sockets, bind the “server” socket to ‘'localhost'’.  On most platforms,
this will take a shortcut around a couple of layers of network code and
be quite a bit faster.

See also
........

The *note multiprocessing: b7. integrates cross-platform IPC into a
higher-level API.


File: python.info,  Node: Using a Socket,  Next: Disconnecting,  Prev: Creating a Socket,  Up: Socket Programming HOWTO

10.9.3 Using a Socket
---------------------

The first thing to note, is that the web browser’s “client” socket and
the web server’s “client” socket are identical beasts.  That is, this is
a “peer to peer” conversation.  Or to put it another way, `as the
designer, you will have to decide what the rules of etiquette are for a
conversation'.  Normally, the ‘connect’ing socket starts the
conversation, by sending in a request, or perhaps a signon.  But that’s
a design decision - it’s not a rule of sockets.

Now there are two sets of verbs to use for communication.  You can use
‘send’ and ‘recv’, or you can transform your client socket into a
file-like beast and use ‘read’ and ‘write’.  The latter is the way Java
presents its sockets.  I’m not going to talk about it here, except to
warn you that you need to use ‘flush’ on sockets.  These are buffered
“files”, and a common mistake is to ‘write’ something, and then ‘read’
for a reply.  Without a ‘flush’ in there, you may wait forever for the
reply, because the request may still be in your output buffer.

Now we come to the major stumbling block of sockets - ‘send’ and ‘recv’
operate on the network buffers.  They do not necessarily handle all the
bytes you hand them (or expect from them), because their major focus is
handling the network buffers.  In general, they return when the
associated network buffers have been filled (‘send’) or emptied
(‘recv’).  They then tell you how many bytes they handled.  It is `your'
responsibility to call them again until your message has been completely
dealt with.

When a ‘recv’ returns 0 bytes, it means the other side has closed (or is
in the process of closing) the connection.  You will not receive any
more data on this connection.  Ever.  You may be able to send data
successfully; I’ll talk more about this later.

A protocol like HTTP uses a socket for only one transfer.  The client
sends a request, then reads a reply.  That’s it.  The socket is
discarded.  This means that a client can detect the end of the reply by
receiving 0 bytes.

But if you plan to reuse your socket for further transfers, you need to
realize that `there is no' EOT (End of Transfer) `on a socket.'  I
repeat: if a socket ‘send’ or ‘recv’ returns after handling 0 bytes, the
connection has been broken.  If the connection has `not' been broken,
you may wait on a ‘recv’ forever, because the socket will `not' tell you
that there’s nothing more to read (for now).  Now if you think about
that a bit, you’ll come to realize a fundamental truth of sockets:
`messages must either be fixed length' (yuck), `or be delimited'
(shrug), `or indicate how long they are' (much better), `or end by
shutting down the connection'.  The choice is entirely yours, (but some
ways are righter than others).

Assuming you don’t want to end the connection, the simplest solution is
a fixed length message:

     class MySocket:     """demonstration class only       - coded for clarity, not efficiency     """      def __init__(self, sock=None):         if sock is None:             self.sock = socket.socket(                             socket.AF_INET, socket.SOCK_STREAM)         else:             self.sock = sock      def connect(self, host, port):         self.sock.connect((host, port))      def mysend(self, msg):         totalsent = 0         while totalsent < MSGLEN:             sent = self.sock.send(msg[totalsent:])             if sent == 0:                 raise RuntimeError("socket connection broken")             totalsent = totalsent + sent      def myreceive(self):         chunks = []         bytes_recd = 0         while bytes_recd < MSGLEN:             chunk = self.sock.recv(min(MSGLEN - bytes_recd, 2048))             if chunk == b'':                 raise RuntimeError("socket connection broken")             chunks.append(chunk)             bytes_recd = bytes_recd + len(chunk)         return b''.join(chunks)

The sending code here is usable for almost any messaging scheme - in
Python you send strings, and you can use ‘len()’ to determine its length
(even if it has embedded ‘\0’ characters).  It’s mostly the receiving
code that gets more complex.  (And in C, it’s not much worse, except you
can’t use ‘strlen’ if the message has embedded ‘\0’s.)

The easiest enhancement is to make the first character of the message an
indicator of message type, and have the type determine the length.  Now
you have two ‘recv’s - the first to get (at least) that first character
so you can look up the length, and the second in a loop to get the rest.
If you decide to go the delimited route, you’ll be receiving in some
arbitrary chunk size, (4096 or 8192 is frequently a good match for
network buffer sizes), and scanning what you’ve received for a
delimiter.

One complication to be aware of: if your conversational protocol allows
multiple messages to be sent back to back (without some kind of reply),
and you pass ‘recv’ an arbitrary chunk size, you may end up reading the
start of a following message.  You’ll need to put that aside and hold
onto it, until it’s needed.

Prefixing the message with its length (say, as 5 numeric characters)
gets more complex, because (believe it or not), you may not get all 5
characters in one ‘recv’.  In playing around, you’ll get away with it;
but in high network loads, your code will very quickly break unless you
use two ‘recv’ loops - the first to determine the length, the second to
get the data part of the message.  Nasty.  This is also when you’ll
discover that ‘send’ does not always manage to get rid of everything in
one pass.  And despite having read this, you will eventually get bit by
it!

In the interests of space, building your character, (and preserving my
competitive position), these enhancements are left as an exercise for
the reader.  Lets move on to cleaning up.

* Menu:

* Binary Data::


File: python.info,  Node: Binary Data,  Up: Using a Socket

10.9.3.1 Binary Data
....................

It is perfectly possible to send binary data over a socket.  The major
problem is that not all machines use the same formats for binary data.
For example, a Motorola chip will represent a 16 bit integer with the
value 1 as the two hex bytes 00 01.  Intel and DEC, however, are
byte-reversed - that same 1 is 01 00.  Socket libraries have calls for
converting 16 and 32 bit integers - ‘ntohl, htonl, ntohs, htons’ where
“n” means `network' and “h” means `host', “s” means `short' and “l”
means `long'.  Where network order is host order, these do nothing, but
where the machine is byte-reversed, these swap the bytes around
appropriately.

In these days of 32 bit machines, the ascii representation of binary
data is frequently smaller than the binary representation.  That’s
because a surprising amount of the time, all those longs have the value
0, or maybe 1.  The string “0” would be two bytes, while binary is four.
Of course, this doesn’t fit well with fixed-length messages.  Decisions,
decisions.


File: python.info,  Node: Disconnecting,  Next: Non-blocking Sockets,  Prev: Using a Socket,  Up: Socket Programming HOWTO

10.9.4 Disconnecting
--------------------

Strictly speaking, you’re supposed to use ‘shutdown’ on a socket before
you ‘close’ it.  The ‘shutdown’ is an advisory to the socket at the
other end.  Depending on the argument you pass it, it can mean “I’m not
going to send anymore, but I’ll still listen”, or “I’m not listening,
good riddance!”.  Most socket libraries, however, are so used to
programmers neglecting to use this piece of etiquette that normally a
‘close’ is the same as ‘shutdown(); close()’.  So in most situations, an
explicit ‘shutdown’ is not needed.

One way to use ‘shutdown’ effectively is in an HTTP-like exchange.  The
client sends a request and then does a ‘shutdown(1)’.  This tells the
server “This client is done sending, but can still receive.” The server
can detect “EOF” by a receive of 0 bytes.  It can assume it has the
complete request.  The server sends a reply.  If the ‘send’ completes
successfully then, indeed, the client was still receiving.

Python takes the automatic shutdown a step further, and says that when a
socket is garbage collected, it will automatically do a ‘close’ if it’s
needed.  But relying on this is a very bad habit.  If your socket just
disappears without doing a ‘close’, the socket at the other end may hang
indefinitely, thinking you’re just being slow.  `Please' ‘close’ your
sockets when you’re done.

* Menu:

* When Sockets Die::


File: python.info,  Node: When Sockets Die,  Up: Disconnecting

10.9.4.1 When Sockets Die
.........................

Probably the worst thing about using blocking sockets is what happens
when the other side comes down hard (without doing a ‘close’).  Your
socket is likely to hang.  TCP is a reliable protocol, and it will wait
a long, long time before giving up on a connection.  If you’re using
threads, the entire thread is essentially dead.  There’s not much you
can do about it.  As long as you aren’t doing something dumb, like
holding a lock while doing a blocking read, the thread isn’t really
consuming much in the way of resources.  Do `not' try to kill the thread
- part of the reason that threads are more efficient than processes is
that they avoid the overhead associated with the automatic recycling of
resources.  In other words, if you do manage to kill the thread, your
whole process is likely to be screwed up.


File: python.info,  Node: Non-blocking Sockets,  Prev: Disconnecting,  Up: Socket Programming HOWTO

10.9.5 Non-blocking Sockets
---------------------------

If you’ve understood the preceding, you already know most of what you
need to know about the mechanics of using sockets.  You’ll still use the
same calls, in much the same ways.  It’s just that, if you do it right,
your app will be almost inside-out.

In Python, you use ‘socket.setblocking(0)’ to make it non-blocking.  In
C, it’s more complex, (for one thing, you’ll need to choose between the
BSD flavor ‘O_NONBLOCK’ and the almost indistinguishable Posix flavor
‘O_NDELAY’, which is completely different from ‘TCP_NODELAY’), but it’s
the exact same idea.  You do this after creating the socket, but before
using it.  (Actually, if you’re nuts, you can switch back and forth.)

The major mechanical difference is that ‘send’, ‘recv’, ‘connect’ and
‘accept’ can return without having done anything.  You have (of course)
a number of choices.  You can check return code and error codes and
generally drive yourself crazy.  If you don’t believe me, try it
sometime.  Your app will grow large, buggy and suck CPU. So let’s skip
the brain-dead solutions and do it right.

Use ‘select’.

In C, coding ‘select’ is fairly complex.  In Python, it’s a piece of
cake, but it’s close enough to the C version that if you understand
‘select’ in Python, you’ll have little trouble with it in C:

     ready_to_read, ready_to_write, in_error = \                select.select(                   potential_readers,                   potential_writers,                   potential_errs,                   timeout)

You pass ‘select’ three lists: the first contains all sockets that you
might want to try reading; the second all the sockets you might want to
try writing to, and the last (normally left empty) those that you want
to check for errors.  You should note that a socket can go into more
than one list.  The ‘select’ call is blocking, but you can give it a
timeout.  This is generally a sensible thing to do - give it a nice long
timeout (say a minute) unless you have good reason to do otherwise.

In return, you will get three lists.  They contain the sockets that are
actually readable, writable and in error.  Each of these lists is a
subset (possibly empty) of the corresponding list you passed in.

If a socket is in the output readable list, you can be
as-close-to-certain-as-we-ever-get-in-this-business that a ‘recv’ on
that socket will return `something'.  Same idea for the writable list.
You’ll be able to send `something'.  Maybe not all you want to, but
`something' is better than nothing.  (Actually, any reasonably healthy
socket will return as writable - it just means outbound network buffer
space is available.)

If you have a “server” socket, put it in the potential_readers list.  If
it comes out in the readable list, your ‘accept’ will (almost certainly)
work.  If you have created a new socket to ‘connect’ to someone else,
put it in the potential_writers list.  If it shows up in the writable
list, you have a decent chance that it has connected.

Actually, ‘select’ can be handy even with blocking sockets.  It’s one
way of determining whether you will block - the socket returns as
readable when there’s something in the buffers.  However, this still
doesn’t help with the problem of determining whether the other end is
done, or just busy with something else.

`Portability alert': On Unix, ‘select’ works both with the sockets and
files.  Don’t try this on Windows.  On Windows, ‘select’ works with
sockets only.  Also note that in C, many of the more advanced socket
options are done differently on Windows.  In fact, on Windows I usually
use threads (which work very, very well) with my sockets.


File: python.info,  Node: Sorting HOW TO,  Next: Unicode HOWTO,  Prev: Socket Programming HOWTO,  Up: Python HOWTOs

10.10 Sorting HOW TO
====================


Author: Andrew Dalke and Raymond Hettinger


Release: 0.1

Python lists have a built-in *note list.sort(): 43a. method that
modifies the list in-place.  There is also a *note sorted(): 439.
built-in function that builds a new sorted list from an iterable.

In this document, we explore the various techniques for sorting data
using Python.

* Menu:

* Sorting Basics::
* Key Functions::
* Operator Module Functions::
* Ascending and Descending::
* Sort Stability and Complex Sorts::
* The Old Way Using Decorate-Sort-Undecorate::
* The Old Way Using the cmp Parameter::
* Odd and Ends::


File: python.info,  Node: Sorting Basics,  Next: Key Functions,  Up: Sorting HOW TO

10.10.1 Sorting Basics
----------------------

A simple ascending sort is very easy: just call the *note sorted(): 439.
function.  It returns a new sorted list:

     >>> sorted([5, 2, 3, 1, 4]) [1, 2, 3, 4, 5]

You can also use the *note list.sort(): 43a. method.  It modifies the
list in-place (and returns ‘None’ to avoid confusion).  Usually it’s
less convenient than *note sorted(): 439. - but if you don’t need the
original list, it’s slightly more efficient.

     >>> a = [5, 2, 3, 1, 4] >>> a.sort() >>> a [1, 2, 3, 4, 5]

Another difference is that the *note list.sort(): 43a. method is only
defined for lists.  In contrast, the *note sorted(): 439. function
accepts any iterable.

     >>> sorted({1: 'D', 2: 'B', 3: 'B', 4: 'E', 5: 'A'}) [1, 2, 3, 4, 5]


File: python.info,  Node: Key Functions,  Next: Operator Module Functions,  Prev: Sorting Basics,  Up: Sorting HOW TO

10.10.2 Key Functions
---------------------

Both *note list.sort(): 43a. and *note sorted(): 439. have a `key'
parameter to specify a function to be called on each list element prior
to making comparisons.

For example, here’s a case-insensitive string comparison:

     >>> sorted("This is a test string from Andrew".split(), key=str.lower) ['a', 'Andrew', 'from', 'is', 'string', 'test', 'This']

The value of the `key' parameter should be a function that takes a
single argument and returns a key to use for sorting purposes.  This
technique is fast because the key function is called exactly once for
each input record.

A common pattern is to sort complex objects using some of the object’s
indices as keys.  For example:

     >>> student_tuples = [ ...     ('john', 'A', 15), ...     ('jane', 'B', 12), ...     ('dave', 'B', 10), ... ] >>> sorted(student_tuples, key=lambda student: student[2])   # sort by age [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

The same technique works for objects with named attributes.  For
example:

     >>> class Student: ...     def __init__(self, name, grade, age): ...         self.name = name ...         self.grade = grade ...         self.age = age ...     def __repr__(self): ...         return repr((self.name, self.grade, self.age))

     >>> student_objects = [ ...     Student('john', 'A', 15), ...     Student('jane', 'B', 12), ...     Student('dave', 'B', 10), ... ] >>> sorted(student_objects, key=lambda student: student.age)   # sort by age [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]


File: python.info,  Node: Operator Module Functions,  Next: Ascending and Descending,  Prev: Key Functions,  Up: Sorting HOW TO

10.10.3 Operator Module Functions
---------------------------------

The key-function patterns shown above are very common, so Python
provides convenience functions to make accessor functions easier and
faster.  The *note operator: c2. module has *note itemgetter(): 25f,
*note attrgetter(): 70f, and a *note methodcaller(): 710. function.

Using those functions, the above examples become simpler and faster:

     >>> from operator import itemgetter, attrgetter

     >>> sorted(student_tuples, key=itemgetter(2)) [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

     >>> sorted(student_objects, key=attrgetter('age')) [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

The operator module functions allow multiple levels of sorting.  For
example, to sort by `grade' then by `age':

     >>> sorted(student_tuples, key=itemgetter(1,2)) [('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]

     >>> sorted(student_objects, key=attrgetter('grade', 'age')) [('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]


File: python.info,  Node: Ascending and Descending,  Next: Sort Stability and Complex Sorts,  Prev: Operator Module Functions,  Up: Sorting HOW TO

10.10.4 Ascending and Descending
--------------------------------

Both *note list.sort(): 43a. and *note sorted(): 439. accept a `reverse'
parameter with a boolean value.  This is used to flag descending sorts.
For example, to get the student data in reverse `age' order:

     >>> sorted(student_tuples, key=itemgetter(2), reverse=True) [('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]

     >>> sorted(student_objects, key=attrgetter('age'), reverse=True) [('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]


File: python.info,  Node: Sort Stability and Complex Sorts,  Next: The Old Way Using Decorate-Sort-Undecorate,  Prev: Ascending and Descending,  Up: Sorting HOW TO

10.10.5 Sort Stability and Complex Sorts
----------------------------------------

Sorts are guaranteed to be stable(1).  That means that when multiple
records have the same key, their original order is preserved.

     >>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)] >>> sorted(data, key=itemgetter(0)) [('blue', 1), ('blue', 2), ('red', 1), ('red', 2)]

Notice how the two records for `blue' retain their original order so
that ‘('blue', 1)’ is guaranteed to precede ‘('blue', 2)’.

This wonderful property lets you build complex sorts in a series of
sorting steps.  For example, to sort the student data by descending
`grade' and then ascending `age', do the `age' sort first and then sort
again using `grade':

     >>> s = sorted(student_objects, key=attrgetter('age'))     # sort on secondary key >>> sorted(s, key=attrgetter('grade'), reverse=True)       # now sort on primary key, descending [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

This can be abstracted out into a wrapper function that can take a list
and tuples of field and order to sort them on multiple passes.

     >>> def multisort(xs, specs): ...     for key, reverse in reversed(specs): ...         xs.sort(key=attrgetter(key), reverse=reverse) ...     return xs

     >>> multisort(list(student_objects), (('grade', True), ('age', False))) [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

The Timsort(2) algorithm used in Python does multiple sorts efficiently
because it can take advantage of any ordering already present in a
dataset.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Sorting_algorithm#Stability

   (2) https://en.wikipedia.org/wiki/Timsort


File: python.info,  Node: The Old Way Using Decorate-Sort-Undecorate,  Next: The Old Way Using the cmp Parameter,  Prev: Sort Stability and Complex Sorts,  Up: Sorting HOW TO

10.10.6 The Old Way Using Decorate-Sort-Undecorate
--------------------------------------------------

This idiom is called Decorate-Sort-Undecorate after its three steps:

   * First, the initial list is decorated with new values that control
     the sort order.

   * Second, the decorated list is sorted.

   * Finally, the decorations are removed, creating a list that contains
     only the initial values in the new order.

For example, to sort the student data by `grade' using the DSU approach:

     >>> decorated = [(student.grade, i, student) for i, student in enumerate(student_objects)] >>> decorated.sort() >>> [student for grade, i, student in decorated]               # undecorate [('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]

This idiom works because tuples are compared lexicographically; the
first items are compared; if they are the same then the second items are
compared, and so on.

It is not strictly necessary in all cases to include the index `i' in
the decorated list, but including it gives two benefits:

   * The sort is stable – if two items have the same key, their order
     will be preserved in the sorted list.

   * The original items do not have to be comparable because the
     ordering of the decorated tuples will be determined by at most the
     first two items.  So for example the original list could contain
     complex numbers which cannot be sorted directly.

Another name for this idiom is Schwartzian transform(1), after Randal L.
Schwartz, who popularized it among Perl programmers.

Now that Python sorting provides key-functions, this technique is not
often needed.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Schwartzian_transform


File: python.info,  Node: The Old Way Using the cmp Parameter,  Next: Odd and Ends,  Prev: The Old Way Using Decorate-Sort-Undecorate,  Up: Sorting HOW TO

10.10.7 The Old Way Using the `cmp' Parameter
---------------------------------------------

Many constructs given in this HOWTO assume Python 2.4 or later.  Before
that, there was no *note sorted(): 439. builtin and *note list.sort():
43a. took no keyword arguments.  Instead, all of the Py2.x versions
supported a `cmp' parameter to handle user specified comparison
functions.

In Py3.0, the `cmp' parameter was removed entirely (as part of a larger
effort to simplify and unify the language, eliminating the conflict
between rich comparisons and the ‘__cmp__()’ magic method).

In Py2.x, sort allowed an optional function which can be called for
doing the comparisons.  That function should take two arguments to be
compared and then return a negative value for less-than, return zero if
they are equal, or return a positive value for greater-than.  For
example, we can do:

     >>> def numeric_compare(x, y): ...     return x - y >>> sorted([5, 2, 4, 1, 3], cmp=numeric_compare) # doctest: +SKIP [1, 2, 3, 4, 5]

Or you can reverse the order of comparison with:

     >>> def reverse_numeric(x, y): ...     return y - x >>> sorted([5, 2, 4, 1, 3], cmp=reverse_numeric) # doctest: +SKIP [5, 4, 3, 2, 1]

When porting code from Python 2.x to 3.x, the situation can arise when
you have the user supplying a comparison function and you need to
convert that to a key function.  The following wrapper makes that easy
to do:

     def cmp_to_key(mycmp):     'Convert a cmp= function into a key= function'     class K:         def __init__(self, obj, *args):             self.obj = obj         def __lt__(self, other):             return mycmp(self.obj, other.obj) < 0         def __gt__(self, other):             return mycmp(self.obj, other.obj) > 0         def __eq__(self, other):             return mycmp(self.obj, other.obj) == 0         def __le__(self, other):             return mycmp(self.obj, other.obj) <= 0         def __ge__(self, other):             return mycmp(self.obj, other.obj) >= 0         def __ne__(self, other):             return mycmp(self.obj, other.obj) != 0     return K

To convert to a key function, just wrap the old comparison function:

     >>> sorted([5, 2, 4, 1, 3], key=cmp_to_key(reverse_numeric)) [5, 4, 3, 2, 1]

In Python 3.2, the *note functools.cmp_to_key(): b49. function was added
to the *note functools: 85. module in the standard library.


File: python.info,  Node: Odd and Ends,  Prev: The Old Way Using the cmp Parameter,  Up: Sorting HOW TO

10.10.8 Odd and Ends
--------------------

   * For locale aware sorting, use *note locale.strxfrm(): 2fbe. for a
     key function or *note locale.strcoll(): 2fbc. for a comparison
     function.

   * The `reverse' parameter still maintains sort stability (so that
     records with equal keys retain the original order).  Interestingly,
     that effect can be simulated without the parameter by using the
     builtin *note reversed(): 18e. function twice:

          >>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)] >>> standard_way = sorted(data, key=itemgetter(0), reverse=True) >>> double_reversed = list(reversed(sorted(reversed(data), key=itemgetter(0)))) >>> assert standard_way == double_reversed >>> standard_way [('red', 1), ('red', 2), ('blue', 1), ('blue', 2)]

   * The sort routines are guaranteed to use *note __lt__(): c27. when
     making comparisons between two objects.  So, it is easy to add a
     standard sort order to a class by defining an *note __lt__(): c27.
     method:

          >>> Student.__lt__ = lambda self, other: self.age < other.age >>> sorted(student_objects) [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

   * Key functions need not depend directly on the objects being sorted.
     A key function can also access external resources.  For instance,
     if the student grades are stored in a dictionary, they can be used
     to sort a separate list of student names:

          >>> students = ['dave', 'john', 'jane'] >>> newgrades = {'john': 'F', 'jane':'A', 'dave': 'C'} >>> sorted(students, key=newgrades.__getitem__) ['jane', 'dave', 'john']


File: python.info,  Node: Unicode HOWTO,  Next: HOWTO Fetch Internet Resources Using The urllib Package,  Prev: Sorting HOW TO,  Up: Python HOWTOs

10.11 Unicode HOWTO
===================


Release: 1.12

This HOWTO discusses Python’s support for the Unicode specification for
representing textual data, and explains various problems that people
commonly encounter when trying to work with Unicode.

* Menu:

* Introduction to Unicode::
* Python’s Unicode Support::
* Reading and Writing Unicode Data::
* Acknowledgements: Acknowledgements<10>.


File: python.info,  Node: Introduction to Unicode,  Next: Python’s Unicode Support,  Up: Unicode HOWTO

10.11.1 Introduction to Unicode
-------------------------------

* Menu:

* Definitions::
* Encodings::
* References: References<3>.


File: python.info,  Node: Definitions,  Next: Encodings,  Up: Introduction to Unicode

10.11.1.1 Definitions
.....................

Today’s programs need to be able to handle a wide variety of characters.
Applications are often internationalized to display messages and output
in a variety of user-selectable languages; the same program might need
to output an error message in English, French, Japanese, Hebrew, or
Russian.  Web content can be written in any of these languages and can
also include a variety of emoji symbols.  Python’s string type uses the
Unicode Standard for representing characters, which lets Python programs
work with all these different possible characters.

Unicode (‘https://www.unicode.org/’) is a specification that aims to
list every character used by human languages and give each character its
own unique code.  The Unicode specifications are continually revised and
updated to add new languages and symbols.

A `character' is the smallest possible component of a text.  ‘A’, ‘B’,
‘C’, etc., are all different characters.  So are ‘È’ and ‘Í’.
Characters vary depending on the language or context you’re talking
about.  For example, there’s a character for “Roman Numeral One”, ‘Ⅰ’,
that’s separate from the uppercase letter ‘I’.  They’ll usually look the
same, but these are two different characters that have different
meanings.

The Unicode standard describes how characters are represented by `code
points'.  A code point value is an integer in the range 0 to 0x10FFFF
(about 1.1 million values, with some 110 thousand assigned so far).  In
the standard and in this document, a code point is written using the
notation ‘U+265E’ to mean the character with value ‘0x265e’ (9,822 in
decimal).

The Unicode standard contains a lot of tables listing characters and
their corresponding code points:

     0061    'a'; LATIN SMALL LETTER A 0062    'b'; LATIN SMALL LETTER B 0063    'c'; LATIN SMALL LETTER C ... 007B    '{'; LEFT CURLY BRACKET ... 2167    'Ⅷ'; ROMAN NUMERAL EIGHT 2168    'Ⅸ'; ROMAN NUMERAL NINE ... 265E    '♞'; BLACK CHESS KNIGHT 265F    '♟'; BLACK CHESS PAWN ... 1F600   '😀'; GRINNING FACE 1F609   '😉'; WINKING FACE ...

Strictly, these definitions imply that it’s meaningless to say ‘this is
character ‘U+265E’’.  ‘U+265E’ is a code point, which represents some
particular character; in this case, it represents the character ‘BLACK
CHESS KNIGHT’, ‘♞’.  In informal contexts, this distinction between code
points and characters will sometimes be forgotten.

A character is represented on a screen or on paper by a set of graphical
elements that’s called a `glyph'.  The glyph for an uppercase A, for
example, is two diagonal strokes and a horizontal stroke, though the
exact details will depend on the font being used.  Most Python code
doesn’t need to worry about glyphs; figuring out the correct glyph to
display is generally the job of a GUI toolkit or a terminal’s font
renderer.


File: python.info,  Node: Encodings,  Next: References<3>,  Prev: Definitions,  Up: Introduction to Unicode

10.11.1.2 Encodings
...................

To summarize the previous section: a Unicode string is a sequence of
code points, which are numbers from 0 through ‘0x10FFFF’ (1,114,111
decimal).  This sequence of code points needs to be represented in
memory as a set of `code units', and `code units' are then mapped to
8-bit bytes.  The rules for translating a Unicode string into a sequence
of bytes are called a `character encoding', or just an `encoding'.

The first encoding you might think of is using 32-bit integers as the
code unit, and then using the CPU’s representation of 32-bit integers.
In this representation, the string “Python” might look like this:

        P           y           t           h           o           n 0x50 00 00 00 79 00 00 00 74 00 00 00 68 00 00 00 6f 00 00 00 6e 00 00 00    0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

This representation is straightforward but using it presents a number of
problems.

  1. It’s not portable; different processors order the bytes
     differently.

  2. It’s very wasteful of space.  In most texts, the majority of the
     code points are less than 127, or less than 255, so a lot of space
     is occupied by ‘0x00’ bytes.  The above string takes 24 bytes
     compared to the 6 bytes needed for an ASCII representation.
     Increased RAM usage doesn’t matter too much (desktop computers have
     gigabytes of RAM, and strings aren’t usually that large), but
     expanding our usage of disk and network bandwidth by a factor of 4
     is intolerable.

  3. It’s not compatible with existing C functions such as ‘strlen()’,
     so a new family of wide string functions would need to be used.

Therefore this encoding isn’t used very much, and people instead choose
other encodings that are more efficient and convenient, such as UTF-8.

UTF-8 is one of the most commonly used encodings, and Python often
defaults to using it.  UTF stands for “Unicode Transformation Format”,
and the ‘8’ means that 8-bit values are used in the encoding.  (There
are also UTF-16 and UTF-32 encodings, but they are less frequently used
than UTF-8.)  UTF-8 uses the following rules:

  1. If the code point is < 128, it’s represented by the corresponding
     byte value.

  2. If the code point is >= 128, it’s turned into a sequence of two,
     three, or four bytes, where each byte of the sequence is between
     128 and 255.

UTF-8 has several convenient properties:

  1. It can handle any Unicode code point.

  2. A Unicode string is turned into a sequence of bytes that contains
     embedded zero bytes only where they represent the null character
     (U+0000).  This means that UTF-8 strings can be processed by C
     functions such as ‘strcpy()’ and sent through protocols that can’t
     handle zero bytes for anything other than end-of-string markers.

  3. A string of ASCII text is also valid UTF-8 text.

  4. UTF-8 is fairly compact; the majority of commonly used characters
     can be represented with one or two bytes.

  5. If bytes are corrupted or lost, it’s possible to determine the
     start of the next UTF-8-encoded code point and resynchronize.  It’s
     also unlikely that random 8-bit data will look like valid UTF-8.

  6. UTF-8 is a byte oriented encoding.  The encoding specifies that
     each character is represented by a specific sequence of one or more
     bytes.  This avoids the byte-ordering issues that can occur with
     integer and word oriented encodings, like UTF-16 and UTF-32, where
     the sequence of bytes varies depending on the hardware on which the
     string was encoded.


File: python.info,  Node: References<3>,  Prev: Encodings,  Up: Introduction to Unicode

10.11.1.3 References
....................

The Unicode Consortium site(1) has character charts, a glossary, and PDF
versions of the Unicode specification.  Be prepared for some difficult
reading.  A chronology(2) of the origin and development of Unicode is
also available on the site.

On the Computerphile Youtube channel, Tom Scott briefly discusses the
history of Unicode and UTF-8(3) (9 minutes 36 seconds).

To help understand the standard, Jukka Korpela has written an
introductory guide(4) to reading the Unicode character tables.

Another good introductory article(5) was written by Joel Spolsky.  If
this introduction didn’t make things clear to you, you should try
reading this alternate article before continuing.

Wikipedia entries are often helpful; see the entries for “character
encoding(6)” and UTF-8(7), for example.

   ---------- Footnotes ----------

   (1) http://www.unicode.org

   (2) http://www.unicode.org/history/

   (3) https://www.youtube.com/watch?v=MijmeoH9LT4

   (4) http://jkorpela.fi/unicode/guide.html

   (5) 
https://www.joelonsoftware.com/2003/10/08/the-absolute-minimum-every-software-developer-absolutely-positively-must-know-about-unicode-and-character-sets-no-excuses/

   (6) https://en.wikipedia.org/wiki/Character_encoding

   (7) https://en.wikipedia.org/wiki/UTF-8


File: python.info,  Node: Python’s Unicode Support,  Next: Reading and Writing Unicode Data,  Prev: Introduction to Unicode,  Up: Unicode HOWTO

10.11.2 Python’s Unicode Support
--------------------------------

Now that you’ve learned the rudiments of Unicode, we can look at
Python’s Unicode features.

* Menu:

* The String Type::
* Converting to Bytes::
* Unicode Literals in Python Source Code::
* Unicode Properties::
* Comparing Strings::
* Unicode Regular Expressions::
* References: References<4>.


File: python.info,  Node: The String Type,  Next: Converting to Bytes,  Up: Python’s Unicode Support

10.11.2.1 The String Type
.........................

Since Python 3.0, the language’s *note str: 325. type contains Unicode
characters, meaning any string created using ‘"unicode rocks!"’,
‘'unicode rocks!'’, or the triple-quoted string syntax is stored as
Unicode.

The default encoding for Python source code is UTF-8, so you can simply
include a Unicode character in a string literal:

     try:     with open('/tmp/input.txt', 'r') as f:         ... except OSError:     # 'File not found' error message.     print("Fichier non trouvé")

Side note: Python 3 also supports using Unicode characters in
identifiers:

     répertoire = "/tmp/records.log" with open(répertoire, "w") as f:     f.write("test\n")

If you can’t enter a particular character in your editor or want to keep
the source code ASCII-only for some reason, you can also use escape
sequences in string literals.  (Depending on your system, you may see
the actual capital-delta glyph instead of a u escape.)

     >>> "\N{GREEK CAPITAL LETTER DELTA}"  # Using the character name '\u0394' >>> "\u0394"                          # Using a 16-bit hex value '\u0394' >>> "\U00000394"                      # Using a 32-bit hex value '\u0394'

In addition, one can create a string using the *note decode(): c2b.
method of *note bytes: 326.  This method takes an `encoding' argument,
such as ‘UTF-8’, and optionally an `errors' argument.

The `errors' argument specifies the response when the input string can’t
be converted according to the encoding’s rules.  Legal values for this
argument are ‘'strict'’ (raise a *note UnicodeDecodeError: 1fb.
exception), ‘'replace'’ (use ‘U+FFFD’, ‘REPLACEMENT CHARACTER’),
‘'ignore'’ (just leave the character out of the Unicode result), or
‘'backslashreplace'’ (inserts a ‘\xNN’ escape sequence).  The following
examples show the differences:

     >>> b'\x80abc'.decode("utf-8", "strict")   Traceback (most recent call last):     ... UnicodeDecodeError: 'utf-8' codec can't decode byte 0x80 in position 0:   invalid start byte >>> b'\x80abc'.decode("utf-8", "replace") '\ufffdabc' >>> b'\x80abc'.decode("utf-8", "backslashreplace") '\\x80abc' >>> b'\x80abc'.decode("utf-8", "ignore") 'abc'

Encodings are specified as strings containing the encoding’s name.
Python comes with roughly 100 different encodings; see the Python
Library Reference at *note Standard Encodings: 683. for a list.  Some
encodings have multiple names; for example, ‘'latin-1'’, ‘'iso_8859_1'’
and ‘'8859’’ are all synonyms for the same encoding.

One-character Unicode strings can also be created with the *note chr():
1363. built-in function, which takes integers and returns a Unicode
string of length 1 that contains the corresponding code point.  The
reverse operation is the built-in *note ord(): 1362. function that takes
a one-character Unicode string and returns the code point value:

     >>> chr(57344) '\ue000' >>> ord('\ue000') 57344


File: python.info,  Node: Converting to Bytes,  Next: Unicode Literals in Python Source Code,  Prev: The String Type,  Up: Python’s Unicode Support

10.11.2.2 Converting to Bytes
.............................

The opposite method of *note bytes.decode(): c2b. is *note str.encode():
c2a, which returns a *note bytes: 326. representation of the Unicode
string, encoded in the requested `encoding'.

The `errors' parameter is the same as the parameter of the *note
decode(): c2b. method but supports a few more possible handlers.  As
well as ‘'strict'’, ‘'ignore'’, and ‘'replace'’ (which in this case
inserts a question mark instead of the unencodable character), there is
also ‘'xmlcharrefreplace'’ (inserts an XML character reference),
‘backslashreplace’ (inserts a ‘\uNNNN’ escape sequence) and
‘namereplace’ (inserts a ‘\N{...}’ escape sequence).

The following example shows the different results:

     >>> u = chr(40960) + 'abcd' + chr(1972) >>> u.encode('utf-8') b'\xea\x80\x80abcd\xde\xb4' >>> u.encode('ascii')   Traceback (most recent call last):     ... UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in   position 0: ordinal not in range(128) >>> u.encode('ascii', 'ignore') b'abcd' >>> u.encode('ascii', 'replace') b'?abcd?' >>> u.encode('ascii', 'xmlcharrefreplace') b'&#40960;abcd&#1972;' >>> u.encode('ascii', 'backslashreplace') b'\\ua000abcd\\u07b4' >>> u.encode('ascii', 'namereplace') b'\\N{YI SYLLABLE IT}abcd\\u07b4'

The low-level routines for registering and accessing the available
encodings are found in the *note codecs: 1c. module.  Implementing new
encodings also requires understanding the *note codecs: 1c. module.
However, the encoding and decoding functions returned by this module are
usually more low-level than is comfortable, and writing new encodings is
a specialized task, so the module won’t be covered in this HOWTO.


File: python.info,  Node: Unicode Literals in Python Source Code,  Next: Unicode Properties,  Prev: Converting to Bytes,  Up: Python’s Unicode Support

10.11.2.3 Unicode Literals in Python Source Code
................................................

In Python source code, specific Unicode code points can be written using
the ‘\u’ escape sequence, which is followed by four hex digits giving
the code point.  The ‘\U’ escape sequence is similar, but expects eight
hex digits, not four:

     >>> s = "a\xac\u1234\u20ac\U00008000" ... #     ^^^^ two-digit hex escape ... #         ^^^^^^ four-digit Unicode escape ... #                     ^^^^^^^^^^ eight-digit Unicode escape >>> [ord(c) for c in s] [97, 172, 4660, 8364, 32768]

Using escape sequences for code points greater than 127 is fine in small
doses, but becomes an annoyance if you’re using many accented
characters, as you would in a program with messages in French or some
other accent-using language.  You can also assemble strings using the
*note chr(): 1363. built-in function, but this is even more tedious.

Ideally, you’d want to be able to write literals in your language’s
natural encoding.  You could then edit Python source code with your
favorite editor which would display the accented characters naturally,
and have the right characters used at runtime.

Python supports writing source code in UTF-8 by default, but you can use
almost any encoding if you declare the encoding being used.  This is
done by including a special comment as either the first or second line
of the source file:

     #!/usr/bin/env python # -*- coding: latin-1 -*-  u = 'abcdé' print(ord(u[-1]))

The syntax is inspired by Emacs’s notation for specifying variables
local to a file.  Emacs supports many different variables, but Python
only supports ‘coding’.  The ‘-*-’ symbols indicate to Emacs that the
comment is special; they have no significance to Python but are a
convention.  Python looks for ‘coding: name’ or ‘coding=name’ in the
comment.

If you don’t include such a comment, the default encoding used will be
UTF-8 as already mentioned.  See also PEP 263(1) for more information.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0263


File: python.info,  Node: Unicode Properties,  Next: Comparing Strings,  Prev: Unicode Literals in Python Source Code,  Up: Python’s Unicode Support

10.11.2.4 Unicode Properties
............................

The Unicode specification includes a database of information about code
points.  For each defined code point, the information includes the
character’s name, its category, the numeric value if applicable (for
characters representing numeric concepts such as the Roman numerals,
fractions such as one-third and four-fifths, etc.).  There are also
display-related properties, such as how to use the code point in
bidirectional text.

The following program displays some information about several
characters, and prints the numeric value of one particular character:

     import unicodedata  u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231)  for i, c in enumerate(u):     print(i, '%04x' % ord(c), unicodedata.category(c), end=" ")     print(unicodedata.name(c))  # Get numeric value of second character print(unicodedata.numeric(u[1]))

When run, this prints:

     0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE 1 0bf2 No TAMIL NUMBER ONE THOUSAND 2 0f84 Mn TIBETAN MARK HALANTA 3 1770 Lo TAGBANWA LETTER SA 4 33af So SQUARE RAD OVER S SQUARED 1000.0

The category codes are abbreviations describing the nature of the
character.  These are grouped into categories such as “Letter”,
“Number”, “Punctuation”, or “Symbol”, which in turn are broken up into
subcategories.  To take the codes from the above output, ‘'Ll'’ means
‘Letter, lowercase’, ‘'No'’ means “Number, other”, ‘'Mn'’ is “Mark,
nonspacing”, and ‘'So'’ is “Symbol, other”.  See the General Category
Values section of the Unicode Character Database documentation(1) for a
list of category codes.

   ---------- Footnotes ----------

   (1) http://www.unicode.org/reports/tr44/#General_Category_Values


File: python.info,  Node: Comparing Strings,  Next: Unicode Regular Expressions,  Prev: Unicode Properties,  Up: Python’s Unicode Support

10.11.2.5 Comparing Strings
...........................

Unicode adds some complication to comparing strings, because the same
set of characters can be represented by different sequences of code
points.  For example, a letter like ‘ê’ can be represented as a single
code point U+00EA, or as U+0065 U+0302, which is the code point for ‘e’
followed by a code point for ‘COMBINING CIRCUMFLEX ACCENT’.  These will
produce the same output when printed, but one is a string of length 1
and the other is of length 2.

One tool for a case-insensitive comparison is the *note casefold(): 6a4.
string method that converts a string to a case-insensitive form
following an algorithm described by the Unicode Standard.  This
algorithm has special handling for characters such as the German letter
‘ß’ (code point U+00DF), which becomes the pair of lowercase letters
‘ss’.

     >>> street = 'Gürzenichstraße' >>> street.casefold() 'gürzenichstrasse'

A second tool is the *note unicodedata: 11a. module’s *note normalize():
fe8. function that converts strings to one of several normal forms,
where letters followed by a combining character are replaced with single
characters.  ‘normalize()’ can be used to perform string comparisons
that won’t falsely report inequality if two strings use combining
characters differently:

     import unicodedata  def compare_strs(s1, s2):     def NFD(s):         return unicodedata.normalize('NFD', s)      return NFD(s1) == NFD(s2)  single_char = 'ê' multiple_chars = '\N{LATIN SMALL LETTER E}\N{COMBINING CIRCUMFLEX ACCENT}' print('length of first string=', len(single_char)) print('length of second string=', len(multiple_chars)) print(compare_strs(single_char, multiple_chars))

When run, this outputs:

     $ python3 compare-strs.py length of first string= 1 length of second string= 2 True

The first argument to the *note normalize(): fe8. function is a string
giving the desired normalization form, which can be one of ‘NFC’,
‘NFKC’, ‘NFD’, and ‘NFKD’.

The Unicode Standard also specifies how to do caseless comparisons:

     import unicodedata  def compare_caseless(s1, s2):     def NFD(s):         return unicodedata.normalize('NFD', s)      return NFD(NFD(s1).casefold()) == NFD(NFD(s2).casefold())  # Example usage single_char = 'ê' multiple_chars = '\N{LATIN CAPITAL LETTER E}\N{COMBINING CIRCUMFLEX ACCENT}'  print(compare_caseless(single_char, multiple_chars))

This will print ‘True’.  (Why is ‘NFD()’ invoked twice?  Because there
are a few characters that make ‘casefold()’ return a non-normalized
string, so the result needs to be normalized again.  See section 3.13 of
the Unicode Standard for a discussion and an example.)


File: python.info,  Node: Unicode Regular Expressions,  Next: References<4>,  Prev: Comparing Strings,  Up: Python’s Unicode Support

10.11.2.6 Unicode Regular Expressions
.....................................

The regular expressions supported by the *note re: dd. module can be
provided either as bytes or strings.  Some of the special character
sequences such as ‘\d’ and ‘\w’ have different meanings depending on
whether the pattern is supplied as bytes or a string.  For example, ‘\d’
will match the characters ‘[0-9]’ in bytes but in strings will match any
character that’s in the ‘'Nd'’ category.

The string in this example has the number 57 written in both Thai and
Arabic numerals:

     import re p = re.compile(r'\d+')  s = "Over \u0e55\u0e57 57 flavours" m = p.search(s) print(repr(m.group()))

When executed, ‘\d+’ will match the Thai numerals and print them out.
If you supply the *note re.ASCII: 3bd. flag to *note compile(): 43f,
‘\d+’ will match the substring “57” instead.

Similarly, ‘\w’ matches a wide variety of Unicode characters but only
‘[a-zA-Z0-9_]’ in bytes or if *note re.ASCII: 3bd. is supplied, and ‘\s’
will match either Unicode whitespace characters or ‘[ \t\n\r\f\v]’.


File: python.info,  Node: References<4>,  Prev: Unicode Regular Expressions,  Up: Python’s Unicode Support

10.11.2.7 References
....................

Some good alternative discussions of Python’s Unicode support are:

   * Processing Text Files in Python 3(1), by Nick Coghlan.

   * Pragmatic Unicode(2), a PyCon 2012 presentation by Ned Batchelder.

The *note str: 325. type is described in the Python library reference at
*note Text Sequence Type — str: 115d.

The documentation for the *note unicodedata: 11a. module.

The documentation for the *note codecs: 1c. module.

Marc-André Lemburg gave a presentation titled "Python and Unicode" (PDF
slides)(3) at EuroPython 2002.  The slides are an excellent overview of
the design of Python 2’s Unicode features (where the Unicode string type
is called ‘unicode’ and literals start with ‘u’).

   ---------- Footnotes ----------

   (1) 
http://python-notes.curiousefficiency.org/en/latest/python3/text_file_processing.html

   (2) https://nedbatchelder.com/text/unipain.html

   (3) https://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf


File: python.info,  Node: Reading and Writing Unicode Data,  Next: Acknowledgements<10>,  Prev: Python’s Unicode Support,  Up: Unicode HOWTO

10.11.3 Reading and Writing Unicode Data
----------------------------------------

Once you’ve written some code that works with Unicode data, the next
problem is input/output.  How do you get Unicode strings into your
program, and how do you convert Unicode into a form suitable for storage
or transmission?

It’s possible that you may not need to do anything depending on your
input sources and output destinations; you should check whether the
libraries used in your application support Unicode natively.  XML
parsers often return Unicode data, for example.  Many relational
databases also support Unicode-valued columns and can return Unicode
values from an SQL query.

Unicode data is usually converted to a particular encoding before it
gets written to disk or sent over a socket.  It’s possible to do all the
work yourself: open a file, read an 8-bit bytes object from it, and
convert the bytes with ‘bytes.decode(encoding)’.  However, the manual
approach is not recommended.

One problem is the multi-byte nature of encodings; one Unicode character
can be represented by several bytes.  If you want to read the file in
arbitrary-sized chunks (say, 1024 or 4096 bytes), you need to write
error-handling code to catch the case where only part of the bytes
encoding a single Unicode character are read at the end of a chunk.  One
solution would be to read the entire file into memory and then perform
the decoding, but that prevents you from working with files that are
extremely large; if you need to read a 2 GiB file, you need 2 GiB of
RAM. (More, really, since for at least a moment you’d need to have both
the encoded string and its Unicode version in memory.)

The solution would be to use the low-level decoding interface to catch
the case of partial coding sequences.  The work of implementing this has
already been done for you: the built-in *note open(): 4e5. function can
return a file-like object that assumes the file’s contents are in a
specified encoding and accepts Unicode parameters for methods such as
*note read(): 1f44. and *note write(): 1f47.  This works through *note
open(): 4e5.’s `encoding' and `errors' parameters which are interpreted
just like those in *note str.encode(): c2a. and *note bytes.decode():
c2b.

Reading Unicode from a file is therefore simple:

     with open('unicode.txt', encoding='utf-8') as f:     for line in f:         print(repr(line))

It’s also possible to open files in update mode, allowing both reading
and writing:

     with open('test', encoding='utf-8', mode='w+') as f:     f.write('\u4500 blah blah blah\n')     f.seek(0)     print(repr(f.readline()[:1]))

The Unicode character ‘U+FEFF’ is used as a byte-order mark (BOM), and
is often written as the first character of a file in order to assist
with autodetection of the file’s byte ordering.  Some encodings, such as
UTF-16, expect a BOM to be present at the start of a file; when such an
encoding is used, the BOM will be automatically written as the first
character and will be silently dropped when the file is read.  There are
variants of these encodings, such as ‘utf-16-le’ and ‘utf-16-be’ for
little-endian and big-endian encodings, that specify one particular byte
ordering and don’t skip the BOM.

In some areas, it is also convention to use a “BOM” at the start of
UTF-8 encoded files; the name is misleading since UTF-8 is not
byte-order dependent.  The mark simply announces that the file is
encoded in UTF-8.  For reading such files, use the ‘utf-8-sig’ codec to
automatically skip the mark if present.

* Menu:

* Unicode filenames::
* Tips for Writing Unicode-aware Programs::
* References: References<5>.


File: python.info,  Node: Unicode filenames,  Next: Tips for Writing Unicode-aware Programs,  Up: Reading and Writing Unicode Data

10.11.3.1 Unicode filenames
...........................

Most of the operating systems in common use today support filenames that
contain arbitrary Unicode characters.  Usually this is implemented by
converting the Unicode string into some encoding that varies depending
on the system.  Today Python is converging on using UTF-8: Python on
MacOS has used UTF-8 for several versions, and Python 3.6 switched to
using UTF-8 on Windows as well.  On Unix systems, there will only be a
filesystem encoding if you’ve set the ‘LANG’ or ‘LC_CTYPE’ environment
variables; if you haven’t, the default encoding is again UTF-8.

The *note sys.getfilesystemencoding(): 4eb. function returns the
encoding to use on your current system, in case you want to do the
encoding manually, but there’s not much reason to bother.  When opening
a file for reading or writing, you can usually just provide the Unicode
string as the filename, and it will be automatically converted to the
right encoding for you:

     filename = 'filename\u4500abc' with open(filename, 'w') as f:     f.write('blah\n')

Functions in the *note os: c4. module such as *note os.stat(): 1ef. will
also accept Unicode filenames.

The *note os.listdir(): a36. function returns filenames, which raises an
issue: should it return the Unicode version of filenames, or should it
return bytes containing the encoded versions?  *note os.listdir(): a36.
can do both, depending on whether you provided the directory path as
bytes or a Unicode string.  If you pass a Unicode string as the path,
filenames will be decoded using the filesystem’s encoding and a list of
Unicode strings will be returned, while passing a byte path will return
the filenames as bytes.  For example, assuming the default filesystem
encoding is UTF-8, running the following program:

     fn = 'filename\u4500abc' f = open(fn, 'w') f.close()  import os print(os.listdir(b'.')) print(os.listdir('.'))

will produce the following output:

     $ python listdir-test.py [b'filename\xe4\x94\x80abc', ...] ['filename\u4500abc', ...]

The first list contains UTF-8-encoded filenames, and the second list
contains the Unicode versions.

Note that on most occasions, you should can just stick with using
Unicode with these APIs.  The bytes APIs should only be used on systems
where undecodable file names can be present; that’s pretty much only
Unix systems now.


File: python.info,  Node: Tips for Writing Unicode-aware Programs,  Next: References<5>,  Prev: Unicode filenames,  Up: Reading and Writing Unicode Data

10.11.3.2 Tips for Writing Unicode-aware Programs
.................................................

This section provides some suggestions on writing software that deals
with Unicode.

The most important tip is:

     Software should only work with Unicode strings internally, decoding
     the input data as soon as possible and encoding the output only at
     the end.

If you attempt to write processing functions that accept both Unicode
and byte strings, you will find your program vulnerable to bugs wherever
you combine the two different kinds of strings.  There is no automatic
encoding or decoding: if you do e.g.  ‘str + bytes’, a *note TypeError:
192. will be raised.

When using data coming from a web browser or some other untrusted
source, a common technique is to check for illegal characters in a
string before using the string in a generated command line or storing it
in a database.  If you’re doing this, be careful to check the decoded
string, not the encoded bytes data; some encodings may have interesting
properties, such as not being bijective or not being fully
ASCII-compatible.  This is especially true if the input data also
specifies the encoding, since the attacker can then choose a clever way
to hide malicious text in the encoded bytestream.

* Menu:

* Converting Between File Encodings::
* Files in an Unknown Encoding::


File: python.info,  Node: Converting Between File Encodings,  Next: Files in an Unknown Encoding,  Up: Tips for Writing Unicode-aware Programs

10.11.3.3 Converting Between File Encodings
...........................................

The *note StreamRecoder: eff. class can transparently convert between
encodings, taking a stream that returns data in encoding #1 and behaving
like a stream returning data in encoding #2.

For example, if you have an input file `f' that’s in Latin-1, you can
wrap it with a *note StreamRecoder: eff. to return bytes encoded in
UTF-8:

     new_f = codecs.StreamRecoder(f,     # en/decoder: used by read() to encode its results and     # by write() to decode its input.     codecs.getencoder('utf-8'), codecs.getdecoder('utf-8'),      # reader/writer: used to read and write to the stream.     codecs.getreader('latin-1'), codecs.getwriter('latin-1') )


File: python.info,  Node: Files in an Unknown Encoding,  Prev: Converting Between File Encodings,  Up: Tips for Writing Unicode-aware Programs

10.11.3.4 Files in an Unknown Encoding
......................................

What can you do if you need to make a change to a file, but don’t know
the file’s encoding?  If you know the encoding is ASCII-compatible and
only want to examine or modify the ASCII parts, you can open the file
with the ‘surrogateescape’ error handler:

     with open(fname, 'r', encoding="ascii", errors="surrogateescape") as f:     data = f.read()  # make changes to the string 'data'  with open(fname + '.new', 'w',           encoding="ascii", errors="surrogateescape") as f:     f.write(data)

The ‘surrogateescape’ error handler will decode any non-ASCII bytes as
code points in a special range running from U+DC80 to U+DCFF. These code
points will then turn back into the same bytes when the
‘surrogateescape’ error handler is used to encode the data and write it
back out.


File: python.info,  Node: References<5>,  Prev: Tips for Writing Unicode-aware Programs,  Up: Reading and Writing Unicode Data

10.11.3.5 References
....................

One section of Mastering Python 3 Input/Output(1), a PyCon 2010 talk by
David Beazley, discusses text processing and binary data handling.

The PDF slides for Marc-André Lemburg’s presentation "Writing
Unicode-aware Applications in Python"(2) discuss questions of character
encodings as well as how to internationalize and localize an
application.  These slides cover Python 2.x only.

The Guts of Unicode in Python(3) is a PyCon 2013 talk by Benjamin
Peterson that discusses the internal Unicode representation in Python
3.3.

   ---------- Footnotes ----------

   (1) http://pyvideo.org/video/289/pycon-2010–mastering-python-3-i-o

   (2) 
https://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf

   (3) http://pyvideo.org/video/1768/the-guts-of-unicode-in-python


File: python.info,  Node: Acknowledgements<10>,  Prev: Reading and Writing Unicode Data,  Up: Unicode HOWTO

10.11.4 Acknowledgements
------------------------

The initial draft of this document was written by Andrew Kuchling.  It
has since been revised further by Alexander Belopolsky, Georg Brandl,
Andrew Kuchling, and Ezio Melotti.

Thanks to the following people who have noted errors or offered
suggestions on this article: Éric Araujo, Nicholas Bastin, Nick Coghlan,
Marius Gedminas, Kent Johnson, Ken Krugler, Marc-André Lemburg, Martin
von Löwis, Terry J. Reedy, Serhiy Storchaka, Eryk Sun, Chad Whitacre,
Graham Wideman.


File: python.info,  Node: HOWTO Fetch Internet Resources Using The urllib Package,  Next: Argparse Tutorial,  Prev: Unicode HOWTO,  Up: Python HOWTOs

10.12 HOWTO Fetch Internet Resources Using The urllib Package
=============================================================


Author: Michael Foord(1)

     Note: There is a French translation of an earlier revision of this
     HOWTO, available at urllib2 - Le Manuel manquant(2).

* Menu:

* Introduction: Introduction<16>.
* Fetching URLs::
* Handling Exceptions: Handling Exceptions<2>.
* info and geturl::
* Openers and Handlers::
* Basic Authentication::
* Proxies::
* Sockets and Layers::
* Footnotes::

   ---------- Footnotes ----------

   (1) http://www.voidspace.org.uk/python/index.shtml

   (2) 
http://www.voidspace.org.uk/python/articles/urllib2_francais.shtml


File: python.info,  Node: Introduction<16>,  Next: Fetching URLs,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.1 Introduction
--------------------

Related Articles
................

You may also find useful the following article on fetching web resources
with Python:

   * Basic Authentication(1)

          A tutorial on `Basic Authentication', with examples in Python.

`urllib.request' is a Python module for fetching URLs (Uniform Resource
Locators).  It offers a very simple interface, in the form of the
`urlopen' function.  This is capable of fetching URLs using a variety of
different protocols.  It also offers a slightly more complex interface
for handling common situations - like basic authentication, cookies,
proxies and so on.  These are provided by objects called handlers and
openers.

urllib.request supports fetching URLs for many “URL schemes” (identified
by the string before the ‘":"’ in URL - for example ‘"ftp"’ is the URL
scheme of ‘"ftp://python.org/"’) using their associated network
protocols (e.g.  FTP, HTTP). This tutorial focuses on the most common
case, HTTP.

For straightforward situations `urlopen' is very easy to use.  But as
soon as you encounter errors or non-trivial cases when opening HTTP
URLs, you will need some understanding of the HyperText Transfer
Protocol.  The most comprehensive and authoritative reference to HTTP is
RFC 2616(2).  This is a technical document and not intended to be easy
to read.  This HOWTO aims to illustrate using `urllib', with enough
detail about HTTP to help you through.  It is not intended to replace
the *note urllib.request: 120. docs, but is supplementary to them.

   ---------- Footnotes ----------

   (1) http://www.voidspace.org.uk/python/articles/authentication.shtml

   (2) https://tools.ietf.org/html/rfc2616.html


File: python.info,  Node: Fetching URLs,  Next: Handling Exceptions<2>,  Prev: Introduction<16>,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.2 Fetching URLs
---------------------

The simplest way to use urllib.request is as follows:

     import urllib.request with urllib.request.urlopen('http://python.org/') as response:    html = response.read()

If you wish to retrieve a resource via URL and store it in a temporary
location, you can do so via the *note shutil.copyfileobj(): 25b. and
*note tempfile.NamedTemporaryFile(): d3c. functions:

     import shutil import tempfile import urllib.request  with urllib.request.urlopen('http://python.org/') as response:     with tempfile.NamedTemporaryFile(delete=False) as tmp_file:         shutil.copyfileobj(response, tmp_file)  with open(tmp_file.name) as html:     pass

Many uses of urllib will be that simple (note that instead of an ‘http:’
URL we could have used a URL starting with ‘ftp:’, ‘file:’, etc.).
However, it’s the purpose of this tutorial to explain the more
complicated cases, concentrating on HTTP.

HTTP is based on requests and responses - the client makes requests and
servers send responses.  urllib.request mirrors this with a ‘Request’
object which represents the HTTP request you are making.  In its
simplest form you create a Request object that specifies the URL you
want to fetch.  Calling ‘urlopen’ with this Request object returns a
response object for the URL requested.  This response is a file-like
object, which means you can for example call ‘.read()’ on the response:

     import urllib.request  req = urllib.request.Request('http://www.voidspace.org.uk') with urllib.request.urlopen(req) as response:    the_page = response.read()

Note that urllib.request makes use of the same Request interface to
handle all URL schemes.  For example, you can make an FTP request like
so:

     req = urllib.request.Request('ftp://example.com/')

In the case of HTTP, there are two extra things that Request objects
allow you to do: First, you can pass data to be sent to the server.
Second, you can pass extra information (“metadata”) `about' the data or
the about request itself, to the server - this information is sent as
HTTP “headers”.  Let’s look at each of these in turn.

* Menu:

* Data::
* Headers::


File: python.info,  Node: Data,  Next: Headers,  Up: Fetching URLs

10.12.2.1 Data
..............

Sometimes you want to send data to a URL (often the URL will refer to a
CGI (Common Gateway Interface) script or other web application).  With
HTTP, this is often done using what’s known as a `POST' request.  This
is often what your browser does when you submit a HTML form that you
filled in on the web.  Not all POSTs have to come from forms: you can
use a POST to transmit arbitrary data to your own application.  In the
common case of HTML forms, the data needs to be encoded in a standard
way, and then passed to the Request object as the ‘data’ argument.  The
encoding is done using a function from the *note urllib.parse: 11f.
library.

     import urllib.parse import urllib.request  url = 'http://www.someserver.com/cgi-bin/register.cgi' values = {'name' : 'Michael Foord',           'location' : 'Northampton',           'language' : 'Python' }  data = urllib.parse.urlencode(values) data = data.encode('ascii') # data should be bytes req = urllib.request.Request(url, data) with urllib.request.urlopen(req) as response:    the_page = response.read()

Note that other encodings are sometimes required (e.g.  for file upload
from HTML forms - see HTML Specification, Form Submission(1) for more
details).

If you do not pass the ‘data’ argument, urllib uses a `GET' request.
One way in which GET and POST requests differ is that POST requests
often have “side-effects”: they change the state of the system in some
way (for example by placing an order with the website for a
hundredweight of tinned spam to be delivered to your door).  Though the
HTTP standard makes it clear that POSTs are intended to `always' cause
side-effects, and GET requests `never' to cause side-effects, nothing
prevents a GET request from having side-effects, nor a POST requests
from having no side-effects.  Data can also be passed in an HTTP GET
request by encoding it in the URL itself.

This is done as follows:

     >>> import urllib.request >>> import urllib.parse >>> data = {} >>> data['name'] = 'Somebody Here' >>> data['location'] = 'Northampton' >>> data['language'] = 'Python' >>> url_values = urllib.parse.urlencode(data) >>> print(url_values)  # The order may differ from below.   name=Somebody+Here&language=Python&location=Northampton >>> url = 'http://www.example.com/example.cgi' >>> full_url = url + '?' + url_values >>> data = urllib.request.urlopen(full_url)

Notice that the full URL is created by adding a ‘?’ to the URL, followed
by the encoded values.

   ---------- Footnotes ----------

   (1) https://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13


File: python.info,  Node: Headers,  Prev: Data,  Up: Fetching URLs

10.12.2.2 Headers
.................

We’ll discuss here one particular HTTP header, to illustrate how to add
headers to your HTTP request.

Some websites (1) dislike being browsed by programs, or send different
versions to different browsers (2).  By default urllib identifies itself
as ‘Python-urllib/x.y’ (where ‘x’ and ‘y’ are the major and minor
version numbers of the Python release, e.g.  ‘Python-urllib/2.5’), which
may confuse the site, or just plain not work.  The way a browser
identifies itself is through the ‘User-Agent’ header (3).  When you
create a Request object you can pass a dictionary of headers in.  The
following example makes the same request as above, but identifies itself
as a version of Internet Explorer (4).

     import urllib.parse import urllib.request  url = 'http://www.someserver.com/cgi-bin/register.cgi' user_agent = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64)' values = {'name': 'Michael Foord',           'location': 'Northampton',           'language': 'Python' } headers = {'User-Agent': user_agent}  data = urllib.parse.urlencode(values) data = data.encode('ascii') req = urllib.request.Request(url, data, headers) with urllib.request.urlopen(req) as response:    the_page = response.read()

The response also has two useful methods.  See the section on *note info
and geturl: 4129. which comes after we have a look at what happens when
things go wrong.

   ---------- Footnotes ----------

   (1) (1) Google for example.

   (2) (2) Browser sniffing is a very bad practice for website design -
building sites using web standards is much more sensible.  Unfortunately
a lot of sites still send different versions to different browsers.

   (3) (3) The user agent for MSIE 6 is `‘Mozilla/4.0 (compatible; MSIE
6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)’'

   (4) (4) For details of more HTTP request headers, see Quick Reference
to HTTP Headers (http://jkorpela.fi/http.html).


File: python.info,  Node: Handling Exceptions<2>,  Next: info and geturl,  Prev: Fetching URLs,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.3 Handling Exceptions
---------------------------

`urlopen' raises ‘URLError’ when it cannot handle a response (though as
usual with Python APIs, built-in exceptions such as *note ValueError:
1f9, *note TypeError: 192. etc.  may also be raised).

‘HTTPError’ is the subclass of ‘URLError’ raised in the specific case of
HTTP URLs.

The exception classes are exported from the *note urllib.error: 11e.
module.

* Menu:

* URLError::
* HTTPError::
* Wrapping it Up::


File: python.info,  Node: URLError,  Next: HTTPError,  Up: Handling Exceptions<2>

10.12.3.1 URLError
..................

Often, URLError is raised because there is no network connection (no
route to the specified server), or the specified server doesn’t exist.
In this case, the exception raised will have a ‘reason’ attribute, which
is a tuple containing an error code and a text error message.

e.g.

     >>> req = urllib.request.Request('http://www.pretend_server.org') >>> try: urllib.request.urlopen(req) ... except urllib.error.URLError as e: ...     print(e.reason)       ... (4, 'getaddrinfo failed')


File: python.info,  Node: HTTPError,  Next: Wrapping it Up,  Prev: URLError,  Up: Handling Exceptions<2>

10.12.3.2 HTTPError
...................

Every HTTP response from the server contains a numeric “status code”.
Sometimes the status code indicates that the server is unable to fulfil
the request.  The default handlers will handle some of these responses
for you (for example, if the response is a “redirection” that requests
the client fetch the document from a different URL, urllib will handle
that for you).  For those it can’t handle, urlopen will raise an
‘HTTPError’.  Typical errors include ‘404’ (page not found), ‘403’
(request forbidden), and ‘401’ (authentication required).

See section 10 of RFC 2616(1) for a reference on all the HTTP error
codes.

The ‘HTTPError’ instance raised will have an integer ‘code’ attribute,
which corresponds to the error sent by the server.

* Menu:

* Error Codes::

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2616.html


File: python.info,  Node: Error Codes,  Up: HTTPError

10.12.3.3 Error Codes
.....................

Because the default handlers handle redirects (codes in the 300 range),
and codes in the 100–299 range indicate success, you will usually only
see error codes in the 400–599 range.

*note http.server.BaseHTTPRequestHandler.responses: 2c0c. is a useful
dictionary of response codes in that shows all the response codes used
by RFC 2616(1).  The dictionary is reproduced here for convenience

     # Table mapping response codes to messages; entries have the # form {code: (shortmessage, longmessage)}. responses = {     100: ('Continue', 'Request received, please continue'),     101: ('Switching Protocols',           'Switching to new protocol; obey Upgrade header'),      200: ('OK', 'Request fulfilled, document follows'),     201: ('Created', 'Document created, URL follows'),     202: ('Accepted',           'Request accepted, processing continues off-line'),     203: ('Non-Authoritative Information', 'Request fulfilled from cache'),     204: ('No Content', 'Request fulfilled, nothing follows'),     205: ('Reset Content', 'Clear input form for further input.'),     206: ('Partial Content', 'Partial content follows.'),      300: ('Multiple Choices',           'Object has several resources -- see URI list'),     301: ('Moved Permanently', 'Object moved permanently -- see URI list'),     302: ('Found', 'Object moved temporarily -- see URI list'),     303: ('See Other', 'Object moved -- see Method and URL list'),     304: ('Not Modified',           'Document has not changed since given time'),     305: ('Use Proxy',           'You must use proxy specified in Location to access this '           'resource.'),     307: ('Temporary Redirect',           'Object moved temporarily -- see URI list'),      400: ('Bad Request',           'Bad request syntax or unsupported method'),     401: ('Unauthorized',           'No permission -- see authorization schemes'),     402: ('Payment Required',           'No payment -- see charging schemes'),     403: ('Forbidden',           'Request forbidden -- authorization will not help'),     404: ('Not Found', 'Nothing matches the given URI'),     405: ('Method Not Allowed',           'Specified method is invalid for this server.'),     406: ('Not Acceptable', 'URI not available in preferred format.'),     407: ('Proxy Authentication Required', 'You must authenticate with '           'this proxy before proceeding.'),     408: ('Request Timeout', 'Request timed out; try again later.'),     409: ('Conflict', 'Request conflict.'),     410: ('Gone',           'URI no longer exists and has been permanently removed.'),     411: ('Length Required', 'Client must specify Content-Length.'),     412: ('Precondition Failed', 'Precondition in headers is false.'),     413: ('Request Entity Too Large', 'Entity is too large.'),     414: ('Request-URI Too Long', 'URI is too long.'),     415: ('Unsupported Media Type', 'Entity body in unsupported format.'),     416: ('Requested Range Not Satisfiable',           'Cannot satisfy request range.'),     417: ('Expectation Failed',           'Expect condition could not be satisfied.'),      500: ('Internal Server Error', 'Server got itself in trouble'),     501: ('Not Implemented',           'Server does not support this operation'),     502: ('Bad Gateway', 'Invalid responses from another server/proxy.'),     503: ('Service Unavailable',           'The server cannot process the request due to a high load'),     504: ('Gateway Timeout',           'The gateway server did not receive a timely response'),     505: ('HTTP Version Not Supported', 'Cannot fulfill request.'),     }

When an error is raised the server responds by returning an HTTP error
code `and' an error page.  You can use the ‘HTTPError’ instance as a
response on the page returned.  This means that as well as the code
attribute, it also has read, geturl, and info, methods as returned by
the ‘urllib.response’ module:

     >>> req = urllib.request.Request('http://www.python.org/fish.html') >>> try: ...     urllib.request.urlopen(req) ... except urllib.error.HTTPError as e: ...     print(e.code) ...     print(e.read())   ... 404 b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html   ...   <title>Page Not Found</title>\n   ...

   ---------- Footnotes ----------

   (1) https://tools.ietf.org/html/rfc2616.html


File: python.info,  Node: Wrapping it Up,  Prev: HTTPError,  Up: Handling Exceptions<2>

10.12.3.4 Wrapping it Up
........................

So if you want to be prepared for ‘HTTPError’ `or' ‘URLError’ there are
two basic approaches.  I prefer the second approach.

* Menu:

* Number 1::
* Number 2::


File: python.info,  Node: Number 1,  Next: Number 2,  Up: Wrapping it Up

10.12.3.5 Number 1
..................

     from urllib.request import Request, urlopen from urllib.error import URLError, HTTPError req = Request(someurl) try:     response = urlopen(req) except HTTPError as e:     print('The server couldn\'t fulfill the request.')     print('Error code: ', e.code) except URLError as e:     print('We failed to reach a server.')     print('Reason: ', e.reason) else:     # everything is fine

     Note: The ‘except HTTPError’ `must' come first, otherwise ‘except
     URLError’ will `also' catch an ‘HTTPError’.


File: python.info,  Node: Number 2,  Prev: Number 1,  Up: Wrapping it Up

10.12.3.6 Number 2
..................

     from urllib.request import Request, urlopen from urllib.error import URLError req = Request(someurl) try:     response = urlopen(req) except URLError as e:     if hasattr(e, 'reason'):         print('We failed to reach a server.')         print('Reason: ', e.reason)     elif hasattr(e, 'code'):         print('The server couldn\'t fulfill the request.')         print('Error code: ', e.code) else:     # everything is fine


File: python.info,  Node: info and geturl,  Next: Openers and Handlers,  Prev: Handling Exceptions<2>,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.4 info and geturl
-----------------------

The response returned by urlopen (or the ‘HTTPError’ instance) has two
useful methods ‘info()’ and ‘geturl()’ and is defined in the module
*note urllib.response: 121..

`geturl' - this returns the real URL of the page fetched.  This is
useful because ‘urlopen’ (or the opener object used) may have followed a
redirect.  The URL of the page fetched may not be the same as the URL
requested.

`info' - this returns a dictionary-like object that describes the page
fetched, particularly the headers sent by the server.  It is currently
an ‘http.client.HTTPMessage’ instance.

Typical headers include ‘Content-length’, ‘Content-type’, and so on.
See the Quick Reference to HTTP Headers(1) for a useful listing of HTTP
headers with brief explanations of their meaning and use.

   ---------- Footnotes ----------

   (1) http://jkorpela.fi/http.html


File: python.info,  Node: Openers and Handlers,  Next: Basic Authentication,  Prev: info and geturl,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.5 Openers and Handlers
----------------------------

When you fetch a URL you use an opener (an instance of the perhaps
confusingly-named *note urllib.request.OpenerDirector: 2b6e.).  Normally
we have been using the default opener - via ‘urlopen’ - but you can
create custom openers.  Openers use handlers.  All the “heavy lifting”
is done by the handlers.  Each handler knows how to open URLs for a
particular URL scheme (http, ftp, etc.), or how to handle an aspect of
URL opening, for example HTTP redirections or HTTP cookies.

You will want to create openers if you want to fetch URLs with specific
handlers installed, for example to get an opener that handles cookies,
or to get an opener that does not handle redirections.

To create an opener, instantiate an ‘OpenerDirector’, and then call
‘.add_handler(some_handler_instance)’ repeatedly.

Alternatively, you can use ‘build_opener’, which is a convenience
function for creating opener objects with a single function call.
‘build_opener’ adds several handlers by default, but provides a quick
way to add more and/or override the default handlers.

Other sorts of handlers you might want to can handle proxies,
authentication, and other common but slightly specialised situations.

‘install_opener’ can be used to make an ‘opener’ object the (global)
default opener.  This means that calls to ‘urlopen’ will use the opener
you have installed.

Opener objects have an ‘open’ method, which can be called directly to
fetch urls in the same way as the ‘urlopen’ function: there’s no need to
call ‘install_opener’, except as a convenience.


File: python.info,  Node: Basic Authentication,  Next: Proxies,  Prev: Openers and Handlers,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.6 Basic Authentication
----------------------------

To illustrate creating and installing a handler we will use the
‘HTTPBasicAuthHandler’.  For a more detailed discussion of this subject
– including an explanation of how Basic Authentication works - see the
Basic Authentication Tutorial(1).

When authentication is required, the server sends a header (as well as
the 401 error code) requesting authentication.  This specifies the
authentication scheme and a ‘realm’.  The header looks like:
‘WWW-Authenticate: SCHEME realm="REALM"’.

e.g.

     WWW-Authenticate: Basic realm="cPanel Users"

The client should then retry the request with the appropriate name and
password for the realm included as a header in the request.  This is
‘basic authentication’.  In order to simplify this process we can create
an instance of ‘HTTPBasicAuthHandler’ and an opener to use this handler.

The ‘HTTPBasicAuthHandler’ uses an object called a password manager to
handle the mapping of URLs and realms to passwords and usernames.  If
you know what the realm is (from the authentication header sent by the
server), then you can use a ‘HTTPPasswordMgr’.  Frequently one doesn’t
care what the realm is.  In that case, it is convenient to use
‘HTTPPasswordMgrWithDefaultRealm’.  This allows you to specify a default
username and password for a URL. This will be supplied in the absence of
you providing an alternative combination for a specific realm.  We
indicate this by providing ‘None’ as the realm argument to the
‘add_password’ method.

The top-level URL is the first URL that requires authentication.  URLs
“deeper” than the URL you pass to .add_password() will also match.

     # create a password manager password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()  # Add the username and password. # If we knew the realm, we could use it instead of None. top_level_url = "http://example.com/foo/" password_mgr.add_password(None, top_level_url, username, password)  handler = urllib.request.HTTPBasicAuthHandler(password_mgr)  # create "opener" (OpenerDirector instance) opener = urllib.request.build_opener(handler)  # use the opener to fetch a URL opener.open(a_url)  # Install the opener. # Now all calls to urllib.request.urlopen use our opener. urllib.request.install_opener(opener)

     Note: In the above example we only supplied our
     ‘HTTPBasicAuthHandler’ to ‘build_opener’.  By default openers have
     the handlers for normal situations – ‘ProxyHandler’ (if a proxy
     setting such as an ‘http_proxy’ environment variable is set),
     ‘UnknownHandler’, ‘HTTPHandler’, ‘HTTPDefaultErrorHandler’,
     ‘HTTPRedirectHandler’, ‘FTPHandler’, ‘FileHandler’, ‘DataHandler’,
     ‘HTTPErrorProcessor’.

‘top_level_url’ is in fact `either' a full URL (including the ‘http:’
scheme component and the hostname and optionally the port number) e.g.
‘"http://example.com/"’ `or' an “authority” (i.e.  the hostname,
optionally including the port number) e.g.  ‘"example.com"’ or
‘"example.com:8080"’ (the latter example includes a port number).  The
authority, if present, must NOT contain the “userinfo” component - for
example ‘"joe:password@example.com"’ is not correct.

   ---------- Footnotes ----------

   (1) http://www.voidspace.org.uk/python/articles/authentication.shtml


File: python.info,  Node: Proxies,  Next: Sockets and Layers,  Prev: Basic Authentication,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.7 Proxies
---------------

`urllib' will auto-detect your proxy settings and use those.  This is
through the ‘ProxyHandler’, which is part of the normal handler chain
when a proxy setting is detected.  Normally that’s a good thing, but
there are occasions when it may not be helpful (1).  One way to do this
is to setup our own ‘ProxyHandler’, with no proxies defined.  This is
done using similar steps to setting up a Basic Authentication(2)
handler:

     >>> proxy_support = urllib.request.ProxyHandler({}) >>> opener = urllib.request.build_opener(proxy_support) >>> urllib.request.install_opener(opener)

     Note: Currently ‘urllib.request’ `does not' support fetching of
     ‘https’ locations through a proxy.  However, this can be enabled by
     extending urllib.request as shown in the recipe (3).

     Note: ‘HTTP_PROXY’ will be ignored if a variable ‘REQUEST_METHOD’
     is set; see the documentation on *note getproxies(): 2b7c.

   ---------- Footnotes ----------

   (1) (5) In my case I have to use a proxy to access the internet at
work.  If you attempt to fetch `localhost' URLs through this proxy it
blocks them.  IE is set to use the proxy, which urllib picks up on.  In
order to test scripts with a localhost server, I have to prevent urllib
from using the proxy.

   (2) http://www.voidspace.org.uk/python/articles/authentication.shtml

   (3) (6) urllib opener for SSL proxy (CONNECT method): ASPN Cookbook
Recipe (https://code.activestate.com/recipes/456195/).


File: python.info,  Node: Sockets and Layers,  Next: Footnotes,  Prev: Proxies,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.8 Sockets and Layers
--------------------------

The Python support for fetching resources from the web is layered.
urllib uses the *note http.client: 94. library, which in turn uses the
socket library.

As of Python 2.3 you can specify how long a socket should wait for a
response before timing out.  This can be useful in applications which
have to fetch web pages.  By default the socket module has `no timeout'
and can hang.  Currently, the socket timeout is not exposed at the
http.client or urllib.request levels.  However, you can set the default
timeout globally for all sockets using

     import socket import urllib.request  # timeout in seconds timeout = 10 socket.setdefaulttimeout(timeout)  # this call to urllib.request.urlopen now uses the default timeout # we have set in the socket module req = urllib.request.Request('http://www.voidspace.org.uk') response = urllib.request.urlopen(req)

__________________________________________________________________


File: python.info,  Node: Footnotes,  Prev: Sockets and Layers,  Up: HOWTO Fetch Internet Resources Using The urllib Package

10.12.9 Footnotes
-----------------

This document was reviewed and revised by John Lee.


File: python.info,  Node: Argparse Tutorial,  Next: An introduction to the ipaddress module,  Prev: HOWTO Fetch Internet Resources Using The urllib Package,  Up: Python HOWTOs

10.13 Argparse Tutorial
=======================


author: Tshepang Lekhonkhobe

This tutorial is intended to be a gentle introduction to *note argparse:
6, the recommended command-line parsing module in the Python standard
library.

     Note: There are two other modules that fulfill the same task,
     namely *note getopt: 87. (an equivalent for ‘getopt()’ from the C
     language) and the deprecated *note optparse: c3.  Note also that
     *note argparse: 6. is based on *note optparse: c3, and therefore
     very similar in terms of usage.

* Menu:

* Concepts::
* The basics::
* Introducing Positional arguments::
* Introducing Optional arguments::
* Combining Positional and Optional arguments::
* Getting a little more advanced::
* Conclusion::


File: python.info,  Node: Concepts,  Next: The basics,  Up: Argparse Tutorial

10.13.1 Concepts
----------------

Let’s show the sort of functionality that we are going to explore in
this introductory tutorial by making use of the ‘ls’ command:

     $ ls cpython  devguide  prog.py  pypy  rm-unused-function.patch $ ls pypy ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ... $ ls -l total 20 drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide -rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy -rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch $ ls --help Usage: ls [OPTION]... [FILE]... List information about the FILEs (the current directory by default). Sort entries alphabetically if none of -cftuvSUX nor --sort is specified. ...

A few concepts we can learn from the four commands:

   * The ‘ls’ command is useful when run without any options at all.  It
     defaults to displaying the contents of the current directory.

   * If we want beyond what it provides by default, we tell it a bit
     more.  In this case, we want it to display a different directory,
     ‘pypy’.  What we did is specify what is known as a positional
     argument.  It’s named so because the program should know what to do
     with the value, solely based on where it appears on the command
     line.  This concept is more relevant to a command like ‘cp’, whose
     most basic usage is ‘cp SRC DEST’.  The first position is `what you
     want copied,' and the second position is `where you want it copied
     to'.

   * Now, say we want to change behaviour of the program.  In our
     example, we display more info for each file instead of just showing
     the file names.  The ‘-l’ in that case is known as an optional
     argument.

   * That’s a snippet of the help text.  It’s very useful in that you
     can come across a program you have never used before, and can
     figure out how it works simply by reading its help text.


File: python.info,  Node: The basics,  Next: Introducing Positional arguments,  Prev: Concepts,  Up: Argparse Tutorial

10.13.2 The basics
------------------

Let us start with a very simple example which does (almost) nothing:

     import argparse parser = argparse.ArgumentParser() parser.parse_args()

Following is a result of running the code:

     $ python3 prog.py $ python3 prog.py --help usage: prog.py [-h]  optional arguments:   -h, --help  show this help message and exit $ python3 prog.py --verbose usage: prog.py [-h] prog.py: error: unrecognized arguments: --verbose $ python3 prog.py foo usage: prog.py [-h] prog.py: error: unrecognized arguments: foo

Here is what is happening:

   * Running the script without any options results in nothing displayed
     to stdout.  Not so useful.

   * The second one starts to display the usefulness of the *note
     argparse: 6. module.  We have done almost nothing, but already we
     get a nice help message.

   * The ‘--help’ option, which can also be shortened to ‘-h’, is the
     only option we get for free (i.e.  no need to specify it).
     Specifying anything else results in an error.  But even then, we do
     get a useful usage message, also for free.


File: python.info,  Node: Introducing Positional arguments,  Next: Introducing Optional arguments,  Prev: The basics,  Up: Argparse Tutorial

10.13.3 Introducing Positional arguments
----------------------------------------

An example:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("echo") args = parser.parse_args() print(args.echo)

And running the code:

     $ python3 prog.py usage: prog.py [-h] echo prog.py: error: the following arguments are required: echo $ python3 prog.py --help usage: prog.py [-h] echo  positional arguments:   echo  optional arguments:   -h, --help  show this help message and exit $ python3 prog.py foo foo

Here is what’s happening:

   * We’ve added the ‘add_argument()’ method, which is what we use to
     specify which command-line options the program is willing to
     accept.  In this case, I’ve named it ‘echo’ so that it’s in line
     with its function.

   * Calling our program now requires us to specify an option.

   * The ‘parse_args()’ method actually returns some data from the
     options specified, in this case, ‘echo’.

   * The variable is some form of ‘magic’ that *note argparse: 6.
     performs for free (i.e.  no need to specify which variable that
     value is stored in).  You will also notice that its name matches
     the string argument given to the method, ‘echo’.

Note however that, although the help display looks nice and all, it
currently is not as helpful as it can be.  For example we see that we
got ‘echo’ as a positional argument, but we don’t know what it does,
other than by guessing or by reading the source code.  So, let’s make it
a bit more useful:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("echo", help="echo the string you use here") args = parser.parse_args() print(args.echo)

And we get:

     $ python3 prog.py -h usage: prog.py [-h] echo  positional arguments:   echo        echo the string you use here  optional arguments:   -h, --help  show this help message and exit

Now, how about doing something even more useful:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", help="display a square of a given number") args = parser.parse_args() print(args.square**2)

Following is a result of running the code:

     $ python3 prog.py 4 Traceback (most recent call last):   File "prog.py", line 5, in <module>     print(args.square**2) TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

That didn’t go so well.  That’s because *note argparse: 6. treats the
options we give it as strings, unless we tell it otherwise.  So, let’s
tell *note argparse: 6. to treat that input as an integer:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", help="display a square of a given number",                     type=int) args = parser.parse_args() print(args.square**2)

Following is a result of running the code:

     $ python3 prog.py 4 16 $ python3 prog.py four usage: prog.py [-h] square prog.py: error: argument square: invalid int value: 'four'

That went well.  The program now even helpfully quits on bad illegal
input before proceeding.


File: python.info,  Node: Introducing Optional arguments,  Next: Combining Positional and Optional arguments,  Prev: Introducing Positional arguments,  Up: Argparse Tutorial

10.13.4 Introducing Optional arguments
--------------------------------------

So far we have been playing with positional arguments.  Let us have a
look on how to add optional ones:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("--verbosity", help="increase output verbosity") args = parser.parse_args() if args.verbosity:     print("verbosity turned on")

And the output:

     $ python3 prog.py --verbosity 1 verbosity turned on $ python3 prog.py $ python3 prog.py --help usage: prog.py [-h] [--verbosity VERBOSITY]  optional arguments:   -h, --help            show this help message and exit   --verbosity VERBOSITY                         increase output verbosity $ python3 prog.py --verbosity usage: prog.py [-h] [--verbosity VERBOSITY] prog.py: error: argument --verbosity: expected one argument

Here is what is happening:

   * The program is written so as to display something when
     ‘--verbosity’ is specified and display nothing when not.

   * To show that the option is actually optional, there is no error
     when running the program without it.  Note that by default, if an
     optional argument isn’t used, the relevant variable, in this case
     ‘args.verbosity’, is given ‘None’ as a value, which is the reason
     it fails the truth test of the *note if: dda. statement.

   * The help message is a bit different.

   * When using the ‘--verbosity’ option, one must also specify some
     value, any value.

The above example accepts arbitrary integer values for ‘--verbosity’,
but for our simple program, only two values are actually useful, ‘True’
or ‘False’.  Let’s modify the code accordingly:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("--verbose", help="increase output verbosity",                     action="store_true") args = parser.parse_args() if args.verbose:     print("verbosity turned on")

And the output:

     $ python3 prog.py --verbose verbosity turned on $ python3 prog.py --verbose 1 usage: prog.py [-h] [--verbose] prog.py: error: unrecognized arguments: 1 $ python3 prog.py --help usage: prog.py [-h] [--verbose]  optional arguments:   -h, --help  show this help message and exit   --verbose   increase output verbosity

Here is what is happening:

   * The option is now more of a flag than something that requires a
     value.  We even changed the name of the option to match that idea.
     Note that we now specify a new keyword, ‘action’, and give it the
     value ‘"store_true"’.  This means that, if the option is specified,
     assign the value ‘True’ to ‘args.verbose’.  Not specifying it
     implies ‘False’.

   * It complains when you specify a value, in true spirit of what flags
     actually are.

   * Notice the different help text.

* Menu:

* Short options::


File: python.info,  Node: Short options,  Up: Introducing Optional arguments

10.13.4.1 Short options
.......................

If you are familiar with command line usage, you will notice that I
haven’t yet touched on the topic of short versions of the options.  It’s
quite simple:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("-v", "--verbose", help="increase output verbosity",                     action="store_true") args = parser.parse_args() if args.verbose:     print("verbosity turned on")

And here goes:

     $ python3 prog.py -v verbosity turned on $ python3 prog.py --help usage: prog.py [-h] [-v]  optional arguments:   -h, --help     show this help message and exit   -v, --verbose  increase output verbosity

Note that the new ability is also reflected in the help text.


File: python.info,  Node: Combining Positional and Optional arguments,  Next: Getting a little more advanced,  Prev: Introducing Optional arguments,  Up: Argparse Tutorial

10.13.5 Combining Positional and Optional arguments
---------------------------------------------------

Our program keeps growing in complexity:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", type=int,                     help="display a square of a given number") parser.add_argument("-v", "--verbose", action="store_true",                     help="increase output verbosity") args = parser.parse_args() answer = args.square**2 if args.verbose:     print("the square of {} equals {}".format(args.square, answer)) else:     print(answer)

And now the output:

     $ python3 prog.py usage: prog.py [-h] [-v] square prog.py: error: the following arguments are required: square $ python3 prog.py 4 16 $ python3 prog.py 4 --verbose the square of 4 equals 16 $ python3 prog.py --verbose 4 the square of 4 equals 16

   * We’ve brought back a positional argument, hence the complaint.

   * Note that the order does not matter.

How about we give this program of ours back the ability to have multiple
verbosity values, and actually get to use them:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", type=int,                     help="display a square of a given number") parser.add_argument("-v", "--verbosity", type=int,                     help="increase output verbosity") args = parser.parse_args() answer = args.square**2 if args.verbosity == 2:     print("the square of {} equals {}".format(args.square, answer)) elif args.verbosity == 1:     print("{}^2 == {}".format(args.square, answer)) else:     print(answer)

And the output:

     $ python3 prog.py 4 16 $ python3 prog.py 4 -v usage: prog.py [-h] [-v VERBOSITY] square prog.py: error: argument -v/--verbosity: expected one argument $ python3 prog.py 4 -v 1 4^2 == 16 $ python3 prog.py 4 -v 2 the square of 4 equals 16 $ python3 prog.py 4 -v 3 16

These all look good except the last one, which exposes a bug in our
program.  Let’s fix it by restricting the values the ‘--verbosity’
option can accept:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", type=int,                     help="display a square of a given number") parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],                     help="increase output verbosity") args = parser.parse_args() answer = args.square**2 if args.verbosity == 2:     print("the square of {} equals {}".format(args.square, answer)) elif args.verbosity == 1:     print("{}^2 == {}".format(args.square, answer)) else:     print(answer)

And the output:

     $ python3 prog.py 4 -v 3 usage: prog.py [-h] [-v {0,1,2}] square prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2) $ python3 prog.py 4 -h usage: prog.py [-h] [-v {0,1,2}] square  positional arguments:   square                display a square of a given number  optional arguments:   -h, --help            show this help message and exit   -v {0,1,2}, --verbosity {0,1,2}                         increase output verbosity

Note that the change also reflects both in the error message as well as
the help string.

Now, let’s use a different approach of playing with verbosity, which is
pretty common.  It also matches the way the CPython executable handles
its own verbosity argument (check the output of ‘python --help’):

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", type=int,                     help="display the square of a given number") parser.add_argument("-v", "--verbosity", action="count",                     help="increase output verbosity") args = parser.parse_args() answer = args.square**2 if args.verbosity == 2:     print("the square of {} equals {}".format(args.square, answer)) elif args.verbosity == 1:     print("{}^2 == {}".format(args.square, answer)) else:     print(answer)

We have introduced another action, “count”, to count the number of
occurrences of a specific optional arguments:

     $ python3 prog.py 4 16 $ python3 prog.py 4 -v 4^2 == 16 $ python3 prog.py 4 -vv the square of 4 equals 16 $ python3 prog.py 4 --verbosity --verbosity the square of 4 equals 16 $ python3 prog.py 4 -v 1 usage: prog.py [-h] [-v] square prog.py: error: unrecognized arguments: 1 $ python3 prog.py 4 -h usage: prog.py [-h] [-v] square  positional arguments:   square           display a square of a given number  optional arguments:   -h, --help       show this help message and exit   -v, --verbosity  increase output verbosity $ python3 prog.py 4 -vvv 16

   * Yes, it’s now more of a flag (similar to ‘action="store_true"’) in
     the previous version of our script.  That should explain the
     complaint.

   * It also behaves similar to “store_true” action.

   * Now here’s a demonstration of what the “count” action gives.
     You’ve probably seen this sort of usage before.

   * And if you don’t specify the ‘-v’ flag, that flag is considered to
     have ‘None’ value.

   * As should be expected, specifying the long form of the flag, we
     should get the same output.

   * Sadly, our help output isn’t very informative on the new ability
     our script has acquired, but that can always be fixed by improving
     the documentation for our script (e.g.  via the ‘help’ keyword
     argument).

   * That last output exposes a bug in our program.

Let’s fix:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", type=int,                     help="display a square of a given number") parser.add_argument("-v", "--verbosity", action="count",                     help="increase output verbosity") args = parser.parse_args() answer = args.square**2  # bugfix: replace == with >= if args.verbosity >= 2:     print("the square of {} equals {}".format(args.square, answer)) elif args.verbosity >= 1:     print("{}^2 == {}".format(args.square, answer)) else:     print(answer)

And this is what it gives:

     $ python3 prog.py 4 -vvv the square of 4 equals 16 $ python3 prog.py 4 -vvvv the square of 4 equals 16 $ python3 prog.py 4 Traceback (most recent call last):   File "prog.py", line 11, in <module>     if args.verbosity >= 2: TypeError: '>=' not supported between instances of 'NoneType' and 'int'

   * First output went well, and fixes the bug we had before.  That is,
     we want any value >= 2 to be as verbose as possible.

   * Third output not so good.

Let’s fix that bug:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("square", type=int,                     help="display a square of a given number") parser.add_argument("-v", "--verbosity", action="count", default=0,                     help="increase output verbosity") args = parser.parse_args() answer = args.square**2 if args.verbosity >= 2:     print("the square of {} equals {}".format(args.square, answer)) elif args.verbosity >= 1:     print("{}^2 == {}".format(args.square, answer)) else:     print(answer)

We’ve just introduced yet another keyword, ‘default’.  We’ve set it to
‘0’ in order to make it comparable to the other int values.  Remember
that by default, if an optional argument isn’t specified, it gets the
‘None’ value, and that cannot be compared to an int value (hence the
*note TypeError: 192. exception).

And:

     $ python3 prog.py 4 16

You can go quite far just with what we’ve learned so far, and we have
only scratched the surface.  The *note argparse: 6. module is very
powerful, and we’ll explore a bit more of it before we end this
tutorial.


File: python.info,  Node: Getting a little more advanced,  Next: Conclusion,  Prev: Combining Positional and Optional arguments,  Up: Argparse Tutorial

10.13.6 Getting a little more advanced
--------------------------------------

What if we wanted to expand our tiny program to perform other powers,
not just squares:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("x", type=int, help="the base") parser.add_argument("y", type=int, help="the exponent") parser.add_argument("-v", "--verbosity", action="count", default=0) args = parser.parse_args() answer = args.x**args.y if args.verbosity >= 2:     print("{} to the power {} equals {}".format(args.x, args.y, answer)) elif args.verbosity >= 1:     print("{}^{} == {}".format(args.x, args.y, answer)) else:     print(answer)

Output:

     $ python3 prog.py usage: prog.py [-h] [-v] x y prog.py: error: the following arguments are required: x, y $ python3 prog.py -h usage: prog.py [-h] [-v] x y  positional arguments:   x                the base   y                the exponent  optional arguments:   -h, --help       show this help message and exit   -v, --verbosity $ python3 prog.py 4 2 -v 4^2 == 16

Notice that so far we’ve been using verbosity level to `change' the text
that gets displayed.  The following example instead uses verbosity level
to display `more' text instead:

     import argparse parser = argparse.ArgumentParser() parser.add_argument("x", type=int, help="the base") parser.add_argument("y", type=int, help="the exponent") parser.add_argument("-v", "--verbosity", action="count", default=0) args = parser.parse_args() answer = args.x**args.y if args.verbosity >= 2:     print("Running '{}'".format(__file__)) if args.verbosity >= 1:     print("{}^{} == ".format(args.x, args.y), end="") print(answer)

Output:

     $ python3 prog.py 4 2 16 $ python3 prog.py 4 2 -v 4^2 == 16 $ python3 prog.py 4 2 -vv Running 'prog.py' 4^2 == 16

* Menu:

* Conflicting options::


File: python.info,  Node: Conflicting options,  Up: Getting a little more advanced

10.13.6.1 Conflicting options
.............................

So far, we have been working with two methods of an *note
argparse.ArgumentParser: 689. instance.  Let’s introduce a third one,
‘add_mutually_exclusive_group()’.  It allows for us to specify options
that conflict with each other.  Let’s also change the rest of the
program so that the new functionality makes more sense: we’ll introduce
the ‘--quiet’ option, which will be the opposite of the ‘--verbose’ one:

     import argparse  parser = argparse.ArgumentParser() group = parser.add_mutually_exclusive_group() group.add_argument("-v", "--verbose", action="store_true") group.add_argument("-q", "--quiet", action="store_true") parser.add_argument("x", type=int, help="the base") parser.add_argument("y", type=int, help="the exponent") args = parser.parse_args() answer = args.x**args.y  if args.quiet:     print(answer) elif args.verbose:     print("{} to the power {} equals {}".format(args.x, args.y, answer)) else:     print("{}^{} == {}".format(args.x, args.y, answer))

Our program is now simpler, and we’ve lost some functionality for the
sake of demonstration.  Anyways, here’s the output:

     $ python3 prog.py 4 2 4^2 == 16 $ python3 prog.py 4 2 -q 16 $ python3 prog.py 4 2 -v 4 to the power 2 equals 16 $ python3 prog.py 4 2 -vq usage: prog.py [-h] [-v | -q] x y prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose $ python3 prog.py 4 2 -v --quiet usage: prog.py [-h] [-v | -q] x y prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose

That should be easy to follow.  I’ve added that last output so you can
see the sort of flexibility you get, i.e.  mixing long form options with
short form ones.

Before we conclude, you probably want to tell your users the main
purpose of your program, just in case they don’t know:

     import argparse  parser = argparse.ArgumentParser(description="calculate X to the power of Y") group = parser.add_mutually_exclusive_group() group.add_argument("-v", "--verbose", action="store_true") group.add_argument("-q", "--quiet", action="store_true") parser.add_argument("x", type=int, help="the base") parser.add_argument("y", type=int, help="the exponent") args = parser.parse_args() answer = args.x**args.y  if args.quiet:     print(answer) elif args.verbose:     print("{} to the power {} equals {}".format(args.x, args.y, answer)) else:     print("{}^{} == {}".format(args.x, args.y, answer))

Note that slight difference in the usage text.  Note the ‘[-v | -q]’,
which tells us that we can either use ‘-v’ or ‘-q’, but not both at the
same time:

     $ python3 prog.py --help usage: prog.py [-h] [-v | -q] x y  calculate X to the power of Y  positional arguments:   x              the base   y              the exponent  optional arguments:   -h, --help     show this help message and exit   -v, --verbose   -q, --quiet


File: python.info,  Node: Conclusion,  Prev: Getting a little more advanced,  Up: Argparse Tutorial

10.13.7 Conclusion
------------------

The *note argparse: 6. module offers a lot more than shown here.  Its
docs are quite detailed and thorough, and full of examples.  Having gone
through this tutorial, you should easily digest them without feeling
overwhelmed.


File: python.info,  Node: An introduction to the ipaddress module,  Next: Argument Clinic How-To,  Prev: Argparse Tutorial,  Up: Python HOWTOs

10.14 An introduction to the ipaddress module
=============================================


author: Peter Moody


author: Nick Coghlan

Overview
........

This document aims to provide a gentle introduction to the *note
ipaddress: a2. module.  It is aimed primarily at users that aren’t
already familiar with IP networking terminology, but may also be useful
to network engineers wanting an overview of how *note ipaddress: a2.
represents IP network addressing concepts.

* Menu:

* Creating Address/Network/Interface objects::
* Inspecting Address/Network/Interface Objects::
* Networks as lists of Addresses::
* Comparisons: Comparisons<4>.
* Using IP Addresses with other modules::
* Getting more detail when instance creation fails::


File: python.info,  Node: Creating Address/Network/Interface objects,  Next: Inspecting Address/Network/Interface Objects,  Up: An introduction to the ipaddress module

10.14.1 Creating Address/Network/Interface objects
--------------------------------------------------

Since *note ipaddress: a2. is a module for inspecting and manipulating
IP addresses, the first thing you’ll want to do is create some objects.
You can use *note ipaddress: a2. to create objects from strings and
integers.

* Menu:

* A Note on IP Versions::
* IP Host Addresses::
* Defining Networks::
* Host Interfaces::


File: python.info,  Node: A Note on IP Versions,  Next: IP Host Addresses,  Up: Creating Address/Network/Interface objects

10.14.1.1 A Note on IP Versions
...............................

For readers that aren’t particularly familiar with IP addressing, it’s
important to know that the Internet Protocol is currently in the process
of moving from version 4 of the protocol to version 6.  This transition
is occurring largely because version 4 of the protocol doesn’t provide
enough addresses to handle the needs of the whole world, especially
given the increasing number of devices with direct connections to the
internet.

Explaining the details of the differences between the two versions of
the protocol is beyond the scope of this introduction, but readers need
to at least be aware that these two versions exist, and it will
sometimes be necessary to force the use of one version or the other.


File: python.info,  Node: IP Host Addresses,  Next: Defining Networks,  Prev: A Note on IP Versions,  Up: Creating Address/Network/Interface objects

10.14.1.2 IP Host Addresses
...........................

Addresses, often referred to as “host addresses” are the most basic unit
when working with IP addressing.  The simplest way to create addresses
is to use the *note ipaddress.ip_address(): 2e41. factory function,
which automatically determines whether to create an IPv4 or IPv6 address
based on the passed in value:

     >>> ipaddress.ip_address('192.0.2.1') IPv4Address('192.0.2.1') >>> ipaddress.ip_address('2001:DB8::1') IPv6Address('2001:db8::1')

Addresses can also be created directly from integers.  Values that will
fit within 32 bits are assumed to be IPv4 addresses:

     >>> ipaddress.ip_address(3221225985) IPv4Address('192.0.2.1') >>> ipaddress.ip_address(42540766411282592856903984951653826561) IPv6Address('2001:db8::1')

To force the use of IPv4 or IPv6 addresses, the relevant classes can be
invoked directly.  This is particularly useful to force creation of IPv6
addresses for small integers:

     >>> ipaddress.ip_address(1) IPv4Address('0.0.0.1') >>> ipaddress.IPv4Address(1) IPv4Address('0.0.0.1') >>> ipaddress.IPv6Address(1) IPv6Address('::1')


File: python.info,  Node: Defining Networks,  Next: Host Interfaces,  Prev: IP Host Addresses,  Up: Creating Address/Network/Interface objects

10.14.1.3 Defining Networks
...........................

Host addresses are usually grouped together into IP networks, so *note
ipaddress: a2. provides a way to create, inspect and manipulate network
definitions.  IP network objects are constructed from strings that
define the range of host addresses that are part of that network.  The
simplest form for that information is a “network address/network prefix”
pair, where the prefix defines the number of leading bits that are
compared to determine whether or not an address is part of the network
and the network address defines the expected value of those bits.

As for addresses, a factory function is provided that determines the
correct IP version automatically:

     >>> ipaddress.ip_network('192.0.2.0/24') IPv4Network('192.0.2.0/24') >>> ipaddress.ip_network('2001:db8::0/96') IPv6Network('2001:db8::/96')

Network objects cannot have any host bits set.  The practical effect of
this is that ‘192.0.2.1/24’ does not describe a network.  Such
definitions are referred to as interface objects since the
ip-on-a-network notation is commonly used to describe network interfaces
of a computer on a given network and are described further in the next
section.

By default, attempting to create a network object with host bits set
will result in *note ValueError: 1f9. being raised.  To request that the
additional bits instead be coerced to zero, the flag ‘strict=False’ can
be passed to the constructor:

     >>> ipaddress.ip_network('192.0.2.1/24') Traceback (most recent call last):    ... ValueError: 192.0.2.1/24 has host bits set >>> ipaddress.ip_network('192.0.2.1/24', strict=False) IPv4Network('192.0.2.0/24')

While the string form offers significantly more flexibility, networks
can also be defined with integers, just like host addresses.  In this
case, the network is considered to contain only the single address
identified by the integer, so the network prefix includes the entire
network address:

     >>> ipaddress.ip_network(3221225984) IPv4Network('192.0.2.0/32') >>> ipaddress.ip_network(42540766411282592856903984951653826560) IPv6Network('2001:db8::/128')

As with addresses, creation of a particular kind of network can be
forced by calling the class constructor directly instead of using the
factory function.


File: python.info,  Node: Host Interfaces,  Prev: Defining Networks,  Up: Creating Address/Network/Interface objects

10.14.1.4 Host Interfaces
.........................

As mentioned just above, if you need to describe an address on a
particular network, neither the address nor the network classes are
sufficient.  Notation like ‘192.0.2.1/24’ is commonly used by network
engineers and the people who write tools for firewalls and routers as
shorthand for “the host ‘192.0.2.1’ on the network ‘192.0.2.0/24’”,
Accordingly, *note ipaddress: a2. provides a set of hybrid classes that
associate an address with a particular network.  The interface for
creation is identical to that for defining network objects, except that
the address portion isn’t constrained to being a network address.

     >>> ipaddress.ip_interface('192.0.2.1/24') IPv4Interface('192.0.2.1/24') >>> ipaddress.ip_interface('2001:db8::1/96') IPv6Interface('2001:db8::1/96')

Integer inputs are accepted (as with networks), and use of a particular
IP version can be forced by calling the relevant constructor directly.


File: python.info,  Node: Inspecting Address/Network/Interface Objects,  Next: Networks as lists of Addresses,  Prev: Creating Address/Network/Interface objects,  Up: An introduction to the ipaddress module

10.14.2 Inspecting Address/Network/Interface Objects
----------------------------------------------------

You’ve gone to the trouble of creating an
IPv(4|6)(Address|Network|Interface) object, so you probably want to get
information about it.  *note ipaddress: a2. tries to make doing this
easy and intuitive.

Extracting the IP version:

     >>> addr4 = ipaddress.ip_address('192.0.2.1') >>> addr6 = ipaddress.ip_address('2001:db8::1') >>> addr6.version 6 >>> addr4.version 4

Obtaining the network from an interface:

     >>> host4 = ipaddress.ip_interface('192.0.2.1/24') >>> host4.network IPv4Network('192.0.2.0/24') >>> host6 = ipaddress.ip_interface('2001:db8::1/96') >>> host6.network IPv6Network('2001:db8::/96')

Finding out how many individual addresses are in a network:

     >>> net4 = ipaddress.ip_network('192.0.2.0/24') >>> net4.num_addresses 256 >>> net6 = ipaddress.ip_network('2001:db8::0/96') >>> net6.num_addresses 4294967296

Iterating through the “usable” addresses on a network:

     >>> net4 = ipaddress.ip_network('192.0.2.0/24') >>> for x in net4.hosts(): ...     print(x)   192.0.2.1 192.0.2.2 192.0.2.3 192.0.2.4 ... 192.0.2.252 192.0.2.253 192.0.2.254

Obtaining the netmask (i.e.  set bits corresponding to the network
prefix) or the hostmask (any bits that are not part of the netmask):

     >>> net4 = ipaddress.ip_network('192.0.2.0/24') >>> net4.netmask IPv4Address('255.255.255.0') >>> net4.hostmask IPv4Address('0.0.0.255') >>> net6 = ipaddress.ip_network('2001:db8::0/96') >>> net6.netmask IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::') >>> net6.hostmask IPv6Address('::ffff:ffff')

Exploding or compressing the address:

     >>> addr6.exploded '2001:0db8:0000:0000:0000:0000:0000:0001' >>> addr6.compressed '2001:db8::1' >>> net6.exploded '2001:0db8:0000:0000:0000:0000:0000:0000/96' >>> net6.compressed '2001:db8::/96'

While IPv4 doesn’t support explosion or compression, the associated
objects still provide the relevant properties so that version neutral
code can easily ensure the most concise or most verbose form is used for
IPv6 addresses while still correctly handling IPv4 addresses.


File: python.info,  Node: Networks as lists of Addresses,  Next: Comparisons<4>,  Prev: Inspecting Address/Network/Interface Objects,  Up: An introduction to the ipaddress module

10.14.3 Networks as lists of Addresses
--------------------------------------

It’s sometimes useful to treat networks as lists.  This means it is
possible to index them like this:

     >>> net4[1] IPv4Address('192.0.2.1') >>> net4[-1] IPv4Address('192.0.2.255') >>> net6[1] IPv6Address('2001:db8::1') >>> net6[-1] IPv6Address('2001:db8::ffff:ffff')

It also means that network objects lend themselves to using the list
membership test syntax like this:

     if address in network:     # do something

Containment testing is done efficiently based on the network prefix:

     >>> addr4 = ipaddress.ip_address('192.0.2.1') >>> addr4 in ipaddress.ip_network('192.0.2.0/24') True >>> addr4 in ipaddress.ip_network('192.0.3.0/24') False


File: python.info,  Node: Comparisons<4>,  Next: Using IP Addresses with other modules,  Prev: Networks as lists of Addresses,  Up: An introduction to the ipaddress module

10.14.4 Comparisons
-------------------

*note ipaddress: a2. provides some simple, hopefully intuitive ways to
compare objects, where it makes sense:

     >>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2') True

A *note TypeError: 192. exception is raised if you try to compare
objects of different versions or different types.


File: python.info,  Node: Using IP Addresses with other modules,  Next: Getting more detail when instance creation fails,  Prev: Comparisons<4>,  Up: An introduction to the ipaddress module

10.14.5 Using IP Addresses with other modules
---------------------------------------------

Other modules that use IP addresses (such as *note socket: ef.) usually
won’t accept objects from this module directly.  Instead, they must be
coerced to an integer or string that the other module will accept:

     >>> addr4 = ipaddress.ip_address('192.0.2.1') >>> str(addr4) '192.0.2.1' >>> int(addr4) 3221225985


File: python.info,  Node: Getting more detail when instance creation fails,  Prev: Using IP Addresses with other modules,  Up: An introduction to the ipaddress module

10.14.6 Getting more detail when instance creation fails
--------------------------------------------------------

When creating address/network/interface objects using the
version-agnostic factory functions, any errors will be reported as *note
ValueError: 1f9. with a generic error message that simply says the
passed in value was not recognized as an object of that type.  The lack
of a specific error is because it’s necessary to know whether the value
is `supposed' to be IPv4 or IPv6 in order to provide more detail on why
it has been rejected.

To support use cases where it is useful to have access to this
additional detail, the individual class constructors actually raise the
*note ValueError: 1f9. subclasses *note ipaddress.AddressValueError:
2e4a. and *note ipaddress.NetmaskValueError: 2e6f. to indicate exactly
which part of the definition failed to parse correctly.

The error messages are significantly more detailed when using the class
constructors directly.  For example:

     >>> ipaddress.ip_address("192.168.0.256") Traceback (most recent call last):   ... ValueError: '192.168.0.256' does not appear to be an IPv4 or IPv6 address >>> ipaddress.IPv4Address("192.168.0.256") Traceback (most recent call last):   ... ipaddress.AddressValueError: Octet 256 (> 255) not permitted in '192.168.0.256'  >>> ipaddress.ip_network("192.168.0.1/64") Traceback (most recent call last):   ... ValueError: '192.168.0.1/64' does not appear to be an IPv4 or IPv6 network >>> ipaddress.IPv4Network("192.168.0.1/64") Traceback (most recent call last):   ... ipaddress.NetmaskValueError: '64' is not a valid netmask

However, both of the module specific exceptions have *note ValueError:
1f9. as their parent class, so if you’re not concerned with the
particular type of error, you can still write code like the following:

     try:     network = ipaddress.IPv4Network(address) except ValueError:     print('address/netmask is invalid for IPv4:', address)


File: python.info,  Node: Argument Clinic How-To,  Next: Instrumenting CPython with DTrace and SystemTap,  Prev: An introduction to the ipaddress module,  Up: Python HOWTOs

10.15 Argument Clinic How-To
============================


author: Larry Hastings

Abstract
........

Argument Clinic is a preprocessor for CPython C files.  Its purpose is
to automate all the boilerplate involved with writing argument parsing
code for “builtins”.  This document shows you how to convert your first
C function to work with Argument Clinic, and then introduces some
advanced topics on Argument Clinic usage.

Currently Argument Clinic is considered internal-only for CPython.  Its
use is not supported for files outside CPython, and no guarantees are
made regarding backwards compatibility for future versions.  In other
words: if you maintain an external C extension for CPython, you’re
welcome to experiment with Argument Clinic in your own code.  But the
version of Argument Clinic that ships with the next version of CPython
`could' be totally incompatible and break all your code.

* Menu:

* The Goals Of Argument Clinic::
* Basic Concepts And Usage::
* Converting Your First Function::
* Advanced Topics::


File: python.info,  Node: The Goals Of Argument Clinic,  Next: Basic Concepts And Usage,  Up: Argument Clinic How-To

10.15.1 The Goals Of Argument Clinic
------------------------------------

Argument Clinic’s primary goal is to take over responsibility for all
argument parsing code inside CPython.  This means that, when you convert
a function to work with Argument Clinic, that function should no longer
do any of its own argument parsing—the code generated by Argument Clinic
should be a “black box” to you, where CPython calls in at the top, and
your code gets called at the bottom, with ‘PyObject *args’ (and maybe
‘PyObject *kwargs’) magically converted into the C variables and types
you need.

In order for Argument Clinic to accomplish its primary goal, it must be
easy to use.  Currently, working with CPython’s argument parsing library
is a chore, requiring maintaining redundant information in a surprising
number of places.  When you use Argument Clinic, you don’t have to
repeat yourself.

Obviously, no one would want to use Argument Clinic unless it’s solving
their problem—and without creating new problems of its own.  So it’s
paramount that Argument Clinic generate correct code.  It’d be nice if
the code was faster, too, but at the very least it should not introduce
a major speed regression.  (Eventually Argument Clinic `should' make a
major speedup possible—we could rewrite its code generator to produce
tailor-made argument parsing code, rather than calling the
general-purpose CPython argument parsing library.  That would make for
the fastest argument parsing possible!)

Additionally, Argument Clinic must be flexible enough to work with any
approach to argument parsing.  Python has some functions with some very
strange parsing behaviors; Argument Clinic’s goal is to support all of
them.

Finally, the original motivation for Argument Clinic was to provide
introspection “signatures” for CPython builtins.  It used to be, the
introspection query functions would throw an exception if you passed in
a builtin.  With Argument Clinic, that’s a thing of the past!

One idea you should keep in mind, as you work with Argument Clinic: the
more information you give it, the better job it’ll be able to do.
Argument Clinic is admittedly relatively simple right now.  But as it
evolves it will get more sophisticated, and it should be able to do many
interesting and smart things with all the information you give it.


File: python.info,  Node: Basic Concepts And Usage,  Next: Converting Your First Function,  Prev: The Goals Of Argument Clinic,  Up: Argument Clinic How-To

10.15.2 Basic Concepts And Usage
--------------------------------

Argument Clinic ships with CPython; you’ll find it in
‘Tools/clinic/clinic.py’.  If you run that script, specifying a C file
as an argument:

     $ python3 Tools/clinic/clinic.py foo.c

Argument Clinic will scan over the file looking for lines that look
exactly like this:

     /*[clinic input]

When it finds one, it reads everything up to a line that looks exactly
like this:

     [clinic start generated code]*/

Everything in between these two lines is input for Argument Clinic.  All
of these lines, including the beginning and ending comment lines, are
collectively called an Argument Clinic “block”.

When Argument Clinic parses one of these blocks, it generates output.
This output is rewritten into the C file immediately after the block,
followed by a comment containing a checksum.  The Argument Clinic block
now looks like this:

     /*[clinic input] ... clinic input goes here ... [clinic start generated code]*/ ... clinic output goes here ... /*[clinic end generated code: checksum=...]*/

If you run Argument Clinic on the same file a second time, Argument
Clinic will discard the old output and write out the new output with a
fresh checksum line.  However, if the input hasn’t changed, the output
won’t change either.

You should never modify the output portion of an Argument Clinic block.
Instead, change the input until it produces the output you want.
(That’s the purpose of the checksum—to detect if someone changed the
output, as these edits would be lost the next time Argument Clinic
writes out fresh output.)

For the sake of clarity, here’s the terminology we’ll use with Argument
Clinic:

   * The first line of the comment (‘/*[clinic input]’) is the `start
     line'.

   * The last line of the initial comment (‘[clinic start generated
     code]*/’) is the `end line'.

   * The last line (‘/*[clinic end generated code: checksum=...]*/’) is
     the `checksum line'.

   * In between the start line and the end line is the `input'.

   * In between the end line and the checksum line is the `output'.

   * All the text collectively, from the start line to the checksum line
     inclusively, is the `block'.  (A block that hasn’t been
     successfully processed by Argument Clinic yet doesn’t have output
     or a checksum line, but it’s still considered a block.)


File: python.info,  Node: Converting Your First Function,  Next: Advanced Topics,  Prev: Basic Concepts And Usage,  Up: Argument Clinic How-To

10.15.3 Converting Your First Function
--------------------------------------

The best way to get a sense of how Argument Clinic works is to convert a
function to work with it.  Here, then, are the bare minimum steps you’d
need to follow to convert a function to work with Argument Clinic.  Note
that for code you plan to check in to CPython, you really should take
the conversion farther, using some of the advanced concepts you’ll see
later on in the document (like “return converters” and “self
converters”).  But we’ll keep it simple for this walkthrough so you can
learn.

Let’s dive in!

  0. Make sure you’re working with a freshly updated checkout of the
     CPython trunk.

  1. Find a Python builtin that calls either *note PyArg_ParseTuple():
     268. or *note PyArg_ParseTupleAndKeywords(): 5bf, and hasn’t been
     converted to work with Argument Clinic yet.  For my example I’m
     using ‘_pickle.Pickler.dump()’.

  2. If the call to the ‘PyArg_Parse’ function uses any of the following
     format units:

          O& O! es es# et et#

     or if it has multiple calls to *note PyArg_ParseTuple(): 268, you
     should choose a different function.  Argument Clinic `does' support
     all of these scenarios.  But these are advanced topics—let’s do
     something simpler for your first function.

     Also, if the function has multiple calls to *note
     PyArg_ParseTuple(): 268. or *note PyArg_ParseTupleAndKeywords():
     5bf. where it supports different types for the same argument, or if
     the function uses something besides PyArg_Parse functions to parse
     its arguments, it probably isn’t suitable for conversion to
     Argument Clinic.  Argument Clinic doesn’t support generic functions
     or polymorphic parameters.

  3. Add the following boilerplate above the function, creating our
     block:

          /*[clinic input] [clinic start generated code]*/

  4. Cut the docstring and paste it in between the ‘[clinic]’ lines,
     removing all the junk that makes it a properly quoted C string.
     When you’re done you should have just the text, based at the left
     margin, with no line wider than 80 characters.  (Argument Clinic
     will preserve indents inside the docstring.)

     If the old docstring had a first line that looked like a function
     signature, throw that line away.  (The docstring doesn’t need it
     anymore—when you use ‘help()’ on your builtin in the future, the
     first line will be built automatically based on the function’s
     signature.)

     Sample:

          /*[clinic input] Write a pickled representation of obj to the open file. [clinic start generated code]*/

  5. If your docstring doesn’t have a “summary” line, Argument Clinic
     will complain.  So let’s make sure it has one.  The “summary” line
     should be a paragraph consisting of a single 80-column line at the
     beginning of the docstring.

     (Our example docstring consists solely of a summary line, so the
     sample code doesn’t have to change for this step.)

  6. Above the docstring, enter the name of the function, followed by a
     blank line.  This should be the Python name of the function, and
     should be the full dotted path to the function—it should start with
     the name of the module, include any sub-modules, and if the
     function is a method on a class it should include the class name
     too.

     Sample:

          /*[clinic input] _pickle.Pickler.dump  Write a pickled representation of obj to the open file. [clinic start generated code]*/

  7. If this is the first time that module or class has been used with
     Argument Clinic in this C file, you must declare the module and/or
     class.  Proper Argument Clinic hygiene prefers declaring these in a
     separate block somewhere near the top of the C file, in the same
     way that include files and statics go at the top.  (In our sample
     code we’ll just show the two blocks next to each other.)

     The name of the class and module should be the same as the one seen
     by Python.  Check the name defined in the *note PyModuleDef: 3a8c.
     or *note PyTypeObject: 2d4. as appropriate.

     When you declare a class, you must also specify two aspects of its
     type in C: the type declaration you’d use for a pointer to an
     instance of this class, and a pointer to the *note PyTypeObject:
     2d4. for this class.

     Sample:

          /*[clinic input] module _pickle class _pickle.Pickler "PicklerObject *" "&Pickler_Type" [clinic start generated code]*/  /*[clinic input] _pickle.Pickler.dump  Write a pickled representation of obj to the open file. [clinic start generated code]*/

  8. Declare each of the parameters to the function.  Each parameter
     should get its own line.  All the parameter lines should be
     indented from the function name and the docstring.

     The general form of these parameter lines is as follows:

          name_of_parameter: converter

     If the parameter has a default value, add that after the converter:

          name_of_parameter: converter = default_value

     Argument Clinic’s support for “default values” is quite
     sophisticated; please see *note the section below on default
     values: 4152. for more information.

     Add a blank line below the parameters.

     What’s a “converter”?  It establishes both the type of the variable
     used in C, and the method to convert the Python value into a C
     value at runtime.  For now you’re going to use what’s called a
     “legacy converter”—a convenience syntax intended to make porting
     old code into Argument Clinic easier.

     For each parameter, copy the “format unit” for that parameter from
     the ‘PyArg_Parse()’ format argument and specify `that' as its
     converter, as a quoted string.  (“format unit” is the formal name
     for the one-to-three character substring of the ‘format’ parameter
     that tells the argument parsing function what the type of the
     variable is and how to convert it.  For more on format units please
     see *note Parsing arguments and building values: 2ce.)

     For multicharacter format units like ‘z#’, use the entire
     two-or-three character string.

     Sample:

           /*[clinic input]  module _pickle  class _pickle.Pickler "PicklerObject *" "&Pickler_Type"  [clinic start generated code]*/   /*[clinic input]  _pickle.Pickler.dump      obj: 'O'  Write a pickled representation of obj to the open file. [clinic start generated code]*/

  9. If your function has ‘|’ in the format string, meaning some
     parameters have default values, you can ignore it.  Argument Clinic
     infers which parameters are optional based on whether or not they
     have default values.

     If your function has ‘$’ in the format string, meaning it takes
     keyword-only arguments, specify ‘*’ on a line by itself before the
     first keyword-only argument, indented the same as the parameter
     lines.

     (‘_pickle.Pickler.dump’ has neither, so our sample is unchanged.)

  10. If the existing C function calls *note PyArg_ParseTuple(): 268.
     (as opposed to *note PyArg_ParseTupleAndKeywords(): 5bf.), then all
     its arguments are positional-only.

     To mark all parameters as positional-only in Argument Clinic, add a
     ‘/’ on a line by itself after the last parameter, indented the same
     as the parameter lines.

     Currently this is all-or-nothing; either all parameters are
     positional-only, or none of them are.  (In the future Argument
     Clinic may relax this restriction.)

     Sample:

          /*[clinic input] module _pickle class _pickle.Pickler "PicklerObject *" "&Pickler_Type" [clinic start generated code]*/  /*[clinic input] _pickle.Pickler.dump      obj: 'O'     /  Write a pickled representation of obj to the open file. [clinic start generated code]*/

  11. It’s helpful to write a per-parameter docstring for each
     parameter.  But per-parameter docstrings are optional; you can skip
     this step if you prefer.

     Here’s how to add a per-parameter docstring.  The first line of the
     per-parameter docstring must be indented further than the parameter
     definition.  The left margin of this first line establishes the
     left margin for the whole per-parameter docstring; all the text you
     write will be outdented by this amount.  You can write as much text
     as you like, across multiple lines if you wish.

     Sample:

          /*[clinic input] module _pickle class _pickle.Pickler "PicklerObject *" "&Pickler_Type" [clinic start generated code]*/  /*[clinic input] _pickle.Pickler.dump      obj: 'O'         The object to be pickled.     /  Write a pickled representation of obj to the open file. [clinic start generated code]*/

  12. Save and close the file, then run ‘Tools/clinic/clinic.py’ on it.
     With luck everything worked—your block now has output, and a ‘.c.h’
     file has been generated!  Reopen the file in your text editor to
     see:

          /*[clinic input] _pickle.Pickler.dump      obj: 'O'         The object to be pickled.     /  Write a pickled representation of obj to the open file. [clinic start generated code]*/  static PyObject * _pickle_Pickler_dump(PicklerObject *self, PyObject *obj) /*[clinic end generated code: output=87ecad1261e02ac7 input=552eb1c0f52260d9]*/

     Obviously, if Argument Clinic didn’t produce any output, it’s
     because it found an error in your input.  Keep fixing your errors
     and retrying until Argument Clinic processes your file without
     complaint.

     For readability, most of the glue code has been generated to a
     ‘.c.h’ file.  You’ll need to include that in your original ‘.c’
     file, typically right after the clinic module block:

          #include "clinic/_pickle.c.h"

  13. Double-check that the argument-parsing code Argument Clinic
     generated looks basically the same as the existing code.

     First, ensure both places use the same argument-parsing function.
     The existing code must call either *note PyArg_ParseTuple(): 268.
     or *note PyArg_ParseTupleAndKeywords(): 5bf.; ensure that the code
     generated by Argument Clinic calls the `exact' same function.

     Second, the format string passed in to *note PyArg_ParseTuple():
     268. or *note PyArg_ParseTupleAndKeywords(): 5bf. should be
     `exactly' the same as the hand-written one in the existing
     function, up to the colon or semi-colon.

     (Argument Clinic always generates its format strings with a ‘:’
     followed by the name of the function.  If the existing code’s
     format string ends with ‘;’, to provide usage help, this change is
     harmless—don’t worry about it.)

     Third, for parameters whose format units require two arguments
     (like a length variable, or an encoding string, or a pointer to a
     conversion function), ensure that the second argument is `exactly'
     the same between the two invocations.

     Fourth, inside the output portion of the block you’ll find a
     preprocessor macro defining the appropriate static *note
     PyMethodDef: e0e. structure for this builtin:

          #define __PICKLE_PICKLER_DUMP_METHODDEF    \ {"dump", (PyCFunction)__pickle_Pickler_dump, METH_O, __pickle_Pickler_dump__doc__},

     This static structure should be `exactly' the same as the existing
     static *note PyMethodDef: e0e. structure for this builtin.

     If any of these items differ in `any way', adjust your Argument
     Clinic function specification and rerun ‘Tools/clinic/clinic.py’
     until they `are' the same.

  14. Notice that the last line of its output is the declaration of your
     “impl” function.  This is where the builtin’s implementation goes.
     Delete the existing prototype of the function you’re modifying, but
     leave the opening curly brace.  Now delete its argument parsing
     code and the declarations of all the variables it dumps the
     arguments into.  Notice how the Python arguments are now arguments
     to this impl function; if the implementation used different names
     for these variables, fix it.

     Let’s reiterate, just because it’s kind of weird.  Your code should
     now look like this:

          static return_type your_function_impl(...) /*[clinic end generated code: checksum=...]*/ { ...

     Argument Clinic generated the checksum line and the function
     prototype just above it.  You should write the opening (and
     closing) curly braces for the function, and the implementation
     inside.

     Sample:

          /*[clinic input] module _pickle class _pickle.Pickler "PicklerObject *" "&Pickler_Type" [clinic start generated code]*/ /*[clinic end generated code: checksum=da39a3ee5e6b4b0d3255bfef95601890afd80709]*/  /*[clinic input] _pickle.Pickler.dump      obj: 'O'         The object to be pickled.     /  Write a pickled representation of obj to the open file. [clinic start generated code]*/  PyDoc_STRVAR(__pickle_Pickler_dump__doc__, "Write a pickled representation of obj to the open file.\n" "\n" ... static PyObject * _pickle_Pickler_dump_impl(PicklerObject *self, PyObject *obj) /*[clinic end generated code: checksum=3bd30745bf206a48f8b576a1da3d90f55a0a4187]*/ {     /* Check whether the Pickler was initialized correctly (issue3664).        Developers often forget to call __init__() in their subclasses, which        would trigger a segfault without this check. */     if (self->write == NULL) {         PyErr_Format(PicklingError,                      "Pickler.__init__() was not called by %s.__init__()",                      Py_TYPE(self)->tp_name);         return NULL;     }      if (_Pickler_ClearBuffer(self) < 0)         return NULL;      ...

  15. Remember the macro with the *note PyMethodDef: e0e. structure for
     this function?  Find the existing *note PyMethodDef: e0e. structure
     for this function and replace it with a reference to the macro.
     (If the builtin is at module scope, this will probably be very near
     the end of the file; if the builtin is a class method, this will
     probably be below but relatively near to the implementation.)

     Note that the body of the macro contains a trailing comma.  So when
     you replace the existing static *note PyMethodDef: e0e. structure
     with the macro, `don’t' add a comma to the end.

     Sample:

          static struct PyMethodDef Pickler_methods[] = {     __PICKLE_PICKLER_DUMP_METHODDEF     __PICKLE_PICKLER_CLEAR_MEMO_METHODDEF     {NULL, NULL}                /* sentinel */ };

  16. Compile, then run the relevant portions of the regression-test
     suite.  This change should not introduce any new compile-time
     warnings or errors, and there should be no externally-visible
     change to Python’s behavior.

     Well, except for one difference: ‘inspect.signature()’ run on your
     function should now provide a valid signature!

     Congratulations, you’ve ported your first function to work with
     Argument Clinic!


File: python.info,  Node: Advanced Topics,  Prev: Converting Your First Function,  Up: Argument Clinic How-To

10.15.4 Advanced Topics
-----------------------

Now that you’ve had some experience working with Argument Clinic, it’s
time for some advanced topics.

* Menu:

* Symbolic default values::
* Renaming the C functions and variables generated by Argument Clinic::
* Converting functions using PyArg_UnpackTuple::
* Optional Groups::
* Using real Argument Clinic converters, instead of “legacy converters”: Using real Argument Clinic converters instead of “legacy converters”.
* Py_buffer::
* Advanced converters::
* Parameter default values::
* The NULL default value::
* Expressions specified as default values::
* Using a return converter::
* Cloning existing functions::
* Calling Python code::
* Using a “self converter”::
* Writing a custom converter::
* Writing a custom return converter::
* METH_O and METH_NOARGS::
* tp_new and tp_init functions::
* Changing and redirecting Clinic’s output::
* The #ifdef trick::
* Using Argument Clinic in Python files::


File: python.info,  Node: Symbolic default values,  Next: Renaming the C functions and variables generated by Argument Clinic,  Up: Advanced Topics

10.15.4.1 Symbolic default values
.................................

The default value you provide for a parameter can’t be any arbitrary
expression.  Currently the following are explicitly supported:

   * Numeric constants (integer and float)

   * String constants

   * ‘True’, ‘False’, and ‘None’

   * Simple symbolic constants like ‘sys.maxsize’, which must start with
     the name of the module

In case you’re curious, this is implemented in ‘from_builtin()’ in
‘Lib/inspect.py’.

(In the future, this may need to get even more elaborate, to allow full
expressions like ‘CONSTANT - 1’.)


File: python.info,  Node: Renaming the C functions and variables generated by Argument Clinic,  Next: Converting functions using PyArg_UnpackTuple,  Prev: Symbolic default values,  Up: Advanced Topics

10.15.4.2 Renaming the C functions and variables generated by Argument Clinic
.............................................................................

Argument Clinic automatically names the functions it generates for you.
Occasionally this may cause a problem, if the generated name collides
with the name of an existing C function.  There’s an easy solution:
override the names used for the C functions.  Just add the keyword
‘"as"’ to your function declaration line, followed by the function name
you wish to use.  Argument Clinic will use that function name for the
base (generated) function, then add ‘"_impl"’ to the end and use that
for the name of the impl function.

For example, if we wanted to rename the C function names generated for
‘pickle.Pickler.dump’, it’d look like this:

     /*[clinic input] pickle.Pickler.dump as pickler_dumper  ...

The base function would now be named ‘pickler_dumper()’, and the impl
function would now be named ‘pickler_dumper_impl()’.

Similarly, you may have a problem where you want to give a parameter a
specific Python name, but that name may be inconvenient in C. Argument
Clinic allows you to give a parameter different names in Python and in
C, using the same ‘"as"’ syntax:

     /*[clinic input] pickle.Pickler.dump      obj: object     file as file_obj: object     protocol: object = NULL     *     fix_imports: bool = True

Here, the name used in Python (in the signature and the ‘keywords’
array) would be ‘file’, but the C variable would be named ‘file_obj’.

You can use this to rename the ‘self’ parameter too!


File: python.info,  Node: Converting functions using PyArg_UnpackTuple,  Next: Optional Groups,  Prev: Renaming the C functions and variables generated by Argument Clinic,  Up: Advanced Topics

10.15.4.3 Converting functions using PyArg_UnpackTuple
......................................................

To convert a function parsing its arguments with *note
PyArg_UnpackTuple(): e39, simply write out all the arguments, specifying
each as an ‘object’.  You may specify the ‘type’ argument to cast the
type as appropriate.  All arguments should be marked positional-only
(add a ‘/’ on a line by itself after the last argument).

Currently the generated code will use *note PyArg_ParseTuple(): 268, but
this will change soon.


File: python.info,  Node: Optional Groups,  Next: Using real Argument Clinic converters instead of “legacy converters”,  Prev: Converting functions using PyArg_UnpackTuple,  Up: Advanced Topics

10.15.4.4 Optional Groups
.........................

Some legacy functions have a tricky approach to parsing their arguments:
they count the number of positional arguments, then use a ‘switch’
statement to call one of several different *note PyArg_ParseTuple():
268. calls depending on how many positional arguments there are.  (These
functions cannot accept keyword-only arguments.)  This approach was used
to simulate optional arguments back before *note
PyArg_ParseTupleAndKeywords(): 5bf. was created.

While functions using this approach can often be converted to use *note
PyArg_ParseTupleAndKeywords(): 5bf, optional arguments, and default
values, it’s not always possible.  Some of these legacy functions have
behaviors *note PyArg_ParseTupleAndKeywords(): 5bf. doesn’t directly
support.  The most obvious example is the builtin function ‘range()’,
which has an optional argument on the `left' side of its required
argument!  Another example is ‘curses.window.addch()’, which has a group
of two arguments that must always be specified together.  (The arguments
are called ‘x’ and ‘y’; if you call the function passing in ‘x’, you
must also pass in ‘y’—and if you don’t pass in ‘x’ you may not pass in
‘y’ either.)

In any case, the goal of Argument Clinic is to support argument parsing
for all existing CPython builtins without changing their semantics.
Therefore Argument Clinic supports this alternate approach to parsing,
using what are called `optional groups'.  Optional groups are groups of
arguments that must all be passed in together.  They can be to the left
or the right of the required arguments.  They can `only' be used with
positional-only parameters.

     Note: Optional groups are `only' intended for use when converting
     functions that make multiple calls to *note PyArg_ParseTuple():
     268.!  Functions that use `any' other approach for parsing
     arguments should `almost never' be converted to Argument Clinic
     using optional groups.  Functions using optional groups currently
     cannot have accurate signatures in Python, because Python just
     doesn’t understand the concept.  Please avoid using optional groups
     wherever possible.

To specify an optional group, add a ‘[’ on a line by itself before the
parameters you wish to group together, and a ‘]’ on a line by itself
after these parameters.  As an example, here’s how ‘curses.window.addch’
uses optional groups to make the first two parameters and the last
parameter optional:

     /*[clinic input]  curses.window.addch      [     x: int       X-coordinate.     y: int       Y-coordinate.     ]      ch: object       Character to add.      [     attr: long       Attributes for the character.     ]     /  ...

Notes:

   * For every optional group, one additional parameter will be passed
     into the impl function representing the group.  The parameter will
     be an int named ‘group_{direction}_{number}’, where ‘{direction}’
     is either ‘right’ or ‘left’ depending on whether the group is
     before or after the required parameters, and ‘{number}’ is a
     monotonically increasing number (starting at 1) indicating how far
     away the group is from the required parameters.  When the impl is
     called, this parameter will be set to zero if this group was
     unused, and set to non-zero if this group was used.  (By used or
     unused, I mean whether or not the parameters received arguments in
     this invocation.)

   * If there are no required arguments, the optional groups will behave
     as if they’re to the right of the required arguments.

   * In the case of ambiguity, the argument parsing code favors
     parameters on the left (before the required parameters).

   * Optional groups can only contain positional-only parameters.

   * Optional groups are `only' intended for legacy code.  Please do not
     use optional groups for new code.


File: python.info,  Node: Using real Argument Clinic converters instead of “legacy converters”,  Next: Py_buffer,  Prev: Optional Groups,  Up: Advanced Topics

10.15.4.5 Using real Argument Clinic converters, instead of “legacy converters”
...............................................................................

To save time, and to minimize how much you need to learn to achieve your
first port to Argument Clinic, the walkthrough above tells you to use
“legacy converters”.  “Legacy converters” are a convenience, designed
explicitly to make porting existing code to Argument Clinic easier.  And
to be clear, their use is acceptable when porting code for Python 3.4.

However, in the long term we probably want all our blocks to use
Argument Clinic’s real syntax for converters.  Why?  A couple reasons:

   * The proper converters are far easier to read and clearer in their
     intent.

   * There are some format units that are unsupported as “legacy
     converters”, because they require arguments, and the legacy
     converter syntax doesn’t support specifying arguments.

   * In the future we may have a new argument parsing library that isn’t
     restricted to what *note PyArg_ParseTuple(): 268. supports; this
     flexibility won’t be available to parameters using legacy
     converters.

Therefore, if you don’t mind a little extra effort, please use the
normal converters instead of legacy converters.

In a nutshell, the syntax for Argument Clinic (non-legacy) converters
looks like a Python function call.  However, if there are no explicit
arguments to the function (all functions take their default values), you
may omit the parentheses.  Thus ‘bool’ and ‘bool()’ are exactly the same
converters.

All arguments to Argument Clinic converters are keyword-only.  All
Argument Clinic converters accept the following arguments:

     ‘c_default’

          The default value for this parameter when defined in C.
          Specifically, this will be the initializer for the variable
          declared in the “parse function”.  See *note the section on
          default values: 4152. for how to use this.  Specified as a
          string.

     ‘annotation’

          The annotation value for this parameter.  Not currently
          supported, because PEP 8(1) mandates that the Python library
          may not use annotations.

In addition, some converters accept additional arguments.  Here is a
list of these arguments, along with their meanings:

     ‘accept’

          A set of Python types (and possibly pseudo-types); this
          restricts the allowable Python argument to values of these
          types.  (This is not a general-purpose facility; as a rule it
          only supports specific lists of types as shown in the legacy
          converter table.)

          To accept ‘None’, add ‘NoneType’ to this set.

     ‘bitwise’

          Only supported for unsigned integers.  The native integer
          value of this Python argument will be written to the parameter
          without any range checking, even for negative values.

     ‘converter’

          Only supported by the ‘object’ converter.  Specifies the name
          of a *note C “converter function”: 3bc4. to use to convert
          this object to a native type.

     ‘encoding’

          Only supported for strings.  Specifies the encoding to use
          when converting this string from a Python str (Unicode) value
          into a C ‘char *’ value.

     ‘subclass_of’

          Only supported for the ‘object’ converter.  Requires that the
          Python value be a subclass of a Python type, as expressed in
          C.

     ‘type’

          Only supported for the ‘object’ and ‘self’ converters.
          Specifies the C type that will be used to declare the
          variable.  Default value is ‘"PyObject *"’.

     ‘zeroes’

          Only supported for strings.  If true, embedded NUL bytes
          (‘'\\0'’) are permitted inside the value.  The length of the
          string will be passed in to the impl function, just after the
          string parameter, as a parameter named
          ‘<parameter_name>_length’.

Please note, not every possible combination of arguments will work.
Usually these arguments are implemented by specific ‘PyArg_ParseTuple’
`format units', with specific behavior.  For example, currently you
cannot call ‘unsigned_short’ without also specifying ‘bitwise=True’.
Although it’s perfectly reasonable to think this would work, these
semantics don’t map to any existing format unit.  So Argument Clinic
doesn’t support it.  (Or, at least, not yet.)

Below is a table showing the mapping of legacy converters into real
Argument Clinic converters.  On the left is the legacy converter, on the
right is the text you’d replace it with.

‘'B'’         ‘unsigned_char(bitwise=True)’
              
              
‘'b'’         ‘unsigned_char’
              
              
‘'c'’         ‘char’
              
              
‘'C'’         ‘int(accept={str})’
              
              
‘'d'’         ‘double’
              
              
‘'D'’         ‘Py_complex’
              
              
‘'es'’        ‘str(encoding='name_of_encoding')’
              
              
‘'es#'’       ‘str(encoding='name_of_encoding', zeroes=True)’
              
              
‘'et'’        ‘str(encoding='name_of_encoding', accept={bytes, bytearray, str})’
              
              
‘'et#'’       ‘str(encoding='name_of_encoding', accept={bytes, bytearray, str}, zeroes=True)’
              
              
‘'f'’         ‘float’
              
              
‘'h'’         ‘short’
              
              
‘'H'’         ‘unsigned_short(bitwise=True)’
              
              
‘'i'’         ‘int’
              
              
‘'I'’         ‘unsigned_int(bitwise=True)’
              
              
‘'k'’         ‘unsigned_long(bitwise=True)’
              
              
‘'K'’         ‘unsigned_long_long(bitwise=True)’
              
              
‘'l'’         ‘long’
              
              
‘'L'’         ‘long long’
              
              
‘'n'’         ‘Py_ssize_t’
              
              
‘'O'’         ‘object’
              
              
‘'O!'’        ‘object(subclass_of='&PySomething_Type')’
              
              
‘'O&'’        ‘object(converter='name_of_c_function')’
              
              
‘'p'’         ‘bool’
              
              
‘'S'’         ‘PyBytesObject’
              
              
‘'s'’         ‘str’
              
              
‘'s#'’        ‘str(zeroes=True)’
              
              
‘'s*'’        ‘Py_buffer(accept={buffer, str})’
              
              
‘'U'’         ‘unicode’
              
              
‘'u'’         ‘Py_UNICODE’
              
              
‘'u#'’        ‘Py_UNICODE(zeroes=True)’
              
              
‘'w*'’        ‘Py_buffer(accept={rwbuffer})’
              
              
‘'Y'’         ‘PyByteArrayObject’
              
              
‘'y'’         ‘str(accept={bytes})’
              
              
‘'y#'’        ‘str(accept={robuffer}, zeroes=True)’
              
              
‘'y*'’        ‘Py_buffer’
              
              
‘'Z'’         ‘Py_UNICODE(accept={str, NoneType})’
              
              
‘'Z#'’        ‘Py_UNICODE(accept={str, NoneType}, zeroes=True)’
              
              
‘'z'’         ‘str(accept={str, NoneType})’
              
              
‘'z#'’        ‘str(accept={str, NoneType}, zeroes=True)’
              
              
‘'z*'’        ‘Py_buffer(accept={buffer, str, NoneType})’
              

As an example, here’s our sample ‘pickle.Pickler.dump’ using the proper
converter:

     /*[clinic input] pickle.Pickler.dump      obj: object         The object to be pickled.     /  Write a pickled representation of obj to the open file. [clinic start generated code]*/

One advantage of real converters is that they’re more flexible than
legacy converters.  For example, the ‘unsigned_int’ converter (and all
the ‘unsigned_’ converters) can be specified without ‘bitwise=True’.
Their default behavior performs range checking on the value, and they
won’t accept negative numbers.  You just can’t do that with a legacy
converter!

Argument Clinic will show you all the converters it has available.  For
each converter it’ll show you all the parameters it accepts, along with
the default value for each parameter.  Just run ‘Tools/clinic/clinic.py
--converters’ to see the full list.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0008


File: python.info,  Node: Py_buffer,  Next: Advanced converters,  Prev: Using real Argument Clinic converters instead of “legacy converters”,  Up: Advanced Topics

10.15.4.6 Py_buffer
...................

When using the ‘Py_buffer’ converter (or the ‘'s*'’, ‘'w*'’, ‘'*y'’, or
‘'z*'’ legacy converters), you `must' not call *note PyBuffer_Release():
d47. on the provided buffer.  Argument Clinic generates code that does
it for you (in the parsing function).


File: python.info,  Node: Advanced converters,  Next: Parameter default values,  Prev: Py_buffer,  Up: Advanced Topics

10.15.4.7 Advanced converters
.............................

Remember those format units you skipped for your first time because they
were advanced?  Here’s how to handle those too.

The trick is, all those format units take arguments—either conversion
functions, or types, or strings specifying an encoding.  (But “legacy
converters” don’t support arguments.  That’s why we skipped them for
your first function.)  The argument you specified to the format unit is
now an argument to the converter; this argument is either ‘converter’
(for ‘O&’), ‘subclass_of’ (for ‘O!’), or ‘encoding’ (for all the format
units that start with ‘e’).

When using ‘subclass_of’, you may also want to use the other custom
argument for ‘object()’: ‘type’, which lets you set the type actually
used for the parameter.  For example, if you want to ensure that the
object is a subclass of ‘PyUnicode_Type’, you probably want to use the
converter ‘object(type='PyUnicodeObject *',
subclass_of='&PyUnicode_Type')’.

One possible problem with using Argument Clinic: it takes away some
possible flexibility for the format units starting with ‘e’.  When
writing a ‘PyArg_Parse’ call by hand, you could theoretically decide at
runtime what encoding string to pass in to *note PyArg_ParseTuple():
268.  But now this string must be hard-coded at
Argument-Clinic-preprocessing-time.  This limitation is deliberate; it
made supporting this format unit much easier, and may allow for future
optimizations.  This restriction doesn’t seem unreasonable; CPython
itself always passes in static hard-coded encoding strings for
parameters whose format units start with ‘e’.


File: python.info,  Node: Parameter default values,  Next: The NULL default value,  Prev: Advanced converters,  Up: Advanced Topics

10.15.4.8 Parameter default values
..................................

Default values for parameters can be any of a number of values.  At
their simplest, they can be string, int, or float literals:

     foo: str = "abc" bar: int = 123 bat: float = 45.6

They can also use any of Python’s built-in constants:

     yep:  bool = True nope: bool = False nada: object = None

There’s also special support for a default value of ‘NULL’, and for
simple expressions, documented in the following sections.


File: python.info,  Node: The NULL default value,  Next: Expressions specified as default values,  Prev: Parameter default values,  Up: Advanced Topics

10.15.4.9 The ‘NULL’ default value
..................................

For string and object parameters, you can set them to ‘None’ to indicate
that there’s no default.  However, that means the C variable will be
initialized to ‘Py_None’.  For convenience’s sakes, there’s a special
value called ‘NULL’ for just this reason: from Python’s perspective it
behaves like a default value of ‘None’, but the C variable is
initialized with ‘NULL’.


File: python.info,  Node: Expressions specified as default values,  Next: Using a return converter,  Prev: The NULL default value,  Up: Advanced Topics

10.15.4.10 Expressions specified as default values
..................................................

The default value for a parameter can be more than just a literal value.
It can be an entire expression, using math operators and looking up
attributes on objects.  However, this support isn’t exactly simple,
because of some non-obvious semantics.

Consider the following example:

     foo: Py_ssize_t = sys.maxsize - 1

‘sys.maxsize’ can have different values on different platforms.
Therefore Argument Clinic can’t simply evaluate that expression locally
and hard-code it in C. So it stores the default in such a way that it
will get evaluated at runtime, when the user asks for the function’s
signature.

What namespace is available when the expression is evaluated?  It’s
evaluated in the context of the module the builtin came from.  So, if
your module has an attribute called “‘max_widgets’”, you may simply use
it:

     foo: Py_ssize_t = max_widgets

If the symbol isn’t found in the current module, it fails over to
looking in ‘sys.modules’.  That’s how it can find ‘sys.maxsize’ for
example.  (Since you don’t know in advance what modules the user will
load into their interpreter, it’s best to restrict yourself to modules
that are preloaded by Python itself.)

Evaluating default values only at runtime means Argument Clinic can’t
compute the correct equivalent C default value.  So you need to tell it
explicitly.  When you use an expression, you must also specify the
equivalent expression in C, using the ‘c_default’ parameter to the
converter:

     foo: Py_ssize_t(c_default="PY_SSIZE_T_MAX - 1") = sys.maxsize - 1

Another complication: Argument Clinic can’t know in advance whether or
not the expression you supply is valid.  It parses it to make sure it
looks legal, but it can’t `actually' know.  You must be very careful
when using expressions to specify values that are guaranteed to be valid
at runtime!

Finally, because expressions must be representable as static C values,
there are many restrictions on legal expressions.  Here’s a list of
Python features you’re not permitted to use:

   * Function calls.

   * Inline if statements (‘3 if foo else 5’).

   * Automatic sequence unpacking (‘*[1, 2, 3]’).

   * List/set/dict comprehensions and generator expressions.

   * Tuple/list/set/dict literals.


File: python.info,  Node: Using a return converter,  Next: Cloning existing functions,  Prev: Expressions specified as default values,  Up: Advanced Topics

10.15.4.11 Using a return converter
...................................

By default the impl function Argument Clinic generates for you returns
‘PyObject *’.  But your C function often computes some C type, then
converts it into the ‘PyObject *’ at the last moment.  Argument Clinic
handles converting your inputs from Python types into native C types—why
not have it convert your return value from a native C type into a Python
type too?

That’s what a “return converter” does.  It changes your impl function to
return some C type, then adds code to the generated (non-impl) function
to handle converting that value into the appropriate ‘PyObject *’.

The syntax for return converters is similar to that of parameter
converters.  You specify the return converter like it was a return
annotation on the function itself.  Return converters behave much the
same as parameter converters; they take arguments, the arguments are all
keyword-only, and if you’re not changing any of the default arguments
you can omit the parentheses.

(If you use both ‘"as"’ `and' a return converter for your function, the
‘"as"’ should come before the return converter.)

There’s one additional complication when using return converters: how do
you indicate an error has occurred?  Normally, a function returns a
valid (non-‘NULL’) pointer for success, and ‘NULL’ for failure.  But if
you use an integer return converter, all integers are valid.  How can
Argument Clinic detect an error?  Its solution: each return converter
implicitly looks for a special value that indicates an error.  If you
return that value, and an error has been set (‘PyErr_Occurred()’ returns
a true value), then the generated code will propagate the error.
Otherwise it will encode the value you return like normal.

Currently Argument Clinic supports only a few return converters:

     bool int unsigned int long unsigned int size_t Py_ssize_t float double DecodeFSDefault

None of these take parameters.  For the first three, return -1 to
indicate error.  For ‘DecodeFSDefault’, the return type is ‘const char
*’; return a ‘NULL’ pointer to indicate an error.

(There’s also an experimental ‘NoneType’ converter, which lets you
return ‘Py_None’ on success or ‘NULL’ on failure, without having to
increment the reference count on ‘Py_None’.  I’m not sure it adds enough
clarity to be worth using.)

To see all the return converters Argument Clinic supports, along with
their parameters (if any), just run ‘Tools/clinic/clinic.py
--converters’ for the full list.


File: python.info,  Node: Cloning existing functions,  Next: Calling Python code,  Prev: Using a return converter,  Up: Advanced Topics

10.15.4.12 Cloning existing functions
.....................................

If you have a number of functions that look similar, you may be able to
use Clinic’s “clone” feature.  When you clone an existing function, you
reuse:

   * its parameters, including

        * their names,

        * their converters, with all parameters,

        * their default values,

        * their per-parameter docstrings,

        * their `kind' (whether they’re positional only, positional or
          keyword, or keyword only), and

   * its return converter.

The only thing not copied from the original function is its docstring;
the syntax allows you to specify a new docstring.

Here’s the syntax for cloning a function:

     /*[clinic input] module.class.new_function [as c_basename] = module.class.existing_function  Docstring for new_function goes here. [clinic start generated code]*/

(The functions can be in different modules or classes.  I wrote
‘module.class’ in the sample just to illustrate that you must use the
full path to `both' functions.)

Sorry, there’s no syntax for partially-cloning a function, or cloning a
function then modifying it.  Cloning is an all-or nothing proposition.

Also, the function you are cloning from must have been previously
defined in the current file.


File: python.info,  Node: Calling Python code,  Next: Using a “self converter”,  Prev: Cloning existing functions,  Up: Advanced Topics

10.15.4.13 Calling Python code
..............................

The rest of the advanced topics require you to write Python code which
lives inside your C file and modifies Argument Clinic’s runtime state.
This is simple: you simply define a Python block.

A Python block uses different delimiter lines than an Argument Clinic
function block.  It looks like this:

     /*[python input] # python code goes here [python start generated code]*/

All the code inside the Python block is executed at the time it’s
parsed.  All text written to stdout inside the block is redirected into
the “output” after the block.

As an example, here’s a Python block that adds a static integer variable
to the C code:

     /*[python input] print('static int __ignored_unused_variable__ = 0;') [python start generated code]*/ static int __ignored_unused_variable__ = 0; /*[python checksum:...]*/


File: python.info,  Node: Using a “self converter”,  Next: Writing a custom converter,  Prev: Calling Python code,  Up: Advanced Topics

10.15.4.14 Using a “self converter”
...................................

Argument Clinic automatically adds a “self” parameter for you using a
default converter.  It automatically sets the ‘type’ of this parameter
to the “pointer to an instance” you specified when you declared the
type.  However, you can override Argument Clinic’s converter and specify
one yourself.  Just add your own ‘self’ parameter as the first parameter
in a block, and ensure that its converter is an instance of
‘self_converter’ or a subclass thereof.

What’s the point?  This lets you override the type of ‘self’, or give it
a different default name.

How do you specify the custom type you want to cast ‘self’ to?  If you
only have one or two functions with the same type for ‘self’, you can
directly use Argument Clinic’s existing ‘self’ converter, passing in the
type you want to use as the ‘type’ parameter:

     /*[clinic input]  _pickle.Pickler.dump    self: self(type="PicklerObject *")   obj: object   /  Write a pickled representation of the given object to the open file. [clinic start generated code]*/

On the other hand, if you have a lot of functions that will use the same
type for ‘self’, it’s best to create your own converter, subclassing
‘self_converter’ but overwriting the ‘type’ member:

     /*[python input] class PicklerObject_converter(self_converter):     type = "PicklerObject *" [python start generated code]*/  /*[clinic input]  _pickle.Pickler.dump    self: PicklerObject   obj: object   /  Write a pickled representation of the given object to the open file. [clinic start generated code]*/


File: python.info,  Node: Writing a custom converter,  Next: Writing a custom return converter,  Prev: Using a “self converter”,  Up: Advanced Topics

10.15.4.15 Writing a custom converter
.....................................

As we hinted at in the previous section… you can write your own
converters!  A converter is simply a Python class that inherits from
‘CConverter’.  The main purpose of a custom converter is if you have a
parameter using the ‘O&’ format unit—parsing this parameter means
calling a *note PyArg_ParseTuple(): 268. “converter function”.

Your converter class should be named ‘*something*_converter’.  If the
name follows this convention, then your converter class will be
automatically registered with Argument Clinic; its name will be the name
of your class with the ‘_converter’ suffix stripped off.  (This is
accomplished with a metaclass.)

You shouldn’t subclass ‘CConverter.__init__’.  Instead, you should write
a ‘converter_init()’ function.  ‘converter_init()’ always accepts a
‘self’ parameter; after that, all additional parameters `must' be
keyword-only.  Any arguments passed in to the converter in Argument
Clinic will be passed along to your ‘converter_init()’.

There are some additional members of ‘CConverter’ you may wish to
specify in your subclass.  Here’s the current list:

‘type’

     The C type to use for this variable.  ‘type’ should be a Python
     string specifying the type, e.g.  ‘int’.  If this is a pointer
     type, the type string should end with ‘' *'’.

‘default’

     The Python default value for this parameter, as a Python value.  Or
     the magic value ‘unspecified’ if there is no default.

‘py_default’

     ‘default’ as it should appear in Python code, as a string.  Or
     ‘None’ if there is no default.

‘c_default’

     ‘default’ as it should appear in C code, as a string.  Or ‘None’ if
     there is no default.

‘c_ignored_default’

     The default value used to initialize the C variable when there is
     no default, but not specifying a default may result in an
     “uninitialized variable” warning.  This can easily happen when
     using option groups—although properly-written code will never
     actually use this value, the variable does get passed in to the
     impl, and the C compiler will complain about the “use” of the
     uninitialized value.  This value should always be a non-empty
     string.

‘converter’

     The name of the C converter function, as a string.

‘impl_by_reference’

     A boolean value.  If true, Argument Clinic will add a ‘&’ in front
     of the name of the variable when passing it into the impl function.

‘parse_by_reference’

     A boolean value.  If true, Argument Clinic will add a ‘&’ in front
     of the name of the variable when passing it into *note
     PyArg_ParseTuple(): 268.

Here’s the simplest example of a custom converter, from
‘Modules/zlibmodule.c’:

     /*[python input]  class ssize_t_converter(CConverter):     type = 'Py_ssize_t'     converter = 'ssize_t_converter'  [python start generated code]*/ /*[python end generated code: output=da39a3ee5e6b4b0d input=35521e4e733823c7]*/

This block adds a converter to Argument Clinic named ‘ssize_t’.
Parameters declared as ‘ssize_t’ will be declared as type ‘Py_ssize_t’,
and will be parsed by the ‘'O&'’ format unit, which will call the
‘ssize_t_converter’ converter function.  ‘ssize_t’ variables
automatically support default values.

More sophisticated custom converters can insert custom C code to handle
initialization and cleanup.  You can see more examples of custom
converters in the CPython source tree; grep the C files for the string
‘CConverter’.


File: python.info,  Node: Writing a custom return converter,  Next: METH_O and METH_NOARGS,  Prev: Writing a custom converter,  Up: Advanced Topics

10.15.4.16 Writing a custom return converter
............................................

Writing a custom return converter is much like writing a custom
converter.  Except it’s somewhat simpler, because return converters are
themselves much simpler.

Return converters must subclass ‘CReturnConverter’.  There are no
examples yet of custom return converters, because they are not widely
used yet.  If you wish to write your own return converter, please read
‘Tools/clinic/clinic.py’, specifically the implementation of
‘CReturnConverter’ and all its subclasses.


File: python.info,  Node: METH_O and METH_NOARGS,  Next: tp_new and tp_init functions,  Prev: Writing a custom return converter,  Up: Advanced Topics

10.15.4.17 METH_O and METH_NOARGS
.................................

To convert a function using ‘METH_O’, make sure the function’s single
argument is using the ‘object’ converter, and mark the arguments as
positional-only:

     /*[clinic input] meth_o_sample       argument: object      / [clinic start generated code]*/

To convert a function using ‘METH_NOARGS’, just don’t specify any
arguments.

You can still use a self converter, a return converter, and specify a
‘type’ argument to the object converter for ‘METH_O’.


File: python.info,  Node: tp_new and tp_init functions,  Next: Changing and redirecting Clinic’s output,  Prev: METH_O and METH_NOARGS,  Up: Advanced Topics

10.15.4.18 tp_new and tp_init functions
.......................................

You can convert ‘tp_new’ and ‘tp_init’ functions.  Just name them
‘__new__’ or ‘__init__’ as appropriate.  Notes:

   * The function name generated for ‘__new__’ doesn’t end in ‘__new__’
     like it would by default.  It’s just the name of the class,
     converted into a valid C identifier.

   * No ‘PyMethodDef’ ‘#define’ is generated for these functions.

   * ‘__init__’ functions return ‘int’, not ‘PyObject *’.

   * Use the docstring as the class docstring.

   * Although ‘__new__’ and ‘__init__’ functions must always accept both
     the ‘args’ and ‘kwargs’ objects, when converting you may specify
     any signature for these functions that you like.  (If your function
     doesn’t support keywords, the parsing function generated will throw
     an exception if it receives any.)


File: python.info,  Node: Changing and redirecting Clinic’s output,  Next: The #ifdef trick,  Prev: tp_new and tp_init functions,  Up: Advanced Topics

10.15.4.19 Changing and redirecting Clinic’s output
...................................................

It can be inconvenient to have Clinic’s output interspersed with your
conventional hand-edited C code.  Luckily, Clinic is configurable: you
can buffer up its output for printing later (or earlier!), or write its
output to a separate file.  You can also add a prefix or suffix to every
line of Clinic’s generated output.

While changing Clinic’s output in this manner can be a boon to
readability, it may result in Clinic code using types before they are
defined, or your code attempting to use Clinic-generated code before it
is defined.  These problems can be easily solved by rearranging the
declarations in your file, or moving where Clinic’s generated code goes.
(This is why the default behavior of Clinic is to output everything into
the current block; while many people consider this hampers readability,
it will never require rearranging your code to fix definition-before-use
problems.)

Let’s start with defining some terminology:

`field'

     A field, in this context, is a subsection of Clinic’s output.  For
     example, the ‘#define’ for the ‘PyMethodDef’ structure is a field,
     called ‘methoddef_define’.  Clinic has seven different fields it
     can output per function definition:

          docstring_prototype docstring_definition methoddef_define impl_prototype parser_prototype parser_definition impl_definition

     All the names are of the form ‘"<a>_<b>"’, where ‘"<a>"’ is the
     semantic object represented (the parsing function, the impl
     function, the docstring, or the methoddef structure) and ‘"<b>"’
     represents what kind of statement the field is.  Field names that
     end in ‘"_prototype"’ represent forward declarations of that thing,
     without the actual body/data of the thing; field names that end in
     ‘"_definition"’ represent the actual definition of the thing, with
     the body/data of the thing.  (‘"methoddef"’ is special, it’s the
     only one that ends with ‘"_define"’, representing that it’s a
     preprocessor #define.)

`destination'

     A destination is a place Clinic can write output to.  There are
     five built-in destinations:

     ‘block’

          The default destination: printed in the output section of the
          current Clinic block.

     ‘buffer’

          A text buffer where you can save text for later.  Text sent
          here is appended to the end of any existing text.  It’s an
          error to have any text left in the buffer when Clinic finishes
          processing a file.

     ‘file’

          A separate “clinic file” that will be created automatically by
          Clinic.  The filename chosen for the file is
          ‘{basename}.clinic{extension}’, where ‘basename’ and
          ‘extension’ were assigned the output from ‘os.path.splitext()’
          run on the current file.  (Example: the ‘file’ destination for
          ‘_pickle.c’ would be written to ‘_pickle.clinic.c’.)

          `Important: When using a' ‘file’ `destination, you' `must
          check in' `the generated file!'

     ‘two-pass’

          A buffer like ‘buffer’.  However, a two-pass buffer can only
          be dumped once, and it prints out all text sent to it during
          all processing, even from Clinic blocks `after' the dumping
          point.

     ‘suppress’

          The text is suppressed—thrown away.

Clinic defines five new directives that let you reconfigure its output.

The first new directive is ‘dump’:

     dump <destination>

This dumps the current contents of the named destination into the output
of the current block, and empties it.  This only works with ‘buffer’ and
‘two-pass’ destinations.

The second new directive is ‘output’.  The most basic form of ‘output’
is like this:

     output <field> <destination>

This tells Clinic to output `field' to `destination'.  ‘output’ also
supports a special meta-destination, called ‘everything’, which tells
Clinic to output `all' fields to that `destination'.

‘output’ has a number of other functions:

     output push output pop output preset <preset>

‘output push’ and ‘output pop’ allow you to push and pop configurations
on an internal configuration stack, so that you can temporarily modify
the output configuration, then easily restore the previous
configuration.  Simply push before your change to save the current
configuration, then pop when you wish to restore the previous
configuration.

‘output preset’ sets Clinic’s output to one of several built-in preset
configurations, as follows:

     ‘block’

          Clinic’s original starting configuration.  Writes everything
          immediately after the input block.

          Suppress the ‘parser_prototype’ and ‘docstring_prototype’,
          write everything else to ‘block’.

     ‘file’

          Designed to write everything to the “clinic file” that it can.
          You then ‘#include’ this file near the top of your file.  You
          may need to rearrange your file to make this work, though
          usually this just means creating forward declarations for
          various ‘typedef’ and ‘PyTypeObject’ definitions.

          Suppress the ‘parser_prototype’ and ‘docstring_prototype’,
          write the ‘impl_definition’ to ‘block’, and write everything
          else to ‘file’.

          The default filename is ‘"{dirname}/clinic/{basename}.h"’.

     ‘buffer’

          Save up most of the output from Clinic, to be written into
          your file near the end.  For Python files implementing modules
          or builtin types, it’s recommended that you dump the buffer
          just above the static structures for your module or builtin
          type; these are normally very near the end.  Using ‘buffer’
          may require even more editing than ‘file’, if your file has
          static ‘PyMethodDef’ arrays defined in the middle of the file.

          Suppress the ‘parser_prototype’, ‘impl_prototype’, and
          ‘docstring_prototype’, write the ‘impl_definition’ to ‘block’,
          and write everything else to ‘file’.

     ‘two-pass’

          Similar to the ‘buffer’ preset, but writes forward
          declarations to the ‘two-pass’ buffer, and definitions to the
          ‘buffer’.  This is similar to the ‘buffer’ preset, but may
          require less editing than ‘buffer’.  Dump the ‘two-pass’
          buffer near the top of your file, and dump the ‘buffer’ near
          the end just like you would when using the ‘buffer’ preset.

          Suppresses the ‘impl_prototype’, write the ‘impl_definition’
          to ‘block’, write ‘docstring_prototype’, ‘methoddef_define’,
          and ‘parser_prototype’ to ‘two-pass’, write everything else to
          ‘buffer’.

     ‘partial-buffer’

          Similar to the ‘buffer’ preset, but writes more things to
          ‘block’, only writing the really big chunks of generated code
          to ‘buffer’.  This avoids the definition-before-use problem of
          ‘buffer’ completely, at the small cost of having slightly more
          stuff in the block’s output.  Dump the ‘buffer’ near the end,
          just like you would when using the ‘buffer’ preset.

          Suppresses the ‘impl_prototype’, write the
          ‘docstring_definition’ and ‘parser_definition’ to ‘buffer’,
          write everything else to ‘block’.

The third new directive is ‘destination’:

     destination <name> <command> [...]

This performs an operation on the destination named ‘name’.

There are two defined subcommands: ‘new’ and ‘clear’.

The ‘new’ subcommand works like this:

     destination <name> new <type>

This creates a new destination with name ‘<name>’ and type ‘<type>’.

There are five destination types:

     ‘suppress’

          Throws the text away.

     ‘block’

          Writes the text to the current block.  This is what Clinic
          originally did.

     ‘buffer’

          A simple text buffer, like the “buffer” builtin destination
          above.

     ‘file’

          A text file.  The file destination takes an extra argument, a
          template to use for building the filename, like so:

               destination <name> new <type> <file_template>

          The template can use three strings internally that will be
          replaced by bits of the filename:

               {path}

                    The full path to the file, including directory and
                    full filename.

               {dirname}

                    The name of the directory the file is in.

               {basename}

                    Just the name of the file, not including the
                    directory.

               {basename_root}

                    Basename with the extension clipped off (everything
                    up to but not including the last ‘.’).

               {basename_extension}

                    The last ‘.’ and everything after it.  If the
                    basename does not contain a period, this will be the
                    empty string.

          If there are no periods in the filename, {basename} and
          {filename} are the same, and {extension} is empty.
          “{basename}{extension}” is always exactly the same as
          “{filename}”.”

     ‘two-pass’

          A two-pass buffer, like the “two-pass” builtin destination
          above.

The ‘clear’ subcommand works like this:

     destination <name> clear

It removes all the accumulated text up to this point in the destination.
(I don’t know what you’d need this for, but I thought maybe it’d be
useful while someone’s experimenting.)

The fourth new directive is ‘set’:

     set line_prefix "string" set line_suffix "string"

‘set’ lets you set two internal variables in Clinic.  ‘line_prefix’ is a
string that will be prepended to every line of Clinic’s output;
‘line_suffix’ is a string that will be appended to every line of
Clinic’s output.

Both of these support two format strings:

     ‘{block comment start}’

          Turns into the string ‘/*’, the start-comment text sequence
          for C files.

     ‘{block comment end}’

          Turns into the string ‘*/’, the end-comment text sequence for
          C files.

The final new directive is one you shouldn’t need to use directly,
called ‘preserve’:

     preserve

This tells Clinic that the current contents of the output should be
kept, unmodified.  This is used internally by Clinic when dumping output
into ‘file’ files; wrapping it in a Clinic block lets Clinic use its
existing checksum functionality to ensure the file was not modified by
hand before it gets overwritten.


File: python.info,  Node: The #ifdef trick,  Next: Using Argument Clinic in Python files,  Prev: Changing and redirecting Clinic’s output,  Up: Advanced Topics

10.15.4.20 The #ifdef trick
...........................

If you’re converting a function that isn’t available on all platforms,
there’s a trick you can use to make life a little easier.  The existing
code probably looks like this:

     #ifdef HAVE_FUNCTIONNAME static module_functionname(...) { ... } #endif /* HAVE_FUNCTIONNAME */

And then in the ‘PyMethodDef’ structure at the bottom the existing code
will have:

     #ifdef HAVE_FUNCTIONNAME {'functionname', ... }, #endif /* HAVE_FUNCTIONNAME */

In this scenario, you should enclose the body of your impl function
inside the ‘#ifdef’, like so:

     #ifdef HAVE_FUNCTIONNAME /*[clinic input] module.functionname ... [clinic start generated code]*/ static module_functionname(...) { ... } #endif /* HAVE_FUNCTIONNAME */

Then, remove those three lines from the ‘PyMethodDef’ structure,
replacing them with the macro Argument Clinic generated:

     MODULE_FUNCTIONNAME_METHODDEF

(You can find the real name for this macro inside the generated code.
Or you can calculate it yourself: it’s the name of your function as
defined on the first line of your block, but with periods changed to
underscores, uppercased, and ‘"_METHODDEF"’ added to the end.)

Perhaps you’re wondering: what if ‘HAVE_FUNCTIONNAME’ isn’t defined?
The ‘MODULE_FUNCTIONNAME_METHODDEF’ macro won’t be defined either!

Here’s where Argument Clinic gets very clever.  It actually detects that
the Argument Clinic block might be deactivated by the ‘#ifdef’.  When
that happens, it generates a little extra code that looks like this:

     #ifndef MODULE_FUNCTIONNAME_METHODDEF     #define MODULE_FUNCTIONNAME_METHODDEF #endif /* !defined(MODULE_FUNCTIONNAME_METHODDEF) */

That means the macro always works.  If the function is defined, this
turns into the correct structure, including the trailing comma.  If the
function is undefined, this turns into nothing.

However, this causes one ticklish problem: where should Argument Clinic
put this extra code when using the “block” output preset?  It can’t go
in the output block, because that could be deactivated by the ‘#ifdef’.
(That’s the whole point!)

In this situation, Argument Clinic writes the extra code to the “buffer”
destination.  This may mean that you get a complaint from Argument
Clinic:

     Warning in file "Modules/posixmodule.c" on line 12357: Destination buffer 'buffer' not empty at end of file, emptying.

When this happens, just open your file, find the ‘dump buffer’ block
that Argument Clinic added to your file (it’ll be at the very bottom),
then move it above the ‘PyMethodDef’ structure where that macro is used.


File: python.info,  Node: Using Argument Clinic in Python files,  Prev: The #ifdef trick,  Up: Advanced Topics

10.15.4.21 Using Argument Clinic in Python files
................................................

It’s actually possible to use Argument Clinic to preprocess Python
files.  There’s no point to using Argument Clinic blocks, of course, as
the output wouldn’t make any sense to the Python interpreter.  But using
Argument Clinic to run Python blocks lets you use Python as a Python
preprocessor!

Since Python comments are different from C comments, Argument Clinic
blocks embedded in Python files look slightly different.  They look like
this:

     #/*[python input] #print("def foo(): pass") #[python start generated code]*/ def foo(): pass #/*[python checksum:...]*/


File: python.info,  Node: Instrumenting CPython with DTrace and SystemTap,  Prev: Argument Clinic How-To,  Up: Python HOWTOs

10.16 Instrumenting CPython with DTrace and SystemTap
=====================================================


author: David Malcolm


author: Łukasz Langa

DTrace and SystemTap are monitoring tools, each providing a way to
inspect what the processes on a computer system are doing.  They both
use domain-specific languages allowing a user to write scripts which:

        - filter which processes are to be observed

        - gather data from the processes of interest

        - generate reports on the data

As of Python 3.6, CPython can be built with embedded “markers”, also
known as “probes”, that can be observed by a DTrace or SystemTap script,
making it easier to monitor what the CPython processes on a system are
doing.

`CPython implementation detail:' DTrace markers are implementation
details of the CPython interpreter.  No guarantees are made about probe
compatibility between versions of CPython.  DTrace scripts can stop
working or work incorrectly without warning when changing CPython
versions.

* Menu:

* Enabling the static markers::
* Static DTrace probes::
* Static SystemTap markers::
* Available static markers::
* SystemTap Tapsets::
* Examples: Examples<36>.


File: python.info,  Node: Enabling the static markers,  Next: Static DTrace probes,  Up: Instrumenting CPython with DTrace and SystemTap

10.16.1 Enabling the static markers
-----------------------------------

macOS comes with built-in support for DTrace.  On Linux, in order to
build CPython with the embedded markers for SystemTap, the SystemTap
development tools must be installed.

On a Linux machine, this can be done via:

     $ yum install systemtap-sdt-devel

or:

     $ sudo apt-get install systemtap-sdt-dev

CPython must then be configured ‘--with-dtrace’:

     checking for --with-dtrace... yes

On macOS, you can list available DTrace probes by running a Python
process in the background and listing all probes made available by the
Python provider:

     $ python3.6 -q & $ sudo dtrace -l -P python$!  # or: dtrace -l -m python3.6     ID   PROVIDER            MODULE                          FUNCTION NAME 29564 python18035        python3.6          _PyEval_EvalFrameDefault function-entry 29565 python18035        python3.6             dtrace_function_entry function-entry 29566 python18035        python3.6          _PyEval_EvalFrameDefault function-return 29567 python18035        python3.6            dtrace_function_return function-return 29568 python18035        python3.6                           collect gc-done 29569 python18035        python3.6                           collect gc-start 29570 python18035        python3.6          _PyEval_EvalFrameDefault line 29571 python18035        python3.6                 maybe_dtrace_line line

On Linux, you can verify if the SystemTap static markers are present in
the built binary by seeing if it contains a “.note.stapsdt” section.

     $ readelf -S ./python | grep .note.stapsdt [30] .note.stapsdt        NOTE         0000000000000000 00308d78

If you’ve built Python as a shared library (with –enable-shared), you
need to look instead within the shared library.  For example:

     $ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt [29] .note.stapsdt        NOTE         0000000000000000 00365b68

Sufficiently modern readelf can print the metadata:

     $ readelf -n ./python  Displaying notes found at file offset 0x00000254 with length 0x00000020:     Owner                 Data size          Description     GNU                  0x00000010          NT_GNU_ABI_TAG (ABI version tag)         OS: Linux, ABI: 2.6.32  Displaying notes found at file offset 0x00000274 with length 0x00000024:     Owner                 Data size          Description     GNU                  0x00000014          NT_GNU_BUILD_ID (unique build ID bitstring)         Build ID: df924a2b08a7e89f6e11251d4602022977af2670  Displaying notes found at file offset 0x002d6c30 with length 0x00000144:     Owner                 Data size          Description     stapsdt              0x00000031          NT_STAPSDT (SystemTap probe descriptors)         Provider: python         Name: gc__start         Location: 0x00000000004371c3, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf6         Arguments: -4@%ebx     stapsdt              0x00000030          NT_STAPSDT (SystemTap probe descriptors)         Provider: python         Name: gc__done         Location: 0x00000000004374e1, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf8         Arguments: -8@%rax     stapsdt              0x00000045          NT_STAPSDT (SystemTap probe descriptors)         Provider: python         Name: function__entry         Location: 0x000000000053db6c, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6be8         Arguments: 8@%rbp 8@%r12 -4@%eax     stapsdt              0x00000046          NT_STAPSDT (SystemTap probe descriptors)         Provider: python         Name: function__return         Location: 0x000000000053dba8, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bea         Arguments: 8@%rbp 8@%r12 -4@%eax

The above metadata contains information for SystemTap describing how it
can patch strategically-placed machine code instructions to enable the
tracing hooks used by a SystemTap script.


File: python.info,  Node: Static DTrace probes,  Next: Static SystemTap markers,  Prev: Enabling the static markers,  Up: Instrumenting CPython with DTrace and SystemTap

10.16.2 Static DTrace probes
----------------------------

The following example DTrace script can be used to show the call/return
hierarchy of a Python script, only tracing within the invocation of a
function called “start”.  In other words, import-time function
invocations are not going to be listed:

     self int indent;  python$target:::function-entry /copyinstr(arg1) == "start"/ {         self->trace = 1; }  python$target:::function-entry /self->trace/ {         printf("%d\t%*s:", timestamp, 15, probename);         printf("%*s", self->indent, "");         printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);         self->indent++; }  python$target:::function-return /self->trace/ {         self->indent--;         printf("%d\t%*s:", timestamp, 15, probename);         printf("%*s", self->indent, "");         printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2); }  python$target:::function-return /copyinstr(arg1) == "start"/ {         self->trace = 0; }

It can be invoked like this:

     $ sudo dtrace -q -s call_stack.d -c "python3.6 script.py"

The output looks like this:

     156641360502280  function-entry:call_stack.py:start:23 156641360518804  function-entry: call_stack.py:function_1:1 156641360532797  function-entry:  call_stack.py:function_3:9 156641360546807 function-return:  call_stack.py:function_3:10 156641360563367 function-return: call_stack.py:function_1:2 156641360578365  function-entry: call_stack.py:function_2:5 156641360591757  function-entry:  call_stack.py:function_1:1 156641360605556  function-entry:   call_stack.py:function_3:9 156641360617482 function-return:   call_stack.py:function_3:10 156641360629814 function-return:  call_stack.py:function_1:2 156641360642285 function-return: call_stack.py:function_2:6 156641360656770  function-entry: call_stack.py:function_3:9 156641360669707 function-return: call_stack.py:function_3:10 156641360687853  function-entry: call_stack.py:function_4:13 156641360700719 function-return: call_stack.py:function_4:14 156641360719640  function-entry: call_stack.py:function_5:18 156641360732567 function-return: call_stack.py:function_5:21 156641360747370 function-return:call_stack.py:start:28


File: python.info,  Node: Static SystemTap markers,  Next: Available static markers,  Prev: Static DTrace probes,  Up: Instrumenting CPython with DTrace and SystemTap

10.16.3 Static SystemTap markers
--------------------------------

The low-level way to use the SystemTap integration is to use the static
markers directly.  This requires you to explicitly state the binary file
containing them.

For example, this SystemTap script can be used to show the call/return
hierarchy of a Python script:

     probe process("python").mark("function__entry") {      filename = user_string($arg1);      funcname = user_string($arg2);      lineno = $arg3;       printf("%s => %s in %s:%d\\n",             thread_indent(1), funcname, filename, lineno); }  probe process("python").mark("function__return") {     filename = user_string($arg1);     funcname = user_string($arg2);     lineno = $arg3;      printf("%s <= %s in %s:%d\\n",            thread_indent(-1), funcname, filename, lineno); }

It can be invoked like this:

     $ stap \   show-call-hierarchy.stp \   -c "./python test.py"

The output looks like this:

     11408 python(8274):        => __contains__ in Lib/_abcoll.py:362 11414 python(8274):         => __getitem__ in Lib/os.py:425 11418 python(8274):          => encode in Lib/os.py:490 11424 python(8274):          <= encode in Lib/os.py:493 11428 python(8274):         <= __getitem__ in Lib/os.py:426 11433 python(8274):        <= __contains__ in Lib/_abcoll.py:366

where the columns are:

        - time in microseconds since start of script

        - name of executable

        - PID of process

and the remainder indicates the call/return hierarchy as the script
executes.

For a ‘–enable-shared’ build of CPython, the markers are contained
within the libpython shared library, and the probe’s dotted path needs
to reflect this.  For example, this line from the above example:

     probe process("python").mark("function__entry") {

should instead read:

     probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") {

(assuming a debug build of CPython 3.6)


File: python.info,  Node: Available static markers,  Next: SystemTap Tapsets,  Prev: Static SystemTap markers,  Up: Instrumenting CPython with DTrace and SystemTap

10.16.4 Available static markers
--------------------------------

 -- C Function: function__entry (str filename, str funcname, int lineno)

     This marker indicates that execution of a Python function has
     begun.  It is only triggered for pure-Python (bytecode) functions.

     The filename, function name, and line number are provided back to
     the tracing script as positional arguments, which must be accessed
     using ‘$arg1’, ‘$arg2’, ‘$arg3’:

             * ‘$arg1’ : ‘(const char *)’ filename, accessible using
               ‘user_string($arg1)’

             * ‘$arg2’ : ‘(const char *)’ function name, accessible
               using ‘user_string($arg2)’

             * ‘$arg3’ : ‘int’ line number

 -- C Function: function__return (str filename, str funcname,
          int lineno)

     This marker is the converse of *note function__entry(): 416f, and
     indicates that execution of a Python function has ended (either via
     ‘return’, or via an exception).  It is only triggered for
     pure-Python (bytecode) functions.

     The arguments are the same as for *note function__entry(): 416f.

 -- C Function: line (str filename, str funcname, int lineno)

     This marker indicates a Python line is about to be executed.  It is
     the equivalent of line-by-line tracing with a Python profiler.  It
     is not triggered within C functions.

     The arguments are the same as for *note function__entry(): 416f.

 -- C Function: gc__start (int generation)

     Fires when the Python interpreter starts a garbage collection
     cycle.  ‘arg0’ is the generation to scan, like *note gc.collect():
     22c.

 -- C Function: gc__done (long collected)

     Fires when the Python interpreter finishes a garbage collection
     cycle.  ‘arg0’ is the number of collected objects.

 -- C Function: import__find__load__start (str modulename)

     Fires before *note importlib: 9b. attempts to find and load the
     module.  ‘arg0’ is the module name.

     New in version 3.7.

 -- C Function: import__find__load__done (str modulename, int found)

     Fires after *note importlib: 9b.’s find_and_load function is
     called.  ‘arg0’ is the module name, ‘arg1’ indicates if module was
     successfully loaded.

     New in version 3.7.

 -- C Function: audit (str event, void *tuple)

     Fires when *note sys.audit(): 3404. or *note PySys_Audit(): e81. is
     called.  ‘arg0’ is the event name as C string, ‘arg1’ is a *note
     PyObject: 4b0. pointer to a tuple object.

     New in version 3.8.


File: python.info,  Node: SystemTap Tapsets,  Next: Examples<36>,  Prev: Available static markers,  Up: Instrumenting CPython with DTrace and SystemTap

10.16.5 SystemTap Tapsets
-------------------------

The higher-level way to use the SystemTap integration is to use a
“tapset”: SystemTap’s equivalent of a library, which hides some of the
lower-level details of the static markers.

Here is a tapset file, based on a non-shared build of CPython:

     /*    Provide a higher-level wrapping around the function__entry and    function__return markers:  \*/ probe python.function.entry = process("python").mark("function__entry") {     filename = user_string($arg1);     funcname = user_string($arg2);     lineno = $arg3;     frameptr = $arg4 } probe python.function.return = process("python").mark("function__return") {     filename = user_string($arg1);     funcname = user_string($arg2);     lineno = $arg3;     frameptr = $arg4 }

If this file is installed in SystemTap’s tapset directory (e.g.
‘/usr/share/systemtap/tapset’), then these additional probepoints become
available:

 -- C Function: python.function.entry (str filename, str funcname,
          int lineno, frameptr)

     This probe point indicates that execution of a Python function has
     begun.  It is only triggered for pure-Python (bytecode) functions.

 -- C Function: python.function.return (str filename, str funcname,
          int lineno, frameptr)

     This probe point is the converse of *note python.function.return():
     4177, and indicates that execution of a Python function has ended
     (either via ‘return’, or via an exception).  It is only triggered
     for pure-Python (bytecode) functions.


File: python.info,  Node: Examples<36>,  Prev: SystemTap Tapsets,  Up: Instrumenting CPython with DTrace and SystemTap

10.16.6 Examples
----------------

This SystemTap script uses the tapset above to more cleanly implement
the example given above of tracing the Python function-call hierarchy,
without needing to directly name the static markers:

     probe python.function.entry {   printf("%s => %s in %s:%d\n",          thread_indent(1), funcname, filename, lineno); }  probe python.function.return {   printf("%s <= %s in %s:%d\n",          thread_indent(-1), funcname, filename, lineno); }

The following script uses the tapset above to provide a top-like view of
all running CPython code, showing the top 20 most frequently-entered
bytecode frames, each second, across the whole system:

     global fn_calls;  probe python.function.entry {     fn_calls[pid(), filename, funcname, lineno] += 1; }  probe timer.ms(1000) {     printf("\033[2J\033[1;1H") /* clear screen \*/     printf("%6s %80s %6s %30s %6s\n",            "PID", "FILENAME", "LINE", "FUNCTION", "CALLS")     foreach ([pid, filename, funcname, lineno] in fn_calls- limit 20) {         printf("%6d %80s %6d %30s %6d\n",             pid, filename, lineno, funcname,             fn_calls[pid, filename, funcname, lineno]);     }     delete fn_calls; }


File: python.info,  Node: Python Frequently Asked Questions,  Next: Glossary,  Prev: Python HOWTOs,  Up: Top

11 Python Frequently Asked Questions
************************************

* Menu:

* General Python FAQ::
* Programming FAQ::
* Design and History FAQ::
* Library and Extension FAQ::
* Extending/Embedding FAQ::
* Python on Windows FAQ::
* Graphic User Interface FAQ::
* “Why is Python Installed on my Computer?” FAQ::


File: python.info,  Node: General Python FAQ,  Next: Programming FAQ,  Up: Python Frequently Asked Questions

11.1 General Python FAQ
=======================

* Menu:

* General Information::
* Python in the real world::


File: python.info,  Node: General Information,  Next: Python in the real world,  Up: General Python FAQ

11.1.1 General Information
--------------------------

* Menu:

* What is Python?::
* What is the Python Software Foundation?::
* Are there copyright restrictions on the use of Python?::
* Why was Python created in the first place?::
* What is Python good for?::
* How does the Python version numbering scheme work?::
* How do I obtain a copy of the Python source?::
* How do I get documentation on Python?::
* I’ve never programmed before. Is there a Python tutorial?: I’ve never programmed before Is there a Python tutorial?.
* Is there a newsgroup or mailing list devoted to Python?::
* How do I get a beta test version of Python?::
* How do I submit bug reports and patches for Python?::
* Are there any published articles about Python that I can reference?::
* Are there any books on Python?::
* Where in the world is www.python.org located?: Where in the world is www python org located?.
* Why is it called Python?::
* Do I have to like “Monty Python’s Flying Circus”?::


File: python.info,  Node: What is Python?,  Next: What is the Python Software Foundation?,  Up: General Information

11.1.1.1 What is Python?
........................

Python is an interpreted, interactive, object-oriented programming
language.  It incorporates modules, exceptions, dynamic typing, very
high level dynamic data types, and classes.  Python combines remarkable
power with very clear syntax.  It has interfaces to many system calls
and libraries, as well as to various window systems, and is extensible
in C or C++.  It is also usable as an extension language for
applications that need a programmable interface.  Finally, Python is
portable: it runs on many Unix variants, on the Mac, and on Windows 2000
and later.

To find out more, start with *note The Python Tutorial: 1134.  The
Beginner’s Guide to Python(1) links to other introductory tutorials and
resources for learning Python.

   ---------- Footnotes ----------

   (1) https://wiki.python.org/moin/BeginnersGuide


File: python.info,  Node: What is the Python Software Foundation?,  Next: Are there copyright restrictions on the use of Python?,  Prev: What is Python?,  Up: General Information

11.1.1.2 What is the Python Software Foundation?
................................................

The Python Software Foundation is an independent non-profit organization
that holds the copyright on Python versions 2.1 and newer.  The PSF’s
mission is to advance open source technology related to the Python
programming language and to publicize the use of Python.  The PSF’s home
page is at ‘https://www.python.org/psf/’.

Donations to the PSF are tax-exempt in the US. If you use Python and
find it helpful, please contribute via the PSF donation page(1).

   ---------- Footnotes ----------

   (1) https://www.python.org/psf/donations/


File: python.info,  Node: Are there copyright restrictions on the use of Python?,  Next: Why was Python created in the first place?,  Prev: What is the Python Software Foundation?,  Up: General Information

11.1.1.3 Are there copyright restrictions on the use of Python?
...............................................................

You can do anything you want with the source, as long as you leave the
copyrights in and display those copyrights in any documentation about
Python that you produce.  If you honor the copyright rules, it’s OK to
use Python for commercial use, to sell copies of Python in source or
binary form (modified or unmodified), or to sell products that
incorporate Python in some form.  We would still like to know about all
commercial use of Python, of course.

See the PSF license page(1) to find further explanations and a link to
the full text of the license.

The Python logo is trademarked, and in certain cases permission is
required to use it.  Consult the Trademark Usage Policy(2) for more
information.

   ---------- Footnotes ----------

   (1) https://www.python.org/psf/license/

   (2) https://www.python.org/psf/trademarks/


File: python.info,  Node: Why was Python created in the first place?,  Next: What is Python good for?,  Prev: Are there copyright restrictions on the use of Python?,  Up: General Information

11.1.1.4 Why was Python created in the first place?
...................................................

Here’s a `very' brief summary of what started it all, written by Guido
van Rossum:

     I had extensive experience with implementing an interpreted
     language in the ABC group at CWI, and from working with this group
     I had learned a lot about language design.  This is the origin of
     many Python features, including the use of indentation for
     statement grouping and the inclusion of very-high-level data types
     (although the details are all different in Python).

     I had a number of gripes about the ABC language, but also liked
     many of its features.  It was impossible to extend the ABC language
     (or its implementation) to remedy my complaints – in fact its lack
     of extensibility was one of its biggest problems.  I had some
     experience with using Modula-2+ and talked with the designers of
     Modula-3 and read the Modula-3 report.  Modula-3 is the origin of
     the syntax and semantics used for exceptions, and some other Python
     features.

     I was working in the Amoeba distributed operating system group at
     CWI. We needed a better way to do system administration than by
     writing either C programs or Bourne shell scripts, since Amoeba had
     its own system call interface which wasn’t easily accessible from
     the Bourne shell.  My experience with error handling in Amoeba made
     me acutely aware of the importance of exceptions as a programming
     language feature.

     It occurred to me that a scripting language with a syntax like ABC
     but with access to the Amoeba system calls would fill the need.  I
     realized that it would be foolish to write an Amoeba-specific
     language, so I decided that I needed a language that was generally
     extensible.

     During the 1989 Christmas holidays, I had a lot of time on my hand,
     so I decided to give it a try.  During the next year, while still
     mostly working on it in my own time, Python was used in the Amoeba
     project with increasing success, and the feedback from colleagues
     made me add many early improvements.

     In February 1991, after just over a year of development, I decided
     to post to USENET. The rest is in the ‘Misc/HISTORY’ file.


File: python.info,  Node: What is Python good for?,  Next: How does the Python version numbering scheme work?,  Prev: Why was Python created in the first place?,  Up: General Information

11.1.1.5 What is Python good for?
.................................

Python is a high-level general-purpose programming language that can be
applied to many different classes of problems.

The language comes with a large standard library that covers areas such
as string processing (regular expressions, Unicode, calculating
differences between files), Internet protocols (HTTP, FTP, SMTP,
XML-RPC, POP, IMAP, CGI programming), software engineering (unit
testing, logging, profiling, parsing Python code), and operating system
interfaces (system calls, filesystems, TCP/IP sockets).  Look at the
table of contents for *note The Python Standard Library: 1135. to get an
idea of what’s available.  A wide variety of third-party extensions are
also available.  Consult the Python Package Index(1) to find packages of
interest to you.

   ---------- Footnotes ----------

   (1) https://pypi.org


File: python.info,  Node: How does the Python version numbering scheme work?,  Next: How do I obtain a copy of the Python source?,  Prev: What is Python good for?,  Up: General Information

11.1.1.6 How does the Python version numbering scheme work?
...........................................................

Python versions are numbered A.B.C or A.B. A is the major version number
– it is only incremented for really major changes in the language.  B is
the minor version number, incremented for less earth-shattering changes.
C is the micro-level – it is incremented for each bugfix release.  See
PEP 6(1) for more information about bugfix releases.

Not all releases are bugfix releases.  In the run-up to a new major
release, a series of development releases are made, denoted as alpha,
beta, or release candidate.  Alphas are early releases in which
interfaces aren’t yet finalized; it’s not unexpected to see an interface
change between two alpha releases.  Betas are more stable, preserving
existing interfaces but possibly adding new modules, and release
candidates are frozen, making no changes except as needed to fix
critical bugs.

Alpha, beta and release candidate versions have an additional suffix.
The suffix for an alpha version is “aN” for some small number N, the
suffix for a beta version is “bN” for some small number N, and the
suffix for a release candidate version is “cN” for some small number N.
In other words, all versions labeled 2.0aN precede the versions labeled
2.0bN, which precede versions labeled 2.0cN, and `those' precede 2.0.

You may also find version numbers with a “+” suffix, e.g.  “2.2+”.
These are unreleased versions, built directly from the CPython
development repository.  In practice, after a final minor release is
made, the version is incremented to the next minor version, which
becomes the “a0” version, e.g.  “2.4a0”.

See also the documentation for *note sys.version: 5c8, *note
sys.hexversion: 3570, and *note sys.version_info: b0d.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0006


File: python.info,  Node: How do I obtain a copy of the Python source?,  Next: How do I get documentation on Python?,  Prev: How does the Python version numbering scheme work?,  Up: General Information

11.1.1.7 How do I obtain a copy of the Python source?
.....................................................

The latest Python source distribution is always available from
python.org, at ‘https://www.python.org/downloads/’.  The latest
development sources can be obtained at
‘https://github.com/python/cpython/’.

The source distribution is a gzipped tar file containing the complete C
source, Sphinx-formatted documentation, Python library modules, example
programs, and several useful pieces of freely distributable software.
The source will compile and run out of the box on most UNIX platforms.

Consult the Getting Started section of the Python Developer’s Guide(1)
for more information on getting the source code and compiling it.

   ---------- Footnotes ----------

   (1) https://devguide.python.org/setup/


File: python.info,  Node: How do I get documentation on Python?,  Next: I’ve never programmed before Is there a Python tutorial?,  Prev: How do I obtain a copy of the Python source?,  Up: General Information

11.1.1.8 How do I get documentation on Python?
..............................................

The standard documentation for the current stable version of Python is
available at ‘https://docs.python.org/3/’.  PDF, plain text, and
downloadable HTML versions are also available at
‘https://docs.python.org/3/download.html’.

The documentation is written in reStructuredText and processed by the
Sphinx documentation tool(1).  The reStructuredText source for the
documentation is part of the Python source distribution.

   ---------- Footnotes ----------

   (1) http://sphinx-doc.org/


File: python.info,  Node: I’ve never programmed before Is there a Python tutorial?,  Next: Is there a newsgroup or mailing list devoted to Python?,  Prev: How do I get documentation on Python?,  Up: General Information

11.1.1.9 I’ve never programmed before. Is there a Python tutorial?
..................................................................

There are numerous tutorials and books available.  The standard
documentation includes *note The Python Tutorial: 1134.

Consult the Beginner’s Guide(1) to find information for beginning Python
programmers, including lists of tutorials.

   ---------- Footnotes ----------

   (1) https://wiki.python.org/moin/BeginnersGuide


File: python.info,  Node: Is there a newsgroup or mailing list devoted to Python?,  Next: How do I get a beta test version of Python?,  Prev: I’ve never programmed before Is there a Python tutorial?,  Up: General Information

11.1.1.10 Is there a newsgroup or mailing list devoted to Python?
.................................................................

There is a newsgroup, ‘comp.lang.python’, and a mailing list,
python-list(1).  The newsgroup and mailing list are gatewayed into each
other – if you can read news it’s unnecessary to subscribe to the
mailing list.  ‘comp.lang.python’ is high-traffic, receiving hundreds of
postings every day, and Usenet readers are often more able to cope with
this volume.

Announcements of new software releases and events can be found in
comp.lang.python.announce, a low-traffic moderated list that receives
about five postings per day.  It’s available as the python-announce
mailing list(2).

More info about other mailing lists and newsgroups can be found at
‘https://www.python.org/community/lists/’.

   ---------- Footnotes ----------

   (1) https://mail.python.org/mailman/listinfo/python-list

   (2) https://mail.python.org/mailman/listinfo/python-announce-list


File: python.info,  Node: How do I get a beta test version of Python?,  Next: How do I submit bug reports and patches for Python?,  Prev: Is there a newsgroup or mailing list devoted to Python?,  Up: General Information

11.1.1.11 How do I get a beta test version of Python?
.....................................................

Alpha and beta releases are available from
‘https://www.python.org/downloads/’.  All releases are announced on the
comp.lang.python and comp.lang.python.announce newsgroups and on the
Python home page at ‘https://www.python.org/’; an RSS feed of news is
available.

You can also access the development version of Python through Git.  See
The Python Developer’s Guide(1) for details.

   ---------- Footnotes ----------

   (1) https://devguide.python.org/


File: python.info,  Node: How do I submit bug reports and patches for Python?,  Next: Are there any published articles about Python that I can reference?,  Prev: How do I get a beta test version of Python?,  Up: General Information

11.1.1.12 How do I submit bug reports and patches for Python?
.............................................................

To report a bug or submit a patch, please use the Roundup installation
at ‘https://bugs.python.org/’.

You must have a Roundup account to report bugs; this makes it possible
for us to contact you if we have follow-up questions.  It will also
enable Roundup to send you updates as we act on your bug.  If you had
previously used SourceForge to report bugs to Python, you can obtain
your Roundup password through Roundup’s password reset procedure(1).

For more information on how Python is developed, consult the Python
Developer’s Guide(2).

   ---------- Footnotes ----------

   (1) https://bugs.python.org/user?@template=forgotten

   (2) https://devguide.python.org/


File: python.info,  Node: Are there any published articles about Python that I can reference?,  Next: Are there any books on Python?,  Prev: How do I submit bug reports and patches for Python?,  Up: General Information

11.1.1.13 Are there any published articles about Python that I can reference?
.............................................................................

It’s probably best to cite your favorite book about Python.

The very first article about Python was written in 1991 and is now quite
outdated.

     Guido van Rossum and Jelke de Boer, “Interactively Testing Remote
     Servers Using the Python Programming Language”, CWI Quarterly,
     Volume 4, Issue 4 (December 1991), Amsterdam, pp 283–303.


File: python.info,  Node: Are there any books on Python?,  Next: Where in the world is www python org located?,  Prev: Are there any published articles about Python that I can reference?,  Up: General Information

11.1.1.14 Are there any books on Python?
........................................

Yes, there are many, and more are being published.  See the python.org
wiki at ‘https://wiki.python.org/moin/PythonBooks’ for a list.

You can also search online bookstores for “Python” and filter out the
Monty Python references; or perhaps search for “Python” and “language”.


File: python.info,  Node: Where in the world is www python org located?,  Next: Why is it called Python?,  Prev: Are there any books on Python?,  Up: General Information

11.1.1.15 Where in the world is www.python.org located?
.......................................................

The Python project’s infrastructure is located all over the world and is
managed by the Python Infrastructure Team.  Details here(1).

   ---------- Footnotes ----------

   (1) http://infra.psf.io


File: python.info,  Node: Why is it called Python?,  Next: Do I have to like “Monty Python’s Flying Circus”?,  Prev: Where in the world is www python org located?,  Up: General Information

11.1.1.16 Why is it called Python?
..................................

When he began implementing Python, Guido van Rossum was also reading the
published scripts from "Monty Python’s Flying Circus"(1), a BBC comedy
series from the 1970s.  Van Rossum thought he needed a name that was
short, unique, and slightly mysterious, so he decided to call the
language Python.

   ---------- Footnotes ----------

   (1) https://en.wikipedia.org/wiki/Monty_Python


File: python.info,  Node: Do I have to like “Monty Python’s Flying Circus”?,  Prev: Why is it called Python?,  Up: General Information

11.1.1.17 Do I have to like “Monty Python’s Flying Circus”?
...........................................................

No, but it helps.  :)


File: python.info,  Node: Python in the real world,  Prev: General Information,  Up: General Python FAQ

11.1.2 Python in the real world
-------------------------------

* Menu:

* How stable is Python?::
* How many people are using Python?::
* Have any significant projects been done in Python?::
* What new developments are expected for Python in the future?::
* Is it reasonable to propose incompatible changes to Python?::
* Is Python a good language for beginning programmers?::


File: python.info,  Node: How stable is Python?,  Next: How many people are using Python?,  Up: Python in the real world

11.1.2.1 How stable is Python?
..............................

Very stable.  New, stable releases have been coming out roughly every 6
to 18 months since 1991, and this seems likely to continue.  Currently
there are usually around 18 months between major releases.

The developers issue “bugfix” releases of older versions, so the
stability of existing releases gradually improves.  Bugfix releases,
indicated by a third component of the version number (e.g.  3.5.3,
3.6.2), are managed for stability; only fixes for known problems are
included in a bugfix release, and it’s guaranteed that interfaces will
remain the same throughout a series of bugfix releases.

The latest stable releases can always be found on the Python download
page(1).  There are two production-ready versions of Python: 2.x and
3.x.  The recommended version is 3.x, which is supported by most widely
used libraries.  Although 2.x is still widely used, it will not be
maintained after January 1, 2020(2).

   ---------- Footnotes ----------

   (1) https://www.python.org/downloads/

   (2) https://www.python.org/dev/peps/pep-0373/


File: python.info,  Node: How many people are using Python?,  Next: Have any significant projects been done in Python?,  Prev: How stable is Python?,  Up: Python in the real world

11.1.2.2 How many people are using Python?
..........................................

There are probably tens of thousands of users, though it’s difficult to
obtain an exact count.

Python is available for free download, so there are no sales figures,
and it’s available from many different sites and packaged with many
Linux distributions, so download statistics don’t tell the whole story
either.

The comp.lang.python newsgroup is very active, but not all Python users
post to the group or even read it.


File: python.info,  Node: Have any significant projects been done in Python?,  Next: What new developments are expected for Python in the future?,  Prev: How many people are using Python?,  Up: Python in the real world

11.1.2.3 Have any significant projects been done in Python?
...........................................................

See ‘https://www.python.org/about/success’ for a list of projects that
use Python.  Consulting the proceedings for past Python conferences(1)
will reveal contributions from many different companies and
organizations.

High-profile Python projects include the Mailman mailing list manager(2)
and the Zope application server(3).  Several Linux distributions, most
notably Red Hat(4), have written part or all of their installer and
system administration software in Python.  Companies that use Python
internally include Google, Yahoo, and Lucasfilm Ltd.

   ---------- Footnotes ----------

   (1) https://www.python.org/community/workshops/

   (2) http://www.list.org

   (3) http://www.zope.org

   (4) https://www.redhat.com


File: python.info,  Node: What new developments are expected for Python in the future?,  Next: Is it reasonable to propose incompatible changes to Python?,  Prev: Have any significant projects been done in Python?,  Up: Python in the real world

11.1.2.4 What new developments are expected for Python in the future?
.....................................................................

See ‘https://www.python.org/dev/peps/’ for the Python Enhancement
Proposals (PEPs).  PEPs are design documents describing a suggested new
feature for Python, providing a concise technical specification and a
rationale.  Look for a PEP titled “Python X.Y Release Schedule”, where
X.Y is a version that hasn’t been publicly released yet.

New development is discussed on the python-dev mailing list(1).

   ---------- Footnotes ----------

   (1) https://mail.python.org/mailman/listinfo/python-dev/


File: python.info,  Node: Is it reasonable to propose incompatible changes to Python?,  Next: Is Python a good language for beginning programmers?,  Prev: What new developments are expected for Python in the future?,  Up: Python in the real world

11.1.2.5 Is it reasonable to propose incompatible changes to Python?
....................................................................

In general, no.  There are already millions of lines of Python code
around the world, so any change in the language that invalidates more
than a very small fraction of existing programs has to be frowned upon.
Even if you can provide a conversion program, there’s still the problem
of updating all documentation; many books have been written about
Python, and we don’t want to invalidate them all at a single stroke.

Providing a gradual upgrade path is necessary if a feature has to be
changed.  PEP 5(1) describes the procedure followed for introducing
backward-incompatible changes while minimizing disruption for users.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0005


File: python.info,  Node: Is Python a good language for beginning programmers?,  Prev: Is it reasonable to propose incompatible changes to Python?,  Up: Python in the real world

11.1.2.6 Is Python a good language for beginning programmers?
.............................................................

Yes.

It is still common to start students with a procedural and statically
typed language such as Pascal, C, or a subset of C++ or Java.  Students
may be better served by learning Python as their first language.  Python
has a very simple and consistent syntax and a large standard library
and, most importantly, using Python in a beginning programming course
lets students concentrate on important programming skills such as
problem decomposition and data type design.  With Python, students can
be quickly introduced to basic concepts such as loops and procedures.
They can probably even work with user-defined objects in their very
first course.

For a student who has never programmed before, using a statically typed
language seems unnatural.  It presents additional complexity that the
student must master and slows the pace of the course.  The students are
trying to learn to think like a computer, decompose problems, design
consistent interfaces, and encapsulate data.  While learning to use a
statically typed language is important in the long term, it is not
necessarily the best topic to address in the students’ first programming
course.

Many other aspects of Python make it a good first language.  Like Java,
Python has a large standard library so that students can be assigned
programming projects very early in the course that `do' something.
Assignments aren’t restricted to the standard four-function calculator
and check balancing programs.  By using the standard library, students
can gain the satisfaction of working on realistic applications as they
learn the fundamentals of programming.  Using the standard library also
teaches students about code reuse.  Third-party modules such as PyGame
are also helpful in extending the students’ reach.

Python’s interactive interpreter enables students to test language
features while they’re programming.  They can keep a window with the
interpreter running while they enter their program’s source in another
window.  If they can’t remember the methods for a list, they can do
something like this:

     >>> L = [] >>> dir(L)  ['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort'] >>> [d for d in dir(L) if '__' not in d] ['append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']  >>> help(L.append) Help on built-in function append:  append(...)     L.append(object) -> None -- append object to end  >>> L.append(1) >>> L [1]

With the interpreter, documentation is never far from the student as
they are programming.

There are also good IDEs for Python.  IDLE is a cross-platform IDE for
Python that is written in Python using Tkinter.  PythonWin is a
Windows-specific IDE. Emacs users will be happy to know that there is a
very good Python mode for Emacs.  All of these programming environments
provide syntax highlighting, auto-indenting, and access to the
interactive interpreter while coding.  Consult the Python wiki(1) for a
full list of Python editing environments.

If you want to discuss Python’s use in education, you may be interested
in joining the edu-sig mailing list(2).

   ---------- Footnotes ----------

   (1) https://wiki.python.org/moin/PythonEditors

   (2) https://www.python.org/community/sigs/current/edu-sig


File: python.info,  Node: Programming FAQ,  Next: Design and History FAQ,  Prev: General Python FAQ,  Up: Python Frequently Asked Questions

11.2 Programming FAQ
====================

* Menu:

* General Questions::
* Core Language::
* Numbers and strings::
* Performance: Performance<4>.
* Sequences (Tuples/Lists): Sequences Tuples/Lists.
* Objects::
* Modules: Modules<3>.


File: python.info,  Node: General Questions,  Next: Core Language,  Up: Programming FAQ

11.2.1 General Questions
------------------------

* Menu:

* Is there a source code level debugger with breakpoints, single-stepping, etc.?: Is there a source code level debugger with breakpoints single-stepping etc ?.
* Is there a tool to help find bugs or perform static analysis?::
* How can I create a stand-alone binary from a Python script?::
* Are there coding standards or a style guide for Python programs?::


File: python.info,  Node: Is there a source code level debugger with breakpoints single-stepping etc ?,  Next: Is there a tool to help find bugs or perform static analysis?,  Up: General Questions

11.2.1.1 Is there a source code level debugger with breakpoints, single-stepping, etc.?
.......................................................................................

Yes.

Several debuggers for Python are described below, and the built-in
function *note breakpoint(): 2ee. allows you to drop into any of them.

The pdb module is a simple but adequate console-mode debugger for
Python.  It is part of the standard Python library, and is *note
documented in the Library Reference Manual: c9.  You can also write your
own debugger by using the code for pdb as an example.

The IDLE interactive development environment, which is part of the
standard Python distribution (normally available as Tools/scripts/idle),
includes a graphical debugger.

PythonWin is a Python IDE that includes a GUI debugger based on pdb.
The Pythonwin debugger colors breakpoints and has quite a few cool
features such as debugging non-Pythonwin programs.  Pythonwin is
available as part of the Python for Windows Extensions(1) project and as
a part of the ActivePython distribution (see
‘https://www.activestate.com/activepython’).

Boa Constructor(2) is an IDE and GUI builder that uses wxWidgets.  It
offers visual frame creation and manipulation, an object inspector, many
views on the source like object browsers, inheritance hierarchies, doc
string generated html documentation, an advanced debugger, integrated
help, and Zope support.

Eric(3) is an IDE built on PyQt and the Scintilla editing component.

Pydb is a version of the standard Python debugger pdb, modified for use
with DDD (Data Display Debugger), a popular graphical debugger front
end.  Pydb can be found at ‘http://bashdb.sourceforge.net/pydb/’ and DDD
can be found at ‘https://www.gnu.org/software/ddd’.

There are a number of commercial Python IDEs that include graphical
debuggers.  They include:

   * Wing IDE (‘https://wingware.com/’)

   * Komodo IDE (‘https://komodoide.com/’)

   * PyCharm (‘https://www.jetbrains.com/pycharm/’)

   ---------- Footnotes ----------

   (1) https://sourceforge.net/projects/pywin32/

   (2) http://boa-constructor.sourceforge.net/

   (3) http://eric-ide.python-projects.org/


File: python.info,  Node: Is there a tool to help find bugs or perform static analysis?,  Next: How can I create a stand-alone binary from a Python script?,  Prev: Is there a source code level debugger with breakpoints single-stepping etc ?,  Up: General Questions

11.2.1.2 Is there a tool to help find bugs or perform static analysis?
......................................................................

Yes.

PyChecker is a static analysis tool that finds bugs in Python source
code and warns about code complexity and style.  You can get PyChecker
from ‘http://pychecker.sourceforge.net/’.

Pylint(1) is another tool that checks if a module satisfies a coding
standard, and also makes it possible to write plug-ins to add a custom
feature.  In addition to the bug checking that PyChecker performs,
Pylint offers some additional features such as checking line length,
whether variable names are well-formed according to your coding
standard, whether declared interfaces are fully implemented, and more.
‘https://docs.pylint.org/’ provides a full list of Pylint’s features.

Static type checkers such as Mypy(2), Pyre(3), and Pytype(4) can check
type hints in Python source code.

   ---------- Footnotes ----------

   (1) https://www.pylint.org/

   (2) http://mypy-lang.org/

   (3) https://pyre-check.org/

   (4) https://github.com/google/pytype


File: python.info,  Node: How can I create a stand-alone binary from a Python script?,  Next: Are there coding standards or a style guide for Python programs?,  Prev: Is there a tool to help find bugs or perform static analysis?,  Up: General Questions

11.2.1.3 How can I create a stand-alone binary from a Python script?
....................................................................

You don’t need the ability to compile Python to C code if all you want
is a stand-alone program that users can download and run without having
to install the Python distribution first.  There are a number of tools
that determine the set of modules required by a program and bind these
modules together with a Python binary to produce a single executable.

One is to use the freeze tool, which is included in the Python source
tree as ‘Tools/freeze’.  It converts Python byte code to C arrays; a C
compiler you can embed all your modules into a new program, which is
then linked with the standard Python modules.

It works by scanning your source recursively for import statements (in
both forms) and looking for the modules in the standard Python path as
well as in the source directory (for built-in modules).  It then turns
the bytecode for modules written in Python into C code (array
initializers that can be turned into code objects using the marshal
module) and creates a custom-made config file that only contains those
built-in modules which are actually used in the program.  It then
compiles the generated C code and links it with the rest of the Python
interpreter to form a self-contained binary which acts exactly like your
script.

Obviously, freeze requires a C compiler.  There are several other
utilities which don’t.  One is Thomas Heller’s py2exe (Windows only) at

     ‘http://www.py2exe.org/’

Another tool is Anthony Tuininga’s cx_Freeze(1).

   ---------- Footnotes ----------

   (1) https://anthony-tuininga.github.io/cx_Freeze/


File: python.info,  Node: Are there coding standards or a style guide for Python programs?,  Prev: How can I create a stand-alone binary from a Python script?,  Up: General Questions

11.2.1.4 Are there coding standards or a style guide for Python programs?
.........................................................................

Yes.  The coding style required for standard library modules is
documented as PEP 8(1).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0008


File: python.info,  Node: Core Language,  Next: Numbers and strings,  Prev: General Questions,  Up: Programming FAQ

11.2.2 Core Language
--------------------

* Menu:

* Why am I getting an UnboundLocalError when the variable has a value?::
* What are the rules for local and global variables in Python?::
* Why do lambdas defined in a loop with different values all return the same result?::
* How do I share global variables across modules?::
* What are the “best practices” for using import in a module?::
* Why are default values shared between objects?::
* How can I pass optional or keyword parameters from one function to another?::
* What is the difference between arguments and parameters?::
* Why did changing list ‘y’ also change list ‘x’?::
* How do I write a function with output parameters (call by reference)?: How do I write a function with output parameters call by reference ?.
* How do you make a higher order function in Python?::
* How do I copy an object in Python?::
* How can I find the methods or attributes of an object?::
* How can my code discover the name of an object?::
* What’s up with the comma operator’s precedence?::
* Is there an equivalent of C’s “?;” ternary operator?: Is there an equivalent of C’s “? ” ternary operator?.
* Is it possible to write obfuscated one-liners in Python?::
* What does the slash(/) in the parameter list of a function mean?: What does the slash / in the parameter list of a function mean?.


File: python.info,  Node: Why am I getting an UnboundLocalError when the variable has a value?,  Next: What are the rules for local and global variables in Python?,  Up: Core Language

11.2.2.1 Why am I getting an UnboundLocalError when the variable has a value?
.............................................................................

It can be a surprise to get the UnboundLocalError in previously working
code when it is modified by adding an assignment statement somewhere in
the body of a function.

This code:

     >>> x = 10 >>> def bar(): ...     print(x) >>> bar() 10

works, but this code:

     >>> x = 10 >>> def foo(): ...     print(x) ...     x += 1

results in an UnboundLocalError:

     >>> foo() Traceback (most recent call last):   ... UnboundLocalError: local variable 'x' referenced before assignment

This is because when you make an assignment to a variable in a scope,
that variable becomes local to that scope and shadows any similarly
named variable in the outer scope.  Since the last statement in foo
assigns a new value to ‘x’, the compiler recognizes it as a local
variable.  Consequently when the earlier ‘print(x)’ attempts to print
the uninitialized local variable and an error results.

In the example above you can access the outer scope variable by
declaring it global:

     >>> x = 10 >>> def foobar(): ...     global x ...     print(x) ...     x += 1 >>> foobar() 10

This explicit declaration is required in order to remind you that
(unlike the superficially analogous situation with class and instance
variables) you are actually modifying the value of the variable in the
outer scope:

     >>> print(x) 11

You can do a similar thing in a nested scope using the *note nonlocal:
c32. keyword:

     >>> def foo(): ...    x = 10 ...    def bar(): ...        nonlocal x ...        print(x) ...        x += 1 ...    bar() ...    print(x) >>> foo() 10 11


File: python.info,  Node: What are the rules for local and global variables in Python?,  Next: Why do lambdas defined in a loop with different values all return the same result?,  Prev: Why am I getting an UnboundLocalError when the variable has a value?,  Up: Core Language

11.2.2.2 What are the rules for local and global variables in Python?
.....................................................................

In Python, variables that are only referenced inside a function are
implicitly global.  If a variable is assigned a value anywhere within
the function’s body, it’s assumed to be a local unless explicitly
declared as global.

Though a bit surprising at first, a moment’s consideration explains
this.  On one hand, requiring *note global: 117e. for assigned variables
provides a bar against unintended side-effects.  On the other hand, if
‘global’ was required for all global references, you’d be using ‘global’
all the time.  You’d have to declare as global every reference to a
built-in function or to a component of an imported module.  This clutter
would defeat the usefulness of the ‘global’ declaration for identifying
side-effects.


File: python.info,  Node: Why do lambdas defined in a loop with different values all return the same result?,  Next: How do I share global variables across modules?,  Prev: What are the rules for local and global variables in Python?,  Up: Core Language

11.2.2.3 Why do lambdas defined in a loop with different values all return the same result?
...........................................................................................

Assume you use a for loop to define a few different lambdas (or even
plain functions), e.g.:

     >>> squares = [] >>> for x in range(5): ...     squares.append(lambda: x**2)

This gives you a list that contains 5 lambdas that calculate ‘x**2’.
You might expect that, when called, they would return, respectively,
‘0’, ‘1’, ‘4’, ‘9’, and ‘16’.  However, when you actually try you will
see that they all return ‘16’:

     >>> squares[2]() 16 >>> squares[4]() 16

This happens because ‘x’ is not local to the lambdas, but is defined in
the outer scope, and it is accessed when the lambda is called — not when
it is defined.  At the end of the loop, the value of ‘x’ is ‘4’, so all
the functions now return ‘4**2’, i.e.  ‘16’.  You can also verify this
by changing the value of ‘x’ and see how the results of the lambdas
change:

     >>> x = 8 >>> squares[2]() 64

In order to avoid this, you need to save the values in variables local
to the lambdas, so that they don’t rely on the value of the global ‘x’:

     >>> squares = [] >>> for x in range(5): ...     squares.append(lambda n=x: n**2)

Here, ‘n=x’ creates a new variable ‘n’ local to the lambda and computed
when the lambda is defined so that it has the same value that ‘x’ had at
that point in the loop.  This means that the value of ‘n’ will be ‘0’ in
the first lambda, ‘1’ in the second, ‘2’ in the third, and so on.
Therefore each lambda will now return the correct result:

     >>> squares[2]() 4 >>> squares[4]() 16

Note that this behaviour is not peculiar to lambdas, but applies to
regular functions too.


File: python.info,  Node: How do I share global variables across modules?,  Next: What are the “best practices” for using import in a module?,  Prev: Why do lambdas defined in a loop with different values all return the same result?,  Up: Core Language

11.2.2.4 How do I share global variables across modules?
........................................................

The canonical way to share information across modules within a single
program is to create a special module (often called config or cfg).
Just import the config module in all modules of your application; the
module then becomes available as a global name.  Because there is only
one instance of each module, any changes made to the module object get
reflected everywhere.  For example:

config.py:

     x = 0   # Default value of the 'x' configuration setting

mod.py:

     import config config.x = 1

main.py:

     import config import mod print(config.x)

Note that using a module is also the basis for implementing the
Singleton design pattern, for the same reason.


File: python.info,  Node: What are the “best practices” for using import in a module?,  Next: Why are default values shared between objects?,  Prev: How do I share global variables across modules?,  Up: Core Language

11.2.2.5 What are the “best practices” for using import in a module?
....................................................................

In general, don’t use ‘from modulename import *’.  Doing so clutters the
importer’s namespace, and makes it much harder for linters to detect
undefined names.

Import modules at the top of a file.  Doing so makes it clear what other
modules your code requires and avoids questions of whether the module
name is in scope.  Using one import per line makes it easy to add and
delete module imports, but using multiple imports per line uses less
screen space.

It’s good practice if you import modules in the following order:

  1. standard library modules – e.g.  ‘sys’, ‘os’, ‘getopt’, ‘re’

  2. third-party library modules (anything installed in Python’s
     site-packages directory) – e.g.  mx.DateTime, ZODB, PIL.Image, etc.

  3. locally-developed modules

It is sometimes necessary to move imports to a function or class to
avoid problems with circular imports.  Gordon McMillan says:

     Circular imports are fine where both modules use the “import
     <module>” form of import.  They fail when the 2nd module wants to
     grab a name out of the first (“from module import name”) and the
     import is at the top level.  That’s because names in the 1st are
     not yet available, because the first module is busy importing the
     2nd.

In this case, if the second module is only used in one function, then
the import can easily be moved into that function.  By the time the
import is called, the first module will have finished initializing, and
the second module can do its import.

It may also be necessary to move imports out of the top level of code if
some of the modules are platform-specific.  In that case, it may not
even be possible to import all of the modules at the top of the file.
In this case, importing the correct modules in the corresponding
platform-specific code is a good option.

Only move imports into a local scope, such as inside a function
definition, if it’s necessary to solve a problem such as avoiding a
circular import or are trying to reduce the initialization time of a
module.  This technique is especially helpful if many of the imports are
unnecessary depending on how the program executes.  You may also want to
move imports into a function if the modules are only ever used in that
function.  Note that loading a module the first time may be expensive
because of the one time initialization of the module, but loading a
module multiple times is virtually free, costing only a couple of
dictionary lookups.  Even if the module name has gone out of scope, the
module is probably available in *note sys.modules: 13eb.


File: python.info,  Node: Why are default values shared between objects?,  Next: How can I pass optional or keyword parameters from one function to another?,  Prev: What are the “best practices” for using import in a module?,  Up: Core Language

11.2.2.6 Why are default values shared between objects?
.......................................................

This type of bug commonly bites neophyte programmers.  Consider this
function:

     def foo(mydict={}):  # Danger: shared reference to one dict for all calls     ... compute something ...     mydict[key] = value     return mydict

The first time you call this function, ‘mydict’ contains a single item.
The second time, ‘mydict’ contains two items because when ‘foo()’ begins
executing, ‘mydict’ starts out with an item already in it.

It is often expected that a function call creates new objects for
default values.  This is not what happens.  Default values are created
exactly once, when the function is defined.  If that object is changed,
like the dictionary in this example, subsequent calls to the function
will refer to this changed object.

By definition, immutable objects such as numbers, strings, tuples, and
‘None’, are safe from change.  Changes to mutable objects such as
dictionaries, lists, and class instances can lead to confusion.

Because of this feature, it is good programming practice to not use
mutable objects as default values.  Instead, use ‘None’ as the default
value and inside the function, check if the parameter is ‘None’ and
create a new list/dictionary/whatever if it is.  For example, don’t
write:

     def foo(mydict={}):     ...

but:

     def foo(mydict=None):     if mydict is None:         mydict = {}  # create a new dict for local namespace

This feature can be useful.  When you have a function that’s
time-consuming to compute, a common technique is to cache the parameters
and the resulting value of each call to the function, and return the
cached value if the same value is requested again.  This is called
“memoizing”, and can be implemented like this:

     # Callers can only provide two parameters and optionally pass _cache by keyword def expensive(arg1, arg2, *, _cache={}):     if (arg1, arg2) in _cache:         return _cache[(arg1, arg2)]      # Calculate the value     result = ... expensive computation ...     _cache[(arg1, arg2)] = result           # Store result in the cache     return result

You could use a global variable containing a dictionary instead of the
default value; it’s a matter of taste.


File: python.info,  Node: How can I pass optional or keyword parameters from one function to another?,  Next: What is the difference between arguments and parameters?,  Prev: Why are default values shared between objects?,  Up: Core Language

11.2.2.7 How can I pass optional or keyword parameters from one function to another?
....................................................................................

Collect the arguments using the ‘*’ and ‘**’ specifiers in the
function’s parameter list; this gives you the positional arguments as a
tuple and the keyword arguments as a dictionary.  You can then pass
these arguments when calling another function by using ‘*’ and ‘**’:

     def f(x, *args, **kwargs):     ...     kwargs['width'] = '14.3c'     ...     g(x, *args, **kwargs)


File: python.info,  Node: What is the difference between arguments and parameters?,  Next: Why did changing list ‘y’ also change list ‘x’?,  Prev: How can I pass optional or keyword parameters from one function to another?,  Up: Core Language

11.2.2.8 What is the difference between arguments and parameters?
.................................................................

*note Parameters: 1469. are defined by the names that appear in a
function definition, whereas *note arguments: 1462. are the values
actually passed to a function when calling it.  Parameters define what
types of arguments a function can accept.  For example, given the
function definition:

     def func(foo, bar=None, **kwargs):     pass

`foo', `bar' and `kwargs' are parameters of ‘func’.  However, when
calling ‘func’, for example:

     func(42, bar=314, extra=somevar)

the values ‘42’, ‘314’, and ‘somevar’ are arguments.


File: python.info,  Node: Why did changing list ‘y’ also change list ‘x’?,  Next: How do I write a function with output parameters call by reference ?,  Prev: What is the difference between arguments and parameters?,  Up: Core Language

11.2.2.9 Why did changing list ‘y’ also change list ‘x’?
........................................................

If you wrote code like:

     >>> x = [] >>> y = x >>> y.append(10) >>> y [10] >>> x [10]

you might be wondering why appending an element to ‘y’ changed ‘x’ too.

There are two factors that produce this result:

  1. Variables are simply names that refer to objects.  Doing ‘y = x’
     doesn’t create a copy of the list – it creates a new variable ‘y’
     that refers to the same object ‘x’ refers to.  This means that
     there is only one object (the list), and both ‘x’ and ‘y’ refer to
     it.

  2. Lists are *note mutable: 1164, which means that you can change
     their content.

After the call to ‘append()’, the content of the mutable object has
changed from ‘[]’ to ‘[10]’.  Since both the variables refer to the same
object, using either name accesses the modified value ‘[10]’.

If we instead assign an immutable object to ‘x’:

     >>> x = 5  # ints are immutable >>> y = x >>> x = x + 1  # 5 can't be mutated, we are creating a new object here >>> x 6 >>> y 5

we can see that in this case ‘x’ and ‘y’ are not equal anymore.  This is
because integers are *note immutable: 115c, and when we do ‘x = x + 1’
we are not mutating the int ‘5’ by incrementing its value; instead, we
are creating a new object (the int ‘6’) and assigning it to ‘x’ (that
is, changing which object ‘x’ refers to).  After this assignment we have
two objects (the ints ‘6’ and ‘5’) and two variables that refer to them
(‘x’ now refers to ‘6’ but ‘y’ still refers to ‘5’).

Some operations (for example ‘y.append(10)’ and ‘y.sort()’) mutate the
object, whereas superficially similar operations (for example ‘y = y +
[10]’ and ‘sorted(y)’) create a new object.  In general in Python (and
in all cases in the standard library) a method that mutates an object
will return ‘None’ to help avoid getting the two types of operations
confused.  So if you mistakenly write ‘y.sort()’ thinking it will give
you a sorted copy of ‘y’, you’ll instead end up with ‘None’, which will
likely cause your program to generate an easily diagnosed error.

However, there is one class of operations where the same operation
sometimes has different behaviors with different types: the augmented
assignment operators.  For example, ‘+=’ mutates lists but not tuples or
ints (‘a_list += [1, 2, 3]’ is equivalent to ‘a_list.extend([1, 2, 3])’
and mutates ‘a_list’, whereas ‘some_tuple += (1, 2, 3)’ and ‘some_int +=
1’ create new objects).

In other words:

   * If we have a mutable object (*note list: 260, *note dict: 1b6,
     *note set: b62, etc.), we can use some specific operations to
     mutate it and all the variables that refer to it will see the
     change.

   * If we have an immutable object (*note str: 325, *note int: 184,
     *note tuple: 473, etc.), all the variables that refer to it will
     always see the same value, but operations that transform that value
     into a new value always return a new object.

If you want to know if two variables refer to the same object or not,
you can use the *note is: 135a. operator, or the built-in function *note
id(): d79.


File: python.info,  Node: How do I write a function with output parameters call by reference ?,  Next: How do you make a higher order function in Python?,  Prev: Why did changing list ‘y’ also change list ‘x’?,  Up: Core Language

11.2.2.10 How do I write a function with output parameters (call by reference)?
...............................................................................

Remember that arguments are passed by assignment in Python.  Since
assignment just creates references to objects, there’s no alias between
an argument name in the caller and callee, and so no call-by-reference
per se.  You can achieve the desired effect in a number of ways.

  1. By returning a tuple of the results:

          def func2(a, b):     a = 'new-value'        # a and b are local names     b = b + 1              # assigned to new objects     return a, b            # return new values  x, y = 'old-value', 99 x, y = func2(x, y) print(x, y)                # output: new-value 100

     This is almost always the clearest solution.

  2. By using global variables.  This isn’t thread-safe, and is not
     recommended.

  3. By passing a mutable (changeable in-place) object:

          def func1(a):     a[0] = 'new-value'     # 'a' references a mutable list     a[1] = a[1] + 1        # changes a shared object  args = ['old-value', 99] func1(args) print(args[0], args[1])    # output: new-value 100

  4. By passing in a dictionary that gets mutated:

          def func3(args):     args['a'] = 'new-value'     # args is a mutable dictionary     args['b'] = args['b'] + 1   # change it in-place  args = {'a': 'old-value', 'b': 99} func3(args) print(args['a'], args['b'])

  5. Or bundle up values in a class instance:

          class callByRef:     def __init__(self, /, **args):         for key, value in args.items():             setattr(self, key, value)  def func4(args):     args.a = 'new-value'        # args is a mutable callByRef     args.b = args.b + 1         # change object in-place  args = callByRef(a='old-value', b=99) func4(args) print(args.a, args.b)

     There’s almost never a good reason to get this complicated.

Your best choice is to return a tuple containing the multiple results.


File: python.info,  Node: How do you make a higher order function in Python?,  Next: How do I copy an object in Python?,  Prev: How do I write a function with output parameters call by reference ?,  Up: Core Language

11.2.2.11 How do you make a higher order function in Python?
............................................................

You have two choices: you can use nested scopes or you can use callable
objects.  For example, suppose you wanted to define ‘linear(a,b)’ which
returns a function ‘f(x)’ that computes the value ‘a*x+b’.  Using nested
scopes:

     def linear(a, b):     def result(x):         return a * x + b     return result

Or using a callable object:

     class linear:      def __init__(self, a, b):         self.a, self.b = a, b      def __call__(self, x):         return self.a * x + self.b

In both cases,

     taxes = linear(0.3, 2)

gives a callable object where ‘taxes(10e6) == 0.3 * 10e6 + 2’.

The callable object approach has the disadvantage that it is a bit
slower and results in slightly longer code.  However, note that a
collection of callables can share their signature via inheritance:

     class exponential(linear):     # __init__ inherited     def __call__(self, x):         return self.a * (x ** self.b)

Object can encapsulate state for several methods:

     class counter:      value = 0      def set(self, x):         self.value = x      def up(self):         self.value = self.value + 1      def down(self):         self.value = self.value - 1  count = counter() inc, dec, reset = count.up, count.down, count.set

Here ‘inc()’, ‘dec()’ and ‘reset()’ act like functions which share the
same counting variable.


File: python.info,  Node: How do I copy an object in Python?,  Next: How can I find the methods or attributes of an object?,  Prev: How do you make a higher order function in Python?,  Up: Core Language

11.2.2.12 How do I copy an object in Python?
............................................

In general, try *note copy.copy(): 3c0. or *note copy.deepcopy(): 3c1.
for the general case.  Not all objects can be copied, but most can.

Some objects can be copied more easily.  Dictionaries have a *note
copy(): 43b. method:

     newdict = olddict.copy()

Sequences can be copied by slicing:

     new_l = l[:]


File: python.info,  Node: How can I find the methods or attributes of an object?,  Next: How can my code discover the name of an object?,  Prev: How do I copy an object in Python?,  Up: Core Language

11.2.2.13 How can I find the methods or attributes of an object?
................................................................

For an instance x of a user-defined class, ‘dir(x)’ returns an
alphabetized list of the names containing the instance attributes and
methods and attributes defined by its class.


File: python.info,  Node: How can my code discover the name of an object?,  Next: What’s up with the comma operator’s precedence?,  Prev: How can I find the methods or attributes of an object?,  Up: Core Language

11.2.2.14 How can my code discover the name of an object?
.........................................................

Generally speaking, it can’t, because objects don’t really have names.
Essentially, assignment always binds a name to a value; the same is true
of ‘def’ and ‘class’ statements, but in that case the value is a
callable.  Consider the following code:

     >>> class A: ...     pass ... >>> B = A >>> a = B() >>> b = a >>> print(b) <__main__.A object at 0x16D07CC> >>> print(a) <__main__.A object at 0x16D07CC>

Arguably the class has a name: even though it is bound to two names and
invoked through the name B the created instance is still reported as an
instance of class A. However, it is impossible to say whether the
instance’s name is a or b, since both names are bound to the same value.

Generally speaking it should not be necessary for your code to “know the
names” of particular values.  Unless you are deliberately writing
introspective programs, this is usually an indication that a change of
approach might be beneficial.

In comp.lang.python, Fredrik Lundh once gave an excellent analogy in
answer to this question:

     The same way as you get the name of that cat you found on your
     porch: the cat (object) itself cannot tell you its name, and it
     doesn’t really care – so the only way to find out what it’s called
     is to ask all your neighbours (namespaces) if it’s their cat
     (object)…

     ….and don’t be surprised if you’ll find that it’s known by many
     names, or no name at all!


File: python.info,  Node: What’s up with the comma operator’s precedence?,  Next: Is there an equivalent of C’s “? ” ternary operator?,  Prev: How can my code discover the name of an object?,  Up: Core Language

11.2.2.15 What’s up with the comma operator’s precedence?
.........................................................

Comma is not an operator in Python.  Consider this session:

     >>> "a" in "b", "a" (False, 'a')

Since the comma is not an operator, but a separator between expressions
the above is evaluated as if you had entered:

     ("a" in "b"), "a"

not:

     "a" in ("b", "a")

The same is true of the various assignment operators (‘=’, ‘+=’ etc).
They are not truly operators but syntactic delimiters in assignment
statements.


File: python.info,  Node: Is there an equivalent of C’s “? ” ternary operator?,  Next: Is it possible to write obfuscated one-liners in Python?,  Prev: What’s up with the comma operator’s precedence?,  Up: Core Language

11.2.2.16 Is there an equivalent of C’s “?:” ternary operator?
..............................................................

Yes, there is.  The syntax is as follows:

     [on_true] if [expression] else [on_false]  x, y = 50, 25 small = x if x < y else y

Before this syntax was introduced in Python 2.5, a common idiom was to
use logical operators:

     [expression] and [on_true] or [on_false]

However, this idiom is unsafe, as it can give wrong results when
`on_true' has a false boolean value.  Therefore, it is always better to
use the ‘... if ... else ...’ form.


File: python.info,  Node: Is it possible to write obfuscated one-liners in Python?,  Next: What does the slash / in the parameter list of a function mean?,  Prev: Is there an equivalent of C’s “? ” ternary operator?,  Up: Core Language

11.2.2.17 Is it possible to write obfuscated one-liners in Python?
..................................................................

Yes.  Usually this is done by nesting *note lambda: c22. within
‘lambda’.  See the following three examples, due to Ulf Bartelt:

     from functools import reduce  # Primes < 1000 print(list(filter(None,map(lambda y:y*reduce(lambda x,y:x*y!=0, map(lambda x,y=y:y%x,range(2,int(pow(y,0.5)+1))),1),range(2,1000)))))  # First 10 Fibonacci numbers print(list(map(lambda x,f=lambda x,f:(f(x-1,f)+f(x-2,f)) if x>1 else 1: f(x,f), range(10))))  # Mandelbrot set print((lambda Ru,Ro,Iu,Io,IM,Sx,Sy:reduce(lambda x,y:x+y,map(lambda y, Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,Sy=Sy,L=lambda yc,Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,i=IM, Sx=Sx,Sy=Sy:reduce(lambda x,y:x+y,map(lambda x,xc=Ru,yc=yc,Ru=Ru,Ro=Ro, i=i,Sx=Sx,F=lambda xc,yc,x,y,k,f=lambda xc,yc,x,y,k,f:(k<=0)or (x*x+y*y >=4.0) or 1+f(xc,yc,x*x-y*y+xc,2.0*x*y+yc,k-1,f):f(xc,yc,x,y,k,f):chr( 64+F(Ru+x*(Ro-Ru)/Sx,yc,0,0,i)),range(Sx))):L(Iu+y*(Io-Iu)/Sy),range(Sy ))))(-2.1, 0.7, -1.2, 1.2, 30, 80, 24)) #    \___ ___/  \___ ___/  |   |   |__ lines on screen #        V          V      |   |______ columns on screen #        |          |      |__________ maximum of "iterations" #        |          |_________________ range on y axis #        |____________________________ range on x axis

Don’t try this at home, kids!


File: python.info,  Node: What does the slash / in the parameter list of a function mean?,  Prev: Is it possible to write obfuscated one-liners in Python?,  Up: Core Language

11.2.2.18 What does the slash(/) in the parameter list of a function mean?
..........................................................................

A slash in the argument list of a function denotes that the parameters
prior to it are positional-only.  Positional-only parameters are the
ones without an externally-usable name.  Upon calling a function that
accepts positional-only parameters, arguments are mapped to parameters
based solely on their position.  For example, *note divmod(): f4d. is a
function that accepts positional-only parameters.  Its documentation
looks like this:

     >>> help(divmod) Help on built-in function divmod in module builtins:  divmod(x, y, /)     Return the tuple (x//y, x%y).  Invariant: div*y + mod == x.

The slash at the end of the parameter list means that both parameters
are positional-only.  Thus, calling *note divmod(): f4d. with keyword
arguments would lead to an error:

     >>> divmod(x=3, y=4) Traceback (most recent call last):   File "<stdin>", line 1, in <module> TypeError: divmod() takes no keyword arguments


File: python.info,  Node: Numbers and strings,  Next: Performance<4>,  Prev: Core Language,  Up: Programming FAQ

11.2.3 Numbers and strings
--------------------------

* Menu:

* How do I specify hexadecimal and octal integers?::
* Why does -22 // 10 return -3?::
* How do I convert a string to a number?::
* How do I convert a number to a string?::
* How do I modify a string in place?::
* How do I use strings to call functions/methods?::
* Is there an equivalent to Perl’s chomp() for removing trailing newlines from strings?: Is there an equivalent to Perl’s chomp for removing trailing newlines from strings?.
* Is there a scanf() or sscanf() equivalent?: Is there a scanf or sscanf equivalent?.
* What does ‘UnicodeDecodeError’ or ‘UnicodeEncodeError’ error mean?::


File: python.info,  Node: How do I specify hexadecimal and octal integers?,  Next: Why does -22 // 10 return -3?,  Up: Numbers and strings

11.2.3.1 How do I specify hexadecimal and octal integers?
.........................................................

To specify an octal digit, precede the octal value with a zero, and then
a lower or uppercase “o”.  For example, to set the variable “a” to the
octal value “10” (8 in decimal), type:

     >>> a = 0o10 >>> a 8

Hexadecimal is just as easy.  Simply precede the hexadecimal number with
a zero, and then a lower or uppercase “x”.  Hexadecimal digits can be
specified in lower or uppercase.  For example, in the Python
interpreter:

     >>> a = 0xa5 >>> a 165 >>> b = 0XB2 >>> b 178


File: python.info,  Node: Why does -22 // 10 return -3?,  Next: How do I convert a string to a number?,  Prev: How do I specify hexadecimal and octal integers?,  Up: Numbers and strings

11.2.3.2 Why does -22 // 10 return -3?
......................................

It’s primarily driven by the desire that ‘i % j’ have the same sign as
‘j’.  If you want that, and also want:

     i == (i // j) * j + (i % j)

then integer division has to return the floor.  C also requires that
identity to hold, and then compilers that truncate ‘i // j’ need to make
‘i % j’ have the same sign as ‘i’.

There are few real use cases for ‘i % j’ when ‘j’ is negative.  When ‘j’
is positive, there are many, and in virtually all of them it’s more
useful for ‘i % j’ to be ‘>= 0’.  If the clock says 10 now, what did it
say 200 hours ago?  ‘-190 % 12 == 2’ is useful; ‘-190 % 12 == -10’ is a
bug waiting to bite.


File: python.info,  Node: How do I convert a string to a number?,  Next: How do I convert a number to a string?,  Prev: Why does -22 // 10 return -3?,  Up: Numbers and strings

11.2.3.3 How do I convert a string to a number?
...............................................

For integers, use the built-in *note int(): 184. type constructor, e.g.
‘int('144') == 144’.  Similarly, *note float(): 187. converts to
floating-point, e.g.  ‘float('144') == 144.0’.

By default, these interpret the number as decimal, so that ‘int('0144')
== 144’ and ‘int('0x144')’ raises *note ValueError: 1f9.  ‘int(string,
base)’ takes the base to convert from as a second optional argument, so
‘int('0x144', 16) == 324’.  If the base is specified as 0, the number is
interpreted using Python’s rules: a leading ‘0o’ indicates octal, and
‘0x’ indicates a hex number.

Do not use the built-in function *note eval(): b83. if all you need is
to convert strings to numbers.  *note eval(): b83. will be significantly
slower and it presents a security risk: someone could pass you a Python
expression that might have unwanted side effects.  For example, someone
could pass ‘__import__('os').system("rm -rf $HOME")’ which would erase
your home directory.

*note eval(): b83. also has the effect of interpreting numbers as Python
expressions, so that e.g.  ‘eval('09')’ gives a syntax error because
Python does not allow leading ‘0’ in a decimal number (except ‘0’).


File: python.info,  Node: How do I convert a number to a string?,  Next: How do I modify a string in place?,  Prev: How do I convert a string to a number?,  Up: Numbers and strings

11.2.3.4 How do I convert a number to a string?
...............................................

To convert, e.g., the number 144 to the string ‘144’, use the built-in
type constructor *note str(): 325.  If you want a hexadecimal or octal
representation, use the built-in functions *note hex(): c59. or *note
oct(): c58.  For fancy formatting, see the *note Formatted string
literals: 15c. and *note Format String Syntax: d0d. sections, e.g.
‘"{:04d}".format(144)’ yields ‘'0144'’ and ‘"{:.3f}".format(1.0/3.0)’
yields ‘'0.333'’.


File: python.info,  Node: How do I modify a string in place?,  Next: How do I use strings to call functions/methods?,  Prev: How do I convert a number to a string?,  Up: Numbers and strings

11.2.3.5 How do I modify a string in place?
...........................................

You can’t, because strings are immutable.  In most situations, you
should simply construct a new string from the various parts you want to
assemble it from.  However, if you need an object with the ability to
modify in-place unicode data, try using an *note io.StringIO: 821.
object or the *note array: 7. module:

     >>> import io >>> s = "Hello, world" >>> sio = io.StringIO(s) >>> sio.getvalue() 'Hello, world' >>> sio.seek(7) 7 >>> sio.write("there!") 6 >>> sio.getvalue() 'Hello, there!'  >>> import array >>> a = array.array('u', s) >>> print(a) array('u', 'Hello, world') >>> a[0] = 'y' >>> print(a) array('u', 'yello, world') >>> a.tounicode() 'yello, world'


File: python.info,  Node: How do I use strings to call functions/methods?,  Next: Is there an equivalent to Perl’s chomp for removing trailing newlines from strings?,  Prev: How do I modify a string in place?,  Up: Numbers and strings

11.2.3.6 How do I use strings to call functions/methods?
........................................................

There are various techniques.

   * The best is to use a dictionary that maps strings to functions.
     The primary advantage of this technique is that the strings do not
     need to match the names of the functions.  This is also the primary
     technique used to emulate a case construct:

          def a():     pass  def b():     pass  dispatch = {'go': a, 'stop': b}  # Note lack of parens for funcs  dispatch[get_input()]()  # Note trailing parens to call function

   * Use the built-in function *note getattr(): 43d.:

          import foo getattr(foo, 'bar')()

     Note that *note getattr(): 43d. works on any object, including
     classes, class instances, modules, and so on.

     This is used in several places in the standard library, like this:

          class Foo:     def do_foo(self):         ...      def do_bar(self):         ...  f = getattr(foo_instance, 'do_' + opname) f()

   * Use *note locals(): 44a. or *note eval(): b83. to resolve the
     function name:

          def myFunc():     print("hello")  fname = "myFunc"  f = locals()[fname] f()  f = eval(fname) f()

     Note: Using *note eval(): b83. is slow and dangerous.  If you don’t
     have absolute control over the contents of the string, someone
     could pass a string that resulted in an arbitrary function being
     executed.


File: python.info,  Node: Is there an equivalent to Perl’s chomp for removing trailing newlines from strings?,  Next: Is there a scanf or sscanf equivalent?,  Prev: How do I use strings to call functions/methods?,  Up: Numbers and strings

11.2.3.7 Is there an equivalent to Perl’s chomp() for removing trailing newlines from strings?
..............................................................................................

You can use ‘S.rstrip("\r\n")’ to remove all occurrences of any line
terminator from the end of the string ‘S’ without removing other
trailing whitespace.  If the string ‘S’ represents more than one line,
with several empty lines at the end, the line terminators for all the
blank lines will be removed:

     >>> lines = ("line 1 \r\n" ...          "\r\n" ...          "\r\n") >>> lines.rstrip("\n\r") 'line 1 '

Since this is typically only desired when reading text one line at a
time, using ‘S.rstrip()’ this way works well.


File: python.info,  Node: Is there a scanf or sscanf equivalent?,  Next: What does ‘UnicodeDecodeError’ or ‘UnicodeEncodeError’ error mean?,  Prev: Is there an equivalent to Perl’s chomp for removing trailing newlines from strings?,  Up: Numbers and strings

11.2.3.8 Is there a scanf() or sscanf() equivalent?
...................................................

Not as such.

For simple input parsing, the easiest approach is usually to split the
line into whitespace-delimited words using the *note split(): 795.
method of string objects and then convert decimal strings to numeric
values using *note int(): 184. or *note float(): 187.  ‘split()’
supports an optional “sep” parameter which is useful if the line uses
something other than whitespace as a separator.

For more complicated input parsing, regular expressions are more
powerful than C’s ‘sscanf()’ and better suited for the task.


File: python.info,  Node: What does ‘UnicodeDecodeError’ or ‘UnicodeEncodeError’ error mean?,  Prev: Is there a scanf or sscanf equivalent?,  Up: Numbers and strings

11.2.3.9 What does ‘UnicodeDecodeError’ or ‘UnicodeEncodeError’ error mean?
...........................................................................

See the *note Unicode HOWTO: c2f.


File: python.info,  Node: Performance<4>,  Next: Sequences Tuples/Lists,  Prev: Numbers and strings,  Up: Programming FAQ

11.2.4 Performance
------------------

* Menu:

* My program is too slow. How do I speed it up?: My program is too slow How do I speed it up?.
* What is the most efficient way to concatenate many strings together?::


File: python.info,  Node: My program is too slow How do I speed it up?,  Next: What is the most efficient way to concatenate many strings together?,  Up: Performance<4>

11.2.4.1 My program is too slow. How do I speed it up?
......................................................

That’s a tough one, in general.  First, here are a list of things to
remember before diving further:

   * Performance characteristics vary across Python implementations.
     This FAQ focusses on *note CPython: 1372.

   * Behaviour can vary across operating systems, especially when
     talking about I/O or multi-threading.

   * You should always find the hot spots in your program `before'
     attempting to optimize any code (see the *note profile: d3.
     module).

   * Writing benchmark scripts will allow you to iterate quickly when
     searching for improvements (see the *note timeit: 10b. module).

   * It is highly recommended to have good code coverage (through unit
     testing or any other technique) before potentially introducing
     regressions hidden in sophisticated optimizations.

That being said, there are many tricks to speed up Python code.  Here
are some general principles which go a long way towards reaching
acceptable performance levels:

   * Making your algorithms faster (or changing to faster ones) can
     yield much larger benefits than trying to sprinkle
     micro-optimization tricks all over your code.

   * Use the right data structures.  Study documentation for the *note
     Built-in Types: 154f. and the *note collections: 1e. module.

   * When the standard library provides a primitive for doing something,
     it is likely (although not guaranteed) to be faster than any
     alternative you may come up with.  This is doubly true for
     primitives written in C, such as builtins and some extension types.
     For example, be sure to use either the *note list.sort(): 43a.
     built-in method or the related *note sorted(): 439. function to do
     sorting (and see the *note Sorting HOW TO: 153c. for examples of
     moderately advanced usage).

   * Abstractions tend to create indirections and force the interpreter
     to work more.  If the levels of indirection outweigh the amount of
     useful work done, your program will be slower.  You should avoid
     excessive abstraction, especially under the form of tiny functions
     or methods (which are also often detrimental to readability).

If you have reached the limit of what pure Python can allow, there are
tools to take you further away.  For example, Cython(1) can compile a
slightly modified version of Python code into a C extension, and can be
used on many different platforms.  Cython can take advantage of
compilation (and optional type annotations) to make your code
significantly faster than when interpreted.  If you are confident in
your C programming skills, you can also *note write a C extension
module: 1137. yourself.

See also
........

The wiki page devoted to performance tips(2).

   ---------- Footnotes ----------

   (1) http://cython.org

   (2) https://wiki.python.org/moin/PythonSpeed/PerformanceTips


File: python.info,  Node: What is the most efficient way to concatenate many strings together?,  Prev: My program is too slow How do I speed it up?,  Up: Performance<4>

11.2.4.2 What is the most efficient way to concatenate many strings together?
.............................................................................

*note str: 325. and *note bytes: 326. objects are immutable, therefore
concatenating many strings together is inefficient as each concatenation
creates a new object.  In the general case, the total runtime cost is
quadratic in the total string length.

To accumulate many *note str: 325. objects, the recommended idiom is to
place them into a list and call *note str.join(): 156d. at the end:

     chunks = [] for s in my_strings:     chunks.append(s) result = ''.join(chunks)

(another reasonably efficient idiom is to use *note io.StringIO: 821.)

To accumulate many *note bytes: 326. objects, the recommended idiom is
to extend a *note bytearray: 327. object using in-place concatenation
(the ‘+=’ operator):

     result = bytearray() for b in my_bytes_objects:     result += b


File: python.info,  Node: Sequences Tuples/Lists,  Next: Objects,  Prev: Performance<4>,  Up: Programming FAQ

11.2.5 Sequences (Tuples/Lists)
-------------------------------

* Menu:

* How do I convert between tuples and lists?::
* What’s a negative index?::
* How do I iterate over a sequence in reverse order?::
* How do you remove duplicates from a list?::
* How do you make an array in Python?::
* How do I create a multidimensional list?::
* How do I apply a method to a sequence of objects?::
* Why does a_tuple[i] += [‘item’] raise an exception when the addition works?::
* I want to do a complicated sort; can you do a Schwartzian Transform in Python?: I want to do a complicated sort can you do a Schwartzian Transform in Python?.
* How can I sort one list by values from another list?::


File: python.info,  Node: How do I convert between tuples and lists?,  Next: What’s a negative index?,  Up: Sequences Tuples/Lists

11.2.5.1 How do I convert between tuples and lists?
...................................................

The type constructor ‘tuple(seq)’ converts any sequence (actually, any
iterable) into a tuple with the same items in the same order.

For example, ‘tuple([1, 2, 3])’ yields ‘(1, 2, 3)’ and ‘tuple('abc')’
yields ‘('a', 'b', 'c')’.  If the argument is a tuple, it does not make
a copy but returns the same object, so it is cheap to call *note
tuple(): 473. when you aren’t sure that an object is already a tuple.

The type constructor ‘list(seq)’ converts any sequence or iterable into
a list with the same items in the same order.  For example, ‘list((1, 2,
3))’ yields ‘[1, 2, 3]’ and ‘list('abc')’ yields ‘['a', 'b', 'c']’.  If
the argument is a list, it makes a copy just like ‘seq[:]’ would.


File: python.info,  Node: What’s a negative index?,  Next: How do I iterate over a sequence in reverse order?,  Prev: How do I convert between tuples and lists?,  Up: Sequences Tuples/Lists

11.2.5.2 What’s a negative index?
.................................

Python sequences are indexed with positive numbers and negative numbers.
For positive numbers 0 is the first index 1 is the second index and so
forth.  For negative indices -1 is the last index and -2 is the
penultimate (next to last) index and so forth.  Think of ‘seq[-n]’ as
the same as ‘seq[len(seq)-n]’.

Using negative indices can be very convenient.  For example ‘S[:-1]’ is
all of the string except for its last character, which is useful for
removing the trailing newline from a string.


File: python.info,  Node: How do I iterate over a sequence in reverse order?,  Next: How do you remove duplicates from a list?,  Prev: What’s a negative index?,  Up: Sequences Tuples/Lists

11.2.5.3 How do I iterate over a sequence in reverse order?
...........................................................

Use the *note reversed(): 18e. built-in function, which is new in Python
2.4:

     for x in reversed(sequence):     ...  # do something with x ...

This won’t touch your original sequence, but build a new copy with
reversed order to iterate over.

With Python 2.3, you can use an extended slice syntax:

     for x in sequence[::-1]:     ...  # do something with x ...


File: python.info,  Node: How do you remove duplicates from a list?,  Next: How do you make an array in Python?,  Prev: How do I iterate over a sequence in reverse order?,  Up: Sequences Tuples/Lists

11.2.5.4 How do you remove duplicates from a list?
..................................................

See the Python Cookbook for a long discussion of many ways to do this:

     ‘https://code.activestate.com/recipes/52560/’

If you don’t mind reordering the list, sort it and then scan from the
end of the list, deleting duplicates as you go:

     if mylist:     mylist.sort()     last = mylist[-1]     for i in range(len(mylist)-2, -1, -1):         if last == mylist[i]:             del mylist[i]         else:             last = mylist[i]

If all elements of the list may be used as set keys (i.e.  they are all
*note hashable: 1364.) this is often faster

     mylist = list(set(mylist))

This converts the list into a set, thereby removing duplicates, and then
back into a list.


File: python.info,  Node: How do you make an array in Python?,  Next: How do I create a multidimensional list?,  Prev: How do you remove duplicates from a list?,  Up: Sequences Tuples/Lists

11.2.5.5 How do you make an array in Python?
............................................

Use a list:

     ["this", 1, "is", "an", "array"]

Lists are equivalent to C or Pascal arrays in their time complexity; the
primary difference is that a Python list can contain objects of many
different types.

The ‘array’ module also provides methods for creating arrays of fixed
types with compact representations, but they are slower to index than
lists.  Also note that the Numeric extensions and others define
array-like structures with various characteristics as well.

To get Lisp-style linked lists, you can emulate cons cells using tuples:

     lisp_list = ("like",  ("this",  ("example", None) ) )

If mutability is desired, you could use lists instead of tuples.  Here
the analogue of lisp car is ‘lisp_list[0]’ and the analogue of cdr is
‘lisp_list[1]’.  Only do this if you’re sure you really need to, because
it’s usually a lot slower than using Python lists.


File: python.info,  Node: How do I create a multidimensional list?,  Next: How do I apply a method to a sequence of objects?,  Prev: How do you make an array in Python?,  Up: Sequences Tuples/Lists

11.2.5.6 How do I create a multidimensional list?
.................................................

You probably tried to make a multidimensional array like this:

     >>> A = [[None] * 2] * 3

This looks correct if you print it:

     >>> A [[None, None], [None, None], [None, None]]

But when you assign a value, it shows up in multiple places:

     >>> A[0][0] = 5 >>> A [[5, None], [5, None], [5, None]]

The reason is that replicating a list with ‘*’ doesn’t create copies, it
only creates references to the existing objects.  The ‘*3’ creates a
list containing 3 references to the same list of length two.  Changes to
one row will show in all rows, which is almost certainly not what you
want.

The suggested approach is to create a list of the desired length first
and then fill in each element with a newly created list:

     A = [None] * 3 for i in range(3):     A[i] = [None] * 2

This generates a list containing 3 different lists of length two.  You
can also use a list comprehension:

     w, h = 2, 3 A = [[None] * w for i in range(h)]

Or, you can use an extension that provides a matrix datatype; NumPy(1)
is the best known.

   ---------- Footnotes ----------

   (1) http://www.numpy.org/


File: python.info,  Node: How do I apply a method to a sequence of objects?,  Next: Why does a_tuple[i] += [‘item’] raise an exception when the addition works?,  Prev: How do I create a multidimensional list?,  Up: Sequences Tuples/Lists

11.2.5.7 How do I apply a method to a sequence of objects?
..........................................................

Use a list comprehension:

     result = [obj.method() for obj in mylist]


File: python.info,  Node: Why does a_tuple[i] += [‘item’] raise an exception when the addition works?,  Next: I want to do a complicated sort can you do a Schwartzian Transform in Python?,  Prev: How do I apply a method to a sequence of objects?,  Up: Sequences Tuples/Lists

11.2.5.8 Why does a_tuple[i] += [‘item’] raise an exception when the addition works?
....................................................................................

This is because of a combination of the fact that augmented assignment
operators are `assignment' operators, and the difference between mutable
and immutable objects in Python.

This discussion applies in general when augmented assignment operators
are applied to elements of a tuple that point to mutable objects, but
we’ll use a ‘list’ and ‘+=’ as our exemplar.

If you wrote:

     >>> a_tuple = (1, 2) >>> a_tuple[0] += 1 Traceback (most recent call last):    ... TypeError: 'tuple' object does not support item assignment

The reason for the exception should be immediately clear: ‘1’ is added
to the object ‘a_tuple[0]’ points to (‘1’), producing the result object,
‘2’, but when we attempt to assign the result of the computation, ‘2’,
to element ‘0’ of the tuple, we get an error because we can’t change
what an element of a tuple points to.

Under the covers, what this augmented assignment statement is doing is
approximately this:

     >>> result = a_tuple[0] + 1 >>> a_tuple[0] = result Traceback (most recent call last):   ... TypeError: 'tuple' object does not support item assignment

It is the assignment part of the operation that produces the error,
since a tuple is immutable.

When you write something like:

     >>> a_tuple = (['foo'], 'bar') >>> a_tuple[0] += ['item'] Traceback (most recent call last):   ... TypeError: 'tuple' object does not support item assignment

The exception is a bit more surprising, and even more surprising is the
fact that even though there was an error, the append worked:

     >>> a_tuple[0] ['foo', 'item']

To see why this happens, you need to know that (a) if an object
implements an ‘__iadd__’ magic method, it gets called when the ‘+=’
augmented assignment is executed, and its return value is what gets used
in the assignment statement; and (b) for lists, ‘__iadd__’ is equivalent
to calling ‘extend’ on the list and returning the list.  That’s why we
say that for lists, ‘+=’ is a “shorthand” for ‘list.extend’:

     >>> a_list = [] >>> a_list += [1] >>> a_list [1]

This is equivalent to:

     >>> result = a_list.__iadd__([1]) >>> a_list = result

The object pointed to by a_list has been mutated, and the pointer to the
mutated object is assigned back to ‘a_list’.  The end result of the
assignment is a no-op, since it is a pointer to the same object that
‘a_list’ was previously pointing to, but the assignment still happens.

Thus, in our tuple example what is happening is equivalent to:

     >>> result = a_tuple[0].__iadd__(['item']) >>> a_tuple[0] = result Traceback (most recent call last):   ... TypeError: 'tuple' object does not support item assignment

The ‘__iadd__’ succeeds, and thus the list is extended, but even though
‘result’ points to the same object that ‘a_tuple[0]’ already points to,
that final assignment still results in an error, because tuples are
immutable.


File: python.info,  Node: I want to do a complicated sort can you do a Schwartzian Transform in Python?,  Next: How can I sort one list by values from another list?,  Prev: Why does a_tuple[i] += [‘item’] raise an exception when the addition works?,  Up: Sequences Tuples/Lists

11.2.5.9 I want to do a complicated sort: can you do a Schwartzian Transform in Python?
.......................................................................................

The technique, attributed to Randal Schwartz of the Perl community,
sorts the elements of a list by a metric which maps each element to its
“sort value”.  In Python, use the ‘key’ argument for the *note
list.sort(): 43a. method:

     Isorted = L[:] Isorted.sort(key=lambda s: int(s[10:15]))


File: python.info,  Node: How can I sort one list by values from another list?,  Prev: I want to do a complicated sort can you do a Schwartzian Transform in Python?,  Up: Sequences Tuples/Lists

11.2.5.10 How can I sort one list by values from another list?
..............................................................

Merge them into an iterator of tuples, sort the resulting list, and then
pick out the element you want.

     >>> list1 = ["what", "I'm", "sorting", "by"] >>> list2 = ["something", "else", "to", "sort"] >>> pairs = zip(list1, list2) >>> pairs = sorted(pairs) >>> pairs [("I'm", 'else'), ('by', 'sort'), ('sorting', 'to'), ('what', 'something')] >>> result = [x[1] for x in pairs] >>> result ['else', 'sort', 'to', 'something']

An alternative for the last step is:

     >>> result = [] >>> for p in pairs: result.append(p[1])

If you find this more legible, you might prefer to use this instead of
the final list comprehension.  However, it is almost twice as slow for
long lists.  Why?  First, the ‘append()’ operation has to reallocate
memory, and while it uses some tricks to avoid doing that each time, it
still has to do it occasionally, and that costs quite a bit.  Second,
the expression “result.append” requires an extra attribute lookup, and
third, there’s a speed reduction from having to make all those function
calls.


File: python.info,  Node: Objects,  Next: Modules<3>,  Prev: Sequences Tuples/Lists,  Up: Programming FAQ

11.2.6 Objects
--------------

* Menu:

* What is a class?::
* What is a method?::
* What is self?::
* How do I check if an object is an instance of a given class or of a subclass of it?::
* What is delegation?::
* How do I call a method defined in a base class from a derived class that overrides it?::
* How can I organize my code to make it easier to change the base class?::
* How do I create static class data and static class methods?::
* How can I overload constructors (or methods) in Python?: How can I overload constructors or methods in Python?.
* I try to use __spam and I get an error about _SomeClassName__spam.: I try to use __spam and I get an error about _SomeClassName__spam.
* My class defines __del__ but it is not called when I delete the object.: My class defines __del__ but it is not called when I delete the object.
* How do I get a list of all instances of a given class?::
* Why does the result of id() appear to be not unique?: Why does the result of id appear to be not unique?.


File: python.info,  Node: What is a class?,  Next: What is a method?,  Up: Objects

11.2.6.1 What is a class?
.........................

A class is the particular object type created by executing a class
statement.  Class objects are used as templates to create instance
objects, which embody both the data (attributes) and code (methods)
specific to a datatype.

A class can be based on one or more other classes, called its base
class(es).  It then inherits the attributes and methods of its base
classes.  This allows an object model to be successively refined by
inheritance.  You might have a generic ‘Mailbox’ class that provides
basic accessor methods for a mailbox, and subclasses such as
‘MboxMailbox’, ‘MaildirMailbox’, ‘OutlookMailbox’ that handle various
specific mailbox formats.


File: python.info,  Node: What is a method?,  Next: What is self?,  Prev: What is a class?,  Up: Objects

11.2.6.2 What is a method?
..........................

A method is a function on some object ‘x’ that you normally call as
‘x.name(arguments...)’.  Methods are defined as functions inside the
class definition:

     class C:     def meth(self, arg):         return arg * 2 + self.attribute


File: python.info,  Node: What is self?,  Next: How do I check if an object is an instance of a given class or of a subclass of it?,  Prev: What is a method?,  Up: Objects

11.2.6.3 What is self?
......................

Self is merely a conventional name for the first argument of a method.
A method defined as ‘meth(self, a, b, c)’ should be called as ‘x.meth(a,
b, c)’ for some instance ‘x’ of the class in which the definition
occurs; the called method will think it is called as ‘meth(x, a, b, c)’.

See also *note Why must ‘self’ be used explicitly in method definitions
and calls?: 41ce.


File: python.info,  Node: How do I check if an object is an instance of a given class or of a subclass of it?,  Next: What is delegation?,  Prev: What is self?,  Up: Objects

11.2.6.4 How do I check if an object is an instance of a given class or of a subclass of it?
............................................................................................

Use the built-in function ‘isinstance(obj, cls)’.  You can check if an
object is an instance of any of a number of classes by providing a tuple
instead of a single class, e.g.  ‘isinstance(obj, (class1, class2,
...))’, and can also check whether an object is one of Python’s built-in
types, e.g.  ‘isinstance(obj, str)’ or ‘isinstance(obj, (int, float,
complex))’.

Note that most programs do not use *note isinstance(): 444. on
user-defined classes very often.  If you are developing the classes
yourself, a more proper object-oriented style is to define methods on
the classes that encapsulate a particular behaviour, instead of checking
the object’s class and doing a different thing based on what class it
is.  For example, if you have a function that does something:

     def search(obj):     if isinstance(obj, Mailbox):         ...  # code to search a mailbox     elif isinstance(obj, Document):         ...  # code to search a document     elif ...

A better approach is to define a ‘search()’ method on all the classes
and just call it:

     class Mailbox:     def search(self):         ...  # code to search a mailbox  class Document:     def search(self):         ...  # code to search a document  obj.search()


File: python.info,  Node: What is delegation?,  Next: How do I call a method defined in a base class from a derived class that overrides it?,  Prev: How do I check if an object is an instance of a given class or of a subclass of it?,  Up: Objects

11.2.6.5 What is delegation?
............................

Delegation is an object oriented technique (also called a design
pattern).  Let’s say you have an object ‘x’ and want to change the
behaviour of just one of its methods.  You can create a new class that
provides a new implementation of the method you’re interested in
changing and delegates all other methods to the corresponding method of
‘x’.

Python programmers can easily implement delegation.  For example, the
following class implements a class that behaves like a file but converts
all written data to uppercase:

     class UpperOut:      def __init__(self, outfile):         self._outfile = outfile      def write(self, s):         self._outfile.write(s.upper())      def __getattr__(self, name):         return getattr(self._outfile, name)

Here the ‘UpperOut’ class redefines the ‘write()’ method to convert the
argument string to uppercase before calling the underlying
‘self.__outfile.write()’ method.  All other methods are delegated to the
underlying ‘self.__outfile’ object.  The delegation is accomplished via
the ‘__getattr__’ method; consult *note the language reference: 1375.
for more information about controlling attribute access.

Note that for more general cases delegation can get trickier.  When
attributes must be set as well as retrieved, the class must define a
*note __setattr__(): e1f. method too, and it must do so carefully.  The
basic implementation of *note __setattr__(): e1f. is roughly equivalent
to the following:

     class X:     ...     def __setattr__(self, name, value):         self.__dict__[name] = value     ...

Most *note __setattr__(): e1f. implementations must modify
‘self.__dict__’ to store local state for self without causing an
infinite recursion.


File: python.info,  Node: How do I call a method defined in a base class from a derived class that overrides it?,  Next: How can I organize my code to make it easier to change the base class?,  Prev: What is delegation?,  Up: Objects

11.2.6.6 How do I call a method defined in a base class from a derived class that overrides it?
...............................................................................................

Use the built-in *note super(): 4d7. function:

     class Derived(Base):     def meth(self):         super(Derived, self).meth()

For version prior to 3.0, you may be using classic classes: For a class
definition such as ‘class Derived(Base): ...’ you can call method
‘meth()’ defined in ‘Base’ (or one of ‘Base’’s base classes) as
‘Base.meth(self, arguments...)’.  Here, ‘Base.meth’ is an unbound
method, so you need to provide the ‘self’ argument.


File: python.info,  Node: How can I organize my code to make it easier to change the base class?,  Next: How do I create static class data and static class methods?,  Prev: How do I call a method defined in a base class from a derived class that overrides it?,  Up: Objects

11.2.6.7 How can I organize my code to make it easier to change the base class?
...............................................................................

You could define an alias for the base class, assign the real base class
to it before your class definition, and use the alias throughout your
class.  Then all you have to change is the value assigned to the alias.
Incidentally, this trick is also handy if you want to decide dynamically
(e.g.  depending on availability of resources) which base class to use.
Example:

     BaseAlias = <real base class>  class Derived(BaseAlias):     def meth(self):         BaseAlias.meth(self)         ...


File: python.info,  Node: How do I create static class data and static class methods?,  Next: How can I overload constructors or methods in Python?,  Prev: How can I organize my code to make it easier to change the base class?,  Up: Objects

11.2.6.8 How do I create static class data and static class methods?
....................................................................

Both static data and static methods (in the sense of C++ or Java) are
supported in Python.

For static data, simply define a class attribute.  To assign a new value
to the attribute, you have to explicitly use the class name in the
assignment:

     class C:     count = 0   # number of times C.__init__ called      def __init__(self):         C.count = C.count + 1      def getcount(self):         return C.count  # or return self.count

‘c.count’ also refers to ‘C.count’ for any ‘c’ such that ‘isinstance(c,
C)’ holds, unless overridden by ‘c’ itself or by some class on the
base-class search path from ‘c.__class__’ back to ‘C’.

Caution: within a method of C, an assignment like ‘self.count = 42’
creates a new and unrelated instance named “count” in ‘self’’s own dict.
Rebinding of a class-static data name must always specify the class
whether inside a method or not:

     C.count = 314

Static methods are possible:

     class C:     @staticmethod     def static(arg1, arg2, arg3):         # No 'self' parameter!         ...

However, a far more straightforward way to get the effect of a static
method is via a simple module-level function:

     def getcount():     return C.count

If your code is structured so as to define one class (or tightly related
class hierarchy) per module, this supplies the desired encapsulation.


File: python.info,  Node: How can I overload constructors or methods in Python?,  Next: I try to use __spam and I get an error about _SomeClassName__spam,  Prev: How do I create static class data and static class methods?,  Up: Objects

11.2.6.9 How can I overload constructors (or methods) in Python?
................................................................

This answer actually applies to all methods, but the question usually
comes up first in the context of constructors.

In C++ you’d write

     class C {     C() { cout << "No arguments\n"; }     C(int i) { cout << "Argument is " << i << "\n"; } }

In Python you have to write a single constructor that catches all cases
using default arguments.  For example:

     class C:     def __init__(self, i=None):         if i is None:             print("No arguments")         else:             print("Argument is", i)

This is not entirely equivalent, but close enough in practice.

You could also try a variable-length argument list, e.g.

     def __init__(self, *args):     ...

The same approach works for all method definitions.


File: python.info,  Node: I try to use __spam and I get an error about _SomeClassName__spam,  Next: My class defines __del__ but it is not called when I delete the object,  Prev: How can I overload constructors or methods in Python?,  Up: Objects

11.2.6.10 I try to use __spam and I get an error about _SomeClassName__spam.
............................................................................

Variable names with double leading underscores are “mangled” to provide
a simple but effective way to define class private variables.  Any
identifier of the form ‘__spam’ (at least two leading underscores, at
most one trailing underscore) is textually replaced with
‘_classname__spam’, where ‘classname’ is the current class name with any
leading underscores stripped.

This doesn’t guarantee privacy: an outside user can still deliberately
access the “_classname__spam” attribute, and private values are visible
in the object’s ‘__dict__’.  Many Python programmers never bother to use
private variable names at all.


File: python.info,  Node: My class defines __del__ but it is not called when I delete the object,  Next: How do I get a list of all instances of a given class?,  Prev: I try to use __spam and I get an error about _SomeClassName__spam,  Up: Objects

11.2.6.11 My class defines __del__ but it is not called when I delete the object.
.................................................................................

There are several possible reasons for this.

The del statement does not necessarily call *note __del__(): 913. – it
simply decrements the object’s reference count, and if this reaches zero
*note __del__(): 913. is called.

If your data structures contain circular links (e.g.  a tree where each
child has a parent reference and each parent has a list of children) the
reference counts will never go back to zero.  Once in a while Python
runs an algorithm to detect such cycles, but the garbage collector might
run some time after the last reference to your data structure vanishes,
so your *note __del__(): 913. method may be called at an inconvenient
and random time.  This is inconvenient if you’re trying to reproduce a
problem.  Worse, the order in which object’s *note __del__(): 913.
methods are executed is arbitrary.  You can run *note gc.collect(): 22c.
to force a collection, but there `are' pathological cases where objects
will never be collected.

Despite the cycle collector, it’s still a good idea to define an
explicit ‘close()’ method on objects to be called whenever you’re done
with them.  The ‘close()’ method can then remove attributes that refer
to subobjects.  Don’t call *note __del__(): 913. directly – *note
__del__(): 913. should call ‘close()’ and ‘close()’ should make sure
that it can be called more than once for the same object.

Another way to avoid cyclical references is to use the *note weakref:
128. module, which allows you to point to objects without incrementing
their reference count.  Tree data structures, for instance, should use
weak references for their parent and sibling references (if they need
them!).

Finally, if your *note __del__(): 913. method raises an exception, a
warning message is printed to *note sys.stderr: 304.


File: python.info,  Node: How do I get a list of all instances of a given class?,  Next: Why does the result of id appear to be not unique?,  Prev: My class defines __del__ but it is not called when I delete the object,  Up: Objects

11.2.6.12 How do I get a list of all instances of a given class?
................................................................

Python does not keep track of all instances of a class (or of a built-in
type).  You can program the class’s constructor to keep track of all
instances by keeping a list of weak references to each instance.


File: python.info,  Node: Why does the result of id appear to be not unique?,  Prev: How do I get a list of all instances of a given class?,  Up: Objects

11.2.6.13 Why does the result of ‘id()’ appear to be not unique?
................................................................

The *note id(): d79. builtin returns an integer that is guaranteed to be
unique during the lifetime of the object.  Since in CPython, this is the
object’s memory address, it happens frequently that after an object is
deleted from memory, the next freshly created object is allocated at the
same position in memory.  This is illustrated by this example:

     >>> id(1000) # doctest: +SKIP 13901272 >>> id(2000) # doctest: +SKIP 13901272

The two ids belong to different integer objects that are created before,
and deleted immediately after execution of the ‘id()’ call.  To be sure
that objects whose id you want to examine are still alive, create
another reference to the object:

     >>> a = 1000; b = 2000 >>> id(a) # doctest: +SKIP 13901272 >>> id(b) # doctest: +SKIP 13891296


File: python.info,  Node: Modules<3>,  Prev: Objects,  Up: Programming FAQ

11.2.7 Modules
--------------

* Menu:

* How do I create a .pyc file?: How do I create a pyc file?.
* How do I find the current module name?::
* How can I have modules that mutually import each other?::
* __import__(‘x.y.z’) returns <module ‘x’>; how do I get z?: __import__ ‘x y z’ returns <module ‘x’>; how do I get z?.
* When I edit an imported module and reimport it, the changes don’t show up. Why does this happen?: When I edit an imported module and reimport it the changes don’t show up Why does this happen?.


File: python.info,  Node: How do I create a pyc file?,  Next: How do I find the current module name?,  Up: Modules<3>

11.2.7.1 How do I create a .pyc file?
.....................................

When a module is imported for the first time (or when the source file
has changed since the current compiled file was created) a ‘.pyc’ file
containing the compiled code should be created in a ‘__pycache__’
subdirectory of the directory containing the ‘.py’ file.  The ‘.pyc’
file will have a filename that starts with the same name as the ‘.py’
file, and ends with ‘.pyc’, with a middle component that depends on the
particular ‘python’ binary that created it.  (See PEP 3147(1) for
details.)

One reason that a ‘.pyc’ file may not be created is a permissions
problem with the directory containing the source file, meaning that the
‘__pycache__’ subdirectory cannot be created.  This can happen, for
example, if you develop as one user but run as another, such as if you
are testing with a web server.

Unless the *note PYTHONDONTWRITEBYTECODE: d2c. environment variable is
set, creation of a .pyc file is automatic if you’re importing a module
and Python has the ability (permissions, free space, etc…) to create a
‘__pycache__’ subdirectory and write the compiled module to that
subdirectory.

Running Python on a top level script is not considered an import and no
‘.pyc’ will be created.  For example, if you have a top-level module
‘foo.py’ that imports another module ‘xyz.py’, when you run ‘foo’ (by
typing ‘python foo.py’ as a shell command), a ‘.pyc’ will be created for
‘xyz’ because ‘xyz’ is imported, but no ‘.pyc’ file will be created for
‘foo’ since ‘foo.py’ isn’t being imported.

If you need to create a ‘.pyc’ file for ‘foo’ – that is, to create a
‘.pyc’ file for a module that is not imported – you can, using the *note
py_compile: d7. and *note compileall: 21. modules.

The *note py_compile: d7. module can manually compile any module.  One
way is to use the ‘compile()’ function in that module interactively:

     >>> import py_compile >>> py_compile.compile('foo.py')

This will write the ‘.pyc’ to a ‘__pycache__’ subdirectory in the same
location as ‘foo.py’ (or you can override that with the optional
parameter ‘cfile’).

You can also automatically compile all files in a directory or
directories using the *note compileall: 21. module.  You can do it from
the shell prompt by running ‘compileall.py’ and providing the path of a
directory containing Python files to compile:

     python -m compileall .

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147


File: python.info,  Node: How do I find the current module name?,  Next: How can I have modules that mutually import each other?,  Prev: How do I create a pyc file?,  Up: Modules<3>

11.2.7.2 How do I find the current module name?
...............................................

A module can find out its own module name by looking at the predefined
global variable ‘__name__’.  If this has the value ‘'__main__'’, the
program is running as a script.  Many modules that are usually used by
importing them also provide a command-line interface or a self-test, and
only execute this code after checking ‘__name__’:

     def main():     print('Running test...')     ...  if __name__ == '__main__':     main()


File: python.info,  Node: How can I have modules that mutually import each other?,  Next: __import__ ‘x y z’ returns <module ‘x’>; how do I get z?,  Prev: How do I find the current module name?,  Up: Modules<3>

11.2.7.3 How can I have modules that mutually import each other?
................................................................

Suppose you have the following modules:

foo.py:

     from bar import bar_var foo_var = 1

bar.py:

     from foo import foo_var bar_var = 2

The problem is that the interpreter will perform the following steps:

   * main imports foo

   * Empty globals for foo are created

   * foo is compiled and starts executing

   * foo imports bar

   * Empty globals for bar are created

   * bar is compiled and starts executing

   * bar imports foo (which is a no-op since there already is a module
     named foo)

   * bar.foo_var = foo.foo_var

The last step fails, because Python isn’t done with interpreting ‘foo’
yet and the global symbol dictionary for ‘foo’ is still empty.

The same thing happens when you use ‘import foo’, and then try to access
‘foo.foo_var’ in global code.

There are (at least) three possible workarounds for this problem.

Guido van Rossum recommends avoiding all uses of ‘from <module> import
...’, and placing all code inside functions.  Initializations of global
variables and class variables should use constants or built-in functions
only.  This means everything from an imported module is referenced as
‘<module>.<name>’.

Jim Roskind suggests performing steps in the following order in each
module:

   * exports (globals, functions, and classes that don’t need imported
     base classes)

   * ‘import’ statements

   * active code (including globals that are initialized from imported
     values).

van Rossum doesn’t like this approach much because the imports appear in
a strange place, but it does work.

Matthias Urlichs recommends restructuring your code so that the
recursive import is not necessary in the first place.

These solutions are not mutually exclusive.


File: python.info,  Node: __import__ ‘x y z’ returns <module ‘x’>; how do I get z?,  Next: When I edit an imported module and reimport it the changes don’t show up Why does this happen?,  Prev: How can I have modules that mutually import each other?,  Up: Modules<3>

11.2.7.4 __import__(‘x.y.z’) returns <module ‘x’>; how do I get z?
..................................................................

Consider using the convenience function *note import_module(): b06. from
*note importlib: 9b. instead:

     z = importlib.import_module('x.y.z')


File: python.info,  Node: When I edit an imported module and reimport it the changes don’t show up Why does this happen?,  Prev: __import__ ‘x y z’ returns <module ‘x’>; how do I get z?,  Up: Modules<3>

11.2.7.5 When I edit an imported module and reimport it, the changes don’t show up. Why does this happen?
.........................................................................................................

For reasons of efficiency as well as consistency, Python only reads the
module file on the first time a module is imported.  If it didn’t, in a
program consisting of many modules where each one imports the same basic
module, the basic module would be parsed and re-parsed many times.  To
force re-reading of a changed module, do this:

     import importlib import modname importlib.reload(modname)

Warning: this technique is not 100% fool-proof.  In particular, modules
containing statements like

     from modname import some_objects

will continue to work with the old version of the imported objects.  If
the module contains class definitions, existing class instances will
`not' be updated to use the new class definition.  This can result in
the following paradoxical behaviour:

     >>> import importlib >>> import cls >>> c = cls.C()                # Create an instance of C >>> importlib.reload(cls) <module 'cls' from 'cls.py'> >>> isinstance(c, cls.C)       # isinstance is false?!? False

The nature of the problem is made clear if you print out the “identity”
of the class objects:

     >>> hex(id(c.__class__)) '0x7352a0' >>> hex(id(cls.C)) '0x4198d0'


File: python.info,  Node: Design and History FAQ,  Next: Library and Extension FAQ,  Prev: Programming FAQ,  Up: Python Frequently Asked Questions

11.3 Design and History FAQ
===========================

* Menu:

* 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 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?: 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?: Can Python be compiled to machine code C or some other language?.
* How does Python manage memory?::
* Why doesn’t CPython use a more traditional garbage collection scheme?::
* Why isn’t all memory freed when CPython 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?: 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 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?::


File: python.info,  Node: Why does Python use indentation for grouping of statements?,  Next: Why am I getting strange results with simple arithmetic operations?,  Up: Design and History FAQ

11.3.1 Why does Python use indentation for grouping of statements?
------------------------------------------------------------------

Guido van Rossum believes that using indentation for grouping is
extremely elegant and contributes a lot to the clarity of the average
Python program.  Most people learn to love this feature after a while.

Since there are no begin/end brackets there cannot be a disagreement
between grouping perceived by the parser and the human reader.
Occasionally C programmers will encounter a fragment of code like this:

     if (x <= y)         x++;         y--; z++;

Only the ‘x++’ statement is executed if the condition is true, but the
indentation leads you to believe otherwise.  Even experienced C
programmers will sometimes stare at it a long time wondering why ‘y’ is
being decremented even for ‘x > y’.

Because there are no begin/end brackets, Python is much less prone to
coding-style conflicts.  In C there are many different ways to place the
braces.  If you’re used to reading and writing code that uses one style,
you will feel at least slightly uneasy when reading (or being required
to write) another style.

Many coding styles place begin/end brackets on a line by themselves.
This makes programs considerably longer and wastes valuable screen
space, making it harder to get a good overview of a program.  Ideally, a
function should fit on one screen (say, 20–30 lines).  20 lines of
Python can do a lot more work than 20 lines of C. This is not solely due
to the lack of begin/end brackets – the lack of declarations and the
high-level data types are also responsible – but the indentation-based
syntax certainly helps.


File: python.info,  Node: Why am I getting strange results with simple arithmetic operations?,  Next: Why are floating-point calculations so inaccurate?,  Prev: Why does Python use indentation for grouping of statements?,  Up: Design and History FAQ

11.3.2 Why am I getting strange results with simple arithmetic operations?
--------------------------------------------------------------------------

See the next question.


File: python.info,  Node: Why are floating-point calculations so inaccurate?,  Next: Why are Python strings immutable?,  Prev: Why am I getting strange results with simple arithmetic operations?,  Up: Design and History FAQ

11.3.3 Why are floating-point calculations so inaccurate?
---------------------------------------------------------

Users are often surprised by results like this:

     >>> 1.2 - 1.0 0.19999999999999996

and think it is a bug in Python.  It’s not.  This has little to do with
Python, and much more to do with how the underlying platform handles
floating-point numbers.

The *note float: 187. type in CPython uses a C ‘double’ for storage.  A
*note float: 187. object’s value is stored in binary floating-point with
a fixed precision (typically 53 bits) and Python uses C operations,
which in turn rely on the hardware implementation in the processor, to
perform floating-point operations.  This means that as far as
floating-point operations are concerned, Python behaves like many
popular languages including C and Java.

Many numbers that can be written easily in decimal notation cannot be
expressed exactly in binary floating-point.  For example, after:

     >>> x = 1.2

the value stored for ‘x’ is a (very good) approximation to the decimal
value ‘1.2’, but is not exactly equal to it.  On a typical machine, the
actual stored value is:

     1.0011001100110011001100110011001100110011001100110011 (binary)

which is exactly:

     1.1999999999999999555910790149937383830547332763671875 (decimal)

The typical precision of 53 bits provides Python floats with 15–16
decimal digits of accuracy.

For a fuller explanation, please see the *note floating point
arithmetic: 125c. chapter in the Python tutorial.


File: python.info,  Node: Why are Python strings immutable?,  Next: Why must ‘self’ be used explicitly in method definitions and calls?,  Prev: Why are floating-point calculations so inaccurate?,  Up: Design and History FAQ

11.3.4 Why are Python strings immutable?
----------------------------------------

There are several advantages.

One is performance: knowing that a string is immutable means we can
allocate space for it at creation time, and the storage requirements are
fixed and unchanging.  This is also one of the reasons for the
distinction between tuples and lists.

Another advantage is that strings in Python are considered as
“elemental” as numbers.  No amount of activity will change the value 8
to anything else, and in Python, no amount of activity will change the
string “eight” to anything else.


File: python.info,  Node: Why must ‘self’ be used explicitly in method definitions and calls?,  Next: Why can’t I use an assignment in an expression?,  Prev: Why are Python strings immutable?,  Up: Design and History FAQ

11.3.5 Why must ‘self’ be used explicitly in method definitions and calls?
--------------------------------------------------------------------------

The idea was borrowed from Modula-3.  It turns out to be very useful,
for a variety of reasons.

First, it’s more obvious that you are using a method or instance
attribute instead of a local variable.  Reading ‘self.x’ or
‘self.meth()’ makes it absolutely clear that an instance variable or
method is used even if you don’t know the class definition by heart.  In
C++, you can sort of tell by the lack of a local variable declaration
(assuming globals are rare or easily recognizable) – but in Python,
there are no local variable declarations, so you’d have to look up the
class definition to be sure.  Some C++ and Java coding standards call
for instance attributes to have an ‘m_’ prefix, so this explicitness is
still useful in those languages, too.

Second, it means that no special syntax is necessary if you want to
explicitly reference or call the method from a particular class.  In
C++, if you want to use a method from a base class which is overridden
in a derived class, you have to use the ‘::’ operator – in Python you
can write ‘baseclass.methodname(self, <argument list>)’.  This is
particularly useful for *note __init__(): d51. methods, and in general
in cases where a derived class method wants to extend the base class
method of the same name and thus has to call the base class method
somehow.

Finally, for instance variables it solves a syntactic problem with
assignment: since local variables in Python are (by definition!)  those
variables to which a value is assigned in a function body (and that
aren’t explicitly declared global), there has to be some way to tell the
interpreter that an assignment was meant to assign to an instance
variable instead of to a local variable, and it should preferably be
syntactic (for efficiency reasons).  C++ does this through declarations,
but Python doesn’t have declarations and it would be a pity having to
introduce them just for this purpose.  Using the explicit ‘self.var’
solves this nicely.  Similarly, for using instance variables, having to
write ‘self.var’ means that references to unqualified names inside a
method don’t have to search the instance’s directories.  To put it
another way, local variables and instance variables live in two
different namespaces, and you need to tell Python which namespace to
use.


File: python.info,  Node: Why can’t I use an assignment in an expression?,  Next: Why does Python use methods for some functionality e g list index but functions for other e g len list ?,  Prev: Why must ‘self’ be used explicitly in method definitions and calls?,  Up: Design and History FAQ

11.3.6 Why can’t I use an assignment in an expression?
------------------------------------------------------

Starting in Python 3.8, you can!

Assignment expressions using the walrus operator ‘:=’ assign a variable
in an expression:

     while chunk := fp.read(200):    print(chunk)

See PEP 572(1) for more information.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0572


File: python.info,  Node: Why does Python use methods for some functionality e g list index but functions for other e g len list ?,  Next: Why is join a string method instead of a list or tuple method?,  Prev: Why can’t I use an assignment in an expression?,  Up: Design and History FAQ

11.3.7 Why does Python use methods for some functionality (e.g. list.index()) but functions for other (e.g. len(list))?
-----------------------------------------------------------------------------------------------------------------------

As Guido said:

     (a) For some operations, prefix notation just reads better than
     postfix – prefix (and infix!)  operations have a long tradition in
     mathematics which likes notations where the visuals help the
     mathematician thinking about a problem.  Compare the easy with
     which we rewrite a formula like x*(a+b) into x*a + x*b to the
     clumsiness of doing the same thing using a raw OO notation.

     (b) When I read code that says len(x) I `know' that it is asking
     for the length of something.  This tells me two things: the result
     is an integer, and the argument is some kind of container.  To the
     contrary, when I read x.len(), I have to already know that x is
     some kind of container implementing an interface or inheriting from
     a class that has a standard len().  Witness the confusion we
     occasionally have when a class that is not implementing a mapping
     has a get() or keys() method, or something that isn’t a file has a
     write() method.

— ‘https://mail.python.org/pipermail/python-3000/2006-November/004643.html’


File: python.info,  Node: Why is join a string method instead of a list or tuple method?,  Next: How fast are exceptions?,  Prev: Why does Python use methods for some functionality e g list index but functions for other e g len list ?,  Up: Design and History FAQ

11.3.8 Why is join() a string method instead of a list or tuple method?
-----------------------------------------------------------------------

Strings became much more like other standard types starting in Python
1.6, when methods were added which give the same functionality that has
always been available using the functions of the string module.  Most of
these new methods have been widely accepted, but the one which appears
to make some programmers feel uncomfortable is:

     ", ".join(['1', '2', '4', '8', '16'])

which gives the result:

     "1, 2, 4, 8, 16"

There are two common arguments against this usage.

The first runs along the lines of: “It looks really ugly using a method
of a string literal (string constant)”, to which the answer is that it
might, but a string literal is just a fixed value.  If the methods are
to be allowed on names bound to strings there is no logical reason to
make them unavailable on literals.

The second objection is typically cast as: “I am really telling a
sequence to join its members together with a string constant”.  Sadly,
you aren’t.  For some reason there seems to be much less difficulty with
having *note split(): 795. as a string method, since in that case it is
easy to see that

     "1, 2, 4, 8, 16".split(", ")

is an instruction to a string literal to return the substrings delimited
by the given separator (or, by default, arbitrary runs of white space).

*note join(): 156d. is a string method because in using it you are
telling the separator string to iterate over a sequence of strings and
insert itself between adjacent elements.  This method can be used with
any argument which obeys the rules for sequence objects, including any
new classes you might define yourself.  Similar methods exist for bytes
and bytearray objects.


File: python.info,  Node: How fast are exceptions?,  Next: Why isn’t there a switch or case statement in Python?,  Prev: Why is join a string method instead of a list or tuple method?,  Up: Design and History FAQ

11.3.9 How fast are exceptions?
-------------------------------

A try/except block is extremely efficient if no exceptions are raised.
Actually catching an exception is expensive.  In versions of Python
prior to 2.0 it was common to use this idiom:

     try:     value = mydict[key] except KeyError:     mydict[key] = getvalue(key)     value = mydict[key]

This only made sense when you expected the dict to have the key almost
all the time.  If that wasn’t the case, you coded it like this:

     if key in mydict:     value = mydict[key] else:     value = mydict[key] = getvalue(key)

For this specific case, you could also use ‘value = dict.setdefault(key,
getvalue(key))’, but only if the ‘getvalue()’ call is cheap enough
because it is evaluated in all cases.


File: python.info,  Node: Why isn’t there a switch or case statement in Python?,  Next: Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?,  Prev: How fast are exceptions?,  Up: Design and History FAQ

11.3.10 Why isn’t there a switch or case statement in Python?
-------------------------------------------------------------

You can do this easily enough with a sequence of ‘if... elif... elif...
else’.  There have been some proposals for switch statement syntax, but
there is no consensus (yet) on whether and how to do range tests.  See
PEP 275(1) for complete details and the current status.

For cases where you need to choose from a very large number of
possibilities, you can create a dictionary mapping case values to
functions to call.  For example:

     def function_1(...):     ...  functions = {'a': function_1,              'b': function_2,              'c': self.method_1, ...}  func = functions[value] func()

For calling methods on objects, you can simplify yet further by using
the *note getattr(): 43d. built-in to retrieve methods with a particular
name:

     def visit_a(self, ...):     ... ...  def dispatch(self, value):     method_name = 'visit_' + str(value)     method = getattr(self, method_name)     method()

It’s suggested that you use a prefix for the method names, such as
‘visit_’ in this example.  Without such a prefix, if values are coming
from an untrusted source, an attacker would be able to call any method
on your object.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0275


File: python.info,  Node: Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?,  Next: Why can’t lambda expressions contain statements?,  Prev: Why isn’t there a switch or case statement in Python?,  Up: Design and History FAQ

11.3.11 Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?
----------------------------------------------------------------------------------------------------------------

Answer 1: Unfortunately, the interpreter pushes at least one C stack
frame for each Python stack frame.  Also, extensions can call back into
Python at almost random moments.  Therefore, a complete threads
implementation requires thread support for C.

Answer 2: Fortunately, there is Stackless Python(1), which has a
completely redesigned interpreter loop that avoids the C stack.

   ---------- Footnotes ----------

   (1) https://github.com/stackless-dev/stackless/wiki


File: python.info,  Node: Why can’t lambda expressions contain statements?,  Next: Can Python be compiled to machine code C or some other language?,  Prev: Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?,  Up: Design and History FAQ

11.3.12 Why can’t lambda expressions contain statements?
--------------------------------------------------------

Python lambda expressions cannot contain statements because Python’s
syntactic framework can’t handle statements nested inside expressions.
However, in Python, this is not a serious problem.  Unlike lambda forms
in other languages, where they add functionality, Python lambdas are
only a shorthand notation if you’re too lazy to define a function.

Functions are already first class objects in Python, and can be declared
in a local scope.  Therefore the only advantage of using a lambda
instead of a locally-defined function is that you don’t need to invent a
name for the function – but that’s just a local variable to which the
function object (which is exactly the same type of object that a lambda
expression yields) is assigned!


File: python.info,  Node: Can Python be compiled to machine code C or some other language?,  Next: How does Python manage memory?,  Prev: Why can’t lambda expressions contain statements?,  Up: Design and History FAQ

11.3.13 Can Python be compiled to machine code, C or some other language?
-------------------------------------------------------------------------

Cython(1) compiles a modified version of Python with optional
annotations into C extensions.  Nuitka(2) is an up-and-coming compiler
of Python into C++ code, aiming to support the full Python language.
For compiling to Java you can consider VOC(3).

   ---------- Footnotes ----------

   (1) http://cython.org/

   (2) http://www.nuitka.net/

   (3) https://voc.readthedocs.io


File: python.info,  Node: How does Python manage memory?,  Next: Why doesn’t CPython use a more traditional garbage collection scheme?,  Prev: Can Python be compiled to machine code C or some other language?,  Up: Design and History FAQ

11.3.14 How does Python manage memory?
--------------------------------------

The details of Python memory management depend on the implementation.
The standard implementation of Python, *note CPython: 1372, uses
reference counting to detect inaccessible objects, and another mechanism
to collect reference cycles, periodically executing a cycle detection
algorithm which looks for inaccessible cycles and deletes the objects
involved.  The *note gc: 86. module provides functions to perform a
garbage collection, obtain debugging statistics, and tune the
collector’s parameters.

Other implementations (such as Jython(1) or PyPy(2)), however, can rely
on a different mechanism such as a full-blown garbage collector.  This
difference can cause some subtle porting problems if your Python code
depends on the behavior of the reference counting implementation.

In some Python implementations, the following code (which is fine in
CPython) will probably run out of file descriptors:

     for file in very_long_list_of_files:     f = open(file)     c = f.read(1)

Indeed, using CPython’s reference counting and destructor scheme, each
new assignment to `f' closes the previous file.  With a traditional GC,
however, those file objects will only get collected (and closed) at
varying and possibly long intervals.

If you want to write code that will work with any Python implementation,
you should explicitly close the file or use the *note with: 6dd.
statement; this will work regardless of memory management scheme:

     for file in very_long_list_of_files:     with open(file) as f:         c = f.read(1)

   ---------- Footnotes ----------

   (1) http://www.jython.org

   (2) http://www.pypy.org


File: python.info,  Node: Why doesn’t CPython use a more traditional garbage collection scheme?,  Next: Why isn’t all memory freed when CPython exits?,  Prev: How does Python manage memory?,  Up: Design and History FAQ

11.3.15 Why doesn’t CPython use a more traditional garbage collection scheme?
-----------------------------------------------------------------------------

For one thing, this is not a C standard feature and hence it’s not
portable.  (Yes, we know about the Boehm GC library.  It has bits of
assembler code for `most' common platforms, not for all of them, and
although it is mostly transparent, it isn’t completely transparent;
patches are required to get Python to work with it.)

Traditional GC also becomes a problem when Python is embedded into other
applications.  While in a standalone Python it’s fine to replace the
standard malloc() and free() with versions provided by the GC library,
an application embedding Python may want to have its `own' substitute
for malloc() and free(), and may not want Python’s.  Right now, CPython
works with anything that implements malloc() and free() properly.


File: python.info,  Node: Why isn’t all memory freed when CPython exits?,  Next: Why are there separate tuple and list data types?,  Prev: Why doesn’t CPython use a more traditional garbage collection scheme?,  Up: Design and History FAQ

11.3.16 Why isn’t all memory freed when CPython exits?
------------------------------------------------------

Objects referenced from the global namespaces of Python modules are not
always deallocated when Python exits.  This may happen if there are
circular references.  There are also certain bits of memory that are
allocated by the C library that are impossible to free (e.g.  a tool
like Purify will complain about these).  Python is, however, aggressive
about cleaning up memory on exit and does try to destroy every single
object.

If you want to force Python to delete certain things on deallocation use
the *note atexit: c. module to run a function that will force those
deletions.


File: python.info,  Node: Why are there separate tuple and list data types?,  Next: How are lists implemented in CPython?,  Prev: Why isn’t all memory freed when CPython exits?,  Up: Design and History FAQ

11.3.17 Why are there separate tuple and list data types?
---------------------------------------------------------

Lists and tuples, while similar in many respects, are generally used in
fundamentally different ways.  Tuples can be thought of as being similar
to Pascal records or C structs; they’re small collections of related
data which may be of different types which are operated on as a group.
For example, a Cartesian coordinate is appropriately represented as a
tuple of two or three numbers.

Lists, on the other hand, are more like arrays in other languages.  They
tend to hold a varying number of objects all of which have the same type
and which are operated on one-by-one.  For example, ‘os.listdir('.')’
returns a list of strings representing the files in the current
directory.  Functions which operate on this output would generally not
break if you added another file or two to the directory.

Tuples are immutable, meaning that once a tuple has been created, you
can’t replace any of its elements with a new value.  Lists are mutable,
meaning that you can always change a list’s elements.  Only immutable
elements can be used as dictionary keys, and hence only tuples and not
lists can be used as keys.


File: python.info,  Node: How are lists implemented in CPython?,  Next: How are dictionaries implemented in CPython?,  Prev: Why are there separate tuple and list data types?,  Up: Design and History FAQ

11.3.18 How are lists implemented in CPython?
---------------------------------------------

CPython’s lists are really variable-length arrays, not Lisp-style linked
lists.  The implementation uses a contiguous array of references to
other objects, and keeps a pointer to this array and the array’s length
in a list head structure.

This makes indexing a list ‘a[i]’ an operation whose cost is independent
of the size of the list or the value of the index.

When items are appended or inserted, the array of references is resized.
Some cleverness is applied to improve the performance of appending items
repeatedly; when the array must be grown, some extra space is allocated
so the next few times don’t require an actual resize.


File: python.info,  Node: How are dictionaries implemented in CPython?,  Next: Why must dictionary keys be immutable?,  Prev: How are lists implemented in CPython?,  Up: Design and History FAQ

11.3.19 How are dictionaries implemented in CPython?
----------------------------------------------------

CPython’s dictionaries are implemented as resizable hash tables.
Compared to B-trees, this gives better performance for lookup (the most
common operation by far) under most circumstances, and the
implementation is simpler.

Dictionaries work by computing a hash code for each key stored in the
dictionary using the *note hash(): 9b8. built-in function.  The hash
code varies widely depending on the key and a per-process seed; for
example, “Python” could hash to -539294296 while “python”, a string that
differs by a single bit, could hash to 1142331976.  The hash code is
then used to calculate a location in an internal array where the value
will be stored.  Assuming that you’re storing keys that all have
different hash values, this means that dictionaries take constant time –
O(1), in Big-O notation – to retrieve a key.


File: python.info,  Node: Why must dictionary keys be immutable?,  Next: Why doesn’t list sort return the sorted list?,  Prev: How are dictionaries implemented in CPython?,  Up: Design and History FAQ

11.3.20 Why must dictionary keys be immutable?
----------------------------------------------

The hash table implementation of dictionaries uses a hash value
calculated from the key value to find the key.  If the key were a
mutable object, its value could change, and thus its hash could also
change.  But since whoever changes the key object can’t tell that it was
being used as a dictionary key, it can’t move the entry around in the
dictionary.  Then, when you try to look up the same object in the
dictionary it won’t be found because its hash value is different.  If
you tried to look up the old value it wouldn’t be found either, because
the value of the object found in that hash bin would be different.

If you want a dictionary indexed with a list, simply convert the list to
a tuple first; the function ‘tuple(L)’ creates a tuple with the same
entries as the list ‘L’.  Tuples are immutable and can therefore be used
as dictionary keys.

Some unacceptable solutions that have been proposed:

   - Hash lists by their address (object ID). This doesn’t work because
     if you construct a new list with the same value it won’t be found;
     e.g.:

          mydict = {[1, 2]: '12'} print(mydict[[1, 2]])

     would raise a *note KeyError: 2c5. exception because the id of the
     ‘[1, 2]’ used in the second line differs from that in the first
     line.  In other words, dictionary keys should be compared using
     ‘==’, not using *note is: 135a.

   - Make a copy when using a list as a key.  This doesn’t work because
     the list, being a mutable object, could contain a reference to
     itself, and then the copying code would run into an infinite loop.

   - Allow lists as keys but tell the user not to modify them.  This
     would allow a class of hard-to-track bugs in programs when you
     forgot or modified a list by accident.  It also invalidates an
     important invariant of dictionaries: every value in ‘d.keys()’ is
     usable as a key of the dictionary.

   - Mark lists as read-only once they are used as a dictionary key.
     The problem is that it’s not just the top-level object that could
     change its value; you could use a tuple containing a list as a key.
     Entering anything as a key into a dictionary would require marking
     all objects reachable from there as read-only – and again,
     self-referential objects could cause an infinite loop.

There is a trick to get around this if you need to, but use it at your
own risk: You can wrap a mutable structure inside a class instance which
has both a *note __eq__(): 334. and a *note __hash__(): 335. method.
You must then make sure that the hash value for all such wrapper objects
that reside in a dictionary (or other hash based structure), remain
fixed while the object is in the dictionary (or other structure).

     class ListWrapper:     def __init__(self, the_list):         self.the_list = the_list      def __eq__(self, other):         return self.the_list == other.the_list      def __hash__(self):         l = self.the_list         result = 98767 - len(l)*555         for i, el in enumerate(l):             try:                 result = result + (hash(el) % 9999999) * 1001 + i             except Exception:                 result = (result % 7777777) + i * 333         return result

Note that the hash computation is complicated by the possibility that
some members of the list may be unhashable and also by the possibility
of arithmetic overflow.

Furthermore it must always be the case that if ‘o1 == o2’ (ie
‘o1.__eq__(o2) is True’) then ‘hash(o1) == hash(o2)’ (ie, ‘o1.__hash__()
== o2.__hash__()’), regardless of whether the object is in a dictionary
or not.  If you fail to meet these restrictions dictionaries and other
hash based structures will misbehave.

In the case of ListWrapper, whenever the wrapper object is in a
dictionary the wrapped list must not change to avoid anomalies.  Don’t
do this unless you are prepared to think hard about the requirements and
the consequences of not meeting them correctly.  Consider yourself
warned.


File: python.info,  Node: Why doesn’t list sort return the sorted list?,  Next: How do you specify and enforce an interface spec in Python?,  Prev: Why must dictionary keys be immutable?,  Up: Design and History FAQ

11.3.21 Why doesn’t list.sort() return the sorted list?
-------------------------------------------------------

In situations where performance matters, making a copy of the list just
to sort it would be wasteful.  Therefore, *note list.sort(): 43a. sorts
the list in place.  In order to remind you of that fact, it does not
return the sorted list.  This way, you won’t be fooled into accidentally
overwriting a list when you need a sorted copy but also need to keep the
unsorted version around.

If you want to return a new list, use the built-in *note sorted(): 439.
function instead.  This function creates a new list from a provided
iterable, sorts it and returns it.  For example, here’s how to iterate
over the keys of a dictionary in sorted order:

     for key in sorted(mydict):     ...  # do whatever with mydict[key]...


File: python.info,  Node: How do you specify and enforce an interface spec in Python?,  Next: Why is there no goto?,  Prev: Why doesn’t list sort return the sorted list?,  Up: Design and History FAQ

11.3.22 How do you specify and enforce an interface spec in Python?
-------------------------------------------------------------------

An interface specification for a module as provided by languages such as
C++ and Java describes the prototypes for the methods and functions of
the module.  Many feel that compile-time enforcement of interface
specifications helps in the construction of large programs.

Python 2.6 adds an *note abc: 4. module that lets you define Abstract
Base Classes (ABCs).  You can then use *note isinstance(): 444. and
*note issubclass(): 445. to check whether an instance or a class
implements a particular ABC. The *note collections.abc: 1f. module
defines a set of useful ABCs such as *note Iterable: 188b, *note
Container: 1889, and *note MutableMapping: 9e3.

For Python, many of the advantages of interface specifications can be
obtained by an appropriate test discipline for components.  There is
also a tool, PyChecker, which can be used to find problems due to
subclassing.

A good test suite for a module can both provide a regression test and
serve as a module interface specification and a set of examples.  Many
Python modules can be run as a script to provide a simple “self test.”
Even modules which use complex external interfaces can often be tested
in isolation using trivial “stub” emulations of the external interface.
The *note doctest: 67. and *note unittest: 11b. modules or third-party
test frameworks can be used to construct exhaustive test suites that
exercise every line of code in a module.

An appropriate testing discipline can help build large complex
applications in Python as well as having interface specifications would.
In fact, it can be better because an interface specification cannot test
certain properties of a program.  For example, the ‘append()’ method is
expected to add new elements to the end of some internal list; an
interface specification cannot test that your ‘append()’ implementation
will actually do this correctly, but it’s trivial to check this property
in a test suite.

Writing test suites is very helpful, and you might want to design your
code with an eye to making it easily tested.  One increasingly popular
technique, test-directed development, calls for writing parts of the
test suite first, before you write any of the actual code.  Of course
Python allows you to be sloppy and not write test cases at all.


File: python.info,  Node: Why is there no goto?,  Next: Why can’t raw strings r-strings end with a backslash?,  Prev: How do you specify and enforce an interface spec in Python?,  Up: Design and History FAQ

11.3.23 Why is there no goto?
-----------------------------

You can use exceptions to provide a “structured goto” that even works
across function calls.  Many feel that exceptions can conveniently
emulate all reasonable uses of the “go” or “goto” constructs of C,
Fortran, and other languages.  For example:

     class label(Exception): pass  # declare a label  try:     ...     if condition: raise label()  # goto label     ... except label:  # where to goto     pass ...

This doesn’t allow you to jump into the middle of a loop, but that’s
usually considered an abuse of goto anyway.  Use sparingly.


File: python.info,  Node: Why can’t raw strings r-strings end with a backslash?,  Next: Why doesn’t Python have a “with” statement for attribute assignments?,  Prev: Why is there no goto?,  Up: Design and History FAQ

11.3.24 Why can’t raw strings (r-strings) end with a backslash?
---------------------------------------------------------------

More precisely, they can’t end with an odd number of backslashes: the
unpaired backslash at the end escapes the closing quote character,
leaving an unterminated string.

Raw strings were designed to ease creating input for processors (chiefly
regular expression engines) that want to do their own backslash escape
processing.  Such processors consider an unmatched trailing backslash to
be an error anyway, so raw strings disallow that.  In return, they allow
you to pass on the string quote character by escaping it with a
backslash.  These rules work well when r-strings are used for their
intended purpose.

If you’re trying to build Windows pathnames, note that all Windows
system calls accept forward slashes too:

     f = open("/mydir/file.txt")  # works fine!

If you’re trying to build a pathname for a DOS command, try e.g.  one of

     dir = r"\this\is\my\dos\dir" "\\" dir = r"\this\is\my\dos\dir\ "[:-1] dir = "\\this\\is\\my\\dos\\dir\\"


File: python.info,  Node: Why doesn’t Python have a “with” statement for attribute assignments?,  Next: Why are colons required for the if/while/def/class statements?,  Prev: Why can’t raw strings r-strings end with a backslash?,  Up: Design and History FAQ

11.3.25 Why doesn’t Python have a “with” statement for attribute assignments?
-----------------------------------------------------------------------------

Python has a ‘with’ statement that wraps the execution of a block,
calling code on the entrance and exit from the block.  Some language
have a construct that looks like this:

     with obj:     a = 1               # equivalent to obj.a = 1     total = total + 1   # obj.total = obj.total + 1

In Python, such a construct would be ambiguous.

Other languages, such as Object Pascal, Delphi, and C++, use static
types, so it’s possible to know, in an unambiguous way, what member is
being assigned to.  This is the main point of static typing – the
compiler `always' knows the scope of every variable at compile time.

Python uses dynamic types.  It is impossible to know in advance which
attribute will be referenced at runtime.  Member attributes may be added
or removed from objects on the fly.  This makes it impossible to know,
from a simple reading, what attribute is being referenced: a local one,
a global one, or a member attribute?

For instance, take the following incomplete snippet:

     def foo(a):     with a:         print(x)

The snippet assumes that “a” must have a member attribute called “x”.
However, there is nothing in Python that tells the interpreter this.
What should happen if “a” is, let us say, an integer?  If there is a
global variable named “x”, will it be used inside the with block?  As
you see, the dynamic nature of Python makes such choices much harder.

The primary benefit of “with” and similar language features (reduction
of code volume) can, however, easily be achieved in Python by
assignment.  Instead of:

     function(args).mydict[index][index].a = 21 function(args).mydict[index][index].b = 42 function(args).mydict[index][index].c = 63

write this:

     ref = function(args).mydict[index][index] ref.a = 21 ref.b = 42 ref.c = 63

This also has the side-effect of increasing execution speed because name
bindings are resolved at run-time in Python, and the second version only
needs to perform the resolution once.


File: python.info,  Node: Why are colons required for the if/while/def/class statements?,  Next: Why does Python allow commas at the end of lists and tuples?,  Prev: Why doesn’t Python have a “with” statement for attribute assignments?,  Up: Design and History FAQ

11.3.26 Why are colons required for the if/while/def/class statements?
----------------------------------------------------------------------

The colon is required primarily to enhance readability (one of the
results of the experimental ABC language).  Consider this:

     if a == b     print(a)

versus

     if a == b:     print(a)

Notice how the second one is slightly easier to read.  Notice further
how a colon sets off the example in this FAQ answer; it’s a standard
usage in English.

Another minor reason is that the colon makes it easier for editors with
syntax highlighting; they can look for colons to decide when indentation
needs to be increased instead of having to do a more elaborate parsing
of the program text.


File: python.info,  Node: Why does Python allow commas at the end of lists and tuples?,  Prev: Why are colons required for the if/while/def/class statements?,  Up: Design and History FAQ

11.3.27 Why does Python allow commas at the end of lists and tuples?
--------------------------------------------------------------------

Python lets you add a trailing comma at the end of lists, tuples, and
dictionaries:

     [1, 2, 3,] ('a', 'b', 'c',) d = {     "A": [1, 5],     "B": [6, 7],  # last trailing comma is optional but good style }

There are several reasons to allow this.

When you have a literal value for a list, tuple, or dictionary spread
across multiple lines, it’s easier to add more elements because you
don’t have to remember to add a comma to the previous line.  The lines
can also be reordered without creating a syntax error.

Accidentally omitting the comma can lead to errors that are hard to
diagnose.  For example:

     x = [   "fee",   "fie"   "foo",   "fum" ]

This list looks like it has four elements, but it actually contains
three: “fee”, “fiefoo” and “fum”.  Always adding the comma avoids this
source of error.

Allowing the trailing comma may also make programmatic code generation
easier.


File: python.info,  Node: Library and Extension FAQ,  Next: Extending/Embedding FAQ,  Prev: Design and History FAQ,  Up: Python Frequently Asked Questions

11.4 Library and Extension FAQ
==============================

* Menu:

* General Library Questions::
* Common tasks::
* Threads::
* Input and Output: Input and Output<2>.
* Network/Internet Programming::
* Databases::
* Mathematics and Numerics::


File: python.info,  Node: General Library Questions,  Next: Common tasks,  Up: Library and Extension FAQ

11.4.1 General Library Questions
--------------------------------

* Menu:

* How do I find a module or application to perform task X?::
* Where is the math.py (socket.py, regex.py, etc.) source file?: Where is the math py socket py regex py etc source file?.
* How do I make a Python script executable on Unix?::
* Is there a curses/termcap package for Python?::
* Is there an equivalent to C’s onexit() in Python?: Is there an equivalent to C’s onexit in Python?.
* Why don’t my signal handlers work?::


File: python.info,  Node: How do I find a module or application to perform task X?,  Next: Where is the math py socket py regex py etc source file?,  Up: General Library Questions

11.4.1.1 How do I find a module or application to perform task X?
.................................................................

Check *note the Library Reference: 1135. to see if there’s a relevant
standard library module.  (Eventually you’ll learn what’s in the
standard library and will be able to skip this step.)

For third-party packages, search the Python Package Index(1) or try
Google(2) or another Web search engine.  Searching for “Python” plus a
keyword or two for your topic of interest will usually find something
helpful.

   ---------- Footnotes ----------

   (1) https://pypi.org

   (2) https://www.google.com


File: python.info,  Node: Where is the math py socket py regex py etc source file?,  Next: How do I make a Python script executable on Unix?,  Prev: How do I find a module or application to perform task X?,  Up: General Library Questions

11.4.1.2 Where is the math.py (socket.py, regex.py, etc.) source file?
......................................................................

If you can’t find a source file for a module it may be a built-in or
dynamically loaded module implemented in C, C++ or other compiled
language.  In this case you may not have the source file or it may be
something like ‘mathmodule.c’, somewhere in a C source directory (not on
the Python Path).

There are (at least) three kinds of modules in Python:

  1. modules written in Python (.py);

  2. modules written in C and dynamically loaded (.dll, .pyd, .so, .sl,
     etc);

  3. modules written in C and linked with the interpreter; to get a list
     of these, type:

          import sys print(sys.builtin_module_names)


File: python.info,  Node: How do I make a Python script executable on Unix?,  Next: Is there a curses/termcap package for Python?,  Prev: Where is the math py socket py regex py etc source file?,  Up: General Library Questions

11.4.1.3 How do I make a Python script executable on Unix?
..........................................................

You need to do two things: the script file’s mode must be executable and
the first line must begin with ‘#!’ followed by the path of the Python
interpreter.

The first is done by executing ‘chmod +x scriptfile’ or perhaps ‘chmod
755 scriptfile’.

The second can be done in a number of ways.  The most straightforward
way is to write

     #!/usr/local/bin/python

as the very first line of your file, using the pathname for where the
Python interpreter is installed on your platform.

If you would like the script to be independent of where the Python
interpreter lives, you can use the ‘env’ program.  Almost all Unix
variants support the following, assuming the Python interpreter is in a
directory on the user’s ‘PATH’:

     #!/usr/bin/env python

`Don’t' do this for CGI scripts.  The ‘PATH’ variable for CGI scripts is
often very minimal, so you need to use the actual absolute pathname of
the interpreter.

Occasionally, a user’s environment is so full that the ‘/usr/bin/env’
program fails; or there’s no env program at all.  In that case, you can
try the following hack (due to Alex Rezinsky):

     #! /bin/sh """:" exec python $0 ${1+"$@"} """

The minor disadvantage is that this defines the script’s __doc__ string.
However, you can fix that by adding

     __doc__ = """...Whatever..."""


File: python.info,  Node: Is there a curses/termcap package for Python?,  Next: Is there an equivalent to C’s onexit in Python?,  Prev: How do I make a Python script executable on Unix?,  Up: General Library Questions

11.4.1.4 Is there a curses/termcap package for Python?
......................................................

For Unix variants: The standard Python source distribution comes with a
curses module in the Modules(1) subdirectory, though it’s not compiled
by default.  (Note that this is not available in the Windows
distribution – there is no curses module for Windows.)

The *note curses: 2c. module supports basic curses features as well as
many additional functions from ncurses and SYSV curses such as colour,
alternative character set support, pads, and mouse support.  This means
the module isn’t compatible with operating systems that only have BSD
curses, but there don’t seem to be any currently maintained OSes that
fall into this category.

For Windows: use the consolelib module(2).

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Modules

   (2) http://effbot.org/zone/console-index.htm


File: python.info,  Node: Is there an equivalent to C’s onexit in Python?,  Next: Why don’t my signal handlers work?,  Prev: Is there a curses/termcap package for Python?,  Up: General Library Questions

11.4.1.5 Is there an equivalent to C’s onexit() in Python?
..........................................................

The *note atexit: c. module provides a register function that is similar
to C’s ‘onexit()’.


File: python.info,  Node: Why don’t my signal handlers work?,  Prev: Is there an equivalent to C’s onexit in Python?,  Up: General Library Questions

11.4.1.6 Why don’t my signal handlers work?
...........................................

The most common problem is that the signal handler is declared with the
wrong argument list.  It is called as

     handler(signum, frame)

so it should be declared with two arguments:

     def handler(signum, frame):     ...


File: python.info,  Node: Common tasks,  Next: Threads,  Prev: General Library Questions,  Up: Library and Extension FAQ

11.4.2 Common tasks
-------------------

* Menu:

* How do I test a Python program or component?::
* How do I create documentation from doc strings?::
* How do I get a single keypress at a time?::


File: python.info,  Node: How do I test a Python program or component?,  Next: How do I create documentation from doc strings?,  Up: Common tasks

11.4.2.1 How do I test a Python program or component?
.....................................................

Python comes with two testing frameworks.  The *note doctest: 67. module
finds examples in the docstrings for a module and runs them, comparing
the output with the expected output given in the docstring.

The *note unittest: 11b. module is a fancier testing framework modelled
on Java and Smalltalk testing frameworks.

To make testing easier, you should use good modular design in your
program.  Your program should have almost all functionality encapsulated
in either functions or class methods – and this sometimes has the
surprising and delightful effect of making the program run faster
(because local variable accesses are faster than global accesses).
Furthermore the program should avoid depending on mutating global
variables, since this makes testing much more difficult to do.

The “global main logic” of your program may be as simple as

     if __name__ == "__main__":     main_logic()

at the bottom of the main module of your program.

Once your program is organized as a tractable collection of functions
and class behaviours you should write test functions that exercise the
behaviours.  A test suite that automates a sequence of tests can be
associated with each module.  This sounds like a lot of work, but since
Python is so terse and flexible it’s surprisingly easy.  You can make
coding much more pleasant and fun by writing your test functions in
parallel with the “production code”, since this makes it easy to find
bugs and even design flaws earlier.

“Support modules” that are not intended to be the main module of a
program may include a self-test of the module.

     if __name__ == "__main__":     self_test()

Even programs that interact with complex external interfaces may be
tested when the external interfaces are unavailable by using “fake”
interfaces implemented in Python.


File: python.info,  Node: How do I create documentation from doc strings?,  Next: How do I get a single keypress at a time?,  Prev: How do I test a Python program or component?,  Up: Common tasks

11.4.2.2 How do I create documentation from doc strings?
........................................................

The *note pydoc: d9. module can create HTML from the doc strings in your
Python source code.  An alternative for creating API documentation
purely from docstrings is epydoc(1).  Sphinx(2) can also include
docstring content.

   ---------- Footnotes ----------

   (1) http://epydoc.sourceforge.net/

   (2) http://sphinx-doc.org


File: python.info,  Node: How do I get a single keypress at a time?,  Prev: How do I create documentation from doc strings?,  Up: Common tasks

11.4.2.3 How do I get a single keypress at a time?
..................................................

For Unix variants there are several solutions.  It’s straightforward to
do this using curses, but curses is a fairly large module to learn.


File: python.info,  Node: Threads,  Next: Input and Output<2>,  Prev: Common tasks,  Up: Library and Extension FAQ

11.4.3 Threads
--------------

* Menu:

* How do I program using threads?::
* None of my threads seem to run; why?: None of my threads seem to run why?.
* How do I parcel out work among a bunch of worker threads?::
* What kinds of global value mutation are thread-safe?::
* Can’t we get rid of the Global Interpreter Lock?::


File: python.info,  Node: How do I program using threads?,  Next: None of my threads seem to run why?,  Up: Threads

11.4.3.1 How do I program using threads?
........................................

Be sure to use the *note threading: 109. module and not the *note
_thread: 3. module.  The *note threading: 109. module builds convenient
abstractions on top of the low-level primitives provided by the *note
_thread: 3. module.

Aahz has a set of slides from his threading tutorial that are helpful;
see ‘http://www.pythoncraft.com/OSCON2001/’.


File: python.info,  Node: None of my threads seem to run why?,  Next: How do I parcel out work among a bunch of worker threads?,  Prev: How do I program using threads?,  Up: Threads

11.4.3.2 None of my threads seem to run: why?
.............................................

As soon as the main thread exits, all threads are killed.  Your main
thread is running too quickly, giving the threads no time to do any
work.

A simple fix is to add a sleep to the end of the program that’s long
enough for all the threads to finish:

     import threading, time  def thread_task(name, n):     for i in range(n):         print(name, i)  for i in range(10):     T = threading.Thread(target=thread_task, args=(str(i), i))     T.start()  time.sleep(10)  # <---------------------------!

But now (on many platforms) the threads don’t run in parallel, but
appear to run sequentially, one at a time!  The reason is that the OS
thread scheduler doesn’t start a new thread until the previous thread is
blocked.

A simple fix is to add a tiny sleep to the start of the run function:

     def thread_task(name, n):     time.sleep(0.001)  # <--------------------!     for i in range(n):         print(name, i)  for i in range(10):     T = threading.Thread(target=thread_task, args=(str(i), i))     T.start()  time.sleep(10)

Instead of trying to guess a good delay value for *note time.sleep():
674, it’s better to use some kind of semaphore mechanism.  One idea is
to use the *note queue: da. module to create a queue object, let each
thread append a token to the queue when it finishes, and let the main
thread read as many tokens from the queue as there are threads.


File: python.info,  Node: How do I parcel out work among a bunch of worker threads?,  Next: What kinds of global value mutation are thread-safe?,  Prev: None of my threads seem to run why?,  Up: Threads

11.4.3.3 How do I parcel out work among a bunch of worker threads?
..................................................................

The easiest way is to use the new *note concurrent.futures: 22. module,
especially the *note ThreadPoolExecutor: 278. class.

Or, if you want fine control over the dispatching algorithm, you can
write your own logic manually.  Use the *note queue: da. module to
create a queue containing a list of jobs.  The *note Queue: d0b. class
maintains a list of objects and has a ‘.put(obj)’ method that adds items
to the queue and a ‘.get()’ method to return them.  The class will take
care of the locking necessary to ensure that each job is handed out
exactly once.

Here’s a trivial example:

     import threading, queue, time  # The worker thread gets jobs off the queue.  When the queue is empty, it # assumes there will be no more work and exits. # (Realistically workers will run until terminated.) def worker():     print('Running worker')     time.sleep(0.1)     while True:         try:             arg = q.get(block=False)         except queue.Empty:             print('Worker', threading.currentThread(), end=' ')             print('queue empty')             break         else:             print('Worker', threading.currentThread(), end=' ')             print('running with argument', arg)             time.sleep(0.5)  # Create queue q = queue.Queue()  # Start a pool of 5 workers for i in range(5):     t = threading.Thread(target=worker, name='worker %i' % (i+1))     t.start()  # Begin adding work to the queue for i in range(50):     q.put(i)  # Give threads time to run print('Main thread sleeping') time.sleep(5)

When run, this will produce the following output:

     Running worker Running worker Running worker Running worker Running worker Main thread sleeping Worker <Thread(worker 1, started 130283832797456)> running with argument 0 Worker <Thread(worker 2, started 130283824404752)> running with argument 1 Worker <Thread(worker 3, started 130283816012048)> running with argument 2 Worker <Thread(worker 4, started 130283807619344)> running with argument 3 Worker <Thread(worker 5, started 130283799226640)> running with argument 4 Worker <Thread(worker 1, started 130283832797456)> running with argument 5 ...

Consult the module’s documentation for more details; the *note Queue:
d0b. class provides a featureful interface.


File: python.info,  Node: What kinds of global value mutation are thread-safe?,  Next: Can’t we get rid of the Global Interpreter Lock?,  Prev: How do I parcel out work among a bunch of worker threads?,  Up: Threads

11.4.3.4 What kinds of global value mutation are thread-safe?
.............................................................

A *note global interpreter lock: 4fb. (GIL) is used internally to ensure
that only one thread runs in the Python VM at a time.  In general,
Python offers to switch among threads only between bytecode
instructions; how frequently it switches can be set via *note
sys.setswitchinterval(): bde.  Each bytecode instruction and therefore
all the C implementation code reached from each instruction is therefore
atomic from the point of view of a Python program.

In theory, this means an exact accounting requires an exact
understanding of the PVM bytecode implementation.  In practice, it means
that operations on shared variables of built-in data types (ints, lists,
dicts, etc) that “look atomic” really are.

For example, the following operations are all atomic (L, L1, L2 are
lists, D, D1, D2 are dicts, x, y are objects, i, j are ints):

     L.append(x) L1.extend(L2) x = L[i] x = L.pop() L1[i:j] = L2 L.sort() x = y x.field = y D[x] = y D1.update(D2) D.keys()

These aren’t:

     i = i+1 L.append(L[-1]) L[i] = L[j] D[x] = D[x] + 1

Operations that replace other objects may invoke those other objects’
*note __del__(): 913. method when their reference count reaches zero,
and that can affect things.  This is especially true for the mass
updates to dictionaries and lists.  When in doubt, use a mutex!


File: python.info,  Node: Can’t we get rid of the Global Interpreter Lock?,  Prev: What kinds of global value mutation are thread-safe?,  Up: Threads

11.4.3.5 Can’t we get rid of the Global Interpreter Lock?
.........................................................

The *note global interpreter lock: 4fb. (GIL) is often seen as a
hindrance to Python’s deployment on high-end multiprocessor server
machines, because a multi-threaded Python program effectively only uses
one CPU, due to the insistence that (almost) all Python code can only
run while the GIL is held.

Back in the days of Python 1.5, Greg Stein actually implemented a
comprehensive patch set (the “free threading” patches) that removed the
GIL and replaced it with fine-grained locking.  Adam Olsen recently did
a similar experiment in his python-safethread(1) project.
Unfortunately, both experiments exhibited a sharp drop in single-thread
performance (at least 30% slower), due to the amount of fine-grained
locking necessary to compensate for the removal of the GIL.

This doesn’t mean that you can’t make good use of Python on multi-CPU
machines!  You just have to be creative with dividing the work up
between multiple `processes' rather than multiple `threads'.  The *note
ProcessPoolExecutor: 2a2. class in the new *note concurrent.futures: 22.
module provides an easy way of doing so; the *note multiprocessing: b7.
module provides a lower-level API in case you want more control over
dispatching of tasks.

Judicious use of C extensions will also help; if you use a C extension
to perform a time-consuming task, the extension can release the GIL
while the thread of execution is in the C code and allow other threads
to get some work done.  Some standard library modules such as *note
zlib: 144. and *note hashlib: 8d. already do this.

It has been suggested that the GIL should be a per-interpreter-state
lock rather than truly global; interpreters then wouldn’t be able to
share objects.  Unfortunately, this isn’t likely to happen either.  It
would be a tremendous amount of work, because many object
implementations currently have global state.  For example, small
integers and short strings are cached; these caches would have to be
moved to the interpreter state.  Other object types have their own free
list; these free lists would have to be moved to the interpreter state.
And so on.

And I doubt that it can even be done in finite time, because the same
problem exists for 3rd party extensions.  It is likely that 3rd party
extensions are being written at a faster rate than you can convert them
to store all their global state in the interpreter state.

And finally, once you have multiple interpreters not sharing any state,
what have you gained over running each interpreter in a separate
process?

   ---------- Footnotes ----------

   (1) https://code.google.com/archive/p/python-safethread


File: python.info,  Node: Input and Output<2>,  Next: Network/Internet Programming,  Prev: Threads,  Up: Library and Extension FAQ

11.4.4 Input and Output
-----------------------

* Menu:

* How do I delete a file? (And other file questions…): How do I delete a file? And other file questions….
* How do I copy a file?::
* How do I read (or write) binary data?: How do I read or write binary data?.
* I can’t seem to use os.read() on a pipe created with os.popen(); why?: I can’t seem to use os read on a pipe created with os popen ; why?.
* How do I access the serial (RS232) port?: How do I access the serial RS232 port?.
* Why doesn’t closing sys.stdout (stdin, stderr) really close it?: Why doesn’t closing sys stdout stdin stderr really close it?.


File: python.info,  Node: How do I delete a file? And other file questions…,  Next: How do I copy a file?,  Up: Input and Output<2>

11.4.4.1 How do I delete a file? (And other file questions…)
............................................................

Use ‘os.remove(filename)’ or ‘os.unlink(filename)’; for documentation,
see the *note os: c4. module.  The two functions are identical; *note
unlink(): a31. is simply the name of the Unix system call for this
function.

To remove a directory, use *note os.rmdir(): a2f.; use *note os.mkdir():
a2b. to create one.  ‘os.makedirs(path)’ will create any intermediate
directories in ‘path’ that don’t exist.  ‘os.removedirs(path)’ will
remove intermediate directories as long as they’re empty; if you want to
delete an entire directory tree and its contents, use *note
shutil.rmtree(): 21a.

To rename a file, use ‘os.rename(old_path, new_path)’.

To truncate a file, open it using ‘f = open(filename, "rb+")’, and use
‘f.truncate(offset)’; offset defaults to the current seek position.
There’s also ‘os.ftruncate(fd, offset)’ for files opened with *note
os.open(): 659, where `fd' is the file descriptor (a small integer).

The *note shutil: e9. module also contains a number of functions to work
on files including *note copyfile(): 256, *note copytree(): 218, and
*note rmtree(): 21a.


File: python.info,  Node: How do I copy a file?,  Next: How do I read or write binary data?,  Prev: How do I delete a file? And other file questions…,  Up: Input and Output<2>

11.4.4.2 How do I copy a file?
..............................

The *note shutil: e9. module contains a *note copyfile(): 256. function.
Note that on MacOS 9 it doesn’t copy the resource fork and Finder info.


File: python.info,  Node: How do I read or write binary data?,  Next: I can’t seem to use os read on a pipe created with os popen ; why?,  Prev: How do I copy a file?,  Up: Input and Output<2>

11.4.4.3 How do I read (or write) binary data?
..............................................

To read or write complex binary data formats, it’s best to use the *note
struct: f8. module.  It allows you to take a string containing binary
data (usually numbers) and convert it to Python objects; and vice versa.

For example, the following code reads two 2-byte integers and one 4-byte
integer in big-endian format from a file:

     import struct  with open(filename, "rb") as f:     s = f.read(8)     x, y, z = struct.unpack(">hhl", s)

The ‘>’ in the format string forces big-endian data; the letter ‘h’
reads one “short integer” (2 bytes), and ‘l’ reads one “long integer” (4
bytes) from the string.

For data that is more regular (e.g.  a homogeneous list of ints or
floats), you can also use the *note array: 7. module.

     Note: To read and write binary data, it is mandatory to open the
     file in binary mode (here, passing ‘"rb"’ to *note open(): 4e5.).
     If you use ‘"r"’ instead (the default), the file will be open in
     text mode and ‘f.read()’ will return *note str: 325. objects rather
     than *note bytes: 326. objects.


File: python.info,  Node: I can’t seem to use os read on a pipe created with os popen ; why?,  Next: How do I access the serial RS232 port?,  Prev: How do I read or write binary data?,  Up: Input and Output<2>

11.4.4.4 I can’t seem to use os.read() on a pipe created with os.popen(); why?
..............................................................................

*note os.read(): 65c. is a low-level function which takes a file
descriptor, a small integer representing the opened file.  *note
os.popen(): 2a7. creates a high-level file object, the same type
returned by the built-in *note open(): 4e5. function.  Thus, to read `n'
bytes from a pipe `p' created with *note os.popen(): 2a7, you need to
use ‘p.read(n)’.


File: python.info,  Node: How do I access the serial RS232 port?,  Next: Why doesn’t closing sys stdout stdin stderr really close it?,  Prev: I can’t seem to use os read on a pipe created with os popen ; why?,  Up: Input and Output<2>

11.4.4.5 How do I access the serial (RS232) port?
.................................................

For Win32, POSIX (Linux, BSD, etc.), Jython:

     ‘http://pyserial.sourceforge.net’

For Unix, see a Usenet post by Mitch Chapman:

     ‘https://groups.google.com/groups?selm=34A04430.CF9@ohioee.com’


File: python.info,  Node: Why doesn’t closing sys stdout stdin stderr really close it?,  Prev: How do I access the serial RS232 port?,  Up: Input and Output<2>

11.4.4.6 Why doesn’t closing sys.stdout (stdin, stderr) really close it?
........................................................................

Python *note file objects: b35. are a high-level layer of abstraction on
low-level C file descriptors.

For most file objects you create in Python via the built-in *note
open(): 4e5. function, ‘f.close()’ marks the Python file object as being
closed from Python’s point of view, and also arranges to close the
underlying C file descriptor.  This also happens automatically in ‘f’’s
destructor, when ‘f’ becomes garbage.

But stdin, stdout and stderr are treated specially by Python, because of
the special status also given to them by C. Running ‘sys.stdout.close()’
marks the Python-level file object as being closed, but does `not' close
the associated C file descriptor.

To close the underlying C file descriptor for one of these three, you
should first be sure that’s what you really want to do (e.g., you may
confuse extension modules trying to do I/O). If it is, use *note
os.close(): 3c7.:

     os.close(stdin.fileno()) os.close(stdout.fileno()) os.close(stderr.fileno())

Or you can use the numeric constants 0, 1 and 2, respectively.


File: python.info,  Node: Network/Internet Programming,  Next: Databases,  Prev: Input and Output<2>,  Up: Library and Extension FAQ

11.4.5 Network/Internet Programming
-----------------------------------

* Menu:

* What WWW tools are there for Python?::
* How can I mimic CGI form submission (METHOD=POST)?: How can I mimic CGI form submission METHOD=POST ?.
* What module should I use to help with generating HTML?::
* How do I send mail from a Python script?::
* How do I avoid blocking in the connect() method of a socket?: How do I avoid blocking in the connect method of a socket?.


File: python.info,  Node: What WWW tools are there for Python?,  Next: How can I mimic CGI form submission METHOD=POST ?,  Up: Network/Internet Programming

11.4.5.1 What WWW tools are there for Python?
.............................................

See the chapters titled *note Internet Protocols and Support: 2b02. and
*note Internet Data Handling: 2706. in the Library Reference Manual.
Python has many modules that will help you build server-side and
client-side web systems.

A summary of available frameworks is maintained by Paul Boddie at
‘https://wiki.python.org/moin/WebProgramming’.

Cameron Laird maintains a useful set of pages about Python web
technologies at ‘http://phaseit.net/claird/comp.lang.python/web_python’.


File: python.info,  Node: How can I mimic CGI form submission METHOD=POST ?,  Next: What module should I use to help with generating HTML?,  Prev: What WWW tools are there for Python?,  Up: Network/Internet Programming

11.4.5.2 How can I mimic CGI form submission (METHOD=POST)?
...........................................................

I would like to retrieve web pages that are the result of POSTing a
form.  Is there existing code that would let me do this easily?

Yes.  Here’s a simple example that uses urllib.request:

     #!/usr/local/bin/python  import urllib.request  # build the query string qs = "First=Josephine&MI=Q&Last=Public"  # connect and send the server a path req = urllib.request.urlopen('http://www.some-server.out-there'                              '/cgi-bin/some-cgi-script', data=qs) with req:     msg, hdrs = req.read(), req.info()

Note that in general for percent-encoded POST operations, query strings
must be quoted using *note urllib.parse.urlencode(): 77f.  For example,
to send ‘name=Guy Steele, Jr.’:

     >>> import urllib.parse >>> urllib.parse.urlencode({'name': 'Guy Steele, Jr.'}) 'name=Guy+Steele%2C+Jr.'

See also
........

*note HOWTO Fetch Internet Resources Using The urllib Package: 2be8. for
extensive examples.


File: python.info,  Node: What module should I use to help with generating HTML?,  Next: How do I send mail from a Python script?,  Prev: How can I mimic CGI form submission METHOD=POST ?,  Up: Network/Internet Programming

11.4.5.3 What module should I use to help with generating HTML?
...............................................................

You can find a collection of useful links on the Web Programming wiki
page(1).

   ---------- Footnotes ----------

   (1) https://wiki.python.org/moin/WebProgramming


File: python.info,  Node: How do I send mail from a Python script?,  Next: How do I avoid blocking in the connect method of a socket?,  Prev: What module should I use to help with generating HTML?,  Up: Network/Internet Programming

11.4.5.4 How do I send mail from a Python script?
.................................................

Use the standard library module *note smtplib: ed.

Here’s a very simple interactive mail sender that uses it.  This method
will work on any host that supports an SMTP listener.

     import sys, smtplib  fromaddr = input("From: ") toaddrs  = input("To: ").split(',') print("Enter message, end with ^D:") msg = '' while True:     line = sys.stdin.readline()     if not line:         break     msg += line  # The actual mail send server = smtplib.SMTP('localhost') server.sendmail(fromaddr, toaddrs, msg) server.quit()

A Unix-only alternative uses sendmail.  The location of the sendmail
program varies between systems; sometimes it is ‘/usr/lib/sendmail’,
sometimes ‘/usr/sbin/sendmail’.  The sendmail manual page will help you
out.  Here’s some sample code:

     import os  SENDMAIL = "/usr/sbin/sendmail"  # sendmail location p = os.popen("%s -t -i" % SENDMAIL, "w") p.write("To: receiver@example.com\n") p.write("Subject: test\n") p.write("\n")  # blank line separating headers from body p.write("Some text\n") p.write("some more text\n") sts = p.close() if sts != 0:     print("Sendmail exit status", sts)


File: python.info,  Node: How do I avoid blocking in the connect method of a socket?,  Prev: How do I send mail from a Python script?,  Up: Network/Internet Programming

11.4.5.5 How do I avoid blocking in the connect() method of a socket?
.....................................................................

The *note select: e5. module is commonly used to help with asynchronous
I/O on sockets.

To prevent the TCP connect from blocking, you can set the socket to
non-blocking mode.  Then when you do the ‘connect()’, you will either
connect immediately (unlikely) or get an exception that contains the
error number as ‘.errno’.  ‘errno.EINPROGRESS’ indicates that the
connection is in progress, but hasn’t finished yet.  Different OSes will
return different values, so you’re going to have to check what’s
returned on your system.

You can use the ‘connect_ex()’ method to avoid creating an exception.
It will just return the errno value.  To poll, you can call
‘connect_ex()’ again later – ‘0’ or ‘errno.EISCONN’ indicate that you’re
connected – or you can pass this socket to select to check if it’s
writable.

     Note: The *note asyncore: b. module presents a framework-like
     approach to the problem of writing non-blocking networking code.
     The third-party Twisted(1) library is a popular and feature-rich
     alternative.

   ---------- Footnotes ----------

   (1) https://twistedmatrix.com/trac/


File: python.info,  Node: Databases,  Next: Mathematics and Numerics,  Prev: Network/Internet Programming,  Up: Library and Extension FAQ

11.4.6 Databases
----------------

* Menu:

* Are there any interfaces to database packages in Python?::
* How do you implement persistent objects in Python?::


File: python.info,  Node: Are there any interfaces to database packages in Python?,  Next: How do you implement persistent objects in Python?,  Up: Databases

11.4.6.1 Are there any interfaces to database packages in Python?
.................................................................

Yes.

Interfaces to disk-based hashes such as *note DBM: 35. and *note GDBM:
34. are also included with standard Python.  There is also the *note
sqlite3: f2. module, which provides a lightweight disk-based relational
database.

Support for most relational databases is available.  See the
DatabaseProgramming wiki page(1) for details.

   ---------- Footnotes ----------

   (1) https://wiki.python.org/moin/DatabaseProgramming


File: python.info,  Node: How do you implement persistent objects in Python?,  Prev: Are there any interfaces to database packages in Python?,  Up: Databases

11.4.6.2 How do you implement persistent objects in Python?
...........................................................

The *note pickle: ca. library module solves this in a very general way
(though you still can’t store things like open files, sockets or
windows), and the *note shelve: e7. library module uses pickle and
(g)dbm to create persistent mappings containing arbitrary Python
objects.


File: python.info,  Node: Mathematics and Numerics,  Prev: Databases,  Up: Library and Extension FAQ

11.4.7 Mathematics and Numerics
-------------------------------

* Menu:

* How do I generate random numbers in Python?::


File: python.info,  Node: How do I generate random numbers in Python?,  Up: Mathematics and Numerics

11.4.7.1 How do I generate random numbers in Python?
....................................................

The standard module *note random: dc. implements a random number
generator.  Usage is simple:

     import random random.random()

This returns a random floating point number in the range [0, 1).

There are also many other specialized generators in this module, such
as:

   * ‘randrange(a, b)’ chooses an integer in the range [a, b).

   * ‘uniform(a, b)’ chooses a floating point number in the range [a,
     b).

   * ‘normalvariate(mean, sdev)’ samples the normal (Gaussian)
     distribution.

Some higher-level functions operate on sequences directly, such as:

   * ‘choice(S)’ chooses random element from a given sequence

   * ‘shuffle(L)’ shuffles a list in-place, i.e.  permutes it randomly

There’s also a ‘Random’ class you can instantiate to create independent
multiple random number generators.


File: python.info,  Node: Extending/Embedding FAQ,  Next: Python on Windows FAQ,  Prev: Library and Extension FAQ,  Up: Python Frequently Asked Questions

11.5 Extending/Embedding FAQ
============================

* Menu:

* 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 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 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?: I want to compile a Python module on my Linux system but some files are missing Why?.
* 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)?: Can I create an object class with some methods implemented in C and others in Python e g through inheritance ?.


File: python.info,  Node: Can I create my own functions in C?,  Next: Can I create my own functions in C++?,  Up: Extending/Embedding FAQ

11.5.1 Can I create my own functions in C?
------------------------------------------

Yes, you can create built-in modules containing functions, variables,
exceptions and even new types in C. This is explained in the document
*note Extending and Embedding the Python Interpreter: 1137.

Most intermediate or advanced Python books will also cover this topic.


File: python.info,  Node: Can I create my own functions in C++?,  Next: Writing C is hard; are there any alternatives?,  Prev: Can I create my own functions in C?,  Up: Extending/Embedding FAQ

11.5.2 Can I create my own functions in C++?
--------------------------------------------

Yes, using the C compatibility features found in C++.  Place ‘extern "C"
{ ... }’ around the Python include files and put ‘extern "C"’ before
each function that is going to be called by the Python interpreter.
Global or static C++ objects with constructors are probably not a good
idea.


File: python.info,  Node: Writing C is hard; are there any alternatives?,  Next: How can I execute arbitrary Python statements from C?,  Prev: Can I create my own functions in C++?,  Up: Extending/Embedding FAQ

11.5.3 Writing C is hard; are there any alternatives?
-----------------------------------------------------

There are a number of alternatives to writing your own C extensions,
depending on what you’re trying to do.

Cython(1) and its relative Pyrex(2) are compilers that accept a slightly
modified form of Python and generate the corresponding C code.  Cython
and Pyrex make it possible to write an extension without having to learn
Python’s C API.

If you need to interface to some C or C++ library for which no Python
extension currently exists, you can try wrapping the library’s data
types and functions with a tool such as SWIG(3). SIP(4), CXX(5)
Boost(6), or Weave(7) are also alternatives for wrapping C++ libraries.

   ---------- Footnotes ----------

   (1) http://cython.org

   (2) https://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/

   (3) http://www.swig.org

   (4) https://riverbankcomputing.com/software/sip/intro

   (5) http://cxx.sourceforge.net/

   (6) http://www.boost.org/libs/python/doc/index.html

   (7) https://github.com/scipy/weave


File: python.info,  Node: How can I execute arbitrary Python statements from C?,  Next: How can I evaluate an arbitrary Python expression from C?,  Prev: Writing C is hard; are there any alternatives?,  Up: Extending/Embedding FAQ

11.5.4 How can I execute arbitrary Python statements from C?
------------------------------------------------------------

The highest-level function to do this is *note PyRun_SimpleString():
3acc. which takes a single string argument to be executed in the context
of the module ‘__main__’ and returns ‘0’ for success and ‘-1’ when an
exception occurred (including *note SyntaxError: 44d.).  If you want
more control, use *note PyRun_String(): ee5.; see the source for *note
PyRun_SimpleString(): 3acc. in ‘Python/pythonrun.c’.


File: python.info,  Node: How can I evaluate an arbitrary Python expression from C?,  Next: How do I extract C values from a Python object?,  Prev: How can I execute arbitrary Python statements from C?,  Up: Extending/Embedding FAQ

11.5.5 How can I evaluate an arbitrary Python expression from C?
----------------------------------------------------------------

Call the function *note PyRun_String(): ee5. from the previous question
with the start symbol *note Py_eval_input: 3b27.; it parses an
expression, evaluates it and returns its value.


File: python.info,  Node: How do I extract C values from a Python object?,  Next: How do I use Py_BuildValue to create a tuple of arbitrary length?,  Prev: How can I evaluate an arbitrary Python expression from C?,  Up: Extending/Embedding FAQ

11.5.6 How do I extract C values from a Python object?
------------------------------------------------------

That depends on the object’s type.  If it’s a tuple, *note
PyTuple_Size(): 3d86. returns its length and *note PyTuple_GetItem():
3a60. returns the item at a specified index.  Lists have similar
functions, ‘PyListSize()’ and *note PyList_GetItem(): 3a61.

For bytes, *note PyBytes_Size(): 3d0e. returns its length and *note
PyBytes_AsStringAndSize(): 3d12. provides a pointer to its value and its
length.  Note that Python bytes objects may contain null bytes so C’s
‘strlen()’ should not be used.

To test the type of an object, first make sure it isn’t ‘NULL’, and then
use *note PyBytes_Check(): d12, *note PyTuple_Check(): 3d82, *note
PyList_Check(): 3d97, etc.

There is also a high-level API to Python objects which is provided by
the so-called ‘abstract’ interface – read ‘Include/abstract.h’ for
further details.  It allows interfacing with any kind of Python sequence
using calls like *note PySequence_Length(): 3c3a, *note
PySequence_GetItem(): f86, etc.  as well as many other useful protocols
such as numbers (*note PyNumber_Index(): 3c33. et al.)  and mappings in
the PyMapping APIs.


File: python.info,  Node: How do I use Py_BuildValue to create a tuple of arbitrary length?,  Next: How do I call an object’s method from C?,  Prev: How do I extract C values from a Python object?,  Up: Extending/Embedding FAQ

11.5.7 How do I use Py_BuildValue() to create a tuple of arbitrary length?
--------------------------------------------------------------------------

You can’t.  Use *note PyTuple_Pack(): 3d85. instead.


File: python.info,  Node: How do I call an object’s method from C?,  Next: How do I catch the output from PyErr_Print or anything that prints to stdout/stderr ?,  Prev: How do I use Py_BuildValue to create a tuple of arbitrary length?,  Up: Extending/Embedding FAQ

11.5.8 How do I call an object’s method from C?
-----------------------------------------------

The *note PyObject_CallMethod(): 3c04. function can be used to call an
arbitrary method of an object.  The parameters are the object, the name
of the method to call, a format string like that used with *note
Py_BuildValue(): 2cc, and the argument values:

     PyObject * PyObject_CallMethod(PyObject *object, const char *method_name,                     const char *arg_format, ...);

This works for any object that has methods – whether built-in or
user-defined.  You are responsible for eventually *note Py_DECREF():
264.’ing the return value.

To call, e.g., a file object’s “seek” method with arguments 10, 0
(assuming the file object pointer is “f”):

     res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0); if (res == NULL) {         ... an exception occurred ... } else {         Py_DECREF(res); }

Note that since *note PyObject_CallObject(): 3a53. `always' wants a
tuple for the argument list, to call a function without arguments, pass
“()” for the format, and to call a function with one argument, surround
the argument in parentheses, e.g.  “(i)”.


File: python.info,  Node: How do I catch the output from PyErr_Print or anything that prints to stdout/stderr ?,  Next: How do I access a module written in Python from C?,  Prev: How do I call an object’s method from C?,  Up: Extending/Embedding FAQ

11.5.9 How do I catch the output from PyErr_Print() (or anything that prints to stdout/stderr)?
-----------------------------------------------------------------------------------------------

In Python code, define an object that supports the ‘write()’ method.
Assign this object to *note sys.stdout: 303. and *note sys.stderr: 304.
Call print_error, or just allow the standard traceback mechanism to
work.  Then, the output will go wherever your ‘write()’ method sends it.

The easiest way to do this is to use the *note io.StringIO: 821. class:

     >>> import io, sys >>> sys.stdout = io.StringIO() >>> print('foo') >>> print('hello world!') >>> sys.stderr.write(sys.stdout.getvalue()) foo hello world!

A custom object to do the same would look like this:

     >>> import io, sys >>> class StdoutCatcher(io.TextIOBase): ...     def __init__(self): ...         self.data = [] ...     def write(self, stuff): ...         self.data.append(stuff) ... >>> import sys >>> sys.stdout = StdoutCatcher() >>> print('foo') >>> print('hello world!') >>> sys.stderr.write(''.join(sys.stdout.data)) foo hello world!


File: python.info,  Node: How do I access a module written in Python from C?,  Next: How do I interface to C++ objects from Python?,  Prev: How do I catch the output from PyErr_Print or anything that prints to stdout/stderr ?,  Up: Extending/Embedding FAQ

11.5.10 How do I access a module written in Python from C?
----------------------------------------------------------

You can get a pointer to the module object as follows:

     module = PyImport_ImportModule("<modulename>");

If the module hasn’t been imported yet (i.e.  it is not yet present in
*note sys.modules: 13eb.), this initializes the module; otherwise it
simply returns the value of ‘sys.modules["<modulename>"]’.  Note that it
doesn’t enter the module into any namespace – it only ensures it has
been initialized and is stored in *note sys.modules: 13eb.

You can then access the module’s attributes (i.e.  any name defined in
the module) as follows:

     attr = PyObject_GetAttrString(module, "<attrname>");

Calling *note PyObject_SetAttrString(): 3bfb. to assign to variables in
the module also works.


File: python.info,  Node: How do I interface to C++ objects from Python?,  Next: I added a module using the Setup file and the make fails; why?,  Prev: How do I access a module written in Python from C?,  Up: Extending/Embedding FAQ

11.5.11 How do I interface to C++ objects from Python?
------------------------------------------------------

Depending on your requirements, there are many approaches.  To do this
manually, begin by reading *note the “Extending and Embedding” document:
1137.  Realize that for the Python run-time system, there isn’t a whole
lot of difference between C and C++ – so the strategy of building a new
Python type around a C structure (pointer) type will also work for C++
objects.

For C++ libraries, see *note Writing C is hard; are there any
alternatives?: 4225.


File: python.info,  Node: I added a module using the Setup file and the make fails; why?,  Next: How do I debug an extension?,  Prev: How do I interface to C++ objects from Python?,  Up: Extending/Embedding FAQ

11.5.12 I added a module using the Setup file and the make fails; why?
----------------------------------------------------------------------

Setup must end in a newline, if there is no newline there, the build
process fails.  (Fixing this requires some ugly shell script hackery,
and this bug is so minor that it doesn’t seem worth the effort.)


File: python.info,  Node: How do I debug an extension?,  Next: I want to compile a Python module on my Linux system but some files are missing Why?,  Prev: I added a module using the Setup file and the make fails; why?,  Up: Extending/Embedding FAQ

11.5.13 How do I debug an extension?
------------------------------------

When using GDB with dynamically loaded extensions, you can’t set a
breakpoint in your extension until your extension is loaded.

In your ‘.gdbinit’ file (or interactively), add the command:

     br _PyImport_LoadDynamicModule

Then, when you run GDB:

     $ gdb /local/bin/python gdb) run myscript.py gdb) continue # repeat until your extension is loaded gdb) finish   # so that your extension is loaded gdb) br myfunction.c:50 gdb) continue


File: python.info,  Node: I want to compile a Python module on my Linux system but some files are missing Why?,  Next: How do I tell “incomplete input” from “invalid input”?,  Prev: How do I debug an extension?,  Up: Extending/Embedding FAQ

11.5.14 I want to compile a Python module on my Linux system, but some files are missing. Why?
----------------------------------------------------------------------------------------------

Most packaged versions of Python don’t include the
‘/usr/lib/python2.`x'/config/’ directory, which contains various files
required for compiling Python extensions.

For Red Hat, install the python-devel RPM to get the necessary files.

For Debian, run ‘apt-get install python-dev’.


File: python.info,  Node: How do I tell “incomplete input” from “invalid input”?,  Next: How do I find undefined g++ symbols __builtin_new or __pure_virtual?,  Prev: I want to compile a Python module on my Linux system but some files are missing Why?,  Up: Extending/Embedding FAQ

11.5.15 How do I tell “incomplete input” from “invalid input”?
--------------------------------------------------------------

Sometimes you want to emulate the Python interactive interpreter’s
behavior, where it gives you a continuation prompt when the input is
incomplete (e.g.  you typed the start of an “if” statement or you didn’t
close your parentheses or triple string quotes), but it gives you a
syntax error message immediately when the input is invalid.

In Python you can use the *note codeop: 1d. module, which approximates
the parser’s behavior sufficiently.  IDLE uses this, for example.

The easiest way to do it in C is to call *note PyRun_InteractiveLoop():
3b0e. (perhaps in a separate thread) and let the Python interpreter
handle the input for you.  You can also set the *note
PyOS_ReadlineFunctionPointer(): 960. to point at your custom input
function.  See ‘Modules/readline.c’ and ‘Parser/myreadline.c’ for more
hints.

However sometimes you have to run the embedded Python interpreter in the
same thread as your rest application and you can’t allow the *note
PyRun_InteractiveLoop(): 3b0e. to stop while waiting for user input.
The one solution then is to call ‘PyParser_ParseString()’ and test for
‘e.error’ equal to ‘E_EOF’, which means the input is incomplete.  Here’s
a sample code fragment, untested, inspired by code from Alex Farber:

     #define PY_SSIZE_T_CLEAN #include <Python.h> #include <node.h> #include <errcode.h> #include <grammar.h> #include <parsetok.h> #include <compile.h>  int testcomplete(char *code)   /* code should end in \n */   /* return -1 for error, 0 for incomplete, 1 for complete */ {   node *n;   perrdetail e;    n = PyParser_ParseString(code, &_PyParser_Grammar,                            Py_file_input, &e);   if (n == NULL) {     if (e.error == E_EOF)       return 0;     return -1;   }    PyNode_Free(n);   return 1; }

Another solution is trying to compile the received string with *note
Py_CompileString(): 3b1f.  If it compiles without errors, try to execute
the returned code object by calling *note PyEval_EvalCode(): 3b23.
Otherwise save the input for later.  If the compilation fails, find out
if it’s an error or just more input is required - by extracting the
message string from the exception tuple and comparing it to the string
“unexpected EOF while parsing”.  Here is a complete example using the
GNU readline library (you may want to ignore `SIGINT' while calling
readline()):

     #include <stdio.h> #include <readline.h>  #define PY_SSIZE_T_CLEAN #include <Python.h> #include <object.h> #include <compile.h> #include <eval.h>  int main (int argc, char* argv[]) {   int i, j, done = 0;                          /* lengths of line, code */   char ps1[] = ">>> ";   char ps2[] = "... ";   char *prompt = ps1;   char *msg, *line, *code = NULL;   PyObject *src, *glb, *loc;   PyObject *exc, *val, *trb, *obj, *dum;    Py_Initialize ();   loc = PyDict_New ();   glb = PyDict_New ();   PyDict_SetItemString (glb, "__builtins__", PyEval_GetBuiltins ());    while (!done)   {     line = readline (prompt);      if (NULL == line)                          /* Ctrl-D pressed */     {       done = 1;     }     else     {       i = strlen (line);        if (i > 0)         add_history (line);                    /* save non-empty lines */        if (NULL == code)                        /* nothing in code yet */         j = 0;       else         j = strlen (code);        code = realloc (code, i + j + 2);       if (NULL == code)                        /* out of memory */         exit (1);        if (0 == j)                              /* code was empty, so */         code[0] = '\0';                        /* keep strncat happy */        strncat (code, line, i);                 /* append line to code */       code[i + j] = '\n';                      /* append '\n' to code */       code[i + j + 1] = '\0';        src = Py_CompileString (code, "<stdin>", Py_single_input);        if (NULL != src)                         /* compiled just fine - */       {         if (ps1  == prompt ||                  /* ">>> " or */             '\n' == code[i + j - 1])           /* "... " and double '\n' */         {                                               /* so execute it */           dum = PyEval_EvalCode (src, glb, loc);           Py_XDECREF (dum);           Py_XDECREF (src);           free (code);           code = NULL;           if (PyErr_Occurred ())             PyErr_Print ();           prompt = ps1;         }       }                                        /* syntax error or E_EOF? */       else if (PyErr_ExceptionMatches (PyExc_SyntaxError))       {         PyErr_Fetch (&exc, &val, &trb);        /* clears exception! */          if (PyArg_ParseTuple (val, "sO", &msg, &obj) &&             !strcmp (msg, "unexpected EOF while parsing")) /* E_EOF */         {           Py_XDECREF (exc);           Py_XDECREF (val);           Py_XDECREF (trb);           prompt = ps2;         }         else                                   /* some other syntax error */         {           PyErr_Restore (exc, val, trb);           PyErr_Print ();           free (code);           code = NULL;           prompt = ps1;         }       }       else                                     /* some non-syntax error */       {         PyErr_Print ();         free (code);         code = NULL;         prompt = ps1;       }        free (line);     }   }    Py_XDECREF(glb);   Py_XDECREF(loc);   Py_Finalize();   exit(0); }


File: python.info,  Node: How do I find undefined g++ symbols __builtin_new or __pure_virtual?,  Next: Can I create an object class with some methods implemented in C and others in Python e g through inheritance ?,  Prev: How do I tell “incomplete input” from “invalid input”?,  Up: Extending/Embedding FAQ

11.5.16 How do I find undefined g++ symbols __builtin_new or __pure_virtual?
----------------------------------------------------------------------------

To dynamically load g++ extension modules, you must recompile Python,
relink it using g++ (change LINKCC in the Python Modules Makefile), and
link your extension module using g++ (e.g., ‘g++ -shared -o mymodule.so
mymodule.o’).


File: python.info,  Node: Can I create an object class with some methods implemented in C and others in Python e g through inheritance ?,  Prev: How do I find undefined g++ symbols __builtin_new or __pure_virtual?,  Up: Extending/Embedding FAQ

11.5.17 Can I create an object class with some methods implemented in C and others in Python (e.g. through inheritance)?
------------------------------------------------------------------------------------------------------------------------

Yes, you can inherit from built-in classes such as *note int: 184, *note
list: 260, *note dict: 1b6, etc.

The Boost Python Library (BPL,
‘http://www.boost.org/libs/python/doc/index.html’) provides a way of
doing this from C++ (i.e.  you can inherit from an extension class
written in C++ using the BPL).


File: python.info,  Node: Python on Windows FAQ,  Next: Graphic User Interface FAQ,  Prev: Extending/Embedding FAQ,  Up: Python Frequently Asked Questions

11.6 Python on Windows FAQ
==========================

* Menu:

* 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 *.pyd file the same as a DLL?: Is a * pyd file 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?::


File: python.info,  Node: How do I run a Python program under Windows?,  Next: How do I make Python scripts executable?,  Up: Python on Windows FAQ

11.6.1 How do I run a Python program under Windows?
---------------------------------------------------

This is not necessarily a straightforward question.  If you are already
familiar with running programs from the Windows command line then
everything will seem obvious; otherwise, you might need a little more
guidance.

Unless you use some sort of integrated development environment, you will
end up `typing' Windows commands into what is variously referred to as a
“DOS window” or “Command prompt window”.  Usually you can create such a
window from your search bar by searching for ‘cmd’.  You should be able
to recognize when you have started such a window because you will see a
Windows “command prompt”, which usually looks like this:

     C:\>

The letter may be different, and there might be other things after it,
so you might just as easily see something like:

     D:\YourName\Projects\Python>

depending on how your computer has been set up and what else you have
recently done with it.  Once you have started such a window, you are
well on the way to running Python programs.

You need to realize that your Python scripts have to be processed by
another program called the Python `interpreter'.  The interpreter reads
your script, compiles it into bytecodes, and then executes the bytecodes
to run your program.  So, how do you arrange for the interpreter to
handle your Python?

First, you need to make sure that your command window recognises the
word “py” as an instruction to start the interpreter.  If you have
opened a command window, you should try entering the command ‘py’ and
hitting return:

     C:\Users\YourName> py

You should then see something like:

     Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:04:45) [MSC v.1900 32 bit (Intel)] on win32 Type "help", "copyright", "credits" or "license" for more information. >>>

You have started the interpreter in “interactive mode”.  That means you
can enter Python statements or expressions interactively and have them
executed or evaluated while you wait.  This is one of Python’s strongest
features.  Check it by entering a few expressions of your choice and
seeing the results:

     >>> print("Hello") Hello >>> "Hello" * 3 'HelloHelloHello'

Many people use the interactive mode as a convenient yet highly
programmable calculator.  When you want to end your interactive Python
session, call the *note exit(): 154a. function or hold the ‘Ctrl’ key
down while you enter a ‘Z’, then hit the “‘Enter’” key to get back to
your Windows command prompt.

You may also find that you have a Start-menu entry such as Start ‣
Programs ‣ Python 3.x ‣ Python (command line) that results in you seeing
the ‘>>>’ prompt in a new window.  If so, the window will disappear
after you call the *note exit(): 154a. function or enter the ‘Ctrl-Z’
character; Windows is running a single “python” command in the window,
and closes it when you terminate the interpreter.

Now that we know the ‘py’ command is recognized, you can give your
Python script to it.  You’ll have to give either an absolute or a
relative path to the Python script.  Let’s say your Python script is
located in your desktop and is named ‘hello.py’, and your command prompt
is nicely opened in your home directory so you’re seeing something
similar to:

     C:\Users\YourName>

So now you’ll ask the ‘py’ command to give your script to Python by
typing ‘py’ followed by your script path:

     C:\Users\YourName> py Desktop\hello.py hello


File: python.info,  Node: How do I make Python scripts executable?,  Next: Why does Python sometimes take so long to start?,  Prev: How do I run a Python program under Windows?,  Up: Python on Windows FAQ

11.6.2 How do I make Python scripts executable?
-----------------------------------------------

On Windows, the standard Python installer already associates the .py
extension with a file type (Python.File) and gives that file type an
open command that runs the interpreter (‘D:\Program
Files\Python\python.exe "%1" %*’).  This is enough to make scripts
executable from the command prompt as ‘foo.py’.  If you’d rather be able
to execute the script by simple typing ‘foo’ with no extension you need
to add .py to the PATHEXT environment variable.


File: python.info,  Node: Why does Python sometimes take so long to start?,  Next: How do I make an executable from a Python script?,  Prev: How do I make Python scripts executable?,  Up: Python on Windows FAQ

11.6.3 Why does Python sometimes take so long to start?
-------------------------------------------------------

Usually Python starts very quickly on Windows, but occasionally there
are bug reports that Python suddenly begins to take a long time to start
up.  This is made even more puzzling because Python will work fine on
other Windows systems which appear to be configured identically.

The problem may be caused by a misconfiguration of virus checking
software on the problem machine.  Some virus scanners have been known to
introduce startup overhead of two orders of magnitude when the scanner
is configured to monitor all reads from the filesystem.  Try checking
the configuration of virus scanning software on your systems to ensure
that they are indeed configured identically.  McAfee, when configured to
scan all file system read activity, is a particular offender.


File: python.info,  Node: How do I make an executable from a Python script?,  Next: Is a * pyd file the same as a DLL?,  Prev: Why does Python sometimes take so long to start?,  Up: Python on Windows FAQ

11.6.4 How do I make an executable from a Python script?
--------------------------------------------------------

See cx_Freeze(1) for a distutils extension that allows you to create
console and GUI executables from Python code.  py2exe(2), the most
popular extension for building Python 2.x-based executables, does not
yet support Python 3 but a version that does is in development.

   ---------- Footnotes ----------

   (1) https://anthony-tuininga.github.io/cx_Freeze/

   (2) http://www.py2exe.org/


File: python.info,  Node: Is a * pyd file the same as a DLL?,  Next: How can I embed Python into a Windows application?,  Prev: How do I make an executable from a Python script?,  Up: Python on Windows FAQ

11.6.5 Is a ‘*.pyd’ file the same as a DLL?
-------------------------------------------

Yes, .pyd files are dll’s, but there are a few differences.  If you have
a DLL named ‘foo.pyd’, then it must have a function ‘PyInit_foo()’.  You
can then write Python “import foo”, and Python will search for foo.pyd
(as well as foo.py, foo.pyc) and if it finds it, will attempt to call
‘PyInit_foo()’ to initialize it.  You do not link your .exe with
foo.lib, as that would cause Windows to require the DLL to be present.

Note that the search path for foo.pyd is PYTHONPATH, not the same as the
path that Windows uses to search for foo.dll.  Also, foo.pyd need not be
present to run your program, whereas if you linked your program with a
dll, the dll is required.  Of course, foo.pyd is required if you want to
say ‘import foo’.  In a DLL, linkage is declared in the source code with
‘__declspec(dllexport)’.  In a .pyd, linkage is defined in a list of
available functions.


File: python.info,  Node: How can I embed Python into a Windows application?,  Next: How do I keep editors from inserting tabs into my Python source?,  Prev: Is a * pyd file the same as a DLL?,  Up: Python on Windows FAQ

11.6.6 How can I embed Python into a Windows application?
---------------------------------------------------------

Embedding the Python interpreter in a Windows app can be summarized as
follows:

  1. Do _not_ build Python into your .exe file directly.  On Windows,
     Python must be a DLL to handle importing modules that are
     themselves DLL’s.  (This is the first key undocumented fact.)
     Instead, link to ‘python`NN'.dll’; it is typically installed in
     ‘C:\Windows\System’.  `NN' is the Python version, a number such as
     “33” for Python 3.3.

     You can link to Python in two different ways.  Load-time linking
     means linking against ‘python`NN'.lib’, while run-time linking
     means linking against ‘python`NN'.dll’.  (General note:
     ‘python`NN'.lib’ is the so-called “import lib” corresponding to
     ‘python`NN'.dll’.  It merely defines symbols for the linker.)

     Run-time linking greatly simplifies link options; everything
     happens at run time.  Your code must load ‘python`NN'.dll’ using
     the Windows ‘LoadLibraryEx()’ routine.  The code must also use
     access routines and data in ‘python`NN'.dll’ (that is, Python’s C
     API’s) using pointers obtained by the Windows ‘GetProcAddress()’
     routine.  Macros can make using these pointers transparent to any C
     code that calls routines in Python’s C API.

     Borland note: convert ‘python`NN'.lib’ to OMF format using
     Coff2Omf.exe first.

  2. If you use SWIG, it is easy to create a Python “extension module”
     that will make the app’s data and methods available to Python.
     SWIG will handle just about all the grungy details for you.  The
     result is C code that you link `into' your .exe file (!)  You do
     _not_ have to create a DLL file, and this also simplifies linking.

  3. SWIG will create an init function (a C function) whose name depends
     on the name of the extension module.  For example, if the name of
     the module is leo, the init function will be called initleo().  If
     you use SWIG shadow classes, as you should, the init function will
     be called initleoc().  This initializes a mostly hidden helper
     class used by the shadow class.

     The reason you can link the C code in step 2 into your .exe file is
     that calling the initialization function is equivalent to importing
     the module into Python!  (This is the second key undocumented
     fact.)

  4. In short, you can use the following code to initialize the Python
     interpreter with your extension module.

          #include "python.h" ... Py_Initialize();  // Initialize Python. initmyAppc();  // Initialize (import) the helper class. PyRun_SimpleString("import myApp");  // Import the shadow class.

  5. There are two problems with Python’s C API which will become
     apparent if you use a compiler other than MSVC, the compiler used
     to build pythonNN.dll.

     Problem 1: The so-called “Very High Level” functions that take FILE
     * arguments will not work in a multi-compiler environment because
     each compiler’s notion of a struct FILE will be different.  From an
     implementation standpoint these are very _low_ level functions.

     Problem 2: SWIG generates the following code when generating
     wrappers to void functions:

          Py_INCREF(Py_None); _resultobj = Py_None; return _resultobj;

     Alas, Py_None is a macro that expands to a reference to a complex
     data structure called _Py_NoneStruct inside pythonNN.dll.  Again,
     this code will fail in a mult-compiler environment.  Replace such
     code by:

          return Py_BuildValue("");

     It may be possible to use SWIG’s ‘%typemap’ command to make the
     change automatically, though I have not been able to get this to
     work (I’m a complete SWIG newbie).

  6. Using a Python shell script to put up a Python interpreter window
     from inside your Windows app is not a good idea; the resulting
     window will be independent of your app’s windowing system.  Rather,
     you (or the wxPythonWindow class) should create a “native”
     interpreter window.  It is easy to connect that window to the
     Python interpreter.  You can redirect Python’s i/o to _any_ object
     that supports read and write, so all you need is a Python object
     (defined in your extension module) that contains read() and write()
     methods.


File: python.info,  Node: How do I keep editors from inserting tabs into my Python source?,  Next: How do I check for a keypress without blocking?,  Prev: How can I embed Python into a Windows application?,  Up: Python on Windows FAQ

11.6.7 How do I keep editors from inserting tabs into my Python source?
-----------------------------------------------------------------------

The FAQ does not recommend using tabs, and the Python style guide, PEP
8(1), recommends 4 spaces for distributed Python code; this is also the
Emacs python-mode default.

Under any editor, mixing tabs and spaces is a bad idea.  MSVC is no
different in this respect, and is easily configured to use spaces: Take
Tools ‣ Options ‣ Tabs, and for file type “Default” set “Tab size” and
“Indent size” to 4, and select the “Insert spaces” radio button.

Python raises *note IndentationError: e6c. or *note TabError: e6b. if
mixed tabs and spaces are causing problems in leading whitespace.  You
may also run the *note tabnanny: 100. module to check a directory tree
in batch mode.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0008


File: python.info,  Node: How do I check for a keypress without blocking?,  Prev: How do I keep editors from inserting tabs into my Python source?,  Up: Python on Windows FAQ

11.6.8 How do I check for a keypress without blocking?
------------------------------------------------------

Use the msvcrt module.  This is a standard Windows-specific extension
module.  It defines a function ‘kbhit()’ which checks whether a keyboard
hit is present, and ‘getch()’ which gets one character without echoing
it.


File: python.info,  Node: Graphic User Interface FAQ,  Next: “Why is Python Installed on my Computer?” FAQ,  Prev: Python on Windows FAQ,  Up: Python Frequently Asked Questions

11.7 Graphic User Interface FAQ
===============================

* Menu:

* General GUI Questions::
* What platform-independent GUI toolkits exist for Python?::
* What platform-specific GUI toolkits exist for Python?::
* Tkinter questions::


File: python.info,  Node: General GUI Questions,  Next: What platform-independent GUI toolkits exist for Python?,  Up: Graphic User Interface FAQ

11.7.1 General GUI Questions
----------------------------


File: python.info,  Node: What platform-independent GUI toolkits exist for Python?,  Next: What platform-specific GUI toolkits exist for Python?,  Prev: General GUI Questions,  Up: Graphic User Interface FAQ

11.7.2 What platform-independent GUI toolkits exist for Python?
---------------------------------------------------------------

Depending on what platform(s) you are aiming at, there are several.
Some of them haven’t been ported to Python 3 yet.  At least *note
Tkinter: 4245. and *note Qt: 4246. are known to be Python 3-compatible.

* Menu:

* Tkinter::
* wxWidgets::
* Qt::
* Gtk+::
* Kivy::
* FLTK::
* OpenGL::


File: python.info,  Node: Tkinter,  Next: wxWidgets,  Up: What platform-independent GUI toolkits exist for Python?

11.7.2.1 Tkinter
................

Standard builds of Python include an object-oriented interface to the
Tcl/Tk widget set, called *note tkinter: 30a9.  This is probably the
easiest to install (since it comes included with most binary
distributions(1) of Python) and use.  For more info about Tk, including
pointers to the source, see the Tcl/Tk home page(2).  Tcl/Tk is fully
portable to the Mac OS X, Windows, and Unix platforms.

   ---------- Footnotes ----------

   (1) https://www.python.org/downloads/

   (2) https://www.tcl.tk


File: python.info,  Node: wxWidgets,  Next: Qt,  Prev: Tkinter,  Up: What platform-independent GUI toolkits exist for Python?

11.7.2.2 wxWidgets
..................

wxWidgets (‘https://www.wxwidgets.org’) is a free, portable GUI class
library written in C++ that provides a native look and feel on a number
of platforms, with Windows, Mac OS X, GTK, X11, all listed as current
stable targets.  Language bindings are available for a number of
languages including Python, Perl, Ruby, etc.

wxPython(1) is the Python binding for wxwidgets.  While it often lags
slightly behind the official wxWidgets releases, it also offers a number
of features via pure Python extensions that are not available in other
language bindings.  There is an active wxPython user and developer
community.

Both wxWidgets and wxPython are free, open source, software with
permissive licences that allow their use in commercial products as well
as in freeware or shareware.

   ---------- Footnotes ----------

   (1) https://www.wxpython.org


File: python.info,  Node: Qt,  Next: Gtk+,  Prev: wxWidgets,  Up: What platform-independent GUI toolkits exist for Python?

11.7.2.3 Qt
...........

There are bindings available for the Qt toolkit (using either PyQt(1) or
PySide(2)) and for KDE (PyKDE4(3)).  PyQt is currently more mature than
PySide, but you must buy a PyQt license from Riverbank Computing(4) if
you want to write proprietary applications.  PySide is free for all
applications.

Qt 4.5 upwards is licensed under the LGPL license; also, commercial
licenses are available from The Qt Company(5).

   ---------- Footnotes ----------

   (1) https://riverbankcomputing.com/software/pyqt/intro

   (2) https://wiki.qt.io/PySide

   (3) https://techbase.kde.org/Languages/Python/Using_PyKDE_4

   (4) https://www.riverbankcomputing.com/commercial/license-faq

   (5) https://www.qt.io/licensing/


File: python.info,  Node: Gtk+,  Next: Kivy,  Prev: Qt,  Up: What platform-independent GUI toolkits exist for Python?

11.7.2.4 Gtk+
.............

The GObject introspection bindings(1) for Python allow you to write GTK+
3 applications.  There is also a Python GTK+ 3 Tutorial(2).

The older PyGtk bindings for the Gtk+ 2 toolkit(3) have been implemented
by James Henstridge; see <‘http://www.pygtk.org’>.

   ---------- Footnotes ----------

   (1) https://wiki.gnome.org/Projects/PyGObject

   (2) https://python-gtk-3-tutorial.readthedocs.io

   (3) https://www.gtk.org


File: python.info,  Node: Kivy,  Next: FLTK,  Prev: Gtk+,  Up: What platform-independent GUI toolkits exist for Python?

11.7.2.5 Kivy
.............

Kivy(1) is a cross-platform GUI library supporting both desktop
operating systems (Windows, macOS, Linux) and mobile devices (Android,
iOS). It is written in Python and Cython, and can use a range of
windowing backends.

Kivy is free and open source software distributed under the MIT license.

   ---------- Footnotes ----------

   (1) https://kivy.org/


File: python.info,  Node: FLTK,  Next: OpenGL,  Prev: Kivy,  Up: What platform-independent GUI toolkits exist for Python?

11.7.2.6 FLTK
.............

Python bindings for the FLTK toolkit(1), a simple yet powerful and
mature cross-platform windowing system, are available from the PyFLTK
project(2).

   ---------- Footnotes ----------

   (1) http://www.fltk.org

   (2) http://pyfltk.sourceforge.net


File: python.info,  Node: OpenGL,  Prev: FLTK,  Up: What platform-independent GUI toolkits exist for Python?

11.7.2.7 OpenGL
...............

For OpenGL bindings, see PyOpenGL(1).

   ---------- Footnotes ----------

   (1) http://pyopengl.sourceforge.net


File: python.info,  Node: What platform-specific GUI toolkits exist for Python?,  Next: Tkinter questions,  Prev: What platform-independent GUI toolkits exist for Python?,  Up: Graphic User Interface FAQ

11.7.3 What platform-specific GUI toolkits exist for Python?
------------------------------------------------------------

By installing the PyObjc Objective-C bridge(1), Python programs can use
Mac OS X’s Cocoa libraries.

*note Pythonwin: 4237. by Mark Hammond includes an interface to the
Microsoft Foundation Classes and a Python programming environment that’s
written mostly in Python using the MFC classes.

   ---------- Footnotes ----------

   (1) https://pypi.org/project/pyobjc/


File: python.info,  Node: Tkinter questions,  Prev: What platform-specific GUI toolkits exist for Python?,  Up: Graphic User Interface FAQ

11.7.4 Tkinter questions
------------------------

* Menu:

* How do I freeze Tkinter applications?::
* Can I have Tk events handled while waiting for I/O?::
* I can’t get key bindings to work in Tkinter; why?: I can’t get key bindings to work in Tkinter why?.


File: python.info,  Node: How do I freeze Tkinter applications?,  Next: Can I have Tk events handled while waiting for I/O?,  Up: Tkinter questions

11.7.4.1 How do I freeze Tkinter applications?
..............................................

Freeze is a tool to create stand-alone applications.  When freezing
Tkinter applications, the applications will not be truly stand-alone, as
the application will still need the Tcl and Tk libraries.

One solution is to ship the application with the Tcl and Tk libraries,
and point to them at run-time using the ‘TCL_LIBRARY’ and ‘TK_LIBRARY’
environment variables.

To get truly stand-alone applications, the Tcl scripts that form the
library have to be integrated into the application as well.  One tool
supporting that is SAM (stand-alone modules), which is part of the Tix
distribution (‘http://tix.sourceforge.net/’).

Build Tix with SAM enabled, perform the appropriate call to
‘Tclsam_init()’, etc.  inside Python’s ‘Modules/tkappinit.c’, and link
with libtclsam and libtksam (you might include the Tix libraries as
well).


File: python.info,  Node: Can I have Tk events handled while waiting for I/O?,  Next: I can’t get key bindings to work in Tkinter why?,  Prev: How do I freeze Tkinter applications?,  Up: Tkinter questions

11.7.4.2 Can I have Tk events handled while waiting for I/O?
............................................................

On platforms other than Windows, yes, and you don’t even need threads!
But you’ll have to restructure your I/O code a bit.  Tk has the
equivalent of Xt’s ‘XtAddInput()’ call, which allows you to register a
callback function which will be called from the Tk mainloop when I/O is
possible on a file descriptor.  See *note File Handlers: 30c3.


File: python.info,  Node: I can’t get key bindings to work in Tkinter why?,  Prev: Can I have Tk events handled while waiting for I/O?,  Up: Tkinter questions

11.7.4.3 I can’t get key bindings to work in Tkinter: why?
..........................................................

An often-heard complaint is that event handlers bound to events with the
‘bind()’ method don’t get handled even when the appropriate key is
pressed.

The most common cause is that the widget to which the binding applies
doesn’t have “keyboard focus”.  Check out the Tk documentation for the
focus command.  Usually a widget is given the keyboard focus by clicking
in it (but not for labels; see the takefocus option).


File: python.info,  Node: “Why is Python Installed on my Computer?” FAQ,  Prev: Graphic User Interface FAQ,  Up: Python Frequently Asked Questions

11.8 “Why is Python Installed on my Computer?” FAQ
==================================================

* Menu:

* What is Python?: What is Python?<2>.
* Why is Python installed on my machine?::
* Can I delete Python?::


File: python.info,  Node: What is Python?<2>,  Next: Why is Python installed on my machine?,  Up: “Why is Python Installed on my Computer?” FAQ

11.8.1 What is Python?
----------------------

Python is a programming language.  It’s used for many different
applications.  It’s used in some high schools and colleges as an
introductory programming language because Python is easy to learn, but
it’s also used by professional software developers at places such as
Google, NASA, and Lucasfilm Ltd.

If you wish to learn more about Python, start with the Beginner’s Guide
to Python(1).

   ---------- Footnotes ----------

   (1) https://wiki.python.org/moin/BeginnersGuide


File: python.info,  Node: Why is Python installed on my machine?,  Next: Can I delete Python?,  Prev: What is Python?<2>,  Up: “Why is Python Installed on my Computer?” FAQ

11.8.2 Why is Python installed on my machine?
---------------------------------------------

If you find Python installed on your system but don’t remember
installing it, there are several possible ways it could have gotten
there.

   * Perhaps another user on the computer wanted to learn programming
     and installed it; you’ll have to figure out who’s been using the
     machine and might have installed it.

   * A third-party application installed on the machine might have been
     written in Python and included a Python installation.  There are
     many such applications, from GUI programs to network servers and
     administrative scripts.

   * Some Windows machines also have Python installed.  At this writing
     we’re aware of computers from Hewlett-Packard and Compaq that
     include Python.  Apparently some of HP/Compaq’s administrative
     tools are written in Python.

   * Many Unix-compatible operating systems, such as Mac OS X and some
     Linux distributions, have Python installed by default; it’s
     included in the base installation.


File: python.info,  Node: Can I delete Python?,  Prev: Why is Python installed on my machine?,  Up: “Why is Python Installed on my Computer?” FAQ

11.8.3 Can I delete Python?
---------------------------

That depends on where Python came from.

If someone installed it deliberately, you can remove it without hurting
anything.  On Windows, use the Add/Remove Programs icon in the Control
Panel.

If Python was installed by a third-party application, you can also
remove it, but that application will no longer work.  You should use
that application’s uninstaller rather than removing Python directly.

If Python came with your operating system, removing it is not
recommended.  If you remove it, whatever tools were written in Python
will no longer run, and some of them might be important to you.
Reinstalling the whole system would then be required to fix things
again.


File: python.info,  Node: Glossary,  Next: About these documents,  Prev: Python Frequently Asked Questions,  Up: Top

12 Glossary
***********

‘>>>’

     The default Python prompt of the interactive shell.  Often seen for
     code examples which can be executed interactively in the
     interpreter.

‘...’

     Can refer to:

        * The default Python prompt of the interactive shell when
          entering the code for an indented code block, when within a
          pair of matching left and right delimiters (parentheses,
          square brackets, curly braces or triple quotes), or after
          specifying a decorator.

        * The *note Ellipsis: 1547. built-in constant.

2to3

     A tool that tries to convert Python 2.x code to Python 3.x code by
     handling most of the incompatibilities which can be detected by
     parsing the source and traversing the parse tree.

     2to3 is available in the standard library as *note lib2to3: a7.; a
     standalone entry point is provided as ‘Tools/scripts/2to3’.  See
     *note 2to3 - Automated Python 2 to 3 code translation: c69.

abstract base class

     Abstract base classes complement *note duck-typing: 4258. by
     providing a way to define interfaces when other techniques like
     *note hasattr(): 43c. would be clumsy or subtly wrong (for example
     with *note magic methods: 1378.).  ABCs introduce virtual
     subclasses, which are classes that don’t inherit from a class but
     are still recognized by *note isinstance(): 444. and *note
     issubclass(): 445.; see the *note abc: 4. module documentation.
     Python comes with many built-in ABCs for data structures (in the
     *note collections.abc: 1f. module), numbers (in the *note numbers:
     c1. module), streams (in the *note io: a1. module), import finders
     and loaders (in the *note importlib.abc: 9c. module).  You can
     create your own ABCs with the *note abc: 4. module.

annotation

     A label associated with a variable, a class attribute or a function
     parameter or return value, used by convention as a *note type hint:
     425a.

     Annotations of local variables cannot be accessed at runtime, but
     annotations of global variables, class attributes, and functions
     are stored in the ‘__annotations__’ special attribute of modules,
     classes, and functions, respectively.

     See *note variable annotation: 614, *note function annotation:
     1197, PEP 484(1) and PEP 526(2), which describe this functionality.

argument

     A value passed to a *note function: 1461. (or *note method: 425b.)
     when calling the function.  There are two kinds of argument:

        * `keyword argument': an argument preceded by an identifier
          (e.g.  ‘name=’) in a function call or passed as a value in a
          dictionary preceded by ‘**’.  For example, ‘3’ and ‘5’ are
          both keyword arguments in the following calls to *note
          complex(): 189.:

               complex(real=3, imag=5) complex(**{'real': 3, 'imag': 5})

        * `positional argument': an argument that is not a keyword
          argument.  Positional arguments can appear at the beginning of
          an argument list and/or be passed as elements of an *note
          iterable: b9f. preceded by ‘*’.  For example, ‘3’ and ‘5’ are
          both positional arguments in the following calls:

               complex(3, 5) complex(*(3, 5))

     Arguments are assigned to the named local variables in a function
     body.  See the *note Calls: 640. section for the rules governing
     this assignment.  Syntactically, any expression can be used to
     represent an argument; the evaluated value is assigned to the local
     variable.

     See also the *note parameter: 1469. glossary entry, the FAQ
     question on *note the difference between arguments and parameters:
     41a5, and PEP 362(3).

asynchronous context manager

     An object which controls the environment seen in an *note async
     with: 637. statement by defining *note __aenter__(): 13d4. and
     *note __aexit__(): 13d5. methods.  Introduced by PEP 492(4).

asynchronous generator

     A function which returns an *note asynchronous generator iterator:
     356f.  It looks like a coroutine function defined with *note async
     def: 282. except that it contains *note yield: 18f. expressions for
     producing a series of values usable in an *note async for: 2e1.
     loop.

     Usually refers to an asynchronous generator function, but may refer
     to an `asynchronous generator iterator' in some contexts.  In cases
     where the intended meaning isn’t clear, using the full terms avoids
     ambiguity.

     An asynchronous generator function may contain *note await: 1a2.
     expressions as well as *note async for: 2e1, and *note async with:
     637. statements.

asynchronous generator iterator

     An object created by a *note asynchronous generator: 1441.
     function.

     This is an *note asynchronous iterator: 639. which when called
     using the *note __anext__(): 13d1. method returns an awaitable
     object which will execute the body of the asynchronous generator
     function until the next *note yield: 18f. expression.

     Each *note yield: 18f. temporarily suspends processing, remembering
     the location execution state (including local variables and pending
     try-statements).  When the `asynchronous generator iterator'
     effectively resumes with another awaitable returned by *note
     __anext__(): 13d1, it picks up where it left off.  See PEP 492(5)
     and PEP 525(6).

asynchronous iterable

     An object, that can be used in an *note async for: 2e1. statement.
     Must return an *note asynchronous iterator: 639. from its *note
     __aiter__(): 47c. method.  Introduced by PEP 492(7).

asynchronous iterator

     An object that implements the *note __aiter__(): 47c. and *note
     __anext__(): 13d1. methods.  ‘__anext__’ must return an *note
     awaitable: 50e. object.  *note async for: 2e1. resolves the
     awaitables returned by an asynchronous iterator’s *note
     __anext__(): 13d1. method until it raises a *note
     StopAsyncIteration: f49. exception.  Introduced by PEP 492(8).

attribute

     A value associated with an object which is referenced by name using
     dotted expressions.  For example, if an object `o' has an attribute
     `a' it would be referenced as `o.a'.

awaitable

     An object that can be used in an *note await: 1a2. expression.  Can
     be a *note coroutine: 1a5. or an object with an *note __await__():
     636. method.  See also PEP 492(9).

BDFL

     Benevolent Dictator For Life, a.k.a.  Guido van Rossum(10),
     Python’s creator.

binary file

     A *note file object: b35. able to read and write *note bytes-like
     objects: 5dd.  Examples of binary files are files opened in binary
     mode (‘'rb'’, ‘'wb'’ or ‘'rb+'’), ‘sys.stdin.buffer’,
     ‘sys.stdout.buffer’, and instances of *note io.BytesIO: 78f. and
     *note gzip.GzipFile: 6d1.

     See also *note text file: 11de. for a file object able to read and
     write *note str: 325. objects.

bytes-like object

     An object that supports the *note Buffer Protocol: 1579. and can
     export a C-*note contiguous: 15f1. buffer.  This includes all *note
     bytes: 326, *note bytearray: 327, and *note array.array: 446.
     objects, as well as many common *note memoryview: 25a. objects.
     Bytes-like objects can be used for various operations that work
     with binary data; these include compression, saving to a binary
     file, and sending over a socket.

     Some operations need the binary data to be mutable.  The
     documentation often refers to these as “read-write bytes-like
     objects”.  Example mutable buffer objects include *note bytearray:
     327. and a *note memoryview: 25a. of a *note bytearray: 327.  Other
     operations require the binary data to be stored in immutable
     objects (“read-only bytes-like objects”); examples of these include
     *note bytes: 326. and a *note memoryview: 25a. of a *note bytes:
     326. object.

bytecode

     Python source code is compiled into bytecode, the internal
     representation of a Python program in the CPython interpreter.  The
     bytecode is also cached in ‘.pyc’ files so that executing the same
     file is faster the second time (recompilation from source to
     bytecode can be avoided).  This “intermediate language” is said to
     run on a *note virtual machine: 26c7. that executes the machine
     code corresponding to each bytecode.  Do note that bytecodes are
     not expected to work between different Python virtual machines, nor
     to be stable between Python releases.

     A list of bytecode instructions can be found in the documentation
     for *note the dis module: 37df.

class

     A template for creating user-defined objects.  Class definitions
     normally contain method definitions which operate on instances of
     the class.

class variable

     A variable defined in a class and intended to be modified only at
     class level (i.e., not in an instance of the class).

coercion

     The implicit conversion of an instance of one type to another
     during an operation which involves two arguments of the same type.
     For example, ‘int(3.15)’ converts the floating point number to the
     integer ‘3’, but in ‘3+4.5’, each argument is of a different type
     (one int, one float), and both must be converted to the same type
     before they can be added or it will raise a *note TypeError: 192.
     Without coercion, all arguments of even compatible types would have
     to be normalized to the same value by the programmer, e.g.,
     ‘float(3)+4.5’ rather than just ‘3+4.5’.

complex number

     An extension of the familiar real number system in which all
     numbers are expressed as a sum of a real part and an imaginary
     part.  Imaginary numbers are real multiples of the imaginary unit
     (the square root of ‘-1’), often written ‘i’ in mathematics or ‘j’
     in engineering.  Python has built-in support for complex numbers,
     which are written with this latter notation; the imaginary part is
     written with a ‘j’ suffix, e.g., ‘3+1j’.  To get access to complex
     equivalents of the *note math: b1. module, use *note cmath: 19.
     Use of complex numbers is a fairly advanced mathematical feature.
     If you’re not aware of a need for them, it’s almost certain you can
     safely ignore them.

context manager

     An object which controls the environment seen in a *note with: 6dd.
     statement by defining *note __enter__(): c88. and *note __exit__():
     c89. methods.  See PEP 343(11).

context variable

     A variable which can have different values depending on its
     context.  This is similar to Thread-Local Storage in which each
     execution thread may have a different value for a variable.
     However, with context variables, there may be several contexts in
     one execution thread and the main usage for context variables is to
     keep track of variables in concurrent asynchronous tasks.  See
     *note contextvars: 25.

contiguous

     A buffer is considered contiguous exactly if it is either
     `C-contiguous' or `Fortran contiguous'.  Zero-dimensional buffers
     are C and Fortran contiguous.  In one-dimensional arrays, the items
     must be laid out in memory next to each other, in order of
     increasing indexes starting from zero.  In multidimensional
     C-contiguous arrays, the last index varies the fastest when
     visiting items in order of memory address.  However, in Fortran
     contiguous arrays, the first index varies the fastest.

coroutine

     Coroutines are a more generalized form of subroutines.  Subroutines
     are entered at one point and exited at another point.  Coroutines
     can be entered, exited, and resumed at many different points.  They
     can be implemented with the *note async def: 282. statement.  See
     also PEP 492(12).

coroutine function

     A function which returns a *note coroutine: 1a5. object.  A
     coroutine function may be defined with the *note async def: 282.
     statement, and may contain *note await: 1a2, *note async for: 2e1,
     and *note async with: 637. keywords.  These were introduced by PEP
     492(13).

CPython

     The canonical implementation of the Python programming language, as
     distributed on python.org(14).  The term “CPython” is used when
     necessary to distinguish this implementation from others such as
     Jython or IronPython.

decorator

     A function returning another function, usually applied as a
     function transformation using the ‘@wrapper’ syntax.  Common
     examples for decorators are *note classmethod(): 1d6. and *note
     staticmethod(): 1d7.

     The decorator syntax is merely syntactic sugar, the following two
     function definitions are semantically equivalent:

          def f(...):     ... f = staticmethod(f)  @staticmethod def f(...):     ...

     The same concept exists for classes, but is less commonly used
     there.  See the documentation for *note function definitions: 1196.
     and *note class definitions: c5d. for more about decorators.

descriptor

     Any object which defines the methods *note __get__(): 1377, *note
     __set__(): 137b, or *note __delete__(): 137c.  When a class
     attribute is a descriptor, its special binding behavior is
     triggered upon attribute lookup.  Normally, using `a.b' to get, set
     or delete an attribute looks up the object named `b' in the class
     dictionary for `a', but if `b' is a descriptor, the respective
     descriptor method gets called.  Understanding descriptors is a key
     to a deep understanding of Python because they are the basis for
     many features including functions, methods, properties, class
     methods, static methods, and reference to super classes.

     For more information about descriptors’ methods, see *note
     Implementing Descriptors: 4de.

dictionary

     An associative array, where arbitrary keys are mapped to values.
     The keys can be any object with *note __hash__(): 335. and *note
     __eq__(): 334. methods.  Called a hash in Perl.

dictionary view

     The objects returned from *note dict.keys(): c1d, *note
     dict.values(): c1f, and *note dict.items(): c1e. are called
     dictionary views.  They provide a dynamic view on the dictionary’s
     entries, which means that when the dictionary changes, the view
     reflects these changes.  To force the dictionary view to become a
     full list use ‘list(dictview)’.  See *note Dictionary view objects:
     1612.

docstring

     A string literal which appears as the first expression in a class,
     function or module.  While ignored when the suite is executed, it
     is recognized by the compiler and put into the ‘__doc__’ attribute
     of the enclosing class, function or module.  Since it is available
     via introspection, it is the canonical place for documentation of
     the object.

duck-typing

     A programming style which does not look at an object’s type to
     determine if it has the right interface; instead, the method or
     attribute is simply called or used (“If it looks like a duck and
     quacks like a duck, it must be a duck.”) By emphasizing interfaces
     rather than specific types, well-designed code improves its
     flexibility by allowing polymorphic substitution.  Duck-typing
     avoids tests using *note type(): 5fd. or *note isinstance(): 444.
     (Note, however, that duck-typing can be complemented with *note
     abstract base classes: b26.)  Instead, it typically employs *note
     hasattr(): 43c. tests or *note EAFP: 1e88. programming.

EAFP

     Easier to ask for forgiveness than permission.  This common Python
     coding style assumes the existence of valid keys or attributes and
     catches exceptions if the assumption proves false.  This clean and
     fast style is characterized by the presence of many *note try: d65.
     and *note except: b31. statements.  The technique contrasts with
     the *note LBYL: 4263. style common to many other languages such as
     C.

expression

     A piece of syntax which can be evaluated to some value.  In other
     words, an expression is an accumulation of expression elements like
     literals, names, attribute access, operators or function calls
     which all return a value.  In contrast to many other languages, not
     all language constructs are expressions.  There are also *note
     statement: 1aca.s which cannot be used as expressions, such as
     *note while: 1167.  Assignments are also statements, not
     expressions.

extension module

     A module written in C or C++, using Python’s C API to interact with
     the core and with user code.

f-string

     String literals prefixed with ‘'f'’ or ‘'F'’ are commonly called
     “f-strings” which is short for *note formatted string literals:
     15c.  See also PEP 498(15).

file object

     An object exposing a file-oriented API (with methods such as
     ‘read()’ or ‘write()’) to an underlying resource.  Depending on the
     way it was created, a file object can mediate access to a real
     on-disk file or to another type of storage or communication device
     (for example standard input/output, in-memory buffers, sockets,
     pipes, etc.).  File objects are also called `file-like objects' or
     `streams'.

     There are actually three categories of file objects: raw *note
     binary files: 1bdb, buffered *note binary files: 1bdb. and *note
     text files: 11de.  Their interfaces are defined in the *note io:
     a1. module.  The canonical way to create a file object is by using
     the *note open(): 4e5. function.

file-like object

     A synonym for *note file object: b35.

finder

     An object that tries to find the *note loader: 13f8. for a module
     that is being imported.

     Since Python 3.3, there are two types of finder: *note meta path
     finders: 9a5. for use with *note sys.meta_path: 5db, and *note path
     entry finders: 9a6. for use with *note sys.path_hooks: 950.

     See PEP 302(16), PEP 420(17) and PEP 451(18) for much more detail.

floor division

     Mathematical division that rounds down to nearest integer.  The
     floor division operator is ‘//’.  For example, the expression ‘11
     // 4’ evaluates to ‘2’ in contrast to the ‘2.75’ returned by float
     true division.  Note that ‘(-11) // 4’ is ‘-3’ because that is
     ‘-2.75’ rounded `downward'.  See PEP 238(19).

function

     A series of statements which returns some value to a caller.  It
     can also be passed zero or more *note arguments: 1462. which may be
     used in the execution of the body.  See also *note parameter: 1469,
     *note method: 425b, and the *note Function definitions: 1196.
     section.

function annotation

     An *note annotation: 4259. of a function parameter or return value.

     Function annotations are usually used for *note type hints: 425a.:
     for example, this function is expected to take two *note int: 184.
     arguments and is also expected to have an *note int: 184. return
     value:

          def sum_two_numbers(a: int, b: int) -> int:    return a + b

     Function annotation syntax is explained in section *note Function
     definitions: 1196.

     See *note variable annotation: 614. and PEP 484(20), which describe
     this functionality.

__future__

     A pseudo-module which programmers can use to enable new language
     features which are not compatible with the current interpreter.

     By importing the *note __future__: 0. module and evaluating its
     variables, you can see when a new feature was first added to the
     language and when it becomes the default:

          >>> import __future__ >>> __future__.division _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)

garbage collection

     The process of freeing memory when it is not used anymore.  Python
     performs garbage collection via reference counting and a cyclic
     garbage collector that is able to detect and break reference
     cycles.  The garbage collector can be controlled using the *note
     gc: 86. module.

generator

     A function which returns a *note generator iterator: 44c.  It looks
     like a normal function except that it contains *note yield: 18f.
     expressions for producing a series of values usable in a for-loop
     or that can be retrieved one at a time with the *note next(): 676.
     function.

     Usually refers to a generator function, but may refer to a
     `generator iterator' in some contexts.  In cases where the intended
     meaning isn’t clear, using the full terms avoids ambiguity.

generator iterator

     An object created by a *note generator: 996. function.

     Each *note yield: 18f. temporarily suspends processing, remembering
     the location execution state (including local variables and pending
     try-statements).  When the `generator iterator' resumes, it picks
     up where it left off (in contrast to functions which start fresh on
     every invocation).

generator expression

     An expression that returns an iterator.  It looks like a normal
     expression followed by a ‘for’ clause defining a loop variable,
     range, and an optional ‘if’ clause.  The combined expression
     generates values for an enclosing function:

          >>> sum(i*i for i in range(10))         # sum of squares 0, 1, 4, ... 81 285

generic function

     A function composed of multiple functions implementing the same
     operation for different types.  Which implementation should be used
     during a call is determined by the dispatch algorithm.

     See also the *note single dispatch: 1c9. glossary entry, the *note
     functools.singledispatch(): 37f. decorator, and PEP 443(21).

GIL

     See *note global interpreter lock: 4fb.

global interpreter lock

     The mechanism used by the *note CPython: 1372. interpreter to
     assure that only one thread executes Python *note bytecode: 609. at
     a time.  This simplifies the CPython implementation by making the
     object model (including critical built-in types such as *note dict:
     1b6.) implicitly safe against concurrent access.  Locking the
     entire interpreter makes it easier for the interpreter to be
     multi-threaded, at the expense of much of the parallelism afforded
     by multi-processor machines.

     However, some extension modules, either standard or third-party,
     are designed so as to release the GIL when doing
     computationally-intensive tasks such as compression or hashing.
     Also, the GIL is always released when doing I/O.

     Past efforts to create a “free-threaded” interpreter (one which
     locks shared data at a much finer granularity) have not been
     successful because performance suffered in the common
     single-processor case.  It is believed that overcoming this
     performance issue would make the implementation much more
     complicated and therefore costlier to maintain.

hash-based pyc

     A bytecode cache file that uses the hash rather than the
     last-modified time of the corresponding source file to determine
     its validity.  See *note Cached bytecode invalidation: 31e.

hashable

     An object is `hashable' if it has a hash value which never changes
     during its lifetime (it needs a *note __hash__(): 335. method), and
     can be compared to other objects (it needs an *note __eq__(): 334.
     method).  Hashable objects which compare equal must have the same
     hash value.

     Hashability makes an object usable as a dictionary key and a set
     member, because these data structures use the hash value
     internally.

     Most of Python’s immutable built-in objects are hashable; mutable
     containers (such as lists or dictionaries) are not; immutable
     containers (such as tuples and frozensets) are only hashable if
     their elements are hashable.  Objects which are instances of
     user-defined classes are hashable by default.  They all compare
     unequal (except with themselves), and their hash value is derived
     from their *note id(): d79.

IDLE

     An Integrated Development Environment for Python.  IDLE is a basic
     editor and interpreter environment which ships with the standard
     distribution of Python.

immutable

     An object with a fixed value.  Immutable objects include numbers,
     strings and tuples.  Such an object cannot be altered.  A new
     object has to be created if a different value has to be stored.
     They play an important role in places where a constant hash value
     is needed, for example as a key in a dictionary.

import path

     A list of locations (or *note path entries: 140d.) that are
     searched by the *note path based finder: 13fd. for modules to
     import.  During import, this list of locations usually comes from
     *note sys.path: 47d, but for subpackages it may also come from the
     parent package’s ‘__path__’ attribute.

importing

     The process by which Python code in one module is made available to
     Python code in another module.

importer

     An object that both finds and loads a module; both a *note finder:
     13f7. and *note loader: 13f8. object.

interactive

     Python has an interactive interpreter which means you can enter
     statements and expressions at the interpreter prompt, immediately
     execute them and see their results.  Just launch ‘python’ with no
     arguments (possibly by selecting it from your computer’s main
     menu).  It is a very powerful way to test out new ideas or inspect
     modules and packages (remember ‘help(x)’).

interpreted

     Python is an interpreted language, as opposed to a compiled one,
     though the distinction can be blurry because of the presence of the
     bytecode compiler.  This means that source files can be run
     directly without explicitly creating an executable which is then
     run.  Interpreted languages typically have a shorter
     development/debug cycle than compiled ones, though their programs
     generally also run more slowly.  See also *note interactive: 4268.

interpreter shutdown

     When asked to shut down, the Python interpreter enters a special
     phase where it gradually releases all allocated resources, such as
     modules and various critical internal structures.  It also makes
     several calls to the *note garbage collector: 1243.  This can
     trigger the execution of code in user-defined destructors or
     weakref callbacks.  Code executed during the shutdown phase can
     encounter various exceptions as the resources it relies on may not
     function anymore (common examples are library modules or the
     warnings machinery).

     The main reason for interpreter shutdown is that the ‘__main__’
     module or the script being run has finished executing.

iterable

     An object capable of returning its members one at a time.  Examples
     of iterables include all sequence types (such as *note list: 260,
     *note str: 325, and *note tuple: 473.) and some non-sequence types
     like *note dict: 1b6, *note file objects: b35, and objects of any
     classes you define with an *note __iter__(): 504. method or with a
     *note __getitem__(): 27a. method that implements *note Sequence:
     1162. semantics.

     Iterables can be used in a *note for: c23. loop and in many other
     places where a sequence is needed (*note zip(): c25, *note map():
     c20, …).  When an iterable object is passed as an argument to the
     built-in function *note iter(): d1a, it returns an iterator for the
     object.  This iterator is good for one pass over the set of values.
     When using iterables, it is usually not necessary to call *note
     iter(): d1a. or deal with iterator objects yourself.  The ‘for’
     statement does that automatically for you, creating a temporary
     unnamed variable to hold the iterator for the duration of the loop.
     See also *note iterator: f73, *note sequence: 1162, and *note
     generator: 996.

iterator

     An object representing a stream of data.  Repeated calls to the
     iterator’s *note __next__(): c57. method (or passing it to the
     built-in function *note next(): 676.) return successive items in
     the stream.  When no more data are available a *note StopIteration:
     47b. exception is raised instead.  At this point, the iterator
     object is exhausted and any further calls to its ‘__next__()’
     method just raise *note StopIteration: 47b. again.  Iterators are
     required to have an *note __iter__(): 504. method that returns the
     iterator object itself so every iterator is also iterable and may
     be used in most places where other iterables are accepted.  One
     notable exception is code which attempts multiple iteration passes.
     A container object (such as a *note list: 260.) produces a fresh
     new iterator each time you pass it to the *note iter(): d1a.
     function or use it in a *note for: c23. loop.  Attempting this with
     an iterator will just return the same exhausted iterator object
     used in the previous iteration pass, making it appear like an empty
     container.

     More information can be found in *note Iterator Types: 1398.

key function

     A key function or collation function is a callable that returns a
     value used for sorting or ordering.  For example, *note
     locale.strxfrm(): 2fbe. is used to produce a sort key that is aware
     of locale specific sort conventions.

     A number of tools in Python accept key functions to control how
     elements are ordered or grouped.  They include *note min(): 7fd,
     *note max(): 7fe, *note sorted(): 439, *note list.sort(): 43a,
     *note heapq.merge(): 6d3, *note heapq.nsmallest(): 189d, *note
     heapq.nlargest(): 189c, and *note itertools.groupby(): 1a76.

     There are several ways to create a key function.  For example.  the
     *note str.lower(): 157f. method can serve as a key function for
     case insensitive sorts.  Alternatively, a key function can be built
     from a *note lambda: c22. expression such as ‘lambda r: (r[0],
     r[2])’.  Also, the *note operator: c2. module provides three key
     function constructors: *note attrgetter(): 70f, *note itemgetter():
     25f, and *note methodcaller(): 710.  See the *note Sorting HOW TO:
     153c. for examples of how to create and use key functions.

keyword argument

     See *note argument: 1462.

lambda

     An anonymous inline function consisting of a single *note
     expression: 3563. which is evaluated when the function is called.
     The syntax to create a lambda function is ‘lambda [parameters]:
     expression’

LBYL

     Look before you leap.  This coding style explicitly tests for
     pre-conditions before making calls or lookups.  This style
     contrasts with the *note EAFP: 1e88. approach and is characterized
     by the presence of many *note if: dda. statements.

     In a multi-threaded environment, the LBYL approach can risk
     introducing a race condition between “the looking” and “the
     leaping”.  For example, the code, ‘if key in mapping: return
     mapping[key]’ can fail if another thread removes `key' from
     `mapping' after the test, but before the lookup.  This issue can be
     solved with locks or by using the EAFP approach.

list

     A built-in Python *note sequence: 1162.  Despite its name it is
     more akin to an array in other languages than to a linked list
     since access to elements is O(1).

list comprehension

     A compact way to process all or part of the elements in a sequence
     and return a list with the results.  ‘result = ['{:#04x}'.format(x)
     for x in range(256) if x % 2 == 0]’ generates a list of strings
     containing even hex numbers (0x..)  in the range from 0 to 255.
     The *note if: dda. clause is optional.  If omitted, all elements in
     ‘range(256)’ are processed.

loader

     An object that loads a module.  It must define a method named
     ‘load_module()’.  A loader is typically returned by a *note finder:
     13f7.  See PEP 302(22) for details and *note importlib.abc.Loader:
     7b6. for an *note abstract base class: b26.

magic method

     An informal synonym for *note special method: 359e.

mapping

     A container object that supports arbitrary key lookups and
     implements the methods specified in the *note Mapping: 187d. or
     *note MutableMapping: 9e3. *note abstract base classes: 1860.
     Examples include *note dict: 1b6, *note collections.defaultdict:
     b2d, *note collections.OrderedDict: 1b7. and *note
     collections.Counter: 9ce.

meta path finder

     A *note finder: 13f7. returned by a search of *note sys.meta_path:
     5db.  Meta path finders are related to, but different from *note
     path entry finders: 9a6.

     See *note importlib.abc.MetaPathFinder: 9a7. for the methods that
     meta path finders implement.

metaclass

     The class of a class.  Class definitions create a class name, a
     class dictionary, and a list of base classes.  The metaclass is
     responsible for taking those three arguments and creating the
     class.  Most object oriented programming languages provide a
     default implementation.  What makes Python special is that it is
     possible to create custom metaclasses.  Most users never need this
     tool, but when the need arises, metaclasses can provide powerful,
     elegant solutions.  They have been used for logging attribute
     access, adding thread-safety, tracking object creation,
     implementing singletons, and many other tasks.

     More information can be found in *note Metaclasses: 1384.

method

     A function which is defined inside a class body.  If called as an
     attribute of an instance of that class, the method will get the
     instance object as its first *note argument: 1462. (which is
     usually called ‘self’).  See *note function: 1461. and *note nested
     scope: 1526.

method resolution order

     Method Resolution Order is the order in which base classes are
     searched for a member during lookup.  See The Python 2.3 Method
     Resolution Order(23) for details of the algorithm used by the
     Python interpreter since the 2.3 release.

module

     An object that serves as an organizational unit of Python code.
     Modules have a namespace containing arbitrary Python objects.
     Modules are loaded into Python by the process of *note importing:
     13ea.

     See also *note package: 13ee.

module spec

     A namespace containing the import-related information used to load
     a module.  An instance of *note importlib.machinery.ModuleSpec:
     1403.

MRO

     See *note method resolution order: 153f.

mutable

     Mutable objects can change their value but keep their *note id():
     d79.  See also *note immutable: 115c.

named tuple

     The term “named tuple” applies to any type or class that inherits
     from tuple and whose indexable elements are also accessible using
     named attributes.  The type or class may have other features as
     well.

     Several built-in types are named tuples, including the values
     returned by *note time.localtime(): 17ea. and *note os.stat(): 1ef.
     Another example is *note sys.float_info: ef3.:

          >>> sys.float_info[1]                   # indexed access 1024 >>> sys.float_info.max_exp              # named field access 1024 >>> isinstance(sys.float_info, tuple)   # kind of tuple True

     Some named tuples are built-in types (such as the above examples).
     Alternatively, a named tuple can be created from a regular class
     definition that inherits from *note tuple: 473. and that defines
     named fields.  Such a class can be written by hand or it can be
     created with the factory function *note collections.namedtuple():
     1b5.  The latter technique also adds some extra methods that may
     not be found in hand-written or built-in named tuples.

namespace

     The place where a variable is stored.  Namespaces are implemented
     as dictionaries.  There are the local, global and built-in
     namespaces as well as nested namespaces in objects (in methods).
     Namespaces support modularity by preventing naming conflicts.  For
     instance, the functions *note builtins.open: 4e5. and *note
     os.open(): 659. are distinguished by their namespaces.  Namespaces
     also aid readability and maintainability by making it clear which
     module implements a function.  For instance, writing *note
     random.seed(): bfb. or *note itertools.islice(): 397. makes it
     clear that those functions are implemented by the *note random: dc.
     and *note itertools: a3. modules, respectively.

namespace package

     A PEP 420(24) *note package: 13ee. which serves only as a container
     for subpackages.  Namespace packages may have no physical
     representation, and specifically are not like a *note regular
     package: 13f0. because they have no ‘__init__.py’ file.

     See also *note module: 13e9.

nested scope

     The ability to refer to a variable in an enclosing definition.  For
     instance, a function defined inside another function can refer to
     variables in the outer function.  Note that nested scopes by
     default work only for reference and not for assignment.  Local
     variables both read and write in the innermost scope.  Likewise,
     global variables read and write to the global namespace.  The *note
     nonlocal: c32. allows writing to outer scopes.

new-style class

     Old name for the flavor of classes now used for all class objects.
     In earlier Python versions, only new-style classes could use
     Python’s newer, versatile features like *note __slots__: e20,
     descriptors, properties, *note __getattribute__(): 43e, class
     methods, and static methods.

object

     Any data with state (attributes or value) and defined behavior
     (methods).  Also the ultimate base class of any *note new-style
     class: 1be3.

package

     A Python *note module: 13e9. which can contain submodules or
     recursively, subpackages.  Technically, a package is a Python
     module with an ‘__path__’ attribute.

     See also *note regular package: 13f0. and *note namespace package:
     13f1.

parameter

     A named entity in a *note function: 1461. (or method) definition
     that specifies an *note argument: 1462. (or in some cases,
     arguments) that the function can accept.  There are five kinds of
     parameter:

        * `positional-or-keyword': specifies an argument that can be
          passed either *note positionally: 1462. or as a *note keyword
          argument: 1462.  This is the default kind of parameter, for
          example `foo' and `bar' in the following:

               def func(foo, bar=None): ...

        * `positional-only': specifies an argument that can be supplied
          only by position.  Python has no syntax for defining
          positional-only parameters.  However, some built-in functions
          have positional-only parameters (e.g.  *note abs(): 11f8.).

        * `keyword-only': specifies an argument that can be supplied
          only by keyword.  Keyword-only parameters can be defined by
          including a single var-positional parameter or bare ‘*’ in the
          parameter list of the function definition before them, for
          example `kw_only1' and `kw_only2' in the following:

               def func(arg, *, kw_only1, kw_only2): ...

        * `var-positional': specifies that an arbitrary sequence of
          positional arguments can be provided (in addition to any
          positional arguments already accepted by other parameters).
          Such a parameter can be defined by prepending the parameter
          name with ‘*’, for example `args' in the following:

               def func(*args, **kwargs): ...

        * `var-keyword': specifies that arbitrarily many keyword
          arguments can be provided (in addition to any keyword
          arguments already accepted by other parameters).  Such a
          parameter can be defined by prepending the parameter name with
          ‘**’, for example `kwargs' in the example above.

     Parameters can specify both optional and required arguments, as
     well as default values for some optional arguments.

     See also the *note argument: 1462. glossary entry, the FAQ question
     on *note the difference between arguments and parameters: 41a5, the
     *note inspect.Parameter: 6e8. class, the *note Function
     definitions: 1196. section, and PEP 362(25).

path entry

     A single location on the *note import path: 13fa. which the *note
     path based finder: 13fd. consults to find modules for importing.

path entry finder

     A *note finder: 13f7. returned by a callable on *note
     sys.path_hooks: 950. (i.e.  a *note path entry hook: 140f.) which
     knows how to locate modules given a *note path entry: 140d.

     See *note importlib.abc.PathEntryFinder: 9a8. for the methods that
     path entry finders implement.

path entry hook

     A callable on the ‘sys.path_hook’ list which returns a *note path
     entry finder: 9a6. if it knows how to find modules on a specific
     *note path entry: 140d.

path based finder

     One of the default *note meta path finders: 9a5. which searches an
     *note import path: 13fa. for modules.

path-like object

     An object representing a file system path.  A path-like object is
     either a *note str: 325. or *note bytes: 326. object representing a
     path, or an object implementing the *note os.PathLike: 4e0.
     protocol.  An object that supports the *note os.PathLike: 4e0.
     protocol can be converted to a *note str: 325. or *note bytes: 326.
     file system path by calling the *note os.fspath(): 4e2. function;
     *note os.fsdecode(): 4e3. and *note os.fsencode(): 4e4. can be used
     to guarantee a *note str: 325. or *note bytes: 326. result instead,
     respectively.  Introduced by PEP 519(26).

PEP

     Python Enhancement Proposal.  A PEP is a design document providing
     information to the Python community, or describing a new feature
     for Python or its processes or environment.  PEPs should provide a
     concise technical specification and a rationale for proposed
     features.

     PEPs are intended to be the primary mechanisms for proposing major
     new features, for collecting community input on an issue, and for
     documenting the design decisions that have gone into Python.  The
     PEP author is responsible for building consensus within the
     community and documenting dissenting opinions.

     See PEP 1(27).

portion

     A set of files in a single directory (possibly stored in a zip
     file) that contribute to a namespace package, as defined in PEP
     420(28).

positional argument

     See *note argument: 1462.

provisional API

     A provisional API is one which has been deliberately excluded from
     the standard library’s backwards compatibility guarantees.  While
     major changes to such interfaces are not expected, as long as they
     are marked provisional, backwards incompatible changes (up to and
     including removal of the interface) may occur if deemed necessary
     by core developers.  Such changes will not be made gratuitously –
     they will occur only if serious fundamental flaws are uncovered
     that were missed prior to the inclusion of the API.

     Even for provisional APIs, backwards incompatible changes are seen
     as a “solution of last resort” - every attempt will still be made
     to find a backwards compatible resolution to any identified
     problems.

     This process allows the standard library to continue to evolve over
     time, without locking in problematic design errors for extended
     periods of time.  See PEP 411(29) for more details.

provisional package

     See *note provisional API: 33d.

Python 3000

     Nickname for the Python 3.x release line (coined long ago when the
     release of version 3 was something in the distant future.)  This is
     also abbreviated “Py3k”.

Pythonic

     An idea or piece of code which closely follows the most common
     idioms of the Python language, rather than implementing code using
     concepts common to other languages.  For example, a common idiom in
     Python is to loop over all elements of an iterable using a *note
     for: c23. statement.  Many other languages don’t have this type of
     construct, so people unfamiliar with Python sometimes use a
     numerical counter instead:

          for i in range(len(food)):     print(food[i])

     As opposed to the cleaner, Pythonic method:

          for piece in food:     print(piece)

qualified name

     A dotted name showing the “path” from a module’s global scope to a
     class, function or method defined in that module, as defined in PEP
     3155(30).  For top-level functions and classes, the qualified name
     is the same as the object’s name:

          >>> class C: ...     class D: ...         def meth(self): ...             pass ... >>> C.__qualname__ 'C' >>> C.D.__qualname__ 'C.D' >>> C.D.meth.__qualname__ 'C.D.meth'

     When used to refer to modules, the `fully qualified name' means the
     entire dotted path to the module, including any parent packages,
     e.g.  ‘email.mime.text’:

          >>> import email.mime.text >>> email.mime.text.__name__ 'email.mime.text'

reference count

     The number of references to an object.  When the reference count of
     an object drops to zero, it is deallocated.  Reference counting is
     generally not visible to Python code, but it is a key element of
     the *note CPython: 1372. implementation.  The *note sys: fd. module
     defines a *note getrefcount(): 356d. function that programmers can
     call to return the reference count for a particular object.

regular package

     A traditional *note package: 13ee, such as a directory containing
     an ‘__init__.py’ file.

     See also *note namespace package: 13f1.

__slots__

     A declaration inside a class that saves memory by pre-declaring
     space for instance attributes and eliminating instance
     dictionaries.  Though popular, the technique is somewhat tricky to
     get right and is best reserved for rare cases where there are large
     numbers of instances in a memory-critical application.

sequence

     An *note iterable: b9f. which supports efficient element access
     using integer indices via the *note __getitem__(): 27a. special
     method and defines a *note __len__(): dbe. method that returns the
     length of the sequence.  Some built-in sequence types are *note
     list: 260, *note str: 325, *note tuple: 473, and *note bytes: 326.
     Note that *note dict: 1b6. also supports *note __getitem__(): 27a.
     and *note __len__(): dbe, but is considered a mapping rather than a
     sequence because the lookups use arbitrary *note immutable: 115c.
     keys rather than integers.

     The *note collections.abc.Sequence: 156b. abstract base class
     defines a much richer interface that goes beyond just *note
     __getitem__(): 27a. and *note __len__(): dbe, adding ‘count()’,
     ‘index()’, *note __contains__(): d1b, and *note __reversed__():
     524.  Types that implement this expanded interface can be
     registered explicitly using ‘register()’.

single dispatch

     A form of *note generic function: 1c8. dispatch where the
     implementation is chosen based on the type of a single argument.

slice

     An object usually containing a portion of a *note sequence: 1162.
     A slice is created using the subscript notation, ‘[]’ with colons
     between numbers when several are given, such as in
     ‘variable_name[1:3:5]’.  The bracket (subscript) notation uses
     *note slice: df7. objects internally.

special method

     A method that is called implicitly by Python to execute a certain
     operation on a type, such as addition.  Such methods have names
     starting and ending with double underscores.  Special methods are
     documented in *note Special method names: 503.

statement

     A statement is part of a suite (a “block” of code).  A statement is
     either an *note expression: 3563. or one of several constructs with
     a keyword, such as *note if: dda, *note while: 1167. or *note for:
     c23.

text encoding

     A codec which encodes Unicode strings to bytes.

text file

     A *note file object: b35. able to read and write *note str: 325.
     objects.  Often, a text file actually accesses a byte-oriented
     datastream and handles the *note text encoding: 1536.
     automatically.  Examples of text files are files opened in text
     mode (‘'r'’ or ‘'w'’), *note sys.stdin: 302, *note sys.stdout: 303,
     and instances of *note io.StringIO: 821.

     See also *note binary file: 1bdb. for a file object able to read
     and write *note bytes-like objects: 5dd.

triple-quoted string

     A string which is bound by three instances of either a quotation
     mark (“) or an apostrophe (‘).  While they don’t provide any
     functionality not available with single-quoted strings, they are
     useful for a number of reasons.  They allow you to include
     unescaped single and double quotes within a string and they can
     span multiple lines without the use of the continuation character,
     making them especially useful when writing docstrings.

type

     The type of a Python object determines what kind of object it is;
     every object has a type.  An object’s type is accessible as its
     *note __class__: dfd. attribute or can be retrieved with
     ‘type(obj)’.

type alias

     A synonym for a type, created by assigning the type to an
     identifier.

     Type aliases are useful for simplifying *note type hints: 425a.
     For example:

          from typing import List, Tuple  def remove_gray_shades(         colors: List[Tuple[int, int, int]]) -> List[Tuple[int, int, int]]:     pass

     could be made more readable like this:

          from typing import List, Tuple  Color = Tuple[int, int, int]  def remove_gray_shades(colors: List[Color]) -> List[Color]:     pass

     See *note typing: 119. and PEP 484(31), which describe this
     functionality.

type hint

     An *note annotation: 4259. that specifies the expected type for a
     variable, a class attribute, or a function parameter or return
     value.

     Type hints are optional and are not enforced by Python but they are
     useful to static type analysis tools, and aid IDEs with code
     completion and refactoring.

     Type hints of global variables, class attributes, and functions,
     but not local variables, can be accessed using *note
     typing.get_type_hints(): 2ff.

     See *note typing: 119. and PEP 484(32), which describe this
     functionality.

universal newlines

     A manner of interpreting text streams in which all of the following
     are recognized as ending a line: the Unix end-of-line convention
     ‘'\n'’, the Windows convention ‘'\r\n'’, and the old Macintosh
     convention ‘'\r'’.  See PEP 278(33) and PEP 3116(34), as well as
     *note bytes.splitlines(): 15df. for an additional use.

variable annotation

     An *note annotation: 4259. of a variable or a class attribute.

     When annotating a variable or a class attribute, assignment is
     optional:

          class C:     field: 'annotation'

     Variable annotations are usually used for *note type hints: 425a.:
     for example this variable is expected to take *note int: 184.
     values:

          count: int = 0

     Variable annotation syntax is explained in section *note Annotated
     assignment statements: 14b2.

     See *note function annotation: 1197, PEP 484(35) and PEP 526(36),
     which describe this functionality.

virtual environment

     A cooperatively isolated runtime environment that allows Python
     users and applications to install and upgrade Python distribution
     packages without interfering with the behaviour of other Python
     applications running on the same system.

     See also *note venv: 125.

virtual machine

     A computer defined entirely in software.  Python’s virtual machine
     executes the *note bytecode: 609. emitted by the bytecode compiler.

Zen of Python

     Listing of Python design principles and philosophies that are
     helpful in understanding and using the language.  The listing can
     be found by typing “‘import this’” at the interactive prompt.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0484

   (2) https://www.python.org/dev/peps/pep-0526

   (3) https://www.python.org/dev/peps/pep-0362

   (4) https://www.python.org/dev/peps/pep-0492

   (5) https://www.python.org/dev/peps/pep-0492

   (6) https://www.python.org/dev/peps/pep-0525

   (7) https://www.python.org/dev/peps/pep-0492

   (8) https://www.python.org/dev/peps/pep-0492

   (9) https://www.python.org/dev/peps/pep-0492

   (10) https://gvanrossum.github.io/

   (11) https://www.python.org/dev/peps/pep-0343

   (12) https://www.python.org/dev/peps/pep-0492

   (13) https://www.python.org/dev/peps/pep-0492

   (14) https://www.python.org

   (15) https://www.python.org/dev/peps/pep-0498

   (16) https://www.python.org/dev/peps/pep-0302

   (17) https://www.python.org/dev/peps/pep-0420

   (18) https://www.python.org/dev/peps/pep-0451

   (19) https://www.python.org/dev/peps/pep-0238

   (20) https://www.python.org/dev/peps/pep-0484

   (21) https://www.python.org/dev/peps/pep-0443

   (22) https://www.python.org/dev/peps/pep-0302

   (23) https://www.python.org/download/releases/2.3/mro/

   (24) https://www.python.org/dev/peps/pep-0420

   (25) https://www.python.org/dev/peps/pep-0362

   (26) https://www.python.org/dev/peps/pep-0519

   (27) https://www.python.org/dev/peps/pep-0001

   (28) https://www.python.org/dev/peps/pep-0420

   (29) https://www.python.org/dev/peps/pep-0411

   (30) https://www.python.org/dev/peps/pep-3155

   (31) https://www.python.org/dev/peps/pep-0484

   (32) https://www.python.org/dev/peps/pep-0484

   (33) https://www.python.org/dev/peps/pep-0278

   (34) https://www.python.org/dev/peps/pep-3116

   (35) https://www.python.org/dev/peps/pep-0484

   (36) https://www.python.org/dev/peps/pep-0526


File: python.info,  Node: About these documents,  Next: Dealing with Bugs,  Prev: Glossary,  Up: Top

13 About these documents
************************

These documents are generated from reStructuredText(1) sources by
Sphinx(2), a document processor specifically written for the Python
documentation.

Development of the documentation and its toolchain is an entirely
volunteer effort, just like Python itself.  If you want to contribute,
please take a look at the *note Dealing with Bugs: 3adb. page for
information on how to do so.  New volunteers are always welcome!

Many thanks go to:

   * Fred L. Drake, Jr., the creator of the original Python
     documentation toolset and writer of much of the content;

   * the Docutils(3) project for creating reStructuredText and the
     Docutils suite;

   * Fredrik Lundh for his Alternative Python Reference(4) project from
     which Sphinx got many good ideas.

* Menu:

* Contributors to the Python Documentation::

   ---------- Footnotes ----------

   (1) http://docutils.sourceforge.net/rst.html

   (2) http://sphinx-doc.org/

   (3) http://docutils.sourceforge.net/

   (4) http://effbot.org/zone/pyref.htm


File: python.info,  Node: Contributors to the Python Documentation,  Up: About these documents

13.1 Contributors to the Python Documentation
=============================================

Many people have contributed to the Python language, the Python standard
library, and the Python documentation.  See Misc/ACKS(1) in the Python
source distribution for a partial list of contributors.

It is only with the input and contributions of the Python community that
Python has such wonderful documentation – Thank You!

   ---------- Footnotes ----------

   (1) https://github.com/python/cpython/tree/3.8/Misc/ACKS


File: python.info,  Node: Dealing with Bugs,  Next: Copyright,  Prev: About these documents,  Up: Top

14 Dealing with Bugs
********************

Python is a mature programming language which has established a
reputation for stability.  In order to maintain this reputation, the
developers would like to know of any deficiencies you find in Python.

It can be sometimes faster to fix bugs yourself and contribute patches
to Python as it streamlines the process and involves less people.  Learn
how to *note contribute: 427b.

* Menu:

* Documentation bugs::
* Using the Python issue tracker::
* Getting started contributing to Python yourself::


File: python.info,  Node: Documentation bugs,  Next: Using the Python issue tracker,  Up: Dealing with Bugs

14.1 Documentation bugs
=======================

If you find a bug in this documentation or would like to propose an
improvement, please submit a bug report on the *note tracker: 427d.  If
you have a suggestion on how to fix it, include that as well.

If you’re short on time, you can also email documentation bug reports to
<docs@python.org> (behavioral bugs can be sent to
<python-list@python.org>).  ‘docs@’ is a mailing list run by volunteers;
your request will be noticed, though it may take a while to be
processed.

See also
........

Documentation bugs(1)

     A list of documentation bugs that have been submitted to the Python
     issue tracker.

Issue Tracking(2)

     Overview of the process involved in reporting an improvement on the
     tracker.

Helping with Documentation(3)

     Comprehensive guide for individuals that are interested in
     contributing to Python documentation.

   ---------- Footnotes ----------

   (1) 
https://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity

   (2) https://devguide.python.org/tracker/

   (3) 
https://devguide.python.org/docquality/#helping-with-documentation


File: python.info,  Node: Using the Python issue tracker,  Next: Getting started contributing to Python yourself,  Prev: Documentation bugs,  Up: Dealing with Bugs

14.2 Using the Python issue tracker
===================================

Bug reports for Python itself should be submitted via the Python Bug
Tracker (‘https://bugs.python.org/’).  The bug tracker offers a Web form
which allows pertinent information to be entered and submitted to the
developers.

The first step in filing a report is to determine whether the problem
has already been reported.  The advantage in doing so, aside from saving
the developers time, is that you learn what has been done to fix it; it
may be that the problem has already been fixed for the next release, or
additional information is needed (in which case you are welcome to
provide it if you can!).  To do this, search the bug database using the
search box on the top of the page.

If the problem you’re reporting is not already in the bug tracker, go
back to the Python Bug Tracker and log in.  If you don’t already have a
tracker account, select the “Register” link or, if you use OpenID, one
of the OpenID provider logos in the sidebar.  It is not possible to
submit a bug report anonymously.

Being now logged in, you can submit a bug.  Select the “Create New” link
in the sidebar to open the bug reporting form.

The submission form has a number of fields.  For the “Title” field,
enter a `very' short description of the problem; less than ten words is
good.  In the “Type” field, select the type of your problem; also select
the “Component” and “Versions” to which the bug relates.

In the “Comment” field, describe the problem in detail, including what
you expected to happen and what did happen.  Be sure to include whether
any extension modules were involved, and what hardware and software
platform you were using (including version information as appropriate).

Each bug report will be assigned to a developer who will determine what
needs to be done to correct the problem.  You will receive an update
each time action is taken on the bug.

See also
........

How to Report Bugs Effectively(1)

     Article which goes into some detail about how to create a useful
     bug report.  This describes what kind of information is useful and
     why it is useful.

Bug Report Writing Guidelines(2)

     Information about writing a good bug report.  Some of this is
     specific to the Mozilla project, but describes general good
     practices.

   ---------- Footnotes ----------

   (1) https://www.chiark.greenend.org.uk/~sgtatham/bugs.html

   (2) 
https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines


File: python.info,  Node: Getting started contributing to Python yourself,  Prev: Using the Python issue tracker,  Up: Dealing with Bugs

14.3 Getting started contributing to Python yourself
====================================================

Beyond just reporting bugs that you find, you are also welcome to submit
patches to fix them.  You can find more information on how to get
started patching Python in the Python Developer’s Guide(1).  If you have
questions, the core-mentorship mailing list(2) is a friendly place to
get answers to any and all questions pertaining to the process of fixing
issues in Python.

   ---------- Footnotes ----------

   (1) https://devguide.python.org/

   (2) 
https://mail.python.org/mailman3/lists/core-mentorship.python.org/


File: python.info,  Node: Copyright,  Next: History and License,  Prev: Dealing with Bugs,  Up: Top

15 Copyright
************

Python and this documentation is:

Copyright © 2001-2019 Python Software Foundation.  All rights reserved.

Copyright © 2000 BeOpen.com.  All rights reserved.

Copyright © 1995-2000 Corporation for National Research Initiatives.
All rights reserved.

Copyright © 1991-1995 Stichting Mathematisch Centrum.  All rights
reserved.

__________________________________________________________________

See *note History and License: 4283. for complete license and
permissions information.


File: python.info,  Node: History and License,  Next: Distributing Python Modules Legacy version,  Prev: Copyright,  Up: Top

16 History and License
**********************

* Menu:

* History of the software::
* Terms and conditions for accessing or otherwise using Python::
* Licenses and Acknowledgements for Incorporated Software::


File: python.info,  Node: History of the software,  Next: Terms and conditions for accessing or otherwise using Python,  Up: History and License

16.1 History of the software
============================

Python was created in the early 1990s by Guido van Rossum at Stichting
Mathematisch Centrum (CWI, see ‘https://www.cwi.nl/’) in the Netherlands
as a successor of a language called ABC. Guido remains Python’s
principal author, although it includes many contributions from others.

In 1995, Guido continued his work on Python at the Corporation for
National Research Initiatives (CNRI, see
‘https://www.cnri.reston.va.us/’) in Reston, Virginia where he released
several versions of the software.

In May 2000, Guido and the Python core development team moved to
BeOpen.com to form the BeOpen PythonLabs team.  In October of the same
year, the PythonLabs team moved to Digital Creations (now Zope
Corporation; see ‘https://www.zope.org/’).  In 2001, the Python Software
Foundation (PSF, see ‘https://www.python.org/psf/’) was formed, a
non-profit organization created specifically to own Python-related
Intellectual Property.  Zope Corporation is a sponsoring member of the
PSF.

All Python releases are Open Source (see ‘https://opensource.org/’ for
the Open Source Definition).  Historically, most, but not all, Python
releases have also been GPL-compatible; the table below summarizes the
various releases.

Release              Derived from       Year             Owner            GPL compatible?
                                                                          
------------------------------------------------------------------------------------------------
                                                                          
0.9.0 thru 1.2       n/a                1991-1995        CWI              yes
                                                                          
                                                                          
1.3 thru 1.5.2       1.2                1995-1999        CNRI             yes
                                                                          
                                                                          
1.6                  1.5.2              2000             CNRI             no
                                                                          
                                                                          
2.0                  1.6                2000             BeOpen.com       no
                                                                          
                                                                          
1.6.1                1.6                2001             CNRI             no
                                                                          
                                                                          
2.1                  2.0+1.6.1          2001             PSF              no
                                                                          
                                                                          
2.0.1                2.0+1.6.1          2001             PSF              yes
                                                                          
                                                                          
2.1.1                2.1+2.0.1          2001             PSF              yes
                                                                          
                                                                          
2.1.2                2.1.1              2002             PSF              yes
                                                                          
                                                                          
2.1.3                2.1.2              2002             PSF              yes
                                                                          
                                                                          
2.2 and above        2.1.1              2001-now         PSF              yes
                                                                          

     Note: GPL-compatible doesn’t mean that we’re distributing Python
     under the GPL. All Python licenses, unlike the GPL, let you
     distribute a modified version without making your changes open
     source.  The GPL-compatible licenses make it possible to combine
     Python with other software that is released under the GPL; the
     others don’t.

Thanks to the many outside volunteers who have worked under Guido’s
direction to make these releases possible.


File: python.info,  Node: Terms and conditions for accessing or otherwise using Python,  Next: Licenses and Acknowledgements for Incorporated Software,  Prev: History of the software,  Up: History and License

16.2 Terms and conditions for accessing or otherwise using Python
=================================================================

* Menu:

* PSF LICENSE AGREEMENT FOR PYTHON 3.8.1: PSF LICENSE AGREEMENT FOR PYTHON 3 8 1.
* BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0: BEOPEN COM LICENSE AGREEMENT FOR PYTHON 2 0.
* CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1: CNRI LICENSE AGREEMENT FOR PYTHON 1 6 1.
* CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2: CWI LICENSE AGREEMENT FOR PYTHON 0 9 0 THROUGH 1 2.


File: python.info,  Node: PSF LICENSE AGREEMENT FOR PYTHON 3 8 1,  Next: BEOPEN COM LICENSE AGREEMENT FOR PYTHON 2 0,  Up: Terms and conditions for accessing or otherwise using Python

16.2.1 PSF LICENSE AGREEMENT FOR PYTHON 3.8.1
---------------------------------------------

     1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and    the Individual or Organization ("Licensee") accessing and otherwise using Python    3.8.1 software in source or binary form and its associated documentation.  2. Subject to the terms and conditions of this License Agreement, PSF hereby    grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,    analyze, test, perform and/or display publicly, prepare derivative works,    distribute, and otherwise use Python 3.8.1 alone or in any derivative    version, provided, however, that PSF's License Agreement and PSF's notice of    copyright, i.e., "Copyright © 2001-2019 Python Software Foundation; All Rights    Reserved" are retained in Python 3.8.1 alone or in any derivative version    prepared by Licensee.  3. In the event Licensee prepares a derivative work that is based on or    incorporates Python 3.8.1 or any part thereof, and wants to make the    derivative work available to others as provided herein, then Licensee hereby    agrees to include in any such work a brief summary of the changes made to Python    3.8.1.  4. PSF is making Python 3.8.1 available to Licensee on an "AS IS" basis.    PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF    EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR    WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE    USE OF PYTHON 3.8.1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.  5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 3.8.1    FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF    MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 3.8.1, OR ANY DERIVATIVE    THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.  6. This License Agreement will automatically terminate upon a material breach of    its terms and conditions.  7. Nothing in this License Agreement shall be deemed to create any relationship    of agency, partnership, or joint venture between PSF and Licensee.  This License    Agreement does not grant permission to use PSF trademarks or trade name in a    trademark sense to endorse or promote products or services of Licensee, or any    third party.  8. By copying, installing or otherwise using Python 3.8.1, Licensee agrees    to be bound by the terms and conditions of this License Agreement.


File: python.info,  Node: BEOPEN COM LICENSE AGREEMENT FOR PYTHON 2 0,  Next: CNRI LICENSE AGREEMENT FOR PYTHON 1 6 1,  Prev: PSF LICENSE AGREEMENT FOR PYTHON 3 8 1,  Up: Terms and conditions for accessing or otherwise using Python

16.2.2 BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
--------------------------------------------------

BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1

     1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an office at    160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or Organization    ("Licensee") accessing and otherwise using this software in source or binary    form and its associated documentation ("the Software").  2. Subject to the terms and conditions of this BeOpen Python License Agreement,    BeOpen hereby grants Licensee a non-exclusive, royalty-free, world-wide license    to reproduce, analyze, test, perform and/or display publicly, prepare derivative    works, distribute, and otherwise use the Software alone or in any derivative    version, provided, however, that the BeOpen Python License is retained in the    Software, alone or in any derivative version prepared by Licensee.  3. BeOpen is making the Software available to Licensee on an "AS IS" basis.    BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF    EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY REPRESENTATION OR    WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE    USE OF THE SOFTWARE WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.  4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE SOFTWARE FOR    ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF USING,    MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY DERIVATIVE THEREOF, EVEN IF    ADVISED OF THE POSSIBILITY THEREOF.  5. This License Agreement will automatically terminate upon a material breach of    its terms and conditions.  6. This License Agreement shall be governed by and interpreted in all respects    by the law of the State of California, excluding conflict of law provisions.    Nothing in this License Agreement shall be deemed to create any relationship of    agency, partnership, or joint venture between BeOpen and Licensee.  This License    Agreement does not grant permission to use BeOpen trademarks or trade names in a    trademark sense to endorse or promote products or services of Licensee, or any    third party.  As an exception, the "BeOpen Python" logos available at    ‘http://www.pythonlabs.com/logos.html’ may be used according to the permissions    granted on that web page.  7. By copying, installing or otherwise using the software, Licensee agrees to be    bound by the terms and conditions of this License Agreement.


File: python.info,  Node: CNRI LICENSE AGREEMENT FOR PYTHON 1 6 1,  Next: CWI LICENSE AGREEMENT FOR PYTHON 0 9 0 THROUGH 1 2,  Prev: BEOPEN COM LICENSE AGREEMENT FOR PYTHON 2 0,  Up: Terms and conditions for accessing or otherwise using Python

16.2.3 CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
----------------------------------------------

     1. This LICENSE AGREEMENT is between the Corporation for National Research    Initiatives, having an office at 1895 Preston White Drive, Reston, VA 20191    ("CNRI"), and the Individual or Organization ("Licensee") accessing and    otherwise using Python 1.6.1 software in source or binary form and its    associated documentation.  2. Subject to the terms and conditions of this License Agreement, CNRI hereby    grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,    analyze, test, perform and/or display publicly, prepare derivative works,    distribute, and otherwise use Python 1.6.1 alone or in any derivative version,    provided, however, that CNRI's License Agreement and CNRI's notice of copyright,    i.e., "Copyright © 1995-2001 Corporation for National Research Initiatives; All    Rights Reserved" are retained in Python 1.6.1 alone or in any derivative version    prepared by Licensee.  Alternately, in lieu of CNRI's License Agreement,    Licensee may substitute the following text (omitting the quotes): "Python 1.6.1    is made available subject to the terms and conditions in CNRI's License    Agreement.  This Agreement together with Python 1.6.1 may be located on the    Internet using the following unique, persistent identifier (known as a handle):    1895.22/1013.  This Agreement may also be obtained from a proxy server on the    Internet using the following URL: ‘http://hdl.handle.net/1895.22/1013’."  3. In the event Licensee prepares a derivative work that is based on or    incorporates Python 1.6.1 or any part thereof, and wants to make the derivative    work available to others as provided herein, then Licensee hereby agrees to    include in any such work a brief summary of the changes made to Python 1.6.1.  4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS" basis.  CNRI    MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF EXAMPLE,    BUT NOT LIMITATION, CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY    OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF    PYTHON 1.6.1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.  5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 1.6.1 FOR    ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF    MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1, OR ANY DERIVATIVE    THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.  6. This License Agreement will automatically terminate upon a material breach of    its terms and conditions.  7. This License Agreement shall be governed by the federal intellectual property    law of the United States, including without limitation the federal copyright    law, and, to the extent such U.S. federal law does not apply, by the law of the    Commonwealth of Virginia, excluding Virginia's conflict of law provisions.    Notwithstanding the foregoing, with regard to derivative works based on Python    1.6.1 that incorporate non-separable material that was previously distributed    under the GNU General Public License (GPL), the law of the Commonwealth of    Virginia shall govern this License Agreement only as to issues arising under or    with respect to Paragraphs 4, 5, and 7 of this License Agreement.  Nothing in    this License Agreement shall be deemed to create any relationship of agency,    partnership, or joint venture between CNRI and Licensee.  This License Agreement    does not grant permission to use CNRI trademarks or trade name in a trademark    sense to endorse or promote products or services of Licensee, or any third    party.  8. By clicking on the "ACCEPT" button where indicated, or by copying, installing    or otherwise using Python 1.6.1, Licensee agrees to be bound by the terms and    conditions of this License Agreement.


File: python.info,  Node: CWI LICENSE AGREEMENT FOR PYTHON 0 9 0 THROUGH 1 2,  Prev: CNRI LICENSE AGREEMENT FOR PYTHON 1 6 1,  Up: Terms and conditions for accessing or otherwise using Python

16.2.4 CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
---------------------------------------------------------

     Copyright © 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, The Netherlands.  All rights reserved.  Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Stichting Mathematisch Centrum or CWI not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.  STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.


File: python.info,  Node: Licenses and Acknowledgements for Incorporated Software,  Prev: Terms and conditions for accessing or otherwise using Python,  Up: History and License

16.3 Licenses and Acknowledgements for Incorporated Software
============================================================

This section is an incomplete, but growing list of licenses and
acknowledgements for third-party software incorporated in the Python
distribution.

* Menu:

* Mersenne Twister::
* Sockets: Sockets<2>.
* Asynchronous socket services::
* Cookie management::
* Execution tracing::
* UUencode and UUdecode functions::
* XML Remote Procedure Calls::
* test_epoll::
* Select kqueue::
* SipHash24::
* strtod and dtoa::
* OpenSSL::
* expat::
* libffi::
* zlib: zlib<3>.
* cfuhash::
* libmpdec::
* W3C C14N test suite::


File: python.info,  Node: Mersenne Twister,  Next: Sockets<2>,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.1 Mersenne Twister
-----------------------

The ‘_random’ module includes code based on a download from
‘http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html’.
The following are the verbatim comments from the original code:

     A C-program for MT19937, with initialization improved 2002/1/26. Coded by Takuji Nishimura and Makoto Matsumoto.  Before using, initialize the state by using init_genrand(seed) or init_by_array(init_key, key_length).  Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura, All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:   1. Redistributions of source code must retain the above copyright     notice, this list of conditions and the following disclaimer.   2. Redistributions in binary form must reproduce the above copyright     notice, this list of conditions and the following disclaimer in the     documentation and/or other materials provided with the distribution.   3. The names of its contributors may not be used to endorse or promote     products derived from this software without specific prior written     permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.   Any feedback is very welcome. http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)


File: python.info,  Node: Sockets<2>,  Next: Asynchronous socket services,  Prev: Mersenne Twister,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.2 Sockets
--------------

The *note socket: ef. module uses the functions, ‘getaddrinfo()’, and
‘getnameinfo()’, which are coded in separate source files from the WIDE
Project, ‘http://www.wide.ad.jp/’.

     Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright    notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright    notice, this list of conditions and the following disclaimer in the    documentation and/or other materials provided with the distribution. 3. Neither the name of the project nor the names of its contributors    may be used to endorse or promote products derived from this software    without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


File: python.info,  Node: Asynchronous socket services,  Next: Cookie management,  Prev: Sockets<2>,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.3 Asynchronous socket services
-----------------------------------

The *note asynchat: 9. and *note asyncore: b. modules contain the
following notice:

     Copyright 1996 by Sam Rushing                          All Rights Reserved  Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Sam Rushing not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.  SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.


File: python.info,  Node: Cookie management,  Next: Execution tracing,  Prev: Asynchronous socket services,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.4 Cookie management
------------------------

The *note http.cookies: 96. module contains the following notice:

     Copyright 2000 by Timothy O'Malley <timo@alum.mit.edu>                 All Rights Reserved  Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Timothy O'Malley  not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.  Timothy O'Malley DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL Timothy O'Malley BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.


File: python.info,  Node: Execution tracing,  Next: UUencode and UUdecode functions,  Prev: Cookie management,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.5 Execution tracing
------------------------

The *note trace: 112. module contains the following notice:

     portions copyright 2001, Autonomous Zones Industries, Inc., all rights... err...  reserved and offered to the public under the terms of the Python 2.2 license. Author: Zooko O'Whielacronx http://zooko.com/ mailto:zooko@zooko.com  Copyright 2000, Mojam Media, Inc., all rights reserved. Author: Skip Montanaro  Copyright 1999, Bioreason, Inc., all rights reserved. Author: Andrew Dalke  Copyright 1995-1997, Automatrix, Inc., all rights reserved. Author: Skip Montanaro  Copyright 1991-1995, Stichting Mathematisch Centrum, all rights reserved.   Permission to use, copy, modify, and distribute this Python software and its associated documentation for any purpose without fee is hereby granted, provided that the above copyright notice appears in all copies, and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of neither Automatrix, Bioreason or Mojam Media be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.


File: python.info,  Node: UUencode and UUdecode functions,  Next: XML Remote Procedure Calls,  Prev: Execution tracing,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.6 UUencode and UUdecode functions
--------------------------------------

The *note uu: 123. module contains the following notice:

     Copyright 1994 by Lance Ellinghouse Cathedral City, California Republic, United States of America.                        All Rights Reserved Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Lance Ellinghouse not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  Modified by Jack Jansen, CWI, July 1995: - Use binascii module to do the actual line-by-line conversion   between ascii and binary. This results in a 1000-fold speedup. The C   version is still 5 times faster, though. - Arguments more compliant with Python standard


File: python.info,  Node: XML Remote Procedure Calls,  Next: test_epoll,  Prev: UUencode and UUdecode functions,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.7 XML Remote Procedure Calls
---------------------------------

The *note xmlrpc.client: 13f. module contains the following notice:

         The XML-RPC client interface is  Copyright (c) 1999-2002 by Secret Labs AB Copyright (c) 1999-2002 by Fredrik Lundh  By obtaining, using, and/or copying this software and/or its associated documentation, you agree that you have read, understood, and will comply with the following terms and conditions:  Permission to use, copy, modify, and distribute this software and its associated documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appears in all copies, and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Secret Labs AB or the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.  SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT- ABILITY AND FITNESS.  IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.


File: python.info,  Node: test_epoll,  Next: Select kqueue,  Prev: XML Remote Procedure Calls,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.8 test_epoll
-----------------

The ‘test_epoll’ module contains the following notice:

     Copyright (c) 2001-2006 Twisted Matrix Laboratories.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


File: python.info,  Node: Select kqueue,  Next: SipHash24,  Prev: test_epoll,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.9 Select kqueue
--------------------

The *note select: e5. module contains the following notice for the
kqueue interface:

     Copyright (c) 2000 Doug White, 2006 James Knight, 2007 Christian Heimes All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright    notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright    notice, this list of conditions and the following disclaimer in the    documentation and/or other materials provided with the distribution.  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


File: python.info,  Node: SipHash24,  Next: strtod and dtoa,  Prev: Select kqueue,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.10 SipHash24
-----------------

The file ‘Python/pyhash.c’ contains Marek Majkowski’ implementation of
Dan Bernstein’s SipHash24 algorithm.  It contains the following note:

     <MIT License> Copyright (c) 2013  Marek Majkowski <marek@popcount.org>  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. </MIT License>  Original location:    https://github.com/majek/csiphash/  Solution inspired by code from:    Samuel Neves (supercop/crypto_auth/siphash24/little)    djb (supercop/crypto_auth/siphash24/little2)    Jean-Philippe Aumasson (https://131002.net/siphash/siphash24.c)


File: python.info,  Node: strtod and dtoa,  Next: OpenSSL,  Prev: SipHash24,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.11 strtod and dtoa
-----------------------

The file ‘Python/dtoa.c’, which supplies C functions dtoa and strtod for
conversion of C doubles to and from strings, is derived from the file of
the same name by David M. Gay, currently available from
‘http://www.netlib.org/fp/’.  The original file, as retrieved on March
16, 2009, contains the following copyright and licensing notice:

     /****************************************************************  *  * The author of this software is David M. Gay.  *  * Copyright (c) 1991, 2000, 2001 by Lucent Technologies.  *  * Permission to use, copy, modify, and distribute this software for any  * purpose without fee is hereby granted, provided that this entire notice  * is included in all copies of any software which is or includes a copy  * or modification of this software and in all copies of the supporting  * documentation for such software.  *  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED  * WARRANTY.  IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY  * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY  * OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.  *  ***************************************************************/


File: python.info,  Node: OpenSSL,  Next: expat,  Prev: strtod and dtoa,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.12 OpenSSL
---------------

The modules *note hashlib: 8d, *note posix: d1, *note ssl: f3, *note
crypt: 29. use the OpenSSL library for added performance if made
available by the operating system.  Additionally, the Windows and Mac OS
X installers for Python may include a copy of the OpenSSL libraries, so
we include a copy of the OpenSSL license here:

      LICENSE ISSUES  ==============   The OpenSSL toolkit stays under a dual license, i.e. both the conditions of  the OpenSSL License and the original SSLeay license apply to the toolkit.  See below for the actual license texts. Actually both licenses are BSD-style  Open Source licenses. In case of any license issues related to OpenSSL  please contact openssl-core@openssl.org.   OpenSSL License  ---------------     /* ====================================================================     * Copyright (c) 1998-2008 The OpenSSL Project.  All rights reserved.     *     * Redistribution and use in source and binary forms, with or without     * modification, are permitted provided that the following conditions     * are met:     *     * 1. Redistributions of source code must retain the above copyright     *    notice, this list of conditions and the following disclaimer.     *     * 2. Redistributions in binary form must reproduce the above copyright     *    notice, this list of conditions and the following disclaimer in     *    the documentation and/or other materials provided with the     *    distribution.     *     * 3. All advertising materials mentioning features or use of this     *    software must display the following acknowledgment:     *    "This product includes software developed by the OpenSSL Project     *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"     *     * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to     *    endorse or promote products derived from this software without     *    prior written permission. For written permission, please contact     *    openssl-core@openssl.org.     *     * 5. Products derived from this software may not be called "OpenSSL"     *    nor may "OpenSSL" appear in their names without prior written     *    permission of the OpenSSL Project.     *     * 6. Redistributions of any form whatsoever must retain the following     *    acknowledgment:     *    "This product includes software developed by the OpenSSL Project     *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"     *     * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY     * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR     * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR     * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,     * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT     * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;     * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,     * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)     * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED     * OF THE POSSIBILITY OF SUCH DAMAGE.     * ====================================================================     *     * This product includes cryptographic software written by Eric Young     * (eay@cryptsoft.com).  This product includes software written by Tim     * Hudson (tjh@cryptsoft.com).     *     */  Original SSLeay License -----------------------     /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)     * All rights reserved.     *     * This package is an SSL implementation written     * by Eric Young (eay@cryptsoft.com).     * The implementation was written so as to conform with Netscapes SSL.     *     * This library is free for commercial and non-commercial use as long as     * the following conditions are aheared to.  The following conditions     * apply to all code found in this distribution, be it the RC4, RSA,     * lhash, DES, etc., code; not just the SSL code.  The SSL documentation     * included with this distribution is covered by the same copyright terms     * except that the holder is Tim Hudson (tjh@cryptsoft.com).     *     * Copyright remains Eric Young's, and as such any Copyright notices in     * the code are not to be removed.     * If this package is used in a product, Eric Young should be given attribution     * as the author of the parts of the library used.     * This can be in the form of a textual message at program startup or     * in documentation (online or textual) provided with the package.     *     * Redistribution and use in source and binary forms, with or without     * modification, are permitted provided that the following conditions     * are met:     * 1. Redistributions of source code must retain the copyright     *    notice, this list of conditions and the following disclaimer.     * 2. Redistributions in binary form must reproduce the above copyright     *    notice, this list of conditions and the following disclaimer in the     *    documentation and/or other materials provided with the distribution.     * 3. All advertising materials mentioning features or use of this software     *    must display the following acknowledgement:     *    "This product includes cryptographic software written by     *     Eric Young (eay@cryptsoft.com)"     *    The word 'cryptographic' can be left out if the rouines from the library     *    being used are not cryptographic related :-).     * 4. If you include any Windows specific code (or a derivative thereof) from     *    the apps directory (application code) you must include an acknowledgement:     *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"     *     * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND     * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE     * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE     * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS     * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT     * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY     * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF     * SUCH DAMAGE.     *     * The licence and distribution terms for any publically available version or     * derivative of this code cannot be changed.  i.e. this code cannot simply be     * copied and put under another distribution licence     * [including the GNU Public Licence.]     */


File: python.info,  Node: expat,  Next: libffi,  Prev: OpenSSL,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.13 expat
-------------

The ‘pyexpat’ extension is built using an included copy of the expat
sources unless the build is configured ‘--with-system-expat’:

     Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd                                and Clark Cooper  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


File: python.info,  Node: libffi,  Next: zlib<3>,  Prev: expat,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.14 libffi
--------------

The ‘_ctypes’ extension is built using an included copy of the libffi
sources unless the build is configured ‘--with-system-libffi’:

     Copyright (c) 1996-2008  Red Hat, Inc and others.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ``Software''), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


File: python.info,  Node: zlib<3>,  Next: cfuhash,  Prev: libffi,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.15 zlib
------------

The *note zlib: 144. extension is built using an included copy of the
zlib sources if the zlib version found on the system is too old to be
used for the build:

     Copyright (C) 1995-2011 Jean-loup Gailly and Mark Adler  This software is provided 'as-is', without any express or implied warranty.  In no event will the authors be held liable for any damages arising from the use of this software.  Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:  1. The origin of this software must not be misrepresented; you must not    claim that you wrote the original software. If you use this software    in a product, an acknowledgment in the product documentation would be    appreciated but is not required.  2. Altered source versions must be plainly marked as such, and must not be    misrepresented as being the original software.  3. This notice may not be removed or altered from any source distribution.  Jean-loup Gailly        Mark Adler jloup@gzip.org          madler@alumni.caltech.edu


File: python.info,  Node: cfuhash,  Next: libmpdec,  Prev: zlib<3>,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.16 cfuhash
---------------

The implementation of the hash table used by the *note tracemalloc: 114.
is based on the cfuhash project:

     Copyright (c) 2005 Don Owens All rights reserved.  This code is released under the BSD license:  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:    * Redistributions of source code must retain the above copyright     notice, this list of conditions and the following disclaimer.    * Redistributions in binary form must reproduce the above     copyright notice, this list of conditions and the following     disclaimer in the documentation and/or other materials provided     with the distribution.    * Neither the name of the author nor the names of its     contributors may be used to endorse or promote products derived     from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


File: python.info,  Node: libmpdec,  Next: W3C C14N test suite,  Prev: cfuhash,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.17 libmpdec
----------------

The ‘_decimal’ module is built using an included copy of the libmpdec
library unless the build is configured ‘--with-system-libmpdec’:

     Copyright (c) 2008-2016 Stefan Krah. All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright    notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright    notice, this list of conditions and the following disclaimer in the    documentation and/or other materials provided with the distribution.  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


File: python.info,  Node: W3C C14N test suite,  Prev: libmpdec,  Up: Licenses and Acknowledgements for Incorporated Software

16.3.18 W3C C14N test suite
---------------------------

The C14N 2.0 test suite in the *note test: 105. package
(‘Lib/test/xmltestdata/c14n-20/’) was retrieved from the W3C website at
‘https://www.w3.org/TR/xml-c14n2-testcases/’ and is distributed under
the 3-clause BSD license:

     Copyright (c) 2013 W3C(R) (MIT, ERCIM, Keio, Beihang), All Rights
     Reserved.

     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions
     are met:

        * Redistributions of works must retain the original copyright
          notice, this list of conditions and the following disclaimer.

        * Redistributions in binary form must reproduce the original
          copyright notice, this list of conditions and the following
          disclaimer in the documentation and/or other materials
          provided with the distribution.

        * Neither the name of the W3C nor the names of its contributors
          may be used to endorse or promote products derived from this
          work without specific prior written permission.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
     COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
     OF THE POSSIBILITY OF SUCH DAMAGE.


File: python.info,  Node: Distributing Python Modules Legacy version,  Next: Installing Python Modules Legacy version,  Prev: History and License,  Up: Top

17 Distributing Python Modules (Legacy version)
***********************************************


Authors: Greg Ward, Anthony Baxter


Email: <distutils-sig@python.org>

See also
........

*note Distributing Python Modules: 7ea.

     The up to date module distribution documentations

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

     Note: This guide only covers the basic tools for building and
     distributing extensions that are provided as part of this version
     of Python.  Third party tools offer easier to use and more secure
     alternatives.  Refer to the quick recommendations section(1) in the
     Python Packaging User Guide for more information.

This document describes the Python Distribution Utilities (“Distutils”)
from the module developer’s point of view, describing the underlying
capabilities that ‘setuptools’ builds on to allow Python developers to
make Python modules and extensions readily available to a wider
audience.

* Menu:

* An Introduction to Distutils::
* Writing the Setup Script::
* Writing the Setup Configuration File::
* Creating a Source Distribution::
* Creating Built Distributions::
* Distutils Examples::
* Extending Distutils::
* Command Reference::
* API Reference::

   ---------- Footnotes ----------

   (1) https://packaging.python.org/guides/tool-recommendations/


File: python.info,  Node: An Introduction to Distutils,  Next: Writing the Setup Script,  Up: Distributing Python Modules Legacy version

17.1 An Introduction to Distutils
=================================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

This document covers using the Distutils to distribute your Python
modules, concentrating on the role of developer/distributor: if you’re
looking for information on installing Python modules, you should refer
to the *note Installing Python Modules (Legacy version): 7eb. chapter.

* Menu:

* Concepts & Terminology::
* A Simple Example: A Simple Example<2>.
* General Python terminology::
* Distutils-specific terminology::


File: python.info,  Node: Concepts & Terminology,  Next: A Simple Example<2>,  Up: An Introduction to Distutils

17.1.1 Concepts & Terminology
-----------------------------

Using the Distutils is quite simple, both for module developers and for
users/administrators installing third-party modules.  As a developer,
your responsibilities (apart from writing solid, well-documented and
well-tested code, of course!)  are:

   * write a setup script (‘setup.py’ by convention)

   * (optional) write a setup configuration file

   * create a source distribution

   * (optional) create one or more built (binary) distributions

Each of these tasks is covered in this document.

Not all module developers have access to a multitude of platforms, so
it’s not always feasible to expect them to create a multitude of built
distributions.  It is hoped that a class of intermediaries, called
`packagers', will arise to address this need.  Packagers will take
source distributions released by module developers, build them on one or
more platforms, and release the resulting built distributions.  Thus,
users on the most popular platforms will be able to install most popular
Python module distributions in the most natural way for their platform,
without having to run a single setup script or compile a line of code.


File: python.info,  Node: A Simple Example<2>,  Next: General Python terminology,  Prev: Concepts & Terminology,  Up: An Introduction to Distutils

17.1.2 A Simple Example
-----------------------

The setup script is usually quite simple, although since it’s written in
Python, there are no arbitrary limits to what you can do with it, though
you should be careful about putting arbitrarily expensive operations in
your setup script.  Unlike, say, Autoconf-style configure scripts, the
setup script may be run multiple times in the course of building and
installing your module distribution.

If all you want to do is distribute a module called ‘foo’, contained in
a file ‘foo.py’, then your setup script can be as simple as this:

     from distutils.core import setup setup(name='foo',       version='1.0',       py_modules=['foo'],       )

Some observations:

   * most information that you supply to the Distutils is supplied as
     keyword arguments to the ‘setup()’ function

   * those keyword arguments fall into two categories: package metadata
     (name, version number) and information about what’s in the package
     (a list of pure Python modules, in this case)

   * modules are specified by module name, not filename (the same will
     hold true for packages and extensions)

   * it’s recommended that you supply a little more metadata, in
     particular your name, email address and a URL for the project (see
     section *note Writing the Setup Script: 42a8. for an example)

To create a source distribution for this module, you would create a
setup script, ‘setup.py’, containing the above code, and run this
command from a terminal:

     python setup.py sdist

For Windows, open a command prompt window (Start ‣ Accessories) and
change the command to:

     setup.py sdist

‘sdist’ will create an archive file (e.g., tarball on Unix, ZIP file on
Windows) containing your setup script ‘setup.py’, and your module
‘foo.py’.  The archive file will be named ‘foo-1.0.tar.gz’ (or ‘.zip’),
and will unpack into a directory ‘foo-1.0’.

If an end-user wishes to install your ‘foo’ module, all they have to do
is download ‘foo-1.0.tar.gz’ (or ‘.zip’), unpack it, and—from the
‘foo-1.0’ directory—run

     python setup.py install

which will ultimately copy ‘foo.py’ to the appropriate directory for
third-party modules in their Python installation.

This simple example demonstrates some fundamental concepts of the
Distutils.  First, both developers and installers have the same basic
user interface, i.e.  the setup script.  The difference is which
Distutils `commands' they use: the ‘sdist’ command is almost exclusively
for module developers, while ‘install’ is more often for installers
(although most developers will want to install their own code
occasionally).

If you want to make things really easy for your users, you can create
one or more built distributions for them.  For instance, if you are
running on a Windows machine, and want to make things easy for other
Windows users, you can create an executable installer (the most
appropriate type of built distribution for this platform) with the
‘bdist_wininst’ command.  For example:

     python setup.py bdist_wininst

will create an executable installer, ‘foo-1.0.win32.exe’, in the current
directory.

Other useful built distribution formats are RPM, implemented by the
‘bdist_rpm’ command, Solaris ‘pkgtool’ (‘bdist_pkgtool’), and HP-UX
‘swinstall’ (‘bdist_sdux’).  For example, the following command will
create an RPM file called ‘foo-1.0.noarch.rpm’:

     python setup.py bdist_rpm

(The ‘bdist_rpm’ command uses the ‘rpm’ executable, therefore this has
to be run on an RPM-based system such as Red Hat Linux, SuSE Linux, or
Mandrake Linux.)

You can find out what distribution formats are available at any time by
running

     python setup.py bdist --help-formats


File: python.info,  Node: General Python terminology,  Next: Distutils-specific terminology,  Prev: A Simple Example<2>,  Up: An Introduction to Distutils

17.1.3 General Python terminology
---------------------------------

If you’re reading this document, you probably have a good idea of what
modules, extensions, and so forth are.  Nevertheless, just to be sure
that everyone is operating from a common starting point, we offer the
following glossary of common Python terms:

module

     the basic unit of code reusability in Python: a block of code
     imported by some other code.  Three types of modules concern us
     here: pure Python modules, extension modules, and packages.

pure Python module

     a module written in Python and contained in a single ‘.py’ file
     (and possibly associated ‘.pyc’ files).  Sometimes referred to as a
     “pure module.”

extension module

     a module written in the low-level language of the Python
     implementation: C/C++ for Python, Java for Jython.  Typically
     contained in a single dynamically loadable pre-compiled file, e.g.
     a shared object (‘.so’) file for Python extensions on Unix, a DLL
     (given the ‘.pyd’ extension) for Python extensions on Windows, or a
     Java class file for Jython extensions.  (Note that currently, the
     Distutils only handles C/C++ extensions for Python.)

package

     a module that contains other modules; typically contained in a
     directory in the filesystem and distinguished from other
     directories by the presence of a file ‘__init__.py’.

root package

     the root of the hierarchy of packages.  (This isn’t really a
     package, since it doesn’t have an ‘__init__.py’ file.  But we have
     to call it something.)  The vast majority of the standard library
     is in the root package, as are many small, standalone third-party
     modules that don’t belong to a larger module collection.  Unlike
     regular packages, modules in the root package can be found in many
     directories: in fact, every directory listed in ‘sys.path’
     contributes modules to the root package.


File: python.info,  Node: Distutils-specific terminology,  Prev: General Python terminology,  Up: An Introduction to Distutils

17.1.4 Distutils-specific terminology
-------------------------------------

The following terms apply more specifically to the domain of
distributing Python modules using the Distutils:

module distribution

     a collection of Python modules distributed together as a single
     downloadable resource and meant to be installed `en masse'.
     Examples of some well-known module distributions are NumPy, SciPy,
     Pillow, or mxBase.  (This would be called a `package', except that
     term is already taken in the Python context: a single module
     distribution may contain zero, one, or many Python packages.)

pure module distribution

     a module distribution that contains only pure Python modules and
     packages.  Sometimes referred to as a “pure distribution.”

non-pure module distribution

     a module distribution that contains at least one extension module.
     Sometimes referred to as a “non-pure distribution.”

distribution root

     the top-level directory of your source tree (or source
     distribution); the directory where ‘setup.py’ exists.  Generally
     ‘setup.py’ will be run from this directory.


File: python.info,  Node: Writing the Setup Script,  Next: Writing the Setup Configuration File,  Prev: An Introduction to Distutils,  Up: Distributing Python Modules Legacy version

17.2 Writing the Setup Script
=============================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

The setup script is the centre of all activity in building,
distributing, and installing modules using the Distutils.  The main
purpose of the setup script is to describe your module distribution to
the Distutils, so that the various commands that operate on your modules
do the right thing.  As we saw in section *note A Simple Example: 42a7.
above, the setup script consists mainly of a call to ‘setup()’, and most
information supplied to the Distutils by the module developer is
supplied as keyword arguments to ‘setup()’.

Here’s a slightly more involved example, which we’ll follow for the next
couple of sections: the Distutils’ own setup script.  (Keep in mind that
although the Distutils are included with Python 1.6 and later, they also
have an independent existence so that Python 1.5.2 users can use them to
install other module distributions.  The Distutils’ own setup script,
shown here, is used to install the package into Python 1.5.2.)

     #!/usr/bin/env python  from distutils.core import setup  setup(name='Distutils',       version='1.0',       description='Python Distribution Utilities',       author='Greg Ward',       author_email='gward@python.net',       url='https://www.python.org/sigs/distutils-sig/',       packages=['distutils', 'distutils.command'],      )

There are only two differences between this and the trivial one-file
distribution presented in section *note A Simple Example: 42a7.: more
metadata, and the specification of pure Python modules by package,
rather than by module.  This is important since the Distutils consist of
a couple of dozen modules split into (so far) two packages; an explicit
list of every module would be tedious to generate and difficult to
maintain.  For more information on the additional meta-data, see section
*note Additional meta-data: 42af.

Note that any pathnames (files or directories) supplied in the setup
script should be written using the Unix convention, i.e.
slash-separated.  The Distutils will take care of converting this
platform-neutral representation into whatever is appropriate on your
current platform before actually using the pathname.  This makes your
setup script portable across operating systems, which of course is one
of the major goals of the Distutils.  In this spirit, all pathnames in
this document are slash-separated.

This, of course, only applies to pathnames given to Distutils functions.
If you, for example, use standard Python functions such as *note
glob.glob(): 5bb. or *note os.listdir(): a36. to specify files, you
should be careful to write portable code instead of hardcoding path
separators:

     glob.glob(os.path.join('mydir', 'subdir', '*.html')) os.listdir(os.path.join('mydir', 'subdir'))

* Menu:

* Listing whole packages::
* Listing individual modules::
* Describing extension modules::
* Relationships between Distributions and Packages::
* Installing Scripts::
* Installing Package Data::
* Installing Additional Files::
* Additional meta-data::
* Debugging the setup script::


File: python.info,  Node: Listing whole packages,  Next: Listing individual modules,  Up: Writing the Setup Script

17.2.1 Listing whole packages
-----------------------------

The ‘packages’ option tells the Distutils to process (build, distribute,
install, etc.)  all pure Python modules found in each package mentioned
in the ‘packages’ list.  In order to do this, of course, there has to be
a correspondence between package names and directories in the
filesystem.  The default correspondence is the most obvious one, i.e.
package *note distutils: 39. is found in the directory ‘distutils’
relative to the distribution root.  Thus, when you say ‘packages =
['foo']’ in your setup script, you are promising that the Distutils will
find a file ‘foo/__init__.py’ (which might be spelled differently on
your system, but you get the idea) relative to the directory where your
setup script lives.  If you break this promise, the Distutils will issue
a warning but still process the broken package anyway.

If you use a different convention to lay out your source directory,
that’s no problem: you just have to supply the ‘package_dir’ option to
tell the Distutils about your convention.  For example, say you keep all
Python source under ‘lib’, so that modules in the “root package” (i.e.,
not in any package at all) are in ‘lib’, modules in the ‘foo’ package
are in ‘lib/foo’, and so forth.  Then you would put

     package_dir = {'': 'lib'}

in your setup script.  The keys to this dictionary are package names,
and an empty package name stands for the root package.  The values are
directory names relative to your distribution root.  In this case, when
you say ‘packages = ['foo']’, you are promising that the file
‘lib/foo/__init__.py’ exists.

Another possible convention is to put the ‘foo’ package right in ‘lib’,
the ‘foo.bar’ package in ‘lib/bar’, etc.  This would be written in the
setup script as

     package_dir = {'foo': 'lib'}

A ‘package: dir’ entry in the ‘package_dir’ dictionary implicitly
applies to all packages below `package', so the ‘foo.bar’ case is
automatically handled here.  In this example, having ‘packages = ['foo',
'foo.bar']’ tells the Distutils to look for ‘lib/__init__.py’ and
‘lib/bar/__init__.py’.  (Keep in mind that although ‘package_dir’
applies recursively, you must explicitly list all packages in
‘packages’: the Distutils will `not' recursively scan your source tree
looking for any directory with an ‘__init__.py’ file.)


File: python.info,  Node: Listing individual modules,  Next: Describing extension modules,  Prev: Listing whole packages,  Up: Writing the Setup Script

17.2.2 Listing individual modules
---------------------------------

For a small module distribution, you might prefer to list all modules
rather than listing packages—especially the case of a single module that
goes in the “root package” (i.e., no package at all).  This simplest
case was shown in section *note A Simple Example: 42a7.; here is a
slightly more involved example:

     py_modules = ['mod1', 'pkg.mod2']

This describes two modules, one of them in the “root” package, the other
in the ‘pkg’ package.  Again, the default package/directory layout
implies that these two modules can be found in ‘mod1.py’ and
‘pkg/mod2.py’, and that ‘pkg/__init__.py’ exists as well.  And again,
you can override the package/directory correspondence using the
‘package_dir’ option.


File: python.info,  Node: Describing extension modules,  Next: Relationships between Distributions and Packages,  Prev: Listing individual modules,  Up: Writing the Setup Script

17.2.3 Describing extension modules
-----------------------------------

Just as writing Python extension modules is a bit more complicated than
writing pure Python modules, describing them to the Distutils is a bit
more complicated.  Unlike pure modules, it’s not enough just to list
modules or packages and expect the Distutils to go out and find the
right files; you have to specify the extension name, source file(s), and
any compile/link requirements (include directories, libraries to link
with, etc.).

All of this is done through another keyword argument to ‘setup()’, the
‘ext_modules’ option.  ‘ext_modules’ is just a list of *note Extension:
42b6. instances, each of which describes a single extension module.
Suppose your distribution includes a single extension, called ‘foo’ and
implemented by ‘foo.c’.  If no additional instructions to the
compiler/linker are needed, describing this extension is quite simple:

     Extension('foo', ['foo.c'])

The ‘Extension’ class can be imported from *note distutils.core: 54.
along with ‘setup()’.  Thus, the setup script for a module distribution
that contains only this one extension and nothing else might be:

     from distutils.core import setup, Extension setup(name='foo',       version='1.0',       ext_modules=[Extension('foo', ['foo.c'])],       )

The ‘Extension’ class (actually, the underlying extension-building
machinery implemented by the ‘build_ext’ command) supports a great deal
of flexibility in describing Python extensions, which is explained in
the following sections.

* Menu:

* Extension names and packages::
* Extension source files::
* Preprocessor options::
* Library options::
* Other options::


File: python.info,  Node: Extension names and packages,  Next: Extension source files,  Up: Describing extension modules

17.2.3.1 Extension names and packages
.....................................

The first argument to the *note Extension: 42b6. constructor is always
the name of the extension, including any package names.  For example,

     Extension('foo', ['src/foo1.c', 'src/foo2.c'])

describes an extension that lives in the root package, while

     Extension('pkg.foo', ['src/foo1.c', 'src/foo2.c'])

describes the same extension in the ‘pkg’ package.  The source files and
resulting object code are identical in both cases; the only difference
is where in the filesystem (and therefore where in Python’s namespace
hierarchy) the resulting extension lives.

If you have a number of extensions all in the same package (or all under
the same base package), use the ‘ext_package’ keyword argument to
‘setup()’.  For example,

     setup(...,       ext_package='pkg',       ext_modules=[Extension('foo', ['foo.c']),                    Extension('subpkg.bar', ['bar.c'])],      )

will compile ‘foo.c’ to the extension ‘pkg.foo’, and ‘bar.c’ to
‘pkg.subpkg.bar’.


File: python.info,  Node: Extension source files,  Next: Preprocessor options,  Prev: Extension names and packages,  Up: Describing extension modules

17.2.3.2 Extension source files
...............................

The second argument to the *note Extension: 42b6. constructor is a list
of source files.  Since the Distutils currently only support C, C++, and
Objective-C extensions, these are normally C/C++/Objective-C source
files.  (Be sure to use appropriate extensions to distinguish C++ source
files: ‘.cc’ and ‘.cpp’ seem to be recognized by both Unix and Windows
compilers.)

However, you can also include SWIG interface (‘.i’) files in the list;
the ‘build_ext’ command knows how to deal with SWIG extensions: it will
run SWIG on the interface file and compile the resulting C/C++ file into
your extension.

This warning notwithstanding, options to SWIG can be currently passed
like this:

     setup(...,       ext_modules=[Extension('_foo', ['foo.i'],                              swig_opts=['-modern', '-I../include'])],       py_modules=['foo'],      )

Or on the commandline like this:

     > python setup.py build_ext --swig-opts="-modern -I../include"

On some platforms, you can include non-source files that are processed
by the compiler and included in your extension.  Currently, this just
means Windows message text (‘.mc’) files and resource definition (‘.rc’)
files for Visual C++.  These will be compiled to binary resource
(‘.res’) files and linked into the executable.


File: python.info,  Node: Preprocessor options,  Next: Library options,  Prev: Extension source files,  Up: Describing extension modules

17.2.3.3 Preprocessor options
.............................

Three optional arguments to *note Extension: 42b6. will help if you need
to specify include directories to search or preprocessor macros to
define/undefine: ‘include_dirs’, ‘define_macros’, and ‘undef_macros’.

For example, if your extension requires header files in the ‘include’
directory under your distribution root, use the ‘include_dirs’ option:

     Extension('foo', ['foo.c'], include_dirs=['include'])

You can specify absolute directories there; if you know that your
extension will only be built on Unix systems with X11R6 installed to
‘/usr’, you can get away with

     Extension('foo', ['foo.c'], include_dirs=['/usr/include/X11'])

You should avoid this sort of non-portable usage if you plan to
distribute your code: it’s probably better to write C code like

     #include <X11/Xlib.h>

If you need to include header files from some other Python extension,
you can take advantage of the fact that header files are installed in a
consistent way by the Distutils ‘install_headers’ command.  For example,
the Numerical Python header files are installed (on a standard Unix
installation) to ‘/usr/local/include/python1.5/Numerical’.  (The exact
location will differ according to your platform and Python
installation.)  Since the Python include
directory—‘/usr/local/include/python1.5’ in this case—is always included
in the search path when building Python extensions, the best approach is
to write C code like

     #include <Numerical/arrayobject.h>

If you must put the ‘Numerical’ include directory right into your header
search path, though, you can find that directory using the Distutils
*note distutils.sysconfig: 62. module:

     from distutils.sysconfig import get_python_inc incdir = os.path.join(get_python_inc(plat_specific=1), 'Numerical') setup(...,       Extension(..., include_dirs=[incdir]),       )

Even though this is quite portable—it will work on any Python
installation, regardless of platform—it’s probably easier to just write
your C code in the sensible way.

You can define and undefine pre-processor macros with the
‘define_macros’ and ‘undef_macros’ options.  ‘define_macros’ takes a
list of ‘(name, value)’ tuples, where ‘name’ is the name of the macro to
define (a string) and ‘value’ is its value: either a string or ‘None’.
(Defining a macro ‘FOO’ to ‘None’ is the equivalent of a bare ‘#define
FOO’ in your C source: with most compilers, this sets ‘FOO’ to the
string ‘1’.)  ‘undef_macros’ is just a list of macros to undefine.

For example:

     Extension(...,           define_macros=[('NDEBUG', '1'),                          ('HAVE_STRFTIME', None)],           undef_macros=['HAVE_FOO', 'HAVE_BAR'])

is the equivalent of having this at the top of every C source file:

     #define NDEBUG 1 #define HAVE_STRFTIME #undef HAVE_FOO #undef HAVE_BAR


File: python.info,  Node: Library options,  Next: Other options,  Prev: Preprocessor options,  Up: Describing extension modules

17.2.3.4 Library options
........................

You can also specify the libraries to link against when building your
extension, and the directories to search for those libraries.  The
‘libraries’ option is a list of libraries to link against,
‘library_dirs’ is a list of directories to search for libraries at
link-time, and ‘runtime_library_dirs’ is a list of directories to search
for shared (dynamically loaded) libraries at run-time.

For example, if you need to link against libraries known to be in the
standard library search path on target systems

     Extension(...,           libraries=['gdbm', 'readline'])

If you need to link with libraries in a non-standard location, you’ll
have to include the location in ‘library_dirs’:

     Extension(...,           library_dirs=['/usr/X11R6/lib'],           libraries=['X11', 'Xt'])

(Again, this sort of non-portable construct should be avoided if you
intend to distribute your code.)


File: python.info,  Node: Other options,  Prev: Library options,  Up: Describing extension modules

17.2.3.5 Other options
......................

There are still some other options which can be used to handle special
cases.

The ‘optional’ option is a boolean; if it is true, a build failure in
the extension will not abort the build process, but instead simply not
install the failing extension.

The ‘extra_objects’ option is a list of object files to be passed to the
linker.  These files must not have extensions, as the default extension
for the compiler is used.

‘extra_compile_args’ and ‘extra_link_args’ can be used to specify
additional command line options for the respective compiler and linker
command lines.

‘export_symbols’ is only useful on Windows.  It can contain a list of
symbols (functions or variables) to be exported.  This option is not
needed when building compiled extensions: Distutils will automatically
add ‘initmodule’ to the list of exported symbols.

The ‘depends’ option is a list of files that the extension depends on
(for example header files).  The build command will call the compiler on
the sources to rebuild extension if any on this files has been modified
since the previous build.


File: python.info,  Node: Relationships between Distributions and Packages,  Next: Installing Scripts,  Prev: Describing extension modules,  Up: Writing the Setup Script

17.2.4 Relationships between Distributions and Packages
-------------------------------------------------------

A distribution may relate to packages in three specific ways:

  1. It can require packages or modules.

  2. It can provide packages or modules.

  3. It can obsolete packages or modules.

These relationships can be specified using keyword arguments to the
*note distutils.core.setup(): 3abc. function.

Dependencies on other Python modules and packages can be specified by
supplying the `requires' keyword argument to ‘setup()’.  The value must
be a list of strings.  Each string specifies a package that is required,
and optionally what versions are sufficient.

To specify that any version of a module or package is required, the
string should consist entirely of the module or package name.  Examples
include ‘'mymodule'’ and ‘'xml.parsers.expat'’.

If specific versions are required, a sequence of qualifiers can be
supplied in parentheses.  Each qualifier may consist of a comparison
operator and a version number.  The accepted comparison operators are:

     <    >    == <=   >=   !=

These can be combined by using multiple qualifiers separated by commas
(and optional whitespace).  In this case, all of the qualifiers must be
matched; a logical AND is used to combine the evaluations.

Let’s look at a bunch of examples:

Requires Expression           Explanation
                              
---------------------------------------------------------------------------------
                              
‘==1.0’                       Only version ‘1.0’ is compatible
                              
                              
‘>1.0, !=1.5.1, <2.0’         Any version after ‘1.0’ and before ‘2.0’ is
                              compatible, except ‘1.5.1’
                              

Now that we can specify dependencies, we also need to be able to specify
what we provide that other distributions can require.  This is done
using the `provides' keyword argument to ‘setup()’.  The value for this
keyword is a list of strings, each of which names a Python module or
package, and optionally identifies the version.  If the version is not
specified, it is assumed to match that of the distribution.

Some examples:

Provides Expression       Explanation
                          
-----------------------------------------------------------------------------
                          
‘mypkg’                   Provide ‘mypkg’, using the distribution version
                          
                          
‘mypkg (1.1)’             Provide ‘mypkg’ version 1.1, regardless of the
                          distribution version
                          

A package can declare that it obsoletes other packages using the
`obsoletes' keyword argument.  The value for this is similar to that of
the `requires' keyword: a list of strings giving module or package
specifiers.  Each specifier consists of a module or package name
optionally followed by one or more version qualifiers.  Version
qualifiers are given in parentheses after the module or package name.

The versions identified by the qualifiers are those that are obsoleted
by the distribution being described.  If no qualifiers are given, all
versions of the named module or package are understood to be obsoleted.


File: python.info,  Node: Installing Scripts,  Next: Installing Package Data,  Prev: Relationships between Distributions and Packages,  Up: Writing the Setup Script

17.2.5 Installing Scripts
-------------------------

So far we have been dealing with pure and non-pure Python modules, which
are usually not run by themselves but imported by scripts.

Scripts are files containing Python source code, intended to be started
from the command line.  Scripts don’t require Distutils to do anything
very complicated.  The only clever feature is that if the first line of
the script starts with ‘#!’ and contains the word “python”, the
Distutils will adjust the first line to refer to the current interpreter
location.  By default, it is replaced with the current interpreter
location.  The ‘--executable’ (or ‘-e’) option will allow the
interpreter path to be explicitly overridden.

The ‘scripts’ option simply is a list of files to be handled in this
way.  From the PyXML setup script:

     setup(...,       scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val']       )

Changed in version 3.1: All the scripts will also be added to the
‘MANIFEST’ file if no template is provided.  See *note Specifying the
files to distribute: 3abf.


File: python.info,  Node: Installing Package Data,  Next: Installing Additional Files,  Prev: Installing Scripts,  Up: Writing the Setup Script

17.2.6 Installing Package Data
------------------------------

Often, additional files need to be installed into a package.  These
files are often data that’s closely related to the package’s
implementation, or text files containing documentation that might be of
interest to programmers using the package.  These files are called
`package data'.

Package data can be added to packages using the ‘package_data’ keyword
argument to the ‘setup()’ function.  The value must be a mapping from
package name to a list of relative path names that should be copied into
the package.  The paths are interpreted as relative to the directory
containing the package (information from the ‘package_dir’ mapping is
used if appropriate); that is, the files are expected to be part of the
package in the source directories.  They may contain glob patterns as
well.

The path names may contain directory portions; any necessary directories
will be created in the installation.

For example, if a package should contain a subdirectory with several
data files, the files can be arranged like this in the source tree:

     setup.py src/     mypkg/         __init__.py         module.py         data/             tables.dat             spoons.dat             forks.dat

The corresponding call to ‘setup()’ might be:

     setup(...,       packages=['mypkg'],       package_dir={'mypkg': 'src/mypkg'},       package_data={'mypkg': ['data/*.dat']},       )

Changed in version 3.1: All the files that match ‘package_data’ will be
added to the ‘MANIFEST’ file if no template is provided.  See *note
Specifying the files to distribute: 3abf.


File: python.info,  Node: Installing Additional Files,  Next: Additional meta-data,  Prev: Installing Package Data,  Up: Writing the Setup Script

17.2.7 Installing Additional Files
----------------------------------

The ‘data_files’ option can be used to specify additional files needed
by the module distribution: configuration files, message catalogs, data
files, anything which doesn’t fit in the previous categories.

‘data_files’ specifies a sequence of (`directory', `files') pairs in the
following way:

     setup(...,       data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),                   ('config', ['cfg/data.cfg'])],      )

Each (`directory', `files') pair in the sequence specifies the
installation directory and the files to install there.

Each file name in `files' is interpreted relative to the ‘setup.py’
script at the top of the package source distribution.  Note that you can
specify the directory where the data files will be installed, but you
cannot rename the data files themselves.

The `directory' should be a relative path.  It is interpreted relative
to the installation prefix (Python’s ‘sys.prefix’ for system
installations; ‘site.USER_BASE’ for user installations).  Distutils
allows `directory' to be an absolute installation path, but this is
discouraged since it is incompatible with the wheel packaging format.
No directory information from `files' is used to determine the final
location of the installed file; only the name of the file is used.

You can specify the ‘data_files’ options as a simple sequence of files
without specifying a target directory, but this is not recommended, and
the ‘install’ command will print a warning in this case.  To install
data files directly in the target directory, an empty string should be
given as the directory.

Changed in version 3.1: All the files that match ‘data_files’ will be
added to the ‘MANIFEST’ file if no template is provided.  See *note
Specifying the files to distribute: 3abf.


File: python.info,  Node: Additional meta-data,  Next: Debugging the setup script,  Prev: Installing Additional Files,  Up: Writing the Setup Script

17.2.8 Additional meta-data
---------------------------

The setup script may include additional meta-data beyond the name and
version.  This information includes:

Meta-Data                  Description                     Value                 Notes
                                                                                 
----------------------------------------------------------------------------------------------
                                                                                 
‘name’                     name of the package             short string          (1)
                                                                                 
                                                                                 
‘version’                  version of this release         short string          (1)(2)
                                                                                 
                                                                                 
‘author’                   package author’s name           short string          (3)
                                                                                 
                                                                                 
‘author_email’             email address of the package    email address         (3)
                           author                                                
                           
                                                                                 
‘maintainer’               package maintainer’s name       short string          (3)
                                                                                 
                                                                                 
‘maintainer_email’         email address of the package    email address         (3)
                           maintainer                                            
                           
                                                                                 
‘url’                      home page for the package       URL                   (1)
                                                                                 
                                                                                 
‘description’              short, summary description of   short string
                           the package                     
                           
                                                                                 
‘long_description’         longer description of the       long string           (4)
                           package                                               
                           
                                                                                 
‘download_url’             location where the package      URL
                           may be downloaded               
                           
                                                                                 
‘classifiers’              a list of classifiers           list of strings       (6)(7)
                                                                                 
                                                                                 
‘platforms’                a list of platforms             list of strings       (6)(8)
                                                                                 
                                                                                 
‘keywords’                 a list of keywords              list of strings       (6)(8)
                                                                                 
                                                                                 
‘license’                  license for the package         short string          (5)
                                                                                 

Notes:

  1. These fields are required.

  2. It is recommended that versions take the form
     `major.minor[.patch[.sub]]'.

  3. Either the author or the maintainer must be identified.  If
     maintainer is provided, distutils lists it as the author in
     ‘PKG-INFO’.

  4. The ‘long_description’ field is used by PyPI when you publish a
     package, to build its project page.

  5. The ‘license’ field is a text indicating the license covering the
     package where the license is not a selection from the “License”
     Trove classifiers.  See the ‘Classifier’ field.  Notice that
     there’s a ‘licence’ distribution option which is deprecated but
     still acts as an alias for ‘license’.

  6. This field must be a list.

  7. The valid classifiers are listed on PyPI(1).

  8. To preserve backward compatibility, this field also accepts a
     string.  If you pass a comma-separated string ‘'foo, bar'’, it will
     be converted to ‘['foo', 'bar']’, Otherwise, it will be converted
     to a list of one string.

‘short string’

     A single line of text, not more than 200 characters.

‘long string’

     Multiple lines of plain text in reStructuredText format (see
     ‘http://docutils.sourceforge.net/’).

‘list of strings’

     See below.

Encoding the version information is an art in itself.  Python packages
generally adhere to the version format `major.minor[.patch][sub]'.  The
major number is 0 for initial, experimental releases of software.  It is
incremented for releases that represent major milestones in a package.
The minor number is incremented when important new features are added to
the package.  The patch number increments when bug-fix releases are
made.  Additional trailing version information is sometimes used to
indicate sub-releases.  These are “a1,a2,…,aN” (for alpha releases,
where functionality and API may change), “b1,b2,…,bN” (for beta
releases, which only fix bugs) and “pr1,pr2,…,prN” (for final
pre-release release testing).  Some examples:

0.1.0

     the first, experimental release of a package

1.0.1a2

     the second alpha release of the first patch version of 1.0

‘classifiers’ must be specified in a list:

     setup(...,       classifiers=[           'Development Status :: 4 - Beta',           'Environment :: Console',           'Environment :: Web Environment',           'Intended Audience :: End Users/Desktop',           'Intended Audience :: Developers',           'Intended Audience :: System Administrators',           'License :: OSI Approved :: Python Software Foundation License',           'Operating System :: MacOS :: MacOS X',           'Operating System :: Microsoft :: Windows',           'Operating System :: POSIX',           'Programming Language :: Python',           'Topic :: Communications :: Email',           'Topic :: Office/Business',           'Topic :: Software Development :: Bug Tracking',           ],       )

Changed in version 3.7: *note setup: 3abc. now warns when ‘classifiers’,
‘keywords’ or ‘platforms’ fields are not specified as a list or a
string.

   ---------- Footnotes ----------

   (1) https://pypi.org/classifiers


File: python.info,  Node: Debugging the setup script,  Prev: Additional meta-data,  Up: Writing the Setup Script

17.2.9 Debugging the setup script
---------------------------------

Sometimes things go wrong, and the setup script doesn’t do what the
developer wants.

Distutils catches any exceptions when running the setup script, and
print a simple error message before the script is terminated.  The
motivation for this behaviour is to not confuse administrators who don’t
know much about Python and are trying to install a package.  If they get
a big long traceback from deep inside the guts of Distutils, they may
think the package or the Python installation is broken because they
don’t read all the way down to the bottom and see that it’s a permission
problem.

On the other hand, this doesn’t help the developer to find the cause of
the failure.  For this purpose, the ‘DISTUTILS_DEBUG’ environment
variable can be set to anything except an empty string, and distutils
will now print detailed information about what it is doing, dump the
full traceback when an exception occurs, and print the whole command
line when an external program (like a C compiler) fails.


File: python.info,  Node: Writing the Setup Configuration File,  Next: Creating a Source Distribution,  Prev: Writing the Setup Script,  Up: Distributing Python Modules Legacy version

17.3 Writing the Setup Configuration File
=========================================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

Often, it’s not possible to write down everything needed to build a
distribution `a priori': you may need to get some information from the
user, or from the user’s system, in order to proceed.  As long as that
information is fairly simple—a list of directories to search for C
header files or libraries, for example—then providing a configuration
file, ‘setup.cfg’, for users to edit is a cheap and easy way to solicit
it.  Configuration files also let you provide default values for any
command option, which the installer can then override either on the
command-line or by editing the config file.

The setup configuration file is a useful middle-ground between the setup
script—which, ideally, would be opaque to installers (1)—and the
command-line to the setup script, which is outside of your control and
entirely up to the installer.  In fact, ‘setup.cfg’ (and any other
Distutils configuration files present on the target system) are
processed after the contents of the setup script, but before the
command-line.  This has several useful consequences:

   * installers can override some of what you put in ‘setup.py’ by
     editing ‘setup.cfg’

   * you can provide non-standard defaults for options that are not
     easily set in ‘setup.py’

   * installers can override anything in ‘setup.cfg’ using the
     command-line options to ‘setup.py’

The basic syntax of the configuration file is simple:

     [command] option=value ...

where `command' is one of the Distutils commands (e.g.  ‘build_py’,
‘install’), and `option' is one of the options that command supports.
Any number of options can be supplied for each command, and any number
of command sections can be included in the file.  Blank lines are
ignored, as are comments, which run from a ‘'#'’ character until the end
of the line.  Long option values can be split across multiple lines
simply by indenting the continuation lines.

You can find out the list of options supported by a particular command
with the universal ‘--help’ option, e.g.

     $ python setup.py --help build_ext [...] Options for 'build_ext' command:   --build-lib (-b)     directory for compiled extension modules   --build-temp (-t)    directory for temporary files (build by-products)   --inplace (-i)       ignore build-lib and put compiled extensions into the                        source directory alongside your pure Python modules   --include-dirs (-I)  list of directories to search for header files   --define (-D)        C preprocessor macros to define   --undef (-U)         C preprocessor macros to undefine   --swig-opts          list of SWIG command line options [...]

Note that an option spelled ‘--foo-bar’ on the command-line is spelled
‘foo_bar’ in configuration files.  For example, say you want your
extensions to be built “in-place”—that is, you have an extension
‘pkg.ext’, and you want the compiled extension file (‘ext.so’ on Unix,
say) to be put in the same source directory as your pure Python modules
‘pkg.mod1’ and ‘pkg.mod2’.  You can always use the ‘--inplace’ option on
the command-line to ensure this:

     python setup.py build_ext --inplace

But this requires that you always specify the ‘build_ext’ command
explicitly, and remember to provide ‘--inplace’.  An easier way is to
“set and forget” this option, by encoding it in ‘setup.cfg’, the
configuration file for this distribution:

     [build_ext] inplace=1

This will affect all builds of this module distribution, whether or not
you explicitly specify ‘build_ext’.  If you include ‘setup.cfg’ in your
source distribution, it will also affect end-user builds—which is
probably a bad idea for this option, since always building extensions
in-place would break installation of the module distribution.  In
certain peculiar cases, though, modules are built right in their
installation directory, so this is conceivably a useful ability.
(Distributing extensions that expect to be built in their installation
directory is almost always a bad idea, though.)

Another example: certain commands take a lot of options that don’t
change from run to run; for example, ‘bdist_rpm’ needs to know
everything required to generate a “spec” file for creating an RPM
distribution.  Some of this information comes from the setup script, and
some is automatically generated by the Distutils (such as the list of
files installed).  But some of it has to be supplied as options to
‘bdist_rpm’, which would be very tedious to do on the command-line for
every run.  Hence, here is a snippet from the Distutils’ own
‘setup.cfg’:

     [bdist_rpm] release = 1 packager = Greg Ward <gward@python.net> doc_files = CHANGES.txt             README.txt             USAGE.txt             doc/             examples/

Note that the ‘doc_files’ option is simply a whitespace-separated string
split across multiple lines for readability.

See also
........

*note Syntax of config files: 42ca. in “Installing Python Modules”

     More information on the configuration files is available in the
     manual for system administrators.

   ---------- Footnotes ----------

   (1) (1) This ideal probably won’t be achieved until
auto-configuration is fully supported by the Distutils.


File: python.info,  Node: Creating a Source Distribution,  Next: Creating Built Distributions,  Prev: Writing the Setup Configuration File,  Up: Distributing Python Modules Legacy version

17.4 Creating a Source Distribution
===================================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

As shown in section *note A Simple Example: 42a7, you use the ‘sdist’
command to create a source distribution.  In the simplest case,

     python setup.py sdist

(assuming you haven’t specified any ‘sdist’ options in the setup script
or config file), ‘sdist’ creates the archive of the default format for
the current platform.  The default format is a gzip’ed tar file
(‘.tar.gz’) on Unix, and ZIP file on Windows.

You can specify as many formats as you like using the ‘--formats’
option, for example:

     python setup.py sdist --formats=gztar,zip

to create a gzipped tarball and a zip file.  The available formats are:

Format          Description                   Notes
                                              
------------------------------------------------------------
                                              
‘zip’           zip file (‘.zip’)             (1),(3)
                                              
                                              
‘gztar’         gzip’ed tar file              (2)
                (‘.tar.gz’)                   
                
                                              
‘bztar’         bzip2’ed tar file
                (‘.tar.bz2’)
                
                                              
‘xztar’         xz’ed tar file (‘.tar.xz’)
                
                                              
‘ztar’          compressed tar file           (4)
                (‘.tar.Z’)                    
                
                                              
‘tar’           tar file (‘.tar’)
                

Changed in version 3.5: Added support for the ‘xztar’ format.

Notes:

  1. default on Windows

  2. default on Unix

  3. requires either external ‘zip’ utility or *note zipfile: 142.
     module (part of the standard Python library since Python 1.6)

  4. requires the ‘compress’ program.  Notice that this format is now
     pending for deprecation and will be removed in the future versions
     of Python.

When using any ‘tar’ format (‘gztar’, ‘bztar’, ‘xztar’, ‘ztar’ or
‘tar’), under Unix you can specify the ‘owner’ and ‘group’ names that
will be set for each member of the archive.

For example, if you want all files of the archive to be owned by root:

     python setup.py sdist --owner=root --group=root

* Menu:

* Specifying the files to distribute::
* Manifest-related options::


File: python.info,  Node: Specifying the files to distribute,  Next: Manifest-related options,  Up: Creating a Source Distribution

17.4.1 Specifying the files to distribute
-----------------------------------------

If you don’t supply an explicit list of files (or instructions on how to
generate one), the ‘sdist’ command puts a minimal default set into the
source distribution:

   * all Python source files implied by the ‘py_modules’ and ‘packages’
     options

   * all C source files mentioned in the ‘ext_modules’ or ‘libraries’
     options

   * scripts identified by the ‘scripts’ option See *note Installing
     Scripts: 42bd.

   * anything that looks like a test script: ‘test/test*.py’ (currently,
     the Distutils don’t do anything with test scripts except include
     them in source distributions, but in the future there will be a
     standard for testing Python module distributions)

   * Any of the standard README files (‘README’, ‘README.txt’, or
     ‘README.rst’), ‘setup.py’ (or whatever you called your setup
     script), and ‘setup.cfg’.

   * all files that matches the ‘package_data’ metadata.  See *note
     Installing Package Data: 42bf.

   * all files that matches the ‘data_files’ metadata.  See *note
     Installing Additional Files: 42c1.

Sometimes this is enough, but usually you will want to specify
additional files to distribute.  The typical way to do this is to write
a `manifest template', called ‘MANIFEST.in’ by default.  The manifest
template is just a list of instructions for how to generate your
manifest file, ‘MANIFEST’, which is the exact list of files to include
in your source distribution.  The ‘sdist’ command processes this
template and generates a manifest based on its instructions and what it
finds in the filesystem.

If you prefer to roll your own manifest file, the format is simple: one
filename per line, regular files (or symlinks to them) only.  If you do
supply your own ‘MANIFEST’, you must specify everything: the default set
of files described above does not apply in this case.

Changed in version 3.1: An existing generated ‘MANIFEST’ will be
regenerated without ‘sdist’ comparing its modification time to the one
of ‘MANIFEST.in’ or ‘setup.py’.

Changed in version 3.1.3: ‘MANIFEST’ files start with a comment
indicating they are generated.  Files without this comment are not
overwritten or removed.

Changed in version 3.2.2: ‘sdist’ will read a ‘MANIFEST’ file if no
‘MANIFEST.in’ exists, like it used to do.

Changed in version 3.7: ‘README.rst’ is now included in the list of
distutils standard READMEs.

The manifest template has one command per line, where each command
specifies a set of files to include or exclude from the source
distribution.  For an example, again we turn to the Distutils’ own
manifest template:

     include *.txt recursive-include examples *.txt *.py prune examples/sample?/build

The meanings should be fairly clear: include all files in the
distribution root matching ‘*.txt’, all files anywhere under the
‘examples’ directory matching ‘*.txt’ or ‘*.py’, and exclude all
directories matching ‘examples/sample?/build’.  All of this is done
`after' the standard include set, so you can exclude files from the
standard set with explicit instructions in the manifest template.  (Or,
you can use the ‘--no-defaults’ option to disable the standard set
entirely.)  There are several other commands available in the manifest
template mini-language; see section *note Creating a source
distribution; the sdist command: 42cf.

The order of commands in the manifest template matters: initially, we
have the list of default files as described above, and each command in
the template adds to or removes from that list of files.  Once we have
fully processed the manifest template, we remove files that should not
be included in the source distribution:

   * all files in the Distutils “build” tree (default ‘build/’)

   * all files in directories named ‘RCS’, ‘CVS’, ‘.svn’, ‘.hg’, ‘.git’,
     ‘.bzr’ or ‘_darcs’

Now we have our complete list of files, which is written to the manifest
for future reference, and then used to build the source distribution
archive(s).

You can disable the default set of included files with the
‘--no-defaults’ option, and you can disable the standard exclude set
with ‘--no-prune’.

Following the Distutils’ own manifest template, let’s trace how the
‘sdist’ command builds the list of files to include in the Distutils
source distribution:

  1. include all Python source files in the ‘distutils’ and
     ‘distutils/command’ subdirectories (because packages corresponding
     to those two directories were mentioned in the ‘packages’ option in
     the setup script—see section *note Writing the Setup Script: 42a8.)

  2. include ‘README.txt’, ‘setup.py’, and ‘setup.cfg’ (standard files)

  3. include ‘test/test*.py’ (standard files)

  4. include ‘*.txt’ in the distribution root (this will find
     ‘README.txt’ a second time, but such redundancies are weeded out
     later)

  5. include anything matching ‘*.txt’ or ‘*.py’ in the sub-tree under
     ‘examples’,

  6. exclude all files in the sub-trees starting at directories matching
     ‘examples/sample?/build’—this may exclude files included by the
     previous two steps, so it’s important that the ‘prune’ command in
     the manifest template comes after the ‘recursive-include’ command

  7. exclude the entire ‘build’ tree, and any ‘RCS’, ‘CVS’, ‘.svn’,
     ‘.hg’, ‘.git’, ‘.bzr’ and ‘_darcs’ directories

Just like in the setup script, file and directory names in the manifest
template should always be slash-separated; the Distutils will take care
of converting them to the standard representation on your platform.
That way, the manifest template is portable across operating systems.


File: python.info,  Node: Manifest-related options,  Prev: Specifying the files to distribute,  Up: Creating a Source Distribution

17.4.2 Manifest-related options
-------------------------------

The normal course of operations for the ‘sdist’ command is as follows:

   * if the manifest file (‘MANIFEST’ by default) exists and the first
     line does not have a comment indicating it is generated from
     ‘MANIFEST.in’, then it is used as is, unaltered

   * if the manifest file doesn’t exist or has been previously
     automatically generated, read ‘MANIFEST.in’ and create the manifest

   * if neither ‘MANIFEST’ nor ‘MANIFEST.in’ exist, create a manifest
     with just the default file set

   * use the list of files now in ‘MANIFEST’ (either just generated or
     read in) to create the source distribution archive(s)

There are a couple of options that modify this behaviour.  First, use
the ‘--no-defaults’ and ‘--no-prune’ to disable the standard “include”
and “exclude” sets.

Second, you might just want to (re)generate the manifest, but not create
a source distribution:

     python setup.py sdist --manifest-only

‘-o’ is a shortcut for ‘--manifest-only’.


File: python.info,  Node: Creating Built Distributions,  Next: Distutils Examples,  Prev: Creating a Source Distribution,  Up: Distributing Python Modules Legacy version

17.5 Creating Built Distributions
=================================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

A “built distribution” is what you’re probably used to thinking of
either as a “binary package” or an “installer” (depending on your
background).  It’s not necessarily binary, though, because it might
contain only Python source code and/or byte-code; and we don’t call it a
package, because that word is already spoken for in Python.  (And
“installer” is a term specific to the world of mainstream desktop
systems.)

A built distribution is how you make life as easy as possible for
installers of your module distribution: for users of RPM-based Linux
systems, it’s a binary RPM; for Windows users, it’s an executable
installer; for Debian-based Linux users, it’s a Debian package; and so
forth.  Obviously, no one person will be able to create built
distributions for every platform under the sun, so the Distutils are
designed to enable module developers to concentrate on their
specialty—writing code and creating source distributions—while an
intermediary species called `packagers' springs up to turn source
distributions into built distributions for as many platforms as there
are packagers.

Of course, the module developer could be their own packager; or the
packager could be a volunteer “out there” somewhere who has access to a
platform which the original developer does not; or it could be software
periodically grabbing new source distributions and turning them into
built distributions for as many platforms as the software has access to.
Regardless of who they are, a packager uses the setup script and the
‘bdist’ command family to generate built distributions.

As a simple example, if I run the following command in the Distutils
source tree:

     python setup.py bdist

then the Distutils builds my module distribution (the Distutils itself
in this case), does a “fake” installation (also in the ‘build’
directory), and creates the default type of built distribution for my
platform.  The default format for built distributions is a “dumb” tar
file on Unix, and a simple executable installer on Windows.  (That tar
file is considered “dumb” because it has to be unpacked in a specific
location to work.)

Thus, the above command on a Unix system creates
‘Distutils-1.0.`plat'.tar.gz’; unpacking this tarball from the right
place installs the Distutils just as though you had downloaded the
source distribution and run ‘python setup.py install’.  (The “right
place” is either the root of the filesystem or Python’s ‘`prefix'’
directory, depending on the options given to the ‘bdist_dumb’ command;
the default is to make dumb distributions relative to ‘`prefix'’.)

Obviously, for pure Python distributions, this isn’t any simpler than
just running ‘python setup.py install’—but for non-pure distributions,
which include extensions that would need to be compiled, it can mean the
difference between someone being able to use your extensions or not.
And creating “smart” built distributions, such as an RPM package or an
executable installer for Windows, is far more convenient for users even
if your distribution doesn’t include any extensions.

The ‘bdist’ command has a ‘--formats’ option, similar to the ‘sdist’
command, which you can use to select the types of built distribution to
generate: for example,

     python setup.py bdist --format=zip

would, when run on a Unix system, create
‘Distutils-1.0.`plat'.zip’—again, this archive would be unpacked from
the root directory to install the Distutils.

The available formats for built distributions are:

Format            Description                        Notes
                                                     
-------------------------------------------------------------------
                                                     
‘gztar’           gzipped tar file (‘.tar.gz’)       (1)
                                                     
                                                     
‘bztar’           bzipped tar file (‘.tar.bz2’)
                  
                                                     
‘xztar’           xzipped tar file (‘.tar.xz’)
                  
                                                     
‘ztar’            compressed tar file (‘.tar.Z’)     (3)
                                                     
                                                     
‘tar’             tar file (‘.tar’)
                  
                                                     
‘zip’             zip file (‘.zip’)                  (2),(4)
                                                     
                                                     
‘rpm’             RPM                                (5)
                                                     
                                                     
‘pkgtool’         Solaris ‘pkgtool’
                  
                                                     
‘sdux’            HP-UX ‘swinstall’
                  
                                                     
‘wininst’         self-extracting ZIP file for       (4)
                  Windows                            
                  
                                                     
‘msi’             Microsoft Installer.
                  

Changed in version 3.5: Added support for the ‘xztar’ format.

Notes:

  1. default on Unix

  2. default on Windows

  3. requires external ‘compress’ utility.

  4. requires either external ‘zip’ utility or *note zipfile: 142.
     module (part of the standard Python library since Python 1.6)

  5. requires external ‘rpm’ utility, version 3.0.4 or better (use ‘rpm
     --version’ to find out which version you have)

You don’t have to use the ‘bdist’ command with the ‘--formats’ option;
you can also use the command that directly implements the format you’re
interested in.  Some of these ‘bdist’ “sub-commands” actually generate
several similar formats; for instance, the ‘bdist_dumb’ command
generates all the “dumb” archive formats (‘tar’, ‘gztar’, ‘bztar’,
‘xztar’, ‘ztar’, and ‘zip’), and ‘bdist_rpm’ generates both binary and
source RPMs.  The ‘bdist’ sub-commands, and the formats generated by
each, are:

Command                        Formats
                               
-------------------------------------------------------------------------
                               
‘bdist_dumb’                   tar, gztar, bztar, xztar, ztar, zip
                               
                               
‘bdist_rpm’                    rpm, srpm
                               
                               
‘bdist_wininst’                wininst
                               
                               
‘bdist_msi’                    msi
                               

     Note: bdist_wininst is deprecated since Python 3.8.

The following sections give details on the individual ‘bdist_*’
commands.

* Menu:

* Creating RPM packages::
* Creating Windows Installers::
* Cross-compiling on Windows::
* Vista User Access Control (UAC): Vista User Access Control UAC.


File: python.info,  Node: Creating RPM packages,  Next: Creating Windows Installers,  Up: Creating Built Distributions

17.5.1 Creating RPM packages
----------------------------

The RPM format is used by many popular Linux distributions, including
Red Hat, SuSE, and Mandrake.  If one of these (or any of the other
RPM-based Linux distributions) is your usual environment, creating RPM
packages for other users of that same distribution is trivial.
Depending on the complexity of your module distribution and differences
between Linux distributions, you may also be able to create RPMs that
work on different RPM-based distributions.

The usual way to create an RPM of your module distribution is to run the
‘bdist_rpm’ command:

     python setup.py bdist_rpm

or the ‘bdist’ command with the ‘--format’ option:

     python setup.py bdist --formats=rpm

The former allows you to specify RPM-specific options; the latter allows
you to easily specify multiple formats in one run.  If you need to do
both, you can explicitly specify multiple ‘bdist_*’ commands and their
options:

     python setup.py bdist_rpm --packager="John Doe <jdoe@example.org>" \                 bdist_wininst --target-version="2.0"

Creating RPM packages is driven by a ‘.spec’ file, much as using the
Distutils is driven by the setup script.  To make your life easier, the
‘bdist_rpm’ command normally creates a ‘.spec’ file based on the
information you supply in the setup script, on the command line, and in
any Distutils configuration files.  Various options and sections in the
‘.spec’ file are derived from options in the setup script as follows:

RPM ‘.spec’ file option or section             Distutils setup script option
                                               
--------------------------------------------------------------------------------------------------
                                               
Name                                           ‘name’
                                               
                                               
Summary (in preamble)                          ‘description’
                                               
                                               
Version                                        ‘version’
                                               
                                               
Vendor                                         ‘author’ and ‘author_email’, or — & ‘maintainer’
                                               and ‘maintainer_email’
                                               
                                               
Copyright                                      ‘license’
                                               
                                               
Url                                            ‘url’
                                               
                                               
%description (section)                         ‘long_description’
                                               

Additionally, there are many options in ‘.spec’ files that don’t have
corresponding options in the setup script.  Most of these are handled
through options to the ‘bdist_rpm’ command as follows:

RPM ‘.spec’ file option or          ‘bdist_rpm’ option                default value
section                                                               

----------------------------------------------------------------------------------------------------
                                                                      
Release                             ‘release’                         “1”
                                                                      
                                                                      
Group                               ‘group’                           “Development/Libraries”
                                                                      
                                                                      
Vendor                              ‘vendor’                          (see above)
                                                                      
                                                                      
Packager                            ‘packager’                        (none)
                                                                      
                                                                      
Provides                            ‘provides’                        (none)
                                                                      
                                                                      
Requires                            ‘requires’                        (none)
                                                                      
                                                                      
Conflicts                           ‘conflicts’                       (none)
                                                                      
                                                                      
Obsoletes                           ‘obsoletes’                       (none)
                                                                      
                                                                      
Distribution                        ‘distribution_name’               (none)
                                                                      
                                                                      
BuildRequires                       ‘build_requires’                  (none)
                                                                      
                                                                      
Icon                                ‘icon’                            (none)
                                                                      

Obviously, supplying even a few of these options on the command-line
would be tedious and error-prone, so it’s usually best to put them in
the setup configuration file, ‘setup.cfg’—see section *note Writing the
Setup Configuration File: 42c7.  If you distribute or package many
Python module distributions, you might want to put options that apply to
all of them in your personal Distutils configuration file
(‘~/.pydistutils.cfg’).  If you want to temporarily disable this file,
you can pass the ‘--no-user-cfg’ option to ‘setup.py’.

There are three steps to building a binary RPM package, all of which are
handled automatically by the Distutils:

  1. create a ‘.spec’ file, which describes the package (analogous to
     the Distutils setup script; in fact, much of the information in the
     setup script winds up in the ‘.spec’ file)

  2. create the source RPM

  3. create the “binary” RPM (which may or may not contain binary code,
     depending on whether your module distribution contains Python
     extensions)

Normally, RPM bundles the last two steps together; when you use the
Distutils, all three steps are typically bundled together.

If you wish, you can separate these three steps.  You can use the
‘--spec-only’ option to make ‘bdist_rpm’ just create the ‘.spec’ file
and exit; in this case, the ‘.spec’ file will be written to the
“distribution directory”—normally ‘dist/’, but customizable with the
‘--dist-dir’ option.  (Normally, the ‘.spec’ file winds up deep in the
“build tree,” in a temporary directory created by ‘bdist_rpm’.)


File: python.info,  Node: Creating Windows Installers,  Next: Cross-compiling on Windows,  Prev: Creating RPM packages,  Up: Creating Built Distributions

17.5.2 Creating Windows Installers
----------------------------------

     Warning: bdist_wininst is deprecated since Python 3.8.

Executable installers are the natural format for binary distributions on
Windows.  They display a nice graphical user interface, display some
information about the module distribution to be installed taken from the
metadata in the setup script, let the user select a few options, and
start or cancel the installation.

Since the metadata is taken from the setup script, creating Windows
installers is usually as easy as running:

     python setup.py bdist_wininst

or the ‘bdist’ command with the ‘--formats’ option:

     python setup.py bdist --formats=wininst

If you have a pure module distribution (only containing pure Python
modules and packages), the resulting installer will be version
independent and have a name like ‘foo-1.0.win32.exe’.  Note that
creating ‘wininst’ binary distributions in only supported on Windows
systems.

If you have a non-pure distribution, the extensions can only be created
on a Windows platform, and will be Python version dependent.  The
installer filename will reflect this and now has the form
‘foo-1.0.win32-py2.0.exe’.  You have to create a separate installer for
every Python version you want to support.

The installer will try to compile pure modules into *note bytecode: 609.
after installation on the target system in normal and optimizing mode.
If you don’t want this to happen for some reason, you can run the
‘bdist_wininst’ command with the ‘--no-target-compile’ and/or the
‘--no-target-optimize’ option.

By default the installer will display the cool “Python Powered” logo
when it is run, but you can also supply your own 152x261 bitmap which
must be a Windows ‘.bmp’ file with the ‘--bitmap’ option.

The installer will also display a large title on the desktop background
window when it is run, which is constructed from the name of your
distribution and the version number.  This can be changed to another
text by using the ‘--title’ option.

The installer file will be written to the “distribution directory” —
normally ‘dist/’, but customizable with the ‘--dist-dir’ option.


File: python.info,  Node: Cross-compiling on Windows,  Next: Vista User Access Control UAC,  Prev: Creating Windows Installers,  Up: Creating Built Distributions

17.5.3 Cross-compiling on Windows
---------------------------------

Starting with Python 2.6, distutils is capable of cross-compiling
between Windows platforms.  In practice, this means that with the
correct tools installed, you can use a 32bit version of Windows to
create 64bit extensions and vice-versa.

To build for an alternate platform, specify the ‘--plat-name’ option to
the build command.  Valid values are currently ‘win32’, and ‘win-amd64’.
For example, on a 32bit version of Windows, you could execute:

     python setup.py build --plat-name=win-amd64

to build a 64bit version of your extension.  The Windows Installers also
support this option, so the command:

     python setup.py build --plat-name=win-amd64 bdist_wininst

would create a 64bit installation executable on your 32bit version of
Windows.

To cross-compile, you must download the Python source code and
cross-compile Python itself for the platform you are targeting - it is
not possible from a binary installation of Python (as the .lib etc file
for other platforms are not included.)  In practice, this means the user
of a 32 bit operating system will need to use Visual Studio 2008 to open
the ‘PCbuild/PCbuild.sln’ solution in the Python source tree and build
the “x64” configuration of the ‘pythoncore’ project before
cross-compiling extensions is possible.

Note that by default, Visual Studio 2008 does not install 64bit
compilers or tools.  You may need to reexecute the Visual Studio setup
process and select these tools (using Control Panel->[Add/Remove]
Programs is a convenient way to check or modify your existing install.)

* Menu:

* The Postinstallation script::


File: python.info,  Node: The Postinstallation script,  Up: Cross-compiling on Windows

17.5.3.1 The Postinstallation script
....................................

Starting with Python 2.3, a postinstallation script can be specified
with the ‘--install-script’ option.  The basename of the script must be
specified, and the script filename must also be listed in the scripts
argument to the setup function.

This script will be run at installation time on the target system after
all the files have been copied, with ‘argv[1]’ set to ‘-install’, and
again at uninstallation time before the files are removed with ‘argv[1]’
set to ‘-remove’.

The installation script runs embedded in the windows installer, every
output (‘sys.stdout’, ‘sys.stderr’) is redirected into a buffer and will
be displayed in the GUI after the script has finished.

Some functions especially useful in this context are available as
additional built-in functions in the installation script.

 -- Function: directory_created (path)
 -- Function: file_created (path)

     These functions should be called when a directory or file is
     created by the postinstall script at installation time.  It will
     register `path' with the uninstaller, so that it will be removed
     when the distribution is uninstalled.  To be safe, directories are
     only removed if they are empty.

 -- Function: get_special_folder_path (csidl_string)

     This function can be used to retrieve special folder locations on
     Windows like the Start Menu or the Desktop.  It returns the full
     path to the folder.  `csidl_string' must be one of the following
     strings:

          "CSIDL_APPDATA"  "CSIDL_COMMON_STARTMENU" "CSIDL_STARTMENU"  "CSIDL_COMMON_DESKTOPDIRECTORY" "CSIDL_DESKTOPDIRECTORY"  "CSIDL_COMMON_STARTUP" "CSIDL_STARTUP"  "CSIDL_COMMON_PROGRAMS" "CSIDL_PROGRAMS"  "CSIDL_FONTS"

     If the folder cannot be retrieved, *note OSError: 1d1. is raised.

     Which folders are available depends on the exact Windows version,
     and probably also the configuration.  For details refer to
     Microsoft’s documentation of the ‘SHGetSpecialFolderPath()’
     function.

 -- Function: create_shortcut (target, description, filename[,
          arguments[, workdir[, iconpath[, iconindex]]]])

     This function creates a shortcut.  `target' is the path to the
     program to be started by the shortcut.  `description' is the
     description of the shortcut.  `filename' is the title of the
     shortcut that the user will see.  `arguments' specifies the command
     line arguments, if any.  `workdir' is the working directory for the
     program.  `iconpath' is the file containing the icon for the
     shortcut, and `iconindex' is the index of the icon in the file
     `iconpath'.  Again, for details consult the Microsoft documentation
     for the ‘IShellLink’ interface.


File: python.info,  Node: Vista User Access Control UAC,  Prev: Cross-compiling on Windows,  Up: Creating Built Distributions

17.5.4 Vista User Access Control (UAC)
--------------------------------------

Starting with Python 2.6, bdist_wininst supports a
‘--user-access-control’ option.  The default is ‘none’ (meaning no UAC
handling is done), and other valid values are ‘auto’ (meaning prompt for
UAC elevation if Python was installed for all users) and ‘force’
(meaning always prompt for elevation).

     Note: bdist_wininst is deprecated since Python 3.8.


File: python.info,  Node: Distutils Examples,  Next: Extending Distutils,  Prev: Creating Built Distributions,  Up: Distributing Python Modules Legacy version

17.6 Distutils Examples
=======================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

This chapter provides a number of basic examples to help get started
with distutils.  Additional information about using distutils can be
found in the Distutils Cookbook.

See also
........

Distutils Cookbook(1)

     Collection of recipes showing how to achieve more control over
     distutils.

* Menu:

* Pure Python distribution (by module): Pure Python distribution by module.
* Pure Python distribution (by package): Pure Python distribution by package.
* Single extension module::
* Checking a package::
* Reading the metadata::

   ---------- Footnotes ----------

   (1) https://wiki.python.org/moin/Distutils/Cookbook


File: python.info,  Node: Pure Python distribution by module,  Next: Pure Python distribution by package,  Up: Distutils Examples

17.6.1 Pure Python distribution (by module)
-------------------------------------------

If you’re just distributing a couple of modules, especially if they
don’t live in a particular package, you can specify them individually
using the ‘py_modules’ option in the setup script.

In the simplest case, you’ll have two files to worry about: a setup
script and the single module you’re distributing, ‘foo.py’ in this
example:

     <root>/         setup.py         foo.py

(In all diagrams in this section, `<root>' will refer to the
distribution root directory.)  A minimal setup script to describe this
situation would be:

     from distutils.core import setup setup(name='foo',       version='1.0',       py_modules=['foo'],       )

Note that the name of the distribution is specified independently with
the ‘name’ option, and there’s no rule that says it has to be the same
as the name of the sole module in the distribution (although that’s
probably a good convention to follow).  However, the distribution name
is used to generate filenames, so you should stick to letters, digits,
underscores, and hyphens.

Since ‘py_modules’ is a list, you can of course specify multiple
modules, eg.  if you’re distributing modules ‘foo’ and ‘bar’, your setup
might look like this:

     <root>/         setup.py         foo.py         bar.py

and the setup script might be

     from distutils.core import setup setup(name='foobar',       version='1.0',       py_modules=['foo', 'bar'],       )

You can put module source files into another directory, but if you have
enough modules to do that, it’s probably easier to specify modules by
package rather than listing them individually.


File: python.info,  Node: Pure Python distribution by package,  Next: Single extension module,  Prev: Pure Python distribution by module,  Up: Distutils Examples

17.6.2 Pure Python distribution (by package)
--------------------------------------------

If you have more than a couple of modules to distribute, especially if
they are in multiple packages, it’s probably easier to specify whole
packages rather than individual modules.  This works even if your
modules are not in a package; you can just tell the Distutils to process
modules from the root package, and that works the same as any other
package (except that you don’t have to have an ‘__init__.py’ file).

The setup script from the last example could also be written as

     from distutils.core import setup setup(name='foobar',       version='1.0',       packages=[''],       )

(The empty string stands for the root package.)

If those two files are moved into a subdirectory, but remain in the root
package, e.g.:

     <root>/         setup.py         src/      foo.py                   bar.py

then you would still specify the root package, but you have to tell the
Distutils where source files in the root package live:

     from distutils.core import setup setup(name='foobar',       version='1.0',       package_dir={'': 'src'},       packages=[''],       )

More typically, though, you will want to distribute multiple modules in
the same package (or in sub-packages).  For example, if the ‘foo’ and
‘bar’ modules belong in package ‘foobar’, one way to layout your source
tree is

     <root>/         setup.py         foobar/                  __init__.py                  foo.py                  bar.py

This is in fact the default layout expected by the Distutils, and the
one that requires the least work to describe in your setup script:

     from distutils.core import setup setup(name='foobar',       version='1.0',       packages=['foobar'],       )

If you want to put modules in directories not named for their package,
then you need to use the ‘package_dir’ option again.  For example, if
the ‘src’ directory holds modules in the ‘foobar’ package:

     <root>/         setup.py         src/                  __init__.py                  foo.py                  bar.py

an appropriate setup script would be

     from distutils.core import setup setup(name='foobar',       version='1.0',       package_dir={'foobar': 'src'},       packages=['foobar'],       )

Or, you might put modules from your main package right in the
distribution root:

     <root>/         setup.py         __init__.py         foo.py         bar.py

in which case your setup script would be

     from distutils.core import setup setup(name='foobar',       version='1.0',       package_dir={'foobar': ''},       packages=['foobar'],       )

(The empty string also stands for the current directory.)

If you have sub-packages, they must be explicitly listed in ‘packages’,
but any entries in ‘package_dir’ automatically extend to sub-packages.
(In other words, the Distutils does `not' scan your source tree, trying
to figure out which directories correspond to Python packages by looking
for ‘__init__.py’ files.)  Thus, if the default layout grows a
sub-package:

     <root>/         setup.py         foobar/                  __init__.py                  foo.py                  bar.py                  subfoo/                            __init__.py                            blah.py

then the corresponding setup script would be

     from distutils.core import setup setup(name='foobar',       version='1.0',       packages=['foobar', 'foobar.subfoo'],       )


File: python.info,  Node: Single extension module,  Next: Checking a package,  Prev: Pure Python distribution by package,  Up: Distutils Examples

17.6.3 Single extension module
------------------------------

Extension modules are specified using the ‘ext_modules’ option.
‘package_dir’ has no effect on where extension source files are found;
it only affects the source for pure Python modules.  The simplest case,
a single extension module in a single C source file, is:

     <root>/         setup.py         foo.c

If the ‘foo’ extension belongs in the root package, the setup script for
this could be

     from distutils.core import setup from distutils.extension import Extension setup(name='foobar',       version='1.0',       ext_modules=[Extension('foo', ['foo.c'])],       )

If the extension actually belongs in a package, say ‘foopkg’, then

With exactly the same source tree layout, this extension can be put in
the ‘foopkg’ package simply by changing the name of the extension:

     from distutils.core import setup from distutils.extension import Extension setup(name='foobar',       version='1.0',       ext_modules=[Extension('foopkg.foo', ['foo.c'])],       )


File: python.info,  Node: Checking a package,  Next: Reading the metadata,  Prev: Single extension module,  Up: Distutils Examples

17.6.4 Checking a package
-------------------------

The ‘check’ command allows you to verify if your package meta-data meet
the minimum requirements to build a distribution.

To run it, just call it using your ‘setup.py’ script.  If something is
missing, ‘check’ will display a warning.

Let’s take an example with a simple script:

     from distutils.core import setup  setup(name='foobar')

Running the ‘check’ command will display some warnings:

     $ python setup.py check running check warning: check: missing required meta-data: version, url warning: check: missing meta-data: either (author and author_email) or          (maintainer and maintainer_email) must be supplied

If you use the reStructuredText syntax in the ‘long_description’ field
and docutils(1) is installed you can check if the syntax is fine with
the ‘check’ command, using the ‘restructuredtext’ option.

For example, if the ‘setup.py’ script is changed like this:

     from distutils.core import setup  desc = """\ My description ==============  This is the description of the ``foobar`` package. """  setup(name='foobar', version='1', author='tarek',     author_email='tarek@ziade.org',     url='http://example.com', long_description=desc)

Where the long description is broken, ‘check’ will be able to detect it
by using the ‘docutils’ parser:

     $ python setup.py check --restructuredtext running check warning: check: Title underline too short. (line 2) warning: check: Could not finish the parsing.

   ---------- Footnotes ----------

   (1) http://docutils.sourceforge.net


File: python.info,  Node: Reading the metadata,  Prev: Checking a package,  Up: Distutils Examples

17.6.5 Reading the metadata
---------------------------

The *note distutils.core.setup(): 3abc. function provides a command-line
interface that allows you to query the metadata fields of a project
through the ‘setup.py’ script of a given project:

     $ python setup.py --name distribute

This call reads the ‘name’ metadata by running the *note
distutils.core.setup(): 3abc. function.  Although, when a source or
binary distribution is created with Distutils, the metadata fields are
written in a static file called ‘PKG-INFO’.  When a Distutils-based
project is installed in Python, the ‘PKG-INFO’ file is copied alongside
the modules and packages of the distribution under
‘NAME-VERSION-pyX.X.egg-info’, where ‘NAME’ is the name of the project,
‘VERSION’ its version as defined in the Metadata, and ‘pyX.X’ the major
and minor version of Python like ‘2.7’ or ‘3.2’.

You can read back this static file, by using the
‘distutils.dist.DistributionMetadata’ class and its ‘read_pkg_file()’
method:

     >>> from distutils.dist import DistributionMetadata >>> metadata = DistributionMetadata() >>> metadata.read_pkg_file(open('distribute-0.6.8-py2.7.egg-info')) >>> metadata.name 'distribute' >>> metadata.version '0.6.8' >>> metadata.description 'Easily download, build, install, upgrade, and uninstall Python packages'

Notice that the class can also be instantiated with a metadata file path
to loads its values:

     >>> pkg_info_path = 'distribute-0.6.8-py2.7.egg-info' >>> DistributionMetadata(pkg_info_path).name 'distribute'


File: python.info,  Node: Extending Distutils,  Next: Command Reference,  Prev: Distutils Examples,  Up: Distributing Python Modules Legacy version

17.7 Extending Distutils
========================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

Distutils can be extended in various ways.  Most extensions take the
form of new commands or replacements for existing commands.  New
commands may be written to support new types of platform-specific
packaging, for example, while replacements for existing commands may be
made to modify details of how the command operates on a package.

Most extensions of the distutils are made within ‘setup.py’ scripts that
want to modify existing commands; many simply add a few file extensions
that should be copied into packages in addition to ‘.py’ files as a
convenience.

Most distutils command implementations are subclasses of the *note
distutils.cmd.Command: 42f0. class.  New commands may directly inherit
from ‘Command’, while replacements often derive from ‘Command’
indirectly, directly subclassing the command they are replacing.
Commands are required to derive from ‘Command’.

* Menu:

* Integrating new commands::
* Adding new distribution types::


File: python.info,  Node: Integrating new commands,  Next: Adding new distribution types,  Up: Extending Distutils

17.7.1 Integrating new commands
-------------------------------

There are different ways to integrate new command implementations into
distutils.  The most difficult is to lobby for the inclusion of the new
features in distutils itself, and wait for (and require) a version of
Python that provides that support.  This is really hard for many
reasons.

The most common, and possibly the most reasonable for most needs, is to
include the new implementations with your ‘setup.py’ script, and cause
the *note distutils.core.setup(): 3abc. function use them:

     from distutils.command.build_py import build_py as _build_py from distutils.core import setup  class build_py(_build_py):     """Specialized Python source builder."""      # implement whatever needs to be different...  setup(cmdclass={'build_py': build_py},       ...)

This approach is most valuable if the new implementations must be used
to use a particular package, as everyone interested in the package will
need to have the new command implementation.

Beginning with Python 2.4, a third option is available, intended to
allow new commands to be added which can support existing ‘setup.py’
scripts without requiring modifications to the Python installation.
This is expected to allow third-party extensions to provide support for
additional packaging systems, but the commands can be used for anything
distutils commands can be used for.  A new configuration option,
‘command_packages’ (command-line option ‘--command-packages’), can be
used to specify additional packages to be searched for modules
implementing commands.  Like all distutils options, this can be
specified on the command line or in a configuration file.  This option
can only be set in the ‘[global]’ section of a configuration file, or
before any commands on the command line.  If set in a configuration
file, it can be overridden from the command line; setting it to an empty
string on the command line causes the default to be used.  This should
never be set in a configuration file provided with a package.

This new option can be used to add any number of packages to the list of
packages searched for command implementations; multiple package names
should be separated by commas.  When not specified, the search is only
performed in the *note distutils.command: 3e. package.  When ‘setup.py’
is run with the option ‘--command-packages distcmds,buildcmds’, however,
the packages *note distutils.command: 3e, ‘distcmds’, and ‘buildcmds’
will be searched in that order.  New commands are expected to be
implemented in modules of the same name as the command by classes
sharing the same name.  Given the example command line option above, the
command ‘bdist_openpkg’ could be implemented by the class
‘distcmds.bdist_openpkg.bdist_openpkg’ or
‘buildcmds.bdist_openpkg.bdist_openpkg’.


File: python.info,  Node: Adding new distribution types,  Prev: Integrating new commands,  Up: Extending Distutils

17.7.2 Adding new distribution types
------------------------------------

Commands that create distributions (files in the ‘dist/’ directory) need
to add ‘(command, filename)’ pairs to ‘self.distribution.dist_files’ so
that ‘upload’ can upload it to PyPI. The `filename' in the pair contains
no path information, only the name of the file itself.  In dry-run mode,
pairs should still be added to represent what would have been created.


File: python.info,  Node: Command Reference,  Next: API Reference,  Prev: Extending Distutils,  Up: Distributing Python Modules Legacy version

17.8 Command Reference
======================

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

* Menu:

* Installing modules; the install command family: Installing modules the install command family.
* Creating a source distribution; the sdist command: Creating a source distribution the sdist command.


File: python.info,  Node: Installing modules the install command family,  Next: Creating a source distribution the sdist command,  Up: Command Reference

17.8.1 Installing modules: the ‘install’ command family
-------------------------------------------------------

The install command ensures that the build commands have been run and
then runs the subcommands ‘install_lib’, ‘install_data’ and
‘install_scripts’.

* Menu:

* install_data::
* install_scripts::


File: python.info,  Node: install_data,  Next: install_scripts,  Up: Installing modules the install command family

17.8.1.1 ‘install_data’
.......................

This command installs all data files provided with the distribution.


File: python.info,  Node: install_scripts,  Prev: install_data,  Up: Installing modules the install command family

17.8.1.2 ‘install_scripts’
..........................

This command installs all (Python) scripts in the distribution.


File: python.info,  Node: Creating a source distribution the sdist command,  Prev: Installing modules the install command family,  Up: Command Reference

17.8.2 Creating a source distribution: the ‘sdist’ command
----------------------------------------------------------

The manifest template commands are:

Command                                         Description
                                                
----------------------------------------------------------------------------------------------------
                                                
‘include pat1 pat2 ...’                         include all files matching any of the listed
                                                patterns
                                                
                                                
‘exclude pat1 pat2 ...’                         exclude all files matching any of the listed
                                                patterns
                                                
                                                
‘recursive-include dir pat1 pat2 ...’           include all files under `dir' matching any of the
                                                listed patterns
                                                
                                                
‘recursive-exclude dir pat1 pat2 ...’           exclude all files under `dir' matching any of the
                                                listed patterns
                                                
                                                
‘global-include pat1 pat2 ...’                  include all files anywhere in the source tree
                                                matching — & any of the listed patterns
                                                
                                                
‘global-exclude pat1 pat2 ...’                  exclude all files anywhere in the source tree
                                                matching — & any of the listed patterns
                                                
                                                
‘prune dir’                                     exclude all files under `dir'
                                                
                                                
‘graft dir’                                     include all files under `dir'
                                                

The patterns here are Unix-style “glob” patterns: ‘*’ matches any
sequence of regular filename characters, ‘?’ matches any single regular
filename character, and ‘[range]’ matches any of the characters in
`range' (e.g., ‘a-z’, ‘a-zA-Z’, ‘a-f0-9_.’).  The definition of “regular
filename character” is platform-specific: on Unix it is anything except
slash; on Windows anything except backslash or colon.


File: python.info,  Node: API Reference,  Prev: Command Reference,  Up: Distributing Python Modules Legacy version

17.9 API Reference
==================

See also
........

New and changed setup.py arguments in setuptools(1)

     The ‘setuptools’ project adds new capabilities to the ‘setup’
     function and other APIs, makes the API consistent across different
     Python versions, and is hence recommended over using ‘distutils’
     directly.

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

* Menu:

* distutils.core — Core Distutils functionality: distutils core — Core Distutils functionality.
* distutils.ccompiler — CCompiler base class: distutils ccompiler — CCompiler base class.
* distutils.unixccompiler — Unix C Compiler: distutils unixccompiler — Unix C Compiler.
* distutils.msvccompiler — Microsoft Compiler: distutils msvccompiler — Microsoft Compiler.
* distutils.bcppcompiler — Borland Compiler: distutils bcppcompiler — Borland Compiler.
* distutils.cygwincompiler — Cygwin Compiler: distutils cygwincompiler — Cygwin Compiler.
* distutils.archive_util — Archiving utilities: distutils archive_util — Archiving utilities.
* distutils.dep_util — Dependency checking: distutils dep_util — Dependency checking.
* distutils.dir_util — Directory tree operations: distutils dir_util — Directory tree operations.
* distutils.file_util — Single file operations: distutils file_util — Single file operations.
* distutils.util — Miscellaneous other utility functions: distutils util — Miscellaneous other utility functions.
* distutils.dist — The Distribution class: distutils dist — The Distribution class.
* distutils.extension — The Extension class: distutils extension — The Extension class.
* distutils.debug — Distutils debug mode: distutils debug — Distutils debug mode.
* distutils.errors — Distutils exceptions: distutils errors — Distutils exceptions.
* distutils.fancy_getopt — Wrapper around the standard getopt module: distutils fancy_getopt — Wrapper around the standard getopt module.
* distutils.filelist — The FileList class: distutils filelist — The FileList class.
* distutils.log — Simple PEP 282-style logging: distutils log — Simple PEP 282-style logging.
* distutils.spawn — Spawn a sub-process: distutils spawn — Spawn a sub-process.
* distutils.sysconfig — System configuration information: distutils sysconfig — System configuration information.
* distutils.text_file — The TextFile class: distutils text_file — The TextFile class.
* distutils.version — Version number classes: distutils version — Version number classes.
* distutils.cmd — Abstract base class for Distutils commands: distutils cmd — Abstract base class for Distutils commands.
* Creating a new Distutils command::
* distutils.command — Individual Distutils commands: distutils command — Individual Distutils commands.
* distutils.command.bdist — Build a binary installer: distutils command bdist — Build a binary installer.
* distutils.command.bdist_packager — Abstract base class for packagers: distutils command bdist_packager — Abstract base class for packagers.
* distutils.command.bdist_dumb — Build a “dumb” installer: distutils command bdist_dumb — Build a “dumb” installer.
* distutils.command.bdist_msi — Build a Microsoft Installer binary package: distutils command bdist_msi — Build a Microsoft Installer binary package.
* distutils.command.bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM: distutils command bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM.
* distutils.command.bdist_wininst — Build a Windows installer: distutils command bdist_wininst — Build a Windows installer.
* distutils.command.sdist — Build a source distribution: distutils command sdist — Build a source distribution.
* distutils.command.build — Build all files of a package: distutils command build — Build all files of a package.
* distutils.command.build_clib — Build any C libraries in a package: distutils command build_clib — Build any C libraries in a package.
* distutils.command.build_ext — Build any extensions in a package: distutils command build_ext — Build any extensions in a package.
* distutils.command.build_py — Build the .py/.pyc files of a package: distutils command build_py — Build the py/ pyc files of a package.
* distutils.command.build_scripts — Build the scripts of a package: distutils command build_scripts — Build the scripts of a package.
* distutils.command.clean — Clean a package build area: distutils command clean — Clean a package build area.
* distutils.command.config — Perform package configuration: distutils command config — Perform package configuration.
* distutils.command.install — Install a package: distutils command install — Install a package.
* distutils.command.install_data — Install data files from a package: distutils command install_data — Install data files from a package.
* distutils.command.install_headers — Install C/C++ header files from a package: distutils command install_headers — Install C/C++ header files from a package.
* distutils.command.install_lib — Install library files from a package: distutils command install_lib — Install library files from a package.
* distutils.command.install_scripts — Install script files from a package: distutils command install_scripts — Install script files from a package.
* distutils.command.register — Register a module with the Python Package Index: distutils command register — Register a module with the Python Package Index.
* distutils.command.check — Check the meta-data of a package: distutils command check — Check the meta-data of a package.

   ---------- Footnotes ----------

   (1) 
https://setuptools.readthedocs.io/en/latest/setuptools.html#new-and-changed-setup-keywords


File: python.info,  Node: distutils core — Core Distutils functionality,  Next: distutils ccompiler — CCompiler base class,  Up: API Reference

17.9.1 ‘distutils.core’ — Core Distutils functionality
------------------------------------------------------

The *note distutils.core: 54. module is the only module that needs to be
installed to use the Distutils.  It provides the *note setup(): 3abc.
(which is called from the setup script).  Indirectly provides the
‘distutils.dist.Distribution’ and *note distutils.cmd.Command: 42f0.
class.

 -- Function: distutils.core.setup (arguments)

     The basic do-everything function that does most everything you
     could ever ask for from a Distutils method.

     The setup function takes a large number of arguments.  These are
     laid out in the following table.

     argument name            value                                type
                                                                   
     --------------------------------------------------------------------------------------------------------------------------------
                                                                   
     `name'                   The name of the package              a string
                                                                   
                                                                   
     `version'                The version number of the package;   a string
                              see *note distutils.version: 66.     
                              
                                                                   
     `description'            A single line describing the         a string
                              package                              
                              
                                                                   
     `long_description'       Longer description of the package    a string
                                                                   
                                                                   
     `author'                 The name of the package author       a string
                                                                   
                                                                   
     `author_email'           The email address of the package     a string
                              author                               
                              
                                                                   
     `maintainer'             The name of the current              a string
                              maintainer, if different from the    
                              author.  Note that if the
                              maintainer is provided, distutils
                              will use it as the author in
                              ‘PKG-INFO’
                              
                                                                   
     `maintainer_email'       The email address of the current     a string
                              maintainer, if different from the    
                              author
                              
                                                                   
     `url'                    A URL for the package (homepage)     a string
                                                                   
                                                                   
     `download_url'           A URL to download the package        a string
                                                                   
                                                                   
     `packages'               A list of Python packages that       a list of strings
                              distutils will manipulate            
                              
                                                                   
     `py_modules'             A list of Python modules that        a list of strings
                              distutils will manipulate            
                              
                                                                   
     `scripts'                A list of standalone script files    a list of strings
                              to be built and installed            
                              
                                                                   
     `ext_modules'            A list of Python extensions to be    a list of instances of *note distutils.core.Extension: 42b6.
                              built                                
                              
                                                                   
     `classifiers'            A list of categories for the         a list of strings; valid classifiers are listed on PyPI(1).
                              package                              
                              
                                                                   
     `distclass'              the *note Distribution: 4301.        a subclass of *note distutils.core.Distribution: 4301.
                              class to use                         
                              
                                                                   
     `script_name'            The name of the setup.py script -    a string
                              defaults to ‘sys.argv[0]’            
                              
                                                                   
     `script_args'            Arguments to supply to the setup     a list of strings
                              script                               
                              
                                                                   
     `options'                default options for the setup        a dictionary
                              script                               
                              
                                                                   
     `license'                The license for the package          a string
                                                                   
                                                                   
     `keywords'               Descriptive meta-data, see PEP       a list of strings or a comma-separated string
                              314(2)                               
                              
                                                                   
     `platforms'                                                   a list of strings or a comma-separated string
                                                                   
                                                                   
     `cmdclass'               A mapping of command names to        a dictionary
                              *note Command: 4302. subclasses      
                              
                                                                   
     `data_files'             A list of data files to install      a list
                                                                   
                                                                   
     `package_dir'            A mapping of package to directory    a dictionary
                              names                                
                              

 -- Function: distutils.core.run_setup (script_name[, script_args=None,
          stop_after='run'])

     Run a setup script in a somewhat controlled environment, and return
     the ‘distutils.dist.Distribution’ instance that drives things.
     This is useful if you need to find out the distribution meta-data
     (passed as keyword args from `script' to *note setup(): 3abc.), or
     the contents of the config files or command-line.

     `script_name' is a file that will be read and run with *note
     exec(): c37.  ‘sys.argv[0]’ will be replaced with `script' for the
     duration of the call.  `script_args' is a list of strings; if
     supplied, ‘sys.argv[1:]’ will be replaced by `script_args' for the
     duration of the call.

     `stop_after' tells *note setup(): 3abc. when to stop processing;
     possible values:

     value               description
                         
     ----------------------------------------------------------------------
                         
     `init'              Stop after the *note Distribution: 4301.
                         instance has been created and populated with
                         the keyword arguments to *note setup(): 3abc.
                         
                         
     `config'            Stop after config files have been parsed (and
                         their data stored in the
                         *note Distribution: 4301. instance)
                         
                         
     `commandline'       Stop after the command-line (‘sys.argv[1:]’ or
                         `script_args') have been parsed (and the data
                         stored in the *note Distribution: 4301.
                         instance.)
                         
                         
     `run'               Stop after all commands have been run (the same
                         as if *note setup(): 3abc. had been called in
                         the usual way).  This is the default value.
                         

In addition, the *note distutils.core: 54. module exposed a number of
classes that live elsewhere.

   * ‘Extension’ from *note distutils.extension: 5b.

   * *note Command: 42f0. from *note distutils.cmd: 3d.

   * ‘Distribution’ from *note distutils.dist: 59.

A short description of each of these follows, but see the relevant
module for the full reference.

 -- Class: distutils.core.Extension

     The Extension class describes a single C or C++ extension module in
     a setup script.  It accepts the following keyword arguments in its
     constructor:

     argument name                value                                type
                                                                       
     --------------------------------------------------------------------------------------------------
                                                                       
     `name'                       the full name of the extension,      a string
                                  including any packages — ie.         
                                  `not' a filename or pathname, but
                                  Python dotted name
                                  
                                                                       
     `sources'                    list of source filenames, relative   a list of strings
                                  to the distribution root (where      
                                  the setup script lives), in Unix
                                  form (slash-separated) for
                                  portability.  Source files may be
                                  C, C++, SWIG (.i),
                                  platform-specific resource files,
                                  or whatever else is recognized by
                                  the ‘build_ext’ command as source
                                  for a Python extension.
                                  
                                                                       
     `include_dirs'               list of directories to search for    a list of strings
                                  C/C++ header files (in Unix form     
                                  for portability)
                                  
                                                                       
     `define_macros'              list of macros to define; each       a list of tuples
                                  macro is defined using a 2-tuple     
                                  ‘(name, value)’, where `value' is
                                  either the string to define it to
                                  or ‘None’ to define it without a
                                  particular value (equivalent of
                                  ‘#define FOO’ in source or ‘-DFOO’
                                  on Unix C compiler command line)
                                  
                                                                       
     `undef_macros'               list of macros to undefine           a list of strings
                                  explicitly                           
                                  
                                                                       
     `library_dirs'               list of directories to search for    a list of strings
                                  C/C++ libraries at link time         
                                  
                                                                       
     `libraries'                  list of library names (not           a list of strings
                                  filenames or paths) to link          
                                  against
                                  
                                                                       
     `runtime_library_dirs'       list of directories to search for    a list of strings
                                  C/C++ libraries at run time (for     
                                  shared extensions, this is when
                                  the extension is loaded)
                                  
                                                                       
     `extra_objects'              list of extra files to link with     a list of strings
                                  (eg.  object files not implied by    
                                  ‘sources’, static library that
                                  must be explicitly specified,
                                  binary resource files, etc.)
                                  
                                                                       
     `extra_compile_args'         any extra platform- and              a list of strings
                                  compiler-specific information to     
                                  use when compiling the source
                                  files in ‘sources’.  For platforms
                                  and compilers where a command line
                                  makes sense, this is typically a
                                  list of command-line arguments,
                                  but for other platforms it could
                                  be anything.
                                  
                                                                       
     `extra_link_args'            any extra platform- and              a list of strings
                                  compiler-specific information to     
                                  use when linking object files
                                  together to create the extension
                                  (or to create a new static Python
                                  interpreter).  Similar
                                  interpretation as for
                                  ‘extra_compile_args’.
                                  
                                                                       
     `export_symbols'             list of symbols to be exported       a list of strings
                                  from a shared extension.  Not used   
                                  on all platforms, and not
                                  generally necessary for Python
                                  extensions, which typically export
                                  exactly one symbol: ‘init’ +
                                  extension_name.
                                  
                                                                       
     `depends'                    list of files that the extension     a list of strings
                                  depends on                           
                                  
                                                                       
     `language'                   extension language (i.e.  ‘'c'’,     a string
                                  ‘'c++'’, ‘'objc'’).  Will be         
                                  detected from the source
                                  extensions if not provided.
                                  
                                                                       
     `optional'                   specifies that a build failure in    a boolean
                                  the extension should not abort the   
                                  build process, but simply skip the
                                  extension.
                                  

     Changed in version 3.8: On Unix, C extensions are no longer linked
     to libpython except on Android and Cygwin.

 -- Class: distutils.core.Distribution

     A *note Distribution: 4301. describes how to build, install and
     package up a Python software package.

     See the *note setup(): 3abc. function for a list of keyword
     arguments accepted by the Distribution constructor.  *note setup():
     3abc. creates a Distribution instance.

     Changed in version 3.7: *note Distribution: 4301. now warns if
     ‘classifiers’, ‘keywords’ and ‘platforms’ fields are not specified
     as a list or a string.

 -- Class: distutils.core.Command

     A *note Command: 4302. class (or rather, an instance of one of its
     subclasses) implement a single distutils command.

   ---------- Footnotes ----------

   (1) https://pypi.org/classifiers

   (2) https://www.python.org/dev/peps/pep-0314


File: python.info,  Node: distutils ccompiler — CCompiler base class,  Next: distutils unixccompiler — Unix C Compiler,  Prev: distutils core — Core Distutils functionality,  Up: API Reference

17.9.2 ‘distutils.ccompiler’ — CCompiler base class
---------------------------------------------------

This module provides the abstract base class for the *note CCompiler:
4305. classes.  A *note CCompiler: 4305. instance can be used for all
the compile and link steps needed to build a single project.  Methods
are provided to set options for the compiler — macro definitions,
include directories, link path, libraries and the like.

This module provides the following functions.

 -- Function: distutils.ccompiler.gen_lib_options (compiler,
          library_dirs, runtime_library_dirs, libraries)

     Generate linker options for searching library directories and
     linking with specific libraries.  `libraries' and `library_dirs'
     are, respectively, lists of library names (not filenames!)  and
     search directories.  Returns a list of command-line options
     suitable for use with some compiler (depending on the two format
     strings passed in).

 -- Function: distutils.ccompiler.gen_preprocess_options (macros,
          include_dirs)

     Generate C pre-processor options (‘-D’, ‘-U’, ‘-I’) as used by at
     least two types of compilers: the typical Unix compiler and Visual
     C++.  `macros' is the usual thing, a list of 1- or 2-tuples, where
     ‘(name,)’ means undefine (‘-U’) macro `name', and ‘(name, value)’
     means define (‘-D’) macro `name' to `value'.  `include_dirs' is
     just a list of directory names to be added to the header file
     search path (‘-I’).  Returns a list of command-line options
     suitable for either Unix compilers or Visual C++.

 -- Function: distutils.ccompiler.get_default_compiler (osname,
          platform)

     Determine the default compiler to use for the given platform.

     `osname' should be one of the standard Python OS names (i.e.  the
     ones returned by ‘os.name’) and `platform' the common value
     returned by ‘sys.platform’ for the platform in question.

     The default values are ‘os.name’ and ‘sys.platform’ in case the
     parameters are not given.

 -- Function: distutils.ccompiler.new_compiler (plat=None,
          compiler=None, verbose=0, dry_run=0, force=0)

     Factory function to generate an instance of some CCompiler subclass
     for the supplied platform/compiler combination.  `plat' defaults to
     ‘os.name’ (eg.  ‘'posix'’, ‘'nt'’), and `compiler' defaults to the
     default compiler for that platform.  Currently only ‘'posix'’ and
     ‘'nt'’ are supported, and the default compilers are “traditional
     Unix interface” (‘UnixCCompiler’ class) and Visual C++
     (‘MSVCCompiler’ class).  Note that it’s perfectly possible to ask
     for a Unix compiler object under Windows, and a Microsoft compiler
     object under Unix—if you supply a value for `compiler', `plat' is
     ignored.

 -- Function: distutils.ccompiler.show_compilers ()

     Print list of available compilers (used by the ‘--help-compiler’
     options to ‘build’, ‘build_ext’, ‘build_clib’).

 -- Class: distutils.ccompiler.CCompiler ([verbose=0, dry_run=0,
          force=0])

     The abstract base class *note CCompiler: 4305. defines the
     interface that must be implemented by real compiler classes.  The
     class also has some utility methods used by several compiler
     classes.

     The basic idea behind a compiler abstraction class is that each
     instance can be used for all the compile/link steps in building a
     single project.  Thus, attributes common to all of those compile
     and link steps — include directories, macros to define, libraries
     to link against, etc.  — are attributes of the compiler instance.
     To allow for variability in how individual files are treated, most
     of those attributes may be varied on a per-compilation or per-link
     basis.

     The constructor for each subclass creates an instance of the
     Compiler object.  Flags are `verbose' (show verbose output),
     `dry_run' (don’t actually execute the steps) and `force' (rebuild
     everything, regardless of dependencies).  All of these flags
     default to ‘0’ (off).  Note that you probably don’t want to
     instantiate *note CCompiler: 4305. or one of its subclasses
     directly - use the ‘distutils.CCompiler.new_compiler()’ factory
     function instead.

     The following methods allow you to manually alter compiler options
     for the instance of the Compiler class.

      -- Method: add_include_dir (dir)

          Add `dir' to the list of directories that will be searched for
          header files.  The compiler is instructed to search
          directories in the order in which they are supplied by
          successive calls to *note add_include_dir(): 430b.

      -- Method: set_include_dirs (dirs)

          Set the list of directories that will be searched to `dirs' (a
          list of strings).  Overrides any preceding calls to *note
          add_include_dir(): 430b.; subsequent calls to *note
          add_include_dir(): 430b. add to the list passed to *note
          set_include_dirs(): 430c.  This does not affect any list of
          standard include directories that the compiler may search by
          default.

      -- Method: add_library (libname)

          Add `libname' to the list of libraries that will be included
          in all links driven by this compiler object.  Note that
          `libname' should *not* be the name of a file containing a
          library, but the name of the library itself: the actual
          filename will be inferred by the linker, the compiler, or the
          compiler class (depending on the platform).

          The linker will be instructed to link against libraries in the
          order they were supplied to *note add_library(): 430d. and/or
          *note set_libraries(): 430e.  It is perfectly valid to
          duplicate library names; the linker will be instructed to link
          against libraries as many times as they are mentioned.

      -- Method: set_libraries (libnames)

          Set the list of libraries to be included in all links driven
          by this compiler object to `libnames' (a list of strings).
          This does not affect any standard system libraries that the
          linker may include by default.

      -- Method: add_library_dir (dir)

          Add `dir' to the list of directories that will be searched for
          libraries specified to *note add_library(): 430d. and *note
          set_libraries(): 430e.  The linker will be instructed to
          search for libraries in the order they are supplied to *note
          add_library_dir(): 430f. and/or *note set_library_dirs():
          4310.

      -- Method: set_library_dirs (dirs)

          Set the list of library search directories to `dirs' (a list
          of strings).  This does not affect any standard library search
          path that the linker may search by default.

      -- Method: add_runtime_library_dir (dir)

          Add `dir' to the list of directories that will be searched for
          shared libraries at runtime.

      -- Method: set_runtime_library_dirs (dirs)

          Set the list of directories to search for shared libraries at
          runtime to `dirs' (a list of strings).  This does not affect
          any standard search path that the runtime linker may search by
          default.

      -- Method: define_macro (name[, value=None])

          Define a preprocessor macro for all compilations driven by
          this compiler object.  The optional parameter `value' should
          be a string; if it is not supplied, then the macro will be
          defined without an explicit value and the exact outcome
          depends on the compiler used.

      -- Method: undefine_macro (name)

          Undefine a preprocessor macro for all compilations driven by
          this compiler object.  If the same macro is defined by *note
          define_macro(): 4313. and undefined by *note undefine_macro():
          4314. the last call takes precedence (including multiple
          redefinitions or undefinitions).  If the macro is
          redefined/undefined on a per-compilation basis (ie.  in the
          call to *note compile(): 1b2.), then that takes precedence.

      -- Method: add_link_object (object)

          Add `object' to the list of object files (or analogues, such
          as explicitly named library files or the output of “resource
          compilers”) to be included in every link driven by this
          compiler object.

      -- Method: set_link_objects (objects)

          Set the list of object files (or analogues) to be included in
          every link to `objects'.  This does not affect any standard
          object files that the linker may include by default (such as
          system libraries).

     The following methods implement methods for autodetection of
     compiler options, providing some functionality similar to GNU
     ‘autoconf’.

      -- Method: detect_language (sources)

          Detect the language of a given file, or list of files.  Uses
          the instance attributes ‘language_map’ (a dictionary), and
          ‘language_order’ (a list) to do the job.

      -- Method: find_library_file (dirs, lib[, debug=0])

          Search the specified list of directories for a static or
          shared library file `lib' and return the full path to that
          file.  If `debug' is true, look for a debugging version (if
          that makes sense on the current platform).  Return ‘None’ if
          `lib' wasn’t found in any of the specified directories.

      -- Method: has_function (funcname[, includes=None,
               include_dirs=None, libraries=None, library_dirs=None])

          Return a boolean indicating whether `funcname' is supported on
          the current platform.  The optional arguments can be used to
          augment the compilation environment by providing additional
          include files and paths and libraries and paths.

      -- Method: library_dir_option (dir)

          Return the compiler option to add `dir' to the list of
          directories searched for libraries.

      -- Method: library_option (lib)

          Return the compiler option to add `lib' to the list of
          libraries linked into the shared library or executable.

      -- Method: runtime_library_dir_option (dir)

          Return the compiler option to add `dir' to the list of
          directories searched for runtime libraries.

      -- Method: set_executables (**args)

          Define the executables (and options for them) that will be run
          to perform the various stages of compilation.  The exact set
          of executables that may be specified here depends on the
          compiler class (via the ‘executables’ class attribute), but
          most will have:

          attribute          description
                             
          ------------------------------------------------------------------
                             
          `compiler'         the C/C++ compiler
                             
                             
          `linker_so'        linker used to create shared objects and
                             libraries
                             
                             
          `linker_exe'       linker used to create binary executables
                             
                             
          `archiver'         static library creator
                             

          On platforms with a command-line (Unix, DOS/Windows), each of
          these is a string that will be split into executable name and
          (optional) list of arguments.  (Splitting the string is done
          similarly to how Unix shells operate: words are delimited by
          spaces, but quotes and backslashes can override this.  See
          *note distutils.util.split_quoted(): 431e.)

     The following methods invoke stages in the build process.

      -- Method: compile (sources[, output_dir=None, macros=None,
               include_dirs=None, debug=0, extra_preargs=None,
               extra_postargs=None, depends=None])

          Compile one or more source files.  Generates object files
          (e.g.  transforms a ‘.c’ file to a ‘.o’ file.)

          `sources' must be a list of filenames, most likely C/C++
          files, but in reality anything that can be handled by a
          particular compiler and compiler class (eg.  ‘MSVCCompiler’
          can handle resource files in `sources').  Return a list of
          object filenames, one per source filename in `sources'.
          Depending on the implementation, not all source files will
          necessarily be compiled, but all corresponding object
          filenames will be returned.

          If `output_dir' is given, object files will be put under it,
          while retaining their original path component.  That is,
          ‘foo/bar.c’ normally compiles to ‘foo/bar.o’ (for a Unix
          implementation); if `output_dir' is `build', then it would
          compile to ‘build/foo/bar.o’.

          `macros', if given, must be a list of macro definitions.  A
          macro definition is either a ‘(name, value)’ 2-tuple or a
          ‘(name,)’ 1-tuple.  The former defines a macro; if the value
          is ‘None’, the macro is defined without an explicit value.
          The 1-tuple case undefines a macro.  Later
          definitions/redefinitions/undefinitions take precedence.

          `include_dirs', if given, must be a list of strings, the
          directories to add to the default include file search path for
          this compilation only.

          `debug' is a boolean; if true, the compiler will be instructed
          to output debug symbols in (or alongside) the object file(s).

          `extra_preargs' and `extra_postargs' are
          implementation-dependent.  On platforms that have the notion
          of a command-line (e.g.  Unix, DOS/Windows), they are most
          likely lists of strings: extra command-line arguments to
          prepend/append to the compiler command line.  On other
          platforms, consult the implementation class documentation.  In
          any event, they are intended as an escape hatch for those
          occasions when the abstract compiler framework doesn’t cut the
          mustard.

          `depends', if given, is a list of filenames that all targets
          depend on.  If a source file is older than any file in
          depends, then the source file will be recompiled.  This
          supports dependency tracking, but only at a coarse
          granularity.

          Raises ‘CompileError’ on failure.

      -- Method: create_static_lib (objects, output_libname[,
               output_dir=None, debug=0, target_lang=None])

          Link a bunch of stuff together to create a static library
          file.  The “bunch of stuff” consists of the list of object
          files supplied as `objects', the extra object files supplied
          to *note add_link_object(): 4315. and/or *note
          set_link_objects(): 4316, the libraries supplied to *note
          add_library(): 430d. and/or *note set_libraries(): 430e, and
          the libraries supplied as `libraries' (if any).

          `output_libname' should be a library name, not a filename; the
          filename will be inferred from the library name.  `output_dir'
          is the directory where the library file will be put.

          `debug' is a boolean; if true, debugging information will be
          included in the library (note that on most platforms, it is
          the compile step where this matters: the `debug' flag is
          included here just for consistency).

          `target_lang' is the target language for which the given
          objects are being compiled.  This allows specific linkage time
          treatment of certain languages.

          Raises ‘LibError’ on failure.

      -- Method: link (target_desc, objects, output_filename[,
               output_dir=None, libraries=None, library_dirs=None,
               runtime_library_dirs=None, export_symbols=None, debug=0,
               extra_preargs=None, extra_postargs=None, build_temp=None,
               target_lang=None])

          Link a bunch of stuff together to create an executable or
          shared library file.

          The “bunch of stuff” consists of the list of object files
          supplied as `objects'.  `output_filename' should be a
          filename.  If `output_dir' is supplied, `output_filename' is
          relative to it (i.e.  `output_filename' can provide directory
          components if needed).

          `libraries' is a list of libraries to link against.  These are
          library names, not filenames, since they’re translated into
          filenames in a platform-specific way (eg.  `foo' becomes
          ‘libfoo.a’ on Unix and ‘foo.lib’ on DOS/Windows).  However,
          they can include a directory component, which means the linker
          will look in that specific directory rather than searching all
          the normal locations.

          `library_dirs', if supplied, should be a list of directories
          to search for libraries that were specified as bare library
          names (ie.  no directory component).  These are on top of the
          system default and those supplied to *note add_library_dir():
          430f. and/or *note set_library_dirs(): 4310.
          `runtime_library_dirs' is a list of directories that will be
          embedded into the shared library and used to search for other
          shared libraries that *it* depends on at run-time.  (This may
          only be relevant on Unix.)

          `export_symbols' is a list of symbols that the shared library
          will export.  (This appears to be relevant only on Windows.)

          `debug' is as for *note compile(): 1b2. and *note
          create_static_lib(): 4320, with the slight distinction that it
          actually matters on most platforms (as opposed to *note
          create_static_lib(): 4320, which includes a `debug' flag
          mostly for form’s sake).

          `extra_preargs' and `extra_postargs' are as for *note
          compile(): 1b2. (except of course that they supply
          command-line arguments for the particular linker being used).

          `target_lang' is the target language for which the given
          objects are being compiled.  This allows specific linkage time
          treatment of certain languages.

          Raises ‘LinkError’ on failure.

      -- Method: link_executable (objects, output_progname[,
               output_dir=None, libraries=None, library_dirs=None,
               runtime_library_dirs=None, debug=0, extra_preargs=None,
               extra_postargs=None, target_lang=None])

          Link an executable.  `output_progname' is the name of the file
          executable, while `objects' are a list of object filenames to
          link in.  Other arguments are as for the *note link(): 4321.
          method.

      -- Method: link_shared_lib (objects, output_libname[,
               output_dir=None, libraries=None, library_dirs=None,
               runtime_library_dirs=None, export_symbols=None, debug=0,
               extra_preargs=None, extra_postargs=None, build_temp=None,
               target_lang=None])

          Link a shared library.  `output_libname' is the name of the
          output library, while `objects' is a list of object filenames
          to link in.  Other arguments are as for the *note link():
          4321. method.

      -- Method: link_shared_object (objects, output_filename[,
               output_dir=None, libraries=None, library_dirs=None,
               runtime_library_dirs=None, export_symbols=None, debug=0,
               extra_preargs=None, extra_postargs=None, build_temp=None,
               target_lang=None])

          Link a shared object.  `output_filename' is the name of the
          shared object that will be created, while `objects' is a list
          of object filenames to link in.  Other arguments are as for
          the *note link(): 4321. method.

      -- Method: preprocess (source[, output_file=None, macros=None,
               include_dirs=None, extra_preargs=None,
               extra_postargs=None])

          Preprocess a single C/C++ source file, named in `source'.
          Output will be written to file named `output_file', or
          `stdout' if `output_file' not supplied.  `macros' is a list of
          macro definitions as for *note compile(): 1b2, which will
          augment the macros set with *note define_macro(): 4313. and
          *note undefine_macro(): 4314.  `include_dirs' is a list of
          directory names that will be added to the default list, in the
          same way as *note add_include_dir(): 430b.

          Raises ‘PreprocessError’ on failure.

     The following utility methods are defined by the *note CCompiler:
     4305. class, for use by the various concrete subclasses.

      -- Method: executable_filename (basename[, strip_dir=0,
               output_dir=''])

          Returns the filename of the executable for the given
          `basename'.  Typically for non-Windows platforms this is the
          same as the basename, while Windows will get a ‘.exe’ added.

      -- Method: library_filename (libname[, lib_type='static',
               strip_dir=0, output_dir=''])

          Returns the filename for the given library name on the current
          platform.  On Unix a library with `lib_type' of ‘'static'’
          will typically be of the form ‘liblibname.a’, while a
          `lib_type' of ‘'dynamic'’ will be of the form ‘liblibname.so’.

      -- Method: object_filenames (source_filenames[, strip_dir=0,
               output_dir=''])

          Returns the name of the object files for the given source
          files.  `source_filenames' should be a list of filenames.

      -- Method: shared_object_filename (basename[, strip_dir=0,
               output_dir=''])

          Returns the name of a shared object file for the given file
          name `basename'.

      -- Method: execute (func, args[, msg=None, level=1])

          Invokes *note distutils.util.execute(): 432b.  This method
          invokes a Python function `func' with the given arguments
          `args', after logging and taking into account the `dry_run'
          flag.

      -- Method: spawn (cmd)

          Invokes ‘distutils.util.spawn()’.  This invokes an external
          process to run the given command.

      -- Method: mkpath (name[, mode=511])

          Invokes *note distutils.dir_util.mkpath(): 432e.  This creates
          a directory and any missing ancestor directories.

      -- Method: move_file (src, dst)

          Invokes *note distutils.file_util.move_file(): 4330.  Renames
          `src' to `dst'.

      -- Method: announce (msg[, level=1])

          Write a message using ‘distutils.log.debug()’.

      -- Method: warn (msg)

          Write a warning message `msg' to standard error.

      -- Method: debug_print (msg)

          If the `debug' flag is set on this *note CCompiler: 4305.
          instance, print `msg' to standard output, otherwise do
          nothing.


File: python.info,  Node: distutils unixccompiler — Unix C Compiler,  Next: distutils msvccompiler — Microsoft Compiler,  Prev: distutils ccompiler — CCompiler base class,  Up: API Reference

17.9.3 ‘distutils.unixccompiler’ — Unix C Compiler
--------------------------------------------------

This module provides the ‘UnixCCompiler’ class, a subclass of
‘CCompiler’ that handles the typical Unix-style command-line C compiler:

   * macros defined with ‘-Dname[=value]’

   * macros undefined with ‘-Uname’

   * include search directories specified with ‘-Idir’

   * libraries specified with ‘-llib’

   * library search directories specified with ‘-Ldir’

   * compile handled by ‘cc’ (or similar) executable with ‘-c’ option:
     compiles ‘.c’ to ‘.o’

   * link static library handled by ‘ar’ command (possibly with
     ‘ranlib’)

   * link shared library handled by ‘cc’ ‘-shared’


File: python.info,  Node: distutils msvccompiler — Microsoft Compiler,  Next: distutils bcppcompiler — Borland Compiler,  Prev: distutils unixccompiler — Unix C Compiler,  Up: API Reference

17.9.4 ‘distutils.msvccompiler’ — Microsoft Compiler
----------------------------------------------------

This module provides ‘MSVCCompiler’, an implementation of the abstract
‘CCompiler’ class for Microsoft Visual Studio.  Typically, extension
modules need to be compiled with the same compiler that was used to
compile Python.  For Python 2.3 and earlier, the compiler was Visual
Studio 6.  For Python 2.4 and 2.5, the compiler is Visual Studio .NET
2003.

‘MSVCCompiler’ will normally choose the right compiler, linker etc.  on
its own.  To override this choice, the environment variables
`DISTUTILS_USE_SDK' and `MSSdk' must be both set.  `MSSdk' indicates
that the current environment has been setup by the SDK’s ‘SetEnv.Cmd’
script, or that the environment variables had been registered when the
SDK was installed; `DISTUTILS_USE_SDK' indicates that the distutils user
has made an explicit choice to override the compiler selection by
‘MSVCCompiler’.


File: python.info,  Node: distutils bcppcompiler — Borland Compiler,  Next: distutils cygwincompiler — Cygwin Compiler,  Prev: distutils msvccompiler — Microsoft Compiler,  Up: API Reference

17.9.5 ‘distutils.bcppcompiler’ — Borland Compiler
--------------------------------------------------

This module provides ‘BorlandCCompiler’, a subclass of the abstract
‘CCompiler’ class for the Borland C++ compiler.


File: python.info,  Node: distutils cygwincompiler — Cygwin Compiler,  Next: distutils archive_util — Archiving utilities,  Prev: distutils bcppcompiler — Borland Compiler,  Up: API Reference

17.9.6 ‘distutils.cygwincompiler’ — Cygwin Compiler
---------------------------------------------------

This module provides the ‘CygwinCCompiler’ class, a subclass of
‘UnixCCompiler’ that handles the Cygwin port of the GNU C compiler to
Windows.  It also contains the Mingw32CCompiler class which handles the
mingw32 port of GCC (same as cygwin in no-cygwin mode).


File: python.info,  Node: distutils archive_util — Archiving utilities,  Next: distutils dep_util — Dependency checking,  Prev: distutils cygwincompiler — Cygwin Compiler,  Up: API Reference

17.9.7 ‘distutils.archive_util’ — Archiving utilities
-----------------------------------------------------

This module provides a few functions for creating archive files, such as
tarballs or zipfiles.

 -- Function: distutils.archive_util.make_archive (base_name, format[,
          root_dir=None, base_dir=None, verbose=0, dry_run=0])

     Create an archive file (eg.  ‘zip’ or ‘tar’).  `base_name' is the
     name of the file to create, minus any format-specific extension;
     `format' is the archive format: one of ‘zip’, ‘tar’, ‘gztar’,
     ‘bztar’, ‘xztar’, or ‘ztar’.  `root_dir' is a directory that will
     be the root directory of the archive; ie.  we typically ‘chdir’
     into `root_dir' before creating the archive.  `base_dir' is the
     directory where we start archiving from; ie.  `base_dir' will be
     the common prefix of all files and directories in the archive.
     `root_dir' and `base_dir' both default to the current directory.
     Returns the name of the archive file.

     Changed in version 3.5: Added support for the ‘xztar’ format.

 -- Function: distutils.archive_util.make_tarball (base_name, base_dir[,
          compress='gzip', verbose=0, dry_run=0])

     ‘Create an (optional compressed) archive as a tar file from all
     files in and under `base_dir'.  `compress' must be ‘'gzip'’ (the
     default), ‘'bzip2'’, ‘'xz'’, ‘'compress'’, or ‘None’.  For the
     ‘'compress'’ method the compression utility named by ‘compress’
     must be on the default program search path, so this is probably
     Unix-specific.  The output tar file will be named ‘base_dir.tar’,
     possibly plus the appropriate compression extension (‘.gz’, ‘.bz2’,
     ‘.xz’ or ‘.Z’).  Return the output filename.

     Changed in version 3.5: Added support for the ‘xz’ compression.

 -- Function: distutils.archive_util.make_zipfile (base_name, base_dir[,
          verbose=0, dry_run=0])

     Create a zip file from all files in and under `base_dir'.  The
     output zip file will be named `base_name' + ‘.zip’.  Uses either
     the *note zipfile: 142. Python module (if available) or the InfoZIP
     ‘zip’ utility (if installed and found on the default search path).
     If neither tool is available, raises ‘DistutilsExecError’.  Returns
     the name of the output zip file.


File: python.info,  Node: distutils dep_util — Dependency checking,  Next: distutils dir_util — Directory tree operations,  Prev: distutils archive_util — Archiving utilities,  Up: API Reference

17.9.8 ‘distutils.dep_util’ — Dependency checking
-------------------------------------------------

This module provides functions for performing simple, timestamp-based
dependency of files and groups of files; also, functions based entirely
on such timestamp dependency analysis.

 -- Function: distutils.dep_util.newer (source, target)

     Return true if `source' exists and is more recently modified than
     `target', or if `source' exists and `target' doesn’t.  Return false
     if both exist and `target' is the same age or newer than `source'.
     Raise ‘DistutilsFileError’ if `source' does not exist.

 -- Function: distutils.dep_util.newer_pairwise (sources, targets)

     Walk two filename lists in parallel, testing if each source is
     newer than its corresponding target.  Return a pair of lists
     (`sources', `targets') where source is newer than target, according
     to the semantics of *note newer(): 433d.

 -- Function: distutils.dep_util.newer_group (sources, target[,
          missing='error'])

     Return true if `target' is out-of-date with respect to any file
     listed in `sources'.  In other words, if `target' exists and is
     newer than every file in `sources', return false; otherwise return
     true.  `missing' controls what we do when a source file is missing;
     the default (‘'error'’) is to blow up with an *note OSError: 1d1.
     from inside *note os.stat(): 1ef.; if it is ‘'ignore'’, we silently
     drop any missing source files; if it is ‘'newer'’, any missing
     source files make us assume that `target' is out-of-date (this is
     handy in “dry-run” mode: it’ll make you pretend to carry out
     commands that wouldn’t work because inputs are missing, but that
     doesn’t matter because you’re not actually going to run the
     commands).


File: python.info,  Node: distutils dir_util — Directory tree operations,  Next: distutils file_util — Single file operations,  Prev: distutils dep_util — Dependency checking,  Up: API Reference

17.9.9 ‘distutils.dir_util’ — Directory tree operations
-------------------------------------------------------

This module provides functions for operating on directories and trees of
directories.

 -- Function: distutils.dir_util.mkpath (name[, mode=0o777, verbose=0,
          dry_run=0])

     Create a directory and any missing ancestor directories.  If the
     directory already exists (or if `name' is the empty string, which
     means the current directory, which of course exists), then do
     nothing.  Raise ‘DistutilsFileError’ if unable to create some
     directory along the way (eg.  some sub-path exists, but is a file
     rather than a directory).  If `verbose' is true, print a one-line
     summary of each mkdir to stdout.  Return the list of directories
     actually created.

 -- Function: distutils.dir_util.create_tree (base_dir, files[,
          mode=0o777, verbose=0, dry_run=0])

     Create all the empty directories under `base_dir' needed to put
     `files' there.  `base_dir' is just the name of a directory which
     doesn’t necessarily exist yet; `files' is a list of filenames to be
     interpreted relative to `base_dir'.  `base_dir' + the directory
     portion of every file in `files' will be created if it doesn’t
     already exist.  `mode', `verbose' and `dry_run' flags are as for
     *note mkpath(): 432e.

 -- Function: distutils.dir_util.copy_tree (src, dst[, preserve_mode=1,
          preserve_times=1, preserve_symlinks=0, update=0, verbose=0,
          dry_run=0])

     Copy an entire directory tree `src' to a new location `dst'.  Both
     `src' and `dst' must be directory names.  If `src' is not a
     directory, raise ‘DistutilsFileError’.  If `dst' does not exist, it
     is created with *note mkpath(): 432e.  The end result of the copy
     is that every file in `src' is copied to `dst', and directories
     under `src' are recursively copied to `dst'.  Return the list of
     files that were copied or might have been copied, using their
     output name.  The return value is unaffected by `update' or
     `dry_run': it is simply the list of all files under `src', with the
     names changed to be under `dst'.

     `preserve_mode' and `preserve_times' are the same as for *note
     distutils.file_util.copy_file(): 4343.; note that they only apply
     to regular files, not to directories.  If `preserve_symlinks' is
     true, symlinks will be copied as symlinks (on platforms that
     support them!); otherwise (the default), the destination of the
     symlink will be copied.  `update' and `verbose' are the same as for
     ‘copy_file()’.

     Files in `src' that begin with ‘.nfs’ are skipped (more information
     on these files is available in answer D2 of the NFS FAQ page(1)).

     Changed in version 3.3.1: NFS files are ignored.

 -- Function: distutils.dir_util.remove_tree (directory[, verbose=0,
          dry_run=0])

     Recursively remove `directory' and all files and directories
     underneath it.  Any errors are ignored (apart from being reported
     to ‘sys.stdout’ if `verbose' is true).

   ---------- Footnotes ----------

   (1) http://nfs.sourceforge.net/#section_d


File: python.info,  Node: distutils file_util — Single file operations,  Next: distutils util — Miscellaneous other utility functions,  Prev: distutils dir_util — Directory tree operations,  Up: API Reference

17.9.10 ‘distutils.file_util’ — Single file operations
------------------------------------------------------

This module contains some utility functions for operating on individual
files.

 -- Function: distutils.file_util.copy_file (src, dst[, preserve_mode=1,
          preserve_times=1, update=0, link=None, verbose=0, dry_run=0])

     Copy file `src' to `dst'.  If `dst' is a directory, then `src' is
     copied there with the same name; otherwise, it must be a filename.
     (If the file exists, it will be ruthlessly clobbered.)  If
     `preserve_mode' is true (the default), the file’s mode (type and
     permission bits, or whatever is analogous on the current platform)
     is copied.  If `preserve_times' is true (the default), the
     last-modified and last-access times are copied as well.  If
     `update' is true, `src' will only be copied if `dst' does not
     exist, or if `dst' does exist but is older than `src'.

     `link' allows you to make hard links (using *note os.link(): a2a.)
     or symbolic links (using *note os.symlink(): a30.) instead of
     copying: set it to ‘'hard'’ or ‘'sym'’; if it is ‘None’ (the
     default), files are copied.  Don’t set `link' on systems that don’t
     support it: *note copy_file(): 4343. doesn’t check if hard or
     symbolic linking is available.  It uses ‘_copy_file_contents()’ to
     copy file contents.

     Return a tuple ‘(dest_name, copied)’: `dest_name' is the actual
     name of the output file, and `copied' is true if the file was
     copied (or would have been copied, if `dry_run' true).

 -- Function: distutils.file_util.move_file (src, dst[, verbose,
          dry_run])

     Move file `src' to `dst'.  If `dst' is a directory, the file will
     be moved into it with the same name; otherwise, `src' is just
     renamed to `dst'.  Returns the new full name of the file.

          Warning: Handles cross-device moves on Unix using *note
          copy_file(): 4343.  What about other systems?

 -- Function: distutils.file_util.write_file (filename, contents)

     Create a file called `filename' and write `contents' (a sequence of
     strings without line terminators) to it.


File: python.info,  Node: distutils util — Miscellaneous other utility functions,  Next: distutils dist — The Distribution class,  Prev: distutils file_util — Single file operations,  Up: API Reference

17.9.11 ‘distutils.util’ — Miscellaneous other utility functions
----------------------------------------------------------------

This module contains other assorted bits and pieces that don’t fit into
any other utility module.

 -- Function: distutils.util.get_platform ()

     Return a string that identifies the current platform.  This is used
     mainly to distinguish platform-specific build directories and
     platform-specific built distributions.  Typically includes the OS
     name and version and the architecture (as supplied by
     ‘os.uname()’), although the exact information included depends on
     the OS; e.g., on Linux, the kernel version isn’t particularly
     important.

     Examples of returned values:

        * ‘linux-i586’

        * ‘linux-alpha’

        * ‘solaris-2.6-sun4u’

     For non-POSIX platforms, currently just returns ‘sys.platform’.

     For Mac OS X systems the OS version reflects the minimal version on
     which binaries will run (that is, the value of
     ‘MACOSX_DEPLOYMENT_TARGET’ during the build of Python), not the OS
     version of the current system.

     For universal binary builds on Mac OS X the architecture value
     reflects the universal binary status instead of the architecture of
     the current processor.  For 32-bit universal binaries the
     architecture is ‘fat’, for 64-bit universal binaries the
     architecture is ‘fat64’, and for 4-way universal binaries the
     architecture is ‘universal’.  Starting from Python 2.7 and Python
     3.2 the architecture ‘fat3’ is used for a 3-way universal build
     (ppc, i386, x86_64) and ‘intel’ is used for a universal build with
     the i386 and x86_64 architectures

     Examples of returned values on Mac OS X:

        * ‘macosx-10.3-ppc’

        * ‘macosx-10.3-fat’

        * ‘macosx-10.5-universal’

        * ‘macosx-10.6-intel’

 -- Function: distutils.util.convert_path (pathname)

     Return ‘pathname’ as a name that will work on the native
     filesystem, i.e.  split it on ‘/’ and put it back together again
     using the current directory separator.  Needed because filenames in
     the setup script are always supplied in Unix style, and have to be
     converted to the local convention before we can actually use them
     in the filesystem.  Raises *note ValueError: 1f9. on non-Unix-ish
     systems if `pathname' either starts or ends with a slash.

 -- Function: distutils.util.change_root (new_root, pathname)

     Return `pathname' with `new_root' prepended.  If `pathname' is
     relative, this is equivalent to ‘os.path.join(new_root,pathname)’
     Otherwise, it requires making `pathname' relative and then joining
     the two, which is tricky on DOS/Windows.

 -- Function: distutils.util.check_environ ()

     Ensure that ‘os.environ’ has all the environment variables we
     guarantee that users can use in config files, command-line options,
     etc.  Currently this includes:

        * ‘HOME’ - user’s home directory (Unix only)

        * ‘PLAT’ - description of the current platform, including
          hardware and OS (see *note get_platform(): 4348.)

 -- Function: distutils.util.subst_vars (s, local_vars)

     Perform shell/Perl-style variable substitution on `s'.  Every
     occurrence of ‘$’ followed by a name is considered a variable, and
     variable is substituted by the value found in the `local_vars'
     dictionary, or in ‘os.environ’ if it’s not in `local_vars'.
     `os.environ' is first checked/augmented to guarantee that it
     contains certain values: see *note check_environ(): 434b.  Raise
     *note ValueError: 1f9. for any variables not found in either
     `local_vars' or ‘os.environ’.

     Note that this is not a fully-fledged string interpolation
     function.  A valid ‘$variable’ can consist only of upper and lower
     case letters, numbers and an underscore.  No { } or ( ) style
     quoting is available.

 -- Function: distutils.util.split_quoted (s)

     Split a string up according to Unix shell-like rules for quotes and
     backslashes.  In short: words are delimited by spaces, as long as
     those spaces are not escaped by a backslash, or inside a quoted
     string.  Single and double quotes are equivalent, and the quote
     characters can be backslash-escaped.  The backslash is stripped
     from any two-character escape sequence, leaving only the escaped
     character.  The quote characters are stripped from any quoted
     string.  Returns a list of words.

 -- Function: distutils.util.execute (func, args[, msg=None, verbose=0,
          dry_run=0])

     Perform some action that affects the outside world (for instance,
     writing to the filesystem).  Such actions are special because they
     are disabled by the `dry_run' flag.  This method takes care of all
     that bureaucracy for you; all you have to do is supply the function
     to call and an argument tuple for it (to embody the “external
     action” being performed), and an optional message to print.

 -- Function: distutils.util.strtobool (val)

     Convert a string representation of truth to true (1) or false (0).

     True values are ‘y’, ‘yes’, ‘t’, ‘true’, ‘on’ and ‘1’; false values
     are ‘n’, ‘no’, ‘f’, ‘false’, ‘off’ and ‘0’.  Raises *note
     ValueError: 1f9. if `val' is anything else.

 -- Function: distutils.util.byte_compile (py_files[, optimize=0,
          force=0, prefix=None, base_dir=None, verbose=1, dry_run=0,
          direct=None])

     Byte-compile a collection of Python source files to ‘.pyc’ files in
     a ‘__pycache__’ subdirectory (see PEP 3147(1) and PEP 488(2)).
     `py_files' is a list of files to compile; any files that don’t end
     in ‘.py’ are silently skipped.  `optimize' must be one of the
     following:

        * ‘0’ - don’t optimize

        * ‘1’ - normal optimization (like ‘python -O’)

        * ‘2’ - extra optimization (like ‘python -OO’)

     If `force' is true, all files are recompiled regardless of
     timestamps.

     The source filename encoded in each *note bytecode: 609. file
     defaults to the filenames listed in `py_files'; you can modify
     these with `prefix' and `basedir'.  `prefix' is a string that will
     be stripped off of each source filename, and `base_dir' is a
     directory name that will be prepended (after `prefix' is stripped).
     You can supply either or both (or neither) of `prefix' and
     `base_dir', as you wish.

     If `dry_run' is true, doesn’t actually do anything that would
     affect the filesystem.

     Byte-compilation is either done directly in this interpreter
     process with the standard *note py_compile: d7. module, or
     indirectly by writing a temporary script and executing it.
     Normally, you should let *note byte_compile(): 434e. figure out to
     use direct compilation or not (see the source for details).  The
     `direct' flag is used by the script generated in indirect mode;
     unless you know what you’re doing, leave it set to ‘None’.

     Changed in version 3.2.3: Create ‘.pyc’ files with an *note import
     magic tag: 3a28. in their name, in a ‘__pycache__’ subdirectory
     instead of files without tag in the current directory.

     Changed in version 3.5: Create ‘.pyc’ files according to PEP
     488(3).

 -- Function: distutils.util.rfc822_escape (header)

     Return a version of `header' escaped for inclusion in an RFC 822(4)
     header, by ensuring there are 8 spaces space after each newline.
     Note that it does no other modification of the string.

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-3147

   (2) https://www.python.org/dev/peps/pep-0488

   (3) https://www.python.org/dev/peps/pep-0488

   (4) https://tools.ietf.org/html/rfc822.html


File: python.info,  Node: distutils dist — The Distribution class,  Next: distutils extension — The Extension class,  Prev: distutils util — Miscellaneous other utility functions,  Up: API Reference

17.9.12 ‘distutils.dist’ — The Distribution class
-------------------------------------------------

This module provides the *note Distribution: 4301. class, which
represents the module distribution being built/installed/distributed.


File: python.info,  Node: distutils extension — The Extension class,  Next: distutils debug — Distutils debug mode,  Prev: distutils dist — The Distribution class,  Up: API Reference

17.9.13 ‘distutils.extension’ — The Extension class
---------------------------------------------------

This module provides the ‘Extension’ class, used to describe C/C++
extension modules in setup scripts.


File: python.info,  Node: distutils debug — Distutils debug mode,  Next: distutils errors — Distutils exceptions,  Prev: distutils extension — The Extension class,  Up: API Reference

17.9.14 ‘distutils.debug’ — Distutils debug mode
------------------------------------------------

This module provides the DEBUG flag.


File: python.info,  Node: distutils errors — Distutils exceptions,  Next: distutils fancy_getopt — Wrapper around the standard getopt module,  Prev: distutils debug — Distutils debug mode,  Up: API Reference

17.9.15 ‘distutils.errors’ — Distutils exceptions
-------------------------------------------------

Provides exceptions used by the Distutils modules.  Note that Distutils
modules may raise standard exceptions; in particular, SystemExit is
usually raised for errors that are obviously the end-user’s fault (eg.
bad command-line arguments).

This module is safe to use in ‘from ... import *’ mode; it only exports
symbols whose names start with ‘Distutils’ and end with ‘Error’.


File: python.info,  Node: distutils fancy_getopt — Wrapper around the standard getopt module,  Next: distutils filelist — The FileList class,  Prev: distutils errors — Distutils exceptions,  Up: API Reference

17.9.16 ‘distutils.fancy_getopt’ — Wrapper around the standard getopt module
----------------------------------------------------------------------------

This module provides a wrapper around the standard *note getopt: 87.
module that provides the following additional features:

   * short and long options are tied together

   * options have help strings, so *note fancy_getopt(): 4355. could
     potentially create a complete usage summary

   * options set attributes of a passed-in object

   * boolean options can have “negative aliases” — eg.  if ‘--quiet’ is
     the “negative alias” of ‘--verbose’, then ‘--quiet’ on the command
     line sets `verbose' to false.

 -- Function: distutils.fancy_getopt.fancy_getopt (options,
          negative_opt, object, args)

     Wrapper function.  `options' is a list of ‘(long_option,
     short_option, help_string)’ 3-tuples as described in the
     constructor for *note FancyGetopt: 4356.  `negative_opt' should be
     a dictionary mapping option names to option names, both the key and
     value should be in the `options' list.  `object' is an object which
     will be used to store values (see the *note getopt(): 87. method of
     the *note FancyGetopt: 4356. class).  `args' is the argument list.
     Will use ‘sys.argv[1:]’ if you pass ‘None’ as `args'.

 -- Function: distutils.fancy_getopt.wrap_text (text, width)

     Wraps `text' to less than `width' wide.

 -- Class: distutils.fancy_getopt.FancyGetopt ([option_table=None])

     The option_table is a list of 3-tuples: ‘(long_option,
     short_option, help_string)’

     If an option takes an argument, its `long_option' should have ‘'='’
     appended; `short_option' should just be a single character, no
     ‘':'’ in any case.  `short_option' should be ‘None’ if a
     `long_option' doesn’t have a corresponding `short_option'.  All
     option tuples must have long options.

The *note FancyGetopt: 4356. class provides the following methods:

 -- Method: FancyGetopt.getopt ([args=None, object=None])

     Parse command-line options in args.  Store as attributes on
     `object'.

     If `args' is ‘None’ or not supplied, uses ‘sys.argv[1:]’.  If
     `object' is ‘None’ or not supplied, creates a new ‘OptionDummy’
     instance, stores option values there, and returns a tuple ‘(args,
     object)’.  If `object' is supplied, it is modified in place and
     *note getopt(): 87. just returns `args'; in both cases, the
     returned `args' is a modified copy of the passed-in `args' list,
     which is left untouched.

 -- Method: FancyGetopt.get_option_order ()

     Returns the list of ‘(option, value)’ tuples processed by the
     previous run of *note getopt(): 87. Raises *note RuntimeError: 2b8.
     if *note getopt(): 87. hasn’t been called yet.

 -- Method: FancyGetopt.generate_help ([header=None])

     Generate help text (a list of strings, one per suggested line of
     output) from the option table for this *note FancyGetopt: 4356.
     object.

     If supplied, prints the supplied `header' at the top of the help.


File: python.info,  Node: distutils filelist — The FileList class,  Next: distutils log — Simple PEP 282-style logging,  Prev: distutils fancy_getopt — Wrapper around the standard getopt module,  Up: API Reference

17.9.17 ‘distutils.filelist’ — The FileList class
-------------------------------------------------

This module provides the ‘FileList’ class, used for poking about the
filesystem and building lists of files.


File: python.info,  Node: distutils log — Simple PEP 282-style logging,  Next: distutils spawn — Spawn a sub-process,  Prev: distutils filelist — The FileList class,  Up: API Reference

17.9.18 ‘distutils.log’ — Simple
--------------------------------

`PEP 282'-style logging


File: python.info,  Node: distutils spawn — Spawn a sub-process,  Next: distutils sysconfig — System configuration information,  Prev: distutils log — Simple PEP 282-style logging,  Up: API Reference

17.9.19 ‘distutils.spawn’ — Spawn a sub-process
-----------------------------------------------

This module provides the ‘spawn()’ function, a front-end to various
platform-specific functions for launching another program in a
sub-process.  Also provides ‘find_executable()’ to search the path for a
given executable name.


File: python.info,  Node: distutils sysconfig — System configuration information,  Next: distutils text_file — The TextFile class,  Prev: distutils spawn — Spawn a sub-process,  Up: API Reference

17.9.20 ‘distutils.sysconfig’ — System configuration information
----------------------------------------------------------------

The *note distutils.sysconfig: 62. module provides access to Python’s
low-level configuration information.  The specific configuration
variables available depend heavily on the platform and configuration.
The specific variables depend on the build process for the specific
version of Python being run; the variables are those found in the
‘Makefile’ and configuration header that are installed with Python on
Unix systems.  The configuration header is called ‘pyconfig.h’ for
Python versions starting with 2.2, and ‘config.h’ for earlier versions
of Python.

Some additional functions are provided which perform some useful
manipulations for other parts of the *note distutils: 39. package.

 -- Data: distutils.sysconfig.PREFIX

     The result of ‘os.path.normpath(sys.prefix)’.

 -- Data: distutils.sysconfig.EXEC_PREFIX

     The result of ‘os.path.normpath(sys.exec_prefix)’.

 -- Function: distutils.sysconfig.get_config_var (name)

     Return the value of a single variable.  This is equivalent to
     ‘get_config_vars().get(name)’.

 -- Function: distutils.sysconfig.get_config_vars (...)

     Return a set of variable definitions.  If there are no arguments,
     this returns a dictionary mapping names of configuration variables
     to values.  If arguments are provided, they should be strings, and
     the return value will be a sequence giving the associated values.
     If a given name does not have a corresponding value, ‘None’ will be
     included for that variable.

 -- Function: distutils.sysconfig.get_config_h_filename ()

     Return the full path name of the configuration header.  For Unix,
     this will be the header generated by the ‘configure’ script; for
     other platforms the header will have been supplied directly by the
     Python source distribution.  The file is a platform-specific text
     file.

 -- Function: distutils.sysconfig.get_makefile_filename ()

     Return the full path name of the ‘Makefile’ used to build Python.
     For Unix, this will be a file generated by the ‘configure’ script;
     the meaning for other platforms will vary.  The file is a
     platform-specific text file, if it exists.  This function is only
     useful on POSIX platforms.

 -- Function: distutils.sysconfig.get_python_inc ([plat_specific[,
          prefix]])

     Return the directory for either the general or platform-dependent C
     include files.  If `plat_specific' is true, the platform-dependent
     include directory is returned; if false or omitted, the
     platform-independent directory is returned.  If `prefix' is given,
     it is used as either the prefix instead of *note PREFIX: 435f, or
     as the exec-prefix instead of *note EXEC_PREFIX: 4360. if
     `plat_specific' is true.

 -- Function: distutils.sysconfig.get_python_lib ([plat_specific[,
          standard_lib[, prefix]]])

     Return the directory for either the general or platform-dependent
     library installation.  If `plat_specific' is true, the
     platform-dependent include directory is returned; if false or
     omitted, the platform-independent directory is returned.  If
     `prefix' is given, it is used as either the prefix instead of *note
     PREFIX: 435f, or as the exec-prefix instead of *note EXEC_PREFIX:
     4360. if `plat_specific' is true.  If `standard_lib' is true, the
     directory for the standard library is returned rather than the
     directory for the installation of third-party extensions.

The following function is only intended for use within the *note
distutils: 39. package.

 -- Function: distutils.sysconfig.customize_compiler (compiler)

     Do any platform-specific customization of a *note
     distutils.ccompiler.CCompiler: 4305. instance.

     This function is only needed on Unix at this time, but should be
     called consistently to support forward-compatibility.  It inserts
     the information that varies across Unix flavors and is stored in
     Python’s ‘Makefile’.  This information includes the selected
     compiler, compiler and linker options, and the extension used by
     the linker for shared objects.

This function is even more special-purpose, and should only be used from
Python’s own build procedures.

 -- Function: distutils.sysconfig.set_python_build ()

     Inform the *note distutils.sysconfig: 62. module that it is being
     used as part of the build process for Python.  This changes a lot
     of relative locations for files, allowing them to be located in the
     build area rather than in an installed Python.


File: python.info,  Node: distutils text_file — The TextFile class,  Next: distutils version — Version number classes,  Prev: distutils sysconfig — System configuration information,  Up: API Reference

17.9.21 ‘distutils.text_file’ — The TextFile class
--------------------------------------------------

This module provides the *note TextFile: 436a. class, which gives an
interface to text files that (optionally) takes care of stripping
comments, ignoring blank lines, and joining lines with backslashes.

 -- Class: distutils.text_file.TextFile ([filename=None, file=None,
          **options])

     This class provides a file-like object that takes care of all the
     things you commonly want to do when processing a text file that has
     some line-by-line syntax: strip comments (as long as ‘#’ is your
     comment character), skip blank lines, join adjacent lines by
     escaping the newline (ie.  backslash at end of line), strip leading
     and/or trailing whitespace.  All of these are optional and
     independently controllable.

     The class provides a *note warn(): 436b. method so you can generate
     warning messages that report physical line number, even if the
     logical line in question spans multiple physical lines.  Also
     provides *note unreadline(): 436c. for implementing line-at-a-time
     lookahead.

     *note TextFile: 436a. instances are create with either `filename',
     `file', or both.  *note RuntimeError: 2b8. is raised if both are
     ‘None’.  `filename' should be a string, and `file' a file object
     (or something that provides *note readline(): de. and *note
     close(): 436d. methods).  It is recommended that you supply at
     least `filename', so that *note TextFile: 436a. can include it in
     warning messages.  If `file' is not supplied, *note TextFile: 436a.
     creates its own using the *note open(): 4e5. built-in function.

     The options are all boolean, and affect the values returned by
     *note readline(): de.

     option name            description                          default
                                                                 
     --------------------------------------------------------------------------
                                                                 
     `strip_comments'       strip from ‘'#'’ to end-of-line,     true
                            as well as any whitespace leading    
                            up to the ‘'#'’—unless it is
                            escaped by a backslash
                            
                                                                 
     `lstrip_ws'            strip leading whitespace from each   false
                            line before returning it             
                            
                                                                 
     `rstrip_ws'            strip trailing whitespace            true
                            (including line terminator!)  from   
                            each line before returning it.
                            
                                                                 
     `skip_blanks'          skip lines that are empty *after*    true
                            stripping comments and whitespace.   
                            (If both lstrip_ws and rstrip_ws
                            are false, then some lines may
                            consist of solely whitespace:
                            these will *not* be skipped, even
                            if `skip_blanks' is true.)
                            
                                                                 
     `join_lines'           if a backslash is the last           false
                            non-newline character on a line      
                            after stripping comments and
                            whitespace, join the following
                            line to it to form one logical
                            line; if N consecutive lines end
                            with a backslash, then N+1
                            physical lines will be joined to
                            form one logical line.
                            
                                                                 
     `collapse_join'        strip leading whitespace from        false
                            lines that are joined to their       
                            predecessor; only matters if
                            ‘(join_lines and not lstrip_ws)’
                            

     Note that since `rstrip_ws' can strip the trailing newline, the
     semantics of *note readline(): de. must differ from those of the
     built-in file object’s *note readline(): de. method!  In
     particular, *note readline(): de. returns ‘None’ for end-of-file:
     an empty string might just be a blank line (or an all-whitespace
     line), if `rstrip_ws' is true but `skip_blanks' is not.

      -- Method: open (filename)

          Open a new file `filename'.  This overrides any `file' or
          `filename' constructor arguments.

      -- Method: close ()

          Close the current file and forget everything we know about it
          (including the filename and the current line number).

      -- Method: warn (msg[, line=None])

          Print (to stderr) a warning message tied to the current
          logical line in the current file.  If the current logical line
          in the file spans multiple physical lines, the warning refers
          to the whole range, such as ‘"lines 3-5"’.  If `line' is
          supplied, it overrides the current line number; it may be a
          list or tuple to indicate a range of physical lines, or an
          integer for a single physical line.

      -- Method: readline ()

          Read and return a single logical line from the current file
          (or from an internal buffer if lines have previously been
          “unread” with *note unreadline(): 436c.).  If the `join_lines'
          option is true, this may involve reading multiple physical
          lines concatenated into a single string.  Updates the current
          line number, so calling *note warn(): 436b. after *note
          readline(): de. emits a warning about the physical line(s)
          just read.  Returns ‘None’ on end-of-file, since the empty
          string can occur if `rstrip_ws' is true but `strip_blanks' is
          not.

      -- Method: readlines ()

          Read and return the list of all logical lines remaining in the
          current file.  This updates the current line number to the
          last line of the file.

      -- Method: unreadline (line)

          Push `line' (a string) onto an internal buffer that will be
          checked by future *note readline(): de. calls.  Handy for
          implementing a parser with line-at-a-time lookahead.  Note
          that lines that are “unread” with *note unreadline(): 436c.
          are not subsequently re-cleansed (whitespace stripped, or
          whatever) when read with *note readline(): de.  If multiple
          calls are made to *note unreadline(): 436c. before a call to
          *note readline(): de, the lines will be returned most in most
          recent first order.


File: python.info,  Node: distutils version — Version number classes,  Next: distutils cmd — Abstract base class for Distutils commands,  Prev: distutils text_file — The TextFile class,  Up: API Reference

17.9.22 ‘distutils.version’ — Version number classes
----------------------------------------------------


File: python.info,  Node: distutils cmd — Abstract base class for Distutils commands,  Next: Creating a new Distutils command,  Prev: distutils version — Version number classes,  Up: API Reference

17.9.23 ‘distutils.cmd’ — Abstract base class for Distutils commands
--------------------------------------------------------------------

This module supplies the abstract base class *note Command: 42f0.

 -- Class: distutils.cmd.Command (dist)

     Abstract base class for defining command classes, the “worker bees”
     of the Distutils.  A useful analogy for command classes is to think
     of them as subroutines with local variables called `options'.  The
     options are declared in *note initialize_options(): 4373. and
     defined (given their final values) in *note finalize_options():
     4374, both of which must be defined by every command class.  The
     distinction between the two is necessary because option values
     might come from the outside world (command line, config file, …),
     and any options dependent on other options must be computed after
     these outside influences have been processed — hence *note
     finalize_options(): 4374.  The body of the subroutine, where it
     does all its work based on the values of its options, is the *note
     run(): 4375. method, which must also be implemented by every
     command class.

     The class constructor takes a single argument `dist', a *note
     Distribution: 4301. instance.


File: python.info,  Node: Creating a new Distutils command,  Next: distutils command — Individual Distutils commands,  Prev: distutils cmd — Abstract base class for Distutils commands,  Up: API Reference

17.9.24 Creating a new Distutils command
----------------------------------------

This section outlines the steps to create a new Distutils command.

A new command lives in a module in the *note distutils.command: 3e.
package.  There is a sample template in that directory called
‘command_template’.  Copy this file to a new module with the same name
as the new command you’re implementing.  This module should implement a
class with the same name as the module (and the command).  So, for
instance, to create the command ‘peel_banana’ (so that users can run
‘setup.py peel_banana’), you’d copy ‘command_template’ to
‘distutils/command/peel_banana.py’, then edit it so that it’s
implementing the class ‘peel_banana’, a subclass of *note
distutils.cmd.Command: 42f0.

Subclasses of *note Command: 42f0. must define the following methods.

 -- Method: Command.initialize_options ()

     Set default values for all the options that this command supports.
     Note that these defaults may be overridden by other commands, by
     the setup script, by config files, or by the command-line.  Thus,
     this is not the place to code dependencies between options;
     generally, *note initialize_options(): 4373. implementations are
     just a bunch of ‘self.foo = None’ assignments.

 -- Method: Command.finalize_options ()

     Set final values for all the options that this command supports.
     This is always called as late as possible, ie.  after any option
     assignments from the command-line or from other commands have been
     done.  Thus, this is the place to code option dependencies: if
     `foo' depends on `bar', then it is safe to set `foo' from `bar' as
     long as `foo' still has the same value it was assigned in *note
     initialize_options(): 4373.

 -- Method: Command.run ()

     A command’s raison d’etre: carry out the action it exists to
     perform, controlled by the options initialized in *note
     initialize_options(): 4373, customized by other commands, the setup
     script, the command-line, and config files, and finalized in *note
     finalize_options(): 4374.  All terminal output and filesystem
     interaction should be done by *note run(): 4375.

 -- Attribute: Command.sub_commands

     `sub_commands' formalizes the notion of a “family” of commands,
     e.g.  ‘install’ as the parent with sub-commands ‘install_lib’,
     ‘install_headers’, etc.  The parent of a family of commands defines
     `sub_commands' as a class attribute; it’s a list of 2-tuples
     ‘(command_name, predicate)’, with `command_name' a string and
     `predicate' a function, a string or ‘None’.  `predicate' is a
     method of the parent command that determines whether the
     corresponding command is applicable in the current situation.
     (E.g.  ‘install_headers’ is only applicable if we have any C header
     files to install.)  If `predicate' is ‘None’, that command is
     always applicable.

     `sub_commands' is usually defined at the `end' of a class, because
     predicates can be methods of the class, so they must already have
     been defined.  The canonical example is the ‘install’ command.


File: python.info,  Node: distutils command — Individual Distutils commands,  Next: distutils command bdist — Build a binary installer,  Prev: Creating a new Distutils command,  Up: API Reference

17.9.25 ‘distutils.command’ — Individual Distutils commands
-----------------------------------------------------------


File: python.info,  Node: distutils command bdist — Build a binary installer,  Next: distutils command bdist_packager — Abstract base class for packagers,  Prev: distutils command — Individual Distutils commands,  Up: API Reference

17.9.26 ‘distutils.command.bdist’ — Build a binary installer
------------------------------------------------------------


File: python.info,  Node: distutils command bdist_packager — Abstract base class for packagers,  Next: distutils command bdist_dumb — Build a “dumb” installer,  Prev: distutils command bdist — Build a binary installer,  Up: API Reference

17.9.27 ‘distutils.command.bdist_packager’ — Abstract base class for packagers
------------------------------------------------------------------------------


File: python.info,  Node: distutils command bdist_dumb — Build a “dumb” installer,  Next: distutils command bdist_msi — Build a Microsoft Installer binary package,  Prev: distutils command bdist_packager — Abstract base class for packagers,  Up: API Reference

17.9.28 ‘distutils.command.bdist_dumb’ — Build a “dumb” installer
-----------------------------------------------------------------


File: python.info,  Node: distutils command bdist_msi — Build a Microsoft Installer binary package,  Next: distutils command bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM,  Prev: distutils command bdist_dumb — Build a “dumb” installer,  Up: API Reference

17.9.29 ‘distutils.command.bdist_msi’ — Build a Microsoft Installer binary package
----------------------------------------------------------------------------------

 -- Class: distutils.command.bdist_msi.bdist_msi

     Builds a Windows Installer(1) (.msi) binary package.

     In most cases, the ‘bdist_msi’ installer is a better choice than
     the ‘bdist_wininst’ installer, because it provides better support
     for Win64 platforms, allows administrators to perform
     non-interactive installations, and allows installation through
     group policies.

   ---------- Footnotes ----------

   (1) https://msdn.microsoft.com/en-us/library/cc185688(VS.85).aspx


File: python.info,  Node: distutils command bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM,  Next: distutils command bdist_wininst — Build a Windows installer,  Prev: distutils command bdist_msi — Build a Microsoft Installer binary package,  Up: API Reference

17.9.30 ‘distutils.command.bdist_rpm’ — Build a binary distribution as a Redhat RPM and SRPM
--------------------------------------------------------------------------------------------


File: python.info,  Node: distutils command bdist_wininst — Build a Windows installer,  Next: distutils command sdist — Build a source distribution,  Prev: distutils command bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM,  Up: API Reference

17.9.31 ‘distutils.command.bdist_wininst’ — Build a Windows installer
---------------------------------------------------------------------

Deprecated since version 3.8: Use bdist_wheel (wheel packages) instead.


File: python.info,  Node: distutils command sdist — Build a source distribution,  Next: distutils command build — Build all files of a package,  Prev: distutils command bdist_wininst — Build a Windows installer,  Up: API Reference

17.9.32 ‘distutils.command.sdist’ — Build a source distribution
---------------------------------------------------------------


File: python.info,  Node: distutils command build — Build all files of a package,  Next: distutils command build_clib — Build any C libraries in a package,  Prev: distutils command sdist — Build a source distribution,  Up: API Reference

17.9.33 ‘distutils.command.build’ — Build all files of a package
----------------------------------------------------------------


File: python.info,  Node: distutils command build_clib — Build any C libraries in a package,  Next: distutils command build_ext — Build any extensions in a package,  Prev: distutils command build — Build all files of a package,  Up: API Reference

17.9.34 ‘distutils.command.build_clib’ — Build any C libraries in a package
---------------------------------------------------------------------------


File: python.info,  Node: distutils command build_ext — Build any extensions in a package,  Next: distutils command build_py — Build the py/ pyc files of a package,  Prev: distutils command build_clib — Build any C libraries in a package,  Up: API Reference

17.9.35 ‘distutils.command.build_ext’ — Build any extensions in a package
-------------------------------------------------------------------------


File: python.info,  Node: distutils command build_py — Build the py/ pyc files of a package,  Next: distutils command build_scripts — Build the scripts of a package,  Prev: distutils command build_ext — Build any extensions in a package,  Up: API Reference

17.9.36 ‘distutils.command.build_py’ — Build the .py/.pyc files of a package
----------------------------------------------------------------------------

 -- Class: distutils.command.build_py.build_py

 -- Class: distutils.command.build_py.build_py_2to3

     Alternative implementation of build_py which also runs the 2to3
     conversion library on each .py file that is going to be installed.
     To use this in a setup.py file for a distribution that is designed
     to run with both Python 2.x and 3.x, add:

          try:     from distutils.command.build_py import build_py_2to3 as build_py except ImportError:     from distutils.command.build_py import build_py

     to your setup.py, and later:

          cmdclass = {'build_py': build_py}

     to the invocation of setup().


File: python.info,  Node: distutils command build_scripts — Build the scripts of a package,  Next: distutils command clean — Clean a package build area,  Prev: distutils command build_py — Build the py/ pyc files of a package,  Up: API Reference

17.9.37 ‘distutils.command.build_scripts’ — Build the scripts of a package
--------------------------------------------------------------------------


File: python.info,  Node: distutils command clean — Clean a package build area,  Next: distutils command config — Perform package configuration,  Prev: distutils command build_scripts — Build the scripts of a package,  Up: API Reference

17.9.38 ‘distutils.command.clean’ — Clean a package build area
--------------------------------------------------------------

This command removes the temporary files created by ‘build’ and its
subcommands, like intermediary compiled object files.  With the ‘--all’
option, the complete build directory will be removed.

Extension modules built *note in place: 42c9. will not be cleaned, as
they are not in the build directory.


File: python.info,  Node: distutils command config — Perform package configuration,  Next: distutils command install — Install a package,  Prev: distutils command clean — Clean a package build area,  Up: API Reference

17.9.39 ‘distutils.command.config’ — Perform package configuration
------------------------------------------------------------------


File: python.info,  Node: distutils command install — Install a package,  Next: distutils command install_data — Install data files from a package,  Prev: distutils command config — Perform package configuration,  Up: API Reference

17.9.40 ‘distutils.command.install’ — Install a package
-------------------------------------------------------


File: python.info,  Node: distutils command install_data — Install data files from a package,  Next: distutils command install_headers — Install C/C++ header files from a package,  Prev: distutils command install — Install a package,  Up: API Reference

17.9.41 ‘distutils.command.install_data’ — Install data files from a package
----------------------------------------------------------------------------


File: python.info,  Node: distutils command install_headers — Install C/C++ header files from a package,  Next: distutils command install_lib — Install library files from a package,  Prev: distutils command install_data — Install data files from a package,  Up: API Reference

17.9.42 ‘distutils.command.install_headers’ — Install C/C++ header files from a package
---------------------------------------------------------------------------------------


File: python.info,  Node: distutils command install_lib — Install library files from a package,  Next: distutils command install_scripts — Install script files from a package,  Prev: distutils command install_headers — Install C/C++ header files from a package,  Up: API Reference

17.9.43 ‘distutils.command.install_lib’ — Install library files from a package
------------------------------------------------------------------------------


File: python.info,  Node: distutils command install_scripts — Install script files from a package,  Next: distutils command register — Register a module with the Python Package Index,  Prev: distutils command install_lib — Install library files from a package,  Up: API Reference

17.9.44 ‘distutils.command.install_scripts’ — Install script files from a package
---------------------------------------------------------------------------------


File: python.info,  Node: distutils command register — Register a module with the Python Package Index,  Next: distutils command check — Check the meta-data of a package,  Prev: distutils command install_scripts — Install script files from a package,  Up: API Reference

17.9.45 ‘distutils.command.register’ — Register a module with the Python Package Index
--------------------------------------------------------------------------------------

The ‘register’ command registers the package with the Python Package
Index.  This is described in more detail in PEP 301(1).

   ---------- Footnotes ----------

   (1) https://www.python.org/dev/peps/pep-0301


File: python.info,  Node: distutils command check — Check the meta-data of a package,  Prev: distutils command register — Register a module with the Python Package Index,  Up: API Reference

17.9.46 ‘distutils.command.check’ — Check the meta-data of a package
--------------------------------------------------------------------

The ‘check’ command performs some tests on the meta-data of a package.
For example, it verifies that all required meta-data are provided as the
arguments passed to the ‘setup()’ function.


File: python.info,  Node: Installing Python Modules Legacy version,  Next: Python Module Index,  Prev: Distributing Python Modules Legacy version,  Up: Top

18 Installing Python Modules (Legacy version)
*********************************************


Author: Greg Ward

See also
........

*note Installing Python Modules: 7e9.

     The up to date module installation documentation.  For regular
     Python usage, you almost certainly want that document rather than
     this one.

     Note: This document is being retained solely until the ‘setuptools’
     documentation at
     ‘https://setuptools.readthedocs.io/en/latest/setuptools.html’
     independently covers all of the relevant information currently
     included here.

     Note: This guide only covers the basic tools for building and
     distributing extensions that are provided as part of this version
     of Python.  Third party tools offer easier to use and more secure
     alternatives.  Refer to the quick recommendations section(1) in the
     Python Packaging User Guide for more information.

* Menu:

* Introduction: Introduction<17>.
* Standard Build and Install::
* Alternate Installation::
* Custom Installation::
* Distutils Configuration Files::
* Building Extensions; Tips and Tricks: Building Extensions Tips and Tricks.

   ---------- Footnotes ----------

   (1) https://packaging.python.org/guides/tool-recommendations/


File: python.info,  Node: Introduction<17>,  Next: Standard Build and Install,  Up: Installing Python Modules Legacy version

18.1 Introduction
=================

In Python 2.0, the ‘distutils’ API was first added to the standard
library.  This provided Linux distro maintainers with a standard way of
converting Python projects into Linux distro packages, and system
administrators with a standard way of installing them directly onto
target systems.

In the many years since Python 2.0 was released, tightly coupling the
build system and package installer to the language runtime release cycle
has turned out to be problematic, and it is now recommended that
projects use the ‘pip’ package installer and the ‘setuptools’ build
system, rather than using ‘distutils’ directly.

See *note Installing Python Modules: 7e9. and *note Distributing Python
Modules: 7ea. for more details.

This legacy documentation is being retained only until we’re confident
that the ‘setuptools’ documentation covers everything needed.

* Menu:

* Distutils based source distributions::


File: python.info,  Node: Distutils based source distributions,  Up: Introduction<17>

18.1.1 Distutils based source distributions
-------------------------------------------

If you download a module source distribution, you can tell pretty
quickly if it was packaged and distributed in the standard way, i.e.
using the Distutils.  First, the distribution’s name and version number
will be featured prominently in the name of the downloaded archive, e.g.
‘foo-1.0.tar.gz’ or ‘widget-0.9.7.zip’.  Next, the archive will unpack
into a similarly-named directory: ‘foo-1.0’ or ‘widget-0.9.7’.
Additionally, the distribution will contain a setup script ‘setup.py’,
and a file named ‘README.txt’ or possibly just ‘README’, which should
explain that building and installing the module distribution is a simple
matter of running one command from a terminal:

     python setup.py install

For Windows, this command should be run from a command prompt window
(Start ‣ Accessories):

     setup.py install

If all these things are true, then you already know how to build and
install the modules you’ve just downloaded: Run the command above.
Unless you need to install things in a non-standard way or customize the
build process, you don’t really need this manual.  Or rather, the above
command is everything you need to get out of this manual.


File: python.info,  Node: Standard Build and Install,  Next: Alternate Installation,  Prev: Introduction<17>,  Up: Installing Python Modules Legacy version

18.2 Standard Build and Install
===============================

As described in section *note Distutils based source distributions:
4396, building and installing a module distribution using the Distutils
is usually one simple command to run from a terminal:

     python setup.py install

* Menu:

* Platform variations::
* Splitting the job up::
* How building works::
* How installation works::


File: python.info,  Node: Platform variations,  Next: Splitting the job up,  Up: Standard Build and Install

18.2.1 Platform variations
--------------------------

You should always run the setup command from the distribution root
directory, i.e.  the top-level subdirectory that the module source
distribution unpacks into.  For example, if you’ve just downloaded a
module source distribution ‘foo-1.0.tar.gz’ onto a Unix system, the
normal thing to do is:

     gunzip -c foo-1.0.tar.gz | tar xf -    # unpacks into directory foo-1.0 cd foo-1.0 python setup.py install

On Windows, you’d probably download ‘foo-1.0.zip’.  If you downloaded
the archive file to ‘C:\Temp’, then it would unpack into
‘C:\Temp\foo-1.0’; you can use either an archive manipulator with a
graphical user interface (such as WinZip) or a command-line tool (such
as ‘unzip’ or ‘pkunzip’) to unpack the archive.  Then, open a command
prompt window and run:

     cd c:\Temp\foo-1.0 python setup.py install


File: python.info,  Node: Splitting the job up,  Next: How building works,  Prev: Platform variations,  Up: Standard Build and Install

18.2.2 Splitting the job up
---------------------------

Running ‘setup.py install’ builds and installs all modules in one run.
If you prefer to work incrementally—especially useful if you want to
customize the build process, or if things are going wrong—you can use
the setup script to do one thing at a time.  This is particularly
helpful when the build and install will be done by different users—for
example, you might want to build a module distribution and hand it off
to a system administrator for installation (or do it yourself, with
super-user privileges).

For example, you can build everything in one step, and then install
everything in a second step, by invoking the setup script twice:

     python setup.py build python setup.py install

If you do this, you will notice that running the ‘install’ command first
runs the ‘build’ command, which—in this case—quickly notices that it has
nothing to do, since everything in the ‘build’ directory is up-to-date.

You may not need this ability to break things down often if all you do
is install modules downloaded off the ‘net, but it’s very handy for more
advanced tasks.  If you get into distributing your own Python modules
and extensions, you’ll run lots of individual Distutils commands on
their own.


File: python.info,  Node: How building works,  Next: How installation works,  Prev: Splitting the job up,  Up: Standard Build and Install

18.2.3 How building works
-------------------------

As implied above, the ‘build’ command is responsible for putting the
files to install into a `build directory'.  By default, this is ‘build’
under the distribution root; if you’re excessively concerned with speed,
or want to keep the source tree pristine, you can change the build
directory with the ‘--build-base’ option.  For example:

     python setup.py build --build-base=/path/to/pybuild/foo-1.0

(Or you could do this permanently with a directive in your system or
personal Distutils configuration file; see section *note Distutils
Configuration Files: 439f.)  Normally, this isn’t necessary.

The default layout for the build tree is as follows:

     --- build/ --- lib/ or --- build/ --- lib.<plat>/                temp.<plat>/

where ‘<plat>’ expands to a brief description of the current OS/hardware
platform and Python version.  The first form, with just a ‘lib’
directory, is used for “pure module distributions”—that is, module
distributions that include only pure Python modules.  If a module
distribution contains any extensions (modules written in C/C++), then
the second form, with two ‘<plat>’ directories, is used.  In that case,
the ‘temp.`plat'’ directory holds temporary files generated by the
compile/link process that don’t actually get installed.  In either case,
the ‘lib’ (or ‘lib.`plat'’) directory contains all Python modules (pure
Python and extensions) that will be installed.

In the future, more directories will be added to handle Python scripts,
documentation, binary executables, and whatever else is needed to handle
the job of installing Python modules and applications.


File: python.info,  Node: How installation works,  Prev: How building works,  Up: Standard Build and Install

18.2.4 How installation works
-----------------------------

After the ‘build’ command runs (whether you run it explicitly, or the
‘install’ command does it for you), the work of the ‘install’ command is
relatively simple: all it has to do is copy everything under ‘build/lib’
(or ‘build/lib.`plat'’) to your chosen installation directory.

If you don’t choose an installation directory—i.e., if you just run
‘setup.py install’—then the ‘install’ command installs to the standard
location for third-party Python modules.  This location varies by
platform and by how you built/installed Python itself.  On Unix (and Mac
OS X, which is also Unix-based), it also depends on whether the module
distribution being installed is pure Python or contains extensions
(“non-pure”):

Platform              Standard installation location                            Default value                                          Notes
                                                                                                                                       
---------------------------------------------------------------------------------------------------------------------------------------------------
                                                                                                                                       
Unix (pure)           ‘`prefix'/lib/python`X.Y'/site-packages’                  ‘/usr/local/lib/python`X.Y'/site-packages’             (1)
                                                                                                                                       
                                                                                                                                       
Unix (non-pure)       ‘`exec-prefix'/lib/python`X.Y'/site-packages’             ‘/usr/local/lib/python`X.Y'/site-packages’             (1)
                                                                                                                                       
                                                                                                                                       
Windows               ‘`prefix'\Lib\site-packages’                              ‘C:\Python`XY'\Lib\site-packages’                      (2)
                                                                                                                                       

Notes:

  1. Most Linux distributions include Python as a standard part of the
     system, so ‘`prefix'’ and ‘`exec-prefix'’ are usually both ‘/usr’
     on Linux.  If you build Python yourself on Linux (or any Unix-like
     system), the default ‘`prefix'’ and ‘`exec-prefix'’ are
     ‘/usr/local’.

  2. The default installation directory on Windows was ‘C:\Program
     Files\Python’ under Python 1.6a1, 1.5.2, and earlier.

‘`prefix'’ and ‘`exec-prefix'’ stand for the directories that Python is
installed to, and where it finds its libraries at run-time.  They are
always the same under Windows, and very often the same under Unix and
Mac OS X. You can find out what your Python installation uses for
‘`prefix'’ and ‘`exec-prefix'’ by running Python in interactive mode and
typing a few simple commands.  Under Unix, just type ‘python’ at the
shell prompt.  Under Windows, choose Start ‣ Programs ‣ Python X.Y ‣
Python (command line).  Once the interpreter is started, you type Python
code at the prompt.  For example, on my Linux system, I type the three
Python statements shown below, and get the output as shown, to find out
my ‘`prefix'’ and ‘`exec-prefix'’:

     Python 2.4 (#26, Aug  7 2004, 17:19:02) Type "help", "copyright", "credits" or "license" for more information. >>> import sys >>> sys.prefix '/usr' >>> sys.exec_prefix '/usr'

A few other placeholders are used in this document: ‘`X.Y'’ stands for
the version of Python, for example ‘3.2’; ‘`abiflags'’ will be replaced
by the value of *note sys.abiflags: 262. or the empty string for
platforms which don’t define ABI flags; ‘`distname'’ will be replaced by
the name of the module distribution being installed.  Dots and
capitalization are important in the paths; for example, a value that
uses ‘python3.2’ on UNIX will typically use ‘Python32’ on Windows.

If you don’t want to install modules to the standard location, or if you
don’t have permission to write there, then you need to read about
alternate installations in section *note Alternate Installation: 43a2.
If you want to customize your installation directories more heavily, see
section *note Custom Installation: 43a3. on custom installations.


File: python.info,  Node: Alternate Installation,  Next: Custom Installation,  Prev: Standard Build and Install,  Up: Installing Python Modules Legacy version

18.3 Alternate Installation
===========================

Often, it is necessary or desirable to install modules to a location
other than the standard location for third-party Python modules.  For
example, on a Unix system you might not have permission to write to the
standard third-party module directory.  Or you might wish to try out a
module before making it a standard part of your local Python
installation.  This is especially true when upgrading a distribution
already present: you want to make sure your existing base of scripts
still works with the new version before actually upgrading.

The Distutils ‘install’ command is designed to make installing module
distributions to an alternate location simple and painless.  The basic
idea is that you supply a base directory for the installation, and the
‘install’ command picks a set of directories (called an `installation
scheme') under this base directory in which to install files.  The
details differ across platforms, so read whichever of the following
sections applies to you.

Note that the various alternate installation schemes are mutually
exclusive: you can pass ‘--user’, or ‘--home’, or ‘--prefix’ and
‘--exec-prefix’, or ‘--install-base’ and ‘--install-platbase’, but you
can’t mix from these groups.

* Menu:

* Alternate installation; the user scheme: Alternate installation the user scheme.
* Alternate installation; the home scheme: Alternate installation the home scheme.
* Alternate installation; Unix (the prefix scheme): Alternate installation Unix the prefix scheme.
* Alternate installation; Windows (the prefix scheme): Alternate installation Windows the prefix scheme.


File: python.info,  Node: Alternate installation the user scheme,  Next: Alternate installation the home scheme,  Up: Alternate Installation

18.3.1 Alternate installation: the user scheme
----------------------------------------------

This scheme is designed to be the most convenient solution for users
that don’t have write permission to the global site-packages directory
or don’t want to install into it.  It is enabled with a simple option:

     python setup.py install --user

Files will be installed into subdirectories of *note site.USER_BASE:
1293. (written as ‘`userbase'’ hereafter).  This scheme installs pure
Python modules and extension modules in the same location (also known as
*note site.USER_SITE: 1281.).  Here are the values for UNIX, including
Mac OS X:

Type of file        Installation directory
                    
------------------------------------------------------------------------------------
                    
modules             ‘`userbase'/lib/python`X.Y'/site-packages’
                    
                    
scripts             ‘`userbase'/bin’
                    
                    
data                ‘`userbase'’
                    
                    
C headers           ‘`userbase'/include/python`X.Y'`abiflags'/`distname'’
                    

And here are the values used on Windows:

Type of file        Installation directory
                    
------------------------------------------------------------------------------------
                    
modules             ‘`userbase'\Python`XY'\site-packages’
                    
                    
scripts             ‘`userbase'\Python`XY'\Scripts’
                    
                    
data                ‘`userbase'’
                    
                    
C headers           ‘`userbase'\Python`XY'\Include{distname}’
                    

The advantage of using this scheme compared to the other ones described
below is that the user site-packages directory is under normal
conditions always included in *note sys.path: 47d. (see *note site: eb.
for more information), which means that there is no additional step to
perform after running the ‘setup.py’ script to finalize the
installation.

The ‘build_ext’ command also has a ‘--user’ option to add
‘`userbase'/include’ to the compiler search path for header files and
‘`userbase'/lib’ to the compiler search path for libraries as well as to
the runtime search path for shared C libraries (rpath).


File: python.info,  Node: Alternate installation the home scheme,  Next: Alternate installation Unix the prefix scheme,  Prev: Alternate installation the user scheme,  Up: Alternate Installation

18.3.2 Alternate installation: the home scheme
----------------------------------------------

The idea behind the “home scheme” is that you build and maintain a
personal stash of Python modules.  This scheme’s name is derived from
the idea of a “home” directory on Unix, since it’s not unusual for a
Unix user to make their home directory have a layout similar to ‘/usr/’
or ‘/usr/local/’.  This scheme can be used by anyone, regardless of the
operating system they are installing for.

Installing a new module distribution is as simple as

     python setup.py install --home=<dir>

where you can supply any directory you like for the ‘--home’ option.  On
Unix, lazy typists can just type a tilde (‘~’); the ‘install’ command
will expand this to your home directory:

     python setup.py install --home=~

To make Python find the distributions installed with this scheme, you
may have to *note modify Python’s search path: 43a8. or edit
‘sitecustomize’ (see *note site: eb.) to call *note site.addsitedir():
364d. or edit *note sys.path: 47d.

The ‘--home’ option defines the installation base directory.  Files are
installed to the following directories under the installation base as
follows:

Type of file        Installation directory
                    
------------------------------------------------------------------------------------
                    
modules             ‘`home'/lib/python’
                    
                    
scripts             ‘`home'/bin’
                    
                    
data                ‘`home'’
                    
                    
C headers           ‘`home'/include/python/`distname'’
                    

(Mentally replace slashes with backslashes if you’re on Windows.)


File: python.info,  Node: Alternate installation Unix the prefix scheme,  Next: Alternate installation Windows the prefix scheme,  Prev: Alternate installation the home scheme,  Up: Alternate Installation

18.3.3 Alternate installation: Unix (the prefix scheme)
-------------------------------------------------------

The “prefix scheme” is useful when you wish to use one Python
installation to perform the build/install (i.e., to run the setup
script), but install modules into the third-party module directory of a
different Python installation (or something that looks like a different
Python installation).  If this sounds a trifle unusual, it is—that’s why
the user and home schemes come before.  However, there are at least two
known cases where the prefix scheme will be useful.

First, consider that many Linux distributions put Python in ‘/usr’,
rather than the more traditional ‘/usr/local’.  This is entirely
appropriate, since in those cases Python is part of “the system” rather
than a local add-on.  However, if you are installing Python modules from
source, you probably want them to go in ‘/usr/local/lib/python2.`X'’
rather than ‘/usr/lib/python2.`X'’.  This can be done with

     /usr/bin/python setup.py install --prefix=/usr/local

Another possibility is a network filesystem where the name used to write
to a remote directory is different from the name used to read it: for
example, the Python interpreter accessed as ‘/usr/local/bin/python’
might search for modules in ‘/usr/local/lib/python2.`X'’, but those
modules would have to be installed to, say,
‘/mnt/`@server'/export/lib/python2.`X'’.  This could be done with

     /usr/local/bin/python setup.py install --prefix=/mnt/@server/export

In either case, the ‘--prefix’ option defines the installation base, and
the ‘--exec-prefix’ option defines the platform-specific installation
base, which is used for platform-specific files.  (Currently, this just
means non-pure module distributions, but could be expanded to C
libraries, binary executables, etc.)  If ‘--exec-prefix’ is not
supplied, it defaults to ‘--prefix’.  Files are installed as follows:

Type of file          Installation directory
                      
-------------------------------------------------------------------------------------
                      
Python modules        ‘`prefix'/lib/python`X.Y'/site-packages’
                      
                      
extension modules     ‘`exec-prefix'/lib/python`X.Y'/site-packages’
                      
                      
scripts               ‘`prefix'/bin’
                      
                      
data                  ‘`prefix'’
                      
                      
C headers             ‘`prefix'/include/python`X.Y'`abiflags'/`distname'’
                      

There is no requirement that ‘--prefix’ or ‘--exec-prefix’ actually
point to an alternate Python installation; if the directories listed
above do not already exist, they are created at installation time.

Incidentally, the real reason the prefix scheme is important is simply
that a standard Unix installation uses the prefix scheme, but with
‘--prefix’ and ‘--exec-prefix’ supplied by Python itself as ‘sys.prefix’
and ‘sys.exec_prefix’.  Thus, you might think you’ll never use the
prefix scheme, but every time you run ‘python setup.py install’ without
any other options, you’re using it.

Note that installing extensions to an alternate Python installation has
no effect on how those extensions are built: in particular, the Python
header files (‘Python.h’ and friends) installed with the Python
interpreter used to run the setup script will be used in compiling
extensions.  It is your responsibility to ensure that the interpreter
used to run extensions installed in this way is compatible with the
interpreter used to build them.  The best way to do this is to ensure
that the two interpreters are the same version of Python (possibly
different builds, or possibly copies of the same build).  (Of course, if
your ‘--prefix’ and ‘--exec-prefix’ don’t even point to an alternate
Python installation, this is immaterial.)


File: python.info,  Node: Alternate installation Windows the prefix scheme,  Prev: Alternate installation Unix the prefix scheme,  Up: Alternate Installation

18.3.4 Alternate installation: Windows (the prefix scheme)
----------------------------------------------------------

Windows has no concept of a user’s home directory, and since the
standard Python installation under Windows is simpler than under Unix,
the ‘--prefix’ option has traditionally been used to install additional
packages in separate locations on Windows.

     python setup.py install --prefix="\Temp\Python"

to install modules to the ‘\Temp\Python’ directory on the current drive.

The installation base is defined by the ‘--prefix’ option; the
‘--exec-prefix’ option is not supported under Windows, which means that
pure Python modules and extension modules are installed into the same
location.  Files are installed as follows:

Type of file        Installation directory
                    
-----------------------------------------------------------------------------------
                    
modules             ‘`prefix'\Lib\site-packages’
                    
                    
scripts             ‘`prefix'\Scripts’
                    
                    
data                ‘`prefix'’
                    
                    
C headers           ‘`prefix'\Include{distname}’
                    


File: python.info,  Node: Custom Installation,  Next: Distutils Configuration Files,  Prev: Alternate Installation,  Up: Installing Python Modules Legacy version

18.4 Custom Installation
========================

Sometimes, the alternate installation schemes described in section *note
Alternate Installation: 43a2. just don’t do what you want.  You might
want to tweak just one or two directories while keeping everything under
the same base directory, or you might want to completely redefine the
installation scheme.  In either case, you’re creating a `custom
installation scheme'.

To create a custom installation scheme, you start with one of the
alternate schemes and override some of the installation directories used
for the various types of files, using these options:

Type of file               Override option
                           
-------------------------------------------------------
                           
Python modules             ‘--install-purelib’
                           
                           
extension modules          ‘--install-platlib’
                           
                           
all modules                ‘--install-lib’
                           
                           
scripts                    ‘--install-scripts’
                           
                           
data                       ‘--install-data’
                           
                           
C headers                  ‘--install-headers’
                           

These override options can be relative, absolute, or explicitly defined
in terms of one of the installation base directories.  (There are two
installation base directories, and they are normally the same—they only
differ when you use the Unix “prefix scheme” and supply different
‘--prefix’ and ‘--exec-prefix’ options; using ‘--install-lib’ will
override values computed or given for ‘--install-purelib’ and
‘--install-platlib’, and is recommended for schemes that don’t make a
difference between Python and extension modules.)

For example, say you’re installing a module distribution to your home
directory under Unix—but you want scripts to go in ‘~/scripts’ rather
than ‘~/bin’.  As you might expect, you can override this directory with
the ‘--install-scripts’ option; in this case, it makes most sense to
supply a relative path, which will be interpreted relative to the
installation base directory (your home directory, in this case):

     python setup.py install --home=~ --install-scripts=scripts

Another Unix example: suppose your Python installation was built and
installed with a prefix of ‘/usr/local/python’, so under a standard
installation scripts will wind up in ‘/usr/local/python/bin’.  If you
want them in ‘/usr/local/bin’ instead, you would supply this absolute
directory for the ‘--install-scripts’ option:

     python setup.py install --install-scripts=/usr/local/bin

(This performs an installation using the “prefix scheme,” where the
prefix is whatever your Python interpreter was installed with—
‘/usr/local/python’ in this case.)

If you maintain Python on Windows, you might want third-party modules to
live in a subdirectory of ‘`prefix'’, rather than right in ‘`prefix'’
itself.  This is almost as easy as customizing the script installation
directory—you just have to remember that there are two types of modules
to worry about, Python and extension modules, which can conveniently be
both controlled by one option:

     python setup.py install --install-lib=Site

The specified installation directory is relative to ‘`prefix'’.  Of
course, you also have to ensure that this directory is in Python’s
module search path, such as by putting a ‘.pth’ file in a site directory
(see *note site: eb.).  See section *note Modifying Python’s Search
Path: 43a8. to find out how to modify Python’s search path.

If you want to define an entire installation scheme, you just have to
supply all of the installation directory options.  The recommended way
to do this is to supply relative paths; for example, if you want to
maintain all Python module-related files under ‘python’ in your home
directory, and you want a separate directory for each platform that you
use your home directory from, you might define the following
installation scheme:

     python setup.py install --home=~ \                         --install-purelib=python/lib \                         --install-platlib=python/lib.$PLAT \                         --install-scripts=python/scripts                         --install-data=python/data

or, equivalently,

     python setup.py install --home=~/python \                         --install-purelib=lib \                         --install-platlib='lib.$PLAT' \                         --install-scripts=scripts                         --install-data=data

‘$PLAT’ is not (necessarily) an environment variable—it will be expanded
by the Distutils as it parses your command line options, just as it does
when parsing your configuration file(s).

Obviously, specifying the entire installation scheme every time you
install a new module distribution would be very tedious.  Thus, you can
put these options into your Distutils config file (see section *note
Distutils Configuration Files: 439f.):

     [install] install-base=$HOME install-purelib=python/lib install-platlib=python/lib.$PLAT install-scripts=python/scripts install-data=python/data

or, equivalently,

     [install] install-base=$HOME/python install-purelib=lib install-platlib=lib.$PLAT install-scripts=scripts install-data=data

Note that these two are `not' equivalent if you supply a different
installation base directory when you run the setup script.  For example,

     python setup.py install --install-base=/tmp

would install pure modules to ‘/tmp/python/lib’ in the first case, and
to ‘/tmp/lib’ in the second case.  (For the second case, you probably
want to supply an installation base of ‘/tmp/python’.)

You probably noticed the use of ‘$HOME’ and ‘$PLAT’ in the sample
configuration file input.  These are Distutils configuration variables,
which bear a strong resemblance to environment variables.  In fact, you
can use environment variables in config files on platforms that have
such a notion but the Distutils additionally define a few extra
variables that may not be in your environment, such as ‘$PLAT’.  (And of
course, on systems that don’t have environment variables, such as Mac OS
9, the configuration variables supplied by the Distutils are the only
ones you can use.)  See section *note Distutils Configuration Files:
439f. for details.

     Note: When a *note virtual environment: 3534. is activated, any
     options that change the installation path will be ignored from all
     distutils configuration files to prevent inadvertently installing
     projects outside of the virtual environment.

* Menu:

* Modifying Python’s Search Path::


File: python.info,  Node: Modifying Python’s Search Path,  Up: Custom Installation

18.4.1 Modifying Python’s Search Path
-------------------------------------

When the Python interpreter executes an *note import: c10. statement, it
searches for both Python code and extension modules along a search path.
A default value for the path is configured into the Python binary when
the interpreter is built.  You can determine the path by importing the
*note sys: fd. module and printing the value of ‘sys.path’.

     $ python Python 2.2 (#11, Oct  3 2002, 13:31:27) [GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import sys >>> sys.path ['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',  '/usr/local/lib/python2.3/lib-tk', '/usr/local/lib/python2.3/lib-dynload',  '/usr/local/lib/python2.3/site-packages'] >>>

The null string in ‘sys.path’ represents the current working directory.

The expected convention for locally installed packages is to put them in
the ‘`…'/site-packages/’ directory, but you may want to install Python
modules into some arbitrary directory.  For example, your site may have
a convention of keeping all software related to the web server under
‘/www’.  Add-on Python modules might then belong in ‘/www/python’, and
in order to import them, this directory must be added to ‘sys.path’.
There are several different ways to add the directory.

The most convenient way is to add a path configuration file to a
directory that’s already on Python’s path, usually to the
‘.../site-packages/’ directory.  Path configuration files have an
extension of ‘.pth’, and each line must contain a single path that will
be appended to ‘sys.path’.  (Because the new paths are appended to
‘sys.path’, modules in the added directories will not override standard
modules.  This means you can’t use this mechanism for installing fixed
versions of standard modules.)

Paths can be absolute or relative, in which case they’re relative to the
directory containing the ‘.pth’ file.  See the documentation of the
*note site: eb. module for more information.

A slightly less convenient way is to edit the ‘site.py’ file in Python’s
standard library, and modify ‘sys.path’.  ‘site.py’ is automatically
imported when the Python interpreter is executed, unless the *note -S:
b17. switch is supplied to suppress this behaviour.  So you could simply
edit ‘site.py’ and add two lines to it:

     import sys sys.path.append('/www/python/')

However, if you reinstall the same major version of Python (perhaps when
upgrading from 2.2 to 2.2.2, for example) ‘site.py’ will be overwritten
by the stock version.  You’d have to remember that it was modified and
save a copy before doing the installation.

There are two environment variables that can modify ‘sys.path’.  *note
PYTHONHOME: 4cb. sets an alternate value for the prefix of the Python
installation.  For example, if *note PYTHONHOME: 4cb. is set to
‘/www/python’, the search path will be set to ‘['',
'/www/python/lib/pythonX.Y/', '/www/python/lib/pythonX.Y/plat-linux2',
...]’.

The *note PYTHONPATH: 947. variable can be set to a list of paths that
will be added to the beginning of ‘sys.path’.  For example, if *note
PYTHONPATH: 947. is set to ‘/www/python:/opt/py’, the search path will
begin with ‘['/www/python', '/opt/py']’.  (Note that directories must
exist in order to be added to ‘sys.path’; the *note site: eb. module
removes paths that don’t exist.)

Finally, ‘sys.path’ is just a regular Python list, so any Python
application can modify it by adding or removing entries.


File: python.info,  Node: Distutils Configuration Files,  Next: Building Extensions Tips and Tricks,  Prev: Custom Installation,  Up: Installing Python Modules Legacy version

18.5 Distutils Configuration Files
==================================

As mentioned above, you can use Distutils configuration files to record
personal or site preferences for any Distutils options.  That is, any
option to any command can be stored in one of two or three (depending on
your platform) configuration files, which will be consulted before the
command-line is parsed.  This means that configuration files will
override default values, and the command-line will in turn override
configuration files.  Furthermore, if multiple configuration files
apply, values from “earlier” files are overridden by “later” files.

* Menu:

* Location and names of config files::
* Syntax of config files::


File: python.info,  Node: Location and names of config files,  Next: Syntax of config files,  Up: Distutils Configuration Files

18.5.1 Location and names of config files
-----------------------------------------

The names and locations of the configuration files vary slightly across
platforms.  On Unix and Mac OS X, the three configuration files (in the
order they are processed) are:

Type of file       Location and filename                                          Notes
                                                                                  
----------------------------------------------------------------------------------------------
                                                                                  
system             ‘`prefix'/lib/python`ver'/distutils/distutils.cfg’             (1)
                                                                                  
                                                                                  
personal           ‘$HOME/.pydistutils.cfg’                                       (2)
                                                                                  
                                                                                  
local              ‘setup.cfg’                                                    (3)
                                                                                  

And on Windows, the configuration files are:

Type of file       Location and filename                                 Notes
                                                                         
-------------------------------------------------------------------------------------
                                                                         
system             ‘`prefix'\Lib\distutils\distutils.cfg’                (4)
                                                                         
                                                                         
personal           ‘%HOME%\pydistutils.cfg’                              (5)
                                                                         
                                                                         
local              ‘setup.cfg’                                           (3)
                                                                         

On all platforms, the “personal” file can be temporarily disabled by
passing the ‘–no-user-cfg’ option.

Notes:

  1. Strictly speaking, the system-wide configuration file lives in the
     directory where the Distutils are installed; under Python 1.6 and
     later on Unix, this is as shown.  For Python 1.5.2, the Distutils
     will normally be installed to
     ‘`prefix'/lib/python1.5/site-packages/distutils’, so the system
     configuration file should be put there under Python 1.5.2.

  2. On Unix, if the ‘HOME’ environment variable is not defined, the
     user’s home directory will be determined with the ‘getpwuid()’
     function from the standard *note pwd: d6. module.  This is done by
     the *note os.path.expanduser(): 1fc. function used by Distutils.

  3. I.e., in the current directory (usually the location of the setup
     script).

  4. (See also note (1).)  Under Python 1.6 and later, Python’s default
     “installation prefix” is ‘C:\Python’, so the system configuration
     file is normally ‘C:\Python\Lib\distutils\distutils.cfg’.  Under
     Python 1.5.2, the default prefix was ‘C:\Program Files\Python’, and
     the Distutils were not part of the standard library—so the system
     configuration file would be ‘C:\Program
     Files\Python\distutils\distutils.cfg’ in a standard Python 1.5.2
     installation under Windows.

  5. On Windows, if the ‘HOME’ environment variable is not defined,
     ‘USERPROFILE’ then ‘HOMEDRIVE’ and ‘HOMEPATH’ will be tried.  This
     is done by the *note os.path.expanduser(): 1fc. function used by
     Distutils.


File: python.info,  Node: Syntax of config files,  Prev: Location and names of config files,  Up: Distutils Configuration Files

18.5.2 Syntax of config files
-----------------------------

The Distutils configuration files all have the same syntax.  The config
files are grouped into sections.  There is one section for each
Distutils command, plus a ‘global’ section for global options that
affect every command.  Each section consists of one option per line,
specified as ‘option=value’.

For example, the following is a complete config file that just forces
all commands to run quietly by default:

     [global] verbose=0

If this is installed as the system config file, it will affect all
processing of any Python module distribution by any user on the current
system.  If it is installed as your personal config file (on systems
that support them), it will affect only module distributions processed
by you.  And if it is used as the ‘setup.cfg’ for a particular module
distribution, it affects only that distribution.

You could override the default “build base” directory and make the
‘build*’ commands always forcibly rebuild all files with the following:

     [build] build-base=blib force=1

which corresponds to the command-line arguments

     python setup.py build --build-base=blib --force

except that including the ‘build’ command on the command-line means that
command will be run.  Including a particular command in config files has
no such implication; it only means that if the command is run, the
options in the config file will apply.  (Or if other commands that
derive values from it are run, they will use the values in the config
file.)

You can find out the complete list of options for any command using the
‘--help’ option, e.g.:

     python setup.py build --help

and you can find out the complete list of global options by using
‘--help’ without a command:

     python setup.py --help

See also the “Reference” section of the “Distributing Python Modules”
manual.


File: python.info,  Node: Building Extensions Tips and Tricks,  Prev: Distutils Configuration Files,  Up: Installing Python Modules Legacy version

18.6 Building Extensions: Tips and Tricks
=========================================

Whenever possible, the Distutils try to use the configuration
information made available by the Python interpreter used to run the
‘setup.py’ script.  For example, the same compiler and linker flags used
to compile Python will also be used for compiling extensions.  Usually
this will work well, but in complicated situations this might be
inappropriate.  This section discusses how to override the usual
Distutils behaviour.

* Menu:

* Tweaking compiler/linker flags::
* Using non-Microsoft compilers on Windows::


File: python.info,  Node: Tweaking compiler/linker flags,  Next: Using non-Microsoft compilers on Windows,  Up: Building Extensions Tips and Tricks

18.6.1 Tweaking compiler/linker flags
-------------------------------------

Compiling a Python extension written in C or C++ will sometimes require
specifying custom flags for the compiler and linker in order to use a
particular library or produce a special kind of object code.  This is
especially true if the extension hasn’t been tested on your platform, or
if you’re trying to cross-compile Python.

In the most general case, the extension author might have foreseen that
compiling the extensions would be complicated, and provided a ‘Setup’
file for you to edit.  This will likely only be done if the module
distribution contains many separate extension modules, or if they often
require elaborate sets of compiler flags in order to work.

A ‘Setup’ file, if present, is parsed in order to get a list of
extensions to build.  Each line in a ‘Setup’ describes a single module.
Lines have the following structure:

     module ... [sourcefile ...] [cpparg ...] [library ...]

Let’s examine each of the fields in turn.

   * `module' is the name of the extension module to be built, and
     should be a valid Python identifier.  You can’t just change this in
     order to rename a module (edits to the source code would also be
     needed), so this should be left alone.

   * `sourcefile' is anything that’s likely to be a source code file, at
     least judging by the filename.  Filenames ending in ‘.c’ are
     assumed to be written in C, filenames ending in ‘.C’, ‘.cc’, and
     ‘.c++’ are assumed to be C++, and filenames ending in ‘.m’ or ‘.mm’
     are assumed to be in Objective C.

   * `cpparg' is an argument for the C preprocessor, and is anything
     starting with ‘-I’, ‘-D’, ‘-U’ or ‘-C’.

   * `library' is anything ending in ‘.a’ or beginning with ‘-l’ or
     ‘-L’.

If a particular platform requires a special library on your platform,
you can add it by editing the ‘Setup’ file and running ‘python setup.py
build’.  For example, if the module defined by the line

     foo foomodule.c

must be linked with the math library ‘libm.a’ on your platform, simply
add ‘-lm’ to the line:

     foo foomodule.c -lm

Arbitrary switches intended for the compiler or the linker can be
supplied with the ‘-Xcompiler’ `arg' and ‘-Xlinker’ `arg' options:

     foo foomodule.c -Xcompiler -o32 -Xlinker -shared -lm

The next option after ‘-Xcompiler’ and ‘-Xlinker’ will be appended to
the proper command line, so in the above example the compiler will be
passed the ‘-o32’ option, and the linker will be passed ‘-shared’.  If a
compiler option requires an argument, you’ll have to supply multiple
‘-Xcompiler’ options; for example, to pass ‘-x c++’ the ‘Setup’ file
would have to contain ‘-Xcompiler -x -Xcompiler c++’.

Compiler flags can also be supplied through setting the ‘CFLAGS’
environment variable.  If set, the contents of ‘CFLAGS’ will be added to
the compiler flags specified in the ‘Setup’ file.


File: python.info,  Node: Using non-Microsoft compilers on Windows,  Prev: Tweaking compiler/linker flags,  Up: Building Extensions Tips and Tricks

18.6.2 Using non-Microsoft compilers on Windows
-----------------------------------------------

* Menu:

* Borland/CodeGear C++::
* GNU C / Cygwin / MinGW::


File: python.info,  Node: Borland/CodeGear C++,  Next: GNU C / Cygwin / MinGW,  Up: Using non-Microsoft compilers on Windows

18.6.2.1 Borland/CodeGear C++
.............................

This subsection describes the necessary steps to use Distutils with the
Borland C++ compiler version 5.5.  First you have to know that Borland’s
object file format (OMF) is different from the format used by the Python
version you can download from the Python or ActiveState Web site.
(Python is built with Microsoft Visual C++, which uses COFF as the
object file format.)  For this reason you have to convert Python’s
library ‘python25.lib’ into the Borland format.  You can do this as
follows:

     coff2omf python25.lib python25_bcpp.lib

The ‘coff2omf’ program comes with the Borland compiler.  The file
‘python25.lib’ is in the ‘Libs’ directory of your Python installation.
If your extension uses other libraries (zlib, …) you have to convert
them too.

The converted files have to reside in the same directories as the normal
libraries.

How does Distutils manage to use these libraries with their changed
names?  If the extension needs a library (eg.  ‘foo’) Distutils checks
first if it finds a library with suffix ‘_bcpp’ (eg.  ‘foo_bcpp.lib’)
and then uses this library.  In the case it doesn’t find such a special
library it uses the default name (‘foo.lib’.)  (1)

To let Distutils compile your extension with Borland C++ you now have to
type:

     python setup.py build --compiler=bcpp

If you want to use the Borland C++ compiler as the default, you could
specify this in your personal or system-wide configuration file for
Distutils (see section *note Distutils Configuration Files: 439f.)

See also
........

C++Builder Compiler(2)

     Information about the free C++ compiler from Borland, including
     links to the download pages.

Creating Python Extensions Using Borland’s Free Compiler(3)

     Document describing how to use Borland’s free command-line C++
     compiler to build Python.

   ---------- Footnotes ----------

   (1) (1) This also means you could replace all existing COFF-libraries
with OMF-libraries of the same name.

   (2) https://www.embarcadero.com/products

   (3) http://www.cyberus.ca/~g_will/pyExtenDL.shtml


File: python.info,  Node: GNU C / Cygwin / MinGW,  Prev: Borland/CodeGear C++,  Up: Using non-Microsoft compilers on Windows

18.6.2.2 GNU C / Cygwin / MinGW
...............................

This section describes the necessary steps to use Distutils with the GNU
C/C++ compilers in their Cygwin and MinGW distributions.  (1) For a
Python interpreter that was built with Cygwin, everything should work
without any of these following steps.

Not all extensions can be built with MinGW or Cygwin, but many can.
Extensions most likely to not work are those that use C++ or depend on
Microsoft Visual C extensions.

To let Distutils compile your extension with Cygwin you have to type:

     python setup.py build --compiler=cygwin

and for Cygwin in no-cygwin mode (2) or for MinGW type:

     python setup.py build --compiler=mingw32

If you want to use any of these options/compilers as default, you should
consider writing it in your personal or system-wide configuration file
for Distutils (see section *note Distutils Configuration Files: 439f.)

* Menu:

* Older Versions of Python and MinGW::

   ---------- Footnotes ----------

   (1) (2) Check ‘https://www.sourceware.org/cygwin/’ and
‘http://www.mingw.org/’ for more information

   (2) (3) Then you have no POSIX emulation available, but you also
don’t need ‘cygwin1.dll’.


File: python.info,  Node: Older Versions of Python and MinGW,  Up: GNU C / Cygwin / MinGW

18.6.2.3 Older Versions of Python and MinGW
...........................................

The following instructions only apply if you’re using a version of
Python inferior to 2.4.1 with a MinGW inferior to 3.0.0 (with
binutils-2.13.90-20030111-1).

These compilers require some special libraries.  This task is more
complex than for Borland’s C++, because there is no program to convert
the library.  First you have to create a list of symbols which the
Python DLL exports.  (You can find a good program for this task at
‘https://sourceforge.net/projects/mingw/files/MinGW/Extension/pexports/’).

     pexports python25.dll >python25.def

The location of an installed ‘python25.dll’ will depend on the
installation options and the version and language of Windows.  In a
“just for me” installation, it will appear in the root of the
installation directory.  In a shared installation, it will be located in
the system directory.

Then you can create from these information an import library for gcc.

     /cygwin/bin/dlltool --dllname python25.dll --def python25.def --output-lib libpython25.a

The resulting library has to be placed in the same directory as
‘python25.lib’.  (Should be the ‘libs’ directory under your Python
installation directory.)

If your extension uses other libraries (zlib,…) you might have to
convert them too.  The converted files have to reside in the same
directories as the normal libraries do.

See also
........

Building Python modules on MS Windows platform with MinGW(1)

     Information about building the required libraries for the MinGW
     environment.

   ---------- Footnotes ----------

   (1) http://old.zope.org/Members/als/tips/win32_mingw_modules


File: python.info,  Node: Python Module Index,  Next: Index,  Prev: Installing Python Modules Legacy version,  Up: Top

Python Module Index
*******************

* Menu:

* __future__: 0. Future statement definitions
* __main__: 1. The environment where the top-level script is run.
* _dummy_thread: 2. Drop-in replacement for the _thread module.
* _thread: 3. Low-level threading API.
* abc: 4. Abstract base classes according to :pep:‘3119‘.
* aifc: 5. Read and write audio files in AIFF or AIFC format.
* argparse: 6. Command-line option and argument parsing library.
* array: 7. Space efficient arrays of uniformly typed numeric
                        values.
* ast: 8. Abstract Syntax Tree classes and manipulation.
* asynchat: 9. Support for asynchronous command/response protocols.
* asyncio: a. Asynchronous I/O.
* asyncore: b. A base class for developing asynchronous socket
                        handling services.
* atexit: c. Register and execute cleanup functions.
* audioop: d. Manipulate raw audio data.
* base64: e. RFC 3548: Base16, Base32, Base64 Data
                        Encodings; Base85 and Ascii85
* bdb: f. Debugger framework.
* binascii: 10. Tools for converting between binary and various ASCII-
                        encoded binary representations.
* binhex: 11. Encode and decode files in binhex4 format.
* bisect: 12. Array bisection algorithms for binary searching.
* builtins: 13. The module that provides the built-in namespace.
* bz2: 14. Interfaces for bzip2 compression and decompression.
* calendar: 15. Functions for working with calendars, including
                        some emulation of the Unix cal program.
* cgi: 16. Helpers for running Python scripts via the Common
                        Gateway Interface.
* cgitb: 17. Configurable traceback handler for CGI scripts.
* chunk: 18. Module to read IFF chunks.
* cmath: 19. Mathematical functions for complex numbers.
* cmd: 1a. Build line-oriented command interpreters.
* code: 1b. Facilities to implement read-eval-print loops.
* codecs: 1c. Encode and decode data and streams.
* codeop: 1d. Compile (possibly incomplete) Python code.
* collections: 1e. Container datatypes
* collections.abc: 1f. Abstract base classes for containers
* colorsys: 20. Conversion functions between RGB and other color
                        systems.
* compileall: 21. Tools for byte-compiling all Python source files in a
                        directory tree.
* concurrent.futures: 22. Execute computations concurrently using threads or
                        processes.
* configparser: 23. Configuration file parser.
* contextlib: 24. Utilities for with-statement contexts.
* contextvars: 25. Context Variables
* copy: 26. Shallow and deep copy operations.
* copyreg: 27. Register pickle support functions.
* cProfile: 28.
* crypt: 29. The crypt() function used to check Unix passwords.
* csv: 2a. Write and read tabular data to and from delimited
                        files.
* ctypes: 2b. A foreign function library for Python.
* curses: 2c. An interface to the curses library, providing
                        portable terminal handling.
* curses.ascii: 2d. Constants and set-membership functions for ASCII
                        characters.
* curses.panel: 2e. A panel stack extension that adds depth to curses
                        windows.
* curses.textpad: 2f. Emacs-like input editing in a curses window.
* dataclasses: 30. Generate special methods on user-defined classes.
* datetime: 31. Basic date and time types.
* dbm: 32. Interfaces to various Unix "database" formats.
* dbm.dumb: 33. Portable implementation of the simple DBM interface.
* dbm.gnu: 34. GNU’s reinterpretation of dbm.
* dbm.ndbm: 35. The standard "database" interface, based on
                        ndbm.
* decimal: 36. Implementation of the General Decimal Arithmetic
                        Specification.
* difflib: 37. Helpers for computing differences between objects.
* dis: 38. Disassembler for Python bytecode.
* distutils: 39. Support for building and installing Python modules
                        into an existing Python installation.
* distutils.archive_util: 3a. Utility functions for creating archive files
                          (tarballs, zip files, ...)
* distutils.bcppcompiler: 3b.
* distutils.ccompiler: 3c. Abstract CCompiler class
* distutils.cmd: 3d. Provides the abstract base class
                        :class:‘~distutils.cmd.Command‘. This class is
                        subclassed by the modules in the distutils.command
                        subpackage.
* distutils.command: 3e. Contains one module for each standard Distutils
                        command.
* distutils.command.bdist: 3f. Build a binary installer for a package
* distutils.command.bdist_dumb: 40. Build a "dumb" installer - a simple archive of
                                files
* distutils.command.bdist_msi: 41. Build a binary distribution as a Windows MSI
                               file
* distutils.command.bdist_packager: 42. Abstract base class for packagers
* distutils.command.bdist_rpm: 43. Build a binary distribution as a Redhat RPM and
                               SRPM
* distutils.command.bdist_wininst: 44. Build a Windows installer
* distutils.command.build: 45. Build all files of a package
* distutils.command.build_clib: 46. Build any C libraries in a package
* distutils.command.build_ext: 47. Build any extensions in a package
* distutils.command.build_py: 48. Build the .py/.pyc files of a package
* distutils.command.build_scripts: 49. Build the scripts of a package
* distutils.command.check: 4a. Check the meta-data of a package
* distutils.command.clean: 4b. Clean a package build area
* distutils.command.config: 4c. Perform package configuration
* distutils.command.install: 4d. Install a package
* distutils.command.install_data: 4e. Install data files from a package
* distutils.command.install_headers: 4f. Install C/C++ header files from a package
* distutils.command.install_lib: 50. Install library files from a package
* distutils.command.install_scripts: 51. Install script files from a package
* distutils.command.register: 52. Register a module with the Python Package Index
* distutils.command.sdist: 53. Build a source distribution
* distutils.core: 54. The core Distutils functionality
* distutils.cygwinccompiler: 55.
* distutils.debug: 56. Provides the debug flag for distutils
* distutils.dep_util: 57. Utility functions for simple dependency checking
* distutils.dir_util: 58. Utility functions for operating on directories and
                        directory trees
* distutils.dist: 59. Provides the Distribution class, which
                        represents the module distribution being
                        built/installed/distributed
* distutils.errors: 5a. Provides standard distutils exceptions
* distutils.extension: 5b. Provides the Extension class, used to describe
                        C/C++ extension modules in setup scripts
* distutils.fancy_getopt: 5c. Additional getopt functionality
* distutils.file_util: 5d. Utility functions for operating on single files
* distutils.filelist: 5e. The FileList class, used for poking about the
                        file system and building lists of files.
* distutils.log: 5f. A simple logging mechanism, :pep:‘282‘-style
* distutils.msvccompiler: 60. Microsoft Compiler
* distutils.spawn: 61. Provides the spawn() function
* distutils.sysconfig: 62. Low-level access to configuration information of the
                        Python interpreter.
* distutils.text_file: 63. Provides the TextFile class, a simple interface
                        to text files
* distutils.unixccompiler: 64. UNIX C Compiler
* distutils.util: 65. Miscellaneous other utility functions
* distutils.version: 66. Implements classes that represent module version
                        numbers.
* doctest: 67. Test pieces of code within docstrings.
* dummy_threading: 68. Drop-in replacement for the threading module.
* email: 69. Package supporting the parsing,
                        manipulating, and generating email messages.
* email.charset: 6a. Character Sets
* email.contentmanager: 6b. Storing and Retrieving Content from MIME Parts
* email.encoders: 6c. Encoders for email message payloads.
* email.errors: 6d. The exception classes used by the email package.
* email.generator: 6e. Generate flat text email messages from a message
                        structure.
* email.header: 6f. Representing non-ASCII headers
* email.headerregistry: 70. Automatic Parsing of headers based on the field name
* email.iterators: 71. Iterate over a message object tree.
* email.message: 72. The base class representing email messages.
* email.mime: 73. Build MIME messages.
* email.parser: 74. Parse flat text email messages to produce a message
                        object structure.
* email.policy: 75. Controlling the parsing and generating of messages
* email.utils: 76. Miscellaneous email package utilities.
* encodings.idna: 77. Internationalized Domain Names implementation
* encodings.mbcs: 78. Windows ANSI codepage
* encodings.utf_8_sig: 79. UTF-8 codec with BOM signature
* ensurepip: 7a. Bootstrapping the "pip" installer into an existing
                        Python installation or virtual environment.
* enum: 7b. Implementation of an enumeration class.
* errno: 7c. Standard errno system symbols.
* faulthandler: 7d. Dump the Python traceback.
* fcntl: 7e. The fcntl() and ioctl() system calls.
* filecmp: 7f. Compare files efficiently.
* fileinput: 80. Loop over standard input or a list of files.
* fnmatch: 81. Unix shell style filename pattern matching.
* formatter: 82. Generic output formatter and device interface.
* fractions: 83. Rational numbers.
* ftplib: 84. FTP protocol client (requires sockets).
* functools: 85. Higher-order functions and operations on callable
                        objects.
* gc: 86. Interface to the cycle-detecting garbage collector.
* getopt: 87. Portable parser for command line options; support both
                        short and long option names.
* getpass: 88. Portable reading of passwords and retrieval of the
                        userid.
* gettext: 89. Multilingual internationalization services.
* glob: 8a. Unix shell style pathname pattern expansion.
* grp: 8b. The group database (getgrnam() and friends).
* gzip: 8c. Interfaces for gzip compression and decompression
                        using file objects.
* hashlib: 8d. Secure hash and message digest algorithms.
* heapq: 8e. Heap queue algorithm (a.k.a. priority queue).
* hmac: 8f. Keyed-Hashing for Message Authentication (HMAC)
                        implementation
* html: 90. Helpers for manipulating HTML.
* html.entities: 91. Definitions of HTML general entities.
* html.parser: 92. A simple parser that can handle HTML and XHTML.
* http: 93. HTTP status codes and messages
* http.client: 94. HTTP and HTTPS protocol client (requires sockets).
* http.cookiejar: 95. Classes for automatic handling of HTTP cookies.
* http.cookies: 96. Support for HTTP state management (cookies).
* http.server: 97. HTTP server and request handlers.
* imaplib: 98. IMAP4 protocol client (requires sockets).
* imghdr: 99. Determine the type of image contained in a file or
                        byte stream.
* imp: 9a. Access the implementation of the import statement.
* importlib: 9b. The implementation of the import machinery.
* importlib.abc: 9c. Abstract base classes related to import
* importlib.machinery: 9d. Importers and path hooks
* importlib.resources: 9e. Package resource reading, opening, and
                        access
* importlib.util: 9f. Utility code for importers
* inspect: a0. Extract information and source code from live objects.
* io: a1. Core tools for working with streams.
* ipaddress: a2. IPv4/IPv6 manipulation library.
* itertools: a3. Functions creating iterators for efficient looping.
* json: a4. Encode and decode the JSON format.
* json.tool: a5. A command line to validate and pretty-print JSON.
* keyword: a6. Test whether a string is a keyword in Python.
* lib2to3: a7. The 2to3 library
* linecache: a8. Provides random access to individual lines from text
                        files.
* locale: a9. Internationalization services.
* logging: aa. Flexible event logging system for applications.
* logging.config: ab. Configuration of the logging module.
* logging.handlers: ac. Handlers for the logging module.
* lzma: ad. A Python wrapper for the liblzma compression library.
* mailbox: ae. Manipulate mailboxes in various formats
* mailcap: af. Mailcap file handling.
* marshal: b0. Convert Python objects to streams of bytes and back
                        (with different constraints).
* math: b1. Mathematical functions (sin() etc.).
* mimetypes: b2. Mapping of filename extensions to MIME types.
* mmap: b3. Interface to memory-mapped files for Unix and Windows.
* modulefinder: b4. Find modules used by a script.
* msilib: b5. Creation of Microsoft Installer files, and CAB
                        files.
* msvcrt: b6. Miscellaneous useful routines from the MS VC++
                        runtime.
* multiprocessing: b7. Process-based parallelism.
* multiprocessing.connection: b8. API for dealing with sockets.
* multiprocessing.dummy: b9. Dumb wrapper around threading.
* multiprocessing.managers: ba. Share data between process with shared objects.
* multiprocessing.pool: bb. Create pools of processes.
* multiprocessing.shared_memory: bc. Provides shared memory for direct access
                                 across processes.
* multiprocessing.sharedctypes: bd. Allocate ctypes objects from shared memory.
* netrc: be. Loading of .netrc files.
* nis: bf. Interface to Sun’s NIS (Yellow Pages) library.
* nntplib: c0. NNTP protocol client (requires sockets).
* numbers: c1. Numeric abstract base classes (Complex,
                        Real, Integral, etc.).
* operator: c2. Functions corresponding to the standard operators.
* optparse: c3. Command-line option parsing library.
* os: c4. Miscellaneous operating system interfaces.
* os.path: c5. Operations on pathnames.
* ossaudiodev: c6. Access to OSS-compatible audio devices.
* parser: c7. Access parse trees for Python source code.
* pathlib: c8. Object-oriented filesystem paths
* pdb: c9. The Python debugger for interactive interpreters.
* pickle: ca. Convert Python objects to streams of bytes and back.
* pickletools: cb. Contains extensive comments about the pickle protocols
                        and pickle-machine opcodes, as well as some
                        useful functions.
* pipes: cc. A Python interface to Unix shell pipelines.
* pkgutil: cd. Utilities for the import system.
* platform: ce. Retrieves as much platform identifying data as
                        possible.
* plistlib: cf. Generate and parse Mac OS X plist files.
* poplib: d0. POP3 protocol client (requires sockets).
* posix: d1. The most common POSIX system calls (normally used via
                        module os).
* pprint: d2. Data pretty printer.
* profile: d3. Python source profiler.
* pstats: d4. Statistics object for use with the profiler.
* pty: d5. Pseudo-Terminal Handling for Linux.
* pwd: d6. The password database (getpwnam() and friends).
* py_compile: d7. Generate byte-code files from Python source files.
* pyclbr: d8. Supports information extraction for a Python class
                        browser.
* pydoc: d9. Documentation generator and online help system.
* queue: da. A synchronized queue class.
* quopri: db. Encode and decode files using the MIME quoted-
                        printable encoding.
* random: dc. Generate pseudo-random numbers with various common
                        distributions.
* re: dd. Regular expression operations.
* readline: de. GNU readline support for Python.
* reprlib: df. Alternate repr() implementation with size limits.
* resource: e0. An interface to provide resource usage information on
                        the current process.
* rlcompleter: e1. Python identifier completion, suitable for the
                        GNU readline library.
* runpy: e2. Locate and run Python modules without importing them
                        first.
* sched: e3. General purpose event scheduler.
* secrets: e4. Generate secure random numbers for managing secrets.
* select: e5. Wait for I/O completion on multiple streams.
* selectors: e6. High-level I/O multiplexing.
* shelve: e7. Python object persistence.
* shlex: e8. Simple lexical analysis for Unix shell-like languages.
* shutil: e9. High-level file operations, including copying.
* signal: ea. Set handlers for asynchronous events.
* site: eb. Module responsible for site-specific configuration.
* smtpd: ec. A SMTP server implementation in Python.
* smtplib: ed. SMTP protocol client (requires sockets).
* sndhdr: ee. Determine type of a sound file.
* socket: ef. Low-level networking interface.
* socketserver: f0. A framework for network servers.
* spwd: f1. The shadow password database (getspnam() and friends).
* sqlite3: f2. A DB-API 2.0 implementation using SQLite 3.x.
* ssl: f3. TLS/SSL wrapper for socket objects
* stat: f4. Utilities for interpreting the results of
                        os.stat(), os.lstat() and os.fstat().
* statistics: f5. Mathematical statistics functions
* string: f6. Common string operations.
* stringprep: f7. String preparation, as per RFC 3453
* struct: f8. Interpret bytes as packed binary data.
* subprocess: f9. Subprocess management.
* sunau: fa. Provide an interface to the Sun AU sound format.
* symbol: fb. Constants representing internal nodes of the parse
                        tree.
* symtable: fc. Interface to the compiler’s internal symbol tables.
* sys: fd. Access system-specific parameters and functions.
* sysconfig: fe. Python’s configuration information
* syslog: ff. An interface to the Unix syslog library routines.
* tabnanny: 100. Tool for detecting white space related problems in
                        Python source files in a directory tree.
* tarfile: 101. Read and write tar-format archive files.
* telnetlib: 102. Telnet client class.
* tempfile: 103. Generate temporary files and directories.
* termios: 104. POSIX style tty control.
* test: 105. Regression tests package containing the testing suite
                        for Python.
* test.support: 106. Support for Python’s regression test suite.
* test.support.script_helper: 107. Support for Python’s script execution tests.
* textwrap: 108. Text wrapping and filling
* threading: 109. Thread-based parallelism.
* time: 10a. Time access and conversions.
* timeit: 10b. Measure the execution time of small code snippets.
* tkinter: 10c. Interface to Tcl/Tk for graphical user interfaces
* tkinter.scrolledtext: 10d. Text widget with a vertical scroll bar.
* tkinter.tix: 10e. Tk Extension Widgets for Tkinter
* tkinter.ttk: 10f. Tk themed widget set
* token: 110. Constants representing terminal nodes of the parse
                        tree.
* tokenize: 111. Lexical scanner for Python source code.
* trace: 112. Trace or track Python statement execution.
* traceback: 113. Print or retrieve a stack traceback.
* tracemalloc: 114. Trace memory allocations.
* tty: 115. Utility functions that perform common terminal control
                        operations.
* turtle: 116. An educational framework for simple graphics
                        applications
* turtledemo: 117. A viewer for example turtle scripts
* types: 118. Names for built-in types.
* typing: 119. Support for type hints (see :pep:‘484‘).
* unicodedata: 11a. Access the Unicode Database.
* unittest: 11b. Unit testing framework for Python.
* unittest.mock: 11c. Mock object library.
* urllib: 11d.
* urllib.error: 11e. Exception classes raised by urllib.request.
* urllib.parse: 11f. Parse URLs into or assemble them from components.
* urllib.request: 120. Extensible library for opening URLs.
* urllib.response: 121. Response classes used by urllib.
* urllib.robotparser: 122. Load a robots.txt file and answer questions about
                        fetchability of other URLs.
* uu: 123. Encode and decode files in uuencode format.
* uuid: 124. UUID objects (universally unique identifiers)
                        according to RFC 4122
* venv: 125. Creation of virtual environments.
* warnings: 126. Issue warning messages and control their disposition.
* wave: 127. Provide an interface to the WAV sound format.
* weakref: 128. Support for weak references and weak dictionaries.
* webbrowser: 129. Easy-to-use controller for Web browsers.
* winreg: 12a. Routines and objects for manipulating the Windows
                        registry.
* winsound: 12b. Access to the sound-playing machinery for Windows.
* wsgiref: 12c. WSGI Utilities and Reference Implementation.
* wsgiref.handlers: 12d. WSGI server/gateway base classes.
* wsgiref.headers: 12e. WSGI response header tools.
* wsgiref.simple_server: 12f. A simple WSGI HTTP server.
* wsgiref.util: 130. WSGI environment utilities.
* wsgiref.validate: 131. WSGI conformance checker.
* xdrlib: 132. Encoders and decoders for the External Data
                        Representation (XDR).
* xml: 133. Package containing XML processing modules
* xml.dom: 134. Document Object Model API for Python.
* xml.dom.minidom: 135. Minimal Document Object Model (DOM) implementation.
* xml.dom.pulldom: 136. Support for building partial DOM trees from SAX
                        events.
* xml.etree.ElementTree: 137. Implementation of the ElementTree API.
* xml.parsers.expat: 138. An interface to the Expat non-validating XML parser.
* xml.parsers.expat.errors: 139.
* xml.parsers.expat.model: 13a.
* xml.sax: 13b. Package containing SAX2 base classes and convenience
                        functions.
* xml.sax.handler: 13c. Base classes for SAX event handlers.
* xml.sax.saxutils: 13d. Convenience functions and classes for use with SAX.
* xml.sax.xmlreader: 13e. Interface which SAX-compliant XML parsers must
                        implement.
* xmlrpc.client: 13f. XML-RPC client access.
* xmlrpc.server: 140. Basic XML-RPC server implementations.
* zipapp: 141. Manage executable Python zip archives
* zipfile: 142. Read and write ZIP-format archive files.
* zipimport: 143. Support for importing Python modules from ZIP
                        archives.
* zlib: 144. Low-level interface to compression and decompression
                        routines compatible with gzip.


File: python.info,  Node: Index,  Prev: Python Module Index,  Up: Top

Index
*****

[index]
* Menu:

* ! (exclamation); in a command interpreter: Cmd Objects.    (line   27)
* ! (exclamation); in curses module:     curses ascii — Utilities for ASCII characters.
                                                             (line  226)
* ! (exclamation); in formatted string literal: String literal concatenation.
                                                             (line   24)
* ! (exclamation); in glob-style wildcards: glob — Unix style pathname pattern expansion.
                                                             (line   10)
* ! (exclamation); in glob-style wildcards <1>: fnmatch — Unix filename pattern matching.
                                                             (line   15)
* ! (exclamation); in string formatting: Format String Syntax.
                                                             (line   12)
* ! (exclamation); in struct format strings: Byte Order Size and Alignment.
                                                             (line   10)
* ! (pdb command):                       Debugger Commands.  (line  305)
* " (double quote); string literal:      Literals.           (line    8)
* """; string literal:                   String and Bytes literals.
                                                             (line   36)
* # (hash); comment:                     An Informal Introduction to Python.
                                                             (line   14)
* # (hash); comment <1>:                 Comments.           (line    6)
* # (hash); comment <2>:                 site — Site-specific configuration hook.
                                                             (line   45)
* # (hash); in doctests:                 Option Flags.       (line  174)
* # (hash); in printf-style formatting:  printf-style String Formatting.
                                                             (line   66)
* # (hash); in printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line   63)
* # (hash); in regular expressions:      Module Contents.    (line  123)
* # (hash); in string formatting:        Format Specification Mini-Language.
                                                             (line   87)
* # (hash); source encoding declaration: Encoding declarations.
                                                             (line    6)
* $ (dollar); environment variables expansion: os path — Common pathname manipulations.
                                                             (line  158)
* $ (dollar); in regular expressions:    Regular Expression Syntax.
                                                             (line   57)
* $ (dollar); in template strings:       Template strings.   (line   13)
* $ (dollar); interpolation in configuration files: Interpolation of values.
                                                             (line   40)
* % (percent); datetime format:          timezone Objects.   (line   71)
* % (percent); datetime format <1>:      Functions<2>.       (line  232)
* % (percent); datetime format <2>:      Functions<2>.       (line  364)
* % (percent); environment variables expansion (Windows): os path — Common pathname manipulations.
                                                             (line  158)
* % (percent); environment variables expansion (Windows) <1>: Functions<11>.
                                                             (line  233)
* % (percent); interpolation in configuration files: Interpolation of values.
                                                             (line   10)
* % (percent); printf-style formatting:  printf-style String Formatting.
                                                             (line    6)
* % (percent); printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line    6)
* %=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* &=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* ’ (single quote); string literal:      Literals.           (line    8)
* ’’’; string literal:                   String and Bytes literals.
                                                             (line   36)
* () (parentheses); call:                Slicings.           (line   38)
* () (parentheses); class definition:    Class definitions.  (line    6)
* () (parentheses); function definition: Function definitions.
                                                             (line    6)
* () (parentheses); generator expression: Generator expressions.
                                                             (line    6)
* () (parentheses); in assignment target list: Assignment statements.
                                                             (line   35)
* () (parentheses); in printf-style formatting: printf-style String Formatting.
                                                             (line   26)
* () (parentheses); in printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line   23)
* () (parentheses); in regular expressions: Regular Expression Syntax.
                                                             (line  199)
* () (parentheses); tuple display:       Parenthesized forms.
                                                             (line    6)
* (?!; in regular expressions:           Regular Expression Syntax.
                                                             (line  316)
* (?#; in regular expressions:           Regular Expression Syntax.
                                                             (line  305)
* (?; in regular expressions:            Regular Expression Syntax.
                                                             (line  208)
* (?;; in regular expressions:           Regular Expression Syntax.
                                                             (line  232)
* (?<!; in regular expressions:          Regular Expression Syntax.
                                                             (line  350)
* (?<=; in regular expressions:          Regular Expression Syntax.
                                                             (line  322)
* (?=; in regular expressions:           Regular Expression Syntax.
                                                             (line  309)
* (?P<; in regular expressions:          Regular Expression Syntax.
                                                             (line  267)
* (?P=; in regular expressions:          Regular Expression Syntax.
                                                             (line  300)
* * (asterisk); function definition:     Function definitions.
                                                             (line   78)
* * (asterisk); import statement:        The import statement.
                                                             (line   79)
* * (asterisk); in argparse module:      nargs.              (line   34)
* * (asterisk); in assignment target list: Assignment statements.
                                                             (line   35)
* * (asterisk); in AST grammar:          Node classes.       (line   22)
* * (asterisk); in expression lists:     Expression lists.   (line   16)
* * (asterisk); in function calls:       Arbitrary Argument Lists.
                                                             (line    6)
* * (asterisk); in function calls <1>:   Calls.              (line   73)
* * (asterisk); in glob-style wildcards: glob — Unix style pathname pattern expansion.
                                                             (line   10)
* * (asterisk); in glob-style wildcards <1>: fnmatch — Unix filename pattern matching.
                                                             (line   15)
* * (asterisk); in printf-style formatting: printf-style String Formatting.
                                                             (line   26)
* * (asterisk); in printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line   23)
* * (asterisk); in regular expressions:  Regular Expression Syntax.
                                                             (line   68)
* **; function definition:               Function definitions.
                                                             (line   78)
* **; in dictionary displays:            Dictionary displays.
                                                             (line   23)
* **; in function calls:                 Unpacking Argument Lists.
                                                             (line   19)
* **; in function calls <1>:             Calls.              (line   99)
* **; in glob-style wildcards:           glob — Unix style pathname pattern expansion.
                                                             (line   39)
* **=; augmented assignment:             Augmented assignment statements.
                                                             (line    6)
* *=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* *?; in regular expressions:            Regular Expression Syntax.
                                                             (line   85)
* + (plus); binary operator:             Binary arithmetic operations.
                                                             (line   60)
* + (plus); binary operator <1>:         Numeric Types — int float complex.
                                                             (line   27)
* + (plus); in argparse module:          nargs.              (line   41)
* + (plus); in doctests:                 Option Flags.       (line  174)
* + (plus); in printf-style formatting:  printf-style String Formatting.
                                                             (line   66)
* + (plus); in printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line   63)
* + (plus); in regular expressions:      Regular Expression Syntax.
                                                             (line   74)
* + (plus); in string formatting:        Format Specification Mini-Language.
                                                             (line   71)
* + (plus); unary operator:              Unary arithmetic and bitwise operations.
                                                             (line   13)
* + (plus); unary operator <1>:          Numeric Types — int float complex.
                                                             (line   27)
* +=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* +?; in regular expressions:            Regular Expression Syntax.
                                                             (line   85)
* , (comma):                             Parenthesized forms.
                                                             (line   20)
* , (comma); argument list:              Slicings.           (line   38)
* , (comma); expression list:            List displays.      (line    6)
* , (comma); expression list <1>:        Set displays.       (line    6)
* , (comma); expression list <2>:        Expression lists.   (line    6)
* , (comma); expression list <3>:        The assert statement.
                                                             (line    6)
* , (comma); expression list <4>:        Class definitions.  (line    6)
* , (comma); identifier list:            The global statement.
                                                             (line    6)
* , (comma); identifier list <1>:        The nonlocal statement.
                                                             (line    6)
* , (comma); import statement:           The import statement.
                                                             (line    6)
* , (comma); in dictionary displays:     Dictionary displays.
                                                             (line    6)
* , (comma); in string formatting:       Format Specification Mini-Language.
                                                             (line   99)
* , (comma); in target list:             Assignment statements.
                                                             (line   35)
* , (comma); parameter list:             Function definitions.
                                                             (line    6)
* , (comma); slicing:                    Slicings.           (line    6)
* , (comma); with statement:             The with statement. (line    6)
* - (minus); binary operator:            Binary arithmetic operations.
                                                             (line   66)
* - (minus); binary operator <1>:        Numeric Types — int float complex.
                                                             (line   27)
* - (minus); in doctests:                Option Flags.       (line  173)
* - (minus); in glob-style wildcards:    glob — Unix style pathname pattern expansion.
                                                             (line   10)
* - (minus); in glob-style wildcards <1>: fnmatch — Unix filename pattern matching.
                                                             (line   15)
* - (minus); in printf-style formatting: printf-style String Formatting.
                                                             (line   66)
* - (minus); in printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line   63)
* - (minus); in regular expressions:     Regular Expression Syntax.
                                                             (line  143)
* - (minus); in string formatting:       Format Specification Mini-Language.
                                                             (line   71)
* - (minus); unary operator:             Unary arithmetic and bitwise operations.
                                                             (line   10)
* - (minus); unary operator <1>:         Numeric Types — int float complex.
                                                             (line   27)
* -=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* ->; function annotations:              Function Annotations.
                                                             (line    6)
* ->; function annotations <1>:          Function definitions.
                                                             (line   89)
* . (dot); attribute reference:          Attribute references.
                                                             (line    6)
* . (dot); in glob-style wildcards:      glob — Unix style pathname pattern expansion.
                                                             (line   10)
* . (dot); in numeric literal:           Integer literals.   (line   40)
* . (dot); in pathnames:                 Miscellaneous System Information.
                                                             (line   81)
* . (dot); in pathnames <1>:             Miscellaneous System Information.
                                                             (line  109)
* . (dot); in printf-style formatting:   printf-style String Formatting.
                                                             (line   26)
* . (dot); in printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line   23)
* . (dot); in regular expressions:       Regular Expression Syntax.
                                                             (line   46)
* . (dot); in string formatting:         Format String Syntax.
                                                             (line   12)
* . (dot); in Tkinter:                   A Very Quick Look at Tcl/Tk.
                                                             (line   44)
* ...:                                   Glossary.           (line   10)
* ...; ellipsis literal:                 The standard type hierarchy.
                                                             (line   41)
* ...; ellipsis literal <1>:             Built-in Constants. (line   52)
* ...; ellipsis literal <2>:             The Null Object.    (line   12)
* ...; in doctests:                      Option Flags.       (line   49)
* ...; interpreter prompt:               How are Docstring Examples Recognized?.
                                                             (line   12)
* ...; interpreter prompt <1>:           sys — System-specific parameters and functions.
                                                             (line 1139)
* ...; placeholder:                      textwrap — Text wrapping and filling.
                                                             (line  266)
* ...; placeholder <1>:                  pprint — Data pretty printer.
                                                             (line   27)
* ...; placeholder <2>:                  reprlib — Alternate repr implementation.
                                                             (line   41)
* ..; in pathnames:                      Miscellaneous System Information.
                                                             (line   87)
* .ini; file:                            configparser — Configuration file parser.
                                                             (line    8)
* .pdbrc; file:                          Debugger Commands.  (line   37)
* / (slash); in pathnames:               Miscellaneous System Information.
                                                             (line   93)
* / (slash); in pathnames <1>:           Miscellaneous System Information.
                                                             (line  102)
* //=; augmented assignment:             Augmented assignment statements.
                                                             (line    6)
* /=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* 0b; integer literal:                   Numeric literals.   (line   14)
* 0o; integer literal:                   Numeric literals.   (line   14)
* 0x; integer literal:                   Numeric literals.   (line   14)
* 2-digit years:                         time — Time access and conversions.
                                                             (line   35)
* 2to3:                                  Glossary.           (line   23)
* ; (colon); annotated variable:         Annotated assignment statements.
                                                             (line    6)
* ; (colon); compound statement:         The if statement.   (line    6)
* ; (colon); compound statement <1>:     The while statement.
                                                             (line    6)
* ; (colon); compound statement <2>:     The for statement.  (line    6)
* ; (colon); compound statement <3>:     The try statement.  (line    6)
* ; (colon); compound statement <4>:     The with statement. (line    6)
* ; (colon); compound statement <5>:     Function definitions.
                                                             (line    6)
* ; (colon); compound statement <6>:     Class definitions.  (line    6)
* ; (colon); function annotations:       Function Annotations.
                                                             (line    6)
* ; (colon); function annotations <1>:   Function definitions.
                                                             (line   89)
* ; (colon); in dictionary expressions:  Dictionary displays.
                                                             (line    6)
* ; (colon); in formatted string literal: String literal concatenation.
                                                             (line   23)
* ; (colon); in SQL statements:          Cursor Objects.     (line   11)
* ; (colon); in string formatting:       Format String Syntax.
                                                             (line   12)
* ; (colon); lambda expression:          Lambdas.            (line    6)
* ; (colon); path separator (POSIX):     Miscellaneous System Information.
                                                             (line  115)
* ; (colon); slicing:                    Slicings.           (line    6)
* ; (semicolon):                         Compound statements.
                                                             (line   18)
* ; (semicolon) <1>:                     Miscellaneous System Information.
                                                             (line  115)
* < (less); in string formatting:        Format Specification Mini-Language.
                                                             (line   42)
* < (less); in struct format strings:    Byte Order Size and Alignment.
                                                             (line   10)
* <<=; augmented assignment:             Augmented assignment statements.
                                                             (line    6)
* <BLANKLINE>:                           Option Flags.       (line   30)
* = (equals); assignment statement:      Assignment statements.
                                                             (line    6)
* = (equals); class definition:          Metaclasses.        (line    6)
* = (equals); function definition:       Function definitions.
                                                             (line   53)
* = (equals); in function calls:         Slicings.           (line   37)
* = (equals); in string formatting:      Format Specification Mini-Language.
                                                             (line   42)
* = (equals); in struct format strings:  Byte Order Size and Alignment.
                                                             (line   10)
* > (greater); in string formatting:     Format Specification Mini-Language.
                                                             (line   42)
* > (greater); in struct format strings: Byte Order Size and Alignment.
                                                             (line   10)
* >>=; augmented assignment:             Augmented assignment statements.
                                                             (line    6)
* >>>:                                   Glossary.           (line    6)
* >>>; interpreter prompt:               How are Docstring Examples Recognized?.
                                                             (line   12)
* >>>; interpreter prompt <1>:           sys — System-specific parameters and functions.
                                                             (line 1139)
* ? (question mark); in a command interpreter: Cmd Objects.  (line   27)
* ? (question mark); in argparse module: nargs.              (line   19)
* ? (question mark); in AST grammar:     Node classes.       (line   22)
* ? (question mark); in glob-style wildcards: glob — Unix style pathname pattern expansion.
                                                             (line   10)
* ? (question mark); in glob-style wildcards <1>: fnmatch — Unix filename pattern matching.
                                                             (line   15)
* ? (question mark); in regular expressions: Regular Expression Syntax.
                                                             (line   80)
* ? (question mark); in SQL statements:  Cursor Objects.     (line   11)
* ? (question mark); in struct format strings: Format Characters.
                                                             (line   86)
* ? (question mark); in struct format strings <1>: Format Characters.
                                                             (line  161)
* ? (question mark); replacement character: Error Handlers.  (line   28)
* ??; in regular expressions:            Regular Expression Syntax.
                                                             (line   85)
* @ (at); class definition:              Class definitions.  (line   44)
* @ (at); function definition:           Function definitions.
                                                             (line   33)
* @ (at); in struct format strings:      Byte Order Size and Alignment.
                                                             (line   10)
* [] (square brackets); in assignment target list: Assignment statements.
                                                             (line   35)
* [] (square brackets); in glob-style wildcards: glob — Unix style pathname pattern expansion.
                                                             (line   10)
* [] (square brackets); in glob-style wildcards <1>: fnmatch — Unix filename pattern matching.
                                                             (line   15)
* [] (square brackets); in regular expressions: Regular Expression Syntax.
                                                             (line  136)
* [] (square brackets); in string formatting: Format String Syntax.
                                                             (line   12)
* [] (square brackets); list expression: List displays.      (line    6)
* [] (square brackets); subscription:    Subscriptions.      (line    6)
* \ (backslash); escape sequence:        String and Bytes literals.
                                                             (line   72)
* \ (backslash); escape sequence <1>:    Error Handlers.     (line   28)
* \ (backslash); in pathnames (Windows): Miscellaneous System Information.
                                                             (line   93)
* \ (backslash); in regular expressions: Regular Expression Syntax.
                                                             (line  121)
* \ (backslash); in regular expressions <1>: Regular Expression Syntax.
                                                             (line  155)
* \ (backslash); in regular expressions <2>: Regular Expression Syntax.
                                                             (line  374)
* \a; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \A; in regular expressions:            Regular Expression Syntax.
                                                             (line  386)
* \a; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \b; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \b; in regular expressions:            Regular Expression Syntax.
                                                             (line  390)
* \B; in regular expressions:            Regular Expression Syntax.
                                                             (line  407)
* \b; in regular expressions <1>:        Regular Expression Syntax.
                                                             (line  486)
* \d; in regular expressions:            Regular Expression Syntax.
                                                             (line  418)
* \D; in regular expressions:            Regular Expression Syntax.
                                                             (line  431)
* \f; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \f; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \g; in regular expressions:            Module Contents.    (line  282)
* \n; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \N; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \N; escape sequence <1>:               Error Handlers.     (line   28)
* \n; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \N; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \r; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \r; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \s; in regular expressions:            Regular Expression Syntax.
                                                             (line  437)
* \S; in regular expressions:            Regular Expression Syntax.
                                                             (line  452)
* \t; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \t; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \u; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \U; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \u; escape sequence <1>:               Error Handlers.     (line   28)
* \U; escape sequence <1>:               Error Handlers.     (line   28)
* \u; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \U; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \v; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \v; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \w; in regular expressions:            Regular Expression Syntax.
                                                             (line  458)
* \W; in regular expressions:            Regular Expression Syntax.
                                                             (line  474)
* \x; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \x; escape sequence <1>:               Error Handlers.     (line   28)
* \x; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* \Z; in regular expressions:            Regular Expression Syntax.
                                                             (line  482)
* \\; escape sequence:                   String and Bytes literals.
                                                             (line   72)
* \\; in regular expressions:            Regular Expression Syntax.
                                                             (line  486)
* ^ (caret); in curses module:           curses ascii — Utilities for ASCII characters.
                                                             (line  226)
* ^ (caret); in regular expressions:     Regular Expression Syntax.
                                                             (line   52)
* ^ (caret); in regular expressions <1>: Regular Expression Syntax.
                                                             (line  160)
* ^ (caret); in string formatting:       Format Specification Mini-Language.
                                                             (line   42)
* ^ (caret); marker:                     What About Exceptions?.
                                                             (line   79)
* ^ (caret); marker <1>:                 traceback — Print or retrieve a stack traceback.
                                                             (line   46)
* ^=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* _ (underscore); gettext:               GNU gettext API.    (line   42)
* _ (underscore); in numeric literal:    Numeric literals.   (line   13)
* _ (underscore); in numeric literal <1>: Integer literals.  (line   39)
* _ (underscore); in string formatting:  Format Specification Mini-Language.
                                                             (line  105)
* _, identifiers:                        Keywords.           (line   18)
* _anonymous_ (ctypes.Structure attribute): Structured data types.
                                                             (line   70)
* _asdict() (collections.somenamedtuple method): namedtuple Factory Function for Tuples with Named Fields.
                                                             (line  107)
* _b_base_ (ctypes._CData attribute):    Data types.         (line   71)
* _b_needsfree_ (ctypes._CData attribute): Data types.       (line   78)
* _callmethod() (multiprocessing.managers.BaseProxy method): Proxy Objects.
                                                             (line   60)
* _CData (class in ctypes):              Data types.         (line    6)
* _clear_type_cache() (in module sys):   sys — System-specific parameters and functions.
                                                             (line  144)
* _current_frames() (in module sys):     sys — System-specific parameters and functions.
                                                             (line  153)
* _debugmallocstats() (in module sys):   sys — System-specific parameters and functions.
                                                             (line  210)
* _dummy_thread (module):                _dummy_thread — Drop-in replacement for the _thread module.
                                                             (line    6)
* _enablelegacywindowsfsencoding() (in module sys): sys — System-specific parameters and functions.
                                                             (line 1400)
* _exit() (in module os):                Process Management. (line  114)
* _fields (ast.AST attribute):           Node classes.       (line   22)
* _fields (collections.somenamedtuple attribute): namedtuple Factory Function for Tuples with Named Fields.
                                                             (line  137)
* _fields_ (ctypes.Structure attribute): Structured data types.
                                                             (line   31)
* _field_defaults (collections.somenamedtuple attribute): namedtuple Factory Function for Tuples with Named Fields.
                                                             (line  150)
* _flush() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  116)
* _frozen (C type):                      Importing Modules<2>.
                                                             (line  260)
* _FuncPtr (class in ctypes):            Foreign functions.  (line   12)
* _getframe() (in module sys):           sys — System-specific parameters and functions.
                                                             (line  685)
* _getvalue() (multiprocessing.managers.BaseProxy method): Proxy Objects.
                                                             (line   94)
* _get_child_mock() (unittest.mock.Mock method): The Mock Class.
                                                             (line  224)
* _handle (ctypes.PyDLL attribute):      Loading shared libraries.
                                                             (line  124)
* _inittab (C type):                     Importing Modules<2>.
                                                             (line  288)
* _length_ (ctypes.Array attribute):     Arrays and pointers.
                                                             (line   18)
* _make() (collections.somenamedtuple class method): namedtuple Factory Function for Tuples with Named Fields.
                                                             (line   98)
* _makeResult() (unittest.TextTestRunner method): Loading and running tests.
                                                             (line  464)
* _name (ctypes.PyDLL attribute):        Loading shared libraries.
                                                             (line  128)
* _objects (ctypes._CData attribute):    Data types.         (line   83)
* _pack_ (ctypes.Structure attribute):   Structured data types.
                                                             (line   63)
* _parse() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   21)
* _Pointer (class in ctypes):            Arrays and pointers.
                                                             (line   31)
* _PyBytes_Resize (C function):          Bytes Objects<2>.   (line  182)
* _PyCFunctionFast (C type):             Common Object Structures.
                                                             (line  107)
* _PyCFunctionFastWithKeywords (C type): Common Object Structures.
                                                             (line  112)
* _PyImport_Fini (C function):           Importing Modules<2>.
                                                             (line  238)
* _PyImport_Init (C function):           Importing Modules<2>.
                                                             (line  230)
* _PyObject_FastCallDict (C function):   Object Protocol.    (line  402)
* _PyObject_New (C function):            Allocating Objects on the Heap.
                                                             (line    6)
* _PyObject_NewVar (C function):         Allocating Objects on the Heap.
                                                             (line    9)
* _PyObject_Vectorcall (C function):     Object Protocol.    (line  347)
* _PyTuple_Resize (C function):          Tuple Objects.      (line   88)
* _Py_c_diff (C function):               Complex Numbers as C Structures.
                                                             (line   24)
* _Py_c_neg (C function):                Complex Numbers as C Structures.
                                                             (line   30)
* _Py_c_pow (C function):                Complex Numbers as C Structures.
                                                             (line   50)
* _Py_c_prod (C function):               Complex Numbers as C Structures.
                                                             (line   35)
* _Py_c_quot (C function):               Complex Numbers as C Structures.
                                                             (line   41)
* _Py_c_sum (C function):                Complex Numbers as C Structures.
                                                             (line   19)
* _Py_InitializeMain (C function):       Multi-Phase Initialization Private Provisional API.
                                                             (line   44)
* _Py_NoneStruct (C variable):           Allocating Objects on the Heap.
                                                             (line   59)
* _Py_TPFLAGS_HAVE_VECTORCALL (built-in variable): PyTypeObject Slots.
                                                             (line  623)
* _replace() (collections.somenamedtuple method): namedtuple Factory Function for Tuples with Named Fields.
                                                             (line  125)
* _setroot() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   15)
* _SimpleCData (class in ctypes):        Fundamental data types<2>.
                                                             (line    6)
* _structure() (in module email.iterators): email iterators Iterators.
                                                             (line   44)
* _thread (module):                      _thread — Low-level threading API.
                                                             (line    6)
* _type_ (ctypes.Array attribute):       Arrays and pointers.
                                                             (line   24)
* _type_ (ctypes._Pointer attribute):    Arrays and pointers.
                                                             (line   46)
* _write() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  108)
* _xoptions (in module sys):             sys — System-specific parameters and functions.
                                                             (line 1630)
* __, identifiers:                       Keywords.           (line   17)
* __abs__() (in module operator):        operator — Standard operators as functions.
                                                             (line   73)
* __abs__() (object method):             Emulating numeric types.
                                                             (line  105)
* __add__() (in module operator):        operator — Standard operators as functions.
                                                             (line   78)
* __add__() (object method):             Emulating numeric types.
                                                             (line   11)
* __aenter__() (object method):          Asynchronous Context Managers.
                                                             (line   12)
* __aexit__() (object method):           Asynchronous Context Managers.
                                                             (line   17)
* __aiter__() (object method):           Asynchronous Iterators.
                                                             (line   12)
* __all__:                               Importing * From a Package.
                                                             (line    6)
* __all__ (optional module attribute):   The import statement.
                                                             (line   83)
* __all__ (package variable):            Importing Modules<2>.
                                                             (line    7)
* __and__() (in module operator):        operator — Standard operators as functions.
                                                             (line   83)
* __and__() (object method):             Emulating numeric types.
                                                             (line   11)
* __anext__() (agen method):             Asynchronous generator-iterator methods.
                                                             (line   10)
* __anext__() (object method):           Asynchronous Iterators.
                                                             (line   16)
* __annotations__ (class attribute):     The standard type hierarchy.
                                                             (line  558)
* __annotations__ (function attribute):  The standard type hierarchy.
                                                             (line  274)
* __annotations__ (module attribute):    The standard type hierarchy.
                                                             (line  506)
* __await__() (object method):           Awaitable Objects.  (line   15)
* __bases__ (class attribute):           The standard type hierarchy.
                                                             (line  558)
* __bases__ (class attribute) <1>:       Special Attributes. (line   19)
* __bool__() (object method):            Basic customization.
                                                             (line  298)
* __bool__() (object method) <1>:        Emulating container types.
                                                             (line   39)
* __breakpointhook__ (in module sys):    sys — System-specific parameters and functions.
                                                             (line  306)
* __bytes__() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  129)
* __bytes__() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  128)
* __bytes__() (object method):           Basic customization.
                                                             (line  144)
* __cached__:                            Import-related module attributes.
                                                             (line   69)
* __callback__ (weakref.ref attribute):  weakref — Weak references.
                                                             (line  121)
* __call__() (email.headerregistry.HeaderRegistry method): email headerregistry Custom Header Objects.
                                                             (line  387)
* __call__() (object method):            Emulating callable objects.
                                                             (line    6)
* __call__() (object method) <1>:        Calls.              (line  146)
* __call__() (weakref.finalize method):  weakref — Weak references.
                                                             (line  267)
* __cause__ (exception attribute):       The raise statement.
                                                             (line   30)
* __cause__ (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   21)
* __ceil__() (fractions.Fraction method): fractions — Rational numbers.
                                                             (line  158)
* __ceil__() (object method):            Emulating numeric types.
                                                             (line  135)
* __classcell__ (class namespace entry): Creating the class object.
                                                             (line    6)
* __class_getitem__() (object class method): Emulating generic types.
                                                             (line    9)
* __class__ (instance attribute):        The standard type hierarchy.
                                                             (line  595)
* __class__ (instance attribute) <1>:    Special Attributes. (line   15)
* __class__ (method cell):               Creating the class object.
                                                             (line    6)
* __class__ (module attribute):          Customizing module attribute access.
                                                             (line    6)
* __class__ (unittest.mock.Mock attribute): The Mock Class.  (line  369)
* __closure__ (function attribute):      The standard type hierarchy.
                                                             (line  274)
* __code__ (function attribute):         The standard type hierarchy.
                                                             (line  274)
* __code__ (function object attribute):  Code Objects.       (line    6)
* __complex__() (object method):         Emulating numeric types.
                                                             (line  113)
* __concat__() (in module operator):     operator — Standard operators as functions.
                                                             (line  172)
* __contains__() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  179)
* __contains__() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  290)
* __contains__() (in module operator):   operator — Standard operators as functions.
                                                             (line  177)
* __contains__() (mailbox.Mailbox method): Mailbox objects.  (line  195)
* __contains__() (object method):        Emulating container types.
                                                             (line  148)
* __context__ (exception attribute):     The raise statement.
                                                             (line   30)
* __context__ (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   25)
* __copy__() (copy protocol):            copy — Shallow and deep copy operations.
                                                             (line   73)
* __debug__:                             The assert statement.
                                                             (line   21)
* __debug__ (built-in variable):         Built-in Constants. (line   58)
* __deepcopy__() (copy protocol):        copy — Shallow and deep copy operations.
                                                             (line   73)
* __defaults__ (function attribute):     The standard type hierarchy.
                                                             (line  274)
* __delattr__() (object method):         Customizing attribute access.
                                                             (line   61)
* __delete__() (object method):          Implementing Descriptors.
                                                             (line   40)
* __delitem__() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  224)
* __delitem__() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  322)
* __delitem__() (in module operator):    operator — Standard operators as functions.
                                                             (line  187)
* __delitem__() (mailbox.Mailbox method): Mailbox objects.   (line   76)
* __delitem__() (mailbox.MH method):     MH.                 (line   76)
* __delitem__() (object method):         Emulating container types.
                                                             (line  102)
* __del__() (io.IOBase method):          I/O Base Classes.   (line  164)
* __del__() (object method):             Basic customization.
                                                             (line   54)
* __dict__ (class attribute):            The standard type hierarchy.
                                                             (line  558)
* __dict__ (function attribute):         The standard type hierarchy.
                                                             (line  274)
* __dict__ (instance attribute):         The standard type hierarchy.
                                                             (line  595)
* __dict__ (module attribute):           The standard type hierarchy.
                                                             (line  517)
* __dict__ (module attribute) <1>:       Module Objects.     (line   42)
* __dict__ (object attribute):           Special Attributes. (line   10)
* __dir__ (module attribute):            Customizing module attribute access.
                                                             (line    6)
* __dir__() (object method):             Customizing attribute access.
                                                             (line   67)
* __dir__() (unittest.mock.Mock method): The Mock Class.     (line  215)
* __displayhook__ (in module sys):       sys — System-specific parameters and functions.
                                                             (line  306)
* __divmod__() (object method):          Emulating numeric types.
                                                             (line   11)
* __doc__ (class attribute):             The standard type hierarchy.
                                                             (line  558)
* __doc__ (function attribute):          The standard type hierarchy.
                                                             (line  274)
* __doc__ (method attribute):            The standard type hierarchy.
                                                             (line  361)
* __doc__ (module attribute):            The standard type hierarchy.
                                                             (line  506)
* __doc__ (module attribute) <1>:        Module Objects.     (line   23)
* __doc__ (types.ModuleType attribute):  Standard Interpreter Types.
                                                             (line  111)
* __enter__() (contextmanager method):   Context Manager Types.
                                                             (line   12)
* __enter__() (object method):           With Statement Context Managers.
                                                             (line   21)
* __enter__() (winreg.PyHKEY method):    Registry Handle Objects.
                                                             (line   55)
* __eq__() (email.charset.Charset method): email charset Representing character sets.
                                                             (line  150)
* __eq__() (email.header.Header method): email header Internationalized headers.
                                                             (line  164)
* __eq__() (in module operator):         operator — Standard operators as functions.
                                                             (line   24)
* __eq__() (instance method):            Comparisons<2>.     (line   50)
* __eq__() (memoryview method):          Memory Views.       (line  108)
* __eq__() (object method):              Basic customization.
                                                             (line  172)
* __excepthook__ (in module sys):        sys — System-specific parameters and functions.
                                                             (line  306)
* __exit__() (contextmanager method):    Context Manager Types.
                                                             (line   32)
* __exit__() (object method):            With Statement Context Managers.
                                                             (line   27)
* __exit__() (winreg.PyHKEY method):     Registry Handle Objects.
                                                             (line   55)
* __file__:                              Import-related module attributes.
                                                             (line   67)
* __file__ (module attribute):           The standard type hierarchy.
                                                             (line  506)
* __file__ (module attribute) <1>:       Module Objects.     (line   23)
* __file__ (module attribute) <2>:       Module Objects.     (line   81)
* __float__() (object method):           Emulating numeric types.
                                                             (line  113)
* __floordiv__() (in module operator):   operator — Standard operators as functions.
                                                             (line   88)
* __floordiv__() (object method):        Emulating numeric types.
                                                             (line   11)
* __floor__() (fractions.Fraction method): fractions — Rational numbers.
                                                             (line  148)
* __floor__() (object method):           Emulating numeric types.
                                                             (line  135)
* __format__:                            Built-in Functions. (line  643)
* __format__() (datetime.date method):   date Objects.       (line  274)
* __format__() (datetime.datetime method): datetime Objects. (line  707)
* __format__() (datetime.time method):   time Objects.       (line  215)
* __format__() (object method):          Basic customization.
                                                             (line  149)
* __fspath__() (os.PathLike method):     Process Parameters. (line  120)
* __func__ (method attribute):           The standard type hierarchy.
                                                             (line  361)
* __future__:                            Glossary.           (line  462)
* __future__ (module):                   __future__ — Future statement definitions.
                                                             (line    6)
* __future__; future statement:          Future statements.  (line    6)
* __getattribute__() (object method):    Customizing attribute access.
                                                             (line   32)
* __getattr__ (module attribute):        Customizing module attribute access.
                                                             (line    6)
* __getattr__() (object method):         Customizing attribute access.
                                                             (line   10)
* __getitem__() (email.headerregistry.HeaderRegistry method): email headerregistry Custom Header Objects.
                                                             (line  382)
* __getitem__() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  188)
* __getitem__() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  298)
* __getitem__() (in module operator):    operator — Standard operators as functions.
                                                             (line  192)
* __getitem__() (mailbox.Mailbox method): Mailbox objects.   (line  140)
* __getitem__() (mapping object method): Special method names.
                                                             (line    6)
* __getitem__() (object method):         Emulating container types.
                                                             (line   76)
* __getitem__() (re.Match method):       Match Objects.      (line   83)
* __getnewargs_ex__() (object method):   Pickling Class Instances.
                                                             (line   29)
* __getnewargs__() (object method):      Pickling Class Instances.
                                                             (line   47)
* __getstate__() (copy protocol):        Handling Stateful Objects.
                                                             (line    6)
* __getstate__() (object method):        Pickling Class Instances.
                                                             (line   61)
* __get__() (object method):             Implementing Descriptors.
                                                             (line   13)
* __ge__() (in module operator):         operator — Standard operators as functions.
                                                             (line   24)
* __ge__() (instance method):            Comparisons<2>.     (line   50)
* __ge__() (object method):              Basic customization.
                                                             (line  172)
* __globals__ (function attribute):      The standard type hierarchy.
                                                             (line  274)
* __gt__() (in module operator):         operator — Standard operators as functions.
                                                             (line   24)
* __gt__() (instance method):            Comparisons<2>.     (line   50)
* __gt__() (object method):              Basic customization.
                                                             (line  172)
* __hash__() (object method):            Basic customization.
                                                             (line  217)
* __iadd__() (in module operator):       In-place Operators. (line   36)
* __iadd__() (object method):            Emulating numeric types.
                                                             (line   76)
* __iand__() (in module operator):       In-place Operators. (line   41)
* __iand__() (object method):            Emulating numeric types.
                                                             (line   76)
* __iconcat__() (in module operator):    In-place Operators. (line   46)
* __ifloordiv__() (in module operator):  In-place Operators. (line   52)
* __ifloordiv__() (object method):       Emulating numeric types.
                                                             (line   76)
* __ilshift__() (in module operator):    In-place Operators. (line   57)
* __ilshift__() (object method):         Emulating numeric types.
                                                             (line   76)
* __imatmul__() (in module operator):    In-place Operators. (line   72)
* __imatmul__() (object method):         Emulating numeric types.
                                                             (line   76)
* __imod__() (in module operator):       In-place Operators. (line   62)
* __imod__() (object method):            Emulating numeric types.
                                                             (line   76)
* __import__() (built-in function):      Built-in Functions. (line 1757)
* __import__() (in module importlib):    Functions<10>.      (line    6)
* __imul__() (in module operator):       In-place Operators. (line   67)
* __imul__() (object method):            Emulating numeric types.
                                                             (line   76)
* __index__() (in module operator):      operator — Standard operators as functions.
                                                             (line   93)
* __index__() (object method):           Emulating numeric types.
                                                             (line  121)
* __init_subclass__() (object class method): Customizing class creation.
                                                             (line   13)
* __init__() (difflib.HtmlDiff method):  difflib — Helpers for computing deltas.
                                                             (line   91)
* __init__() (logging.Handler method):   Handler Objects.    (line   13)
* __init__() (logging.logging.Formatter method): Formatters. (line   13)
* __init__() (object method):            Basic customization.
                                                             (line   38)
* __instancecheck__() (class method):    Customizing instance and subclass checks.
                                                             (line   15)
* __interactivehook__ (in module sys):   sys — System-specific parameters and functions.
                                                             (line  909)
* __int__() (object method):             Emulating numeric types.
                                                             (line  113)
* __invert__() (in module operator):     operator — Standard operators as functions.
                                                             (line   98)
* __invert__() (object method):          Emulating numeric types.
                                                             (line  105)
* __inv__() (in module operator):        operator — Standard operators as functions.
                                                             (line   98)
* __ior__() (in module operator):        In-place Operators. (line   79)
* __ior__() (object method):             Emulating numeric types.
                                                             (line   76)
* __ipow__() (in module operator):       In-place Operators. (line   84)
* __ipow__() (object method):            Emulating numeric types.
                                                             (line   76)
* __irshift__() (in module operator):    In-place Operators. (line   89)
* __irshift__() (object method):         Emulating numeric types.
                                                             (line   76)
* __isub__() (in module operator):       In-place Operators. (line   94)
* __isub__() (object method):            Emulating numeric types.
                                                             (line   76)
* __iter__() (container method):         Iterator Types.     (line   14)
* __iter__() (iterator method):          Iterator Types.     (line   29)
* __iter__() (mailbox.Mailbox method):   Mailbox objects.    (line  114)
* __iter__() (object method):            Emulating container types.
                                                             (line  116)
* __iter__() (unittest.TestSuite method): Grouping tests.    (line   60)
* __itruediv__() (in module operator):   In-place Operators. (line   99)
* __itruediv__() (object method):        Emulating numeric types.
                                                             (line   76)
* __ixor__() (in module operator):       In-place Operators. (line  104)
* __ixor__() (object method):            Emulating numeric types.
                                                             (line   76)
* __kwdefaults__ (function attribute):   The standard type hierarchy.
                                                             (line  274)
* __length_hint__() (object method):     Emulating container types.
                                                             (line   52)
* __len__() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  175)
* __len__() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  286)
* __len__() (mailbox.Mailbox method):    Mailbox objects.    (line  200)
* __len__() (mapping object method):     Basic customization.
                                                             (line  300)
* __len__() (object method):             Emulating container types.
                                                             (line   37)
* __le__() (in module operator):         operator — Standard operators as functions.
                                                             (line   24)
* __le__() (instance method):            Comparisons<2>.     (line   50)
* __le__() (object method):              Basic customization.
                                                             (line  172)
* __loader__:                            Import-related module attributes.
                                                             (line   16)
* __loader__ (module attribute):         Module Objects.     (line   23)
* __loader__ (types.ModuleType attribute): Standard Interpreter Types.
                                                             (line  115)
* __lshift__() (in module operator):     operator — Standard operators as functions.
                                                             (line  106)
* __lshift__() (object method):          Emulating numeric types.
                                                             (line   11)
* __lt__() (in module operator):         operator — Standard operators as functions.
                                                             (line   24)
* __lt__() (instance method):            Comparisons<2>.     (line   50)
* __lt__() (object method):              Basic customization.
                                                             (line  172)
* __main__ (module):                     __main__ — Top-level script environment.
                                                             (line    6)
* __matmul__() (in module operator):     operator — Standard operators as functions.
                                                             (line  121)
* __matmul__() (object method):          Emulating numeric types.
                                                             (line   11)
* __missing__():                         Mapping Types — dict.
                                                             (line   84)
* __missing__() (collections.defaultdict method): defaultdict objects.
                                                             (line   22)
* __missing__() (object method):         Emulating container types.
                                                             (line  111)
* __module__ (class attribute):          The standard type hierarchy.
                                                             (line  558)
* __module__ (function attribute):       The standard type hierarchy.
                                                             (line  274)
* __module__ (method attribute):         The standard type hierarchy.
                                                             (line  361)
* __mod__() (in module operator):        operator — Standard operators as functions.
                                                             (line  111)
* __mod__() (object method):             Emulating numeric types.
                                                             (line   11)
* __mro__ (class attribute):             Special Attributes. (line   35)
* __mul__() (in module operator):        operator — Standard operators as functions.
                                                             (line  116)
* __mul__() (object method):             Emulating numeric types.
                                                             (line   11)
* __name__:                              Import-related module attributes.
                                                             (line   10)
* __name__ (class attribute):            The standard type hierarchy.
                                                             (line  558)
* __name__ (definition attribute):       Special Attributes. (line   23)
* __name__ (function attribute):         The standard type hierarchy.
                                                             (line  274)
* __name__ (method attribute):           The standard type hierarchy.
                                                             (line  361)
* __name__ (module attribute):           The standard type hierarchy.
                                                             (line  506)
* __name__ (module attribute) <1>:       Module Objects.     (line   23)
* __name__ (module attribute) <2>:       Module Objects.     (line   55)
* __name__ (types.ModuleType attribute): Standard Interpreter Types.
                                                             (line  123)
* __neg__() (in module operator):        operator — Standard operators as functions.
                                                             (line  128)
* __neg__() (object method):             Emulating numeric types.
                                                             (line  105)
* __new__() (object method):             Basic customization.
                                                             (line    6)
* __next__() (csv.csvreader method):     Reader Objects.     (line    9)
* __next__() (generator method):         Generator-iterator methods.
                                                             (line   12)
* __next__() (iterator method):          Iterator Types.     (line   37)
* __ne__() (email.charset.Charset method): email charset Representing character sets.
                                                             (line  155)
* __ne__() (email.header.Header method): email header Internationalized headers.
                                                             (line  169)
* __ne__() (in module operator):         operator — Standard operators as functions.
                                                             (line   24)
* __ne__() (instance method):            Comparisons<2>.     (line   50)
* __ne__() (object method):              Basic customization.
                                                             (line  172)
* __not__() (in module operator):        operator — Standard operators as functions.
                                                             (line   49)
* __or__() (in module operator):         operator — Standard operators as functions.
                                                             (line  133)
* __or__() (object method):              Emulating numeric types.
                                                             (line   11)
* __package__:                           Import-related module attributes.
                                                             (line   23)
* __package__ (module attribute):        Module Objects.     (line   23)
* __package__ (types.ModuleType attribute): Standard Interpreter Types.
                                                             (line  127)
* __path__:                              Import-related module attributes.
                                                             (line   56)
* __pos__() (in module operator):        operator — Standard operators as functions.
                                                             (line  138)
* __pos__() (object method):             Emulating numeric types.
                                                             (line  105)
* __pow__() (in module operator):        operator — Standard operators as functions.
                                                             (line  143)
* __pow__() (object method):             Emulating numeric types.
                                                             (line   11)
* __prepare__ (metaclass method):        Preparing the class namespace.
                                                             (line    6)
* __qualname__ (definition attribute):   Special Attributes. (line   28)
* __radd__() (object method):            Emulating numeric types.
                                                             (line   41)
* __rand__() (object method):            Emulating numeric types.
                                                             (line   41)
* __rdivmod__() (object method):         Emulating numeric types.
                                                             (line   41)
* __reduce_ex__() (object method):       Pickling Class Instances.
                                                             (line  162)
* __reduce__() (object method):          Pickling Class Instances.
                                                             (line  107)
* __repr__() (multiprocessing.managers.BaseProxy method): Proxy Objects.
                                                             (line  101)
* __repr__() (netrc.netrc method):       netrc Objects.      (line   16)
* __repr__() (object method):            Basic customization.
                                                             (line  113)
* __reversed__() (object method):        Emulating container types.
                                                             (line  127)
* __rfloordiv__() (object method):       Emulating numeric types.
                                                             (line   41)
* __rlshift__() (object method):         Emulating numeric types.
                                                             (line   41)
* __rmatmul__() (object method):         Emulating numeric types.
                                                             (line   41)
* __rmod__() (object method):            Emulating numeric types.
                                                             (line   41)
* __rmul__() (object method):            Emulating numeric types.
                                                             (line   41)
* __ror__() (object method):             Emulating numeric types.
                                                             (line   41)
* __round__() (fractions.Fraction method): fractions — Rational numbers.
                                                             (line  163)
* __round__() (object method):           Emulating numeric types.
                                                             (line  135)
* __rpow__() (object method):            Emulating numeric types.
                                                             (line   41)
* __rrshift__() (object method):         Emulating numeric types.
                                                             (line   41)
* __rshift__() (in module operator):     operator — Standard operators as functions.
                                                             (line  148)
* __rshift__() (object method):          Emulating numeric types.
                                                             (line   11)
* __rsub__() (object method):            Emulating numeric types.
                                                             (line   41)
* __rtruediv__() (object method):        Emulating numeric types.
                                                             (line   41)
* __rxor__() (object method):            Emulating numeric types.
                                                             (line   41)
* __self__ (method attribute):           The standard type hierarchy.
                                                             (line  361)
* __setattr__() (object method):         Customizing attribute access.
                                                             (line   50)
* __setitem__() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  203)
* __setitem__() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  309)
* __setitem__() (in module operator):    operator — Standard operators as functions.
                                                             (line  201)
* __setitem__() (mailbox.Mailbox method): Mailbox objects.   (line   90)
* __setitem__() (mailbox.Maildir method): Maildir.           (line   90)
* __setitem__() (object method):         Emulating container types.
                                                             (line   93)
* __setstate__() (copy protocol):        Handling Stateful Objects.
                                                             (line    6)
* __setstate__() (object method):        Pickling Class Instances.
                                                             (line   70)
* __set_name__() (object method):        Implementing Descriptors.
                                                             (line   45)
* __set__() (object method):             Implementing Descriptors.
                                                             (line   31)
* __slots__:                             Glossary.           (line 1095)
* __spec__:                              Import-related module attributes.
                                                             (line   40)
* __stderr__ (in module sys):            sys — System-specific parameters and functions.
                                                             (line 1477)
* __stdin__ (in module sys):             sys — System-specific parameters and functions.
                                                             (line 1477)
* __stdout__ (in module sys):            sys — System-specific parameters and functions.
                                                             (line 1477)
* __str__() (datetime.date method):      date Objects.       (line  247)
* __str__() (datetime.datetime method):  datetime Objects.   (line  677)
* __str__() (datetime.time method):      time Objects.       (line  205)
* __str__() (email.charset.Charset method): email charset Representing character sets.
                                                             (line  145)
* __str__() (email.header.Header method): email header Internationalized headers.
                                                             (line  152)
* __str__() (email.headerregistry.Address method): email headerregistry Custom Header Objects.
                                                             (line  445)
* __str__() (email.headerregistry.Group method): email headerregistry Custom Header Objects.
                                                             (line  480)
* __str__() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line   95)
* __str__() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line   96)
* __str__() (multiprocessing.managers.BaseProxy method): Proxy Objects.
                                                             (line  105)
* __str__() (object method):             Basic customization.
                                                             (line  129)
* __subclasscheck__() (class method):    Customizing instance and subclass checks.
                                                             (line   21)
* __subclasses__() (class method):       Special Attributes. (line   46)
* __subclasshook__() (abc.ABCMeta method): abc — Abstract Base Classes.
                                                             (line   78)
* __sub__() (in module operator):        operator — Standard operators as functions.
                                                             (line  153)
* __sub__() (object method):             Emulating numeric types.
                                                             (line   11)
* __suppress_context__ (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   30)
* __traceback__ (exception attribute):   The raise statement.
                                                             (line    6)
* __truediv__() (in module operator):    operator — Standard operators as functions.
                                                             (line  158)
* __truediv__() (object method):         Emulating numeric types.
                                                             (line   11)
* __trunc__() (object method):           Emulating numeric types.
                                                             (line  135)
* __unraisablehook__ (in module sys):    sys — System-specific parameters and functions.
                                                             (line  306)
* __xor__() (in module operator):        operator — Standard operators as functions.
                                                             (line  164)
* __xor__() (object method):             Emulating numeric types.
                                                             (line   11)
* {} (curly brackets); dictionary expression: Dictionary displays.
                                                             (line    6)
* {} (curly brackets); in formatted string literal: String literal concatenation.
                                                             (line   24)
* {} (curly brackets); in regular expressions: Regular Expression Syntax.
                                                             (line   95)
* {} (curly brackets); in string formatting: Format String Syntax.
                                                             (line   12)
* {} (curly brackets); set expression:   Set displays.       (line    6)
* | (vertical bar); in regular expressions: Regular Expression Syntax.
                                                             (line  186)
* |=; augmented assignment:              Augmented assignment statements.
                                                             (line    6)
* ~ (tilde); home directory expansion:   os path — Common pathname manipulations.
                                                             (line  135)
* A (in module re):                      Module Contents.    (line   44)
* a-LAW:                                 audioop — Manipulate raw audio data.
                                                             (line   17)
* A-LAW:                                 aifc — Read and write AIFF and AIFC files.
                                                             (line  160)
* A-LAW <1>:                             sndhdr — Determine type of sound file.
                                                             (line    8)
* a2b_base64() (in module binascii):     binascii — Convert between binary and ASCII.
                                                             (line   41)
* a2b_hex() (in module binascii):        binascii — Convert between binary and ASCII.
                                                             (line  149)
* a2b_hqx() (in module binascii):        binascii — Convert between binary and ASCII.
                                                             (line   76)
* a2b_qp() (in module binascii):         binascii — Convert between binary and ASCII.
                                                             (line   55)
* a2b_uu() (in module binascii):         binascii — Convert between binary and ASCII.
                                                             (line   26)
* a85decode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  163)
* a85encode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  140)
* ABC (class in abc):                    abc — Abstract Base Classes.
                                                             (line   26)
* abc (module):                          abc — Abstract Base Classes.
                                                             (line    6)
* ABCMeta (class in abc):                abc — Abstract Base Classes.
                                                             (line   46)
* abiflags (in module sys):              sys — System-specific parameters and functions.
                                                             (line   12)
* abort():                               Process Control.    (line    8)
* abort() (asyncio.DatagramTransport method): Datagram Transports.
                                                             (line   15)
* abort() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line    6)
* abort() (ftplib.FTP method):           FTP Objects.        (line   61)
* abort() (in module os):                Process Management. (line   16)
* abort() (threading.Barrier method):    Barrier Objects.    (line   66)
* above() (curses.panel.Panel method):   Panel Objects.      (line   13)
* ABOVE_NORMAL_PRIORITY_CLASS (in module subprocess): Windows Constants.
                                                             (line   52)
* abs() (built-in function):             Built-in Functions. (line   55)
* abs() (decimal.Context method):        Context objects.    (line  230)
* abs() (in module operator):            operator — Standard operators as functions.
                                                             (line   73)
* abspath() (in module os.path):         os path — Common pathname manipulations.
                                                             (line   54)
* abstract base class:                   Glossary.           (line   32)
* AbstractAsyncContextManager (class in contextlib): Utilities.
                                                             (line   19)
* AbstractBasicAuthHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  332)
* AbstractChildWatcher (class in asyncio): Process Watchers. (line   39)
* abstractclassmethod() (in module abc): abc — Abstract Base Classes.
                                                             (line  165)
* AbstractContextManager (class in contextlib): Utilities.   (line    8)
* AbstractDigestAuthHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  371)
* AbstractEventLoop (class in asyncio):  Event Loop Implementations.
                                                             (line   35)
* AbstractEventLoopPolicy (class in asyncio): Policy Objects.
                                                             (line    8)
* AbstractFormatter (class in formatter): Formatter Implementations.
                                                             (line   18)
* abstractmethod() (in module abc):      abc — Abstract Base Classes.
                                                             (line  122)
* abstractproperty() (in module abc):    abc — Abstract Base Classes.
                                                             (line  201)
* AbstractSet (class in typing):         Classes functions and decorators.
                                                             (line  171)
* abstractstaticmethod() (in module abc): abc — Abstract Base Classes.
                                                             (line  183)
* AbstractWriter (class in formatter):   Writer Implementations.
                                                             (line   16)
* accept() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  229)
* accept() (multiprocessing.connection.Listener method): Listeners and Clients.
                                                             (line   84)
* accept() (socket.socket method):       Socket Objects.     (line   13)
* access() (in module os):               Files and Directories.
                                                             (line   51)
* accumulate() (in module itertools):    Itertool functions. (line   10)
* aclose() (agen method):                Asynchronous generator-iterator methods.
                                                             (line   55)
* aclose() (contextlib.AsyncExitStack method): Utilities.    (line  355)
* acos() (in module cmath):              Trigonometric functions<2>.
                                                             (line    6)
* acos() (in module math):               Trigonometric functions.
                                                             (line    6)
* acosh() (in module cmath):             Hyperbolic functions<2>.
                                                             (line    6)
* acosh() (in module math):              Hyperbolic functions.
                                                             (line    9)
* acquire() (asyncio.Condition method):  Condition.          (line   37)
* acquire() (asyncio.Lock method):       Lock.               (line   25)
* acquire() (asyncio.Semaphore method):  Semaphore.          (line   32)
* acquire() (logging.Handler method):    Handler Objects.    (line   26)
* acquire() (multiprocessing.Lock method): Synchronization primitives.
                                                             (line   64)
* acquire() (multiprocessing.RLock method): Synchronization primitives.
                                                             (line  118)
* acquire() (threading.Condition method): Condition Objects. (line   73)
* acquire() (threading.Lock method):     Lock Objects.       (line   43)
* acquire() (threading.RLock method):    RLock Objects.      (line   35)
* acquire() (threading.Semaphore method): Semaphore Objects. (line   34)
* acquire() (_thread.lock method):       _thread — Low-level threading API.
                                                             (line  126)
* acquire_lock() (in module imp):        imp — Access the import internals.
                                                             (line  274)
* Action (class in argparse):            Action classes.     (line   11)
* action (optparse.Option attribute):    Option attributes.  (line   11)
* ACTIONS (optparse.Option attribute):   Adding new actions. (line   31)
* active_children() (in module multiprocessing): Miscellaneous<3>.
                                                             (line    6)
* active_count() (in module threading):  threading — Thread-based parallelism.
                                                             (line   23)
* add() (decimal.Context method):        Context objects.    (line  234)
* add() (frozenset method):              Set Types — set frozenset.
                                                             (line  184)
* add() (in module audioop):             audioop — Manipulate raw audio data.
                                                             (line   31)
* add() (in module operator):            operator — Standard operators as functions.
                                                             (line   78)
* add() (mailbox.Mailbox method):        Mailbox objects.    (line   59)
* add() (mailbox.Maildir method):        Maildir.            (line   90)
* add() (msilib.RadioButtonGroup method): GUI classes.       (line   34)
* add() (pstats.Stats method):           The Stats Class.    (line   49)
* add() (tarfile.TarFile method):        TarFile Objects.    (line  200)
* add() (tkinter.ttk.Notebook method):   ttk Notebook.       (line    8)
* addAsyncCleanup() (unittest.IsolatedAsyncioTestCase method): Test cases.
                                                             (line  813)
* addaudithook() (in module sys):        sys — System-specific parameters and functions.
                                                             (line   23)
* addch() (curses.window method):        Window Objects.     (line    9)
* addClassCleanup() (unittest.TestCase class method): Test cases.
                                                             (line  751)
* addCleanup() (unittest.TestCase method): Test cases.       (line  721)
* addcomponent() (turtle.Shape method):  Public classes.     (line   66)
* addError() (unittest.TestResult method): Loading and running tests.
                                                             (line  349)
* addExpectedFailure() (unittest.TestResult method): Loading and running tests.
                                                             (line  385)
* addFailure() (unittest.TestResult method): Loading and running tests.
                                                             (line  360)
* addfile() (tarfile.TarFile method):    TarFile Objects.    (line  218)
* addFilter() (logging.Handler method):  Handler Objects.    (line   52)
* addFilter() (logging.Logger method):   Logger Objects.     (line  246)
* addHandler() (logging.Logger method):  Logger Objects.     (line  263)
* addition:                              Binary arithmetic operations.
                                                             (line   60)
* addLevelName() (in module logging):    Module-Level Functions.
                                                             (line  186)
* addModuleCleanup() (in module unittest): setUpModule and tearDownModule.
                                                             (line   18)
* addnstr() (curses.window method):      Window Objects.     (line   23)
* AddPackagePath() (in module modulefinder): modulefinder — Find modules used by a script.
                                                             (line   16)
* addr (smtpd.SMTPChannel attribute):    SMTPChannel Objects.
                                                             (line   52)
* Address (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  400)
* address (email.headerregistry.SingleAddressHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  220)
* address (multiprocessing.connection.Listener attribute): Listeners and Clients.
                                                             (line   99)
* address (multiprocessing.managers.BaseManager attribute): Managers.
                                                             (line  115)
* addresses (email.headerregistry.AddressHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  193)
* addresses (email.headerregistry.Group attribute): email headerregistry Custom Header Objects.
                                                             (line  475)
* AddressHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  178)
* addressof() (in module ctypes):        Utility functions.  (line    6)
* AddressValueError:                     Custom Exceptions.  (line    9)
* address_exclude() (ipaddress.IPv4Network method): Network objects.
                                                             (line  152)
* address_exclude() (ipaddress.IPv6Network method): Network objects.
                                                             (line  299)
* address_family (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line   63)
* address_string() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  320)
* addr_spec (email.headerregistry.Address attribute): email headerregistry Custom Header Objects.
                                                             (line  439)
* addshape() (in module turtle):         Settings and special methods.
                                                             (line   56)
* addsitedir() (in module site):         Module contents<3>. (line   51)
* addSkip() (unittest.TestResult method): Loading and running tests.
                                                             (line  377)
* addstr() (curses.window method):       Window Objects.     (line   31)
* addSubTest() (unittest.TestResult method): Loading and running tests.
                                                             (line  403)
* addSuccess() (unittest.TestResult method): Loading and running tests.
                                                             (line  371)
* addTest() (unittest.TestSuite method): Grouping tests.     (line   25)
* addTests() (unittest.TestSuite method): Grouping tests.    (line   30)
* addTypeEqualityFunc() (unittest.TestCase method): Test cases.
                                                             (line  539)
* addUnexpectedSuccess() (unittest.TestResult method): Loading and running tests.
                                                             (line  395)
* add_alias() (in module email.charset): email charset Representing character sets.
                                                             (line  193)
* add_alternative() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  611)
* add_argument() (argparse.ArgumentParser method): The add_argument method.
                                                             (line    6)
* add_argument_group() (argparse.ArgumentParser method): Argument groups.
                                                             (line    6)
* add_attachment() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  623)
* add_cgi_vars() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  132)
* add_charset() (in module email.charset): email charset Representing character sets.
                                                             (line  164)
* add_child_handler() (asyncio.AbstractChildWatcher method): Process Watchers.
                                                             (line   41)
* add_codec() (in module email.charset): email charset Representing character sets.
                                                             (line  202)
* add_cookie_header() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   11)
* add_data() (in module msilib):         msilib — Read and write Microsoft Installer files.
                                                             (line   74)
* add_dll_directory() (in module os):    Process Management. (line   24)
* add_done_callback() (asyncio.Future method): Future Object.
                                                             (line   76)
* add_done_callback() (asyncio.Task method): Task Object.    (line  116)
* add_done_callback() (concurrent.futures.Future method): Future Objects.
                                                             (line   70)
* add_fallback() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   28)
* add_file() (msilib.Directory method):  Directory Objects.  (line   30)
* add_flag() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   76)
* add_flag() (mailbox.mboxMessage method): mboxMessage.      (line   79)
* add_flag() (mailbox.MMDFMessage method): MMDFMessage.      (line   78)
* add_flowing_data() (formatter.formatter method): The Formatter Interface.
                                                             (line   43)
* add_folder() (mailbox.Maildir method): Maildir.            (line   70)
* add_folder() (mailbox.MH method):      MH.                 (line   42)
* add_get_handler() (email.contentmanager.ContentManager method): email contentmanager Managing MIME Content.
                                                             (line   75)
* add_handler() (urllib.request.OpenerDirector method): OpenerDirector Objects.
                                                             (line    8)
* add_header() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  258)
* add_header() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  356)
* add_header() (urllib.request.Request method): Request Objects.
                                                             (line   79)
* add_header() (wsgiref.headers.Headers method): wsgiref headers – WSGI response header tools.
                                                             (line   61)
* add_history() (in module readline):    History list.       (line   38)
* add_hor_rule() (formatter.formatter method): The Formatter Interface.
                                                             (line   36)
* add_include_dir() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line   96)
* add_label() (mailbox.BabylMessage method): BabylMessage.   (line   55)
* add_label_data() (formatter.formatter method): The Formatter Interface.
                                                             (line   59)
* add_library() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  113)
* add_library_dir() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  135)
* add_line_break() (formatter.formatter method): The Formatter Interface.
                                                             (line   31)
* add_link_object() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  180)
* add_literal_data() (formatter.formatter method): The Formatter Interface.
                                                             (line   53)
* add_mutually_exclusive_group() (argparse.ArgumentParser method): Mutual exclusion.
                                                             (line    6)
* add_option() (optparse.OptionParser method): Defining options.
                                                             (line   14)
* add_parent() (urllib.request.BaseHandler method): BaseHandler Objects.
                                                             (line   10)
* add_password() (urllib.request.HTTPPasswordMgr method): HTTPPasswordMgr Objects.
                                                             (line    9)
* add_password() (urllib.request.HTTPPasswordMgrWithPriorAuth method): HTTPPasswordMgrWithPriorAuth Objects.
                                                             (line   10)
* add_reader() (asyncio.loop method):    Watching file descriptors.
                                                             (line    6)
* add_related() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  598)
* add_runtime_library_dir() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  150)
* add_section() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line   86)
* add_section() (configparser.RawConfigParser method): RawConfigParser Objects.
                                                             (line   26)
* add_sequence() (mailbox.MHMessage method): MHMessage.      (line   41)
* add_set_handler() (email.contentmanager.ContentManager method): email contentmanager Managing MIME Content.
                                                             (line   80)
* add_signal_handler() (asyncio.loop method): Unix signals.  (line    6)
* add_stream() (in module msilib):       msilib — Read and write Microsoft Installer files.
                                                             (line  104)
* add_subparsers() (argparse.ArgumentParser method): Sub-commands.
                                                             (line    6)
* add_tables() (in module msilib):       msilib — Read and write Microsoft Installer files.
                                                             (line   95)
* add_type() (in module mimetypes):      mimetypes — Map filenames to MIME types.
                                                             (line  107)
* add_unredirected_header() (urllib.request.Request method): Request Objects.
                                                             (line   90)
* add_writer() (asyncio.loop method):    Watching file descriptors.
                                                             (line   16)
* adjusted() (decimal.Decimal method):   Decimal objects.    (line  114)
* adler32() (in module zlib):            zlib — Compression compatible with gzip.
                                                             (line   28)
* ADPCM, Intel/DVI:                      audioop — Manipulate raw audio data.
                                                             (line   17)
* adpcm2lin() (in module audioop):       audioop — Manipulate raw audio data.
                                                             (line   38)
* AF_ALG (in module socket):             Constants<8>.       (line  183)
* AF_CAN (in module socket):             Constants<8>.       (line   93)
* AF_INET (in module socket):            Constants<8>.       (line   11)
* AF_INET6 (in module socket):           Constants<8>.       (line   11)
* AF_LINK (in module socket):            Constants<8>.       (line  207)
* AF_PACKET (in module socket):          Constants<8>.       (line  144)
* AF_QIPCRTR (in module socket):         Constants<8>.       (line  235)
* AF_RDS (in module socket):             Constants<8>.       (line  154)
* AF_UNIX (in module socket):            Constants<8>.       (line   11)
* AF_VSOCK (in module socket):           Constants<8>.       (line  194)
* aifc (module):                         aifc — Read and write AIFF and AIFC files.
                                                             (line    6)
* aifc() (aifc.aifc method):             aifc — Read and write AIFF and AIFC files.
                                                             (line  134)
* AIFF:                                  aifc — Read and write AIFF and AIFC files.
                                                             (line    8)
* AIFF <1>:                              chunk — Read IFF chunked data.
                                                             (line    8)
* aiff() (aifc.aifc method):             aifc — Read and write AIFF and AIFC files.
                                                             (line  128)
* AIFF-C:                                aifc — Read and write AIFF and AIFC files.
                                                             (line    8)
* AIFF-C <1>:                            chunk — Read IFF chunked data.
                                                             (line    8)
* alarm() (in module signal):            Module contents<2>. (line  116)
* alaw2lin() (in module audioop):        audioop — Manipulate raw audio data.
                                                             (line   45)
* AlertDescription (class in ssl):       Constants<9>.       (line  481)
* ALERT_DESCRIPTION_HANDSHAKE_FAILURE (in module ssl): Constants<9>.
                                                             (line  467)
* ALERT_DESCRIPTION_INTERNAL_ERROR (in module ssl): Constants<9>.
                                                             (line  467)
* algorithms_available (in module hashlib): Hash algorithms. (line   81)
* algorithms_guaranteed (in module hashlib): Hash algorithms.
                                                             (line   72)
* alias (pdb command):                   Debugger Commands.  (line  280)
* alignment() (in module ctypes):        Utility functions.  (line   14)
* alive (weakref.finalize attribute):    weakref — Weak references.
                                                             (line  284)
* all() (built-in function):             Built-in Functions. (line   62)
* allocate_lock() (in module _thread):   _thread — Low-level threading API.
                                                             (line   68)
* allocfunc (C type):                    Slot Type typedefs. (line    6)
* allowed_domains() (http.cookiejar.DefaultCookiePolicy method): DefaultCookiePolicy Objects.
                                                             (line   58)
* allow_reuse_address (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line   90)
* all_errors (in module ftplib):         ftplib — FTP protocol client.
                                                             (line  104)
* all_features (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   90)
* all_frames (tracemalloc.Filter attribute): Filter.         (line   57)
* all_properties (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line  122)
* all_suffixes() (in module importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   57)
* all_tasks() (asyncio.Task class method): Task Object.      (line  200)
* all_tasks() (in module asyncio):       Introspection.      (line   16)
* alt() (in module curses.ascii):        curses ascii — Utilities for ASCII characters.
                                                             (line  218)
* altsep (in module os):                 Miscellaneous System Information.
                                                             (line  102)
* altzone (in module time):              Timezone Constants. (line    6)
* ALT_DIGITS (in module locale):         locale — Internationalization services.
                                                             (line  295)
* ALWAYS_EQ (in module test.support):    test support — Utilities for the Python test suite.
                                                             (line  145)
* ALWAYS_TYPED_ACTIONS (optparse.Option attribute): Adding new actions.
                                                             (line   43)
* AMPER (in module token):               token — Constants used with Python parse trees.
                                                             (line  102)
* AMPEREQUAL (in module token):          token — Constants used with Python parse trees.
                                                             (line  190)
* and_() (in module operator):           operator — Standard operators as functions.
                                                             (line   83)
* annotated; assignment:                 Annotated assignment statements.
                                                             (line    6)
* annotation:                            Glossary.           (line   47)
* annotation (inspect.Parameter attribute): Introspecting callables with the Signature object.
                                                             (line  154)
* announce() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  503)
* anonymous; function:                   Lambdas.            (line    6)
* answer_challenge() (in module multiprocessing.connection): Listeners and Clients.
                                                             (line   25)
* anticipate_failure() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  543)
* Any (in module typing):                Classes functions and decorators.
                                                             (line  628)
* ANY (in module unittest.mock):         ANY.                (line    6)
* any() (built-in function):             Built-in Functions. (line   73)
* AnyStr (in module typing):             Classes functions and decorators.
                                                             (line  781)
* api_version (in module sys):           sys — System-specific parameters and functions.
                                                             (line 1594)
* apop() (poplib.POP3 method):           POP3 Objects.       (line   41)
* APPDATA:                               PEP 370 Per-user site-packages Directory.
                                                             (line   26)
* append() (array.array method):         array — Efficient arrays of numeric values.
                                                             (line  113)
* append() (collections.deque method):   deque objects.      (line   35)
* append() (email.header.Header method): email header Internationalized headers.
                                                             (line   90)
* append() (imaplib.IMAP4 method):       IMAP4 Objects.      (line   33)
* append() (msilib.CAB method):          CAB Objects.        (line   15)
* append() (pipes.Template method):      Template Objects.   (line   22)
* append() (sequence method):            Mutable Sequence Types.
                                                             (line   16)
* append() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line   87)
* appendChild() (xml.dom.Node method):   Node Objects.       (line  115)
* appendleft() (collections.deque method): deque objects.    (line   39)
* append_history_file() (in module readline): History file.  (line   20)
* application_uri() (in module wsgiref.util): wsgiref util – WSGI environment utilities.
                                                             (line   32)
* apply (2to3 fixer):                    Fixers.             (line   10)
* apply() (multiprocessing.pool.Pool method): Process Pools. (line   51)
* apply_async() (multiprocessing.pool.Pool method): Process Pools.
                                                             (line   59)
* apply_defaults() (inspect.BoundArguments method): Introspecting callables with the Signature object.
                                                             (line  265)
* architecture() (in module platform):   Cross Platform.     (line    6)
* archive (zipimport.zipimporter attribute): zipimporter Objects.
                                                             (line   69)
* aRepr (in module reprlib):             reprlib — Alternate repr implementation.
                                                             (line   24)
* argparse (module):                     argparse — Parser for command-line options arguments and sub-commands.
                                                             (line    6)
* args (BaseException attribute):        Base classes.       (line   17)
* args (functools.partial attribute):    partial Objects.    (line   15)
* args (inspect.BoundArguments attribute): Introspecting callables with the Signature object.
                                                             (line  251)
* args (pdb command):                    Debugger Commands.  (line  226)
* args (subprocess.CompletedProcess attribute): Using the subprocess Module.
                                                             (line   85)
* args (subprocess.Popen attribute):     Popen Objects.      (line   91)
* args_from_interpreter_flags() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  378)
* argtypes (ctypes._FuncPtr attribute):  Foreign functions.  (line   36)
* argument:                              Glossary.           (line   62)
* argument; call semantics:              Slicings.           (line   38)
* argument; difference from parameter:   How can I pass optional or keyword parameters from one function to another?.
                                                             (line   13)
* argument; function definition:         Function definitions.
                                                             (line   53)
* ArgumentDefaultsHelpFormatter (class in argparse): formatter_class.
                                                             (line   10)
* ArgumentError:                         Foreign functions.  (line   83)
* ArgumentParser (class in argparse):    ArgumentParser objects.
                                                             (line    6)
* arguments (inspect.BoundArguments attribute): Introspecting callables with the Signature object.
                                                             (line  235)
* argv (in module sys):                  sys — System-specific parameters and functions.
                                                             (line   50)
* argv (in module sys) <1>:              Process-wide parameters.
                                                             (line  217)
* arithmetic:                            Numeric Types — int float complex.
                                                             (line   27)
* arithmetic; conversion:                Arithmetic conversions.
                                                             (line    6)
* ArithmeticError:                       Base classes.       (line   43)
* array (class in array):                array — Efficient arrays of numeric values.
                                                             (line   75)
* Array (class in ctypes):               Arrays and pointers.
                                                             (line    6)
* array (module):                        array — Efficient arrays of numeric values.
                                                             (line    6)
* Array() (in module multiprocessing):   Shared ctypes Objects.
                                                             (line   41)
* Array() (in module multiprocessing.sharedctypes): The multiprocessing sharedctypes module.
                                                             (line   51)
* Array() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  191)
* arrays:                                array — Efficient arrays of numeric values.
                                                             (line    6)
* arraysize (sqlite3.Cursor attribute):  Cursor Objects.     (line  214)
* article() (nntplib.NNTP method):       Methods<3>.         (line  217)
* as; except clause:                     The try statement.  (line   39)
* as; import statement:                  The import statement.
                                                             (line   38)
* as; with statement:                    The with statement. (line    6)
* ASCII:                                 Notation.           (line   31)
* ASCII <1>:                             Literals.           (line    8)
* ASCII (in module re):                  Module Contents.    (line   44)
* ascii() (built-in function):           Built-in Functions. (line   84)
* ascii() (in module curses.ascii):      curses ascii — Utilities for ASCII characters.
                                                             (line  209)
* ascii_letters (in module string):      String constants.   (line    8)
* ascii_lowercase (in module string):    String constants.   (line   14)
* ascii_uppercase (in module string):    String constants.   (line   19)
* asctime() (in module time):            Functions<2>.       (line    6)
* asdict() (in module dataclasses):      Module-level decorators classes and functions.
                                                             (line  245)
* asend() (agen method):                 Asynchronous generator-iterator methods.
                                                             (line   28)
* asin() (in module cmath):              Trigonometric functions<2>.
                                                             (line   13)
* asin() (in module math):               Trigonometric functions.
                                                             (line   10)
* asinh() (in module cmath):             Hyperbolic functions<2>.
                                                             (line   12)
* asinh() (in module math):              Hyperbolic functions.
                                                             (line   13)
* assertAlmostEqual() (unittest.TestCase method): Test cases.
                                                             (line  460)
* assertCountEqual() (unittest.TestCase method): Test cases. (line  518)
* assertDictEqual() (unittest.TestCase method): Test cases.  (line  627)
* assertEqual() (unittest.TestCase method): Test cases.      (line  173)
* assertFalse() (unittest.TestCase method): Test cases.      (line  198)
* assertGreater() (unittest.TestCase method): Test cases.    (line  485)
* assertGreaterEqual() (unittest.TestCase method): Test cases.
                                                             (line  485)
* assertIn() (unittest.TestCase method): Test cases.         (line  225)
* AssertionError:                        Concrete exceptions.
                                                             (line    8)
* assertIs() (unittest.TestCase method): Test cases.         (line  210)
* assertIsInstance() (unittest.TestCase method): Test cases. (line  232)
* assertIsNone() (unittest.TestCase method): Test cases.     (line  218)
* assertIsNot() (unittest.TestCase method): Test cases.      (line  210)
* assertIsNotNone() (unittest.TestCase method): Test cases.  (line  218)
* assertLess() (unittest.TestCase method): Test cases.       (line  485)
* assertLessEqual() (unittest.TestCase method): Test cases.  (line  485)
* assertListEqual() (unittest.TestCase method): Test cases.  (line  604)
* assertLogs() (unittest.TestCase method): Test cases.       (line  386)
* assertMultiLineEqual() (unittest.TestCase method): Test cases.
                                                             (line  579)
* assertNotAlmostEqual() (unittest.TestCase method): Test cases.
                                                             (line  460)
* assertNotEqual() (unittest.TestCase method): Test cases.   (line  193)
* assertNotIn() (unittest.TestCase method): Test cases.      (line  225)
* assertNotIsInstance() (unittest.TestCase method): Test cases.
                                                             (line  232)
* assertNotRegex() (unittest.TestCase method): Test cases.   (line  497)
* assertRaises() (unittest.TestCase method): Test cases.     (line  267)
* assertRaisesRegex() (unittest.TestCase method): Test cases.
                                                             (line  303)
* assertRegex() (unittest.TestCase method): Test cases.      (line  497)
* asserts (2to3 fixer):                  Fixers.             (line   15)
* assertSequenceEqual() (unittest.TestCase method): Test cases.
                                                             (line  589)
* assertSetEqual() (unittest.TestCase method): Test cases.   (line  615)
* assertTrue() (unittest.TestCase method): Test cases.       (line  198)
* assertTupleEqual() (unittest.TestCase method): Test cases. (line  604)
* assertWarns() (unittest.TestCase method): Test cases.      (line  328)
* assertWarnsRegex() (unittest.TestCase method): Test cases. (line  364)
* assert_any_await() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  521)
* assert_any_call() (unittest.mock.Mock method): The Mock Class.
                                                             (line  125)
* assert_awaited() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  494)
* assert_awaited_once() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  502)
* assert_awaited_once_with() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  514)
* assert_awaited_with() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  508)
* assert_called() (unittest.mock.Mock method): The Mock Class.
                                                             (line   95)
* assert_called_once() (unittest.mock.Mock method): The Mock Class.
                                                             (line  103)
* assert_called_once_with() (unittest.mock.Mock method): The Mock Class.
                                                             (line  118)
* assert_called_with() (unittest.mock.Mock method): The Mock Class.
                                                             (line  111)
* assert_has_awaits() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  528)
* assert_has_calls() (unittest.mock.Mock method): The Mock Class.
                                                             (line  138)
* assert_line_data() (formatter.formatter method): The Formatter Interface.
                                                             (line  143)
* assert_not_awaited() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  542)
* assert_not_called() (unittest.mock.Mock method): The Mock Class.
                                                             (line  151)
* assert_python_failure() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   50)
* assert_python_ok() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   37)
* assignment; statement:                 The standard type hierarchy.
                                                             (line  174)
* assignment; statement <1>:             Assignment statements.
                                                             (line    6)
* AST (class in ast):                    Node classes.       (line    6)
* ast (module):                          ast — Abstract Syntax Trees.
                                                             (line    6)
* astimezone() (datetime.datetime method): datetime Objects. (line  427)
* astuple() (in module dataclasses):     Module-level decorators classes and functions.
                                                             (line  257)
* ASYNC (in module token):               token — Constants used with Python parse trees.
                                                             (line  246)
* async for; in comprehensions:          Displays for lists sets and dictionaries.
                                                             (line   14)
* AsyncContextManager (class in typing): Classes functions and decorators.
                                                             (line  290)
* asynccontextmanager() (in module contextlib): Utilities.   (line   77)
* AsyncExitStack (class in contextlib):  Utilities.          (line  331)
* AsyncGenerator (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  237)
* AsyncGenerator (class in typing):      Classes functions and decorators.
                                                             (line  362)
* AsyncGeneratorType (in module types):  Standard Interpreter Types.
                                                             (line   37)
* asynchat (module):                     asynchat — Asynchronous socket command/response handler.
                                                             (line    6)
* asynchronous context manager:          Glossary.           (line   92)
* asynchronous generator:                Glossary.           (line   98)
* asynchronous generator iterator:       Glossary.           (line  115)
* asynchronous generator; asynchronous iterator: The standard type hierarchy.
                                                             (line  437)
* asynchronous generator; function:      The standard type hierarchy.
                                                             (line  437)
* asynchronous iterable:                 Glossary.           (line  132)
* asynchronous iterator:                 Glossary.           (line  138)
* asyncio (module):                      asyncio — Asynchronous I/O.
                                                             (line    6)
* asyncio.subprocess.DEVNULL (in module asyncio): Constants<7>.
                                                             (line   23)
* asyncio.subprocess.PIPE (in module asyncio): Constants<7>. (line    6)
* asyncio.subprocess.Process (class in asyncio): Interacting with Subprocesses.
                                                             (line   11)
* asyncio.subprocess.STDOUT (in module asyncio): Constants<7>.
                                                             (line   17)
* AsyncIterable (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  223)
* AsyncIterable (class in typing):       Classes functions and decorators.
                                                             (line  270)
* AsyncIterator (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  230)
* AsyncIterator (class in typing):       Classes functions and decorators.
                                                             (line  276)
* AsyncMock (class in unittest.mock):    The Mock Class.     (line  449)
* asyncore (module):                     asyncore — Asynchronous socket handler.
                                                             (line    6)
* AsyncResult (class in multiprocessing.pool): Process Pools.
                                                             (line  179)
* asyncSetUp() (unittest.IsolatedAsyncioTestCase method): Test cases.
                                                             (line  789)
* asyncTearDown() (unittest.IsolatedAsyncioTestCase method): Test cases.
                                                             (line  798)
* async_chat (class in asynchat):        asynchat — Asynchronous socket command/response handler.
                                                             (line   28)
* async_chat.ac_in_buffer_size (in module asynchat): asynchat — Asynchronous socket command/response handler.
                                                             (line   47)
* async_chat.ac_out_buffer_size (in module asynchat): asynchat — Asynchronous socket command/response handler.
                                                             (line   51)
* as_bytes() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  107)
* as_bytes() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  101)
* as_completed() (in module asyncio):    Waiting Primitives. (line   71)
* as_completed() (in module concurrent.futures): Module Functions.
                                                             (line   43)
* as_integer_ratio() (decimal.Decimal method): Decimal objects.
                                                             (line  122)
* as_integer_ratio() (float method):     Additional Methods on Float.
                                                             (line    9)
* as_integer_ratio() (fractions.Fraction method): fractions — Rational numbers.
                                                             (line   98)
* as_integer_ratio() (int method):       Additional Methods on Integer Types.
                                                             (line   97)
* AS_IS (in module formatter):           The Formatter Interface.
                                                             (line   12)
* as_posix() (pathlib.PurePath method):  Methods and properties.
                                                             (line  142)
* as_string() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line   61)
* as_string() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line   60)
* as_tuple() (decimal.Decimal method):   Decimal objects.    (line  136)
* as_uri() (pathlib.PurePath method):    Methods and properties.
                                                             (line  153)
* AT (in module token):                  token — Constants used with Python parse trees.
                                                             (line  222)
* atan() (in module cmath):              Trigonometric functions<2>.
                                                             (line   18)
* atan() (in module math):               Trigonometric functions.
                                                             (line   14)
* atan2() (in module math):              Trigonometric functions.
                                                             (line   18)
* atanh() (in module cmath):             Hyperbolic functions<2>.
                                                             (line   19)
* atanh() (in module math):              Hyperbolic functions.
                                                             (line   17)
* ATEQUAL (in module token):             token — Constants used with Python parse trees.
                                                             (line  226)
* atexit (module):                       atexit — Exit handlers.
                                                             (line    6)
* atexit (weakref.finalize attribute):   weakref — Weak references.
                                                             (line  289)
* athrow() (agen method):                Asynchronous generator-iterator methods.
                                                             (line   43)
* atof() (in module locale):             locale — Internationalization services.
                                                             (line  447)
* atoi() (in module locale):             locale — Internationalization services.
                                                             (line  452)
* atom:                                  Atoms.              (line    6)
* attach() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  157)
* attach_loop() (asyncio.AbstractChildWatcher method): Process Watchers.
                                                             (line   59)
* attach_mock() (unittest.mock.Mock method): The Mock Class. (line  190)
* AttlistDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  208)
* attrgetter() (in module operator):     operator — Standard operators as functions.
                                                             (line  221)
* attrib (xml.etree.ElementTree.Element attribute): Element Objects.
                                                             (line   45)
* attribute:                             The standard type hierarchy.
                                                             (line   13)
* attribute <1>:                         Glossary.           (line  147)
* attribute; assignment:                 Assignment statements.
                                                             (line    6)
* attribute; assignment <1>:             Assignment statements.
                                                             (line   78)
* attribute; deletion:                   The del statement<2>.
                                                             (line   20)
* attribute; reference:                  Attribute references.
                                                             (line    6)
* AttributeError:                        Concrete exceptions.
                                                             (line   12)
* attributes (xml.dom.Node attribute):   Node Objects.       (line   26)
* AttributesImpl (class in xml.sax.xmlreader): xml sax xmlreader — Interface for XML parsers.
                                                             (line   69)
* AttributesNSImpl (class in xml.sax.xmlreader): xml sax xmlreader — Interface for XML parsers.
                                                             (line   80)
* attroff() (curses.window method):      Window Objects.     (line   53)
* attron() (curses.window method):       Window Objects.     (line   58)
* attrset() (curses.window method):      Window Objects.     (line   63)
* at_eof() (asyncio.StreamReader method): StreamReader.      (line   64)
* Audio Interchange File Format:         aifc — Read and write AIFF and AIFC files.
                                                             (line    8)
* Audio Interchange File Format <1>:     chunk — Read IFF chunked data.
                                                             (line    8)
* AUDIODEV:                              ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line   54)
* audioop (module):                      audioop — Manipulate raw audio data.
                                                             (line    6)
* AUDIO_FILE_ENCODING_ADPCM_G721 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   98)
* AUDIO_FILE_ENCODING_ADPCM_G722 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   98)
* AUDIO_FILE_ENCODING_ADPCM_G723_3 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   98)
* AUDIO_FILE_ENCODING_ADPCM_G723_5 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   98)
* AUDIO_FILE_ENCODING_ALAW_8 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   88)
* AUDIO_FILE_ENCODING_DOUBLE (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   98)
* AUDIO_FILE_ENCODING_FLOAT (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   98)
* AUDIO_FILE_ENCODING_LINEAR_16 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   88)
* AUDIO_FILE_ENCODING_LINEAR_24 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   88)
* AUDIO_FILE_ENCODING_LINEAR_32 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   88)
* AUDIO_FILE_ENCODING_LINEAR_8 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   88)
* AUDIO_FILE_ENCODING_MULAW_8 (in module sunau): sunau — Read and write Sun AU files.
                                                             (line   88)
* AUDIO_FILE_MAGIC (in module sunau):    sunau — Read and write Sun AU files.
                                                             (line   82)
* audit (C function):                    Available static markers.
                                                             (line   67)
* audit events:                          Debugging and Profiling.
                                                             (line   11)
* audit() (in module sys):               sys — System-specific parameters and functions.
                                                             (line   68)
* auditing:                              sys — System-specific parameters and functions.
                                                             (line   70)
* augmented; assignment:                 Augmented assignment statements.
                                                             (line    6)
* auth() (ftplib.FTP_TLS method):        FTP_TLS Objects.    (line   14)
* auth() (smtplib.SMTP method):          SMTP Objects.       (line  141)
* authenticate() (imaplib.IMAP4 method): IMAP4 Objects.      (line   37)
* AuthenticationError:                   Process and exceptions.
                                                             (line  205)
* authenticators() (netrc.netrc method): netrc Objects.      (line    8)
* authkey (multiprocessing.Process attribute): Process and exceptions.
                                                             (line  119)
* auto (class in enum):                  Module Contents<2>. (line   39)
* autorange() (timeit.Timer method):     Python Interface.   (line   90)
* avg() (in module audioop):             audioop — Manipulate raw audio data.
                                                             (line   51)
* avgpp() (in module audioop):           audioop — Manipulate raw audio data.
                                                             (line   55)
* avoids_symlink_attacks (shutil.rmtree attribute): Directory and files operations.
                                                             (line  271)
* AWAIT (in module token):               token — Constants used with Python parse trees.
                                                             (line  244)
* await; in comprehensions:              Displays for lists sets and dictionaries.
                                                             (line   45)
* awaitable:                             Glossary.           (line  153)
* Awaitable (class in collections.abc):  Collections Abstract Base Classes.
                                                             (line  187)
* Awaitable (class in typing):           Classes functions and decorators.
                                                             (line  253)
* await_args (unittest.mock.AsyncMock attribute): The Mock Class.
                                                             (line  561)
* await_args_list (unittest.mock.AsyncMock attribute): The Mock Class.
                                                             (line  569)
* await_count (unittest.mock.AsyncMock attribute): The Mock Class.
                                                             (line  554)
* b"; bytes literal:                     String and Bytes literals.
                                                             (line   43)
* b’; bytes literal:                     String and Bytes literals.
                                                             (line   43)
* b16decode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  128)
* b16encode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  123)
* b2a_base64() (in module binascii):     binascii — Convert between binary and ASCII.
                                                             (line   46)
* b2a_hex() (in module binascii):        binascii — Convert between binary and ASCII.
                                                             (line  127)
* b2a_hqx() (in module binascii):        binascii — Convert between binary and ASCII.
                                                             (line  100)
* b2a_qp() (in module binascii):         binascii — Convert between binary and ASCII.
                                                             (line   62)
* b2a_uu() (in module binascii):         binascii — Convert between binary and ASCII.
                                                             (line   32)
* b32decode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  103)
* b32encode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   98)
* b64decode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   55)
* b64encode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   43)
* b85decode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  195)
* b85encode() (in module base64):        base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  184)
* Babyl (class in mailbox):              Babyl.              (line    6)
* BabylMessage (class in mailbox):       BabylMessage.       (line    6)
* back() (in module turtle):             Turtle motion.      (line   17)
* backslash character:                   Explicit line joining.
                                                             (line    6)
* backslashreplace_errors() (in module codecs): Error Handlers.
                                                             (line  151)
* backup() (sqlite3.Connection method):  Connection Objects. (line  403)
* backward() (in module turtle):         Turtle motion.      (line   17)
* BadGzipFile:                           gzip — Support for gzip files.
                                                             (line   63)
* BadStatusLine:                         http client — HTTP protocol client.
                                                             (line  171)
* BadZipFile:                            zipfile — Work with ZIP archives.
                                                             (line   24)
* BadZipfile:                            zipfile — Work with ZIP archives.
                                                             (line   30)
* Balloon (class in tkinter.tix):        Basic Widgets.      (line    6)
* Barrier (class in multiprocessing):    Synchronization primitives.
                                                             (line   13)
* Barrier (class in threading):          Barrier Objects.    (line   23)
* Barrier() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  138)
* base64 (module):                       base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line    6)
* base64; encoding:                      base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line    8)
* BaseCGIHandler (class in wsgiref.handlers): wsgiref handlers – server/gateway base classes.
                                                             (line   53)
* BaseCookie (class in http.cookies):    http cookies — HTTP state management.
                                                             (line   38)
* BaseException:                         Base classes.       (line    9)
* BaseHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  272)
* BaseHandler (class in wsgiref.handlers): wsgiref handlers – server/gateway base classes.
                                                             (line   88)
* BaseHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line   37)
* BaseHTTPRequestHandler (class in http.server): http server — HTTP servers.
                                                             (line   43)
* BaseManager (class in multiprocessing.managers): Managers. (line   23)
* basename() (in module os.path):        os path — Common pathname manipulations.
                                                             (line   62)
* BaseProtocol (class in asyncio):       Base Protocols.     (line    6)
* BaseProxy (class in multiprocessing.managers): Proxy Objects.
                                                             (line   56)
* BaseRequestHandler (class in socketserver): Request Handler Objects.
                                                             (line    6)
* BaseRotatingHandler (class in logging.handlers): BaseRotatingHandler.
                                                             (line   12)
* BaseSelector (class in selectors):     Classes<3>.         (line   48)
* BaseServer (class in socketserver):    Server Objects<2>.  (line    6)
* basestring (2to3 fixer):               Fixers.             (line   60)
* BaseTransport (class in asyncio):      Transports Hierarchy.
                                                             (line    6)
* base_exec_prefix (in module sys):      sys — System-specific parameters and functions.
                                                             (line   91)
* base_prefix (in module sys):           sys — System-specific parameters and functions.
                                                             (line  105)
* basicConfig() (in module logging):     Module-Level Functions.
                                                             (line  231)
* BasicContext (class in decimal):       Context objects.    (line   47)
* BasicInterpolation (class in configparser): Interpolation of values.
                                                             (line   10)
* BasicTestRunner (class in test.support): test support — Utilities for the Python test suite.
                                                             (line 1034)
* baudrate() (in module curses):         Functions<3>.       (line   18)
* bbox() (tkinter.ttk.Treeview method):  ttk Treeview.       (line    8)
* BDADDR_ANY (in module socket):         Constants<8>.       (line  218)
* BDADDR_LOCAL (in module socket):       Constants<8>.       (line  218)
* Bdb (class in bdb):                    bdb — Debugger framework.
                                                             (line   79)
* bdb (module):                          bdb — Debugger framework.
                                                             (line    6)
* BdbQuit:                               bdb — Debugger framework.
                                                             (line   15)
* BDFL:                                  Glossary.           (line  159)
* bdist_msi (class in distutils.command.bdist_msi): distutils command bdist_msi — Build a Microsoft Installer binary package.
                                                             (line    6)
* beep() (in module curses):             Functions<3>.       (line   26)
* Beep() (in module winsound):           winsound — Sound-playing interface for Windows.
                                                             (line   12)
* BEFORE_ASYNC_WITH (opcode):            Python Bytecode Instructions.
                                                             (line  295)
* begin_fill() (in module turtle):       Filling.            (line   12)
* BEGIN_FINALLY (opcode):                Python Bytecode Instructions.
                                                             (line  406)
* begin_poly() (in module turtle):       Special Turtle methods.
                                                             (line    6)
* below() (curses.panel.Panel method):   Panel Objects.      (line   17)
* BELOW_NORMAL_PRIORITY_CLASS (in module subprocess): Windows Constants.
                                                             (line   59)
* benchmarking:                          Functions<2>.       (line  184)
* benchmarking <1>:                      Functions<2>.       (line  202)
* benchmarking <2>:                      Functions<2>.       (line  481)
* Benchmarking:                          timeit — Measure execution time of small code snippets.
                                                             (line    8)
* betavariate() (in module random):      Real-valued distributions.
                                                             (line   33)
* bgcolor() (in module turtle):          Window control.     (line    6)
* bgpic() (in module turtle):            Window control.     (line   16)
* bias() (in module audioop):            audioop — Manipulate raw audio data.
                                                             (line   61)
* bidirectional() (in module unicodedata): unicodedata — Unicode Database.
                                                             (line   54)
* bigaddrspacetest() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  651)
* BigEndianStructure (class in ctypes):  Structured data types.
                                                             (line   10)
* bigmemtest() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  635)
* bin() (built-in function):             Built-in Functions. (line   92)
* Binary (class in msilib):              msilib — Read and write Microsoft Installer files.
                                                             (line   89)
* Binary (class in xmlrpc.client):       Binary Objects.     (line    6)
* binary file:                           Glossary.           (line  164)
* binary literal:                        Numeric literals.   (line    6)
* binary mode:                           Built-in Functions. (line 1212)
* binary semaphores:                     _thread — Low-level threading API.
                                                             (line    6)
* binary; arithmetic; operation:         Binary arithmetic operations.
                                                             (line    6)
* binary; bitwise; operation:            Binary bitwise operations.
                                                             (line    6)
* binary; literals:                      Numeric Types — int float complex.
                                                             (line   19)
* binaryfunc (C type):                   Slot Type typedefs. (line  111)
* BinaryIO (class in typing):            Classes functions and decorators.
                                                             (line  399)
* BINARY_ADD (opcode):                   Python Bytecode Instructions.
                                                             (line  157)
* BINARY_AND (opcode):                   Python Bytecode Instructions.
                                                             (line  177)
* BINARY_FLOOR_DIVIDE (opcode):          Python Bytecode Instructions.
                                                             (line  145)
* BINARY_LSHIFT (opcode):                Python Bytecode Instructions.
                                                             (line  169)
* BINARY_MATRIX_MULTIPLY (opcode):       Python Bytecode Instructions.
                                                             (line  139)
* BINARY_MODULO (opcode):                Python Bytecode Instructions.
                                                             (line  153)
* BINARY_MULTIPLY (opcode):              Python Bytecode Instructions.
                                                             (line  135)
* BINARY_OR (opcode):                    Python Bytecode Instructions.
                                                             (line  185)
* BINARY_POWER (opcode):                 Python Bytecode Instructions.
                                                             (line  131)
* BINARY_RSHIFT (opcode):                Python Bytecode Instructions.
                                                             (line  173)
* BINARY_SUBSCR (opcode):                Python Bytecode Instructions.
                                                             (line  165)
* BINARY_SUBTRACT (opcode):              Python Bytecode Instructions.
                                                             (line  161)
* BINARY_TRUE_DIVIDE (opcode):           Python Bytecode Instructions.
                                                             (line  149)
* BINARY_XOR (opcode):                   Python Bytecode Instructions.
                                                             (line  181)
* binascii (module):                     binascii — Convert between binary and ASCII.
                                                             (line    6)
* bind (widgets):                        Bindings and Events.
                                                             (line    6)
* bind() (asyncore.dispatcher method):   asyncore — Asynchronous socket handler.
                                                             (line  220)
* bind() (inspect.Signature method):     Introspecting callables with the Signature object.
                                                             (line   83)
* bind() (socket.socket method):         Socket Objects.     (line   30)
* binding; name:                         Binding of names.   (line    6)
* binding; name <1>:                     Assignment statements.
                                                             (line    6)
* bindtextdomain() (in module gettext):  GNU gettext API.    (line   14)
* bindtextdomain() (in module locale):   Access to message catalogs.
                                                             (line   14)
* bind_partial() (inspect.Signature method): Introspecting callables with the Signature object.
                                                             (line   90)
* bind_port() (in module test.support):  test support — Utilities for the Python test suite.
                                                             (line  774)
* bind_textdomain_codeset() (in module gettext): GNU gettext API.
                                                             (line   26)
* bind_unix_socket() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  791)
* binhex (module):                       binhex — Encode and decode binhex4 files.
                                                             (line    6)
* binhex() (in module binhex):           binhex — Encode and decode binhex4 files.
                                                             (line   16)
* bisect (module):                       bisect — Array bisection algorithm.
                                                             (line    6)
* bisect() (in module bisect):           bisect — Array bisection algorithm.
                                                             (line   34)
* bisect_left() (in module bisect):      bisect — Array bisection algorithm.
                                                             (line   20)
* bisect_right() (in module bisect):     bisect — Array bisection algorithm.
                                                             (line   34)
* bitmap() (msilib.Dialog method):       GUI classes.        (line   60)
* bitwise; and:                          Binary bitwise operations.
                                                             (line   12)
* bitwise; operations:                   Bitwise Operations on Integer Types.
                                                             (line    6)
* bitwise; or:                           Binary bitwise operations.
                                                             (line   18)
* bitwise; xor:                          Binary bitwise operations.
                                                             (line   15)
* bit_length() (int method):             Additional Methods on Integer Types.
                                                             (line    9)
* bk() (in module turtle):               Turtle motion.      (line   17)
* bkgd() (curses.window method):         Window Objects.     (line   68)
* bkgdset() (curses.window method):      Window Objects.     (line   80)
* blake2b() (in module hashlib):         Creating hash objects.
                                                             (line    8)
* blake2b, blake2s:                      BLAKE2.             (line    6)
* blake2b.MAX_DIGEST_SIZE (in module hashlib): Constants<5>. (line   24)
* blake2b.MAX_KEY_SIZE (in module hashlib): Constants<5>.    (line   18)
* blake2b.PERSON_SIZE (in module hashlib): Constants<5>.     (line   12)
* blake2b.SALT_SIZE (in module hashlib): Constants<5>.       (line    6)
* blake2s() (in module hashlib):         Creating hash objects.
                                                             (line   13)
* blake2s.MAX_DIGEST_SIZE (in module hashlib): Constants<5>. (line   26)
* blake2s.MAX_KEY_SIZE (in module hashlib): Constants<5>.    (line   20)
* blake2s.PERSON_SIZE (in module hashlib): Constants<5>.     (line   14)
* blake2s.SALT_SIZE (in module hashlib): Constants<5>.       (line    8)
* blank line:                            Blank lines.        (line    6)
* block:                                 Structure of a program.
                                                             (line    6)
* blocked_domains() (http.cookiejar.DefaultCookiePolicy method): DefaultCookiePolicy Objects.
                                                             (line   45)
* BlockingIOError:                       OS exceptions.      (line    9)
* BlockingIOError <1>:                   High-level Module Interface.
                                                             (line   37)
* blocksize (http.client.HTTPConnection attribute): HTTPConnection Objects.
                                                             (line  112)
* block_size (hmac.HMAC attribute):      hmac — Keyed-Hashing for Message Authentication.
                                                             (line   94)
* BNF:                                   Notation.           (line    6)
* BNF <1>:                               Expressions.        (line    6)
* body() (nntplib.NNTP method):          Methods<3>.         (line  236)
* body_encode() (email.charset.Charset method): email charset Representing character sets.
                                                             (line  135)
* body_encoding (email.charset.Charset attribute): email charset Representing character sets.
                                                             (line   67)
* body_line_iterator() (in module email.iterators): email iterators Iterators.
                                                             (line   14)
* BOM (in module codecs):                codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_BE (in module codecs):             codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_LE (in module codecs):             codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_UTF16 (in module codecs):          codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_UTF16_BE (in module codecs):       codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_UTF16_LE (in module codecs):       codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_UTF32 (in module codecs):          codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_UTF32_BE (in module codecs):       codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_UTF32_LE (in module codecs):       codecs — Codec registry and base classes.
                                                             (line  241)
* BOM_UTF8 (in module codecs):           codecs — Codec registry and base classes.
                                                             (line  241)
* bool (built-in class):                 Built-in Functions. (line  114)
* Boolean; operation:                    Boolean operations. (line    6)
* Boolean; operations:                   Truth Value Testing.
                                                             (line    6)
* Boolean; operations <1>:               Boolean Operations — and or not.
                                                             (line    6)
* Boolean; type:                         Built-in Functions. (line  124)
* Boolean; values:                       Boolean Values.     (line   15)
* BOOLEAN_STATES (configparser.ConfigParser attribute): Customizing Parser Behaviour.
                                                             (line  245)
* bootstrap() (in module ensurepip):     Module API.         (line   13)
* border() (curses.window method):       Window Objects.     (line   91)
* bottom() (curses.panel.Panel method):  Panel Objects.      (line   21)
* bottom_panel() (in module curses.panel): Functions<4>.     (line    8)
* BoundArguments (class in inspect):     Introspecting callables with the Signature object.
                                                             (line  229)
* BoundaryError:                         email errors Exception and Defect classes.
                                                             (line   38)
* BoundedSemaphore (class in asyncio):   BoundedSemaphore.   (line    6)
* BoundedSemaphore (class in multiprocessing): Synchronization primitives.
                                                             (line   19)
* BoundedSemaphore (class in threading): Semaphore Objects.  (line   69)
* BoundedSemaphore() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  145)
* box() (curses.window method):          Window Objects.     (line  130)
* bpformat() (bdb.Breakpoint method):    bdb — Debugger framework.
                                                             (line   55)
* bpprint() (bdb.Breakpoint method):     bdb — Debugger framework.
                                                             (line   74)
* break (pdb command):                   Debugger Commands.  (line   71)
* Breakpoint (class in bdb):             bdb — Debugger framework.
                                                             (line   22)
* breakpoint() (built-in function):      Built-in Functions. (line  126)
* breakpointhook() (in module sys):      sys — System-specific parameters and functions.
                                                             (line  173)
* breakpoints:                           Help menu Shell and Editor.
                                                             (line   29)
* break_anywhere() (bdb.Bdb method):     bdb — Debugger framework.
                                                             (line  204)
* break_here() (bdb.Bdb method):         bdb — Debugger framework.
                                                             (line  197)
* break_long_words (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  238)
* break_on_hyphens (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  248)
* broadcast_address (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   91)
* broadcast_address (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  269)
* broken (threading.Barrier attribute):  Barrier Objects.    (line   85)
* BrokenBarrierError:                    Barrier Objects.    (line   90)
* BrokenExecutor:                        Exception classes.  (line   14)
* BrokenPipeError:                       OS exceptions.      (line   37)
* BrokenProcessPool:                     Exception classes.  (line   37)
* BrokenThreadPool:                      Exception classes.  (line   29)
* BROWSER:                               webbrowser — Convenient Web-browser controller.
                                                             (line   20)
* BROWSER <1>:                           webbrowser — Convenient Web-browser controller.
                                                             (line   95)
* BsdDbShelf (class in shelve):          Restrictions.       (line   52)
* buf (multiprocessing.shared_memory.SharedMemory attribute): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   87)
* buffer (2to3 fixer):                   Fixers.             (line   64)
* buffer (io.TextIOBase attribute):      Text I/O<2>.        (line   30)
* buffer (unittest.TestResult attribute): Loading and running tests.
                                                             (line  274)
* buffer interface; (see buffer protocol): Iterator Protocol.
                                                             (line   24)
* buffer object; (see buffer protocol):  Iterator Protocol.  (line   23)
* buffer protocol:                       Iterator Protocol.  (line   24)
* buffer protocol; binary sequence types: printf-style String Formatting.
                                                             (line  189)
* buffer protocol; str (built-in class): Text Sequence Type — str.
                                                             (line   60)
* buffer size, I/O:                      Built-in Functions. (line 1212)
* BufferedIOBase (class in io):          I/O Base Classes.   (line  223)
* BufferedProtocol (class in asyncio):   Base Protocols.     (line   15)
* BufferedRandom (class in io):          Buffered Streams.   (line  134)
* BufferedReader (class in io):          Buffered Streams.   (line   56)
* BufferedRWPair (class in io):          Buffered Streams.   (line  147)
* BufferedWriter (class in io):          Buffered Streams.   (line   95)
* BufferError:                           Base classes.       (line   49)
* BufferingHandler (class in logging.handlers): MemoryHandler.
                                                             (line   19)
* BufferTooShort:                        Process and exceptions.
                                                             (line  197)
* buffer_info() (array.array method):    array — Efficient arrays of numeric values.
                                                             (line  117)
* buffer_size (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line   84)
* buffer_text (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line   91)
* buffer_updated() (asyncio.BufferedProtocol method): Buffered Streaming Protocols.
                                                             (line   35)
* buffer_used (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  100)
* bufsize() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  212)
* BUILD_CONST_KEY_MAP (opcode):          Python Bytecode Instructions.
                                                             (line  558)
* BUILD_LIST (opcode):                   Python Bytecode Instructions.
                                                             (line  540)
* BUILD_LIST_UNPACK (opcode):            Python Bytecode Instructions.
                                                             (line  589)
* BUILD_MAP (opcode):                    Python Bytecode Instructions.
                                                             (line  548)
* BUILD_MAP_UNPACK (opcode):             Python Bytecode Instructions.
                                                             (line  605)
* BUILD_MAP_UNPACK_WITH_CALL (opcode):   Python Bytecode Instructions.
                                                             (line  613)
* build_opener() (in module urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  125)
* build_py (class in distutils.command.build_py): distutils command build_py — Build the py/ pyc files of a package.
                                                             (line    6)
* build_py_2to3 (class in distutils.command.build_py): distutils command build_py — Build the py/ pyc files of a package.
                                                             (line    8)
* BUILD_SET (opcode):                    Python Bytecode Instructions.
                                                             (line  544)
* BUILD_SET_UNPACK (opcode):             Python Bytecode Instructions.
                                                             (line  597)
* BUILD_SLICE (opcode):                  Python Bytecode Instructions.
                                                             (line  858)
* BUILD_STRING (opcode):                 Python Bytecode Instructions.
                                                             (line  566)
* BUILD_TUPLE (opcode):                  Python Bytecode Instructions.
                                                             (line  535)
* BUILD_TUPLE_UNPACK (opcode):           Python Bytecode Instructions.
                                                             (line  573)
* BUILD_TUPLE_UNPACK_WITH_CALL (opcode): Python Bytecode Instructions.
                                                             (line  581)
* built-in function; abs:                Emulating numeric types.
                                                             (line  110)
* built-in function; abs <1>:            Number Protocol.    (line   86)
* built-in function; ascii:              Object Protocol.    (line  176)
* built-in function; bytes:              Basic customization.
                                                             (line  146)
* built-in function; bytes <1>:          Object Protocol.    (line  197)
* built-in function; call:               Calls.              (line  131)
* built-in function; chr:                The standard type hierarchy.
                                                             (line  138)
* built-in function; classmethod:        Common Object Structures.
                                                             (line  225)
* built-in function; compile:            The global statement.
                                                             (line   27)
* built-in function; compile <1>:        Code Objects.       (line    6)
* built-in function; compile <2>:        Standard Interpreter Types.
                                                             (line   46)
* built-in function; compile <3>:        Queries on ST Objects.
                                                             (line   14)
* built-in function; compile <4>:        Importing Modules<2>.
                                                             (line  119)
* built-in function; complex:            Emulating numeric types.
                                                             (line  117)
* built-in function; complex <1>:        Numeric Types — int float complex.
                                                             (line   27)
* built-in function; divmod:             Emulating numeric types.
                                                             (line   26)
* built-in function; divmod <1>:         Emulating numeric types.
                                                             (line   56)
* built-in function; divmod <2>:         Number Protocol.    (line   59)
* built-in function; eval:               The global statement.
                                                             (line   27)
* built-in function; eval <1>:           Expression input.   (line    6)
* built-in function; eval <2>:           Code Objects.       (line   14)
* built-in function; eval <3>:           pprint — Data pretty printer.
                                                             (line  132)
* built-in function; eval <4>:           PrettyPrinter Objects.
                                                             (line   26)
* built-in function; eval <5>:           Converting ST Objects.
                                                             (line   45)
* built-in function; exec:               The global statement.
                                                             (line   27)
* built-in function; exec <1>:           Built-in Functions. (line  519)
* built-in function; exec <2>:           Code Objects.       (line   14)
* built-in function; exec <3>:           Converting ST Objects.
                                                             (line   45)
* built-in function; float:              Emulating numeric types.
                                                             (line  117)
* built-in function; float <1>:          Numeric Types — int float complex.
                                                             (line   27)
* built-in function; float <2>:          Number Protocol.    (line  238)
* built-in function; hash:               Basic customization.
                                                             (line  219)
* built-in function; hash <1>:           Immutable Sequence Types.
                                                             (line    6)
* built-in function; hash <2>:           Object Protocol.    (line  424)
* built-in function; hash <3>:           PyTypeObject Slots. (line  311)
* built-in function; help:               Operating System Interface.
                                                             (line   20)
* built-in function; id:                 Objects values and types.
                                                             (line   11)
* built-in function; int:                Emulating numeric types.
                                                             (line  117)
* built-in function; int <1>:            Numeric Types — int float complex.
                                                             (line   27)
* built-in function; int <2>:            Number Protocol.    (line  231)
* built-in function; len:                The standard type hierarchy.
                                                             (line  109)
* built-in function; len <1>:            The standard type hierarchy.
                                                             (line  201)
* built-in function; len <2>:            The standard type hierarchy.
                                                             (line  231)
* built-in function; len <3>:            Emulating container types.
                                                             (line   39)
* built-in function; len <4>:            Common Sequence Operations.
                                                             (line   21)
* built-in function; len <5>:            Mapping Types — dict.
                                                             (line    6)
* built-in function; len <6>:            Object Protocol.    (line  470)
* built-in function; len <7>:            Sequence Protocol.  (line   17)
* built-in function; len <8>:            Mapping Protocol.   (line   20)
* built-in function; len <9>:            List Objects.       (line   39)
* built-in function; len <10>:           Dictionary Objects. (line  133)
* built-in function; len <11>:           Set Objects.        (line   90)
* built-in function; max:                Common Sequence Operations.
                                                             (line   21)
* built-in function; min:                Common Sequence Operations.
                                                             (line   21)
* built-in function; open:               Reading and Writing Files.
                                                             (line    6)
* built-in function; open <1>:           The standard type hierarchy.
                                                             (line  600)
* built-in function; ord:                The standard type hierarchy.
                                                             (line  138)
* built-in function; pow:                Emulating numeric types.
                                                             (line   26)
* built-in function; pow <1>:            Emulating numeric types.
                                                             (line   26)
* built-in function; pow <2>:            Emulating numeric types.
                                                             (line   56)
* built-in function; pow <3>:            Emulating numeric types.
                                                             (line   66)
* built-in function; pow <4>:            Number Protocol.    (line   68)
* built-in function; pow <5>:            Number Protocol.    (line  183)
* built-in function; print:              Basic customization.
                                                             (line  149)
* built-in function; range:              The for statement.  (line   38)
* built-in function; repr:               Expression statements.
                                                             (line   17)
* built-in function; repr <1>:           Finalization and De-allocation.
                                                             (line   49)
* built-in function; repr <2>:           Object Protocol.    (line  164)
* built-in function; repr <3>:           PyTypeObject Slots. (line  252)
* built-in function; round:              Emulating numeric types.
                                                             (line  140)
* built-in function; slice:              The standard type hierarchy.
                                                             (line  769)
* built-in function; slice <1>:          Python Bytecode Instructions.
                                                             (line  860)
* built-in function; staticmethod:       Common Object Structures.
                                                             (line  232)
* built-in function; tuple:              Sequence Protocol.  (line  119)
* built-in function; tuple <1>:          List Objects.       (line  126)
* built-in function; type:               Objects values and types.
                                                             (line   11)
* built-in function; type <1>:           Metaclasses.        (line    6)
* built-in function; type <2>:           Type Objects.       (line    6)
* built-in function; type <3>:           Object Protocol.    (line  451)
* built-in function; __import__:         Importing Modules<2>.
                                                             (line   38)
* built-in method; call:                 Calls.              (line  131)
* built-in; method:                      The standard type hierarchy.
                                                             (line  468)
* built-in; types:                       Built-in Types.     (line    9)
* BuiltinFunctionType (in module types): Standard Interpreter Types.
                                                             (line   66)
* BuiltinImporter (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   67)
* BuiltinMethodType (in module types):   Standard Interpreter Types.
                                                             (line   66)
* builtins (module):                     builtins — Built-in objects.
                                                             (line    6)
* builtin_module_names (in module sys):  sys — System-specific parameters and functions.
                                                             (line  126)
* ButtonBox (class in tkinter.tix):      Basic Widgets.      (line   13)
* bye() (in module turtle):              Methods specific to Screen not inherited from TurtleScreen.
                                                             (line    6)
* byref() (in module ctypes):            Utility functions.  (line   19)
* byte:                                  The standard type hierarchy.
                                                             (line  165)
* bytearray:                             The standard type hierarchy.
                                                             (line  189)
* bytearray (built-in class):            Bytearray Objects.  (line    9)
* bytearray; formatting:                 printf-style Bytes Formatting.
                                                             (line    6)
* bytearray; interpolation:              printf-style Bytes Formatting.
                                                             (line    6)
* bytearray; methods:                    Bytes and Bytearray Operations.
                                                             (line    6)
* bytecode:                              The standard type hierarchy.
                                                             (line  619)
* bytecode <1>:                          Glossary.           (line  194)
* Bytecode (class in dis):               Bytecode analysis.  (line   12)
* Bytecode.codeobj (in module dis):      Bytecode analysis.  (line   39)
* Bytecode.first_line (in module dis):   Bytecode analysis.  (line   43)
* BYTECODE_SUFFIXES (in module importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   40)
* byteorder (in module sys):             sys — System-specific parameters and functions.
                                                             (line  119)
* bytes:                                 The standard type hierarchy.
                                                             (line  165)
* bytes (built-in class):                Bytes Objects.      (line   12)
* bytes (uuid.UUID attribute):           uuid — UUID objects according to RFC 4122.
                                                             (line   79)
* bytes literal:                         Literals.           (line    8)
* bytes-like object:                     Glossary.           (line  175)
* bytes; formatting:                     printf-style Bytes Formatting.
                                                             (line    6)
* bytes; interpolation:                  printf-style Bytes Formatting.
                                                             (line    6)
* bytes; methods:                        Bytes and Bytearray Operations.
                                                             (line    6)
* bytes; str (built-in class):           Text Sequence Type — str.
                                                             (line   60)
* BytesFeedParser (class in email.parser): FeedParser API.   (line   28)
* BytesGenerator (class in email.generator): email generator Generating MIME documents.
                                                             (line   43)
* BytesHeaderParser (class in email.parser): Parser API.     (line   67)
* BytesIO (class in io):                 Buffered Streams.   (line    9)
* BytesParser (class in email.parser):   Parser API.         (line   17)
* ByteString (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  152)
* ByteString (class in typing):          Classes functions and decorators.
                                                             (line  198)
* byteswap() (array.array method):       array — Efficient arrays of numeric values.
                                                             (line  136)
* byteswap() (in module audioop):        audioop — Manipulate raw audio data.
                                                             (line   66)
* BytesWarning:                          Warnings.           (line   54)
* bytes_le (uuid.UUID attribute):        uuid — UUID objects according to RFC 4122.
                                                             (line   84)
* byte_compile() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line  127)
* bz2 (module):                          bz2 — Support for bzip2 compression.
                                                             (line    6)
* BZ2Compressor (class in bz2):          Incremental de compression.
                                                             (line    6)
* BZ2Decompressor (class in bz2):        Incremental de compression.
                                                             (line   33)
* BZ2File (class in bz2):                De compression of files.
                                                             (line   40)
* C:                                     String and Bytes literals.
                                                             (line   72)
* C-contiguous:                          shape strides suboffsets.
                                                             (line   26)
* C-contiguous <1>:                      Glossary.           (line  266)
* C14NWriterTarget (class in xml.etree.ElementTree): TreeBuilder Objects.
                                                             (line   93)
* C; language:                           The standard type hierarchy.
                                                             (line    6)
* C; language <1>:                       The standard type hierarchy.
                                                             (line   89)
* C; language <2>:                       The standard type hierarchy.
                                                             (line  455)
* C; language <3>:                       Comparisons.        (line    6)
* C; language <4>:                       Numeric Types — int float complex.
                                                             (line    6)
* C; language <5>:                       Numeric Types — int float complex.
                                                             (line  102)
* C; structures:                         struct — Interpret bytes as packed binary data.
                                                             (line    8)
* CAB (class in msilib):                 CAB Objects.        (line    6)
* cached (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  399)
* cached_property() (in module functools): functools — Higher-order functions and operations on callable objects.
                                                             (line   16)
* CacheFTPHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  430)
* cache_from_source() (in module imp):   imp — Access the import internals.
                                                             (line  202)
* cache_from_source() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line   21)
* calcobjsize() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  506)
* calcsize() (in module struct):         Functions and Exceptions.
                                                             (line   55)
* calcvobjsize() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  511)
* Calendar (class in calendar):          calendar — General calendar-related functions.
                                                             (line   27)
* calendar (module):                     calendar — General calendar-related functions.
                                                             (line    6)
* calendar() (in module calendar):       calendar — General calendar-related functions.
                                                             (line  349)
* call:                                  Slicings.           (line   38)
* call() (in module subprocess):         Older high-level API.
                                                             (line   10)
* call() (in module unittest.mock):      call.               (line    6)
* call; instance:                        Emulating callable objects.
                                                             (line    8)
* Callable (class in collections.abc):   Collections Abstract Base Classes.
                                                             (line  104)
* Callable (in module typing):           Classes functions and decorators.
                                                             (line  713)
* callable() (built-in function):        Built-in Functions. (line  193)
* CallableProxyType (in module weakref): weakref — Weak references.
                                                             (line  312)
* callback (optparse.Option attribute):  Option attributes.  (line   60)
* callback() (contextlib.ExitStack method): Utilities.       (line  299)
* callbacks (in module gc):              gc — Garbage Collector interface.
                                                             (line  207)
* callback_args (optparse.Option attribute): Option attributes.
                                                             (line   66)
* callback_kwargs (optparse.Option attribute): Option attributes.
                                                             (line   66)
* called (unittest.mock.Mock attribute): The Mock Class.     (line  234)
* CalledProcessError:                    Using the subprocess Module.
                                                             (line  179)
* calloc():                              Overview<3>.        (line   33)
* call_args (unittest.mock.Mock attribute): The Mock Class.  (line  305)
* call_args_list (unittest.mock.Mock attribute): The Mock Class.
                                                             (line  324)
* call_at() (asyncio.loop method):       Scheduling delayed callbacks.
                                                             (line   37)
* call_count (unittest.mock.Mock attribute): The Mock Class. (line  241)
* call_exception_handler() (asyncio.loop method): Error Handling API.
                                                             (line   37)
* CALL_FINALLY (opcode):                 Python Bytecode Instructions.
                                                             (line  702)
* CALL_FUNCTION (opcode):                Python Bytecode Instructions.
                                                             (line  768)
* CALL_FUNCTION_EX (opcode):             Python Bytecode Instructions.
                                                             (line  798)
* CALL_FUNCTION_KW (opcode):             Python Bytecode Instructions.
                                                             (line  781)
* call_later() (asyncio.loop method):    Scheduling delayed callbacks.
                                                             (line   10)
* call_list() (unittest.mock.call method): call.             (line   16)
* CALL_METHOD (opcode):                  Python Bytecode Instructions.
                                                             (line  827)
* call_soon() (asyncio.loop method):     Scheduling callbacks.
                                                             (line    6)
* call_soon_threadsafe() (asyncio.loop method): Scheduling callbacks.
                                                             (line   23)
* call_tracing() (in module sys):        sys — System-specific parameters and functions.
                                                             (line  133)
* cancel() (asyncio.Future method):      Future Object.      (line  106)
* cancel() (asyncio.Handle method):      Callback Handles.   (line   11)
* cancel() (asyncio.Task method):        Task Object.        (line   52)
* cancel() (concurrent.futures.Future method): Future Objects.
                                                             (line   16)
* cancel() (sched.scheduler method):     Scheduler Objects.  (line   41)
* cancel() (threading.Timer method):     Timer Objects.      (line   31)
* cancelled() (asyncio.Future method):   Future Object.      (line   67)
* cancelled() (asyncio.Handle method):   Callback Handles.   (line   16)
* cancelled() (asyncio.Task method):     Task Object.        (line   72)
* cancelled() (concurrent.futures.Future method): Future Objects.
                                                             (line   24)
* CancelledError:                        Exception classes.  (line    6)
* CancelledError <1>:                    Exceptions<9>.      (line   17)
* cancel_dump_traceback_later() (in module faulthandler): Dumping the tracebacks after a timeout.
                                                             (line   29)
* cancel_join_thread() (multiprocessing.Queue method): Pipes and Queues.
                                                             (line  182)
* CannotSendHeader:                      http client — HTTP protocol client.
                                                             (line  163)
* CannotSendRequest:                     http client — HTTP protocol client.
                                                             (line  159)
* canonic() (bdb.Bdb method):            bdb — Debugger framework.
                                                             (line   99)
* canonical() (decimal.Context method):  Context objects.    (line  238)
* canonical() (decimal.Decimal method):  Decimal objects.    (line  141)
* canonicalize() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line    6)
* CAN_BCM (in module socket):            Constants<8>.       (line  107)
* can_change_color() (in module curses): Functions<3>.       (line   30)
* can_fetch() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   33)
* CAN_ISOTP (in module socket):          Constants<8>.       (line  135)
* CAN_RAW_FD_FRAMES (in module socket):  Constants<8>.       (line  122)
* can_symlink() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  521)
* can_write_eof() (asyncio.StreamWriter method): StreamWriter.
                                                             (line   44)
* can_write_eof() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line   14)
* can_xattr() (in module test.support):  test support — Utilities for the Python test suite.
                                                             (line  525)
* capa() (poplib.POP3 method):           POP3 Objects.       (line   24)
* capitalize() (bytearray method):       Bytes and Bytearray Operations.
                                                             (line  403)
* capitalize() (bytes method):           Bytes and Bytearray Operations.
                                                             (line  403)
* capitalize() (str method):             String Methods<2>.  (line   22)
* captured_stderr() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  388)
* captured_stdin() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  388)
* captured_stdout() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  388)
* captureWarnings() (in module logging): Integration with the warnings module.
                                                             (line    9)
* capwords() (in module string):         Helper functions.   (line    6)
* casefold() (str method):               String Methods<2>.  (line   32)
* cast() (in module ctypes):             Utility functions.  (line   33)
* cast() (in module typing):             Classes functions and decorators.
                                                             (line  508)
* cast() (memoryview method):            Memory Views.       (line  264)
* cat() (in module nis):                 nis — Interface to Sun’s NIS Yellow Pages.
                                                             (line   29)
* catch_threading_exception() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  796)
* catch_unraisable_exception() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  821)
* catch_warnings (class in warnings):    Available Context Managers.
                                                             (line    6)
* category() (in module unicodedata):    unicodedata — Unicode Database.
                                                             (line   49)
* cbreak() (in module curses):           Functions<3>.       (line   35)
* CC:                                    New Improved and Deprecated Modules<4>.
                                                             (line   58)
* ccc() (ftplib.FTP_TLS method):         FTP_TLS Objects.    (line   23)
* CCompiler (class in distutils.ccompiler): distutils ccompiler — CCompiler base class.
                                                             (line   67)
* cdf() (statistics.NormalDist method):  NormalDist objects. (line   80)
* CDLL (class in ctypes):                Loading shared libraries.
                                                             (line    9)
* ceil() (in module math):               Numeric Types — int float complex.
                                                             (line  102)
* ceil() (in module math) <1>:           Number-theoretic and representation functions.
                                                             (line    6)
* CellType (in module types):            Standard Interpreter Types.
                                                             (line   55)
* center() (bytearray method):           Bytes and Bytearray Operations.
                                                             (line  236)
* center() (bytes method):               Bytes and Bytearray Operations.
                                                             (line  236)
* center() (str method):                 String Methods<2>.  (line   48)
* CertificateError:                      Exceptions<12>.     (line   94)
* certificates:                          SSL Contexts.       (line  615)
* CERT_NONE (in module ssl):             Constants<9>.       (line   11)
* CERT_OPTIONAL (in module ssl):         Constants<9>.       (line   25)
* CERT_REQUIRED (in module ssl):         Constants<9>.       (line   43)
* cert_store_stats() (ssl.SSLContext method): SSL Contexts.  (line   67)
* cert_time_to_seconds() (in module ssl): Certificate handling.
                                                             (line   42)
* CFLAGS:                                New Improved and Deprecated Modules<4>.
                                                             (line   58)
* CFLAGS <1>:                            Tweaking compiler/linker flags.
                                                             (line   66)
* CFLAGS <2>:                            Tweaking compiler/linker flags.
                                                             (line   67)
* CFUNCTYPE() (in module ctypes):        Function prototypes.
                                                             (line   15)
* cgi (module):                          cgi — Common Gateway Interface support.
                                                             (line    6)
* CGI; debugging:                        Debugging CGI scripts.
                                                             (line    6)
* CGI; exceptions:                       cgitb — Traceback manager for CGI scripts.
                                                             (line    8)
* CGI; protocol:                         cgi — Common Gateway Interface support.
                                                             (line    8)
* CGI; security:                         Caring about security.
                                                             (line    6)
* CGI; tracebacks:                       cgitb — Traceback manager for CGI scripts.
                                                             (line    8)
* CGIHandler (class in wsgiref.handlers): wsgiref handlers – server/gateway base classes.
                                                             (line   11)
* CGIHTTPRequestHandler (class in http.server): http server — HTTP servers.
                                                             (line  438)
* cgitb (module):                        cgitb — Traceback manager for CGI scripts.
                                                             (line    6)
* CGIXMLRPCRequestHandler (class in xmlrpc.server): xmlrpc server — Basic XML-RPC servers.
                                                             (line   45)
* cgi_directories (http.server.CGIHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  464)
* chain() (in module itertools):         Itertool functions. (line   85)
* chaining; comparisons:                 Comparisons.        (line   17)
* chaining; comparisons <1>:             Comparisons<2>.     (line    6)
* ChainMap (class in collections):       ChainMap objects.   (line   16)
* ChainMap (class in typing):            Classes functions and decorators.
                                                             (line  331)
* change_cwd() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  413)
* change_root() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line   64)
* channels() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  133)
* CHANNEL_BINDING_TYPES (in module ssl): Constants<9>.       (line  433)
* channel_class (smtpd.SMTPServer attribute): SMTPServer Objects.
                                                             (line   80)
* character:                             The standard type hierarchy.
                                                             (line  138)
* character <1>:                         Subscriptions.      (line   38)
* character <2>:                         unicodedata — Unicode Database.
                                                             (line    6)
* CharacterDataHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  240)
* characters() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line  129)
* characters_written (BlockingIOError attribute): OS exceptions.
                                                             (line   18)
* Charset (class in email.charset):      email charset Representing character sets.
                                                             (line   24)
* charset() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   83)
* CHAR_MAX (in module locale):           locale — Internationalization services.
                                                             (line  503)
* chdir() (in module os):                Files and Directories.
                                                             (line  115)
* check (lzma.LZMADecompressor attribute): Compressing and decompressing data in memory.
                                                             (line  159)
* check() (imaplib.IMAP4 method):        IMAP4 Objects.      (line   58)
* check() (in module tabnanny):          tabnanny — Detection of ambiguous indentation.
                                                             (line   17)
* checkbox() (msilib.Dialog method):     GUI classes.        (line   78)
* checkcache() (in module linecache):    linecache — Random access to text lines.
                                                             (line   43)
* CHECKED_HASH (py_compile.PycInvalidationMode attribute): py_compile — Compile Python source files.
                                                             (line  108)
* checkfuncname() (in module bdb):       bdb — Debugger framework.
                                                             (line  386)
* CheckList (class in tkinter.tix):      Hierarchical ListBox.
                                                             (line   13)
* checksizeof() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  516)
* checksum; Cyclic Redundancy Check:     zlib — Compression compatible with gzip.
                                                             (line  117)
* check_call() (in module subprocess):   Older high-level API.
                                                             (line   35)
* check_environ() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line   71)
* check_free_after_iterating() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  904)
* check_hostname (ssl.SSLContext attribute): SSL Contexts.   (line  449)
* check_impl_detail() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  286)
* check_no_resource_warning() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  351)
* check_output() (doctest.OutputChecker method): OutputChecker objects.
                                                             (line   17)
* check_output() (in module subprocess): Older high-level API.
                                                             (line   62)
* check_returncode() (subprocess.CompletedProcess method): Using the subprocess Module.
                                                             (line  114)
* check_syntax_error() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  661)
* check_syntax_warning() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  672)
* check_unused_args() (string.Formatter method): Custom String Formatting.
                                                             (line   91)
* check_warnings() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  293)
* check__all__() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  916)
* chflags() (in module os):              Files and Directories.
                                                             (line  131)
* chgat() (curses.window method):        Window Objects.     (line  136)
* childNodes (xml.dom.Node attribute):   Node Objects.       (line   49)
* ChildProcessError:                     OS exceptions.      (line   24)
* children (pyclbr.Class attribute):     Class Objects<2>.   (line   31)
* children (pyclbr.Function attribute):  Function Objects.   (line   31)
* chmod() (in module os):                Files and Directories.
                                                             (line  169)
* chmod() (pathlib.Path method):         Methods<2>.         (line   46)
* choice() (in module random):           Functions for sequences.
                                                             (line    6)
* choice() (in module secrets):          Random numbers.     (line   15)
* choices (optparse.Option attribute):   Option attributes.  (line   55)
* choices() (in module random):          Functions for sequences.
                                                             (line   11)
* chown() (in module os):                Files and Directories.
                                                             (line  228)
* chown() (in module shutil):            Directory and files operations.
                                                             (line  329)
* chr() (built-in function):             Built-in Functions. (line  205)
* chroot() (in module os):               Files and Directories.
                                                             (line  248)
* Chunk (class in chunk):                chunk — Read IFF chunked data.
                                                             (line   49)
* chunk (module):                        chunk — Read IFF chunked data.
                                                             (line    6)
* cipher() (ssl.SSLSocket method):       SSL Sockets.        (line  192)
* cipher; DES:                           crypt — Function to check Unix passwords.
                                                             (line    8)
* circle() (in module turtle):           Turtle motion.      (line  129)
* CIRCUMFLEX (in module token):          token — Constants used with Python parse trees.
                                                             (line  154)
* CIRCUMFLEXEQUAL (in module token):     token — Constants used with Python parse trees.
                                                             (line  198)
* Clamped (class in decimal):            Signals.            (line   20)
* class:                                 Glossary.           (line  209)
* Class (class in symtable):             Examining Symbol Tables.
                                                             (line   93)
* Class browser:                         File menu Shell and Editor.
                                                             (line   22)
* class instance; attribute:             The standard type hierarchy.
                                                             (line  570)
* class instance; attribute; assignment: The standard type hierarchy.
                                                             (line  586)
* class instance; call:                  Calls.              (line  140)
* class object; call:                    The standard type hierarchy.
                                                             (line  543)
* class object; call <1>:                The standard type hierarchy.
                                                             (line  555)
* class object; call <2>:                Calls.              (line  136)
* class variable:                        Glossary.           (line  215)
* class; attribute:                      The standard type hierarchy.
                                                             (line  543)
* class; attribute; assignment:          The standard type hierarchy.
                                                             (line  552)
* class; body:                           Executing the class body.
                                                             (line    6)
* class; constructor:                    Basic customization.
                                                             (line   40)
* class; definition:                     The return statement.
                                                             (line    6)
* class; definition <1>:                 Class definitions.  (line    6)
* class; instance:                       The standard type hierarchy.
                                                             (line  570)
* class; name:                           Class definitions.  (line    6)
* classmethod() (built-in function):     Built-in Functions. (line  216)
* ClassMethodDescriptorType (in module types): Standard Interpreter Types.
                                                             (line   95)
* ClassVar (in module typing):           Classes functions and decorators.
                                                             (line  745)
* clause:                                Compound statements.
                                                             (line   18)
* CLD_CONTINUED (in module os):          Process Management. (line  730)
* CLD_DUMPED (in module os):             Process Management. (line  730)
* CLD_EXITED (in module os):             Process Management. (line  730)
* CLD_TRAPPED (in module os):            Process Management. (line  730)
* clean() (mailbox.Maildir method):      Maildir.            (line   81)
* cleandoc() (in module inspect):        Retrieving source code.
                                                             (line   65)
* CleanImport (class in test.support):   test support — Utilities for the Python test suite.
                                                             (line  993)
* cleanup functions:                     Process Control.    (line   26)
* clear (pdb command):                   Debugger Commands.  (line   93)
* Clear Breakpoint:                      Help menu Shell and Editor.
                                                             (line   30)
* clear() (asyncio.Event method):        Event.              (line   40)
* clear() (collections.deque method):    deque objects.      (line   43)
* clear() (curses.window method):        Window Objects.     (line  152)
* clear() (dict method):                 Mapping Types — dict.
                                                             (line  130)
* clear() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  639)
* clear() (frame method):                The standard type hierarchy.
                                                             (line  711)
* clear() (frozenset method):            Set Types — set frozenset.
                                                             (line  202)
* clear() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   77)
* clear() (in module turtle):            More drawing control.
                                                             (line   13)
* clear() (in module turtle) <1>:        Window control.     (line   30)
* clear() (mailbox.Mailbox method):      Mailbox objects.    (line  204)
* clear() (sequence method):             Mutable Sequence Types.
                                                             (line   16)
* clear() (threading.Event method):      Event Objects.      (line   33)
* clear() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line   58)
* clearcache() (in module linecache):    linecache — Random access to text lines.
                                                             (line   38)
* ClearData() (msilib.Record method):    Record Objects.     (line   37)
* clearok() (curses.window method):      Window Objects.     (line  157)
* clearscreen() (in module turtle):      Window control.     (line   30)
* clearstamp() (in module turtle):       Turtle motion.      (line  178)
* clearstamps() (in module turtle):      Turtle motion.      (line  188)
* clear_all_breaks() (bdb.Bdb method):   bdb — Debugger framework.
                                                             (line  305)
* clear_all_file_breaks() (bdb.Bdb method): bdb — Debugger framework.
                                                             (line  300)
* clear_bpbynumber() (bdb.Bdb method):   bdb — Debugger framework.
                                                             (line  294)
* clear_break() (bdb.Bdb method):        bdb — Debugger framework.
                                                             (line  289)
* clear_cache() (in module filecmp):     filecmp — File and Directory Comparisons.
                                                             (line   53)
* clear_content() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  643)
* clear_flags() (decimal.Context method): Context objects.   (line  152)
* clear_frames() (in module traceback):  traceback — Print or retrieve a stack traceback.
                                                             (line  150)
* clear_history() (in module readline):  History list.       (line    8)
* clear_session_cookies() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   89)
* clear_traces() (in module tracemalloc): Functions<9>.      (line    6)
* clear_traps() (decimal.Context method): Context objects.   (line  156)
* Client() (in module multiprocessing.connection): Listeners and Clients.
                                                             (line   34)
* client_address (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   63)
* CLOCK_BOOTTIME (in module time):       Clock ID Constants. (line    9)
* clock_getres() (in module time):       Functions<2>.       (line   38)
* clock_gettime() (in module time):      Functions<2>.       (line   48)
* clock_gettime_ns() (in module time):   Functions<2>.       (line   58)
* CLOCK_HIGHRES (in module time):        Clock ID Constants. (line   23)
* CLOCK_MONOTONIC (in module time):      Clock ID Constants. (line   34)
* CLOCK_MONOTONIC_RAW (in module time):  Clock ID Constants. (line   43)
* CLOCK_PROCESS_CPUTIME_ID (in module time): Clock ID Constants.
                                                             (line   53)
* CLOCK_PROF (in module time):           Clock ID Constants. (line   61)
* CLOCK_REALTIME (in module time):       Clock ID Constants. (line  100)
* clock_settime() (in module time):      Functions<2>.       (line   67)
* clock_settime_ns() (in module time):   Functions<2>.       (line   76)
* CLOCK_THREAD_CPUTIME_ID (in module time): Clock ID Constants.
                                                             (line   69)
* CLOCK_UPTIME (in module time):         Clock ID Constants. (line   77)
* CLOCK_UPTIME_RAW (in module time):     Clock ID Constants. (line   87)
* clone() (email.generator.BytesGenerator method): email generator Generating MIME documents.
                                                             (line  112)
* clone() (email.generator.Generator method): email generator Generating MIME documents.
                                                             (line  208)
* clone() (email.policy.Policy method):  email policy Policy Objects.
                                                             (line  185)
* clone() (in module turtle):            Special Turtle methods.
                                                             (line   23)
* clone() (pipes.Template method):       Template Objects.   (line   12)
* cloneNode() (xml.dom.Node method):     Node Objects.       (line  147)
* close() (aifc.aifc method):            aifc — Read and write AIFF and AIFC files.
                                                             (line  116)
* close() (aifc.aifc method) <1>:        aifc — Read and write AIFF and AIFC files.
                                                             (line  203)
* close() (asyncio.AbstractChildWatcher method): Process Watchers.
                                                             (line   77)
* close() (asyncio.BaseTransport method): Base Transport.    (line    6)
* close() (asyncio.loop method):         Running and stopping the loop.
                                                             (line   43)
* close() (asyncio.Server method):       Server Objects.     (line   24)
* close() (asyncio.StreamWriter method): StreamWriter.       (line   35)
* close() (asyncio.SubprocessTransport method): Subprocess Transports.
                                                             (line   59)
* close() (asyncore.dispatcher method):  asyncore — Asynchronous socket handler.
                                                             (line  241)
* close() (chunk.Chunk method):          chunk — Read IFF chunked data.
                                                             (line   78)
* close() (contextlib.ExitStack method): Utilities.          (line  324)
* close() (coroutine method):            Coroutine Objects.  (line   45)
* close() (dbm.dumb.dumbdbm method):     dbm dumb — Portable DBM implementation.
                                                             (line   83)
* close() (dbm.gnu.gdbm method):         dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line  118)
* close() (dbm.ndbm.ndbm method):        dbm ndbm — Interface based on ndbm.
                                                             (line   66)
* close() (distutils.text_file.TextFile method): distutils text_file — The TextFile class.
                                                             (line   96)
* close() (email.parser.BytesFeedParser method): FeedParser API.
                                                             (line   65)
* close() (ftplib.FTP method):           FTP Objects.        (line  246)
* close() (generator method):            Generator-iterator methods.
                                                             (line   47)
* close() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   15)
* close() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line  108)
* close() (imaplib.IMAP4 method):        IMAP4 Objects.      (line   62)
* close() (in module fileinput):         fileinput — Iterate over lines from multiple input streams.
                                                             (line  127)
* close() (in module os):                File Descriptor Operations.
                                                             (line   21)
* close() (in module os) <1>:            Sub-interpreter support.
                                                             (line   60)
* close() (in module socket):            Other functions<2>. (line    9)
* close() (io.IOBase method):            I/O Base Classes.   (line   49)
* close() (logging.FileHandler method):  FileHandler.        (line   23)
* close() (logging.Handler method):      Handler Objects.    (line   73)
* close() (logging.handlers.MemoryHandler method): MemoryHandler.
                                                             (line   55)
* close() (logging.handlers.NTEventLogHandler method): NTEventLogHandler.
                                                             (line   29)
* close() (logging.handlers.SocketHandler method): SocketHandler.
                                                             (line   20)
* close() (logging.handlers.SysLogHandler method): SysLogHandler.
                                                             (line   39)
* close() (mailbox.Mailbox method):      Mailbox objects.    (line  262)
* close() (mailbox.Maildir method):      Maildir.            (line  112)
* close() (mailbox.MH method):           MH.                 (line  104)
* close() (mmap.mmap method):            mmap — Memory-mapped file support.
                                                             (line  130)
* Close() (msilib.Database method):      Database Objects.   (line   22)
* Close() (msilib.View method):          View Objects.       (line   35)
* close() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   35)
* close() (multiprocessing.connection.Listener method): Listeners and Clients.
                                                             (line   91)
* close() (multiprocessing.pool.Pool method): Process Pools. (line  156)
* close() (multiprocessing.Process method): Process and exceptions.
                                                             (line  174)
* close() (multiprocessing.Queue method): Pipes and Queues.  (line  163)
* close() (multiprocessing.shared_memory.SharedMemory method): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   65)
* close() (os.scandir method):           Files and Directories.
                                                             (line  728)
* close() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line   22)
* close() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line    8)
* close() (select.devpoll method):       /dev/poll Polling Objects.
                                                             (line   12)
* close() (select.epoll method):         Edge and Level Trigger Polling epoll Objects.
                                                             (line   65)
* close() (select.kqueue method):        Kqueue Objects.     (line    6)
* close() (selectors.BaseSelector method): Classes<3>.       (line  132)
* close() (shelve.Shelf method):         shelve — Python object persistence.
                                                             (line   71)
* close() (socket.socket method):        Socket Objects.     (line   39)
* close() (sqlite3.Connection method):   Connection Objects. (line   45)
* close() (sqlite3.Cursor method):       Cursor Objects.     (line  169)
* close() (sunau.AU_read method):        AU_read Objects.    (line    9)
* close() (sunau.AU_write method):       AU_write Objects.   (line   59)
* close() (tarfile.TarFile method):      TarFile Objects.    (line  248)
* close() (telnetlib.Telnet method):     Telnet Objects.     (line   89)
* close() (urllib.request.BaseHandler method): BaseHandler Objects.
                                                             (line   14)
* close() (wave.Wave_read method):       Wave_read Objects.  (line    9)
* close() (wave.Wave_write method):      Wave_write Objects. (line   23)
* Close() (winreg.PyHKEY method):        Registry Handle Objects.
                                                             (line   33)
* close() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   28)
* close() (xml.etree.ElementTree.XMLParser method): XMLParser Objects.
                                                             (line   20)
* close() (xml.etree.ElementTree.XMLPullParser method): XMLPullParser Objects.
                                                             (line   22)
* close() (xml.sax.xmlreader.IncrementalParser method): IncrementalParser Objects.
                                                             (line   13)
* close() (zipfile.ZipFile method):      ZipFile Objects.    (line   86)
* closed (http.client.HTTPResponse attribute): HTTPResponse Objects.
                                                             (line   65)
* closed (io.IOBase attribute):          I/O Base Classes.   (line   59)
* closed (mmap.mmap attribute):          mmap — Memory-mapped file support.
                                                             (line  136)
* closed (ossaudiodev.oss_audio_device attribute): Audio Device Objects.
                                                             (line  228)
* closed (select.devpoll attribute):     /dev/poll Polling Objects.
                                                             (line   18)
* closed (select.epoll attribute):       Edge and Level Trigger Polling epoll Objects.
                                                             (line   69)
* closed (select.kqueue attribute):      Kqueue Objects.     (line   10)
* CloseKey() (in module winreg):         Functions<11>.      (line    8)
* closelog() (in module syslog):         syslog — Unix syslog library routines.
                                                             (line   53)
* closerange() (in module os):           File Descriptor Operations.
                                                             (line   32)
* close_connection (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   72)
* close_when_done() (asynchat.async_chat method): asynchat — Asynchronous socket command/response handler.
                                                             (line   73)
* closing() (in module contextlib):      Utilities.          (line   95)
* clrtobot() (curses.window method):     Window Objects.     (line  162)
* clrtoeol() (curses.window method):     Window Objects.     (line  168)
* cmath (module):                        cmath — Mathematical functions for complex numbers.
                                                             (line    6)
* Cmd (class in cmd):                    cmd — Support for line-oriented command interpreters.
                                                             (line   15)
* cmd (module):                          cmd — Support for line-oriented command interpreters.
                                                             (line    6)
* cmd (subprocess.CalledProcessError attribute): Using the subprocess Module.
                                                             (line  190)
* cmd (subprocess.TimeoutExpired attribute): Using the subprocess Module.
                                                             (line  153)
* cmdloop() (cmd.Cmd method):            Cmd Objects.        (line    8)
* cmdqueue (cmd.Cmd attribute):          Cmd Objects.        (line  135)
* cmp() (in module filecmp):             filecmp — File and Directory Comparisons.
                                                             (line   16)
* cmpfiles() (in module filecmp):        filecmp — File and Directory Comparisons.
                                                             (line   33)
* cmp_op (in module dis):                Opcode collections. (line   17)
* cmp_to_key() (in module functools):    functools — Higher-order functions and operations on callable objects.
                                                             (line   48)
* CMSG_LEN() (in module socket):         Other functions<2>. (line  293)
* CMSG_SPACE() (in module socket):       Other functions<2>. (line  308)
* code (module):                         code — Interpreter base classes.
                                                             (line    6)
* code (SystemExit attribute):           Concrete exceptions.
                                                             (line  304)
* code (urllib.error.HTTPError attribute): urllib error — Exception classes raised by urllib request.
                                                             (line   38)
* code (xml.etree.ElementTree.ParseError attribute): Exceptions<15>.
                                                             (line   14)
* code (xml.parsers.expat.ExpatError attribute): ExpatError Exceptions.
                                                             (line    9)
* code object:                           The standard type hierarchy.
                                                             (line  619)
* code object <1>:                       Methods.            (line   42)
* code object <2>:                       marshal — Internal Python object serialization.
                                                             (line   30)
* code object <3>:                       Cell Objects.       (line   52)
* code; block:                           Execution model.    (line    6)
* CodecInfo (class in codecs):           codecs — Codec registry and base classes.
                                                             (line   58)
* Codecs:                                codecs — Codec registry and base classes.
                                                             (line    8)
* codecs (module):                       codecs — Codec registry and base classes.
                                                             (line    6)
* Codecs; decode:                        codecs — Codec registry and base classes.
                                                             (line    8)
* Codecs; encode:                        codecs — Codec registry and base classes.
                                                             (line    8)
* coded_value (http.cookies.Morsel attribute): Morsel Objects.
                                                             (line   56)
* codeop (module):                       codeop — Compile Python code.
                                                             (line    6)
* codepoint2name (in module html.entities): html entities — Definitions of HTML general entities.
                                                             (line   35)
* codes (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   16)
* CODESET (in module locale):            locale — Internationalization services.
                                                             (line  183)
* CodeType (in module types):            Standard Interpreter Types.
                                                             (line   44)
* code_info() (in module dis):           Analysis functions. (line   11)
* coding; style:                         Intermezzo Coding Style.
                                                             (line    6)
* coercion:                              Glossary.           (line  220)
* collapse_addresses() (in module ipaddress): Other Module Level Functions.
                                                             (line   37)
* collapse_rfc2231_value() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line  181)
* collect() (in module gc):              gc — Garbage Collector interface.
                                                             (line   34)
* Collection (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  124)
* Collection (class in typing):          Classes functions and decorators.
                                                             (line  165)
* collections (module):                  collections — Container datatypes.
                                                             (line    6)
* collections.abc (module):              collections abc — Abstract Base Classes for Containers.
                                                             (line    6)
* collect_incoming_data() (asynchat.async_chat method): asynchat — Asynchronous socket command/response handler.
                                                             (line   78)
* colno (json.JSONDecodeError attribute): Exceptions<13>.    (line   27)
* colno (re.error attribute):            Module Contents.    (line  379)
* COLON (in module token):               token — Constants used with Python parse trees.
                                                             (line   70)
* COLONEQUAL (in module token):          token — Constants used with Python parse trees.
                                                             (line  238)
* color() (in module turtle):            Color control.      (line   78)
* colormode() (in module turtle):        Settings and special methods.
                                                             (line   32)
* colorsys (module):                     colorsys — Conversions between color systems.
                                                             (line    6)
* color_content() (in module curses):    Functions<3>.       (line   45)
* color_pair() (in module curses):       Functions<3>.       (line   53)
* COLS:                                  curses<2>.          (line    7)
* COLS <1>:                              Functions<3>.       (line  523)
* column() (tkinter.ttk.Treeview method): ttk Treeview.      (line   35)
* COLUMNS:                               Functions<3>.       (line  547)
* COLUMNS <1>:                           Functions<3>.       (line  550)
* columns (os.terminal_size attribute):  Querying the size of a terminal.
                                                             (line   30)
* col_offset (ast.AST attribute):        Node classes.       (line   39)
* comb() (in module math):               Number-theoretic and representation functions.
                                                             (line   12)
* combinations() (in module itertools):  Itertool functions. (line  110)
* combinations_with_replacement() (in module itertools): Itertool functions.
                                                             (line  160)
* combine() (datetime.datetime class method): datetime Objects.
                                                             (line  170)
* combining() (in module unicodedata):   unicodedata — Unicode Database.
                                                             (line   59)
* ComboBox (class in tkinter.tix):       Basic Widgets.      (line   18)
* Combobox (class in tkinter.ttk):       ttk Combobox.       (line    6)
* comma:                                 Parenthesized forms.
                                                             (line   20)
* COMMA (in module token):               token — Constants used with Python parse trees.
                                                             (line   74)
* Command (class in distutils.cmd):      distutils cmd — Abstract base class for Distutils commands.
                                                             (line    8)
* Command (class in distutils.core):     distutils core — Core Distutils functionality.
                                                             (line  307)
* command (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   85)
* command line:                          Complete Python programs.
                                                             (line   25)
* command line option; -?:               Generic options.    (line    6)
* command line option; -b:               Miscellaneous options.
                                                             (line    6)
* command line option; -B:               Miscellaneous options.
                                                             (line   16)
* command line option; -c <command>:     Interface options.  (line   36)
* command line option; –check-hash-based-pycs default|always|never: Miscellaneous options.
                                                             (line   21)
* command line option; -d:               Miscellaneous options.
                                                             (line   35)
* command line option; -E:               Miscellaneous options.
                                                             (line   40)
* command line option; -h:               Generic options.    (line    6)
* command line option; –help:            Generic options.    (line    6)
* command line option; -i:               Miscellaneous options.
                                                             (line   45)
* command line option; -I:               Miscellaneous options.
                                                             (line   56)
* command line option; -J:               Options you shouldn’t use.
                                                             (line    6)
* command line option; -m <module-name>: Interface options.  (line   50)
* command line option; -O:               Miscellaneous options.
                                                             (line   66)
* command line option; -OO:              Miscellaneous options.
                                                             (line   76)
* command line option; -q:               Miscellaneous options.
                                                             (line   85)
* command line option; -R:               Miscellaneous options.
                                                             (line   92)
* command line option; -s:               Miscellaneous options.
                                                             (line  117)
* command line option; -S:               Miscellaneous options.
                                                             (line  127)
* command line option; -u:               Miscellaneous options.
                                                             (line  135)
* command line option; -V:               Generic options.    (line   12)
* command line option; -v:               Miscellaneous options.
                                                             (line  145)
* command line option; –version:         Generic options.    (line   12)
* command line option; -W arg:           Miscellaneous options.
                                                             (line  152)
* command line option; -x:               Miscellaneous options.
                                                             (line  191)
* command line option; -X:               Miscellaneous options.
                                                             (line  196)
* CommandCompiler (class in codeop):     codeop — Compile Python code.
                                                             (line   64)
* commands (pdb command):                Debugger Commands.  (line  126)
* comment:                               Comments.           (line    6)
* comment (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   58)
* COMMENT (in module token):             token — Constants used with Python parse trees.
                                                             (line  261)
* comment (zipfile.ZipFile attribute):   ZipFile Objects.    (line  308)
* comment (zipfile.ZipInfo attribute):   ZipInfo Objects.    (line   88)
* Comment() (in module xml.etree.ElementTree): Functions<6>. (line   65)
* comment() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   49)
* commenters (shlex.shlex attribute):    shlex Objects.      (line   85)
* CommentHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  295)
* comment_url (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   63)
* commit() (msilib.CAB method):          CAB Objects.        (line   24)
* Commit() (msilib.Database method):     Database Objects.   (line   11)
* commit() (sqlite3.Connection method):  Connection Objects. (line   32)
* common (filecmp.dircmp attribute):     The dircmp class.   (line   59)
* Common Gateway Interface:              cgi — Common Gateway Interface support.
                                                             (line    8)
* commonpath() (in module os.path):      os path — Common pathname manipulations.
                                                             (line   73)
* commonprefix() (in module os.path):    os path — Common pathname manipulations.
                                                             (line   88)
* common_dirs (filecmp.dircmp attribute): The dircmp class.  (line   71)
* common_files (filecmp.dircmp attribute): The dircmp class. (line   75)
* common_funny (filecmp.dircmp attribute): The dircmp class. (line   79)
* common_types (in module mimetypes):    mimetypes — Map filenames to MIME types.
                                                             (line  144)
* communicate() (asyncio.asyncio.subprocess.Process method): Interacting with Subprocesses.
                                                             (line   50)
* communicate() (subprocess.Popen method): Popen Objects.    (line   35)
* compare() (decimal.Context method):    Context objects.    (line  242)
* compare() (decimal.Decimal method):    Decimal objects.    (line  147)
* compare() (difflib.Differ method):     Differ Objects.     (line   38)
* compare_digest() (in module hmac):     hmac — Keyed-Hashing for Message Authentication.
                                                             (line  109)
* compare_digest() (in module secrets):  Other functions.    (line    6)
* compare_networks() (ipaddress.IPv4Network method): Network objects.
                                                             (line  200)
* compare_networks() (ipaddress.IPv6Network method): Network objects.
                                                             (line  309)
* COMPARE_OP (opcode):                   Python Bytecode Instructions.
                                                             (line  629)
* compare_signal() (decimal.Context method): Context objects.
                                                             (line  246)
* compare_signal() (decimal.Decimal method): Decimal objects.
                                                             (line  158)
* compare_to() (tracemalloc.Snapshot method): Snapshot.      (line   13)
* compare_total() (decimal.Context method): Context objects. (line  250)
* compare_total() (decimal.Decimal method): Decimal objects. (line  165)
* compare_total_mag() (decimal.Context method): Context objects.
                                                             (line  254)
* compare_total_mag() (decimal.Decimal method): Decimal objects.
                                                             (line  190)
* comparison:                            Comparisons.        (line    6)
* comparisons:                           Basic customization.
                                                             (line  179)
* COMPARISON_FLAGS (in module doctest):  Option Flags.       (line  106)
* Compat32 (class in email.policy):      email policy Policy Objects.
                                                             (line  525)
* compat32 (in module email.policy):     email policy Policy Objects.
                                                             (line  580)
* Compile (class in codeop):             codeop — Compile Python code.
                                                             (line   55)
* compile() (built-in function):         Built-in Functions. (line  243)
* compile() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  269)
* compile() (in module py_compile):      py_compile — Compile Python source files.
                                                             (line   24)
* compile() (in module re):              Module Contents.    (line   14)
* compile() (parser.ST method):          ST Objects.         (line   17)
* compileall (module):                   compileall — Byte-compile Python libraries.
                                                             (line    6)
* compileall command line option; -b:    Command-line use.   (line   52)
* compileall command line option; -d destdir: Command-line use.
                                                             (line   32)
* compileall command line option; -f:    Command-line use.   (line   22)
* compileall command line option; -i list: Command-line use. (line   46)
* compileall command line option; –invalidation-mode [timestamp|checked-hash|unchecked-hash]: Command-line use.
                                                             (line   73)
* compileall command line option; -j N:  Command-line use.   (line   67)
* compileall command line option; -l:    Command-line use.   (line   17)
* compileall command line option; -q:    Command-line use.   (line   26)
* compileall command line option; -r:    Command-line use.   (line   60)
* compileall command line option; -x regex: Command-line use.
                                                             (line   40)
* compileall command line option; directory ...: Command-line use.
                                                             (line    9)
* compileall command line option; file ...: Command-line use.
                                                             (line    9)
* compilest() (in module parser):        Converting ST Objects.
                                                             (line   43)
* compile_command() (in module code):    code — Interpreter base classes.
                                                             (line   47)
* compile_command() (in module codeop):  codeop — Compile Python code.
                                                             (line   29)
* compile_dir() (in module compileall):  Public functions.   (line    6)
* compile_file() (in module compileall): Public functions.   (line   78)
* compile_path() (in module compileall): Public functions.   (line  127)
* complete() (rlcompleter.Completer method): Completer Objects.
                                                             (line    8)
* completedefault() (cmd.Cmd method):    Cmd Objects.        (line   80)
* CompletedProcess (class in subprocess): Using the subprocess Module.
                                                             (line   80)
* complete_statement() (in module sqlite3): Module functions and constants.
                                                             (line  143)
* complex (built-in class):              Built-in Functions. (line  326)
* Complex (class in numbers):            The numeric tower.  (line    6)
* complex literal:                       Numeric literals.   (line    6)
* complex number:                        Glossary.           (line  232)
* complex number; literals:              Numeric Types — int float complex.
                                                             (line   19)
* complex; number:                       The standard type hierarchy.
                                                             (line  101)
* compound; statement:                   Compound statements.
                                                             (line    6)
* compress() (bz2.BZ2Compressor method): Incremental de compression.
                                                             (line   15)
* compress() (in module bz2):            One-shot de compression.
                                                             (line    6)
* compress() (in module gzip):           gzip — Support for gzip files.
                                                             (line  172)
* compress() (in module itertools):      Itertool functions. (line  210)
* compress() (in module lzma):           Compressing and decompressing data in memory.
                                                             (line  183)
* compress() (in module zlib):           zlib — Compression compatible with gzip.
                                                             (line   45)
* compress() (lzma.LZMACompressor method): Compressing and decompressing data in memory.
                                                             (line   81)
* compress() (zlib.Compress method):     zlib — Compression compatible with gzip.
                                                             (line  199)
* compressed (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   47)
* compressed (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  107)
* compressed (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  138)
* compressed (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  277)
* compression() (ssl.SSLSocket method):  SSL Sockets.        (line  210)
* CompressionError:                      tarfile — Read and write tar archive files.
                                                             (line  191)
* compressobj() (in module zlib):        zlib — Compression compatible with gzip.
                                                             (line   60)
* compress_size (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line  139)
* compress_type (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line   84)
* COMSPEC:                               Process Management. (line  635)
* COMSPEC <1>:                           Popen Constructor.  (line   78)
* concat() (in module operator):         operator — Standard operators as functions.
                                                             (line  172)
* concatenation; operation:              Common Sequence Operations.
                                                             (line   21)
* concurrent.futures (module):           concurrent futures — Launching parallel tasks.
                                                             (line    6)
* Condition (class in asyncio):          Condition.          (line    6)
* Condition (class in multiprocessing):  Synchronization primitives.
                                                             (line   32)
* Condition (class in threading):        Condition Objects.  (line   60)
* condition (pdb command):               Debugger Commands.  (line  119)
* condition() (msilib.Control method):   GUI classes.        (line   24)
* Condition() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  150)
* Conditional; expression:               Boolean operations. (line    6)
* conditional; expression:               Conditional expressions.
                                                             (line    6)
* ConfigParser (class in configparser):  ConfigParser Objects.
                                                             (line    6)
* configparser (module):                 configparser — Configuration file parser.
                                                             (line    6)
* configuration information:             sysconfig — Provide access to Python’s configuration information.
                                                             (line   10)
* configuration; file:                   configparser — Configuration file parser.
                                                             (line    8)
* configure() (tkinter.ttk.Style method): Ttk Styling.       (line   24)
* configure_mock() (unittest.mock.Mock method): The Mock Class.
                                                             (line  197)
* confstr() (in module os):              Miscellaneous System Information.
                                                             (line    6)
* confstr_names (in module os):          Miscellaneous System Information.
                                                             (line   28)
* conjugate() (complex number method):   Numeric Types — int float complex.
                                                             (line   92)
* conjugate() (decimal.Decimal method):  Decimal objects.    (line  202)
* conjugate() (numbers.Complex method):  The numeric tower.  (line   23)
* conn (smtpd.SMTPChannel attribute):    SMTPChannel Objects.
                                                             (line   48)
* connect() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  192)
* connect() (ftplib.FTP method):         FTP Objects.        (line   22)
* connect() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line  102)
* connect() (in module sqlite3):         Module functions and constants.
                                                             (line   54)
* connect() (multiprocessing.managers.BaseManager method): Managers.
                                                             (line   56)
* connect() (smtplib.SMTP method):       SMTP Objects.       (line   33)
* connect() (socket.socket method):      Socket Objects.     (line   60)
* Connection (class in multiprocessing.connection): Connection Objects<2>.
                                                             (line   13)
* Connection (class in sqlite3):         Connection Objects. (line    6)
* connection (sqlite3.Cursor attribute): Cursor Objects.     (line  230)
* ConnectionAbortedError:                OS exceptions.      (line   44)
* ConnectionError:                       OS exceptions.      (line   29)
* ConnectionRefusedError:                OS exceptions.      (line   50)
* ConnectionResetError:                  OS exceptions.      (line   56)
* connection_lost() (asyncio.BaseProtocol method): Base Protocol.
                                                             (line   23)
* connection_made() (asyncio.BaseProtocol method): Base Protocol.
                                                             (line   15)
* ConnectRegistry() (in module winreg):  Functions<11>.      (line   17)
* connect_accepted_socket() (asyncio.loop method): Creating network servers.
                                                             (line  115)
* connect_ex() (socket.socket method):   Socket Objects.     (line   82)
* connect_read_pipe() (asyncio.loop method): Working with pipes.
                                                             (line    6)
* connect_write_pipe() (asyncio.loop method): Working with pipes.
                                                             (line   22)
* const (optparse.Option attribute):     Option attributes.  (line   50)
* constant:                              Literals.           (line    6)
* constructor() (in module copyreg):     copyreg — Register pickle support functions.
                                                             (line   17)
* consumed (asyncio.LimitOverrunError attribute): Exceptions<9>.
                                                             (line   65)
* container:                             Objects values and types.
                                                             (line   67)
* container <1>:                         The standard type hierarchy.
                                                             (line  543)
* Container (class in collections.abc):  Collections Abstract Base Classes.
                                                             (line  104)
* Container (class in typing):           Classes functions and decorators.
                                                             (line  153)
* container; iteration over:             Iterator Types.     (line    6)
* contains() (in module operator):       operator — Standard operators as functions.
                                                             (line  177)
* ContentDispositionHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  278)
* ContentHandler (class in xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   18)
* ContentManager (class in email.contentmanager): email contentmanager Managing MIME Content.
                                                             (line   12)
* contents (ctypes._Pointer attribute):  Arrays and pointers.
                                                             (line   50)
* contents() (importlib.abc.ResourceReader method): importlib abc – Abstract base classes related to import.
                                                             (line  330)
* contents() (in module importlib.resources): importlib resources – Resources.
                                                             (line  127)
* ContentTooShortError:                  urllib error — Exception classes raised by urllib request.
                                                             (line   56)
* ContentTransferEncoding (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  288)
* ContentTypeHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  265)
* content_manager (email.policy.EmailPolicy attribute): email policy Policy Objects.
                                                             (line  380)
* content_type (email.headerregistry.ContentTypeHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  270)
* Context (class in contextvars):        Manual Context Management.
                                                             (line   19)
* Context (class in decimal):            Context objects.    (line   96)
* context (ssl.SSLSocket attribute):     SSL Sockets.        (line  301)
* context management protocol:           Context Manager Types.
                                                             (line    6)
* context manager:                       With Statement Context Managers.
                                                             (line   14)
* context manager <1>:                   Context Manager Types.
                                                             (line    6)
* context manager <2>:                   Glossary.           (line  246)
* context variable:                      Glossary.           (line  252)
* ContextDecorator (class in contextlib): Utilities.         (line  189)
* contextlib (module):                   contextlib — Utilities for with-statement contexts.
                                                             (line    6)
* ContextManager (class in typing):      Classes functions and decorators.
                                                             (line  282)
* contextmanager() (in module contextlib): Utilities.        (line   30)
* ContextVar (class in contextvars):     Context Variables.  (line    6)
* contextvars (module):                  contextvars — Context Variables.
                                                             (line    6)
* contextvars.Token (class in contextvars): Context Variables.
                                                             (line   68)
* context_diff() (in module difflib):    difflib — Helpers for computing deltas.
                                                             (line  157)
* contiguous:                            shape strides suboffsets.
                                                             (line   26)
* contiguous <1>:                        Glossary.           (line  262)
* contiguous (memoryview attribute):     Memory Views.       (line  477)
* continue (pdb command):                Debugger Commands.  (line  189)
* Control (class in msilib):             GUI classes.        (line   11)
* Control (class in tkinter.tix):        Basic Widgets.      (line   24)
* control() (msilib.Dialog method):      GUI classes.        (line   47)
* control() (select.kqueue method):      Kqueue Objects.     (line   22)
* controlnames (in module curses.ascii): curses ascii — Utilities for ASCII characters.
                                                             (line  237)
* controls() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   23)
* ConversionError:                       Exceptions<6>.      (line   13)
* convert_arg_line_to_args() (argparse.ArgumentParser method): Customizing file parsing.
                                                             (line    6)
* convert_field() (string.Formatter method): Custom String Formatting.
                                                             (line  108)
* convert_path() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line   54)
* Cookie (class in http.cookiejar):      http cookiejar — Cookie handling for HTTP clients.
                                                             (line  109)
* CookieError:                           http cookies — HTTP state management.
                                                             (line   33)
* CookieJar (class in http.cookiejar):   http cookiejar — Cookie handling for HTTP clients.
                                                             (line   45)
* cookiejar (urllib.request.HTTPCookieProcessor attribute): HTTPCookieProcessor Objects.
                                                             (line    8)
* CookiePolicy (class in http.cookiejar): http cookiejar — Cookie handling for HTTP clients.
                                                             (line   73)
* Coordinated Universal Time:            time — Time access and conversions.
                                                             (line   40)
* Copy:                                  Help menu Shell and Editor.
                                                             (line   30)
* copy (module):                         copy — Shallow and deep copy operations.
                                                             (line    6)
* copy() (collections.deque method):     deque objects.      (line   47)
* copy() (contextvars.Context method):   Manual Context Management.
                                                             (line   45)
* copy() (decimal.Context method):       Context objects.    (line  162)
* copy() (dict method):                  Mapping Types — dict.
                                                             (line  134)
* copy() (frozenset method):             Set Types — set frozenset.
                                                             (line  112)
* copy() (hashlib.hash method):          Hash algorithms.    (line  141)
* copy() (hmac.HMAC method):             hmac — Keyed-Hashing for Message Authentication.
                                                             (line   82)
* copy() (http.cookies.Morsel method):   Morsel Objects.     (line  102)
* copy() (imaplib.IMAP4 method):         IMAP4 Objects.      (line   68)
* copy() (in module copy):               copy — Shallow and deep copy operations.
                                                             (line   18)
* copy() (in module multiprocessing.sharedctypes): The multiprocessing sharedctypes module.
                                                             (line   83)
* copy() (in module shutil):             Directory and files operations.
                                                             (line  112)
* copy() (pipes.Template method):        Template Objects.   (line   48)
* copy() (sequence method):              Mutable Sequence Types.
                                                             (line   16)
* copy() (types.MappingProxyType method): Standard Interpreter Types.
                                                             (line  201)
* copy() (zlib.Compress method):         zlib — Compression compatible with gzip.
                                                             (line  220)
* copy() (zlib.Decompress method):       zlib — Compression compatible with gzip.
                                                             (line  289)
* copy2() (in module shutil):            Directory and files operations.
                                                             (line  136)
* copy; protocol:                        Pickling Class Instances.
                                                             (line   94)
* copyfile() (in module shutil):         Directory and files operations.
                                                             (line   17)
* copyfileobj() (in module shutil):      Directory and files operations.
                                                             (line    6)
* copying files:                         shutil — High-level file operations.
                                                             (line    8)
* copymode() (in module shutil):         Directory and files operations.
                                                             (line   56)
* copyreg (module):                      copyreg — Register pickle support functions.
                                                             (line    6)
* copyright (built-in variable):         Constants added by the site module.
                                                             (line   18)
* copyright (in module sys):             sys — System-specific parameters and functions.
                                                             (line  139)
* copyright (in module sys) <1>:         Process-wide parameters.
                                                             (line  188)
* copysign() (in module math):           Number-theoretic and representation functions.
                                                             (line   30)
* copystat() (in module shutil):         Directory and files operations.
                                                             (line   71)
* copytree() (in module shutil):         Directory and files operations.
                                                             (line  169)
* copy_abs() (decimal.Context method):   Context objects.    (line  259)
* copy_abs() (decimal.Decimal method):   Decimal objects.    (line  207)
* copy_context() (in module contextvars): Manual Context Management.
                                                             (line    6)
* copy_decimal() (decimal.Context method): Context objects.  (line  166)
* copy_file() (in module distutils.file_util): distutils file_util — Single file operations.
                                                             (line    9)
* copy_file_range() (in module os):      File Descriptor Operations.
                                                             (line   44)
* copy_location() (in module ast):       ast Helpers.        (line   96)
* copy_negate() (decimal.Context method): Context objects.   (line  263)
* copy_negate() (decimal.Decimal method): Decimal objects.   (line  213)
* copy_sign() (decimal.Context method):  Context objects.    (line  267)
* copy_sign() (decimal.Decimal method):  Decimal objects.    (line  219)
* copy_tree() (in module distutils.dir_util): distutils dir_util — Directory tree operations.
                                                             (line   32)
* coroutine:                             Special method lookup.
                                                             (line   74)
* coroutine <1>:                         Yield expressions.  (line   51)
* coroutine <2>:                         Glossary.           (line  273)
* Coroutine (class in collections.abc):  Collections Abstract Base Classes.
                                                             (line  205)
* Coroutine (class in typing):           Classes functions and decorators.
                                                             (line  259)
* coroutine function:                    Glossary.           (line  281)
* coroutine() (in module asyncio):       Generator-based Coroutines.
                                                             (line   16)
* coroutine() (in module types):         Coroutine Utility Functions.
                                                             (line    6)
* coroutine; function:                   The standard type hierarchy.
                                                             (line  428)
* CoroutineType (in module types):       Standard Interpreter Types.
                                                             (line   30)
* cos() (in module cmath):               Trigonometric functions<2>.
                                                             (line   25)
* cos() (in module math):                Trigonometric functions.
                                                             (line   28)
* cosh() (in module cmath):              Hyperbolic functions<2>.
                                                             (line   26)
* cosh() (in module math):               Hyperbolic functions.
                                                             (line   21)
* count (tracemalloc.Statistic attribute): Statistic.        (line   15)
* count (tracemalloc.StatisticDiff attribute): StatisticDiff.
                                                             (line   15)
* count() (array.array method):          array — Efficient arrays of numeric values.
                                                             (line  144)
* count() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line   36)
* count() (bytes method):                Bytes and Bytearray Operations.
                                                             (line   36)
* count() (collections.deque method):    deque objects.      (line   53)
* count() (in module itertools):         Itertool functions. (line  223)
* count() (multiprocessing.shared_memory.ShareableList method): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  185)
* count() (sequence method):             Common Sequence Operations.
                                                             (line   21)
* count() (str method):                  String Methods<2>.  (line   55)
* Counter (class in collections):        Counter objects.    (line   23)
* Counter (class in typing):             Classes functions and decorators.
                                                             (line  323)
* countOf() (in module operator):        operator — Standard operators as functions.
                                                             (line  183)
* countTestCases() (unittest.TestCase method): Test cases.   (line  687)
* countTestCases() (unittest.TestSuite method): Grouping tests.
                                                             (line   55)
* count_diff (tracemalloc.StatisticDiff attribute): StatisticDiff.
                                                             (line   20)
* CoverageResults (class in trace):      Programmatic Interface.
                                                             (line   50)
* co_argcount (code object attribute):   The standard type hierarchy.
                                                             (line  632)
* CO_ASYNC_GENERATOR (in module inspect): Code Objects Bit Flags.
                                                             (line   56)
* co_cellvars (code object attribute):   The standard type hierarchy.
                                                             (line  632)
* co_code (code object attribute):       The standard type hierarchy.
                                                             (line  632)
* co_consts (code object attribute):     The standard type hierarchy.
                                                             (line  632)
* CO_COROUTINE (in module inspect):      Code Objects Bit Flags.
                                                             (line   39)
* co_filename (code object attribute):   The standard type hierarchy.
                                                             (line  632)
* co_firstlineno (code object attribute): The standard type hierarchy.
                                                             (line  632)
* co_flags (code object attribute):      The standard type hierarchy.
                                                             (line  632)
* co_freevars (code object attribute):   The standard type hierarchy.
                                                             (line  632)
* CO_FUTURE_DIVISION (C variable):       The Very High Level Layer.
                                                             (line  421)
* CO_GENERATOR (in module inspect):      Code Objects Bit Flags.
                                                             (line   30)
* CO_ITERABLE_COROUTINE (in module inspect): Code Objects Bit Flags.
                                                             (line   47)
* co_kwonlyargcount (code object attribute): The standard type hierarchy.
                                                             (line  632)
* co_lnotab (code object attribute):     The standard type hierarchy.
                                                             (line  632)
* co_name (code object attribute):       The standard type hierarchy.
                                                             (line  632)
* co_names (code object attribute):      The standard type hierarchy.
                                                             (line  632)
* CO_NESTED (in module inspect):         Code Objects Bit Flags.
                                                             (line   26)
* CO_NEWLOCALS (in module inspect):      Code Objects Bit Flags.
                                                             (line   13)
* co_nlocals (code object attribute):    The standard type hierarchy.
                                                             (line  632)
* CO_NOFREE (in module inspect):         Code Objects Bit Flags.
                                                             (line   35)
* CO_OPTIMIZED (in module inspect):      Code Objects Bit Flags.
                                                             (line    9)
* co_posonlyargcount (code object attribute): The standard type hierarchy.
                                                             (line  632)
* co_stacksize (code object attribute):  The standard type hierarchy.
                                                             (line  632)
* CO_VARARGS (in module inspect):        Code Objects Bit Flags.
                                                             (line   18)
* CO_VARKEYWORDS (in module inspect):    Code Objects Bit Flags.
                                                             (line   22)
* co_varnames (code object attribute):   The standard type hierarchy.
                                                             (line  632)
* CPP:                                   New Improved and Deprecated Modules<4>.
                                                             (line   59)
* CPPFLAGS:                              New Improved and Deprecated Modules<4>.
                                                             (line   59)
* cProfile (module):                     profile and cProfile Module Reference.
                                                             (line    6)
* CPU time:                              Functions<2>.       (line  202)
* CPU time <1>:                          Functions<2>.       (line  481)
* cpu_count() (in module multiprocessing): Miscellaneous<3>. (line   13)
* cpu_count() (in module os):            Miscellaneous System Information.
                                                             (line   37)
* CPython:                               Glossary.           (line  289)
* cpython_only() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  608)
* crawl_delay() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   50)
* CRC (zipfile.ZipInfo attribute):       ZipInfo Objects.    (line  135)
* crc32() (in module binascii):          binascii — Convert between binary and ASCII.
                                                             (line  113)
* crc32() (in module zlib):              zlib — Compression compatible with gzip.
                                                             (line  115)
* crc_hqx() (in module binascii):        binascii — Convert between binary and ASCII.
                                                             (line  106)
* create() (imaplib.IMAP4 method):       IMAP4 Objects.      (line   72)
* create() (in module venv):             API<2>.             (line  145)
* create() (venv.EnvBuilder method):     API<2>.             (line   49)
* createAttribute() (xml.dom.Document method): Document Objects.
                                                             (line   46)
* createAttributeNS() (xml.dom.Document method): Document Objects.
                                                             (line   53)
* createComment() (xml.dom.Document method): Document Objects.
                                                             (line   34)
* createDocument() (xml.dom.DOMImplementation method): DOMImplementation Objects.
                                                             (line   16)
* createDocumentType() (xml.dom.DOMImplementation method): DOMImplementation Objects.
                                                             (line   26)
* createElement() (xml.dom.Document method): Document Objects.
                                                             (line   14)
* createElementNS() (xml.dom.Document method): Document Objects.
                                                             (line   21)
* createfilehandler() (tkinter.Widget.tk method): File Handlers.
                                                             (line   22)
* CreateKey() (in module winreg):        Functions<11>.      (line   35)
* CreateKeyEx() (in module winreg):      Functions<11>.      (line   63)
* createLock() (logging.Handler method): Handler Objects.    (line   20)
* createLock() (logging.NullHandler method): NullHandler.    (line   24)
* createProcessingInstruction() (xml.dom.Document method): Document Objects.
                                                             (line   40)
* CreateRecord() (in module msilib):     msilib — Read and write Microsoft Installer files.
                                                             (line   55)
* createSocket() (logging.handlers.SocketHandler method): SocketHandler.
                                                             (line   70)
* createTextNode() (xml.dom.Document method): Document Objects.
                                                             (line   28)
* create_aggregate() (sqlite3.Connection method): Connection Objects.
                                                             (line  109)
* create_archive() (in module zipapp):   Python API.         (line    8)
* create_autospec() (in module unittest.mock): create_autospec.
                                                             (line    6)
* CREATE_BREAKAWAY_FROM_JOB (in module subprocess): Windows Constants.
                                                             (line  124)
* create_collation() (sqlite3.Connection method): Connection Objects.
                                                             (line  147)
* create_configuration() (venv.EnvBuilder method): API<2>.   (line   76)
* create_connection() (asyncio.loop method): Opening network connections.
                                                             (line    6)
* create_connection() (in module socket): Creating sockets.  (line   80)
* create_datagram_endpoint() (asyncio.loop method): Opening network connections.
                                                             (line  122)
* create_decimal() (decimal.Context method): Context objects.
                                                             (line  170)
* create_decimal_from_float() (decimal.Context method): Context objects.
                                                             (line  194)
* create_default_context() (in module ssl): Context creation.
                                                             (line    9)
* CREATE_DEFAULT_ERROR_MODE (in module subprocess): Windows Constants.
                                                             (line  114)
* create_empty_file() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  237)
* create_function() (sqlite3.Connection method): Connection Objects.
                                                             (line   73)
* create_future() (asyncio.loop method): Creating Futures and Tasks.
                                                             (line    6)
* create_module (C function):            Multi-phase initialization.
                                                             (line   67)
* create_module() (importlib.abc.Loader method): importlib abc – Abstract base classes related to import.
                                                             (line  161)
* create_module() (importlib.machinery.ExtensionFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  315)
* CREATE_NEW_CONSOLE (in module subprocess): Windows Constants.
                                                             (line   38)
* CREATE_NEW_PROCESS_GROUP (in module subprocess): Windows Constants.
                                                             (line   43)
* CREATE_NO_WINDOW (in module subprocess): Windows Constants.
                                                             (line   99)
* create_server() (asyncio.loop method): Creating network servers.
                                                             (line    6)
* create_server() (in module socket):    Creating sockets.   (line  104)
* create_shortcut() (built-in function): The Postinstallation script.
                                                             (line   48)
* create_socket() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  182)
* create_static_lib() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  323)
* create_stats() (profile.Profile method): profile and cProfile Module Reference.
                                                             (line   71)
* create_string_buffer() (in module ctypes): Utility functions.
                                                             (line   40)
* create_subprocess_exec() (in module asyncio): Creating Subprocesses.
                                                             (line    6)
* create_subprocess_shell() (in module asyncio): Creating Subprocesses.
                                                             (line   25)
* create_system (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line   99)
* create_task() (asyncio.loop method):   Creating Futures and Tasks.
                                                             (line   17)
* create_task() (in module asyncio):     Creating Tasks.     (line    6)
* create_tree() (in module distutils.dir_util): distutils dir_util — Directory tree operations.
                                                             (line   21)
* create_unicode_buffer() (in module ctypes): Utility functions.
                                                             (line   58)
* create_unix_connection() (asyncio.loop method): Opening network connections.
                                                             (line  200)
* create_unix_server() (asyncio.loop method): Creating network servers.
                                                             (line   93)
* create_version (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line  103)
* credits (built-in variable):           Constants added by the site module.
                                                             (line   18)
* critical() (in module logging):        Module-Level Functions.
                                                             (line  134)
* critical() (logging.Logger method):    Logger Objects.     (line  229)
* CRNCYSTR (in module locale):           locale — Internationalization services.
                                                             (line  256)
* cross() (in module audioop):           audioop — Manipulate raw audio data.
                                                             (line   74)
* crypt (module):                        crypt — Function to check Unix passwords.
                                                             (line    6)
* crypt() (in module crypt):             Module Functions<2>.
                                                             (line    8)
* crypt(3):                              crypt — Function to check Unix passwords.
                                                             (line    8)
* crypt(3) <1>:                          crypt — Function to check Unix passwords.
                                                             (line   16)
* crypt(3) <2>:                          Module Functions<2>.
                                                             (line   32)
* cryptography:                          Cryptographic Services.
                                                             (line    6)
* cssclasses (calendar.HTMLCalendar attribute): calendar — General calendar-related functions.
                                                             (line  193)
* cssclasses_weekday_head (calendar.HTMLCalendar attribute): calendar — General calendar-related functions.
                                                             (line  213)
* cssclass_month (calendar.HTMLCalendar attribute): calendar — General calendar-related functions.
                                                             (line  227)
* cssclass_month_head (calendar.HTMLCalendar attribute): calendar — General calendar-related functions.
                                                             (line  220)
* cssclass_noday (calendar.HTMLCalendar attribute): calendar — General calendar-related functions.
                                                             (line  206)
* cssclass_year (calendar.HTMLCalendar attribute): calendar — General calendar-related functions.
                                                             (line  234)
* cssclass_year_head (calendar.HTMLCalendar attribute): calendar — General calendar-related functions.
                                                             (line  241)
* csv:                                   csv — CSV File Reading and Writing.
                                                             (line    8)
* csv (module):                          csv — CSV File Reading and Writing.
                                                             (line    6)
* cte (email.headerregistry.ContentTransferEncoding attribute): email headerregistry Custom Header Objects.
                                                             (line  292)
* ctermid() (in module os):              Process Parameters. (line    9)
* cte_type (email.policy.Policy attribute): email policy Policy Objects.
                                                             (line  137)
* ctime() (datetime.date method):        date Objects.       (line  251)
* ctime() (datetime.datetime method):    datetime Objects.   (line  682)
* ctime() (in module time):              Functions<2>.       (line   85)
* ctrl() (in module curses.ascii):       curses ascii — Utilities for ASCII characters.
                                                             (line  213)
* CTRL_BREAK_EVENT (in module signal):   Module contents<2>. (line   47)
* CTRL_C_EVENT (in module signal):       Module contents<2>. (line   38)
* ctypes (module):                       ctypes — A foreign function library for Python.
                                                             (line    6)
* curdir (in module os):                 Miscellaneous System Information.
                                                             (line   81)
* currency() (in module locale):         locale — Internationalization services.
                                                             (line  419)
* current() (tkinter.ttk.Combobox method): ttk Combobox.     (line    8)
* CurrentByteIndex (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  157)
* CurrentColumnNumber (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  161)
* currentframe() (in module inspect):    The interpreter stack.
                                                             (line   69)
* CurrentLineNumber (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  165)
* current_process() (in module multiprocessing): Miscellaneous<3>.
                                                             (line   28)
* current_task() (asyncio.Task class method): Task Object.   (line  212)
* current_task() (in module asyncio):    Introspection.      (line    6)
* current_thread() (in module threading): threading — Thread-based parallelism.
                                                             (line   29)
* curses (module):                       curses — Terminal handling for character-cell displays.
                                                             (line    6)
* curses.ascii (module):                 curses ascii — Utilities for ASCII characters.
                                                             (line    6)
* curses.panel (module):                 curses panel — A panel stack extension for curses.
                                                             (line    6)
* curses.textpad (module):               curses textpad — Text input widget for curses programs.
                                                             (line    6)
* Cursor (class in sqlite3):             Cursor Objects.     (line    6)
* cursor() (sqlite3.Connection method):  Connection Objects. (line   26)
* cursyncup() (curses.window method):    Window Objects.     (line  172)
* curs_set() (in module curses):         Functions<3>.       (line   60)
* customize_compiler() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   84)
* Cut:                                   Help menu Shell and Editor.
                                                             (line   30)
* cwd() (ftplib.FTP method):             FTP Objects.        (line  213)
* cwd() (pathlib.Path class method):     Methods<2>.         (line   17)
* cycle() (in module itertools):         Itertool functions. (line  245)
* Cyclic Redundancy Check:               zlib — Compression compatible with gzip.
                                                             (line  117)
* c_bool (class in ctypes):              Fundamental data types<2>.
                                                             (line  202)
* C_BUILTIN (in module imp):             imp — Access the import internals.
                                                             (line  330)
* c_byte (class in ctypes):              Fundamental data types<2>.
                                                             (line   45)
* c_char (class in ctypes):              Fundamental data types<2>.
                                                             (line   51)
* c_char_p (class in ctypes):            Fundamental data types<2>.
                                                             (line   58)
* c_contiguous (memoryview attribute):   Memory Views.       (line  463)
* c_double (class in ctypes):            Fundamental data types<2>.
                                                             (line   65)
* C_EXTENSION (in module imp):           imp — Access the import internals.
                                                             (line  318)
* c_float (class in ctypes):             Fundamental data types<2>.
                                                             (line   76)
* c_int (class in ctypes):               Fundamental data types<2>.
                                                             (line   81)
* c_int16 (class in ctypes):             Fundamental data types<2>.
                                                             (line   93)
* c_int32 (class in ctypes):             Fundamental data types<2>.
                                                             (line   98)
* c_int64 (class in ctypes):             Fundamental data types<2>.
                                                             (line  103)
* c_int8 (class in ctypes):              Fundamental data types<2>.
                                                             (line   88)
* c_long (class in ctypes):              Fundamental data types<2>.
                                                             (line  108)
* c_longdouble (class in ctypes):        Fundamental data types<2>.
                                                             (line   70)
* c_longlong (class in ctypes):          Fundamental data types<2>.
                                                             (line  113)
* c_short (class in ctypes):             Fundamental data types<2>.
                                                             (line  119)
* c_size_t (class in ctypes):            Fundamental data types<2>.
                                                             (line  124)
* c_ssize_t (class in ctypes):           Fundamental data types<2>.
                                                             (line  128)
* c_ubyte (class in ctypes):             Fundamental data types<2>.
                                                             (line  134)
* c_uint (class in ctypes):              Fundamental data types<2>.
                                                             (line  140)
* c_uint16 (class in ctypes):            Fundamental data types<2>.
                                                             (line  152)
* c_uint32 (class in ctypes):            Fundamental data types<2>.
                                                             (line  157)
* c_uint64 (class in ctypes):            Fundamental data types<2>.
                                                             (line  162)
* c_uint8 (class in ctypes):             Fundamental data types<2>.
                                                             (line  147)
* c_ulong (class in ctypes):             Fundamental data types<2>.
                                                             (line  167)
* c_ulonglong (class in ctypes):         Fundamental data types<2>.
                                                             (line  172)
* c_ushort (class in ctypes):            Fundamental data types<2>.
                                                             (line  178)
* c_void_p (class in ctypes):            Fundamental data types<2>.
                                                             (line  184)
* c_wchar (class in ctypes):             Fundamental data types<2>.
                                                             (line  189)
* c_wchar_p (class in ctypes):           Fundamental data types<2>.
                                                             (line  196)
* daemon (multiprocessing.Process attribute): Process and exceptions.
                                                             (line   88)
* daemon (threading.Thread attribute):   Thread Objects.     (line  184)
* dangling; else:                        Compound statements.
                                                             (line   54)
* data:                                  Objects values and types.
                                                             (line    6)
* Data (class in plistlib):              plistlib — Generate and parse Mac OS X plist files.
                                                             (line  169)
* data (collections.UserDict attribute): UserDict objects.   (line   24)
* data (collections.UserList attribute): UserList objects.   (line   29)
* data (collections.UserString attribute): UserString objects.
                                                             (line   24)
* data (select.kevent attribute):        Kevent Objects.     (line  175)
* data (selectors.SelectorKey attribute): Classes<3>.        (line   43)
* data (urllib.request.Request attribute): Request Objects.  (line   39)
* data (xml.dom.Comment attribute):      Comment Objects.    (line    9)
* data (xml.dom.ProcessingInstruction attribute): ProcessingInstruction Objects.
                                                             (line   14)
* data (xml.dom.Text attribute):         Text and CDATASection Objects.
                                                             (line   15)
* data (xmlrpc.client.Binary attribute): Binary Objects.     (line   12)
* data() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   33)
* data; tabular:                         csv — CSV File Reading and Writing.
                                                             (line    8)
* data; type:                            The standard type hierarchy.
                                                             (line    6)
* DatabaseError:                         Exceptions<4>.      (line   15)
* databases:                             dbm dumb — Portable DBM implementation.
                                                             (line    8)
* dataclass() (in module dataclasses):   Module-level decorators classes and functions.
                                                             (line    6)
* dataclasses (module):                  dataclasses — Data Classes.
                                                             (line    6)
* DatagramHandler (class in logging.handlers): DatagramHandler.
                                                             (line   10)
* DatagramProtocol (class in asyncio):   Base Protocols.     (line   20)
* DatagramRequestHandler (class in socketserver): Request Handler Objects.
                                                             (line   42)
* DatagramTransport (class in asyncio):  Transports Hierarchy.
                                                             (line   43)
* datagram_received() (asyncio.DatagramProtocol method): Datagram Protocols.
                                                             (line    9)
* DataHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  420)
* data_open() (urllib.request.DataHandler method): DataHandler Objects.
                                                             (line    6)
* data_received() (asyncio.Protocol method): Streaming Protocols.
                                                             (line   13)
* date (class in datetime):              date Objects.       (line   13)
* date() (datetime.datetime method):     datetime Objects.   (line  392)
* date() (nntplib.NNTP method):          Methods<3>.         (line  262)
* DateHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  134)
* datetime (class in datetime):          datetime Objects.   (line   17)
* DateTime (class in xmlrpc.client):     DateTime Objects.   (line    6)
* datetime (email.headerregistry.DateHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  143)
* datetime (module):                     datetime — Basic date and time types.
                                                             (line    6)
* date_time (zipfile.ZipInfo attribute): ZipInfo Objects.    (line   54)
* date_time_string() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  307)
* datum:                                 Dictionary displays.
                                                             (line    6)
* day (datetime.date attribute):         date Objects.       (line  110)
* day (datetime.datetime attribute):     datetime Objects.   (line  273)
* daylight (in module time):             Timezone Constants. (line   13)
* Daylight Saving Time:                  time — Time access and conversions.
                                                             (line   44)
* day_abbr (in module calendar):         calendar — General calendar-related functions.
                                                             (line  371)
* day_name (in module calendar):         calendar — General calendar-related functions.
                                                             (line  366)
* DbfilenameShelf (class in shelve):     Restrictions.       (line   64)
* dbm (module):                          dbm — Interfaces to Unix “databases”.
                                                             (line    6)
* dbm.dumb (module):                     dbm dumb — Portable DBM implementation.
                                                             (line    6)
* dbm.gnu (module):                      dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line    6)
* dbm.ndbm (module):                     dbm ndbm — Interface based on ndbm.
                                                             (line    6)
* dcgettext() (in module locale):        Access to message catalogs.
                                                             (line   10)
* deallocation, object:                  Finalization and De-allocation.
                                                             (line    6)
* debug (imaplib.IMAP4 attribute):       IMAP4 Objects.      (line  374)
* DEBUG (in module re):                  Module Contents.    (line   58)
* debug (pdb command):                   Debugger Commands.  (line  328)
* debug (shlex.shlex attribute):         shlex Objects.      (line  162)
* debug (zipfile.ZipFile attribute):     ZipFile Objects.    (line  302)
* debug() (in module doctest):           Debugging.          (line   73)
* debug() (in module logging):           Module-Level Functions.
                                                             (line   43)
* debug() (logging.Logger method):       Logger Objects.     (line  118)
* debug() (pipes.Template method):       Template Objects.   (line   16)
* debug() (unittest.TestCase method):    Test cases.         (line  116)
* debug() (unittest.TestSuite method):   Grouping tests.     (line   48)
* debugger:                              Debug menu Shell window only.
                                                             (line   15)
* debugger <1>:                          sys — System-specific parameters and functions.
                                                             (line  706)
* debugger <2>:                          sys — System-specific parameters and functions.
                                                             (line 1261)
* debugger; configuration; file:         Debugger Commands.  (line   37)
* debugging:                             pdb — The Python Debugger.
                                                             (line    8)
* debugging; assertions:                 The assert statement.
                                                             (line    6)
* DebuggingServer (class in smtpd):      DebuggingServer Objects.
                                                             (line    6)
* debuglevel (http.client.HTTPResponse attribute): HTTPResponse Objects.
                                                             (line   59)
* DebugRunner (class in doctest):        Debugging.          (line  117)
* DEBUG_BYTECODE_SUFFIXES (in module importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   20)
* DEBUG_COLLECTABLE (in module gc):      gc — Garbage Collector interface.
                                                             (line  251)
* DEBUG_LEAK (in module gc):             gc — Garbage Collector interface.
                                                             (line  271)
* debug_print() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  511)
* DEBUG_SAVEALL (in module gc):          gc — Garbage Collector interface.
                                                             (line  265)
* debug_src() (in module doctest):       Debugging.          (line   96)
* DEBUG_STATS (in module gc):            gc — Garbage Collector interface.
                                                             (line  246)
* DEBUG_UNCOLLECTABLE (in module gc):    gc — Garbage Collector interface.
                                                             (line  255)
* Decimal (class in decimal):            Decimal objects.    (line    6)
* decimal (module):                      decimal — Decimal fixed point and floating point arithmetic.
                                                             (line    6)
* decimal literal:                       Numeric literals.   (line    6)
* decimal() (in module unicodedata):     unicodedata — Unicode Database.
                                                             (line   31)
* DecimalException (class in decimal):   Signals.            (line   28)
* decode (codecs.CodecInfo attribute):   codecs — Codec registry and base classes.
                                                             (line   69)
* decode() (bytearray method):           Bytes and Bytearray Operations.
                                                             (line   49)
* decode() (bytes method):               Bytes and Bytearray Operations.
                                                             (line   49)
* decode() (codecs.Codec method):        Stateless Encoding and Decoding.
                                                             (line   26)
* decode() (codecs.IncrementalDecoder method): IncrementalDecoder Objects.
                                                             (line   28)
* decode() (in module base64):           base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  205)
* decode() (in module codecs):           codecs — Codec registry and base classes.
                                                             (line   34)
* decode() (in module quopri):           quopri — Encode and decode MIME quoted-printable data.
                                                             (line   19)
* decode() (in module uu):               uu — Encode and decode uuencode files.
                                                             (line   37)
* decode() (json.JSONDecoder method):    Encoders and Decoders.
                                                             (line   85)
* decode() (xmlrpc.client.Binary method): Binary Objects.    (line   20)
* decode() (xmlrpc.client.DateTime method): DateTime Objects.
                                                             (line   13)
* decodebytes() (in module base64):      base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  212)
* DecodedGenerator (class in email.generator): email generator Generating MIME documents.
                                                             (line  232)
* decodestring() (in module base64):     base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  220)
* decodestring() (in module quopri):     quopri — Encode and decode MIME quoted-printable data.
                                                             (line   41)
* decode_header() (in module email.header): email header Internationalized headers.
                                                             (line  177)
* decode_header() (in module nntplib):   Utility functions<2>.
                                                             (line    8)
* decode_params() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line  198)
* decode_rfc2231() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line  168)
* decode_source() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line   72)
* decomposition() (in module unicodedata): unicodedata — Unicode Database.
                                                             (line   75)
* decompress() (bz2.BZ2Decompressor method): Incremental de compression.
                                                             (line   45)
* decompress() (in module bz2):          One-shot de compression.
                                                             (line   16)
* decompress() (in module gzip):         gzip — Support for gzip files.
                                                             (line  183)
* decompress() (in module lzma):         Compressing and decompressing data in memory.
                                                             (line  192)
* decompress() (in module zlib):         zlib — Compression compatible with gzip.
                                                             (line  131)
* decompress() (lzma.LZMADecompressor method): Compressing and decompressing data in memory.
                                                             (line  132)
* decompress() (zlib.Decompress method): zlib — Compression compatible with gzip.
                                                             (line  258)
* decompressobj() (in module zlib):      zlib — Compression compatible with gzip.
                                                             (line  176)
* decorator:                             Glossary.           (line  296)
* DEDENT (in module token):              token — Constants used with Python parse trees.
                                                             (line   52)
* DEDENT token:                          Indentation.        (line   33)
* DEDENT token <1>:                      Compound statements.
                                                             (line   54)
* dedent() (in module textwrap):         textwrap — Text wrapping and filling.
                                                             (line   65)
* deepcopy() (in module copy):           copy — Shallow and deep copy operations.
                                                             (line   22)
* default (in module email.policy):      email policy Policy Objects.
                                                             (line  465)
* DEFAULT (in module unittest.mock):     DEFAULT.            (line    6)
* default (inspect.Parameter attribute): Introspecting callables with the Signature object.
                                                             (line  148)
* default (optparse.Option attribute):   Option attributes.  (line   36)
* default() (cmd.Cmd method):            Cmd Objects.        (line   74)
* default() (json.JSONEncoder method):   Encoders and Decoders.
                                                             (line  197)
* default; parameter; value:             Function definitions.
                                                             (line   53)
* DefaultContext (class in decimal):     Context objects.    (line   72)
* DefaultCookiePolicy (class in http.cookiejar): http cookiejar — Cookie handling for HTTP clients.
                                                             (line   78)
* defaultdict (class in collections):    defaultdict objects.
                                                             (line    6)
* DefaultDict (class in typing):         Classes functions and decorators.
                                                             (line  309)
* DefaultEventLoopPolicy (class in asyncio): Policy Objects. (line   50)
* DefaultHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  310)
* DefaultHandlerExpand() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  317)
* defaults() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line   77)
* DefaultSelector (class in selectors):  Classes<3>.         (line  156)
* defaultTestLoader (in module unittest): Loading and running tests.
                                                             (line  428)
* defaultTestResult() (unittest.TestCase method): Test cases.
                                                             (line  692)
* DEFAULT_BUFFER_SIZE (in module io):    High-level Module Interface.
                                                             (line    6)
* default_bufsize (in module xml.dom.pulldom): xml dom pulldom — Support for building partial DOM trees.
                                                             (line   91)
* default_exception_handler() (asyncio.loop method): Error Handling API.
                                                             (line   26)
* default_factory (collections.defaultdict attribute): defaultdict objects.
                                                             (line   49)
* DEFAULT_FORMAT (in module tarfile):    tarfile — Read and write tar archive files.
                                                             (line  234)
* DEFAULT_IGNORES (in module filecmp):   The dircmp class.   (line  105)
* default_open() (urllib.request.BaseHandler method): BaseHandler Objects.
                                                             (line   30)
* DEFAULT_PROTOCOL (in module pickle):   Module Interface.   (line   21)
* default_timer() (in module timeit):    Python Interface.   (line   32)
* defects (email.headerregistry.BaseHeader attribute): email headerregistry Custom Header Objects.
                                                             (line   52)
* defects (email.message.EmailMessage attribute): email message Representing an email message.
                                                             (line  683)
* defects (email.message.Message attribute): email message Message Representing an email message using the compat32 API.
                                                             (line  685)
* define_macro() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  162)
* defpath (in module os):                Miscellaneous System Information.
                                                             (line  121)
* DefragResult (class in urllib.parse):  Structured Parse Results.
                                                             (line   33)
* DefragResultBytes (class in urllib.parse): Structured Parse Results.
                                                             (line   58)
* def_prog_mode() (in module curses):    Functions<3>.       (line   69)
* def_shell_mode() (in module curses):   Functions<3>.       (line   76)
* degrees() (in module math):            Angular conversion. (line    6)
* degrees() (in module turtle):          Settings for measurement.
                                                             (line    6)
* delattr() (built-in function):         Built-in Functions. (line  358)
* delay() (in module turtle):            Animation control.  (line    6)
* delayload (http.cookiejar.FileCookieJar attribute): CookieJar and FileCookieJar Objects.
                                                             (line  158)
* delay_output() (in module curses):     Functions<3>.       (line   84)
* delch() (curses.window method):        Window Objects.     (line  177)
* dele() (poplib.POP3 method):           POP3 Objects.       (line   67)
* delete() (ftplib.FTP method):          FTP Objects.        (line  206)
* delete() (imaplib.IMAP4 method):       IMAP4 Objects.      (line   76)
* delete() (tkinter.ttk.Treeview method): ttk Treeview.      (line   79)
* deleteacl() (imaplib.IMAP4 method):    IMAP4 Objects.      (line   80)
* deletefilehandler() (tkinter.Widget.tk method): File Handlers.
                                                             (line   32)
* DeleteKey() (in module winreg):        Functions<11>.      (line  102)
* DeleteKeyEx() (in module winreg):      Functions<11>.      (line  124)
* deleteln() (curses.window method):     Window Objects.     (line  181)
* deleteMe() (bdb.Breakpoint method):    bdb — Debugger framework.
                                                             (line   41)
* DeleteValue() (in module winreg):      Functions<11>.      (line  165)
* DELETE_ATTR (opcode):                  Python Bytecode Instructions.
                                                             (line  515)
* DELETE_DEREF (opcode):                 Python Bytecode Instructions.
                                                             (line  749)
* DELETE_FAST (opcode):                  Python Bytecode Instructions.
                                                             (line  719)
* DELETE_GLOBAL (opcode):                Python Bytecode Instructions.
                                                             (line  523)
* DELETE_NAME (opcode):                  Python Bytecode Instructions.
                                                             (line  489)
* DELETE_SUBSCR (opcode):                Python Bytecode Instructions.
                                                             (line  254)
* deletion; target:                      The del statement<2>.
                                                             (line    6)
* deletion; target; list:                The del statement<2>.
                                                             (line    6)
* delimiter (csv.Dialect attribute):     Dialects and Formatting Parameters.
                                                             (line   19)
* delimiters:                            Delimiters.         (line    6)
* delitem() (in module operator):        operator — Standard operators as functions.
                                                             (line  187)
* deliver_challenge() (in module multiprocessing.connection): Listeners and Clients.
                                                             (line   15)
* delocalize() (in module locale):       locale — Internationalization services.
                                                             (line  440)
* del_param() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  380)
* del_param() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  529)
* demo_app() (in module wsgiref.simple_server): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   27)
* denominator (fractions.Fraction attribute): fractions — Rational numbers.
                                                             (line   94)
* denominator (numbers.Rational attribute): The numeric tower.
                                                             (line   51)
* DeprecationWarning:                    Warnings.           (line   17)
* deque (class in collections):          deque objects.      (line    6)
* Deque (class in typing):               Classes functions and decorators.
                                                             (line  208)
* dequeue() (logging.handlers.QueueListener method): QueueListener.
                                                             (line   46)
* derwin() (curses.window method):       Window Objects.     (line  186)
* DER_cert_to_PEM_cert() (in module ssl): Certificate handling.
                                                             (line   79)
* descrgetfunc (C type):                 Slot Type typedefs. (line   78)
* description (inspect.Parameter.kind attribute): Introspecting callables with the Signature object.
                                                             (line  205)
* description (sqlite3.Cursor attribute): Cursor Objects.    (line  220)
* description() (nntplib.NNTP method):   Methods<3>.         (line  138)
* descriptions() (nntplib.NNTP method):  Methods<3>.         (line  128)
* descriptor:                            Glossary.           (line  312)
* descrsetfunc (C type):                 Slot Type typedefs. (line   83)
* dest (optparse.Option attribute):      Option attributes.  (line   27)
* destructor:                            Basic customization.
                                                             (line   56)
* destructor <1>:                        Assignment statements.
                                                             (line   73)
* destructor (C type):                   Slot Type typedefs. (line   24)
* detach() (io.BufferedIOBase method):   I/O Base Classes.   (line  256)
* detach() (io.TextIOBase method):       Text I/O<2>.        (line   37)
* detach() (socket.socket method):       Socket Objects.     (line   94)
* detach() (tkinter.ttk.Treeview method): ttk Treeview.      (line   85)
* detach() (weakref.finalize method):    weakref — Weak references.
                                                             (line  273)
* Detach() (winreg.PyHKEY method):       Registry Handle Objects.
                                                             (line   39)
* DETACHED_PROCESS (in module subprocess): Windows Constants.
                                                             (line  106)
* detect_api_mismatch() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  878)
* detect_encoding() (in module tokenize): Tokenizing Input.  (line   77)
* detect_language() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  198)
* deterministic profiling:               Introduction to the profilers.
                                                             (line    6)
* device_encoding() (in module os):      File Descriptor Operations.
                                                             (line   67)
* devnull (in module os):                Miscellaneous System Information.
                                                             (line  136)
* DEVNULL (in module subprocess):        Using the subprocess Module.
                                                             (line  121)
* devpoll() (in module select):          select — Waiting for I/O completion.
                                                             (line   31)
* DevpollSelector (class in selectors):  Classes<3>.         (line  179)
* dgettext() (in module gettext):        GNU gettext API.    (line   49)
* dgettext() (in module locale):         Access to message catalogs.
                                                             (line    8)
* Dialect (class in csv):                Module Contents<3>. (line  172)
* dialect (csv.csvreader attribute):     Reader Objects.     (line   18)
* dialect (csv.csvwriter attribute):     Writer Objects.     (line   31)
* Dialog (class in msilib):              GUI classes.        (line   40)
* dict (2to3 fixer):                     Fixers.             (line   70)
* dict (built-in class):                 Mapping Types — dict.
                                                             (line   27)
* Dict (class in typing):                Classes functions and decorators.
                                                             (line  299)
* dict() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  200)
* dictConfig() (in module logging.config): Configuration functions.
                                                             (line   13)
* dictionary:                            Glossary.           (line  328)
* dictionary view:                       Glossary.           (line  334)
* dictionary; display:                   Dictionary displays.
                                                             (line    6)
* DictReader (class in csv):             Module Contents<3>. (line  102)
* DictWriter (class in csv):             Module Contents<3>. (line  139)
* Differ (class in difflib):             difflib — Helpers for computing deltas.
                                                             (line   50)
* Differ (class in difflib) <1>:         Differ Objects.     (line   15)
* difference() (frozenset method):       Set Types — set frozenset.
                                                             (line   98)
* difference_update() (frozenset method): Set Types — set frozenset.
                                                             (line  171)
* difflib (module):                      difflib — Helpers for computing deltas.
                                                             (line    6)
* diff_bytes() (in module difflib):      difflib — Helpers for computing deltas.
                                                             (line  339)
* diff_files (filecmp.dircmp attribute): The dircmp class.   (line   90)
* digest() (hashlib.hash method):        Hash algorithms.    (line  128)
* digest() (hashlib.shake method):       SHAKE variable length digests.
                                                             (line   11)
* digest() (hmac.HMAC method):           hmac — Keyed-Hashing for Message Authentication.
                                                             (line   56)
* digest() (in module hmac):             hmac — Keyed-Hashing for Message Authentication.
                                                             (line   31)
* digest_size (hmac.HMAC attribute):     hmac — Keyed-Hashing for Message Authentication.
                                                             (line   90)
* digit() (in module unicodedata):       unicodedata — Unicode Database.
                                                             (line   37)
* digits (in module string):             String constants.   (line   24)
* dir() (built-in function):             Built-in Functions. (line  380)
* dir() (ftplib.FTP method):             FTP Objects.        (line  189)
* dircmp (class in filecmp):             The dircmp class.   (line    6)
* Directory (class in msilib):           Directory Objects.  (line    6)
* directory (http.server.SimpleHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  354)
* directory; changing:                   Files and Directories.
                                                             (line  117)
* directory; creating:                   Files and Directories.
                                                             (line  422)
* directory; deleting:                   Directory and files operations.
                                                             (line  235)
* directory; deleting <1>:               Files and Directories.
                                                             (line  606)
* directory; traversal:                  Files and Directories.
                                                             (line 1429)
* directory; traversal <1>:              Files and Directories.
                                                             (line 1522)
* directory; walking:                    Files and Directories.
                                                             (line 1429)
* directory; walking <1>:                Files and Directories.
                                                             (line 1522)
* directory_created() (built-in function): The Postinstallation script.
                                                             (line   23)
* DirEntry (class in os):                Files and Directories.
                                                             (line  766)
* DirList (class in tkinter.tix):        File Selectors.     (line    6)
* dirname() (in module os.path):         os path — Common pathname manipulations.
                                                             (line  106)
* DirSelectBox (class in tkinter.tix):   File Selectors.     (line   26)
* DirSelectDialog (class in tkinter.tix): File Selectors.    (line   20)
* DirsOnSysPath (class in test.support): test support — Utilities for the Python test suite.
                                                             (line 1001)
* DirTree (class in tkinter.tix):        File Selectors.     (line   13)
* dis (module):                          dis — Disassembler for Python bytecode.
                                                             (line    6)
* dis() (dis.Bytecode method):           Bytecode analysis.  (line   47)
* dis() (in module dis):                 Analysis functions. (line   40)
* dis() (in module pickletools):         Programmatic Interface<2>.
                                                             (line    6)
* disable (pdb command):                 Debugger Commands.  (line  100)
* disable() (bdb.Breakpoint method):     bdb — Debugger framework.
                                                             (line   51)
* disable() (in module faulthandler):    Fault handler state.
                                                             (line   22)
* disable() (in module gc):              gc — Garbage Collector interface.
                                                             (line   26)
* disable() (in module logging):         Module-Level Functions.
                                                             (line  163)
* disable() (profile.Profile method):    profile and cProfile Module Reference.
                                                             (line   67)
* DisableReflectionKey() (in module winreg): Functions<11>.  (line  486)
* disable_faulthandler() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  447)
* disable_gc() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  459)
* disable_interspersed_args() (optparse.OptionParser method): Querying and manipulating your option parser.
                                                             (line   10)
* disassemble() (in module dis):         Analysis functions. (line   81)
* discard (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   54)
* discard() (frozenset method):          Set Types — set frozenset.
                                                             (line  193)
* discard() (mailbox.Mailbox method):    Mailbox objects.    (line   76)
* discard() (mailbox.MH method):         MH.                 (line   76)
* discard_buffers() (asynchat.async_chat method): asynchat — Asynchronous socket command/response handler.
                                                             (line   84)
* disco() (in module dis):               Analysis functions. (line   81)
* discover() (unittest.TestLoader method): Loading and running tests.
                                                             (line  117)
* disk_usage() (in module shutil):       Directory and files operations.
                                                             (line  315)
* dispatcher (class in asyncore):        asyncore — Asynchronous socket handler.
                                                             (line   67)
* dispatcher_with_send (class in asyncore): asyncore — Asynchronous socket handler.
                                                             (line  248)
* dispatch_call() (bdb.Bdb method):      bdb — Debugger framework.
                                                             (line  157)
* dispatch_exception() (bdb.Bdb method): bdb — Debugger framework.
                                                             (line  177)
* dispatch_line() (bdb.Bdb method):      bdb — Debugger framework.
                                                             (line  147)
* dispatch_return() (bdb.Bdb method):    bdb — Debugger framework.
                                                             (line  167)
* dispatch_table (pickle.Pickler attribute): Module Interface.
                                                             (line  175)
* display (pdb command):                 Debugger Commands.  (line  254)
* displayhook() (in module sys):         sys — System-specific parameters and functions.
                                                             (line  230)
* display_name (email.headerregistry.Address attribute): email headerregistry Custom Header Objects.
                                                             (line  424)
* display_name (email.headerregistry.Group attribute): email headerregistry Custom Header Objects.
                                                             (line  469)
* dist() (in module math):               Trigonometric functions.
                                                             (line   32)
* distance() (in module turtle):         Tell Turtle’s state.
                                                             (line   50)
* distb() (in module dis):               Analysis functions. (line   70)
* Distribution (class in distutils.core): distutils core — Core Distutils functionality.
                                                             (line  294)
* distutils (module):                    distutils — Building and installing Python modules.
                                                             (line    6)
* distutils.archive_util (module):       distutils archive_util — Archiving utilities.
                                                             (line    6)
* distutils.bcppcompiler (module):       distutils bcppcompiler — Borland Compiler.
                                                             (line    6)
* distutils.ccompiler (module):          distutils ccompiler — CCompiler base class.
                                                             (line    6)
* distutils.cmd (module):                distutils cmd — Abstract base class for Distutils commands.
                                                             (line    6)
* distutils.command (module):            distutils command — Individual Distutils commands.
                                                             (line    5)
* distutils.command.bdist (module):      distutils command bdist — Build a binary installer.
                                                             (line    5)
* distutils.command.bdist_dumb (module): distutils command bdist_dumb — Build a “dumb” installer.
                                                             (line    5)
* distutils.command.bdist_msi (module):  distutils command bdist_msi — Build a Microsoft Installer binary package.
                                                             (line    6)
* distutils.command.bdist_packager (module): distutils command bdist_packager — Abstract base class for packagers.
                                                             (line    5)
* distutils.command.bdist_rpm (module):  distutils command bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM.
                                                             (line    5)
* distutils.command.bdist_wininst (module): distutils command bdist_wininst — Build a Windows installer.
                                                             (line    6)
* distutils.command.build (module):      distutils command build — Build all files of a package.
                                                             (line    5)
* distutils.command.build_clib (module): distutils command build_clib — Build any C libraries in a package.
                                                             (line    5)
* distutils.command.build_ext (module):  distutils command build_ext — Build any extensions in a package.
                                                             (line    5)
* distutils.command.build_py (module):   distutils command build_py — Build the py/ pyc files of a package.
                                                             (line    6)
* distutils.command.build_scripts (module): distutils command build_scripts — Build the scripts of a package.
                                                             (line    5)
* distutils.command.check (module):      distutils command check — Check the meta-data of a package.
                                                             (line    6)
* distutils.command.clean (module):      distutils command clean — Clean a package build area.
                                                             (line    6)
* distutils.command.config (module):     distutils command config — Perform package configuration.
                                                             (line    5)
* distutils.command.install (module):    distutils command install — Install a package.
                                                             (line    5)
* distutils.command.install_data (module): distutils command install_data — Install data files from a package.
                                                             (line    5)
* distutils.command.install_headers (module): distutils command install_headers — Install C/C++ header files from a package.
                                                             (line    5)
* distutils.command.install_lib (module): distutils command install_lib — Install library files from a package.
                                                             (line    5)
* distutils.command.install_scripts (module): distutils command install_scripts — Install script files from a package.
                                                             (line    5)
* distutils.command.register (module):   distutils command register — Register a module with the Python Package Index.
                                                             (line    6)
* distutils.command.sdist (module):      distutils command sdist — Build a source distribution.
                                                             (line    5)
* distutils.core (module):               distutils core — Core Distutils functionality.
                                                             (line    6)
* distutils.cygwinccompiler (module):    distutils cygwincompiler — Cygwin Compiler.
                                                             (line    6)
* distutils.debug (module):              distutils debug — Distutils debug mode.
                                                             (line    6)
* distutils.dep_util (module):           distutils dep_util — Dependency checking.
                                                             (line    6)
* distutils.dir_util (module):           distutils dir_util — Directory tree operations.
                                                             (line    6)
* distutils.dist (module):               distutils dist — The Distribution class.
                                                             (line    6)
* distutils.errors (module):             distutils errors — Distutils exceptions.
                                                             (line    6)
* distutils.extension (module):          distutils extension — The Extension class.
                                                             (line    6)
* distutils.fancy_getopt (module):       distutils fancy_getopt — Wrapper around the standard getopt module.
                                                             (line    6)
* distutils.filelist (module):           distutils filelist — The FileList class.
                                                             (line    6)
* distutils.file_util (module):          distutils file_util — Single file operations.
                                                             (line    6)
* distutils.log (module):                distutils log — Simple PEP 282-style logging.
                                                             (line    7)
* distutils.msvccompiler (module):       distutils msvccompiler — Microsoft Compiler.
                                                             (line    6)
* distutils.spawn (module):              distutils spawn — Spawn a sub-process.
                                                             (line    6)
* distutils.sysconfig (module):          distutils sysconfig — System configuration information.
                                                             (line    6)
* distutils.text_file (module):          distutils text_file — The TextFile class.
                                                             (line    6)
* distutils.unixccompiler (module):      distutils unixccompiler — Unix C Compiler.
                                                             (line    6)
* distutils.util (module):               distutils util — Miscellaneous other utility functions.
                                                             (line    6)
* distutils.version (module):            distutils version — Version number classes.
                                                             (line    5)
* DISTUTILS_DEBUG:                       Debugging the setup script.
                                                             (line   19)
* divide() (decimal.Context method):     Context objects.    (line  271)
* divide_int() (decimal.Context method): Context objects.    (line  275)
* division:                              Binary arithmetic operations.
                                                             (line   28)
* DivisionByZero (class in decimal):     Signals.            (line   33)
* divmod() (built-in function):          Built-in Functions. (line  438)
* divmod() (decimal.Context method):     Context objects.    (line  279)
* DllCanUnloadNow() (in module ctypes):  Utility functions.  (line   76)
* DllGetClassObject() (in module ctypes): Utility functions. (line   82)
* dllhandle (in module sys):             sys — System-specific parameters and functions.
                                                             (line  224)
* dngettext() (in module gettext):       GNU gettext API.    (line   68)
* dnpgettext() (in module gettext):      GNU gettext API.    (line   79)
* doc (json.JSONDecodeError attribute):  Exceptions<13>.     (line   15)
* DocCGIXMLRPCRequestHandler (class in xmlrpc.server): Documenting XMLRPC server.
                                                             (line   22)
* DocFileSuite() (in module doctest):    Unittest API.       (line   18)
* doClassCleanups() (unittest.TestCase class method): Test cases.
                                                             (line  766)
* doCleanups() (unittest.TestCase method): Test cases.       (line  735)
* docmd() (smtplib.SMTP method):         SMTP Objects.       (line   17)
* docstring:                             Class definitions.  (line    6)
* docstring <1>:                         Glossary.           (line  344)
* docstring (doctest.DocTest attribute): DocTest Objects.    (line   49)
* docstrings:                            Defining Functions. (line   21)
* docstrings <1>:                        Documentation Strings.
                                                             (line    6)
* DocTest (class in doctest):            DocTest Objects.    (line    6)
* doctest (module):                      doctest — Test interactive Python examples.
                                                             (line    6)
* DocTestFailure:                        Debugging.          (line  135)
* DocTestFinder (class in doctest):      DocTestFinder objects.
                                                             (line    6)
* DocTestParser (class in doctest):      DocTestParser objects.
                                                             (line    6)
* DocTestRunner (class in doctest):      DocTestRunner objects.
                                                             (line    6)
* DocTestSuite() (in module doctest):    Unittest API.       (line   93)
* doctype() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   66)
* documentation string:                  The standard type hierarchy.
                                                             (line  673)
* documentation strings:                 Defining Functions. (line   21)
* documentation strings <1>:             Documentation Strings.
                                                             (line    6)
* documentation; generation:             pydoc — Documentation generator and online help system.
                                                             (line    8)
* documentation; online:                 pydoc — Documentation generator and online help system.
                                                             (line    8)
* documentElement (xml.dom.Document attribute): Document Objects.
                                                             (line   10)
* DocXMLRPCRequestHandler (class in xmlrpc.server): Documenting XMLRPC server.
                                                             (line   27)
* DocXMLRPCServer (class in xmlrpc.server): Documenting XMLRPC server.
                                                             (line   11)
* doc_header (cmd.Cmd attribute):        Cmd Objects.        (line  147)
* domain (email.headerregistry.Address attribute): email headerregistry Custom Header Objects.
                                                             (line  435)
* domain (tracemalloc.DomainFilter attribute): DomainFilter. (line   20)
* domain (tracemalloc.Filter attribute): Filter.             (line   30)
* domain (tracemalloc.Trace attribute):  Trace.              (line   15)
* DomainFilter (class in tracemalloc):   DomainFilter.       (line    6)
* DomainLiberal (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  149)
* DomainRFC2965Match (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  142)
* DomainStrict (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  154)
* DomainStrictNoDots (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  129)
* DomainStrictNonDomain (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  135)
* domain_initial_dot (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   86)
* domain_return_ok() (http.cookiejar.CookiePolicy method): CookiePolicy Objects.
                                                             (line   27)
* domain_specified (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   82)
* DOMEventStream (class in xml.dom.pulldom): DOMEventStream Objects.
                                                             (line    6)
* DOMException:                          Exceptions<16>.     (line   18)
* doModuleCleanups() (in module unittest): setUpModule and tearDownModule.
                                                             (line   31)
* DomstringSizeErr:                      Exceptions<16>.     (line   23)
* done() (asyncio.Future method):        Future Object.      (line   59)
* done() (asyncio.Task method):          Task Object.        (line   81)
* done() (concurrent.futures.Future method): Future Objects. (line   33)
* done() (in module turtle):             Using screen events.
                                                             (line   88)
* done() (xdrlib.Unpacker method):       Unpacker Objects.   (line   26)
* DONT_ACCEPT_BLANKLINE (in module doctest): Option Flags.   (line   30)
* DONT_ACCEPT_TRUE_FOR_1 (in module doctest): Option Flags.  (line   18)
* dont_write_bytecode (in module sys):   sys — System-specific parameters and functions.
                                                             (line  250)
* doRollover() (logging.handlers.RotatingFileHandler method): RotatingFileHandler.
                                                             (line   38)
* doRollover() (logging.handlers.TimedRotatingFileHandler method): TimedRotatingFileHandler.
                                                             (line  101)
* DOT (in module token):                 token — Constants used with Python parse trees.
                                                             (line  118)
* dot() (in module turtle):              Turtle motion.      (line  156)
* DOTALL (in module re):                 Module Contents.    (line  113)
* doublequote (csv.Dialect attribute):   Dialects and Formatting Parameters.
                                                             (line   24)
* DOUBLESLASH (in module token):         token — Constants used with Python parse trees.
                                                             (line  214)
* DOUBLESLASHEQUAL (in module token):    token — Constants used with Python parse trees.
                                                             (line  218)
* DOUBLESTAR (in module token):          token — Constants used with Python parse trees.
                                                             (line  166)
* DOUBLESTAREQUAL (in module token):     token — Constants used with Python parse trees.
                                                             (line  210)
* doupdate() (in module curses):         Functions<3>.       (line   88)
* down (pdb command):                    Debugger Commands.  (line   61)
* down() (in module turtle):             Drawing state.      (line    6)
* do_clear() (bdb.Bdb method):           bdb — Debugger framework.
                                                             (line  234)
* do_command() (curses.textpad.Textbox method): Textbox objects.
                                                             (line   30)
* do_GET() (http.server.SimpleHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  369)
* do_handshake() (ssl.SSLSocket method): SSL Sockets.        (line  121)
* do_HEAD() (http.server.SimpleHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  362)
* do_POST() (http.server.CGIHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  472)
* dpgettext() (in module gettext):       GNU gettext API.    (line   75)
* drain() (asyncio.StreamWriter method): StreamWriter.       (line   63)
* dropwhile() (in module itertools):     Itertool functions. (line  264)
* drop_whitespace (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  190)
* dst() (datetime.datetime method):      datetime Objects.   (line  486)
* dst() (datetime.time method):          time Objects.       (line  233)
* dst() (datetime.timezone method):      timezone Objects.   (line   57)
* dst() (datetime.tzinfo method):        tzinfo Objects.     (line   65)
* DTDHandler (class in xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   24)
* duck-typing:                           Glossary.           (line  353)
* DumbWriter (class in formatter):       Writer Implementations.
                                                             (line   22)
* dummy_threading (module):              dummy_threading — Drop-in replacement for the threading module.
                                                             (line    6)
* dump() (in module ast):                ast Helpers.        (line  183)
* dump() (in module json):               Basic Usage.        (line    6)
* dump() (in module marshal):            marshal — Internal Python object serialization.
                                                             (line   47)
* dump() (in module pickle):             Module Interface.   (line   35)
* dump() (in module plistlib):           plistlib — Generate and parse Mac OS X plist files.
                                                             (line   85)
* dump() (in module xml.etree.ElementTree): Functions<6>.    (line   79)
* dump() (pickle.Pickler method):        Module Interface.   (line  154)
* dump() (tracemalloc.Snapshot method):  Snapshot.           (line   29)
* dumps() (in module json):              Basic Usage.        (line   78)
* dumps() (in module marshal):           marshal — Internal Python object serialization.
                                                             (line   72)
* dumps() (in module pickle):            Module Interface.   (line   47)
* dumps() (in module plistlib):          plistlib — Generate and parse Mac OS X plist files.
                                                             (line  115)
* dumps() (in module xmlrpc.client):     Convenience Functions.
                                                             (line    6)
* dump_stats() (profile.Profile method): profile and cProfile Module Reference.
                                                             (line   81)
* dump_stats() (pstats.Stats method):    The Stats Class.    (line   59)
* dump_traceback() (in module faulthandler): Dumping the traceback.
                                                             (line    6)
* dump_traceback_later() (in module faulthandler): Dumping the tracebacks after a timeout.
                                                             (line    6)
* dup() (in module os):                  File Descriptor Operations.
                                                             (line   73)
* dup() (socket.socket method):          Socket Objects.     (line  102)
* dup2() (in module os):                 File Descriptor Operations.
                                                             (line   85)
* DuplicateOptionError:                  Exceptions<5>.      (line   24)
* DuplicateSectionError:                 Exceptions<5>.      (line   14)
* DUP_TOP (opcode):                      Python Bytecode Instructions.
                                                             (line   79)
* DUP_TOP_TWO (opcode):                  Python Bytecode Instructions.
                                                             (line   85)
* dwFlags (subprocess.STARTUPINFO attribute): Windows Popen Helpers.
                                                             (line   19)
* DynamicClassAttribute() (in module types): Additional Utility Classes and Functions.
                                                             (line   36)
* D_FMT (in module locale):              locale — Internationalization services.
                                                             (line  194)
* D_T_FMT (in module locale):            locale — Internationalization services.
                                                             (line  188)
* e (in module cmath):                   Constants<3>.       (line   10)
* e (in module math):                    Constants<2>.       (line   10)
* E2BIG (in module errno):               errno — Standard errno system symbols.
                                                             (line   55)
* e; in numeric literal:                 Integer literals.   (line   40)
* EACCES (in module errno):              errno — Standard errno system symbols.
                                                             (line   79)
* EADDRINUSE (in module errno):          errno — Standard errno system symbols.
                                                             (line  419)
* EADDRNOTAVAIL (in module errno):       errno — Standard errno system symbols.
                                                             (line  423)
* EADV (in module errno):                errno — Standard errno system symbols.
                                                             (line  299)
* EAFNOSUPPORT (in module errno):        errno — Standard errno system symbols.
                                                             (line  415)
* EAFP:                                  Glossary.           (line  366)
* EAGAIN (in module errno):              errno — Standard errno system symbols.
                                                             (line   71)
* EALREADY (in module errno):            errno — Standard errno system symbols.
                                                             (line  483)
* east_asian_width() (in module unicodedata): unicodedata — Unicode Database.
                                                             (line   64)
* EBADE (in module errno):               errno — Standard errno system symbols.
                                                             (line  235)
* EBADF (in module errno):               errno — Standard errno system symbols.
                                                             (line   63)
* EBADFD (in module errno):              errno — Standard errno system symbols.
                                                             (line  335)
* EBADMSG (in module errno):             errno — Standard errno system symbols.
                                                             (line  323)
* EBADR (in module errno):               errno — Standard errno system symbols.
                                                             (line  239)
* EBADRQC (in module errno):             errno — Standard errno system symbols.
                                                             (line  251)
* EBADSLT (in module errno):             errno — Standard errno system symbols.
                                                             (line  255)
* EBFONT (in module errno):              errno — Standard errno system symbols.
                                                             (line  263)
* EBUSY (in module errno):               errno — Standard errno system symbols.
                                                             (line   91)
* ECHILD (in module errno):              errno — Standard errno system symbols.
                                                             (line   67)
* echo() (in module curses):             Functions<3>.       (line  104)
* echochar() (curses.window method):     Window Objects.     (line  196)
* ECHRNG (in module errno):              errno — Standard errno system symbols.
                                                             (line  203)
* ECOMM (in module errno):               errno — Standard errno system symbols.
                                                             (line  307)
* ECONNABORTED (in module errno):        errno — Standard errno system symbols.
                                                             (line  439)
* ECONNREFUSED (in module errno):        errno — Standard errno system symbols.
                                                             (line  471)
* ECONNRESET (in module errno):          errno — Standard errno system symbols.
                                                             (line  443)
* EDEADLK (in module errno):             errno — Standard errno system symbols.
                                                             (line  167)
* EDEADLOCK (in module errno):           errno — Standard errno system symbols.
                                                             (line  259)
* EDESTADDRREQ (in module errno):        errno — Standard errno system symbols.
                                                             (line  383)
* edit() (curses.textpad.Textbox method): Textbox objects.   (line   19)
* EDOM (in module errno):                errno — Standard errno system symbols.
                                                             (line  159)
* EDOTDOT (in module errno):             errno — Standard errno system symbols.
                                                             (line  319)
* EDQUOT (in module errno):              errno — Standard errno system symbols.
                                                             (line  515)
* EEXIST (in module errno):              errno — Standard errno system symbols.
                                                             (line   95)
* EFAULT (in module errno):              errno — Standard errno system symbols.
                                                             (line   83)
* EFBIG (in module errno):               errno — Standard errno system symbols.
                                                             (line  135)
* effective() (in module bdb):           bdb — Debugger framework.
                                                             (line  397)
* ehlo() (smtplib.SMTP method):          SMTP Objects.       (line   58)
* ehlo_or_helo_if_needed() (smtplib.SMTP method): SMTP Objects.
                                                             (line   75)
* EHOSTDOWN (in module errno):           errno — Standard errno system symbols.
                                                             (line  475)
* EHOSTUNREACH (in module errno):        errno — Standard errno system symbols.
                                                             (line  479)
* EIDRM (in module errno):               errno — Standard errno system symbols.
                                                             (line  199)
* EILSEQ (in module errno):              errno — Standard errno system symbols.
                                                             (line  363)
* EINPROGRESS (in module errno):         errno — Standard errno system symbols.
                                                             (line  487)
* EINTR (in module errno):               errno — Standard errno system symbols.
                                                             (line   38)
* EINVAL (in module errno):              errno — Standard errno system symbols.
                                                             (line  115)
* EIO (in module errno):                 errno — Standard errno system symbols.
                                                             (line   47)
* EISCONN (in module errno):             errno — Standard errno system symbols.
                                                             (line  451)
* EISDIR (in module errno):              errno — Standard errno system symbols.
                                                             (line  111)
* EISNAM (in module errno):              errno — Standard errno system symbols.
                                                             (line  507)
* EL2HLT (in module errno):              errno — Standard errno system symbols.
                                                             (line  231)
* EL2NSYNC (in module errno):            errno — Standard errno system symbols.
                                                             (line  207)
* EL3HLT (in module errno):              errno — Standard errno system symbols.
                                                             (line  211)
* EL3RST (in module errno):              errno — Standard errno system symbols.
                                                             (line  215)
* Element (class in xml.etree.ElementTree): Element Objects. (line    6)
* ElementDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  202)
* elements() (collections.Counter method): Counter objects.  (line   66)
* ElementTree (class in xml.etree.ElementTree): ElementTree Objects.
                                                             (line    6)
* element_create() (tkinter.ttk.Style method): Ttk Styling.  (line   86)
* element_names() (tkinter.ttk.Style method): Ttk Styling.   (line  138)
* element_options() (tkinter.ttk.Style method): Ttk Styling. (line  142)
* ELIBACC (in module errno):             errno — Standard errno system symbols.
                                                             (line  343)
* ELIBBAD (in module errno):             errno — Standard errno system symbols.
                                                             (line  347)
* ELIBEXEC (in module errno):            errno — Standard errno system symbols.
                                                             (line  359)
* ELIBMAX (in module errno):             errno — Standard errno system symbols.
                                                             (line  355)
* ELIBSCN (in module errno):             errno — Standard errno system symbols.
                                                             (line  351)
* Ellinghouse, Lance:                    uu — Encode and decode uuencode files.
                                                             (line   20)
* Ellipsis (built-in variable):          Built-in Constants. (line   52)
* ELLIPSIS (in module doctest):          Option Flags.       (line   49)
* ELLIPSIS (in module token):            token — Constants used with Python parse trees.
                                                             (line  234)
* ELNRNG (in module errno):              errno — Standard errno system symbols.
                                                             (line  219)
* ELOOP (in module errno):               errno — Standard errno system symbols.
                                                             (line  187)
* else; conditional expression:          Conditional expressions.
                                                             (line    6)
* email (module):                        email — An email and MIME handling package.
                                                             (line    6)
* email.charset (module):                email charset Representing character sets.
                                                             (line    6)
* email.contentmanager (module):         email contentmanager Managing MIME Content.
                                                             (line    6)
* email.encoders (module):               email encoders Encoders.
                                                             (line    6)
* email.errors (module):                 email errors Exception and Defect classes.
                                                             (line    6)
* email.generator (module):              email generator Generating MIME documents.
                                                             (line    6)
* email.header (module):                 email header Internationalized headers.
                                                             (line    6)
* email.headerregistry (module):         email headerregistry Custom Header Objects.
                                                             (line    6)
* email.iterators (module):              email iterators Iterators.
                                                             (line    6)
* email.message (module):                email message Representing an email message.
                                                             (line    6)
* email.mime (module):                   email mime Creating email and MIME objects from scratch.
                                                             (line    6)
* email.parser (module):                 email parser Parsing email messages.
                                                             (line    6)
* email.policy (module):                 email policy Policy Objects.
                                                             (line    6)
* email.utils (module):                  email utils Miscellaneous utilities.
                                                             (line    6)
* EmailMessage (class in email.message): email message Representing an email message.
                                                             (line   52)
* EmailPolicy (class in email.policy):   email policy Policy Objects.
                                                             (line  321)
* EMFILE (in module errno):              errno — Standard errno system symbols.
                                                             (line  123)
* emit() (logging.FileHandler method):   FileHandler.        (line   27)
* emit() (logging.Handler method):       Handler Objects.    (line  107)
* emit() (logging.handlers.BufferingHandler method): MemoryHandler.
                                                             (line   24)
* emit() (logging.handlers.DatagramHandler method): DatagramHandler.
                                                             (line   20)
* emit() (logging.handlers.HTTPHandler method): HTTPHandler. (line   36)
* emit() (logging.handlers.NTEventLogHandler method): NTEventLogHandler.
                                                             (line   38)
* emit() (logging.handlers.QueueHandler method): QueueHandler.
                                                             (line   31)
* emit() (logging.handlers.RotatingFileHandler method): RotatingFileHandler.
                                                             (line   42)
* emit() (logging.handlers.SMTPHandler method): SMTPHandler. (line   35)
* emit() (logging.handlers.SocketHandler method): SocketHandler.
                                                             (line   24)
* emit() (logging.handlers.SysLogHandler method): SysLogHandler.
                                                             (line   43)
* emit() (logging.handlers.TimedRotatingFileHandler method): TimedRotatingFileHandler.
                                                             (line  105)
* emit() (logging.handlers.WatchedFileHandler method): WatchedFileHandler.
                                                             (line   46)
* emit() (logging.NullHandler method):   NullHandler.        (line   16)
* emit() (logging.StreamHandler method): StreamHandler.      (line   17)
* EMLINK (in module errno):              errno — Standard errno system symbols.
                                                             (line  151)
* Empty:                                 queue — A synchronized queue class.
                                                             (line   76)
* empty (inspect.Parameter attribute):   Introspecting callables with the Signature object.
                                                             (line  131)
* empty (inspect.Signature attribute):   Introspecting callables with the Signature object.
                                                             (line   61)
* empty() (asyncio.Queue method):        Queue.              (line   28)
* empty() (multiprocessing.Queue method): Pipes and Queues.  (line  108)
* empty() (multiprocessing.SimpleQueue method): Pipes and Queues.
                                                             (line  209)
* empty() (queue.Queue method):          Queue Objects.      (line   15)
* empty() (queue.SimpleQueue method):    SimpleQueue Objects.
                                                             (line   14)
* empty() (sched.scheduler method):      Scheduler Objects.  (line   47)
* empty; list:                           List displays.      (line    6)
* empty; tuple:                          The standard type hierarchy.
                                                             (line  154)
* empty; tuple <1>:                      Parenthesized forms.
                                                             (line   16)
* emptyline() (cmd.Cmd method):          Cmd Objects.        (line   68)
* EMPTY_NAMESPACE (in module xml.dom):   Module Contents<4>. (line   35)
* EMSGSIZE (in module errno):            errno — Standard errno system symbols.
                                                             (line  387)
* EMULTIHOP (in module errno):           errno — Standard errno system symbols.
                                                             (line  315)
* enable (pdb command):                  Debugger Commands.  (line  107)
* enable() (bdb.Breakpoint method):      bdb — Debugger framework.
                                                             (line   47)
* enable() (imaplib.IMAP4 method):       IMAP4 Objects.      (line   84)
* enable() (in module cgitb):            cgitb — Traceback manager for CGI scripts.
                                                             (line   29)
* enable() (in module faulthandler):     Fault handler state.
                                                             (line    6)
* enable() (in module gc):               gc — Garbage Collector interface.
                                                             (line   22)
* enable() (profile.Profile method):     profile and cProfile Module Reference.
                                                             (line   63)
* EnableReflectionKey() (in module winreg): Functions<11>.   (line  504)
* enable_callback_tracebacks() (in module sqlite3): Module functions and constants.
                                                             (line  185)
* enable_interspersed_args() (optparse.OptionParser method): Querying and manipulating your option parser.
                                                             (line   31)
* enable_load_extension() (sqlite3.Connection method): Connection Objects.
                                                             (line  250)
* enable_traversal() (tkinter.ttk.Notebook method): ttk Notebook.
                                                             (line   75)
* ENABLE_USER_SITE (in module site):     Module contents<3>. (line   10)
* ENAMETOOLONG (in module errno):        errno — Standard errno system symbols.
                                                             (line  171)
* ENAVAIL (in module errno):             errno — Standard errno system symbols.
                                                             (line  503)
* enclose() (curses.window method):      Window Objects.     (line  201)
* encode (codecs.CodecInfo attribute):   codecs — Codec registry and base classes.
                                                             (line   69)
* encode() (codecs.Codec method):        Stateless Encoding and Decoding.
                                                             (line    9)
* encode() (codecs.IncrementalEncoder method): IncrementalEncoder Objects.
                                                             (line   28)
* encode() (email.header.Header method): email header Internationalized headers.
                                                             (line  119)
* encode() (in module base64):           base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  226)
* encode() (in module codecs):           codecs — Codec registry and base classes.
                                                             (line   23)
* encode() (in module quopri):           quopri — Encode and decode MIME quoted-printable data.
                                                             (line   29)
* encode() (in module uu):               uu — Encode and decode uuencode files.
                                                             (line   25)
* encode() (json.JSONEncoder method):    Encoders and Decoders.
                                                             (line  208)
* encode() (str method):                 String Methods<2>.  (line   61)
* encode() (xmlrpc.client.Binary method): Binary Objects.    (line   25)
* encode() (xmlrpc.client.DateTime method): DateTime Objects.
                                                             (line   17)
* encodebytes() (in module base64):      base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  236)
* EncodedFile() (in module codecs):      codecs — Codec registry and base classes.
                                                             (line  194)
* encodePriority() (logging.handlers.SysLogHandler method): SysLogHandler.
                                                             (line   77)
* encodestring() (in module base64):     base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  246)
* encodestring() (in module quopri):     quopri — Encode and decode MIME quoted-printable data.
                                                             (line   46)
* encode_7or8bit() (in module email.encoders): email encoders Encoders.
                                                             (line   57)
* encode_base64() (in module email.encoders): email encoders Encoders.
                                                             (line   49)
* encode_noop() (in module email.encoders): email encoders Encoders.
                                                             (line   63)
* encode_quopri() (in module email.encoders): email encoders Encoders.
                                                             (line   42)
* encode_rfc2231() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line  172)
* encoding (curses.window attribute):    Window Objects.     (line  208)
* ENCODING (in module tarfile):          tarfile — Read and write tar archive files.
                                                             (line  213)
* ENCODING (in module token):            token — Constants used with Python parse trees.
                                                             (line  272)
* encoding (io.TextIOBase attribute):    Text I/O<2>.        (line   15)
* encoding (UnicodeError attribute):     Concrete exceptions.
                                                             (line  342)
* encoding declarations (source file):   Encoding declarations.
                                                             (line    6)
* encodings.idna (module):               encodings idna — Internationalized Domain Names in Applications.
                                                             (line    6)
* encodings.mbcs (module):               encodings mbcs — Windows ANSI codepage.
                                                             (line    6)
* encodings.utf_8_sig (module):          encodings utf_8_sig — UTF-8 codec with BOM signature.
                                                             (line    6)
* encodings_map (in module mimetypes):   mimetypes — Map filenames to MIME types.
                                                             (line  136)
* encodings_map (mimetypes.MimeTypes attribute): MimeTypes Objects.
                                                             (line   33)
* end (UnicodeError attribute):          Concrete exceptions.
                                                             (line  358)
* end() (re.Match method):               Match Objects.      (line  132)
* end() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   38)
* EndCdataSectionHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  306)
* EndDoctypeDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  197)
* endDocument() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line   40)
* endElement() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line   95)
* EndElementHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  232)
* endElementNS() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line  121)
* endheaders() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line  140)
* ENDMARKER (in module token):           token — Constants used with Python parse trees.
                                                             (line   40)
* EndNamespaceDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  285)
* endpos (re.Match attribute):           Match Objects.      (line  171)
* endPrefixMapping() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line   73)
* endswith() (bytearray method):         Bytes and Bytearray Operations.
                                                             (line   67)
* endswith() (bytes method):             Bytes and Bytearray Operations.
                                                             (line   67)
* endswith() (str method):               String Methods<2>.  (line   75)
* endwin() (in module curses):           Functions<3>.       (line  109)
* END_ASYNC_FOR (opcode):                Python Bytecode Instructions.
                                                             (line  284)
* end_col_offset (ast.AST attribute):    Node classes.       (line   39)
* end_fill() (in module turtle):         Filling.            (line   16)
* END_FINALLY (opcode):                  Python Bytecode Instructions.
                                                             (line  415)
* end_headers() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  262)
* end_lineno (ast.AST attribute):        Node classes.       (line   39)
* end_ns() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   85)
* end_paragraph() (formatter.formatter method): The Formatter Interface.
                                                             (line   26)
* end_poly() (in module turtle):         Special Turtle methods.
                                                             (line   11)
* ENETDOWN (in module errno):            errno — Standard errno system symbols.
                                                             (line  427)
* ENETRESET (in module errno):           errno — Standard errno system symbols.
                                                             (line  435)
* ENETUNREACH (in module errno):         errno — Standard errno system symbols.
                                                             (line  431)
* ENFILE (in module errno):              errno — Standard errno system symbols.
                                                             (line  119)
* ENOANO (in module errno):              errno — Standard errno system symbols.
                                                             (line  247)
* ENOBUFS (in module errno):             errno — Standard errno system symbols.
                                                             (line  447)
* ENOCSI (in module errno):              errno — Standard errno system symbols.
                                                             (line  227)
* ENODATA (in module errno):             errno — Standard errno system symbols.
                                                             (line  271)
* ENODEV (in module errno):              errno — Standard errno system symbols.
                                                             (line  103)
* ENOENT (in module errno):              errno — Standard errno system symbols.
                                                             (line   30)
* ENOEXEC (in module errno):             errno — Standard errno system symbols.
                                                             (line   59)
* ENOLCK (in module errno):              errno — Standard errno system symbols.
                                                             (line  175)
* ENOLINK (in module errno):             errno — Standard errno system symbols.
                                                             (line  295)
* ENOMEM (in module errno):              errno — Standard errno system symbols.
                                                             (line   75)
* ENOMSG (in module errno):              errno — Standard errno system symbols.
                                                             (line  195)
* ENONET (in module errno):              errno — Standard errno system symbols.
                                                             (line  283)
* ENOPKG (in module errno):              errno — Standard errno system symbols.
                                                             (line  287)
* ENOPROTOOPT (in module errno):         errno — Standard errno system symbols.
                                                             (line  395)
* ENOSPC (in module errno):              errno — Standard errno system symbols.
                                                             (line  139)
* ENOSR (in module errno):               errno — Standard errno system symbols.
                                                             (line  279)
* ENOSTR (in module errno):              errno — Standard errno system symbols.
                                                             (line  267)
* ENOSYS (in module errno):              errno — Standard errno system symbols.
                                                             (line  179)
* ENOTBLK (in module errno):             errno — Standard errno system symbols.
                                                             (line   87)
* ENOTCONN (in module errno):            errno — Standard errno system symbols.
                                                             (line  455)
* ENOTDIR (in module errno):             errno — Standard errno system symbols.
                                                             (line  107)
* ENOTEMPTY (in module errno):           errno — Standard errno system symbols.
                                                             (line  183)
* ENOTNAM (in module errno):             errno — Standard errno system symbols.
                                                             (line  499)
* ENOTSOCK (in module errno):            errno — Standard errno system symbols.
                                                             (line  379)
* ENOTTY (in module errno):              errno — Standard errno system symbols.
                                                             (line  127)
* ENOTUNIQ (in module errno):            errno — Standard errno system symbols.
                                                             (line  331)
* enqueue() (logging.handlers.QueueHandler method): QueueHandler.
                                                             (line   53)
* enqueue_sentinel() (logging.handlers.QueueListener method): QueueListener.
                                                             (line   87)
* ensurepip (module):                    ensurepip — Bootstrapping the pip installer.
                                                             (line    6)
* ensure_directories() (venv.EnvBuilder method): API<2>.     (line   67)
* ensure_future() (in module asyncio):   Future Functions.   (line   19)
* enter() (sched.scheduler method):      Scheduler Objects.  (line   30)
* enterabs() (sched.scheduler method):   Scheduler Objects.  (line    9)
* enter_async_context() (contextlib.AsyncExitStack method): Utilities.
                                                             (line  341)
* enter_context() (contextlib.ExitStack method): Utilities.  (line  267)
* entities (xml.dom.DocumentType attribute): DocumentType Objects.
                                                             (line   38)
* EntityDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  258)
* entitydefs (in module html.entities):  html entities — Definitions of HTML general entities.
                                                             (line   25)
* EntityResolver (class in xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   31)
* Enum (class in enum):                  Module Contents<2>. (line   11)
* enum (module):                         enum — Support for enumerations.
                                                             (line    6)
* enumerate() (built-in function):       Built-in Functions. (line  450)
* enumerate() (in module threading):     threading — Thread-based parallelism.
                                                             (line   98)
* EnumKey() (in module winreg):          Functions<11>.      (line  177)
* EnumValue() (in module winreg):        Functions<11>.      (line  196)
* enum_certificates() (in module ssl):   Certificate handling.
                                                             (line  117)
* enum_crls() (in module ssl):           Certificate handling.
                                                             (line  138)
* EnvBuilder (class in venv):            API<2>.             (line   11)
* environ (in module os):                Process Parameters. (line   16)
* environ (in module posix):             Notable Module Contents.
                                                             (line    9)
* environb (in module os):               Process Parameters. (line   55)
* environment:                           Resolution of names.
                                                             (line   12)
* environment variable; APPDATA:         PEP 370 Per-user site-packages Directory.
                                                             (line   26)
* environment variable; AUDIODEV:        ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line   54)
* environment variable; BROWSER:         webbrowser — Convenient Web-browser controller.
                                                             (line   20)
* environment variable; BROWSER <1>:     webbrowser — Convenient Web-browser controller.
                                                             (line   95)
* environment variable; CC:              New Improved and Deprecated Modules<4>.
                                                             (line   58)
* environment variable; CFLAGS:          New Improved and Deprecated Modules<4>.
                                                             (line   58)
* environment variable; CFLAGS <1>:      Tweaking compiler/linker flags.
                                                             (line   66)
* environment variable; CFLAGS <2>:      Tweaking compiler/linker flags.
                                                             (line   67)
* environment variable; COLS:            curses<2>.          (line    7)
* environment variable; COLS <1>:        Functions<3>.       (line  523)
* environment variable; COLUMNS:         Functions<3>.       (line  547)
* environment variable; COLUMNS <1>:     Functions<3>.       (line  550)
* environment variable; COMSPEC:         Process Management. (line  635)
* environment variable; COMSPEC <1>:     Popen Constructor.  (line   78)
* environment variable; CPP:             New Improved and Deprecated Modules<4>.
                                                             (line   59)
* environment variable; CPPFLAGS:        New Improved and Deprecated Modules<4>.
                                                             (line   59)
* environment variable; DISTUTILS_DEBUG: Debugging the setup script.
                                                             (line   19)
* environment variable; exec_prefix:     Python-related paths and files.
                                                             (line    7)
* environment variable; exec_prefix <1>: Include Files.      (line   36)
* environment variable; exec_prefix <2>: Include Files.      (line   47)
* environment variable; HOME:            os path.            (line   15)
* environment variable; HOME <1>:        Changes in the Python API.
                                                             (line  111)
* environment variable; HOME <2>:        os path — Common pathname manipulations.
                                                             (line  140)
* environment variable; HOME <3>:        os path — Common pathname manipulations.
                                                             (line  156)
* environment variable; HOME <4>:        distutils util — Miscellaneous other utility functions.
                                                             (line   77)
* environment variable; HOME <5>:        Location and names of config files.
                                                             (line   50)
* environment variable; HOME <6>:        Location and names of config files.
                                                             (line   67)
* environment variable; HOMEDRIVE:       os path — Common pathname manipulations.
                                                             (line  147)
* environment variable; HOMEDRIVE <1>:   Location and names of config files.
                                                             (line   68)
* environment variable; HOMEPATH:        os path — Common pathname manipulations.
                                                             (line  147)
* environment variable; HOMEPATH <1>:    Location and names of config files.
                                                             (line   68)
* environment variable; http_proxy:      urllib request — Extensible library for opening URLs.
                                                             (line   85)
* environment variable; http_proxy <1>:  Examples<21>.       (line   56)
* environment variable; http_proxy <2>:  Basic Authentication.
                                                             (line   44)
* environment variable; IDLESTARTUP:     IDLE<14>.           (line  176)
* environment variable; IDLESTARTUP <1>: IDLE<18>.           (line    9)
* environment variable; IDLESTARTUP <2>: IDLE<24>.           (line    9)
* environment variable; IDLESTARTUP <3>: Startup and code execution.
                                                             (line    7)
* environment variable; KDEDIR:          webbrowser — Convenient Web-browser controller.
                                                             (line  184)
* environment variable; LANG:            GNU gettext API.    (line   21)
* environment variable; LANG <1>:        Class-based API.    (line   26)
* environment variable; LANG <2>:        locale — Internationalization services.
                                                             (line   48)
* environment variable; LANG <3>:        locale — Internationalization services.
                                                             (line  309)
* environment variable; LANG <4>:        locale — Internationalization services.
                                                             (line  313)
* environment variable; LANGUAGE:        GNU gettext API.    (line   20)
* environment variable; LANGUAGE <1>:    Class-based API.    (line   25)
* environment variable; LC_ALL:          GNU gettext API.    (line   20)
* environment variable; LC_ALL <1>:      Class-based API.    (line   25)
* environment variable; LC_MESSAGES:     GNU gettext API.    (line   20)
* environment variable; LC_MESSAGES <1>: Class-based API.    (line   26)
* environment variable; LDCXXSHARED:     Build and C API Changes<8>.
                                                             (line  153)
* environment variable; LDFLAGS:         New Improved and Deprecated Modules<4>.
                                                             (line   59)
* environment variable; LINES:           curses<2>.          (line    6)
* environment variable; LINES <1>:       Functions<3>.       (line  124)
* environment variable; LINES <2>:       Functions<3>.       (line  523)
* environment variable; LINES <3>:       Functions<3>.       (line  547)
* environment variable; LINES <4>:       Functions<3>.       (line  549)
* environment variable; LNAME:           getpass — Portable password input.
                                                             (line   38)
* environment variable; LOGNAME:         Process Parameters. (line  221)
* environment variable; LOGNAME <1>:     getpass — Portable password input.
                                                             (line   38)
* environment variable; MIXERDEV:        ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line   74)
* environment variable; no_proxy:        urllib request — Extensible library for opening URLs.
                                                             (line  303)
* environment variable; PAGER:           pydoc — Documentation generator and online help system.
                                                             (line   47)
* environment variable; PATH:            Changes in the Python API.
                                                             (line  137)
* environment variable; PATH <1>:        Changes in ‘python’ Command Behavior<2>.
                                                             (line    6)
* environment variable; PATH <2>:        Changes in ‘python’ Command Behavior<2>.
                                                             (line   11)
* environment variable; PATH <3>:        Changes in ‘python’ Command Behavior<2>.
                                                             (line   12)
* environment variable; PATH <4>:        Security<7>.        (line   16)
* environment variable; PATH <5>:        Security<7>.        (line   20)
* environment variable; PATH <6>:        The Module Search Path.
                                                             (line   16)
* environment variable; PATH <7>:        Executable Python Scripts.
                                                             (line   11)
* environment variable; PATH <8>:        Environment variables.
                                                             (line   27)
* environment variable; PATH <9>:        Miscellaneous.      (line   16)
* environment variable; PATH <10>:       Installation steps. (line   32)
* environment variable; PATH <11>:       Installation steps. (line   56)
* environment variable; PATH <12>:       Installing Without UI.
                                                             (line   57)
* environment variable; PATH <13>:       Excursus Setting environment variables.
                                                             (line   23)
* environment variable; PATH <14>:       Excursus Setting environment variables.
                                                             (line   35)
* environment variable; PATH <15>:       Finding the Python executable.
                                                             (line   14)
* environment variable; PATH <16>:       Finding the Python executable.
                                                             (line   21)
* environment variable; PATH <17>:       Finding the Python executable.
                                                             (line   22)
* environment variable; PATH <18>:       Python Launcher for Windows.
                                                             (line   13)
* environment variable; PATH <19>:       From the command-line.
                                                             (line    9)
* environment variable; PATH <20>:       From the command-line.
                                                             (line   38)
* environment variable; PATH <21>:       Shebang Lines.      (line   48)
* environment variable; PATH <22>:       Shebang Lines.      (line   50)
* environment variable; PATH <23>:       Process Management. (line   42)
* environment variable; PATH <24>:       Process Management. (line   83)
* environment variable; PATH <25>:       Process Management. (line   86)
* environment variable; PATH <26>:       Process Management. (line   89)
* environment variable; PATH <27>:       Process Management. (line  433)
* environment variable; PATH <28>:       Process Management. (line  516)
* environment variable; PATH <29>:       Process Management. (line  520)
* environment variable; PATH <30>:       Process Management. (line  522)
* environment variable; PATH <31>:       Miscellaneous System Information.
                                                             (line  118)
* environment variable; PATH <32>:       webbrowser — Convenient Web-browser controller.
                                                             (line  208)
* environment variable; PATH <33>:       Installing your CGI script on a Unix system.
                                                             (line   29)
* environment variable; PATH <34>:       Common problems and solutions.
                                                             (line   23)
* environment variable; PATH <35>:       site — Site-specific configuration hook.
                                                             (line   59)
* environment variable; PATH <36>:       Embedding Python<2>.
                                                             (line   31)
* environment variable; PATH <37>:       Embedding Python<2>.
                                                             (line   37)
* environment variable; PATH <38>:       How do I make a Python script executable on Unix?.
                                                             (line   24)
* environment variable; PATH <39>:       How do I make a Python script executable on Unix?.
                                                             (line   28)
* environment variable; PATHEXT:         Other Improvements<2>.
                                                             (line   30)
* environment variable; PATHEXT <1>:     Installing Without UI.
                                                             (line   58)
* environment variable; PIP_USER:        Windows<6>.         (line    7)
* environment variable; PLAT:            distutils util — Miscellaneous other utility functions.
                                                             (line   79)
* environment variable; POSIXLY_CORRECT: getopt — C-style parser for command line options.
                                                             (line   71)
* environment variable; prefix:          Python-related paths and files.
                                                             (line    7)
* environment variable; prefix <1>:      Include Files.      (line   36)
* environment variable; prefix <2>:      Include Files.      (line   39)
* environment variable; prefix <3>:      Include Files.      (line   46)
* environment variable; PYTHON*:         Other Improvements<2>.
                                                             (line    9)
* environment variable; PYTHON* <1>:     Interface options.  (line   80)
* environment variable; PYTHON* <2>:     Interface options.  (line  140)
* environment variable; PYTHON* <3>:     Miscellaneous options.
                                                             (line   42)
* environment variable; PYTHON* <4>:     Miscellaneous options.
                                                             (line   60)
* environment variable; PYTHON* <5>:     Global configuration variables.
                                                             (line   56)
* environment variable; PYTHONASYNCIODEBUG: Environment variables.
                                                             (line  238)
* environment variable; PYTHONASYNCIODEBUG <1>: Enabling debug mode.
                                                             (line   10)
* environment variable; PYTHONASYNCIODEBUG <2>: Debug Mode.  (line   11)
* environment variable; PYTHONBREAKPOINT: PEP 553 Built-in breakpoint.
                                                             (line   13)
* environment variable; PYTHONBREAKPOINT <1>: Environment variables.
                                                             (line   66)
* environment variable; PYTHONBREAKPOINT <2>: sys — System-specific parameters and functions.
                                                             (line  188)
* environment variable; PYTHONBREAKPOINT <3>: sys — System-specific parameters and functions.
                                                             (line  202)
* environment variable; PYTHONBREAKPOINT <4>: sys — System-specific parameters and functions.
                                                             (line  206)
* environment variable; PYTHONCASEOK:    PEP 235 Importing Modules on Case-Insensitive Platforms.
                                                             (line   17)
* environment variable; PYTHONCASEOK <1>: Environment variables.
                                                             (line  104)
* environment variable; PYTHONCOERCECLOCALE: PEP 538 Legacy C Locale Coercion.
                                                             (line   13)
* environment variable; PYTHONCOERCECLOCALE <1>: Environment variables.
                                                             (line  322)
* environment variable; PYTHONCOERCECLOCALE <2>: Environment variables.
                                                             (line  438)
* environment variable; PYTHONCOERCECLOCALE <3>: Python Configuration.
                                                             (line   15)
* environment variable; PYTHONDEBUG:     Miscellaneous options.
                                                             (line   38)
* environment variable; PYTHONDEBUG <1>: Environment variables.
                                                             (line   79)
* environment variable; PYTHONDEBUG <2>: Global configuration variables.
                                                             (line   28)
* environment variable; PYTHONDEVMODE:   Development Runtime Mode -X dev.
                                                             (line    6)
* environment variable; PYTHONDEVMODE <1>: Environment variables.
                                                             (line  378)
* environment variable; PYTHONDEVMODE <2>: test support script_helper — Utilities for the Python execution tests.
                                                             (line  106)
* environment variable; PYTHONDOCS:      pydoc — Documentation generator and online help system.
                                                             (line   85)
* environment variable; PYTHONDONTWRITEBYTECODE: Interpreter Changes<2>.
                                                             (line   16)
* environment variable; PYTHONDONTWRITEBYTECODE <1>: New and Improved Modules<2>.
                                                             (line  625)
* environment variable; PYTHONDONTWRITEBYTECODE <2>: Miscellaneous options.
                                                             (line   19)
* environment variable; PYTHONDONTWRITEBYTECODE <3>: Environment variables.
                                                             (line  109)
* environment variable; PYTHONDONTWRITEBYTECODE <4>: sys — System-specific parameters and functions.
                                                             (line  255)
* environment variable; PYTHONDONTWRITEBYTECODE <5>: Global configuration variables.
                                                             (line   36)
* environment variable; PYTHONDONTWRITEBYTECODE <6>: How do I create a pyc file?.
                                                             (line   21)
* environment variable; PYTHONDUMPREFS:  Debug build uses the same ABI as release build.
                                                             (line   14)
* environment variable; PYTHONDUMPREFS <1>: Build<7>.        (line   54)
* environment variable; PYTHONDUMPREFS <2>: Debug-mode variables.
                                                             (line   14)
* environment variable; PYTHONDUMPREFS <3>: PyObject Slots.  (line   24)
* environment variable; PYTHONEXECUTABLE: Environment variables.
                                                             (line  182)
* environment variable; PYTHONFAULTHANDLER: faulthandler<3>. (line   11)
* environment variable; PYTHONFAULTHANDLER <1>: Environment variables.
                                                             (line  209)
* environment variable; PYTHONFAULTHANDLER <2>: faulthandler — Dump the Python traceback.
                                                             (line   14)
* environment variable; PYTHONHASHSEED:  Builtin functions and types.
                                                             (line   17)
* environment variable; PYTHONHASHSEED <1>: Porting Python code.
                                                             (line    6)
* environment variable; PYTHONHASHSEED <2>: Core and Builtins<19>.
                                                             (line   30)
* environment variable; PYTHONHASHSEED <3>: Miscellaneous options.
                                                             (line   94)
* environment variable; PYTHONHASHSEED <4>: Miscellaneous options.
                                                             (line  110)
* environment variable; PYTHONHASHSEED <5>: Environment variables.
                                                             (line  124)
* environment variable; PYTHONHASHSEED <6>: Environment variables.
                                                             (line  129)
* environment variable; PYTHONHASHSEED <7>: Basic customization.
                                                             (line  294)
* environment variable; PYTHONHASHSEED <8>: Global configuration variables.
                                                             (line   48)
* environment variable; PYTHONHASHSEED <9>: Global configuration variables.
                                                             (line   51)
* environment variable; PYTHONHOME:      Summary – Release highlights<2>.
                                                             (line  107)
* environment variable; PYTHONHOME <1>:  Miscellaneous options.
                                                             (line   43)
* environment variable; PYTHONHOME <2>:  Environment variables.
                                                             (line   11)
* environment variable; PYTHONHOME <3>:  Environment variables.
                                                             (line   19)
* environment variable; PYTHONHOME <4>:  Environment variables.
                                                             (line   21)
* environment variable; PYTHONHOME <5>:  Environment variables.
                                                             (line   38)
* environment variable; PYTHONHOME <6>:  Finding modules.    (line   50)
* environment variable; PYTHONHOME <7>:  Finding modules.    (line   68)
* environment variable; PYTHONHOME <8>:  Finding modules.    (line  102)
* environment variable; PYTHONHOME <9>:  test support script_helper — Utilities for the Python execution tests.
                                                             (line   25)
* environment variable; PYTHONHOME <10>: Embedding Python<2>.
                                                             (line   38)
* environment variable; PYTHONHOME <11>: Embedding Python<2>.
                                                             (line   44)
* environment variable; PYTHONHOME <12>: Global configuration variables.
                                                             (line   57)
* environment variable; PYTHONHOME <13>: Process-wide parameters.
                                                             (line  270)
* environment variable; PYTHONHOME <14>: Process-wide parameters.
                                                             (line  284)
* environment variable; PYTHONHOME <15>: PyConfig.           (line  197)
* environment variable; PYTHONHOME <16>: Modifying Python’s Search Path.
                                                             (line   50)
* environment variable; PYTHONHOME <17>: Modifying Python’s Search Path.
                                                             (line   52)
* environment variable; PYTHONINSPECT:   Other Changes and Fixes<2>.
                                                             (line   13)
* environment variable; PYTHONINSPECT <1>: Miscellaneous options.
                                                             (line   53)
* environment variable; PYTHONINSPECT <2>: Environment variables.
                                                             (line   85)
* environment variable; PYTHONINSPECT <3>: Global configuration variables.
                                                             (line   68)
* environment variable; PYTHONIOENCODING: Other Improvements<2>.
                                                             (line   75)
* environment variable; PYTHONIOENCODING <1>: Interpreter Changes<2>.
                                                             (line   23)
* environment variable; PYTHONIOENCODING <2>: Environment variables.
                                                             (line  142)
* environment variable; PYTHONIOENCODING <3>: Environment variables.
                                                             (line  359)
* environment variable; PYTHONIOENCODING <4>: Environment variables.
                                                             (line  426)
* environment variable; PYTHONIOENCODING <5>: sys — System-specific parameters and functions.
                                                             (line 1454)
* environment variable; PYTHONIOENCODING <6>: Process-wide parameters.
                                                             (line   14)
* environment variable; PYTHONIOENCODING <7>: Process-wide parameters.
                                                             (line   18)
* environment variable; PYTHONLEGACYWINDOWSFSENCODING: PEP 529 Change Windows filesystem encoding to UTF-8.
                                                             (line   18)
* environment variable; PYTHONLEGACYWINDOWSFSENCODING <1>: Environment variables.
                                                             (line  295)
* environment variable; PYTHONLEGACYWINDOWSFSENCODING <2>: sys — System-specific parameters and functions.
                                                             (line 1406)
* environment variable; PYTHONLEGACYWINDOWSFSENCODING <3>: Global configuration variables.
                                                             (line   90)
* environment variable; PYTHONLEGACYWINDOWSSTDIO: PEP 528 Change Windows console encoding to UTF-8.
                                                             (line   12)
* environment variable; PYTHONLEGACYWINDOWSSTDIO <1>: Environment variables.
                                                             (line  156)
* environment variable; PYTHONLEGACYWINDOWSSTDIO <2>: Environment variables.
                                                             (line  309)
* environment variable; PYTHONLEGACYWINDOWSSTDIO <3>: sys — System-specific parameters and functions.
                                                             (line 1458)
* environment variable; PYTHONLEGACYWINDOWSSTDIO <4>: Global configuration variables.
                                                             (line  102)
* environment variable; PYTHONMALLOC:    PYTHONMALLOC environment variable.
                                                             (line    6)
* environment variable; PYTHONMALLOC <1>: Changes in the C API<3>.
                                                             (line    9)
* environment variable; PYTHONMALLOC <2>: Core and Builtins<39>.
                                                             (line   91)
* environment variable; PYTHONMALLOC <3>: Environment variables.
                                                             (line  245)
* environment variable; PYTHONMALLOC <4>: Environment variables.
                                                             (line  286)
* environment variable; PYTHONMALLOC <5>: Overview<3>.       (line   67)
* environment variable; PYTHONMALLOC <6>: Default Memory Allocators.
                                                             (line   26)
* environment variable; PYTHONMALLOC <7>: Customize Memory Allocators.
                                                             (line  129)
* environment variable; PYTHONMALLOCSTATS: Core and Builtins<39>.
                                                             (line   97)
* environment variable; PYTHONMALLOCSTATS <1>: Environment variables.
                                                             (line  280)
* environment variable; PYTHONMALLOCSTATS <2>: Overview<3>.  (line   70)
* environment variable; PYTHONNOUSERSITE: PEP 370 Per-user site-packages Directory.
                                                             (line   30)
* environment variable; PYTHONNOUSERSITE <1>: Environment variables.
                                                             (line  160)
* environment variable; PYTHONNOUSERSITE <2>: Module contents<3>.
                                                             (line   15)
* environment variable; PYTHONNOUSERSITE <3>: Module contents<3>.
                                                             (line   74)
* environment variable; PYTHONNOUSERSITE <4>: Global configuration variables.
                                                             (line  124)
* environment variable; PYTHONOPTIMIZE:  Miscellaneous options.
                                                             (line   71)
* environment variable; PYTHONOPTIMIZE <1>: Environment variables.
                                                             (line   60)
* environment variable; PYTHONOPTIMIZE <2>: Global configuration variables.
                                                             (line  129)
* environment variable; PYTHONPATH:      Changes in ‘python’ Command Behavior<2>.
                                                             (line    8)
* environment variable; PYTHONPATH <1>:  Changes in ‘python’ Command Behavior<2>.
                                                             (line    9)
* environment variable; PYTHONPATH <2>:  The Module Search Path.
                                                             (line   15)
* environment variable; PYTHONPATH <3>:  Standard Modules.   (line   34)
* environment variable; PYTHONPATH <4>:  Standard Modules.   (line   35)
* environment variable; PYTHONPATH <5>:  Miscellaneous options.
                                                             (line   42)
* environment variable; PYTHONPATH <6>:  Environment variables.
                                                             (line   24)
* environment variable; PYTHONPATH <7>:  Environment variables.
                                                             (line   32)
* environment variable; PYTHONPATH <8>:  Environment variables.
                                                             (line   39)
* environment variable; PYTHONPATH <9>:  Environment variables.
                                                             (line   42)
* environment variable; PYTHONPATH <10>: Excursus Setting environment variables.
                                                             (line   38)
* environment variable; PYTHONPATH <11>: Finding modules.    (line   36)
* environment variable; PYTHONPATH <12>: Finding modules.    (line   59)
* environment variable; PYTHONPATH <13>: Finding modules.    (line  102)
* environment variable; PYTHONPATH <14>: Configuration.      (line    6)
* environment variable; PYTHONPATH <15>: Installing your CGI script on a Unix system.
                                                             (line   29)
* environment variable; PYTHONPATH <16>: test support script_helper — Utilities for the Python execution tests.
                                                             (line   26)
* environment variable; PYTHONPATH <17>: sys — System-specific parameters and functions.
                                                             (line 1018)
* environment variable; PYTHONPATH <18>: sys — System-specific parameters and functions.
                                                             (line 1028)
* environment variable; PYTHONPATH <19>: Building C and C++ Extensions.
                                                             (line    9)
* environment variable; PYTHONPATH <20>: Embedding Python<2>.
                                                             (line   39)
* environment variable; PYTHONPATH <21>: Embedding Python<2>.
                                                             (line   44)
* environment variable; PYTHONPATH <22>: Global configuration variables.
                                                             (line   56)
* environment variable; PYTHONPATH <23>: PyConfig.           (line  252)
* environment variable; PYTHONPATH <24>: Modifying Python’s Search Path.
                                                             (line   57)
* environment variable; PYTHONPATH <25>: Modifying Python’s Search Path.
                                                             (line   58)
* environment variable; PYTHONPROFILEIMPORTTIME: Other Language Changes<2>.
                                                             (line   42)
* environment variable; PYTHONPROFILEIMPORTTIME <1>: Core and Builtins<21>.
                                                             (line   66)
* environment variable; PYTHONPROFILEIMPORTTIME <2>: Miscellaneous options.
                                                             (line  223)
* environment variable; PYTHONPROFILEIMPORTTIME <3>: Environment variables.
                                                             (line  230)
* environment variable; PYTHONPYCACHEPREFIX: Parallel filesystem cache for compiled bytecode files.
                                                             (line    6)
* environment variable; PYTHONPYCACHEPREFIX <1>: Core and Builtins<12>.
                                                             (line  402)
* environment variable; PYTHONPYCACHEPREFIX <2>: Miscellaneous options.
                                                             (line  257)
* environment variable; PYTHONPYCACHEPREFIX <3>: Environment variables.
                                                             (line  115)
* environment variable; PYTHONPYCACHEPREFIX <4>: sys — System-specific parameters and functions.
                                                             (line  273)
* environment variable; PYTHONSHOWALLOCCOUNT: Two new environment variables for debug mode.
                                                             (line   11)
* environment variable; PYTHONSHOWREFCOUNT: Two new environment variables for debug mode.
                                                             (line    7)
* environment variable; PYTHONSTARTUP:   sys<6>.             (line   17)
* environment variable; PYTHONSTARTUP <1>: sys<6>.           (line   21)
* environment variable; PYTHONSTARTUP <2>: IDLE<14>.         (line  176)
* environment variable; PYTHONSTARTUP <3>: IDLE<18>.         (line    9)
* environment variable; PYTHONSTARTUP <4>: IDLE<24>.         (line    9)
* environment variable; PYTHONSTARTUP <5>: The Interactive Startup File.
                                                             (line    8)
* environment variable; PYTHONSTARTUP <6>: Miscellaneous options.
                                                             (line   50)
* environment variable; PYTHONSTARTUP <7>: Environment variables.
                                                             (line   46)
* environment variable; PYTHONSTARTUP <8>: Example.          (line   10)
* environment variable; PYTHONSTARTUP <9>: Startup and code execution.
                                                             (line    7)
* environment variable; PYTHONSTARTUP <10>: sys — System-specific parameters and functions.
                                                             (line  913)
* environment variable; PYTHONSTARTUP <11>: Readline configuration.
                                                             (line   12)
* environment variable; PYTHONTHREADDEBUG: Debug-mode variables.
                                                             (line    8)
* environment variable; PYTHONTRACEMALLOC: Environment variables.
                                                             (line  219)
* environment variable; PYTHONTRACEMALLOC <1>: tracemalloc — Trace memory allocations.
                                                             (line   25)
* environment variable; PYTHONTRACEMALLOC <2>: tracemalloc — Trace memory allocations.
                                                             (line   32)
* environment variable; PYTHONTRACEMALLOC <3>: Functions<9>. (line   68)
* environment variable; PYTHONUNBUFFERED: Miscellaneous options.
                                                             (line  140)
* environment variable; PYTHONUNBUFFERED <1>: Environment variables.
                                                             (line   93)
* environment variable; PYTHONUNBUFFERED <2>: Global configuration variables.
                                                             (line  145)
* environment variable; PYTHONUSERBASE:  PEP 370 Per-user site-packages Directory.
                                                             (line   23)
* environment variable; PYTHONUSERBASE <1>: Environment variables.
                                                             (line  170)
* environment variable; PYTHONUSERBASE <2>: Module contents<3>.
                                                             (line   39)
* environment variable; PYTHONUSERBASE <3>: Module contents<3>.
                                                             (line   66)
* environment variable; PYTHONUSERSITE:  test support script_helper — Utilities for the Python execution tests.
                                                             (line   26)
* environment variable; PYTHONUTF8:      PEP 540 Forced UTF-8 Runtime Mode.
                                                             (line    6)
* environment variable; PYTHONUTF8 <1>:  Miscellaneous options.
                                                             (line  252)
* environment variable; PYTHONUTF8 <2>:  Environment variables.
                                                             (line  369)
* environment variable; PYTHONUTF8 <3>:  Environment variables.
                                                             (line  386)
* environment variable; PYTHONUTF8 <4>:  sys — System-specific parameters and functions.
                                                             (line 1456)
* environment variable; PYTHONUTF8 <5>:  Python Configuration.
                                                             (line   14)
* environment variable; PYTHONVERBOSE:   Miscellaneous options.
                                                             (line  151)
* environment variable; PYTHONVERBOSE <1>: Environment variables.
                                                             (line   98)
* environment variable; PYTHONVERBOSE <2>: Global configuration variables.
                                                             (line  156)
* environment variable; PYTHONWARNINGS:  warnings.           (line   21)
* environment variable; PYTHONWARNINGS <1>: Other Language Changes<7>.
                                                             (line  158)
* environment variable; PYTHONWARNINGS <2>: Changes to the Handling of Deprecation Warnings.
                                                             (line   25)
* environment variable; PYTHONWARNINGS <3>: Interpreter Changes.
                                                             (line    6)
* environment variable; PYTHONWARNINGS <4>: Miscellaneous options.
                                                             (line  169)
* environment variable; PYTHONWARNINGS <5>: Environment variables.
                                                             (line  188)
* environment variable; PYTHONWARNINGS <6>: Describing Warning Filters.
                                                             (line    7)
* environment variable; PYTHONWARNINGS <7>: Describing Warning Filters.
                                                             (line   21)
* environment variable; PYTHONWARNINGS <8>: Default Warning Filter.
                                                             (line    7)
* environment variable; PYTHON_DOM:      Module Contents<4>. (line   23)
* environment variable; PY_PYTHON:       Customizing default Python versions.
                                                             (line   18)
* environment variable; SOURCE_DATE_EPOCH: py_compile<2>.    (line    7)
* environment variable; SOURCE_DATE_EPOCH <1>: Library<12>.  (line  453)
* environment variable; SOURCE_DATE_EPOCH <2>: Build<15>.    (line   15)
* environment variable; SOURCE_DATE_EPOCH <3>: py_compile — Compile Python source files.
                                                             (line   65)
* environment variable; SOURCE_DATE_EPOCH <4>: py_compile — Compile Python source files.
                                                             (line   81)
* environment variable; SOURCE_DATE_EPOCH <5>: py_compile — Compile Python source files.
                                                             (line   85)
* environment variable; SOURCE_DATE_EPOCH <6>: Command-line use.
                                                             (line   85)
* environment variable; SSLKEYLOGFILE:   Context creation.   (line   33)
* environment variable; SSLKEYLOGFILE <1>: Context creation. (line   66)
* environment variable; SSL_CERT_FILE:   LibreSSL support.   (line   15)
* environment variable; SSL_CERT_PATH:   LibreSSL support.   (line   15)
* environment variable; SystemRoot:      Popen Constructor.  (line  222)
* environment variable; TCL_LIBRARY:     How do I freeze Tkinter applications?.
                                                             (line   11)
* environment variable; TEMP:            tempfile — Generate temporary files and directories.
                                                             (line  240)
* environment variable; TERM:            Functions<3>.       (line  437)
* environment variable; TERM <1>:        Functions<3>.       (line  464)
* environment variable; TK_LIBRARY:      How do I freeze Tkinter applications?.
                                                             (line   11)
* environment variable; TMP:             tempfile — Generate temporary files and directories.
                                                             (line  242)
* environment variable; TMPDIR:          tempfile — Generate temporary files and directories.
                                                             (line  238)
* environment variable; TZ:              Functions<2>.       (line  510)
* environment variable; TZ <1>:          Functions<2>.       (line  511)
* environment variable; TZ <2>:          Functions<2>.       (line  519)
* environment variable; TZ <3>:          Functions<2>.       (line  524)
* environment variable; TZ <4>:          Functions<2>.       (line  526)
* environment variable; TZ <5>:          Functions<2>.       (line  586)
* environment variable; USER:            getpass — Portable password input.
                                                             (line   38)
* environment variable; USERNAME:        Process Parameters. (line  221)
* environment variable; USERNAME <1>:    getpass — Portable password input.
                                                             (line   39)
* environment variable; USERPROFILE:     os path.            (line   14)
* environment variable; USERPROFILE <1>: Changes in the Python API.
                                                             (line  110)
* environment variable; USERPROFILE <2>: os path — Common pathname manipulations.
                                                             (line  146)
* environment variable; USERPROFILE <3>: Location and names of config files.
                                                             (line   67)
* environment variable; USER_BASE:       New and Improved Modules.
                                                             (line  469)
* environment variables; deleting:       Process Parameters. (line  498)
* environment variables; setting:        Process Parameters. (line  318)
* EnvironmentError:                      Concrete exceptions.
                                                             (line  394)
* Environments; virtual:                 venv — Creation of virtual environments.
                                                             (line   10)
* EnvironmentVarGuard (class in test.support): test support — Utilities for the Python test suite.
                                                             (line  958)
* ENXIO (in module errno):               errno — Standard errno system symbols.
                                                             (line   51)
* eof (bz2.BZ2Decompressor attribute):   Incremental de compression.
                                                             (line   72)
* eof (lzma.LZMADecompressor attribute): Compressing and decompressing data in memory.
                                                             (line  165)
* eof (shlex.shlex attribute):           shlex Objects.      (line  178)
* eof (ssl.MemoryBIO attribute):         Memory BIO Support<2>.
                                                             (line  137)
* eof (zlib.Decompress attribute):       zlib — Compression compatible with gzip.
                                                             (line  248)
* EOFError:                              Concrete exceptions.
                                                             (line   19)
* EOFError (built-in exception):         File Objects.       (line   41)
* eof_received() (asyncio.BufferedProtocol method): Buffered Streaming Protocols.
                                                             (line   42)
* eof_received() (asyncio.Protocol method): Streaming Protocols.
                                                             (line   30)
* EOPNOTSUPP (in module errno):          errno — Standard errno system symbols.
                                                             (line  407)
* EOVERFLOW (in module errno):           errno — Standard errno system symbols.
                                                             (line  327)
* EPERM (in module errno):               errno — Standard errno system symbols.
                                                             (line   26)
* EPFNOSUPPORT (in module errno):        errno — Standard errno system symbols.
                                                             (line  411)
* epilogue (email.message.EmailMessage attribute): email message Representing an email message.
                                                             (line  675)
* epilogue (email.message.Message attribute): email message Message Representing an email message using the compat32 API.
                                                             (line  675)
* EPIPE (in module errno):               errno — Standard errno system symbols.
                                                             (line  155)
* epoch:                                 time — Time access and conversions.
                                                             (line   18)
* epoll() (in module select):            select — Waiting for I/O completion.
                                                             (line   50)
* EpollSelector (class in selectors):    Classes<3>.         (line  170)
* EPROTO (in module errno):              errno — Standard errno system symbols.
                                                             (line  311)
* EPROTONOSUPPORT (in module errno):     errno — Standard errno system symbols.
                                                             (line  399)
* EPROTOTYPE (in module errno):          errno — Standard errno system symbols.
                                                             (line  391)
* eq() (in module operator):             operator — Standard operators as functions.
                                                             (line   24)
* EQEQUAL (in module token):             token — Constants used with Python parse trees.
                                                             (line  134)
* EQUAL (in module token):               token — Constants used with Python parse trees.
                                                             (line  114)
* ERA (in module locale):                locale — Internationalization services.
                                                             (line  263)
* ERANGE (in module errno):              errno — Standard errno system symbols.
                                                             (line  163)
* erase() (curses.window method):        Window Objects.     (line  218)
* erasechar() (in module curses):        Functions<3>.       (line  113)
* ERA_D_FMT (in module locale):          locale — Internationalization services.
                                                             (line  285)
* ERA_D_T_FMT (in module locale):        locale — Internationalization services.
                                                             (line  280)
* ERA_T_FMT (in module locale):          locale — Internationalization services.
                                                             (line  290)
* EREMCHG (in module errno):             errno — Standard errno system symbols.
                                                             (line  339)
* EREMOTE (in module errno):             errno — Standard errno system symbols.
                                                             (line  291)
* EREMOTEIO (in module errno):           errno — Standard errno system symbols.
                                                             (line  511)
* ERESTART (in module errno):            errno — Standard errno system symbols.
                                                             (line  367)
* erf() (in module math):                Special functions.  (line    6)
* erfc() (in module math):               Special functions.  (line   20)
* EROFS (in module errno):               errno — Standard errno system symbols.
                                                             (line  147)
* ERR (in module curses):                Constants<6>.       (line    8)
* errcheck (ctypes._FuncPtr attribute):  Foreign functions.  (line   59)
* errcode (xmlrpc.client.ProtocolError attribute): ProtocolError Objects.
                                                             (line   17)
* errmsg (xmlrpc.client.ProtocolError attribute): ProtocolError Objects.
                                                             (line   21)
* errno (module):                        errno — Standard errno system symbols.
                                                             (line    6)
* errno (OSError attribute):             Concrete exceptions.
                                                             (line  135)
* error:                                 Module Contents.    (line  353)
* error <1>:                             Functions and Exceptions.
                                                             (line    8)
* error <2>:                             copy — Shallow and deep copy operations.
                                                             (line   26)
* Error:                                 Directory and files operations.
                                                             (line  372)
* error <3>:                             dbm — Interfaces to Unix “databases”.
                                                             (line   16)
* error <4>:                             dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line   21)
* error <5>:                             dbm ndbm — Interface based on ndbm.
                                                             (line   21)
* error <6>:                             dbm dumb — Portable DBM implementation.
                                                             (line   24)
* Error <1>:                             Exceptions<4>.      (line   10)
* error <7>:                             zlib — Compression compatible with gzip.
                                                             (line   24)
* Error <2>:                             Module Contents<3>. (line  261)
* Error <3>:                             Exceptions<5>.      (line    6)
* Error <4>:                             Exceptions<6>.      (line    8)
* error <8>:                             os — Miscellaneous operating system interfaces.
                                                             (line   42)
* error <9>:                             getopt — C-style parser for command line options.
                                                             (line   85)
* error <10>:                            Functions<3>.       (line    8)
* error <11>:                            _thread — Low-level threading API.
                                                             (line   21)
* error <12>:                            Exceptions<11>.     (line    6)
* error <13>:                            select — Waiting for I/O completion.
                                                             (line   24)
* Error <5>:                             Exceptions<14>.     (line    9)
* Error <6>:                             binhex — Encode and decode binhex4 files.
                                                             (line   33)
* Error <7>:                             binascii — Convert between binary and ASCII.
                                                             (line  162)
* Error <8>:                             uu — Encode and decode uuencode files.
                                                             (line   51)
* error <14>:                            xml parsers expat — Fast XML parsing using Expat.
                                                             (line   31)
* Error <9>:                             webbrowser — Convenient Web-browser controller.
                                                             (line   44)
* error <15>:                            audioop — Manipulate raw audio data.
                                                             (line   26)
* Error <10>:                            sunau — Read and write Sun AU files.
                                                             (line   75)
* Error <11>:                            wave — Read and write WAV files.
                                                             (line   55)
* Error <12>:                            locale — Internationalization services.
                                                             (line   22)
* error <16>:                            resource — Resource usage information.
                                                             (line   17)
* error <17>:                            nis — Interface to Sun’s NIS Yellow Pages.
                                                             (line   54)
* error handling:                        Exceptions<2>.      (line    6)
* error() (argparse.ArgumentParser method): Exiting methods. (line   14)
* error() (in module logging):           Module-Level Functions.
                                                             (line  129)
* error() (logging.Logger method):       Logger Objects.     (line  224)
* error() (urllib.request.OpenerDirector method): OpenerDirector Objects.
                                                             (line   58)
* error() (xml.sax.handler.ErrorHandler method): ErrorHandler Objects.
                                                             (line   16)
* ErrorByteIndex (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  132)
* errorcode (in module errno):           errno — Standard errno system symbols.
                                                             (line   13)
* ErrorCode (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  136)
* ErrorColumnNumber (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  142)
* ErrorHandler (class in xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   38)
* ErrorLineNumber (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  146)
* errors:                                Exceptions<2>.      (line    6)
* errors (io.TextIOBase attribute):      Text I/O<2>.        (line   20)
* errors (unittest.TestLoader attribute): Loading and running tests.
                                                             (line   17)
* errors (unittest.TestResult attribute): Loading and running tests.
                                                             (line  234)
* Errors; logging:                       logging — Logging facility for Python.
                                                             (line    8)
* ErrorString() (in module xml.parsers.expat): xml parsers expat — Fast XML parsing using Expat.
                                                             (line   42)
* ERRORTOKEN (in module token):          token — Constants used with Python parse trees.
                                                             (line  252)
* error_body (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  259)
* error_content_type (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  146)
* error_headers (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  252)
* error_leader() (shlex.shlex method):   shlex Objects.      (line   69)
* error_message_format (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  138)
* error_output() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  224)
* error_perm:                            ftplib — FTP protocol client.
                                                             (line   93)
* error_proto:                           ftplib — FTP protocol client.
                                                             (line   98)
* error_proto <1>:                       poplib — POP3 protocol client.
                                                             (line   83)
* error_received() (asyncio.DatagramProtocol method): Datagram Protocols.
                                                             (line   15)
* error_reply:                           ftplib — FTP protocol client.
                                                             (line   83)
* error_status (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  246)
* error_temp:                            ftplib — FTP protocol client.
                                                             (line   88)
* escape (shlex.shlex attribute):        shlex Objects.      (line  110)
* escape sequence:                       String and Bytes literals.
                                                             (line   72)
* escape() (in module glob):             glob — Unix style pathname pattern expansion.
                                                             (line   60)
* escape() (in module html):             html — HyperText Markup Language support.
                                                             (line   12)
* escape() (in module re):               Module Contents.    (line  316)
* escape() (in module xml.sax.saxutils): xml sax saxutils — SAX Utilities.
                                                             (line   14)
* escapechar (csv.Dialect attribute):    Dialects and Formatting Parameters.
                                                             (line   35)
* escapedquotes (shlex.shlex attribute): shlex Objects.      (line  122)
* ESHUTDOWN (in module errno):           errno — Standard errno system symbols.
                                                             (line  459)
* ESOCKTNOSUPPORT (in module errno):     errno — Standard errno system symbols.
                                                             (line  403)
* ESPIPE (in module errno):              errno — Standard errno system symbols.
                                                             (line  143)
* ESRCH (in module errno):               errno — Standard errno system symbols.
                                                             (line   34)
* ESRMNT (in module errno):              errno — Standard errno system symbols.
                                                             (line  303)
* ESTALE (in module errno):              errno — Standard errno system symbols.
                                                             (line  491)
* ESTRPIPE (in module errno):            errno — Standard errno system symbols.
                                                             (line  371)
* ETIME (in module errno):               errno — Standard errno system symbols.
                                                             (line  275)
* ETIMEDOUT (in module errno):           errno — Standard errno system symbols.
                                                             (line  467)
* Etiny() (decimal.Context method):      Context objects.    (line  213)
* ETOOMANYREFS (in module errno):        errno — Standard errno system symbols.
                                                             (line  463)
* Etop() (decimal.Context method):       Context objects.    (line  219)
* ETXTBSY (in module errno):             errno — Standard errno system symbols.
                                                             (line  131)
* EUCLEAN (in module errno):             errno — Standard errno system symbols.
                                                             (line  495)
* EUNATCH (in module errno):             errno — Standard errno system symbols.
                                                             (line  223)
* EUSERS (in module errno):              errno — Standard errno system symbols.
                                                             (line  375)
* eval() (built-in function):            Built-in Functions. (line  473)
* evaluation; order:                     Evaluation order.   (line    6)
* Event (class in asyncio):              Event.              (line    6)
* Event (class in multiprocessing):      Synchronization primitives.
                                                             (line   42)
* Event (class in threading):            Event Objects.      (line   14)
* event scheduling:                      sched — Event scheduler.
                                                             (line    8)
* event() (msilib.Control method):       GUI classes.        (line   16)
* Event() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  161)
* events (selectors.SelectorKey attribute): Classes<3>.      (line   39)
* events (widgets):                      Bindings and Events.
                                                             (line    6)
* EWOULDBLOCK (in module errno):         errno — Standard errno system symbols.
                                                             (line  191)
* Example (class in doctest):            Example Objects.    (line    6)
* example (doctest.DocTestFailure attribute): Debugging.     (line  149)
* example (doctest.UnexpectedException attribute): Debugging.
                                                             (line  170)
* examples (doctest.DocTest attribute):  DocTest Objects.    (line   17)
* excel (class in csv):                  Module Contents<3>. (line  179)
* excel_tab (class in csv):              Module Contents<3>. (line  185)
* except (2to3 fixer):                   Fixers.             (line   82)
* excepthook() (in module sys):          cgitb — Traceback manager for CGI scripts.
                                                             (line   32)
* excepthook() (in module sys) <1>:      sys — System-specific parameters and functions.
                                                             (line  279)
* excepthook() (in module threading):    threading — Thread-based parallelism.
                                                             (line   36)
* exception:                             Exceptions<2>.      (line    6)
* exception <1>:                         The raise statement.
                                                             (line    6)
* Exception:                             Base classes.       (line   37)
* EXCEPTION (in module tkinter):         File Handlers.      (line   36)
* exception handler:                     Exceptions<2>.      (line    6)
* exception() (asyncio.Future method):   Future Object.      (line  114)
* exception() (asyncio.Task method):     Task Object.        (line  102)
* exception() (concurrent.futures.Future method): Future Objects.
                                                             (line   54)
* exception() (in module logging):       Module-Level Functions.
                                                             (line  139)
* exception() (logging.Logger method):   Logger Objects.     (line  239)
* exception; AssertionError:             The assert statement.
                                                             (line   21)
* exception; AttributeError:             Attribute references.
                                                             (line   10)
* exception; chaining:                   The raise statement.
                                                             (line   30)
* exception; GeneratorExit:              Generator-iterator methods.
                                                             (line   47)
* exception; GeneratorExit <1>:          Asynchronous generator-iterator methods.
                                                             (line   55)
* exception; handler:                    The standard type hierarchy.
                                                             (line  727)
* exception; ImportError:                The import statement.
                                                             (line    6)
* exception; NameError:                  Identifiers Names.  (line   10)
* exception; StopAsyncIteration:         Asynchronous generator-iterator methods.
                                                             (line   10)
* exception; StopIteration:              Generator-iterator methods.
                                                             (line   12)
* exception; StopIteration <1>:          The yield statement.
                                                             (line    6)
* exception; TypeError:                  Unary arithmetic and bitwise operations.
                                                             (line   19)
* exception; ValueError:                 Shifting operations.
                                                             (line   15)
* exception; ZeroDivisionError:          Binary arithmetic operations.
                                                             (line   28)
* exceptions; in CGI scripts:            cgitb — Traceback manager for CGI scripts.
                                                             (line    8)
* exclusive; or:                         Binary bitwise operations.
                                                             (line   15)
* exc_info (doctest.UnexpectedException attribute): Debugging.
                                                             (line  174)
* exc_info (in module sys):              The standard type hierarchy.
                                                             (line  727)
* exc_info() (in module sys):            sys — System-specific parameters and functions.
                                                             (line  320)
* exc_info() (in module sys) <1>:        Exceptions<18>.     (line   45)
* exc_msg (doctest.Example attribute):   Example Objects.    (line   31)
* exc_type (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   38)
* EXDEV (in module errno):               errno — Standard errno system symbols.
                                                             (line   99)
* exec (2to3 fixer):                     Fixers.             (line   86)
* exec() (built-in function):            Built-in Functions. (line  519)
* execfile (2to3 fixer):                 Fixers.             (line   90)
* execl() (in module os):                Process Management. (line   50)
* execle() (in module os):               Process Management. (line   50)
* execlp() (in module os):               Process Management. (line   50)
* execlpe() (in module os):              Process Management. (line   50)
* executable (in module sys):            sys — System-specific parameters and functions.
                                                             (line  359)
* executable (in module sys) <1>:        Process-wide parameters.
                                                             (line  111)
* Executable Zip Files:                  zipapp — Manage executable Python zip archives.
                                                             (line   10)
* executable_filename() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  451)
* execute() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  481)
* execute() (in module distutils.util):  distutils util — Miscellaneous other utility functions.
                                                             (line  109)
* Execute() (msilib.View method):        View Objects.       (line    6)
* execute() (sqlite3.Connection method): Connection Objects. (line   52)
* execute() (sqlite3.Cursor method):     Cursor Objects.     (line   11)
* executemany() (sqlite3.Connection method): Connection Objects.
                                                             (line   59)
* executemany() (sqlite3.Cursor method): Cursor Objects.     (line   46)
* executescript() (sqlite3.Connection method): Connection Objects.
                                                             (line   66)
* executescript() (sqlite3.Cursor method): Cursor Objects.   (line  100)
* execution model:                       Execution model.    (line    6)
* execution; frame:                      Structure of a program.
                                                             (line   16)
* execution; frame <1>:                  Class definitions.  (line    6)
* execution; stack:                      The standard type hierarchy.
                                                             (line  727)
* ExecutionLoader (class in importlib.abc): importlib abc – Abstract base classes related to import.
                                                             (line  442)
* Executor (class in concurrent.futures): Executor Objects.  (line    6)
* execv() (in module os):                Process Management. (line   50)
* execve() (in module os):               Process Management. (line   50)
* execvp() (in module os):               Process Management. (line   50)
* execvpe() (in module os):              Process Management. (line   50)
* exec_module (C function):              Multi-phase initialization.
                                                             (line  103)
* exec_module() (importlib.abc.InspectLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  429)
* exec_module() (importlib.abc.Loader method): importlib abc – Abstract base classes related to import.
                                                             (line  173)
* exec_module() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  576)
* exec_module() (importlib.machinery.ExtensionFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  322)
* exec_prefix:                           Python-related paths and files.
                                                             (line    7)
* exec_prefix <1>:                       Include Files.      (line   36)
* exec_prefix <2>:                       Include Files.      (line   47)
* EXEC_PREFIX (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   23)
* exec_prefix (in module sys):           sys — System-specific parameters and functions.
                                                             (line  342)
* ExFileSelectBox (class in tkinter.tix): File Selectors.    (line   34)
* EXFULL (in module errno):              errno — Standard errno system symbols.
                                                             (line  243)
* exists() (in module os.path):          os path — Common pathname manipulations.
                                                             (line  114)
* exists() (pathlib.Path method):        Methods<2>.         (line   57)
* exists() (tkinter.ttk.Treeview method): ttk Treeview.      (line   95)
* exists() (zipfile.Path method):        Path Objects.       (line   42)
* exit (built-in variable):              Constants added by the site module.
                                                             (line   11)
* exit():                                Process Control.    (line   17)
* exit() (argparse.ArgumentParser method): Exiting methods.  (line    6)
* exit() (in module sys):                sys — System-specific parameters and functions.
                                                             (line  366)
* exit() (in module _thread):            _thread — Low-level threading API.
                                                             (line   63)
* exitcode (multiprocessing.Process attribute): Process and exceptions.
                                                             (line  113)
* exitfunc (2to3 fixer):                 Fixers.             (line   96)
* exitonclick() (in module turtle):      Methods specific to Screen not inherited from TurtleScreen.
                                                             (line   10)
* ExitStack (class in contextlib):       Utilities.          (line  231)
* exp() (decimal.Context method):        Context objects.    (line  284)
* exp() (decimal.Decimal method):        Decimal objects.    (line  232)
* exp() (in module cmath):               Power and logarithmic functions<2>.
                                                             (line    6)
* exp() (in module math):                Power and logarithmic functions.
                                                             (line    6)
* expand() (re.Match method):            Match Objects.      (line   17)
* ExpandEnvironmentStrings() (in module winreg): Functions<11>.
                                                             (line  233)
* expandNode() (xml.dom.pulldom.DOMEventStream method): DOMEventStream Objects.
                                                             (line   21)
* expandtabs() (bytearray method):       Bytes and Bytearray Operations.
                                                             (line  414)
* expandtabs() (bytes method):           Bytes and Bytearray Operations.
                                                             (line  414)
* expandtabs() (str method):             String Methods<2>.  (line   82)
* expanduser() (in module os.path):      os path — Common pathname manipulations.
                                                             (line  135)
* expanduser() (pathlib.Path method):    Methods<2>.         (line   74)
* expandvars() (in module os.path):      os path — Common pathname manipulations.
                                                             (line  158)
* expand_tabs (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  156)
* Expat:                                 xml parsers expat — Fast XML parsing using Expat.
                                                             (line   12)
* ExpatError:                            xml parsers expat — Fast XML parsing using Expat.
                                                             (line   25)
* expect() (telnetlib.Telnet method):    Telnet Objects.     (line  121)
* expected (asyncio.IncompleteReadError attribute): Exceptions<9>.
                                                             (line   50)
* expectedFailure() (in module unittest): Skipping tests and expected failures.
                                                             (line   60)
* expectedFailures (unittest.TestResult attribute): Loading and running tests.
                                                             (line  254)
* expires (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   49)
* exploded (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   49)
* exploded (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  109)
* exploded (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  146)
* exploded (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  279)
* expm1() (in module math):              Power and logarithmic functions.
                                                             (line   12)
* expovariate() (in module random):      Real-valued distributions.
                                                             (line   38)
* expr() (in module parser):             Creating ST Objects.
                                                             (line   10)
* expression:                            Expressions.        (line    6)
* expression <1>:                        Glossary.           (line  376)
* expression; list:                      Expression lists.   (line    6)
* expression; list <1>:                  Expression statements.
                                                             (line    6)
* expression; list <2>:                  Expression statements.
                                                             (line    6)
* expression; statement:                 Expression statements.
                                                             (line    6)
* expunge() (imaplib.IMAP4 method):      IMAP4 Objects.      (line   93)
* extend() (array.array method):         array — Efficient arrays of numeric values.
                                                             (line  148)
* extend() (collections.deque method):   deque objects.      (line   59)
* extend() (sequence method):            Mutable Sequence Types.
                                                             (line   16)
* extend() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line   93)
* ExtendedContext (class in decimal):    Context objects.    (line   58)
* ExtendedInterpolation (class in configparser): Interpolation of values.
                                                             (line   40)
* EXTENDED_ARG (opcode):                 Python Bytecode Instructions.
                                                             (line  865)
* extendleft() (collections.deque method): deque objects.    (line   64)
* extend_path() (in module pkgutil):     pkgutil — Package extension utility.
                                                             (line   19)
* Extension (class in distutils.core):   distutils core — Core Distutils functionality.
                                                             (line  176)
* extension module:                      Glossary.           (line  387)
* extension; module:                     The standard type hierarchy.
                                                             (line    6)
* ExtensionFileLoader (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line  296)
* extensions_map (http.server.SimpleHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  346)
* EXTENSION_SUFFIXES (in module importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   50)
* External Data Representation:          Data stream format. (line    6)
* External Data Representation <1>:      xdrlib — Encode and decode XDR data.
                                                             (line    8)
* ExternalClashError:                    Exceptions<14>.     (line   25)
* ExternalEntityParserCreate() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line   44)
* ExternalEntityRefHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  333)
* external_attr (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line  127)
* extra (zipfile.ZipInfo attribute):     ZipInfo Objects.    (line   93)
* extract() (tarfile.TarFile method):    TarFile Objects.    (line  162)
* extract() (traceback.StackSummary class method): StackSummary Objects.
                                                             (line   13)
* extract() (zipfile.ZipFile method):    ZipFile Objects.    (line  158)
* extractall() (tarfile.TarFile method): TarFile Objects.    (line  136)
* extractall() (zipfile.ZipFile method): ZipFile Objects.    (line  185)
* ExtractError:                          tarfile — Read and write tar archive files.
                                                             (line  201)
* extractfile() (tarfile.TarFile method): TarFile Objects.   (line  190)
* extract_cookies() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   30)
* extract_stack() (in module traceback): traceback — Print or retrieve a stack traceback.
                                                             (line   96)
* extract_tb() (in module traceback):    traceback — Print or retrieve a stack traceback.
                                                             (line   83)
* extract_version (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line  107)
* extsep (in module os):                 Miscellaneous System Information.
                                                             (line  109)
* EX_CANTCREAT (in module os):           Process Management. (line  196)
* EX_CONFIG (in module os):              Process Management. (line  232)
* EX_DATAERR (in module os):             Process Management. (line  145)
* EX_IOERR (in module os):               Process Management. (line  203)
* EX_NOHOST (in module os):              Process Management. (line  164)
* EX_NOINPUT (in module os):             Process Management. (line  151)
* EX_NOPERM (in module os):              Process Management. (line  225)
* EX_NOTFOUND (in module os):            Process Management. (line  239)
* EX_NOUSER (in module os):              Process Management. (line  158)
* EX_OK (in module os):                  Process Management. (line  132)
* EX_OSERR (in module os):               Process Management. (line  182)
* EX_OSFILE (in module os):              Process Management. (line  189)
* EX_PROTOCOL (in module os):            Process Management. (line  218)
* EX_SOFTWARE (in module os):            Process Management. (line  176)
* EX_TEMPFAIL (in module os):            Process Management. (line  210)
* EX_UNAVAILABLE (in module os):         Process Management. (line  170)
* EX_USAGE (in module os):               Process Management. (line  138)
* f"; formatted string literal:          String and Bytes literals.
                                                             (line   62)
* f’; formatted string literal:          String and Bytes literals.
                                                             (line   62)
* f-string:                              String literal concatenation.
                                                             (line   24)
* f-string <1>:                          Glossary.           (line  392)
* fabs() (in module math):               Number-theoretic and representation functions.
                                                             (line   36)
* factorial() (in module math):          Number-theoretic and representation functions.
                                                             (line   40)
* factory() (importlib.util.LazyLoader class method): importlib util – Utility code for importers.
                                                             (line  255)
* fail() (unittest.TestCase method):     Test cases.         (line  639)
* failfast (unittest.TestResult attribute): Loading and running tests.
                                                             (line  285)
* failureException (unittest.TestCase attribute): Test cases.
                                                             (line  644)
* failures (unittest.TestResult attribute): Loading and running tests.
                                                             (line  240)
* FAIL_FAST (in module doctest):         Option Flags.       (line  142)
* FakePath (class in test.support):      test support — Utilities for the Python test suite.
                                                             (line 1044)
* False:                                 The standard type hierarchy.
                                                             (line   75)
* false:                                 Truth Value Testing.
                                                             (line    6)
* False <1>:                             Truth Value Testing.
                                                             (line   23)
* False <2>:                             Boolean Values.     (line   15)
* False (Built-in object):               Truth Value Testing.
                                                             (line   15)
* False (built-in variable):             Built-in Constants. (line    8)
* family (socket.socket attribute):      Socket Objects.     (line  573)
* FancyGetopt (class in distutils.fancy_getopt): distutils fancy_getopt — Wrapper around the standard getopt module.
                                                             (line   36)
* FancyURLopener (class in urllib.request): Legacy interface.
                                                             (line  144)
* fancy_getopt() (in module distutils.fancy_getopt): distutils fancy_getopt — Wrapper around the standard getopt module.
                                                             (line   20)
* fast (pickle.Pickler attribute):       Module Interface.   (line  213)
* FastChildWatcher (class in asyncio):   Process Watchers.   (line  132)
* fatalError() (xml.sax.handler.ErrorHandler method): ErrorHandler Objects.
                                                             (line   24)
* Fault (class in xmlrpc.client):        Fault Objects.      (line    6)
* faultCode (xmlrpc.client.Fault attribute): Fault Objects.  (line   11)
* faulthandler (module):                 faulthandler — Dump the Python traceback.
                                                             (line    6)
* faultString (xmlrpc.client.Fault attribute): Fault Objects.
                                                             (line   15)
* fchdir() (in module os):               Files and Directories.
                                                             (line  256)
* fchmod() (in module os):               File Descriptor Operations.
                                                             (line   97)
* fchown() (in module os):               File Descriptor Operations.
                                                             (line  105)
* FCICreate() (in module msilib):        msilib — Read and write Microsoft Installer files.
                                                             (line   26)
* fcntl (module):                        fcntl — The fcntl and ioctl system calls.
                                                             (line    6)
* fcntl() (in module fcntl):             fcntl — The fcntl and ioctl system calls.
                                                             (line   28)
* fd (selectors.SelectorKey attribute):  Classes<3>.         (line   35)
* fd() (in module turtle):               Turtle motion.      (line    6)
* fdatasync() (in module os):            File Descriptor Operations.
                                                             (line  114)
* fdopen() (in module os):               File Object Creation.
                                                             (line    9)
* fd_count() (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line  242)
* Feature (class in msilib):             Features<3>.        (line    6)
* feature_external_ges (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   76)
* feature_external_pes (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   83)
* feature_namespaces (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   48)
* feature_namespace_prefixes (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   55)
* feature_string_interning (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   62)
* feature_validation (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   69)
* feed() (email.parser.BytesFeedParser method): FeedParser API.
                                                             (line   56)
* feed() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line    8)
* feed() (xml.etree.ElementTree.XMLParser method): XMLParser Objects.
                                                             (line   27)
* feed() (xml.etree.ElementTree.XMLPullParser method): XMLPullParser Objects.
                                                             (line   18)
* feed() (xml.sax.xmlreader.IncrementalParser method): IncrementalParser Objects.
                                                             (line    9)
* FeedParser (class in email.parser):    FeedParser API.     (line   71)
* fetch() (imaplib.IMAP4 method):        IMAP4 Objects.      (line   99)
* Fetch() (msilib.View method):          View Objects.       (line   18)
* fetchall() (sqlite3.Cursor method):    Cursor Objects.     (line  162)
* fetchmany() (sqlite3.Cursor method):   Cursor Objects.     (line  142)
* fetchone() (sqlite3.Cursor method):    Cursor Objects.     (line  137)
* fflags (select.kevent attribute):      Kevent Objects.     (line   90)
* Field (class in dataclasses):          Module-level decorators classes and functions.
                                                             (line  218)
* field() (in module dataclasses):       Module-level decorators classes and functions.
                                                             (line  140)
* fieldnames (csv.csvreader attribute):  Reader Objects.     (line   30)
* fields (uuid.UUID attribute):          uuid — UUID objects according to RFC 4122.
                                                             (line   89)
* fields() (in module dataclasses):      Module-level decorators classes and functions.
                                                             (line  237)
* field_size_limit() (in module csv):    Module Contents<3>. (line   95)
* file (pyclbr.Class attribute):         Class Objects<2>.   (line    9)
* file (pyclbr.Function attribute):      Function Objects.   (line    9)
* file object:                           Glossary.           (line  398)
* file object; io module:                Overview.           (line    6)
* file object; open() built-in function: Built-in Functions. (line 1020)
* file-like object:                      Glossary.           (line  414)
* file; byte-code:                       py_compile — Compile Python source files.
                                                             (line    8)
* file; byte-code <1>:                   imp — Access the import internals.
                                                             (line   19)
* file; copying:                         shutil — High-level file operations.
                                                             (line    8)
* file; large files:                     Large File Support. (line    6)
* file; mime.types:                      mimetypes — Map filenames to MIME types.
                                                             (line  124)
* file; modes:                           Built-in Functions. (line 1042)
* filecmp (module):                      filecmp — File and Directory Comparisons.
                                                             (line    6)
* fileConfig() (in module logging.config): Configuration functions.
                                                             (line   62)
* FileCookieJar (class in http.cookiejar): http cookiejar — Cookie handling for HTTP clients.
                                                             (line   56)
* FileEntry (class in tkinter.tix):      File Selectors.     (line   50)
* FileExistsError:                       OS exceptions.      (line   61)
* FileFinder (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line  156)
* FileHandler (class in logging):        FileHandler.        (line   10)
* FileHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  416)
* FileInput (class in fileinput):        fileinput — Iterate over lines from multiple input streams.
                                                             (line  134)
* fileinput (module):                    fileinput — Iterate over lines from multiple input streams.
                                                             (line    6)
* FileIO (class in io):                  Raw File I/O.       (line    6)
* filelineno() (in module fileinput):    fileinput — Iterate over lines from multiple input streams.
                                                             (line   99)
* FileLoader (class in importlib.abc):   importlib abc – Abstract base classes related to import.
                                                             (line  461)
* filemode() (in module stat):           stat — Interpreting stat results.
                                                             (line  121)
* filename (doctest.DocTest attribute):  DocTest Objects.    (line   36)
* filename (http.cookiejar.FileCookieJar attribute): CookieJar and FileCookieJar Objects.
                                                             (line  153)
* filename (OSError attribute):          Concrete exceptions.
                                                             (line  157)
* filename (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   42)
* filename (tracemalloc.Frame attribute): Frame.             (line   13)
* filename (zipfile.ZipFile attribute):  ZipFile Objects.    (line  298)
* filename (zipfile.ZipInfo attribute):  ZipInfo Objects.    (line   50)
* filename() (in module fileinput):      fileinput — Iterate over lines from multiple input streams.
                                                             (line   81)
* filename2 (OSError attribute):         Concrete exceptions.
                                                             (line  157)
* filenames; pathname expansion:         glob — Unix style pathname pattern expansion.
                                                             (line    8)
* filenames; wildcard expansion:         fnmatch — Unix filename pattern matching.
                                                             (line    8)
* filename_only (in module tabnanny):    tabnanny — Detection of ambiguous indentation.
                                                             (line   31)
* filename_pattern (tracemalloc.Filter attribute): Filter.   (line   53)
* fileno() (http.client.HTTPResponse method): HTTPResponse Objects.
                                                             (line   36)
* fileno() (in module fileinput):        fileinput — Iterate over lines from multiple input streams.
                                                             (line   86)
* fileno() (io.IOBase method):           I/O Base Classes.   (line   63)
* fileno() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   31)
* fileno() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line   28)
* fileno() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   14)
* fileno() (select.devpoll method):      /dev/poll Polling Objects.
                                                             (line   24)
* fileno() (select.epoll method):        Edge and Level Trigger Polling epoll Objects.
                                                             (line   73)
* fileno() (select.kqueue method):       Kqueue Objects.     (line   14)
* fileno() (selectors.DevpollSelector method): Classes<3>.   (line  183)
* fileno() (selectors.EpollSelector method): Classes<3>.     (line  174)
* fileno() (selectors.KqueueSelector method): Classes<3>.    (line  194)
* fileno() (socket.socket method):       Socket Objects.     (line  110)
* fileno() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line   14)
* fileno() (telnetlib.Telnet method):    Telnet Objects.     (line   97)
* FileNotFoundError:                     OS exceptions.      (line   66)
* fileobj (selectors.SelectorKey attribute): Classes<3>.     (line   31)
* FileSelectBox (class in tkinter.tix):  File Selectors.     (line   42)
* FileType (class in argparse):          FileType objects.   (line    6)
* FileWrapper (class in wsgiref.util):   wsgiref util – WSGI environment utilities.
                                                             (line   95)
* FILE_ATTRIBUTE_ARCHIVE (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_COMPRESSED (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_DEVICE (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_DIRECTORY (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_ENCRYPTED (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_HIDDEN (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_INTEGRITY_STREAM (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_NORMAL (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_NOT_CONTENT_INDEXED (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_NO_SCRUB_DATA (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_OFFLINE (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_READONLY (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_REPARSE_POINT (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_SPARSE_FILE (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_SYSTEM (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_TEMPORARY (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* FILE_ATTRIBUTE_VIRTUAL (in module stat): stat — Interpreting stat results.
                                                             (line  394)
* file_created() (built-in function):    The Postinstallation script.
                                                             (line   23)
* file_dispatcher (class in asyncore):   asyncore — Asynchronous socket handler.
                                                             (line  254)
* file_open() (urllib.request.FileHandler method): FileHandler Objects.
                                                             (line    6)
* file_size (zipfile.ZipInfo attribute): ZipInfo Objects.    (line  143)
* file_wrapper (class in asyncore):      asyncore — Asynchronous socket handler.
                                                             (line  264)
* fill() (in module textwrap):           textwrap — Text wrapping and filling.
                                                             (line   29)
* fill() (textwrap.TextWrapper method):  textwrap — Text wrapping and filling.
                                                             (line  285)
* fillcolor() (in module turtle):        Color control.      (line   42)
* filling() (in module turtle):          Filling.            (line    6)
* filter (2to3 fixer):                   Fixers.             (line  101)
* Filter (class in logging):             Filter Objects.     (line   13)
* Filter (class in tracemalloc):         Filter.             (line    6)
* filter (select.kevent attribute):      Kevent Objects.     (line   15)
* filter() (built-in function):          Built-in Functions. (line  565)
* filter() (in module curses):           Functions<3>.       (line  120)
* filter() (in module fnmatch):          fnmatch — Unix filename pattern matching.
                                                             (line   65)
* filter() (logging.Filter method):      Filter Objects.     (line   20)
* filter() (logging.Handler method):     Handler Objects.    (line   60)
* filter() (logging.Logger method):      Logger Objects.     (line  254)
* filterfalse() (in module itertools):   Itertool functions. (line  282)
* filterwarnings() (in module warnings): Available Functions.
                                                             (line   76)
* FILTER_DIR (in module unittest.mock):  FILTER_DIR.         (line    6)
* filter_traces() (tracemalloc.Snapshot method): Snapshot.   (line   35)
* Final (in module typing):              Classes functions and decorators.
                                                             (line  769)
* final() (in module typing):            Classes functions and decorators.
                                                             (line  567)
* finalization, of objects:              Finalization and De-allocation.
                                                             (line    6)
* finalize (class in weakref):           weakref — Weak references.
                                                             (line  240)
* finalizer:                             Basic customization.
                                                             (line   56)
* finalize_options() (distutils.cmd.Command method): Creating a new Distutils command.
                                                             (line   30)
* find() (bytearray method):             Bytes and Bytearray Operations.
                                                             (line   78)
* find() (bytes method):                 Bytes and Bytearray Operations.
                                                             (line   78)
* find() (doctest.DocTestFinder method): DocTestFinder objects.
                                                             (line   32)
* find() (in module gettext):            Class-based API.    (line   14)
* find() (mmap.mmap method):             mmap — Memory-mapped file support.
                                                             (line  142)
* find() (str method):                   String Methods<2>.  (line  103)
* find() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  101)
* find() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   21)
* findall() (in module re):              Module Contents.    (line  219)
* findall() (re.Pattern method):         Regular Expression Objects.
                                                             (line   79)
* findall() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  110)
* findall() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   26)
* findCaller() (logging.Logger method):  Logger Objects.     (line  271)
* finder:                                Finders and loaders.
                                                             (line    6)
* finder <1>:                            Glossary.           (line  418)
* Finder (class in importlib.abc):       importlib abc – Abstract base classes related to import.
                                                             (line   19)
* finder; find_spec:                     The meta path.      (line    6)
* findfactor() (in module audioop):      audioop — Manipulate raw audio data.
                                                             (line   79)
* findfile() (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line  228)
* findfit() (in module audioop):         audioop — Manipulate raw audio data.
                                                             (line   88)
* finditer() (in module re):             Module Contents.    (line  231)
* finditer() (re.Pattern method):        Regular Expression Objects.
                                                             (line   85)
* findlabels() (in module dis):          Analysis functions. (line  136)
* findlinestarts() (in module dis):      Analysis functions. (line  125)
* findmatch() (in module mailcap):       mailcap — Mailcap file handling.
                                                             (line   24)
* findmax() (in module audioop):         audioop — Manipulate raw audio data.
                                                             (line   99)
* findtext() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  119)
* findtext() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   31)
* find_class() (pickle protocol):        Restricting Globals.
                                                             (line    6)
* find_class() (pickle.Unpickler method): Module Interface.  (line  285)
* find_library() (in module ctypes.util): Utility functions. (line   89)
* find_library_file() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  204)
* find_loader() (importlib.abc.PathEntryFinder method): importlib abc – Abstract base classes related to import.
                                                             (line  110)
* find_loader() (importlib.machinery.FileFinder method): importlib machinery – Importers and path hooks.
                                                             (line  193)
* find_loader() (in module importlib):   Functions<10>.      (line   40)
* find_loader() (in module pkgutil):     pkgutil — Package extension utility.
                                                             (line   76)
* find_longest_match() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line   64)
* find_module() (imp.NullImporter method): imp — Access the import internals.
                                                             (line  352)
* find_module() (importlib.abc.Finder method): importlib abc – Abstract base classes related to import.
                                                             (line   26)
* find_module() (importlib.abc.MetaPathFinder method): importlib abc – Abstract base classes related to import.
                                                             (line   58)
* find_module() (importlib.abc.PathEntryFinder method): importlib abc – Abstract base classes related to import.
                                                             (line  134)
* find_module() (importlib.machinery.PathFinder class method): importlib machinery – Importers and path hooks.
                                                             (line  135)
* find_module() (in module imp):         imp — Access the import internals.
                                                             (line   41)
* find_module() (zipimport.zipimporter method): zipimporter Objects.
                                                             (line   19)
* find_msvcrt() (in module ctypes.util): Utility functions.  (line   98)
* find_spec() (importlib.abc.MetaPathFinder method): importlib abc – Abstract base classes related to import.
                                                             (line   43)
* find_spec() (importlib.abc.PathEntryFinder method): importlib abc – Abstract base classes related to import.
                                                             (line   97)
* find_spec() (importlib.machinery.FileFinder method): importlib machinery – Importers and path hooks.
                                                             (line  186)
* find_spec() (importlib.machinery.PathFinder class method): importlib machinery – Importers and path hooks.
                                                             (line  113)
* find_spec() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line   97)
* find_unused_port() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  840)
* find_user_password() (urllib.request.HTTPPasswordMgr method): HTTPPasswordMgr Objects.
                                                             (line   16)
* find_user_password() (urllib.request.HTTPPasswordMgr method) <1>: HTTPPasswordMgrWithPriorAuth Objects.
                                                             (line   19)
* finish() (socketserver.BaseRequestHandler method): Request Handler Objects.
                                                             (line   35)
* finish_request() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  123)
* firstChild (xml.dom.Node attribute):   Node Objects.       (line   54)
* firstkey() (dbm.gnu.gdbm method):      dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line   85)
* firstweekday() (in module calendar):   calendar — General calendar-related functions.
                                                             (line  297)
* fix_missing_locations() (in module ast): ast Helpers.      (line   81)
* fix_sentence_endings (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  211)
* Flag (class in enum):                  Module Contents<2>. (line   28)
* flags (in module sys):                 sys — System-specific parameters and functions.
                                                             (line  397)
* flags (re.Pattern attribute):          Regular Expression Objects.
                                                             (line  101)
* flags (select.kevent attribute):       Kevent Objects.     (line   52)
* flag_bits (zipfile.ZipInfo attribute): ZipInfo Objects.    (line  115)
* flash() (in module curses):            Functions<3>.       (line  131)
* flatten() (email.generator.BytesGenerator method): email generator Generating MIME documents.
                                                             (line   80)
* flatten() (email.generator.Generator method): email generator Generating MIME documents.
                                                             (line  175)
* flattening; objects:                   pickle — Python object serialization.
                                                             (line    8)
* float (built-in class):                Built-in Functions. (line  582)
* floating point literal:                Numeric literals.   (line    6)
* floating point; literals:              Numeric Types — int float complex.
                                                             (line   19)
* floating point; number:                The standard type hierarchy.
                                                             (line   89)
* FloatingPointError:                    Concrete exceptions.
                                                             (line   26)
* FloatOperation (class in decimal):     Signals.            (line  100)
* float_info (in module sys):            sys — System-specific parameters and functions.
                                                             (line  467)
* float_repr_style (in module sys):      sys — System-specific parameters and functions.
                                                             (line  539)
* flock() (in module fcntl):             fcntl — The fcntl and ioctl system calls.
                                                             (line   93)
* floor division:                        Glossary.           (line  429)
* floor() (in module math):              Numeric Types — int float complex.
                                                             (line  102)
* floor() (in module math) <1>:          Number-theoretic and representation functions.
                                                             (line   45)
* floordiv() (in module operator):       operator — Standard operators as functions.
                                                             (line   88)
* flush() (bz2.BZ2Compressor method):    Incremental de compression.
                                                             (line   25)
* flush() (formatter.writer method):     The Writer Interface.
                                                             (line   13)
* flush() (io.BufferedWriter method):    Buffered Streams.   (line  121)
* flush() (io.IOBase method):            I/O Base Classes.   (line   69)
* flush() (logging.Handler method):      Handler Objects.    (line   68)
* flush() (logging.handlers.BufferingHandler method): MemoryHandler.
                                                             (line   30)
* flush() (logging.handlers.MemoryHandler method): MemoryHandler.
                                                             (line   60)
* flush() (logging.StreamHandler method): StreamHandler.     (line   25)
* flush() (lzma.LZMACompressor method):  Compressing and decompressing data in memory.
                                                             (line   91)
* flush() (mailbox.Mailbox method):      Mailbox objects.    (line  242)
* flush() (mailbox.Maildir method):      Maildir.            (line  101)
* flush() (mailbox.MH method):           MH.                 (line   99)
* flush() (mmap.mmap method):            mmap — Memory-mapped file support.
                                                             (line  152)
* flush() (zlib.Compress method):        zlib — Compression compatible with gzip.
                                                             (line  207)
* flush() (zlib.Decompress method):      zlib — Compression compatible with gzip.
                                                             (line  279)
* flushinp() (in module curses):         Functions<3>.       (line  138)
* FlushKey() (in module winreg):         Functions<11>.      (line  243)
* flush_headers() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  271)
* flush_softspace() (formatter.formatter method): The Formatter Interface.
                                                             (line   83)
* fma() (decimal.Context method):        Context objects.    (line  288)
* fma() (decimal.Decimal method):        Decimal objects.    (line  270)
* fmean() (in module statistics):        Function details.   (line   50)
* fmod() (in module math):               Number-theoretic and representation functions.
                                                             (line   51)
* FMT_BINARY (in module plistlib):       plistlib — Generate and parse Mac OS X plist files.
                                                             (line  200)
* FMT_XML (in module plistlib):          plistlib — Generate and parse Mac OS X plist files.
                                                             (line  194)
* fnmatch (module):                      fnmatch — Unix filename pattern matching.
                                                             (line    6)
* fnmatch() (in module fnmatch):         fnmatch — Unix filename pattern matching.
                                                             (line   40)
* fnmatchcase() (in module fnmatch):     fnmatch — Unix filename pattern matching.
                                                             (line   59)
* focus() (tkinter.ttk.Treeview method): ttk Treeview.       (line   99)
* fold (datetime.datetime attribute):    datetime Objects.   (line  299)
* fold (datetime.time attribute):        time Objects.       (line   71)
* fold() (email.headerregistry.BaseHeader method): email headerregistry Custom Header Objects.
                                                             (line   72)
* fold() (email.policy.Compat32 method): email policy Policy Objects.
                                                             (line  562)
* fold() (email.policy.EmailPolicy method): email policy Policy Objects.
                                                             (line  428)
* fold() (email.policy.Policy method):   email policy Policy Objects.
                                                             (line  297)
* fold_binary() (email.policy.Compat32 method): email policy Policy Objects.
                                                             (line  570)
* fold_binary() (email.policy.EmailPolicy method): email policy Policy Objects.
                                                             (line  448)
* fold_binary() (email.policy.Policy method): email policy Policy Objects.
                                                             (line  312)
* for; in comprehensions:                Displays for lists sets and dictionaries.
                                                             (line   14)
* forget() (in module test.support):     test support — Utilities for the Python test suite.
                                                             (line  162)
* forget() (tkinter.ttk.Notebook method): ttk Notebook.      (line   18)
* fork() (in module os):                 Process Management. (line  245)
* fork() (in module pty):                pty — Pseudo-terminal utilities.
                                                             (line   20)
* ForkingMixIn (class in socketserver):  Server Creation Notes.
                                                             (line   16)
* ForkingTCPServer (class in socketserver): Server Creation Notes.
                                                             (line   49)
* ForkingUDPServer (class in socketserver): Server Creation Notes.
                                                             (line   49)
* forkpty() (in module os):              Process Management. (line  262)
* Form (class in tkinter.tix):           Form Geometry Manager.
                                                             (line    9)
* format (memoryview attribute):         Memory Views.       (line  411)
* format (multiprocessing.shared_memory.ShareableList attribute): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  194)
* format (struct.Struct attribute):      Classes<2>.         (line   55)
* format() (built-in function):          Built-in Functions. (line  643)
* format() (built-in function); __str__() (object method): Basic customization.
                                                             (line  129)
* format() (in module locale):           locale — Internationalization services.
                                                             (line  406)
* format() (logging.Formatter method):   Formatter Objects.  (line   49)
* format() (logging.Handler method):     Handler Objects.    (line  102)
* format() (pprint.PrettyPrinter method): PrettyPrinter Objects.
                                                             (line   40)
* format() (str method):                 String Methods<2>.  (line  117)
* format() (string.Formatter method):    Custom String Formatting.
                                                             (line   17)
* format() (traceback.StackSummary method): StackSummary Objects.
                                                             (line   36)
* format() (traceback.TracebackException method): TracebackException Objects.
                                                             (line   73)
* format() (tracemalloc.Traceback method): Traceback.        (line   25)
* formataddr() (in module email.utils):  email utils Miscellaneous utilities.
                                                             (line   67)
* formatargspec() (in module inspect):   Classes and functions<2>.
                                                             (line   92)
* formatargvalues() (in module inspect): Classes and functions<2>.
                                                             (line  116)
* formatdate() (in module email.utils):  email utils Miscellaneous utilities.
                                                             (line  133)
* FormatError:                           Exceptions<14>.     (line   32)
* FormatError() (in module ctypes):      Utility functions.  (line  108)
* formatException() (logging.Formatter method): Formatter Objects.
                                                             (line  110)
* formatmonth() (calendar.HTMLCalendar method): calendar — General calendar-related functions.
                                                             (line  169)
* formatmonth() (calendar.TextCalendar method): calendar — General calendar-related functions.
                                                             (line  134)
* formatStack() (logging.Formatter method): Formatter Objects.
                                                             (line  118)
* formatted string literal:              String literal concatenation.
                                                             (line   24)
* Formatter (class in logging):          Formatter Objects.  (line   26)
* Formatter (class in string):           Custom String Formatting.
                                                             (line   13)
* formatter (module):                    formatter — Generic output formatting.
                                                             (line    6)
* formatTime() (logging.Formatter method): Formatter Objects.
                                                             (line   73)
* formatting, string (%):                printf-style String Formatting.
                                                             (line    6)
* formatting; bytearray (%):             printf-style Bytes Formatting.
                                                             (line    6)
* formatting; bytes (%):                 printf-style Bytes Formatting.
                                                             (line    6)
* formatwarning() (in module warnings):  Available Functions.
                                                             (line   67)
* formatyear() (calendar.HTMLCalendar method): calendar — General calendar-related functions.
                                                             (line  175)
* formatyear() (calendar.TextCalendar method): calendar — General calendar-related functions.
                                                             (line  148)
* formatyearpage() (calendar.HTMLCalendar method): calendar — General calendar-related functions.
                                                             (line  180)
* format_datetime() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line  154)
* format_exc() (in module traceback):    traceback — Print or retrieve a stack traceback.
                                                             (line  137)
* format_exception() (in module traceback): traceback — Print or retrieve a stack traceback.
                                                             (line  124)
* format_exception_only() (in module traceback): traceback — Print or retrieve a stack traceback.
                                                             (line  113)
* format_exception_only() (traceback.TracebackException method): TracebackException Objects.
                                                             (line   88)
* format_field() (string.Formatter method): Custom String Formatting.
                                                             (line  102)
* format_help() (argparse.ArgumentParser method): Printing help.
                                                             (line   30)
* format_list() (in module traceback):   traceback — Print or retrieve a stack traceback.
                                                             (line  103)
* format_map() (str method):             String Methods<2>.  (line  147)
* format_stack() (in module traceback):  traceback — Print or retrieve a stack traceback.
                                                             (line  146)
* format_stack_entry() (bdb.Bdb method): bdb — Debugger framework.
                                                             (line  344)
* format_string() (in module locale):    locale — Internationalization services.
                                                             (line  389)
* format_tb() (in module traceback):     traceback — Print or retrieve a stack traceback.
                                                             (line  142)
* format_usage() (argparse.ArgumentParser method): Printing help.
                                                             (line   25)
* FORMAT_VALUE (opcode):                 Python Bytecode Instructions.
                                                             (line  873)
* Fortran contiguous:                    shape strides suboffsets.
                                                             (line   25)
* Fortran contiguous <1>:                Glossary.           (line  266)
* forward() (in module turtle):          Turtle motion.      (line    6)
* ForwardRef (class in typing):          Classes functions and decorators.
                                                             (line  490)
* FOR_ITER (opcode):                     Python Bytecode Instructions.
                                                             (line  685)
* found_terminator() (asynchat.async_chat method): asynchat — Asynchronous socket command/response handler.
                                                             (line   89)
* fpathconf() (in module os):            File Descriptor Operations.
                                                             (line  123)
* fqdn (smtpd.SMTPChannel attribute):    SMTPChannel Objects.
                                                             (line   90)
* Fraction (class in fractions):         fractions — Rational numbers.
                                                             (line   16)
* fractions (module):                    fractions — Rational numbers.
                                                             (line    6)
* Frame (class in tracemalloc):          Frame.              (line    6)
* frame (tkinter.scrolledtext.ScrolledText attribute): tkinter scrolledtext — Scrolled Text Widget.
                                                             (line   24)
* FrameSummary (class in traceback):     FrameSummary Objects.
                                                             (line   11)
* FrameType (in module types):           Standard Interpreter Types.
                                                             (line  146)
* free():                                Overview<3>.        (line   33)
* free; variable:                        Binding of names.   (line   26)
* freefunc (C type):                     Slot Type typedefs. (line   37)
* freeze utility:                        Importing Modules<2>.
                                                             (line  262)
* freeze() (in module gc):               gc — Garbage Collector interface.
                                                             (line  160)
* freeze_support() (in module multiprocessing): Miscellaneous<3>.
                                                             (line   43)
* frexp() (in module math):              Number-theoretic and representation functions.
                                                             (line   67)
* from; import statement:                Binding of names.   (line    9)
* from; import statement <1>:            The import statement.
                                                             (line   51)
* from; yield from expression:           Yield expressions.  (line   63)
* frombuf() (tarfile.TarInfo class method): TarInfo Objects. (line   19)
* frombytes() (array.array method):      array — Efficient arrays of numeric values.
                                                             (line  156)
* fromfd() (in module socket):           Creating sockets.   (line  141)
* fromfd() (select.epoll method):        Edge and Level Trigger Polling epoll Objects.
                                                             (line   77)
* fromfd() (select.kqueue method):       Kqueue Objects.     (line   18)
* fromfile() (array.array method):       array — Efficient arrays of numeric values.
                                                             (line  165)
* fromhex() (bytearray class method):    Bytearray Objects.  (line   36)
* fromhex() (bytes class method):        Bytes Objects.      (line   62)
* fromhex() (float class method):        Additional Methods on Float.
                                                             (line   39)
* fromisocalendar() (datetime.date class method): date Objects.
                                                             (line   77)
* fromisocalendar() (datetime.datetime class method): datetime Objects.
                                                             (line  223)
* fromisoformat() (datetime.date class method): date Objects.
                                                             (line   63)
* fromisoformat() (datetime.datetime class method): datetime Objects.
                                                             (line  186)
* fromisoformat() (datetime.time class method): time Objects.
                                                             (line  113)
* fromkeys() (collections.Counter method): Counter objects.  (line  106)
* fromkeys() (dict class method):        Mapping Types — dict.
                                                             (line  138)
* fromlist() (array.array method):       array — Efficient arrays of numeric values.
                                                             (line  174)
* fromordinal() (datetime.date class method): date Objects.  (line   54)
* fromordinal() (datetime.datetime class method): datetime Objects.
                                                             (line  161)
* fromshare() (in module socket):        Creating sockets.   (line  158)
* fromstring() (array.array method):     array — Efficient arrays of numeric values.
                                                             (line  180)
* fromstring() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line   92)
* fromstringlist() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  100)
* fromtarfile() (tarfile.TarInfo class method): TarInfo Objects.
                                                             (line   26)
* fromtimestamp() (datetime.date class method): date Objects.
                                                             (line   35)
* fromtimestamp() (datetime.datetime class method): datetime Objects.
                                                             (line   93)
* fromunicode() (array.array method):    array — Efficient arrays of numeric values.
                                                             (line  186)
* fromutc() (datetime.timezone method):  timezone Objects.   (line   61)
* fromutc() (datetime.tzinfo method):    tzinfo Objects.     (line  163)
* from_address() (ctypes._CData method): Data types.         (line   42)
* from_buffer() (ctypes._CData method):  Data types.         (line   19)
* from_buffer_copy() (ctypes._CData method): Data types.     (line   31)
* from_bytes() (int class method):       Additional Methods on Integer Types.
                                                             (line   67)
* from_callable() (inspect.Signature class method): Introspecting callables with the Signature object.
                                                             (line  109)
* from_decimal() (fractions.Fraction method): fractions — Rational numbers.
                                                             (line  116)
* from_exception() (traceback.TracebackException class method): TracebackException Objects.
                                                             (line   63)
* from_file() (zipfile.ZipInfo class method): ZipInfo Objects.
                                                             (line   14)
* from_float() (decimal.Decimal method): Decimal objects.    (line  243)
* from_float() (fractions.Fraction method): fractions — Rational numbers.
                                                             (line  105)
* from_iterable() (itertools.chain class method): Itertool functions.
                                                             (line   98)
* from_list() (traceback.StackSummary class method): StackSummary Objects.
                                                             (line   29)
* from_param() (ctypes._CData method):   Data types.         (line   51)
* from_samples() (statistics.NormalDist class method): NormalDist objects.
                                                             (line   45)
* from_traceback() (dis.Bytecode class method): Bytecode analysis.
                                                             (line   33)
* FrozenImporter (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   80)
* FrozenInstanceError:                   Exceptions<17>.     (line    6)
* frozenset (built-in class):            Set Types — set frozenset.
                                                             (line   33)
* FrozenSet (class in typing):           Classes functions and decorators.
                                                             (line  233)
* fsdecode() (in module os):             Process Parameters. (line   88)
* fsencode() (in module os):             Process Parameters. (line   75)
* fspath() (in module os):               Process Parameters. (line  101)
* fstat() (in module os):                File Descriptor Operations.
                                                             (line  145)
* fstatvfs() (in module os):             File Descriptor Operations.
                                                             (line  157)
* fsum() (in module math):               Number-theoretic and representation functions.
                                                             (line   75)
* fsync() (in module os):                File Descriptor Operations.
                                                             (line  165)
* fs_is_case_insensitive() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  873)
* FS_NONASCII (in module test.support):  test support — Utilities for the Python test suite.
                                                             (line   48)
* FTP:                                   urllib request Restrictions.
                                                             (line   37)
* FTP (class in ftplib):                 ftplib — FTP protocol client.
                                                             (line   24)
* FTP; ftplib (standard module):         ftplib — FTP protocol client.
                                                             (line    8)
* FTP; protocol:                         urllib request Restrictions.
                                                             (line    6)
* FTP; protocol <1>:                     ftplib — FTP protocol client.
                                                             (line    8)
* FTPHandler (class in urllib.request):  urllib request — Extensible library for opening URLs.
                                                             (line  426)
* ftplib (module):                       ftplib — FTP protocol client.
                                                             (line    6)
* ftp_open() (urllib.request.FTPHandler method): FTPHandler Objects.
                                                             (line    6)
* FTP_TLS (class in ftplib):             ftplib — FTP protocol client.
                                                             (line   47)
* ftruncate() (in module os):            File Descriptor Operations.
                                                             (line  178)
* Full:                                  queue — A synchronized queue class.
                                                             (line   82)
* full() (asyncio.Queue method):         Queue.              (line   32)
* full() (multiprocessing.Queue method): Pipes and Queues.   (line  114)
* full() (queue.Queue method):           Queue Objects.      (line   22)
* fullmatch() (in module re):            Module Contents.    (line  167)
* fullmatch() (re.Pattern method):       Regular Expression Objects.
                                                             (line   56)
* full_url (urllib.request.Request attribute): Request Objects.
                                                             (line   11)
* func (functools.partial attribute):    partial Objects.    (line    9)
* funcattrs (2to3 fixer):                Fixers.             (line  105)
* function:                              Glossary.           (line  437)
* Function (class in symtable):          Examining Symbol Tables.
                                                             (line   66)
* function annotation:                   Glossary.           (line  445)
* function; annotations:                 Function Annotations.
                                                             (line    6)
* function; annotations <1>:             Function definitions.
                                                             (line   89)
* function; argument:                    The standard type hierarchy.
                                                             (line  262)
* function; call:                        The standard type hierarchy.
                                                             (line  262)
* function; call <1>:                    Calls.              (line  122)
* function; call <2>:                    Calls.              (line  131)
* function; definition:                  The return statement.
                                                             (line    6)
* function; definition <1>:              Function definitions.
                                                             (line    6)
* function; generator:                   The yield statement.
                                                             (line    6)
* function; name:                        Function definitions.
                                                             (line    6)
* function; name <1>:                    Function definitions.
                                                             (line    6)
* FunctionTestCase (class in unittest):  Test cases.         (line  836)
* FunctionType (in module types):        Standard Interpreter Types.
                                                             (line   19)
* function__entry (C function):          Available static markers.
                                                             (line    6)
* function__return (C function):         Available static markers.
                                                             (line   23)
* functools (module):                    functools — Higher-order functions and operations on callable objects.
                                                             (line    6)
* funny_files (filecmp.dircmp attribute): The dircmp class.  (line   95)
* future (2to3 fixer):                   Fixers.             (line  111)
* Future (class in asyncio):             Future Object.      (line    6)
* Future (class in concurrent.futures):  Future Objects.     (line   10)
* future; statement:                     Future statements.  (line    6)
* FutureWarning:                         Warnings.           (line   40)
* fwalk() (in module os):                Files and Directories.
                                                             (line 1519)
* f_back (frame attribute):              The standard type hierarchy.
                                                             (line  683)
* f_builtins (frame attribute):          The standard type hierarchy.
                                                             (line  683)
* f_code (frame attribute):              The standard type hierarchy.
                                                             (line  683)
* f_contiguous (memoryview attribute):   Memory Views.       (line  470)
* f_globals (frame attribute):           The standard type hierarchy.
                                                             (line  683)
* f_lasti (frame attribute):             The standard type hierarchy.
                                                             (line  683)
* f_lineno (frame attribute):            The standard type hierarchy.
                                                             (line  692)
* f_locals (frame attribute):            The standard type hierarchy.
                                                             (line  683)
* F_LOCK (in module os):                 File Descriptor Operations.
                                                             (line  220)
* F_OK (in module os):                   Files and Directories.
                                                             (line  106)
* F_TEST (in module os):                 File Descriptor Operations.
                                                             (line  220)
* F_TLOCK (in module os):                File Descriptor Operations.
                                                             (line  220)
* f_trace (frame attribute):             The standard type hierarchy.
                                                             (line  692)
* f_trace_lines (frame attribute):       The standard type hierarchy.
                                                             (line  692)
* f_trace_opcodes (frame attribute):     The standard type hierarchy.
                                                             (line  692)
* F_ULOCK (in module os):                File Descriptor Operations.
                                                             (line  220)
* G.722:                                 aifc — Read and write AIFF and AIFC files.
                                                             (line  160)
* gaierror:                              Exceptions<11>.     (line   27)
* gamma() (in module math):              Special functions.  (line   29)
* gammavariate() (in module random):     Real-valued distributions.
                                                             (line   46)
* garbage (in module gc):                gc — Garbage Collector interface.
                                                             (line  188)
* garbage collection:                    Objects values and types.
                                                             (line   37)
* garbage collection <1>:                Glossary.           (line  474)
* gather() (curses.textpad.Textbox method): Textbox objects. (line  109)
* gauss() (in module random):            Real-valued distributions.
                                                             (line   57)
* gc (module):                           gc — Garbage Collector interface.
                                                             (line    6)
* gcd() (in module fractions):           fractions — Rational numbers.
                                                             (line  174)
* gcd() (in module math):                Number-theoretic and representation functions.
                                                             (line   95)
* gc_collect() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  451)
* gc__done (C function):                 Available static markers.
                                                             (line   47)
* gc__start (C function):                Available static markers.
                                                             (line   41)
* ge() (in module operator):             operator — Standard operators as functions.
                                                             (line   24)
* generate_help() (distutils.fancy_getopt.FancyGetopt method): distutils fancy_getopt — Wrapper around the standard getopt module.
                                                             (line   68)
* generate_tokens() (in module tokenize): Tokenizing Input.  (line   38)
* generator:                             Glossary.           (line  483)
* generator <1>:                         Glossary.           (line  483)
* Generator (class in collections.abc):  Collections Abstract Base Classes.
                                                             (line  143)
* Generator (class in email.generator):  email generator Generating MIME documents.
                                                             (line  140)
* Generator (class in typing):           Classes functions and decorators.
                                                             (line  340)
* generator expression:                  Glossary.           (line  505)
* generator expression <1>:              Glossary.           (line  505)
* generator iterator:                    Glossary.           (line  493)
* generator; expression:                 Generator expressions.
                                                             (line    6)
* generator; function:                   The standard type hierarchy.
                                                             (line  414)
* generator; function <1>:               Yield expressions.  (line    6)
* generator; function <2>:               The yield statement.
                                                             (line    6)
* generator; iterator:                   The standard type hierarchy.
                                                             (line  414)
* generator; iterator <1>:               The yield statement.
                                                             (line    6)
* GeneratorExit:                         Concrete exceptions.
                                                             (line   30)
* GeneratorType (in module types):       Standard Interpreter Types.
                                                             (line   25)
* Generic (class in typing):             Classes functions and decorators.
                                                             (line   40)
* generic function:                      Glossary.           (line  513)
* generic; special; attribute:           The standard type hierarchy.
                                                             (line   13)
* generic_visit() (ast.NodeVisitor method): ast Helpers.     (line  136)
* genops() (in module pickletools):      Programmatic Interface<2>.
                                                             (line   22)
* gen_lib_options() (in module distutils.ccompiler): distutils ccompiler — CCompiler base class.
                                                             (line   14)
* gen_preprocess_options() (in module distutils.ccompiler): distutils ccompiler — CCompiler base class.
                                                             (line   24)
* gen_uuid() (in module msilib):         msilib — Read and write Microsoft Installer files.
                                                             (line  109)
* geometric_mean() (in module statistics): Function details. (line   64)
* get() (asyncio.Queue method):          Queue.              (line   40)
* get() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  188)
* get() (contextvars.Context method):    Manual Context Management.
                                                             (line   60)
* get() (contextvars.ContextVar method): Context Variables.  (line   30)
* get() (dict method):                   Mapping Types — dict.
                                                             (line  150)
* get() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  243)
* get() (email.message.Message method):  email message Message Representing an email message using the compat32 API.
                                                             (line  341)
* get() (in module webbrowser):          webbrowser — Convenient Web-browser controller.
                                                             (line   77)
* get() (mailbox.Mailbox method):        Mailbox objects.    (line  140)
* get() (multiprocessing.pool.AsyncResult method): Process Pools.
                                                             (line  184)
* get() (multiprocessing.Queue method):  Pipes and Queues.   (line  140)
* get() (multiprocessing.SimpleQueue method): Pipes and Queues.
                                                             (line  213)
* get() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   57)
* get() (queue.Queue method):            Queue Objects.      (line   44)
* get() (queue.SimpleQueue method):      SimpleQueue Objects.
                                                             (line   40)
* get() (tkinter.ttk.Combobox method):   ttk Combobox.       (line   15)
* get() (tkinter.ttk.Spinbox method):    ttk Spinbox.        (line    8)
* get() (types.MappingProxyType method): Standard Interpreter Types.
                                                             (line  205)
* get() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line   64)
* getacl() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  106)
* getaddresses() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line   81)
* getaddrinfo() (asyncio.loop method):   DNS.                (line    6)
* getaddrinfo() (in module socket):      Other functions<2>. (line   17)
* getallocatedblocks() (in module sys):  sys — System-specific parameters and functions.
                                                             (line  551)
* getandroidapilevel() (in module sys):  sys — System-specific parameters and functions.
                                                             (line  566)
* getannotation() (imaplib.IMAP4 method): IMAP4 Objects.     (line  111)
* getargspec() (in module inspect):      Classes and functions<2>.
                                                             (line   17)
* getargvalues() (in module inspect):    Classes and functions<2>.
                                                             (line   81)
* getatime() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  170)
* getattr() (built-in function):         Built-in Functions. (line  676)
* getattrfunc (C type):                  Slot Type typedefs. (line   53)
* getAttribute() (xml.dom.Element method): Element Objects<2>.
                                                             (line   31)
* getAttributeNode() (xml.dom.Element method): Element Objects<2>.
                                                             (line   37)
* getAttributeNodeNS() (xml.dom.Element method): Element Objects<2>.
                                                             (line   47)
* getAttributeNS() (xml.dom.Element method): Element Objects<2>.
                                                             (line   41)
* getattrofunc (C type):                 Slot Type typedefs. (line   63)
* getattr_static() (in module inspect):  Fetching attributes statically.
                                                             (line   16)
* GetBase() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line   31)
* getbegyx() (curses.window method):     Window Objects.     (line  222)
* getbkgd() (curses.window method):      Window Objects.     (line  226)
* getblocking() (socket.socket method):  Socket Objects.     (line  153)
* getboolean() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  222)
* getbuffer() (io.BytesIO method):       Buffered Streams.   (line   21)
* getbufferproc (C type):                Slot Type typedefs. (line  105)
* getByteStream() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   48)
* getcallargs() (in module inspect):     Classes and functions<2>.
                                                             (line  135)
* getcanvas() (in module turtle):        Settings and special methods.
                                                             (line   43)
* getcapabilities() (nntplib.NNTP method): Methods<3>.       (line   34)
* getcaps() (in module mailcap):         mailcap — Mailcap file handling.
                                                             (line   62)
* getch() (curses.window method):        Window Objects.     (line  231)
* getch() (in module msvcrt):            Console I/O.        (line   10)
* getCharacterStream() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   64)
* getche() (in module msvcrt):           Console I/O.        (line   25)
* getcheckinterval() (in module sys):    sys — System-specific parameters and functions.
                                                             (line  574)
* getChild() (logging.Logger method):    Logger Objects.     (line  106)
* getchildren() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  130)
* getclasstree() (in module inspect):    Classes and functions<2>.
                                                             (line    6)
* getclosurevars() (in module inspect):  Classes and functions<2>.
                                                             (line  155)
* GetColumnInfo() (msilib.View method):  View Objects.       (line   12)
* getColumnNumber() (xml.sax.xmlreader.Locator method): Locator Objects.
                                                             (line    8)
* getcomments() (in module inspect):     Retrieving source code.
                                                             (line   17)
* getcompname() (aifc.aifc method):      aifc — Read and write AIFF and AIFC files.
                                                             (line   73)
* getcompname() (sunau.AU_read method):  AU_read Objects.    (line   35)
* getcompname() (wave.Wave_read method): Wave_read Objects.  (line   35)
* getcomptype() (aifc.aifc method):      aifc — Read and write AIFF and AIFC files.
                                                             (line   67)
* getcomptype() (sunau.AU_read method):  AU_read Objects.    (line   30)
* getcomptype() (wave.Wave_read method): Wave_read Objects.  (line   31)
* getContentHandler() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   21)
* getcontext() (in module decimal):      Context objects.    (line   14)
* getcoroutinelocals() (in module inspect): Current State of Generators and Coroutines.
                                                             (line   73)
* getcoroutinestate() (in module inspect): Current State of Generators and Coroutines.
                                                             (line   28)
* getctime() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  186)
* getcwd() (in module os):               Files and Directories.
                                                             (line  265)
* getcwdb() (in module os):              Files and Directories.
                                                             (line  269)
* getcwdu (2to3 fixer):                  Fixers.             (line  115)
* getdecoder() (in module codecs):       codecs — Codec registry and base classes.
                                                             (line  107)
* getdefaultencoding() (in module sys):  sys — System-specific parameters and functions.
                                                             (line  582)
* getdefaultlocale() (in module locale): locale — Internationalization services.
                                                             (line  300)
* getdefaulttimeout() (in module socket): Other functions<2>.
                                                             (line  328)
* getdlopenflags() (in module sys):      sys — System-specific parameters and functions.
                                                             (line  587)
* getdoc() (in module inspect):          Retrieving source code.
                                                             (line    6)
* getDOMImplementation() (in module xml.dom): Module Contents<4>.
                                                             (line   17)
* getDTDHandler() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   30)
* getEffectiveLevel() (logging.Logger method): Logger Objects.
                                                             (line   97)
* getegid() (in module os):              Process Parameters. (line  163)
* getElementsByTagName() (xml.dom.Document method): Document Objects.
                                                             (line   61)
* getElementsByTagName() (xml.dom.Element method): Element Objects<2>.
                                                             (line   14)
* getElementsByTagNameNS() (xml.dom.Document method): Document Objects.
                                                             (line   66)
* getElementsByTagNameNS() (xml.dom.Element method): Element Objects<2>.
                                                             (line   18)
* getencoder() (in module codecs):       codecs — Codec registry and base classes.
                                                             (line   99)
* getEncoding() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   32)
* getEntityResolver() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   39)
* getenv() (in module os):               Process Parameters. (line  128)
* getenvb() (in module os):              Process Parameters. (line  140)
* getErrorHandler() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   50)
* geteuid() (in module os):              Process Parameters. (line  171)
* getEvent() (xml.dom.pulldom.DOMEventStream method): DOMEventStream Objects.
                                                             (line   11)
* getEventCategory() (logging.handlers.NTEventLogHandler method): NTEventLogHandler.
                                                             (line   43)
* getEventType() (logging.handlers.NTEventLogHandler method): NTEventLogHandler.
                                                             (line   49)
* getException() (xml.sax.SAXException method): SAXException Objects.
                                                             (line   13)
* getFeature() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   69)
* GetFieldCount() (msilib.Record method): Record Objects.    (line    6)
* getfile() (in module inspect):         Retrieving source code.
                                                             (line   26)
* getfilesystemencodeerrors() (in module sys): sys — System-specific parameters and functions.
                                                             (line  632)
* getfilesystemencoding() (in module sys): sys — System-specific parameters and functions.
                                                             (line  596)
* getfirst() (cgi.FieldStorage method):  Higher Level Interface.
                                                             (line   51)
* getfloat() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  215)
* getfmts() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line   80)
* getfqdn() (in module socket):          Other functions<2>. (line   67)
* getframeinfo() (in module inspect):    The interpreter stack.
                                                             (line   41)
* getframerate() (aifc.aifc method):     aifc — Read and write AIFF and AIFC files.
                                                             (line   59)
* getframerate() (sunau.AU_read method): AU_read Objects.    (line   22)
* getframerate() (wave.Wave_read method): Wave_read Objects. (line   23)
* getfullargspec() (in module inspect):  Classes and functions<2>.
                                                             (line   36)
* getgeneratorlocals() (in module inspect): Current State of Generators and Coroutines.
                                                             (line   53)
* getgeneratorstate() (in module inspect): Current State of Generators and Coroutines.
                                                             (line   12)
* getgid() (in module os):               Process Parameters. (line  177)
* getgrall() (in module grp):            grp — The group database.
                                                             (line   57)
* getgrgid() (in module grp):            grp — The group database.
                                                             (line   42)
* getgrnam() (in module grp):            grp — The group database.
                                                             (line   52)
* getgrouplist() (in module os):         Process Parameters. (line  183)
* getgroups() (in module os):            Process Parameters. (line  193)
* getheader() (http.client.HTTPResponse method): HTTPResponse Objects.
                                                             (line   24)
* getheaders() (http.client.HTTPResponse method): HTTPResponse Objects.
                                                             (line   32)
* gethostbyaddr() (in module socket):    Process Parameters. (line  468)
* gethostbyaddr() (in module socket) <1>: Other functions<2>.
                                                             (line  116)
* gethostbyname() (in module socket):    Other functions<2>. (line   77)
* gethostbyname_ex() (in module socket): Other functions<2>. (line   90)
* gethostname() (in module socket):      Process Parameters. (line  468)
* gethostname() (in module socket) <1>:  Other functions<2>. (line  105)
* getincrementaldecoder() (in module codecs): codecs — Codec registry and base classes.
                                                             (line  123)
* getincrementalencoder() (in module codecs): codecs — Codec registry and base classes.
                                                             (line  115)
* getinfo() (zipfile.ZipFile method):    ZipFile Objects.    (line   91)
* getinnerframes() (in module inspect):  The interpreter stack.
                                                             (line   58)
* GetInputContext() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line   37)
* getint() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  208)
* GetInteger() (msilib.Record method):   Record Objects.     (line   11)
* getitem() (in module operator):        operator — Standard operators as functions.
                                                             (line  192)
* getiterator() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  135)
* getiterator() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   36)
* getiterfunc (C type):                  Slot Type typedefs. (line   95)
* getitimer() (in module signal):        Module contents<2>. (line  256)
* getkey() (curses.window method):       Window Objects.     (line  246)
* GetLastError() (in module ctypes):     Utility functions.  (line  114)
* getLength() (xml.sax.xmlreader.Attributes method): The Attributes Interface.
                                                             (line   11)
* getLevelName() (in module logging):    Module-Level Functions.
                                                             (line  199)
* getline() (in module linecache):       linecache — Random access to text lines.
                                                             (line   23)
* getLineNumber() (xml.sax.xmlreader.Locator method): Locator Objects.
                                                             (line   12)
* getlist() (cgi.FieldStorage method):   Higher Level Interface.
                                                             (line   62)
* getloadavg() (in module os):           Miscellaneous System Information.
                                                             (line   48)
* getlocale() (in module locale):        locale — Internationalization services.
                                                             (line  325)
* getLogger() (in module logging):       Module-Level Functions.
                                                             (line    9)
* getLoggerClass() (in module logging):  Module-Level Functions.
                                                             (line   21)
* getlogin() (in module os):             Process Parameters. (line  216)
* getLogRecordFactory() (in module logging): Module-Level Functions.
                                                             (line   31)
* getmark() (aifc.aifc method):          aifc — Read and write AIFF and AIFC files.
                                                             (line   92)
* getmark() (sunau.AU_read method):      AU_read Objects.    (line   77)
* getmark() (wave.Wave_read method):     Wave_read Objects.  (line   62)
* getmarkers() (aifc.aifc method):       aifc — Read and write AIFF and AIFC files.
                                                             (line   85)
* getmarkers() (sunau.AU_read method):   AU_read Objects.    (line   73)
* getmarkers() (wave.Wave_read method):  Wave_read Objects.  (line   58)
* getmaxyx() (curses.window method):     Window Objects.     (line  253)
* getmember() (tarfile.TarFile method):  TarFile Objects.    (line  101)
* getmembers() (in module inspect):      Types and members.  (line  268)
* getmembers() (tarfile.TarFile method): TarFile Objects.    (line  109)
* getMessage() (logging.LogRecord method): LogRecord Objects.
                                                             (line   56)
* getMessage() (xml.sax.SAXException method): SAXException Objects.
                                                             (line    9)
* getMessageID() (logging.handlers.NTEventLogHandler method): NTEventLogHandler.
                                                             (line   60)
* getmodule() (in module inspect):       Retrieving source code.
                                                             (line   32)
* getmodulename() (in module inspect):   Types and members.  (line  281)
* getmouse() (in module curses):         Functions<3>.       (line  144)
* getmro() (in module inspect):          Classes and functions<2>.
                                                             (line  127)
* getmtime() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  177)
* getname() (chunk.Chunk method):        chunk — Read IFF chunked data.
                                                             (line   69)
* getName() (threading.Thread method):   Thread Objects.     (line  142)
* getNameByQName() (xml.sax.xmlreader.AttributesNS method): The AttributesNS Interface.
                                                             (line   16)
* getnameinfo() (asyncio.loop method):   DNS.                (line   11)
* getnameinfo() (in module socket):      Other functions<2>. (line  130)
* getnames() (tarfile.TarFile method):   TarFile Objects.    (line  115)
* getNames() (xml.sax.xmlreader.Attributes method): The Attributes Interface.
                                                             (line   15)
* getnchannels() (aifc.aifc method):     aifc — Read and write AIFF and AIFC files.
                                                             (line   51)
* getnchannels() (sunau.AU_read method): AU_read Objects.    (line   14)
* getnchannels() (wave.Wave_read method): Wave_read Objects. (line   15)
* getnframes() (aifc.aifc method):       aifc — Read and write AIFF and AIFC files.
                                                             (line   63)
* getnframes() (sunau.AU_read method):   AU_read Objects.    (line   26)
* getnframes() (wave.Wave_read method):  Wave_read Objects.  (line   27)
* getnode:                               uuid — UUID objects according to RFC 4122.
                                                             (line  173)
* getnode() (in module uuid):            uuid — UUID objects according to RFC 4122.
                                                             (line  155)
* getopt (module):                       getopt — C-style parser for command line options.
                                                             (line    6)
* getopt() (distutils.fancy_getopt.FancyGetopt method): distutils fancy_getopt — Wrapper around the standard getopt module.
                                                             (line   49)
* getopt() (in module getopt):           getopt — C-style parser for command line options.
                                                             (line   25)
* GetoptError:                           getopt — C-style parser for command line options.
                                                             (line   74)
* getouterframes() (in module inspect):  The interpreter stack.
                                                             (line   47)
* getoutput() (in module subprocess):    Legacy Shell Invocation Functions.
                                                             (line   34)
* getpagesize() (in module resource):    Resource Usage.     (line   91)
* getparams() (aifc.aifc method):        aifc — Read and write AIFF and AIFC files.
                                                             (line   79)
* getparams() (sunau.AU_read method):    AU_read Objects.    (line   41)
* getparams() (wave.Wave_read method):   Wave_read Objects.  (line   40)
* getparyx() (curses.window method):     Window Objects.     (line  257)
* getpass (module):                      getpass — Portable password input.
                                                             (line    6)
* getpass() (in module getpass):         getpass — Portable password input.
                                                             (line   12)
* GetPassWarning:                        getpass — Portable password input.
                                                             (line   29)
* getpeercert() (ssl.SSLSocket method):  SSL Sockets.        (line  139)
* getpeername() (socket.socket method):  Socket Objects.     (line  127)
* getpen() (in module turtle):           Special Turtle methods.
                                                             (line   30)
* getpgid() (in module os):              Process Parameters. (line  227)
* getpgrp() (in module os):              Process Parameters. (line  235)
* getpid() (in module os):               Process Parameters. (line  241)
* getpos() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   28)
* getppid() (in module os):              Process Parameters. (line  245)
* getpreferredencoding() (in module locale): locale — Internationalization services.
                                                             (line  336)
* getpriority() (in module os):          Process Parameters. (line  256)
* getprofile() (in module sys):          sys — System-specific parameters and functions.
                                                             (line  700)
* GetProperty() (msilib.SummaryInformation method): Summary Information Objects.
                                                             (line    6)
* getProperty() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   83)
* GetPropertyCount() (msilib.SummaryInformation method): Summary Information Objects.
                                                             (line   17)
* getprotobyname() (in module socket):   Other functions<2>. (line  148)
* getproxies() (in module urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  160)
* getPublicId() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   10)
* getPublicId() (xml.sax.xmlreader.Locator method): Locator Objects.
                                                             (line   16)
* getpwall() (in module pwd):            pwd — The password database.
                                                             (line   65)
* getpwnam() (in module pwd):            pwd — The password database.
                                                             (line   61)
* getpwuid() (in module pwd):            pwd — The password database.
                                                             (line   57)
* getQNameByName() (xml.sax.xmlreader.AttributesNS method): The AttributesNS Interface.
                                                             (line   20)
* getQNames() (xml.sax.xmlreader.AttributesNS method): The AttributesNS Interface.
                                                             (line   24)
* getquota() (imaplib.IMAP4 method):     IMAP4 Objects.      (line  116)
* getquotaroot() (imaplib.IMAP4 method): IMAP4 Objects.      (line  121)
* getrandbits() (in module random):      Bookkeeping functions.
                                                             (line   41)
* getrandom() (in module os):            Random numbers<2>.  (line    6)
* getreader() (in module codecs):        codecs — Codec registry and base classes.
                                                             (line  131)
* getrecursionlimit() (in module sys):   sys — System-specific parameters and functions.
                                                             (line  649)
* getrefcount() (in module sys):         sys — System-specific parameters and functions.
                                                             (line  643)
* getresgid() (in module os):            Process Parameters. (line  291)
* getresponse() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line   59)
* getresuid() (in module os):            Process Parameters. (line  282)
* getrlimit() (in module resource):      Resource Limits.    (line   24)
* getroot() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   41)
* getrusage() (in module resource):      Resource Usage.     (line    8)
* getsample() (in module audioop):       audioop — Manipulate raw audio data.
                                                             (line  108)
* getsampwidth() (aifc.aifc method):     aifc — Read and write AIFF and AIFC files.
                                                             (line   55)
* getsampwidth() (sunau.AU_read method): AU_read Objects.    (line   18)
* getsampwidth() (wave.Wave_read method): Wave_read Objects. (line   19)
* getscreen() (in module turtle):        Special Turtle methods.
                                                             (line   38)
* getservbyname() (in module socket):    Other functions<2>. (line  157)
* getservbyport() (in module socket):    Other functions<2>. (line  166)
* GetSetDescriptorType (in module types): Standard Interpreter Types.
                                                             (line  154)
* getshapes() (in module turtle):        Settings and special methods.
                                                             (line   50)
* getsid() (in module os):               Process Parameters. (line  429)
* getsignal() (in module signal):        Module contents<2>. (line  129)
* getsitepackages() (in module site):    Module contents<3>. (line   56)
* getsize() (chunk.Chunk method):        chunk — Read IFF chunked data.
                                                             (line   74)
* getsize() (in module os.path):         os path — Common pathname manipulations.
                                                             (line  197)
* getsizeof() (in module sys):           sys — System-specific parameters and functions.
                                                             (line  656)
* getsockname() (socket.socket method):  Socket Objects.     (line  135)
* getsockopt() (socket.socket method):   Socket Objects.     (line  141)
* getsource() (in module inspect):       Retrieving source code.
                                                             (line   55)
* getsourcefile() (in module inspect):   Retrieving source code.
                                                             (line   36)
* getsourcelines() (in module inspect):  Retrieving source code.
                                                             (line   42)
* getspall() (in module spwd):           spwd — The shadow password database.
                                                             (line   67)
* getspnam() (in module spwd):           spwd — The shadow password database.
                                                             (line   59)
* getstate() (codecs.IncrementalDecoder method): IncrementalDecoder Objects.
                                                             (line   44)
* getstate() (codecs.IncrementalEncoder method): IncrementalEncoder Objects.
                                                             (line   42)
* getstate() (in module random):         Bookkeeping functions.
                                                             (line   28)
* getstatusoutput() (in module subprocess): Legacy Shell Invocation Functions.
                                                             (line   11)
* getstr() (curses.window method):       Window Objects.     (line  263)
* GetString() (msilib.Record method):    Record Objects.     (line   16)
* getSubject() (logging.handlers.SMTPHandler method): SMTPHandler.
                                                             (line   39)
* GetSummaryInformation() (msilib.Database method): Database Objects.
                                                             (line   16)
* getswitchinterval() (in module sys):   sys — System-specific parameters and functions.
                                                             (line  678)
* getSystemId() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   18)
* getSystemId() (xml.sax.xmlreader.Locator method): Locator Objects.
                                                             (line   20)
* getsyx() (in module curses):           Functions<3>.       (line  158)
* gettarinfo() (tarfile.TarFile method): TarFile Objects.    (line  226)
* gettempdir() (in module tempfile):     tempfile — Generate temporary files and directories.
                                                             (line  229)
* gettempdirb() (in module tempfile):    tempfile — Generate temporary files and directories.
                                                             (line  257)
* gettempprefix() (in module tempfile):  tempfile — Generate temporary files and directories.
                                                             (line  263)
* gettempprefixb() (in module tempfile): tempfile — Generate temporary files and directories.
                                                             (line  268)
* getTestCaseNames() (unittest.TestLoader method): Loading and running tests.
                                                             (line  111)
* gettext (module):                      gettext — Multilingual internationalization services.
                                                             (line    6)
* gettext() (gettext.GNUTranslations method): The GNUTranslations class.
                                                             (line   38)
* gettext() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   35)
* gettext() (in module gettext):         GNU gettext API.    (line   42)
* gettext() (in module locale):          Access to message catalogs.
                                                             (line    6)
* gettimeout() (socket.socket method):   Socket Objects.     (line  162)
* gettrace() (in module sys):            sys — System-specific parameters and functions.
                                                             (line  704)
* getturtle() (in module turtle):        Special Turtle methods.
                                                             (line   30)
* getType() (xml.sax.xmlreader.Attributes method): The Attributes Interface.
                                                             (line   19)
* getuid() (in module os):               Process Parameters. (line  300)
* geturl() (urllib.parse.urllib.parse.SplitResult method): Structured Parse Results.
                                                             (line   12)
* getuser() (in module getpass):         getpass — Portable password input.
                                                             (line   34)
* getuserbase() (in module site):        Module contents<3>. (line   62)
* getusersitepackages() (in module site): Module contents<3>.
                                                             (line   70)
* getvalue() (io.BytesIO method):        Buffered Streams.   (line   38)
* getvalue() (io.StringIO method):       Text I/O<2>.        (line  212)
* getValue() (xml.sax.xmlreader.Attributes method): The Attributes Interface.
                                                             (line   24)
* getValueByQName() (xml.sax.xmlreader.AttributesNS method): The AttributesNS Interface.
                                                             (line   12)
* getwch() (in module msvcrt):           Console I/O.        (line   20)
* getwche() (in module msvcrt):          Console I/O.        (line   30)
* getweakrefcount() (in module weakref): weakref — Weak references.
                                                             (line  148)
* getweakrefs() (in module weakref):     weakref — Weak references.
                                                             (line  153)
* getwelcome() (ftplib.FTP method):      FTP Objects.        (line   42)
* getwelcome() (nntplib.NNTP method):    Methods<3>.         (line   28)
* getwelcome() (poplib.POP3 method):     POP3 Objects.       (line   20)
* getwin() (in module curses):           Functions<3>.       (line  164)
* getwindowsversion() (in module sys):   sys — System-specific parameters and functions.
                                                             (line  715)
* getwriter() (in module codecs):        codecs — Codec registry and base classes.
                                                             (line  139)
* getxattr() (in module os):             Linux extended attributes.
                                                             (line   10)
* getyx() (curses.window method):        Window Objects.     (line  274)
* GET_AITER (opcode):                    Python Bytecode Instructions.
                                                             (line  268)
* get_all() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  252)
* get_all() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  350)
* get_all() (wsgiref.headers.Headers method): wsgiref headers – WSGI response header tools.
                                                             (line   51)
* get_all_breaks() (bdb.Bdb method):     bdb — Debugger framework.
                                                             (line  332)
* get_all_start_methods() (in module multiprocessing): Miscellaneous<3>.
                                                             (line   63)
* GET_ANEXT (opcode):                    Python Bytecode Instructions.
                                                             (line  277)
* get_app() (wsgiref.simple_server.WSGIServer method): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   57)
* get_archive_formats() (in module shutil): Archiving operations.
                                                             (line   54)
* get_args() (in module typing):         Classes functions and decorators.
                                                             (line  532)
* get_asyncgen_hooks() (in module sys):  sys — System-specific parameters and functions.
                                                             (line  763)
* get_attribute() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  769)
* GET_AWAITABLE (opcode):                Python Bytecode Instructions.
                                                             (line  260)
* get_begidx() (in module readline):     Completion.         (line   40)
* get_blocking() (in module os):         File Descriptor Operations.
                                                             (line  191)
* get_body() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  489)
* get_body_encoding() (email.charset.Charset method): email charset Representing character sets.
                                                             (line   96)
* get_boundary() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  400)
* get_boundary() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  565)
* get_bpbynumber() (bdb.Bdb method):     bdb — Debugger framework.
                                                             (line  309)
* get_break() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  318)
* get_breaks() (bdb.Bdb method):         bdb — Debugger framework.
                                                             (line  322)
* get_buffer() (asyncio.BufferedProtocol method): Buffered Streaming Protocols.
                                                             (line   23)
* get_buffer() (xdrlib.Packer method):   Packer Objects.     (line    8)
* get_buffer() (xdrlib.Unpacker method): Unpacker Objects.   (line   22)
* get_bytes() (mailbox.Mailbox method):  Mailbox objects.    (line  159)
* get_cache_token() (in module abc):     abc — Abstract Base Classes.
                                                             (line  230)
* get_ca_certs() (ssl.SSLContext method): SSL Contexts.      (line  156)
* get_channel_binding() (ssl.SSLSocket method): SSL Sockets. (line  221)
* get_charset() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  255)
* get_charsets() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  428)
* get_charsets() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  599)
* get_children() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   62)
* get_children() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line   19)
* get_child_watcher() (asyncio.AbstractEventLoopPolicy method): Policy Objects.
                                                             (line   33)
* get_child_watcher() (in module asyncio): Process Watchers. (line   25)
* get_ciphers() (ssl.SSLContext method): SSL Contexts.       (line  170)
* get_clock_info() (in module time):     Functions<2>.       (line   97)
* get_close_matches() (in module difflib): difflib — Helpers for computing deltas.
                                                             (line  204)
* get_code() (importlib.abc.InspectLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  377)
* get_code() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  571)
* get_code() (importlib.machinery.ExtensionFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  334)
* get_code() (importlib.machinery.SourcelessFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  277)
* get_code() (zipimport.zipimporter method): zipimporter Objects.
                                                             (line   28)
* get_completer() (in module readline):  Completion.         (line   29)
* get_completer_delims() (in module readline): Completion.   (line   48)
* get_completion_type() (in module readline): Completion.    (line   34)
* get_config_h_filename() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   41)
* get_config_h_filename() (in module sysconfig): Other functions<3>.
                                                             (line   68)
* get_config_var() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   27)
* get_config_var() (in module sysconfig): Configuration variables.
                                                             (line   26)
* get_config_vars() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   32)
* get_config_vars() (in module sysconfig): Configuration variables.
                                                             (line   16)
* get_content() (email.contentmanager.ContentManager method): email contentmanager Managing MIME Content.
                                                             (line   19)
* get_content() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  553)
* get_content() (in module email.contentmanager): Content Manager Instances.
                                                             (line   24)
* get_content_charset() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  421)
* get_content_charset() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  588)
* get_content_disposition() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  452)
* get_content_disposition() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  613)
* get_content_maintype() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  321)
* get_content_maintype() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  419)
* get_content_subtype() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  327)
* get_content_subtype() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  425)
* get_content_type() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  305)
* get_content_type() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  403)
* get_context() (in module multiprocessing): Miscellaneous<3>.
                                                             (line   73)
* get_coro() (asyncio.Task method):      Task Object.        (line  172)
* get_coroutine_origin_tracking_depth() (in module sys): sys — System-specific parameters and functions.
                                                             (line  777)
* get_count() (in module gc):            gc — Garbage Collector interface.
                                                             (line  106)
* get_current_history_length() (in module readline): History list.
                                                             (line   14)
* get_data() (importlib.abc.FileLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  493)
* get_data() (importlib.abc.ResourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  358)
* get_data() (in module pkgutil):        pkgutil — Package extension utility.
                                                             (line  196)
* get_data() (zipimport.zipimporter method): zipimporter Objects.
                                                             (line   33)
* get_date() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   92)
* get_debug() (asyncio.loop method):     Enabling debug mode.
                                                             (line    6)
* get_debug() (in module gc):            gc — Garbage Collector interface.
                                                             (line   55)
* get_default() (argparse.ArgumentParser method): Parser defaults.
                                                             (line   25)
* get_default_compiler() (in module distutils.ccompiler): distutils ccompiler — CCompiler base class.
                                                             (line   36)
* get_default_domain() (in module nis):  nis — Interface to Sun’s NIS Yellow Pages.
                                                             (line   48)
* get_default_type() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  332)
* get_default_type() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  430)
* get_default_verify_paths() (in module ssl): Certificate handling.
                                                             (line   89)
* get_dialect() (in module csv):         Module Contents<3>. (line   85)
* get_docstring() (in module ast):       ast Helpers.        (line   61)
* get_doctest() (doctest.DocTestParser method): DocTestParser objects.
                                                             (line   13)
* get_endidx() (in module readline):     Completion.         (line   40)
* get_environ() (wsgiref.simple_server.WSGIRequestHandler method): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   79)
* get_errno() (in module ctypes):        Utility functions.  (line  121)
* get_event_loop() (asyncio.AbstractEventLoopPolicy method): Policy Objects.
                                                             (line   12)
* get_event_loop() (in module asyncio):  Event Loop.         (line   39)
* get_event_loop_policy() (in module asyncio): Getting and Setting the Policy.
                                                             (line    9)
* get_examples() (doctest.DocTestParser method): DocTestParser objects.
                                                             (line   22)
* get_exception_handler() (asyncio.loop method): Error Handling API.
                                                             (line   19)
* get_exec_path() (in module os):        Process Parameters. (line  153)
* get_extra_info() (asyncio.BaseTransport method): Base Transport.
                                                             (line   20)
* get_extra_info() (asyncio.StreamWriter method): StreamWriter.
                                                             (line   58)
* get_field() (string.Formatter method): Custom String Formatting.
                                                             (line   55)
* get_file() (mailbox.Babyl method):     Babyl.              (line   49)
* get_file() (mailbox.Mailbox method):   Mailbox objects.    (line  175)
* get_file() (mailbox.Maildir method):   Maildir.            (line  118)
* get_file() (mailbox.mbox method):      mbox.               (line   33)
* get_file() (mailbox.MH method):        MH.                 (line   93)
* get_file() (mailbox.MMDF method):      MMDF.               (line   29)
* get_filename() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  390)
* get_filename() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  555)
* get_filename() (importlib.abc.ExecutionLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  448)
* get_filename() (importlib.abc.FileLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  489)
* get_filename() (importlib.machinery.ExtensionFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  342)
* get_filename() (zipimport.zipimporter method): zipimporter Objects.
                                                             (line   41)
* get_file_breaks() (bdb.Bdb method):    bdb — Debugger framework.
                                                             (line  327)
* get_flags() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   63)
* get_flags() (mailbox.mboxMessage method): mboxMessage.     (line   64)
* get_flags() (mailbox.MMDFMessage method): MMDFMessage.     (line   63)
* get_folder() (mailbox.Maildir method): Maildir.            (line   64)
* get_folder() (mailbox.MH method):      MH.                 (line   36)
* get_frees() (symtable.Function method): Examining Symbol Tables.
                                                             (line   88)
* get_freeze_count() (in module gc):     gc — Garbage Collector interface.
                                                             (line  179)
* get_from() (mailbox.mboxMessage method): mboxMessage.      (line   47)
* get_from() (mailbox.MMDFMessage method): MMDFMessage.      (line   46)
* get_full_url() (urllib.request.Request method): Request Objects.
                                                             (line  106)
* get_globals() (symtable.Function method): Examining Symbol Tables.
                                                             (line   80)
* get_grouped_opcodes() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line  166)
* get_handle_inheritable() (in module os): Inheritance of File Descriptors.
                                                             (line   32)
* get_header() (urllib.request.Request method): Request Objects.
                                                             (line  120)
* get_history_item() (in module readline): History list.     (line   20)
* get_history_length() (in module readline): History file.   (line   30)
* get_id() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   15)
* get_ident() (in module threading):     threading — Thread-based parallelism.
                                                             (line   75)
* get_ident() (in module _thread):       _thread — Low-level threading API.
                                                             (line   73)
* get_identifiers() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   48)
* get_importer() (in module pkgutil):    pkgutil — Package extension utility.
                                                             (line   91)
* get_info() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line  102)
* get_inheritable() (in module os):      Inheritance of File Descriptors.
                                                             (line   23)
* get_inheritable() (socket.socket method): Socket Objects.  (line  119)
* get_instructions() (in module dis):    Analysis functions. (line  110)
* get_interpreter() (in module zipapp):  Python API.         (line   82)
* GET_ITER (opcode):                     Python Bytecode Instructions.
                                                             (line  113)
* get_key() (selectors.BaseSelector method): Classes<3>.     (line  140)
* get_labels() (mailbox.Babyl method):   Babyl.              (line   35)
* get_labels() (mailbox.BabylMessage method): BabylMessage.  (line   47)
* get_last_error() (in module ctypes):   Utility functions.  (line  129)
* get_lineno() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   26)
* get_line_buffer() (in module readline): Line buffer.       (line    8)
* get_loader() (in module pkgutil):      pkgutil — Package extension utility.
                                                             (line  105)
* get_locals() (symtable.Function method): Examining Symbol Tables.
                                                             (line   76)
* get_logger() (in module multiprocessing): Logging<2>.      (line   11)
* get_loop() (asyncio.Future method):    Future Object.      (line  127)
* get_loop() (asyncio.Server method):    Server Objects.     (line   36)
* get_magic() (in module imp):           imp — Access the import internals.
                                                             (line   17)
* get_makefile_filename() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   49)
* get_makefile_filename() (in module sysconfig): Other functions<3>.
                                                             (line   72)
* get_map() (selectors.BaseSelector method): Classes<3>.     (line  148)
* get_matching_blocks() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line  105)
* get_message() (mailbox.Mailbox method): Mailbox objects.   (line  152)
* get_method() (urllib.request.Request method): Request Objects.
                                                             (line   69)
* get_methods() (symtable.Class method): Examining Symbol Tables.
                                                             (line   98)
* get_mixed_type_key() (in module ipaddress): Other Module Level Functions.
                                                             (line   47)
* get_name() (asyncio.Task method):      Task Object.        (line  178)
* get_name() (symtable.Symbol method):   Examining Symbol Tables.
                                                             (line  108)
* get_name() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   19)
* get_namespace() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  171)
* get_namespaces() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  167)
* get_native_id() (in module threading): threading — Thread-based parallelism.
                                                             (line   85)
* get_native_id() (in module _thread):   _thread — Low-level threading API.
                                                             (line   81)
* get_nonlocals() (symtable.Function method): Examining Symbol Tables.
                                                             (line   84)
* get_nonstandard_attr() (http.cookiejar.Cookie method): Cookie Objects<2>.
                                                             (line   98)
* get_nowait() (asyncio.Queue method):   Queue.              (line   45)
* get_nowait() (multiprocessing.Queue method): Pipes and Queues.
                                                             (line  155)
* get_nowait() (queue.Queue method):     Queue Objects.      (line   61)
* get_nowait() (queue.SimpleQueue method): SimpleQueue Objects.
                                                             (line   51)
* get_objects() (in module gc):          gc — Garbage Collector interface.
                                                             (line   59)
* get_object_traceback() (in module tracemalloc): Functions<9>.
                                                             (line   12)
* get_opcodes() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line  123)
* get_option() (optparse.OptionParser method): Querying and manipulating your option parser.
                                                             (line   37)
* get_option_group() (optparse.OptionParser method): Grouping Options.
                                                             (line   52)
* get_option_order() (distutils.fancy_getopt.FancyGetopt method): distutils fancy_getopt — Wrapper around the standard getopt module.
                                                             (line   62)
* get_origin() (in module typing):       Classes functions and decorators.
                                                             (line  530)
* get_original_stdout() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  367)
* get_osfhandle() (in module msvcrt):    File Operations.    (line   49)
* get_output_charset() (email.charset.Charset method): email charset Representing character sets.
                                                             (line  111)
* get_param() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  465)
* get_parameters() (symtable.Function method): Examining Symbol Tables.
                                                             (line   71)
* get_params() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  444)
* get_path() (in module sysconfig):      Installation paths. (line   67)
* get_paths() (in module sysconfig):     Installation paths. (line   97)
* get_path_names() (in module sysconfig): Installation paths.
                                                             (line   62)
* get_payload() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  170)
* get_pid() (asyncio.SubprocessTransport method): Subprocess Transports.
                                                             (line    6)
* get_pipe_transport() (asyncio.SubprocessTransport method): Subprocess Transports.
                                                             (line   10)
* get_platform() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line    9)
* get_platform() (in module sysconfig):  Other functions<3>. (line   11)
* get_poly() (in module turtle):         Special Turtle methods.
                                                             (line   17)
* get_position() (xdrlib.Unpacker method): Unpacker Objects. (line   12)
* get_protocol() (asyncio.BaseTransport method): Base Transport.
                                                             (line   85)
* get_python_inc() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   57)
* get_python_lib() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   68)
* get_python_version() (in module sysconfig): Other functions<3>.
                                                             (line    6)
* get_recsrc() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   81)
* get_referents() (in module gc):        gc — Garbage Collector interface.
                                                             (line  134)
* get_referrers() (in module gc):        gc — Garbage Collector interface.
                                                             (line  116)
* get_request() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  129)
* get_returncode() (asyncio.SubprocessTransport method): Subprocess Transports.
                                                             (line   29)
* get_running_loop() (in module asyncio): Event Loop.        (line   29)
* get_scheme() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  187)
* get_scheme_names() (in module sysconfig): Installation paths.
                                                             (line   57)
* get_sequences() (mailbox.MH method):   MH.                 (line   53)
* get_sequences() (mailbox.MHMessage method): MHMessage.     (line   32)
* get_server() (multiprocessing.managers.BaseManager method): Managers.
                                                             (line   46)
* get_server_certificate() (in module ssl): Certificate handling.
                                                             (line   59)
* get_shapepoly() (in module turtle):    Appearance.         (line  147)
* get_socket() (telnetlib.Telnet method): Telnet Objects.    (line   93)
* get_source() (importlib.abc.InspectLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  391)
* get_source() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  589)
* get_source() (importlib.machinery.ExtensionFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  338)
* get_source() (importlib.machinery.SourcelessFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  282)
* get_source() (zipimport.zipimporter method): zipimporter Objects.
                                                             (line   49)
* get_source_segment() (in module ast):  ast Helpers.        (line   70)
* get_special_folder_path() (built-in function): The Postinstallation script.
                                                             (line   32)
* get_stack() (asyncio.Task method):     Task Object.        (line  136)
* get_stack() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  339)
* get_starttag_text() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   32)
* get_start_method() (in module multiprocessing): Miscellaneous<3>.
                                                             (line   85)
* get_stats() (in module gc):            gc — Garbage Collector interface.
                                                             (line   67)
* get_stderr() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  127)
* get_stderr() (wsgiref.simple_server.WSGIRequestHandler method): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   89)
* get_stdin() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  122)
* get_string() (mailbox.Mailbox method): Mailbox objects.    (line  167)
* get_subdir() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   47)
* get_suffixes() (in module imp):        imp — Access the import internals.
                                                             (line   26)
* get_symbols() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   57)
* get_tag() (in module imp):             imp — Access the import internals.
                                                             (line  241)
* get_task_factory() (asyncio.loop method): Creating Futures and Tasks.
                                                             (line   42)
* get_terminal_size() (in module os):    Querying the size of a terminal.
                                                             (line    8)
* get_terminal_size() (in module shutil): Querying the size of the output terminal.
                                                             (line    6)
* get_terminator() (asynchat.async_chat method): asynchat — Asynchronous socket command/response handler.
                                                             (line   97)
* get_threshold() (in module gc):        gc — Garbage Collector interface.
                                                             (line  111)
* get_token() (shlex.shlex method):      shlex Objects.      (line    8)
* get_traceback_limit() (in module tracemalloc): Functions<9>.
                                                             (line   22)
* get_traced_memory() (in module tracemalloc): Functions<9>. (line   32)
* get_tracemalloc_memory() (in module tracemalloc): Functions<9>.
                                                             (line   38)
* get_type() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   10)
* get_type_hints() (in module typing):   Classes functions and decorators.
                                                             (line  517)
* get_unixfrom() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  152)
* get_unixfrom() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  152)
* get_unpack_formats() (in module shutil): Archiving operations.
                                                             (line  141)
* get_usage() (optparse.OptionParser method): Other methods. (line   22)
* get_value() (string.Formatter method): Custom String Formatting.
                                                             (line   65)
* get_version() (optparse.OptionParser method): Printing a version string.
                                                             (line   33)
* get_visible() (mailbox.BabylMessage method): BabylMessage. (line   63)
* get_wch() (curses.window method):      Window Objects.     (line  238)
* get_write_buffer_limits() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line   23)
* get_write_buffer_size() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line   19)
* GET_YIELD_FROM_ITER (opcode):          Python Bytecode Instructions.
                                                             (line  117)
* gid (tarfile.TarInfo attribute):       TarInfo Objects.    (line   76)
* GIL:                                   Glossary.           (line  521)
* glob (module):                         glob — Unix style pathname pattern expansion.
                                                             (line    6)
* glob() (in module glob):               glob — Unix style pathname pattern expansion.
                                                             (line   29)
* glob() (msilib.Directory method):      Directory Objects.  (line   39)
* glob() (pathlib.Path method):          Methods<2>.         (line   85)
* global interpreter lock:               Thread State and the Global Interpreter Lock.
                                                             (line    6)
* global interpreter lock <1>:           Glossary.           (line  525)
* global; name; binding:                 The global statement.
                                                             (line    6)
* global; namespace:                     The standard type hierarchy.
                                                             (line  274)
* globals() (built-in function):         Built-in Functions. (line  685)
* globs (doctest.DocTest attribute):     DocTest Objects.    (line   22)
* gmtime() (in module time):             Functions<2>.       (line  133)
* gname (tarfile.TarInfo attribute):     TarInfo Objects.    (line   84)
* GNOME:                                 The Catalog constructor.
                                                             (line    6)
* GNUTranslations (class in gettext):    The GNUTranslations class.
                                                             (line   33)
* GNU_FORMAT (in module tarfile):        tarfile — Read and write tar archive files.
                                                             (line  226)
* gnu_getopt() (in module getopt):       getopt — C-style parser for command line options.
                                                             (line   62)
* got (doctest.DocTestFailure attribute): Debugging.         (line  153)
* goto() (in module turtle):             Turtle motion.      (line   55)
* grammar:                               Notation.           (line    6)
* Graphical User Interface:              Graphical User Interfaces with Tk.
                                                             (line    6)
* GREATER (in module token):             token — Constants used with Python parse trees.
                                                             (line  110)
* GREATEREQUAL (in module token):        token — Constants used with Python parse trees.
                                                             (line  146)
* Greenwich Mean Time:                   time — Time access and conversions.
                                                             (line   40)
* GRND_NONBLOCK (in module os):          Random numbers<2>.  (line   73)
* GRND_RANDOM (in module os):            Random numbers<2>.  (line   86)
* Group (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  455)
* group() (nntplib.NNTP method):         Methods<3>.         (line  147)
* group() (pathlib.Path method):         Methods<2>.         (line  108)
* group() (re.Match method):             Match Objects.      (line   29)
* groupby() (in module itertools):       Itertool functions. (line  296)
* groupdict() (re.Match method):         Match Objects.      (line  121)
* groupindex (re.Pattern attribute):     Regular Expression Objects.
                                                             (line  112)
* grouping:                              Indentation.        (line    6)
* groups (email.headerregistry.AddressHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  186)
* groups (re.Pattern attribute):         Regular Expression Objects.
                                                             (line  108)
* groups() (re.Match method):            Match Objects.      (line   98)
* grp (module):                          grp — The group database.
                                                             (line    6)
* gt() (in module operator):             operator — Standard operators as functions.
                                                             (line   24)
* guess_all_extensions() (in module mimetypes): mimetypes — Map filenames to MIME types.
                                                             (line   51)
* guess_all_extensions() (mimetypes.MimeTypes method): MimeTypes Objects.
                                                             (line   65)
* guess_extension() (in module mimetypes): mimetypes — Map filenames to MIME types.
                                                             (line   63)
* guess_extension() (mimetypes.MimeTypes method): MimeTypes Objects.
                                                             (line   55)
* guess_scheme() (in module wsgiref.util): wsgiref util – WSGI environment utilities.
                                                             (line   12)
* guess_type() (in module mimetypes):    mimetypes — Map filenames to MIME types.
                                                             (line   24)
* guess_type() (mimetypes.MimeTypes method): MimeTypes Objects.
                                                             (line   60)
* GUI:                                   Graphical User Interfaces with Tk.
                                                             (line    6)
* gzip (module):                         gzip — Support for gzip files.
                                                             (line    6)
* gzip command line option; –best:       Command line options.
                                                             (line   14)
* gzip command line option; -d, –decompress: Command line options.
                                                             (line   18)
* gzip command line option; –fast:       Command line options.
                                                             (line   10)
* gzip command line option; -h, –help:   Command line options.
                                                             (line   22)
* gzip command line option; file:        Command line options.
                                                             (line    6)
* GzipFile (class in gzip):              gzip — Support for gzip files.
                                                             (line   71)
* halfdelay() (in module curses):        Functions<3>.       (line  194)
* Handle (class in asyncio):             Callback Handles.   (line    6)
* handle an exception:                   Exceptions<2>.      (line    6)
* handle() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  179)
* handle() (logging.Handler method):     Handler Objects.    (line   81)
* handle() (logging.handlers.QueueListener method): QueueListener.
                                                             (line   63)
* handle() (logging.Logger method):      Logger Objects.     (line  286)
* handle() (logging.NullHandler method): NullHandler.        (line   20)
* handle() (socketserver.BaseRequestHandler method): Request Handler Objects.
                                                             (line   20)
* handle() (wsgiref.simple_server.WSGIRequestHandler method): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   94)
* handleError() (logging.Handler method): Handler Objects.   (line   88)
* handleError() (logging.handlers.SocketHandler method): SocketHandler.
                                                             (line   33)
* Handler (class in logging):            Handler Objects.    (line   11)
* handler() (in module cgitb):           cgitb — Traceback manager for CGI scripts.
                                                             (line   65)
* handle_accept() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  141)
* handle_accepted() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  151)
* handle_charref() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   93)
* handle_close() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  132)
* handle_comment() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line  102)
* handle_connect() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  126)
* handle_data() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   80)
* handle_decl() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line  115)
* handle_defect() (email.policy.Policy method): email policy Policy Objects.
                                                             (line  196)
* handle_endtag() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   64)
* handle_entityref() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   86)
* handle_error() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  136)
* handle_error() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  135)
* handle_expect_100() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  192)
* handle_expt() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  120)
* handle_one_request() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  186)
* handle_pi() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line  123)
* handle_read() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  107)
* handle_request() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line   21)
* handle_request() (xmlrpc.server.CGIXMLRPCRequestHandler method): CGIXMLRPCRequestHandler.
                                                             (line   50)
* handle_startendtag() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   71)
* handle_starttag() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   45)
* handle_timeout() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  145)
* handle_write() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  112)
* harmonic_mean() (in module statistics): Function details.  (line   84)
* hasattr() (built-in function):         Built-in Functions. (line  692)
* hasAttribute() (xml.dom.Element method): Element Objects<2>.
                                                             (line   22)
* hasAttributeNS() (xml.dom.Element method): Element Objects<2>.
                                                             (line   26)
* hasAttributes() (xml.dom.Node method): Node Objects.       (line   94)
* hasChildNodes() (xml.dom.Node method): Node Objects.       (line   98)
* hascompare (in module dis):            Opcode collections. (line   49)
* hasconst (in module dis):              Opcode collections. (line   21)
* hasFeature() (xml.dom.DOMImplementation method): DOMImplementation Objects.
                                                             (line   11)
* hasfree (in module dis):               Opcode collections. (line   25)
* hash character:                        Comments.           (line    6)
* hash() (built-in function):            Built-in Functions. (line  699)
* hash-based pyc:                        Glossary.           (line  548)
* hash.block_size (in module hashlib):   Hash algorithms.    (line   99)
* hash.digest_size (in module hashlib):  Hash algorithms.    (line   95)
* hashable:                              Dictionary displays.
                                                             (line   37)
* hashable <1>:                          Glossary.           (line  554)
* Hashable (class in collections.abc):   Collections Abstract Base Classes.
                                                             (line  104)
* Hashable (class in typing):            Classes functions and decorators.
                                                             (line  157)
* hasHandlers() (logging.Logger method): Logger Objects.     (line  301)
* hashfunc (C type):                     Slot Type typedefs. (line   87)
* hashlib (module):                      hashlib — Secure hashes and message digests.
                                                             (line    6)
* hash_info (in module sys):             sys — System-specific parameters and functions.
                                                             (line  787)
* hasjabs (in module dis):               Opcode collections. (line   41)
* hasjrel (in module dis):               Opcode collections. (line   37)
* haslocal (in module dis):              Opcode collections. (line   45)
* hasname (in module dis):               Opcode collections. (line   33)
* HAS_ALPN (in module ssl):              Constants<9>.       (line  350)
* has_children() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   39)
* has_colors() (in module curses):       Functions<3>.       (line  170)
* has_dualstack_ipv6() (in module socket): Creating sockets. (line  134)
* HAS_ECDH (in module ssl):              Constants<9>.       (line  366)
* has_exec() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   44)
* has_extn() (smtplib.SMTP method):      SMTP Objects.       (line   85)
* has_function() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  212)
* has_header() (csv.Sniffer method):     Module Contents<3>. (line  214)
* has_header() (urllib.request.Request method): Request Objects.
                                                             (line   94)
* has_ic() (in module curses):           Functions<3>.       (line  175)
* has_il() (in module curses):           Functions<3>.       (line  182)
* has_ipv6 (in module socket):           Constants<8>.       (line  213)
* has_key (2to3 fixer):                  Fixers.             (line  119)
* has_key() (in module curses):          Functions<3>.       (line  189)
* has_location (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  412)
* HAS_NEVER_CHECK_COMMON_NAME (in module ssl): Constants<9>. (line  358)
* has_nonstandard_attr() (http.cookiejar.Cookie method): Cookie Objects<2>.
                                                             (line   94)
* HAS_NPN (in module ssl):               Constants<9>.       (line  381)
* has_option() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  106)
* has_option() (optparse.OptionParser method): Querying and manipulating your option parser.
                                                             (line   42)
* has_section() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line   97)
* HAS_SNI (in module ssl):               Constants<9>.       (line  374)
* HAS_SSLv2 (in module ssl):             Constants<9>.       (line  391)
* HAS_SSLv3 (in module ssl):             Constants<9>.       (line  398)
* has_ticket (ssl.SSLSession attribute): SSL session.        (line   20)
* HAS_TLSv1 (in module ssl):             Constants<9>.       (line  405)
* HAS_TLSv1_1 (in module ssl):           Constants<9>.       (line  412)
* HAS_TLSv1_2 (in module ssl):           Constants<9>.       (line  419)
* HAS_TLSv1_3 (in module ssl):           Constants<9>.       (line  426)
* HAVE_ARGUMENT (opcode):                Python Bytecode Instructions.
                                                             (line  898)
* HAVE_DOCSTRINGS (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  137)
* HAVE_THREADS (in module decimal):      Constants<4>.       (line   25)
* HCI_DATA_DIR (in module socket):       Constants<8>.       (line  226)
* HCI_FILTER (in module socket):         Constants<8>.       (line  226)
* HCI_TIME_STAMP (in module socket):     Constants<8>.       (line  226)
* head() (nntplib.NNTP method):          Methods<3>.         (line  230)
* Header (class in email.header):        email header Internationalized headers.
                                                             (line   54)
* HeaderError:                           tarfile — Read and write tar archive files.
                                                             (line  206)
* HeaderParseError:                      email errors Exception and Defect classes.
                                                             (line   26)
* HeaderParser (class in email.parser):  Parser API.         (line  106)
* HeaderRegistry (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  297)
* Headers (class in wsgiref.headers):    wsgiref headers – WSGI response header tools.
                                                             (line    9)
* headers (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   98)
* headers (urllib.error.HTTPError attribute): urllib error — Exception classes raised by urllib request.
                                                             (line   49)
* headers (xmlrpc.client.ProtocolError attribute): ProtocolError Objects.
                                                             (line   25)
* header_encode() (email.charset.Charset method): email charset Representing character sets.
                                                             (line  118)
* header_encode_lines() (email.charset.Charset method): email charset Representing character sets.
                                                             (line  125)
* header_encoding (email.charset.Charset attribute): email charset Representing character sets.
                                                             (line   59)
* header_factory (email.policy.EmailPolicy attribute): email policy Policy Objects.
                                                             (line  369)
* header_fetch_parse() (email.policy.Compat32 method): email policy Policy Objects.
                                                             (line  556)
* header_fetch_parse() (email.policy.EmailPolicy method): email policy Policy Objects.
                                                             (line  419)
* header_fetch_parse() (email.policy.Policy method): email policy Policy Objects.
                                                             (line  280)
* header_items() (urllib.request.Request method): Request Objects.
                                                             (line  125)
* header_max_count() (email.policy.EmailPolicy method): email policy Policy Objects.
                                                             (line  396)
* header_max_count() (email.policy.Policy method): email policy Policy Objects.
                                                             (line  221)
* header_offset (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line  131)
* header_source_parse() (email.policy.Compat32 method): email policy Policy Objects.
                                                             (line  544)
* header_source_parse() (email.policy.EmailPolicy method): email policy Policy Objects.
                                                             (line  402)
* header_source_parse() (email.policy.Policy method): email policy Policy Objects.
                                                             (line  243)
* header_store_parse() (email.policy.Compat32 method): email policy Policy Objects.
                                                             (line  552)
* header_store_parse() (email.policy.EmailPolicy method): email policy Policy Objects.
                                                             (line  410)
* header_store_parse() (email.policy.Policy method): email policy Policy Objects.
                                                             (line  264)
* heading() (in module turtle):          Tell Turtle’s state.
                                                             (line   43)
* heading() (tkinter.ttk.Treeview method): ttk Treeview.     (line  105)
* heapify() (in module heapq):           heapq — Heap queue algorithm.
                                                             (line   56)
* heapmin() (in module msvcrt):          Other Functions.    (line    6)
* heappop() (in module heapq):           heapq — Heap queue algorithm.
                                                             (line   42)
* heappush() (in module heapq):          heapq — Heap queue algorithm.
                                                             (line   37)
* heappushpop() (in module heapq):       heapq — Heap queue algorithm.
                                                             (line   49)
* heapq (module):                        heapq — Heap queue algorithm.
                                                             (line    6)
* heapreplace() (in module heapq):       heapq — Heap queue algorithm.
                                                             (line   60)
* helo() (smtplib.SMTP method):          SMTP Objects.       (line   47)
* help (optparse.Option attribute):      Option attributes.  (line   72)
* help (pdb command):                    Debugger Commands.  (line   47)
* help() (built-in function):            Built-in Functions. (line  712)
* help() (nntplib.NNTP method):          Methods<3>.         (line  193)
* help; online:                          pydoc — Documentation generator and online help system.
                                                             (line    8)
* herror:                                Exceptions<11>.     (line   13)
* hex (uuid.UUID attribute):             uuid — UUID objects according to RFC 4122.
                                                             (line  122)
* hex() (built-in function):             Built-in Functions. (line  734)
* hex() (bytearray method):              Bytearray Objects.  (line   52)
* hex() (bytes method):                  Bytes Objects.      (line   78)
* hex() (float method):                  Additional Methods on Float.
                                                             (line   33)
* hex() (memoryview method):             Memory Views.       (line  184)
* hexadecimal literal:                   Numeric literals.   (line    6)
* hexadecimal; literals:                 Numeric Types — int float complex.
                                                             (line   19)
* hexbin() (in module binhex):           binhex — Encode and decode binhex4 files.
                                                             (line   23)
* hexdigest() (hashlib.hash method):     Hash algorithms.    (line  134)
* hexdigest() (hashlib.shake method):    SHAKE variable length digests.
                                                             (line   17)
* hexdigest() (hmac.HMAC method):        hmac — Keyed-Hashing for Message Authentication.
                                                             (line   69)
* hexdigits (in module string):          String constants.   (line   28)
* hexlify() (in module binascii):        binascii — Convert between binary and ASCII.
                                                             (line  127)
* hexversion (in module sys):            sys — System-specific parameters and functions.
                                                             (line  828)
* hidden() (curses.panel.Panel method):  Panel Objects.      (line   25)
* hide() (curses.panel.Panel method):    Panel Objects.      (line   30)
* hide() (tkinter.ttk.Notebook method):  ttk Notebook.       (line   23)
* hideturtle() (in module turtle):       Visibility.         (line    6)
* hide_cookie2 (http.cookiejar.CookiePolicy attribute): CookiePolicy Objects.
                                                             (line   76)
* HierarchyRequestErr:                   Exceptions<16>.     (line   29)
* HIGHEST_PROTOCOL (in module pickle):   Module Interface.   (line   14)
* HIGH_PRIORITY_CLASS (in module subprocess): Windows Constants.
                                                             (line   66)
* HKEY_CLASSES_ROOT (in module winreg):  HKEY_* Constants.   (line    6)
* HKEY_CURRENT_CONFIG (in module winreg): HKEY_* Constants.  (line   38)
* HKEY_CURRENT_USER (in module winreg):  HKEY_* Constants.   (line   12)
* HKEY_DYN_DATA (in module winreg):      HKEY_* Constants.   (line   43)
* HKEY_LOCAL_MACHINE (in module winreg): HKEY_* Constants.   (line   19)
* HKEY_PERFORMANCE_DATA (in module winreg): HKEY_* Constants.
                                                             (line   31)
* HKEY_USERS (in module winreg):         HKEY_* Constants.   (line   25)
* hline() (curses.window method):        Window Objects.     (line  279)
* HList (class in tkinter.tix):          Hierarchical ListBox.
                                                             (line    6)
* hls_to_rgb() (in module colorsys):     colorsys — Conversions between color systems.
                                                             (line   40)
* hmac (module):                         hmac — Keyed-Hashing for Message Authentication.
                                                             (line    6)
* HOME:                                  os path.            (line   15)
* HOME <1>:                              Changes in the Python API.
                                                             (line  111)
* HOME <2>:                              os path — Common pathname manipulations.
                                                             (line  140)
* HOME <3>:                              os path — Common pathname manipulations.
                                                             (line  156)
* HOME <4>:                              distutils util — Miscellaneous other utility functions.
                                                             (line   77)
* HOME <5>:                              Location and names of config files.
                                                             (line   50)
* HOME <6>:                              Location and names of config files.
                                                             (line   67)
* home() (in module turtle):             Turtle motion.      (line  121)
* home() (pathlib.Path class method):    Methods<2>.         (line   25)
* HOMEDRIVE:                             os path — Common pathname manipulations.
                                                             (line  147)
* HOMEDRIVE <1>:                         Location and names of config files.
                                                             (line   68)
* HOMEPATH:                              os path — Common pathname manipulations.
                                                             (line  147)
* HOMEPATH <1>:                          Location and names of config files.
                                                             (line   68)
* hooks; import:                         Import hooks.       (line    6)
* hooks; meta:                           Import hooks.       (line    6)
* hooks; path:                           Import hooks.       (line    6)
* hook_compressed() (in module fileinput): fileinput — Iterate over lines from multiple input streams.
                                                             (line  188)
* hook_encoded() (in module fileinput):  fileinput — Iterate over lines from multiple input streams.
                                                             (line  199)
* host (urllib.request.Request attribute): Request Objects.  (line   25)
* hostmask (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   97)
* hostmask (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  271)
* hostname_checks_common_name (ssl.SSLContext attribute): SSL Contexts.
                                                             (line  578)
* hosts (netrc.netrc attribute):         netrc Objects.      (line   23)
* hosts() (ipaddress.IPv4Network method): Network objects.   (line  136)
* hosts() (ipaddress.IPv6Network method): Network objects.   (line  289)
* hour (datetime.datetime attribute):    datetime Objects.   (line  278)
* hour (datetime.time attribute):        time Objects.       (line   50)
* HRESULT (class in ctypes):             Fundamental data types<2>.
                                                             (line  208)
* hStdError (subprocess.STARTUPINFO attribute): Windows Popen Helpers.
                                                             (line   41)
* hStdInput (subprocess.STARTUPINFO attribute): Windows Popen Helpers.
                                                             (line   26)
* hStdOutput (subprocess.STARTUPINFO attribute): Windows Popen Helpers.
                                                             (line   34)
* hsv_to_rgb() (in module colorsys):     colorsys — Conversions between color systems.
                                                             (line   48)
* ht() (in module turtle):               Visibility.         (line    6)
* HTML:                                  html parser — Simple HTML and XHTML parser.
                                                             (line    8)
* HTML <1>:                              urllib request Restrictions.
                                                             (line   29)
* html (module):                         html — HyperText Markup Language support.
                                                             (line    6)
* html() (in module cgitb):              cgitb — Traceback manager for CGI scripts.
                                                             (line   56)
* html.entities (module):                html entities — Definitions of HTML general entities.
                                                             (line    6)
* html.parser (module):                  html parser — Simple HTML and XHTML parser.
                                                             (line    6)
* html5 (in module html.entities):       html entities — Definitions of HTML general entities.
                                                             (line   14)
* HTMLCalendar (class in calendar):      calendar — General calendar-related functions.
                                                             (line  163)
* HtmlDiff (class in difflib):           difflib — Helpers for computing deltas.
                                                             (line   81)
* HTMLParser (class in html.parser):     html parser — Simple HTML and XHTML parser.
                                                             (line   14)
* htonl() (in module socket):            Other functions<2>. (line  195)
* htons() (in module socket):            Other functions<2>. (line  202)
* HTTP (in module email.policy):         email policy Policy Objects.
                                                             (line  486)
* http (module):                         http — HTTP modules.
                                                             (line    6)
* http.client (module):                  http client — HTTP protocol client.
                                                             (line    6)
* http.cookiejar (module):               http cookiejar — Cookie handling for HTTP clients.
                                                             (line    6)
* http.cookies (module):                 http cookies — HTTP state management.
                                                             (line    6)
* http.server (module):                  http server — HTTP servers.
                                                             (line    6)
* HTTP; http (standard module):          http — HTTP modules.
                                                             (line    8)
* HTTP; http.client (standard module):   http client — HTTP protocol client.
                                                             (line    8)
* HTTP; protocol:                        cgi — Common Gateway Interface support.
                                                             (line    8)
* HTTP; protocol <1>:                    urllib request Restrictions.
                                                             (line    6)
* HTTP; protocol <2>:                    urllib request Restrictions.
                                                             (line   29)
* HTTP; protocol <3>:                    http — HTTP modules.
                                                             (line    8)
* HTTP; protocol <4>:                    http client — HTTP protocol client.
                                                             (line    8)
* HTTP; protocol <5>:                    http server — HTTP servers.
                                                             (line    8)
* HTTPBasicAuthHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  355)
* HTTPConnection (class in http.client): http client — HTTP protocol client.
                                                             (line   26)
* HTTPCookieProcessor (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  286)
* httpd:                                 http server — HTTP servers.
                                                             (line    8)
* HTTPDefaultErrorHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  277)
* HTTPDigestAuthHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  379)
* HTTPError:                             urllib error — Exception classes raised by urllib request.
                                                             (line   30)
* HTTPErrorProcessor (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  439)
* HTTPException:                         http client — HTTP protocol client.
                                                             (line  125)
* HTTPHandler (class in logging.handlers): HTTPHandler.      (line   10)
* HTTPHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  403)
* HTTPPasswordMgr (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  312)
* HTTPPasswordMgrWithDefaultRealm (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  316)
* HTTPPasswordMgrWithPriorAuth (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  322)
* HTTPRedirectHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  282)
* HTTPResponse (class in http.client):   http client — HTTP protocol client.
                                                             (line   94)
* HTTPSConnection (class in http.client): http client — HTTP protocol client.
                                                             (line   54)
* HTTPServer (class in http.server):     http server — HTTP servers.
                                                             (line   22)
* HTTPSHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  407)
* HTTPStatus (class in http):            http — HTTP modules.
                                                             (line   28)
* https_open() (urllib.request.HTTPSHandler method): HTTPSHandler Objects.
                                                             (line    6)
* HTTPS_PORT (in module http.client):    http client — HTTP protocol client.
                                                             (line  198)
* https_response() (urllib.request.HTTPErrorProcessor method): HTTPErrorProcessor Objects.
                                                             (line   18)
* http_error_301() (urllib.request.HTTPRedirectHandler method): HTTPRedirectHandler Objects.
                                                             (line   35)
* http_error_302() (urllib.request.HTTPRedirectHandler method): HTTPRedirectHandler Objects.
                                                             (line   42)
* http_error_303() (urllib.request.HTTPRedirectHandler method): HTTPRedirectHandler Objects.
                                                             (line   48)
* http_error_307() (urllib.request.HTTPRedirectHandler method): HTTPRedirectHandler Objects.
                                                             (line   54)
* http_error_401() (urllib.request.HTTPBasicAuthHandler method): HTTPBasicAuthHandler Objects.
                                                             (line    6)
* http_error_401() (urllib.request.HTTPDigestAuthHandler method): HTTPDigestAuthHandler Objects.
                                                             (line    6)
* http_error_407() (urllib.request.ProxyBasicAuthHandler method): ProxyBasicAuthHandler Objects.
                                                             (line    6)
* http_error_407() (urllib.request.ProxyDigestAuthHandler method): ProxyDigestAuthHandler Objects.
                                                             (line    6)
* http_error_auth_reqed() (urllib.request.AbstractBasicAuthHandler method): AbstractBasicAuthHandler Objects.
                                                             (line    6)
* http_error_auth_reqed() (urllib.request.AbstractDigestAuthHandler method): AbstractDigestAuthHandler Objects.
                                                             (line    6)
* http_error_default() (urllib.request.BaseHandler method): BaseHandler Objects.
                                                             (line   65)
* http_open() (urllib.request.HTTPHandler method): HTTPHandler Objects.
                                                             (line    6)
* HTTP_PORT (in module http.client):     http client — HTTP protocol client.
                                                             (line  194)
* http_proxy:                            urllib request — Extensible library for opening URLs.
                                                             (line   85)
* http_proxy <1>:                        Examples<21>.       (line   56)
* http_proxy <2>:                        Basic Authentication.
                                                             (line   44)
* http_response() (urllib.request.HTTPErrorProcessor method): HTTPErrorProcessor Objects.
                                                             (line    6)
* http_version (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  299)
* hypot() (in module math):              Trigonometric functions.
                                                             (line   44)
* I (in module re):                      Module Contents.    (line   63)
* I/O control; buffering:                Built-in Functions. (line 1212)
* I/O control; buffering <1>:            Socket Objects.     (line  199)
* iadd() (in module operator):           In-place Operators. (line   36)
* iand() (in module operator):           In-place Operators. (line   41)
* iconcat() (in module operator):        In-place Operators. (line   46)
* id (ssl.SSLSession attribute):         SSL session.        (line   12)
* id() (built-in function):              Built-in Functions. (line  765)
* id() (unittest.TestCase method):       Test cases.         (line  702)
* idcok() (curses.window method):        Window Objects.     (line  286)
* ident (select.kevent attribute):       Kevent Objects.     (line    8)
* ident (threading.Thread attribute):    Thread Objects.     (line  148)
* identchars (cmd.Cmd attribute):        Cmd Objects.        (line  127)
* identifier:                            Identifiers and keywords.
                                                             (line    6)
* identifier <1>:                        Identifiers Names.  (line    6)
* identify() (tkinter.ttk.Notebook method): ttk Notebook.    (line   32)
* identify() (tkinter.ttk.Treeview method): ttk Treeview.    (line  143)
* identify() (tkinter.ttk.Widget method): ttk Widget.        (line   11)
* identify_column() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  153)
* identify_element() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  182)
* identify_region() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  160)
* identify_row() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  149)
* identity of an object:                 Objects values and types.
                                                             (line   11)
* identity; test:                        Membership test operations.
                                                             (line   40)
* idioms (2to3 fixer):                   Fixers.             (line  123)
* IDLE:                                  IDLE<41>.           (line    8)
* IDLE <1>:                              Glossary.           (line  574)
* IDLESTARTUP:                           IDLE<14>.           (line  176)
* IDLESTARTUP <1>:                       IDLE<18>.           (line    9)
* IDLESTARTUP <2>:                       IDLE<24>.           (line    9)
* IDLESTARTUP <3>:                       Startup and code execution.
                                                             (line    7)
* IDLE_PRIORITY_CLASS (in module subprocess): Windows Constants.
                                                             (line   73)
* idlok() (curses.window method):        Window Objects.     (line  294)
* if; conditional expression:            Conditional expressions.
                                                             (line    6)
* if; in comprehensions:                 Displays for lists sets and dictionaries.
                                                             (line   14)
* ifloordiv() (in module operator):      In-place Operators. (line   52)
* if_indextoname() (in module socket):   Other functions<2>. (line  377)
* if_nameindex() (in module socket):     Other functions<2>. (line  354)
* if_nametoindex() (in module socket):   Other functions<2>. (line  365)
* iglob() (in module glob):              glob — Unix style pathname pattern expansion.
                                                             (line   52)
* ignorableWhitespace() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line  150)
* ignore (pdb command):                  Debugger Commands.  (line  111)
* IGNORECASE (in module re):             Module Contents.    (line   63)
* ignore_errors() (in module codecs):    Error Handlers.     (line  140)
* IGNORE_EXCEPTION_DETAIL (in module doctest): Option Flags. (line   58)
* ignore_patterns() (in module shutil):  Directory and files operations.
                                                             (line  162)
* ihave() (nntplib.NNTP method):         Methods<3>.         (line  255)
* IISCGIHandler (class in wsgiref.handlers): wsgiref handlers – server/gateway base classes.
                                                             (line   24)
* ilshift() (in module operator):        In-place Operators. (line   57)
* imag (numbers.Complex attribute):      The numeric tower.  (line   19)
* imaginary literal:                     Numeric literals.   (line    6)
* imap() (multiprocessing.pool.Pool method): Process Pools.  (line  114)
* IMAP4 (class in imaplib):              imaplib — IMAP4 protocol client.
                                                             (line   20)
* IMAP4.abort:                           imaplib — IMAP4 protocol client.
                                                             (line   45)
* IMAP4.error:                           imaplib — IMAP4 protocol client.
                                                             (line   40)
* IMAP4.readonly:                        imaplib — IMAP4 protocol client.
                                                             (line   52)
* IMAP4; protocol:                       imaplib — IMAP4 protocol client.
                                                             (line    8)
* IMAP4_SSL (class in imaplib):          imaplib — IMAP4 protocol client.
                                                             (line   61)
* IMAP4_SSL; protocol:                   imaplib — IMAP4 protocol client.
                                                             (line    8)
* IMAP4_stream (class in imaplib):       imaplib — IMAP4 protocol client.
                                                             (line   95)
* IMAP4_stream; protocol:                imaplib — IMAP4 protocol client.
                                                             (line    8)
* imaplib (module):                      imaplib — IMAP4 protocol client.
                                                             (line    6)
* imap_unordered() (multiprocessing.pool.Pool method): Process Pools.
                                                             (line  129)
* imatmul() (in module operator):        In-place Operators. (line   72)
* imghdr (module):                       imghdr — Determine the type of an image.
                                                             (line    6)
* immedok() (curses.window method):      Window Objects.     (line  300)
* immutable:                             Glossary.           (line  580)
* immutable object:                      Objects values and types.
                                                             (line   11)
* immutable; data; type:                 Literals<2>.        (line   17)
* immutable; object:                     Literals<2>.        (line   17)
* immutable; object <1>:                 Dictionary displays.
                                                             (line   37)
* immutable; sequence; types:            Immutable Sequence Types.
                                                             (line    6)
* imod() (in module operator):           In-place Operators. (line   62)
* imp (module):                          imp — Access the import internals.
                                                             (line    6)
* ImpImporter (class in pkgutil):        pkgutil — Package extension utility.
                                                             (line   52)
* implementation (in module sys):        sys — System-specific parameters and functions.
                                                             (line  846)
* ImpLoader (class in pkgutil):          pkgutil — Package extension utility.
                                                             (line   68)
* impl_detail() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  612)
* import (2to3 fixer):                   Fixers.             (line  138)
* import hooks:                          Import hooks.       (line    6)
* import machinery:                      The import system.  (line    6)
* import path:                           Glossary.           (line  588)
* importer:                              Glossary.           (line  601)
* ImportError:                           Concrete exceptions.
                                                             (line   38)
* importing:                             Glossary.           (line  596)
* importlib (module):                    importlib — The implementation of import.
                                                             (line    6)
* importlib.abc (module):                importlib abc – Abstract base classes related to import.
                                                             (line    6)
* importlib.machinery (module):          importlib machinery – Importers and path hooks.
                                                             (line    6)
* importlib.resources (module):          importlib resources – Resources.
                                                             (line    6)
* importlib.util (module):               importlib util – Utility code for importers.
                                                             (line    6)
* imports (2to3 fixer):                  Fixers.             (line  142)
* imports2 (2to3 fixer):                 Fixers.             (line  146)
* ImportWarning:                         Warnings.           (line   46)
* import_fresh_module() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  708)
* IMPORT_FROM (opcode):                  Python Bytecode Instructions.
                                                             (line  643)
* import_module() (in module importlib): Functions<10>.      (line   15)
* import_module() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  693)
* IMPORT_NAME (opcode):                  Python Bytecode Instructions.
                                                             (line  634)
* IMPORT_STAR (opcode):                  Python Bytecode Instructions.
                                                             (line  366)
* import__find__load__done (C function): Available static markers.
                                                             (line   59)
* import__find__load__start (C function): Available static markers.
                                                             (line   52)
* ImproperConnectionState:               http client — HTTP protocol client.
                                                             (line  155)
* imul() (in module operator):           In-place Operators. (line   67)
* inch() (curses.window method):         Window Objects.     (line  308)
* inclusive (tracemalloc.DomainFilter attribute): DomainFilter.
                                                             (line   12)
* inclusive (tracemalloc.Filter attribute): Filter.          (line   38)
* inclusive; or:                         Binary bitwise operations.
                                                             (line   18)
* Incomplete:                            binascii — Convert between binary and ASCII.
                                                             (line  166)
* IncompleteRead:                        http client — HTTP protocol client.
                                                             (line  151)
* IncompleteReadError:                   Exceptions<9>.      (line   42)
* IncrementalDecoder (class in codecs):  IncrementalDecoder Objects.
                                                             (line   11)
* incrementaldecoder (codecs.CodecInfo attribute): codecs — Codec registry and base classes.
                                                             (line   78)
* IncrementalEncoder (class in codecs):  IncrementalEncoder Objects.
                                                             (line   11)
* incrementalencoder (codecs.CodecInfo attribute): codecs — Codec registry and base classes.
                                                             (line   78)
* IncrementalNewlineDecoder (class in io): Text I/O<2>.      (line  234)
* IncrementalParser (class in xml.sax.xmlreader): xml sax xmlreader — Interface for XML parsers.
                                                             (line   20)
* increment_lineno() (in module ast):    ast Helpers.        (line   90)
* incr_item():                           Exceptions<18>.     (line   73)
* incr_item() <1>:                       Exceptions<18>.     (line   77)
* indent (doctest.Example attribute):    Example Objects.    (line   47)
* INDENT (in module token):              token — Constants used with Python parse trees.
                                                             (line   50)
* INDENT token:                          Indentation.        (line   33)
* indent() (in module textwrap):         textwrap — Text wrapping and filling.
                                                             (line   91)
* indentation:                           Indentation.        (line    6)
* IndentationError:                      Concrete exceptions.
                                                             (line  258)
* index operation:                       The standard type hierarchy.
                                                             (line  109)
* index() (array.array method):          array — Efficient arrays of numeric values.
                                                             (line  193)
* index() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line   99)
* index() (bytes method):                Bytes and Bytearray Operations.
                                                             (line   99)
* index() (collections.deque method):    deque objects.      (line   70)
* index() (in module operator):          operator — Standard operators as functions.
                                                             (line   93)
* index() (multiprocessing.shared_memory.ShareableList method): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  189)
* index() (sequence method):             Common Sequence Operations.
                                                             (line   21)
* index() (str method):                  String Methods<2>.  (line  162)
* index() (tkinter.ttk.Notebook method): ttk Notebook.       (line   37)
* index() (tkinter.ttk.Treeview method): ttk Treeview.       (line  188)
* IndexError:                            Concrete exceptions.
                                                             (line   59)
* indexOf() (in module operator):        operator — Standard operators as functions.
                                                             (line  197)
* IndexSizeErr:                          Exceptions<16>.     (line   34)
* indices() (slice method):              The standard type hierarchy.
                                                             (line  779)
* inet_aton() (in module socket):        Other functions<2>. (line  215)
* inet_ntoa() (in module socket):        Other functions<2>. (line  235)
* inet_ntop() (in module socket):        Other functions<2>. (line  271)
* inet_pton() (in module socket):        Other functions<2>. (line  252)
* Inexact (class in decimal):            Signals.            (line   42)
* inf (in module cmath):                 Constants<3>.       (line   20)
* inf (in module math):                  Constants<2>.       (line   24)
* infile (shlex.shlex attribute):        shlex Objects.      (line  140)
* Infinity:                              Built-in Functions. (line  584)
* infj (in module cmath):                Constants<3>.       (line   26)
* info() (dis.Bytecode method):          Bytecode analysis.  (line   53)
* info() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   78)
* info() (in module logging):            Module-Level Functions.
                                                             (line  115)
* info() (logging.Logger method):        Logger Objects.     (line  210)
* infolist() (zipfile.ZipFile method):   ZipFile Objects.    (line   98)
* inheritance:                           Class definitions.  (line    6)
* ini file:                              configparser — Configuration file parser.
                                                             (line    8)
* init() (in module mimetypes):          mimetypes — Map filenames to MIME types.
                                                             (line   78)
* inited (in module mimetypes):          mimetypes — Map filenames to MIME types.
                                                             (line  117)
* initgroups() (in module os):           Process Parameters. (line  306)
* initialize_options() (distutils.cmd.Command method): Creating a new Distutils command.
                                                             (line   21)
* initial_indent (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  199)
* initproc (C type):                     Slot Type typedefs. (line   45)
* initscr() (in module curses):          Functions<3>.       (line  226)
* init_color() (in module curses):       Functions<3>.       (line  203)
* init_database() (in module msilib):    msilib — Read and write Microsoft Installer files.
                                                             (line   60)
* init_pair() (in module curses):        Functions<3>.       (line  214)
* inode() (os.DirEntry method):          Files and Directories.
                                                             (line  817)
* INPLACE_ADD (opcode):                  Python Bytecode Instructions.
                                                             (line  222)
* INPLACE_AND (opcode):                  Python Bytecode Instructions.
                                                             (line  238)
* INPLACE_FLOOR_DIVIDE (opcode):         Python Bytecode Instructions.
                                                             (line  210)
* INPLACE_LSHIFT (opcode):               Python Bytecode Instructions.
                                                             (line  230)
* INPLACE_MATRIX_MULTIPLY (opcode):      Python Bytecode Instructions.
                                                             (line  204)
* INPLACE_MODULO (opcode):               Python Bytecode Instructions.
                                                             (line  218)
* INPLACE_MULTIPLY (opcode):             Python Bytecode Instructions.
                                                             (line  200)
* INPLACE_OR (opcode):                   Python Bytecode Instructions.
                                                             (line  246)
* INPLACE_POWER (opcode):                Python Bytecode Instructions.
                                                             (line  196)
* INPLACE_RSHIFT (opcode):               Python Bytecode Instructions.
                                                             (line  234)
* INPLACE_SUBTRACT (opcode):             Python Bytecode Instructions.
                                                             (line  226)
* INPLACE_TRUE_DIVIDE (opcode):          Python Bytecode Instructions.
                                                             (line  214)
* INPLACE_XOR (opcode):                  Python Bytecode Instructions.
                                                             (line  242)
* input:                                 Expression input.   (line    6)
* input (2to3 fixer):                    Fixers.             (line  152)
* input() (built-in function):           Built-in Functions. (line  775)
* input() (in module fileinput):         fileinput — Iterate over lines from multiple input streams.
                                                             (line   54)
* InputOnly (class in tkinter.tix):      Miscellaneous Widgets.
                                                             (line    6)
* InputSource (class in xml.sax.xmlreader): xml sax xmlreader — Interface for XML parsers.
                                                             (line   51)
* input_charset (email.charset.Charset attribute): email charset Representing character sets.
                                                             (line   53)
* input_codec (email.charset.Charset attribute): email charset Representing character sets.
                                                             (line   82)
* inquiry (C type):                      Supporting Cyclic Garbage Collection.
                                                             (line  128)
* insch() (curses.window method):        Window Objects.     (line  314)
* insdelln() (curses.window method):     Window Objects.     (line  321)
* insert() (array.array method):         array — Efficient arrays of numeric values.
                                                             (line  198)
* insert() (collections.deque method):   deque objects.      (line   78)
* insert() (sequence method):            Mutable Sequence Types.
                                                             (line   16)
* insert() (tkinter.ttk.Notebook method): ttk Notebook.      (line   42)
* insert() (tkinter.ttk.Treeview method): ttk Treeview.      (line  193)
* insert() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  140)
* insertBefore() (xml.dom.Node method):  Node Objects.       (line  121)
* insertln() (curses.window method):     Window Objects.     (line  329)
* insert_text() (in module readline):    Line buffer.        (line   13)
* insnstr() (curses.window method):      Window Objects.     (line  334)
* insort() (in module bisect):           bisect — Array bisection algorithm.
                                                             (line   52)
* insort_left() (in module bisect):      bisect — Array bisection algorithm.
                                                             (line   45)
* insort_right() (in module bisect):     bisect — Array bisection algorithm.
                                                             (line   52)
* inspect (module):                      inspect — Inspect live objects.
                                                             (line    6)
* inspect command line option; –details: Command Line Interface<3>.
                                                             (line   13)
* InspectLoader (class in importlib.abc): importlib abc – Abstract base classes related to import.
                                                             (line  372)
* insstr() (curses.window method):       Window Objects.     (line  345)
* install() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line  100)
* install() (in module gettext):         Class-based API.    (line   72)
* installHandler() (in module unittest): Signal Handling.    (line   28)
* install_opener() (in module urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  116)
* install_scripts() (venv.EnvBuilder method): API<2>.        (line  115)
* instance; call:                        Calls.              (line  146)
* instate() (tkinter.ttk.Widget method): ttk Widget.         (line   18)
* instr() (curses.window method):        Window Objects.     (line  355)
* instream (shlex.shlex attribute):      shlex Objects.      (line  146)
* Instruction (class in dis):            Python Bytecode Instructions.
                                                             (line   10)
* Instruction.arg (in module dis):       Python Bytecode Instructions.
                                                             (line   24)
* Instruction.argrepr (in module dis):   Python Bytecode Instructions.
                                                             (line   32)
* Instruction.argval (in module dis):    Python Bytecode Instructions.
                                                             (line   28)
* Instruction.is_jump_target (in module dis): Python Bytecode Instructions.
                                                             (line   44)
* Instruction.offset (in module dis):    Python Bytecode Instructions.
                                                             (line   36)
* Instruction.opcode (in module dis):    Python Bytecode Instructions.
                                                             (line   14)
* Instruction.opname (in module dis):    Python Bytecode Instructions.
                                                             (line   20)
* Instruction.starts_line (in module dis): Python Bytecode Instructions.
                                                             (line   40)
* int (built-in class):                  Built-in Functions. (line  798)
* int (uuid.UUID attribute):             uuid — UUID objects according to RFC 4122.
                                                             (line  126)
* Int2AP() (in module imaplib):          imaplib — IMAP4 protocol client.
                                                             (line  109)
* integer:                               The standard type hierarchy.
                                                             (line  138)
* integer literal:                       Numeric literals.   (line    6)
* integer; literals:                     Numeric Types — int float complex.
                                                             (line   19)
* integer; representation:               The standard type hierarchy.
                                                             (line   83)
* Integral (class in numbers):           The numeric tower.  (line   55)
* Integrated Development Environment:    IDLE<41>.           (line    8)
* IntegrityError:                        Exceptions<4>.      (line   19)
* Intel/DVI ADPCM:                       audioop — Manipulate raw audio data.
                                                             (line   17)
* IntEnum (class in enum):               Module Contents<2>. (line   16)
* interact (pdb command):                Debugger Commands.  (line  272)
* interact() (code.InteractiveConsole method): Interactive Console Objects.
                                                             (line   10)
* interact() (in module code):           code — Interpreter base classes.
                                                             (line   32)
* interact() (telnetlib.Telnet method):  Telnet Objects.     (line  113)
* interactive:                           Glossary.           (line  606)
* interactive mode:                      Complete Python programs.
                                                             (line   19)
* InteractiveConsole (class in code):    code — Interpreter base classes.
                                                             (line   25)
* InteractiveInterpreter (class in code): code — Interpreter base classes.
                                                             (line   15)
* intern (2to3 fixer):                   Fixers.             (line  156)
* intern() (in module sys):              sys — System-specific parameters and functions.
                                                             (line  923)
* internal type:                         The standard type hierarchy.
                                                             (line  615)
* Internaldate2tuple() (in module imaplib): imaplib — IMAP4 protocol client.
                                                             (line  103)
* internalSubset (xml.dom.DocumentType attribute): DocumentType Objects.
                                                             (line   27)
* internal_attr (zipfile.ZipInfo attribute): ZipInfo Objects.
                                                             (line  123)
* Internet:                              Internet Protocols and Support.
                                                             (line    6)
* interpolated string literal:           String literal concatenation.
                                                             (line   24)
* interpolation, string (%):             printf-style String Formatting.
                                                             (line    6)
* interpolation; bytearray (%):          printf-style Bytes Formatting.
                                                             (line    6)
* interpolation; bytes (%):              printf-style Bytes Formatting.
                                                             (line    6)
* InterpolationDepthError:               Exceptions<5>.      (line   42)
* InterpolationError:                    Exceptions<5>.      (line   37)
* InterpolationMissingOptionError:       Exceptions<5>.      (line   49)
* InterpolationSyntaxError:              Exceptions<5>.      (line   54)
* interpreted:                           Glossary.           (line  615)
* interpreter:                           Top-level components.
                                                             (line    6)
* interpreter lock:                      Thread State and the Global Interpreter Lock.
                                                             (line    6)
* interpreter prompts:                   sys — System-specific parameters and functions.
                                                             (line 1139)
* interpreter shutdown:                  Glossary.           (line  625)
* interpreter_requires_environment() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line    9)
* interrupt() (sqlite3.Connection method): Connection Objects.
                                                             (line  188)
* InterruptedError:                      OS exceptions.      (line   71)
* interrupt_main() (in module _thread):  _thread — Low-level threading API.
                                                             (line   53)
* intersection() (frozenset method):     Set Types — set frozenset.
                                                             (line   91)
* intersection_update() (frozenset method): Set Types — set frozenset.
                                                             (line  164)
* IntFlag (class in enum):               Module Contents<2>. (line   21)
* intro (cmd.Cmd attribute):             Cmd Objects.        (line  142)
* int_info (in module sys):              sys — System-specific parameters and functions.
                                                             (line  889)
* InuseAttributeErr:                     Exceptions<16>.     (line   39)
* inv() (in module operator):            operator — Standard operators as functions.
                                                             (line   98)
* InvalidAccessErr:                      Exceptions<16>.     (line   44)
* invalidate_caches() (importlib.abc.MetaPathFinder method): importlib abc – Abstract base classes related to import.
                                                             (line   77)
* invalidate_caches() (importlib.abc.PathEntryFinder method): importlib abc – Abstract base classes related to import.
                                                             (line  142)
* invalidate_caches() (importlib.machinery.FileFinder method): importlib machinery – Importers and path hooks.
                                                             (line  198)
* invalidate_caches() (importlib.machinery.PathFinder class method): importlib machinery – Importers and path hooks.
                                                             (line  142)
* invalidate_caches() (in module importlib): Functions<10>.  (line   62)
* InvalidCharacterErr:                   Exceptions<16>.     (line   49)
* InvalidModificationErr:                Exceptions<16>.     (line   57)
* InvalidOperation (class in decimal):   Signals.            (line   50)
* InvalidStateErr:                       Exceptions<16>.     (line   61)
* InvalidStateError:                     Exception classes.  (line   22)
* InvalidStateError <1>:                 Exceptions<9>.      (line   28)
* InvalidURL:                            http client — HTTP protocol client.
                                                             (line  134)
* inversion:                             Unary arithmetic and bitwise operations.
                                                             (line   15)
* invert() (in module operator):         operator — Standard operators as functions.
                                                             (line   98)
* invocation:                            The standard type hierarchy.
                                                             (line  262)
* inv_cdf() (statistics.NormalDist method): NormalDist objects.
                                                             (line   86)
* in_dll() (ctypes._CData method):       Data types.         (line   63)
* in_table_a1() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line   40)
* in_table_b1() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line   45)
* in_table_c11() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   60)
* in_table_c11_c12() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   69)
* in_table_c12() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   64)
* in_table_c21() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   74)
* in_table_c21_c22() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   84)
* in_table_c22() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   79)
* in_table_c3() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line   89)
* in_table_c4() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line   93)
* in_table_c5() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line   98)
* in_table_c6() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line  102)
* in_table_c7() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line  107)
* in_table_c8() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line  112)
* in_table_c9() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line  117)
* in_table_d1() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line  121)
* in_table_d2() (in module stringprep):  stringprep — Internet String Preparation.
                                                             (line  126)
* in_transaction (sqlite3.Connection attribute): Connection Objects.
                                                             (line   18)
* IO (class in typing):                  Classes functions and decorators.
                                                             (line  399)
* io (module):                           io — Core tools for working with streams.
                                                             (line    6)
* IOBase (class in io):                  I/O Base Classes.   (line    6)
* ioctl() (in module fcntl):             fcntl — The fcntl and ioctl system calls.
                                                             (line   51)
* ioctl() (socket.socket method):        Socket Objects.     (line  168)
* IOCTL_VM_SOCKETS_GET_LOCAL_CID (in module socket): Constants<8>.
                                                             (line  194)
* IOError:                               Concrete exceptions.
                                                             (line  396)
* ior() (in module operator):            In-place Operators. (line   79)
* IO_REPARSE_TAG_APPEXECLINK (in module stat): stat — Interpreting stat results.
                                                             (line  418)
* IO_REPARSE_TAG_MOUNT_POINT (in module stat): stat — Interpreting stat results.
                                                             (line  418)
* IO_REPARSE_TAG_SYMLINK (in module stat): stat — Interpreting stat results.
                                                             (line  418)
* ip (ipaddress.IPv4Interface attribute): Interface objects. (line   19)
* ip (ipaddress.IPv6Interface attribute): Interface objects. (line   64)
* ipaddress (module):                    ipaddress — IPv4/IPv6 manipulation library.
                                                             (line    6)
* ipow() (in module operator):           In-place Operators. (line   84)
* IPv4Address (class in ipaddress):      Address objects.    (line   13)
* IPv4Interface (class in ipaddress):    Interface objects.  (line    9)
* IPv4Network (class in ipaddress):      Network objects.    (line   13)
* ipv4_mapped (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  186)
* IPv6Address (class in ipaddress):      Address objects.    (line  116)
* IPv6Interface (class in ipaddress):    Interface objects.  (line   54)
* IPv6Network (class in ipaddress):      Network objects.    (line  211)
* IPV6_ENABLED (in module test.support): test support — Utilities for the Python test suite.
                                                             (line   83)
* ip_address() (in module ipaddress):    Convenience factory functions.
                                                             (line    9)
* ip_interface() (in module ipaddress):  Convenience factory functions.
                                                             (line   33)
* ip_network() (in module ipaddress):    Convenience factory functions.
                                                             (line   20)
* irshift() (in module operator):        In-place Operators. (line   89)
* isabs() (in module os.path):           os path — Common pathname manipulations.
                                                             (line  204)
* isabstract() (in module inspect):      Types and members.  (line  400)
* IsADirectoryError:                     OS exceptions.      (line   81)
* isalnum() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  441)
* isalnum() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  441)
* isalnum() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  131)
* isalnum() (str method):                String Methods<2>.  (line  167)
* isalpha() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  459)
* isalpha() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  459)
* isalpha() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  136)
* isalpha() (str method):                String Methods<2>.  (line  174)
* isascii() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  474)
* isascii() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  474)
* isascii() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  141)
* isascii() (str method):                String Methods<2>.  (line  184)
* isasyncgen() (in module inspect):      Types and members.  (line  370)
* isasyncgenfunction() (in module inspect): Types and members.
                                                             (line  357)
* isatty() (chunk.Chunk method):         chunk — Read IFF chunked data.
                                                             (line   88)
* isatty() (in module os):               File Descriptor Operations.
                                                             (line  203)
* isatty() (io.IOBase method):           I/O Base Classes.   (line   74)
* isawaitable() (in module inspect):     Types and members.  (line  345)
* isblank() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  145)
* isblk() (tarfile.TarInfo method):      TarInfo Objects.    (line  120)
* isbuiltin() (in module inspect):       Types and members.  (line  390)
* ischr() (tarfile.TarInfo method):      TarInfo Objects.    (line  116)
* isclass() (in module inspect):         Types and members.  (line  301)
* isclose() (in module cmath):           Classification functions.
                                                             (line   23)
* isclose() (in module math):            Number-theoretic and representation functions.
                                                             (line  104)
* iscntrl() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  149)
* iscode() (in module inspect):          Types and members.  (line  386)
* iscoroutine() (in module asyncio):     Generator-based Coroutines.
                                                             (line   31)
* iscoroutine() (in module inspect):     Types and members.  (line  338)
* iscoroutinefunction() (in module asyncio): Generator-based Coroutines.
                                                             (line   38)
* iscoroutinefunction() (in module inspect): Types and members.
                                                             (line  327)
* isctrl() (in module curses.ascii):     curses ascii — Utilities for ASCII characters.
                                                             (line  190)
* isDaemon() (threading.Thread method):  Thread Objects.     (line  197)
* isdatadescriptor() (in module inspect): Types and members. (line  422)
* isdecimal() (str method):              String Methods<2>.  (line  192)
* isdev() (tarfile.TarInfo method):      TarInfo Objects.    (line  128)
* isdigit() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  482)
* isdigit() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  482)
* isdigit() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  154)
* isdigit() (str method):                String Methods<2>.  (line  200)
* isdir() (in module os.path):           os path — Common pathname manipulations.
                                                             (line  220)
* isdir() (tarfile.TarInfo method):      TarInfo Objects.    (line  104)
* isdisjoint() (frozenset method):       Set Types — set frozenset.
                                                             (line   57)
* isdown() (in module turtle):           Drawing state.      (line   71)
* iselement() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  111)
* isenabled() (in module gc):            gc — Garbage Collector interface.
                                                             (line   30)
* isEnabledFor() (logging.Logger method): Logger Objects.    (line   89)
* isendwin() (in module curses):         Functions<3>.       (line  239)
* ISEOF() (in module token):             token — Constants used with Python parse trees.
                                                             (line   34)
* isexpr() (in module parser):           Queries on ST Objects.
                                                             (line   12)
* isexpr() (parser.ST method):           ST Objects.         (line   21)
* isfifo() (tarfile.TarInfo method):     TarInfo Objects.    (line  124)
* isfile() (in module os.path):          os path — Common pathname manipulations.
                                                             (line  212)
* isfile() (tarfile.TarInfo method):     TarInfo Objects.    (line   96)
* isfinite() (in module cmath):          Classification functions.
                                                             (line    6)
* isfinite() (in module math):           Number-theoretic and representation functions.
                                                             (line  137)
* isfirstline() (in module fileinput):   fileinput — Iterate over lines from multiple input streams.
                                                             (line  106)
* isframe() (in module inspect):         Types and members.  (line  382)
* isfunction() (in module inspect):      Types and members.  (line  310)
* isfuture() (in module asyncio):        Future Functions.   (line    6)
* isgenerator() (in module inspect):     Types and members.  (line  323)
* isgeneratorfunction() (in module inspect): Types and members.
                                                             (line  315)
* isgetsetdescriptor() (in module inspect): Types and members.
                                                             (line  435)
* isgraph() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  159)
* isidentifier() (str method):           String Methods<2>.  (line  210)
* isinf() (in module cmath):             Classification functions.
                                                             (line   13)
* isinf() (in module math):              Number-theoretic and representation functions.
                                                             (line  144)
* isinstance (2to3 fixer):               Fixers.             (line  160)
* isinstance() (built-in function):      Built-in Functions. (line  840)
* iskeyword() (in module keyword):       keyword — Testing for Python keywords.
                                                             (line   13)
* isleap() (in module calendar):         calendar — General calendar-related functions.
                                                             (line  301)
* islice() (in module itertools):        Itertool functions. (line  353)
* islink() (in module os.path):          os path — Common pathname manipulations.
                                                             (line  228)
* islnk() (tarfile.TarInfo method):      TarInfo Objects.    (line  112)
* islower() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  496)
* islower() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  496)
* islower() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  163)
* islower() (str method):                String Methods<2>.  (line  228)
* ismemberdescriptor() (in module inspect): Types and members.
                                                             (line  444)
* ismeta() (in module curses.ascii):     curses ascii — Utilities for ASCII characters.
                                                             (line  194)
* ismethod() (in module inspect):        Types and members.  (line  306)
* ismethoddescriptor() (in module inspect): Types and members.
                                                             (line  404)
* ismodule() (in module inspect):        Types and members.  (line  297)
* ismount() (in module os.path):         os path — Common pathname manipulations.
                                                             (line  236)
* isnan() (in module cmath):             Classification functions.
                                                             (line   18)
* isnan() (in module math):              Number-theoretic and representation functions.
                                                             (line  149)
* ISNONTERMINAL() (in module token):     token — Constants used with Python parse trees.
                                                             (line   30)
* isnumeric() (str method):              String Methods<2>.  (line  234)
* isocalendar() (datetime.date method):  date Objects.       (line  213)
* isocalendar() (datetime.datetime method): datetime Objects.
                                                             (line  595)
* isoformat() (datetime.date method):    date Objects.       (line  236)
* isoformat() (datetime.datetime method): datetime Objects.  (line  600)
* isoformat() (datetime.time method):    time Objects.       (line  151)
* IsolatedAsyncioTestCase (class in unittest): Test cases.   (line  782)
* isolation_level (sqlite3.Connection attribute): Connection Objects.
                                                             (line   11)
* isoweekday() (datetime.date method):   date Objects.       (line  206)
* isoweekday() (datetime.datetime method): datetime Objects. (line  589)
* isprint() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  167)
* isprintable() (str method):            String Methods<2>.  (line  244)
* ispunct() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  171)
* isqrt() (in module math):              Number-theoretic and representation functions.
                                                             (line  154)
* isreadable() (in module pprint):       pprint — Data pretty printer.
                                                             (line  130)
* isreadable() (pprint.PrettyPrinter method): PrettyPrinter Objects.
                                                             (line   24)
* isrecursive() (in module pprint):      pprint — Data pretty printer.
                                                             (line  139)
* isrecursive() (pprint.PrettyPrinter method): PrettyPrinter Objects.
                                                             (line   32)
* isreg() (tarfile.TarInfo method):      TarInfo Objects.    (line  100)
* isReservedKey() (http.cookies.Morsel method): Morsel Objects.
                                                             (line   68)
* isroutine() (in module inspect):       Types and members.  (line  395)
* isSameNode() (xml.dom.Node method):    Node Objects.       (line  102)
* isspace() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  513)
* isspace() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  513)
* isspace() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  176)
* isspace() (str method):                String Methods<2>.  (line  256)
* isstdin() (in module fileinput):       fileinput — Iterate over lines from multiple input streams.
                                                             (line  111)
* issubclass() (built-in function):      Built-in Functions. (line  851)
* issubset() (frozenset method):         Set Types — set frozenset.
                                                             (line   63)
* issuite() (in module parser):          Queries on ST Objects.
                                                             (line   22)
* issuite() (parser.ST method):          ST Objects.         (line   25)
* issuperset() (frozenset method):       Set Types — set frozenset.
                                                             (line   74)
* issym() (tarfile.TarInfo method):      TarInfo Objects.    (line  108)
* ISTERMINAL() (in module token):        token — Constants used with Python parse trees.
                                                             (line   26)
* istitle() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  521)
* istitle() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  521)
* istitle() (str method):                String Methods<2>.  (line  266)
* istraceback() (in module inspect):     Types and members.  (line  378)
* isub() (in module operator):           In-place Operators. (line   94)
* isupper() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  535)
* isupper() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  535)
* isupper() (in module curses.ascii):    curses ascii — Utilities for ASCII characters.
                                                             (line  181)
* isupper() (str method):                String Methods<2>.  (line  273)
* isvisible() (in module turtle):        Visibility.         (line   22)
* isxdigit() (in module curses.ascii):   curses ascii — Utilities for ASCII characters.
                                                             (line  185)
* is_() (in module operator):            operator — Standard operators as functions.
                                                             (line   63)
* is_absolute() (pathlib.PurePath method): Methods and properties.
                                                             (line  165)
* is_active() (asyncio.AbstractChildWatcher method): Process Watchers.
                                                             (line   68)
* is_alive() (multiprocessing.Process method): Process and exceptions.
                                                             (line   80)
* is_alive() (threading.Thread method):  Thread Objects.     (line  175)
* is_android (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line   40)
* is_assigned() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  147)
* is_attachment() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  442)
* is_authenticated() (urllib.request.HTTPPasswordMgrWithPriorAuth method): HTTPPasswordMgrWithPriorAuth Objects.
                                                             (line   29)
* is_blocked() (http.cookiejar.DefaultCookiePolicy method): DefaultCookiePolicy Objects.
                                                             (line   53)
* is_block_device() (pathlib.Path method): Methods<2>.       (line  168)
* is_canonical() (decimal.Context method): Context objects.  (line  292)
* is_canonical() (decimal.Decimal method): Decimal objects.  (line  278)
* IS_CHARACTER_JUNK() (in module difflib): difflib — Helpers for computing deltas.
                                                             (line  364)
* is_char_device() (pathlib.Path method): Methods<2>.        (line  177)
* is_check_supported() (in module lzma): Miscellaneous<2>.   (line    6)
* is_closed() (asyncio.loop method):     Running and stopping the loop.
                                                             (line   39)
* is_closing() (asyncio.BaseTransport method): Base Transport.
                                                             (line   16)
* is_closing() (asyncio.StreamWriter method): StreamWriter.  (line   77)
* is_dataclass() (in module dataclasses): Module-level decorators classes and functions.
                                                             (line  324)
* is_declared_global() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  133)
* is_dir() (os.DirEntry method):         Files and Directories.
                                                             (line  828)
* is_dir() (pathlib.Path method):        Methods<2>.         (line  113)
* is_dir() (zipfile.Path method):        Path Objects.       (line   34)
* is_dir() (zipfile.ZipInfo method):     ZipInfo Objects.    (line   42)
* is_enabled() (in module faulthandler): Fault handler state.
                                                             (line   27)
* is_expired() (http.cookiejar.Cookie method): Cookie Objects<2>.
                                                             (line  109)
* is_fifo() (pathlib.Path method):       Methods<2>.         (line  160)
* is_file() (os.DirEntry method):        Files and Directories.
                                                             (line  857)
* is_file() (pathlib.Path method):       Methods<2>.         (line  122)
* is_file() (zipfile.Path method):       Path Objects.       (line   38)
* is_finalizing() (in module sys):       sys — System-specific parameters and functions.
                                                             (line  938)
* is_finite() (decimal.Context method):  Context objects.    (line  296)
* is_finite() (decimal.Decimal method):  Decimal objects.    (line  285)
* is_free() (symtable.Symbol method):    Examining Symbol Tables.
                                                             (line  142)
* is_global (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   89)
* is_global (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  166)
* is_global() (symtable.Symbol method):  Examining Symbol Tables.
                                                             (line  125)
* is_hop_by_hop() (in module wsgiref.util): wsgiref util – WSGI environment utilities.
                                                             (line   90)
* is_imported() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  116)
* is_infinite() (decimal.Context method): Context objects.   (line  300)
* is_infinite() (decimal.Decimal method): Decimal objects.   (line  290)
* is_integer() (float method):           Additional Methods on Float.
                                                             (line   16)
* is_jython (in module test.support):    test support — Utilities for the Python test suite.
                                                             (line   36)
* is_linetouched() (curses.window method): Window Objects.   (line  365)
* IS_LINE_JUNK() (in module difflib):    difflib — Helpers for computing deltas.
                                                             (line  357)
* is_link_local (ipaddress.IPv4Address attribute): Address objects.
                                                             (line  111)
* is_link_local (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   80)
* is_link_local (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  174)
* is_link_local (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  265)
* is_local() (symtable.Symbol method):   Examining Symbol Tables.
                                                             (line  138)
* is_loopback (ipaddress.IPv4Address attribute): Address objects.
                                                             (line  106)
* is_loopback (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   78)
* is_loopback (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  172)
* is_loopback (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  263)
* is_mount() (pathlib.Path method):      Methods<2>.         (line  131)
* is_multicast (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   78)
* is_multicast (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   70)
* is_multicast (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  162)
* is_multicast (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  255)
* is_multipart() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  134)
* is_multipart() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  135)
* is_namespace() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  151)
* is_nan() (decimal.Context method):     Context objects.    (line  304)
* is_nan() (decimal.Decimal method):     Decimal objects.    (line  295)
* is_nested() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   35)
* is_nonlocal() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  129)
* is_normal() (decimal.Context method):  Context objects.    (line  309)
* is_normal() (decimal.Decimal method):  Decimal objects.    (line  300)
* is_normalized() (in module unicodedata): unicodedata — Unicode Database.
                                                             (line  117)
* is_not() (in module operator):         operator — Standard operators as functions.
                                                             (line   67)
* is_not_allowed() (http.cookiejar.DefaultCookiePolicy method): DefaultCookiePolicy Objects.
                                                             (line   67)
* is_optimized() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   31)
* is_package() (importlib.abc.InspectLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  403)
* is_package() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  594)
* is_package() (importlib.machinery.ExtensionFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  329)
* is_package() (importlib.machinery.SourceFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  228)
* is_package() (importlib.machinery.SourcelessFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  272)
* is_package() (zipimport.zipimporter method): zipimporter Objects.
                                                             (line   56)
* is_parameter() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  121)
* is_private (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   83)
* is_private (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   72)
* is_private (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  164)
* is_private (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  257)
* is_python_build() (in module sysconfig): Other functions<3>.
                                                             (line   50)
* is_qnan() (decimal.Context method):    Context objects.    (line  314)
* is_qnan() (decimal.Decimal method):    Decimal objects.    (line  306)
* is_reading() (asyncio.ReadTransport method): Read-only Transports.
                                                             (line    6)
* is_referenced() (symtable.Symbol method): Examining Symbol Tables.
                                                             (line  112)
* is_reserved (ipaddress.IPv4Address attribute): Address objects.
                                                             (line  102)
* is_reserved (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   76)
* is_reserved (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  170)
* is_reserved (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  261)
* is_reserved() (pathlib.PurePath method): Methods and properties.
                                                             (line  184)
* is_resource() (importlib.abc.ResourceReader method): importlib abc – Abstract base classes related to import.
                                                             (line  324)
* is_resource() (in module importlib.resources): importlib resources – Resources.
                                                             (line  120)
* is_resource_enabled() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  197)
* is_running() (asyncio.loop method):    Running and stopping the loop.
                                                             (line   35)
* is_safe (uuid.UUID attribute):         uuid — UUID objects according to RFC 4122.
                                                             (line  146)
* is_serving() (asyncio.Server method):  Server Objects.     (line   74)
* is_set() (asyncio.Event method):       Event.              (line   47)
* is_set() (threading.Event method):     Event Objects.      (line   23)
* is_signed() (decimal.Context method):  Context objects.    (line  319)
* is_signed() (decimal.Decimal method):  Decimal objects.    (line  311)
* is_site_local (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  178)
* is_site_local (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  314)
* is_snan() (decimal.Context method):    Context objects.    (line  323)
* is_snan() (decimal.Decimal method):    Decimal objects.    (line  317)
* is_socket() (pathlib.Path method):     Methods<2>.         (line  151)
* is_subnormal() (decimal.Context method): Context objects.  (line  328)
* is_subnormal() (decimal.Decimal method): Decimal objects.  (line  322)
* is_symlink() (os.DirEntry method):     Files and Directories.
                                                             (line  873)
* is_symlink() (pathlib.Path method):    Methods<2>.         (line  143)
* is_tarfile() (in module tarfile):      tarfile — Read and write tar archive files.
                                                             (line  175)
* is_term_resized() (in module curses):  Functions<3>.       (line  234)
* is_tracing() (in module tracemalloc):  Functions<9>.       (line   43)
* is_tracked() (in module gc):           gc — Garbage Collector interface.
                                                             (line  146)
* is_unspecified (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   97)
* is_unspecified (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   74)
* is_unspecified (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  168)
* is_unspecified (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  259)
* is_wintouched() (curses.window method): Window Objects.    (line  372)
* is_zero() (decimal.Context method):    Context objects.    (line  332)
* is_zero() (decimal.Decimal method):    Decimal objects.    (line  327)
* is_zipfile() (in module zipfile):      zipfile — Work with ZIP archives.
                                                             (line   71)
* item selection:                        The standard type hierarchy.
                                                             (line  109)
* item() (tkinter.ttk.Treeview method):  ttk Treeview.       (line  212)
* item() (xml.dom.NamedNodeMap method):  NamedNodeMap Objects.
                                                             (line   12)
* item() (xml.dom.NodeList method):      NodeList Objects.   (line   15)
* itemgetter() (in module operator):     operator — Standard operators as functions.
                                                             (line  258)
* items() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  235)
* items() (contextvars.Context method):  Manual Context Management.
                                                             (line   83)
* items() (dict method):                 Mapping Types — dict.
                                                             (line  156)
* items() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  238)
* items() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  336)
* items() (mailbox.Mailbox method):      Mailbox objects.    (line  129)
* items() (types.MappingProxyType method): Standard Interpreter Types.
                                                             (line  212)
* items() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line   71)
* itemsize (array.array attribute):      array — Efficient arrays of numeric values.
                                                             (line  108)
* itemsize (memoryview attribute):       Memory Views.       (line  423)
* ItemsView (class in collections.abc):  Collections Abstract Base Classes.
                                                             (line  180)
* ItemsView (class in typing):           Classes functions and decorators.
                                                             (line  245)
* iter() (built-in function):            Built-in Functions. (line  859)
* iter() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  146)
* iter() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   45)
* iterable:                              Glossary.           (line  640)
* Iterable (class in collections.abc):   Collections Abstract Base Classes.
                                                             (line  113)
* Iterable (class in typing):            Classes functions and decorators.
                                                             (line  109)
* iterable; unpacking:                   Expression lists.   (line   16)
* iterator:                              Glossary.           (line  662)
* Iterator (class in collections.abc):   Collections Abstract Base Classes.
                                                             (line  130)
* Iterator (class in typing):            Classes functions and decorators.
                                                             (line  113)
* iterator protocol:                     Iterator Types.     (line    6)
* iterdecode() (in module codecs):       codecs — Codec registry and base classes.
                                                             (line  225)
* iterdir() (pathlib.Path method):       Methods<2>.         (line  186)
* iterdir() (zipfile.Path method):       Path Objects.       (line   30)
* iterdump() (sqlite3.Connection method): Connection Objects.
                                                             (line  385)
* iterencode() (in module codecs):       codecs — Codec registry and base classes.
                                                             (line  213)
* iterencode() (json.JSONEncoder method): Encoders and Decoders.
                                                             (line  215)
* iterfind() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  157)
* iterfind() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   52)
* iteritems() (mailbox.Mailbox method):  Mailbox objects.    (line  129)
* iterkeys() (mailbox.Mailbox method):   Mailbox objects.    (line  107)
* itermonthdates() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   45)
* itermonthdays() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   53)
* itermonthdays2() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   61)
* itermonthdays3() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   69)
* itermonthdays4() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   79)
* iternextfunc (C type):                 Slot Type typedefs. (line   99)
* iterparse() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  117)
* itertext() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  166)
* itertools (2to3 fixer):                Fixers.             (line  173)
* itertools (module):                    itertools — Functions creating iterators for efficient looping.
                                                             (line    6)
* itertools_imports (2to3 fixer):        Fixers.             (line  167)
* itervalues() (mailbox.Mailbox method): Mailbox objects.    (line  114)
* iterweekdays() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   39)
* iter_attachments() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  531)
* iter_child_nodes() (in module ast):    ast Helpers.        (line  107)
* iter_fields() (in module ast):         ast Helpers.        (line  102)
* iter_importers() (in module pkgutil):  pkgutil — Package extension utility.
                                                             (line  122)
* iter_modules() (in module pkgutil):    pkgutil — Package extension utility.
                                                             (line  140)
* iter_parts() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  547)
* iter_unpack() (in module struct):      Functions and Exceptions.
                                                             (line   42)
* iter_unpack() (struct.Struct method):  Classes<2>.         (line   47)
* ItimerError:                           Module contents<2>. (line  103)
* ITIMER_PROF (in module signal):        Module contents<2>. (line   70)
* ITIMER_REAL (in module signal):        Module contents<2>. (line   60)
* ITIMER_VIRTUAL (in module signal):     Module contents<2>. (line   65)
* itruediv() (in module operator):       In-place Operators. (line   99)
* ixor() (in module operator):           In-place Operators. (line  104)
* j; in numeric literal:                 Floating point literals.
                                                             (line   28)
* Jansen, Jack:                          uu — Encode and decode uuencode files.
                                                             (line   20)
* Java; language:                        The standard type hierarchy.
                                                             (line   89)
* java_ver() (in module platform):       Java Platform.      (line    6)
* join() (asyncio.Queue method):         Queue.              (line   50)
* join() (bytearray method):             Bytes and Bytearray Operations.
                                                             (line  111)
* join() (bytes method):                 Bytes and Bytearray Operations.
                                                             (line  111)
* join() (in module os.path):            os path — Common pathname manipulations.
                                                             (line  254)
* join() (in module shlex):              shlex — Simple lexical analysis.
                                                             (line   30)
* join() (multiprocessing.JoinableQueue method): Pipes and Queues.
                                                             (line  242)
* join() (multiprocessing.pool.Pool method): Process Pools.  (line  168)
* join() (multiprocessing.Process method): Process and exceptions.
                                                             (line   51)
* join() (queue.Queue method):           Queue Objects.      (line   83)
* join() (str method):                   String Methods<2>.  (line  279)
* join() (threading.Thread method):      Thread Objects.     (line  110)
* JoinableQueue (class in multiprocessing): Pipes and Queues.
                                                             (line  221)
* joinpath() (pathlib.PurePath method):  Methods and properties.
                                                             (line  198)
* join_thread() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  757)
* join_thread() (multiprocessing.Queue method): Pipes and Queues.
                                                             (line  170)
* json (module):                         json — JSON encoder and decoder.
                                                             (line    6)
* json.tool (module):                    Command Line Interface<2>.
                                                             (line    6)
* json.tool command line option; -h, –help: Command line options<2>.
                                                             (line   31)
* json.tool command line option; –json-lines: Command line options<2>.
                                                             (line   25)
* json.tool command line option; –sort-keys: Command line options<2>.
                                                             (line   19)
* json.tool command line option; infile: Command line options<2>.
                                                             (line    6)
* json.tool command line option; outfile: Command line options<2>.
                                                             (line   14)
* JSONDecodeError:                       Exceptions<13>.     (line    6)
* JSONDecoder (class in json):           Encoders and Decoders.
                                                             (line    6)
* JSONEncoder (class in json):           Encoders and Decoders.
                                                             (line  102)
* js_output() (http.cookies.BaseCookie method): Cookie Objects.
                                                             (line   32)
* js_output() (http.cookies.Morsel method): Morsel Objects.  (line   79)
* jump (pdb command):                    Debugger Commands.  (line  193)
* JUMP_ABSOLUTE (opcode):                Python Bytecode Instructions.
                                                             (line  681)
* JUMP_FORWARD (opcode):                 Python Bytecode Instructions.
                                                             (line  649)
* JUMP_IF_FALSE_OR_POP (opcode):         Python Bytecode Instructions.
                                                             (line  674)
* JUMP_IF_TRUE_OR_POP (opcode):          Python Bytecode Instructions.
                                                             (line  667)
* kbhit() (in module msvcrt):            Console I/O.        (line    6)
* KDEDIR:                                webbrowser — Convenient Web-browser controller.
                                                             (line  184)
* kevent() (in module select):           select — Waiting for I/O completion.
                                                             (line  103)
* key:                                   Dictionary displays.
                                                             (line    6)
* key (http.cookies.Morsel attribute):   Morsel Objects.     (line   60)
* key function:                          Glossary.           (line  684)
* key/datum pair:                        Dictionary displays.
                                                             (line    6)
* KeyboardInterrupt:                     Concrete exceptions.
                                                             (line   70)
* KeyboardInterrupt (built-in exception): Signal Handling<2>.
                                                             (line    8)
* KeyboardInterrupt (built-in exception) <1>: Signal Handling<2>.
                                                             (line   20)
* KeyError:                              Concrete exceptions.
                                                             (line   65)
* keylog_filename (ssl.SSLContext attribute): SSL Contexts.  (line  478)
* keyname() (in module curses):          Functions<3>.       (line  244)
* keypad() (curses.window method):       Window Objects.     (line  377)
* keyrefs() (weakref.WeakKeyDictionary method): weakref — Weak references.
                                                             (line  181)
* keys() (contextvars.Context method):   Manual Context Management.
                                                             (line   75)
* keys() (dict method):                  Mapping Types — dict.
                                                             (line  161)
* keys() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  230)
* keys() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  328)
* keys() (mailbox.Mailbox method):       Mailbox objects.    (line  107)
* keys() (sqlite3.Row method):           Row Objects.        (line   18)
* keys() (types.MappingProxyType method): Standard Interpreter Types.
                                                             (line  217)
* keys() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line   76)
* KeysView (class in collections.abc):   Collections Abstract Base Classes.
                                                             (line  180)
* KeysView (class in typing):            Classes functions and decorators.
                                                             (line  241)
* keyword:                               Keywords.           (line    6)
* keyword (module):                      keyword — Testing for Python keywords.
                                                             (line    6)
* keyword argument:                      Glossary.           (line  706)
* keyword; as:                           The import statement.
                                                             (line    6)
* keyword; as <1>:                       The try statement.  (line    6)
* keyword; as <2>:                       The with statement. (line    6)
* keyword; async:                        Coroutine function definition.
                                                             (line    9)
* keyword; await:                        Calls.              (line  148)
* keyword; await <1>:                    Coroutine function definition.
                                                             (line    9)
* keyword; elif:                         The if statement.   (line    6)
* keyword; else:                         The break statement.
                                                             (line   12)
* keyword; else <1>:                     The if statement.   (line    6)
* keyword; else <2>:                     The while statement.
                                                             (line    6)
* keyword; else <3>:                     The for statement.  (line    6)
* keyword; else <4>:                     The try statement.  (line    6)
* keyword; else <5>:                     The try statement.  (line   78)
* keyword; except:                       The try statement.  (line    6)
* keyword; finally:                      The return statement.
                                                             (line   17)
* keyword; finally <1>:                  The break statement.
                                                             (line   18)
* keyword; finally <2>:                  The continue statement.
                                                             (line    6)
* keyword; finally <3>:                  The try statement.  (line    6)
* keyword; finally <4>:                  The try statement.  (line   84)
* keyword; from:                         Yield expressions.  (line    6)
* keyword; from <1>:                     The import statement.
                                                             (line    6)
* keyword; in:                           The for statement.  (line    6)
* keyword; yield:                        Yield expressions.  (line    6)
* keywords (functools.partial attribute): partial Objects.   (line   20)
* KEY_ALL_ACCESS (in module winreg):     Access Rights.      (line    8)
* KEY_CREATE_LINK (in module winreg):    Access Rights.      (line   51)
* KEY_CREATE_SUB_KEY (in module winreg): Access Rights.      (line   38)
* KEY_ENUMERATE_SUB_KEYS (in module winreg): Access Rights.  (line   42)
* KEY_EXECUTE (in module winreg):        Access Rights.      (line   26)
* KEY_NOTIFY (in module winreg):         Access Rights.      (line   46)
* KEY_QUERY_VALUE (in module winreg):    Access Rights.      (line   30)
* KEY_READ (in module winreg):           Access Rights.      (line   20)
* KEY_SET_VALUE (in module winreg):      Access Rights.      (line   34)
* KEY_WOW64_32KEY (in module winreg):    64-bit Specific.    (line   13)
* KEY_WOW64_64KEY (in module winreg):    64-bit Specific.    (line    8)
* KEY_WRITE (in module winreg):          Access Rights.      (line   15)
* kill() (asyncio.asyncio.subprocess.Process method): Interacting with Subprocesses.
                                                             (line  100)
* kill() (asyncio.SubprocessTransport method): Subprocess Transports.
                                                             (line   35)
* kill() (in module os):                 Process Management. (line  276)
* kill() (multiprocessing.Process method): Process and exceptions.
                                                             (line  167)
* kill() (subprocess.Popen method):      Popen Objects.      (line   83)
* killchar() (in module curses):         Functions<3>.       (line  254)
* killpg() (in module os):               Process Management. (line  295)
* kill_python() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   67)
* kind (inspect.Parameter attribute):    Introspecting callables with the Signature object.
                                                             (line  160)
* knownfiles (in module mimetypes):      mimetypes — Map filenames to MIME types.
                                                             (line  122)
* kqueue() (in module select):           select — Waiting for I/O completion.
                                                             (line   92)
* KqueueSelector (class in selectors):   Classes<3>.         (line  190)
* kwargs (inspect.BoundArguments attribute): Introspecting callables with the Signature object.
                                                             (line  256)
* kwlist (in module keyword):            keyword — Testing for Python keywords.
                                                             (line   17)
* L (in module re):                      Module Contents.    (line   81)
* LabelEntry (class in tkinter.tix):     Basic Widgets.      (line   31)
* LabelFrame (class in tkinter.tix):     Basic Widgets.      (line   37)
* lambda:                                Glossary.           (line  710)
* lambda; expression:                    Lambdas.            (line    6)
* lambda; expression <1>:                Function definitions.
                                                             (line  104)
* lambda; form:                          Lambdas.            (line    6)
* LambdaType (in module types):          Standard Interpreter Types.
                                                             (line   19)
* LANG:                                  GNU gettext API.    (line   21)
* LANG <1>:                              Class-based API.    (line   26)
* LANG <2>:                              locale — Internationalization services.
                                                             (line   48)
* LANG <3>:                              locale — Internationalization services.
                                                             (line  309)
* LANG <4>:                              locale — Internationalization services.
                                                             (line  313)
* LANGUAGE:                              GNU gettext API.    (line   20)
* LANGUAGE <1>:                          Class-based API.    (line   25)
* large files:                           Large File Support. (line    6)
* LARGEST (in module test.support):      test support — Utilities for the Python test suite.
                                                             (line  150)
* LargeZipFile:                          zipfile — Work with ZIP archives.
                                                             (line   37)
* last() (nntplib.NNTP method):          Methods<3>.         (line  213)
* lastChild (xml.dom.Node attribute):    Node Objects.       (line   59)
* lastcmd (cmd.Cmd attribute):           Cmd Objects.        (line  131)
* lastgroup (re.Match attribute):        Match Objects.      (line  186)
* lastindex (re.Match attribute):        Match Objects.      (line  178)
* lastResort (in module logging):        Module-Level Attributes.
                                                             (line    6)
* lastrowid (sqlite3.Cursor attribute):  Cursor Objects.     (line  199)
* last_accepted (multiprocessing.connection.Listener attribute): Listeners and Clients.
                                                             (line  103)
* last_traceback (in module sys):        The standard type hierarchy.
                                                             (line  727)
* last_traceback (in module sys) <1>:    sys — System-specific parameters and functions.
                                                             (line  945)
* last_type (in module sys):             sys — System-specific parameters and functions.
                                                             (line  945)
* last_value (in module sys):            sys — System-specific parameters and functions.
                                                             (line  945)
* layout() (tkinter.ttk.Style method):   Ttk Styling.        (line   70)
* lazycache() (in module linecache):     linecache — Random access to text lines.
                                                             (line   50)
* LazyLoader (class in importlib.util):  importlib util – Utility code for importers.
                                                             (line  225)
* LBRACE (in module token):              token — Constants used with Python parse trees.
                                                             (line  126)
* LBYL:                                  Glossary.           (line  717)
* lchflags() (in module os):             Files and Directories.
                                                             (line  277)
* lchmod() (in module os):               Files and Directories.
                                                             (line  288)
* lchmod() (pathlib.Path method):        Methods<2>.         (line  202)
* lchown() (in module os):               Files and Directories.
                                                             (line  300)
* LC_ALL:                                GNU gettext API.    (line   20)
* LC_ALL <1>:                            Class-based API.    (line   25)
* LC_ALL (in module locale):             locale — Internationalization services.
                                                             (line  494)
* LC_COLLATE (in module locale):         locale — Internationalization services.
                                                             (line  463)
* LC_CTYPE (in module locale):           locale — Internationalization services.
                                                             (line  457)
* LC_MESSAGES:                           GNU gettext API.    (line   20)
* LC_MESSAGES <1>:                       Class-based API.    (line   26)
* LC_MESSAGES (in module locale):        locale — Internationalization services.
                                                             (line  479)
* LC_MONETARY (in module locale):        locale — Internationalization services.
                                                             (line  474)
* LC_NUMERIC (in module locale):         locale — Internationalization services.
                                                             (line  486)
* LC_TIME (in module locale):            locale — Internationalization services.
                                                             (line  469)
* LDCXXSHARED:                           Build and C API Changes<8>.
                                                             (line  153)
* ldexp() (in module math):              Number-theoretic and representation functions.
                                                             (line  167)
* LDFLAGS:                               New Improved and Deprecated Modules<4>.
                                                             (line   59)
* ldgettext() (in module gettext):       GNU gettext API.    (line   90)
* ldngettext() (in module gettext):      GNU gettext API.    (line   94)
* le() (in module operator):             operator — Standard operators as functions.
                                                             (line   24)
* leading whitespace:                    Indentation.        (line    6)
* leapdays() (in module calendar):       calendar — General calendar-related functions.
                                                             (line  306)
* leaveok() (curses.window method):      Window Objects.     (line  384)
* left (filecmp.dircmp attribute):       The dircmp class.   (line   41)
* left() (in module turtle):             Turtle motion.      (line   42)
* LEFTSHIFT (in module token):           token — Constants used with Python parse trees.
                                                             (line  158)
* LEFTSHIFTEQUAL (in module token):      token — Constants used with Python parse trees.
                                                             (line  202)
* left_list (filecmp.dircmp attribute):  The dircmp class.   (line   49)
* left_only (filecmp.dircmp attribute):  The dircmp class.   (line   63)
* len() (built-in function):             Built-in Functions. (line  886)
* lenfunc (C type):                      Slot Type typedefs. (line  103)
* length (xml.dom.NamedNodeMap attribute): NamedNodeMap Objects.
                                                             (line    8)
* length (xml.dom.NodeList attribute):   NodeList Objects.   (line   21)
* length_hint() (in module operator):    operator — Standard operators as functions.
                                                             (line  206)
* LESS (in module token):                token — Constants used with Python parse trees.
                                                             (line  106)
* LESSEQUAL (in module token):           token — Constants used with Python parse trees.
                                                             (line  142)
* lexical analysis:                      Lexical analysis.   (line    6)
* lexical definitions:                   Notation.           (line   31)
* lexists() (in module os.path):         os path — Common pathname manipulations.
                                                             (line  127)
* lgamma() (in module math):             Special functions.  (line   35)
* lgettext() (gettext.GNUTranslations method): The GNUTranslations class.
                                                             (line   88)
* lgettext() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   63)
* lgettext() (in module gettext):        GNU gettext API.    (line   88)
* lib2to3 (module):                      lib2to3 - 2to3’s library.
                                                             (line    6)
* libc_ver() (in module platform):       Unix Platforms.     (line    6)
* library (in module dbm.ndbm):          dbm ndbm — Interface based on ndbm.
                                                             (line   27)
* library (ssl.SSLError attribute):      Exceptions<12>.     (line   19)
* LibraryLoader (class in ctypes):       Loading shared libraries.
                                                             (line  137)
* library_dir_option() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  220)
* library_filename() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  459)
* library_option() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  225)
* license (built-in variable):           Constants added by the site module.
                                                             (line   24)
* LifoQueue (class in asyncio):          LIFO Queue.         (line    6)
* LifoQueue (class in queue):            queue — A synchronized queue class.
                                                             (line   42)
* light-weight processes:                _thread — Low-level threading API.
                                                             (line    6)
* LimitOverrunError:                     Exceptions<9>.      (line   59)
* limit_denominator() (fractions.Fraction method): fractions — Rational numbers.
                                                             (line  126)
* lin2adpcm() (in module audioop):       audioop — Manipulate raw audio data.
                                                             (line  112)
* lin2alaw() (in module audioop):        audioop — Manipulate raw audio data.
                                                             (line  126)
* lin2lin() (in module audioop):         audioop — Manipulate raw audio data.
                                                             (line  133)
* lin2ulaw() (in module audioop):        audioop — Manipulate raw audio data.
                                                             (line  147)
* line (C function):                     Available static markers.
                                                             (line   33)
* line continuation:                     Explicit line joining.
                                                             (line    6)
* line joining:                          Logical lines.      (line    6)
* line joining <1>:                      Explicit line joining.
                                                             (line    6)
* line structure:                        Line structure.     (line    6)
* line() (msilib.Dialog method):         GUI classes.        (line   64)
* line-buffered I/O:                     Built-in Functions. (line 1212)
* linecache (module):                    linecache — Random access to text lines.
                                                             (line    6)
* lineno (ast.AST attribute):            Node classes.       (line   39)
* lineno (doctest.DocTest attribute):    DocTest Objects.    (line   42)
* lineno (doctest.Example attribute):    Example Objects.    (line   41)
* lineno (json.JSONDecodeError attribute): Exceptions<13>.   (line   23)
* lineno (pyclbr.Class attribute):       Class Objects<2>.   (line   21)
* lineno (pyclbr.Function attribute):    Function Objects.   (line   21)
* lineno (re.error attribute):           Module Contents.    (line  375)
* lineno (shlex.shlex attribute):        shlex Objects.      (line  169)
* lineno (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   46)
* lineno (tracemalloc.Filter attribute): Filter.             (line   48)
* lineno (tracemalloc.Frame attribute):  Frame.              (line   17)
* lineno (xml.parsers.expat.ExpatError attribute): ExpatError Exceptions.
                                                             (line   21)
* lineno() (in module fileinput):        fileinput — Iterate over lines from multiple input streams.
                                                             (line   92)
* LINES:                                 curses<2>.          (line    6)
* LINES <1>:                             Functions<3>.       (line  124)
* LINES <2>:                             Functions<3>.       (line  523)
* LINES <3>:                             Functions<3>.       (line  547)
* LINES <4>:                             Functions<3>.       (line  549)
* lines (os.terminal_size attribute):    Querying the size of a terminal.
                                                             (line   34)
* linesep (email.policy.Policy attribute): email policy Policy Objects.
                                                             (line  130)
* linesep (in module os):                Miscellaneous System Information.
                                                             (line  127)
* lineterminator (csv.Dialect attribute): Dialects and Formatting Parameters.
                                                             (line   43)
* LineTooLong:                           http client — HTTP protocol client.
                                                             (line  176)
* line_buffering (io.TextIOWrapper attribute): Text I/O<2>.  (line  162)
* line_num (csv.csvreader attribute):    Reader Objects.     (line   22)
* link() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  349)
* link() (in module os):                 Files and Directories.
                                                             (line  311)
* linkname (tarfile.TarInfo attribute):  TarInfo Objects.    (line   67)
* link_executable() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  401)
* link_shared_lib() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  411)
* link_shared_object() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  422)
* link_to() (pathlib.Path method):       Methods<2>.         (line  417)
* list:                                  Glossary.           (line  731)
* list (built-in class):                 Lists<2>.           (line   10)
* List (class in typing):                Classes functions and decorators.
                                                             (line  216)
* list (pdb command):                    Debugger Commands.  (line  203)
* list comprehension:                    Glossary.           (line  737)
* list() (imaplib.IMAP4 method):         IMAP4 Objects.      (line  126)
* list() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  209)
* list() (nntplib.NNTP method):          Methods<3>.         (line   97)
* list() (poplib.POP3 method):           POP3 Objects.       (line   56)
* list() (tarfile.TarFile method):       TarFile Objects.    (line  120)
* list; comprehensions:                  List displays.      (line    6)
* list; display:                         List displays.      (line    6)
* listdir() (in module os):              Files and Directories.
                                                             (line  330)
* listen() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  213)
* listen() (in module logging.config):   Configuration functions.
                                                             (line  108)
* listen() (in module turtle):           Using screen events.
                                                             (line    6)
* listen() (socket.socket method):       Socket Objects.     (line  186)
* Listener (class in multiprocessing.connection): Listeners and Clients.
                                                             (line   50)
* listMethods() (xmlrpc.client.ServerProxy.system method): ServerProxy Objects.
                                                             (line   17)
* ListNoteBook (class in tkinter.tix):   Manager Widgets.    (line   13)
* listxattr() (in module os):            Linux extended attributes.
                                                             (line   23)
* LIST_APPEND (opcode):                  Python Bytecode Instructions.
                                                             (line  322)
* list_dialects() (in module csv):       Module Contents<3>. (line   91)
* list_folders() (mailbox.Maildir method): Maildir.          (line   60)
* list_folders() (mailbox.MH method):    MH.                 (line   32)
* literal:                               Literals.           (line    6)
* literal <1>:                           Literals<2>.        (line    6)
* Literal (in module typing):            Classes functions and decorators.
                                                             (line  730)
* literal_eval() (in module ast):        ast Helpers.        (line   43)
* LittleEndianStructure (class in ctypes): Structured data types.
                                                             (line   14)
* ljust() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  248)
* ljust() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  248)
* ljust() (str method):                  String Methods<2>.  (line  287)
* LK_LOCK (in module msvcrt):            File Operations.    (line   16)
* LK_NBLCK (in module msvcrt):           File Operations.    (line   24)
* LK_NBRLCK (in module msvcrt):          File Operations.    (line   24)
* LK_RLCK (in module msvcrt):            File Operations.    (line   16)
* LK_UNLCK (in module msvcrt):           File Operations.    (line   30)
* ll (pdb command):                      Debugger Commands.  (line  219)
* LMTP (class in smtplib):               smtplib — SMTP protocol client.
                                                             (line   95)
* ln() (decimal.Context method):         Context objects.    (line  336)
* ln() (decimal.Decimal method):         Decimal objects.    (line  332)
* LNAME:                                 getpass — Portable password input.
                                                             (line   38)
* lngettext() (gettext.GNUTranslations method): The GNUTranslations class.
                                                             (line   90)
* lngettext() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   65)
* lngettext() (in module gettext):       GNU gettext API.    (line   92)
* load() (http.cookiejar.FileCookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line  125)
* load() (http.cookies.BaseCookie method): Cookie Objects.   (line   40)
* load() (in module json):               Basic Usage.        (line   94)
* load() (in module marshal):            marshal — Internal Python object serialization.
                                                             (line   60)
* load() (in module pickle):             Module Interface.   (line   58)
* load() (in module plistlib):           plistlib — Generate and parse Mac OS X plist files.
                                                             (line   44)
* load() (pickle.Unpickler method):      Module Interface.   (line  266)
* load() (tracemalloc.Snapshot class method): Snapshot.      (line   50)
* loader:                                Finders and loaders.
                                                             (line    6)
* loader <1>:                            Glossary.           (line  746)
* Loader (class in importlib.abc):       importlib abc – Abstract base classes related to import.
                                                             (line  149)
* loader (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  370)
* LoadError:                             http cookiejar — Cookie handling for HTTP clients.
                                                             (line   34)
* loader_state (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  394)
* LoadKey() (in module winreg):          Functions<11>.      (line  262)
* LoadLibrary() (ctypes.LibraryLoader method): Loading shared libraries.
                                                             (line  148)
* loads() (in module json):              Basic Usage.        (line  149)
* loads() (in module marshal):           marshal — Internal Python object serialization.
                                                             (line   82)
* loads() (in module pickle):            Module Interface.   (line   76)
* loads() (in module plistlib):          plistlib — Generate and parse Mac OS X plist files.
                                                             (line   77)
* loads() (in module xmlrpc.client):     Convenience Functions.
                                                             (line   19)
* loadTestsFromModule() (unittest.TestLoader method): Loading and running tests.
                                                             (line   41)
* loadTestsFromName() (unittest.TestLoader method): Loading and running tests.
                                                             (line   70)
* loadTestsFromNames() (unittest.TestLoader method): Loading and running tests.
                                                             (line  104)
* loadTestsFromTestCase() (unittest.TestLoader method): Loading and running tests.
                                                             (line   29)
* LOAD_ATTR (opcode):                    Python Bytecode Instructions.
                                                             (line  625)
* LOAD_BUILD_CLASS (opcode):             Python Bytecode Instructions.
                                                             (line  433)
* load_cert_chain() (ssl.SSLContext method): SSL Contexts.   (line   79)
* LOAD_CLASSDEREF (opcode):              Python Bytecode Instructions.
                                                             (line  736)
* LOAD_CLOSURE (opcode):                 Python Bytecode Instructions.
                                                             (line  723)
* LOAD_CONST (opcode):                   Python Bytecode Instructions.
                                                             (line  527)
* load_default_certs() (ssl.SSLContext method): SSL Contexts.
                                                             (line  110)
* LOAD_DEREF (opcode):                   Python Bytecode Instructions.
                                                             (line  730)
* load_dh_params() (ssl.SSLContext method): SSL Contexts.    (line  314)
* load_extension() (sqlite3.Connection method): Connection Objects.
                                                             (line  291)
* LOAD_FAST (opcode):                    Python Bytecode Instructions.
                                                             (line  710)
* LOAD_GLOBAL (opcode):                  Python Bytecode Instructions.
                                                             (line  692)
* LOAD_METHOD (opcode):                  Python Bytecode Instructions.
                                                             (line  817)
* load_module() (importlib.abc.FileLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  482)
* load_module() (importlib.abc.InspectLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  435)
* load_module() (importlib.abc.Loader method): importlib abc – Abstract base classes related to import.
                                                             (line  186)
* load_module() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  582)
* load_module() (importlib.machinery.SourceFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  243)
* load_module() (importlib.machinery.SourcelessFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  287)
* load_module() (in module imp):         imp — Access the import internals.
                                                             (line   90)
* load_module() (zipimport.zipimporter method): zipimporter Objects.
                                                             (line   62)
* LOAD_NAME (opcode):                    Python Bytecode Instructions.
                                                             (line  531)
* load_package_tests() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  862)
* load_verify_locations() (ssl.SSLContext method): SSL Contexts.
                                                             (line  127)
* local (class in threading):            Thread-Local Data.  (line   14)
* localcontext() (in module decimal):    Context objects.    (line   25)
* LOCALE (in module re):                 Module Contents.    (line   81)
* locale (module):                       locale — Internationalization services.
                                                             (line    6)
* localeconv() (in module locale):       locale — Internationalization services.
                                                             (line   52)
* LocaleHTMLCalendar (class in calendar): calendar — General calendar-related functions.
                                                             (line  272)
* LocaleTextCalendar (class in calendar): calendar — General calendar-related functions.
                                                             (line  264)
* localName (xml.dom.Attr attribute):    Attr Objects.       (line   13)
* localName (xml.dom.Node attribute):    Node Objects.       (line   64)
* locals() (built-in function):          Built-in Functions. (line  898)
* localtime() (in module email.utils):   email utils Miscellaneous utilities.
                                                             (line   13)
* localtime() (in module time):          Functions<2>.       (line  143)
* Locator (class in xml.sax.xmlreader):  xml sax xmlreader — Interface for XML parsers.
                                                             (line   43)
* Lock (class in asyncio):               Lock.               (line    6)
* Lock (class in multiprocessing):       Synchronization primitives.
                                                             (line   46)
* Lock (class in threading):             Lock Objects.       (line   33)
* lock() (mailbox.Babyl method):         Babyl.              (line   59)
* lock() (mailbox.Mailbox method):       Mailbox objects.    (line  249)
* lock() (mailbox.Maildir method):       Maildir.            (line  106)
* lock() (mailbox.mbox method):          mbox.               (line   39)
* lock() (mailbox.MH method):            MH.                 (line   84)
* lock() (mailbox.MMDF method):          MMDF.               (line   35)
* Lock() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  166)
* lock, interpreter:                     Thread State and the Global Interpreter Lock.
                                                             (line    6)
* locked() (asyncio.Condition method):   Condition.          (line   53)
* locked() (asyncio.Lock method):        Lock.               (line   48)
* locked() (asyncio.Semaphore method):   Semaphore.          (line   40)
* locked() (threading.Lock method):      Lock Objects.       (line   87)
* locked() (_thread.lock method):        _thread — Low-level threading API.
                                                             (line  156)
* lockf() (in module fcntl):             fcntl — The fcntl and ioctl system calls.
                                                             (line  102)
* lockf() (in module os):                File Descriptor Operations.
                                                             (line  208)
* locking() (in module msvcrt):          File Operations.    (line    6)
* LockType (in module _thread):          _thread — Low-level threading API.
                                                             (line   28)
* lock_held() (in module imp):           imp — Access the import internals.
                                                             (line  254)
* log() (in module cmath):               Power and logarithmic functions<2>.
                                                             (line   11)
* log() (in module logging):             Module-Level Functions.
                                                             (line  146)
* log() (in module math):                Power and logarithmic functions.
                                                             (line   28)
* log() (logging.Logger method):         Logger Objects.     (line  234)
* log10() (decimal.Context method):      Context objects.    (line  340)
* log10() (decimal.Decimal method):      Decimal objects.    (line  338)
* log10() (in module cmath):             Power and logarithmic functions<2>.
                                                             (line   18)
* log10() (in module math):              Power and logarithmic functions.
                                                             (line   55)
* log1p() (in module math):              Power and logarithmic functions.
                                                             (line   36)
* log2() (in module math):               Power and logarithmic functions.
                                                             (line   41)
* logb() (decimal.Context method):       Context objects.    (line  344)
* logb() (decimal.Decimal method):       Decimal objects.    (line  344)
* Logger (class in logging):             Logger Objects.     (line   23)
* LoggerAdapter (class in logging):      LoggerAdapter Objects.
                                                             (line   11)
* logging (module):                      logging — Logging facility for Python.
                                                             (line    6)
* logging.config (module):               logging config — Logging configuration.
                                                             (line    6)
* logging.handlers (module):             logging handlers — Logging handlers.
                                                             (line    6)
* logical line:                          Logical lines.      (line    6)
* logical_and() (decimal.Context method): Context objects.   (line  348)
* logical_and() (decimal.Decimal method): Decimal objects.   (line  352)
* logical_invert() (decimal.Context method): Context objects.
                                                             (line  353)
* logical_invert() (decimal.Decimal method): Decimal objects.
                                                             (line  358)
* logical_or() (decimal.Context method): Context objects.    (line  357)
* logical_or() (decimal.Decimal method): Decimal objects.    (line  363)
* logical_xor() (decimal.Context method): Context objects.   (line  362)
* logical_xor() (decimal.Decimal method): Decimal objects.   (line  369)
* login() (ftplib.FTP method):           FTP Objects.        (line   48)
* login() (imaplib.IMAP4 method):        IMAP4 Objects.      (line  132)
* login() (nntplib.NNTP method):         Methods<3>.         (line   46)
* login() (smtplib.SMTP method):         SMTP Objects.       (line  102)
* login_cram_md5() (imaplib.IMAP4 method): IMAP4 Objects.    (line  137)
* LOGNAME:                               Process Parameters. (line  221)
* LOGNAME <1>:                           getpass — Portable password input.
                                                             (line   38)
* lognormvariate() (in module random):   Real-valued distributions.
                                                             (line   63)
* logout() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  143)
* LogRecord (class in logging):          LogRecord Objects.  (line   11)
* log_date_time_string() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  316)
* log_error() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  285)
* log_exception() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  208)
* log_message() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  291)
* log_request() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  278)
* log_to_stderr() (in module multiprocessing): Logging<2>.   (line   24)
* long (2to3 fixer):                     Fixers.             (line  180)
* longMessage (unittest.TestCase attribute): Test cases.     (line  653)
* longname() (in module curses):         Functions<3>.       (line  261)
* LONG_MAX:                              Integer Objects.    (line  112)
* lookup() (in module codecs):           codecs — Codec registry and base classes.
                                                             (line   47)
* lookup() (in module unicodedata):      unicodedata — Unicode Database.
                                                             (line   16)
* lookup() (symtable.SymbolTable method): Examining Symbol Tables.
                                                             (line   52)
* lookup() (tkinter.ttk.Style method):   Ttk Styling.        (line   57)
* LookupError:                           Base classes.       (line   54)
* lookup_error() (in module codecs):     Error Handlers.     (line  117)
* loop control; target:                  The break statement.
                                                             (line   12)
* loop() (in module asyncore):           asyncore — Asynchronous socket handler.
                                                             (line   49)
* loop; over mutable sequence:           The for statement.  (line   44)
* loop; statement:                       The break statement.
                                                             (line    6)
* loop; statement <1>:                   The continue statement.
                                                             (line    6)
* loop; statement <2>:                   The while statement.
                                                             (line    6)
* loop; statement <3>:                   The for statement.  (line    6)
* lower() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  553)
* lower() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  553)
* lower() (str method):                  String Methods<2>.  (line  294)
* LPAR (in module token):                token — Constants used with Python parse trees.
                                                             (line   54)
* lpAttributeList (subprocess.STARTUPINFO attribute): Windows Popen Helpers.
                                                             (line   59)
* lru_cache() (in module functools):     functools — Higher-order functions and operations on callable objects.
                                                             (line   73)
* lseek() (in module os):                File Descriptor Operations.
                                                             (line  231)
* lshift() (in module operator):         operator — Standard operators as functions.
                                                             (line  106)
* LSQB (in module token):                token — Constants used with Python parse trees.
                                                             (line   62)
* lstat() (in module os):                Files and Directories.
                                                             (line  365)
* lstat() (pathlib.Path method):         Methods<2>.         (line  208)
* lstrip() (bytearray method):           Bytes and Bytearray Operations.
                                                             (line  260)
* lstrip() (bytes method):               Bytes and Bytearray Operations.
                                                             (line  260)
* lstrip() (str method):                 String Methods<2>.  (line  302)
* lsub() (imaplib.IMAP4 method):         IMAP4 Objects.      (line  150)
* lt() (in module operator):             operator — Standard operators as functions.
                                                             (line   24)
* lt() (in module turtle):               Turtle motion.      (line   42)
* LWPCookieJar (class in http.cookiejar): FileCookieJar subclasses and co-operation with web browsers.
                                                             (line   28)
* lzma (module):                         lzma — Compression using the LZMA algorithm.
                                                             (line    6)
* LZMACompressor (class in lzma):        Compressing and decompressing data in memory.
                                                             (line    6)
* LZMADecompressor (class in lzma):      Compressing and decompressing data in memory.
                                                             (line  100)
* LZMAError:                             lzma — Compression using the LZMA algorithm.
                                                             (line   24)
* LZMAFile (class in lzma):              Reading and writing compressed files.
                                                             (line   45)
* M (in module re):                      Module Contents.    (line  101)
* machine() (in module platform):        Cross Platform.     (line   36)
* macros (netrc.netrc attribute):        netrc Objects.      (line   29)
* mac_ver() (in module platform):        Mac OS Platform.    (line    6)
* madvise() (mmap.mmap method):          mmap — Memory-mapped file support.
                                                             (line  170)
* MADV_AUTOSYNC (in module mmap):        MADV_* Constants.   (line    6)
* MADV_CORE (in module mmap):            MADV_* Constants.   (line    6)
* MADV_DODUMP (in module mmap):          MADV_* Constants.   (line    6)
* MADV_DOFORK (in module mmap):          MADV_* Constants.   (line    6)
* MADV_DONTDUMP (in module mmap):        MADV_* Constants.   (line    6)
* MADV_DONTFORK (in module mmap):        MADV_* Constants.   (line    6)
* MADV_DONTNEED (in module mmap):        MADV_* Constants.   (line    6)
* MADV_FREE (in module mmap):            MADV_* Constants.   (line    6)
* MADV_HUGEPAGE (in module mmap):        MADV_* Constants.   (line    6)
* MADV_HWPOISON (in module mmap):        MADV_* Constants.   (line    6)
* MADV_MERGEABLE (in module mmap):       MADV_* Constants.   (line    6)
* MADV_NOCORE (in module mmap):          MADV_* Constants.   (line    6)
* MADV_NOHUGEPAGE (in module mmap):      MADV_* Constants.   (line    6)
* MADV_NORMAL (in module mmap):          MADV_* Constants.   (line    6)
* MADV_NOSYNC (in module mmap):          MADV_* Constants.   (line    6)
* MADV_PROTECT (in module mmap):         MADV_* Constants.   (line    6)
* MADV_RANDOM (in module mmap):          MADV_* Constants.   (line    6)
* MADV_REMOVE (in module mmap):          MADV_* Constants.   (line    6)
* MADV_SEQUENTIAL (in module mmap):      MADV_* Constants.   (line    6)
* MADV_SOFT_OFFLINE (in module mmap):    MADV_* Constants.   (line    6)
* MADV_UNMERGEABLE (in module mmap):     MADV_* Constants.   (line    6)
* MADV_WILLNEED (in module mmap):        MADV_* Constants.   (line    6)
* magic method:                          Glossary.           (line  753)
* magic; method:                         Glossary.           (line  757)
* MagicMock (class in unittest.mock):    Magic Mock.         (line    9)
* MAGIC_NUMBER (in module importlib.util): importlib util – Utility code for importers.
                                                             (line   13)
* Mailbox (class in mailbox):            Mailbox objects.    (line    6)
* mailbox (module):                      mailbox — Manipulate mailboxes in various formats.
                                                             (line    6)
* mailcap (module):                      mailcap — Mailcap file handling.
                                                             (line    6)
* Maildir (class in mailbox):            Maildir.            (line    6)
* MaildirMessage (class in mailbox):     MaildirMessage.     (line    6)
* mailfrom (smtpd.SMTPChannel attribute): SMTPChannel Objects.
                                                             (line   74)
* MailmanProxy (class in smtpd):         MailmanProxy Objects.
                                                             (line    6)
* main():                                Process-wide parameters.
                                                             (line    9)
* main() <1>:                            Process-wide parameters.
                                                             (line   36)
* main() <2>:                            Process-wide parameters.
                                                             (line  217)
* main() (in module py_compile):         py_compile — Compile Python source files.
                                                             (line  124)
* main() (in module site):               Module contents<3>. (line   41)
* main() (in module unittest):           Loading and running tests.
                                                             (line  487)
* mainloop() (in module turtle):         Using screen events.
                                                             (line   88)
* maintype (email.headerregistry.ContentTypeHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  274)
* main_thread() (in module threading):   threading — Thread-based parallelism.
                                                             (line  105)
* major (email.headerregistry.MIMEVersionHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  245)
* major() (in module os):                Files and Directories.
                                                             (line  498)
* makedev() (in module os):              Files and Directories.
                                                             (line  508)
* makedirs() (in module os):             Files and Directories.
                                                             (line  420)
* makeelement() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  174)
* makefile() (socket method):            The standard type hierarchy.
                                                             (line  600)
* makefile() (socket.socket method):     Socket Objects.     (line  196)
* makeLogRecord() (in module logging):   Module-Level Functions.
                                                             (line  223)
* makePickle() (logging.handlers.SocketHandler method): SocketHandler.
                                                             (line   45)
* makeRecord() (logging.Logger method):  Logger Objects.     (line  295)
* makeSocket() (logging.handlers.DatagramHandler method): DatagramHandler.
                                                             (line   28)
* makeSocket() (logging.handlers.SocketHandler method): SocketHandler.
                                                             (line   39)
* maketrans() (bytearray static method): Bytes and Bytearray Operations.
                                                             (line  121)
* maketrans() (bytes static method):     Bytes and Bytearray Operations.
                                                             (line  121)
* maketrans() (str static method):       String Methods<2>.  (line  315)
* make_alternative() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  578)
* make_archive() (in module distutils.archive_util): distutils archive_util — Archiving utilities.
                                                             (line    9)
* make_archive() (in module shutil):     Archiving operations.
                                                             (line   14)
* make_bad_fd() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  656)
* make_cookies() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   60)
* make_dataclass() (in module dataclasses): Module-level decorators classes and functions.
                                                             (line  271)
* make_file() (difflib.HtmlDiff method): difflib — Helpers for computing deltas.
                                                             (line  111)
* MAKE_FUNCTION (opcode):                Python Bytecode Instructions.
                                                             (line  838)
* make_header() (in module email.header): email header Internationalized headers.
                                                             (line  192)
* make_legacy_pyc() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  190)
* make_mixed() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  588)
* make_msgid() (in module email.utils):  email utils Miscellaneous utilities.
                                                             (line   29)
* make_parser() (in module xml.sax):     xml sax — Support for SAX2 parsers.
                                                             (line   28)
* make_pkg() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   87)
* make_related() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  569)
* make_script() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   72)
* make_server() (in module wsgiref.simple_server): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   14)
* make_table() (difflib.HtmlDiff method): difflib — Helpers for computing deltas.
                                                             (line  143)
* make_tarball() (in module distutils.archive_util): distutils archive_util — Archiving utilities.
                                                             (line   25)
* make_zipfile() (in module distutils.archive_util): distutils archive_util — Archiving utilities.
                                                             (line   39)
* make_zip_pkg() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   94)
* make_zip_script() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   79)
* malloc():                              Overview<3>.        (line   33)
* mangle_from_ (email.policy.Compat32 attribute): email policy Policy Objects.
                                                             (line  537)
* mangle_from_ (email.policy.Policy attribute): email policy Policy Objects.
                                                             (line  164)
* map (2to3 fixer):                      Fixers.             (line  184)
* map() (built-in function):             Built-in Functions. (line  910)
* map() (concurrent.futures.Executor method): Executor Objects.
                                                             (line   20)
* map() (multiprocessing.pool.Pool method): Process Pools.   (line   78)
* map() (tkinter.ttk.Style method):      Ttk Styling.        (line   37)
* mapLogRecord() (logging.handlers.HTTPHandler method): HTTPHandler.
                                                             (line   27)
* mapping:                               Glossary.           (line  757)
* Mapping (class in collections.abc):    Collections Abstract Base Classes.
                                                             (line  175)
* Mapping (class in typing):             Classes functions and decorators.
                                                             (line  179)
* mapping() (msilib.Control method):     GUI classes.        (line   20)
* MappingProxyType (class in types):     Standard Interpreter Types.
                                                             (line  173)
* MappingView (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  180)
* MappingView (class in typing):         Classes functions and decorators.
                                                             (line  237)
* mapPriority() (logging.handlers.SysLogHandler method): SysLogHandler.
                                                             (line  183)
* maps (collections.ChainMap attribute): ChainMap objects.   (line   39)
* maps() (in module nis):                nis — Interface to Sun’s NIS Yellow Pages.
                                                             (line   41)
* MAP_ADD (opcode):                      Python Bytecode Instructions.
                                                             (line  327)
* map_async() (multiprocessing.pool.Pool method): Process Pools.
                                                             (line   95)
* map_table_b2() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   50)
* map_table_b3() (in module stringprep): stringprep — Internet String Preparation.
                                                             (line   55)
* map_to_type() (email.headerregistry.HeaderRegistry method): email headerregistry Custom Header Objects.
                                                             (line  374)
* marshal (module):                      marshal — Internal Python object serialization.
                                                             (line    6)
* marshalling; objects:                  pickle — Python object serialization.
                                                             (line    8)
* masking; operations:                   Bitwise Operations on Integer Types.
                                                             (line    6)
* Match (class in typing):               Classes functions and decorators.
                                                             (line  407)
* match() (in module nis):               nis — Interface to Sun’s NIS Yellow Pages.
                                                             (line   16)
* match() (in module re):                Module Contents.    (line  152)
* match() (pathlib.PurePath method):     Methods and properties.
                                                             (line  212)
* match() (re.Pattern method):           Regular Expression Objects.
                                                             (line   37)
* Matcher (class in test.support):       test support — Utilities for the Python test suite.
                                                             (line 1018)
* matches() (test.support.Matcher method): test support — Utilities for the Python test suite.
                                                             (line 1020)
* match_hostname() (in module ssl):      Certificate handling.
                                                             (line    6)
* match_test() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  246)
* match_value() (test.support.Matcher method): test support — Utilities for the Python test suite.
                                                             (line 1024)
* math (module):                         math — Mathematical functions.
                                                             (line    6)
* matmul() (in module operator):         operator — Standard operators as functions.
                                                             (line  121)
* matrix multiplication:                 Binary arithmetic operations.
                                                             (line   23)
* max (datetime.date attribute):         date Objects.       (line   91)
* max (datetime.datetime attribute):     datetime Objects.   (line  253)
* max (datetime.time attribute):         time Objects.       (line   37)
* max (datetime.timedelta attribute):    timedelta Objects.  (line   78)
* max() (built-in function):             Built-in Functions. (line  920)
* max() (decimal.Context method):        Context objects.    (line  367)
* max() (decimal.Decimal method):        Decimal objects.    (line  375)
* max() (in module audioop):             audioop — Manipulate raw audio data.
                                                             (line  154)
* maxarray (reprlib.Repr attribute):     Repr Objects.       (line   15)
* maxdeque (reprlib.Repr attribute):     Repr Objects.       (line   15)
* maxdict (reprlib.Repr attribute):      Repr Objects.       (line   15)
* maxDiff (unittest.TestCase attribute): Test cases.         (line  670)
* maxfrozenset (reprlib.Repr attribute): Repr Objects.       (line   15)
* MAXIMUM_SUPPORTED (ssl.TLSVersion attribute): Constants<9>.
                                                             (line  522)
* maximum_version (ssl.SSLContext attribute): SSL Contexts.  (line  491)
* maxlen (collections.deque attribute):  deque objects.      (line  120)
* maxlevel (reprlib.Repr attribute):     Repr Objects.       (line   10)
* maxlist (reprlib.Repr attribute):      Repr Objects.       (line   15)
* maxlong (reprlib.Repr attribute):      Repr Objects.       (line   27)
* maxother (reprlib.Repr attribute):     Repr Objects.       (line   40)
* maxpp() (in module audioop):           audioop — Manipulate raw audio data.
                                                             (line  159)
* maxset (reprlib.Repr attribute):       Repr Objects.       (line   15)
* maxsize (asyncio.Queue attribute):     Queue.              (line   24)
* maxsize (in module sys):               sys — System-specific parameters and functions.
                                                             (line  961)
* maxstring (reprlib.Repr attribute):    Repr Objects.       (line   32)
* maxtuple (reprlib.Repr attribute):     Repr Objects.       (line   15)
* maxunicode (in module sys):            sys — System-specific parameters and functions.
                                                             (line  967)
* MAXYEAR (in module datetime):          Constants.          (line   13)
* max_count (email.headerregistry.BaseHeader attribute): email headerregistry Custom Header Objects.
                                                             (line   60)
* MAX_EMAX (in module decimal):          Constants<4>.       (line   16)
* MAX_INTERPOLATION_DEPTH (in module configparser): ConfigParser Objects.
                                                             (line  321)
* max_lines (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  258)
* max_line_length (email.policy.Policy attribute): email policy Policy Objects.
                                                             (line  123)
* max_mag() (decimal.Context method):    Context objects.    (line  371)
* max_mag() (decimal.Decimal method):    Decimal objects.    (line  382)
* max_memuse (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line  122)
* MAX_PREC (in module decimal):          Constants<4>.       (line   13)
* max_prefixlen (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   38)
* max_prefixlen (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   65)
* max_prefixlen (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  160)
* max_prefixlen (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  253)
* MAX_Py_ssize_t (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  118)
* mbox (class in mailbox):               mbox.               (line    6)
* mboxMessage (class in mailbox):        mboxMessage.        (line    6)
* MB_ICONASTERISK (in module winsound):  winsound — Sound-playing interface for Windows.
                                                             (line  122)
* MB_ICONEXCLAMATION (in module winsound): winsound — Sound-playing interface for Windows.
                                                             (line  126)
* MB_ICONHAND (in module winsound):      winsound — Sound-playing interface for Windows.
                                                             (line  130)
* MB_ICONQUESTION (in module winsound):  winsound — Sound-playing interface for Windows.
                                                             (line  134)
* MB_OK (in module winsound):            winsound — Sound-playing interface for Windows.
                                                             (line  138)
* mean (statistics.NormalDist attribute): NormalDist objects.
                                                             (line   21)
* mean() (in module statistics):         Function details.   (line   10)
* median (statistics.NormalDist attribute): NormalDist objects.
                                                             (line   26)
* median() (in module statistics):       Function details.   (line  121)
* median_grouped() (in module statistics): Function details. (line  184)
* median_high() (in module statistics):  Function details.   (line  166)
* median_low() (in module statistics):   Function details.   (line  148)
* MemberDescriptorType (in module types): Standard Interpreter Types.
                                                             (line  162)
* membership; test:                      Membership test operations.
                                                             (line   37)
* memfd_create() (in module os):         Files and Directories.
                                                             (line 1576)
* memmove() (in module ctypes):          Utility functions.  (line  137)
* MemoryBIO (class in ssl):              Memory BIO Support<2>.
                                                             (line  128)
* MemoryError:                           Concrete exceptions.
                                                             (line   78)
* MemoryHandler (class in logging.handlers): MemoryHandler.  (line   40)
* memoryview (built-in class):           Memory Views.       (line   10)
* memset() (in module ctypes):           Utility functions.  (line  143)
* merge() (in module heapq):             heapq — Heap queue algorithm.
                                                             (line   79)
* Message (class in email.message):      email message Message Representing an email message using the compat32 API.
                                                             (line   49)
* Message (class in mailbox):            Message objects.    (line    6)
* message digest, MD5:                   hashlib — Secure hashes and message digests.
                                                             (line    8)
* MessageBeep() (in module winsound):    winsound — Sound-playing interface for Windows.
                                                             (line   31)
* MessageClass (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  160)
* MessageError:                          email errors Exception and Defect classes.
                                                             (line   13)
* MessageParseError:                     email errors Exception and Defect classes.
                                                             (line   19)
* messages (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   23)
* message_factory (email.policy.Policy attribute): email policy Policy Objects.
                                                             (line  173)
* message_from_binary_file() (in module email): Parser API.  (line  129)
* message_from_bytes() (in module email): Parser API.        (line  116)
* message_from_file() (in module email): Parser API.         (line  152)
* message_from_string() (in module email): Parser API.       (line  142)
* meta hooks:                            Import hooks.       (line    6)
* meta path finder:                      Glossary.           (line  766)
* meta() (in module curses):             Functions<3>.       (line  268)
* metaclass:                             Metaclasses.        (line    6)
* metaclass <1>:                         Glossary.           (line  775)
* metaclass (2to3 fixer):                Fixers.             (line  190)
* metaclass hint:                        Determining the appropriate metaclass.
                                                             (line    6)
* MetaPathFinder (class in importlib.abc): importlib abc – Abstract base classes related to import.
                                                             (line   36)
* metavar (optparse.Option attribute):   Option attributes.  (line   80)
* MetavarTypeHelpFormatter (class in argparse): formatter_class.
                                                             (line   10)
* meta_path (in module sys):             sys — System-specific parameters and functions.
                                                             (line  977)
* Meter (class in tkinter.tix):          Basic Widgets.      (line   44)
* method:                                Glossary.           (line  790)
* method (urllib.request.Request attribute): Request Objects.
                                                             (line   52)
* method resolution order:               Glossary.           (line  798)
* method; call:                          Calls.              (line  131)
* methodattrs (2to3 fixer):              Fixers.             (line  195)
* methodcaller() (in module operator):   operator — Standard operators as functions.
                                                             (line  310)
* MethodDescriptorType (in module types): Standard Interpreter Types.
                                                             (line   88)
* methodHelp() (xmlrpc.client.ServerProxy.system method): ServerProxy Objects.
                                                             (line   43)
* methods (in module crypt):             Module Attributes.  (line    8)
* methods (pyclbr.Class attribute):      Class Objects<2>.   (line   46)
* methodSignature() (xmlrpc.client.ServerProxy.system method): ServerProxy Objects.
                                                             (line   22)
* MethodType (in module types):          Standard Interpreter Types.
                                                             (line   62)
* MethodType (in module types) <1>:      Function Objects<3>.
                                                             (line   14)
* MethodType (in module types) <2>:      Method Objects<2>.  (line   12)
* MethodWrapperType (in module types):   Standard Interpreter Types.
                                                             (line   81)
* METHOD_BLOWFISH (in module crypt):     Hashing Methods.    (line   22)
* method_calls (unittest.mock.Mock attribute): The Mock Class.
                                                             (line  339)
* METHOD_CRYPT (in module crypt):        Hashing Methods.    (line   34)
* METHOD_MD5 (in module crypt):          Hashing Methods.    (line   29)
* METHOD_SHA256 (in module crypt):       Hashing Methods.    (line   17)
* METHOD_SHA512 (in module crypt):       Hashing Methods.    (line   11)
* METH_CLASS (built-in variable):        Common Object Structures.
                                                             (line  223)
* METH_COEXIST (built-in variable):      Common Object Structures.
                                                             (line  240)
* METH_FASTCALL (built-in variable):     Common Object Structures.
                                                             (line  174)
* METH_NOARGS (built-in variable):       Common Object Structures.
                                                             (line  201)
* METH_O (built-in variable):            Common Object Structures.
                                                             (line  210)
* METH_STATIC (built-in variable):       Common Object Structures.
                                                             (line  230)
* METH_VARARGS (built-in variable):      Common Object Structures.
                                                             (line  155)
* MFD_ALLOW_SEALING (in module os):      Files and Directories.
                                                             (line 1595)
* MFD_CLOEXEC (in module os):            Files and Directories.
                                                             (line 1595)
* MFD_HUGETLB (in module os):            Files and Directories.
                                                             (line 1595)
* MFD_HUGE_16GB (in module os):          Files and Directories.
                                                             (line 1595)
* MFD_HUGE_16MB (in module os):          Files and Directories.
                                                             (line 1595)
* MFD_HUGE_1GB (in module os):           Files and Directories.
                                                             (line 1595)
* MFD_HUGE_1MB (in module os):           Files and Directories.
                                                             (line 1595)
* MFD_HUGE_256MB (in module os):         Files and Directories.
                                                             (line 1595)
* MFD_HUGE_2GB (in module os):           Files and Directories.
                                                             (line 1595)
* MFD_HUGE_2MB (in module os):           Files and Directories.
                                                             (line 1595)
* MFD_HUGE_32MB (in module os):          Files and Directories.
                                                             (line 1595)
* MFD_HUGE_512KB (in module os):         Files and Directories.
                                                             (line 1595)
* MFD_HUGE_512MB (in module os):         Files and Directories.
                                                             (line 1595)
* MFD_HUGE_64KB (in module os):          Files and Directories.
                                                             (line 1595)
* MFD_HUGE_8MB (in module os):           Files and Directories.
                                                             (line 1595)
* MFD_HUGE_MASK (in module os):          Files and Directories.
                                                             (line 1595)
* MFD_HUGE_SHIFT (in module os):         Files and Directories.
                                                             (line 1595)
* MH (class in mailbox):                 MH.                 (line    6)
* MHMessage (class in mailbox):          MHMessage.          (line    6)
* microsecond (datetime.datetime attribute): datetime Objects.
                                                             (line  290)
* microsecond (datetime.time attribute): time Objects.       (line   62)
* MIME; base64 encoding:                 base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line    8)
* MIME; content type:                    mimetypes — Map filenames to MIME types.
                                                             (line    8)
* MIME; headers:                         mimetypes — Map filenames to MIME types.
                                                             (line   26)
* MIME; headers <1>:                     cgi — Common Gateway Interface support.
                                                             (line    8)
* MIME; quoted-printable encoding:       quopri — Encode and decode MIME quoted-printable data.
                                                             (line    8)
* MIMEApplication (class in email.mime.application): email mime Creating email and MIME objects from scratch.
                                                             (line   95)
* MIMEAudio (class in email.mime.audio): email mime Creating email and MIME objects from scratch.
                                                             (line  125)
* MIMEBase (class in email.mime.base):   email mime Creating email and MIME objects from scratch.
                                                             (line   30)
* MIMEImage (class in email.mime.image): email mime Creating email and MIME objects from scratch.
                                                             (line  158)
* MIMEMessage (class in email.mime.message): email mime Creating email and MIME objects from scratch.
                                                             (line  191)
* MIMEMultipart (class in email.mime.multipart): email mime Creating email and MIME objects from scratch.
                                                             (line   66)
* MIMENonMultipart (class in email.mime.nonmultipart): email mime Creating email and MIME objects from scratch.
                                                             (line   55)
* MIMEPart (class in email.message):     email message Representing an email message.
                                                             (line  689)
* MIMEText (class in email.mime.text):   email mime Creating email and MIME objects from scratch.
                                                             (line  209)
* MimeTypes (class in mimetypes):        MimeTypes Objects.  (line   10)
* mimetypes (module):                    mimetypes — Map filenames to MIME types.
                                                             (line    6)
* MIMEVersionHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  232)
* min (datetime.date attribute):         date Objects.       (line   87)
* min (datetime.datetime attribute):     datetime Objects.   (line  248)
* min (datetime.time attribute):         time Objects.       (line   33)
* min (datetime.timedelta attribute):    timedelta Objects.  (line   73)
* min() (built-in function):             Built-in Functions. (line  952)
* min() (decimal.Context method):        Context objects.    (line  375)
* min() (decimal.Decimal method):        Decimal objects.    (line  387)
* MINEQUAL (in module token):            token — Constants used with Python parse trees.
                                                             (line  174)
* MINIMUM_SUPPORTED (ssl.TLSVersion attribute): Constants<9>.
                                                             (line  520)
* minimum_version (ssl.SSLContext attribute): SSL Contexts.  (line  512)
* minmax() (in module audioop):          audioop — Manipulate raw audio data.
                                                             (line  163)
* minor (email.headerregistry.MIMEVersionHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  249)
* minor() (in module os):                Files and Directories.
                                                             (line  503)
* minus:                                 Unary arithmetic and bitwise operations.
                                                             (line   10)
* MINUS (in module token):               token — Constants used with Python parse trees.
                                                             (line   86)
* minus() (decimal.Context method):      Context objects.    (line  383)
* minute (datetime.datetime attribute):  datetime Objects.   (line  282)
* minute (datetime.time attribute):      time Objects.       (line   54)
* MINYEAR (in module datetime):          Constants.          (line    8)
* MIN_EMIN (in module decimal):          Constants<4>.       (line   19)
* MIN_ETINY (in module decimal):         Constants<4>.       (line   22)
* min_mag() (decimal.Context method):    Context objects.    (line  379)
* min_mag() (decimal.Decimal method):    Decimal objects.    (line  394)
* mirrored() (in module unicodedata):    unicodedata — Unicode Database.
                                                             (line   69)
* misc_header (cmd.Cmd attribute):       Cmd Objects.        (line  152)
* MISSING (contextvars.contextvars.Token.Token attribute): Context Variables.
                                                             (line   87)
* MissingSectionHeaderError:             Exceptions<5>.      (line   60)
* missing_compiler_executable() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  909)
* MISSING_C_DOCSTRINGS (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  132)
* MIXERDEV:                              ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line   74)
* mkd() (ftplib.FTP method):             FTP Objects.        (line  217)
* mkdir() (in module os):                Files and Directories.
                                                             (line  398)
* mkdir() (pathlib.Path method):         Methods<2>.         (line  214)
* mkdtemp() (in module tempfile):        tempfile — Generate temporary files and directories.
                                                             (line  201)
* mkfifo() (in module os):               Files and Directories.
                                                             (line  457)
* mknod() (in module os):                Files and Directories.
                                                             (line  478)
* mkpath() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  493)
* mkpath() (in module distutils.dir_util): distutils dir_util — Directory tree operations.
                                                             (line    9)
* mksalt() (in module crypt):            Module Functions<2>.
                                                             (line   39)
* mkstemp() (in module tempfile):        tempfile — Generate temporary files and directories.
                                                             (line  142)
* mktemp() (in module tempfile):         Deprecated functions and variables.
                                                             (line   15)
* mktime() (in module time):             Functions<2>.       (line  150)
* mktime_tz() (in module email.utils):   email utils Miscellaneous utilities.
                                                             (line  127)
* mlsd() (ftplib.FTP method):            FTP Objects.        (line  165)
* mmap (class in mmap):                  mmap — Memory-mapped file support.
                                                             (line   48)
* mmap (module):                         mmap — Memory-mapped file support.
                                                             (line    6)
* MMDF (class in mailbox):               MMDF.               (line    6)
* MMDFMessage (class in mailbox):        MMDFMessage.        (line    6)
* Mock (class in unittest.mock):         The Mock Class.     (line   24)
* mock_add_spec() (unittest.mock.Mock method): The Mock Class.
                                                             (line  181)
* mock_calls (unittest.mock.Mock attribute): The Mock Class. (line  351)
* mock_open() (in module unittest.mock): mock_open.          (line    6)
* mod() (in module operator):            operator — Standard operators as functions.
                                                             (line  111)
* mode (io.FileIO attribute):            Raw File I/O.       (line   57)
* mode (ossaudiodev.oss_audio_device attribute): Audio Device Objects.
                                                             (line  236)
* mode (statistics.NormalDist attribute): NormalDist objects.
                                                             (line   31)
* mode (tarfile.TarInfo attribute):      TarInfo Objects.    (line   55)
* mode() (in module statistics):         Function details.   (line  229)
* mode() (in module turtle):             Settings and special methods.
                                                             (line    6)
* modf() (in module math):               Number-theoretic and representation functions.
                                                             (line  172)
* modified() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   45)
* Modify() (msilib.View method):         View Objects.       (line   23)
* modify() (select.devpoll method):      /dev/poll Polling Objects.
                                                             (line   49)
* modify() (select.epoll method):        Edge and Level Trigger Polling epoll Objects.
                                                             (line   85)
* modify() (select.poll method):         Polling Objects.    (line   60)
* modify() (selectors.BaseSelector method): Classes<3>.      (line   89)
* module:                                Glossary.           (line  805)
* module (pyclbr.Class attribute):       Class Objects<2>.   (line   13)
* module (pyclbr.Function attribute):    Function Objects.   (line   13)
* module spec:                           Finders and loaders.
                                                             (line    6)
* module spec <1>:                       Glossary.           (line  814)
* module; array:                         The standard type hierarchy.
                                                             (line  195)
* module; array <1>:                     Binary Sequence Types — bytes bytearray memoryview.
                                                             (line    6)
* module; base64:                        binascii — Convert between binary and ASCII.
                                                             (line    6)
* module; bdb:                           pdb — The Python Debugger.
                                                             (line   17)
* module; binhex:                        binascii — Convert between binary and ASCII.
                                                             (line    6)
* module; builtins:                      The dir Function.   (line   43)
* module; builtins <1>:                  Complete Python programs.
                                                             (line    6)
* module; builtins <2>:                  Embedding Python<2>.
                                                             (line   12)
* module; builtins <3>:                  Initializing and finalizing the interpreter.
                                                             (line    8)
* module; builtins <4>:                  Sub-interpreter support.
                                                             (line   25)
* module; cmd:                           pdb — The Python Debugger.
                                                             (line   17)
* module; copy:                          copyreg — Register pickle support functions.
                                                             (line    8)
* module; crypt:                         pwd — The password database.
                                                             (line   43)
* module; dbm.gnu:                       The standard type hierarchy.
                                                             (line  256)
* module; dbm.gnu <1>:                   Restrictions.       (line    6)
* module; dbm.ndbm:                      The standard type hierarchy.
                                                             (line  256)
* module; dbm.ndbm <1>:                  Restrictions.       (line    6)
* module; errno:                         Concrete exceptions.
                                                             (line  118)
* module; glob:                          fnmatch — Unix filename pattern matching.
                                                             (line   34)
* module; imp:                           Built-in Functions. (line 1760)
* module; importing:                     The import statement.
                                                             (line    6)
* module; io:                            The standard type hierarchy.
                                                             (line  600)
* module; json:                          Saving structured data with json.
                                                             (line    6)
* module; math:                          Numeric Types — int float complex.
                                                             (line  102)
* module; math <1>:                      Constants<3>.       (line   47)
* module; namespace:                     The standard type hierarchy.
                                                             (line  506)
* module; os:                            posix — The most common POSIX system calls.
                                                             (line   12)
* module; pickle:                        copy — Shallow and deep copy operations.
                                                             (line   68)
* module; pickle <1>:                    copyreg — Register pickle support functions.
                                                             (line    8)
* module; pickle <2>:                    shelve — Python object persistence.
                                                             (line    8)
* module; pickle <3>:                    marshal — Internal Python object serialization.
                                                             (line   15)
* module; pty:                           File Descriptor Operations.
                                                             (line  346)
* module; pwd:                           os path — Common pathname manipulations.
                                                             (line  140)
* module; pyexpat:                       xml parsers expat — Fast XML parsing using Expat.
                                                             (line   20)
* module; re:                            String Methods<2>.  (line    6)
* module; re <1>:                        fnmatch — Unix filename pattern matching.
                                                             (line    8)
* module; search; path:                  The Module Search Path.
                                                             (line    6)
* module; search; path <1>:              linecache — Random access to text lines.
                                                             (line   30)
* module; search; path <2>:              sys — System-specific parameters and functions.
                                                             (line 1017)
* module; search; path <3>:              site — Site-specific configuration hook.
                                                             (line   14)
* module; search; path <4>:              Embedding Python<2>.
                                                             (line   12)
* module; search; path <5>:              Initializing and finalizing the interpreter.
                                                             (line    8)
* module; search; path <6>:              Process-wide parameters.
                                                             (line  120)
* module; search; path <7>:              Process-wide parameters.
                                                             (line  133)
* module; shelve:                        marshal — Internal Python object serialization.
                                                             (line   15)
* module; signal:                        _thread — Low-level threading API.
                                                             (line  168)
* module; signal <1>:                    Signal Handling<2>. (line    8)
* module; sitecustomize:                 site — Site-specific configuration hook.
                                                             (line   87)
* module; socket:                        Internet Protocols and Support.
                                                             (line    6)
* module; stat:                          Files and Directories.
                                                             (line  947)
* module; string:                        locale — Internationalization services.
                                                             (line  459)
* module; struct:                        Socket Objects.     (line  529)
* module; sys:                           Standard Modules.   (line    6)
* module; sys <1>:                       The try statement.  (line   68)
* module; sys <2>:                       Complete Python programs.
                                                             (line    6)
* module; sys <3>:                       Built-in Functions. (line 1212)
* module; sys <4>:                       Embedding Python<2>.
                                                             (line   12)
* module; sys <5>:                       Initializing and finalizing the interpreter.
                                                             (line    8)
* module; sys <6>:                       Sub-interpreter support.
                                                             (line   25)
* module; types:                         Type Objects.       (line    6)
* module; urllib.request:                http client — HTTP protocol client.
                                                             (line    8)
* module; usercustomize:                 site — Site-specific configuration hook.
                                                             (line   98)
* module; uu:                            binascii — Convert between binary and ASCII.
                                                             (line    6)
* module; _locale:                       locale — Internationalization services.
                                                             (line   16)
* module; _thread:                       High-level API.     (line   45)
* module; __main__:                      Resolution of names.
                                                             (line   50)
* module; __main__ <1>:                  Complete Python programs.
                                                             (line    6)
* module; __main__ <2>:                  Complete Python programs.
                                                             (line   19)
* module; __main__ <3>:                  runpy — Locating and executing Python modules.
                                                             (line   30)
* module; __main__ <4>:                  runpy — Locating and executing Python modules.
                                                             (line   98)
* module; __main__ <5>:                  Embedding Python<2>.
                                                             (line   12)
* module; __main__ <6>:                  Initializing and finalizing the interpreter.
                                                             (line    8)
* module; __main__ <7>:                  Sub-interpreter support.
                                                             (line   25)
* ModuleFinder (class in modulefinder):  modulefinder — Find modules used by a script.
                                                             (line   26)
* modulefinder (module):                 modulefinder — Find modules used by a script.
                                                             (line    6)
* ModuleInfo (class in pkgutil):         pkgutil — Package extension utility.
                                                             (line   13)
* ModuleNotFoundError:                   Concrete exceptions.
                                                             (line   51)
* modules (in module sys):               sys — System-specific parameters and functions.
                                                             (line 1007)
* modules (in module sys) <1>:           Importing Modules<2>.
                                                             (line    7)
* modules (in module sys) <2>:           Initializing and finalizing the interpreter.
                                                             (line    8)
* modules (modulefinder.ModuleFinder attribute): modulefinder — Find modules used by a script.
                                                             (line   49)
* ModuleSpec (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line  348)
* modules_cleanup() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  743)
* modules_setup() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  739)
* ModuleType (class in types):           Standard Interpreter Types.
                                                             (line  102)
* ModuleType (in module types):          Module Objects.     (line    8)
* module_for_loader() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line  133)
* module_from_spec() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line  117)
* module_repr() (importlib.abc.Loader method): importlib abc – Abstract base classes related to import.
                                                             (line  262)
* modulo:                                Binary arithmetic operations.
                                                             (line   35)
* monotonic() (in module time):          Functions<2>.       (line  163)
* monotonic_ns() (in module time):       Functions<2>.       (line  176)
* month (datetime.date attribute):       date Objects.       (line  106)
* month (datetime.datetime attribute):   datetime Objects.   (line  269)
* month() (in module calendar):          calendar — General calendar-related functions.
                                                             (line  339)
* monthcalendar() (in module calendar):  calendar — General calendar-related functions.
                                                             (line  328)
* monthdatescalendar() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   89)
* monthdays2calendar() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line   95)
* monthdayscalendar() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line  101)
* monthrange() (in module calendar):     calendar — General calendar-related functions.
                                                             (line  323)
* month_abbr (in module calendar):       calendar — General calendar-related functions.
                                                             (line  383)
* month_name (in module calendar):       calendar — General calendar-related functions.
                                                             (line  376)
* Morsel (class in http.cookies):        Morsel Objects.     (line    6)
* most_common() (collections.Counter method): Counter objects.
                                                             (line   77)
* mouseinterval() (in module curses):    Functions<3>.       (line  273)
* mousemask() (in module curses):        Functions<3>.       (line  280)
* move() (curses.panel.Panel method):    Panel Objects.      (line   35)
* move() (curses.window method):         Window Objects.     (line  393)
* move() (in module shutil):             Directory and files operations.
                                                             (line  280)
* move() (mmap.mmap method):             mmap — Memory-mapped file support.
                                                             (line  183)
* move() (tkinter.ttk.Treeview method):  ttk Treeview.       (line  221)
* move_file() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  498)
* move_file() (in module distutils.file_util): distutils file_util — Single file operations.
                                                             (line   34)
* move_to_end() (collections.OrderedDict method): OrderedDict objects.
                                                             (line   53)
* MozillaCookieJar (class in http.cookiejar): FileCookieJar subclasses and co-operation with web browsers.
                                                             (line    9)
* MRO:                                   Glossary.           (line  820)
* mro() (class method):                  Special Attributes. (line   40)
* msg (http.client.HTTPResponse attribute): HTTPResponse Objects.
                                                             (line   40)
* msg (json.JSONDecodeError attribute):  Exceptions<13>.     (line   11)
* msg (re.error attribute):              Module Contents.    (line  362)
* msg (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   59)
* msg() (telnetlib.Telnet method):       Telnet Objects.     (line   78)
* msi:                                   msilib — Read and write Microsoft Installer files.
                                                             (line    8)
* msilib (module):                       msilib — Read and write Microsoft Installer files.
                                                             (line    6)
* msvcrt (module):                       msvcrt — Useful routines from the MS VC++ runtime.
                                                             (line    6)
* mtime (gzip.GzipFile attribute):       gzip — Support for gzip files.
                                                             (line  140)
* mtime (tarfile.TarInfo attribute):     TarInfo Objects.    (line   51)
* mtime() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   39)
* mt_interact() (telnetlib.Telnet method): Telnet Objects.   (line  117)
* mul() (in module audioop):             audioop — Manipulate raw audio data.
                                                             (line  168)
* mul() (in module operator):            operator — Standard operators as functions.
                                                             (line  116)
* MultiCall (class in xmlrpc.client):    MultiCall Objects.  (line    9)
* MULTILINE (in module re):              Module Contents.    (line  101)
* MultiLoopChildWatcher (class in asyncio): Process Watchers.
                                                             (line  100)
* multimode() (in module statistics):    Function details.   (line  257)
* MultipartConversionError:              email errors Exception and Defect classes.
                                                             (line   42)
* multiplication:                        Binary arithmetic operations.
                                                             (line   16)
* multiply() (decimal.Context method):   Context objects.    (line  388)
* multiprocessing (module):              multiprocessing — Process-based parallelism.
                                                             (line    6)
* multiprocessing.connection (module):   Listeners and Clients.
                                                             (line    6)
* multiprocessing.dummy (module):        The multiprocessing dummy module.
                                                             (line    6)
* multiprocessing.Manager() (in module multiprocessing.sharedctypes): Managers.
                                                             (line   12)
* multiprocessing.managers (module):     Managers.           (line   18)
* multiprocessing.pool (module):         Process Pools.      (line    6)
* multiprocessing.sharedctypes (module): The multiprocessing sharedctypes module.
                                                             (line    6)
* multiprocessing.shared_memory (module): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line    6)
* mutable:                               Glossary.           (line  824)
* mutable object:                        Objects values and types.
                                                             (line   11)
* mutable sequence; loop over:           The for statement.  (line   44)
* mutable; sequence; types:              Mutable Sequence Types.
                                                             (line    6)
* MutableMapping (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  175)
* MutableMapping (class in typing):      Classes functions and decorators.
                                                             (line  186)
* MutableSequence (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  152)
* MutableSequence (class in typing):     Classes functions and decorators.
                                                             (line  194)
* MutableSet (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  170)
* MutableSet (class in typing):          Classes functions and decorators.
                                                             (line  175)
* mvderwin() (curses.window method):     Window Objects.     (line  397)
* mvwin() (curses.window method):        Window Objects.     (line  404)
* myrights() (imaplib.IMAP4 method):     IMAP4 Objects.      (line  157)
* name:                                  Identifiers and keywords.
                                                             (line    6)
* name <1>:                              Binding of names.   (line    6)
* name <2>:                              Identifiers Names.  (line    6)
* name (codecs.CodecInfo attribute):     codecs — Codec registry and base classes.
                                                             (line   65)
* name (contextvars.ContextVar attribute): Context Variables.
                                                             (line   24)
* name (doctest.DocTest attribute):      DocTest Objects.    (line   30)
* name (email.headerregistry.BaseHeader attribute): email headerregistry Custom Header Objects.
                                                             (line   45)
* name (hashlib.hash attribute):         Hash algorithms.    (line  105)
* name (hmac.HMAC attribute):            hmac — Keyed-Hashing for Message Authentication.
                                                             (line  100)
* name (http.cookiejar.Cookie attribute): Cookie Objects<2>. (line   28)
* name (importlib.abc.FileLoader attribute): importlib abc – Abstract base classes related to import.
                                                             (line  474)
* name (importlib.machinery.ExtensionFileLoader attribute): importlib machinery – Importers and path hooks.
                                                             (line  307)
* name (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  364)
* name (importlib.machinery.SourceFileLoader attribute): importlib machinery – Importers and path hooks.
                                                             (line  220)
* name (importlib.machinery.SourcelessFileLoader attribute): importlib machinery – Importers and path hooks.
                                                             (line  264)
* name (in module os):                   os — Miscellaneous operating system interfaces.
                                                             (line   46)
* NAME (in module token):                token — Constants used with Python parse trees.
                                                             (line   42)
* name (inspect.Parameter attribute):    Introspecting callables with the Signature object.
                                                             (line  136)
* name (io.FileIO attribute):            Raw File I/O.       (line   61)
* name (multiprocessing.Process attribute): Process and exceptions.
                                                             (line   67)
* name (multiprocessing.shared_memory.SharedMemory attribute): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   91)
* name (os.DirEntry attribute):          Files and Directories.
                                                             (line  792)
* name (ossaudiodev.oss_audio_device attribute): Audio Device Objects.
                                                             (line  232)
* name (pyclbr.Class attribute):         Class Objects<2>.   (line   17)
* name (pyclbr.Function attribute):      Function Objects.   (line   17)
* name (tarfile.TarInfo attribute):      TarInfo Objects.    (line   43)
* name (threading.Thread attribute):     Thread Objects.     (line  136)
* name (xml.dom.Attr attribute):         Attr Objects.       (line    8)
* name (xml.dom.DocumentType attribute): DocumentType Objects.
                                                             (line   33)
* name (zipfile.Path attribute):         Path Objects.       (line   21)
* name() (in module unicodedata):        unicodedata — Unicode Database.
                                                             (line   25)
* name2codepoint (in module html.entities): html entities — Definitions of HTML general entities.
                                                             (line   30)
* name; binding:                         The import statement.
                                                             (line    6)
* name; binding <1>:                     The import statement.
                                                             (line   51)
* name; binding <2>:                     Function definitions.
                                                             (line    6)
* name; binding <3>:                     Function definitions.
                                                             (line    6)
* name; binding <4>:                     Class definitions.  (line    6)
* name; mangling:                        Private Variables.  (line   13)
* name; mangling <1>:                    Identifiers Names.  (line   14)
* Named Shared Memory:                   multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   10)
* named tuple:                           Glossary.           (line  829)
* NamedTemporaryFile() (in module tempfile): tempfile — Generate temporary files and directories.
                                                             (line   71)
* NamedTuple (class in typing):          Classes functions and decorators.
                                                             (line  416)
* namedtuple() (in module collections):  namedtuple Factory Function for Tuples with Named Fields.
                                                             (line   11)
* NameError:                             Concrete exceptions.
                                                             (line   89)
* NameError (built-in exception):        Resolution of names.
                                                             (line   16)
* namelist() (zipfile.ZipFile method):   ZipFile Objects.    (line  105)
* nameprep() (in module encodings.idna): encodings idna — Internationalized Domain Names in Applications.
                                                             (line   47)
* namer (logging.handlers.BaseRotatingHandler attribute): BaseRotatingHandler.
                                                             (line   17)
* namereplace_errors() (in module codecs): Error Handlers.   (line  157)
* namespace:                             Naming and binding. (line    6)
* namespace <1>:                         Glossary.           (line  850)
* Namespace (class in argparse):         The Namespace object.
                                                             (line    6)
* Namespace (class in multiprocessing.managers): Managers.   (line  221)
* namespace package:                     Glossary.           (line  864)
* namespace() (imaplib.IMAP4 method):    IMAP4 Objects.      (line  162)
* Namespace() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  171)
* NamespaceErr:                          Exceptions<16>.     (line   66)
* namespaceURI (xml.dom.Node attribute): Node Objects.       (line   74)
* NAMESPACE_DNS (in module uuid):        uuid — UUID objects according to RFC 4122.
                                                             (line  198)
* NAMESPACE_OID (in module uuid):        uuid — UUID objects according to RFC 4122.
                                                             (line  207)
* NAMESPACE_URL (in module uuid):        uuid — UUID objects according to RFC 4122.
                                                             (line  203)
* NAMESPACE_X500 (in module uuid):       uuid — UUID objects according to RFC 4122.
                                                             (line  211)
* NaN:                                   Built-in Functions. (line  584)
* nan (in module cmath):                 Constants<3>.       (line   33)
* nan (in module math):                  Constants<2>.       (line   31)
* nanj (in module cmath):                Constants<3>.       (line   40)
* NannyNag:                              tabnanny — Detection of ambiguous indentation.
                                                             (line   37)
* napms() (in module curses):            Functions<3>.       (line  289)
* nargs (optparse.Option attribute):     Option attributes.  (line   42)
* native_id (threading.Thread attribute): Thread Objects.    (line  156)
* nbytes (memoryview attribute):         Memory Views.       (line  370)
* ncurses_version (in module curses):    Constants<6>.       (line   23)
* ndiff() (in module difflib):           difflib — Helpers for computing deltas.
                                                             (line  232)
* ndim (memoryview attribute):           Memory Views.       (line  436)
* ne (2to3 fixer):                       Fixers.             (line  200)
* ne() (in module operator):             operator — Standard operators as functions.
                                                             (line   24)
* needs_input (bz2.BZ2Decompressor attribute): Incremental de compression.
                                                             (line   85)
* needs_input (lzma.LZMADecompressor attribute): Compressing and decompressing data in memory.
                                                             (line  175)
* neg() (in module operator):            operator — Standard operators as functions.
                                                             (line  128)
* negation:                              Unary arithmetic and bitwise operations.
                                                             (line   10)
* nested scope:                          Glossary.           (line  873)
* netmask (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  101)
* netmask (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  273)
* NetmaskValueError:                     Custom Exceptions.  (line   13)
* netrc (class in netrc):                netrc — netrc file processing.
                                                             (line   13)
* netrc (module):                        netrc — netrc file processing.
                                                             (line    6)
* NetrcParseError:                       netrc — netrc file processing.
                                                             (line   36)
* netscape (http.cookiejar.CookiePolicy attribute): CookiePolicy Objects.
                                                             (line   68)
* network (ipaddress.IPv4Interface attribute): Interface objects.
                                                             (line   26)
* network (ipaddress.IPv6Interface attribute): Interface objects.
                                                             (line   66)
* Network News Transfer Protocol:        nntplib — NNTP protocol client.
                                                             (line    8)
* network_address (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   86)
* network_address (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  267)
* new() (in module hashlib):             Hash algorithms.    (line   55)
* new() (in module hmac):                hmac — Keyed-Hashing for Message Authentication.
                                                             (line   12)
* new-style class:                       Glossary.           (line  883)
* newer() (in module distutils.dep_util): distutils dep_util — Dependency checking.
                                                             (line   10)
* newer_group() (in module distutils.dep_util): distutils dep_util — Dependency checking.
                                                             (line   24)
* newer_pairwise() (in module distutils.dep_util): distutils dep_util — Dependency checking.
                                                             (line   17)
* newfunc (C type):                      Slot Type typedefs. (line   41)
* newgroups() (nntplib.NNTP method):     Methods<3>.         (line   78)
* NEWLINE (in module token):             token — Constants used with Python parse trees.
                                                             (line   48)
* NEWLINE token:                         Logical lines.      (line    6)
* NEWLINE token <1>:                     Compound statements.
                                                             (line   54)
* newlines (io.TextIOBase attribute):    Text I/O<2>.        (line   24)
* newnews() (nntplib.NNTP method):       Methods<3>.         (line   88)
* newpad() (in module curses):           Functions<3>.       (line  293)
* NewType() (in module typing):          Classes functions and decorators.
                                                             (line  498)
* newwin() (in module curses):           Functions<3>.       (line  313)
* new_alignment() (formatter.writer method): The Writer Interface.
                                                             (line   17)
* new_child() (collections.ChainMap method): ChainMap objects.
                                                             (line   46)
* new_class() (in module types):         Dynamic Type Creation.
                                                             (line    6)
* new_compiler() (in module distutils.ccompiler): distutils ccompiler — CCompiler base class.
                                                             (line   48)
* new_event_loop() (asyncio.AbstractEventLoopPolicy method): Policy Objects.
                                                             (line   27)
* new_event_loop() (in module asyncio):  Event Loop.         (line   59)
* new_font() (formatter.writer method):  The Writer Interface.
                                                             (line   25)
* new_margin() (formatter.writer method): The Writer Interface.
                                                             (line   35)
* new_module() (in module imp):          imp — Access the import internals.
                                                             (line  124)
* new_panel() (in module curses.panel):  Functions<4>.       (line   12)
* new_spacing() (formatter.writer method): The Writer Interface.
                                                             (line   42)
* new_styles() (formatter.writer method): The Writer Interface.
                                                             (line   46)
* next (2to3 fixer):                     Fixers.             (line  204)
* next (pdb command):                    Debugger Commands.  (line  165)
* next() (built-in function):            Built-in Functions. (line  979)
* next() (nntplib.NNTP method):          Methods<3>.         (line  209)
* next() (tarfile.TarFile method):       TarFile Objects.    (line  130)
* next() (tkinter.ttk.Treeview method):  ttk Treeview.       (line  232)
* nextfile() (in module fileinput):      fileinput — Iterate over lines from multiple input streams.
                                                             (line  116)
* nextkey() (dbm.gnu.gdbm method):       dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line   93)
* nextSibling (xml.dom.Node attribute):  Node Objects.       (line   42)
* next_minus() (decimal.Context method): Context objects.    (line  392)
* next_minus() (decimal.Decimal method): Decimal objects.    (line  399)
* next_plus() (decimal.Context method):  Context objects.    (line  396)
* next_plus() (decimal.Decimal method):  Decimal objects.    (line  405)
* next_toward() (decimal.Context method): Context objects.   (line  400)
* next_toward() (decimal.Decimal method): Decimal objects.   (line  411)
* ngettext() (gettext.GNUTranslations method): The GNUTranslations class.
                                                             (line   47)
* ngettext() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   41)
* ngettext() (in module gettext):        GNU gettext API.    (line   54)
* nice() (in module os):                 Process Management. (line  301)
* nis (module):                          nis — Interface to Sun’s NIS Yellow Pages.
                                                             (line    6)
* NL (in module token):                  token — Constants used with Python parse trees.
                                                             (line  265)
* nl() (in module curses):               Functions<3>.       (line  323)
* nlargest() (in module heapq):          heapq — Heap queue algorithm.
                                                             (line  106)
* nlst() (ftplib.FTP method):            FTP Objects.        (line  179)
* nl_langinfo() (in module locale):      locale — Internationalization services.
                                                             (line  171)
* NNTP (class in nntplib):               nntplib — NNTP protocol client.
                                                             (line   30)
* NNTP; protocol:                        nntplib — NNTP protocol client.
                                                             (line    8)
* NNTPDataError:                         nntplib — NNTP protocol client.
                                                             (line  124)
* NNTPError:                             nntplib — NNTP protocol client.
                                                             (line   93)
* nntplib (module):                      nntplib — NNTP protocol client.
                                                             (line    6)
* NNTPPermanentError:                    nntplib — NNTP protocol client.
                                                             (line  114)
* NNTPProtocolError:                     nntplib — NNTP protocol client.
                                                             (line  119)
* NNTPReplyError:                        nntplib — NNTP protocol client.
                                                             (line  104)
* NNTPTemporaryError:                    nntplib — NNTP protocol client.
                                                             (line  109)
* nntp_implementation (nntplib.NNTP attribute): Attributes.  (line   14)
* NNTP_SSL (class in nntplib):           nntplib — NNTP protocol client.
                                                             (line   64)
* nntp_version (nntplib.NNTP attribute): Attributes.         (line    6)
* nocbreak() (in module curses):         Functions<3>.       (line  329)
* NoDataAllowedErr:                      Exceptions<16>.     (line   83)
* node() (in module platform):           Cross Platform.     (line   41)
* nodelay() (curses.window method):      Window Objects.     (line  408)
* nodeName (xml.dom.Node attribute):     Node Objects.       (line   79)
* NodeTransformer (class in ast):        ast Helpers.        (line  154)
* nodeType (xml.dom.Node attribute):     Node Objects.       (line    8)
* nodeValue (xml.dom.Node attribute):    Node Objects.       (line   88)
* NodeVisitor (class in ast):            ast Helpers.        (line  119)
* noecho() (in module curses):           Functions<3>.       (line  334)
* NOEXPR (in module locale):             locale — Internationalization services.
                                                             (line  250)
* NoModificationAllowedErr:              Exceptions<16>.     (line   88)
* nonblock() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line   75)
* NonCallableMagicMock (class in unittest.mock): Magic Mock. (line   21)
* NonCallableMock (class in unittest.mock): The Mock Class.  (line  385)
* None (Built-in object):                Truth Value Testing.
                                                             (line   15)
* None (built-in variable):              Built-in Constants. (line   18)
* nonl() (in module curses):             Functions<3>.       (line  338)
* nonzero (2to3 fixer):                  Fixers.             (line  210)
* noop() (imaplib.IMAP4 method):         IMAP4 Objects.      (line  166)
* noop() (poplib.POP3 method):           POP3 Objects.       (line   78)
* NoOptionError:                         Exceptions<5>.      (line   32)
* NOP (opcode):                          Python Bytecode Instructions.
                                                             (line   55)
* noqiflush() (in module curses):        Functions<3>.       (line  348)
* noraw() (in module curses):            Functions<3>.       (line  356)
* NoReturn (in module typing):           Classes functions and decorators.
                                                             (line  636)
* NormalDist (class in statistics):      NormalDist objects. (line   13)
* normalize() (decimal.Context method):  Context objects.    (line  404)
* normalize() (decimal.Decimal method):  Decimal objects.    (line  419)
* normalize() (in module locale):        locale — Internationalization services.
                                                             (line  355)
* normalize() (in module unicodedata):   unicodedata — Unicode Database.
                                                             (line   81)
* normalize() (xml.dom.Node method):     Node Objects.       (line  141)
* NORMALIZE_WHITESPACE (in module doctest): Option Flags.    (line   39)
* normalvariate() (in module random):    Real-valued distributions.
                                                             (line   70)
* NORMAL_PRIORITY_CLASS (in module subprocess): Windows Constants.
                                                             (line   80)
* normcase() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  275)
* normpath() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  284)
* NoSectionError:                        Exceptions<5>.      (line   10)
* NoSuchMailboxError:                    Exceptions<14>.     (line   13)
* NotADirectoryError:                    OS exceptions.      (line   86)
* notation:                              Notation.           (line    6)
* notationDecl() (xml.sax.handler.DTDHandler method): DTDHandler Objects.
                                                             (line    8)
* NotationDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  272)
* notations (xml.dom.DocumentType attribute): DocumentType Objects.
                                                             (line   46)
* NotConnected:                          http client — HTTP protocol client.
                                                             (line  130)
* NoteBook (class in tkinter.tix):       Manager Widgets.    (line   22)
* Notebook (class in tkinter.ttk):       ttk Notebook.       (line    6)
* NotEmptyError:                         Exceptions<14>.     (line   20)
* NOTEQUAL (in module token):            token — Constants used with Python parse trees.
                                                             (line  138)
* NotFoundErr:                           Exceptions<16>.     (line   72)
* notify() (asyncio.Condition method):   Condition.          (line   44)
* notify() (threading.Condition method): Condition Objects.  (line  139)
* notify_all() (asyncio.Condition method): Condition.        (line   57)
* notify_all() (threading.Condition method): Condition Objects.
                                                             (line  159)
* notimeout() (curses.window method):    Window Objects.     (line  412)
* NotImplemented (built-in variable):    Built-in Constants. (line   25)
* NotImplementedError:                   Concrete exceptions.
                                                             (line   95)
* NotStandaloneHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  323)
* NotSupportedErr:                       Exceptions<16>.     (line   78)
* NotSupportedError:                     Exceptions<4>.      (line   40)
* not_() (in module operator):           operator — Standard operators as functions.
                                                             (line   49)
* noutrefresh() (curses.window method):  Window Objects.     (line  420)
* now() (datetime.datetime class method): datetime Objects.  (line   60)
* no_proxy:                              urllib request — Extensible library for opening URLs.
                                                             (line  303)
* no_tracing() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  618)
* no_type_check() (in module typing):    Classes functions and decorators.
                                                             (line  580)
* no_type_check_decorator() (in module typing): Classes functions and decorators.
                                                             (line  590)
* npgettext() (gettext.GNUTranslations method): The GNUTranslations class.
                                                             (line   74)
* npgettext() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   55)
* npgettext() (in module gettext):       GNU gettext API.    (line   77)
* NSIG (in module signal):               Module contents<2>. (line   56)
* nsmallest() (in module heapq):         heapq — Heap queue algorithm.
                                                             (line  114)
* NTEventLogHandler (class in logging.handlers): NTEventLogHandler.
                                                             (line   11)
* ntohl() (in module socket):            Other functions<2>. (line  175)
* ntohs() (in module socket):            Other functions<2>. (line  182)
* ntransfercmd() (ftplib.FTP method):    FTP Objects.        (line  157)
* NT_OFFSET (in module token):           token — Constants used with Python parse trees.
                                                             (line  256)
* null; operation:                       The pass statement. (line    6)
* null; operation <1>:                   The pass statement. (line    6)
* nullcontext() (in module contextlib):  Utilities.          (line  109)
* NullFormatter (class in formatter):    Formatter Implementations.
                                                             (line   10)
* NullHandler (class in logging):        NullHandler.        (line   12)
* NullImporter (class in imp):           imp — Access the import internals.
                                                             (line  342)
* NullTranslations (class in gettext):   The NullTranslations class.
                                                             (line   13)
* NullWriter (class in formatter):       Writer Implementations.
                                                             (line   10)
* number:                                Numeric literals.   (line    6)
* Number (class in numbers):             numbers — Numeric abstract base classes.
                                                             (line   15)
* NUMBER (in module token):              token — Constants used with Python parse trees.
                                                             (line   44)
* numbers (module):                      numbers — Numeric abstract base classes.
                                                             (line    6)
* number_class() (decimal.Context method): Context objects.  (line  408)
* number_class() (decimal.Decimal method): Decimal objects.  (line  428)
* numerator (fractions.Fraction attribute): fractions — Rational numbers.
                                                             (line   90)
* numerator (numbers.Rational attribute): The numeric tower. (line   47)
* numeric literal:                       Numeric literals.   (line    6)
* numeric() (in module unicodedata):     unicodedata — Unicode Database.
                                                             (line   43)
* numeric; conversions:                  Numeric Types — int float complex.
                                                             (line  102)
* numeric; literals:                     Numeric Types — int float complex.
                                                             (line   19)
* Numerical Python:                      Built-in Functions. (line 1482)
* numinput() (in module turtle):         Input methods.      (line   22)
* numliterals (2to3 fixer):              Fixers.             (line  214)
* num_addresses (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  128)
* num_addresses (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  285)
* num_tickets (ssl.SSLContext attribute): SSL Contexts.      (line  522)
* N_TOKENS (in module token):            token — Constants used with Python parse trees.
                                                             (line  254)
* n_waiting (threading.Barrier attribute): Barrier Objects.  (line   81)
* obj (memoryview attribute):            Memory Views.       (line  359)
* object:                                Objects values and types.
                                                             (line    6)
* object <1>:                            Glossary.           (line  891)
* object (built-in class):               Built-in Functions. (line  986)
* object (UnicodeError attribute):       Concrete exceptions.
                                                             (line  350)
* object.__slots__ (built-in variable):  __slots__.          (line   13)
* object; asynchronous-generator:        Asynchronous generator functions.
                                                             (line   55)
* object; Boolean:                       The standard type hierarchy.
                                                             (line   75)
* object; Boolean <1>:                   Numeric Types — int float complex.
                                                             (line    6)
* object; built-in function:             The standard type hierarchy.
                                                             (line  455)
* object; built-in function <1>:         Calls.              (line  131)
* object; built-in method:               The standard type hierarchy.
                                                             (line  468)
* object; built-in method <1>:           Calls.              (line  131)
* object; bytearray:                     Mutable Sequence Types.
                                                             (line    6)
* object; bytearray <1>:                 Binary Sequence Types — bytes bytearray memoryview.
                                                             (line    6)
* object; bytearray <2>:                 Bytearray Objects.  (line    6)
* object; bytearray <3>:                 Byte Array Objects. (line    6)
* object; bytes:                         Binary Sequence Types — bytes bytearray memoryview.
                                                             (line    6)
* object; bytes <1>:                     Bytes Objects.      (line    6)
* object; bytes <2>:                     Bytes Objects<2>.   (line    9)
* object; callable:                      The standard type hierarchy.
                                                             (line  262)
* object; callable <1>:                  Slicings.           (line   38)
* object; Capsule:                       Capsules<2>.        (line    6)
* object; class:                         The standard type hierarchy.
                                                             (line  543)
* object; class <1>:                     Calls.              (line  136)
* object; class <2>:                     Class definitions.  (line    6)
* object; class instance:                The standard type hierarchy.
                                                             (line  543)
* object; class instance <1>:            The standard type hierarchy.
                                                             (line  570)
* object; class instance <2>:            Calls.              (line  140)
* object; code:                          The standard type hierarchy.
                                                             (line  619)
* object; code <1>:                      Methods.            (line   43)
* object; code <2>:                      marshal — Internal Python object serialization.
                                                             (line   30)
* object; code <3>:                      Cell Objects.       (line   53)
* object; complex:                       The standard type hierarchy.
                                                             (line  101)
* object; complex number:                Numeric Types — int float complex.
                                                             (line    6)
* object; complex number <1>:            Complex Number Objects.
                                                             (line    6)
* object; deallocation:                  Finalization and De-allocation.
                                                             (line    6)
* object; dictionary:                    The standard type hierarchy.
                                                             (line  242)
* object; dictionary <1>:                The standard type hierarchy.
                                                             (line  543)
* object; dictionary <2>:                Basic customization.
                                                             (line  219)
* object; dictionary <3>:                Dictionary displays.
                                                             (line    6)
* object; dictionary <4>:                Subscriptions.      (line    6)
* object; dictionary <5>:                Assignment statements.
                                                             (line  116)
* object; dictionary <6>:                Mapping Types — dict.
                                                             (line    6)
* object; dictionary <7>:                Dictionary Objects. (line    6)
* object; Ellipsis:                      The standard type hierarchy.
                                                             (line   41)
* object; file:                          Reading and Writing Files.
                                                             (line    6)
* object; file <1>:                      File Objects.       (line    6)
* object; finalization:                  Finalization and De-allocation.
                                                             (line    6)
* object; floating point:                The standard type hierarchy.
                                                             (line   89)
* object; floating point <1>:            Numeric Types — int float complex.
                                                             (line    6)
* object; floating point <2>:            Floating Point Objects.
                                                             (line    6)
* object; frame:                         The standard type hierarchy.
                                                             (line  679)
* object; frozenset:                     The standard type hierarchy.
                                                             (line  224)
* object; frozenset <1>:                 Set Objects.        (line    6)
* object; function:                      The standard type hierarchy.
                                                             (line  267)
* object; function <1>:                  The standard type hierarchy.
                                                             (line  455)
* object; function <2>:                  Calls.              (line  122)
* object; function <3>:                  Calls.              (line  131)
* object; function <4>:                  Function definitions.
                                                             (line    6)
* object; function <5>:                  Function Objects<3>.
                                                             (line    6)
* object; generator:                     The standard type hierarchy.
                                                             (line  657)
* object; generator <1>:                 Generator expressions.
                                                             (line    6)
* object; generator <2>:                 Yield expressions.  (line  108)
* object; immutable:                     The standard type hierarchy.
                                                             (line  128)
* object; immutable sequence:            The standard type hierarchy.
                                                             (line  128)
* object; instance:                      The standard type hierarchy.
                                                             (line  543)
* object; instance <1>:                  The standard type hierarchy.
                                                             (line  570)
* object; instance <2>:                  Calls.              (line  140)
* object; instancemethod:                Instance Method Objects.
                                                             (line    6)
* object; integer:                       The standard type hierarchy.
                                                             (line   59)
* object; integer <1>:                   Numeric Types — int float complex.
                                                             (line    6)
* object; integer <2>:                   Integer Objects.    (line    6)
* object; io.StringIO:                   Text Sequence Type — str.
                                                             (line   35)
* object; list:                          The standard type hierarchy.
                                                             (line  182)
* object; list <1>:                      List displays.      (line    6)
* object; list <2>:                      Attribute references.
                                                             (line   10)
* object; list <3>:                      Subscriptions.      (line    6)
* object; list <4>:                      Slicings.           (line    6)
* object; list <5>:                      Assignment statements.
                                                             (line  108)
* object; list <6>:                      Mutable Sequence Types.
                                                             (line    6)
* object; list <7>:                      Lists<2>.           (line    6)
* object; list <8>:                      List Objects.       (line    6)
* object; long integer:                  Integer Objects.    (line    6)
* object; mapping:                       The standard type hierarchy.
                                                             (line  231)
* object; mapping <1>:                   The standard type hierarchy.
                                                             (line  591)
* object; mapping <2>:                   Subscriptions.      (line    6)
* object; mapping <3>:                   Assignment statements.
                                                             (line  116)
* object; mapping <4>:                   Mapping Types — dict.
                                                             (line    6)
* object; mapping <5>:                   Container Objects.  (line    6)
* object; memoryview:                    Binary Sequence Types — bytes bytearray memoryview.
                                                             (line    6)
* object; memoryview <1>:                Ellipsis Object.    (line   11)
* object; method:                        Instance Objects.   (line   31)
* object; method <1>:                    The standard type hierarchy.
                                                             (line  358)
* object; method <2>:                    The standard type hierarchy.
                                                             (line  468)
* object; method <3>:                    Calls.              (line  131)
* object; method <4>:                    Methods.            (line    6)
* object; method <5>:                    Method Objects<2>.  (line    6)
* object; module:                        The standard type hierarchy.
                                                             (line  491)
* object; module <1>:                    Attribute references.
                                                             (line   10)
* object; module <2>:                    Module Objects.     (line    6)
* object; mutable:                       The standard type hierarchy.
                                                             (line  174)
* object; mutable <1>:                   Assignment statements.
                                                             (line    6)
* object; mutable <2>:                   Assignment statements.
                                                             (line  103)
* object; mutable sequence:              The standard type hierarchy.
                                                             (line  174)
* object; None:                          The standard type hierarchy.
                                                             (line   20)
* object; None <1>:                      Expression statements.
                                                             (line   17)
* object; None <2>:                      The None Object.    (line    6)
* object; NotImplemented:                The standard type hierarchy.
                                                             (line   28)
* object; numeric:                       The standard type hierarchy.
                                                             (line   47)
* object; numeric <1>:                   The standard type hierarchy.
                                                             (line  591)
* object; numeric <2>:                   Comparisons<2>.     (line   43)
* object; numeric <3>:                   Numeric Types — int float complex.
                                                             (line    6)
* object; numeric <4>:                   Numeric Objects.    (line    6)
* object; range:                         Ranges.             (line    6)
* object; sequence:                      The standard type hierarchy.
                                                             (line  109)
* object; sequence <1>:                  The standard type hierarchy.
                                                             (line  591)
* object; sequence <2>:                  Subscriptions.      (line    6)
* object; sequence <3>:                  Slicings.           (line    6)
* object; sequence <4>:                  Membership test operations.
                                                             (line   37)
* object; sequence <5>:                  Assignment statements.
                                                             (line  108)
* object; sequence <6>:                  The for statement.  (line    6)
* object; sequence <7>:                  Common Sequence Operations.
                                                             (line    6)
* object; sequence <8>:                  Sequence Objects.   (line    6)
* object; set:                           The standard type hierarchy.
                                                             (line  218)
* object; set <1>:                       Set displays.       (line    6)
* object; set <2>:                       Set Types — set frozenset.
                                                             (line    6)
* object; set <3>:                       Set Objects.        (line    6)
* object; set type:                      The standard type hierarchy.
                                                             (line  201)
* object; slice:                         Emulating container types.
                                                             (line   64)
* object; socket:                        socket — Low-level networking interface.
                                                             (line   17)
* object; string:                        Subscriptions.      (line    6)
* object; string <1>:                    Slicings.           (line    6)
* object; string <2>:                    Ranges.             (line  124)
* object; traceback:                     The standard type hierarchy.
                                                             (line  727)
* object; traceback <1>:                 The raise statement.
                                                             (line   21)
* object; traceback <2>:                 The try statement.  (line   68)
* object; traceback <3>:                 sys — System-specific parameters and functions.
                                                             (line  333)
* object; traceback <4>:                 traceback — Print or retrieve a stack traceback.
                                                             (line   16)
* object; tuple:                         The standard type hierarchy.
                                                             (line  154)
* object; tuple <1>:                     Subscriptions.      (line    6)
* object; tuple <2>:                     Slicings.           (line    6)
* object; tuple <3>:                     Expression lists.   (line   11)
* object; tuple <4>:                     Immutable Sequence Types.
                                                             (line    6)
* object; tuple <5>:                     Tuples.             (line    6)
* object; tuple <6>:                     Tuple Objects.      (line    6)
* object; type:                          Built-in Functions. (line 1663)
* object; type <1>:                      Objects Types and Reference Counts.
                                                             (line    6)
* object; type <2>:                      Type Objects<2>.    (line    6)
* object; user-defined function:         The standard type hierarchy.
                                                             (line  267)
* object; user-defined function <1>:     Calls.              (line  122)
* object; user-defined function <2>:     Function definitions.
                                                             (line    6)
* object; user-defined method:           The standard type hierarchy.
                                                             (line  358)
* objects; comparing:                    Comparisons<2>.     (line   43)
* object_filenames() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  467)
* objobjargproc (C type):                Slot Type typedefs. (line  122)
* objobjproc (C type):                   Slot Type typedefs. (line  120)
* obufcount() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  216)
* obuffree() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  221)
* oct() (built-in function):             Built-in Functions. (line  996)
* octal literal:                         Numeric literals.   (line    6)
* octal; literals:                       Numeric Types — int float complex.
                                                             (line   19)
* octdigits (in module string):          String constants.   (line   32)
* offset (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   54)
* offset (xml.parsers.expat.ExpatError attribute): ExpatError Exceptions.
                                                             (line   26)
* OK (in module curses):                 Constants<6>.       (line   13)
* old_value (contextvars.contextvars.Token.Token attribute): Context Variables.
                                                             (line   80)
* OleDLL (class in ctypes):              Loading shared libraries.
                                                             (line   16)
* onclick() (in module turtle):          Using events.       (line    6)
* onclick() (in module turtle) <1>:      Using screen events.
                                                             (line   47)
* ondrag() (in module turtle):           Using events.       (line   45)
* onecmd() (cmd.Cmd method):             Cmd Objects.        (line   57)
* onkey() (in module turtle):            Using screen events.
                                                             (line   12)
* onkeypress() (in module turtle):       Using screen events.
                                                             (line   30)
* onkeyrelease() (in module turtle):     Using screen events.
                                                             (line   12)
* onrelease() (in module turtle):        Using events.       (line   26)
* onscreenclick() (in module turtle):    Using screen events.
                                                             (line   47)
* ontimer() (in module turtle):          Using screen events.
                                                             (line   75)
* OP (in module token):                  token — Constants used with Python parse trees.
                                                             (line  242)
* open() (built-in function):            Built-in Functions. (line 1020)
* open() (distutils.text_file.TextFile method): distutils text_file — The TextFile class.
                                                             (line   91)
* open() (imaplib.IMAP4 method):         IMAP4 Objects.      (line  170)
* open() (in module aifc):               aifc — Read and write AIFF and AIFC files.
                                                             (line   30)
* open() (in module bz2):                De compression of files.
                                                             (line    6)
* open() (in module codecs):             codecs — Codec registry and base classes.
                                                             (line  167)
* open() (in module dbm):                dbm — Interfaces to Unix “databases”.
                                                             (line   35)
* open() (in module dbm.dumb):           dbm dumb — Portable DBM implementation.
                                                             (line   30)
* open() (in module dbm.gnu):            dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line   27)
* open() (in module dbm.ndbm):           dbm ndbm — Interface based on ndbm.
                                                             (line   31)
* open() (in module gzip):               gzip — Support for gzip files.
                                                             (line   28)
* open() (in module io):                 High-level Module Interface.
                                                             (line   12)
* open() (in module lzma):               Reading and writing compressed files.
                                                             (line    6)
* open() (in module os):                 File Descriptor Operations.
                                                             (line  250)
* open() (in module ossaudiodev):        ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line   42)
* open() (in module shelve):             shelve — Python object persistence.
                                                             (line   17)
* open() (in module sunau):              sunau — Read and write Sun AU files.
                                                             (line   48)
* open() (in module tarfile):            tarfile — Read and write tar archive files.
                                                             (line   35)
* open() (in module tokenize):           Tokenizing Input.   (line  100)
* open() (in module wave):               wave — Read and write WAV files.
                                                             (line   17)
* open() (in module webbrowser):         webbrowser — Convenient Web-browser controller.
                                                             (line   50)
* open() (pathlib.Path method):          Methods<2>.         (line  239)
* open() (pipes.Template method):        Template Objects.   (line   42)
* open() (tarfile.TarFile class method): TarFile Objects.    (line   96)
* open() (telnetlib.Telnet method):      Telnet Objects.     (line   65)
* open() (urllib.request.OpenerDirector method): OpenerDirector Objects.
                                                             (line   46)
* open() (urllib.request.URLopener method): Legacy interface.
                                                             (line   95)
* open() (webbrowser.controller method): Browser Controller Objects.
                                                             (line    9)
* open() (zipfile.Path method):          Path Objects.       (line   25)
* open() (zipfile.ZipFile method):       ZipFile Objects.    (line  109)
* OpenDatabase() (in module msilib):     msilib — Read and write Microsoft Installer files.
                                                             (line   45)
* OpenerDirector (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  266)
* openfp() (in module sunau):            sunau — Read and write Sun AU files.
                                                             (line   66)
* openfp() (in module wave):             wave — Read and write WAV files.
                                                             (line   48)
* OpenKey() (in module winreg):          Functions<11>.      (line  290)
* OpenKeyEx() (in module winreg):        Functions<11>.      (line  290)
* openlog() (in module syslog):          syslog — Unix syslog library routines.
                                                             (line   33)
* openmixer() (in module ossaudiodev):   ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line   70)
* openpty() (in module os):              File Descriptor Operations.
                                                             (line  344)
* openpty() (in module pty):             pty — Pseudo-terminal utilities.
                                                             (line   29)
* OpenSSL; (use in module hashlib):      Hash algorithms.    (line   21)
* OpenSSL; (use in module ssl):          ssl — TLS/SSL wrapper for socket objects.
                                                             (line    8)
* OPENSSL_VERSION (in module ssl):       Constants<9>.       (line  441)
* OPENSSL_VERSION_INFO (in module ssl):  Constants<9>.       (line  450)
* OPENSSL_VERSION_NUMBER (in module ssl): Constants<9>.      (line  459)
* OpenView() (msilib.Database method):   Database Objects.   (line    6)
* open_binary() (in module importlib.resources): importlib resources – Resources.
                                                             (line   53)
* open_code() (in module io):            High-level Module Interface.
                                                             (line   22)
* open_connection() (in module asyncio): Streams.            (line   25)
* open_new() (in module webbrowser):     webbrowser — Convenient Web-browser controller.
                                                             (line   67)
* open_new() (webbrowser.controller method): Browser Controller Objects.
                                                             (line   15)
* open_new_tab() (in module webbrowser): webbrowser — Convenient Web-browser controller.
                                                             (line   72)
* open_new_tab() (webbrowser.controller method): Browser Controller Objects.
                                                             (line   21)
* open_osfhandle() (in module msvcrt):   File Operations.    (line   41)
* open_resource() (importlib.abc.ResourceReader method): importlib abc – Abstract base classes related to import.
                                                             (line  309)
* open_text() (in module importlib.resources): importlib resources – Resources.
                                                             (line   64)
* open_unix_connection() (in module asyncio): Streams.       (line   81)
* open_unknown() (urllib.request.URLopener method): Legacy interface.
                                                             (line  106)
* open_urlresource() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  689)
* OperationalError:                      Exceptions<4>.      (line   32)
* operations on; dictionary; type:       Mapping Types — dict.
                                                             (line    6)
* operations on; integer; types:         Bitwise Operations on Integer Types.
                                                             (line    6)
* operations on; list; type:             Mutable Sequence Types.
                                                             (line   16)
* operations on; mapping; types:         Mapping Types — dict.
                                                             (line    6)
* operations on; numeric; types:         Numeric Types — int float complex.
                                                             (line   92)
* operations on; sequence; types:        Common Sequence Operations.
                                                             (line   21)
* operations on; sequence; types <1>:    Mutable Sequence Types.
                                                             (line   16)
* operator (2to3 fixer):                 Fixers.             (line  218)
* operator (module):                     operator — Standard operators as functions.
                                                             (line    6)
* operator; !=:                          Comparisons.        (line    6)
* operator; != <1>:                      Comparisons<2>.     (line    6)
* operator; % (percent):                 Binary arithmetic operations.
                                                             (line   35)
* operator; % (percent) <1>:             Numeric Types — int float complex.
                                                             (line   27)
* operator; & (ampersand):               Binary bitwise operations.
                                                             (line   12)
* operator; & (ampersand) <1>:           Bitwise Operations on Integer Types.
                                                             (line    6)
* operator; * (asterisk):                Binary arithmetic operations.
                                                             (line   16)
* operator; * (asterisk) <1>:            Numeric Types — int float complex.
                                                             (line   27)
* operator; **:                          The power operator. (line    6)
* operator; ** <1>:                      Numeric Types — int float complex.
                                                             (line   27)
* operator; + (plus):                    Unary arithmetic and bitwise operations.
                                                             (line   13)
* operator; + (plus) <1>:                Binary arithmetic operations.
                                                             (line   60)
* operator; + (plus) <2>:                Numeric Types — int float complex.
                                                             (line   27)
* operator; - (minus):                   Unary arithmetic and bitwise operations.
                                                             (line   10)
* operator; - (minus) <1>:               Binary arithmetic operations.
                                                             (line   66)
* operator; - (minus) <2>:               Numeric Types — int float complex.
                                                             (line   27)
* operator; / (slash):                   Binary arithmetic operations.
                                                             (line   28)
* operator; / (slash) <1>:               Numeric Types — int float complex.
                                                             (line   27)
* operator; //:                          Binary arithmetic operations.
                                                             (line   28)
* operator; // <1>:                      Numeric Types — int float complex.
                                                             (line   27)
* operator; < (less):                    Comparisons.        (line    6)
* operator; < (less) <1>:                Comparisons<2>.     (line    6)
* operator; <<:                          Shifting operations.
                                                             (line    6)
* operator; << <1>:                      Bitwise Operations on Integer Types.
                                                             (line    6)
* operator; <=:                          Comparisons.        (line    6)
* operator; <= <1>:                      Comparisons<2>.     (line    6)
* operator; ==:                          Comparisons.        (line    6)
* operator; == <1>:                      Comparisons<2>.     (line    6)
* operator; > (greater):                 Comparisons.        (line    6)
* operator; > (greater) <1>:             Comparisons<2>.     (line    6)
* operator; >=:                          Comparisons.        (line    6)
* operator; >= <1>:                      Comparisons<2>.     (line    6)
* operator; >>:                          Shifting operations.
                                                             (line    6)
* operator; >> <1>:                      Bitwise Operations on Integer Types.
                                                             (line    6)
* operator; @ (at):                      Binary arithmetic operations.
                                                             (line   23)
* operator; and:                         Boolean operations. (line   21)
* operator; and <1>:                     Truth Value Testing.
                                                             (line   23)
* operator; and <2>:                     Boolean Operations — and or not.
                                                             (line   22)
* operator; comparison:                  Comparisons<2>.     (line    6)
* operator; in:                          Membership test operations.
                                                             (line   37)
* operator; in <1>:                      Comparisons<2>.     (line   64)
* operator; in <2>:                      Common Sequence Operations.
                                                             (line   21)
* operator; is:                          Membership test operations.
                                                             (line   40)
* operator; is <1>:                      Comparisons<2>.     (line    6)
* operator; is not:                      Membership test operations.
                                                             (line   40)
* operator; is not <1>:                  Comparisons<2>.     (line    6)
* operator; not:                         Boolean operations. (line   18)
* operator; not <1>:                     Boolean Operations — and or not.
                                                             (line   22)
* operator; not in:                      Membership test operations.
                                                             (line   37)
* operator; not in <1>:                  Comparisons<2>.     (line   64)
* operator; not in <2>:                  Common Sequence Operations.
                                                             (line   21)
* operator; or:                          Boolean operations. (line   25)
* operator; or <1>:                      Truth Value Testing.
                                                             (line   23)
* operator; or <2>:                      Boolean Operations — and or not.
                                                             (line   22)
* operator; overloading:                 Special method names.
                                                             (line    6)
* operator; precedence:                  Operator precedence.
                                                             (line    6)
* operator; ^ (caret):                   Binary bitwise operations.
                                                             (line   15)
* operator; ^ (caret) <1>:               Bitwise Operations on Integer Types.
                                                             (line    6)
* operator; | (vertical bar):            Binary bitwise operations.
                                                             (line   18)
* operator; | (vertical bar) <1>:        Bitwise Operations on Integer Types.
                                                             (line    6)
* operator; ~ (tilde):                   Unary arithmetic and bitwise operations.
                                                             (line   15)
* operator; ~ (tilde) <1>:               Bitwise Operations on Integer Types.
                                                             (line    6)
* operators:                             Operators.          (line    6)
* opmap (in module dis):                 Opcode collections. (line   13)
* opname (in module dis):                Opcode collections. (line    9)
* optimize() (in module pickletools):    Programmatic Interface<2>.
                                                             (line   31)
* OPTIMIZED_BYTECODE_SUFFIXES (in module importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   30)
* optim_args_from_interpreter_flags() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  383)
* Optional (in module typing):           Classes functions and decorators.
                                                             (line  680)
* OptionGroup (class in optparse):       Grouping Options.   (line   12)
* OptionMenu (class in tkinter.tix):     Basic Widgets.      (line   49)
* OptionParser (class in optparse):      Creating the parser.
                                                             (line    9)
* Options (class in ssl):                Constants<9>.       (line  340)
* options (doctest.Example attribute):   Example Objects.    (line   53)
* options (ssl.SSLContext attribute):    SSL Contexts.       (line  533)
* options() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  102)
* optionxform() (configparser.ConfigParser method): Customizing Parser Behaviour.
                                                             (line  266)
* optionxform() (configparser.ConfigParser method) <1>: ConfigParser Objects.
                                                             (line  279)
* optparse (module):                     optparse — Parser for command line options.
                                                             (line    6)
* OP_ALL (in module ssl):                Constants<9>.       (line  209)
* OP_CIPHER_SERVER_PREFERENCE (in module ssl): Constants<9>. (line  298)
* OP_ENABLE_MIDDLEBOX_COMPAT (in module ssl): Constants<9>.  (line  322)
* OP_NO_COMPRESSION (in module ssl):     Constants<9>.       (line  331)
* OP_NO_RENEGOTIATION (in module ssl):   Constants<9>.       (line  288)
* OP_NO_SSLv2 (in module ssl):           Constants<9>.       (line  217)
* OP_NO_SSLv3 (in module ssl):           Constants<9>.       (line  227)
* OP_NO_TICKET (in module ssl):          Constants<9>.       (line  344)
* OP_NO_TLSv1 (in module ssl):           Constants<9>.       (line  237)
* OP_NO_TLSv1_1 (in module ssl):         Constants<9>.       (line  249)
* OP_NO_TLSv1_2 (in module ssl):         Constants<9>.       (line  261)
* OP_NO_TLSv1_3 (in module ssl):         Constants<9>.       (line  273)
* OP_SINGLE_DH_USE (in module ssl):      Constants<9>.       (line  306)
* OP_SINGLE_ECDH_USE (in module ssl):    Constants<9>.       (line  314)
* ord() (built-in function):             Built-in Functions. (line 1259)
* OrderedDict (class in collections):    OrderedDict objects.
                                                             (line   39)
* OrderedDict (class in typing):         Classes functions and decorators.
                                                             (line  316)
* ordered_attributes (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  107)
* origin (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  377)
* origin_req_host (urllib.request.Request attribute): Request Objects.
                                                             (line   30)
* origin_server (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  287)
* or_() (in module operator):            operator — Standard operators as functions.
                                                             (line  133)
* os (module):                           os — Miscellaneous operating system interfaces.
                                                             (line    6)
* os.path (module):                      os path — Common pathname manipulations.
                                                             (line    6)
* OSError:                               Concrete exceptions.
                                                             (line  113)
* ossaudiodev (module):                  ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line    6)
* OSSAudioError:                         ossaudiodev — Access to OSS-compatible audio devices.
                                                             (line   29)
* os_environ (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  165)
* output:                                Expression statements.
                                                             (line   17)
* output (subprocess.CalledProcessError attribute): Using the subprocess Module.
                                                             (line  194)
* output (subprocess.TimeoutExpired attribute): Using the subprocess Module.
                                                             (line  161)
* output (unittest.TestCase attribute):  Test cases.         (line  413)
* output() (http.cookies.BaseCookie method): Cookie Objects. (line   24)
* output() (http.cookies.Morsel method): Morsel Objects.     (line   72)
* OutputChecker (class in doctest):      OutputChecker objects.
                                                             (line    6)
* OutputString() (http.cookies.Morsel method): Morsel Objects.
                                                             (line   87)
* output_charset (email.charset.Charset attribute): email charset Representing character sets.
                                                             (line   74)
* output_charset() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   87)
* output_codec (email.charset.Charset attribute): email charset Representing character sets.
                                                             (line   88)
* output_difference() (doctest.OutputChecker method): OutputChecker objects.
                                                             (line   27)
* over() (nntplib.NNTP method):          Methods<3>.         (line  156)
* Overflow (class in decimal):           Signals.            (line   67)
* OverflowError:                         Concrete exceptions.
                                                             (line  177)
* OverflowError (built-in exception):    Integer Objects.    (line  112)
* OverflowError (built-in exception) <1>: Integer Objects.   (line  151)
* OverflowError (built-in exception) <2>: Integer Objects.   (line  193)
* OverflowError (built-in exception) <3>: Integer Objects.   (line  204)
* OverflowError (built-in exception) <4>: Integer Objects.   (line  215)
* OverflowError (built-in exception) <5>: Integer Objects.   (line  227)
* overlap() (statistics.NormalDist method): NormalDist objects.
                                                             (line   96)
* overlaps() (ipaddress.IPv4Network method): Network objects.
                                                             (line  147)
* overlaps() (ipaddress.IPv6Network method): Network objects.
                                                             (line  297)
* overlay() (curses.window method):      Window Objects.     (line  427)
* overload() (in module typing):         Classes functions and decorators.
                                                             (line  547)
* overwrite() (curses.window method):    Window Objects.     (line  440)
* owner() (pathlib.Path method):         Methods<2>.         (line  251)
* O_APPEND (in module os):               File Descriptor Operations.
                                                             (line  295)
* O_ASYNC (in module os):                File Descriptor Operations.
                                                             (line  327)
* O_BINARY (in module os):               File Descriptor Operations.
                                                             (line  317)
* O_CLOEXEC (in module os):              File Descriptor Operations.
                                                             (line  305)
* O_CREAT (in module os):                File Descriptor Operations.
                                                             (line  295)
* O_DIRECT (in module os):               File Descriptor Operations.
                                                             (line  327)
* O_DIRECTORY (in module os):            File Descriptor Operations.
                                                             (line  327)
* O_DSYNC (in module os):                File Descriptor Operations.
                                                             (line  305)
* O_EXCL (in module os):                 File Descriptor Operations.
                                                             (line  295)
* O_EXLOCK (in module os):               File Descriptor Operations.
                                                             (line  327)
* O_NDELAY (in module os):               File Descriptor Operations.
                                                             (line  305)
* O_NOATIME (in module os):              File Descriptor Operations.
                                                             (line  327)
* O_NOCTTY (in module os):               File Descriptor Operations.
                                                             (line  305)
* O_NOFOLLOW (in module os):             File Descriptor Operations.
                                                             (line  327)
* O_NOINHERIT (in module os):            File Descriptor Operations.
                                                             (line  317)
* O_NONBLOCK (in module os):             File Descriptor Operations.
                                                             (line  305)
* O_PATH (in module os):                 File Descriptor Operations.
                                                             (line  327)
* O_RANDOM (in module os):               File Descriptor Operations.
                                                             (line  317)
* O_RDONLY (in module os):               File Descriptor Operations.
                                                             (line  295)
* O_RDWR (in module os):                 File Descriptor Operations.
                                                             (line  295)
* O_RSYNC (in module os):                File Descriptor Operations.
                                                             (line  305)
* O_SEQUENTIAL (in module os):           File Descriptor Operations.
                                                             (line  317)
* O_SHLOCK (in module os):               File Descriptor Operations.
                                                             (line  327)
* O_SHORT_LIVED (in module os):          File Descriptor Operations.
                                                             (line  317)
* O_SYNC (in module os):                 File Descriptor Operations.
                                                             (line  305)
* O_TEMPORARY (in module os):            File Descriptor Operations.
                                                             (line  317)
* O_TEXT (in module os):                 File Descriptor Operations.
                                                             (line  317)
* O_TMPFILE (in module os):              File Descriptor Operations.
                                                             (line  327)
* O_TRUNC (in module os):                File Descriptor Operations.
                                                             (line  295)
* O_WRONLY (in module os):               File Descriptor Operations.
                                                             (line  295)
* p (pdb command):                       Debugger Commands.  (line  230)
* pack() (in module struct):             Functions and Exceptions.
                                                             (line   13)
* pack() (mailbox.MH method):            MH.                 (line   64)
* pack() (struct.Struct method):         Classes<2>.         (line   25)
* package:                               Packages<2>.        (line    6)
* package <1>:                           site — Site-specific configuration hook.
                                                             (line   64)
* package <2>:                           Glossary.           (line  897)
* Package (in module importlib.resources): importlib resources – Resources.
                                                             (line   37)
* package variable; __all__:             Importing Modules<2>.
                                                             (line    7)
* package; namespace:                    Namespace packages. (line    6)
* package; portion:                      Namespace packages. (line    6)
* package; regular:                      Regular packages.   (line    6)
* packed (ipaddress.IPv4Address attribute): Address objects. (line   60)
* packed (ipaddress.IPv6Address attribute): Address objects. (line  154)
* Packer (class in xdrlib):              xdrlib — Encode and decode XDR data.
                                                             (line   18)
* packing (widgets):                     The Packer.         (line    6)
* packing; binary; data:                 struct — Interpret bytes as packed binary data.
                                                             (line    8)
* pack_array() (xdrlib.Packer method):   Packer Objects.     (line   86)
* pack_bytes() (xdrlib.Packer method):   Packer Objects.     (line   54)
* pack_double() (xdrlib.Packer method):  Packer Objects.     (line   26)
* pack_farray() (xdrlib.Packer method):  Packer Objects.     (line   78)
* pack_float() (xdrlib.Packer method):   Packer Objects.     (line   22)
* pack_fopaque() (xdrlib.Packer method): Packer Objects.     (line   38)
* pack_fstring() (xdrlib.Packer method): Packer Objects.     (line   32)
* pack_into() (in module struct):        Functions and Exceptions.
                                                             (line   19)
* pack_into() (struct.Struct method):    Classes<2>.         (line   30)
* pack_list() (xdrlib.Packer method):    Packer Objects.     (line   61)
* pack_opaque() (xdrlib.Packer method):  Packer Objects.     (line   49)
* pack_string() (xdrlib.Packer method):  Packer Objects.     (line   43)
* PAGER:                                 pydoc — Documentation generator and online help system.
                                                             (line   47)
* pair_content() (in module curses):     Functions<3>.       (line  361)
* pair_number() (in module curses):      Functions<3>.       (line  367)
* PanedWindow (class in tkinter.tix):    Manager Widgets.    (line    6)
* parameter:                             Glossary.           (line  906)
* Parameter (class in inspect):          Introspecting callables with the Signature object.
                                                             (line  121)
* parameter; call semantics:             Calls.              (line   24)
* parameter; difference from argument:   How can I pass optional or keyword parameters from one function to another?.
                                                             (line   12)
* parameter; function definition:        The with statement. (line   76)
* ParameterizedMIMEHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  253)
* parameters (inspect.Signature attribute): Introspecting callables with the Signature object.
                                                             (line   66)
* params (email.headerregistry.ParameterizedMIMEHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  261)
* pardir (in module os):                 Miscellaneous System Information.
                                                             (line   87)
* paren (2to3 fixer):                    Fixers.             (line  250)
* parent (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  405)
* parent (pyclbr.Class attribute):       Class Objects<2>.   (line   25)
* parent (pyclbr.Function attribute):    Function Objects.   (line   25)
* parent (urllib.request.BaseHandler attribute): BaseHandler Objects.
                                                             (line   25)
* parent() (tkinter.ttk.Treeview method): ttk Treeview.      (line  237)
* parenthesized form:                    Parenthesized forms.
                                                             (line    6)
* parentNode (xml.dom.Node attribute):   Node Objects.       (line   17)
* parents (collections.ChainMap attribute): ChainMap objects.
                                                             (line   59)
* parent_process() (in module multiprocessing): Miscellaneous<3>.
                                                             (line   35)
* paretovariate() (in module random):    Real-valued distributions.
                                                             (line   83)
* parse() (doctest.DocTestParser method): DocTestParser objects.
                                                             (line   29)
* parse() (email.parser.BytesParser method): Parser API.     (line   34)
* parse() (email.parser.Parser method):  Parser API.         (line   86)
* parse() (in module ast):               ast Helpers.        (line    9)
* parse() (in module cgi):               Functions<8>.       (line    9)
* parse() (in module xml.dom.minidom):   xml dom minidom — Minimal DOM implementation.
                                                             (line   30)
* parse() (in module xml.dom.pulldom):   xml dom pulldom — Support for building partial DOM trees.
                                                             (line   73)
* parse() (in module xml.etree.ElementTree): Functions<6>.   (line  153)
* parse() (in module xml.sax):           xml sax — Support for SAX2 parsers.
                                                             (line   39)
* parse() (string.Formatter method):     Custom String Formatting.
                                                             (line   40)
* parse() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   29)
* parse() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   59)
* Parse() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line    8)
* parse() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line    8)
* parseaddr() (in module email.utils):   email utils Miscellaneous utilities.
                                                             (line   59)
* parsebytes() (email.parser.BytesParser method): Parser API.
                                                             (line   54)
* parsedate() (in module email.utils):   email utils Miscellaneous utilities.
                                                             (line   90)
* parsedate_to_datetime() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line  113)
* parsedate_tz() (in module email.utils): email utils Miscellaneous utilities.
                                                             (line  102)
* ParseError (class in xml.etree.ElementTree): Exceptions<15>.
                                                             (line    6)
* ParseFile() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line   16)
* ParseFlags() (in module imaplib):      imaplib — IMAP4 protocol client.
                                                             (line  114)
* parser:                                Lexical analysis.   (line    6)
* Parser (class in email.parser):        Parser API.         (line   75)
* parser (module):                       parser — Access Python parse trees.
                                                             (line    6)
* ParserCreate() (in module xml.parsers.expat): xml parsers expat — Fast XML parsing using Expat.
                                                             (line   46)
* ParserError:                           Exceptions and Error Handling.
                                                             (line   11)
* ParseResult (class in urllib.parse):   Structured Parse Results.
                                                             (line   41)
* ParseResultBytes (class in urllib.parse): Structured Parse Results.
                                                             (line   66)
* parsestr() (email.parser.Parser method): Parser API.       (line   96)
* parseString() (in module xml.dom.minidom): xml dom minidom — Minimal DOM implementation.
                                                             (line   43)
* parseString() (in module xml.dom.pulldom): xml dom pulldom — Support for building partial DOM trees.
                                                             (line   86)
* parseString() (in module xml.sax):     xml sax — Support for SAX2 parsers.
                                                             (line   50)
* parse_and_bind() (in module readline): Init file.          (line    8)
* parse_args() (argparse.ArgumentParser method): The parse_args method.
                                                             (line    6)
* PARSE_COLNAMES (in module sqlite3):    Module functions and constants.
                                                             (line   38)
* parse_config_h() (in module sysconfig): Other functions<3>.
                                                             (line   57)
* PARSE_DECLTYPES (in module sqlite3):   Module functions and constants.
                                                             (line   25)
* parse_header() (in module cgi):        Functions<8>.       (line   37)
* parse_headers() (in module http.client): http client — HTTP protocol client.
                                                             (line  105)
* parse_intermixed_args() (argparse.ArgumentParser method): Intermixed parsing.
                                                             (line    6)
* parse_known_args() (argparse.ArgumentParser method): Partial parsing.
                                                             (line    6)
* parse_known_intermixed_args() (argparse.ArgumentParser method): Intermixed parsing.
                                                             (line    9)
* parse_multipart() (in module cgi):     Functions<8>.       (line   17)
* parse_qs() (in module urllib.parse):   URL Parsing.        (line  114)
* parse_qsl() (in module urllib.parse):  URL Parsing.        (line  151)
* parsing; Python source code:           parser — Access Python parse trees.
                                                             (line    6)
* ParsingError:                          Exceptions<5>.      (line   65)
* partial (asyncio.IncompleteReadError attribute): Exceptions<9>.
                                                             (line   54)
* partial() (imaplib.IMAP4 method):      IMAP4 Objects.      (line  182)
* partial() (in module functools):       functools — Higher-order functions and operations on callable objects.
                                                             (line  216)
* partialmethod (class in functools):    functools — Higher-order functions and operations on callable objects.
                                                             (line  247)
* parties (threading.Barrier attribute): Barrier Objects.    (line   77)
* partition() (bytearray method):        Bytes and Bytearray Operations.
                                                             (line  132)
* partition() (bytes method):            Bytes and Bytearray Operations.
                                                             (line  132)
* partition() (str method):              String Methods<2>.  (line  331)
* pass_() (poplib.POP3 method):          POP3 Objects.       (line   36)
* Paste:                                 Help menu Shell and Editor.
                                                             (line   30)
* patch() (in module test.support):      test support — Utilities for the Python test suite.
                                                             (line  891)
* patch() (in module unittest.mock):     patch.              (line   10)
* patch.dict() (in module unittest.mock): patch dict.        (line    6)
* patch.multiple() (in module unittest.mock): patch multiple.
                                                             (line    6)
* patch.object() (in module unittest.mock): patch object.    (line    6)
* patch.stopall() (in module unittest.mock): patch methods start and stop.
                                                             (line   39)
* PATH:                                  Changes in the Python API.
                                                             (line  137)
* PATH <1>:                              Changes in ‘python’ Command Behavior<2>.
                                                             (line    6)
* PATH <2>:                              Changes in ‘python’ Command Behavior<2>.
                                                             (line   11)
* PATH <3>:                              Changes in ‘python’ Command Behavior<2>.
                                                             (line   12)
* PATH <4>:                              Security<7>.        (line   16)
* PATH <5>:                              Security<7>.        (line   20)
* PATH <6>:                              The Module Search Path.
                                                             (line   16)
* PATH <7>:                              Executable Python Scripts.
                                                             (line   11)
* PATH <8>:                              Environment variables.
                                                             (line   27)
* PATH <9>:                              Miscellaneous.      (line   16)
* PATH <10>:                             Installation steps. (line   32)
* PATH <11>:                             Installation steps. (line   56)
* PATH <12>:                             Installing Without UI.
                                                             (line   57)
* PATH <13>:                             Excursus Setting environment variables.
                                                             (line   23)
* PATH <14>:                             Excursus Setting environment variables.
                                                             (line   35)
* PATH <15>:                             Finding the Python executable.
                                                             (line   14)
* PATH <16>:                             Finding the Python executable.
                                                             (line   21)
* PATH <17>:                             Finding the Python executable.
                                                             (line   22)
* PATH <18>:                             Python Launcher for Windows.
                                                             (line   13)
* PATH <19>:                             From the command-line.
                                                             (line    9)
* PATH <20>:                             From the command-line.
                                                             (line   38)
* PATH <21>:                             Shebang Lines.      (line   48)
* PATH <22>:                             Shebang Lines.      (line   50)
* PATH <23>:                             Process Management. (line   42)
* PATH <24>:                             Process Management. (line   83)
* PATH <25>:                             Process Management. (line   86)
* PATH <26>:                             Process Management. (line   89)
* PATH <27>:                             Process Management. (line  433)
* PATH <28>:                             Process Management. (line  516)
* PATH <29>:                             Process Management. (line  520)
* PATH <30>:                             Process Management. (line  522)
* PATH <31>:                             Miscellaneous System Information.
                                                             (line  118)
* PATH <32>:                             webbrowser — Convenient Web-browser controller.
                                                             (line  208)
* PATH <33>:                             Installing your CGI script on a Unix system.
                                                             (line   29)
* PATH <34>:                             Common problems and solutions.
                                                             (line   23)
* PATH <35>:                             site — Site-specific configuration hook.
                                                             (line   59)
* PATH <36>:                             Embedding Python<2>.
                                                             (line   31)
* PATH <37>:                             Embedding Python<2>.
                                                             (line   37)
* PATH <38>:                             How do I make a Python script executable on Unix?.
                                                             (line   24)
* PATH <39>:                             How do I make a Python script executable on Unix?.
                                                             (line   28)
* Path (class in pathlib):               Concrete paths.     (line   11)
* Path (class in zipfile):               Path Objects.       (line    6)
* path (http.cookiejar.Cookie attribute): Cookie Objects<2>. (line   41)
* path (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   89)
* path (importlib.abc.FileLoader attribute): importlib abc – Abstract base classes related to import.
                                                             (line  478)
* path (importlib.machinery.ExtensionFileLoader attribute): importlib machinery – Importers and path hooks.
                                                             (line  311)
* path (importlib.machinery.FileFinder attribute): importlib machinery – Importers and path hooks.
                                                             (line  182)
* path (importlib.machinery.SourceFileLoader attribute): importlib machinery – Importers and path hooks.
                                                             (line  224)
* path (importlib.machinery.SourcelessFileLoader attribute): importlib machinery – Importers and path hooks.
                                                             (line  268)
* path (in module sys):                  sys — System-specific parameters and functions.
                                                             (line 1015)
* path (in module sys) <1>:              Embedding Python<2>.
                                                             (line   12)
* path (in module sys) <2>:              Initializing and finalizing the interpreter.
                                                             (line    8)
* path (in module sys) <3>:              Process-wide parameters.
                                                             (line  120)
* path (in module sys) <4>:              Process-wide parameters.
                                                             (line  133)
* path (os.DirEntry attribute):          Files and Directories.
                                                             (line  802)
* path based finder:                     The Path Based Finder.
                                                             (line    6)
* path based finder <1>:                 Glossary.           (line  975)
* Path browser:                          File menu Shell and Editor.
                                                             (line   22)
* path entry:                            Glossary.           (line  955)
* path entry finder:                     Glossary.           (line  960)
* path entry hook:                       Glossary.           (line  969)
* path hooks:                            Import hooks.       (line    6)
* path() (in module importlib.resources): importlib resources – Resources.
                                                             (line  105)
* path-like object:                      Glossary.           (line  980)
* path; configuration; file:             site — Site-specific configuration hook.
                                                             (line   64)
* path; operations:                      pathlib — Object-oriented filesystem paths.
                                                             (line   10)
* path; operations <1>:                  os path — Common pathname manipulations.
                                                             (line    9)
* pathconf() (in module os):             Files and Directories.
                                                             (line  513)
* pathconf_names (in module os):         Files and Directories.
                                                             (line  537)
* PathEntryFinder (class in importlib.abc): importlib abc – Abstract base classes related to import.
                                                             (line   87)
* PATHEXT:                               Other Improvements<2>.
                                                             (line   30)
* PATHEXT <1>:                           Installing Without UI.
                                                             (line   58)
* PathFinder (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line  104)
* pathlib (module):                      pathlib — Object-oriented filesystem paths.
                                                             (line    6)
* PathLike (class in os):                Process Parameters. (line  113)
* pathname2url() (in module urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  147)
* pathsep (in module os):                Miscellaneous System Information.
                                                             (line  115)
* path_hook() (importlib.machinery.FileFinder class method): importlib machinery – Importers and path hooks.
                                                             (line  202)
* path_hooks (in module sys):            sys — System-specific parameters and functions.
                                                             (line 1040)
* path_importer_cache (in module sys):   sys — System-specific parameters and functions.
                                                             (line 1049)
* path_mtime() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  544)
* path_return_ok() (http.cookiejar.CookiePolicy method): CookiePolicy Objects.
                                                             (line   56)
* path_stats() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  522)
* path_stats() (importlib.machinery.SourceFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  233)
* Pattern (class in typing):             Classes functions and decorators.
                                                             (line  407)
* pattern (re.error attribute):          Module Contents.    (line  366)
* pattern (re.Pattern attribute):        Regular Expression Objects.
                                                             (line  118)
* pause() (in module signal):            Module contents<2>. (line  156)
* pause_reading() (asyncio.ReadTransport method): Read-only Transports.
                                                             (line   12)
* pause_writing() (asyncio.BaseProtocol method): Base Protocol.
                                                             (line   40)
* PAX_FORMAT (in module tarfile):        tarfile — Read and write tar archive files.
                                                             (line  230)
* pax_headers (tarfile.TarFile attribute): TarFile Objects.  (line  253)
* pax_headers (tarfile.TarInfo attribute): TarInfo Objects.  (line   88)
* pbkdf2_hmac() (in module hashlib):     Key derivation.     (line   11)
* pd() (in module turtle):               Drawing state.      (line    6)
* Pdb (class in pdb):                    pdb — The Python Debugger.
                                                             (line   17)
* Pdb (class in pdb) <1>:                pdb — The Python Debugger.
                                                             (line  124)
* pdb (module):                          pdb — The Python Debugger.
                                                             (line    6)
* pdf() (statistics.NormalDist method):  NormalDist objects. (line   68)
* peek() (bz2.BZ2File method):           De compression of files.
                                                             (line   77)
* peek() (gzip.GzipFile method):         gzip — Support for gzip files.
                                                             (line  125)
* peek() (io.BufferedReader method):     Buffered Streams.   (line   73)
* peek() (lzma.LZMAFile method):         Reading and writing compressed files.
                                                             (line   85)
* peek() (weakref.finalize method):      weakref — Weak references.
                                                             (line  279)
* peer (smtpd.SMTPChannel attribute):    SMTPChannel Objects.
                                                             (line   95)
* PEM_cert_to_DER_cert() (in module ssl): Certificate handling.
                                                             (line   84)
* pen() (in module turtle):              Drawing state.      (line   31)
* pencolor() (in module turtle):         Color control.      (line    6)
* pending (ssl.MemoryBIO attribute):     Memory BIO Support<2>.
                                                             (line  133)
* pending() (ssl.SSLSocket method):      SSL Sockets.        (line  296)
* PendingDeprecationWarning:             Warnings.           (line   22)
* pendown() (in module turtle):          Drawing state.      (line    6)
* pensize() (in module turtle):          Drawing state.      (line   18)
* penup() (in module turtle):            Drawing state.      (line   12)
* PEP:                                   Glossary.           (line  992)
* PERCENT (in module token):             token — Constants used with Python parse trees.
                                                             (line  122)
* PERCENTEQUAL (in module token):        token — Constants used with Python parse trees.
                                                             (line  186)
* Performance:                           timeit — Measure execution time of small code snippets.
                                                             (line    8)
* perf_counter() (in module time):       Functions<2>.       (line  182)
* perf_counter_ns() (in module time):    Functions<2>.       (line  193)
* perm() (in module math):               Number-theoretic and representation functions.
                                                             (line  177)
* PermissionError:                       OS exceptions.      (line   92)
* permutations() (in module itertools):  Itertool functions. (line  398)
* Persist() (msilib.SummaryInformation method): Summary Information Objects.
                                                             (line   29)
* persistence:                           pickle — Python object serialization.
                                                             (line    8)
* persistent; objects:                   pickle — Python object serialization.
                                                             (line    8)
* persistent_id (pickle protocol):       Persistence of External Objects.
                                                             (line    6)
* persistent_id() (pickle.Pickler method): Module Interface. (line  159)
* persistent_load (pickle protocol):     Persistence of External Objects.
                                                             (line    6)
* persistent_load() (pickle.Unpickler method): Module Interface.
                                                             (line  273)
* pformat() (in module pprint):          pprint — Data pretty printer.
                                                             (line   81)
* pformat() (pprint.PrettyPrinter method): PrettyPrinter Objects.
                                                             (line    8)
* PF_CAN (in module socket):             Constants<8>.       (line   93)
* PF_PACKET (in module socket):          Constants<8>.       (line  144)
* PF_RDS (in module socket):             Constants<8>.       (line  154)
* pgettext() (gettext.GNUTranslations method): The GNUTranslations class.
                                                             (line   63)
* pgettext() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   47)
* pgettext() (in module gettext):        GNU gettext API.    (line   73)
* PGO (in module test.support):          test support — Utilities for the Python test suite.
                                                             (line   91)
* phase() (in module cmath):             Conversions to and from polar coordinates.
                                                             (line   22)
* Philbrick, Geoff:                      Keyword Parameters for Extension Functions.
                                                             (line   24)
* physical line:                         Logical lines.      (line    6)
* physical line <1>:                     Explicit line joining.
                                                             (line    6)
* physical line <2>:                     String and Bytes literals.
                                                             (line   72)
* pi (in module cmath):                  Constants<3>.       (line    6)
* pi (in module math):                   Constants<2>.       (line    6)
* pi() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   56)
* pickle (module):                       pickle — Python object serialization.
                                                             (line    6)
* pickle() (in module copyreg):          copyreg — Register pickle support functions.
                                                             (line   23)
* PickleBuffer (class in pickle):        Module Interface.   (line  300)
* PickleError:                           Module Interface.   (line   94)
* Pickler (class in pickle):             Module Interface.   (line  120)
* pickletools (module):                  pickletools — Tools for pickle developers.
                                                             (line    6)
* pickletools command line option; -a, –annotate: Command line options<3>.
                                                             (line    6)
* pickletools command line option; -l, –indentlevel=<num>: Command line options<3>.
                                                             (line   14)
* pickletools command line option; -m, –memo: Command line options<3>.
                                                             (line   18)
* pickletools command line option; -o, –output=<file>: Command line options<3>.
                                                             (line   10)
* pickletools command line option; -p, –preamble=<preamble>: Command line options<3>.
                                                             (line   23)
* pickling; objects:                     pickle — Python object serialization.
                                                             (line    8)
* PicklingError:                         Module Interface.   (line   99)
* pid (asyncio.asyncio.subprocess.Process attribute): Interacting with Subprocesses.
                                                             (line  132)
* pid (multiprocessing.Process attribute): Process and exceptions.
                                                             (line  108)
* pid (subprocess.Popen attribute):      Popen Objects.      (line  132)
* PIPE (in module subprocess):           Using the subprocess Module.
                                                             (line  129)
* Pipe() (in module multiprocessing):    Pipes and Queues.   (line   74)
* pipe() (in module os):                 File Descriptor Operations.
                                                             (line  356)
* pipe2() (in module os):                File Descriptor Operations.
                                                             (line  367)
* pipes (module):                        pipes — Interface to shell pipelines.
                                                             (line    6)
* PIPE_BUF (in module select):           select — Waiting for I/O completion.
                                                             (line  157)
* pipe_connection_lost() (asyncio.SubprocessProtocol method): Subprocess Protocols.
                                                             (line   19)
* pipe_data_received() (asyncio.SubprocessProtocol method): Subprocess Protocols.
                                                             (line   10)
* PIPE_MAX_SIZE (in module test.support): test support — Utilities for the Python test suite.
                                                             (line   95)
* PIP_USER:                              Windows<6>.         (line    7)
* pkgutil (module):                      pkgutil — Package extension utility.
                                                             (line    6)
* PKG_DIRECTORY (in module imp):         imp — Access the import internals.
                                                             (line  324)
* placeholder (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  266)
* PLAT:                                  distutils util — Miscellaneous other utility functions.
                                                             (line   79)
* platform (in module sys):              sys — System-specific parameters and functions.
                                                             (line 1062)
* platform (in module sys) <1>:          Process-wide parameters.
                                                             (line  172)
* platform (module):                     platform — Access to underlying platform’s identifying data.
                                                             (line    6)
* platform() (in module platform):       Cross Platform.     (line   46)
* PlaySound() (in module winsound):      winsound — Sound-playing interface for Windows.
                                                             (line   20)
* plist; file:                           plistlib — Generate and parse Mac OS X plist files.
                                                             (line    8)
* plistlib (module):                     plistlib — Generate and parse Mac OS X plist files.
                                                             (line    6)
* plock() (in module os):                Process Management. (line  308)
* plus:                                  Unary arithmetic and bitwise operations.
                                                             (line   13)
* PLUS (in module token):                token — Constants used with Python parse trees.
                                                             (line   82)
* plus() (decimal.Context method):       Context objects.    (line  412)
* PLUSEQUAL (in module token):           token — Constants used with Python parse trees.
                                                             (line  170)
* pm() (in module pdb):                  pdb — The Python Debugger.
                                                             (line  114)
* POINTER() (in module ctypes):          Utility functions.  (line  149)
* pointer() (in module ctypes):          Utility functions.  (line  155)
* polar() (in module cmath):             Conversions to and from polar coordinates.
                                                             (line   42)
* Policy (class in email.policy):        email policy Policy Objects.
                                                             (line  106)
* poll() (in module select):             select — Waiting for I/O completion.
                                                             (line   84)
* poll() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   42)
* poll() (select.devpoll method):        /dev/poll Polling Objects.
                                                             (line   65)
* poll() (select.epoll method):          Edge and Level Trigger Polling epoll Objects.
                                                             (line   93)
* poll() (select.poll method):           Polling Objects.    (line   77)
* poll() (subprocess.Popen method):      Popen Objects.      (line    8)
* PollSelector (class in selectors):     Classes<3>.         (line  166)
* Pool (class in multiprocessing.pool):  Process Pools.      (line    9)
* pop() (array.array method):            array — Efficient arrays of numeric values.
                                                             (line  204)
* pop() (collections.deque method):      deque objects.      (line   87)
* pop() (dict method):                   Mapping Types — dict.
                                                             (line  166)
* pop() (frozenset method):              Set Types — set frozenset.
                                                             (line  197)
* pop() (mailbox.Mailbox method):        Mailbox objects.    (line  208)
* pop() (sequence method):               Mutable Sequence Types.
                                                             (line   16)
* POP3 (class in poplib):                poplib — POP3 protocol client.
                                                             (line   29)
* POP3; protocol:                        poplib — POP3 protocol client.
                                                             (line    8)
* POP3_SSL (class in poplib):            poplib — POP3 protocol client.
                                                             (line   45)
* Popen (class in subprocess):           Popen Constructor.  (line   11)
* popen() (in module os):                The standard type hierarchy.
                                                             (line  600)
* popen() (in module os) <1>:            Process Management. (line  315)
* popen() (in module os) <2>:            select — Waiting for I/O completion.
                                                             (line  138)
* popitem() (collections.OrderedDict method): OrderedDict objects.
                                                             (line   46)
* popitem() (dict method):               Mapping Types — dict.
                                                             (line  172)
* popitem() (mailbox.Mailbox method):    Mailbox objects.    (line  217)
* popleft() (collections.deque method):  deque objects.      (line   92)
* poplib (module):                       poplib — POP3 protocol client.
                                                             (line    6)
* PopupMenu (class in tkinter.tix):      Basic Widgets.      (line   53)
* pop_alignment() (formatter.formatter method): The Formatter Interface.
                                                             (line   97)
* pop_all() (contextlib.ExitStack method): Utilities.        (line  311)
* POP_BLOCK (opcode):                    Python Bytecode Instructions.
                                                             (line  372)
* POP_EXCEPT (opcode):                   Python Bytecode Instructions.
                                                             (line  377)
* POP_FINALLY (opcode):                  Python Bytecode Instructions.
                                                             (line  385)
* pop_font() (formatter.formatter method): The Formatter Interface.
                                                             (line  109)
* POP_JUMP_IF_FALSE (opcode):            Python Bytecode Instructions.
                                                             (line  660)
* POP_JUMP_IF_TRUE (opcode):             Python Bytecode Instructions.
                                                             (line  653)
* pop_margin() (formatter.formatter method): The Formatter Interface.
                                                             (line  121)
* pop_source() (shlex.shlex method):     shlex Objects.      (line   63)
* pop_style() (formatter.formatter method): The Formatter Interface.
                                                             (line  132)
* POP_TOP (opcode):                      Python Bytecode Instructions.
                                                             (line   59)
* port (http.cookiejar.Cookie attribute): Cookie Objects<2>. (line   36)
* portion:                               Glossary.           (line 1008)
* port_specified (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   77)
* pos (json.JSONDecodeError attribute):  Exceptions<13>.     (line   19)
* pos (re.error attribute):              Module Contents.    (line  370)
* pos (re.Match attribute):              Match Objects.      (line  164)
* pos() (in module operator):            operator — Standard operators as functions.
                                                             (line  138)
* pos() (in module turtle):              Tell Turtle’s state.
                                                             (line    6)
* position (xml.etree.ElementTree.ParseError attribute): Exceptions<15>.
                                                             (line   20)
* position() (in module turtle):         Tell Turtle’s state.
                                                             (line    6)
* positional argument:                   Glossary.           (line 1014)
* posix (module):                        posix — The most common POSIX system calls.
                                                             (line    6)
* POSIX Shared Memory:                   multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   10)
* POSIX; I/O control:                    termios — POSIX style tty control.
                                                             (line    6)
* POSIXLY_CORRECT:                       getopt — C-style parser for command line options.
                                                             (line   71)
* PosixPath (class in pathlib):          Concrete paths.     (line   22)
* posix_fadvise() (in module os):        File Descriptor Operations.
                                                             (line  387)
* POSIX_FADV_DONTNEED (in module os):    File Descriptor Operations.
                                                             (line  401)
* POSIX_FADV_NOREUSE (in module os):     File Descriptor Operations.
                                                             (line  401)
* POSIX_FADV_NORMAL (in module os):      File Descriptor Operations.
                                                             (line  401)
* POSIX_FADV_RANDOM (in module os):      File Descriptor Operations.
                                                             (line  401)
* POSIX_FADV_SEQUENTIAL (in module os):  File Descriptor Operations.
                                                             (line  401)
* POSIX_FADV_WILLNEED (in module os):    File Descriptor Operations.
                                                             (line  401)
* posix_fallocate() (in module os):      File Descriptor Operations.
                                                             (line  378)
* posix_spawn() (in module os):          Process Management. (line  338)
* posix_spawnp() (in module os):         Process Management. (line  425)
* POSIX_SPAWN_CLOSE (in module os):      Process Management. (line  366)
* POSIX_SPAWN_DUP2 (in module os):       Process Management. (line  372)
* POSIX_SPAWN_OPEN (in module os):       Process Management. (line  360)
* post() (nntplib.NNTP method):          Methods<3>.         (line  242)
* post() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  179)
* postcmd() (cmd.Cmd method):            Cmd Objects.        (line   96)
* postloop() (cmd.Cmd method):           Cmd Objects.        (line  114)
* post_handshake_auth (ssl.SSLContext attribute): SSL Contexts.
                                                             (line  550)
* post_mortem() (in module pdb):         pdb — The Python Debugger.
                                                             (line  107)
* post_setup() (venv.EnvBuilder method): API<2>.             (line   94)
* pow() (built-in function):             Built-in Functions. (line 1266)
* pow() (in module math):                Power and logarithmic functions.
                                                             (line   60)
* pow() (in module operator):            operator — Standard operators as functions.
                                                             (line  143)
* power() (decimal.Context method):      Context objects.    (line  418)
* power; operation:                      The power operator. (line    6)
* pp (pdb command):                      Debugger Commands.  (line  239)
* pp() (in module pprint):               pprint — Data pretty printer.
                                                             (line   93)
* pprint (module):                       pprint — Data pretty printer.
                                                             (line    6)
* pprint() (in module pprint):           pprint — Data pretty printer.
                                                             (line  103)
* pprint() (pprint.PrettyPrinter method): PrettyPrinter Objects.
                                                             (line   14)
* prcal() (in module calendar):          calendar — General calendar-related functions.
                                                             (line  344)
* pread() (in module os):                File Descriptor Operations.
                                                             (line  415)
* preadv() (in module os):               File Descriptor Operations.
                                                             (line  428)
* preamble (email.message.EmailMessage attribute): email message Representing an email message.
                                                             (line  651)
* preamble (email.message.Message attribute): email message Message Representing an email message using the compat32 API.
                                                             (line  651)
* precmd() (cmd.Cmd method):             Cmd Objects.        (line   86)
* prefix:                                Python-related paths and files.
                                                             (line    7)
* prefix <1>:                            Include Files.      (line   36)
* prefix <2>:                            Include Files.      (line   39)
* prefix <3>:                            Include Files.      (line   46)
* PREFIX (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   19)
* prefix (in module sys):                sys — System-specific parameters and functions.
                                                             (line 1119)
* prefix (xml.dom.Attr attribute):       Attr Objects.       (line   18)
* prefix (xml.dom.Node attribute):       Node Objects.       (line   69)
* prefix (zipimport.zipimporter attribute): zipimporter Objects.
                                                             (line   74)
* PREFIXES (in module site):             Module contents<3>. (line    6)
* prefixlen (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  132)
* prefixlen (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  287)
* preloop() (cmd.Cmd method):            Cmd Objects.        (line  108)
* prepare() (logging.handlers.QueueHandler method): QueueHandler.
                                                             (line   40)
* prepare() (logging.handlers.QueueListener method): QueueListener.
                                                             (line   54)
* prepare_class() (in module types):     Dynamic Type Creation.
                                                             (line   23)
* prepare_input_source() (in module xml.sax.saxutils): xml sax saxutils — SAX Utilities.
                                                             (line   76)
* prepend() (pipes.Template method):     Template Objects.   (line   37)
* preprocess() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  433)
* PrettyPrinter (class in pprint):       pprint — Data pretty printer.
                                                             (line   27)
* prev() (tkinter.ttk.Treeview method):  ttk Treeview.       (line  242)
* previousSibling (xml.dom.Node attribute): Node Objects.    (line   32)
* primary:                               Primaries.          (line    6)
* print (2to3 fixer):                    Fixers.             (line  256)
* print() (built-in function):           Built-in Functions. (line 1301)
* print() (built-in function); __str__() (object method): Basic customization.
                                                             (line  129)
* printable (in module string):          String constants.   (line   41)
* printdir() (zipfile.ZipFile method):   ZipFile Objects.    (line  207)
* printf-style formatting:               printf-style String Formatting.
                                                             (line    6)
* printf-style formatting <1>:           printf-style Bytes Formatting.
                                                             (line    6)
* print_callees() (pstats.Stats method): The Stats Class.    (line  217)
* print_callers() (pstats.Stats method): The Stats Class.    (line  196)
* print_directory() (in module cgi):     Functions<8>.       (line   56)
* print_environ() (in module cgi):       Functions<8>.       (line   48)
* print_environ_usage() (in module cgi): Functions<8>.       (line   60)
* print_exc() (in module traceback):     traceback — Print or retrieve a stack traceback.
                                                             (line   60)
* print_exc() (timeit.Timer method):     Python Interface.   (line  133)
* print_exception() (in module traceback): traceback — Print or retrieve a stack traceback.
                                                             (line   33)
* PRINT_EXPR (opcode):                   Python Bytecode Instructions.
                                                             (line  311)
* print_form() (in module cgi):          Functions<8>.       (line   52)
* print_help() (argparse.ArgumentParser method): Printing help.
                                                             (line   16)
* print_last() (in module traceback):    traceback — Print or retrieve a stack traceback.
                                                             (line   65)
* print_stack() (asyncio.Task method):   Task Object.        (line  158)
* print_stack() (in module traceback):   traceback — Print or retrieve a stack traceback.
                                                             (line   72)
* print_stats() (profile.Profile method): profile and cProfile Module Reference.
                                                             (line   76)
* print_stats() (pstats.Stats method):   The Stats Class.    (line  164)
* print_tb() (in module traceback):      traceback — Print or retrieve a stack traceback.
                                                             (line   22)
* print_usage() (argparse.ArgumentParser method): Printing help.
                                                             (line   10)
* print_usage() (optparse.OptionParser method): Other methods.
                                                             (line   15)
* print_version() (optparse.OptionParser method): Printing a version string.
                                                             (line   25)
* PriorityQueue (class in asyncio):      Priority Queue.     (line    6)
* PriorityQueue (class in queue):        queue — A synchronized queue class.
                                                             (line   50)
* PRIO_PGRP (in module os):              Process Parameters. (line  271)
* PRIO_PROCESS (in module os):           Process Parameters. (line  271)
* PRIO_USER (in module os):              Process Parameters. (line  271)
* private; names:                        Identifiers Names.  (line   14)
* prlimit() (in module resource):        Resource Limits.    (line   53)
* prmonth() (calendar.TextCalendar method): calendar — General calendar-related functions.
                                                             (line  143)
* prmonth() (in module calendar):        calendar — General calendar-related functions.
                                                             (line  335)
* ProactorEventLoop (class in asyncio):  Event Loop Implementations.
                                                             (line   24)
* procedure; call:                       Expression statements.
                                                             (line   17)
* Process (class in multiprocessing):    Process and exceptions.
                                                             (line    6)
* process() (logging.LoggerAdapter method): LoggerAdapter Objects.
                                                             (line   16)
* process; group:                        Process Parameters. (line  179)
* process; group <1>:                    Process Parameters. (line  237)
* process; id:                           Process Parameters. (line  243)
* process; id of parent:                 Process Parameters. (line  247)
* process; killing:                      Process Management. (line  278)
* process; killing <1>:                  Process Management. (line  297)
* process; scheduling priority:          Process Parameters. (line  258)
* process; scheduling priority <1>:      Process Parameters. (line  386)
* process; signalling:                   Process Management. (line  278)
* process; signalling <1>:               Process Management. (line  297)
* ProcessError:                          Process and exceptions.
                                                             (line  193)
* processes, light-weight:               _thread — Low-level threading API.
                                                             (line    6)
* ProcessingInstruction() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  160)
* processingInstruction() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line  164)
* ProcessingInstructionHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  236)
* ProcessLookupError:                    OS exceptions.      (line   98)
* processor time:                        Functions<2>.       (line  202)
* processor time <1>:                    Functions<2>.       (line  481)
* processor() (in module platform):      Cross Platform.     (line   67)
* ProcessPoolExecutor (class in concurrent.futures): ProcessPoolExecutor.
                                                             (line   21)
* process_exited() (asyncio.SubprocessProtocol method): Subprocess Protocols.
                                                             (line   26)
* process_message() (smtpd.SMTPServer method): SMTPServer Objects.
                                                             (line   41)
* process_request() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  154)
* process_time() (in module time):       Functions<2>.       (line  200)
* process_time_ns() (in module time):    Functions<2>.       (line  210)
* process_tokens() (in module tabnanny): tabnanny — Detection of ambiguous indentation.
                                                             (line   42)
* prod() (in module math):               Number-theoretic and representation functions.
                                                             (line  194)
* product() (in module itertools):       Itertool functions. (line  458)
* Profile (class in profile):            profile and cProfile Module Reference.
                                                             (line   35)
* profile (module):                      profile and cProfile Module Reference.
                                                             (line    6)
* profile function:                      threading — Thread-based parallelism.
                                                             (line  122)
* profile function <1>:                  sys — System-specific parameters and functions.
                                                             (line  702)
* profile function <2>:                  sys — System-specific parameters and functions.
                                                             (line 1178)
* profiler:                              sys — System-specific parameters and functions.
                                                             (line  702)
* profiler <1>:                          sys — System-specific parameters and functions.
                                                             (line 1178)
* profiling, deterministic:              Introduction to the profilers.
                                                             (line    6)
* program:                               Complete Python programs.
                                                             (line    6)
* ProgrammingError:                      Exceptions<4>.      (line   25)
* Progressbar (class in tkinter.ttk):    ttk Progressbar.    (line    6)
* prompt (cmd.Cmd attribute):            Cmd Objects.        (line  123)
* prompts, interpreter:                  sys — System-specific parameters and functions.
                                                             (line 1139)
* prompt_user_passwd() (urllib.request.FancyURLopener method): Legacy interface.
                                                             (line  181)
* propagate (logging.Logger attribute):  Logger Objects.     (line   25)
* property (built-in class):             Built-in Functions. (line 1326)
* property list:                         plistlib — Generate and parse Mac OS X plist files.
                                                             (line    8)
* PropertyMock (class in unittest.mock): The Mock Class.     (line  430)
* property_declaration_handler (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line  101)
* property_dom_node (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line  108)
* property_lexical_handler (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line   94)
* property_xml_string (in module xml.sax.handler): xml sax handler — Base classes for SAX handlers.
                                                             (line  115)
* proto (socket.socket attribute):       Socket Objects.     (line  581)
* Protocol (class in asyncio):           Base Protocols.     (line   10)
* Protocol (class in typing):            Classes functions and decorators.
                                                             (line   54)
* protocol (ssl.SSLContext attribute):   SSL Contexts.       (line  573)
* protocol; context management:          Context Manager Types.
                                                             (line    6)
* protocol; iterator:                    Iterator Types.     (line    6)
* protocol; Telnet:                      telnetlib — Telnet client.
                                                             (line    8)
* ProtocolError (class in xmlrpc.client): ProtocolError Objects.
                                                             (line    6)
* PROTOCOL_SSLv2 (in module ssl):        Constants<9>.       (line  150)
* PROTOCOL_SSLv23 (in module ssl):       Constants<9>.       (line  143)
* PROTOCOL_SSLv3 (in module ssl):        Constants<9>.       (line  163)
* PROTOCOL_TLS (in module ssl):          Constants<9>.       (line  118)
* PROTOCOL_TLSv1 (in module ssl):        Constants<9>.       (line  177)
* PROTOCOL_TLSv1_1 (in module ssl):      Constants<9>.       (line  185)
* PROTOCOL_TLSv1_2 (in module ssl):      Constants<9>.       (line  196)
* PROTOCOL_TLS_CLIENT (in module ssl):   Constants<9>.       (line  126)
* PROTOCOL_TLS_SERVER (in module ssl):   Constants<9>.       (line  135)
* protocol_version (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  151)
* PROTOCOL_VERSION (imaplib.IMAP4 attribute): IMAP4 Objects. (line  369)
* prot_c() (ftplib.FTP_TLS method):      FTP_TLS Objects.    (line   35)
* prot_p() (ftplib.FTP_TLS method):      FTP_TLS Objects.    (line   31)
* provisional API:                       Glossary.           (line 1018)
* provisional package:                   Glossary.           (line 1038)
* proxy() (in module weakref):           weakref — Weak references.
                                                             (line  131)
* proxyauth() (imaplib.IMAP4 method):    IMAP4 Objects.      (line  187)
* ProxyBasicAuthHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  364)
* ProxyDigestAuthHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  396)
* ProxyHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  290)
* ProxyType (in module weakref):         weakref — Weak references.
                                                             (line  308)
* ProxyTypes (in module weakref):        weakref — Weak references.
                                                             (line  316)
* pryear() (calendar.TextCalendar method): calendar — General calendar-related functions.
                                                             (line  158)
* ps1 (in module sys):                   sys — System-specific parameters and functions.
                                                             (line 1136)
* ps2 (in module sys):                   sys — System-specific parameters and functions.
                                                             (line 1136)
* pstats (module):                       The Stats Class.    (line    7)
* pstdev() (in module statistics):       Function details.   (line  271)
* pthreads:                              _thread — Low-level threading API.
                                                             (line   16)
* pthread_getcpuclockid() (in module time): Functions<2>.    (line   21)
* pthread_kill() (in module signal):     Module contents<2>. (line  173)
* pthread_sigmask() (in module signal):  Module contents<2>. (line  199)
* pty (module):                          pty — Pseudo-terminal utilities.
                                                             (line    6)
* pu() (in module turtle):               Drawing state.      (line   12)
* publicId (xml.dom.DocumentType attribute): DocumentType Objects.
                                                             (line   17)
* PullDom (class in xml.dom.pulldom):    xml dom pulldom — Support for building partial DOM trees.
                                                             (line   65)
* punctuation (in module string):        String constants.   (line   36)
* punctuation_chars (shlex.shlex attribute): shlex Objects.  (line  183)
* PurePath (class in pathlib):           Pure paths.         (line   10)
* PurePath.anchor (in module pathlib):   Methods and properties.
                                                             (line   40)
* PurePath.drive (in module pathlib):    Methods and properties.
                                                             (line    8)
* PurePath.name (in module pathlib):     Methods and properties.
                                                             (line   94)
* PurePath.parent (in module pathlib):   Methods and properties.
                                                             (line   66)
* PurePath.parents (in module pathlib):  Methods and properties.
                                                             (line   53)
* PurePath.parts (in module pathlib):    Accessing individual parts.
                                                             (line    9)
* PurePath.root (in module pathlib):     Methods and properties.
                                                             (line   24)
* PurePath.stem (in module pathlib):     Methods and properties.
                                                             (line  131)
* PurePath.suffix (in module pathlib):   Methods and properties.
                                                             (line  109)
* PurePath.suffixes (in module pathlib): Methods and properties.
                                                             (line  120)
* PurePosixPath (class in pathlib):      Pure paths.         (line   68)
* PureProxy (class in smtpd):            PureProxy Objects.  (line    6)
* PureWindowsPath (class in pathlib):    Pure paths.         (line   78)
* purge() (in module re):                Module Contents.    (line  349)
* Purpose.CLIENT_AUTH (in module ssl):   Constants<9>.       (line  497)
* Purpose.SERVER_AUTH (in module ssl):   Constants<9>.       (line  488)
* push() (asynchat.async_chat method):   asynchat — Asynchronous socket command/response handler.
                                                             (line  101)
* push() (code.InteractiveConsole method): Interactive Console Objects.
                                                             (line   28)
* push() (contextlib.ExitStack method):  Utilities.          (line  278)
* pushbutton() (msilib.Dialog method):   GUI classes.        (line   68)
* push_alignment() (formatter.formatter method): The Formatter Interface.
                                                             (line   90)
* push_async_callback() (contextlib.AsyncExitStack method): Utilities.
                                                             (line  351)
* push_async_exit() (contextlib.AsyncExitStack method): Utilities.
                                                             (line  346)
* push_font() (formatter.formatter method): The Formatter Interface.
                                                             (line  101)
* push_margin() (formatter.formatter method): The Formatter Interface.
                                                             (line  113)
* push_source() (shlex.shlex method):    shlex Objects.      (line   56)
* push_style() (formatter.formatter method): The Formatter Interface.
                                                             (line  125)
* push_token() (shlex.shlex method):     shlex Objects.      (line   16)
* push_with_producer() (asynchat.async_chat method): asynchat — Asynchronous socket command/response handler.
                                                             (line  109)
* put() (asyncio.Queue method):          Queue.              (line   62)
* put() (multiprocessing.Queue method):  Pipes and Queues.   (line  120)
* put() (multiprocessing.SimpleQueue method): Pipes and Queues.
                                                             (line  217)
* put() (queue.Queue method):            Queue Objects.      (line   29)
* put() (queue.SimpleQueue method):      SimpleQueue Objects.
                                                             (line   20)
* putch() (in module msvcrt):            Console I/O.        (line   35)
* putenv() (in module os):               Process Parameters. (line  316)
* putheader() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line  133)
* putp() (in module curses):             Functions<3>.       (line  373)
* putrequest() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line  122)
* putwch() (in module msvcrt):           Console I/O.        (line   39)
* putwin() (curses.window method):       Window Objects.     (line  453)
* put_nowait() (asyncio.Queue method):   Queue.              (line   67)
* put_nowait() (multiprocessing.Queue method): Pipes and Queues.
                                                             (line  136)
* put_nowait() (queue.Queue method):     Queue Objects.      (line   40)
* put_nowait() (queue.SimpleQueue method): SimpleQueue Objects.
                                                             (line   35)
* pvariance() (in module statistics):    Function details.   (line  280)
* pwd (module):                          pwd — The password database.
                                                             (line    6)
* pwd() (ftplib.FTP method):             FTP Objects.        (line  221)
* pwrite() (in module os):               File Descriptor Operations.
                                                             (line  486)
* pwritev() (in module os):              File Descriptor Operations.
                                                             (line  497)
* PyAnySet_Check (C function):           Set Objects.        (line   55)
* PyAnySet_CheckExact (C function):      Set Objects.        (line   60)
* PyArg_Parse (C function):              API Functions.      (line   51)
* PyArg_ParseTuple (C function):         API Functions.      (line    6)
* PyArg_ParseTuple():                    Extracting Parameters in Extension Functions.
                                                             (line    6)
* PyArg_ParseTupleAndKeywords (C function): API Functions.   (line   20)
* PyArg_ParseTupleAndKeywords():         Keyword Parameters for Extension Functions.
                                                             (line    6)
* PyArg_UnpackTuple (C function):        API Functions.      (line   63)
* PyArg_ValidateKeywordArguments (C function): API Functions.
                                                             (line   42)
* PyArg_VaParse (C function):            API Functions.      (line   13)
* PyArg_VaParseTupleAndKeywords (C function): API Functions. (line   34)
* PyASCIIObject (C type):                Unicode Type.       (line   29)
* PyAsyncMethods (C type):               Async Object Structures.
                                                             (line    8)
* PyAsyncMethods.am_aiter (C member):    Async Object Structures.
                                                             (line   30)
* PyAsyncMethods.am_anext (C member):    Async Object Structures.
                                                             (line   42)
* PyAsyncMethods.am_await (C member):    Async Object Structures.
                                                             (line   18)
* PyBool_Check (C function):             Boolean Objects.    (line   11)
* PyBool_FromLong (C function):          Boolean Objects.    (line   37)
* PyBufferProcs:                         Buffer Protocol.    (line   20)
* PyBufferProcs (C type):                Buffer Object Structures.
                                                             (line    6)
* PyBufferProcs.bf_getbuffer (C member): Buffer Object Structures.
                                                             (line   12)
* PyBufferProcs.bf_releasebuffer (C member): Buffer Object Structures.
                                                             (line   60)
* PyBuffer_FillContiguousStrides (C function): Buffer-related functions.
                                                             (line   77)
* PyBuffer_FillInfo (C function):        Buffer-related functions.
                                                             (line   87)
* PyBuffer_FromContiguous (C function):  Buffer-related functions.
                                                             (line   59)
* PyBuffer_GetPointer (C function):      Buffer-related functions.
                                                             (line   53)
* PyBuffer_IsContiguous (C function):    Buffer-related functions.
                                                             (line   46)
* PyBuffer_Release (C function):         Buffer-related functions.
                                                             (line   32)
* PyBuffer_SizeFromFormat (C function):  Buffer-related functions.
                                                             (line   41)
* PyBuffer_ToContiguous (C function):    Buffer-related functions.
                                                             (line   66)
* PyBUF_ANY_CONTIGUOUS (C macro):        contiguity requests.
                                                             (line   20)
* PyBUF_CONTIG (C macro):                compound requests.  (line   36)
* PyBUF_CONTIG_RO (C macro):             compound requests.  (line   39)
* PyBUF_C_CONTIGUOUS (C macro):          contiguity requests.
                                                             (line   14)
* PyBUF_FORMAT (C macro):                readonly format.    (line   14)
* PyBUF_FULL (C macro):                  compound requests.  (line   18)
* PyBUF_FULL_RO (C macro):               compound requests.  (line   21)
* PyBUF_F_CONTIGUOUS (C macro):          contiguity requests.
                                                             (line   17)
* PyBUF_INDIRECT (C macro):              shape strides suboffsets.
                                                             (line   14)
* PyBUF_ND (C macro):                    shape strides suboffsets.
                                                             (line   20)
* PyBUF_ND (C macro) <1>:                contiguity requests.
                                                             (line   23)
* PyBUF_RECORDS (C macro):               compound requests.  (line   24)
* PyBUF_RECORDS_RO (C macro):            compound requests.  (line   27)
* PyBUF_SIMPLE (C macro):                shape strides suboffsets.
                                                             (line   23)
* PyBUF_STRIDED (C macro):               compound requests.  (line   30)
* PyBUF_STRIDED_RO (C macro):            compound requests.  (line   33)
* PyBUF_STRIDES (C macro):               shape strides suboffsets.
                                                             (line   17)
* PyBUF_WRITABLE (C macro):              readonly format.    (line    6)
* PyByteArrayObject (C type):            Byte Array Objects. (line    6)
* PyByteArray_AsString (C function):     Direct API functions.
                                                             (line   23)
* PyByteArray_AS_STRING (C function):    Macros.             (line    8)
* PyByteArray_Check (C function):        Type check macros.  (line    6)
* PyByteArray_CheckExact (C function):   Type check macros.  (line   11)
* PyByteArray_Concat (C function):       Direct API functions.
                                                             (line   15)
* PyByteArray_FromObject (C function):   Direct API functions.
                                                             (line    6)
* PyByteArray_FromStringAndSize (C function): Direct API functions.
                                                             (line   10)
* PyByteArray_GET_SIZE (C function):     Macros.             (line   12)
* PyByteArray_Resize (C function):       Direct API functions.
                                                             (line   29)
* PyByteArray_Size (C function):         Direct API functions.
                                                             (line   19)
* PyByteArray_Type (C variable):         Byte Array Objects. (line   11)
* PyBytesObject (C type):                Bytes Objects<2>.   (line    9)
* PyBytes_AsString (C function):         Bytes Objects<2>.   (line  126)
* PyBytes_AsStringAndSize (C function):  Bytes Objects<2>.   (line  143)
* PyBytes_AS_STRING (C function):        Bytes Objects<2>.   (line  138)
* PyBytes_Check (C function):            Bytes Objects<2>.   (line   20)
* PyBytes_CheckExact (C function):       Bytes Objects<2>.   (line   25)
* PyBytes_Concat (C function):           Bytes Objects<2>.   (line  165)
* PyBytes_ConcatAndDel (C function):     Bytes Objects<2>.   (line  175)
* PyBytes_FromFormat (C function):       Bytes Objects<2>.   (line   43)
* PyBytes_FromFormatV (C function):      Bytes Objects<2>.   (line  106)
* PyBytes_FromObject (C function):       Bytes Objects<2>.   (line  113)
* PyBytes_FromString (C function):       Bytes Objects<2>.   (line   30)
* PyBytes_FromStringAndSize (C function): Bytes Objects<2>.  (line   35)
* PyBytes_GET_SIZE (C function):         Bytes Objects<2>.   (line  121)
* PyBytes_Size (C function):             Bytes Objects<2>.   (line  117)
* PyBytes_Type (C variable):             Bytes Objects<2>.   (line   14)
* pycache_prefix (in module sys):        sys — System-specific parameters and functions.
                                                             (line  258)
* PyCallable_Check (C function):         Object Protocol.    (line  248)
* PyCallIter_Check (C function):         Iterator Objects.   (line   34)
* PyCallIter_New (C function):           Iterator Objects.   (line   38)
* PyCallIter_Type (C variable):          Iterator Objects.   (line   28)
* PyCapsule (C type):                    Capsules<2>.        (line   11)
* PyCapsule_CheckExact (C function):     Capsules<2>.        (line   29)
* PyCapsule_Destructor (C type):         Capsules<2>.        (line   20)
* PyCapsule_GetContext (C function):     Capsules<2>.        (line   76)
* PyCapsule_GetDestructor (C function):  Capsules<2>.        (line   65)
* PyCapsule_GetName (C function):        Capsules<2>.        (line   86)
* PyCapsule_GetPointer (C function):     Capsules<2>.        (line   53)
* PyCapsule_Import (C function):         Capsules<2>.        (line   96)
* PyCapsule_IsValid (C function):        Capsules<2>.        (line  110)
* PyCapsule_New (C function):            Capsules<2>.        (line   33)
* PyCapsule_SetContext (C function):     Capsules<2>.        (line  126)
* PyCapsule_SetDestructor (C function):  Capsules<2>.        (line  134)
* PyCapsule_SetName (C function):        Capsules<2>.        (line  143)
* PyCapsule_SetPointer (C function):     Capsules<2>.        (line  153)
* PyCellObject (C type):                 Cell Objects.       (line   16)
* PyCell_Check (C function):             Cell Objects.       (line   24)
* PyCell_Get (C function):               Cell Objects.       (line   32)
* PyCell_GET (C function):               Cell Objects.       (line   36)
* PyCell_New (C function):               Cell Objects.       (line   28)
* PyCell_Set (C function):               Cell Objects.       (line   41)
* PyCell_SET (C function):               Cell Objects.       (line   48)
* PyCell_Type (C variable):              Cell Objects.       (line   20)
* PyCFunction (C type):                  Common Object Structures.
                                                             (line   93)
* PyCFunctionWithKeywords (C type):      Common Object Structures.
                                                             (line  102)
* PycInvalidationMode (class in py_compile): py_compile — Compile Python source files.
                                                             (line   91)
* pyclbr (module):                       pyclbr — Python class browser support.
                                                             (line    6)
* PyCodec_BackslashReplaceErrors (C function): Registry API for Unicode encoding error handlers.
                                                             (line   50)
* PyCodec_Decode (C function):           Codec registry and support functions.
                                                             (line   29)
* PyCodec_Decoder (C function):          Codec lookup API.   (line   15)
* PyCodec_Encode (C function):           Codec registry and support functions.
                                                             (line   19)
* PyCodec_Encoder (C function):          Codec lookup API.   (line   11)
* PyCodec_IgnoreErrors (C function):     Registry API for Unicode encoding error handlers.
                                                             (line   37)
* PyCodec_IncrementalDecoder (C function): Codec lookup API. (line   24)
* PyCodec_IncrementalEncoder (C function): Codec lookup API. (line   19)
* PyCodec_KnownEncoding (C function):    Codec registry and support functions.
                                                             (line   14)
* PyCodec_LookupError (C function):      Registry API for Unicode encoding error handlers.
                                                             (line   28)
* PyCodec_NameReplaceErrors (C function): Registry API for Unicode encoding error handlers.
                                                             (line   54)
* PyCodec_Register (C function):         Codec registry and support functions.
                                                             (line    6)
* PyCodec_RegisterError (C function):    Registry API for Unicode encoding error handlers.
                                                             (line    6)
* PyCodec_ReplaceErrors (C function):    Registry API for Unicode encoding error handlers.
                                                             (line   41)
* PyCodec_StreamReader (C function):     Codec lookup API.   (line   29)
* PyCodec_StreamWriter (C function):     Codec lookup API.   (line   35)
* PyCodec_StrictErrors (C function):     Registry API for Unicode encoding error handlers.
                                                             (line   34)
* PyCodec_XMLCharRefReplaceErrors (C function): Registry API for Unicode encoding error handlers.
                                                             (line   45)
* PyCodeObject (C type):                 Code Objects<2>.    (line   10)
* PyCode_Check (C function):             Code Objects<2>.    (line   20)
* PyCode_GetNumFree (C function):        Code Objects<2>.    (line   24)
* PyCode_New (C function):               Code Objects<2>.    (line   28)
* PyCode_NewEmpty (C function):          Code Objects<2>.    (line   56)
* PyCode_NewWithPosOnlyArgs (C function): Code Objects<2>.   (line   42)
* PyCode_Type (C variable):              Code Objects<2>.    (line   15)
* PyCompactUnicodeObject (C type):       Unicode Type.       (line   29)
* PyCompileError:                        py_compile — Compile Python source files.
                                                             (line   19)
* PyCompilerFlags (C type):              The Very High Level Layer.
                                                             (line  395)
* PyCompilerFlags.cf_feature_version (C member): The Very High Level Layer.
                                                             (line  411)
* PyCompilerFlags.cf_flags (C member):   The Very High Level Layer.
                                                             (line  407)
* PyComplexObject (C type):              Complex Numbers as Python Objects.
                                                             (line    6)
* PyComplex_AsCComplex (C function):     Complex Numbers as Python Objects.
                                                             (line   44)
* PyComplex_Check (C function):          Complex Numbers as Python Objects.
                                                             (line   17)
* PyComplex_CheckExact (C function):     Complex Numbers as Python Objects.
                                                             (line   22)
* PyComplex_FromCComplex (C function):   Complex Numbers as Python Objects.
                                                             (line   27)
* PyComplex_FromDoubles (C function):    Complex Numbers as Python Objects.
                                                             (line   31)
* PyComplex_ImagAsDouble (C function):   Complex Numbers as Python Objects.
                                                             (line   40)
* PyComplex_RealAsDouble (C function):   Complex Numbers as Python Objects.
                                                             (line   36)
* PyComplex_Type (C variable):           Complex Numbers as Python Objects.
                                                             (line   11)
* PyConfig (C type):                     PyConfig.           (line    6)
* PyConfig.argv (C member):              PyConfig.           (line   99)
* PyConfig.base_executable (C member):   PyConfig.           (line  111)
* PyConfig.base_exec_prefix (C member):  PyConfig.           (line  107)
* PyConfig.base_prefix (C member):       PyConfig.           (line  116)
* PyConfig.buffered_stdio (C member):    PyConfig.           (line  120)
* PyConfig.bytes_warning (C member):     PyConfig.           (line  127)
* PyConfig.check_hash_pycs_mode (C member): PyConfig.        (line  134)
* PyConfig.configure_c_stdio (C member): PyConfig.           (line  144)
* PyConfig.dev_mode (C member):          PyConfig.           (line  150)
* PyConfig.dump_refs (C member):         PyConfig.           (line  154)
* PyConfig.executable (C member):        PyConfig.           (line  165)
* PyConfig.exec_prefix (C member):       PyConfig.           (line  161)
* PyConfig.faulthandler (C member):      PyConfig.           (line  169)
* PyConfig.filesystem_encoding (C member): PyConfig.         (line  174)
* PyConfig.filesystem_errors (C member): PyConfig.           (line  178)
* PyConfig.hash_seed (C member):         PyConfig.           (line  183)
* PyConfig.home (C member):              PyConfig.           (line  193)
* PyConfig.import_time (C member):       PyConfig.           (line  200)
* PyConfig.inspect (C member):           PyConfig.           (line  204)
* PyConfig.install_signal_handlers (C member): PyConfig.     (line  208)
* PyConfig.interactive (C member):       PyConfig.           (line  212)
* PyConfig.isolated (C member):          PyConfig.           (line  216)
* PyConfig.legacy_windows_stdio (C member): PyConfig.        (line  230)
* PyConfig.malloc_stats (C member):      PyConfig.           (line  239)
* PyConfig.module_search_paths (C member): PyConfig.         (line  255)
* PyConfig.module_search_paths_set (C member): PyConfig.     (line  257)
* PyConfig.optimization_level (C member): PyConfig.          (line  264)
* PyConfig.parser_debug (C member):      PyConfig.           (line  280)
* PyConfig.parse_argv (C member):        PyConfig.           (line  274)
* PyConfig.pathconfig_warnings (C member): PyConfig.         (line  285)
* PyConfig.prefix (C member):            PyConfig.           (line  291)
* PyConfig.program_name (C member):      PyConfig.           (line  295)
* PyConfig.pycache_prefix (C member):    PyConfig.           (line  300)
* PyConfig.pythonpath_env (C member):    PyConfig.           (line  247)
* PyConfig.quiet (C member):             PyConfig.           (line  306)
* PyConfig.run_command (C member):       PyConfig.           (line  311)
* PyConfig.run_filename (C member):      PyConfig.           (line  316)
* PyConfig.run_module (C member):        PyConfig.           (line  320)
* PyConfig.show_alloc_count (C member):  PyConfig.           (line  325)
* PyConfig.show_ref_count (C member):    PyConfig.           (line  333)
* PyConfig.site_import (C member):       PyConfig.           (line  342)
* PyConfig.skip_source_first_line (C member): PyConfig.      (line  346)
* PyConfig.stdio_encoding (C member):    PyConfig.           (line  350)
* PyConfig.stdio_errors (C member):      PyConfig.           (line  352)
* PyConfig.tracemalloc (C member):       PyConfig.           (line  357)
* PyConfig.user_site_directory (C member): PyConfig.         (line  365)
* PyConfig.use_environment (C member):   PyConfig.           (line  361)
* PyConfig.use_hash_seed (C member):     PyConfig.           (line  185)
* PyConfig.verbose (C member):           PyConfig.           (line  369)
* PyConfig.warnoptions (C member):       PyConfig.           (line  373)
* PyConfig.write_bytecode (C member):    PyConfig.           (line  384)
* PyConfig.xoptions (C member):          PyConfig.           (line  391)
* PyConfig_Clear (C function):           PyConfig.           (line   69)
* PyConfig_InitIsolatedConfig (C function): PyConfig.        (line   17)
* PyConfig_InitPythonConfig (C function): PyConfig.          (line   12)
* PyConfig_Read (C function):            PyConfig.           (line   61)
* PyConfig_SetArgv (C function):         PyConfig.           (line   37)
* PyConfig_SetBytesArgv (C function):    PyConfig.           (line   44)
* PyConfig_SetBytesString (C function):  PyConfig.           (line   29)
* PyConfig_SetString (C function):       PyConfig.           (line   22)
* PyConfig_SetWideStringList (C function): PyConfig.         (line   53)
* PyContext (C type):                    Context Variables Objects.
                                                             (line   20)
* PyContextToken (C type):               Context Variables Objects.
                                                             (line   30)
* PyContextToken_CheckExact (C function): Context Variables Objects.
                                                             (line   58)
* PyContextToken_Type (C variable):      Context Variables Objects.
                                                             (line   42)
* PyContextVar (C type):                 Context Variables Objects.
                                                             (line   25)
* PyContextVar_CheckExact (C function):  Context Variables Objects.
                                                             (line   53)
* PyContextVar_Get (C function):         Context Variables Objects.
                                                             (line  103)
* PyContextVar_New (C function):         Context Variables Objects.
                                                             (line   95)
* PyContextVar_Reset (C function):       Context Variables Objects.
                                                             (line  128)
* PyContextVar_Set (C function):         Context Variables Objects.
                                                             (line  122)
* PyContextVar_Type (C variable):        Context Variables Objects.
                                                             (line   38)
* PyContext_CheckExact (C function):     Context Variables Objects.
                                                             (line   48)
* PyContext_ClearFreeList (C function):  Context Variables Objects.
                                                             (line   88)
* PyContext_Copy (C function):           Context Variables Objects.
                                                             (line   69)
* PyContext_CopyCurrent (C function):    Context Variables Objects.
                                                             (line   73)
* PyContext_Enter (C function):          Context Variables Objects.
                                                             (line   77)
* PyContext_Exit (C function):           Context Variables Objects.
                                                             (line   82)
* PyContext_New (C function):            Context Variables Objects.
                                                             (line   65)
* PyContext_Type (C variable):           Context Variables Objects.
                                                             (line   34)
* PyCoroObject (C type):                 Coroutine Objects<2>.
                                                             (line   11)
* PyCoro_CheckExact (C function):        Coroutine Objects<2>.
                                                             (line   19)
* PyCoro_New (C function):               Coroutine Objects<2>.
                                                             (line   24)
* PyCoro_Type (C variable):              Coroutine Objects<2>.
                                                             (line   15)
* PyDateTime_Check (C function):         DateTime Objects<2>.
                                                             (line   35)
* PyDateTime_CheckExact (C function):    DateTime Objects<2>.
                                                             (line   40)
* PyDateTime_DATE_GET_HOUR (C function): DateTime Objects<2>.
                                                             (line  158)
* PyDateTime_DATE_GET_MICROSECOND (C function): DateTime Objects<2>.
                                                             (line  170)
* PyDateTime_DATE_GET_MINUTE (C function): DateTime Objects<2>.
                                                             (line  162)
* PyDateTime_DATE_GET_SECOND (C function): DateTime Objects<2>.
                                                             (line  166)
* PyDateTime_DELTA_GET_DAYS (C function): DateTime Objects<2>.
                                                             (line  200)
* PyDateTime_DELTA_GET_MICROSECONDS (C function): DateTime Objects<2>.
                                                             (line  212)
* PyDateTime_DELTA_GET_SECONDS (C function): DateTime Objects<2>.
                                                             (line  206)
* PyDateTime_FromDateAndTime (C function): DateTime Objects<2>.
                                                             (line   81)
* PyDateTime_FromDateAndTimeAndFold (C function): DateTime Objects<2>.
                                                             (line   88)
* PyDateTime_FromTimestamp (C function): DateTime Objects<2>.
                                                             (line  221)
* PyDateTime_GET_DAY (C function):       DateTime Objects<2>.
                                                             (line  150)
* PyDateTime_GET_MONTH (C function):     DateTime Objects<2>.
                                                             (line  146)
* PyDateTime_GET_YEAR (C function):      DateTime Objects<2>.
                                                             (line  142)
* PyDateTime_TimeZone_UTC (C variable):  DateTime Objects<2>.
                                                             (line   16)
* PyDateTime_TIME_GET_HOUR (C function): DateTime Objects<2>.
                                                             (line  180)
* PyDateTime_TIME_GET_MICROSECOND (C function): DateTime Objects<2>.
                                                             (line  192)
* PyDateTime_TIME_GET_MINUTE (C function): DateTime Objects<2>.
                                                             (line  184)
* PyDateTime_TIME_GET_SECOND (C function): DateTime Objects<2>.
                                                             (line  188)
* PyDate_Check (C function):             DateTime Objects<2>.
                                                             (line   25)
* PyDate_CheckExact (C function):        DateTime Objects<2>.
                                                             (line   30)
* PyDate_FromDate (C function):          DateTime Objects<2>.
                                                             (line   77)
* PyDate_FromTimestamp (C function):     DateTime Objects<2>.
                                                             (line  226)
* PyDelta_Check (C function):            DateTime Objects<2>.
                                                             (line   55)
* PyDelta_CheckExact (C function):       DateTime Objects<2>.
                                                             (line   60)
* PyDelta_FromDSU (C function):          DateTime Objects<2>.
                                                             (line  112)
* PyDescr_IsData (C function):           Descriptor Objects. (line   37)
* PyDescr_NewClassMethod (C function):   Descriptor Objects. (line   32)
* PyDescr_NewGetSet (C function):        Descriptor Objects. (line   13)
* PyDescr_NewMember (C function):        Descriptor Objects. (line   18)
* PyDescr_NewMethod (C function):        Descriptor Objects. (line   23)
* PyDescr_NewWrapper (C function):       Descriptor Objects. (line   28)
* PyDictObject (C type):                 Dictionary Objects. (line    6)
* PyDictProxy_New (C function):          Dictionary Objects. (line   31)
* PyDict_Check (C function):             Dictionary Objects. (line   17)
* PyDict_CheckExact (C function):        Dictionary Objects. (line   22)
* PyDict_Clear (C function):             Dictionary Objects. (line   37)
* PyDict_ClearFreeList (C function):     Dictionary Objects. (line  195)
* PyDict_Contains (C function):          Dictionary Objects. (line   41)
* PyDict_Copy (C function):              Dictionary Objects. (line   47)
* PyDict_DelItem (C function):           Dictionary Objects. (line   68)
* PyDict_DelItemString (C function):     Dictionary Objects. (line   74)
* PyDict_GetItem (C function):           Dictionary Objects. (line   79)
* PyDict_GetItemString (C function):     Dictionary Objects. (line   96)
* PyDict_GetItemWithError (C function):  Dictionary Objects. (line   88)
* PyDict_Items (C function):             Dictionary Objects. (line  119)
* PyDict_Keys (C function):              Dictionary Objects. (line  123)
* PyDict_Merge (C function):             Dictionary Objects. (line  163)
* PyDict_MergeFromSeq2 (C function):     Dictionary Objects. (line  182)
* PyDict_New (C function):               Dictionary Objects. (line   27)
* PyDict_Next (C function):              Dictionary Objects. (line  136)
* PyDict_SetDefault (C function):        Dictionary Objects. (line  107)
* PyDict_SetItem (C function):           Dictionary Objects. (line   51)
* PyDict_SetItemString (C function):     Dictionary Objects. (line   59)
* PyDict_Size (C function):              Dictionary Objects. (line  131)
* PyDict_Type (C variable):              Dictionary Objects. (line   11)
* PyDict_Update (C function):            Dictionary Objects. (line  174)
* PyDict_Values (C function):            Dictionary Objects. (line  127)
* PyDLL (class in ctypes):               Loading shared libraries.
                                                             (line   45)
* pydoc (module):                        pydoc — Documentation generator and online help system.
                                                             (line    6)
* PyErr_BadArgument (C function):        Raising exceptions. (line   46)
* PyErr_BadInternalCall (C function):    Raising exceptions. (line  197)
* PyErr_CheckSignals (C function):       Signal Handling<2>. (line    6)
* PyErr_Clear (C function):              Printing and clearing.
                                                             (line    6)
* PyErr_Clear():                         Exceptions<18>.     (line   25)
* PyErr_Clear() <1>:                     Exceptions<18>.     (line   77)
* PyErr_ExceptionMatches (C function):   Querying the error indicator.
                                                             (line   20)
* PyErr_ExceptionMatches():              Exceptions<18>.     (line   77)
* PyErr_Fetch (C function):              Querying the error indicator.
                                                             (line   36)
* PyErr_Fetch():                         Finalization and De-allocation.
                                                             (line   16)
* PyErr_Format (C function):             Raising exceptions. (line   25)
* PyErr_FormatV (C function):            Raising exceptions. (line   33)
* PyErr_GetExcInfo (C function):         Querying the error indicator.
                                                             (line   88)
* PyErr_GivenExceptionMatches (C function): Querying the error indicator.
                                                             (line   26)
* PyErr_NewException (C function):       Exception Classes.  (line    6)
* PyErr_NewExceptionWithDoc (C function): Exception Classes. (line   24)
* PyErr_NoMemory (C function):           Raising exceptions. (line   52)
* PyErr_NormalizeException (C function): Querying the error indicator.
                                                             (line   71)
* PyErr_Occurred (C function):           Querying the error indicator.
                                                             (line    6)
* PyErr_Occurred():                      Exceptions<18>.     (line   12)
* PyErr_Print (C function):              Printing and clearing.
                                                             (line   26)
* PyErr_PrintEx (C function):            Printing and clearing.
                                                             (line   11)
* PyErr_ResourceWarning (C function):    Issuing warnings.   (line   80)
* PyErr_Restore (C function):            Querying the error indicator.
                                                             (line   52)
* PyErr_Restore():                       Finalization and De-allocation.
                                                             (line   16)
* PyErr_SetExcFromWindowsErr (C function): Raising exceptions.
                                                             (line  114)
* PyErr_SetExcFromWindowsErrWithFilename (C function): Raising exceptions.
                                                             (line  152)
* PyErr_SetExcFromWindowsErrWithFilenameObject (C function): Raising exceptions.
                                                             (line  132)
* PyErr_SetExcFromWindowsErrWithFilenameObjects (C function): Raising exceptions.
                                                             (line  141)
* PyErr_SetExcInfo (C function):         Querying the error indicator.
                                                             (line  105)
* PyErr_SetFromErrno (C function):       Raising exceptions. (line   58)
* PyErr_SetFromErrnoWithFilename (C function): Raising exceptions.
                                                             (line   93)
* PyErr_SetFromErrnoWithFilenameObject (C function): Raising exceptions.
                                                             (line   73)
* PyErr_SetFromErrnoWithFilenameObjects (C function): Raising exceptions.
                                                             (line   82)
* PyErr_SetFromWindowsErr (C function):  Raising exceptions. (line  100)
* PyErr_SetFromWindowsErrWithFilename (C function): Raising exceptions.
                                                             (line  123)
* PyErr_SetImportError (C function):     Raising exceptions. (line  161)
* PyErr_SetImportErrorSubclass (C function): Issuing warnings.
                                                             (line   41)
* PyErr_SetInterrupt (C function):       Signal Handling<2>. (line   18)
* PyErr_SetNone (C function):            Raising exceptions. (line   42)
* PyErr_SetObject (C function):          Raising exceptions. (line   19)
* PyErr_SetString (C function):          Raising exceptions. (line   10)
* PyErr_SetString():                     Exceptions<18>.     (line   25)
* PyErr_SyntaxLocation (C function):     Raising exceptions. (line  191)
* PyErr_SyntaxLocationEx (C function):   Raising exceptions. (line  182)
* PyErr_SyntaxLocationObject (C function): Raising exceptions.
                                                             (line  171)
* PyErr_WarnEx (C function):             Issuing warnings.   (line   19)
* PyErr_WarnExplicit (C function):       Issuing warnings.   (line   63)
* PyErr_WarnExplicitObject (C function): Issuing warnings.   (line   50)
* PyErr_WarnFormat (C function):         Issuing warnings.   (line   71)
* PyErr_WriteUnraisable (C function):    Printing and clearing.
                                                             (line   30)
* PyEval_AcquireLock (C function):       Low-level API.      (line  137)
* PyEval_AcquireThread (C function):     Low-level API.      (line  104)
* PyEval_AcquireThread():                High-level API.     (line   29)
* PyEval_EvalCode (C function):          The Very High Level Layer.
                                                             (line  328)
* PyEval_EvalCodeEx (C function):        The Very High Level Layer.
                                                             (line  334)
* PyEval_EvalFrame (C function):         The Very High Level Layer.
                                                             (line  353)
* PyEval_EvalFrameEx (C function):       The Very High Level Layer.
                                                             (line  358)
* PyEval_GetBuiltins (C function):       Reflection.         (line    6)
* PyEval_GetFrame (C function):          Reflection.         (line   21)
* PyEval_GetFuncDesc (C function):       Reflection.         (line   34)
* PyEval_GetFuncName (C function):       Reflection.         (line   29)
* PyEval_GetGlobals (C function):        Reflection.         (line   16)
* PyEval_GetLocals (C function):         Reflection.         (line   11)
* PyEval_InitThreads (C function):       High-level API.     (line   27)
* PyEval_InitThreads():                  Initializing and finalizing the interpreter.
                                                             (line    8)
* PyEval_MergeCompilerFlags (C function): The Very High Level Layer.
                                                             (line  372)
* PyEval_ReleaseLock (C function):       Low-level API.      (line  159)
* PyEval_ReleaseThread (C function):     Low-level API.      (line  126)
* PyEval_ReleaseThread():                High-level API.     (line   29)
* PyEval_RestoreThread (C function):     High-level API.     (line   62)
* PyEval_RestoreThread():                Releasing the GIL from extension code.
                                                             (line   23)
* PyEval_RestoreThread() <1>:            High-level API.     (line   29)
* PyEval_SaveThread (C function):        High-level API.     (line   55)
* PyEval_SaveThread():                   Releasing the GIL from extension code.
                                                             (line   23)
* PyEval_SaveThread() <1>:               High-level API.     (line   29)
* PyEval_SetProfile (C function):        Profiling and Tracing.
                                                             (line  116)
* PyEval_SetTrace (C function):          Profiling and Tracing.
                                                             (line  127)
* PyEval_ThreadsInitialized (C function): High-level API.    (line   45)
* PyException_GetCause (C function):     Exception Objects.  (line   32)
* PyException_GetContext (C function):   Exception Objects.  (line   18)
* PyException_GetTraceback (C function): Exception Objects.  (line    6)
* PyException_SetCause (C function):     Exception Objects.  (line   38)
* PyException_SetContext (C function):   Exception Objects.  (line   25)
* PyException_SetTraceback (C function): Exception Objects.  (line   12)
* PyExc_ArithmeticError:                 Standard Exceptions.
                                                             (line   11)
* PyExc_AssertionError:                  Standard Exceptions.
                                                             (line   11)
* PyExc_AttributeError:                  Standard Exceptions.
                                                             (line   11)
* PyExc_BaseException:                   Standard Exceptions.
                                                             (line   11)
* PyExc_BlockingIOError:                 Standard Exceptions.
                                                             (line   11)
* PyExc_BrokenPipeError:                 Standard Exceptions.
                                                             (line   11)
* PyExc_BufferError:                     Standard Exceptions.
                                                             (line   11)
* PyExc_BytesWarning:                    Standard Warning Categories.
                                                             (line   11)
* PyExc_ChildProcessError:               Standard Exceptions.
                                                             (line   11)
* PyExc_ConnectionAbortedError:          Standard Exceptions.
                                                             (line   11)
* PyExc_ConnectionError:                 Standard Exceptions.
                                                             (line   11)
* PyExc_ConnectionRefusedError:          Standard Exceptions.
                                                             (line   11)
* PyExc_ConnectionResetError:            Standard Exceptions.
                                                             (line   11)
* PyExc_DeprecationWarning:              Standard Warning Categories.
                                                             (line   11)
* PyExc_EnvironmentError:                Standard Exceptions.
                                                             (line  190)
* PyExc_EOFError:                        Standard Exceptions.
                                                             (line   11)
* PyExc_Exception:                       Standard Exceptions.
                                                             (line   11)
* PyExc_FileExistsError:                 Standard Exceptions.
                                                             (line   11)
* PyExc_FileNotFoundError:               Standard Exceptions.
                                                             (line   11)
* PyExc_FloatingPointError:              Standard Exceptions.
                                                             (line   11)
* PyExc_FutureWarning:                   Standard Warning Categories.
                                                             (line   11)
* PyExc_GeneratorExit:                   Standard Exceptions.
                                                             (line   11)
* PyExc_ImportError:                     Standard Exceptions.
                                                             (line   11)
* PyExc_ImportWarning:                   Standard Warning Categories.
                                                             (line   11)
* PyExc_IndentationError:                Standard Exceptions.
                                                             (line   11)
* PyExc_IndexError:                      Standard Exceptions.
                                                             (line   11)
* PyExc_InterruptedError:                Standard Exceptions.
                                                             (line   11)
* PyExc_IOError:                         Standard Exceptions.
                                                             (line  190)
* PyExc_IsADirectoryError:               Standard Exceptions.
                                                             (line   11)
* PyExc_KeyboardInterrupt:               Standard Exceptions.
                                                             (line   11)
* PyExc_KeyError:                        Standard Exceptions.
                                                             (line   11)
* PyExc_LookupError:                     Standard Exceptions.
                                                             (line   11)
* PyExc_MemoryError:                     Standard Exceptions.
                                                             (line   11)
* PyExc_ModuleNotFoundError:             Standard Exceptions.
                                                             (line   11)
* PyExc_NameError:                       Standard Exceptions.
                                                             (line   11)
* PyExc_NotADirectoryError:              Standard Exceptions.
                                                             (line   11)
* PyExc_NotImplementedError:             Standard Exceptions.
                                                             (line   11)
* PyExc_OSError:                         Standard Exceptions.
                                                             (line   11)
* PyExc_OverflowError:                   Standard Exceptions.
                                                             (line   11)
* PyExc_PendingDeprecationWarning:       Standard Warning Categories.
                                                             (line   11)
* PyExc_PermissionError:                 Standard Exceptions.
                                                             (line   11)
* PyExc_ProcessLookupError:              Standard Exceptions.
                                                             (line   11)
* PyExc_RecursionError:                  Standard Exceptions.
                                                             (line   11)
* PyExc_ReferenceError:                  Standard Exceptions.
                                                             (line   11)
* PyExc_ResourceWarning:                 Standard Warning Categories.
                                                             (line   11)
* PyExc_RuntimeError:                    Standard Exceptions.
                                                             (line   11)
* PyExc_RuntimeWarning:                  Standard Warning Categories.
                                                             (line   11)
* PyExc_StopAsyncIteration:              Standard Exceptions.
                                                             (line   11)
* PyExc_StopIteration:                   Standard Exceptions.
                                                             (line   11)
* PyExc_SyntaxError:                     Standard Exceptions.
                                                             (line   11)
* PyExc_SyntaxWarning:                   Standard Warning Categories.
                                                             (line   11)
* PyExc_SystemError:                     Standard Exceptions.
                                                             (line   11)
* PyExc_SystemExit:                      Standard Exceptions.
                                                             (line   11)
* PyExc_TabError:                        Standard Exceptions.
                                                             (line   11)
* PyExc_TimeoutError:                    Standard Exceptions.
                                                             (line   11)
* PyExc_TypeError:                       Standard Exceptions.
                                                             (line   11)
* PyExc_UnboundLocalError:               Standard Exceptions.
                                                             (line   11)
* PyExc_UnicodeDecodeError:              Standard Exceptions.
                                                             (line   11)
* PyExc_UnicodeEncodeError:              Standard Exceptions.
                                                             (line   11)
* PyExc_UnicodeError:                    Standard Exceptions.
                                                             (line   11)
* PyExc_UnicodeTranslateError:           Standard Exceptions.
                                                             (line   11)
* PyExc_UnicodeWarning:                  Standard Warning Categories.
                                                             (line   11)
* PyExc_UserWarning:                     Standard Warning Categories.
                                                             (line   11)
* PyExc_ValueError:                      Standard Exceptions.
                                                             (line   11)
* PyExc_Warning:                         Standard Warning Categories.
                                                             (line   11)
* PyExc_WindowsError:                    Standard Exceptions.
                                                             (line  190)
* PyExc_ZeroDivisionError:               Standard Exceptions.
                                                             (line   11)
* PyFile_FromFd (C function):            File Objects.       (line   15)
* PyFile_GetLine (C function):           File Objects.       (line   40)
* PyFile_SetOpenCodeHook (C function):   File Objects.       (line   54)
* PyFile_WriteObject (C function):       File Objects.       (line   81)
* PyFile_WriteString (C function):       File Objects.       (line   89)
* PyFloatObject (C type):                Floating Point Objects.
                                                             (line    6)
* PyFloat_AsDouble (C function):         Floating Point Objects.
                                                             (line   35)
* PyFloat_AS_DOUBLE (C function):        Floating Point Objects.
                                                             (line   47)
* PyFloat_Check (C function):            Floating Point Objects.
                                                             (line   17)
* PyFloat_CheckExact (C function):       Floating Point Objects.
                                                             (line   22)
* PyFloat_ClearFreeList (C function):    Floating Point Objects.
                                                             (line   68)
* PyFloat_FromDouble (C function):       Floating Point Objects.
                                                             (line   31)
* PyFloat_FromString (C function):       Floating Point Objects.
                                                             (line   27)
* PyFloat_GetInfo (C function):          Floating Point Objects.
                                                             (line   52)
* PyFloat_GetMax (C function):           Floating Point Objects.
                                                             (line   58)
* PyFloat_GetMin (C function):           Floating Point Objects.
                                                             (line   63)
* PyFloat_Type (C variable):             Floating Point Objects.
                                                             (line   11)
* PyFrameObject (C type):                The Very High Level Layer.
                                                             (line  348)
* PyFrame_GetLineNumber (C function):    Reflection.         (line   25)
* PyFrozenSet_Check (C function):        Set Objects.        (line   50)
* PyFrozenSet_CheckExact (C function):   Set Objects.        (line   65)
* PyFrozenSet_New (C function):          Set Objects.        (line   78)
* PyFrozenSet_Type (C variable):         Set Objects.        (line   36)
* PyFunctionObject (C type):             Function Objects<3>.
                                                             (line    8)
* PyFunction_Check (C function):         Function Objects<3>.
                                                             (line   18)
* PyFunction_GetAnnotations (C function): Function Objects<3>.
                                                             (line   85)
* PyFunction_GetClosure (C function):    Function Objects<3>.
                                                             (line   72)
* PyFunction_GetCode (C function):       Function Objects<3>.
                                                             (line   45)
* PyFunction_GetDefaults (C function):   Function Objects<3>.
                                                             (line   59)
* PyFunction_GetGlobals (C function):    Function Objects<3>.
                                                             (line   49)
* PyFunction_GetModule (C function):     Function Objects<3>.
                                                             (line   53)
* PyFunction_New (C function):           Function Objects<3>.
                                                             (line   23)
* PyFunction_NewWithQualName (C function): Function Objects<3>.
                                                             (line   34)
* PyFunction_SetAnnotations (C function): Function Objects<3>.
                                                             (line   89)
* PyFunction_SetClosure (C function):    Function Objects<3>.
                                                             (line   77)
* PyFunction_SetDefaults (C function):   Function Objects<3>.
                                                             (line   64)
* PyFunction_Type (C variable):          Function Objects<3>.
                                                             (line   12)
* PYFUNCTYPE() (in module ctypes):       Function prototypes.
                                                             (line   34)
* PyGenObject (C type):                  Generator Objects.  (line   11)
* PyGen_Check (C function):              Generator Objects.  (line   19)
* PyGen_CheckExact (C function):         Generator Objects.  (line   23)
* PyGen_New (C function):                Generator Objects.  (line   28)
* PyGen_NewWithQualName (C function):    Generator Objects.  (line   33)
* PyGen_Type (C variable):               Generator Objects.  (line   15)
* PyGetSetDef (C type):                  Common Object Structures.
                                                             (line  356)
* PyGILState_Check (C function):         High-level API.     (line  142)
* PyGILState_Ensure (C function):        High-level API.     (line   92)
* PyGILState_GetThisThreadState (C function): High-level API.
                                                             (line  134)
* PyGILState_Release (C function):       High-level API.     (line  123)
* PyImport_AddModule (C function):       Importing Modules<2>.
                                                             (line  111)
* PyImport_AddModuleObject (C function): Importing Modules<2>.
                                                             (line   95)
* PyImport_AppendInittab (C function):   Importing Modules<2>.
                                                             (line  277)
* PyImport_Cleanup (C function):         Importing Modules<2>.
                                                             (line  234)
* PyImport_ExecCodeModule (C function):  Importing Modules<2>.
                                                             (line  116)
* PyImport_ExecCodeModuleEx (C function): Importing Modules<2>.
                                                             (line  152)
* PyImport_ExecCodeModuleObject (C function): Importing Modules<2>.
                                                             (line  162)
* PyImport_ExecCodeModuleWithPathnames (C function): Importing Modules<2>.
                                                             (line  172)
* PyImport_ExtendInittab (C function):   Importing Modules<2>.
                                                             (line  300)
* PyImport_FrozenModules (C variable):   Importing Modules<2>.
                                                             (line  269)
* PyImport_GetImporter (C function):     Importing Modules<2>.
                                                             (line  219)
* PyImport_GetMagicNumber (C function):  Importing Modules<2>.
                                                             (line  188)
* PyImport_GetMagicTag (C function):     Importing Modules<2>.
                                                             (line  197)
* PyImport_GetModule (C function):       Importing Modules<2>.
                                                             (line  211)
* PyImport_GetModuleDict (C function):   Importing Modules<2>.
                                                             (line  206)
* PyImport_Import (C function):          Importing Modules<2>.
                                                             (line   80)
* PyImport_ImportFrozenModule (C function): Importing Modules<2>.
                                                             (line  255)
* PyImport_ImportFrozenModuleObject (C function): Importing Modules<2>.
                                                             (line  242)
* PyImport_ImportModule (C function):    Importing Modules<2>.
                                                             (line    6)
* PyImport_ImportModuleEx (C function):  Importing Modules<2>.
                                                             (line   35)
* PyImport_ImportModuleLevel (C function): Importing Modules<2>.
                                                             (line   69)
* PyImport_ImportModuleLevelObject (C function): Importing Modules<2>.
                                                             (line   52)
* PyImport_ImportModuleNoBlock (C function): Importing Modules<2>.
                                                             (line   25)
* PyImport_ReloadModule (C function):    Importing Modules<2>.
                                                             (line   90)
* PyIndex_Check (C function):            Number Protocol.    (line  272)
* PyInit_modulename (C function):        Building C and C++ Extensions.
                                                             (line   16)
* PyInstanceMethod_Check (C function):   Instance Method Objects.
                                                             (line   15)
* PyInstanceMethod_Function (C function): Instance Method Objects.
                                                             (line   25)
* PyInstanceMethod_GET_FUNCTION (C function): Instance Method Objects.
                                                             (line   29)
* PyInstanceMethod_New (C function):     Instance Method Objects.
                                                             (line   20)
* PyInstanceMethod_Type (C variable):    Instance Method Objects.
                                                             (line   10)
* PyInterpreterState (C type):           High-level API.     (line    9)
* PyInterpreterState_Clear (C function): Low-level API.      (line   21)
* PyInterpreterState_Delete (C function): Low-level API.     (line   30)
* PyInterpreterState_GetDict (C function): Low-level API.    (line   63)
* PyInterpreterState_GetID (C function): Low-level API.      (line   55)
* PyInterpreterState_Head (C function):  Advanced Debugger Support.
                                                             (line    9)
* PyInterpreterState_Main (C function):  Advanced Debugger Support.
                                                             (line   14)
* PyInterpreterState_New (C function):   Low-level API.      (line   12)
* PyInterpreterState_Next (C function):  Advanced Debugger Support.
                                                             (line   18)
* PyInterpreterState_ThreadHead (C function): Advanced Debugger Support.
                                                             (line   25)
* PyIter_Check (C function):             Iterator Protocol.  (line    8)
* PyIter_Next (C function):              Iterator Protocol.  (line   12)
* PyListObject (C type):                 List Objects.       (line    6)
* PyList_Append (C function):            List Objects.       (line   91)
* PyList_AsTuple (C function):           List Objects.       (line  125)
* PyList_Check (C function):             List Objects.       (line   17)
* PyList_CheckExact (C function):        List Objects.       (line   22)
* PyList_ClearFreeList (C function):     List Objects.       (line  131)
* PyList_GetItem (C function):           List Objects.       (line   46)
* PyList_GetItem():                      Reference Count Details.
                                                             (line   90)
* PyList_GetSlice (C function):          List Objects.       (line   97)
* PyList_GET_ITEM (C function):          List Objects.       (line   54)
* PyList_GET_SIZE (C function):          List Objects.       (line   42)
* PyList_Insert (C function):            List Objects.       (line   83)
* PyList_New (C function):               List Objects.       (line   27)
* PyList_Reverse (C function):           List Objects.       (line  120)
* PyList_SetItem (C function):           List Objects.       (line   58)
* PyList_SetItem():                      Reference Count Details.
                                                             (line   26)
* PyList_SetSlice (C function):          List Objects.       (line  105)
* PyList_SET_ITEM (C function):          List Objects.       (line   70)
* PyList_Size (C function):              List Objects.       (line   37)
* PyList_Sort (C function):              List Objects.       (line  115)
* PyList_Type (C variable):              List Objects.       (line   11)
* PyLongObject (C type):                 Integer Objects.    (line   13)
* PyLong_AsDouble (C function):          Integer Objects.    (line  277)
* PyLong_AsLong (C function):            Integer Objects.    (line  110)
* PyLong_AsLongAndOverflow (C function): Integer Objects.    (line  128)
* PyLong_AsLongLong (C function):        Integer Objects.    (line  149)
* PyLong_AsLongLongAndOverflow (C function): Integer Objects.
                                                             (line  167)
* PyLong_AsSize_t (C function):          Integer Objects.    (line  213)
* PyLong_AsSsize_t (C function):         Integer Objects.    (line  191)
* PyLong_AsUnsignedLong (C function):    Integer Objects.    (line  202)
* PyLong_AsUnsignedLongLong (C function): Integer Objects.   (line  224)
* PyLong_AsUnsignedLongLongMask (C function): Integer Objects.
                                                             (line  257)
* PyLong_AsUnsignedLongMask (C function): Integer Objects.   (line  239)
* PyLong_AsVoidPtr (C function):         Integer Objects.    (line  288)
* PyLong_Check (C function):             Integer Objects.    (line   24)
* PyLong_CheckExact (C function):        Integer Objects.    (line   29)
* PyLong_FromDouble (C function):        Integer Objects.    (line   66)
* PyLong_FromLong (C function):          Integer Objects.    (line   34)
* PyLong_FromLongLong (C function):      Integer Objects.    (line   56)
* PyLong_FromSize_t (C function):        Integer Objects.    (line   52)
* PyLong_FromSsize_t (C function):       Integer Objects.    (line   48)
* PyLong_FromString (C function):        Integer Objects.    (line   70)
* PyLong_FromUnicode (C function):       Integer Objects.    (line   84)
* PyLong_FromUnicodeObject (C function): Integer Objects.    (line   95)
* PyLong_FromUnsignedLong (C function):  Integer Objects.    (line   44)
* PyLong_FromUnsignedLongLong (C function): Integer Objects. (line   60)
* PyLong_FromVoidPtr (C function):       Integer Objects.    (line  105)
* PyLong_Type (C variable):              Integer Objects.    (line   18)
* PyMappingMethods (C type):             Mapping Object Structures.
                                                             (line    6)
* PyMappingMethods.mp_ass_subscript (C member): Mapping Object Structures.
                                                             (line   25)
* PyMappingMethods.mp_length (C member): Mapping Object Structures.
                                                             (line   11)
* PyMappingMethods.mp_subscript (C member): Mapping Object Structures.
                                                             (line   17)
* PyMapping_Check (C function):          Mapping Protocol.   (line    9)
* PyMapping_DelItem (C function):        Mapping Protocol.   (line   38)
* PyMapping_DelItemString (C function):  Mapping Protocol.   (line   44)
* PyMapping_GetItemString (C function):  Mapping Protocol.   (line   23)
* PyMapping_HasKey (C function):         Mapping Protocol.   (line   51)
* PyMapping_HasKeyString (C function):   Mapping Protocol.   (line   61)
* PyMapping_Items (C function):          Mapping Protocol.   (line   87)
* PyMapping_Keys (C function):           Mapping Protocol.   (line   73)
* PyMapping_Length (C function):         Mapping Protocol.   (line   17)
* PyMapping_SetItemString (C function):  Mapping Protocol.   (line   31)
* PyMapping_Size (C function):           Mapping Protocol.   (line   17)
* PyMapping_Values (C function):         Mapping Protocol.   (line   80)
* PyMarshal_ReadLastObjectFromFile (C function): Data marshalling support.
                                                             (line   68)
* PyMarshal_ReadLongFromFile (C function): Data marshalling support.
                                                             (line   42)
* PyMarshal_ReadObjectFromFile (C function): Data marshalling support.
                                                             (line   60)
* PyMarshal_ReadObjectFromString (C function): Data marshalling support.
                                                             (line   83)
* PyMarshal_ReadShortFromFile (C function): Data marshalling support.
                                                             (line   51)
* PyMarshal_WriteLongToFile (C function): Data marshalling support.
                                                             (line   20)
* PyMarshal_WriteObjectToFile (C function): Data marshalling support.
                                                             (line   28)
* PyMarshal_WriteObjectToString (C function): Data marshalling support.
                                                             (line   34)
* PyMemAllocatorDomain (C type):         Customize Memory Allocators.
                                                             (line   36)
* PyMemAllocatorEx (C type):             Customize Memory Allocators.
                                                             (line    8)
* PyMemberDef (C type):                  Common Object Structures.
                                                             (line  253)
* PyMemoryView_Check (C function):       MemoryView objects. (line   41)
* PyMemoryView_FromBuffer (C function):  MemoryView objects. (line   26)
* PyMemoryView_FromMemory (C function):  MemoryView objects. (line   17)
* PyMemoryView_FromObject (C function):  MemoryView objects. (line   10)
* PyMemoryView_GetContiguous (C function): MemoryView objects.
                                                             (line   31)
* PyMemoryView_GET_BASE (C function):    MemoryView objects. (line   53)
* PyMemoryView_GET_BUFFER (C function):  MemoryView objects. (line   46)
* PyMem_Calloc (C function):             Memory Interface.   (line   28)
* PyMem_Del (C function):                Memory Interface.   (line   86)
* PYMEM_DOMAIN_MEM (C variable):         Customize Memory Allocators.
                                                             (line   52)
* PYMEM_DOMAIN_OBJ (C variable):         Customize Memory Allocators.
                                                             (line   64)
* PYMEM_DOMAIN_RAW (C variable):         Customize Memory Allocators.
                                                             (line   40)
* PyMem_Free (C function):               Memory Interface.   (line   57)
* PyMem_GetAllocator (C function):       Customize Memory Allocators.
                                                             (line   76)
* PyMem_Malloc (C function):             Memory Interface.   (line   19)
* PyMem_New (C function):                Memory Interface.   (line   70)
* PyMem_RawCalloc (C function):          Raw Memory Interface.
                                                             (line   24)
* PyMem_RawFree (C function):            Raw Memory Interface.
                                                             (line   53)
* PyMem_RawMalloc (C function):          Raw Memory Interface.
                                                             (line   15)
* PyMem_RawRealloc (C function):         Raw Memory Interface.
                                                             (line   36)
* PyMem_Realloc (C function):            Memory Interface.   (line   40)
* PyMem_Resize (C function):             Memory Interface.   (line   76)
* PyMem_SetAllocator (C function):       Customize Memory Allocators.
                                                             (line   82)
* PyMem_SetupDebugHooks (C function):    Customize Memory Allocators.
                                                             (line   99)
* PyMethodDef (C type):                  Common Object Structures.
                                                             (line  117)
* PyMethod_Check (C function):           Method Objects<2>.  (line   16)
* PyMethod_ClearFreeList (C function):   Method Objects<2>.  (line   43)
* PyMethod_Function (C function):        Method Objects<2>.  (line   27)
* PyMethod_GET_FUNCTION (C function):    Method Objects<2>.  (line   31)
* PyMethod_GET_SELF (C function):        Method Objects<2>.  (line   39)
* PyMethod_New (C function):             Method Objects<2>.  (line   21)
* PyMethod_Self (C function):            Method Objects<2>.  (line   35)
* PyMethod_Type (C variable):            Method Objects<2>.  (line   10)
* PyModuleDef (C type):                  Initializing C modules.
                                                             (line   17)
* PyModuleDef.m_base (C member):         Initializing C modules.
                                                             (line   23)
* PyModuleDef.m_clear (C member):        Initializing C modules.
                                                             (line   82)
* PyModuleDef.m_doc (C member):          Initializing C modules.
                                                             (line   31)
* PyModuleDef.m_free (C member):         Initializing C modules.
                                                             (line   90)
* PyModuleDef.m_methods (C member):      Initializing C modules.
                                                             (line   57)
* PyModuleDef.m_name (C member):         Initializing C modules.
                                                             (line   27)
* PyModuleDef.m_reload (C member):       Initializing C modules.
                                                             (line   72)
* PyModuleDef.m_size (C member):         Initializing C modules.
                                                             (line   36)
* PyModuleDef.m_slots (C member):        Initializing C modules.
                                                             (line   63)
* PyModuleDef.m_traverse (C member):     Initializing C modules.
                                                             (line   74)
* PyModuleDef_Init (C function):         Multi-phase initialization.
                                                             (line   33)
* PyModuleDef_Slot (C type):             Multi-phase initialization.
                                                             (line   45)
* PyModuleDef_Slot.slot (C member):      Multi-phase initialization.
                                                             (line   47)
* PyModuleDef_Slot.value (C member):     Multi-phase initialization.
                                                             (line   51)
* PyModule_AddFunctions (C function):    Low-level module creation functions.
                                                             (line   53)
* PyModule_AddIntConstant (C function):  Support functions.  (line   29)
* PyModule_AddIntMacro (C function):     Support functions.  (line   46)
* PyModule_AddObject (C function):       Support functions.  (line   11)
* PyModule_AddStringConstant (C function): Support functions.
                                                             (line   37)
* PyModule_AddStringMacro (C function):  Support functions.  (line   53)
* PyModule_Check (C function):           Module Objects.     (line   12)
* PyModule_CheckExact (C function):      Module Objects.     (line   17)
* PyModule_Create (C function):          Single-phase initialization.
                                                             (line   10)
* PyModule_Create2 (C function):         Single-phase initialization.
                                                             (line   16)
* PyModule_ExecDef (C function):         Low-level module creation functions.
                                                             (line   36)
* PyModule_FromDefAndSpec (C function):  Low-level module creation functions.
                                                             (line   11)
* PyModule_FromDefAndSpec2 (C function): Low-level module creation functions.
                                                             (line   21)
* PyModule_GetDef (C function):          Module Objects.     (line   74)
* PyModule_GetDict (C function):         Module Objects.     (line   41)
* PyModule_GetFilename (C function):     Module Objects.     (line   91)
* PyModule_GetFilenameObject (C function): Module Objects.   (line   80)
* PyModule_GetName (C function):         Module Objects.     (line   63)
* PyModule_GetNameObject (C function):   Module Objects.     (line   54)
* PyModule_GetState (C function):        Module Objects.     (line   68)
* PyModule_New (C function):             Module Objects.     (line   36)
* PyModule_NewObject (C function):       Module Objects.     (line   22)
* PyModule_SetDocString (C function):    Low-level module creation functions.
                                                             (line   44)
* PyModule_Type (C variable):            Module Objects.     (line    6)
* PyNumberMethods (C type):              Number Object Structures.
                                                             (line    6)
* PyNumberMethods.nb_absolute (C member): Number Object Structures.
                                                             (line   44)
* PyNumberMethods.nb_add (C member):     Number Object Structures.
                                                             (line   28)
* PyNumberMethods.nb_and (C member):     Number Object Structures.
                                                             (line   54)
* PyNumberMethods.nb_bool (C member):    Number Object Structures.
                                                             (line   46)
* PyNumberMethods.nb_divmod (C member):  Number Object Structures.
                                                             (line   36)
* PyNumberMethods.nb_float (C member):   Number Object Structures.
                                                             (line   64)
* PyNumberMethods.nb_floor_divide (C member): Number Object Structures.
                                                             (line   86)
* PyNumberMethods.nb_index (C member):   Number Object Structures.
                                                             (line   94)
* PyNumberMethods.nb_inplace_add (C member): Number Object Structures.
                                                             (line   66)
* PyNumberMethods.nb_inplace_and (C member): Number Object Structures.
                                                             (line   80)
* PyNumberMethods.nb_inplace_floor_divide (C member): Number Object Structures.
                                                             (line   90)
* PyNumberMethods.nb_inplace_lshift (C member): Number Object Structures.
                                                             (line   76)
* PyNumberMethods.nb_inplace_matrix_multiply (C member): Number Object Structures.
                                                             (line   98)
* PyNumberMethods.nb_inplace_multiply (C member): Number Object Structures.
                                                             (line   70)
* PyNumberMethods.nb_inplace_or (C member): Number Object Structures.
                                                             (line   84)
* PyNumberMethods.nb_inplace_power (C member): Number Object Structures.
                                                             (line   74)
* PyNumberMethods.nb_inplace_remainder (C member): Number Object Structures.
                                                             (line   72)
* PyNumberMethods.nb_inplace_rshift (C member): Number Object Structures.
                                                             (line   78)
* PyNumberMethods.nb_inplace_subtract (C member): Number Object Structures.
                                                             (line   68)
* PyNumberMethods.nb_inplace_true_divide (C member): Number Object Structures.
                                                             (line   92)
* PyNumberMethods.nb_inplace_xor (C member): Number Object Structures.
                                                             (line   82)
* PyNumberMethods.nb_int (C member):     Number Object Structures.
                                                             (line   60)
* PyNumberMethods.nb_invert (C member):  Number Object Structures.
                                                             (line   48)
* PyNumberMethods.nb_lshift (C member):  Number Object Structures.
                                                             (line   50)
* PyNumberMethods.nb_matrix_multiply (C member): Number Object Structures.
                                                             (line   96)
* PyNumberMethods.nb_multiply (C member): Number Object Structures.
                                                             (line   32)
* PyNumberMethods.nb_negative (C member): Number Object Structures.
                                                             (line   40)
* PyNumberMethods.nb_or (C member):      Number Object Structures.
                                                             (line   58)
* PyNumberMethods.nb_positive (C member): Number Object Structures.
                                                             (line   42)
* PyNumberMethods.nb_power (C member):   Number Object Structures.
                                                             (line   38)
* PyNumberMethods.nb_remainder (C member): Number Object Structures.
                                                             (line   34)
* PyNumberMethods.nb_reserved (C member): Number Object Structures.
                                                             (line   62)
* PyNumberMethods.nb_rshift (C member):  Number Object Structures.
                                                             (line   52)
* PyNumberMethods.nb_subtract (C member): Number Object Structures.
                                                             (line   30)
* PyNumberMethods.nb_true_divide (C member): Number Object Structures.
                                                             (line   88)
* PyNumberMethods.nb_xor (C member):     Number Object Structures.
                                                             (line   56)
* PyNumber_Absolute (C function):        Number Protocol.    (line   85)
* PyNumber_Add (C function):             Number Protocol.    (line   13)
* PyNumber_And (C function):             Number Protocol.    (line  106)
* PyNumber_AsSsize_t (C function):       Number Protocol.    (line  257)
* PyNumber_Check (C function):           Number Protocol.    (line    6)
* PyNumber_Divmod (C function):          Number Protocol.    (line   58)
* PyNumber_Float (C function):           Number Protocol.    (line  237)
* PyNumber_FloorDivide (C function):     Number Protocol.    (line   37)
* PyNumber_Index (C function):           Number Protocol.    (line  244)
* PyNumber_InPlaceAdd (C function):      Number Protocol.    (line  121)
* PyNumber_InPlaceAnd (C function):      Number Protocol.    (line  209)
* PyNumber_InPlaceFloorDivide (C function): Number Protocol. (line  154)
* PyNumber_InPlaceLshift (C function):   Number Protocol.    (line  193)
* PyNumber_InPlaceMatrixMultiply (C function): Number Protocol.
                                                             (line  144)
* PyNumber_InPlaceMultiply (C function): Number Protocol.    (line  136)
* PyNumber_InPlaceOr (C function):       Number Protocol.    (line  223)
* PyNumber_InPlacePower (C function):    Number Protocol.    (line  181)
* PyNumber_InPlaceRemainder (C function): Number Protocol.   (line  173)
* PyNumber_InPlaceRshift (C function):   Number Protocol.    (line  201)
* PyNumber_InPlaceSubtract (C function): Number Protocol.    (line  128)
* PyNumber_InPlaceTrueDivide (C function): Number Protocol.  (line  162)
* PyNumber_InPlaceXor (C function):      Number Protocol.    (line  216)
* PyNumber_Invert (C function):          Number Protocol.    (line   91)
* PyNumber_Long (C function):            Number Protocol.    (line  230)
* PyNumber_Lshift (C function):          Number Protocol.    (line   96)
* PyNumber_MatrixMultiply (C function):  Number Protocol.    (line   28)
* PyNumber_Multiply (C function):        Number Protocol.    (line   23)
* PyNumber_Negative (C function):        Number Protocol.    (line   76)
* PyNumber_Or (C function):              Number Protocol.    (line  116)
* PyNumber_Positive (C function):        Number Protocol.    (line   81)
* PyNumber_Power (C function):           Number Protocol.    (line   65)
* PyNumber_Remainder (C function):       Number Protocol.    (line   52)
* PyNumber_Rshift (C function):          Number Protocol.    (line  101)
* PyNumber_Subtract (C function):        Number Protocol.    (line   18)
* PyNumber_ToBase (C function):          Number Protocol.    (line  249)
* PyNumber_TrueDivide (C function):      Number Protocol.    (line   43)
* PyNumber_Xor (C function):             Number Protocol.    (line  111)
* PyObject (C type):                     Common Object Structures.
                                                             (line   17)
* PyObject.ob_refcnt (C member):         PyObject Slots.     (line   30)
* PyObject.ob_type (C member):           PyObject Slots.     (line   43)
* PyObject._ob_next (C member):          PyObject Slots.     (line   13)
* PyObject._ob_prev (C member):          PyObject Slots.     (line   13)
* PyObjectArenaAllocator (C type):       Customize pymalloc Arena Allocator.
                                                             (line    8)
* PyObject_AsCharBuffer (C function):    Old Buffer Protocol.
                                                             (line   21)
* PyObject_ASCII (C function):           Object Protocol.    (line  175)
* PyObject_AsFileDescriptor (C function): File Objects.      (line   32)
* PyObject_AsReadBuffer (C function):    Old Buffer Protocol.
                                                             (line   31)
* PyObject_AsWriteBuffer (C function):   Old Buffer Protocol.
                                                             (line   50)
* PyObject_Bytes (C function):           Object Protocol.    (line  196)
* PyObject_Call (C function):            Object Protocol.    (line  253)
* PyObject_CallFunction (C function):    Object Protocol.    (line  280)
* PyObject_CallFunctionObjArgs (C function): Object Protocol.
                                                             (line  322)
* PyObject_CallMethod (C function):      Object Protocol.    (line  299)
* PyObject_CallMethodObjArgs (C function): Object Protocol.  (line  335)
* PyObject_CallObject (C function):      Object Protocol.    (line  268)
* PyObject_CallObject():                 Calling Python Functions from C.
                                                             (line   43)
* PyObject_Calloc (C function):          Object allocators.  (line   25)
* PyObject_CheckBuffer (C function):     Buffer-related functions.
                                                             (line    6)
* PyObject_CheckReadBuffer (C function): Old Buffer Protocol.
                                                             (line   40)
* PyObject_Del (C function):             Allocating Objects on the Heap.
                                                             (line   51)
* PyObject_DelAttr (C function):         Object Protocol.    (line  110)
* PyObject_DelAttrString (C function):   Object Protocol.    (line  116)
* PyObject_DelItem (C function):         Object Protocol.    (line  499)
* PyObject_Dir (C function):             Object Protocol.    (line  505)
* PyObject_Free (C function):            Object allocators.  (line   54)
* PyObject_GC_Del (C function):          Supporting Cyclic Garbage Collection.
                                                             (line   71)
* PyObject_GC_New (C function):          Supporting Cyclic Garbage Collection.
                                                             (line   34)
* PyObject_GC_NewVar (C function):       Supporting Cyclic Garbage Collection.
                                                             (line   39)
* PyObject_GC_Resize (C function):       Supporting Cyclic Garbage Collection.
                                                             (line   46)
* PyObject_GC_Track (C function):        Supporting Cyclic Garbage Collection.
                                                             (line   54)
* PyObject_GC_UnTrack (C function):      Supporting Cyclic Garbage Collection.
                                                             (line   76)
* PyObject_GenericGetAttr (C function):  Object Protocol.    (line   63)
* PyObject_GenericGetDict (C function):  Object Protocol.    (line  123)
* PyObject_GenericSetAttr (C function):  Object Protocol.    (line   98)
* PyObject_GenericSetDict (C function):  Object Protocol.    (line  131)
* PyObject_GetArenaAllocator (C function): Customize pymalloc Arena Allocator.
                                                             (line   26)
* PyObject_GetAttr (C function):         Object Protocol.    (line   48)
* PyObject_GetAttrString (C function):   Object Protocol.    (line   55)
* PyObject_GetBuffer (C function):       Buffer-related functions.
                                                             (line   13)
* PyObject_GetItem (C function):         Object Protocol.    (line  486)
* PyObject_GetIter (C function):         Object Protocol.    (line  514)
* PyObject_HasAttr (C function):         Object Protocol.    (line   25)
* PyObject_HasAttrString (C function):   Object Protocol.    (line   36)
* PyObject_Hash (C function):            Object Protocol.    (line  422)
* PyObject_HashNotImplemented (C function): Object Protocol. (line  431)
* PyObject_HEAD (C macro):               Common Object Structures.
                                                             (line   37)
* PyObject_HEAD_INIT (C macro):          Common Object Structures.
                                                             (line   78)
* PyObject_Init (C function):            Allocating Objects on the Heap.
                                                             (line   14)
* PyObject_InitVar (C function):         Allocating Objects on the Heap.
                                                             (line   23)
* PyObject_IsInstance (C function):      Object Protocol.    (line  226)
* PyObject_IsSubclass (C function):      Object Protocol.    (line  205)
* PyObject_IsTrue (C function):          Object Protocol.    (line  438)
* PyObject_Length (C function):          Object Protocol.    (line  467)
* PyObject_LengthHint (C function):      Object Protocol.    (line  475)
* PyObject_Malloc (C function):          Object allocators.  (line   16)
* PyObject_New (C function):             Allocating Objects on the Heap.
                                                             (line   30)
* PyObject_NewVar (C function):          Allocating Objects on the Heap.
                                                             (line   38)
* PyObject_Not (C function):             Object Protocol.    (line  444)
* PyObject_Print (C function):           Object Protocol.    (line   17)
* PyObject_Realloc (C function):         Object allocators.  (line   37)
* PyObject_Repr (C function):            Object Protocol.    (line  163)
* PyObject_RichCompare (C function):     Object Protocol.    (line  138)
* PyObject_RichCompareBool (C function): Object Protocol.    (line  148)
* PyObject_SetArenaAllocator (C function): Customize pymalloc Arena Allocator.
                                                             (line   31)
* PyObject_SetAttr (C function):         Object Protocol.    (line   75)
* PyObject_SetAttrString (C function):   Object Protocol.    (line   87)
* PyObject_SetItem (C function):         Object Protocol.    (line  491)
* PyObject_Size (C function):            Object Protocol.    (line  467)
* PyObject_Str (C function):             Object Protocol.    (line  185)
* PyObject_Type (C function):            Object Protocol.    (line  450)
* PyObject_TypeCheck (C function):       Object Protocol.    (line  462)
* PyObject_VAR_HEAD (C macro):           Common Object Structures.
                                                             (line   47)
* PyOS_AfterFork (C function):           Operating System Utilities.
                                                             (line   75)
* PyOS_AfterFork_Child (C function):     Operating System Utilities.
                                                             (line   53)
* PyOS_AfterFork_Parent (C function):    Operating System Utilities.
                                                             (line   39)
* PyOS_BeforeFork (C function):          Operating System Utilities.
                                                             (line   26)
* PyOS_CheckStack (C function):          Operating System Utilities.
                                                             (line   85)
* PyOS_double_to_string (C function):    String conversion and formatting.
                                                             (line   87)
* PyOS_FSPath (C function):              Operating System Utilities.
                                                             (line    6)
* PyOS_getsig (C function):              Operating System Utilities.
                                                             (line   93)
* PyOS_InputHook (C variable):           The Very High Level Layer.
                                                             (line  164)
* PyOS_ReadlineFunctionPointer (C variable): The Very High Level Layer.
                                                             (line  174)
* PyOS_setsig (C function):              Operating System Utilities.
                                                             (line  100)
* PyOS_snprintf (C function):            String conversion and formatting.
                                                             (line    8)
* PyOS_stricmp (C function):             String conversion and formatting.
                                                             (line  122)
* PyOS_string_to_double (C function):    String conversion and formatting.
                                                             (line   54)
* PyOS_strnicmp (C function):            String conversion and formatting.
                                                             (line  127)
* PyOS_vsnprintf (C function):           String conversion and formatting.
                                                             (line   15)
* PyParser_SimpleParseFile (C function): The Very High Level Layer.
                                                             (line  220)
* PyParser_SimpleParseFileFlags (C function): The Very High Level Layer.
                                                             (line  228)
* PyParser_SimpleParseString (C function): The Very High Level Layer.
                                                             (line  195)
* PyParser_SimpleParseStringFlags (C function): The Very High Level Layer.
                                                             (line  202)
* PyParser_SimpleParseStringFlagsFilename (C function): The Very High Level Layer.
                                                             (line  210)
* PyPI; (see Python Package Index (PyPI)): Installing the tools.
                                                             (line   25)
* PyPreConfig (C type):                  PyPreConfig.        (line    6)
* PyPreConfig.allocator (C member):      PyPreConfig.        (line   32)
* PyPreConfig.coerce_c_locale (C member): PyPreConfig.       (line   68)
* PyPreConfig.coerce_c_locale_warn (C member): PyPreConfig.  (line   73)
* PyPreConfig.configure_locale (C member): PyPreConfig.      (line   62)
* PyPreConfig.dev_mode (C member):       PyPreConfig.        (line   77)
* PyPreConfig.isolated (C member):       PyPreConfig.        (line   81)
* PyPreConfig.legacy_windows_fs_encoding (C member): PyPreConfig.
                                                             (line   85)
* PyPreConfig.parse_argv (C member):     PyPreConfig.        (line   94)
* PyPreConfig.use_environment (C member): PyPreConfig.       (line  101)
* PyPreConfig.utf8_mode (C member):      PyPreConfig.        (line  105)
* PyPreConfig_InitIsolatedConfig (C function): PyPreConfig.  (line   18)
* PyPreConfig_InitPythonConfig (C function): PyPreConfig.    (line   24)
* PyProperty_Type (C variable):          Descriptor Objects. (line    9)
* PyRun_AnyFile (C function):            The Very High Level Layer.
                                                             (line   48)
* PyRun_AnyFileEx (C function):          The Very High Level Layer.
                                                             (line   61)
* PyRun_AnyFileExFlags (C function):     The Very High Level Layer.
                                                             (line   68)
* PyRun_AnyFileFlags (C function):       The Very High Level Layer.
                                                             (line   54)
* PyRun_File (C function):               The Very High Level Layer.
                                                             (line  254)
* PyRun_FileEx (C function):             The Very High Level Layer.
                                                             (line  261)
* PyRun_FileExFlags (C function):        The Very High Level Layer.
                                                             (line  275)
* PyRun_FileFlags (C function):          The Very High Level Layer.
                                                             (line  268)
* PyRun_InteractiveLoop (C function):    The Very High Level Layer.
                                                             (line  148)
* PyRun_InteractiveLoopFlags (C function): The Very High Level Layer.
                                                             (line  155)
* PyRun_InteractiveOne (C function):     The Very High Level Layer.
                                                             (line  126)
* PyRun_InteractiveOneFlags (C function): The Very High Level Layer.
                                                             (line  133)
* PyRun_SimpleFile (C function):         The Very High Level Layer.
                                                             (line  100)
* PyRun_SimpleFileEx (C function):       The Very High Level Layer.
                                                             (line  105)
* PyRun_SimpleFileExFlags (C function):  The Very High Level Layer.
                                                             (line  112)
* PyRun_SimpleString (C function):       The Very High Level Layer.
                                                             (line   79)
* PyRun_SimpleStringFlags (C function):  The Very High Level Layer.
                                                             (line   85)
* PyRun_String (C function):             The Very High Level Layer.
                                                             (line  235)
* PyRun_StringFlags (C function):        The Very High Level Layer.
                                                             (line  242)
* PySeqIter_Check (C function):          Iterator Objects.   (line   18)
* PySeqIter_New (C function):            Iterator Objects.   (line   22)
* PySeqIter_Type (C variable):           Iterator Objects.   (line   12)
* PySequenceMethods (C type):            Sequence Object Structures.
                                                             (line    6)
* PySequenceMethods.sq_ass_item (C member): Sequence Object Structures.
                                                             (line   45)
* PySequenceMethods.sq_concat (C member): Sequence Object Structures.
                                                             (line   18)
* PySequenceMethods.sq_contains (C member): Sequence Object Structures.
                                                             (line   54)
* PySequenceMethods.sq_inplace_concat (C member): Sequence Object Structures.
                                                             (line   61)
* PySequenceMethods.sq_inplace_repeat (C member): Sequence Object Structures.
                                                             (line   71)
* PySequenceMethods.sq_item (C member):  Sequence Object Structures.
                                                             (line   31)
* PySequenceMethods.sq_length (C member): Sequence Object Structures.
                                                             (line   11)
* PySequenceMethods.sq_repeat (C member): Sequence Object Structures.
                                                             (line   24)
* PySequence_Check (C function):         Sequence Protocol.  (line    6)
* PySequence_Concat (C function):        Sequence Protocol.  (line   20)
* PySequence_Contains (C function):      Sequence Protocol.  (line   99)
* PySequence_Count (C function):         Sequence Protocol.  (line   91)
* PySequence_DelItem (C function):       Sequence Protocol.  (line   70)
* PySequence_DelSlice (C function):      Sequence Protocol.  (line   83)
* PySequence_Fast (C function):          Sequence Protocol.  (line  127)
* PySequence_Fast_GET_ITEM (C function): Sequence Protocol.  (line  149)
* PySequence_Fast_GET_SIZE (C function): Sequence Protocol.  (line  141)
* PySequence_Fast_ITEMS (C function):    Sequence Protocol.  (line  156)
* PySequence_GetItem (C function):       Sequence Protocol.  (line   47)
* PySequence_GetItem():                  Reference Count Details.
                                                             (line   90)
* PySequence_GetSlice (C function):      Sequence Protocol.  (line   52)
* PySequence_Index (C function):         Sequence Protocol.  (line  105)
* PySequence_InPlaceConcat (C function): Sequence Protocol.  (line   31)
* PySequence_InPlaceRepeat (C function): Sequence Protocol.  (line   39)
* PySequence_ITEM (C function):          Sequence Protocol.  (line  166)
* PySequence_Length (C function):        Sequence Protocol.  (line   14)
* PySequence_List (C function):          Sequence Protocol.  (line  112)
* PySequence_Repeat (C function):        Sequence Protocol.  (line   25)
* PySequence_SetItem (C function):       Sequence Protocol.  (line   58)
* PySequence_SetSlice (C function):      Sequence Protocol.  (line   75)
* PySequence_Size (C function):          Sequence Protocol.  (line   14)
* PySequence_Tuple (C function):         Sequence Protocol.  (line  118)
* PySetObject (C type):                  Set Objects.        (line   19)
* PySet_Add (C function):                Set Objects.        (line  108)
* PySet_Check (C function):              Set Objects.        (line   45)
* PySet_Clear (C function):              Set Objects.        (line  140)
* PySet_ClearFreeList (C function):      Set Objects.        (line  144)
* PySet_Contains (C function):           Set Objects.        (line   99)
* PySet_Discard (C function):            Set Objects.        (line  123)
* PySet_GET_SIZE (C function):           Set Objects.        (line   95)
* PySet_New (C function):                Set Objects.        (line   70)
* PySet_Pop (C function):                Set Objects.        (line  133)
* PySet_Size (C function):               Set Objects.        (line   88)
* PySet_Type (C variable):               Set Objects.        (line   31)
* PySignal_SetWakeupFd (C function):     Signal Handling<2>. (line   28)
* PySlice_AdjustIndices (C function):    Slice Objects.      (line   96)
* PySlice_Check (C function):            Slice Objects.      (line   11)
* PySlice_GetIndices (C function):       Slice Objects.      (line   25)
* PySlice_GetIndicesEx (C function):     Slice Objects.      (line   44)
* PySlice_New (C function):              Slice Objects.      (line   15)
* PySlice_Type (C variable):             Slice Objects.      (line    6)
* PySlice_Unpack (C function):           Slice Objects.      (line   82)
* PyState_AddModule (C function):        Module lookup.      (line   23)
* PyState_FindModule (C function):       Module lookup.      (line   15)
* PyState_RemoveModule (C function):     Module lookup.      (line   45)
* PyStatus (C type):                     PyStatus.           (line    6)
* PyStatus.err_msg (C member):           PyStatus.           (line   20)
* PyStatus.exitcode (C member):          PyStatus.           (line   16)
* PyStatus.func (C member):              PyStatus.           (line   24)
* PyStatus_Error (C function):           PyStatus.           (line   34)
* PyStatus_Exception (C function):       PyStatus.           (line   48)
* PyStatus_Exit (C function):            PyStatus.           (line   42)
* PyStatus_IsError (C function):         PyStatus.           (line   54)
* PyStatus_IsExit (C function):          PyStatus.           (line   58)
* PyStatus_NoMemory (C function):        PyStatus.           (line   38)
* PyStatus_Ok (C function):              PyStatus.           (line   30)
* PyStructSequence_Desc (C type):        Struct Sequence Objects.
                                                             (line   34)
* PyStructSequence_Field (C type):       Struct Sequence Objects.
                                                             (line   57)
* PyStructSequence_GetItem (C function): Struct Sequence Objects.
                                                             (line   86)
* PyStructSequence_GET_ITEM (C function): Struct Sequence Objects.
                                                             (line   93)
* PyStructSequence_InitType (C function): Struct Sequence Objects.
                                                             (line   19)
* PyStructSequence_InitType2 (C function): Struct Sequence Objects.
                                                             (line   25)
* PyStructSequence_New (C function):     Struct Sequence Objects.
                                                             (line   81)
* PyStructSequence_NewType (C function): Struct Sequence Objects.
                                                             (line   11)
* PyStructSequence_SetItem (C function): Struct Sequence Objects.
                                                             (line   99)
* PyStructSequence_SET_ITEM (C function): Struct Sequence Objects.
                                                             (line  108)
* PyStructSequence_UnnamedField (C variable): Struct Sequence Objects.
                                                             (line   77)
* PySys_AddAuditHook (C function):       System Functions.   (line  129)
* PySys_AddWarnOption (C function):      System Functions.   (line   27)
* PySys_AddWarnOptionUnicode (C function): System Functions. (line   33)
* PySys_AddXOption (C function):         System Functions.   (line   87)
* PySys_Audit (C function):              System Functions.   (line  103)
* PySys_FormatStderr (C function):       System Functions.   (line   80)
* PySys_FormatStdout (C function):       System Functions.   (line   72)
* PySys_GetObject (C function):          System Functions.   (line   11)
* PySys_GetXOptions (C function):        System Functions.   (line   96)
* PySys_ResetWarnOptions (C function):   System Functions.   (line   22)
* PySys_SetArgv (C function):            Process-wide parameters.
                                                             (line  255)
* PySys_SetArgv():                       Initializing and finalizing the interpreter.
                                                             (line    8)
* PySys_SetArgvEx (C function):          Process-wide parameters.
                                                             (line  214)
* PySys_SetArgvEx():                     Embedding Python<2>.
                                                             (line   17)
* PySys_SetArgvEx() <1>:                 Initializing and finalizing the interpreter.
                                                             (line    8)
* PySys_SetObject (C function):          System Functions.   (line   16)
* PySys_SetPath (C function):            System Functions.   (line   43)
* PySys_WriteStderr (C function):        System Functions.   (line   67)
* PySys_WriteStdout (C function):        System Functions.   (line   49)
* Python 3000:                           Glossary.           (line 1042)
* Python Editor:                         IDLE<41>.           (line    8)
* Python Enhancement Proposals; PEP 1:   New Development Process.
                                                             (line   67)
* Python Enhancement Proposals; PEP 1 <1>: New Development Process.
                                                             (line   82)
* Python Enhancement Proposals; PEP 1 <2>: Glossary.         (line 1008)
* Python Enhancement Proposals; PEP 100: Unicode<2>.         (line   15)
* Python Enhancement Proposals; PEP 11:  PEP 538 Legacy C Locale Coercion.
                                                             (line   19)
* Python Enhancement Proposals; PEP 11 <1>: Unsupported Operating Systems.
                                                             (line    6)
* Python Enhancement Proposals; PEP 11 <2>: Library Changes. (line   15)
* Python Enhancement Proposals; PEP 11 <3>: Build<18>.       (line   14)
* Python Enhancement Proposals; PEP 11 <4>: Using Python on Windows.
                                                             (line   18)
* Python Enhancement Proposals; PEP 11 <5>: Other Platforms. (line    8)
* Python Enhancement Proposals; PEP 201: New Development Process.
                                                             (line   86)
* Python Enhancement Proposals; PEP 205: PEP 205 Weak References.
                                                             (line   82)
* Python Enhancement Proposals; PEP 205 <1>: weakref — Weak references.
                                                             (line  331)
* Python Enhancement Proposals; PEP 207: PEP 207 Rich Comparisons.
                                                             (line   71)
* Python Enhancement Proposals; PEP 207 <1>: PEP 207 Rich Comparisons.
                                                             (line   77)
* Python Enhancement Proposals; PEP 208: PEP 208 New Coercion Model.
                                                             (line   30)
* Python Enhancement Proposals; PEP 217: PEP 217 Interactive Display Hook.
                                                             (line   27)
* Python Enhancement Proposals; PEP 218: PEP 218 Built-In Set Objects.
                                                             (line   50)
* Python Enhancement Proposals; PEP 218 <1>: Other Language Changes<12>.
                                                             (line   12)
* Python Enhancement Proposals; PEP 218 <2>: PEP 218 A Standard Set Datatype.
                                                             (line   80)
* Python Enhancement Proposals; PEP 227: PEP 227 Nested Scopes.
                                                             (line   96)
* Python Enhancement Proposals; PEP 227 <1>: PEP 227 Nested Scopes<2>.
                                                             (line   96)
* Python Enhancement Proposals; PEP 227 <2>: __future__ — Future statement definitions.
                                                             (line   65)
* Python Enhancement Proposals; PEP 229: PEP 229 New Build System.
                                                             (line   39)
* Python Enhancement Proposals; PEP 230: PEP 230 Warning Framework.
                                                             (line   73)
* Python Enhancement Proposals; PEP 232: PEP 232 Function Attributes.
                                                             (line   36)
* Python Enhancement Proposals; PEP 234: PEP 234 Iterators.  (line  124)
* Python Enhancement Proposals; PEP 235: Introduction<12>.   (line   37)
* Python Enhancement Proposals; PEP 236: PEP 227 Nested Scopes<2>.
                                                             (line   87)
* Python Enhancement Proposals; PEP 236 <1>: PEP 227 Nested Scopes<2>.
                                                             (line   88)
* Python Enhancement Proposals; PEP 236 <2>: PEP 236 __future__ Directives.
                                                             (line   29)
* Python Enhancement Proposals; PEP 236 <3>: Future statements.
                                                             (line   85)
* Python Enhancement Proposals; PEP 237: Integers.           (line    6)
* Python Enhancement Proposals; PEP 237 <1>: PEP 237 Unifying Long Integers and Integers.
                                                             (line   22)
* Python Enhancement Proposals; PEP 237 <2>: Other Language Changes<12>.
                                                             (line   18)
* Python Enhancement Proposals; PEP 237 <3>: PEP 237 Unifying Long Integers and Integers<2>.
                                                             (line   37)
* Python Enhancement Proposals; PEP 237 <4>: printf-style String Formatting.
                                                             (line  182)
* Python Enhancement Proposals; PEP 237 <5>: printf-style Bytes Formatting.
                                                             (line  189)
* Python Enhancement Proposals; PEP 238: Integers.           (line   10)
* Python Enhancement Proposals; PEP 238 <1>: PEP 238 Changing the Division Operator.
                                                             (line   21)
* Python Enhancement Proposals; PEP 238 <2>: PEP 238 Changing the Division Operator.
                                                             (line   27)
* Python Enhancement Proposals; PEP 238 <3>: PEP 238 Changing the Division Operator.
                                                             (line   68)
* Python Enhancement Proposals; PEP 238 <4>: __future__ — Future statement definitions.
                                                             (line   71)
* Python Enhancement Proposals; PEP 238 <5>: The Very High Level Layer.
                                                             (line  424)
* Python Enhancement Proposals; PEP 238 <6>: Glossary.       (line  437)
* Python Enhancement Proposals; PEP 241: PEP 241 Metadata in Python Packages.
                                                             (line   15)
* Python Enhancement Proposals; PEP 241 <1>: PEP 241 Metadata in Python Packages.
                                                             (line   28)
* Python Enhancement Proposals; PEP 241 <2>: PEP 241 Metadata in Python Packages.
                                                             (line   35)
* Python Enhancement Proposals; PEP 243: PEP 241 Metadata in Python Packages.
                                                             (line   39)
* Python Enhancement Proposals; PEP 247: hmac<2>.            (line   20)
* Python Enhancement Proposals; PEP 249: The sqlite3 package.
                                                             (line   18)
* Python Enhancement Proposals; PEP 249 <1>: The sqlite3 package.
                                                             (line  110)
* Python Enhancement Proposals; PEP 249 <2>: sqlite3 — DB-API 2 0 interface for SQLite databases.
                                                             (line   18)
* Python Enhancement Proposals; PEP 249 <3>: sqlite3 — DB-API 2 0 interface for SQLite databases.
                                                             (line  118)
* Python Enhancement Proposals; PEP 252: Related Links.      (line   17)
* Python Enhancement Proposals; PEP 252 <1>: Related Links.  (line   17)
* Python Enhancement Proposals; PEP 252 <2>: Implementing Descriptors.
                                                             (line   24)
* Python Enhancement Proposals; PEP 253: Old and New Classes.
                                                             (line   28)
* Python Enhancement Proposals; PEP 253 <1>: Multiple Inheritance The Diamond Rule.
                                                             (line    8)
* Python Enhancement Proposals; PEP 253 <2>: Related Links.  (line   17)
* Python Enhancement Proposals; PEP 253 <3>: Related Links.  (line   19)
* Python Enhancement Proposals; PEP 253 <4>: Related Links.  (line   21)
* Python Enhancement Proposals; PEP 255: PEP 255 Simple Generators.
                                                             (line   45)
* Python Enhancement Proposals; PEP 255 <1>: PEP 255 Simple Generators.
                                                             (line  131)
* Python Enhancement Proposals; PEP 255 <2>: PEP 255 Simple Generators<2>.
                                                             (line   43)
* Python Enhancement Proposals; PEP 255 <3>: PEP 255 Simple Generators<2>.
                                                             (line  129)
* Python Enhancement Proposals; PEP 255 <4>: Yield expressions.
                                                             (line   88)
* Python Enhancement Proposals; PEP 255 <5>: __future__ — Future statement definitions.
                                                             (line   68)
* Python Enhancement Proposals; PEP 261: Unicode Changes.    (line   18)
* Python Enhancement Proposals; PEP 261 <1>: Unicode Changes.
                                                             (line   61)
* Python Enhancement Proposals; PEP 263: Other Language Changes<11>.
                                                             (line   98)
* Python Enhancement Proposals; PEP 263 <1>: PEP 263 Source Code Encodings.
                                                             (line   29)
* Python Enhancement Proposals; PEP 263 <2>: Introduction<12>.
                                                             (line   41)
* Python Enhancement Proposals; PEP 263 <3>: Tokenizing Input.
                                                             (line   35)
* Python Enhancement Proposals; PEP 263 <4>: Tokenizing Input.
                                                             (line   89)
* Python Enhancement Proposals; PEP 263 <5>: Unicode Literals in Python Source Code.
                                                             (line   39)
* Python Enhancement Proposals; PEP 264: Other Changes and Fixes<3>.
                                                             (line   55)
* Python Enhancement Proposals; PEP 273: PEP 273 Importing Modules from ZIP Archives.
                                                             (line   41)
* Python Enhancement Proposals; PEP 273 <1>: PEP 273 Importing Modules from ZIP Archives.
                                                             (line   44)
* Python Enhancement Proposals; PEP 273 <2>: zipimport — Import modules from Zip archives.
                                                             (line   42)
* Python Enhancement Proposals; PEP 273 <3>: zipimport — Import modules from Zip archives.
                                                             (line   45)
* Python Enhancement Proposals; PEP 274: New Syntax.         (line   38)
* Python Enhancement Proposals; PEP 275: Why isn’t there a switch or case statement in Python?.
                                                             (line    8)
* Python Enhancement Proposals; PEP 277: PEP 277 Unicode file name support for Windows NT.
                                                             (line   32)
* Python Enhancement Proposals; PEP 278: PEP 278 Universal Newline Support.
                                                             (line   33)
* Python Enhancement Proposals; PEP 278 <1>: Glossary.       (line 1223)
* Python Enhancement Proposals; PEP 279: PEP 279 enumerate.  (line   27)
* Python Enhancement Proposals; PEP 282: PEP 282 The logging Package.
                                                             (line  101)
* Python Enhancement Proposals; PEP 282 <1>: PEP 282 The logging Package.
                                                             (line  107)
* Python Enhancement Proposals; PEP 282 <2>: Archiving operations.
                                                             (line   42)
* Python Enhancement Proposals; PEP 282 <3>: Integration with the warnings module.
                                                             (line   36)
* Python Enhancement Proposals; PEP 282 <4>: distutils log — Simple PEP 282-style logging.
                                                             (line    6)
* Python Enhancement Proposals; PEP 285: PEP 285 A Boolean Type.
                                                             (line   47)
* Python Enhancement Proposals; PEP 285 <1>: PEP 285 A Boolean Type.
                                                             (line   70)
* Python Enhancement Proposals; PEP 288: PEP 342 New Generator Features.
                                                             (line  146)
* Python Enhancement Proposals; PEP 289: PEP 289 Generator Expressions.
                                                             (line   56)
* Python Enhancement Proposals; PEP 289 <1>: Other Language Changes<12>.
                                                             (line   15)
* Python Enhancement Proposals; PEP 289 <2>: Python documentation.
                                                             (line   12)
* Python Enhancement Proposals; PEP 292: PEP 292 Simpler String Substitutions.
                                                             (line   45)
* Python Enhancement Proposals; PEP 292 <1>: Template strings.
                                                             (line    6)
* Python Enhancement Proposals; PEP 293: PEP 293 Codec Error Handling Callbacks.
                                                             (line   33)
* Python Enhancement Proposals; PEP 3000: Python 3 0.        (line   43)
* Python Enhancement Proposals; PEP 301: PEP 301 Package Index and Metadata for Distutils.
                                                             (line   45)
* Python Enhancement Proposals; PEP 301 <1>: distutils command register — Register a module with the Python Package Index.
                                                             (line    7)
* Python Enhancement Proposals; PEP 302: Using importlib as the Implementation of Import.
                                                             (line   13)
* Python Enhancement Proposals; PEP 302 <1>: Visible Changes.
                                                             (line   18)
* Python Enhancement Proposals; PEP 302 <2>: Porting Python code.
                                                             (line   71)
* Python Enhancement Proposals; PEP 302 <3>: New Improved and Deprecated Modules<2>.
                                                             (line  106)
* Python Enhancement Proposals; PEP 302 <4>: New Improved and Removed Modules.
                                                             (line  289)
* Python Enhancement Proposals; PEP 302 <5>: PEP 273 Importing Modules from ZIP Archives.
                                                             (line   46)
* Python Enhancement Proposals; PEP 302 <6>: PEP 302 New Import Hooks.
                                                             (line   13)
* Python Enhancement Proposals; PEP 302 <7>: PEP 302 New Import Hooks.
                                                             (line   38)
* Python Enhancement Proposals; PEP 302 <8>: PEP 302 New Import Hooks.
                                                             (line   62)
* Python Enhancement Proposals; PEP 302 <9>: The import system.
                                                             (line   42)
* Python Enhancement Proposals; PEP 302 <10>: References.    (line   10)
* Python Enhancement Proposals; PEP 302 <11>: Built-in Functions.
                                                             (line 1768)
* Python Enhancement Proposals; PEP 302 <12>: linecache — Random access to text lines.
                                                             (line   31)
* Python Enhancement Proposals; PEP 302 <13>: sys — System-specific parameters and functions.
                                                             (line 1047)
* Python Enhancement Proposals; PEP 302 <14>: sys — System-specific parameters and functions.
                                                             (line 1057)
* Python Enhancement Proposals; PEP 302 <15>: zipimport — Import modules from Zip archives.
                                                             (line   47)
* Python Enhancement Proposals; PEP 302 <16>: zipimport — Import modules from Zip archives.
                                                             (line   49)
* Python Enhancement Proposals; PEP 302 <17>: pkgutil — Package extension utility.
                                                             (line   54)
* Python Enhancement Proposals; PEP 302 <18>: pkgutil — Package extension utility.
                                                             (line   56)
* Python Enhancement Proposals; PEP 302 <19>: pkgutil — Package extension utility.
                                                             (line   57)
* Python Enhancement Proposals; PEP 302 <20>: pkgutil — Package extension utility.
                                                             (line   65)
* Python Enhancement Proposals; PEP 302 <21>: pkgutil — Package extension utility.
                                                             (line   73)
* Python Enhancement Proposals; PEP 302 <22>: pkgutil — Package extension utility.
                                                             (line   86)
* Python Enhancement Proposals; PEP 302 <23>: pkgutil — Package extension utility.
                                                             (line  102)
* Python Enhancement Proposals; PEP 302 <24>: pkgutil — Package extension utility.
                                                             (line  117)
* Python Enhancement Proposals; PEP 302 <25>: pkgutil — Package extension utility.
                                                             (line  137)
* Python Enhancement Proposals; PEP 302 <26>: pkgutil — Package extension utility.
                                                             (line  158)
* Python Enhancement Proposals; PEP 302 <27>: pkgutil — Package extension utility.
                                                             (line  193)
* Python Enhancement Proposals; PEP 302 <28>: runpy — Locating and executing Python modules.
                                                             (line   32)
* Python Enhancement Proposals; PEP 302 <29>: Introduction<12>.
                                                             (line   45)
* Python Enhancement Proposals; PEP 302 <30>: importlib abc – Abstract base classes related to import.
                                                             (line   29)
* Python Enhancement Proposals; PEP 302 <31>: importlib abc – Abstract base classes related to import.
                                                             (line  151)
* Python Enhancement Proposals; PEP 302 <32>: importlib abc – Abstract base classes related to import.
                                                             (line  351)
* Python Enhancement Proposals; PEP 302 <33>: importlib abc – Abstract base classes related to import.
                                                             (line  375)
* Python Enhancement Proposals; PEP 302 <34>: importlib abc – Abstract base classes related to import.
                                                             (line  446)
* Python Enhancement Proposals; PEP 302 <35>: imp — Access the import internals.
                                                             (line  344)
* Python Enhancement Proposals; PEP 302 <36>: Glossary.      (line  429)
* Python Enhancement Proposals; PEP 302 <37>: Glossary.      (line  752)
* Python Enhancement Proposals; PEP 305: PEP 305 Comma-separated Files.
                                                             (line   42)
* Python Enhancement Proposals; PEP 305 <1>: csv — CSV File Reading and Writing.
                                                             (line   38)
* Python Enhancement Proposals; PEP 307: PEP 307 Pickle Enhancements.
                                                             (line    8)
* Python Enhancement Proposals; PEP 307 <1>: PEP 307 Pickle Enhancements.
                                                             (line   30)
* Python Enhancement Proposals; PEP 307 <2>: PEP 307 Pickle Enhancements.
                                                             (line   42)
* Python Enhancement Proposals; PEP 307 <3>: Data stream format.
                                                             (line   32)
* Python Enhancement Proposals; PEP 308: PEP 308 Conditional Expressions.
                                                             (line   72)
* Python Enhancement Proposals; PEP 308 <1>: PEP 308 Conditional Expressions.
                                                             (line   78)
* Python Enhancement Proposals; PEP 308 <2>: Conditional expressions.
                                                             (line   17)
* Python Enhancement Proposals; PEP 309: PEP 309 Partial Function Application.
                                                             (line   73)
* Python Enhancement Proposals; PEP 3100: Python 3 0.        (line   44)
* Python Enhancement Proposals; PEP 3101: PEP 3101 A New Approach To String Formatting.
                                                             (line    3)
* Python Enhancement Proposals; PEP 3101 <1>: PEP 3101 A New Approach To String Formatting.
                                                             (line    8)
* Python Enhancement Proposals; PEP 3101 <2>: PEP 3101 Advanced String Formatting.
                                                             (line  162)
* Python Enhancement Proposals; PEP 3101 <3>: Custom String Formatting.
                                                             (line    8)
* Python Enhancement Proposals; PEP 3101 <4>: Custom String Formatting.
                                                             (line   60)
* Python Enhancement Proposals; PEP 3102: New Syntax.        (line   13)
* Python Enhancement Proposals; PEP 3104: New Syntax.        (line   24)
* Python Enhancement Proposals; PEP 3104 <1>: The nonlocal statement.
                                                             (line   26)
* Python Enhancement Proposals; PEP 3105: Print Is A Function.
                                                             (line    8)
* Python Enhancement Proposals; PEP 3105 <1>: PEP 3105 print As a Function.
                                                             (line   35)
* Python Enhancement Proposals; PEP 3105 <2>: __future__ — Future statement definitions.
                                                             (line   81)
* Python Enhancement Proposals; PEP 3106: PEP 3106 Dictionary Views.
                                                             (line   58)
* Python Enhancement Proposals; PEP 3107: PEP 563 Postponed Evaluation of Annotations.
                                                             (line    7)
* Python Enhancement Proposals; PEP 3107 <1>: PEP 484 - Type Hints.
                                                             (line    7)
* Python Enhancement Proposals; PEP 3107 <2>: New Syntax.    (line    6)
* Python Enhancement Proposals; PEP 3107 <3>: Function Annotations.
                                                             (line    7)
* Python Enhancement Proposals; PEP 3107 <4>: Function definitions.
                                                             (line  123)
* Python Enhancement Proposals; PEP 3108: Library Changes.   (line    7)
* Python Enhancement Proposals; PEP 3108 <1>: Library Changes.
                                                             (line   17)
* Python Enhancement Proposals; PEP 3108 <2>: Library Changes.
                                                             (line   95)
* Python Enhancement Proposals; PEP 3109: Changed Syntax.    (line    6)
* Python Enhancement Proposals; PEP 3109 <1>: Changes To Exceptions.
                                                             (line   29)
* Python Enhancement Proposals; PEP 3110: Changed Syntax.    (line   16)
* Python Enhancement Proposals; PEP 3110 <1>: Changes To Exceptions.
                                                             (line   35)
* Python Enhancement Proposals; PEP 3110 <2>: PEP 3110 Exception-Handling Changes.
                                                             (line   48)
* Python Enhancement Proposals; PEP 3111: Builtins.          (line   12)
* Python Enhancement Proposals; PEP 3112: PEP 3112 Byte Literals.
                                                             (line   75)
* Python Enhancement Proposals; PEP 3112 <1>: __future__ — Future statement definitions.
                                                             (line   84)
* Python Enhancement Proposals; PEP 3113: Removed Syntax.    (line    6)
* Python Enhancement Proposals; PEP 3114: Operators And Special Methods.
                                                             (line   19)
* Python Enhancement Proposals; PEP 3115: types<4>.          (line   10)
* Python Enhancement Proposals; PEP 3115 <1>: Changed Syntax.
                                                             (line   18)
* Python Enhancement Proposals; PEP 3115 <2>: Preparing the class namespace.
                                                             (line   18)
* Python Enhancement Proposals; PEP 3115 <3>: Class definitions.
                                                             (line   71)
* Python Enhancement Proposals; PEP 3115 <4>: Dynamic Type Creation.
                                                             (line   54)
* Python Enhancement Proposals; PEP 3116: Optimizations<7>.  (line    8)
* Python Enhancement Proposals; PEP 3116 <1>: PEP 3116 New I/O Library.
                                                             (line   69)
* Python Enhancement Proposals; PEP 3116 <2>: Glossary.      (line 1223)
* Python Enhancement Proposals; PEP 3118: Pickle protocol 5 with out-of-band data buffers.
                                                             (line   13)
* Python Enhancement Proposals; PEP 3118 <1>: PEP 3118 New memoryview implementation and buffer protocol documentation.
                                                             (line    6)
* Python Enhancement Proposals; PEP 3118 <2>: API changes.   (line   29)
* Python Enhancement Proposals; PEP 3118 <3>: Build and C API Changes<4>.
                                                             (line    8)
* Python Enhancement Proposals; PEP 3118 <4>: Build and C API Changes<7>.
                                                             (line   12)
* Python Enhancement Proposals; PEP 3118 <5>: PEP 3118 Revised Buffer Protocol.
                                                             (line   46)
* Python Enhancement Proposals; PEP 3118 <6>: Library<23>.   (line   99)
* Python Enhancement Proposals; PEP 3118 <7>: Library<28>.   (line   61)
* Python Enhancement Proposals; PEP 3118 <8>: Library<71>.   (line  956)
* Python Enhancement Proposals; PEP 3118 <9>: Memory Views.  (line  110)
* Python Enhancement Proposals; PEP 3119: PEP 3119 Abstract Base Classes.
                                                             (line  139)
* Python Enhancement Proposals; PEP 3119 <1>: Customizing instance and subclass checks.
                                                             (line   35)
* Python Enhancement Proposals; PEP 3119 <2>: Collections Abstract Base Classes.
                                                             (line  309)
* Python Enhancement Proposals; PEP 3119 <3>: abc — Abstract Base Classes.
                                                             (line   11)
* Python Enhancement Proposals; PEP 3119 <4>: Object Protocol.
                                                             (line  217)
* Python Enhancement Proposals; PEP 3119 <5>: Object Protocol.
                                                             (line  237)
* Python Enhancement Proposals; PEP 3120: Text Vs Data Instead Of Unicode Vs 8-bit.
                                                             (line  107)
* Python Enhancement Proposals; PEP 3120 <1>: Lexical analysis.
                                                             (line   12)
* Python Enhancement Proposals; PEP 3120 <2>: Introduction<12>.
                                                             (line   77)
* Python Enhancement Proposals; PEP 3121: Build and C API Changes<7>.
                                                             (line   14)
* Python Enhancement Proposals; PEP 3121 <1>: Initializing C modules.
                                                             (line   55)
* Python Enhancement Proposals; PEP 3123: Build and C API Changes<7>.
                                                             (line   16)
* Python Enhancement Proposals; PEP 3127: PEP 3127 Integer Literal Support and Syntax.
                                                             (line   47)
* Python Enhancement Proposals; PEP 3129: PEP 3129 Class Decorators.
                                                             (line   24)
* Python Enhancement Proposals; PEP 3129 <1>: Class definitions.
                                                             (line   77)
* Python Enhancement Proposals; PEP 3131: Text Vs Data Instead Of Unicode Vs 8-bit.
                                                             (line  109)
* Python Enhancement Proposals; PEP 3131 <1>: Identifiers and keywords.
                                                             (line   10)
* Python Enhancement Proposals; PEP 3131 <2>: Identifiers and keywords.
                                                             (line   19)
* Python Enhancement Proposals; PEP 3132: New Syntax.        (line   28)
* Python Enhancement Proposals; PEP 3132 <1>: Assignment statements.
                                                             (line  159)
* Python Enhancement Proposals; PEP 3134: Changed Syntax.    (line    6)
* Python Enhancement Proposals; PEP 3134 <1>: Changes To Exceptions.
                                                             (line   40)
* Python Enhancement Proposals; PEP 3134 <2>: Changes To Exceptions.
                                                             (line   60)
* Python Enhancement Proposals; PEP 3135: Builtins.          (line    6)
* Python Enhancement Proposals; PEP 3135 <1>: Creating the class object.
                                                             (line   54)
* Python Enhancement Proposals; PEP 3137: PEP 3137 The memoryview Object.
                                                             (line   49)
* Python Enhancement Proposals; PEP 3138: Text Vs Data Instead Of Unicode Vs 8-bit.
                                                             (line  103)
* Python Enhancement Proposals; PEP 314: PEP 314 Metadata for Python Software Packages v1 1.
                                                             (line   42)
* Python Enhancement Proposals; PEP 314 <1>: distutils core — Core Distutils functionality.
                                                             (line  103)
* Python Enhancement Proposals; PEP 3141: PEP 3141 A Type Hierarchy for Numbers.
                                                             (line   43)
* Python Enhancement Proposals; PEP 3141 <1>: numbers — Numeric abstract base classes.
                                                             (line   10)
* Python Enhancement Proposals; PEP 3141 <2>: abc — Abstract Base Classes.
                                                             (line   12)
* Python Enhancement Proposals; PEP 3144: ipaddress<4>.      (line   10)
* Python Enhancement Proposals; PEP 3147: PEP 421 Adding sys implementation.
                                                             (line   21)
* Python Enhancement Proposals; PEP 3147 <1>: PEP 3147 PYC Repository Directories.
                                                             (line   69)
* Python Enhancement Proposals; PEP 3147 <2>: “Compiled” Python files.
                                                             (line   47)
* Python Enhancement Proposals; PEP 3147 <3>: Import-related module attributes.
                                                             (line   79)
* Python Enhancement Proposals; PEP 3147 <4>: test support — Utilities for the Python test suite.
                                                             (line  192)
* Python Enhancement Proposals; PEP 3147 <5>: runpy — Locating and executing Python modules.
                                                             (line   87)
* Python Enhancement Proposals; PEP 3147 <6>: Introduction<12>.
                                                             (line   81)
* Python Enhancement Proposals; PEP 3147 <7>: importlib util – Utility code for importers.
                                                             (line   24)
* Python Enhancement Proposals; PEP 3147 <8>: importlib util – Utility code for importers.
                                                             (line   60)
* Python Enhancement Proposals; PEP 3147 <9>: importlib util – Utility code for importers.
                                                             (line   64)
* Python Enhancement Proposals; PEP 3147 <10>: py_compile — Compile Python source files.
                                                             (line   30)
* Python Enhancement Proposals; PEP 3147 <11>: py_compile — Compile Python source files.
                                                             (line   69)
* Python Enhancement Proposals; PEP 3147 <12>: Command-line use.
                                                             (line   56)
* Python Enhancement Proposals; PEP 3147 <13>: Public functions.
                                                             (line   36)
* Python Enhancement Proposals; PEP 3147 <14>: Public functions.
                                                             (line  101)
* Python Enhancement Proposals; PEP 3147 <15>: imp — Access the import internals.
                                                             (line  197)
* Python Enhancement Proposals; PEP 3147 <16>: imp — Access the import internals.
                                                             (line  204)
* Python Enhancement Proposals; PEP 3147 <17>: imp — Access the import internals.
                                                             (line  227)
* Python Enhancement Proposals; PEP 3147 <18>: imp — Access the import internals.
                                                             (line  231)
* Python Enhancement Proposals; PEP 3147 <19>: imp — Access the import internals.
                                                             (line  243)
* Python Enhancement Proposals; PEP 3147 <20>: Importing Modules<2>.
                                                             (line  199)
* Python Enhancement Proposals; PEP 3147 <21>: How do I create a pyc file?.
                                                             (line   12)
* Python Enhancement Proposals; PEP 3147 <22>: distutils util — Miscellaneous other utility functions.
                                                             (line  132)
* Python Enhancement Proposals; PEP 3148: PEP 3148 The concurrent futures module.
                                                             (line   51)
* Python Enhancement Proposals; PEP 3148 <1>: Module Functions.
                                                             (line   61)
* Python Enhancement Proposals; PEP 3149: PEP 3149 ABI Version Tagged so Files.
                                                             (line   33)
* Python Enhancement Proposals; PEP 3149 <1>: Core and Builtins<54>.
                                                             (line    9)
* Python Enhancement Proposals; PEP 3149 <2>: sys — System-specific parameters and functions.
                                                             (line   15)
* Python Enhancement Proposals; PEP 3151: PEP 3151 Reworking the OS and IO exception hierarchy.
                                                             (line   84)
* Python Enhancement Proposals; PEP 3151 <1>: OS exceptions. (line  114)
* Python Enhancement Proposals; PEP 3151 <2>: Exceptions<11>.
                                                             (line   10)
* Python Enhancement Proposals; PEP 3151 <3>: select — Waiting for I/O completion.
                                                             (line   28)
* Python Enhancement Proposals; PEP 3151 <4>: resource — Resource usage information.
                                                             (line   21)
* Python Enhancement Proposals; PEP 3151 <5>: Standard Exceptions.
                                                             (line  181)
* Python Enhancement Proposals; PEP 3154: Summary – Release Highlights<2>.
                                                             (line   57)
* Python Enhancement Proposals; PEP 3154 <1>: pickle<4>.     (line   16)
* Python Enhancement Proposals; PEP 3154 <2>: Library<12>.   (line 1283)
* Python Enhancement Proposals; PEP 3154 <3>: Data stream format.
                                                             (line   42)
* Python Enhancement Proposals; PEP 3155: PEP 3155 Qualified name for classes and functions.
                                                             (line   62)
* Python Enhancement Proposals; PEP 3155 <1>: Glossary.      (line 1069)
* Python Enhancement Proposals; PEP 3156: Summary – Release Highlights<2>.
                                                             (line   31)
* Python Enhancement Proposals; PEP 3156 <1>: Summary – Release Highlights<2>.
                                                             (line   44)
* Python Enhancement Proposals; PEP 3156 <2>: asyncio<6>.    (line    6)
* Python Enhancement Proposals; PEP 3156 <3>: asyncio<6>.    (line   17)
* Python Enhancement Proposals; PEP 3156 <4>: selectors<2>.  (line    6)
* Python Enhancement Proposals; PEP 318: PEP 318 Decorators for Functions and Methods.
                                                             (line  101)
* Python Enhancement Proposals; PEP 318 <1>: PEP 318 Decorators for Functions and Methods.
                                                             (line  125)
* Python Enhancement Proposals; PEP 318 <2>: Other Language Changes<12>.
                                                             (line    9)
* Python Enhancement Proposals; PEP 318 <3>: Class definitions.
                                                             (line   80)
* Python Enhancement Proposals; PEP 322: PEP 322 Reverse Iteration.
                                                             (line   35)
* Python Enhancement Proposals; PEP 322 <1>: Other Language Changes<12>.
                                                             (line   13)
* Python Enhancement Proposals; PEP 324: PEP 324 New subprocess Module.
                                                             (line   86)
* Python Enhancement Proposals; PEP 324 <1>: subprocess — Subprocess management.
                                                             (line   24)
* Python Enhancement Proposals; PEP 325: PEP 342 New Generator Features.
                                                             (line  147)
* Python Enhancement Proposals; PEP 327: The Context type.   (line   56)
* Python Enhancement Proposals; PEP 328: Porting Python code.
                                                             (line   36)
* Python Enhancement Proposals; PEP 328 <1>: Removed Syntax. (line   29)
* Python Enhancement Proposals; PEP 328 <2>: PEP 328 Absolute and Relative Imports.
                                                             (line    6)
* Python Enhancement Proposals; PEP 328 <3>: PEP 328 Absolute and Relative Imports.
                                                             (line   82)
* Python Enhancement Proposals; PEP 328 <4>: PEP 328 Multi-line Imports.
                                                             (line   35)
* Python Enhancement Proposals; PEP 328 <5>: Other Language Changes<12>.
                                                             (line   21)
* Python Enhancement Proposals; PEP 328 <6>: References.     (line   20)
* Python Enhancement Proposals; PEP 328 <7>: Built-in Functions.
                                                             (line 1786)
* Python Enhancement Proposals; PEP 328 <8>: __future__ — Future statement definitions.
                                                             (line   74)
* Python Enhancement Proposals; PEP 328 <9>: Introduction<12>.
                                                             (line   49)
* Python Enhancement Proposals; PEP 331: PEP 331 Locale-Independent Float/String Conversions.
                                                             (line   38)
* Python Enhancement Proposals; PEP 333: The wsgiref package.
                                                             (line    8)
* Python Enhancement Proposals; PEP 333 <1>: The wsgiref package.
                                                             (line   31)
* Python Enhancement Proposals; PEP 3333: PEP 3333 Python Web Server Gateway Interface v1 0 1.
                                                             (line   50)
* Python Enhancement Proposals; PEP 3333 <1>: wsgiref — WSGI Utilities and Reference Implementation.
                                                             (line   24)
* Python Enhancement Proposals; PEP 3333 <2>: wsgiref util – WSGI environment utilities.
                                                             (line    8)
* Python Enhancement Proposals; PEP 3333 <3>: wsgiref util – WSGI environment utilities.
                                                             (line   10)
* Python Enhancement Proposals; PEP 3333 <4>: wsgiref util – WSGI environment utilities.
                                                             (line   28)
* Python Enhancement Proposals; PEP 3333 <5>: wsgiref util – WSGI environment utilities.
                                                             (line   74)
* Python Enhancement Proposals; PEP 3333 <6>: wsgiref headers – WSGI response header tools.
                                                             (line   12)
* Python Enhancement Proposals; PEP 3333 <7>: wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   21)
* Python Enhancement Proposals; PEP 3333 <8>: wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   87)
* Python Enhancement Proposals; PEP 3333 <9>: wsgiref validate — WSGI conformance checker.
                                                             (line   13)
* Python Enhancement Proposals; PEP 3333 <10>: wsgiref validate — WSGI conformance checker.
                                                             (line   40)
* Python Enhancement Proposals; PEP 3333 <11>: wsgiref handlers – server/gateway base classes.
                                                             (line  233)
* Python Enhancement Proposals; PEP 3333 <12>: wsgiref handlers – server/gateway base classes.
                                                             (line  249)
* Python Enhancement Proposals; PEP 3333 <13>: wsgiref handlers – server/gateway base classes.
                                                             (line  256)
* Python Enhancement Proposals; PEP 3333 <14>: wsgiref handlers – server/gateway base classes.
                                                             (line  265)
* Python Enhancement Proposals; PEP 3333 <15>: wsgiref handlers – server/gateway base classes.
                                                             (line  307)
* Python Enhancement Proposals; PEP 338: PEP 338 Executing Modules as Scripts.
                                                             (line   21)
* Python Enhancement Proposals; PEP 338 <1>: Interface options.
                                                             (line  100)
* Python Enhancement Proposals; PEP 338 <2>: References.     (line   24)
* Python Enhancement Proposals; PEP 338 <3>: runpy — Locating and executing Python modules.
                                                             (line  171)
* Python Enhancement Proposals; PEP 339: Build and C API Changes<10>.
                                                             (line   45)
* Python Enhancement Proposals; PEP 341: PEP 341 Unified try/except/finally.
                                                             (line   44)
* Python Enhancement Proposals; PEP 342: PEP 342 New Generator Features.
                                                             (line   42)
* Python Enhancement Proposals; PEP 342 <1>: PEP 342 New Generator Features.
                                                             (line  140)
* Python Enhancement Proposals; PEP 342 <2>: Porting to Python 2 5.
                                                             (line   15)
* Python Enhancement Proposals; PEP 342 <3>: Yield expressions.
                                                             (line   93)
* Python Enhancement Proposals; PEP 342 <4>: Collections Abstract Base Classes.
                                                             (line  145)
* Python Enhancement Proposals; PEP 342 <5>: Passing values into a generator.
                                                             (line   25)
* Python Enhancement Proposals; PEP 342 <6>: Python documentation.
                                                             (line   14)
* Python Enhancement Proposals; PEP 343: The contextlib module.
                                                             (line   64)
* Python Enhancement Proposals; PEP 343 <1>: PEP 342 New Generator Features.
                                                             (line  129)
* Python Enhancement Proposals; PEP 343 <2>: The contextlib module<2>.
                                                             (line   64)
* Python Enhancement Proposals; PEP 343 <3>: With Statement Context Managers.
                                                             (line   45)
* Python Enhancement Proposals; PEP 343 <4>: The with statement.
                                                             (line   71)
* Python Enhancement Proposals; PEP 343 <5>: Using a context manager as a function decorator.
                                                             (line   33)
* Python Enhancement Proposals; PEP 343 <6>: __future__ — Future statement definitions.
                                                             (line   78)
* Python Enhancement Proposals; PEP 343 <7>: Glossary.       (line  252)
* Python Enhancement Proposals; PEP 347: Build and C API Changes<10>.
                                                             (line   10)
* Python Enhancement Proposals; PEP 352: Changes To Exceptions.
                                                             (line    9)
* Python Enhancement Proposals; PEP 352 <1>: Deprecations and Removals.
                                                             (line    9)
* Python Enhancement Proposals; PEP 352 <2>: PEP 352 Exceptions as New-Style Classes.
                                                             (line   57)
* Python Enhancement Proposals; PEP 353: PEP 353 Using ssize_t as the index type.
                                                             (line   48)
* Python Enhancement Proposals; PEP 353 <1>: PEP 353 Using ssize_t as the index type.
                                                             (line   54)
* Python Enhancement Proposals; PEP 353 <2>: Build and C API Changes<10>.
                                                             (line   20)
* Python Enhancement Proposals; PEP 356: What’s New in Python 2 5.
                                                             (line   10)
* Python Enhancement Proposals; PEP 357: PEP 357 The ‘__index__’ method.
                                                             (line   39)
* Python Enhancement Proposals; PEP 361: What’s New in Python 2 6.
                                                             (line   10)
* Python Enhancement Proposals; PEP 362: PEP 362 Function Signature Object.
                                                             (line   19)
* Python Enhancement Proposals; PEP 362 <1>: Introspecting callables with the Signature object.
                                                             (line  287)
* Python Enhancement Proposals; PEP 362 <2>: Glossary.       (line   92)
* Python Enhancement Proposals; PEP 362 <3>: Glossary.       (line  955)
* Python Enhancement Proposals; PEP 366: Visible Changes.    (line   24)
* Python Enhancement Proposals; PEP 366 <1>: Import-related module attributes.
                                                             (line   30)
* Python Enhancement Proposals; PEP 366 <2>: Import-related module attributes.
                                                             (line   34)
* Python Enhancement Proposals; PEP 366 <3>: References.     (line   17)
* Python Enhancement Proposals; PEP 366 <4>: References.     (line   21)
* Python Enhancement Proposals; PEP 366 <5>: runpy — Locating and executing Python modules.
                                                             (line  175)
* Python Enhancement Proposals; PEP 366 <6>: Introduction<12>.
                                                             (line   53)
* Python Enhancement Proposals; PEP 370: PEP 370 Per-user site-packages Directory.
                                                             (line   36)
* Python Enhancement Proposals; PEP 370 <1>: Miscellaneous options.
                                                             (line  125)
* Python Enhancement Proposals; PEP 370 <2>: Environment variables.
                                                             (line  168)
* Python Enhancement Proposals; PEP 370 <3>: Environment variables.
                                                             (line  180)
* Python Enhancement Proposals; PEP 370 <4>: Module contents<3>.
                                                             (line  109)
* Python Enhancement Proposals; PEP 371: PEP 371 The multiprocessing Package.
                                                             (line  145)
* Python Enhancement Proposals; PEP 372: PEP 372 Ordered Dictionaries.
                                                             (line   31)
* Python Enhancement Proposals; PEP 372 <1>: PEP 372 Adding an Ordered Dictionary to collections.
                                                             (line   97)
* Python Enhancement Proposals; PEP 373: The Future for Python 2 x.
                                                             (line   23)
* Python Enhancement Proposals; PEP 378: PEP 378 Format Specifier for Thousands Separator.
                                                             (line   32)
* Python Enhancement Proposals; PEP 378 <1>: PEP 378 Format Specifier for Thousands Separator<2>.
                                                             (line   37)
* Python Enhancement Proposals; PEP 378 <2>: Format Specification Mini-Language.
                                                             (line  103)
* Python Enhancement Proposals; PEP 380: PEP 380 Syntax for Delegating to a Subgenerator.
                                                             (line   66)
* Python Enhancement Proposals; PEP 380 <1>: Yield expressions.
                                                             (line   98)
* Python Enhancement Proposals; PEP 383: Error Handlers.     (line   58)
* Python Enhancement Proposals; PEP 383 <1>: Socket families.
                                                             (line   15)
* Python Enhancement Proposals; PEP 383 <2>: Locale Encoding.
                                                             (line   14)
* Python Enhancement Proposals; PEP 383 <3>: Locale Encoding.
                                                             (line   50)
* Python Enhancement Proposals; PEP 383 <4>: File System Encoding.
                                                             (line    9)
* Python Enhancement Proposals; PEP 384: PEP 384 Defining a Stable ABI.
                                                             (line   24)
* Python Enhancement Proposals; PEP 384 <1>: Stable Application Binary Interface.
                                                             (line   36)
* Python Enhancement Proposals; PEP 385: Code Repository.    (line   13)
* Python Enhancement Proposals; PEP 389: PEP 389 Argparse Command Line Parsing Module.
                                                             (line   92)
* Python Enhancement Proposals; PEP 389 <1>: PEP 389 The argparse Module for Parsing Command Lines.
                                                             (line  100)
* Python Enhancement Proposals; PEP 391: PEP 391 Dictionary Based Configuration for Logging.
                                                             (line   52)
* Python Enhancement Proposals; PEP 391 <1>: PEP 391 Dictionary-Based Configuration For Logging.
                                                             (line   94)
* Python Enhancement Proposals; PEP 392: What’s New In Python 3 2.
                                                             (line   16)
* Python Enhancement Proposals; PEP 393: PEP 393 Flexible String Representation.
                                                             (line   16)
* Python Enhancement Proposals; PEP 393 <1>: Functionality.  (line    6)
* Python Enhancement Proposals; PEP 393 <2>: Performance and resource usage.
                                                             (line   29)
* Python Enhancement Proposals; PEP 393 <3>: Optimizations<5>.
                                                             (line    8)
* Python Enhancement Proposals; PEP 393 <4>: Build and C API Changes<4>.
                                                             (line   12)
* Python Enhancement Proposals; PEP 393 <5>: Deprecated Python modules functions and methods<4>.
                                                             (line   10)
* Python Enhancement Proposals; PEP 393 <6>: Deprecated functions and types of the C API<3>.
                                                             (line    6)
* Python Enhancement Proposals; PEP 393 <7>: Porting C code. (line   17)
* Python Enhancement Proposals; PEP 393 <8>: Encodings and Unicode.
                                                             (line    7)
* Python Enhancement Proposals; PEP 393 <9>: sys — System-specific parameters and functions.
                                                             (line  972)
* Python Enhancement Proposals; PEP 393 <10>: Unicode Objects.
                                                             (line    6)
* Python Enhancement Proposals; PEP 393 <11>: Deprecated Py_UNICODE APIs.
                                                             (line    8)
* Python Enhancement Proposals; PEP 395: Open issues.        (line   18)
* Python Enhancement Proposals; PEP 397: PEP 486 Make the Python Launcher aware of virtual environments.
                                                             (line    6)
* Python Enhancement Proposals; PEP 397 <1>: PEP 397 Python Launcher for Windows.
                                                             (line   31)
* Python Enhancement Proposals; PEP 397 <2>: Python Launcher for Windows.
                                                             (line   18)
* Python Enhancement Proposals; PEP 397 <3>: Creating virtual environments.
                                                             (line  154)
* Python Enhancement Proposals; PEP 398: What’s New In Python 3 3.
                                                             (line   13)
* Python Enhancement Proposals; PEP 4:   Library Changes.    (line   13)
* Python Enhancement Proposals; PEP 405: PEP 405 Virtual Environments.
                                                             (line   22)
* Python Enhancement Proposals; PEP 405 <1>: venv — Creation of virtual environments.
                                                             (line   19)
* Python Enhancement Proposals; PEP 409: PEP 409 Suppressing exception context.
                                                             (line   63)
* Python Enhancement Proposals; PEP 411: sys — System-specific parameters and functions.
                                                             (line  775)
* Python Enhancement Proposals; PEP 411 <1>: sys — System-specific parameters and functions.
                                                             (line  785)
* Python Enhancement Proposals; PEP 411 <2>: sys — System-specific parameters and functions.
                                                             (line 1378)
* Python Enhancement Proposals; PEP 411 <3>: sys — System-specific parameters and functions.
                                                             (line 1398)
* Python Enhancement Proposals; PEP 411 <4>: Glossary.       (line 1038)
* Python Enhancement Proposals; PEP 412: PEP 412 Key-Sharing Dictionary.
                                                             (line   15)
* Python Enhancement Proposals; PEP 414: PEP 414 Explicit Unicode literals.
                                                             (line   17)
* Python Enhancement Proposals; PEP 414 <1>: String and Bytes literals.
                                                             (line   60)
* Python Enhancement Proposals; PEP 418: time<5>.            (line    6)
* Python Enhancement Proposals; PEP 420: PEP 420 Implicit Namespace Packages.
                                                             (line    9)
* Python Enhancement Proposals; PEP 420 <1>: PEP 420 Implicit Namespace Packages.
                                                             (line   14)
* Python Enhancement Proposals; PEP 420 <2>: Core and Builtins<39>.
                                                             (line   56)
* Python Enhancement Proposals; PEP 420 <3>: Core and Builtins<44>.
                                                             (line  114)
* Python Enhancement Proposals; PEP 420 <4>: The import system.
                                                             (line   45)
* Python Enhancement Proposals; PEP 420 <5>: Namespace packages.
                                                             (line   27)
* Python Enhancement Proposals; PEP 420 <6>: module __path__.
                                                             (line   21)
* Python Enhancement Proposals; PEP 420 <7>: module __path__.
                                                             (line   21)
* Python Enhancement Proposals; PEP 420 <8>: References.     (line   11)
* Python Enhancement Proposals; PEP 420 <9>: References.     (line   13)
* Python Enhancement Proposals; PEP 420 <10>: References.    (line   13)
* Python Enhancement Proposals; PEP 420 <11>: Introduction<12>.
                                                             (line   57)
* Python Enhancement Proposals; PEP 420 <12>: Glossary.      (line  429)
* Python Enhancement Proposals; PEP 420 <13>: Glossary.      (line  868)
* Python Enhancement Proposals; PEP 420 <14>: Glossary.      (line 1013)
* Python Enhancement Proposals; PEP 421: SimpleNamespace.    (line   16)
* Python Enhancement Proposals; PEP 421 <1>: sys — System-specific parameters and functions.
                                                             (line  882)
* Python Enhancement Proposals; PEP 421 <2>: sys — System-specific parameters and functions.
                                                             (line  887)
* Python Enhancement Proposals; PEP 424: Other Language Changes<5>.
                                                             (line   57)
* Python Enhancement Proposals; PEP 424 <1>: operator<2>.    (line    8)
* Python Enhancement Proposals; PEP 427: Key terms.          (line   36)
* Python Enhancement Proposals; PEP 428: Summary – Release Highlights<2>.
                                                             (line   39)
* Python Enhancement Proposals; PEP 428 <1>: pathlib<5>.     (line   17)
* Python Enhancement Proposals; PEP 428 <2>: pathlib — Object-oriented filesystem paths.
                                                             (line   39)
* Python Enhancement Proposals; PEP 429: What’s New In Python 3 4.
                                                             (line   16)
* Python Enhancement Proposals; PEP 432: Other CPython implementation changes.
                                                             (line    7)
* Python Enhancement Proposals; PEP 432 <1>: Core and Builtins<22>.
                                                             (line  313)
* Python Enhancement Proposals; PEP 432 <2>: Multi-Phase Initialization Private Provisional API.
                                                             (line    7)
* Python Enhancement Proposals; PEP 432 <3>: Multi-Phase Initialization Private Provisional API.
                                                             (line   57)
* Python Enhancement Proposals; PEP 434: PEP 434 IDLE Enhancement Exception for All Branches.
                                                             (line    6)
* Python Enhancement Proposals; PEP 435: Summary – Release Highlights<2>.
                                                             (line   36)
* Python Enhancement Proposals; PEP 435 <1>: enum<5>.        (line    6)
* Python Enhancement Proposals; PEP 435 <2>: enum<5>.        (line   15)
* Python Enhancement Proposals; PEP 436: Summary – Release Highlights<2>.
                                                             (line  120)
* Python Enhancement Proposals; PEP 436 <1>: PEP 436 Argument Clinic.
                                                             (line    6)
* Python Enhancement Proposals; PEP 436 <2>: PEP 436 Argument Clinic.
                                                             (line   28)
* Python Enhancement Proposals; PEP 441: zipapp<2>.          (line    6)
* Python Enhancement Proposals; PEP 441 <1>: zipapp<2>.      (line   24)
* Python Enhancement Proposals; PEP 442: Summary – Release Highlights<2>.
                                                             (line  113)
* Python Enhancement Proposals; PEP 442 <1>: Summary – Release Highlights<2>.
                                                             (line  115)
* Python Enhancement Proposals; PEP 442 <2>: PEP 442 Safe Object Finalization.
                                                             (line    6)
* Python Enhancement Proposals; PEP 442 <3>: PEP 442 Safe Object Finalization.
                                                             (line   21)
* Python Enhancement Proposals; PEP 442 <4>: gc — Garbage Collector interface.
                                                             (line  203)
* Python Enhancement Proposals; PEP 442 <5>: Finalization and De-allocation.
                                                             (line   48)
* Python Enhancement Proposals; PEP 442 <6>: PyTypeObject Slots.
                                                             (line 1342)
* Python Enhancement Proposals; PEP 443: Summary – Release Highlights<2>.
                                                             (line   55)
* Python Enhancement Proposals; PEP 443 <1>: functools<4>.   (line   22)
* Python Enhancement Proposals; PEP 443 <2>: Glossary.       (line  521)
* Python Enhancement Proposals; PEP 445: Summary – Release Highlights<2>.
                                                             (line  118)
* Python Enhancement Proposals; PEP 445 <1>: PEP 445 Customization of CPython Memory Allocators.
                                                             (line    6)
* Python Enhancement Proposals; PEP 445 <2>: PEP 445 Customization of CPython Memory Allocators.
                                                             (line   12)
* Python Enhancement Proposals; PEP 445 <3>: Other Improvements<2>.
                                                             (line   63)
* Python Enhancement Proposals; PEP 446: Summary – Release Highlights<2>.
                                                             (line   14)
* Python Enhancement Proposals; PEP 446 <1>: Summary – Release Highlights<2>.
                                                             (line   78)
* Python Enhancement Proposals; PEP 446 <2>: PEP 446 Newly Created File Descriptors Are Non-Inheritable.
                                                             (line    6)
* Python Enhancement Proposals; PEP 446 <3>: PEP 446 Newly Created File Descriptors Are Non-Inheritable.
                                                             (line   26)
* Python Enhancement Proposals; PEP 448: PEP 448 - Additional Unpacking Generalizations.
                                                             (line    6)
* Python Enhancement Proposals; PEP 448 <1>: PEP 448 - Additional Unpacking Generalizations.
                                                             (line   39)
* Python Enhancement Proposals; PEP 448 <2>: Documentation<32>.
                                                             (line   10)
* Python Enhancement Proposals; PEP 448 <3>: Documentation<36>.
                                                             (line    9)
* Python Enhancement Proposals; PEP 448 <4>: Core and Builtins<47>.
                                                             (line   12)
* Python Enhancement Proposals; PEP 448 <5>: Core and Builtins<50>.
                                                             (line    9)
* Python Enhancement Proposals; PEP 448 <6>: Dictionary displays.
                                                             (line   29)
* Python Enhancement Proposals; PEP 448 <7>: Calls.          (line  112)
* Python Enhancement Proposals; PEP 448 <8>: Expression lists.
                                                             (line   22)
* Python Enhancement Proposals; PEP 450: Summary – Release Highlights<2>.
                                                             (line   47)
* Python Enhancement Proposals; PEP 450 <1>: statistics<3>.  (line    6)
* Python Enhancement Proposals; PEP 450 <2>: statistics<3>.  (line   14)
* Python Enhancement Proposals; PEP 451: PEP 489 Multi-phase extension module initialization.
                                                             (line    7)
* Python Enhancement Proposals; PEP 451 <1>: Summary – Release Highlights<2>.
                                                             (line   22)
* Python Enhancement Proposals; PEP 451 <2>: PEP 451 A ModuleSpec Type for the Import System.
                                                             (line    6)
* Python Enhancement Proposals; PEP 451 <3>: Core and Builtins<39>.
                                                             (line   76)
* Python Enhancement Proposals; PEP 451 <4>: References.     (line   26)
* Python Enhancement Proposals; PEP 451 <5>: sys — System-specific parameters and functions.
                                                             (line 1002)
* Python Enhancement Proposals; PEP 451 <6>: pkgutil — Package extension utility.
                                                             (line   89)
* Python Enhancement Proposals; PEP 451 <7>: pkgutil — Package extension utility.
                                                             (line  120)
* Python Enhancement Proposals; PEP 451 <8>: runpy — Locating and executing Python modules.
                                                             (line   91)
* Python Enhancement Proposals; PEP 451 <9>: runpy — Locating and executing Python modules.
                                                             (line  164)
* Python Enhancement Proposals; PEP 451 <10>: runpy — Locating and executing Python modules.
                                                             (line  179)
* Python Enhancement Proposals; PEP 451 <11>: Introduction<12>.
                                                             (line   61)
* Python Enhancement Proposals; PEP 451 <12>: Multi-phase initialization.
                                                             (line   72)
* Python Enhancement Proposals; PEP 451 <13>: Glossary.      (line  429)
* Python Enhancement Proposals; PEP 453: Summary – Release Highlights<2>.
                                                             (line   12)
* Python Enhancement Proposals; PEP 453 <1>: Summary – Release Highlights<2>.
                                                             (line   34)
* Python Enhancement Proposals; PEP 453 <2>: Bootstrapping pip By Default.
                                                             (line    6)
* Python Enhancement Proposals; PEP 453 <3>: Documentation Changes.
                                                             (line   21)
* Python Enhancement Proposals; PEP 453 <4>: ensurepip.      (line    7)
* Python Enhancement Proposals; PEP 453 <5>: venv<4>.        (line   13)
* Python Enhancement Proposals; PEP 453 <6>: Other Improvements<2>.
                                                             (line   73)
* Python Enhancement Proposals; PEP 453 <7>: PEP 477 Backport ensurepip PEP 453 to Python 2 7.
                                                             (line    6)
* Python Enhancement Proposals; PEP 453 <8>: Bootstrapping pip By Default<2>.
                                                             (line    6)
* Python Enhancement Proposals; PEP 453 <9>: Documentation Changes<2>.
                                                             (line   21)
* Python Enhancement Proposals; PEP 453 <10>: ensurepip — Bootstrapping the pip installer.
                                                             (line   33)
* Python Enhancement Proposals; PEP 454: Summary – Release Highlights<2>.
                                                             (line   50)
* Python Enhancement Proposals; PEP 454 <1>: tracemalloc<3>. (line    6)
* Python Enhancement Proposals; PEP 454 <2>: tracemalloc<3>. (line   22)
* Python Enhancement Proposals; PEP 456: Summary – Release Highlights<2>.
                                                             (line   75)
* Python Enhancement Proposals; PEP 456 <1>: PEP 456 Secure and Interchangeable Hash Algorithm.
                                                             (line    6)
* Python Enhancement Proposals; PEP 461: PEP 461 - percent formatting support for bytes and bytearray.
                                                             (line    6)
* Python Enhancement Proposals; PEP 461 <1>: PEP 461 - percent formatting support for bytes and bytearray.
                                                             (line   41)
* Python Enhancement Proposals; PEP 461 <2>: printf-style Bytes Formatting.
                                                             (line  198)
* Python Enhancement Proposals; PEP 465: PEP 465 - A dedicated infix operator for matrix multiplication.
                                                             (line    6)
* Python Enhancement Proposals; PEP 465 <1>: PEP 465 - A dedicated infix operator for matrix multiplication.
                                                             (line   45)
* Python Enhancement Proposals; PEP 465 <2>: Build and C API Changes<3>.
                                                             (line   43)
* Python Enhancement Proposals; PEP 465 <3>: Tools/Demos<32>.
                                                             (line   39)
* Python Enhancement Proposals; PEP 466: PEP 466 Network Security Enhancements for Python 2 7.
                                                             (line    6)
* Python Enhancement Proposals; PEP 466 <1>: PEP 466 Network Security Enhancements for Python 2 7.
                                                             (line   11)
* Python Enhancement Proposals; PEP 466 <2>: PEP 466 Network Security Enhancements for Python 2 7.
                                                             (line   21)
* Python Enhancement Proposals; PEP 466 <3>: PEP 466 Network Security Enhancements for Python 2 7.
                                                             (line   32)
* Python Enhancement Proposals; PEP 468: PEP 468 Preserving Keyword Argument Order.
                                                             (line   12)
* Python Enhancement Proposals; PEP 468 <1>: Library<31>.    (line   87)
* Python Enhancement Proposals; PEP 468 <2>: OrderedDict objects.
                                                             (line   85)
* Python Enhancement Proposals; PEP 471: PEP 471 - os scandir function – a better and faster directory iterator.
                                                             (line    6)
* Python Enhancement Proposals; PEP 471 <1>: PEP 471 - os scandir function – a better and faster directory iterator.
                                                             (line   29)
* Python Enhancement Proposals; PEP 471 <2>: Library<70>.    (line    6)
* Python Enhancement Proposals; PEP 475: PEP 475 Retry system calls failing with EINTR.
                                                             (line   32)
* Python Enhancement Proposals; PEP 475 <1>: PEP 475 Retry system calls failing with EINTR.
                                                             (line   77)
* Python Enhancement Proposals; PEP 475 <2>: Changes in the Python API<4>.
                                                             (line    6)
* Python Enhancement Proposals; PEP 475 <3>: Library<21>.    (line  229)
* Python Enhancement Proposals; PEP 475 <4>: Library<68>.    (line  143)
* Python Enhancement Proposals; PEP 475 <5>: Built-in Functions.
                                                             (line 1246)
* Python Enhancement Proposals; PEP 475 <6>: OS exceptions.  (line   78)
* Python Enhancement Proposals; PEP 475 <7>: File Descriptor Operations.
                                                             (line  284)
* Python Enhancement Proposals; PEP 475 <8>: File Descriptor Operations.
                                                             (line  564)
* Python Enhancement Proposals; PEP 475 <9>: File Descriptor Operations.
                                                             (line  683)
* Python Enhancement Proposals; PEP 475 <10>: Process Management.
                                                             (line  776)
* Python Enhancement Proposals; PEP 475 <11>: Functions<2>.  (line  230)
* Python Enhancement Proposals; PEP 475 <12>: Socket Objects.
                                                             (line   28)
* Python Enhancement Proposals; PEP 475 <13>: Socket Objects.
                                                             (line   80)
* Python Enhancement Proposals; PEP 475 <14>: Socket Objects.
                                                             (line  234)
* Python Enhancement Proposals; PEP 475 <15>: Socket Objects.
                                                             (line  248)
* Python Enhancement Proposals; PEP 475 <16>: Socket Objects.
                                                             (line  314)
* Python Enhancement Proposals; PEP 475 <17>: Socket Objects.
                                                             (line  376)
* Python Enhancement Proposals; PEP 475 <18>: Socket Objects.
                                                             (line  395)
* Python Enhancement Proposals; PEP 475 <19>: Socket Objects.
                                                             (line  414)
* Python Enhancement Proposals; PEP 475 <20>: Socket Objects.
                                                             (line  453)
* Python Enhancement Proposals; PEP 475 <21>: select — Waiting for I/O completion.
                                                             (line  154)
* Python Enhancement Proposals; PEP 475 <22>: /dev/poll Polling Objects.
                                                             (line   82)
* Python Enhancement Proposals; PEP 475 <23>: Edge and Level Trigger Polling epoll Objects.
                                                             (line   99)
* Python Enhancement Proposals; PEP 475 <24>: Polling Objects.
                                                             (line   94)
* Python Enhancement Proposals; PEP 475 <25>: Kqueue Objects.
                                                             (line   36)
* Python Enhancement Proposals; PEP 475 <26>: Classes<3>.    (line  128)
* Python Enhancement Proposals; PEP 475 <27>: Module contents<2>.
                                                             (line  401)
* Python Enhancement Proposals; PEP 475 <28>: Module contents<2>.
                                                             (line  419)
* Python Enhancement Proposals; PEP 476: PEP 476 Enabling certificate verification by default for stdlib http clients<2>.
                                                             (line    6)
* Python Enhancement Proposals; PEP 477: PEP 477 Backport ensurepip PEP 453 to Python 2 7.
                                                             (line    6)
* Python Enhancement Proposals; PEP 478: What’s New In Python 3 5.
                                                             (line   17)
* Python Enhancement Proposals; PEP 479: Changes in Python Behavior.
                                                             (line   11)
* Python Enhancement Proposals; PEP 479 <1>: PEP 479 Change StopIteration handling inside generators.
                                                             (line   12)
* Python Enhancement Proposals; PEP 479 <2>: PEP 479 Change StopIteration handling inside generators.
                                                             (line   47)
* Python Enhancement Proposals; PEP 479 <3>: Library<12>.    (line 1271)
* Python Enhancement Proposals; PEP 479 <4>: Library<16>.    (line   52)
* Python Enhancement Proposals; PEP 479 <5>: Core and Builtins<18>.
                                                             (line   34)
* Python Enhancement Proposals; PEP 479 <6>: Library<24>.    (line   95)
* Python Enhancement Proposals; PEP 479 <7>: Library<38>.    (line   80)
* Python Enhancement Proposals; PEP 479 <8>: Library<51>.    (line  326)
* Python Enhancement Proposals; PEP 479 <9>: Concrete exceptions.
                                                             (line  234)
* Python Enhancement Proposals; PEP 479 <10>: Concrete exceptions.
                                                             (line  236)
* Python Enhancement Proposals; PEP 479 <11>: __future__ — Future statement definitions.
                                                             (line   87)
* Python Enhancement Proposals; PEP 483: PEP 484 - Type Hints.
                                                             (line   47)
* Python Enhancement Proposals; PEP 483 <1>: typing — Support for type hints.
                                                             (line   21)
* Python Enhancement Proposals; PEP 484: ast.                (line   17)
* Python Enhancement Proposals; PEP 484 <1>: ast.            (line   20)
* Python Enhancement Proposals; PEP 484 <2>: PEP 560 Core Support for typing module and Generic Types.
                                                             (line    6)
* Python Enhancement Proposals; PEP 484 <3>: PEP 526 Syntax for variable annotations.
                                                             (line    6)
* Python Enhancement Proposals; PEP 484 <4>: PEP 484 - Type Hints.
                                                             (line   16)
* Python Enhancement Proposals; PEP 484 <5>: PEP 484 - Type Hints.
                                                             (line   41)
* Python Enhancement Proposals; PEP 484 <6>: Function Annotations.
                                                             (line    8)
* Python Enhancement Proposals; PEP 484 <7>: Emulating generic types.
                                                             (line    6)
* Python Enhancement Proposals; PEP 484 <8>: Annotated assignment statements.
                                                             (line   45)
* Python Enhancement Proposals; PEP 484 <9>: Function definitions.
                                                             (line  127)
* Python Enhancement Proposals; PEP 484 <10>: typing — Support for type hints.
                                                             (line   16)
* Python Enhancement Proposals; PEP 484 <11>: typing — Support for type hints.
                                                             (line   20)
* Python Enhancement Proposals; PEP 484 <12>: NewType.       (line   44)
* Python Enhancement Proposals; PEP 484 <13>: Nominal vs structural subtyping.
                                                             (line    6)
* Python Enhancement Proposals; PEP 484 <14>: Nominal vs structural subtyping.
                                                             (line   14)
* Python Enhancement Proposals; PEP 484 <15>: Classes functions and decorators.
                                                             (line   33)
* Python Enhancement Proposals; PEP 484 <16>: Classes functions and decorators.
                                                             (line   38)
* Python Enhancement Proposals; PEP 484 <17>: Classes functions and decorators.
                                                             (line   96)
* Python Enhancement Proposals; PEP 484 <18>: Classes functions and decorators.
                                                             (line  564)
* Python Enhancement Proposals; PEP 484 <19>: ast Helpers.   (line   16)
* Python Enhancement Proposals; PEP 484 <20>: ast Helpers.   (line   26)
* Python Enhancement Proposals; PEP 484 <21>: Glossary.      (line   61)
* Python Enhancement Proposals; PEP 484 <22>: Glossary.      (line  461)
* Python Enhancement Proposals; PEP 484 <23>: Glossary.      (line 1198)
* Python Enhancement Proposals; PEP 484 <24>: Glossary.      (line 1215)
* Python Enhancement Proposals; PEP 484 <25>: Glossary.      (line 1244)
* Python Enhancement Proposals; PEP 485: PEP 485 A function for testing approximate equality.
                                                             (line    6)
* Python Enhancement Proposals; PEP 485 <1>: PEP 485 A function for testing approximate equality.
                                                             (line   36)
* Python Enhancement Proposals; PEP 485 <2>: Library<66>.    (line   10)
* Python Enhancement Proposals; PEP 485 <3>: Number-theoretic and representation functions.
                                                             (line  135)
* Python Enhancement Proposals; PEP 485 <4>: Classification functions.
                                                             (line   54)
* Python Enhancement Proposals; PEP 486: PEP 486 Make the Python Launcher aware of virtual environments.
                                                             (line    6)
* Python Enhancement Proposals; PEP 486 <1>: PEP 486 Make the Python Launcher aware of virtual environments.
                                                             (line   14)
* Python Enhancement Proposals; PEP 486 <2>: Windows<41>.    (line    6)
* Python Enhancement Proposals; PEP 487: PEP 487 Simpler customization of class creation.
                                                             (line   32)
* Python Enhancement Proposals; PEP 487 <1>: PEP 487 Descriptor Protocol Enhancements.
                                                             (line    6)
* Python Enhancement Proposals; PEP 487 <2>: PEP 487 Descriptor Protocol Enhancements.
                                                             (line   33)
* Python Enhancement Proposals; PEP 487 <3>: Changes in the Python API<3>.
                                                             (line  104)
* Python Enhancement Proposals; PEP 487 <4>: Documentation<22>.
                                                             (line   52)
* Python Enhancement Proposals; PEP 487 <5>: Documentation<29>.
                                                             (line    8)
* Python Enhancement Proposals; PEP 487 <6>: Core and Builtins<36>.
                                                             (line   46)
* Python Enhancement Proposals; PEP 488: PEP 488 Elimination of PYO files.
                                                             (line    6)
* Python Enhancement Proposals; PEP 488 <1>: PEP 488 Elimination of PYO files.
                                                             (line   20)
* Python Enhancement Proposals; PEP 488 <2>: Changes in the Python API<4>.
                                                             (line   79)
* Python Enhancement Proposals; PEP 488 <3>: Core and Builtins<54>.
                                                             (line   15)
* Python Enhancement Proposals; PEP 488 <4>: Miscellaneous options.
                                                             (line   71)
* Python Enhancement Proposals; PEP 488 <5>: Miscellaneous options.
                                                             (line   73)
* Python Enhancement Proposals; PEP 488 <6>: Miscellaneous options.
                                                             (line   80)
* Python Enhancement Proposals; PEP 488 <7>: Miscellaneous options.
                                                             (line   82)
* Python Enhancement Proposals; PEP 488 <8>: test support — Utilities for the Python test suite.
                                                             (line  192)
* Python Enhancement Proposals; PEP 488 <9>: Introduction<12>.
                                                             (line   65)
* Python Enhancement Proposals; PEP 488 <10>: importlib util – Utility code for importers.
                                                             (line   24)
* Python Enhancement Proposals; PEP 488 <11>: importlib util – Utility code for importers.
                                                             (line   64)
* Python Enhancement Proposals; PEP 488 <12>: py_compile — Compile Python source files.
                                                             (line   31)
* Python Enhancement Proposals; PEP 488 <13>: distutils util — Miscellaneous other utility functions.
                                                             (line  132)
* Python Enhancement Proposals; PEP 488 <14>: distutils util — Miscellaneous other utility functions.
                                                             (line  169)
* Python Enhancement Proposals; PEP 489: PEP 489 Multi-phase extension module initialization.
                                                             (line    6)
* Python Enhancement Proposals; PEP 489 <1>: PEP 489 Multi-phase extension module initialization.
                                                             (line   18)
* Python Enhancement Proposals; PEP 489 <2>: Build and C API Changes<3>.
                                                             (line   37)
* Python Enhancement Proposals; PEP 489 <3>: Introduction<12>.
                                                             (line   69)
* Python Enhancement Proposals; PEP 489 <4>: importlib machinery – Importers and path hooks.
                                                             (line   77)
* Python Enhancement Proposals; PEP 489 <5>: importlib machinery – Importers and path hooks.
                                                             (line  318)
* Python Enhancement Proposals; PEP 489 <6>: importlib machinery – Importers and path hooks.
                                                             (line  324)
* Python Enhancement Proposals; PEP 489 <7>: The Module’s Method Table and Initialization Function.
                                                             (line   77)
* Python Enhancement Proposals; PEP 489 <8>: Building C and C++ Extensions.
                                                             (line   35)
* Python Enhancement Proposals; PEP 489 <9>: Multi-phase initialization.
                                                             (line  108)
* Python Enhancement Proposals; PEP 492: PEP 525 Asynchronous Generators.
                                                             (line    6)
* Python Enhancement Proposals; PEP 492 <1>: New Keywords.   (line    7)
* Python Enhancement Proposals; PEP 492 <2>: PEP 492 - Coroutines with async and await syntax.
                                                             (line    6)
* Python Enhancement Proposals; PEP 492 <3>: PEP 492 - Coroutines with async and await syntax.
                                                             (line   97)
* Python Enhancement Proposals; PEP 492 <4>: New Keywords<2>.
                                                             (line    7)
* Python Enhancement Proposals; PEP 492 <5>: Changes in the C API<4>.
                                                             (line   25)
* Python Enhancement Proposals; PEP 492 <6>: Core and Builtins<21>.
                                                             (line   98)
* Python Enhancement Proposals; PEP 492 <7>: Library<42>.    (line   36)
* Python Enhancement Proposals; PEP 492 <8>: Library<54>.    (line   16)
* Python Enhancement Proposals; PEP 492 <9>: Core and Builtins<51>.
                                                             (line   14)
* Python Enhancement Proposals; PEP 492 <10>: Awaitable Objects.
                                                             (line   27)
* Python Enhancement Proposals; PEP 492 <11>: Yield expressions.
                                                             (line  105)
* Python Enhancement Proposals; PEP 492 <12>: The async with statement.
                                                             (line   41)
* Python Enhancement Proposals; PEP 492 <13>: Collections Abstract Base Classes.
                                                             (line  240)
* Python Enhancement Proposals; PEP 492 <14>: Code Objects Bit Flags.
                                                             (line   42)
* Python Enhancement Proposals; PEP 492 <15>: Code Objects Bit Flags.
                                                             (line   51)
* Python Enhancement Proposals; PEP 492 <16>: Glossary.      (line   98)
* Python Enhancement Proposals; PEP 492 <17>: Glossary.      (line  131)
* Python Enhancement Proposals; PEP 492 <18>: Glossary.      (line  138)
* Python Enhancement Proposals; PEP 492 <19>: Glossary.      (line  147)
* Python Enhancement Proposals; PEP 492 <20>: Glossary.      (line  159)
* Python Enhancement Proposals; PEP 492 <21>: Glossary.      (line  281)
* Python Enhancement Proposals; PEP 492 <22>: Glossary.      (line  288)
* Python Enhancement Proposals; PEP 493: PEP 493 HTTPS verification migration tools for Python 2 7.
                                                             (line    6)
* Python Enhancement Proposals; PEP 494: What’s New In Python 3 6.
                                                             (line   17)
* Python Enhancement Proposals; PEP 495: PEP 495 Local Time Disambiguation.
                                                             (line   13)
* Python Enhancement Proposals; PEP 495 <1>: PEP 495 Local Time Disambiguation.
                                                             (line   36)
* Python Enhancement Proposals; PEP 495 <2>: Library<37>.    (line   96)
* Python Enhancement Proposals; PEP 498: PEP 498 Formatted string literals.
                                                             (line    6)
* Python Enhancement Proposals; PEP 498 <1>: PEP 498 Formatted string literals.
                                                             (line   27)
* Python Enhancement Proposals; PEP 498 <2>: Core and Builtins<39>.
                                                             (line  284)
* Python Enhancement Proposals; PEP 498 <3>: Formatted string literals.
                                                             (line  112)
* Python Enhancement Proposals; PEP 498 <4>: Glossary.       (line  398)
* Python Enhancement Proposals; PEP 5:   PEP 230 Warning Framework.
                                                             (line   66)
* Python Enhancement Proposals; PEP 5 <1>: Is it reasonable to propose incompatible changes to Python?.
                                                             (line   14)
* Python Enhancement Proposals; PEP 506: secrets.            (line   19)
* Python Enhancement Proposals; PEP 506 <1>: Library<44>.    (line   60)
* Python Enhancement Proposals; PEP 506 <2>: secrets — Generate secure random numbers for managing secrets.
                                                             (line   24)
* Python Enhancement Proposals; PEP 511: Changes in the Python API<3>.
                                                             (line   32)
* Python Enhancement Proposals; PEP 514: Windows<31>.        (line    8)
* Python Enhancement Proposals; PEP 515: PEP 515 Underscores in Numeric Literals.
                                                             (line    6)
* Python Enhancement Proposals; PEP 515 <1>: PEP 515 Underscores in Numeric Literals.
                                                             (line   32)
* Python Enhancement Proposals; PEP 515 <2>: Core and Builtins<35>.
                                                             (line   15)
* Python Enhancement Proposals; PEP 515 <3>: Core and Builtins<35>.
                                                             (line   43)
* Python Enhancement Proposals; PEP 515 <4>: Format Specification Mini-Language.
                                                             (line  111)
* Python Enhancement Proposals; PEP 519: PEP 519 Adding a file system path protocol.
                                                             (line   62)
* Python Enhancement Proposals; PEP 519 <1>: Library<37>.    (line    6)
* Python Enhancement Proposals; PEP 519 <2>: Core and Builtins<38>.
                                                             (line   19)
* Python Enhancement Proposals; PEP 519 <3>: Library<42>.    (line   16)
* Python Enhancement Proposals; PEP 519 <4>: Library<42>.    (line   27)
* Python Enhancement Proposals; PEP 519 <5>: Library<42>.    (line   29)
* Python Enhancement Proposals; PEP 519 <6>: C API<26>.      (line    6)
* Python Enhancement Proposals; PEP 519 <7>: Glossary.       (line  992)
* Python Enhancement Proposals; PEP 520: PEP 520 Preserving Class Attribute Definition Order.
                                                             (line   17)
* Python Enhancement Proposals; PEP 523: PEP 523 Adding a frame evaluation API to CPython.
                                                             (line   12)
* Python Enhancement Proposals; PEP 523 <1>: PEP 523 Adding a frame evaluation API to CPython.
                                                             (line   26)
* Python Enhancement Proposals; PEP 523 <2>: Tools/Demos<14>.
                                                             (line    7)
* Python Enhancement Proposals; PEP 523 <3>: Tools/Demos<18>.
                                                             (line    7)
* Python Enhancement Proposals; PEP 523 <4>: Core and Builtins<35>.
                                                             (line   83)
* Python Enhancement Proposals; PEP 524: Summary – Release highlights<2>.
                                                             (line   77)
* Python Enhancement Proposals; PEP 524 <1>: os<3>.          (line   20)
* Python Enhancement Proposals; PEP 524 <2>: os<3>.          (line   25)
* Python Enhancement Proposals; PEP 524 <3>: Library<36>.    (line  150)
* Python Enhancement Proposals; PEP 524 <4>: Library<36>.    (line  154)
* Python Enhancement Proposals; PEP 524 <5>: Random numbers<2>.
                                                             (line   42)
* Python Enhancement Proposals; PEP 525: PEP 525 Asynchronous Generators.
                                                             (line   23)
* Python Enhancement Proposals; PEP 525 <1>: Core and Builtins<35>.
                                                             (line   49)
* Python Enhancement Proposals; PEP 525 <2>: Yield expressions.
                                                             (line  103)
* Python Enhancement Proposals; PEP 525 <3>: Collections Abstract Base Classes.
                                                             (line  240)
* Python Enhancement Proposals; PEP 525 <4>: sys — System-specific parameters and functions.
                                                             (line  772)
* Python Enhancement Proposals; PEP 525 <5>: sys — System-specific parameters and functions.
                                                             (line 1373)
* Python Enhancement Proposals; PEP 525 <6>: Code Objects Bit Flags.
                                                             (line   60)
* Python Enhancement Proposals; PEP 525 <7>: Glossary.       (line  132)
* Python Enhancement Proposals; PEP 526: ast.                (line   18)
* Python Enhancement Proposals; PEP 526 <1>: PEP 563 Postponed Evaluation of Annotations.
                                                             (line    8)
* Python Enhancement Proposals; PEP 526 <2>: PEP 526 Syntax for variable annotations.
                                                             (line   30)
* Python Enhancement Proposals; PEP 526 <3>: typing<2>.      (line   23)
* Python Enhancement Proposals; PEP 526 <4>: Core and Builtins<35>.
                                                             (line   51)
* Python Enhancement Proposals; PEP 526 <5>: Annotated assignment statements.
                                                             (line   39)
* Python Enhancement Proposals; PEP 526 <6>: Function definitions.
                                                             (line  131)
* Python Enhancement Proposals; PEP 526 <7>: typing — Support for type hints.
                                                             (line   17)
* Python Enhancement Proposals; PEP 526 <8>: Classes functions and decorators.
                                                             (line  450)
* Python Enhancement Proposals; PEP 526 <9>: Classes functions and decorators.
                                                             (line  479)
* Python Enhancement Proposals; PEP 526 <10>: Classes functions and decorators.
                                                             (line  749)
* Python Enhancement Proposals; PEP 526 <11>: dataclasses — Data Classes.
                                                             (line   16)
* Python Enhancement Proposals; PEP 526 <12>: Class variables.
                                                             (line    8)
* Python Enhancement Proposals; PEP 526 <13>: ast Helpers.   (line   16)
* Python Enhancement Proposals; PEP 526 <14>: Glossary.      (line   61)
* Python Enhancement Proposals; PEP 526 <15>: Glossary.      (line 1244)
* Python Enhancement Proposals; PEP 528: PEP 528 Change Windows console encoding to UTF-8.
                                                             (line   17)
* Python Enhancement Proposals; PEP 528 <1>: Global configuration variables.
                                                             (line  105)
* Python Enhancement Proposals; PEP 529: Changes in the Python API.
                                                             (line    7)
* Python Enhancement Proposals; PEP 529 <1>: PEP 529 Change Windows filesystem encoding to UTF-8.
                                                             (line   22)
* Python Enhancement Proposals; PEP 529 <2>: Library<7>.     (line   22)
* Python Enhancement Proposals; PEP 529 <3>: Windows<26>.    (line   14)
* Python Enhancement Proposals; PEP 529 <4>: Environment variables.
                                                             (line  307)
* Python Enhancement Proposals; PEP 529 <5>: Files and Directories.
                                                             (line  274)
* Python Enhancement Proposals; PEP 529 <6>: sys — System-specific parameters and functions.
                                                             (line  627)
* Python Enhancement Proposals; PEP 529 <7>: sys — System-specific parameters and functions.
                                                             (line 1412)
* Python Enhancement Proposals; PEP 529 <8>: File System Encoding.
                                                             (line    9)
* Python Enhancement Proposals; PEP 529 <9>: Global configuration variables.
                                                             (line   93)
* Python Enhancement Proposals; PEP 530: PEP 530 Asynchronous Comprehensions.
                                                             (line    6)
* Python Enhancement Proposals; PEP 530 <1>: PEP 530 Asynchronous Comprehensions.
                                                             (line   19)
* Python Enhancement Proposals; PEP 530 <2>: Core and Builtins<35>.
                                                             (line  145)
* Python Enhancement Proposals; PEP 530 <3>: Displays for lists sets and dictionaries.
                                                             (line   53)
* Python Enhancement Proposals; PEP 538: PEP 538 Legacy C Locale Coercion.
                                                             (line   11)
* Python Enhancement Proposals; PEP 538 <1>: PEP 538 Legacy C Locale Coercion.
                                                             (line   36)
* Python Enhancement Proposals; PEP 538 <2>: PEP 538 Legacy C Locale Coercion.
                                                             (line   48)
* Python Enhancement Proposals; PEP 538 <3>: PEP 540 Forced UTF-8 Runtime Mode.
                                                             (line   27)
* Python Enhancement Proposals; PEP 538 <4>: Documentation<12>.
                                                             (line   68)
* Python Enhancement Proposals; PEP 538 <5>: Documentation<13>.
                                                             (line    6)
* Python Enhancement Proposals; PEP 538 <6>: Core and Builtins<22>.
                                                             (line  135)
* Python Enhancement Proposals; PEP 538 <7>: Environment variables.
                                                             (line  376)
* Python Enhancement Proposals; PEP 538 <8>: Python Configuration.
                                                             (line   13)
* Python Enhancement Proposals; PEP 539: PEP 539 New C API for Thread-Local Storage.
                                                             (line   12)
* Python Enhancement Proposals; PEP 539 <1>: PEP 539 New C API for Thread-Local Storage.
                                                             (line   30)
* Python Enhancement Proposals; PEP 539 <2>: C API<15>.      (line   13)
* Python Enhancement Proposals; PEP 539 <3>: Thread Specific Storage TSS API.
                                                             (line   15)
* Python Enhancement Proposals; PEP 540: PEP 540 Forced UTF-8 Runtime Mode.
                                                             (line   18)
* Python Enhancement Proposals; PEP 540 <1>: PEP 540 Forced UTF-8 Runtime Mode.
                                                             (line   35)
* Python Enhancement Proposals; PEP 540 <2>: Core and Builtins<19>.
                                                             (line   63)
* Python Enhancement Proposals; PEP 540 <3>: Environment variables.
                                                             (line  447)
* Python Enhancement Proposals; PEP 540 <4>: Python Configuration.
                                                             (line   13)
* Python Enhancement Proposals; PEP 544: typing.             (line   32)
* Python Enhancement Proposals; PEP 544 <1>: typing — Support for type hints.
                                                             (line   17)
* Python Enhancement Proposals; PEP 544 <2>: Nominal vs structural subtyping.
                                                             (line   18)
* Python Enhancement Proposals; PEP 544 <3>: Classes functions and decorators.
                                                             (line   66)
* Python Enhancement Proposals; PEP 545: PEP 545 Python Documentation Translations.
                                                             (line    6)
* Python Enhancement Proposals; PEP 545 <1>: PEP 545 Python Documentation Translations.
                                                             (line   20)
* Python Enhancement Proposals; PEP 552: PEP 552 Hash-based pyc Files.
                                                             (line   15)
* Python Enhancement Proposals; PEP 552 <1>: PEP 552 Hash-based pyc Files.
                                                             (line   35)
* Python Enhancement Proposals; PEP 552 <2>: Library<12>.    (line  797)
* Python Enhancement Proposals; PEP 552 <3>: Core and Builtins<19>.
                                                             (line   75)
* Python Enhancement Proposals; PEP 552 <4>: Introduction<12>.
                                                             (line   73)
* Python Enhancement Proposals; PEP 552 <5>: py_compile — Compile Python source files.
                                                             (line   81)
* Python Enhancement Proposals; PEP 552 <6>: PyConfig.       (line  137)
* Python Enhancement Proposals; PEP 553: PEP 553 Built-in breakpoint.
                                                             (line   20)
* Python Enhancement Proposals; PEP 553 <1>: Core and Builtins<21>.
                                                             (line   72)
* Python Enhancement Proposals; PEP 557: dataclasses.        (line   26)
* Python Enhancement Proposals; PEP 557 <1>: dataclasses — Data Classes.
                                                             (line   13)
* Python Enhancement Proposals; PEP 560: PEP 560 Core Support for typing module and Generic Types.
                                                             (line   19)
* Python Enhancement Proposals; PEP 560 <1>: types.          (line   12)
* Python Enhancement Proposals; PEP 560 <2>: Core and Builtins<19>.
                                                             (line   66)
* Python Enhancement Proposals; PEP 560 <3>: Resolving MRO entries.
                                                             (line   15)
* Python Enhancement Proposals; PEP 560 <4>: Emulating generic types.
                                                             (line   22)
* Python Enhancement Proposals; PEP 560 <5>: Dynamic Type Creation.
                                                             (line   60)
* Python Enhancement Proposals; PEP 560 <6>: Dynamic Type Creation.
                                                             (line   74)
* Python Enhancement Proposals; PEP 562: PEP 562 Customization of Access to Module Attributes.
                                                             (line   16)
* Python Enhancement Proposals; PEP 562 <1>: Library<19>.    (line   63)
* Python Enhancement Proposals; PEP 562 <2>: Core and Builtins<19>.
                                                             (line   69)
* Python Enhancement Proposals; PEP 562 <3>: Customizing module attribute access.
                                                             (line   52)
* Python Enhancement Proposals; PEP 563: PEP 563 Postponed Evaluation of Annotations.
                                                             (line   51)
* Python Enhancement Proposals; PEP 563 <1>: Function definitions.
                                                             (line  136)
* Python Enhancement Proposals; PEP 563 <2>: __future__ — Future statement definitions.
                                                             (line   91)
* Python Enhancement Proposals; PEP 564: PEP 564 New Time Functions With Nanosecond Resolution.
                                                             (line    8)
* Python Enhancement Proposals; PEP 564 <1>: PEP 564 New Time Functions With Nanosecond Resolution.
                                                             (line   33)
* Python Enhancement Proposals; PEP 564 <2>: time<2>.        (line    6)
* Python Enhancement Proposals; PEP 564 <3>: Library<21>.    (line  300)
* Python Enhancement Proposals; PEP 565: PEP 565 Show DeprecationWarning in __main__.
                                                             (line   41)
* Python Enhancement Proposals; PEP 567: contextvars.        (line   20)
* Python Enhancement Proposals; PEP 567 <1>: asyncio<2>.     (line   19)
* Python Enhancement Proposals; PEP 567 <2>: Documentation<12>.
                                                             (line   86)
* Python Enhancement Proposals; PEP 567 <3>: Documentation<14>.
                                                             (line    9)
* Python Enhancement Proposals; PEP 567 <4>: Core and Builtins<18>.
                                                             (line   63)
* Python Enhancement Proposals; PEP 567 <5>: contextvars — Context Variables.
                                                             (line   18)
* Python Enhancement Proposals; PEP 567 <6>: Scheduling callbacks.
                                                             (line   32)
* Python Enhancement Proposals; PEP 567 <7>: Scheduling delayed callbacks.
                                                             (line   31)
* Python Enhancement Proposals; PEP 567 <8>: Scheduling delayed callbacks.
                                                             (line   49)
* Python Enhancement Proposals; PEP 567 <9>: Future Object.  (line   97)
* Python Enhancement Proposals; PEP 570: Positional-only parameters.
                                                             (line   71)
* Python Enhancement Proposals; PEP 570 <1>: Changes in the Python API.
                                                             (line  153)
* Python Enhancement Proposals; PEP 570 <2>: Changes in the C API.
                                                             (line  110)
* Python Enhancement Proposals; PEP 570 <3>: Core and Builtins<9>.
                                                             (line   36)
* Python Enhancement Proposals; PEP 572: Assignment expressions.
                                                             (line   41)
* Python Enhancement Proposals; PEP 572 <1>: CPython bytecode changes.
                                                             (line   28)
* Python Enhancement Proposals; PEP 572 <2>: Core and Builtins<5>.
                                                             (line   18)
* Python Enhancement Proposals; PEP 572 <3>: Core and Builtins<12>.
                                                             (line   92)
* Python Enhancement Proposals; PEP 572 <4>: Dictionary displays.
                                                             (line   47)
* Python Enhancement Proposals; PEP 572 <5>: Why can’t I use an assignment in an expression?.
                                                             (line   13)
* Python Enhancement Proposals; PEP 574: Pickle protocol 5 with out-of-band data buffers.
                                                             (line   17)
* Python Enhancement Proposals; PEP 574 <1>: Data stream format.
                                                             (line   46)
* Python Enhancement Proposals; PEP 574 <2>: Example<4>.     (line   63)
* Python Enhancement Proposals; PEP 578: PEP 578 Python Runtime Audit Hooks.
                                                             (line   12)
* Python Enhancement Proposals; PEP 578 <1>: System Functions.
                                                             (line  153)
* Python Enhancement Proposals; PEP 586: typing.             (line   18)
* Python Enhancement Proposals; PEP 586 <1>: typing — Support for type hints.
                                                             (line   17)
* Python Enhancement Proposals; PEP 586 <2>: Classes functions and decorators.
                                                             (line  740)
* Python Enhancement Proposals; PEP 587: PEP 587 Python Initialization Configuration.
                                                             (line    6)
* Python Enhancement Proposals; PEP 587 <1>: PEP 587 Python Initialization Configuration.
                                                             (line   83)
* Python Enhancement Proposals; PEP 587 <2>: Core and Builtins<4>.
                                                             (line   12)
* Python Enhancement Proposals; PEP 587 <3>: C API<6>.       (line    6)
* Python Enhancement Proposals; PEP 587 <4>: Python Initialization Configuration.
                                                             (line   81)
* Python Enhancement Proposals; PEP 589: typing.             (line    8)
* Python Enhancement Proposals; PEP 589 <1>: typing — Support for type hints.
                                                             (line   17)
* Python Enhancement Proposals; PEP 589 <2>: Classes functions and decorators.
                                                             (line  485)
* Python Enhancement Proposals; PEP 590: Vectorcall a fast calling protocol for CPython.
                                                             (line   14)
* Python Enhancement Proposals; PEP 590 <1>: C API<6>.       (line   17)
* Python Enhancement Proposals; PEP 591: typing.             (line   25)
* Python Enhancement Proposals; PEP 591 <1>: typing — Support for type hints.
                                                             (line   17)
* Python Enhancement Proposals; PEP 591 <2>: Classes functions and decorators.
                                                             (line  575)
* Python Enhancement Proposals; PEP 591 <3>: Classes functions and decorators.
                                                             (line  776)
* Python Enhancement Proposals; PEP 6:   How does the Python version numbering scheme work?.
                                                             (line    9)
* Python Enhancement Proposals; PEP 628: cmath.              (line    7)
* Python Enhancement Proposals; PEP 628 <1>: math<3>.        (line    7)
* Python Enhancement Proposals; PEP 628 <2>: Library<37>.    (line   32)
* Python Enhancement Proposals; PEP 7:   Build and C API Changes<2>.
                                                             (line    9)
* Python Enhancement Proposals; PEP 7 <1>: Coding standards. (line    7)
* Python Enhancement Proposals; PEP 8:   Library Changes.    (line   26)
* Python Enhancement Proposals; PEP 8 <1>: Library<21>.      (line  125)
* Python Enhancement Proposals; PEP 8 <2>: IDLE<40>.         (line   81)
* Python Enhancement Proposals; PEP 8 <3>: Intermezzo Coding Style.
                                                             (line   13)
* Python Enhancement Proposals; PEP 8 <4>: Editors and IDEs. (line    7)
* Python Enhancement Proposals; PEP 8 <5>: Value comparisons.
                                                             (line   61)
* Python Enhancement Proposals; PEP 8 <6>: Using real Argument Clinic converters instead of “legacy converters”.
                                                             (line   50)
* Python Enhancement Proposals; PEP 8 <7>: Are there coding standards or a style guide for Python programs?.
                                                             (line    7)
* Python Enhancement Proposals; PEP 8 <8>: How do I keep editors from inserting tabs into my Python source?.
                                                             (line    6)
* Python Package Index (PyPI):           Installing the tools.
                                                             (line   26)
* PYTHON*:                               Other Improvements<2>.
                                                             (line    9)
* PYTHON* <1>:                           Interface options.  (line   80)
* PYTHON* <2>:                           Interface options.  (line  140)
* PYTHON* <3>:                           Miscellaneous options.
                                                             (line   42)
* PYTHON* <4>:                           Miscellaneous options.
                                                             (line   60)
* PYTHON* <5>:                           Global configuration variables.
                                                             (line   56)
* python.function.entry (C function):    SystemTap Tapsets.  (line   18)
* python.function.return (C function):   SystemTap Tapsets.  (line   24)
* PYTHONASYNCIODEBUG:                    Enabling debug mode.
                                                             (line   10)
* PYTHONASYNCIODEBUG <1>:                Debug Mode.         (line   11)
* PYTHONBREAKPOINT:                      PEP 553 Built-in breakpoint.
                                                             (line   13)
* PYTHONBREAKPOINT <1>:                  sys — System-specific parameters and functions.
                                                             (line  188)
* PYTHONBREAKPOINT <2>:                  sys — System-specific parameters and functions.
                                                             (line  202)
* PYTHONBREAKPOINT <3>:                  sys — System-specific parameters and functions.
                                                             (line  206)
* PYTHONCASEOK:                          PEP 235 Importing Modules on Case-Insensitive Platforms.
                                                             (line   17)
* PYTHONCOERCECLOCALE:                   PEP 538 Legacy C Locale Coercion.
                                                             (line   13)
* PYTHONCOERCECLOCALE <1>:               Environment variables.
                                                             (line  438)
* PYTHONCOERCECLOCALE <2>:               Python Configuration.
                                                             (line   15)
* PYTHONDEBUG:                           Miscellaneous options.
                                                             (line   38)
* PYTHONDEBUG <1>:                       Global configuration variables.
                                                             (line   28)
* PYTHONDEVMODE:                         Development Runtime Mode -X dev.
                                                             (line    6)
* PYTHONDEVMODE <1>:                     test support script_helper — Utilities for the Python execution tests.
                                                             (line  106)
* PYTHONDOCS:                            pydoc — Documentation generator and online help system.
                                                             (line   85)
* PYTHONDONTWRITEBYTECODE:               Interpreter Changes<2>.
                                                             (line   16)
* PYTHONDONTWRITEBYTECODE <1>:           New and Improved Modules<2>.
                                                             (line  625)
* PYTHONDONTWRITEBYTECODE <2>:           Miscellaneous options.
                                                             (line   19)
* PYTHONDONTWRITEBYTECODE <3>:           sys — System-specific parameters and functions.
                                                             (line  255)
* PYTHONDONTWRITEBYTECODE <4>:           Global configuration variables.
                                                             (line   36)
* PYTHONDONTWRITEBYTECODE <5>:           How do I create a pyc file?.
                                                             (line   21)
* PYTHONDUMPREFS:                        Debug build uses the same ABI as release build.
                                                             (line   14)
* PYTHONDUMPREFS <1>:                    Build<7>.           (line   54)
* PYTHONDUMPREFS <2>:                    PyObject Slots.     (line   24)
* PYTHONFAULTHANDLER:                    faulthandler<3>.    (line   11)
* PYTHONFAULTHANDLER <1>:                faulthandler — Dump the Python traceback.
                                                             (line   14)
* PYTHONHASHSEED:                        Builtin functions and types.
                                                             (line   17)
* PYTHONHASHSEED <1>:                    Porting Python code.
                                                             (line    6)
* PYTHONHASHSEED <2>:                    Core and Builtins<19>.
                                                             (line   30)
* PYTHONHASHSEED <3>:                    Miscellaneous options.
                                                             (line   94)
* PYTHONHASHSEED <4>:                    Miscellaneous options.
                                                             (line  110)
* PYTHONHASHSEED <5>:                    Environment variables.
                                                             (line  129)
* PYTHONHASHSEED <6>:                    Basic customization.
                                                             (line  294)
* PYTHONHASHSEED <7>:                    Global configuration variables.
                                                             (line   48)
* PYTHONHASHSEED <8>:                    Global configuration variables.
                                                             (line   51)
* PYTHONHOME:                            Summary – Release highlights<2>.
                                                             (line  107)
* PYTHONHOME <1>:                        Miscellaneous options.
                                                             (line   43)
* PYTHONHOME <2>:                        Environment variables.
                                                             (line   19)
* PYTHONHOME <3>:                        Environment variables.
                                                             (line   21)
* PYTHONHOME <4>:                        Environment variables.
                                                             (line   38)
* PYTHONHOME <5>:                        Finding modules.    (line   50)
* PYTHONHOME <6>:                        Finding modules.    (line   68)
* PYTHONHOME <7>:                        Finding modules.    (line  102)
* PYTHONHOME <8>:                        test support script_helper — Utilities for the Python execution tests.
                                                             (line   25)
* PYTHONHOME <9>:                        Embedding Python<2>.
                                                             (line   38)
* PYTHONHOME <10>:                       Embedding Python<2>.
                                                             (line   44)
* PYTHONHOME <11>:                       Global configuration variables.
                                                             (line   57)
* PYTHONHOME <12>:                       Process-wide parameters.
                                                             (line  270)
* PYTHONHOME <13>:                       Process-wide parameters.
                                                             (line  284)
* PYTHONHOME <14>:                       PyConfig.           (line  197)
* PYTHONHOME <15>:                       Modifying Python’s Search Path.
                                                             (line   50)
* PYTHONHOME <16>:                       Modifying Python’s Search Path.
                                                             (line   52)
* Pythonic:                              Glossary.           (line 1048)
* PYTHONINSPECT:                         Other Changes and Fixes<2>.
                                                             (line   13)
* PYTHONINSPECT <1>:                     Miscellaneous options.
                                                             (line   53)
* PYTHONINSPECT <2>:                     Global configuration variables.
                                                             (line   68)
* PYTHONIOENCODING:                      Other Improvements<2>.
                                                             (line   75)
* PYTHONIOENCODING <1>:                  Interpreter Changes<2>.
                                                             (line   23)
* PYTHONIOENCODING <2>:                  Environment variables.
                                                             (line  359)
* PYTHONIOENCODING <3>:                  Environment variables.
                                                             (line  426)
* PYTHONIOENCODING <4>:                  sys — System-specific parameters and functions.
                                                             (line 1454)
* PYTHONIOENCODING <5>:                  Process-wide parameters.
                                                             (line   14)
* PYTHONIOENCODING <6>:                  Process-wide parameters.
                                                             (line   18)
* PYTHONLEGACYWINDOWSFSENCODING:         PEP 529 Change Windows filesystem encoding to UTF-8.
                                                             (line   18)
* PYTHONLEGACYWINDOWSFSENCODING <1>:     sys — System-specific parameters and functions.
                                                             (line 1406)
* PYTHONLEGACYWINDOWSFSENCODING <2>:     Global configuration variables.
                                                             (line   90)
* PYTHONLEGACYWINDOWSSTDIO:              PEP 528 Change Windows console encoding to UTF-8.
                                                             (line   12)
* PYTHONLEGACYWINDOWSSTDIO <1>:          Environment variables.
                                                             (line  156)
* PYTHONLEGACYWINDOWSSTDIO <2>:          sys — System-specific parameters and functions.
                                                             (line 1458)
* PYTHONLEGACYWINDOWSSTDIO <3>:          Global configuration variables.
                                                             (line  102)
* PYTHONMALLOC:                          PYTHONMALLOC environment variable.
                                                             (line    6)
* PYTHONMALLOC <1>:                      Changes in the C API<3>.
                                                             (line    9)
* PYTHONMALLOC <2>:                      Core and Builtins<39>.
                                                             (line   91)
* PYTHONMALLOC <3>:                      Environment variables.
                                                             (line  286)
* PYTHONMALLOC <4>:                      Overview<3>.        (line   67)
* PYTHONMALLOC <5>:                      Default Memory Allocators.
                                                             (line   26)
* PYTHONMALLOC <6>:                      Customize Memory Allocators.
                                                             (line  129)
* PYTHONMALLOCSTATS:                     Core and Builtins<39>.
                                                             (line   97)
* PYTHONMALLOCSTATS <1>:                 Overview<3>.        (line   70)
* PYTHONNOUSERSITE:                      PEP 370 Per-user site-packages Directory.
                                                             (line   30)
* PYTHONNOUSERSITE <1>:                  Module contents<3>. (line   15)
* PYTHONNOUSERSITE <2>:                  Module contents<3>. (line   74)
* PYTHONNOUSERSITE <3>:                  Global configuration variables.
                                                             (line  124)
* PYTHONOPTIMIZE:                        Miscellaneous options.
                                                             (line   71)
* PYTHONOPTIMIZE <1>:                    Global configuration variables.
                                                             (line  129)
* PYTHONPATH:                            Changes in ‘python’ Command Behavior<2>.
                                                             (line    8)
* PYTHONPATH <1>:                        Changes in ‘python’ Command Behavior<2>.
                                                             (line    9)
* PYTHONPATH <2>:                        The Module Search Path.
                                                             (line   15)
* PYTHONPATH <3>:                        Standard Modules.   (line   34)
* PYTHONPATH <4>:                        Standard Modules.   (line   35)
* PYTHONPATH <5>:                        Miscellaneous options.
                                                             (line   42)
* PYTHONPATH <6>:                        Environment variables.
                                                             (line   32)
* PYTHONPATH <7>:                        Environment variables.
                                                             (line   39)
* PYTHONPATH <8>:                        Environment variables.
                                                             (line   42)
* PYTHONPATH <9>:                        Excursus Setting environment variables.
                                                             (line   38)
* PYTHONPATH <10>:                       Finding modules.    (line   36)
* PYTHONPATH <11>:                       Finding modules.    (line   59)
* PYTHONPATH <12>:                       Finding modules.    (line  102)
* PYTHONPATH <13>:                       Configuration.      (line    6)
* PYTHONPATH <14>:                       Path entry finders. (line    6)
* PYTHONPATH <15>:                       Installing your CGI script on a Unix system.
                                                             (line   29)
* PYTHONPATH <16>:                       test support script_helper — Utilities for the Python execution tests.
                                                             (line   26)
* PYTHONPATH <17>:                       sys — System-specific parameters and functions.
                                                             (line 1018)
* PYTHONPATH <18>:                       sys — System-specific parameters and functions.
                                                             (line 1028)
* PYTHONPATH <19>:                       Building C and C++ Extensions.
                                                             (line    9)
* PYTHONPATH <20>:                       Embedding Python<2>.
                                                             (line   39)
* PYTHONPATH <21>:                       Embedding Python<2>.
                                                             (line   44)
* PYTHONPATH <22>:                       Global configuration variables.
                                                             (line   56)
* PYTHONPATH <23>:                       PyConfig.           (line  252)
* PYTHONPATH <24>:                       Modifying Python’s Search Path.
                                                             (line   57)
* PYTHONPATH <25>:                       Modifying Python’s Search Path.
                                                             (line   58)
* PYTHONPROFILEIMPORTTIME:               Other Language Changes<2>.
                                                             (line   42)
* PYTHONPROFILEIMPORTTIME <1>:           Core and Builtins<21>.
                                                             (line   66)
* PYTHONPROFILEIMPORTTIME <2>:           Miscellaneous options.
                                                             (line  223)
* PYTHONPYCACHEPREFIX:                   Parallel filesystem cache for compiled bytecode files.
                                                             (line    6)
* PYTHONPYCACHEPREFIX <1>:               Core and Builtins<12>.
                                                             (line  402)
* PYTHONPYCACHEPREFIX <2>:               Miscellaneous options.
                                                             (line  257)
* PYTHONPYCACHEPREFIX <3>:               sys — System-specific parameters and functions.
                                                             (line  273)
* PYTHONSHOWALLOCCOUNT:                  Two new environment variables for debug mode.
                                                             (line   11)
* PYTHONSHOWREFCOUNT:                    Two new environment variables for debug mode.
                                                             (line    7)
* PYTHONSTARTUP:                         sys<6>.             (line   17)
* PYTHONSTARTUP <1>:                     sys<6>.             (line   21)
* PYTHONSTARTUP <2>:                     IDLE<14>.           (line  176)
* PYTHONSTARTUP <3>:                     IDLE<18>.           (line    9)
* PYTHONSTARTUP <4>:                     IDLE<24>.           (line    9)
* PYTHONSTARTUP <5>:                     The Interactive Startup File.
                                                             (line    8)
* PYTHONSTARTUP <6>:                     Miscellaneous options.
                                                             (line   50)
* PYTHONSTARTUP <7>:                     Example.            (line   10)
* PYTHONSTARTUP <8>:                     Startup and code execution.
                                                             (line    7)
* PYTHONSTARTUP <9>:                     sys — System-specific parameters and functions.
                                                             (line  913)
* PYTHONSTARTUP <10>:                    Readline configuration.
                                                             (line   12)
* PYTHONTRACEMALLOC:                     tracemalloc — Trace memory allocations.
                                                             (line   25)
* PYTHONTRACEMALLOC <1>:                 tracemalloc — Trace memory allocations.
                                                             (line   32)
* PYTHONTRACEMALLOC <2>:                 Functions<9>.       (line   68)
* PYTHONUNBUFFERED:                      Miscellaneous options.
                                                             (line  140)
* PYTHONUNBUFFERED <1>:                  Global configuration variables.
                                                             (line  145)
* PYTHONUSERBASE:                        PEP 370 Per-user site-packages Directory.
                                                             (line   23)
* PYTHONUSERBASE <1>:                    Module contents<3>. (line   39)
* PYTHONUSERBASE <2>:                    Module contents<3>. (line   66)
* PYTHONUSERSITE:                        test support script_helper — Utilities for the Python execution tests.
                                                             (line   26)
* PYTHONUTF8:                            PEP 540 Forced UTF-8 Runtime Mode.
                                                             (line    6)
* PYTHONUTF8 <1>:                        Miscellaneous options.
                                                             (line  252)
* PYTHONUTF8 <2>:                        Environment variables.
                                                             (line  369)
* PYTHONUTF8 <3>:                        sys — System-specific parameters and functions.
                                                             (line 1456)
* PYTHONUTF8 <4>:                        Python Configuration.
                                                             (line   14)
* PYTHONVERBOSE:                         Miscellaneous options.
                                                             (line  151)
* PYTHONVERBOSE <1>:                     Global configuration variables.
                                                             (line  156)
* PYTHONWARNINGS:                        warnings.           (line   21)
* PYTHONWARNINGS <1>:                    Other Language Changes<7>.
                                                             (line  158)
* PYTHONWARNINGS <2>:                    Changes to the Handling of Deprecation Warnings.
                                                             (line   25)
* PYTHONWARNINGS <3>:                    Interpreter Changes.
                                                             (line    6)
* PYTHONWARNINGS <4>:                    Miscellaneous options.
                                                             (line  169)
* PYTHONWARNINGS <5>:                    Describing Warning Filters.
                                                             (line    7)
* PYTHONWARNINGS <6>:                    Describing Warning Filters.
                                                             (line   21)
* PYTHONWARNINGS <7>:                    Default Warning Filter.
                                                             (line    7)
* python_branch() (in module platform):  Cross Platform.     (line   86)
* python_build() (in module platform):   Cross Platform.     (line   76)
* python_compiler() (in module platform): Cross Platform.    (line   81)
* PYTHON_DOM:                            Module Contents<4>. (line   23)
* python_implementation() (in module platform): Cross Platform.
                                                             (line   90)
* python_is_optimized() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  203)
* python_revision() (in module platform): Cross Platform.    (line   95)
* python_version() (in module platform): Cross Platform.     (line  100)
* python_version_tuple() (in module platform): Cross Platform.
                                                             (line  107)
* PyThreadState:                         Thread State and the Global Interpreter Lock.
                                                             (line   23)
* PyThreadState <1>:                     Thread State and the Global Interpreter Lock.
                                                             (line   23)
* PyThreadState (C type):                High-level API.     (line   21)
* PyThreadState_Clear (C function):      Low-level API.      (line   44)
* PyThreadState_Delete (C function):     Low-level API.      (line   49)
* PyThreadState_Get (C function):        High-level API.     (line   76)
* PyThreadState_GetDict (C function):    Low-level API.      (line   78)
* PyThreadState_New (C function):        Low-level API.      (line   37)
* PyThreadState_Next (C function):       Advanced Debugger Support.
                                                             (line   32)
* PyThreadState_SetAsyncExc (C function): Low-level API.     (line   87)
* PyThreadState_Swap (C function):       High-level API.     (line   82)
* PyThread_create_key (C function):      Thread Local Storage TLS API.
                                                             (line   18)
* PyThread_delete_key (C function):      Thread Local Storage TLS API.
                                                             (line   20)
* PyThread_delete_key_value (C function): Thread Local Storage TLS API.
                                                             (line   26)
* PyThread_get_key_value (C function):   Thread Local Storage TLS API.
                                                             (line   24)
* PyThread_ReInitTLS (C function):       Thread Local Storage TLS API.
                                                             (line   28)
* PyThread_set_key_value (C function):   Thread Local Storage TLS API.
                                                             (line   22)
* PyThread_tss_alloc (C function):       Dynamic Allocation. (line   11)
* PyThread_tss_create (C function):      Methods<4>.         (line   16)
* PyThread_tss_delete (C function):      Methods<4>.         (line   24)
* PyThread_tss_free (C function):        Dynamic Allocation. (line   17)
* PyThread_tss_get (C function):         Methods<4>.         (line   39)
* PyThread_tss_is_created (C function):  Methods<4>.         (line   11)
* PyThread_tss_set (C function):         Methods<4>.         (line   33)
* PyTimeZone_FromOffset (C function):    DateTime Objects<2>.
                                                             (line  120)
* PyTimeZone_FromOffsetAndName (C function): DateTime Objects<2>.
                                                             (line  128)
* PyTime_Check (C function):             DateTime Objects<2>.
                                                             (line   45)
* PyTime_CheckExact (C function):        DateTime Objects<2>.
                                                             (line   50)
* PyTime_FromTime (C function):          DateTime Objects<2>.
                                                             (line   98)
* PyTime_FromTimeAndFold (C function):   DateTime Objects<2>.
                                                             (line  103)
* PyTrace_CALL (C variable):             Profiling and Tracing.
                                                             (line   61)
* PyTrace_C_CALL (C variable):           Profiling and Tracing.
                                                             (line   93)
* PyTrace_C_EXCEPTION (C variable):      Profiling and Tracing.
                                                             (line   98)
* PyTrace_C_RETURN (C variable):         Profiling and Tracing.
                                                             (line  103)
* PyTrace_EXCEPTION (C variable):        Profiling and Tracing.
                                                             (line   69)
* PyTrace_LINE (C variable):             Profiling and Tracing.
                                                             (line   81)
* PyTrace_OPCODE (C variable):           Profiling and Tracing.
                                                             (line  108)
* PyTrace_RETURN (C variable):           Profiling and Tracing.
                                                             (line   88)
* PyTupleObject (C type):                Tuple Objects.      (line    6)
* PyTuple_Check (C function):            Tuple Objects.      (line   17)
* PyTuple_CheckExact (C function):       Tuple Objects.      (line   22)
* PyTuple_ClearFreeList (C function):    Tuple Objects.      (line  103)
* PyTuple_GetItem (C function):          Tuple Objects.      (line   48)
* PyTuple_GetSlice (C function):         Tuple Objects.      (line   57)
* PyTuple_GET_ITEM (C function):         Tuple Objects.      (line   53)
* PyTuple_GET_SIZE (C function):         Tuple Objects.      (line   43)
* PyTuple_New (C function):              Tuple Objects.      (line   27)
* PyTuple_Pack (C function):             Tuple Objects.      (line   31)
* PyTuple_SetItem (C function):          Tuple Objects.      (line   64)
* PyTuple_SetItem():                     Reference Count Details.
                                                             (line   26)
* PyTuple_SET_ITEM (C function):         Tuple Objects.      (line   76)
* PyTuple_Size (C function):             Tuple Objects.      (line   38)
* PyTuple_Type (C variable):             Tuple Objects.      (line   11)
* PyTypeObject (C type):                 Type Objects<2>.    (line    6)
* PyTypeObject.tp_alloc (C member):      PyTypeObject Slots. (line 1139)
* PyTypeObject.tp_allocs (C member):     PyTypeObject Slots. (line 1349)
* PyTypeObject.tp_as_async (C member):   PyTypeObject Slots. (line  235)
* PyTypeObject.tp_as_buffer (C member):  PyTypeObject Slots. (line  436)
* PyTypeObject.tp_as_mapping (C member): PyTypeObject Slots. (line  298)
* PyTypeObject.tp_as_number (C member):  PyTypeObject Slots. (line  276)
* PyTypeObject.tp_as_sequence (C member): PyTypeObject Slots.
                                                             (line  287)
* PyTypeObject.tp_base (C member):       PyTypeObject Slots. (line  954)
* PyTypeObject.tp_bases (C member):      PyTypeObject Slots. (line 1250)
* PyTypeObject.tp_basicsize (C member):  PyTypeObject Slots. (line   47)
* PyTypeObject.tp_cache (C member):      PyTypeObject Slots. (line 1272)
* PyTypeObject.tp_call (C member):       PyTypeObject Slots. (line  346)
* PyTypeObject.tp_clear (C member):      PyTypeObject Slots. (line  698)
* PyTypeObject.tp_dealloc (C member):    PyTypeObject Slots. (line   99)
* PyTypeObject.tp_del (C member):        PyTypeObject Slots. (line 1297)
* PyTypeObject.tp_descr_get (C member):  PyTypeObject Slots. (line 1011)
* PyTypeObject.tp_descr_set (C member):  PyTypeObject Slots. (line 1023)
* PyTypeObject.tp_dict (C member):       PyTypeObject Slots. (line  986)
* PyTypeObject.tp_dictoffset (C member): PyTypeObject Slots. (line 1038)
* PyTypeObject.tp_doc (C member):        PyTypeObject Slots. (line  645)
* PyTypeObject.tp_finalize (C member):   PyTypeObject Slots. (line 1309)
* PyTypeObject.tp_flags (C member):      PyTypeObject Slots. (line  447)
* PyTypeObject.tp_free (C member):       PyTypeObject Slots. (line 1198)
* PyTypeObject.tp_frees (C member):      PyTypeObject Slots. (line 1353)
* PyTypeObject.tp_getattr (C member):    PyTypeObject Slots. (line  196)
* PyTypeObject.tp_getattro (C member):   PyTypeObject Slots. (line  384)
* PyTypeObject.tp_getset (C member):     PyTypeObject Slots. (line  939)
* PyTypeObject.tp_hash (C member):       PyTypeObject Slots. (line  309)
* PyTypeObject.tp_init (C member):       PyTypeObject Slots. (line 1102)
* PyTypeObject.tp_is_gc (C member):      PyTypeObject Slots. (line 1221)
* PyTypeObject.tp_itemsize (C member):   PyTypeObject Slots. (line   47)
* PyTypeObject.tp_iter (C member):       PyTypeObject Slots. (line  871)
* PyTypeObject.tp_iternext (C member):   PyTypeObject Slots. (line  887)
* PyTypeObject.tp_maxalloc (C member):   PyTypeObject Slots. (line 1357)
* PyTypeObject.tp_members (C member):    PyTypeObject Slots. (line  924)
* PyTypeObject.tp_methods (C member):    PyTypeObject Slots. (line  909)
* PyTypeObject.tp_mro (C member):        PyTypeObject Slots. (line 1261)
* PyTypeObject.tp_name (C member):       PyTypeObject Slots. (line   12)
* PyTypeObject.tp_new (C member):        PyTypeObject Slots. (line 1162)
* PyTypeObject.tp_next (C member):       PyTypeObject Slots. (line 1366)
* PyTypeObject.tp_prev (C member):       PyTypeObject Slots. (line 1361)
* PyTypeObject.tp_repr (C member):       PyTypeObject Slots. (line  250)
* PyTypeObject.tp_richcompare (C member): PyTypeObject Slots.
                                                             (line  759)
* PyTypeObject.tp_setattr (C member):    PyTypeObject Slots. (line  215)
* PyTypeObject.tp_setattro (C member):   PyTypeObject Slots. (line  409)
* PyTypeObject.tp_str (C member):        PyTypeObject Slots. (line  358)
* PyTypeObject.tp_subclasses (C member): PyTypeObject Slots. (line 1280)
* PyTypeObject.tp_traverse (C member):   PyTypeObject Slots. (line  655)
* PyTypeObject.tp_vectorcall_offset (C member): PyTypeObject Slots.
                                                             (line  136)
* PyTypeObject.tp_version_tag (C member): PyTypeObject Slots.
                                                             (line 1301)
* PyTypeObject.tp_weaklist (C member):   PyTypeObject Slots. (line 1288)
* PyTypeObject.tp_weaklistoffset (C member): PyTypeObject Slots.
                                                             (line  835)
* PyType_Check (C function):             Type Objects<2>.    (line   15)
* PyType_CheckExact (C function):        Type Objects<2>.    (line   21)
* PyType_ClearCache (C function):        Type Objects<2>.    (line   26)
* PyType_FromSpec (C function):          Creating Heap-Allocated Types.
                                                             (line   25)
* PyType_FromSpecWithBases (C function): Creating Heap-Allocated Types.
                                                             (line    9)
* PyType_GenericAlloc (C function):      Type Objects<2>.    (line   68)
* PyType_GenericNew (C function):        Type Objects<2>.    (line   76)
* PyType_GetFlags (C function):          Type Objects<2>.    (line   30)
* PyType_GetSlot (C function):           Type Objects<2>.    (line   90)
* PyType_HasFeature (C function):        Type Objects<2>.    (line   49)
* PyType_IsSubtype (C function):         Type Objects<2>.    (line   59)
* PyType_IS_GC (C function):             Type Objects<2>.    (line   54)
* PyType_Modified (C function):          Type Objects<2>.    (line   43)
* PyType_Ready (C function):             Type Objects<2>.    (line   83)
* PyType_Slot (C type):                  Creating Heap-Allocated Types.
                                                             (line   58)
* PyType_Slot.PyType_Slot.pfunc (C member): Creating Heap-Allocated Types.
                                                             (line  108)
* PyType_Slot.PyType_Slot.slot (C member): Creating Heap-Allocated Types.
                                                             (line   63)
* PyType_Spec (C type):                  Creating Heap-Allocated Types.
                                                             (line   29)
* PyType_Spec.PyType_Spec.basicsize (C member): Creating Heap-Allocated Types.
                                                             (line   38)
* PyType_Spec.PyType_Spec.flags (C member): Creating Heap-Allocated Types.
                                                             (line   46)
* PyType_Spec.PyType_Spec.itemsize (C member): Creating Heap-Allocated Types.
                                                             (line   40)
* PyType_Spec.PyType_Spec.name (C member): Creating Heap-Allocated Types.
                                                             (line   33)
* PyType_Spec.PyType_Spec.slots (C member): Creating Heap-Allocated Types.
                                                             (line   53)
* PyType_Type (C variable):              Type Objects<2>.    (line   10)
* PyTZInfo_Check (C function):           DateTime Objects<2>.
                                                             (line   65)
* PyTZInfo_CheckExact (C function):      DateTime Objects<2>.
                                                             (line   70)
* PyUnicodeDecodeError_Create (C function): Unicode Exception Objects.
                                                             (line    9)
* PyUnicodeDecodeError_GetEncoding (C function): Unicode Exception Objects.
                                                             (line   37)
* PyUnicodeDecodeError_GetEnd (C function): Unicode Exception Objects.
                                                             (line   78)
* PyUnicodeDecodeError_GetObject (C function): Unicode Exception Objects.
                                                             (line   44)
* PyUnicodeDecodeError_GetReason (C function): Unicode Exception Objects.
                                                             (line  105)
* PyUnicodeDecodeError_GetStart (C function): Unicode Exception Objects.
                                                             (line   51)
* PyUnicodeDecodeError_SetEnd (C function): Unicode Exception Objects.
                                                             (line   92)
* PyUnicodeDecodeError_SetReason (C function): Unicode Exception Objects.
                                                             (line  112)
* PyUnicodeDecodeError_SetStart (C function): Unicode Exception Objects.
                                                             (line   65)
* PyUnicodeEncodeError_Create (C function): Unicode Exception Objects.
                                                             (line   18)
* PyUnicodeEncodeError_GetEncoding (C function): Unicode Exception Objects.
                                                             (line   37)
* PyUnicodeEncodeError_GetEnd (C function): Unicode Exception Objects.
                                                             (line   78)
* PyUnicodeEncodeError_GetObject (C function): Unicode Exception Objects.
                                                             (line   44)
* PyUnicodeEncodeError_GetReason (C function): Unicode Exception Objects.
                                                             (line  105)
* PyUnicodeEncodeError_GetStart (C function): Unicode Exception Objects.
                                                             (line   51)
* PyUnicodeEncodeError_SetEnd (C function): Unicode Exception Objects.
                                                             (line   92)
* PyUnicodeEncodeError_SetReason (C function): Unicode Exception Objects.
                                                             (line  112)
* PyUnicodeEncodeError_SetStart (C function): Unicode Exception Objects.
                                                             (line   65)
* PyUnicodeObject (C type):              Unicode Type.       (line   29)
* PyUnicodeTranslateError_Create (C function): Unicode Exception Objects.
                                                             (line   27)
* PyUnicodeTranslateError_GetEnd (C function): Unicode Exception Objects.
                                                             (line   78)
* PyUnicodeTranslateError_GetObject (C function): Unicode Exception Objects.
                                                             (line   44)
* PyUnicodeTranslateError_GetReason (C function): Unicode Exception Objects.
                                                             (line  105)
* PyUnicodeTranslateError_GetStart (C function): Unicode Exception Objects.
                                                             (line   51)
* PyUnicodeTranslateError_SetEnd (C function): Unicode Exception Objects.
                                                             (line   92)
* PyUnicodeTranslateError_SetReason (C function): Unicode Exception Objects.
                                                             (line  112)
* PyUnicodeTranslateError_SetStart (C function): Unicode Exception Objects.
                                                             (line   65)
* PyUnicode_1BYTE_DATA (C function):     Unicode Type.       (line   77)
* PyUnicode_1BYTE_KIND (C macro):        Unicode Type.       (line   90)
* PyUnicode_2BYTE_DATA (C function):     Unicode Type.       (line   77)
* PyUnicode_2BYTE_KIND (C macro):        Unicode Type.       (line   90)
* PyUnicode_4BYTE_DATA (C function):     Unicode Type.       (line   77)
* PyUnicode_4BYTE_KIND (C macro):        Unicode Type.       (line   90)
* PyUnicode_AsASCIIString (C function):  ASCII Codecs.       (line   16)
* PyUnicode_AsCharmapString (C function): Character Map Codecs.
                                                             (line   30)
* PyUnicode_AsEncodedString (C function): Generic Codecs.    (line   17)
* PyUnicode_AsLatin1String (C function): Latin-1 Codecs.     (line   17)
* PyUnicode_AsMBCSString (C function):   MBCS codecs for Windows.
                                                             (line   28)
* PyUnicode_AsRawUnicodeEscapeString (C function): Raw-Unicode-Escape Codecs.
                                                             (line   14)
* PyUnicode_AsUCS4 (C function):         Creating and accessing Unicode strings.
                                                             (line  250)
* PyUnicode_AsUCS4Copy (C function):     Creating and accessing Unicode strings.
                                                             (line  260)
* PyUnicode_AsUnicode (C function):      Deprecated Py_UNICODE APIs.
                                                             (line   33)
* PyUnicode_AsUnicodeAndSize (C function): Deprecated Py_UNICODE APIs.
                                                             (line   54)
* PyUnicode_AsUnicodeCopy (C function):  Deprecated Py_UNICODE APIs.
                                                             (line   65)
* PyUnicode_AsUnicodeEscapeString (C function): Unicode-Escape Codecs.
                                                             (line   15)
* PyUnicode_AsUTF16String (C function):  UTF-16 Codecs.      (line   48)
* PyUnicode_AsUTF32String (C function):  UTF-32 Codecs.      (line   47)
* PyUnicode_AsUTF8 (C function):         UTF-8 Codecs.       (line   53)
* PyUnicode_AsUTF8AndSize (C function):  UTF-8 Codecs.       (line   30)
* PyUnicode_AsUTF8String (C function):   UTF-8 Codecs.       (line   25)
* PyUnicode_AsWideChar (C function):     wchar_t Support.    (line   16)
* PyUnicode_AsWideCharString (C function): wchar_t Support.  (line   31)
* PyUnicode_AS_DATA (C function):        Unicode Type.       (line  180)
* PyUnicode_AS_UNICODE (C function):     Unicode Type.       (line  180)
* PyUnicode_Check (C function):          Unicode Type.       (line   48)
* PyUnicode_CheckExact (C function):     Unicode Type.       (line   53)
* PyUnicode_ClearFreeList (C function):  Unicode Type.       (line  156)
* PyUnicode_Compare (C function):        Methods and Slot Functions.
                                                             (line  104)
* PyUnicode_CompareWithASCIIString (C function): Methods and Slot Functions.
                                                             (line  112)
* PyUnicode_Concat (C function):         Methods and Slot Functions.
                                                             (line   12)
* PyUnicode_Contains (C function):       Methods and Slot Functions.
                                                             (line  143)
* PyUnicode_CopyCharacters (C function): Creating and accessing Unicode strings.
                                                             (line  189)
* PyUnicode_Count (C function):          Methods and Slot Functions.
                                                             (line   91)
* PyUnicode_DATA (C function):           Unicode Type.       (line  108)
* PyUnicode_Decode (C function):         Generic Codecs.     (line    8)
* PyUnicode_DecodeASCII (C function):    ASCII Codecs.       (line    9)
* PyUnicode_DecodeCharmap (C function):  Character Map Codecs.
                                                             (line   15)
* PyUnicode_DecodeFSDefault (C function): File System Encoding.
                                                             (line   65)
* PyUnicode_DecodeFSDefaultAndSize (C function): File System Encoding.
                                                             (line   43)
* PyUnicode_DecodeLatin1 (C function):   Latin-1 Codecs.     (line   10)
* PyUnicode_DecodeLocale (C function):   Locale Encoding.    (line   37)
* PyUnicode_DecodeLocaleAndSize (C function): Locale Encoding.
                                                             (line    9)
* PyUnicode_DecodeMBCS (C function):     MBCS codecs for Windows.
                                                             (line   12)
* PyUnicode_DecodeMBCSStateful (C function): MBCS codecs for Windows.
                                                             (line   19)
* PyUnicode_DecodeRawUnicodeEscape (C function): Raw-Unicode-Escape Codecs.
                                                             (line    8)
* PyUnicode_DecodeUnicodeEscape (C function): Unicode-Escape Codecs.
                                                             (line    8)
* PyUnicode_DecodeUTF16 (C function):    UTF-16 Codecs.      (line    8)
* PyUnicode_DecodeUTF16Stateful (C function): UTF-16 Codecs. (line   35)
* PyUnicode_DecodeUTF32 (C function):    UTF-32 Codecs.      (line    8)
* PyUnicode_DecodeUTF32Stateful (C function): UTF-32 Codecs. (line   34)
* PyUnicode_DecodeUTF7 (C function):     UTF-7 Codecs.       (line    8)
* PyUnicode_DecodeUTF7Stateful (C function): UTF-7 Codecs.   (line   15)
* PyUnicode_DecodeUTF8 (C function):     UTF-8 Codecs.       (line    8)
* PyUnicode_DecodeUTF8Stateful (C function): UTF-8 Codecs.   (line   15)
* PyUnicode_Encode (C function):         Generic Codecs.     (line   26)
* PyUnicode_EncodeASCII (C function):    ASCII Codecs.       (line   21)
* PyUnicode_EncodeCharmap (C function):  Character Map Codecs.
                                                             (line   44)
* PyUnicode_EncodeCodePage (C function): MBCS codecs for Windows.
                                                             (line   33)
* PyUnicode_EncodeFSDefault (C function): File System Encoding.
                                                             (line   79)
* PyUnicode_EncodeLatin1 (C function):   Latin-1 Codecs.     (line   23)
* PyUnicode_EncodeLocale (C function):   Locale Encoding.    (line   45)
* PyUnicode_EncodeMBCS (C function):     MBCS codecs for Windows.
                                                             (line   43)
* PyUnicode_EncodeRawUnicodeEscape (C function): Raw-Unicode-Escape Codecs.
                                                             (line   21)
* PyUnicode_EncodeUnicodeEscape (C function): Unicode-Escape Codecs.
                                                             (line   22)
* PyUnicode_EncodeUTF16 (C function):    UTF-16 Codecs.      (line   54)
* PyUnicode_EncodeUTF32 (C function):    UTF-32 Codecs.      (line   53)
* PyUnicode_EncodeUTF7 (C function):     UTF-7 Codecs.       (line   25)
* PyUnicode_EncodeUTF8 (C function):     UTF-8 Codecs.       (line   63)
* PyUnicode_Fill (C function):           Creating and accessing Unicode strings.
                                                             (line  202)
* PyUnicode_Find (C function):           Methods and Slot Functions.
                                                             (line   65)
* PyUnicode_FindChar (C function):       Methods and Slot Functions.
                                                             (line   76)
* PyUnicode_Format (C function):         Methods and Slot Functions.
                                                             (line  138)
* PyUnicode_FromEncodedObject (C function): Creating and accessing Unicode strings.
                                                             (line  166)
* PyUnicode_FromFormat (C function):     Creating and accessing Unicode strings.
                                                             (line   49)
* PyUnicode_FromFormatV (C function):    Creating and accessing Unicode strings.
                                                             (line  159)
* PyUnicode_FromKindAndData (C function): Creating and accessing Unicode strings.
                                                             (line   21)
* PyUnicode_FromObject (C function):     Deprecated Py_UNICODE APIs.
                                                             (line   88)
* PyUnicode_FromString (C function):     Creating and accessing Unicode strings.
                                                             (line   45)
* PyUnicode_FromString():                Dictionary Objects. (line   63)
* PyUnicode_FromStringAndSize (C function): Creating and accessing Unicode strings.
                                                             (line   32)
* PyUnicode_FromUnicode (C function):    Deprecated Py_UNICODE APIs.
                                                             (line   13)
* PyUnicode_FromWideChar (C function):   wchar_t Support.    (line    8)
* PyUnicode_FSConverter (C function):    File System Encoding.
                                                             (line   13)
* PyUnicode_FSDecoder (C function):      File System Encoding.
                                                             (line   30)
* PyUnicode_GetLength (C function):      Creating and accessing Unicode strings.
                                                             (line  183)
* PyUnicode_GetSize (C function):        Deprecated Py_UNICODE APIs.
                                                             (line   80)
* PyUnicode_GET_DATA_SIZE (C function):  Unicode Type.       (line  170)
* PyUnicode_GET_LENGTH (C function):     Unicode Type.       (line   69)
* PyUnicode_GET_SIZE (C function):       Unicode Type.       (line  160)
* PyUnicode_InternFromString (C function): Methods and Slot Functions.
                                                             (line  165)
* PyUnicode_InternInPlace (C function):  Methods and Slot Functions.
                                                             (line  152)
* PyUnicode_Join (C function):           Methods and Slot Functions.
                                                             (line   51)
* PyUnicode_KIND (C function):           Unicode Type.       (line   99)
* PyUnicode_MAX_CHAR_VALUE (C function): Unicode Type.       (line  147)
* PyUnicode_New (C function):            Creating and accessing Unicode strings.
                                                             (line    9)
* PyUnicode_READ (C function):           Unicode Type.       (line  128)
* PyUnicode_ReadChar (C function):       Creating and accessing Unicode strings.
                                                             (line  231)
* PyUnicode_READY (C function):          Unicode Type.       (line   58)
* PyUnicode_READ_CHAR (C function):      Unicode Type.       (line  138)
* PyUnicode_Replace (C function):        Methods and Slot Functions.
                                                             (line   97)
* PyUnicode_RichCompare (C function):    Methods and Slot Functions.
                                                             (line  123)
* PyUnicode_Split (C function):          Methods and Slot Functions.
                                                             (line   17)
* PyUnicode_Splitlines (C function):     Methods and Slot Functions.
                                                             (line   27)
* PyUnicode_Substring (C function):      Creating and accessing Unicode strings.
                                                             (line  241)
* PyUnicode_Tailmatch (C function):      Methods and Slot Functions.
                                                             (line   56)
* PyUnicode_TransformDecimalToASCII (C function): Deprecated Py_UNICODE APIs.
                                                             (line   47)
* PyUnicode_Translate (C function):      Character Map Codecs.
                                                             (line   59)
* PyUnicode_Translate (C function) <1>:  Methods and Slot Functions.
                                                             (line   34)
* PyUnicode_TranslateCharmap (C function): Character Map Codecs.
                                                             (line   72)
* PyUnicode_Type (C variable):           Unicode Type.       (line   40)
* PyUnicode_WCHAR_KIND (C macro):        Unicode Type.       (line   90)
* PyUnicode_WRITE (C function):          Unicode Type.       (line  115)
* PyUnicode_WriteChar (C function):      Creating and accessing Unicode strings.
                                                             (line  217)
* PyVarObject (C type):                  Common Object Structures.
                                                             (line   28)
* PyVarObject.ob_size (C member):        PyVarObject Slots.  (line    6)
* PyVarObject_HEAD_INIT (C macro):       Common Object Structures.
                                                             (line   85)
* PyVectorcall_Call (C function):        PyTypeObject Slots. (line  159)
* PyVectorcall_NARGS (C function):       Object Protocol.    (line  394)
* PyWeakref_Check (C function):          Weak Reference Objects<2>.
                                                             (line   11)
* PyWeakref_CheckProxy (C function):     Weak Reference Objects<2>.
                                                             (line   19)
* PyWeakref_CheckRef (C function):       Weak Reference Objects<2>.
                                                             (line   15)
* PyWeakref_GetObject (C function):      Weak Reference Objects<2>.
                                                             (line   50)
* PyWeakref_GET_OBJECT (C function):     Weak Reference Objects<2>.
                                                             (line   60)
* PyWeakref_NewProxy (C function):       Weak Reference Objects<2>.
                                                             (line   36)
* PyWeakref_NewRef (C function):         Weak Reference Objects<2>.
                                                             (line   23)
* PyWideStringList (C type):             PyWideStringList.   (line    6)
* PyWideStringList.items (C member):     PyWideStringList.   (line   41)
* PyWideStringList.length (C member):    PyWideStringList.   (line   37)
* PyWideStringList_Append (C function):  PyWideStringList.   (line   15)
* PyWideStringList_Insert (C function):  PyWideStringList.   (line   22)
* PyWrapper_New (C function):            Descriptor Objects. (line   43)
* PyZipFile (class in zipfile):          PyZipFile Objects.  (line   10)
* Py_ABS (C macro):                      Useful macros.      (line   21)
* Py_AddPendingCall (C function):        Asynchronous Notifications.
                                                             (line   10)
* Py_AddPendingCall():                   Asynchronous Notifications.
                                                             (line   12)
* Py_AtExit (C function):                Process Control.    (line   24)
* Py_BEGIN_ALLOW_THREADS:                Releasing the GIL from extension code.
                                                             (line   15)
* Py_BEGIN_ALLOW_THREADS (C macro):      High-level API.     (line  158)
* Py_BLOCK_THREADS (C macro):            High-level API.     (line  172)
* Py_buffer (C type):                    Buffer structure.   (line   25)
* Py_buffer.buf (C member):              Buffer structure.   (line   27)
* Py_buffer.format (C member):           Buffer structure.   (line   87)
* Py_buffer.internal (C member):         Buffer structure.   (line  154)
* Py_buffer.itemsize (C member):         Buffer structure.   (line   67)
* Py_buffer.len (C member):              Buffer structure.   (line   50)
* Py_buffer.ndim (C member):             Buffer structure.   (line   96)
* Py_buffer.obj (C member):              Buffer structure.   (line   38)
* Py_buffer.readonly (C member):         Buffer structure.   (line   62)
* Py_buffer.shape (C member):            Buffer structure.   (line  109)
* Py_buffer.strides (C member):          Buffer structure.   (line  122)
* Py_buffer.suboffsets (C member):       Buffer structure.   (line  135)
* Py_BuildValue (C function):            Building values.    (line    6)
* Py_BytesMain (C function):             The Very High Level Layer.
                                                             (line   41)
* Py_BytesWarningFlag (C variable):      Global configuration variables.
                                                             (line   15)
* Py_CHARMASK (C macro):                 Useful macros.      (line   52)
* Py_CLEAR (C function):                 Reference Counting. (line   47)
* py_compile (module):                   py_compile — Compile Python source files.
                                                             (line    6)
* PY_COMPILED (in module imp):           imp — Access the import internals.
                                                             (line  312)
* Py_CompileString (C function):         The Very High Level Layer.
                                                             (line  285)
* Py_CompileString():                    The Very High Level Layer.
                                                             (line  379)
* Py_CompileString() <1>:                The Very High Level Layer.
                                                             (line  384)
* Py_CompileString() <2>:                The Very High Level Layer.
                                                             (line  391)
* Py_CompileStringExFlags (C function):  The Very High Level Layer.
                                                             (line  319)
* Py_CompileStringFlags (C function):    The Very High Level Layer.
                                                             (line  291)
* Py_CompileStringObject (C function):   The Very High Level Layer.
                                                             (line  298)
* Py_complex (C type):                   Complex Numbers as C Structures.
                                                             (line   10)
* Py_DebugFlag (C variable):             Global configuration variables.
                                                             (line   23)
* Py_DecodeLocale (C function):          Operating System Utilities.
                                                             (line  108)
* Py_DECREF (C function):                Reference Counting. (line   20)
* Py_DECREF():                           Reference Counts<2>.
                                                             (line   17)
* Py_DEPRECATED (C macro):               Useful macros.      (line   70)
* Py_DontWriteBytecodeFlag (C variable): Global configuration variables.
                                                             (line   31)
* Py_Ellipsis (C variable):              Ellipsis Object.    (line    6)
* Py_EncodeLocale (C function):          Operating System Utilities.
                                                             (line  161)
* Py_EndInterpreter (C function):        Sub-interpreter support.
                                                             (line   60)
* Py_END_ALLOW_THREADS:                  Releasing the GIL from extension code.
                                                             (line   15)
* Py_END_ALLOW_THREADS (C macro):        High-level API.     (line  165)
* Py_EnterRecursiveCall (C function):    Recursion Control.  (line   11)
* Py_eval_input (C variable):            The Very High Level Layer.
                                                             (line  377)
* Py_Exit (C function):                  Process Control.    (line   15)
* Py_ExitStatusException (C function):   PyStatus.           (line   62)
* Py_False (C variable):                 Boolean Objects.    (line   15)
* Py_FatalError (C function):            Process Control.    (line    6)
* Py_FatalError():                       Process-wide parameters.
                                                             (line  217)
* Py_FdIsInteractive (C function):       Operating System Utilities.
                                                             (line   17)
* Py_file_input (C variable):            The Very High Level Layer.
                                                             (line  382)
* Py_Finalize (C function):              Initializing and finalizing the interpreter.
                                                             (line   78)
* Py_FinalizeEx (C function):            Initializing and finalizing the interpreter.
                                                             (line   39)
* Py_FinalizeEx():                       Process Control.    (line   17)
* Py_FinalizeEx() <1>:                   Process Control.    (line   26)
* Py_FinalizeEx() <2>:                   Initializing and finalizing the interpreter.
                                                             (line    8)
* Py_FinalizeEx() <3>:                   Sub-interpreter support.
                                                             (line   48)
* Py_FinalizeEx() <4>:                   Sub-interpreter support.
                                                             (line   62)
* PY_FROZEN (in module imp):             imp — Access the import internals.
                                                             (line  336)
* Py_FrozenFlag (C variable):            Global configuration variables.
                                                             (line   39)
* Py_GetBuildInfo (C function):          Process-wide parameters.
                                                             (line  203)
* Py_GetCompiler (C function):           Process-wide parameters.
                                                             (line  192)
* Py_GetCopyright (C function):          Process-wide parameters.
                                                             (line  181)
* Py_GETENV (C macro):                   Useful macros.      (line   57)
* Py_GetExecPrefix (C function):         Process-wide parameters.
                                                             (line   71)
* Py_GetExecPrefix():                    Embedding Python<2>.
                                                             (line   42)
* Py_GetPath (C function):               Process-wide parameters.
                                                             (line  118)
* Py_GetPath():                          Embedding Python<2>.
                                                             (line   42)
* Py_GetPath() <1>:                      Process-wide parameters.
                                                             (line   36)
* Py_GetPath() <2>:                      Process-wide parameters.
                                                             (line  133)
* Py_GetPlatform (C function):           Process-wide parameters.
                                                             (line  170)
* Py_GetPrefix (C function):             Process-wide parameters.
                                                             (line   57)
* Py_GetPrefix():                        Embedding Python<2>.
                                                             (line   42)
* Py_GetProgramFullPath (C function):    Process-wide parameters.
                                                             (line  109)
* Py_GetProgramFullPath():               Embedding Python<2>.
                                                             (line   42)
* Py_GetProgramName (C function):        Process-wide parameters.
                                                             (line   51)
* Py_GetPythonHome (C function):         Process-wide parameters.
                                                             (line  281)
* Py_GetVersion (C function):            Process-wide parameters.
                                                             (line  157)
* Py_HashRandomizationFlag (C variable): Global configuration variables.
                                                             (line   46)
* Py_IgnoreEnvironmentFlag (C variable): Global configuration variables.
                                                             (line   54)
* Py_INCREF (C function):                Reference Counting. (line    9)
* Py_INCREF():                           Reference Counts<2>.
                                                             (line   17)
* Py_Initialize (C function):            Initializing and finalizing the interpreter.
                                                             (line    6)
* Py_Initialize():                       Embedding Python<2>.
                                                             (line   12)
* Py_Initialize() <1>:                   Process-wide parameters.
                                                             (line    9)
* Py_Initialize() <2>:                   Process-wide parameters.
                                                             (line   36)
* Py_Initialize() <3>:                   Sub-interpreter support.
                                                             (line   48)
* Py_InitializeEx (C function):          Initializing and finalizing the interpreter.
                                                             (line   26)
* Py_InitializeFromConfig (C function):  Initialization with PyConfig.
                                                             (line    8)
* Py_InspectFlag (C variable):           Global configuration variables.
                                                             (line   61)
* Py_InteractiveFlag (C variable):       Global configuration variables.
                                                             (line   71)
* Py_IsInitialized (C function):         Initializing and finalizing the interpreter.
                                                             (line   32)
* Py_IsInitialized():                    Embedding Python<2>.
                                                             (line   51)
* Py_IsolatedFlag (C variable):          Global configuration variables.
                                                             (line   75)
* Py_LeaveRecursiveCall (C function):    Recursion Control.  (line   29)
* Py_LegacyWindowsFSEncodingFlag (C variable): Global configuration variables.
                                                             (line   85)
* Py_LegacyWindowsStdioFlag (C variable): Global configuration variables.
                                                             (line   97)
* Py_Main (C function):                  The Very High Level Layer.
                                                             (line   24)
* Py_MAX (C macro):                      Useful macros.      (line   33)
* Py_MEMBER_SIZE (C macro):              Useful macros.      (line   46)
* Py_MIN (C macro):                      Useful macros.      (line   27)
* Py_mod_create (C variable):            Multi-phase initialization.
                                                             (line   61)
* Py_mod_exec (C variable):              Multi-phase initialization.
                                                             (line   96)
* Py_NewInterpreter (C function):        Sub-interpreter support.
                                                             (line   23)
* Py_None (C variable):                  The None Object.    (line   11)
* Py_NoSiteFlag (C variable):            Global configuration variables.
                                                             (line  109)
* Py_NotImplemented (C variable):        Object Protocol.    (line    6)
* Py_NoUserSiteDirectory (C variable):   Global configuration variables.
                                                             (line  119)
* py_object (class in ctypes):           Fundamental data types<2>.
                                                             (line  213)
* Py_OptimizeFlag (C variable):          Global configuration variables.
                                                             (line  127)
* Py_PreInitialize (C function):         Preinitialization with PyPreConfig.
                                                             (line    8)
* Py_PreInitializeFromArgs (C function): Preinitialization with PyPreConfig.
                                                             (line   19)
* Py_PreInitializeFromBytesArgs (C function): Preinitialization with PyPreConfig.
                                                             (line   12)
* Py_PRINT_RAW:                          File Objects.       (line   84)
* PY_PYTHON:                             Customizing default Python versions.
                                                             (line   18)
* Py_QuietFlag (C variable):             Global configuration variables.
                                                             (line  132)
* Py_REFCNT (C macro):                   Common Object Structures.
                                                             (line   64)
* Py_ReprEnter (C function):             Recursion Control.  (line   41)
* Py_ReprLeave (C function):             Recursion Control.  (line   59)
* Py_RETURN_FALSE (C macro):             Boolean Objects.    (line   27)
* Py_RETURN_NONE (C macro):              The None Object.    (line   17)
* Py_RETURN_NOTIMPLEMENTED (C macro):    Object Protocol.    (line   11)
* Py_RETURN_RICHCOMPARE (C function):    PyTypeObject Slots. (line  803)
* Py_RETURN_TRUE (C macro):              Boolean Objects.    (line   32)
* Py_RunMain (C function):               Py_RunMain.         (line    6)
* Py_SetPath (C function):               Process-wide parameters.
                                                             (line  131)
* Py_SetPath():                          Process-wide parameters.
                                                             (line  120)
* Py_SetProgramName (C function):        Process-wide parameters.
                                                             (line   34)
* Py_SetProgramName():                   Embedding Python<2>.
                                                             (line   42)
* Py_SetProgramName() <1>:               Initializing and finalizing the interpreter.
                                                             (line    8)
* Py_SetProgramName() <2>:               Process-wide parameters.
                                                             (line   53)
* Py_SetProgramName() <3>:               Process-wide parameters.
                                                             (line  111)
* Py_SetPythonHome (C function):         Process-wide parameters.
                                                             (line  267)
* Py_SetStandardStreamEncoding (C function): Process-wide parameters.
                                                             (line    6)
* Py_single_input (C variable):          The Very High Level Layer.
                                                             (line  389)
* Py_SIZE (C macro):                     Common Object Structures.
                                                             (line   71)
* PY_SOURCE (in module imp):             imp — Access the import internals.
                                                             (line  306)
* PY_SSIZE_T_MAX:                        Integer Objects.    (line  193)
* Py_STRINGIFY (C macro):                Useful macros.      (line   39)
* Py_TPFLAGS_BASETYPE (built-in variable): PyTypeObject Slots.
                                                             (line  502)
* Py_TPFLAGS_BASE_EXC_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  599)
* Py_TPFLAGS_BYTES_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  593)
* Py_TPFLAGS_DEFAULT (built-in variable): PyTypeObject Slots.
                                                             (line  551)
* Py_TPFLAGS_DICT_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  597)
* Py_TPFLAGS_HAVE_FINALIZE (built-in variable): PyTypeObject Slots.
                                                             (line  612)
* Py_TPFLAGS_HAVE_GC (built-in variable): PyTypeObject Slots.
                                                             (line  530)
* Py_TPFLAGS_HEAPTYPE (built-in variable): PyTypeObject Slots.
                                                             (line  487)
* Py_TPFLAGS_LIST_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  589)
* Py_TPFLAGS_LONG_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  587)
* Py_TPFLAGS_METHOD_DESCRIPTOR (built-in variable): PyTypeObject Slots.
                                                             (line  563)
* Py_TPFLAGS_READY (built-in variable):  PyTypeObject Slots. (line  512)
* Py_TPFLAGS_READYING (built-in variable): PyTypeObject Slots.
                                                             (line  521)
* Py_TPFLAGS_TUPLE_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  591)
* Py_TPFLAGS_TYPE_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  601)
* Py_TPFLAGS_UNICODE_SUBCLASS (built-in variable): PyTypeObject Slots.
                                                             (line  595)
* Py_tracefunc (C type):                 Profiling and Tracing.
                                                             (line   18)
* Py_True (C variable):                  Boolean Objects.    (line   21)
* Py_tss_NEEDS_INIT (C macro):           Thread Specific Storage TSS API.
                                                             (line   28)
* Py_tss_t (C type):                     Thread Specific Storage TSS API.
                                                             (line   17)
* Py_TYPE (C macro):                     Common Object Structures.
                                                             (line   57)
* Py_UCS1 (C type):                      Unicode Type.       (line    9)
* Py_UCS2 (C type):                      Unicode Type.       (line    9)
* Py_UCS4 (C type):                      Unicode Type.       (line    9)
* Py_UNBLOCK_THREADS (C macro):          High-level API.     (line  178)
* Py_UnbufferedStdioFlag (C variable):   Global configuration variables.
                                                             (line  141)
* Py_UNICODE (C type):                   Unicode Type.       (line   20)
* Py_UNICODE_ISALNUM (C function):       Unicode Character Properties.
                                                             (line   52)
* Py_UNICODE_ISALPHA (C function):       Unicode Character Properties.
                                                             (line   47)
* Py_UNICODE_ISDECIMAL (C function):     Unicode Character Properties.
                                                             (line   35)
* Py_UNICODE_ISDIGIT (C function):       Unicode Character Properties.
                                                             (line   39)
* Py_UNICODE_ISLINEBREAK (C function):   Unicode Character Properties.
                                                             (line   30)
* Py_UNICODE_ISLOWER (C function):       Unicode Character Properties.
                                                             (line   15)
* Py_UNICODE_ISNUMERIC (C function):     Unicode Character Properties.
                                                             (line   43)
* Py_UNICODE_ISPRINTABLE (C function):   Unicode Character Properties.
                                                             (line   57)
* Py_UNICODE_ISSPACE (C function):       Unicode Character Properties.
                                                             (line   10)
* Py_UNICODE_ISTITLE (C function):       Unicode Character Properties.
                                                             (line   25)
* Py_UNICODE_ISUPPER (C function):       Unicode Character Properties.
                                                             (line   20)
* Py_UNICODE_IS_HIGH_SURROGATE (C macro): Unicode Character Properties.
                                                             (line  114)
* Py_UNICODE_IS_LOW_SURROGATE (C macro): Unicode Character Properties.
                                                             (line  118)
* Py_UNICODE_IS_SURROGATE (C macro):     Unicode Character Properties.
                                                             (line  110)
* Py_UNICODE_JOIN_SURROGATES (C macro):  Unicode Character Properties.
                                                             (line  122)
* Py_UNICODE_TODECIMAL (C function):     Unicode Character Properties.
                                                             (line   91)
* Py_UNICODE_TODIGIT (C function):       Unicode Character Properties.
                                                             (line   97)
* Py_UNICODE_TOLOWER (C function):       Unicode Character Properties.
                                                             (line   70)
* Py_UNICODE_TONUMERIC (C function):     Unicode Character Properties.
                                                             (line  103)
* Py_UNICODE_TOTITLE (C function):       Unicode Character Properties.
                                                             (line   84)
* Py_UNICODE_TOUPPER (C function):       Unicode Character Properties.
                                                             (line   77)
* Py_UNREACHABLE (C macro):              Useful macros.      (line   11)
* Py_UNUSED (C macro):                   Useful macros.      (line   62)
* Py_VaBuildValue (C function):          Building values.    (line  200)
* PY_VECTORCALL_ARGUMENTS_OFFSET (C variable): Object Protocol.
                                                             (line  380)
* Py_VerboseFlag (C variable):           Global configuration variables.
                                                             (line  148)
* Py_VISIT (C function):                 Supporting Cyclic Garbage Collection.
                                                             (line  117)
* Py_XDECREF (C function):               Reference Counting. (line   40)
* Py_XDECREF():                          Exceptions<18>.     (line   77)
* Py_XINCREF (C function):               Reference Counting. (line   15)
* P_ALL (in module os):                  Process Management. (line  708)
* P_DETACH (in module os):               Process Management. (line  573)
* P_NOWAIT (in module os):               Process Management. (line  553)
* P_NOWAITO (in module os):              Process Management. (line  553)
* P_OVERLAY (in module os):              Process Management. (line  573)
* P_PGID (in module os):                 Process Management. (line  708)
* P_PID (in module os):                  Process Management. (line  708)
* P_WAIT (in module os):                 Process Management. (line  563)
* qiflush() (in module curses):          Functions<3>.       (line  379)
* QName (class in xml.etree.ElementTree): QName Objects.     (line    6)
* qsize() (asyncio.Queue method):        Queue.              (line   74)
* qsize() (multiprocessing.Queue method): Pipes and Queues.  (line   98)
* qsize() (queue.Queue method):          Queue Objects.      (line    9)
* qsize() (queue.SimpleQueue method):    SimpleQueue Objects.
                                                             (line    9)
* qualified name:                        Glossary.           (line 1065)
* quantiles() (in module statistics):    Function details.   (line  400)
* quantiles() (statistics.NormalDist method): NormalDist objects.
                                                             (line  103)
* quantize() (decimal.Context method):   Context objects.    (line  455)
* quantize() (decimal.Decimal method):   Decimal objects.    (line  462)
* QueryInfoKey() (in module winreg):     Functions<11>.      (line  323)
* QueryReflectionKey() (in module winreg): Functions<11>.    (line  520)
* QueryValue() (in module winreg):       Functions<11>.      (line  352)
* QueryValueEx() (in module winreg):     Functions<11>.      (line  372)
* Queue (class in asyncio):              Queue.              (line    6)
* Queue (class in multiprocessing):      Pipes and Queues.   (line   84)
* Queue (class in queue):                queue — A synchronized queue class.
                                                             (line   34)
* queue (module):                        queue — A synchronized queue class.
                                                             (line    6)
* queue (sched.scheduler attribute):     Scheduler Objects.  (line   74)
* Queue() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  176)
* QueueEmpty:                            Exceptions<8>.      (line    6)
* QueueFull:                             Exceptions<8>.      (line   11)
* QueueHandler (class in logging.handlers): QueueHandler.    (line   21)
* QueueListener (class in logging.handlers): QueueListener.  (line   25)
* quick_ratio() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line  202)
* quit (built-in variable):              Constants added by the site module.
                                                             (line   11)
* quit (pdb command):                    Debugger Commands.  (line  324)
* quit() (ftplib.FTP method):            FTP Objects.        (line  237)
* quit() (nntplib.NNTP method):          Methods<3>.         (line   22)
* quit() (poplib.POP3 method):           POP3 Objects.       (line   82)
* quit() (smtplib.SMTP method):          SMTP Objects.       (line  344)
* quopri (module):                       quopri — Encode and decode MIME quoted-printable data.
                                                             (line    6)
* quote() (in module email.utils):       email utils Miscellaneous utilities.
                                                             (line   47)
* quote() (in module shlex):             shlex — Simple lexical analysis.
                                                             (line   42)
* quote() (in module urllib.parse):      URL Quoting.        (line   13)
* quoteattr() (in module xml.sax.saxutils): xml sax saxutils — SAX Utilities.
                                                             (line   34)
* quotechar (csv.Dialect attribute):     Dialects and Formatting Parameters.
                                                             (line   52)
* quoted-printable; encoding:            quopri — Encode and decode MIME quoted-printable data.
                                                             (line    8)
* quotes (shlex.shlex attribute):        shlex Objects.      (line  115)
* QUOTE_ALL (in module csv):             Module Contents<3>. (line  230)
* quote_from_bytes() (in module urllib.parse): URL Quoting.  (line   52)
* QUOTE_MINIMAL (in module csv):         Module Contents<3>. (line  234)
* QUOTE_NONE (in module csv):            Module Contents<3>. (line  248)
* QUOTE_NONNUMERIC (in module csv):      Module Contents<3>. (line  240)
* quote_plus() (in module urllib.parse): URL Quoting.        (line   41)
* quoting (csv.Dialect attribute):       Dialects and Formatting Parameters.
                                                             (line   58)
* r"; raw string literal:                String and Bytes literals.
                                                             (line   48)
* r’; raw string literal:                String and Bytes literals.
                                                             (line   48)
* radians() (in module math):            Angular conversion. (line   10)
* radians() (in module turtle):          Settings for measurement.
                                                             (line   16)
* RadioButtonGroup (class in msilib):    GUI classes.        (line   29)
* radiogroup() (msilib.Dialog method):   GUI classes.        (line   73)
* radix() (decimal.Context method):      Context objects.    (line  460)
* radix() (decimal.Decimal method):      Decimal objects.    (line  490)
* RADIXCHAR (in module locale):          locale — Internationalization services.
                                                             (line  231)
* raise (2to3 fixer):                    Fixers.             (line  260)
* raise an exception:                    Exceptions<2>.      (line    6)
* raise_on_defect (email.policy.Policy attribute): email policy Policy Objects.
                                                             (line  158)
* raise_signal() (in module signal):     Module contents<2>. (line  167)
* RAISE_VARARGS (opcode):                Python Bytecode Instructions.
                                                             (line  756)
* raising; exception:                    The raise statement.
                                                             (line    6)
* randbelow() (in module secrets):       Random numbers.     (line   19)
* randbits() (in module secrets):        Random numbers.     (line   23)
* randint() (in module random):          Functions for integers.
                                                             (line   23)
* Random (class in random):              Alternative Generator.
                                                             (line    6)
* random (module):                       random — Generate pseudo-random numbers.
                                                             (line    6)
* random() (in module random):           Real-valued distributions.
                                                             (line   11)
* randrange() (in module random):        Functions for integers.
                                                             (line    6)
* RAND_add() (in module ssl):            Random generation.  (line   66)
* RAND_bytes() (in module ssl):          Random generation.  (line    6)
* RAND_egd() (in module ssl):            Random generation.  (line   50)
* RAND_pseudo_bytes() (in module ssl):   Random generation.  (line   23)
* RAND_status() (in module ssl):         Random generation.  (line   43)
* range (built-in class):                Ranges.             (line   10)
* RARROW (in module token):              token — Constants used with Python parse trees.
                                                             (line  230)
* ratecv() (in module audioop):          audioop — Manipulate raw audio data.
                                                             (line  174)
* ratio() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line  178)
* Rational (class in numbers):           The numeric tower.  (line   41)
* raw (io.BufferedIOBase attribute):     I/O Base Classes.   (line  249)
* raw string:                            String and Bytes literals.
                                                             (line   36)
* raw() (in module curses):              Functions<3>.       (line  386)
* raw() (pickle.PickleBuffer method):    Module Interface.   (line  316)
* RawArray() (in module multiprocessing.sharedctypes): The multiprocessing sharedctypes module.
                                                             (line   16)
* RawConfigParser (class in configparser): RawConfigParser Objects.
                                                             (line    6)
* RawDescriptionHelpFormatter (class in argparse): formatter_class.
                                                             (line   10)
* RawIOBase (class in io):               I/O Base Classes.   (line  170)
* RawPen (class in turtle):              Public classes.     (line    6)
* RawTextHelpFormatter (class in argparse): formatter_class. (line   10)
* RawTurtle (class in turtle):           Public classes.     (line    6)
* RawValue() (in module multiprocessing.sharedctypes): The multiprocessing sharedctypes module.
                                                             (line   33)
* raw_data_manager (in module email.contentmanager): Content Manager Instances.
                                                             (line   11)
* raw_decode() (json.JSONDecoder method): Encoders and Decoders.
                                                             (line   93)
* raw_input (2to3 fixer):                Fixers.             (line  267)
* raw_input() (code.InteractiveConsole method): Interactive Console Objects.
                                                             (line   44)
* RBRACE (in module token):              token — Constants used with Python parse trees.
                                                             (line  130)
* rcpttos (smtpd.SMTPChannel attribute): SMTPChannel Objects.
                                                             (line   79)
* re (module):                           re — Regular expression operations.
                                                             (line    6)
* re (re.Match attribute):               Match Objects.      (line  191)
* read() (asyncio.StreamReader method):  StreamReader.       (line   15)
* read() (chunk.Chunk method):           chunk — Read IFF chunked data.
                                                             (line  105)
* read() (codecs.StreamReader method):   StreamReader Objects.
                                                             (line   34)
* read() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  113)
* read() (http.client.HTTPResponse method): HTTPResponse Objects.
                                                             (line   13)
* read() (imaplib.IMAP4 method):         IMAP4 Objects.      (line  192)
* read() (in module os):                 File Descriptor Operations.
                                                             (line  546)
* read() (io.BufferedIOBase method):     I/O Base Classes.   (line  270)
* read() (io.BufferedReader method):     Buffered Streams.   (line   80)
* read() (io.RawIOBase method):          I/O Base Classes.   (line  183)
* read() (io.TextIOBase method):         Text I/O<2>.        (line   52)
* read() (mimetypes.MimeTypes method):   MimeTypes Objects.  (line   70)
* read() (mmap.mmap method):             mmap — Memory-mapped file support.
                                                             (line  190)
* read() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line   32)
* read() (ssl.MemoryBIO method):         Memory BIO Support<2>.
                                                             (line  142)
* read() (ssl.SSLSocket method):         SSL Sockets.        (line   71)
* read() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   25)
* read() (zipfile.ZipFile method):       ZipFile Objects.    (line  215)
* read1() (io.BufferedIOBase method):    I/O Base Classes.   (line  287)
* read1() (io.BufferedReader method):    Buffered Streams.   (line   86)
* read1() (io.BytesIO method):           Buffered Streams.   (line   43)
* READABLE (in module tkinter):          File Handlers.      (line   36)
* readable() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  162)
* readable() (io.IOBase method):         I/O Base Classes.   (line   79)
* readall() (io.RawIOBase method):       I/O Base Classes.   (line  198)
* reader() (in module csv):              Module Contents<3>. (line    8)
* ReadError:                             tarfile — Read and write tar archive files.
                                                             (line  186)
* readexactly() (asyncio.StreamReader method): StreamReader. (line   34)
* readfp() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  300)
* readfp() (mimetypes.MimeTypes method): MimeTypes Objects.  (line   78)
* readframes() (aifc.aifc method):       aifc — Read and write AIFF and AIFC files.
                                                             (line   97)
* readframes() (sunau.AU_read method):   AU_read Objects.    (line   47)
* readframes() (wave.Wave_read method):  Wave_read Objects.  (line   46)
* readinto() (http.client.HTTPResponse method): HTTPResponse Objects.
                                                             (line   17)
* readinto() (io.BufferedIOBase method): I/O Base Classes.   (line  298)
* readinto() (io.RawIOBase method):      I/O Base Classes.   (line  203)
* readinto1() (io.BufferedIOBase method): I/O Base Classes.  (line  311)
* readinto1() (io.BytesIO method):       Buffered Streams.   (line   49)
* readline (module):                     readline — GNU readline interface.
                                                             (line    6)
* readline() (asyncio.StreamReader method): StreamReader.    (line   23)
* readline() (codecs.StreamReader method): StreamReader Objects.
                                                             (line   60)
* readline() (distutils.text_file.TextFile method): distutils text_file — The TextFile class.
                                                             (line  111)
* readline() (imaplib.IMAP4 method):     IMAP4 Objects.      (line  197)
* readline() (io.IOBase method):         I/O Base Classes.   (line   84)
* readline() (io.TextIOBase method):     Text I/O<2>.        (line   58)
* readline() (mmap.mmap method):         mmap — Memory-mapped file support.
                                                             (line  205)
* readlines() (codecs.StreamReader method): StreamReader Objects.
                                                             (line   71)
* readlines() (distutils.text_file.TextFile method): distutils text_file — The TextFile class.
                                                             (line  124)
* readlines() (io.IOBase method):        I/O Base Classes.   (line   93)
* readlink() (in module os):             Files and Directories.
                                                             (line  546)
* readmodule() (in module pyclbr):       pyclbr — Python class browser support.
                                                             (line   19)
* readmodule_ex() (in module pyclbr):    pyclbr — Python class browser support.
                                                             (line   28)
* READONLY:                              Generic Attribute Management.
                                                             (line   79)
* readonly (memoryview attribute):       Memory Views.       (line  407)
* readPlist() (in module plistlib):      plistlib — Generate and parse Mac OS X plist files.
                                                             (line  126)
* readPlistFromBytes() (in module plistlib): plistlib — Generate and parse Mac OS X plist files.
                                                             (line  149)
* ReadTransport (class in asyncio):      Transports Hierarchy.
                                                             (line   20)
* readuntil() (asyncio.StreamReader method): StreamReader.   (line   43)
* readv() (in module os):                File Descriptor Operations.
                                                             (line  627)
* ready() (multiprocessing.pool.AsyncResult method): Process Pools.
                                                             (line  197)
* read_all() (telnetlib.Telnet method):  Telnet Objects.     (line   17)
* read_binary() (in module importlib.resources): importlib resources – Resources.
                                                             (line   80)
* read_byte() (mmap.mmap method):        mmap — Memory-mapped file support.
                                                             (line  200)
* read_bytes() (pathlib.Path method):    Methods<2>.         (line  256)
* read_bytes() (zipfile.Path method):    Path Objects.       (line   53)
* read_dict() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  172)
* read_eager() (telnetlib.Telnet method): Telnet Objects.    (line   35)
* read_environ() (in module wsgiref.handlers): wsgiref handlers – server/gateway base classes.
                                                             (line  305)
* read_events() (xml.etree.ElementTree.XMLPullParser method): XMLPullParser Objects.
                                                             (line   29)
* read_file() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  150)
* read_history_file() (in module readline): History file.    (line    8)
* read_init_file() (in module readline): Init file.          (line   13)
* read_lazy() (telnetlib.Telnet method): Telnet Objects.     (line   43)
* read_mime_types() (in module mimetypes): mimetypes — Map filenames to MIME types.
                                                             (line   99)
* READ_RESTRICTED:                       Generic Attribute Management.
                                                             (line   79)
* read_sb_data() (telnetlib.Telnet method): Telnet Objects.  (line   59)
* read_some() (telnetlib.Telnet method): Telnet Objects.     (line   21)
* read_string() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  162)
* read_text() (in module importlib.resources): importlib resources – Resources.
                                                             (line   91)
* read_text() (pathlib.Path method):     Methods<2>.         (line  269)
* read_text() (zipfile.Path method):     Path Objects.       (line   47)
* read_token() (shlex.shlex method):     shlex Objects.      (line   20)
* read_until() (telnetlib.Telnet method): Telnet Objects.    (line    8)
* read_very_eager() (telnetlib.Telnet method): Telnet Objects.
                                                             (line   27)
* read_very_lazy() (telnetlib.Telnet method): Telnet Objects.
                                                             (line   51)
* read_windows_registry() (mimetypes.MimeTypes method): MimeTypes Objects.
                                                             (line   86)
* Real (class in numbers):               The numeric tower.  (line   28)
* real (numbers.Complex attribute):      The numeric tower.  (line   15)
* Real Media File Format:                chunk — Read IFF chunked data.
                                                             (line    8)
* realloc():                             Overview<3>.        (line   33)
* realpath() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  295)
* REALTIME_PRIORITY_CLASS (in module subprocess): Windows Constants.
                                                             (line   87)
* real_max_memuse (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  127)
* real_quick_ratio() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line  207)
* reap_children() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  762)
* reap_threads() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  630)
* reason (http.client.HTTPResponse attribute): HTTPResponse Objects.
                                                             (line   55)
* reason (ssl.SSLError attribute):       Exceptions<12>.     (line   27)
* reason (UnicodeError attribute):       Concrete exceptions.
                                                             (line  346)
* reason (urllib.error.HTTPError attribute): urllib error — Exception classes raised by urllib request.
                                                             (line   45)
* reason (urllib.error.URLError attribute): urllib error — Exception classes raised by urllib request.
                                                             (line   22)
* reattach() (tkinter.ttk.Treeview method): ttk Treeview.    (line  247)
* rebinding; name:                       Assignment statements.
                                                             (line    6)
* reccontrols() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   51)
* received_data (smtpd.SMTPChannel attribute): SMTPChannel Objects.
                                                             (line   84)
* received_lines (smtpd.SMTPChannel attribute): SMTPChannel Objects.
                                                             (line   57)
* recent() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  202)
* reconfigure() (io.TextIOWrapper method): Text I/O<2>.      (line  173)
* records (unittest.TestCase attribute): Test cases.         (line  408)
* record_original_stdout() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  362)
* rect() (in module cmath):              Conversions to and from polar coordinates.
                                                             (line   48)
* rectangle() (in module curses.textpad): curses textpad — Text input widget for curses programs.
                                                             (line   15)
* RecursionError:                        Concrete exceptions.
                                                             (line  187)
* recursive_repr() (in module reprlib):  reprlib — Alternate repr implementation.
                                                             (line   41)
* recv() (asyncore.dispatcher method):   asyncore — Asynchronous socket handler.
                                                             (line  202)
* recv() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   24)
* recv() (socket.socket method):         Socket Objects.     (line  219)
* recvfrom() (socket.socket method):     Socket Objects.     (line  236)
* recvfrom_into() (socket.socket method): Socket Objects.    (line  343)
* recvmsg() (socket.socket method):      Socket Objects.     (line  254)
* recvmsg_into() (socket.socket method): Socket Objects.     (line  316)
* recv_bytes() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   65)
* recv_bytes_into() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   79)
* recv_into() (socket.socket method):    Socket Objects.     (line  353)
* redirect_request() (urllib.request.HTTPRedirectHandler method): HTTPRedirectHandler Objects.
                                                             (line   15)
* redirect_stderr() (in module contextlib): Utilities.       (line  180)
* redirect_stdout() (in module contextlib): Utilities.       (line  147)
* redisplay() (in module readline):      Line buffer.        (line   19)
* redrawln() (curses.window method):     Window Objects.     (line  459)
* redrawwin() (curses.window method):    Window Objects.     (line  465)
* reduce (2to3 fixer):                   Fixers.             (line  271)
* reduce() (in module functools):        functools — Higher-order functions and operations on callable objects.
                                                             (line  292)
* reducer_override() (pickle.Pickler method): Module Interface.
                                                             (line  199)
* ref (class in weakref):                weakref — Weak references.
                                                             (line   85)
* refcount_test() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  623)
* reference count:                       Glossary.           (line 1080)
* reference counting:                    Objects values and types.
                                                             (line   37)
* ReferenceError:                        Concrete exceptions.
                                                             (line  196)
* ReferenceError <1>:                    weakref — Weak references.
                                                             (line  322)
* ReferenceType (in module weakref):     weakref — Weak references.
                                                             (line  304)
* refold_source (email.policy.EmailPolicy attribute): email policy Policy Objects.
                                                             (line  349)
* refresh() (curses.window method):      Window Objects.     (line  470)
* register() (abc.ABCMeta method):       abc — Abstract Base Classes.
                                                             (line   63)
* register() (in module atexit):         atexit — Exit handlers.
                                                             (line   22)
* register() (in module codecs):         codecs — Codec registry and base classes.
                                                             (line  150)
* register() (in module faulthandler):   Dumping the traceback on a user signal.
                                                             (line    6)
* register() (in module webbrowser):     webbrowser — Convenient Web-browser controller.
                                                             (line   83)
* register() (multiprocessing.managers.BaseManager method): Managers.
                                                             (line   70)
* register() (select.devpoll method):    /dev/poll Polling Objects.
                                                             (line   30)
* register() (select.epoll method):      Edge and Level Trigger Polling epoll Objects.
                                                             (line   81)
* register() (select.poll method):       Polling Objects.    (line   15)
* register() (selectors.BaseSelector method): Classes<3>.    (line   60)
* registerDOMImplementation() (in module xml.dom): Module Contents<4>.
                                                             (line    8)
* registerResult() (in module unittest): Signal Handling.    (line   34)
* register_adapter() (in module sqlite3): Module functions and constants.
                                                             (line  136)
* register_archive_format() (in module shutil): Archiving operations.
                                                             (line   78)
* register_at_fork() (in module os):     Process Management. (line  441)
* register_converter() (in module sqlite3): Module functions and constants.
                                                             (line  127)
* register_defect() (email.policy.Policy method): email policy Policy Objects.
                                                             (line  207)
* register_dialect() (in module csv):    Module Contents<3>. (line   70)
* register_error() (in module codecs):   Error Handlers.     (line   88)
* register_function() (xmlrpc.server.CGIXMLRPCRequestHandler method): CGIXMLRPCRequestHandler.
                                                             (line    9)
* register_function() (xmlrpc.server.SimpleXMLRPCServer method): SimpleXMLRPCServer Objects.
                                                             (line   10)
* register_instance() (xmlrpc.server.CGIXMLRPCRequestHandler method): CGIXMLRPCRequestHandler.
                                                             (line   26)
* register_instance() (xmlrpc.server.SimpleXMLRPCServer method): SimpleXMLRPCServer Objects.
                                                             (line   27)
* register_introspection_functions() (xmlrpc.server.CGIXMLRPCRequestHandler method): CGIXMLRPCRequestHandler.
                                                             (line   41)
* register_introspection_functions() (xmlrpc.server.SimpleXMLRPCServer method): SimpleXMLRPCServer Objects.
                                                             (line   55)
* register_multicall_functions() (xmlrpc.server.CGIXMLRPCRequestHandler method): CGIXMLRPCRequestHandler.
                                                             (line   46)
* register_multicall_functions() (xmlrpc.server.SimpleXMLRPCServer method): SimpleXMLRPCServer Objects.
                                                             (line   60)
* register_namespace() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  175)
* register_optionflag() (in module doctest): Option Flags.   (line  163)
* register_shape() (in module turtle):   Settings and special methods.
                                                             (line   56)
* register_unpack_format() (in module shutil): Archiving operations.
                                                             (line  120)
* regular package:                       Glossary.           (line 1088)
* REG_BINARY (in module winreg):         Value Types.        (line    8)
* REG_DWORD (in module winreg):          Value Types.        (line   12)
* REG_DWORD_BIG_ENDIAN (in module winreg): Value Types.      (line   21)
* REG_DWORD_LITTLE_ENDIAN (in module winreg): Value Types.   (line   16)
* REG_EXPAND_SZ (in module winreg):      Value Types.        (line   25)
* REG_FULL_RESOURCE_DESCRIPTOR (in module winreg): Value Types.
                                                             (line   60)
* REG_LINK (in module winreg):           Value Types.        (line   30)
* REG_MULTI_SZ (in module winreg):       Value Types.        (line   34)
* REG_NONE (in module winreg):           Value Types.        (line   39)
* REG_QWORD (in module winreg):          Value Types.        (line   43)
* REG_QWORD_LITTLE_ENDIAN (in module winreg): Value Types.   (line   49)
* REG_RESOURCE_LIST (in module winreg):  Value Types.        (line   56)
* REG_RESOURCE_REQUIREMENTS_LIST (in module winreg): Value Types.
                                                             (line   64)
* REG_SZ (in module winreg):             Value Types.        (line   68)
* relative; import:                      The import statement.
                                                             (line   98)
* relative; URL:                         urllib parse — Parse URLs into components.
                                                             (line    8)
* relative_to() (pathlib.PurePath method): Methods and properties.
                                                             (line  240)
* release() (asyncio.Condition method):  Condition.          (line   68)
* release() (asyncio.Lock method):       Lock.               (line   39)
* release() (asyncio.Semaphore method):  Semaphore.          (line   44)
* release() (in module platform):        Cross Platform.     (line  115)
* release() (logging.Handler method):    Handler Objects.    (line   31)
* release() (memoryview method):         Memory Views.       (line  230)
* release() (multiprocessing.Lock method): Synchronization primitives.
                                                             (line   92)
* release() (multiprocessing.RLock method): Synchronization primitives.
                                                             (line  148)
* release() (pickle.PickleBuffer method): Module Interface.  (line  324)
* release() (threading.Condition method): Condition Objects. (line   79)
* release() (threading.Lock method):     Lock Objects.       (line   73)
* release() (threading.RLock method):    RLock Objects.      (line   66)
* release() (threading.Semaphore method): Semaphore Objects. (line   63)
* release() (_thread.lock method):       _thread — Low-level threading API.
                                                             (line  151)
* releasebufferproc (C type):            Slot Type typedefs. (line  107)
* release_lock() (in module imp):        imp — Access the import internals.
                                                             (line  292)
* reload (2to3 fixer):                   Fixers.             (line  275)
* reload() (in module imp):              imp — Access the import internals.
                                                             (line  132)
* reload() (in module importlib):        Functions<10>.      (line   73)
* relpath() (in module os.path):         os path — Common pathname manipulations.
                                                             (line  310)
* remainder() (decimal.Context method):  Context objects.    (line  464)
* remainder() (in module math):          Number-theoretic and representation functions.
                                                             (line  205)
* remainder_near() (decimal.Context method): Context objects.
                                                             (line  471)
* remainder_near() (decimal.Decimal method): Decimal objects.
                                                             (line  496)
* RemoteDisconnected:                    http client — HTTP protocol client.
                                                             (line  181)
* remove() (array.array method):         array — Efficient arrays of numeric values.
                                                             (line  210)
* remove() (collections.deque method):   deque objects.      (line   97)
* remove() (frozenset method):           Set Types — set frozenset.
                                                             (line  188)
* remove() (in module os):               Files and Directories.
                                                             (line  584)
* remove() (mailbox.Mailbox method):     Mailbox objects.    (line   76)
* remove() (mailbox.MH method):          MH.                 (line   76)
* remove() (sequence method):            Mutable Sequence Types.
                                                             (line   16)
* remove() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line  180)
* removeAttribute() (xml.dom.Element method): Element Objects<2>.
                                                             (line   52)
* removeAttributeNode() (xml.dom.Element method): Element Objects<2>.
                                                             (line   57)
* removeAttributeNS() (xml.dom.Element method): Element Objects<2>.
                                                             (line   62)
* removeChild() (xml.dom.Node method):   Node Objects.       (line  128)
* removedirs() (in module os):           Files and Directories.
                                                             (line  604)
* removeFilter() (logging.Handler method): Handler Objects.  (line   56)
* removeFilter() (logging.Logger method): Logger Objects.    (line  250)
* removeHandler() (in module unittest):  Signal Handling.    (line   51)
* removeHandler() (logging.Logger method): Logger Objects.   (line  267)
* removeResult() (in module unittest):   Signal Handling.    (line   45)
* removexattr() (in module os):          Linux extended attributes.
                                                             (line   35)
* remove_child_handler() (asyncio.AbstractChildWatcher method): Process Watchers.
                                                             (line   52)
* remove_done_callback() (asyncio.Future method): Future Object.
                                                             (line   99)
* remove_done_callback() (asyncio.Task method): Task Object. (line  126)
* remove_flag() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   84)
* remove_flag() (mailbox.mboxMessage method): mboxMessage.   (line   85)
* remove_flag() (mailbox.MMDFMessage method): MMDFMessage.   (line   84)
* remove_folder() (mailbox.Maildir method): Maildir.         (line   75)
* remove_folder() (mailbox.MH method):   MH.                 (line   47)
* remove_header() (urllib.request.Request method): Request Objects.
                                                             (line   99)
* remove_history_item() (in module readline): History list.  (line   26)
* remove_label() (mailbox.BabylMessage method): BabylMessage.
                                                             (line   59)
* remove_option() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  266)
* remove_option() (optparse.OptionParser method): Querying and manipulating your option parser.
                                                             (line   47)
* remove_pyc() (msilib.Directory method): Directory Objects. (line   45)
* remove_reader() (asyncio.loop method): Watching file descriptors.
                                                             (line   12)
* remove_section() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  273)
* remove_sequence() (mailbox.MHMessage method): MHMessage.   (line   46)
* remove_signal_handler() (asyncio.loop method): Unix signals.
                                                             (line   26)
* remove_tree() (in module distutils.dir_util): distutils dir_util — Directory tree operations.
                                                             (line   60)
* remove_writer() (asyncio.loop method): Watching file descriptors.
                                                             (line   25)
* rename() (ftplib.FTP method):          FTP Objects.        (line  202)
* rename() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  207)
* rename() (in module os):               Files and Directories.
                                                             (line  618)
* rename() (pathlib.Path method):        Methods<2>.         (line  284)
* renames (2to3 fixer):                  Fixers.             (line  279)
* renames() (in module os):              Files and Directories.
                                                             (line  649)
* reopenIfNeeded() (logging.handlers.WatchedFileHandler method): WatchedFileHandler.
                                                             (line   37)
* reorganize() (dbm.gnu.gdbm method):    dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line  104)
* repeat() (in module itertools):        Itertool functions. (line  490)
* repeat() (in module timeit):           Python Interface.   (line   18)
* repeat() (timeit.Timer method):        Python Interface.   (line  108)
* repetition; operation:                 Common Sequence Operations.
                                                             (line   21)
* replace() (bytearray method):          Bytes and Bytearray Operations.
                                                             (line  145)
* replace() (bytes method):              Bytes and Bytearray Operations.
                                                             (line  145)
* replace() (curses.panel.Panel method): Panel Objects.      (line   39)
* replace() (datetime.date method):      date Objects.       (line  166)
* replace() (datetime.datetime method):  datetime Objects.   (line  414)
* replace() (datetime.time method):      time Objects.       (line  139)
* replace() (in module dataclasses):     Module-level decorators classes and functions.
                                                             (line  296)
* replace() (in module os):              Files and Directories.
                                                             (line  664)
* replace() (inspect.Parameter method):  Introspecting callables with the Signature object.
                                                             (line  215)
* replace() (inspect.Signature method):  Introspecting callables with the Signature object.
                                                             (line   98)
* replace() (pathlib.Path method):       Methods<2>.         (line  304)
* replace() (str method):                String Methods<2>.  (line  339)
* replaceChild() (xml.dom.Node method):  Node Objects.       (line  135)
* ReplacePackage() (in module modulefinder): modulefinder — Find modules used by a script.
                                                             (line   21)
* replace_errors() (in module codecs):   Error Handlers.     (line  133)
* replace_header() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  298)
* replace_header() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  396)
* replace_history_item() (in module readline): History list. (line   32)
* replace_whitespace (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  171)
* report() (filecmp.dircmp method):      The dircmp class.   (line   18)
* report() (modulefinder.ModuleFinder method): modulefinder — Find modules used by a script.
                                                             (line   38)
* REPORTING_FLAGS (in module doctest):   Option Flags.       (line  155)
* REPORT_CDIFF (in module doctest):      Option Flags.       (line  117)
* report_failure() (doctest.DocTestRunner method): DocTestRunner objects.
                                                             (line   70)
* report_full_closure() (filecmp.dircmp method): The dircmp class.
                                                             (line   28)
* REPORT_NDIFF (in module doctest):      Option Flags.       (line  122)
* REPORT_ONLY_FIRST_FAILURE (in module doctest): Option Flags.
                                                             (line  131)
* report_partial_closure() (filecmp.dircmp method): The dircmp class.
                                                             (line   23)
* report_start() (doctest.DocTestRunner method): DocTestRunner objects.
                                                             (line   48)
* report_success() (doctest.DocTestRunner method): DocTestRunner objects.
                                                             (line   59)
* REPORT_UDIFF (in module doctest):      Option Flags.       (line  112)
* report_unexpected_exception() (doctest.DocTestRunner method): DocTestRunner objects.
                                                             (line   81)
* repr (2to3 fixer):                     Fixers.             (line  283)
* Repr (class in reprlib):               reprlib — Alternate repr implementation.
                                                             (line   17)
* repr() (built-in function):            Built-in Functions. (line 1413)
* repr() (built-in function); __repr__() (object method): Basic customization.
                                                             (line  113)
* repr() (in module reprlib):            reprlib — Alternate repr implementation.
                                                             (line   31)
* repr() (reprlib.Repr method):          Repr Objects.       (line   47)
* repr1() (reprlib.Repr method):         Repr Objects.       (line   52)
* reprfunc (C type):                     Slot Type typedefs. (line   49)
* reprlib (module):                      reprlib — Alternate repr implementation.
                                                             (line    6)
* Request (class in urllib.request):     urllib request — Extensible library for opening URLs.
                                                             (line  182)
* request() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line    8)
* RequestHandlerClass (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line   69)
* requestline (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   78)
* request_queue_size (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line   96)
* request_rate() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   60)
* request_uri() (in module wsgiref.util): wsgiref util – WSGI environment utilities.
                                                             (line   25)
* request_version (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   93)
* requires() (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line  211)
* requires_bz2() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  592)
* requires_docstrings() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  604)
* requires_freebsd_version() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  562)
* requires_gzip() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  588)
* requires_IEEE_754() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  580)
* requires_linux_version() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  568)
* requires_lzma() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  596)
* requires_mac_version() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  574)
* requires_resource() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  600)
* requires_zlib() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  584)
* reserved (zipfile.ZipInfo attribute):  ZipInfo Objects.    (line  111)
* reserved word:                         Keywords.           (line    6)
* RESERVED_FUTURE (in module uuid):      uuid — UUID objects according to RFC 4122.
                                                             (line  231)
* RESERVED_MICROSOFT (in module uuid):   uuid — UUID objects according to RFC 4122.
                                                             (line  227)
* RESERVED_NCS (in module uuid):         uuid — UUID objects according to RFC 4122.
                                                             (line  219)
* reset() (bdb.Bdb method):              bdb — Debugger framework.
                                                             (line  106)
* reset() (codecs.IncrementalDecoder method): IncrementalDecoder Objects.
                                                             (line   40)
* reset() (codecs.IncrementalEncoder method): IncrementalEncoder Objects.
                                                             (line   35)
* reset() (codecs.StreamReader method):  StreamReader Objects.
                                                             (line   83)
* reset() (codecs.StreamWriter method):  StreamWriter Objects.
                                                             (line   41)
* reset() (contextvars.ContextVar method): Context Variables.
                                                             (line   58)
* reset() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line   23)
* reset() (in module turtle):            More drawing control.
                                                             (line    6)
* reset() (in module turtle) <1>:        Window control.     (line   42)
* reset() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  172)
* reset() (pipes.Template method):       Template Objects.   (line    8)
* reset() (threading.Barrier method):    Barrier Objects.    (line   55)
* reset() (xdrlib.Packer method):        Packer Objects.     (line   12)
* reset() (xdrlib.Unpacker method):      Unpacker Objects.   (line    8)
* reset() (xml.dom.pulldom.DOMEventStream method): DOMEventStream Objects.
                                                             (line   27)
* reset() (xml.sax.xmlreader.IncrementalParser method): IncrementalParser Objects.
                                                             (line   19)
* resetbuffer() (code.InteractiveConsole method): Interactive Console Objects.
                                                             (line   40)
* resetlocale() (in module locale):      locale — Internationalization services.
                                                             (line  366)
* resetscreen() (in module turtle):      Window control.     (line   42)
* resetty() (in module curses):          Functions<3>.       (line  402)
* resetwarnings() (in module warnings):  Available Functions.
                                                             (line   98)
* reset_mock() (unittest.mock.AsyncMock method): The Mock Class.
                                                             (line  548)
* reset_mock() (unittest.mock.Mock method): The Mock Class.  (line  159)
* reset_prog_mode() (in module curses):  Functions<3>.       (line  392)
* reset_shell_mode() (in module curses): Functions<3>.       (line  397)
* resize() (curses.window method):       Window Objects.     (line  489)
* resize() (in module ctypes):           Utility functions.  (line  163)
* resize() (mmap.mmap method):           mmap — Memory-mapped file support.
                                                             (line  210)
* resizemode() (in module turtle):       Appearance.         (line   20)
* resizeterm() (in module curses):       Functions<3>.       (line  417)
* resize_term() (in module curses):      Functions<3>.       (line  407)
* resolution (datetime.date attribute):  date Objects.       (line   95)
* resolution (datetime.datetime attribute): datetime Objects.
                                                             (line  258)
* resolution (datetime.time attribute):  time Objects.       (line   42)
* resolution (datetime.timedelta attribute): timedelta Objects.
                                                             (line   84)
* resolve() (pathlib.Path method):       Methods<2>.         (line  313)
* resolveEntity() (xml.sax.handler.EntityResolver method): EntityResolver Objects.
                                                             (line    6)
* resolve_bases() (in module types):     Dynamic Type Creation.
                                                             (line   58)
* resolve_name() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line   80)
* Resource (in module importlib.resources): importlib resources – Resources.
                                                             (line   45)
* resource (module):                     resource — Resource usage information.
                                                             (line    6)
* ResourceDenied:                        test support — Utilities for the Python test suite.
                                                             (line   22)
* ResourceLoader (class in importlib.abc): importlib abc – Abstract base classes related to import.
                                                             (line  348)
* ResourceReader (class in importlib.abc): importlib abc – Abstract base classes related to import.
                                                             (line  277)
* ResourceWarning:                       Warnings.           (line   59)
* resource_path() (importlib.abc.ResourceReader method): importlib abc – Abstract base classes related to import.
                                                             (line  317)
* response (nntplib.NNTPError attribute): nntplib — NNTP protocol client.
                                                             (line   99)
* response() (imaplib.IMAP4 method):     IMAP4 Objects.      (line  211)
* ResponseNotReady:                      http client — HTTP protocol client.
                                                             (line  167)
* responses (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  166)
* responses (in module http.client):     http client — HTTP protocol client.
                                                             (line  202)
* restart (pdb command):                 Debugger Commands.  (line  315)
* restore() (in module difflib):         difflib — Helpers for computing deltas.
                                                             (line  273)
* RESTRICTED:                            Generic Attribute Management.
                                                             (line   79)
* restricted; execution:                 Builtins and restricted execution.
                                                             (line    6)
* restype (ctypes._FuncPtr attribute):   Foreign functions.  (line   22)
* result() (asyncio.Future method):      Future Object.      (line   28)
* result() (asyncio.Task method):        Task Object.        (line   88)
* result() (concurrent.futures.Future method): Future Objects.
                                                             (line   38)
* results() (trace.Trace method):        Programmatic Interface.
                                                             (line   42)
* resume_reading() (asyncio.ReadTransport method): Read-only Transports.
                                                             (line   21)
* resume_writing() (asyncio.BaseProtocol method): Base Protocol.
                                                             (line   44)
* retr() (poplib.POP3 method):           POP3 Objects.       (line   62)
* retrbinary() (ftplib.FTP method):      FTP Objects.        (line   84)
* retrieve() (urllib.request.URLopener method): Legacy interface.
                                                             (line  110)
* retrlines() (ftplib.FTP method):       FTP Objects.        (line   96)
* return (pdb command):                  Debugger Commands.  (line  185)
* returncode (asyncio.asyncio.subprocess.Process attribute): Interacting with Subprocesses.
                                                             (line  140)
* returncode (subprocess.CalledProcessError attribute): Using the subprocess Module.
                                                             (line  185)
* returncode (subprocess.CompletedProcess attribute): Using the subprocess Module.
                                                             (line   90)
* returncode (subprocess.Popen attribute): Popen Objects.    (line  139)
* return_annotation (inspect.Signature attribute): Introspecting callables with the Signature object.
                                                             (line   77)
* return_ok() (http.cookiejar.CookiePolicy method): CookiePolicy Objects.
                                                             (line   18)
* RETURN_VALUE (opcode):                 Python Bytecode Instructions.
                                                             (line  342)
* return_value (unittest.mock.Mock attribute): The Mock Class.
                                                             (line  248)
* retval (pdb command):                  Debugger Commands.  (line  334)
* reverse() (array.array method):        array — Efficient arrays of numeric values.
                                                             (line  214)
* reverse() (collections.deque method):  deque objects.      (line  102)
* reverse() (in module audioop):         audioop — Manipulate raw audio data.
                                                             (line  187)
* reverse() (sequence method):           Mutable Sequence Types.
                                                             (line   16)
* reversed() (built-in function):        Built-in Functions. (line 1425)
* reverse_order() (pstats.Stats method): The Stats Class.    (line  157)
* reverse_pointer (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   66)
* reverse_pointer (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  156)
* Reversible (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  136)
* Reversible (class in typing):          Classes functions and decorators.
                                                             (line  117)
* revert() (http.cookiejar.FileCookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line  141)
* rewind() (aifc.aifc method):           aifc — Read and write AIFF and AIFC files.
                                                             (line  103)
* rewind() (sunau.AU_read method):       AU_read Objects.    (line   53)
* rewind() (wave.Wave_read method):      Wave_read Objects.  (line   51)
* rfc2109 (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   68)
* rfc2109_as_netscape (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line   76)
* rfc2965 (http.cookiejar.CookiePolicy attribute): CookiePolicy Objects.
                                                             (line   72)
* rfc822_escape() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line  172)
* RFC; RFC 1014:                         xdrlib — Encode and decode XDR data.
                                                             (line   11)
* RFC; RFC 1014 <1>:                     xdrlib — Encode and decode XDR data.
                                                             (line   32)
* RFC; RFC 1123:                         Functions<2>.       (line  617)
* RFC; RFC 1321:                         hashlib — Secure hashes and message digests.
                                                             (line   13)
* RFC; RFC 1422:                         Certificates.       (line   38)
* RFC; RFC 1422 <1>:                     LibreSSL support.   (line   29)
* RFC; RFC 1521:                         base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  264)
* RFC; RFC 1521 <1>:                     quopri — Encode and decode MIME quoted-printable data.
                                                             (line   11)
* RFC; RFC 1521 <2>:                     quopri — Encode and decode MIME quoted-printable data.
                                                             (line   37)
* RFC; RFC 1522:                         binascii — Convert between binary and ASCII.
                                                             (line   71)
* RFC; RFC 1522 <1>:                     quopri — Encode and decode MIME quoted-printable data.
                                                             (line   25)
* RFC; RFC 1522 <2>:                     quopri — Encode and decode MIME quoted-printable data.
                                                             (line   39)
* RFC; RFC 1524:                         mailcap — Mailcap file handling.
                                                             (line   19)
* RFC; RFC 1524 <1>:                     mailcap — Mailcap file handling.
                                                             (line   38)
* RFC; RFC 1730:                         imaplib — IMAP4 protocol client.
                                                             (line   14)
* RFC; RFC 1738:                         URL Quoting.        (line  176)
* RFC; RFC 1750:                         Random generation.  (line   70)
* RFC; RFC 1766:                         locale — Internationalization services.
                                                             (line  321)
* RFC; RFC 1766 <1>:                     locale — Internationalization services.
                                                             (line  332)
* RFC; RFC 1808:                         urllib.             (line   23)
* RFC; RFC 1808 <1>:                     URL Parsing.        (line   23)
* RFC; RFC 1808 <2>:                     URL Quoting.        (line  170)
* RFC; RFC 1832:                         xdrlib — Encode and decode XDR data.
                                                             (line   36)
* RFC; RFC 1832 <1>:                     xdrlib — Encode and decode XDR data.
                                                             (line   38)
* RFC; RFC 1869:                         smtplib — SMTP protocol client.
                                                             (line   13)
* RFC; RFC 1869 <1>:                     smtplib — SMTP protocol client.
                                                             (line  179)
* RFC; RFC 1870:                         smtpd<3>.           (line    7)
* RFC; RFC 1870 <1>:                     smtpd — SMTP Server.
                                                             (line   26)
* RFC; RFC 1870 <2>:                     SMTPChannel Objects.
                                                             (line  125)
* RFC; RFC 1939:                         poplib — POP3 protocol client.
                                                             (line   11)
* RFC; RFC 1939 <1>:                     poplib — POP3 protocol client.
                                                             (line   13)
* RFC; RFC 2033:                         New and Improved Modules<2>.
                                                             (line  569)
* RFC; RFC 2045:                         email — An email and MIME handling package.
                                                             (line   16)
* RFC; RFC 2045 <1>:                     email message Representing an email message.
                                                             (line  313)
* RFC; RFC 2045 <2>:                     email message Representing an email message.
                                                             (line  315)
* RFC; RFC 2045 <3>:                     email message Representing an email message.
                                                             (line  318)
* RFC; RFC 2045 <4>:                     email headerregistry Custom Header Objects.
                                                             (line  237)
* RFC; RFC 2045 <5>:                     email headerregistry Custom Header Objects.
                                                             (line  295)
* RFC; RFC 2045 <6>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  409)
* RFC; RFC 2045 <7>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  413)
* RFC; RFC 2045 <8>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  416)
* RFC; RFC 2045 <9>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  512)
* RFC; RFC 2045 <10>:                    email header Internationalized headers.
                                                             (line   31)
* RFC; RFC 2045 <11>:                    base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   30)
* RFC; RFC 2045 <12>:                    base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   31)
* RFC; RFC 2045 <13>:                    base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  234)
* RFC; RFC 2045 <14>:                    base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  242)
* RFC; RFC 2045#section-6.8:             Binary Objects.     (line   31)
* RFC; RFC 2046:                         email — An email and MIME handling package.
                                                             (line   16)
* RFC; RFC 2046 <1>:                     Content Manager Instances.
                                                             (line   85)
* RFC; RFC 2046 <2>:                     email header Internationalized headers.
                                                             (line   32)
* RFC; RFC 2047:                         PEP 3333 Python Web Server Gateway Interface v1 0 1.
                                                             (line   21)
* RFC; RFC 2047 <1>:                     email<5>.           (line   27)
* RFC; RFC 2047 <2>:                     email — An email and MIME handling package.
                                                             (line   16)
* RFC; RFC 2047 <3>:                     email policy Policy Objects.
                                                             (line  325)
* RFC; RFC 2047 <4>:                     email policy Policy Objects.
                                                             (line  331)
* RFC; RFC 2047 <5>:                     email headerregistry Custom Header Objects.
                                                             (line   78)
* RFC; RFC 2047 <6>:                     email headerregistry Custom Header Objects.
                                                             (line  121)
* RFC; RFC 2047 <7>:                     email headerregistry Custom Header Objects.
                                                             (line  126)
* RFC; RFC 2047 <8>:                     email header Internationalized headers.
                                                             (line   32)
* RFC; RFC 2047 <9>:                     email header Internationalized headers.
                                                             (line   49)
* RFC; RFC 2047 <10>:                    email header Internationalized headers.
                                                             (line  111)
* RFC; RFC 2047 <11>:                    email header Internationalized headers.
                                                             (line  135)
* RFC; RFC 2047 <12>:                    email utils Miscellaneous utilities.
                                                             (line   74)
* RFC; RFC 2060:                         imaplib — IMAP4 protocol client.
                                                             (line   13)
* RFC; RFC 2060 <1>:                     IMAP4 Objects.      (line  306)
* RFC; RFC 2068:                         http cookies — HTTP state management.
                                                             (line   16)
* RFC; RFC 2104:                         New and Improved Modules<3>.
                                                             (line   35)
* RFC; RFC 2104 <1>:                     hmac — Keyed-Hashing for Message Authentication.
                                                             (line   10)
* RFC; RFC 2109:                         http cookies — HTTP state management.
                                                             (line   15)
* RFC; RFC 2109 <1>:                     http cookies — HTTP state management.
                                                             (line   35)
* RFC; RFC 2109 <2>:                     http cookies — HTTP state management.
                                                             (line   65)
* RFC; RFC 2109 <3>:                     Morsel Objects.     (line    8)
* RFC; RFC 2109 <4>:                     Morsel Objects.     (line   11)
* RFC; RFC 2109 <5>:                     Morsel Objects.     (line   98)
* RFC; RFC 2109 <6>:                     Morsel Objects.     (line  110)
* RFC; RFC 2109 <7>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line   17)
* RFC; RFC 2109 <8>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line   99)
* RFC; RFC 2109 <9>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line  111)
* RFC; RFC 2109 <10>:                    http cookiejar — Cookie handling for HTTP clients.
                                                             (line  138)
* RFC; RFC 2109 <11>:                    DefaultCookiePolicy Objects.
                                                             (line   79)
* RFC; RFC 2109 <12>:                    Cookie Objects<2>.  (line   11)
* RFC; RFC 2109 <13>:                    Cookie Objects<2>.  (line   23)
* RFC; RFC 2109 <14>:                    Cookie Objects<2>.  (line   70)
* RFC; RFC 2183:                         email — An email and MIME handling package.
                                                             (line   16)
* RFC; RFC 2183 <1>:                     email message Representing an email message.
                                                             (line  457)
* RFC; RFC 2183 <2>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  618)
* RFC; RFC 2231:                         email — An email and MIME handling package.
                                                             (line   16)
* RFC; RFC 2231 <1>:                     email message Representing an email message.
                                                             (line  278)
* RFC; RFC 2231 <2>:                     email message Representing an email message.
                                                             (line  281)
* RFC; RFC 2231 <3>:                     email message Representing an email message.
                                                             (line  362)
* RFC; RFC 2231 <4>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  373)
* RFC; RFC 2231 <5>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  377)
* RFC; RFC 2231 <6>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  478)
* RFC; RFC 2231 <7>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  486)
* RFC; RFC 2231 <8>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  519)
* RFC; RFC 2231 <9>:                     email header Internationalized headers.
                                                             (line   32)
* RFC; RFC 2231 <10>:                    email utils Miscellaneous utilities.
                                                             (line  170)
* RFC; RFC 2231 <11>:                    email utils Miscellaneous utilities.
                                                             (line  175)
* RFC; RFC 2231 <12>:                    email utils Miscellaneous utilities.
                                                             (line  184)
* RFC; RFC 2231 <13>:                    email utils Miscellaneous utilities.
                                                             (line  191)
* RFC; RFC 2231 <14>:                    email utils Miscellaneous utilities.
                                                             (line  200)
* RFC; RFC 2295:                         HTTP status codes.  (line  175)
* RFC; RFC 2342:                         New and Improved Modules<3>.
                                                             (line   93)
* RFC; RFC 2342 <1>:                     IMAP4 Objects.      (line  164)
* RFC; RFC 2368:                         URL Quoting.        (line  166)
* RFC; RFC 2373:                         Address objects.    (line   81)
* RFC; RFC 2373 <1>:                     Address objects.    (line  100)
* RFC; RFC 2373 <2>:                     Address objects.    (line  109)
* RFC; RFC 2396:                         urllib parse.       (line    6)
* RFC; RFC 2396 <1>:                     urllib.             (line   24)
* RFC; RFC 2396 <2>:                     URL Parsing.        (line  201)
* RFC; RFC 2396 <3>:                     URL Quoting.        (line   24)
* RFC; RFC 2396 <4>:                     URL Quoting.        (line  161)
* RFC; RFC 2397:                         DataHandler Objects.
                                                             (line    9)
* RFC; RFC 2449:                         POP3 Objects.       (line   26)
* RFC; RFC 2487:                         New and Improved Modules<3>.
                                                             (line   85)
* RFC; RFC 2518:                         HTTP status codes.  (line   19)
* RFC; RFC 2595:                         poplib — POP3 protocol client.
                                                             (line   14)
* RFC; RFC 2595 <1>:                     POP3 Objects.       (line  115)
* RFC; RFC 2616:                         PEP 3333 Python Web Server Gateway Interface v1 0 1.
                                                             (line   20)
* RFC; RFC 2616 <1>:                     wsgiref util – WSGI environment utilities.
                                                             (line   93)
* RFC; RFC 2616 <2>:                     wsgiref validate — WSGI conformance checker.
                                                             (line   27)
* RFC; RFC 2616 <3>:                     HTTPRedirectHandler Objects.
                                                             (line    8)
* RFC; RFC 2616 <4>:                     HTTPRedirectHandler Objects.
                                                             (line   28)
* RFC; RFC 2616 <5>:                     Legacy interface.   (line  161)
* RFC; RFC 2616 <6>:                     urllib error — Exception classes raised by urllib request.
                                                             (line   40)
* RFC; RFC 2616 <7>:                     Introduction<16>.   (line   34)
* RFC; RFC 2616 <8>:                     HTTPError.          (line   15)
* RFC; RFC 2616 <9>:                     Error Codes.        (line   12)
* RFC; RFC 2732:                         urllib parse<2>.    (line   10)
* RFC; RFC 2732 <1>:                     New and Improved Modules.
                                                             (line  638)
* RFC; RFC 2732 <2>:                     URL Quoting.        (line  157)
* RFC; RFC 2774:                         HTTP status codes.  (line  184)
* RFC; RFC 2818:                         ssl<9>.             (line   16)
* RFC; RFC 2818 <1>:                     Certificate handling.
                                                             (line   11)
* RFC; RFC 2821:                         email — An email and MIME handling package.
                                                             (line   12)
* RFC; RFC 2822:                         New and Improved Modules<3>.
                                                             (line   97)
* RFC; RFC 2822 <1>:                     Batteries Included. (line   16)
* RFC; RFC 2822 <2>:                     Functions<2>.       (line  348)
* RFC; RFC 2822 <3>:                     Functions<2>.       (line  618)
* RFC; RFC 2822 <4>:                     email message Message Representing an email message using the compat32 API.
                                                             (line  264)
* RFC; RFC 2822 <5>:                     email header Internationalized headers.
                                                             (line   20)
* RFC; RFC 2822 <6>:                     email header Internationalized headers.
                                                             (line   23)
* RFC; RFC 2822 <7>:                     email header Internationalized headers.
                                                             (line   31)
* RFC; RFC 2822 <8>:                     email header Internationalized headers.
                                                             (line   82)
* RFC; RFC 2822 <9>:                     email header Internationalized headers.
                                                             (line  110)
* RFC; RFC 2822 <10>:                    email header Internationalized headers.
                                                             (line  128)
* RFC; RFC 2822 <11>:                    email utils Miscellaneous utilities.
                                                             (line   31)
* RFC; RFC 2822 <12>:                    email utils Miscellaneous utilities.
                                                             (line   92)
* RFC; RFC 2822 <13>:                    email utils Miscellaneous utilities.
                                                             (line   95)
* RFC; RFC 2822 <14>:                    email utils Miscellaneous utilities.
                                                             (line  218)
* RFC; RFC 2822 <15>:                    email utils Miscellaneous utilities.
                                                             (line  136)
* RFC; RFC 2822 <16>:                    Message objects.    (line   17)
* RFC; RFC 2822 <17>:                    http client — HTTP protocol client.
                                                             (line  109)
* RFC; RFC 2822 <18>:                    http server — HTTP servers.
                                                             (line  105)
* RFC; RFC 2964:                         http cookiejar — Cookie handling for HTTP clients.
                                                             (line  151)
* RFC; RFC 2965:                         urllib request — Extensible library for opening URLs.
                                                             (line  225)
* RFC; RFC 2965 <1>:                     urllib request — Extensible library for opening URLs.
                                                             (line  233)
* RFC; RFC 2965 <2>:                     Request Objects.    (line   50)
* RFC; RFC 2965 <3>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line   16)
* RFC; RFC 2965 <4>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line   99)
* RFC; RFC 2965 <5>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line  111)
* RFC; RFC 2965 <6>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line  140)
* RFC; RFC 2965 <7>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line  142)
* RFC; RFC 2965 <8>:                     http cookiejar — Cookie handling for HTTP clients.
                                                             (line  149)
* RFC; RFC 2965 <9>:                     FileCookieJar subclasses and co-operation with web browsers.
                                                             (line   16)
* RFC; RFC 2965 <10>:                    CookiePolicy Objects.
                                                             (line   74)
* RFC; RFC 2965 <11>:                    CookiePolicy Objects.
                                                             (line   79)
* RFC; RFC 2965 <12>:                    DefaultCookiePolicy Objects.
                                                             (line    8)
* RFC; RFC 2965 <13>:                    DefaultCookiePolicy Objects.
                                                             (line   83)
* RFC; RFC 2965 <14>:                    DefaultCookiePolicy Objects.
                                                             (line   94)
* RFC; RFC 2965 <15>:                    DefaultCookiePolicy Objects.
                                                             (line   98)
* RFC; RFC 2965 <16>:                    DefaultCookiePolicy Objects.
                                                             (line  107)
* RFC; RFC 2965 <17>:                    DefaultCookiePolicy Objects.
                                                             (line  144)
* RFC; RFC 2965 <18>:                    Cookie Objects<2>.  (line   23)
* RFC; RFC 2965 <19>:                    Examples<24>.       (line   18)
* RFC; RFC 2980:                         nntplib — NNTP protocol client.
                                                             (line   13)
* RFC; RFC 2980 <1>:                     Methods<3>.         (line  281)
* RFC; RFC 3056:                         Address objects.    (line  196)
* RFC; RFC 3171:                         Address objects.    (line   80)
* RFC; RFC 3207:                         New and Improved Modules<2>.
                                                             (line  574)
* RFC; RFC 3229:                         HTTP status codes.  (line   49)
* RFC; RFC 3280:                         SSL Sockets.        (line  152)
* RFC; RFC 3330:                         Address objects.    (line  108)
* RFC; RFC 3339:                         Displaying the date/time in messages.
                                                             (line   16)
* RFC; RFC 3454:                         stringprep — Internet String Preparation.
                                                             (line   17)
* RFC; RFC 3454 <1>:                     stringprep — Internet String Preparation.
                                                             (line   26)
* RFC; RFC 3490:                         Text Encodings.     (line   14)
* RFC; RFC 3490 <1>:                     encodings idna — Internationalized Domain Names in Applications.
                                                             (line    6)
* RFC; RFC 3490 <2>:                     encodings idna — Internationalized Domain Names in Applications.
                                                             (line   54)
* RFC; RFC 3490 <3>:                     encodings idna — Internationalized Domain Names in Applications.
                                                             (line   59)
* RFC; RFC 3490#section-3.1:             encodings idna — Internationalized Domain Names in Applications.
                                                             (line   24)
* RFC; RFC 3492:                         Text Encodings.     (line   36)
* RFC; RFC 3492 <1>:                     encodings idna — Internationalized Domain Names in Applications.
                                                             (line    7)
* RFC; RFC 3493:                         Example<8>.         (line   88)
* RFC; RFC 3501:                         IMAP4 Objects.      (line  314)
* RFC; RFC 3542:                         Library<12>.        (line  352)
* RFC; RFC 3542 <1>:                     Other functions<2>. (line  298)
* RFC; RFC 3548:                         New Improved and Deprecated Modules<3>.
                                                             (line   16)
* RFC; RFC 3548 <1>:                     base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   12)
* RFC; RFC 3548 <2>:                     base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   16)
* RFC; RFC 3548 <3>:                     base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   24)
* RFC; RFC 3548 <4>:                     base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line  112)
* RFC; RFC 3548 <5>:                     binascii — Convert between binary and ASCII.
                                                             (line   50)
* RFC; RFC 3659:                         FTP Objects.        (line  168)
* RFC; RFC 3879:                         Address objects.    (line  181)
* RFC; RFC 3927:                         Address objects.    (line  113)
* RFC; RFC 3977:                         nntplib — NNTP protocol client.
                                                             (line   13)
* RFC; RFC 3977 <1>:                     Attributes.         (line   10)
* RFC; RFC 3977 <2>:                     Methods<3>.         (line   36)
* RFC; RFC 3977 <3>:                     Methods<3>.         (line  131)
* RFC; RFC 3977 <4>:                     Methods<3>.         (line  282)
* RFC; RFC 3986:                         urllib parse.       (line    6)
* RFC; RFC 3986 <1>:                     urllib.             (line   22)
* RFC; RFC 3986 <2>:                     New and Improved Modules.
                                                             (line  617)
* RFC; RFC 3986 <3>:                     Porting to Python 2 7.
                                                             (line   80)
* RFC; RFC 3986 <4>:                     URL Parsing.        (line  104)
* RFC; RFC 3986 <5>:                     URL Parsing.        (line  294)
* RFC; RFC 3986 <6>:                     URL Quoting.        (line   24)
* RFC; RFC 3986 <7>:                     URL Quoting.        (line  149)
* RFC; RFC 4086:                         LibreSSL support.   (line   33)
* RFC; RFC 4122:                         New Improved and Removed Modules.
                                                             (line  417)
* RFC; RFC 4122 <1>:                     New Improved and Removed Modules.
                                                             (line  422)
* RFC; RFC 4122 <2>:                     uuid — UUID objects according to RFC 4122.
                                                             (line    6)
* RFC; RFC 4122 <3>:                     uuid — UUID objects according to RFC 4122.
                                                             (line   15)
* RFC; RFC 4122 <4>:                     uuid — UUID objects according to RFC 4122.
                                                             (line   66)
* RFC; RFC 4122 <5>:                     uuid — UUID objects according to RFC 4122.
                                                             (line  132)
* RFC; RFC 4122 <6>:                     uuid — UUID objects according to RFC 4122.
                                                             (line  161)
* RFC; RFC 4122 <7>:                     uuid — UUID objects according to RFC 4122.
                                                             (line  225)
* RFC; RFC 4122 <8>:                     uuid — UUID objects according to RFC 4122.
                                                             (line  238)
* RFC; RFC 4180:                         csv — CSV File Reading and Writing.
                                                             (line   13)
* RFC; RFC 4193:                         Address objects.    (line  183)
* RFC; RFC 4217:                         ftplib — FTP protocol client.
                                                             (line   52)
* RFC; RFC 4291:                         Address objects.    (line  127)
* RFC; RFC 4380:                         Address objects.    (line  203)
* RFC; RFC 4627:                         json — JSON encoder and decoder.
                                                             (line   11)
* RFC; RFC 4627 <1>:                     Top-level Non-Object Non-Array Values.
                                                             (line    6)
* RFC; RFC 4642:                         nntplib — NNTP protocol client.
                                                             (line   76)
* RFC; RFC 4918:                         HTTP status codes.  (line   43)
* RFC; RFC 4918 <1>:                     HTTP status codes.  (line  133)
* RFC; RFC 4918 <2>:                     HTTP status codes.  (line  136)
* RFC; RFC 4918 <3>:                     HTTP status codes.  (line  139)
* RFC; RFC 4918 <4>:                     HTTP status codes.  (line  178)
* RFC; RFC 4954:                         SMTP Objects.       (line  135)
* RFC; RFC 4954 <1>:                     SMTP Objects.       (line  158)
* RFC; RFC 5161:                         imaplib.            (line   11)
* RFC; RFC 5161 <1>:                     IMAP4 Objects.      (line   86)
* RFC; RFC 5233:                         email — An email and MIME handling package.
                                                             (line   15)
* RFC; RFC 5233 <1>:                     email message Message Representing an email message using the compat32 API.
                                                             (line   21)
* RFC; RFC 5246:                         Constants<9>.       (line  472)
* RFC; RFC 5246 <1>:                     LibreSSL support.   (line   41)
* RFC; RFC 5280:                         Other Changes.      (line   20)
* RFC; RFC 5280 <1>:                     Changes in the Python API<4>.
                                                             (line   95)
* RFC; RFC 5280 <2>:                     Certificate handling.
                                                             (line   11)
* RFC; RFC 5280 <3>:                     Certificate handling.
                                                             (line   52)
* RFC; RFC 5280 <4>:                     LibreSSL support.   (line   37)
* RFC; RFC 5321:                         smtpd<3>.           (line    6)
* RFC; RFC 5321 <1>:                     email headerregistry Custom Header Objects.
                                                             (line  451)
* RFC; RFC 5321 <2>:                     smtpd — SMTP Server.
                                                             (line   26)
* RFC; RFC 5321 <3>:                     SMTPServer Objects. (line   50)
* RFC; RFC 5321 <4>:                     SMTPServer Objects. (line   78)
* RFC; RFC 5322:                         email message Representing an email message.
                                                             (line   20)
* RFC; RFC 5322 <1>:                     email message Representing an email message.
                                                             (line   31)
* RFC; RFC 5322 <2>:                     Parser API.         (line   41)
* RFC; RFC 5322 <3>:                     email generator Generating MIME documents.
                                                             (line  102)
* RFC; RFC 5322 <4>:                     email generator Generating MIME documents.
                                                             (line  195)
* RFC; RFC 5322 <5>:                     email policy Policy Objects.
                                                             (line  126)
* RFC; RFC 5322 <6>:                     email policy Policy Objects.
                                                             (line  304)
* RFC; RFC 5322 <7>:                     email policy Policy Objects.
                                                             (line  325)
* RFC; RFC 5322 <8>:                     email policy Policy Objects.
                                                             (line  331)
* RFC; RFC 5322 <9>:                     email policy Policy Objects.
                                                             (line  343)
* RFC; RFC 5322 <10>:                    email policy Policy Objects.
                                                             (line  376)
* RFC; RFC 5322 <11>:                    email errors Exception and Defect classes.
                                                             (line   28)
* RFC; RFC 5322 <12>:                    email headerregistry Custom Header Objects.
                                                             (line   16)
* RFC; RFC 5322 <13>:                    email headerregistry Custom Header Objects.
                                                             (line  115)
* RFC; RFC 5322 <14>:                    email headerregistry Custom Header Objects.
                                                             (line  120)
* RFC; RFC 5322 <15>:                    email headerregistry Custom Header Objects.
                                                             (line  121)
* RFC; RFC 5322 <16>:                    email headerregistry Custom Header Objects.
                                                             (line  136)
* RFC; RFC 5322 <17>:                    email headerregistry Custom Header Objects.
                                                             (line  157)
* RFC; RFC 5322 <18>:                    email headerregistry Custom Header Objects.
                                                             (line  414)
* RFC; RFC 5322 <19>:                    email headerregistry Custom Header Objects.
                                                             (line  448)
* RFC; RFC 5322 <20>:                    email headerregistry Custom Header Objects.
                                                             (line  482)
* RFC; RFC 5322 <21>:                    SMTP Objects.       (line  317)
* RFC; RFC 5424:                         SysLogHandler.      (line   53)
* RFC; RFC 5424 <1>:                     Inserting a BOM into messages sent to a SysLogHandler.
                                                             (line    6)
* RFC; RFC 5424 <2>:                     Inserting a BOM into messages sent to a SysLogHandler.
                                                             (line   19)
* RFC; RFC 5424 <3>:                     Inserting a BOM into messages sent to a SysLogHandler.
                                                             (line   43)
* RFC; RFC 5424#section-6:               Inserting a BOM into messages sent to a SysLogHandler.
                                                             (line    9)
* RFC; RFC 5735:                         Address objects.    (line   99)
* RFC; RFC 5842:                         HTTP status codes.  (line   46)
* RFC; RFC 5842 <1>:                     HTTP status codes.  (line  181)
* RFC; RFC 5929:                         SSL Sockets.        (line  230)
* RFC; RFC 6066:                         Constants<9>.       (line  377)
* RFC; RFC 6066 <1>:                     SSL Contexts.       (line  252)
* RFC; RFC 6066 <2>:                     LibreSSL support.   (line   45)
* RFC; RFC 6125:                         Certificate handling.
                                                             (line   11)
* RFC; RFC 6125 <1>:                     Certificate handling.
                                                             (line   23)
* RFC; RFC 6152:                         smtpd.              (line   17)
* RFC; RFC 6152 <1>:                     SMTPServer Objects. (line   35)
* RFC; RFC 6531:                         email<2>.           (line   19)
* RFC; RFC 6531 <1>:                     smtpd.              (line   23)
* RFC; RFC 6531 <2>:                     smtplib.            (line   15)
* RFC; RFC 6531 <3>:                     email message Representing an email message.
                                                             (line  103)
* RFC; RFC 6531 <4>:                     email policy Policy Objects.
                                                             (line  347)
* RFC; RFC 6531 <5>:                     smtplib — SMTP protocol client.
                                                             (line   58)
* RFC; RFC 6531 <6>:                     smtpd — SMTP Server.
                                                             (line   26)
* RFC; RFC 6531 <7>:                     SMTPServer Objects. (line   26)
* RFC; RFC 6531 <8>:                     SMTPChannel Objects.
                                                             (line   21)
* RFC; RFC 6532:                         email<2>.           (line   18)
* RFC; RFC 6532 <1>:                     email — An email and MIME handling package.
                                                             (line   15)
* RFC; RFC 6532 <2>:                     email message Representing an email message.
                                                             (line   20)
* RFC; RFC 6532 <3>:                     Parser API.         (line   42)
* RFC; RFC 6532 <4>:                     email policy Policy Objects.
                                                             (line  345)
* RFC; RFC 6585:                         HTTP status codes.  (line  145)
* RFC; RFC 6585 <1>:                     HTTP status codes.  (line  148)
* RFC; RFC 6585 <2>:                     HTTP status codes.  (line  151)
* RFC; RFC 6585 <3>:                     HTTP status codes.  (line  187)
* RFC; RFC 6855:                         imaplib.            (line   12)
* RFC; RFC 6855 <1>:                     imaplib.            (line   14)
* RFC; RFC 6855 <2>:                     IMAP4 Objects.      (line   88)
* RFC; RFC 6855 <3>:                     IMAP4 Objects.      (line   90)
* RFC; RFC 6856:                         poplib.             (line    6)
* RFC; RFC 6856 <1>:                     POP3 Objects.       (line  108)
* RFC; RFC 7159:                         json — JSON encoder and decoder.
                                                             (line   10)
* RFC; RFC 7159 <1>:                     Standard Compliance and Interoperability.
                                                             (line    6)
* RFC; RFC 7159 <2>:                     Top-level Non-Object Non-Array Values.
                                                             (line    9)
* RFC; RFC 7230:                         urllib request — Extensible library for opening URLs.
                                                             (line  197)
* RFC; RFC 7230 <1>:                     HTTPConnection Objects.
                                                             (line  148)
* RFC; RFC 7231:                         HTTP status codes.  (line   13)
* RFC; RFC 7231 <1>:                     HTTP status codes.  (line   16)
* RFC; RFC 7231 <2>:                     HTTP status codes.  (line   22)
* RFC; RFC 7231 <3>:                     HTTP status codes.  (line   25)
* RFC; RFC 7231 <4>:                     HTTP status codes.  (line   28)
* RFC; RFC 7231 <5>:                     HTTP status codes.  (line   31)
* RFC; RFC 7231 <6>:                     HTTP status codes.  (line   34)
* RFC; RFC 7231 <7>:                     HTTP status codes.  (line   37)
* RFC; RFC 7231 <8>:                     HTTP status codes.  (line   52)
* RFC; RFC 7231 <9>:                     HTTP status codes.  (line   55)
* RFC; RFC 7231 <10>:                    HTTP status codes.  (line   58)
* RFC; RFC 7231 <11>:                    HTTP status codes.  (line   61)
* RFC; RFC 7231 <12>:                    HTTP status codes.  (line   67)
* RFC; RFC 7231 <13>:                    HTTP status codes.  (line   70)
* RFC; RFC 7231 <14>:                    HTTP status codes.  (line   76)
* RFC; RFC 7231 <15>:                    HTTP status codes.  (line   82)
* RFC; RFC 7231 <16>:                    HTTP status codes.  (line   85)
* RFC; RFC 7231 <17>:                    HTTP status codes.  (line   88)
* RFC; RFC 7231 <18>:                    HTTP status codes.  (line   91)
* RFC; RFC 7231 <19>:                    HTTP status codes.  (line   94)
* RFC; RFC 7231 <20>:                    HTTP status codes.  (line  100)
* RFC; RFC 7231 <21>:                    HTTP status codes.  (line  103)
* RFC; RFC 7231 <22>:                    HTTP status codes.  (line  106)
* RFC; RFC 7231 <23>:                    HTTP status codes.  (line  109)
* RFC; RFC 7231 <24>:                    HTTP status codes.  (line  115)
* RFC; RFC 7231 <25>:                    HTTP status codes.  (line  118)
* RFC; RFC 7231 <26>:                    HTTP status codes.  (line  121)
* RFC; RFC 7231 <27>:                    HTTP status codes.  (line  127)
* RFC; RFC 7231 <28>:                    HTTP status codes.  (line  142)
* RFC; RFC 7231 <29>:                    HTTP status codes.  (line  157)
* RFC; RFC 7231 <30>:                    HTTP status codes.  (line  160)
* RFC; RFC 7231 <31>:                    HTTP status codes.  (line  163)
* RFC; RFC 7231 <32>:                    HTTP status codes.  (line  166)
* RFC; RFC 7231 <33>:                    HTTP status codes.  (line  169)
* RFC; RFC 7231 <34>:                    HTTP status codes.  (line  172)
* RFC; RFC 7232:                         HTTP status codes.  (line   64)
* RFC; RFC 7232 <1>:                     HTTP status codes.  (line  112)
* RFC; RFC 7233:                         HTTP status codes.  (line   40)
* RFC; RFC 7233 <1>:                     HTTP status codes.  (line  124)
* RFC; RFC 7235:                         HTTP status codes.  (line   79)
* RFC; RFC 7235 <1>:                     HTTP status codes.  (line   97)
* RFC; RFC 7238:                         HTTP status codes.  (line   73)
* RFC; RFC 7301:                         Application-Layer Protocol Negotiation Support.
                                                             (line   10)
* RFC; RFC 7301 <1>:                     Constants<9>.       (line  354)
* RFC; RFC 7301 <2>:                     SSL Contexts.       (line  217)
* RFC; RFC 7525:                         LibreSSL support.   (line   53)
* RFC; RFC 7540:                         HTTP status codes.  (line  130)
* RFC; RFC 7693:                         BLAKE2.             (line    6)
* RFC; RFC 7725:                         HTTP status codes.  (line  154)
* RFC; RFC 7914:                         Key derivation.     (line   48)
* RFC; RFC 821:                          smtplib — SMTP protocol client.
                                                             (line   12)
* RFC; RFC 821 <1>:                      smtplib — SMTP protocol client.
                                                             (line  174)
* RFC; RFC 822:                          New and Improved Modules<3>.
                                                             (line   97)
* RFC; RFC 822 <1>:                      Functions<2>.       (line  612)
* RFC; RFC 822 <2>:                      Functions<2>.       (line  615)
* RFC; RFC 822 <3>:                      email Examples.     (line   15)
* RFC; RFC 822 <4>:                      email header Internationalized headers.
                                                             (line   21)
* RFC; RFC 822 <5>:                      HTTPConnection Objects.
                                                             (line  135)
* RFC; RFC 822 <6>:                      SMTP Objects.       (line   94)
* RFC; RFC 822 <7>:                      SMTP Objects.       (line  232)
* RFC; RFC 822 <8>:                      SMTP Objects.       (line  233)
* RFC; RFC 822 <9>:                      SMTP Example.       (line   10)
* RFC; RFC 822 <10>:                     The GNUTranslations class.
                                                             (line   13)
* RFC; RFC 822 <11>:                     distutils util — Miscellaneous other utility functions.
                                                             (line  174)
* RFC; RFC 8305:                         Opening network connections.
                                                             (line   76)
* RFC; RFC 8305 <1>:                     Opening network connections.
                                                             (line   85)
* RFC; RFC 854:                          telnetlib — Telnet client.
                                                             (line   11)
* RFC; RFC 854 <1>:                      telnetlib — Telnet client.
                                                             (line   55)
* RFC; RFC 959:                          ftplib — FTP protocol client.
                                                             (line   16)
* RFC; RFC 959 <1>:                      FTP Objects.        (line  148)
* RFC; RFC 977:                          nntplib — NNTP protocol client.
                                                             (line   13)
* RFC_4122 (in module uuid):             uuid — UUID objects according to RFC 4122.
                                                             (line  223)
* rfile (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  107)
* rfind() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  159)
* rfind() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  159)
* rfind() (mmap.mmap method):            mmap — Memory-mapped file support.
                                                             (line  216)
* rfind() (str method):                  String Methods<2>.  (line  345)
* rgb_to_hls() (in module colorsys):     colorsys — Conversions between color systems.
                                                             (line   36)
* rgb_to_hsv() (in module colorsys):     colorsys — Conversions between color systems.
                                                             (line   44)
* rgb_to_yiq() (in module colorsys):     colorsys — Conversions between color systems.
                                                             (line   28)
* rglob() (pathlib.Path method):         Methods<2>.         (line  341)
* richcmpfunc (C type):                  Slot Type typedefs. (line   91)
* right (filecmp.dircmp attribute):      The dircmp class.   (line   45)
* right() (in module turtle):            Turtle motion.      (line   29)
* RIGHTSHIFT (in module token):          token — Constants used with Python parse trees.
                                                             (line  162)
* RIGHTSHIFTEQUAL (in module token):     token — Constants used with Python parse trees.
                                                             (line  206)
* right_list (filecmp.dircmp attribute): The dircmp class.   (line   54)
* right_only (filecmp.dircmp attribute): The dircmp class.   (line   67)
* rindex() (bytearray method):           Bytes and Bytearray Operations.
                                                             (line  173)
* rindex() (bytes method):               Bytes and Bytearray Operations.
                                                             (line  173)
* rindex() (str method):                 String Methods<2>.  (line  352)
* rjust() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  283)
* rjust() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  283)
* rjust() (str method):                  String Methods<2>.  (line  357)
* rlcompleter (module):                  rlcompleter — Completion function for GNU readline.
                                                             (line    6)
* rlecode_hqx() (in module binascii):    binascii — Convert between binary and ASCII.
                                                             (line   95)
* rledecode_hqx() (in module binascii):  binascii — Convert between binary and ASCII.
                                                             (line   83)
* RLIMIT_AS (in module resource):        Resource Limits.    (line  141)
* RLIMIT_CORE (in module resource):      Resource Limits.    (line   86)
* RLIMIT_CPU (in module resource):       Resource Limits.    (line   93)
* RLIMIT_DATA (in module resource):      Resource Limits.    (line  105)
* RLIMIT_FSIZE (in module resource):     Resource Limits.    (line  101)
* RLIMIT_MEMLOCK (in module resource):   Resource Limits.    (line  133)
* RLIMIT_MSGQUEUE (in module resource):  Resource Limits.    (line  146)
* RLIMIT_NICE (in module resource):      Resource Limits.    (line  154)
* RLIMIT_NOFILE (in module resource):    Resource Limits.    (line  124)
* RLIMIT_NPROC (in module resource):     Resource Limits.    (line  120)
* RLIMIT_NPTS (in module resource):      Resource Limits.    (line  209)
* RLIMIT_OFILE (in module resource):     Resource Limits.    (line  129)
* RLIMIT_RSS (in module resource):       Resource Limits.    (line  115)
* RLIMIT_RTPRIO (in module resource):    Resource Limits.    (line  163)
* RLIMIT_RTTIME (in module resource):    Resource Limits.    (line  171)
* RLIMIT_SBSIZE (in module resource):    Resource Limits.    (line  188)
* RLIMIT_SIGPENDING (in module resource): Resource Limits.   (line  180)
* RLIMIT_STACK (in module resource):     Resource Limits.    (line  109)
* RLIMIT_SWAP (in module resource):      Resource Limits.    (line  198)
* RLIMIT_VMEM (in module resource):      Resource Limits.    (line  137)
* RLIM_INFINITY (in module resource):    Resource Limits.    (line   20)
* RLock (class in multiprocessing):      Synchronization primitives.
                                                             (line  102)
* RLock (class in threading):            RLock Objects.      (line   23)
* RLock() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  181)
* rmd() (ftplib.FTP method):             FTP Objects.        (line  225)
* rmdir() (in module os):                Files and Directories.
                                                             (line  682)
* rmdir() (in module test.support):      test support — Utilities for the Python test suite.
                                                             (line  177)
* rmdir() (pathlib.Path method):         Methods<2>.         (line  353)
* RMFF:                                  chunk — Read IFF chunked data.
                                                             (line    8)
* rms() (in module audioop):             audioop — Manipulate raw audio data.
                                                             (line  192)
* rmtree() (in module shutil):           Directory and files operations.
                                                             (line  233)
* rmtree() (in module test.support):     test support — Utilities for the Python test suite.
                                                             (line  183)
* RobotFileParser (class in urllib.robotparser): urllib robotparser — Parser for robots txt.
                                                             (line   16)
* robots.txt:                            urllib robotparser — Parser for robots txt.
                                                             (line    8)
* rollback() (sqlite3.Connection method): Connection Objects.
                                                             (line   40)
* rotate() (collections.deque method):   deque objects.      (line  109)
* rotate() (decimal.Context method):     Context objects.    (line  477)
* rotate() (decimal.Decimal method):     Decimal objects.    (line  515)
* rotate() (logging.handlers.BaseRotatingHandler method): BaseRotatingHandler.
                                                             (line   58)
* RotatingFileHandler (class in logging.handlers): RotatingFileHandler.
                                                             (line    9)
* rotation_filename() (logging.handlers.BaseRotatingHandler method): BaseRotatingHandler.
                                                             (line   41)
* rotator (logging.handlers.BaseRotatingHandler attribute): BaseRotatingHandler.
                                                             (line   32)
* ROT_FOUR (opcode):                     Python Bytecode Instructions.
                                                             (line   72)
* ROT_THREE (opcode):                    Python Bytecode Instructions.
                                                             (line   67)
* ROT_TWO (opcode):                      Python Bytecode Instructions.
                                                             (line   63)
* round() (built-in function):           Built-in Functions. (line 1432)
* Rounded (class in decimal):            Signals.            (line   77)
* ROUND_05UP (in module decimal):        Rounding modes.     (line   34)
* ROUND_CEILING (in module decimal):     Rounding modes.     (line    6)
* ROUND_DOWN (in module decimal):        Rounding modes.     (line   10)
* ROUND_FLOOR (in module decimal):       Rounding modes.     (line   14)
* ROUND_HALF_DOWN (in module decimal):   Rounding modes.     (line   18)
* ROUND_HALF_EVEN (in module decimal):   Rounding modes.     (line   22)
* ROUND_HALF_UP (in module decimal):     Rounding modes.     (line   26)
* ROUND_UP (in module decimal):          Rounding modes.     (line   30)
* Row (class in sqlite3):                Row Objects.        (line    6)
* rowcount (sqlite3.Cursor attribute):   Cursor Objects.     (line  178)
* row_factory (sqlite3.Connection attribute): Connection Objects.
                                                             (line  301)
* RPAR (in module token):                token — Constants used with Python parse trees.
                                                             (line   58)
* rpartition() (bytearray method):       Bytes and Bytearray Operations.
                                                             (line  185)
* rpartition() (bytes method):           Bytes and Bytearray Operations.
                                                             (line  185)
* rpartition() (str method):             String Methods<2>.  (line  364)
* rpc_paths (xmlrpc.server.SimpleXMLRPCRequestHandler attribute): SimpleXMLRPCServer Objects.
                                                             (line   64)
* rpop() (poplib.POP3 method):           POP3 Objects.       (line   46)
* rset() (poplib.POP3 method):           POP3 Objects.       (line   74)
* rshift() (in module operator):         operator — Standard operators as functions.
                                                             (line  148)
* rsplit() (bytearray method):           Bytes and Bytearray Operations.
                                                             (line  295)
* rsplit() (bytes method):               Bytes and Bytearray Operations.
                                                             (line  295)
* rsplit() (str method):                 String Methods<2>.  (line  372)
* RSQB (in module token):                token — Constants used with Python parse trees.
                                                             (line   66)
* rstrip() (bytearray method):           Bytes and Bytearray Operations.
                                                             (line  306)
* rstrip() (bytes method):               Bytes and Bytearray Operations.
                                                             (line  306)
* rstrip() (str method):                 String Methods<2>.  (line  381)
* rt() (in module turtle):               Turtle motion.      (line   29)
* RTLD_DEEPBIND (in module os):          Miscellaneous System Information.
                                                             (line  141)
* RTLD_GLOBAL (in module os):            Miscellaneous System Information.
                                                             (line  141)
* RTLD_LAZY (in module os):              Miscellaneous System Information.
                                                             (line  141)
* RTLD_LOCAL (in module os):             Miscellaneous System Information.
                                                             (line  141)
* RTLD_NODELETE (in module os):          Miscellaneous System Information.
                                                             (line  141)
* RTLD_NOLOAD (in module os):            Miscellaneous System Information.
                                                             (line  141)
* RTLD_NOW (in module os):               Miscellaneous System Information.
                                                             (line  141)
* ruler (cmd.Cmd attribute):             Cmd Objects.        (line  164)
* run (pdb command):                     Debugger Commands.  (line  315)
* Run script:                            Format menu Editor window only.
                                                             (line   53)
* run() (bdb.Bdb method):                bdb — Debugger framework.
                                                             (line  363)
* run() (contextvars.Context method):    Manual Context Management.
                                                             (line   30)
* run() (distutils.cmd.Command method):  Creating a new Distutils command.
                                                             (line   40)
* run() (doctest.DocTestRunner method):  DocTestRunner objects.
                                                             (line   95)
* run() (in module asyncio):             Running an asyncio Program.
                                                             (line    6)
* run() (in module pdb):                 pdb — The Python Debugger.
                                                             (line   71)
* run() (in module profile):             profile and cProfile Module Reference.
                                                             (line    9)
* run() (in module subprocess):          Using the subprocess Module.
                                                             (line   15)
* run() (multiprocessing.Process method): Process and exceptions.
                                                             (line   33)
* run() (pdb.Pdb method):                pdb — The Python Debugger.
                                                             (line  158)
* run() (profile.Profile method):        profile and cProfile Module Reference.
                                                             (line   85)
* run() (sched.scheduler method):        Scheduler Objects.  (line   51)
* run() (test.support.BasicTestRunner method): test support — Utilities for the Python test suite.
                                                             (line 1036)
* run() (threading.Thread method):       Thread Objects.     (line  100)
* run() (trace.Trace method):            Programmatic Interface.
                                                             (line   22)
* run() (unittest.IsolatedAsyncioTestCase method): Test cases.
                                                             (line  818)
* run() (unittest.TestCase method):      Test cases.         (line   79)
* run() (unittest.TestSuite method):     Grouping tests.     (line   41)
* run() (unittest.TextTestRunner method): Loading and running tests.
                                                             (line  479)
* run() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line   98)
* runcall() (bdb.Bdb method):            bdb — Debugger framework.
                                                             (line  380)
* runcall() (in module pdb):             pdb — The Python Debugger.
                                                             (line   90)
* runcall() (pdb.Pdb method):            pdb — The Python Debugger.
                                                             (line  158)
* runcall() (profile.Profile method):    profile and cProfile Module Reference.
                                                             (line   94)
* runcode() (code.InteractiveInterpreter method): Interactive Interpreter Objects.
                                                             (line   33)
* runctx() (bdb.Bdb method):             bdb — Debugger framework.
                                                             (line  375)
* runctx() (in module profile):          profile and cProfile Module Reference.
                                                             (line   23)
* runctx() (profile.Profile method):     profile and cProfile Module Reference.
                                                             (line   89)
* runctx() (trace.Trace method):         Programmatic Interface.
                                                             (line   29)
* runeval() (bdb.Bdb method):            bdb — Debugger framework.
                                                             (line  369)
* runeval() (in module pdb):             pdb — The Python Debugger.
                                                             (line   83)
* runeval() (pdb.Pdb method):            pdb — The Python Debugger.
                                                             (line  158)
* runfunc() (trace.Trace method):        Programmatic Interface.
                                                             (line   36)
* running() (concurrent.futures.Future method): Future Objects.
                                                             (line   28)
* runpy (module):                        runpy — Locating and executing Python modules.
                                                             (line    6)
* runsource() (code.InteractiveInterpreter method): Interactive Interpreter Objects.
                                                             (line    6)
* RuntimeError:                          Concrete exceptions.
                                                             (line  204)
* RuntimeWarning:                        Warnings.           (line   36)
* runtime_checkable() (in module typing): Classes functions and decorators.
                                                             (line  611)
* runtime_library_dir_option() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  230)
* run_coroutine_threadsafe() (in module asyncio): Scheduling From Other Threads.
                                                             (line    6)
* run_docstring_examples() (in module doctest): Basic API.   (line  128)
* run_doctest() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  269)
* run_forever() (asyncio.loop method):   Running and stopping the loop.
                                                             (line   16)
* run_in_executor() (asyncio.loop method): Executing code in thread or process pools.
                                                             (line    6)
* run_in_subinterp() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  899)
* run_module() (in module runpy):        runpy — Locating and executing Python modules.
                                                             (line   27)
* run_path() (in module runpy):          runpy — Locating and executing Python modules.
                                                             (line   95)
* run_python_until_end() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   30)
* run_script() (modulefinder.ModuleFinder method): modulefinder — Find modules used by a script.
                                                             (line   44)
* run_setup() (in module distutils.core): distutils core — Core Distutils functionality.
                                                             (line  121)
* run_unittest() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  254)
* run_until_complete() (asyncio.loop method): Running and stopping the loop.
                                                             (line    6)
* run_with_locale() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  549)
* run_with_tz() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  557)
* RUSAGE_BOTH (in module resource):      Resource Usage.     (line  112)
* RUSAGE_CHILDREN (in module resource):  Resource Usage.     (line  106)
* RUSAGE_SELF (in module resource):      Resource Usage.     (line  100)
* RUSAGE_THREAD (in module resource):    Resource Usage.     (line  118)
* RWF_DSYNC (in module os):              File Descriptor Operations.
                                                             (line  526)
* RWF_HIPRI (in module os):              File Descriptor Operations.
                                                             (line  473)
* RWF_NOWAIT (in module os):             File Descriptor Operations.
                                                             (line  458)
* RWF_SYNC (in module os):               File Descriptor Operations.
                                                             (line  536)
* R_OK (in module os):                   Files and Directories.
                                                             (line  106)
* S (in module re):                      Module Contents.    (line  113)
* safe (uuid.SafeUUID attribute):        uuid — UUID objects according to RFC 4122.
                                                             (line   33)
* SafeChildWatcher (class in asyncio):   Process Watchers.   (line  118)
* saferepr() (in module pprint):         pprint — Data pretty printer.
                                                             (line  145)
* SafeUUID (class in uuid):              uuid — UUID objects according to RFC 4122.
                                                             (line   29)
* safe_substitute() (string.Template method): Template strings.
                                                             (line   50)
* samefile() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  323)
* samefile() (pathlib.Path method):      Methods<2>.         (line  357)
* SameFileError:                         Directory and files operations.
                                                             (line   49)
* sameopenfile() (in module os.path):    os path — Common pathname manipulations.
                                                             (line  339)
* samestat() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  350)
* same_files (filecmp.dircmp attribute): The dircmp class.   (line   85)
* same_quantum() (decimal.Context method): Context objects.  (line  481)
* same_quantum() (decimal.Decimal method): Decimal objects.  (line  527)
* sample() (in module random):           Functions for sequences.
                                                             (line   67)
* samples() (statistics.NormalDist method): NormalDist objects.
                                                             (line   58)
* save() (http.cookiejar.FileCookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line  105)
* SAVEDCWD (in module test.support):     test support — Utilities for the Python test suite.
                                                             (line   87)
* SaveKey() (in module winreg):          Functions<11>.      (line  399)
* SaveSignals (class in test.support):   test support — Utilities for the Python test suite.
                                                             (line 1013)
* savetty() (in module curses):          Functions<3>.       (line  424)
* SAX2DOM (class in xml.dom.pulldom):    xml dom pulldom — Support for building partial DOM trees.
                                                             (line   69)
* SAXException:                          xml sax — Support for SAX2 parsers.
                                                             (line   86)
* SAXNotRecognizedException:             xml sax — Support for SAX2 parsers.
                                                             (line  111)
* SAXNotSupportedException:              xml sax — Support for SAX2 parsers.
                                                             (line  118)
* SAXParseException:                     xml sax — Support for SAX2 parsers.
                                                             (line  103)
* scaleb() (decimal.Context method):     Context objects.    (line  485)
* scaleb() (decimal.Decimal method):     Decimal objects.    (line  537)
* scandir() (in module os):              Files and Directories.
                                                             (line  696)
* scanf():                               Simulating scanf.   (line    6)
* sched (module):                        sched — Event scheduler.
                                                             (line    6)
* scheduler (class in sched):            sched — Event scheduler.
                                                             (line   13)
* SCHED_BATCH (in module os):            Interface to the scheduler.
                                                             (line   19)
* SCHED_FIFO (in module os):             Interface to the scheduler.
                                                             (line   32)
* sched_getaffinity() (in module os):    Interface to the scheduler.
                                                             (line  109)
* sched_getparam() (in module os):       Interface to the scheduler.
                                                             (line   87)
* sched_getscheduler() (in module os):   Interface to the scheduler.
                                                             (line   75)
* sched_get_priority_max() (in module os): Interface to the scheduler.
                                                             (line   63)
* sched_get_priority_min() (in module os): Interface to the scheduler.
                                                             (line   58)
* SCHED_IDLE (in module os):             Interface to the scheduler.
                                                             (line   24)
* SCHED_OTHER (in module os):            Interface to the scheduler.
                                                             (line   15)
* sched_param (class in os):             Interface to the scheduler.
                                                             (line   46)
* sched_priority (os.sched_param attribute): Interface to the scheduler.
                                                             (line   54)
* SCHED_RESET_ON_FORK (in module os):    Interface to the scheduler.
                                                             (line   40)
* SCHED_RR (in module os):               Interface to the scheduler.
                                                             (line   36)
* sched_rr_get_interval() (in module os): Interface to the scheduler.
                                                             (line   93)
* sched_setaffinity() (in module os):    Interface to the scheduler.
                                                             (line  102)
* sched_setparam() (in module os):       Interface to the scheduler.
                                                             (line   81)
* sched_setscheduler() (in module os):   Interface to the scheduler.
                                                             (line   68)
* SCHED_SPORADIC (in module os):         Interface to the scheduler.
                                                             (line   28)
* sched_yield() (in module os):          Interface to the scheduler.
                                                             (line   98)
* schema (in module msilib):             Precomputed tables. (line   10)
* scope:                                 Naming and binding. (line    6)
* scope <1>:                             Resolution of names.
                                                             (line    6)
* Screen (class in turtle):              Public classes.     (line   30)
* screensize() (in module turtle):       Window control.     (line   52)
* script_from_examples() (in module doctest): Debugging.     (line   36)
* scroll() (curses.window method):       Window Objects.     (line  497)
* ScrolledCanvas (class in turtle):      Public classes.     (line   34)
* scrollok() (curses.window method):     Window Objects.     (line  501)
* scrypt() (in module hashlib):          Key derivation.     (line   44)
* seal() (in module unittest.mock):      Sealing mocks.      (line    6)
* search() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  216)
* search() (in module re):               Module Contents.    (line  143)
* search() (re.Pattern method):          Regular Expression Objects.
                                                             (line    9)
* second (datetime.datetime attribute):  datetime Objects.   (line  286)
* second (datetime.time attribute):      time Objects.       (line   58)
* seconds since the epoch:               time — Time access and conversions.
                                                             (line   25)
* secrets (module):                      secrets — Generate secure random numbers for managing secrets.
                                                             (line    6)
* SECTCRE (configparser.ConfigParser attribute): Customizing Parser Behaviour.
                                                             (line  300)
* sections() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line   81)
* secure (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   45)
* secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512: hashlib — Secure hashes and message digests.
                                                             (line    8)
* Secure Sockets Layer:                  ssl — TLS/SSL wrapper for socket objects.
                                                             (line    8)
* see() (tkinter.ttk.Treeview method):   ttk Treeview.       (line  251)
* seed() (in module random):             Bookkeeping functions.
                                                             (line    6)
* seek() (chunk.Chunk method):           chunk — Read IFF chunked data.
                                                             (line   92)
* seek() (io.IOBase method):             I/O Base Classes.   (line  104)
* seek() (io.TextIOBase method):         Text I/O<2>.        (line   66)
* seek() (mmap.mmap method):             mmap — Memory-mapped file support.
                                                             (line  226)
* seekable() (io.IOBase method):         I/O Base Classes.   (line  129)
* SEEK_CUR (in module os):               File Descriptor Operations.
                                                             (line  240)
* SEEK_END (in module os):               File Descriptor Operations.
                                                             (line  240)
* SEEK_SET (in module os):               File Descriptor Operations.
                                                             (line  240)
* seen_greeting (smtpd.SMTPChannel attribute): SMTPChannel Objects.
                                                             (line   69)
* Select (class in tkinter.tix):         Basic Widgets.      (line   59)
* select (module):                       select — Waiting for I/O completion.
                                                             (line    6)
* select() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  229)
* select() (in module select):           select — Waiting for I/O completion.
                                                             (line  110)
* select() (selectors.BaseSelector method): Classes<3>.      (line  103)
* select() (tkinter.ttk.Notebook method): ttk Notebook.      (line   53)
* selected_alpn_protocol() (ssl.SSLSocket method): SSL Sockets.
                                                             (line  236)
* selected_npn_protocol() (ssl.SSLSocket method): SSL Sockets.
                                                             (line  246)
* selection() (tkinter.ttk.Treeview method): ttk Treeview.   (line  259)
* selection_add() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  274)
* selection_remove() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  281)
* selection_set() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  267)
* selection_toggle() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  288)
* selector (urllib.request.Request attribute): Request Objects.
                                                             (line   34)
* SelectorEventLoop (class in asyncio):  Event Loop Implementations.
                                                             (line   12)
* SelectorKey (class in selectors):      Classes<3>.         (line   24)
* selectors (module):                    selectors — High-level I/O multiplexing.
                                                             (line    6)
* SelectSelector (class in selectors):   Classes<3>.         (line  162)
* Semaphore (class in asyncio):          Semaphore.          (line    6)
* Semaphore (class in multiprocessing):  Synchronization primitives.
                                                             (line  167)
* Semaphore (class in threading):        Semaphore Objects.  (line   19)
* Semaphore() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  186)
* semaphores, binary:                    _thread — Low-level threading API.
                                                             (line    6)
* SEMI (in module token):                token — Constants used with Python parse trees.
                                                             (line   78)
* send() (asyncore.dispatcher method):   asyncore — Asynchronous socket handler.
                                                             (line  198)
* send() (coroutine method):             Coroutine Objects.  (line   23)
* send() (generator method):             Generator-iterator methods.
                                                             (line   27)
* send() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line  167)
* send() (imaplib.IMAP4 method):         IMAP4 Objects.      (line  236)
* send() (logging.handlers.DatagramHandler method): DatagramHandler.
                                                             (line   34)
* send() (logging.handlers.SocketHandler method): SocketHandler.
                                                             (line   61)
* send() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   15)
* send() (socket.socket method):         Socket Objects.     (line  362)
* sendall() (socket.socket method):      Socket Objects.     (line  378)
* sendcmd() (ftplib.FTP method):         FTP Objects.        (line   66)
* sendfile() (asyncio.loop method):      Transferring files. (line    6)
* sendfile() (in module os):             File Descriptor Operations.
                                                             (line  567)
* sendfile() (socket.socket method):     Socket Objects.     (line  466)
* sendfile() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  274)
* SendfileNotAvailableError:             Exceptions<9>.      (line   35)
* sendmail() (smtplib.SMTP method):      SMTP Objects.       (line  229)
* sendmsg() (socket.socket method):      Socket Objects.     (line  416)
* sendmsg_afalg() (socket.socket method): Socket Objects.    (line  455)
* sendto() (asyncio.DatagramTransport method): Datagram Transports.
                                                             (line    6)
* sendto() (socket.socket method):       Socket Objects.     (line  397)
* send_bytes() (multiprocessing.connection.Connection method): Connection Objects<2>.
                                                             (line   54)
* send_error() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  203)
* send_flowing_data() (formatter.writer method): The Writer Interface.
                                                             (line   76)
* send_header() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  239)
* send_hor_rule() (formatter.writer method): The Writer Interface.
                                                             (line   68)
* send_label_data() (formatter.writer method): The Writer Interface.
                                                             (line   92)
* send_line_break() (formatter.writer method): The Writer Interface.
                                                             (line   54)
* send_literal_data() (formatter.writer method): The Writer Interface.
                                                             (line   83)
* send_message() (smtplib.SMTP method):  SMTP Objects.       (line  307)
* send_paragraph() (formatter.writer method): The Writer Interface.
                                                             (line   58)
* send_response() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  223)
* send_response_only() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  252)
* send_signal() (asyncio.asyncio.subprocess.Process method): Interacting with Subprocesses.
                                                             (line   81)
* send_signal() (asyncio.SubprocessTransport method): Subprocess Transports.
                                                             (line   44)
* send_signal() (subprocess.Popen method): Popen Objects.    (line   68)
* sentinel (in module unittest.mock):    sentinel.           (line    6)
* sentinel (multiprocessing.Process attribute): Process and exceptions.
                                                             (line  134)
* sep (in module os):                    Miscellaneous System Information.
                                                             (line   93)
* sequence:                              Glossary.           (line 1103)
* Sequence (class in collections.abc):   Collections Abstract Base Classes.
                                                             (line  152)
* Sequence (class in typing):            Classes functions and decorators.
                                                             (line  190)
* sequence (in module msilib):           Precomputed tables. (line   16)
* sequence2st() (in module parser):      Creating ST Objects.
                                                             (line   26)
* sequence; item:                        Subscriptions.      (line    6)
* sequence; iteration:                   Iterator Types.     (line    6)
* SequenceMatcher (class in difflib):    difflib — Helpers for computing deltas.
                                                             (line   16)
* SequenceMatcher (class in difflib) <1>: SequenceMatcher Objects.
                                                             (line    8)
* serializing; objects:                  pickle — Python object serialization.
                                                             (line    8)
* Server (class in asyncio):             Server Objects.     (line   12)
* server (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line   68)
* ServerProxy (class in xmlrpc.client):  xmlrpc client — XML-RPC client access.
                                                             (line   24)
* server_activate() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  162)
* server_address (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line   74)
* server_bind() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  168)
* server_close() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line   59)
* server_hostname (ssl.SSLSocket attribute): SSL Sockets.    (line  318)
* server_side (ssl.SSLSocket attribute): SSL Sockets.        (line  311)
* server_software (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  175)
* server_version (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  124)
* server_version (http.server.SimpleHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  341)
* serve_forever() (asyncio.Server method): Server Objects.   (line   58)
* serve_forever() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line   32)
* service_actions() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line   45)
* session (ssl.SSLSocket attribute):     SSL Sockets.        (line  331)
* session_reused (ssl.SSLSocket attribute): SSL Sockets.     (line  341)
* session_stats() (ssl.SSLContext method): SSL Contexts.     (line  439)
* set (built-in class):                  Set Types — set frozenset.
                                                             (line   33)
* Set (class in collections.abc):        Collections Abstract Base Classes.
                                                             (line  170)
* Set (class in typing):                 Classes functions and decorators.
                                                             (line  227)
* Set Breakpoint:                        Help menu Shell and Editor.
                                                             (line   30)
* set() (asyncio.Event method):          Event.              (line   33)
* set() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  250)
* set() (configparser.RawConfigParser method): RawConfigParser Objects.
                                                             (line   37)
* set() (contextvars.ContextVar method): Context Variables.  (line   46)
* set() (http.cookies.Morsel method):    Morsel Objects.     (line   64)
* set() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   69)
* set() (test.support.EnvironmentVarGuard method): test support — Utilities for the Python test suite.
                                                             (line  969)
* set() (threading.Event method):        Event Objects.      (line   27)
* set() (tkinter.ttk.Combobox method):   ttk Combobox.       (line   19)
* set() (tkinter.ttk.Spinbox method):    ttk Spinbox.        (line   12)
* set() (tkinter.ttk.Treeview method):   ttk Treeview.       (line  295)
* set() (xml.etree.ElementTree.Element method): Element Objects.
                                                             (line   81)
* set; display:                          Set displays.       (line    6)
* setacl() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  243)
* setannotation() (imaplib.IMAP4 method): IMAP4 Objects.     (line  248)
* setattr() (built-in function):         Built-in Functions. (line 1469)
* setattrfunc (C type):                  Slot Type typedefs. (line   57)
* setAttribute() (xml.dom.Element method): Element Objects<2>.
                                                             (line   67)
* setAttributeNode() (xml.dom.Element method): Element Objects<2>.
                                                             (line   71)
* setAttributeNodeNS() (xml.dom.Element method): Element Objects<2>.
                                                             (line   79)
* setAttributeNS() (xml.dom.Element method): Element Objects<2>.
                                                             (line   87)
* setattrofunc (C type):                 Slot Type typedefs. (line   69)
* SetBase() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line   22)
* setblocking() (socket.socket method):  Socket Objects.     (line  490)
* setByteStream() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   36)
* setcbreak() (in module tty):           tty — Terminal control functions.
                                                             (line   24)
* setCharacterStream() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   55)
* setcheckinterval() (in module sys):    sys — System-specific parameters and functions.
                                                             (line 1147)
* setcomptype() (aifc.aifc method):      aifc — Read and write AIFF and AIFC files.
                                                             (line  158)
* setcomptype() (sunau.AU_write method): AU_write Objects.   (line   28)
* setcomptype() (wave.Wave_write method): Wave_write Objects.
                                                             (line   51)
* setContentHandler() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   25)
* setcontext() (in module decimal):      Context objects.    (line   18)
* setDaemon() (threading.Thread method): Thread Objects.     (line  197)
* setdefault() (dict method):            Mapping Types — dict.
                                                             (line  191)
* setdefault() (http.cookies.Morsel method): Morsel Objects. (line  108)
* setdefaulttimeout() (in module socket): Other functions<2>.
                                                             (line  335)
* setdlopenflags() (in module sys):      sys — System-specific parameters and functions.
                                                             (line 1163)
* setDocumentLocator() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line   10)
* setDTDHandler() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   34)
* setegid() (in module os):              Process Parameters. (line  335)
* setEncoding() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   22)
* setEntityResolver() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   43)
* setErrorHandler() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   54)
* seteuid() (in module os):              Process Parameters. (line  341)
* setFeature() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   76)
* setfirstweekday() (in module calendar): calendar — General calendar-related functions.
                                                             (line  287)
* setfmt() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  125)
* setFormatter() (logging.Handler method): Handler Objects.  (line   48)
* setframerate() (aifc.aifc method):     aifc — Read and write AIFF and AIFC files.
                                                             (line  148)
* setframerate() (sunau.AU_write method): AU_write Objects.  (line   19)
* setframerate() (wave.Wave_write method): Wave_write Objects.
                                                             (line   38)
* setgid() (in module os):               Process Parameters. (line  347)
* setgroups() (in module os):            Process Parameters. (line  353)
* seth() (in module turtle):             Turtle motion.      (line   94)
* setheading() (in module turtle):       Turtle motion.      (line   94)
* sethostname() (in module socket):      Other functions<2>. (line  342)
* SetInteger() (msilib.Record method):   Record Objects.     (line   32)
* setitem() (in module operator):        operator — Standard operators as functions.
                                                             (line  201)
* setitimer() (in module signal):        Module contents<2>. (line  234)
* setLevel() (logging.Handler method):   Handler Objects.    (line   35)
* setLevel() (logging.Logger method):    Logger Objects.     (line   50)
* setlocale() (in module locale):        locale — Internationalization services.
                                                             (line   27)
* setLocale() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   60)
* setLoggerClass() (in module logging):  Module-Level Functions.
                                                             (line  329)
* setlogmask() (in module syslog):       syslog — Unix syslog library routines.
                                                             (line   64)
* setLogRecordFactory() (in module logging): Module-Level Functions.
                                                             (line  341)
* setmark() (aifc.aifc method):          aifc — Read and write AIFF and AIFC files.
                                                             (line  176)
* setMaxConns() (urllib.request.CacheFTPHandler method): CacheFTPHandler Objects.
                                                             (line   13)
* setmode() (in module msvcrt):          File Operations.    (line   35)
* setName() (threading.Thread method):   Thread Objects.     (line  142)
* setnchannels() (aifc.aifc method):     aifc — Read and write AIFF and AIFC files.
                                                             (line  140)
* setnchannels() (sunau.AU_write method): AU_write Objects.  (line    9)
* setnchannels() (wave.Wave_write method): Wave_write Objects.
                                                             (line   30)
* setnframes() (aifc.aifc method):       aifc — Read and write AIFF and AIFC files.
                                                             (line  152)
* setnframes() (sunau.AU_write method):  AU_write Objects.   (line   23)
* setnframes() (wave.Wave_write method): Wave_write Objects. (line   45)
* SetParamEntityParsing() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line   54)
* setparameters() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  189)
* setparams() (aifc.aifc method):        aifc — Read and write AIFF and AIFC files.
                                                             (line  168)
* setparams() (sunau.AU_write method):   AU_write Objects.   (line   33)
* setparams() (wave.Wave_write method):  Wave_write Objects. (line   56)
* setpassword() (zipfile.ZipFile method): ZipFile Objects.   (line  211)
* setpgid() (in module os):              Process Parameters. (line  376)
* setpgrp() (in module os):              Process Parameters. (line  368)
* setpos() (aifc.aifc method):           aifc — Read and write AIFF and AIFC files.
                                                             (line  108)
* setpos() (in module turtle):           Turtle motion.      (line   55)
* setpos() (sunau.AU_read method):       AU_read Objects.    (line   60)
* setpos() (wave.Wave_read method):      Wave_read Objects.  (line   69)
* setposition() (in module turtle):      Turtle motion.      (line   55)
* setpriority() (in module os):          Process Parameters. (line  384)
* setprofile() (in module sys):          sys — System-specific parameters and functions.
                                                             (line 1176)
* setprofile() (in module threading):    threading — Thread-based parallelism.
                                                             (line  120)
* SetProperty() (msilib.SummaryInformation method): Summary Information Objects.
                                                             (line   22)
* setProperty() (xml.sax.xmlreader.XMLReader method): XMLReader Objects.
                                                             (line   90)
* setPublicId() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line    6)
* setquota() (imaplib.IMAP4 method):     IMAP4 Objects.      (line  253)
* setraw() (in module tty):              tty — Terminal control functions.
                                                             (line   18)
* setrecursionlimit() (in module sys):   sys — System-specific parameters and functions.
                                                             (line 1228)
* setregid() (in module os):             Process Parameters. (line  401)
* setresgid() (in module os):            Process Parameters. (line  407)
* setresuid() (in module os):            Process Parameters. (line  415)
* setreuid() (in module os):             Process Parameters. (line  423)
* setrlimit() (in module resource):      Resource Limits.    (line   31)
* setsampwidth() (aifc.aifc method):     aifc — Read and write AIFF and AIFC files.
                                                             (line  144)
* setsampwidth() (sunau.AU_write method): AU_write Objects.  (line   13)
* setsampwidth() (wave.Wave_write method): Wave_write Objects.
                                                             (line   34)
* setscrreg() (curses.window method):    Window Objects.     (line  511)
* setsid() (in module os):               Process Parameters. (line  436)
* setsockopt() (socket.socket method):   Socket Objects.     (line  523)
* setsockopt() (socket.socket method) <1>: Socket Objects.   (line  525)
* setsockopt() (socket.socket method) <2>: Socket Objects.   (line  527)
* setstate() (codecs.IncrementalDecoder method): IncrementalDecoder Objects.
                                                             (line   60)
* setstate() (codecs.IncrementalEncoder method): IncrementalEncoder Objects.
                                                             (line   51)
* setstate() (in module random):         Bookkeeping functions.
                                                             (line   34)
* setStream() (logging.StreamHandler method): StreamHandler. (line   32)
* SetStream() (msilib.Record method):    Record Objects.     (line   26)
* SetString() (msilib.Record method):    Record Objects.     (line   21)
* setswitchinterval() (in module sys):   sys — System-specific parameters and functions.
                                                             (line 1246)
* setswitchinterval() (in module sys) <1>: Thread State and the Global Interpreter Lock.
                                                             (line   15)
* setswitchinterval() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  280)
* setSystemId() (xml.sax.xmlreader.InputSource method): InputSource Objects.
                                                             (line   14)
* setsyx() (in module curses):           Functions<3>.       (line  429)
* setTarget() (logging.handlers.MemoryHandler method): MemoryHandler.
                                                             (line   67)
* settiltangle() (in module turtle):     Appearance.         (line   92)
* settimeout() (socket.socket method):   Socket Objects.     (line  507)
* setTimeout() (urllib.request.CacheFTPHandler method): CacheFTPHandler Objects.
                                                             (line    9)
* settrace() (in module sys):            sys — System-specific parameters and functions.
                                                             (line 1259)
* settrace() (in module threading):      threading — Thread-based parallelism.
                                                             (line  113)
* setuid() (in module os):               Process Parameters. (line  443)
* setundobuffer() (in module turtle):    Special Turtle methods.
                                                             (line   45)
* setup() (in module distutils.core):    distutils core — Core Distutils functionality.
                                                             (line   12)
* setup() (in module turtle):            Methods specific to Screen not inherited from TurtleScreen.
                                                             (line   20)
* setup() (socketserver.BaseRequestHandler method): Request Handler Objects.
                                                             (line   14)
* setUp() (unittest.TestCase method):    Test cases.         (line   33)
* setUpClass() (unittest.TestCase method): Test cases.       (line   55)
* setupterm() (in module curses):        Functions<3>.       (line  434)
* SETUP_ANNOTATIONS (opcode):            Python Bytecode Instructions.
                                                             (line  357)
* SETUP_ASYNC_WITH (opcode):             Python Bytecode Instructions.
                                                             (line  303)
* setup_environ() (wsgiref.handlers.BaseHandler method): wsgiref handlers – server/gateway base classes.
                                                             (line  195)
* SETUP_FINALLY (opcode):                Python Bytecode Instructions.
                                                             (line  696)
* setup_python() (venv.EnvBuilder method): API<2>.           (line   81)
* setup_scripts() (venv.EnvBuilder method): API<2>.          (line   89)
* setup_testing_defaults() (in module wsgiref.util): wsgiref util – WSGI environment utilities.
                                                             (line   68)
* SETUP_WITH (opcode):                   Python Bytecode Instructions.
                                                             (line  438)
* SetValue() (in module winreg):         Functions<11>.      (line  423)
* SetValueEx() (in module winreg):       Functions<11>.      (line  454)
* setworldcoordinates() (in module turtle): Window control.  (line   75)
* setx() (in module turtle):             Turtle motion.      (line   74)
* setxattr() (in module os):             Linux extended attributes.
                                                             (line   48)
* sety() (in module turtle):             Turtle motion.      (line   84)
* SET_ADD (opcode):                      Python Bytecode Instructions.
                                                             (line  317)
* set_all():                             Reference Count Details.
                                                             (line   71)
* set_allowed_domains() (http.cookiejar.DefaultCookiePolicy method): DefaultCookiePolicy Objects.
                                                             (line   63)
* set_alpn_protocols() (ssl.SSLContext method): SSL Contexts.
                                                             (line  211)
* set_app() (wsgiref.simple_server.WSGIServer method): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   52)
* set_asyncgen_hooks() (in module sys):  sys — System-specific parameters and functions.
                                                             (line 1355)
* set_authorizer() (sqlite3.Connection method): Connection Objects.
                                                             (line  194)
* set_auto_history() (in module readline): History list.     (line   43)
* set_blocked_domains() (http.cookiejar.DefaultCookiePolicy method): DefaultCookiePolicy Objects.
                                                             (line   49)
* set_blocking() (in module os):         File Descriptor Operations.
                                                             (line  603)
* set_boundary() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  408)
* set_boundary() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  573)
* set_break() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  281)
* set_charset() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  225)
* set_children() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line   25)
* set_child_watcher() (asyncio.AbstractEventLoopPolicy method): Policy Objects.
                                                             (line   42)
* set_child_watcher() (in module asyncio): Process Watchers. (line   29)
* set_ciphers() (ssl.SSLContext method): SSL Contexts.       (line  197)
* set_completer() (in module readline):  Completion.         (line   14)
* set_completer_delims() (in module readline): Completion.   (line   48)
* set_completion_display_matches_hook() (in module readline): Completion.
                                                             (line   57)
* set_content() (email.contentmanager.ContentManager method): email contentmanager Managing MIME Content.
                                                             (line   40)
* set_content() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  561)
* set_content() (in module email.contentmanager): Content Manager Instances.
                                                             (line   35)
* set_continue() (bdb.Bdb method):       bdb — Debugger framework.
                                                             (line  266)
* set_cookie() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   72)
* set_cookie_if_ok() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   68)
* set_coroutine_origin_tracking_depth() (in module sys): sys — System-specific parameters and functions.
                                                             (line 1380)
* set_current() (msilib.Feature method): Features<3>.        (line   14)
* set_data() (importlib.abc.SourceLoader method): importlib abc – Abstract base classes related to import.
                                                             (line  558)
* set_data() (importlib.machinery.SourceFileLoader method): importlib machinery – Importers and path hooks.
                                                             (line  238)
* set_date() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   97)
* set_debug() (asyncio.loop method):     Enabling debug mode.
                                                             (line   14)
* set_debug() (in module gc):            gc — Garbage Collector interface.
                                                             (line   48)
* set_debuglevel() (ftplib.FTP method):  FTP Objects.        (line   13)
* set_debuglevel() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line   71)
* set_debuglevel() (nntplib.NNTP method): Methods<3>.        (line  271)
* set_debuglevel() (poplib.POP3 method): POP3 Objects.       (line   11)
* set_debuglevel() (smtplib.SMTP method): SMTP Objects.      (line    8)
* set_debuglevel() (telnetlib.Telnet method): Telnet Objects.
                                                             (line   84)
* set_defaults() (argparse.ArgumentParser method): Parser defaults.
                                                             (line    6)
* set_defaults() (optparse.OptionParser method): Other methods.
                                                             (line   27)
* set_default_executor() (asyncio.loop method): Executing code in thread or process pools.
                                                             (line   28)
* set_default_type() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  339)
* set_default_type() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  437)
* set_default_verify_paths() (ssl.SSLContext method): SSL Contexts.
                                                             (line  188)
* set_ecdh_curve() (ssl.SSLContext method): SSL Contexts.    (line  327)
* set_errno() (in module ctypes):        Utility functions.  (line  171)
* set_event_loop() (asyncio.AbstractEventLoopPolicy method): Policy Objects.
                                                             (line   23)
* set_event_loop() (in module asyncio):  Event Loop.         (line   55)
* set_event_loop_policy() (in module asyncio): Getting and Setting the Policy.
                                                             (line   13)
* set_exception() (asyncio.Future method): Future Object.    (line   52)
* set_exception() (concurrent.futures.Future method): Future Objects.
                                                             (line  123)
* set_exception_handler() (asyncio.loop method): Error Handling API.
                                                             (line    8)
* set_executable() (in module multiprocessing): Miscellaneous<3>.
                                                             (line  100)
* set_executables() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  235)
* set_flags() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   72)
* set_flags() (mailbox.mboxMessage method): mboxMessage.     (line   72)
* set_flags() (mailbox.MMDFMessage method): MMDFMessage.     (line   71)
* set_from() (mailbox.mboxMessage method): mboxMessage.      (line   53)
* set_from() (mailbox.MMDFMessage method): MMDFMessage.      (line   52)
* set_handle_inheritable() (in module os): Inheritance of File Descriptors.
                                                             (line   38)
* set_history_length() (in module readline): History file.   (line   30)
* set_include_dirs() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  103)
* set_info() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line  108)
* set_inheritable() (in module os):      Inheritance of File Descriptors.
                                                             (line   28)
* set_inheritable() (socket.socket method): Socket Objects.  (line  483)
* set_labels() (mailbox.BabylMessage method): BabylMessage.  (line   51)
* set_last_error() (in module ctypes):   Utility functions.  (line  180)
* set_libraries() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  128)
* set_library_dirs() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  144)
* set_link_objects() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  187)
* set_literal (2to3 fixer):              Fixers.             (line  287)
* set_loader() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line  168)
* set_match_tests() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  250)
* set_memlimit() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  357)
* set_name() (asyncio.Task method):      Task Object.        (line  188)
* set_next() (bdb.Bdb method):           bdb — Debugger framework.
                                                             (line  248)
* set_nonstandard_attr() (http.cookiejar.Cookie method): Cookie Objects<2>.
                                                             (line  103)
* set_npn_protocols() (ssl.SSLContext method): SSL Contexts. (line  231)
* set_ok() (http.cookiejar.CookiePolicy method): CookiePolicy Objects.
                                                             (line    9)
* set_option_negotiation_callback() (telnetlib.Telnet method): Telnet Objects.
                                                             (line  143)
* set_output_charset() (gettext.NullTranslations method): The NullTranslations class.
                                                             (line   94)
* set_package() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line  183)
* set_param() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  348)
* set_param() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  504)
* set_pasv() (ftplib.FTP method):        FTP Objects.        (line  107)
* set_payload() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  215)
* set_policy() (http.cookiejar.CookieJar method): CookieJar and FileCookieJar Objects.
                                                             (line   56)
* set_position() (xdrlib.Unpacker method): Unpacker Objects. (line   16)
* set_pre_input_hook() (in module readline): Startup hooks.  (line   14)
* set_progress_handler() (sqlite3.Connection method): Connection Objects.
                                                             (line  218)
* set_protocol() (asyncio.BaseTransport method): Base Transport.
                                                             (line   78)
* set_proxy() (urllib.request.Request method): Request Objects.
                                                             (line  114)
* set_python_build() (in module distutils.sysconfig): distutils sysconfig — System configuration information.
                                                             (line   99)
* set_quit() (bdb.Bdb method):           bdb — Debugger framework.
                                                             (line  271)
* set_recsrc() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   86)
* set_result() (asyncio.Future method):  Future Object.      (line   45)
* set_result() (concurrent.futures.Future method): Future Objects.
                                                             (line  111)
* set_return() (bdb.Bdb method):         bdb — Debugger framework.
                                                             (line  252)
* set_running_or_notify_cancel() (concurrent.futures.Future method): Future Objects.
                                                             (line   89)
* set_runtime_library_dirs() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  155)
* set_seq1() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line   54)
* set_seq2() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line   59)
* set_seqs() (difflib.SequenceMatcher method): SequenceMatcher Objects.
                                                             (line   44)
* set_sequences() (mailbox.MH method):   MH.                 (line   58)
* set_sequences() (mailbox.MHMessage method): MHMessage.     (line   37)
* set_servername_callback (ssl.SSLContext attribute): SSL Contexts.
                                                             (line  298)
* set_server_documentation() (xmlrpc.server.DocCGIXMLRPCRequestHandler method): DocCGIXMLRPCRequestHandler.
                                                             (line   24)
* set_server_documentation() (xmlrpc.server.DocXMLRPCServer method): DocXMLRPCServer Objects.
                                                             (line   24)
* set_server_name() (xmlrpc.server.DocCGIXMLRPCRequestHandler method): DocCGIXMLRPCRequestHandler.
                                                             (line   18)
* set_server_name() (xmlrpc.server.DocXMLRPCServer method): DocXMLRPCServer Objects.
                                                             (line   18)
* set_server_title() (xmlrpc.server.DocCGIXMLRPCRequestHandler method): DocCGIXMLRPCRequestHandler.
                                                             (line   13)
* set_server_title() (xmlrpc.server.DocXMLRPCServer method): DocXMLRPCServer Objects.
                                                             (line   13)
* set_spacing() (formatter.formatter method): The Formatter Interface.
                                                             (line  139)
* set_startup_hook() (in module readline): Startup hooks.    (line    6)
* set_start_method() (in module multiprocessing): Miscellaneous<3>.
                                                             (line  113)
* set_step() (bdb.Bdb method):           bdb — Debugger framework.
                                                             (line  244)
* set_subdir() (mailbox.MaildirMessage method): MaildirMessage.
                                                             (line   58)
* set_task_factory() (asyncio.loop method): Creating Futures and Tasks.
                                                             (line   31)
* set_terminator() (asynchat.async_chat method): asynchat — Asynchronous socket command/response handler.
                                                             (line  117)
* set_threshold() (in module gc):        gc — Garbage Collector interface.
                                                             (line   86)
* set_trace() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  261)
* set_trace() (in module bdb):           bdb — Debugger framework.
                                                             (line  404)
* set_trace() (in module pdb):           pdb — The Python Debugger.
                                                             (line   97)
* set_trace() (pdb.Pdb method):          pdb — The Python Debugger.
                                                             (line  158)
* set_trace_callback() (sqlite3.Connection method): Connection Objects.
                                                             (line  232)
* set_tunnel() (http.client.HTTPConnection method): HTTPConnection Objects.
                                                             (line   81)
* set_type() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  537)
* set_unittest_reportflags() (in module doctest): Unittest API.
                                                             (line  159)
* set_unixfrom() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  146)
* set_unixfrom() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  147)
* set_until() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  256)
* set_url() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   21)
* set_usage() (optparse.OptionParser method): Other methods. (line    8)
* set_userptr() (curses.panel.Panel method): Panel Objects.  (line   43)
* set_visible() (mailbox.BabylMessage method): BabylMessage. (line   68)
* set_wakeup_fd() (in module signal):    Module contents<2>. (line  263)
* set_write_buffer_limits() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line   33)
* SF_APPEND (in module stat):            stat — Interpreting stat results.
                                                             (line  374)
* SF_ARCHIVED (in module stat):          stat — Interpreting stat results.
                                                             (line  366)
* SF_IMMUTABLE (in module stat):         stat — Interpreting stat results.
                                                             (line  370)
* SF_MNOWAIT (in module os):             File Descriptor Operations.
                                                             (line  616)
* SF_NODISKIO (in module os):            File Descriptor Operations.
                                                             (line  616)
* SF_NOUNLINK (in module stat):          stat — Interpreting stat results.
                                                             (line  378)
* SF_SNAPSHOT (in module stat):          stat — Interpreting stat results.
                                                             (line  382)
* SF_SYNC (in module os):                File Descriptor Operations.
                                                             (line  616)
* Shape (class in turtle):               Public classes.     (line   43)
* shape (memoryview attribute):          Memory Views.       (line  441)
* shape() (in module turtle):            Appearance.         (line    6)
* shapesize() (in module turtle):        Appearance.         (line   44)
* shapetransform() (in module turtle):   Appearance.         (line  120)
* share() (socket.socket method):        Socket Objects.     (line  553)
* ShareableList (class in multiprocessing.shared_memory): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  164)
* ShareableList() (multiprocessing.managers.SharedMemoryManager method): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  143)
* Shared Memory:                         multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   10)
* SharedMemory (class in multiprocessing.shared_memory): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   33)
* SharedMemory() (multiprocessing.managers.SharedMemoryManager method): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  138)
* SharedMemoryManager (class in multiprocessing.managers): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  111)
* shared_ciphers() (ssl.SSLSocket method): SSL Sockets.      (line  199)
* shared_object_filename() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  474)
* shearfactor() (in module turtle):      Appearance.         (line   68)
* Shelf (class in shelve):               Restrictions.       (line   23)
* shelve (module):                       shelve — Python object persistence.
                                                             (line    6)
* shift() (decimal.Context method):      Context objects.    (line  490)
* shift() (decimal.Decimal method):      Decimal objects.    (line  543)
* shifting; operation:                   Shifting operations.
                                                             (line    6)
* shifting; operations:                  Bitwise Operations on Integer Types.
                                                             (line    6)
* shift_path_info() (in module wsgiref.util): wsgiref util – WSGI environment utilities.
                                                             (line   38)
* shlex (class in shlex):                shlex — Simple lexical analysis.
                                                             (line   65)
* shlex (module):                        shlex — Simple lexical analysis.
                                                             (line    6)
* shm (multiprocessing.shared_memory.ShareableList attribute): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line  199)
* shortDescription() (unittest.TestCase method): Test cases. (line  708)
* shorten() (in module textwrap):        textwrap — Text wrapping and filling.
                                                             (line   40)
* shouldFlush() (logging.handlers.BufferingHandler method): MemoryHandler.
                                                             (line   35)
* shouldFlush() (logging.handlers.MemoryHandler method): MemoryHandler.
                                                             (line   71)
* shouldStop (unittest.TestResult attribute): Loading and running tests.
                                                             (line  265)
* show() (curses.panel.Panel method):    Panel Objects.      (line   49)
* showsyntaxerror() (code.InteractiveInterpreter method): Interactive Interpreter Objects.
                                                             (line   44)
* showtraceback() (code.InteractiveInterpreter method): Interactive Interpreter Objects.
                                                             (line   53)
* showturtle() (in module turtle):       Visibility.         (line   15)
* showwarning() (in module warnings):    Available Functions.
                                                             (line   55)
* show_code() (in module dis):           Analysis functions. (line   26)
* show_compilers() (in module distutils.ccompiler): distutils ccompiler — CCompiler base class.
                                                             (line   62)
* shuffle() (in module random):          Functions for sequences.
                                                             (line   49)
* shutdown() (concurrent.futures.Executor method): Executor Objects.
                                                             (line   54)
* shutdown() (imaplib.IMAP4 method):     IMAP4 Objects.      (line  258)
* shutdown() (in module logging):        Module-Level Functions.
                                                             (line  318)
* shutdown() (multiprocessing.managers.BaseManager method): Managers.
                                                             (line   62)
* shutdown() (socket.socket method):     Socket Objects.     (line  546)
* shutdown() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line   54)
* shutdown_asyncgens() (asyncio.loop method): Running and stopping the loop.
                                                             (line   56)
* shutil (module):                       shutil — High-level file operations.
                                                             (line    6)
* side_effect (unittest.mock.Mock attribute): The Mock Class.
                                                             (line  263)
* SIGINT:                                Signal Handling<2>. (line    8)
* SIGINT <1>:                            Signal Handling<2>. (line   20)
* siginterrupt() (in module signal):     Module contents<2>. (line  305)
* signal (module):                       signal — Set handlers for asynchronous events.
                                                             (line    6)
* signal() (in module signal):           Module contents<2>. (line  319)
* Signature (class in inspect):          Introspecting callables with the Signature object.
                                                             (line   37)
* signature (inspect.BoundArguments attribute): Introspecting callables with the Signature object.
                                                             (line  261)
* signature() (in module inspect):       Introspecting callables with the Signature object.
                                                             (line   12)
* sigpending() (in module signal):       Module contents<2>. (line  345)
* sigtimedwait() (in module signal):     Module contents<2>. (line  403)
* sigwait() (in module signal):          Module contents<2>. (line  359)
* sigwaitinfo() (in module signal):      Module contents<2>. (line  375)
* SIG_BLOCK (in module signal):          Module contents<2>. (line   78)
* SIG_DFL (in module signal):            Module contents<2>. (line   15)
* SIG_IGN (in module signal):            Module contents<2>. (line   22)
* SIG_SETMASK (in module signal):        Module contents<2>. (line   93)
* SIG_UNBLOCK (in module signal):        Module contents<2>. (line   85)
* Simple Mail Transfer Protocol:         smtplib — SMTP protocol client.
                                                             (line    8)
* simple; statement:                     Simple statements.  (line    6)
* SimpleCookie (class in http.cookies):  http cookies — HTTP state management.
                                                             (line   48)
* simplefilter() (in module warnings):   Available Functions.
                                                             (line   89)
* SimpleHandler (class in wsgiref.handlers): wsgiref handlers – server/gateway base classes.
                                                             (line   70)
* SimpleHTTPRequestHandler (class in http.server): http server — HTTP servers.
                                                             (line  328)
* SimpleNamespace (class in types):      Additional Utility Classes and Functions.
                                                             (line    6)
* SimpleQueue (class in multiprocessing): Pipes and Queues.  (line  204)
* SimpleQueue (class in queue):          queue — A synchronized queue class.
                                                             (line   69)
* SimpleXMLRPCRequestHandler (class in xmlrpc.server): xmlrpc server — Basic XML-RPC servers.
                                                             (line   58)
* SimpleXMLRPCServer (class in xmlrpc.server): xmlrpc server — Basic XML-RPC servers.
                                                             (line   19)
* sin() (in module cmath):               Trigonometric functions<2>.
                                                             (line   29)
* sin() (in module math):                Trigonometric functions.
                                                             (line   57)
* single dispatch:                       Glossary.           (line 1122)
* SingleAddressHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  215)
* singledispatch() (in module functools): functools — Higher-order functions and operations on callable objects.
                                                             (line  320)
* singledispatchmethod (class in functools): functools — Higher-order functions and operations on callable objects.
                                                             (line  437)
* singleton; tuple:                      The standard type hierarchy.
                                                             (line  154)
* sinh() (in module cmath):              Hyperbolic functions<2>.
                                                             (line   30)
* sinh() (in module math):               Hyperbolic functions.
                                                             (line   25)
* SIO_KEEPALIVE_VALS (in module socket): Constants<8>.       (line  167)
* SIO_LOOPBACK_FAST_PATH (in module socket): Constants<8>.   (line  167)
* SIO_RCVALL (in module socket):         Constants<8>.       (line  167)
* site (module):                         site — Site-specific configuration hook.
                                                             (line    6)
* site command line option; –user-base:  Module contents<3>. (line   90)
* site command line option; –user-site:  Module contents<3>. (line   94)
* site-packages; directory:              site — Site-specific configuration hook.
                                                             (line   24)
* site_maps() (urllib.robotparser.RobotFileParser method): urllib robotparser — Parser for robots txt.
                                                             (line   71)
* sixtofour (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  193)
* size (multiprocessing.shared_memory.SharedMemory attribute): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   96)
* size (struct.Struct attribute):        Classes<2>.         (line   62)
* size (tarfile.TarInfo attribute):      TarInfo Objects.    (line   47)
* size (tracemalloc.Statistic attribute): Statistic.         (line   19)
* size (tracemalloc.StatisticDiff attribute): StatisticDiff. (line   26)
* size (tracemalloc.Trace attribute):    Trace.              (line   23)
* size() (ftplib.FTP method):            FTP Objects.        (line  229)
* size() (mmap.mmap method):             mmap — Memory-mapped file support.
                                                             (line  234)
* Sized (class in collections.abc):      Collections Abstract Base Classes.
                                                             (line  104)
* Sized (class in typing):               Classes functions and decorators.
                                                             (line  161)
* sizeof() (in module ctypes):           Utility functions.  (line  189)
* size_diff (tracemalloc.StatisticDiff attribute): StatisticDiff.
                                                             (line   32)
* SIZE_MAX:                              Integer Objects.    (line  215)
* SKIP (in module doctest):              Option Flags.       (line   94)
* skip() (chunk.Chunk method):           chunk — Read IFF chunked data.
                                                             (line  113)
* skip() (in module unittest):           Skipping tests and expected failures.
                                                             (line   47)
* skipIf() (in module unittest):         Skipping tests and expected failures.
                                                             (line   52)
* skipinitialspace (csv.Dialect attribute): Dialects and Formatting Parameters.
                                                             (line   65)
* skipped (unittest.TestResult attribute): Loading and running tests.
                                                             (line  247)
* skippedEntity() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line  176)
* SkipTest:                              Skipping tests and expected failures.
                                                             (line   66)
* skipTest() (unittest.TestCase method): Test cases.         (line   93)
* skipUnless() (in module unittest):     Skipping tests and expected failures.
                                                             (line   56)
* skip_unless_bind_unix_socket() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  538)
* skip_unless_symlink() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  529)
* skip_unless_xattr() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  534)
* SLASH (in module token):               token — Constants used with Python parse trees.
                                                             (line   94)
* SLASHEQUAL (in module token):          token — Constants used with Python parse trees.
                                                             (line  182)
* slave() (nntplib.NNTP method):         Methods<3>.         (line  267)
* sleep() (in module asyncio):           Sleeping.           (line    6)
* sleep() (in module time):              Functions<2>.       (line  217)
* slice:                                 Slicings.           (line    6)
* slice <1>:                             Glossary.           (line 1127)
* slice (built-in class):                Built-in Functions. (line 1478)
* slice; assignment:                     Mutable Sequence Types.
                                                             (line   16)
* slice; operation:                      Common Sequence Operations.
                                                             (line   21)
* slicing:                               The standard type hierarchy.
                                                             (line  115)
* slicing <1>:                           The standard type hierarchy.
                                                             (line  174)
* slicing <2>:                           Slicings.           (line    6)
* slicing; assignment:                   Assignment statements.
                                                             (line  126)
* SMALLEST (in module test.support):     test support — Utilities for the Python test suite.
                                                             (line  155)
* SMTP (class in smtplib):               smtplib — SMTP protocol client.
                                                             (line   16)
* SMTP (in module email.policy):         email policy Policy Objects.
                                                             (line  471)
* SMTP; protocol:                        smtplib — SMTP protocol client.
                                                             (line    8)
* SMTPAuthenticationError:               smtplib — SMTP protocol client.
                                                             (line  166)
* SMTPChannel (class in smtpd):          SMTPChannel Objects.
                                                             (line    6)
* SMTPConnectError:                      smtplib — SMTP protocol client.
                                                             (line  151)
* smtpd (module):                        smtpd — SMTP Server.
                                                             (line    6)
* SMTPDataError:                         smtplib — SMTP protocol client.
                                                             (line  147)
* SMTPException:                         smtplib — SMTP protocol client.
                                                             (line  112)
* SMTPHandler (class in logging.handlers): SMTPHandler.      (line   10)
* SMTPHeloError:                         smtplib — SMTP protocol client.
                                                             (line  156)
* smtplib (module):                      smtplib — SMTP protocol client.
                                                             (line    6)
* SMTPNotSupportedError:                 smtplib — SMTP protocol client.
                                                             (line  160)
* SMTPRecipientsRefused:                 smtplib — SMTP protocol client.
                                                             (line  140)
* SMTPResponseException:                 smtplib — SMTP protocol client.
                                                             (line  126)
* SMTPSenderRefused:                     smtplib — SMTP protocol client.
                                                             (line  134)
* SMTPServer (class in smtpd):           SMTPServer Objects. (line    6)
* SMTPServerDisconnected:                smtplib — SMTP protocol client.
                                                             (line  120)
* SMTPUTF8 (in module email.policy):     email policy Policy Objects.
                                                             (line  477)
* smtp_server (smtpd.SMTPChannel attribute): SMTPChannel Objects.
                                                             (line   44)
* SMTP_SSL (class in smtplib):           smtplib — SMTP protocol client.
                                                             (line   61)
* smtp_state (smtpd.SMTPChannel attribute): SMTPChannel Objects.
                                                             (line   63)
* Snapshot (class in tracemalloc):       Snapshot.           (line    6)
* sndhdr (module):                       sndhdr — Determine type of sound file.
                                                             (line    6)
* SND_ALIAS (in module winsound):        winsound — Sound-playing interface for Windows.
                                                             (line   47)
* SND_ASYNC (in module winsound):        winsound — Sound-playing interface for Windows.
                                                             (line  103)
* SND_FILENAME (in module winsound):     winsound — Sound-playing interface for Windows.
                                                             (line   42)
* SND_LOOP (in module winsound):         winsound — Sound-playing interface for Windows.
                                                             (line   82)
* SND_MEMORY (in module winsound):       winsound — Sound-playing interface for Windows.
                                                             (line   88)
* SND_NODEFAULT (in module winsound):    winsound — Sound-playing interface for Windows.
                                                             (line  107)
* SND_NOSTOP (in module winsound):       winsound — Sound-playing interface for Windows.
                                                             (line  112)
* SND_NOWAIT (in module winsound):       winsound — Sound-playing interface for Windows.
                                                             (line  116)
* SND_PURGE (in module winsound):        winsound — Sound-playing interface for Windows.
                                                             (line   97)
* sniff() (csv.Sniffer method):          Module Contents<3>. (line  207)
* Sniffer (class in csv):                Module Contents<3>. (line  200)
* sni_callback (ssl.SSLContext attribute): SSL Contexts.     (line  247)
* socket (module):                       socket — Low-level networking interface.
                                                             (line    6)
* socket (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line   83)
* socket() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  264)
* socket() (in module socket):           Creating sockets.   (line    8)
* socket() (in module socket) <1>:       select — Waiting for I/O completion.
                                                             (line  138)
* SocketHandler (class in logging.handlers): SocketHandler.  (line   10)
* socketpair() (in module socket):       Creating sockets.   (line   61)
* sockets (asyncio.Server attribute):    Server Objects.     (line   84)
* socketserver (module):                 socketserver — A framework for network servers.
                                                             (line    6)
* SocketType (in module socket):         Creating sockets.   (line  168)
* socket_type (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line  106)
* sock_accept() (asyncio.loop method):   Working with socket objects directly.
                                                             (line   74)
* SOCK_CLOEXEC (in module socket):       Constants<8>.       (line   32)
* sock_connect() (asyncio.loop method):  Working with socket objects directly.
                                                             (line   55)
* SOCK_DGRAM (in module socket):         Constants<8>.       (line   21)
* SOCK_MAX_SIZE (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  100)
* SOCK_NONBLOCK (in module socket):      Constants<8>.       (line   32)
* SOCK_RAW (in module socket):           Constants<8>.       (line   21)
* SOCK_RDM (in module socket):           Constants<8>.       (line   21)
* sock_recv() (asyncio.loop method):     Working with socket objects directly.
                                                             (line   12)
* sock_recv_into() (asyncio.loop method): Working with socket objects directly.
                                                             (line   26)
* sock_sendall() (asyncio.loop method):  Working with socket objects directly.
                                                             (line   37)
* sock_sendfile() (asyncio.loop method): Working with socket objects directly.
                                                             (line   97)
* SOCK_SEQPACKET (in module socket):     Constants<8>.       (line   21)
* SOCK_STREAM (in module socket):        Constants<8>.       (line   21)
* SOL_ALG (in module socket):            Constants<8>.       (line  183)
* SOL_RDS (in module socket):            Constants<8>.       (line  154)
* SOMAXCONN (in module socket):          Constants<8>.       (line   48)
* sort() (imaplib.IMAP4 method):         IMAP4 Objects.      (line  268)
* sort() (list method):                  Lists<2>.           (line   39)
* sortdict() (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line  224)
* sorted() (built-in function):          Built-in Functions. (line 1494)
* sortTestMethodsUsing (unittest.TestLoader attribute): Loading and running tests.
                                                             (line  183)
* sort_stats() (pstats.Stats method):    The Stats Class.    (line   67)
* source (doctest.Example attribute):    Example Objects.    (line   17)
* source (pdb command):                  Debugger Commands.  (line  248)
* source (shlex.shlex attribute):        shlex Objects.      (line  151)
* source character set:                  Encoding declarations.
                                                             (line    6)
* SourceFileLoader (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line  212)
* sourcehook() (shlex.shlex method):     shlex Objects.      (line   26)
* SourcelessFileLoader (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line  252)
* SourceLoader (class in importlib.abc): importlib abc – Abstract base classes related to import.
                                                             (line  497)
* SOURCE_DATE_EPOCH:                     py_compile<2>.      (line    7)
* SOURCE_DATE_EPOCH <1>:                 Library<12>.        (line  453)
* SOURCE_DATE_EPOCH <2>:                 Build<15>.          (line   15)
* SOURCE_DATE_EPOCH <3>:                 py_compile — Compile Python source files.
                                                             (line   65)
* SOURCE_DATE_EPOCH <4>:                 py_compile — Compile Python source files.
                                                             (line   81)
* SOURCE_DATE_EPOCH <5>:                 py_compile — Compile Python source files.
                                                             (line   85)
* SOURCE_DATE_EPOCH <6>:                 Command-line use.   (line   85)
* source_from_cache() (in module imp):   imp — Access the import internals.
                                                             (line  225)
* source_from_cache() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line   58)
* source_hash() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line  217)
* SOURCE_SUFFIXES (in module importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   13)
* source_to_code() (importlib.abc.InspectLoader static method): importlib abc – Abstract base classes related to import.
                                                             (line  412)
* space:                                 Indentation.        (line    6)
* space; in printf-style formatting:     printf-style String Formatting.
                                                             (line   66)
* space; in printf-style formatting <1>: printf-style Bytes Formatting.
                                                             (line   63)
* space; in string formatting:           Format Specification Mini-Language.
                                                             (line   71)
* span() (re.Match method):              Match Objects.      (line  157)
* spawn() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  488)
* spawn() (in module pty):               pty — Pseudo-terminal utilities.
                                                             (line   36)
* spawnl() (in module os):               Process Management. (line  477)
* spawnle() (in module os):              Process Management. (line  477)
* spawnlp() (in module os):              Process Management. (line  477)
* spawnlpe() (in module os):             Process Management. (line  477)
* spawnv() (in module os):               Process Management. (line  477)
* spawnve() (in module os):              Process Management. (line  477)
* spawnvp() (in module os):              Process Management. (line  477)
* spawnvpe() (in module os):             Process Management. (line  477)
* spawn_python() (in module test.support.script_helper): test support script_helper — Utilities for the Python execution tests.
                                                             (line   59)
* special method:                        Glossary.           (line 1135)
* special; attribute:                    The standard type hierarchy.
                                                             (line   13)
* special; method:                       Glossary.           (line 1139)
* specified_attributes (xml.parsers.expat.xmlparser attribute): XMLParser Objects<2>.
                                                             (line  117)
* spec_from_file_location() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line  205)
* spec_from_loader() (in module importlib.util): importlib util – Utility code for importers.
                                                             (line  194)
* speed() (in module turtle):            Turtle motion.      (line  206)
* speed() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  140)
* Spinbox (class in tkinter.ttk):        ttk Spinbox.        (line    6)
* split() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  329)
* split() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  329)
* split() (in module os.path):           os path — Common pathname manipulations.
                                                             (line  364)
* split() (in module re):                Module Contents.    (line  176)
* split() (in module shlex):             shlex — Simple lexical analysis.
                                                             (line   17)
* split() (re.Pattern method):           Regular Expression Objects.
                                                             (line   74)
* split() (str method):                  String Methods<2>.  (line  394)
* splitdrive() (in module os.path):      os path — Common pathname manipulations.
                                                             (line  379)
* splitext() (in module os.path):        os path — Common pathname manipulations.
                                                             (line  400)
* splitlines() (bytearray method):       Bytes and Bytearray Operations.
                                                             (line  572)
* splitlines() (bytes method):           Bytes and Bytearray Operations.
                                                             (line  572)
* splitlines() (str method):             String Methods<2>.  (line  434)
* SplitResult (class in urllib.parse):   Structured Parse Results.
                                                             (line   48)
* SplitResultBytes (class in urllib.parse): Structured Parse Results.
                                                             (line   75)
* split_quoted() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line   98)
* SpooledTemporaryFile() (in module tempfile): tempfile — Generate temporary files and directories.
                                                             (line   93)
* sprintf-style formatting:              printf-style String Formatting.
                                                             (line    6)
* sprintf-style formatting <1>:          printf-style Bytes Formatting.
                                                             (line    6)
* spwd (module):                         spwd — The shadow password database.
                                                             (line    6)
* sqlite3 (module):                      sqlite3 — DB-API 2 0 interface for SQLite databases.
                                                             (line    6)
* sqlite_version (in module sqlite3):    Module functions and constants.
                                                             (line   16)
* sqlite_version_info (in module sqlite3): Module functions and constants.
                                                             (line   20)
* sqrt() (decimal.Context method):       Context objects.    (line  494)
* sqrt() (decimal.Decimal method):       Decimal objects.    (line  554)
* sqrt() (in module cmath):              Power and logarithmic functions<2>.
                                                             (line   23)
* sqrt() (in module math):               Power and logarithmic functions.
                                                             (line   74)
* ssizeargfunc (C type):                 Slot Type typedefs. (line  116)
* ssizeobjargproc (C type):              Slot Type typedefs. (line  118)
* SSL:                                   ssl — TLS/SSL wrapper for socket objects.
                                                             (line    8)
* ssl (module):                          ssl — TLS/SSL wrapper for socket objects.
                                                             (line    6)
* SSLCertVerificationError:              Exceptions<12>.     (line   79)
* SSLContext (class in ssl):             SSL Contexts.       (line   14)
* SSLEOFError:                           Exceptions<12>.     (line   71)
* SSLError:                              Exceptions<12>.     (line    6)
* SSLErrorNumber (class in ssl):         Constants<9>.       (line  506)
* SSLKEYLOGFILE:                         Context creation.   (line   33)
* SSLKEYLOGFILE <1>:                     Context creation.   (line   66)
* SSLObject (class in ssl):              Memory BIO Support<2>.
                                                             (line   30)
* sslobject_class (ssl.SSLContext attribute): SSL Contexts.  (line  430)
* SSLSession (class in ssl):             SSL session.        (line    8)
* SSLSocket (class in ssl):              SSL Sockets.        (line    6)
* sslsocket_class (ssl.SSLContext attribute): SSL Contexts.  (line  404)
* SSLSyscallError:                       Exceptions<12>.     (line   62)
* SSLv3 (ssl.TLSVersion attribute):      Constants<9>.       (line  528)
* SSLWantReadError:                      Exceptions<12>.     (line   44)
* SSLWantWriteError:                     Exceptions<12>.     (line   53)
* SSLZeroReturnError:                    Exceptions<12>.     (line   35)
* SSL_CERT_FILE:                         LibreSSL support.   (line   15)
* SSL_CERT_PATH:                         LibreSSL support.   (line   15)
* ssl_version (ftplib.FTP_TLS attribute): FTP_TLS Objects.   (line    9)
* st() (in module turtle):               Visibility.         (line   15)
* st2list() (in module parser):          Converting ST Objects.
                                                             (line   11)
* st2tuple() (in module parser):         Converting ST Objects.
                                                             (line   31)
* stack (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   34)
* stack viewer:                          Debug menu Shell window only.
                                                             (line   15)
* stack() (in module inspect):           The interpreter stack.
                                                             (line   79)
* stack; trace:                          The standard type hierarchy.
                                                             (line  727)
* stackable; streams:                    codecs — Codec registry and base classes.
                                                             (line    8)
* StackSummary (class in traceback):     StackSummary Objects.
                                                             (line   11)
* stack_effect() (in module dis):        Analysis functions. (line  141)
* stack_size() (in module threading):    threading — Thread-based parallelism.
                                                             (line  127)
* stack_size() (in module _thread):      _thread — Low-level threading API.
                                                             (line   94)
* stamp() (in module turtle):            Turtle motion.      (line  170)
* Standard C:                            String and Bytes literals.
                                                             (line   72)
* standard input:                        Complete Python programs.
                                                             (line   25)
* standard; output:                      Expression statements.
                                                             (line   17)
* standarderror (2to3 fixer):            Fixers.             (line  292)
* standard_b64decode() (in module base64): base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   79)
* standard_b64encode() (in module base64): base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   74)
* standend() (curses.window method):     Window Objects.     (line  516)
* standout() (curses.window method):     Window Objects.     (line  521)
* STAR (in module token):                token — Constants used with Python parse trees.
                                                             (line   90)
* STAREQUAL (in module token):           token — Constants used with Python parse trees.
                                                             (line  178)
* starmap() (in module itertools):       Itertool functions. (line  515)
* starmap() (multiprocessing.pool.Pool method): Process Pools.
                                                             (line  136)
* starmap_async() (multiprocessing.pool.Pool method): Process Pools.
                                                             (line  147)
* start (range attribute):               Ranges.             (line   60)
* start (slice object attribute):        The standard type hierarchy.
                                                             (line  773)
* start (slice object attribute) <1>:    Slicings.           (line   26)
* start (UnicodeError attribute):        Concrete exceptions.
                                                             (line  354)
* start() (in module tracemalloc):       Functions<9>.       (line   50)
* start() (logging.handlers.QueueListener method): QueueListener.
                                                             (line   71)
* start() (multiprocessing.managers.BaseManager method): Managers.
                                                             (line   40)
* start() (multiprocessing.Process method): Process and exceptions.
                                                             (line   43)
* start() (re.Match method):             Match Objects.      (line  132)
* start() (threading.Thread method):     Thread Objects.     (line   89)
* start() (tkinter.ttk.Progressbar method): ttk Progressbar. (line    8)
* start() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   43)
* StartCdataSectionHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  300)
* StartDoctypeDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  186)
* startDocument() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line   32)
* startElement() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line   82)
* StartElementHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  224)
* startElementNS() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line  102)
* startfile() (in module os):            Process Management. (line  585)
* STARTF_USESHOWWINDOW (in module subprocess): Windows Constants.
                                                             (line   33)
* STARTF_USESTDHANDLES (in module subprocess): Windows Constants.
                                                             (line   27)
* StartNamespaceDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  279)
* startPrefixMapping() (xml.sax.handler.ContentHandler method): ContentHandler Objects.
                                                             (line   49)
* startswith() (bytearray method):       Bytes and Bytearray Operations.
                                                             (line  198)
* startswith() (bytes method):           Bytes and Bytearray Operations.
                                                             (line  198)
* startswith() (str method):             String Methods<2>.  (line  507)
* startTest() (unittest.TestResult method): Loading and running tests.
                                                             (line  328)
* startTestRun() (unittest.TestResult method): Loading and running tests.
                                                             (line  337)
* starttls() (imaplib.IMAP4 method):     IMAP4 Objects.      (line  286)
* starttls() (nntplib.NNTP method):      Methods<3>.         (line   60)
* starttls() (smtplib.SMTP method):      SMTP Objects.       (line  185)
* STARTUPINFO (class in subprocess):     Windows Popen Helpers.
                                                             (line    9)
* start_color() (in module curses):      Functions<3>.       (line  442)
* start_component() (msilib.Directory method): Directory Objects.
                                                             (line   20)
* start_new_thread() (in module _thread): _thread — Low-level threading API.
                                                             (line   32)
* start_ns() (xml.etree.ElementTree.TreeBuilder method): TreeBuilder Objects.
                                                             (line   75)
* start_server() (in module asyncio):    Streams.            (line   48)
* start_serving() (asyncio.Server method): Server Objects.   (line   42)
* start_threads() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  501)
* start_tls() (asyncio.loop method):     TLS Upgrade.        (line    6)
* start_unix_server() (in module asyncio): Streams.          (line  101)
* stat (module):                         stat — Interpreting stat results.
                                                             (line    6)
* stat() (in module os):                 Files and Directories.
                                                             (line  921)
* stat() (nntplib.NNTP method):          Methods<3>.         (line  198)
* stat() (os.DirEntry method):           Files and Directories.
                                                             (line  892)
* stat() (pathlib.Path method):          Methods<2>.         (line   35)
* stat() (poplib.POP3 method):           POP3 Objects.       (line   51)
* state() (tkinter.ttk.Widget method):   ttk Widget.         (line   25)
* statement:                             Glossary.           (line 1142)
* statement grouping:                    Indentation.        (line    6)
* statement; assert:                     The assert statement.
                                                             (line    6)
* statement; assert <1>:                 Concrete exceptions.
                                                             (line   10)
* statement; assignment, annotated:      Annotated assignment statements.
                                                             (line    6)
* statement; assignment, augmented:      Augmented assignment statements.
                                                             (line    6)
* statement; async def:                  Coroutines<2>.      (line    8)
* statement; async for:                  Coroutine function definition.
                                                             (line   26)
* statement; async with:                 The async for statement.
                                                             (line   42)
* statement; break:                      The break statement.
                                                             (line    6)
* statement; break <1>:                  The while statement.
                                                             (line   17)
* statement; break <2>:                  The for statement.  (line   22)
* statement; break <3>:                  The try statement.  (line   78)
* statement; break <4>:                  The try statement.  (line  107)
* statement; class:                      Class definitions.  (line    6)
* statement; continue:                   The continue statement.
                                                             (line    6)
* statement; continue <1>:               The while statement.
                                                             (line   17)
* statement; continue <2>:               The for statement.  (line   22)
* statement; continue <3>:               The try statement.  (line   78)
* statement; continue <4>:               The try statement.  (line  107)
* statement; def:                        Function definitions.
                                                             (line    6)
* statement; del:                        Basic customization.
                                                             (line   56)
* statement; del <1>:                    The del statement<2>.
                                                             (line    6)
* statement; del <2>:                    Mutable Sequence Types.
                                                             (line   16)
* statement; del <3>:                    Mapping Types — dict.
                                                             (line    6)
* statement; except:                     Built-in Exceptions.
                                                             (line    6)
* statement; for:                        for Statements.     (line    6)
* statement; for <1>:                    The break statement.
                                                             (line    6)
* statement; for <2>:                    The continue statement.
                                                             (line    6)
* statement; for <3>:                    The for statement.  (line    6)
* statement; global:                     The del statement<2>.
                                                             (line   15)
* statement; global <1>:                 The global statement.
                                                             (line    6)
* statement; if:                         The if statement.   (line    6)
* statement; if <1>:                     Truth Value Testing.
                                                             (line    6)
* statement; import:                     The standard type hierarchy.
                                                             (line  491)
* statement; import <1>:                 The import statement.
                                                             (line    6)
* statement; import <2>:                 Built-in Functions. (line 1760)
* statement; import <3>:                 site — Site-specific configuration hook.
                                                             (line   45)
* statement; import <4>:                 imp — Access the import internals.
                                                             (line   11)
* statement; nonlocal:                   The nonlocal statement.
                                                             (line    6)
* statement; pass:                       The pass statement. (line    6)
* statement; raise:                      The raise statement.
                                                             (line    6)
* statement; raise <1>:                  Built-in Exceptions.
                                                             (line   14)
* statement; return:                     The return statement.
                                                             (line    6)
* statement; return <1>:                 The try statement.  (line   78)
* statement; return <2>:                 The try statement.  (line  107)
* statement; try:                        The standard type hierarchy.
                                                             (line  750)
* statement; try <1>:                    The try statement.  (line    6)
* statement; try <2>:                    Built-in Exceptions.
                                                             (line    6)
* statement; while:                      The break statement.
                                                             (line    6)
* statement; while <1>:                  The continue statement.
                                                             (line    6)
* statement; while <2>:                  The while statement.
                                                             (line    6)
* statement; while <3>:                  Truth Value Testing.
                                                             (line    6)
* statement; with:                       With Statement Context Managers.
                                                             (line   14)
* statement; with <1>:                   The with statement. (line    6)
* statement; yield:                      The yield statement.
                                                             (line    6)
* staticmethod() (built-in function):    Built-in Functions. (line 1521)
* Statistic (class in tracemalloc):      Statistic.          (line    6)
* StatisticDiff (class in tracemalloc):  StatisticDiff.      (line    6)
* statistics (module):                   statistics — Mathematical statistics functions.
                                                             (line    6)
* statistics() (tracemalloc.Snapshot method): Snapshot.      (line   56)
* StatisticsError:                       Exceptions<3>.      (line    8)
* Stats (class in pstats):               The Stats Class.    (line    9)
* status (http.client.HTTPResponse attribute): HTTPResponse Objects.
                                                             (line   51)
* status() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  299)
* statvfs() (in module os):              Files and Directories.
                                                             (line 1181)
* stat_result (class in os):             Files and Directories.
                                                             (line  976)
* StdButtonBox (class in tkinter.tix):   Basic Widgets.      (line   65)
* stderr (asyncio.asyncio.subprocess.Process attribute): Interacting with Subprocesses.
                                                             (line  120)
* stderr (in module sys):                The standard type hierarchy.
                                                             (line  600)
* stderr (in module sys) <1>:            sys — System-specific parameters and functions.
                                                             (line 1414)
* stderr (in module sys) <2>:            Sub-interpreter support.
                                                             (line   25)
* stderr (subprocess.CalledProcessError attribute): Using the subprocess Module.
                                                             (line  203)
* stderr (subprocess.CompletedProcess attribute): Using the subprocess Module.
                                                             (line  108)
* stderr (subprocess.Popen attribute):   Popen Objects.      (line  117)
* stderr (subprocess.TimeoutExpired attribute): Using the subprocess Module.
                                                             (line  170)
* stdev (statistics.NormalDist attribute): NormalDist objects.
                                                             (line   35)
* stdev() (in module statistics):        Function details.   (line  335)
* stdin (asyncio.asyncio.subprocess.Process attribute): Interacting with Subprocesses.
                                                             (line  110)
* stdin (in module sys):                 The standard type hierarchy.
                                                             (line  600)
* stdin (in module sys) <1>:             sys — System-specific parameters and functions.
                                                             (line 1414)
* stdin (in module sys) <2>:             Sub-interpreter support.
                                                             (line   25)
* stdin (subprocess.Popen attribute):    Popen Objects.      (line   98)
* stdin; stdout; sdterr:                 Process-wide parameters.
                                                             (line    9)
* stdio:                                 The standard type hierarchy.
                                                             (line  600)
* stdout (asyncio.asyncio.subprocess.Process attribute): Interacting with Subprocesses.
                                                             (line  115)
* STDOUT (in module subprocess):         Using the subprocess Module.
                                                             (line  136)
* stdout (in module sys):                The standard type hierarchy.
                                                             (line  600)
* stdout (in module sys) <1>:            sys — System-specific parameters and functions.
                                                             (line 1414)
* stdout (in module sys) <2>:            Sub-interpreter support.
                                                             (line   25)
* stdout (subprocess.CalledProcessError attribute): Using the subprocess Module.
                                                             (line  199)
* stdout (subprocess.CompletedProcess attribute): Using the subprocess Module.
                                                             (line   98)
* stdout (subprocess.Popen attribute):   Popen Objects.      (line  107)
* stdout (subprocess.TimeoutExpired attribute): Using the subprocess Module.
                                                             (line  166)
* STD_ERROR_HANDLE (in module subprocess): Windows Constants.
                                                             (line   18)
* STD_INPUT_HANDLE (in module subprocess): Windows Constants.
                                                             (line    8)
* STD_OUTPUT_HANDLE (in module subprocess): Windows Constants.
                                                             (line   13)
* step (pdb command):                    Debugger Commands.  (line  159)
* step (range attribute):                Ranges.             (line   69)
* step (slice object attribute):         The standard type hierarchy.
                                                             (line  773)
* step (slice object attribute) <1>:     Slicings.           (line   26)
* step() (tkinter.ttk.Progressbar method): ttk Progressbar.  (line   15)
* stereocontrols() (ossaudiodev.oss_mixer_device method): Mixer Device Objects.
                                                             (line   41)
* stls() (poplib.POP3 method):           POP3 Objects.       (line  113)
* stop (range attribute):                Ranges.             (line   65)
* stop (slice object attribute):         The standard type hierarchy.
                                                             (line  773)
* stop (slice object attribute) <1>:     Slicings.           (line   26)
* stop() (asyncio.loop method):          Running and stopping the loop.
                                                             (line   31)
* stop() (in module tracemalloc):        Functions<9>.       (line   76)
* stop() (logging.handlers.QueueListener method): QueueListener.
                                                             (line   78)
* stop() (tkinter.ttk.Progressbar method): ttk Progressbar.  (line   21)
* stop() (unittest.TestResult method):   Loading and running tests.
                                                             (line  308)
* StopAsyncIteration:                    Concrete exceptions.
                                                             (line  240)
* StopIteration:                         Concrete exceptions.
                                                             (line  210)
* stopListening() (in module logging.config): Configuration functions.
                                                             (line  165)
* stopTest() (unittest.TestResult method): Loading and running tests.
                                                             (line  332)
* stopTestRun() (unittest.TestResult method): Loading and running tests.
                                                             (line  343)
* stop_here() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  191)
* storbinary() (ftplib.FTP method):      FTP Objects.        (line  112)
* store() (imaplib.IMAP4 method):        IMAP4 Objects.      (line  303)
* STORE_ACTIONS (optparse.Option attribute): Adding new actions.
                                                             (line   35)
* STORE_ATTR (opcode):                   Python Bytecode Instructions.
                                                             (line  510)
* STORE_DEREF (opcode):                  Python Bytecode Instructions.
                                                             (line  744)
* STORE_FAST (opcode):                   Python Bytecode Instructions.
                                                             (line  715)
* STORE_GLOBAL (opcode):                 Python Bytecode Instructions.
                                                             (line  519)
* STORE_NAME (opcode):                   Python Bytecode Instructions.
                                                             (line  483)
* STORE_SUBSCR (opcode):                 Python Bytecode Instructions.
                                                             (line  250)
* storlines() (ftplib.FTP method):       FTP Objects.        (line  126)
* str (built-in class):                  Text Sequence Type — str.
                                                             (line   44)
* str (built-in class); (see also string): Ranges.           (line  125)
* str() (in module locale):              locale — Internationalization services.
                                                             (line  434)
* strcoll() (in module locale):          locale — Internationalization services.
                                                             (line  374)
* StreamError:                           tarfile — Read and write tar archive files.
                                                             (line  196)
* StreamHandler (class in logging):      StreamHandler.      (line   11)
* StreamReader (class in asyncio):       StreamReader.       (line    6)
* StreamReader (class in codecs):        StreamReader Objects.
                                                             (line   10)
* streamreader (codecs.CodecInfo attribute): codecs — Codec registry and base classes.
                                                             (line   87)
* StreamReaderWriter (class in codecs):  StreamReaderWriter Objects.
                                                             (line   12)
* StreamRecoder (class in codecs):       StreamRecoder Objects.
                                                             (line   13)
* StreamRequestHandler (class in socketserver): Request Handler Objects.
                                                             (line   42)
* streams:                               codecs — Codec registry and base classes.
                                                             (line    8)
* StreamWriter (class in asyncio):       StreamWriter.       (line    6)
* StreamWriter (class in codecs):        StreamWriter Objects.
                                                             (line   10)
* streamwriter (codecs.CodecInfo attribute): codecs — Codec registry and base classes.
                                                             (line   87)
* strerror (OSError attribute):          Concrete exceptions.
                                                             (line  151)
* strerror():                            Raising exceptions. (line   59)
* strerror() (in module os):             Process Parameters. (line  449)
* strftime() (datetime.date method):     date Objects.       (line  267)
* strftime() (datetime.datetime method): datetime Objects.   (line  701)
* strftime() (datetime.time method):     time Objects.       (line  209)
* strftime() (in module time):           Functions<2>.       (line  232)
* strict (csv.Dialect attribute):        Dialects and Formatting Parameters.
                                                             (line   70)
* strict (in module email.policy):       email policy Policy Objects.
                                                             (line  492)
* strict_domain (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line   88)
* strict_errors() (in module codecs):    Error Handlers.     (line  128)
* strict_ns_domain (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  110)
* strict_ns_set_initial_dollar (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  115)
* strict_ns_set_path (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  120)
* strict_ns_unverifiable (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line  105)
* strict_rfc2965_unverifiable (http.cookiejar.DefaultCookiePolicy attribute): DefaultCookiePolicy Objects.
                                                             (line   96)
* strides (memoryview attribute):        Memory Views.       (line  449)
* STRING (in module token):              token — Constants used with Python parse trees.
                                                             (line   46)
* string (module):                       string — Common string operations.
                                                             (line    6)
* string (re.Match attribute):           Match Objects.      (line  196)
* string literal:                        Literals.           (line    8)
* string; conversion:                    Basic customization.
                                                             (line  149)
* string; conversion <1>:                Expression statements.
                                                             (line   17)
* string; format() (built-in function):  Built-in Functions. (line  643)
* string; formatted literal:             String literal concatenation.
                                                             (line   24)
* string; formatting, printf:            printf-style String Formatting.
                                                             (line    6)
* string; immutable sequences:           The standard type hierarchy.
                                                             (line  136)
* string; interpolated literal:          String literal concatenation.
                                                             (line   24)
* string; interpolation, printf:         printf-style String Formatting.
                                                             (line    6)
* string; item:                          Subscriptions.      (line   38)
* string; methods:                       Text Sequence Type — str.
                                                             (line   85)
* string; object representation:         Finalization and De-allocation.
                                                             (line   50)
* string; PyObject_Str (C function):     Object Protocol.    (line  185)
* string; str (built-in class):          Text Sequence Type — str.
                                                             (line   44)
* string; str() (built-in function):     Built-in Functions. (line 1554)
* string; text sequence type:            Ranges.             (line  125)
* string; __format__() (object method):  Basic customization.
                                                             (line  149)
* string; __str__() (object method):     Basic customization.
                                                             (line  129)
* StringIO (class in io):                Text I/O<2>.        (line  193)
* stringprep (module):                   stringprep — Internet String Preparation.
                                                             (line    6)
* strings, documentation:                Defining Functions. (line   21)
* strings, documentation <1>:            Documentation Strings.
                                                             (line    6)
* string_at() (in module ctypes):        Utility functions.  (line  194)
* strip() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  375)
* strip() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  375)
* strip() (str method):                  String Methods<2>.  (line  514)
* stripspaces (curses.textpad.Textbox attribute): Textbox objects.
                                                             (line  115)
* strip_dirs() (pstats.Stats method):    The Stats Class.    (line   34)
* strip_python_strerr() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  372)
* strptime() (datetime.datetime class method): datetime Objects.
                                                             (line  232)
* strptime() (in module time):           Functions<2>.       (line  364)
* strsignal() (in module signal):        Module contents<2>. (line  140)
* strtobool() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line  119)
* Struct (class in struct):              Classes<2>.         (line    8)
* struct (module):                       struct — Interpret bytes as packed binary data.
                                                             (line    6)
* Structure (class in ctypes):           Structured data types.
                                                             (line   21)
* struct_time (class in time):           Functions<2>.       (line  398)
* strxfrm() (in module locale):          locale — Internationalization services.
                                                             (line  381)
* STType (in module parser):             ST Objects.         (line   10)
* Style (class in tkinter.ttk):          Ttk Styling.        (line   20)
* ST_ATIME (in module stat):             stat — Interpreting stat results.
                                                             (line  163)
* st_atime (os.stat_result attribute):   Files and Directories.
                                                             (line 1021)
* st_atime_ns (os.stat_result attribute): Files and Directories.
                                                             (line 1037)
* st_birthtime (os.stat_result attribute): Files and Directories.
                                                             (line 1105)
* st_blksize (os.stat_result attribute): Files and Directories.
                                                             (line 1083)
* st_blocks (os.stat_result attribute):  Files and Directories.
                                                             (line 1078)
* st_creator (os.stat_result attribute): Files and Directories.
                                                             (line 1123)
* ST_CTIME (in module stat):             stat — Interpreting stat results.
                                                             (line  171)
* st_ctime (os.stat_result attribute):   Files and Directories.
                                                             (line 1029)
* st_ctime_ns (os.stat_result attribute): Files and Directories.
                                                             (line 1047)
* ST_DEV (in module stat):               stat — Interpreting stat results.
                                                             (line  142)
* st_dev (os.stat_result attribute):     Files and Directories.
                                                             (line  997)
* st_file_attributes (os.stat_result attribute): Files and Directories.
                                                             (line 1133)
* st_flags (os.stat_result attribute):   Files and Directories.
                                                             (line 1093)
* st_fstype (os.stat_result attribute):  Files and Directories.
                                                             (line 1112)
* st_gen (os.stat_result attribute):     Files and Directories.
                                                             (line 1101)
* ST_GID (in module stat):               stat — Interpreting stat results.
                                                             (line  154)
* st_gid (os.stat_result attribute):     Files and Directories.
                                                             (line 1009)
* ST_INO (in module stat):               stat — Interpreting stat results.
                                                             (line  138)
* st_ino (os.stat_result attribute):     Files and Directories.
                                                             (line  988)
* ST_MODE (in module stat):              stat — Interpreting stat results.
                                                             (line  134)
* st_mode (os.stat_result attribute):    Files and Directories.
                                                             (line  984)
* ST_MTIME (in module stat):             stat — Interpreting stat results.
                                                             (line  167)
* st_mtime (os.stat_result attribute):   Files and Directories.
                                                             (line 1025)
* st_mtime_ns (os.stat_result attribute): Files and Directories.
                                                             (line 1042)
* ST_NLINK (in module stat):             stat — Interpreting stat results.
                                                             (line  146)
* st_nlink (os.stat_result attribute):   Files and Directories.
                                                             (line 1001)
* st_rdev (os.stat_result attribute):    Files and Directories.
                                                             (line 1089)
* st_reparse_tag (os.stat_result attribute): Files and Directories.
                                                             (line 1140)
* st_rsize (os.stat_result attribute):   Files and Directories.
                                                             (line 1119)
* ST_SIZE (in module stat):              stat — Interpreting stat results.
                                                             (line  158)
* st_size (os.stat_result attribute):    Files and Directories.
                                                             (line 1013)
* st_type (os.stat_result attribute):    Files and Directories.
                                                             (line 1127)
* ST_UID (in module stat):               stat — Interpreting stat results.
                                                             (line  150)
* st_uid (os.stat_result attribute):     Files and Directories.
                                                             (line 1005)
* sub() (in module operator):            operator — Standard operators as functions.
                                                             (line  153)
* sub() (in module re):                  Module Contents.    (line  241)
* sub() (re.Pattern method):             Regular Expression Objects.
                                                             (line   91)
* subclassing; immutable types:          Basic customization.
                                                             (line    8)
* subdirs (filecmp.dircmp attribute):    The dircmp class.   (line  100)
* SubElement() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  185)
* submit() (concurrent.futures.Executor method): Executor Objects.
                                                             (line   12)
* submodule_search_locations (importlib.machinery.ModuleSpec attribute): importlib machinery – Importers and path hooks.
                                                             (line  387)
* subn() (in module re):                 Module Contents.    (line  306)
* subn() (re.Pattern method):            Regular Expression Objects.
                                                             (line   96)
* subnets() (ipaddress.IPv4Network method): Network objects. (line  161)
* subnets() (ipaddress.IPv6Network method): Network objects. (line  301)
* subnet_of() (ipaddress.IPv4Network method): Network objects.
                                                             (line  184)
* subnet_of() (ipaddress.IPv6Network method): Network objects.
                                                             (line  305)
* Subnormal (class in decimal):          Signals.            (line   86)
* suboffsets (memoryview attribute):     Memory Views.       (line  458)
* subpad() (curses.window method):       Window Objects.     (line  525)
* subprocess (module):                   subprocess — Subprocess management.
                                                             (line    6)
* SubprocessError:                       Using the subprocess Module.
                                                             (line  142)
* SubprocessProtocol (class in asyncio): Base Protocols.     (line   24)
* SubprocessTransport (class in asyncio): Transports Hierarchy.
                                                             (line   50)
* subprocess_exec() (asyncio.loop method): Running Subprocesses.
                                                             (line   15)
* subprocess_shell() (asyncio.loop method): Running Subprocesses.
                                                             (line  112)
* subscribe() (imaplib.IMAP4 method):    IMAP4 Objects.      (line  324)
* subscript; assignment:                 Mutable Sequence Types.
                                                             (line   16)
* subscript; operation:                  Common Sequence Operations.
                                                             (line   21)
* subscription:                          The standard type hierarchy.
                                                             (line  109)
* subscription <1>:                      The standard type hierarchy.
                                                             (line  174)
* subscription <2>:                      The standard type hierarchy.
                                                             (line  231)
* subscription <3>:                      Subscriptions.      (line    6)
* subscription; assignment:              Assignment statements.
                                                             (line  103)
* subsequent_indent (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  205)
* substitute() (string.Template method): Template strings.   (line   40)
* subst_vars() (in module distutils.util): distutils util — Miscellaneous other utility functions.
                                                             (line   82)
* subTest() (unittest.TestCase method):  Test cases.         (line  101)
* subtract() (collections.Counter method): Counter objects.  (line   88)
* subtract() (decimal.Context method):   Context objects.    (line  498)
* subtraction:                           Binary arithmetic operations.
                                                             (line   66)
* subtype (email.headerregistry.ContentTypeHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  276)
* subwin() (curses.window method):       Window Objects.     (line  532)
* sub_commands (distutils.cmd.Command attribute): Creating a new Distutils command.
                                                             (line   49)
* successful() (multiprocessing.pool.AsyncResult method): Process Pools.
                                                             (line  201)
* suffix_map (in module mimetypes):      mimetypes — Map filenames to MIME types.
                                                             (line  128)
* suffix_map (mimetypes.MimeTypes attribute): MimeTypes Objects.
                                                             (line   23)
* suite:                                 Compound statements.
                                                             (line   18)
* suite() (in module parser):            Creating ST Objects.
                                                             (line   18)
* suiteClass (unittest.TestLoader attribute): Loading and running tests.
                                                             (line  189)
* sum() (built-in function):             Built-in Functions. (line 1565)
* summarize() (doctest.DocTestRunner method): DocTestRunner objects.
                                                             (line  116)
* summarize_address_range() (in module ipaddress): Other Module Level Functions.
                                                             (line   24)
* sum_list():                            Reference Count Details.
                                                             (line   96)
* sum_sequence():                        Reference Count Details.
                                                             (line   97)
* sum_sequence() <1>:                    Exceptions<18>.     (line   65)
* sunau (module):                        sunau — Read and write Sun AU files.
                                                             (line    6)
* super (pyclbr.Class attribute):        Class Objects<2>.   (line   38)
* super() (built-in function):           Built-in Functions. (line 1581)
* supernet() (ipaddress.IPv4Network method): Network objects.
                                                             (line  173)
* supernet() (ipaddress.IPv6Network method): Network objects.
                                                             (line  303)
* supernet_of() (ipaddress.IPv4Network method): Network objects.
                                                             (line  192)
* supernet_of() (ipaddress.IPv6Network method): Network objects.
                                                             (line  307)
* SupportsAbs (class in typing):         Classes functions and decorators.
                                                             (line  143)
* SupportsBytes (class in typing):       Classes functions and decorators.
                                                             (line  133)
* SupportsComplex (class in typing):     Classes functions and decorators.
                                                             (line  129)
* SupportsFloat (class in typing):       Classes functions and decorators.
                                                             (line  125)
* SupportsIndex (class in typing):       Classes functions and decorators.
                                                             (line  137)
* SupportsInt (class in typing):         Classes functions and decorators.
                                                             (line  121)
* SupportsRound (class in typing):       Classes functions and decorators.
                                                             (line  148)
* supports_bytes_environ (in module os): Process Parameters. (line  455)
* supports_dir_fd (in module os):        Files and Directories.
                                                             (line 1224)
* supports_effective_ids (in module os): Files and Directories.
                                                             (line 1249)
* supports_fd (in module os):            Files and Directories.
                                                             (line 1268)
* supports_follow_symlinks (in module os): Files and Directories.
                                                             (line 1287)
* supports_unicode_filenames (in module os.path): os path — Common pathname manipulations.
                                                             (line  409)
* suppress() (in module contextlib):     Utilities.          (line  123)
* SuppressCrashReport (class in test.support): test support — Utilities for the Python test suite.
                                                             (line  978)
* swapcase() (bytearray method):         Bytes and Bytearray Operations.
                                                             (line  596)
* swapcase() (bytes method):             Bytes and Bytearray Operations.
                                                             (line  596)
* swapcase() (str method):               String Methods<2>.  (line  538)
* swap_attr() (in module test.support):  test support — Utilities for the Python test suite.
                                                             (line  464)
* swap_item() (in module test.support):  test support — Utilities for the Python test suite.
                                                             (line  480)
* SW_HIDE (in module subprocess):        Windows Constants.  (line   23)
* Symbol (class in symtable):            Examining Symbol Tables.
                                                             (line  103)
* symbol (module):                       symbol — Constants used with Python parse trees.
                                                             (line    6)
* SymbolTable (class in symtable):       Examining Symbol Tables.
                                                             (line    6)
* symlink() (in module os):              Files and Directories.
                                                             (line 1310)
* symlink_to() (pathlib.Path method):    Methods<2>.         (line  376)
* symmetric_difference() (frozenset method): Set Types — set frozenset.
                                                             (line  105)
* symmetric_difference_update() (frozenset method): Set Types — set frozenset.
                                                             (line  177)
* symtable (module):                     symtable — Access to the compiler’s symbol tables.
                                                             (line    6)
* symtable() (in module symtable):       Generating Symbol Tables.
                                                             (line    6)
* sym_name (in module symbol):           symbol — Constants used with Python parse trees.
                                                             (line   19)
* sync() (dbm.dumb.dumbdbm method):      dbm dumb — Portable DBM implementation.
                                                             (line   78)
* sync() (dbm.gnu.gdbm method):          dbm gnu — GNU’s reinterpretation of dbm.
                                                             (line  113)
* sync() (in module os):                 Files and Directories.
                                                             (line 1349)
* sync() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line  165)
* sync() (shelve.Shelf method):          shelve — Python object persistence.
                                                             (line   63)
* syncdown() (curses.window method):     Window Objects.     (line  542)
* synchronized() (in module multiprocessing.sharedctypes): The multiprocessing sharedctypes module.
                                                             (line   88)
* SyncManager (class in multiprocessing.managers): Managers. (line  128)
* syncok() (curses.window method):       Window Objects.     (line  548)
* syncup() (curses.window method):       Window Objects.     (line  553)
* syntax:                                Notation.           (line    6)
* SyntaxErr:                             Exceptions<16>.     (line   93)
* SyntaxError:                           Concrete exceptions.
                                                             (line  247)
* SyntaxWarning:                         Warnings.           (line   32)
* sys (module):                          sys — System-specific parameters and functions.
                                                             (line    6)
* sys.exc_info:                          The standard type hierarchy.
                                                             (line  727)
* sys.last_traceback:                    The standard type hierarchy.
                                                             (line  727)
* sys.meta_path:                         The meta path.      (line    6)
* sys.modules:                           The module cache.   (line    6)
* sys.path:                              Path entry finders. (line    6)
* sys.path_hooks:                        Path entry finders. (line    6)
* sys.path_importer_cache:               Path entry finders. (line    6)
* sys.stderr:                            The standard type hierarchy.
                                                             (line  600)
* sys.stdin:                             The standard type hierarchy.
                                                             (line  600)
* sys.stdout:                            The standard type hierarchy.
                                                             (line  600)
* sysconf() (in module os):              Miscellaneous System Information.
                                                             (line   56)
* sysconfig (module):                    sysconfig — Provide access to Python’s configuration information.
                                                             (line    6)
* sysconf_names (in module os):          Miscellaneous System Information.
                                                             (line   66)
* syslog (module):                       syslog — Unix syslog library routines.
                                                             (line    6)
* syslog() (in module syslog):           syslog — Unix syslog library routines.
                                                             (line   18)
* SysLogHandler (class in logging.handlers): SysLogHandler.  (line   10)
* system() (in module os):               Process Management. (line  618)
* system() (in module platform):         Cross Platform.     (line  120)
* SystemError:                           Concrete exceptions.
                                                             (line  268)
* SystemError (built-in exception):      Module Objects.     (line   55)
* SystemError (built-in exception) <1>:  Module Objects.     (line   81)
* SystemExit:                            Concrete exceptions.
                                                             (line  282)
* SystemExit (built-in exception):       Exceptions<2>.      (line   26)
* systemId (xml.dom.DocumentType attribute): DocumentType Objects.
                                                             (line   22)
* SystemRandom (class in random):        Alternative Generator.
                                                             (line   11)
* SystemRandom (class in secrets):       Random numbers.     (line    9)
* SystemRoot:                            Popen Constructor.  (line  222)
* system_alias() (in module platform):   Cross Platform.     (line  126)
* system_must_validate_cert() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  219)
* sys_exc (2to3 fixer):                  Fixers.             (line  296)
* sys_version (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  131)
* S_ENFMT (in module stat):              stat — Interpreting stat results.
                                                             (line  317)
* S_IEXEC (in module stat):              stat — Interpreting stat results.
                                                             (line  331)
* S_IFBLK (in module stat):              stat — Interpreting stat results.
                                                             (line  206)
* S_IFCHR (in module stat):              stat — Interpreting stat results.
                                                             (line  214)
* S_IFDIR (in module stat):              stat — Interpreting stat results.
                                                             (line  210)
* S_IFDOOR (in module stat):             stat — Interpreting stat results.
                                                             (line  222)
* S_IFIFO (in module stat):              stat — Interpreting stat results.
                                                             (line  218)
* S_IFLNK (in module stat):              stat — Interpreting stat results.
                                                             (line  198)
* S_IFMT() (in module stat):             stat — Interpreting stat results.
                                                             (line   78)
* S_IFPORT (in module stat):             stat — Interpreting stat results.
                                                             (line  228)
* S_IFREG (in module stat):              stat — Interpreting stat results.
                                                             (line  202)
* S_IFSOCK (in module stat):             stat — Interpreting stat results.
                                                             (line  194)
* S_IFWHT (in module stat):              stat — Interpreting stat results.
                                                             (line  234)
* S_IMODE() (in module stat):            stat — Interpreting stat results.
                                                             (line   71)
* S_IREAD (in module stat):              stat — Interpreting stat results.
                                                             (line  323)
* S_IRGRP (in module stat):              stat — Interpreting stat results.
                                                             (line  289)
* S_IROTH (in module stat):              stat — Interpreting stat results.
                                                             (line  305)
* S_IRUSR (in module stat):              stat — Interpreting stat results.
                                                             (line  273)
* S_IRWXG (in module stat):              stat — Interpreting stat results.
                                                             (line  285)
* S_IRWXO (in module stat):              stat — Interpreting stat results.
                                                             (line  301)
* S_IRWXU (in module stat):              stat — Interpreting stat results.
                                                             (line  269)
* S_ISBLK() (in module stat):            stat — Interpreting stat results.
                                                             (line   30)
* S_ISCHR() (in module stat):            stat — Interpreting stat results.
                                                             (line   25)
* S_ISDIR() (in module stat):            stat — Interpreting stat results.
                                                             (line   21)
* S_ISDOOR() (in module stat):           stat — Interpreting stat results.
                                                             (line   50)
* S_ISFIFO() (in module stat):           stat — Interpreting stat results.
                                                             (line   38)
* S_ISGID (in module stat):              stat — Interpreting stat results.
                                                             (line  251)
* S_ISLNK() (in module stat):            stat — Interpreting stat results.
                                                             (line   42)
* S_ISPORT() (in module stat):           stat — Interpreting stat results.
                                                             (line   56)
* S_ISREG() (in module stat):            stat — Interpreting stat results.
                                                             (line   34)
* S_ISSOCK() (in module stat):           stat — Interpreting stat results.
                                                             (line   46)
* S_ISUID (in module stat):              stat — Interpreting stat results.
                                                             (line  247)
* S_ISVTX (in module stat):              stat — Interpreting stat results.
                                                             (line  262)
* S_ISWHT() (in module stat):            stat — Interpreting stat results.
                                                             (line   62)
* S_IWGRP (in module stat):              stat — Interpreting stat results.
                                                             (line  293)
* S_IWOTH (in module stat):              stat — Interpreting stat results.
                                                             (line  309)
* S_IWRITE (in module stat):             stat — Interpreting stat results.
                                                             (line  327)
* S_IWUSR (in module stat):              stat — Interpreting stat results.
                                                             (line  277)
* S_IXGRP (in module stat):              stat — Interpreting stat results.
                                                             (line  297)
* S_IXOTH (in module stat):              stat — Interpreting stat results.
                                                             (line  313)
* S_IXUSR (in module stat):              stat — Interpreting stat results.
                                                             (line  281)
* tab:                                   Indentation.        (line    6)
* tab() (tkinter.ttk.Notebook method):   ttk Notebook.       (line   62)
* TabError:                              Concrete exceptions.
                                                             (line  263)
* tabnanny (module):                     tabnanny — Detection of ambiguous indentation.
                                                             (line    6)
* tabs() (tkinter.ttk.Notebook method):  ttk Notebook.       (line   71)
* tabsize (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  162)
* tag (xml.etree.ElementTree.Element attribute): Element Objects.
                                                             (line   16)
* tagName (xml.dom.Element attribute):   Element Objects<2>. (line    9)
* tag_bind() (tkinter.ttk.Treeview method): ttk Treeview.    (line  303)
* tag_configure() (tkinter.ttk.Treeview method): ttk Treeview.
                                                             (line  309)
* tag_has() (tkinter.ttk.Treeview method): ttk Treeview.     (line  319)
* tail (xml.etree.ElementTree.Element attribute): Element Objects.
                                                             (line   21)
* takewhile() (in module itertools):     Itertool functions. (line  530)
* take_snapshot() (in module tracemalloc): Functions<9>.     (line   88)
* tan() (in module cmath):               Trigonometric functions<2>.
                                                             (line   33)
* tan() (in module math):                Trigonometric functions.
                                                             (line   61)
* tanh() (in module cmath):              Hyperbolic functions<2>.
                                                             (line   34)
* tanh() (in module math):               Hyperbolic functions.
                                                             (line   29)
* TarError:                              tarfile — Read and write tar archive files.
                                                             (line  182)
* TarFile (class in tarfile):            tarfile — Read and write tar archive files.
                                                             (line  169)
* TarFile (class in tarfile) <1>:        TarFile Objects.    (line   22)
* tarfile (module):                      tarfile — Read and write tar archive files.
                                                             (line    6)
* tarfile command line option; -c <tarfile> <source1> ... <sourceN>: Command-line options<2>.
                                                             (line   11)
* tarfile command line option; –create <tarfile> <source1> ... <sourceN>: Command-line options<2>.
                                                             (line   11)
* tarfile command line option; -e <tarfile> [<output_dir>]: Command-line options<2>.
                                                             (line   16)
* tarfile command line option; –extract <tarfile> [<output_dir>]: Command-line options<2>.
                                                             (line   16)
* tarfile command line option; -l <tarfile>: Command-line options<2>.
                                                             (line    6)
* tarfile command line option; –list <tarfile>: Command-line options<2>.
                                                             (line    6)
* tarfile command line option; -t <tarfile>: Command-line options<2>.
                                                             (line   22)
* tarfile command line option; –test <tarfile>: Command-line options<2>.
                                                             (line   22)
* tarfile command line option; -v, –verbose: Command-line options<2>.
                                                             (line   27)
* target:                                Assignment statements.
                                                             (line   27)
* target (xml.dom.ProcessingInstruction attribute): ProcessingInstruction Objects.
                                                             (line    9)
* target; list:                          Assignment statements.
                                                             (line   27)
* target; list <1>:                      The for statement.  (line    6)
* target; list; assignment:              Assignment statements.
                                                             (line   35)
* TarInfo (class in tarfile):            TarInfo Objects.    (line   15)
* Task (class in asyncio):               Task Object.        (line    6)
* task_done() (asyncio.Queue method):    Queue.              (line   78)
* task_done() (multiprocessing.JoinableQueue method): Pipes and Queues.
                                                             (line  227)
* task_done() (queue.Queue method):      Queue Objects.      (line   68)
* tau (in module cmath):                 Constants<3>.       (line   14)
* tau (in module math):                  Constants<2>.       (line   14)
* tbreak (pdb command):                  Debugger Commands.  (line   88)
* tb_frame (traceback attribute):        The standard type hierarchy.
                                                             (line  750)
* tb_lasti (traceback attribute):        The standard type hierarchy.
                                                             (line  750)
* tb_lineno (traceback attribute):       The standard type hierarchy.
                                                             (line  750)
* tb_locals (unittest.TestResult attribute): Loading and running tests.
                                                             (line  292)
* tb_next (traceback attribute):         The standard type hierarchy.
                                                             (line  759)
* tcdrain() (in module termios):         termios — POSIX style tty control.
                                                             (line   53)
* tcflow() (in module termios):          termios — POSIX style tty control.
                                                             (line   64)
* tcflush() (in module termios):         termios — POSIX style tty control.
                                                             (line   58)
* tcgetattr() (in module termios):       termios — POSIX style tty control.
                                                             (line   26)
* tcgetpgrp() (in module os):            File Descriptor Operations.
                                                             (line  644)
* Tcl() (in module tkinter):             Tkinter Modules.    (line   33)
* TCL_LIBRARY:                           How do I freeze Tkinter applications?.
                                                             (line   11)
* TCPServer (class in socketserver):     socketserver — A framework for network servers.
                                                             (line   15)
* tcsendbreak() (in module termios):     termios — POSIX style tty control.
                                                             (line   47)
* tcsetattr() (in module termios):       termios — POSIX style tty control.
                                                             (line   37)
* tcsetpgrp() (in module os):            File Descriptor Operations.
                                                             (line  651)
* tearDown() (unittest.TestCase method): Test cases.         (line   41)
* tearDownClass() (unittest.TestCase method): Test cases.    (line   67)
* tee() (in module itertools):           Itertool functions. (line  543)
* tell() (aifc.aifc method):             aifc — Read and write AIFF and AIFC files.
                                                             (line  112)
* tell() (aifc.aifc method) <1>:         aifc — Read and write AIFF and AIFC files.
                                                             (line  182)
* tell() (chunk.Chunk method):           chunk — Read IFF chunked data.
                                                             (line  101)
* tell() (io.IOBase method):             I/O Base Classes.   (line  135)
* tell() (io.TextIOBase method):         Text I/O<2>.        (line   88)
* tell() (mmap.mmap method):             mmap — Memory-mapped file support.
                                                             (line  239)
* tell() (sunau.AU_read method):         AU_read Objects.    (line   65)
* tell() (sunau.AU_write method):        AU_write Objects.   (line   39)
* tell() (wave.Wave_read method):        Wave_read Objects.  (line   73)
* tell() (wave.Wave_write method):       Wave_write Objects. (line   62)
* Telnet (class in telnetlib):           telnetlib — Telnet client.
                                                             (line   25)
* telnetlib (module):                    telnetlib — Telnet client.
                                                             (line    6)
* TEMP:                                  tempfile — Generate temporary files and directories.
                                                             (line  240)
* tempdir (in module tempfile):          tempfile — Generate temporary files and directories.
                                                             (line  282)
* tempfile (module):                     tempfile — Generate temporary files and directories.
                                                             (line    6)
* Template (class in pipes):             pipes — Interface to shell pipelines.
                                                             (line   19)
* Template (class in string):            Template strings.   (line   35)
* template (string.Template attribute):  Template strings.   (line   70)
* temporary; file:                       tempfile — Generate temporary files and directories.
                                                             (line    8)
* temporary; file name:                  tempfile — Generate temporary files and directories.
                                                             (line    8)
* TemporaryDirectory() (in module tempfile): tempfile — Generate temporary files and directories.
                                                             (line  119)
* TemporaryFile() (in module tempfile):  tempfile — Generate temporary files and directories.
                                                             (line   28)
* temp_cwd() (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line  422)
* temp_dir() (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line  403)
* temp_umask() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  436)
* teredo (ipaddress.IPv6Address attribute): Address objects. (line  200)
* TERM:                                  Functions<3>.       (line  437)
* TERM <1>:                              Functions<3>.       (line  464)
* termattrs() (in module curses):        Functions<3>.       (line  456)
* terminal_size (class in os):           Querying the size of a terminal.
                                                             (line   25)
* terminate() (asyncio.asyncio.subprocess.Process method): Interacting with Subprocesses.
                                                             (line   90)
* terminate() (asyncio.SubprocessTransport method): Subprocess Transports.
                                                             (line   49)
* terminate() (multiprocessing.pool.Pool method): Process Pools.
                                                             (line  162)
* terminate() (multiprocessing.Process method): Process and exceptions.
                                                             (line  150)
* terminate() (subprocess.Popen method): Popen Objects.      (line   77)
* termination model:                     Exceptions<2>.      (line   20)
* termios (module):                      termios — POSIX style tty control.
                                                             (line    6)
* termname() (in module curses):         Functions<3>.       (line  462)
* ternary; operator:                     Conditional expressions.
                                                             (line    6)
* ternaryfunc (C type):                  Slot Type typedefs. (line  113)
* test (doctest.DocTestFailure attribute): Debugging.        (line  144)
* test (doctest.UnexpectedException attribute): Debugging.   (line  165)
* test (module):                         test — Regression tests package for Python.
                                                             (line    6)
* test() (in module cgi):                Functions<8>.       (line   42)
* test.support (module):                 test support — Utilities for the Python test suite.
                                                             (line    6)
* test.support.script_helper (module):   test support script_helper — Utilities for the Python execution tests.
                                                             (line    6)
* TestCase (class in unittest):          Test cases.         (line    6)
* TestFailed:                            test support — Utilities for the Python test suite.
                                                             (line   16)
* testfile() (in module doctest):        Basic API.          (line   12)
* TESTFN (in module test.support):       test support — Utilities for the Python test suite.
                                                             (line   52)
* TESTFN_ENCODING (in module test.support): test support — Utilities for the Python test suite.
                                                             (line   62)
* TESTFN_NONASCII (in module test.support): test support — Utilities for the Python test suite.
                                                             (line   78)
* TESTFN_UNDECODABLE (in module test.support): test support — Utilities for the Python test suite.
                                                             (line   72)
* TESTFN_UNENCODABLE (in module test.support): test support — Utilities for the Python test suite.
                                                             (line   66)
* TESTFN_UNICODE (in module test.support): test support — Utilities for the Python test suite.
                                                             (line   58)
* TestHandler (class in test.support):   test support — Utilities for the Python test suite.
                                                             (line 1040)
* TestLoader (class in unittest):        Loading and running tests.
                                                             (line    6)
* testMethodPrefix (unittest.TestLoader attribute): Loading and running tests.
                                                             (line  175)
* testmod() (in module doctest):         Basic API.          (line   90)
* testNamePatterns (unittest.TestLoader attribute): Loading and running tests.
                                                             (line  197)
* TestResult (class in unittest):        Loading and running tests.
                                                             (line  214)
* tests (in module imghdr):              imghdr — Determine the type of an image.
                                                             (line   75)
* testsource() (in module doctest):      Debugging.          (line   56)
* testsRun (unittest.TestResult attribute): Loading and running tests.
                                                             (line  270)
* TestSuite (class in unittest):         Grouping tests.     (line    6)
* testzip() (zipfile.ZipFile method):    ZipFile Objects.    (line  232)
* TEST_DATA_DIR (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  114)
* TEST_HOME_DIR (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  110)
* TEST_HTTP_URL (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  141)
* TEST_SUPPORT_DIR (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  105)
* Text (class in typing):                Classes functions and decorators.
                                                             (line  386)
* text (in module msilib):               Precomputed tables. (line   23)
* text (traceback.TracebackException attribute): TracebackException Objects.
                                                             (line   50)
* text (xml.etree.ElementTree.Element attribute): Element Objects.
                                                             (line   21)
* text encoding:                         Glossary.           (line 1149)
* text file:                             Glossary.           (line 1153)
* text mode:                             Built-in Functions. (line 1212)
* text() (in module cgitb):              cgitb — Traceback manager for CGI scripts.
                                                             (line   47)
* text() (msilib.Dialog method):         GUI classes.        (line   56)
* Textbox (class in curses.textpad):     Textbox objects.    (line    8)
* TextCalendar (class in calendar):      calendar — General calendar-related functions.
                                                             (line  128)
* textdomain() (in module gettext):      GNU gettext API.    (line   36)
* textdomain() (in module locale):       Access to message catalogs.
                                                             (line   12)
* TextFile (class in distutils.text_file): distutils text_file — The TextFile class.
                                                             (line   10)
* textinput() (in module turtle):        Input methods.      (line    6)
* TextIO (class in typing):              Classes functions and decorators.
                                                             (line  399)
* TextIOBase (class in io):              Text I/O<2>.        (line    6)
* TextIOWrapper (class in io):           Text I/O<2>.        (line   99)
* TextTestResult (class in unittest):    Loading and running tests.
                                                             (line  419)
* TextTestRunner (class in unittest):    Loading and running tests.
                                                             (line  434)
* textwrap (module):                     textwrap — Text wrapping and filling.
                                                             (line    6)
* TextWrapper (class in textwrap):       textwrap — Text wrapping and filling.
                                                             (line  129)
* text_factory (sqlite3.Connection attribute): Connection Objects.
                                                             (line  336)
* theme_create() (tkinter.ttk.Style method): Ttk Styling.    (line  146)
* theme_names() (tkinter.ttk.Style method): Ttk Styling.     (line  173)
* theme_settings() (tkinter.ttk.Style method): Ttk Styling.  (line  156)
* theme_use() (tkinter.ttk.Style method): Ttk Styling.       (line  177)
* THOUSEP (in module locale):            locale — Internationalization services.
                                                             (line  235)
* Thread (class in threading):           Thread Objects.     (line   57)
* thread() (imaplib.IMAP4 method):       IMAP4 Objects.      (line  328)
* ThreadedChildWatcher (class in asyncio): Process Watchers. (line   84)
* threading (module):                    threading — Thread-based parallelism.
                                                             (line    6)
* ThreadingHTTPServer (class in http.server): http server — HTTP servers.
                                                             (line   29)
* ThreadingMixIn (class in socketserver): Server Creation Notes.
                                                             (line   16)
* ThreadingTCPServer (class in socketserver): Server Creation Notes.
                                                             (line   49)
* ThreadingUDPServer (class in socketserver): Server Creation Notes.
                                                             (line   49)
* threading_cleanup() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  752)
* threading_setup() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  748)
* ThreadPoolExecutor (class in concurrent.futures): ThreadPoolExecutor.
                                                             (line   18)
* threads; POSIX:                        _thread — Low-level threading API.
                                                             (line   16)
* thread_info (in module sys):           sys — System-specific parameters and functions.
                                                             (line 1498)
* thread_time() (in module time):        Functions<2>.       (line  479)
* thread_time_ns() (in module time):     Functions<2>.       (line  493)
* throw (2to3 fixer):                    Fixers.             (line  301)
* throw() (coroutine method):            Coroutine Objects.  (line   34)
* throw() (generator method):            Generator-iterator methods.
                                                             (line   38)
* ticket_lifetime_hint (ssl.SSLSession attribute): SSL session.
                                                             (line   18)
* tigetflag() (in module curses):        Functions<3>.       (line  467)
* tigetnum() (in module curses):         Functions<3>.       (line  474)
* tigetstr() (in module curses):         Functions<3>.       (line  481)
* TILDE (in module token):               token — Constants used with Python parse trees.
                                                             (line  150)
* tilt() (in module turtle):             Appearance.         (line   82)
* tiltangle() (in module turtle):        Appearance.         (line  105)
* time (class in datetime):              time Objects.       (line   10)
* time (module):                         time — Time access and conversions.
                                                             (line    6)
* time (ssl.SSLSession attribute):       SSL session.        (line   14)
* time() (asyncio.loop method):          Scheduling delayed callbacks.
                                                             (line   56)
* time() (datetime.datetime method):     datetime Objects.   (line  396)
* time() (in module time):               Functions<2>.       (line  456)
* Time2Internaldate() (in module imaplib): imaplib — IMAP4 protocol client.
                                                             (line  118)
* timedelta (class in datetime):         timedelta Objects.  (line    9)
* TimedRotatingFileHandler (class in logging.handlers): TimedRotatingFileHandler.
                                                             (line   10)
* timegm() (in module calendar):         calendar — General calendar-related functions.
                                                             (line  355)
* timeit (module):                       timeit — Measure execution time of small code snippets.
                                                             (line    6)
* timeit command line option; -h, –help: Command-Line Interface<4>.
                                                             (line   44)
* timeit command line option; -n N, –number=N: Command-Line Interface<4>.
                                                             (line   13)
* timeit command line option; -p, –process: Command-Line Interface<4>.
                                                             (line   25)
* timeit command line option; -r N, –repeat=N: Command-Line Interface<4>.
                                                             (line   17)
* timeit command line option; -s S, –setup=S: Command-Line Interface<4>.
                                                             (line   21)
* timeit command line option; -u, –unit=U: Command-Line Interface<4>.
                                                             (line   33)
* timeit command line option; -v, –verbose: Command-Line Interface<4>.
                                                             (line   40)
* timeit() (in module timeit):           Python Interface.   (line    8)
* timeit() (timeit.Timer method):        Python Interface.   (line   69)
* timeout:                               Exceptions<11>.     (line   40)
* timeout (socketserver.BaseServer attribute): Server Objects<2>.
                                                             (line  112)
* timeout (ssl.SSLSession attribute):    SSL session.        (line   16)
* timeout (subprocess.TimeoutExpired attribute): Using the subprocess Module.
                                                             (line  157)
* timeout() (curses.window method):      Window Objects.     (line  558)
* TimeoutError:                          OS exceptions.      (line  103)
* TimeoutError <1>:                      Process and exceptions.
                                                             (line  209)
* TimeoutError <2>:                      Exception classes.  (line   10)
* TimeoutError <3>:                      Exceptions<9>.      (line   10)
* TimeoutExpired:                        Using the subprocess Module.
                                                             (line  148)
* TIMEOUT_MAX (in module threading):     threading — Thread-based parallelism.
                                                             (line  151)
* TIMEOUT_MAX (in module _thread):       _thread — Low-level threading API.
                                                             (line  116)
* Timer (class in threading):            Timer Objects.      (line   21)
* Timer (class in timeit):               Python Interface.   (line   39)
* TimerHandle (class in asyncio):        Callback Handles.   (line   22)
* times() (in module os):                Process Management. (line  651)
* TIMESTAMP (py_compile.PycInvalidationMode attribute): py_compile — Compile Python source files.
                                                             (line  101)
* timestamp() (datetime.datetime method): datetime Objects.  (line  547)
* timetuple() (datetime.date method):    date Objects.       (line  179)
* timetuple() (datetime.datetime method): datetime Objects.  (line  502)
* timetz() (datetime.datetime method):   datetime Objects.   (line  405)
* timezone (class in datetime):          timezone Objects.   (line   14)
* timezone (in module time):             Timezone Constants. (line   17)
* time_ns() (in module time):            Functions<2>.       (line  500)
* title() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  621)
* title() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  621)
* title() (in module turtle):            Methods specific to Screen not inherited from TurtleScreen.
                                                             (line   46)
* title() (str method):                  String Methods<2>.  (line  544)
* Tix:                                   tkinter tix — Extension widgets for Tk.
                                                             (line    8)
* tixCommand (class in tkinter.tix):     Tix Commands.       (line    6)
* tix_addbitmapdir() (tkinter.tix.tixCommand method): Tix Commands.
                                                             (line   45)
* tix_cget() (tkinter.tix.tixCommand method): Tix Commands.  (line   30)
* tix_configure() (tkinter.tix.tixCommand method): Tix Commands.
                                                             (line   18)
* tix_filedialog() (tkinter.tix.tixCommand method): Tix Commands.
                                                             (line   55)
* tix_getbitmap() (tkinter.tix.tixCommand method): Tix Commands.
                                                             (line   35)
* tix_getimage() (tkinter.tix.tixCommand method): Tix Commands.
                                                             (line   66)
* tix_option_get() (tkinter.tix.tixCommand method): Tix Commands.
                                                             (line   80)
* tix_resetoptions() (tkinter.tix.tixCommand method): Tix Commands.
                                                             (line   84)
* Tk:                                    Graphical User Interfaces with Tk.
                                                             (line    6)
* Tk (class in tkinter):                 Tkinter Modules.    (line   25)
* Tk (class in tkinter.tix):             Using Tix.          (line    6)
* Tk Option Data Types:                  Tk Option Data Types.
                                                             (line    6)
* Tkinter:                               Graphical User Interfaces with Tk.
                                                             (line    6)
* tkinter (module):                      tkinter — Python interface to Tcl/Tk.
                                                             (line    6)
* tkinter.scrolledtext (module):         tkinter scrolledtext — Scrolled Text Widget.
                                                             (line    6)
* tkinter.tix (module):                  tkinter tix — Extension widgets for Tk.
                                                             (line    6)
* tkinter.ttk (module):                  tkinter ttk — Tk themed widgets.
                                                             (line    6)
* TK_LIBRARY:                            How do I freeze Tkinter applications?.
                                                             (line   11)
* TList (class in tkinter.tix):          Tabular ListBox.    (line    6)
* TLS:                                   ssl — TLS/SSL wrapper for socket objects.
                                                             (line    8)
* TLSv1 (ssl.TLSVersion attribute):      Constants<9>.       (line  530)
* TLSv1_1 (ssl.TLSVersion attribute):    Constants<9>.       (line  532)
* TLSv1_2 (ssl.TLSVersion attribute):    Constants<9>.       (line  534)
* TLSv1_3 (ssl.TLSVersion attribute):    Constants<9>.       (line  536)
* TLSVersion (class in ssl):             Constants<9>.       (line  512)
* TMP:                                   tempfile — Generate temporary files and directories.
                                                             (line  242)
* TMPDIR:                                tempfile — Generate temporary files and directories.
                                                             (line  238)
* ToASCII() (in module encodings.idna):  encodings idna — Internationalized Domain Names in Applications.
                                                             (line   52)
* tobuf() (tarfile.TarInfo method):      TarInfo Objects.    (line   31)
* tobytes() (array.array method):        array — Efficient arrays of numeric values.
                                                             (line  218)
* tobytes() (memoryview method):         Memory Views.       (line  159)
* today() (datetime.date class method):  date Objects.       (line   29)
* today() (datetime.datetime class method): datetime Objects.
                                                             (line   47)
* tofile() (array.array method):         array — Efficient arrays of numeric values.
                                                             (line  227)
* token:                                 Lexical analysis.   (line    6)
* token (module):                        token — Constants used with Python parse trees.
                                                             (line    6)
* token (shlex.shlex attribute):         shlex Objects.      (line  173)
* TokenError:                            Tokenizing Input.   (line  107)
* tokenize (module):                     tokenize — Tokenizer for Python source.
                                                             (line    6)
* tokenize command line option; -e, –exact: Command-Line Usage<2>.
                                                             (line   19)
* tokenize command line option; -h, –help: Command-Line Usage<2>.
                                                             (line   15)
* tokenize() (in module tokenize):       Tokenizing Input.   (line    8)
* token_bytes() (in module secrets):     Generating tokens.  (line   10)
* token_hex() (in module secrets):       Generating tokens.  (line   19)
* token_urlsafe() (in module secrets):   Generating tokens.  (line   28)
* tok_name (in module token):            token — Constants used with Python parse trees.
                                                             (line   20)
* tolist() (array.array method):         array — Efficient arrays of numeric values.
                                                             (line  232)
* tolist() (memoryview method):          Memory Views.       (line  195)
* tolist() (parser.ST method):           ST Objects.         (line   29)
* tomono() (in module audioop):          audioop — Manipulate raw audio data.
                                                             (line  199)
* toordinal() (datetime.date method):    date Objects.       (line  194)
* toordinal() (datetime.datetime method): datetime Objects.  (line  542)
* top() (curses.panel.Panel method):     Panel Objects.      (line   53)
* top() (poplib.POP3 method):            POP3 Objects.       (line   86)
* toprettyxml() (xml.dom.minidom.Node method): DOM Objects.  (line   57)
* top_panel() (in module curses.panel):  Functions<4>.       (line   19)
* toreadonly() (memoryview method):      Memory Views.       (line  211)
* tostereo() (in module audioop):        audioop — Manipulate raw audio data.
                                                             (line  205)
* tostring() (array.array method):       array — Efficient arrays of numeric values.
                                                             (line  236)
* tostring() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  198)
* tostringlist() (in module xml.etree.ElementTree): Functions<6>.
                                                             (line  220)
* total_changes (sqlite3.Connection attribute): Connection Objects.
                                                             (line  379)
* total_ordering() (in module functools): functools — Higher-order functions and operations on callable objects.
                                                             (line  173)
* total_seconds() (datetime.timedelta method): timedelta Objects.
                                                             (line  245)
* totuple() (parser.ST method):          ST Objects.         (line   33)
* touch() (pathlib.Path method):         Methods<2>.         (line  395)
* touchline() (curses.window method):    Window Objects.     (line  568)
* touchwin() (curses.window method):     Window Objects.     (line  575)
* tounicode() (array.array method):      array — Efficient arrays of numeric values.
                                                             (line  242)
* ToUnicode() (in module encodings.idna): encodings idna — Internationalized Domain Names in Applications.
                                                             (line   57)
* towards() (in module turtle):          Tell Turtle’s state.
                                                             (line   14)
* toxml() (xml.dom.minidom.Node method): DOM Objects.        (line   42)
* to_bytes() (int method):               Additional Methods on Integer Types.
                                                             (line   35)
* to_eng_string() (decimal.Context method): Context objects. (line  502)
* to_eng_string() (decimal.Decimal method): Decimal objects. (line  558)
* to_integral() (decimal.Decimal method): Decimal objects.   (line  571)
* to_integral_exact() (decimal.Context method): Context objects.
                                                             (line  512)
* to_integral_exact() (decimal.Decimal method): Decimal objects.
                                                             (line  577)
* to_integral_value() (decimal.Decimal method): Decimal objects.
                                                             (line  585)
* to_sci_string() (decimal.Context method): Context objects. (line  516)
* tparm() (in module curses):            Functions<3>.       (line  488)
* Trace (class in trace):                Programmatic Interface.
                                                             (line    6)
* Trace (class in tracemalloc):          Trace.              (line    6)
* trace (module):                        trace — Trace or track Python statement execution.
                                                             (line    6)
* trace command line option; -c, –count: Main options.       (line   12)
* trace command line option; -C, –coverdir=<dir>: Modifiers. (line   11)
* trace command line option; -f, –file=<file>: Modifiers.    (line    6)
* trace command line option; -g, –timing: Modifiers.         (line   33)
* trace command line option; –help:      Command-Line Usage. (line   15)
* trace command line option; –ignore-dir=<dir>: Filters.     (line   14)
* trace command line option; –ignore-module=<mod>: Filters.  (line    8)
* trace command line option; -l, –listfuncs: Main options.   (line   23)
* trace command line option; -m, –missing: Modifiers.        (line   17)
* trace command line option; -R, –no-report: Modifiers.      (line   27)
* trace command line option; -r, –report: Main options.      (line   27)
* trace command line option; -s, –summary: Modifiers.        (line   22)
* trace command line option; -t, –trace: Main options.       (line   19)
* trace command line option; -T, –trackcalls: Main options.  (line   33)
* trace command line option; –version:   Command-Line Usage. (line   19)
* trace function:                        threading — Thread-based parallelism.
                                                             (line  115)
* trace function <1>:                    sys — System-specific parameters and functions.
                                                             (line  706)
* trace function <2>:                    sys — System-specific parameters and functions.
                                                             (line 1261)
* trace() (in module inspect):           The interpreter stack.
                                                             (line   89)
* Traceback (class in tracemalloc):      Traceback.          (line    6)
* traceback (module):                    traceback — Print or retrieve a stack traceback.
                                                             (line    6)
* traceback (tracemalloc.Statistic attribute): Statistic.    (line   23)
* traceback (tracemalloc.StatisticDiff attribute): StatisticDiff.
                                                             (line   38)
* traceback (tracemalloc.Trace attribute): Trace.            (line   27)
* TracebackException (class in traceback): TracebackException Objects.
                                                             (line   11)
* tracebacklimit (in module sys):        sys — System-specific parameters and functions.
                                                             (line 1532)
* tracebacks; in CGI scripts:            cgitb — Traceback manager for CGI scripts.
                                                             (line    8)
* TracebackType (class in types):        Standard Interpreter Types.
                                                             (line  138)
* traceback_limit (tracemalloc.Snapshot attribute): Snapshot.
                                                             (line   83)
* traceback_limit (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  218)
* tracemalloc (module):                  tracemalloc — Trace memory allocations.
                                                             (line    6)
* tracer() (in module turtle):           Animation control.  (line   19)
* traces (tracemalloc.Snapshot attribute): Snapshot.         (line   89)
* trace_dispatch() (bdb.Bdb method):     bdb — Debugger framework.
                                                             (line  111)
* trailing; comma:                       Expression lists.   (line   24)
* transfercmd() (ftplib.FTP method):     FTP Objects.        (line  135)
* TransientResource (class in test.support): test support — Utilities for the Python test suite.
                                                             (line  949)
* transient_internet() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  440)
* translate() (bytearray method):        Bytes and Bytearray Operations.
                                                             (line  210)
* translate() (bytes method):            Bytes and Bytearray Operations.
                                                             (line  210)
* translate() (in module fnmatch):       fnmatch — Unix filename pattern matching.
                                                             (line   71)
* translate() (str method):              String Methods<2>.  (line  575)
* translation() (in module gettext):     Class-based API.    (line   44)
* transport (asyncio.StreamWriter attribute): StreamWriter.  (line   54)
* Transport (class in asyncio):          Transports Hierarchy.
                                                             (line   29)
* Transport Layer Security:              ssl — TLS/SSL wrapper for socket objects.
                                                             (line    8)
* traverseproc (C type):                 Supporting Cyclic Garbage Collection.
                                                             (line  102)
* Tree (class in tkinter.tix):           Hierarchical ListBox.
                                                             (line   20)
* TreeBuilder (class in xml.etree.ElementTree): TreeBuilder Objects.
                                                             (line    6)
* Treeview (class in tkinter.ttk):       ttk Treeview.       (line    6)
* triangular() (in module random):       Real-valued distributions.
                                                             (line   25)
* triple-quoted string:                  String and Bytes literals.
                                                             (line   36)
* triple-quoted string <1>:              Glossary.           (line 1165)
* True:                                  The standard type hierarchy.
                                                             (line   75)
* true:                                  Truth Value Testing.
                                                             (line   10)
* True <1>:                              Truth Value Testing.
                                                             (line   23)
* True <2>:                              Boolean Values.     (line   15)
* True (built-in variable):              Built-in Constants. (line   13)
* truediv() (in module operator):        operator — Standard operators as functions.
                                                             (line  158)
* trunc() (in module math):              Numeric Types — int float complex.
                                                             (line  102)
* trunc() (in module math) <1>:          Number-theoretic and representation functions.
                                                             (line  227)
* truncate() (in module os):             Files and Directories.
                                                             (line 1357)
* truncate() (io.IOBase method):         I/O Base Classes.   (line  139)
* truth() (in module operator):          operator — Standard operators as functions.
                                                             (line   57)
* truth; value:                          Truth Value Testing.
                                                             (line    6)
* ttk:                                   tkinter ttk — Tk themed widgets.
                                                             (line    8)
* tty (module):                          tty — Terminal control functions.
                                                             (line    6)
* tty; I/O control:                      termios — POSIX style tty control.
                                                             (line    6)
* ttyname() (in module os):              File Descriptor Operations.
                                                             (line  659)
* tuple (built-in class):                Tuples.             (line   12)
* Tuple (in module typing):              Classes functions and decorators.
                                                             (line  699)
* tuple2st() (in module parser):         Creating ST Objects.
                                                             (line   51)
* tuple_params (2to3 fixer):             Fixers.             (line  305)
* Turtle (class in turtle):              Public classes.     (line   16)
* turtle (module):                       turtle — Turtle graphics.
                                                             (line    6)
* turtledemo (module):                   turtledemo — Demo scripts.
                                                             (line    6)
* turtles() (in module turtle):          Settings and special methods.
                                                             (line   81)
* TurtleScreen (class in turtle):        Public classes.     (line   22)
* turtlesize() (in module turtle):       Appearance.         (line   44)
* type:                                  The standard type hierarchy.
                                                             (line    6)
* type <1>:                              Glossary.           (line 1175)
* type (built-in class):                 Built-in Functions. (line 1659)
* Type (class in typing):                Classes functions and decorators.
                                                             (line   77)
* type (optparse.Option attribute):      Option attributes.  (line   19)
* type (socket.socket attribute):        Socket Objects.     (line  577)
* type (tarfile.TarInfo attribute):      TarInfo Objects.    (line   59)
* type (urllib.request.Request attribute): Request Objects.  (line   21)
* type alias:                            Glossary.           (line 1182)
* type hint:                             Glossary.           (line 1199)
* type of an object:                     Objects values and types.
                                                             (line   11)
* type; hierarchy:                       The standard type hierarchy.
                                                             (line    6)
* typeahead() (in module curses):        Functions<3>.       (line  496)
* typecode (array.array attribute):      array — Efficient arrays of numeric values.
                                                             (line  104)
* typecodes (in module array):           array — Efficient arrays of numeric values.
                                                             (line   91)
* TypedDict (class in typing):           Classes functions and decorators.
                                                             (line  464)
* TYPED_ACTIONS (optparse.Option attribute): Adding new actions.
                                                             (line   39)
* typed_subpart_iterator() (in module email.iterators): email iterators Iterators.
                                                             (line   26)
* TypeError:                             Concrete exceptions.
                                                             (line  309)
* types (2to3 fixer):                    Fixers.             (line  310)
* types (module):                        types — Dynamic type creation and names for built-in types.
                                                             (line    6)
* TYPES (optparse.Option attribute):     Adding new types.   (line   11)
* types, internal:                       The standard type hierarchy.
                                                             (line  615)
* types_map (in module mimetypes):       mimetypes — Map filenames to MIME types.
                                                             (line  140)
* types_map (mimetypes.MimeTypes attribute): MimeTypes Objects.
                                                             (line   39)
* types_map_inv (mimetypes.MimeTypes attribute): MimeTypes Objects.
                                                             (line   47)
* TypeVar (class in typing):             Classes functions and decorators.
                                                             (line    8)
* TYPE_CHECKER (optparse.Option attribute): Adding new types.
                                                             (line   16)
* TYPE_CHECKING (in module typing):      Classes functions and decorators.
                                                             (line  792)
* type_check_only() (in module typing):  Classes functions and decorators.
                                                             (line  598)
* TYPE_COMMENT (in module token):        token — Constants used with Python parse trees.
                                                             (line  250)
* TYPE_COMMENT (in module token) <1>:    token — Constants used with Python parse trees.
                                                             (line  278)
* TYPE_IGNORE (in module token):         token — Constants used with Python parse trees.
                                                             (line  248)
* typing (module):                       typing — Support for type hints.
                                                             (line    6)
* TZ:                                    Functions<2>.       (line  510)
* TZ <1>:                                Functions<2>.       (line  511)
* TZ <2>:                                Functions<2>.       (line  519)
* TZ <3>:                                Functions<2>.       (line  524)
* TZ <4>:                                Functions<2>.       (line  526)
* TZ <5>:                                Functions<2>.       (line  586)
* tzinfo (class in datetime):            tzinfo Objects.     (line    6)
* tzinfo (datetime.datetime attribute):  datetime Objects.   (line  294)
* tzinfo (datetime.time attribute):      time Objects.       (line   66)
* tzname (in module time):               Timezone Constants. (line   23)
* tzname() (datetime.datetime method):   datetime Objects.   (line  496)
* tzname() (datetime.time method):       time Objects.       (line  243)
* tzname() (datetime.timezone method):   timezone Objects.   (line   42)
* tzname() (datetime.tzinfo method):     tzinfo Objects.     (line  123)
* tzset() (in module time):              Functions<2>.       (line  507)
* T_FMT (in module locale):              locale — Internationalization services.
                                                             (line  200)
* T_FMT_AMPM (in module locale):         locale — Internationalization services.
                                                             (line  206)
* u"; string literal:                    Literals.           (line    8)
* u’; string literal:                    Literals.           (line    8)
* u-LAW:                                 audioop — Manipulate raw audio data.
                                                             (line   17)
* u-LAW <1>:                             aifc — Read and write AIFF and AIFC files.
                                                             (line  160)
* u-LAW <2>:                             sndhdr — Determine type of sound file.
                                                             (line    8)
* ucd_3_2_0 (in module unicodedata):     unicodedata — Unicode Database.
                                                             (line  131)
* udata (select.kevent attribute):       Kevent Objects.     (line  179)
* UDPServer (class in socketserver):     socketserver — A framework for network servers.
                                                             (line   25)
* UF_APPEND (in module stat):            stat — Interpreting stat results.
                                                             (line  346)
* UF_COMPRESSED (in module stat):        stat — Interpreting stat results.
                                                             (line  358)
* UF_HIDDEN (in module stat):            stat — Interpreting stat results.
                                                             (line  362)
* UF_IMMUTABLE (in module stat):         stat — Interpreting stat results.
                                                             (line  342)
* UF_NODUMP (in module stat):            stat — Interpreting stat results.
                                                             (line  338)
* UF_NOUNLINK (in module stat):          stat — Interpreting stat results.
                                                             (line  354)
* UF_OPAQUE (in module stat):            stat — Interpreting stat results.
                                                             (line  350)
* UID (class in plistlib):               plistlib — Generate and parse Mac OS X plist files.
                                                             (line  181)
* uid (tarfile.TarInfo attribute):       TarInfo Objects.    (line   72)
* uid() (imaplib.IMAP4 method):          IMAP4 Objects.      (line  351)
* uidl() (poplib.POP3 method):           POP3 Objects.       (line   98)
* ulaw2lin() (in module audioop):        audioop — Manipulate raw audio data.
                                                             (line  212)
* ULONG_MAX:                             Integer Objects.    (line  204)
* umask() (in module os):                Process Parameters. (line  462)
* unalias (pdb command):                 Debugger Commands.  (line  301)
* uname (tarfile.TarInfo attribute):     TarInfo Objects.    (line   80)
* uname() (in module os):                Process Parameters. (line  466)
* uname() (in module platform):          Cross Platform.     (line  137)
* unary; arithmetic; operation:          Unary arithmetic and bitwise operations.
                                                             (line    6)
* unary; bitwise; operation:             Unary arithmetic and bitwise operations.
                                                             (line    6)
* unaryfunc (C type):                    Slot Type typedefs. (line  109)
* UNARY_INVERT (opcode):                 Python Bytecode Instructions.
                                                             (line  109)
* UNARY_NEGATIVE (opcode):               Python Bytecode Instructions.
                                                             (line  101)
* UNARY_NOT (opcode):                    Python Bytecode Instructions.
                                                             (line  105)
* UNARY_POSITIVE (opcode):               Python Bytecode Instructions.
                                                             (line   97)
* unbinding; name:                       The del statement<2>.
                                                             (line   15)
* UnboundLocalError:                     Resolution of names.
                                                             (line   16)
* UnboundLocalError <1>:                 Concrete exceptions.
                                                             (line  327)
* unbuffered I/O:                        Built-in Functions. (line 1212)
* UNC paths; and os.makedirs():          Files and Directories.
                                                             (line  422)
* UNCHECKED_HASH (py_compile.PycInvalidationMode attribute): py_compile — Compile Python source files.
                                                             (line  114)
* unconsumed_tail (zlib.Decompress attribute): zlib — Compression compatible with gzip.
                                                             (line  239)
* unctrl() (in module curses):           Functions<3>.       (line  508)
* unctrl() (in module curses.ascii):     curses ascii — Utilities for ASCII characters.
                                                             (line  226)
* undefine_macro() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  170)
* Underflow (class in decimal):          Signals.            (line   93)
* undisplay (pdb command):               Debugger Commands.  (line  264)
* undo() (in module turtle):             Turtle motion.      (line  199)
* undobufferentries() (in module turtle): Special Turtle methods.
                                                             (line   58)
* undoc_header (cmd.Cmd attribute):      Cmd Objects.        (line  158)
* unescape() (in module html):           html — HyperText Markup Language support.
                                                             (line   23)
* unescape() (in module xml.sax.saxutils): xml sax saxutils — SAX Utilities.
                                                             (line   24)
* UnexpectedException:                   Debugging.          (line  157)
* unexpectedSuccesses (unittest.TestResult attribute): Loading and running tests.
                                                             (line  260)
* unfreeze() (in module gc):             gc — Garbage Collector interface.
                                                             (line  172)
* ungetch() (in module curses):          Functions<3>.       (line  515)
* ungetch() (in module msvcrt):          Console I/O.        (line   44)
* ungetmouse() (in module curses):       Functions<3>.       (line  537)
* ungetwch() (in module msvcrt):         Console I/O.        (line   50)
* unget_wch() (in module curses):        Functions<3>.       (line  528)
* unhexlify() (in module binascii):      binascii — Convert between binary and ASCII.
                                                             (line  149)
* Unicode:                               The standard type hierarchy.
                                                             (line  138)
* Unicode <1>:                           unicodedata — Unicode Database.
                                                             (line    6)
* Unicode <2>:                           codecs — Codec registry and base classes.
                                                             (line    8)
* unicode (2to3 fixer):                  Fixers.             (line  315)
* Unicode Consortium:                    String and Bytes literals.
                                                             (line   36)
* Unicode; database:                     unicodedata — Unicode Database.
                                                             (line    6)
* unicodedata (module):                  unicodedata — Unicode Database.
                                                             (line    6)
* UnicodeDecodeError:                    Concrete exceptions.
                                                             (line  367)
* UnicodeEncodeError:                    Concrete exceptions.
                                                             (line  362)
* UnicodeError:                          Concrete exceptions.
                                                             (line  333)
* UnicodeTranslateError:                 Concrete exceptions.
                                                             (line  372)
* UnicodeWarning:                        Warnings.           (line   50)
* unidata_version (in module unicodedata): unicodedata — Unicode Database.
                                                             (line  127)
* unified_diff() (in module difflib):    difflib — Helpers for computing deltas.
                                                             (line  295)
* uniform() (in module random):          Real-valued distributions.
                                                             (line   16)
* UnimplementedFileMode:                 http client — HTTP protocol client.
                                                             (line  147)
* Union (class in ctypes):               Structured data types.
                                                             (line    6)
* Union (in module typing):              Classes functions and decorators.
                                                             (line  647)
* union() (frozenset method):            Set Types — set frozenset.
                                                             (line   85)
* unique() (in module enum):             Module Contents<2>. (line   34)
* unique() (in module enum) <1>:         Ensuring unique enumeration values.
                                                             (line   10)
* unittest (module):                     unittest — Unit testing framework.
                                                             (line    6)
* unittest command line option; -b, –buffer: Command-line options<3>.
                                                             (line    8)
* unittest command line option; -c, –catch: Command-line options<3>.
                                                             (line   15)
* unittest command line option; -f, –failfast: Command-line options<3>.
                                                             (line   24)
* unittest command line option; -k:      Command-line options<3>.
                                                             (line   28)
* unittest command line option; –locals: Command-line options<3>.
                                                             (line   45)
* unittest-discover command line option; -p, –pattern pattern: Test Discovery.
                                                             (line   34)
* unittest-discover command line option; -s, –start-directory directory: Test Discovery.
                                                             (line   30)
* unittest-discover command line option; -t, –top-level-directory directory: Test Discovery.
                                                             (line   38)
* unittest-discover command line option; -v, –verbose: Test Discovery.
                                                             (line   26)
* unittest.mock (module):                unittest mock — mock object library.
                                                             (line    6)
* universal newlines:                    Glossary.           (line 1216)
* universal newlines; bytearray.splitlines method: Bytes and Bytearray Operations.
                                                             (line  572)
* universal newlines; bytes.splitlines method: Bytes and Bytearray Operations.
                                                             (line  572)
* universal newlines; csv.reader function: Module Contents<3>.
                                                             (line    8)
* universal newlines; importlib.abc.InspectLoader.get_source method: importlib abc – Abstract base classes related to import.
                                                             (line  388)
* universal newlines; io.IncrementalNewlineDecoder class: Text I/O<2>.
                                                             (line  234)
* universal newlines; io.TextIOWrapper class: Text I/O<2>.   (line  123)
* universal newlines; open() built-in function: Built-in Functions.
                                                             (line 1150)
* universal newlines; str.splitlines method: String Methods<2>.
                                                             (line  434)
* universal newlines; subprocess module: Frequently Used Arguments.
                                                             (line   33)
* universal newlines; What’s new:        PEP 3116 New I/O Library.
                                                             (line   42)
* universal newlines; What’s new <1>:    New Improved and Removed Modules.
                                                             (line  138)
* universal newlines; What’s new <2>:    PEP 324 New subprocess Module.
                                                             (line   36)
* universal newlines; What’s new <3>:    PEP 277 Unicode file name support for Windows NT.
                                                             (line   36)
* UNIX:                                  Complete Python programs.
                                                             (line   25)
* UNIX; file control:                    fcntl — The fcntl and ioctl system calls.
                                                             (line    6)
* UNIX; I/O control:                     fcntl — The fcntl and ioctl system calls.
                                                             (line    6)
* UnixDatagramServer (class in socketserver): socketserver — A framework for network servers.
                                                             (line   32)
* UnixStreamServer (class in socketserver): socketserver — A framework for network servers.
                                                             (line   32)
* unix_dialect (class in csv):           Module Contents<3>. (line  191)
* unix_shell (in module test.support):   test support — Utilities for the Python test suite.
                                                             (line   44)
* unknown (uuid.SafeUUID attribute):     uuid — UUID objects according to RFC 4122.
                                                             (line   42)
* UnknownHandler (class in urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  435)
* UnknownProtocol:                       http client — HTTP protocol client.
                                                             (line  139)
* UnknownTransferEncoding:               http client — HTTP protocol client.
                                                             (line  143)
* unknown_decl() (html.parser.HTMLParser method): HTMLParser Methods.
                                                             (line  137)
* unknown_open() (urllib.request.BaseHandler method): BaseHandler Objects.
                                                             (line   55)
* unknown_open() (urllib.request.UnknownHandler method): UnknownHandler Objects.
                                                             (line    6)
* unlink() (in module os):               Files and Directories.
                                                             (line 1375)
* unlink() (in module test.support):     test support — Utilities for the Python test suite.
                                                             (line  171)
* unlink() (multiprocessing.shared_memory.SharedMemory method): multiprocessing shared_memory — Provides shared memory for direct access across processes.
                                                             (line   73)
* unlink() (pathlib.Path method):        Methods<2>.         (line  404)
* unlink() (xml.dom.minidom.Node method): DOM Objects.       (line   10)
* unload() (in module test.support):     test support — Utilities for the Python test suite.
                                                             (line  167)
* unlock() (mailbox.Babyl method):       Babyl.              (line   59)
* unlock() (mailbox.Mailbox method):     Mailbox objects.    (line  258)
* unlock() (mailbox.Maildir method):     Maildir.            (line  106)
* unlock() (mailbox.mbox method):        mbox.               (line   39)
* unlock() (mailbox.MH method):          MH.                 (line   84)
* unlock() (mailbox.MMDF method):        MMDF.               (line   35)
* unpack() (in module struct):           Functions and Exceptions.
                                                             (line   26)
* unpack() (struct.Struct method):       Classes<2>.         (line   35)
* Unpacker (class in xdrlib):            xdrlib — Encode and decode XDR data.
                                                             (line   24)
* unpacking; dictionary:                 Dictionary displays.
                                                             (line   23)
* unpacking; in function calls:          Calls.              (line   73)
* unpack_archive() (in module shutil):   Archiving operations.
                                                             (line  102)
* unpack_array() (xdrlib.Unpacker method): Unpacker Objects. (line   91)
* unpack_bytes() (xdrlib.Unpacker method): Unpacker Objects. (line   70)
* unpack_double() (xdrlib.Unpacker method): Unpacker Objects.
                                                             (line   40)
* UNPACK_EX (opcode):                    Python Bytecode Instructions.
                                                             (line  499)
* unpack_farray() (xdrlib.Unpacker method): Unpacker Objects.
                                                             (line   85)
* unpack_float() (xdrlib.Unpacker method): Unpacker Objects. (line   36)
* unpack_fopaque() (xdrlib.Unpacker method): Unpacker Objects.
                                                             (line   54)
* unpack_from() (in module struct):      Functions and Exceptions.
                                                             (line   34)
* unpack_from() (struct.Struct method):  Classes<2>.         (line   41)
* unpack_fstring() (xdrlib.Unpacker method): Unpacker Objects.
                                                             (line   48)
* unpack_list() (xdrlib.Unpacker method): Unpacker Objects.  (line   77)
* unpack_opaque() (xdrlib.Unpacker method): Unpacker Objects.
                                                             (line   65)
* UNPACK_SEQUENCE (opcode):              Python Bytecode Instructions.
                                                             (line  494)
* unpack_string() (xdrlib.Unpacker method): Unpacker Objects.
                                                             (line   59)
* unparsedEntityDecl() (xml.sax.handler.DTDHandler method): DTDHandler Objects.
                                                             (line   12)
* UnparsedEntityDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  249)
* Unpickler (class in pickle):           Module Interface.   (line  225)
* UnpicklingError:                       Module Interface.   (line  107)
* unquote() (in module email.utils):     email utils Miscellaneous utilities.
                                                             (line   52)
* unquote() (in module urllib.parse):    URL Quoting.        (line   60)
* unquote_plus() (in module urllib.parse): URL Quoting.      (line   76)
* unquote_to_bytes() (in module urllib.parse): URL Quoting.  (line   86)
* unraisablehook() (in module sys):      sys — System-specific parameters and functions.
                                                             (line 1540)
* unreachable object:                    Objects values and types.
                                                             (line   37)
* unreadline() (distutils.text_file.TextFile method): distutils text_file — The TextFile class.
                                                             (line  130)
* unrecognized escape sequence:          String and Bytes literals.
                                                             (line  156)
* unregister() (in module atexit):       atexit — Exit handlers.
                                                             (line   43)
* unregister() (in module faulthandler): Dumping the traceback on a user signal.
                                                             (line   23)
* unregister() (select.devpoll method):  /dev/poll Polling Objects.
                                                             (line   55)
* unregister() (select.epoll method):    Edge and Level Trigger Polling epoll Objects.
                                                             (line   89)
* unregister() (select.poll method):     Polling Objects.    (line   67)
* unregister() (selectors.BaseSelector method): Classes<3>.  (line   75)
* unregister_archive_format() (in module shutil): Archiving operations.
                                                             (line   97)
* unregister_dialect() (in module csv):  Module Contents<3>. (line   79)
* unregister_unpack_format() (in module shutil): Archiving operations.
                                                             (line  137)
* unsafe (uuid.SafeUUID attribute):      uuid — UUID objects according to RFC 4122.
                                                             (line   38)
* unset() (test.support.EnvironmentVarGuard method): test support — Utilities for the Python test suite.
                                                             (line  974)
* unsetenv() (in module os):             Process Parameters. (line  496)
* UnstructuredHeader (class in email.headerregistry): email headerregistry Custom Header Objects.
                                                             (line  113)
* unsubscribe() (imaplib.IMAP4 method):  IMAP4 Objects.      (line  358)
* UnsupportedOperation:                  High-level Module Interface.
                                                             (line   42)
* until (pdb command):                   Debugger Commands.  (line  174)
* untokenize() (in module tokenize):     Tokenizing Input.   (line   57)
* untouchwin() (curses.window method):   Window Objects.     (line  580)
* unused_data (bz2.BZ2Decompressor attribute): Incremental de compression.
                                                             (line   78)
* unused_data (lzma.LZMADecompressor attribute): Compressing and decompressing data in memory.
                                                             (line  169)
* unused_data (zlib.Decompress attribute): zlib — Compression compatible with gzip.
                                                             (line  231)
* unverifiable (urllib.request.Request attribute): Request Objects.
                                                             (line   47)
* unwrap() (in module inspect):          Classes and functions<2>.
                                                             (line  171)
* unwrap() (in module urllib.parse):     URL Parsing.        (line  322)
* unwrap() (ssl.SSLSocket method):       SSL Sockets.        (line  255)
* up (pdb command):                      Debugger Commands.  (line   66)
* up() (in module turtle):               Drawing state.      (line   12)
* update() (collections.Counter method): Counter objects.    (line  111)
* update() (dict method):                Mapping Types — dict.
                                                             (line  197)
* update() (frozenset method):           Set Types — set frozenset.
                                                             (line  158)
* update() (hashlib.hash method):        Hash algorithms.    (line  117)
* update() (hmac.HMAC method):           hmac — Keyed-Hashing for Message Authentication.
                                                             (line   47)
* update() (http.cookies.Morsel method): Morsel Objects.     (line   94)
* update() (in module turtle):           Animation control.  (line   37)
* update() (mailbox.Mailbox method):     Mailbox objects.    (line  227)
* update() (mailbox.Maildir method):     Maildir.            (line   90)
* update() (trace.CoverageResults method): Programmatic Interface.
                                                             (line   55)
* update_authenticated() (urllib.request.HTTPPasswordMgrWithPriorAuth method): HTTPPasswordMgrWithPriorAuth Objects.
                                                             (line   23)
* update_lines_cols() (in module curses): Functions<3>.      (line  521)
* update_panels() (in module curses.panel): Functions<4>.    (line   23)
* update_visible() (mailbox.BabylMessage method): BabylMessage.
                                                             (line   76)
* update_wrapper() (in module functools): functools — Higher-order functions and operations on callable objects.
                                                             (line  486)
* upper() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  664)
* upper() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  664)
* upper() (str method):                  String Methods<2>.  (line  593)
* urandom() (in module os):              Random numbers<2>.  (line   29)
* URL:                                   cgi — Common Gateway Interface support.
                                                             (line    8)
* URL <1>:                               urllib parse — Parse URLs into components.
                                                             (line    8)
* URL <2>:                               urllib robotparser — Parser for robots txt.
                                                             (line    8)
* URL <3>:                               http server — HTTP servers.
                                                             (line    8)
* url (xmlrpc.client.ProtocolError attribute): ProtocolError Objects.
                                                             (line   13)
* url2pathname() (in module urllib.request): urllib request — Extensible library for opening URLs.
                                                             (line  154)
* URL; parsing:                          urllib parse — Parse URLs into components.
                                                             (line    8)
* urlcleanup() (in module urllib.request): Legacy interface. (line   59)
* urldefrag() (in module urllib.parse):  URL Parsing.        (line  296)
* urlencode() (in module urllib.parse):  URL Quoting.        (line   98)
* URLError:                              urllib error — Exception classes raised by urllib request.
                                                             (line   17)
* urljoin() (in module urllib.parse):    URL Parsing.        (line  270)
* urllib (2to3 fixer):                   Fixers.             (line  319)
* urllib (module):                       urllib — URL handling modules.
                                                             (line    6)
* urllib.error (module):                 urllib error — Exception classes raised by urllib request.
                                                             (line    6)
* urllib.parse (module):                 urllib parse — Parse URLs into components.
                                                             (line    6)
* urllib.request (module):               urllib request — Extensible library for opening URLs.
                                                             (line    6)
* urllib.response (module):              urllib response — Response classes used by urllib.
                                                             (line    6)
* urllib.robotparser (module):           urllib robotparser — Parser for robots txt.
                                                             (line    6)
* urlopen() (in module urllib.request):  urllib request — Extensible library for opening URLs.
                                                             (line   22)
* URLopener (class in urllib.request):   Legacy interface.   (line   64)
* urlparse() (in module urllib.parse):   URL Parsing.        (line    9)
* urlretrieve() (in module urllib.request): Legacy interface.
                                                             (line   10)
* urlsafe_b64decode() (in module base64): base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   91)
* urlsafe_b64encode() (in module base64): base64 — Base16 Base32 Base64 Base85 Data Encodings.
                                                             (line   84)
* urlsplit() (in module urllib.parse):   URL Parsing.        (line  194)
* urlunparse() (in module urllib.parse): URL Parsing.        (line  186)
* urlunsplit() (in module urllib.parse): URL Parsing.        (line  261)
* urn (uuid.UUID attribute):             uuid — UUID objects according to RFC 4122.
                                                             (line  130)
* UseForeignDTD() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line   63)
* USER:                                  getpass — Portable password input.
                                                             (line   38)
* user() (poplib.POP3 method):           POP3 Objects.       (line   31)
* user-defined; function:                The standard type hierarchy.
                                                             (line  267)
* user-defined; function; call:          Calls.              (line  122)
* user-defined; method:                  The standard type hierarchy.
                                                             (line  358)
* user; effective id:                    Process Parameters. (line  173)
* user; id:                              Process Parameters. (line  302)
* user; id, setting:                     Process Parameters. (line  445)
* UserDict (class in collections):       UserDict objects.   (line   12)
* UserList (class in collections):       UserList objects.   (line   16)
* USERNAME:                              Process Parameters. (line  221)
* USERNAME <1>:                          getpass — Portable password input.
                                                             (line   39)
* username (email.headerregistry.Address attribute): email headerregistry Custom Header Objects.
                                                             (line  430)
* USERPROFILE:                           os path.            (line   14)
* USERPROFILE <1>:                       Changes in the Python API.
                                                             (line  110)
* USERPROFILE <2>:                       os path — Common pathname manipulations.
                                                             (line  146)
* USERPROFILE <3>:                       Location and names of config files.
                                                             (line   67)
* userptr() (curses.panel.Panel method): Panel Objects.      (line   57)
* UserString (class in collections):     UserString objects. (line   12)
* UserWarning:                           Warnings.           (line   13)
* USER_BASE:                             New and Improved Modules.
                                                             (line  469)
* USER_BASE (in module site):            Module contents<3>. (line   30)
* user_call() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  212)
* user_exception() (bdb.Bdb method):     bdb — Debugger framework.
                                                             (line  229)
* user_line() (bdb.Bdb method):          bdb — Debugger framework.
                                                             (line  218)
* user_return() (bdb.Bdb method):        bdb — Debugger framework.
                                                             (line  224)
* USER_SITE (in module site):            Module contents<3>. (line   19)
* use_default_colors() (in module curses): Functions<3>.     (line  552)
* use_env() (in module curses):          Functions<3>.       (line  542)
* use_rawinput (cmd.Cmd attribute):      Cmd Objects.        (line  169)
* USTAR_FORMAT (in module tarfile):      tarfile — Read and write tar archive files.
                                                             (line  222)
* UTC:                                   time — Time access and conversions.
                                                             (line   40)
* utc (datetime.timezone attribute):     timezone Objects.   (line   68)
* utcfromtimestamp() (datetime.datetime class method): datetime Objects.
                                                             (line  124)
* utcnow() (datetime.datetime class method): datetime Objects.
                                                             (line   77)
* utcoffset() (datetime.datetime method): datetime Objects.  (line  476)
* utcoffset() (datetime.time method):    time Objects.       (line  223)
* utcoffset() (datetime.timezone method): timezone Objects.  (line   30)
* utcoffset() (datetime.tzinfo method):  tzinfo Objects.     (line   38)
* utctimetuple() (datetime.datetime method): datetime Objects.
                                                             (line  521)
* utf8 (email.policy.EmailPolicy attribute): email policy Policy Objects.
                                                             (line  341)
* utf8() (poplib.POP3 method):           POP3 Objects.       (line  105)
* utf8_enabled (imaplib.IMAP4 attribute): IMAP4 Objects.     (line  380)
* utime() (in module os):                Files and Directories.
                                                             (line 1386)
* uu (module):                           uu — Encode and decode uuencode files.
                                                             (line    6)
* UUID (class in uuid):                  uuid — UUID objects according to RFC 4122.
                                                             (line   47)
* uuid (module):                         uuid — UUID objects according to RFC 4122.
                                                             (line    8)
* uuid1:                                 uuid — UUID objects according to RFC 4122.
                                                             (line  181)
* uuid1() (in module uuid):              uuid — UUID objects according to RFC 4122.
                                                             (line  173)
* uuid3:                                 uuid — UUID objects according to RFC 4122.
                                                             (line  186)
* uuid3() (in module uuid):              uuid — UUID objects according to RFC 4122.
                                                             (line  181)
* uuid4:                                 uuid — UUID objects according to RFC 4122.
                                                             (line  190)
* uuid4() (in module uuid):              uuid — UUID objects according to RFC 4122.
                                                             (line  186)
* uuid5:                                 uuid — UUID objects according to RFC 4122.
                                                             (line  195)
* uuid5() (in module uuid):              uuid — UUID objects according to RFC 4122.
                                                             (line  190)
* UuidCreate() (in module msilib):       msilib — Read and write Microsoft Installer files.
                                                             (line   39)
* v4_int_to_packed() (in module ipaddress): Other Module Level Functions.
                                                             (line    8)
* v6_int_to_packed() (in module ipaddress): Other Module Level Functions.
                                                             (line   17)
* validator() (in module wsgiref.validate): wsgiref validate — WSGI conformance checker.
                                                             (line   22)
* valid_signals() (in module signal):    Module contents<2>. (line  148)
* value (ctypes._SimpleCData attribute): Fundamental data types<2>.
                                                             (line   17)
* value (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   32)
* value (http.cookies.Morsel attribute): Morsel Objects.     (line   52)
* value (xml.dom.Attr attribute):        Attr Objects.       (line   23)
* value of an object:                    Objects values and types.
                                                             (line   11)
* Value() (in module multiprocessing):   Shared ctypes Objects.
                                                             (line    9)
* Value() (in module multiprocessing.sharedctypes): The multiprocessing sharedctypes module.
                                                             (line   67)
* Value() (multiprocessing.managers.SyncManager method): Managers.
                                                             (line  195)
* ValueError:                            Concrete exceptions.
                                                             (line  377)
* valuerefs() (weakref.WeakValueDictionary method): weakref — Weak references.
                                                             (line  202)
* values() (contextvars.Context method): Manual Context Management.
                                                             (line   79)
* values() (dict method):                Mapping Types — dict.
                                                             (line  208)
* values() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  234)
* values() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  332)
* values() (mailbox.Mailbox method):     Mailbox objects.    (line  114)
* values() (types.MappingProxyType method): Standard Interpreter Types.
                                                             (line  221)
* ValuesView (class in collections.abc): Collections Abstract Base Classes.
                                                             (line  180)
* ValuesView (class in typing):          Classes functions and decorators.
                                                             (line  249)
* value_decode() (http.cookies.BaseCookie method): Cookie Objects.
                                                             (line    6)
* value_encode() (http.cookies.BaseCookie method): Cookie Objects.
                                                             (line   13)
* var (contextvars.contextvars.Token.Token attribute): Context Variables.
                                                             (line   75)
* variable annotation:                   Glossary.           (line 1224)
* variance (statistics.NormalDist attribute): NormalDist objects.
                                                             (line   40)
* variance() (in module statistics):     Function details.   (line  344)
* variant (uuid.UUID attribute):         uuid — UUID objects according to RFC 4122.
                                                             (line  134)
* vars() (built-in function):            Built-in Functions. (line 1692)
* VBAR (in module token):                token — Constants used with Python parse trees.
                                                             (line   98)
* vbar (tkinter.scrolledtext.ScrolledText attribute): tkinter scrolledtext — Scrolled Text Widget.
                                                             (line   28)
* VBAREQUAL (in module token):           token — Constants used with Python parse trees.
                                                             (line  194)
* Vec2D (class in turtle):               Public classes.     (line   83)
* vectorcallfunc (C type):               Slot Type typedefs. (line   26)
* venv (module):                         venv — Creation of virtual environments.
                                                             (line    6)
* VERBOSE (in module re):                Module Contents.    (line  120)
* verbose (in module tabnanny):          tabnanny — Detection of ambiguous indentation.
                                                             (line   26)
* verbose (in module test.support):      test support — Utilities for the Python test suite.
                                                             (line   30)
* verify() (smtplib.SMTP method):        SMTP Objects.       (line   91)
* VerifyFlags (class in ssl):            Constants<9>.       (line  112)
* VerifyMode (class in ssl):             Constants<9>.       (line   64)
* verify_client_post_handshake() (ssl.SSLSocket method): SSL Sockets.
                                                             (line  264)
* verify_code (ssl.SSLCertVerificationError attribute): Exceptions<12>.
                                                             (line   86)
* VERIFY_CRL_CHECK_CHAIN (in module ssl): Constants<9>.      (line   89)
* VERIFY_CRL_CHECK_LEAF (in module ssl): Constants<9>.       (line   78)
* VERIFY_DEFAULT (in module ssl):        Constants<9>.       (line   70)
* verify_flags (ssl.SSLContext attribute): SSL Contexts.     (line  588)
* verify_message (ssl.SSLCertVerificationError attribute): Exceptions<12>.
                                                             (line   90)
* verify_mode (ssl.SSLContext attribute): SSL Contexts.      (line  603)
* verify_request() (socketserver.BaseServer method): Server Objects<2>.
                                                             (line  173)
* VERIFY_X509_STRICT (in module ssl):    Constants<9>.       (line   96)
* VERIFY_X509_TRUSTED_FIRST (in module ssl): Constants<9>.   (line  103)
* version (email.headerregistry.MIMEVersionHeader attribute): email headerregistry Custom Header Objects.
                                                             (line  240)
* version (http.client.HTTPResponse attribute): HTTPResponse Objects.
                                                             (line   46)
* version (http.cookiejar.Cookie attribute): Cookie Objects<2>.
                                                             (line   20)
* version (in module curses):            Constants<6>.       (line   18)
* version (in module marshal):           marshal — Internal Python object serialization.
                                                             (line   90)
* version (in module sqlite3):           Module functions and constants.
                                                             (line    6)
* version (in module sys):               sys — System-specific parameters and functions.
                                                             (line 1585)
* version (in module sys) <1>:           Process-wide parameters.
                                                             (line  164)
* version (in module sys) <2>:           Process-wide parameters.
                                                             (line  199)
* version (in module sys) <3>:           Process-wide parameters.
                                                             (line  210)
* version (ipaddress.IPv4Address attribute): Address objects.
                                                             (line   34)
* version (ipaddress.IPv4Network attribute): Network objects.
                                                             (line   63)
* version (ipaddress.IPv6Address attribute): Address objects.
                                                             (line  158)
* version (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  251)
* version (urllib.request.URLopener attribute): Legacy interface.
                                                             (line  136)
* version (uuid.UUID attribute):         uuid — UUID objects according to RFC 4122.
                                                             (line  141)
* version() (in module ensurepip):       Module API.         (line    8)
* version() (in module platform):        Cross Platform.     (line  132)
* version() (ssl.SSLSocket method):      SSL Sockets.        (line  286)
* version_info (in module sqlite3):      Module functions and constants.
                                                             (line   11)
* version_info (in module sys):          sys — System-specific parameters and functions.
                                                             (line 1600)
* version_string() (http.server.BaseHTTPRequestHandler method): http server — HTTP servers.
                                                             (line  301)
* vformat() (string.Formatter method):   Custom String Formatting.
                                                             (line   26)
* virtual environment:                   Glossary.           (line 1245)
* virtual machine:                       Glossary.           (line 1254)
* visit() (ast.NodeVisitor method):      ast Helpers.        (line  129)
* visitproc (C type):                    Supporting Cyclic Garbage Collection.
                                                             (line   91)
* vline() (curses.window method):        Window Objects.     (line  585)
* voidcmd() (ftplib.FTP method):         FTP Objects.        (line   74)
* volume (zipfile.ZipInfo attribute):    ZipInfo Objects.    (line  119)
* vonmisesvariate() (in module random):  Real-valued distributions.
                                                             (line   75)
* wait() (asyncio.asyncio.subprocess.Process method): Interacting with Subprocesses.
                                                             (line   38)
* wait() (asyncio.Condition method):     Condition.          (line   75)
* wait() (asyncio.Event method):         Event.              (line   26)
* wait() (in module asyncio):            Waiting Primitives. (line    6)
* wait() (in module concurrent.futures): Module Functions.   (line    6)
* wait() (in module multiprocessing.connection): Listeners and Clients.
                                                             (line  113)
* wait() (in module os):                 Process Management. (line  681)
* wait() (multiprocessing.pool.AsyncResult method): Process Pools.
                                                             (line  192)
* wait() (subprocess.Popen method):      Popen Objects.      (line   13)
* wait() (threading.Barrier method):     Barrier Objects.    (line   30)
* wait() (threading.Condition method):   Condition Objects.  (line   85)
* wait() (threading.Event method):       Event Objects.      (line   39)
* wait3() (in module os):                Process Management. (line  779)
* wait4() (in module os):                Process Management. (line  790)
* waitid() (in module os):               Process Management. (line  691)
* waitpid() (in module os):              Process Management. (line  742)
* wait_closed() (asyncio.Server method): Server Objects.     (line   80)
* wait_closed() (asyncio.StreamWriter method): StreamWriter. (line   84)
* wait_for() (asyncio.Condition method): Condition.          (line   87)
* wait_for() (in module asyncio):        Timeouts.           (line    6)
* wait_for() (threading.Condition method): Condition Objects.
                                                             (line  116)
* wait_threads_exit() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  496)
* walk() (email.message.EmailMessage method): email message Representing an email message.
                                                             (line  464)
* walk() (email.message.Message method): email message Message Representing an email message using the compat32 API.
                                                             (line  622)
* walk() (in module ast):                ast Helpers.        (line  112)
* walk() (in module os):                 Files and Directories.
                                                             (line 1426)
* walk_packages() (in module pkgutil):   pkgutil — Package extension utility.
                                                             (line  161)
* walk_stack() (in module traceback):    traceback — Print or retrieve a stack traceback.
                                                             (line  157)
* walk_tb() (in module traceback):       traceback — Print or retrieve a stack traceback.
                                                             (line  166)
* want (doctest.Example attribute):      Example Objects.    (line   23)
* warn() (distutils.ccompiler.CCompiler method): distutils ccompiler — CCompiler base class.
                                                             (line  507)
* warn() (distutils.text_file.TextFile method): distutils text_file — The TextFile class.
                                                             (line  101)
* warn() (in module warnings):           Available Functions.
                                                             (line    6)
* Warning:                               Warnings.           (line    9)
* Warning <1>:                           Exceptions<4>.      (line    6)
* warning() (in module logging):         Module-Level Functions.
                                                             (line  120)
* warning() (logging.Logger method):     Logger Objects.     (line  215)
* warning() (xml.sax.handler.ErrorHandler method): ErrorHandler Objects.
                                                             (line   29)
* warnings:                              warnings — Warning control.
                                                             (line    8)
* warnings (module):                     warnings — Warning control.
                                                             (line    6)
* WarningsRecorder (class in test.support): test support — Utilities for the Python test suite.
                                                             (line 1029)
* warnoptions (in module sys):           sys — System-specific parameters and functions.
                                                             (line 1613)
* warn_explicit() (in module warnings):  Available Functions.
                                                             (line   31)
* wasSuccessful() (unittest.TestResult method): Loading and running tests.
                                                             (line  299)
* WatchedFileHandler (class in logging.handlers): WatchedFileHandler.
                                                             (line   24)
* wave (module):                         wave — Read and write WAV files.
                                                             (line    6)
* WCONTINUED (in module os):             Process Management. (line  809)
* WCOREDUMP() (in module os):            Process Management. (line  829)
* WeakKeyDictionary (class in weakref):  weakref — Weak references.
                                                             (line  158)
* WeakMethod (class in weakref):         weakref — Weak references.
                                                             (line  211)
* weakref (module):                      weakref — Weak references.
                                                             (line    6)
* WeakSet (class in weakref):            weakref — Weak references.
                                                             (line  206)
* WeakValueDictionary (class in weakref): weakref — Weak references.
                                                             (line  185)
* webbrowser (module):                   webbrowser — Convenient Web-browser controller.
                                                             (line    6)
* weekday() (datetime.date method):      date Objects.       (line  200)
* weekday() (datetime.datetime method):  datetime Objects.   (line  583)
* weekday() (in module calendar):        calendar — General calendar-related functions.
                                                             (line  313)
* weekheader() (in module calendar):     calendar — General calendar-related functions.
                                                             (line  318)
* weibullvariate() (in module random):   Real-valued distributions.
                                                             (line   87)
* WEXITED (in module os):                Process Management. (line  719)
* WEXITSTATUS() (in module os):          Process Management. (line  864)
* wfile (http.server.BaseHTTPRequestHandler attribute): http server — HTTP servers.
                                                             (line  112)
* what() (in module imghdr):             imghdr — Determine the type of an image.
                                                             (line   15)
* what() (in module sndhdr):             sndhdr — Determine type of sound file.
                                                             (line   25)
* whathdr() (in module sndhdr):          sndhdr — Determine type of sound file.
                                                             (line   34)
* whatis (pdb command):                  Debugger Commands.  (line  244)
* when() (asyncio.TimerHandle method):   Callback Handles.   (line   29)
* where (pdb command):                   Debugger Commands.  (line   55)
* which() (in module shutil):            Directory and files operations.
                                                             (line  342)
* whichdb() (in module dbm):             dbm — Interfaces to Unix “databases”.
                                                             (line   23)
* whitespace (in module string):         String constants.   (line   47)
* whitespace (shlex.shlex attribute):    shlex Objects.      (line  104)
* whitespace_split (shlex.shlex attribute): shlex Objects.   (line  128)
* Widget (class in tkinter.ttk):         ttk Widget.         (line    9)
* width (textwrap.TextWrapper attribute): textwrap — Text wrapping and filling.
                                                             (line  149)
* width() (in module turtle):            Drawing state.      (line   18)
* WIFCONTINUED() (in module os):         Process Management. (line  836)
* WIFEXITED() (in module os):            Process Management. (line  857)
* WIFSIGNALED() (in module os):          Process Management. (line  850)
* WIFSTOPPED() (in module os):           Process Management. (line  843)
* win32_edition() (in module platform):  Windows Platform.   (line   26)
* win32_is_iot() (in module platform):   Windows Platform.   (line   34)
* win32_ver() (in module platform):      Windows Platform.   (line    6)
* WinDLL (class in ctypes):              Loading shared libraries.
                                                             (line   30)
* window manager (widgets):              The Window Manager. (line    6)
* window() (curses.panel.Panel method):  Panel Objects.      (line   62)
* Windows:                               Complete Python programs.
                                                             (line   25)
* Windows ini file:                      configparser — Configuration file parser.
                                                             (line    8)
* WindowsError:                          Concrete exceptions.
                                                             (line  398)
* WindowsPath (class in pathlib):        Concrete paths.     (line   32)
* WindowsProactorEventLoopPolicy (class in asyncio): Policy Objects.
                                                             (line   68)
* WindowsRegistryFinder (class in importlib.machinery): importlib machinery – Importers and path hooks.
                                                             (line   89)
* WindowsSelectorEventLoopPolicy (class in asyncio): Policy Objects.
                                                             (line   61)
* window_height() (in module turtle):    Settings and special methods.
                                                             (line   87)
* window_width() (in module turtle):     Settings and special methods.
                                                             (line   93)
* winerror (OSError attribute):          Concrete exceptions.
                                                             (line  139)
* WinError() (in module ctypes):         Utility functions.  (line  203)
* WINFUNCTYPE() (in module ctypes):      Function prototypes.
                                                             (line   25)
* winreg (module):                       winreg — Windows registry access.
                                                             (line    6)
* WinSock:                               select — Waiting for I/O completion.
                                                             (line  146)
* winsound (module):                     winsound — Sound-playing interface for Windows.
                                                             (line    6)
* winver (in module sys):                sys — System-specific parameters and functions.
                                                             (line 1619)
* WITH_CLEANUP_FINISH (opcode):          Python Bytecode Instructions.
                                                             (line  468)
* WITH_CLEANUP_START (opcode):           Python Bytecode Instructions.
                                                             (line  452)
* with_hostmask (ipaddress.IPv4Interface attribute): Interface objects.
                                                             (line   47)
* with_hostmask (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  123)
* with_hostmask (ipaddress.IPv6Interface attribute): Interface objects.
                                                             (line   72)
* with_hostmask (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  283)
* with_name() (pathlib.PurePath method): Methods and properties.
                                                             (line  257)
* with_netmask (ipaddress.IPv4Interface attribute): Interface objects.
                                                             (line   40)
* with_netmask (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  118)
* with_netmask (ipaddress.IPv6Interface attribute): Interface objects.
                                                             (line   70)
* with_netmask (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  281)
* with_prefixlen (ipaddress.IPv4Interface attribute): Interface objects.
                                                             (line   33)
* with_prefixlen (ipaddress.IPv4Network attribute): Network objects.
                                                             (line  105)
* with_prefixlen (ipaddress.IPv6Interface attribute): Interface objects.
                                                             (line   68)
* with_prefixlen (ipaddress.IPv6Network attribute): Network objects.
                                                             (line  275)
* with_pymalloc() (in module test.support): test support — Utilities for the Python test suite.
                                                             (line  207)
* with_suffix() (pathlib.PurePath method): Methods and properties.
                                                             (line  273)
* with_traceback() (BaseException method): Base classes.     (line   25)
* WNOHANG (in module os):                Process Management. (line  801)
* WNOWAIT (in module os):                Process Management. (line  719)
* wordchars (shlex.shlex attribute):     shlex Objects.      (line   91)
* World Wide Web:                        Internet Protocols and Support.
                                                             (line    6)
* World Wide Web <1>:                    urllib parse — Parse URLs into components.
                                                             (line    8)
* World Wide Web <2>:                    urllib robotparser — Parser for robots txt.
                                                             (line    8)
* wrap() (in module textwrap):           textwrap — Text wrapping and filling.
                                                             (line   16)
* wrap() (textwrap.TextWrapper method):  textwrap — Text wrapping and filling.
                                                             (line  276)
* wrapper() (in module curses):          Functions<3>.       (line  561)
* WrapperDescriptorType (in module types): Standard Interpreter Types.
                                                             (line   73)
* wraps() (in module functools):         functools — Higher-order functions and operations on callable objects.
                                                             (line  534)
* wrap_bio() (ssl.SSLContext method):    SSL Contexts.       (line  413)
* wrap_future() (in module asyncio):     Future Functions.   (line   44)
* wrap_socket() (in module ssl):         Certificate handling.
                                                             (line  153)
* wrap_socket() (ssl.SSLContext method): SSL Contexts.       (line  349)
* wrap_text() (in module distutils.fancy_getopt): distutils fancy_getopt — Wrapper around the standard getopt module.
                                                             (line   32)
* WRITABLE (in module tkinter):          File Handlers.      (line   36)
* writable() (asyncore.dispatcher method): asyncore — Asynchronous socket handler.
                                                             (line  170)
* writable() (io.IOBase method):         I/O Base Classes.   (line  152)
* write() (asyncio.StreamWriter method): StreamWriter.       (line   15)
* write() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line   60)
* write() (code.InteractiveInterpreter method): Interactive Interpreter Objects.
                                                             (line   63)
* write() (codecs.StreamWriter method):  StreamWriter Objects.
                                                             (line   31)
* write() (configparser.ConfigParser method): ConfigParser Objects.
                                                             (line  257)
* write() (email.generator.BytesGenerator method): email generator Generating MIME documents.
                                                             (line  118)
* write() (email.generator.Generator method): email generator Generating MIME documents.
                                                             (line  214)
* write() (in module os):                File Descriptor Operations.
                                                             (line  667)
* write() (in module turtle):            More drawing control.
                                                             (line   19)
* write() (io.BufferedIOBase method):    I/O Base Classes.   (line  324)
* write() (io.BufferedWriter method):    Buffered Streams.   (line  127)
* write() (io.RawIOBase method):         I/O Base Classes.   (line  211)
* write() (io.TextIOBase method):        Text I/O<2>.        (line   94)
* write() (mmap.mmap method):            mmap — Memory-mapped file support.
                                                             (line  243)
* write() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line   39)
* write() (ssl.MemoryBIO method):        Memory BIO Support<2>.
                                                             (line  147)
* write() (ssl.SSLSocket method):        SSL Sockets.        (line   91)
* write() (telnetlib.Telnet method):     Telnet Objects.     (line  101)
* write() (xml.etree.ElementTree.ElementTree method): ElementTree Objects.
                                                             (line   67)
* write() (zipfile.ZipFile method):      ZipFile Objects.    (line  242)
* writeall() (ossaudiodev.oss_audio_device method): Audio Device Objects.
                                                             (line   51)
* writeframes() (aifc.aifc method):      aifc — Read and write AIFF and AIFC files.
                                                             (line  187)
* writeframes() (sunau.AU_write method): AU_write Objects.   (line   52)
* writeframes() (wave.Wave_write method): Wave_write Objects.
                                                             (line   75)
* writeframesraw() (aifc.aifc method):   aifc — Read and write AIFF and AIFC files.
                                                             (line  195)
* writeframesraw() (sunau.AU_write method): AU_write Objects.
                                                             (line   45)
* writeframesraw() (wave.Wave_write method): Wave_write Objects.
                                                             (line   68)
* writeheader() (csv.DictWriter method): Writer Objects.     (line   37)
* writelines() (asyncio.StreamWriter method): StreamWriter.  (line   25)
* writelines() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line   67)
* writelines() (codecs.StreamWriter method): StreamWriter Objects.
                                                             (line   35)
* writelines() (io.IOBase method):       I/O Base Classes.   (line  158)
* writePlist() (in module plistlib):     plistlib — Generate and parse Mac OS X plist files.
                                                             (line  142)
* writePlistToBytes() (in module plistlib): plistlib — Generate and parse Mac OS X plist files.
                                                             (line  161)
* writepy() (zipfile.PyZipFile method):  PyZipFile Objects.  (line   20)
* writer (formatter.formatter attribute): The Formatter Interface.
                                                             (line   22)
* writer() (in module csv):              Module Contents<3>. (line   40)
* writerow() (csv.csvwriter method):     Writer Objects.     (line   15)
* writerows() (csv.csvwriter method):    Writer Objects.     (line   23)
* writestr() (zipfile.ZipFile method):   ZipFile Objects.    (line  266)
* WriteTransport (class in asyncio):     Transports Hierarchy.
                                                             (line   11)
* writev() (in module os):               File Descriptor Operations.
                                                             (line  686)
* writexml() (xml.dom.minidom.Node method): DOM Objects.     (line   26)
* write_byte() (mmap.mmap method):       mmap — Memory-mapped file support.
                                                             (line  259)
* write_bytes() (pathlib.Path method):   Methods<2>.         (line  423)
* write_docstringdict() (in module turtle): Translation of docstrings into different languages.
                                                             (line   10)
* write_eof() (asyncio.StreamWriter method): StreamWriter.   (line   49)
* write_eof() (asyncio.WriteTransport method): Write-only Transports.
                                                             (line   74)
* write_eof() (ssl.MemoryBIO method):    Memory BIO Support<2>.
                                                             (line  155)
* write_file() (in module distutils.file_util): distutils file_util — Single file operations.
                                                             (line   44)
* write_history_file() (in module readline): History file.   (line   14)
* WRITE_RESTRICTED:                      Generic Attribute Management.
                                                             (line   79)
* write_results() (trace.CoverageResults method): Programmatic Interface.
                                                             (line   60)
* write_text() (pathlib.Path method):    Methods<2>.         (line  438)
* write_through (io.TextIOWrapper attribute): Text I/O<2>.   (line  166)
* writing; values:                       Expression statements.
                                                             (line   17)
* WrongDocumentErr:                      Exceptions<16>.     (line   97)
* wsgiref (module):                      wsgiref — WSGI Utilities and Reference Implementation.
                                                             (line    6)
* wsgiref.handlers (module):             wsgiref handlers – server/gateway base classes.
                                                             (line    6)
* wsgiref.headers (module):              wsgiref headers – WSGI response header tools.
                                                             (line    6)
* wsgiref.simple_server (module):        wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line    6)
* wsgiref.util (module):                 wsgiref util – WSGI environment utilities.
                                                             (line    6)
* wsgiref.validate (module):             wsgiref validate — WSGI conformance checker.
                                                             (line    6)
* WSGIRequestHandler (class in wsgiref.simple_server): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   66)
* WSGIServer (class in wsgiref.simple_server): wsgiref simple_server – a simple WSGI HTTP server.
                                                             (line   36)
* wsgi_file_wrapper (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  268)
* wsgi_multiprocess (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  152)
* wsgi_multithread (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  145)
* wsgi_run_once (wsgiref.handlers.BaseHandler attribute): wsgiref handlers – server/gateway base classes.
                                                             (line  159)
* wShowWindow (subprocess.STARTUPINFO attribute): Windows Popen Helpers.
                                                             (line   48)
* WSTOPPED (in module os):               Process Management. (line  719)
* WSTOPSIG() (in module os):             Process Management. (line  871)
* wstring_at() (in module ctypes):       Utility functions.  (line  214)
* ws_comma (2to3 fixer):                 Fixers.             (line  324)
* WTERMSIG() (in module os):             Process Management. (line  877)
* WUNTRACED (in module os):              Process Management. (line  817)
* WWW:                                   Internet Protocols and Support.
                                                             (line    6)
* WWW <1>:                               urllib parse — Parse URLs into components.
                                                             (line    8)
* WWW <2>:                               urllib robotparser — Parser for robots txt.
                                                             (line    8)
* WWW; server:                           cgi — Common Gateway Interface support.
                                                             (line    8)
* WWW; server <1>:                       http server — HTTP servers.
                                                             (line    8)
* W_OK (in module os):                   Files and Directories.
                                                             (line  106)
* X (in module re):                      Module Contents.    (line  120)
* X509 certificate:                      SSL Contexts.       (line  614)
* xatom() (imaplib.IMAP4 method):        IMAP4 Objects.      (line  362)
* XATTR_CREATE (in module os):           Linux extended attributes.
                                                             (line   75)
* XATTR_REPLACE (in module os):          Linux extended attributes.
                                                             (line   81)
* XATTR_SIZE_MAX (in module os):         Linux extended attributes.
                                                             (line   70)
* xcor() (in module turtle):             Tell Turtle’s state.
                                                             (line   31)
* XDR:                                   xdrlib — Encode and decode XDR data.
                                                             (line    8)
* xdrlib (module):                       xdrlib — Encode and decode XDR data.
                                                             (line    6)
* xhdr() (nntplib.NNTP method):          Methods<3>.         (line  284)
* XHTML:                                 html parser — Simple HTML and XHTML parser.
                                                             (line    8)
* XHTML_NAMESPACE (in module xml.dom):   Module Contents<4>. (line   53)
* xml (module):                          XML Processing Modules.
                                                             (line    6)
* XML() (in module xml.etree.ElementTree): Functions<6>.     (line  246)
* xml.dom (module):                      xml dom — The Document Object Model API.
                                                             (line    6)
* xml.dom.minidom (module):              xml dom minidom — Minimal DOM implementation.
                                                             (line    6)
* xml.dom.pulldom (module):              xml dom pulldom — Support for building partial DOM trees.
                                                             (line    6)
* xml.etree.ElementInclude.default_loader() (in module xml.etree.ElementTree): Functions<7>.
                                                             (line    6)
* xml.etree.ElementInclude.include() (in module xml.etree.ElementTree): Functions<7>.
                                                             (line   17)
* xml.etree.ElementTree (module):        xml etree ElementTree — The ElementTree XML API.
                                                             (line    6)
* xml.parsers.expat (module):            xml parsers expat — Fast XML parsing using Expat.
                                                             (line    6)
* xml.parsers.expat.errors (module):     Expat error constants.
                                                             (line    6)
* xml.parsers.expat.model (module):      Content Model Descriptions.
                                                             (line    6)
* xml.sax (module):                      xml sax — Support for SAX2 parsers.
                                                             (line    6)
* xml.sax.handler (module):              xml sax handler — Base classes for SAX handlers.
                                                             (line    6)
* xml.sax.saxutils (module):             xml sax saxutils — SAX Utilities.
                                                             (line    6)
* xml.sax.xmlreader (module):            xml sax xmlreader — Interface for XML parsers.
                                                             (line    6)
* xmlcharrefreplace_errors() (in module codecs): Error Handlers.
                                                             (line  145)
* XmlDeclHandler() (xml.parsers.expat.xmlparser method): XMLParser Objects<2>.
                                                             (line  175)
* XMLFilterBase (class in xml.sax.saxutils): xml sax saxutils — SAX Utilities.
                                                             (line   67)
* XMLGenerator (class in xml.sax.saxutils): xml sax saxutils — SAX Utilities.
                                                             (line   51)
* XMLID() (in module xml.etree.ElementTree): Functions<6>.   (line  254)
* XMLNS_NAMESPACE (in module xml.dom):   Module Contents<4>. (line   47)
* XMLParser (class in xml.etree.ElementTree): XMLParser Objects.
                                                             (line    6)
* XMLParserType (in module xml.parsers.expat): xml parsers expat — Fast XML parsing using Expat.
                                                             (line   35)
* XMLPullParser (class in xml.etree.ElementTree): XMLPullParser Objects.
                                                             (line    6)
* XMLReader (class in xml.sax.xmlreader): xml sax xmlreader — Interface for XML parsers.
                                                             (line   16)
* xmlrpc.client (module):                xmlrpc client — XML-RPC client access.
                                                             (line    6)
* xmlrpc.server (module):                xmlrpc server — Basic XML-RPC servers.
                                                             (line    6)
* XML_ERROR_ABORTED (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  180)
* XML_ERROR_ASYNC_ENTITY (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   29)
* XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   31)
* XML_ERROR_BAD_CHAR_REF (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   37)
* XML_ERROR_BINARY_ENTITY_REF (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   42)
* XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  135)
* XML_ERROR_DUPLICATE_ATTRIBUTE (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   47)
* XML_ERROR_ENTITY_DECLARED_IN_PE (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  126)
* XML_ERROR_EXTERNAL_ENTITY_HANDLING (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  116)
* XML_ERROR_FEATURE_REQUIRES_XML_DTD (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  128)
* XML_ERROR_FINISHED (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  184)
* XML_ERROR_INCOMPLETE_PE (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  152)
* XML_ERROR_INCORRECT_ENCODING (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   51)
* XML_ERROR_INVALID_TOKEN (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   53)
* XML_ERROR_JUNK_AFTER_DOC_ELEMENT (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   59)
* XML_ERROR_MISPLACED_XML_PI (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   64)
* XML_ERROR_NOT_STANDALONE (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  118)
* XML_ERROR_NOT_SUSPENDED (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  175)
* XML_ERROR_NO_ELEMENTS (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   69)
* XML_ERROR_NO_MEMORY (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   74)
* XML_ERROR_PARAM_ENTITY_REF (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   78)
* XML_ERROR_PARTIAL_CHAR (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   82)
* XML_ERROR_PUBLICID (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  165)
* XML_ERROR_RECURSIVE_ENTITY_REF (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   86)
* XML_ERROR_SUSPENDED (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  169)
* XML_ERROR_SUSPEND_PE (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  190)
* XML_ERROR_SYNTAX (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   91)
* XML_ERROR_TAG_MISMATCH (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   95)
* XML_ERROR_TEXT_DECL (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  160)
* XML_ERROR_UNBOUND_PREFIX (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  142)
* XML_ERROR_UNCLOSED_CDATA_SECTION (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  112)
* XML_ERROR_UNCLOSED_TOKEN (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line   99)
* XML_ERROR_UNDECLARING_PREFIX (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  147)
* XML_ERROR_UNDEFINED_ENTITY (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  104)
* XML_ERROR_UNEXPECTED_STATE (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  124)
* XML_ERROR_UNKNOWN_ENCODING (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  108)
* XML_ERROR_XML_DECL (in module xml.parsers.expat.errors): Expat error constants.
                                                             (line  156)
* XML_NAMESPACE (in module xml.dom):     Module Contents<4>. (line   42)
* xor() (in module operator):            operator — Standard operators as functions.
                                                             (line  164)
* xover() (nntplib.NNTP method):         Methods<3>.         (line  300)
* xpath() (nntplib.NNTP method):         Methods<3>.         (line  308)
* xrange (2to3 fixer):                   Fixers.             (line  329)
* xreadlines (2to3 fixer):               Fixers.             (line  334)
* xview() (tkinter.ttk.Treeview method): ttk Treeview.       (line  327)
* X_OK (in module os):                   Files and Directories.
                                                             (line  106)
* ycor() (in module turtle):             Tell Turtle’s state.
                                                             (line   37)
* year (datetime.date attribute):        date Objects.       (line  102)
* year (datetime.datetime attribute):    datetime Objects.   (line  265)
* Year 2038:                             time — Time access and conversions.
                                                             (line   30)
* yeardatescalendar() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line  106)
* yeardays2calendar() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line  114)
* yeardayscalendar() (calendar.Calendar method): calendar — General calendar-related functions.
                                                             (line  121)
* YESEXPR (in module locale):            locale — Internationalization services.
                                                             (line  240)
* yield; examples:                       Generator-iterator methods.
                                                             (line   57)
* yield; expression:                     Yield expressions.  (line    6)
* yield; yield from (in What’s New):     PEP 3151 Reworking the OS and IO exception hierarchy.
                                                             (line   87)
* YIELD_FROM (opcode):                   Python Bytecode Instructions.
                                                             (line  350)
* YIELD_VALUE (opcode):                  Python Bytecode Instructions.
                                                             (line  346)
* yiq_to_rgb() (in module colorsys):     colorsys — Conversions between color systems.
                                                             (line   32)
* yview() (tkinter.ttk.Treeview method): ttk Treeview.       (line  331)
* Zen of Python:                         Glossary.           (line 1260)
* ZeroDivisionError:                     Concrete exceptions.
                                                             (line  384)
* zfill() (bytearray method):            Bytes and Bytearray Operations.
                                                             (line  683)
* zfill() (bytes method):                Bytes and Bytearray Operations.
                                                             (line  683)
* zfill() (str method):                  String Methods<2>.  (line  604)
* zip (2to3 fixer):                      Fixers.             (line  338)
* zip() (built-in function):             Built-in Functions. (line 1708)
* zipapp (module):                       zipapp — Manage executable Python zip archives.
                                                             (line    6)
* zipapp command line option; -c, –compress: Command-Line Interface<5>.
                                                             (line   45)
* zipapp command line option; -h, –help: Command-Line Interface<5>.
                                                             (line   61)
* zipapp command line option; –info:     Command-Line Interface<5>.
                                                             (line   55)
* zipapp command line option; -m <mainfn>, –main=<mainfn>: Command-Line Interface<5>.
                                                             (line   35)
* zipapp command line option; -o <output>, –output=<output>: Command-Line Interface<5>.
                                                             (line   18)
* zipapp command line option; -p <interpreter>, –python=<interpreter>: Command-Line Interface<5>.
                                                             (line   29)
* ZipFile (class in zipfile):            ZipFile Objects.    (line    6)
* zipfile (module):                      zipfile — Work with ZIP archives.
                                                             (line    6)
* zipfile command line option; -c <zipfile> <source1> ... <sourceN>: Command-line options.
                                                             (line   11)
* zipfile command line option; –create <zipfile> <source1> ... <sourceN>: Command-line options.
                                                             (line   11)
* zipfile command line option; -e <zipfile> <output_dir>: Command-line options.
                                                             (line   16)
* zipfile command line option; –extract <zipfile> <output_dir>: Command-line options.
                                                             (line   16)
* zipfile command line option; -l <zipfile>: Command-line options.
                                                             (line    6)
* zipfile command line option; –list <zipfile>: Command-line options.
                                                             (line    6)
* zipfile command line option; -t <zipfile>: Command-line options.
                                                             (line   21)
* zipfile command line option; –test <zipfile>: Command-line options.
                                                             (line   21)
* zipimport (module):                    zipimport — Import modules from Zip archives.
                                                             (line    6)
* zipimporter (class in zipimport):      zipimporter Objects.
                                                             (line    8)
* ZipImportError:                        zipimport — Import modules from Zip archives.
                                                             (line   55)
* ZipInfo (class in zipfile):            zipfile — Work with ZIP archives.
                                                             (line   58)
* ZIP_BZIP2 (in module zipfile):         zipfile — Work with ZIP archives.
                                                             (line   88)
* ZIP_DEFLATED (in module zipfile):      zipfile — Work with ZIP archives.
                                                             (line   83)
* zip_longest() (in module itertools):   Itertool functions. (line  583)
* ZIP_LZMA (in module zipfile):          zipfile — Work with ZIP archives.
                                                             (line   95)
* ZIP_STORED (in module zipfile):        zipfile — Work with ZIP archives.
                                                             (line   79)
* zlib (module):                         zlib — Compression compatible with gzip.
                                                             (line    6)
* ZLIB_RUNTIME_VERSION (in module zlib): zlib — Compression compatible with gzip.
                                                             (line  309)
* ZLIB_VERSION (in module zlib):         zlib — Compression compatible with gzip.
                                                             (line  302)

                                                             
                                                             
                                                             
                                                             
                                                             
                                                             



Tag Table:
Node: Top343
Ref: contents doc543
Ref: 145543
Node: What’s New in Python183157
Ref: whatsnew/index doc183259
Ref: 146183259
Ref: whatsnew/index python-documentation-contents183259
Ref: 147183259
Ref: whatsnew/index what-s-new-in-python183259
Ref: 148183259
Ref: whatsnew/index whatsnew-index183259
Ref: 149183259
Node: What’s New In Python 3 8184534
Ref: whatsnew/3 8 doc184654
Ref: 14a184654
Ref: whatsnew/3 8 what-s-new-in-python-3-8184654
Ref: 14b184654
Node: Summary – Release highlights185243
Ref: whatsnew/3 8 summary-release-highlights185357
Ref: 14d185357
Node: New Features185430
Ref: whatsnew/3 8 new-features185575
Ref: 14e185575
Node: Assignment expressions186181
Ref: whatsnew/3 8 assignment-expressions186287
Ref: 14f186287
Ref: Assignment expressions-Footnote-1187793
Ref: Assignment expressions-Footnote-2187890
Ref: Assignment expressions-Footnote-3187939
Node: Positional-only parameters187982
Ref: whatsnew/3 8 positional-only-parameters188150
Ref: 151188150
Ref: Positional-only parameters-Footnote-1190859
Ref: Positional-only parameters-Footnote-2190911
Ref: Positional-only parameters-Footnote-3190960
Node: Parallel filesystem cache for compiled bytecode files191003
Ref: whatsnew/3 8 parallel-filesystem-cache-for-compiled-bytecode-files191195
Ref: 153191195
Ref: Parallel filesystem cache for compiled bytecode files-Footnote-1191837
Node: Debug build uses the same ABI as release build191880
Ref: whatsnew/3 8 debug-build-uses-the-same-abi-as-release-build192112
Ref: 158192112
Ref: Debug build uses the same ABI as release build-Footnote-1194447
Ref: Debug build uses the same ABI as release build-Footnote-2194490
Ref: Debug build uses the same ABI as release build-Footnote-3194533
Ref: Debug build uses the same ABI as release build-Footnote-4194576
Node: f-strings support = for self-documenting expressions and debugging194619
Ref: whatsnew/3 8 f-strings-support-for-self-documenting-expressions-and-debugging194832
Ref: 15a194832
Ref: f-strings support = for self-documenting expressions and debugging-Footnote-1195921
Node: PEP 578 Python Runtime Audit Hooks195964
Ref: whatsnew/3 8 pep-578-python-runtime-audit-hooks196174
Ref: 15d196174
Ref: PEP 578 Python Runtime Audit Hooks-Footnote-1196657
Node: PEP 587 Python Initialization Configuration196706
Ref: whatsnew/3 8 pep-587-python-initialization-configuration196896
Ref: 15e196896
Ref: PEP 587 Python Initialization Configuration-Footnote-1198883
Ref: PEP 587 Python Initialization Configuration-Footnote-2198932
Ref: PEP 587 Python Initialization Configuration-Footnote-3198981
Node: Vectorcall a fast calling protocol for CPython199024
Ref: whatsnew/3 8 vectorcall-a-fast-calling-protocol-for-cpython199227
Ref: 17e199227
Ref: Vectorcall a fast calling protocol for CPython-Footnote-1199787
Ref: Vectorcall a fast calling protocol for CPython-Footnote-2199836
Node: Pickle protocol 5 with out-of-band data buffers199879
Ref: whatsnew/3 8 pickle-protocol-5-with-out-of-band-data-buffers200030
Ref: 17f200030
Ref: Pickle protocol 5 with out-of-band data buffers-Footnote-1200782
Ref: Pickle protocol 5 with out-of-band data buffers-Footnote-2200831
Ref: Pickle protocol 5 with out-of-band data buffers-Footnote-3200880
Node: Other Language Changes200923
Ref: whatsnew/3 8 other-language-changes201049
Ref: 180201049
Ref: Other Language Changes-Footnote-1208426
Ref: Other Language Changes-Footnote-2208469
Ref: Other Language Changes-Footnote-3208512
Ref: Other Language Changes-Footnote-4208555
Ref: Other Language Changes-Footnote-5208598
Ref: Other Language Changes-Footnote-6208641
Ref: Other Language Changes-Footnote-7208684
Ref: Other Language Changes-Footnote-8208727
Ref: Other Language Changes-Footnote-9208770
Ref: Other Language Changes-Footnote-10208813
Ref: Other Language Changes-Footnote-11208857
Ref: Other Language Changes-Footnote-12208903
Ref: Other Language Changes-Footnote-13208947
Ref: Other Language Changes-Footnote-14209017
Ref: Other Language Changes-Footnote-15209077
Ref: Other Language Changes-Footnote-16209121
Ref: Other Language Changes-Footnote-17209165
Node: New Modules209209
Ref: whatsnew/3 8 new-modules209339
Ref: 19c209339
Ref: New Modules-Footnote-1210412
Node: Improved Modules210455
Ref: whatsnew/3 8 improved-modules210576
Ref: 19d210576
Node: ast211200
Ref: whatsnew/3 8 ast211272
Ref: 19e211272
Ref: ast-Footnote-1212304
Ref: ast-Footnote-2212347
Ref: ast-Footnote-3212396
Ref: ast-Footnote-4212445
Ref: ast-Footnote-5212494
Node: asyncio212537
Ref: whatsnew/3 8 asyncio212626
Ref: 1a3212626
Ref: asyncio-Footnote-1215709
Ref: asyncio-Footnote-2215752
Ref: asyncio-Footnote-3215795
Ref: asyncio-Footnote-4215838
Ref: asyncio-Footnote-5215881
Ref: asyncio-Footnote-6215924
Ref: asyncio-Footnote-7215967
Ref: asyncio-Footnote-8216010
Ref: asyncio-Footnote-9216053
Ref: asyncio-Footnote-10216106
Node: builtins216150
Ref: whatsnew/3 8 builtins216247
Ref: 1b1216247
Ref: builtins-Footnote-1216746
Node: collections216789
Ref: whatsnew/3 8 collections216887
Ref: 1b3216887
Ref: collections-Footnote-1217409
Node: cProfile217452
Ref: whatsnew/3 8 cprofile217545
Ref: 1b8217545
Ref: cProfile-Footnote-1217895
Node: csv217938
Ref: whatsnew/3 8 csv218026
Ref: 1ba218026
Ref: csv-Footnote-1218342
Node: curses218385
Ref: whatsnew/3 8 curses218471
Ref: 1bc218471
Ref: curses-Footnote-1218715
Node: ctypes218758
Ref: whatsnew/3 8 ctypes218849
Ref: 1be218849
Ref: ctypes-Footnote-1219338
Node: datetime219381
Ref: whatsnew/3 8 datetime219475
Ref: 1c1219475
Ref: datetime-Footnote-1219903
Node: functools219946
Ref: whatsnew/3 8 functools220036
Ref: 1c4220036
Ref: functools-Footnote-1221578
Ref: functools-Footnote-2221621
Ref: functools-Footnote-3221664
Node: gc221707
Ref: whatsnew/3 8 gc221796
Ref: 1ca221796
Ref: gc-Footnote-1222029
Node: gettext222072
Ref: whatsnew/3 8 gettext222156
Ref: 1cc222156
Ref: gettext-Footnote-1222357
Node: gzip222399
Ref: whatsnew/3 8 gzip222497
Ref: 1ce222497
Ref: gzip-Footnote-1222914
Ref: gzip-Footnote-2222957
Node: IDLE and idlelib222999
Ref: whatsnew/3 8 idle-and-idlelib223097
Ref: 1d2223097
Ref: IDLE and idlelib-Footnote-1224770
Ref: IDLE and idlelib-Footnote-2224815
Ref: IDLE and idlelib-Footnote-3224857
Ref: IDLE and idlelib-Footnote-4224900
Ref: IDLE and idlelib-Footnote-5224943
Node: inspect224986
Ref: whatsnew/3 8 inspect225082
Ref: 1d3225082
Ref: inspect-Footnote-1225848
Node: io225891
Ref: whatsnew/3 8 io225980
Ref: 1d8225980
Ref: io-Footnote-1226316
Node: itertools226359
Ref: whatsnew/3 8 itertools226450
Ref: 1da226450
Ref: itertools-Footnote-1226828
Node: json tool226871
Ref: whatsnew/3 8 json-tool226967
Ref: 1dc226967
Ref: json tool-Footnote-1227174
Node: logging227217
Ref: whatsnew/3 8 logging227308
Ref: 1dd227308
Ref: logging-Footnote-1228024
Node: math228067
Ref: whatsnew/3 8 math228153
Ref: 1df228153
Ref: math-Footnote-1229902
Ref: math-Footnote-2229945
Ref: math-Footnote-3229988
Ref: math-Footnote-4230031
Ref: math-Footnote-5230074
Ref: math-Footnote-6230117
Ref: math-Footnote-7230160
Ref: math-Footnote-8230203
Node: mmap230246
Ref: whatsnew/3 8 mmap230340
Ref: 1e9230340
Ref: mmap-Footnote-1230570
Node: multiprocessing230613
Ref: whatsnew/3 8 multiprocessing230705
Ref: 1ec230705
Ref: multiprocessing-Footnote-1231009
Ref: multiprocessing-Footnote-2231052
Node: os231095
Ref: whatsnew/3 8 os231190
Ref: 1ed231190
Ref: os-Footnote-1232698
Ref: os-Footnote-2232741
Ref: os-Footnote-3232784
Node: os path232827
Ref: whatsnew/3 8 os-path232914
Ref: 1f3232914
Ref: os path-Footnote-1233937
Ref: os path-Footnote-2233980
Ref: os path-Footnote-3234023
Node: pathlib234066
Ref: whatsnew/3 8 pathlib234157
Ref: 1fe234157
Ref: pathlib-Footnote-1234883
Ref: pathlib-Footnote-2234926
Node: pickle234969
Ref: whatsnew/3 8 pickle235061
Ref: 20a235061
Ref: pickle-Footnote-1235399
Node: plistlib235442
Ref: whatsnew/3 8 plistlib235533
Ref: 20d235533
Ref: plistlib-Footnote-1235771
Node: pprint235814
Ref: whatsnew/3 8 pprint235909
Ref: 20f235909
Ref: pprint-Footnote-1236974
Node: py_compile237017
Ref: whatsnew/3 8 py-compile237109
Ref: 212237109
Ref: py_compile-Footnote-1237298
Node: shlex237341
Ref: whatsnew/3 8 shlex237433
Ref: 214237433
Ref: shlex-Footnote-1237637
Node: shutil237680
Ref: whatsnew/3 8 shutil237768
Ref: 217237768
Ref: shutil-Footnote-1238422
Ref: shutil-Footnote-2238465
Ref: shutil-Footnote-3238508
Node: socket238551
Ref: whatsnew/3 8 socket238637
Ref: 21b238637
Ref: socket-Footnote-1239212
Ref: socket-Footnote-2239255
Node: ssl239298
Ref: whatsnew/3 8 ssl239388
Ref: 221239388
Ref: ssl-Footnote-1239650
Node: statistics239693
Ref: whatsnew/3 8 statistics239780
Ref: 224239780
Ref: statistics-Footnote-1241511
Ref: statistics-Footnote-2241554
Ref: statistics-Footnote-3241597
Ref: statistics-Footnote-4241640
Ref: statistics-Footnote-5241683
Node: sys241726
Ref: whatsnew/3 8 sys241817
Ref: 22a241817
Ref: sys-Footnote-1242260
Node: tarfile242303
Ref: whatsnew/3 8 tarfile242393
Ref: 22d242393
Ref: tarfile-Footnote-1242812
Node: threading242855
Ref: whatsnew/3 8 threading242950
Ref: 22e242950
Ref: threading-Footnote-1243686
Ref: threading-Footnote-2243731
Node: tokenize243774
Ref: whatsnew/3 8 tokenize243869
Ref: 234243869
Ref: tokenize-Footnote-1244195
Node: tkinter244238
Ref: whatsnew/3 8 tkinter244328
Ref: 235244328
Ref: tkinter-Footnote-1244871
Ref: tkinter-Footnote-2244914
Ref: tkinter-Footnote-3244957
Node: time245000
Ref: whatsnew/3 8 time245088
Ref: 236245088
Ref: time-Footnote-1245267
Node: typing245310
Ref: whatsnew/3 8 typing245402
Ref: 238245402
Ref: typing-Footnote-1246876
Ref: typing-Footnote-2246925
Ref: typing-Footnote-3246974
Ref: typing-Footnote-4247023
Node: unicodedata247072
Ref: whatsnew/3 8 unicodedata247168
Ref: 243247168
Ref: unicodedata-Footnote-1247597
Ref: unicodedata-Footnote-2247658
Ref: unicodedata-Footnote-3247701
Node: unittest247744
Ref: whatsnew/3 8 unittest247838
Ref: 245247838
Ref: unittest-Footnote-1249128
Ref: unittest-Footnote-2249171
Ref: unittest-Footnote-3249214
Ref: unittest-Footnote-4249257
Node: venv249300
Ref: whatsnew/3 8 venv249390
Ref: 24c249390
Ref: venv-Footnote-1249642
Node: weakref249685
Ref: whatsnew/3 8 weakref249770
Ref: 24d249770
Ref: weakref-Footnote-1250063
Node: xml250106
Ref: whatsnew/3 8 xml250193
Ref: 24f250193
Ref: xml-Footnote-1251367
Ref: xml-Footnote-2251410
Ref: xml-Footnote-3251453
Ref: xml-Footnote-4251496
Ref: xml-Footnote-5251539
Node: xmlrpc251582
Ref: whatsnew/3 8 xmlrpc251653
Ref: 252251653
Ref: xmlrpc-Footnote-1252045
Node: Optimizations252088
Ref: whatsnew/3 8 optimizations252221
Ref: 254252221
Ref: Optimizations-Footnote-1256588
Ref: Optimizations-Footnote-2256631
Ref: Optimizations-Footnote-3256674
Ref: Optimizations-Footnote-4256717
Ref: Optimizations-Footnote-5256760
Ref: Optimizations-Footnote-6256803
Ref: Optimizations-Footnote-7256846
Ref: Optimizations-Footnote-8256889
Ref: Optimizations-Footnote-9256932
Ref: Optimizations-Footnote-10256975
Ref: Optimizations-Footnote-11257019
Ref: Optimizations-Footnote-12257063
Ref: Optimizations-Footnote-13257107
Node: Build and C API Changes257151
Ref: whatsnew/3 8 build-and-c-api-changes257278
Ref: 261257278
Ref: Build and C API Changes-Footnote-1262869
Ref: Build and C API Changes-Footnote-2262912
Ref: Build and C API Changes-Footnote-3262955
Ref: Build and C API Changes-Footnote-4262998
Ref: Build and C API Changes-Footnote-5263041
Ref: Build and C API Changes-Footnote-6263084
Ref: Build and C API Changes-Footnote-7263127
Ref: Build and C API Changes-Footnote-8263170
Ref: Build and C API Changes-Footnote-9263213
Ref: Build and C API Changes-Footnote-10263256
Ref: Build and C API Changes-Footnote-11263300
Ref: Build and C API Changes-Footnote-12263344
Node: Deprecated263388
Ref: whatsnew/3 8 deprecated263526
Ref: 275263526
Ref: Deprecated-Footnote-1269394
Ref: Deprecated-Footnote-2269437
Ref: Deprecated-Footnote-3269480
Ref: Deprecated-Footnote-4269523
Ref: Deprecated-Footnote-5269565
Ref: Deprecated-Footnote-6269608
Ref: Deprecated-Footnote-7269651
Ref: Deprecated-Footnote-8269694
Ref: Deprecated-Footnote-9269737
Ref: Deprecated-Footnote-10269780
Ref: Deprecated-Footnote-11269824
Ref: Deprecated-Footnote-12269868
Ref: Deprecated-Footnote-13269912
Node: API and Feature Removals269956
Ref: whatsnew/3 8 api-and-feature-removals270092
Ref: 2a6270092
Ref: API and Feature Removals-Footnote-1272926
Ref: API and Feature Removals-Footnote-2272969
Ref: API and Feature Removals-Footnote-3273012
Ref: API and Feature Removals-Footnote-4273055
Ref: API and Feature Removals-Footnote-5273098
Ref: API and Feature Removals-Footnote-6273141
Ref: API and Feature Removals-Footnote-7273184
Ref: API and Feature Removals-Footnote-8273227
Ref: API and Feature Removals-Footnote-9273270
Ref: API and Feature Removals-Footnote-10273313
Ref: API and Feature Removals-Footnote-11273357
Node: Porting to Python 3 8273401
Ref: whatsnew/3 8 porting-to-python-3-8273558
Ref: 2ac273558
Node: Changes in Python behavior273869
Ref: whatsnew/3 8 changes-in-python-behavior273987
Ref: 2ad273987
Ref: Changes in Python behavior-Footnote-1276367
Ref: Changes in Python behavior-Footnote-2276410
Ref: Changes in Python behavior-Footnote-3276453
Ref: Changes in Python behavior-Footnote-4276496
Ref: Changes in Python behavior-Footnote-5276539
Ref: Changes in Python behavior-Footnote-6276582
Node: Changes in the Python API276625
Ref: whatsnew/3 8 changes-in-the-python-api276772
Ref: 2b5276772
Ref: whatsnew/3 8 bpo-36085-whatsnew283345
Ref: 2c8283345
Ref: Changes in the Python API-Footnote-1284895
Ref: Changes in the Python API-Footnote-2284944
Ref: Changes in the Python API-Footnote-3284987
Ref: Changes in the Python API-Footnote-4285030
Ref: Changes in the Python API-Footnote-5285073
Ref: Changes in the Python API-Footnote-6285116
Ref: Changes in the Python API-Footnote-7285159
Ref: Changes in the Python API-Footnote-8285202
Ref: Changes in the Python API-Footnote-9285245
Ref: Changes in the Python API-Footnote-10285288
Ref: Changes in the Python API-Footnote-11285332
Ref: Changes in the Python API-Footnote-12285376
Ref: Changes in the Python API-Footnote-13285420
Ref: Changes in the Python API-Footnote-14285464
Ref: Changes in the Python API-Footnote-15285508
Ref: Changes in the Python API-Footnote-16285552
Ref: Changes in the Python API-Footnote-17285596
Ref: Changes in the Python API-Footnote-18285639
Ref: Changes in the Python API-Footnote-19285683
Ref: Changes in the Python API-Footnote-20285727
Ref: Changes in the Python API-Footnote-21285771
Ref: Changes in the Python API-Footnote-22285815
Ref: Changes in the Python API-Footnote-23285859
Ref: Changes in the Python API-Footnote-24285903
Ref: Changes in the Python API-Footnote-25285947
Ref: Changes in the Python API-Footnote-26285991
Node: Changes in the C API286041
Ref: whatsnew/3 8 changes-in-the-c-api286186
Ref: 2c9286186
Ref: Changes in the C API-Footnote-1292194
Ref: Changes in the C API-Footnote-2292237
Ref: Changes in the C API-Footnote-3292280
Ref: Changes in the C API-Footnote-4292323
Ref: Changes in the C API-Footnote-5292366
Ref: Changes in the C API-Footnote-6292409
Ref: Changes in the C API-Footnote-7292452
Ref: Changes in the C API-Footnote-8292495
Ref: Changes in the C API-Footnote-9292544
Node: CPython bytecode changes292587
Ref: whatsnew/3 8 cpython-bytecode-changes292722
Ref: 2d8292722
Ref: CPython bytecode changes-Footnote-1294084
Ref: CPython bytecode changes-Footnote-2294127
Ref: CPython bytecode changes-Footnote-3294170
Ref: CPython bytecode changes-Footnote-4294219
Node: Demos and Tools294262
Ref: whatsnew/3 8 demos-and-tools294368
Ref: 2e3294368
Ref: Demos and Tools-Footnote-1297545
Node: Notable changes in Python 3 8 1297588
Ref: whatsnew/3 8 notable-changes-in-python-3-8-1297712
Ref: 2e4297712
Ref: Notable changes in Python 3 8 1-Footnote-1298223
Node: What’s New In Python 3 7298266
Ref: whatsnew/3 7 doc298421
Ref: 2e6298421
Ref: whatsnew/3 7 what-s-new-in-python-3-7298421
Ref: 2e7298421
Node: Summary – Release Highlights299573
Ref: whatsnew/3 7 summary-release-highlights299690
Ref: 2e8299690
Ref: Summary – Release Highlights-Footnote-1301843
Ref: Summary – Release Highlights-Footnote-2301923
Ref: Summary – Release Highlights-Footnote-3301959
Ref: Summary – Release Highlights-Footnote-4301995
Node: New Features<2>302031
Ref: whatsnew/3 7 new-features302182
Ref: 2fd302182
Node: PEP 563 Postponed Evaluation of Annotations303280
Ref: whatsnew/3 7 pep-563-postponed-evaluation-of-annotations303416
Ref: 2fe303416
Ref: whatsnew/3 7 whatsnew37-pep563303416
Ref: 2e9303416
Ref: PEP 563 Postponed Evaluation of Annotations-Footnote-1305179
Ref: PEP 563 Postponed Evaluation of Annotations-Footnote-2305228
Ref: PEP 563 Postponed Evaluation of Annotations-Footnote-3305277
Node: PEP 538 Legacy C Locale Coercion305326
Ref: whatsnew/3 7 pep-538-legacy-c-locale-coercion305504
Ref: 300305504
Ref: whatsnew/3 7 whatsnew37-pep538305504
Ref: 2f4305504
Ref: PEP 538 Legacy C Locale Coercion-Footnote-1307891
Ref: PEP 538 Legacy C Locale Coercion-Footnote-2307940
Ref: PEP 538 Legacy C Locale Coercion-Footnote-3307989
Ref: PEP 538 Legacy C Locale Coercion-Footnote-4308038
Node: PEP 540 Forced UTF-8 Runtime Mode308087
Ref: whatsnew/3 7 pep-540-forced-utf-8-runtime-mode308249
Ref: 305308249
Ref: whatsnew/3 7 whatsnew37-pep540308249
Ref: 2f5308249
Ref: PEP 540 Forced UTF-8 Runtime Mode-Footnote-1309805
Ref: PEP 540 Forced UTF-8 Runtime Mode-Footnote-2309854
Ref: PEP 540 Forced UTF-8 Runtime Mode-Footnote-3309903
Node: PEP 553 Built-in breakpoint309952
Ref: whatsnew/3 7 pep-553-built-in-breakpoint310124
Ref: 307310124
Ref: whatsnew/3 7 whatsnew37-pep553310124
Ref: 2ed310124
Ref: PEP 553 Built-in breakpoint-Footnote-1310963
Node: PEP 539 New C API for Thread-Local Storage311012
Ref: whatsnew/3 7 pep-539-new-c-api-for-thread-local-storage311203
Ref: 30a311203
Ref: whatsnew/3 7 whatsnew37-pep539311203
Ref: 2f9311203
Ref: PEP 539 New C API for Thread-Local Storage-Footnote-1312722
Ref: PEP 539 New C API for Thread-Local Storage-Footnote-2312771
Node: PEP 562 Customization of Access to Module Attributes312820
Ref: whatsnew/3 7 pep-562-customization-of-access-to-module-attributes313037
Ref: 30e313037
Ref: whatsnew/3 7 whatsnew37-pep562313037
Ref: 2ef313037
Ref: PEP 562 Customization of Access to Module Attributes-Footnote-1313624
Node: PEP 564 New Time Functions With Nanosecond Resolution313673
Ref: whatsnew/3 7 pep-564-new-time-functions-with-nanosecond-resolution313891
Ref: 311313891
Ref: whatsnew/3 7 whatsnew37-pep564313891
Ref: 2f3313891
Ref: PEP 564 New Time Functions With Nanosecond Resolution-Footnote-1314977
Ref: PEP 564 New Time Functions With Nanosecond Resolution-Footnote-2315026
Ref: PEP 564 New Time Functions With Nanosecond Resolution-Footnote-3315111
Node: PEP 565 Show DeprecationWarning in __main__315160
Ref: whatsnew/3 7 pep-565-show-deprecationwarning-in-main315382
Ref: 319315382
Ref: whatsnew/3 7 whatsnew37-pep565315382
Ref: 2f8315382
Ref: PEP 565 Show DeprecationWarning in __main__-Footnote-1317314
Node: PEP 560 Core Support for typing module and Generic Types317363
Ref: whatsnew/3 7 pep-560-core-support-for-typing-module-and-generic-types317560
Ref: 31b317560
Ref: whatsnew/3 7 whatsnew37-pep560317560
Ref: 2f0317560
Ref: PEP 560 Core Support for typing module and Generic Types-Footnote-1318515
Ref: PEP 560 Core Support for typing module and Generic Types-Footnote-2318564
Node: PEP 552 Hash-based pyc Files318613
Ref: whatsnew/3 7 pep-552-hash-based-pyc-files318808
Ref: 31d318808
Ref: whatsnew/3 7 whatsnew37-pep552318808
Ref: 2f6318808
Ref: PEP 552 Hash-based pyc Files-Footnote-1320482
Ref: PEP 552 Hash-based pyc Files-Footnote-2320523
Ref: PEP 552 Hash-based pyc Files-Footnote-3320572
Node: PEP 545 Python Documentation Translations320621
Ref: whatsnew/3 7 pep-545-python-documentation-translations320791
Ref: 31f320791
Ref: whatsnew/3 7 whatsnew37-pep545320791
Ref: 2fa320791
Ref: PEP 545 Python Documentation Translations-Footnote-1321375
Ref: PEP 545 Python Documentation Translations-Footnote-2321424
Node: Development Runtime Mode -X dev321473
Ref: whatsnew/3 7 development-runtime-mode-x-dev321606
Ref: 320321606
Ref: whatsnew/3 7 whatsnew37-devmode321606
Ref: 2f7321606
Node: Other Language Changes<2>322074
Ref: whatsnew/3 7 other-language-changes322209
Ref: 322322209
Ref: Other Language Changes<2>-Footnote-1324324
Ref: Other Language Changes<2>-Footnote-2324367
Ref: Other Language Changes<2>-Footnote-3324410
Ref: Other Language Changes<2>-Footnote-4324453
Ref: Other Language Changes<2>-Footnote-5324496
Ref: Other Language Changes<2>-Footnote-6324539
Ref: Other Language Changes<2>-Footnote-7324582
Ref: Other Language Changes<2>-Footnote-8324625
Ref: Other Language Changes<2>-Footnote-9324668
Ref: Other Language Changes<2>-Footnote-10324711
Node: New Modules<2>324755
Ref: whatsnew/3 7 new-modules324894
Ref: 32e324894
Node: contextvars325017
Ref: whatsnew/3 7 contextvars325099
Ref: 32f325099
Ref: whatsnew/3 7 whatsnew37-pep567325099
Ref: 2ea325099
Ref: contextvars-Footnote-1325828
Node: dataclasses325877
Ref: whatsnew/3 7 dataclasses325987
Ref: 331325987
Ref: whatsnew/3 7 whatsnew37-pep557325987
Ref: 2eb325987
Ref: dataclasses-Footnote-1326658
Node: importlib resources326707
Ref: whatsnew/3 7 importlib-resources326797
Ref: 336326797
Ref: whatsnew/3 7 whatsnew37-importlib-resources326797
Ref: 2ec326797
Ref: importlib resources-Footnote-1327545
Ref: importlib resources-Footnote-2327588
Node: Improved Modules<2>327649
Ref: whatsnew/3 7 improved-modules327776
Ref: 338327776
Node: argparse328927
Ref: whatsnew/3 7 argparse329010
Ref: 339329010
Ref: argparse-Footnote-1329244
Node: asyncio<2>329287
Ref: whatsnew/3 7 asyncio329387
Ref: 33b329387
Ref: whatsnew/3 7 whatsnew37-asyncio329387
Ref: 2f2329387
Ref: asyncio<2>-Footnote-1335689
Ref: asyncio<2>-Footnote-2335732
Ref: asyncio<2>-Footnote-3335781
Ref: asyncio<2>-Footnote-4335824
Ref: asyncio<2>-Footnote-5335867
Ref: asyncio<2>-Footnote-6335910
Ref: asyncio<2>-Footnote-7335953
Ref: asyncio<2>-Footnote-8335996
Ref: asyncio<2>-Footnote-9336039
Ref: asyncio<2>-Footnote-10336082
Ref: asyncio<2>-Footnote-11336126
Ref: asyncio<2>-Footnote-12336170
Ref: asyncio<2>-Footnote-13336214
Ref: asyncio<2>-Footnote-14336258
Ref: asyncio<2>-Footnote-15336302
Ref: asyncio<2>-Footnote-16336346
Ref: asyncio<2>-Footnote-17336390
Ref: asyncio<2>-Footnote-18336434
Ref: asyncio<2>-Footnote-19336478
Ref: asyncio<2>-Footnote-20336522
Ref: asyncio<2>-Footnote-21336566
Ref: asyncio<2>-Footnote-22336610
Ref: asyncio<2>-Footnote-23336654
Ref: asyncio<2>-Footnote-24336698
Node: binascii336742
Ref: whatsnew/3 7 binascii336842
Ref: 361336842
Ref: binascii-Footnote-1337121
Node: calendar337164
Ref: whatsnew/3 7 calendar337268
Ref: 363337268
Ref: calendar-Footnote-1337518
Node: collections<2>337561
Ref: whatsnew/3 7 collections337667
Ref: 365337667
Ref: collections<2>-Footnote-1337858
Node: compileall337901
Ref: whatsnew/3 7 compileall338017
Ref: 366338017
Ref: compileall-Footnote-1338414
Node: concurrent futures338457
Ref: whatsnew/3 7 concurrent-futures338569
Ref: 368338569
Ref: concurrent futures-Footnote-1339011
Ref: concurrent futures-Footnote-2339054
Node: contextlib339097
Ref: whatsnew/3 7 contextlib339210
Ref: 369339210
Ref: contextlib-Footnote-1339740
Ref: contextlib-Footnote-2339783
Ref: contextlib-Footnote-3339826
Ref: contextlib-Footnote-4339869
Node: cProfile<2>339912
Ref: whatsnew/3 7 cprofile340012
Ref: 36f340012
Ref: cProfile<2>-Footnote-1340238
Node: crypt340281
Ref: whatsnew/3 7 crypt340382
Ref: 370340382
Ref: crypt-Footnote-1340714
Ref: crypt-Footnote-2340757
Node: datetime<2>340800
Ref: whatsnew/3 7 datetime340893
Ref: 372340893
Ref: datetime<2>-Footnote-1341304
Ref: datetime<2>-Footnote-2341347
Node: dbm341389
Ref: whatsnew/3 7 dbm341484
Ref: 376341484
Node: decimal341629
Ref: whatsnew/3 7 decimal341716
Ref: 377341716
Ref: decimal-Footnote-1341937
Node: dis341980
Ref: whatsnew/3 7 dis342073
Ref: 378342073
Ref: dis-Footnote-1342476
Node: distutils342519
Ref: whatsnew/3 7 distutils342609
Ref: 37a342609
Ref: distutils-Footnote-1342857
Node: enum342900
Ref: whatsnew/3 7 enum342999
Ref: 37b342999
Ref: enum-Footnote-1343667
Ref: enum-Footnote-2343710
Node: functools<2>343753
Ref: whatsnew/3 7 functools343848
Ref: 37e343848
Ref: functools<2>-Footnote-1344077
Node: gc<2>344120
Ref: whatsnew/3 7 gc344215
Ref: 380344215
Ref: gc<2>-Footnote-1344754
Node: hmac344797
Ref: whatsnew/3 7 hmac344891
Ref: 384344891
Ref: hmac-Footnote-1345149
Node: http client345192
Ref: whatsnew/3 7 http-client345292
Ref: 386345292
Ref: http client-Footnote-1345549
Node: http server345592
Ref: whatsnew/3 7 http-server345704
Ref: 389345704
Ref: http server-Footnote-1346582
Ref: http server-Footnote-2346625
Ref: http server-Footnote-3346668
Node: idlelib and IDLE346711
Ref: whatsnew/3 7 idlelib-and-idle346821
Ref: 38c346821
Ref: idlelib and IDLE-Footnote-1349830
Ref: idlelib and IDLE-Footnote-2349873
Ref: idlelib and IDLE-Footnote-3349918
Ref: idlelib and IDLE-Footnote-4349961
Ref: idlelib and IDLE-Footnote-5350004
Ref: idlelib and IDLE-Footnote-6350047
Ref: idlelib and IDLE-Footnote-7350090
Ref: idlelib and IDLE-Footnote-8350133
Ref: idlelib and IDLE-Footnote-9350176
Ref: idlelib and IDLE-Footnote-10350219
Ref: idlelib and IDLE-Footnote-11350265
Ref: idlelib and IDLE-Footnote-12350308
Ref: idlelib and IDLE-Footnote-13350352
Node: importlib350396
Ref: whatsnew/3 7 importlib350500
Ref: 38d350500
Ref: importlib-Footnote-1351371
Ref: importlib-Footnote-2351414
Ref: importlib-Footnote-3351457
Node: io<2>351500
Ref: whatsnew/3 7 io351597
Ref: 391351597
Ref: io<2>-Footnote-1351862
Ref: io<2>-Footnote-2351905
Node: ipaddress351948
Ref: whatsnew/3 7 ipaddress352048
Ref: 393352048
Ref: ipaddress-Footnote-1352368
Node: itertools<2>352411
Ref: whatsnew/3 7 itertools352512
Ref: 396352512
Ref: itertools<2>-Footnote-1352749
Node: locale352792
Ref: whatsnew/3 7 locale352894
Ref: 398352894
Ref: locale-Footnote-1353308
Node: logging<2>353351
Ref: whatsnew/3 7 logging353448
Ref: 39b353448
Ref: logging<2>-Footnote-1353972
Ref: logging<2>-Footnote-2354015
Ref: logging<2>-Footnote-3354058
Node: math<2>354101
Ref: whatsnew/3 7 math354201
Ref: 39f354201
Ref: math<2>-Footnote-1354414
Node: mimetypes354457
Ref: whatsnew/3 7 mimetypes354553
Ref: 3a1354553
Ref: mimetypes-Footnote-1354768
Node: msilib354811
Ref: whatsnew/3 7 msilib354918
Ref: 3a2354918
Ref: msilib-Footnote-1355141
Node: multiprocessing<2>355184
Ref: whatsnew/3 7 multiprocessing355287
Ref: 3a4355287
Ref: multiprocessing<2>-Footnote-1355934
Ref: multiprocessing<2>-Footnote-2355977
Ref: multiprocessing<2>-Footnote-3356020
Node: os<2>356063
Ref: whatsnew/3 7 os356170
Ref: 3a8356170
Ref: os<2>-Footnote-1357468
Ref: os<2>-Footnote-2357511
Ref: os<2>-Footnote-3357554
Ref: os<2>-Footnote-4357597
Ref: os<2>-Footnote-5357640
Ref: os<2>-Footnote-6357683
Ref: os<2>-Footnote-7357726
Node: pathlib<2>357769
Ref: whatsnew/3 7 pathlib357861
Ref: 3b5357861
Ref: pathlib<2>-Footnote-1358121
Node: pdb358164
Ref: whatsnew/3 7 pdb358264
Ref: 3b6358264
Ref: pdb-Footnote-1358674
Ref: pdb-Footnote-2358717
Node: py_compile<2>358760
Ref: whatsnew/3 7 py-compile358855
Ref: 3b8358855
Ref: py_compile<2>-Footnote-1359309
Ref: py_compile<2>-Footnote-2359350
Node: pydoc359393
Ref: whatsnew/3 7 pydoc359490
Ref: 3b9359490
Ref: pydoc-Footnote-1359714
Node: queue359757
Ref: whatsnew/3 7 queue359843
Ref: 3ba359843
Ref: queue-Footnote-1360048
Node: re360091
Ref: whatsnew/3 7 re360178
Ref: 3bc360178
Ref: re-Footnote-1361254
Ref: re-Footnote-2361297
Ref: re-Footnote-3361340
Ref: re-Footnote-4361383
Ref: re-Footnote-5361426
Node: signal361469
Ref: whatsnew/3 7 signal361560
Ref: 3c2361560
Ref: signal-Footnote-1361879
Node: socket<2>361922
Ref: whatsnew/3 7 socket362023
Ref: 3c4362023
Ref: socket<2>-Footnote-1363111
Ref: socket<2>-Footnote-2363154
Ref: socket<2>-Footnote-3363197
Ref: socket<2>-Footnote-4363240
Ref: socket<2>-Footnote-5363283
Ref: socket<2>-Footnote-6363326
Node: socketserver363369
Ref: whatsnew/3 7 socketserver363471
Ref: 3c9363471
Node: sqlite3363947
Ref: whatsnew/3 7 sqlite3364046
Ref: 3cc364046
Ref: sqlite3-Footnote-1364488
Ref: sqlite3-Footnote-2364531
Node: ssl<2>364574
Ref: whatsnew/3 7 ssl364667
Ref: 3d0364667
Ref: ssl<2>-Footnote-1367716
Ref: ssl<2>-Footnote-2367759
Ref: ssl<2>-Footnote-3367802
Ref: ssl<2>-Footnote-4367845
Ref: ssl<2>-Footnote-5367888
Ref: ssl<2>-Footnote-6367931
Ref: ssl<2>-Footnote-7367974
Ref: ssl<2>-Footnote-8368017
Ref: ssl<2>-Footnote-9368060
Ref: ssl<2>-Footnote-10368103
Ref: ssl<2>-Footnote-11368147
Ref: ssl<2>-Footnote-12368191
Ref: ssl<2>-Footnote-13368235
Node: string368279
Ref: whatsnew/3 7 string368375
Ref: 3df368375
Ref: string-Footnote-1368652
Node: subprocess368697
Ref: whatsnew/3 7 subprocess368793
Ref: 3e1368793
Ref: subprocess-Footnote-1370115
Ref: subprocess-Footnote-2370158
Ref: subprocess-Footnote-3370201
Ref: subprocess-Footnote-4370244
Node: sys<2>370287
Ref: whatsnew/3 7 sys370384
Ref: 3e5370384
Ref: sys<2>-Footnote-1371124
Ref: sys<2>-Footnote-2371167
Ref: sys<2>-Footnote-3371210
Node: time<2>371253
Ref: whatsnew/3 7 time371350
Ref: 3e9371350
Ref: time<2>-Footnote-1372560
Ref: time<2>-Footnote-2372609
Node: tkinter<2>372652
Ref: whatsnew/3 7 tkinter372754
Ref: 3f1372754
Ref: tkinter<2>-Footnote-1372935
Node: tracemalloc372978
Ref: whatsnew/3 7 tracemalloc373078
Ref: 3f3373078
Ref: tracemalloc-Footnote-1373544
Node: types373587
Ref: whatsnew/3 7 types373691
Ref: 3f6373691
Ref: types-Footnote-1374206
Ref: types-Footnote-2374249
Ref: types-Footnote-3374292
Ref: types-Footnote-4374341
Node: unicodedata<2>374384
Ref: whatsnew/3 7 unicodedata374488
Ref: 3fc374488
Ref: unicodedata<2>-Footnote-1374691
Node: unittest<2>374746
Ref: whatsnew/3 7 unittest374858
Ref: 3fd374858
Ref: unittest<2>-Footnote-1375263
Node: unittest mock375306
Ref: whatsnew/3 7 unittest-mock375416
Ref: 3fe375416
Ref: unittest mock-Footnote-1375934
Ref: unittest mock-Footnote-2375977
Node: urllib parse376020
Ref: whatsnew/3 7 urllib-parse376121
Ref: 401376121
Ref: urllib parse-Footnote-1376434
Ref: urllib parse-Footnote-2376483
Ref: urllib parse-Footnote-3376532
Node: uu376575
Ref: whatsnew/3 7 uu376667
Ref: 403376667
Ref: uu-Footnote-1376939
Node: uuid376982
Ref: whatsnew/3 7 uuid377070
Ref: 405377070
Ref: uuid-Footnote-1377710
Ref: uuid-Footnote-2377753
Node: warnings377796
Ref: whatsnew/3 7 warnings377891
Ref: 409377891
Ref: warnings-Footnote-1379345
Ref: warnings-Footnote-2379388
Ref: warnings-Footnote-3379431
Ref: warnings-Footnote-4379474
Node: xml etree379517
Ref: whatsnew/3 7 xml-etree379621
Ref: 40e379621
Ref: xml etree-Footnote-1379962
Node: xmlrpc server380005
Ref: whatsnew/3 7 xmlrpc-server380107
Ref: 410380107
Ref: xmlrpc server-Footnote-1380316
Node: zipapp380358
Ref: whatsnew/3 7 zipapp380458
Ref: 411380458
Ref: zipapp-Footnote-1380982
Ref: zipapp-Footnote-2381025
Node: zipfile381068
Ref: whatsnew/3 7 zipfile381146
Ref: 413381146
Ref: zipfile-Footnote-1381511
Ref: zipfile-Footnote-2381554
Node: C API Changes381597
Ref: whatsnew/3 7 c-api-changes381723
Ref: 415381723
Ref: C API Changes-Footnote-1386234
Ref: C API Changes-Footnote-2386277
Ref: C API Changes-Footnote-3386320
Ref: C API Changes-Footnote-4386363
Ref: C API Changes-Footnote-5386406
Ref: C API Changes-Footnote-6386449
Ref: C API Changes-Footnote-7386492
Ref: C API Changes-Footnote-8386535
Ref: C API Changes-Footnote-9386578
Ref: C API Changes-Footnote-10386621
Ref: C API Changes-Footnote-11386665
Ref: C API Changes-Footnote-12386709
Ref: C API Changes-Footnote-13386753
Ref: C API Changes-Footnote-14386797
Ref: C API Changes-Footnote-15386841
Ref: C API Changes-Footnote-16386884
Ref: C API Changes-Footnote-17386928
Ref: C API Changes-Footnote-18386972
Ref: C API Changes-Footnote-19387016
Ref: C API Changes-Footnote-20387060
Node: Build Changes387104
Ref: whatsnew/3 7 build-changes387227
Ref: 436387227
Ref: Build Changes-Footnote-1388361
Ref: Build Changes-Footnote-2388404
Ref: Build Changes-Footnote-3388447
Node: Optimizations<2>388490
Ref: whatsnew/3 7 optimizations388636
Ref: 437388636
Ref: whatsnew/3 7 whatsnew37-perf388636
Ref: 2fb388636
Ref: whatsnew/3 7 whatsnew37-asyncio-perf389330
Ref: 33c389330
Ref: Optimizations<2>-Footnote-1393884
Ref: Optimizations<2>-Footnote-2393927
Ref: Optimizations<2>-Footnote-3393970
Ref: Optimizations<2>-Footnote-4394013
Ref: Optimizations<2>-Footnote-5394056
Ref: Optimizations<2>-Footnote-6394099
Ref: Optimizations<2>-Footnote-7394142
Ref: Optimizations<2>-Footnote-8394185
Ref: Optimizations<2>-Footnote-9394228
Ref: Optimizations<2>-Footnote-10394271
Ref: Optimizations<2>-Footnote-11394315
Ref: Optimizations<2>-Footnote-12394359
Ref: Optimizations<2>-Footnote-13394403
Ref: Optimizations<2>-Footnote-14394447
Ref: Optimizations<2>-Footnote-15394491
Ref: Optimizations<2>-Footnote-16394535
Ref: Optimizations<2>-Footnote-17394579
Ref: Optimizations<2>-Footnote-18394623
Ref: Optimizations<2>-Footnote-19394667
Ref: Optimizations<2>-Footnote-20394711
Ref: Optimizations<2>-Footnote-21394755
Ref: Optimizations<2>-Footnote-22394799
Ref: Optimizations<2>-Footnote-23394843
Ref: Optimizations<2>-Footnote-24394887
Ref: Optimizations<2>-Footnote-25394931
Ref: Optimizations<2>-Footnote-26394975
Ref: Optimizations<2>-Footnote-27395019
Ref: Optimizations<2>-Footnote-28395063
Ref: Optimizations<2>-Footnote-29395107
Ref: Optimizations<2>-Footnote-30395151
Node: Other CPython Implementation Changes395195
Ref: whatsnew/3 7 other-cpython-implementation-changes395354
Ref: 449395354
Ref: Other CPython Implementation Changes-Footnote-1396755
Ref: Other CPython Implementation Changes-Footnote-2396798
Ref: Other CPython Implementation Changes-Footnote-3396841
Ref: Other CPython Implementation Changes-Footnote-4396884
Ref: Other CPython Implementation Changes-Footnote-5396927
Node: Deprecated Python Behavior396970
Ref: whatsnew/3 7 deprecated-python-behavior397160
Ref: 44b397160
Ref: Deprecated Python Behavior-Footnote-1398269
Ref: Deprecated Python Behavior-Footnote-2398312
Node: Deprecated Python modules functions and methods398355
Ref: whatsnew/3 7 deprecated-python-modules-functions-and-methods398552
Ref: 44e398552
Node: aifc398950
Ref: whatsnew/3 7 aifc399057
Ref: 44f399057
Ref: aifc-Footnote-1399283
Node: asyncio<3>399326
Ref: whatsnew/3 7 id2399456
Ref: 451399456
Ref: whatsnew/3 7 whatsnew37-asyncio-deprecated399456
Ref: 360399456
Ref: asyncio<3>-Footnote-1399992
Ref: asyncio<3>-Footnote-2400035
Node: collections<3>400078
Ref: whatsnew/3 7 id3400210
Ref: 452400210
Ref: collections<3>-Footnote-1400589
Node: dbm<2>400632
Ref: whatsnew/3 7 id4400761
Ref: 453400761
Ref: dbm<2>-Footnote-1401162
Node: enum<2>401205
Ref: whatsnew/3 7 id5401330
Ref: 454401330
Ref: enum<2>-Footnote-1401780
Node: gettext<2>401823
Ref: whatsnew/3 7 gettext401954
Ref: 455401954
Ref: gettext<2>-Footnote-1402199
Node: importlib<2>402242
Ref: whatsnew/3 7 id6402375
Ref: 456402375
Ref: importlib<2>-Footnote-1402901
Node: locale<2>402944
Ref: whatsnew/3 7 id7403074
Ref: 45c403074
Ref: locale<2>-Footnote-1403283
Node: macpath403326
Ref: whatsnew/3 7 macpath403456
Ref: 45e403456
Ref: macpath-Footnote-1403646
Node: threading<2>403688
Ref: whatsnew/3 7 threading403818
Ref: 45f403818
Ref: threading<2>-Footnote-1404126
Node: socket<3>404169
Ref: whatsnew/3 7 id8404298
Ref: 460404298
Ref: socket<3>-Footnote-1404643
Node: ssl<3>404686
Ref: whatsnew/3 7 id9404808
Ref: 463404808
Ref: ssl<3>-Footnote-1405026
Node: sunau405069
Ref: whatsnew/3 7 sunau405188
Ref: 465405188
Ref: sunau-Footnote-1405427
Node: sys<3>405470
Ref: whatsnew/3 7 id10405587
Ref: 468405587
Ref: sys<3>-Footnote-1405904
Node: wave405947
Ref: whatsnew/3 7 wave406050
Ref: 469406050
Ref: wave-Footnote-1406285
Node: Deprecated functions and types of the C API406328
Ref: whatsnew/3 7 deprecated-functions-and-types-of-the-c-api406524
Ref: 46c406524
Ref: Deprecated functions and types of the C API-Footnote-1407182
Ref: Deprecated functions and types of the C API-Footnote-2407225
Node: Platform Support Removals407268
Ref: whatsnew/3 7 id11407444
Ref: 46e407444
Ref: whatsnew/3 7 platform-support-removals407444
Ref: 3d4407444
Ref: Platform Support Removals-Footnote-1408856
Ref: Platform Support Removals-Footnote-2408919
Node: API and Feature Removals<2>408998
Ref: whatsnew/3 7 api-and-feature-removals409146
Ref: 46f409146
Ref: API and Feature Removals<2>-Footnote-1412115
Ref: API and Feature Removals<2>-Footnote-2412158
Ref: API and Feature Removals<2>-Footnote-3412201
Node: Module Removals412244
Ref: whatsnew/3 7 module-removals412387
Ref: 477412387
Ref: Module Removals-Footnote-1412722
Node: Windows-only Changes412765
Ref: whatsnew/3 7 windows-only-changes412902
Ref: 478412902
Ref: Windows-only Changes-Footnote-1413779
Ref: Windows-only Changes-Footnote-2413822
Node: Porting to Python 3 7413865
Ref: whatsnew/3 7 porting-to-python-3-7414018
Ref: 479414018
Ref: whatsnew/3 7 porting-to-python-37414018
Ref: 2fc414018
Node: Changes in Python Behavior414480
Ref: whatsnew/3 7 changes-in-python-behavior414601
Ref: 47a414601
Ref: Changes in Python Behavior-Footnote-1416467
Ref: Changes in Python Behavior-Footnote-2416510
Ref: Changes in Python Behavior-Footnote-3416559
Ref: Changes in Python Behavior-Footnote-4416602
Ref: Changes in Python Behavior-Footnote-5416645
Ref: Changes in Python Behavior-Footnote-6416688
Node: Changes in the Python API<2>416731
Ref: whatsnew/3 7 changes-in-the-python-api416884
Ref: 47e416884
Ref: Changes in the Python API<2>-Footnote-1426435
Ref: Changes in the Python API<2>-Footnote-2426478
Ref: Changes in the Python API<2>-Footnote-3426521
Ref: Changes in the Python API<2>-Footnote-4426564
Ref: Changes in the Python API<2>-Footnote-5426607
Ref: Changes in the Python API<2>-Footnote-6426650
Ref: Changes in the Python API<2>-Footnote-7426693
Ref: Changes in the Python API<2>-Footnote-8426736
Ref: Changes in the Python API<2>-Footnote-9426779
Ref: Changes in the Python API<2>-Footnote-10426822
Ref: Changes in the Python API<2>-Footnote-11426866
Ref: Changes in the Python API<2>-Footnote-12426910
Ref: Changes in the Python API<2>-Footnote-13426954
Ref: Changes in the Python API<2>-Footnote-14426998
Ref: Changes in the Python API<2>-Footnote-15427041
Ref: Changes in the Python API<2>-Footnote-16427085
Ref: Changes in the Python API<2>-Footnote-17427129
Ref: Changes in the Python API<2>-Footnote-18427173
Ref: Changes in the Python API<2>-Footnote-19427217
Ref: Changes in the Python API<2>-Footnote-20427261
Ref: Changes in the Python API<2>-Footnote-21427305
Ref: Changes in the Python API<2>-Footnote-22427349
Ref: Changes in the Python API<2>-Footnote-23427393
Ref: Changes in the Python API<2>-Footnote-24427437
Ref: Changes in the Python API<2>-Footnote-25427481
Ref: Changes in the Python API<2>-Footnote-26427525
Ref: Changes in the Python API<2>-Footnote-27427569
Ref: Changes in the Python API<2>-Footnote-28427613
Ref: Changes in the Python API<2>-Footnote-29427657
Ref: Changes in the Python API<2>-Footnote-30427701
Node: Changes in the C API<2>427745
Ref: whatsnew/3 7 changes-in-the-c-api427899
Ref: 4a1427899
Ref: Changes in the C API<2>-Footnote-1428535
Node: CPython bytecode changes<2>428578
Ref: whatsnew/3 7 cpython-bytecode-changes428727
Ref: 4a2428727
Ref: CPython bytecode changes<2>-Footnote-1429079
Ref: CPython bytecode changes<2>-Footnote-2429122
Node: Windows-only Changes<2>429165
Ref: whatsnew/3 7 id12429327
Ref: 4a5429327
Ref: Windows-only Changes<2>-Footnote-1429648
Node: Other CPython implementation changes429691
Ref: whatsnew/3 7 id13429817
Ref: 4a7429817
Ref: Other CPython implementation changes-Footnote-1432165
Ref: Other CPython implementation changes-Footnote-2432214
Ref: Other CPython implementation changes-Footnote-3432257
Node: Notable changes in Python 3 7 1432300
Ref: whatsnew/3 7 notable-changes-in-python-3-7-1432464
Ref: 4ac432464
Ref: Notable changes in Python 3 7 1-Footnote-1433404
Ref: Notable changes in Python 3 7 1-Footnote-2433447
Ref: Notable changes in Python 3 7 1-Footnote-3433490
Node: Notable changes in Python 3 7 2433533
Ref: whatsnew/3 7 notable-changes-in-python-3-7-2433707
Ref: 4b1433707
Node: Notable changes in Python 3 7 6434202
Ref: whatsnew/3 7 notable-changes-in-python-3-7-6434336
Ref: 4b2434336
Ref: Notable changes in Python 3 7 6-Footnote-1434847
Node: What’s New In Python 3 6434890
Ref: whatsnew/3 6 doc435045
Ref: 4b3435045
Ref: whatsnew/3 6 what-s-new-in-python-3-6435045
Ref: 4b4435045
Ref: What’s New In Python 3 6-Footnote-1436238
Ref: What’s New In Python 3 6-Footnote-2436298
Node: Summary – Release highlights<2>436347
Ref: whatsnew/3 6 summary-release-highlights436467
Ref: 4b5436467
Ref: Summary – Release highlights<2>-Footnote-1440708
Ref: Summary – Release highlights<2>-Footnote-2440788
Ref: Summary – Release highlights<2>-Footnote-3440878
Node: New Features<3>440927
Ref: whatsnew/3 6 new-features441081
Ref: 4cc441081
Ref: whatsnew/3 6 pypy-dict-implementation441081
Ref: 4cd441081
Node: PEP 498 Formatted string literals442491
Ref: whatsnew/3 6 pep-498-formatted-string-literals442624
Ref: 4ce442624
Ref: whatsnew/3 6 whatsnew36-pep498442624
Ref: 4b6442624
Ref: PEP 498 Formatted string literals-Footnote-1443608
Ref: PEP 498 Formatted string literals-Footnote-2443657
Node: PEP 526 Syntax for variable annotations443706
Ref: whatsnew/3 6 pep-526-syntax-for-variable-annotations443887
Ref: 4d1443887
Ref: whatsnew/3 6 whatsnew36-pep526443887
Ref: 4b8443887
Ref: PEP 526 Syntax for variable annotations-Footnote-1445131
Ref: PEP 526 Syntax for variable annotations-Footnote-2445180
Ref: PEP 526 Syntax for variable annotations-Footnote-3445229
Ref: PEP 526 Syntax for variable annotations-Footnote-4445263
Node: PEP 515 Underscores in Numeric Literals445304
Ref: whatsnew/3 6 pep-515-underscores-in-numeric-literals445483
Ref: 4d2445483
Ref: whatsnew/3 6 whatsnew36-pep515445483
Ref: 4b7445483
Ref: PEP 515 Underscores in Numeric Literals-Footnote-1446552
Ref: PEP 515 Underscores in Numeric Literals-Footnote-2446601
Node: PEP 525 Asynchronous Generators446650
Ref: whatsnew/3 6 pep-525-asynchronous-generators446825
Ref: 4d4446825
Ref: whatsnew/3 6 whatsnew36-pep525446825
Ref: 4b9446825
Ref: PEP 525 Asynchronous Generators-Footnote-1447660
Ref: PEP 525 Asynchronous Generators-Footnote-2447709
Node: PEP 530 Asynchronous Comprehensions447758
Ref: whatsnew/3 6 pep-530-asynchronous-comprehensions447941
Ref: 4d5447941
Ref: whatsnew/3 6 whatsnew36-pep530447941
Ref: 4ba447941
Ref: PEP 530 Asynchronous Comprehensions-Footnote-1448499
Ref: PEP 530 Asynchronous Comprehensions-Footnote-2448548
Node: PEP 487 Simpler customization of class creation448597
Ref: whatsnew/3 6 pep-487-simpler-customization-of-class-creation448789
Ref: 4d6448789
Ref: whatsnew/3 6 whatsnew36-pep487448789
Ref: 4bd448789
Ref: PEP 487 Simpler customization of class creation-Footnote-1449881
Node: PEP 487 Descriptor Protocol Enhancements449930
Ref: whatsnew/3 6 pep-487-descriptor-protocol-enhancements450129
Ref: 4db450129
Ref: whatsnew/3 6 whatsnew36-pep487-descriptors450129
Ref: 4dc450129
Ref: PEP 487 Descriptor Protocol Enhancements-Footnote-1451380
Ref: PEP 487 Descriptor Protocol Enhancements-Footnote-2451429
Node: PEP 519 Adding a file system path protocol451478
Ref: whatsnew/3 6 pep-519-adding-a-file-system-path-protocol451663
Ref: 4df451663
Ref: whatsnew/3 6 whatsnew36-pep519451663
Ref: 4c2451663
Ref: PEP 519 Adding a file system path protocol-Footnote-1454490
Node: PEP 495 Local Time Disambiguation454539
Ref: whatsnew/3 6 pep-495-local-time-disambiguation454735
Ref: 4e7454735
Ref: whatsnew/3 6 whatsnew36-pep495454735
Ref: 4c3454735
Ref: PEP 495 Local Time Disambiguation-Footnote-1456148
Ref: PEP 495 Local Time Disambiguation-Footnote-2456197
Node: PEP 529 Change Windows filesystem encoding to UTF-8456246
Ref: whatsnew/3 6 pep-529-change-windows-filesystem-encoding-to-utf-8456448
Ref: 4ea456448
Ref: whatsnew/3 6 whatsnew36-pep529456448
Ref: 4c9456448
Ref: PEP 529 Change Windows filesystem encoding to UTF-8-Footnote-1457478
Node: PEP 528 Change Windows console encoding to UTF-8457527
Ref: whatsnew/3 6 pep-528-change-windows-console-encoding-to-utf-8457747
Ref: 4ee457747
Ref: whatsnew/3 6 whatsnew36-pep528457747
Ref: 4c8457747
Ref: PEP 528 Change Windows console encoding to UTF-8-Footnote-1458450
Node: PEP 520 Preserving Class Attribute Definition Order458499
Ref: whatsnew/3 6 pep-520-preserving-class-attribute-definition-order458709
Ref: 4f0458709
Ref: whatsnew/3 6 whatsnew36-pep520458709
Ref: 4be458709
Ref: PEP 520 Preserving Class Attribute Definition Order-Footnote-1459349
Node: PEP 468 Preserving Keyword Argument Order459398
Ref: whatsnew/3 6 pep-468-preserving-keyword-argument-order459583
Ref: 4f3459583
Ref: whatsnew/3 6 whatsnew36-pep468459583
Ref: 4bf459583
Ref: PEP 468 Preserving Keyword Argument Order-Footnote-1459944
Node: New dict implementation459993
Ref: whatsnew/3 6 new-dict-implementation460175
Ref: 4f4460175
Ref: whatsnew/3 6 whatsnew36-compactdict460175
Ref: 4bc460175
Ref: New dict implementation-Footnote-1461153
Ref: New dict implementation-Footnote-2461233
Ref: New dict implementation-Footnote-3461323
Ref: New dict implementation-Footnote-4461366
Node: PEP 523 Adding a frame evaluation API to CPython461446
Ref: whatsnew/3 6 pep-523-adding-a-frame-evaluation-api-to-cpython461620
Ref: 4f5461620
Ref: whatsnew/3 6 whatsnew36-pep523461620
Ref: 4f6461620
Ref: PEP 523 Adding a frame evaluation API to CPython-Footnote-1462791
Ref: PEP 523 Adding a frame evaluation API to CPython-Footnote-2462840
Node: PYTHONMALLOC environment variable462889
Ref: whatsnew/3 6 pythonmalloc-environment-variable463076
Ref: 4f7463076
Ref: whatsnew/3 6 whatsnew36-pythonmalloc463076
Ref: 4c1463076
Ref: PYTHONMALLOC environment variable-Footnote-1466259
Ref: PYTHONMALLOC environment variable-Footnote-2466302
Node: DTrace and SystemTap probing support466345
Ref: whatsnew/3 6 dtrace-and-systemtap-probing-support466475
Ref: 500466475
Ref: whatsnew/3 6 whatsnew36-tracing466475
Ref: 4c0466475
Ref: DTrace and SystemTap probing support-Footnote-1467306
Node: Other Language Changes<3>467349
Ref: whatsnew/3 6 other-language-changes467484
Ref: 502467484
Ref: Other Language Changes<3>-Footnote-1468869
Ref: Other Language Changes<3>-Footnote-2468912
Ref: Other Language Changes<3>-Footnote-3468955
Ref: Other Language Changes<3>-Footnote-4468998
Node: New Modules<3>469041
Ref: whatsnew/3 6 new-modules469180
Ref: 506469180
Node: secrets469239
Ref: whatsnew/3 6 secrets469297
Ref: 507469297
Ref: whatsnew/3 6 whatsnew36-pep506469297
Ref: 4bb469297
Ref: secrets-Footnote-1469980
Node: Improved Modules<3>470029
Ref: whatsnew/3 6 improved-modules470159
Ref: 508470159
Node: array471540
Ref: whatsnew/3 6 array471616
Ref: 509471616
Ref: array-Footnote-1471909
Node: ast<2>471952
Ref: whatsnew/3 6 ast472047
Ref: 50a472047
Ref: ast<2>-Footnote-1472290
Node: asyncio<4>472333
Ref: whatsnew/3 6 asyncio472434
Ref: 50b472434
Ref: asyncio<4>-Footnote-1475774
Ref: asyncio<4>-Footnote-2475817
Ref: asyncio<4>-Footnote-3475862
Ref: asyncio<4>-Footnote-4475905
Ref: asyncio<4>-Footnote-5475948
Ref: asyncio<4>-Footnote-6475991
Ref: asyncio<4>-Footnote-7476034
Ref: asyncio<4>-Footnote-8476077
Ref: asyncio<4>-Footnote-9476120
Ref: asyncio<4>-Footnote-10476163
Ref: asyncio<4>-Footnote-11476207
Ref: asyncio<4>-Footnote-12476251
Node: binascii<2>476295
Ref: whatsnew/3 6 binascii476395
Ref: 517476395
Ref: binascii<2>-Footnote-1476680
Node: cmath476723
Ref: whatsnew/3 6 cmath476827
Ref: 519476827
Ref: cmath-Footnote-1477298
Ref: cmath-Footnote-2477341
Ref: cmath-Footnote-3477390
Node: collections<4>477433
Ref: whatsnew/3 6 collections477547
Ref: 521477547
Ref: collections<4>-Footnote-1478648
Ref: collections<4>-Footnote-2478691
Ref: collections<4>-Footnote-3478734
Ref: collections<4>-Footnote-4478777
Ref: collections<4>-Footnote-5478820
Ref: collections<4>-Footnote-6478863
Node: concurrent futures<2>478906
Ref: whatsnew/3 6 concurrent-futures479028
Ref: 527479028
Ref: concurrent futures<2>-Footnote-1479358
Node: contextlib<2>479401
Ref: whatsnew/3 6 contextlib479520
Ref: 528479520
Ref: contextlib<2>-Footnote-1480016
Node: datetime<3>480059
Ref: whatsnew/3 6 datetime480167
Ref: 52b480167
Ref: datetime<3>-Footnote-1481184
Ref: datetime<3>-Footnote-2481227
Ref: datetime<3>-Footnote-3481270
Ref: datetime<3>-Footnote-4481313
Node: decimal<2>481356
Ref: whatsnew/3 6 decimal481463
Ref: 52f481463
Ref: decimal<2>-Footnote-1481876
Node: distutils<2>481919
Ref: whatsnew/3 6 distutils482020
Ref: 531482020
Ref: distutils<2>-Footnote-1482394
Node: email482437
Ref: whatsnew/3 6 email482537
Ref: 532482537
Ref: email-Footnote-1483453
Ref: email-Footnote-2483496
Ref: email-Footnote-3483539
Node: encodings483582
Ref: whatsnew/3 6 encodings483677
Ref: 538483677
Ref: encodings-Footnote-1483972
Node: enum<3>484015
Ref: whatsnew/3 6 enum484117
Ref: 539484117
Ref: enum<3>-Footnote-1484865
Node: faulthandler484908
Ref: whatsnew/3 6 faulthandler485010
Ref: 53c485010
Ref: faulthandler-Footnote-1485273
Node: fileinput485316
Ref: whatsnew/3 6 fileinput485418
Ref: 53e485418
Ref: fileinput-Footnote-1485606
Node: hashlib485649
Ref: whatsnew/3 6 hashlib485753
Ref: 540485753
Ref: hashlib-Footnote-1486771
Ref: hashlib-Footnote-2486814
Ref: hashlib-Footnote-3486857
Ref: hashlib-Footnote-4486900
Node: http client<2>486943
Ref: whatsnew/3 6 http-client487057
Ref: 543487057
Ref: http client<2>-Footnote-1487317
Node: idlelib and IDLE<2>487360
Ref: whatsnew/3 6 idlelib-and-idle487479
Ref: 546487479
Ref: idlelib and IDLE<2>-Footnote-1490953
Ref: idlelib and IDLE<2>-Footnote-2490996
Ref: idlelib and IDLE<2>-Footnote-3491039
Ref: idlelib and IDLE<2>-Footnote-4491084
Ref: idlelib and IDLE<2>-Footnote-5491127
Ref: idlelib and IDLE<2>-Footnote-6491170
Ref: idlelib and IDLE<2>-Footnote-7491213
Ref: idlelib and IDLE<2>-Footnote-8491256
Ref: idlelib and IDLE<2>-Footnote-9491299
Ref: idlelib and IDLE<2>-Footnote-10491342
Ref: idlelib and IDLE<2>-Footnote-11491386
Node: importlib<3>491432
Ref: whatsnew/3 6 importlib491547
Ref: 547491547
Ref: importlib<3>-Footnote-1492374
Node: inspect<2>492417
Ref: whatsnew/3 6 inspect492517
Ref: 54f492517
Ref: inspect<2>-Footnote-1493298
Ref: inspect<2>-Footnote-2493341
Node: json493384
Ref: whatsnew/3 6 json493482
Ref: 553493482
Ref: json-Footnote-1493754
Node: logging<3>493797
Ref: whatsnew/3 6 logging493892
Ref: 556493892
Ref: logging<3>-Footnote-1494156
Node: math<3>494199
Ref: whatsnew/3 6 math494308
Ref: 558494308
Ref: math<3>-Footnote-1494540
Ref: math<3>-Footnote-2494583
Node: multiprocessing<3>494632
Ref: whatsnew/3 6 multiprocessing494736
Ref: 559494736
Ref: multiprocessing<3>-Footnote-1494959
Node: os<3>495001
Ref: whatsnew/3 6 os495108
Ref: 55b495108
Ref: os<3>-Footnote-1496108
Ref: os<3>-Footnote-2496151
Ref: os<3>-Footnote-3496200
Node: pathlib<3>496249
Ref: whatsnew/3 6 pathlib496344
Ref: 55f496344
Ref: pathlib<3>-Footnote-1496578
Node: pdb<2>496621
Ref: whatsnew/3 6 pdb496720
Ref: 560496720
Node: pickle<2>496877
Ref: whatsnew/3 6 pickle496977
Ref: 562496977
Ref: pickle<2>-Footnote-1497294
Node: pickletools497337
Ref: whatsnew/3 6 pickletools497439
Ref: 564497439
Ref: pickletools-Footnote-1497667
Node: pydoc<2>497710
Ref: whatsnew/3 6 pydoc497809
Ref: 566497809
Ref: pydoc<2>-Footnote-1498203
Ref: pydoc<2>-Footnote-2498245
Node: random498288
Ref: whatsnew/3 6 random498381
Ref: 568498381
Ref: random-Footnote-1498636
Node: re<2>498679
Ref: whatsnew/3 6 re498772
Ref: 56a498772
Ref: re<2>-Footnote-1499477
Ref: re<2>-Footnote-2499521
Ref: re<2>-Footnote-3499564
Node: readline499607
Ref: whatsnew/3 6 readline499705
Ref: 56b499705
Ref: readline-Footnote-1499936
Node: rlcompleter499979
Ref: whatsnew/3 6 rlcompleter500080
Ref: 56d500080
Ref: rlcompleter-Footnote-1500384
Ref: rlcompleter-Footnote-2500427
Node: shlex<2>500470
Ref: whatsnew/3 6 shlex500567
Ref: 56e500567
Ref: shlex<2>-Footnote-1500857
Node: site500902
Ref: whatsnew/3 6 site500998
Ref: 571500998
Ref: site-Footnote-1501262
Node: sqlite3<2>501305
Ref: whatsnew/3 6 sqlite3501402
Ref: 572501402
Ref: sqlite3<2>-Footnote-1501605
Node: socket<4>501648
Ref: whatsnew/3 6 socket501756
Ref: 574501756
Ref: socket<4>-Footnote-1502718
Ref: socket<4>-Footnote-2502761
Ref: socket<4>-Footnote-3502804
Ref: socket<4>-Footnote-4502847
Node: socketserver<2>502890
Ref: whatsnew/3 6 socketserver502994
Ref: 57b502994
Ref: socketserver<2>-Footnote-1503623
Ref: socketserver<2>-Footnote-2503666
Node: ssl<4>503709
Ref: whatsnew/3 6 ssl503817
Ref: 57f503817
Ref: ssl<4>-Footnote-1505013
Ref: ssl<4>-Footnote-2505056
Ref: ssl<4>-Footnote-3505099
Ref: ssl<4>-Footnote-4505142
Ref: ssl<4>-Footnote-5505185
Ref: ssl<4>-Footnote-6505228
Ref: ssl<4>-Footnote-7505271
Node: statistics<2>505314
Ref: whatsnew/3 6 statistics505413
Ref: 583505413
Ref: statistics<2>-Footnote-1505603
Node: struct505646
Ref: whatsnew/3 6 struct505752
Ref: 585505752
Ref: struct-Footnote-1505983
Node: subprocess<2>506026
Ref: whatsnew/3 6 subprocess506125
Ref: 586506125
Ref: subprocess<2>-Footnote-1506818
Ref: subprocess<2>-Footnote-2506861
Node: sys<4>506903
Ref: whatsnew/3 6 sys507005
Ref: 588507005
Ref: sys<4>-Footnote-1507606
Ref: sys<4>-Footnote-2507649
Node: telnetlib507692
Ref: whatsnew/3 6 telnetlib507788
Ref: 58b507788
Ref: telnetlib-Footnote-1507959
Node: time<3>508002
Ref: whatsnew/3 6 time508098
Ref: 58d508098
Node: timeit508237
Ref: whatsnew/3 6 timeit508334
Ref: 58f508334
Ref: timeit-Footnote-1508794
Ref: timeit-Footnote-2508836
Node: tkinter<3>508879
Ref: whatsnew/3 6 tkinter508978
Ref: 592508978
Ref: tkinter<3>-Footnote-1509404
Node: traceback509447
Ref: whatsnew/3 6 traceback509554
Ref: 593509554
Ref: whatsnew/3 6 whatsnew36-traceback509554
Ref: 505509554
Ref: traceback-Footnote-1510189
Node: tracemalloc<2>510232
Ref: whatsnew/3 6 tracemalloc510338
Ref: 594510338
Ref: tracemalloc<2>-Footnote-1510699
Node: typing<2>510742
Ref: whatsnew/3 6 typing510853
Ref: 596510853
Ref: whatsnew/3 6 whatsnew36-typing510853
Ref: 4c4510853
Ref: typing<2>-Footnote-1512505
Ref: typing<2>-Footnote-2512555
Ref: typing<2>-Footnote-3512598
Ref: typing<2>-Footnote-4512641
Ref: typing<2>-Footnote-5512690
Ref: typing<2>-Footnote-6512740
Ref: typing<2>-Footnote-7512792
Node: unicodedata<3>512844
Ref: whatsnew/3 6 unicodedata512957
Ref: 59b512957
Ref: unicodedata<3>-Footnote-1513145
Node: unittest mock<2>513195
Ref: whatsnew/3 6 unittest-mock513313
Ref: 59c513313
Ref: unittest mock<2>-Footnote-1513830
Ref: unittest mock<2>-Footnote-2513873
Node: urllib request513916
Ref: whatsnew/3 6 urllib-request514038
Ref: 5a0514038
Ref: urllib request-Footnote-1514403
Node: urllib robotparser514446
Ref: whatsnew/3 6 urllib-robotparser514559
Ref: 5a1514559
Ref: urllib robotparser-Footnote-1514804
Node: venv<2>514847
Ref: whatsnew/3 6 venv514957
Ref: 5a3514957
Ref: venv<2>-Footnote-1515244
Node: warnings<2>515287
Ref: whatsnew/3 6 warnings515385
Ref: 5a4515385
Ref: warnings<2>-Footnote-1516660
Ref: warnings<2>-Footnote-2516703
Node: winreg516746
Ref: whatsnew/3 6 winreg516845
Ref: 5a6516845
Ref: winreg-Footnote-1517018
Node: winsound517061
Ref: whatsnew/3 6 winsound517162
Ref: 5a8517162
Ref: winsound-Footnote-1517361
Node: xmlrpc client517404
Ref: whatsnew/3 6 xmlrpc-client517509
Ref: 5ac517509
Ref: xmlrpc client-Footnote-1517802
Node: zipfile<2>517845
Ref: whatsnew/3 6 zipfile517946
Ref: 5ad517946
Ref: zipfile<2>-Footnote-1518480
Ref: zipfile<2>-Footnote-2518523
Node: zlib518566
Ref: whatsnew/3 6 zlib518645
Ref: 5b2518645
Ref: zlib-Footnote-1518901
Ref: zlib-Footnote-2518944
Node: Optimizations<3>518987
Ref: whatsnew/3 6 optimizations519129
Ref: 5b5519129
Ref: Optimizations<3>-Footnote-1522998
Ref: Optimizations<3>-Footnote-2523041
Ref: Optimizations<3>-Footnote-3523084
Ref: Optimizations<3>-Footnote-4523127
Ref: Optimizations<3>-Footnote-5523170
Ref: Optimizations<3>-Footnote-6523213
Ref: Optimizations<3>-Footnote-7523256
Ref: Optimizations<3>-Footnote-8523299
Ref: Optimizations<3>-Footnote-9523342
Ref: Optimizations<3>-Footnote-10523385
Ref: Optimizations<3>-Footnote-11523429
Ref: Optimizations<3>-Footnote-12523473
Ref: Optimizations<3>-Footnote-13523517
Ref: Optimizations<3>-Footnote-14523561
Ref: Optimizations<3>-Footnote-15523605
Ref: Optimizations<3>-Footnote-16523649
Ref: Optimizations<3>-Footnote-17523693
Ref: Optimizations<3>-Footnote-18523737
Ref: Optimizations<3>-Footnote-19523781
Ref: Optimizations<3>-Footnote-20523825
Ref: Optimizations<3>-Footnote-21523869
Node: Build and C API Changes<2>523913
Ref: whatsnew/3 6 build-and-c-api-changes524054
Ref: 5bd524054
Ref: Build and C API Changes<2>-Footnote-1526507
Ref: Build and C API Changes<2>-Footnote-2526556
Ref: Build and C API Changes<2>-Footnote-3526599
Ref: Build and C API Changes<2>-Footnote-4526642
Ref: Build and C API Changes<2>-Footnote-5526685
Ref: Build and C API Changes<2>-Footnote-6526727
Ref: Build and C API Changes<2>-Footnote-7526770
Ref: Build and C API Changes<2>-Footnote-8526813
Ref: Build and C API Changes<2>-Footnote-9526856
Ref: Build and C API Changes<2>-Footnote-10526899
Node: Other Improvements526943
Ref: whatsnew/3 6 other-improvements527081
Ref: 5c5527081
Node: Deprecated<2>527452
Ref: whatsnew/3 6 deprecated527571
Ref: 5c9527571
Node: New Keywords527892
Ref: whatsnew/3 6 new-keywords527989
Ref: 5ca527989
Ref: New Keywords-Footnote-1528382
Node: Deprecated Python behavior528431
Ref: whatsnew/3 6 deprecated-python-behavior528587
Ref: 5cb528587
Ref: Deprecated Python behavior-Footnote-1529794
Ref: Deprecated Python behavior-Footnote-2529837
Ref: Deprecated Python behavior-Footnote-3529880
Node: Deprecated Python modules functions and methods<2>529923
Ref: whatsnew/3 6 deprecated-python-modules-functions-and-methods530113
Ref: 5ce530113
Node: asynchat530422
Ref: whatsnew/3 6 asynchat530534
Ref: 5cf530534
Ref: asynchat-Footnote-1530722
Node: asyncore530765
Ref: whatsnew/3 6 asyncore530892
Ref: 5d0530892
Ref: asyncore-Footnote-1531080
Node: dbm<3>531123
Ref: whatsnew/3 6 dbm531254
Ref: 5d1531254
Ref: dbm<3>-Footnote-1531614
Node: distutils<3>531657
Ref: whatsnew/3 6 id2531783
Ref: 5d2531783
Ref: distutils<3>-Footnote-1532103
Node: grp532146
Ref: whatsnew/3 6 grp532278
Ref: 5d3532278
Ref: grp-Footnote-1532476
Node: importlib<4>532519
Ref: whatsnew/3 6 id3532644
Ref: 5d5532644
Node: os<4>533298
Ref: whatsnew/3 6 id4533425
Ref: 5dc533425
Ref: os<4>-Footnote-1533719
Ref: os<4>-Footnote-2533762
Node: re<3>533805
Ref: whatsnew/3 6 id5533926
Ref: 5de533926
Ref: re<3>-Footnote-1534252
Node: ssl<5>534295
Ref: whatsnew/3 6 id6534421
Ref: 5df534421
Ref: ssl<5>-Footnote-1535216
Ref: ssl<5>-Footnote-2535259
Ref: ssl<5>-Footnote-3535302
Node: tkinter<4>535345
Ref: whatsnew/3 6 id7535473
Ref: 5e0535473
Node: venv<3>535634
Ref: whatsnew/3 6 id8535747
Ref: 5e1535747
Ref: venv<3>-Footnote-1536098
Node: Deprecated functions and types of the C API<2>536141
Ref: whatsnew/3 6 deprecated-functions-and-types-of-the-c-api536329
Ref: 5e2536329
Node: Deprecated Build Options536678
Ref: whatsnew/3 6 deprecated-build-options536807
Ref: 5e4536807
Node: Removed537248
Ref: whatsnew/3 6 removed537370
Ref: 5e5537370
Node: API and Feature Removals<3>537468
Ref: whatsnew/3 6 api-and-feature-removals537539
Ref: 5e6537539
Ref: API and Feature Removals<3>-Footnote-1539631
Ref: API and Feature Removals<3>-Footnote-2539674
Node: Porting to Python 3 6539747
Ref: whatsnew/3 6 porting-to-python-3-6539887
Ref: 5ea539887
Node: Changes in ‘python’ Command Behavior540273
Ref: whatsnew/3 6 changes-in-python-command-behavior540408
Ref: 5eb540408
Ref: Changes in ‘python’ Command Behavior-Footnote-1540888
Node: Changes in the Python API<3>540931
Ref: whatsnew/3 6 changes-in-the-python-api541098
Ref: 5ec541098
Ref: Changes in the Python API<3>-Footnote-1551221
Ref: Changes in the Python API<3>-Footnote-2551263
Ref: Changes in the Python API<3>-Footnote-3551312
Ref: Changes in the Python API<3>-Footnote-4551355
Ref: Changes in the Python API<3>-Footnote-5551398
Ref: Changes in the Python API<3>-Footnote-6551441
Ref: Changes in the Python API<3>-Footnote-7551484
Ref: Changes in the Python API<3>-Footnote-8551527
Ref: Changes in the Python API<3>-Footnote-9551570
Ref: Changes in the Python API<3>-Footnote-10551613
Ref: Changes in the Python API<3>-Footnote-11551657
Ref: Changes in the Python API<3>-Footnote-12551707
Ref: Changes in the Python API<3>-Footnote-13551751
Ref: Changes in the Python API<3>-Footnote-14551795
Ref: Changes in the Python API<3>-Footnote-15551839
Ref: Changes in the Python API<3>-Footnote-16551883
Ref: Changes in the Python API<3>-Footnote-17551926
Ref: Changes in the Python API<3>-Footnote-18551970
Ref: Changes in the Python API<3>-Footnote-19552014
Ref: Changes in the Python API<3>-Footnote-20552058
Node: Changes in the C API<3>552102
Ref: whatsnew/3 6 changes-in-the-c-api552256
Ref: 606552256
Ref: Changes in the C API<3>-Footnote-1552910
Ref: Changes in the C API<3>-Footnote-2552953
Node: CPython bytecode changes<3>552995
Ref: whatsnew/3 6 cpython-bytecode-changes553112
Ref: 608553112
Ref: CPython bytecode changes<3>-Footnote-1554768
Ref: CPython bytecode changes<3>-Footnote-2554811
Ref: CPython bytecode changes<3>-Footnote-3554854
Ref: CPython bytecode changes<3>-Footnote-4554897
Ref: CPython bytecode changes<3>-Footnote-5554940
Ref: CPython bytecode changes<3>-Footnote-6554983
Ref: CPython bytecode changes<3>-Footnote-7555026
Ref: CPython bytecode changes<3>-Footnote-8555069
Ref: CPython bytecode changes<3>-Footnote-9555112
Node: Notable changes in Python 3 6 2555155
Ref: whatsnew/3 6 notable-changes-in-python-3-6-2555319
Ref: 615555319
Node: New make regen-all build target555483
Ref: whatsnew/3 6 new-make-regen-all-build-target555625
Ref: 616555625
Ref: New make regen-all build target-Footnote-1556412
Ref: New make regen-all build target-Footnote-2556479
Node: Removal of make touch build target556522
Ref: whatsnew/3 6 removal-of-make-touch-build-target556664
Ref: 617556664
Ref: Removal of make touch build target-Footnote-1557094
Node: Notable changes in Python 3 6 4557137
Ref: whatsnew/3 6 notable-changes-in-python-3-6-4557311
Ref: 618557311
Ref: Notable changes in Python 3 6 4-Footnote-1557684
Ref: Notable changes in Python 3 6 4-Footnote-2557727
Node: Notable changes in Python 3 6 5557770
Ref: whatsnew/3 6 notable-changes-in-python-3-6-5557944
Ref: 619557944
Ref: Notable changes in Python 3 6 5-Footnote-1558247
Node: Notable changes in Python 3 6 7558290
Ref: whatsnew/3 6 notable-changes-in-python-3-6-7558465
Ref: 61a558465
Ref: Notable changes in Python 3 6 7-Footnote-1558842
Node: Notable changes in Python 3 6 10558885
Ref: whatsnew/3 6 notable-changes-in-python-3-6-10559020
Ref: 61b559020
Ref: Notable changes in Python 3 6 10-Footnote-1559533
Node: What’s New In Python 3 5559576
Ref: whatsnew/3 5 doc559731
Ref: 61c559731
Ref: whatsnew/3 5 what-s-new-in-python-3-5559731
Ref: 61d559731
Ref: What’s New In Python 3 5-Footnote-1560670
Ref: What’s New In Python 3 5-Footnote-2560730
Node: Summary – Release highlights<3>560779
Ref: whatsnew/3 5 summary-release-highlights560899
Ref: 61e560899
Ref: Summary – Release highlights<3>-Footnote-1564628
Ref: Summary – Release highlights<3>-Footnote-2564670
Ref: Summary – Release highlights<3>-Footnote-3564713
Ref: Summary – Release highlights<3>-Footnote-4564756
Ref: Summary – Release highlights<3>-Footnote-5564799
Ref: Summary – Release highlights<3>-Footnote-6564842
Ref: Summary – Release highlights<3>-Footnote-7564885
Node: New Features<4>564928
Ref: whatsnew/3 5 new-features565082
Ref: 631565082
Node: PEP 492 - Coroutines with async and await syntax566178
Ref: whatsnew/3 5 pep-492-coroutines-with-async-and-await-syntax566349
Ref: 632566349
Ref: whatsnew/3 5 whatsnew-pep-492566349
Ref: 61f566349
Ref: PEP 492 - Coroutines with async and await syntax-Footnote-1569428
Ref: PEP 492 - Coroutines with async and await syntax-Footnote-2569477
Node: PEP 465 - A dedicated infix operator for matrix multiplication569526
Ref: whatsnew/3 5 pep-465-a-dedicated-infix-operator-for-matrix-multiplication569752
Ref: 63b569752
Ref: whatsnew/3 5 whatsnew-pep-465569752
Ref: 620569752
Ref: PEP 465 - A dedicated infix operator for matrix multiplication-Footnote-1571155
Ref: PEP 465 - A dedicated infix operator for matrix multiplication-Footnote-2571204
Node: PEP 448 - Additional Unpacking Generalizations571253
Ref: whatsnew/3 5 pep-448-additional-unpacking-generalizations571491
Ref: 63f571491
Ref: whatsnew/3 5 whatsnew-pep-448571491
Ref: 621571491
Ref: PEP 448 - Additional Unpacking Generalizations-Footnote-1572584
Ref: PEP 448 - Additional Unpacking Generalizations-Footnote-2572633
Node: PEP 461 - percent formatting support for bytes and bytearray572682
Ref: whatsnew/3 5 pep-461-percent-formatting-support-for-bytes-and-bytearray572878
Ref: 643572878
Ref: whatsnew/3 5 whatsnew-pep-461572878
Ref: 624572878
Ref: PEP 461 - percent formatting support for bytes and bytearray-Footnote-1574414
Ref: PEP 461 - percent formatting support for bytes and bytearray-Footnote-2574463
Node: PEP 484 - Type Hints574512
Ref: whatsnew/3 5 pep-484-type-hints574734
Ref: 645574734
Ref: whatsnew/3 5 whatsnew-pep-484574734
Ref: 622574734
Ref: PEP 484 - Type Hints-Footnote-1576381
Ref: PEP 484 - Type Hints-Footnote-2576430
Ref: PEP 484 - Type Hints-Footnote-3576479
Ref: PEP 484 - Type Hints-Footnote-4576508
Ref: PEP 484 - Type Hints-Footnote-5576557
Node: PEP 471 - os scandir function – a better and faster directory iterator576606
Ref: whatsnew/3 5 pep-471-os-scandir-function-a-better-and-faster-directory-iterator576813
Ref: 647576813
Ref: whatsnew/3 5 whatsnew-pep-471576813
Ref: 62d576813
Ref: PEP 471 - os scandir function – a better and faster directory iterator-Footnote-1578169
Ref: PEP 471 - os scandir function – a better and faster directory iterator-Footnote-2578218
Node: PEP 475 Retry system calls failing with EINTR578267
Ref: whatsnew/3 5 pep-475-retry-system-calls-failing-with-eintr578509
Ref: 64a578509
Ref: whatsnew/3 5 whatsnew-pep-475578509
Ref: 64b578509
Ref: PEP 475 Retry system calls failing with EINTR-Footnote-1581573
Ref: PEP 475 Retry system calls failing with EINTR-Footnote-2581622
Node: PEP 479 Change StopIteration handling inside generators581671
Ref: whatsnew/3 5 pep-479-change-stopiteration-handling-inside-generators581892
Ref: 675581892
Ref: whatsnew/3 5 whatsnew-pep-479581892
Ref: 5cc581892
Ref: PEP 479 Change StopIteration handling inside generators-Footnote-1583822
Ref: PEP 479 Change StopIteration handling inside generators-Footnote-2583871
Node: PEP 485 A function for testing approximate equality583920
Ref: whatsnew/3 5 pep-485-a-function-for-testing-approximate-equality584158
Ref: 678584158
Ref: whatsnew/3 5 whatsnew-pep-485584158
Ref: 679584158
Ref: PEP 485 A function for testing approximate equality-Footnote-1585341
Ref: PEP 485 A function for testing approximate equality-Footnote-2585390
Node: PEP 486 Make the Python Launcher aware of virtual environments585439
Ref: whatsnew/3 5 pep-486-make-the-python-launcher-aware-of-virtual-environments585654
Ref: 67c585654
Ref: whatsnew/3 5 whatsnew-pep-486585654
Ref: 67d585654
Ref: PEP 486 Make the Python Launcher aware of virtual environments-Footnote-1586228
Ref: PEP 486 Make the Python Launcher aware of virtual environments-Footnote-2586277
Ref: PEP 486 Make the Python Launcher aware of virtual environments-Footnote-3586326
Node: PEP 488 Elimination of PYO files586375
Ref: whatsnew/3 5 pep-488-elimination-of-pyo-files586590
Ref: 67e586590
Ref: whatsnew/3 5 whatsnew-pep-488586590
Ref: 629586590
Ref: PEP 488 Elimination of PYO files-Footnote-1587456
Ref: PEP 488 Elimination of PYO files-Footnote-2587505
Node: PEP 489 Multi-phase extension module initialization587554
Ref: whatsnew/3 5 pep-489-multi-phase-extension-module-initialization587698
Ref: 681587698
Ref: whatsnew/3 5 whatsnew-pep-489587698
Ref: 62a587698
Ref: PEP 489 Multi-phase extension module initialization-Footnote-1588461
Ref: PEP 489 Multi-phase extension module initialization-Footnote-2588510
Ref: PEP 489 Multi-phase extension module initialization-Footnote-3588559
Node: Other Language Changes<4>588608
Ref: whatsnew/3 5 other-language-changes588743
Ref: 682588743
Ref: Other Language Changes<4>-Footnote-1589741
Ref: Other Language Changes<4>-Footnote-2589784
Ref: Other Language Changes<4>-Footnote-3589827
Ref: Other Language Changes<4>-Footnote-4589870
Ref: Other Language Changes<4>-Footnote-5589913
Ref: Other Language Changes<4>-Footnote-6589956
Ref: Other Language Changes<4>-Footnote-7589999
Node: New Modules<4>590042
Ref: whatsnew/3 5 new-modules590181
Ref: 684590181
Node: typing<3>590270
Ref: whatsnew/3 5 typing590348
Ref: 685590348
Node: zipapp<2>590559
Ref: whatsnew/3 5 whatsnew-zipapp590637
Ref: 623590637
Ref: whatsnew/3 5 zipapp590637
Ref: 686590637
Ref: zipapp<2>-Footnote-1591347
Ref: zipapp<2>-Footnote-2591396
Ref: zipapp<2>-Footnote-3591441
Ref: zipapp<2>-Footnote-4591484
Node: Improved Modules<4>591533
Ref: whatsnew/3 5 improved-modules591673
Ref: 687591673
Node: argparse<2>593237
Ref: whatsnew/3 5 argparse593323
Ref: 688593323
Ref: argparse<2>-Footnote-1593646
Node: asyncio<5>593689
Ref: whatsnew/3 5 asyncio593787
Ref: 68c593787
Ref: asyncio<5>-Footnote-1597265
Ref: asyncio<5>-Footnote-2597308
Ref: asyncio<5>-Footnote-3597351
Node: bz2597396
Ref: whatsnew/3 5 bz2597486
Ref: 696597486
Ref: bz2-Footnote-1597741
Node: cgi597784
Ref: whatsnew/3 5 cgi597872
Ref: 698597872
Ref: cgi-Footnote-1598067
Node: cmath<2>598110
Ref: whatsnew/3 5 cmath598199
Ref: 699598199
Ref: cmath<2>-Footnote-1598413
Node: code598456
Ref: whatsnew/3 5 code598556
Ref: 69a598556
Ref: code-Footnote-1598807
Node: collections<5>598850
Ref: whatsnew/3 5 collections598957
Ref: 69c598957
Ref: whatsnew/3 5 whatsnew-ordereddict598998
Ref: 62b598998
Ref: collections<5>-Footnote-1600277
Ref: collections<5>-Footnote-2600320
Ref: collections<5>-Footnote-3600363
Ref: collections<5>-Footnote-4600406
Ref: collections<5>-Footnote-5600449
Node: collections abc600492
Ref: whatsnew/3 5 collections-abc600608
Ref: 6a8600608
Ref: collections abc-Footnote-1601278
Ref: collections abc-Footnote-2601321
Ref: collections abc-Footnote-3601364
Ref: collections abc-Footnote-4601407
Node: compileall<2>601454
Ref: whatsnew/3 5 compileall601577
Ref: 6ae601577
Ref: compileall<2>-Footnote-1602454
Ref: compileall<2>-Footnote-2602497
Ref: compileall<2>-Footnote-3602540
Node: concurrent futures<3>602583
Ref: whatsnew/3 5 concurrent-futures602703
Ref: 6b1602703
Ref: concurrent futures<3>-Footnote-1603205
Ref: concurrent futures<3>-Footnote-2603248
Node: configparser603291
Ref: whatsnew/3 5 configparser603411
Ref: 6b3603411
Ref: configparser-Footnote-1604362
Node: contextlib<3>604405
Ref: whatsnew/3 5 contextlib604510
Ref: 6b4604510
Ref: contextlib<3>-Footnote-1605120
Node: csv<2>605163
Ref: whatsnew/3 5 csv605265
Ref: 6b7605265
Ref: csv<2>-Footnote-1605469
Node: curses<2>605512
Ref: whatsnew/3 5 curses605607
Ref: 6b9605607
Ref: curses<2>-Footnote-1605888
Node: dbm<4>605930
Ref: whatsnew/3 5 dbm606026
Ref: 6bb606026
Ref: dbm<4>-Footnote-1606229
Node: difflib606272
Ref: whatsnew/3 5 difflib606371
Ref: 6bc606371
Ref: difflib-Footnote-1606907
Ref: difflib-Footnote-2606949
Node: distutils<4>606992
Ref: whatsnew/3 5 distutils607092
Ref: 6bf607092
Ref: distutils<4>-Footnote-1607547
Ref: distutils<4>-Footnote-2607589
Node: doctest607632
Ref: whatsnew/3 5 doctest607733
Ref: 6c0607733
Ref: doctest-Footnote-1608018
Node: email<2>608061
Ref: whatsnew/3 5 email608157
Ref: 6c3608157
Ref: email<2>-Footnote-1609268
Ref: email<2>-Footnote-2609311
Ref: email<2>-Footnote-3609354
Ref: email<2>-Footnote-4609403
Ref: email<2>-Footnote-5609452
Ref: email<2>-Footnote-6609495
Node: enum<4>609538
Ref: whatsnew/3 5 enum609642
Ref: 6c9609642
Ref: enum<4>-Footnote-1610033
Node: faulthandler<2>610076
Ref: whatsnew/3 5 faulthandler610184
Ref: 6ca610184
Ref: faulthandler<2>-Footnote-1610496
Node: functools<3>610539
Ref: whatsnew/3 5 functools610644
Ref: 6ce610644
Ref: whatsnew/3 5 whatsnew-lrucache610683
Ref: 62e610683
Ref: functools<3>-Footnote-1610909
Node: glob610952
Ref: whatsnew/3 5 glob611049
Ref: 6cf611049
Ref: glob-Footnote-1611301
Node: gzip<2>611344
Ref: whatsnew/3 5 gzip611434
Ref: 6d0611434
Ref: gzip<2>-Footnote-1611659
Node: heapq611702
Ref: whatsnew/3 5 heapq611792
Ref: 6d2611792
Ref: heapq-Footnote-1612432
Node: http612475
Ref: whatsnew/3 5 http612572
Ref: 6d5612572
Ref: http-Footnote-1612818
Node: http client<3>612861
Ref: whatsnew/3 5 http-client612972
Ref: 6d7612972
Ref: http client<3>-Footnote-1613716
Node: idlelib and IDLE<3>613758
Ref: whatsnew/3 5 idlelib-and-idle613872
Ref: 6db613872
Node: imaplib614266
Ref: whatsnew/3 5 imaplib614372
Ref: 6dc614372
Ref: imaplib-Footnote-1615251
Ref: imaplib-Footnote-2615293
Ref: imaplib-Footnote-3615342
Ref: imaplib-Footnote-4615391
Ref: imaplib-Footnote-5615440
Ref: imaplib-Footnote-6615483
Node: imghdr615526
Ref: whatsnew/3 5 imghdr615625
Ref: 6e0615625
Ref: imghdr-Footnote-1615919
Ref: imghdr-Footnote-2615950
Ref: imghdr-Footnote-3615993
Ref: imghdr-Footnote-4616036
Node: importlib<5>616079
Ref: whatsnew/3 5 importlib616181
Ref: 6e2616181
Ref: importlib<5>-Footnote-1617016
Ref: importlib<5>-Footnote-2617059
Ref: importlib<5>-Footnote-3617102
Node: inspect<3>617145
Ref: whatsnew/3 5 inspect617246
Ref: 6e6617246
Ref: inspect<3>-Footnote-1618803
Ref: inspect<3>-Footnote-2618846
Ref: inspect<3>-Footnote-3618889
Ref: inspect<3>-Footnote-4618932
Ref: inspect<3>-Footnote-5618975
Ref: inspect<3>-Footnote-6619018
Ref: inspect<3>-Footnote-7619061
Ref: inspect<3>-Footnote-8619104
Node: io<3>619147
Ref: whatsnew/3 5 io619248
Ref: 6f4619248
Ref: io<3>-Footnote-1619546
Node: ipaddress<2>619589
Ref: whatsnew/3 5 ipaddress619687
Ref: 6f8619687
Ref: ipaddress<2>-Footnote-1620715
Ref: ipaddress<2>-Footnote-2620758
Node: json<2>620801
Ref: whatsnew/3 5 json620903
Ref: 6f9620903
Ref: json<2>-Footnote-1621403
Ref: json<2>-Footnote-2621446
Node: linecache621489
Ref: whatsnew/3 5 linecache621588
Ref: 6fb621588
Ref: linecache-Footnote-1621998
Node: locale<3>622041
Ref: whatsnew/3 5 locale622143
Ref: 6fe622143
Ref: locale<3>-Footnote-1622708
Node: logging<4>622751
Ref: whatsnew/3 5 logging622848
Ref: 700622848
Ref: logging<4>-Footnote-1623818
Ref: logging<4>-Footnote-2623861
Node: lzma623904
Ref: whatsnew/3 5 lzma623999
Ref: 707623999
Ref: lzma-Footnote-1624261
Node: math<4>624304
Ref: whatsnew/3 5 math624407
Ref: 709624407
Ref: math<4>-Footnote-1624955
Ref: math<4>-Footnote-2624998
Ref: math<4>-Footnote-3625041
Node: multiprocessing<4>625084
Ref: whatsnew/3 5 multiprocessing625191
Ref: 70c625191
Ref: multiprocessing<4>-Footnote-1625441
Node: operator625484
Ref: whatsnew/3 5 operator625589
Ref: 70e625589
Ref: operator-Footnote-1625994
Ref: operator-Footnote-2626037
Node: os<5>626080
Ref: whatsnew/3 5 os626177
Ref: 713626177
Ref: os<5>-Footnote-1628025
Ref: os<5>-Footnote-2628068
Ref: os<5>-Footnote-3628111
Ref: os<5>-Footnote-4628154
Ref: os<5>-Footnote-5628197
Ref: os<5>-Footnote-6628240
Node: pathlib<4>628283
Ref: whatsnew/3 5 pathlib628381
Ref: 71b628381
Ref: pathlib<4>-Footnote-1629852
Ref: pathlib<4>-Footnote-2629895
Ref: pathlib<4>-Footnote-3629938
Ref: pathlib<4>-Footnote-4629981
Ref: pathlib<4>-Footnote-5630024
Node: pickle<3>630067
Ref: whatsnew/3 5 pickle630166
Ref: 724630166
Ref: pickle<3>-Footnote-1630482
Node: poplib630525
Ref: whatsnew/3 5 poplib630619
Ref: 725630619
Ref: poplib-Footnote-1630861
Ref: poplib-Footnote-2630910
Node: re<4>630953
Ref: whatsnew/3 5 re631049
Ref: 727631049
Ref: re<4>-Footnote-1632285
Ref: re<4>-Footnote-2632327
Ref: re<4>-Footnote-3632370
Ref: re<4>-Footnote-4632415
Node: readline<2>632458
Ref: whatsnew/3 5 readline632557
Ref: 72f632557
Ref: readline<2>-Footnote-1632820
Node: selectors632863
Ref: whatsnew/3 5 selectors632966
Ref: 731632966
Ref: selectors-Footnote-1633188
Node: shutil<2>633231
Ref: whatsnew/3 5 shutil633332
Ref: 732633332
Ref: shutil<2>-Footnote-1633811
Ref: shutil<2>-Footnote-2633854
Node: signal<2>633896
Ref: whatsnew/3 5 signal633993
Ref: 733633993
Ref: signal<2>-Footnote-1634460
Ref: signal<2>-Footnote-2634503
Node: smtpd634546
Ref: whatsnew/3 5 smtpd634641
Ref: 734634641
Ref: smtpd-Footnote-1636325
Ref: smtpd-Footnote-2636368
Ref: smtpd-Footnote-3636417
Ref: smtpd-Footnote-4636460
Ref: smtpd-Footnote-5636509
Ref: smtpd-Footnote-6636552
Node: smtplib636595
Ref: whatsnew/3 5 smtplib636687
Ref: 735636687
Ref: smtplib-Footnote-1637308
Ref: smtplib-Footnote-2637351
Ref: smtplib-Footnote-3637394
Ref: smtplib-Footnote-4637443
Node: sndhdr637486
Ref: whatsnew/3 5 sndhdr637582
Ref: 73a637582
Ref: sndhdr-Footnote-1637797
Node: socket<5>637840
Ref: whatsnew/3 5 socket637935
Ref: 73d637935
Ref: socket<5>-Footnote-1638906
Ref: socket<5>-Footnote-2638949
Ref: socket<5>-Footnote-3638992
Ref: socket<5>-Footnote-4639035
Node: ssl<6>639078
Ref: whatsnew/3 5 ssl639177
Ref: 741639177
Node: Memory BIO Support639306
Ref: whatsnew/3 5 memory-bio-support639422
Ref: 742639422
Ref: whatsnew/3 5 whatsnew-sslmemorybio639422
Ref: 62c639422
Ref: Memory BIO Support-Footnote-1640305
Node: Application-Layer Protocol Negotiation Support640348
Ref: whatsnew/3 5 application-layer-protocol-negotiation-support640486
Ref: 744640486
Ref: Application-Layer Protocol Negotiation Support-Footnote-1641191
Ref: Application-Layer Protocol Negotiation Support-Footnote-2641234
Node: Other Changes641283
Ref: whatsnew/3 5 other-changes641394
Ref: 748641394
Ref: Other Changes-Footnote-1642987
Ref: Other Changes-Footnote-2643030
Ref: Other Changes-Footnote-3643073
Ref: Other Changes-Footnote-4643116
Ref: Other Changes-Footnote-5643165
Ref: Other Changes-Footnote-6643208
Ref: Other Changes-Footnote-7643251
Ref: Other Changes-Footnote-8643294
Node: sqlite3<3>643337
Ref: whatsnew/3 5 sqlite3643440
Ref: 751643440
Ref: sqlite3<3>-Footnote-1643769
Ref: sqlite3<3>-Footnote-2643812
Node: subprocess<3>643855
Ref: whatsnew/3 5 subprocess643958
Ref: 753643958
Ref: whatsnew/3 5 whatsnew-subprocess643958
Ref: 62f643958
Ref: subprocess<3>-Footnote-1644972
Node: sys<5>645015
Ref: whatsnew/3 5 sys645117
Ref: 755645117
Ref: sys<5>-Footnote-1645767
Ref: sys<5>-Footnote-2645810
Node: sysconfig645853
Ref: whatsnew/3 5 sysconfig645952
Ref: 758645952
Ref: sysconfig-Footnote-1646185
Node: tarfile<2>646228
Ref: whatsnew/3 5 tarfile646333
Ref: 759646333
Ref: tarfile<2>-Footnote-1647244
Ref: tarfile<2>-Footnote-2647287
Ref: tarfile<2>-Footnote-3647330
Node: threading<3>647373
Ref: whatsnew/3 5 threading647476
Ref: 75f647476
Ref: threading<3>-Footnote-1647728
Node: time<4>647771
Ref: whatsnew/3 5 time647873
Ref: 762647873
Ref: time<4>-Footnote-1648050
Node: timeit<2>648093
Ref: whatsnew/3 5 timeit648193
Ref: 764648193
Ref: timeit<2>-Footnote-1648660
Ref: timeit<2>-Footnote-2648703
Node: tkinter<5>648745
Ref: whatsnew/3 5 tkinter648850
Ref: 766648850
Ref: tkinter<5>-Footnote-1649182
Node: traceback<2>649225
Ref: whatsnew/3 5 traceback649329
Ref: 767649329
Ref: whatsnew/3 5 whatsnew-traceback649329
Ref: 630649329
Ref: traceback<2>-Footnote-1649912
Ref: traceback<2>-Footnote-2649955
Ref: traceback<2>-Footnote-3649998
Node: types<2>650041
Ref: whatsnew/3 5 types650149
Ref: 76f650149
Ref: types<2>-Footnote-1650593
Ref: types<2>-Footnote-2650636
Node: unicodedata<4>650679
Ref: whatsnew/3 5 unicodedata650786
Ref: 772650786
Ref: unicodedata<4>-Footnote-1650938
Node: unittest<3>650988
Ref: whatsnew/3 5 unittest651103
Ref: 773651103
Ref: unittest<3>-Footnote-1651897
Ref: unittest<3>-Footnote-2651940
Ref: unittest<3>-Footnote-3651983
Node: unittest mock<3>652026
Ref: whatsnew/3 5 unittest-mock652133
Ref: 777652133
Ref: unittest mock<3>-Footnote-1653074
Ref: unittest mock<3>-Footnote-2653117
Ref: unittest mock<3>-Footnote-3653160
Ref: unittest mock<3>-Footnote-4653203
Ref: unittest mock<3>-Footnote-5653246
Ref: unittest mock<3>-Footnote-6653289
Node: urllib653332
Ref: whatsnew/3 5 urllib653435
Ref: 77d653435
Ref: urllib-Footnote-1654595
Ref: urllib-Footnote-2654638
Ref: urllib-Footnote-3654680
Ref: urllib-Footnote-4654723
Ref: urllib-Footnote-5654766
Ref: urllib-Footnote-6654815
Ref: urllib-Footnote-7654864
Ref: urllib-Footnote-8654913
Node: wsgiref654956
Ref: whatsnew/3 5 wsgiref655052
Ref: 782655052
Ref: wsgiref-Footnote-1655290
Node: xmlrpc<2>655332
Ref: whatsnew/3 5 xmlrpc655429
Ref: 784655429
Ref: xmlrpc<2>-Footnote-1655799
Ref: xmlrpc<2>-Footnote-2655842
Node: xml sax655885
Ref: whatsnew/3 5 xml-sax655985
Ref: 785655985
Ref: xml sax-Footnote-1656318
Ref: xml sax-Footnote-2656360
Node: zipfile<3>656403
Ref: whatsnew/3 5 zipfile656485
Ref: 788656485
Ref: zipfile<3>-Footnote-1656825
Ref: zipfile<3>-Footnote-2656868
Node: Other module-level changes656911
Ref: whatsnew/3 5 other-module-level-changes657053
Ref: 789657053
Ref: Other module-level changes-Footnote-1657384
Node: Optimizations<4>657427
Ref: whatsnew/3 5 optimizations657576
Ref: 78a657576
Ref: Optimizations<4>-Footnote-1660633
Ref: Optimizations<4>-Footnote-2660676
Ref: Optimizations<4>-Footnote-3660719
Ref: Optimizations<4>-Footnote-4660762
Ref: Optimizations<4>-Footnote-5660805
Ref: Optimizations<4>-Footnote-6660848
Ref: Optimizations<4>-Footnote-7660891
Ref: Optimizations<4>-Footnote-8660934
Ref: Optimizations<4>-Footnote-9660977
Ref: Optimizations<4>-Footnote-10661020
Ref: Optimizations<4>-Footnote-11661064
Ref: Optimizations<4>-Footnote-12661108
Ref: Optimizations<4>-Footnote-13661152
Ref: Optimizations<4>-Footnote-14661196
Ref: Optimizations<4>-Footnote-15661240
Ref: Optimizations<4>-Footnote-16661284
Ref: Optimizations<4>-Footnote-17661328
Ref: Optimizations<4>-Footnote-18661372
Ref: Optimizations<4>-Footnote-19661416
Ref: Optimizations<4>-Footnote-20661460
Node: Build and C API Changes<3>661504
Ref: whatsnew/3 5 build-and-c-api-changes661640
Ref: 798661640
Ref: Build and C API Changes<3>-Footnote-1665190
Ref: Build and C API Changes<3>-Footnote-2665233
Ref: Build and C API Changes<3>-Footnote-3665276
Ref: Build and C API Changes<3>-Footnote-4665319
Ref: Build and C API Changes<3>-Footnote-5665362
Ref: Build and C API Changes<3>-Footnote-6665405
Ref: Build and C API Changes<3>-Footnote-7665454
Ref: Build and C API Changes<3>-Footnote-8665497
Ref: Build and C API Changes<3>-Footnote-9665540
Ref: Build and C API Changes<3>-Footnote-10665589
Node: Deprecated<3>665628
Ref: whatsnew/3 5 deprecated665758
Ref: 7a4665758
Node: New Keywords<2>666035
Ref: whatsnew/3 5 new-keywords666138
Ref: 7a5666138
Ref: New Keywords<2>-Footnote-1666412
Node: Deprecated Python Behavior<2>666461
Ref: whatsnew/3 5 deprecated-python-behavior666602
Ref: 7a6666602
Node: Unsupported Operating Systems667017
Ref: whatsnew/3 5 unsupported-operating-systems667193
Ref: 7a7667193
Ref: Unsupported Operating Systems-Footnote-1667434
Node: Deprecated Python modules functions and methods<3>667483
Ref: whatsnew/3 5 deprecated-python-modules-functions-and-methods667621
Ref: 7a8667621
Ref: Deprecated Python modules functions and methods<3>-Footnote-1670559
Ref: Deprecated Python modules functions and methods<3>-Footnote-2670602
Ref: Deprecated Python modules functions and methods<3>-Footnote-3670644
Ref: Deprecated Python modules functions and methods<3>-Footnote-4670687
Ref: Deprecated Python modules functions and methods<3>-Footnote-5670730
Ref: Deprecated Python modules functions and methods<3>-Footnote-6670773
Ref: Deprecated Python modules functions and methods<3>-Footnote-7670816
Ref: Deprecated Python modules functions and methods<3>-Footnote-8670859
Node: Removed<2>670902
Ref: whatsnew/3 5 removed671027
Ref: 7ae671027
Node: API and Feature Removals<4>671125
Ref: whatsnew/3 5 api-and-feature-removals671199
Ref: 7af671199
Ref: API and Feature Removals<4>-Footnote-1672056
Ref: API and Feature Removals<4>-Footnote-2672098
Node: Porting to Python 3 5672141
Ref: whatsnew/3 5 porting-to-python-3-5672284
Ref: 7b0672284
Node: Changes in Python behavior<2>672629
Ref: whatsnew/3 5 changes-in-python-behavior672753
Ref: 7b1672753
Node: Changes in the Python API<4>673163
Ref: whatsnew/3 5 changes-in-the-python-api673319
Ref: 7b2673319
Ref: Changes in the Python API<4>-Footnote-1680245
Ref: Changes in the Python API<4>-Footnote-2680294
Ref: Changes in the Python API<4>-Footnote-3680337
Ref: Changes in the Python API<4>-Footnote-4680380
Ref: Changes in the Python API<4>-Footnote-5680423
Ref: Changes in the Python API<4>-Footnote-6680466
Ref: Changes in the Python API<4>-Footnote-7680509
Ref: Changes in the Python API<4>-Footnote-8680552
Ref: Changes in the Python API<4>-Footnote-9680595
Ref: Changes in the Python API<4>-Footnote-10680638
Ref: Changes in the Python API<4>-Footnote-11680682
Ref: Changes in the Python API<4>-Footnote-12680726
Ref: Changes in the Python API<4>-Footnote-13680769
Ref: Changes in the Python API<4>-Footnote-14680819
Ref: Changes in the Python API<4>-Footnote-15680869
Ref: Changes in the Python API<4>-Footnote-16680913
Ref: Changes in the Python API<4>-Footnote-17680957
Ref: Changes in the Python API<4>-Footnote-18681001
Node: Changes in the C API<4>681044
Ref: whatsnew/3 5 changes-in-the-c-api681162
Ref: 7bd681162
Ref: Changes in the C API<4>-Footnote-1682434
Ref: Changes in the C API<4>-Footnote-2682477
Ref: Changes in the C API<4>-Footnote-3682520
Node: Notable changes in Python 3 5 4682569
Ref: whatsnew/3 5 notable-changes-in-python-3-5-4682693
Ref: 7c2682693
Node: New make regen-all build target<2>682930
Ref: whatsnew/3 5 new-make-regen-all-build-target683078
Ref: 7c3683078
Ref: New make regen-all build target<2>-Footnote-1683865
Ref: New make regen-all build target<2>-Footnote-2683932
Node: Removal of make touch build target<2>683975
Ref: whatsnew/3 5 removal-of-make-touch-build-target684123
Ref: 7c4684123
Ref: Removal of make touch build target<2>-Footnote-1684553
Node: What’s New In Python 3 4684596
Ref: whatsnew/3 4 doc684751
Ref: 7c5684751
Ref: whatsnew/3 4 what-s-new-in-python-3-4684751
Ref: 7c6684751
Ref: What’s New In Python 3 4-Footnote-1685485
Ref: What’s New In Python 3 4-Footnote-2685545
Node: Summary – Release Highlights<2>685594
Ref: whatsnew/3 4 summary-release-highlights685714
Ref: 7c7685714
Ref: Summary – Release Highlights<2>-Footnote-1690010
Ref: Summary – Release Highlights<2>-Footnote-2690059
Ref: Summary – Release Highlights<2>-Footnote-3690108
Ref: Summary – Release Highlights<2>-Footnote-4690151
Ref: Summary – Release Highlights<2>-Footnote-5690200
Ref: Summary – Release Highlights<2>-Footnote-6690243
Ref: Summary – Release Highlights<2>-Footnote-7690292
Ref: Summary – Release Highlights<2>-Footnote-8690341
Ref: Summary – Release Highlights<2>-Footnote-9690390
Ref: Summary – Release Highlights<2>-Footnote-10690439
Ref: Summary – Release Highlights<2>-Footnote-11690489
Ref: Summary – Release Highlights<2>-Footnote-12690539
Ref: Summary – Release Highlights<2>-Footnote-13690589
Ref: Summary – Release Highlights<2>-Footnote-14690639
Ref: Summary – Release Highlights<2>-Footnote-15690689
Ref: Summary – Release Highlights<2>-Footnote-16690732
Ref: Summary – Release Highlights<2>-Footnote-17690776
Ref: Summary – Release Highlights<2>-Footnote-18690826
Ref: Summary – Release Highlights<2>-Footnote-19690876
Ref: Summary – Release Highlights<2>-Footnote-20690920
Ref: Summary – Release Highlights<2>-Footnote-21690966
Ref: Summary – Release Highlights<2>-Footnote-22691016
Ref: Summary – Release Highlights<2>-Footnote-23691066
Ref: Summary – Release Highlights<2>-Footnote-24691110
Ref: Summary – Release Highlights<2>-Footnote-25691160
Node: New Features<5>691210
Ref: whatsnew/3 4 new-features691353
Ref: 7e3691353
Node: PEP 453 Explicit Bootstrapping of PIP in Python Installations691843
Ref: whatsnew/3 4 pep-453-explicit-bootstrapping-of-pip-in-python-installations692023
Ref: 7e4692023
Ref: whatsnew/3 4 whatsnew-pep-453692023
Ref: 7c8692023
Node: Bootstrapping pip By Default692235
Ref: whatsnew/3 4 bootstrapping-pip-by-default692391
Ref: 7e5692391
Ref: Bootstrapping pip By Default-Footnote-1695291
Ref: Bootstrapping pip By Default-Footnote-2695340
Node: Documentation Changes695435
Ref: whatsnew/3 4 documentation-changes695591
Ref: 7e8695591
Ref: Documentation Changes-Footnote-1696542
Ref: Documentation Changes-Footnote-2696579
Node: PEP 446 Newly Created File Descriptors Are Non-Inheritable696628
Ref: whatsnew/3 4 pep-446-newly-created-file-descriptors-are-non-inheritable696847
Ref: 7ed696847
Ref: whatsnew/3 4 whatsnew-pep-446696847
Ref: 7c9696847
Ref: PEP 446 Newly Created File Descriptors Are Non-Inheritable-Footnote-1697865
Ref: PEP 446 Newly Created File Descriptors Are Non-Inheritable-Footnote-2697914
Node: Improvements to Codec Handling697963
Ref: whatsnew/3 4 codec-handling-improvements698168
Ref: 7cb698168
Ref: whatsnew/3 4 improvements-to-codec-handling698168
Ref: 7f5698168
Ref: Improvements to Codec Handling-Footnote-1702374
Ref: Improvements to Codec Handling-Footnote-2702416
Ref: Improvements to Codec Handling-Footnote-3702459
Ref: Improvements to Codec Handling-Footnote-4702502
Node: PEP 451 A ModuleSpec Type for the Import System702545
Ref: whatsnew/3 4 pep-451-a-modulespec-type-for-the-import-system702717
Ref: 7fa702717
Ref: whatsnew/3 4 whatsnew-pep-451702717
Ref: 7cc702717
Ref: PEP 451 A ModuleSpec Type for the Import System-Footnote-1703668
Ref: PEP 451 A ModuleSpec Type for the Import System-Footnote-2703717
Node: Other Language Changes<5>703797
Ref: whatsnew/3 4 other-language-changes703930
Ref: 7fc703930
Ref: Other Language Changes<5>-Footnote-1706567
Ref: Other Language Changes<5>-Footnote-2706610
Ref: Other Language Changes<5>-Footnote-3706653
Ref: Other Language Changes<5>-Footnote-4706696
Ref: Other Language Changes<5>-Footnote-5706741
Ref: Other Language Changes<5>-Footnote-6706784
Ref: Other Language Changes<5>-Footnote-7706827
Ref: Other Language Changes<5>-Footnote-8706870
Ref: Other Language Changes<5>-Footnote-9706913
Ref: Other Language Changes<5>-Footnote-10706956
Ref: Other Language Changes<5>-Footnote-11707000
Ref: Other Language Changes<5>-Footnote-12707050
Node: New Modules<5>707094
Ref: whatsnew/3 4 new-modules707223
Ref: 801707223
Node: asyncio<6>707434
Ref: whatsnew/3 4 asyncio707513
Ref: 802707513
Ref: whatsnew/3 4 whatsnew-asyncio707513
Ref: 7ce707513
Ref: asyncio<6>-Footnote-1708111
Ref: asyncio<6>-Footnote-2708160
Node: ensurepip708209
Ref: whatsnew/3 4 ensurepip708304
Ref: 803708304
Ref: whatsnew/3 4 whatsnew-ensurepip708304
Ref: 7cf708304
Ref: ensurepip-Footnote-1709576
Node: enum<5>709625
Ref: whatsnew/3 4 enum709720
Ref: 804709720
Ref: whatsnew/3 4 whatsnew-enum709720
Ref: 7d0709720
Ref: enum<5>-Footnote-1710290
Ref: enum<5>-Footnote-2710339
Node: pathlib<5>710388
Ref: whatsnew/3 4 pathlib710486
Ref: 805710486
Ref: whatsnew/3 4 whatsnew-pathlib710486
Ref: 7d1710486
Ref: pathlib<5>-Footnote-1711104
Node: selectors<2>711153
Ref: whatsnew/3 4 selectors711257
Ref: 806711257
Ref: whatsnew/3 4 whatsnew-selectors711257
Ref: 7d2711257
Ref: selectors<2>-Footnote-1711515
Node: statistics<3>711564
Ref: whatsnew/3 4 statistics711672
Ref: 807711672
Ref: whatsnew/3 4 whatsnew-statistics711672
Ref: 7d3711672
Ref: statistics<3>-Footnote-1712137
Ref: statistics<3>-Footnote-2712186
Node: tracemalloc<3>712235
Ref: whatsnew/3 4 tracemalloc712322
Ref: 808712322
Ref: whatsnew/3 4 whatsnew-tracemalloc712322
Ref: 7d4712322
Ref: tracemalloc<3>-Footnote-1712987
Ref: tracemalloc<3>-Footnote-2713036
Node: Improved Modules<5>713085
Ref: whatsnew/3 4 improved-modules713229
Ref: 809713229
Node: abc714541
Ref: whatsnew/3 4 abc714616
Ref: 80a714616
Ref: abc-Footnote-1715137
Ref: abc-Footnote-2715180
Node: aifc<2>715223
Ref: whatsnew/3 4 aifc715318
Ref: 80e715318
Ref: aifc<2>-Footnote-1715956
Ref: aifc<2>-Footnote-2715999
Ref: aifc<2>-Footnote-3716042
Node: argparse<3>716084
Ref: whatsnew/3 4 argparse716183
Ref: 813716183
Ref: argparse<3>-Footnote-1716429
Node: audioop716472
Ref: whatsnew/3 4 audioop716570
Ref: 815716570
Ref: audioop-Footnote-1717109
Ref: audioop-Footnote-2717152
Ref: audioop-Footnote-3717195
Node: base64717238
Ref: whatsnew/3 4 base64717339
Ref: 817717339
Ref: base64-Footnote-1718170
Ref: base64-Footnote-2718213
Node: collections<6>718256
Ref: whatsnew/3 4 collections718358
Ref: 81c718358
Ref: collections<6>-Footnote-1718688
Node: colorsys718731
Ref: whatsnew/3 4 colorsys718840
Ref: 81e718840
Ref: colorsys-Footnote-1719208
Node: contextlib<4>719251
Ref: whatsnew/3 4 contextlib719352
Ref: 81f719352
Ref: contextlib<4>-Footnote-1720537
Ref: contextlib<4>-Footnote-2720580
Ref: contextlib<4>-Footnote-3720623
Node: dbm<5>720666
Ref: whatsnew/3 4 dbm720765
Ref: 823720765
Ref: dbm<5>-Footnote-1721112
Node: dis<2>721155
Ref: whatsnew/3 4 dis721251
Ref: 825721251
Ref: dis<2>-Footnote-1723850
Ref: dis<2>-Footnote-2723893
Ref: dis<2>-Footnote-3723936
Node: doctest<2>723979
Ref: whatsnew/3 4 doctest724077
Ref: 82f724077
Ref: doctest<2>-Footnote-1724845
Ref: doctest<2>-Footnote-2724888
Ref: doctest<2>-Footnote-3724931
Node: email<3>724973
Ref: whatsnew/3 4 email725072
Ref: 832725072
Ref: whatsnew/3 4 whatsnew-email-contentmanager726320
Ref: 7d8726320
Ref: email<3>-Footnote-1727249
Ref: email<3>-Footnote-2727292
Ref: email<3>-Footnote-3727335
Ref: email<3>-Footnote-4727378
Node: filecmp727421
Ref: whatsnew/3 4 filecmp727522
Ref: 83a727522
Ref: filecmp-Footnote-1728268
Ref: filecmp-Footnote-2728311
Node: functools<4>728354
Ref: whatsnew/3 4 functools728452
Ref: 83e728452
Ref: whatsnew/3 4 whatsnew-singledispatch728899
Ref: 7d5728899
Ref: functools<4>-Footnote-1729858
Ref: functools<4>-Footnote-2729900
Ref: functools<4>-Footnote-3729949
Ref: functools<4>-Footnote-4729992
Node: gc<3>730035
Ref: whatsnew/3 4 gc730133
Ref: 841730133
Ref: gc<3>-Footnote-1730399
Node: glob<2>730442
Ref: whatsnew/3 4 glob730538
Ref: 843730538
Ref: glob<2>-Footnote-1730842
Node: hashlib<2>730884
Ref: whatsnew/3 4 hashlib730982
Ref: 845730982
Ref: hashlib<2>-Footnote-1731615
Ref: hashlib<2>-Footnote-2731660
Ref: hashlib<2>-Footnote-3731703
Node: hmac<2>731746
Ref: whatsnew/3 4 hmac731841
Ref: 847731841
Ref: hmac<2>-Footnote-1732867
Ref: hmac<2>-Footnote-2732910
Ref: hmac<2>-Footnote-3732953
Ref: hmac<2>-Footnote-4733002
Node: html733045
Ref: whatsnew/3 4 html733137
Ref: 84d733137
Ref: html-Footnote-1733894
Ref: html-Footnote-2733936
Ref: html-Footnote-3733979
Node: http<2>734022
Ref: whatsnew/3 4 http734126
Ref: 84f734126
Ref: http<2>-Footnote-1734767
Ref: http<2>-Footnote-2734810
Node: idlelib and IDLE<4>734853
Ref: whatsnew/3 4 idlelib-and-idle734965
Ref: 852734965
Node: importlib<6>735359
Ref: whatsnew/3 4 importlib735474
Ref: 853735474
Ref: importlib<6>-Footnote-1737475
Ref: importlib<6>-Footnote-2737518
Ref: importlib<6>-Footnote-3737561
Ref: importlib<6>-Footnote-4737604
Ref: importlib<6>-Footnote-5737647
Ref: importlib<6>-Footnote-6737690
Ref: importlib<6>-Footnote-7737733
Node: inspect<4>737776
Ref: whatsnew/3 4 inspect737884
Ref: 85b737884
Ref: inspect<4>-Footnote-1739598
Ref: inspect<4>-Footnote-2739641
Ref: inspect<4>-Footnote-3739684
Ref: inspect<4>-Footnote-4739727
Ref: inspect<4>-Footnote-5739770
Ref: inspect<4>-Footnote-6739813
Node: ipaddress<3>739856
Ref: whatsnew/3 4 ipaddress739962
Ref: 85f739962
Ref: ipaddress<3>-Footnote-1740488
Node: logging<5>740531
Ref: whatsnew/3 4 logging740634
Ref: 861740634
Ref: logging<5>-Footnote-1741764
Ref: logging<5>-Footnote-2741806
Ref: logging<5>-Footnote-3741849
Node: marshal741892
Ref: whatsnew/3 4 marshal741990
Ref: 867741990
Ref: whatsnew/3 4 whatsnew-marshal-3741990
Ref: 7cd741990
Ref: marshal-Footnote-1742669
Ref: marshal-Footnote-2742712
Node: mmap<2>742755
Ref: whatsnew/3 4 mmap742861
Ref: 868742861
Ref: mmap<2>-Footnote-1743024
Node: multiprocessing<5>743066
Ref: whatsnew/3 4 multiprocessing743176
Ref: 869743176
Ref: whatsnew/3 4 whatsnew-multiprocessing-no-fork743227
Ref: 7d7743227
Ref: multiprocessing<5>-Footnote-1745039
Ref: multiprocessing<5>-Footnote-2745081
Ref: multiprocessing<5>-Footnote-3745124
Ref: multiprocessing<5>-Footnote-4745166
Node: operator<2>745209
Ref: whatsnew/3 4 operator745317
Ref: 870745317
Ref: operator<2>-Footnote-1745868
Ref: operator<2>-Footnote-2745917
Ref: operator<2>-Footnote-3745960
Node: os<6>746003
Ref: whatsnew/3 4 os746099
Ref: 872746099
Ref: os<6>-Footnote-1747544
Ref: os<6>-Footnote-2747587
Ref: os<6>-Footnote-3747630
Ref: os<6>-Footnote-4747672
Node: pdb<3>747715
Ref: whatsnew/3 4 pdb747809
Ref: 879747809
Ref: pdb<3>-Footnote-1748803
Ref: pdb<3>-Footnote-2748846
Node: pickle<4>748889
Ref: whatsnew/3 4 pickle748989
Ref: 87c748989
Ref: whatsnew/3 4 whatsnew-protocol-4748989
Ref: 7d6748989
Ref: pickle<4>-Footnote-1749584
Node: plistlib<2>749633
Ref: whatsnew/3 4 plistlib749736
Ref: 87e749736
Ref: plistlib<2>-Footnote-1750270
Node: poplib<2>750313
Ref: whatsnew/3 4 poplib750416
Ref: 885750416
Ref: poplib<2>-Footnote-1750804
Node: pprint<2>750846
Ref: whatsnew/3 4 pprint750941
Ref: 888750941
Ref: pprint<2>-Footnote-1751559
Ref: pprint<2>-Footnote-2751602
Node: pty751645
Ref: whatsnew/3 4 pty751739
Ref: 88b751739
Node: pydoc<3>751930
Ref: whatsnew/3 4 pydoc752020
Ref: 88d752020
Ref: pydoc<3>-Footnote-1753075
Ref: pydoc<3>-Footnote-2753118
Node: re<5>753161
Ref: whatsnew/3 4 re753256
Ref: 88e753256
Ref: re<5>-Footnote-1753997
Ref: re<5>-Footnote-2754040
Ref: re<5>-Footnote-3754083
Node: resource754126
Ref: whatsnew/3 4 resource754219
Ref: 892754219
Ref: resource-Footnote-1755070
Ref: resource-Footnote-2755113
Ref: resource-Footnote-3755156
Node: select755199
Ref: whatsnew/3 4 select755293
Ref: 89c755293
Ref: select-Footnote-1755800
Ref: select-Footnote-2755843
Node: shelve755886
Ref: whatsnew/3 4 shelve755981
Ref: 8a3755981
Ref: shelve-Footnote-1756251
Node: shutil<3>756294
Ref: whatsnew/3 4 shutil756391
Ref: 8a5756391
Ref: shutil<3>-Footnote-1756762
Node: smtpd<2>756807
Ref: whatsnew/3 4 smtpd756908
Ref: 8a8756908
Ref: smtpd<2>-Footnote-1757284
Node: smtplib<2>757327
Ref: whatsnew/3 4 smtplib757428
Ref: 8aa757428
Ref: smtplib<2>-Footnote-1757788
Node: socket<6>757830
Ref: whatsnew/3 4 socket757933
Ref: 8ac757933
Ref: socket<6>-Footnote-1758714
Ref: socket<6>-Footnote-2758757
Node: sqlite3<4>758799
Ref: whatsnew/3 4 sqlite3758898
Ref: 8b1758898
Ref: sqlite3<4>-Footnote-1759187
Ref: sqlite3<4>-Footnote-2759227
Node: ssl<7>759270
Ref: whatsnew/3 4 ssl759364
Ref: 8b2759364
Ref: whatsnew/3 4 whatsnew-tls-11-12759391
Ref: 7db759391
Ref: whatsnew/3 4 whatsnew34-sslcontext759661
Ref: 7de759661
Ref: whatsnew/3 4 whatsnew34-win-cert-store762335
Ref: 7dc762335
Ref: whatsnew/3 4 whatsnew34-sni762589
Ref: 7dd762589
Ref: ssl<7>-Footnote-1763038
Ref: ssl<7>-Footnote-2763081
Ref: ssl<7>-Footnote-3763124
Ref: ssl<7>-Footnote-4763167
Ref: ssl<7>-Footnote-5763210
Ref: ssl<7>-Footnote-6763253
Ref: ssl<7>-Footnote-7763295
Ref: ssl<7>-Footnote-8763338
Ref: ssl<7>-Footnote-9763381
Ref: ssl<7>-Footnote-10763423
Node: stat763467
Ref: whatsnew/3 4 stat763560
Ref: 8c6763560
Ref: stat-Footnote-1764031
Ref: stat-Footnote-2764074
Node: struct<2>764117
Ref: whatsnew/3 4 struct764217
Ref: 8cb764217
Ref: struct<2>-Footnote-1764547
Node: subprocess<4>764590
Ref: whatsnew/3 4 subprocess764694
Ref: 8ce764694
Ref: subprocess<4>-Footnote-1765138
Ref: subprocess<4>-Footnote-2765181
Node: sunau<2>765224
Ref: whatsnew/3 4 sunau765325
Ref: 8d1765325
Ref: sunau<2>-Footnote-1766130
Ref: sunau<2>-Footnote-2766173
Ref: sunau<2>-Footnote-3766216
Ref: sunau<2>-Footnote-4766259
Node: sys<6>766301
Ref: whatsnew/3 4 sys766399
Ref: 8d5766399
Ref: sys<6>-Footnote-1767677
Ref: sys<6>-Footnote-2767720
Node: tarfile<3>767762
Ref: whatsnew/3 4 tarfile767860
Ref: 8db767860
Ref: tarfile<3>-Footnote-1768177
Node: textwrap768220
Ref: whatsnew/3 4 textwrap768324
Ref: 8dd768324
Ref: textwrap-Footnote-1769023
Ref: textwrap-Footnote-2769066
Node: threading<4>769109
Ref: whatsnew/3 4 threading769215
Ref: 8e2769215
Ref: threading<4>-Footnote-1769558
Node: traceback<3>769601
Ref: whatsnew/3 4 traceback769707
Ref: 8e4769707
Ref: traceback<3>-Footnote-1770020
Node: types<3>770065
Ref: whatsnew/3 4 types770168
Ref: 8e6770168
Ref: types<3>-Footnote-1770672
Node: urllib<2>770715
Ref: whatsnew/3 4 urllib770817
Ref: 8e8770817
Ref: urllib<2>-Footnote-1772131
Ref: urllib<2>-Footnote-2772174
Ref: urllib<2>-Footnote-3772217
Ref: urllib<2>-Footnote-4772260
Ref: urllib<2>-Footnote-5772303
Ref: urllib<2>-Footnote-6772346
Node: unittest<4>772389
Ref: whatsnew/3 4 unittest772490
Ref: 8f2772490
Ref: unittest<4>-Footnote-1775644
Ref: unittest<4>-Footnote-2775687
Ref: unittest<4>-Footnote-3775730
Ref: unittest<4>-Footnote-4775773
Ref: unittest<4>-Footnote-5775816
Ref: unittest<4>-Footnote-6775859
Ref: unittest<4>-Footnote-7775902
Ref: unittest<4>-Footnote-8775945
Ref: unittest<4>-Footnote-9775988
Node: venv<4>776031
Ref: whatsnew/3 4 venv776130
Ref: 8fb776130
Ref: venv<4>-Footnote-1776686
Ref: venv<4>-Footnote-2776729
Ref: venv<4>-Footnote-3776772
Node: wave<2>776821
Ref: whatsnew/3 4 wave776919
Ref: 8fe776919
Ref: wave<2>-Footnote-1777554
Ref: wave<2>-Footnote-2777597
Ref: wave<2>-Footnote-3777640
Ref: wave<2>-Footnote-4777682
Node: weakref<2>777724
Ref: whatsnew/3 4 weakref777827
Ref: 902777827
Ref: weakref<2>-Footnote-1778446
Ref: weakref<2>-Footnote-2778489
Ref: weakref<2>-Footnote-3778532
Node: xml etree<2>778575
Ref: whatsnew/3 4 xml-etree778681
Ref: 906778681
Ref: xml etree<2>-Footnote-1779418
Ref: xml etree<2>-Footnote-2779461
Node: zipfile<4>779504
Ref: whatsnew/3 4 zipfile779591
Ref: 90d779591
Ref: zipfile<4>-Footnote-1780120
Ref: zipfile<4>-Footnote-2780163
Node: CPython Implementation Changes780206
Ref: whatsnew/3 4 cpython-implementation-changes780349
Ref: 910780349
Node: PEP 445 Customization of CPython Memory Allocators780879
Ref: whatsnew/3 4 pep-445-customization-of-cpython-memory-allocators781037
Ref: 911781037
Ref: whatsnew/3 4 whatsnew-pep-445781037
Ref: 7e1781037
Ref: PEP 445 Customization of CPython Memory Allocators-Footnote-1781432
Ref: PEP 445 Customization of CPython Memory Allocators-Footnote-2781481
Node: PEP 442 Safe Object Finalization781530
Ref: whatsnew/3 4 pep-442-safe-object-finalization781746
Ref: 912781746
Ref: whatsnew/3 4 whatsnew-pep-442781746
Ref: 7e0781746
Ref: PEP 442 Safe Object Finalization-Footnote-1782613
Ref: PEP 442 Safe Object Finalization-Footnote-2782662
Node: PEP 456 Secure and Interchangeable Hash Algorithm782711
Ref: whatsnew/3 4 pep-456-secure-and-interchangeable-hash-algorithm782900
Ref: 914782900
Ref: whatsnew/3 4 whatsnew-pep-456782900
Ref: 7d9782900
Ref: PEP 456 Secure and Interchangeable Hash Algorithm-Footnote-1783846
Ref: PEP 456 Secure and Interchangeable Hash Algorithm-Footnote-2783895
Node: PEP 436 Argument Clinic783938
Ref: whatsnew/3 4 pep-436-argument-clinic784124
Ref: 916784124
Ref: whatsnew/3 4 whatsnew-pep-436784124
Ref: 7e2784124
Ref: PEP 436 Argument Clinic-Footnote-1785230
Ref: PEP 436 Argument Clinic-Footnote-2785279
Node: Other Build and C API Changes785328
Ref: whatsnew/3 4 other-build-and-c-api-changes785486
Ref: 917785486
Ref: Other Build and C API Changes-Footnote-1787570
Ref: Other Build and C API Changes-Footnote-2787613
Ref: Other Build and C API Changes-Footnote-3787656
Ref: Other Build and C API Changes-Footnote-4787701
Ref: Other Build and C API Changes-Footnote-5787743
Ref: Other Build and C API Changes-Footnote-6787786
Ref: Other Build and C API Changes-Footnote-7787859
Ref: Other Build and C API Changes-Footnote-8787923
Ref: Other Build and C API Changes-Footnote-9787966
Node: Other Improvements<2>788009
Ref: whatsnew/3 4 other-improvements788169
Ref: 91d788169
Ref: whatsnew/3 4 other-improvements-3-4788169
Ref: 91e788169
Ref: whatsnew/3 4 whatsnew-isolated-mode788224
Ref: 7ca788224
Ref: Other Improvements<2>-Footnote-1792349
Ref: Other Improvements<2>-Footnote-2792392
Ref: Other Improvements<2>-Footnote-3792434
Ref: Other Improvements<2>-Footnote-4792477
Ref: Other Improvements<2>-Footnote-5792520
Ref: Other Improvements<2>-Footnote-6792563
Ref: Other Improvements<2>-Footnote-7792606
Ref: Other Improvements<2>-Footnote-8792701
Ref: Other Improvements<2>-Footnote-9792754
Ref: Other Improvements<2>-Footnote-10792797
Ref: Other Improvements<2>-Footnote-11792841
Ref: Other Improvements<2>-Footnote-12792885
Ref: Other Improvements<2>-Footnote-13792935
Ref: Other Improvements<2>-Footnote-14792979
Ref: Other Improvements<2>-Footnote-15793023
Ref: Other Improvements<2>-Footnote-16793067
Ref: Other Improvements<2>-Footnote-17793111
Ref: Other Improvements<2>-Footnote-18793161
Ref: Other Improvements<2>-Footnote-19793205
Ref: Other Improvements<2>-Footnote-20793249
Ref: Other Improvements<2>-Footnote-21793293
Node: Significant Optimizations793337
Ref: whatsnew/3 4 significant-optimizations793459
Ref: 924793459
Ref: Significant Optimizations-Footnote-1796262
Ref: Significant Optimizations-Footnote-2796305
Ref: Significant Optimizations-Footnote-3796348
Ref: Significant Optimizations-Footnote-4796391
Ref: Significant Optimizations-Footnote-5796434
Ref: Significant Optimizations-Footnote-6796477
Ref: Significant Optimizations-Footnote-7796520
Ref: Significant Optimizations-Footnote-8796562
Ref: Significant Optimizations-Footnote-9796605
Ref: Significant Optimizations-Footnote-10796648
Ref: Significant Optimizations-Footnote-11796692
Ref: Significant Optimizations-Footnote-12796736
Ref: Significant Optimizations-Footnote-13796780
Node: Deprecated<4>796824
Ref: whatsnew/3 4 deprecated796958
Ref: 929796958
Ref: whatsnew/3 4 deprecated-3-4796958
Ref: 7fb796958
Node: Deprecations in the Python API797398
Ref: whatsnew/3 4 deprecations-in-the-python-api797506
Ref: 92a797506
Node: Deprecated Features801268
Ref: whatsnew/3 4 deprecated-features801376
Ref: 93d801376
Ref: Deprecated Features-Footnote-1801759
Ref: Deprecated Features-Footnote-2801802
Node: Removed<3>801845
Ref: whatsnew/3 4 removed801970
Ref: 93f801970
Node: Operating Systems No Longer Supported802126
Ref: whatsnew/3 4 operating-systems-no-longer-supported802246
Ref: 940802246
Ref: Operating Systems No Longer Supported-Footnote-1802659
Ref: Operating Systems No Longer Supported-Footnote-2802702
Ref: Operating Systems No Longer Supported-Footnote-3802745
Node: API and Feature Removals<5>802788
Ref: whatsnew/3 4 api-and-feature-removals802930
Ref: 941802930
Ref: API and Feature Removals<5>-Footnote-1805384
Ref: API and Feature Removals<5>-Footnote-2805420
Ref: API and Feature Removals<5>-Footnote-3805463
Ref: API and Feature Removals<5>-Footnote-4805506
Ref: API and Feature Removals<5>-Footnote-5805549
Ref: API and Feature Removals<5>-Footnote-6805592
Ref: API and Feature Removals<5>-Footnote-7805634
Node: Code Cleanups805677
Ref: whatsnew/3 4 code-cleanups805773
Ref: 944805773
Ref: Code Cleanups-Footnote-1806436
Node: Porting to Python 3 4806479
Ref: whatsnew/3 4 porting-to-python-3-4806607
Ref: 945806607
Node: Changes in ‘python’ Command Behavior<2>806978
Ref: whatsnew/3 4 changes-in-python-command-behavior807116
Ref: 946807116
Ref: Changes in ‘python’ Command Behavior<2>-Footnote-1808227
Node: Changes in the Python API<5>808270
Ref: whatsnew/3 4 changes-in-the-python-api808440
Ref: 948808440
Ref: Changes in the Python API<5>-Footnote-1821822
Ref: Changes in the Python API<5>-Footnote-2821865
Ref: Changes in the Python API<5>-Footnote-3821908
Ref: Changes in the Python API<5>-Footnote-4821951
Ref: Changes in the Python API<5>-Footnote-5821994
Ref: Changes in the Python API<5>-Footnote-6822037
Ref: Changes in the Python API<5>-Footnote-7822080
Ref: Changes in the Python API<5>-Footnote-8822123
Ref: Changes in the Python API<5>-Footnote-9822165
Ref: Changes in the Python API<5>-Footnote-10822208
Ref: Changes in the Python API<5>-Footnote-11822252
Ref: Changes in the Python API<5>-Footnote-12822296
Ref: Changes in the Python API<5>-Footnote-13822340
Ref: Changes in the Python API<5>-Footnote-14822384
Ref: Changes in the Python API<5>-Footnote-15822428
Ref: Changes in the Python API<5>-Footnote-16822472
Ref: Changes in the Python API<5>-Footnote-17822516
Ref: Changes in the Python API<5>-Footnote-18822560
Ref: Changes in the Python API<5>-Footnote-19822604
Ref: Changes in the Python API<5>-Footnote-20822648
Ref: Changes in the Python API<5>-Footnote-21822692
Ref: Changes in the Python API<5>-Footnote-22822736
Ref: Changes in the Python API<5>-Footnote-23822780
Ref: Changes in the Python API<5>-Footnote-24822823
Node: Changes in the C API<5>822867
Ref: whatsnew/3 4 changes-in-the-c-api822985
Ref: 95a822985
Ref: Changes in the C API<5>-Footnote-1824745
Ref: Changes in the C API<5>-Footnote-2824788
Node: Changed in 3 4 3824831
Ref: whatsnew/3 4 changed-in-3-4-3824940
Ref: 966824940
Node: PEP 476 Enabling certificate verification by default for stdlib http clients825156
Ref: whatsnew/3 4 pep-476825285
Ref: 967825285
Ref: whatsnew/3 4 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients825285
Ref: 968825285
Node: What’s New In Python 3 3826284
Ref: whatsnew/3 3 doc826439
Ref: 969826439
Ref: whatsnew/3 3 what-s-new-in-python-3-3826439
Ref: 96a826439
Ref: What’s New In Python 3 3-Footnote-1828379
Ref: What’s New In Python 3 3-Footnote-2828439
Node: Summary – Release highlights<4>828488
Ref: whatsnew/3 3 summary-release-highlights828621
Ref: 96b828621
Node: PEP 405 Virtual Environments829950
Ref: whatsnew/3 3 pep-405830127
Ref: 96d830127
Ref: whatsnew/3 3 pep-405-virtual-environments830127
Ref: 975830127
Ref: PEP 405 Virtual Environments-Footnote-1831115
Node: PEP 420 Implicit Namespace Packages831164
Ref: whatsnew/3 3 pep-420-implicit-namespace-packages831380
Ref: 976831380
Ref: PEP 420 Implicit Namespace Packages-Footnote-1831891
Ref: PEP 420 Implicit Namespace Packages-Footnote-2831940
Node: PEP 3118 New memoryview implementation and buffer protocol documentation831989
Ref: whatsnew/3 3 pep-3118-new-memoryview-implementation-and-buffer-protocol-documentation832215
Ref: 977832215
Ref: whatsnew/3 3 pep-3118-update832215
Ref: 978832215
Ref: PEP 3118 New memoryview implementation and buffer protocol documentation-Footnote-1833345
Node: Features833394
Ref: whatsnew/3 3 features833531
Ref: 979833531
Ref: Features-Footnote-1834331
Node: API changes834374
Ref: whatsnew/3 3 api-changes834511
Ref: 97a834511
Ref: API changes-Footnote-1835526
Ref: API changes-Footnote-2835569
Node: PEP 393 Flexible String Representation835618
Ref: whatsnew/3 3 pep-393835844
Ref: 970835844
Ref: whatsnew/3 3 pep-393-flexible-string-representation835844
Ref: 97d835844
Ref: PEP 393 Flexible String Representation-Footnote-1836903
Node: Functionality836952
Ref: whatsnew/3 3 functionality837079
Ref: 97e837079
Ref: Functionality-Footnote-1838526
Ref: Functionality-Footnote-2838575
Node: Performance and resource usage838618
Ref: whatsnew/3 3 performance-and-resource-usage838745
Ref: 980838745
Ref: Performance and resource usage-Footnote-1839976
Node: PEP 397 Python Launcher for Windows840025
Ref: whatsnew/3 3 pep-397840231
Ref: 981840231
Ref: whatsnew/3 3 pep-397-python-launcher-for-windows840231
Ref: 982840231
Ref: PEP 397 Python Launcher for Windows-Footnote-1841773
Ref: PEP 397 Python Launcher for Windows-Footnote-2841815
Node: PEP 3151 Reworking the OS and IO exception hierarchy841864
Ref: whatsnew/3 3 pep-3151842079
Ref: 96e842079
Ref: whatsnew/3 3 pep-3151-reworking-the-os-and-io-exception-hierarchy842079
Ref: 985842079
Ref: PEP 3151 Reworking the OS and IO exception hierarchy-Footnote-1844648
Node: PEP 380 Syntax for Delegating to a Subgenerator844697
Ref: whatsnew/3 3 pep-380844914
Ref: 96c844914
Ref: whatsnew/3 3 pep-380-syntax-for-delegating-to-a-subgenerator844914
Ref: 995844914
Ref: PEP 380 Syntax for Delegating to a Subgenerator-Footnote-1847357
Node: PEP 409 Suppressing exception context847406
Ref: whatsnew/3 3 pep-409-suppressing-exception-context847604
Ref: 997847604
Ref: PEP 409 Suppressing exception context-Footnote-1849692
Node: PEP 414 Explicit Unicode literals849741
Ref: whatsnew/3 3 pep-414-explicit-unicode-literals849941
Ref: 998849941
Ref: PEP 414 Explicit Unicode literals-Footnote-1850654
Node: PEP 3155 Qualified name for classes and functions850703
Ref: whatsnew/3 3 pep-3155-qualified-name-for-classes-and-functions850896
Ref: 999850896
Ref: PEP 3155 Qualified name for classes and functions-Footnote-1852488
Node: PEP 412 Key-Sharing Dictionary852537
Ref: whatsnew/3 3 pep-412852730
Ref: 971852730
Ref: whatsnew/3 3 pep-412-key-sharing-dictionary852730
Ref: 99a852730
Ref: PEP 412 Key-Sharing Dictionary-Footnote-1853249
Node: PEP 362 Function Signature Object853298
Ref: whatsnew/3 3 pep-362-function-signature-object853475
Ref: 99b853475
Ref: PEP 362 Function Signature Object-Footnote-1854369
Node: PEP 421 Adding sys implementation854418
Ref: whatsnew/3 3 pep-421-adding-sys-implementation854612
Ref: 99d854612
Ref: PEP 421 Adding sys implementation-Footnote-1855826
Node: SimpleNamespace855875
Ref: whatsnew/3 3 simplenamespace855960
Ref: 99f855960
Ref: SimpleNamespace-Footnote-1856578
Node: Using importlib as the Implementation of Import856627
Ref: whatsnew/3 3 importlib856813
Ref: 96f856813
Ref: whatsnew/3 3 using-importlib-as-the-implementation-of-import856813
Ref: 9a1856813
Ref: Using importlib as the Implementation of Import-Footnote-1858094
Ref: Using importlib as the Implementation of Import-Footnote-2858136
Ref: Using importlib as the Implementation of Import-Footnote-3858179
Ref: Using importlib as the Implementation of Import-Footnote-4858222
Ref: Using importlib as the Implementation of Import-Footnote-5858265
Node: New APIs858314
Ref: whatsnew/3 3 new-apis858430
Ref: 9a4858430
Node: Visible Changes860272
Ref: whatsnew/3 3 visible-changes860388
Ref: 9ae860388
Ref: Visible Changes-Footnote-1862242
Ref: Visible Changes-Footnote-2862291
Node: Other Language Changes<6>862340
Ref: whatsnew/3 3 other-language-changes862520
Ref: 9b0862520
Ref: Other Language Changes<6>-Footnote-1864480
Ref: Other Language Changes<6>-Footnote-2864523
Ref: Other Language Changes<6>-Footnote-3864566
Ref: Other Language Changes<6>-Footnote-4864609
Ref: Other Language Changes<6>-Footnote-5864652
Ref: Other Language Changes<6>-Footnote-6864695
Ref: Other Language Changes<6>-Footnote-7864738
Ref: Other Language Changes<6>-Footnote-8864781
Node: A Finer-Grained Import Lock864824
Ref: whatsnew/3 3 a-finer-grained-import-lock864984
Ref: 9b4864984
Ref: A Finer-Grained Import Lock-Footnote-1865727
Node: Builtin functions and types865769
Ref: whatsnew/3 3 builtin-functions-and-types865918
Ref: 9b6865918
Ref: Builtin functions and types-Footnote-1867151
Node: New Modules<6>867193
Ref: whatsnew/3 3 new-modules867334
Ref: 9ba867334
Node: faulthandler<3>867460
Ref: whatsnew/3 3 faulthandler867547
Ref: 9bb867547
Node: ipaddress<4>868472
Ref: whatsnew/3 3 ipaddress868575
Ref: 9bd868575
Ref: ipaddress<4>-Footnote-1868919
Node: lzma<2>868968
Ref: whatsnew/3 3 lzma869047
Ref: 9be869047
Ref: lzma<2>-Footnote-1869359
Node: Improved Modules<6>869401
Ref: whatsnew/3 3 improved-modules869531
Ref: 9bf869531
Node: abc<2>870798
Ref: whatsnew/3 3 abc870877
Ref: 9c0870877
Ref: abc<2>-Footnote-1871909
Ref: abc<2>-Footnote-2871952
Node: array<2>871995
Ref: whatsnew/3 3 array872092
Ref: 9c6872092
Ref: array<2>-Footnote-1872330
Node: base64<2>872375
Ref: whatsnew/3 3 base64872477
Ref: 9c7872477
Ref: base64<2>-Footnote-1872775
Node: binascii<3>872818
Ref: whatsnew/3 3 binascii872918
Ref: 9c8872918
Ref: binascii<3>-Footnote-1873172
Node: bz2<2>873215
Ref: whatsnew/3 3 bz2873312
Ref: 9c9873312
Ref: bz2<2>-Footnote-1874283
Ref: bz2<2>-Footnote-2874325
Node: codecs874367
Ref: whatsnew/3 3 codecs874467
Ref: 9cc874467
Ref: codecs-Footnote-1875787
Ref: codecs-Footnote-2875830
Ref: codecs-Footnote-3875873
Node: collections<7>875916
Ref: whatsnew/3 3 collections876023
Ref: 9cd876023
Ref: collections<7>-Footnote-1876788
Ref: collections<7>-Footnote-2876831
Ref: collections<7>-Footnote-3876874
Ref: collections<7>-Footnote-4876917
Node: contextlib<5>876960
Ref: whatsnew/3 3 contextlib877069
Ref: 9cf877069
Ref: contextlib<5>-Footnote-1877663
Node: crypt<2>877706
Ref: whatsnew/3 3 crypt877810
Ref: 9d0877810
Ref: crypt<2>-Footnote-1878023
Node: curses<3>878066
Ref: whatsnew/3 3 curses878168
Ref: 9d1878168
Ref: curses<3>-Footnote-1879026
Node: datetime<4>879068
Ref: whatsnew/3 3 datetime879172
Ref: 9d5879172
Ref: datetime<4>-Footnote-1879890
Node: decimal<3>879933
Ref: whatsnew/3 3 decimal880036
Ref: 9d7880036
Ref: whatsnew/3 3 new-decimal880036
Ref: 972880036
Ref: decimal<3>-Footnote-1881739
Node: Features<2>881781
Ref: whatsnew/3 3 id1881862
Ref: 9d8881862
Node: API changes<2>882234
Ref: whatsnew/3 3 id2882315
Ref: 9db882315
Node: email<4>885093
Ref: whatsnew/3 3 email885191
Ref: 9e6885191
Ref: whatsnew/3 3 new-email885191
Ref: 973885191
Node: Policy Framework885320
Ref: whatsnew/3 3 policy-framework885428
Ref: 9e7885428
Node: Provisional Policy with New Header API888436
Ref: whatsnew/3 3 provisional-policy-with-new-header-api888570
Ref: 9eb888570
Node: Other API Changes893206
Ref: whatsnew/3 3 other-api-changes893315
Ref: 9ef893315
Node: ftplib894206
Ref: whatsnew/3 3 ftplib894306
Ref: 9f6894306
Ref: ftplib-Footnote-1895213
Ref: ftplib-Footnote-2895255
Ref: ftplib-Footnote-3895298
Node: functools<5>895341
Ref: whatsnew/3 3 functools895438
Ref: 9fd895438
Ref: functools<5>-Footnote-1895784
Node: gc<4>895827
Ref: whatsnew/3 3 gc895925
Ref: 9fe895925
Node: hmac<3>896097
Ref: whatsnew/3 3 hmac896190
Ref: a00896190
Ref: hmac<3>-Footnote-1896454
Node: http<3>896497
Ref: whatsnew/3 3 http896592
Ref: a02896592
Ref: http<3>-Footnote-1897270
Ref: http<3>-Footnote-2897312
Ref: http<3>-Footnote-3897355
Node: html<2>897398
Ref: whatsnew/3 3 html897496
Ref: a09897496
Ref: html<2>-Footnote-1898494
Ref: html<2>-Footnote-2898537
Ref: html<2>-Footnote-3898580
Ref: html<2>-Footnote-4898623
Ref: html<2>-Footnote-5898666
Ref: html<2>-Footnote-6898709
Ref: html<2>-Footnote-7898754
Ref: html<2>-Footnote-8898798
Ref: html<2>-Footnote-9898841
Ref: html<2>-Footnote-10898884
Ref: html<2>-Footnote-11898930
Ref: html<2>-Footnote-12898975
Ref: html<2>-Footnote-13899019
Ref: html<2>-Footnote-14899063
Ref: html<2>-Footnote-15899106
Ref: html<2>-Footnote-16899150
Node: imaplib<2>899194
Ref: whatsnew/3 3 imaplib899295
Ref: a0b899295
Ref: imaplib<2>-Footnote-1899535
Node: inspect<5>899577
Ref: whatsnew/3 3 inspect899676
Ref: a0d899676
Ref: inspect<5>-Footnote-1900386
Ref: inspect<5>-Footnote-2900429
Node: io<4>900472
Ref: whatsnew/3 3 io900573
Ref: a10900573
Ref: io<4>-Footnote-1901220
Node: itertools<3>901263
Ref: whatsnew/3 3 itertools901364
Ref: a11901364
Node: logging<6>901520
Ref: whatsnew/3 3 logging901623
Ref: a12901623
Node: math<5>902074
Ref: whatsnew/3 3 math902172
Ref: a14902172
Ref: math<5>-Footnote-1902395
Node: mmap<3>902438
Ref: whatsnew/3 3 mmap902544
Ref: a16902544
Ref: mmap<3>-Footnote-1902879
Node: multiprocessing<6>902922
Ref: whatsnew/3 3 multiprocessing903028
Ref: a18903028
Ref: multiprocessing<6>-Footnote-1904178
Ref: multiprocessing<6>-Footnote-2904221
Ref: multiprocessing<6>-Footnote-3904263
Ref: multiprocessing<6>-Footnote-4904305
Node: nntplib904348
Ref: whatsnew/3 3 nntplib904452
Ref: a20904452
Ref: nntplib-Footnote-1905015
Node: os<7>905057
Ref: whatsnew/3 3 os905149
Ref: a22905149
Ref: os<7>-Footnote-1912527
Ref: os<7>-Footnote-2912570
Ref: os<7>-Footnote-3912612
Ref: os<7>-Footnote-4912655
Ref: os<7>-Footnote-5912698
Ref: os<7>-Footnote-6912741
Ref: os<7>-Footnote-7912783
Ref: os<7>-Footnote-8912826
Ref: os<7>-Footnote-9912869
Ref: os<7>-Footnote-10912912
Ref: os<7>-Footnote-11912955
Node: pdb<4>912999
Ref: whatsnew/3 3 pdb913093
Ref: a5c913093
Ref: pdb<4>-Footnote-1913374
Node: pickle<5>913417
Ref: whatsnew/3 3 pickle913514
Ref: a5d913514
Ref: pickle<5>-Footnote-1913782
Node: pydoc<4>913825
Ref: whatsnew/3 3 pydoc913921
Ref: a5f913921
Node: re<6>914118
Ref: whatsnew/3 3 re914210
Ref: a60914210
Ref: re<6>-Footnote-1914404
Node: sched914446
Ref: whatsnew/3 3 sched914539
Ref: a61914539
Ref: sched-Footnote-1915671
Ref: sched-Footnote-2915714
Ref: sched-Footnote-3915756
Ref: sched-Footnote-4915799
Ref: sched-Footnote-5915842
Node: select<2>915885
Ref: whatsnew/3 3 select915981
Ref: a66915981
Ref: select<2>-Footnote-1916244
Node: shlex<3>916286
Ref: whatsnew/3 3 shlex916386
Ref: a67916386
Node: shutil<4>916697
Ref: whatsnew/3 3 shutil916797
Ref: a69916797
Ref: shutil<4>-Footnote-1918667
Ref: shutil<4>-Footnote-2918710
Ref: shutil<4>-Footnote-3918753
Ref: shutil<4>-Footnote-4918796
Ref: shutil<4>-Footnote-5918839
Ref: shutil<4>-Footnote-6918882
Ref: shutil<4>-Footnote-7918925
Ref: shutil<4>-Footnote-8918967
Node: signal<3>919009
Ref: whatsnew/3 3 signal919109
Ref: a6d919109
Ref: signal<3>-Footnote-1920174
Node: smtpd<3>920216
Ref: whatsnew/3 3 smtpd920317
Ref: a74920317
Ref: smtpd<3>-Footnote-1920803
Ref: smtpd<3>-Footnote-2920852
Ref: smtpd<3>-Footnote-3920901
Node: smtplib<3>920943
Ref: whatsnew/3 3 smtplib921044
Ref: a75921044
Ref: smtplib<3>-Footnote-1921795
Ref: smtplib<3>-Footnote-2921838
Ref: smtplib<3>-Footnote-3921881
Node: socket<7>921923
Ref: whatsnew/3 3 socket922031
Ref: a7a922031
Ref: socket<7>-Footnote-1923273
Ref: socket<7>-Footnote-2923315
Ref: socket<7>-Footnote-3923358
Ref: socket<7>-Footnote-4923401
Node: socketserver<3>923444
Ref: whatsnew/3 3 socketserver923552
Ref: a7d923552
Ref: socketserver<3>-Footnote-1923925
Node: sqlite3<5>923968
Ref: whatsnew/3 3 sqlite3924073
Ref: a81924073
Ref: sqlite3<5>-Footnote-1924348
Node: ssl<8>924391
Ref: whatsnew/3 3 ssl924488
Ref: a83924488
Ref: ssl<8>-Footnote-1926705
Ref: ssl<8>-Footnote-2926748
Ref: ssl<8>-Footnote-3926791
Ref: ssl<8>-Footnote-4926834
Ref: ssl<8>-Footnote-5926877
Ref: ssl<8>-Footnote-6926920
Ref: ssl<8>-Footnote-7926963
Ref: ssl<8>-Footnote-8927006
Ref: ssl<8>-Footnote-9927049
Ref: ssl<8>-Footnote-10927092
Ref: ssl<8>-Footnote-11927136
Node: stat<2>927180
Ref: whatsnew/3 3 stat927276
Ref: a91927276
Ref: stat<2>-Footnote-1927571
Node: struct<3>927614
Ref: whatsnew/3 3 struct927717
Ref: a93927717
Ref: struct<3>-Footnote-1927964
Node: subprocess<5>928006
Ref: whatsnew/3 3 subprocess928108
Ref: a94928108
Ref: subprocess<5>-Footnote-1928443
Ref: subprocess<5>-Footnote-2928485
Node: sys<7>928527
Ref: whatsnew/3 3 sys928630
Ref: a96928630
Ref: sys<7>-Footnote-1928848
Node: tarfile<4>928891
Ref: whatsnew/3 3 tarfile928989
Ref: a99928989
Ref: tarfile<4>-Footnote-1929197
Node: tempfile929239
Ref: whatsnew/3 3 tempfile929342
Ref: a9a929342
Ref: tempfile-Footnote-1929569
Node: textwrap<2>929611
Ref: whatsnew/3 3 textwrap929716
Ref: a9c929716
Ref: textwrap<2>-Footnote-1929961
Node: threading<5>930004
Ref: whatsnew/3 3 threading930108
Ref: a9e930108
Ref: threading<5>-Footnote-1931039
Ref: threading<5>-Footnote-2931082
Node: time<5>931124
Ref: whatsnew/3 3 time931225
Ref: aa5931225
Ref: time<5>-Footnote-1932192
Ref: time<5>-Footnote-2932241
Node: types<4>932284
Ref: whatsnew/3 3 types932384
Ref: aaa932384
Ref: types<4>-Footnote-1932720
Ref: types<4>-Footnote-2932763
Ref: types<4>-Footnote-3932812
Node: unittest<5>932855
Ref: whatsnew/3 3 unittest932957
Ref: aae932957
Ref: unittest<5>-Footnote-1933370
Node: urllib<3>933413
Ref: whatsnew/3 3 urllib933517
Ref: ab5933517
Ref: urllib<3>-Footnote-1933869
Node: webbrowser933914
Ref: whatsnew/3 3 webbrowser934028
Ref: ab7934028
Ref: webbrowser-Footnote-1934570
Ref: webbrowser-Footnote-2934613
Node: xml etree ElementTree934656
Ref: whatsnew/3 3 xml-etree-elementtree934768
Ref: ab8934768
Node: zlib<2>935287
Ref: whatsnew/3 3 zlib935380
Ref: aba935380
Ref: zlib<2>-Footnote-1935852
Ref: zlib<2>-Footnote-2935895
Node: Optimizations<5>935938
Ref: whatsnew/3 3 optimizations936080
Ref: abd936080
Ref: Optimizations<5>-Footnote-1936891
Ref: Optimizations<5>-Footnote-2936940
Ref: Optimizations<5>-Footnote-3936983
Ref: Optimizations<5>-Footnote-4937026
Node: Build and C API Changes<4>937069
Ref: whatsnew/3 3 build-and-c-api-changes937205
Ref: 97b937205
Ref: Build and C API Changes<4>-Footnote-1939078
Ref: Build and C API Changes<4>-Footnote-2939127
Ref: Build and C API Changes<4>-Footnote-3939176
Node: Deprecated<5>939219
Ref: whatsnew/3 3 deprecated939360
Ref: adc939360
Node: Unsupported Operating Systems<2>939697
Ref: whatsnew/3 3 unsupported-operating-systems939838
Ref: add939838
Node: Deprecated Python modules functions and methods<4>940192
Ref: whatsnew/3 3 deprecated-python-modules-functions-and-methods940388
Ref: ade940388
Ref: Deprecated Python modules functions and methods<4>-Footnote-1942726
Ref: Deprecated Python modules functions and methods<4>-Footnote-2942768
Ref: Deprecated Python modules functions and methods<4>-Footnote-3942817
Ref: Deprecated Python modules functions and methods<4>-Footnote-4942860
Ref: Deprecated Python modules functions and methods<4>-Footnote-5942903
Node: Deprecated functions and types of the C API<3>942946
Ref: whatsnew/3 3 deprecated-functions-and-types-of-the-c-api943129
Ref: ae2943129
Ref: Deprecated functions and types of the C API<3>-Footnote-1946259
Node: Deprecated features946308
Ref: whatsnew/3 3 deprecated-features946432
Ref: b03946432
Node: Porting to Python 3 3946655
Ref: whatsnew/3 3 porting-to-python-3-3946761
Ref: b04946761
Node: Porting Python code947038
Ref: whatsnew/3 3 porting-python-code947138
Ref: 9a3947138
Ref: whatsnew/3 3 portingpythoncode947138
Ref: b05947138
Ref: Porting Python code-Footnote-1954166
Ref: Porting Python code-Footnote-2954209
Ref: Porting Python code-Footnote-3954252
Ref: Porting Python code-Footnote-4954295
Ref: Porting Python code-Footnote-5954344
Ref: Porting Python code-Footnote-6954393
Ref: Porting Python code-Footnote-7954435
Ref: Porting Python code-Footnote-8954480
Ref: Porting Python code-Footnote-9954523
Ref: Porting Python code-Footnote-10954565
Node: Porting C code954609
Ref: whatsnew/3 3 porting-c-code954739
Ref: 97c954739
Ref: Porting C code-Footnote-1956231
Node: Building C extensions956280
Ref: whatsnew/3 3 building-c-extensions956418
Ref: b15956418
Ref: Building C extensions-Footnote-1957016
Node: Command Line Switch Changes957059
Ref: whatsnew/3 3 command-line-switch-changes957174
Ref: b16957174
Ref: Command Line Switch Changes-Footnote-1957739
Ref: Command Line Switch Changes-Footnote-2957782
Node: What’s New In Python 3 2957825
Ref: whatsnew/3 2 doc957980
Ref: b18957980
Ref: whatsnew/3 2 what-s-new-in-python-3-2957980
Ref: b19957980
Ref: What’s New In Python 3 2-Footnote-1959328
Ref: What’s New In Python 3 2-Footnote-2959427
Node: PEP 384 Defining a Stable ABI959476
Ref: whatsnew/3 2 pep-384-defining-a-stable-abi959621
Ref: b1a959621
Ref: PEP 384 Defining a Stable ABI-Footnote-1960712
Node: PEP 389 Argparse Command Line Parsing Module960761
Ref: whatsnew/3 2 pep-389-argparse-command-line-parsing-module960965
Ref: b1b960965
Ref: PEP 389 Argparse Command Line Parsing Module-Footnote-1965091
Node: PEP 391 Dictionary Based Configuration for Logging965140
Ref: whatsnew/3 2 pep-391-dictionary-based-configuration-for-logging965353
Ref: b1d965353
Ref: PEP 391 Dictionary Based Configuration for Logging-Footnote-1967644
Node: PEP 3148 The concurrent futures module967693
Ref: whatsnew/3 2 pep-3148-the-concurrent-futures-module967897
Ref: b1f967897
Ref: PEP 3148 The concurrent futures module-Footnote-1970595
Node: PEP 3147 PYC Repository Directories970644
Ref: whatsnew/3 2 pep-3147-pyc-repository-directories970834
Ref: b24970834
Ref: PEP 3147 PYC Repository Directories-Footnote-1973963
Node: PEP 3149 ABI Version Tagged so Files974012
Ref: whatsnew/3 2 pep-3149-abi-version-tagged-so-files974215
Ref: b27974215
Ref: PEP 3149 ABI Version Tagged so Files-Footnote-1975473
Node: PEP 3333 Python Web Server Gateway Interface v1 0 1975522
Ref: whatsnew/3 2 pep-3333-python-web-server-gateway-interface-v1-0-1975715
Ref: b28975715
Ref: PEP 3333 Python Web Server Gateway Interface v1 0 1-Footnote-1978077
Ref: PEP 3333 Python Web Server Gateway Interface v1 0 1-Footnote-2978126
Ref: PEP 3333 Python Web Server Gateway Interface v1 0 1-Footnote-3978175
Node: Other Language Changes<7>978224
Ref: whatsnew/3 2 other-language-changes978416
Ref: b2b978416
Ref: Other Language Changes<7>-Footnote-1987932
Ref: Other Language Changes<7>-Footnote-2987974
Ref: Other Language Changes<7>-Footnote-3988016
Ref: Other Language Changes<7>-Footnote-4988061
Ref: Other Language Changes<7>-Footnote-5988103
Ref: Other Language Changes<7>-Footnote-6988145
Ref: Other Language Changes<7>-Footnote-7988187
Ref: Other Language Changes<7>-Footnote-8988229
Ref: Other Language Changes<7>-Footnote-9988271
Ref: Other Language Changes<7>-Footnote-10988313
Ref: Other Language Changes<7>-Footnote-11988357
Ref: Other Language Changes<7>-Footnote-12988402
Ref: Other Language Changes<7>-Footnote-13988445
Ref: Other Language Changes<7>-Footnote-14988488
Ref: Other Language Changes<7>-Footnote-15988532
Ref: Other Language Changes<7>-Footnote-16988576
Node: New Improved and Deprecated Modules988619
Ref: whatsnew/3 2 new-improved-and-deprecated-modules988775
Ref: b38988775
Node: email<5>990801
Ref: whatsnew/3 2 email990901
Ref: b39990901
Ref: email<5>-Footnote-1992875
Ref: email<5>-Footnote-2992924
Ref: email<5>-Footnote-3992966
Node: elementtree993009
Ref: whatsnew/3 2 elementtree993130
Ref: b41993130
Ref: elementtree-Footnote-1994608
Ref: elementtree-Footnote-2994664
Node: functools<6>994706
Ref: whatsnew/3 2 functools994831
Ref: b48994831
Ref: functools<6>-Footnote-1998348
Ref: functools<6>-Footnote-2998400
Ref: functools<6>-Footnote-3998452
Ref: functools<6>-Footnote-4998495
Ref: functools<6>-Footnote-5998538
Ref: functools<6>-Footnote-6998580
Ref: functools<6>-Footnote-7998622
Ref: functools<6>-Footnote-8998664
Node: itertools<4>998716
Ref: whatsnew/3 2 itertools998844
Ref: b4a998844
Node: collections<8>999534
Ref: whatsnew/3 2 collections999662
Ref: b4c999662
Ref: collections<8>-Footnote-11001904
Ref: collections<8>-Footnote-21001964
Node: threading<6>1002011
Ref: whatsnew/3 2 threading1002144
Ref: b511002144
Ref: threading<6>-Footnote-11004905
Ref: threading<6>-Footnote-21004966
Ref: threading<6>-Footnote-31005064
Ref: threading<6>-Footnote-41005136
Node: datetime and time1005178
Ref: whatsnew/3 2 datetime-and-time1005304
Ref: b551005304
Ref: datetime and time-Footnote-11008092
Ref: datetime and time-Footnote-21008137
Ref: datetime and time-Footnote-31008179
Ref: datetime and time-Footnote-41008221
Ref: datetime and time-Footnote-51008263
Ref: datetime and time-Footnote-61008308
Ref: datetime and time-Footnote-71008350
Node: math<6>1008393
Ref: whatsnew/3 2 math1008513
Ref: b591008513
Ref: math<6>-Footnote-11010390
Node: abc<3>1010443
Ref: whatsnew/3 2 abc1010551
Ref: b5e1010551
Ref: abc<3>-Footnote-11011173
Node: io<5>1011215
Ref: whatsnew/3 2 io1011323
Ref: b5f1011323
Ref: io<5>-Footnote-11012488
Node: reprlib1012530
Ref: whatsnew/3 2 reprlib1012642
Ref: b611012642
Ref: reprlib-Footnote-11013630
Ref: reprlib-Footnote-21013672
Node: logging<7>1013714
Ref: whatsnew/3 2 logging1013827
Ref: b641013827
Node: csv<3>1015678
Ref: whatsnew/3 2 csv1015797
Ref: b6b1015797
Ref: csv<3>-Footnote-11016658
Ref: csv<3>-Footnote-21016700
Node: contextlib<6>1016745
Ref: whatsnew/3 2 contextlib1016875
Ref: b6f1016875
Ref: contextlib<6>-Footnote-11019088
Node: decimal and fractions1019130
Ref: whatsnew/3 2 decimal-and-fractions1019257
Ref: b721019257
Ref: decimal and fractions-Footnote-11021696
Ref: decimal and fractions-Footnote-21021738
Ref: decimal and fractions-Footnote-31021780
Ref: decimal and fractions-Footnote-41021822
Ref: decimal and fractions-Footnote-51021864
Ref: decimal and fractions-Footnote-61021906
Node: ftp1021948
Ref: whatsnew/3 2 ftp1022067
Ref: b761022067
Ref: ftp-Footnote-11023409
Ref: ftp-Footnote-21023451
Ref: ftp-Footnote-31023493
Ref: ftp-Footnote-41023535
Node: popen1023577
Ref: whatsnew/3 2 popen1023684
Ref: b771023684
Ref: popen-Footnote-11023989
Ref: popen-Footnote-21024031
Node: select<3>1024074
Ref: whatsnew/3 2 select1024194
Ref: b781024194
Ref: select<3>-Footnote-11024643
Node: gzip and zipfile1024685
Ref: whatsnew/3 2 gzip-and-zipfile1024810
Ref: b7a1024810
Ref: gzip and zipfile-Footnote-11026365
Ref: gzip and zipfile-Footnote-21026407
Ref: gzip and zipfile-Footnote-31026449
Ref: gzip and zipfile-Footnote-41026494
Ref: gzip and zipfile-Footnote-51026536
Ref: gzip and zipfile-Footnote-61026578
Node: tarfile<5>1026620
Ref: whatsnew/3 2 tarfile1026746
Ref: b7e1026746
Ref: tarfile<5>-Footnote-11028317
Node: hashlib<3>1028359
Ref: whatsnew/3 2 hashlib1028475
Ref: b811028475
Ref: hashlib<3>-Footnote-11029230
Node: ast<3>1029272
Ref: whatsnew/3 2 ast1029383
Ref: b821029383
Node: os<8>1030320
Ref: whatsnew/3 2 os1030430
Ref: b841030430
Node: shutil<5>1031199
Ref: whatsnew/3 2 shutil1031313
Ref: b881031313
Node: sqlite3<6>1033480
Ref: whatsnew/3 2 sqlite31033596
Ref: b8b1033596
Ref: sqlite3<6>-Footnote-11034245
Node: html<3>1034287
Ref: whatsnew/3 2 html1034403
Ref: b8e1034403
Node: socket<8>1034689
Ref: whatsnew/3 2 socket1034801
Ref: b8f1034801
Ref: socket<8>-Footnote-11035443
Ref: socket<8>-Footnote-21035485
Node: ssl<9>1035527
Ref: whatsnew/3 2 ssl1035636
Ref: b921035636
Ref: ssl<9>-Footnote-11037738
Ref: ssl<9>-Footnote-21037787
Ref: ssl<9>-Footnote-31037872
Ref: ssl<9>-Footnote-41037914
Ref: ssl<9>-Footnote-51037956
Ref: ssl<9>-Footnote-61037998
Ref: ssl<9>-Footnote-71038040
Ref: ssl<9>-Footnote-81038082
Ref: ssl<9>-Footnote-91038124
Node: nntp1038166
Ref: whatsnew/3 2 nntp1038278
Ref: b971038278
Ref: nntp-Footnote-11038848
Ref: nntp-Footnote-21038890
Node: certificates1038932
Ref: whatsnew/3 2 certificates1039048
Ref: b9a1039048
Ref: certificates-Footnote-11039443
Node: imaplib<3>1039485
Ref: whatsnew/3 2 imaplib1039611
Ref: b9c1039611
Ref: imaplib<3>-Footnote-11039882
Node: http client<4>1039924
Ref: whatsnew/3 2 http-client1040049
Ref: b9e1040049
Ref: http client<4>-Footnote-11041471
Node: unittest<6>1041514
Ref: whatsnew/3 2 unittest1041638
Ref: ba11041638
Ref: unittest<6>-Footnote-11046419
Ref: unittest<6>-Footnote-21046462
Ref: unittest<6>-Footnote-31046504
Node: random<2>1046546
Ref: whatsnew/3 2 random1046665
Ref: bad1046665
Ref: random<2>-Footnote-11047327
Node: poplib<3>1047369
Ref: whatsnew/3 2 poplib1047488
Ref: bb31047488
Ref: poplib<3>-Footnote-11047840
Node: asyncore<2>1047882
Ref: whatsnew/3 2 asyncore1048003
Ref: bb51048003
Ref: asyncore<2>-Footnote-11048479
Node: tempfile<2>1048521
Ref: whatsnew/3 2 tempfile1048643
Ref: bba1048643
Ref: tempfile<2>-Footnote-11049050
Node: inspect<6>1049092
Ref: whatsnew/3 2 inspect1049211
Ref: bbc1049211
Ref: inspect<6>-Footnote-11050569
Node: pydoc<5>1050612
Ref: whatsnew/3 2 pydoc1050726
Ref: bbf1050726
Ref: pydoc<5>-Footnote-11051043
Node: dis<3>1051085
Ref: whatsnew/3 2 dis1051195
Ref: bc01051195
Ref: dis<3>-Footnote-11053343
Node: dbm<6>1053385
Ref: whatsnew/3 2 dbm1053496
Ref: bc21053496
Ref: dbm<6>-Footnote-11053683
Node: ctypes<2>1053725
Ref: whatsnew/3 2 ctypes1053837
Ref: bc31053837
Node: site<2>1053953
Ref: whatsnew/3 2 site1054071
Ref: bc51054071
Ref: site<2>-Footnote-11055300
Node: sysconfig<2>1055342
Ref: whatsnew/3 2 sysconfig1055457
Ref: bc91055457
Node: pdb<5>1057686
Ref: whatsnew/3 2 pdb1057809
Ref: bcd1057809
Node: configparser<2>1058707
Ref: whatsnew/3 2 configparser1058833
Ref: bce1058833
Node: urllib parse<2>1061697
Ref: whatsnew/3 2 urllib-parse1061824
Ref: bd01061824
Ref: urllib parse<2>-Footnote-11063898
Ref: urllib parse<2>-Footnote-21063941
Ref: urllib parse<2>-Footnote-31063990
Ref: urllib parse<2>-Footnote-41064032
Ref: urllib parse<2>-Footnote-51064074
Node: mailbox1064116
Ref: whatsnew/3 2 mailbox1064238
Ref: bd41064238
Ref: mailbox-Footnote-11065810
Node: turtledemo1065852
Ref: whatsnew/3 2 turtledemo1065950
Ref: bdb1065950
Ref: turtledemo-Footnote-11066385
Node: Multi-threading1066428
Ref: whatsnew/3 2 multi-threading1066575
Ref: bdc1066575
Ref: Multi-threading-Footnote-11068230
Ref: Multi-threading-Footnote-21068309
Ref: Multi-threading-Footnote-31068351
Ref: Multi-threading-Footnote-41068395
Node: Optimizations<6>1068437
Ref: whatsnew/3 2 optimizations1068556
Ref: be01068556
Ref: Optimizations<6>-Footnote-11071995
Ref: Optimizations<6>-Footnote-21072037
Ref: Optimizations<6>-Footnote-31072079
Ref: Optimizations<6>-Footnote-41072121
Ref: Optimizations<6>-Footnote-51072167
Ref: Optimizations<6>-Footnote-61072209
Ref: Optimizations<6>-Footnote-71072251
Ref: Optimizations<6>-Footnote-81072294
Ref: Optimizations<6>-Footnote-91072336
Ref: Optimizations<6>-Footnote-101072378
Ref: Optimizations<6>-Footnote-111072421
Ref: Optimizations<6>-Footnote-121072464
Ref: Optimizations<6>-Footnote-131072507
Ref: Optimizations<6>-Footnote-141072553
Ref: Optimizations<6>-Footnote-151072596
Ref: Optimizations<6>-Footnote-161072640
Node: Unicode1072683
Ref: whatsnew/3 2 unicode1072793
Ref: be31072793
Ref: Unicode-Footnote-11073343
Ref: Unicode-Footnote-21073393
Ref: Unicode-Footnote-31073437
Node: Codecs1073508
Ref: whatsnew/3 2 codecs1073615
Ref: be41073615
Ref: Codecs-Footnote-11074544
Node: Documentation1074589
Ref: whatsnew/3 2 documentation1074693
Ref: be51074693
Ref: Documentation-Footnote-11076337
Ref: Documentation-Footnote-21076405
Ref: Documentation-Footnote-31076481
Ref: Documentation-Footnote-41076523
Node: IDLE1076565
Ref: whatsnew/3 2 idle1076678
Ref: be91076678
Ref: IDLE-Footnote-11077062
Ref: IDLE-Footnote-21077104
Node: Code Repository1077146
Ref: whatsnew/3 2 code-repository1077272
Ref: bea1077272
Ref: Code Repository-Footnote-11077878
Ref: Code Repository-Footnote-21077917
Ref: Code Repository-Footnote-31077966
Ref: Code Repository-Footnote-41078020
Node: Build and C API Changes<5>1078064
Ref: whatsnew/3 2 build-and-c-api-changes1078207
Ref: beb1078207
Ref: Build and C API Changes<5>-Footnote-11082344
Ref: Build and C API Changes<5>-Footnote-21082387
Ref: Build and C API Changes<5>-Footnote-31082429
Ref: Build and C API Changes<5>-Footnote-41082471
Ref: Build and C API Changes<5>-Footnote-51082513
Ref: Build and C API Changes<5>-Footnote-61082555
Ref: Build and C API Changes<5>-Footnote-71082597
Ref: Build and C API Changes<5>-Footnote-81082639
Ref: Build and C API Changes<5>-Footnote-91082681
Ref: Build and C API Changes<5>-Footnote-101082723
Ref: Build and C API Changes<5>-Footnote-111082766
Ref: Build and C API Changes<5>-Footnote-121082809
Ref: Build and C API Changes<5>-Footnote-131082852
Ref: Build and C API Changes<5>-Footnote-141082914
Ref: Build and C API Changes<5>-Footnote-151082994
Node: Porting to Python 3 21083051
Ref: whatsnew/3 2 porting-to-python-3-21083170
Ref: bf41083170
Ref: Porting to Python 3 2-Footnote-11090013
Ref: Porting to Python 3 2-Footnote-21090055
Ref: Porting to Python 3 2-Footnote-31090097
Ref: Porting to Python 3 2-Footnote-41090142
Ref: Porting to Python 3 2-Footnote-51090185
Ref: Porting to Python 3 2-Footnote-61090228
Ref: Porting to Python 3 2-Footnote-71090271
Node: What’s New In Python 3 11090313
Ref: whatsnew/3 1 doc1090468
Ref: c061090468
Ref: whatsnew/3 1 what-s-new-in-python-3-11090468
Ref: c071090468
Node: PEP 372 Ordered Dictionaries1091094
Ref: whatsnew/3 1 pep-372-ordered-dictionaries1091242
Ref: c081091242
Ref: PEP 372 Ordered Dictionaries-Footnote-11092791
Ref: PEP 372 Ordered Dictionaries-Footnote-21092818
Node: PEP 378 Format Specifier for Thousands Separator1092867
Ref: whatsnew/3 1 pep-378-format-specifier-for-thousands-separator1093049
Ref: c091093049
Ref: PEP 378 Format Specifier for Thousands Separator-Footnote-11094288
Node: Other Language Changes<8>1094337
Ref: whatsnew/3 1 other-language-changes1094529
Ref: c0a1094529
Ref: Other Language Changes<8>-Footnote-11099326
Ref: Other Language Changes<8>-Footnote-21099371
Ref: Other Language Changes<8>-Footnote-31099413
Ref: Other Language Changes<8>-Footnote-41099455
Ref: Other Language Changes<8>-Footnote-51099497
Ref: Other Language Changes<8>-Footnote-61099542
Ref: Other Language Changes<8>-Footnote-71099584
Node: New Improved and Deprecated Modules<2>1099626
Ref: whatsnew/3 1 new-improved-and-deprecated-modules1099786
Ref: c0b1099786
Ref: New Improved and Deprecated Modules<2>-Footnote-11108314
Ref: New Improved and Deprecated Modules<2>-Footnote-21108359
Ref: New Improved and Deprecated Modules<2>-Footnote-31108401
Ref: New Improved and Deprecated Modules<2>-Footnote-41108443
Ref: New Improved and Deprecated Modules<2>-Footnote-51108485
Ref: New Improved and Deprecated Modules<2>-Footnote-61108527
Ref: New Improved and Deprecated Modules<2>-Footnote-71108576
Ref: New Improved and Deprecated Modules<2>-Footnote-81108618
Ref: New Improved and Deprecated Modules<2>-Footnote-91108660
Ref: New Improved and Deprecated Modules<2>-Footnote-101108702
Ref: New Improved and Deprecated Modules<2>-Footnote-111108745
Ref: New Improved and Deprecated Modules<2>-Footnote-121108788
Ref: New Improved and Deprecated Modules<2>-Footnote-131108831
Node: Optimizations<7>1108874
Ref: whatsnew/3 1 optimizations1109016
Ref: c111109016
Ref: Optimizations<7>-Footnote-11111193
Ref: Optimizations<7>-Footnote-21111242
Ref: Optimizations<7>-Footnote-31111284
Ref: Optimizations<7>-Footnote-41111326
Ref: Optimizations<7>-Footnote-51111368
Ref: Optimizations<7>-Footnote-61111393
Ref: Optimizations<7>-Footnote-71111435
Node: IDLE<2>1111477
Ref: whatsnew/3 1 idle1111607
Ref: c121111607
Ref: IDLE<2>-Footnote-11111822
Node: Build and C API Changes<6>1111864
Ref: whatsnew/3 1 build-and-c-api-changes1111999
Ref: c131111999
Ref: Build and C API Changes<6>-Footnote-11114224
Ref: Build and C API Changes<6>-Footnote-21114266
Ref: Build and C API Changes<6>-Footnote-31114308
Ref: Build and C API Changes<6>-Footnote-41114350
Ref: Build and C API Changes<6>-Footnote-51114392
Node: Porting to Python 3 11114434
Ref: whatsnew/3 1 porting-to-python-3-11114553
Ref: c171114553
Node: What’s New In Python 3 01115683
Ref: whatsnew/3 0 doc1115838
Ref: c181115838
Ref: whatsnew/3 0 what-s-new-in-python-3-01115838
Ref: c191115838
Node: Common Stumbling Blocks1117649
Ref: whatsnew/3 0 common-stumbling-blocks1117770
Ref: c1a1117770
Node: Print Is A Function1118138
Ref: whatsnew/3 0 print-is-a-function1118262
Ref: c1b1118262
Ref: Print Is A Function-Footnote-11119946
Node: Views And Iterators Instead Of Lists1119995
Ref: whatsnew/3 0 views-and-iterators-instead-of-lists1120148
Ref: c1c1120148
Node: Ordering Comparisons1121988
Ref: whatsnew/3 0 ordering-comparisons1122130
Ref: c261122130
Node: Integers1123581
Ref: whatsnew/3 0 integers1123727
Ref: c281123727
Ref: Integers-Footnote-11124949
Ref: Integers-Footnote-21124998
Node: Text Vs Data Instead Of Unicode Vs 8-bit1125047
Ref: whatsnew/3 0 text-vs-data-instead-of-unicode-vs-8-bit1125164
Ref: c291125164
Ref: Text Vs Data Instead Of Unicode Vs 8-bit-Footnote-11131748
Ref: Text Vs Data Instead Of Unicode Vs 8-bit-Footnote-21131797
Ref: Text Vs Data Instead Of Unicode Vs 8-bit-Footnote-31131846
Node: Overview Of Syntax Changes1131895
Ref: whatsnew/3 0 overview-of-syntax-changes1132062
Ref: c301132062
Node: New Syntax1132272
Ref: whatsnew/3 0 new-syntax1132368
Ref: c311132368
Ref: New Syntax-Footnote-11134914
Ref: New Syntax-Footnote-21134963
Ref: New Syntax-Footnote-31135012
Ref: New Syntax-Footnote-41135061
Ref: New Syntax-Footnote-51135110
Node: Changed Syntax1135159
Ref: whatsnew/3 0 changed-syntax1135278
Ref: c341135278
Ref: Changed Syntax-Footnote-11136971
Ref: Changed Syntax-Footnote-21137020
Ref: Changed Syntax-Footnote-31137069
Ref: Changed Syntax-Footnote-41137118
Node: Removed Syntax1137167
Ref: whatsnew/3 0 removed-syntax1137267
Ref: c361137267
Ref: Removed Syntax-Footnote-11138457
Ref: Removed Syntax-Footnote-21138506
Node: Changes Already Present In Python 2 61138555
Ref: whatsnew/3 0 changes-already-present-in-python-2-61138714
Ref: c391138714
Node: Library Changes1142551
Ref: whatsnew/3 0 library-changes1142728
Ref: c4c1142728
Ref: Library Changes-Footnote-11148956
Ref: Library Changes-Footnote-21149005
Ref: Library Changes-Footnote-31149054
Ref: Library Changes-Footnote-41149103
Ref: Library Changes-Footnote-51149152
Ref: Library Changes-Footnote-61149201
Node: PEP 3101 A New Approach To String Formatting1149250
Ref: whatsnew/3 0 pep-3101-a-new-approach-to-string-formatting1149411
Ref: c501149411
Ref: PEP 3101 A New Approach To String Formatting-Footnote-11149803
Node: Changes To Exceptions1149852
Ref: whatsnew/3 0 changes-to-exceptions1150025
Ref: c511150025
Ref: Changes To Exceptions-Footnote-11153529
Ref: Changes To Exceptions-Footnote-21153578
Ref: Changes To Exceptions-Footnote-31153627
Ref: Changes To Exceptions-Footnote-41153676
Ref: Changes To Exceptions-Footnote-51153725
Node: Miscellaneous Other Changes1153774
Ref: whatsnew/3 0 miscellaneous-other-changes1153929
Ref: c531153929
Node: Operators And Special Methods1154055
Ref: whatsnew/3 0 operators-and-special-methods1154165
Ref: c541154165
Ref: Operators And Special Methods-Footnote-11155805
Node: Builtins1155854
Ref: whatsnew/3 0 builtins1155964
Ref: c5c1155964
Ref: Builtins-Footnote-11158435
Ref: Builtins-Footnote-21158484
Node: Build and C API Changes<7>1158533
Ref: whatsnew/3 0 build-and-c-api-changes1158678
Ref: c641158678
Ref: Build and C API Changes<7>-Footnote-11159711
Ref: Build and C API Changes<7>-Footnote-21159760
Ref: Build and C API Changes<7>-Footnote-31159809
Node: Performance1159858
Ref: whatsnew/3 0 performance1159997
Ref: c671159997
Node: Porting To Python 3 01160316
Ref: whatsnew/3 0 porting-to-python-3-01160420
Ref: c681160420
Node: What’s New in Python 2 71162021
Ref: whatsnew/2 7 doc1162176
Ref: c6b1162176
Ref: whatsnew/2 7 what-s-new-in-python-2-71162176
Ref: c6c1162176
Node: The Future for Python 2 x1164639
Ref: whatsnew/2 7 the-future-for-python-2-x1164783
Ref: c6d1164783
Ref: whatsnew/2 7 whatsnew27-python311164783
Ref: c6e1164783
Ref: The Future for Python 2 x-Footnote-11168130
Ref: The Future for Python 2 x-Footnote-21168179
Node: Changes to the Handling of Deprecation Warnings1168216
Ref: whatsnew/2 7 changes-to-the-handling-of-deprecation-warnings1168388
Ref: c711168388
Ref: Changes to the Handling of Deprecation Warnings-Footnote-11169963
Node: Python 3 1 Features1170005
Ref: whatsnew/2 7 python-3-1-features1170203
Ref: c721170203
Node: PEP 372 Adding an Ordered Dictionary to collections1172122
Ref: whatsnew/2 7 pep-03721172324
Ref: c731172324
Ref: whatsnew/2 7 pep-372-adding-an-ordered-dictionary-to-collections1172324
Ref: c761172324
Ref: PEP 372 Adding an Ordered Dictionary to collections-Footnote-11175928
Ref: PEP 372 Adding an Ordered Dictionary to collections-Footnote-21175955
Node: PEP 378 Format Specifier for Thousands Separator<2>1176004
Ref: whatsnew/2 7 pep-03781176240
Ref: c741176240
Ref: whatsnew/2 7 pep-378-format-specifier-for-thousands-separator1176240
Ref: c781176240
Ref: PEP 378 Format Specifier for Thousands Separator<2>-Footnote-11177757
Node: PEP 389 The argparse Module for Parsing Command Lines1177806
Ref: whatsnew/2 7 pep-389-the-argparse-module-for-parsing-command-lines1178041
Ref: c791178041
Ref: PEP 389 The argparse Module for Parsing Command Lines-Footnote-11182065
Node: PEP 391 Dictionary-Based Configuration For Logging1182114
Ref: whatsnew/2 7 pep-391-dictionary-based-configuration-for-logging1182323
Ref: c7a1182323
Ref: PEP 391 Dictionary-Based Configuration For Logging-Footnote-11186191
Node: PEP 3106 Dictionary Views1186240
Ref: whatsnew/2 7 pep-3106-dictionary-views1186426
Ref: c801186426
Ref: PEP 3106 Dictionary Views-Footnote-11188543
Ref: PEP 3106 Dictionary Views-Footnote-21188592
Node: PEP 3137 The memoryview Object1188634
Ref: whatsnew/2 7 pep-3137-the-memoryview-object1188795
Ref: c811188795
Ref: PEP 3137 The memoryview Object-Footnote-11190460
Ref: PEP 3137 The memoryview Object-Footnote-21190509
Node: Other Language Changes<9>1190551
Ref: whatsnew/2 7 other-language-changes1190711
Ref: c821190711
Ref: Other Language Changes<9>-Footnote-11200667
Ref: Other Language Changes<9>-Footnote-21200709
Ref: Other Language Changes<9>-Footnote-31200751
Ref: Other Language Changes<9>-Footnote-41200793
Ref: Other Language Changes<9>-Footnote-51200835
Ref: Other Language Changes<9>-Footnote-61200877
Ref: Other Language Changes<9>-Footnote-71200919
Ref: Other Language Changes<9>-Footnote-81200961
Ref: Other Language Changes<9>-Footnote-91201003
Ref: Other Language Changes<9>-Footnote-101201045
Ref: Other Language Changes<9>-Footnote-111201088
Ref: Other Language Changes<9>-Footnote-121201131
Ref: Other Language Changes<9>-Footnote-131201174
Ref: Other Language Changes<9>-Footnote-141201217
Ref: Other Language Changes<9>-Footnote-151201263
Ref: Other Language Changes<9>-Footnote-161201306
Ref: Other Language Changes<9>-Footnote-171201349
Ref: Other Language Changes<9>-Footnote-181201392
Ref: Other Language Changes<9>-Footnote-191201438
Ref: Other Language Changes<9>-Footnote-201201481
Ref: Other Language Changes<9>-Footnote-211201524
Ref: Other Language Changes<9>-Footnote-221201567
Ref: Other Language Changes<9>-Footnote-231201610
Ref: Other Language Changes<9>-Footnote-241201653
Node: Interpreter Changes1201696
Ref: whatsnew/2 7 interpreter-changes1201802
Ref: c851201802
Ref: whatsnew/2 7 new-27-interpreter1201802
Ref: c861201802
Ref: Interpreter Changes-Footnote-11202456
Node: Optimizations<8>1202498
Ref: whatsnew/2 7 optimizations1202604
Ref: c871202604
Ref: Optimizations<8>-Footnote-11207451
Ref: Optimizations<8>-Footnote-21207493
Ref: Optimizations<8>-Footnote-31207535
Ref: Optimizations<8>-Footnote-41207577
Ref: Optimizations<8>-Footnote-51207619
Ref: Optimizations<8>-Footnote-61207661
Ref: Optimizations<8>-Footnote-71207706
Ref: Optimizations<8>-Footnote-81207748
Ref: Optimizations<8>-Footnote-91207790
Ref: Optimizations<8>-Footnote-101207832
Ref: Optimizations<8>-Footnote-111207875
Ref: Optimizations<8>-Footnote-121207918
Ref: Optimizations<8>-Footnote-131207961
Node: New and Improved Modules1208004
Ref: whatsnew/2 7 new-and-improved-modules1208160
Ref: c8a1208160
Ref: New and Improved Modules-Footnote-11243336
Ref: New and Improved Modules-Footnote-21243378
Ref: New and Improved Modules-Footnote-31243420
Ref: New and Improved Modules-Footnote-41243473
Ref: New and Improved Modules-Footnote-51243515
Ref: New and Improved Modules-Footnote-61243557
Ref: New and Improved Modules-Footnote-71243602
Ref: New and Improved Modules-Footnote-81243644
Ref: New and Improved Modules-Footnote-91243686
Ref: New and Improved Modules-Footnote-101243728
Ref: New and Improved Modules-Footnote-111243771
Ref: New and Improved Modules-Footnote-121243814
Ref: New and Improved Modules-Footnote-131243857
Ref: New and Improved Modules-Footnote-141243897
Ref: New and Improved Modules-Footnote-151243940
Ref: New and Improved Modules-Footnote-161243983
Ref: New and Improved Modules-Footnote-171244026
Ref: New and Improved Modules-Footnote-181244069
Ref: New and Improved Modules-Footnote-191244112
Ref: New and Improved Modules-Footnote-201244155
Ref: New and Improved Modules-Footnote-211244198
Ref: New and Improved Modules-Footnote-221244241
Ref: New and Improved Modules-Footnote-231244284
Ref: New and Improved Modules-Footnote-241244327
Ref: New and Improved Modules-Footnote-251244370
Ref: New and Improved Modules-Footnote-261244413
Ref: New and Improved Modules-Footnote-271244459
Ref: New and Improved Modules-Footnote-281244502
Ref: New and Improved Modules-Footnote-291244545
Ref: New and Improved Modules-Footnote-301244588
Ref: New and Improved Modules-Footnote-311244631
Ref: New and Improved Modules-Footnote-321244674
Ref: New and Improved Modules-Footnote-331244717
Ref: New and Improved Modules-Footnote-341244760
Ref: New and Improved Modules-Footnote-351244803
Ref: New and Improved Modules-Footnote-361244846
Ref: New and Improved Modules-Footnote-371244889
Ref: New and Improved Modules-Footnote-381244932
Ref: New and Improved Modules-Footnote-391244975
Ref: New and Improved Modules-Footnote-401245018
Ref: New and Improved Modules-Footnote-411245061
Ref: New and Improved Modules-Footnote-421245104
Ref: New and Improved Modules-Footnote-431245147
Ref: New and Improved Modules-Footnote-441245190
Ref: New and Improved Modules-Footnote-451245233
Ref: New and Improved Modules-Footnote-461245276
Ref: New and Improved Modules-Footnote-471245319
Ref: New and Improved Modules-Footnote-481245362
Ref: New and Improved Modules-Footnote-491245408
Ref: New and Improved Modules-Footnote-501245451
Ref: New and Improved Modules-Footnote-511245494
Ref: New and Improved Modules-Footnote-521245537
Ref: New and Improved Modules-Footnote-531245580
Ref: New and Improved Modules-Footnote-541245623
Ref: New and Improved Modules-Footnote-551245666
Ref: New and Improved Modules-Footnote-561245709
Ref: New and Improved Modules-Footnote-571245752
Ref: New and Improved Modules-Footnote-581245795
Ref: New and Improved Modules-Footnote-591245838
Ref: New and Improved Modules-Footnote-601245881
Ref: New and Improved Modules-Footnote-611245924
Ref: New and Improved Modules-Footnote-621245967
Ref: New and Improved Modules-Footnote-631246010
Ref: New and Improved Modules-Footnote-641246053
Ref: New and Improved Modules-Footnote-651246096
Ref: New and Improved Modules-Footnote-661246139
Ref: New and Improved Modules-Footnote-671246182
Ref: New and Improved Modules-Footnote-681246225
Ref: New and Improved Modules-Footnote-691246268
Ref: New and Improved Modules-Footnote-701246314
Ref: New and Improved Modules-Footnote-711246357
Ref: New and Improved Modules-Footnote-721246400
Ref: New and Improved Modules-Footnote-731246486
Ref: New and Improved Modules-Footnote-741246529
Ref: New and Improved Modules-Footnote-751246572
Ref: New and Improved Modules-Footnote-761246615
Ref: New and Improved Modules-Footnote-771246658
Ref: New and Improved Modules-Footnote-781246701
Ref: New and Improved Modules-Footnote-791246747
Ref: New and Improved Modules-Footnote-801246790
Ref: New and Improved Modules-Footnote-811246833
Ref: New and Improved Modules-Footnote-821246876
Ref: New and Improved Modules-Footnote-831246919
Ref: New and Improved Modules-Footnote-841246962
Ref: New and Improved Modules-Footnote-851247005
Ref: New and Improved Modules-Footnote-861247051
Ref: New and Improved Modules-Footnote-871247097
Ref: New and Improved Modules-Footnote-881247140
Ref: New and Improved Modules-Footnote-891247190
Ref: New and Improved Modules-Footnote-901247240
Ref: New and Improved Modules-Footnote-911247283
Ref: New and Improved Modules-Footnote-921247326
Ref: New and Improved Modules-Footnote-931247369
Ref: New and Improved Modules-Footnote-941247412
Ref: New and Improved Modules-Footnote-951247455
Ref: New and Improved Modules-Footnote-961247498
Ref: New and Improved Modules-Footnote-971247541
Node: New module importlib1247584
Ref: whatsnew/2 7 importlib-section1247694
Ref: c751247694
Ref: whatsnew/2 7 new-module-importlib1247694
Ref: caf1247694
Node: New module sysconfig1249234
Ref: whatsnew/2 7 new-module-sysconfig1249378
Ref: cb01249378
Node: ttk Themed Widgets for Tk1250704
Ref: whatsnew/2 7 ttk-themed-widgets-for-tk1250851
Ref: cb31250851
Ref: ttk Themed Widgets for Tk-Footnote-11251923
Ref: ttk Themed Widgets for Tk-Footnote-21251965
Node: Updated module unittest1252007
Ref: whatsnew/2 7 unittest-section1252164
Ref: cb41252164
Ref: whatsnew/2 7 updated-module-unittest1252164
Ref: cb51252164
Ref: Updated module unittest-Footnote-11261019
Ref: Updated module unittest-Footnote-21261045
Ref: Updated module unittest-Footnote-31261082
Ref: Updated module unittest-Footnote-41261124
Ref: Updated module unittest-Footnote-51261166
Ref: Updated module unittest-Footnote-61261211
Ref: Updated module unittest-Footnote-71261253
Ref: Updated module unittest-Footnote-81261295
Ref: Updated module unittest-Footnote-91261337
Ref: Updated module unittest-Footnote-101261379
Ref: Updated module unittest-Footnote-111261422
Ref: Updated module unittest-Footnote-121261465
Ref: Updated module unittest-Footnote-131261508
Ref: Updated module unittest-Footnote-141261551
Node: Updated module ElementTree 1 31261594
Ref: whatsnew/2 7 elementtree-section1261717
Ref: cd81261717
Ref: whatsnew/2 7 updated-module-elementtree-1-31261717
Ref: cd91261717
Ref: Updated module ElementTree 1 3-Footnote-11265672
Node: Build and C API Changes<8>1265714
Ref: whatsnew/2 7 build-and-c-api-changes1265868
Ref: cdb1265868
Ref: Build and C API Changes<8>-Footnote-11274539
Ref: Build and C API Changes<8>-Footnote-21274609
Ref: Build and C API Changes<8>-Footnote-31274651
Ref: Build and C API Changes<8>-Footnote-41274693
Ref: Build and C API Changes<8>-Footnote-51274735
Ref: Build and C API Changes<8>-Footnote-61274777
Ref: Build and C API Changes<8>-Footnote-71274819
Ref: Build and C API Changes<8>-Footnote-81274861
Ref: Build and C API Changes<8>-Footnote-91274930
Ref: Build and C API Changes<8>-Footnote-101274972
Ref: Build and C API Changes<8>-Footnote-111275015
Ref: Build and C API Changes<8>-Footnote-121275058
Ref: Build and C API Changes<8>-Footnote-131275101
Ref: Build and C API Changes<8>-Footnote-141275147
Ref: Build and C API Changes<8>-Footnote-151275193
Ref: Build and C API Changes<8>-Footnote-161275236
Ref: Build and C API Changes<8>-Footnote-171275279
Ref: Build and C API Changes<8>-Footnote-181275322
Ref: Build and C API Changes<8>-Footnote-191275365
Ref: Build and C API Changes<8>-Footnote-201275408
Ref: Build and C API Changes<8>-Footnote-211275454
Ref: Build and C API Changes<8>-Footnote-221275497
Node: Capsules1275540
Ref: whatsnew/2 7 capsules1275649
Ref: ce11275649
Ref: whatsnew/2 7 whatsnew27-capsules1275649
Ref: ce21275649
Ref: Capsules-Footnote-11277648
Node: Port-Specific Changes Windows1277690
Ref: whatsnew/2 7 port-specific-changes-windows1277838
Ref: ce51277838
Ref: Port-Specific Changes Windows-Footnote-11279530
Ref: Port-Specific Changes Windows-Footnote-21279572
Ref: Port-Specific Changes Windows-Footnote-31279614
Ref: Port-Specific Changes Windows-Footnote-41279656
Ref: Port-Specific Changes Windows-Footnote-51279701
Ref: Port-Specific Changes Windows-Footnote-61279743
Node: Port-Specific Changes Mac OS X1279785
Ref: whatsnew/2 7 port-specific-changes-mac-os-x1279954
Ref: ce71279954
Ref: Port-Specific Changes Mac OS X-Footnote-11280999
Ref: Port-Specific Changes Mac OS X-Footnote-21281041
Node: Port-Specific Changes FreeBSD1281084
Ref: whatsnew/2 7 port-specific-changes-freebsd1281215
Ref: ce81281215
Ref: Port-Specific Changes FreeBSD-Footnote-11281575
Node: Other Changes and Fixes1281617
Ref: whatsnew/2 7 other-changes-and-fixes1281768
Ref: ce91281768
Ref: Other Changes and Fixes-Footnote-11283956
Ref: Other Changes and Fixes-Footnote-21283998
Ref: Other Changes and Fixes-Footnote-31284043
Ref: Other Changes and Fixes-Footnote-41284085
Ref: Other Changes and Fixes-Footnote-51284127
Node: Porting to Python 2 71284169
Ref: whatsnew/2 7 porting-to-python-2-71284347
Ref: cea1284347
Ref: Porting to Python 2 7-Footnote-11289914
Ref: Porting to Python 2 7-Footnote-21289956
Ref: Porting to Python 2 7-Footnote-31289998
Ref: Porting to Python 2 7-Footnote-41290040
Ref: Porting to Python 2 7-Footnote-51290082
Ref: Porting to Python 2 7-Footnote-61290124
Ref: Porting to Python 2 7-Footnote-71290166
Ref: Porting to Python 2 7-Footnote-81290208
Ref: Porting to Python 2 7-Footnote-91290250
Ref: Porting to Python 2 7-Footnote-101290292
Ref: Porting to Python 2 7-Footnote-111290335
Ref: Porting to Python 2 7-Footnote-121290378
Ref: Porting to Python 2 7-Footnote-131290421
Ref: Porting to Python 2 7-Footnote-141290471
Node: New Features Added to Python 2 7 Maintenance Releases1290514
Ref: whatsnew/2 7 new-features-added-to-python-2-7-maintenance-releases1290685
Ref: ceb1290685
Ref: whatsnew/2 7 py27-maintenance-enhancements1290685
Ref: c6f1290685
Node: Two new environment variables for debug mode1292150
Ref: whatsnew/2 7 two-new-environment-variables-for-debug-mode1292344
Ref: cec1292344
Ref: Two new environment variables for debug mode-Footnote-11293023
Ref: Two new environment variables for debug mode-Footnote-21293066
Node: PEP 434 IDLE Enhancement Exception for All Branches1293109
Ref: whatsnew/2 7 pep-434-idle-enhancement-exception-for-all-branches1293364
Ref: ced1293364
Ref: PEP 434 IDLE Enhancement Exception for All Branches-Footnote-11293884
Node: PEP 466 Network Security Enhancements for Python 2 71293933
Ref: whatsnew/2 7 pep-466-network-security-enhancements-for-python-2-71294192
Ref: cee1294192
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-11296421
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-21296470
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-31296519
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-41296562
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-51296605
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-61296654
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-71296697
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-81296740
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-91296789
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-101296832
Ref: PEP 466 Network Security Enhancements for Python 2 7-Footnote-111296876
Node: PEP 477 Backport ensurepip PEP 453 to Python 2 71296920
Ref: whatsnew/2 7 pep-477-backport-ensurepip-pep-453-to-python-2-71297207
Ref: cf11297207
Ref: PEP 477 Backport ensurepip PEP 453 to Python 2 7-Footnote-11297703
Ref: PEP 477 Backport ensurepip PEP 453 to Python 2 7-Footnote-21297752
Node: Bootstrapping pip By Default<2>1297801
Ref: whatsnew/2 7 bootstrapping-pip-by-default1297950
Ref: cf21297950
Ref: Bootstrapping pip By Default<2>-Footnote-11299618
Ref: Bootstrapping pip By Default<2>-Footnote-21299667
Node: Documentation Changes<2>1299765
Ref: whatsnew/2 7 documentation-changes1299914
Ref: cf31299914
Ref: whatsnew/2 7 id11299914
Ref: cf41299914
Ref: Documentation Changes<2>-Footnote-11300869
Ref: Documentation Changes<2>-Footnote-21300905
Node: PEP 476 Enabling certificate verification by default for stdlib http clients<2>1300954
Ref: whatsnew/2 7 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients1301246
Ref: cf51301246
Ref: PEP 476 Enabling certificate verification by default for stdlib http clients<2>-Footnote-11302327
Node: PEP 493 HTTPS verification migration tools for Python 2 71302376
Ref: whatsnew/2 7 pep-493-https-verification-migration-tools-for-python-2-71302654
Ref: cf61302654
Ref: PEP 493 HTTPS verification migration tools for Python 2 7-Footnote-11303818
Node: New make regen-all build target<3>1303867
Ref: whatsnew/2 7 new-make-regen-all-build-target1304103
Ref: cf71304103
Ref: New make regen-all build target<3>-Footnote-11304893
Ref: New make regen-all build target<3>-Footnote-21304960
Node: Removal of make touch build target<3>1305003
Ref: whatsnew/2 7 removal-of-make-touch-build-target1305173
Ref: cf81305173
Ref: Removal of make touch build target<3>-Footnote-11305608
Node: Acknowledgements1305651
Ref: whatsnew/2 7 acknowledgements1305792
Ref: cf91305792
Ref: whatsnew/2 7 acks271305792
Ref: cfa1305792
Node: What’s New in Python 2 61306065
Ref: whatsnew/2 6 doc1306220
Ref: cfb1306220
Ref: whatsnew/2 6 what-s-new-in-python-2-61306220
Ref: cfc1306220
Ref: whatsnew/2 6 whats-new-in-2-61306220
Ref: c3a1306220
Ref: What’s New in Python 2 6-Footnote-11309283
Node: Python 3 01309332
Ref: whatsnew/2 6 python-3-01309448
Ref: cfd1309448
Ref: Python 3 0-Footnote-11311562
Ref: Python 3 0-Footnote-21311611
Node: Changes to the Development Process1311660
Ref: whatsnew/2 6 changes-to-the-development-process1311817
Ref: cfe1311817
Node: New Issue Tracker Roundup1312335
Ref: whatsnew/2 6 new-issue-tracker-roundup1312494
Ref: cff1312494
Ref: New Issue Tracker Roundup-Footnote-11314541
Ref: New Issue Tracker Roundup-Footnote-21314590
Ref: New Issue Tracker Roundup-Footnote-31314621
Ref: New Issue Tracker Roundup-Footnote-41314661
Ref: New Issue Tracker Roundup-Footnote-51314696
Node: New Documentation Format reStructuredText Using Sphinx1314737
Ref: whatsnew/2 6 new-documentation-format-restructuredtext-using-sphinx1314896
Ref: d001314896
Ref: New Documentation Format reStructuredText Using Sphinx-Footnote-11317006
Ref: New Documentation Format reStructuredText Using Sphinx-Footnote-21317065
Ref: New Documentation Format reStructuredText Using Sphinx-Footnote-31317114
Ref: New Documentation Format reStructuredText Using Sphinx-Footnote-41317145
Node: PEP 343 The ‘with’ statement1317185
Ref: whatsnew/2 6 pep-03431317384
Ref: c3b1317384
Ref: whatsnew/2 6 pep-343-the-with-statement1317384
Ref: d011317384
Node: Writing Context Managers1320660
Ref: whatsnew/2 6 new-26-context-managers1320783
Ref: c3c1320783
Ref: whatsnew/2 6 writing-context-managers1320783
Ref: d021320783
Node: The contextlib module1325296
Ref: whatsnew/2 6 new-module-contextlib1325419
Ref: c3d1325419
Ref: whatsnew/2 6 the-contextlib-module1325419
Ref: d031325419
Ref: The contextlib module-Footnote-11327921
Node: PEP 366 Explicit Relative Imports From a Main Module1327970
Ref: whatsnew/2 6 pep-03661328175
Ref: c3e1328175
Ref: whatsnew/2 6 pep-366-explicit-relative-imports-from-a-main-module1328175
Ref: d041328175
Node: PEP 370 Per-user site-packages Directory1328938
Ref: whatsnew/2 6 pep-03701329146
Ref: c3f1329146
Ref: whatsnew/2 6 pep-370-per-user-site-packages-directory1329146
Ref: d061329146
Ref: PEP 370 Per-user site-packages Directory-Footnote-11330605
Node: PEP 371 The multiprocessing Package1330654
Ref: whatsnew/2 6 pep-03711330845
Ref: c401330845
Ref: whatsnew/2 6 pep-371-the-multiprocessing-package1330845
Ref: d0a1330845
Ref: PEP 371 The multiprocessing Package-Footnote-11335984
Node: PEP 3101 Advanced String Formatting1336033
Ref: whatsnew/2 6 pep-31011336212
Ref: c411336212
Ref: whatsnew/2 6 pep-3101-advanced-string-formatting1336212
Ref: d0c1336212
Ref: PEP 3101 Advanced String Formatting-Footnote-11341925
Node: PEP 3105 print As a Function1341974
Ref: whatsnew/2 6 pep-31051342153
Ref: c421342153
Ref: whatsnew/2 6 pep-3105-print-as-a-function1342153
Ref: d0e1342153
Ref: PEP 3105 print As a Function-Footnote-11343307
Node: PEP 3110 Exception-Handling Changes1343356
Ref: whatsnew/2 6 pep-31101343522
Ref: c431343522
Ref: whatsnew/2 6 pep-3110-exception-handling-changes1343522
Ref: d0f1343522
Ref: PEP 3110 Exception-Handling Changes-Footnote-11345123
Node: PEP 3112 Byte Literals1345172
Ref: whatsnew/2 6 pep-31121345334
Ref: c441345334
Ref: whatsnew/2 6 pep-3112-byte-literals1345334
Ref: d101345334
Ref: PEP 3112 Byte Literals-Footnote-11348348
Node: PEP 3116 New I/O Library1348397
Ref: whatsnew/2 6 pep-31161348556
Ref: c451348556
Ref: whatsnew/2 6 pep-3116-new-i-o-library1348556
Ref: d161348556
Ref: PEP 3116 New I/O Library-Footnote-11352182
Node: PEP 3118 Revised Buffer Protocol1352231
Ref: whatsnew/2 6 pep-31181352398
Ref: c461352398
Ref: whatsnew/2 6 pep-3118-revised-buffer-protocol1352398
Ref: d171352398
Ref: PEP 3118 Revised Buffer Protocol-Footnote-11354537
Node: PEP 3119 Abstract Base Classes1354586
Ref: whatsnew/2 6 pep-31191354772
Ref: c471354772
Ref: whatsnew/2 6 pep-3119-abstract-base-classes1354772
Ref: d191354772
Ref: PEP 3119 Abstract Base Classes-Footnote-11360141
Node: PEP 3127 Integer Literal Support and Syntax1360190
Ref: whatsnew/2 6 pep-31271360369
Ref: c481360369
Ref: whatsnew/2 6 pep-3127-integer-literal-support-and-syntax1360369
Ref: d1c1360369
Ref: PEP 3127 Integer Literal Support and Syntax-Footnote-11361734
Node: PEP 3129 Class Decorators1361783
Ref: whatsnew/2 6 pep-31291361969
Ref: c491361969
Ref: whatsnew/2 6 pep-3129-class-decorators1361969
Ref: d1d1361969
Ref: PEP 3129 Class Decorators-Footnote-11362369
Node: PEP 3141 A Type Hierarchy for Numbers1362418
Ref: whatsnew/2 6 pep-31411362587
Ref: c4a1362587
Ref: whatsnew/2 6 pep-3141-a-type-hierarchy-for-numbers1362587
Ref: d1e1362587
Ref: PEP 3141 A Type Hierarchy for Numbers-Footnote-11364788
Ref: PEP 3141 A Type Hierarchy for Numbers-Footnote-21364837
Ref: PEP 3141 A Type Hierarchy for Numbers-Footnote-31364935
Node: The fractions Module1365020
Ref: whatsnew/2 6 the-fractions-module1365114
Ref: d221365114
Node: Other Language Changes<10>1366721
Ref: whatsnew/2 6 other-language-changes1366892
Ref: d231366892
Ref: Other Language Changes<10>-Footnote-11375741
Ref: Other Language Changes<10>-Footnote-21375786
Ref: Other Language Changes<10>-Footnote-31375828
Ref: Other Language Changes<10>-Footnote-41375873
Ref: Other Language Changes<10>-Footnote-51375915
Ref: Other Language Changes<10>-Footnote-61375957
Ref: Other Language Changes<10>-Footnote-71375999
Ref: Other Language Changes<10>-Footnote-81376041
Ref: Other Language Changes<10>-Footnote-91376083
Ref: Other Language Changes<10>-Footnote-101376125
Ref: Other Language Changes<10>-Footnote-111376168
Ref: Other Language Changes<10>-Footnote-121376211
Ref: Other Language Changes<10>-Footnote-131376257
Ref: Other Language Changes<10>-Footnote-141376303
Ref: Other Language Changes<10>-Footnote-151376349
Ref: Other Language Changes<10>-Footnote-161376395
Node: Optimizations<9>1376441
Ref: whatsnew/2 6 optimizations1376551
Ref: d271376551
Ref: Optimizations<9>-Footnote-11379407
Ref: Optimizations<9>-Footnote-21379452
Ref: Optimizations<9>-Footnote-31379497
Ref: Optimizations<9>-Footnote-41379539
Node: Interpreter Changes<2>1379581
Ref: whatsnew/2 6 interpreter-changes1379691
Ref: d281379691
Ref: whatsnew/2 6 new-26-interpreter1379691
Ref: d291379691
Node: New and Improved Modules<2>1381277
Ref: whatsnew/2 6 new-and-improved-modules1381436
Ref: d2d1381436
Ref: New and Improved Modules<2>-Footnote-11423868
Ref: New and Improved Modules<2>-Footnote-21423913
Ref: New and Improved Modules<2>-Footnote-31423966
Ref: New and Improved Modules<2>-Footnote-41424008
Ref: New and Improved Modules<2>-Footnote-51424052
Ref: New and Improved Modules<2>-Footnote-61424094
Ref: New and Improved Modules<2>-Footnote-71424139
Ref: New and Improved Modules<2>-Footnote-81424181
Ref: New and Improved Modules<2>-Footnote-91424234
Ref: New and Improved Modules<2>-Footnote-101424279
Ref: New and Improved Modules<2>-Footnote-111424325
Ref: New and Improved Modules<2>-Footnote-121424371
Ref: New and Improved Modules<2>-Footnote-131424414
Ref: New and Improved Modules<2>-Footnote-141424457
Ref: New and Improved Modules<2>-Footnote-151424502
Ref: New and Improved Modules<2>-Footnote-161424545
Ref: New and Improved Modules<2>-Footnote-171424591
Ref: New and Improved Modules<2>-Footnote-181424634
Ref: New and Improved Modules<2>-Footnote-191424680
Ref: New and Improved Modules<2>-Footnote-201424726
Ref: New and Improved Modules<2>-Footnote-211424772
Ref: New and Improved Modules<2>-Footnote-221424817
Ref: New and Improved Modules<2>-Footnote-231424863
Ref: New and Improved Modules<2>-Footnote-241424909
Ref: New and Improved Modules<2>-Footnote-251424952
Ref: New and Improved Modules<2>-Footnote-261424995
Ref: New and Improved Modules<2>-Footnote-271425041
Ref: New and Improved Modules<2>-Footnote-281425087
Ref: New and Improved Modules<2>-Footnote-291425132
Ref: New and Improved Modules<2>-Footnote-301425175
Ref: New and Improved Modules<2>-Footnote-311425218
Ref: New and Improved Modules<2>-Footnote-321425261
Ref: New and Improved Modules<2>-Footnote-331425304
Ref: New and Improved Modules<2>-Footnote-341425347
Ref: New and Improved Modules<2>-Footnote-351425390
Ref: New and Improved Modules<2>-Footnote-361425433
Ref: New and Improved Modules<2>-Footnote-371425483
Ref: New and Improved Modules<2>-Footnote-381425528
Ref: New and Improved Modules<2>-Footnote-391425578
Ref: New and Improved Modules<2>-Footnote-401425623
Ref: New and Improved Modules<2>-Footnote-411425666
Ref: New and Improved Modules<2>-Footnote-421425711
Ref: New and Improved Modules<2>-Footnote-431425757
Ref: New and Improved Modules<2>-Footnote-441425800
Ref: New and Improved Modules<2>-Footnote-451425843
Ref: New and Improved Modules<2>-Footnote-461425886
Ref: New and Improved Modules<2>-Footnote-471425932
Ref: New and Improved Modules<2>-Footnote-481425975
Ref: New and Improved Modules<2>-Footnote-491426018
Ref: New and Improved Modules<2>-Footnote-501426064
Ref: New and Improved Modules<2>-Footnote-511426107
Ref: New and Improved Modules<2>-Footnote-521426153
Ref: New and Improved Modules<2>-Footnote-531426196
Ref: New and Improved Modules<2>-Footnote-541426242
Ref: New and Improved Modules<2>-Footnote-551426285
Ref: New and Improved Modules<2>-Footnote-561426331
Ref: New and Improved Modules<2>-Footnote-571426374
Ref: New and Improved Modules<2>-Footnote-581426420
Ref: New and Improved Modules<2>-Footnote-591426466
Ref: New and Improved Modules<2>-Footnote-601426509
Ref: New and Improved Modules<2>-Footnote-611426552
Ref: New and Improved Modules<2>-Footnote-621426597
Ref: New and Improved Modules<2>-Footnote-631426643
Node: The ast module1426689
Ref: whatsnew/2 6 the-ast-module1426802
Ref: d3d1426802
Node: The future_builtins module1429463
Ref: whatsnew/2 6 the-future-builtins-module1429627
Ref: d3e1429627
Node: The json module JavaScript Object Notation1430742
Ref: whatsnew/2 6 the-json-module-javascript-object-notation1430934
Ref: d401430934
Node: The plistlib module A Property-List Parser1431946
Ref: whatsnew/2 6 the-plistlib-module-a-property-list-parser1432131
Ref: d411432131
Node: ctypes Enhancements1433502
Ref: whatsnew/2 6 ctypes-enhancements1433665
Ref: d421433665
Ref: ctypes Enhancements-Footnote-11435432
Ref: ctypes Enhancements-Footnote-21435477
Node: Improved SSL Support1435519
Ref: whatsnew/2 6 improved-ssl-support1435631
Ref: d431435631
Ref: Improved SSL Support-Footnote-11436584
Node: Deprecations and Removals1436617
Ref: whatsnew/2 6 deprecations-and-removals1436776
Ref: d441436776
Ref: Deprecations and Removals-Footnote-11438631
Node: Build and C API Changes<9>1438680
Ref: whatsnew/2 6 build-and-c-api-changes1438833
Ref: d461438833
Ref: Build and C API Changes<9>-Footnote-11444870
Ref: Build and C API Changes<9>-Footnote-21444912
Ref: Build and C API Changes<9>-Footnote-31444957
Ref: Build and C API Changes<9>-Footnote-41444999
Ref: Build and C API Changes<9>-Footnote-51445041
Node: Port-Specific Changes Windows<2>1445086
Ref: whatsnew/2 6 port-specific-changes-windows1445223
Ref: d4d1445223
Ref: Port-Specific Changes Windows<2>-Footnote-11447633
Ref: Port-Specific Changes Windows<2>-Footnote-21447677
Ref: Port-Specific Changes Windows<2>-Footnote-31447722
Node: Port-Specific Changes Mac OS X<2>1447764
Ref: whatsnew/2 6 port-specific-changes-mac-os-x1447936
Ref: d4e1447936
Ref: Port-Specific Changes Mac OS X<2>-Footnote-11449207
Node: Port-Specific Changes IRIX1449252
Ref: whatsnew/2 6 port-specific-changes-irix1449383
Ref: d4f1449383
Node: Porting to Python 2 61449902
Ref: whatsnew/2 6 porting-to-python-2-61450049
Ref: d501450049
Ref: Porting to Python 2 6-Footnote-11453474
Ref: Porting to Python 2 6-Footnote-21453519
Ref: Porting to Python 2 6-Footnote-31453564
Node: Acknowledgements<2>1453609
Ref: whatsnew/2 6 acknowledgements1453721
Ref: d531453721
Ref: whatsnew/2 6 acks1453721
Ref: d541453721
Node: What’s New in Python 2 51454063
Ref: whatsnew/2 5 doc1454218
Ref: d551454218
Ref: whatsnew/2 5 what-s-new-in-python-2-51454218
Ref: d561454218
Ref: What’s New in Python 2 5-Footnote-11457821
Node: PEP 308 Conditional Expressions1457870
Ref: whatsnew/2 5 pep-3081458009
Ref: d571458009
Ref: whatsnew/2 5 pep-308-conditional-expressions1458009
Ref: d5c1458009
Ref: PEP 308 Conditional Expressions-Footnote-11461493
Ref: PEP 308 Conditional Expressions-Footnote-21461542
Node: PEP 309 Partial Function Application1461591
Ref: whatsnew/2 5 pep-3091461789
Ref: d5d1461789
Ref: whatsnew/2 5 pep-309-partial-function-application1461789
Ref: d5e1461789
Ref: PEP 309 Partial Function Application-Footnote-11464636
Node: PEP 314 Metadata for Python Software Packages v1 11464685
Ref: whatsnew/2 5 pep-3141464889
Ref: d5f1464889
Ref: whatsnew/2 5 pep-314-metadata-for-python-software-packages-v1-11464889
Ref: d601464889
Ref: PEP 314 Metadata for Python Software Packages v1 1-Footnote-11466723
Node: PEP 328 Absolute and Relative Imports1466772
Ref: whatsnew/2 5 pep-3281466976
Ref: d5a1466976
Ref: whatsnew/2 5 pep-328-absolute-and-relative-imports1466976
Ref: d611466976
Ref: PEP 328 Absolute and Relative Imports-Footnote-11470788
Ref: PEP 328 Absolute and Relative Imports-Footnote-21470837
Node: PEP 338 Executing Modules as Scripts1470886
Ref: whatsnew/2 5 pep-3381471074
Ref: d621471074
Ref: whatsnew/2 5 pep-338-executing-modules-as-scripts1471074
Ref: d631471074
Ref: PEP 338 Executing Modules as Scripts-Footnote-11471969
Node: PEP 341 Unified try/except/finally1472018
Ref: whatsnew/2 5 pep-3411472199
Ref: d5b1472199
Ref: whatsnew/2 5 pep-341-unified-try-except-finally1472199
Ref: d641472199
Ref: PEP 341 Unified try/except/finally-Footnote-11473966
Node: PEP 342 New Generator Features1474015
Ref: whatsnew/2 5 pep-3421474195
Ref: d591474195
Ref: whatsnew/2 5 pep-342-new-generator-features1474195
Ref: d661474195
Ref: PEP 342 New Generator Features-Footnote-11480812
Ref: PEP 342 New Generator Features-Footnote-21480861
Ref: PEP 342 New Generator Features-Footnote-31480910
Ref: PEP 342 New Generator Features-Footnote-41480959
Ref: PEP 342 New Generator Features-Footnote-51481008
Node: PEP 343 The ‘with’ statement<2>1481057
Ref: whatsnew/2 5 pep-3431481242
Ref: d581481242
Ref: whatsnew/2 5 pep-343-the-with-statement1481242
Ref: d671481242
Node: Writing Context Managers<2>1484262
Ref: whatsnew/2 5 new-25-context-managers1484394
Ref: d681484394
Ref: whatsnew/2 5 writing-context-managers1484394
Ref: d691484394
Node: The contextlib module<2>1488790
Ref: whatsnew/2 5 contextlibmod1488922
Ref: d6a1488922
Ref: whatsnew/2 5 the-contextlib-module1488922
Ref: d6b1488922
Ref: The contextlib module<2>-Footnote-11491415
Node: PEP 352 Exceptions as New-Style Classes1491464
Ref: whatsnew/2 5 pep-3521491658
Ref: d6c1491658
Ref: whatsnew/2 5 pep-352-exceptions-as-new-style-classes1491658
Ref: d6d1491658
Ref: PEP 352 Exceptions as New-Style Classes-Footnote-11494140
Node: PEP 353 Using ssize_t as the index type1494189
Ref: whatsnew/2 5 pep-3531494382
Ref: d6f1494382
Ref: whatsnew/2 5 pep-353-using-ssize-t-as-the-index-type1494382
Ref: d701494382
Ref: PEP 353 Using ssize_t as the index type-Footnote-11497294
Ref: PEP 353 Using ssize_t as the index type-Footnote-21497343
Node: PEP 357 The ‘__index__’ method1497392
Ref: whatsnew/2 5 pep-3571497572
Ref: d721497572
Ref: whatsnew/2 5 pep-357-the-index-method1497572
Ref: d731497572
Ref: PEP 357 The ‘__index__’ method-Footnote-11499300
Node: Other Language Changes<11>1499349
Ref: whatsnew/2 5 other-lang1499522
Ref: d751499522
Ref: whatsnew/2 5 other-language-changes1499522
Ref: d761499522
Ref: Other Language Changes<11>-Footnote-11506475
Node: Interactive Interpreter Changes1506524
Ref: whatsnew/2 5 interactive1506644
Ref: d7c1506644
Ref: whatsnew/2 5 interactive-interpreter-changes1506644
Ref: d7d1506644
Node: Optimizations<10>1507424
Ref: whatsnew/2 5 optimizations1507544
Ref: d801507544
Ref: whatsnew/2 5 opts1507544
Ref: d811507544
Node: New Improved and Removed Modules1511362
Ref: whatsnew/2 5 modules1511528
Ref: d821511528
Ref: whatsnew/2 5 new-improved-and-removed-modules1511528
Ref: d831511528
Ref: New Improved and Removed Modules-Footnote-11536020
Ref: New Improved and Removed Modules-Footnote-21536069
Ref: New Improved and Removed Modules-Footnote-31536118
Node: The ctypes package1536167
Ref: whatsnew/2 5 module-ctypes1536286
Ref: d901536286
Ref: whatsnew/2 5 the-ctypes-package1536286
Ref: d911536286
Node: The ElementTree package1539503
Ref: whatsnew/2 5 module-etree1539650
Ref: d921539650
Ref: whatsnew/2 5 the-elementtree-package1539650
Ref: d931539650
Node: The hashlib package1544862
Ref: whatsnew/2 5 module-hashlib1545010
Ref: d941545010
Ref: whatsnew/2 5 the-hashlib-package1545010
Ref: d951545010
Node: The sqlite3 package1546595
Ref: whatsnew/2 5 module-sqlite1546739
Ref: d961546739
Ref: whatsnew/2 5 the-sqlite3-package1546739
Ref: d971546739
Ref: The sqlite3 package-Footnote-11550748
Ref: The sqlite3 package-Footnote-21550797
Node: The wsgiref package1550846
Ref: whatsnew/2 5 module-wsgiref1550962
Ref: d981550962
Ref: whatsnew/2 5 the-wsgiref-package1550962
Ref: d991550962
Ref: The wsgiref package-Footnote-11551883
Ref: The wsgiref package-Footnote-21551932
Node: Build and C API Changes<10>1551981
Ref: whatsnew/2 5 build-and-c-api-changes1552142
Ref: d9a1552142
Ref: whatsnew/2 5 build-api1552142
Ref: d9b1552142
Ref: Build and C API Changes<10>-Footnote-11559161
Ref: Build and C API Changes<10>-Footnote-21559210
Ref: Build and C API Changes<10>-Footnote-31559259
Node: Port-Specific Changes1559308
Ref: whatsnew/2 5 port-specific-changes1559393
Ref: da51559393
Ref: whatsnew/2 5 ports1559393
Ref: da61559393
Ref: Port-Specific Changes-Footnote-11560070
Node: Porting to Python 2 51560112
Ref: whatsnew/2 5 porting1560260
Ref: da71560260
Ref: whatsnew/2 5 porting-to-python-2-51560260
Ref: da81560260
Ref: Porting to Python 2 5-Footnote-11563083
Node: Acknowledgements<3>1563132
Ref: whatsnew/2 5 acknowledgements1563244
Ref: da91563244
Node: What’s New in Python 2 41563738
Ref: whatsnew/2 4 doc1563893
Ref: daa1563893
Ref: whatsnew/2 4 what-s-new-in-python-2-41563893
Ref: dab1563893
Node: PEP 218 Built-In Set Objects1565998
Ref: whatsnew/2 4 pep-218-built-in-set-objects1566141
Ref: dac1566141
Ref: PEP 218 Built-In Set Objects-Footnote-11568377
Node: PEP 237 Unifying Long Integers and Integers1568426
Ref: whatsnew/2 4 pep-237-unifying-long-integers-and-integers1568607
Ref: dad1568607
Ref: PEP 237 Unifying Long Integers and Integers-Footnote-11569648
Node: PEP 289 Generator Expressions1569697
Ref: whatsnew/2 4 pep-289-generator-expressions1569886
Ref: dae1569886
Ref: PEP 289 Generator Expressions-Footnote-11572158
Node: PEP 292 Simpler String Substitutions1572207
Ref: whatsnew/2 4 pep-292-simpler-string-substitutions1572397
Ref: daf1572397
Ref: PEP 292 Simpler String Substitutions-Footnote-11574196
Node: PEP 318 Decorators for Functions and Methods1574245
Ref: whatsnew/2 4 pep-318-decorators-for-functions-and-methods1574431
Ref: db01574431
Ref: PEP 318 Decorators for Functions and Methods-Footnote-11578952
Ref: PEP 318 Decorators for Functions and Methods-Footnote-21579001
Node: PEP 322 Reverse Iteration1579050
Ref: whatsnew/2 4 pep-322-reverse-iteration1579229
Ref: db21579229
Ref: PEP 322 Reverse Iteration-Footnote-11580191
Node: PEP 324 New subprocess Module1580240
Ref: whatsnew/2 4 pep-324-new-subprocess-module1580400
Ref: db31580400
Ref: PEP 324 New subprocess Module-Footnote-11584164
Node: PEP 327 Decimal Data Type1584213
Ref: whatsnew/2 4 pep-327-decimal-data-type1584374
Ref: db51584374
Node: Why is Decimal needed?1584952
Ref: whatsnew/2 4 why-is-decimal-needed1585061
Ref: db61585061
Node: The Decimal type1587651
Ref: whatsnew/2 4 the-decimal-type1587785
Ref: db71587785
Node: The Context type1590957
Ref: whatsnew/2 4 the-context-type1591060
Ref: db81591060
Ref: The Context type-Footnote-11593669
Node: PEP 328 Multi-line Imports1593718
Ref: whatsnew/2 4 pep-328-multi-line-imports1593901
Ref: db91593901
Ref: PEP 328 Multi-line Imports-Footnote-11595395
Node: PEP 331 Locale-Independent Float/String Conversions1595444
Ref: whatsnew/2 4 pep-331-locale-independent-float-string-conversions1595628
Ref: dba1595628
Ref: PEP 331 Locale-Independent Float/String Conversions-Footnote-11597368
Node: Other Language Changes<12>1597417
Ref: whatsnew/2 4 other-language-changes1597613
Ref: dbb1597613
Ref: Other Language Changes<12>-Footnote-11604595
Ref: Other Language Changes<12>-Footnote-21604644
Ref: Other Language Changes<12>-Footnote-31604693
Ref: Other Language Changes<12>-Footnote-41604742
Ref: Other Language Changes<12>-Footnote-51604791
Ref: Other Language Changes<12>-Footnote-61604840
Node: Optimizations<11>1604889
Ref: whatsnew/2 4 optimizations1604969
Ref: dbd1604969
Node: New Improved and Deprecated Modules<3>1607724
Ref: whatsnew/2 4 new-improved-and-deprecated-modules1607896
Ref: dbf1607896
Ref: New Improved and Deprecated Modules<3>-Footnote-11625183
Node: cookielib1625232
Ref: whatsnew/2 4 cookielib1625335
Ref: dc11625335
Node: doctest<3>1626254
Ref: whatsnew/2 4 doctest1626357
Ref: dc21626357
Node: Build and C API Changes<11>1629091
Ref: whatsnew/2 4 build-and-c-api-changes1629258
Ref: dc81629258
Node: Port-Specific Changes<2>1631884
Ref: whatsnew/2 4 port-specific-changes1631972
Ref: dcf1631972
Node: Porting to Python 2 41632151
Ref: whatsnew/2 4 porting-to-python-2-41632299
Ref: dd01632299
Node: Acknowledgements<4>1634267
Ref: whatsnew/2 4 acknowledgements1634379
Ref: dd21634379
Ref: whatsnew/2 4 acks1634379
Ref: dd31634379
Node: What’s New in Python 2 31634712
Ref: whatsnew/2 3 doc1634867
Ref: dd41634867
Ref: whatsnew/2 3 what-s-new-in-python-2-31634867
Ref: dd51634867
Node: PEP 218 A Standard Set Datatype1637885
Ref: whatsnew/2 3 pep-218-a-standard-set-datatype1638013
Ref: dd71638013
Ref: PEP 218 A Standard Set Datatype-Footnote-11640504
Node: PEP 255 Simple Generators1640553
Ref: whatsnew/2 3 pep-255-simple-generators1640719
Ref: dd81640719
Ref: whatsnew/2 3 section-generators1640719
Ref: dd91640719
Ref: PEP 255 Simple Generators-Footnote-11646901
Ref: PEP 255 Simple Generators-Footnote-21646950
Node: PEP 263 Source Code Encodings1646999
Ref: whatsnew/2 3 pep-263-source-code-encodings1647177
Ref: ddb1647177
Ref: whatsnew/2 3 section-encodings1647177
Ref: ddc1647177
Ref: PEP 263 Source Code Encodings-Footnote-11648389
Node: PEP 273 Importing Modules from ZIP Archives1648438
Ref: whatsnew/2 3 pep-273-importing-modules-from-zip-archives1648639
Ref: ddd1648639
Ref: PEP 273 Importing Modules from ZIP Archives-Footnote-11650672
Ref: PEP 273 Importing Modules from ZIP Archives-Footnote-21650721
Ref: PEP 273 Importing Modules from ZIP Archives-Footnote-31650770
Node: PEP 277 Unicode file name support for Windows NT1650819
Ref: whatsnew/2 3 pep-277-unicode-file-name-support-for-windows-nt1651024
Ref: ddf1651024
Ref: PEP 277 Unicode file name support for Windows NT-Footnote-11652502
Node: PEP 278 Universal Newline Support1652551
Ref: whatsnew/2 3 pep-278-universal-newline-support1652730
Ref: de11652730
Ref: PEP 278 Universal Newline Support-Footnote-11654245
Node: PEP 279 enumerate1654294
Ref: whatsnew/2 3 pep-279-enumerate1654452
Ref: de21654452
Ref: whatsnew/2 3 section-enumerate1654452
Ref: de31654452
Ref: PEP 279 enumerate-Footnote-11655308
Node: PEP 282 The logging Package1655357
Ref: whatsnew/2 3 pep-282-the-logging-package1655504
Ref: de41655504
Ref: PEP 282 The logging Package-Footnote-11660198
Ref: PEP 282 The logging Package-Footnote-21660247
Node: PEP 285 A Boolean Type1660296
Ref: whatsnew/2 3 pep-285-a-boolean-type1660464
Ref: de51660464
Ref: whatsnew/2 3 section-bool1660464
Ref: de61660464
Ref: PEP 285 A Boolean Type-Footnote-11662913
Ref: PEP 285 A Boolean Type-Footnote-21662962
Node: PEP 293 Codec Error Handling Callbacks1663011
Ref: whatsnew/2 3 pep-293-codec-error-handling-callbacks1663200
Ref: de71663200
Ref: PEP 293 Codec Error Handling Callbacks-Footnote-11664749
Node: PEP 301 Package Index and Metadata for Distutils1664798
Ref: whatsnew/2 3 pep-301-package-index-and-metadata-for-distutils1664989
Ref: dea1664989
Ref: whatsnew/2 3 section-pep3011664989
Ref: deb1664989
Ref: PEP 301 Package Index and Metadata for Distutils-Footnote-11666633
Ref: PEP 301 Package Index and Metadata for Distutils-Footnote-21666669
Node: PEP 302 New Import Hooks1666718
Ref: whatsnew/2 3 pep-302-new-import-hooks1666900
Ref: dec1666900
Ref: whatsnew/2 3 section-pep3021666900
Ref: dde1666900
Ref: PEP 302 New Import Hooks-Footnote-11669507
Ref: PEP 302 New Import Hooks-Footnote-21669556
Ref: PEP 302 New Import Hooks-Footnote-31669605
Node: PEP 305 Comma-separated Files1669654
Ref: whatsnew/2 3 pep-305-comma-separated-files1669815
Ref: ded1669815
Ref: whatsnew/2 3 section-pep3051669815
Ref: dee1669815
Ref: PEP 305 Comma-separated Files-Footnote-11671291
Node: PEP 307 Pickle Enhancements1671340
Ref: whatsnew/2 3 pep-307-pickle-enhancements1671492
Ref: df01671492
Ref: whatsnew/2 3 section-pep3071671492
Ref: df11671492
Ref: PEP 307 Pickle Enhancements-Footnote-11673463
Ref: PEP 307 Pickle Enhancements-Footnote-21673512
Ref: PEP 307 Pickle Enhancements-Footnote-31673561
Node: Extended Slices1673610
Ref: whatsnew/2 3 extended-slices1673759
Ref: df51673759
Ref: whatsnew/2 3 section-slices1673759
Ref: df61673759
Node: Other Language Changes<13>1677151
Ref: whatsnew/2 3 other-language-changes1677311
Ref: df81677311
Ref: Other Language Changes<13>-Footnote-11685095
Ref: Other Language Changes<13>-Footnote-21685167
Node: String Changes1685221
Ref: whatsnew/2 3 string-changes1685324
Ref: dfe1685324
Node: Optimizations<12>1687777
Ref: whatsnew/2 3 optimizations1687880
Ref: dff1687880
Node: New Improved and Deprecated Modules<4>1689327
Ref: whatsnew/2 3 new-improved-and-deprecated-modules1689511
Ref: e011689511
Ref: New Improved and Deprecated Modules<4>-Footnote-11714115
Node: Date/Time Type1714154
Ref: whatsnew/2 3 date-time-type1714271
Ref: e051714271
Node: The optparse Module1716535
Ref: whatsnew/2 3 the-optparse-module1716652
Ref: e061716652
Node: Pymalloc A Specialized Object Allocator1718712
Ref: whatsnew/2 3 pymalloc-a-specialized-object-allocator1718897
Ref: e071718897
Ref: whatsnew/2 3 section-pymalloc1718897
Ref: e081718897
Node: Build and C API Changes<12>1722799
Ref: whatsnew/2 3 build-and-c-api-changes1722972
Ref: e0a1722972
Node: Port-Specific Changes<3>1726394
Ref: whatsnew/2 3 port-specific-changes1726482
Ref: e0f1726482
Node: Other Changes and Fixes<2>1727717
Ref: whatsnew/2 3 other-changes-and-fixes1727872
Ref: e101727872
Ref: whatsnew/2 3 section-other1727872
Ref: e001727872
Node: Porting to Python 2 31730362
Ref: whatsnew/2 3 porting-to-python-2-31730509
Ref: e131730509
Node: Acknowledgements<5>1733317
Ref: whatsnew/2 3 acknowledgements1733429
Ref: e141733429
Ref: whatsnew/2 3 acks1733429
Ref: e151733429
Node: What’s New in Python 2 21734050
Ref: whatsnew/2 2 doc1734205
Ref: e161734205
Ref: whatsnew/2 2 what-s-new-in-python-2-21734205
Ref: e171734205
Node: Introduction1734940
Ref: whatsnew/2 2 introduction1735063
Ref: e181735063
Ref: Introduction-Footnote-11736035
Ref: Introduction-Footnote-21736084
Node: PEPs 252 and 253 Type and Class Changes1736133
Ref: whatsnew/2 2 peps-252-and-253-type-and-class-changes1736282
Ref: e191736282
Node: Old and New Classes1739714
Ref: whatsnew/2 2 old-and-new-classes1739829
Ref: e1b1739829
Ref: Old and New Classes-Footnote-11742234
Node: Descriptors1742283
Ref: whatsnew/2 2 descriptors1742444
Ref: e1c1742444
Node: Multiple Inheritance The Diamond Rule1746304
Ref: whatsnew/2 2 multiple-inheritance-the-diamond-rule1746462
Ref: e1d1746462
Ref: Multiple Inheritance The Diamond Rule-Footnote-11749347
Node: Attribute Access1749396
Ref: whatsnew/2 2 attribute-access1749556
Ref: e1e1749556
Node: Related Links1753373
Ref: whatsnew/2 2 related-links1753487
Ref: e211753487
Ref: whatsnew/2 2 sect-rellinks1753487
Ref: e1a1753487
Ref: Related Links-Footnote-11754988
Ref: Related Links-Footnote-21755037
Ref: Related Links-Footnote-31755086
Ref: Related Links-Footnote-41755135
Ref: Related Links-Footnote-51755184
Node: PEP 234 Iterators1755233
Ref: whatsnew/2 2 pep-234-iterators1755398
Ref: e221755398
Ref: PEP 234 Iterators-Footnote-11760286
Node: PEP 255 Simple Generators<2>1760335
Ref: whatsnew/2 2 pep-255-simple-generators1760507
Ref: e251760507
Ref: PEP 255 Simple Generators<2>-Footnote-11766564
Ref: PEP 255 Simple Generators<2>-Footnote-21766613
Node: PEP 237 Unifying Long Integers and Integers<2>1766662
Ref: whatsnew/2 2 pep-237-unifying-long-integers-and-integers1766855
Ref: e261766855
Ref: PEP 237 Unifying Long Integers and Integers<2>-Footnote-11768580
Node: PEP 238 Changing the Division Operator1768629
Ref: whatsnew/2 2 pep-238-changing-the-division-operator1768809
Ref: e271768809
Ref: PEP 238 Changing the Division Operator-Footnote-11772461
Ref: PEP 238 Changing the Division Operator-Footnote-21772510
Ref: PEP 238 Changing the Division Operator-Footnote-31772559
Node: Unicode Changes1772608
Ref: whatsnew/2 2 unicode-changes1772763
Ref: e291772763
Ref: Unicode Changes-Footnote-11775400
Ref: Unicode Changes-Footnote-21775449
Node: PEP 227 Nested Scopes1775498
Ref: whatsnew/2 2 pep-227-nested-scopes1775642
Ref: e2b1775642
Ref: PEP 227 Nested Scopes-Footnote-11779984
Node: New and Improved Modules<3>1780033
Ref: whatsnew/2 2 new-and-improved-modules1780191
Ref: e2c1780191
Ref: New and Improved Modules<3>-Footnote-11786821
Ref: New and Improved Modules<3>-Footnote-21786870
Ref: New and Improved Modules<3>-Footnote-31786919
Ref: New and Improved Modules<3>-Footnote-41786968
Ref: New and Improved Modules<3>-Footnote-51787017
Node: Interpreter Changes and Fixes1787065
Ref: whatsnew/2 2 interpreter-changes-and-fixes1787228
Ref: e2d1787228
Node: Other Changes and Fixes<3>1791985
Ref: whatsnew/2 2 other-changes-and-fixes1792140
Ref: e3f1792140
Ref: Other Changes and Fixes<3>-Footnote-11798806
Node: Acknowledgements<6>1798855
Ref: whatsnew/2 2 acknowledgements1798972
Ref: e421798972
Node: What’s New in Python 2 11799573
Ref: whatsnew/2 1 doc1799728
Ref: e431799728
Ref: whatsnew/2 1 what-s-new-in-python-2-11799728
Ref: e441799728
Node: Introduction<2>1800733
Ref: whatsnew/2 1 introduction1800844
Ref: e451800844
Node: PEP 227 Nested Scopes<2>1801940
Ref: whatsnew/2 1 pep-227-nested-scopes1802089
Ref: e461802089
Ref: PEP 227 Nested Scopes<2>-Footnote-11806450
Ref: PEP 227 Nested Scopes<2>-Footnote-21806499
Ref: PEP 227 Nested Scopes<2>-Footnote-31806548
Node: PEP 236 __future__ Directives1806597
Ref: whatsnew/2 1 pep-236-future-directives1806755
Ref: e471806755
Ref: PEP 236 __future__ Directives-Footnote-11807992
Node: PEP 207 Rich Comparisons1808041
Ref: whatsnew/2 1 pep-207-rich-comparisons1808200
Ref: e481808200
Ref: PEP 207 Rich Comparisons-Footnote-11811595
Ref: PEP 207 Rich Comparisons-Footnote-21811644
Node: PEP 230 Warning Framework1811693
Ref: whatsnew/2 1 pep-230-warning-framework1811847
Ref: e4a1811847
Ref: PEP 230 Warning Framework-Footnote-11815127
Ref: PEP 230 Warning Framework-Footnote-21815176
Node: PEP 229 New Build System1815225
Ref: whatsnew/2 1 pep-229-new-build-system1815378
Ref: e4c1815378
Ref: PEP 229 New Build System-Footnote-11817298
Node: PEP 205 Weak References1817347
Ref: whatsnew/2 1 pep-205-weak-references1817502
Ref: e4d1817502
Ref: PEP 205 Weak References-Footnote-11820621
Node: PEP 232 Function Attributes1820670
Ref: whatsnew/2 1 pep-232-function-attributes1820856
Ref: e4f1820856
Ref: PEP 232 Function Attributes-Footnote-11822367
Node: PEP 235 Importing Modules on Case-Insensitive Platforms1822416
Ref: whatsnew/2 1 pep-235-importing-modules-on-case-insensitive-platforms1822611
Ref: e501822611
Node: PEP 217 Interactive Display Hook1823514
Ref: whatsnew/2 1 pep-217-interactive-display-hook1823708
Ref: e521823708
Ref: PEP 217 Interactive Display Hook-Footnote-11824636
Node: PEP 208 New Coercion Model1824685
Ref: whatsnew/2 1 pep-208-new-coercion-model1824859
Ref: e541824859
Ref: PEP 208 New Coercion Model-Footnote-11826481
Node: PEP 241 Metadata in Python Packages1826530
Ref: whatsnew/2 1 pep-241-metadata-in-python-packages1826699
Ref: e551826699
Ref: PEP 241 Metadata in Python Packages-Footnote-11828742
Ref: PEP 241 Metadata in Python Packages-Footnote-21828791
Ref: PEP 241 Metadata in Python Packages-Footnote-31828840
Ref: PEP 241 Metadata in Python Packages-Footnote-41828889
Node: New and Improved Modules<4>1828938
Ref: whatsnew/2 1 new-and-improved-modules1829107
Ref: e561829107
Node: Other Changes and Fixes<4>1834940
Ref: whatsnew/2 1 other-changes-and-fixes1835093
Ref: e591835093
Node: Acknowledgements<7>1841027
Ref: whatsnew/2 1 acknowledgements1841144
Ref: e5a1841144
Node: What’s New in Python 2 01841435
Ref: whatsnew/2 0 doc1841573
Ref: e5b1841573
Ref: whatsnew/2 0 what-s-new-in-python-2-01841573
Ref: e5c1841573
Node: Introduction<3>1842246
Ref: whatsnew/2 0 introduction1842355
Ref: e5d1842355
Node: What About Python 1 6?1843239
Ref: whatsnew/2 0 what-about-python-1-61843380
Ref: e5e1843380
Node: New Development Process1844621
Ref: whatsnew/2 0 new-development-process1844757
Ref: e5f1844757
Ref: New Development Process-Footnote-11849905
Ref: New Development Process-Footnote-21849954
Ref: New Development Process-Footnote-31850003
Node: Unicode<2>1850052
Ref: whatsnew/2 0 unicode1850185
Ref: e601850185
Ref: Unicode<2>-Footnote-11856359
Node: List Comprehensions1856408
Ref: whatsnew/2 0 list-comprehensions1856538
Ref: e611856538
Node: Augmented Assignment1860269
Ref: whatsnew/2 0 augmented-assignment1860403
Ref: e621860403
Node: String Methods1861949
Ref: whatsnew/2 0 string-methods1862092
Ref: e651862092
Node: Garbage Collection of Cycles1863945
Ref: whatsnew/2 0 garbage-collection-of-cycles1864086
Ref: e661864086
Node: Other Core Changes1867433
Ref: whatsnew/2 0 other-core-changes1867574
Ref: e671867574
Node: Minor Language Changes1867859
Ref: whatsnew/2 0 minor-language-changes1867974
Ref: e681867974
Node: Changes to Built-in Functions1873061
Ref: whatsnew/2 0 changes-to-built-in-functions1873176
Ref: e6d1873176
Node: Porting to 2 01875466
Ref: whatsnew/2 0 porting-to-2-01875606
Ref: e701875606
Node: Extending/Embedding Changes1880925
Ref: whatsnew/2 0 extending-embedding-changes1881087
Ref: e711881087
Node: Distutils Making Modules Easy to Install1884909
Ref: whatsnew/2 0 distutils-making-modules-easy-to-install1885068
Ref: e721885068
Node: XML Modules1888434
Ref: whatsnew/2 0 xml-modules1888580
Ref: e731888580
Node: SAX2 Support1889479
Ref: whatsnew/2 0 sax2-support1889559
Ref: e741889559
Node: DOM Support1891197
Ref: whatsnew/2 0 dom-support1891307
Ref: e751891307
Node: Relationship to PyXML1894135
Ref: whatsnew/2 0 relationship-to-pyxml1894224
Ref: e761894224
Node: Module changes1895514
Ref: whatsnew/2 0 module-changes1895631
Ref: e771895631
Node: New modules1898103
Ref: whatsnew/2 0 new-modules1898226
Ref: e781898226
Node: IDLE Improvements1902218
Ref: whatsnew/2 0 idle-improvements1902357
Ref: e7a1902357
Node: Deleted and Deprecated Modules1903480
Ref: whatsnew/2 0 deleted-and-deprecated-modules1903627
Ref: e7b1903627
Node: Acknowledgements<8>1904379
Ref: whatsnew/2 0 acknowledgements1904500
Ref: e7c1904500
Ref: Acknowledgements<8>-Footnote-11905099
Ref: Acknowledgements<8>-Footnote-21905138
Node: Changelog1905201
Ref: whatsnew/changelog doc1905304
Ref: e7d1905304
Ref: whatsnew/changelog changelog1905304
Ref: 14c1905304
Ref: whatsnew/changelog id11905304
Ref: e7e1905304
Node: Python 3 8 1 final1908971
Ref: whatsnew/changelog python-3-8-1-final1909076
Ref: e7f1909076
Node: Core and Builtins1909250
Ref: whatsnew/changelog core-and-builtins1909338
Ref: e801909338
Ref: Core and Builtins-Footnote-11910053
Ref: Core and Builtins-Footnote-21910096
Ref: Core and Builtins-Footnote-31910139
Node: Library1910182
Ref: whatsnew/changelog library1910284
Ref: e821910284
Ref: Library-Footnote-11910814
Ref: Library-Footnote-21910857
Ref: Library-Footnote-31910900
Node: Tests1910943
Ref: whatsnew/changelog tests1911035
Ref: e831911035
Ref: Tests-Footnote-11911231
Node: Windows1911274
Ref: whatsnew/changelog windows1911364
Ref: e841911364
Ref: Windows-Footnote-11911515
Node: macOS1911558
Ref: whatsnew/changelog macos1911650
Ref: e851911650
Ref: macOS-Footnote-11911818
Node: IDLE<3>1911861
Ref: whatsnew/changelog idle1911937
Ref: e861911937
Ref: IDLE<3>-Footnote-11912217
Ref: IDLE<3>-Footnote-21912260
Node: Python 3 8 1 release candidate 11912303
Ref: whatsnew/changelog python-3-8-1-release-candidate-11912435
Ref: e871912435
Node: Security1912766
Ref: whatsnew/changelog security1912872
Ref: e881912872
Ref: Security-Footnote-11914052
Ref: Security-Footnote-21914095
Ref: Security-Footnote-31914138
Ref: Security-Footnote-41914181
Ref: Security-Footnote-51914224
Ref: Security-Footnote-61914267
Ref: Security-Footnote-71914310
Node: Core and Builtins<2>1914353
Ref: whatsnew/changelog id21914478
Ref: e8a1914478
Ref: Core and Builtins<2>-Footnote-11915838
Ref: Core and Builtins<2>-Footnote-21915881
Ref: Core and Builtins<2>-Footnote-31915924
Ref: Core and Builtins<2>-Footnote-41915967
Ref: Core and Builtins<2>-Footnote-51916010
Ref: Core and Builtins<2>-Footnote-61916053
Ref: Core and Builtins<2>-Footnote-71916096
Ref: Core and Builtins<2>-Footnote-81916139
Ref: Core and Builtins<2>-Footnote-91916182
Node: Library<2>1916225
Ref: whatsnew/changelog id31916358
Ref: e8b1916358
Ref: Library<2>-Footnote-11921740
Ref: Library<2>-Footnote-21921783
Ref: Library<2>-Footnote-31921826
Ref: Library<2>-Footnote-41921869
Ref: Library<2>-Footnote-51921912
Ref: Library<2>-Footnote-61921955
Ref: Library<2>-Footnote-71921998
Ref: Library<2>-Footnote-81922041
Ref: Library<2>-Footnote-91922084
Ref: Library<2>-Footnote-101922127
Ref: Library<2>-Footnote-111922171
Ref: Library<2>-Footnote-121922215
Ref: Library<2>-Footnote-131922259
Ref: Library<2>-Footnote-141922303
Ref: Library<2>-Footnote-151922347
Ref: Library<2>-Footnote-161922391
Ref: Library<2>-Footnote-171922435
Ref: Library<2>-Footnote-181922479
Ref: Library<2>-Footnote-191922523
Ref: Library<2>-Footnote-201922567
Ref: Library<2>-Footnote-211922611
Ref: Library<2>-Footnote-221922655
Ref: Library<2>-Footnote-231922699
Ref: Library<2>-Footnote-241922743
Ref: Library<2>-Footnote-251922787
Ref: Library<2>-Footnote-261922831
Ref: Library<2>-Footnote-271922875
Ref: Library<2>-Footnote-281922919
Ref: Library<2>-Footnote-291922963
Ref: Library<2>-Footnote-301923007
Ref: Library<2>-Footnote-311923051
Ref: Library<2>-Footnote-321923095
Ref: Library<2>-Footnote-331923139
Node: Documentation<2>1923183
Ref: whatsnew/changelog documentation1923304
Ref: e8e1923304
Ref: Documentation<2>-Footnote-11923962
Ref: Documentation<2>-Footnote-21924005
Ref: Documentation<2>-Footnote-31924048
Ref: Documentation<2>-Footnote-41924091
Node: Tests<2>1924134
Ref: whatsnew/changelog id41924250
Ref: e8f1924250
Ref: Tests<2>-Footnote-11925617
Ref: Tests<2>-Footnote-21925660
Ref: Tests<2>-Footnote-31925703
Ref: Tests<2>-Footnote-41925746
Ref: Tests<2>-Footnote-51925789
Ref: Tests<2>-Footnote-61925832
Ref: Tests<2>-Footnote-71925875
Node: Build1925918
Ref: whatsnew/changelog build1926028
Ref: e911926028
Ref: Build-Footnote-11926636
Ref: Build-Footnote-21926679
Ref: Build-Footnote-31926722
Ref: Build-Footnote-41926765
Node: Windows<2>1926808
Ref: whatsnew/changelog id51926918
Ref: e921926918
Ref: Windows<2>-Footnote-11927468
Ref: Windows<2>-Footnote-21927511
Ref: Windows<2>-Footnote-31927554
Ref: Windows<2>-Footnote-41927597
Ref: Windows<2>-Footnote-51927640
Node: macOS<2>1927683
Ref: whatsnew/changelog id61927795
Ref: e931927795
Ref: macOS<2>-Footnote-11928101
Node: IDLE<4>1928144
Ref: whatsnew/changelog id71928251
Ref: e941928251
Ref: IDLE<4>-Footnote-11928971
Ref: IDLE<4>-Footnote-21929014
Ref: IDLE<4>-Footnote-31929057
Ref: IDLE<4>-Footnote-41929100
Ref: IDLE<4>-Footnote-51929142
Node: C API1929185
Ref: whatsnew/changelog c-api1929275
Ref: e951929275
Ref: C API-Footnote-11929860
Ref: C API-Footnote-21929903
Ref: C API-Footnote-31929946
Node: Python 3 8 0 final1929989
Ref: whatsnew/changelog python-3-8-0-final1930135
Ref: e971930135
Node: Core and Builtins<3>1930421
Ref: whatsnew/changelog id81930515
Ref: e981930515
Ref: Core and Builtins<3>-Footnote-11931209
Ref: Core and Builtins<3>-Footnote-21931252
Node: Library<3>1931295
Ref: whatsnew/changelog id91931414
Ref: e991931414
Ref: Library<3>-Footnote-11932780
Ref: Library<3>-Footnote-21932823
Ref: Library<3>-Footnote-31932866
Ref: Library<3>-Footnote-41932909
Ref: Library<3>-Footnote-51932952
Ref: Library<3>-Footnote-61932995
Ref: Library<3>-Footnote-71933038
Node: Documentation<3>1933081
Ref: whatsnew/changelog id101933188
Ref: e9f1933188
Ref: Documentation<3>-Footnote-11933359
Node: Tests<3>1933402
Ref: whatsnew/changelog id111933509
Ref: ea01933509
Ref: Tests<3>-Footnote-11933946
Node: Windows<3>1933989
Ref: whatsnew/changelog id121934087
Ref: ea11934087
Ref: Windows<3>-Footnote-11934377
Ref: Windows<3>-Footnote-21934420
Ref: Windows<3>-Footnote-31934463
Node: IDLE<5>1934506
Ref: whatsnew/changelog id131934607
Ref: ea21934607
Ref: IDLE<5>-Footnote-11934904
Node: Tools/Demos1934947
Ref: whatsnew/changelog tools-demos1935046
Ref: ea31935046
Ref: Tools/Demos-Footnote-11935400
Ref: Tools/Demos-Footnote-21935443
Node: C API<2>1935486
Ref: whatsnew/changelog id141935569
Ref: ea51935569
Ref: C API<2>-Footnote-11935895
Node: Python 3 8 0 release candidate 11935938
Ref: whatsnew/changelog python-3-8-0-release-candidate-11936071
Ref: ea61936071
Node: Security<2>1936463
Ref: whatsnew/changelog id151936572
Ref: ea71936572
Ref: Security<2>-Footnote-11937219
Ref: Security<2>-Footnote-21937262
Ref: Security<2>-Footnote-31937305
Ref: Security<2>-Footnote-41937348
Node: Core and Builtins<4>1937391
Ref: whatsnew/changelog id161937519
Ref: ea91937519
Ref: Core and Builtins<4>-Footnote-11940082
Ref: Core and Builtins<4>-Footnote-21940125
Ref: Core and Builtins<4>-Footnote-31940168
Ref: Core and Builtins<4>-Footnote-41940217
Ref: Core and Builtins<4>-Footnote-51940260
Ref: Core and Builtins<4>-Footnote-61940303
Ref: Core and Builtins<4>-Footnote-71940346
Ref: Core and Builtins<4>-Footnote-81940389
Ref: Core and Builtins<4>-Footnote-91940432
Ref: Core and Builtins<4>-Footnote-101940475
Ref: Core and Builtins<4>-Footnote-111940519
Ref: Core and Builtins<4>-Footnote-121940563
Ref: Core and Builtins<4>-Footnote-131940607
Ref: Core and Builtins<4>-Footnote-141940651
Ref: Core and Builtins<4>-Footnote-151940695
Node: Library<4>1940739
Ref: whatsnew/changelog id171940872
Ref: eaa1940872
Ref: Library<4>-Footnote-11950002
Ref: Library<4>-Footnote-21950045
Ref: Library<4>-Footnote-31950088
Ref: Library<4>-Footnote-41950131
Ref: Library<4>-Footnote-51950174
Ref: Library<4>-Footnote-61950217
Ref: Library<4>-Footnote-71950260
Ref: Library<4>-Footnote-81950303
Ref: Library<4>-Footnote-91950346
Ref: Library<4>-Footnote-101950389
Ref: Library<4>-Footnote-111950433
Ref: Library<4>-Footnote-121950477
Ref: Library<4>-Footnote-131950521
Ref: Library<4>-Footnote-141950565
Ref: Library<4>-Footnote-151950609
Ref: Library<4>-Footnote-161950653
Ref: Library<4>-Footnote-171950697
Ref: Library<4>-Footnote-181950741
Ref: Library<4>-Footnote-191950785
Ref: Library<4>-Footnote-201950829
Ref: Library<4>-Footnote-211950873
Ref: Library<4>-Footnote-221950917
Ref: Library<4>-Footnote-231950961
Ref: Library<4>-Footnote-241951005
Ref: Library<4>-Footnote-251951049
Ref: Library<4>-Footnote-261951093
Ref: Library<4>-Footnote-271951137
Ref: Library<4>-Footnote-281951181
Ref: Library<4>-Footnote-291951225
Ref: Library<4>-Footnote-301951269
Ref: Library<4>-Footnote-311951313
Ref: Library<4>-Footnote-321951421
Ref: Library<4>-Footnote-331951465
Ref: Library<4>-Footnote-341951509
Ref: Library<4>-Footnote-351951553
Ref: Library<4>-Footnote-361951597
Ref: Library<4>-Footnote-371951641
Ref: Library<4>-Footnote-381951685
Ref: Library<4>-Footnote-391951729
Ref: Library<4>-Footnote-401951773
Ref: Library<4>-Footnote-411951817
Ref: Library<4>-Footnote-421951861
Ref: Library<4>-Footnote-431951905
Ref: Library<4>-Footnote-441951949
Ref: Library<4>-Footnote-451951993
Ref: Library<4>-Footnote-461952037
Ref: Library<4>-Footnote-471952081
Ref: Library<4>-Footnote-481952125
Ref: Library<4>-Footnote-491952169
Ref: Library<4>-Footnote-501952213
Ref: Library<4>-Footnote-511952257
Ref: Library<4>-Footnote-521952301
Ref: Library<4>-Footnote-531952345
Ref: Library<4>-Footnote-541952389
Ref: Library<4>-Footnote-551952433
Ref: Library<4>-Footnote-561952477
Ref: Library<4>-Footnote-571952521
Ref: Library<4>-Footnote-581952565
Ref: Library<4>-Footnote-591952609
Node: Documentation<4>1952653
Ref: whatsnew/changelog id181952774
Ref: eae1952774
Ref: Documentation<4>-Footnote-11954049
Ref: Documentation<4>-Footnote-21954092
Ref: Documentation<4>-Footnote-31954135
Ref: Documentation<4>-Footnote-41954178
Ref: Documentation<4>-Footnote-51954221
Ref: Documentation<4>-Footnote-61954264
Ref: Documentation<4>-Footnote-71954307
Ref: Documentation<4>-Footnote-81954350
Ref: Documentation<4>-Footnote-91954393
Ref: Documentation<4>-Footnote-101954436
Node: Tests<4>1954480
Ref: whatsnew/changelog id191954599
Ref: eb01954599
Ref: Tests<4>-Footnote-11956822
Ref: Tests<4>-Footnote-21956865
Ref: Tests<4>-Footnote-31956908
Ref: Tests<4>-Footnote-41956951
Ref: Tests<4>-Footnote-51956994
Ref: Tests<4>-Footnote-61957037
Ref: Tests<4>-Footnote-71957080
Ref: Tests<4>-Footnote-81957123
Ref: Tests<4>-Footnote-91957166
Ref: Tests<4>-Footnote-101957209
Ref: Tests<4>-Footnote-111957253
Ref: Tests<4>-Footnote-121957297
Ref: Tests<4>-Footnote-131957341
Node: Build<2>1957385
Ref: whatsnew/changelog id201957498
Ref: eb21957498
Ref: Build<2>-Footnote-11958784
Ref: Build<2>-Footnote-21958827
Ref: Build<2>-Footnote-31958870
Ref: Build<2>-Footnote-41958913
Ref: Build<2>-Footnote-51958956
Node: Windows<4>1958999
Ref: whatsnew/changelog id211959112
Ref: eb31959112
Ref: Windows<4>-Footnote-11961064
Ref: Windows<4>-Footnote-21961107
Ref: Windows<4>-Footnote-31961150
Ref: Windows<4>-Footnote-41961193
Ref: Windows<4>-Footnote-51961236
Ref: Windows<4>-Footnote-61961279
Ref: Windows<4>-Footnote-71961322
Ref: Windows<4>-Footnote-81961365
Ref: Windows<4>-Footnote-91961408
Ref: Windows<4>-Footnote-101961451
Ref: Windows<4>-Footnote-111961495
Ref: Windows<4>-Footnote-121961539
Ref: Windows<4>-Footnote-131961583
Ref: Windows<4>-Footnote-141961627
Ref: Windows<4>-Footnote-151961671
Ref: Windows<4>-Footnote-161961715
Ref: Windows<4>-Footnote-171961759
Node: macOS<3>1961803
Ref: whatsnew/changelog id221961915
Ref: eb51961915
Ref: macOS<3>-Footnote-11962146
Ref: macOS<3>-Footnote-21962189
Node: IDLE<6>1962232
Ref: whatsnew/changelog id231962348
Ref: eb61962348
Ref: IDLE<6>-Footnote-11963499
Ref: IDLE<6>-Footnote-21963542
Ref: IDLE<6>-Footnote-31963585
Ref: IDLE<6>-Footnote-41963628
Ref: IDLE<6>-Footnote-51963671
Ref: IDLE<6>-Footnote-61963714
Node: Tools/Demos<2>1963757
Ref: whatsnew/changelog id241963873
Ref: eb71963873
Ref: Tools/Demos<2>-Footnote-11964177
Ref: Tools/Demos<2>-Footnote-21964220
Node: C API<3>1964263
Ref: whatsnew/changelog id251964363
Ref: eb81964363
Ref: C API<3>-Footnote-11965086
Ref: C API<3>-Footnote-21965129
Ref: C API<3>-Footnote-31965172
Ref: C API<3>-Footnote-41965215
Node: Python 3 8 0 beta 41965258
Ref: whatsnew/changelog python-3-8-0-beta-41965392
Ref: ebc1965392
Node: Security<3>1965758
Ref: whatsnew/changelog id261965854
Ref: ebd1965854
Ref: Security<3>-Footnote-11966135
Node: Core and Builtins<5>1966178
Ref: whatsnew/changelog id271966293
Ref: ebe1966293
Ref: Core and Builtins<5>-Footnote-11967722
Ref: Core and Builtins<5>-Footnote-21967765
Ref: Core and Builtins<5>-Footnote-31967808
Ref: Core and Builtins<5>-Footnote-41967851
Ref: Core and Builtins<5>-Footnote-51967894
Ref: Core and Builtins<5>-Footnote-61967937
Ref: Core and Builtins<5>-Footnote-71967986
Ref: Core and Builtins<5>-Footnote-81968029
Ref: Core and Builtins<5>-Footnote-91968072
Node: Library<5>1968115
Ref: whatsnew/changelog id281968235
Ref: ebf1968235
Ref: Library<5>-Footnote-11974287
Ref: Library<5>-Footnote-21974330
Ref: Library<5>-Footnote-31974373
Ref: Library<5>-Footnote-41974416
Ref: Library<5>-Footnote-51974459
Ref: Library<5>-Footnote-61974502
Ref: Library<5>-Footnote-71974545
Ref: Library<5>-Footnote-81974588
Ref: Library<5>-Footnote-91974631
Ref: Library<5>-Footnote-101974674
Ref: Library<5>-Footnote-111974718
Ref: Library<5>-Footnote-121974762
Ref: Library<5>-Footnote-131974806
Ref: Library<5>-Footnote-141974850
Ref: Library<5>-Footnote-151974894
Ref: Library<5>-Footnote-161974938
Ref: Library<5>-Footnote-171974982
Ref: Library<5>-Footnote-181975026
Ref: Library<5>-Footnote-191975070
Ref: Library<5>-Footnote-201975114
Ref: Library<5>-Footnote-211975158
Ref: Library<5>-Footnote-221975202
Ref: Library<5>-Footnote-231975246
Ref: Library<5>-Footnote-241975290
Ref: Library<5>-Footnote-251975334
Ref: Library<5>-Footnote-261975378
Ref: Library<5>-Footnote-271975422
Ref: Library<5>-Footnote-281975466
Ref: Library<5>-Footnote-291975510
Ref: Library<5>-Footnote-301975554
Ref: Library<5>-Footnote-311975598
Ref: Library<5>-Footnote-321975642
Ref: Library<5>-Footnote-331975686
Ref: Library<5>-Footnote-341975730
Ref: Library<5>-Footnote-351975774
Ref: Library<5>-Footnote-361975818
Ref: Library<5>-Footnote-371975862
Ref: Library<5>-Footnote-381975906
Node: Documentation<5>1975950
Ref: whatsnew/changelog id291976058
Ref: ec11976058
Ref: Documentation<5>-Footnote-11976835
Ref: Documentation<5>-Footnote-21976878
Ref: Documentation<5>-Footnote-31976921
Ref: Documentation<5>-Footnote-41976964
Ref: Documentation<5>-Footnote-51977007
Ref: Documentation<5>-Footnote-61977050
Node: Tests<5>1977093
Ref: whatsnew/changelog id301977199
Ref: ec21977199
Ref: Tests<5>-Footnote-11977359
Node: Build<3>1977402
Ref: whatsnew/changelog id311977502
Ref: ec31977502
Ref: Build<3>-Footnote-11977783
Node: Windows<5>1977826
Ref: whatsnew/changelog id321977926
Ref: ec41977926
Ref: Windows<5>-Footnote-11979406
Ref: Windows<5>-Footnote-21979449
Ref: Windows<5>-Footnote-31979491
Ref: Windows<5>-Footnote-41979533
Ref: Windows<5>-Footnote-51979576
Ref: Windows<5>-Footnote-61979619
Ref: Windows<5>-Footnote-71979662
Ref: Windows<5>-Footnote-81979705
Ref: Windows<5>-Footnote-91979748
Node: macOS<4>1979791
Ref: whatsnew/changelog id331979890
Ref: ec61979890
Ref: macOS<4>-Footnote-11980152
Node: IDLE<7>1980195
Ref: whatsnew/changelog id341980298
Ref: ec71980298
Ref: IDLE<7>-Footnote-11980861
Ref: IDLE<7>-Footnote-21980904
Ref: IDLE<7>-Footnote-31980947
Ref: IDLE<7>-Footnote-41980990
Ref: IDLE<7>-Footnote-51981033
Node: Tools/Demos<3>1981076
Ref: whatsnew/changelog id351981179
Ref: ec81981179
Ref: Tools/Demos<3>-Footnote-11981499
Ref: Tools/Demos<3>-Footnote-21981542
Node: C API<4>1981585
Ref: whatsnew/changelog id361981672
Ref: ec91981672
Ref: C API<4>-Footnote-11981976
Ref: C API<4>-Footnote-21982019
Node: Python 3 8 0 beta 31982062
Ref: whatsnew/changelog python-3-8-0-beta-31982183
Ref: eca1982183
Node: Security<4>1982511
Ref: whatsnew/changelog id371982607
Ref: ecb1982607
Ref: Security<4>-Footnote-11982796
Node: Core and Builtins<6>1982839
Ref: whatsnew/changelog id381982954
Ref: ecc1982954
Ref: Core and Builtins<6>-Footnote-11983355
Ref: Core and Builtins<6>-Footnote-21983398
Node: Library<6>1983441
Ref: whatsnew/changelog id391983561
Ref: ecd1983561
Ref: Library<6>-Footnote-11986531
Ref: Library<6>-Footnote-21986574
Ref: Library<6>-Footnote-31986648
Ref: Library<6>-Footnote-41986691
Ref: Library<6>-Footnote-51986734
Ref: Library<6>-Footnote-61986777
Ref: Library<6>-Footnote-71986820
Ref: Library<6>-Footnote-81986863
Ref: Library<6>-Footnote-91986906
Ref: Library<6>-Footnote-101986949
Ref: Library<6>-Footnote-111986993
Ref: Library<6>-Footnote-121987037
Ref: Library<6>-Footnote-131987081
Ref: Library<6>-Footnote-141987125
Ref: Library<6>-Footnote-151987169
Ref: Library<6>-Footnote-161987213
Node: Documentation<6>1987257
Ref: whatsnew/changelog id401987365
Ref: ed21987365
Ref: Documentation<6>-Footnote-11988511
Ref: Documentation<6>-Footnote-21988554
Ref: Documentation<6>-Footnote-31988597
Ref: Documentation<6>-Footnote-41988640
Ref: Documentation<6>-Footnote-51988683
Ref: Documentation<6>-Footnote-61988726
Ref: Documentation<6>-Footnote-71988769
Ref: Documentation<6>-Footnote-81988812
Node: Tests<6>1988855
Ref: whatsnew/changelog id411988961
Ref: ed31988961
Ref: Tests<6>-Footnote-11989632
Ref: Tests<6>-Footnote-21989675
Ref: Tests<6>-Footnote-31989718
Ref: Tests<6>-Footnote-41989761
Node: Build<4>1989804
Ref: whatsnew/changelog id421989904
Ref: ed51989904
Ref: Build<4>-Footnote-11990671
Node: Windows<6>1990714
Ref: whatsnew/changelog id431990813
Ref: ed61990813
Ref: Windows<6>-Footnote-11991011
Node: IDLE<8>1991054
Ref: whatsnew/changelog id441991159
Ref: ed71991159
Ref: IDLE<8>-Footnote-11992636
Ref: IDLE<8>-Footnote-21992679
Ref: IDLE<8>-Footnote-31992722
Ref: IDLE<8>-Footnote-41992765
Ref: IDLE<8>-Footnote-51992808
Ref: IDLE<8>-Footnote-61992851
Ref: IDLE<8>-Footnote-71992894
Ref: IDLE<8>-Footnote-81992937
Ref: IDLE<8>-Footnote-91992980
Node: Tools/Demos<4>1993023
Ref: whatsnew/changelog id451993109
Ref: ed81993109
Ref: Tools/Demos<4>-Footnote-11993269
Node: Python 3 8 0 beta 21993312
Ref: whatsnew/changelog python-3-8-0-beta-21993433
Ref: ed91993433
Node: Security<5>1993768
Ref: whatsnew/changelog id461993864
Ref: eda1993864
Ref: Security<5>-Footnote-11994974
Ref: Security<5>-Footnote-21995017
Ref: Security<5>-Footnote-31995060
Ref: Security<5>-Footnote-41995103
Ref: Security<5>-Footnote-51995146
Node: Core and Builtins<7>1995189
Ref: whatsnew/changelog id471995304
Ref: edc1995304
Ref: Core and Builtins<7>-Footnote-11997024
Ref: Core and Builtins<7>-Footnote-21997067
Ref: Core and Builtins<7>-Footnote-31997110
Ref: Core and Builtins<7>-Footnote-41997153
Ref: Core and Builtins<7>-Footnote-51997196
Ref: Core and Builtins<7>-Footnote-61997239
Ref: Core and Builtins<7>-Footnote-71997282
Ref: Core and Builtins<7>-Footnote-81997325
Ref: Core and Builtins<7>-Footnote-91997368
Ref: Core and Builtins<7>-Footnote-101997411
Ref: Core and Builtins<7>-Footnote-111997455
Ref: Core and Builtins<7>-Footnote-121997499
Node: Library<7>1997543
Ref: whatsnew/changelog id481997663
Ref: edd1997663
Ref: Library<7>-Footnote-12003354
Ref: Library<7>-Footnote-22003397
Ref: Library<7>-Footnote-32003440
Ref: Library<7>-Footnote-42003483
Ref: Library<7>-Footnote-52003526
Ref: Library<7>-Footnote-62003569
Ref: Library<7>-Footnote-72003618
Ref: Library<7>-Footnote-82003661
Ref: Library<7>-Footnote-92003704
Ref: Library<7>-Footnote-102003747
Ref: Library<7>-Footnote-112003791
Ref: Library<7>-Footnote-122003835
Ref: Library<7>-Footnote-132003879
Ref: Library<7>-Footnote-142003923
Ref: Library<7>-Footnote-152003967
Ref: Library<7>-Footnote-162004011
Ref: Library<7>-Footnote-172004055
Ref: Library<7>-Footnote-182004099
Ref: Library<7>-Footnote-192004143
Ref: Library<7>-Footnote-202004187
Ref: Library<7>-Footnote-212004231
Ref: Library<7>-Footnote-222004275
Ref: Library<7>-Footnote-232004319
Ref: Library<7>-Footnote-242004363
Ref: Library<7>-Footnote-252004407
Ref: Library<7>-Footnote-262004451
Ref: Library<7>-Footnote-272004495
Ref: Library<7>-Footnote-282004539
Ref: Library<7>-Footnote-292004583
Ref: Library<7>-Footnote-302004627
Ref: Library<7>-Footnote-312004671
Ref: Library<7>-Footnote-322004715
Ref: Library<7>-Footnote-332004759
Ref: Library<7>-Footnote-342004803
Ref: Library<7>-Footnote-352004847
Ref: Library<7>-Footnote-362004891
Node: Documentation<7>2004934
Ref: whatsnew/changelog id492005042
Ref: ee02005042
Ref: Documentation<7>-Footnote-12005293
Node: Tests<7>2005336
Ref: whatsnew/changelog id502005442
Ref: ee22005442
Ref: Tests<7>-Footnote-12008025
Ref: Tests<7>-Footnote-22008068
Ref: Tests<7>-Footnote-32008111
Ref: Tests<7>-Footnote-42008154
Ref: Tests<7>-Footnote-52008197
Ref: Tests<7>-Footnote-62008240
Ref: Tests<7>-Footnote-72008283
Ref: Tests<7>-Footnote-82008326
Ref: Tests<7>-Footnote-92008369
Ref: Tests<7>-Footnote-102008412
Ref: Tests<7>-Footnote-112008456
Ref: Tests<7>-Footnote-122008500
Ref: Tests<7>-Footnote-132008544
Ref: Tests<7>-Footnote-142008588
Ref: Tests<7>-Footnote-152008632
Ref: Tests<7>-Footnote-162008676
Ref: Tests<7>-Footnote-172008720
Node: Build<5>2008764
Ref: whatsnew/changelog id512008864
Ref: ee42008864
Ref: Build<5>-Footnote-12009135
Node: Windows<7>2009178
Ref: whatsnew/changelog id522009278
Ref: ee62009278
Ref: Windows<7>-Footnote-12009967
Ref: Windows<7>-Footnote-22010010
Ref: Windows<7>-Footnote-32010053
Ref: Windows<7>-Footnote-42010096
Ref: Windows<7>-Footnote-52010139
Ref: Windows<7>-Footnote-62010182
Node: macOS<5>2010225
Ref: whatsnew/changelog id532010324
Ref: ee72010324
Ref: macOS<5>-Footnote-12010796
Ref: macOS<5>-Footnote-22010839
Ref: macOS<5>-Footnote-32010882
Node: IDLE<9>2010925
Ref: whatsnew/changelog id542011022
Ref: ee82011022
Ref: IDLE<9>-Footnote-12012169
Ref: IDLE<9>-Footnote-22012212
Ref: IDLE<9>-Footnote-32012255
Ref: IDLE<9>-Footnote-42012298
Ref: IDLE<9>-Footnote-52012341
Ref: IDLE<9>-Footnote-62012384
Node: C API<5>2012426
Ref: whatsnew/changelog id552012506
Ref: ee92012506
Ref: C API<5>-Footnote-12013680
Ref: C API<5>-Footnote-22013723
Ref: C API<5>-Footnote-32013766
Ref: C API<5>-Footnote-42013809
Ref: C API<5>-Footnote-52013852
Ref: C API<5>-Footnote-62013895
Ref: C API<5>-Footnote-72013938
Ref: C API<5>-Footnote-82013981
Node: Python 3 8 0 beta 12014024
Ref: whatsnew/changelog python-3-8-0-beta-12014146
Ref: eec2014146
Node: Security<6>2014513
Ref: whatsnew/changelog id562014609
Ref: eed2014609
Ref: Security<6>-Footnote-12015198
Ref: Security<6>-Footnote-22015241
Ref: Security<6>-Footnote-32015284
Node: Core and Builtins<8>2015327
Ref: whatsnew/changelog id572015442
Ref: eee2015442
Ref: Core and Builtins<8>-Footnote-12023513
Ref: Core and Builtins<8>-Footnote-22023556
Ref: Core and Builtins<8>-Footnote-32023599
Ref: Core and Builtins<8>-Footnote-42023642
Ref: Core and Builtins<8>-Footnote-52023685
Ref: Core and Builtins<8>-Footnote-62023728
Ref: Core and Builtins<8>-Footnote-72023771
Ref: Core and Builtins<8>-Footnote-82023814
Ref: Core and Builtins<8>-Footnote-92023857
Ref: Core and Builtins<8>-Footnote-102023900
Ref: Core and Builtins<8>-Footnote-112023944
Ref: Core and Builtins<8>-Footnote-122023988
Ref: Core and Builtins<8>-Footnote-132024032
Ref: Core and Builtins<8>-Footnote-142024076
Ref: Core and Builtins<8>-Footnote-152024120
Ref: Core and Builtins<8>-Footnote-162024164
Ref: Core and Builtins<8>-Footnote-172024208
Ref: Core and Builtins<8>-Footnote-182024252
Ref: Core and Builtins<8>-Footnote-192024295
Ref: Core and Builtins<8>-Footnote-202024339
Ref: Core and Builtins<8>-Footnote-212024383
Ref: Core and Builtins<8>-Footnote-222024427
Ref: Core and Builtins<8>-Footnote-232024470
Ref: Core and Builtins<8>-Footnote-242024514
Ref: Core and Builtins<8>-Footnote-252024558
Ref: Core and Builtins<8>-Footnote-262024602
Ref: Core and Builtins<8>-Footnote-272024646
Ref: Core and Builtins<8>-Footnote-282024690
Ref: Core and Builtins<8>-Footnote-292024734
Ref: Core and Builtins<8>-Footnote-302024778
Ref: Core and Builtins<8>-Footnote-312024822
Ref: Core and Builtins<8>-Footnote-322024866
Ref: Core and Builtins<8>-Footnote-332024910
Ref: Core and Builtins<8>-Footnote-342024954
Ref: Core and Builtins<8>-Footnote-352024998
Ref: Core and Builtins<8>-Footnote-362025042
Ref: Core and Builtins<8>-Footnote-372025086
Ref: Core and Builtins<8>-Footnote-382025130
Ref: Core and Builtins<8>-Footnote-392025174
Ref: Core and Builtins<8>-Footnote-402025218
Ref: Core and Builtins<8>-Footnote-412025262
Ref: Core and Builtins<8>-Footnote-422025306
Ref: Core and Builtins<8>-Footnote-432025350
Ref: Core and Builtins<8>-Footnote-442025394
Node: Library<8>2025438
Ref: whatsnew/changelog id582025558
Ref: ef42025558
Ref: Library<8>-Footnote-12043855
Ref: Library<8>-Footnote-22043898
Ref: Library<8>-Footnote-32043941
Ref: Library<8>-Footnote-42043984
Ref: Library<8>-Footnote-52044027
Ref: Library<8>-Footnote-62044070
Ref: Library<8>-Footnote-72044113
Ref: Library<8>-Footnote-82044156
Ref: Library<8>-Footnote-92044199
Ref: Library<8>-Footnote-102044242
Ref: Library<8>-Footnote-112044286
Ref: Library<8>-Footnote-122044330
Ref: Library<8>-Footnote-132044374
Ref: Library<8>-Footnote-142044418
Ref: Library<8>-Footnote-152044462
Ref: Library<8>-Footnote-162044506
Ref: Library<8>-Footnote-172044550
Ref: Library<8>-Footnote-182044594
Ref: Library<8>-Footnote-192044638
Ref: Library<8>-Footnote-202044682
Ref: Library<8>-Footnote-212044726
Ref: Library<8>-Footnote-222044770
Ref: Library<8>-Footnote-232044814
Ref: Library<8>-Footnote-242044858
Ref: Library<8>-Footnote-252044904
Ref: Library<8>-Footnote-262044948
Ref: Library<8>-Footnote-272044992
Ref: Library<8>-Footnote-282045036
Ref: Library<8>-Footnote-292045080
Ref: Library<8>-Footnote-302045124
Ref: Library<8>-Footnote-312045168
Ref: Library<8>-Footnote-322045212
Ref: Library<8>-Footnote-332045256
Ref: Library<8>-Footnote-342045300
Ref: Library<8>-Footnote-352045344
Ref: Library<8>-Footnote-362045388
Ref: Library<8>-Footnote-372045432
Ref: Library<8>-Footnote-382045476
Ref: Library<8>-Footnote-392045520
Ref: Library<8>-Footnote-402045564
Ref: Library<8>-Footnote-412045608
Ref: Library<8>-Footnote-422045652
Ref: Library<8>-Footnote-432045696
Ref: Library<8>-Footnote-442045740
Ref: Library<8>-Footnote-452045784
Ref: Library<8>-Footnote-462045828
Ref: Library<8>-Footnote-472045872
Ref: Library<8>-Footnote-482045916
Ref: Library<8>-Footnote-492045960
Ref: Library<8>-Footnote-502046004
Ref: Library<8>-Footnote-512046048
Ref: Library<8>-Footnote-522046092
Ref: Library<8>-Footnote-532046136
Ref: Library<8>-Footnote-542046180
Ref: Library<8>-Footnote-552046224
Ref: Library<8>-Footnote-562046268
Ref: Library<8>-Footnote-572046312
Ref: Library<8>-Footnote-582046356
Ref: Library<8>-Footnote-592046400
Ref: Library<8>-Footnote-602046444
Ref: Library<8>-Footnote-612046488
Ref: Library<8>-Footnote-622046532
Ref: Library<8>-Footnote-632046576
Ref: Library<8>-Footnote-642046620
Ref: Library<8>-Footnote-652046664
Ref: Library<8>-Footnote-662046708
Ref: Library<8>-Footnote-672046752
Ref: Library<8>-Footnote-682046796
Ref: Library<8>-Footnote-692046839
Ref: Library<8>-Footnote-702046883
Ref: Library<8>-Footnote-712046926
Ref: Library<8>-Footnote-722046970
Ref: Library<8>-Footnote-732047014
Ref: Library<8>-Footnote-742047058
Ref: Library<8>-Footnote-752047102
Ref: Library<8>-Footnote-762047146
Ref: Library<8>-Footnote-772047190
Ref: Library<8>-Footnote-782047234
Ref: Library<8>-Footnote-792047278
Ref: Library<8>-Footnote-802047322
Ref: Library<8>-Footnote-812047366
Ref: Library<8>-Footnote-822047410
Ref: Library<8>-Footnote-832047454
Ref: Library<8>-Footnote-842047498
Ref: Library<8>-Footnote-852047542
Ref: Library<8>-Footnote-862047586
Ref: Library<8>-Footnote-872047630
Ref: Library<8>-Footnote-882047674
Ref: Library<8>-Footnote-892047718
Ref: Library<8>-Footnote-902047762
Ref: Library<8>-Footnote-912047806
Ref: Library<8>-Footnote-922047850
Ref: Library<8>-Footnote-932047894
Ref: Library<8>-Footnote-942047938
Ref: Library<8>-Footnote-952047982
Ref: Library<8>-Footnote-962048026
Ref: Library<8>-Footnote-972048070
Ref: Library<8>-Footnote-982048114
Ref: Library<8>-Footnote-992048158
Ref: Library<8>-Footnote-1002048202
Ref: Library<8>-Footnote-1012048247
Ref: Library<8>-Footnote-1022048292
Ref: Library<8>-Footnote-1032048337
Ref: Library<8>-Footnote-1042048382
Ref: Library<8>-Footnote-1052048427
Ref: Library<8>-Footnote-1062048472
Ref: Library<8>-Footnote-1072048517
Node: Documentation<8>2048562
Ref: whatsnew/changelog id592048670
Ref: f022048670
Ref: Documentation<8>-Footnote-12050760
Ref: Documentation<8>-Footnote-22050803
Ref: Documentation<8>-Footnote-32050846
Ref: Documentation<8>-Footnote-42050889
Ref: Documentation<8>-Footnote-52050932
Ref: Documentation<8>-Footnote-62050975
Ref: Documentation<8>-Footnote-72051018
Ref: Documentation<8>-Footnote-82051061
Ref: Documentation<8>-Footnote-92051104
Ref: Documentation<8>-Footnote-102051147
Ref: Documentation<8>-Footnote-112051191
Ref: Documentation<8>-Footnote-122051235
Ref: Documentation<8>-Footnote-132051279
Ref: Documentation<8>-Footnote-142051323
Node: Tests<8>2051367
Ref: whatsnew/changelog id602051473
Ref: f032051473
Ref: Tests<8>-Footnote-12053106
Ref: Tests<8>-Footnote-22053149
Ref: Tests<8>-Footnote-32053192
Ref: Tests<8>-Footnote-42053235
Ref: Tests<8>-Footnote-52053278
Ref: Tests<8>-Footnote-62053321
Ref: Tests<8>-Footnote-72053364
Ref: Tests<8>-Footnote-82053407
Ref: Tests<8>-Footnote-92053450
Ref: Tests<8>-Footnote-102053493
Node: Build<6>2053537
Ref: whatsnew/changelog id612053637
Ref: f052053637
Ref: Build<6>-Footnote-12054851
Ref: Build<6>-Footnote-22054894
Node: Windows<8>2054937
Ref: whatsnew/changelog id622055037
Ref: f062055037
Ref: Windows<8>-Footnote-12055461
Ref: Windows<8>-Footnote-22055504
Ref: Windows<8>-Footnote-32055547
Ref: Windows<8>-Footnote-42055590
Node: macOS<6>2055633
Ref: whatsnew/changelog id632055733
Ref: f072055733
Ref: macOS<6>-Footnote-12056033
Node: IDLE<10>2056076
Ref: whatsnew/changelog id642056180
Ref: f082056180
Ref: IDLE<10>-Footnote-12056780
Ref: IDLE<10>-Footnote-22056823
Ref: IDLE<10>-Footnote-32056866
Ref: IDLE<10>-Footnote-42056909
Ref: IDLE<10>-Footnote-52056952
Ref: IDLE<10>-Footnote-62056995
Node: Tools/Demos<5>2057038
Ref: whatsnew/changelog id652057142
Ref: f092057142
Ref: Tools/Demos<5>-Footnote-12057343
Node: C API<6>2057386
Ref: whatsnew/changelog id662057473
Ref: f0a2057473
Ref: C API<6>-Footnote-12058810
Ref: C API<6>-Footnote-22058853
Ref: C API<6>-Footnote-32058902
Ref: C API<6>-Footnote-42058945
Ref: C API<6>-Footnote-52058988
Ref: C API<6>-Footnote-62059031
Ref: C API<6>-Footnote-72059080
Ref: C API<6>-Footnote-82059123
Ref: C API<6>-Footnote-92059166
Node: Python 3 8 0 alpha 42059209
Ref: whatsnew/changelog python-3-8-0-alpha-42059332
Ref: f0c2059332
Node: Security<7>2059701
Ref: whatsnew/changelog id672059798
Ref: f0d2059798
Ref: Security<7>-Footnote-12060678
Ref: Security<7>-Footnote-22060721
Ref: Security<7>-Footnote-32060764
Node: Core and Builtins<9>2060807
Ref: whatsnew/changelog id682060923
Ref: f0f2060923
Ref: Core and Builtins<9>-Footnote-12064213
Ref: Core and Builtins<9>-Footnote-22064256
Ref: Core and Builtins<9>-Footnote-32064299
Ref: Core and Builtins<9>-Footnote-42064342
Ref: Core and Builtins<9>-Footnote-52064385
Ref: Core and Builtins<9>-Footnote-62064428
Ref: Core and Builtins<9>-Footnote-72064471
Ref: Core and Builtins<9>-Footnote-82064514
Ref: Core and Builtins<9>-Footnote-92064557
Ref: Core and Builtins<9>-Footnote-102064606
Ref: Core and Builtins<9>-Footnote-112064650
Ref: Core and Builtins<9>-Footnote-122064694
Ref: Core and Builtins<9>-Footnote-132064738
Ref: Core and Builtins<9>-Footnote-142064782
Ref: Core and Builtins<9>-Footnote-152064826
Ref: Core and Builtins<9>-Footnote-162064870
Ref: Core and Builtins<9>-Footnote-172064914
Ref: Core and Builtins<9>-Footnote-182064958
Ref: Core and Builtins<9>-Footnote-192065002
Ref: Core and Builtins<9>-Footnote-202065046
Node: Library<9>2065090
Ref: whatsnew/changelog id692065211
Ref: f102065211
Ref: Library<9>-Footnote-12074536
Ref: Library<9>-Footnote-22074579
Ref: Library<9>-Footnote-32074622
Ref: Library<9>-Footnote-42074665
Ref: Library<9>-Footnote-52074710
Ref: Library<9>-Footnote-62074753
Ref: Library<9>-Footnote-72074796
Ref: Library<9>-Footnote-82074839
Ref: Library<9>-Footnote-92074882
Ref: Library<9>-Footnote-102074925
Ref: Library<9>-Footnote-112074969
Ref: Library<9>-Footnote-122075013
Ref: Library<9>-Footnote-132075057
Ref: Library<9>-Footnote-142075101
Ref: Library<9>-Footnote-152075145
Ref: Library<9>-Footnote-162075189
Ref: Library<9>-Footnote-172075233
Ref: Library<9>-Footnote-182075277
Ref: Library<9>-Footnote-192075321
Ref: Library<9>-Footnote-202075365
Ref: Library<9>-Footnote-212075409
Ref: Library<9>-Footnote-222075453
Ref: Library<9>-Footnote-232075497
Ref: Library<9>-Footnote-242075541
Ref: Library<9>-Footnote-252075585
Ref: Library<9>-Footnote-262075629
Ref: Library<9>-Footnote-272075673
Ref: Library<9>-Footnote-282075717
Ref: Library<9>-Footnote-292075761
Ref: Library<9>-Footnote-302075805
Ref: Library<9>-Footnote-312075849
Ref: Library<9>-Footnote-322075893
Ref: Library<9>-Footnote-332075937
Ref: Library<9>-Footnote-342075981
Ref: Library<9>-Footnote-352076025
Ref: Library<9>-Footnote-362076069
Ref: Library<9>-Footnote-372076113
Ref: Library<9>-Footnote-382076157
Ref: Library<9>-Footnote-392076201
Ref: Library<9>-Footnote-402076245
Ref: Library<9>-Footnote-412076289
Ref: Library<9>-Footnote-422076333
Ref: Library<9>-Footnote-432076377
Ref: Library<9>-Footnote-442076421
Ref: Library<9>-Footnote-452076465
Ref: Library<9>-Footnote-462076509
Ref: Library<9>-Footnote-472076553
Ref: Library<9>-Footnote-482076597
Ref: Library<9>-Footnote-492076641
Ref: Library<9>-Footnote-502076685
Ref: Library<9>-Footnote-512076729
Ref: Library<9>-Footnote-522076773
Ref: Library<9>-Footnote-532076817
Ref: Library<9>-Footnote-542076861
Node: Documentation<9>2076905
Ref: whatsnew/changelog id702077014
Ref: f162077014
Ref: Documentation<9>-Footnote-12078461
Ref: Documentation<9>-Footnote-22078504
Ref: Documentation<9>-Footnote-32078547
Ref: Documentation<9>-Footnote-42078590
Ref: Documentation<9>-Footnote-52078633
Ref: Documentation<9>-Footnote-62078672
Ref: Documentation<9>-Footnote-72078715
Ref: Documentation<9>-Footnote-82078758
Ref: Documentation<9>-Footnote-92078801
Ref: Documentation<9>-Footnote-102078844
Ref: Documentation<9>-Footnote-112078888
Ref: Documentation<9>-Footnote-122078932
Node: Tests<9>2078976
Ref: whatsnew/changelog id712079083
Ref: f172079083
Ref: Tests<9>-Footnote-12081331
Ref: Tests<9>-Footnote-22081374
Ref: Tests<9>-Footnote-32081417
Ref: Tests<9>-Footnote-42081460
Ref: Tests<9>-Footnote-52081503
Ref: Tests<9>-Footnote-62081546
Ref: Tests<9>-Footnote-72081589
Ref: Tests<9>-Footnote-82081632
Ref: Tests<9>-Footnote-92081675
Ref: Tests<9>-Footnote-102081718
Ref: Tests<9>-Footnote-112081762
Ref: Tests<9>-Footnote-122081806
Ref: Tests<9>-Footnote-132081850
Ref: Tests<9>-Footnote-142081894
Ref: Tests<9>-Footnote-152081938
Node: Build<7>2081982
Ref: whatsnew/changelog id722082083
Ref: f192082083
Ref: Build<7>-Footnote-12085240
Ref: Build<7>-Footnote-22085283
Ref: Build<7>-Footnote-32085326
Ref: Build<7>-Footnote-42085369
Ref: Build<7>-Footnote-52085412
Ref: Build<7>-Footnote-62085455
Ref: Build<7>-Footnote-72085498
Ref: Build<7>-Footnote-82085541
Ref: Build<7>-Footnote-92085584
Ref: Build<7>-Footnote-102085627
Ref: Build<7>-Footnote-112085671
Ref: Build<7>-Footnote-122085715
Ref: Build<7>-Footnote-132085759
Node: Windows<9>2085803
Ref: whatsnew/changelog id732085904
Ref: f1a2085904
Ref: Windows<9>-Footnote-12088554
Ref: Windows<9>-Footnote-22088597
Ref: Windows<9>-Footnote-32088640
Ref: Windows<9>-Footnote-42088683
Ref: Windows<9>-Footnote-52088726
Ref: Windows<9>-Footnote-62088769
Ref: Windows<9>-Footnote-72088812
Ref: Windows<9>-Footnote-82088855
Ref: Windows<9>-Footnote-92088898
Ref: Windows<9>-Footnote-102088941
Ref: Windows<9>-Footnote-112088985
Ref: Windows<9>-Footnote-122089029
Node: macOS<7>2089073
Ref: whatsnew/changelog id742089174
Ref: f1b2089174
Ref: macOS<7>-Footnote-12089486
Ref: macOS<7>-Footnote-22089529
Node: IDLE<11>2089572
Ref: whatsnew/changelog id752089677
Ref: f1c2089677
Ref: IDLE<11>-Footnote-12089922
Node: Tools/Demos<6>2089965
Ref: whatsnew/changelog id762090070
Ref: f1d2090070
Ref: Tools/Demos<6>-Footnote-12090222
Node: C API<7>2090265
Ref: whatsnew/changelog id772090353
Ref: f1e2090353
Ref: C API<7>-Footnote-12092351
Ref: C API<7>-Footnote-22092394
Ref: C API<7>-Footnote-32092437
Ref: C API<7>-Footnote-42092480
Ref: C API<7>-Footnote-52092523
Ref: C API<7>-Footnote-62092566
Node: Python 3 8 0 alpha 32092609
Ref: whatsnew/changelog python-3-8-0-alpha-32092733
Ref: f202092733
Node: Security<8>2093090
Ref: whatsnew/changelog id782093188
Ref: f212093188
Ref: Security<8>-Footnote-12093751
Ref: Security<8>-Footnote-22093794
Node: Core and Builtins<10>2093837
Ref: whatsnew/changelog id792093955
Ref: f232093955
Ref: Core and Builtins<10>-Footnote-12097536
Ref: Core and Builtins<10>-Footnote-22097579
Ref: Core and Builtins<10>-Footnote-32097622
Ref: Core and Builtins<10>-Footnote-42097665
Ref: Core and Builtins<10>-Footnote-52097708
Ref: Core and Builtins<10>-Footnote-62097751
Ref: Core and Builtins<10>-Footnote-72097794
Ref: Core and Builtins<10>-Footnote-82097837
Ref: Core and Builtins<10>-Footnote-92097880
Ref: Core and Builtins<10>-Footnote-102097923
Ref: Core and Builtins<10>-Footnote-112097967
Ref: Core and Builtins<10>-Footnote-122098011
Ref: Core and Builtins<10>-Footnote-132098055
Ref: Core and Builtins<10>-Footnote-142098099
Ref: Core and Builtins<10>-Footnote-152098143
Ref: Core and Builtins<10>-Footnote-162098187
Ref: Core and Builtins<10>-Footnote-172098231
Ref: Core and Builtins<10>-Footnote-182098275
Ref: Core and Builtins<10>-Footnote-192098319
Ref: Core and Builtins<10>-Footnote-202098363
Ref: Core and Builtins<10>-Footnote-212098407
Ref: Core and Builtins<10>-Footnote-222098451
Node: Library<10>2098495
Ref: whatsnew/changelog id802098619
Ref: f252098619
Ref: Library<10>-Footnote-12104261
Ref: Library<10>-Footnote-22104304
Ref: Library<10>-Footnote-32104347
Ref: Library<10>-Footnote-42104390
Ref: Library<10>-Footnote-52104433
Ref: Library<10>-Footnote-62104476
Ref: Library<10>-Footnote-72104519
Ref: Library<10>-Footnote-82104562
Ref: Library<10>-Footnote-92104605
Ref: Library<10>-Footnote-102104648
Ref: Library<10>-Footnote-112104692
Ref: Library<10>-Footnote-122104736
Ref: Library<10>-Footnote-132104780
Ref: Library<10>-Footnote-142104824
Ref: Library<10>-Footnote-152104868
Ref: Library<10>-Footnote-162104912
Ref: Library<10>-Footnote-172104956
Ref: Library<10>-Footnote-182105000
Ref: Library<10>-Footnote-192105044
Ref: Library<10>-Footnote-202105088
Ref: Library<10>-Footnote-212105132
Ref: Library<10>-Footnote-222105176
Ref: Library<10>-Footnote-232105220
Ref: Library<10>-Footnote-242105264
Ref: Library<10>-Footnote-252105308
Ref: Library<10>-Footnote-262105352
Ref: Library<10>-Footnote-272105396
Ref: Library<10>-Footnote-282105440
Ref: Library<10>-Footnote-292105484
Ref: Library<10>-Footnote-302105528
Ref: Library<10>-Footnote-312105572
Ref: Library<10>-Footnote-322105616
Ref: Library<10>-Footnote-332105660
Ref: Library<10>-Footnote-342105704
Ref: Library<10>-Footnote-352105748
Ref: Library<10>-Footnote-362105792
Ref: Library<10>-Footnote-372105836
Node: Documentation<10>2105880
Ref: whatsnew/changelog id812105992
Ref: f272105992
Ref: Documentation<10>-Footnote-12106563
Ref: Documentation<10>-Footnote-22106606
Ref: Documentation<10>-Footnote-32106649
Node: Tests<10>2106692
Ref: whatsnew/changelog id822106801
Ref: f282106801
Ref: Tests<10>-Footnote-12107313
Ref: Tests<10>-Footnote-22107356
Ref: Tests<10>-Footnote-32107399
Node: Build<8>2107442
Ref: whatsnew/changelog id832107545
Ref: f292107545
Ref: Build<8>-Footnote-12108065
Ref: Build<8>-Footnote-22108108
Ref: Build<8>-Footnote-32108151
Ref: Build<8>-Footnote-42108194
Node: Windows<10>2108237
Ref: whatsnew/changelog id842108339
Ref: f2a2108339
Ref: Windows<10>-Footnote-12108790
Ref: Windows<10>-Footnote-22108833
Ref: Windows<10>-Footnote-32108876
Node: IDLE<12>2108919
Ref: whatsnew/changelog id852109027
Ref: f2b2109027
Ref: IDLE<12>-Footnote-12110136
Ref: IDLE<12>-Footnote-22110179
Ref: IDLE<12>-Footnote-32110222
Ref: IDLE<12>-Footnote-42110265
Ref: IDLE<12>-Footnote-52110308
Ref: IDLE<12>-Footnote-62110351
Ref: IDLE<12>-Footnote-72110394
Ref: IDLE<12>-Footnote-82110437
Ref: IDLE<12>-Footnote-92110480
Node: Tools/Demos<7>2110523
Ref: whatsnew/changelog id862110628
Ref: f2c2110628
Ref: Tools/Demos<7>-Footnote-12110841
Ref: Tools/Demos<7>-Footnote-22110884
Node: C API<8>2110927
Ref: whatsnew/changelog id872111015
Ref: f2d2111015
Ref: C API<8>-Footnote-12111407
Ref: C API<8>-Footnote-22111450
Node: Python 3 8 0 alpha 22111493
Ref: whatsnew/changelog python-3-8-0-alpha-22111617
Ref: f2e2111617
Node: Core and Builtins<11>2111880
Ref: whatsnew/changelog id882111978
Ref: f2f2111978
Ref: Core and Builtins<11>-Footnote-12115122
Ref: Core and Builtins<11>-Footnote-22115165
Ref: Core and Builtins<11>-Footnote-32115208
Ref: Core and Builtins<11>-Footnote-42115251
Ref: Core and Builtins<11>-Footnote-52115294
Ref: Core and Builtins<11>-Footnote-62115339
Ref: Core and Builtins<11>-Footnote-72115382
Ref: Core and Builtins<11>-Footnote-82115425
Ref: Core and Builtins<11>-Footnote-92115468
Ref: Core and Builtins<11>-Footnote-102115511
Ref: Core and Builtins<11>-Footnote-112115555
Ref: Core and Builtins<11>-Footnote-122115599
Ref: Core and Builtins<11>-Footnote-132115643
Ref: Core and Builtins<11>-Footnote-142115687
Ref: Core and Builtins<11>-Footnote-152115731
Ref: Core and Builtins<11>-Footnote-162115775
Ref: Core and Builtins<11>-Footnote-172115819
Node: Library<11>2115863
Ref: whatsnew/changelog id892115987
Ref: f312115987
Ref: Library<11>-Footnote-12119697
Ref: Library<11>-Footnote-22119740
Ref: Library<11>-Footnote-32119783
Ref: Library<11>-Footnote-42119826
Ref: Library<11>-Footnote-52119869
Ref: Library<11>-Footnote-62119912
Ref: Library<11>-Footnote-72119955
Ref: Library<11>-Footnote-82119998
Ref: Library<11>-Footnote-92120041
Ref: Library<11>-Footnote-102120084
Ref: Library<11>-Footnote-112120128
Ref: Library<11>-Footnote-122120172
Ref: Library<11>-Footnote-132120216
Ref: Library<11>-Footnote-142120260
Ref: Library<11>-Footnote-152120304
Ref: Library<11>-Footnote-162120348
Ref: Library<11>-Footnote-172120392
Node: Documentation<11>2120436
Ref: whatsnew/changelog id902120548
Ref: f352120548
Ref: Documentation<11>-Footnote-12120926
Ref: Documentation<11>-Footnote-22120969
Ref: Documentation<11>-Footnote-32121012
Node: Tests<11>2121055
Ref: whatsnew/changelog id912121167
Ref: f362121167
Ref: Tests<11>-Footnote-12122537
Ref: Tests<11>-Footnote-22122580
Ref: Tests<11>-Footnote-32122623
Ref: Tests<11>-Footnote-42122666
Ref: Tests<11>-Footnote-52122709
Ref: Tests<11>-Footnote-62122752
Ref: Tests<11>-Footnote-72122795
Ref: Tests<11>-Footnote-82122838
Node: Windows<11>2122881
Ref: whatsnew/changelog id922122984
Ref: f382122984
Ref: Windows<11>-Footnote-12123581
Ref: Windows<11>-Footnote-22123624
Ref: Windows<11>-Footnote-32123667
Ref: Windows<11>-Footnote-42123710
Ref: Windows<11>-Footnote-52123753
Node: IDLE<13>2123796
Ref: whatsnew/changelog id932123881
Ref: f392123881
Ref: IDLE<13>-Footnote-12124187
Ref: IDLE<13>-Footnote-22124230
Ref: IDLE<13>-Footnote-32124273
Node: Python 3 8 0 alpha 12124316
Ref: whatsnew/changelog python-3-8-0-alpha-12124438
Ref: f3a2124438
Node: Security<9>2124814
Ref: whatsnew/changelog id942124912
Ref: f3b2124912
Ref: Security<9>-Footnote-12127229
Ref: Security<9>-Footnote-22127272
Ref: Security<9>-Footnote-32127315
Ref: Security<9>-Footnote-42127358
Ref: Security<9>-Footnote-52127401
Ref: Security<9>-Footnote-62127444
Ref: Security<9>-Footnote-72127487
Ref: Security<9>-Footnote-82127530
Ref: Security<9>-Footnote-92127573
Ref: Security<9>-Footnote-102127616
Ref: Security<9>-Footnote-112127660
Ref: Security<9>-Footnote-122127704
Node: Core and Builtins<12>2127748
Ref: whatsnew/changelog id952127866
Ref: f3e2127866
Ref: Core and Builtins<12>-Footnote-12154083
Ref: Core and Builtins<12>-Footnote-22154126
Ref: Core and Builtins<12>-Footnote-32154169
Ref: Core and Builtins<12>-Footnote-42154212
Ref: Core and Builtins<12>-Footnote-52154255
Ref: Core and Builtins<12>-Footnote-62154298
Ref: Core and Builtins<12>-Footnote-72154341
Ref: Core and Builtins<12>-Footnote-82154384
Ref: Core and Builtins<12>-Footnote-92154427
Ref: Core and Builtins<12>-Footnote-102154470
Ref: Core and Builtins<12>-Footnote-112154514
Ref: Core and Builtins<12>-Footnote-122154558
Ref: Core and Builtins<12>-Footnote-132154602
Ref: Core and Builtins<12>-Footnote-142154646
Ref: Core and Builtins<12>-Footnote-152154690
Ref: Core and Builtins<12>-Footnote-162154734
Ref: Core and Builtins<12>-Footnote-172154778
Ref: Core and Builtins<12>-Footnote-182154822
Ref: Core and Builtins<12>-Footnote-192154866
Ref: Core and Builtins<12>-Footnote-202154910
Ref: Core and Builtins<12>-Footnote-212154954
Ref: Core and Builtins<12>-Footnote-222154998
Ref: Core and Builtins<12>-Footnote-232155042
Ref: Core and Builtins<12>-Footnote-242155086
Ref: Core and Builtins<12>-Footnote-252155130
Ref: Core and Builtins<12>-Footnote-262155180
Ref: Core and Builtins<12>-Footnote-272155224
Ref: Core and Builtins<12>-Footnote-282155268
Ref: Core and Builtins<12>-Footnote-292155312
Ref: Core and Builtins<12>-Footnote-302155356
Ref: Core and Builtins<12>-Footnote-312155400
Ref: Core and Builtins<12>-Footnote-322155444
Ref: Core and Builtins<12>-Footnote-332155488
Ref: Core and Builtins<12>-Footnote-342155532
Ref: Core and Builtins<12>-Footnote-352155576
Ref: Core and Builtins<12>-Footnote-362155620
Ref: Core and Builtins<12>-Footnote-372155664
Ref: Core and Builtins<12>-Footnote-382155708
Ref: Core and Builtins<12>-Footnote-392155752
Ref: Core and Builtins<12>-Footnote-402155796
Ref: Core and Builtins<12>-Footnote-412155840
Ref: Core and Builtins<12>-Footnote-422155884
Ref: Core and Builtins<12>-Footnote-432155928
Ref: Core and Builtins<12>-Footnote-442155972
Ref: Core and Builtins<12>-Footnote-452156016
Ref: Core and Builtins<12>-Footnote-462156060
Ref: Core and Builtins<12>-Footnote-472156104
Ref: Core and Builtins<12>-Footnote-482156148
Ref: Core and Builtins<12>-Footnote-492156192
Ref: Core and Builtins<12>-Footnote-502156236
Ref: Core and Builtins<12>-Footnote-512156280
Ref: Core and Builtins<12>-Footnote-522156324
Ref: Core and Builtins<12>-Footnote-532156368
Ref: Core and Builtins<12>-Footnote-542156412
Ref: Core and Builtins<12>-Footnote-552156456
Ref: Core and Builtins<12>-Footnote-562156500
Ref: Core and Builtins<12>-Footnote-572156544
Ref: Core and Builtins<12>-Footnote-582156588
Ref: Core and Builtins<12>-Footnote-592156632
Ref: Core and Builtins<12>-Footnote-602156675
Ref: Core and Builtins<12>-Footnote-612156719
Ref: Core and Builtins<12>-Footnote-622156763
Ref: Core and Builtins<12>-Footnote-632156807
Ref: Core and Builtins<12>-Footnote-642156851
Ref: Core and Builtins<12>-Footnote-652156895
Ref: Core and Builtins<12>-Footnote-662156939
Ref: Core and Builtins<12>-Footnote-672156983
Ref: Core and Builtins<12>-Footnote-682157027
Ref: Core and Builtins<12>-Footnote-692157071
Ref: Core and Builtins<12>-Footnote-702157115
Ref: Core and Builtins<12>-Footnote-712157159
Ref: Core and Builtins<12>-Footnote-722157203
Ref: Core and Builtins<12>-Footnote-732157247
Ref: Core and Builtins<12>-Footnote-742157291
Ref: Core and Builtins<12>-Footnote-752157335
Ref: Core and Builtins<12>-Footnote-762157379
Ref: Core and Builtins<12>-Footnote-772157423
Ref: Core and Builtins<12>-Footnote-782157467
Ref: Core and Builtins<12>-Footnote-792157511
Ref: Core and Builtins<12>-Footnote-802157555
Ref: Core and Builtins<12>-Footnote-812157599
Ref: Core and Builtins<12>-Footnote-822157643
Ref: Core and Builtins<12>-Footnote-832157687
Ref: Core and Builtins<12>-Footnote-842157731
Ref: Core and Builtins<12>-Footnote-852157775
Ref: Core and Builtins<12>-Footnote-862157819
Ref: Core and Builtins<12>-Footnote-872157863
Ref: Core and Builtins<12>-Footnote-882157907
Ref: Core and Builtins<12>-Footnote-892157951
Ref: Core and Builtins<12>-Footnote-902157995
Ref: Core and Builtins<12>-Footnote-912158039
Ref: Core and Builtins<12>-Footnote-922158083
Ref: Core and Builtins<12>-Footnote-932158127
Ref: Core and Builtins<12>-Footnote-942158171
Ref: Core and Builtins<12>-Footnote-952158215
Ref: Core and Builtins<12>-Footnote-962158259
Ref: Core and Builtins<12>-Footnote-972158305
Ref: Core and Builtins<12>-Footnote-982158349
Ref: Core and Builtins<12>-Footnote-992158393
Ref: Core and Builtins<12>-Footnote-1002158437
Ref: Core and Builtins<12>-Footnote-1012158482
Ref: Core and Builtins<12>-Footnote-1022158527
Ref: Core and Builtins<12>-Footnote-1032158572
Ref: Core and Builtins<12>-Footnote-1042158617
Ref: Core and Builtins<12>-Footnote-1052158662
Ref: Core and Builtins<12>-Footnote-1062158707
Ref: Core and Builtins<12>-Footnote-1072158752
Ref: Core and Builtins<12>-Footnote-1082158797
Ref: Core and Builtins<12>-Footnote-1092158842
Ref: Core and Builtins<12>-Footnote-1102158887
Ref: Core and Builtins<12>-Footnote-1112158932
Ref: Core and Builtins<12>-Footnote-1122158977
Ref: Core and Builtins<12>-Footnote-1132159022
Ref: Core and Builtins<12>-Footnote-1142159067
Ref: Core and Builtins<12>-Footnote-1152159112
Ref: Core and Builtins<12>-Footnote-1162159157
Ref: Core and Builtins<12>-Footnote-1172159202
Ref: Core and Builtins<12>-Footnote-1182159247
Ref: Core and Builtins<12>-Footnote-1192159292
Ref: Core and Builtins<12>-Footnote-1202159337
Ref: Core and Builtins<12>-Footnote-1212159382
Ref: Core and Builtins<12>-Footnote-1222159427
Ref: Core and Builtins<12>-Footnote-1232159472
Ref: Core and Builtins<12>-Footnote-1242159517
Ref: Core and Builtins<12>-Footnote-1252159562
Ref: Core and Builtins<12>-Footnote-1262159607
Ref: Core and Builtins<12>-Footnote-1272159652
Ref: Core and Builtins<12>-Footnote-1282159697
Ref: Core and Builtins<12>-Footnote-1292159742
Ref: Core and Builtins<12>-Footnote-1302159787
Ref: Core and Builtins<12>-Footnote-1312159832
Ref: Core and Builtins<12>-Footnote-1322159877
Ref: Core and Builtins<12>-Footnote-1332159922
Ref: Core and Builtins<12>-Footnote-1342159967
Ref: Core and Builtins<12>-Footnote-1352160012
Ref: Core and Builtins<12>-Footnote-1362160057
Ref: Core and Builtins<12>-Footnote-1372160102
Ref: Core and Builtins<12>-Footnote-1382160147
Ref: Core and Builtins<12>-Footnote-1392160192
Ref: Core and Builtins<12>-Footnote-1402160237
Ref: Core and Builtins<12>-Footnote-1412160282
Ref: Core and Builtins<12>-Footnote-1422160327
Ref: Core and Builtins<12>-Footnote-1432160372
Ref: Core and Builtins<12>-Footnote-1442160417
Ref: Core and Builtins<12>-Footnote-1452160462
Ref: Core and Builtins<12>-Footnote-1462160507
Ref: Core and Builtins<12>-Footnote-1472160552
Ref: Core and Builtins<12>-Footnote-1482160597
Ref: Core and Builtins<12>-Footnote-1492160642
Ref: Core and Builtins<12>-Footnote-1502160687
Ref: Core and Builtins<12>-Footnote-1512160732
Ref: Core and Builtins<12>-Footnote-1522160777
Ref: Core and Builtins<12>-Footnote-1532160822
Ref: Core and Builtins<12>-Footnote-1542160867
Ref: Core and Builtins<12>-Footnote-1552160912
Ref: Core and Builtins<12>-Footnote-1562160957
Ref: Core and Builtins<12>-Footnote-1572161002
Ref: Core and Builtins<12>-Footnote-1582161047
Ref: Core and Builtins<12>-Footnote-1592161092
Ref: Core and Builtins<12>-Footnote-1602161137
Ref: Core and Builtins<12>-Footnote-1612161182
Ref: Core and Builtins<12>-Footnote-1622161227
Node: Library<12>2161272
Ref: whatsnew/changelog id962161396
Ref: f4b2161396
Ref: Library<12>-Footnote-12232607
Ref: Library<12>-Footnote-22232650
Ref: Library<12>-Footnote-32232693
Ref: Library<12>-Footnote-42232736
Ref: Library<12>-Footnote-52232779
Ref: Library<12>-Footnote-62232822
Ref: Library<12>-Footnote-72232865
Ref: Library<12>-Footnote-82232908
Ref: Library<12>-Footnote-92232951
Ref: Library<12>-Footnote-102232994
Ref: Library<12>-Footnote-112233038
Ref: Library<12>-Footnote-122233082
Ref: Library<12>-Footnote-132233126
Ref: Library<12>-Footnote-142233170
Ref: Library<12>-Footnote-152233214
Ref: Library<12>-Footnote-162233258
Ref: Library<12>-Footnote-172233302
Ref: Library<12>-Footnote-182233346
Ref: Library<12>-Footnote-192233390
Ref: Library<12>-Footnote-202233434
Ref: Library<12>-Footnote-212233478
Ref: Library<12>-Footnote-222233522
Ref: Library<12>-Footnote-232233566
Ref: Library<12>-Footnote-242233610
Ref: Library<12>-Footnote-252233654
Ref: Library<12>-Footnote-262233698
Ref: Library<12>-Footnote-272233742
Ref: Library<12>-Footnote-282233786
Ref: Library<12>-Footnote-292233830
Ref: Library<12>-Footnote-302233874
Ref: Library<12>-Footnote-312233918
Ref: Library<12>-Footnote-322233962
Ref: Library<12>-Footnote-332234006
Ref: Library<12>-Footnote-342234050
Ref: Library<12>-Footnote-352234094
Ref: Library<12>-Footnote-362234138
Ref: Library<12>-Footnote-372234182
Ref: Library<12>-Footnote-382234226
Ref: Library<12>-Footnote-392234270
Ref: Library<12>-Footnote-402234314
Ref: Library<12>-Footnote-412234358
Ref: Library<12>-Footnote-422234402
Ref: Library<12>-Footnote-432234446
Ref: Library<12>-Footnote-442234490
Ref: Library<12>-Footnote-452234534
Ref: Library<12>-Footnote-462234578
Ref: Library<12>-Footnote-472234622
Ref: Library<12>-Footnote-482234666
Ref: Library<12>-Footnote-492234710
Ref: Library<12>-Footnote-502234754
Ref: Library<12>-Footnote-512234798
Ref: Library<12>-Footnote-522234842
Ref: Library<12>-Footnote-532234886
Ref: Library<12>-Footnote-542234930
Ref: Library<12>-Footnote-552234974
Ref: Library<12>-Footnote-562235018
Ref: Library<12>-Footnote-572235062
Ref: Library<12>-Footnote-582235106
Ref: Library<12>-Footnote-592235150
Ref: Library<12>-Footnote-602235194
Ref: Library<12>-Footnote-612235238
Ref: Library<12>-Footnote-622235282
Ref: Library<12>-Footnote-632235326
Ref: Library<12>-Footnote-642235370
Ref: Library<12>-Footnote-652235414
Ref: Library<12>-Footnote-662235458
Ref: Library<12>-Footnote-672235502
Ref: Library<12>-Footnote-682235546
Ref: Library<12>-Footnote-692235590
Ref: Library<12>-Footnote-702235634
Ref: Library<12>-Footnote-712235678
Ref: Library<12>-Footnote-722235722
Ref: Library<12>-Footnote-732235766
Ref: Library<12>-Footnote-742235810
Ref: Library<12>-Footnote-752235854
Ref: Library<12>-Footnote-762235898
Ref: Library<12>-Footnote-772235942
Ref: Library<12>-Footnote-782235986
Ref: Library<12>-Footnote-792236030
Ref: Library<12>-Footnote-802236074
Ref: Library<12>-Footnote-812236118
Ref: Library<12>-Footnote-822236162
Ref: Library<12>-Footnote-832236206
Ref: Library<12>-Footnote-842236250
Ref: Library<12>-Footnote-852236294
Ref: Library<12>-Footnote-862236338
Ref: Library<12>-Footnote-872236382
Ref: Library<12>-Footnote-882236426
Ref: Library<12>-Footnote-892236470
Ref: Library<12>-Footnote-902236514
Ref: Library<12>-Footnote-912236558
Ref: Library<12>-Footnote-922236602
Ref: Library<12>-Footnote-932236646
Ref: Library<12>-Footnote-942236696
Ref: Library<12>-Footnote-952236740
Ref: Library<12>-Footnote-962236784
Ref: Library<12>-Footnote-972236828
Ref: Library<12>-Footnote-982236872
Ref: Library<12>-Footnote-992236916
Ref: Library<12>-Footnote-1002236960
Ref: Library<12>-Footnote-1012237005
Ref: Library<12>-Footnote-1022237050
Ref: Library<12>-Footnote-1032237095
Ref: Library<12>-Footnote-1042237140
Ref: Library<12>-Footnote-1052237185
Ref: Library<12>-Footnote-1062237230
Ref: Library<12>-Footnote-1072237275
Ref: Library<12>-Footnote-1082237320
Ref: Library<12>-Footnote-1092237365
Ref: Library<12>-Footnote-1102237410
Ref: Library<12>-Footnote-1112237455
Ref: Library<12>-Footnote-1122237500
Ref: Library<12>-Footnote-1132237545
Ref: Library<12>-Footnote-1142237590
Ref: Library<12>-Footnote-1152237635
Ref: Library<12>-Footnote-1162237680
Ref: Library<12>-Footnote-1172237725
Ref: Library<12>-Footnote-1182237770
Ref: Library<12>-Footnote-1192237815
Ref: Library<12>-Footnote-1202237860
Ref: Library<12>-Footnote-1212237905
Ref: Library<12>-Footnote-1222237950
Ref: Library<12>-Footnote-1232237995
Ref: Library<12>-Footnote-1242238040
Ref: Library<12>-Footnote-1252238085
Ref: Library<12>-Footnote-1262238129
Ref: Library<12>-Footnote-1272238174
Ref: Library<12>-Footnote-1282238219
Ref: Library<12>-Footnote-1292238264
Ref: Library<12>-Footnote-1302238309
Ref: Library<12>-Footnote-1312238354
Ref: Library<12>-Footnote-1322238399
Ref: Library<12>-Footnote-1332238444
Ref: Library<12>-Footnote-1342238489
Ref: Library<12>-Footnote-1352238534
Ref: Library<12>-Footnote-1362238579
Ref: Library<12>-Footnote-1372238623
Ref: Library<12>-Footnote-1382238668
Ref: Library<12>-Footnote-1392238713
Ref: Library<12>-Footnote-1402238758
Ref: Library<12>-Footnote-1412238803
Ref: Library<12>-Footnote-1422238848
Ref: Library<12>-Footnote-1432238893
Ref: Library<12>-Footnote-1442238938
Ref: Library<12>-Footnote-1452238983
Ref: Library<12>-Footnote-1462239028
Ref: Library<12>-Footnote-1472239073
Ref: Library<12>-Footnote-1482239118
Ref: Library<12>-Footnote-1492239163
Ref: Library<12>-Footnote-1502239208
Ref: Library<12>-Footnote-1512239253
Ref: Library<12>-Footnote-1522239298
Ref: Library<12>-Footnote-1532239343
Ref: Library<12>-Footnote-1542239388
Ref: Library<12>-Footnote-1552239432
Ref: Library<12>-Footnote-1562239477
Ref: Library<12>-Footnote-1572239522
Ref: Library<12>-Footnote-1582239567
Ref: Library<12>-Footnote-1592239612
Ref: Library<12>-Footnote-1602239657
Ref: Library<12>-Footnote-1612239702
Ref: Library<12>-Footnote-1622239747
Ref: Library<12>-Footnote-1632239792
Ref: Library<12>-Footnote-1642239837
Ref: Library<12>-Footnote-1652239881
Ref: Library<12>-Footnote-1662239926
Ref: Library<12>-Footnote-1672239971
Ref: Library<12>-Footnote-1682240016
Ref: Library<12>-Footnote-1692240061
Ref: Library<12>-Footnote-1702240106
Ref: Library<12>-Footnote-1712240151
Ref: Library<12>-Footnote-1722240196
Ref: Library<12>-Footnote-1732240241
Ref: Library<12>-Footnote-1742240285
Ref: Library<12>-Footnote-1752240330
Ref: Library<12>-Footnote-1762240375
Ref: Library<12>-Footnote-1772240420
Ref: Library<12>-Footnote-1782240465
Ref: Library<12>-Footnote-1792240510
Ref: Library<12>-Footnote-1802240554
Ref: Library<12>-Footnote-1812240599
Ref: Library<12>-Footnote-1822240644
Ref: Library<12>-Footnote-1832240689
Ref: Library<12>-Footnote-1842240734
Ref: Library<12>-Footnote-1852240779
Ref: Library<12>-Footnote-1862240824
Ref: Library<12>-Footnote-1872240869
Ref: Library<12>-Footnote-1882240914
Ref: Library<12>-Footnote-1892240959
Ref: Library<12>-Footnote-1902241004
Ref: Library<12>-Footnote-1912241049
Ref: Library<12>-Footnote-1922241094
Ref: Library<12>-Footnote-1932241139
Ref: Library<12>-Footnote-1942241184
Ref: Library<12>-Footnote-1952241229
Ref: Library<12>-Footnote-1962241274
Ref: Library<12>-Footnote-1972241319
Ref: Library<12>-Footnote-1982241364
Ref: Library<12>-Footnote-1992241409
Ref: Library<12>-Footnote-2002241454
Ref: Library<12>-Footnote-2012241499
Ref: Library<12>-Footnote-2022241545
Ref: Library<12>-Footnote-2032241590
Ref: Library<12>-Footnote-2042241635
Ref: Library<12>-Footnote-2052241680
Ref: Library<12>-Footnote-2062241725
Ref: Library<12>-Footnote-2072241770
Ref: Library<12>-Footnote-2082241815
Ref: Library<12>-Footnote-2092241860
Ref: Library<12>-Footnote-2102241905
Ref: Library<12>-Footnote-2112241950
Ref: Library<12>-Footnote-2122241995
Ref: Library<12>-Footnote-2132242046
Ref: Library<12>-Footnote-2142242091
Ref: Library<12>-Footnote-2152242136
Ref: Library<12>-Footnote-2162242181
Ref: Library<12>-Footnote-2172242226
Ref: Library<12>-Footnote-2182242271
Ref: Library<12>-Footnote-2192242316
Ref: Library<12>-Footnote-2202242361
Ref: Library<12>-Footnote-2212242406
Ref: Library<12>-Footnote-2222242451
Ref: Library<12>-Footnote-2232242496
Ref: Library<12>-Footnote-2242242541
Ref: Library<12>-Footnote-2252242586
Ref: Library<12>-Footnote-2262242631
Ref: Library<12>-Footnote-2272242676
Ref: Library<12>-Footnote-2282242721
Ref: Library<12>-Footnote-2292242766
Ref: Library<12>-Footnote-2302242811
Ref: Library<12>-Footnote-2312242856
Ref: Library<12>-Footnote-2322242901
Ref: Library<12>-Footnote-2332242946
Ref: Library<12>-Footnote-2342242991
Ref: Library<12>-Footnote-2352243036
Ref: Library<12>-Footnote-2362243081
Ref: Library<12>-Footnote-2372243126
Ref: Library<12>-Footnote-2382243171
Ref: Library<12>-Footnote-2392243216
Ref: Library<12>-Footnote-2402243261
Ref: Library<12>-Footnote-2412243306
Ref: Library<12>-Footnote-2422243351
Ref: Library<12>-Footnote-2432243396
Ref: Library<12>-Footnote-2442243441
Ref: Library<12>-Footnote-2452243486
Ref: Library<12>-Footnote-2462243531
Ref: Library<12>-Footnote-2472243576
Ref: Library<12>-Footnote-2482243621
Ref: Library<12>-Footnote-2492243666
Ref: Library<12>-Footnote-2502243711
Ref: Library<12>-Footnote-2512243756
Ref: Library<12>-Footnote-2522243801
Ref: Library<12>-Footnote-2532243846
Ref: Library<12>-Footnote-2542243891
Ref: Library<12>-Footnote-2552243936
Ref: Library<12>-Footnote-2562243981
Ref: Library<12>-Footnote-2572244026
Ref: Library<12>-Footnote-2582244071
Ref: Library<12>-Footnote-2592244116
Ref: Library<12>-Footnote-2602244160
Ref: Library<12>-Footnote-2612244205
Ref: Library<12>-Footnote-2622244250
Ref: Library<12>-Footnote-2632244295
Ref: Library<12>-Footnote-2642244340
Ref: Library<12>-Footnote-2652244385
Ref: Library<12>-Footnote-2662244430
Ref: Library<12>-Footnote-2672244475
Ref: Library<12>-Footnote-2682244520
Ref: Library<12>-Footnote-2692244565
Ref: Library<12>-Footnote-2702244610
Ref: Library<12>-Footnote-2712244655
Ref: Library<12>-Footnote-2722244700
Ref: Library<12>-Footnote-2732244745
Ref: Library<12>-Footnote-2742244790
Ref: Library<12>-Footnote-2752244835
Ref: Library<12>-Footnote-2762244880
Ref: Library<12>-Footnote-2772244925
Ref: Library<12>-Footnote-2782244970
Ref: Library<12>-Footnote-2792245015
Ref: Library<12>-Footnote-2802245060
Ref: Library<12>-Footnote-2812245105
Ref: Library<12>-Footnote-2822245150
Ref: Library<12>-Footnote-2832245195
Ref: Library<12>-Footnote-2842245240
Ref: Library<12>-Footnote-2852245285
Ref: Library<12>-Footnote-2862245330
Ref: Library<12>-Footnote-2872245375
Ref: Library<12>-Footnote-2882245420
Ref: Library<12>-Footnote-2892245465
Ref: Library<12>-Footnote-2902245510
Ref: Library<12>-Footnote-2912245555
Ref: Library<12>-Footnote-2922245600
Ref: Library<12>-Footnote-2932245645
Ref: Library<12>-Footnote-2942245690
Ref: Library<12>-Footnote-2952245735
Ref: Library<12>-Footnote-2962245780
Ref: Library<12>-Footnote-2972245825
Ref: Library<12>-Footnote-2982245870
Ref: Library<12>-Footnote-2992245915
Ref: Library<12>-Footnote-3002245960
Ref: Library<12>-Footnote-3012246005
Ref: Library<12>-Footnote-3022246050
Ref: Library<12>-Footnote-3032246095
Ref: Library<12>-Footnote-3042246140
Ref: Library<12>-Footnote-3052246185
Ref: Library<12>-Footnote-3062246230
Ref: Library<12>-Footnote-3072246275
Ref: Library<12>-Footnote-3082246320
Ref: Library<12>-Footnote-3092246365
Ref: Library<12>-Footnote-3102246410
Ref: Library<12>-Footnote-3112246455
Ref: Library<12>-Footnote-3122246500
Ref: Library<12>-Footnote-3132246545
Ref: Library<12>-Footnote-3142246590
Ref: Library<12>-Footnote-3152246635
Ref: Library<12>-Footnote-3162246680
Ref: Library<12>-Footnote-3172246725
Ref: Library<12>-Footnote-3182246770
Ref: Library<12>-Footnote-3192246815
Ref: Library<12>-Footnote-3202246860
Ref: Library<12>-Footnote-3212246905
Ref: Library<12>-Footnote-3222246950
Ref: Library<12>-Footnote-3232246995
Ref: Library<12>-Footnote-3242247040
Ref: Library<12>-Footnote-3252247085
Ref: Library<12>-Footnote-3262247130
Ref: Library<12>-Footnote-3272247175
Ref: Library<12>-Footnote-3282247221
Ref: Library<12>-Footnote-3292247266
Ref: Library<12>-Footnote-3302247311
Ref: Library<12>-Footnote-3312247356
Ref: Library<12>-Footnote-3322247401
Ref: Library<12>-Footnote-3332247446
Ref: Library<12>-Footnote-3342247491
Ref: Library<12>-Footnote-3352247536
Ref: Library<12>-Footnote-3362247581
Ref: Library<12>-Footnote-3372247626
Ref: Library<12>-Footnote-3382247671
Ref: Library<12>-Footnote-3392247716
Ref: Library<12>-Footnote-3402247761
Ref: Library<12>-Footnote-3412247806
Ref: Library<12>-Footnote-3422247851
Ref: Library<12>-Footnote-3432247896
Ref: Library<12>-Footnote-3442247941
Ref: Library<12>-Footnote-3452247992
Ref: Library<12>-Footnote-3462248037
Ref: Library<12>-Footnote-3472248082
Ref: Library<12>-Footnote-3482248127
Ref: Library<12>-Footnote-3492248178
Ref: Library<12>-Footnote-3502248223
Ref: Library<12>-Footnote-3512248268
Ref: Library<12>-Footnote-3522248313
Ref: Library<12>-Footnote-3532248358
Ref: Library<12>-Footnote-3542248403
Ref: Library<12>-Footnote-3552248448
Ref: Library<12>-Footnote-3562248493
Ref: Library<12>-Footnote-3572248538
Ref: Library<12>-Footnote-3582248583
Ref: Library<12>-Footnote-3592248628
Ref: Library<12>-Footnote-3602248673
Ref: Library<12>-Footnote-3612248718
Ref: Library<12>-Footnote-3622248763
Ref: Library<12>-Footnote-3632248808
Ref: Library<12>-Footnote-3642248853
Ref: Library<12>-Footnote-3652248898
Ref: Library<12>-Footnote-3662248943
Ref: Library<12>-Footnote-3672248988
Ref: Library<12>-Footnote-3682249033
Ref: Library<12>-Footnote-3692249078
Ref: Library<12>-Footnote-3702249123
Ref: Library<12>-Footnote-3712249168
Ref: Library<12>-Footnote-3722249213
Ref: Library<12>-Footnote-3732249258
Ref: Library<12>-Footnote-3742249303
Ref: Library<12>-Footnote-3752249348
Ref: Library<12>-Footnote-3762249393
Ref: Library<12>-Footnote-3772249438
Ref: Library<12>-Footnote-3782249483
Ref: Library<12>-Footnote-3792249528
Ref: Library<12>-Footnote-3802249573
Ref: Library<12>-Footnote-3812249618
Ref: Library<12>-Footnote-3822249663
Ref: Library<12>-Footnote-3832249708
Ref: Library<12>-Footnote-3842249753
Ref: Library<12>-Footnote-3852249798
Ref: Library<12>-Footnote-3862249843
Ref: Library<12>-Footnote-3872249888
Ref: Library<12>-Footnote-3882249933
Ref: Library<12>-Footnote-3892249978
Ref: Library<12>-Footnote-3902250023
Ref: Library<12>-Footnote-3912250068
Ref: Library<12>-Footnote-3922250113
Ref: Library<12>-Footnote-3932250158
Ref: Library<12>-Footnote-3942250203
Ref: Library<12>-Footnote-3952250248
Ref: Library<12>-Footnote-3962250293
Ref: Library<12>-Footnote-3972250338
Ref: Library<12>-Footnote-3982250383
Ref: Library<12>-Footnote-3992250428
Ref: Library<12>-Footnote-4002250473
Ref: Library<12>-Footnote-4012250518
Ref: Library<12>-Footnote-4022250563
Ref: Library<12>-Footnote-4032250608
Ref: Library<12>-Footnote-4042250653
Ref: Library<12>-Footnote-4052250698
Ref: Library<12>-Footnote-4062250743
Ref: Library<12>-Footnote-4072250788
Ref: Library<12>-Footnote-4082250833
Ref: Library<12>-Footnote-4092250878
Ref: Library<12>-Footnote-4102250923
Ref: Library<12>-Footnote-4112250968
Ref: Library<12>-Footnote-4122251013
Ref: Library<12>-Footnote-4132251058
Ref: Library<12>-Footnote-4142251103
Ref: Library<12>-Footnote-4152251148
Ref: Library<12>-Footnote-4162251193
Ref: Library<12>-Footnote-4172251238
Ref: Library<12>-Footnote-4182251283
Ref: Library<12>-Footnote-4192251328
Ref: Library<12>-Footnote-4202251373
Ref: Library<12>-Footnote-4212251418
Ref: Library<12>-Footnote-4222251462
Ref: Library<12>-Footnote-4232251507
Ref: Library<12>-Footnote-4242251552
Ref: Library<12>-Footnote-4252251597
Ref: Library<12>-Footnote-4262251642
Ref: Library<12>-Footnote-4272251687
Ref: Library<12>-Footnote-4282251732
Ref: Library<12>-Footnote-4292251777
Ref: Library<12>-Footnote-4302251822
Ref: Library<12>-Footnote-4312251867
Ref: Library<12>-Footnote-4322251912
Ref: Library<12>-Footnote-4332251957
Ref: Library<12>-Footnote-4342252002
Ref: Library<12>-Footnote-4352252047
Ref: Library<12>-Footnote-4362252092
Node: Documentation<12>2252137
Ref: whatsnew/changelog id972252249
Ref: f772252249
Ref: Documentation<12>-Footnote-12258957
Ref: Documentation<12>-Footnote-22259000
Ref: Documentation<12>-Footnote-32259043
Ref: Documentation<12>-Footnote-42259086
Ref: Documentation<12>-Footnote-52259129
Ref: Documentation<12>-Footnote-62259172
Ref: Documentation<12>-Footnote-72259215
Ref: Documentation<12>-Footnote-82259258
Ref: Documentation<12>-Footnote-92259301
Ref: Documentation<12>-Footnote-102259344
Ref: Documentation<12>-Footnote-112259388
Ref: Documentation<12>-Footnote-122259432
Ref: Documentation<12>-Footnote-132259476
Ref: Documentation<12>-Footnote-142259520
Ref: Documentation<12>-Footnote-152259564
Ref: Documentation<12>-Footnote-162259608
Ref: Documentation<12>-Footnote-172259652
Ref: Documentation<12>-Footnote-182259696
Ref: Documentation<12>-Footnote-192259740
Ref: Documentation<12>-Footnote-202259784
Ref: Documentation<12>-Footnote-212259828
Ref: Documentation<12>-Footnote-222259872
Ref: Documentation<12>-Footnote-232259916
Ref: Documentation<12>-Footnote-242259966
Ref: Documentation<12>-Footnote-252260010
Ref: Documentation<12>-Footnote-262260054
Ref: Documentation<12>-Footnote-272260098
Ref: Documentation<12>-Footnote-282260142
Ref: Documentation<12>-Footnote-292260186
Ref: Documentation<12>-Footnote-302260236
Ref: Documentation<12>-Footnote-312260280
Ref: Documentation<12>-Footnote-322260324
Ref: Documentation<12>-Footnote-332260368
Ref: Documentation<12>-Footnote-342260412
Ref: Documentation<12>-Footnote-352260456
Ref: Documentation<12>-Footnote-362260500
Ref: Documentation<12>-Footnote-372260544
Ref: Documentation<12>-Footnote-382260588
Ref: Documentation<12>-Footnote-392260632
Ref: Documentation<12>-Footnote-402260676
Ref: Documentation<12>-Footnote-412260720
Ref: Documentation<12>-Footnote-422260764
Ref: Documentation<12>-Footnote-432260808
Ref: Documentation<12>-Footnote-442260852
Ref: Documentation<12>-Footnote-452260896
Ref: Documentation<12>-Footnote-462260940
Ref: Documentation<12>-Footnote-472260984
Ref: Documentation<12>-Footnote-482261028
Ref: Documentation<12>-Footnote-492261072
Ref: Documentation<12>-Footnote-502261116
Ref: Documentation<12>-Footnote-512261159
Ref: Documentation<12>-Footnote-522261203
Ref: Documentation<12>-Footnote-532261247
Ref: Documentation<12>-Footnote-542261291
Ref: Documentation<12>-Footnote-552261335
Ref: Documentation<12>-Footnote-562261379
Ref: Documentation<12>-Footnote-572261422
Ref: Documentation<12>-Footnote-582261466
Ref: Documentation<12>-Footnote-592261510
Node: Tests<12>2261554
Ref: whatsnew/changelog id982261663
Ref: f7a2261663
Ref: Tests<12>-Footnote-12269272
Ref: Tests<12>-Footnote-22269315
Ref: Tests<12>-Footnote-32269358
Ref: Tests<12>-Footnote-42269401
Ref: Tests<12>-Footnote-52269444
Ref: Tests<12>-Footnote-62269487
Ref: Tests<12>-Footnote-72269530
Ref: Tests<12>-Footnote-82269573
Ref: Tests<12>-Footnote-92269616
Ref: Tests<12>-Footnote-102269659
Ref: Tests<12>-Footnote-112269703
Ref: Tests<12>-Footnote-122269747
Ref: Tests<12>-Footnote-132269791
Ref: Tests<12>-Footnote-142269835
Ref: Tests<12>-Footnote-152269879
Ref: Tests<12>-Footnote-162269923
Ref: Tests<12>-Footnote-172269967
Ref: Tests<12>-Footnote-182270011
Ref: Tests<12>-Footnote-192270055
Ref: Tests<12>-Footnote-202270099
Ref: Tests<12>-Footnote-212270143
Ref: Tests<12>-Footnote-222270187
Ref: Tests<12>-Footnote-232270231
Ref: Tests<12>-Footnote-242270275
Ref: Tests<12>-Footnote-252270319
Ref: Tests<12>-Footnote-262270363
Ref: Tests<12>-Footnote-272270407
Ref: Tests<12>-Footnote-282270451
Ref: Tests<12>-Footnote-292270495
Ref: Tests<12>-Footnote-302270539
Ref: Tests<12>-Footnote-312270583
Ref: Tests<12>-Footnote-322270627
Ref: Tests<12>-Footnote-332270671
Ref: Tests<12>-Footnote-342270715
Ref: Tests<12>-Footnote-352270759
Ref: Tests<12>-Footnote-362270803
Ref: Tests<12>-Footnote-372270847
Ref: Tests<12>-Footnote-382270891
Ref: Tests<12>-Footnote-392270935
Ref: Tests<12>-Footnote-402270979
Ref: Tests<12>-Footnote-412271023
Ref: Tests<12>-Footnote-422271067
Ref: Tests<12>-Footnote-432271111
Ref: Tests<12>-Footnote-442271155
Ref: Tests<12>-Footnote-452271199
Ref: Tests<12>-Footnote-462271243
Ref: Tests<12>-Footnote-472271287
Ref: Tests<12>-Footnote-482271331
Node: Build<9>2271375
Ref: whatsnew/changelog id992271478
Ref: f7c2271478
Ref: Build<9>-Footnote-12276599
Ref: Build<9>-Footnote-22276642
Ref: Build<9>-Footnote-32276685
Ref: Build<9>-Footnote-42276728
Ref: Build<9>-Footnote-52276771
Ref: Build<9>-Footnote-62276814
Ref: Build<9>-Footnote-72276857
Ref: Build<9>-Footnote-82276900
Ref: Build<9>-Footnote-92276943
Ref: Build<9>-Footnote-102276986
Ref: Build<9>-Footnote-112277030
Ref: Build<9>-Footnote-122277074
Ref: Build<9>-Footnote-132277118
Ref: Build<9>-Footnote-142277162
Ref: Build<9>-Footnote-152277206
Ref: Build<9>-Footnote-162277250
Ref: Build<9>-Footnote-172277294
Ref: Build<9>-Footnote-182277338
Ref: Build<9>-Footnote-192277382
Ref: Build<9>-Footnote-202277426
Ref: Build<9>-Footnote-212277470
Ref: Build<9>-Footnote-222277514
Ref: Build<9>-Footnote-232277558
Ref: Build<9>-Footnote-242277601
Ref: Build<9>-Footnote-252277645
Ref: Build<9>-Footnote-262277689
Ref: Build<9>-Footnote-272277733
Ref: Build<9>-Footnote-282277777
Ref: Build<9>-Footnote-292277821
Ref: Build<9>-Footnote-302277865
Ref: Build<9>-Footnote-312277909
Ref: Build<9>-Footnote-322277953
Ref: Build<9>-Footnote-332277997
Ref: Build<9>-Footnote-342278041
Ref: Build<9>-Footnote-352278085
Ref: Build<9>-Footnote-362278129
Ref: Build<9>-Footnote-372278173
Node: Windows<12>2278217
Ref: whatsnew/changelog id1002278319
Ref: f7d2278319
Ref: Windows<12>-Footnote-12282742
Ref: Windows<12>-Footnote-22282785
Ref: Windows<12>-Footnote-32282828
Ref: Windows<12>-Footnote-42282871
Ref: Windows<12>-Footnote-52282914
Ref: Windows<12>-Footnote-62282957
Ref: Windows<12>-Footnote-72283000
Ref: Windows<12>-Footnote-82283043
Ref: Windows<12>-Footnote-92283086
Ref: Windows<12>-Footnote-102283129
Ref: Windows<12>-Footnote-112283173
Ref: Windows<12>-Footnote-122283217
Ref: Windows<12>-Footnote-132283261
Ref: Windows<12>-Footnote-142283305
Ref: Windows<12>-Footnote-152283349
Ref: Windows<12>-Footnote-162283393
Ref: Windows<12>-Footnote-172283437
Ref: Windows<12>-Footnote-182283481
Ref: Windows<12>-Footnote-192283525
Ref: Windows<12>-Footnote-202283569
Ref: Windows<12>-Footnote-212283613
Ref: Windows<12>-Footnote-222283657
Ref: Windows<12>-Footnote-232283701
Ref: Windows<12>-Footnote-242283745
Ref: Windows<12>-Footnote-252283789
Ref: Windows<12>-Footnote-262283833
Ref: Windows<12>-Footnote-272283877
Ref: Windows<12>-Footnote-282283921
Ref: Windows<12>-Footnote-292283965
Ref: Windows<12>-Footnote-302284009
Ref: Windows<12>-Footnote-312284053
Ref: Windows<12>-Footnote-322284097
Ref: Windows<12>-Footnote-332284141
Ref: Windows<12>-Footnote-342284185
Ref: Windows<12>-Footnote-352284229
Ref: Windows<12>-Footnote-362284273
Ref: Windows<12>-Footnote-372284317
Ref: Windows<12>-Footnote-382284361
Ref: Windows<12>-Footnote-392284405
Ref: Windows<12>-Footnote-402284449
Node: macOS<8>2284492
Ref: whatsnew/changelog id1012284594
Ref: f7e2284594
Ref: macOS<8>-Footnote-12286201
Ref: macOS<8>-Footnote-22286244
Ref: macOS<8>-Footnote-32286287
Ref: macOS<8>-Footnote-42286330
Ref: macOS<8>-Footnote-52286373
Ref: macOS<8>-Footnote-62286416
Ref: macOS<8>-Footnote-72286459
Ref: macOS<8>-Footnote-82286502
Ref: macOS<8>-Footnote-92286545
Ref: macOS<8>-Footnote-102286588
Node: IDLE<14>2286632
Ref: whatsnew/changelog id1022286737
Ref: f7f2286737
Ref: IDLE<14>-Footnote-12295193
Ref: IDLE<14>-Footnote-22295236
Ref: IDLE<14>-Footnote-32295279
Ref: IDLE<14>-Footnote-42295322
Ref: IDLE<14>-Footnote-52295365
Ref: IDLE<14>-Footnote-62295408
Ref: IDLE<14>-Footnote-72295451
Ref: IDLE<14>-Footnote-82295494
Ref: IDLE<14>-Footnote-92295537
Ref: IDLE<14>-Footnote-102295580
Ref: IDLE<14>-Footnote-112295624
Ref: IDLE<14>-Footnote-122295668
Ref: IDLE<14>-Footnote-132295712
Ref: IDLE<14>-Footnote-142295756
Ref: IDLE<14>-Footnote-152295800
Ref: IDLE<14>-Footnote-162295844
Ref: IDLE<14>-Footnote-172295888
Ref: IDLE<14>-Footnote-182295932
Ref: IDLE<14>-Footnote-192295976
Ref: IDLE<14>-Footnote-202296020
Ref: IDLE<14>-Footnote-212296064
Ref: IDLE<14>-Footnote-222296108
Ref: IDLE<14>-Footnote-232296152
Ref: IDLE<14>-Footnote-242296196
Ref: IDLE<14>-Footnote-252296240
Ref: IDLE<14>-Footnote-262296284
Ref: IDLE<14>-Footnote-272296328
Ref: IDLE<14>-Footnote-282296374
Ref: IDLE<14>-Footnote-292296418
Ref: IDLE<14>-Footnote-302296462
Ref: IDLE<14>-Footnote-312296506
Ref: IDLE<14>-Footnote-322296550
Ref: IDLE<14>-Footnote-332296594
Ref: IDLE<14>-Footnote-342296638
Ref: IDLE<14>-Footnote-352296682
Ref: IDLE<14>-Footnote-362296726
Ref: IDLE<14>-Footnote-372296770
Ref: IDLE<14>-Footnote-382296814
Ref: IDLE<14>-Footnote-392296858
Ref: IDLE<14>-Footnote-402296902
Ref: IDLE<14>-Footnote-412296946
Ref: IDLE<14>-Footnote-422296990
Ref: IDLE<14>-Footnote-432297034
Ref: IDLE<14>-Footnote-442297078
Ref: IDLE<14>-Footnote-452297122
Ref: IDLE<14>-Footnote-462297166
Ref: IDLE<14>-Footnote-472297210
Ref: IDLE<14>-Footnote-482297254
Ref: IDLE<14>-Footnote-492297298
Ref: IDLE<14>-Footnote-502297342
Ref: IDLE<14>-Footnote-512297386
Ref: IDLE<14>-Footnote-522297430
Ref: IDLE<14>-Footnote-532297474
Ref: IDLE<14>-Footnote-542297518
Ref: IDLE<14>-Footnote-552297562
Ref: IDLE<14>-Footnote-562297606
Ref: IDLE<14>-Footnote-572297650
Ref: IDLE<14>-Footnote-582297694
Ref: IDLE<14>-Footnote-592297738
Node: Tools/Demos<8>2297782
Ref: whatsnew/changelog id1032297887
Ref: f802297887
Ref: Tools/Demos<8>-Footnote-12299536
Ref: Tools/Demos<8>-Footnote-22299579
Ref: Tools/Demos<8>-Footnote-32299622
Ref: Tools/Demos<8>-Footnote-42299665
Ref: Tools/Demos<8>-Footnote-52299708
Ref: Tools/Demos<8>-Footnote-62299751
Ref: Tools/Demos<8>-Footnote-72299794
Ref: Tools/Demos<8>-Footnote-82299837
Ref: Tools/Demos<8>-Footnote-92299880
Ref: Tools/Demos<8>-Footnote-102299923
Ref: Tools/Demos<8>-Footnote-112299967
Ref: Tools/Demos<8>-Footnote-122300011
Node: C API<9>2300055
Ref: whatsnew/changelog id1042300143
Ref: f812300143
Ref: C API<9>-Footnote-12303533
Ref: C API<9>-Footnote-22303576
Ref: C API<9>-Footnote-32303619
Ref: C API<9>-Footnote-42303662
Ref: C API<9>-Footnote-52303705
Ref: C API<9>-Footnote-62303748
Ref: C API<9>-Footnote-72303791
Ref: C API<9>-Footnote-82303834
Ref: C API<9>-Footnote-92303877
Ref: C API<9>-Footnote-102303920
Ref: C API<9>-Footnote-112303964
Ref: C API<9>-Footnote-122304008
Ref: C API<9>-Footnote-132304052
Ref: C API<9>-Footnote-142304096
Ref: C API<9>-Footnote-152304140
Ref: C API<9>-Footnote-162304184
Ref: C API<9>-Footnote-172304228
Ref: C API<9>-Footnote-182304272
Ref: C API<9>-Footnote-192304316
Ref: C API<9>-Footnote-202304360
Ref: C API<9>-Footnote-212304404
Ref: C API<9>-Footnote-222304448
Node: Python 3 7 0 final2304492
Ref: whatsnew/changelog python-3-7-0-final2304626
Ref: f8b2304626
Node: Library<13>2304763
Ref: whatsnew/changelog id1052304847
Ref: f8c2304847
Ref: Library<13>-Footnote-12305016
Node: C API<10>2305059
Ref: whatsnew/changelog id1062305143
Ref: f8e2305143
Ref: C API<10>-Footnote-12305354
Node: Python 3 7 0 release candidate 12305397
Ref: whatsnew/changelog python-3-7-0-release-candidate-12305530
Ref: f8f2305530
Node: Core and Builtins<13>2305817
Ref: whatsnew/changelog id1072305927
Ref: f902305927
Ref: Core and Builtins<13>-Footnote-12306571
Ref: Core and Builtins<13>-Footnote-22306614
Ref: Core and Builtins<13>-Footnote-32306657
Ref: Core and Builtins<13>-Footnote-42306700
Node: Library<14>2306743
Ref: whatsnew/changelog id1082306879
Ref: f912306879
Ref: Library<14>-Footnote-12308577
Ref: Library<14>-Footnote-22308620
Ref: Library<14>-Footnote-32308663
Ref: Library<14>-Footnote-42308706
Ref: Library<14>-Footnote-52308749
Ref: Library<14>-Footnote-62308792
Ref: Library<14>-Footnote-72308835
Ref: Library<14>-Footnote-82308878
Ref: Library<14>-Footnote-92308921
Ref: Library<14>-Footnote-102308964
Ref: Library<14>-Footnote-112309008
Ref: Library<14>-Footnote-122309052
Ref: Library<14>-Footnote-132309096
Node: Documentation<13>2309140
Ref: whatsnew/changelog id1092309264
Ref: f922309264
Ref: Documentation<13>-Footnote-12309771
Ref: Documentation<13>-Footnote-22309814
Ref: Documentation<13>-Footnote-32309863
Ref: Documentation<13>-Footnote-42309906
Node: Build<10>2309949
Ref: whatsnew/changelog id1102310073
Ref: f932310073
Ref: Build<10>-Footnote-12310335
Node: Windows<13>2310377
Ref: whatsnew/changelog id1112310492
Ref: f942310492
Ref: Windows<13>-Footnote-12310649
Node: IDLE<15>2310692
Ref: whatsnew/changelog id1122310789
Ref: f952310789
Ref: IDLE<15>-Footnote-12312009
Ref: IDLE<15>-Footnote-22312052
Ref: IDLE<15>-Footnote-32312095
Ref: IDLE<15>-Footnote-42312138
Ref: IDLE<15>-Footnote-52312181
Ref: IDLE<15>-Footnote-62312224
Node: Python 3 7 0 beta 52312267
Ref: whatsnew/changelog python-3-7-0-beta-52312401
Ref: f962312401
Node: Core and Builtins<14>2312677
Ref: whatsnew/changelog id1132312774
Ref: f972312774
Ref: Core and Builtins<14>-Footnote-12314293
Ref: Core and Builtins<14>-Footnote-22314336
Ref: Core and Builtins<14>-Footnote-32314379
Ref: Core and Builtins<14>-Footnote-42314422
Ref: Core and Builtins<14>-Footnote-52314465
Ref: Core and Builtins<14>-Footnote-62314508
Ref: Core and Builtins<14>-Footnote-72314551
Ref: Core and Builtins<14>-Footnote-82314594
Ref: Core and Builtins<14>-Footnote-92314637
Node: Library<15>2314680
Ref: whatsnew/changelog id1142314803
Ref: f982314803
Ref: Library<15>-Footnote-12320445
Ref: Library<15>-Footnote-22320488
Ref: Library<15>-Footnote-32320531
Ref: Library<15>-Footnote-42320574
Ref: Library<15>-Footnote-52320617
Ref: Library<15>-Footnote-62320660
Ref: Library<15>-Footnote-72320703
Ref: Library<15>-Footnote-82320746
Ref: Library<15>-Footnote-92320789
Ref: Library<15>-Footnote-102320832
Ref: Library<15>-Footnote-112320876
Ref: Library<15>-Footnote-122320920
Ref: Library<15>-Footnote-132320964
Ref: Library<15>-Footnote-142321008
Ref: Library<15>-Footnote-152321052
Ref: Library<15>-Footnote-162321096
Ref: Library<15>-Footnote-172321140
Ref: Library<15>-Footnote-182321184
Ref: Library<15>-Footnote-192321228
Ref: Library<15>-Footnote-202321272
Ref: Library<15>-Footnote-212321316
Ref: Library<15>-Footnote-222321360
Ref: Library<15>-Footnote-232321404
Ref: Library<15>-Footnote-242321448
Ref: Library<15>-Footnote-252321492
Ref: Library<15>-Footnote-262321536
Ref: Library<15>-Footnote-272321580
Ref: Library<15>-Footnote-282321624
Ref: Library<15>-Footnote-292321668
Ref: Library<15>-Footnote-302321712
Ref: Library<15>-Footnote-312321756
Ref: Library<15>-Footnote-322321800
Ref: Library<15>-Footnote-332321844
Ref: Library<15>-Footnote-342321888
Ref: Library<15>-Footnote-352321932
Ref: Library<15>-Footnote-362321976
Ref: Library<15>-Footnote-372322020
Ref: Library<15>-Footnote-382322064
Node: Documentation<14>2322108
Ref: whatsnew/changelog id1152322219
Ref: f992322219
Ref: Documentation<14>-Footnote-12322695
Ref: Documentation<14>-Footnote-22322738
Ref: Documentation<14>-Footnote-32322781
Ref: Documentation<14>-Footnote-42322830
Ref: Documentation<14>-Footnote-52322873
Ref: Documentation<14>-Footnote-62322916
Node: Tests<13>2322959
Ref: whatsnew/changelog id1162323068
Ref: f9a2323068
Ref: Tests<13>-Footnote-12323417
Ref: Tests<13>-Footnote-22323460
Node: Build<11>2323503
Ref: whatsnew/changelog id1172323603
Ref: f9b2323603
Ref: Build<11>-Footnote-12324082
Ref: Build<11>-Footnote-22324125
Ref: Build<11>-Footnote-32324168
Node: macOS<9>2324211
Ref: whatsnew/changelog id1182324310
Ref: f9c2324310
Ref: macOS<9>-Footnote-12324552
Node: IDLE<16>2324595
Ref: whatsnew/changelog id1192324676
Ref: f9d2324676
Ref: IDLE<16>-Footnote-12324955
Ref: IDLE<16>-Footnote-22324998
Ref: IDLE<16>-Footnote-32325041
Node: Python 3 7 0 beta 42325084
Ref: whatsnew/changelog python-3-7-0-beta-42325205
Ref: f9e2325205
Node: Core and Builtins<15>2325537
Ref: whatsnew/changelog id1202325634
Ref: f9f2325634
Ref: Core and Builtins<15>-Footnote-12326768
Ref: Core and Builtins<15>-Footnote-22326811
Ref: Core and Builtins<15>-Footnote-32326854
Ref: Core and Builtins<15>-Footnote-42326897
Ref: Core and Builtins<15>-Footnote-52326940
Ref: Core and Builtins<15>-Footnote-62326983
Ref: Core and Builtins<15>-Footnote-72327026
Node: Library<16>2327069
Ref: whatsnew/changelog id1212327192
Ref: fa02327192
Ref: Library<16>-Footnote-12330030
Ref: Library<16>-Footnote-22330073
Ref: Library<16>-Footnote-32330116
Ref: Library<16>-Footnote-42330159
Ref: Library<16>-Footnote-52330203
Ref: Library<16>-Footnote-62330246
Ref: Library<16>-Footnote-72330289
Ref: Library<16>-Footnote-82330332
Ref: Library<16>-Footnote-92330375
Ref: Library<16>-Footnote-102330418
Ref: Library<16>-Footnote-112330462
Ref: Library<16>-Footnote-122330506
Ref: Library<16>-Footnote-132330550
Ref: Library<16>-Footnote-142330594
Ref: Library<16>-Footnote-152330638
Ref: Library<16>-Footnote-162330682
Ref: Library<16>-Footnote-172330726
Ref: Library<16>-Footnote-182330776
Ref: Library<16>-Footnote-192330820
Ref: Library<16>-Footnote-202330864
Ref: Library<16>-Footnote-212330908
Ref: Library<16>-Footnote-222330952
Node: Documentation<15>2330996
Ref: whatsnew/changelog id1222331107
Ref: fa12331107
Ref: Documentation<15>-Footnote-12331858
Ref: Documentation<15>-Footnote-22331901
Ref: Documentation<15>-Footnote-32331944
Ref: Documentation<15>-Footnote-42331987
Ref: Documentation<15>-Footnote-52332030
Ref: Documentation<15>-Footnote-62332072
Node: Tests<14>2332115
Ref: whatsnew/changelog id1232332224
Ref: fa22332224
Ref: Tests<14>-Footnote-12332440
Node: Build<12>2332483
Ref: whatsnew/changelog id1242332586
Ref: fa32332586
Ref: Build<12>-Footnote-12333276
Ref: Build<12>-Footnote-22333319
Ref: Build<12>-Footnote-32333362
Ref: Build<12>-Footnote-42333405
Ref: Build<12>-Footnote-52333448
Node: Windows<14>2333491
Ref: whatsnew/changelog id1252333594
Ref: fa42333594
Ref: Windows<14>-Footnote-12333735
Node: macOS<10>2333778
Ref: whatsnew/changelog id1262333880
Ref: fa52333880
Ref: macOS<10>-Footnote-12334021
Node: IDLE<17>2334064
Ref: whatsnew/changelog id1272334169
Ref: fa62334169
Ref: IDLE<17>-Footnote-12334759
Ref: IDLE<17>-Footnote-22334802
Node: Tools/Demos<9>2334845
Ref: whatsnew/changelog id1282334932
Ref: fa72334932
Ref: Tools/Demos<9>-Footnote-12335540
Ref: Tools/Demos<9>-Footnote-22335583
Ref: Tools/Demos<9>-Footnote-32335626
Ref: Tools/Demos<9>-Footnote-42335669
Node: Python 3 7 0 beta 32335712
Ref: whatsnew/changelog python-3-7-0-beta-32335833
Ref: fa82335833
Node: Security<10>2336212
Ref: whatsnew/changelog id1292336310
Ref: fa92336310
Ref: Security<10>-Footnote-12336933
Ref: Security<10>-Footnote-22336976
Ref: Security<10>-Footnote-32337019
Node: Core and Builtins<16>2337062
Ref: whatsnew/changelog id1302337180
Ref: faa2337180
Ref: Core and Builtins<16>-Footnote-12338390
Ref: Core and Builtins<16>-Footnote-22338433
Ref: Core and Builtins<16>-Footnote-32338476
Ref: Core and Builtins<16>-Footnote-42338519
Ref: Core and Builtins<16>-Footnote-52338562
Ref: Core and Builtins<16>-Footnote-62338605
Ref: Core and Builtins<16>-Footnote-72338648
Node: Library<17>2338691
Ref: whatsnew/changelog id1312338814
Ref: fab2338814
Ref: Library<17>-Footnote-12342877
Ref: Library<17>-Footnote-22342920
Ref: Library<17>-Footnote-32342963
Ref: Library<17>-Footnote-42343006
Ref: Library<17>-Footnote-52343049
Ref: Library<17>-Footnote-62343092
Ref: Library<17>-Footnote-72343135
Ref: Library<17>-Footnote-82343178
Ref: Library<17>-Footnote-92343221
Ref: Library<17>-Footnote-102343264
Ref: Library<17>-Footnote-112343308
Ref: Library<17>-Footnote-122343352
Ref: Library<17>-Footnote-132343396
Ref: Library<17>-Footnote-142343440
Ref: Library<17>-Footnote-152343484
Ref: Library<17>-Footnote-162343528
Ref: Library<17>-Footnote-172343572
Ref: Library<17>-Footnote-182343616
Ref: Library<17>-Footnote-192343660
Ref: Library<17>-Footnote-202343704
Ref: Library<17>-Footnote-212343748
Ref: Library<17>-Footnote-222343792
Ref: Library<17>-Footnote-232343836
Ref: Library<17>-Footnote-242343880
Ref: Library<17>-Footnote-252343924
Ref: Library<17>-Footnote-262343968
Ref: Library<17>-Footnote-272344012
Node: Documentation<16>2344056
Ref: whatsnew/changelog id1322344167
Ref: fac2344167
Ref: Documentation<16>-Footnote-12344804
Ref: Documentation<16>-Footnote-22344847
Ref: Documentation<16>-Footnote-32344890
Ref: Documentation<16>-Footnote-42344933
Ref: Documentation<16>-Footnote-52344976
Node: Tests<15>2345019
Ref: whatsnew/changelog id1332345128
Ref: fad2345128
Ref: Tests<15>-Footnote-12345461
Ref: Tests<15>-Footnote-22345504
Ref: Tests<15>-Footnote-32345547
Node: Build<13>2345590
Ref: whatsnew/changelog id1342345693
Ref: fae2345693
Ref: Build<13>-Footnote-12345830
Node: Windows<15>2345873
Ref: whatsnew/changelog id1352345976
Ref: faf2345976
Ref: Windows<15>-Footnote-12346255
Ref: Windows<15>-Footnote-22346298
Node: macOS<11>2346341
Ref: whatsnew/changelog id1362346443
Ref: fb02346443
Ref: macOS<11>-Footnote-12346875
Node: IDLE<18>2346918
Ref: whatsnew/changelog id1372347024
Ref: fb12347024
Ref: IDLE<18>-Footnote-12347738
Ref: IDLE<18>-Footnote-22347781
Node: Tools/Demos<10>2347824
Ref: whatsnew/changelog id1382347930
Ref: fb22347930
Ref: Tools/Demos<10>-Footnote-12348160
Node: C API<11>2348203
Ref: whatsnew/changelog id1392348292
Ref: fb32348292
Ref: C API<11>-Footnote-12348676
Ref: C API<11>-Footnote-22348719
Node: Python 3 7 0 beta 22348762
Ref: whatsnew/changelog python-3-7-0-beta-22348883
Ref: fb42348883
Node: Security<11>2349242
Ref: whatsnew/changelog id1402349340
Ref: fb52349340
Ref: Security<11>-Footnote-12349525
Node: Core and Builtins<17>2349568
Ref: whatsnew/changelog id1412349686
Ref: fb62349686
Ref: Core and Builtins<17>-Footnote-12350517
Ref: Core and Builtins<17>-Footnote-22350560
Ref: Core and Builtins<17>-Footnote-32350603
Ref: Core and Builtins<17>-Footnote-42350646
Ref: Core and Builtins<17>-Footnote-52350689
Ref: Core and Builtins<17>-Footnote-62350732
Ref: Core and Builtins<17>-Footnote-72350775
Node: Library<18>2350818
Ref: whatsnew/changelog id1422350941
Ref: fb72350941
Ref: Library<18>-Footnote-12357339
Ref: Library<18>-Footnote-22357382
Ref: Library<18>-Footnote-32357425
Ref: Library<18>-Footnote-42357468
Ref: Library<18>-Footnote-52357511
Ref: Library<18>-Footnote-62357554
Ref: Library<18>-Footnote-72357597
Ref: Library<18>-Footnote-82357640
Ref: Library<18>-Footnote-92357683
Ref: Library<18>-Footnote-102357726
Ref: Library<18>-Footnote-112357770
Ref: Library<18>-Footnote-122357814
Ref: Library<18>-Footnote-132357858
Ref: Library<18>-Footnote-142357902
Ref: Library<18>-Footnote-152357946
Ref: Library<18>-Footnote-162357990
Ref: Library<18>-Footnote-172358034
Ref: Library<18>-Footnote-182358078
Ref: Library<18>-Footnote-192358122
Ref: Library<18>-Footnote-202358166
Ref: Library<18>-Footnote-212358210
Ref: Library<18>-Footnote-222358254
Ref: Library<18>-Footnote-232358298
Ref: Library<18>-Footnote-242358342
Ref: Library<18>-Footnote-252358386
Ref: Library<18>-Footnote-262358430
Ref: Library<18>-Footnote-272358474
Ref: Library<18>-Footnote-282358518
Ref: Library<18>-Footnote-292358562
Ref: Library<18>-Footnote-302358606
Ref: Library<18>-Footnote-312358650
Ref: Library<18>-Footnote-322358694
Ref: Library<18>-Footnote-332358738
Ref: Library<18>-Footnote-342358782
Node: Documentation<17>2358826
Ref: whatsnew/changelog id1432358937
Ref: fb82358937
Ref: Documentation<17>-Footnote-12359906
Ref: Documentation<17>-Footnote-22359949
Ref: Documentation<17>-Footnote-32359992
Ref: Documentation<17>-Footnote-42360035
Ref: Documentation<17>-Footnote-52360078
Ref: Documentation<17>-Footnote-62360121
Ref: Documentation<17>-Footnote-72360163
Ref: Documentation<17>-Footnote-82360206
Node: Tests<16>2360249
Ref: whatsnew/changelog id1442360358
Ref: fb92360358
Ref: Tests<16>-Footnote-12360501
Node: Build<14>2360544
Ref: whatsnew/changelog id1452360647
Ref: fba2360647
Ref: Build<14>-Footnote-12360788
Node: Windows<16>2360831
Ref: whatsnew/changelog id1462360934
Ref: fbb2360934
Ref: Windows<16>-Footnote-12361670
Ref: Windows<16>-Footnote-22361713
Ref: Windows<16>-Footnote-32361756
Ref: Windows<16>-Footnote-42361799
Ref: Windows<16>-Footnote-52361842
Ref: Windows<16>-Footnote-62361885
Node: macOS<12>2361928
Ref: whatsnew/changelog id1472362030
Ref: fbc2362030
Ref: macOS<12>-Footnote-12362165
Node: IDLE<19>2362208
Ref: whatsnew/changelog id1482362314
Ref: fbd2362314
Ref: IDLE<19>-Footnote-12363161
Ref: IDLE<19>-Footnote-22363204
Ref: IDLE<19>-Footnote-32363247
Ref: IDLE<19>-Footnote-42363290
Ref: IDLE<19>-Footnote-52363333
Ref: IDLE<19>-Footnote-62363376
Node: Tools/Demos<11>2363419
Ref: whatsnew/changelog id1492363507
Ref: fbe2363507
Ref: Tools/Demos<11>-Footnote-12363726
Node: Python 3 7 0 beta 12363769
Ref: whatsnew/changelog python-3-7-0-beta-12363891
Ref: fbf2363891
Node: Core and Builtins<18>2364194
Ref: whatsnew/changelog id1502364291
Ref: fc02364291
Ref: Core and Builtins<18>-Footnote-12367725
Ref: Core and Builtins<18>-Footnote-22367768
Ref: Core and Builtins<18>-Footnote-32367811
Ref: Core and Builtins<18>-Footnote-42367854
Ref: Core and Builtins<18>-Footnote-52367897
Ref: Core and Builtins<18>-Footnote-62367940
Ref: Core and Builtins<18>-Footnote-72367983
Ref: Core and Builtins<18>-Footnote-82368026
Ref: Core and Builtins<18>-Footnote-92368069
Ref: Core and Builtins<18>-Footnote-102368118
Ref: Core and Builtins<18>-Footnote-112368162
Ref: Core and Builtins<18>-Footnote-122368206
Ref: Core and Builtins<18>-Footnote-132368250
Ref: Core and Builtins<18>-Footnote-142368294
Ref: Core and Builtins<18>-Footnote-152368338
Ref: Core and Builtins<18>-Footnote-162368382
Ref: Core and Builtins<18>-Footnote-172368426
Ref: Core and Builtins<18>-Footnote-182368470
Ref: Core and Builtins<18>-Footnote-192368520
Ref: Core and Builtins<18>-Footnote-202368564
Ref: Core and Builtins<18>-Footnote-212368608
Ref: Core and Builtins<18>-Footnote-222368652
Ref: Core and Builtins<18>-Footnote-232368696
Node: Library<19>2368740
Ref: whatsnew/changelog id1512368863
Ref: fc12368863
Ref: Library<19>-Footnote-12376245
Ref: Library<19>-Footnote-22376288
Ref: Library<19>-Footnote-32376331
Ref: Library<19>-Footnote-42376374
Ref: Library<19>-Footnote-52376417
Ref: Library<19>-Footnote-62376460
Ref: Library<19>-Footnote-72376503
Ref: Library<19>-Footnote-82376546
Ref: Library<19>-Footnote-92376589
Ref: Library<19>-Footnote-102376632
Ref: Library<19>-Footnote-112376676
Ref: Library<19>-Footnote-122376720
Ref: Library<19>-Footnote-132376764
Ref: Library<19>-Footnote-142376808
Ref: Library<19>-Footnote-152376852
Ref: Library<19>-Footnote-162376896
Ref: Library<19>-Footnote-172376940
Ref: Library<19>-Footnote-182376984
Ref: Library<19>-Footnote-192377034
Ref: Library<19>-Footnote-202377078
Ref: Library<19>-Footnote-212377122
Ref: Library<19>-Footnote-222377166
Ref: Library<19>-Footnote-232377210
Ref: Library<19>-Footnote-242377254
Ref: Library<19>-Footnote-252377298
Ref: Library<19>-Footnote-262377342
Ref: Library<19>-Footnote-272377386
Ref: Library<19>-Footnote-282377430
Ref: Library<19>-Footnote-292377474
Ref: Library<19>-Footnote-302377518
Ref: Library<19>-Footnote-312377562
Ref: Library<19>-Footnote-322377606
Ref: Library<19>-Footnote-332377650
Ref: Library<19>-Footnote-342377694
Ref: Library<19>-Footnote-352377738
Ref: Library<19>-Footnote-362377782
Ref: Library<19>-Footnote-372377826
Ref: Library<19>-Footnote-382377870
Ref: Library<19>-Footnote-392377914
Ref: Library<19>-Footnote-402377958
Ref: Library<19>-Footnote-412378002
Ref: Library<19>-Footnote-422378046
Ref: Library<19>-Footnote-432378090
Ref: Library<19>-Footnote-442378134
Ref: Library<19>-Footnote-452378178
Ref: Library<19>-Footnote-462378222
Ref: Library<19>-Footnote-472378266
Node: Documentation<18>2378310
Ref: whatsnew/changelog id1522378421
Ref: fc42378421
Ref: Documentation<18>-Footnote-12378962
Ref: Documentation<18>-Footnote-22379005
Ref: Documentation<18>-Footnote-32379048
Node: Tests<17>2379091
Ref: whatsnew/changelog id1532379200
Ref: fc52379200
Ref: Tests<17>-Footnote-12380112
Ref: Tests<17>-Footnote-22380155
Ref: Tests<17>-Footnote-32380198
Ref: Tests<17>-Footnote-42380241
Ref: Tests<17>-Footnote-52380284
Ref: Tests<17>-Footnote-62380327
Node: Build<15>2380370
Ref: whatsnew/changelog id1542380473
Ref: fc62380473
Ref: Build<15>-Footnote-12381076
Ref: Build<15>-Footnote-22381119
Ref: Build<15>-Footnote-32381162
Ref: Build<15>-Footnote-42381205
Node: Windows<17>2381248
Ref: whatsnew/changelog id1552381351
Ref: fc72381351
Ref: Windows<17>-Footnote-12381732
Ref: Windows<17>-Footnote-22381775
Ref: Windows<17>-Footnote-32381818
Node: macOS<13>2381861
Ref: whatsnew/changelog id1562381964
Ref: fc82381964
Ref: macOS<13>-Footnote-12382486
Ref: macOS<13>-Footnote-22382529
Node: C API<12>2382572
Ref: whatsnew/changelog id1572382655
Ref: fc92382655
Ref: C API<12>-Footnote-12382976
Ref: C API<12>-Footnote-22383019
Node: Python 3 7 0 alpha 42383062
Ref: whatsnew/changelog python-3-7-0-alpha-42383185
Ref: fca2383185
Node: Core and Builtins<19>2383482
Ref: whatsnew/changelog id1582383580
Ref: fcb2383580
Ref: Core and Builtins<19>-Footnote-12387089
Ref: Core and Builtins<19>-Footnote-22387132
Ref: Core and Builtins<19>-Footnote-32387175
Ref: Core and Builtins<19>-Footnote-42387218
Ref: Core and Builtins<19>-Footnote-52387261
Ref: Core and Builtins<19>-Footnote-62387304
Ref: Core and Builtins<19>-Footnote-72387347
Ref: Core and Builtins<19>-Footnote-82387390
Ref: Core and Builtins<19>-Footnote-92387433
Ref: Core and Builtins<19>-Footnote-102387476
Ref: Core and Builtins<19>-Footnote-112387520
Ref: Core and Builtins<19>-Footnote-122387564
Ref: Core and Builtins<19>-Footnote-132387608
Ref: Core and Builtins<19>-Footnote-142387652
Ref: Core and Builtins<19>-Footnote-152387696
Ref: Core and Builtins<19>-Footnote-162387740
Ref: Core and Builtins<19>-Footnote-172387784
Ref: Core and Builtins<19>-Footnote-182387828
Ref: Core and Builtins<19>-Footnote-192387872
Ref: Core and Builtins<19>-Footnote-202387922
Ref: Core and Builtins<19>-Footnote-212387966
Ref: Core and Builtins<19>-Footnote-222388016
Ref: Core and Builtins<19>-Footnote-232388060
Ref: Core and Builtins<19>-Footnote-242388110
Ref: Core and Builtins<19>-Footnote-252388154
Ref: Core and Builtins<19>-Footnote-262388198
Ref: Core and Builtins<19>-Footnote-272388248
Node: Library<20>2388292
Ref: whatsnew/changelog id1592388416
Ref: fcd2388416
Ref: Library<20>-Footnote-12396426
Ref: Library<20>-Footnote-22396469
Ref: Library<20>-Footnote-32396512
Ref: Library<20>-Footnote-42396555
Ref: Library<20>-Footnote-52396598
Ref: Library<20>-Footnote-62396641
Ref: Library<20>-Footnote-72396684
Ref: Library<20>-Footnote-82396727
Ref: Library<20>-Footnote-92396770
Ref: Library<20>-Footnote-102396813
Ref: Library<20>-Footnote-112396857
Ref: Library<20>-Footnote-122396901
Ref: Library<20>-Footnote-132396945
Ref: Library<20>-Footnote-142396989
Ref: Library<20>-Footnote-152397033
Ref: Library<20>-Footnote-162397077
Ref: Library<20>-Footnote-172397121
Ref: Library<20>-Footnote-182397165
Ref: Library<20>-Footnote-192397209
Ref: Library<20>-Footnote-202397253
Ref: Library<20>-Footnote-212397297
Ref: Library<20>-Footnote-222397341
Ref: Library<20>-Footnote-232397385
Ref: Library<20>-Footnote-242397429
Ref: Library<20>-Footnote-252397473
Ref: Library<20>-Footnote-262397517
Ref: Library<20>-Footnote-272397561
Ref: Library<20>-Footnote-282397605
Ref: Library<20>-Footnote-292397649
Ref: Library<20>-Footnote-302397693
Ref: Library<20>-Footnote-312397737
Ref: Library<20>-Footnote-322397781
Ref: Library<20>-Footnote-332397825
Ref: Library<20>-Footnote-342397869
Ref: Library<20>-Footnote-352397913
Ref: Library<20>-Footnote-362397957
Ref: Library<20>-Footnote-372398001
Ref: Library<20>-Footnote-382398045
Ref: Library<20>-Footnote-392398089
Ref: Library<20>-Footnote-402398133
Ref: Library<20>-Footnote-412398177
Ref: Library<20>-Footnote-422398221
Ref: Library<20>-Footnote-432398265
Ref: Library<20>-Footnote-442398309
Ref: Library<20>-Footnote-452398353
Ref: Library<20>-Footnote-462398397
Ref: Library<20>-Footnote-472398441
Ref: Library<20>-Footnote-482398485
Ref: Library<20>-Footnote-492398529
Ref: Library<20>-Footnote-502398573
Ref: Library<20>-Footnote-512398617
Ref: Library<20>-Footnote-522398661
Ref: Library<20>-Footnote-532398705
Ref: Library<20>-Footnote-542398749
Node: Documentation<19>2398793
Ref: whatsnew/changelog id1602398905
Ref: fd02398905
Ref: Documentation<19>-Footnote-12399075
Node: Tests<18>2399118
Ref: whatsnew/changelog id1612399230
Ref: fd12399230
Ref: Tests<18>-Footnote-12399625
Ref: Tests<18>-Footnote-22399668
Node: Windows<18>2399711
Ref: whatsnew/changelog id1622399821
Ref: fd22399821
Ref: Windows<18>-Footnote-12400020
Node: Tools/Demos<12>2400063
Ref: whatsnew/changelog id1632400173
Ref: fd32400173
Ref: Tools/Demos<12>-Footnote-12400455
Node: C API<13>2400498
Ref: whatsnew/changelog id1642400588
Ref: fd42400588
Ref: C API<13>-Footnote-12401249
Ref: C API<13>-Footnote-22401292
Ref: C API<13>-Footnote-32401335
Ref: C API<13>-Footnote-42401378
Node: Python 3 7 0 alpha 32401421
Ref: whatsnew/changelog python-3-7-0-alpha-32401545
Ref: fd52401545
Node: Core and Builtins<20>2401900
Ref: whatsnew/changelog id1652401998
Ref: fd62401998
Ref: Core and Builtins<20>-Footnote-12407127
Ref: Core and Builtins<20>-Footnote-22407170
Ref: Core and Builtins<20>-Footnote-32407213
Ref: Core and Builtins<20>-Footnote-42407256
Ref: Core and Builtins<20>-Footnote-52407299
Ref: Core and Builtins<20>-Footnote-62407342
Ref: Core and Builtins<20>-Footnote-72407385
Ref: Core and Builtins<20>-Footnote-82407428
Ref: Core and Builtins<20>-Footnote-92407471
Ref: Core and Builtins<20>-Footnote-102407514
Ref: Core and Builtins<20>-Footnote-112407558
Ref: Core and Builtins<20>-Footnote-122407602
Ref: Core and Builtins<20>-Footnote-132407646
Ref: Core and Builtins<20>-Footnote-142407690
Ref: Core and Builtins<20>-Footnote-152407734
Ref: Core and Builtins<20>-Footnote-162407778
Ref: Core and Builtins<20>-Footnote-172407822
Ref: Core and Builtins<20>-Footnote-182407866
Ref: Core and Builtins<20>-Footnote-192407910
Ref: Core and Builtins<20>-Footnote-202407954
Ref: Core and Builtins<20>-Footnote-212407998
Ref: Core and Builtins<20>-Footnote-222408042
Node: Library<21>2408086
Ref: whatsnew/changelog id1662408210
Ref: fd72408210
Ref: Library<21>-Footnote-12424284
Ref: Library<21>-Footnote-22424327
Ref: Library<21>-Footnote-32424370
Ref: Library<21>-Footnote-42424413
Ref: Library<21>-Footnote-52424456
Ref: Library<21>-Footnote-62424499
Ref: Library<21>-Footnote-72424542
Ref: Library<21>-Footnote-82424585
Ref: Library<21>-Footnote-92424629
Ref: Library<21>-Footnote-102424672
Ref: Library<21>-Footnote-112424716
Ref: Library<21>-Footnote-122424760
Ref: Library<21>-Footnote-132424804
Ref: Library<21>-Footnote-142424848
Ref: Library<21>-Footnote-152424892
Ref: Library<21>-Footnote-162424936
Ref: Library<21>-Footnote-172424980
Ref: Library<21>-Footnote-182425024
Ref: Library<21>-Footnote-192425068
Ref: Library<21>-Footnote-202425112
Ref: Library<21>-Footnote-212425156
Ref: Library<21>-Footnote-222425200
Ref: Library<21>-Footnote-232425244
Ref: Library<21>-Footnote-242425288
Ref: Library<21>-Footnote-252425332
Ref: Library<21>-Footnote-262425378
Ref: Library<21>-Footnote-272425422
Ref: Library<21>-Footnote-282425466
Ref: Library<21>-Footnote-292425510
Ref: Library<21>-Footnote-302425554
Ref: Library<21>-Footnote-312425598
Ref: Library<21>-Footnote-322425642
Ref: Library<21>-Footnote-332425692
Ref: Library<21>-Footnote-342425736
Ref: Library<21>-Footnote-352425780
Ref: Library<21>-Footnote-362425824
Ref: Library<21>-Footnote-372425868
Ref: Library<21>-Footnote-382425912
Ref: Library<21>-Footnote-392425956
Ref: Library<21>-Footnote-402426000
Ref: Library<21>-Footnote-412426044
Ref: Library<21>-Footnote-422426088
Ref: Library<21>-Footnote-432426132
Ref: Library<21>-Footnote-442426176
Ref: Library<21>-Footnote-452426220
Ref: Library<21>-Footnote-462426264
Ref: Library<21>-Footnote-472426307
Ref: Library<21>-Footnote-482426351
Ref: Library<21>-Footnote-492426395
Ref: Library<21>-Footnote-502426439
Ref: Library<21>-Footnote-512426483
Ref: Library<21>-Footnote-522426527
Ref: Library<21>-Footnote-532426571
Ref: Library<21>-Footnote-542426615
Ref: Library<21>-Footnote-552426659
Ref: Library<21>-Footnote-562426703
Ref: Library<21>-Footnote-572426747
Ref: Library<21>-Footnote-582426791
Ref: Library<21>-Footnote-592426835
Ref: Library<21>-Footnote-602426879
Ref: Library<21>-Footnote-612426923
Ref: Library<21>-Footnote-622426967
Ref: Library<21>-Footnote-632427017
Ref: Library<21>-Footnote-642427061
Ref: Library<21>-Footnote-652427105
Ref: Library<21>-Footnote-662427149
Ref: Library<21>-Footnote-672427193
Ref: Library<21>-Footnote-682427237
Ref: Library<21>-Footnote-692427281
Ref: Library<21>-Footnote-702427325
Ref: Library<21>-Footnote-712427369
Ref: Library<21>-Footnote-722427413
Ref: Library<21>-Footnote-732427457
Ref: Library<21>-Footnote-742427501
Ref: Library<21>-Footnote-752427545
Ref: Library<21>-Footnote-762427589
Ref: Library<21>-Footnote-772427633
Ref: Library<21>-Footnote-782427677
Ref: Library<21>-Footnote-792427721
Ref: Library<21>-Footnote-802427765
Ref: Library<21>-Footnote-812427809
Ref: Library<21>-Footnote-822427853
Ref: Library<21>-Footnote-832427903
Ref: Library<21>-Footnote-842427947
Ref: Library<21>-Footnote-852427991
Ref: Library<21>-Footnote-862428035
Ref: Library<21>-Footnote-872428079
Ref: Library<21>-Footnote-882428123
Ref: Library<21>-Footnote-892428167
Ref: Library<21>-Footnote-902428211
Ref: Library<21>-Footnote-912428255
Ref: Library<21>-Footnote-922428299
Ref: Library<21>-Footnote-932428343
Ref: Library<21>-Footnote-942428387
Ref: Library<21>-Footnote-952428431
Ref: Library<21>-Footnote-962428475
Ref: Library<21>-Footnote-972428519
Ref: Library<21>-Footnote-982428563
Node: Documentation<20>2428607
Ref: whatsnew/changelog id1672428719
Ref: fde2428719
Ref: Documentation<20>-Footnote-12428902
Node: Tests<19>2428945
Ref: whatsnew/changelog id1682429055
Ref: fdf2429055
Ref: Tests<19>-Footnote-12430265
Ref: Tests<19>-Footnote-22430308
Ref: Tests<19>-Footnote-32430351
Ref: Tests<19>-Footnote-42430394
Ref: Tests<19>-Footnote-52430437
Ref: Tests<19>-Footnote-62430480
Ref: Tests<19>-Footnote-72430523
Node: Build<16>2430566
Ref: whatsnew/changelog id1692430670
Ref: fe02430670
Ref: Build<16>-Footnote-12431884
Ref: Build<16>-Footnote-22431927
Ref: Build<16>-Footnote-32431970
Ref: Build<16>-Footnote-42432013
Ref: Build<16>-Footnote-52432056
Ref: Build<16>-Footnote-62432099
Ref: Build<16>-Footnote-72432142
Ref: Build<16>-Footnote-82432185
Ref: Build<16>-Footnote-92432228
Ref: Build<16>-Footnote-102432271
Ref: Build<16>-Footnote-112432315
Ref: Build<16>-Footnote-122432359
Node: Windows<19>2432403
Ref: whatsnew/changelog id1702432507
Ref: fe12432507
Ref: Windows<19>-Footnote-12433040
Ref: Windows<19>-Footnote-22433082
Ref: Windows<19>-Footnote-32433125
Ref: Windows<19>-Footnote-42433168
Node: macOS<14>2433211
Ref: whatsnew/changelog id1712433314
Ref: fe22433314
Ref: macOS<14>-Footnote-12433448
Node: IDLE<20>2433491
Ref: whatsnew/changelog id1722433598
Ref: fe32433598
Ref: IDLE<20>-Footnote-12435691
Ref: IDLE<20>-Footnote-22435734
Ref: IDLE<20>-Footnote-32435777
Ref: IDLE<20>-Footnote-42435820
Ref: IDLE<20>-Footnote-52435863
Ref: IDLE<20>-Footnote-62435906
Ref: IDLE<20>-Footnote-72435949
Ref: IDLE<20>-Footnote-82435992
Node: Tools/Demos<13>2436035
Ref: whatsnew/changelog id1732436142
Ref: fe42436142
Ref: Tools/Demos<13>-Footnote-12436674
Ref: Tools/Demos<13>-Footnote-22436717
Node: C API<14>2436760
Ref: whatsnew/changelog id1742436850
Ref: fe52436850
Ref: C API<14>-Footnote-12437978
Ref: C API<14>-Footnote-22438021
Ref: C API<14>-Footnote-32438064
Ref: C API<14>-Footnote-42438107
Ref: C API<14>-Footnote-52438150
Ref: C API<14>-Footnote-62438193
Node: Python 3 7 0 alpha 22438236
Ref: whatsnew/changelog python-3-7-0-alpha-22438360
Ref: fe62438360
Node: Core and Builtins<21>2438619
Ref: whatsnew/changelog id1752438717
Ref: fe72438717
Ref: Core and Builtins<21>-Footnote-12442917
Ref: Core and Builtins<21>-Footnote-22442960
Ref: Core and Builtins<21>-Footnote-32443003
Ref: Core and Builtins<21>-Footnote-42443046
Ref: Core and Builtins<21>-Footnote-52443089
Ref: Core and Builtins<21>-Footnote-62443132
Ref: Core and Builtins<21>-Footnote-72443175
Ref: Core and Builtins<21>-Footnote-82443218
Ref: Core and Builtins<21>-Footnote-92443261
Ref: Core and Builtins<21>-Footnote-102443304
Ref: Core and Builtins<21>-Footnote-112443348
Ref: Core and Builtins<21>-Footnote-122443392
Ref: Core and Builtins<21>-Footnote-132443436
Ref: Core and Builtins<21>-Footnote-142443480
Ref: Core and Builtins<21>-Footnote-152443524
Ref: Core and Builtins<21>-Footnote-162443568
Ref: Core and Builtins<21>-Footnote-172443612
Ref: Core and Builtins<21>-Footnote-182443656
Ref: Core and Builtins<21>-Footnote-192443700
Ref: Core and Builtins<21>-Footnote-202443744
Ref: Core and Builtins<21>-Footnote-212443794
Ref: Core and Builtins<21>-Footnote-222443838
Ref: Core and Builtins<21>-Footnote-232443882
Ref: Core and Builtins<21>-Footnote-242443926
Ref: Core and Builtins<21>-Footnote-252443970
Ref: Core and Builtins<21>-Footnote-262444014
Ref: Core and Builtins<21>-Footnote-272444058
Node: Library<22>2444108
Ref: whatsnew/changelog id1762444232
Ref: fea2444232
Ref: Library<22>-Footnote-12448324
Ref: Library<22>-Footnote-22448367
Ref: Library<22>-Footnote-32448410
Ref: Library<22>-Footnote-42448453
Ref: Library<22>-Footnote-52448496
Ref: Library<22>-Footnote-62448539
Ref: Library<22>-Footnote-72448582
Ref: Library<22>-Footnote-82448625
Ref: Library<22>-Footnote-92448668
Ref: Library<22>-Footnote-102448711
Ref: Library<22>-Footnote-112448755
Ref: Library<22>-Footnote-122448799
Ref: Library<22>-Footnote-132448843
Ref: Library<22>-Footnote-142448887
Ref: Library<22>-Footnote-152448931
Ref: Library<22>-Footnote-162448975
Ref: Library<22>-Footnote-172449019
Ref: Library<22>-Footnote-182449063
Ref: Library<22>-Footnote-192449107
Ref: Library<22>-Footnote-202449151
Ref: Library<22>-Footnote-212449195
Ref: Library<22>-Footnote-222449239
Ref: Library<22>-Footnote-232449283
Ref: Library<22>-Footnote-242449327
Ref: Library<22>-Footnote-252449371
Ref: Library<22>-Footnote-262449415
Node: Documentation<21>2449459
Ref: whatsnew/changelog id1772449571
Ref: fec2449571
Ref: Documentation<21>-Footnote-12449962
Ref: Documentation<21>-Footnote-22450005
Node: Build<17>2450048
Ref: whatsnew/changelog id1782450157
Ref: fed2450157
Ref: Build<17>-Footnote-12450784
Ref: Build<17>-Footnote-22450827
Ref: Build<17>-Footnote-32450870
Ref: Build<17>-Footnote-42450913
Ref: Build<17>-Footnote-52450956
Ref: Build<17>-Footnote-62450999
Node: IDLE<21>2451042
Ref: whatsnew/changelog id1792451143
Ref: fee2451143
Ref: IDLE<21>-Footnote-12452449
Ref: IDLE<21>-Footnote-22452492
Ref: IDLE<21>-Footnote-32452535
Ref: IDLE<21>-Footnote-42452578
Ref: IDLE<21>-Footnote-52452621
Ref: IDLE<21>-Footnote-62452664
Node: C API<15>2452709
Ref: whatsnew/changelog id1802452792
Ref: fef2452792
Ref: C API<15>-Footnote-12453534
Ref: C API<15>-Footnote-22453577
Ref: C API<15>-Footnote-32453620
Ref: C API<15>-Footnote-42453663
Node: Python 3 7 0 alpha 12453712
Ref: whatsnew/changelog python-3-7-0-alpha-12453834
Ref: ff02453834
Node: Security<12>2454195
Ref: whatsnew/changelog id1812454294
Ref: ff12454294
Ref: Security<12>-Footnote-12455918
Ref: Security<12>-Footnote-22455961
Ref: Security<12>-Footnote-32456004
Ref: Security<12>-Footnote-42456047
Ref: Security<12>-Footnote-52456090
Ref: Security<12>-Footnote-62456133
Ref: Security<12>-Footnote-72456176
Node: Core and Builtins<22>2456219
Ref: whatsnew/changelog id1822456338
Ref: ff22456338
Ref: Core and Builtins<22>-Footnote-12477262
Ref: Core and Builtins<22>-Footnote-22477305
Ref: Core and Builtins<22>-Footnote-32477348
Ref: Core and Builtins<22>-Footnote-42477391
Ref: Core and Builtins<22>-Footnote-52477434
Ref: Core and Builtins<22>-Footnote-62477477
Ref: Core and Builtins<22>-Footnote-72477520
Ref: Core and Builtins<22>-Footnote-82477563
Ref: Core and Builtins<22>-Footnote-92477606
Ref: Core and Builtins<22>-Footnote-102477649
Ref: Core and Builtins<22>-Footnote-112477693
Ref: Core and Builtins<22>-Footnote-122477737
Ref: Core and Builtins<22>-Footnote-132477781
Ref: Core and Builtins<22>-Footnote-142477825
Ref: Core and Builtins<22>-Footnote-152477869
Ref: Core and Builtins<22>-Footnote-162477913
Ref: Core and Builtins<22>-Footnote-172477957
Ref: Core and Builtins<22>-Footnote-182478001
Ref: Core and Builtins<22>-Footnote-192478045
Ref: Core and Builtins<22>-Footnote-202478089
Ref: Core and Builtins<22>-Footnote-212478133
Ref: Core and Builtins<22>-Footnote-222478177
Ref: Core and Builtins<22>-Footnote-232478221
Ref: Core and Builtins<22>-Footnote-242478265
Ref: Core and Builtins<22>-Footnote-252478309
Ref: Core and Builtins<22>-Footnote-262478353
Ref: Core and Builtins<22>-Footnote-272478397
Ref: Core and Builtins<22>-Footnote-282478441
Ref: Core and Builtins<22>-Footnote-292478485
Ref: Core and Builtins<22>-Footnote-302478529
Ref: Core and Builtins<22>-Footnote-312478573
Ref: Core and Builtins<22>-Footnote-322478617
Ref: Core and Builtins<22>-Footnote-332478661
Ref: Core and Builtins<22>-Footnote-342478705
Ref: Core and Builtins<22>-Footnote-352478749
Ref: Core and Builtins<22>-Footnote-362478799
Ref: Core and Builtins<22>-Footnote-372478843
Ref: Core and Builtins<22>-Footnote-382478887
Ref: Core and Builtins<22>-Footnote-392478931
Ref: Core and Builtins<22>-Footnote-402478975
Ref: Core and Builtins<22>-Footnote-412479019
Ref: Core and Builtins<22>-Footnote-422479063
Ref: Core and Builtins<22>-Footnote-432479107
Ref: Core and Builtins<22>-Footnote-442479151
Ref: Core and Builtins<22>-Footnote-452479195
Ref: Core and Builtins<22>-Footnote-462479239
Ref: Core and Builtins<22>-Footnote-472479283
Ref: Core and Builtins<22>-Footnote-482479327
Ref: Core and Builtins<22>-Footnote-492479371
Ref: Core and Builtins<22>-Footnote-502479415
Ref: Core and Builtins<22>-Footnote-512479459
Ref: Core and Builtins<22>-Footnote-522479503
Ref: Core and Builtins<22>-Footnote-532479547
Ref: Core and Builtins<22>-Footnote-542479591
Ref: Core and Builtins<22>-Footnote-552479635
Ref: Core and Builtins<22>-Footnote-562479679
Ref: Core and Builtins<22>-Footnote-572479723
Ref: Core and Builtins<22>-Footnote-582479767
Ref: Core and Builtins<22>-Footnote-592479811
Ref: Core and Builtins<22>-Footnote-602479855
Ref: Core and Builtins<22>-Footnote-612479899
Ref: Core and Builtins<22>-Footnote-622479943
Ref: Core and Builtins<22>-Footnote-632479987
Ref: Core and Builtins<22>-Footnote-642480031
Ref: Core and Builtins<22>-Footnote-652480075
Ref: Core and Builtins<22>-Footnote-662480119
Ref: Core and Builtins<22>-Footnote-672480163
Ref: Core and Builtins<22>-Footnote-682480207
Ref: Core and Builtins<22>-Footnote-692480251
Ref: Core and Builtins<22>-Footnote-702480295
Ref: Core and Builtins<22>-Footnote-712480339
Ref: Core and Builtins<22>-Footnote-722480383
Ref: Core and Builtins<22>-Footnote-732480427
Ref: Core and Builtins<22>-Footnote-742480471
Ref: Core and Builtins<22>-Footnote-752480515
Ref: Core and Builtins<22>-Footnote-762480559
Ref: Core and Builtins<22>-Footnote-772480603
Ref: Core and Builtins<22>-Footnote-782480647
Ref: Core and Builtins<22>-Footnote-792480691
Ref: Core and Builtins<22>-Footnote-802480735
Ref: Core and Builtins<22>-Footnote-812480779
Ref: Core and Builtins<22>-Footnote-822480823
Ref: Core and Builtins<22>-Footnote-832480867
Ref: Core and Builtins<22>-Footnote-842480911
Ref: Core and Builtins<22>-Footnote-852480955
Ref: Core and Builtins<22>-Footnote-862480999
Ref: Core and Builtins<22>-Footnote-872481043
Ref: Core and Builtins<22>-Footnote-882481087
Ref: Core and Builtins<22>-Footnote-892481131
Ref: Core and Builtins<22>-Footnote-902481175
Ref: Core and Builtins<22>-Footnote-912481225
Ref: Core and Builtins<22>-Footnote-922481269
Ref: Core and Builtins<22>-Footnote-932481313
Ref: Core and Builtins<22>-Footnote-942481357
Ref: Core and Builtins<22>-Footnote-952481401
Ref: Core and Builtins<22>-Footnote-962481445
Ref: Core and Builtins<22>-Footnote-972481489
Ref: Core and Builtins<22>-Footnote-982481533
Ref: Core and Builtins<22>-Footnote-992481577
Ref: Core and Builtins<22>-Footnote-1002481621
Ref: Core and Builtins<22>-Footnote-1012481666
Ref: Core and Builtins<22>-Footnote-1022481711
Ref: Core and Builtins<22>-Footnote-1032481756
Ref: Core and Builtins<22>-Footnote-1042481801
Ref: Core and Builtins<22>-Footnote-1052481846
Ref: Core and Builtins<22>-Footnote-1062481891
Ref: Core and Builtins<22>-Footnote-1072481936
Ref: Core and Builtins<22>-Footnote-1082481981
Ref: Core and Builtins<22>-Footnote-1092482026
Ref: Core and Builtins<22>-Footnote-1102482071
Ref: Core and Builtins<22>-Footnote-1112482116
Ref: Core and Builtins<22>-Footnote-1122482161
Ref: Core and Builtins<22>-Footnote-1132482206
Ref: Core and Builtins<22>-Footnote-1142482251
Ref: Core and Builtins<22>-Footnote-1152482296
Ref: Core and Builtins<22>-Footnote-1162482341
Ref: Core and Builtins<22>-Footnote-1172482386
Ref: Core and Builtins<22>-Footnote-1182482431
Ref: Core and Builtins<22>-Footnote-1192482476
Ref: Core and Builtins<22>-Footnote-1202482521
Ref: Core and Builtins<22>-Footnote-1212482566
Ref: Core and Builtins<22>-Footnote-1222482611
Ref: Core and Builtins<22>-Footnote-1232482656
Ref: Core and Builtins<22>-Footnote-1242482701
Ref: Core and Builtins<22>-Footnote-1252482746
Ref: Core and Builtins<22>-Footnote-1262482791
Ref: Core and Builtins<22>-Footnote-1272482836
Ref: Core and Builtins<22>-Footnote-1282482881
Ref: Core and Builtins<22>-Footnote-1292482926
Ref: Core and Builtins<22>-Footnote-1302482971
Ref: Core and Builtins<22>-Footnote-1312483016
Ref: Core and Builtins<22>-Footnote-1322483061
Ref: Core and Builtins<22>-Footnote-1332483106
Ref: Core and Builtins<22>-Footnote-1342483151
Ref: Core and Builtins<22>-Footnote-1352483196
Ref: Core and Builtins<22>-Footnote-1362483241
Ref: Core and Builtins<22>-Footnote-1372483286
Ref: Core and Builtins<22>-Footnote-1382483331
Ref: Core and Builtins<22>-Footnote-1392483376
Ref: Core and Builtins<22>-Footnote-1402483421
Ref: Core and Builtins<22>-Footnote-1412483466
Ref: Core and Builtins<22>-Footnote-1422483511
Ref: Core and Builtins<22>-Footnote-1432483556
Ref: Core and Builtins<22>-Footnote-1442483601
Ref: Core and Builtins<22>-Footnote-1452483646
Ref: Core and Builtins<22>-Footnote-1462483691
Ref: Core and Builtins<22>-Footnote-1472483736
Ref: Core and Builtins<22>-Footnote-1482483781
Node: Library<23>2483826
Ref: whatsnew/changelog id1832483950
Ref: ff42483950
Ref: Library<23>-Footnote-12530630
Ref: Library<23>-Footnote-22530673
Ref: Library<23>-Footnote-32530716
Ref: Library<23>-Footnote-42530759
Ref: Library<23>-Footnote-52530802
Ref: Library<23>-Footnote-62530845
Ref: Library<23>-Footnote-72530888
Ref: Library<23>-Footnote-82530931
Ref: Library<23>-Footnote-92530974
Ref: Library<23>-Footnote-102531017
Ref: Library<23>-Footnote-112531061
Ref: Library<23>-Footnote-122531105
Ref: Library<23>-Footnote-132531149
Ref: Library<23>-Footnote-142531193
Ref: Library<23>-Footnote-152531237
Ref: Library<23>-Footnote-162531281
Ref: Library<23>-Footnote-172531325
Ref: Library<23>-Footnote-182531369
Ref: Library<23>-Footnote-192531413
Ref: Library<23>-Footnote-202531457
Ref: Library<23>-Footnote-212531501
Ref: Library<23>-Footnote-222531547
Ref: Library<23>-Footnote-232531591
Ref: Library<23>-Footnote-242531635
Ref: Library<23>-Footnote-252531679
Ref: Library<23>-Footnote-262531723
Ref: Library<23>-Footnote-272531773
Ref: Library<23>-Footnote-282531817
Ref: Library<23>-Footnote-292531861
Ref: Library<23>-Footnote-302531905
Ref: Library<23>-Footnote-312531949
Ref: Library<23>-Footnote-322531993
Ref: Library<23>-Footnote-332532037
Ref: Library<23>-Footnote-342532081
Ref: Library<23>-Footnote-352532124
Ref: Library<23>-Footnote-362532168
Ref: Library<23>-Footnote-372532212
Ref: Library<23>-Footnote-382532256
Ref: Library<23>-Footnote-392532300
Ref: Library<23>-Footnote-402532343
Ref: Library<23>-Footnote-412532387
Ref: Library<23>-Footnote-422532431
Ref: Library<23>-Footnote-432532475
Ref: Library<23>-Footnote-442532519
Ref: Library<23>-Footnote-452532563
Ref: Library<23>-Footnote-462532607
Ref: Library<23>-Footnote-472532651
Ref: Library<23>-Footnote-482532695
Ref: Library<23>-Footnote-492532739
Ref: Library<23>-Footnote-502532783
Ref: Library<23>-Footnote-512532827
Ref: Library<23>-Footnote-522532871
Ref: Library<23>-Footnote-532532914
Ref: Library<23>-Footnote-542532958
Ref: Library<23>-Footnote-552533002
Ref: Library<23>-Footnote-562533046
Ref: Library<23>-Footnote-572533090
Ref: Library<23>-Footnote-582533134
Ref: Library<23>-Footnote-592533178
Ref: Library<23>-Footnote-602533222
Ref: Library<23>-Footnote-612533266
Ref: Library<23>-Footnote-622533310
Ref: Library<23>-Footnote-632533354
Ref: Library<23>-Footnote-642533398
Ref: Library<23>-Footnote-652533442
Ref: Library<23>-Footnote-662533486
Ref: Library<23>-Footnote-672533530
Ref: Library<23>-Footnote-682533574
Ref: Library<23>-Footnote-692533618
Ref: Library<23>-Footnote-702533662
Ref: Library<23>-Footnote-712533706
Ref: Library<23>-Footnote-722533750
Ref: Library<23>-Footnote-732533793
Ref: Library<23>-Footnote-742533837
Ref: Library<23>-Footnote-752533881
Ref: Library<23>-Footnote-762533925
Ref: Library<23>-Footnote-772533969
Ref: Library<23>-Footnote-782534013
Ref: Library<23>-Footnote-792534057
Ref: Library<23>-Footnote-802534101
Ref: Library<23>-Footnote-812534145
Ref: Library<23>-Footnote-822534189
Ref: Library<23>-Footnote-832534233
Ref: Library<23>-Footnote-842534277
Ref: Library<23>-Footnote-852534321
Ref: Library<23>-Footnote-862534365
Ref: Library<23>-Footnote-872534409
Ref: Library<23>-Footnote-882534453
Ref: Library<23>-Footnote-892534497
Ref: Library<23>-Footnote-902534541
Ref: Library<23>-Footnote-912534585
Ref: Library<23>-Footnote-922534629
Ref: Library<23>-Footnote-932534673
Ref: Library<23>-Footnote-942534717
Ref: Library<23>-Footnote-952534761
Ref: Library<23>-Footnote-962534805
Ref: Library<23>-Footnote-972534849
Ref: Library<23>-Footnote-982534893
Ref: Library<23>-Footnote-992534937
Ref: Library<23>-Footnote-1002534981
Ref: Library<23>-Footnote-1012535026
Ref: Library<23>-Footnote-1022535071
Ref: Library<23>-Footnote-1032535116
Ref: Library<23>-Footnote-1042535161
Ref: Library<23>-Footnote-1052535206
Ref: Library<23>-Footnote-1062535251
Ref: Library<23>-Footnote-1072535296
Ref: Library<23>-Footnote-1082535341
Ref: Library<23>-Footnote-1092535386
Ref: Library<23>-Footnote-1102535431
Ref: Library<23>-Footnote-1112535476
Ref: Library<23>-Footnote-1122535521
Ref: Library<23>-Footnote-1132535566
Ref: Library<23>-Footnote-1142535611
Ref: Library<23>-Footnote-1152535656
Ref: Library<23>-Footnote-1162535701
Ref: Library<23>-Footnote-1172535745
Ref: Library<23>-Footnote-1182535790
Ref: Library<23>-Footnote-1192535835
Ref: Library<23>-Footnote-1202535880
Ref: Library<23>-Footnote-1212535925
Ref: Library<23>-Footnote-1222535970
Ref: Library<23>-Footnote-1232536015
Ref: Library<23>-Footnote-1242536060
Ref: Library<23>-Footnote-1252536105
Ref: Library<23>-Footnote-1262536150
Ref: Library<23>-Footnote-1272536195
Ref: Library<23>-Footnote-1282536240
Ref: Library<23>-Footnote-1292536285
Ref: Library<23>-Footnote-1302536330
Ref: Library<23>-Footnote-1312536375
Ref: Library<23>-Footnote-1322536420
Ref: Library<23>-Footnote-1332536465
Ref: Library<23>-Footnote-1342536510
Ref: Library<23>-Footnote-1352536555
Ref: Library<23>-Footnote-1362536600
Ref: Library<23>-Footnote-1372536645
Ref: Library<23>-Footnote-1382536690
Ref: Library<23>-Footnote-1392536735
Ref: Library<23>-Footnote-1402536780
Ref: Library<23>-Footnote-1412536825
Ref: Library<23>-Footnote-1422536870
Ref: Library<23>-Footnote-1432536915
Ref: Library<23>-Footnote-1442536960
Ref: Library<23>-Footnote-1452537005
Ref: Library<23>-Footnote-1462537050
Ref: Library<23>-Footnote-1472537094
Ref: Library<23>-Footnote-1482537139
Ref: Library<23>-Footnote-1492537184
Ref: Library<23>-Footnote-1502537229
Ref: Library<23>-Footnote-1512537274
Ref: Library<23>-Footnote-1522537319
Ref: Library<23>-Footnote-1532537364
Ref: Library<23>-Footnote-1542537409
Ref: Library<23>-Footnote-1552537454
Ref: Library<23>-Footnote-1562537499
Ref: Library<23>-Footnote-1572537544
Ref: Library<23>-Footnote-1582537589
Ref: Library<23>-Footnote-1592537634
Ref: Library<23>-Footnote-1602537679
Ref: Library<23>-Footnote-1612537724
Ref: Library<23>-Footnote-1622537769
Ref: Library<23>-Footnote-1632537814
Ref: Library<23>-Footnote-1642537859
Ref: Library<23>-Footnote-1652537904
Ref: Library<23>-Footnote-1662537949
Ref: Library<23>-Footnote-1672537994
Ref: Library<23>-Footnote-1682538039
Ref: Library<23>-Footnote-1692538084
Ref: Library<23>-Footnote-1702538128
Ref: Library<23>-Footnote-1712538173
Ref: Library<23>-Footnote-1722538218
Ref: Library<23>-Footnote-1732538263
Ref: Library<23>-Footnote-1742538308
Ref: Library<23>-Footnote-1752538353
Ref: Library<23>-Footnote-1762538398
Ref: Library<23>-Footnote-1772538443
Ref: Library<23>-Footnote-1782538488
Ref: Library<23>-Footnote-1792538533
Ref: Library<23>-Footnote-1802538578
Ref: Library<23>-Footnote-1812538622
Ref: Library<23>-Footnote-1822538667
Ref: Library<23>-Footnote-1832538712
Ref: Library<23>-Footnote-1842538757
Ref: Library<23>-Footnote-1852538802
Ref: Library<23>-Footnote-1862538847
Ref: Library<23>-Footnote-1872538891
Ref: Library<23>-Footnote-1882538936
Ref: Library<23>-Footnote-1892538981
Ref: Library<23>-Footnote-1902539026
Ref: Library<23>-Footnote-1912539071
Ref: Library<23>-Footnote-1922539116
Ref: Library<23>-Footnote-1932539161
Ref: Library<23>-Footnote-1942539206
Ref: Library<23>-Footnote-1952539251
Ref: Library<23>-Footnote-1962539296
Ref: Library<23>-Footnote-1972539341
Ref: Library<23>-Footnote-1982539386
Ref: Library<23>-Footnote-1992539431
Ref: Library<23>-Footnote-2002539476
Ref: Library<23>-Footnote-2012539521
Ref: Library<23>-Footnote-2022539566
Ref: Library<23>-Footnote-2032539611
Ref: Library<23>-Footnote-2042539656
Ref: Library<23>-Footnote-2052539701
Ref: Library<23>-Footnote-2062539746
Ref: Library<23>-Footnote-2072539791
Ref: Library<23>-Footnote-2082539836
Ref: Library<23>-Footnote-2092539881
Ref: Library<23>-Footnote-2102539926
Ref: Library<23>-Footnote-2112539971
Ref: Library<23>-Footnote-2122540016
Ref: Library<23>-Footnote-2132540061
Ref: Library<23>-Footnote-2142540106
Ref: Library<23>-Footnote-2152540151
Ref: Library<23>-Footnote-2162540196
Ref: Library<23>-Footnote-2172540241
Ref: Library<23>-Footnote-2182540286
Ref: Library<23>-Footnote-2192540331
Ref: Library<23>-Footnote-2202540376
Ref: Library<23>-Footnote-2212540421
Ref: Library<23>-Footnote-2222540466
Ref: Library<23>-Footnote-2232540511
Ref: Library<23>-Footnote-2242540556
Ref: Library<23>-Footnote-2252540600
Ref: Library<23>-Footnote-2262540645
Ref: Library<23>-Footnote-2272540690
Ref: Library<23>-Footnote-2282540735
Ref: Library<23>-Footnote-2292540780
Ref: Library<23>-Footnote-2302540825
Ref: Library<23>-Footnote-2312540870
Ref: Library<23>-Footnote-2322540915
Ref: Library<23>-Footnote-2332540960
Ref: Library<23>-Footnote-2342541005
Ref: Library<23>-Footnote-2352541050
Ref: Library<23>-Footnote-2362541095
Ref: Library<23>-Footnote-2372541140
Ref: Library<23>-Footnote-2382541185
Ref: Library<23>-Footnote-2392541230
Ref: Library<23>-Footnote-2402541275
Ref: Library<23>-Footnote-2412541320
Ref: Library<23>-Footnote-2422541365
Ref: Library<23>-Footnote-2432541410
Ref: Library<23>-Footnote-2442541455
Ref: Library<23>-Footnote-2452541500
Ref: Library<23>-Footnote-2462541545
Ref: Library<23>-Footnote-2472541590
Ref: Library<23>-Footnote-2482541635
Ref: Library<23>-Footnote-2492541680
Ref: Library<23>-Footnote-2502541725
Ref: Library<23>-Footnote-2512541770
Ref: Library<23>-Footnote-2522541815
Ref: Library<23>-Footnote-2532541860
Ref: Library<23>-Footnote-2542541905
Ref: Library<23>-Footnote-2552541950
Ref: Library<23>-Footnote-2562541995
Ref: Library<23>-Footnote-2572542040
Ref: Library<23>-Footnote-2582542085
Ref: Library<23>-Footnote-2592542130
Ref: Library<23>-Footnote-2602542175
Ref: Library<23>-Footnote-2612542220
Ref: Library<23>-Footnote-2622542265
Ref: Library<23>-Footnote-2632542310
Ref: Library<23>-Footnote-2642542355
Ref: Library<23>-Footnote-2652542400
Ref: Library<23>-Footnote-2662542445
Ref: Library<23>-Footnote-2672542490
Ref: Library<23>-Footnote-2682542535
Ref: Library<23>-Footnote-2692542580
Ref: Library<23>-Footnote-2702542625
Ref: Library<23>-Footnote-2712542670
Ref: Library<23>-Footnote-2722542715
Ref: Library<23>-Footnote-2732542771
Ref: Library<23>-Footnote-2742542816
Ref: Library<23>-Footnote-2752542861
Ref: Library<23>-Footnote-2762542906
Ref: Library<23>-Footnote-2772542951
Ref: Library<23>-Footnote-2782542996
Ref: Library<23>-Footnote-2792543041
Ref: Library<23>-Footnote-2802543086
Ref: Library<23>-Footnote-2812543131
Ref: Library<23>-Footnote-2822543176
Ref: Library<23>-Footnote-2832543221
Ref: Library<23>-Footnote-2842543266
Ref: Library<23>-Footnote-2852543311
Ref: Library<23>-Footnote-2862543356
Ref: Library<23>-Footnote-2872543401
Ref: Library<23>-Footnote-2882543446
Ref: Library<23>-Footnote-2892543491
Ref: Library<23>-Footnote-2902543536
Ref: Library<23>-Footnote-2912543581
Ref: Library<23>-Footnote-2922543626
Ref: Library<23>-Footnote-2932543671
Ref: Library<23>-Footnote-2942543716
Ref: Library<23>-Footnote-2952543761
Ref: Library<23>-Footnote-2962543806
Ref: Library<23>-Footnote-2972543851
Ref: Library<23>-Footnote-2982543896
Ref: Library<23>-Footnote-2992543941
Ref: Library<23>-Footnote-3002543986
Ref: Library<23>-Footnote-3012544031
Ref: Library<23>-Footnote-3022544076
Ref: Library<23>-Footnote-3032544121
Ref: Library<23>-Footnote-3042544166
Ref: Library<23>-Footnote-3052544211
Ref: Library<23>-Footnote-3062544256
Ref: Library<23>-Footnote-3072544301
Ref: Library<23>-Footnote-3082544346
Ref: Library<23>-Footnote-3092544391
Ref: Library<23>-Footnote-3102544436
Ref: Library<23>-Footnote-3112544481
Ref: Library<23>-Footnote-3122544526
Ref: Library<23>-Footnote-3132544571
Ref: Library<23>-Footnote-3142544616
Ref: Library<23>-Footnote-3152544661
Ref: Library<23>-Footnote-3162544706
Ref: Library<23>-Footnote-3172544751
Ref: Library<23>-Footnote-3182544796
Ref: Library<23>-Footnote-3192544841
Ref: Library<23>-Footnote-3202544886
Ref: Library<23>-Footnote-3212544931
Ref: Library<23>-Footnote-3222544976
Ref: Library<23>-Footnote-3232545021
Ref: Library<23>-Footnote-3242545066
Ref: Library<23>-Footnote-3252545111
Ref: Library<23>-Footnote-3262545156
Node: Documentation<22>2545201
Ref: whatsnew/changelog id1842545313
Ref: ff52545313
Ref: Documentation<22>-Footnote-12547477
Ref: Documentation<22>-Footnote-22547520
Ref: Documentation<22>-Footnote-32547563
Ref: Documentation<22>-Footnote-42547606
Ref: Documentation<22>-Footnote-52547649
Ref: Documentation<22>-Footnote-62547692
Ref: Documentation<22>-Footnote-72547735
Ref: Documentation<22>-Footnote-82547778
Ref: Documentation<22>-Footnote-92547821
Ref: Documentation<22>-Footnote-102547864
Ref: Documentation<22>-Footnote-112547908
Ref: Documentation<22>-Footnote-122547952
Ref: Documentation<22>-Footnote-132547996
Ref: Documentation<22>-Footnote-142548040
Ref: Documentation<22>-Footnote-152548084
Ref: Documentation<22>-Footnote-162548128
Ref: Documentation<22>-Footnote-172548178
Node: Tests<20>2548222
Ref: whatsnew/changelog id1852548332
Ref: ff82548332
Ref: Tests<20>-Footnote-12551090
Ref: Tests<20>-Footnote-22551133
Ref: Tests<20>-Footnote-32551176
Ref: Tests<20>-Footnote-42551219
Ref: Tests<20>-Footnote-52551262
Ref: Tests<20>-Footnote-62551305
Ref: Tests<20>-Footnote-72551348
Ref: Tests<20>-Footnote-82551391
Ref: Tests<20>-Footnote-92551434
Ref: Tests<20>-Footnote-102551477
Ref: Tests<20>-Footnote-112551521
Ref: Tests<20>-Footnote-122551565
Ref: Tests<20>-Footnote-132551609
Ref: Tests<20>-Footnote-142551653
Ref: Tests<20>-Footnote-152551697
Ref: Tests<20>-Footnote-162551741
Ref: Tests<20>-Footnote-172551785
Ref: Tests<20>-Footnote-182551829
Ref: Tests<20>-Footnote-192551873
Node: Build<18>2551917
Ref: whatsnew/changelog id1862552021
Ref: ff92552021
Ref: Build<18>-Footnote-12556785
Ref: Build<18>-Footnote-22556828
Ref: Build<18>-Footnote-32556871
Ref: Build<18>-Footnote-42556914
Ref: Build<18>-Footnote-52556963
Ref: Build<18>-Footnote-62557006
Ref: Build<18>-Footnote-72557049
Ref: Build<18>-Footnote-82557092
Ref: Build<18>-Footnote-92557135
Ref: Build<18>-Footnote-102557178
Ref: Build<18>-Footnote-112557222
Ref: Build<18>-Footnote-122557266
Ref: Build<18>-Footnote-132557310
Ref: Build<18>-Footnote-142557354
Ref: Build<18>-Footnote-152557398
Ref: Build<18>-Footnote-162557442
Ref: Build<18>-Footnote-172557486
Ref: Build<18>-Footnote-182557530
Ref: Build<18>-Footnote-192557574
Ref: Build<18>-Footnote-202557618
Ref: Build<18>-Footnote-212557662
Ref: Build<18>-Footnote-222557706
Ref: Build<18>-Footnote-232557750
Ref: Build<18>-Footnote-242557794
Ref: Build<18>-Footnote-252557838
Ref: Build<18>-Footnote-262557882
Ref: Build<18>-Footnote-272557926
Ref: Build<18>-Footnote-282557970
Ref: Build<18>-Footnote-292558014
Ref: Build<18>-Footnote-302558058
Ref: Build<18>-Footnote-312558102
Ref: Build<18>-Footnote-322558146
Ref: Build<18>-Footnote-332558190
Ref: Build<18>-Footnote-342558234
Ref: Build<18>-Footnote-352558278
Ref: Build<18>-Footnote-362558322
Ref: Build<18>-Footnote-372558366
Node: Windows<20>2558410
Ref: whatsnew/changelog id1872558513
Ref: ffa2558513
Ref: Windows<20>-Footnote-12560999
Ref: Windows<20>-Footnote-22561042
Ref: Windows<20>-Footnote-32561085
Ref: Windows<20>-Footnote-42561128
Ref: Windows<20>-Footnote-52561171
Ref: Windows<20>-Footnote-62561214
Ref: Windows<20>-Footnote-72561257
Ref: Windows<20>-Footnote-82561300
Ref: Windows<20>-Footnote-92561343
Ref: Windows<20>-Footnote-102561386
Ref: Windows<20>-Footnote-112561430
Ref: Windows<20>-Footnote-122561474
Ref: Windows<20>-Footnote-132561518
Ref: Windows<20>-Footnote-142561562
Ref: Windows<20>-Footnote-152561606
Ref: Windows<20>-Footnote-162561650
Ref: Windows<20>-Footnote-172561694
Ref: Windows<20>-Footnote-182561738
Ref: Windows<20>-Footnote-192561782
Ref: Windows<20>-Footnote-202561826
Ref: Windows<20>-Footnote-212561870
Ref: Windows<20>-Footnote-222561914
Ref: Windows<20>-Footnote-232561958
Ref: Windows<20>-Footnote-242562002
Ref: Windows<20>-Footnote-252562046
Node: IDLE<22>2562090
Ref: whatsnew/changelog id1882562199
Ref: ffb2562199
Ref: IDLE<22>-Footnote-12572216
Ref: IDLE<22>-Footnote-22572259
Ref: IDLE<22>-Footnote-32572302
Ref: IDLE<22>-Footnote-42572345
Ref: IDLE<22>-Footnote-52572388
Ref: IDLE<22>-Footnote-62572431
Ref: IDLE<22>-Footnote-72572474
Ref: IDLE<22>-Footnote-82572517
Ref: IDLE<22>-Footnote-92572560
Ref: IDLE<22>-Footnote-102572603
Ref: IDLE<22>-Footnote-112572647
Ref: IDLE<22>-Footnote-122572691
Ref: IDLE<22>-Footnote-132572735
Ref: IDLE<22>-Footnote-142572779
Ref: IDLE<22>-Footnote-152572823
Ref: IDLE<22>-Footnote-162572867
Ref: IDLE<22>-Footnote-172572911
Ref: IDLE<22>-Footnote-182572955
Ref: IDLE<22>-Footnote-192572999
Ref: IDLE<22>-Footnote-202573043
Ref: IDLE<22>-Footnote-212573087
Ref: IDLE<22>-Footnote-222573131
Ref: IDLE<22>-Footnote-232573175
Ref: IDLE<22>-Footnote-242573219
Ref: IDLE<22>-Footnote-252573263
Ref: IDLE<22>-Footnote-262573307
Ref: IDLE<22>-Footnote-272573351
Ref: IDLE<22>-Footnote-282573395
Ref: IDLE<22>-Footnote-292573439
Ref: IDLE<22>-Footnote-302573483
Ref: IDLE<22>-Footnote-312573527
Ref: IDLE<22>-Footnote-322573571
Ref: IDLE<22>-Footnote-332573615
Ref: IDLE<22>-Footnote-342573659
Ref: IDLE<22>-Footnote-352573702
Ref: IDLE<22>-Footnote-362573746
Ref: IDLE<22>-Footnote-372573790
Ref: IDLE<22>-Footnote-382573834
Ref: IDLE<22>-Footnote-392573878
Ref: IDLE<22>-Footnote-402573922
Ref: IDLE<22>-Footnote-412573966
Ref: IDLE<22>-Footnote-422574010
Ref: IDLE<22>-Footnote-432574054
Ref: IDLE<22>-Footnote-442574097
Ref: IDLE<22>-Footnote-452574141
Ref: IDLE<22>-Footnote-462574185
Ref: IDLE<22>-Footnote-472574229
Ref: IDLE<22>-Footnote-482574273
Ref: IDLE<22>-Footnote-492574317
Ref: IDLE<22>-Footnote-502574361
Ref: IDLE<22>-Footnote-512574405
Node: Tools/Demos<14>2574449
Ref: whatsnew/changelog id1892574556
Ref: ffc2574556
Ref: Tools/Demos<14>-Footnote-12576055
Ref: Tools/Demos<14>-Footnote-22576098
Ref: Tools/Demos<14>-Footnote-32576147
Ref: Tools/Demos<14>-Footnote-42576190
Ref: Tools/Demos<14>-Footnote-52576233
Ref: Tools/Demos<14>-Footnote-62576276
Ref: Tools/Demos<14>-Footnote-72576319
Ref: Tools/Demos<14>-Footnote-82576362
Node: C API<16>2576405
Ref: whatsnew/changelog id1902576495
Ref: ffd2576495
Ref: C API<16>-Footnote-12579559
Ref: C API<16>-Footnote-22579602
Ref: C API<16>-Footnote-32579645
Ref: C API<16>-Footnote-42579688
Ref: C API<16>-Footnote-52579731
Ref: C API<16>-Footnote-62579773
Ref: C API<16>-Footnote-72579816
Ref: C API<16>-Footnote-82579859
Ref: C API<16>-Footnote-92579902
Ref: C API<16>-Footnote-102579945
Ref: C API<16>-Footnote-112579989
Ref: C API<16>-Footnote-122580033
Ref: C API<16>-Footnote-132580077
Ref: C API<16>-Footnote-142580121
Ref: C API<16>-Footnote-152580165
Node: Python 3 6 6 final2580209
Ref: whatsnew/changelog python-3-6-6-final2580343
Ref: ffe2580343
Node: Python 3 6 6 release candidate 12580471
Ref: whatsnew/changelog python-3-6-6-release-candidate-12580603
Ref: fff2580603
Node: Core and Builtins<23>2580982
Ref: whatsnew/changelog id1912581092
Ref: 10002581092
Ref: Core and Builtins<23>-Footnote-12582673
Ref: Core and Builtins<23>-Footnote-22582716
Ref: Core and Builtins<23>-Footnote-32582759
Ref: Core and Builtins<23>-Footnote-42582802
Ref: Core and Builtins<23>-Footnote-52582845
Ref: Core and Builtins<23>-Footnote-62582888
Ref: Core and Builtins<23>-Footnote-72582931
Ref: Core and Builtins<23>-Footnote-82582974
Ref: Core and Builtins<23>-Footnote-92583017
Ref: Core and Builtins<23>-Footnote-102583060
Ref: Core and Builtins<23>-Footnote-112583104
Ref: Core and Builtins<23>-Footnote-122583148
Node: Library<24>2583192
Ref: whatsnew/changelog id1922583328
Ref: 10012583328
Ref: Library<24>-Footnote-12588813
Ref: Library<24>-Footnote-22588856
Ref: Library<24>-Footnote-32588899
Ref: Library<24>-Footnote-42588942
Ref: Library<24>-Footnote-52588985
Ref: Library<24>-Footnote-62589028
Ref: Library<24>-Footnote-72589071
Ref: Library<24>-Footnote-82589114
Ref: Library<24>-Footnote-92589157
Ref: Library<24>-Footnote-102589200
Ref: Library<24>-Footnote-112589244
Ref: Library<24>-Footnote-122589288
Ref: Library<24>-Footnote-132589332
Ref: Library<24>-Footnote-142589376
Ref: Library<24>-Footnote-152589420
Ref: Library<24>-Footnote-162589464
Ref: Library<24>-Footnote-172589508
Ref: Library<24>-Footnote-182589552
Ref: Library<24>-Footnote-192589596
Ref: Library<24>-Footnote-202589640
Ref: Library<24>-Footnote-212589684
Ref: Library<24>-Footnote-222589729
Ref: Library<24>-Footnote-232589773
Ref: Library<24>-Footnote-242589817
Ref: Library<24>-Footnote-252589861
Ref: Library<24>-Footnote-262589905
Ref: Library<24>-Footnote-272589949
Ref: Library<24>-Footnote-282589993
Ref: Library<24>-Footnote-292590043
Ref: Library<24>-Footnote-302590087
Ref: Library<24>-Footnote-312590131
Ref: Library<24>-Footnote-322590175
Ref: Library<24>-Footnote-332590219
Ref: Library<24>-Footnote-342590263
Ref: Library<24>-Footnote-352590307
Ref: Library<24>-Footnote-362590351
Ref: Library<24>-Footnote-372590395
Ref: Library<24>-Footnote-382590439
Ref: Library<24>-Footnote-392590483
Node: Documentation<23>2590527
Ref: whatsnew/changelog id1932590651
Ref: 10022590651
Ref: Documentation<23>-Footnote-12592142
Ref: Documentation<23>-Footnote-22592185
Ref: Documentation<23>-Footnote-32592228
Ref: Documentation<23>-Footnote-42592271
Ref: Documentation<23>-Footnote-52592314
Ref: Documentation<23>-Footnote-62592357
Ref: Documentation<23>-Footnote-72592400
Ref: Documentation<23>-Footnote-82592443
Ref: Documentation<23>-Footnote-92592486
Ref: Documentation<23>-Footnote-102592529
Ref: Documentation<23>-Footnote-112592573
Ref: Documentation<23>-Footnote-122592617
Ref: Documentation<23>-Footnote-132592660
Node: Tests<21>2592704
Ref: whatsnew/changelog id1942592826
Ref: 10032592826
Ref: Tests<21>-Footnote-12593048
Ref: Tests<21>-Footnote-22593091
Node: Build<19>2593134
Ref: whatsnew/changelog id1952593250
Ref: 10042593250
Ref: Build<19>-Footnote-12594047
Ref: Build<19>-Footnote-22594089
Ref: Build<19>-Footnote-32594132
Ref: Build<19>-Footnote-42594175
Ref: Build<19>-Footnote-52594218
Node: Windows<21>2594261
Ref: whatsnew/changelog id1962594377
Ref: 10052594377
Ref: Windows<21>-Footnote-12594514
Node: macOS<15>2594557
Ref: whatsnew/changelog id1972594672
Ref: 10062594672
Ref: macOS<15>-Footnote-12594813
Node: IDLE<23>2594856
Ref: whatsnew/changelog id1982594975
Ref: 10072594975
Ref: IDLE<23>-Footnote-12597044
Ref: IDLE<23>-Footnote-22597087
Ref: IDLE<23>-Footnote-32597130
Ref: IDLE<23>-Footnote-42597173
Ref: IDLE<23>-Footnote-52597216
Ref: IDLE<23>-Footnote-62597259
Ref: IDLE<23>-Footnote-72597302
Ref: IDLE<23>-Footnote-82597345
Ref: IDLE<23>-Footnote-92597388
Ref: IDLE<23>-Footnote-102597431
Ref: IDLE<23>-Footnote-112597475
Ref: IDLE<23>-Footnote-122597519
Node: Tools/Demos<15>2597563
Ref: whatsnew/changelog id1992597682
Ref: 10082597682
Ref: Tools/Demos<15>-Footnote-12598437
Ref: Tools/Demos<15>-Footnote-22598480
Ref: Tools/Demos<15>-Footnote-32598523
Ref: Tools/Demos<15>-Footnote-42598566
Ref: Tools/Demos<15>-Footnote-52598609
Node: C API<17>2598652
Ref: whatsnew/changelog id2002598754
Ref: 10092598754
Ref: C API<17>-Footnote-12598967
Node: Python 3 6 5 final2599010
Ref: whatsnew/changelog python-3-6-5-final2599156
Ref: 100a2599156
Node: Tests<22>2599289
Ref: whatsnew/changelog id2012599371
Ref: 100b2599371
Ref: Tests<22>-Footnote-12599525
Node: Build<20>2599568
Ref: whatsnew/changelog id2022599650
Ref: 100c2599650
Ref: Build<20>-Footnote-12599787
Node: Python 3 6 5 release candidate 12599830
Ref: whatsnew/changelog python-3-6-5-release-candidate-12599962
Ref: 100d2599962
Node: Security<13>2600367
Ref: whatsnew/changelog id2032600478
Ref: 100e2600478
Ref: Security<13>-Footnote-12600903
Ref: Security<13>-Footnote-22600946
Node: Core and Builtins<24>2600989
Ref: whatsnew/changelog id2042601120
Ref: 100f2601120
Ref: Core and Builtins<24>-Footnote-12603294
Ref: Core and Builtins<24>-Footnote-22603337
Ref: Core and Builtins<24>-Footnote-32603380
Ref: Core and Builtins<24>-Footnote-42603423
Ref: Core and Builtins<24>-Footnote-52603466
Ref: Core and Builtins<24>-Footnote-62603509
Ref: Core and Builtins<24>-Footnote-72603552
Ref: Core and Builtins<24>-Footnote-82603595
Ref: Core and Builtins<24>-Footnote-92603638
Ref: Core and Builtins<24>-Footnote-102603681
Ref: Core and Builtins<24>-Footnote-112603725
Ref: Core and Builtins<24>-Footnote-122603769
Ref: Core and Builtins<24>-Footnote-132603813
Ref: Core and Builtins<24>-Footnote-142603857
Node: Library<25>2603901
Ref: whatsnew/changelog id2052604037
Ref: 10102604037
Ref: Library<25>-Footnote-12609975
Ref: Library<25>-Footnote-22610018
Ref: Library<25>-Footnote-32610061
Ref: Library<25>-Footnote-42610104
Ref: Library<25>-Footnote-52610147
Ref: Library<25>-Footnote-62610190
Ref: Library<25>-Footnote-72610233
Ref: Library<25>-Footnote-82610276
Ref: Library<25>-Footnote-92610319
Ref: Library<25>-Footnote-102610362
Ref: Library<25>-Footnote-112610406
Ref: Library<25>-Footnote-122610450
Ref: Library<25>-Footnote-132610494
Ref: Library<25>-Footnote-142610538
Ref: Library<25>-Footnote-152610582
Ref: Library<25>-Footnote-162610626
Ref: Library<25>-Footnote-172610670
Ref: Library<25>-Footnote-182610714
Ref: Library<25>-Footnote-192610758
Ref: Library<25>-Footnote-202610802
Ref: Library<25>-Footnote-212610846
Ref: Library<25>-Footnote-222610890
Ref: Library<25>-Footnote-232610934
Ref: Library<25>-Footnote-242610978
Ref: Library<25>-Footnote-252611022
Ref: Library<25>-Footnote-262611066
Ref: Library<25>-Footnote-272611110
Ref: Library<25>-Footnote-282611154
Ref: Library<25>-Footnote-292611198
Ref: Library<25>-Footnote-302611242
Ref: Library<25>-Footnote-312611286
Ref: Library<25>-Footnote-322611330
Ref: Library<25>-Footnote-332611374
Ref: Library<25>-Footnote-342611418
Ref: Library<25>-Footnote-352611462
Ref: Library<25>-Footnote-362611506
Ref: Library<25>-Footnote-372611550
Ref: Library<25>-Footnote-382611594
Ref: Library<25>-Footnote-392611638
Ref: Library<25>-Footnote-402611682
Node: Documentation<24>2611726
Ref: whatsnew/changelog id2062611850
Ref: 10112611850
Ref: Documentation<24>-Footnote-12612703
Ref: Documentation<24>-Footnote-22612746
Ref: Documentation<24>-Footnote-32612789
Ref: Documentation<24>-Footnote-42612831
Ref: Documentation<24>-Footnote-52612874
Ref: Documentation<24>-Footnote-62612917
Node: Tests<23>2612960
Ref: whatsnew/changelog id2072613082
Ref: 10122613082
Ref: Tests<23>-Footnote-12613743
Ref: Tests<23>-Footnote-22613786
Ref: Tests<23>-Footnote-32613829
Ref: Tests<23>-Footnote-42613872
Node: Build<21>2613915
Ref: whatsnew/changelog id2082614031
Ref: 10132614031
Ref: Build<21>-Footnote-12614220
Node: Windows<22>2614263
Ref: whatsnew/changelog id2092614379
Ref: 10142614379
Ref: Windows<22>-Footnote-12615329
Ref: Windows<22>-Footnote-22615372
Ref: Windows<22>-Footnote-32615415
Ref: Windows<22>-Footnote-42615458
Ref: Windows<22>-Footnote-52615501
Ref: Windows<22>-Footnote-62615544
Ref: Windows<22>-Footnote-72615587
Ref: Windows<22>-Footnote-82615630
Node: macOS<16>2615673
Ref: whatsnew/changelog id2102615788
Ref: 10152615788
Ref: macOS<16>-Footnote-12616181
Node: IDLE<24>2616224
Ref: whatsnew/changelog id2112616343
Ref: 10162616343
Ref: IDLE<24>-Footnote-12617837
Ref: IDLE<24>-Footnote-22617880
Ref: IDLE<24>-Footnote-32617923
Ref: IDLE<24>-Footnote-42617966
Ref: IDLE<24>-Footnote-52618009
Ref: IDLE<24>-Footnote-62618052
Ref: IDLE<24>-Footnote-72618095
Ref: IDLE<24>-Footnote-82618138
Node: Tools/Demos<16>2618181
Ref: whatsnew/changelog id2122618300
Ref: 10172618300
Ref: Tools/Demos<16>-Footnote-12618720
Ref: Tools/Demos<16>-Footnote-22618763
Node: C API<18>2618806
Ref: whatsnew/changelog id2132618908
Ref: 10182618908
Ref: C API<18>-Footnote-12619158
Node: Python 3 6 4 final2619201
Ref: whatsnew/changelog python-3-6-4-final2619347
Ref: 10192619347
Node: Python 3 6 4 release candidate 12619496
Ref: whatsnew/changelog python-3-6-4-release-candidate-12619628
Ref: 101a2619628
Node: Core and Builtins<25>2620007
Ref: whatsnew/changelog id2142620117
Ref: 101b2620117
Ref: Core and Builtins<25>-Footnote-12624861
Ref: Core and Builtins<25>-Footnote-22624904
Ref: Core and Builtins<25>-Footnote-32624947
Ref: Core and Builtins<25>-Footnote-42624990
Ref: Core and Builtins<25>-Footnote-52625033
Ref: Core and Builtins<25>-Footnote-62625076
Ref: Core and Builtins<25>-Footnote-72625119
Ref: Core and Builtins<25>-Footnote-82625162
Ref: Core and Builtins<25>-Footnote-92625205
Ref: Core and Builtins<25>-Footnote-102625248
Ref: Core and Builtins<25>-Footnote-112625292
Ref: Core and Builtins<25>-Footnote-122625336
Ref: Core and Builtins<25>-Footnote-132625380
Ref: Core and Builtins<25>-Footnote-142625424
Ref: Core and Builtins<25>-Footnote-152625468
Ref: Core and Builtins<25>-Footnote-162625512
Ref: Core and Builtins<25>-Footnote-172625556
Ref: Core and Builtins<25>-Footnote-182625600
Ref: Core and Builtins<25>-Footnote-192625644
Ref: Core and Builtins<25>-Footnote-202625688
Ref: Core and Builtins<25>-Footnote-212625732
Ref: Core and Builtins<25>-Footnote-222625776
Ref: Core and Builtins<25>-Footnote-232625820
Ref: Core and Builtins<25>-Footnote-242625864
Node: Library<26>2625908
Ref: whatsnew/changelog id2152626044
Ref: 101c2626044
Ref: Library<26>-Footnote-12633378
Ref: Library<26>-Footnote-22633421
Ref: Library<26>-Footnote-32633464
Ref: Library<26>-Footnote-42633507
Ref: Library<26>-Footnote-52633550
Ref: Library<26>-Footnote-62633593
Ref: Library<26>-Footnote-72633636
Ref: Library<26>-Footnote-82633679
Ref: Library<26>-Footnote-92633722
Ref: Library<26>-Footnote-102633765
Ref: Library<26>-Footnote-112633809
Ref: Library<26>-Footnote-122633853
Ref: Library<26>-Footnote-132633897
Ref: Library<26>-Footnote-142633941
Ref: Library<26>-Footnote-152633985
Ref: Library<26>-Footnote-162634029
Ref: Library<26>-Footnote-172634072
Ref: Library<26>-Footnote-182634116
Ref: Library<26>-Footnote-192634160
Ref: Library<26>-Footnote-202634204
Ref: Library<26>-Footnote-212634248
Ref: Library<26>-Footnote-222634292
Ref: Library<26>-Footnote-232634336
Ref: Library<26>-Footnote-242634380
Ref: Library<26>-Footnote-252634424
Ref: Library<26>-Footnote-262634468
Ref: Library<26>-Footnote-272634512
Ref: Library<26>-Footnote-282634556
Ref: Library<26>-Footnote-292634600
Ref: Library<26>-Footnote-302634644
Ref: Library<26>-Footnote-312634688
Ref: Library<26>-Footnote-322634732
Ref: Library<26>-Footnote-332634776
Ref: Library<26>-Footnote-342634820
Ref: Library<26>-Footnote-352634864
Ref: Library<26>-Footnote-362634908
Ref: Library<26>-Footnote-372634952
Ref: Library<26>-Footnote-382634996
Ref: Library<26>-Footnote-392635040
Ref: Library<26>-Footnote-402635084
Ref: Library<26>-Footnote-412635128
Ref: Library<26>-Footnote-422635172
Ref: Library<26>-Footnote-432635216
Ref: Library<26>-Footnote-442635260
Ref: Library<26>-Footnote-452635304
Ref: Library<26>-Footnote-462635348
Ref: Library<26>-Footnote-472635392
Ref: Library<26>-Footnote-482635436
Ref: Library<26>-Footnote-492635480
Ref: Library<26>-Footnote-502635524
Ref: Library<26>-Footnote-512635568
Ref: Library<26>-Footnote-522635612
Node: Documentation<25>2635656
Ref: whatsnew/changelog id2162635780
Ref: 101d2635780
Ref: Documentation<25>-Footnote-12636269
Ref: Documentation<25>-Footnote-22636312
Ref: Documentation<25>-Footnote-32636355
Node: Tests<24>2636398
Ref: whatsnew/changelog id2172636520
Ref: 101e2636520
Ref: Tests<24>-Footnote-12637192
Ref: Tests<24>-Footnote-22637235
Ref: Tests<24>-Footnote-32637278
Ref: Tests<24>-Footnote-42637321
Node: Build<22>2637364
Ref: whatsnew/changelog id2182637480
Ref: 101f2637480
Ref: Build<22>-Footnote-12638384
Ref: Build<22>-Footnote-22638427
Ref: Build<22>-Footnote-32638470
Ref: Build<22>-Footnote-42638513
Ref: Build<22>-Footnote-52638556
Ref: Build<22>-Footnote-62638599
Ref: Build<22>-Footnote-72638642
Ref: Build<22>-Footnote-82638685
Ref: Build<22>-Footnote-92638728
Node: Windows<23>2638771
Ref: whatsnew/changelog id2192638887
Ref: 10202638887
Ref: Windows<23>-Footnote-12639205
Ref: Windows<23>-Footnote-22639247
Node: macOS<17>2639290
Ref: whatsnew/changelog id2202639405
Ref: 10212639405
Ref: macOS<17>-Footnote-12639539
Node: IDLE<25>2639582
Ref: whatsnew/changelog id2212639701
Ref: 10222639701
Ref: IDLE<25>-Footnote-12643038
Ref: IDLE<25>-Footnote-22643081
Ref: IDLE<25>-Footnote-32643124
Ref: IDLE<25>-Footnote-42643167
Ref: IDLE<25>-Footnote-52643210
Ref: IDLE<25>-Footnote-62643253
Ref: IDLE<25>-Footnote-72643296
Ref: IDLE<25>-Footnote-82643339
Ref: IDLE<25>-Footnote-92643382
Ref: IDLE<25>-Footnote-102643425
Ref: IDLE<25>-Footnote-112643469
Ref: IDLE<25>-Footnote-122643513
Ref: IDLE<25>-Footnote-132643557
Ref: IDLE<25>-Footnote-142643601
Node: Tools/Demos<17>2643647
Ref: whatsnew/changelog id2222643766
Ref: 10232643766
Ref: Tools/Demos<17>-Footnote-12644056
Node: C API<19>2644099
Ref: whatsnew/changelog id2232644201
Ref: 10242644201
Ref: C API<19>-Footnote-12644929
Ref: C API<19>-Footnote-22644972
Ref: C API<19>-Footnote-32645015
Ref: C API<19>-Footnote-42645058
Node: Python 3 6 3 final2645101
Ref: whatsnew/changelog python-3-6-3-final2645247
Ref: 10252645247
Node: Library<27>2645384
Ref: whatsnew/changelog id2242645468
Ref: 10262645468
Ref: Library<27>-Footnote-12645681
Node: Build<23>2645724
Ref: whatsnew/changelog id2252645808
Ref: 10282645808
Ref: Build<23>-Footnote-12646099
Ref: Build<23>-Footnote-22646142
Node: Python 3 6 3 release candidate 12646185
Ref: whatsnew/changelog python-3-6-3-release-candidate-12646317
Ref: 10292646317
Node: Security<14>2646682
Ref: whatsnew/changelog id2262646793
Ref: 102a2646793
Ref: Security<14>-Footnote-12647099
Ref: Security<14>-Footnote-22647142
Node: Core and Builtins<26>2647185
Ref: whatsnew/changelog id2272647316
Ref: 102b2647316
Ref: Core and Builtins<26>-Footnote-12650862
Ref: Core and Builtins<26>-Footnote-22650905
Ref: Core and Builtins<26>-Footnote-32650948
Ref: Core and Builtins<26>-Footnote-42650991
Ref: Core and Builtins<26>-Footnote-52651034
Ref: Core and Builtins<26>-Footnote-62651077
Ref: Core and Builtins<26>-Footnote-72651120
Ref: Core and Builtins<26>-Footnote-82651163
Ref: Core and Builtins<26>-Footnote-92651206
Ref: Core and Builtins<26>-Footnote-102651249
Ref: Core and Builtins<26>-Footnote-112651293
Ref: Core and Builtins<26>-Footnote-122651337
Ref: Core and Builtins<26>-Footnote-132651381
Ref: Core and Builtins<26>-Footnote-142651425
Ref: Core and Builtins<26>-Footnote-152651469
Ref: Core and Builtins<26>-Footnote-162651513
Ref: Core and Builtins<26>-Footnote-172651557
Ref: Core and Builtins<26>-Footnote-182651601
Ref: Core and Builtins<26>-Footnote-192651645
Ref: Core and Builtins<26>-Footnote-202651689
Ref: Core and Builtins<26>-Footnote-212651733
Ref: Core and Builtins<26>-Footnote-222651777
Node: Library<28>2651821
Ref: whatsnew/changelog id2282651957
Ref: 102c2651957
Ref: Library<28>-Footnote-12657959
Ref: Library<28>-Footnote-22658002
Ref: Library<28>-Footnote-32658045
Ref: Library<28>-Footnote-42658088
Ref: Library<28>-Footnote-52658131
Ref: Library<28>-Footnote-62658174
Ref: Library<28>-Footnote-72658217
Ref: Library<28>-Footnote-82658260
Ref: Library<28>-Footnote-92658303
Ref: Library<28>-Footnote-102658346
Ref: Library<28>-Footnote-112658390
Ref: Library<28>-Footnote-122658434
Ref: Library<28>-Footnote-132658478
Ref: Library<28>-Footnote-142658522
Ref: Library<28>-Footnote-152658566
Ref: Library<28>-Footnote-162658609
Ref: Library<28>-Footnote-172658653
Ref: Library<28>-Footnote-182658697
Ref: Library<28>-Footnote-192658747
Ref: Library<28>-Footnote-202658791
Ref: Library<28>-Footnote-212658835
Ref: Library<28>-Footnote-222658879
Ref: Library<28>-Footnote-232658923
Ref: Library<28>-Footnote-242658967
Ref: Library<28>-Footnote-252659011
Ref: Library<28>-Footnote-262659055
Ref: Library<28>-Footnote-272659099
Ref: Library<28>-Footnote-282659143
Ref: Library<28>-Footnote-292659187
Ref: Library<28>-Footnote-302659231
Ref: Library<28>-Footnote-312659275
Ref: Library<28>-Footnote-322659319
Ref: Library<28>-Footnote-332659363
Ref: Library<28>-Footnote-342659407
Ref: Library<28>-Footnote-352659451
Ref: Library<28>-Footnote-362659495
Ref: Library<28>-Footnote-372659539
Ref: Library<28>-Footnote-382659583
Ref: Library<28>-Footnote-392659627
Ref: Library<28>-Footnote-402659671
Ref: Library<28>-Footnote-412659715
Ref: Library<28>-Footnote-422659759
Node: Documentation<26>2659803
Ref: whatsnew/changelog id2292659927
Ref: 102d2659927
Ref: Documentation<26>-Footnote-12660350
Ref: Documentation<26>-Footnote-22660393
Ref: Documentation<26>-Footnote-32660436
Node: Tests<25>2660479
Ref: whatsnew/changelog id2302660601
Ref: 102e2660601
Ref: Tests<25>-Footnote-12661306
Ref: Tests<25>-Footnote-22661349
Ref: Tests<25>-Footnote-32661392
Ref: Tests<25>-Footnote-42661435
Node: Build<24>2661478
Ref: whatsnew/changelog id2312661594
Ref: 102f2661594
Ref: Build<24>-Footnote-12661769
Node: Windows<24>2661812
Ref: whatsnew/changelog id2322661927
Ref: 10302661927
Ref: Windows<24>-Footnote-12662435
Ref: Windows<24>-Footnote-22662478
Ref: Windows<24>-Footnote-32662521
Ref: Windows<24>-Footnote-42662564
Node: IDLE<26>2662607
Ref: whatsnew/changelog id2332662728
Ref: 10312662728
Ref: IDLE<26>-Footnote-12671577
Ref: IDLE<26>-Footnote-22671620
Ref: IDLE<26>-Footnote-32671663
Ref: IDLE<26>-Footnote-42671706
Ref: IDLE<26>-Footnote-52671749
Ref: IDLE<26>-Footnote-62671792
Ref: IDLE<26>-Footnote-72671835
Ref: IDLE<26>-Footnote-82671878
Ref: IDLE<26>-Footnote-92671921
Ref: IDLE<26>-Footnote-102671964
Ref: IDLE<26>-Footnote-112672008
Ref: IDLE<26>-Footnote-122672052
Ref: IDLE<26>-Footnote-132672096
Ref: IDLE<26>-Footnote-142672140
Ref: IDLE<26>-Footnote-152672184
Ref: IDLE<26>-Footnote-162672228
Ref: IDLE<26>-Footnote-172672272
Ref: IDLE<26>-Footnote-182672316
Ref: IDLE<26>-Footnote-192672360
Ref: IDLE<26>-Footnote-202672404
Ref: IDLE<26>-Footnote-212672448
Ref: IDLE<26>-Footnote-222672492
Ref: IDLE<26>-Footnote-232672536
Ref: IDLE<26>-Footnote-242672580
Ref: IDLE<26>-Footnote-252672624
Ref: IDLE<26>-Footnote-262672668
Ref: IDLE<26>-Footnote-272672712
Ref: IDLE<26>-Footnote-282672756
Ref: IDLE<26>-Footnote-292672800
Ref: IDLE<26>-Footnote-302672844
Ref: IDLE<26>-Footnote-312672888
Ref: IDLE<26>-Footnote-322672932
Ref: IDLE<26>-Footnote-332672976
Ref: IDLE<26>-Footnote-342673020
Ref: IDLE<26>-Footnote-352673063
Ref: IDLE<26>-Footnote-362673107
Ref: IDLE<26>-Footnote-372673151
Ref: IDLE<26>-Footnote-382673195
Ref: IDLE<26>-Footnote-392673239
Ref: IDLE<26>-Footnote-402673283
Ref: IDLE<26>-Footnote-412673327
Ref: IDLE<26>-Footnote-422673371
Ref: IDLE<26>-Footnote-432673415
Node: Tools/Demos<18>2673458
Ref: whatsnew/changelog id2342673559
Ref: 10322673559
Ref: Tools/Demos<18>-Footnote-12674121
Ref: Tools/Demos<18>-Footnote-22674164
Node: Python 3 6 2 final2674213
Ref: whatsnew/changelog python-3-6-2-final2674359
Ref: 10332674359
Node: Python 3 6 2 release candidate 22674480
Ref: whatsnew/changelog python-3-6-2-release-candidate-22674626
Ref: 10342674626
Node: Security<15>2674773
Ref: whatsnew/changelog id2352674854
Ref: 10352674854
Ref: Security<15>-Footnote-12675961
Ref: Security<15>-Footnote-22676004
Ref: Security<15>-Footnote-32676047
Node: Python 3 6 2 release candidate 12676090
Ref: whatsnew/changelog python-3-6-2-release-candidate-12676236
Ref: 10362676236
Node: Core and Builtins<27>2676645
Ref: whatsnew/changelog id2362676755
Ref: 10372676755
Ref: Core and Builtins<27>-Footnote-12678756
Ref: Core and Builtins<27>-Footnote-22678799
Ref: Core and Builtins<27>-Footnote-32678842
Ref: Core and Builtins<27>-Footnote-42678885
Ref: Core and Builtins<27>-Footnote-52678928
Ref: Core and Builtins<27>-Footnote-62678971
Ref: Core and Builtins<27>-Footnote-72679014
Ref: Core and Builtins<27>-Footnote-82679057
Ref: Core and Builtins<27>-Footnote-92679100
Ref: Core and Builtins<27>-Footnote-102679143
Ref: Core and Builtins<27>-Footnote-112679187
Ref: Core and Builtins<27>-Footnote-122679231
Ref: Core and Builtins<27>-Footnote-132679275
Ref: Core and Builtins<27>-Footnote-142679319
Ref: Core and Builtins<27>-Footnote-152679363
Node: Library<29>2679407
Ref: whatsnew/changelog id2372679538
Ref: 10382679538
Ref: Library<29>-Footnote-12680672
Ref: Library<29>-Footnote-22680715
Ref: Library<29>-Footnote-32680758
Ref: Library<29>-Footnote-42680801
Ref: Library<29>-Footnote-52680844
Ref: Library<29>-Footnote-62680887
Ref: Library<29>-Footnote-72680930
Ref: Library<29>-Footnote-82680973
Node: Security<16>2681016
Ref: whatsnew/changelog id2382681137
Ref: 10392681137
Ref: Security<16>-Footnote-12681404
Node: Library<30>2681447
Ref: whatsnew/changelog id2392681565
Ref: 103a2681565
Ref: Library<30>-Footnote-12688926
Ref: Library<30>-Footnote-22688969
Ref: Library<30>-Footnote-32689012
Ref: Library<30>-Footnote-42689055
Ref: Library<30>-Footnote-52689098
Ref: Library<30>-Footnote-62689141
Ref: Library<30>-Footnote-72689184
Ref: Library<30>-Footnote-82689227
Ref: Library<30>-Footnote-92689270
Ref: Library<30>-Footnote-102689313
Ref: Library<30>-Footnote-112689357
Ref: Library<30>-Footnote-122689401
Ref: Library<30>-Footnote-132689445
Ref: Library<30>-Footnote-142689489
Ref: Library<30>-Footnote-152689533
Ref: Library<30>-Footnote-162689577
Ref: Library<30>-Footnote-172689621
Ref: Library<30>-Footnote-182689665
Ref: Library<30>-Footnote-192689709
Ref: Library<30>-Footnote-202689753
Ref: Library<30>-Footnote-212689797
Ref: Library<30>-Footnote-222689841
Ref: Library<30>-Footnote-232689885
Ref: Library<30>-Footnote-242689929
Ref: Library<30>-Footnote-252689973
Ref: Library<30>-Footnote-262690017
Ref: Library<30>-Footnote-272690061
Ref: Library<30>-Footnote-282690105
Ref: Library<30>-Footnote-292690149
Ref: Library<30>-Footnote-302690193
Ref: Library<30>-Footnote-312690237
Ref: Library<30>-Footnote-322690281
Ref: Library<30>-Footnote-332690325
Ref: Library<30>-Footnote-342690369
Ref: Library<30>-Footnote-352690413
Ref: Library<30>-Footnote-362690457
Ref: Library<30>-Footnote-372690501
Ref: Library<30>-Footnote-382690545
Ref: Library<30>-Footnote-392690589
Ref: Library<30>-Footnote-402690633
Ref: Library<30>-Footnote-412690677
Ref: Library<30>-Footnote-422690721
Ref: Library<30>-Footnote-432690765
Ref: Library<30>-Footnote-442690809
Ref: Library<30>-Footnote-452690853
Ref: Library<30>-Footnote-462690897
Ref: Library<30>-Footnote-472690941
Ref: Library<30>-Footnote-482690984
Ref: Library<30>-Footnote-492691028
Ref: Library<30>-Footnote-502691072
Ref: Library<30>-Footnote-512691116
Ref: Library<30>-Footnote-522691160
Node: IDLE<27>2691204
Ref: whatsnew/changelog id2402691319
Ref: 103b2691319
Ref: IDLE<27>-Footnote-12692324
Ref: IDLE<27>-Footnote-22692367
Ref: IDLE<27>-Footnote-32692410
Ref: IDLE<27>-Footnote-42692453
Ref: IDLE<27>-Footnote-52692496
Ref: IDLE<27>-Footnote-62692539
Node: C API<20>2692582
Ref: whatsnew/changelog id2412692695
Ref: 103c2692695
Ref: C API<20>-Footnote-12692883
Node: Build<25>2692926
Ref: whatsnew/changelog id2422693048
Ref: 103d2693048
Ref: Build<25>-Footnote-12693857
Ref: Build<25>-Footnote-22693900
Ref: Build<25>-Footnote-32693943
Ref: Build<25>-Footnote-42693986
Ref: Build<25>-Footnote-52694029
Node: Documentation<27>2694072
Ref: whatsnew/changelog id2432694200
Ref: 103e2694200
Ref: Documentation<27>-Footnote-12694927
Ref: Documentation<27>-Footnote-22694970
Ref: Documentation<27>-Footnote-32695013
Node: Tools/Demos<19>2695056
Ref: whatsnew/changelog id2442695184
Ref: 103f2695184
Ref: Tools/Demos<19>-Footnote-12695374
Node: Tests<26>2695417
Ref: whatsnew/changelog id2452695539
Ref: 10402695539
Ref: Tests<26>-Footnote-12696202
Ref: Tests<26>-Footnote-22696245
Node: Windows<25>2696288
Ref: whatsnew/changelog id2462696386
Ref: 10412696386
Ref: Windows<25>-Footnote-12696830
Ref: Windows<25>-Footnote-22696873
Node: Python 3 6 1 final2696916
Ref: whatsnew/changelog python-3-6-1-final2697062
Ref: 10422697062
Node: Core and Builtins<28>2697219
Ref: whatsnew/changelog id2472697313
Ref: 10432697313
Ref: Core and Builtins<28>-Footnote-12697932
Ref: Core and Builtins<28>-Footnote-22697975
Node: Build<26>2698018
Ref: whatsnew/changelog id2482698112
Ref: 10442698112
Ref: Build<26>-Footnote-12698294
Node: Python 3 6 1 release candidate 12698337
Ref: whatsnew/changelog python-3-6-1-release-candidate-12698469
Ref: 10452698469
Node: Core and Builtins<29>2698796
Ref: whatsnew/changelog id2492698906
Ref: 10462698906
Ref: Core and Builtins<29>-Footnote-12701738
Ref: Core and Builtins<29>-Footnote-22701781
Ref: Core and Builtins<29>-Footnote-32701824
Ref: Core and Builtins<29>-Footnote-42701867
Ref: Core and Builtins<29>-Footnote-52701910
Ref: Core and Builtins<29>-Footnote-62701953
Ref: Core and Builtins<29>-Footnote-72701996
Ref: Core and Builtins<29>-Footnote-82702039
Ref: Core and Builtins<29>-Footnote-92702082
Ref: Core and Builtins<29>-Footnote-102702125
Ref: Core and Builtins<29>-Footnote-112702169
Ref: Core and Builtins<29>-Footnote-122702213
Ref: Core and Builtins<29>-Footnote-132702257
Ref: Core and Builtins<29>-Footnote-142702301
Ref: Core and Builtins<29>-Footnote-152702345
Ref: Core and Builtins<29>-Footnote-162702389
Ref: Core and Builtins<29>-Footnote-172702433
Ref: Core and Builtins<29>-Footnote-182702477
Ref: Core and Builtins<29>-Footnote-192702521
Ref: Core and Builtins<29>-Footnote-202702565
Ref: Core and Builtins<29>-Footnote-212702609
Ref: Core and Builtins<29>-Footnote-222702653
Node: Library<31>2702697
Ref: whatsnew/changelog id2502702824
Ref: 10472702824
Ref: Library<31>-Footnote-12708471
Ref: Library<31>-Footnote-22708514
Ref: Library<31>-Footnote-32708557
Ref: Library<31>-Footnote-42708600
Ref: Library<31>-Footnote-52708643
Ref: Library<31>-Footnote-62708686
Ref: Library<31>-Footnote-72708729
Ref: Library<31>-Footnote-82708772
Ref: Library<31>-Footnote-92708815
Ref: Library<31>-Footnote-102708858
Ref: Library<31>-Footnote-112708902
Ref: Library<31>-Footnote-122708946
Ref: Library<31>-Footnote-132708990
Ref: Library<31>-Footnote-142709034
Ref: Library<31>-Footnote-152709078
Ref: Library<31>-Footnote-162709122
Ref: Library<31>-Footnote-172709166
Ref: Library<31>-Footnote-182709210
Ref: Library<31>-Footnote-192709254
Ref: Library<31>-Footnote-202709298
Ref: Library<31>-Footnote-212709342
Ref: Library<31>-Footnote-222709386
Ref: Library<31>-Footnote-232709430
Ref: Library<31>-Footnote-242709474
Ref: Library<31>-Footnote-252709518
Ref: Library<31>-Footnote-262709562
Ref: Library<31>-Footnote-272709606
Ref: Library<31>-Footnote-282709656
Ref: Library<31>-Footnote-292709700
Ref: Library<31>-Footnote-302709744
Ref: Library<31>-Footnote-312709788
Ref: Library<31>-Footnote-322709832
Ref: Library<31>-Footnote-332709876
Ref: Library<31>-Footnote-342709920
Ref: Library<31>-Footnote-352709964
Ref: Library<31>-Footnote-362710007
Ref: Library<31>-Footnote-372710051
Ref: Library<31>-Footnote-382710095
Ref: Library<31>-Footnote-392710139
Ref: Library<31>-Footnote-402710183
Ref: Library<31>-Footnote-412710227
Ref: Library<31>-Footnote-422710271
Ref: Library<31>-Footnote-432710315
Ref: Library<31>-Footnote-442710359
Node: IDLE<28>2710403
Ref: whatsnew/changelog id2512710520
Ref: 10482710520
Ref: IDLE<28>-Footnote-12710809
Ref: IDLE<28>-Footnote-22710852
Node: Windows<26>2710895
Ref: whatsnew/changelog id2522711010
Ref: 10492711010
Ref: Windows<26>-Footnote-12711657
Ref: Windows<26>-Footnote-22711700
Ref: Windows<26>-Footnote-32711743
Ref: Windows<26>-Footnote-42711786
Ref: Windows<26>-Footnote-52711829
Ref: Windows<26>-Footnote-62711878
Ref: Windows<26>-Footnote-72711921
Ref: Windows<26>-Footnote-82711964
Node: C API<21>2712007
Ref: whatsnew/changelog id2532712131
Ref: 104a2712131
Ref: C API<21>-Footnote-12712957
Ref: C API<21>-Footnote-22713000
Ref: C API<21>-Footnote-32713043
Node: Documentation<28>2713086
Ref: whatsnew/changelog id2542713208
Ref: 104b2713208
Ref: Documentation<28>-Footnote-12713745
Ref: Documentation<28>-Footnote-22713788
Ref: Documentation<28>-Footnote-32713831
Ref: Documentation<28>-Footnote-42713874
Node: Tests<27>2713917
Ref: whatsnew/changelog id2552714039
Ref: 104c2714039
Ref: Tests<27>-Footnote-12715024
Ref: Tests<27>-Footnote-22715067
Ref: Tests<27>-Footnote-32715110
Ref: Tests<27>-Footnote-42715153
Ref: Tests<27>-Footnote-52715196
Node: Build<27>2715239
Ref: whatsnew/changelog id2562715335
Ref: 104d2715335
Ref: Build<27>-Footnote-12716596
Ref: Build<27>-Footnote-22716639
Ref: Build<27>-Footnote-32716682
Ref: Build<27>-Footnote-42716725
Ref: Build<27>-Footnote-52716768
Ref: Build<27>-Footnote-62716811
Ref: Build<27>-Footnote-72716854
Ref: Build<27>-Footnote-82716897
Ref: Build<27>-Footnote-92716940
Ref: Build<27>-Footnote-102716983
Node: Python 3 6 0 final2717027
Ref: whatsnew/changelog python-3-6-0-final2717173
Ref: 104e2717173
Node: Python 3 6 0 release candidate 22717294
Ref: whatsnew/changelog python-3-6-0-release-candidate-22717440
Ref: 104f2717440
Node: Core and Builtins<30>2717681
Ref: whatsnew/changelog id2572717795
Ref: 10502717795
Ref: Core and Builtins<30>-Footnote-12718180
Ref: Core and Builtins<30>-Footnote-22718223
Node: Tools/Demos<20>2718266
Ref: whatsnew/changelog id2582718400
Ref: 10512718400
Ref: Tools/Demos<20>-Footnote-12718534
Node: Windows<27>2718577
Ref: whatsnew/changelog id2592718699
Ref: 10522718699
Ref: Windows<27>-Footnote-12718825
Node: Build<28>2718868
Ref: whatsnew/changelog id2602718966
Ref: 10532718966
Ref: Build<28>-Footnote-12719121
Node: Python 3 6 0 release candidate 12719164
Ref: whatsnew/changelog python-3-6-0-release-candidate-12719311
Ref: 10542719311
Node: Core and Builtins<31>2719588
Ref: whatsnew/changelog id2612719698
Ref: 10552719698
Ref: Core and Builtins<31>-Footnote-12720507
Ref: Core and Builtins<31>-Footnote-22720550
Ref: Core and Builtins<31>-Footnote-32720593
Ref: Core and Builtins<31>-Footnote-42720636
Node: Library<32>2720679
Ref: whatsnew/changelog id2622720807
Ref: 10562720807
Ref: Library<32>-Footnote-12721846
Ref: Library<32>-Footnote-22721889
Ref: Library<32>-Footnote-32721932
Ref: Library<32>-Footnote-42721975
Ref: Library<32>-Footnote-52722018
Ref: Library<32>-Footnote-62722061
Node: C API<22>2722104
Ref: whatsnew/changelog id2632722228
Ref: 10572722228
Ref: C API<22>-Footnote-12722386
Node: Documentation<29>2722429
Ref: whatsnew/changelog id2642722557
Ref: 10582722557
Ref: Documentation<29>-Footnote-12722897
Ref: Documentation<29>-Footnote-22722940
Node: Tools/Demos<21>2722989
Ref: whatsnew/changelog id2652723099
Ref: 10592723099
Ref: Tools/Demos<21>-Footnote-12723265
Node: Python 3 6 0 beta 42723308
Ref: whatsnew/changelog python-3-6-0-beta-42723442
Ref: 105a2723442
Node: Core and Builtins<32>2723681
Ref: whatsnew/changelog id2662723778
Ref: 105b2723778
Ref: Core and Builtins<32>-Footnote-12725330
Ref: Core and Builtins<32>-Footnote-22725373
Ref: Core and Builtins<32>-Footnote-32725416
Ref: Core and Builtins<32>-Footnote-42725459
Ref: Core and Builtins<32>-Footnote-52725502
Ref: Core and Builtins<32>-Footnote-62725545
Ref: Core and Builtins<32>-Footnote-72725588
Ref: Core and Builtins<32>-Footnote-82725631
Ref: Core and Builtins<32>-Footnote-92725674
Ref: Core and Builtins<32>-Footnote-102725717
Ref: Core and Builtins<32>-Footnote-112725761
Node: Library<33>2725805
Ref: whatsnew/changelog id2672725928
Ref: 105c2725928
Ref: Library<33>-Footnote-12727930
Ref: Library<33>-Footnote-22727973
Ref: Library<33>-Footnote-32728016
Ref: Library<33>-Footnote-42728059
Ref: Library<33>-Footnote-52728102
Ref: Library<33>-Footnote-62728145
Ref: Library<33>-Footnote-72728188
Ref: Library<33>-Footnote-82728231
Ref: Library<33>-Footnote-92728274
Ref: Library<33>-Footnote-102728317
Ref: Library<33>-Footnote-112728361
Ref: Library<33>-Footnote-122728405
Ref: Library<33>-Footnote-132728449
Ref: Library<33>-Footnote-142728493
Ref: Library<33>-Footnote-152728537
Ref: Library<33>-Footnote-162728581
Ref: Library<33>-Footnote-172728625
Ref: Library<33>-Footnote-182728669
Node: Documentation<30>2728713
Ref: whatsnew/changelog id2682728824
Ref: 105d2728824
Ref: Documentation<30>-Footnote-12728975
Node: Tests<28>2729018
Ref: whatsnew/changelog id2692729127
Ref: 105e2729127
Ref: Tests<28>-Footnote-12729389
Ref: Tests<28>-Footnote-22729432
Node: Build<29>2729475
Ref: whatsnew/changelog id2702729558
Ref: 105f2729558
Ref: Build<29>-Footnote-12729921
Ref: Build<29>-Footnote-22729964
Ref: Build<29>-Footnote-32730007
Node: Python 3 6 0 beta 32730050
Ref: whatsnew/changelog python-3-6-0-beta-32730171
Ref: 10602730171
Node: Core and Builtins<33>2730398
Ref: whatsnew/changelog id2712730495
Ref: 10612730495
Ref: Core and Builtins<33>-Footnote-12731402
Ref: Core and Builtins<33>-Footnote-22731445
Ref: Core and Builtins<33>-Footnote-32731488
Ref: Core and Builtins<33>-Footnote-42731531
Ref: Core and Builtins<33>-Footnote-52731574
Ref: Core and Builtins<33>-Footnote-62731617
Ref: Core and Builtins<33>-Footnote-72731660
Node: Library<34>2731703
Ref: whatsnew/changelog id2722731820
Ref: 10622731820
Ref: Library<34>-Footnote-12734867
Ref: Library<34>-Footnote-22734910
Ref: Library<34>-Footnote-32734953
Ref: Library<34>-Footnote-42734996
Ref: Library<34>-Footnote-52735039
Ref: Library<34>-Footnote-62735082
Ref: Library<34>-Footnote-72735125
Ref: Library<34>-Footnote-82735168
Ref: Library<34>-Footnote-92735211
Ref: Library<34>-Footnote-102735254
Ref: Library<34>-Footnote-112735298
Ref: Library<34>-Footnote-122735342
Ref: Library<34>-Footnote-132735386
Ref: Library<34>-Footnote-142735430
Ref: Library<34>-Footnote-152735474
Ref: Library<34>-Footnote-162735518
Ref: Library<34>-Footnote-172735562
Ref: Library<34>-Footnote-182735606
Ref: Library<34>-Footnote-192735650
Ref: Library<34>-Footnote-202735694
Ref: Library<34>-Footnote-212735738
Ref: Library<34>-Footnote-222735782
Ref: Library<34>-Footnote-232735826
Ref: Library<34>-Footnote-242735870
Node: Windows<28>2735914
Ref: whatsnew/changelog id2732736019
Ref: 10632736019
Ref: Windows<28>-Footnote-12736163
Node: Build<30>2736206
Ref: whatsnew/changelog id2742736309
Ref: 10642736309
Ref: Build<30>-Footnote-12736628
Ref: Build<30>-Footnote-22736671
Ref: Build<30>-Footnote-32736714
Node: Tests<29>2736757
Ref: whatsnew/changelog id2752736840
Ref: 10652736840
Ref: Tests<29>-Footnote-12737099
Ref: Tests<29>-Footnote-22737142
Node: Python 3 6 0 beta 22737185
Ref: whatsnew/changelog python-3-6-0-beta-22737306
Ref: 10662737306
Node: Core and Builtins<34>2737553
Ref: whatsnew/changelog id2762737650
Ref: 10672737650
Ref: Core and Builtins<34>-Footnote-12740394
Ref: Core and Builtins<34>-Footnote-22740437
Ref: Core and Builtins<34>-Footnote-32740480
Ref: Core and Builtins<34>-Footnote-42740523
Ref: Core and Builtins<34>-Footnote-52740566
Ref: Core and Builtins<34>-Footnote-62740609
Ref: Core and Builtins<34>-Footnote-72740652
Ref: Core and Builtins<34>-Footnote-82740695
Ref: Core and Builtins<34>-Footnote-92740738
Ref: Core and Builtins<34>-Footnote-102740781
Ref: Core and Builtins<34>-Footnote-112740825
Ref: Core and Builtins<34>-Footnote-122740869
Ref: Core and Builtins<34>-Footnote-132740913
Ref: Core and Builtins<34>-Footnote-142740957
Ref: Core and Builtins<34>-Footnote-152741001
Ref: Core and Builtins<34>-Footnote-162741045
Ref: Core and Builtins<34>-Footnote-172741089
Ref: Core and Builtins<34>-Footnote-182741133
Ref: Core and Builtins<34>-Footnote-192741177
Ref: Core and Builtins<34>-Footnote-202741221
Ref: Core and Builtins<34>-Footnote-212741265
Ref: Core and Builtins<34>-Footnote-222741309
Ref: Core and Builtins<34>-Footnote-232741353
Node: Library<35>2741397
Ref: whatsnew/changelog id2772741514
Ref: 10682741514
Ref: Library<35>-Footnote-12747304
Ref: Library<35>-Footnote-22747347
Ref: Library<35>-Footnote-32747390
Ref: Library<35>-Footnote-42747433
Ref: Library<35>-Footnote-52747476
Ref: Library<35>-Footnote-62747519
Ref: Library<35>-Footnote-72747562
Ref: Library<35>-Footnote-82747605
Ref: Library<35>-Footnote-92747648
Ref: Library<35>-Footnote-102747691
Ref: Library<35>-Footnote-112747735
Ref: Library<35>-Footnote-122747779
Ref: Library<35>-Footnote-132747823
Ref: Library<35>-Footnote-142747867
Ref: Library<35>-Footnote-152747911
Ref: Library<35>-Footnote-162747955
Ref: Library<35>-Footnote-172747999
Ref: Library<35>-Footnote-182748043
Ref: Library<35>-Footnote-192748087
Ref: Library<35>-Footnote-202748131
Ref: Library<35>-Footnote-212748175
Ref: Library<35>-Footnote-222748219
Ref: Library<35>-Footnote-232748263
Ref: Library<35>-Footnote-242748307
Ref: Library<35>-Footnote-252748351
Ref: Library<35>-Footnote-262748395
Ref: Library<35>-Footnote-272748439
Ref: Library<35>-Footnote-282748483
Ref: Library<35>-Footnote-292748527
Ref: Library<35>-Footnote-302748571
Ref: Library<35>-Footnote-312748615
Ref: Library<35>-Footnote-322748659
Ref: Library<35>-Footnote-332748703
Ref: Library<35>-Footnote-342748747
Ref: Library<35>-Footnote-352748791
Ref: Library<35>-Footnote-362748835
Ref: Library<35>-Footnote-372748879
Ref: Library<35>-Footnote-382748923
Ref: Library<35>-Footnote-392748967
Ref: Library<35>-Footnote-402749011
Ref: Library<35>-Footnote-412749055
Ref: Library<35>-Footnote-422749099
Ref: Library<35>-Footnote-432749143
Ref: Library<35>-Footnote-442749187
Ref: Library<35>-Footnote-452749231
Ref: Library<35>-Footnote-462749275
Ref: Library<35>-Footnote-472749319
Ref: Library<35>-Footnote-482749363
Node: Windows<29>2749407
Ref: whatsnew/changelog id2782749512
Ref: 10692749512
Ref: Windows<29>-Footnote-12750323
Ref: Windows<29>-Footnote-22750366
Ref: Windows<29>-Footnote-32750409
Ref: Windows<29>-Footnote-42750452
Ref: Windows<29>-Footnote-52750495
Ref: Windows<29>-Footnote-62750538
Ref: Windows<29>-Footnote-72750581
Ref: Windows<29>-Footnote-82750624
Ref: Windows<29>-Footnote-92750667
Ref: Windows<29>-Footnote-102750710
Node: C API<23>2750754
Ref: whatsnew/changelog id2792750857
Ref: 106a2750857
Ref: C API<23>-Footnote-12751111
Node: Build<31>2751154
Ref: whatsnew/changelog id2802751255
Ref: 106b2751255
Ref: Build<31>-Footnote-12751681
Ref: Build<31>-Footnote-22751724
Ref: Build<31>-Footnote-32751767
Node: Tests<30>2751810
Ref: whatsnew/changelog id2812751893
Ref: 106c2751893
Ref: Tests<30>-Footnote-12752030
Node: Python 3 6 0 beta 12752073
Ref: whatsnew/changelog python-3-6-0-beta-12752195
Ref: 106d2752195
Node: Core and Builtins<35>2752492
Ref: whatsnew/changelog id2822752589
Ref: 106e2752589
Ref: Core and Builtins<35>-Footnote-12758794
Ref: Core and Builtins<35>-Footnote-22758837
Ref: Core and Builtins<35>-Footnote-32758880
Ref: Core and Builtins<35>-Footnote-42758923
Ref: Core and Builtins<35>-Footnote-52758972
Ref: Core and Builtins<35>-Footnote-62759015
Ref: Core and Builtins<35>-Footnote-72759058
Ref: Core and Builtins<35>-Footnote-82759101
Ref: Core and Builtins<35>-Footnote-92759144
Ref: Core and Builtins<35>-Footnote-102759187
Ref: Core and Builtins<35>-Footnote-112759231
Ref: Core and Builtins<35>-Footnote-122759275
Ref: Core and Builtins<35>-Footnote-132759319
Ref: Core and Builtins<35>-Footnote-142759369
Ref: Core and Builtins<35>-Footnote-152759413
Ref: Core and Builtins<35>-Footnote-162759457
Ref: Core and Builtins<35>-Footnote-172759507
Ref: Core and Builtins<35>-Footnote-182759551
Ref: Core and Builtins<35>-Footnote-192759601
Ref: Core and Builtins<35>-Footnote-202759645
Ref: Core and Builtins<35>-Footnote-212759689
Ref: Core and Builtins<35>-Footnote-222759733
Ref: Core and Builtins<35>-Footnote-232759777
Ref: Core and Builtins<35>-Footnote-242759821
Ref: Core and Builtins<35>-Footnote-252759865
Ref: Core and Builtins<35>-Footnote-262759909
Ref: Core and Builtins<35>-Footnote-272759953
Ref: Core and Builtins<35>-Footnote-282760003
Ref: Core and Builtins<35>-Footnote-292760047
Ref: Core and Builtins<35>-Footnote-302760091
Ref: Core and Builtins<35>-Footnote-312760135
Ref: Core and Builtins<35>-Footnote-322760179
Ref: Core and Builtins<35>-Footnote-332760223
Ref: Core and Builtins<35>-Footnote-342760267
Ref: Core and Builtins<35>-Footnote-352760311
Ref: Core and Builtins<35>-Footnote-362760355
Ref: Core and Builtins<35>-Footnote-372760399
Ref: Core and Builtins<35>-Footnote-382760443
Ref: Core and Builtins<35>-Footnote-392760487
Ref: Core and Builtins<35>-Footnote-402760531
Ref: Core and Builtins<35>-Footnote-412760575
Ref: Core and Builtins<35>-Footnote-422760619
Ref: Core and Builtins<35>-Footnote-432760663
Ref: Core and Builtins<35>-Footnote-442760707
Ref: Core and Builtins<35>-Footnote-452760751
Ref: Core and Builtins<35>-Footnote-462760795
Ref: Core and Builtins<35>-Footnote-472760845
Node: Library<36>2760889
Ref: whatsnew/changelog id2832761003
Ref: 106f2761003
Ref: Library<36>-Footnote-12771990
Ref: Library<36>-Footnote-22772033
Ref: Library<36>-Footnote-32772076
Ref: Library<36>-Footnote-42772119
Ref: Library<36>-Footnote-52772162
Ref: Library<36>-Footnote-62772205
Ref: Library<36>-Footnote-72772248
Ref: Library<36>-Footnote-82772291
Ref: Library<36>-Footnote-92772334
Ref: Library<36>-Footnote-102772377
Ref: Library<36>-Footnote-112772421
Ref: Library<36>-Footnote-122772465
Ref: Library<36>-Footnote-132772509
Ref: Library<36>-Footnote-142772553
Ref: Library<36>-Footnote-152772597
Ref: Library<36>-Footnote-162772641
Ref: Library<36>-Footnote-172772685
Ref: Library<36>-Footnote-182772731
Ref: Library<36>-Footnote-192772775
Ref: Library<36>-Footnote-202772819
Ref: Library<36>-Footnote-212772863
Ref: Library<36>-Footnote-222772907
Ref: Library<36>-Footnote-232772951
Ref: Library<36>-Footnote-242772995
Ref: Library<36>-Footnote-252773039
Ref: Library<36>-Footnote-262773084
Ref: Library<36>-Footnote-272773128
Ref: Library<36>-Footnote-282773172
Ref: Library<36>-Footnote-292773216
Ref: Library<36>-Footnote-302773260
Ref: Library<36>-Footnote-312773304
Ref: Library<36>-Footnote-322773348
Ref: Library<36>-Footnote-332773392
Ref: Library<36>-Footnote-342773436
Ref: Library<36>-Footnote-352773480
Ref: Library<36>-Footnote-362773524
Ref: Library<36>-Footnote-372773568
Ref: Library<36>-Footnote-382773612
Ref: Library<36>-Footnote-392773656
Ref: Library<36>-Footnote-402773700
Ref: Library<36>-Footnote-412773744
Ref: Library<36>-Footnote-422773788
Ref: Library<36>-Footnote-432773838
Ref: Library<36>-Footnote-442773882
Ref: Library<36>-Footnote-452773932
Ref: Library<36>-Footnote-462773976
Ref: Library<36>-Footnote-472774020
Ref: Library<36>-Footnote-482774064
Ref: Library<36>-Footnote-492774108
Ref: Library<36>-Footnote-502774152
Ref: Library<36>-Footnote-512774196
Ref: Library<36>-Footnote-522774240
Ref: Library<36>-Footnote-532774284
Ref: Library<36>-Footnote-542774328
Ref: Library<36>-Footnote-552774372
Ref: Library<36>-Footnote-562774416
Ref: Library<36>-Footnote-572774460
Ref: Library<36>-Footnote-582774504
Ref: Library<36>-Footnote-592774548
Ref: Library<36>-Footnote-602774592
Ref: Library<36>-Footnote-612774636
Ref: Library<36>-Footnote-622774680
Ref: Library<36>-Footnote-632774724
Ref: Library<36>-Footnote-642774768
Ref: Library<36>-Footnote-652774812
Ref: Library<36>-Footnote-662774856
Ref: Library<36>-Footnote-672774900
Ref: Library<36>-Footnote-682774944
Ref: Library<36>-Footnote-692774988
Ref: Library<36>-Footnote-702775032
Ref: Library<36>-Footnote-712775076
Ref: Library<36>-Footnote-722775120
Ref: Library<36>-Footnote-732775164
Ref: Library<36>-Footnote-742775208
Ref: Library<36>-Footnote-752775252
Ref: Library<36>-Footnote-762775295
Ref: Library<36>-Footnote-772775338
Ref: Library<36>-Footnote-782775382
Ref: Library<36>-Footnote-792775426
Ref: Library<36>-Footnote-802775469
Ref: Library<36>-Footnote-812775513
Node: IDLE<29>2775557
Ref: whatsnew/changelog id2842775659
Ref: 10702775659
Ref: IDLE<29>-Footnote-12776425
Ref: IDLE<29>-Footnote-22776468
Ref: IDLE<29>-Footnote-32776511
Ref: IDLE<29>-Footnote-42776554
Ref: IDLE<29>-Footnote-52776597
Ref: IDLE<29>-Footnote-62776640
Node: C API<24>2776683
Ref: whatsnew/changelog id2852776783
Ref: 10712776783
Ref: C API<24>-Footnote-12777055
Ref: C API<24>-Footnote-22777098
Node: Tests<31>2777141
Ref: whatsnew/changelog id2862777242
Ref: 10722777242
Ref: Tests<31>-Footnote-12777762
Ref: Tests<31>-Footnote-22777805
Ref: Tests<31>-Footnote-32777848
Ref: Tests<31>-Footnote-42777891
Node: Build<32>2777934
Ref: whatsnew/changelog id2872778041
Ref: 10732778041
Ref: Build<32>-Footnote-12779426
Ref: Build<32>-Footnote-22779469
Ref: Build<32>-Footnote-32779512
Ref: Build<32>-Footnote-42779555
Ref: Build<32>-Footnote-52779598
Ref: Build<32>-Footnote-62779641
Ref: Build<32>-Footnote-72779684
Ref: Build<32>-Footnote-82779727
Ref: Build<32>-Footnote-92779770
Ref: Build<32>-Footnote-102779813
Ref: Build<32>-Footnote-112779857
Node: Tools/Demos<22>2779901
Ref: whatsnew/changelog id2882780010
Ref: 10742780010
Ref: Tools/Demos<22>-Footnote-12780289
Node: Windows<30>2780332
Ref: whatsnew/changelog id2892780423
Ref: 10752780423
Ref: Windows<30>-Footnote-12781392
Ref: Windows<30>-Footnote-22781435
Ref: Windows<30>-Footnote-32781478
Ref: Windows<30>-Footnote-42781520
Ref: Windows<30>-Footnote-52781563
Ref: Windows<30>-Footnote-62781606
Ref: Windows<30>-Footnote-72781648
Ref: Windows<30>-Footnote-82781691
Ref: Windows<30>-Footnote-92781734
Ref: Windows<30>-Footnote-102781777
Ref: Windows<30>-Footnote-112781821
Node: Python 3 6 0 alpha 42781865
Ref: whatsnew/changelog python-3-6-0-alpha-42781988
Ref: 10762781988
Node: Core and Builtins<36>2782235
Ref: whatsnew/changelog id2902782333
Ref: 10772782333
Ref: Core and Builtins<36>-Footnote-12784291
Ref: Core and Builtins<36>-Footnote-22784334
Ref: Core and Builtins<36>-Footnote-32784377
Ref: Core and Builtins<36>-Footnote-42784420
Ref: Core and Builtins<36>-Footnote-52784463
Ref: Core and Builtins<36>-Footnote-62784506
Ref: Core and Builtins<36>-Footnote-72784549
Ref: Core and Builtins<36>-Footnote-82784592
Ref: Core and Builtins<36>-Footnote-92784635
Ref: Core and Builtins<36>-Footnote-102784677
Ref: Core and Builtins<36>-Footnote-112784721
Ref: Core and Builtins<36>-Footnote-122784765
Ref: Core and Builtins<36>-Footnote-132784809
Ref: Core and Builtins<36>-Footnote-142784853
Node: Library<37>2784903
Ref: whatsnew/changelog id2912785018
Ref: 10782785018
Ref: Library<37>-Footnote-12789527
Ref: Library<37>-Footnote-22789570
Ref: Library<37>-Footnote-32789619
Ref: Library<37>-Footnote-42789662
Ref: Library<37>-Footnote-52789705
Ref: Library<37>-Footnote-62789748
Ref: Library<37>-Footnote-72789791
Ref: Library<37>-Footnote-82789834
Ref: Library<37>-Footnote-92789877
Ref: Library<37>-Footnote-102789920
Ref: Library<37>-Footnote-112789964
Ref: Library<37>-Footnote-122790014
Ref: Library<37>-Footnote-132790058
Ref: Library<37>-Footnote-142790102
Ref: Library<37>-Footnote-152790146
Ref: Library<37>-Footnote-162790190
Ref: Library<37>-Footnote-172790233
Ref: Library<37>-Footnote-182790277
Ref: Library<37>-Footnote-192790321
Ref: Library<37>-Footnote-202790365
Ref: Library<37>-Footnote-212790409
Ref: Library<37>-Footnote-222790453
Ref: Library<37>-Footnote-232790497
Ref: Library<37>-Footnote-242790541
Ref: Library<37>-Footnote-252790585
Ref: Library<37>-Footnote-262790629
Ref: Library<37>-Footnote-272790673
Ref: Library<37>-Footnote-282790717
Ref: Library<37>-Footnote-292790760
Ref: Library<37>-Footnote-302790804
Ref: Library<37>-Footnote-312790848
Ref: Library<37>-Footnote-322790892
Ref: Library<37>-Footnote-332790942
Ref: Library<37>-Footnote-342790986
Ref: Library<37>-Footnote-352791029
Ref: Library<37>-Footnote-362791073
Ref: Library<37>-Footnote-372791117
Ref: Library<37>-Footnote-382791161
Node: IDLE<30>2791205
Ref: whatsnew/changelog id2922791308
Ref: 10792791308
Ref: IDLE<30>-Footnote-12792632
Ref: IDLE<30>-Footnote-22792675
Ref: IDLE<30>-Footnote-32792718
Ref: IDLE<30>-Footnote-42792761
Ref: IDLE<30>-Footnote-52792804
Ref: IDLE<30>-Footnote-62792847
Ref: IDLE<30>-Footnote-72792890
Ref: IDLE<30>-Footnote-82792933
Node: Tests<32>2792976
Ref: whatsnew/changelog id2932793079
Ref: 107a2793079
Ref: Tests<32>-Footnote-12793668
Ref: Tests<32>-Footnote-22793711
Ref: Tests<32>-Footnote-32793754
Ref: Tests<32>-Footnote-42793797
Node: Windows<31>2793840
Ref: whatsnew/changelog id2942793944
Ref: 107b2793944
Ref: Windows<31>-Footnote-12794320
Ref: Windows<31>-Footnote-22794363
Ref: Windows<31>-Footnote-32794406
Ref: Windows<31>-Footnote-42794455
Ref: Windows<31>-Footnote-52794498
Node: Build<33>2794541
Ref: whatsnew/changelog id2952794627
Ref: 107c2794627
Ref: Build<33>-Footnote-12795528
Ref: Build<33>-Footnote-22795571
Ref: Build<33>-Footnote-32795614
Ref: Build<33>-Footnote-42795657
Ref: Build<33>-Footnote-52795700
Ref: Build<33>-Footnote-62795743
Node: Python 3 6 0 alpha 32795786
Ref: whatsnew/changelog python-3-6-0-alpha-32795910
Ref: 107d2795910
Node: Core and Builtins<37>2796321
Ref: whatsnew/changelog id2962796419
Ref: 107e2796419
Ref: Core and Builtins<37>-Footnote-12797170
Ref: Core and Builtins<37>-Footnote-22797213
Ref: Core and Builtins<37>-Footnote-32797256
Ref: Core and Builtins<37>-Footnote-42797299
Node: Library<38>2797342
Ref: whatsnew/changelog id2972797461
Ref: 107f2797461
Ref: Library<38>-Footnote-12800975
Ref: Library<38>-Footnote-22801018
Ref: Library<38>-Footnote-32801061
Ref: Library<38>-Footnote-42801104
Ref: Library<38>-Footnote-52801147
Ref: Library<38>-Footnote-62801190
Ref: Library<38>-Footnote-72801233
Ref: Library<38>-Footnote-82801276
Ref: Library<38>-Footnote-92801319
Ref: Library<38>-Footnote-102801362
Ref: Library<38>-Footnote-112801406
Ref: Library<38>-Footnote-122801450
Ref: Library<38>-Footnote-132801494
Ref: Library<38>-Footnote-142801538
Ref: Library<38>-Footnote-152801582
Ref: Library<38>-Footnote-162801626
Ref: Library<38>-Footnote-172801670
Ref: Library<38>-Footnote-182801714
Ref: Library<38>-Footnote-192801758
Ref: Library<38>-Footnote-202801802
Ref: Library<38>-Footnote-212801846
Node: Security<17>2801896
Ref: whatsnew/changelog id2982802005
Ref: 10802802005
Ref: Security<17>-Footnote-12802294
Node: Library<39>2802337
Ref: whatsnew/changelog id2992802447
Ref: 10812802447
Ref: Library<39>-Footnote-12802854
Ref: Library<39>-Footnote-22802897
Ref: Library<39>-Footnote-32802940
Node: Security<18>2802982
Ref: whatsnew/changelog id3002803091
Ref: 10822803091
Ref: Security<18>-Footnote-12803255
Node: Library<40>2803298
Ref: whatsnew/changelog id3012803404
Ref: 10832803404
Ref: Library<40>-Footnote-12803737
Ref: Library<40>-Footnote-22803780
Node: IDLE<31>2803823
Ref: whatsnew/changelog id3022803926
Ref: 10842803926
Ref: IDLE<31>-Footnote-12805592
Ref: IDLE<31>-Footnote-22805635
Ref: IDLE<31>-Footnote-32805678
Ref: IDLE<31>-Footnote-42805721
Ref: IDLE<31>-Footnote-52805764
Ref: IDLE<31>-Footnote-62805807
Ref: IDLE<31>-Footnote-72805850
Ref: IDLE<31>-Footnote-82805893
Ref: IDLE<31>-Footnote-92805936
Ref: IDLE<31>-Footnote-102805979
Node: C API<25>2806023
Ref: whatsnew/changelog id3032806124
Ref: 10852806124
Ref: C API<25>-Footnote-12806364
Node: Build<34>2806407
Ref: whatsnew/changelog id3042806515
Ref: 10862806515
Ref: Build<34>-Footnote-12807492
Ref: Build<34>-Footnote-22807535
Ref: Build<34>-Footnote-32807578
Ref: Build<34>-Footnote-42807621
Ref: Build<34>-Footnote-52807664
Node: Tools/Demos<23>2807707
Ref: whatsnew/changelog id3052807823
Ref: 10872807823
Ref: Tools/Demos<23>-Footnote-12808109
Ref: Tools/Demos<23>-Footnote-22808152
Node: Documentation<31>2808195
Ref: whatsnew/changelog id3062808311
Ref: 10882808311
Ref: Documentation<31>-Footnote-12808694
Ref: Documentation<31>-Footnote-22808737
Node: Tests<33>2808780
Ref: whatsnew/changelog id3072808872
Ref: 10892808872
Ref: Tests<33>-Footnote-12809042
Node: Python 3 6 0 alpha 22809085
Ref: whatsnew/changelog python-3-6-0-alpha-22809209
Ref: 108a2809209
Node: Core and Builtins<38>2809668
Ref: whatsnew/changelog id3082809766
Ref: 108b2809766
Ref: Core and Builtins<38>-Footnote-12811398
Ref: Core and Builtins<38>-Footnote-22811441
Ref: Core and Builtins<38>-Footnote-32811484
Ref: Core and Builtins<38>-Footnote-42811527
Ref: Core and Builtins<38>-Footnote-52811570
Ref: Core and Builtins<38>-Footnote-62811613
Ref: Core and Builtins<38>-Footnote-72811662
Ref: Core and Builtins<38>-Footnote-82811705
Ref: Core and Builtins<38>-Footnote-92811748
Ref: Core and Builtins<38>-Footnote-102811791
Ref: Core and Builtins<38>-Footnote-112811835
Ref: Core and Builtins<38>-Footnote-122811879
Node: Library<41>2811923
Ref: whatsnew/changelog id3092812042
Ref: 108c2812042
Ref: Library<41>-Footnote-12812684
Ref: Library<41>-Footnote-22812727
Ref: Library<41>-Footnote-32812770
Ref: Library<41>-Footnote-42812813
Node: Security<19>2812856
Ref: whatsnew/changelog id3102812965
Ref: 108d2812965
Ref: Security<19>-Footnote-12813201
Node: Library<42>2813244
Ref: whatsnew/changelog id3112813354
Ref: 108e2813354
Ref: Library<42>-Footnote-12815301
Ref: Library<42>-Footnote-22815344
Ref: Library<42>-Footnote-32815387
Ref: Library<42>-Footnote-42815430
Ref: Library<42>-Footnote-52815473
Ref: Library<42>-Footnote-62815522
Ref: Library<42>-Footnote-72815565
Ref: Library<42>-Footnote-82815608
Ref: Library<42>-Footnote-92815651
Ref: Library<42>-Footnote-102815700
Ref: Library<42>-Footnote-112815744
Ref: Library<42>-Footnote-122815794
Ref: Library<42>-Footnote-132815844
Ref: Library<42>-Footnote-142815888
Node: Security<20>2815932
Ref: whatsnew/changelog id3122816041
Ref: 108f2816041
Ref: Security<20>-Footnote-12816365
Node: Library<43>2816408
Ref: whatsnew/changelog id3132816514
Ref: 10902816514
Ref: Library<43>-Footnote-12819269
Ref: Library<43>-Footnote-22819312
Ref: Library<43>-Footnote-32819355
Ref: Library<43>-Footnote-42819398
Ref: Library<43>-Footnote-52819441
Ref: Library<43>-Footnote-62819484
Ref: Library<43>-Footnote-72819527
Ref: Library<43>-Footnote-82819570
Ref: Library<43>-Footnote-92819613
Ref: Library<43>-Footnote-102819656
Ref: Library<43>-Footnote-112819700
Ref: Library<43>-Footnote-122819744
Ref: Library<43>-Footnote-132819788
Ref: Library<43>-Footnote-142819832
Ref: Library<43>-Footnote-152819876
Ref: Library<43>-Footnote-162819920
Ref: Library<43>-Footnote-172819964
Node: IDLE<32>2820008
Ref: whatsnew/changelog id3142820119
Ref: 10912820119
Ref: IDLE<32>-Footnote-12822772
Ref: IDLE<32>-Footnote-22822814
Ref: IDLE<32>-Footnote-32822857
Ref: IDLE<32>-Footnote-42822900
Ref: IDLE<32>-Footnote-52822943
Ref: IDLE<32>-Footnote-62822986
Ref: IDLE<32>-Footnote-72823029
Ref: IDLE<32>-Footnote-82823072
Ref: IDLE<32>-Footnote-92823115
Ref: IDLE<32>-Footnote-102823158
Ref: IDLE<32>-Footnote-112823202
Ref: IDLE<32>-Footnote-122823246
Ref: IDLE<32>-Footnote-132823290
Ref: IDLE<32>-Footnote-142823334
Ref: IDLE<32>-Footnote-152823378
Ref: IDLE<32>-Footnote-162823422
Ref: IDLE<32>-Footnote-172823466
Ref: IDLE<32>-Footnote-182823510
Ref: IDLE<32>-Footnote-192823554
Node: Documentation<32>2823598
Ref: whatsnew/changelog id3152823707
Ref: 10922823707
Ref: Documentation<32>-Footnote-12824154
Ref: Documentation<32>-Footnote-22824197
Ref: Documentation<32>-Footnote-32824240
Ref: Documentation<32>-Footnote-42824289
Node: Tests<34>2824332
Ref: whatsnew/changelog id3162824444
Ref: 10932824444
Ref: Tests<34>-Footnote-12824824
Ref: Tests<34>-Footnote-22824867
Node: Windows<32>2824910
Ref: whatsnew/changelog id3172825014
Ref: 10942825014
Ref: Windows<32>-Footnote-12825298
Node: Build<35>2825341
Ref: whatsnew/changelog id3182825447
Ref: 10952825447
Ref: Build<35>-Footnote-12825726
Ref: Build<35>-Footnote-22825769
Node: Windows<33>2825812
Ref: whatsnew/changelog id3192825916
Ref: 10962825916
Ref: Windows<33>-Footnote-12826119
Node: C API<26>2826162
Ref: whatsnew/changelog id3202826272
Ref: 10972826272
Ref: C API<26>-Footnote-12826512
Ref: C API<26>-Footnote-22826555
Ref: C API<26>-Footnote-32826604
Node: Tools/Demos<24>2826647
Ref: whatsnew/changelog id3212826737
Ref: 10982826737
Ref: Tools/Demos<24>-Footnote-12826935
Node: Python 3 6 0 alpha 12826978
Ref: whatsnew/changelog python-3-6-0-alpha-12827100
Ref: 10992827100
Node: Core and Builtins<39>2827585
Ref: whatsnew/changelog id3222827683
Ref: 109a2827683
Ref: Core and Builtins<39>-Footnote-12840876
Ref: Core and Builtins<39>-Footnote-22840919
Ref: Core and Builtins<39>-Footnote-32840962
Ref: Core and Builtins<39>-Footnote-42841005
Ref: Core and Builtins<39>-Footnote-52841048
Ref: Core and Builtins<39>-Footnote-62841091
Ref: Core and Builtins<39>-Footnote-72841134
Ref: Core and Builtins<39>-Footnote-82841177
Ref: Core and Builtins<39>-Footnote-92841220
Ref: Core and Builtins<39>-Footnote-102841263
Ref: Core and Builtins<39>-Footnote-112841307
Ref: Core and Builtins<39>-Footnote-122841351
Ref: Core and Builtins<39>-Footnote-132841395
Ref: Core and Builtins<39>-Footnote-142841439
Ref: Core and Builtins<39>-Footnote-152841483
Ref: Core and Builtins<39>-Footnote-162841527
Ref: Core and Builtins<39>-Footnote-172841577
Ref: Core and Builtins<39>-Footnote-182841621
Ref: Core and Builtins<39>-Footnote-192841665
Ref: Core and Builtins<39>-Footnote-202841709
Ref: Core and Builtins<39>-Footnote-212841753
Ref: Core and Builtins<39>-Footnote-222841797
Ref: Core and Builtins<39>-Footnote-232841841
Ref: Core and Builtins<39>-Footnote-242841891
Ref: Core and Builtins<39>-Footnote-252841935
Ref: Core and Builtins<39>-Footnote-262841979
Ref: Core and Builtins<39>-Footnote-272842023
Ref: Core and Builtins<39>-Footnote-282842067
Ref: Core and Builtins<39>-Footnote-292842111
Ref: Core and Builtins<39>-Footnote-302842155
Ref: Core and Builtins<39>-Footnote-312842199
Ref: Core and Builtins<39>-Footnote-322842243
Ref: Core and Builtins<39>-Footnote-332842287
Ref: Core and Builtins<39>-Footnote-342842331
Ref: Core and Builtins<39>-Footnote-352842375
Ref: Core and Builtins<39>-Footnote-362842419
Ref: Core and Builtins<39>-Footnote-372842462
Ref: Core and Builtins<39>-Footnote-382842506
Ref: Core and Builtins<39>-Footnote-392842550
Ref: Core and Builtins<39>-Footnote-402842594
Ref: Core and Builtins<39>-Footnote-412842638
Ref: Core and Builtins<39>-Footnote-422842682
Ref: Core and Builtins<39>-Footnote-432842726
Ref: Core and Builtins<39>-Footnote-442842770
Ref: Core and Builtins<39>-Footnote-452842814
Ref: Core and Builtins<39>-Footnote-462842858
Ref: Core and Builtins<39>-Footnote-472842902
Ref: Core and Builtins<39>-Footnote-482842946
Ref: Core and Builtins<39>-Footnote-492842990
Ref: Core and Builtins<39>-Footnote-502843034
Ref: Core and Builtins<39>-Footnote-512843078
Ref: Core and Builtins<39>-Footnote-522843122
Ref: Core and Builtins<39>-Footnote-532843165
Ref: Core and Builtins<39>-Footnote-542843209
Ref: Core and Builtins<39>-Footnote-552843253
Ref: Core and Builtins<39>-Footnote-562843297
Ref: Core and Builtins<39>-Footnote-572843341
Ref: Core and Builtins<39>-Footnote-582843385
Ref: Core and Builtins<39>-Footnote-592843429
Ref: Core and Builtins<39>-Footnote-602843473
Ref: Core and Builtins<39>-Footnote-612843517
Ref: Core and Builtins<39>-Footnote-622843561
Ref: Core and Builtins<39>-Footnote-632843605
Ref: Core and Builtins<39>-Footnote-642843649
Ref: Core and Builtins<39>-Footnote-652843693
Ref: Core and Builtins<39>-Footnote-662843737
Ref: Core and Builtins<39>-Footnote-672843781
Ref: Core and Builtins<39>-Footnote-682843825
Ref: Core and Builtins<39>-Footnote-692843869
Ref: Core and Builtins<39>-Footnote-702843913
Ref: Core and Builtins<39>-Footnote-712843957
Ref: Core and Builtins<39>-Footnote-722844001
Ref: Core and Builtins<39>-Footnote-732844045
Ref: Core and Builtins<39>-Footnote-742844089
Ref: Core and Builtins<39>-Footnote-752844133
Ref: Core and Builtins<39>-Footnote-762844177
Ref: Core and Builtins<39>-Footnote-772844221
Ref: Core and Builtins<39>-Footnote-782844265
Ref: Core and Builtins<39>-Footnote-792844308
Ref: Core and Builtins<39>-Footnote-802844352
Ref: Core and Builtins<39>-Footnote-812844402
Ref: Core and Builtins<39>-Footnote-822844446
Ref: Core and Builtins<39>-Footnote-832844490
Ref: Core and Builtins<39>-Footnote-842844534
Ref: Core and Builtins<39>-Footnote-852844578
Ref: Core and Builtins<39>-Footnote-862844622
Ref: Core and Builtins<39>-Footnote-872844666
Node: Library<44>2844710
Ref: whatsnew/changelog id3232844829
Ref: 109c2844829
Ref: Library<44>-Footnote-12850013
Ref: Library<44>-Footnote-22850056
Ref: Library<44>-Footnote-32850099
Ref: Library<44>-Footnote-42850142
Ref: Library<44>-Footnote-52850185
Ref: Library<44>-Footnote-62850228
Ref: Library<44>-Footnote-72850271
Ref: Library<44>-Footnote-82850314
Ref: Library<44>-Footnote-92850357
Ref: Library<44>-Footnote-102850400
Ref: Library<44>-Footnote-112850444
Ref: Library<44>-Footnote-122850488
Ref: Library<44>-Footnote-132850532
Ref: Library<44>-Footnote-142850576
Ref: Library<44>-Footnote-152850620
Ref: Library<44>-Footnote-162850664
Ref: Library<44>-Footnote-172850708
Ref: Library<44>-Footnote-182850752
Ref: Library<44>-Footnote-192850802
Ref: Library<44>-Footnote-202850846
Ref: Library<44>-Footnote-212850890
Ref: Library<44>-Footnote-222850934
Ref: Library<44>-Footnote-232850978
Ref: Library<44>-Footnote-242851022
Ref: Library<44>-Footnote-252851066
Ref: Library<44>-Footnote-262851110
Ref: Library<44>-Footnote-272851154
Ref: Library<44>-Footnote-282851198
Ref: Library<44>-Footnote-292851242
Ref: Library<44>-Footnote-302851286
Ref: Library<44>-Footnote-312851330
Ref: Library<44>-Footnote-322851374
Ref: Library<44>-Footnote-332851418
Ref: Library<44>-Footnote-342851462
Ref: Library<44>-Footnote-352851506
Ref: Library<44>-Footnote-362851550
Node: Security<21>2851594
Ref: whatsnew/changelog id3242851703
Ref: 109d2851703
Ref: Security<21>-Footnote-12851991
Node: Library<45>2852034
Ref: whatsnew/changelog id3252852144
Ref: 109e2852144
Ref: Library<45>-Footnote-12856861
Ref: Library<45>-Footnote-22856904
Ref: Library<45>-Footnote-32856947
Ref: Library<45>-Footnote-42856990
Ref: Library<45>-Footnote-52857033
Ref: Library<45>-Footnote-62857076
Ref: Library<45>-Footnote-72857119
Ref: Library<45>-Footnote-82857162
Ref: Library<45>-Footnote-92857205
Ref: Library<45>-Footnote-102857248
Ref: Library<45>-Footnote-112857292
Ref: Library<45>-Footnote-122857336
Ref: Library<45>-Footnote-132857380
Ref: Library<45>-Footnote-142857424
Ref: Library<45>-Footnote-152857468
Ref: Library<45>-Footnote-162857512
Ref: Library<45>-Footnote-172857556
Ref: Library<45>-Footnote-182857600
Ref: Library<45>-Footnote-192857644
Ref: Library<45>-Footnote-202857688
Ref: Library<45>-Footnote-212857732
Ref: Library<45>-Footnote-222857776
Ref: Library<45>-Footnote-232857820
Ref: Library<45>-Footnote-242857864
Ref: Library<45>-Footnote-252857908
Ref: Library<45>-Footnote-262857952
Ref: Library<45>-Footnote-272857996
Ref: Library<45>-Footnote-282858040
Ref: Library<45>-Footnote-292858084
Ref: Library<45>-Footnote-302858128
Ref: Library<45>-Footnote-312858172
Ref: Library<45>-Footnote-322858216
Node: Security<22>2858260
Ref: whatsnew/changelog id3262858369
Ref: 10a02858369
Ref: Security<22>-Footnote-12858556
Node: Library<46>2858599
Ref: whatsnew/changelog id3272858709
Ref: 10a12858709
Ref: Library<46>-Footnote-12862254
Ref: Library<46>-Footnote-22862297
Ref: Library<46>-Footnote-32862340
Ref: Library<46>-Footnote-42862383
Ref: Library<46>-Footnote-52862426
Ref: Library<46>-Footnote-62862469
Ref: Library<46>-Footnote-72862512
Ref: Library<46>-Footnote-82862555
Ref: Library<46>-Footnote-92862598
Ref: Library<46>-Footnote-102862641
Ref: Library<46>-Footnote-112862685
Ref: Library<46>-Footnote-122862729
Ref: Library<46>-Footnote-132862772
Ref: Library<46>-Footnote-142862816
Ref: Library<46>-Footnote-152862860
Ref: Library<46>-Footnote-162862904
Ref: Library<46>-Footnote-172862948
Ref: Library<46>-Footnote-182862992
Ref: Library<46>-Footnote-192863036
Ref: Library<46>-Footnote-202863080
Ref: Library<46>-Footnote-212863124
Ref: Library<46>-Footnote-222863168
Ref: Library<46>-Footnote-232863212
Ref: Library<46>-Footnote-242863256
Ref: Library<46>-Footnote-252863300
Node: Security<23>2863344
Ref: whatsnew/changelog id3282863453
Ref: 10a42863453
Ref: Security<23>-Footnote-12863619
Node: Library<47>2863662
Ref: whatsnew/changelog id3292863768
Ref: 10a52863768
Ref: Library<47>-Footnote-12881482
Ref: Library<47>-Footnote-22881525
Ref: Library<47>-Footnote-32881568
Ref: Library<47>-Footnote-42881611
Ref: Library<47>-Footnote-52881654
Ref: Library<47>-Footnote-62881697
Ref: Library<47>-Footnote-72881740
Ref: Library<47>-Footnote-82881783
Ref: Library<47>-Footnote-92881826
Ref: Library<47>-Footnote-102881869
Ref: Library<47>-Footnote-112881913
Ref: Library<47>-Footnote-122881957
Ref: Library<47>-Footnote-132882001
Ref: Library<47>-Footnote-142882045
Ref: Library<47>-Footnote-152882089
Ref: Library<47>-Footnote-162882133
Ref: Library<47>-Footnote-172882177
Ref: Library<47>-Footnote-182882221
Ref: Library<47>-Footnote-192882265
Ref: Library<47>-Footnote-202882309
Ref: Library<47>-Footnote-212882353
Ref: Library<47>-Footnote-222882397
Ref: Library<47>-Footnote-232882441
Ref: Library<47>-Footnote-242882485
Ref: Library<47>-Footnote-252882529
Ref: Library<47>-Footnote-262882573
Ref: Library<47>-Footnote-272882617
Ref: Library<47>-Footnote-282882661
Ref: Library<47>-Footnote-292882705
Ref: Library<47>-Footnote-302882749
Ref: Library<47>-Footnote-312882793
Ref: Library<47>-Footnote-322882837
Ref: Library<47>-Footnote-332882881
Ref: Library<47>-Footnote-342882925
Ref: Library<47>-Footnote-352882969
Ref: Library<47>-Footnote-362883013
Ref: Library<47>-Footnote-372883057
Ref: Library<47>-Footnote-382883101
Ref: Library<47>-Footnote-392883145
Ref: Library<47>-Footnote-402883189
Ref: Library<47>-Footnote-412883233
Ref: Library<47>-Footnote-422883277
Ref: Library<47>-Footnote-432883321
Ref: Library<47>-Footnote-442883365
Ref: Library<47>-Footnote-452883409
Ref: Library<47>-Footnote-462883453
Ref: Library<47>-Footnote-472883497
Ref: Library<47>-Footnote-482883541
Ref: Library<47>-Footnote-492883585
Ref: Library<47>-Footnote-502883629
Ref: Library<47>-Footnote-512883673
Ref: Library<47>-Footnote-522883716
Ref: Library<47>-Footnote-532883760
Ref: Library<47>-Footnote-542883804
Ref: Library<47>-Footnote-552883848
Ref: Library<47>-Footnote-562883892
Ref: Library<47>-Footnote-572883936
Ref: Library<47>-Footnote-582883979
Ref: Library<47>-Footnote-592884023
Ref: Library<47>-Footnote-602884067
Ref: Library<47>-Footnote-612884111
Ref: Library<47>-Footnote-622884155
Ref: Library<47>-Footnote-632884199
Ref: Library<47>-Footnote-642884243
Ref: Library<47>-Footnote-652884287
Ref: Library<47>-Footnote-662884331
Ref: Library<47>-Footnote-672884375
Ref: Library<47>-Footnote-682884418
Ref: Library<47>-Footnote-692884462
Ref: Library<47>-Footnote-702884506
Ref: Library<47>-Footnote-712884550
Ref: Library<47>-Footnote-722884594
Ref: Library<47>-Footnote-732884638
Ref: Library<47>-Footnote-742884682
Ref: Library<47>-Footnote-752884726
Ref: Library<47>-Footnote-762884770
Ref: Library<47>-Footnote-772884814
Ref: Library<47>-Footnote-782884858
Ref: Library<47>-Footnote-792884902
Ref: Library<47>-Footnote-802884946
Ref: Library<47>-Footnote-812884990
Ref: Library<47>-Footnote-822885034
Ref: Library<47>-Footnote-832885078
Ref: Library<47>-Footnote-842885122
Ref: Library<47>-Footnote-852885166
Ref: Library<47>-Footnote-862885210
Ref: Library<47>-Footnote-872885254
Ref: Library<47>-Footnote-882885298
Ref: Library<47>-Footnote-892885342
Ref: Library<47>-Footnote-902885386
Ref: Library<47>-Footnote-912885430
Ref: Library<47>-Footnote-922885474
Ref: Library<47>-Footnote-932885518
Ref: Library<47>-Footnote-942885562
Ref: Library<47>-Footnote-952885606
Ref: Library<47>-Footnote-962885650
Ref: Library<47>-Footnote-972885694
Ref: Library<47>-Footnote-982885738
Ref: Library<47>-Footnote-992885782
Ref: Library<47>-Footnote-1002885826
Ref: Library<47>-Footnote-1012885871
Ref: Library<47>-Footnote-1022885916
Ref: Library<47>-Footnote-1032885961
Ref: Library<47>-Footnote-1042886006
Ref: Library<47>-Footnote-1052886051
Ref: Library<47>-Footnote-1062886096
Ref: Library<47>-Footnote-1072886141
Ref: Library<47>-Footnote-1082886186
Ref: Library<47>-Footnote-1092886231
Ref: Library<47>-Footnote-1102886276
Ref: Library<47>-Footnote-1112886321
Ref: Library<47>-Footnote-1122886366
Ref: Library<47>-Footnote-1132886411
Ref: Library<47>-Footnote-1142886456
Ref: Library<47>-Footnote-1152886501
Ref: Library<47>-Footnote-1162886545
Ref: Library<47>-Footnote-1172886589
Ref: Library<47>-Footnote-1182886634
Ref: Library<47>-Footnote-1192886679
Ref: Library<47>-Footnote-1202886724
Ref: Library<47>-Footnote-1212886769
Ref: Library<47>-Footnote-1222886814
Ref: Library<47>-Footnote-1232886859
Ref: Library<47>-Footnote-1242886904
Ref: Library<47>-Footnote-1252886949
Ref: Library<47>-Footnote-1262886994
Ref: Library<47>-Footnote-1272887039
Ref: Library<47>-Footnote-1282887084
Ref: Library<47>-Footnote-1292887129
Ref: Library<47>-Footnote-1302887174
Ref: Library<47>-Footnote-1312887219
Node: IDLE<33>2887264
Ref: whatsnew/changelog id3302887375
Ref: 10a62887375
Ref: IDLE<33>-Footnote-12892954
Ref: IDLE<33>-Footnote-22892997
Ref: IDLE<33>-Footnote-32893040
Ref: IDLE<33>-Footnote-42893083
Ref: IDLE<33>-Footnote-52893126
Ref: IDLE<33>-Footnote-62893169
Ref: IDLE<33>-Footnote-72893212
Ref: IDLE<33>-Footnote-82893255
Ref: IDLE<33>-Footnote-92893298
Ref: IDLE<33>-Footnote-102893341
Ref: IDLE<33>-Footnote-112893385
Ref: IDLE<33>-Footnote-122893429
Ref: IDLE<33>-Footnote-132893473
Ref: IDLE<33>-Footnote-142893517
Ref: IDLE<33>-Footnote-152893561
Ref: IDLE<33>-Footnote-162893605
Ref: IDLE<33>-Footnote-172893649
Ref: IDLE<33>-Footnote-182893693
Ref: IDLE<33>-Footnote-192893737
Ref: IDLE<33>-Footnote-202893781
Ref: IDLE<33>-Footnote-212893825
Ref: IDLE<33>-Footnote-222893869
Ref: IDLE<33>-Footnote-232893913
Ref: IDLE<33>-Footnote-242893957
Ref: IDLE<33>-Footnote-252894001
Ref: IDLE<33>-Footnote-262894045
Ref: IDLE<33>-Footnote-272894089
Ref: IDLE<33>-Footnote-282894133
Node: Documentation<33>2894177
Ref: whatsnew/changelog id3312894286
Ref: 10a72894286
Ref: Documentation<33>-Footnote-12895084
Ref: Documentation<33>-Footnote-22895127
Ref: Documentation<33>-Footnote-32895169
Ref: Documentation<33>-Footnote-42895212
Ref: Documentation<33>-Footnote-52895255
Node: Tests<35>2895298
Ref: whatsnew/changelog id3322895408
Ref: 10a82895408
Ref: Tests<35>-Footnote-12897166
Ref: Tests<35>-Footnote-22897209
Ref: Tests<35>-Footnote-32897252
Ref: Tests<35>-Footnote-42897295
Ref: Tests<35>-Footnote-52897338
Ref: Tests<35>-Footnote-62897381
Ref: Tests<35>-Footnote-72897424
Ref: Tests<35>-Footnote-82897467
Ref: Tests<35>-Footnote-92897510
Ref: Tests<35>-Footnote-102897553
Ref: Tests<35>-Footnote-112897597
Ref: Tests<35>-Footnote-122897641
Ref: Tests<35>-Footnote-132897685
Node: Build<36>2897729
Ref: whatsnew/changelog id3332897833
Ref: 10a92897833
Ref: Build<36>-Footnote-12900565
Ref: Build<36>-Footnote-22900608
Ref: Build<36>-Footnote-32900651
Ref: Build<36>-Footnote-42900694
Ref: Build<36>-Footnote-52900737
Ref: Build<36>-Footnote-62900780
Ref: Build<36>-Footnote-72900823
Ref: Build<36>-Footnote-82900866
Ref: Build<36>-Footnote-92900909
Ref: Build<36>-Footnote-102900952
Ref: Build<36>-Footnote-112900996
Ref: Build<36>-Footnote-122901040
Ref: Build<36>-Footnote-132901084
Ref: Build<36>-Footnote-142901128
Ref: Build<36>-Footnote-152901172
Ref: Build<36>-Footnote-162901216
Ref: Build<36>-Footnote-172901260
Ref: Build<36>-Footnote-182901304
Ref: Build<36>-Footnote-192901348
Node: Windows<34>2901392
Ref: whatsnew/changelog id3342901502
Ref: 10aa2901502
Ref: Windows<34>-Footnote-12902152
Ref: Windows<34>-Footnote-22902195
Ref: Windows<34>-Footnote-32902238
Ref: Windows<34>-Footnote-42902281
Ref: Windows<34>-Footnote-52902324
Ref: Windows<34>-Footnote-62902367
Node: Tools/Demos<25>2902410
Ref: whatsnew/changelog id3352902520
Ref: 10ab2902520
Ref: Tools/Demos<25>-Footnote-12903312
Ref: Tools/Demos<25>-Footnote-22903355
Ref: Tools/Demos<25>-Footnote-32903398
Ref: Tools/Demos<25>-Footnote-42903441
Ref: Tools/Demos<25>-Footnote-52903484
Ref: Tools/Demos<25>-Footnote-62903527
Node: C API<27>2903570
Ref: whatsnew/changelog id3362903660
Ref: 10ac2903660
Ref: C API<27>-Footnote-12904157
Ref: C API<27>-Footnote-22904200
Node: Python 3 5 5 final2904243
Ref: whatsnew/changelog python-3-5-5-final2904377
Ref: 10ad2904377
Node: Python 3 5 5 release candidate 12904505
Ref: whatsnew/changelog python-3-5-5-release-candidate-12904637
Ref: 10ae2904637
Node: Security<24>2904852
Ref: whatsnew/changelog id3372904963
Ref: 10af2904963
Ref: Security<24>-Footnote-12906231
Ref: Security<24>-Footnote-22906274
Ref: Security<24>-Footnote-32906317
Ref: Security<24>-Footnote-42906360
Ref: Security<24>-Footnote-52906403
Node: Core and Builtins<40>2906446
Ref: whatsnew/changelog id3382906577
Ref: 10b02906577
Ref: Core and Builtins<40>-Footnote-12906802
Node: Library<48>2906845
Ref: whatsnew/changelog id3392906955
Ref: 10b12906955
Ref: Library<48>-Footnote-12907482
Ref: Library<48>-Footnote-22907525
Node: Python 3 5 4 final2907568
Ref: whatsnew/changelog python-3-5-4-final2907714
Ref: 10b22907714
Node: Library<49>2907831
Ref: whatsnew/changelog id3402907897
Ref: 10b32907897
Ref: Library<49>-Footnote-12908096
Node: Python 3 5 4 release candidate 12908139
Ref: whatsnew/changelog python-3-5-4-release-candidate-12908271
Ref: 10b42908271
Node: Security<25>2908606
Ref: whatsnew/changelog id3412908717
Ref: 10b52908717
Ref: Security<25>-Footnote-12910016
Ref: Security<25>-Footnote-22910059
Ref: Security<25>-Footnote-32910102
Ref: Security<25>-Footnote-42910145
Node: Core and Builtins<41>2910188
Ref: whatsnew/changelog id3422910319
Ref: 10b62910319
Ref: Core and Builtins<41>-Footnote-12912574
Ref: Core and Builtins<41>-Footnote-22912617
Ref: Core and Builtins<41>-Footnote-32912660
Ref: Core and Builtins<41>-Footnote-42912703
Ref: Core and Builtins<41>-Footnote-52912746
Ref: Core and Builtins<41>-Footnote-62912789
Ref: Core and Builtins<41>-Footnote-72912832
Ref: Core and Builtins<41>-Footnote-82912875
Ref: Core and Builtins<41>-Footnote-92912918
Ref: Core and Builtins<41>-Footnote-102912961
Ref: Core and Builtins<41>-Footnote-112913005
Ref: Core and Builtins<41>-Footnote-122913049
Ref: Core and Builtins<41>-Footnote-132913093
Ref: Core and Builtins<41>-Footnote-142913137
Ref: Core and Builtins<41>-Footnote-152913181
Node: Library<50>2913225
Ref: whatsnew/changelog id3432913361
Ref: 10b72913361
Ref: Library<50>-Footnote-12923563
Ref: Library<50>-Footnote-22923606
Ref: Library<50>-Footnote-32923649
Ref: Library<50>-Footnote-42923692
Ref: Library<50>-Footnote-52923735
Ref: Library<50>-Footnote-62923778
Ref: Library<50>-Footnote-72923821
Ref: Library<50>-Footnote-82923864
Ref: Library<50>-Footnote-92923907
Ref: Library<50>-Footnote-102923950
Ref: Library<50>-Footnote-112923994
Ref: Library<50>-Footnote-122924038
Ref: Library<50>-Footnote-132924082
Ref: Library<50>-Footnote-142924126
Ref: Library<50>-Footnote-152924170
Ref: Library<50>-Footnote-162924214
Ref: Library<50>-Footnote-172924258
Ref: Library<50>-Footnote-182924302
Ref: Library<50>-Footnote-192924346
Ref: Library<50>-Footnote-202924390
Ref: Library<50>-Footnote-212924434
Ref: Library<50>-Footnote-222924478
Ref: Library<50>-Footnote-232924522
Ref: Library<50>-Footnote-242924566
Ref: Library<50>-Footnote-252924610
Ref: Library<50>-Footnote-262924654
Ref: Library<50>-Footnote-272924698
Ref: Library<50>-Footnote-282924742
Ref: Library<50>-Footnote-292924786
Ref: Library<50>-Footnote-302924830
Ref: Library<50>-Footnote-312924874
Ref: Library<50>-Footnote-322924918
Ref: Library<50>-Footnote-332924962
Ref: Library<50>-Footnote-342925006
Ref: Library<50>-Footnote-352925050
Ref: Library<50>-Footnote-362925094
Ref: Library<50>-Footnote-372925138
Ref: Library<50>-Footnote-382925182
Ref: Library<50>-Footnote-392925226
Ref: Library<50>-Footnote-402925270
Ref: Library<50>-Footnote-412925314
Ref: Library<50>-Footnote-422925358
Ref: Library<50>-Footnote-432925402
Ref: Library<50>-Footnote-442925446
Ref: Library<50>-Footnote-452925490
Ref: Library<50>-Footnote-462925534
Ref: Library<50>-Footnote-472925578
Ref: Library<50>-Footnote-482925622
Ref: Library<50>-Footnote-492925666
Ref: Library<50>-Footnote-502925710
Ref: Library<50>-Footnote-512925754
Ref: Library<50>-Footnote-522925798
Ref: Library<50>-Footnote-532925842
Ref: Library<50>-Footnote-542925886
Ref: Library<50>-Footnote-552925929
Ref: Library<50>-Footnote-562925973
Ref: Library<50>-Footnote-572926017
Ref: Library<50>-Footnote-582926061
Ref: Library<50>-Footnote-592926105
Ref: Library<50>-Footnote-602926149
Ref: Library<50>-Footnote-612926193
Ref: Library<50>-Footnote-622926237
Ref: Library<50>-Footnote-632926281
Ref: Library<50>-Footnote-642926325
Ref: Library<50>-Footnote-652926369
Ref: Library<50>-Footnote-662926413
Ref: Library<50>-Footnote-672926457
Ref: Library<50>-Footnote-682926501
Ref: Library<50>-Footnote-692926545
Ref: Library<50>-Footnote-702926589
Ref: Library<50>-Footnote-712926633
Ref: Library<50>-Footnote-722926677
Ref: Library<50>-Footnote-732926721
Ref: Library<50>-Footnote-742926765
Node: Documentation<34>2926809
Ref: whatsnew/changelog id3442926933
Ref: 10b82926933
Ref: Documentation<34>-Footnote-12927643
Ref: Documentation<34>-Footnote-22927686
Ref: Documentation<34>-Footnote-32927729
Ref: Documentation<34>-Footnote-42927772
Ref: Documentation<34>-Footnote-52927815
Ref: Documentation<34>-Footnote-62927858
Node: Tests<36>2927901
Ref: whatsnew/changelog id3452928023
Ref: 10b92928023
Ref: Tests<36>-Footnote-12930130
Ref: Tests<36>-Footnote-22930173
Ref: Tests<36>-Footnote-32930216
Ref: Tests<36>-Footnote-42930259
Ref: Tests<36>-Footnote-52930302
Ref: Tests<36>-Footnote-62930345
Ref: Tests<36>-Footnote-72930388
Ref: Tests<36>-Footnote-82930431
Ref: Tests<36>-Footnote-92930474
Node: Build<37>2930517
Ref: whatsnew/changelog id3462930633
Ref: 10ba2930633
Ref: Build<37>-Footnote-12931149
Ref: Build<37>-Footnote-22931192
Ref: Build<37>-Footnote-32931235
Node: Windows<35>2931278
Ref: whatsnew/changelog id3472931394
Ref: 10bb2931394
Ref: Windows<35>-Footnote-12931652
Ref: Windows<35>-Footnote-22931695
Node: C API<28>2931738
Ref: whatsnew/changelog id3482931836
Ref: 10bc2931836
Ref: C API<28>-Footnote-12932443
Ref: C API<28>-Footnote-22932486
Node: Python 3 5 3 final2932529
Ref: whatsnew/changelog python-3-5-3-final2932675
Ref: 10bd2932675
Node: Python 3 5 3 release candidate 12932820
Ref: whatsnew/changelog python-3-5-3-release-candidate-12932952
Ref: 10be2932952
Node: Core and Builtins<42>2933411
Ref: whatsnew/changelog id3492933521
Ref: 10bf2933521
Ref: Core and Builtins<42>-Footnote-12938979
Ref: Core and Builtins<42>-Footnote-22939022
Ref: Core and Builtins<42>-Footnote-32939065
Ref: Core and Builtins<42>-Footnote-42939108
Ref: Core and Builtins<42>-Footnote-52939151
Ref: Core and Builtins<42>-Footnote-62939194
Ref: Core and Builtins<42>-Footnote-72939237
Ref: Core and Builtins<42>-Footnote-82939280
Ref: Core and Builtins<42>-Footnote-92939323
Ref: Core and Builtins<42>-Footnote-102939366
Ref: Core and Builtins<42>-Footnote-112939410
Ref: Core and Builtins<42>-Footnote-122939454
Ref: Core and Builtins<42>-Footnote-132939498
Ref: Core and Builtins<42>-Footnote-142939542
Ref: Core and Builtins<42>-Footnote-152939586
Ref: Core and Builtins<42>-Footnote-162939630
Ref: Core and Builtins<42>-Footnote-172939674
Ref: Core and Builtins<42>-Footnote-182939718
Ref: Core and Builtins<42>-Footnote-192939762
Ref: Core and Builtins<42>-Footnote-202939806
Ref: Core and Builtins<42>-Footnote-212939850
Ref: Core and Builtins<42>-Footnote-222939894
Ref: Core and Builtins<42>-Footnote-232939938
Ref: Core and Builtins<42>-Footnote-242939982
Ref: Core and Builtins<42>-Footnote-252940026
Ref: Core and Builtins<42>-Footnote-262940070
Ref: Core and Builtins<42>-Footnote-272940114
Ref: Core and Builtins<42>-Footnote-282940158
Ref: Core and Builtins<42>-Footnote-292940202
Ref: Core and Builtins<42>-Footnote-302940246
Ref: Core and Builtins<42>-Footnote-312940290
Ref: Core and Builtins<42>-Footnote-322940334
Ref: Core and Builtins<42>-Footnote-332940378
Ref: Core and Builtins<42>-Footnote-342940422
Ref: Core and Builtins<42>-Footnote-352940466
Ref: Core and Builtins<42>-Footnote-362940510
Ref: Core and Builtins<42>-Footnote-372940554
Ref: Core and Builtins<42>-Footnote-382940598
Ref: Core and Builtins<42>-Footnote-392940642
Ref: Core and Builtins<42>-Footnote-402940686
Ref: Core and Builtins<42>-Footnote-412940730
Ref: Core and Builtins<42>-Footnote-422940774
Ref: Core and Builtins<42>-Footnote-432940818
Node: Library<51>2940862
Ref: whatsnew/changelog id3502940993
Ref: 10c02940993
Ref: Library<51>-Footnote-12954040
Ref: Library<51>-Footnote-22954083
Ref: Library<51>-Footnote-32954126
Ref: Library<51>-Footnote-42954169
Ref: Library<51>-Footnote-52954212
Ref: Library<51>-Footnote-62954254
Ref: Library<51>-Footnote-72954297
Ref: Library<51>-Footnote-82954340
Ref: Library<51>-Footnote-92954383
Ref: Library<51>-Footnote-102954426
Ref: Library<51>-Footnote-112954470
Ref: Library<51>-Footnote-122954514
Ref: Library<51>-Footnote-132954558
Ref: Library<51>-Footnote-142954602
Ref: Library<51>-Footnote-152954646
Ref: Library<51>-Footnote-162954690
Ref: Library<51>-Footnote-172954734
Ref: Library<51>-Footnote-182954778
Ref: Library<51>-Footnote-192954822
Ref: Library<51>-Footnote-202954866
Ref: Library<51>-Footnote-212954910
Ref: Library<51>-Footnote-222954954
Ref: Library<51>-Footnote-232954998
Ref: Library<51>-Footnote-242955042
Ref: Library<51>-Footnote-252955086
Ref: Library<51>-Footnote-262955130
Ref: Library<51>-Footnote-272955174
Ref: Library<51>-Footnote-282955218
Ref: Library<51>-Footnote-292955262
Ref: Library<51>-Footnote-302955306
Ref: Library<51>-Footnote-312955350
Ref: Library<51>-Footnote-322955394
Ref: Library<51>-Footnote-332955440
Ref: Library<51>-Footnote-342955484
Ref: Library<51>-Footnote-352955528
Ref: Library<51>-Footnote-362955572
Ref: Library<51>-Footnote-372955616
Ref: Library<51>-Footnote-382955660
Ref: Library<51>-Footnote-392955704
Ref: Library<51>-Footnote-402955748
Ref: Library<51>-Footnote-412955792
Ref: Library<51>-Footnote-422955836
Ref: Library<51>-Footnote-432955880
Ref: Library<51>-Footnote-442955924
Ref: Library<51>-Footnote-452955968
Ref: Library<51>-Footnote-462956012
Ref: Library<51>-Footnote-472956056
Ref: Library<51>-Footnote-482956100
Ref: Library<51>-Footnote-492956144
Ref: Library<51>-Footnote-502956188
Ref: Library<51>-Footnote-512956232
Ref: Library<51>-Footnote-522956276
Ref: Library<51>-Footnote-532956320
Ref: Library<51>-Footnote-542956364
Ref: Library<51>-Footnote-552956408
Ref: Library<51>-Footnote-562956452
Ref: Library<51>-Footnote-572956496
Ref: Library<51>-Footnote-582956540
Ref: Library<51>-Footnote-592956584
Ref: Library<51>-Footnote-602956628
Ref: Library<51>-Footnote-612956672
Ref: Library<51>-Footnote-622956716
Ref: Library<51>-Footnote-632956760
Ref: Library<51>-Footnote-642956804
Ref: Library<51>-Footnote-652956848
Ref: Library<51>-Footnote-662956892
Ref: Library<51>-Footnote-672956936
Ref: Library<51>-Footnote-682956980
Ref: Library<51>-Footnote-692957024
Ref: Library<51>-Footnote-702957068
Ref: Library<51>-Footnote-712957112
Ref: Library<51>-Footnote-722957155
Ref: Library<51>-Footnote-732957199
Ref: Library<51>-Footnote-742957243
Ref: Library<51>-Footnote-752957287
Ref: Library<51>-Footnote-762957331
Ref: Library<51>-Footnote-772957375
Ref: Library<51>-Footnote-782957419
Ref: Library<51>-Footnote-792957463
Ref: Library<51>-Footnote-802957507
Ref: Library<51>-Footnote-812957551
Ref: Library<51>-Footnote-822957595
Ref: Library<51>-Footnote-832957639
Ref: Library<51>-Footnote-842957683
Ref: Library<51>-Footnote-852957727
Ref: Library<51>-Footnote-862957771
Ref: Library<51>-Footnote-872957815
Ref: Library<51>-Footnote-882957859
Ref: Library<51>-Footnote-892957903
Ref: Library<51>-Footnote-902957947
Ref: Library<51>-Footnote-912957991
Ref: Library<51>-Footnote-922958035
Ref: Library<51>-Footnote-932958079
Ref: Library<51>-Footnote-942958123
Ref: Library<51>-Footnote-952958167
Node: Security<26>2958217
Ref: whatsnew/changelog id3512958338
Ref: 10c12958338
Ref: Security<26>-Footnote-12958627
Node: Library<52>2958670
Ref: whatsnew/changelog id3522958792
Ref: 10c22958792
Ref: Library<52>-Footnote-12958966
Node: Security<27>2959009
Ref: whatsnew/changelog id3532959130
Ref: 10c32959130
Ref: Security<27>-Footnote-12959294
Node: Library<53>2959337
Ref: whatsnew/changelog id3542959455
Ref: 10c42959455
Ref: Library<53>-Footnote-12962339
Ref: Library<53>-Footnote-22962382
Ref: Library<53>-Footnote-32962425
Ref: Library<53>-Footnote-42962468
Ref: Library<53>-Footnote-52962511
Ref: Library<53>-Footnote-62962554
Ref: Library<53>-Footnote-72962597
Ref: Library<53>-Footnote-82962640
Ref: Library<53>-Footnote-92962683
Ref: Library<53>-Footnote-102962726
Ref: Library<53>-Footnote-112962770
Ref: Library<53>-Footnote-122962814
Ref: Library<53>-Footnote-132962858
Ref: Library<53>-Footnote-142962902
Ref: Library<53>-Footnote-152962946
Ref: Library<53>-Footnote-162962990
Ref: Library<53>-Footnote-172963034
Ref: Library<53>-Footnote-182963078
Ref: Library<53>-Footnote-192963122
Ref: Library<53>-Footnote-202963166
Ref: Library<53>-Footnote-212963210
Ref: Library<53>-Footnote-222963254
Ref: Library<53>-Footnote-232963298
Ref: Library<53>-Footnote-242963342
Ref: Library<53>-Footnote-252963386
Ref: Library<53>-Footnote-262963430
Ref: Library<53>-Footnote-272963474
Ref: Library<53>-Footnote-282963518
Node: IDLE<34>2963562
Ref: whatsnew/changelog id3552963677
Ref: 10c52963677
Ref: IDLE<34>-Footnote-12964926
Ref: IDLE<34>-Footnote-22964969
Ref: IDLE<34>-Footnote-32965012
Ref: IDLE<34>-Footnote-42965055
Ref: IDLE<34>-Footnote-52965098
Ref: IDLE<34>-Footnote-62965141
Ref: IDLE<34>-Footnote-72965184
Ref: IDLE<34>-Footnote-82965227
Node: C API<29>2965270
Ref: whatsnew/changelog id3562965391
Ref: 10c62965391
Ref: C API<29>-Footnote-12965721
Ref: C API<29>-Footnote-22965764
Node: Documentation<35>2965807
Ref: whatsnew/changelog id3572965929
Ref: 10c72965929
Ref: Documentation<35>-Footnote-12966080
Node: Tests<37>2966123
Ref: whatsnew/changelog id3582966251
Ref: 10c82966251
Ref: Tests<37>-Footnote-12966944
Ref: Tests<37>-Footnote-22966987
Ref: Tests<37>-Footnote-32967030
Ref: Tests<37>-Footnote-42967073
Ref: Tests<37>-Footnote-52967116
Ref: Tests<37>-Footnote-62967159
Node: Tools/Demos<26>2967202
Ref: whatsnew/changelog id3592967324
Ref: 10c92967324
Ref: Tools/Demos<26>-Footnote-12967808
Ref: Tools/Demos<26>-Footnote-22967851
Ref: Tools/Demos<26>-Footnote-32967894
Node: Windows<36>2967937
Ref: whatsnew/changelog id3602968059
Ref: 10ca2968059
Ref: Windows<36>-Footnote-12968561
Ref: Windows<36>-Footnote-22968604
Ref: Windows<36>-Footnote-32968647
Ref: Windows<36>-Footnote-42968690
Ref: Windows<36>-Footnote-52968733
Node: Build<38>2968776
Ref: whatsnew/changelog id3612968874
Ref: 10cb2968874
Ref: Build<38>-Footnote-12971581
Ref: Build<38>-Footnote-22971624
Ref: Build<38>-Footnote-32971667
Ref: Build<38>-Footnote-42971710
Ref: Build<38>-Footnote-52971753
Ref: Build<38>-Footnote-62971796
Ref: Build<38>-Footnote-72971839
Ref: Build<38>-Footnote-82971882
Ref: Build<38>-Footnote-92971925
Ref: Build<38>-Footnote-102971968
Ref: Build<38>-Footnote-112972012
Ref: Build<38>-Footnote-122972056
Ref: Build<38>-Footnote-132972100
Ref: Build<38>-Footnote-142972144
Ref: Build<38>-Footnote-152972188
Ref: Build<38>-Footnote-162972232
Ref: Build<38>-Footnote-172972276
Ref: Build<38>-Footnote-182972320
Ref: Build<38>-Footnote-192972364
Ref: Build<38>-Footnote-202972408
Ref: Build<38>-Footnote-212972452
Ref: Build<38>-Footnote-222972496
Node: Python 3 5 2 final2972540
Ref: whatsnew/changelog python-3-5-2-final2972686
Ref: 10cc2972686
Node: Core and Builtins<43>2972861
Ref: whatsnew/changelog id3622972955
Ref: 10cd2972955
Ref: Core and Builtins<43>-Footnote-12973113
Node: Tests<38>2973156
Ref: whatsnew/changelog id3632973267
Ref: 10ce2973267
Ref: Tests<38>-Footnote-12973427
Node: IDLE<35>2973470
Ref: whatsnew/changelog id3642973551
Ref: 10cf2973551
Ref: IDLE<35>-Footnote-12973705
Node: Python 3 5 2 release candidate 12973748
Ref: whatsnew/changelog python-3-5-2-release-candidate-12973880
Ref: 10d02973880
Node: Core and Builtins<44>2974469
Ref: whatsnew/changelog id3652974580
Ref: 10d12974580
Ref: Core and Builtins<44>-Footnote-12980431
Ref: Core and Builtins<44>-Footnote-22980474
Ref: Core and Builtins<44>-Footnote-32980517
Ref: Core and Builtins<44>-Footnote-42980560
Ref: Core and Builtins<44>-Footnote-52980603
Ref: Core and Builtins<44>-Footnote-62980646
Ref: Core and Builtins<44>-Footnote-72980689
Ref: Core and Builtins<44>-Footnote-82980732
Ref: Core and Builtins<44>-Footnote-92980775
Ref: Core and Builtins<44>-Footnote-102980818
Ref: Core and Builtins<44>-Footnote-112980862
Ref: Core and Builtins<44>-Footnote-122980906
Ref: Core and Builtins<44>-Footnote-132980950
Ref: Core and Builtins<44>-Footnote-142980994
Ref: Core and Builtins<44>-Footnote-152981038
Ref: Core and Builtins<44>-Footnote-162981082
Ref: Core and Builtins<44>-Footnote-172981126
Ref: Core and Builtins<44>-Footnote-182981169
Ref: Core and Builtins<44>-Footnote-192981213
Ref: Core and Builtins<44>-Footnote-202981257
Ref: Core and Builtins<44>-Footnote-212981301
Ref: Core and Builtins<44>-Footnote-222981345
Ref: Core and Builtins<44>-Footnote-232981389
Ref: Core and Builtins<44>-Footnote-242981433
Ref: Core and Builtins<44>-Footnote-252981477
Ref: Core and Builtins<44>-Footnote-262981521
Ref: Core and Builtins<44>-Footnote-272981565
Ref: Core and Builtins<44>-Footnote-282981609
Ref: Core and Builtins<44>-Footnote-292981653
Ref: Core and Builtins<44>-Footnote-302981697
Ref: Core and Builtins<44>-Footnote-312981741
Ref: Core and Builtins<44>-Footnote-322981791
Ref: Core and Builtins<44>-Footnote-332981835
Ref: Core and Builtins<44>-Footnote-342981879
Ref: Core and Builtins<44>-Footnote-352981923
Ref: Core and Builtins<44>-Footnote-362981967
Ref: Core and Builtins<44>-Footnote-372982011
Ref: Core and Builtins<44>-Footnote-382982055
Node: Security<28>2982099
Ref: whatsnew/changelog id3662982230
Ref: 10d22982230
Ref: Security<28>-Footnote-12982465
Node: Library<54>2982508
Ref: whatsnew/changelog id3672982630
Ref: 10d32982630
Ref: Library<54>-Footnote-12983810
Ref: Library<54>-Footnote-22983853
Ref: Library<54>-Footnote-32983896
Ref: Library<54>-Footnote-42983945
Ref: Library<54>-Footnote-52983988
Node: Security<29>2984031
Ref: whatsnew/changelog id3682984152
Ref: 10d42984152
Ref: Security<29>-Footnote-12984476
Node: Library<55>2984519
Ref: whatsnew/changelog id3692984641
Ref: 10d52984641
Ref: Library<55>-Footnote-12989377
Ref: Library<55>-Footnote-22989420
Ref: Library<55>-Footnote-32989463
Ref: Library<55>-Footnote-42989506
Ref: Library<55>-Footnote-52989549
Ref: Library<55>-Footnote-62989592
Ref: Library<55>-Footnote-72989635
Ref: Library<55>-Footnote-82989678
Ref: Library<55>-Footnote-92989721
Ref: Library<55>-Footnote-102989764
Ref: Library<55>-Footnote-112989808
Ref: Library<55>-Footnote-122989852
Ref: Library<55>-Footnote-132989896
Ref: Library<55>-Footnote-142989940
Ref: Library<55>-Footnote-152989984
Ref: Library<55>-Footnote-162990028
Ref: Library<55>-Footnote-172990072
Ref: Library<55>-Footnote-182990116
Ref: Library<55>-Footnote-192990160
Ref: Library<55>-Footnote-202990204
Ref: Library<55>-Footnote-212990248
Ref: Library<55>-Footnote-222990292
Ref: Library<55>-Footnote-232990336
Ref: Library<55>-Footnote-242990380
Ref: Library<55>-Footnote-252990424
Ref: Library<55>-Footnote-262990468
Ref: Library<55>-Footnote-272990512
Ref: Library<55>-Footnote-282990556
Ref: Library<55>-Footnote-292990600
Ref: Library<55>-Footnote-302990644
Ref: Library<55>-Footnote-312990688
Node: Security<30>2990732
Ref: whatsnew/changelog id3702990853
Ref: 10d62990853
Ref: Security<30>-Footnote-12991141
Node: Library<56>2991184
Ref: whatsnew/changelog id3712991306
Ref: 10d72991306
Ref: Library<56>-Footnote-12993382
Ref: Library<56>-Footnote-22993425
Ref: Library<56>-Footnote-32993468
Ref: Library<56>-Footnote-42993511
Ref: Library<56>-Footnote-52993554
Ref: Library<56>-Footnote-62993597
Ref: Library<56>-Footnote-72993640
Ref: Library<56>-Footnote-82993683
Ref: Library<56>-Footnote-92993726
Ref: Library<56>-Footnote-102993769
Ref: Library<56>-Footnote-112993813
Ref: Library<56>-Footnote-122993857
Ref: Library<56>-Footnote-132993901
Ref: Library<56>-Footnote-142993945
Ref: Library<56>-Footnote-152993989
Node: Security<31>2994033
Ref: whatsnew/changelog id3722994154
Ref: 10d82994154
Ref: Security<31>-Footnote-12994341
Node: Library<57>2994384
Ref: whatsnew/changelog id3732994506
Ref: 10d92994506
Ref: Library<57>-Footnote-12997063
Ref: Library<57>-Footnote-22997106
Ref: Library<57>-Footnote-32997149
Ref: Library<57>-Footnote-42997192
Ref: Library<57>-Footnote-52997235
Ref: Library<57>-Footnote-62997278
Ref: Library<57>-Footnote-72997321
Ref: Library<57>-Footnote-82997364
Ref: Library<57>-Footnote-92997407
Ref: Library<57>-Footnote-102997450
Ref: Library<57>-Footnote-112997493
Ref: Library<57>-Footnote-122997537
Ref: Library<57>-Footnote-132997581
Ref: Library<57>-Footnote-142997625
Ref: Library<57>-Footnote-152997669
Ref: Library<57>-Footnote-162997713
Ref: Library<57>-Footnote-172997757
Ref: Library<57>-Footnote-182997801
Ref: Library<57>-Footnote-192997845
Node: Security<32>2997889
Ref: whatsnew/changelog id3742998010
Ref: 10da2998010
Ref: Security<32>-Footnote-12998178
Node: Library<58>2998221
Ref: whatsnew/changelog id3752998339
Ref: 10db2998339
Ref: Library<58>-Footnote-13004850
Ref: Library<58>-Footnote-23004893
Ref: Library<58>-Footnote-33004936
Ref: Library<58>-Footnote-43004979
Ref: Library<58>-Footnote-53005022
Ref: Library<58>-Footnote-63005065
Ref: Library<58>-Footnote-73005108
Ref: Library<58>-Footnote-83005151
Ref: Library<58>-Footnote-93005194
Ref: Library<58>-Footnote-103005237
Ref: Library<58>-Footnote-113005281
Ref: Library<58>-Footnote-123005325
Ref: Library<58>-Footnote-133005369
Ref: Library<58>-Footnote-143005413
Ref: Library<58>-Footnote-153005457
Ref: Library<58>-Footnote-163005501
Ref: Library<58>-Footnote-173005545
Ref: Library<58>-Footnote-183005589
Ref: Library<58>-Footnote-193005633
Ref: Library<58>-Footnote-203005677
Ref: Library<58>-Footnote-213005721
Ref: Library<58>-Footnote-223005765
Ref: Library<58>-Footnote-233005809
Ref: Library<58>-Footnote-243005853
Ref: Library<58>-Footnote-253005897
Ref: Library<58>-Footnote-263005941
Ref: Library<58>-Footnote-273005985
Ref: Library<58>-Footnote-283006029
Ref: Library<58>-Footnote-293006073
Ref: Library<58>-Footnote-303006117
Ref: Library<58>-Footnote-313006161
Ref: Library<58>-Footnote-323006204
Ref: Library<58>-Footnote-333006248
Ref: Library<58>-Footnote-343006292
Ref: Library<58>-Footnote-353006336
Ref: Library<58>-Footnote-363006380
Ref: Library<58>-Footnote-373006424
Ref: Library<58>-Footnote-383006468
Ref: Library<58>-Footnote-393006512
Ref: Library<58>-Footnote-403006556
Ref: Library<58>-Footnote-413006600
Ref: Library<58>-Footnote-423006644
Ref: Library<58>-Footnote-433006688
Ref: Library<58>-Footnote-443006732
Ref: Library<58>-Footnote-453006776
Ref: Library<58>-Footnote-463006820
Ref: Library<58>-Footnote-473006864
Ref: Library<58>-Footnote-483006908
Ref: Library<58>-Footnote-493006952
Ref: Library<58>-Footnote-503006996
Node: IDLE<36>3007040
Ref: whatsnew/changelog id3763007163
Ref: 10dc3007163
Ref: IDLE<36>-Footnote-13009526
Ref: IDLE<36>-Footnote-23009568
Ref: IDLE<36>-Footnote-33009611
Ref: IDLE<36>-Footnote-43009654
Ref: IDLE<36>-Footnote-53009697
Ref: IDLE<36>-Footnote-63009740
Ref: IDLE<36>-Footnote-73009783
Ref: IDLE<36>-Footnote-83009826
Ref: IDLE<36>-Footnote-93009869
Ref: IDLE<36>-Footnote-103009912
Ref: IDLE<36>-Footnote-113009956
Ref: IDLE<36>-Footnote-123010000
Ref: IDLE<36>-Footnote-133010044
Ref: IDLE<36>-Footnote-143010088
Ref: IDLE<36>-Footnote-153010132
Node: Documentation<36>3010176
Ref: whatsnew/changelog id3773010297
Ref: 10dd3010297
Ref: Documentation<36>-Footnote-13011257
Ref: Documentation<36>-Footnote-23011300
Ref: Documentation<36>-Footnote-33011343
Ref: Documentation<36>-Footnote-43011392
Ref: Documentation<36>-Footnote-53011435
Ref: Documentation<36>-Footnote-63011477
Ref: Documentation<36>-Footnote-73011520
Ref: Documentation<36>-Footnote-83011563
Node: Tests<39>3011606
Ref: whatsnew/changelog id3783011728
Ref: 10de3011728
Ref: Tests<39>-Footnote-13012603
Ref: Tests<39>-Footnote-23012646
Ref: Tests<39>-Footnote-33012689
Ref: Tests<39>-Footnote-43012732
Ref: Tests<39>-Footnote-53012775
Ref: Tests<39>-Footnote-63012818
Ref: Tests<39>-Footnote-73012861
Node: Build<39>3012904
Ref: whatsnew/changelog id3793013020
Ref: 10df3013020
Ref: Build<39>-Footnote-13015548
Ref: Build<39>-Footnote-23015591
Ref: Build<39>-Footnote-33015634
Ref: Build<39>-Footnote-43015677
Ref: Build<39>-Footnote-53015720
Ref: Build<39>-Footnote-63015763
Ref: Build<39>-Footnote-73015806
Ref: Build<39>-Footnote-83015849
Ref: Build<39>-Footnote-93015892
Ref: Build<39>-Footnote-103015935
Ref: Build<39>-Footnote-113015979
Ref: Build<39>-Footnote-123016023
Ref: Build<39>-Footnote-133016067
Ref: Build<39>-Footnote-143016111
Ref: Build<39>-Footnote-153016155
Ref: Build<39>-Footnote-163016199
Ref: Build<39>-Footnote-173016243
Node: Windows<37>3016287
Ref: whatsnew/changelog id3803016409
Ref: 10e03016409
Ref: Windows<37>-Footnote-13016991
Ref: Windows<37>-Footnote-23017034
Ref: Windows<37>-Footnote-33017077
Ref: Windows<37>-Footnote-43017120
Ref: Windows<37>-Footnote-53017163
Node: Tools/Demos<27>3017206
Ref: whatsnew/changelog id3813017330
Ref: 10e13017330
Ref: Tools/Demos<27>-Footnote-13017954
Ref: Tools/Demos<27>-Footnote-23017997
Ref: Tools/Demos<27>-Footnote-33018040
Ref: Tools/Demos<27>-Footnote-43018083
Node: Windows<38>3018126
Ref: whatsnew/changelog id3823018230
Ref: 10e23018230
Ref: Windows<38>-Footnote-13018433
Node: Python 3 5 1 final3018476
Ref: whatsnew/changelog python-3-5-1-final3018622
Ref: 10e33018622
Node: Core and Builtins<45>3018783
Ref: whatsnew/changelog id3833018879
Ref: 10e43018879
Ref: Core and Builtins<45>-Footnote-13019063
Node: Windows<39>3019106
Ref: whatsnew/changelog id3843019202
Ref: 10e53019202
Ref: Windows<39>-Footnote-13019392
Node: Python 3 5 1 release candidate 13019435
Ref: whatsnew/changelog python-3-5-1-release-candidate-13019567
Ref: 10e63019567
Node: Core and Builtins<46>3019906
Ref: whatsnew/changelog id3853020016
Ref: 10e73020016
Ref: Core and Builtins<46>-Footnote-13023156
Ref: Core and Builtins<46>-Footnote-23023199
Ref: Core and Builtins<46>-Footnote-33023242
Ref: Core and Builtins<46>-Footnote-43023285
Ref: Core and Builtins<46>-Footnote-53023328
Ref: Core and Builtins<46>-Footnote-63023371
Ref: Core and Builtins<46>-Footnote-73023414
Ref: Core and Builtins<46>-Footnote-83023457
Ref: Core and Builtins<46>-Footnote-93023500
Ref: Core and Builtins<46>-Footnote-103023543
Ref: Core and Builtins<46>-Footnote-113023587
Ref: Core and Builtins<46>-Footnote-123023631
Ref: Core and Builtins<46>-Footnote-133023675
Ref: Core and Builtins<46>-Footnote-143023719
Ref: Core and Builtins<46>-Footnote-153023763
Ref: Core and Builtins<46>-Footnote-163023807
Ref: Core and Builtins<46>-Footnote-173023851
Ref: Core and Builtins<46>-Footnote-183023895
Ref: Core and Builtins<46>-Footnote-193023939
Node: Library<59>3023983
Ref: whatsnew/changelog id3863024110
Ref: 10e83024110
Ref: Library<59>-Footnote-13034488
Ref: Library<59>-Footnote-23034531
Ref: Library<59>-Footnote-33034574
Ref: Library<59>-Footnote-43034617
Ref: Library<59>-Footnote-53034659
Ref: Library<59>-Footnote-63034702
Ref: Library<59>-Footnote-73034745
Ref: Library<59>-Footnote-83034788
Ref: Library<59>-Footnote-93034831
Ref: Library<59>-Footnote-103034874
Ref: Library<59>-Footnote-113034918
Ref: Library<59>-Footnote-123034962
Ref: Library<59>-Footnote-133035006
Ref: Library<59>-Footnote-143035050
Ref: Library<59>-Footnote-153035094
Ref: Library<59>-Footnote-163035138
Ref: Library<59>-Footnote-173035182
Ref: Library<59>-Footnote-183035226
Ref: Library<59>-Footnote-193035270
Ref: Library<59>-Footnote-203035314
Ref: Library<59>-Footnote-213035358
Ref: Library<59>-Footnote-223035402
Ref: Library<59>-Footnote-233035446
Ref: Library<59>-Footnote-243035490
Ref: Library<59>-Footnote-253035534
Ref: Library<59>-Footnote-263035578
Ref: Library<59>-Footnote-273035622
Ref: Library<59>-Footnote-283035666
Ref: Library<59>-Footnote-293035710
Ref: Library<59>-Footnote-303035754
Ref: Library<59>-Footnote-313035798
Ref: Library<59>-Footnote-323035842
Ref: Library<59>-Footnote-333035886
Ref: Library<59>-Footnote-343035930
Ref: Library<59>-Footnote-353035974
Ref: Library<59>-Footnote-363036018
Ref: Library<59>-Footnote-373036062
Ref: Library<59>-Footnote-383036106
Ref: Library<59>-Footnote-393036150
Ref: Library<59>-Footnote-403036194
Ref: Library<59>-Footnote-413036238
Ref: Library<59>-Footnote-423036282
Ref: Library<59>-Footnote-433036326
Ref: Library<59>-Footnote-443036370
Ref: Library<59>-Footnote-453036414
Ref: Library<59>-Footnote-463036458
Ref: Library<59>-Footnote-473036502
Ref: Library<59>-Footnote-483036546
Ref: Library<59>-Footnote-493036590
Ref: Library<59>-Footnote-503036634
Ref: Library<59>-Footnote-513036678
Ref: Library<59>-Footnote-523036722
Ref: Library<59>-Footnote-533036766
Ref: Library<59>-Footnote-543036810
Ref: Library<59>-Footnote-553036854
Ref: Library<59>-Footnote-563036898
Ref: Library<59>-Footnote-573036942
Ref: Library<59>-Footnote-583036986
Ref: Library<59>-Footnote-593037030
Ref: Library<59>-Footnote-603037074
Ref: Library<59>-Footnote-613037118
Ref: Library<59>-Footnote-623037162
Ref: Library<59>-Footnote-633037206
Ref: Library<59>-Footnote-643037250
Ref: Library<59>-Footnote-653037294
Ref: Library<59>-Footnote-663037338
Ref: Library<59>-Footnote-673037382
Ref: Library<59>-Footnote-683037426
Ref: Library<59>-Footnote-693037470
Ref: Library<59>-Footnote-703037514
Node: IDLE<37>3037558
Ref: whatsnew/changelog id3873037681
Ref: 10e93037681
Ref: IDLE<37>-Footnote-13042632
Ref: IDLE<37>-Footnote-23042675
Ref: IDLE<37>-Footnote-33042718
Ref: IDLE<37>-Footnote-43042761
Ref: IDLE<37>-Footnote-53042804
Ref: IDLE<37>-Footnote-63042847
Ref: IDLE<37>-Footnote-73042890
Ref: IDLE<37>-Footnote-83042933
Ref: IDLE<37>-Footnote-93042976
Ref: IDLE<37>-Footnote-103043019
Ref: IDLE<37>-Footnote-113043063
Ref: IDLE<37>-Footnote-123043107
Ref: IDLE<37>-Footnote-133043151
Ref: IDLE<37>-Footnote-143043195
Ref: IDLE<37>-Footnote-153043239
Ref: IDLE<37>-Footnote-163043283
Ref: IDLE<37>-Footnote-173043327
Ref: IDLE<37>-Footnote-183043371
Ref: IDLE<37>-Footnote-193043415
Ref: IDLE<37>-Footnote-203043459
Ref: IDLE<37>-Footnote-213043503
Ref: IDLE<37>-Footnote-223043547
Ref: IDLE<37>-Footnote-233043591
Ref: IDLE<37>-Footnote-243043635
Ref: IDLE<37>-Footnote-253043679
Node: Documentation<37>3043723
Ref: whatsnew/changelog id3883043844
Ref: 10ea3043844
Ref: Documentation<37>-Footnote-13044925
Ref: Documentation<37>-Footnote-23044968
Ref: Documentation<37>-Footnote-33045011
Ref: Documentation<37>-Footnote-43045054
Ref: Documentation<37>-Footnote-53045097
Ref: Documentation<37>-Footnote-63045140
Node: Tests<40>3045183
Ref: whatsnew/changelog id3893045305
Ref: 10eb3045305
Ref: Tests<40>-Footnote-13045812
Ref: Tests<40>-Footnote-23045855
Ref: Tests<40>-Footnote-33045898
Node: Build<40>3045941
Ref: whatsnew/changelog id3903046057
Ref: 10ec3046057
Ref: Build<40>-Footnote-13046482
Ref: Build<40>-Footnote-23046525
Ref: Build<40>-Footnote-33046568
Node: Windows<40>3046611
Ref: whatsnew/changelog id3913046733
Ref: 10ed3046733
Ref: Windows<40>-Footnote-13048006
Ref: Windows<40>-Footnote-23048049
Ref: Windows<40>-Footnote-33048092
Ref: Windows<40>-Footnote-43048135
Ref: Windows<40>-Footnote-53048178
Ref: Windows<40>-Footnote-63048221
Ref: Windows<40>-Footnote-73048264
Ref: Windows<40>-Footnote-83048307
Ref: Windows<40>-Footnote-93048350
Ref: Windows<40>-Footnote-103048393
Ref: Windows<40>-Footnote-113048437
Ref: Windows<40>-Footnote-123048481
Ref: Windows<40>-Footnote-133048525
Ref: Windows<40>-Footnote-143048569
Node: Tools/Demos<28>3048613
Ref: whatsnew/changelog id3923048717
Ref: 10ee3048717
Ref: Tools/Demos<28>-Footnote-13048867
Node: Python 3 5 0 final3048910
Ref: whatsnew/changelog python-3-5-0-final3049056
Ref: 10ef3049056
Node: Build<41>3049169
Ref: whatsnew/changelog id3933049233
Ref: 10f03049233
Ref: Build<41>-Footnote-13049409
Node: Python 3 5 0 release candidate 43049452
Ref: whatsnew/changelog python-3-5-0-release-candidate-43049598
Ref: 10f13049598
Node: Library<60>3049763
Ref: whatsnew/changelog id3943049861
Ref: 10f23049861
Ref: Library<60>-Footnote-13049990
Node: Build<42>3050033
Ref: whatsnew/changelog id3953050131
Ref: 10f33050131
Ref: Build<42>-Footnote-13050313
Node: Python 3 5 0 release candidate 33050356
Ref: whatsnew/changelog python-3-5-0-release-candidate-33050516
Ref: 10f43050516
Node: Core and Builtins<47>3050705
Ref: whatsnew/changelog id3963050815
Ref: 10f53050815
Ref: Core and Builtins<47>-Footnote-13051183
Ref: Core and Builtins<47>-Footnote-23051226
Ref: Core and Builtins<47>-Footnote-33051269
Ref: Core and Builtins<47>-Footnote-43051312
Node: Library<61>3051361
Ref: whatsnew/changelog id3973051471
Ref: 10f63051471
Ref: Library<61>-Footnote-13052245
Ref: Library<61>-Footnote-23052288
Ref: Library<61>-Footnote-33052331
Ref: Library<61>-Footnote-43052374
Ref: Library<61>-Footnote-53052417
Node: Python 3 5 0 release candidate 23052460
Ref: whatsnew/changelog python-3-5-0-release-candidate-23052620
Ref: 10f73052620
Node: Core and Builtins<48>3052809
Ref: whatsnew/changelog id3983052919
Ref: 10f83052919
Ref: Core and Builtins<48>-Footnote-13053463
Ref: Core and Builtins<48>-Footnote-23053506
Ref: Core and Builtins<48>-Footnote-33053549
Node: Library<62>3053592
Ref: whatsnew/changelog id3993053702
Ref: 10f93053702
Ref: Library<62>-Footnote-13053983
Ref: Library<62>-Footnote-23054026
Ref: Library<62>-Footnote-33054069
Node: Python 3 5 0 release candidate 13054112
Ref: whatsnew/changelog python-3-5-0-release-candidate-13054259
Ref: 10fa3054259
Node: Core and Builtins<49>3054522
Ref: whatsnew/changelog id4003054632
Ref: 10fb3054632
Ref: Core and Builtins<49>-Footnote-13054810
Node: Library<63>3054853
Ref: whatsnew/changelog id4013054980
Ref: 10fc3054980
Ref: Library<63>-Footnote-13056562
Ref: Library<63>-Footnote-23056605
Ref: Library<63>-Footnote-33056648
Ref: Library<63>-Footnote-43056691
Ref: Library<63>-Footnote-53056733
Ref: Library<63>-Footnote-63056776
Ref: Library<63>-Footnote-73056819
Ref: Library<63>-Footnote-83056862
Ref: Library<63>-Footnote-93056905
Ref: Library<63>-Footnote-103056948
Ref: Library<63>-Footnote-113056992
Ref: Library<63>-Footnote-123057036
Ref: Library<63>-Footnote-133057080
Ref: Library<63>-Footnote-143057124
Ref: Library<63>-Footnote-153057168
Node: IDLE<38>3057212
Ref: whatsnew/changelog id4023057335
Ref: 10fd3057335
Ref: IDLE<38>-Footnote-13058080
Ref: IDLE<38>-Footnote-23058123
Ref: IDLE<38>-Footnote-33058166
Ref: IDLE<38>-Footnote-43058209
Node: Documentation<38>3058252
Ref: whatsnew/changelog id4033058373
Ref: 10fe3058373
Ref: Documentation<38>-Footnote-13059033
Ref: Documentation<38>-Footnote-23059076
Ref: Documentation<38>-Footnote-33059119
Ref: Documentation<38>-Footnote-43059162
Node: Tests<41>3059205
Ref: whatsnew/changelog id4043059309
Ref: 10ff3059309
Ref: Tests<41>-Footnote-13059547
Node: Python 3 5 0 beta 43059590
Ref: whatsnew/changelog python-3-5-0-beta-43059724
Ref: 11003059724
Node: Core and Builtins<50>3059907
Ref: whatsnew/changelog id4053060004
Ref: 11013060004
Ref: Core and Builtins<50>-Footnote-13060808
Ref: Core and Builtins<50>-Footnote-23060851
Ref: Core and Builtins<50>-Footnote-33060894
Ref: Core and Builtins<50>-Footnote-43060943
Ref: Core and Builtins<50>-Footnote-53060986
Ref: Core and Builtins<50>-Footnote-63061029
Ref: Core and Builtins<50>-Footnote-73061072
Ref: Core and Builtins<50>-Footnote-83061115
Node: Library<64>3061158
Ref: whatsnew/changelog id4063061273
Ref: 11023061273
Ref: Library<64>-Footnote-13063561
Ref: Library<64>-Footnote-23063604
Ref: Library<64>-Footnote-33063647
Ref: Library<64>-Footnote-43063690
Ref: Library<64>-Footnote-53063733
Ref: Library<64>-Footnote-63063776
Ref: Library<64>-Footnote-73063819
Ref: Library<64>-Footnote-83063862
Ref: Library<64>-Footnote-93063905
Ref: Library<64>-Footnote-103063948
Ref: Library<64>-Footnote-113063992
Ref: Library<64>-Footnote-123064036
Ref: Library<64>-Footnote-133064080
Ref: Library<64>-Footnote-143064124
Ref: Library<64>-Footnote-153064168
Ref: Library<64>-Footnote-163064212
Ref: Library<64>-Footnote-173064256
Ref: Library<64>-Footnote-183064300
Ref: Library<64>-Footnote-193064344
Node: Build<43>3064388
Ref: whatsnew/changelog id4073064473
Ref: 11043064473
Ref: Build<43>-Footnote-13064636
Node: Python 3 5 0 beta 33064679
Ref: whatsnew/changelog python-3-5-0-beta-33064800
Ref: 11053064800
Node: Core and Builtins<51>3065039
Ref: whatsnew/changelog id4083065136
Ref: 11063065136
Ref: Core and Builtins<51>-Footnote-13066461
Ref: Core and Builtins<51>-Footnote-23066504
Ref: Core and Builtins<51>-Footnote-33066547
Ref: Core and Builtins<51>-Footnote-43066590
Ref: Core and Builtins<51>-Footnote-53066639
Ref: Core and Builtins<51>-Footnote-63066682
Node: Library<65>3066725
Ref: whatsnew/changelog id4093066840
Ref: 11073066840
Ref: Library<65>-Footnote-13068800
Ref: Library<65>-Footnote-23068843
Ref: Library<65>-Footnote-33068886
Ref: Library<65>-Footnote-43068929
Ref: Library<65>-Footnote-53068972
Ref: Library<65>-Footnote-63069015
Ref: Library<65>-Footnote-73069058
Ref: Library<65>-Footnote-83069101
Ref: Library<65>-Footnote-93069144
Ref: Library<65>-Footnote-103069187
Ref: Library<65>-Footnote-113069231
Ref: Library<65>-Footnote-123069275
Ref: Library<65>-Footnote-133069319
Ref: Library<65>-Footnote-143069363
Ref: Library<65>-Footnote-153069407
Ref: Library<65>-Footnote-163069451
Ref: Library<65>-Footnote-173069495
Ref: Library<65>-Footnote-183069539
Node: Tests<42>3069583
Ref: whatsnew/changelog id4103069694
Ref: 11083069694
Ref: Tests<42>-Footnote-13069974
Ref: Tests<42>-Footnote-23070017
Node: Documentation<39>3070060
Ref: whatsnew/changelog id4113070169
Ref: 11093070169
Ref: Documentation<39>-Footnote-13070511
Ref: Documentation<39>-Footnote-23070554
Node: Build<44>3070597
Ref: whatsnew/changelog id4123070688
Ref: 110a3070688
Ref: Build<44>-Footnote-13070851
Node: Python 3 5 0 beta 23070894
Ref: whatsnew/changelog python-3-5-0-beta-23071015
Ref: 110b3071015
Node: Core and Builtins<52>3071178
Ref: whatsnew/changelog id4133071275
Ref: 110c3071275
Ref: Core and Builtins<52>-Footnote-13072026
Ref: Core and Builtins<52>-Footnote-23072069
Ref: Core and Builtins<52>-Footnote-33072112
Ref: Core and Builtins<52>-Footnote-43072155
Ref: Core and Builtins<52>-Footnote-53072198
Node: Library<66>3072241
Ref: whatsnew/changelog id4143072338
Ref: 110d3072338
Ref: Library<66>-Footnote-13073043
Ref: Library<66>-Footnote-23073086
Ref: Library<66>-Footnote-33073129
Ref: Library<66>-Footnote-43073178
Ref: Library<66>-Footnote-53073220
Ref: Library<66>-Footnote-63073263
Ref: Library<66>-Footnote-73073306
Node: Python 3 5 0 beta 13073349
Ref: whatsnew/changelog python-3-5-0-beta-13073471
Ref: 110e3073471
Node: Core and Builtins<53>3073740
Ref: whatsnew/changelog id4153073837
Ref: 110f3073837
Ref: Core and Builtins<53>-Footnote-13075708
Ref: Core and Builtins<53>-Footnote-23075751
Ref: Core and Builtins<53>-Footnote-33075794
Ref: Core and Builtins<53>-Footnote-43075837
Ref: Core and Builtins<53>-Footnote-53075880
Ref: Core and Builtins<53>-Footnote-63075923
Ref: Core and Builtins<53>-Footnote-73075966
Ref: Core and Builtins<53>-Footnote-83076009
Ref: Core and Builtins<53>-Footnote-93076052
Ref: Core and Builtins<53>-Footnote-103076095
Ref: Core and Builtins<53>-Footnote-113076138
Ref: Core and Builtins<53>-Footnote-123076182
Ref: Core and Builtins<53>-Footnote-133076226
Ref: Core and Builtins<53>-Footnote-143076270
Ref: Core and Builtins<53>-Footnote-153076314
Ref: Core and Builtins<53>-Footnote-163076358
Ref: Core and Builtins<53>-Footnote-173076402
Ref: Core and Builtins<53>-Footnote-183076445
Ref: Core and Builtins<53>-Footnote-193076489
Node: Library<67>3076533
Ref: whatsnew/changelog id4163076647
Ref: 11103076647
Ref: Library<67>-Footnote-13084307
Ref: Library<67>-Footnote-23084350
Ref: Library<67>-Footnote-33084393
Ref: Library<67>-Footnote-43084436
Ref: Library<67>-Footnote-53084479
Ref: Library<67>-Footnote-63084522
Ref: Library<67>-Footnote-73084565
Ref: Library<67>-Footnote-83084608
Ref: Library<67>-Footnote-93084651
Ref: Library<67>-Footnote-103084694
Ref: Library<67>-Footnote-113084737
Ref: Library<67>-Footnote-123084781
Ref: Library<67>-Footnote-133084825
Ref: Library<67>-Footnote-143084869
Ref: Library<67>-Footnote-153084912
Ref: Library<67>-Footnote-163084956
Ref: Library<67>-Footnote-173085000
Ref: Library<67>-Footnote-183085044
Ref: Library<67>-Footnote-193085088
Ref: Library<67>-Footnote-203085132
Ref: Library<67>-Footnote-213085176
Ref: Library<67>-Footnote-223085220
Ref: Library<67>-Footnote-233085264
Ref: Library<67>-Footnote-243085308
Ref: Library<67>-Footnote-253085352
Ref: Library<67>-Footnote-263085395
Ref: Library<67>-Footnote-273085439
Ref: Library<67>-Footnote-283085483
Ref: Library<67>-Footnote-293085527
Ref: Library<67>-Footnote-303085571
Ref: Library<67>-Footnote-313085615
Ref: Library<67>-Footnote-323085659
Ref: Library<67>-Footnote-333085703
Ref: Library<67>-Footnote-343085747
Ref: Library<67>-Footnote-353085791
Ref: Library<67>-Footnote-363085835
Ref: Library<67>-Footnote-373085879
Ref: Library<67>-Footnote-383085923
Ref: Library<67>-Footnote-393085967
Ref: Library<67>-Footnote-403086011
Ref: Library<67>-Footnote-413086055
Ref: Library<67>-Footnote-423086098
Ref: Library<67>-Footnote-433086142
Ref: Library<67>-Footnote-443086186
Ref: Library<67>-Footnote-453086230
Ref: Library<67>-Footnote-463086274
Ref: Library<67>-Footnote-473086318
Ref: Library<67>-Footnote-483086362
Ref: Library<67>-Footnote-493086406
Ref: Library<67>-Footnote-503086450
Ref: Library<67>-Footnote-513086494
Ref: Library<67>-Footnote-523086538
Ref: Library<67>-Footnote-533086582
Ref: Library<67>-Footnote-543086626
Ref: Library<67>-Footnote-553086670
Ref: Library<67>-Footnote-563086714
Node: IDLE<39>3086758
Ref: whatsnew/changelog id4173086860
Ref: 11113086860
Ref: IDLE<39>-Footnote-13087027
Node: Tests<43>3087070
Ref: whatsnew/changelog id4183087178
Ref: 11123087178
Ref: Tests<43>-Footnote-13087474
Ref: Tests<43>-Footnote-23087517
Node: Documentation<40>3087559
Ref: whatsnew/changelog id4193087674
Ref: 11133087674
Ref: Documentation<40>-Footnote-13088079
Ref: Documentation<40>-Footnote-23088122
Ref: Documentation<40>-Footnote-33088165
Node: Tools/Demos<29>3088208
Ref: whatsnew/changelog id4203088305
Ref: 11143088305
Ref: Tools/Demos<29>-Footnote-13088822
Ref: Tools/Demos<29>-Footnote-23088865
Ref: Tools/Demos<29>-Footnote-33088908
Ref: Tools/Demos<29>-Footnote-43088951
Node: Python 3 5 0 alpha 43088994
Ref: whatsnew/changelog python-3-5-0-alpha-43089117
Ref: 11153089117
Node: Core and Builtins<54>3089374
Ref: whatsnew/changelog id4213089472
Ref: 11163089472
Ref: Core and Builtins<54>-Footnote-13090839
Ref: Core and Builtins<54>-Footnote-23090882
Ref: Core and Builtins<54>-Footnote-33090931
Ref: Core and Builtins<54>-Footnote-43090974
Ref: Core and Builtins<54>-Footnote-53091017
Ref: Core and Builtins<54>-Footnote-63091066
Ref: Core and Builtins<54>-Footnote-73091109
Ref: Core and Builtins<54>-Footnote-83091152
Ref: Core and Builtins<54>-Footnote-93091195
Ref: Core and Builtins<54>-Footnote-103091238
Ref: Core and Builtins<54>-Footnote-113091282
Node: Library<68>3091326
Ref: whatsnew/changelog id4223091442
Ref: 11173091442
Ref: Library<68>-Footnote-13098157
Ref: Library<68>-Footnote-23098200
Ref: Library<68>-Footnote-33098243
Ref: Library<68>-Footnote-43098285
Ref: Library<68>-Footnote-53098328
Ref: Library<68>-Footnote-63098371
Ref: Library<68>-Footnote-73098413
Ref: Library<68>-Footnote-83098456
Ref: Library<68>-Footnote-93098499
Ref: Library<68>-Footnote-103098542
Ref: Library<68>-Footnote-113098586
Ref: Library<68>-Footnote-123098630
Ref: Library<68>-Footnote-133098674
Ref: Library<68>-Footnote-143098718
Ref: Library<68>-Footnote-153098762
Ref: Library<68>-Footnote-163098806
Ref: Library<68>-Footnote-173098850
Ref: Library<68>-Footnote-183098894
Ref: Library<68>-Footnote-193098938
Ref: Library<68>-Footnote-203098982
Ref: Library<68>-Footnote-213099026
Ref: Library<68>-Footnote-223099070
Ref: Library<68>-Footnote-233099114
Ref: Library<68>-Footnote-243099158
Ref: Library<68>-Footnote-253099202
Ref: Library<68>-Footnote-263099246
Ref: Library<68>-Footnote-273099290
Ref: Library<68>-Footnote-283099334
Ref: Library<68>-Footnote-293099378
Ref: Library<68>-Footnote-303099422
Ref: Library<68>-Footnote-313099465
Ref: Library<68>-Footnote-323099509
Ref: Library<68>-Footnote-333099553
Ref: Library<68>-Footnote-343099597
Ref: Library<68>-Footnote-353099641
Ref: Library<68>-Footnote-363099685
Ref: Library<68>-Footnote-373099729
Ref: Library<68>-Footnote-383099773
Ref: Library<68>-Footnote-393099817
Ref: Library<68>-Footnote-403099861
Ref: Library<68>-Footnote-413099905
Ref: Library<68>-Footnote-423099949
Ref: Library<68>-Footnote-433099999
Ref: Library<68>-Footnote-443100043
Ref: Library<68>-Footnote-453100087
Ref: Library<68>-Footnote-463100131
Ref: Library<68>-Footnote-473100175
Ref: Library<68>-Footnote-483100219
Node: Build<45>3100263
Ref: whatsnew/changelog id4233100367
Ref: 11183100367
Ref: Build<45>-Footnote-13100650
Ref: Build<45>-Footnote-23100693
Node: Tests<44>3100736
Ref: whatsnew/changelog id4243100844
Ref: 11193100844
Ref: Tests<44>-Footnote-13101143
Ref: Tests<44>-Footnote-23101186
Node: Tools/Demos<30>3101229
Ref: whatsnew/changelog id4253101337
Ref: 111a3101337
Ref: Tools/Demos<30>-Footnote-13102369
Ref: Tools/Demos<30>-Footnote-23102412
Ref: Tools/Demos<30>-Footnote-33102455
Ref: Tools/Demos<30>-Footnote-43102498
Ref: Tools/Demos<30>-Footnote-53102541
Ref: Tools/Demos<30>-Footnote-63102584
Node: C API<30>3102627
Ref: whatsnew/changelog id4263102717
Ref: 111b3102717
Ref: C API<30>-Footnote-13102870
Node: Python 3 5 0 alpha 33102913
Ref: whatsnew/changelog python-3-5-0-alpha-33103037
Ref: 111c3103037
Node: Core and Builtins<55>3103274
Ref: whatsnew/changelog id4273103372
Ref: 111d3103372
Ref: Core and Builtins<55>-Footnote-13104166
Ref: Core and Builtins<55>-Footnote-23104209
Ref: Core and Builtins<55>-Footnote-33104252
Ref: Core and Builtins<55>-Footnote-43104295
Ref: Core and Builtins<55>-Footnote-53104338
Ref: Core and Builtins<55>-Footnote-63104381
Node: Library<69>3104424
Ref: whatsnew/changelog id4283104540
Ref: 111e3104540
Ref: Library<69>-Footnote-13110974
Ref: Library<69>-Footnote-23111017
Ref: Library<69>-Footnote-33111060
Ref: Library<69>-Footnote-43111103
Ref: Library<69>-Footnote-53111146
Ref: Library<69>-Footnote-63111189
Ref: Library<69>-Footnote-73111232
Ref: Library<69>-Footnote-83111275
Ref: Library<69>-Footnote-93111318
Ref: Library<69>-Footnote-103111361
Ref: Library<69>-Footnote-113111405
Ref: Library<69>-Footnote-123111449
Ref: Library<69>-Footnote-133111493
Ref: Library<69>-Footnote-143111537
Ref: Library<69>-Footnote-153111580
Ref: Library<69>-Footnote-163111624
Ref: Library<69>-Footnote-173111668
Ref: Library<69>-Footnote-183111712
Ref: Library<69>-Footnote-193111756
Ref: Library<69>-Footnote-203111800
Ref: Library<69>-Footnote-213111844
Ref: Library<69>-Footnote-223111888
Ref: Library<69>-Footnote-233111932
Ref: Library<69>-Footnote-243111976
Ref: Library<69>-Footnote-253112020
Ref: Library<69>-Footnote-263112064
Ref: Library<69>-Footnote-273112108
Ref: Library<69>-Footnote-283112152
Ref: Library<69>-Footnote-293112196
Ref: Library<69>-Footnote-303112240
Ref: Library<69>-Footnote-313112283
Ref: Library<69>-Footnote-323112327
Ref: Library<69>-Footnote-333112371
Ref: Library<69>-Footnote-343112415
Ref: Library<69>-Footnote-353112458
Ref: Library<69>-Footnote-363112502
Ref: Library<69>-Footnote-373112546
Ref: Library<69>-Footnote-383112590
Ref: Library<69>-Footnote-393112634
Ref: Library<69>-Footnote-403112678
Ref: Library<69>-Footnote-413112722
Ref: Library<69>-Footnote-423112766
Node: Build<46>3112810
Ref: whatsnew/changelog id4293112914
Ref: 111f3112914
Ref: Build<46>-Footnote-13113057
Node: Tests<45>3113100
Ref: whatsnew/changelog id4303113208
Ref: 11203113208
Ref: Tests<45>-Footnote-13113431
Ref: Tests<45>-Footnote-23113474
Node: Tools/Demos<31>3113517
Ref: whatsnew/changelog id4313113607
Ref: 11213113607
Ref: Tools/Demos<31>-Footnote-13113874
Node: Python 3 5 0 alpha 23113917
Ref: whatsnew/changelog python-3-5-0-alpha-23114041
Ref: 11223114041
Node: Core and Builtins<56>3114270
Ref: whatsnew/changelog id4323114368
Ref: 11233114368
Ref: Core and Builtins<56>-Footnote-13114664
Node: Library<70>3114707
Ref: whatsnew/changelog id4333114823
Ref: 11243114823
Ref: Library<70>-Footnote-13119138
Ref: Library<70>-Footnote-23119181
Ref: Library<70>-Footnote-33119230
Ref: Library<70>-Footnote-43119273
Ref: Library<70>-Footnote-53119316
Ref: Library<70>-Footnote-63119359
Ref: Library<70>-Footnote-73119402
Ref: Library<70>-Footnote-83119445
Ref: Library<70>-Footnote-93119488
Ref: Library<70>-Footnote-103119530
Ref: Library<70>-Footnote-113119574
Ref: Library<70>-Footnote-123119618
Ref: Library<70>-Footnote-133119662
Ref: Library<70>-Footnote-143119706
Ref: Library<70>-Footnote-153119750
Ref: Library<70>-Footnote-163119794
Ref: Library<70>-Footnote-173119837
Ref: Library<70>-Footnote-183119882
Ref: Library<70>-Footnote-193119925
Ref: Library<70>-Footnote-203119969
Ref: Library<70>-Footnote-213120012
Ref: Library<70>-Footnote-223120056
Ref: Library<70>-Footnote-233120100
Ref: Library<70>-Footnote-243120144
Ref: Library<70>-Footnote-253120188
Ref: Library<70>-Footnote-263120232
Ref: Library<70>-Footnote-273120276
Ref: Library<70>-Footnote-283120320
Ref: Library<70>-Footnote-293120364
Ref: Library<70>-Footnote-303120408
Ref: Library<70>-Footnote-313120452
Ref: Library<70>-Footnote-323120496
Ref: Library<70>-Footnote-333120540
Ref: Library<70>-Footnote-343120584
Ref: Library<70>-Footnote-353120628
Ref: Library<70>-Footnote-363120672
Ref: Library<70>-Footnote-373120716
Node: Build<47>3120760
Ref: whatsnew/changelog id4343120864
Ref: 11253120864
Ref: Build<47>-Footnote-13121133
Ref: Build<47>-Footnote-23121176
Node: C API<31>3121219
Ref: whatsnew/changelog id4353121323
Ref: 11263121323
Ref: C API<31>-Footnote-13121503
Node: Windows<41>3121546
Ref: whatsnew/changelog id4363121632
Ref: 11273121632
Ref: Windows<41>-Footnote-13121927
Ref: Windows<41>-Footnote-23121970
Ref: Windows<41>-Footnote-33122019
Node: Python 3 5 0 alpha 13122062
Ref: whatsnew/changelog python-3-5-0-alpha-13122157
Ref: 11283122157
Node: Core and Builtins<57>3122492
Ref: whatsnew/changelog id4373122590
Ref: 11293122590
Ref: Core and Builtins<57>-Footnote-13132518
Ref: Core and Builtins<57>-Footnote-23132561
Ref: Core and Builtins<57>-Footnote-33132604
Ref: Core and Builtins<57>-Footnote-43132647
Ref: Core and Builtins<57>-Footnote-53132690
Ref: Core and Builtins<57>-Footnote-63132733
Ref: Core and Builtins<57>-Footnote-73132776
Ref: Core and Builtins<57>-Footnote-83132819
Ref: Core and Builtins<57>-Footnote-93132862
Ref: Core and Builtins<57>-Footnote-103132905
Ref: Core and Builtins<57>-Footnote-113132949
Ref: Core and Builtins<57>-Footnote-123132993
Ref: Core and Builtins<57>-Footnote-133133037
Ref: Core and Builtins<57>-Footnote-143133081
Ref: Core and Builtins<57>-Footnote-153133125
Ref: Core and Builtins<57>-Footnote-163133169
Ref: Core and Builtins<57>-Footnote-173133213
Ref: Core and Builtins<57>-Footnote-183133257
Ref: Core and Builtins<57>-Footnote-193133301
Ref: Core and Builtins<57>-Footnote-203133345
Ref: Core and Builtins<57>-Footnote-213133389
Ref: Core and Builtins<57>-Footnote-223133433
Ref: Core and Builtins<57>-Footnote-233133477
Ref: Core and Builtins<57>-Footnote-243133521
Ref: Core and Builtins<57>-Footnote-253133565
Ref: Core and Builtins<57>-Footnote-263133609
Ref: Core and Builtins<57>-Footnote-273133653
Ref: Core and Builtins<57>-Footnote-283133697
Ref: Core and Builtins<57>-Footnote-293133741
Ref: Core and Builtins<57>-Footnote-303133785
Ref: Core and Builtins<57>-Footnote-313133829
Ref: Core and Builtins<57>-Footnote-323133873
Ref: Core and Builtins<57>-Footnote-333133917
Ref: Core and Builtins<57>-Footnote-343133963
Ref: Core and Builtins<57>-Footnote-353134007
Ref: Core and Builtins<57>-Footnote-363134051
Ref: Core and Builtins<57>-Footnote-373134095
Ref: Core and Builtins<57>-Footnote-383134139
Ref: Core and Builtins<57>-Footnote-393134183
Ref: Core and Builtins<57>-Footnote-403134227
Ref: Core and Builtins<57>-Footnote-413134271
Ref: Core and Builtins<57>-Footnote-423134315
Ref: Core and Builtins<57>-Footnote-433134359
Ref: Core and Builtins<57>-Footnote-443134403
Ref: Core and Builtins<57>-Footnote-453134447
Ref: Core and Builtins<57>-Footnote-463134491
Ref: Core and Builtins<57>-Footnote-473134535
Ref: Core and Builtins<57>-Footnote-483134579
Ref: Core and Builtins<57>-Footnote-493134623
Ref: Core and Builtins<57>-Footnote-503134667
Ref: Core and Builtins<57>-Footnote-513134711
Ref: Core and Builtins<57>-Footnote-523134755
Ref: Core and Builtins<57>-Footnote-533134799
Ref: Core and Builtins<57>-Footnote-543134843
Ref: Core and Builtins<57>-Footnote-553134887
Ref: Core and Builtins<57>-Footnote-563134931
Ref: Core and Builtins<57>-Footnote-573134975
Ref: Core and Builtins<57>-Footnote-583135019
Ref: Core and Builtins<57>-Footnote-593135063
Ref: Core and Builtins<57>-Footnote-603135107
Ref: Core and Builtins<57>-Footnote-613135151
Ref: Core and Builtins<57>-Footnote-623135195
Ref: Core and Builtins<57>-Footnote-633135239
Ref: Core and Builtins<57>-Footnote-643135283
Ref: Core and Builtins<57>-Footnote-653135327
Ref: Core and Builtins<57>-Footnote-663135371
Ref: Core and Builtins<57>-Footnote-673135414
Ref: Core and Builtins<57>-Footnote-683135458
Ref: Core and Builtins<57>-Footnote-693135502
Ref: Core and Builtins<57>-Footnote-703135546
Ref: Core and Builtins<57>-Footnote-713135590
Ref: Core and Builtins<57>-Footnote-723135634
Ref: Core and Builtins<57>-Footnote-733135677
Node: Library<71>3135721
Ref: whatsnew/changelog id4383135836
Ref: 112a3135836
Ref: Library<71>-Footnote-13188293
Ref: Library<71>-Footnote-23188336
Ref: Library<71>-Footnote-33188379
Ref: Library<71>-Footnote-43188422
Ref: Library<71>-Footnote-53188465
Ref: Library<71>-Footnote-63188508
Ref: Library<71>-Footnote-73188551
Ref: Library<71>-Footnote-83188594
Ref: Library<71>-Footnote-93188637
Ref: Library<71>-Footnote-103188680
Ref: Library<71>-Footnote-113188724
Ref: Library<71>-Footnote-123188768
Ref: Library<71>-Footnote-133188812
Ref: Library<71>-Footnote-143188856
Ref: Library<71>-Footnote-153188900
Ref: Library<71>-Footnote-163188944
Ref: Library<71>-Footnote-173188988
Ref: Library<71>-Footnote-183189032
Ref: Library<71>-Footnote-193189076
Ref: Library<71>-Footnote-203189120
Ref: Library<71>-Footnote-213189164
Ref: Library<71>-Footnote-223189208
Ref: Library<71>-Footnote-233189252
Ref: Library<71>-Footnote-243189296
Ref: Library<71>-Footnote-253189340
Ref: Library<71>-Footnote-263189384
Ref: Library<71>-Footnote-273189428
Ref: Library<71>-Footnote-283189472
Ref: Library<71>-Footnote-293189516
Ref: Library<71>-Footnote-303189560
Ref: Library<71>-Footnote-313189604
Ref: Library<71>-Footnote-323189648
Ref: Library<71>-Footnote-333189692
Ref: Library<71>-Footnote-343189736
Ref: Library<71>-Footnote-353189780
Ref: Library<71>-Footnote-363189824
Ref: Library<71>-Footnote-373189868
Ref: Library<71>-Footnote-383189912
Ref: Library<71>-Footnote-393189956
Ref: Library<71>-Footnote-403190000
Ref: Library<71>-Footnote-413190044
Ref: Library<71>-Footnote-423190088
Ref: Library<71>-Footnote-433190132
Ref: Library<71>-Footnote-443190176
Ref: Library<71>-Footnote-453190220
Ref: Library<71>-Footnote-463190264
Ref: Library<71>-Footnote-473190308
Ref: Library<71>-Footnote-483190352
Ref: Library<71>-Footnote-493190396
Ref: Library<71>-Footnote-503190440
Ref: Library<71>-Footnote-513190484
Ref: Library<71>-Footnote-523190528
Ref: Library<71>-Footnote-533190572
Ref: Library<71>-Footnote-543190616
Ref: Library<71>-Footnote-553190660
Ref: Library<71>-Footnote-563190706
Ref: Library<71>-Footnote-573190750
Ref: Library<71>-Footnote-583190794
Ref: Library<71>-Footnote-593190838
Ref: Library<71>-Footnote-603190882
Ref: Library<71>-Footnote-613190926
Ref: Library<71>-Footnote-623190970
Ref: Library<71>-Footnote-633191014
Ref: Library<71>-Footnote-643191058
Ref: Library<71>-Footnote-653191102
Ref: Library<71>-Footnote-663191146
Ref: Library<71>-Footnote-673191190
Ref: Library<71>-Footnote-683191234
Ref: Library<71>-Footnote-693191278
Ref: Library<71>-Footnote-703191322
Ref: Library<71>-Footnote-713191366
Ref: Library<71>-Footnote-723191410
Ref: Library<71>-Footnote-733191454
Ref: Library<71>-Footnote-743191498
Ref: Library<71>-Footnote-753191542
Ref: Library<71>-Footnote-763191586
Ref: Library<71>-Footnote-773191630
Ref: Library<71>-Footnote-783191674
Ref: Library<71>-Footnote-793191718
Ref: Library<71>-Footnote-803191762
Ref: Library<71>-Footnote-813191806
Ref: Library<71>-Footnote-823191850
Ref: Library<71>-Footnote-833191894
Ref: Library<71>-Footnote-843191938
Ref: Library<71>-Footnote-853191982
Ref: Library<71>-Footnote-863192026
Ref: Library<71>-Footnote-873192070
Ref: Library<71>-Footnote-883192114
Ref: Library<71>-Footnote-893192158
Ref: Library<71>-Footnote-903192202
Ref: Library<71>-Footnote-913192246
Ref: Library<71>-Footnote-923192290
Ref: Library<71>-Footnote-933192334
Ref: Library<71>-Footnote-943192378
Ref: Library<71>-Footnote-953192422
Ref: Library<71>-Footnote-963192465
Ref: Library<71>-Footnote-973192509
Ref: Library<71>-Footnote-983192553
Ref: Library<71>-Footnote-993192597
Ref: Library<71>-Footnote-1003192640
Ref: Library<71>-Footnote-1013192685
Ref: Library<71>-Footnote-1023192730
Ref: Library<71>-Footnote-1033192775
Ref: Library<71>-Footnote-1043192820
Ref: Library<71>-Footnote-1053192865
Ref: Library<71>-Footnote-1063192910
Ref: Library<71>-Footnote-1073192954
Ref: Library<71>-Footnote-1083192998
Ref: Library<71>-Footnote-1093193043
Ref: Library<71>-Footnote-1103193088
Ref: Library<71>-Footnote-1113193133
Ref: Library<71>-Footnote-1123193178
Ref: Library<71>-Footnote-1133193223
Ref: Library<71>-Footnote-1143193268
Ref: Library<71>-Footnote-1153193313
Ref: Library<71>-Footnote-1163193358
Ref: Library<71>-Footnote-1173193403
Ref: Library<71>-Footnote-1183193448
Ref: Library<71>-Footnote-1193193493
Ref: Library<71>-Footnote-1203193538
Ref: Library<71>-Footnote-1213193585
Ref: Library<71>-Footnote-1223193630
Ref: Library<71>-Footnote-1233193675
Ref: Library<71>-Footnote-1243193720
Ref: Library<71>-Footnote-1253193765
Ref: Library<71>-Footnote-1263193810
Ref: Library<71>-Footnote-1273193855
Ref: Library<71>-Footnote-1283193900
Ref: Library<71>-Footnote-1293193945
Ref: Library<71>-Footnote-1303193990
Ref: Library<71>-Footnote-1313194035
Ref: Library<71>-Footnote-1323194080
Ref: Library<71>-Footnote-1333194125
Ref: Library<71>-Footnote-1343194170
Ref: Library<71>-Footnote-1353194215
Ref: Library<71>-Footnote-1363194260
Ref: Library<71>-Footnote-1373194305
Ref: Library<71>-Footnote-1383194350
Ref: Library<71>-Footnote-1393194395
Ref: Library<71>-Footnote-1403194440
Ref: Library<71>-Footnote-1413194485
Ref: Library<71>-Footnote-1423194529
Ref: Library<71>-Footnote-1433194573
Ref: Library<71>-Footnote-1443194618
Ref: Library<71>-Footnote-1453194663
Ref: Library<71>-Footnote-1463194708
Ref: Library<71>-Footnote-1473194753
Ref: Library<71>-Footnote-1483194798
Ref: Library<71>-Footnote-1493194843
Ref: Library<71>-Footnote-1503194888
Ref: Library<71>-Footnote-1513194933
Ref: Library<71>-Footnote-1523194978
Ref: Library<71>-Footnote-1533195023
Ref: Library<71>-Footnote-1543195068
Ref: Library<71>-Footnote-1553195113
Ref: Library<71>-Footnote-1563195158
Ref: Library<71>-Footnote-1573195202
Ref: Library<71>-Footnote-1583195247
Ref: Library<71>-Footnote-1593195292
Ref: Library<71>-Footnote-1603195337
Ref: Library<71>-Footnote-1613195382
Ref: Library<71>-Footnote-1623195427
Ref: Library<71>-Footnote-1633195472
Ref: Library<71>-Footnote-1643195517
Ref: Library<71>-Footnote-1653195562
Ref: Library<71>-Footnote-1663195607
Ref: Library<71>-Footnote-1673195652
Ref: Library<71>-Footnote-1683195697
Ref: Library<71>-Footnote-1693195742
Ref: Library<71>-Footnote-1703195787
Ref: Library<71>-Footnote-1713195832
Ref: Library<71>-Footnote-1723195877
Ref: Library<71>-Footnote-1733195922
Ref: Library<71>-Footnote-1743195967
Ref: Library<71>-Footnote-1753196012
Ref: Library<71>-Footnote-1763196057
Ref: Library<71>-Footnote-1773196102
Ref: Library<71>-Footnote-1783196147
Ref: Library<71>-Footnote-1793196192
Ref: Library<71>-Footnote-1803196237
Ref: Library<71>-Footnote-1813196282
Ref: Library<71>-Footnote-1823196327
Ref: Library<71>-Footnote-1833196372
Ref: Library<71>-Footnote-1843196417
Ref: Library<71>-Footnote-1853196462
Ref: Library<71>-Footnote-1863196507
Ref: Library<71>-Footnote-1873196552
Ref: Library<71>-Footnote-1883196596
Ref: Library<71>-Footnote-1893196641
Ref: Library<71>-Footnote-1903196686
Ref: Library<71>-Footnote-1913196731
Ref: Library<71>-Footnote-1923196776
Ref: Library<71>-Footnote-1933196821
Ref: Library<71>-Footnote-1943196866
Ref: Library<71>-Footnote-1953196911
Ref: Library<71>-Footnote-1963196955
Ref: Library<71>-Footnote-1973197000
Ref: Library<71>-Footnote-1983197045
Ref: Library<71>-Footnote-1993197090
Ref: Library<71>-Footnote-2003197135
Ref: Library<71>-Footnote-2013197180
Ref: Library<71>-Footnote-2023197225
Ref: Library<71>-Footnote-2033197269
Ref: Library<71>-Footnote-2043197314
Ref: Library<71>-Footnote-2053197359
Ref: Library<71>-Footnote-2063197404
Ref: Library<71>-Footnote-2073197449
Ref: Library<71>-Footnote-2083197494
Ref: Library<71>-Footnote-2093197539
Ref: Library<71>-Footnote-2103197584
Ref: Library<71>-Footnote-2113197629
Ref: Library<71>-Footnote-2123197674
Ref: Library<71>-Footnote-2133197719
Ref: Library<71>-Footnote-2143197764
Ref: Library<71>-Footnote-2153197809
Ref: Library<71>-Footnote-2163197854
Ref: Library<71>-Footnote-2173197899
Ref: Library<71>-Footnote-2183197944
Ref: Library<71>-Footnote-2193197989
Ref: Library<71>-Footnote-2203198034
Ref: Library<71>-Footnote-2213198079
Ref: Library<71>-Footnote-2223198124
Ref: Library<71>-Footnote-2233198169
Ref: Library<71>-Footnote-2243198213
Ref: Library<71>-Footnote-2253198257
Ref: Library<71>-Footnote-2263198302
Ref: Library<71>-Footnote-2273198347
Ref: Library<71>-Footnote-2283198392
Ref: Library<71>-Footnote-2293198437
Ref: Library<71>-Footnote-2303198482
Ref: Library<71>-Footnote-2313198527
Ref: Library<71>-Footnote-2323198572
Ref: Library<71>-Footnote-2333198617
Ref: Library<71>-Footnote-2343198662
Ref: Library<71>-Footnote-2353198707
Ref: Library<71>-Footnote-2363198752
Ref: Library<71>-Footnote-2373198797
Ref: Library<71>-Footnote-2383198842
Ref: Library<71>-Footnote-2393198887
Ref: Library<71>-Footnote-2403198932
Ref: Library<71>-Footnote-2413198977
Ref: Library<71>-Footnote-2423199022
Ref: Library<71>-Footnote-2433199067
Ref: Library<71>-Footnote-2443199112
Ref: Library<71>-Footnote-2453199156
Ref: Library<71>-Footnote-2463199201
Ref: Library<71>-Footnote-2473199246
Ref: Library<71>-Footnote-2483199291
Ref: Library<71>-Footnote-2493199336
Ref: Library<71>-Footnote-2503199381
Ref: Library<71>-Footnote-2513199426
Ref: Library<71>-Footnote-2523199471
Ref: Library<71>-Footnote-2533199516
Ref: Library<71>-Footnote-2543199561
Ref: Library<71>-Footnote-2553199606
Ref: Library<71>-Footnote-2563199651
Ref: Library<71>-Footnote-2573199696
Ref: Library<71>-Footnote-2583199741
Ref: Library<71>-Footnote-2593199786
Ref: Library<71>-Footnote-2603199831
Ref: Library<71>-Footnote-2613199876
Ref: Library<71>-Footnote-2623199921
Ref: Library<71>-Footnote-2633199966
Ref: Library<71>-Footnote-2643200011
Ref: Library<71>-Footnote-2653200056
Ref: Library<71>-Footnote-2663200101
Ref: Library<71>-Footnote-2673200146
Ref: Library<71>-Footnote-2683200191
Ref: Library<71>-Footnote-2693200236
Ref: Library<71>-Footnote-2703200281
Ref: Library<71>-Footnote-2713200326
Ref: Library<71>-Footnote-2723200371
Ref: Library<71>-Footnote-2733200416
Ref: Library<71>-Footnote-2743200461
Ref: Library<71>-Footnote-2753200506
Ref: Library<71>-Footnote-2763200551
Ref: Library<71>-Footnote-2773200595
Ref: Library<71>-Footnote-2783200640
Ref: Library<71>-Footnote-2793200685
Ref: Library<71>-Footnote-2803200730
Ref: Library<71>-Footnote-2813200775
Ref: Library<71>-Footnote-2823200820
Ref: Library<71>-Footnote-2833200865
Ref: Library<71>-Footnote-2843200910
Ref: Library<71>-Footnote-2853200955
Ref: Library<71>-Footnote-2863201000
Ref: Library<71>-Footnote-2873201045
Ref: Library<71>-Footnote-2883201090
Ref: Library<71>-Footnote-2893201141
Ref: Library<71>-Footnote-2903201186
Ref: Library<71>-Footnote-2913201231
Ref: Library<71>-Footnote-2923201276
Ref: Library<71>-Footnote-2933201321
Ref: Library<71>-Footnote-2943201366
Ref: Library<71>-Footnote-2953201411
Ref: Library<71>-Footnote-2963201456
Ref: Library<71>-Footnote-2973201501
Ref: Library<71>-Footnote-2983201546
Ref: Library<71>-Footnote-2993201591
Ref: Library<71>-Footnote-3003201636
Ref: Library<71>-Footnote-3013201681
Ref: Library<71>-Footnote-3023201726
Ref: Library<71>-Footnote-3033201771
Ref: Library<71>-Footnote-3043201816
Ref: Library<71>-Footnote-3053201861
Ref: Library<71>-Footnote-3063201906
Ref: Library<71>-Footnote-3073201951
Ref: Library<71>-Footnote-3083201996
Ref: Library<71>-Footnote-3093202041
Ref: Library<71>-Footnote-3103202086
Ref: Library<71>-Footnote-3113202131
Ref: Library<71>-Footnote-3123202176
Ref: Library<71>-Footnote-3133202221
Ref: Library<71>-Footnote-3143202266
Ref: Library<71>-Footnote-3153202310
Ref: Library<71>-Footnote-3163202355
Ref: Library<71>-Footnote-3173202400
Ref: Library<71>-Footnote-3183202445
Ref: Library<71>-Footnote-3193202490
Ref: Library<71>-Footnote-3203202535
Ref: Library<71>-Footnote-3213202580
Ref: Library<71>-Footnote-3223202625
Ref: Library<71>-Footnote-3233202670
Ref: Library<71>-Footnote-3243202715
Ref: Library<71>-Footnote-3253202760
Ref: Library<71>-Footnote-3263202805
Ref: Library<71>-Footnote-3273202850
Ref: Library<71>-Footnote-3283202895
Ref: Library<71>-Footnote-3293202940
Ref: Library<71>-Footnote-3303202985
Ref: Library<71>-Footnote-3313203030
Ref: Library<71>-Footnote-3323203075
Ref: Library<71>-Footnote-3333203120
Ref: Library<71>-Footnote-3343203165
Ref: Library<71>-Footnote-3353203209
Ref: Library<71>-Footnote-3363203254
Ref: Library<71>-Footnote-3373203299
Ref: Library<71>-Footnote-3383203344
Ref: Library<71>-Footnote-3393203389
Ref: Library<71>-Footnote-3403203434
Ref: Library<71>-Footnote-3413203479
Ref: Library<71>-Footnote-3423203524
Ref: Library<71>-Footnote-3433203569
Ref: Library<71>-Footnote-3443203614
Ref: Library<71>-Footnote-3453203659
Ref: Library<71>-Footnote-3463203704
Ref: Library<71>-Footnote-3473203749
Ref: Library<71>-Footnote-3483203794
Ref: Library<71>-Footnote-3493203839
Ref: Library<71>-Footnote-3503203884
Ref: Library<71>-Footnote-3513203929
Ref: Library<71>-Footnote-3523203974
Ref: Library<71>-Footnote-3533204019
Ref: Library<71>-Footnote-3543204064
Ref: Library<71>-Footnote-3553204109
Ref: Library<71>-Footnote-3563204154
Ref: Library<71>-Footnote-3573204199
Ref: Library<71>-Footnote-3583204244
Ref: Library<71>-Footnote-3593204289
Ref: Library<71>-Footnote-3603204334
Ref: Library<71>-Footnote-3613204379
Ref: Library<71>-Footnote-3623204424
Ref: Library<71>-Footnote-3633204469
Ref: Library<71>-Footnote-3643204514
Ref: Library<71>-Footnote-3653204559
Ref: Library<71>-Footnote-3663204604
Ref: Library<71>-Footnote-3673204649
Ref: Library<71>-Footnote-3683204694
Ref: Library<71>-Footnote-3693204739
Ref: Library<71>-Footnote-3703204784
Ref: Library<71>-Footnote-3713204828
Ref: Library<71>-Footnote-3723204873
Ref: Library<71>-Footnote-3733204918
Ref: Library<71>-Footnote-3743204963
Ref: Library<71>-Footnote-3753205008
Ref: Library<71>-Footnote-3763205053
Ref: Library<71>-Footnote-3773205098
Ref: Library<71>-Footnote-3783205143
Ref: Library<71>-Footnote-3793205188
Ref: Library<71>-Footnote-3803205233
Ref: Library<71>-Footnote-3813205278
Ref: Library<71>-Footnote-3823205323
Ref: Library<71>-Footnote-3833205368
Ref: Library<71>-Footnote-3843205412
Ref: Library<71>-Footnote-3853205457
Ref: Library<71>-Footnote-3863205502
Ref: Library<71>-Footnote-3873205547
Ref: Library<71>-Footnote-3883205592
Ref: Library<71>-Footnote-3893205635
Ref: Library<71>-Footnote-3903205680
Ref: Library<71>-Footnote-3913205725
Ref: Library<71>-Footnote-3923205770
Ref: Library<71>-Footnote-3933205815
Ref: Library<71>-Footnote-3943205860
Ref: Library<71>-Footnote-3953205905
Ref: Library<71>-Footnote-3963205950
Node: IDLE<40>3205995
Ref: whatsnew/changelog id4393206098
Ref: 112b3206098
Ref: IDLE<40>-Footnote-13209594
Ref: IDLE<40>-Footnote-23209637
Ref: IDLE<40>-Footnote-33209680
Ref: IDLE<40>-Footnote-43209722
Ref: IDLE<40>-Footnote-53209765
Ref: IDLE<40>-Footnote-63209807
Ref: IDLE<40>-Footnote-73209850
Ref: IDLE<40>-Footnote-83209893
Ref: IDLE<40>-Footnote-93209936
Ref: IDLE<40>-Footnote-103209979
Ref: IDLE<40>-Footnote-113210023
Ref: IDLE<40>-Footnote-123210067
Ref: IDLE<40>-Footnote-133210111
Ref: IDLE<40>-Footnote-143210155
Ref: IDLE<40>-Footnote-153210199
Ref: IDLE<40>-Footnote-163210243
Ref: IDLE<40>-Footnote-173210287
Ref: IDLE<40>-Footnote-183210331
Ref: IDLE<40>-Footnote-193210375
Ref: IDLE<40>-Footnote-203210419
Ref: IDLE<40>-Footnote-213210463
Ref: IDLE<40>-Footnote-223210507
Ref: IDLE<40>-Footnote-233210551
Ref: IDLE<40>-Footnote-243210601
Ref: IDLE<40>-Footnote-253210645
Ref: IDLE<40>-Footnote-263210689
Node: Build<48>3210733
Ref: whatsnew/changelog id4403210834
Ref: 112c3210834
Ref: Build<48>-Footnote-13214264
Ref: Build<48>-Footnote-23214307
Ref: Build<48>-Footnote-33214350
Ref: Build<48>-Footnote-43214393
Ref: Build<48>-Footnote-53214436
Ref: Build<48>-Footnote-63214479
Ref: Build<48>-Footnote-73214522
Ref: Build<48>-Footnote-83214565
Ref: Build<48>-Footnote-93214608
Ref: Build<48>-Footnote-103214651
Ref: Build<48>-Footnote-113214695
Ref: Build<48>-Footnote-123214739
Ref: Build<48>-Footnote-133214783
Ref: Build<48>-Footnote-143214827
Ref: Build<48>-Footnote-153214871
Ref: Build<48>-Footnote-163214915
Ref: Build<48>-Footnote-173214959
Ref: Build<48>-Footnote-183215003
Ref: Build<48>-Footnote-193215047
Ref: Build<48>-Footnote-203215091
Ref: Build<48>-Footnote-213215135
Ref: Build<48>-Footnote-223215179
Ref: Build<48>-Footnote-233215223
Ref: Build<48>-Footnote-243215267
Ref: Build<48>-Footnote-253215311
Ref: Build<48>-Footnote-263215355
Node: C API<32>3215399
Ref: whatsnew/changelog id4413215509
Ref: 112d3215509
Ref: C API<32>-Footnote-13216874
Ref: C API<32>-Footnote-23216917
Ref: C API<32>-Footnote-33216960
Ref: C API<32>-Footnote-43217003
Ref: C API<32>-Footnote-53217046
Ref: C API<32>-Footnote-63217089
Ref: C API<32>-Footnote-73217132
Node: Documentation<41>3217175
Ref: whatsnew/changelog id4423217285
Ref: 112e3217285
Ref: Documentation<41>-Footnote-13219092
Ref: Documentation<41>-Footnote-23219135
Ref: Documentation<41>-Footnote-33219178
Ref: Documentation<41>-Footnote-43219221
Ref: Documentation<41>-Footnote-53219264
Ref: Documentation<41>-Footnote-63219306
Ref: Documentation<41>-Footnote-73219349
Ref: Documentation<41>-Footnote-83219392
Ref: Documentation<41>-Footnote-93219435
Ref: Documentation<41>-Footnote-103219478
Ref: Documentation<41>-Footnote-113219522
Node: Tests<46>3219566
Ref: whatsnew/changelog id4433219682
Ref: 112f3219682
Ref: Tests<46>-Footnote-13223873
Ref: Tests<46>-Footnote-23223916
Ref: Tests<46>-Footnote-33223959
Ref: Tests<46>-Footnote-43224002
Ref: Tests<46>-Footnote-53224045
Ref: Tests<46>-Footnote-63224088
Ref: Tests<46>-Footnote-73224131
Ref: Tests<46>-Footnote-83224174
Ref: Tests<46>-Footnote-93224217
Ref: Tests<46>-Footnote-103224260
Ref: Tests<46>-Footnote-113224304
Ref: Tests<46>-Footnote-123224348
Ref: Tests<46>-Footnote-133224392
Ref: Tests<46>-Footnote-143224436
Ref: Tests<46>-Footnote-153224479
Ref: Tests<46>-Footnote-163224523
Ref: Tests<46>-Footnote-173224567
Ref: Tests<46>-Footnote-183224611
Ref: Tests<46>-Footnote-193224655
Ref: Tests<46>-Footnote-203224699
Ref: Tests<46>-Footnote-213224743
Ref: Tests<46>-Footnote-223224787
Ref: Tests<46>-Footnote-233224831
Ref: Tests<46>-Footnote-243224875
Ref: Tests<46>-Footnote-253224919
Ref: Tests<46>-Footnote-263224963
Ref: Tests<46>-Footnote-273225007
Ref: Tests<46>-Footnote-283225051
Ref: Tests<46>-Footnote-293225095
Ref: Tests<46>-Footnote-303225139
Ref: Tests<46>-Footnote-313225183
Ref: Tests<46>-Footnote-323225227
Ref: Tests<46>-Footnote-333225271
Ref: Tests<46>-Footnote-343225315
Ref: Tests<46>-Footnote-353225359
Ref: Tests<46>-Footnote-363225403
Ref: Tests<46>-Footnote-373225447
Node: Tools/Demos<32>3225491
Ref: whatsnew/changelog id4443225601
Ref: 11303225601
Ref: Tools/Demos<32>-Footnote-13227273
Ref: Tools/Demos<32>-Footnote-23227316
Ref: Tools/Demos<32>-Footnote-33227359
Ref: Tools/Demos<32>-Footnote-43227402
Ref: Tools/Demos<32>-Footnote-53227445
Ref: Tools/Demos<32>-Footnote-63227488
Ref: Tools/Demos<32>-Footnote-73227531
Ref: Tools/Demos<32>-Footnote-83227574
Ref: Tools/Demos<32>-Footnote-93227617
Ref: Tools/Demos<32>-Footnote-103227660
Ref: Tools/Demos<32>-Footnote-113227710
Ref: Tools/Demos<32>-Footnote-123227754
Ref: Tools/Demos<32>-Footnote-133227798
Node: Windows<42>3227842
Ref: whatsnew/changelog id4453227934
Ref: 11313227934
Ref: Windows<42>-Footnote-13229145
Ref: Windows<42>-Footnote-23229188
Ref: Windows<42>-Footnote-33229231
Ref: Windows<42>-Footnote-43229274
Ref: Windows<42>-Footnote-53229317
Ref: Windows<42>-Footnote-63229360
Ref: Windows<42>-Footnote-73229403
Node: The Python Tutorial3229446
Ref: tutorial/index doc3229567
Ref: 11323229567
Ref: tutorial/index the-python-tutorial3229567
Ref: 11333229567
Ref: tutorial/index tutorial-index3229567
Ref: 11343229567
Node: Whetting Your Appetite3232294
Ref: tutorial/appetite doc3232409
Ref: 113a3232409
Ref: tutorial/appetite tut-intro3232409
Ref: 113b3232409
Ref: tutorial/appetite whetting-your-appetite3232409
Ref: 113c3232409
Node: Using the Python Interpreter3236927
Ref: tutorial/interpreter doc3237085
Ref: 113d3237085
Ref: tutorial/interpreter tut-using3237085
Ref: 113e3237085
Ref: tutorial/interpreter using-the-python-interpreter3237085
Ref: 113f3237085
Node: Invoking the Interpreter3237231
Ref: tutorial/interpreter invoking-the-interpreter3237364
Ref: 11403237364
Ref: tutorial/interpreter tut-invoking3237364
Ref: 11413237364
Ref: Invoking the Interpreter-Footnote-13240372
Ref: Invoking the Interpreter-Footnote-23240572
Node: Argument Passing3240633
Ref: tutorial/interpreter argument-passing3240735
Ref: 11463240735
Ref: tutorial/interpreter tut-argpassing3240735
Ref: 11473240735
Node: Interactive Mode3241645
Ref: tutorial/interpreter interactive-mode3241747
Ref: 11483241747
Ref: tutorial/interpreter tut-interactive3241747
Ref: 8d73241747
Node: The Interpreter and Its Environment3242762
Ref: tutorial/interpreter the-interpreter-and-its-environment3242895
Ref: 114a3242895
Ref: tutorial/interpreter tut-interp3242895
Ref: 114b3242895
Node: Source Code Encoding3243015
Ref: tutorial/interpreter source-code-encoding3243107
Ref: 114c3243107
Ref: tutorial/interpreter tut-source-encoding3243107
Ref: 114d3243107
Node: An Informal Introduction to Python3244343
Ref: tutorial/introduction doc3244502
Ref: 114f3244502
Ref: tutorial/introduction an-informal-introduction-to-python3244502
Ref: 11503244502
Ref: tutorial/introduction tut-informal3244502
Ref: 11513244502
Node: Using Python as a Calculator3245807
Ref: tutorial/introduction tut-calculator3245946
Ref: 11543245946
Ref: tutorial/introduction using-python-as-a-calculator3245946
Ref: 11553245946
Node: Numbers3246199
Ref: tutorial/introduction numbers3246287
Ref: 11563246287
Ref: tutorial/introduction tut-numbers3246287
Ref: 11573246287
Ref: Numbers-Footnote-13249297
Node: Strings3249497
Ref: tutorial/introduction strings3249599
Ref: 115a3249599
Ref: tutorial/introduction tut-strings3249599
Ref: 115b3249599
Ref: Strings-Footnote-13257555
Node: Lists3257863
Ref: tutorial/introduction lists3257949
Ref: 11603257949
Ref: tutorial/introduction tut-lists3257949
Ref: 11613257949
Node: First Steps Towards Programming3260550
Ref: tutorial/introduction first-steps-towards-programming3260689
Ref: 11653260689
Ref: tutorial/introduction tut-firststeps3260689
Ref: 11663260689
Ref: First Steps Towards Programming-Footnote-13263787
Node: More Control Flow Tools3263842
Ref: tutorial/controlflow doc3263988
Ref: 11683263988
Ref: tutorial/controlflow more-control-flow-tools3263988
Ref: 11693263988
Ref: tutorial/controlflow tut-morecontrol3263988
Ref: 116a3263988
Node: if Statements3264531
Ref: tutorial/controlflow if-statements3264627
Ref: 116b3264627
Ref: tutorial/controlflow tut-if3264627
Ref: 116c3264627
Node: for Statements3265444
Ref: tutorial/controlflow for-statements3265567
Ref: 116f3265567
Ref: tutorial/controlflow tut-for3265567
Ref: 11703265567
Node: The range Function3266816
Ref: tutorial/controlflow the-range-function3266981
Ref: 11713266981
Ref: tutorial/controlflow tut-range3266981
Ref: 11723266981
Node: break and continue Statements and else Clauses on Loops3269234
Ref: tutorial/controlflow break-and-continue-statements-and-else-clauses-on-loops3269400
Ref: 11753269400
Ref: tutorial/controlflow tut-break3269400
Ref: 11763269400
Node: pass Statements3271581
Ref: tutorial/controlflow pass-statements3271747
Ref: 11783271747
Ref: tutorial/controlflow tut-pass3271747
Ref: 11793271747
Node: Defining Functions3272476
Ref: tutorial/controlflow defining-functions3272613
Ref: 117b3272613
Ref: tutorial/controlflow tut-functions3272613
Ref: 117c3272613
Ref: Defining Functions-Footnote-13277616
Node: More on Defining Functions3277818
Ref: tutorial/controlflow more-on-defining-functions3277963
Ref: 11803277963
Ref: tutorial/controlflow tut-defining3277963
Ref: 11813277963
Node: Default Argument Values3278370
Ref: tutorial/controlflow default-argument-values3278482
Ref: 11823278482
Ref: tutorial/controlflow tut-defaultargs3278482
Ref: 11833278482
Node: Keyword Arguments3280493
Ref: tutorial/controlflow keyword-arguments3280632
Ref: 11843280632
Ref: tutorial/controlflow tut-keywordargs3280632
Ref: 11853280632
Node: Special parameters3284379
Ref: tutorial/controlflow special-parameters3284519
Ref: 11873284519
Node: Positional-or-Keyword Arguments3285656
Ref: tutorial/controlflow positional-or-keyword-arguments3285777
Ref: 11883285777
Node: Positional-Only Parameters3285991
Ref: tutorial/controlflow positional-only-parameters3286143
Ref: 11893286143
Node: Keyword-Only Arguments3286777
Ref: tutorial/controlflow keyword-only-arguments3286915
Ref: 118a3286915
Node: Function Examples3287166
Ref: tutorial/controlflow function-examples3287283
Ref: 118b3287283
Node: Recap3290282
Ref: tutorial/controlflow recap3290368
Ref: 118c3290368
Node: Arbitrary Argument Lists3291229
Ref: tutorial/controlflow arbitrary-argument-lists3291376
Ref: 118d3291376
Ref: tutorial/controlflow tut-arbitraryargs3291376
Ref: 118e3291376
Node: Unpacking Argument Lists3292416
Ref: tutorial/controlflow tut-unpacking-arguments3292563
Ref: 118f3292563
Ref: tutorial/controlflow unpacking-argument-lists3292563
Ref: 11903292563
Node: Lambda Expressions3293796
Ref: tutorial/controlflow lambda-expressions3293940
Ref: 11913293940
Ref: tutorial/controlflow tut-lambda3293940
Ref: 11923293940
Node: Documentation Strings3294931
Ref: tutorial/controlflow documentation-strings3295071
Ref: 11933295071
Ref: tutorial/controlflow tut-docstrings3295071
Ref: 117d3295071
Node: Function Annotations3297001
Ref: tutorial/controlflow function-annotations3297114
Ref: 11943297114
Ref: tutorial/controlflow tut-annotations3297114
Ref: 11953297114
Ref: Function Annotations-Footnote-13298329
Ref: Function Annotations-Footnote-23298378
Node: Intermezzo Coding Style3298427
Ref: tutorial/controlflow intermezzo-coding-style3298545
Ref: 11983298545
Ref: tutorial/controlflow tut-codingstyle3298545
Ref: 11993298545
Ref: Intermezzo Coding Style-Footnote-13300703
Node: Data Structures3300752
Ref: tutorial/datastructures doc3300871
Ref: 119b3300871
Ref: tutorial/datastructures data-structures3300871
Ref: 119c3300871
Ref: tutorial/datastructures tut-structures3300871
Ref: 11743300871
Node: More on Lists3301216
Ref: tutorial/datastructures more-on-lists3301307
Ref: 119d3301307
Ref: tutorial/datastructures tut-morelists3301307
Ref: 119e3301307
Ref: More on Lists-Footnote-13305172
Node: Using Lists as Stacks3305313
Ref: tutorial/datastructures tut-lists-as-stacks3305414
Ref: 119f3305414
Ref: tutorial/datastructures using-lists-as-stacks3305414
Ref: 11a03305414
Node: Using Lists as Queues3306048
Ref: tutorial/datastructures tut-lists-as-queues3306180
Ref: 11a13306180
Ref: tutorial/datastructures using-lists-as-queues3306180
Ref: 11a23306180
Node: List Comprehensions<2>3307244
Ref: tutorial/datastructures list-comprehensions3307381
Ref: 11a33307381
Ref: tutorial/datastructures tut-listcomps3307381
Ref: 11a43307381
Node: Nested List Comprehensions3310594
Ref: tutorial/datastructures nested-list-comprehensions3310701
Ref: 11a53310701
Node: The del statement3312350
Ref: tutorial/datastructures the-del-statement3312470
Ref: 11a63312470
Ref: tutorial/datastructures tut-del3312470
Ref: 11a73312470
Node: Tuples and Sequences3313322
Ref: tutorial/datastructures tuples-and-sequences3313433
Ref: 11a93313433
Ref: tutorial/datastructures tut-tuples3313433
Ref: 11863313433
Node: Sets3316466
Ref: tutorial/datastructures sets3316572
Ref: 11ab3316572
Ref: tutorial/datastructures tut-sets3316572
Ref: 11ac3316572
Node: Dictionaries3318313
Ref: tutorial/datastructures dictionaries3318417
Ref: 11ad3318417
Ref: tutorial/datastructures tut-dictionaries3318417
Ref: 11ae3318417
Node: Looping Techniques3321238
Ref: tutorial/datastructures looping-techniques3321356
Ref: 11af3321356
Ref: tutorial/datastructures tut-loopidioms3321356
Ref: 11733321356
Node: More on Conditions3323536
Ref: tutorial/datastructures more-on-conditions3323677
Ref: 11b03323677
Ref: tutorial/datastructures tut-conditions3323677
Ref: 11b13323677
Node: Comparing Sequences and Other Types3325767
Ref: tutorial/datastructures comparing-sequences-and-other-types3325881
Ref: 11b23325881
Ref: tutorial/datastructures tut-comparing3325881
Ref: 11b33325881
Node: Modules3327468
Ref: tutorial/modules doc3327580
Ref: 11b43327580
Ref: tutorial/modules modules3327580
Ref: 11b53327580
Ref: tutorial/modules tut-modules3327580
Ref: 11b63327580
Node: More on Modules3330133
Ref: tutorial/modules more-on-modules3330217
Ref: 11b73330217
Ref: tutorial/modules tut-moremodules3330217
Ref: 11b83330217
Ref: More on Modules-Footnote-13333333
Node: Executing modules as scripts3333541
Ref: tutorial/modules executing-modules-as-scripts3333652
Ref: 11b93333652
Ref: tutorial/modules tut-modulesasscripts3333652
Ref: 11ba3333652
Node: The Module Search Path3334540
Ref: tutorial/modules the-module-search-path3334687
Ref: 11bb3334687
Ref: tutorial/modules tut-searchpath3334687
Ref: 11bc3334687
Node: “Compiled” Python files3336009
Ref: tutorial/modules compiled-python-files3336119
Ref: 11be3336119
Ref: “Compiled” Python files-Footnote-13338428
Node: Standard Modules3338477
Ref: tutorial/modules standard-modules3338586
Ref: 11bf3338586
Ref: tutorial/modules tut-standardmodules3338586
Ref: 11bd3338586
Node: The dir Function3340050
Ref: tutorial/modules the-dir-function3340152
Ref: 11c03340152
Ref: tutorial/modules tut-dir3340152
Ref: 11c13340152
Node: Packages3344317
Ref: tutorial/modules packages3344394
Ref: 11c23344394
Ref: tutorial/modules tut-packages3344394
Ref: 11c33344394
Node: Importing * From a Package3348697
Ref: tutorial/modules importing-from-a-package3348801
Ref: 11c43348801
Ref: tutorial/modules tut-pkg-import-star3348801
Ref: 11c53348801
Node: Intra-package References3351443
Ref: tutorial/modules intra-package-references3351588
Ref: 11c63351588
Node: Packages in Multiple Directories3352601
Ref: tutorial/modules packages-in-multiple-directories3352711
Ref: 11c73352711
Node: Input and Output3353240
Ref: tutorial/inputoutput doc3353358
Ref: 11c93353358
Ref: tutorial/inputoutput input-and-output3353358
Ref: 11ca3353358
Ref: tutorial/inputoutput tut-io3353358
Ref: 11cb3353358
Node: Fancier Output Formatting3353667
Ref: tutorial/inputoutput fancier-output-formatting3353779
Ref: 11cc3353779
Ref: tutorial/inputoutput tut-formatting3353779
Ref: 11cd3353779
Node: Formatted String Literals3357501
Ref: tutorial/inputoutput formatted-string-literals3357621
Ref: 11cf3357621
Ref: tutorial/inputoutput tut-f-strings3357621
Ref: 11ce3357621
Node: The String format Method3359183
Ref: tutorial/inputoutput the-string-format-method3359336
Ref: 11d03359336
Ref: tutorial/inputoutput tut-string-format3359336
Ref: 11d13359336
Node: Manual String Formatting3362003
Ref: tutorial/inputoutput manual-string-formatting3362152
Ref: 11d23362152
Node: Old string formatting3363681
Ref: tutorial/inputoutput old-string-formatting3363797
Ref: 11d73363797
Node: Reading and Writing Files3364343
Ref: tutorial/inputoutput reading-and-writing-files3364455
Ref: 11d83364455
Ref: tutorial/inputoutput tut-files3364455
Ref: 11d93364455
Node: Methods of File Objects3367488
Ref: tutorial/inputoutput methods-of-file-objects3367614
Ref: 11da3367614
Ref: tutorial/inputoutput tut-filemethods3367614
Ref: 11db3367614
Node: Saving structured data with json3371308
Ref: tutorial/inputoutput saving-structured-data-with-json3371434
Ref: 11dc3371434
Ref: tutorial/inputoutput tut-json3371434
Ref: 11dd3371434
Ref: Saving structured data with json-Footnote-13374080
Node: Errors and Exceptions3374104
Ref: tutorial/errors doc3374222
Ref: 11df3374222
Ref: tutorial/errors errors-and-exceptions3374222
Ref: 11e03374222
Ref: tutorial/errors tut-errors3374222
Ref: 11e13374222
Node: Syntax Errors3374678
Ref: tutorial/errors syntax-errors3374768
Ref: 11e23374768
Ref: tutorial/errors tut-syntaxerrors3374768
Ref: 11e33374768
Node: Exceptions3375571
Ref: tutorial/errors exceptions3375689
Ref: 11e43375689
Ref: tutorial/errors tut-exceptions3375689
Ref: 11e53375689
Node: Handling Exceptions3377524
Ref: tutorial/errors handling-exceptions3377647
Ref: 11e83377647
Ref: tutorial/errors tut-handling3377647
Ref: 11773377647
Node: Raising Exceptions3383543
Ref: tutorial/errors raising-exceptions3383679
Ref: 11e93383679
Ref: tutorial/errors tut-raising3383679
Ref: 11ea3383679
Node: User-defined Exceptions3384821
Ref: tutorial/errors tut-userexceptions3384963
Ref: 11eb3384963
Ref: tutorial/errors user-defined-exceptions3384963
Ref: 11ec3384963
Node: Defining Clean-up Actions3387007
Ref: tutorial/errors defining-clean-up-actions3387158
Ref: 11ed3387158
Ref: tutorial/errors tut-cleanup3387158
Ref: 11ee3387158
Node: Predefined Clean-up Actions3390352
Ref: tutorial/errors predefined-clean-up-actions3390471
Ref: 11ef3390471
Ref: tutorial/errors tut-cleanup-with3390471
Ref: 11f03390471
Node: Classes3391590
Ref: tutorial/classes doc3391726
Ref: 11f13391726
Ref: tutorial/classes classes3391726
Ref: 11f23391726
Ref: tutorial/classes tut-classes3391726
Ref: 117f3391726
Node: A Word About Names and Objects3394040
Ref: tutorial/classes a-word-about-names-and-objects3394151
Ref: 11f43394151
Ref: tutorial/classes tut-object3394151
Ref: 11f53394151
Node: Python Scopes and Namespaces3395073
Ref: tutorial/classes python-scopes-and-namespaces3395216
Ref: 11f63395216
Ref: tutorial/classes tut-scopes3395216
Ref: 11f73395216
Ref: Python Scopes and Namespaces-Footnote-13401286
Node: Scopes and Namespaces Example3401680
Ref: tutorial/classes scopes-and-namespaces-example3401774
Ref: 11f93401774
Ref: tutorial/classes tut-scopeexample3401774
Ref: 11fa3401774
Node: A First Look at Classes3403139
Ref: tutorial/classes a-first-look-at-classes3403266
Ref: 11fb3403266
Ref: tutorial/classes tut-firstclasses3403266
Ref: 119a3403266
Node: Class Definition Syntax3403551
Ref: tutorial/classes class-definition-syntax3403656
Ref: 11fc3403656
Ref: tutorial/classes tut-classdefinition3403656
Ref: 11fd3403656
Node: Class Objects3405192
Ref: tutorial/classes class-objects3405322
Ref: 11fe3405322
Ref: tutorial/classes tut-classobjects3405322
Ref: 11ff3405322
Node: Instance Objects3407523
Ref: tutorial/classes instance-objects3407644
Ref: 12003407644
Ref: tutorial/classes tut-instanceobjects3407644
Ref: 12013407644
Node: Method Objects3409308
Ref: tutorial/classes method-objects3409444
Ref: 12023409444
Ref: tutorial/classes tut-methodobjects3409444
Ref: 12033409444
Node: Class and Instance Variables3411385
Ref: tutorial/classes class-and-instance-variables3411496
Ref: 12043411496
Ref: tutorial/classes tut-class-and-instance-variables3411496
Ref: 12053411496
Node: Random Remarks3413540
Ref: tutorial/classes random-remarks3413650
Ref: 12063413650
Ref: tutorial/classes tut-remarks3413650
Ref: 12073413650
Node: Inheritance3417477
Ref: tutorial/classes inheritance3417581
Ref: 12083417581
Ref: tutorial/classes tut-inheritance3417581
Ref: 12093417581
Node: Multiple Inheritance3420350
Ref: tutorial/classes multiple-inheritance3420418
Ref: 120a3420418
Ref: tutorial/classes tut-multiple3420418
Ref: 120b3420418
Node: Private Variables3422419
Ref: tutorial/classes private-variables3422522
Ref: 120c3422522
Ref: tutorial/classes tut-private3422522
Ref: 11f33422522
Node: Odds and Ends3425210
Ref: tutorial/classes odds-and-ends3425311
Ref: 120d3425311
Ref: tutorial/classes tut-odds3425311
Ref: 120e3425311
Node: Iterators3426316
Ref: tutorial/classes iterators3426410
Ref: 120f3426410
Ref: tutorial/classes tut-iterators3426410
Ref: 12103426410
Node: Generators3428692
Ref: tutorial/classes generators3428794
Ref: 12113428794
Ref: tutorial/classes tut-generators3428794
Ref: 12123428794
Node: Generator Expressions3430232
Ref: tutorial/classes generator-expressions3430316
Ref: 12143430316
Ref: tutorial/classes tut-genexps3430316
Ref: 12153430316
Node: Brief Tour of the Standard Library3431303
Ref: tutorial/stdlib doc3431464
Ref: 12163431464
Ref: tutorial/stdlib brief-tour-of-the-standard-library3431464
Ref: 12173431464
Ref: tutorial/stdlib tut-brieftour3431464
Ref: 12183431464
Node: Operating System Interface3431861
Ref: tutorial/stdlib operating-system-interface3431981
Ref: 12193431981
Ref: tutorial/stdlib tut-os-interface3431981
Ref: 121a3431981
Node: File Wildcards3433246
Ref: tutorial/stdlib file-wildcards3433397
Ref: 121b3433397
Ref: tutorial/stdlib tut-file-wildcards3433397
Ref: 121c3433397
Node: Command Line Arguments3433639
Ref: tutorial/stdlib command-line-arguments3433812
Ref: 121d3433812
Ref: tutorial/stdlib tut-command-line-arguments3433812
Ref: 121e3433812
Node: Error Output Redirection and Program Termination3434920
Ref: tutorial/stdlib error-output-redirection-and-program-termination3435102
Ref: 121f3435102
Ref: tutorial/stdlib tut-stderr3435102
Ref: 12203435102
Node: String Pattern Matching3435625
Ref: tutorial/stdlib string-pattern-matching3435796
Ref: 12213435796
Ref: tutorial/stdlib tut-string-pattern-matching3435796
Ref: 12223435796
Node: Mathematics3436435
Ref: tutorial/stdlib mathematics3436573
Ref: 12233436573
Ref: tutorial/stdlib tut-mathematics3436573
Ref: 12243436573
Node: Internet Access3437721
Ref: tutorial/stdlib internet-access3437851
Ref: 12253437851
Ref: tutorial/stdlib tut-internet-access3437851
Ref: 12263437851
Node: Dates and Times3438874
Ref: tutorial/stdlib dates-and-times3439009
Ref: 12273439009
Ref: tutorial/stdlib tut-dates-and-times3439009
Ref: 12283439009
Node: Data Compression3439830
Ref: tutorial/stdlib data-compression3439973
Ref: 12293439973
Ref: tutorial/stdlib tut-data-compression3439973
Ref: 122a3439973
Node: Performance Measurement3440496
Ref: tutorial/stdlib performance-measurement3440639
Ref: 122b3440639
Ref: tutorial/stdlib tut-performance-measurement3440639
Ref: 122c3440639
Node: Quality Control3441514
Ref: tutorial/stdlib quality-control3441659
Ref: 122d3441659
Ref: tutorial/stdlib tut-quality-control3441659
Ref: 122e3441659
Node: Batteries Included3443227
Ref: tutorial/stdlib batteries-included3443340
Ref: 122f3443340
Ref: tutorial/stdlib tut-batteries-included3443340
Ref: 12303443340
Ref: Batteries Included-Footnote-13445152
Node: Brief Tour of the Standard Library — Part II3445201
Ref: tutorial/stdlib2 doc3445388
Ref: 12313445388
Ref: tutorial/stdlib2 brief-tour-of-the-standard-library-part-ii3445388
Ref: 12323445388
Ref: tutorial/stdlib2 tut-brieftourtwo3445388
Ref: 12333445388
Node: Output Formatting3445862
Ref: tutorial/stdlib2 output-formatting3445981
Ref: 12343445981
Ref: tutorial/stdlib2 tut-output-formatting3445981
Ref: 12353445981
Node: Templating3448094
Ref: tutorial/stdlib2 templating3448261
Ref: 12363448261
Ref: tutorial/stdlib2 tut-templating3448261
Ref: 12373448261
Node: Working with Binary Data Record Layouts3450816
Ref: tutorial/stdlib2 tut-binary-formats3450984
Ref: 123a3450984
Ref: tutorial/stdlib2 working-with-binary-data-record-layouts3450984
Ref: 123b3450984
Node: Multi-threading<2>3452159
Ref: tutorial/stdlib2 multi-threading3452324
Ref: 123d3452324
Ref: tutorial/stdlib2 tut-multi-threading3452324
Ref: 123e3452324
Node: Logging3454267
Ref: tutorial/stdlib2 logging3454408
Ref: 123f3454408
Ref: tutorial/stdlib2 tut-logging3454408
Ref: 12403454408
Node: Weak References3455576
Ref: tutorial/stdlib2 tut-weak-references3455727
Ref: 12413455727
Ref: tutorial/stdlib2 weak-references3455727
Ref: 12423455727
Node: Tools for Working with Lists3457484
Ref: tutorial/stdlib2 tools-for-working-with-lists3457661
Ref: 12443457661
Ref: tutorial/stdlib2 tut-list-tools3457661
Ref: 12453457661
Node: Decimal Floating Point Arithmetic3460115
Ref: tutorial/stdlib2 decimal-floating-point-arithmetic3460268
Ref: 12463460268
Ref: tutorial/stdlib2 tut-decimal-fp3460268
Ref: 12473460268
Node: Virtual Environments and Packages3462165
Ref: tutorial/venv doc3462327
Ref: 12483462327
Ref: tutorial/venv tut-venv3462327
Ref: 12493462327
Ref: tutorial/venv virtual-environments-and-packages3462327
Ref: 124a3462327
Node: Introduction<4>3462514
Ref: tutorial/venv introduction3462637
Ref: 124b3462637
Node: Creating Virtual Environments3463959
Ref: tutorial/venv creating-virtual-environments3464117
Ref: 124d3464117
Node: Managing Packages with pip3466180
Ref: tutorial/venv managing-packages-with-pip3466314
Ref: 124e3466314
Node: What Now?3470676
Ref: tutorial/whatnow doc3470842
Ref: 124f3470842
Ref: tutorial/whatnow tut-whatnow3470842
Ref: 12503470842
Ref: tutorial/whatnow what-now3470842
Ref: 12513470842
Ref: What Now?-Footnote-13474309
Node: Interactive Input Editing and History Substitution3474466
Ref: tutorial/interactive doc3474647
Ref: 12533474647
Ref: tutorial/interactive interactive-input-editing-and-history-substitution3474647
Ref: 12543474647
Ref: tutorial/interactive tut-interacting3474647
Ref: 11443474647
Ref: Interactive Input Editing and History Substitution-Footnote-13475243
Node: Tab Completion and History Editing3475304
Ref: tutorial/interactive tab-completion-and-history-editing3475477
Ref: 12553475477
Ref: tutorial/interactive tut-keybindings3475477
Ref: 12563475477
Node: Alternatives to the Interactive Interpreter3476332
Ref: tutorial/interactive alternatives-to-the-interactive-interpreter3476505
Ref: 12573476505
Ref: tutorial/interactive tut-commentary3476505
Ref: 12583476505
Ref: Alternatives to the Interactive Interpreter-Footnote-13477399
Ref: Alternatives to the Interactive Interpreter-Footnote-23477428
Node: Floating Point Arithmetic Issues and Limitations3477473
Ref: tutorial/floatingpoint doc3477653
Ref: 12593477653
Ref: tutorial/floatingpoint bpython3477653
Ref: 125a3477653
Ref: tutorial/floatingpoint floating-point-arithmetic-issues-and-limitations3477653
Ref: 125b3477653
Ref: tutorial/floatingpoint tut-fp-issues3477653
Ref: 125c3477653
Ref: Floating Point Arithmetic Issues and Limitations-Footnote-13485743
Node: Representation Error3485782
Ref: tutorial/floatingpoint representation-error3485887
Ref: 125f3485887
Ref: tutorial/floatingpoint tut-fp-error3485887
Ref: 12603485887
Node: Appendix3489093
Ref: tutorial/appendix doc3489214
Ref: 12613489214
Ref: tutorial/appendix appendix3489214
Ref: 12623489214
Ref: tutorial/appendix tut-appendix3489214
Ref: 12633489214
Node: Interactive Mode<2>3489294
Ref: tutorial/appendix interactive-mode3489358
Ref: 12643489358
Ref: tutorial/appendix tut-interac3489358
Ref: 11493489358
Node: Error Handling3489529
Ref: tutorial/appendix error-handling3489633
Ref: 12653489633
Ref: tutorial/appendix tut-error3489633
Ref: 12663489633
Ref: Error Handling-Footnote-13490686
Node: Executable Python Scripts3490756
Ref: tutorial/appendix executable-python-scripts3490897
Ref: 12673490897
Ref: tutorial/appendix tut-scripts3490897
Ref: 114e3490897
Node: The Interactive Startup File3491979
Ref: tutorial/appendix the-interactive-startup-file3492131
Ref: 12683492131
Ref: tutorial/appendix tut-startup3492131
Ref: 12693492131
Node: The Customization Modules3493567
Ref: tutorial/appendix the-customization-modules3493685
Ref: 126a3493685
Ref: tutorial/appendix tut-customize3493685
Ref: 126b3493685
Node: Python Setup and Usage3494588
Ref: using/index doc3494716
Ref: 126c3494716
Ref: using/index python-setup-and-usage3494716
Ref: 126d3494716
Ref: using/index using-index3494716
Ref: 126e3494716
Node: Command line and environment3495138
Ref: using/cmdline doc3495264
Ref: 126f3495264
Ref: using/cmdline command-line-and-environment3495264
Ref: 12703495264
Ref: using/cmdline using-on-general3495264
Ref: edb3495264
Node: Command line3495633
Ref: using/cmdline command-line3495740
Ref: 12723495740
Ref: using/cmdline using-on-cmdline3495740
Ref: 91f3495740
Node: Interface options3496134
Ref: using/cmdline interface-options3496224
Ref: 12733496224
Ref: using/cmdline using-on-interface-options3496224
Ref: 12743496224
Ref: using/cmdline cmdoption-c3497606
Ref: 11453497606
Ref: using/cmdline cmdoption-m3498182
Ref: 32c3498182
Ref: using/cmdline cmdarg-dash3500584
Ref: 12773500584
Ref: using/cmdline cmdarg-script3501001
Ref: 12783501001
Ref: Interface options-Footnote-13502853
Node: Generic options3502902
Ref: using/cmdline generic-options3503022
Ref: 12793503022
Ref: using/cmdline cmdoption3503071
Ref: d7f3503071
Ref: using/cmdline cmdoption-h3503094
Ref: 127a3503094
Ref: using/cmdline cmdoption-help3503117
Ref: d7e3503117
Ref: using/cmdline cmdoption-v3503206
Ref: 5c73503206
Ref: using/cmdline cmdoption-version3503229
Ref: 5c63503229
Node: Miscellaneous options3503577
Ref: using/cmdline miscellaneous-options3503707
Ref: 127b3503707
Ref: using/cmdline using-on-misc-options3503707
Ref: 9203503707
Ref: using/cmdline cmdoption-b3503768
Ref: 40a3503768
Ref: using/cmdline id13504107
Ref: d2b3504107
Ref: using/cmdline cmdoption-check-hash-based-pycs3504276
Ref: 127c3504276
Ref: using/cmdline cmdoption-d3504978
Ref: 127d3504978
Ref: using/cmdline cmdoption-e3505133
Ref: f3d3505133
Ref: using/cmdline cmdoption-i3505291
Ref: e123505291
Ref: using/cmdline id23505749
Ref: f3c3505749
Ref: using/cmdline cmdoption-o3506154
Ref: 67f3506154
Ref: using/cmdline cmdoption-oo3506550
Ref: 6803506550
Ref: using/cmdline cmdoption-q3506863
Ref: 12803506863
Ref: using/cmdline cmdoption-r3507001
Ref: fcc3507001
Ref: using/cmdline cmdoption-s3508061
Ref: d083508061
Ref: using/cmdline id33508261
Ref: b173508261
Ref: using/cmdline cmdoption-u3508586
Ref: 12833508586
Ref: using/cmdline id43508870
Ref: d7b3508870
Ref: using/cmdline using-on-warnings3509244
Ref: 12863509244
Ref: using/cmdline cmdoption-w3509244
Ref: 40c3509244
Ref: using/cmdline cmdoption-x3510856
Ref: 12893510856
Ref: using/cmdline id53511021
Ref: 1553511021
Ref: Miscellaneous options-Footnote-13514678
Ref: Miscellaneous options-Footnote-23514727
Ref: Miscellaneous options-Footnote-33514776
Ref: Miscellaneous options-Footnote-43514825
Ref: Miscellaneous options-Footnote-53514874
Node: Options you shouldn’t use3514923
Ref: using/cmdline options-you-shouldn-t-use3515029
Ref: 128d3515029
Ref: using/cmdline cmdoption-j3515100
Ref: d2a3515100
Ref: Options you shouldn’t use-Footnote-13515197
Node: Environment variables3515228
Ref: using/cmdline environment-variables3515335
Ref: 128e3515335
Ref: using/cmdline using-on-envvars3515335
Ref: 128f3515335
Ref: using/cmdline envvar-PYTHONHOME3515628
Ref: 4cb3515628
Ref: using/cmdline envvar-PYTHONPATH3516234
Ref: 9473516234
Ref: using/cmdline envvar-PYTHONSTARTUP3517297
Ref: 8d93517297
Ref: using/cmdline envvar-PYTHONOPTIMIZE3517986
Ref: 127f3517986
Ref: using/cmdline envvar-PYTHONBREAKPOINT3518224
Ref: 3093518224
Ref: using/cmdline envvar-PYTHONDEBUG3518847
Ref: 127e3518847
Ref: using/cmdline envvar-PYTHONINSPECT3519084
Ref: e113519084
Ref: using/cmdline envvar-PYTHONUNBUFFERED3519367
Ref: 12843519367
Ref: using/cmdline envvar-PYTHONVERBOSE3519518
Ref: 12853519518
Ref: using/cmdline envvar-PYTHONCASEOK3519755
Ref: e513519755
Ref: using/cmdline envvar-PYTHONDONTWRITEBYTECODE3519914
Ref: d2c3519914
Ref: using/cmdline envvar-PYTHONPYCACHEPREFIX3520158
Ref: 1543520158
Ref: using/cmdline envvar-PYTHONHASHSEED3520499
Ref: 9b93520499
Ref: using/cmdline envvar-PYTHONIOENCODING3521182
Ref: 9233521182
Ref: using/cmdline envvar-PYTHONNOUSERSITE3522005
Ref: d093522005
Ref: using/cmdline envvar-PYTHONUSERBASE3522248
Ref: d073522248
Ref: using/cmdline envvar-PYTHONEXECUTABLE3522610
Ref: 12953522610
Ref: using/cmdline envvar-PYTHONWARNINGS3522823
Ref: 40d3522823
Ref: using/cmdline envvar-PYTHONFAULTHANDLER3523746
Ref: 9bc3523746
Ref: using/cmdline envvar-PYTHONTRACEMALLOC3524158
Ref: 12963524158
Ref: using/cmdline envvar-PYTHONPROFILEIMPORTTIME3524633
Ref: 32d3524633
Ref: using/cmdline envvar-PYTHONASYNCIODEBUG3524910
Ref: 12973524910
Ref: using/cmdline envvar-PYTHONMALLOC3525120
Ref: 4f83525120
Ref: using/cmdline envvar-PYTHONMALLOCSTATS3526383
Ref: 109b3526383
Ref: using/cmdline envvar-PYTHONLEGACYWINDOWSFSENCODING3526998
Ref: 4ec3526998
Ref: using/cmdline envvar-PYTHONLEGACYWINDOWSSTDIO3527514
Ref: 4ef3527514
Ref: using/cmdline envvar-PYTHONCOERCECLOCALE3527985
Ref: 3013527985
Ref: using/cmdline envvar-PYTHONDEVMODE3530713
Ref: 3213530713
Ref: using/cmdline envvar-PYTHONUTF83530940
Ref: 3063530940
Ref: Environment variables-Footnote-13533774
Ref: Environment variables-Footnote-23533823
Ref: Environment variables-Footnote-33533872
Ref: Environment variables-Footnote-43533921
Ref: Environment variables-Footnote-53533970
Node: Debug-mode variables3534019
Ref: using/cmdline debug-mode-variables3534097
Ref: 129e3534097
Ref: using/cmdline envvar-PYTHONTHREADDEBUG3534228
Ref: 129f3534228
Ref: using/cmdline envvar-PYTHONDUMPREFS3534400
Ref: 1593534400
Node: Using Python on Unix platforms3534632
Ref: using/unix doc3534790
Ref: 12a03534790
Ref: using/unix using-on-unix3534790
Ref: 12a13534790
Ref: using/unix using-python-on-unix-platforms3534790
Ref: 12a23534790
Node: Getting and installing the latest version of Python3535000
Ref: using/unix getting-and-installing-the-latest-version-of-python3535142
Ref: 12a33535142
Node: On Linux3535328
Ref: using/unix on-linux3535455
Ref: 12a43535455
Node: On FreeBSD and OpenBSD3536372
Ref: using/unix on-freebsd-and-openbsd3536522
Ref: 12a53536522
Node: On OpenSolaris3537012
Ref: using/unix on-opensolaris3537145
Ref: 12a63537145
Ref: On OpenSolaris-Footnote-13537365
Node: Building Python3537398
Ref: using/unix building-python3537579
Ref: 12a73537579
Ref: using/unix building-python-on-unix3537579
Ref: 7e73537579
Ref: Building Python-Footnote-13538394
Ref: Building Python-Footnote-23538443
Ref: Building Python-Footnote-33538510
Node: Python-related paths and files3538572
Ref: using/unix python-related-paths-and-files3538715
Ref: 12a83538715
Node: Miscellaneous3540285
Ref: using/unix miscellaneous3540404
Ref: 12a93540404
Node: Using Python on Windows3540962
Ref: using/windows doc3541119
Ref: 12aa3541119
Ref: using/windows using-on-windows3541119
Ref: 2d73541119
Ref: using/windows using-python-on-windows3541119
Ref: 12ab3541119
Ref: Using Python on Windows-Footnote-13543393
Ref: Using Python on Windows-Footnote-23543443
Node: The full installer3543492
Ref: using/windows the-full-installer3543606
Ref: 12af3543606
Ref: using/windows windows-full3543606
Ref: 12ac3543606
Node: Installation steps3543813
Ref: using/windows installation-steps3543927
Ref: 12b03543927
Node: Removing the MAX_PATH Limitation3546037
Ref: using/windows max-path3546181
Ref: 4ca3546181
Ref: using/windows removing-the-max-path-limitation3546181
Ref: 12b23546181
Node: Installing Without UI3547156
Ref: using/windows install-quiet-option3547312
Ref: 12b33547312
Ref: using/windows installing-without-ui3547312
Ref: 12b43547312
Node: Installing Without Downloading3556640
Ref: using/windows install-layout-option3556784
Ref: 12b13556784
Ref: using/windows installing-without-downloading3556784
Ref: 12b53556784
Node: Modifying an install3557779
Ref: using/windows modifying-an-install3557893
Ref: 12b63557893
Node: The Microsoft Store package3558782
Ref: using/windows the-microsoft-store-package3558927
Ref: 12b73558927
Ref: using/windows windows-store3558927
Ref: 11423558927
Node: Known Issues3561083
Ref: using/windows known-issues3561159
Ref: 12b83561159
Node: The nuget org packages3561494
Ref: using/windows the-nuget-org-packages3561643
Ref: 12b93561643
Ref: using/windows windows-nuget3561643
Ref: 12ad3561643
Ref: The nuget org packages-Footnote-13563927
Ref: The nuget org packages-Footnote-23563958
Ref: The nuget org packages-Footnote-33564004
Node: The embeddable package3564053
Ref: using/windows the-embeddable-package3564194
Ref: 12ba3564194
Ref: using/windows windows-embeddable3564194
Ref: 12ae3564194
Ref: The embeddable package-Footnote-13565977
Node: Python Application3566048
Ref: using/windows python-application3566150
Ref: 12bb3566150
Node: Embedding Python3567647
Ref: using/windows embedding-python3567749
Ref: 12bc3567749
Node: Alternative bundles3568537
Ref: using/windows alternative-bundles3568674
Ref: 12bd3568674
Ref: Alternative bundles-Footnote-13569542
Ref: Alternative bundles-Footnote-23569592
Ref: Alternative bundles-Footnote-33569635
Ref: Alternative bundles-Footnote-43569685
Node: Configuring Python3569722
Ref: using/windows configuring-python3569864
Ref: 12be3569864
Node: Excursus Setting environment variables3570432
Ref: using/windows excursus-setting-environment-variables3570563
Ref: 12bf3570563
Ref: using/windows setting-envvars3570563
Ref: 11433570563
Node: Finding the Python executable3572945
Ref: using/windows finding-the-python-executable3573076
Ref: 12c03573076
Ref: using/windows windows-path-mod3573076
Ref: 9843573076
Node: Python Launcher for Windows3574369
Ref: using/windows launcher3574507
Ref: 9833574507
Ref: using/windows python-launcher-for-windows3574507
Ref: 12c13574507
Ref: Python Launcher for Windows-Footnote-13575308
Node: Getting started3575357
Ref: using/windows getting-started3575458
Ref: 12c23575458
Node: From the command-line3575613
Ref: using/windows from-the-command-line3575715
Ref: 12c33575715
Node: Virtual environments3576931
Ref: using/windows virtual-environments3577055
Ref: 12c43577055
Node: From a script3577551
Ref: using/windows from-a-script3577676
Ref: 12c53577676
Node: From file associations3578722
Ref: using/windows from-file-associations3578818
Ref: 12c63578818
Node: Shebang Lines3579395
Ref: using/windows shebang-lines3579531
Ref: 12c73579531
Node: Arguments in shebang lines3581586
Ref: using/windows arguments-in-shebang-lines3581720
Ref: 12c83581720
Node: Customization3582010
Ref: using/windows customization3582142
Ref: 12c93582142
Node: Customization via INI files3582269
Ref: using/windows customization-via-ini-files3582390
Ref: 12ca3582390
Node: Customizing default Python versions3583148
Ref: using/windows customizing-default-python-versions3583269
Ref: 12cb3583269
Node: Diagnostics3587128
Ref: using/windows diagnostics3587225
Ref: 12cc3587225
Node: Finding modules3587658
Ref: using/windows finding-modules3587796
Ref: 4a63587796
Ref: using/windows id13587796
Ref: 12cd3587796
Node: Additional modules3594064
Ref: using/windows additional-modules3594202
Ref: 12ce3594202
Node: PyWin323594614
Ref: using/windows pywin323594694
Ref: 12d03594694
Ref: PyWin32-Footnote-13595276
Ref: PyWin32-Footnote-23595317
Ref: PyWin32-Footnote-33595417
Ref: PyWin32-Footnote-43595491
Ref: PyWin32-Footnote-53595585
Ref: PyWin32-Footnote-63595643
Node: cx_Freeze3595692
Ref: using/windows cx-freeze3595787
Ref: 12d13595787
Ref: cx_Freeze-Footnote-13596142
Node: WConio3596196
Ref: using/windows wconio3596275
Ref: 12d33596275
Ref: WConio-Footnote-13596621
Node: Compiling Python on Windows3596681
Ref: using/windows compiling-python-on-windows3596819
Ref: 12d43596819
Ref: Compiling Python on Windows-Footnote-13597819
Ref: Compiling Python on Windows-Footnote-23597868
Ref: Compiling Python on Windows-Footnote-33597935
Ref: Compiling Python on Windows-Footnote-43597983
Node: Other Platforms3598027
Ref: using/windows other-platforms3598138
Ref: 12d63598138
Ref: Other Platforms-Footnote-13598710
Ref: Other Platforms-Footnote-23598759
Ref: Other Platforms-Footnote-33598800
Ref: Other Platforms-Footnote-43598828
Ref: Other Platforms-Footnote-53598916
Ref: Other Platforms-Footnote-63598970
Node: Using Python on a Macintosh3599020
Ref: using/mac doc3599163
Ref: 12d73599163
Ref: using/mac using-on-mac3599163
Ref: 12d83599163
Ref: using/mac using-python-on-a-macintosh3599163
Ref: 12d93599163
Node: Getting and Installing MacPython3599693
Ref: using/mac getting-and-installing-macpython3599805
Ref: 12da3599805
Ref: using/mac getting-osx3599805
Ref: 12db3599805
Node: How to run a Python script3601910
Ref: using/mac how-to-run-a-python-script3602040
Ref: 12dc3602040
Node: Running scripts with a GUI3603511
Ref: using/mac osx-gui-scripts3603663
Ref: 12de3603663
Ref: using/mac running-scripts-with-a-gui3603663
Ref: 12df3603663
Node: Configuration3604079
Ref: using/mac configuration3604196
Ref: 12e03604196
Node: The IDE3604739
Ref: using/mac ide3604897
Ref: 12dd3604897
Ref: using/mac the-ide3604897
Ref: 12e23604897
Node: Installing Additional Python Packages3605111
Ref: using/mac installing-additional-python-packages3605263
Ref: 12e33605263
Ref: using/mac mac-package-manager3605263
Ref: 12e13605263
Node: GUI Programming on the Mac3605663
Ref: using/mac gui-programming-on-the-mac3605851
Ref: 12e43605851
Node: Distributing Python Applications on the Mac3606866
Ref: using/mac distributing-python-applications-on-the-mac3607032
Ref: 12e53607032
Node: Other Resources3607598
Ref: using/mac other-resources3607729
Ref: 12e63607729
Node: Editors and IDEs3608041
Ref: using/editors doc3608152
Ref: 12e73608152
Ref: using/editors editors3608152
Ref: 12e83608152
Ref: using/editors editors-and-ides3608152
Ref: 12e93608152
Ref: Editors and IDEs-Footnote-13608491
Ref: Editors and IDEs-Footnote-23608540
Ref: Editors and IDEs-Footnote-33608591
Node: The Python Language Reference3608662
Ref: reference/index doc3608798
Ref: 12ea3608798
Ref: reference/index reference-index3608798
Ref: 11363608798
Ref: reference/index the-python-language-reference3608798
Ref: 12eb3608798
Node: Introduction<5>3609790
Ref: reference/introduction doc3609896
Ref: 12ec3609896
Ref: reference/introduction id13609896
Ref: 12ed3609896
Ref: reference/introduction introduction3609896
Ref: 12ee3609896
Node: Alternate Implementations3611692
Ref: reference/introduction alternate-implementations3611786
Ref: 12ef3611786
Ref: reference/introduction implementations3611786
Ref: 12713611786
Ref: Alternate Implementations-Footnote-13613968
Ref: Alternate Implementations-Footnote-23613999
Ref: Alternate Implementations-Footnote-33614036
Ref: Alternate Implementations-Footnote-43614067
Node: Notation3614092
Ref: reference/introduction id23614186
Ref: 12f03614186
Ref: reference/introduction notation3614186
Ref: 12f13614186
Ref: reference/introduction grammar-token-name3614349
Ref: 12f23614349
Ref: reference/introduction grammar-token-lc-letter3614397
Ref: 12f33614397
Node: Lexical analysis3616431
Ref: reference/lexical_analysis doc3616556
Ref: 12f43616556
Ref: reference/lexical_analysis lexical3616556
Ref: 12f53616556
Ref: reference/lexical_analysis lexical-analysis3616556
Ref: 12f63616556
Ref: Lexical analysis-Footnote-13617201
Node: Line structure3617250
Ref: reference/lexical_analysis id13617338
Ref: 12f73617338
Ref: reference/lexical_analysis line-structure3617338
Ref: 12f83617338
Node: Logical lines3617644
Ref: reference/lexical_analysis id23617731
Ref: 12f93617731
Ref: reference/lexical_analysis logical-lines3617731
Ref: 12fa3617731
Node: Physical lines3618109
Ref: reference/lexical_analysis id33618213
Ref: 12fb3618213
Ref: reference/lexical_analysis physical-lines3618213
Ref: 12fc3618213
Node: Comments3618984
Ref: reference/lexical_analysis comments3619096
Ref: 12fd3619096
Ref: reference/lexical_analysis id43619096
Ref: 12fe3619096
Node: Encoding declarations3619399
Ref: reference/lexical_analysis encoding-declarations3619518
Ref: 12ff3619518
Ref: reference/lexical_analysis encodings3619518
Ref: 13003619518
Node: Explicit line joining3620648
Ref: reference/lexical_analysis explicit-joining3620780
Ref: 13013620780
Ref: reference/lexical_analysis explicit-line-joining3620780
Ref: 13023620780
Node: Implicit line joining3621714
Ref: reference/lexical_analysis implicit-joining3621836
Ref: 13033621836
Ref: reference/lexical_analysis implicit-line-joining3621836
Ref: 13043621836
Node: Blank lines3622672
Ref: reference/lexical_analysis blank-lines3622784
Ref: 13053622784
Ref: reference/lexical_analysis id53622784
Ref: 13063622784
Node: Indentation3623259
Ref: reference/lexical_analysis id63623375
Ref: 13073623375
Ref: reference/lexical_analysis indentation3623375
Ref: 13083623375
Node: Whitespace between tokens3626761
Ref: reference/lexical_analysis whitespace3626857
Ref: 13093626857
Ref: reference/lexical_analysis whitespace-between-tokens3626857
Ref: 130a3626857
Node: Other tokens3627259
Ref: reference/lexical_analysis id73627380
Ref: 130b3627380
Ref: reference/lexical_analysis other-tokens3627380
Ref: 130c3627380
Node: Identifiers and keywords3627812
Ref: reference/lexical_analysis identifiers3627927
Ref: 130d3627927
Ref: reference/lexical_analysis identifiers-and-keywords3627927
Ref: 130e3627927
Ref: reference/lexical_analysis grammar-token-identifier3628822
Ref: 130f3628822
Ref: reference/lexical_analysis grammar-token-id-start3628868
Ref: 13103628868
Ref: reference/lexical_analysis grammar-token-id-continue3629017
Ref: 13113629017
Ref: reference/lexical_analysis grammar-token-xid-start3629165
Ref: 13123629165
Ref: reference/lexical_analysis grammar-token-xid-continue3629272
Ref: 13133629272
Ref: Identifiers and keywords-Footnote-13630267
Ref: Identifiers and keywords-Footnote-23630316
Ref: Identifiers and keywords-Footnote-33630365
Node: Keywords3630427
Ref: reference/lexical_analysis id83630536
Ref: 13143630536
Ref: reference/lexical_analysis keywords3630536
Ref: 13153630536
Node: Reserved classes of identifiers3631131
Ref: reference/lexical_analysis id-classes3631240
Ref: 13163631240
Ref: reference/lexical_analysis reserved-classes-of-identifiers3631240
Ref: 13173631240
Node: Literals3632838
Ref: reference/lexical_analysis id93632950
Ref: 13193632950
Ref: reference/lexical_analysis literals3632950
Ref: 131a3632950
Node: String and Bytes literals3633245
Ref: reference/lexical_analysis string-and-bytes-literals3633352
Ref: 131b3633352
Ref: reference/lexical_analysis strings3633352
Ref: 131c3633352
Ref: reference/lexical_analysis grammar-token-stringliteral3633490
Ref: 131d3633490
Ref: reference/lexical_analysis grammar-token-stringprefix3633556
Ref: 131e3633556
Ref: reference/lexical_analysis grammar-token-shortstring3633696
Ref: 131f3633696
Ref: reference/lexical_analysis grammar-token-longstring3633773
Ref: 13203633773
Ref: reference/lexical_analysis grammar-token-shortstringitem3633856
Ref: 13213633856
Ref: reference/lexical_analysis grammar-token-longstringitem3633915
Ref: 13223633915
Ref: reference/lexical_analysis grammar-token-shortstringchar3633973
Ref: 13233633973
Ref: reference/lexical_analysis grammar-token-longstringchar3634056
Ref: 13243634056
Ref: reference/lexical_analysis grammar-token-stringescapeseq3634115
Ref: 13253634115
Ref: reference/lexical_analysis grammar-token-bytesliteral3634168
Ref: 13263634168
Ref: reference/lexical_analysis grammar-token-bytesprefix3634228
Ref: 13273634228
Ref: reference/lexical_analysis grammar-token-shortbytes3634318
Ref: 13283634318
Ref: reference/lexical_analysis grammar-token-longbytes3634392
Ref: 13293634392
Ref: reference/lexical_analysis grammar-token-shortbytesitem3634472
Ref: 132a3634472
Ref: reference/lexical_analysis grammar-token-longbytesitem3634528
Ref: 132b3634528
Ref: reference/lexical_analysis grammar-token-shortbyteschar3634583
Ref: 132c3634583
Ref: reference/lexical_analysis grammar-token-longbyteschar3634664
Ref: 132d3634664
Ref: reference/lexical_analysis grammar-token-bytesescapeseq3634721
Ref: 132e3634721
Ref: String and Bytes literals-Footnote-13642117
Ref: String and Bytes literals-Footnote-23642166
Node: String literal concatenation3642241
Ref: reference/lexical_analysis string-concatenation3642382
Ref: 132f3642382
Ref: reference/lexical_analysis string-literal-concatenation3642382
Ref: 13303642382
Node: Formatted string literals3643425
Ref: reference/lexical_analysis f-strings3643557
Ref: 15c3643557
Ref: reference/lexical_analysis formatted-string-literals3643557
Ref: 13313643557
Ref: reference/lexical_analysis grammar-token-f-string3644168
Ref: 13323644168
Ref: reference/lexical_analysis grammar-token-replacement-field3644245
Ref: 13333644245
Ref: reference/lexical_analysis grammar-token-f-expression3644328
Ref: 13343644328
Ref: reference/lexical_analysis grammar-token-conversion3644523
Ref: 13353644523
Ref: reference/lexical_analysis grammar-token-format-spec3644566
Ref: 13363644566
Ref: reference/lexical_analysis grammar-token-literal-char3644636
Ref: 13373644636
Ref: Formatted string literals-Footnote-13648442
Node: Numeric literals3648491
Ref: reference/lexical_analysis numbers3648611
Ref: 13383648611
Ref: reference/lexical_analysis numeric-literals3648611
Ref: 13393648611
Node: Integer literals3649045
Ref: reference/lexical_analysis integer-literals3649163
Ref: 133a3649163
Ref: reference/lexical_analysis integers3649163
Ref: 133b3649163
Ref: reference/lexical_analysis grammar-token-integer3649284
Ref: 133c3649284
Ref: reference/lexical_analysis grammar-token-decinteger3649356
Ref: 133d3649356
Ref: reference/lexical_analysis grammar-token-bininteger3649426
Ref: 133e3649426
Ref: reference/lexical_analysis grammar-token-octinteger3649482
Ref: 133f3649482
Ref: reference/lexical_analysis grammar-token-hexinteger3649538
Ref: 13403649538
Ref: reference/lexical_analysis grammar-token-nonzerodigit3649594
Ref: 13413649594
Ref: reference/lexical_analysis grammar-token-digit3649626
Ref: 13423649626
Ref: reference/lexical_analysis grammar-token-bindigit3649658
Ref: 13433649658
Ref: reference/lexical_analysis grammar-token-octdigit3649690
Ref: 13443649690
Ref: reference/lexical_analysis grammar-token-hexdigit3649722
Ref: 13453649722
Node: Floating point literals3650576
Ref: reference/lexical_analysis floating3650696
Ref: 13463650696
Ref: reference/lexical_analysis floating-point-literals3650696
Ref: 13473650696
Ref: reference/lexical_analysis grammar-token-floatnumber3650838
Ref: 13483650838
Ref: reference/lexical_analysis grammar-token-pointfloat3650888
Ref: 13493650888
Ref: reference/lexical_analysis grammar-token-exponentfloat3650948
Ref: 134a3650948
Ref: reference/lexical_analysis grammar-token-digitpart3651005
Ref: 134b3651005
Ref: reference/lexical_analysis grammar-token-fraction3651049
Ref: 134c3651049
Ref: reference/lexical_analysis grammar-token-exponent3651086
Ref: 134d3651086
Node: Imaginary literals3651652
Ref: reference/lexical_analysis imaginary3651747
Ref: 134e3651747
Ref: reference/lexical_analysis imaginary-literals3651747
Ref: 134f3651747
Ref: reference/lexical_analysis grammar-token-imagnumber3651874
Ref: 13503651874
Node: Operators3652337
Ref: reference/lexical_analysis id113652435
Ref: 13513652435
Ref: reference/lexical_analysis operators3652435
Ref: 13523652435
Node: Delimiters3652672
Ref: reference/lexical_analysis delimiters3652753
Ref: 13533652753
Ref: reference/lexical_analysis id123652753
Ref: 13543652753
Node: Data model3653669
Ref: reference/datamodel doc3653794
Ref: 13553653794
Ref: reference/datamodel data-model3653794
Ref: 13563653794
Ref: reference/datamodel datamodel3653794
Ref: 13573653794
Node: Objects values and types3653962
Ref: reference/datamodel objects3654069
Ref: 13583654069
Ref: reference/datamodel objects-values-and-types3654069
Ref: 13593654069
Ref: Objects values and types-Footnote-13658878
Node: The standard type hierarchy3659109
Ref: reference/datamodel the-standard-type-hierarchy3659245
Ref: 135b3659245
Ref: reference/datamodel types3659245
Ref: 135c3659245
Ref: reference/datamodel frame-objects3694234
Ref: 136e3694234
Ref: reference/datamodel frame clear3695978
Ref: 7ff3695978
Ref: reference/datamodel traceback-objects3696532
Ref: 32b3696532
Ref: reference/datamodel slice indices3699206
Ref: 9533699206
Node: Special method names3700976
Ref: reference/datamodel special-method-names3701098
Ref: 136f3701098
Ref: reference/datamodel specialnames3701098
Ref: 5033701098
Ref: Special method names-Footnote-13702930
Node: Basic customization3703212
Ref: reference/datamodel basic-customization3703325
Ref: 13703703325
Ref: reference/datamodel customization3703325
Ref: 13713703325
Ref: reference/datamodel object __new__3703382
Ref: 87d3703382
Ref: reference/datamodel object __init__3704956
Ref: d513704956
Ref: reference/datamodel object __del__3705815
Ref: 9133705815
Ref: reference/datamodel object __repr__3708947
Ref: 3333708947
Ref: reference/datamodel object __str__3709793
Ref: e2a3709793
Ref: reference/datamodel object __bytes__3710445
Ref: 13733710445
Ref: reference/datamodel object __format__3710623
Ref: 9423710623
Ref: reference/datamodel richcmpfuncs3711732
Ref: 13743711732
Ref: reference/datamodel object __lt__3711732
Ref: c273711732
Ref: reference/datamodel object __le__3711772
Ref: c933711772
Ref: reference/datamodel object __eq__3711812
Ref: 3343711812
Ref: reference/datamodel object __ne__3711852
Ref: e493711852
Ref: reference/datamodel object __gt__3711892
Ref: c943711892
Ref: reference/datamodel object __ge__3711932
Ref: c953711932
Ref: reference/datamodel object __hash__3714219
Ref: 3353714219
Ref: reference/datamodel object __bool__3718433
Ref: c5b3718433
Node: Customizing attribute access3718883
Ref: reference/datamodel attribute-access3719031
Ref: 13753719031
Ref: reference/datamodel customizing-attribute-access3719031
Ref: 13763719031
Ref: reference/datamodel object __getattr__3719263
Ref: 30f3719263
Ref: reference/datamodel object __getattribute__3720509
Ref: 43e3720509
Ref: reference/datamodel object __setattr__3721446
Ref: e1f3721446
Ref: reference/datamodel object __delattr__3721945
Ref: 136c3721945
Ref: reference/datamodel object __dir__3722172
Ref: 3103722172
Node: Customizing module attribute access3722500
Ref: reference/datamodel customizing-module-attribute-access3722633
Ref: 13793722633
Ref: Customizing module attribute access-Footnote-13724759
Node: Implementing Descriptors3724808
Ref: reference/datamodel descriptors3724970
Ref: 4de3724970
Ref: reference/datamodel implementing-descriptors3724970
Ref: 137a3724970
Ref: reference/datamodel object __get__3725450
Ref: 13773725450
Ref: reference/datamodel object __set__3726381
Ref: 137b3726381
Ref: reference/datamodel object __delete__3726739
Ref: 137c3726739
Ref: reference/datamodel object __set_name__3726875
Ref: 4dd3726875
Ref: Implementing Descriptors-Footnote-13728078
Node: Invoking Descriptors3728127
Ref: reference/datamodel descriptor-invocation3728263
Ref: 137d3728263
Ref: reference/datamodel invoking-descriptors3728263
Ref: 137e3728263
Node: __slots__3731478
Ref: reference/datamodel id33731581
Ref: 137f3731581
Ref: reference/datamodel slots3731581
Ref: 13803731581
Ref: reference/datamodel object __slots__3731939
Ref: e203731939
Node: Notes on using __slots__3732292
Ref: reference/datamodel notes-on-using-slots3732362
Ref: 13813732362
Node: Customizing class creation3735150
Ref: reference/datamodel class-customization3735319
Ref: 4da3735319
Ref: reference/datamodel customizing-class-creation3735319
Ref: 13823735319
Ref: reference/datamodel object __init_subclass__3735786
Ref: 4d83735786
Node: Metaclasses3737318
Ref: reference/datamodel id43737422
Ref: 13833737422
Ref: reference/datamodel metaclasses3737422
Ref: 13843737422
Node: Resolving MRO entries3738477
Ref: reference/datamodel resolving-mro-entries3738627
Ref: 13853738627
Ref: Resolving MRO entries-Footnote-13739154
Node: Determining the appropriate metaclass3739203
Ref: reference/datamodel determining-the-appropriate-metaclass3739371
Ref: 13863739371
Node: Preparing the class namespace3740302
Ref: reference/datamodel prepare3740473
Ref: 4f23740473
Ref: reference/datamodel preparing-the-class-namespace3740473
Ref: 13873740473
Ref: Preparing the class namespace-Footnote-13741129
Node: Executing the class body3741178
Ref: reference/datamodel executing-the-class-body3741337
Ref: 13883741337
Node: Creating the class object3742072
Ref: reference/datamodel class-object-creation3742222
Ref: 4d93742222
Ref: reference/datamodel creating-the-class-object3742222
Ref: 13893742222
Ref: Creating the class object-Footnote-13744693
Node: Uses for metaclasses3744742
Ref: reference/datamodel uses-for-metaclasses3744859
Ref: 138a3744859
Node: Customizing instance and subclass checks3745170
Ref: reference/datamodel customizing-instance-and-subclass-checks3745334
Ref: 138b3745334
Ref: reference/datamodel class __instancecheck__3745824
Ref: 138c3745824
Ref: reference/datamodel class __subclasscheck__3746053
Ref: 138d3746053
Ref: Customizing instance and subclass checks-Footnote-13747006
Node: Emulating generic types3747055
Ref: reference/datamodel emulating-generic-types3747219
Ref: 138e3747219
Ref: reference/datamodel object __class_getitem__3747417
Ref: 31c3747417
Ref: Emulating generic types-Footnote-13747939
Ref: Emulating generic types-Footnote-23747988
Node: Emulating callable objects3748037
Ref: reference/datamodel callable-types3748186
Ref: 138f3748186
Ref: reference/datamodel emulating-callable-objects3748186
Ref: 13903748186
Ref: reference/datamodel object __call__3748259
Ref: 13693748259
Node: Emulating container types3748484
Ref: reference/datamodel emulating-container-types3748633
Ref: 13913748633
Ref: reference/datamodel sequence-types3748633
Ref: 13923748633
Ref: reference/datamodel object __len__3750843
Ref: dbe3750843
Ref: reference/datamodel object __length_hint__3751581
Ref: 8003751581
Ref: reference/datamodel object __getitem__3752368
Ref: 27a3752368
Ref: reference/datamodel object __setitem__3753264
Ref: c553753264
Ref: reference/datamodel object __delitem__3753726
Ref: c563753726
Ref: reference/datamodel object __missing__3754152
Ref: b2e3754152
Ref: reference/datamodel object __iter__3754343
Ref: 5043754343
Ref: reference/datamodel object __reversed__3754821
Ref: 5243754821
Ref: reference/datamodel object __contains__3755805
Ref: d1b3755805
Node: Emulating numeric types3756369
Ref: reference/datamodel emulating-numeric-types3756523
Ref: 139b3756523
Ref: reference/datamodel numeric-types3756523
Ref: 139c3756523
Ref: reference/datamodel object __add__3756838
Ref: 13933756838
Ref: reference/datamodel object __sub__3756879
Ref: 139d3756879
Ref: reference/datamodel object __mul__3756920
Ref: 13953756920
Ref: reference/datamodel object __matmul__3756961
Ref: 63c3756961
Ref: reference/datamodel object __truediv__3757005
Ref: 77a3757005
Ref: reference/datamodel object __floordiv__3757050
Ref: e283757050
Ref: reference/datamodel object __mod__3757096
Ref: 139e3757096
Ref: reference/datamodel object __divmod__3757137
Ref: 77b3757137
Ref: reference/datamodel object __pow__3757181
Ref: 139f3757181
Ref: reference/datamodel object __lshift__3757232
Ref: 13a03757232
Ref: reference/datamodel object __rshift__3757276
Ref: 13a13757276
Ref: reference/datamodel object __and__3757320
Ref: 13a23757320
Ref: reference/datamodel object __xor__3757361
Ref: 13a33757361
Ref: reference/datamodel object __or__3757402
Ref: 13a43757402
Ref: reference/datamodel object __radd__3758385
Ref: 13943758385
Ref: reference/datamodel object __rsub__3758427
Ref: 13a53758427
Ref: reference/datamodel object __rmul__3758469
Ref: 13963758469
Ref: reference/datamodel object __rmatmul__3758511
Ref: 63d3758511
Ref: reference/datamodel object __rtruediv__3758556
Ref: 13a63758556
Ref: reference/datamodel object __rfloordiv__3758602
Ref: 13a73758602
Ref: reference/datamodel object __rmod__3758649
Ref: 6a33758649
Ref: reference/datamodel object __rdivmod__3758691
Ref: 13a83758691
Ref: reference/datamodel object __rpow__3758736
Ref: 13a93758736
Ref: reference/datamodel object __rlshift__3758778
Ref: 13aa3758778
Ref: reference/datamodel object __rrshift__3758823
Ref: 13ab3758823
Ref: reference/datamodel object __rand__3758868
Ref: 13ac3758868
Ref: reference/datamodel object __rxor__3758910
Ref: 13ad3758910
Ref: reference/datamodel object __ror__3758952
Ref: 13ae3758952
Ref: reference/datamodel object __iadd__3760165
Ref: e633760165
Ref: reference/datamodel object __isub__3760207
Ref: e643760207
Ref: reference/datamodel object __imul__3760249
Ref: 13973760249
Ref: reference/datamodel object __imatmul__3760291
Ref: 63e3760291
Ref: reference/datamodel object __itruediv__3760336
Ref: 13af3760336
Ref: reference/datamodel object __ifloordiv__3760382
Ref: 13b03760382
Ref: reference/datamodel object __imod__3760429
Ref: 13b13760429
Ref: reference/datamodel object __ipow__3760471
Ref: 13b23760471
Ref: reference/datamodel object __ilshift__3760523
Ref: 13b33760523
Ref: reference/datamodel object __irshift__3760568
Ref: 13b43760568
Ref: reference/datamodel object __iand__3760613
Ref: 13b53760613
Ref: reference/datamodel object __ixor__3760655
Ref: 13b63760655
Ref: reference/datamodel object __ior__3760697
Ref: 13b73760697
Ref: reference/datamodel object __neg__3761752
Ref: 13b93761752
Ref: reference/datamodel object __pos__3761786
Ref: 13ba3761786
Ref: reference/datamodel object __abs__3761820
Ref: 13bb3761820
Ref: reference/datamodel object __invert__3761854
Ref: 13bc3761854
Ref: reference/datamodel object __complex__3762007
Ref: 18d3762007
Ref: reference/datamodel object __int__3762045
Ref: 18b3762045
Ref: reference/datamodel object __float__3762079
Ref: 18c3762079
Ref: reference/datamodel object __index__3762287
Ref: 18a3762287
Ref: reference/datamodel object __round__3762961
Ref: 13be3762961
Ref: reference/datamodel object __trunc__3763008
Ref: 13bf3763008
Ref: reference/datamodel object __floor__3763044
Ref: 13c03763044
Ref: reference/datamodel object __ceil__3763080
Ref: 13c13763080
Ref: Emulating numeric types-Footnote-13763643
Ref: Emulating numeric types-Footnote-23763962
Node: With Statement Context Managers3764172
Ref: reference/datamodel context-managers3764322
Ref: 13c23764322
Ref: reference/datamodel with-statement-context-managers3764322
Ref: 13c33764322
Ref: reference/datamodel object __enter__3765085
Ref: c883765085
Ref: reference/datamodel object __exit__3765335
Ref: c893765335
Ref: With Statement Context Managers-Footnote-13766223
Node: Special method lookup3766272
Ref: reference/datamodel special-lookup3766390
Ref: 13783766390
Ref: reference/datamodel special-method-lookup3766390
Ref: 13c53766390
Node: Coroutines3769111
Ref: reference/datamodel coroutines3769197
Ref: 13c63769197
Node: Awaitable Objects3769347
Ref: reference/datamodel awaitable-objects3769437
Ref: 13c73769437
Ref: reference/datamodel object __await__3769916
Ref: 6363769916
Ref: Awaitable Objects-Footnote-13770331
Node: Coroutine Objects3770380
Ref: reference/datamodel coroutine-objects3770501
Ref: 13683770501
Ref: reference/datamodel id73770501
Ref: 13c83770501
Ref: reference/datamodel coroutine send3771371
Ref: 13ca3771371
Ref: reference/datamodel coroutine throw3771910
Ref: 13cc3771910
Ref: reference/datamodel coroutine close3772506
Ref: 13ce3772506
Node: Asynchronous Iterators3773128
Ref: reference/datamodel async-iterators3773261
Ref: 63a3773261
Ref: reference/datamodel asynchronous-iterators3773261
Ref: 13d03773261
Ref: reference/datamodel object __aiter__3773485
Ref: 47c3773485
Ref: reference/datamodel object __anext__3773575
Ref: 13d13773575
Node: Asynchronous Context Managers3774456
Ref: reference/datamodel async-context-managers3774563
Ref: 13d23774563
Ref: reference/datamodel asynchronous-context-managers3774563
Ref: 13d33774563
Ref: reference/datamodel object __aenter__3774868
Ref: 13d43774868
Ref: reference/datamodel object __aexit__3775027
Ref: 13d53775027
Node: Execution model3775502
Ref: reference/executionmodel doc3775628
Ref: 13d63775628
Ref: reference/executionmodel execmodel3775628
Ref: 13d73775628
Ref: reference/executionmodel execution-model3775628
Ref: 13d83775628
Node: Structure of a program3775758
Ref: reference/executionmodel prog-structure3775859
Ref: 13d93775859
Ref: reference/executionmodel structure-of-a-program3775859
Ref: 13da3775859
Node: Naming and binding3776764
Ref: reference/executionmodel naming3776887
Ref: 13db3776887
Ref: reference/executionmodel naming-and-binding3776887
Ref: 13dc3776887
Node: Binding of names3777069
Ref: reference/executionmodel bind-names3777168
Ref: 13dd3777168
Ref: reference/executionmodel binding-of-names3777168
Ref: 13de3777168
Node: Resolution of names3778654
Ref: reference/executionmodel resolution-of-names3778795
Ref: 13df3778795
Ref: reference/executionmodel resolve-names3778795
Ref: 13e03778795
Node: Builtins and restricted execution3782187
Ref: reference/executionmodel builtins-and-restricted-execution3782345
Ref: 13e13782345
Ref: reference/executionmodel restrict-exec3782345
Ref: 13e23782345
Node: Interaction with dynamic features3783190
Ref: reference/executionmodel dynamic-features3783320
Ref: 13e33783320
Ref: reference/executionmodel interaction-with-dynamic-features3783320
Ref: 13e43783320
Ref: Interaction with dynamic features-Footnote-13784112
Node: Exceptions<2>3784254
Ref: reference/executionmodel exceptions3784346
Ref: 13e53784346
Ref: reference/executionmodel id23784346
Ref: 13e63784346
Node: The import system3786504
Ref: reference/import doc3786631
Ref: 13e73786631
Ref: reference/import importsystem3786631
Ref: 136a3786631
Ref: reference/import the-import-system3786631
Ref: 13e83786631
Ref: The import system-Footnote-13789281
Ref: The import system-Footnote-23789326
Ref: The import system-Footnote-33789375
Node: importlib<7>3789424
Ref: reference/import importlib3789510
Ref: 13ec3789510
Node: Packages<2>3789885
Ref: reference/import packages3789989
Ref: 13ed3789989
Node: Regular packages3791426
Ref: reference/import regular-packages3791517
Ref: 13ef3791517
Node: Namespace packages3792729
Ref: reference/import namespace-packages3792820
Ref: 13f23792820
Ref: Namespace packages-Footnote-13794197
Node: Searching3794246
Ref: reference/import searching3794345
Ref: 13f43794345
Node: The module cache3795170
Ref: reference/import the-module-cache3795260
Ref: 13f53795260
Node: Finders and loaders3796824
Ref: reference/import finders-and-loaders3796935
Ref: 13f63796935
Node: Import hooks3798692
Ref: reference/import import-hooks3798800
Ref: 13fb3798800
Node: The meta path3799672
Ref: reference/import the-meta-path3799752
Ref: 13fc3799752
Node: Loading3802751
Ref: reference/import loading3802860
Ref: 13fe3802860
Ref: Loading-Footnote-13806166
Node: Loaders3806550
Ref: reference/import loaders3806620
Ref: 14003806620
Node: Submodules3809877
Ref: reference/import submodules3809967
Ref: 14013809967
Node: Module spec3811271
Ref: reference/import module-spec3811386
Ref: 14023811386
Node: Import-related module attributes3812225
Ref: reference/import import-mod-attrs3812345
Ref: 13ff3812345
Ref: reference/import import-related-module-attributes3812345
Ref: 14043812345
Ref: reference/import __name__3812583
Ref: d053812583
Ref: reference/import __loader__3812781
Ref: 94a3812781
Ref: reference/import __package__3813097
Ref: 9493813097
Ref: reference/import __spec__3813924
Ref: 14053813924
Ref: reference/import __path__3814533
Ref: 11c83814533
Ref: reference/import __file__3815025
Ref: 136b3815025
Ref: reference/import __cached__3815050
Ref: b253815050
Ref: Import-related module attributes-Footnote-13816039
Ref: Import-related module attributes-Footnote-23816088
Ref: Import-related module attributes-Footnote-33816137
Node: module __path__3816186
Ref: reference/import module-path3816307
Ref: 14093816307
Ref: reference/import package-path-rules3816307
Ref: 14083816307
Ref: module __path__-Footnote-13817489
Ref: module __path__-Footnote-23817538
Node: Module reprs3817587
Ref: reference/import module-reprs3817704
Ref: 140a3817704
Node: Cached bytecode invalidation3819375
Ref: reference/import cached-bytecode-invalidation3819468
Ref: 140b3819468
Ref: reference/import pyc-invalidation3819468
Ref: 31e3819468
Node: The Path Based Finder3820817
Ref: reference/import the-path-based-finder3820953
Ref: 140c3820953
Node: Path entry finders3823457
Ref: reference/import path-entry-finders3823568
Ref: 140e3823568
Ref: Path entry finders-Footnote-13828629
Node: Path entry finder protocol3828887
Ref: reference/import path-entry-finder-protocol3828998
Ref: 14103828998
Node: Replacing the standard import system3831920
Ref: reference/import replacing-the-standard-import-system3832073
Ref: 14113832073
Node: Package Relative Imports3833076
Ref: reference/import package-relative-imports3833243
Ref: 14123833243
Ref: reference/import relativeimports3833243
Ref: 14133833243
Node: Special considerations for __main__3834446
Ref: reference/import special-considerations-for-main3834588
Ref: 14143834588
Node: __main__ __spec__3835191
Ref: reference/import id43835280
Ref: 14153835280
Ref: reference/import main-spec3835280
Ref: 14073835280
Node: Open issues3836678
Ref: reference/import open-issues3836806
Ref: 14163836806
Ref: Open issues-Footnote-13837442
Node: References3837491
Ref: reference/import references3837575
Ref: 14173837575
Ref: References-Footnote-13838808
Ref: References-Footnote-23838860
Ref: References-Footnote-33838909
Ref: References-Footnote-43838958
Ref: References-Footnote-53839007
Ref: References-Footnote-63839056
Ref: References-Footnote-73839105
Ref: References-Footnote-83839154
Ref: References-Footnote-93839203
Ref: References-Footnote-103839252
Node: Expressions3839302
Ref: reference/expressions doc3839431
Ref: 14183839431
Ref: reference/expressions expressions3839431
Ref: 14193839431
Ref: reference/expressions id13839431
Ref: 141a3839431
Ref: reference/expressions grammar-token-name3839725
Ref: 141b3839725
Node: Arithmetic conversions3840238
Ref: reference/expressions arithmetic-conversions3840322
Ref: 141c3840322
Ref: reference/expressions conversions3840322
Ref: 141d3840322
Node: Atoms3841025
Ref: reference/expressions atoms3841127
Ref: 141e3841127
Ref: reference/expressions id23841127
Ref: 141f3841127
Ref: reference/expressions grammar-token-atom3841374
Ref: 14203841374
Ref: reference/expressions grammar-token-enclosure3841426
Ref: 14213841426
Node: Identifiers Names3841853
Ref: reference/expressions atom-identifiers3841932
Ref: 13183841932
Ref: reference/expressions identifiers-names3841932
Ref: 14223841932
Node: Literals<2>3843226
Ref: reference/expressions atom-literals3843333
Ref: 14233843333
Ref: reference/expressions literals3843333
Ref: 14243843333
Ref: reference/expressions grammar-token-literal3843441
Ref: 14253843441
Node: Parenthesized forms3844148
Ref: reference/expressions parenthesized3844278
Ref: 14263844278
Ref: reference/expressions parenthesized-forms3844278
Ref: 14273844278
Ref: reference/expressions grammar-token-parenth-form3844413
Ref: 14283844413
Node: Displays for lists sets and dictionaries3845177
Ref: reference/expressions comprehensions3845309
Ref: 14293845309
Ref: reference/expressions displays-for-lists-sets-and-dictionaries3845309
Ref: 142a3845309
Ref: reference/expressions grammar-token-comprehension3845755
Ref: 142b3845755
Ref: reference/expressions grammar-token-comp-for3845798
Ref: 142c3845798
Ref: reference/expressions grammar-token-comp-iter3845874
Ref: 142d3845874
Ref: reference/expressions grammar-token-comp-if3845916
Ref: 142e3845916
Ref: Displays for lists sets and dictionaries-Footnote-13848107
Node: List displays3848156
Ref: reference/expressions list-displays3848281
Ref: 142f3848281
Ref: reference/expressions lists3848281
Ref: 14303848281
Ref: reference/expressions grammar-token-list-display3848413
Ref: 14313848413
Node: Set displays3848859
Ref: reference/expressions set3848963
Ref: 14323848963
Ref: reference/expressions set-displays3848963
Ref: 14333848963
Ref: reference/expressions grammar-token-set-display3849143
Ref: 14343849143
Node: Dictionary displays3849675
Ref: reference/expressions dict3849787
Ref: 6423849787
Ref: reference/expressions dictionary-displays3849787
Ref: 14353849787
Ref: reference/expressions grammar-token-dict-display3849938
Ref: 14363849938
Ref: reference/expressions grammar-token-key-datum-list3850012
Ref: 14373850012
Ref: reference/expressions grammar-token-key-datum3850073
Ref: 14383850073
Ref: reference/expressions grammar-token-dict-comprehension3850142
Ref: 14393850142
Ref: Dictionary displays-Footnote-13851957
Ref: Dictionary displays-Footnote-23852006
Node: Generator expressions3852055
Ref: reference/expressions generator-expressions3852172
Ref: 143a3852172
Ref: reference/expressions genexpr3852172
Ref: 143b3852172
Ref: reference/expressions grammar-token-generator-expression3852305
Ref: 143c3852305
Node: Yield expressions3854248
Ref: reference/expressions yield-expressions3854337
Ref: 143d3854337
Ref: reference/expressions yieldexpr3854337
Ref: 143e3854337
Ref: reference/expressions grammar-token-yield-atom3854390
Ref: 143f3854390
Ref: reference/expressions grammar-token-yield-expression3854441
Ref: 14403854441
Ref: Yield expressions-Footnote-13859326
Ref: Yield expressions-Footnote-23859375
Ref: Yield expressions-Footnote-33859424
Ref: Yield expressions-Footnote-43859473
Ref: Yield expressions-Footnote-53859522
Node: Generator-iterator methods3859571
Ref: reference/expressions generator-iterator-methods3859668
Ref: 14443859668
Ref: reference/expressions generator-methods3859668
Ref: 13c93859668
Ref: reference/expressions generator __next__3860010
Ref: 12133860010
Ref: reference/expressions generator send3860773
Ref: 13cb3860773
Ref: reference/expressions generator throw3861355
Ref: 13cd3861355
Ref: reference/expressions generator close3861841
Ref: 13cf3861841
Node: Examples3862426
Ref: reference/expressions examples3862564
Ref: 14453862564
Node: Asynchronous generator functions3863623
Ref: reference/expressions asynchronous-generator-functions3863774
Ref: 14423863774
Ref: reference/expressions id33863774
Ref: 14463863774
Ref: Asynchronous generator functions-Footnote-13866843
Node: Asynchronous generator-iterator methods3866922
Ref: reference/expressions asynchronous-generator-iterator-methods3867056
Ref: 144b3867056
Ref: reference/expressions asynchronous-generator-methods3867056
Ref: 144c3867056
Ref: reference/expressions agen __anext__3867298
Ref: 14473867298
Ref: reference/expressions agen asend3868228
Ref: 14483868228
Ref: reference/expressions agen athrow3869092
Ref: 144d3869092
Ref: reference/expressions agen aclose3869779
Ref: 14493869779
Node: Primaries3870793
Ref: reference/expressions id43870889
Ref: 144e3870889
Ref: reference/expressions primaries3870889
Ref: 144f3870889
Ref: reference/expressions grammar-token-primary3871011
Ref: 14503871011
Node: Attribute references3871157
Ref: reference/expressions attribute-references3871245
Ref: 14513871245
Ref: reference/expressions id53871245
Ref: 14523871245
Ref: reference/expressions grammar-token-attributeref3871374
Ref: 14533871374
Node: Subscriptions3871953
Ref: reference/expressions id63872058
Ref: 14543872058
Ref: reference/expressions subscriptions3872058
Ref: 14553872058
Ref: reference/expressions grammar-token-subscription3872205
Ref: 14563872205
Node: Slicings3873730
Ref: reference/expressions id73873820
Ref: 14573873820
Ref: reference/expressions slicings3873820
Ref: 14583873820
Ref: reference/expressions grammar-token-slicing3874069
Ref: 14593874069
Ref: reference/expressions grammar-token-slice-list3874118
Ref: 145a3874118
Ref: reference/expressions grammar-token-slice-item3874175
Ref: 145b3874175
Ref: reference/expressions grammar-token-proper-slice3874223
Ref: 145c3874223
Ref: reference/expressions grammar-token-lower-bound3874294
Ref: 145d3874294
Ref: reference/expressions grammar-token-upper-bound3874327
Ref: 145e3874327
Ref: reference/expressions grammar-token-stride3874360
Ref: 145f3874360
Node: Calls3875578
Ref: reference/expressions calls3875646
Ref: 6403875646
Ref: reference/expressions id83875646
Ref: 14603875646
Ref: reference/expressions grammar-token-call3875795
Ref: 14633875795
Ref: reference/expressions grammar-token-argument-list3875879
Ref: 14643875879
Ref: reference/expressions grammar-token-positional-arguments3876143
Ref: 14653876143
Ref: reference/expressions grammar-token-starred-and-keywords3876214
Ref: 14663876214
Ref: reference/expressions grammar-token-keywords-arguments3876347
Ref: 14673876347
Ref: reference/expressions grammar-token-keyword-item3876482
Ref: 14683876482
Ref: Calls-Footnote-13882520
Node: Await expression3882569
Ref: reference/expressions await3882678
Ref: 1a23882678
Ref: reference/expressions await-expression3882678
Ref: 146a3882678
Ref: reference/expressions grammar-token-await-expr3882867
Ref: 146b3882867
Node: The power operator3882925
Ref: reference/expressions power3883064
Ref: 146c3883064
Ref: reference/expressions the-power-operator3883064
Ref: 146d3883064
Ref: reference/expressions grammar-token-power3883261
Ref: 146e3883261
Node: Unary arithmetic and bitwise operations3884311
Ref: reference/expressions unary3884462
Ref: 146f3884462
Ref: reference/expressions unary-arithmetic-and-bitwise-operations3884462
Ref: 14703884462
Ref: reference/expressions grammar-token-u-expr3884624
Ref: 14713884624
Node: Binary arithmetic operations3885144
Ref: reference/expressions binary3885296
Ref: 14723885296
Ref: reference/expressions binary-arithmetic-operations3885296
Ref: 14733885296
Ref: reference/expressions grammar-token-m-expr3885640
Ref: 14743885640
Ref: reference/expressions grammar-token-a-expr3885796
Ref: 14753885796
Ref: Binary arithmetic operations-Footnote-13888653
Ref: Binary arithmetic operations-Footnote-23889270
Node: Shifting operations3889557
Ref: reference/expressions shifting3889695
Ref: 14773889695
Ref: reference/expressions shifting-operations3889695
Ref: 14783889695
Ref: reference/expressions grammar-token-shift-expr3889825
Ref: 14793889825
Node: Binary bitwise operations3890189
Ref: reference/expressions binary-bitwise-operations3890310
Ref: 147a3890310
Ref: reference/expressions bitwise3890310
Ref: 147b3890310
Ref: reference/expressions grammar-token-and-expr3890445
Ref: 147c3890445
Ref: reference/expressions grammar-token-xor-expr3890500
Ref: 147d3890500
Ref: reference/expressions grammar-token-or-expr3890551
Ref: 147e3890551
Node: Comparisons3890889
Ref: reference/expressions comparisons3891009
Ref: 147f3891009
Ref: reference/expressions id113891009
Ref: 14803891009
Ref: reference/expressions grammar-token-comparison3891304
Ref: 14813891304
Ref: reference/expressions grammar-token-comp-operator3891360
Ref: 14823891360
Node: Value comparisons3892300
Ref: reference/expressions value-comparisons3892400
Ref: 14833892400
Ref: reference/expressions in3900232
Ref: 7973900232
Ref: reference/expressions not-in3900232
Ref: 13993900232
Ref: Value comparisons-Footnote-13900270
Ref: Value comparisons-Footnote-23900319
Node: Membership test operations3901434
Ref: reference/expressions membership-test-details3901563
Ref: 139a3901563
Ref: reference/expressions membership-test-operations3901563
Ref: 14843901563
Ref: reference/expressions is3903457
Ref: 135a3903457
Node: Identity comparisons3903457
Ref: reference/expressions identity-comparisons3903560
Ref: 14853903560
Ref: reference/expressions is-not3903560
Ref: 14863903560
Ref: reference/expressions booleans3903906
Ref: 14873903906
Ref: reference/expressions and3903906
Ref: 14883903906
Ref: reference/expressions or3903906
Ref: 14893903906
Ref: Identity comparisons-Footnote-13903944
Node: Boolean operations3904251
Ref: reference/expressions boolean-operations3904369
Ref: 148a3904369
Ref: reference/expressions not3904369
Ref: 148b3904369
Ref: reference/expressions grammar-token-or-test3904422
Ref: 148c3904422
Ref: reference/expressions grammar-token-and-test3904473
Ref: 148d3904473
Ref: reference/expressions grammar-token-not-test3904526
Ref: 148e3904526
Node: Conditional expressions3905969
Ref: reference/expressions conditional-expressions3906083
Ref: 148f3906083
Ref: reference/expressions if-expr3906083
Ref: 14903906083
Ref: reference/expressions grammar-token-conditional-expression3906146
Ref: 14913906146
Ref: reference/expressions grammar-token-expression3906219
Ref: 14923906219
Ref: reference/expressions grammar-token-expression-nocond3906288
Ref: 14933906288
Ref: reference/expressions lambdas3906736
Ref: 14943906736
Ref: Conditional expressions-Footnote-13906774
Node: Lambdas3906823
Ref: reference/expressions id143906935
Ref: 14953906935
Ref: reference/expressions lambda3906935
Ref: c223906935
Ref: reference/expressions grammar-token-lambda-expr3906966
Ref: 14963906966
Ref: reference/expressions grammar-token-lambda-expr-nocond3907035
Ref: 14973907035
Node: Expression lists3907583
Ref: reference/expressions expression-lists3907688
Ref: 14983907688
Ref: reference/expressions exprlists3907688
Ref: 6413907688
Ref: reference/expressions grammar-token-expression-list3907737
Ref: 14433907737
Ref: reference/expressions grammar-token-starred-list3907800
Ref: 14993907800
Ref: reference/expressions grammar-token-starred-expression3907867
Ref: 149a3907867
Ref: reference/expressions grammar-token-starred-item3907943
Ref: 149b3907943
Ref: Expression lists-Footnote-13908900
Node: Evaluation order3908949
Ref: reference/expressions evalorder3909066
Ref: 149c3909066
Ref: reference/expressions evaluation-order3909066
Ref: 149d3909066
Node: Operator precedence3909581
Ref: reference/expressions operator-precedence3909673
Ref: 149e3909673
Ref: reference/expressions operator-summary3909673
Ref: 149f3909673
Ref: Operator precedence-Footnote-13914224
Ref: Operator precedence-Footnote-23914322
Node: Simple statements3914475
Ref: reference/simple_stmts doc3914606
Ref: 14a03914606
Ref: reference/simple_stmts simple3914606
Ref: 14a13914606
Ref: reference/simple_stmts simple-statements3914606
Ref: 14a23914606
Ref: reference/simple_stmts grammar-token-simple-stmt3914830
Ref: 14a33914830
Node: Expression statements3915775
Ref: reference/simple_stmts expression-statements3915880
Ref: 14a43915880
Ref: reference/simple_stmts exprstmts3915880
Ref: 14a53915880
Ref: reference/simple_stmts grammar-token-expression-stmt3916270
Ref: 14a63916270
Node: Assignment statements3916697
Ref: reference/simple_stmts assignment3916831
Ref: 14a73916831
Ref: reference/simple_stmts assignment-statements3916831
Ref: 14a83916831
Ref: reference/simple_stmts grammar-token-assignment-stmt3917002
Ref: 14a93917002
Ref: reference/simple_stmts grammar-token-target-list3917086
Ref: 14aa3917086
Ref: reference/simple_stmts grammar-token-target3917138
Ref: 14ab3917138
Ref: reference/simple_stmts attr-target-note3920779
Ref: 14ac3920779
Ref: Assignment statements-Footnote-13924836
Node: Augmented assignment statements3924885
Ref: reference/simple_stmts augassign3925014
Ref: 14ad3925014
Ref: reference/simple_stmts augmented-assignment-statements3925014
Ref: 14ae3925014
Ref: reference/simple_stmts grammar-token-augmented-assignment-stmt3925211
Ref: 14af3925211
Ref: reference/simple_stmts grammar-token-augtarget3925299
Ref: 14b03925299
Ref: reference/simple_stmts grammar-token-augop3925385
Ref: 14b13925385
Node: Annotated assignment statements3927127
Ref: reference/simple_stmts annassign3927256
Ref: 14b23927256
Ref: reference/simple_stmts annotated-assignment-statements3927256
Ref: 14b33927256
Ref: reference/simple_stmts grammar-token-annotated-assignment-stmt3927491
Ref: 14b43927491
Ref: Annotated assignment statements-Footnote-13929438
Ref: Annotated assignment statements-Footnote-23929487
Node: The assert statement3929536
Ref: reference/simple_stmts assert3929667
Ref: df93929667
Ref: reference/simple_stmts the-assert-statement3929667
Ref: 14b53929667
Ref: reference/simple_stmts grammar-token-assert-stmt3929817
Ref: 14b63929817
Node: The pass statement3930900
Ref: reference/simple_stmts pass3931030
Ref: 117a3931030
Ref: reference/simple_stmts the-pass-statement3931030
Ref: 14b73931030
Ref: reference/simple_stmts grammar-token-pass-stmt3931089
Ref: 14b83931089
Node: The del statement<2>3931440
Ref: reference/simple_stmts del3931570
Ref: 11a83931570
Ref: reference/simple_stmts the-del-statement3931570
Ref: 14b93931570
Ref: reference/simple_stmts grammar-token-del-stmt3931627
Ref: 14ba3931627
Node: The return statement3932548
Ref: reference/simple_stmts return3932679
Ref: 1903932679
Ref: reference/simple_stmts the-return-statement3932679
Ref: 14bb3932679
Ref: reference/simple_stmts grammar-token-return-stmt3932742
Ref: 14bc3932742
Node: The yield statement3933866
Ref: reference/simple_stmts the-yield-statement3933996
Ref: 14bd3933996
Ref: reference/simple_stmts yield3933996
Ref: 18f3933996
Ref: reference/simple_stmts grammar-token-yield-stmt3934057
Ref: 14be3934057
Node: The raise statement3934892
Ref: reference/simple_stmts raise3935021
Ref: c353935021
Ref: reference/simple_stmts the-raise-statement3935021
Ref: 14bf3935021
Ref: reference/simple_stmts grammar-token-raise-stmt3935082
Ref: 14c03935082
Node: The break statement3938416
Ref: reference/simple_stmts break3938548
Ref: 2d93938548
Ref: reference/simple_stmts the-break-statement3938548
Ref: 14c13938548
Ref: reference/simple_stmts grammar-token-break-stmt3938609
Ref: 14c23938609
Node: The continue statement3939203
Ref: reference/simple_stmts continue3939336
Ref: 1813939336
Ref: reference/simple_stmts the-continue-statement3939336
Ref: 14c33939336
Ref: reference/simple_stmts grammar-token-continue-stmt3939405
Ref: 14c43939405
Ref: reference/simple_stmts import3939871
Ref: c103939871
Node: The import statement3939873
Ref: reference/simple_stmts from3940007
Ref: c383940007
Ref: reference/simple_stmts the-import-statement3940007
Ref: 14c53940007
Ref: reference/simple_stmts grammar-token-import-stmt3940072
Ref: 14c63940072
Ref: reference/simple_stmts grammar-token-module3940529
Ref: 14c73940529
Ref: reference/simple_stmts grammar-token-relative-module3940583
Ref: 14c83940583
Node: Future statements3945833
Ref: reference/simple_stmts future3945907
Ref: 14c93945907
Ref: reference/simple_stmts future-statements3945907
Ref: 14ca3945907
Ref: reference/simple_stmts grammar-token-future-stmt3946433
Ref: 14cb3946433
Ref: reference/simple_stmts grammar-token-feature3946709
Ref: 14cc3946709
Ref: Future statements-Footnote-13949423
Node: The global statement3949472
Ref: reference/simple_stmts global3949606
Ref: 117e3949606
Ref: reference/simple_stmts the-global-statement3949606
Ref: 14cd3949606
Ref: reference/simple_stmts grammar-token-global-stmt3949671
Ref: 14ce3949671
Node: The nonlocal statement3951220
Ref: reference/simple_stmts nonlocal3951325
Ref: c323951325
Ref: reference/simple_stmts the-nonlocal-statement3951325
Ref: 14cf3951325
Ref: reference/simple_stmts grammar-token-nonlocal-stmt3951394
Ref: 14d03951394
Ref: The nonlocal statement-Footnote-13952369
Node: Compound statements3952418
Ref: reference/compound_stmts doc3952558
Ref: 14d13952558
Ref: reference/compound_stmts compound3952558
Ref: 14d23952558
Ref: reference/compound_stmts compound-statements3952558
Ref: 14d33952558
Ref: reference/compound_stmts grammar-token-compound-stmt3954328
Ref: 14d43954328
Ref: reference/compound_stmts grammar-token-suite3954685
Ref: 14d53954685
Ref: reference/compound_stmts grammar-token-statement3954761
Ref: 14d63954761
Ref: reference/compound_stmts grammar-token-stmt-list3954818
Ref: 14d73954818
Ref: reference/compound_stmts if3955344
Ref: dda3955344
Ref: reference/compound_stmts elif3955344
Ref: 116d3955344
Node: The if statement3955543
Ref: reference/compound_stmts else3955643
Ref: 116e3955643
Ref: reference/compound_stmts the-if-statement3955643
Ref: 14d83955643
Ref: reference/compound_stmts grammar-token-if-stmt3955763
Ref: 14d93955763
Node: The while statement3956289
Ref: reference/compound_stmts the-while-statement3956415
Ref: 14da3956415
Ref: reference/compound_stmts while3956415
Ref: 11673956415
Ref: reference/compound_stmts grammar-token-while-stmt3956575
Ref: 14db3956575
Node: The for statement3957164
Ref: reference/compound_stmts for3957291
Ref: c233957291
Ref: reference/compound_stmts the-for-statement3957291
Ref: 14dc3957291
Ref: reference/compound_stmts grammar-token-for-stmt3957490
Ref: 14dd3957490
Ref: reference/compound_stmts try3960250
Ref: d653960250
Ref: reference/compound_stmts except3960250
Ref: b313960250
Node: The try statement3960251
Ref: reference/compound_stmts finally3960377
Ref: 1823960377
Ref: reference/compound_stmts the-try-statement3960377
Ref: 14de3960377
Ref: reference/compound_stmts grammar-token-try-stmt3960541
Ref: 14df3960541
Ref: reference/compound_stmts grammar-token-try1-stmt3960582
Ref: 14e03960582
Ref: reference/compound_stmts grammar-token-try2-stmt3960768
Ref: 14e13960768
Ref: reference/compound_stmts with3966013
Ref: 6dd3966013
Ref: The try statement-Footnote-13966049
Node: The with statement3966251
Ref: reference/compound_stmts as3966380
Ref: 14e23966380
Ref: reference/compound_stmts the-with-statement3966380
Ref: 14e33966380
Ref: reference/compound_stmts grammar-token-with-stmt3966749
Ref: 14e43966749
Ref: reference/compound_stmts grammar-token-with-item3966812
Ref: 14e53966812
Ref: reference/compound_stmts function3969071
Ref: 11963969071
Ref: The with statement-Footnote-13969107
Node: Function definitions3969156
Ref: reference/compound_stmts def3969285
Ref: db13969285
Ref: reference/compound_stmts function-definitions3969285
Ref: 14e63969285
Ref: reference/compound_stmts grammar-token-funcdef3969458
Ref: 14e73969458
Ref: reference/compound_stmts grammar-token-decorators3969609
Ref: 14e83969609
Ref: reference/compound_stmts grammar-token-decorator3969655
Ref: 14e93969655
Ref: reference/compound_stmts grammar-token-dotted-name3969746
Ref: 14ea3969746
Ref: reference/compound_stmts grammar-token-parameter-list3969810
Ref: 14eb3969810
Ref: reference/compound_stmts grammar-token-parameter-list-no-posonly3969985
Ref: 14ec3969985
Ref: reference/compound_stmts grammar-token-parameter-list-starargs3970146
Ref: 14ed3970146
Ref: reference/compound_stmts grammar-token-parameter3970304
Ref: 14ee3970304
Ref: reference/compound_stmts grammar-token-defparameter3970367
Ref: 14ef3970367
Ref: reference/compound_stmts grammar-token-funcname3970429
Ref: 14f03970429
Ref: Function definitions-Footnote-13976122
Ref: Function definitions-Footnote-23976320
Ref: Function definitions-Footnote-33976369
Ref: Function definitions-Footnote-43976418
Ref: Function definitions-Footnote-53976467
Node: Class definitions3976516
Ref: reference/compound_stmts class3976640
Ref: c5d3976640
Ref: reference/compound_stmts class-definitions3976640
Ref: 14f23976640
Ref: reference/compound_stmts grammar-token-classdef3976788
Ref: 14f33976788
Ref: reference/compound_stmts grammar-token-inheritance3976864
Ref: 14f43976864
Ref: reference/compound_stmts grammar-token-classname3976909
Ref: 14f53976909
Ref: Class definitions-Footnote-13979626
Ref: Class definitions-Footnote-23979814
Ref: Class definitions-Footnote-33979863
Ref: Class definitions-Footnote-43979912
Node: Coroutines<2>3979961
Ref: reference/compound_stmts async3980056
Ref: 1a13980056
Ref: reference/compound_stmts coroutines3980056
Ref: 14f63980056
Node: Coroutine function definition3980213
Ref: reference/compound_stmts async-def3980324
Ref: 2823980324
Ref: reference/compound_stmts coroutine-function-definition3980324
Ref: 14f73980324
Ref: reference/compound_stmts grammar-token-async-funcdef3980401
Ref: 14f83980401
Node: The async for statement3981259
Ref: reference/compound_stmts async-for3981403
Ref: 2e13981403
Ref: reference/compound_stmts the-async-for-statement3981403
Ref: 14f93981403
Ref: reference/compound_stmts grammar-token-async-for-stmt3981476
Ref: 14fa3981476
Node: The async with statement3982403
Ref: reference/compound_stmts async-with3982509
Ref: 6373982509
Ref: reference/compound_stmts the-async-with-statement3982509
Ref: 14fb3982509
Ref: reference/compound_stmts grammar-token-async-with-stmt3982584
Ref: 14fc3982584
Ref: The async with statement-Footnote-13983564
Node: Top-level components3983613
Ref: reference/toplevel_components doc3983762
Ref: 14fd3983762
Ref: reference/toplevel_components top-level3983762
Ref: 14fe3983762
Ref: reference/toplevel_components top-level-components3983762
Ref: 14ff3983762
Node: Complete Python programs3984155
Ref: reference/toplevel_components complete-python-programs3984255
Ref: 15003984255
Ref: reference/toplevel_components programs3984255
Ref: 14063984255
Node: File input3985638
Ref: reference/toplevel_components file-input3985764
Ref: 15013985764
Ref: reference/toplevel_components id13985764
Ref: 15023985764
Ref: reference/toplevel_components grammar-token-file-input3985861
Ref: 15033985861
Node: Interactive input3986137
Ref: reference/toplevel_components interactive3986255
Ref: 15043986255
Ref: reference/toplevel_components interactive-input3986255
Ref: 15053986255
Ref: reference/toplevel_components grammar-token-interactive-input3986370
Ref: 15063986370
Node: Expression input3986603
Ref: reference/toplevel_components expression-input3986702
Ref: 15073986702
Ref: reference/toplevel_components id23986702
Ref: 15083986702
Ref: reference/toplevel_components grammar-token-eval-input3986904
Ref: 15093986904
Node: Full Grammar specification3986950
Ref: reference/grammar doc3987071
Ref: 150a3987071
Ref: reference/grammar full-grammar-specification3987071
Ref: 150b3987071
Node: The Python Standard Library3998063
Ref: library/index doc3998223
Ref: 150c3998223
Ref: library/index library-index3998223
Ref: 11353998223
Ref: library/index the-python-standard-library3998223
Ref: 150d3998223
Ref: The Python Standard Library-Footnote-14000953
Node: Introduction<6>4000978
Ref: library/intro doc4001084
Ref: 150e4001084
Ref: library/intro introduction4001084
Ref: 150f4001084
Ref: library/intro library-intro4001084
Ref: 15104001084
Node: Notes on availability4003767
Ref: library/intro availability4003840
Ref: 129a4003840
Ref: library/intro notes-on-availability4003840
Ref: 15114003840
Node: Built-in Functions4004229
Ref: library/functions doc4004362
Ref: 15124004362
Ref: library/functions built-in-funcs4004362
Ref: be64004362
Ref: library/functions built-in-functions4004362
Ref: 15134004362
Ref: library/functions abs4008923
Ref: 11f84008923
Ref: library/functions all4009210
Ref: d784009210
Ref: library/functions any4009523
Ref: d774009523
Ref: library/functions ascii4009847
Ref: d3f4009847
Ref: library/functions bin4010205
Ref: c334010205
Ref: library/functions bool4010873
Ref: 1834010873
Ref: library/functions breakpoint4011465
Ref: 2ee4011465
Ref: library/functions func-bytearray4012296
Ref: ff74012296
Ref: library/functions func-bytes4013673
Ref: ff64013673
Ref: library/functions callable4014372
Ref: b374014372
Ref: library/functions chr4014925
Ref: 13634014925
Ref: library/functions classmethod4015381
Ref: 1d64015381
Ref: library/functions compile4016374
Ref: 1b24016374
Ref: library/functions complex4020594
Ref: 1894020594
Ref: library/functions delattr4022111
Ref: 15144022111
Ref: library/functions func-dict4022480
Ref: 15174022480
Ref: library/functions dir4022937
Ref: d264022937
Ref: library/functions divmod4025711
Ref: f4d4025711
Ref: library/functions enumerate4026352
Ref: dd64026352
Ref: library/functions eval4027243
Ref: b834027243
Ref: library/functions exec4029568
Ref: c374029568
Ref: library/functions filter4032153
Ref: c214032153
Ref: library/functions float4032954
Ref: 1874032954
Ref: library/functions grammar-token-sign4033574
Ref: 15284033574
Ref: library/functions grammar-token-infinity4033613
Ref: 15294033613
Ref: library/functions grammar-token-nan4033661
Ref: 152a4033661
Ref: library/functions grammar-token-numeric-value4033696
Ref: 152b4033696
Ref: library/functions grammar-token-numeric-string4033754
Ref: 152c4033754
Ref: library/functions format4035272
Ref: 4d04035272
Ref: library/functions func-frozenset4036363
Ref: 151b4036363
Ref: library/functions getattr4036838
Ref: 43d4036838
Ref: library/functions globals4037301
Ref: 151e4037301
Ref: library/functions hasattr4037577
Ref: 43c4037577
Ref: library/functions hash4037916
Ref: 9b84037916
Ref: library/functions help4038502
Ref: 5674038502
Ref: library/functions hex4039554
Ref: c594039554
Ref: library/functions id4040622
Ref: d794040622
Ref: library/functions input4040988
Ref: c5e4040988
Ref: library/functions int4041843
Ref: 1844041843
Ref: library/functions isinstance4043920
Ref: 4444043920
Ref: library/functions issubclass4044508
Ref: 4454044508
Ref: library/functions iter4044894
Ref: d1a4044894
Ref: library/functions len4046266
Ref: 1504046266
Ref: library/functions func-list4046499
Ref: 151c4046499
Ref: library/functions locals4046721
Ref: 44a4046721
Ref: library/functions map4047248
Ref: c204047248
Ref: library/functions max4047774
Ref: 7fe4047774
Ref: library/functions func-memoryview4048968
Ref: 15154048968
Ref: library/functions min4049131
Ref: 7fd4049131
Ref: library/functions next4050316
Ref: 6764050316
Ref: library/functions object4050584
Ref: 2ae4050584
Ref: library/functions oct4051003
Ref: c584051003
Ref: library/functions open4051775
Ref: 4e54051775
Ref: library/functions filemodes4053167
Ref: 15314053167
Ref: library/functions open-newline-parameter4058343
Ref: 15334058343
Ref: library/functions ord4063407
Ref: 13624063407
Ref: library/functions pow4063729
Ref: 1524063729
Ref: library/functions print4065356
Ref: 87a4065356
Ref: library/functions property4066542
Ref: 1d54066542
Ref: library/functions func-range4069250
Ref: 151d4069250
Ref: library/functions repr4069517
Ref: 7c04069517
Ref: library/functions reversed4070124
Ref: 18e4070124
Ref: library/functions round4070438
Ref: c604070438
Ref: library/functions func-set4071758
Ref: 15164071758
Ref: library/functions setattr4072216
Ref: 15184072216
Ref: library/functions slice4072633
Ref: df74072633
Ref: library/functions sorted4073414
Ref: 4394073414
Ref: library/functions staticmethod4074502
Ref: 1d74074502
Ref: library/functions func-str4075741
Ref: 15194075741
Ref: library/functions sum4076078
Ref: 1e34076078
Ref: library/functions super4076787
Ref: 4d74076787
Ref: library/functions func-tuple4080503
Ref: 151a4080503
Ref: library/functions type4080734
Ref: 5fd4080734
Ref: library/functions vars4082060
Ref: f6f4082060
Ref: library/functions zip4082741
Ref: c254082741
Ref: library/functions __import__4084684
Ref: 6054084684
Ref: Built-in Functions-Footnote-14087859
Ref: Built-in Functions-Footnote-24088069
Ref: Built-in Functions-Footnote-34088118
Ref: Built-in Functions-Footnote-44088195
Ref: Built-in Functions-Footnote-54088244
Node: Built-in Constants4088293
Ref: library/constants doc4088425
Ref: 15444088425
Ref: library/constants built-in-constants4088425
Ref: 15454088425
Ref: library/constants built-in-consts4088425
Ref: 15464088425
Ref: library/constants False4088544
Ref: 37d4088544
Ref: library/constants True4088694
Ref: 48f4088694
Ref: library/constants None4088841
Ref: 1574088841
Ref: library/constants NotImplemented4089120
Ref: 8404089120
Ref: library/constants Ellipsis4090453
Ref: 15474090453
Ref: library/constants __debug__4090649
Ref: f304090649
Node: Constants added by the site module4091118
Ref: library/constants constants-added-by-the-site-module4091207
Ref: 15484091207
Ref: library/constants quit4091575
Ref: 15494091575
Ref: library/constants exit4091602
Ref: 154a4091602
Ref: library/constants copyright4091818
Ref: 154b4091818
Ref: library/constants credits4091838
Ref: 154c4091838
Ref: library/constants license4091959
Ref: 154d4091959
Node: Built-in Types4092186
Ref: library/stdtypes doc4092319
Ref: 154e4092319
Ref: library/stdtypes bltin-types4092319
Ref: 154f4092319
Ref: library/stdtypes built-in-types4092319
Ref: 15504092319
Node: Truth Value Testing4093741
Ref: library/stdtypes truth4093853
Ref: 151f4093853
Ref: library/stdtypes truth-value-testing4093853
Ref: 15514093853
Ref: Truth Value Testing-Footnote-14094926
Node: Boolean Operations — and or not4095066
Ref: library/stdtypes boolean4095201
Ref: 15524095201
Ref: library/stdtypes boolean-operations-and-or-not4095201
Ref: 15534095201
Node: Comparisons<2>4096530
Ref: library/stdtypes comparisons4096681
Ref: 15544096681
Ref: library/stdtypes stdcomparisons4096681
Ref: 15554096681
Node: Numeric Types — int float complex4099125
Ref: library/stdtypes numeric-types-int-float-complex4099257
Ref: 15564099257
Ref: library/stdtypes typesnumeric4099257
Ref: 11594099257
Ref: Numeric Types — int float complex-Footnote-14107238
Node: Bitwise Operations on Integer Types4107357
Ref: library/stdtypes bitstring-ops4107508
Ref: 15574107508
Ref: library/stdtypes bitwise-operations-on-integer-types4107508
Ref: 15584107508
Node: Additional Methods on Integer Types4109902
Ref: library/stdtypes additional-methods-on-integer-types4110089
Ref: 15594110089
Ref: library/stdtypes int bit_length4110315
Ref: 155a4110315
Ref: library/stdtypes int to_bytes4111230
Ref: 155b4111230
Ref: library/stdtypes int from_bytes4112640
Ref: 155d4112640
Ref: library/stdtypes int as_integer_ratio4113836
Ref: 1864113836
Node: Additional Methods on Float4114150
Ref: library/stdtypes additional-methods-on-float4114326
Ref: 155e4114326
Ref: library/stdtypes float as_integer_ratio4114538
Ref: 125d4114538
Ref: library/stdtypes float is_integer4114794
Ref: 155f4114794
Ref: library/stdtypes float hex4115421
Ref: 125e4115421
Ref: library/stdtypes float fromhex4115671
Ref: 15604115671
Node: Hashing of numeric types4117305
Ref: library/stdtypes hashing-of-numeric-types4117437
Ref: 15614117437
Ref: library/stdtypes numeric-hash4117437
Ref: 15624117437
Node: Iterator Types4121695
Ref: library/stdtypes iterator-types4121848
Ref: 15634121848
Ref: library/stdtypes typeiter4121848
Ref: 13984121848
Ref: library/stdtypes container __iter__4122230
Ref: 15644122230
Ref: library/stdtypes iterator __iter__4122964
Ref: 15654122964
Ref: library/stdtypes iterator __next__4123302
Ref: c574123302
Node: Generator Types4124072
Ref: library/stdtypes generator-types4124138
Ref: 15664124138
Ref: library/stdtypes id34124138
Ref: 15674124138
Node: Sequence Types — list tuple range4124634
Ref: library/stdtypes sequence-types-list-tuple-range4124778
Ref: 15684124778
Ref: library/stdtypes typesseq4124778
Ref: 11aa4124778
Node: Common Sequence Operations4125245
Ref: library/stdtypes common-sequence-operations4125376
Ref: 15694125376
Ref: library/stdtypes typesseq-common4125376
Ref: 156a4125376
Ref: Common Sequence Operations-Footnote-14133787
Node: Immutable Sequence Types4133870
Ref: library/stdtypes immutable-sequence-types4134032
Ref: 156f4134032
Ref: library/stdtypes typesseq-immutable4134032
Ref: 15704134032
Node: Mutable Sequence Types4134565
Ref: library/stdtypes mutable-sequence-types4134709
Ref: 15714134709
Ref: library/stdtypes typesseq-mutable4134709
Ref: 15214134709
Node: Lists<2>4140372
Ref: library/stdtypes lists4140498
Ref: 15724140498
Ref: library/stdtypes typesseq-list4140498
Ref: 152f4140498
Ref: library/stdtypes list4140681
Ref: 2604140681
Ref: library/stdtypes list sort4141868
Ref: 43a4141868
Node: Tuples4144185
Ref: library/stdtypes tuples4144295
Ref: 15734144295
Ref: library/stdtypes typesseq-tuple4144295
Ref: 15424144295
Ref: library/stdtypes tuple4144658
Ref: 4734144658
Node: Ranges4146213
Ref: library/stdtypes ranges4146306
Ref: 15744146306
Ref: library/stdtypes typesseq-range4146306
Ref: 153a4146306
Ref: library/stdtypes range4146495
Ref: 9b24146495
Ref: library/stdtypes range start4148465
Ref: 15754148465
Ref: library/stdtypes range stop4148595
Ref: 15764148595
Ref: library/stdtypes range step4148666
Ref: 15774148666
Ref: Ranges-Footnote-14150673
Node: Text Sequence Type — str4150725
Ref: library/stdtypes text-sequence-type-str4150907
Ref: 15784150907
Ref: library/stdtypes textseq4150907
Ref: 115d4150907
Ref: library/stdtypes str4152574
Ref: 3254152574
Node: String Methods<2>4154712
Ref: library/stdtypes id54154831
Ref: 157b4154831
Ref: library/stdtypes string-methods4154831
Ref: 115e4154831
Ref: library/stdtypes str capitalize4155673
Ref: 157e4155673
Ref: library/stdtypes str casefold4156039
Ref: 6a44156039
Ref: library/stdtypes str center4156659
Ref: 11d54156659
Ref: library/stdtypes str count4156931
Ref: 15804156931
Ref: library/stdtypes str encode4157167
Ref: c2a4157167
Ref: library/stdtypes str endswith4157906
Ref: 7bb4157906
Ref: library/stdtypes str expandtabs4158241
Ref: 15814158241
Ref: library/stdtypes str find4159356
Ref: 7934159356
Ref: library/stdtypes str format4159905
Ref: 4cf4159905
Ref: library/stdtypes str format_map4161417
Ref: 6a54161417
Ref: library/stdtypes str index4161928
Ref: 15824161928
Ref: library/stdtypes str isalnum4162074
Ref: 15834162074
Ref: library/stdtypes str isalpha4162414
Ref: 15844162414
Ref: library/stdtypes str isascii4162912
Ref: 3284162912
Ref: library/stdtypes str isdecimal4163152
Ref: 15854163152
Ref: library/stdtypes str isdigit4163540
Ref: 15864163540
Ref: library/stdtypes str isidentifier4164048
Ref: 15874164048
Ref: library/stdtypes str islower4164601
Ref: 15894164601
Ref: library/stdtypes str isnumeric4164785
Ref: 158a4164785
Ref: library/stdtypes str isprintable4165265
Ref: 6a64165265
Ref: library/stdtypes str isspace4165883
Ref: 158b4165883
Ref: library/stdtypes str istitle4166305
Ref: 158c4166305
Ref: library/stdtypes str isupper4166586
Ref: 158d4166586
Ref: library/stdtypes str join4166770
Ref: 156d4166770
Ref: library/stdtypes str ljust4167098
Ref: 11d44167098
Ref: library/stdtypes str lower4167385
Ref: 157f4167385
Ref: library/stdtypes str lstrip4167604
Ref: 158e4167604
Ref: library/stdtypes str maketrans4168118
Ref: 6a74168118
Ref: library/stdtypes str partition4168847
Ref: 7964168847
Ref: library/stdtypes str replace4169186
Ref: 15904169186
Ref: library/stdtypes str rfind4169427
Ref: 7944169427
Ref: library/stdtypes str rindex4169724
Ref: 15914169724
Ref: library/stdtypes str rjust4169879
Ref: 11d34169879
Ref: library/stdtypes str rpartition4170167
Ref: 15924170167
Ref: library/stdtypes str rsplit4170506
Ref: 15934170506
Ref: library/stdtypes str rstrip4170956
Ref: 15944170956
Ref: library/stdtypes str split4171460
Ref: 7954171460
Ref: library/stdtypes str splitlines4173119
Ref: 15954173119
Ref: library/stdtypes str startswith4175765
Ref: 7ba4175765
Ref: library/stdtypes str strip4176102
Ref: 15964176102
Ref: library/stdtypes str swapcase4177110
Ref: 15974177110
Ref: library/stdtypes str title4177327
Ref: 15984177327
Ref: library/stdtypes str translate4178380
Ref: 158f4178380
Ref: library/stdtypes str upper4179286
Ref: 159a4179286
Ref: library/stdtypes str zfill4179751
Ref: 11d64179751
Ref: String Methods<2>-Footnote-14180272
Ref: String Methods<2>-Footnote-24180448
Ref: String Methods<2>-Footnote-34180624
Ref: String Methods<2>-Footnote-44180800
Node: printf-style String Formatting4180976
Ref: library/stdtypes old-string-formatting4181095
Ref: 115f4181095
Ref: library/stdtypes printf-style-string-formatting4181095
Ref: 159b4181095
Ref: printf-style String Formatting-Footnote-14190306
Ref: printf-style String Formatting-Footnote-24190437
Node: Binary Sequence Types — bytes bytearray memoryview4190486
Ref: library/stdtypes binary-sequence-types-bytes-bytearray-memoryview4190660
Ref: 159d4190660
Ref: library/stdtypes binaryseq4190660
Ref: 15234190660
Node: Bytes Objects4191352
Ref: library/stdtypes bytes-objects4191480
Ref: 159e4191480
Ref: library/stdtypes typebytes4191480
Ref: 15254191480
Ref: library/stdtypes bytes4191820
Ref: 3264191820
Ref: library/stdtypes bytes fromhex4194074
Ref: 3234194074
Ref: library/stdtypes bytes hex4194675
Ref: 6254194675
Node: Bytearray Objects4196850
Ref: library/stdtypes bytearray-objects4197017
Ref: 159f4197017
Ref: library/stdtypes typebytearray4197017
Ref: 15244197017
Ref: library/stdtypes bytearray4197157
Ref: 3274197157
Ref: library/stdtypes bytearray fromhex4198194
Ref: 3244198194
Ref: library/stdtypes bytearray hex4198824
Ref: 6264198824
Node: Bytes and Bytearray Operations4199612
Ref: library/stdtypes bytes-and-bytearray-operations4199795
Ref: 15a04199795
Ref: library/stdtypes bytes-methods4199795
Ref: 15224199795
Ref: library/stdtypes bytes count4201013
Ref: 15a14201013
Ref: library/stdtypes bytearray count4201059
Ref: 15a24201059
Ref: library/stdtypes bytes decode4201522
Ref: c2b4201522
Ref: library/stdtypes bytearray decode4201583
Ref: 15a34201583
Ref: library/stdtypes bytes endswith4202469
Ref: 15a44202469
Ref: library/stdtypes bytearray endswith4202521
Ref: 15a54202521
Ref: library/stdtypes bytes find4202948
Ref: 15a64202948
Ref: library/stdtypes bytearray find4202993
Ref: 15a74202993
Ref: library/stdtypes bytes index4203799
Ref: 15a84203799
Ref: library/stdtypes bytearray index4203845
Ref: 15a94203845
Ref: library/stdtypes bytes join4204219
Ref: 156e4204219
Ref: library/stdtypes bytearray join4204253
Ref: 15aa4204253
Ref: library/stdtypes bytes maketrans4204689
Ref: bfc4204689
Ref: library/stdtypes bytearray maketrans4204735
Ref: bfd4204735
Ref: library/stdtypes bytes partition4205101
Ref: 15ac4205101
Ref: library/stdtypes bytearray partition4205135
Ref: 15ad4205135
Ref: library/stdtypes bytes replace4205622
Ref: 15ae4205622
Ref: library/stdtypes bytearray replace4205668
Ref: 15af4205668
Ref: library/stdtypes bytes rfind4206188
Ref: 15b04206188
Ref: library/stdtypes bytearray rfind4206234
Ref: 15b14206234
Ref: library/stdtypes bytes rindex4206764
Ref: 15b24206764
Ref: library/stdtypes bytearray rindex4206811
Ref: 15b34206811
Ref: library/stdtypes bytes rpartition4207194
Ref: 15b44207194
Ref: library/stdtypes bytearray rpartition4207229
Ref: 15b54207229
Ref: library/stdtypes bytes startswith4207716
Ref: 15b64207716
Ref: library/stdtypes bytearray startswith4207770
Ref: 15b74207770
Ref: library/stdtypes bytes translate4208206
Ref: 15ab4208206
Ref: library/stdtypes bytearray translate4208257
Ref: c844208257
Ref: library/stdtypes bytes center4209278
Ref: 15b84209278
Ref: library/stdtypes bytearray center4209323
Ref: 15b94209323
Ref: library/stdtypes bytes ljust4209824
Ref: 15ba4209824
Ref: library/stdtypes bytearray ljust4209868
Ref: 15bb4209868
Ref: library/stdtypes bytes lstrip4210374
Ref: 15bc4210374
Ref: library/stdtypes bytearray lstrip4210409
Ref: 15bd4210409
Ref: library/stdtypes bytes rjust4211310
Ref: 15be4211310
Ref: library/stdtypes bytearray rjust4211354
Ref: 15bf4211354
Ref: library/stdtypes bytes rsplit4211861
Ref: 15c04211861
Ref: library/stdtypes bytearray rsplit4211910
Ref: 15c14211910
Ref: library/stdtypes bytes rstrip4212424
Ref: 15c34212424
Ref: library/stdtypes bytearray rstrip4212459
Ref: 15c44212459
Ref: library/stdtypes bytes split4213350
Ref: 15c54213350
Ref: library/stdtypes bytearray split4213398
Ref: 15c24213398
Ref: library/stdtypes bytes strip4215321
Ref: 15c64215321
Ref: library/stdtypes bytearray strip4215355
Ref: 15c74215355
Ref: library/stdtypes bytes capitalize4216542
Ref: 15c84216542
Ref: library/stdtypes bytearray capitalize4216574
Ref: 15c94216574
Ref: library/stdtypes bytes expandtabs4216983
Ref: 15ca4216983
Ref: library/stdtypes bytearray expandtabs4217024
Ref: 15cb4217024
Ref: library/stdtypes bytes isalnum4218366
Ref: 15cc4218366
Ref: library/stdtypes bytearray isalnum4218395
Ref: 15cd4218395
Ref: library/stdtypes bytes isalpha4218957
Ref: 15ce4218957
Ref: library/stdtypes bytearray isalpha4218986
Ref: 15cf4218986
Ref: library/stdtypes bytes isascii4219423
Ref: 15d04219423
Ref: library/stdtypes bytearray isascii4219452
Ref: 15d14219452
Ref: library/stdtypes bytes isdigit4219667
Ref: 15d24219667
Ref: library/stdtypes bytearray isdigit4219696
Ref: 15d34219696
Ref: library/stdtypes bytes islower4220068
Ref: 15d44220068
Ref: library/stdtypes bytearray islower4220097
Ref: 15d54220097
Ref: library/stdtypes bytes isspace4220635
Ref: 15d64220635
Ref: library/stdtypes bytearray isspace4220664
Ref: 15d74220664
Ref: library/stdtypes bytes istitle4220996
Ref: 15d84220996
Ref: library/stdtypes bytearray istitle4221025
Ref: 15d94221025
Ref: library/stdtypes bytes isupper4221398
Ref: 15db4221398
Ref: library/stdtypes bytearray isupper4221427
Ref: 15dc4221427
Ref: library/stdtypes bytes lower4221981
Ref: 15dd4221981
Ref: library/stdtypes bytearray lower4222008
Ref: 15de4222008
Ref: library/stdtypes bytes splitlines4222647
Ref: 15df4222647
Ref: library/stdtypes bytearray splitlines4222693
Ref: 15e04222693
Ref: library/stdtypes bytes swapcase4223642
Ref: 15e14223642
Ref: library/stdtypes bytearray swapcase4223672
Ref: 15e24223672
Ref: library/stdtypes bytes title4224602
Ref: 15da4224602
Ref: library/stdtypes bytearray title4224629
Ref: 15e34224629
Ref: library/stdtypes bytes upper4226254
Ref: 15e44226254
Ref: library/stdtypes bytearray upper4226281
Ref: 15e54226281
Ref: library/stdtypes bytes zfill4226920
Ref: 15e64226920
Ref: library/stdtypes bytearray zfill4226952
Ref: 15e74226952
Node: printf-style Bytes Formatting4227662
Ref: library/stdtypes bytes-formatting4227840
Ref: 6444227840
Ref: library/stdtypes printf-style-bytes-formatting4227840
Ref: 15e84227840
Ref: printf-style Bytes Formatting-Footnote-14237333
Ref: printf-style Bytes Formatting-Footnote-24237464
Ref: printf-style Bytes Formatting-Footnote-34237513
Node: Memory Views4237562
Ref: library/stdtypes memory-views4237701
Ref: 15e94237701
Ref: library/stdtypes typememoryview4237701
Ref: 15304237701
Ref: library/stdtypes memoryview4237899
Ref: 25a4237899
Ref: library/stdtypes memoryview __eq__4241663
Ref: 15ed4241663
Ref: library/stdtypes memoryview tobytes4243665
Ref: 15ee4243665
Ref: library/stdtypes memoryview hex4244768
Ref: 6274244768
Ref: library/stdtypes memoryview tolist4245025
Ref: 15ea4245025
Ref: library/stdtypes memoryview toreadonly4245587
Ref: 15ef4245587
Ref: library/stdtypes memoryview release4246199
Ref: b304246199
Ref: library/stdtypes memoryview cast4247565
Ref: 15f04247565
Ref: library/stdtypes memoryview obj4250584
Ref: 15f24250584
Ref: library/stdtypes memoryview nbytes4250822
Ref: 15f34250822
Ref: library/stdtypes memoryview readonly4251948
Ref: 15f44251948
Ref: library/stdtypes memoryview format4252040
Ref: 15ec4252040
Ref: library/stdtypes memoryview itemsize4252578
Ref: 15eb4252578
Ref: library/stdtypes memoryview ndim4252954
Ref: 15f54252954
Ref: library/stdtypes memoryview shape4253095
Ref: 15f64253095
Ref: library/stdtypes memoryview strides4253350
Ref: 15f74253350
Ref: library/stdtypes memoryview suboffsets4253640
Ref: 15f84253640
Ref: library/stdtypes memoryview c_contiguous4253765
Ref: 15f94253765
Ref: library/stdtypes memoryview f_contiguous4253917
Ref: 15fa4253917
Ref: library/stdtypes memoryview contiguous4254075
Ref: 15fb4254075
Ref: Memory Views-Footnote-14254259
Node: Set Types — set frozenset4254308
Ref: library/stdtypes set-types-set-frozenset4254478
Ref: 15fc4254478
Ref: library/stdtypes types-set4254478
Ref: 152d4254478
Ref: library/stdtypes set4256028
Ref: b624256028
Ref: library/stdtypes frozenset4256056
Ref: be14256056
Ref: library/stdtypes frozenset isdisjoint4256741
Ref: 15fd4256741
Ref: library/stdtypes frozenset issubset4256949
Ref: 15fe4256949
Ref: library/stdtypes frozenset issuperset4257228
Ref: 15ff4257228
Ref: library/stdtypes frozenset union4257511
Ref: 16004257511
Ref: library/stdtypes frozenset intersection4257652
Ref: 16014257652
Ref: library/stdtypes frozenset difference4257815
Ref: 16024257815
Ref: library/stdtypes frozenset symmetric_difference4257981
Ref: 16034257981
Ref: library/stdtypes frozenset copy4258153
Ref: 16044258153
Ref: library/stdtypes frozenset update4260394
Ref: 16054260394
Ref: library/stdtypes frozenset intersection_update4260526
Ref: 16064260526
Ref: library/stdtypes frozenset difference_update4260698
Ref: 16074260698
Ref: library/stdtypes frozenset symmetric_difference_update4260843
Ref: 16084260843
Ref: library/stdtypes frozenset add4261025
Ref: 16094261025
Ref: library/stdtypes frozenset remove4261096
Ref: 160a4261096
Ref: library/stdtypes frozenset discard4261253
Ref: 160b4261253
Ref: library/stdtypes frozenset pop4261350
Ref: 160c4261350
Ref: library/stdtypes frozenset clear4261499
Ref: 160d4261499
Node: Mapping Types — dict4262059
Ref: library/stdtypes mapping-types-dict4262198
Ref: 160e4262198
Ref: library/stdtypes typesmapping4262198
Ref: 2f14262198
Ref: library/stdtypes dict4263431
Ref: 1b64263431
Ref: library/stdtypes dict clear4267293
Ref: 160f4267293
Ref: library/stdtypes dict copy4267369
Ref: 43b4267369
Ref: library/stdtypes dict fromkeys4267447
Ref: 16104267447
Ref: library/stdtypes dict get4267983
Ref: 16114267983
Ref: library/stdtypes dict items4268238
Ref: c1e4268238
Ref: library/stdtypes dict keys4268412
Ref: c1d4268412
Ref: library/stdtypes dict pop4268557
Ref: 16134268557
Ref: library/stdtypes dict popitem4268810
Ref: 16144268810
Ref: library/stdtypes dict setdefault4269552
Ref: 9b34269552
Ref: library/stdtypes dict update4269782
Ref: dbc4269782
Ref: library/stdtypes dict values4270266
Ref: c1f4270266
Node: Dictionary view objects4272373
Ref: library/stdtypes dict-views4272455
Ref: 16124272455
Ref: library/stdtypes dictionary-view-objects4272455
Ref: 16154272455
Node: Context Manager Types4275357
Ref: library/stdtypes context-manager-types4275489
Ref: 16174275489
Ref: library/stdtypes typecontextmanager4275489
Ref: 13c44275489
Ref: library/stdtypes contextmanager __enter__4275854
Ref: 16184275854
Ref: library/stdtypes contextmanager __exit__4276853
Ref: 161a4276853
Node: Other Built-in Types4279239
Ref: library/stdtypes other-built-in-types4279367
Ref: 161b4279367
Ref: library/stdtypes typesother4279367
Ref: 161c4279367
Node: Modules<2>4279772
Ref: library/stdtypes modules4279875
Ref: 161d4279875
Ref: library/stdtypes typesmodules4279875
Ref: 161e4279875
Node: Classes and Class Instances4281028
Ref: library/stdtypes classes-and-class-instances4281149
Ref: 161f4281149
Ref: library/stdtypes typesobjects4281149
Ref: 16204281149
Node: Functions4281313
Ref: library/stdtypes functions4281431
Ref: 16214281431
Ref: library/stdtypes typesfunctions4281431
Ref: 16224281431
Node: Methods4281895
Ref: library/stdtypes methods4281998
Ref: 16234281998
Ref: library/stdtypes typesmethods4281998
Ref: 16244281998
Node: Code Objects4283769
Ref: library/stdtypes bltin-code-objects4283875
Ref: 16254283875
Ref: library/stdtypes code-objects4283875
Ref: 16264283875
Node: Type Objects4284581
Ref: library/stdtypes bltin-type-objects4284695
Ref: 15434284695
Ref: library/stdtypes type-objects4284695
Ref: 16274284695
Node: The Null Object4285046
Ref: library/stdtypes bltin-null-object4285167
Ref: 16284285167
Ref: library/stdtypes the-null-object4285167
Ref: 16294285167
Node: The Ellipsis Object4285482
Ref: library/stdtypes bltin-ellipsis-object4285616
Ref: 162a4285616
Ref: library/stdtypes the-ellipsis-object4285616
Ref: 162b4285616
Node: The NotImplemented Object4285984
Ref: library/stdtypes bltin-notimplemented-object4286117
Ref: 162c4286117
Ref: library/stdtypes the-notimplemented-object4286117
Ref: 162d4286117
Node: Boolean Values4286520
Ref: library/stdtypes bltin-boolean-values4286650
Ref: 15204286650
Ref: library/stdtypes boolean-values4286650
Ref: 162e4286650
Node: Internal Objects4287273
Ref: library/stdtypes internal-objects4287369
Ref: 162f4287369
Ref: library/stdtypes typesinternal4287369
Ref: 16304287369
Node: Special Attributes4287565
Ref: library/stdtypes special-attributes4287663
Ref: 16314287663
Ref: library/stdtypes specialattrs4287663
Ref: 16324287663
Ref: library/stdtypes object __dict__4287902
Ref: 4f14287902
Ref: library/stdtypes instance __class__4288033
Ref: dfd4288033
Ref: library/stdtypes class __bases__4288119
Ref: dfc4288119
Ref: library/stdtypes definition __name__4288202
Ref: c5a4288202
Ref: library/stdtypes definition __qualname__4288325
Ref: 13654288325
Ref: library/stdtypes class __mro__4288501
Ref: 15404288501
Ref: library/stdtypes class mro4288655
Ref: 16334288655
Ref: library/stdtypes class __subclasses__4288889
Ref: 16344288889
Node: Built-in Exceptions4289152
Ref: library/exceptions doc4289291
Ref: 16354289291
Ref: library/exceptions bltin-exceptions4289291
Ref: 11e74289291
Ref: library/exceptions built-in-exceptions4289291
Ref: 16364289291
Node: Base classes4292579
Ref: library/exceptions base-classes4292675
Ref: 16374292675
Ref: library/exceptions BaseException4292794
Ref: 1a74292794
Ref: library/exceptions BaseException args4293179
Ref: 16384293179
Ref: library/exceptions BaseException with_traceback4293547
Ref: 16394293547
Ref: library/exceptions Exception4293956
Ref: 1a84293956
Ref: library/exceptions ArithmeticError4294140
Ref: 163a4294140
Ref: library/exceptions BufferError4294369
Ref: 163c4294369
Ref: library/exceptions LookupError4294481
Ref: 15994294481
Node: Concrete exceptions4294747
Ref: library/exceptions concrete-exceptions4294860
Ref: 163e4294860
Ref: library/exceptions AssertionError4294983
Ref: f664294983
Ref: library/exceptions AttributeError4295071
Ref: 3904295071
Ref: library/exceptions EOFError4295341
Ref: c5f4295341
Ref: library/exceptions FloatingPointError4295618
Ref: 163b4295618
Ref: library/exceptions GeneratorExit4295679
Ref: d254295679
Ref: library/exceptions ImportError4296001
Ref: 3294296001
Ref: library/exceptions ModuleNotFoundError4296576
Ref: 38f4296576
Ref: library/exceptions IndexError4296838
Ref: e694296838
Ref: library/exceptions KeyError4297065
Ref: 2c54297065
Ref: library/exceptions KeyboardInterrupt4297182
Ref: 1974297182
Ref: library/exceptions MemoryError4297572
Ref: f424297572
Ref: library/exceptions NameError4298153
Ref: d6e4298153
Ref: library/exceptions NotImplementedError4298375
Ref: 6034298375
Ref: library/exceptions OSError4299219
Ref: 1d14299219
Ref: library/exceptions OSError errno4300256
Ref: 16414300256
Ref: library/exceptions OSError winerror4300348
Ref: 16424300348
Ref: library/exceptions OSError strerror4300927
Ref: 16434300927
Ref: library/exceptions OSError filename4301163
Ref: 16444301163
Ref: library/exceptions OSError filename24301192
Ref: 16454301192
Ref: library/exceptions OverflowError4302170
Ref: 9544302170
Ref: library/exceptions RecursionError4302662
Ref: 6284302662
Ref: library/exceptions ReferenceError4302984
Ref: e404302984
Ref: library/exceptions RuntimeError4303310
Ref: 2b84303310
Ref: library/exceptions StopIteration4303512
Ref: 47b4303512
Ref: library/exceptions StopAsyncIteration4304842
Ref: f494304842
Ref: library/exceptions SyntaxError4305034
Ref: 44d4305034
Ref: library/exceptions IndentationError4305556
Ref: e6c4305556
Ref: library/exceptions TabError4305709
Ref: e6b4305709
Ref: library/exceptions SystemError4305870
Ref: 5f04305870
Ref: library/exceptions SystemExit4306513
Ref: 5f14306513
Ref: library/exceptions SystemExit code4307809
Ref: 16474307809
Ref: library/exceptions TypeError4307951
Ref: 1924307951
Ref: library/exceptions UnboundLocalError4308780
Ref: e6a4308780
Ref: library/exceptions UnicodeError4308998
Ref: c2e4308998
Ref: library/exceptions UnicodeError encoding4309359
Ref: 16484309359
Ref: library/exceptions UnicodeError reason4309448
Ref: 16494309448
Ref: library/exceptions UnicodeError object4309533
Ref: 164a4309533
Ref: library/exceptions UnicodeError start4309629
Ref: 164b4309629
Ref: library/exceptions UnicodeError end4309721
Ref: 164c4309721
Ref: library/exceptions UnicodeEncodeError4309817
Ref: 1fa4309817
Ref: library/exceptions UnicodeDecodeError4309969
Ref: 1fb4309969
Ref: library/exceptions UnicodeTranslateError4310121
Ref: 164d4310121
Ref: library/exceptions ValueError4310279
Ref: 1f94310279
Ref: library/exceptions ZeroDivisionError4310531
Ref: 11e64310531
Ref: library/exceptions EnvironmentError4310888
Ref: 9874310888
Ref: library/exceptions IOError4310921
Ref: 9864310921
Ref: library/exceptions WindowsError4310945
Ref: 9884310945
Ref: Concrete exceptions-Footnote-14311071
Ref: Concrete exceptions-Footnote-24311120
Node: OS exceptions4311169
Ref: library/exceptions os-exceptions4311238
Ref: 16404311238
Ref: library/exceptions BlockingIOError4311399
Ref: 98b4311399
Ref: library/exceptions BlockingIOError characters_written4311755
Ref: 164e4311755
Ref: library/exceptions ChildProcessError4312010
Ref: 98c4312010
Ref: library/exceptions ConnectionError4312149
Ref: 6da4312149
Ref: library/exceptions BrokenPipeError4312397
Ref: 9914312397
Ref: library/exceptions ConnectionAbortedError4312696
Ref: 9924312696
Ref: library/exceptions ConnectionRefusedError4312898
Ref: 9934312898
Ref: library/exceptions ConnectionResetError4313100
Ref: 9944313100
Ref: library/exceptions FileExistsError4313283
Ref: 94c4313283
Ref: library/exceptions FileNotFoundError4313439
Ref: 7b44313439
Ref: library/exceptions InterruptedError4313591
Ref: 64d4313591
Ref: library/exceptions IsADirectoryError4313997
Ref: 98d4313997
Ref: library/exceptions NotADirectoryError4314176
Ref: 98e4314176
Ref: library/exceptions PermissionError4314390
Ref: 5f44314390
Ref: library/exceptions ProcessLookupError4314608
Ref: 98f4314608
Ref: library/exceptions TimeoutError4314740
Ref: 9904314740
Ref: OS exceptions-Footnote-14315077
Ref: OS exceptions-Footnote-24315126
Node: Warnings4315175
Ref: library/exceptions warning-categories-as-exceptions4315295
Ref: 164f4315295
Ref: library/exceptions warnings4315295
Ref: 16504315295
Ref: library/exceptions Warning4315456
Ref: 16524315456
Ref: library/exceptions UserWarning4315521
Ref: 16534315521
Ref: library/exceptions DeprecationWarning4315603
Ref: 2764315603
Ref: library/exceptions PendingDeprecationWarning4315761
Ref: 2774315761
Ref: library/exceptions SyntaxWarning4316155
Ref: 1914316155
Ref: library/exceptions RuntimeWarning4316237
Ref: 2be4316237
Ref: library/exceptions FutureWarning4316330
Ref: 31a4316330
Ref: library/exceptions ImportWarning4316517
Ref: 5cd4316517
Ref: library/exceptions UnicodeWarning4316620
Ref: d7a4316620
Ref: library/exceptions BytesWarning4316701
Ref: 4ab4316701
Ref: library/exceptions ResourceWarning4316820
Ref: 4c54316820
Node: Exception hierarchy4316981
Ref: library/exceptions exception-hierarchy4317073
Ref: 16544317073
Ref: library/text stringservices4319317
Ref: 157a4319317
Node: Text Processing Services4319318
Ref: library/text doc4319463
Ref: 16554319463
Ref: library/text text-processing-services4319463
Ref: 16564319463
Ref: library/text textservices4319463
Ref: 157d4319463
Node: string — Common string operations4320251
Ref: library/string doc4320392
Ref: 16584320392
Ref: library/string module-string4320392
Ref: f64320392
Ref: library/string string-common-string-operations4320392
Ref: 16594320392
Ref: string — Common string operations-Footnote-14320836
Node: String constants4320901
Ref: library/string string-constants4321022
Ref: 165a4321022
Ref: library/string string ascii_letters4321116
Ref: c4f4321116
Ref: library/string string ascii_lowercase4321315
Ref: 165b4321315
Ref: library/string string ascii_uppercase4321475
Ref: 165c4321475
Ref: library/string string digits4321635
Ref: 165d4321635
Ref: library/string string hexdigits4321697
Ref: 165e4321697
Ref: library/string string octdigits4321774
Ref: 165f4321774
Ref: library/string string punctuation4321837
Ref: 16604321837
Ref: library/string string printable4322012
Ref: 16614322012
Ref: library/string string whitespace4322240
Ref: 16624322240
Node: Custom String Formatting4322446
Ref: library/string custom-string-formatting4322596
Ref: 16634322596
Ref: library/string string-formatting4322596
Ref: 157c4322596
Ref: library/string string Formatter4323043
Ref: 7a94323043
Ref: library/string string Formatter format4323144
Ref: 4814323144
Ref: library/string string Formatter vformat4323505
Ref: 16644323505
Ref: library/string string Formatter parse4324216
Ref: 16654324216
Ref: library/string string Formatter get_field4324972
Ref: 16664324972
Ref: library/string string Formatter get_value4325521
Ref: 16674325521
Ref: library/string string Formatter check_unused_args4326757
Ref: 16684326757
Ref: library/string string Formatter format_field4327361
Ref: 16694327361
Ref: library/string string Formatter convert_field4327587
Ref: 166a4327587
Ref: Custom String Formatting-Footnote-14327962
Ref: Custom String Formatting-Footnote-24328011
Node: Format String Syntax4328060
Ref: library/string format-string-syntax4328210
Ref: 166b4328210
Ref: library/string formatstrings4328210
Ref: d0d4328210
Ref: library/string grammar-token-replacement-field4328949
Ref: 166c4328949
Ref: library/string grammar-token-field-name4329037
Ref: 166d4329037
Ref: library/string grammar-token-arg-name4329124
Ref: 166e4329124
Ref: library/string grammar-token-attribute-name4329178
Ref: 166f4329178
Ref: library/string grammar-token-element-index4329221
Ref: 16704329221
Ref: library/string grammar-token-index-string4329275
Ref: 16714329275
Ref: library/string grammar-token-conversion4329343
Ref: 16724329343
Ref: library/string grammar-token-format-spec4329391
Ref: 16734329391
Node: Format Specification Mini-Language4333388
Ref: library/string format-specification-mini-language4333503
Ref: 16754333503
Ref: library/string formatspec4333503
Ref: 4d34333503
Ref: library/string id14334397
Ref: 16764334397
Ref: library/string grammar-token-fill4334490
Ref: 16774334490
Ref: library/string grammar-token-align4334531
Ref: 16784334531
Ref: library/string grammar-token-sign4334578
Ref: 16794334578
Ref: library/string grammar-token-width4334619
Ref: 167a4334619
Ref: library/string grammar-token-grouping-option4334651
Ref: 167b4334651
Ref: library/string grammar-token-precision4334686
Ref: 167c4334686
Ref: library/string grammar-token-type4334718
Ref: 167d4334718
Ref: Format Specification Mini-Language-Footnote-14345548
Ref: Format Specification Mini-Language-Footnote-24345597
Node: Format examples4345646
Ref: library/string format-examples4345761
Ref: 167e4345761
Ref: library/string formatexamples4345761
Ref: 16744345761
Node: Template strings4350289
Ref: library/string id24350431
Ref: 167f4350431
Ref: library/string template-strings4350431
Ref: 159c4350431
Ref: library/string string Template4351892
Ref: 3e04351892
Ref: library/string string Template substitute4352012
Ref: 12384352012
Ref: library/string string Template safe_substitute4352497
Ref: 12394352497
Ref: library/string string Template template4353534
Ref: 16804353534
Ref: Template strings-Footnote-14357310
Ref: Template strings-Footnote-24357359
Node: Helper functions4357410
Ref: library/string helper-functions4357523
Ref: 16814357523
Ref: library/string string capwords4357574
Ref: 16824357574
Node: re — Regular expression operations4358060
Ref: library/re doc4358250
Ref: 16834358250
Ref: library/re module-re4358250
Ref: dd4358250
Ref: library/re re-regular-expression-operations4358250
Ref: 16844358250
Ref: re — Regular expression operations-Footnote-14360824
Ref: re — Regular expression operations-Footnote-24360885
Node: Regular Expression Syntax4360925
Ref: library/re re-syntax4361047
Ref: 16854361047
Ref: library/re regular-expression-syntax4361047
Ref: 16864361047
Ref: Regular Expression Syntax-Footnote-14384660
Node: Module Contents4384702
Ref: library/re contents-of-module-re4384859
Ref: 16914384859
Ref: library/re module-contents4384859
Ref: 16924384859
Ref: library/re re compile4385274
Ref: 43f4385274
Ref: library/re re A4386402
Ref: 168b4386402
Ref: library/re re ASCII4386417
Ref: 3bd4386417
Ref: library/re re DEBUG4387046
Ref: 16964387046
Ref: library/re re I4387161
Ref: 168c4387161
Ref: library/re re IGNORECASE4387176
Ref: 16974387176
Ref: library/re re L4388165
Ref: 168d4388165
Ref: library/re re LOCALE4388180
Ref: 3be4388180
Ref: library/re re M4389121
Ref: 168e4389121
Ref: library/re re MULTILINE4389136
Ref: 168a4389136
Ref: library/re re S4389721
Ref: 168f4389721
Ref: library/re re DOTALL4389736
Ref: 16894389736
Ref: library/re re X4389972
Ref: 16904389972
Ref: library/re re VERBOSE4389987
Ref: 16984389987
Ref: library/re re search4391003
Ref: ba54391003
Ref: library/re re match4391407
Ref: ba64391407
Ref: library/re re fullmatch4392058
Ref: 88f4392058
Ref: library/re re split4392387
Ref: 3bf4392387
Ref: library/re re findall4394256
Ref: 9574394256
Ref: library/re re finditer4394799
Ref: 169a4394799
Ref: library/re re sub4395236
Ref: 4704395236
Ref: library/re re subn4398417
Ref: 7284398417
Ref: library/re re escape4398753
Ref: 48b4398753
Ref: library/re re purge4400239
Ref: 169b4400239
Ref: library/re re error4400308
Ref: 7294400308
Ref: library/re re error msg4400741
Ref: 72a4400741
Ref: library/re re error pattern4400808
Ref: 72b4400808
Ref: library/re re error pos4400880
Ref: 72c4400880
Ref: library/re re error lineno4400995
Ref: 72d4400995
Ref: library/re re error colno4401087
Ref: 72e4401087
Node: Regular Expression Objects4401239
Ref: library/re re-objects4401384
Ref: 8904401384
Ref: library/re regular-expression-objects4401384
Ref: 169c4401384
Ref: library/re re Pattern search4401538
Ref: 16954401538
Ref: library/re re Pattern match4403002
Ref: 16944403002
Ref: library/re re Pattern fullmatch4403861
Ref: 169d4403861
Ref: library/re re Pattern split4404658
Ref: 169e4404658
Ref: library/re re Pattern findall4404792
Ref: 169f4404792
Ref: library/re re Pattern finditer4405053
Ref: 16a04405053
Ref: library/re re Pattern sub4405317
Ref: 16a14405317
Ref: library/re re Pattern subn4405450
Ref: 16a24405450
Ref: library/re re Pattern flags4405585
Ref: 16a34405585
Ref: library/re re Pattern groups4405852
Ref: 16a44405852
Ref: library/re re Pattern groupindex4405936
Ref: 16a54405936
Ref: library/re re Pattern pattern4406150
Ref: 16a64406150
Node: Match Objects4406409
Ref: library/re id24406566
Ref: 16a74406566
Ref: library/re match-objects4406566
Ref: 8914406566
Ref: library/re re Match expand4406979
Ref: 16a84406979
Ref: library/re re Match group4407501
Ref: 16a94407501
Ref: library/re re Match __getitem__4409769
Ref: 16aa4409769
Ref: library/re re Match groups4410244
Ref: 16ab4410244
Ref: library/re re Match groupdict4411090
Ref: 16ac4411090
Ref: library/re re Match start4411557
Ref: 16ad4411557
Ref: library/re re Match end4411591
Ref: 16ae4411591
Ref: library/re re Match span4412638
Ref: 16af4412638
Ref: library/re re Match pos4412891
Ref: 16b04412891
Ref: library/re re Match endpos4413151
Ref: 16b14413151
Ref: library/re re Match lastindex4413405
Ref: 16b24413405
Ref: library/re re Match lastgroup4413804
Ref: 16b34413804
Ref: library/re re Match re4413977
Ref: 16b44413977
Ref: library/re re Match string4414144
Ref: 16b54414144
Node: Regular Expression Examples4414382
Ref: library/re re-examples4414504
Ref: be74414504
Ref: library/re regular-expression-examples4414504
Ref: 16b64414504
Node: Checking for a Pair4414848
Ref: library/re checking-for-a-pair4414956
Ref: 16b74414956
Node: Simulating scanf4417053
Ref: library/re simulating-scanf4417185
Ref: 16b84417185
Node: search vs match4419253
Ref: library/re id34419384
Ref: 16b94419384
Ref: library/re search-vs-match4419384
Ref: 16994419384
Node: Making a Phonebook4420598
Ref: library/re making-a-phonebook4420725
Ref: 16ba4420725
Node: Text Munging4422904
Ref: library/re text-munging4423035
Ref: 16bb4423035
Node: Finding all Adverbs4423859
Ref: library/re finding-all-adverbs4424011
Ref: 16bc4424011
Node: Finding all Adverbs and their Positions4424466
Ref: library/re finding-all-adverbs-and-their-positions4424625
Ref: 16bd4424625
Node: Raw String Notation4425327
Ref: library/re raw-string-notation4425486
Ref: 16be4425486
Node: Writing a Tokenizer4426413
Ref: library/re writing-a-tokenizer4426524
Ref: 16bf4426524
Ref: library/re frie094429857
Ref: 16874429857
Ref: Writing a Tokenizer-Footnote-14430137
Node: difflib — Helpers for computing deltas4430192
Ref: library/difflib doc4430385
Ref: 16c04430385
Ref: library/difflib difflib-helpers-for-computing-deltas4430385
Ref: 16c14430385
Ref: library/difflib module-difflib4430385
Ref: 374430385
Ref: library/difflib difflib SequenceMatcher4430891
Ref: 9434430891
Ref: library/difflib difflib Differ4432870
Ref: 16c24432870
Ref: library/difflib difflib HtmlDiff4433997
Ref: 16c34433997
Ref: library/difflib difflib HtmlDiff __init__4434367
Ref: 16c44434367
Ref: library/difflib difflib HtmlDiff make_file4435180
Ref: 6bd4435180
Ref: library/difflib difflib HtmlDiff make_table4436863
Ref: 16c64436863
Ref: library/difflib difflib context_diff4437445
Ref: 16c74437445
Ref: library/difflib difflib get_close_matches4439387
Ref: 16cb4439387
Ref: library/difflib difflib ndiff4440551
Ref: 16c54440551
Ref: library/difflib difflib restore4442201
Ref: 16ce4442201
Ref: library/difflib difflib unified_diff4442944
Ref: 16d04442944
Ref: library/difflib difflib diff_bytes4444863
Ref: 6be4444863
Ref: library/difflib difflib IS_LINE_JUNK4445755
Ref: 16cc4445755
Ref: library/difflib difflib IS_CHARACTER_JUNK4446057
Ref: 16cd4446057
Ref: difflib — Helpers for computing deltas-Footnote-14446717
Ref: difflib — Helpers for computing deltas-Footnote-24446783
Ref: difflib — Helpers for computing deltas-Footnote-34446872
Node: SequenceMatcher Objects4446904
Ref: library/difflib sequence-matcher4447037
Ref: 16d14447037
Ref: library/difflib sequencematcher-objects4447037
Ref: 16d24447037
Ref: library/difflib difflib SequenceMatcher set_seqs4448687
Ref: 16d34448687
Ref: library/difflib difflib SequenceMatcher set_seq14449105
Ref: 16d54449105
Ref: library/difflib difflib SequenceMatcher set_seq24449248
Ref: 16d44449248
Ref: library/difflib difflib SequenceMatcher find_longest_match4449391
Ref: 16d64449391
Ref: library/difflib difflib SequenceMatcher get_matching_blocks4451474
Ref: 16d74451474
Ref: library/difflib difflib SequenceMatcher get_opcodes4452391
Ref: 16d84452391
Ref: library/difflib difflib SequenceMatcher get_grouped_opcodes4454378
Ref: 16d94454378
Ref: library/difflib difflib SequenceMatcher ratio4454810
Ref: 16da4454810
Ref: library/difflib difflib SequenceMatcher quick_ratio4455833
Ref: 16db4455833
Ref: library/difflib difflib SequenceMatcher real_quick_ratio4455953
Ref: 16dc4455953
Node: SequenceMatcher Examples4456464
Ref: library/difflib id14456620
Ref: 16dd4456620
Ref: library/difflib sequencematcher-examples4456620
Ref: 16de4456620
Ref: SequenceMatcher Examples-Footnote-14458325
Node: Differ Objects4458378
Ref: library/difflib differ-objects4458525
Ref: 16df4458525
Ref: library/difflib id24458525
Ref: 16e04458525
Ref: library/difflib difflib Differ compare4459931
Ref: 16cf4459931
Node: Differ Example4460455
Ref: library/difflib differ-example4460613
Ref: 16e14460613
Ref: library/difflib differ-examples4460613
Ref: 16e24460613
Node: A command-line interface to difflib4462871
Ref: library/difflib a-command-line-interface-to-difflib4463006
Ref: 16e34463006
Ref: library/difflib difflib-interface4463006
Ref: 16ca4463006
Node: textwrap — Text wrapping and filling4465761
Ref: library/textwrap doc4465950
Ref: 16e44465950
Ref: library/textwrap module-textwrap4465950
Ref: 1084465950
Ref: library/textwrap textwrap-text-wrapping-and-filling4465950
Ref: 16e54465950
Ref: library/textwrap textwrap wrap4466482
Ref: 16e64466482
Ref: library/textwrap textwrap fill4466983
Ref: 16e84466983
Ref: library/textwrap textwrap shorten4467343
Ref: 8e14467343
Ref: library/textwrap textwrap dedent4468478
Ref: 16ed4468478
Ref: library/textwrap textwrap indent4469414
Ref: a9d4469414
Ref: library/textwrap textwrap TextWrapper4470750
Ref: 8de4470750
Ref: library/textwrap textwrap TextWrapper width4471426
Ref: 16ef4471426
Ref: library/textwrap textwrap TextWrapper expand_tabs4471748
Ref: 16ea4471748
Ref: library/textwrap textwrap TextWrapper tabsize4471951
Ref: 16e94471951
Ref: library/textwrap textwrap TextWrapper replace_whitespace4472239
Ref: 16ec4472239
Ref: library/textwrap textwrap TextWrapper drop_whitespace4473202
Ref: 16eb4473202
Ref: library/textwrap textwrap TextWrapper initial_indent4473616
Ref: 16f04473616
Ref: library/textwrap textwrap TextWrapper subsequent_indent4473851
Ref: 16f14473851
Ref: library/textwrap textwrap TextWrapper fix_sentence_endings4474078
Ref: 16f24474078
Ref: library/textwrap textwrap TextWrapper break_long_words4475299
Ref: 16ee4475299
Ref: library/textwrap textwrap TextWrapper break_on_hyphens4475789
Ref: 16f34475789
Ref: library/textwrap textwrap TextWrapper max_lines4476321
Ref: 8df4476321
Ref: library/textwrap textwrap TextWrapper placeholder4476566
Ref: 8e04476566
Ref: library/textwrap textwrap TextWrapper wrap4476880
Ref: 16e74476880
Ref: library/textwrap textwrap TextWrapper fill4477302
Ref: 16f44477302
Ref: textwrap — Text wrapping and filling-Footnote-14477489
Node: unicodedata — Unicode Database4477556
Ref: library/unicodedata doc4477747
Ref: 16f54477747
Ref: library/unicodedata module-unicodedata4477747
Ref: 11a4477747
Ref: library/unicodedata unicodedata-unicode-database4477747
Ref: 16f64477747
Ref: library/unicodedata unicodedata lookup4478269
Ref: 9b14478269
Ref: library/unicodedata unicodedata name4478586
Ref: 16f74478586
Ref: library/unicodedata unicodedata decimal4478812
Ref: 16f84478812
Ref: library/unicodedata unicodedata digit4479055
Ref: 16f94479055
Ref: library/unicodedata unicodedata numeric4479293
Ref: bec4479293
Ref: library/unicodedata unicodedata category4479533
Ref: 16fa4479533
Ref: library/unicodedata unicodedata bidirectional4479658
Ref: 16fb4479658
Ref: library/unicodedata unicodedata combining4479850
Ref: 16fc4479850
Ref: library/unicodedata unicodedata east_asian_width4480037
Ref: 16fd4480037
Ref: library/unicodedata unicodedata mirrored4480170
Ref: 16fe4480170
Ref: library/unicodedata unicodedata decomposition4480428
Ref: 16ff4480428
Ref: library/unicodedata unicodedata normalize4480643
Ref: fe84480643
Ref: library/unicodedata unicodedata is_normalized4482505
Ref: 2444482505
Ref: library/unicodedata unicodedata unidata_version4482812
Ref: 17004482812
Ref: library/unicodedata unicodedata ucd_3_2_04482914
Ref: d8f4482914
Ref: unicodedata — Unicode Database-Footnote-14483693
Ref: unicodedata — Unicode Database-Footnote-24483742
Ref: unicodedata — Unicode Database-Footnote-34483788
Ref: unicodedata — Unicode Database-Footnote-44483863
Node: stringprep — Internet String Preparation4483941
Ref: library/stringprep doc4484129
Ref: 17014484129
Ref: library/stringprep module-stringprep4484129
Ref: f74484129
Ref: library/stringprep stringprep-internet-string-preparation4484129
Ref: 17024484129
Ref: library/stringprep stringprep in_table_a14486051
Ref: 17034486051
Ref: library/stringprep stringprep in_table_b14486188
Ref: 17044486188
Ref: library/stringprep stringprep map_table_b24486314
Ref: 17054486314
Ref: library/stringprep stringprep map_table_b34486471
Ref: 17064486471
Ref: library/stringprep stringprep in_table_c114486640
Ref: 17074486640
Ref: library/stringprep stringprep in_table_c124486760
Ref: 17084486760
Ref: library/stringprep stringprep in_table_c11_c124486889
Ref: 17094486889
Ref: library/stringprep stringprep in_table_c214487036
Ref: 170a4487036
Ref: library/stringprep stringprep in_table_c224487163
Ref: 170b4487163
Ref: library/stringprep stringprep in_table_c21_c224487294
Ref: 170c4487294
Ref: library/stringprep stringprep in_table_c34487443
Ref: 170d4487443
Ref: library/stringprep stringprep in_table_c44487549
Ref: 170e4487549
Ref: library/stringprep stringprep in_table_c54487674
Ref: 170f4487674
Ref: library/stringprep stringprep in_table_c64487784
Ref: 17104487784
Ref: library/stringprep stringprep in_table_c74487912
Ref: 17114487912
Ref: library/stringprep stringprep in_table_c84488054
Ref: 17124488054
Ref: library/stringprep stringprep in_table_c94488197
Ref: 17134488197
Ref: library/stringprep stringprep in_table_d14488310
Ref: 17144488310
Ref: library/stringprep stringprep in_table_d24488468
Ref: 17154488468
Ref: stringprep — Internet String Preparation-Footnote-14488650
Ref: stringprep — Internet String Preparation-Footnote-24488719
Ref: stringprep — Internet String Preparation-Footnote-34488768
Node: readline — GNU readline interface4488817
Ref: library/readline doc4489025
Ref: 17164489025
Ref: library/readline module-readline4489025
Ref: de4489025
Ref: library/readline readline-gnu-readline-interface4489025
Ref: 17174489025
Ref: readline — GNU readline interface-Footnote-14490946
Node: Init file4491016
Ref: library/readline init-file4491117
Ref: 17184491117
Ref: library/readline readline parse_and_bind4491227
Ref: 17194491227
Ref: library/readline readline read_init_file4491408
Ref: 171a4491408
Node: Line buffer4491630
Ref: library/readline line-buffer4491752
Ref: 171b4491752
Ref: library/readline readline get_line_buffer4491846
Ref: 171c4491846
Ref: library/readline readline insert_text4491997
Ref: 171d4491997
Ref: library/readline readline redisplay4492207
Ref: 171e4492207
Node: History file4492412
Ref: library/readline history-file4492537
Ref: 171f4492537
Ref: library/readline readline read_history_file4492632
Ref: 17204492632
Ref: library/readline readline write_history_file4492870
Ref: 17214492870
Ref: library/readline readline append_history_file4493127
Ref: 7304493127
Ref: library/readline readline get_history_length4493534
Ref: 17224493534
Ref: library/readline readline set_history_length4493579
Ref: 17234493579
Node: History list4493942
Ref: library/readline history-list4494069
Ref: 17244494069
Ref: library/readline readline clear_history4494171
Ref: 17254494171
Ref: library/readline readline get_current_history_length4494419
Ref: 17264494419
Ref: library/readline readline get_history_item4494684
Ref: 17274494684
Ref: library/readline readline remove_history_item4494894
Ref: 17284494894
Ref: library/readline readline replace_history_item4495114
Ref: 17294495114
Ref: library/readline readline add_history4495345
Ref: 172a4495345
Ref: library/readline readline set_auto_history4495529
Ref: 56c4495529
Node: Startup hooks4495995
Ref: library/readline startup-hooks4496120
Ref: 172b4496120
Ref: library/readline readline set_startup_hook4496165
Ref: 172c4496165
Ref: library/readline readline set_pre_input_hook4496569
Ref: 172d4496569
Node: Completion4497141
Ref: library/readline completion4497261
Ref: 172e4497261
Ref: library/readline readline set_completer4497747
Ref: 172f4497747
Ref: library/readline readline get_completer4498538
Ref: 17304498538
Ref: library/readline readline get_completion_type4498671
Ref: 17314498671
Ref: library/readline readline get_begidx4498871
Ref: 17324498871
Ref: library/readline readline get_endidx4498908
Ref: 17334498908
Ref: library/readline readline set_completer_delims4499166
Ref: 17344499166
Ref: library/readline readline get_completer_delims4499219
Ref: 17354499219
Ref: library/readline readline set_completion_display_matches_hook4499540
Ref: 17364499540
Node: Example4500129
Ref: library/readline example4500227
Ref: 17374500227
Ref: library/readline readline-example4500227
Ref: 17384500227
Node: rlcompleter — Completion function for GNU readline4502867
Ref: library/rlcompleter doc4503024
Ref: 173a4503024
Ref: library/rlcompleter module-rlcompleter4503024
Ref: e14503024
Ref: library/rlcompleter rlcompleter-completion-function-for-gnu-readline4503024
Ref: 173b4503024
Ref: rlcompleter — Completion function for GNU readline-Footnote-14504489
Node: Completer Objects4504559
Ref: library/rlcompleter completer-objects4504665
Ref: 173c4504665
Ref: library/rlcompleter id14504665
Ref: 173d4504665
Ref: library/rlcompleter rlcompleter Completer complete4504764
Ref: 173e4504764
Node: Binary Data Services4505520
Ref: library/binary doc4505656
Ref: 173f4505656
Ref: library/binary binary-data-services4505656
Ref: 17404505656
Ref: library/binary binaryservices4505656
Ref: 16574505656
Node: struct — Interpret bytes as packed binary data4506422
Ref: library/struct doc4506578
Ref: 17414506578
Ref: library/struct module-struct4506578
Ref: f84506578
Ref: library/struct struct-interpret-bytes-as-packed-binary-data4506578
Ref: 17424506578
Ref: struct — Interpret bytes as packed binary data-Footnote-14508385
Node: Functions and Exceptions4508450
Ref: library/struct functions-and-exceptions4508582
Ref: 17464508582
Ref: library/struct struct error4508708
Ref: ca74508708
Ref: library/struct struct pack4508834
Ref: bfe4508834
Ref: library/struct struct pack_into4509076
Ref: 17474509076
Ref: library/struct struct unpack4509375
Ref: 123c4509375
Ref: library/struct struct unpack_from4509742
Ref: 17494509742
Ref: library/struct struct iter_unpack4510135
Ref: 8cc4510135
Ref: library/struct struct calcsize4510655
Ref: 17484510655
Node: Format Strings4510854
Ref: library/struct format-strings4511005
Ref: 174a4511005
Ref: library/struct struct-format-strings4511005
Ref: 17434511005
Node: Byte Order Size and Alignment4511494
Ref: library/struct byte-order-size-and-alignment4511600
Ref: 174c4511600
Ref: library/struct struct-alignment4511600
Ref: 17444511600
Node: Format Characters4514753
Ref: library/struct format-characters4514879
Ref: 174b4514879
Ref: library/struct id14514879
Ref: 174e4514879
Ref: Format Characters-Footnote-14525866
Ref: Format Characters-Footnote-24525938
Node: Examples<2>4526014
Ref: library/struct examples4526102
Ref: 174f4526102
Ref: library/struct struct-examples4526102
Ref: 174d4526102
Node: Classes<2>4527815
Ref: library/struct classes4527933
Ref: 17504527933
Ref: library/struct struct-objects4527933
Ref: 17514527933
Ref: library/struct struct Struct4528029
Ref: 17454528029
Ref: library/struct struct Struct pack4528771
Ref: 17524528771
Ref: library/struct struct Struct pack_into4528952
Ref: 17544528952
Ref: library/struct struct Struct unpack4529110
Ref: 17554529110
Ref: library/struct struct Struct unpack_from4529310
Ref: 17564529310
Ref: library/struct struct Struct iter_unpack4529568
Ref: 8cd4529568
Ref: library/struct struct Struct format4529819
Ref: 4874529819
Ref: library/struct struct Struct size4530034
Ref: 17534530034
Node: codecs — Codec registry and base classes4530235
Ref: library/codecs doc4530391
Ref: 17574530391
Ref: library/codecs codecs-codec-registry-and-base-classes4530391
Ref: 17584530391
Ref: library/codecs ieee-754-standard4530391
Ref: 17594530391
Ref: library/codecs module-codecs4530391
Ref: 1c4530391
Ref: library/codecs codecs encode4531252
Ref: 7f64531252
Ref: library/codecs codecs decode4531747
Ref: 7f74531747
Ref: library/codecs codecs lookup4532307
Ref: 163d4532307
Ref: library/codecs codecs CodecInfo4532805
Ref: 175b4532805
Ref: library/codecs codecs CodecInfo name4533101
Ref: 175c4533101
Ref: library/codecs codecs CodecInfo encode4533164
Ref: 175d4533164
Ref: library/codecs codecs CodecInfo decode4533191
Ref: 175e4533191
Ref: library/codecs codecs CodecInfo incrementalencoder4533569
Ref: 17624533569
Ref: library/codecs codecs CodecInfo incrementaldecoder4533608
Ref: 17634533608
Ref: library/codecs codecs CodecInfo streamwriter4533947
Ref: 17664533947
Ref: library/codecs codecs CodecInfo streamreader4533980
Ref: 17674533980
Ref: library/codecs codecs getencoder4534434
Ref: 176a4534434
Ref: library/codecs codecs getdecoder4534646
Ref: 176b4534646
Ref: library/codecs codecs getincrementalencoder4534858
Ref: 176c4534858
Ref: library/codecs codecs getincrementaldecoder4535164
Ref: 176d4535164
Ref: library/codecs codecs getreader4535470
Ref: 176e4535470
Ref: library/codecs codecs getwriter4535716
Ref: 176f4535716
Ref: library/codecs codecs register4536045
Ref: 17704536045
Ref: library/codecs codecs open4536849
Ref: 129d4536849
Ref: library/codecs codecs EncodedFile4538102
Ref: 17724538102
Ref: library/codecs codecs iterencode4538958
Ref: 17734538958
Ref: library/codecs codecs iterdecode4539488
Ref: 17744539488
Ref: library/codecs codecs BOM4540210
Ref: 17754540210
Ref: library/codecs codecs BOM_BE4540231
Ref: 17764540231
Ref: library/codecs codecs BOM_LE4540255
Ref: 17774540255
Ref: library/codecs codecs BOM_UTF84540279
Ref: 17784540279
Ref: library/codecs codecs BOM_UTF164540305
Ref: 17794540305
Ref: library/codecs codecs BOM_UTF16_BE4540332
Ref: 177a4540332
Ref: library/codecs codecs BOM_UTF16_LE4540362
Ref: 177b4540362
Ref: library/codecs codecs BOM_UTF324540392
Ref: 177c4540392
Ref: library/codecs codecs BOM_UTF32_BE4540419
Ref: 177d4540419
Ref: library/codecs codecs BOM_UTF32_LE4540449
Ref: 177e4540449
Ref: codecs — Codec registry and base classes-Footnote-14541596
Node: Codec Base Classes4541661
Ref: library/codecs codec-base-classes4541788
Ref: 175a4541788
Ref: library/codecs id14541788
Ref: 177f4541788
Ref: library/codecs surrogateescape4542381
Ref: 17804542381
Node: Error Handlers4542518
Ref: library/codecs error-handlers4542627
Ref: 129c4542627
Ref: library/codecs id24542627
Ref: 17814542627
Ref: library/codecs codecs register_error4546711
Ref: de84546711
Ref: library/codecs codecs lookup_error4548252
Ref: de94548252
Ref: library/codecs codecs strict_errors4548547
Ref: 17824548547
Ref: library/codecs codecs replace_errors4548718
Ref: 17844548718
Ref: library/codecs codecs ignore_errors4549022
Ref: 17834549022
Ref: library/codecs codecs xmlcharrefreplace_errors4549215
Ref: 17854549215
Ref: library/codecs codecs backslashreplace_errors4549481
Ref: 17864549481
Ref: library/codecs codecs namereplace_errors4549711
Ref: 17874549711
Ref: Error Handlers-Footnote-14550020
Node: Stateless Encoding and Decoding4550069
Ref: library/codecs codec-objects4550220
Ref: 17614550220
Ref: library/codecs stateless-encoding-and-decoding4550220
Ref: 17884550220
Ref: library/codecs codecs Codec encode4550431
Ref: 175f4550431
Ref: library/codecs codecs Codec decode4551173
Ref: 17604551173
Node: Incremental Encoding and Decoding4552100
Ref: library/codecs incremental-encoding-and-decoding4552265
Ref: 17894552265
Node: IncrementalEncoder Objects4553105
Ref: library/codecs incremental-encoder-objects4553236
Ref: 178c4553236
Ref: library/codecs incrementalencoder-objects4553236
Ref: 178d4553236
Ref: library/codecs codecs IncrementalEncoder4553535
Ref: 17644553535
Ref: library/codecs codecs IncrementalEncoder encode4554320
Ref: 178a4554320
Ref: library/codecs codecs IncrementalEncoder reset4554613
Ref: 178e4554613
Ref: library/codecs codecs IncrementalEncoder getstate4554882
Ref: 178f4554882
Ref: library/codecs codecs IncrementalEncoder setstate4555295
Ref: 17904555295
Node: IncrementalDecoder Objects4555462
Ref: library/codecs incremental-decoder-objects4555593
Ref: 17914555593
Ref: library/codecs incrementaldecoder-objects4555593
Ref: 17924555593
Ref: library/codecs codecs IncrementalDecoder4555892
Ref: 17654555892
Ref: library/codecs codecs IncrementalDecoder decode4556677
Ref: 178b4556677
Ref: library/codecs codecs IncrementalDecoder reset4557306
Ref: 17934557306
Ref: library/codecs codecs IncrementalDecoder getstate4557384
Ref: 17944557384
Ref: library/codecs codecs IncrementalDecoder setstate4558331
Ref: 17954558331
Node: Stream Encoding and Decoding4558497
Ref: library/codecs stream-encoding-and-decoding4558622
Ref: 17964558622
Node: StreamWriter Objects4559049
Ref: library/codecs stream-writer-objects4559163
Ref: 17974559163
Ref: library/codecs streamwriter-objects4559163
Ref: 17984559163
Ref: library/codecs codecs StreamWriter4559418
Ref: 17684559418
Ref: library/codecs codecs StreamWriter write4560375
Ref: 17994560375
Ref: library/codecs codecs StreamWriter writelines4560473
Ref: 179a4560473
Ref: library/codecs codecs StreamWriter reset4560713
Ref: 179b4560713
Node: StreamReader Objects4561185
Ref: library/codecs stream-reader-objects4561334
Ref: 179c4561334
Ref: library/codecs streamreader-objects4561334
Ref: 179d4561334
Ref: library/codecs codecs StreamReader4561589
Ref: 17694561589
Ref: library/codecs codecs StreamReader read4562659
Ref: 179e4562659
Ref: library/codecs codecs StreamReader readline4563911
Ref: 179f4563911
Ref: library/codecs codecs StreamReader readlines4564256
Ref: 17a04564256
Ref: library/codecs codecs StreamReader reset4564701
Ref: 17a14564701
Node: StreamReaderWriter Objects4565095
Ref: library/codecs stream-reader-writer4565245
Ref: 17a24565245
Ref: library/codecs streamreaderwriter-objects4565245
Ref: 17a34565245
Ref: library/codecs codecs StreamReaderWriter4565581
Ref: 17714565581
Node: StreamRecoder Objects4566236
Ref: library/codecs stream-recoder-objects4566357
Ref: 17a44566357
Ref: library/codecs streamrecoder-objects4566357
Ref: 17a54566357
Ref: library/codecs codecs StreamRecoder4566707
Ref: eff4566707
Node: Encodings and Unicode4567836
Ref: library/codecs encodings-and-unicode4567990
Ref: 17a64567990
Ref: library/codecs encodings-overview4567990
Ref: 17a74567990
Ref: Encodings and Unicode-Footnote-14574689
Node: Standard Encodings4574738
Ref: library/codecs id34574899
Ref: 17a84574899
Ref: library/codecs standard-encodings4574899
Ref: 6834574899
Node: Python Specific Encodings4596923
Ref: library/codecs python-specific-encodings4597128
Ref: 17a94597128
Node: Text Encodings4597716
Ref: library/codecs text-encodings4597818
Ref: 17aa4597818
Ref: Text Encodings-Footnote-14601190
Ref: Text Encodings-Footnote-24601239
Node: Binary Transforms4601288
Ref: library/codecs binary-transforms4601414
Ref: 7f84601414
Ref: library/codecs id44601414
Ref: 17ab4601414
Ref: Binary Transforms-Footnote-14605219
Node: Text Transforms4605364
Ref: library/codecs id64605467
Ref: 17b44605467
Ref: library/codecs text-transforms4605467
Ref: 7f94605467
Node: encodings idna — Internationalized Domain Names in Applications4606211
Ref: library/codecs encodings-idna-internationalized-domain-names-in-applications4606438
Ref: 17b54606438
Ref: library/codecs module-encodings idna4606438
Ref: 774606438
Ref: library/codecs encodings idna nameprep4608947
Ref: 17b64608947
Ref: library/codecs encodings idna ToASCII4609135
Ref: 17b74609135
Ref: library/codecs encodings idna ToUnicode4609295
Ref: 17b84609295
Ref: encodings idna — Internationalized Domain Names in Applications-Footnote-14609442
Ref: encodings idna — Internationalized Domain Names in Applications-Footnote-24609491
Ref: encodings idna — Internationalized Domain Names in Applications-Footnote-34609540
Ref: encodings idna — Internationalized Domain Names in Applications-Footnote-44609601
Ref: encodings idna — Internationalized Domain Names in Applications-Footnote-54609650
Node: encodings mbcs — Windows ANSI codepage4609699
Ref: library/codecs encodings-mbcs-windows-ansi-codepage4609955
Ref: 17b94609955
Ref: library/codecs module-encodings mbcs4609955
Ref: 784609955
Node: encodings utf_8_sig — UTF-8 codec with BOM signature4610353
Ref: library/codecs encodings-utf-8-sig-utf-8-codec-with-bom-signature4610535
Ref: 17ba4610535
Ref: library/codecs module-encodings utf_8_sig4610535
Ref: 794610535
Node: Data Types4610980
Ref: library/datatypes doc4611124
Ref: 17bb4611124
Ref: library/datatypes data-types4611124
Ref: 17bc4611124
Ref: library/datatypes datatypes4611124
Ref: 17bd4611124
Node: datetime — Basic date and time types4612394
Ref: library/datetime doc4612535
Ref: 17be4612535
Ref: library/datetime datetime-basic-date-and-time-types4612535
Ref: 17bf4612535
Ref: library/datetime module-datetime4612535
Ref: 314612535
Ref: datetime — Basic date and time types-Footnote-14613509
Ref: datetime — Basic date and time types-Footnote-24613576
Node: Aware and Naive Objects4613627
Ref: library/datetime aware-and-naive-objects4613743
Ref: 17c04613743
Ref: library/datetime datetime-naive-aware4613743
Ref: 17c14613743
Ref: Aware and Naive Objects-Footnote-14615607
Node: Constants4615668
Ref: library/datetime constants4615808
Ref: 17c24615808
Ref: library/datetime datetime MINYEAR4615910
Ref: 17c34615910
Ref: library/datetime datetime MAXYEAR4616070
Ref: 17c44616070
Node: Available Types4616232
Ref: library/datetime available-types4616366
Ref: 17c54616366
Node: Common Properties4618148
Ref: library/datetime common-properties4618268
Ref: 17d64618268
Node: Determining if an Object is Aware or Naive4618678
Ref: library/datetime determining-if-an-object-is-aware-or-naive4618798
Ref: 17d74618798
Node: timedelta Objects4619533
Ref: library/datetime datetime-timedelta4619670
Ref: 17d84619670
Ref: library/datetime timedelta-objects4619670
Ref: 17d94619670
Ref: library/datetime datetime timedelta4619829
Ref: 1954619829
Ref: library/datetime datetime timedelta min4622081
Ref: 17da4622081
Ref: library/datetime datetime timedelta max4622199
Ref: 17db4622199
Ref: library/datetime datetime timedelta resolution4622381
Ref: 17dc4622381
Ref: library/datetime datetime timedelta total_seconds4629785
Ref: c8f4629785
Node: Examples of usage timedelta4630307
Ref: library/datetime examples-of-usage-timedelta4630388
Ref: 17dd4630388
Node: date Objects4631329
Ref: library/datetime date-objects4631467
Ref: 17de4631467
Ref: library/datetime datetime-date4631467
Ref: 17df4631467
Ref: library/datetime datetime date4631789
Ref: 1934631789
Ref: library/datetime datetime date today4632208
Ref: 17e04632208
Ref: library/datetime datetime date fromtimestamp4632345
Ref: 17e14632345
Ref: library/datetime datetime date fromordinal4633277
Ref: 17e24633277
Ref: library/datetime datetime date fromisoformat4633604
Ref: fcf4633604
Ref: library/datetime datetime date fromisocalendar4634026
Ref: 1c24634026
Ref: library/datetime datetime date min4634312
Ref: 17e54634312
Ref: library/datetime datetime date max4634403
Ref: 17e64634403
Ref: library/datetime datetime date resolution4634494
Ref: 17e74634494
Ref: library/datetime datetime date year4634661
Ref: 17c64634661
Ref: library/datetime datetime date month4634758
Ref: 17c74634758
Ref: library/datetime datetime date day4634819
Ref: 17c84634819
Ref: library/datetime datetime date replace4637309
Ref: 17e84637309
Ref: library/datetime datetime date timetuple4637694
Ref: 17e94637694
Ref: library/datetime datetime date toordinal4638189
Ref: 17eb4638189
Ref: library/datetime datetime date weekday4638411
Ref: 17ec4638411
Ref: library/datetime datetime date isoweekday4638636
Ref: 17ed4638636
Ref: library/datetime datetime date isocalendar4638896
Ref: 17e44638896
Ref: library/datetime datetime date isoformat4639745
Ref: 17e34639745
Ref: library/datetime datetime date __str__4640033
Ref: 17ee4640033
Ref: library/datetime datetime date ctime4640135
Ref: 17ef4640135
Ref: library/datetime datetime date strftime4640609
Ref: 52d4640609
Ref: library/datetime datetime date __format__4640917
Ref: 17f24640917
Ref: date Objects-Footnote-14641375
Ref: date Objects-Footnote-24641688
Node: Examples of Usage date4641866
Ref: library/datetime examples-of-usage-date4641937
Ref: 17f34641937
Node: datetime Objects4643829
Ref: library/datetime datetime-datetime4643962
Ref: 17f44643962
Ref: library/datetime datetime-objects4643962
Ref: 17f54643962
Ref: library/datetime datetime datetime4644411
Ref: 1944644411
Ref: library/datetime datetime datetime today4645274
Ref: 17f64645274
Ref: library/datetime datetime datetime now4645623
Ref: f344645623
Ref: library/datetime datetime datetime utcnow4646298
Ref: 17f74646298
Ref: library/datetime datetime datetime fromtimestamp4647032
Ref: fc34647032
Ref: library/datetime datetime datetime utcfromtimestamp4648742
Ref: 17f84648742
Ref: library/datetime datetime datetime fromordinal4650407
Ref: 17f94650407
Ref: library/datetime datetime datetime combine4650806
Ref: 52e4650806
Ref: library/datetime datetime datetime fromisoformat4651579
Ref: 3734651579
Ref: library/datetime datetime datetime fromisocalendar4653258
Ref: 1c34653258
Ref: library/datetime datetime datetime strptime4653631
Ref: ee14653631
Ref: library/datetime datetime datetime min4654190
Ref: 17fb4654190
Ref: library/datetime datetime datetime max4654322
Ref: 17fc4654322
Ref: library/datetime datetime datetime resolution4654474
Ref: 17fd4654474
Ref: library/datetime datetime datetime year4654669
Ref: 17ce4654669
Ref: library/datetime datetime datetime month4654770
Ref: 17cf4654770
Ref: library/datetime datetime datetime day4654835
Ref: 17d04654835
Ref: library/datetime datetime datetime hour4654946
Ref: 17d14654946
Ref: library/datetime datetime datetime minute4655002
Ref: 17d24655002
Ref: library/datetime datetime datetime second4655060
Ref: 17d34655060
Ref: library/datetime datetime datetime microsecond4655118
Ref: 17d44655118
Ref: library/datetime datetime datetime tzinfo4655186
Ref: 17d54655186
Ref: library/datetime datetime datetime fold4655347
Ref: 4e94655347
Ref: library/datetime datetime datetime date4659978
Ref: 17fe4659978
Ref: library/datetime datetime datetime time4660076
Ref: 17ff4660076
Ref: library/datetime datetime datetime timetz4660383
Ref: 18004660383
Ref: library/datetime datetime datetime replace4660673
Ref: 18014660673
Ref: library/datetime datetime datetime astimezone4661254
Ref: 1964661254
Ref: library/datetime datetime datetime utcoffset4663586
Ref: 18024663586
Ref: library/datetime datetime datetime dst4663980
Ref: 18034663980
Ref: library/datetime datetime datetime tzname4664362
Ref: 18054664362
Ref: library/datetime datetime datetime timetuple4664595
Ref: 18064664595
Ref: library/datetime datetime datetime utctimetuple4665449
Ref: 18074665449
Ref: library/datetime datetime datetime toordinal4666576
Ref: 18084666576
Ref: library/datetime datetime datetime timestamp4666718
Ref: 9d64666718
Ref: library/datetime datetime datetime weekday4668226
Ref: 18094668226
Ref: library/datetime datetime datetime isoweekday4668430
Ref: 180a4668430
Ref: library/datetime datetime datetime isocalendar4668664
Ref: 17fa4668664
Ref: library/datetime datetime datetime isoformat4668818
Ref: 3744668818
Ref: library/datetime datetime datetime __str__4671802
Ref: 180b4671802
Ref: library/datetime datetime datetime ctime4671941
Ref: 180c4671941
Ref: library/datetime datetime datetime strftime4672574
Ref: 52c4672574
Ref: library/datetime datetime datetime __format__4672818
Ref: 180d4672818
Ref: datetime Objects-Footnote-14673296
Node: Examples of Usage datetime4673384
Ref: library/datetime examples-of-usage-datetime4673463
Ref: 180e4673463
Node: time Objects4677791
Ref: library/datetime datetime-time4677926
Ref: 180f4677926
Ref: library/datetime time-objects4677926
Ref: 18104677926
Ref: library/datetime datetime time4678134
Ref: 4e84678134
Ref: library/datetime datetime time min4678799
Ref: 18114678799
Ref: library/datetime datetime time max4678898
Ref: 18124678898
Ref: library/datetime datetime time resolution4679008
Ref: 18134679008
Ref: library/datetime datetime time hour4679276
Ref: 17c94679276
Ref: library/datetime datetime time minute4679328
Ref: 17ca4679328
Ref: library/datetime datetime time second4679382
Ref: 17cb4679382
Ref: library/datetime datetime time microsecond4679436
Ref: 17cc4679436
Ref: library/datetime datetime time tzinfo4679500
Ref: 17cd4679500
Ref: library/datetime datetime time fold4679651
Ref: 18144679651
Ref: library/datetime datetime time fromisoformat4681626
Ref: fce4681626
Ref: library/datetime datetime time replace4682530
Ref: 18164682530
Ref: library/datetime datetime time isoformat4683063
Ref: 18154683063
Ref: library/datetime datetime time __str__4685074
Ref: 18184685074
Ref: library/datetime datetime time strftime4685176
Ref: 18194685176
Ref: library/datetime datetime time __format__4685407
Ref: 181a4685407
Ref: library/datetime datetime time utcoffset4685769
Ref: 18174685769
Ref: library/datetime datetime time dst4686159
Ref: 181b4686159
Ref: library/datetime datetime time tzname4686538
Ref: 181c4686538
Ref: time Objects-Footnote-14686867
Node: Examples of Usage time4686910
Ref: library/datetime examples-of-usage-time4686981
Ref: 181d4686981
Node: tzinfo Objects4687863
Ref: library/datetime datetime-tzinfo4687998
Ref: 181e4687998
Ref: library/datetime tzinfo-objects4687998
Ref: 181f4687998
Ref: library/datetime datetime tzinfo4688055
Ref: 3754688055
Ref: library/datetime datetime tzinfo utcoffset4689697
Ref: 18204689697
Ref: library/datetime datetime tzinfo dst4690927
Ref: 18214690927
Ref: library/datetime datetime tzinfo tzname4693509
Ref: 18224693509
Ref: library/datetime datetime tzinfo fromutc4695648
Ref: 18044695648
Ref: tzinfo Objects-Footnote-14708149
Ref: tzinfo Objects-Footnote-24708207
Node: timezone Objects4708247
Ref: library/datetime datetime-timezone4708400
Ref: 18244708400
Ref: library/datetime timezone-objects4708400
Ref: 18254708400
Ref: library/datetime datetime timezone4708820
Ref: 9f54708820
Ref: library/datetime datetime timezone utcoffset4709448
Ref: 18264709448
Ref: library/datetime datetime timezone tzname4709838
Ref: 18274709838
Ref: library/datetime datetime timezone dst4710520
Ref: 18284710520
Ref: library/datetime datetime timezone fromutc4710584
Ref: 18294710584
Ref: library/datetime datetime timezone utc4710779
Ref: 18234710779
Node: strftime and strptime Behavior4710862
Ref: library/datetime strftime-and-strptime-behavior4710992
Ref: 182a4710992
Ref: library/datetime strftime-strptime-behavior4710992
Ref: 17f14710992
Node: strftime and strptime Format Codes4713177
Ref: library/datetime strftime-and-strptime-format-codes4713303
Ref: 182b4713303
Node: Technical Detail4723264
Ref: library/datetime technical-detail4723390
Ref: 182c4723390
Ref: Technical Detail-Footnote-14729045
Node: calendar — General calendar-related functions4729155
Ref: library/calendar doc4729340
Ref: 182e4729340
Ref: library/calendar calendar-general-calendar-related-functions4729340
Ref: 182f4729340
Ref: library/calendar module-calendar4729340
Ref: 154729340
Ref: library/calendar calendar Calendar4730543
Ref: 18314730543
Ref: library/calendar calendar Calendar iterweekdays4731050
Ref: 18324731050
Ref: library/calendar calendar Calendar itermonthdates4731299
Ref: 49c4731299
Ref: library/calendar calendar Calendar itermonthdays4731671
Ref: 18344731671
Ref: library/calendar calendar Calendar itermonthdays24732056
Ref: 18354732056
Ref: library/calendar calendar Calendar itermonthdays34732406
Ref: 49d4732406
Ref: library/calendar calendar Calendar itermonthdays44732786
Ref: 49e4732786
Ref: library/calendar calendar Calendar monthdatescalendar4733186
Ref: 18364733186
Ref: library/calendar calendar Calendar monthdays2calendar4733406
Ref: 18374733406
Ref: library/calendar calendar Calendar monthdayscalendar4733634
Ref: 18384733634
Ref: library/calendar calendar Calendar yeardatescalendar4733821
Ref: 18394733821
Ref: library/calendar calendar Calendar yeardays2calendar4734215
Ref: 183a4734215
Ref: library/calendar calendar Calendar yeardayscalendar4734531
Ref: 183b4734531
Ref: library/calendar calendar TextCalendar4734816
Ref: 183c4734816
Ref: library/calendar calendar TextCalendar formatmonth4735000
Ref: 183d4735000
Ref: library/calendar calendar TextCalendar prmonth4735449
Ref: 183e4735449
Ref: library/calendar calendar TextCalendar formatyear4735595
Ref: 183f4735595
Ref: library/calendar calendar TextCalendar pryear4736132
Ref: 18404736132
Ref: library/calendar calendar HTMLCalendar4736287
Ref: 3644736287
Ref: library/calendar calendar HTMLCalendar formatmonth4736458
Ref: 18414736458
Ref: library/calendar calendar HTMLCalendar formatyear4736708
Ref: 18424736708
Ref: library/calendar calendar HTMLCalendar formatyearpage4736889
Ref: 18434736889
Ref: library/calendar calendar HTMLCalendar cssclasses4737529
Ref: 18444737529
Ref: library/calendar calendar HTMLCalendar cssclass_noday4737943
Ref: 18454737943
Ref: library/calendar calendar HTMLCalendar cssclasses_weekday_head4738102
Ref: 18464738102
Ref: library/calendar calendar HTMLCalendar cssclass_month_head4738315
Ref: 18474738315
Ref: library/calendar calendar HTMLCalendar cssclass_month4738509
Ref: 18484738509
Ref: library/calendar calendar HTMLCalendar cssclass_year4738716
Ref: 18494738716
Ref: library/calendar calendar HTMLCalendar cssclass_year_head4738929
Ref: 184a4738929
Ref: library/calendar calendar LocaleTextCalendar4739836
Ref: 184b4739836
Ref: library/calendar calendar LocaleHTMLCalendar4740200
Ref: 184c4740200
Ref: library/calendar calendar setfirstweekday4740888
Ref: 18304740888
Ref: library/calendar calendar firstweekday4741314
Ref: 18334741314
Ref: library/calendar calendar isleap4741424
Ref: 184d4741424
Ref: library/calendar calendar leapdays4741552
Ref: 184e4741552
Ref: library/calendar calendar weekday4741777
Ref: 184f4741777
Ref: library/calendar calendar weekheader4741976
Ref: 18504741976
Ref: library/calendar calendar monthrange4742136
Ref: 18514742136
Ref: library/calendar calendar monthcalendar4742305
Ref: 18524742305
Ref: library/calendar calendar prmonth4742584
Ref: 18534742584
Ref: library/calendar calendar month4742716
Ref: 18544742716
Ref: library/calendar calendar prcal4742909
Ref: 18554742909
Ref: library/calendar calendar calendar4743053
Ref: 18564743053
Ref: library/calendar calendar timegm4743268
Ref: 18574743268
Ref: library/calendar calendar day_name4743744
Ref: 18584743744
Ref: library/calendar calendar day_abbr4743853
Ref: 18594743853
Ref: library/calendar calendar month_name4743974
Ref: 185a4743974
Ref: library/calendar calendar month_abbr4744232
Ref: 185b4744232
Ref: calendar — General calendar-related functions-Footnote-14744765
Node: collections — Container datatypes4744832
Ref: library/collections doc4745035
Ref: 185c4745035
Ref: library/collections collections-container-datatypes4745035
Ref: 185d4745035
Ref: library/collections module-collections4745035
Ref: 1e4745035
Ref: collections — Container datatypes-Footnote-14747265
Node: ChainMap objects4747345
Ref: library/collections chainmap-objects4747457
Ref: 18614747457
Ref: library/collections collections ChainMap4747844
Ref: 49f4747844
Ref: library/collections collections ChainMap maps4748877
Ref: 18624748877
Ref: library/collections collections ChainMap new_child4749180
Ref: 81d4749180
Ref: library/collections collections ChainMap parents4749818
Ref: 18634749818
Ref: ChainMap objects-Footnote-14751671
Ref: ChainMap objects-Footnote-24751766
Ref: ChainMap objects-Footnote-34751813
Ref: ChainMap objects-Footnote-44751894
Ref: ChainMap objects-Footnote-54751947
Node: ChainMap Examples and Recipes4752000
Ref: library/collections chainmap-examples-and-recipes4752082
Ref: 18644752082
Node: Counter objects4755196
Ref: library/collections counter-objects4755330
Ref: 18654755330
Ref: library/collections collections Counter4756035
Ref: 9ce4756035
Ref: library/collections collections Counter elements4758005
Ref: c8d4758005
Ref: library/collections collections Counter most_common4758428
Ref: c8c4758428
Ref: library/collections collections Counter subtract4758888
Ref: b4d4758888
Ref: library/collections collections Counter fromkeys4759579
Ref: 18664759579
Ref: library/collections collections Counter update4759708
Ref: 18674759708
Ref: Counter objects-Footnote-14764111
Ref: Counter objects-Footnote-24764190
Ref: Counter objects-Footnote-34764237
Node: deque objects4764330
Ref: library/collections deque-objects4764467
Ref: 18684764467
Ref: library/collections collections deque4764520
Ref: 5264764520
Ref: library/collections collections deque append4765963
Ref: 18694765963
Ref: library/collections collections deque appendleft4766043
Ref: 186a4766043
Ref: library/collections collections deque clear4766126
Ref: 186b4766126
Ref: library/collections collections deque copy4766225
Ref: 69f4766225
Ref: library/collections collections deque count4766329
Ref: b4f4766329
Ref: library/collections collections deque extend4766448
Ref: 186c4766448
Ref: library/collections collections deque extendleft4766590
Ref: 186d4766590
Ref: library/collections collections deque index4766837
Ref: 69d4766837
Ref: library/collections collections deque insert4767109
Ref: 69e4767109
Ref: library/collections collections deque pop4767354
Ref: 186e4767354
Ref: library/collections collections deque popleft4767524
Ref: 186f4767524
Ref: library/collections collections deque remove4767697
Ref: 18704767697
Ref: library/collections collections deque reverse4767838
Ref: b504767838
Ref: library/collections collections deque rotate4767990
Ref: 18714767990
Ref: library/collections collections deque maxlen4768399
Ref: c8e4768399
Node: deque Recipes4771050
Ref: library/collections deque-recipes4771113
Ref: 18724771113
Ref: deque Recipes-Footnote-14773576
Node: defaultdict objects4773637
Ref: library/collections defaultdict-objects4773815
Ref: 18734773815
Ref: library/collections collections defaultdict4773880
Ref: b2d4773880
Ref: library/collections collections defaultdict __missing__4774661
Ref: 18754774661
Ref: library/collections collections defaultdict default_factory4775850
Ref: 18744775850
Node: defaultdict Examples4776121
Ref: library/collections defaultdict-examples4776197
Ref: 18764776197
Node: namedtuple Factory Function for Tuples with Named Fields4778860
Ref: library/collections namedtuple-factory-function-for-tuples-with-named-fields4779044
Ref: 18774779044
Ref: library/collections collections namedtuple4779425
Ref: 1b54779425
Ref: library/collections collections somenamedtuple _make4783334
Ref: 18784783334
Ref: library/collections collections somenamedtuple _asdict4783559
Ref: 1b44783559
Ref: library/collections collections somenamedtuple _replace4784245
Ref: 18794784245
Ref: library/collections collections somenamedtuple _fields4784645
Ref: 187a4784645
Ref: library/collections collections somenamedtuple _field_defaults4785141
Ref: 187b4785141
Node: OrderedDict objects4787909
Ref: library/collections ordereddict-objects4788090
Ref: 187c4788090
Ref: library/collections collections OrderedDict4789513
Ref: 1b74789513
Ref: library/collections collections OrderedDict popitem4789709
Ref: c774789709
Ref: library/collections collections OrderedDict move_to_end4789967
Ref: b4e4789967
Ref: OrderedDict objects-Footnote-14791511
Ref: OrderedDict objects-Footnote-24791596
Node: OrderedDict Examples and Recipes4791645
Ref: library/collections ordereddict-examples-and-recipes4791733
Ref: 187f4791733
Node: UserDict objects4793005
Ref: library/collections userdict-objects4793146
Ref: 18804793146
Ref: library/collections collections UserDict4793512
Ref: 185e4793512
Ref: library/collections collections UserDict data4794102
Ref: 18814794102
Node: UserList objects4794230
Ref: library/collections userlist-objects4794370
Ref: 18824794370
Ref: library/collections collections UserList4794885
Ref: 185f4794885
Ref: library/collections collections UserList data4795490
Ref: 18834795490
Node: UserString objects4796284
Ref: library/collections userstring-objects4796399
Ref: 18844796399
Ref: library/collections collections UserString4796761
Ref: 6a14796761
Ref: library/collections collections UserString data4797355
Ref: 18854797355
Node: collections abc — Abstract Base Classes for Containers4797655
Ref: library/collections abc doc4797841
Ref: 18864797841
Ref: library/collections abc collections-abc-abstract-base-classes-for-containers4797841
Ref: 18874797841
Ref: library/collections abc module-collections abc4797841
Ref: 1f4797841
Ref: collections abc — Abstract Base Classes for Containers-Footnote-14798453
Node: Collections Abstract Base Classes4798529
Ref: library/collections abc collections-abstract-base-classes4798655
Ref: 18604798655
Ref: library/collections abc id14798655
Ref: 18884798655
Ref: library/collections abc collections abc Container4807615
Ref: 18894807615
Ref: library/collections abc collections abc Hashable4807652
Ref: 188a4807652
Ref: library/collections abc collections abc Sized4807688
Ref: 188d4807688
Ref: library/collections abc collections abc Callable4807721
Ref: 188e4807721
Ref: library/collections abc collections abc Iterable4807929
Ref: 188b4807929
Ref: library/collections abc collections abc Collection4808409
Ref: 5224808409
Ref: library/collections abc collections abc Iterator4808522
Ref: 188c4808522
Ref: library/collections abc collections abc Reversible4808717
Ref: 5234808717
Ref: library/collections abc collections abc Generator4808875
Ref: 6a94808875
Ref: library/collections abc collections abc Sequence4809193
Ref: 156b4809193
Ref: library/collections abc collections abc MutableSequence4809229
Ref: 6a04809229
Ref: library/collections abc collections abc ByteString4809272
Ref: 188f4809272
Ref: library/collections abc collections abc Set4810008
Ref: 16164810008
Ref: library/collections abc collections abc MutableSet4810039
Ref: 18904810039
Ref: library/collections abc collections abc Mapping4810121
Ref: 187d4810121
Ref: library/collections abc collections abc MutableMapping4810156
Ref: 9e34810156
Ref: library/collections abc collections abc MappingView4810257
Ref: 18914810257
Ref: library/collections abc collections abc ItemsView4810296
Ref: 18924810296
Ref: library/collections abc collections abc KeysView4810333
Ref: 18934810333
Ref: library/collections abc collections abc ValuesView4810369
Ref: 18944810369
Ref: library/collections abc collections abc Awaitable4810475
Ref: 6aa4810475
Ref: library/collections abc collections abc Coroutine4811251
Ref: 6ab4811251
Ref: library/collections abc collections abc AsyncIterable4812145
Ref: 6ad4812145
Ref: library/collections abc collections abc AsyncIterator4812339
Ref: 6ac4812339
Ref: library/collections abc collections abc AsyncGenerator4812553
Ref: 5254812553
Ref: Collections Abstract Base Classes-Footnote-14815594
Ref: Collections Abstract Base Classes-Footnote-24815643
Ref: Collections Abstract Base Classes-Footnote-34815692
Ref: Collections Abstract Base Classes-Footnote-44815741
Ref: Collections Abstract Base Classes-Footnote-54815794
Node: heapq — Heap queue algorithm4815843
Ref: library/heapq doc4816030
Ref: 18954816030
Ref: library/heapq heapq-heap-queue-algorithm4816030
Ref: 18964816030
Ref: library/heapq module-heapq4816030
Ref: 8e4816030
Ref: library/heapq heapq heappush4817585
Ref: 18984817585
Ref: library/heapq heapq heappop4817710
Ref: 18994817710
Ref: library/heapq heapq heappushpop4817974
Ref: 189a4817974
Ref: library/heapq heapq heapify4818247
Ref: 18974818247
Ref: library/heapq heapq heapreplace4818344
Ref: 189b4818344
Ref: library/heapq heapq merge4819191
Ref: 6d34819191
Ref: library/heapq heapq nlargest4820354
Ref: 189c4820354
Ref: library/heapq heapq nsmallest4820752
Ref: 189d4820752
Ref: heapq — Heap queue algorithm-Footnote-14821621
Node: Basic Examples4821685
Ref: library/heapq basic-examples4821810
Ref: 189e4821810
Ref: Basic Examples-Footnote-14822777
Node: Priority Queue Implementation Notes4822824
Ref: library/heapq priority-queue-implementation-notes4822964
Ref: 189f4822964
Ref: Priority Queue Implementation Notes-Footnote-14825900
Node: Theory4825953
Ref: library/heapq theory4826070
Ref: 18a04826070
Ref: Theory-Footnote-14830230
Node: bisect — Array bisection algorithm4830890
Ref: library/bisect doc4831065
Ref: 18a14831065
Ref: library/bisect bisect-array-bisection-algorithm4831065
Ref: 18a24831065
Ref: library/bisect module-bisect4831065
Ref: 124831065
Ref: library/bisect bisect bisect_left4831762
Ref: 18a34831762
Ref: library/bisect bisect bisect_right4832508
Ref: 18a44832508
Ref: library/bisect bisect bisect4832566
Ref: 18a54832566
Ref: library/bisect bisect insort_left4832993
Ref: 18a64832993
Ref: library/bisect bisect insort_right4833304
Ref: 18a74833304
Ref: library/bisect bisect insort4833362
Ref: 18a84833362
Ref: bisect — Array bisection algorithm-Footnote-14833880
Ref: bisect — Array bisection algorithm-Footnote-24833945
Node: Searching Sorted Lists4834015
Ref: library/bisect searching-sorted-lists4834133
Ref: 18a94834133
Node: Other Examples4835355
Ref: library/bisect other-examples4835473
Ref: 18aa4835473
Ref: library/bisect bisect-example4835520
Ref: 18ab4835520
Node: array — Efficient arrays of numeric values4836845
Ref: library/array doc4837017
Ref: 18ac4837017
Ref: library/array array-efficient-arrays-of-numeric-values4837017
Ref: 18ad4837017
Ref: library/array module-array4837017
Ref: 74837017
Ref: library/array array array4841561
Ref: 4464841561
Ref: library/array array typecodes4842282
Ref: 18b24842282
Ref: library/array array array typecode4842800
Ref: 18b34842800
Ref: library/array array array itemsize4842886
Ref: 18b44842886
Ref: library/array array array append4842998
Ref: 18b54842998
Ref: library/array array array buffer_info4843092
Ref: 18b64843092
Ref: library/array array array byteswap4844122
Ref: 18b74844122
Ref: library/array array array count4844449
Ref: 18b84844449
Ref: library/array array array extend4844538
Ref: 18b14844538
Ref: library/array array array frombytes4844898
Ref: 18af4844898
Ref: library/array array array fromfile4845220
Ref: 18b94845220
Ref: library/array array array fromlist4845635
Ref: 18ae4845635
Ref: library/array array array fromstring4845832
Ref: 18ba4845832
Ref: library/array array array fromunicode4845985
Ref: 18b04845985
Ref: library/array array array index4846299
Ref: 18bb4846299
Ref: library/array array array insert4846435
Ref: 18bc4846435
Ref: library/array array array pop4846622
Ref: 18bd4846622
Ref: library/array array array remove4846836
Ref: 18be4846836
Ref: library/array array array reverse4846923
Ref: 18bf4846923
Ref: library/array array array tobytes4847004
Ref: 18c04847004
Ref: library/array array array tofile4847337
Ref: 18c14847337
Ref: library/array array array tolist4847450
Ref: 18c34847450
Ref: library/array array array tostring4847544
Ref: 18c24847544
Ref: library/array array array tounicode4847693
Ref: 18c44847693
Ref: array — Efficient arrays of numeric values-Footnote-14849069
Node: weakref — Weak references4849105
Ref: library/weakref doc4849301
Ref: 18c54849301
Ref: library/weakref module-weakref4849301
Ref: 1284849301
Ref: library/weakref weakref-weak-references4849301
Ref: 18c64849301
Ref: library/weakref weakref ref4853091
Ref: 9044853091
Ref: library/weakref weakref ref __callback__4854901
Ref: 9054854901
Ref: library/weakref weakref proxy4855266
Ref: 24e4855266
Ref: library/weakref weakref getweakrefcount4856132
Ref: 18ca4856132
Ref: library/weakref weakref getweakrefs4856265
Ref: 18cb4856265
Ref: library/weakref weakref WeakKeyDictionary4856399
Ref: 18c74856399
Ref: library/weakref weakref WeakKeyDictionary keyrefs4857677
Ref: 18cc4857677
Ref: library/weakref weakref WeakValueDictionary4857780
Ref: 18c84857780
Ref: library/weakref weakref WeakValueDictionary valuerefs4858594
Ref: 18cd4858594
Ref: library/weakref weakref WeakSet4858703
Ref: cab4858703
Ref: library/weakref weakref WeakMethod4858887
Ref: 9034858887
Ref: library/weakref weakref finalize4859822
Ref: 29b4859822
Ref: library/weakref weakref finalize __call__4861121
Ref: 18ce4861121
Ref: library/weakref weakref finalize detach4861332
Ref: 18cf4861332
Ref: library/weakref weakref finalize peek4861533
Ref: 18d04861533
Ref: library/weakref weakref finalize alive4861702
Ref: 18d14861702
Ref: library/weakref weakref finalize atexit4861817
Ref: 18d24861817
Ref: library/weakref weakref ReferenceType4862416
Ref: 18d34862416
Ref: library/weakref weakref ProxyType4862500
Ref: 18d44862500
Ref: library/weakref weakref CallableProxyType4862598
Ref: 18d54862598
Ref: library/weakref weakref ProxyTypes4862690
Ref: 18d64862690
Ref: library/weakref weakref ReferenceError4862900
Ref: e4e4862900
Ref: weakref — Weak references-Footnote-14863538
Ref: weakref — Weak references-Footnote-24863604
Node: Weak Reference Objects4863653
Ref: library/weakref weak-reference-objects4863758
Ref: 18d74863758
Ref: library/weakref weakref-objects4863758
Ref: 18d84863758
Node: Example<2>4866316
Ref: library/weakref example4866447
Ref: 18d94866447
Ref: library/weakref weakref-example4866447
Ref: 18da4866447
Node: Finalizer Objects4866988
Ref: library/weakref finalize-examples4867138
Ref: 18db4867138
Ref: library/weakref finalizer-objects4867138
Ref: 18dc4867138
Node: Comparing finalizers with __del__ methods4869070
Ref: library/weakref comparing-finalizers-with-del-methods4869201
Ref: 18dd4869201
Node: types — Dynamic type creation and names for built-in types4872025
Ref: library/types doc4872218
Ref: 18de4872218
Ref: library/types module-types4872218
Ref: 1184872218
Ref: library/types types-dynamic-type-creation-and-names-for-built-in-types4872218
Ref: 18df4872218
Ref: types — Dynamic type creation and names for built-in types-Footnote-14873019
Node: Dynamic Type Creation4873083
Ref: library/types dynamic-type-creation4873236
Ref: 18e04873236
Ref: library/types types new_class4873297
Ref: aac4873297
Ref: library/types types prepare_class4874009
Ref: aad4874009
Ref: library/types types resolve_bases4875178
Ref: 3fb4875178
Ref: Dynamic Type Creation-Footnote-14875849
Ref: Dynamic Type Creation-Footnote-24875898
Ref: Dynamic Type Creation-Footnote-34875947
Node: Standard Interpreter Types4875996
Ref: library/types standard-interpreter-types4876198
Ref: 18e14876198
Ref: library/types types FunctionType4876752
Ref: 18e24876752
Ref: library/types types LambdaType4876781
Ref: 18e34876781
Ref: library/types types GeneratorType4876912
Ref: 18e44876912
Ref: library/types types CoroutineType4877038
Ref: 7714877038
Ref: library/types types AsyncGeneratorType4877193
Ref: 18e54877193
Ref: library/types types CodeType4877377
Ref: 1984877377
Ref: library/types types CellType4877820
Ref: 13674877820
Ref: library/types types MethodType4877981
Ref: 18e64877981
Ref: library/types types BuiltinFunctionType4878068
Ref: 18e74878068
Ref: library/types types BuiltinMethodType4878104
Ref: 18e84878104
Ref: library/types types WrapperDescriptorType4878327
Ref: 3f74878327
Ref: library/types types MethodWrapperType4878542
Ref: 3f84878542
Ref: library/types types MethodDescriptorType4878743
Ref: 3f94878743
Ref: library/types types ClassMethodDescriptorType4878898
Ref: 3fa4878898
Ref: library/types types ModuleType4879083
Ref: 6e54879083
Ref: library/types types ModuleType __doc__4879442
Ref: 18e94879442
Ref: library/types types ModuleType __loader__4879549
Ref: 18ea4879549
Ref: library/types types ModuleType __name__4879785
Ref: 18eb4879785
Ref: library/types types ModuleType __package__4879850
Ref: 18ec4879850
Ref: library/types types TracebackType4880353
Ref: 32a4880353
Ref: library/types types FrameType4880664
Ref: 18ed4880664
Ref: library/types types GetSetDescriptorType4880905
Ref: 18ee4880905
Ref: library/types types MemberDescriptorType4881266
Ref: 18ef4881266
Ref: library/types types MappingProxyType4881784
Ref: aab4881784
Ref: library/types types MappingProxyType copy4882617
Ref: 18f04882617
Ref: library/types types MappingProxyType get4882703
Ref: 18f14882703
Ref: library/types types MappingProxyType items4882976
Ref: 18f24882976
Ref: library/types types MappingProxyType keys4883106
Ref: 18f34883106
Ref: library/types types MappingProxyType values4883197
Ref: 18f44883197
Node: Additional Utility Classes and Functions4883292
Ref: library/types additional-utility-classes-and-functions4883500
Ref: 18f54883500
Ref: library/types types SimpleNamespace4883599
Ref: 9a04883599
Ref: library/types types DynamicClassAttribute4884722
Ref: 8e74884722
Node: Coroutine Utility Functions4885379
Ref: library/types coroutine-utility-functions4885552
Ref: 18f64885552
Ref: library/types types coroutine4885625
Ref: 7704885625
Node: copy — Shallow and deep copy operations4886449
Ref: library/copy doc4886645
Ref: 18f74886645
Ref: library/copy copy-shallow-and-deep-copy-operations4886645
Ref: 18f84886645
Ref: library/copy module-copy4886645
Ref: 264886645
Ref: library/copy copy copy4887200
Ref: 3c04887200
Ref: library/copy copy deepcopy4887265
Ref: 3c14887265
Ref: library/copy copy error4887339
Ref: 18f94887339
Ref: library/copy shallow-vs-deep-copy4887406
Ref: 11634887406
Ref: copy — Shallow and deep copy operations-Footnote-14890053
Node: pprint — Data pretty printer4890116
Ref: library/pprint doc4890293
Ref: 18fa4890293
Ref: library/pprint module-pprint4890293
Ref: d24890293
Ref: library/pprint pprint-data-pretty-printer4890293
Ref: 18fb4890293
Ref: library/pprint pprint PrettyPrinter4891291
Ref: 8894891291
Ref: library/pprint pprint pformat4893963
Ref: 88a4893963
Ref: library/pprint pprint pp4894427
Ref: 2104894427
Ref: library/pprint pprint pprint4894852
Ref: 2114894852
Ref: library/pprint pprint isreadable4895933
Ref: 18fc4895933
Ref: library/pprint pprint isrecursive4896241
Ref: 18fd4896241
Ref: library/pprint pprint saferepr4896393
Ref: 18fe4896393
Ref: pprint — Data pretty printer-Footnote-14896977
Node: PrettyPrinter Objects4897042
Ref: library/pprint id14897149
Ref: 18ff4897149
Ref: library/pprint prettyprinter-objects4897149
Ref: 19004897149
Ref: library/pprint pprint PrettyPrinter pformat4897277
Ref: 19014897277
Ref: library/pprint pprint PrettyPrinter pprint4897476
Ref: 19024897476
Ref: library/pprint pprint PrettyPrinter isreadable4897863
Ref: 19034897863
Ref: library/pprint pprint PrettyPrinter isrecursive4898265
Ref: 19044898265
Ref: library/pprint pprint PrettyPrinter format4898581
Ref: 19054898581
Node: Example<3>4899740
Ref: library/pprint example4899847
Ref: 19064899847
Ref: library/pprint pprint-example4899847
Ref: 19074899847
Ref: Example<3>-Footnote-14907157
Node: reprlib — Alternate repr implementation4907182
Ref: library/reprlib doc4907351
Ref: 19084907351
Ref: library/reprlib module-reprlib4907351
Ref: df4907351
Ref: library/reprlib reprlib-alternate-repr-implementation4907351
Ref: 19094907351
Ref: library/reprlib reprlib Repr4907847
Ref: 190a4907847
Ref: library/reprlib reprlib aRepr4908131
Ref: 190b4908131
Ref: library/reprlib reprlib repr4908414
Ref: 190c4908414
Ref: library/reprlib reprlib recursive_repr4908816
Ref: b634908816
Ref: reprlib — Alternate repr implementation-Footnote-14909618
Node: Repr Objects4909684
Ref: library/reprlib id14909807
Ref: 190e4909807
Ref: library/reprlib repr-objects4909807
Ref: 190f4909807
Ref: library/reprlib reprlib Repr maxlevel4910048
Ref: 19104910048
Ref: library/reprlib reprlib Repr maxdict4910172
Ref: 19114910172
Ref: library/reprlib reprlib Repr maxlist4910200
Ref: 19124910200
Ref: library/reprlib reprlib Repr maxtuple4910228
Ref: 19134910228
Ref: library/reprlib reprlib Repr maxset4910257
Ref: 19144910257
Ref: library/reprlib reprlib Repr maxfrozenset4910284
Ref: 19154910284
Ref: library/reprlib reprlib Repr maxdeque4910317
Ref: 19164910317
Ref: library/reprlib reprlib Repr maxarray4910346
Ref: 19174910346
Ref: library/reprlib reprlib Repr maxlong4910574
Ref: 19184910574
Ref: library/reprlib reprlib Repr maxstring4910743
Ref: 19194910743
Ref: library/reprlib reprlib Repr maxother4911100
Ref: 191a4911100
Ref: library/reprlib reprlib Repr repr4911379
Ref: 190d4911379
Ref: library/reprlib reprlib Repr repr14911519
Ref: 191b4911519
Node: Subclassing Repr Objects4912337
Ref: library/reprlib subclassing-repr-objects4912460
Ref: 191c4912460
Ref: library/reprlib subclassing-reprs4912460
Ref: 191d4912460
Node: enum — Support for enumerations4913143
Ref: library/enum doc4913273
Ref: 191e4913273
Ref: library/enum enum-support-for-enumerations4913273
Ref: 191f4913273
Ref: library/enum module-enum4913273
Ref: 7b4913273
Ref: enum — Support for enumerations-Footnote-14914275
Node: Module Contents<2>4914338
Ref: library/enum module-contents4914451
Ref: 19204914451
Ref: library/enum enum Enum4914774
Ref: 37c4914774
Ref: library/enum enum IntEnum4914932
Ref: 5824914932
Ref: library/enum enum IntFlag4915057
Ref: 16934915057
Ref: library/enum enum Flag4915320
Ref: 53a4915320
Ref: library/enum enum unique4915503
Ref: 19214915503
Ref: library/enum enum auto4915619
Ref: 53b4915619
Node: Creating an Enum4915773
Ref: library/enum creating-an-enum4915958
Ref: 19234915958
Node: Programmatic access to enumeration members and their attributes4918404
Ref: library/enum programmatic-access-to-enumeration-members-and-their-attributes4918606
Ref: 19254918606
Node: Duplicating enum members and values4919364
Ref: library/enum duplicating-enum-members-and-values4919584
Ref: 19264919584
Node: Ensuring unique enumeration values4920675
Ref: library/enum ensuring-unique-enumeration-values4920854
Ref: 19274920854
Node: Using automatic values4921700
Ref: library/enum using-automatic-values4921853
Ref: 19284921853
Node: Iteration4922973
Ref: library/enum iteration4923106
Ref: 19294923106
Node: Comparisons<3>4923968
Ref: library/enum comparisons4924125
Ref: 192a4924125
Node: Allowed members and attributes of enumerations4925049
Ref: library/enum allowed-members-and-attributes-of-enumerations4925224
Ref: 192c4925224
Node: Restricted Enum subclassing4927061
Ref: library/enum restricted-enum-subclassing4927230
Ref: 192e4927230
Node: Pickling4928331
Ref: library/enum pickling4928468
Ref: 19304928468
Node: Functional API4929112
Ref: library/enum functional-api4929242
Ref: 19224929242
Node: Derived Enumerations4932502
Ref: library/enum derived-enumerations4932655
Ref: 19324932655
Node: IntEnum4932772
Ref: library/enum intenum4932852
Ref: 192b4932852
Node: IntFlag4933979
Ref: library/enum intflag4934072
Ref: 19334934072
Node: Flag4935610
Ref: library/enum flag4935702
Ref: 19344935702
Node: Others4937820
Ref: library/enum others4937896
Ref: 19354937896
Node: When to use __new__ vs __init__4939511
Ref: library/enum when-to-use-new-vs-init4939670
Ref: 19364939670
Node: Interesting examples4940788
Ref: library/enum interesting-examples4940951
Ref: 19374940951
Node: Omitting values4941398
Ref: library/enum omitting-values4941490
Ref: 19384941490
Node: Using auto4942542
Ref: library/enum using-auto4942625
Ref: 19394942625
Node: Using object4942879
Ref: library/enum using-object4942997
Ref: 193a4942997
Node: Using a descriptive string4943263
Ref: library/enum using-a-descriptive-string4943393
Ref: 193b4943393
Node: Using a custom __new__4943716
Ref: library/enum using-a-custom-new4943825
Ref: 193c4943825
Node: OrderedEnum4944628
Ref: library/enum orderedenum4944746
Ref: 192f4944746
Node: DuplicateFreeEnum4945928
Ref: library/enum duplicatefreeenum4946037
Ref: 193d4946037
Node: Planet4947116
Ref: library/enum planet4947224
Ref: 192d4947224
Node: TimePeriod4948286
Ref: library/enum timeperiod4948368
Ref: 193e4948368
Node: How are Enums different?4948983
Ref: library/enum how-are-enums-different4949106
Ref: 19244949106
Node: Enum Classes4949398
Ref: library/enum enum-classes4949506
Ref: 193f4949506
Node: Enum Members aka instances4950084
Ref: library/enum enum-members-aka-instances4950213
Ref: 19404950213
Node: Finer Points4950609
Ref: library/enum finer-points4950717
Ref: 19414950717
Node: Supported __dunder__ names4950961
Ref: library/enum supported-dunder-names4951069
Ref: 19424951069
Node: Supported _sunder_ names4951492
Ref: library/enum supported-sunder-names4951625
Ref: 19434951625
Node: Enum member type4953127
Ref: library/enum enum-member-type4953275
Ref: 19444953275
Node: Boolean value of Enum classes and members4953990
Ref: library/enum boolean-value-of-enum-classes-and-members4954139
Ref: 19454954139
Node: Enum classes with methods4954712
Ref: library/enum enum-classes-with-methods4954870
Ref: 19464954870
Node: Combining members of Flag4955406
Ref: library/enum combining-members-of-flag4955514
Ref: 19474955514
Node: Numeric and Mathematical Modules4956134
Ref: library/numeric doc4956288
Ref: 19484956288
Ref: library/numeric numeric4956288
Ref: 19494956288
Ref: library/numeric numeric-and-mathematical-modules4956288
Ref: 194a4956288
Node: numbers — Numeric abstract base classes4957193
Ref: library/numbers doc4957343
Ref: 194b4957343
Ref: library/numbers module-numbers4957343
Ref: c14957343
Ref: library/numbers numbers-numeric-abstract-base-classes4957343
Ref: 194c4957343
Ref: library/numbers numbers Number4957766
Ref: 135e4957766
Ref: numbers — Numeric abstract base classes-Footnote-14958062
Ref: numbers — Numeric abstract base classes-Footnote-24958128
Node: The numeric tower4958177
Ref: library/numbers the-numeric-tower4958308
Ref: 194d4958308
Ref: library/numbers numbers Complex4958361
Ref: 13614958361
Ref: library/numbers numbers Complex real4958802
Ref: 194e4958802
Ref: library/numbers numbers Complex imag4958895
Ref: 194f4958895
Ref: library/numbers numbers Complex conjugate4958993
Ref: 19504958993
Ref: library/numbers numbers Real4959152
Ref: 13604959152
Ref: library/numbers numbers Rational4959659
Ref: c4b4959659
Ref: library/numbers numbers Rational numerator4959896
Ref: 19514959896
Ref: library/numbers numbers Rational denominator4959948
Ref: 19524959948
Ref: library/numbers numbers Integral4960002
Ref: 135f4960002
Node: Notes for type implementors4960337
Ref: library/numbers notes-for-type-implementors4960468
Ref: 19534960468
Node: Adding More Numeric ABCs4961318
Ref: library/numbers adding-more-numeric-abcs4961453
Ref: 19544961453
Node: Implementing the arithmetic operations4961799
Ref: library/numbers id14961934
Ref: 19554961934
Ref: library/numbers implementing-the-arithmetic-operations4961934
Ref: 135d4961934
Node: math — Mathematical functions4966730
Ref: library/math doc4966941
Ref: 19564966941
Ref: library/math math-mathematical-functions4966941
Ref: 19574966941
Ref: library/math module-math4966941
Ref: b14966941
Node: Number-theoretic and representation functions4968111
Ref: library/math number-theoretic-and-representation-functions4968264
Ref: 19584968264
Ref: library/math math ceil4968373
Ref: d204968373
Ref: library/math math comb4968605
Ref: 1e54968605
Ref: library/math math copysign4969216
Ref: d304969216
Ref: library/math math fabs4969430
Ref: 19594969430
Ref: library/math math factorial4969499
Ref: 1e84969499
Ref: library/math math floor4969650
Ref: d1f4969650
Ref: library/math math fmod4969878
Ref: 14764969878
Ref: library/math math frexp4970864
Ref: 195a4970864
Ref: library/math math fsum4971229
Ref: d314971229
Ref: library/math math gcd4972068
Ref: 70a4972068
Ref: library/math math isclose4972375
Ref: 67a4972375
Ref: library/math math isfinite4973721
Ref: b5a4973721
Ref: library/math math isinf4973924
Ref: d2e4973924
Ref: library/math math isnan4974053
Ref: d2f4974053
Ref: library/math math isqrt4974171
Ref: 1e64974171
Ref: library/math math ldexp4974689
Ref: 195b4974689
Ref: library/math math modf4974824
Ref: 195c4974824
Ref: library/math math perm4974964
Ref: 1e44974964
Ref: library/math math prod4975505
Ref: 1e24975505
Ref: library/math math remainder4975881
Ref: 3a04975881
Ref: library/math math trunc4976907
Ref: d214976907
Ref: Number-theoretic and representation functions-Footnote-14977795
Ref: Number-theoretic and representation functions-Footnote-24977848
Node: Power and logarithmic functions4977897
Ref: library/math power-and-logarithmic-functions4978082
Ref: 195d4978082
Ref: library/math math exp4978163
Ref: c9c4978163
Ref: library/math math expm14978381
Ref: b5b4978381
Ref: library/math math log4978994
Ref: e044978994
Ref: library/math math log1p4979229
Ref: d354979229
Ref: library/math math log24979392
Ref: a154979392
Ref: library/math math log104979732
Ref: 195e4979732
Ref: library/math math pow4979864
Ref: 195f4979864
Ref: library/math math sqrt4980560
Ref: 1e74980560
Ref: Power and logarithmic functions-Footnote-14980662
Node: Trigonometric functions4980721
Ref: library/math trigonometric-functions4980879
Ref: 19604980879
Ref: library/math math acos4980944
Ref: 19614980944
Ref: library/math math asin4981021
Ref: 19624981021
Ref: library/math math atan4981096
Ref: 19634981096
Ref: library/math math atan24981174
Ref: 19644981174
Ref: library/math math cos4981686
Ref: e034981686
Ref: library/math math dist4981754
Ref: 1e04981754
Ref: library/math math hypot4982083
Ref: 1e14982083
Ref: library/math math sin4982608
Ref: e024982608
Ref: library/math math tan4982674
Ref: 19654982674
Node: Angular conversion4982743
Ref: library/math angular-conversion4982890
Ref: 19664982890
Ref: library/math math degrees4982945
Ref: 19674982945
Ref: library/math math radians4983026
Ref: 19684983026
Node: Hyperbolic functions4983107
Ref: library/math hyperbolic-functions4983248
Ref: 19694983248
Ref: library/math math acosh4983420
Ref: d324983420
Ref: library/math math asinh4983501
Ref: d334983501
Ref: library/math math atanh4983580
Ref: d344983580
Ref: library/math math cosh4983662
Ref: 196a4983662
Ref: library/math math sinh4983734
Ref: 196b4983734
Ref: library/math math tanh4983804
Ref: 196c4983804
Ref: Hyperbolic functions-Footnote-14983913
Node: Special functions4983971
Ref: library/math special-functions4984106
Ref: 196d4984106
Ref: library/math math erf4984159
Ref: 4474984159
Ref: library/math math erfc4984579
Ref: 4484984579
Ref: library/math math gamma4984878
Ref: b5c4984878
Ref: library/math math lgamma4984977
Ref: b5d4984977
Ref: Special functions-Footnote-14985162
Ref: Special functions-Footnote-24985215
Ref: Special functions-Footnote-34985307
Ref: Special functions-Footnote-44985360
Ref: Special functions-Footnote-54985419
Node: Constants<2>4985472
Ref: library/math constants4985578
Ref: 196e4985578
Ref: library/math math pi4985615
Ref: 196f4985615
Ref: library/math math e4985710
Ref: 19704985710
Ref: library/math math tau4985803
Ref: 19714985803
Ref: library/math math inf4986181
Ref: 51d4986181
Ref: library/math math nan4986370
Ref: 51e4986370
Ref: Constants<2>-Footnote-14987700
Ref: Constants<2>-Footnote-24987752
Node: cmath — Mathematical functions for complex numbers4987780
Ref: library/cmath doc4988011
Ref: 19724988011
Ref: library/cmath cmath-mathematical-functions-for-complex-numbers4988011
Ref: 19734988011
Ref: library/cmath module-cmath4988011
Ref: 194988011
Node: Conversions to and from polar coordinates4989303
Ref: library/cmath conversions-to-and-from-polar-coordinates4989476
Ref: 19744989476
Ref: library/cmath cmath phase4990328
Ref: 19754990328
Ref: library/cmath cmath polar4991235
Ref: 19764991235
Ref: library/cmath cmath rect4991488
Ref: 19774991488
Node: Power and logarithmic functions<2>4991662
Ref: library/cmath power-and-logarithmic-functions4991870
Ref: 19784991870
Ref: library/cmath cmath exp4991951
Ref: 19794991951
Ref: library/cmath cmath log4992072
Ref: 197a4992072
Ref: library/cmath cmath log104992345
Ref: 197b4992345
Ref: library/cmath cmath sqrt4992476
Ref: 197c4992476
Node: Trigonometric functions<2>4992600
Ref: library/cmath trigonometric-functions4992790
Ref: 197d4992790
Ref: library/cmath cmath acos4992855
Ref: 197e4992855
Ref: library/cmath cmath asin4993124
Ref: 197f4993124
Ref: library/cmath cmath atan4993247
Ref: 19804993247
Ref: library/cmath cmath cos4993551
Ref: 19814993551
Ref: library/cmath cmath sin4993612
Ref: 19824993612
Ref: library/cmath cmath tan4993671
Ref: 19834993671
Node: Hyperbolic functions<2>4993733
Ref: library/cmath hyperbolic-functions4993913
Ref: 19844993913
Ref: library/cmath cmath acosh4993972
Ref: 19854993972
Ref: library/cmath cmath asinh4994164
Ref: 19864994164
Ref: library/cmath cmath atanh4994481
Ref: 19874994481
Ref: library/cmath cmath cosh4994780
Ref: 19884994780
Ref: library/cmath cmath sinh4994853
Ref: 19894994853
Ref: library/cmath cmath tanh4994924
Ref: 198a4994924
Node: Classification functions4994998
Ref: library/cmath classification-functions4995164
Ref: 198b4995164
Ref: library/cmath cmath isfinite4995231
Ref: 198c4995231
Ref: library/cmath cmath isinf4995403
Ref: 198d4995403
Ref: library/cmath cmath isnan4995554
Ref: 198e4995554
Ref: library/cmath cmath isclose4995699
Ref: 67b4995699
Ref: Classification functions-Footnote-14997082
Node: Constants<3>4997131
Ref: library/cmath constants4997265
Ref: 198f4997265
Ref: library/cmath cmath pi4997302
Ref: 19904997302
Ref: library/cmath cmath e4997372
Ref: 19914997372
Ref: library/cmath cmath tau4997440
Ref: 51a4997440
Ref: library/cmath cmath inf4997537
Ref: 51b4997537
Ref: library/cmath cmath infj4997659
Ref: 51f4997659
Ref: library/cmath cmath nan4997840
Ref: 51c4997840
Ref: library/cmath cmath nanj4997982
Ref: 5204997982
Node: decimal — Decimal fixed point and floating point arithmetic4999393
Ref: library/decimal doc4999623
Ref: 19924999623
Ref: library/decimal decimal-decimal-fixed-point-and-floating-point-arithmetic4999623
Ref: 19934999623
Ref: library/decimal module-decimal4999623
Ref: 364999623
Ref: decimal — Decimal fixed point and floating point arithmetic-Footnote-15004746
Ref: decimal — Decimal fixed point and floating point arithmetic-Footnote-25004812
Node: Quick-start Tutorial5004865
Ref: library/decimal decimal-tutorial5005007
Ref: 19a35005007
Ref: library/decimal quick-start-tutorial5005007
Ref: 19a45005007
Node: Decimal objects5012227
Ref: library/decimal decimal-decimal5012393
Ref: 19a75012393
Ref: library/decimal decimal-objects5012393
Ref: 19a85012393
Ref: library/decimal decimal Decimal5012442
Ref: 1885012442
Ref: library/decimal decimal Decimal adjusted5017568
Ref: 19a95017568
Ref: library/decimal decimal Decimal as_integer_ratio5017919
Ref: 5305017919
Ref: library/decimal decimal Decimal as_tuple5018358
Ref: 19aa5018358
Ref: library/decimal decimal Decimal canonical5018516
Ref: 19ab5018516
Ref: library/decimal decimal Decimal compare5018755
Ref: 19ac5018755
Ref: library/decimal decimal Decimal compare_signal5019188
Ref: 19ad5019188
Ref: library/decimal decimal Decimal compare_total5019500
Ref: 19ae5019500
Ref: library/decimal decimal Decimal compare_total_mag5020777
Ref: 19af5020777
Ref: library/decimal decimal Decimal conjugate5021382
Ref: 19b05021382
Ref: library/decimal decimal Decimal copy_abs5021515
Ref: 19b15021515
Ref: library/decimal decimal Decimal copy_negate5021729
Ref: 19b25021729
Ref: library/decimal decimal Decimal copy_sign5021940
Ref: 19b35021940
Ref: library/decimal decimal Decimal exp5022477
Ref: 9e15022477
Ref: library/decimal decimal Decimal from_float5022911
Ref: b735022911
Ref: library/decimal decimal Decimal fma5024013
Ref: 19b45024013
Ref: library/decimal decimal Decimal is_canonical5024257
Ref: 19b55024257
Ref: library/decimal decimal Decimal is_finite5024532
Ref: 19b65024532
Ref: library/decimal decimal Decimal is_infinite5024707
Ref: 19b75024707
Ref: library/decimal decimal Decimal is_nan5024874
Ref: 19b85024874
Ref: library/decimal decimal Decimal is_normal5025026
Ref: 19b95025026
Ref: library/decimal decimal Decimal is_qnan5025250
Ref: 19ba5025250
Ref: library/decimal decimal Decimal is_signed5025389
Ref: 19bb5025389
Ref: library/decimal decimal Decimal is_snan5025592
Ref: 19bc5025592
Ref: library/decimal decimal Decimal is_subnormal5025734
Ref: 19bd5025734
Ref: library/decimal decimal Decimal is_zero5025888
Ref: 19be5025888
Ref: library/decimal decimal Decimal ln5026044
Ref: 9e25026044
Ref: library/decimal decimal Decimal log105026252
Ref: 19bf5026252
Ref: library/decimal decimal Decimal logb5026455
Ref: 19c05026455
Ref: library/decimal decimal Decimal logical_and5026842
Ref: 19c15026842
Ref: library/decimal decimal Decimal logical_invert5027107
Ref: 19c35027107
Ref: library/decimal decimal Decimal logical_or5027286
Ref: 19c45027286
Ref: library/decimal decimal Decimal logical_xor5027548
Ref: 19c55027548
Ref: library/decimal decimal Decimal max5027816
Ref: 19c65027816
Ref: library/decimal decimal Decimal max_mag5028120
Ref: 19c75028120
Ref: library/decimal decimal Decimal min5028301
Ref: 19c85028301
Ref: library/decimal decimal Decimal min_mag5028605
Ref: 19c95028605
Ref: library/decimal decimal Decimal next_minus5028786
Ref: 19ca5028786
Ref: library/decimal decimal Decimal next_plus5029024
Ref: 19cb5029024
Ref: library/decimal decimal Decimal next_toward5029261
Ref: 19cc5029261
Ref: library/decimal decimal Decimal normalize5029628
Ref: 19cd5029628
Ref: library/decimal decimal Decimal number_class5030084
Ref: 19ce5030084
Ref: library/decimal decimal Decimal quantize5031254
Ref: 9e55031254
Ref: library/decimal decimal Decimal radix5032547
Ref: 19cf5032547
Ref: library/decimal decimal Decimal remainder_near5032764
Ref: 19d05032764
Ref: library/decimal decimal Decimal rotate5033608
Ref: 19d15033608
Ref: library/decimal decimal Decimal same_quantum5034281
Ref: 19d25034281
Ref: library/decimal decimal Decimal scaleb5034693
Ref: 19d35034693
Ref: library/decimal decimal Decimal shift5034944
Ref: 19d45034944
Ref: library/decimal decimal Decimal sqrt5035550
Ref: 19d55035550
Ref: library/decimal decimal Decimal to_eng_string5035657
Ref: 19d65035657
Ref: library/decimal decimal Decimal to_integral5036133
Ref: 19d75036133
Ref: library/decimal decimal Decimal to_integral_exact5036363
Ref: 19d95036363
Ref: library/decimal decimal Decimal to_integral_value5036793
Ref: 19d85036793
Node: Logical operands5037147
Ref: library/decimal logical-operands5037215
Ref: 19da5037215
Ref: library/decimal logical-operands-label5037215
Ref: 19c25037215
Node: Context objects5037562
Ref: library/decimal context-objects5037720
Ref: 19db5037720
Ref: library/decimal decimal-context5037720
Ref: 19dc5037720
Ref: library/decimal decimal getcontext5038104
Ref: 19a55038104
Ref: library/decimal decimal setcontext5038197
Ref: 19a65038197
Ref: library/decimal decimal localcontext5038431
Ref: 16195038431
Ref: library/decimal decimal BasicContext5039356
Ref: 9dd5039356
Ref: library/decimal decimal ExtendedContext5039808
Ref: 9de5039808
Ref: library/decimal decimal DefaultContext5040441
Ref: 9dc5040441
Ref: library/decimal decimal Context5041543
Ref: 9e45041543
Ref: library/decimal decimal Context clear_flags5044462
Ref: 19e15044462
Ref: library/decimal decimal Context clear_traps5044542
Ref: 19e25044542
Ref: library/decimal decimal Context copy5044653
Ref: 19e35044653
Ref: library/decimal decimal Context copy_decimal5044725
Ref: 19e45044725
Ref: library/decimal decimal Context create_decimal5044816
Ref: 9e05044816
Ref: library/decimal decimal Context create_decimal_from_float5045920
Ref: 19e55045920
Ref: library/decimal decimal Context Etiny5046683
Ref: 19e65046683
Ref: library/decimal decimal Context Etop5046913
Ref: 19e75046913
Ref: library/decimal decimal Context abs5047419
Ref: 19e85047419
Ref: library/decimal decimal Context add5047491
Ref: 19e95047491
Ref: library/decimal decimal Context canonical5047562
Ref: c905047562
Ref: library/decimal decimal Context compare5047642
Ref: 19ea5047642
Ref: library/decimal decimal Context compare_signal5047720
Ref: 19eb5047720
Ref: library/decimal decimal Context compare_total5047824
Ref: 19ec5047824
Ref: library/decimal decimal Context compare_total_mag5047933
Ref: 19ed5047933
Ref: library/decimal decimal Context copy_abs5048071
Ref: 19ee5048071
Ref: library/decimal decimal Context copy_negate5048159
Ref: 19ef5048159
Ref: library/decimal decimal Context copy_sign5048250
Ref: 19f05048250
Ref: library/decimal decimal Context divide5048329
Ref: 19f15048329
Ref: library/decimal decimal Context divide_int5048399
Ref: 19f25048399
Ref: library/decimal decimal Context divmod5048498
Ref: 19f35048498
Ref: library/decimal decimal Context exp5048615
Ref: 19f45048615
Ref: library/decimal decimal Context fma5048674
Ref: 19f55048674
Ref: library/decimal decimal Context is_canonical5048758
Ref: c915048758
Ref: library/decimal decimal Context is_finite5048875
Ref: 19f65048875
Ref: library/decimal decimal Context is_infinite5048986
Ref: 19f75048986
Ref: library/decimal decimal Context is_nan5049101
Ref: 19f85049101
Ref: library/decimal decimal Context is_normal5049227
Ref: 19f95049227
Ref: library/decimal decimal Context is_qnan5049357
Ref: 19fa5049357
Ref: library/decimal decimal Context is_signed5049481
Ref: 19fb5049481
Ref: library/decimal decimal Context is_snan5049594
Ref: 19fc5049594
Ref: library/decimal decimal Context is_subnormal5049722
Ref: 19fd5049722
Ref: library/decimal decimal Context is_zero5049839
Ref: 19fe5049839
Ref: library/decimal decimal Context ln5049948
Ref: 19ff5049948
Ref: library/decimal decimal Context log105050031
Ref: 1a005050031
Ref: library/decimal decimal Context logb5050108
Ref: 1a015050108
Ref: library/decimal decimal Context logical_and5050208
Ref: 1a025050208
Ref: library/decimal decimal Context logical_invert5050335
Ref: 1a035050335
Ref: library/decimal decimal Context logical_or5050413
Ref: 1a045050413
Ref: library/decimal decimal Context logical_xor5050538
Ref: 1a055050538
Ref: library/decimal decimal Context max5050665
Ref: 1a065050665
Ref: library/decimal decimal Context max_mag5050762
Ref: 1a075050762
Ref: library/decimal decimal Context min5050863
Ref: 1a085050863
Ref: library/decimal decimal Context min_mag5050960
Ref: 1a095050960
Ref: library/decimal decimal Context minus5051061
Ref: 1a0a5051061
Ref: library/decimal decimal Context multiply5051174
Ref: 1a0b5051174
Ref: library/decimal decimal Context next_minus5051254
Ref: 1a0c5051254
Ref: library/decimal decimal Context next_plus5051357
Ref: 1a0d5051357
Ref: library/decimal decimal Context next_toward5051459
Ref: 1a0e5051459
Ref: library/decimal decimal Context normalize5051568
Ref: 1a0f5051568
Ref: library/decimal decimal Context number_class5051645
Ref: 1a105051645
Ref: library/decimal decimal Context plus5051734
Ref: 1a115051734
Ref: library/decimal decimal Context power5051951
Ref: 1a125051951
Ref: library/decimal decimal Context quantize5053605
Ref: 1a135053605
Ref: library/decimal decimal Context radix5053728
Ref: 1a145053728
Ref: library/decimal decimal Context remainder5053806
Ref: 1a155053806
Ref: library/decimal decimal Context remainder_near5054001
Ref: 1a165054001
Ref: library/decimal decimal Context rotate5054221
Ref: 1a175054221
Ref: library/decimal decimal Context same_quantum5054306
Ref: 1a185054306
Ref: library/decimal decimal Context scaleb5054418
Ref: 1a195054418
Ref: library/decimal decimal Context shift5054536
Ref: 1a1a5054536
Ref: library/decimal decimal Context sqrt5054620
Ref: 1a1b5054620
Ref: library/decimal decimal Context subtract5054717
Ref: 1a1c5054717
Ref: library/decimal decimal Context to_eng_string5054805
Ref: 1a1d5054805
Ref: library/decimal decimal Context to_integral_exact5055169
Ref: 1a1e5055169
Ref: library/decimal decimal Context to_sci_string5055242
Ref: 1a1f5055242
Node: Constants<4>5055346
Ref: library/decimal constants5055503
Ref: 1a205055503
Ref: library/decimal decimal-rounding-modes5055503
Ref: 1a215055503
Ref: library/decimal decimal MAX_PREC5055940
Ref: 19dd5055940
Ref: library/decimal decimal MAX_EMAX5056075
Ref: 19e05056075
Ref: library/decimal decimal MIN_EMIN5056210
Ref: 19df5056210
Ref: library/decimal decimal MIN_ETINY5056346
Ref: 1a225056346
Ref: library/decimal decimal HAVE_THREADS5056474
Ref: 9da5056474
Node: Rounding modes5056719
Ref: library/decimal rounding-modes5056868
Ref: 19de5056868
Ref: library/decimal decimal ROUND_CEILING5056915
Ref: 19945056915
Ref: library/decimal decimal ROUND_DOWN5056984
Ref: 19955056984
Ref: library/decimal decimal ROUND_FLOOR5057040
Ref: 19965057040
Ref: library/decimal decimal ROUND_HALF_DOWN5057108
Ref: 19975057108
Ref: library/decimal decimal ROUND_HALF_EVEN5057196
Ref: 19985057196
Ref: library/decimal decimal ROUND_HALF_UP5057295
Ref: 19995057295
Ref: library/decimal decimal ROUND_UP5057383
Ref: 199a5057383
Ref: library/decimal decimal ROUND_05UP5057439
Ref: 199b5057439
Node: Signals5057597
Ref: library/decimal decimal-signals5057754
Ref: 1a235057754
Ref: library/decimal signals5057754
Ref: 1a245057754
Ref: library/decimal decimal Clamped5058471
Ref: 199c5058471
Ref: library/decimal decimal DecimalException5058765
Ref: 1a255058765
Ref: library/decimal decimal DivisionByZero5058889
Ref: 199d5058889
Ref: library/decimal decimal Inexact5059227
Ref: 199e5059227
Ref: library/decimal decimal InvalidOperation5059502
Ref: 9df5059502
Ref: library/decimal decimal Overflow5059943
Ref: 19a15059943
Ref: library/decimal decimal Rounded5060346
Ref: 199f5060346
Ref: library/decimal decimal Subnormal5060684
Ref: 19a05060684
Ref: library/decimal decimal Underflow5060906
Ref: 19a25060906
Ref: library/decimal decimal FloatOperation5061131
Ref: 9d95061131
Node: Floating Point Notes5062403
Ref: library/decimal decimal-notes5062566
Ref: 1a265062566
Ref: library/decimal floating-point-notes5062566
Ref: 1a275062566
Node: Mitigating round-off error with increased precision5062710
Ref: library/decimal mitigating-round-off-error-with-increased-precision5062841
Ref: 1a285062841
Node: Special values5064530
Ref: library/decimal special-values5064661
Ref: 1a295064661
Node: Working with threads5067782
Ref: library/decimal decimal-threads5067945
Ref: 1a2a5067945
Ref: library/decimal working-with-threads5067945
Ref: 1a2b5067945
Node: Recipes5069318
Ref: library/decimal decimal-recipes5069472
Ref: 1a2c5069472
Ref: library/decimal recipes5069472
Ref: 1a2d5069472
Node: Decimal FAQ5074317
Ref: library/decimal decimal-faq5074442
Ref: 1a2e5074442
Ref: library/decimal id15074442
Ref: 1a2f5074442
Ref: Decimal FAQ-Footnote-15080753
Ref: Decimal FAQ-Footnote-25080820
Ref: Decimal FAQ-Footnote-35080878
Node: fractions — Rational numbers5080981
Ref: library/fractions doc5081200
Ref: 1a305081200
Ref: library/fractions fractions-rational-numbers5081200
Ref: 1a315081200
Ref: library/fractions module-fractions5081200
Ref: 835081200
Ref: library/fractions fractions Fraction5081580
Ref: 1855081580
Ref: library/fractions fractions Fraction numerator5084756
Ref: 1a335084756
Ref: library/fractions fractions Fraction denominator5084840
Ref: 1a345084840
Ref: library/fractions fractions Fraction as_integer_ratio5084928
Ref: 1a355084928
Ref: library/fractions fractions Fraction from_float5085120
Ref: b745085120
Ref: library/fractions fractions Fraction from_decimal5085579
Ref: b755085579
Ref: library/fractions fractions Fraction limit_denominator5085978
Ref: 1a325085978
Ref: library/fractions fractions Fraction __floor__5086852
Ref: 1a365086852
Ref: library/fractions fractions Fraction __ceil__5087152
Ref: 1a375087152
Ref: library/fractions fractions Fraction __round__5087332
Ref: 1a385087332
Ref: library/fractions fractions gcd5087802
Ref: 70b5087802
Ref: fractions — Rational numbers-Footnote-15088403
Node: random — Generate pseudo-random numbers5088471
Ref: library/random doc5088677
Ref: 1a395088677
Ref: library/random module-random5088677
Ref: dc5088677
Ref: library/random random-generate-pseudo-random-numbers5088677
Ref: 1a3a5088677
Ref: random — Generate pseudo-random numbers-Footnote-15091667
Ref: random — Generate pseudo-random numbers-Footnote-25091732
Node: Bookkeeping functions5091785
Ref: library/random bookkeeping-functions5091915
Ref: 1a3e5091915
Ref: library/random random seed5091976
Ref: bfb5091976
Ref: library/random random getstate5092866
Ref: 1a3f5092866
Ref: library/random random setstate5093064
Ref: 1a405093064
Ref: library/random random getrandbits5093342
Ref: 9275093342
Node: Functions for integers5093701
Ref: library/random functions-for-integers5093863
Ref: 1a415093863
Ref: library/random random randrange5093926
Ref: bae5093926
Ref: library/random random randint5094628
Ref: baf5094628
Node: Functions for sequences5094769
Ref: library/random functions-for-sequences5094935
Ref: 1a425094935
Ref: library/random random choice5095000
Ref: bb05095000
Ref: library/random random choices5095155
Ref: 5695095155
Ref: library/random random shuffle5097029
Ref: bb15097029
Ref: library/random random sample5097795
Ref: bb25097795
Node: Real-valued distributions5098864
Ref: library/random real-valued-distributions5099029
Ref: 1a435099029
Ref: library/random random random5099368
Ref: 1a3b5099368
Ref: library/random random uniform5099481
Ref: 1a445099481
Ref: library/random random triangular5099820
Ref: 1a455099820
Ref: library/random random betavariate5100177
Ref: 1a465100177
Ref: library/random random expovariate5100365
Ref: 1a475100365
Ref: library/random random gammavariate5100744
Ref: 1a485100744
Ref: library/random random gauss5101146
Ref: 1a495101146
Ref: library/random random lognormvariate5101370
Ref: 1a4b5101370
Ref: library/random random normalvariate5101669
Ref: 1a4a5101669
Ref: library/random random vonmisesvariate5101807
Ref: 1a4c5101807
Ref: library/random random paretovariate5102149
Ref: 1a4d5102149
Ref: library/random random weibullvariate5102253
Ref: 1a4e5102253
Node: Alternative Generator5102404
Ref: library/random alternative-generator5102570
Ref: 1a4f5102570
Ref: library/random random Random5102631
Ref: 1a3c5102631
Ref: library/random random SystemRandom5102780
Ref: 1a3d5102780
Node: Notes on Reproducibility5103277
Ref: library/random notes-on-reproducibility5103438
Ref: 1a505103438
Node: Examples and Recipes5104136
Ref: library/random examples-and-recipes5104267
Ref: 1a515104267
Ref: library/random random-examples5104267
Ref: b4b5104267
Ref: Examples and Recipes-Footnote-15109689
Ref: Examples and Recipes-Footnote-25109754
Ref: Examples and Recipes-Footnote-35109835
Ref: Examples and Recipes-Footnote-45109881
Ref: Examples and Recipes-Footnote-55109933
Ref: Examples and Recipes-Footnote-65109988
Ref: Examples and Recipes-Footnote-75110064
Ref: Examples and Recipes-Footnote-85110099
Ref: Examples and Recipes-Footnote-95110177
Node: statistics — Mathematical statistics functions5110212
Ref: library/statistics doc5110379
Ref: 1a525110379
Ref: library/statistics module-statistics5110379
Ref: f55110379
Ref: library/statistics statistics-mathematical-statistics-functions5110379
Ref: 1a535110379
Ref: statistics — Mathematical statistics functions-Footnote-15111673
Ref: statistics — Mathematical statistics functions-Footnote-25111742
Ref: statistics — Mathematical statistics functions-Footnote-35111768
Node: Averages and measures of central location5111799
Ref: library/statistics averages-and-measures-of-central-location5111952
Ref: 1a545111952
Node: Measures of spread5113475
Ref: library/statistics measures-of-spread5113653
Ref: 1a595113653
Node: Function details5114279
Ref: library/statistics function-details5114429
Ref: 1a5e5114429
Ref: library/statistics statistics mean5114631
Ref: 1995114631
Ref: library/statistics statistics fmean5116237
Ref: 2255116237
Ref: library/statistics statistics geometric_mean5116650
Ref: 2265116650
Ref: library/statistics statistics harmonic_mean5117337
Ref: 5845117337
Ref: library/statistics statistics median5118807
Ref: 1a555118807
Ref: library/statistics statistics median_low5119802
Ref: 1a565119802
Ref: library/statistics statistics median_high5120443
Ref: 1a575120443
Ref: library/statistics statistics median_grouped5121081
Ref: 1a585121081
Ref: library/statistics statistics mode5122740
Ref: 2b95122740
Ref: library/statistics statistics multimode5123906
Ref: 2275123906
Ref: library/statistics statistics pstdev5124325
Ref: 1a5a5124325
Ref: library/statistics statistics pvariance5124625
Ref: 1a5b5124625
Ref: library/statistics statistics stdev5126891
Ref: 1a5c5126891
Ref: library/statistics statistics variance5127183
Ref: 1a5d5127183
Ref: library/statistics statistics quantiles5129448
Ref: 2285129448
Ref: Function details-Footnote-15132216
Ref: Function details-Footnote-25132311
Node: Exceptions<3>5132391
Ref: library/statistics exceptions5132541
Ref: 1a605132541
Ref: library/statistics statistics StatisticsError5132612
Ref: 1a5f5132612
Node: NormalDist objects5132736
Ref: library/statistics normaldist-objects5132861
Ref: 1a615132861
Ref: library/statistics statistics NormalDist5133249
Ref: 2295133249
Ref: library/statistics statistics NormalDist mean5133514
Ref: 1a625133514
Ref: library/statistics statistics NormalDist median5133635
Ref: 1a635133635
Ref: library/statistics statistics NormalDist mode5133749
Ref: 1a645133749
Ref: library/statistics statistics NormalDist stdev5133849
Ref: 1a655133849
Ref: library/statistics statistics NormalDist variance5133974
Ref: 1a665133974
Ref: library/statistics statistics NormalDist from_samples5134140
Ref: 1a675134140
Ref: library/statistics statistics NormalDist samples5134742
Ref: 1a685134742
Ref: library/statistics statistics NormalDist pdf5135147
Ref: 1a695135147
Ref: library/statistics statistics NormalDist cdf5135748
Ref: 1a6a5135748
Ref: library/statistics statistics NormalDist inv_cdf5135991
Ref: 1a6b5135991
Ref: library/statistics statistics NormalDist overlap5136430
Ref: 1a6c5136430
Ref: library/statistics statistics NormalDist quantiles5136686
Ref: 1a6d5136686
Ref: NormalDist objects-Footnote-15138347
Ref: NormalDist objects-Footnote-25138411
Ref: NormalDist objects-Footnote-35138471
Ref: NormalDist objects-Footnote-45138525
Ref: NormalDist objects-Footnote-55138582
Ref: NormalDist objects-Footnote-65138636
Ref: NormalDist objects-Footnote-75138681
Ref: NormalDist objects-Footnote-85138737
Ref: NormalDist objects-Footnote-95138794
Ref: NormalDist objects-Footnote-105138841
Ref: NormalDist objects-Footnote-115138909
Ref: NormalDist objects-Footnote-125138981
Ref: NormalDist objects-Footnote-135139038
Ref: NormalDist objects-Footnote-145139130
Ref: NormalDist objects-Footnote-155139177
Node: NormalDist Examples and Recipes5139262
Ref: library/statistics normaldist-examples-and-recipes5139348
Ref: 1a6e5139348
Ref: NormalDist Examples and Recipes-Footnote-15142544
Ref: NormalDist Examples and Recipes-Footnote-25142604
Ref: NormalDist Examples and Recipes-Footnote-35142651
Ref: NormalDist Examples and Recipes-Footnote-45142696
Ref: NormalDist Examples and Recipes-Footnote-55142753
Ref: NormalDist Examples and Recipes-Footnote-65142834
Ref: NormalDist Examples and Recipes-Footnote-75142890
Node: Functional Programming Modules5142960
Ref: library/functional doc5143129
Ref: 1a6f5143129
Ref: library/functional functional-programming-modules5143129
Ref: 1a705143129
Node: itertools — Functions creating iterators for efficient looping5143612
Ref: library/itertools doc5143823
Ref: 1a715143823
Ref: library/itertools itertools-functions-creating-iterators-for-efficient-looping5143823
Ref: 1a725143823
Ref: library/itertools module-itertools5143823
Ref: a35143823
Node: Itertool functions5154212
Ref: library/itertools itertool-functions5154357
Ref: 1a7a5154357
Ref: library/itertools itertools-functions5154357
Ref: 1a7b5154357
Ref: library/itertools itertools accumulate5154604
Ref: 1db5154604
Ref: library/itertools itertools chain5158122
Ref: 153e5158122
Ref: library/itertools itertools chain from_iterable5158632
Ref: 1a745158632
Ref: library/itertools itertools combinations5159065
Ref: c995159065
Ref: library/itertools itertools combinations_with_replacement5160979
Ref: c0c5160979
Ref: library/itertools itertools compress5162898
Ref: c0d5162898
Ref: library/itertools itertools count5163414
Ref: c0e5163414
Ref: library/itertools itertools cycle5164258
Ref: 1a735164258
Ref: library/itertools itertools dropwhile5164978
Ref: 1a755164978
Ref: library/itertools itertools filterfalse5165679
Ref: 15275165679
Ref: library/itertools itertools groupby5166246
Ref: 1a765166246
Ref: library/itertools itertools islice5168982
Ref: 3975168982
Ref: library/itertools itertools permutations5171070
Ref: 1a795171070
Ref: library/itertools itertools product5173456
Ref: c9a5173456
Ref: library/itertools itertools repeat5174832
Ref: feb5174832
Ref: library/itertools itertools starmap5175702
Ref: a1d5175702
Ref: library/itertools itertools takewhile5176388
Ref: 1a775176388
Ref: library/itertools itertools tee5176830
Ref: 1a785176830
Ref: library/itertools itertools zip_longest5178559
Ref: c245178559
Ref: Itertool functions-Footnote-15180035
Node: Itertools Recipes5180093
Ref: library/itertools id15180238
Ref: 1a7d5180238
Ref: library/itertools itertools-recipes5180238
Ref: be85180238
Ref: Itertools Recipes-Footnote-15189278
Node: functools — Higher-order functions and operations on callable objects5189327
Ref: library/functools doc5189591
Ref: 1a7e5189591
Ref: library/functools functools-higher-order-functions-and-operations-on-callable-objects5189591
Ref: 1a7f5189591
Ref: library/functools module-functools5189591
Ref: 855189591
Ref: library/functools functools cached_property5190134
Ref: 1c65190134
Ref: library/functools functools cmp_to_key5191439
Ref: b495191439
Ref: library/functools functools lru_cache5192483
Ref: 1c55192483
Ref: library/functools functools total_ordering5196655
Ref: 83f5196655
Ref: library/functools functools partial5198568
Ref: 7bc5198568
Ref: library/functools functools partialmethod5199951
Ref: 29a5199951
Ref: library/functools functools reduce5201695
Ref: c625201695
Ref: library/functools functools singledispatch5202902
Ref: 37f5202902
Ref: library/functools functools singledispatchmethod5207105
Ref: 1c75207105
Ref: library/functools functools update_wrapper5208726
Ref: 94e5208726
Ref: library/functools functools wraps5211173
Ref: 85e5211173
Ref: functools — Higher-order functions and operations on callable objects-Footnote-15212471
Ref: functools — Higher-order functions and operations on callable objects-Footnote-25212539
Ref: functools — Higher-order functions and operations on callable objects-Footnote-35212603
Ref: functools — Higher-order functions and operations on callable objects-Footnote-45212658
Ref: functools — Higher-order functions and operations on callable objects-Footnote-55212716
Node: partial Objects5212759
Ref: library/functools id15212882
Ref: 1a815212882
Ref: library/functools partial-objects5212882
Ref: 1a805212882
Ref: library/functools functools partial func5213063
Ref: 1a825213063
Ref: library/functools functools partial args5213252
Ref: 1a835213252
Ref: library/functools functools partial keywords5213424
Ref: 1a845213424
Node: operator — Standard operators as functions5213986
Ref: library/operator doc5214177
Ref: 1a855214177
Ref: library/operator module-operator5214177
Ref: c25214177
Ref: library/operator operator-standard-operators-as-functions5214177
Ref: 1a865214177
Ref: library/operator operator lt5215110
Ref: 1a875215110
Ref: library/operator operator le5215143
Ref: 1a885215143
Ref: library/operator operator eq5215176
Ref: 1a895215176
Ref: library/operator operator ne5215209
Ref: 1a8a5215209
Ref: library/operator operator ge5215242
Ref: 1a8b5215242
Ref: library/operator operator gt5215275
Ref: 1a8c5215275
Ref: library/operator operator __lt__5215308
Ref: 1a8d5215308
Ref: library/operator operator __le__5215345
Ref: 1a8e5215345
Ref: library/operator operator __eq__5215382
Ref: 1a8f5215382
Ref: library/operator operator __ne__5215419
Ref: 1a905215419
Ref: library/operator operator __ge__5215456
Ref: 1a915215456
Ref: library/operator operator __gt__5215493
Ref: 1a925215493
Ref: library/operator operator not_5216233
Ref: 1a935216233
Ref: library/operator operator __not__5216267
Ref: 1a945216267
Ref: library/operator operator truth5216588
Ref: 1a955216588
Ref: library/operator operator is_5216778
Ref: 1a965216778
Ref: library/operator operator is_not5216864
Ref: 1a975216864
Ref: library/operator operator abs5217021
Ref: 1a985217021
Ref: library/operator operator __abs__5217054
Ref: 1a995217054
Ref: library/operator operator add5217134
Ref: 1a9a5217134
Ref: library/operator operator __add__5217168
Ref: 1a9b5217168
Ref: library/operator operator and_5217258
Ref: 1a9c5217258
Ref: library/operator operator __and__5217293
Ref: 1a9d5217293
Ref: library/operator operator floordiv5217377
Ref: 1a9e5217377
Ref: library/operator operator __floordiv__5217416
Ref: 1a9f5217416
Ref: library/operator operator index5217487
Ref: 13bd5217487
Ref: library/operator operator __index__5217520
Ref: 1aa05217520
Ref: library/operator operator inv5217636
Ref: 1aa15217636
Ref: library/operator operator invert5217669
Ref: 1aa25217669
Ref: library/operator operator __inv__5217705
Ref: 1aa35217705
Ref: library/operator operator __invert__5217742
Ref: 1aa45217742
Ref: library/operator operator lshift5217877
Ref: 1aa55217877
Ref: library/operator operator __lshift__5217914
Ref: 1aa65217914
Ref: library/operator operator mod5217994
Ref: 1aa75217994
Ref: library/operator operator __mod__5218028
Ref: 1aa85218028
Ref: library/operator operator mul5218093
Ref: 1a7c5218093
Ref: library/operator operator __mul__5218127
Ref: 1aa95218127
Ref: library/operator operator matmul5218217
Ref: 7115218217
Ref: library/operator operator __matmul__5218254
Ref: 1aaa5218254
Ref: library/operator operator neg5218348
Ref: 1aab5218348
Ref: library/operator operator __neg__5218381
Ref: 1aac5218381
Ref: library/operator operator or_5218460
Ref: 1aad5218460
Ref: library/operator operator __or__5218494
Ref: 1aae5218494
Ref: library/operator operator pos5218576
Ref: 1aaf5218576
Ref: library/operator operator __pos__5218609
Ref: 1ab05218609
Ref: library/operator operator pow5218689
Ref: 1ab15218689
Ref: library/operator operator __pow__5218723
Ref: 1ab25218723
Ref: library/operator operator rshift5218814
Ref: 1ab35218814
Ref: library/operator operator __rshift__5218851
Ref: 1ab45218851
Ref: library/operator operator sub5218932
Ref: 1ab55218932
Ref: library/operator operator __sub__5218966
Ref: 1ab65218966
Ref: library/operator operator truediv5219031
Ref: 1ab75219031
Ref: library/operator operator __truediv__5219069
Ref: 1ab85219069
Ref: library/operator operator xor5219218
Ref: 1ab95219218
Ref: library/operator operator __xor__5219252
Ref: 1aba5219252
Ref: library/operator operator concat5219425
Ref: 1abb5219425
Ref: library/operator operator __concat__5219462
Ref: 1abc5219462
Ref: library/operator operator contains5219556
Ref: 1abd5219556
Ref: library/operator operator __contains__5219595
Ref: 1abe5219595
Ref: library/operator operator countOf5219724
Ref: 1abf5219724
Ref: library/operator operator delitem5219817
Ref: 1ac05219817
Ref: library/operator operator __delitem__5219855
Ref: 1ac15219855
Ref: library/operator operator getitem5219942
Ref: 1ac25219942
Ref: library/operator operator __getitem__5219980
Ref: 1ac35219980
Ref: library/operator operator indexOf5220067
Ref: 1ac45220067
Ref: library/operator operator setitem5220171
Ref: 1ac55220171
Ref: library/operator operator __setitem__5220212
Ref: 1ac65220212
Ref: library/operator operator length_hint5220306
Ref: 8715220306
Ref: library/operator operator attrgetter5220878
Ref: 70f5220878
Ref: library/operator operator itemgetter5222179
Ref: 25f5222179
Ref: library/operator operator methodcaller5224010
Ref: 7105224010
Ref: operator — Standard operators as functions-Footnote-15224809
Node: Mapping Operators to Functions5224876
Ref: library/operator mapping-operators-to-functions5225014
Ref: 1ac75225014
Ref: library/operator operator-map5225014
Ref: 1ac85225014
Node: In-place Operators5232438
Ref: library/operator in-place-operators5232576
Ref: 1ac95232576
Ref: library/operator operator iadd5233884
Ref: 1acb5233884
Ref: library/operator operator __iadd__5233919
Ref: 1acc5233919
Ref: library/operator operator iand5234017
Ref: 1acd5234017
Ref: library/operator operator __iand__5234052
Ref: 1ace5234052
Ref: library/operator operator iconcat5234150
Ref: 1acf5234150
Ref: library/operator operator __iconcat__5234188
Ref: 1ad05234188
Ref: library/operator operator ifloordiv5234323
Ref: 1ad15234323
Ref: library/operator operator __ifloordiv__5234363
Ref: 1ad25234363
Ref: library/operator operator ilshift5234472
Ref: 1ad35234472
Ref: library/operator operator __ilshift__5234510
Ref: 1ad45234510
Ref: library/operator operator imod5234615
Ref: 1ad55234615
Ref: library/operator operator __imod__5234650
Ref: 1ad65234650
Ref: library/operator operator imul5234748
Ref: 1ad75234748
Ref: library/operator operator __imul__5234783
Ref: 1ad85234783
Ref: library/operator operator imatmul5234881
Ref: 7125234881
Ref: library/operator operator __imatmul__5234919
Ref: 1ad95234919
Ref: library/operator operator ior5235049
Ref: 1ada5235049
Ref: library/operator operator __ior__5235083
Ref: 1adb5235083
Ref: library/operator operator ipow5235179
Ref: 1adc5235179
Ref: library/operator operator __ipow__5235214
Ref: 1add5235214
Ref: library/operator operator irshift5235313
Ref: 1ade5235313
Ref: library/operator operator __irshift__5235351
Ref: 1adf5235351
Ref: library/operator operator isub5235456
Ref: 1ae05235456
Ref: library/operator operator __isub__5235491
Ref: 1ae15235491
Ref: library/operator operator itruediv5235589
Ref: 1ae25235589
Ref: library/operator operator __itruediv__5235628
Ref: 1ae35235628
Ref: library/operator operator ixor5235734
Ref: 1ae45235734
Ref: library/operator operator __ixor__5235769
Ref: 1ae55235769
Node: File and Directory Access5235867
Ref: library/filesys doc5236020
Ref: 1ae65236020
Ref: library/filesys file-and-directory-access5236020
Ref: 1ae75236020
Ref: library/filesys filesys5236020
Ref: 1ae85236020
Node: pathlib — Object-oriented filesystem paths5236922
Ref: library/pathlib doc5237078
Ref: 1ae95237078
Ref: library/pathlib module-pathlib5237078
Ref: c85237078
Ref: library/pathlib pathlib-object-oriented-filesystem-paths5237078
Ref: 1aea5237078
Ref: pathlib — Object-oriented filesystem paths-Footnote-15238777
Ref: pathlib — Object-oriented filesystem paths-Footnote-25238843
Node: Basic use5238892
Ref: library/pathlib basic-use5239001
Ref: 1aef5239001
Node: Pure paths5239947
Ref: library/pathlib id15240079
Ref: 1af05240079
Ref: library/pathlib pure-paths5240079
Ref: 1aeb5240079
Ref: library/pathlib pathlib PurePath5240294
Ref: f795240294
Ref: library/pathlib pathlib PurePosixPath5242477
Ref: 1af15242477
Ref: library/pathlib pathlib PureWindowsPath5242769
Ref: 1aee5242769
Node: General properties5243360
Ref: library/pathlib general-properties5243446
Ref: 1af25243446
Node: Operators<2>5244298
Ref: library/pathlib operators5244419
Ref: 1af35244419
Node: Accessing individual parts5245628
Ref: library/pathlib accessing-individual-parts5245753
Ref: 1af45245753
Ref: library/pathlib pathlib PurePath parts5245916
Ref: 1af55245916
Node: Methods and properties5246314
Ref: library/pathlib methods-and-properties5246418
Ref: 1af65246418
Ref: library/pathlib pathlib PurePath drive5246541
Ref: 1af75246541
Ref: library/pathlib pathlib PurePath root5246959
Ref: 1af85246959
Ref: library/pathlib pathlib PurePath anchor5247347
Ref: 1af95247347
Ref: library/pathlib pathlib PurePath parents5247709
Ref: 1afa5247709
Ref: library/pathlib pathlib PurePath parent5248073
Ref: 1afb5248073
Ref: library/pathlib pathlib PurePath name5248892
Ref: 1afd5248892
Ref: library/pathlib pathlib PurePath suffix5249280
Ref: 1afe5249280
Ref: library/pathlib pathlib PurePath suffixes5249573
Ref: 1aff5249573
Ref: library/pathlib pathlib PurePath stem5249883
Ref: 1b005249883
Ref: library/pathlib pathlib PurePath as_posix5250177
Ref: 1b015250177
Ref: library/pathlib pathlib PurePath as_uri5250442
Ref: 1b025250442
Ref: library/pathlib pathlib PurePath is_absolute5250796
Ref: 1b035250796
Ref: library/pathlib pathlib PurePath is_reserved5251388
Ref: 1b045251388
Ref: library/pathlib pathlib PurePath joinpath5251860
Ref: 1b055251860
Ref: library/pathlib pathlib PurePath match5252437
Ref: 1b065252437
Ref: library/pathlib pathlib PurePath relative_to5253278
Ref: 1b075253278
Ref: library/pathlib pathlib PurePath with_name5253940
Ref: 1b085253940
Ref: library/pathlib pathlib PurePath with_suffix5254654
Ref: f685254654
Node: Concrete paths5255324
Ref: library/pathlib concrete-paths5255487
Ref: 1aec5255487
Ref: library/pathlib id25255487
Ref: 1b095255487
Ref: library/pathlib pathlib Path5255759
Ref: 1ff5255759
Ref: library/pathlib pathlib PosixPath5256141
Ref: 1b0a5256141
Ref: library/pathlib pathlib WindowsPath5256450
Ref: 1aed5256450
Node: Methods<2>5257431
Ref: library/pathlib methods5257492
Ref: 1b0b5257492
Ref: library/pathlib pathlib Path cwd5258099
Ref: 1b0c5258099
Ref: library/pathlib pathlib Path home5258314
Ref: 71f5258314
Ref: library/pathlib pathlib Path stat5258587
Ref: 1b0d5258587
Ref: library/pathlib pathlib Path chmod5258892
Ref: 1b0e5258892
Ref: library/pathlib pathlib Path exists5259155
Ref: 2005259155
Ref: library/pathlib pathlib Path expanduser5259627
Ref: 71e5259627
Ref: library/pathlib pathlib Path glob5259948
Ref: 1b0f5259948
Ref: library/pathlib pathlib Path group5260853
Ref: 1b105260853
Ref: library/pathlib pathlib Path is_dir5261027
Ref: 2015261027
Ref: library/pathlib pathlib Path is_file5261368
Ref: 2025261368
Ref: library/pathlib pathlib Path is_mount5261716
Ref: 2035261716
Ref: library/pathlib pathlib Path is_symlink5262220
Ref: 2045262220
Ref: library/pathlib pathlib Path is_socket5262469
Ref: 2085262469
Ref: library/pathlib pathlib Path is_fifo5262817
Ref: 2075262817
Ref: library/pathlib pathlib Path is_block_device5263144
Ref: 2055263144
Ref: library/pathlib pathlib Path is_char_device5263500
Ref: 2065263500
Ref: library/pathlib pathlib Path iterdir5263863
Ref: 1b115263863
Ref: library/pathlib pathlib Path lchmod5264336
Ref: 1b125264336
Ref: library/pathlib pathlib Path lstat5264525
Ref: 1b135264525
Ref: library/pathlib pathlib Path mkdir5264711
Ref: 71d5264711
Ref: library/pathlib pathlib Path open5265778
Ref: 1b145265778
Ref: library/pathlib pathlib Path owner5266131
Ref: 1b155266131
Ref: library/pathlib pathlib Path read_bytes5266304
Ref: 7235266304
Ref: library/pathlib pathlib Path read_text5266613
Ref: 7215266613
Ref: library/pathlib pathlib Path rename5267046
Ref: 1b165267046
Ref: library/pathlib pathlib Path replace5267693
Ref: 1b175267693
Ref: library/pathlib pathlib Path resolve5268026
Ref: 1afc5268026
Ref: library/pathlib pathlib Path rglob5268958
Ref: 1b185268958
Ref: library/pathlib pathlib Path rmdir5269357
Ref: 1b195269357
Ref: library/pathlib pathlib Path samefile5269443
Ref: 71c5269443
Ref: library/pathlib pathlib Path symlink_to5269994
Ref: 1b1a5269994
Ref: library/pathlib pathlib Path touch5270649
Ref: 1b1b5270649
Ref: library/pathlib pathlib Path unlink5271067
Ref: f005271067
Ref: library/pathlib pathlib Path link_to5271562
Ref: 2095271562
Ref: library/pathlib pathlib Path write_bytes5271687
Ref: 7225271687
Ref: library/pathlib pathlib Path write_text5272068
Ref: 7205272068
Node: Correspondence to tools in the os module5272542
Ref: library/pathlib correspondence-to-tools-in-the-os-module5272686
Ref: 1b1c5272686
Node: os path — Common pathname manipulations5276527
Ref: library/os path doc5276752
Ref: 1b225276752
Ref: library/os path module-os path5276752
Ref: c55276752
Ref: library/os path os-path-common-pathname-manipulations5276752
Ref: 1b235276752
Ref: library/os path os path abspath5279148
Ref: ca35279148
Ref: library/os path os path basename5279474
Ref: 1b1f5279474
Ref: library/os path os path commonpath5279985
Ref: 7195279985
Ref: library/os path os path commonprefix5280504
Ref: 71a5280504
Ref: library/os path os path dirname5281152
Ref: 1b205281152
Ref: library/os path os path exists5281424
Ref: 1f45281424
Ref: library/os path os path lexists5282012
Ref: 1f55282012
Ref: library/os path os path expanduser5282318
Ref: 1fc5282318
Ref: library/os path os path expandvars5283341
Ref: d375283341
Ref: library/os path os path getatime5283833
Ref: 1b255283833
Ref: library/os path os path getmtime5284134
Ref: 1b265284134
Ref: library/os path os path getctime5284510
Ref: 1b275284510
Ref: library/os path os path getsize5285001
Ref: 1b285285001
Ref: library/os path os path isabs5285231
Ref: 1b1e5285231
Ref: library/os path os path isfile5285540
Ref: 1f75285540
Ref: library/os path os path isdir5285845
Ref: 1f65285845
Ref: library/os path os path islink5286146
Ref: 1f25286146
Ref: library/os path os path ismount5286450
Ref: 1f85286450
Ref: library/os path os path join5287338
Ref: e8c5287338
Ref: library/os path os path normcase5288409
Ref: 1b295288409
Ref: library/os path os path normpath5288748
Ref: ca25288748
Ref: library/os path os path realpath5289253
Ref: 1fd5289253
Ref: library/os path os path relpath5289806
Ref: 1b1d5289806
Ref: library/os path os path samefile5290275
Ref: 8765290275
Ref: library/os path os path sameopenfile5290837
Ref: 1b2b5290837
Ref: library/os path os path samestat5291147
Ref: 8755291147
Ref: library/os path os path split5291700
Ref: 1b245291700
Ref: library/os path os path splitdrive5292489
Ref: 4725292489
Ref: library/os path os path splitext5293386
Ref: 1b215293386
Ref: library/os path os path supports_unicode_filenames5293784
Ref: de05293784
Ref: os path — Common pathname manipulations-Footnote-15293992
Ref: os path — Common pathname manipulations-Footnote-25294060
Node: fileinput — Iterate over lines from multiple input streams5294125
Ref: library/fileinput doc5294340
Ref: 1b2c5294340
Ref: library/fileinput fileinput-iterate-over-lines-from-multiple-input-streams5294340
Ref: 1b2d5294340
Ref: library/fileinput module-fileinput5294340
Ref: 805294340
Ref: library/fileinput fileinput input5296504
Ref: 2ab5296504
Ref: library/fileinput fileinput filename5297606
Ref: 1b2e5297606
Ref: library/fileinput fileinput fileno5297762
Ref: 1b2f5297762
Ref: library/fileinput fileinput lineno5297961
Ref: 1b305297961
Ref: library/fileinput fileinput filelineno5298234
Ref: 1b315298234
Ref: library/fileinput fileinput isfirstline5298500
Ref: 1b325298500
Ref: library/fileinput fileinput isstdin5298652
Ref: 1b335298652
Ref: library/fileinput fileinput nextfile5298795
Ref: 1b345298795
Ref: library/fileinput fileinput close5299335
Ref: 1b355299335
Ref: library/fileinput fileinput FileInput5299506
Ref: 27d5299506
Ref: library/fileinput fileinput hook_compressed5302120
Ref: 1b375302120
Ref: library/fileinput fileinput hook_encoded5302617
Ref: 53f5302617
Ref: fileinput — Iterate over lines from multiple input streams-Footnote-15303037
Node: stat — Interpreting stat results5303105
Ref: library/stat doc5303321
Ref: 1b385303321
Ref: library/stat module-stat5303321
Ref: f45303321
Ref: library/stat stat-interpreting-stat-results5303321
Ref: 1b395303321
Ref: library/stat stat S_ISDIR5303999
Ref: 1b3a5303999
Ref: library/stat stat S_ISCHR5304089
Ref: 1b3b5304089
Ref: library/stat stat S_ISBLK5304204
Ref: 1b3c5304204
Ref: library/stat stat S_ISREG5304310
Ref: 1b3d5304310
Ref: library/stat stat S_ISFIFO5304403
Ref: 1b3e5304403
Ref: library/stat stat S_ISLNK5304502
Ref: 1b3f5304502
Ref: library/stat stat S_ISSOCK5304596
Ref: 1b405304596
Ref: library/stat stat S_ISDOOR5304684
Ref: e9b5304684
Ref: library/stat stat S_ISPORT5304796
Ref: e9c5304796
Ref: library/stat stat S_ISWHT5304915
Ref: e9d5304915
Ref: library/stat stat S_IMODE5305120
Ref: 1b415305120
Ref: library/stat stat S_IFMT5305387
Ref: 1b425305387
Ref: library/stat stat filemode5306917
Ref: a925306917
Ref: library/stat stat ST_MODE5307328
Ref: 8c75307328
Ref: library/stat stat ST_INO5307381
Ref: 1b435307381
Ref: library/stat stat ST_DEV5307424
Ref: 1b445307424
Ref: library/stat stat ST_NLINK5307478
Ref: 1b455307478
Ref: library/stat stat ST_UID5307539
Ref: 1b465307539
Ref: library/stat stat ST_GID5307590
Ref: 1b475307590
Ref: library/stat stat ST_SIZE5307642
Ref: 1b485307642
Ref: library/stat stat ST_ATIME5307754
Ref: 1b495307754
Ref: library/stat stat ST_MTIME5307806
Ref: 1b4a5307806
Ref: library/stat stat ST_CTIME5307864
Ref: 1b4b5307864
Ref: library/stat stat S_IFSOCK5308906
Ref: 1b4c5308906
Ref: library/stat stat S_IFLNK5308945
Ref: 1b4d5308945
Ref: library/stat stat S_IFREG5308990
Ref: 1b4e5308990
Ref: library/stat stat S_IFBLK5309034
Ref: 1b4f5309034
Ref: library/stat stat S_IFDIR5309078
Ref: 1b505309078
Ref: library/stat stat S_IFCHR5309119
Ref: 1b515309119
Ref: library/stat stat S_IFIFO5309167
Ref: 1b525309167
Ref: library/stat stat S_IFDOOR5309203
Ref: 8c85309203
Ref: library/stat stat S_IFPORT5309266
Ref: 8c95309266
Ref: library/stat stat S_IFWHT5309335
Ref: 8ca5309335
Ref: library/stat stat S_ISUID5309653
Ref: 1b535309653
Ref: library/stat stat S_ISGID5309696
Ref: 1b545309696
Ref: library/stat stat S_ISVTX5310273
Ref: 1b575310273
Ref: library/stat stat S_IRWXU5310522
Ref: 1b585310522
Ref: library/stat stat S_IRUSR5310585
Ref: 1b595310585
Ref: library/stat stat S_IWUSR5310642
Ref: 1b5a5310642
Ref: library/stat stat S_IXUSR5310700
Ref: 1b5b5310700
Ref: library/stat stat S_IRWXG5310760
Ref: 1b5c5310760
Ref: library/stat stat S_IRGRP5310818
Ref: 1b5d5310818
Ref: library/stat stat S_IWGRP5310875
Ref: 1b5e5310875
Ref: library/stat stat S_IXGRP5310933
Ref: 1b555310933
Ref: library/stat stat S_IRWXO5310993
Ref: 1b5f5310993
Ref: library/stat stat S_IROTH5311071
Ref: 1b605311071
Ref: library/stat stat S_IWOTH5311130
Ref: 1b615311130
Ref: library/stat stat S_IXOTH5311190
Ref: 1b625311190
Ref: library/stat stat S_ENFMT5311252
Ref: 1b565311252
Ref: library/stat stat S_IREAD5311485
Ref: 1b635311485
Ref: library/stat stat S_IWRITE5311556
Ref: 1b645311556
Ref: library/stat stat S_IEXEC5311628
Ref: 1b655311628
Ref: library/stat stat UF_NODUMP5311785
Ref: 1b665311785
Ref: library/stat stat UF_IMMUTABLE5311839
Ref: 1b675311839
Ref: library/stat stat UF_APPEND5311903
Ref: 1b685311903
Ref: library/stat stat UF_OPAQUE5311969
Ref: 1b695311969
Ref: library/stat stat UF_NOUNLINK5312060
Ref: 1b6a5312060
Ref: library/stat stat UF_COMPRESSED5312134
Ref: 1b6b5312134
Ref: library/stat stat UF_HIDDEN5312218
Ref: 1b6c5312218
Ref: library/stat stat SF_ARCHIVED5312310
Ref: 1b6d5312310
Ref: library/stat stat SF_IMMUTABLE5312370
Ref: 1b6e5312370
Ref: library/stat stat SF_APPEND5312434
Ref: 1b6f5312434
Ref: library/stat stat SF_NOUNLINK5312500
Ref: 1b705312500
Ref: library/stat stat SF_SNAPSHOT5312574
Ref: 1b715312574
Ref: library/stat stat FILE_ATTRIBUTE_ARCHIVE5312971
Ref: 1b725312971
Ref: library/stat stat FILE_ATTRIBUTE_COMPRESSED5313009
Ref: 1b735313009
Ref: library/stat stat FILE_ATTRIBUTE_DEVICE5313050
Ref: 1b745313050
Ref: library/stat stat FILE_ATTRIBUTE_DIRECTORY5313087
Ref: 1b755313087
Ref: library/stat stat FILE_ATTRIBUTE_ENCRYPTED5313127
Ref: 1b765313127
Ref: library/stat stat FILE_ATTRIBUTE_HIDDEN5313167
Ref: 1b775313167
Ref: library/stat stat FILE_ATTRIBUTE_INTEGRITY_STREAM5313204
Ref: 1b785313204
Ref: library/stat stat FILE_ATTRIBUTE_NORMAL5313251
Ref: 1b795313251
Ref: library/stat stat FILE_ATTRIBUTE_NOT_CONTENT_INDEXED5313288
Ref: 1b7a5313288
Ref: library/stat stat FILE_ATTRIBUTE_NO_SCRUB_DATA5313338
Ref: 1b7b5313338
Ref: library/stat stat FILE_ATTRIBUTE_OFFLINE5313382
Ref: 1b7c5313382
Ref: library/stat stat FILE_ATTRIBUTE_READONLY5313420
Ref: 1b7d5313420
Ref: library/stat stat FILE_ATTRIBUTE_REPARSE_POINT5313459
Ref: 1b7e5313459
Ref: library/stat stat FILE_ATTRIBUTE_SPARSE_FILE5313503
Ref: 1b7f5313503
Ref: library/stat stat FILE_ATTRIBUTE_SYSTEM5313545
Ref: 1b805313545
Ref: library/stat stat FILE_ATTRIBUTE_TEMPORARY5313582
Ref: 1b815313582
Ref: library/stat stat FILE_ATTRIBUTE_VIRTUAL5313622
Ref: 1b825313622
Ref: library/stat stat IO_REPARSE_TAG_SYMLINK5313892
Ref: 1b835313892
Ref: library/stat stat IO_REPARSE_TAG_MOUNT_POINT5313930
Ref: 1b845313930
Ref: library/stat stat IO_REPARSE_TAG_APPEXECLINK5313972
Ref: 1b855313972
Ref: stat — Interpreting stat results-Footnote-15314077
Ref: stat — Interpreting stat results-Footnote-25314140
Node: filecmp — File and Directory Comparisons5314220
Ref: library/filecmp doc5314429
Ref: 1b865314429
Ref: library/filecmp filecmp-file-and-directory-comparisons5314429
Ref: 1b875314429
Ref: library/filecmp module-filecmp5314429
Ref: 7f5314429
Ref: library/filecmp filecmp cmp5314898
Ref: 1b885314898
Ref: library/filecmp filecmp cmpfiles5315585
Ref: 1b895315585
Ref: library/filecmp filecmp clear_cache5316530
Ref: 83b5316530
Ref: filecmp — File and Directory Comparisons-Footnote-15316845
Node: The dircmp class5316911
Ref: library/filecmp dircmp-objects5317006
Ref: 1b8a5317006
Ref: library/filecmp the-dircmp-class5317006
Ref: 1b8b5317006
Ref: library/filecmp filecmp dircmp5317067
Ref: 83d5317067
Ref: library/filecmp filecmp dircmp report5317602
Ref: 1b8c5317602
Ref: library/filecmp filecmp dircmp report_partial_closure5317719
Ref: 1b8d5317719
Ref: library/filecmp filecmp dircmp report_full_closure5317860
Ref: 1b8e5317860
Ref: library/filecmp filecmp dircmp left5318379
Ref: 1b8f5318379
Ref: library/filecmp filecmp dircmp right5318435
Ref: 1b905318435
Ref: library/filecmp filecmp dircmp left_list5318492
Ref: 1b915318492
Ref: library/filecmp filecmp dircmp right_list5318610
Ref: 1b925318610
Ref: library/filecmp filecmp dircmp common5318729
Ref: 1b935318729
Ref: library/filecmp filecmp dircmp left_only5318814
Ref: 1b945318814
Ref: library/filecmp filecmp dircmp right_only5318894
Ref: 1b955318894
Ref: library/filecmp filecmp dircmp common_dirs5318975
Ref: 1b965318975
Ref: library/filecmp filecmp dircmp common_files5319055
Ref: 1b975319055
Ref: library/filecmp filecmp dircmp common_funny5319127
Ref: 1b985319127
Ref: library/filecmp filecmp dircmp same_files5319330
Ref: 1b995319330
Ref: library/filecmp filecmp dircmp diff_files5319476
Ref: 1b9a5319476
Ref: library/filecmp filecmp dircmp funny_files5319641
Ref: 1b9b5319641
Ref: library/filecmp filecmp dircmp subdirs5319759
Ref: 1b9c5319759
Ref: library/filecmp filecmp DEFAULT_IGNORES5319895
Ref: 83c5319895
Node: tempfile — Generate temporary files and directories5320579
Ref: library/tempfile doc5320800
Ref: 1b9d5320800
Ref: library/tempfile module-tempfile5320800
Ref: 1035320800
Ref: library/tempfile tempfile-generate-temporary-files-and-directories5320800
Ref: 1b9e5320800
Ref: library/tempfile tempfile TemporaryFile5321955
Ref: 1b9f5321955
Ref: library/tempfile tempfile NamedTemporaryFile5324011
Ref: d3c5324011
Ref: library/tempfile tempfile SpooledTemporaryFile5325183
Ref: a9b5325183
Ref: library/tempfile tempfile TemporaryDirectory5326416
Ref: bbb5326416
Ref: library/tempfile tempfile mkstemp5327401
Ref: 1ba05327401
Ref: library/tempfile tempfile mkdtemp5330314
Ref: 1ba15330314
Ref: library/tempfile tempfile gettempdir5331429
Ref: 1ba75331429
Ref: library/tempfile tempfile gettempdirb5332438
Ref: 1ba95332438
Ref: library/tempfile tempfile gettempprefix5332577
Ref: 1ba55332577
Ref: library/tempfile tempfile gettempprefixb5332736
Ref: 1ba65332736
Ref: library/tempfile tempfile tempdir5333236
Ref: 1ba85333236
Ref: tempfile — Generate temporary files and directories-Footnote-15333762
Node: Examples<3>5333829
Ref: library/tempfile examples5333973
Ref: 1baa5333973
Ref: library/tempfile tempfile-examples5333973
Ref: 1ba35333973
Node: Deprecated functions and variables5334891
Ref: library/tempfile deprecated-functions-and-variables5335035
Ref: 1bab5335035
Ref: library/tempfile tempfile mktemp5335665
Ref: 1bac5335665
Node: glob — Unix style pathname pattern expansion5336798
Ref: library/glob doc5337019
Ref: 1bad5337019
Ref: library/glob glob-unix-style-pathname-pattern-expansion5337019
Ref: 1bae5337019
Ref: library/glob module-glob5337019
Ref: 8a5337019
Ref: library/glob glob glob5338132
Ref: 5bb5338132
Ref: library/glob glob iglob5339239
Ref: 5bc5339239
Ref: library/glob glob escape5339551
Ref: 8445339551
Ref: glob — Unix style pathname pattern expansion-Footnote-15341005
Node: fnmatch — Unix filename pattern matching5341068
Ref: library/fnmatch doc5341277
Ref: 1bb25341277
Ref: library/fnmatch fnmatch-unix-filename-pattern-matching5341277
Ref: 1bb35341277
Ref: library/fnmatch module-fnmatch5341277
Ref: 815341277
Ref: library/fnmatch fnmatch fnmatch5342612
Ref: 1baf5342612
Ref: library/fnmatch fnmatch fnmatchcase5343299
Ref: 1bb55343299
Ref: library/fnmatch fnmatch filter5343546
Ref: 1bb45343546
Ref: library/fnmatch fnmatch translate5343774
Ref: f755343774
Ref: fnmatch — Unix filename pattern matching-Footnote-15344354
Node: linecache — Random access to text lines5344420
Ref: library/linecache doc5344620
Ref: 1bb65344620
Ref: library/linecache linecache-random-access-to-text-lines5344620
Ref: 1bb75344620
Ref: library/linecache module-linecache5344620
Ref: a85344620
Ref: library/linecache linecache getline5345450
Ref: 6fd5345450
Ref: library/linecache linecache clearcache5346219
Ref: 1bba5346219
Ref: library/linecache linecache checkcache5346388
Ref: 1bbb5346388
Ref: library/linecache linecache lazycache5346666
Ref: 6fc5346666
Ref: linecache — Random access to text lines-Footnote-15347213
Ref: linecache — Random access to text lines-Footnote-25347281
Node: shutil — High-level file operations5347330
Ref: library/shutil doc5347479
Ref: 1bbc5347479
Ref: library/shutil module-shutil5347479
Ref: e95347479
Ref: library/shutil shutil-high-level-file-operations5347479
Ref: 1bbd5347479
Ref: shutil — High-level file operations-Footnote-15348582
Node: Directory and files operations5348647
Ref: library/shutil directory-and-files-operations5348780
Ref: 1bbe5348780
Ref: library/shutil file-operations5348780
Ref: 1bbf5348780
Ref: library/shutil shutil copyfileobj5348863
Ref: 25b5348863
Ref: library/shutil shutil copyfile5349446
Ref: 2565349446
Ref: library/shutil shutil SameFileError5350939
Ref: 8a75350939
Ref: library/shutil shutil copymode5351109
Ref: 1bc05351109
Ref: library/shutil shutil copystat5351896
Ref: a6c5351896
Ref: library/shutil shutil copy5353895
Ref: 2575353895
Ref: library/shutil shutil copy25355073
Ref: 2585355073
Ref: library/shutil shutil ignore_patterns5356372
Ref: 1bc25356372
Ref: library/shutil shutil copytree5356674
Ref: 2185356674
Ref: library/shutil shutil rmtree5359825
Ref: 21a5359825
Ref: library/shutil shutil rmtree avoids_symlink_attacks5361750
Ref: 1bc35361750
Ref: library/shutil shutil move5362090
Ref: 2595362090
Ref: library/shutil shutil disk_usage5363826
Ref: a6a5363826
Ref: library/shutil shutil chown5364274
Ref: a6b5364274
Ref: library/shutil shutil which5364641
Ref: f0e5364641
Ref: library/shutil shutil Error5365966
Ref: 8a65365966
Node: Platform-dependent efficient copy operations5366302
Ref: library/shutil platform-dependent-efficient-copy-operations5366438
Ref: 1bc45366438
Ref: library/shutil shutil-platform-dependent-efficient-copy-operations5366438
Ref: 25c5366438
Ref: Platform-dependent efficient copy operations-Footnote-15367559
Ref: Platform-dependent efficient copy operations-Footnote-25367602
Node: copytree example5367650
Ref: library/shutil copytree-example5367809
Ref: 1bc55367809
Ref: library/shutil shutil-copytree-example5367809
Ref: 1bc65367809
Node: rmtree example5369887
Ref: library/shutil rmtree-example5369993
Ref: 1bc75369993
Ref: library/shutil shutil-rmtree-example5369993
Ref: 1bc85369993
Node: Archiving operations5370540
Ref: library/shutil archiving-operations5370722
Ref: b895370722
Ref: library/shutil id15370722
Ref: 1bc95370722
Ref: library/shutil shutil make_archive5371030
Ref: 2195371030
Ref: library/shutil shutil get_archive_formats5372790
Ref: 1bca5372790
Ref: library/shutil shutil register_archive_format5373632
Ref: 1bcb5373632
Ref: library/shutil shutil unregister_archive_format5374478
Ref: 1bcc5374478
Ref: library/shutil shutil unpack_archive5374613
Ref: b8a5374613
Ref: library/shutil shutil register_unpack_format5375433
Ref: 1bcd5375433
Ref: library/shutil shutil unregister_unpack_format5376196
Ref: 1bcf5376196
Ref: library/shutil shutil get_unpack_formats5376320
Ref: 1bce5376320
Ref: Archiving operations-Footnote-15377237
Node: Archiving example5377286
Ref: library/shutil archiving-example5377360
Ref: 1bd05377360
Ref: library/shutil shutil-archiving-example5377360
Ref: 1bd15377360
Node: Querying the size of the output terminal5378453
Ref: library/shutil querying-the-size-of-the-output-terminal5378596
Ref: 1bd25378596
Ref: library/shutil shutil get_terminal_size5378699
Ref: a3f5378699
Ref: Querying the size of the output terminal-Footnote-15380226
Node: Data Persistence5380308
Ref: library/persistence doc5380461
Ref: 1bd55380461
Ref: library/persistence data-persistence5380461
Ref: 1bd65380461
Ref: library/persistence other-environment-variables5380461
Ref: 1bd75380461
Ref: library/persistence persistence5380461
Ref: 1bd85380461
Node: pickle — Python object serialization5381292
Ref: library/pickle doc5381437
Ref: 1bd95381437
Ref: library/pickle module-pickle5381437
Ref: ca5381437
Ref: library/pickle pickle-python-object-serialization5381437
Ref: 1bda5381437
Ref: pickle — Python object serialization-Footnote-15383272
Ref: pickle — Python object serialization-Footnote-25383337
Node: Relationship to other Python modules5383405
Ref: library/pickle relationship-to-other-python-modules5383543
Ref: 1bdd5383543
Node: Comparison with marshal5383699
Ref: library/pickle comparison-with-marshal5383824
Ref: 1bde5383824
Node: Comparison with json5386052
Ref: library/pickle comparison-with-json5386177
Ref: 1bdc5386177
Ref: library/pickle id25386177
Ref: 1bdf5386177
Ref: Comparison with json-Footnote-15387342
Node: Data stream format5387366
Ref: library/pickle data-stream-format5387529
Ref: 1be15387529
Ref: library/pickle pickle-protocols5387529
Ref: 5635387529
Ref: Data stream format-Footnote-15390499
Ref: Data stream format-Footnote-25390548
Ref: Data stream format-Footnote-35390597
Node: Module Interface5390646
Ref: library/pickle module-interface5390807
Ref: 1be45390807
Ref: library/pickle pickle HIGHEST_PROTOCOL5391259
Ref: df35391259
Ref: library/pickle pickle DEFAULT_PROTOCOL5391531
Ref: 1be75391531
Ref: library/pickle pickle dump5392039
Ref: 1be65392039
Ref: library/pickle pickle dumps5392537
Ref: df25392537
Ref: library/pickle pickle load5392974
Ref: 5b75392974
Ref: library/pickle pickle loads5393722
Ref: 5b85393722
Ref: library/pickle pickle PickleError5394418
Ref: 1be85394418
Ref: library/pickle pickle PicklingError5394552
Ref: 1be95394552
Ref: library/pickle pickle UnpicklingError5394831
Ref: 1beb5394831
Ref: library/pickle pickle Pickler5395340
Ref: 20b5395340
Ref: library/pickle pickle Pickler dump5396894
Ref: f745396894
Ref: library/pickle pickle Pickler persistent_id5397036
Ref: 1bee5397036
Ref: library/pickle pickle Pickler dispatch_table5397712
Ref: a5e5397712
Ref: library/pickle pickle Pickler reducer_override5398876
Ref: 20c5398876
Ref: library/pickle pickle Pickler fast5399491
Ref: 1bf45399491
Ref: library/pickle pickle Unpickler5399976
Ref: 1be55399976
Ref: library/pickle pickle Unpickler load5402080
Ref: 1bf65402080
Ref: library/pickle pickle Unpickler persistent_load5402375
Ref: 1bef5402375
Ref: library/pickle pickle Unpickler find_class5402822
Ref: 1bf75402822
Ref: library/pickle pickle PickleBuffer5403502
Ref: 1bec5403502
Ref: library/pickle pickle PickleBuffer raw5404120
Ref: 1bf95404120
Ref: library/pickle pickle PickleBuffer release5404463
Ref: 1bfa5404463
Node: What can be pickled and unpickled?5404579
Ref: library/pickle pickle-picklable5404746
Ref: 1bea5404746
Ref: library/pickle what-can-be-pickled-and-unpickled5404746
Ref: 1bfb5404746
Ref: What can be pickled and unpickled?-Footnote-15407474
Ref: What can be pickled and unpickled?-Footnote-25407610
Node: Pickling Class Instances5407750
Ref: library/pickle pickle-inst5407955
Ref: 1be05407955
Ref: library/pickle pickling-class-instances5407955
Ref: 1bfc5407955
Ref: library/pickle object __getnewargs_ex__5408887
Ref: 1bfd5408887
Ref: library/pickle object __getnewargs__5409719
Ref: 6a25409719
Ref: library/pickle object __getstate__5410285
Ref: df45410285
Ref: library/pickle object __setstate__5410724
Ref: 19b5410724
Ref: library/pickle object __reduce__5412626
Ref: 19a5412626
Ref: library/pickle object __reduce_ex__5415491
Ref: 19315415491
Ref: Pickling Class Instances-Footnote-15416152
Node: Persistence of External Objects5416251
Ref: library/pickle persistence-of-external-objects5416367
Ref: 1bff5416367
Ref: library/pickle pickle-persistent5416367
Ref: 1bf05416367
Ref: Persistence of External Objects-Footnote-15421035
Node: Dispatch Tables5421299
Ref: library/pickle dispatch-tables5421449
Ref: 1c005421449
Ref: library/pickle pickle-dispatch5421449
Ref: 1bf25421449
Node: Handling Stateful Objects5422676
Ref: library/pickle handling-stateful-objects5422786
Ref: 1c015422786
Ref: library/pickle pickle-state5422786
Ref: 1bfe5422786
Node: Custom Reduction for Types Functions and Other Objects5425073
Ref: library/pickle custom-reduction-for-types-functions-and-other-objects5425263
Ref: 1c025425263
Ref: library/pickle reducer-override5425263
Ref: 1bf35425263
Node: Out-of-band Buffers5427355
Ref: library/pickle out-of-band-buffers5427540
Ref: 1c035427540
Ref: library/pickle pickle-oob5427540
Ref: 1bed5427540
Node: Provider API5428388
Ref: library/pickle provider-api5428477
Ref: 1c045428477
Node: Consumer API5429084
Ref: library/pickle consumer-api5429192
Ref: 1c055429192
Node: Example<4>5430494
Ref: library/pickle example5430581
Ref: 1c065430581
Ref: Example<4>-Footnote-15432965
Node: Restricting Globals5433014
Ref: library/pickle pickle-restrict5433159
Ref: 1bf85433159
Ref: library/pickle restricting-globals5433159
Ref: 1c075433159
Node: Performance<2>5435935
Ref: library/pickle performance5436072
Ref: 1c085436072
Node: Examples<4>5436348
Ref: library/pickle examples5436457
Ref: 1c095436457
Ref: library/pickle pickle-example5436457
Ref: 1c0a5436457
Node: copyreg — Register pickle support functions5437675
Ref: library/copyreg doc5437865
Ref: 1c0b5437865
Ref: library/copyreg copyreg-register-pickle-support-functions5437865
Ref: 1c0c5437865
Ref: library/copyreg module-copyreg5437865
Ref: 275437865
Ref: library/copyreg copyreg constructor5438457
Ref: 1c0d5438457
Ref: library/copyreg copyreg pickle5438660
Ref: 1bf15438660
Ref: copyreg — Register pickle support functions-Footnote-15439613
Node: Example<5>5439679
Ref: library/copyreg example5439771
Ref: 1c0e5439771
Node: shelve — Python object persistence5440359
Ref: library/shelve doc5440559
Ref: 1c0f5440559
Ref: library/shelve module-shelve5440559
Ref: e75440559
Ref: library/shelve shelve-python-object-persistence5440559
Ref: 1c105440559
Ref: library/shelve shelve open5441144
Ref: 1c115441144
Ref: library/shelve shelve Shelf sync5443360
Ref: 1c135443360
Ref: library/shelve shelve Shelf close5443681
Ref: 1c145443681
Ref: shelve — Python object persistence-Footnote-15444063
Ref: shelve — Python object persistence-Footnote-25444128
Node: Restrictions5444181
Ref: library/shelve restrictions5444285
Ref: 1c155444285
Ref: library/shelve shelve Shelf5445310
Ref: 8a45445310
Ref: library/shelve shelve BsdDbShelf5446546
Ref: 1c165446546
Ref: library/shelve shelve DbfilenameShelf5447252
Ref: 1c175447252
Ref: Restrictions-Footnote-15447867
Node: Example<6>5447920
Ref: library/shelve example5448024
Ref: 1c185448024
Ref: library/shelve shelve-example5448024
Ref: 1c125448024
Node: marshal — Internal Python object serialization5449703
Ref: library/marshal doc5449900
Ref: 1c195449900
Ref: library/marshal marshal-internal-python-object-serialization5449900
Ref: 1c1a5449900
Ref: library/marshal module-marshal5449900
Ref: b05449900
Ref: library/marshal marshal dump5452307
Ref: 1c1b5452307
Ref: library/marshal marshal load5452854
Ref: f245452854
Ref: library/marshal marshal dumps5453405
Ref: 7905453405
Ref: library/marshal marshal loads5453805
Ref: 1c1c5453805
Ref: library/marshal marshal version5454106
Ref: 1c1d5454106
Ref: marshal — Internal Python object serialization-Footnote-15454460
Node: dbm — Interfaces to Unix “databases”5454844
Ref: library/dbm doc5455058
Ref: 1c1e5455058
Ref: library/dbm dbm-interfaces-to-unix-databases5455058
Ref: 1c1f5455058
Ref: library/dbm module-dbm5455058
Ref: 325455058
Ref: library/dbm dbm error5455568
Ref: 1c205455568
Ref: library/dbm dbm whichdb5455840
Ref: 1c215455840
Ref: library/dbm dbm open5456403
Ref: 8245456403
Ref: dbm — Interfaces to Unix “databases”-Footnote-15460046
Ref: dbm — Interfaces to Unix “databases”-Footnote-25460117
Node: dbm gnu — GNU’s reinterpretation of dbm5460170
Ref: library/dbm dbm-gnu-gnu-s-reinterpretation-of-dbm5460337
Ref: 1c225460337
Ref: library/dbm module-dbm gnu5460337
Ref: 345460337
Ref: library/dbm dbm gnu error5461153
Ref: 2c35461153
Ref: library/dbm dbm gnu open5461357
Ref: f695461357
Ref: library/dbm dbm gnu gdbm firstkey5463435
Ref: 1c235463435
Ref: library/dbm dbm gnu gdbm nextkey5463779
Ref: 1c245463779
Ref: library/dbm dbm gnu gdbm reorganize5464160
Ref: 1c255464160
Ref: library/dbm dbm gnu gdbm sync5464603
Ref: 1c265464603
Ref: library/dbm dbm gnu gdbm close5464768
Ref: 1c275464768
Ref: dbm gnu — GNU’s reinterpretation of dbm-Footnote-15464878
Node: dbm ndbm — Interface based on ndbm5464944
Ref: library/dbm dbm-ndbm-interface-based-on-ndbm5465160
Ref: 1c285465160
Ref: library/dbm module-dbm ndbm5465160
Ref: 355465160
Ref: library/dbm dbm ndbm error5465916
Ref: 2c45465916
Ref: library/dbm dbm ndbm library5466122
Ref: 1c295466122
Ref: library/dbm dbm ndbm open5466208
Ref: f6a5466208
Ref: library/dbm dbm ndbm ndbm close5467493
Ref: 1c2a5467493
Ref: dbm ndbm — Interface based on ndbm-Footnote-15467603
Node: dbm dumb — Portable DBM implementation5467670
Ref: library/dbm dbm-dumb-portable-dbm-implementation5467834
Ref: 1c2b5467834
Ref: library/dbm module-dbm dumb5467834
Ref: 335467834
Ref: library/dbm dbm dumb error5468659
Ref: 2c25468659
Ref: library/dbm dbm dumb open5468865
Ref: 2bd5468865
Ref: library/dbm dbm dumb dumbdbm sync5470810
Ref: 1c2c5470810
Ref: library/dbm dbm dumb dumbdbm close5470973
Ref: 1c2d5470973
Ref: dbm dumb — Portable DBM implementation-Footnote-15471089
Node: sqlite3 — DB-API 2 0 interface for SQLite databases5471156
Ref: library/sqlite3 doc5471313
Ref: 1c2e5471313
Ref: library/sqlite3 module-sqlite35471313
Ref: f25471313
Ref: library/sqlite3 sqlite3-db-api-2-0-interface-for-sqlite-databases5471313
Ref: 1c2f5471313
Ref: sqlite3 — DB-API 2 0 interface for SQLite databases-Footnote-15475808
Ref: sqlite3 — DB-API 2 0 interface for SQLite databases-Footnote-25475872
Ref: sqlite3 — DB-API 2 0 interface for SQLite databases-Footnote-35475921
Node: Module functions and constants5475970
Ref: library/sqlite3 module-functions-and-constants5476117
Ref: 1c345476117
Ref: library/sqlite3 sqlite3-module-contents5476117
Ref: 1c355476117
Ref: library/sqlite3 sqlite3 version5476198
Ref: 1c365476198
Ref: library/sqlite3 sqlite3 version_info5476332
Ref: 1c375476332
Ref: library/sqlite3 sqlite3 sqlite_version5476482
Ref: 1c385476482
Ref: library/sqlite3 sqlite3 sqlite_version_info5476586
Ref: 1c395476586
Ref: library/sqlite3 sqlite3 PARSE_DECLTYPES5476711
Ref: 1c3a5476711
Ref: library/sqlite3 sqlite3 PARSE_COLNAMES5477313
Ref: 1c3b5477313
Ref: library/sqlite3 sqlite3 connect5478155
Ref: 3cf5478155
Ref: library/sqlite3 sqlite3 register_converter5481560
Ref: 1c3e5481560
Ref: library/sqlite3 sqlite3 register_adapter5482041
Ref: 1c405482041
Ref: library/sqlite3 sqlite3 complete_statement5482366
Ref: 1c415482366
Ref: library/sqlite3 sqlite3 enable_callback_tracebacks5483700
Ref: 1c425483700
Ref: Module functions and constants-Footnote-15484151
Node: Connection Objects5484191
Ref: library/sqlite3 connection-objects5484361
Ref: 1c435484361
Ref: library/sqlite3 sqlite3-connection-objects5484361
Ref: 1c445484361
Ref: library/sqlite3 sqlite3 Connection5484418
Ref: 3cd5484418
Ref: library/sqlite3 sqlite3 Connection isolation_level5484531
Ref: 1c3d5484531
Ref: library/sqlite3 sqlite3 Connection in_transaction5484841
Ref: 1c465484841
Ref: library/sqlite3 sqlite3 Connection cursor5485067
Ref: 1c475485067
Ref: library/sqlite3 sqlite3 Connection commit5485307
Ref: 1c485485307
Ref: library/sqlite3 sqlite3 Connection rollback5485700
Ref: 1c495485700
Ref: library/sqlite3 sqlite3 Connection close5485847
Ref: 1c4a5485847
Ref: library/sqlite3 sqlite3 Connection execute5486134
Ref: 1c4b5486134
Ref: library/sqlite3 sqlite3 Connection executemany5486430
Ref: 1c4c5486430
Ref: library/sqlite3 sqlite3 Connection executescript5486734
Ref: 1c4e5486734
Ref: library/sqlite3 sqlite3 Connection create_function5487035
Ref: ecf5487035
Ref: library/sqlite3 sqlite3 Connection create_aggregate5488447
Ref: ece5488447
Ref: library/sqlite3 sqlite3 Connection create_collation5489779
Ref: 1c515489779
Ref: library/sqlite3 sqlite3 Connection interrupt5491389
Ref: 1c525491389
Ref: library/sqlite3 sqlite3 Connection set_authorizer5491629
Ref: ed05491629
Ref: library/sqlite3 sqlite3 Connection set_progress_handler5492989
Ref: ed15492989
Ref: library/sqlite3 sqlite3 Connection set_trace_callback5493647
Ref: a825493647
Ref: library/sqlite3 sqlite3 Connection enable_load_extension5494414
Ref: b8c5494414
Ref: library/sqlite3 sqlite3 Connection load_extension5496228
Ref: b8d5496228
Ref: library/sqlite3 sqlite3 Connection row_factory5496568
Ref: 1c545496568
Ref: library/sqlite3 sqlite3 Connection text_factory5497934
Ref: 1c555497934
Ref: library/sqlite3 sqlite3 Connection total_changes5499651
Ref: 1c565499651
Ref: library/sqlite3 sqlite3 Connection iterdump5499847
Ref: 1c575499847
Ref: library/sqlite3 sqlite3 Connection backup5500494
Ref: 3ce5500494
Ref: Connection Objects-Footnote-15502906
Ref: Connection Objects-Footnote-25502952
Ref: Connection Objects-Footnote-35503246
Node: Cursor Objects5503540
Ref: library/sqlite3 cursor-objects5503691
Ref: 1c585503691
Ref: library/sqlite3 sqlite3-cursor-objects5503691
Ref: 1c595503691
Ref: library/sqlite3 sqlite3 Cursor5503740
Ref: 1c305503740
Ref: library/sqlite3 sqlite3 Cursor execute5503851
Ref: 1c315503851
Ref: library/sqlite3 sqlite3 Cursor executemany5505128
Ref: 1c4d5505128
Ref: library/sqlite3 sqlite3 Cursor executescript5506907
Ref: 1c4f5506907
Ref: library/sqlite3 sqlite3 Cursor fetchone5508021
Ref: 1c325508021
Ref: library/sqlite3 sqlite3 Cursor fetchmany5508197
Ref: 1c5b5508197
Ref: library/sqlite3 sqlite3 Cursor fetchall5509174
Ref: 1c335509174
Ref: library/sqlite3 sqlite3 Cursor close5509458
Ref: 1c5c5509458
Ref: library/sqlite3 sqlite3 Cursor rowcount5509763
Ref: 1c5e5509763
Ref: library/sqlite3 sqlite3 Cursor lastrowid5510757
Ref: 5735510757
Ref: library/sqlite3 sqlite3 Cursor arraysize5511406
Ref: 1c5f5511406
Ref: library/sqlite3 sqlite3 Cursor description5511635
Ref: 1c3c5511635
Ref: library/sqlite3 sqlite3 Cursor connection5512016
Ref: 1c605512016
Node: Row Objects5512512
Ref: library/sqlite3 row-objects5512658
Ref: 1c615512658
Ref: library/sqlite3 sqlite3-row-objects5512658
Ref: 1c625512658
Ref: library/sqlite3 sqlite3 Row5512701
Ref: 7525512701
Ref: library/sqlite3 sqlite3 Row keys5513161
Ref: 1c635513161
Node: Exceptions<4>5514390
Ref: library/sqlite3 exceptions5514545
Ref: 1c645514545
Ref: library/sqlite3 sqlite3-exceptions5514545
Ref: 1c655514545
Ref: library/sqlite3 sqlite3 Warning5514586
Ref: 1c5a5514586
Ref: library/sqlite3 sqlite3 Error5514660
Ref: 1c665514660
Ref: library/sqlite3 sqlite3 DatabaseError5514799
Ref: 1c675514799
Ref: library/sqlite3 sqlite3 IntegrityError5514905
Ref: 1c685514905
Ref: library/sqlite3 sqlite3 ProgrammingError5515117
Ref: 1c5d5515117
Ref: library/sqlite3 sqlite3 OperationalError5515387
Ref: 1c535515387
Ref: library/sqlite3 sqlite3 NotSupportedError5515751
Ref: 1c505515751
Node: SQLite and Python types5516097
Ref: library/sqlite3 sqlite-and-python-types5516265
Ref: 1c695516265
Ref: library/sqlite3 sqlite3-types5516265
Ref: 1c3f5516265
Node: Introduction<7>5516535
Ref: library/sqlite3 introduction5516686
Ref: 1c6a5516686
Node: Using adapters to store additional Python types in SQLite databases5518573
Ref: library/sqlite3 using-adapters-to-store-additional-python-types-in-sqlite-databases5518780
Ref: 1c6b5518780
Node: Letting your object adapt itself5519378
Ref: library/sqlite3 letting-your-object-adapt-itself5519554
Ref: 1c6c5519554
Node: Registering an adapter callable5520667
Ref: library/sqlite3 registering-an-adapter-callable5520843
Ref: 1c6d5520843
Node: Converting SQLite values to custom Python types5522159
Ref: library/sqlite3 converting-sqlite-values-to-custom-python-types5522382
Ref: 1c6e5522382
Node: Default adapters and converters5525011
Ref: library/sqlite3 default-adapters-and-converters5525158
Ref: 1c6f5525158
Node: Controlling Transactions5526716
Ref: library/sqlite3 controlling-transactions5526896
Ref: 1c705526896
Ref: library/sqlite3 sqlite3-controlling-transactions5526896
Ref: 1c455526896
Node: Using sqlite3 efficiently5528552
Ref: library/sqlite3 using-sqlite3-efficiently5528722
Ref: 1c715528722
Node: Using shortcut methods5528936
Ref: library/sqlite3 using-shortcut-methods5529074
Ref: 1c725529074
Node: Accessing columns by name instead of by index5530372
Ref: library/sqlite3 accessing-columns-by-name-instead-of-by-index5530560
Ref: 1c735530560
Node: Using the connection as a context manager5531284
Ref: library/sqlite3 using-the-connection-as-a-context-manager5531441
Ref: 1c745531441
Node: Common issues5532552
Ref: library/sqlite3 common-issues5532689
Ref: 1c755532689
Node: Multithreading5532767
Ref: library/sqlite3 multithreading5532831
Ref: 1c765532831
Node: Data Compression and Archiving5533239
Ref: library/archiving doc5533379
Ref: 1be25533379
Ref: library/archiving archiving5533379
Ref: 1c775533379
Ref: library/archiving data-compression-and-archiving5533379
Ref: 1c785533379
Node: zlib — Compression compatible with gzip5533971
Ref: library/zlib doc5534119
Ref: 1c795534119
Ref: library/zlib module-zlib5534119
Ref: 1445534119
Ref: library/zlib zlib-compression-compatible-with-gzip5534119
Ref: 1c7a5534119
Ref: library/zlib zlib error5535084
Ref: 1c7b5535084
Ref: library/zlib zlib adler325535175
Ref: 1c7c5535175
Ref: library/zlib zlib compress5536088
Ref: 5b35536088
Ref: library/zlib zlib compressobj5536862
Ref: 1c7d5536862
Ref: library/zlib zlib crc325539596
Ref: 1c7e5539596
Ref: library/zlib zlib decompress5540424
Ref: 5b45540424
Ref: library/zlib decompress-wbits5540854
Ref: 1c7f5540854
Ref: library/zlib zlib decompressobj5542589
Ref: 1c805542589
Ref: library/zlib zlib Compress compress5543588
Ref: 1c815543588
Ref: library/zlib zlib Compress flush5543946
Ref: 1c825543946
Ref: library/zlib zlib Compress copy5544701
Ref: 1c835544701
Ref: library/zlib zlib Decompress unused_data5545069
Ref: 1c845545069
Ref: library/zlib zlib Decompress unconsumed_tail5545415
Ref: 1c855545415
Ref: library/zlib zlib Decompress eof5545869
Ref: abb5545869
Ref: library/zlib zlib Decompress decompress5546152
Ref: 1c865546152
Ref: library/zlib zlib Decompress flush5547179
Ref: 1c875547179
Ref: library/zlib zlib Decompress copy5547584
Ref: 1c885547584
Ref: library/zlib zlib ZLIB_VERSION5548062
Ref: 1c895548062
Ref: library/zlib zlib ZLIB_RUNTIME_VERSION5548316
Node: gzip — Support for gzip files5548754
Ref: library/gzip doc5548948
Ref: 1c8a5548948
Ref: library/gzip gzip-support-for-gzip-files5548948
Ref: 1c8b5548948
Ref: library/gzip module-gzip5548948
Ref: 8c5548948
Ref: library/gzip gzip open5549943
Ref: 1c8c5549943
Ref: library/gzip gzip BadGzipFile5551474
Ref: 1d05551474
Ref: library/gzip gzip GzipFile5551719
Ref: 6d15551719
Ref: library/gzip gzip GzipFile peek5554540
Ref: b7b5554540
Ref: library/gzip gzip GzipFile mtime5555164
Ref: 1c8d5555164
Ref: library/gzip gzip compress5556499
Ref: 1cf5556499
Ref: library/gzip gzip decompress5556888
Ref: b7c5556888
Ref: gzip — Support for gzip files-Footnote-15557152
Node: Examples of usage5557215
Ref: library/gzip examples-of-usage5557331
Ref: 1c925557331
Ref: library/gzip gzip-usage-examples5557331
Ref: 1c935557331
Node: Command Line Interface5558249
Ref: library/gzip command-line-interface5558365
Ref: 1c945558365
Node: Command line options5558785
Ref: library/gzip command-line-options5558864
Ref: 1c955558864
Ref: library/gzip cmdoption-gzip-arg-file5558925
Ref: 1c965558925
Ref: library/gzip cmdoption-gzip-fast5559017
Ref: 1c975559017
Ref: library/gzip cmdoption-gzip-best5559112
Ref: 1c985559112
Ref: library/gzip cmdoption-gzip-d5559207
Ref: 1c995559207
Ref: library/gzip cmdoption-gzip-h5559278
Ref: 1c9a5559278
Node: bz2 — Support for bzip2 compression5559339
Ref: library/bz2 doc5559537
Ref: 1c9b5559537
Ref: library/bz2 bz2-support-for-bzip2-compression5559537
Ref: 1c9c5559537
Ref: library/bz2 module-bz25559537
Ref: 145559537
Ref: bz2 — Support for bzip2 compression-Footnote-15560577
Node: De compression of files5560639
Ref: library/bz2 de-compression-of-files5560771
Ref: 1c9f5560771
Ref: library/bz2 bz2 open5560840
Ref: 9ca5560840
Ref: library/bz2 bz2 BZ2File5562277
Ref: 9255562277
Ref: library/bz2 bz2 BZ2File peek5563827
Ref: 1ca05563827
Node: Incremental de compression5565291
Ref: library/bz2 incremental-de-compression5565455
Ref: 1ca15565455
Ref: library/bz2 bz2 BZ2Compressor5565530
Ref: 1c9d5565530
Ref: library/bz2 bz2 BZ2Compressor compress5565870
Ref: 1ca25565870
Ref: library/bz2 bz2 BZ2Compressor flush5566218
Ref: 1ca35566218
Ref: library/bz2 bz2 BZ2Decompressor5566447
Ref: 1c9e5566447
Ref: library/bz2 bz2 BZ2Decompressor decompress5566998
Ref: 6975566998
Ref: library/bz2 bz2 BZ2Decompressor eof5568356
Ref: 1ca65568356
Ref: library/bz2 bz2 BZ2Decompressor unused_data5568480
Ref: 1ca55568480
Ref: library/bz2 bz2 BZ2Decompressor needs_input5568702
Ref: 1ca45568702
Node: One-shot de compression5568924
Ref: library/bz2 one-shot-de-compression5569085
Ref: 1ca75569085
Ref: library/bz2 bz2 compress5569154
Ref: 17ae5569154
Ref: library/bz2 bz2 decompress5569453
Ref: 9cb5569453
Node: Examples of usage<2>5569811
Ref: library/bz2 bz2-usage-examples5569937
Ref: 1ca85569937
Ref: library/bz2 examples-of-usage5569937
Ref: 1ca95569937
Node: lzma — Compression using the LZMA algorithm5572865
Ref: library/lzma doc5573066
Ref: 1caa5573066
Ref: library/lzma lzma-compression-using-the-lzma-algorithm5573066
Ref: 1cab5573066
Ref: library/lzma module-lzma5573066
Ref: ad5573066
Ref: library/lzma lzma LZMAError5573907
Ref: 1cac5573907
Ref: lzma — Compression using the LZMA algorithm-Footnote-15574326
Node: Reading and writing compressed files5574389
Ref: library/lzma reading-and-writing-compressed-files5574560
Ref: 1cad5574560
Ref: library/lzma lzma open5574653
Ref: 1cae5574653
Ref: library/lzma lzma LZMAFile5576420
Ref: 9265576420
Ref: library/lzma lzma LZMAFile peek5578297
Ref: 1cb15578297
Node: Compressing and decompressing data in memory5579178
Ref: library/lzma compressing-and-decompressing-data-in-memory5579374
Ref: 1cb25579374
Ref: library/lzma lzma LZMACompressor5579483
Ref: 1cb05579483
Ref: library/lzma lzma LZMACompressor compress5582561
Ref: 1cb55582561
Ref: library/lzma lzma LZMACompressor flush5583034
Ref: 1cb65583034
Ref: library/lzma lzma LZMADecompressor5583314
Ref: 1caf5583314
Ref: library/lzma lzma LZMADecompressor decompress5584842
Ref: 7085584842
Ref: library/lzma lzma LZMADecompressor check5586203
Ref: 1cba5586203
Ref: library/lzma lzma LZMADecompressor eof5586436
Ref: 1cbb5586436
Ref: library/lzma lzma LZMADecompressor unused_data5586529
Ref: 1cb95586529
Ref: library/lzma lzma LZMADecompressor needs_input5586700
Ref: 1cb85586700
Ref: library/lzma lzma compress5586922
Ref: 1cb35586922
Ref: library/lzma lzma decompress5587268
Ref: 1cb75587268
Node: Miscellaneous<2>5587775
Ref: library/lzma miscellaneous5587966
Ref: 1cbc5587966
Ref: library/lzma lzma is_check_supported5588013
Ref: 1cbd5588013
Node: Specifying custom filter chains5588375
Ref: library/lzma filter-chain-specs5588533
Ref: 1cb45588533
Ref: library/lzma specifying-custom-filter-chains5588533
Ref: 1cbe5588533
Node: Examples<5>5591382
Ref: library/lzma examples5591515
Ref: 1cbf5591515
Node: zipfile — Work with ZIP archives5592883
Ref: library/zipfile doc5593091
Ref: 1cc05593091
Ref: library/zipfile module-zipfile5593091
Ref: 1425593091
Ref: library/zipfile zipfile-work-with-zip-archives5593091
Ref: 1cc15593091
Ref: library/zipfile zipfile BadZipFile5593954
Ref: 1cc25593954
Ref: library/zipfile zipfile BadZipfile5594057
Ref: 1cc35594057
Ref: library/zipfile zipfile LargeZipFile5594218
Ref: 1cc45594218
Ref: library/zipfile zipfile ZipInfo5594770
Ref: 5af5594770
Ref: library/zipfile zipfile is_zipfile5595468
Ref: cad5595468
Ref: library/zipfile zipfile ZIP_STORED5595761
Ref: 1cca5595761
Ref: library/zipfile zipfile ZIP_DEFLATED5595854
Ref: 1ccb5595854
Ref: library/zipfile zipfile ZIP_BZIP25596000
Ref: 1ccc5596000
Ref: library/zipfile zipfile ZIP_LZMA5596163
Ref: 1ccd5596163
Ref: zipfile — Work with ZIP archives-Footnote-15597169
Ref: zipfile — Work with ZIP archives-Footnote-25597235
Ref: zipfile — Work with ZIP archives-Footnote-35597303
Ref: zipfile — Work with ZIP archives-Footnote-45597371
Node: ZipFile Objects5597404
Ref: library/zipfile id15597511
Ref: 1cce5597511
Ref: library/zipfile zipfile-objects5597511
Ref: 1cc55597511
Ref: library/zipfile zipfile ZipFile5597562
Ref: 4145597562
Ref: library/zipfile zipfile ZipFile close5601553
Ref: 1ccf5601553
Ref: library/zipfile zipfile ZipFile getinfo5601724
Ref: 1cc75601724
Ref: library/zipfile zipfile ZipFile infolist5601983
Ref: 1cc85601983
Ref: library/zipfile zipfile ZipFile namelist5602241
Ref: 1cd05602241
Ref: library/zipfile zipfile ZipFile open5602322
Ref: 5b15602322
Ref: library/zipfile zipfile ZipFile extract5604709
Ref: 1cd45604709
Ref: library/zipfile zipfile ZipFile extractall5606068
Ref: 1cd55606068
Ref: library/zipfile zipfile ZipFile printdir5607086
Ref: 1cd65607086
Ref: library/zipfile zipfile ZipFile setpassword5607188
Ref: 1cd75607188
Ref: library/zipfile zipfile ZipFile read5607291
Ref: cac5607291
Ref: library/zipfile zipfile ZipFile testzip5608193
Ref: 1cd85608193
Ref: library/zipfile zipfile ZipFile write5608563
Ref: 6045608563
Ref: library/zipfile zipfile ZipFile writestr5609729
Ref: cae5609729
Ref: library/zipfile zipfile ZipFile filename5611369
Ref: 1cd95611369
Ref: library/zipfile zipfile ZipFile debug5611430
Ref: 1cda5611430
Ref: library/zipfile zipfile ZipFile comment5611650
Ref: 1cdb5611650
Node: Path Objects5611973
Ref: library/zipfile id25612106
Ref: 1cdc5612106
Ref: library/zipfile path-objects5612106
Ref: 1cc65612106
Ref: library/zipfile zipfile Path5612151
Ref: 1cdd5612151
Ref: library/zipfile zipfile Path name5612697
Ref: 1cde5612697
Ref: library/zipfile zipfile Path open5612755
Ref: 1cdf5612755
Ref: library/zipfile zipfile Path iterdir5612910
Ref: 1ce05612910
Ref: library/zipfile zipfile Path is_dir5612994
Ref: 1ce15612994
Ref: library/zipfile zipfile Path is_file5613093
Ref: 1ce25613093
Ref: library/zipfile zipfile Path exists5613188
Ref: 1ce35613188
Ref: library/zipfile zipfile Path read_text5613316
Ref: 1ce45613316
Ref: library/zipfile zipfile Path read_bytes5613548
Ref: 1ce55613548
Node: PyZipFile Objects5613618
Ref: library/zipfile id35613751
Ref: 1ce65613751
Ref: library/zipfile pyzipfile-objects5613751
Ref: 1ce75613751
Ref: library/zipfile zipfile PyZipFile5613953
Ref: 90f5613953
Ref: library/zipfile zipfile PyZipFile writepy5614277
Ref: 90e5614277
Node: ZipInfo Objects5617104
Ref: library/zipfile id45617247
Ref: 1ce85617247
Ref: library/zipfile zipinfo-objects5617247
Ref: 1cc95617247
Ref: library/zipfile zipfile ZipInfo from_file5617615
Ref: 5ae5617615
Ref: library/zipfile zipfile ZipInfo is_dir5618676
Ref: 5b05618676
Ref: library/zipfile zipfile ZipInfo filename5618876
Ref: 1ce95618876
Ref: library/zipfile zipfile ZipInfo date_time5618948
Ref: 1cea5618948
Ref: library/zipfile zipfile ZipInfo compress_type5619730
Ref: 1ceb5619730
Ref: library/zipfile zipfile ZipInfo comment5619818
Ref: 1cec5619818
Ref: library/zipfile zipfile ZipInfo extra5619934
Ref: 1ced5619934
Ref: library/zipfile zipfile ZipInfo create_system5620138
Ref: 1cee5620138
Ref: library/zipfile zipfile ZipInfo create_version5620216
Ref: 1cef5620216
Ref: library/zipfile zipfile ZipInfo extract_version5620302
Ref: 1cf05620302
Ref: library/zipfile zipfile ZipInfo reserved5620389
Ref: 1cf15620389
Ref: library/zipfile zipfile ZipInfo flag_bits5620442
Ref: 1cf25620442
Ref: library/zipfile zipfile ZipInfo volume5620497
Ref: 1cf35620497
Ref: library/zipfile zipfile ZipInfo internal_attr5620564
Ref: 1cf45620564
Ref: library/zipfile zipfile ZipInfo external_attr5620629
Ref: 1cf55620629
Ref: library/zipfile zipfile ZipInfo header_offset5620699
Ref: 1cf65620699
Ref: library/zipfile zipfile ZipInfo CRC5620775
Ref: 1cf75620775
Ref: library/zipfile zipfile ZipInfo compress_size5620842
Ref: 1cf85620842
Ref: library/zipfile zipfile ZipInfo file_size5620915
Ref: 1cd35620915
Ref: ZipInfo Objects-Footnote-15621022
Node: Command-Line Interface5621090
Ref: library/zipfile command-line-interface5621238
Ref: 1cf95621238
Ref: library/zipfile zipfile-commandline5621238
Ref: 1cfa5621238
Node: Command-line options5622011
Ref: library/zipfile command-line-options5622090
Ref: 1cfe5622090
Ref: library/zipfile cmdoption-zipfile-l5622151
Ref: 1cfd5622151
Ref: library/zipfile cmdoption-zipfile-list5622184
Ref: 1cff5622184
Ref: library/zipfile cmdoption-zipfile-c5622253
Ref: 1cfb5622253
Ref: library/zipfile cmdoption-zipfile-create5622310
Ref: 1d005622310
Ref: library/zipfile cmdoption-zipfile-e5622414
Ref: 1cfc5622414
Ref: library/zipfile cmdoption-zipfile-extract5622460
Ref: 1d015622460
Ref: library/zipfile cmdoption-zipfile-t5622559
Ref: 1d025622559
Ref: library/zipfile cmdoption-zipfile-test5622592
Ref: 1d035622592
Node: Decompression pitfalls5622678
Ref: library/zipfile decompression-pitfalls5622802
Ref: 1d045622802
Node: From file itself5623085
Ref: library/zipfile from-file-itself5623192
Ref: 1d055623192
Node: File System limitations5623371
Ref: library/zipfile file-system-limitations5623508
Ref: 1d065623508
Node: Resources limitations5623810
Ref: library/zipfile resources-limitations5623943
Ref: 1d075623943
Ref: Resources limitations-Footnote-15624230
Node: Interruption5624277
Ref: library/zipfile interruption5624418
Ref: 1d085624418
Node: Default behaviors of extraction5624624
Ref: library/zipfile default-behaviors-of-extraction5624735
Ref: 1d095624735
Node: tarfile — Read and write tar archive files5625000
Ref: library/tarfile doc5625154
Ref: 1d0a5625154
Ref: library/tarfile module-tarfile5625154
Ref: 1015625154
Ref: library/tarfile pkzip-application-note5625154
Ref: 1d0b5625154
Ref: library/tarfile tarfile-read-and-write-tar-archive-files5625154
Ref: 1d0c5625154
Ref: library/tarfile tarfile open5626416
Ref: 75a5626416
Ref: library/tarfile tarfile TarFile5632508
Ref: b7f5632508
Ref: library/tarfile tarfile is_tarfile5632703
Ref: 1d115632703
Ref: library/tarfile tarfile TarError5632924
Ref: 1d125632924
Ref: library/tarfile tarfile ReadError5633014
Ref: 1d0e5633014
Ref: library/tarfile tarfile CompressionError5633186
Ref: 1d0f5633186
Ref: library/tarfile tarfile StreamError5633336
Ref: 1d135633336
Ref: library/tarfile tarfile ExtractError5633475
Ref: 1d145633475
Ref: library/tarfile tarfile HeaderError5633645
Ref: 1d155633645
Ref: library/tarfile tarfile ENCODING5633830
Ref: 1d175633830
Ref: library/tarfile tarfile USTAR_FORMAT5634178
Ref: 1d195634178
Ref: library/tarfile tarfile GNU_FORMAT5634245
Ref: 1d1a5634245
Ref: library/tarfile tarfile PAX_FORMAT5634297
Ref: 1d1b5634297
Ref: library/tarfile tarfile DEFAULT_FORMAT5634360
Ref: 1d1c5634360
Ref: tarfile — Read and write tar archive files-Footnote-15635210
Ref: tarfile — Read and write tar archive files-Footnote-25635276
Node: TarFile Objects5635348
Ref: library/tarfile id15635468
Ref: 1d1d5635468
Ref: library/tarfile tarfile-objects5635468
Ref: 1d0d5635468
Ref: library/tarfile tarfile TarFile open5639726
Ref: 1d205639726
Ref: library/tarfile tarfile TarFile getmember5639885
Ref: 1d215639885
Ref: library/tarfile tarfile TarFile getmembers5640208
Ref: 75e5640208
Ref: library/tarfile tarfile TarFile getnames5640395
Ref: 1d225640395
Ref: library/tarfile tarfile TarFile list5640556
Ref: 75d5640556
Ref: library/tarfile tarfile TarFile next5641006
Ref: 1d235641006
Ref: library/tarfile tarfile TarFile extractall5641226
Ref: 75b5641226
Ref: library/tarfile tarfile TarFile extract5642537
Ref: 75c5642537
Ref: library/tarfile tarfile TarFile extractfile5643752
Ref: 1d245643752
Ref: library/tarfile tarfile TarFile add5644148
Ref: 4715644148
Ref: library/tarfile tarfile TarFile addfile5645054
Ref: 1d255645054
Ref: library/tarfile tarfile TarFile gettarinfo5645421
Ref: 1d265645421
Ref: library/tarfile tarfile TarFile close5646562
Ref: 1d2a5646562
Ref: library/tarfile tarfile TarFile pax_headers5646704
Ref: 1d2b5646704
Node: TarInfo Objects5646809
Ref: library/tarfile id25646963
Ref: 1d2c5646963
Ref: library/tarfile tarinfo-objects5646963
Ref: 1d1e5646963
Ref: library/tarfile tarfile TarInfo5647443
Ref: b805647443
Ref: library/tarfile tarfile TarInfo frombuf5647524
Ref: 1d165647524
Ref: library/tarfile tarfile TarInfo fromtarfile5647731
Ref: 1d2d5647731
Ref: library/tarfile tarfile TarInfo tobuf5647905
Ref: 1d2e5647905
Ref: library/tarfile tarfile TarInfo name5648344
Ref: 1d295648344
Ref: library/tarfile tarfile TarInfo size5648407
Ref: 1d285648407
Ref: library/tarfile tarfile TarInfo mtime5648457
Ref: 1d2f5648457
Ref: library/tarfile tarfile TarInfo mode5648520
Ref: 1d305648520
Ref: library/tarfile tarfile TarInfo type5648572
Ref: 1d315648572
Ref: library/tarfile tarfile TarInfo linkname5648950
Ref: 1d325648950
Ref: library/tarfile tarfile TarInfo uid5649118
Ref: 1d335649118
Ref: library/tarfile tarfile TarInfo gid5649207
Ref: 1d345649207
Ref: library/tarfile tarfile TarInfo uname5649297
Ref: 1d355649297
Ref: library/tarfile tarfile TarInfo gname5649344
Ref: 1d365649344
Ref: library/tarfile tarfile TarInfo pax_headers5649392
Ref: 1d375649392
Ref: library/tarfile tarfile TarInfo isfile5649592
Ref: 1d385649592
Ref: library/tarfile tarfile TarInfo isreg5649700
Ref: 1d395649700
Ref: library/tarfile tarfile TarInfo isdir5649766
Ref: 1d3a5649766
Ref: library/tarfile tarfile TarInfo issym5649848
Ref: 1d3b5649848
Ref: library/tarfile tarfile TarInfo islnk5649934
Ref: 1d3c5649934
Ref: library/tarfile tarfile TarInfo ischr5650016
Ref: 1d3d5650016
Ref: library/tarfile tarfile TarInfo isblk5650105
Ref: 1d3e5650105
Ref: library/tarfile tarfile TarInfo isfifo5650190
Ref: 1d3f5650190
Ref: library/tarfile tarfile TarInfo isdev5650268
Ref: 1d405650268
Node: Command-Line Interface<2>5650389
Ref: library/tarfile command-line-interface5650539
Ref: 1d415650539
Ref: library/tarfile tarfile-commandline5650539
Ref: 8dc5650539
Node: Command-line options<2>5651493
Ref: library/tarfile command-line-options5651578
Ref: 1d455651578
Ref: library/tarfile cmdoption-tarfile-l5651639
Ref: 1d445651639
Ref: library/tarfile cmdoption-tarfile-list5651672
Ref: 1d465651672
Ref: library/tarfile cmdoption-tarfile-c5651741
Ref: 1d425651741
Ref: library/tarfile cmdoption-tarfile-create5651798
Ref: 1d475651798
Ref: library/tarfile cmdoption-tarfile-e5651902
Ref: 1d435651902
Ref: library/tarfile cmdoption-tarfile-extract5651950
Ref: 1d485651950
Ref: library/tarfile cmdoption-tarfile-t5652094
Ref: 1d495652094
Ref: library/tarfile cmdoption-tarfile-test5652127
Ref: 1d4a5652127
Ref: library/tarfile cmdoption-tarfile-v5652213
Ref: 1d4b5652213
Node: Examples<6>5652270
Ref: library/tarfile examples5652426
Ref: 1d4c5652426
Ref: library/tarfile tar-examples5652426
Ref: 1d105652426
Node: Supported tar formats5654298
Ref: library/tarfile supported-tar-formats5654443
Ref: 1d4d5654443
Ref: library/tarfile tar-formats5654443
Ref: 1d185654443
Node: Unicode issues5656665
Ref: library/tarfile tar-unicode5656790
Ref: 1d1f5656790
Ref: library/tarfile unicode-issues5656790
Ref: 1d4e5656790
Node: File Formats5658763
Ref: library/fileformats doc5658909
Ref: 1d505658909
Ref: library/fileformats file-formats5658909
Ref: 1d515658909
Ref: library/fileformats fileformats5658909
Ref: 1d525658909
Node: csv — CSV File Reading and Writing5659375
Ref: library/csv doc5659511
Ref: 1d535659511
Ref: library/csv csv-csv-file-reading-and-writing5659511
Ref: 1d545659511
Ref: library/csv module-csv5659511
Ref: 2a5659511
Ref: csv — CSV File Reading and Writing-Footnote-15661421
Ref: csv — CSV File Reading and Writing-Footnote-25661483
Ref: csv — CSV File Reading and Writing-Footnote-35661532
Node: Module Contents<3>5661581
Ref: library/csv csv-contents5661715
Ref: 1d565661715
Ref: library/csv module-contents5661715
Ref: 1d575661715
Ref: library/csv csv reader5661826
Ref: 1d555661826
Ref: library/csv csv writer5663495
Ref: def5663495
Ref: library/csv csv register_dialect5665252
Ref: 1d5b5665252
Ref: library/csv csv unregister_dialect5665725
Ref: 1d5c5665725
Ref: library/csv csv get_dialect5665932
Ref: 1d5e5665932
Ref: library/csv csv list_dialects5666163
Ref: 1d595666163
Ref: library/csv csv field_size_limit5666250
Ref: 1d5f5666250
Ref: library/csv csv DictReader5666485
Ref: 1bb5666485
Ref: library/csv csv DictWriter5667955
Ref: b6d5667955
Ref: library/csv csv Dialect5669618
Ref: 1d585669618
Ref: library/csv csv excel5669862
Ref: 1d605669862
Ref: library/csv csv excel_tab5670045
Ref: 1d615670045
Ref: library/csv csv unix_dialect5670250
Ref: b6c5670250
Ref: library/csv csv Sniffer5670551
Ref: 1d625670551
Ref: library/csv csv Sniffer sniff5670720
Ref: 1d635670720
Ref: library/csv csv Sniffer has_header5671042
Ref: 1d645671042
Ref: library/csv csv QUOTE_ALL5671591
Ref: 1d655671591
Ref: library/csv csv QUOTE_MINIMAL5671680
Ref: 1d665671680
Ref: library/csv csv QUOTE_NONNUMERIC5671901
Ref: 1d675671901
Ref: library/csv csv QUOTE_NONE5672096
Ref: 1d685672096
Ref: library/csv csv Error5672596
Ref: 1d5d5672596
Ref: Module Contents<3>-Footnote-15672722
Ref: Module Contents<3>-Footnote-25673067
Node: Dialects and Formatting Parameters5673412
Ref: library/csv csv-fmt-params5673569
Ref: 1d5a5673569
Ref: library/csv dialects-and-formatting-parameters5673569
Ref: 1d695673569
Ref: library/csv csv Dialect delimiter5674362
Ref: 1d6a5674362
Ref: library/csv csv Dialect doublequote5674482
Ref: 1d6b5674482
Ref: library/csv csv Dialect escapechar5674954
Ref: 1d6c5674954
Ref: library/csv csv Dialect lineterminator5675334
Ref: 1d6d5675334
Ref: library/csv csv Dialect quotechar5675691
Ref: 1d6e5675691
Ref: library/csv csv Dialect quoting5675921
Ref: 1d6f5675921
Ref: library/csv csv Dialect skipinitialspace5676196
Ref: 1d705676196
Ref: library/csv csv Dialect strict5676365
Ref: 1d715676365
Node: Reader Objects5676505
Ref: library/csv reader-objects5676658
Ref: 1d725676658
Ref: library/csv csv csvreader __next__5676852
Ref: 1d735676852
Ref: library/csv csv csvreader dialect5677232
Ref: 1d745677232
Ref: library/csv csv csvreader line_num5677333
Ref: 1d755677333
Ref: library/csv csv csvreader fieldnames5677585
Ref: 1d765677585
Node: Writer Objects5677789
Ref: library/csv writer-objects5677919
Ref: 1d775677919
Ref: library/csv csv csvwriter writerow5678520
Ref: 6b85678520
Ref: library/csv csv csvwriter writerows5678833
Ref: 1d785678833
Ref: library/csv csv csvwriter dialect5679096
Ref: 1d795679096
Ref: library/csv csv DictWriter writeheader5679251
Ref: b6e5679251
Node: Examples<7>5679735
Ref: library/csv csv-examples5679842
Ref: 1d7a5679842
Ref: library/csv examples5679842
Ref: 1d7b5679842
Node: configparser — Configuration file parser5681854
Ref: library/configparser doc5682030
Ref: 1d7c5682030
Ref: library/configparser configparser-configuration-file-parser5682030
Ref: 1d7d5682030
Ref: library/configparser module-configparser5682030
Ref: 235682030
Ref: configparser — Configuration file parser-Footnote-15683324
Node: Quick Start5683395
Ref: library/configparser quick-start5683513
Ref: 1d7e5683513
Ref: Quick Start-Footnote-15686194
Ref: Quick Start-Footnote-25686400
Node: Supported Datatypes5686606
Ref: library/configparser supported-datatypes5686748
Ref: 1d825686748
Ref: Supported Datatypes-Footnote-15688070
Ref: Supported Datatypes-Footnote-25688276
Node: Fallback Values5688482
Ref: library/configparser fallback-values5688641
Ref: 1d865688641
Node: Supported INI File Structure5690139
Ref: library/configparser supported-ini-file-structure5690302
Ref: 1d7f5690302
Ref: Supported INI File Structure-Footnote-15692578
Ref: Supported INI File Structure-Footnote-25692784
Ref: Supported INI File Structure-Footnote-35692990
Ref: Supported INI File Structure-Footnote-45693196
Node: Interpolation of values5693402
Ref: library/configparser interpolation-of-values5693573
Ref: 1d875693573
Ref: library/configparser configparser BasicInterpolation5693809
Ref: 1d885693809
Ref: library/configparser configparser ExtendedInterpolation5695088
Ref: bcf5695088
Ref: Interpolation of values-Footnote-15696569
Node: Mapping Protocol Access5696775
Ref: library/configparser mapping-protocol-access5696946
Ref: 1d805696946
Ref: Mapping Protocol Access-Footnote-15699835
Node: Customizing Parser Behaviour5700041
Ref: library/configparser customizing-parser-behaviour5700208
Ref: 1d815700208
Ref: library/configparser configparser ConfigParser BOOLEAN_STATES5710951
Ref: 1d8a5710951
Ref: library/configparser configparser ConfigParser optionxform5711876
Ref: 1d8b5711876
Ref: library/configparser configparser ConfigParser SECTCRE5713137
Ref: 1d8c5713137
Node: Legacy API Examples5714379
Ref: library/configparser legacy-api-examples5714543
Ref: 1d8d5714543
Node: ConfigParser Objects5718361
Ref: library/configparser configparser-objects5718520
Ref: 1d8e5718520
Ref: library/configparser id115718520
Ref: 1d8f5718520
Ref: library/configparser configparser ConfigParser5718581
Ref: 4a05718581
Ref: library/configparser configparser ConfigParser defaults5722384
Ref: 1d915722384
Ref: library/configparser configparser ConfigParser sections5722484
Ref: 1d925722484
Ref: library/configparser configparser ConfigParser add_section5722627
Ref: bf75722627
Ref: library/configparser configparser ConfigParser has_section5723116
Ref: 1d935723116
Ref: library/configparser configparser ConfigParser options5723292
Ref: 1d945723292
Ref: library/configparser configparser ConfigParser has_option5723402
Ref: 1d955723402
Ref: library/configparser configparser ConfigParser read5723702
Ref: fdd5723702
Ref: library/configparser configparser ConfigParser read_file5725426
Ref: 1d965725426
Ref: library/configparser configparser ConfigParser read_string5725907
Ref: 1d985725907
Ref: library/configparser configparser ConfigParser read_dict5726254
Ref: 1d905726254
Ref: library/configparser configparser ConfigParser get5726949
Ref: bf55726949
Ref: library/configparser configparser ConfigParser getint5727905
Ref: 1d845727905
Ref: library/configparser configparser ConfigParser getfloat5728193
Ref: 1d855728193
Ref: library/configparser configparser ConfigParser getboolean5728496
Ref: 1d835728496
Ref: library/configparser configparser ConfigParser items5729226
Ref: 1d995729226
Ref: library/configparser configparser ConfigParser set5729864
Ref: bf65729864
Ref: library/configparser configparser ConfigParser write5730149
Ref: 1d895730149
Ref: library/configparser configparser ConfigParser remove_option5730589
Ref: 1d9b5730589
Ref: library/configparser configparser ConfigParser remove_section5730903
Ref: 1d9c5730903
Ref: library/configparser configparser ConfigParser readfp5732088
Ref: 1d975732088
Ref: library/configparser configparser MAX_INTERPOLATION_DEPTH5732856
Ref: 1d9d5732856
Node: RawConfigParser Objects5733082
Ref: library/configparser id135733235
Ref: 1d9e5733235
Ref: library/configparser rawconfigparser-objects5733235
Ref: 1d9f5733235
Ref: library/configparser configparser RawConfigParser5733304
Ref: 8655733304
Ref: library/configparser configparser RawConfigParser add_section5734286
Ref: 1da05734286
Ref: library/configparser configparser RawConfigParser set5734760
Ref: 1da15734760
Node: Exceptions<5>5735587
Ref: library/configparser exceptions5735711
Ref: 1da25735711
Ref: library/configparser configparser Error5735754
Ref: 1da35735754
Ref: library/configparser configparser NoSectionError5735856
Ref: 1d9a5735856
Ref: library/configparser configparser DuplicateSectionError5735962
Ref: bf85735962
Ref: library/configparser configparser DuplicateOptionError5736374
Ref: bf95736374
Ref: library/configparser configparser NoOptionError5736734
Ref: 1da45736734
Ref: library/configparser configparser InterpolationError5736868
Ref: 1da55736868
Ref: library/configparser configparser InterpolationDepthError5737013
Ref: 1da65737013
Ref: library/configparser configparser InterpolationMissingOptionError5737273
Ref: 1da75737273
Ref: library/configparser configparser InterpolationSyntaxError5737462
Ref: 1da85737462
Ref: library/configparser configparser MissingSectionHeaderError5737690
Ref: 1da95737690
Ref: library/configparser configparser ParsingError5737835
Ref: 1daa5737835
Node: netrc — netrc file processing5738092
Ref: library/netrc doc5738269
Ref: 1dab5738269
Ref: library/netrc module-netrc5738269
Ref: be5738269
Ref: library/netrc netrc-netrc-file-processing5738269
Ref: 1dac5738269
Ref: library/netrc netrc netrc5738587
Ref: fd85738587
Ref: library/netrc netrc NetrcParseError5739847
Ref: 1dad5739847
Ref: netrc — netrc file processing-Footnote-15740316
Node: netrc Objects5740380
Ref: library/netrc id15740461
Ref: 1dae5740461
Ref: library/netrc netrc-objects5740461
Ref: 1daf5740461
Ref: library/netrc netrc netrc authenticators5740565
Ref: 1db05740565
Ref: library/netrc netrc netrc __repr__5740911
Ref: 1db15740911
Ref: library/netrc netrc netrc hosts5741134
Ref: 1db25741134
Ref: library/netrc netrc netrc macros5741332
Ref: 1db35741332
Node: xdrlib — Encode and decode XDR data5741738
Ref: library/xdrlib doc5741925
Ref: 1db45741925
Ref: library/xdrlib module-xdrlib5741925
Ref: 1325741925
Ref: library/xdrlib xdrlib-encode-and-decode-xdr-data5741925
Ref: 1db55741925
Ref: library/xdrlib xdrlib Packer5742530
Ref: 1db65742530
Ref: library/xdrlib xdrlib Unpacker5742713
Ref: 1db75742713
Ref: xdrlib — Encode and decode XDR data-Footnote-15743366
Ref: xdrlib — Encode and decode XDR data-Footnote-25743431
Ref: xdrlib — Encode and decode XDR data-Footnote-35743480
Ref: xdrlib — Encode and decode XDR data-Footnote-45743529
Ref: xdrlib — Encode and decode XDR data-Footnote-55743578
Node: Packer Objects5743627
Ref: library/xdrlib packer-objects5743740
Ref: 1db85743740
Ref: library/xdrlib xdr-packer-objects5743740
Ref: 1db95743740
Ref: library/xdrlib xdrlib Packer get_buffer5743848
Ref: 1dba5743848
Ref: library/xdrlib xdrlib Packer reset5743933
Ref: 1dbb5743933
Ref: library/xdrlib xdrlib Packer pack_float5744369
Ref: 1dbc5744369
Ref: library/xdrlib xdrlib Packer pack_double5744472
Ref: 1dbd5744472
Ref: library/xdrlib xdrlib Packer pack_fstring5744648
Ref: 1dbe5744648
Ref: library/xdrlib xdrlib Packer pack_fopaque5744899
Ref: 1dbf5744899
Ref: library/xdrlib xdrlib Packer pack_string5745035
Ref: 1dc05745035
Ref: library/xdrlib xdrlib Packer pack_opaque5745254
Ref: 1dc15745254
Ref: library/xdrlib xdrlib Packer pack_bytes5745388
Ref: 1dc25745388
Ref: library/xdrlib xdrlib Packer pack_list5745572
Ref: 1dc35745572
Ref: library/xdrlib xdrlib Packer pack_farray5746262
Ref: 1dc45746262
Ref: library/xdrlib xdrlib Packer pack_array5746624
Ref: 1dc55746624
Node: Unpacker Objects5746875
Ref: library/xdrlib unpacker-objects5747010
Ref: 1dc65747010
Ref: library/xdrlib xdr-unpacker-objects5747010
Ref: 1dc75747010
Ref: library/xdrlib xdrlib Unpacker reset5747126
Ref: 1dc85747126
Ref: library/xdrlib xdrlib Unpacker get_position5747215
Ref: 1dc95747215
Ref: library/xdrlib xdrlib Unpacker set_position5747315
Ref: 1dca5747315
Ref: library/xdrlib xdrlib Unpacker get_buffer5747524
Ref: 1dcb5747524
Ref: library/xdrlib xdrlib Unpacker done5747618
Ref: 1dcc5747618
Ref: library/xdrlib xdrlib Unpacker unpack_float5748005
Ref: 1dce5748005
Ref: library/xdrlib xdrlib Unpacker unpack_double5748099
Ref: 1dcf5748099
Ref: library/xdrlib xdrlib Unpacker unpack_fstring5748316
Ref: 1dd05748316
Ref: library/xdrlib xdrlib Unpacker unpack_fopaque5748527
Ref: 1dd15748527
Ref: library/xdrlib xdrlib Unpacker unpack_string5748677
Ref: 1dd25748677
Ref: library/xdrlib xdrlib Unpacker unpack_opaque5748914
Ref: 1dd35748914
Ref: library/xdrlib xdrlib Unpacker unpack_bytes5749064
Ref: 1dd45749064
Ref: library/xdrlib xdrlib Unpacker unpack_list5749265
Ref: 1dd55749265
Ref: library/xdrlib xdrlib Unpacker unpack_farray5749670
Ref: 1dd65749670
Ref: library/xdrlib xdrlib Unpacker unpack_array5749941
Ref: 1dd75749941
Node: Exceptions<6>5750216
Ref: library/xdrlib exceptions5750328
Ref: 1dd85750328
Ref: library/xdrlib xdr-exceptions5750328
Ref: 1dd95750328
Ref: library/xdrlib xdrlib Error5750426
Ref: 1dcd5750426
Ref: library/xdrlib xdrlib ConversionError5750593
Ref: 1dda5750593
Node: plistlib — Generate and parse Mac OS X plist files5750984
Ref: library/plistlib doc5751131
Ref: 1ddb5751131
Ref: library/plistlib module-plistlib5751131
Ref: cf5751131
Ref: library/plistlib plistlib-generate-and-parse-mac-os-x-plist-files5751131
Ref: 1ddc5751131
Ref: library/plistlib plistlib load5752508
Ref: 87f5752508
Ref: library/plistlib plistlib loads5753676
Ref: 8815753676
Ref: library/plistlib plistlib dump5753916
Ref: 8805753916
Ref: library/plistlib plistlib dumps5755014
Ref: 8825755014
Ref: library/plistlib plistlib readPlist5755351
Ref: 4745755351
Ref: library/plistlib plistlib writePlist5755989
Ref: 9395755989
Ref: library/plistlib plistlib readPlistFromBytes5756248
Ref: 4755756248
Ref: library/plistlib plistlib writePlistToBytes5756677
Ref: 93a5756677
Ref: library/plistlib plistlib Data5756905
Ref: 93b5756905
Ref: library/plistlib plistlib UID5757322
Ref: 20e5757322
Ref: library/plistlib plistlib FMT_XML5757726
Ref: 8835757726
Ref: library/plistlib plistlib FMT_BINARY5757818
Ref: 8845757818
Ref: plistlib — Generate and parse Mac OS X plist files-Footnote-15757986
Ref: plistlib — Generate and parse Mac OS X plist files-Footnote-25758053
Node: Examples<8>5758152
Ref: library/plistlib examples5758252
Ref: 1ddd5758252
Node: Cryptographic Services5758994
Ref: library/crypto doc5759143
Ref: 1dde5759143
Ref: library/crypto crypto5759143
Ref: 1ddf5759143
Ref: library/crypto cryptographic-services5759143
Ref: 1de05759143
Node: hashlib — Secure hashes and message digests5759628
Ref: library/hashlib doc5759790
Ref: 1de15759790
Ref: library/hashlib hashlib-secure-hashes-and-message-digests5759790
Ref: 1de25759790
Ref: library/hashlib module-hashlib5759790
Ref: 8d5759790
Ref: hashlib — Secure hashes and message digests-Footnote-15760811
Ref: hashlib — Secure hashes and message digests-Footnote-25760877
Node: Hash algorithms5760926
Ref: library/hashlib hash-algorithms5761061
Ref: 1de35761061
Ref: library/hashlib id15761061
Ref: 1de45761061
Ref: library/hashlib hashlib new5763307
Ref: 1de55763307
Ref: library/hashlib hashlib algorithms_guaranteed5763985
Ref: cef5763985
Ref: library/hashlib hashlib algorithms_available5764318
Ref: cf05764318
Ref: library/hashlib hashlib hash digest_size5764854
Ref: 1de65764854
Ref: library/hashlib hashlib hash block_size5764929
Ref: 1de75764929
Ref: library/hashlib hashlib hash name5765063
Ref: 8465765063
Ref: library/hashlib hashlib hash update5765484
Ref: 1de85765484
Ref: library/hashlib hashlib hash digest5765971
Ref: 1de95765971
Ref: library/hashlib hashlib hash hexdigest5766211
Ref: 1dea5766211
Ref: library/hashlib hashlib hash copy5766482
Ref: 1deb5766482
Node: SHAKE variable length digests5766669
Ref: library/hashlib shake-variable-length-digests5766827
Ref: 1dec5766827
Ref: library/hashlib hashlib shake digest5767156
Ref: f5d5767156
Ref: library/hashlib hashlib shake hexdigest5767380
Ref: f5e5767380
Node: Key derivation5767658
Ref: library/hashlib key-derivation5767807
Ref: 1ded5767807
Ref: library/hashlib hashlib pbkdf2_hmac5768118
Ref: 7da5768118
Ref: library/hashlib hashlib scrypt5769549
Ref: 4c75769549
Ref: Key derivation-Footnote-15770318
Ref: Key derivation-Footnote-25770380
Node: BLAKE25770429
Ref: library/hashlib blake25770540
Ref: 1dee5770540
Ref: BLAKE2-Footnote-15771262
Ref: BLAKE2-Footnote-25771289
Ref: BLAKE2-Footnote-35771338
Node: Creating hash objects5771416
Ref: library/hashlib creating-hash-objects5771501
Ref: 1def5771501
Ref: library/hashlib hashlib blake2b5771628
Ref: 5415771628
Ref: library/hashlib hashlib blake2s5771832
Ref: 5425771832
Ref: Creating hash objects-Footnote-15774764
Node: Constants<5>5774811
Ref: library/hashlib constants5774916
Ref: 1df05774916
Ref: library/hashlib hashlib blake2b SALT_SIZE5774955
Ref: 1df15774955
Ref: library/hashlib hashlib blake2s SALT_SIZE5774984
Ref: 1df25774984
Ref: library/hashlib hashlib blake2b PERSON_SIZE5775069
Ref: 1df35775069
Ref: library/hashlib hashlib blake2s PERSON_SIZE5775100
Ref: 1df45775100
Ref: library/hashlib hashlib blake2b MAX_KEY_SIZE5775205
Ref: 1df55775205
Ref: library/hashlib hashlib blake2s MAX_KEY_SIZE5775237
Ref: 1df65775237
Ref: library/hashlib hashlib blake2b MAX_DIGEST_SIZE5775288
Ref: 1df75775288
Ref: library/hashlib hashlib blake2s MAX_DIGEST_SIZE5775323
Ref: 1df85775323
Node: Examples<9>5775414
Ref: library/hashlib examples5775505
Ref: 1df95775505
Node: Simple hashing5775679
Ref: library/hashlib simple-hashing5775778
Ref: 1dfa5775778
Node: Using different digest sizes5777200
Ref: library/hashlib using-different-digest-sizes5777321
Ref: 1dfb5777321
Node: Keyed hashing5778462
Ref: library/hashlib keyed-hashing5778587
Ref: 1dfc5778587
Ref: Keyed hashing-Footnote-15780598
Node: Randomized hashing5780676
Ref: library/hashlib randomized-hashing5780788
Ref: 1dfd5780788
Ref: Randomized hashing-Footnote-15783392
Ref: Randomized hashing-Footnote-25783459
Node: Personalization5783490
Ref: library/hashlib personalization5783598
Ref: 1dfe5783598
Ref: Personalization-Footnote-15785593
Node: Tree mode5785661
Ref: library/hashlib tree-mode5785742
Ref: 1dff5785742
Node: Credits5786993
Ref: library/hashlib credits5787063
Ref: 1e005787063
Ref: Credits-Footnote-15789297
Ref: Credits-Footnote-25789324
Ref: Credits-Footnote-35789393
Ref: Credits-Footnote-45789427
Ref: Credits-Footnote-55789464
Ref: Credits-Footnote-65789507
Node: hmac — Keyed-Hashing for Message Authentication5789550
Ref: library/hmac doc5789784
Ref: 1e015789784
Ref: library/hmac hmac-keyed-hashing-for-message-authentication5789784
Ref: 1e025789784
Ref: library/hmac module-hmac5789784
Ref: 8f5789784
Ref: library/hmac hmac new5790076
Ref: 8485790076
Ref: library/hmac hmac digest5791011
Ref: 3855791011
Ref: library/hmac hmac HMAC update5791652
Ref: 8495791652
Ref: library/hmac hmac HMAC digest5792000
Ref: 1e035792000
Ref: library/hmac hmac HMAC hexdigest5792609
Ref: 1e045792609
Ref: library/hmac hmac HMAC copy5793197
Ref: 1e055793197
Ref: library/hmac hmac HMAC digest_size5793435
Ref: 84c5793435
Ref: library/hmac hmac HMAC block_size5793522
Ref: 84a5793522
Ref: library/hmac hmac HMAC name5793642
Ref: 84b5793642
Ref: library/hmac hmac compare_digest5793835
Ref: a015793835
Ref: hmac — Keyed-Hashing for Message Authentication-Footnote-15794657
Ref: hmac — Keyed-Hashing for Message Authentication-Footnote-25794720
Node: secrets — Generate secure random numbers for managing secrets5794769
Ref: library/secrets doc5794949
Ref: 1e065794949
Ref: library/secrets module-secrets5794949
Ref: e45794949
Ref: library/secrets secrets-generate-secure-random-numbers-for-managing-secrets5794949
Ref: 1e075794949
Ref: secrets — Generate secure random numbers for managing secrets-Footnote-15795815
Ref: secrets — Generate secure random numbers for managing secrets-Footnote-25795881
Node: Random numbers5795930
Ref: library/secrets random-numbers5796070
Ref: 1e085796070
Ref: library/secrets secrets SystemRandom5796243
Ref: 1e095796243
Ref: library/secrets secrets choice5796460
Ref: 1e0a5796460
Ref: library/secrets secrets randbelow5796567
Ref: 1e0b5796567
Ref: library/secrets secrets randbits5796653
Ref: 1e0c5796653
Node: Generating tokens5796731
Ref: library/secrets generating-tokens5796895
Ref: 1e0d5796895
Ref: library/secrets secrets token_bytes5797114
Ref: 1e0e5797114
Ref: library/secrets secrets token_hex5797407
Ref: 1e0f5797407
Ref: library/secrets secrets token_urlsafe5797743
Ref: 1e105797743
Node: How many bytes should tokens use?5798173
Ref: library/secrets how-many-bytes-should-tokens-use5798260
Ref: 1e115798260
Ref: How many bytes should tokens use?-Footnote-15799287
Node: Other functions5799344
Ref: library/secrets other-functions5799520
Ref: 1e125799520
Ref: library/secrets secrets compare_digest5799571
Ref: 1e135799571
Ref: Other functions-Footnote-15799864
Node: Recipes and best practices5799921
Ref: library/secrets recipes-and-best-practices5800071
Ref: 1e145800071
Ref: Recipes and best practices-Footnote-15801811
Ref: Recipes and best practices-Footnote-25801866
Node: Generic Operating System Services5801896
Ref: library/allos doc5802053
Ref: 1e155802053
Ref: library/allos allos5802053
Ref: 1e165802053
Ref: library/allos generic-operating-system-services5802053
Ref: 1e175802053
Node: os — Miscellaneous operating system interfaces5803604
Ref: library/os doc5803773
Ref: 1e185803773
Ref: library/os module-os5803773
Ref: c45803773
Ref: library/os os-miscellaneous-operating-system-interfaces5803773
Ref: 1e195803773
Ref: library/os os error5805565
Ref: 1e1a5805565
Ref: library/os os name5805653
Ref: 1e1b5805653
Ref: library/os os-filenames5806096
Ref: 1d4f5806096
Ref: os — Miscellaneous operating system interfaces-Footnote-15806501
Node: File Names Command Line Arguments and Environment Variables5806562
Ref: library/os file-names-command-line-arguments-and-environment-variables5806733
Ref: 1e1c5806733
Ref: library/os filesystem-encoding5806733
Ref: 1e1d5806733
Node: Process Parameters5807737
Ref: library/os os-procinfo5807937
Ref: 1e1e5807937
Ref: library/os process-parameters5807937
Ref: 1e1f5807937
Ref: library/os os ctermid5808091
Ref: 1e205808091
Ref: library/os os environ5808248
Ref: b2a5808248
Ref: library/os os environb5810139
Ref: b875810139
Ref: library/os os fsencode5810725
Ref: 4e45810725
Ref: library/os os fsdecode5811155
Ref: 4e35811155
Ref: library/os os fspath5811589
Ref: 4e25811589
Ref: library/os os PathLike5812000
Ref: 4e05812000
Ref: library/os os PathLike __fspath__5812176
Ref: 4e15812176
Ref: library/os os getenv5812446
Ref: 1e235812446
Ref: library/os os getenvb5812926
Ref: b865812926
Ref: library/os os get_exec_path5813312
Ref: 1e245813312
Ref: library/os os getegid5813691
Ref: 1e255813691
Ref: library/os os geteuid5813922
Ref: 1e265813922
Ref: library/os os getgid5814046
Ref: 1e275814046
Ref: library/os os getgrouplist5814168
Ref: a505814168
Ref: library/os os getgroups5814482
Ref: 1e285814482
Ref: library/os os getlogin5815708
Ref: 1e2a5815708
Ref: library/os os getpgid5816190
Ref: 1e2c5816190
Ref: library/os os getpgrp5816415
Ref: 1e2d5816415
Ref: library/os os getpid5816533
Ref: 1e2e5816533
Ref: library/os os getppid5816598
Ref: 1e2f5816598
Ref: library/os os getpriority5816968
Ref: a3b5816968
Ref: library/os os PRIO_PROCESS5817600
Ref: 1e305817600
Ref: library/os os PRIO_PGRP5817626
Ref: 1e315817626
Ref: library/os os PRIO_USER5817649
Ref: 1e325817649
Ref: library/os os getresuid5817835
Ref: c9e5817835
Ref: library/os os getresgid5818046
Ref: c9d5818046
Ref: library/os os getuid5818258
Ref: 1e335818258
Ref: library/os os initgroups5818376
Ref: ca15818376
Ref: library/os os putenv5818664
Ref: 1e215818664
Ref: library/os os setegid5819518
Ref: 1e355819518
Ref: library/os os seteuid5819644
Ref: 1e365819644
Ref: library/os os setgid5819769
Ref: 1e375819769
Ref: library/os os setgroups5819882
Ref: 1e295819882
Ref: library/os os setpgrp5820530
Ref: 1e385820530
Ref: library/os os setpgid5820766
Ref: 1e395820766
Ref: library/os os setpriority5821030
Ref: a3c5821030
Ref: library/os os setregid5821807
Ref: 1e3a5821807
Ref: library/os os setresgid5821950
Ref: c9f5821950
Ref: library/os os setresuid5822134
Ref: ca05822134
Ref: library/os os setreuid5822317
Ref: 1e3b5822317
Ref: library/os os getsid5822459
Ref: 1e3c5822459
Ref: library/os os setsid5822617
Ref: 1e3d5822617
Ref: library/os os setuid5822772
Ref: 1e3e5822772
Ref: library/os os strerror5822885
Ref: 1e3f5822885
Ref: library/os os supports_bytes_environ5823128
Ref: b855823128
Ref: library/os os umask5823293
Ref: 1e405823293
Ref: library/os os uname5823391
Ref: a525823391
Ref: library/os os unsetenv5824443
Ref: d365824443
Node: File Object Creation5825098
Ref: library/os file-object-creation5825265
Ref: 1e425825265
Ref: library/os os-newstreams5825265
Ref: 1e435825265
Ref: library/os os fdopen5825440
Ref: 136d5825440
Node: File Descriptor Operations5825767
Ref: library/os file-descriptor-operations5825937
Ref: 1e445825937
Ref: library/os os-fd-ops5825937
Ref: 1e455825937
Ref: library/os os close5826778
Ref: 3c75826778
Ref: library/os os closerange5827223
Ref: 1e485827223
Ref: library/os os copy_file_range5827569
Ref: 1e495827569
Ref: library/os os device_encoding5828596
Ref: 1e4b5828596
Ref: library/os os dup5828789
Ref: ec55828789
Ref: library/os os dup25829158
Ref: 3b35829158
Ref: library/os os fchmod5829617
Ref: 6505829617
Ref: library/os os fchown5829907
Ref: 6515829907
Ref: library/os os fdatasync5830241
Ref: 6525830241
Ref: library/os os fpathconf5830472
Ref: 1e4c5830472
Ref: library/os os fstat5831501
Ref: 6535831501
Ref: library/os os fstatvfs5831760
Ref: 6545831760
Ref: library/os os fsync5832034
Ref: 6555832034
Ref: library/os os ftruncate5832519
Ref: 6565832519
Ref: library/os os get_blocking5832961
Ref: 7155832961
Ref: library/os os isatty5833301
Ref: 1e4e5833301
Ref: library/os os lockf5833452
Ref: a4f5833452
Ref: library/os os F_LOCK5833858
Ref: 1e4f5833858
Ref: library/os os F_TLOCK5833878
Ref: 1e505833878
Ref: library/os os F_ULOCK5833899
Ref: 1e515833899
Ref: library/os os F_TEST5833920
Ref: 1e525833920
Ref: library/os os lseek5834074
Ref: a535834074
Ref: library/os os SEEK_SET5834544
Ref: d875834544
Ref: library/os os SEEK_CUR5834566
Ref: d885834566
Ref: library/os os SEEK_END5834588
Ref: d895834588
Ref: library/os os open5834849
Ref: 6595834849
Ref: library/os os O_RDONLY5836915
Ref: 1e535836915
Ref: library/os os O_WRONLY5836937
Ref: 1e545836937
Ref: library/os os O_RDWR5836959
Ref: 1e565836959
Ref: library/os os O_APPEND5836979
Ref: 1e575836979
Ref: library/os os O_CREAT5837001
Ref: 1e585837001
Ref: library/os os O_EXCL5837022
Ref: 1ba45837022
Ref: library/os os O_TRUNC5837042
Ref: 1e595837042
Ref: library/os os O_DSYNC5837125
Ref: 1e5a5837125
Ref: library/os os O_RSYNC5837146
Ref: 1e5b5837146
Ref: library/os os O_SYNC5837167
Ref: 1e5c5837167
Ref: library/os os O_NDELAY5837187
Ref: 1e5d5837187
Ref: library/os os O_NONBLOCK5837209
Ref: 7175837209
Ref: library/os os O_NOCTTY5837233
Ref: 1e5e5837233
Ref: library/os os O_CLOEXEC5837255
Ref: 9b75837255
Ref: library/os os O_BINARY5837399
Ref: 1e555837399
Ref: library/os os O_NOINHERIT5837421
Ref: 1e5f5837421
Ref: library/os os O_SHORT_LIVED5837446
Ref: 1e605837446
Ref: library/os os O_TEMPORARY5837473
Ref: 1e615837473
Ref: library/os os O_RANDOM5837498
Ref: 1e625837498
Ref: library/os os O_SEQUENTIAL5837520
Ref: 1e635837520
Ref: library/os os O_TEXT5837546
Ref: 1e645837546
Ref: library/os os O_ASYNC5837624
Ref: 1e655837624
Ref: library/os os O_DIRECT5837645
Ref: 1e665837645
Ref: library/os os O_DIRECTORY5837667
Ref: 1e675837667
Ref: library/os os O_NOFOLLOW5837692
Ref: 1e685837692
Ref: library/os os O_NOATIME5837716
Ref: 1e695837716
Ref: library/os os O_PATH5837739
Ref: 8775837739
Ref: library/os os O_TMPFILE5837759
Ref: 8785837759
Ref: library/os os O_SHLOCK5837782
Ref: d8a5837782
Ref: library/os os O_EXLOCK5837804
Ref: d8b5837804
Ref: library/os os openpty5838095
Ref: 1e6a5838095
Ref: library/os os pipe5838545
Ref: 1e475838545
Ref: library/os os pipe25838885
Ref: a235838885
Ref: library/os os posix_fallocate5839276
Ref: 65b5839276
Ref: library/os os posix_fadvise5839534
Ref: 65a5839534
Ref: library/os os POSIX_FADV_NORMAL5840136
Ref: 1e6b5840136
Ref: library/os os POSIX_FADV_SEQUENTIAL5840167
Ref: 1e6c5840167
Ref: library/os os POSIX_FADV_RANDOM5840202
Ref: 1e6d5840202
Ref: library/os os POSIX_FADV_NOREUSE5840233
Ref: 1e6e5840233
Ref: library/os os POSIX_FADV_WILLNEED5840265
Ref: 1e6f5840265
Ref: library/os os POSIX_FADV_DONTNEED5840298
Ref: 1e705840298
Ref: library/os os pread5840533
Ref: 3ae5840533
Ref: library/os os preadv5840920
Ref: 3ac5840920
Ref: library/os os RWF_NOWAIT5841975
Ref: 1e725841975
Ref: library/os os RWF_HIPRI5842484
Ref: 1e715842484
Ref: library/os os pwrite5842882
Ref: 3b15842882
Ref: library/os os pwritev5843166
Ref: 3af5843166
Ref: library/os os RWF_DSYNC5844184
Ref: 1e755844184
Ref: library/os os RWF_SYNC5844460
Ref: 1e765844460
Ref: library/os os read5844734
Ref: 65c5844734
Ref: library/os os sendfile5845675
Ref: 34e5845675
Ref: library/os os set_blocking5847027
Ref: 7165847027
Ref: library/os os SF_NODISKIO5847393
Ref: 1e775847393
Ref: library/os os SF_MNOWAIT5847418
Ref: 1e785847418
Ref: library/os os SF_SYNC5847442
Ref: 1e795847442
Ref: library/os os readv5847628
Ref: 3ad5847628
Ref: library/os os tcgetpgrp5848244
Ref: 1e7a5848244
Ref: library/os os tcsetpgrp5848459
Ref: 1e7b5848459
Ref: library/os os ttyname5848688
Ref: 1e7c5848688
Ref: library/os os write5848939
Ref: 6625848939
Ref: library/os os writev5849787
Ref: 3b05849787
Ref: File Descriptor Operations-Footnote-15850481
Ref: File Descriptor Operations-Footnote-25850530
Ref: File Descriptor Operations-Footnote-35850593
Ref: File Descriptor Operations-Footnote-45850642
Node: Querying the size of a terminal5850691
Ref: library/os querying-the-size-of-a-terminal5850825
Ref: 1e7d5850825
Ref: library/os terminal-size5850825
Ref: 1e7e5850825
Ref: library/os os get_terminal_size5850929
Ref: a3e5850929
Ref: library/os os terminal_size5851566
Ref: 1bd45851566
Ref: library/os os terminal_size columns5851687
Ref: 1e7f5851687
Ref: library/os os terminal_size lines5851771
Ref: 1e805851771
Node: Inheritance of File Descriptors5851854
Ref: library/os fd-inheritance5851988
Ref: 7ee5851988
Ref: library/os inheritance-of-file-descriptors5851988
Ref: 1e815851988
Ref: library/os os get_inheritable5852951
Ref: 7ef5852951
Ref: library/os os set_inheritable5853078
Ref: 7f05853078
Ref: library/os os get_handle_inheritable5853201
Ref: 7f15853201
Ref: library/os os set_handle_inheritable5853367
Ref: 7f25853367
Node: Files and Directories5853534
Ref: library/os files-and-directories5853702
Ref: 1e835853702
Ref: library/os os-file-dir5853702
Ref: 1e225853702
Ref: library/os path-fd5853851
Ref: 3aa5853851
Ref: library/os dir-fd5854795
Ref: a245854795
Ref: library/os follow-symlinks5855510
Ref: a255855510
Ref: library/os os access5856094
Ref: a265856094
Ref: library/os os F_OK5858642
Ref: 1e845858642
Ref: library/os os R_OK5858660
Ref: 1e855858660
Ref: library/os os W_OK5858678
Ref: 1e865858678
Ref: library/os os X_OK5858696
Ref: 1e875858696
Ref: library/os os chdir5858885
Ref: a345858885
Ref: library/os os chflags5859468
Ref: a275859468
Ref: library/os os chmod5860429
Ref: a285860429
Ref: library/os os chown5862069
Ref: a295862069
Ref: library/os os chroot5862836
Ref: 1e895862836
Ref: library/os os fchdir5863042
Ref: 64f5863042
Ref: library/os os getcwd5863357
Ref: f115863357
Ref: library/os os getcwdb5863451
Ref: 2b65863451
Ref: library/os os lchflags5863759
Ref: 1e8a5863759
Ref: library/os os lchmod5864133
Ref: f615864133
Ref: library/os os lchown5864587
Ref: 1e8b5864587
Ref: library/os os link5864973
Ref: a2a5864973
Ref: library/os os listdir5865617
Ref: a365865617
Ref: library/os os lstat5866940
Ref: 1f05866940
Ref: library/os os mkdir5868075
Ref: a2b5868075
Ref: library/os mkdir-modebits5868279
Ref: 1e8c5868279
Ref: library/os os makedirs5869011
Ref: 3b25869011
Ref: library/os os mkfifo5870614
Ref: 6575870614
Ref: library/os os mknod5871500
Ref: 6585871500
Ref: library/os os major5872371
Ref: 1e8f5872371
Ref: library/os os minor5872539
Ref: 1e905872539
Ref: library/os os makedev5872707
Ref: 1e8e5872707
Ref: library/os os pathconf5872828
Ref: a375872828
Ref: library/os os pathconf_names5873925
Ref: 1e915873925
Ref: library/os os readlink5874248
Ref: 1f15874248
Ref: library/os os remove5875747
Ref: a2c5875747
Ref: library/os os removedirs5876495
Ref: 1e925876495
Ref: library/os os rename5877232
Ref: a2d5877232
Ref: library/os os renames5878589
Ref: 1e935878589
Ref: library/os os replace5879239
Ref: a2e5879239
Ref: library/os os rmdir5879969
Ref: a2f5879969
Ref: library/os os scandir5880500
Ref: 25d5880500
Ref: library/os os scandir close5882126
Ref: 55c5882126
Ref: library/os os DirEntry5883650
Ref: 4e65883650
Ref: library/os os DirEntry name5884835
Ref: 1e965884835
Ref: library/os os DirEntry path5885206
Ref: 1e975885206
Ref: library/os os DirEntry inode5885941
Ref: 1e985885941
Ref: library/os os DirEntry is_dir5886300
Ref: 1e945886300
Ref: library/os os DirEntry is_file5887735
Ref: 6495887735
Ref: library/os os DirEntry is_symlink5888458
Ref: 1e995888458
Ref: library/os os DirEntry stat5889309
Ref: 1e955889309
Ref: library/os os stat5890727
Ref: 1ef5890727
Ref: library/os os stat_result5893308
Ref: fc25893308
Ref: library/os os stat_result st_mode5893558
Ref: 1e9a5893558
Ref: library/os os stat_result st_ino5893653
Ref: 1e9b5893653
Ref: library/os os stat_result st_dev5893902
Ref: 1e9c5893902
Ref: library/os os stat_result st_nlink5893994
Ref: 1e9d5893994
Ref: library/os os stat_result st_uid5894057
Ref: 1e9e5894057
Ref: library/os os stat_result st_gid5894131
Ref: 1e9f5894131
Ref: library/os os stat_result st_size5894206
Ref: 1ea05894206
Ref: library/os os stat_result st_atime5894460
Ref: 1ea15894460
Ref: library/os os stat_result st_mtime5894550
Ref: 1c8f5894550
Ref: library/os os stat_result st_ctime5894654
Ref: 1ea25894654
Ref: library/os os stat_result st_atime_ns5894851
Ref: 1ea35894851
Ref: library/os os stat_result st_mtime_ns5894972
Ref: 1ea45894972
Ref: library/os os stat_result st_ctime_ns5895107
Ref: 1ea55895107
Ref: library/os os stat_result st_blocks5896557
Ref: 1ea65896557
Ref: library/os os stat_result st_blksize5896731
Ref: 1ea75896731
Ref: library/os os stat_result st_rdev5896933
Ref: 1ea85896933
Ref: library/os os stat_result st_flags5897008
Ref: 1ea95897008
Ref: library/os os stat_result st_gen5897233
Ref: 1eaa5897233
Ref: library/os os stat_result st_birthtime5897296
Ref: 1eab5897296
Ref: library/os os stat_result st_fstype5897451
Ref: 3b45897451
Ref: library/os os stat_result st_rsize5897659
Ref: 1eac5897659
Ref: library/os os stat_result st_creator5897723
Ref: 1ead5897723
Ref: library/os os stat_result st_type5897787
Ref: 1eae5897787
Ref: library/os os stat_result st_file_attributes5897909
Ref: 7145897909
Ref: library/os os stat_result st_reparse_tag5898216
Ref: 1eaf5898216
Ref: library/os os statvfs5900064
Ref: a385900064
Ref: library/os os supports_dir_fd5902087
Ref: a335902087
Ref: library/os os supports_effective_ids5903246
Ref: a3a5903246
Ref: library/os os supports_fd5903984
Ref: a395903984
Ref: library/os os supports_follow_symlinks5904806
Ref: 1bc15904806
Ref: library/os os symlink5905940
Ref: a305905940
Ref: library/os os sync5907477
Ref: a4e5907477
Ref: library/os os truncate5907609
Ref: 7185907609
Ref: library/os os unlink5908131
Ref: a315908131
Ref: library/os os utime5908550
Ref: a325908550
Ref: library/os os walk5910286
Ref: 6485910286
Ref: library/os os fwalk5915104
Ref: 3a95915104
Ref: library/os os memfd_create5917541
Ref: 1ee5917541
Ref: library/os os MFD_CLOEXEC5918415
Ref: 1eb05918415
Ref: library/os os MFD_ALLOW_SEALING5918440
Ref: 1eb15918440
Ref: library/os os MFD_HUGETLB5918471
Ref: 1eb25918471
Ref: library/os os MFD_HUGE_SHIFT5918496
Ref: 1eb35918496
Ref: library/os os MFD_HUGE_MASK5918524
Ref: 1eb45918524
Ref: library/os os MFD_HUGE_64KB5918551
Ref: 1eb55918551
Ref: library/os os MFD_HUGE_512KB5918578
Ref: 1eb65918578
Ref: library/os os MFD_HUGE_1MB5918606
Ref: 1eb75918606
Ref: library/os os MFD_HUGE_2MB5918632
Ref: 1eb85918632
Ref: library/os os MFD_HUGE_8MB5918658
Ref: 1eb95918658
Ref: library/os os MFD_HUGE_16MB5918684
Ref: 1eba5918684
Ref: library/os os MFD_HUGE_32MB5918711
Ref: 1ebb5918711
Ref: library/os os MFD_HUGE_256MB5918738
Ref: 1ebc5918738
Ref: library/os os MFD_HUGE_512MB5918766
Ref: 1ebd5918766
Ref: library/os os MFD_HUGE_1GB5918794
Ref: 1ebe5918794
Ref: library/os os MFD_HUGE_2GB5918820
Ref: 1ebf5918820
Ref: library/os os MFD_HUGE_16GB5918846
Ref: 1ec05918846
Ref: Files and Directories-Footnote-15919186
Ref: Files and Directories-Footnote-25919235
Ref: Files and Directories-Footnote-35919278
Ref: Files and Directories-Footnote-45919357
Ref: Files and Directories-Footnote-55919438
Ref: Files and Directories-Footnote-65919527
Ref: Files and Directories-Footnote-75919616
Node: Linux extended attributes5919674
Ref: library/os linux-extended-attributes5919757
Ref: 1ec15919757
Ref: library/os os getxattr5919899
Ref: a405919899
Ref: library/os os listxattr5920448
Ref: a415920448
Ref: library/os os removexattr5920962
Ref: a425920962
Ref: library/os os setxattr5921510
Ref: a435921510
Ref: library/os os XATTR_SIZE_MAX5922584
Ref: 1ec45922584
Ref: library/os os XATTR_CREATE5922720
Ref: 1ec35922720
Ref: library/os os XATTR_REPLACE5922891
Ref: 1ec25922891
Node: Process Management5923073
Ref: library/os os-process5923241
Ref: 1ec55923241
Ref: library/os process-management5923241
Ref: 1ec65923241
Ref: library/os os abort5923854
Ref: 1ec85923854
Ref: library/os os add_dll_directory5924229
Ref: 1c05924229
Ref: library/os os execl5925277
Ref: 1ec75925277
Ref: library/os os execle5925324
Ref: 1ec95925324
Ref: library/os os execlp5925377
Ref: 1eca5925377
Ref: library/os os execlpe5925425
Ref: 1ecb5925425
Ref: library/os os execv5925479
Ref: 1e345925479
Ref: library/os os execve5925515
Ref: a355925515
Ref: library/os os execvp5925557
Ref: 1ecc5925557
Ref: library/os os execvpe5925594
Ref: 1ecd5925594
Ref: library/os os _exit5928702
Ref: 16465928702
Ref: library/os os EX_OK5929450
Ref: 1ece5929450
Ref: library/os os EX_USAGE5929555
Ref: 1ecf5929555
Ref: library/os os EX_DATAERR5929737
Ref: 1ed05929737
Ref: library/os os EX_NOINPUT5929858
Ref: 1ed15929858
Ref: library/os os EX_NOUSER5930003
Ref: 1ed25930003
Ref: library/os os EX_NOHOST5930125
Ref: 1ed35930125
Ref: library/os os EX_UNAVAILABLE5930247
Ref: 1ed45930247
Ref: library/os os EX_SOFTWARE5930382
Ref: 1ed55930382
Ref: library/os os EX_OSERR5930515
Ref: 1ed65930515
Ref: library/os os EX_OSFILE5930697
Ref: 1ed75930697
Ref: library/os os EX_CANTCREAT5930878
Ref: 1ed85930878
Ref: library/os os EX_IOERR5931027
Ref: 1ed95931027
Ref: library/os os EX_TEMPFAIL5931174
Ref: 1eda5931174
Ref: library/os os EX_PROTOCOL5931448
Ref: 1edb5931448
Ref: library/os os EX_NOPERM5931611
Ref: 1edc5931611
Ref: library/os os EX_CONFIG5931817
Ref: 1edd5931817
Ref: library/os os EX_NOTFOUND5931960
Ref: 1ede5931960
Ref: library/os os fork5932097
Ref: 9555932097
Ref: library/os os forkpty5932693
Ref: 1edf5932693
Ref: library/os os kill5933340
Ref: ce65933340
Ref: library/os os killpg5934136
Ref: 1ee25934136
Ref: library/os os nice5934269
Ref: a3d5934269
Ref: library/os os plock5934431
Ref: 1ee35934431
Ref: library/os os popen5934634
Ref: 2a75934634
Ref: library/os os posix_spawn5935914
Ref: 2555935914
Ref: library/os os POSIX_SPAWN_OPEN5936915
Ref: 1ee45936915
Ref: library/os os POSIX_SPAWN_CLOSE5937088
Ref: 1ee55937088
Ref: library/os os POSIX_SPAWN_DUP25937211
Ref: 1ee65937211
Ref: library/os os posix_spawnp5939708
Ref: f4c5939708
Ref: library/os os register_at_fork5940305
Ref: 3ab5940305
Ref: library/os os spawnl5941720
Ref: 1e825941720
Ref: library/os os spawnle5941762
Ref: 1ee85941762
Ref: library/os os spawnlp5941810
Ref: 1ee95941810
Ref: library/os os spawnlpe5941853
Ref: 1eea5941853
Ref: library/os os spawnv5941902
Ref: 1eeb5941902
Ref: library/os os spawnve5941945
Ref: 1eec5941945
Ref: library/os os spawnvp5941994
Ref: 1eed5941994
Ref: library/os os spawnvpe5942038
Ref: 1eee5942038
Ref: library/os os P_NOWAIT5945784
Ref: 1eef5945784
Ref: library/os os P_NOWAITO5945806
Ref: 1ef15945806
Ref: library/os os P_WAIT5946152
Ref: 1ef05946152
Ref: library/os os P_DETACH5946569
Ref: 1ef25946569
Ref: library/os os P_OVERLAY5946591
Ref: 1ef35946591
Ref: library/os os startfile5947083
Ref: 1ef45947083
Ref: library/os os system5948677
Ref: db45948677
Ref: library/os os times5950235
Ref: a515950235
Ref: library/os os wait5951377
Ref: 65f5951377
Ref: library/os os waitid5951788
Ref: 6605951788
Ref: library/os os P_PID5952606
Ref: 1ef55952606
Ref: library/os os P_PGID5952625
Ref: 1ef65952625
Ref: library/os os P_ALL5952645
Ref: 1ef75952645
Ref: library/os os WEXITED5952845
Ref: 1ef85952845
Ref: library/os os WSTOPPED5952866
Ref: 1ef95952866
Ref: library/os os WNOWAIT5952888
Ref: 1efc5952888
Ref: library/os os CLD_EXITED5953090
Ref: 1efd5953090
Ref: library/os os CLD_DUMPED5953114
Ref: 1efe5953114
Ref: library/os os CLD_TRAPPED5953138
Ref: 1eff5953138
Ref: library/os os CLD_CONTINUED5953163
Ref: 1f005953163
Ref: library/os os waitpid5953362
Ref: 6615953362
Ref: library/os os wait35955236
Ref: 65d5955236
Ref: library/os os wait45955733
Ref: 65e5955733
Ref: library/os os WNOHANG5956196
Ref: 1efb5956196
Ref: library/os os WCONTINUED5956434
Ref: 1efa5956434
Ref: library/os os WUNTRACED5956667
Ref: 1f015956667
Ref: library/os os WCOREDUMP5957102
Ref: 1f025957102
Ref: library/os os WIFCONTINUED5957283
Ref: 1f035957283
Ref: library/os os WIFSTOPPED5957480
Ref: 1f045957480
Ref: library/os os WIFSIGNALED5957649
Ref: 1f055957649
Ref: library/os os WIFEXITED5957825
Ref: 1f065957825
Ref: library/os os WEXITSTATUS5958019
Ref: 1f075958019
Ref: library/os os WSTOPSIG5958252
Ref: 1f085958252
Ref: library/os os WTERMSIG5958385
Ref: 1f095958385
Ref: Process Management-Footnote-15958554
Ref: Process Management-Footnote-25958626
Node: Interface to the scheduler5958675
Ref: library/os interface-to-the-scheduler5958854
Ref: 1f0a5958854
Ref: library/os os SCHED_OTHER5959239
Ref: 1f0b5959239
Ref: library/os os SCHED_BATCH5959302
Ref: 1f0c5959302
Ref: library/os os SCHED_IDLE5959451
Ref: 1f0d5959451
Ref: library/os os SCHED_SPORADIC5959545
Ref: 1f0e5959545
Ref: library/os os SCHED_FIFO5959628
Ref: 1f0f5959628
Ref: library/os os SCHED_RR5959699
Ref: 1f105959699
Ref: library/os os SCHED_RESET_ON_FORK5959761
Ref: 1f115959761
Ref: library/os os sched_param5959983
Ref: 1ee75959983
Ref: library/os os sched_param sched_priority5960275
Ref: 1f125960275
Ref: library/os os sched_get_priority_min5960371
Ref: a455960371
Ref: library/os os sched_get_priority_max5960536
Ref: a445960536
Ref: library/os os sched_setscheduler5960701
Ref: a4c5960701
Ref: library/os os sched_getscheduler5960987
Ref: a485960987
Ref: library/os os sched_setparam5961209
Ref: a4b5961209
Ref: library/os os sched_getparam5961421
Ref: a475961421
Ref: library/os os sched_rr_get_interval5961621
Ref: a495961621
Ref: library/os os sched_yield5961793
Ref: a4d5961793
Ref: library/os os sched_setaffinity5961864
Ref: a4a5961864
Ref: library/os os sched_getaffinity5962127
Ref: a465962127
Node: Miscellaneous System Information5962281
Ref: library/os miscellaneous-system-information5962459
Ref: 1f135962459
Ref: library/os os-path5962459
Ref: 1f145962459
Ref: library/os os confstr5962546
Ref: 1f155962546
Ref: library/os os confstr_names5963581
Ref: 1f165963581
Ref: library/os os cpu_count5963874
Ref: 8735963874
Ref: library/os os getloadavg5964200
Ref: 1f175964200
Ref: library/os os sysconf5964454
Ref: 1e735964454
Ref: library/os os sysconf_names5964875
Ref: 1f185964875
Ref: library/os os curdir5965367
Ref: 1b2a5965367
Ref: library/os os pardir5965568
Ref: 1e8d5965568
Ref: library/os os sep5965769
Ref: 1bb05965769
Ref: library/os os altsep5966180
Ref: 1bb15966180
Ref: library/os os extsep5966479
Ref: 1f195966479
Ref: library/os os pathsep5966666
Ref: 12905966666
Ref: library/os os defpath5966910
Ref: f125966910
Ref: library/os os linesep5967119
Ref: 15375967119
Ref: library/os os devnull5967532
Ref: f525967532
Ref: library/os os RTLD_LAZY5967706
Ref: a545967706
Ref: library/os os RTLD_NOW5967729
Ref: a555967729
Ref: library/os os RTLD_GLOBAL5967751
Ref: a565967751
Ref: library/os os RTLD_LOCAL5967776
Ref: a575967776
Ref: library/os os RTLD_NODELETE5967800
Ref: a585967800
Ref: library/os os RTLD_NOLOAD5967827
Ref: a595967827
Ref: library/os os RTLD_DEEPBIND5967852
Ref: a5a5967852
Node: Random numbers<2>5968095
Ref: library/os random-numbers5968238
Ref: 1f1a5968238
Ref: library/os os getrandom5968289
Ref: 55e5968289
Ref: library/os os urandom5969124
Ref: 4c65969124
Ref: library/os os GRND_NONBLOCK5971048
Ref: 1f1c5971048
Ref: library/os os GRND_RANDOM5971521
Ref: 1f1b5971521
Ref: Random numbers<2>-Footnote-15971740
Ref: Random numbers<2>-Footnote-25971802
Node: io — Core tools for working with streams5971851
Ref: library/io doc5972065
Ref: 1f1d5972065
Ref: library/io io-core-tools-for-working-with-streams5972065
Ref: 1f1e5972065
Ref: library/io module-io5972065
Ref: a15972065
Ref: io — Core tools for working with streams-Footnote-15972411
Node: Overview5972472
Ref: library/io io-overview5972595
Ref: 15325972595
Ref: library/io overview5972595
Ref: 1f1f5972595
Node: Text I/O5973852
Ref: library/io text-i-o5973924
Ref: 1f205973924
Node: Binary I/O5974615
Ref: library/io binary-i-o5974703
Ref: 1f215974703
Node: Raw I/O5975572
Ref: library/io raw-i-o5975643
Ref: 1f225975643
Node: High-level Module Interface5976096
Ref: library/io high-level-module-interface5976243
Ref: 1f235976243
Ref: library/io io DEFAULT_BUFFER_SIZE5976318
Ref: 15345976318
Ref: library/io io open5976553
Ref: 64e5976553
Ref: library/io io open_code5976994
Ref: e895976994
Ref: library/io io BlockingIOError5977563
Ref: 1f255977563
Ref: library/io io UnsupportedOperation5977694
Ref: 1f265977694
Node: In-memory streams5977921
Ref: library/io in-memory-streams5978002
Ref: 1f275978002
Node: Class hierarchy5978538
Ref: library/io class-hierarchy5978691
Ref: 1f285978691
Node: I/O Base Classes5983354
Ref: library/io i-o-base-classes5983443
Ref: 1f2a5983443
Ref: library/io io IOBase5983496
Ref: 1d95983496
Ref: library/io io IOBase close5985409
Ref: f435985409
Ref: library/io io IOBase closed5985819
Ref: f445985819
Ref: library/io io IOBase fileno5985894
Ref: 1e465985894
Ref: library/io io IOBase flush5986115
Ref: 1f2b5986115
Ref: library/io io IOBase isatty5986275
Ref: 15355986275
Ref: library/io io IOBase readable5986415
Ref: 1f2c5986415
Ref: library/io io IOBase readline5986577
Ref: 163f5986577
Ref: library/io io IOBase readlines5986946
Ref: 16c85986946
Ref: library/io io IOBase seek5987405
Ref: 1cd15987405
Ref: library/io io IOBase seekable5988401
Ref: 1f2d5988401
Ref: library/io io IOBase tell5988633
Ref: 1cd25988633
Ref: library/io io IOBase truncate5988706
Ref: c985988706
Ref: library/io io IOBase writable5989281
Ref: 1f2e5989281
Ref: library/io io IOBase writelines5989481
Ref: 16c95989481
Ref: library/io io IOBase __del__5989701
Ref: 1f2f5989701
Ref: library/io io RawIOBase5989918
Ref: a085989918
Ref: library/io io RawIOBase read5990421
Ref: 6f65990421
Ref: library/io io RawIOBase readall5991102
Ref: 1f305991102
Ref: library/io io RawIOBase readinto5991258
Ref: 6f75991258
Ref: library/io io RawIOBase write5991596
Ref: 1f315991596
Ref: library/io io BufferedIOBase5992232
Ref: 57d5992232
Ref: library/io io BufferedIOBase raw5993449
Ref: 1f335993449
Ref: library/io io BufferedIOBase detach5993719
Ref: 1f345993719
Ref: library/io io BufferedIOBase read5994153
Ref: 1c915994153
Ref: library/io io BufferedIOBase read15994958
Ref: 1c905994958
Ref: library/io io BufferedIOBase readinto5995438
Ref: 1f325995438
Ref: library/io io BufferedIOBase readinto15995969
Ref: 6f55995969
Ref: library/io io BufferedIOBase write5996461
Ref: 57e5996461
Node: Raw File I/O5997278
Ref: library/io raw-file-i-o5997392
Ref: 1f355997392
Ref: library/io io FileIO5997437
Ref: c975997437
Ref: library/io io FileIO mode5999828
Ref: 1f365999828
Ref: library/io io FileIO name5999903
Ref: 1d275999903
Node: Buffered Streams6000048
Ref: library/io buffered-streams6000157
Ref: 1f376000157
Ref: library/io io BytesIO6000303
Ref: 78f6000303
Ref: library/io io BytesIO getbuffer6000785
Ref: b606000785
Ref: library/io io BytesIO getvalue6001352
Ref: 1c8e6001352
Ref: library/io io BytesIO read16001474
Ref: 1f386001474
Ref: library/io io BytesIO readinto16001653
Ref: 1f396001653
Ref: library/io io BufferedReader6001804
Ref: b7d6001804
Ref: library/io io BufferedReader peek6002603
Ref: 1f3a6002603
Ref: library/io io BufferedReader read6002874
Ref: 1f3b6002874
Ref: library/io io BufferedReader read16003070
Ref: 1f3c6003070
Ref: library/io io BufferedWriter6003404
Ref: 15386003404
Ref: library/io io BufferedWriter flush6004477
Ref: 1f3d6004477
Ref: library/io io BufferedWriter write6004661
Ref: 1f3e6004661
Ref: library/io io BufferedRandom6004948
Ref: 15396004948
Ref: library/io io BufferedRWPair6005555
Ref: 1f296005555
Node: Text I/O<2>6006495
Ref: library/io id16006583
Ref: 1f3f6006583
Ref: library/io io TextIOBase6006622
Ref: c2c6006622
Ref: library/io io TextIOBase encoding6006965
Ref: 1f406006965
Ref: library/io io TextIOBase errors6007125
Ref: 1f416007125
Ref: library/io io TextIOBase newlines6007209
Ref: 1f426007209
Ref: library/io io TextIOBase buffer6007453
Ref: c2d6007453
Ref: library/io io TextIOBase detach6007726
Ref: 1f436007726
Ref: library/io io TextIOBase read6008241
Ref: 1f446008241
Ref: library/io io TextIOBase readline6008446
Ref: 1b366008446
Ref: library/io io TextIOBase seek6008709
Ref: 1f456008709
Ref: library/io io TextIOBase tell6009677
Ref: 1f466009677
Ref: library/io io TextIOBase write6009881
Ref: 1f476009881
Ref: library/io io TextIOWrapper6010010
Ref: 5e86010010
Ref: library/io io TextIOWrapper line_buffering6013434
Ref: 1f496013434
Ref: library/io io TextIOWrapper write_through6013516
Ref: 1f4a6013516
Ref: library/io io TextIOWrapper reconfigure6013674
Ref: 3926013674
Ref: library/io io StringIO6014449
Ref: 8216014449
Ref: library/io io StringIO getvalue6015333
Ref: 1f4b6015333
Ref: library/io io IncrementalNewlineDecoder6015981
Ref: 1f4c6015981
Node: Performance<3>6016163
Ref: library/io performance6016280
Ref: 1f4d6016280
Node: Binary I/O<2>6016529
Ref: library/io id26016613
Ref: 1f4e6016613
Node: Text I/O<3>6017265
Ref: library/io id36017376
Ref: 1f4f6017376
Node: Multi-threading<3>6017953
Ref: library/io multi-threading6018061
Ref: 1f506018061
Node: Reentrancy6018594
Ref: library/io reentrancy6018682
Ref: 1f516018682
Node: time — Time access and conversions6019474
Ref: library/time doc6019711
Ref: 1f526019711
Ref: library/time module-time6019711
Ref: 10a6019711
Ref: library/time time-time-access-and-conversions6019711
Ref: 1f536019711
Ref: library/time epoch6020411
Ref: 1f546020411
Ref: time — Time access and conversions-Footnote-16024784
Node: Functions<2>6024834
Ref: library/time functions6024946
Ref: 1f556024946
Ref: library/time time-functions6024946
Ref: 1f566024946
Ref: library/time time asctime6024985
Ref: b566024985
Ref: library/time time pthread_getcpuclockid6025653
Ref: 3f06025653
Ref: library/time time clock_getres6026260
Ref: aa76026260
Ref: library/time time clock_gettime6026535
Ref: aa86026535
Ref: library/time time clock_gettime_ns6026803
Ref: 3136026803
Ref: library/time time clock_settime6027003
Ref: aa96027003
Ref: library/time time clock_settime_ns6027262
Ref: 3146027262
Ref: library/time time ctime6027465
Ref: 17f06027465
Ref: library/time time get_clock_info6028032
Ref: aa66028032
Ref: library/time time gmtime6029208
Ref: b326029208
Ref: library/time time localtime6029687
Ref: 17ea6029687
Ref: library/time time mktime6029976
Ref: b576029976
Ref: library/time time monotonic6030686
Ref: 7636030686
Ref: library/time time monotonic_ns6031166
Ref: 3156031166
Ref: library/time time perf_counter6031308
Ref: 2a86031308
Ref: library/time time perf_counter_ns6031757
Ref: 3166031757
Ref: library/time time process_time6031910
Ref: 2a96031910
Ref: library/time time process_time_ns6032334
Ref: 3176032334
Ref: library/time time sleep6032487
Ref: 6746032487
Ref: library/time time strftime6033249
Ref: b586033249
Ref: library/time time strptime6040329
Ref: d846040329
Ref: library/time time struct_time6042065
Ref: 58e6042065
Ref: library/time time time6044826
Ref: 3126044826
Ref: library/time time thread_time6046125
Ref: 3ee6046125
Ref: library/time time thread_time_ns6046683
Ref: 3ef6046683
Ref: library/time time time_ns6046834
Ref: 3186046834
Ref: library/time time tzset6047021
Ref: 1f5a6047021
Ref: Functions<2>-Footnote-16050940
Ref: Functions<2>-Footnote-26050989
Ref: Functions<2>-Footnote-36051039
Ref: Functions<2>-Footnote-46051088
Ref: Functions<2>-Footnote-56051725
Ref: Functions<2>-Footnote-66051775
Node: Clock ID Constants6051823
Ref: library/time clock-id-constants6051962
Ref: 1f5b6051962
Ref: library/time time-clock-id-constants6051962
Ref: 1f586051962
Ref: library/time time CLOCK_BOOTTIME6052122
Ref: 3ea6052122
Ref: library/time time CLOCK_HIGHRES6052605
Ref: 1f5c6052605
Ref: library/time time CLOCK_MONOTONIC6052931
Ref: 3eb6052931
Ref: library/time time CLOCK_MONOTONIC_RAW6053133
Ref: 1f5d6053133
Ref: library/time time CLOCK_PROCESS_CPUTIME_ID6053419
Ref: 1f5e6053419
Ref: library/time time CLOCK_PROF6053579
Ref: 3ec6053579
Ref: library/time time CLOCK_THREAD_CPUTIME_ID6053756
Ref: 1f5f6053756
Ref: library/time time CLOCK_UPTIME6053899
Ref: 3ed6053899
Ref: library/time time CLOCK_UPTIME_RAW6054186
Ref: 2376054186
Ref: library/time time CLOCK_REALTIME6054584
Ref: 1f596054584
Node: Timezone Constants6054773
Ref: library/time time-timezone-constants6054891
Ref: 1f606054891
Ref: library/time timezone-constants6054891
Ref: 1f616054891
Ref: library/time time altzone6054948
Ref: 1f626054948
Ref: library/time time daylight6055236
Ref: 1f636055236
Ref: library/time time timezone6055322
Ref: 1f646055322
Ref: library/time time tzname6055520
Ref: 1f656055520
Node: argparse — Parser for command-line options arguments and sub-commands6056705
Ref: library/argparse doc6056950
Ref: 1f666056950
Ref: library/argparse argparse-parser-for-command-line-options-arguments-and-sub-commands6056950
Ref: 1f676056950
Ref: library/argparse module-argparse6056950
Ref: 66056950
Ref: argparse — Parser for command-line options arguments and sub-commands-Footnote-16058050
Node: Example<7>6058117
Ref: library/argparse example6058266
Ref: 1f696058266
Node: Creating a parser6059783
Ref: library/argparse creating-a-parser6059872
Ref: 1f6a6059872
Node: Adding arguments6060235
Ref: library/argparse adding-arguments6060350
Ref: 1f6b6060350
Node: Parsing arguments6061477
Ref: library/argparse parsing-arguments6061566
Ref: 1f6e6061566
Node: ArgumentParser objects6062291
Ref: library/argparse argumentparser-objects6062472
Ref: 1f706062472
Ref: library/argparse argparse ArgumentParser6062537
Ref: 6896062537
Node: prog6064985
Ref: library/argparse prog6065062
Ref: 1f716065062
Node: usage6066809
Ref: library/argparse usage6066906
Ref: 1f726066906
Node: description6067986
Ref: library/argparse description6068085
Ref: 1f736068085
Node: epilog6068823
Ref: library/argparse epilog6068924
Ref: 1f746068924
Node: parents6069663
Ref: library/argparse parents6069768
Ref: 1f756069768
Node: formatter_class6071177
Ref: library/argparse formatter-class6071288
Ref: 1f766071288
Ref: library/argparse argparse RawDescriptionHelpFormatter6071506
Ref: 1f7c6071506
Ref: library/argparse argparse RawTextHelpFormatter6071554
Ref: 1f7d6071554
Ref: library/argparse argparse ArgumentDefaultsHelpFormatter6071595
Ref: 1f7e6071595
Ref: library/argparse argparse MetavarTypeHelpFormatter6071645
Ref: 1f7f6071645
Node: prefix_chars6074887
Ref: library/argparse prefix-chars6075012
Ref: 1f776075012
Node: fromfile_prefix_chars6075730
Ref: library/argparse fromfile-prefix-chars6075856
Ref: 1f786075856
Node: argument_default6077106
Ref: library/argparse argument-default6077232
Ref: 1f796077232
Node: allow_abbrev6078089
Ref: library/argparse allow-abbrev6078210
Ref: 68b6078210
Ref: library/argparse id16078210
Ref: 1f846078210
Node: conflict_handler6078836
Ref: library/argparse conflict-handler6078949
Ref: 1f7a6078949
Node: add_help6080442
Ref: library/argparse add-help6080534
Ref: 1f7b6080534
Node: The add_argument method6082032
Ref: library/argparse the-add-argument-method6082224
Ref: 1f856082224
Ref: library/argparse argparse ArgumentParser add_argument6082297
Ref: 1f6c6082297
Node: name or flags6084087
Ref: library/argparse name-or-flags6084175
Ref: 1f866084175
Node: action6085279
Ref: library/argparse action6085381
Ref: 1f876085381
Node: nargs6090628
Ref: library/argparse nargs6090722
Ref: 1f886090722
Ref: library/argparse argparse-remainder6094180
Ref: 1f906094180
Node: const6094952
Ref: library/argparse const6095047
Ref: 1f896095047
Node: default6096242
Ref: library/argparse default6096336
Ref: 1f8a6096336
Node: type6098159
Ref: library/argparse type6098255
Ref: 1f806098255
Node: choices6100745
Ref: library/argparse choices6100842
Ref: 1f8b6100842
Node: required6102267
Ref: library/argparse required6102364
Ref: 1f8c6102364
Node: help6103300
Ref: library/argparse help6103397
Ref: 1f8d6103397
Node: metavar6105389
Ref: library/argparse metavar6105482
Ref: 1f8e6105482
Node: dest6107574
Ref: library/argparse dest6107677
Ref: 1f816107677
Node: Action classes6109252
Ref: library/argparse action-classes6109339
Ref: 1f916109339
Ref: library/argparse argparse Action6109621
Ref: 1f8f6109621
Node: The parse_args method6111409
Ref: library/argparse the-parse-args-method6111594
Ref: 1f926111594
Ref: library/argparse argparse ArgumentParser parse_args6111663
Ref: 1f6d6111663
Node: Option value syntax6112539
Ref: library/argparse option-value-syntax6112642
Ref: 1f956112642
Node: Invalid arguments6113974
Ref: library/argparse invalid-arguments6114108
Ref: 1f966114108
Node: Arguments containing -6115023
Ref: library/argparse arguments-containing6115176
Ref: 1f976115176
Node: Argument abbreviations prefix matching6117066
Ref: library/argparse argument-abbreviations-prefix-matching6117217
Ref: 1f986117217
Ref: library/argparse prefix-matching6117217
Ref: 68a6117217
Node: Beyond sys argv6118100
Ref: library/argparse args6118249
Ref: 1f936118249
Ref: library/argparse beyond-sys-argv6118249
Ref: 1f996118249
Node: The Namespace object6119149
Ref: library/argparse namespace6119251
Ref: 1f946119251
Ref: library/argparse the-namespace-object6119251
Ref: 1f9a6119251
Ref: library/argparse argparse Namespace6119314
Ref: 1f6f6119314
Node: Other utilities6120278
Ref: library/argparse other-utilities6120463
Ref: 1f9b6120463
Node: Sub-commands6120735
Ref: library/argparse sub-commands6120824
Ref: 1f9c6120824
Ref: library/argparse argparse ArgumentParser add_subparsers6120871
Ref: 49a6120871
Node: FileType objects6128865
Ref: library/argparse filetype-objects6128978
Ref: 1f9d6128978
Ref: library/argparse argparse FileType6129033
Ref: 8146129033
Node: Argument groups6130413
Ref: library/argparse argument-groups6130530
Ref: 1f9e6130530
Ref: library/argparse argparse ArgumentParser add_argument_group6130583
Ref: 1f9f6130583
Node: Mutual exclusion6132488
Ref: library/argparse mutual-exclusion6132604
Ref: 1fa06132604
Ref: library/argparse argparse ArgumentParser add_mutually_exclusive_group6132659
Ref: 1fa16132659
Node: Parser defaults6134094
Ref: library/argparse parser-defaults6134208
Ref: 1fa26134208
Ref: library/argparse argparse ArgumentParser set_defaults6134261
Ref: 1f836134261
Ref: library/argparse argparse ArgumentParser get_default6135305
Ref: 1fa36135305
Node: Printing help6135632
Ref: library/argparse printing-help6135745
Ref: 1fa46135745
Ref: library/argparse argparse ArgumentParser print_usage6135974
Ref: 1fa56135974
Ref: library/argparse argparse ArgumentParser print_help6136206
Ref: 1fa66136206
Ref: library/argparse argparse ArgumentParser format_usage6136560
Ref: 1fa76136560
Ref: library/argparse argparse ArgumentParser format_help6136739
Ref: 1fa86136739
Node: Partial parsing6136952
Ref: library/argparse partial-parsing6137074
Ref: 1fa96137074
Ref: library/argparse argparse ArgumentParser parse_known_args6137127
Ref: 1faa6137127
Node: Customizing file parsing6138146
Ref: library/argparse customizing-file-parsing6138270
Ref: 1fab6138270
Ref: library/argparse argparse ArgumentParser convert_arg_line_to_args6138341
Ref: 1f826138341
Node: Exiting methods6139226
Ref: library/argparse exiting-methods6139353
Ref: 1fac6139353
Ref: library/argparse argparse ArgumentParser exit6139406
Ref: 1fad6139406
Ref: library/argparse argparse ArgumentParser error6139898
Ref: 1fae6139898
Node: Intermixed parsing6140086
Ref: library/argparse intermixed-parsing6140180
Ref: 1faf6140180
Ref: library/argparse argparse ArgumentParser parse_intermixed_args6140239
Ref: 33a6140239
Ref: library/argparse argparse ArgumentParser parse_known_intermixed_args6140327
Ref: 1fb06140327
Node: Upgrading optparse code6141825
Ref: library/argparse id26141980
Ref: 1fb16141980
Ref: library/argparse upgrading-optparse-code6141980
Ref: b1c6141980
Node: getopt — C-style parser for command line options6144478
Ref: library/getopt doc6144726
Ref: 1fb46144726
Ref: library/getopt getopt-c-style-parser-for-command-line-options6144726
Ref: 1fb56144726
Ref: library/getopt module-getopt6144726
Ref: 876144726
Ref: library/getopt getopt getopt6145738
Ref: 1fb66145738
Ref: library/getopt getopt gnu_getopt6147925
Ref: 1fb86147925
Ref: library/getopt getopt GetoptError6148505
Ref: 1fb76148505
Ref: library/getopt getopt error6149085
Ref: 1fb96149085
Ref: getopt — C-style parser for command line options-Footnote-16151292
Node: logging — Logging facility for Python6151357
Ref: library/logging doc6151574
Ref: 1fba6151574
Ref: library/logging logging-logging-facility-for-python6151574
Ref: 1fbb6151574
Ref: library/logging module-logging6151574
Ref: aa6151574
Ref: logging — Logging facility for Python-Footnote-16153343
Node: Logger Objects6153419
Ref: library/logging logger6153532
Ref: 1fbc6153532
Ref: library/logging logger-objects6153532
Ref: 1fbd6153532
Ref: library/logging logging Logger6154625
Ref: 39c6154625
Ref: library/logging logging Logger propagate6154652
Ref: 1fbf6154652
Ref: library/logging logging Logger setLevel6155941
Ref: 1fc06155941
Ref: library/logging logging Logger isEnabledFor6157903
Ref: 1fc36157903
Ref: library/logging logging Logger getEffectiveLevel6158246
Ref: 1fc26158246
Ref: library/logging logging Logger getChild6158717
Ref: c7e6158717
Ref: library/logging logging Logger debug6159216
Ref: 7046159216
Ref: library/logging logging Logger info6164246
Ref: 1fc66164246
Ref: library/logging logging Logger warning6164425
Ref: 1fc86164425
Ref: library/logging logging Logger error6164831
Ref: 1fc96164831
Ref: library/logging logging Logger critical6165012
Ref: 7036165012
Ref: library/logging logging Logger log6165199
Ref: 7016165199
Ref: library/logging logging Logger exception6165395
Ref: 7026165395
Ref: library/logging logging Logger addFilter6165710
Ref: 1fca6165710
Ref: library/logging logging Logger removeFilter6165809
Ref: 1fcb6165809
Ref: library/logging logging Logger filter6165916
Ref: 1fcc6165916
Ref: library/logging logging Logger addHandler6166353
Ref: 1fcd6166353
Ref: library/logging logging Logger removeHandler6166450
Ref: 1fce6166450
Ref: library/logging logging Logger findCaller6166555
Ref: 1fcf6166555
Ref: library/logging logging Logger handle6167357
Ref: 1fd06167357
Ref: library/logging logging Logger makeRecord6167756
Ref: 1fd16167756
Ref: library/logging logging Logger hasHandlers6168018
Ref: 1fd26168018
Node: Logging Levels6168637
Ref: library/logging levels6168774
Ref: 1fc16168774
Ref: library/logging logging-levels6168774
Ref: 1fd36168774
Node: Handler Objects6169644
Ref: library/logging handler6169784
Ref: 1fd46169784
Ref: library/logging handler-objects6169784
Ref: 1fd56169784
Ref: library/logging logging Handler6170110
Ref: 1fc56170110
Ref: library/logging logging Handler __init__6170138
Ref: 1fd66170138
Ref: library/logging logging Handler createLock6170433
Ref: 1fd76170433
Ref: library/logging logging Handler acquire6170621
Ref: 1fd86170621
Ref: library/logging logging Handler release6170735
Ref: 1fd96170735
Ref: library/logging logging Handler setLevel6170837
Ref: 1fda6170837
Ref: library/logging logging Handler setFormatter6171409
Ref: 1fdb6171409
Ref: library/logging logging Handler addFilter6171516
Ref: 1fdc6171516
Ref: library/logging logging Handler removeFilter6171616
Ref: 1fdd6171616
Ref: library/logging logging Handler filter6171724
Ref: 1fde6171724
Ref: library/logging logging Handler flush6172123
Ref: 1fdf6172123
Ref: library/logging logging Handler close6172291
Ref: 1fe06172291
Ref: library/logging logging Handler handle6172649
Ref: 1fe26172649
Ref: library/logging logging Handler handleError6172927
Ref: 1fe36172927
Ref: library/logging logging Handler format6173715
Ref: 1fe56173715
Ref: library/logging logging Handler emit6173883
Ref: 1fe46173883
Node: Formatter Objects6174197
Ref: library/logging formatter-objects6174337
Ref: 1fe66174337
Ref: library/logging id16174337
Ref: 1fe76174337
Ref: library/logging logging Formatter6175502
Ref: 1fc46175502
Ref: library/logging logging Formatter format6176660
Ref: 1feb6176660
Ref: library/logging logging Formatter formatTime6178074
Ref: 1fe96178074
Ref: library/logging logging Formatter formatException6180371
Ref: 1fec6180371
Ref: library/logging logging Formatter formatStack6180710
Ref: 1fed6180710
Node: Filter Objects6181002
Ref: library/logging filter6181144
Ref: 1fef6181144
Ref: library/logging filter-objects6181144
Ref: 1ff06181144
Ref: library/logging logging Filter6181658
Ref: b6a6181658
Ref: library/logging logging Filter filter6181948
Ref: 1ff16181948
Node: LogRecord Objects6183929
Ref: library/logging log-record6184074
Ref: 1ff46184074
Ref: library/logging logrecord-objects6184074
Ref: 1ff56184074
Ref: library/logging logging LogRecord6184367
Ref: 8fa6184367
Ref: library/logging logging LogRecord getMessage6186194
Ref: 1ff76186194
Node: LogRecord attributes6187642
Ref: library/logging id26187794
Ref: 1ffa6187794
Ref: library/logging logrecord-attributes6187794
Ref: 1fe86187794
Node: LoggerAdapter Objects6195744
Ref: library/logging logger-adapter6195892
Ref: 1ffc6195892
Ref: library/logging loggeradapter-objects6195892
Ref: 1ffd6195892
Ref: library/logging logging LoggerAdapter6196172
Ref: c7f6196172
Ref: library/logging logging LoggerAdapter process6196365
Ref: 1fff6196365
Node: Thread Safety6197577
Ref: library/logging thread-safety6197727
Ref: 20006197727
Node: Module-Level Functions6198386
Ref: library/logging module-level-functions6198538
Ref: 20016198538
Ref: library/logging logging getLogger6198696
Ref: 1fbe6198696
Ref: library/logging logging getLoggerClass6199284
Ref: 20026199284
Ref: library/logging logging getLogRecordFactory6199752
Ref: 1ff86199752
Ref: library/logging logging debug6200211
Ref: 1fc76200211
Ref: library/logging logging info6204028
Ref: 1ff26204028
Ref: library/logging logging warning6204206
Ref: 20046204206
Ref: library/logging logging error6204598
Ref: 20056204598
Ref: library/logging logging critical6204778
Ref: 20066204778
Ref: library/logging logging exception6204964
Ref: 20076204964
Ref: library/logging logging log6205271
Ref: 20086205271
Ref: library/logging logging disable6206199
Ref: 20096206199
Ref: library/logging logging addLevelName6207415
Ref: 200a6207415
Ref: library/logging logging getLevelName6208073
Ref: 200c6208073
Ref: library/logging logging makeLogRecord6209400
Ref: 1ff66209400
Ref: library/logging logging basicConfig6209765
Ref: 1de6209765
Ref: library/logging logging shutdown6213977
Ref: 1fe16213977
Ref: library/logging logging setLoggerClass6214419
Ref: 20036214419
Ref: library/logging logging setLogRecordFactory6215053
Ref: 1ff96215053
Node: Module-Level Attributes6216350
Ref: library/logging module-level-attributes6216525
Ref: 200d6216525
Ref: library/logging logging lastResort6216594
Ref: b696216594
Node: Integration with the warnings module6217203
Ref: library/logging integration-with-the-warnings-module6217347
Ref: 200e6217347
Ref: library/logging logging captureWarnings6217569
Ref: 200f6217569
Ref: Integration with the warnings module-Footnote-16218953
Ref: Integration with the warnings module-Footnote-26219002
Node: logging config — Logging configuration6219055
Ref: library/logging config doc6219259
Ref: 20106219259
Ref: library/logging config logging-config-logging-configuration6219259
Ref: 20116219259
Ref: library/logging config module-logging config6219259
Ref: ab6219259
Ref: logging config — Logging configuration-Footnote-16219879
Node: Configuration functions6219952
Ref: library/logging config configuration-functions6220092
Ref: 20126220092
Ref: library/logging config logging-config-api6220092
Ref: c7b6220092
Ref: library/logging config logging config dictConfig6220534
Ref: b1e6220534
Ref: library/logging config logging config fileConfig6222822
Ref: 39e6222822
Ref: library/logging config logging config listen6225052
Ref: 8666225052
Ref: library/logging config logging config stopListening6228390
Ref: 20166228390
Node: Configuration dictionary schema6228634
Ref: library/logging config configuration-dictionary-schema6228808
Ref: 20176228808
Ref: library/logging config logging-config-dictschema6228808
Ref: 20136228808
Node: Dictionary Schema Details6229746
Ref: library/logging config dictionary-schema-details6229873
Ref: 20196229873
Node: Incremental Configuration6234730
Ref: library/logging config incremental-configuration6234884
Ref: 201d6234884
Ref: library/logging config logging-config-dict-incremental6234884
Ref: 201c6234884
Node: Object connections6236329
Ref: library/logging config logging-config-dict-connections6236478
Ref: 20186236478
Ref: library/logging config object-connections6236478
Ref: 201e6236478
Node: User-defined objects6238798
Ref: library/logging config logging-config-dict-userdef6238948
Ref: 201a6238948
Ref: library/logging config user-defined-objects6238948
Ref: 201f6238948
Node: Access to external objects6242114
Ref: library/logging config access-to-external-objects6242272
Ref: 20206242272
Ref: library/logging config logging-config-dict-externalobj6242272
Ref: 20216242272
Node: Access to internal objects6243571
Ref: library/logging config access-to-internal-objects6243747
Ref: 20226243747
Ref: library/logging config logging-config-dict-internalobj6243747
Ref: 20236243747
Node: Import resolution and custom importers6247036
Ref: library/logging config import-resolution-and-custom-importers6247177
Ref: 20256247177
Ref: library/logging config logging-import-resolution6247177
Ref: 20266247177
Node: Configuration file format6248145
Ref: library/logging config configuration-file-format6248287
Ref: 20276248287
Ref: library/logging config logging-config-fileformat6248287
Ref: 20146248287
Node: logging handlers — Logging handlers6255682
Ref: library/logging handlers doc6255882
Ref: 20286255882
Ref: library/logging handlers logging-handlers-logging-handlers6255882
Ref: 20296255882
Ref: library/logging handlers module-logging handlers6255882
Ref: ac6255882
Ref: logging handlers — Logging handlers-Footnote-16256946
Node: StreamHandler6257022
Ref: library/logging handlers stream-handler6257129
Ref: 202b6257129
Ref: library/logging handlers streamhandler6257129
Ref: 202c6257129
Ref: library/logging handlers logging StreamHandler6257442
Ref: b686257442
Ref: library/logging handlers logging StreamHandler emit6257679
Ref: 202d6257679
Ref: library/logging handlers logging StreamHandler flush6258012
Ref: 202e6258012
Ref: library/logging handlers logging StreamHandler setStream6258305
Ref: 39d6258305
Node: FileHandler6259104
Ref: library/logging handlers file-handler6259231
Ref: 202f6259231
Ref: library/logging handlers filehandler6259231
Ref: 20306259231
Ref: library/logging handlers logging FileHandler6259465
Ref: 202a6259465
Ref: library/logging handlers logging FileHandler close6260115
Ref: 20326260115
Ref: library/logging handlers logging FileHandler emit6260170
Ref: 20316260170
Node: NullHandler6260245
Ref: library/logging handlers null-handler6260377
Ref: 20336260377
Ref: library/logging handlers nullhandler6260377
Ref: 20346260377
Ref: library/logging handlers logging NullHandler6260635
Ref: c0f6260635
Ref: library/logging handlers logging NullHandler emit6260734
Ref: 20356260734
Ref: library/logging handlers logging NullHandler handle6260803
Ref: 20366260803
Ref: library/logging handlers logging NullHandler createLock6260874
Ref: 20376260874
Node: WatchedFileHandler6261156
Ref: library/logging handlers watched-file-handler6261296
Ref: 20396261296
Ref: library/logging handlers watchedfilehandler6261296
Ref: 203a6261296
Ref: library/logging handlers logging handlers WatchedFileHandler6262311
Ref: 203b6262311
Ref: library/logging handlers logging handlers WatchedFileHandler reopenIfNeeded6262984
Ref: 5576262984
Ref: library/logging handlers logging handlers WatchedFileHandler emit6263275
Ref: 203c6263275
Node: BaseRotatingHandler6263443
Ref: library/logging handlers base-rotating-handler6263591
Ref: 203d6263591
Ref: library/logging handlers baserotatinghandler6263591
Ref: 203e6263591
Ref: library/logging handlers logging handlers BaseRotatingHandler6263978
Ref: 203f6263978
Ref: library/logging handlers logging handlers BaseRotatingHandler namer6264154
Ref: 20406264154
Ref: library/logging handlers logging handlers BaseRotatingHandler rotator6264781
Ref: 20426264781
Ref: library/logging handlers logging handlers BaseRotatingHandler rotation_filename6265064
Ref: 20416265064
Ref: library/logging handlers logging handlers BaseRotatingHandler rotate6265633
Ref: 20436265633
Node: RotatingFileHandler6266943
Ref: library/logging handlers rotating-file-handler6267097
Ref: 20456267097
Ref: library/logging handlers rotatingfilehandler6267097
Ref: 20466267097
Ref: library/logging handlers logging handlers RotatingFileHandler6267289
Ref: 201b6267289
Ref: library/logging handlers logging handlers RotatingFileHandler doRollover6269091
Ref: 20486269091
Ref: library/logging handlers logging handlers RotatingFileHandler emit6269171
Ref: 20476269171
Node: TimedRotatingFileHandler6269303
Ref: library/logging handlers timed-rotating-file-handler6269451
Ref: 20496269451
Ref: library/logging handlers timedrotatingfilehandler6269451
Ref: 204a6269451
Ref: library/logging handlers logging handlers TimedRotatingFileHandler6269684
Ref: 8626269684
Ref: library/logging handlers logging handlers TimedRotatingFileHandler doRollover6274664
Ref: 204c6274664
Ref: library/logging handlers logging handlers TimedRotatingFileHandler emit6274744
Ref: 204b6274744
Node: SocketHandler6274871
Ref: library/logging handlers socket-handler6275015
Ref: 204d6275015
Ref: library/logging handlers sockethandler6275015
Ref: 204e6275015
Ref: library/logging handlers logging handlers SocketHandler6275227
Ref: 8636275227
Ref: library/logging handlers logging handlers SocketHandler close6275634
Ref: 204f6275634
Ref: library/logging handlers logging handlers SocketHandler emit6275691
Ref: 20506275691
Ref: library/logging handlers logging handlers SocketHandler handleError6276126
Ref: 20516276126
Ref: library/logging handlers logging handlers SocketHandler makeSocket6276356
Ref: 20526276356
Ref: library/logging handlers logging handlers SocketHandler makePickle6276599
Ref: 20536276599
Ref: library/logging handlers logging handlers SocketHandler send6277379
Ref: 20546277379
Ref: library/logging handlers logging handlers SocketHandler createSocket6277700
Ref: 20556277700
Node: DatagramHandler6278900
Ref: library/logging handlers datagram-handler6279033
Ref: 20566279033
Ref: library/logging handlers datagramhandler6279033
Ref: 20576279033
Ref: library/logging handlers logging handlers DatagramHandler6279269
Ref: 8646279269
Ref: library/logging handlers logging handlers DatagramHandler emit6279680
Ref: 20586279680
Ref: library/logging handlers logging handlers DatagramHandler makeSocket6280034
Ref: 20596280034
Ref: library/logging handlers logging handlers DatagramHandler send6280220
Ref: 205a6280220
Node: SysLogHandler6280435
Ref: library/logging handlers syslog-handler6280572
Ref: 205b6280572
Ref: library/logging handlers sysloghandler6280572
Ref: 205c6280572
Ref: library/logging handlers logging handlers SysLogHandler6280778
Ref: a136280778
Ref: library/logging handlers logging handlers SysLogHandler close6282441
Ref: 205d6282441
Ref: library/logging handlers logging handlers SysLogHandler emit6282517
Ref: 205e6282517
Ref: library/logging handlers logging handlers SysLogHandler encodePriority6284399
Ref: 205f6284399
Ref: library/logging handlers logging handlers SysLogHandler mapPriority6288423
Ref: 20606288423
Ref: SysLogHandler-Footnote-16288913
Ref: SysLogHandler-Footnote-26288956
Ref: SysLogHandler-Footnote-36289005
Node: NTEventLogHandler6289048
Ref: library/logging handlers nt-eventlog-handler6289181
Ref: 20616289181
Ref: library/logging handlers nteventloghandler6289181
Ref: 20626289181
Ref: library/logging handlers logging handlers NTEventLogHandler6289516
Ref: 20636289516
Ref: library/logging handlers logging handlers NTEventLogHandler close6290577
Ref: 20646290577
Ref: library/logging handlers logging handlers NTEventLogHandler emit6290979
Ref: 20656290979
Ref: library/logging handlers logging handlers NTEventLogHandler getEventCategory6291137
Ref: 20666291137
Ref: library/logging handlers logging handlers NTEventLogHandler getEventType6291339
Ref: 20676291339
Ref: library/logging handlers logging handlers NTEventLogHandler getMessageID6291932
Ref: 20686291932
Node: SMTPHandler6292362
Ref: library/logging handlers smtp-handler6292495
Ref: 20696292495
Ref: library/logging handlers smtphandler6292495
Ref: 206a6292495
Ref: library/logging handlers logging handlers SMTPHandler6292692
Ref: 206b6292692
Ref: library/logging handlers logging handlers SMTPHandler emit6293945
Ref: 206c6293945
Ref: library/logging handlers logging handlers SMTPHandler getSubject6294049
Ref: 206d6294049
Node: MemoryHandler6294195
Ref: library/logging handlers memory-handler6294322
Ref: 206e6294322
Ref: library/logging handlers memoryhandler6294322
Ref: 206f6294322
Ref: library/logging handlers logging handlers BufferingHandler6295025
Ref: 20706295025
Ref: library/logging handlers logging handlers BufferingHandler emit6295221
Ref: 20716295221
Ref: library/logging handlers logging handlers BufferingHandler flush6295411
Ref: 20736295411
Ref: library/logging handlers logging handlers BufferingHandler shouldFlush6295564
Ref: 20726295564
Ref: library/logging handlers logging handlers MemoryHandler6295747
Ref: 20246295747
Ref: library/logging handlers logging handlers MemoryHandler close6296562
Ref: 20756296562
Ref: library/logging handlers logging handlers MemoryHandler flush6296690
Ref: 20766296690
Ref: library/logging handlers logging handlers MemoryHandler setTarget6296961
Ref: 20746296961
Ref: library/logging handlers logging handlers MemoryHandler shouldFlush6297051
Ref: 20776297051
Node: HTTPHandler6297177
Ref: library/logging handlers http-handler6297305
Ref: 20786297305
Ref: library/logging handlers httphandler6297305
Ref: 20796297305
Ref: library/logging handlers logging handlers HTTPHandler6297536
Ref: 7056297536
Ref: library/logging handlers logging handlers HTTPHandler mapLogRecord6298496
Ref: 207a6298496
Ref: library/logging handlers logging handlers HTTPHandler emit6298952
Ref: 207b6298952
Node: QueueHandler6299686
Ref: library/logging handlers queue-handler6299814
Ref: 207c6299814
Ref: library/logging handlers queuehandler6299814
Ref: 207d6299814
Ref: library/logging handlers logging handlers QueueHandler6300553
Ref: 207e6300553
Ref: library/logging handlers logging handlers QueueHandler emit6301050
Ref: 20806301050
Ref: library/logging handlers logging handlers QueueHandler prepare6301529
Ref: 20816301529
Ref: library/logging handlers logging handlers QueueHandler enqueue6302076
Ref: 207f6302076
Node: QueueListener6302322
Ref: library/logging handlers queue-listener6302430
Ref: 20826302430
Ref: library/logging handlers queuelistener6302430
Ref: 20836302430
Ref: library/logging handlers logging handlers QueueListener6303450
Ref: 7066303450
Ref: library/logging handlers logging handlers QueueListener dequeue6304502
Ref: 20846304502
Ref: library/logging handlers logging handlers QueueListener prepare6304783
Ref: 20856304783
Ref: library/logging handlers logging handlers QueueListener handle6305100
Ref: 20866305100
Ref: library/logging handlers logging handlers QueueListener start6305362
Ref: 20876305362
Ref: library/logging handlers logging handlers QueueListener stop6305525
Ref: 20886305525
Ref: library/logging handlers logging handlers QueueListener enqueue_sentinel6305836
Ref: 20896305836
Node: getpass — Portable password input6306333
Ref: library/getpass doc6306549
Ref: 208a6306549
Ref: library/getpass getpass-portable-password-input6306549
Ref: 208b6306549
Ref: library/getpass module-getpass6306549
Ref: 886306549
Ref: library/getpass getpass getpass6306799
Ref: 208c6306799
Ref: library/getpass getpass GetPassWarning6307648
Ref: 208d6307648
Ref: library/getpass getpass getuser6307776
Ref: 1e2b6307776
Ref: getpass — Portable password input-Footnote-16308363
Node: curses — Terminal handling for character-cell displays6308429
Ref: library/curses doc6308664
Ref: 208e6308664
Ref: library/curses curses-terminal-handling-for-character-cell-displays6308664
Ref: 208f6308664
Ref: library/curses module-curses6308664
Ref: 2c6308664
Ref: curses — Terminal handling for character-cell displays-Footnote-16310868
Node: Functions<3>6310931
Ref: library/curses curses-functions6311059
Ref: 20916311059
Ref: library/curses functions6311059
Ref: 20926311059
Ref: library/curses curses error6311163
Ref: 20936311163
Ref: library/curses curses baudrate6311525
Ref: 20946311525
Ref: library/curses curses beep6311877
Ref: 20956311877
Ref: library/curses curses can_change_color6311943
Ref: 20966311943
Ref: library/curses curses cbreak6312115
Ref: 20976312115
Ref: library/curses curses color_content6312593
Ref: 20996312593
Ref: library/curses curses color_pair6312972
Ref: 209a6312972
Ref: library/curses curses curs_set6313291
Ref: 209c6313291
Ref: library/curses curses def_prog_mode6313719
Ref: 209d6313719
Ref: library/curses curses def_shell_mode6314047
Ref: 209f6314047
Ref: library/curses curses delay_output6314393
Ref: 20a16314393
Ref: library/curses curses doupdate6314483
Ref: 20a26314483
Ref: library/curses curses echo6315308
Ref: 20a66315308
Ref: library/curses curses endwin6315444
Ref: 20a76315444
Ref: library/curses curses erasechar6315547
Ref: 20a86315547
Ref: library/curses curses filter6315815
Ref: 20a96315815
Ref: library/curses curses flash6316426
Ref: 20ab6316426
Ref: library/curses curses flushinp6316689
Ref: 20ac6316689
Ref: library/curses curses getmouse6316875
Ref: 20ad6316875
Ref: library/curses curses getsyx6317679
Ref: 20af6317679
Ref: library/curses curses getwin6317890
Ref: 20b16317890
Ref: library/curses curses has_colors6318126
Ref: 20b26318126
Ref: library/curses curses has_ic6318258
Ref: 20b36318258
Ref: library/curses curses has_il6318514
Ref: 20b46318514
Ref: library/curses curses has_key6318811
Ref: 20b56318811
Ref: library/curses curses halfdelay6318965
Ref: 20b66318965
Ref: library/curses curses init_color6319403
Ref: 20b86319403
Ref: library/curses curses init_pair6320051
Ref: 20b96320051
Ref: library/curses curses initscr6320700
Ref: 20aa6320700
Ref: library/curses curses is_term_resized6320975
Ref: 20bb6320975
Ref: library/curses curses isendwin6321146
Ref: 20bd6321146
Ref: library/curses curses keyname6321304
Ref: 20be6321304
Ref: library/curses curses killchar6321835
Ref: 20bf6321835
Ref: library/curses curses longname6322106
Ref: 20c06322106
Ref: library/curses curses meta6322381
Ref: 20c16322381
Ref: library/curses curses mouseinterval6322538
Ref: 20c26322538
Ref: library/curses curses mousemask6322837
Ref: 20c36322837
Ref: library/curses curses napms6323257
Ref: 20c46323257
Ref: library/curses curses newpad6323325
Ref: 20c56323325
Ref: library/curses curses newwin6324413
Ref: 20c66324413
Ref: library/curses curses nl6324780
Ref: 20c76324780
Ref: library/curses curses nocbreak6324995
Ref: 20b76324995
Ref: library/curses curses noecho6325116
Ref: 20c86325116
Ref: library/curses curses nonl6325215
Ref: 20c96325215
Ref: library/curses curses noqiflush6325708
Ref: 20ca6325708
Ref: library/curses curses noraw6326098
Ref: 20cb6326098
Ref: library/curses curses pair_content6326213
Ref: 20cc6326213
Ref: library/curses curses pair_number6326439
Ref: 209b6326439
Ref: library/curses curses putp6326631
Ref: 20cd6326631
Ref: library/curses curses qiflush6326877
Ref: 20ce6326877
Ref: library/curses curses raw6327143
Ref: 20986327143
Ref: library/curses curses reset_prog_mode6327385
Ref: 209e6327385
Ref: library/curses curses reset_shell_mode6327533
Ref: 20a06327533
Ref: library/curses curses resetty6327681
Ref: 20cf6327681
Ref: library/curses curses resize_term6327823
Ref: 20bc6327823
Ref: library/curses curses resizeterm6328362
Ref: 20d16328362
Ref: library/curses curses savetty6328635
Ref: 20d06328635
Ref: library/curses curses setsyx6328770
Ref: 20d26328770
Ref: library/curses curses setupterm6328940
Ref: 20d36328940
Ref: library/curses curses start_color6329357
Ref: 20d46329357
Ref: library/curses curses termattrs6330037
Ref: 20d56330037
Ref: library/curses curses termname6330267
Ref: 20d66330267
Ref: library/curses curses tigetflag6330416
Ref: 20d76330416
Ref: library/curses curses tigetnum6330732
Ref: 20d86330732
Ref: library/curses curses tigetstr6331048
Ref: 20d96331048
Ref: library/curses curses tparm6331358
Ref: 20da6331358
Ref: library/curses curses typeahead6331695
Ref: 20db6331695
Ref: library/curses curses unctrl6332288
Ref: 20dc6332288
Ref: library/curses curses ungetch6332569
Ref: 20dd6332569
Ref: library/curses curses update_lines_cols6332746
Ref: 6ba6332746
Ref: library/curses curses unget_wch6332905
Ref: 9d46332905
Ref: library/curses curses ungetmouse6333123
Ref: 20de6333123
Ref: library/curses curses use_env6333282
Ref: 20df6333282
Ref: library/curses curses use_default_colors6333792
Ref: 20e06333792
Ref: library/curses curses wrapper6334225
Ref: 29f6334225
Node: Window Objects6335036
Ref: library/curses curses-window-objects6335185
Ref: 20ba6335185
Ref: library/curses window-objects6335185
Ref: 20e16335185
Ref: library/curses curses window addch6335367
Ref: 20e26335367
Ref: library/curses curses window addnstr6335970
Ref: 20e36335970
Ref: library/curses curses window addstr6336229
Ref: 20a46336229
Ref: library/curses curses window attroff6337229
Ref: 20e46337229
Ref: library/curses curses window attron6337374
Ref: 20e56337374
Ref: library/curses curses window attrset6337515
Ref: 20e66337515
Ref: library/curses curses window bkgd6337663
Ref: 20e76337663
Ref: library/curses curses window bkgdset6338108
Ref: 20e86338108
Ref: library/curses curses window border6338674
Ref: 20e96338674
Ref: library/curses curses window box6340626
Ref: 20ea6340626
Ref: library/curses curses window chgat6340854
Ref: 20eb6340854
Ref: library/curses curses window clear6341478
Ref: 20ed6341478
Ref: library/curses curses window clearok6341633
Ref: 20ef6341633
Ref: library/curses curses window clrtobot6341778
Ref: 20f06341778
Ref: library/curses curses window clrtoeol6341975
Ref: 20f16341975
Ref: library/curses curses window cursyncup6342055
Ref: 20f26342055
Ref: library/curses curses window delch6342223
Ref: 20f36342223
Ref: library/curses curses window deleteln6342302
Ref: 20f46342302
Ref: library/curses curses window derwin6342426
Ref: 20f56342426
Ref: library/curses curses window echochar6342836
Ref: 20f76342836
Ref: library/curses curses window enclose6342990
Ref: 20f86342990
Ref: library/curses curses window encoding6343294
Ref: 9d26343294
Ref: library/curses curses window erase6343678
Ref: 20ee6343678
Ref: library/curses curses window getbegyx6343731
Ref: 20f96343731
Ref: library/curses curses window getbkgd6343835
Ref: 20fa6343835
Ref: library/curses curses window getch6343950
Ref: 20ae6343950
Ref: library/curses curses window get_wch6344270
Ref: 9d36344270
Ref: library/curses curses window getkey6344536
Ref: 20fb6344536
Ref: library/curses curses window getmaxyx6344844
Ref: 20fc6344844
Ref: library/curses curses window getparyx6344949
Ref: 20fd6344949
Ref: library/curses curses window getstr6345153
Ref: 20fe6345153
Ref: library/curses curses window getyx6345369
Ref: 20ff6345369
Ref: library/curses curses window hline6345510
Ref: 21006345510
Ref: library/curses curses window idcok6345696
Ref: 21016345696
Ref: library/curses curses window idlok6346042
Ref: 21026346042
Ref: library/curses curses window immedok6346235
Ref: 21036346235
Ref: library/curses curses window inch6346584
Ref: 21046346584
Ref: library/curses curses window insch6346772
Ref: 21056346772
Ref: library/curses curses window insdelln6346986
Ref: 21066346986
Ref: library/curses curses window insertln6347365
Ref: 21076347365
Ref: library/curses curses window insnstr6347495
Ref: 21086347495
Ref: library/curses curses window insstr6348008
Ref: 21096348008
Ref: library/curses curses window instr6348427
Ref: 210a6348427
Ref: library/curses curses window is_linetouched6348823
Ref: 210b6348823
Ref: library/curses curses window is_wintouched6349106
Ref: 210c6349106
Ref: library/curses curses window keypad6349286
Ref: 210d6349286
Ref: library/curses curses window leaveok6349554
Ref: 20b06349554
Ref: library/curses curses window move6349905
Ref: 210e6349905
Ref: library/curses curses window mvderwin6349988
Ref: 210f6349988
Ref: library/curses curses window mvwin6350265
Ref: 21106350265
Ref: library/curses curses window nodelay6350381
Ref: 21116350381
Ref: library/curses curses window notimeout6350490
Ref: 21126350490
Ref: library/curses curses window noutrefresh6350754
Ref: 20a36350754
Ref: library/curses curses window overlay6351028
Ref: 21136351028
Ref: library/curses curses window overwrite6351677
Ref: 21146351677
Ref: library/curses curses window putwin6352329
Ref: 21156352329
Ref: library/curses curses window redrawln6352535
Ref: 21166352535
Ref: library/curses curses window redrawwin6352741
Ref: 21176352741
Ref: library/curses curses window refresh6352887
Ref: 20a56352887
Ref: library/curses curses window resize6353908
Ref: 21186353908
Ref: library/curses curses window scroll6354260
Ref: 21196354260
Ref: library/curses curses window scrollok6354368
Ref: 211a6354368
Ref: library/curses curses window setscrreg6354904
Ref: 211b6354904
Ref: library/curses curses window standend6355073
Ref: 211c6355073
Ref: library/curses curses window standout6355224
Ref: 211d6355224
Ref: library/curses curses window subpad6355294
Ref: 211e6355294
Ref: library/curses curses window subwin6355533
Ref: 20f66355533
Ref: library/curses curses window syncdown6355891
Ref: 211f6355891
Ref: library/curses curses window syncok6356137
Ref: 21206356137
Ref: library/curses curses window syncup6356300
Ref: 21216356300
Ref: library/curses curses window timeout6356426
Ref: 21226356426
Ref: library/curses curses window touchline6356929
Ref: 20ec6356929
Ref: library/curses curses window touchwin6357237
Ref: 21236357237
Ref: library/curses curses window untouchwin6357362
Ref: 21246357362
Ref: library/curses curses window vline6357495
Ref: 21256357495
Ref: Window Objects-Footnote-16357715
Node: Constants<6>6357758
Ref: library/curses constants6357886
Ref: 21266357886
Ref: library/curses curses ERR6357993
Ref: 21276357993
Ref: library/curses curses OK6358138
Ref: 21286358138
Ref: library/curses curses version6358281
Ref: 21296358281
Ref: library/curses curses ncurses_version6358418
Ref: 1bd6358418
Node: curses textpad — Text input widget for curses programs6376977
Ref: library/curses curses-textpad-text-input-widget-for-curses-programs6377224
Ref: 212a6377224
Ref: library/curses module-curses textpad6377224
Ref: 2f6377224
Ref: library/curses curses textpad rectangle6377814
Ref: 212c6377814
Node: Textbox objects6378537
Ref: library/curses curses-textpad-objects6378645
Ref: 212d6378645
Ref: library/curses textbox-objects6378645
Ref: 212e6378645
Ref: library/curses curses textpad Textbox6378761
Ref: 212b6378761
Ref: library/curses curses textpad Textbox edit6379240
Ref: 21306379240
Ref: library/curses curses textpad Textbox do_command6379811
Ref: 21316379811
Ref: library/curses curses textpad Textbox gather6383335
Ref: 21326383335
Ref: library/curses curses textpad Textbox stripspaces6383528
Ref: 212f6383528
Node: curses ascii — Utilities for ASCII characters6383939
Ref: library/curses ascii doc6384181
Ref: 21336384181
Ref: library/curses ascii curses-ascii-utilities-for-ascii-characters6384181
Ref: 21346384181
Ref: library/curses ascii module-curses ascii6384181
Ref: 2d6384181
Ref: library/curses ascii curses ascii isalnum6387863
Ref: 21356387863
Ref: library/curses ascii curses ascii isalpha6388010
Ref: 21366388010
Ref: library/curses ascii curses ascii isascii6388155
Ref: 21376388155
Ref: library/curses ascii curses ascii isblank6388264
Ref: 21386388264
Ref: library/curses ascii curses ascii iscntrl6388377
Ref: 21396388377
Ref: library/curses ascii curses ascii isdigit6388503
Ref: 213a6388503
Ref: library/curses ascii curses ascii isgraph6388667
Ref: 213b6388667
Ref: library/curses ascii curses ascii islower6388768
Ref: 213c6388768
Ref: library/curses ascii curses ascii isprint6388856
Ref: 213d6388856
Ref: library/curses ascii curses ascii ispunct6388960
Ref: 213e6388960
Ref: library/curses ascii curses ascii isspace6389103
Ref: 213f6389103
Ref: library/curses ascii curses ascii isupper6389271
Ref: 21406389271
Ref: library/curses ascii curses ascii isxdigit6389355
Ref: 21416389355
Ref: library/curses ascii curses ascii isctrl6389498
Ref: 21426389498
Ref: library/curses ascii curses ascii ismeta6389607
Ref: 21436389607
Ref: library/curses ascii curses ascii ascii6390207
Ref: 21446390207
Ref: library/curses ascii curses ascii ctrl6390314
Ref: 21456390314
Ref: library/curses ascii curses ascii alt6390482
Ref: 21466390482
Ref: library/curses ascii curses ascii unctrl6390754
Ref: 21476390754
Ref: library/curses ascii curses ascii controlnames6391309
Ref: 21486391309
Node: curses panel — A panel stack extension for curses6391555
Ref: library/curses panel doc6391804
Ref: 21496391804
Ref: library/curses panel curses-panel-a-panel-stack-extension-for-curses6391804
Ref: 214a6391804
Ref: library/curses panel module-curses panel6391804
Ref: 2e6391804
Node: Functions<4>6392282
Ref: library/curses panel cursespanel-functions6392404
Ref: 214b6392404
Ref: library/curses panel functions6392404
Ref: 214c6392404
Ref: library/curses panel curses panel bottom_panel6392514
Ref: 214d6392514
Ref: library/curses panel curses panel new_panel6392609
Ref: 214e6392609
Ref: library/curses panel curses panel top_panel6392911
Ref: 214f6392911
Ref: library/curses panel curses panel update_panels6393000
Ref: 21506393000
Node: Panel Objects6393211
Ref: library/curses panel curses-panel-objects6393333
Ref: 21516393333
Ref: library/curses panel panel-objects6393333
Ref: 21526393333
Ref: library/curses panel curses panel Panel above6393689
Ref: 21536393689
Ref: library/curses panel curses panel Panel below6393766
Ref: 21546393766
Ref: library/curses panel curses panel Panel bottom6393843
Ref: 21556393843
Ref: library/curses panel curses panel Panel hidden6393921
Ref: 21566393921
Ref: library/curses panel curses panel Panel hide6394041
Ref: 21576394041
Ref: library/curses panel curses panel Panel move6394175
Ref: 21586394175
Ref: library/curses panel curses panel Panel replace6394267
Ref: 21596394267
Ref: library/curses panel curses panel Panel set_userptr6394371
Ref: 215a6394371
Ref: library/curses panel curses panel Panel show6394565
Ref: 215b6394565
Ref: library/curses panel curses panel Panel top6394648
Ref: 215c6394648
Ref: library/curses panel curses panel Panel userptr6394716
Ref: 215d6394716
Ref: library/curses panel curses panel Panel window6394831
Ref: 215e6394831
Node: platform — Access to underlying platform’s identifying data6394919
Ref: library/platform doc6395160
Ref: 215f6395160
Ref: library/platform module-platform6395160
Ref: ce6395160
Ref: library/platform platform-access-to-underlying-platform-s-identifying-data6395160
Ref: 21606395160
Ref: platform — Access to underlying platform’s identifying data-Footnote-16395655
Node: Cross Platform6395722
Ref: library/platform cross-platform6395858
Ref: 21616395858
Ref: library/platform platform architecture6395909
Ref: f4e6395909
Ref: library/platform platform machine6397250
Ref: 21626397250
Ref: library/platform platform node6397406
Ref: 21636397406
Ref: library/platform platform platform6397581
Ref: f536397581
Ref: library/platform platform processor6398515
Ref: 21656398515
Ref: library/platform platform python_build6398836
Ref: 21666398836
Ref: library/platform platform python_compiler6398983
Ref: 21676398983
Ref: library/platform platform python_branch6399106
Ref: 21686399106
Ref: library/platform platform python_implementation6399220
Ref: 21696399220
Ref: library/platform platform python_revision6399424
Ref: 216a6399424
Ref: library/platform platform python_version6399547
Ref: 216b6399547
Ref: library/platform platform python_version_tuple6399796
Ref: 216c6399796
Ref: library/platform platform release6400076
Ref: 216d6400076
Ref: library/platform platform system6400251
Ref: 216e6400251
Ref: library/platform platform system_alias6400448
Ref: 21646400448
Ref: library/platform platform version6400731
Ref: 216f6400731
Ref: library/platform platform uname6400908
Ref: f516400908
Node: Java Platform6401601
Ref: library/platform java-platform6401762
Ref: 21706401762
Ref: library/platform platform java_ver6401811
Ref: 21716401811
Node: Windows Platform6402282
Ref: library/platform windows-platform6402444
Ref: 21726402444
Ref: library/platform platform win32_ver6402499
Ref: 21736402499
Ref: library/platform platform win32_edition6403458
Ref: 21746403458
Ref: library/platform platform win32_is_iot6403731
Ref: 21756403731
Node: Mac OS Platform6403923
Ref: library/platform mac-os-platform6404086
Ref: 21766404086
Ref: library/platform platform mac_ver6404139
Ref: f546404139
Node: Unix Platforms6404521
Ref: library/platform unix-platforms6404659
Ref: 21776404659
Ref: library/platform platform libc_ver6404710
Ref: f506404710
Node: errno — Standard errno system symbols6405327
Ref: library/errno doc6405565
Ref: 21786405565
Ref: library/errno errno-standard-errno-system-symbols6405565
Ref: 21796405565
Ref: library/errno module-errno6405565
Ref: 7c6405565
Ref: library/errno errno errorcode6405977
Ref: 217a6405977
Ref: library/errno errno EPERM6406498
Ref: 217b6406498
Ref: library/errno errno ENOENT6406551
Ref: 217c6406551
Ref: library/errno errno ESRCH6406607
Ref: 217d6406607
Ref: library/errno errno EINTR6406652
Ref: 64c6406652
Ref: library/errno errno EIO6406808
Ref: 217e6406808
Ref: library/errno errno ENXIO6406845
Ref: 217f6406845
Ref: library/errno errno E2BIG6406900
Ref: 21806406900
Ref: library/errno errno ENOEXEC6406947
Ref: 21816406947
Ref: library/errno errno EBADF6406996
Ref: 21826406996
Ref: library/errno errno ECHILD6407041
Ref: 21836407041
Ref: library/errno errno EAGAIN6407090
Ref: 1e746407090
Ref: library/errno errno ENOMEM6407130
Ref: 21846407130
Ref: library/errno errno EACCES6407174
Ref: 21856407174
Ref: library/errno errno EFAULT6407222
Ref: 21866407222
Ref: library/errno errno ENOTBLK6407264
Ref: 21876407264
Ref: library/errno errno EBUSY6407317
Ref: 21886407317
Ref: library/errno errno EEXIST6407370
Ref: 21896407370
Ref: library/errno errno EXDEV6407412
Ref: 1e4a6407412
Ref: library/errno errno ENODEV6407459
Ref: 218a6407459
Ref: library/errno errno ENOTDIR6407504
Ref: 218b6407504
Ref: library/errno errno EISDIR6407551
Ref: 218c6407551
Ref: library/errno errno EINVAL6407596
Ref: efb6407596
Ref: library/errno errno ENFILE6407643
Ref: 218d6407643
Ref: library/errno errno EMFILE6407693
Ref: 218e6407693
Ref: library/errno errno ENOTTY6407743
Ref: 218f6407743
Ref: library/errno errno ETXTBSY6407790
Ref: 21906407790
Ref: library/errno errno EFBIG6407836
Ref: 21916407836
Ref: library/errno errno ENOSPC6407880
Ref: 21926407880
Ref: library/errno errno ESPIPE6407934
Ref: 21936407934
Ref: library/errno errno EROFS6407977
Ref: 21946407977
Ref: library/errno errno EMLINK6408028
Ref: 21956408028
Ref: library/errno errno EPIPE6408073
Ref: 21966408073
Ref: library/errno errno EDOM6408114
Ref: 21976408114
Ref: library/errno errno ERANGE6408178
Ref: 21986408178
Ref: library/errno errno EDEADLK6408238
Ref: 21996408238
Ref: library/errno errno ENAMETOOLONG6408299
Ref: 219a6408299
Ref: library/errno errno ENOLCK6408354
Ref: 219b6408354
Ref: library/errno errno ENOSYS6408410
Ref: 219c6408410
Ref: library/errno errno ENOTEMPTY6408465
Ref: 219d6408465
Ref: library/errno errno ELOOP6408518
Ref: 219e6408518
Ref: library/errno errno EWOULDBLOCK6408583
Ref: 219f6408583
Ref: library/errno errno ENOMSG6408640
Ref: 21a06408640
Ref: library/errno errno EIDRM6408697
Ref: 21a16408697
Ref: library/errno errno ECHRNG6408745
Ref: 21a26408745
Ref: library/errno errno EL2NSYNC6408803
Ref: 21a36408803
Ref: library/errno errno EL3HLT6408860
Ref: 21a46408860
Ref: library/errno errno EL3RST6408905
Ref: 21a56408905
Ref: library/errno errno ELNRNG6408949
Ref: 21a66408949
Ref: library/errno errno EUNATCH6409004
Ref: 21a76409004
Ref: library/errno errno ENOCSI6409064
Ref: 21a86409064
Ref: library/errno errno EL2HLT6409121
Ref: 21a96409121
Ref: library/errno errno EBADE6409166
Ref: 21aa6409166
Ref: library/errno errno EBADR6409212
Ref: 21ab6409212
Ref: library/errno errno EXFULL6409268
Ref: 21ac6409268
Ref: library/errno errno ENOANO6409312
Ref: 21ad6409312
Ref: library/errno errno EBADRQC6409351
Ref: 21ae6409351
Ref: library/errno errno EBADSLT6409403
Ref: 21af6409403
Ref: library/errno errno EDEADLOCK6409447
Ref: 21b06409447
Ref: library/errno errno EBFONT6409508
Ref: 21b16409508
Ref: library/errno errno ENOSTR6409559
Ref: 21b26409559
Ref: library/errno errno ENODATA6409609
Ref: 21b36409609
Ref: library/errno errno ETIME6409658
Ref: 21b46409658
Ref: library/errno errno ENOSR6409701
Ref: 21b56409701
Ref: library/errno errno ENONET6409755
Ref: 21b66409755
Ref: library/errno errno ENOPKG6409815
Ref: 21b76409815
Ref: library/errno errno EREMOTE6409867
Ref: 21b86409867
Ref: library/errno errno ENOLINK6409915
Ref: 21b96409915
Ref: library/errno errno EADV6409968
Ref: 21ba6409968
Ref: library/errno errno ESRMNT6410012
Ref: 21bb6410012
Ref: library/errno errno ECOMM6410056
Ref: 21bc6410056
Ref: library/errno errno EPROTO6410113
Ref: 21bd6410113
Ref: library/errno errno EMULTIHOP6410158
Ref: 21be6410158
Ref: library/errno errno EDOTDOT6410210
Ref: 21bf6410210
Ref: library/errno errno EBADMSG6410260
Ref: 21c06410260
Ref: library/errno errno EOVERFLOW6410310
Ref: 21c16410310
Ref: library/errno errno ENOTUNIQ6410381
Ref: 21c26410381
Ref: library/errno errno EBADFD6410440
Ref: 21c36410440
Ref: library/errno errno EREMCHG6410499
Ref: 21c46410499
Ref: library/errno errno ELIBACC6410553
Ref: 21c56410553
Ref: library/errno errno ELIBBAD6410623
Ref: 21c66410623
Ref: library/errno errno ELIBSCN6410691
Ref: 21c76410691
Ref: library/errno errno ELIBMAX6410754
Ref: 21c86410754
Ref: library/errno errno ELIBEXEC6410833
Ref: 21c96410833
Ref: library/errno errno EILSEQ6410903
Ref: 21ca6410903
Ref: library/errno errno ERESTART6410955
Ref: 21cb6410955
Ref: library/errno errno ESTRPIPE6411031
Ref: 21cc6411031
Ref: library/errno errno EUSERS6411082
Ref: 21cd6411082
Ref: library/errno errno ENOTSOCK6411127
Ref: 21ce6411127
Ref: library/errno errno EDESTADDRREQ6411190
Ref: 21cf6411190
Ref: library/errno errno EMSGSIZE6411255
Ref: 21d06411255
Ref: library/errno errno EPROTOTYPE6411304
Ref: 21d16411304
Ref: library/errno errno ENOPROTOOPT6411369
Ref: 21d26411369
Ref: library/errno errno EPROTONOSUPPORT6411427
Ref: 21d36411427
Ref: library/errno errno ESOCKTNOSUPPORT6411489
Ref: 21d46411489
Ref: library/errno errno EOPNOTSUPP6411554
Ref: 21d56411554
Ref: library/errno errno EPFNOSUPPORT6411634
Ref: 21d66411634
Ref: library/errno errno EAFNOSUPPORT6411700
Ref: 21d76411700
Ref: library/errno errno EADDRINUSE6411777
Ref: 21d86411777
Ref: library/errno errno EADDRNOTAVAIL6411834
Ref: 21d96411834
Ref: library/errno errno ENETDOWN6411903
Ref: 21da6411903
Ref: library/errno errno ENETUNREACH6411951
Ref: f186411951
Ref: library/errno errno ENETRESET6412009
Ref: 21db6412009
Ref: library/errno errno ECONNABORTED6412086
Ref: 21dc6412086
Ref: library/errno errno ECONNRESET6412155
Ref: 21dd6412155
Ref: library/errno errno ENOBUFS6412214
Ref: 21de6412214
Ref: library/errno errno EISCONN6412271
Ref: 21df6412271
Ref: library/errno errno ENOTCONN6412342
Ref: 21e06412342
Ref: library/errno errno ESHUTDOWN6412410
Ref: 21e16412410
Ref: library/errno errno ETOOMANYREFS6412489
Ref: 21e26412489
Ref: library/errno errno ETIMEDOUT6412560
Ref: 21e36412560
Ref: library/errno errno ECONNREFUSED6412614
Ref: 21e46412614
Ref: library/errno errno EHOSTDOWN6412669
Ref: 21e56412669
Ref: library/errno errno EHOSTUNREACH6412715
Ref: 21e66412715
Ref: library/errno errno EALREADY6412768
Ref: 21e76412768
Ref: library/errno errno EINPROGRESS6412830
Ref: 21e86412830
Ref: library/errno errno ESTALE6412891
Ref: 21e96412891
Ref: library/errno errno EUCLEAN6412943
Ref: 21ea6412943
Ref: library/errno errno ENOTNAM6412999
Ref: 21eb6412999
Ref: library/errno errno ENAVAIL6413058
Ref: 21ec6413058
Ref: library/errno errno EISNAM6413119
Ref: 21ed6413119
Ref: library/errno errno EREMOTEIO6413170
Ref: 21ee6413170
Ref: library/errno errno EDQUOT6413220
Ref: 21ef6413220
Node: ctypes — A foreign function library for Python6413265
Ref: library/ctypes doc6413431
Ref: 21f06413431
Ref: library/ctypes ctypes-a-foreign-function-library-for-python6413431
Ref: 21f16413431
Ref: library/ctypes module-ctypes6413431
Ref: 2b6413431
Node: ctypes tutorial6413884
Ref: library/ctypes ctypes-ctypes-tutorial6414009
Ref: 21f26414009
Ref: library/ctypes ctypes-tutorial6414009
Ref: 21f36414009
Node: Loading dynamic link libraries6415378
Ref: library/ctypes ctypes-loading-dynamic-link-libraries6415505
Ref: 21f66415505
Ref: library/ctypes loading-dynamic-link-libraries6415505
Ref: 21f76415505
Node: Accessing functions from loaded dlls6417546
Ref: library/ctypes accessing-functions-from-loaded-dlls6417699
Ref: 21f86417699
Ref: library/ctypes ctypes-accessing-functions-from-loaded-dlls6417699
Ref: 21f96417699
Node: Calling functions6419847
Ref: library/ctypes calling-functions6419992
Ref: 21fa6419992
Ref: library/ctypes ctypes-calling-functions6419992
Ref: 21fb6419992
Node: Fundamental data types6422657
Ref: library/ctypes ctypes-fundamental-data-types6422793
Ref: 21fc6422793
Ref: library/ctypes fundamental-data-types6422793
Ref: 21fd6422793
Node: Calling functions continued6430628
Ref: library/ctypes calling-functions-continued6430796
Ref: 22116430796
Ref: library/ctypes ctypes-calling-functions-continued6430796
Ref: 22126430796
Node: Calling functions with your own custom data types6431795
Ref: library/ctypes calling-functions-with-your-own-custom-data-types6431999
Ref: 22136431999
Ref: library/ctypes ctypes-calling-functions-with-own-custom-data-types6431999
Ref: 22146431999
Node: Specifying the required argument types function prototypes6432802
Ref: library/ctypes ctypes-specifying-required-argument-types6432991
Ref: 22156432991
Ref: library/ctypes specifying-the-required-argument-types-function-prototypes6432991
Ref: 22166432991
Node: Return types6434762
Ref: library/ctypes ctypes-return-types6434953
Ref: 22176434953
Ref: library/ctypes return-types6434953
Ref: 22186434953
Node: Passing pointers or passing parameters by reference6437417
Ref: library/ctypes ctypes-passing-pointers6437571
Ref: 221a6437571
Ref: library/ctypes passing-pointers-or-passing-parameters-by-reference6437571
Ref: 221b6437571
Node: Structures and unions6438615
Ref: library/ctypes ctypes-structures-unions6438797
Ref: 221e6438797
Ref: library/ctypes structures-and-unions6438797
Ref: 221f6438797
Ref: library/ctypes ctypes-structureunion-alignment-byte-order6440738
Ref: 22226440738
Node: Structure/union alignment and byte order6441066
Ref: library/ctypes structure-union-alignment-and-byte-order6441232
Ref: 22236441232
Node: Bit fields in structures and unions6442012
Ref: library/ctypes bit-fields-in-structures-and-unions6442163
Ref: 22266442163
Ref: library/ctypes ctypes-bit-fields-in-structures-unions6442163
Ref: 22276442163
Node: Arrays6442710
Ref: library/ctypes arrays6442829
Ref: 22286442829
Ref: library/ctypes ctypes-arrays6442829
Ref: 22296442829
Node: Pointers6444013
Ref: library/ctypes ctypes-pointers6444113
Ref: 222a6444113
Ref: library/ctypes pointers6444113
Ref: 222b6444113
Node: Type conversions6446571
Ref: library/ctypes ctypes-type-conversions6446681
Ref: 222e6446681
Ref: library/ctypes type-conversions6446681
Ref: 222f6446681
Node: Incomplete Types6449158
Ref: library/ctypes ctypes-incomplete-types6449278
Ref: 22306449278
Ref: library/ctypes incomplete-types6449278
Ref: 22316449278
Node: Callback functions6450732
Ref: library/ctypes callback-functions6450871
Ref: 22326450871
Ref: library/ctypes ctypes-callback-functions6450871
Ref: 22336450871
Node: Accessing values exported from dlls6454543
Ref: library/ctypes accessing-values-exported-from-dlls6454675
Ref: 22376454675
Ref: library/ctypes ctypes-accessing-values-exported-from-dlls6454675
Ref: 22386454675
Node: Surprises6457362
Ref: library/ctypes ctypes-surprises6457501
Ref: 223b6457501
Ref: library/ctypes surprises6457501
Ref: 223c6457501
Node: Variable-sized data types6459551
Ref: library/ctypes ctypes-variable-sized-data-types6459646
Ref: 223d6459646
Ref: library/ctypes variable-sized-data-types6459646
Ref: 223e6459646
Node: ctypes reference6460959
Ref: library/ctypes ctypes-ctypes-reference6461084
Ref: 22406461084
Ref: library/ctypes ctypes-reference6461084
Ref: 22416461084
Node: Finding shared libraries6461395
Ref: library/ctypes ctypes-finding-shared-libraries6461505
Ref: 22426461505
Ref: library/ctypes finding-shared-libraries6461505
Ref: 22436461505
Node: Loading shared libraries6463950
Ref: library/ctypes ctypes-loading-shared-libraries6464086
Ref: 22446464086
Ref: library/ctypes loading-shared-libraries6464086
Ref: 22456464086
Ref: library/ctypes ctypes CDLL6464289
Ref: 1bf6464289
Ref: library/ctypes ctypes OleDLL6464592
Ref: 22466464592
Ref: library/ctypes ctypes WinDLL6465282
Ref: 22486465282
Ref: library/ctypes ctypes PyDLL6465953
Ref: 22496465953
Ref: library/ctypes ctypes PyDLL _handle6469651
Ref: 224e6469651
Ref: library/ctypes ctypes PyDLL _name6469733
Ref: 224f6469733
Ref: library/ctypes ctypes LibraryLoader6470075
Ref: 22506470075
Ref: library/ctypes ctypes LibraryLoader LoadLibrary6470540
Ref: 22516470540
Node: Foreign functions6472080
Ref: library/ctypes ctypes-foreign-functions6472211
Ref: 22526472211
Ref: library/ctypes foreign-functions6472211
Ref: 22536472211
Ref: library/ctypes ctypes _FuncPtr6472625
Ref: 22546472625
Ref: library/ctypes ctypes _FuncPtr restype6472926
Ref: 22556472926
Ref: library/ctypes ctypes _FuncPtr argtypes6473622
Ref: 22576473622
Ref: library/ctypes ctypes _FuncPtr errcheck6474861
Ref: 22566474861
Ref: library/ctypes ctypes ArgumentError6475847
Ref: 22586475847
Node: Function prototypes6476487
Ref: library/ctypes ctypes-function-prototypes6476611
Ref: 22596476611
Ref: library/ctypes function-prototypes6476611
Ref: 225a6476611
Ref: library/ctypes ctypes CFUNCTYPE6477194
Ref: 22346477194
Ref: library/ctypes ctypes WINFUNCTYPE6477705
Ref: 22356477705
Ref: library/ctypes ctypes PYFUNCTYPE6478157
Ref: 225b6478157
Node: Utility functions6483630
Ref: library/ctypes ctypes-utility-functions6483747
Ref: 225c6483747
Ref: library/ctypes utility-functions6483747
Ref: 225d6483747
Ref: library/ctypes ctypes addressof6483806
Ref: 225e6483806
Ref: library/ctypes ctypes alignment6484050
Ref: 225f6484050
Ref: library/ctypes ctypes byref6484210
Ref: 221c6484210
Ref: library/ctypes ctypes cast6484724
Ref: f4a6484724
Ref: library/ctypes ctypes create_string_buffer6485018
Ref: 22106485018
Ref: library/ctypes ctypes create_unicode_buffer6485824
Ref: ede6485824
Ref: library/ctypes ctypes DllCanUnloadNow6486644
Ref: 22606486644
Ref: library/ctypes ctypes DllGetClassObject6486889
Ref: 22616486889
Ref: library/ctypes ctypes util find_library6487149
Ref: 5ff6487149
Ref: library/ctypes ctypes util find_msvcrt6487541
Ref: 22626487541
Ref: library/ctypes ctypes FormatError6487997
Ref: 22636487997
Ref: library/ctypes ctypes GetLastError6488236
Ref: 22196488236
Ref: library/ctypes ctypes get_errno6488510
Ref: 224a6488510
Ref: library/ctypes ctypes get_last_error6488763
Ref: 224c6488763
Ref: library/ctypes ctypes memmove6489039
Ref: 22646489039
Ref: library/ctypes ctypes memset6489283
Ref: 22656489283
Ref: library/ctypes ctypes POINTER6489536
Ref: 222d6489536
Ref: library/ctypes ctypes pointer6489784
Ref: 221d6489784
Ref: library/ctypes ctypes resize6490104
Ref: 223f6490104
Ref: library/ctypes ctypes set_errno6490442
Ref: 224b6490442
Ref: library/ctypes ctypes set_last_error6490750
Ref: 224d6490750
Ref: library/ctypes ctypes sizeof6491081
Ref: 22666491081
Ref: library/ctypes ctypes string_at6491252
Ref: 22676491252
Ref: library/ctypes ctypes WinError6491622
Ref: 22686491622
Ref: library/ctypes ctypes wstring_at6492103
Ref: 22696492103
Node: Data types6492523
Ref: library/ctypes ctypes-data-types6492646
Ref: 226a6492646
Ref: library/ctypes data-types6492646
Ref: 226b6492646
Ref: library/ctypes ctypes _CData6492691
Ref: fe96492691
Ref: library/ctypes ctypes _CData from_buffer6493326
Ref: 226e6493326
Ref: library/ctypes ctypes _CData from_buffer_copy6493913
Ref: 226f6493913
Ref: library/ctypes ctypes _CData from_address6494458
Ref: 22706494458
Ref: library/ctypes ctypes _CData from_param6494804
Ref: 22716494804
Ref: library/ctypes ctypes _CData in_dll6495358
Ref: 22726495358
Ref: library/ctypes ctypes _CData _b_base_6495654
Ref: 22736495654
Ref: library/ctypes ctypes _CData _b_needsfree_6495959
Ref: 22746495959
Ref: library/ctypes ctypes _CData _objects6496133
Ref: 226c6496133
Node: Fundamental data types<2>6496445
Ref: library/ctypes ctypes-fundamental-data-types-26496572
Ref: 22756496572
Ref: library/ctypes id16496572
Ref: 22766496572
Ref: library/ctypes ctypes _SimpleCData6496641
Ref: 22776496641
Ref: library/ctypes ctypes _SimpleCData value6497113
Ref: 22786497113
Ref: library/ctypes ctypes c_byte6498468
Ref: 22016498468
Ref: library/ctypes ctypes c_char6498686
Ref: 21ff6498686
Ref: library/ctypes ctypes c_char_p6498932
Ref: 220d6498932
Ref: library/ctypes ctypes c_double6499233
Ref: 220b6499233
Ref: library/ctypes ctypes c_longdouble6499368
Ref: 220c6499368
Ref: library/ctypes ctypes c_float6499621
Ref: 220a6499621
Ref: library/ctypes ctypes c_int6499754
Ref: 21f46499754
Ref: library/ctypes ctypes c_int86500024
Ref: 22796500024
Ref: library/ctypes ctypes c_int166500153
Ref: 227a6500153
Ref: library/ctypes ctypes c_int326500285
Ref: 227b6500285
Ref: library/ctypes ctypes c_int646500415
Ref: 227c6500415
Ref: library/ctypes ctypes c_long6500550
Ref: 21f56500550
Ref: library/ctypes ctypes c_longlong6500720
Ref: 22076500720
Ref: library/ctypes ctypes c_short6500904
Ref: 22036500904
Ref: library/ctypes ctypes c_size_t6501076
Ref: 22096501076
Ref: library/ctypes ctypes c_ssize_t6501150
Ref: bc46501150
Ref: library/ctypes ctypes c_ubyte6501252
Ref: 22026501252
Ref: library/ctypes ctypes c_uint6501472
Ref: 22056501472
Ref: library/ctypes ctypes c_uint86501747
Ref: 227d6501747
Ref: library/ctypes ctypes c_uint166501880
Ref: 227e6501880
Ref: library/ctypes ctypes c_uint326502016
Ref: 227f6502016
Ref: library/ctypes ctypes c_uint646502150
Ref: 22806502150
Ref: library/ctypes ctypes c_ulong6502289
Ref: 22066502289
Ref: library/ctypes ctypes c_ulonglong6502462
Ref: 22086502462
Ref: library/ctypes ctypes c_ushort6502649
Ref: 22046502649
Ref: library/ctypes ctypes c_void_p6502829
Ref: 220f6502829
Ref: library/ctypes ctypes c_wchar6503000
Ref: 22006503000
Ref: library/ctypes ctypes c_wchar_p6503265
Ref: 220e6503265
Ref: library/ctypes ctypes c_bool6503479
Ref: 21fe6503479
Ref: library/ctypes ctypes HRESULT6503706
Ref: 22476503706
Ref: library/ctypes ctypes py_object6503867
Ref: 22816503867
Node: Structured data types6504263
Ref: library/ctypes ctypes-structured-data-types6504399
Ref: 22826504399
Ref: library/ctypes structured-data-types6504399
Ref: 22836504399
Ref: library/ctypes ctypes Union6504466
Ref: 22216504466
Ref: library/ctypes ctypes BigEndianStructure6504564
Ref: 22246504564
Ref: library/ctypes ctypes LittleEndianStructure6504685
Ref: 22256504685
Ref: library/ctypes ctypes Structure6504943
Ref: 22206504943
Ref: library/ctypes ctypes Structure _fields_6505367
Ref: 22846505367
Ref: library/ctypes ctypes Structure _pack_6506901
Ref: 22856506901
Ref: library/ctypes ctypes Structure _anonymous_6507189
Ref: 22866507189
Node: Arrays and pointers6509395
Ref: library/ctypes arrays-and-pointers6509497
Ref: 22876509497
Ref: library/ctypes ctypes-arrays-pointers6509497
Ref: 22886509497
Ref: library/ctypes ctypes Array6509560
Ref: f406509560
Ref: library/ctypes ctypes Array _length_6510069
Ref: 22896510069
Ref: library/ctypes ctypes Array _type_6510297
Ref: 228a6510297
Ref: library/ctypes ctypes _Pointer6510495
Ref: 228b6510495
Ref: library/ctypes ctypes _Pointer _type_6511153
Ref: 228c6511153
Ref: library/ctypes ctypes _Pointer contents6511223
Ref: 222c6511223
Node: Concurrent Execution6511413
Ref: library/concurrency doc6511581
Ref: 228d6511581
Ref: library/concurrency concurrency6511581
Ref: 228e6511581
Ref: library/concurrency concurrent-execution6511581
Ref: 228f6511581
Node: threading — Thread-based parallelism6512648
Ref: library/threading doc6512797
Ref: 22906512797
Ref: library/threading module-threading6512797
Ref: 1096512797
Ref: library/threading threading-thread-based-parallelism6512797
Ref: 22916512797
Ref: library/threading threading active_count6513474
Ref: 22926513474
Ref: library/threading threading current_thread6513687
Ref: 22946513687
Ref: library/threading threading excepthook6514005
Ref: 22f6514005
Ref: library/threading threading get_ident6515339
Ref: aa46515339
Ref: library/threading threading get_native_id6515733
Ref: 2316515733
Ref: library/threading threading enumerate6516194
Ref: 22936516194
Ref: library/threading threading main_thread6516513
Ref: 8e36516513
Ref: library/threading threading settrace6516738
Ref: 22956516738
Ref: library/threading threading setprofile6517005
Ref: 22966517005
Ref: library/threading threading stack_size6517278
Ref: 22976517278
Ref: library/threading threading TIMEOUT_MAX6518573
Ref: 22986518573
Ref: threading — Thread-based parallelism-Footnote-16519930
Node: Thread-Local Data6519998
Ref: library/threading thread-local-data6520113
Ref: 229a6520113
Ref: library/threading threading local6520460
Ref: 22366520460
Node: Thread Objects6520656
Ref: library/threading id16520792
Ref: 229b6520792
Ref: library/threading thread-objects6520792
Ref: 229c6520792
Ref: library/threading threading Thread6523472
Ref: 2336523472
Ref: library/threading threading Thread start6524706
Ref: 20156524706
Ref: library/threading threading Thread run6525083
Ref: 2306525083
Ref: library/threading threading Thread join6525495
Ref: b536525495
Ref: library/threading threading Thread name6526775
Ref: 229e6526775
Ref: library/threading threading Thread getName6526993
Ref: 22a06526993
Ref: library/threading threading Thread setName6527021
Ref: 22a16527021
Ref: library/threading threading Thread ident6527155
Ref: 1f576527155
Ref: library/threading threading Thread native_id6527546
Ref: 2326527546
Ref: library/threading threading Thread is_alive6528406
Ref: 229d6528406
Ref: library/threading threading Thread daemon6528744
Ref: 229f6528744
Ref: library/threading threading Thread isDaemon6529327
Ref: 22a26529327
Ref: library/threading threading Thread setDaemon6529356
Ref: 22a36529356
Node: Lock Objects6530038
Ref: library/threading id26530170
Ref: 22a46530170
Ref: library/threading lock-objects6530170
Ref: 22a56530170
Ref: library/threading threading Lock6531587
Ref: 22a86531587
Ref: library/threading threading Lock acquire6531989
Ref: 7606531989
Ref: library/threading threading Lock release6533320
Ref: 22a66533320
Ref: library/threading threading Lock locked6533805
Ref: 22a96533805
Node: RLock Objects6533888
Ref: library/threading id36534023
Ref: 22aa6534023
Ref: library/threading rlock-objects6534023
Ref: 22ab6534023
Ref: library/threading threading RLock6534933
Ref: be26534933
Ref: library/threading threading RLock acquire6535455
Ref: 7616535455
Ref: library/threading threading RLock release6536982
Ref: 22ac6536982
Node: Condition Objects6537675
Ref: library/threading condition-objects6537815
Ref: 22ad6537815
Ref: library/threading id46537815
Ref: 22ae6537815
Ref: library/threading threading Condition6540885
Ref: a9f6540885
Ref: library/threading threading Condition acquire6541428
Ref: 22af6541428
Ref: library/threading threading Condition release6541640
Ref: 22b06541640
Ref: library/threading threading Condition wait6541823
Ref: 22996541823
Ref: library/threading threading Condition wait_for6543354
Ref: 22b36543354
Ref: library/threading threading Condition notify6544311
Ref: 22b16544311
Ref: library/threading threading Condition notify_all6545213
Ref: 22b26545213
Node: Semaphore Objects6545552
Ref: library/threading id56545692
Ref: 22b46545692
Ref: library/threading semaphore-objects6545692
Ref: 22b56545692
Ref: library/threading threading Semaphore6546388
Ref: aa06546388
Ref: library/threading threading Semaphore acquire6547077
Ref: bdf6547077
Ref: library/threading threading Semaphore release6548366
Ref: 22b66548366
Ref: library/threading threading BoundedSemaphore6548607
Ref: aa16548607
Node: Semaphore Example6549170
Ref: library/threading semaphore-example6549241
Ref: 22b76549241
Ref: library/threading semaphore-examples6549241
Ref: 22b86549241
Node: Event Objects6550075
Ref: library/threading event-objects6550211
Ref: 22b96550211
Ref: library/threading id66550211
Ref: 22ba6550211
Ref: library/threading threading Event6550612
Ref: aa26550612
Ref: library/threading threading Event is_set6551002
Ref: 22bd6551002
Ref: library/threading threading Event set6551101
Ref: 22bb6551101
Ref: library/threading threading Event clear6551328
Ref: 22bc6551328
Ref: library/threading threading Event wait6551556
Ref: caa6551556
Node: Timer Objects6552431
Ref: library/threading id76552565
Ref: 22be6552565
Ref: library/threading timer-objects6552565
Ref: 22bf6552565
Ref: library/threading threading Timer6553299
Ref: aa36553299
Ref: library/threading threading Timer cancel6553748
Ref: 22c06553748
Node: Barrier Objects6553938
Ref: library/threading barrier-objects6554118
Ref: 22c16554118
Ref: library/threading threading Barrier6555018
Ref: b526555018
Ref: library/threading threading Barrier wait6555362
Ref: 22c26555362
Ref: library/threading threading Barrier reset6556464
Ref: 22c36556464
Ref: library/threading threading Barrier abort6556900
Ref: 22c46556900
Ref: library/threading threading Barrier parties6557389
Ref: 22c56557389
Ref: library/threading threading Barrier n_waiting6557481
Ref: 22c66557481
Ref: library/threading threading Barrier broken6557579
Ref: 22c76557579
Ref: library/threading threading BrokenBarrierError6557696
Ref: b546557696
Node: Using locks conditions and semaphores in the with statement6557873
Ref: library/threading using-locks-conditions-and-semaphores-in-the-with-statement6558031
Ref: 22c86558031
Ref: library/threading with-locks6558031
Ref: 22a76558031
Node: multiprocessing — Process-based parallelism6558851
Ref: library/multiprocessing doc6559100
Ref: 22c96559100
Ref: library/multiprocessing module-multiprocessing6559100
Ref: b76559100
Ref: library/multiprocessing multiprocessing-process-based-parallelism6559100
Ref: 22ca6559100
Ref: multiprocessing — Process-based parallelism-Footnote-16559467
Node: Introduction<8>6559539
Ref: library/multiprocessing introduction6559654
Ref: 22cb6559654
Node: The Process class6561162
Ref: library/multiprocessing the-process-class6561266
Ref: 22cc6561266
Node: Contexts and start methods6562347
Ref: library/multiprocessing contexts-and-start-methods6562496
Ref: 22cf6562496
Ref: library/multiprocessing multiprocessing-start-methods6562569
Ref: 86a6562569
Ref: Contexts and start methods-Footnote-16566954
Node: Exchanging objects between processes6566997
Ref: library/multiprocessing exchanging-objects-between-processes6567162
Ref: 22d26567162
Node: Synchronization between processes6568710
Ref: library/multiprocessing synchronization-between-processes6568880
Ref: 22d56568880
Node: Sharing state between processes6569551
Ref: library/multiprocessing sharing-state-between-processes6569708
Ref: 22d66569708
Node: Using a pool of workers6572513
Ref: library/multiprocessing using-a-pool-of-workers6572628
Ref: 22e16572628
Node: Reference6575431
Ref: library/multiprocessing reference6575577
Ref: 22e26575577
Node: Process and exceptions6576106
Ref: library/multiprocessing process-and-exceptions6576199
Ref: 22e36576199
Ref: library/multiprocessing multiprocessing Process6576272
Ref: 3a76576272
Ref: library/multiprocessing multiprocessing Process run6577641
Ref: 22d06577641
Ref: library/multiprocessing multiprocessing Process start6578053
Ref: 22cd6578053
Ref: library/multiprocessing multiprocessing Process join6578302
Ref: 22e66578302
Ref: library/multiprocessing multiprocessing Process name6579024
Ref: 22e46579024
Ref: library/multiprocessing multiprocessing Process is_alive6579489
Ref: 22e86579489
Ref: library/multiprocessing multiprocessing Process daemon6579725
Ref: 22e56579725
Ref: library/multiprocessing multiprocessing Process pid6580606
Ref: 22e96580606
Ref: library/multiprocessing multiprocessing Process exitcode6580731
Ref: 22e76580731
Ref: library/multiprocessing multiprocessing Process authkey6580959
Ref: 22ea6580959
Ref: library/multiprocessing multiprocessing Process sentinel6581487
Ref: a1a6581487
Ref: library/multiprocessing multiprocessing Process terminate6582124
Ref: 22ec6582124
Ref: library/multiprocessing multiprocessing Process kill6582926
Ref: 3a66582926
Ref: library/multiprocessing multiprocessing Process close6583081
Ref: 3a56583081
Ref: library/multiprocessing multiprocessing ProcessError6584199
Ref: 22ed6584199
Ref: library/multiprocessing multiprocessing BufferTooShort6584311
Ref: 22ee6584311
Ref: library/multiprocessing multiprocessing AuthenticationError6584620
Ref: 22ef6584620
Ref: library/multiprocessing multiprocessing TimeoutError6584724
Ref: 22f06584724
Node: Pipes and Queues6584834
Ref: library/multiprocessing pipes-and-queues6584952
Ref: 22f16584952
Ref: library/multiprocessing multiprocessing Pipe6588376
Ref: 22d46588376
Ref: library/multiprocessing multiprocessing Queue6588798
Ref: 22d36588798
Ref: library/multiprocessing multiprocessing Queue qsize6589396
Ref: 22ff6589396
Ref: library/multiprocessing multiprocessing Queue empty6589746
Ref: 22fa6589746
Ref: library/multiprocessing multiprocessing Queue full6589943
Ref: 23006589943
Ref: library/multiprocessing multiprocessing Queue put6590138
Ref: f646590138
Ref: library/multiprocessing multiprocessing Queue put_nowait6590965
Ref: 23016590965
Ref: library/multiprocessing multiprocessing Queue get6591048
Ref: f656591048
Ref: library/multiprocessing multiprocessing Queue get_nowait6591836
Ref: 22fb6591836
Ref: library/multiprocessing multiprocessing Queue close6592082
Ref: 23026592082
Ref: library/multiprocessing multiprocessing Queue join_thread6592378
Ref: 23036592378
Ref: library/multiprocessing multiprocessing Queue cancel_join_thread6592929
Ref: 22fc6592929
Ref: library/multiprocessing multiprocessing SimpleQueue6594074
Ref: 22f26594074
Ref: library/multiprocessing multiprocessing SimpleQueue empty6594210
Ref: 23046594210
Ref: library/multiprocessing multiprocessing SimpleQueue get6594312
Ref: 23056594312
Ref: library/multiprocessing multiprocessing SimpleQueue put6594390
Ref: 23066594390
Ref: library/multiprocessing multiprocessing JoinableQueue6594457
Ref: 22f36594457
Ref: library/multiprocessing multiprocessing JoinableQueue task_done6594677
Ref: 22f66594677
Ref: library/multiprocessing multiprocessing JoinableQueue join6595363
Ref: 23076595363
Ref: Pipes and Queues-Footnote-16595867
Node: Miscellaneous<3>6595909
Ref: library/multiprocessing miscellaneous6596026
Ref: 23086596026
Ref: library/multiprocessing multiprocessing active_children6596075
Ref: 23096596075
Ref: library/multiprocessing multiprocessing cpu_count6596292
Ref: 8746596292
Ref: library/multiprocessing multiprocessing current_process6596673
Ref: 230a6596673
Ref: library/multiprocessing multiprocessing parent_process6596871
Ref: 230b6596871
Ref: library/multiprocessing multiprocessing freeze_support6597138
Ref: 230c6597138
Ref: library/multiprocessing multiprocessing get_all_start_methods6598124
Ref: 86b6598124
Ref: library/multiprocessing multiprocessing get_context6598542
Ref: 86e6598542
Ref: library/multiprocessing multiprocessing get_start_method6598976
Ref: 86c6598976
Ref: library/multiprocessing multiprocessing set_executable6599577
Ref: 230d6599577
Ref: library/multiprocessing multiprocessing set_start_method6600041
Ref: 86d6600041
Node: Connection Objects<2>6600705
Ref: library/multiprocessing connection-objects6600832
Ref: 230e6600832
Ref: library/multiprocessing multiprocessing connection Connection6601151
Ref: 22fe6601151
Ref: library/multiprocessing multiprocessing connection Connection send6601201
Ref: 23106601201
Ref: library/multiprocessing multiprocessing connection Connection recv6601528
Ref: 23116601528
Ref: library/multiprocessing multiprocessing connection Connection fileno6601820
Ref: 23126601820
Ref: library/multiprocessing multiprocessing connection Connection close6601920
Ref: 23136601920
Ref: library/multiprocessing multiprocessing connection Connection poll6602072
Ref: 23146602072
Ref: library/multiprocessing multiprocessing connection Connection send_bytes6602558
Ref: 23156602558
Ref: library/multiprocessing multiprocessing connection Connection recv_bytes6603017
Ref: 23166603017
Ref: library/multiprocessing multiprocessing connection Connection recv_bytes_into6603657
Ref: 23176603657
Node: Synchronization primitives6606097
Ref: library/multiprocessing synchronization-primitives6606229
Ref: 23186606229
Ref: library/multiprocessing multiprocessing Barrier6606600
Ref: 22e06606600
Ref: library/multiprocessing multiprocessing BoundedSemaphore6606758
Ref: 22dd6606758
Ref: library/multiprocessing multiprocessing Condition6607259
Ref: 22de6607259
Ref: library/multiprocessing multiprocessing Event6607593
Ref: 22df6607593
Ref: library/multiprocessing multiprocessing Lock6607672
Ref: 22da6607672
Ref: library/multiprocessing multiprocessing Lock acquire6608515
Ref: 23196608515
Ref: library/multiprocessing multiprocessing Lock release6610041
Ref: 231a6610041
Ref: library/multiprocessing multiprocessing RLock6610410
Ref: 22db6610410
Ref: library/multiprocessing multiprocessing RLock acquire6611141
Ref: 231b6611141
Ref: library/multiprocessing multiprocessing RLock release6612790
Ref: 231c6612790
Ref: library/multiprocessing multiprocessing Semaphore6613767
Ref: 22dc6613767
Ref: Synchronization primitives-Footnote-16615192
Node: Shared ctypes Objects6615234
Ref: library/multiprocessing shared-ctypes-objects6615353
Ref: 231d6615353
Ref: library/multiprocessing multiprocessing Value6615530
Ref: 22d76615530
Ref: library/multiprocessing multiprocessing Array6616949
Ref: 22d86616949
Node: The multiprocessing sharedctypes module6618392
Ref: library/multiprocessing module-multiprocessing sharedctypes6618489
Ref: bd6618489
Ref: library/multiprocessing the-multiprocessing-sharedctypes-module6618489
Ref: 231e6618489
Ref: library/multiprocessing multiprocessing sharedctypes RawArray6619120
Ref: 231f6619120
Ref: library/multiprocessing multiprocessing sharedctypes RawValue6619949
Ref: 23216619949
Ref: library/multiprocessing multiprocessing sharedctypes Array6620733
Ref: 23206620733
Ref: library/multiprocessing multiprocessing sharedctypes Value6621500
Ref: 23226621500
Ref: library/multiprocessing multiprocessing sharedctypes copy6622251
Ref: 23236622251
Ref: library/multiprocessing multiprocessing sharedctypes synchronized6622413
Ref: 70d6622413
Node: Managers6625294
Ref: library/multiprocessing managers6625400
Ref: 23246625400
Ref: library/multiprocessing multiprocessing-managers6625400
Ref: 22f76625400
Ref: library/multiprocessing multiprocessing sharedctypes multiprocessing Manager6625750
Ref: 23256625750
Ref: library/multiprocessing module-multiprocessing managers6626070
Ref: ba6626070
Ref: library/multiprocessing multiprocessing managers BaseManager6626260
Ref: 23276626260
Ref: library/multiprocessing multiprocessing managers BaseManager start6626979
Ref: 23286626979
Ref: library/multiprocessing multiprocessing managers BaseManager get_server6627214
Ref: 23296627214
Ref: library/multiprocessing multiprocessing managers BaseManager connect6627713
Ref: 232b6627713
Ref: library/multiprocessing multiprocessing managers BaseManager shutdown6627964
Ref: 232c6627964
Ref: library/multiprocessing multiprocessing managers BaseManager register6628200
Ref: 232d6628200
Ref: library/multiprocessing multiprocessing managers BaseManager address6630516
Ref: 232a6630516
Ref: library/multiprocessing multiprocessing managers SyncManager6631047
Ref: 23266631047
Ref: library/multiprocessing multiprocessing managers SyncManager Barrier6631482
Ref: 23306631482
Ref: library/multiprocessing multiprocessing managers SyncManager BoundedSemaphore6631671
Ref: 23316631671
Ref: library/multiprocessing multiprocessing managers SyncManager Condition6631826
Ref: 23326631826
Ref: library/multiprocessing multiprocessing managers SyncManager Event6632199
Ref: 23336632199
Ref: library/multiprocessing multiprocessing managers SyncManager Lock6632325
Ref: 23346632325
Ref: library/multiprocessing multiprocessing managers SyncManager Namespace6632450
Ref: 23356632450
Ref: library/multiprocessing multiprocessing managers SyncManager Queue6632575
Ref: 23366632575
Ref: library/multiprocessing multiprocessing managers SyncManager RLock6632706
Ref: 23376632706
Ref: library/multiprocessing multiprocessing managers SyncManager Semaphore6632832
Ref: 23386632832
Ref: library/multiprocessing multiprocessing managers SyncManager Array6632973
Ref: 23396632973
Ref: library/multiprocessing multiprocessing managers SyncManager Value6633072
Ref: 233a6633072
Ref: library/multiprocessing multiprocessing managers SyncManager dict6633217
Ref: 233b6633217
Ref: library/multiprocessing multiprocessing managers SyncManager list6633398
Ref: 233c6633398
Ref: library/multiprocessing multiprocessing managers Namespace6633804
Ref: 22d96633804
Node: Customized managers6634525
Ref: library/multiprocessing customized-managers6634620
Ref: 233d6634620
Node: Using a remote manager6635327
Ref: library/multiprocessing using-a-remote-manager6635422
Ref: 233e6635422
Node: Proxy Objects6637390
Ref: library/multiprocessing multiprocessing-proxy-objects6637488
Ref: 55a6637488
Ref: library/multiprocessing proxy-objects6637488
Ref: 233f6637488
Ref: library/multiprocessing multiprocessing managers BaseProxy6640562
Ref: 232e6640562
Ref: library/multiprocessing multiprocessing managers BaseProxy _callmethod6640683
Ref: 232f6640683
Ref: library/multiprocessing multiprocessing managers BaseProxy _getvalue6642144
Ref: 23406642144
Ref: library/multiprocessing multiprocessing managers BaseProxy __repr__6642304
Ref: 23416642304
Ref: library/multiprocessing multiprocessing managers BaseProxy __str__6642390
Ref: 23426642390
Node: Cleanup6642495
Ref: library/multiprocessing cleanup6642552
Ref: 23436642552
Node: Process Pools6642841
Ref: library/multiprocessing module-multiprocessing pool6642952
Ref: bb6642952
Ref: library/multiprocessing process-pools6642952
Ref: 23446642952
Ref: library/multiprocessing multiprocessing pool Pool6643113
Ref: 86f6643113
Ref: library/multiprocessing multiprocessing pool Pool apply6645097
Ref: 23456645097
Ref: library/multiprocessing multiprocessing pool Pool apply_async6645468
Ref: 23466645468
Ref: library/multiprocessing multiprocessing pool Pool map6646302
Ref: a1e6646302
Ref: library/multiprocessing multiprocessing pool Pool map_async6647086
Ref: a1f6647086
Ref: library/multiprocessing multiprocessing pool Pool imap6647922
Ref: 23476647922
Ref: library/multiprocessing multiprocessing pool Pool imap_unordered6648632
Ref: 23486648632
Ref: library/multiprocessing multiprocessing pool Pool starmap6648958
Ref: a1b6648958
Ref: library/multiprocessing multiprocessing pool Pool starmap_async6649310
Ref: a1c6649310
Ref: library/multiprocessing multiprocessing pool Pool close6649661
Ref: 23496649661
Ref: library/multiprocessing multiprocessing pool Pool terminate6649848
Ref: 234a6649848
Ref: library/multiprocessing multiprocessing pool Pool join6650082
Ref: 234b6650082
Ref: library/multiprocessing multiprocessing pool AsyncResult6650526
Ref: 234c6650526
Ref: library/multiprocessing multiprocessing pool AsyncResult get6650683
Ref: 234d6650683
Ref: library/multiprocessing multiprocessing pool AsyncResult wait6651048
Ref: 234e6651048
Ref: library/multiprocessing multiprocessing pool AsyncResult ready6651172
Ref: 234f6651172
Ref: library/multiprocessing multiprocessing pool AsyncResult successful6651249
Ref: 23506651249
Node: Listeners and Clients6652476
Ref: library/multiprocessing listeners-and-clients6652593
Ref: 23516652593
Ref: library/multiprocessing module-multiprocessing connection6652593
Ref: b86652593
Ref: library/multiprocessing multiprocessing-listeners-clients6652593
Ref: 230f6652593
Ref: library/multiprocessing multiprocessing connection deliver_challenge6653129
Ref: 23526653129
Ref: library/multiprocessing multiprocessing connection answer_challenge6653535
Ref: 23536653535
Ref: library/multiprocessing multiprocessing connection Client6653849
Ref: 23546653849
Ref: library/multiprocessing multiprocessing connection Listener6654603
Ref: 23566654603
Ref: library/multiprocessing multiprocessing connection Listener accept6656363
Ref: 23576656363
Ref: library/multiprocessing multiprocessing connection Listener close6656645
Ref: 23586656645
Ref: library/multiprocessing multiprocessing connection Listener address6656945
Ref: 23596656945
Ref: library/multiprocessing multiprocessing connection Listener last_accepted6657041
Ref: 235a6657041
Ref: library/multiprocessing multiprocessing connection wait6657457
Ref: a196657457
Node: Address Formats6661287
Ref: library/multiprocessing address-formats6661360
Ref: 235b6661360
Ref: library/multiprocessing multiprocessing-address-formats6661360
Ref: 23556661360
Node: Authentication keys6662108
Ref: library/multiprocessing authentication-keys6662222
Ref: 235c6662222
Ref: library/multiprocessing multiprocessing-auth-keys6662222
Ref: 22eb6662222
Node: Logging<2>6663406
Ref: library/multiprocessing logging6663531
Ref: 235d6663531
Ref: library/multiprocessing multiprocessing get_logger6663799
Ref: 235e6663799
Ref: library/multiprocessing multiprocessing log_to_stderr6664311
Ref: 235f6664311
Node: The multiprocessing dummy module6665267
Ref: library/multiprocessing module-multiprocessing dummy6665364
Ref: b96665364
Ref: library/multiprocessing the-multiprocessing-dummy-module6665364
Ref: 23606665364
Node: Programming guidelines6665613
Ref: library/multiprocessing multiprocessing-programming6665756
Ref: 22ce6665756
Ref: library/multiprocessing programming-guidelines6665756
Ref: 23616665756
Node: All start methods6666004
Ref: library/multiprocessing all-start-methods6666127
Ref: 23626666127
Ref: All start methods-Footnote-16671952
Ref: All start methods-Footnote-26671994
Ref: All start methods-Footnote-36672036
Node: The spawn and forkserver start methods6672078
Ref: library/multiprocessing the-spawn-and-forkserver-start-methods6672201
Ref: 23636672201
Node: Examples<10>6674168
Ref: library/multiprocessing examples6674293
Ref: 23646674293
Ref: library/multiprocessing multiprocessing-examples6674293
Ref: 22fd6674293
Node: multiprocessing shared_memory — Provides shared memory for direct access across processes6681979
Ref: library/multiprocessing shared_memory doc6682212
Ref: 23656682212
Ref: library/multiprocessing shared_memory module-multiprocessing shared_memory6682212
Ref: bc6682212
Ref: library/multiprocessing shared_memory multiprocessing-shared-memory-provides-shared-memory-for-direct-access-across-processes6682212
Ref: 23666682212
Ref: library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory6683778
Ref: 22d16683778
Ref: library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory close6685453
Ref: 23676685453
Ref: library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory unlink6685809
Ref: 23686685809
Ref: library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory buf6686589
Ref: 23696686589
Ref: library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory name6686678
Ref: 236a6686678
Ref: library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory size6686789
Ref: 236b6686789
Ref: library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager6689599
Ref: 236c6689599
Ref: library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager SharedMemory6691014
Ref: 236d6691014
Ref: library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager ShareableList6691170
Ref: 236e6691170
Ref: library/multiprocessing shared_memory multiprocessing shared_memory ShareableList6692921
Ref: 236f6692921
Ref: library/multiprocessing shared_memory multiprocessing shared_memory ShareableList count6694096
Ref: 23706694096
Ref: library/multiprocessing shared_memory multiprocessing shared_memory ShareableList index6694189
Ref: 23716694189
Ref: library/multiprocessing shared_memory multiprocessing shared_memory ShareableList format6694349
Ref: 23726694349
Ref: library/multiprocessing shared_memory multiprocessing shared_memory ShareableList shm6694503
Ref: 23736694503
Ref: multiprocessing shared_memory — Provides shared memory for direct access across processes-Footnote-16695994
Ref: multiprocessing shared_memory — Provides shared memory for direct access across processes-Footnote-26696083
Node: The concurrent package6696114
Ref: library/concurrent doc6696349
Ref: 23746696349
Ref: library/concurrent the-concurrent-package6696349
Ref: 23756696349
Node: concurrent futures — Launching parallel tasks6696537
Ref: library/concurrent futures doc6696717
Ref: 23766696717
Ref: library/concurrent futures concurrent-futures-launching-parallel-tasks6696717
Ref: 23776696717
Ref: library/concurrent futures module-concurrent futures6696717
Ref: 226696717
Ref: concurrent futures — Launching parallel tasks-Footnote-16697561
Ref: concurrent futures — Launching parallel tasks-Footnote-26697646
Node: Executor Objects6697732
Ref: library/concurrent futures executor-objects6697859
Ref: 23796697859
Ref: library/concurrent futures concurrent futures Executor6697912
Ref: 23786697912
Ref: library/concurrent futures concurrent futures Executor submit6698111
Ref: 2a16698111
Ref: library/concurrent futures concurrent futures Executor map6698511
Ref: 6b26698511
Ref: library/concurrent futures concurrent futures Executor shutdown6700152
Ref: b216700152
Node: ThreadPoolExecutor6701717
Ref: library/concurrent futures threadpoolexecutor6701872
Ref: 237b6701872
Ref: library/concurrent futures concurrent futures ThreadPoolExecutor6702855
Ref: 2786702855
Node: ThreadPoolExecutor Example6704639
Ref: library/concurrent futures id16704720
Ref: 237d6704720
Ref: library/concurrent futures threadpoolexecutor-example6704720
Ref: b226704720
Node: ProcessPoolExecutor6705809
Ref: library/concurrent futures processpoolexecutor6705962
Ref: 237e6705962
Ref: library/concurrent futures concurrent futures ProcessPoolExecutor6706696
Ref: 2a26706696
Node: ProcessPoolExecutor Example6708498
Ref: library/concurrent futures id26708581
Ref: 23806708581
Ref: library/concurrent futures processpoolexecutor-example6708581
Ref: b236708581
Node: Future Objects6709357
Ref: library/concurrent futures future-objects6709508
Ref: 23816709508
Ref: library/concurrent futures concurrent futures Future6709717
Ref: b206709717
Ref: library/concurrent futures concurrent futures Future cancel6709956
Ref: 23826709956
Ref: library/concurrent futures concurrent futures Future cancelled6710295
Ref: 23836710295
Ref: library/concurrent futures concurrent futures Future running6710405
Ref: 23846710405
Ref: library/concurrent futures concurrent futures Future done6710553
Ref: 23856710553
Ref: library/concurrent futures concurrent futures Future result6710693
Ref: 23866710693
Ref: library/concurrent futures concurrent futures Future exception6711428
Ref: 23886711428
Ref: library/concurrent futures concurrent futures Future add_done_callback6712168
Ref: 23896712168
Ref: library/concurrent futures concurrent futures Future set_running_or_notify_cancel6713064
Ref: 238a6713064
Ref: library/concurrent futures concurrent futures Future set_result6714153
Ref: 238c6714153
Ref: library/concurrent futures concurrent futures Future set_exception6714609
Ref: 238d6714609
Node: Module Functions6715100
Ref: library/concurrent futures module-functions6715249
Ref: 238f6715249
Ref: library/concurrent futures concurrent futures wait6715302
Ref: 238b6715302
Ref: library/concurrent futures concurrent futures as_completed6717211
Ref: 10276717211
Ref: Module Functions-Footnote-16718268
Node: Exception classes6718317
Ref: library/concurrent futures exception-classes6718443
Ref: 23906718443
Ref: library/concurrent futures concurrent futures CancelledError6718498
Ref: 23876718498
Ref: library/concurrent futures concurrent futures TimeoutError6718589
Ref: 237a6718589
Ref: library/concurrent futures concurrent futures BrokenExecutor6718701
Ref: 23916718701
Ref: library/concurrent futures concurrent futures InvalidStateError6718957
Ref: 238e6718957
Ref: library/concurrent futures concurrent futures thread BrokenThreadPool6719139
Ref: 237c6719139
Ref: library/concurrent futures concurrent futures process BrokenProcessPool6719391
Ref: 237f6719391
Node: subprocess — Subprocess management6719751
Ref: library/subprocess doc6719934
Ref: 23926719934
Ref: library/subprocess module-subprocess6719934
Ref: f96719934
Ref: library/subprocess subprocess-subprocess-management6719934
Ref: 23936719934
Ref: subprocess — Subprocess management-Footnote-16720870
Ref: subprocess — Subprocess management-Footnote-26720939
Node: Using the subprocess Module6720988
Ref: library/subprocess using-the-subprocess-module6721120
Ref: 23946721120
Ref: library/subprocess subprocess run6721588
Ref: 3e26721588
Ref: library/subprocess subprocess CompletedProcess6725260
Ref: 7546725260
Ref: library/subprocess subprocess CompletedProcess args6725393
Ref: 23996725393
Ref: library/subprocess subprocess CompletedProcess returncode6725515
Ref: 239a6725515
Ref: library/subprocess subprocess CompletedProcess stdout6725789
Ref: 239b6725789
Ref: library/subprocess subprocess CompletedProcess stderr6726220
Ref: 239c6726220
Ref: library/subprocess subprocess CompletedProcess check_returncode6726462
Ref: 239d6726462
Ref: library/subprocess subprocess DEVNULL6726626
Ref: a956726626
Ref: library/subprocess subprocess PIPE6726869
Ref: 3e36726869
Ref: library/subprocess subprocess STDOUT6727133
Ref: 239e6727133
Ref: library/subprocess subprocess SubprocessError6727340
Ref: 239f6727340
Ref: library/subprocess subprocess TimeoutExpired6727469
Ref: 23986727469
Ref: library/subprocess subprocess TimeoutExpired cmd6727628
Ref: 23a06727628
Ref: library/subprocess subprocess TimeoutExpired timeout6727714
Ref: 23a16727714
Ref: library/subprocess subprocess TimeoutExpired output6727774
Ref: 23a26727774
Ref: library/subprocess subprocess TimeoutExpired stdout6727945
Ref: 23a36727945
Ref: library/subprocess subprocess TimeoutExpired stderr6728040
Ref: 23a46728040
Ref: library/subprocess subprocess CalledProcessError6728283
Ref: ca86728283
Ref: library/subprocess subprocess CalledProcessError returncode6728503
Ref: 23a66728503
Ref: library/subprocess subprocess CalledProcessError cmd6728671
Ref: 23a76728671
Ref: library/subprocess subprocess CalledProcessError output6728757
Ref: 23a86728757
Ref: library/subprocess subprocess CalledProcessError stdout6728928
Ref: 23a96728928
Ref: library/subprocess subprocess CalledProcessError stderr6729023
Ref: 23aa6729023
Node: Frequently Used Arguments6729331
Ref: library/subprocess frequently-used-arguments6729446
Ref: 23966729446
Ref: library/subprocess id16729446
Ref: 23ab6729446
Node: Popen Constructor6733614
Ref: library/subprocess popen-constructor6733751
Ref: 23b06733751
Ref: library/subprocess subprocess Popen6734046
Ref: 2b76734046
Ref: Popen Constructor-Footnote-16747512
Node: Exceptions<7>6747572
Ref: library/subprocess exceptions6747675
Ref: 23c06747675
Node: Security Considerations6748668
Ref: library/subprocess security-considerations6748822
Ref: 23af6748822
Ref: Security Considerations-Footnote-16749550
Node: Popen Objects6749620
Ref: library/subprocess popen-objects6749768
Ref: 23c16749768
Ref: library/subprocess subprocess Popen poll6749885
Ref: 23c26749885
Ref: library/subprocess subprocess Popen wait6750045
Ref: 5876750045
Ref: library/subprocess subprocess Popen communicate6750974
Ref: 23976750974
Ref: library/subprocess subprocess Popen send_signal6752625
Ref: 23c36752625
Ref: library/subprocess subprocess Popen terminate6752967
Ref: 23c46752967
Ref: library/subprocess subprocess Popen kill6753173
Ref: 23c56753173
Ref: library/subprocess subprocess Popen args6753407
Ref: 23c66753407
Ref: library/subprocess subprocess Popen stdin6753590
Ref: 23ac6753590
Ref: library/subprocess subprocess Popen stdout6754021
Ref: 23ad6754021
Ref: library/subprocess subprocess Popen stderr6754524
Ref: 23ae6754524
Ref: library/subprocess subprocess Popen pid6755289
Ref: 23c76755289
Ref: library/subprocess subprocess Popen returncode6755471
Ref: 23bf6755471
Node: Windows Popen Helpers6755822
Ref: library/subprocess windows-popen-helpers6755967
Ref: 23c86755967
Ref: library/subprocess subprocess STARTUPINFO6756121
Ref: 23b26756121
Ref: library/subprocess subprocess STARTUPINFO dwFlags6756540
Ref: 23c96756540
Ref: library/subprocess subprocess STARTUPINFO hStdInput6756839
Ref: 23ca6756839
Ref: library/subprocess subprocess STARTUPINFO hStdOutput6757161
Ref: 23cc6757161
Ref: library/subprocess subprocess STARTUPINFO hStdError6757472
Ref: 23cd6757472
Ref: library/subprocess subprocess STARTUPINFO wShowWindow6757780
Ref: 23ce6757780
Ref: library/subprocess subprocess STARTUPINFO lpAttributeList6758272
Ref: 4906758272
Ref: Windows Popen Helpers-Footnote-16759525
Ref: Windows Popen Helpers-Footnote-26759597
Ref: Windows Popen Helpers-Footnote-36759669
Node: Windows Constants6759758
Ref: library/subprocess windows-constants6759833
Ref: 23d16759833
Ref: library/subprocess subprocess STD_INPUT_HANDLE6759955
Ref: 23d26759955
Ref: library/subprocess subprocess STD_OUTPUT_HANDLE6760092
Ref: 23d36760092
Ref: library/subprocess subprocess STD_ERROR_HANDLE6760240
Ref: 23d46760240
Ref: library/subprocess subprocess SW_HIDE6760386
Ref: 23d06760386
Ref: library/subprocess subprocess STARTF_USESTDHANDLES6760475
Ref: 23cb6760475
Ref: library/subprocess subprocess STARTF_USESHOWWINDOW6760706
Ref: 23cf6760706
Ref: library/subprocess subprocess CREATE_NEW_CONSOLE6760859
Ref: 23b36760859
Ref: library/subprocess subprocess CREATE_NEW_PROCESS_GROUP6761006
Ref: 23b46761006
Ref: library/subprocess subprocess ABOVE_NORMAL_PRIORITY_CLASS6761328
Ref: 23b56761328
Ref: library/subprocess subprocess BELOW_NORMAL_PRIORITY_CLASS6761532
Ref: 23b66761532
Ref: library/subprocess subprocess HIGH_PRIORITY_CLASS6761735
Ref: 23b76761735
Ref: library/subprocess subprocess IDLE_PRIORITY_CLASS6761921
Ref: 23b86761921
Ref: library/subprocess subprocess NORMAL_PRIORITY_CLASS6762117
Ref: 23b96762117
Ref: library/subprocess subprocess REALTIME_PRIORITY_CLASS6762319
Ref: 23ba6762319
Ref: library/subprocess subprocess CREATE_NO_WINDOW6762853
Ref: 23bb6762853
Ref: library/subprocess subprocess DETACHED_PROCESS6763035
Ref: 23bc6763035
Ref: library/subprocess subprocess CREATE_DEFAULT_ERROR_MODE6763289
Ref: 23bd6763289
Ref: library/subprocess subprocess CREATE_BREAKAWAY_FROM_JOB6763689
Ref: 23be6763689
Node: Older high-level API6763886
Ref: library/subprocess call-function-trio6764070
Ref: 23956764070
Ref: library/subprocess older-high-level-api6764070
Ref: 23d56764070
Ref: library/subprocess subprocess call6764318
Ref: 3e46764318
Ref: library/subprocess subprocess check_call6765340
Ref: 23a56765340
Ref: library/subprocess subprocess check_output6766519
Ref: 8cf6766519
Node: Replacing Older Functions with the subprocess Module6768550
Ref: library/subprocess replacing-older-functions-with-the-subprocess-module6768746
Ref: 23d66768746
Ref: library/subprocess subprocess-replacements6768746
Ref: adf6768746
Node: Replacing /bin/sh shell command substitution6769913
Ref: library/subprocess replacing-bin-sh-shell-command-substitution6770079
Ref: 23d76770079
Node: Replacing shell pipeline6770284
Ref: library/subprocess replacing-shell-pipeline6770478
Ref: 23d86770478
Node: Replacing os system6771112
Ref: library/subprocess replacing-os-system6771291
Ref: 23d96771291
Node: Replacing the os spawn family6771881
Ref: library/subprocess replacing-the-os-spawn-family6772074
Ref: 23da6772074
Node: Replacing os popen os popen2 os popen36772665
Ref: library/subprocess replacing-os-popen-os-popen2-os-popen36772881
Ref: 23db6772881
Node: Replacing functions from the popen2 module6774046
Ref: library/subprocess replacing-functions-from-the-popen2-module6774224
Ref: 23dc6774224
Node: Legacy Shell Invocation Functions6775498
Ref: library/subprocess legacy-shell-invocation-functions6775679
Ref: 23dd6775679
Ref: library/subprocess subprocess getstatusoutput6776043
Ref: 8d06776043
Ref: library/subprocess subprocess getoutput6777152
Ref: 23de6777152
Node: Notes6777589
Ref: library/subprocess notes6777709
Ref: 23df6777709
Node: Converting an argument sequence to a string on Windows6777811
Ref: library/subprocess converting-an-argument-sequence-to-a-string-on-windows6777907
Ref: 23e06777907
Ref: library/subprocess converting-argument-sequence6777907
Ref: 23b16777907
Node: sched — Event scheduler6779067
Ref: library/sched doc6779239
Ref: 23e16779239
Ref: library/sched module-sched6779239
Ref: e36779239
Ref: library/sched sched-event-scheduler6779239
Ref: 23e26779239
Ref: library/sched sched scheduler6779509
Ref: a636779509
Ref: sched — Event scheduler-Footnote-16781079
Node: Scheduler Objects6781143
Ref: library/sched id16781222
Ref: 23e36781222
Ref: library/sched scheduler-objects6781222
Ref: 23e46781222
Ref: library/sched sched scheduler enterabs6781353
Ref: a656781353
Ref: library/sched sched scheduler enter6782237
Ref: a646782237
Ref: library/sched sched scheduler cancel6782646
Ref: 23e56782646
Ref: library/sched sched scheduler empty6782833
Ref: 23e66782833
Ref: library/sched sched scheduler run6782918
Ref: a626782918
Ref: library/sched sched scheduler queue6783970
Ref: 23e76783970
Node: queue — A synchronized queue class6784229
Ref: library/queue doc6784400
Ref: 23e86784400
Ref: library/queue module-queue6784400
Ref: da6784400
Ref: library/queue queue-a-synchronized-queue-class6784400
Ref: 23e96784400
Ref: library/queue queue Queue6785723
Ref: d0b6785723
Ref: library/queue queue LifoQueue6786087
Ref: 23ea6786087
Ref: library/queue queue PriorityQueue6786455
Ref: 23eb6786455
Ref: library/queue queue SimpleQueue6787400
Ref: 3bb6787400
Ref: library/queue queue Empty6787574
Ref: 22f86787574
Ref: library/queue queue Full6787759
Ref: 22f96787759
Ref: queue — A synchronized queue class-Footnote-16788030
Node: Queue Objects6788094
Ref: library/queue queue-objects6788208
Ref: 23f06788208
Ref: library/queue queueobjects6788208
Ref: 23f16788208
Ref: library/queue queue Queue qsize6788387
Ref: 23f26788387
Ref: library/queue queue Queue empty6788616
Ref: 23f36788616
Ref: library/queue queue Queue full6788945
Ref: 23f46788945
Ref: library/queue queue Queue put6789270
Ref: 23ee6789270
Ref: library/queue queue Queue put_nowait6789862
Ref: 23ef6789862
Ref: library/queue queue Queue get6789943
Ref: 23ec6789943
Ref: library/queue queue Queue get_nowait6790847
Ref: 23ed6790847
Ref: library/queue queue Queue task_done6791040
Ref: 22f46791040
Ref: library/queue queue Queue join6791686
Ref: 22f56791686
Node: SimpleQueue Objects6792654
Ref: library/queue simplequeue-objects6792768
Ref: 23f56792768
Ref: library/queue queue SimpleQueue qsize6792904
Ref: 23f66792904
Ref: library/queue queue SimpleQueue empty6793070
Ref: 23f76793070
Ref: library/queue queue SimpleQueue put6793287
Ref: 23f86793287
Ref: library/queue queue SimpleQueue put_nowait6794052
Ref: 23f96794052
Ref: library/queue queue SimpleQueue get6794201
Ref: 23fa6794201
Ref: library/queue queue SimpleQueue get_nowait6794783
Ref: 23fb6794783
Node: _thread — Low-level threading API6795298
Ref: library/_thread doc6795504
Ref: 23fc6795504
Ref: library/_thread module-_thread6795504
Ref: 36795504
Ref: library/_thread thread-low-level-threading-api6795504
Ref: 23fd6795504
Ref: library/_thread _thread error6796219
Ref: 23fe6796219
Ref: library/_thread _thread LockType6796387
Ref: 23ff6796387
Ref: library/_thread _thread start_new_thread6796455
Ref: ef76796455
Ref: library/_thread _thread interrupt_main6797347
Ref: 24006797347
Ref: library/_thread _thread exit6797716
Ref: 24036797716
Ref: library/_thread _thread allocate_lock6797865
Ref: 24046797865
Ref: library/_thread _thread get_ident6798013
Ref: 24056798013
Ref: library/_thread _thread get_native_id6798379
Ref: 24066798379
Ref: library/_thread _thread stack_size6798838
Ref: 24076798838
Ref: library/_thread _thread TIMEOUT_MAX6800081
Ref: 24086800081
Ref: library/_thread _thread lock acquire6800361
Ref: 24096800361
Ref: library/_thread _thread lock release6801444
Ref: 240a6801444
Ref: library/_thread _thread lock locked6801586
Ref: 240b6801586
Node: _dummy_thread — Drop-in replacement for the _thread module6802966
Ref: library/_dummy_thread doc6803200
Ref: 240c6803200
Ref: library/_dummy_thread dummy-thread-drop-in-replacement-for-the-thread-module6803200
Ref: 240d6803200
Ref: library/_dummy_thread module-_dummy_thread6803200
Ref: 26803200
Ref: _dummy_thread — Drop-in replacement for the _thread module-Footnote-16803997
Node: dummy_threading — Drop-in replacement for the threading module6804069
Ref: library/dummy_threading doc6804259
Ref: 240e6804259
Ref: library/dummy_threading dummy-threading-drop-in-replacement-for-the-threading-module6804259
Ref: 240f6804259
Ref: library/dummy_threading module-dummy_threading6804259
Ref: 686804259
Ref: dummy_threading — Drop-in replacement for the threading module-Footnote-16805038
Node: contextvars — Context Variables6805112
Ref: library/contextvars doc6805288
Ref: 24106805288
Ref: library/contextvars contextvars-context-variables6805288
Ref: 24116805288
Ref: library/contextvars module-contextvars6805288
Ref: 256805288
Ref: contextvars — Context Variables-Footnote-16806141
Node: Context Variables6806190
Ref: library/contextvars context-variables6806311
Ref: 24156806311
Ref: library/contextvars contextvars ContextVar6806362
Ref: 24126806362
Ref: library/contextvars contextvars ContextVar name6807069
Ref: 24176807069
Ref: library/contextvars contextvars ContextVar get6807196
Ref: 24166807196
Ref: library/contextvars contextvars ContextVar set6807683
Ref: 24186807683
Ref: library/contextvars contextvars ContextVar reset6808079
Ref: 241a6808079
Ref: library/contextvars contextvars contextvars Token6808525
Ref: 24196808525
Ref: library/contextvars contextvars contextvars Token Token var6808799
Ref: 241b6808799
Ref: library/contextvars contextvars contextvars Token Token old_value6808943
Ref: 241c6808943
Ref: library/contextvars contextvars contextvars Token Token MISSING6809234
Ref: 241d6809234
Node: Manual Context Management6809327
Ref: library/contextvars manual-context-management6809472
Ref: 241e6809472
Ref: library/contextvars contextvars copy_context6809539
Ref: 24136809539
Ref: library/contextvars contextvars Context6810005
Ref: 24146810005
Ref: library/contextvars contextvars Context run6810343
Ref: 241f6810343
Ref: library/contextvars contextvars Context copy6811515
Ref: 24206811515
Ref: library/contextvars contextvars Context get6811958
Ref: 24216811958
Ref: library/contextvars contextvars Context keys6812400
Ref: 24226812400
Ref: library/contextvars contextvars Context values6812491
Ref: 24236812491
Ref: library/contextvars contextvars Context items6812594
Ref: 24246812594
Node: asyncio support6812733
Ref: library/contextvars asyncio-support6812852
Ref: 24256812852
Node: Networking and Interprocess Communication6814216
Ref: library/ipc doc6814394
Ref: 24266814394
Ref: library/ipc ipc6814394
Ref: 24276814394
Ref: library/ipc networking-and-interprocess-communication6814394
Ref: 24286814394
Node: asyncio — Asynchronous I/O6815298
Ref: library/asyncio doc6815454
Ref: 24296815454
Ref: library/asyncio asyncio-asynchronous-i-o6815454
Ref: 242a6815454
Ref: library/asyncio module-asyncio6815454
Ref: a6815454
Node: Coroutines and Tasks6817228
Ref: library/asyncio-task doc6817329
Ref: 24346817329
Ref: library/asyncio-task coroutines-and-tasks6817329
Ref: 24356817329
Node: Coroutines<3>6817787
Ref: library/asyncio-task coroutine6817876
Ref: 242b6817876
Ref: library/asyncio-task coroutines6817876
Ref: 24366817876
Node: Awaitables6820001
Ref: library/asyncio-task asyncio-awaitables6820125
Ref: 24376820125
Ref: library/asyncio-task awaitables6820125
Ref: 24386820125
Node: Running an asyncio Program6822632
Ref: library/asyncio-task running-an-asyncio-program6822757
Ref: 243b6822757
Ref: library/asyncio-task asyncio run6822830
Ref: 1a46822830
Ref: Running an asyncio Program-Footnote-16823744
Node: Creating Tasks6823818
Ref: library/asyncio-task creating-tasks6823941
Ref: 243c6823941
Ref: library/asyncio-task asyncio create_task6823990
Ref: 1ac6823990
Node: Sleeping6824900
Ref: library/asyncio-task sleeping6825023
Ref: 243d6825023
Ref: library/asyncio-task asyncio sleep6825060
Ref: 2836825060
Ref: library/asyncio-task asyncio-example-sleep6825446
Ref: 243e6825446
Node: Running Tasks Concurrently6825851
Ref: library/asyncio-task running-tasks-concurrently6825987
Ref: 243f6825987
Ref: library/asyncio-task asyncio gather6826060
Ref: 2846826060
Ref: library/asyncio-task asyncio-example-gather6827452
Ref: 24406827452
Node: Shielding From Cancellation6828408
Ref: library/asyncio-task shielding-from-cancellation6828544
Ref: 24416828544
Ref: library/asyncio-task asyncio shield6828619
Ref: 2856828619
Node: Timeouts6829772
Ref: library/asyncio-task timeouts6829900
Ref: 24436829900
Ref: library/asyncio-task asyncio wait_for6829937
Ref: 2866829937
Ref: library/asyncio-task asyncio-example-waitfor6830790
Ref: 24456830790
Node: Waiting Primitives6831342
Ref: library/asyncio-task waiting-primitives6831472
Ref: 24466831472
Ref: library/asyncio-task asyncio wait6831531
Ref: 2876831531
Ref: library/asyncio-task asyncio-example-wait-coroutine6833815
Ref: 24476833815
Ref: library/asyncio-task asyncio as_completed6834570
Ref: 2886834570
Node: Scheduling From Other Threads6835172
Ref: library/asyncio-task scheduling-from-other-threads6835307
Ref: 24486835307
Ref: library/asyncio-task asyncio run_coroutine_threadsafe6835388
Ref: 50f6835388
Node: Introspection6836691
Ref: library/asyncio-task introspection6836819
Ref: 244a6836819
Ref: library/asyncio-task asyncio current_task6836868
Ref: 3456836868
Ref: library/asyncio-task asyncio all_tasks6837145
Ref: 3466837145
Node: Task Object6837403
Ref: library/asyncio-task task-object6837528
Ref: 244b6837528
Ref: library/asyncio-task asyncio Task6837573
Ref: 1ab6837573
Ref: library/asyncio-task asyncio Task cancel6839589
Ref: 24426839589
Ref: library/asyncio-task asyncio-example-task-cancel6840298
Ref: 24506840298
Ref: library/asyncio-task asyncio Task cancelled6841165
Ref: 244c6841165
Ref: library/asyncio-task asyncio Task done6841475
Ref: 24516841475
Ref: library/asyncio-task asyncio Task result6841691
Ref: 24526841691
Ref: library/asyncio-task asyncio Task exception6842179
Ref: 24546842179
Ref: library/asyncio-task asyncio Task add_done_callback6842666
Ref: 24556842666
Ref: library/asyncio-task asyncio Task remove_done_callback6842981
Ref: 24566842981
Ref: library/asyncio-task asyncio Task get_stack6843279
Ref: 24586843279
Ref: library/asyncio-task asyncio Task print_stack6844275
Ref: 24596844275
Ref: library/asyncio-task asyncio Task get_coro6844767
Ref: 1aa6844767
Ref: library/asyncio-task asyncio Task get_name6844899
Ref: 1af6844899
Ref: library/asyncio-task asyncio Task set_name6845171
Ref: 1ae6845171
Ref: library/asyncio-task asyncio Task all_tasks6845505
Ref: 3486845505
Ref: library/asyncio-task asyncio Task current_task6845987
Ref: 3476845987
Node: Generator-based Coroutines6846407
Ref: library/asyncio-task asyncio-generator-based-coro6846510
Ref: 24396846510
Ref: library/asyncio-task generator-based-coroutines6846510
Ref: 245a6846510
Ref: library/asyncio-task asyncio coroutine6846981
Ref: 2806846981
Ref: library/asyncio-task asyncio iscoroutine6847507
Ref: 245b6847507
Ref: library/asyncio-task asyncio iscoroutinefunction6847753
Ref: 245c6847753
Node: Streams6848070
Ref: library/asyncio-stream doc6848206
Ref: 245d6848206
Ref: library/asyncio-stream asyncio-streams6848206
Ref: 242c6848206
Ref: library/asyncio-stream streams6848206
Ref: 245e6848206
Ref: library/asyncio-stream asyncio-example-stream6848543
Ref: 245f6848543
Ref: library/asyncio-stream asyncio open_connection6849229
Ref: 3586849229
Ref: library/asyncio-stream asyncio start_server6850153
Ref: 3596850153
Ref: library/asyncio-stream asyncio open_unix_connection6851449
Ref: 24616851449
Ref: library/asyncio-stream asyncio start_unix_server6852091
Ref: 24636852091
Ref: Streams-Footnote-16852818
Node: StreamReader6852892
Ref: library/asyncio-stream streamreader6852969
Ref: 24646852969
Ref: library/asyncio-stream asyncio StreamReader6853016
Ref: efc6853016
Ref: library/asyncio-stream asyncio StreamReader read6853299
Ref: 24656853299
Ref: library/asyncio-stream asyncio StreamReader readline6853580
Ref: 24666853580
Ref: library/asyncio-stream asyncio StreamReader readexactly6853936
Ref: 5146853936
Ref: library/asyncio-stream asyncio StreamReader readuntil6854232
Ref: 5136854232
Ref: library/asyncio-stream asyncio StreamReader at_eof6855081
Ref: 246a6855081
Node: StreamWriter6855204
Ref: library/asyncio-stream streamwriter6855302
Ref: 246b6855302
Ref: library/asyncio-stream asyncio StreamWriter6855349
Ref: efd6855349
Ref: library/asyncio-stream asyncio StreamWriter write6855631
Ref: 246c6855631
Ref: library/asyncio-stream asyncio StreamWriter writelines6855986
Ref: 246d6855986
Ref: library/asyncio-stream asyncio StreamWriter close6856364
Ref: 246e6856364
Ref: library/asyncio-stream asyncio StreamWriter can_write_eof6856606
Ref: 246f6856606
Ref: library/asyncio-stream asyncio StreamWriter write_eof6856777
Ref: 24706856777
Ref: library/asyncio-stream asyncio StreamWriter transport6856905
Ref: 24716856905
Ref: library/asyncio-stream asyncio StreamWriter get_extra_info6856988
Ref: 24726856988
Ref: library/asyncio-stream asyncio StreamWriter drain6857162
Ref: 24736857162
Ref: library/asyncio-stream asyncio StreamWriter is_closing6857740
Ref: 34c6857740
Ref: library/asyncio-stream asyncio StreamWriter wait_closed6857901
Ref: 34b6857901
Node: Examples<11>6858135
Ref: library/asyncio-stream examples6858212
Ref: 24606858212
Node: TCP echo client using streams6858409
Ref: library/asyncio-stream asyncio-tcp-echo-client-streams6858525
Ref: 24746858525
Ref: library/asyncio-stream tcp-echo-client-using-streams6858525
Ref: 24756858525
Node: TCP echo server using streams6859197
Ref: library/asyncio-stream asyncio-tcp-echo-server-streams6859338
Ref: 24776859338
Ref: library/asyncio-stream tcp-echo-server-using-streams6859338
Ref: 24786859338
Node: Get HTTP headers6860222
Ref: library/asyncio-stream get-http-headers6860388
Ref: 247a6860388
Node: Register an open socket to wait for data using streams6861488
Ref: library/asyncio-stream asyncio-example-create-connection-streams6861616
Ref: 247b6861616
Ref: library/asyncio-stream register-an-open-socket-to-wait-for-data-using-streams6861616
Ref: 247c6861616
Node: Synchronization Primitives6862910
Ref: library/asyncio-sync doc6863038
Ref: 24806863038
Ref: library/asyncio-sync asyncio-sync6863038
Ref: 242f6863038
Ref: library/asyncio-sync synchronization-primitives6863038
Ref: 24816863038
Ref: Synchronization Primitives-Footnote-16864079
Node: Lock6864151
Ref: library/asyncio-sync lock6864232
Ref: 24826864232
Ref: library/asyncio-sync asyncio Lock6864263
Ref: 2896864263
Ref: library/asyncio-sync asyncio Lock acquire6864885
Ref: 24836864885
Ref: library/asyncio-sync asyncio Lock release6865379
Ref: 24846865379
Ref: library/asyncio-sync asyncio Lock locked6865596
Ref: 24856865596
Node: Event6865678
Ref: library/asyncio-sync event6865777
Ref: 24866865777
Ref: library/asyncio-sync asyncio Event6865810
Ref: 28a6865810
Ref: library/asyncio-sync asyncio-example-sync-event6866387
Ref: 24886866387
Ref: library/asyncio-sync asyncio Event wait6866876
Ref: 24896866876
Ref: library/asyncio-sync asyncio Event set6867085
Ref: 248a6867085
Ref: library/asyncio-sync asyncio Event clear6867225
Ref: 24876867225
Ref: library/asyncio-sync asyncio Event is_set6867413
Ref: 248b6867413
Node: Condition6867491
Ref: library/asyncio-sync condition6867595
Ref: 248c6867595
Ref: library/asyncio-sync asyncio Condition6867636
Ref: 28b6867636
Ref: library/asyncio-sync asyncio Condition acquire6868827
Ref: 248d6868827
Ref: library/asyncio-sync asyncio Condition notify6869030
Ref: 248e6869030
Ref: library/asyncio-sync asyncio Condition locked6869389
Ref: 248f6869389
Ref: library/asyncio-sync asyncio Condition notify_all6869482
Ref: 24906869482
Ref: library/asyncio-sync asyncio Condition release6869860
Ref: 24916869860
Ref: library/asyncio-sync asyncio Condition wait6870022
Ref: 24926870022
Ref: library/asyncio-sync asyncio Condition wait_for6870492
Ref: 24936870492
Node: Semaphore6870746
Ref: library/asyncio-sync semaphore6870861
Ref: 24946870861
Ref: library/asyncio-sync asyncio Semaphore6870902
Ref: 28c6870902
Ref: library/asyncio-sync asyncio Semaphore acquire6871973
Ref: 24956871973
Ref: library/asyncio-sync asyncio Semaphore locked6872261
Ref: 24976872261
Ref: library/asyncio-sync asyncio Semaphore release6872365
Ref: 24966872365
Node: BoundedSemaphore6872679
Ref: library/asyncio-sync boundedsemaphore6872776
Ref: 24986872776
Ref: library/asyncio-sync asyncio BoundedSemaphore6872831
Ref: 28d6872831
Node: Subprocesses6873542
Ref: library/asyncio-subprocess doc6873669
Ref: 24996873669
Ref: library/asyncio-subprocess asyncio-subprocess6873669
Ref: 242d6873669
Ref: library/asyncio-subprocess subprocesses6873669
Ref: 249a6873669
Ref: library/asyncio-subprocess asyncio-example-subprocess-shell6873957
Ref: 249b6873957
Ref: Subprocesses-Footnote-16875163
Ref: Subprocesses-Footnote-26875241
Node: Creating Subprocesses6875324
Ref: library/asyncio-subprocess creating-subprocesses6875415
Ref: 249d6875415
Ref: library/asyncio-subprocess asyncio create_subprocess_exec6875480
Ref: 28f6875480
Ref: library/asyncio-subprocess asyncio create_subprocess_shell6876136
Ref: 2906876136
Ref: Creating Subprocesses-Footnote-16877805
Node: Constants<7>6877875
Ref: library/asyncio-subprocess constants6878004
Ref: 24a56878004
Ref: library/asyncio-subprocess asyncio asyncio subprocess PIPE6878045
Ref: 24a66878045
Ref: library/asyncio-subprocess asyncio asyncio subprocess STDOUT6878489
Ref: 24aa6878489
Ref: library/asyncio-subprocess asyncio asyncio subprocess DEVNULL6878675
Ref: 24ab6878675
Node: Interacting with Subprocesses6878955
Ref: library/asyncio-subprocess interacting-with-subprocesses6879054
Ref: 24ac6879054
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process6879385
Ref: 249e6879385
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process wait6880363
Ref: 24ae6880363
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process communicate6880872
Ref: 24ad6880872
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process send_signal6882108
Ref: 24b16882108
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process terminate6882500
Ref: 24b26882500
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process kill6882782
Ref: 24b36882782
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process stdin6883012
Ref: 24a76883012
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process stdout6883173
Ref: 24a86883173
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process stderr6883337
Ref: 24a96883337
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process pid6883839
Ref: 24b46883839
Ref: library/asyncio-subprocess asyncio asyncio subprocess Process returncode6884078
Ref: 24b06884078
Node: Subprocess and Threads6884436
Ref: library/asyncio-subprocess asyncio-subprocess-threads6884545
Ref: 24af6884545
Ref: library/asyncio-subprocess subprocess-and-threads6884545
Ref: 24b56884545
Node: Examples<12>6885415
Ref: library/asyncio-subprocess examples6885524
Ref: 249c6885524
Ref: library/asyncio-subprocess asyncio-example-create-subprocess-exec6885708
Ref: 24b96885708
Node: Queues6886429
Ref: library/asyncio-queue doc6886543
Ref: 24bb6886543
Ref: library/asyncio-queue asyncio-queues6886543
Ref: 242e6886543
Ref: library/asyncio-queue queues6886543
Ref: 24bc6886543
Ref: Queues-Footnote-16887234
Node: Queue6887307
Ref: library/asyncio-queue queue6887378
Ref: 24be6887378
Ref: library/asyncio-queue asyncio Queue6887411
Ref: 28e6887411
Ref: library/asyncio-queue asyncio Queue maxsize6888069
Ref: 24c16888069
Ref: library/asyncio-queue asyncio Queue empty6888147
Ref: 24c26888147
Ref: library/asyncio-queue asyncio Queue full6888249
Ref: 24c36888249
Ref: library/asyncio-queue asyncio Queue get6888505
Ref: 24bf6888505
Ref: library/asyncio-queue asyncio Queue get_nowait6888656
Ref: 24c46888656
Ref: library/asyncio-queue asyncio Queue join6888792
Ref: 6936888792
Ref: library/asyncio-queue asyncio Queue put6889290
Ref: 24c66889290
Ref: library/asyncio-queue asyncio Queue put_nowait6889461
Ref: 24c76889461
Ref: library/asyncio-queue asyncio Queue qsize6889645
Ref: 24c06889645
Ref: library/asyncio-queue asyncio Queue task_done6889724
Ref: 6946889724
Node: Priority Queue6890407
Ref: library/asyncio-queue priority-queue6890497
Ref: 24c96890497
Ref: library/asyncio-queue asyncio PriorityQueue6890548
Ref: 24ca6890548
Node: LIFO Queue6890755
Ref: library/asyncio-queue lifo-queue6890853
Ref: 24cb6890853
Ref: library/asyncio-queue asyncio LifoQueue6890896
Ref: 24cc6890896
Node: Exceptions<8>6891039
Ref: library/asyncio-queue exceptions6891135
Ref: 24cd6891135
Ref: library/asyncio-queue asyncio QueueEmpty6891178
Ref: 24c56891178
Ref: library/asyncio-queue asyncio QueueFull6891320
Ref: 24c86891320
Node: Examples<13>6891477
Ref: library/asyncio-queue examples6891554
Ref: 24bd6891554
Ref: library/asyncio-queue asyncio-example-queue-dist6891593
Ref: 24ce6891593
Node: Exceptions<9>6893161
Ref: library/asyncio-exceptions doc6893273
Ref: 24cf6893273
Ref: library/asyncio-exceptions asyncio-exceptions6893273
Ref: 24d06893273
Ref: library/asyncio-exceptions exceptions6893273
Ref: 24d16893273
Ref: library/asyncio-exceptions asyncio TimeoutError6893429
Ref: 24446893429
Ref: library/asyncio-exceptions asyncio CancelledError6893632
Ref: 1a66893632
Ref: library/asyncio-exceptions asyncio InvalidStateError6893987
Ref: 24536893987
Ref: library/asyncio-exceptions asyncio SendfileNotAvailableError6894226
Ref: 24d26894226
Ref: library/asyncio-exceptions asyncio IncompleteReadError6894411
Ref: 24676894411
Ref: library/asyncio-exceptions asyncio IncompleteReadError expected6894626
Ref: 24d36894626
Ref: library/asyncio-exceptions asyncio IncompleteReadError partial6894721
Ref: 24686894721
Ref: library/asyncio-exceptions asyncio LimitOverrunError6894844
Ref: 24696894844
Ref: library/asyncio-exceptions asyncio LimitOverrunError consumed6895006
Ref: 24d46895006
Ref: Exceptions<9>-Footnote-16895125
Node: Event Loop6895203
Ref: library/asyncio-eventloop doc6895316
Ref: 24d56895316
Ref: library/asyncio-eventloop event-loop6895316
Ref: 24d66895316
Ref: library/asyncio-eventloop asyncio get_running_loop6896146
Ref: 3496896146
Ref: library/asyncio-eventloop asyncio get_event_loop6896431
Ref: 34a6896431
Ref: library/asyncio-eventloop asyncio set_event_loop6897122
Ref: 24d76897122
Ref: library/asyncio-eventloop asyncio new_event_loop6897235
Ref: 24d86897235
Ref: Event Loop-Footnote-16898503
Ref: Event Loop-Footnote-26898576
Node: Event Loop Methods6898655
Ref: library/asyncio-eventloop asyncio-event-loop6898745
Ref: 6386898745
Ref: library/asyncio-eventloop event-loop-methods6898745
Ref: 24da6898745
Node: Running and stopping the loop6899328
Ref: library/asyncio-eventloop running-and-stopping-the-loop6899441
Ref: 24e06899441
Ref: library/asyncio-eventloop asyncio loop run_until_complete6899522
Ref: 50d6899522
Ref: library/asyncio-eventloop asyncio loop run_forever6899838
Ref: 24e16899838
Ref: library/asyncio-eventloop asyncio loop stop6900558
Ref: 5156900558
Ref: library/asyncio-eventloop asyncio loop is_running6900611
Ref: 24e26900611
Ref: library/asyncio-eventloop asyncio loop is_closed6900707
Ref: 68f6900707
Ref: library/asyncio-eventloop asyncio loop close6900792
Ref: 24e36900792
Ref: library/asyncio-eventloop asyncio loop shutdown_asyncgens6901197
Ref: 5166901197
Node: Scheduling callbacks6901841
Ref: library/asyncio-eventloop scheduling-callbacks6901991
Ref: 24e46901991
Ref: library/asyncio-eventloop asyncio loop call_soon6902054
Ref: 33e6902054
Ref: library/asyncio-eventloop asyncio loop call_soon_threadsafe6902703
Ref: 33f6902703
Ref: library/asyncio-eventloop asyncio-pass-keywords6903092
Ref: 24e56903092
Ref: Scheduling callbacks-Footnote-16903567
Node: Scheduling delayed callbacks6903616
Ref: library/asyncio-eventloop asyncio-delayed-calls6903763
Ref: 24e66903763
Ref: library/asyncio-eventloop scheduling-delayed-callbacks6903763
Ref: 24e76903763
Ref: library/asyncio-eventloop asyncio loop call_later6903996
Ref: 3406903996
Ref: library/asyncio-eventloop asyncio loop call_at6905167
Ref: 3416905167
Ref: library/asyncio-eventloop asyncio loop time6905927
Ref: 24e86905927
Ref: Scheduling delayed callbacks-Footnote-16906362
Ref: Scheduling delayed callbacks-Footnote-26906411
Node: Creating Futures and Tasks6906460
Ref: library/asyncio-eventloop creating-futures-and-tasks6906614
Ref: 24e96906614
Ref: library/asyncio-eventloop asyncio loop create_future6906689
Ref: 5116906689
Ref: library/asyncio-eventloop asyncio loop create_task6907045
Ref: 1ad6907045
Ref: library/asyncio-eventloop asyncio loop set_task_factory6907564
Ref: 6916907564
Ref: library/asyncio-eventloop asyncio loop get_task_factory6908034
Ref: 6926908034
Node: Opening network connections6908144
Ref: library/asyncio-eventloop opening-network-connections6908294
Ref: 24ea6908294
Ref: library/asyncio-eventloop asyncio loop create_connection6908371
Ref: 1b06908371
Ref: library/asyncio-eventloop asyncio loop create_datagram_endpoint6913528
Ref: 2e56913528
Ref: library/asyncio-eventloop asyncio loop create_unix_connection6916983
Ref: 24626916983
Ref: Opening network connections-Footnote-16917948
Ref: Opening network connections-Footnote-26917997
Node: Creating network servers6918046
Ref: library/asyncio-eventloop creating-network-servers6918188
Ref: 24f46918188
Ref: library/asyncio-eventloop asyncio loop create_server6918259
Ref: 3526918259
Ref: library/asyncio-eventloop asyncio loop create_unix_server6921897
Ref: 3536921897
Ref: library/asyncio-eventloop asyncio loop connect_accepted_socket6922756
Ref: 35a6922756
Node: Transferring files6923786
Ref: library/asyncio-eventloop transferring-files6923912
Ref: 24f56923912
Ref: library/asyncio-eventloop asyncio loop sendfile6923971
Ref: 24f66923971
Node: TLS Upgrade6925029
Ref: library/asyncio-eventloop tls-upgrade6925156
Ref: 24f76925156
Ref: library/asyncio-eventloop asyncio loop start_tls6925201
Ref: 3436925201
Node: Watching file descriptors6926425
Ref: library/asyncio-eventloop watching-file-descriptors6926570
Ref: 24f86926570
Ref: library/asyncio-eventloop asyncio loop add_reader6926643
Ref: 247f6926643
Ref: library/asyncio-eventloop asyncio loop remove_reader6926861
Ref: 24f96926861
Ref: library/asyncio-eventloop asyncio loop add_writer6926968
Ref: 24fa6926968
Ref: library/asyncio-eventloop asyncio loop remove_writer6927288
Ref: 24fb6927288
Node: Working with socket objects directly6927483
Ref: library/asyncio-eventloop working-with-socket-objects-directly6927620
Ref: 24fd6927620
Ref: library/asyncio-eventloop asyncio loop sock_recv6928071
Ref: 4946928071
Ref: library/asyncio-eventloop asyncio loop sock_recv_into6928540
Ref: 3446928540
Ref: library/asyncio-eventloop asyncio loop sock_sendall6928847
Ref: 4956928847
Ref: library/asyncio-eventloop asyncio loop sock_connect6929604
Ref: 6956929604
Ref: library/asyncio-eventloop asyncio loop sock_accept6930225
Ref: 4966930225
Ref: library/asyncio-eventloop asyncio loop sock_sendfile6931049
Ref: 34d6931049
Node: DNS6932250
Ref: library/asyncio-eventloop dns6932380
Ref: 24fe6932380
Ref: library/asyncio-eventloop asyncio loop getaddrinfo6932409
Ref: 4976932409
Ref: library/asyncio-eventloop asyncio loop getnameinfo6932575
Ref: 4986932575
Node: Working with pipes6932959
Ref: library/asyncio-eventloop working-with-pipes6933065
Ref: 25016933065
Ref: library/asyncio-eventloop asyncio loop connect_read_pipe6933124
Ref: 24a16933124
Ref: library/asyncio-eventloop asyncio loop connect_write_pipe6933699
Ref: 24a26933699
Node: Unix signals6934537
Ref: library/asyncio-eventloop unix-signals6934681
Ref: 25046934681
Ref: library/asyncio-eventloop asyncio loop add_signal_handler6934728
Ref: 24316934728
Ref: library/asyncio-eventloop asyncio loop remove_signal_handler6935516
Ref: 25056935516
Node: Executing code in thread or process pools6935821
Ref: library/asyncio-eventloop executing-code-in-thread-or-process-pools6935965
Ref: 25066935965
Ref: library/asyncio-eventloop asyncio loop run_in_executor6936070
Ref: 243a6936070
Ref: library/asyncio-eventloop asyncio loop set_default_executor6937924
Ref: 2796937924
Node: Error Handling API6938408
Ref: library/asyncio-eventloop error-handling-api6938559
Ref: 25076938559
Ref: library/asyncio-eventloop asyncio loop set_exception_handler6938684
Ref: 25086938684
Ref: library/asyncio-eventloop asyncio loop get_exception_handler6939212
Ref: 5126939212
Ref: library/asyncio-eventloop asyncio loop default_exception_handler6939386
Ref: 250a6939386
Ref: library/asyncio-eventloop asyncio loop call_exception_handler6939761
Ref: 25096939761
Node: Enabling debug mode6940639
Ref: library/asyncio-eventloop enabling-debug-mode6940769
Ref: 250b6940769
Ref: library/asyncio-eventloop asyncio loop get_debug6940830
Ref: 68e6940830
Ref: library/asyncio-eventloop asyncio loop set_debug6941085
Ref: 68d6941085
Node: Running Subprocesses6941355
Ref: library/asyncio-eventloop running-subprocesses6941458
Ref: 250c6941458
Ref: library/asyncio-eventloop asyncio loop subprocess_exec6941918
Ref: 24306941918
Ref: library/asyncio-eventloop asyncio loop subprocess_shell6945907
Ref: 249f6945907
Ref: Running Subprocesses-Footnote-16947227
Node: Callback Handles6947297
Ref: library/asyncio-eventloop callback-handles6947410
Ref: 24db6947410
Ref: library/asyncio-eventloop asyncio Handle6947465
Ref: fdb6947465
Ref: library/asyncio-eventloop asyncio Handle cancel6947610
Ref: 250f6947610
Ref: library/asyncio-eventloop asyncio Handle cancelled6947763
Ref: 35b6947763
Ref: library/asyncio-eventloop asyncio TimerHandle6947885
Ref: 24dc6947885
Ref: library/asyncio-eventloop asyncio TimerHandle when6948080
Ref: 3576948080
Node: Server Objects6948325
Ref: library/asyncio-eventloop server-objects6948446
Ref: 24dd6948446
Ref: library/asyncio-eventloop asyncio Server6948714
Ref: 3516948714
Ref: library/asyncio-eventloop asyncio Server close6949247
Ref: 25106949247
Ref: library/asyncio-eventloop asyncio Server get_loop6949639
Ref: 3506949639
Ref: library/asyncio-eventloop asyncio Server start_serving6949768
Ref: 3546949768
Ref: library/asyncio-eventloop asyncio Server serve_forever6950392
Ref: 3556950392
Ref: library/asyncio-eventloop asyncio Server is_serving6951169
Ref: 3566951169
Ref: library/asyncio-eventloop asyncio Server wait_closed6951305
Ref: 25116951305
Ref: library/asyncio-eventloop asyncio Server sockets6951413
Ref: 4996951413
Node: Event Loop Implementations6951729
Ref: library/asyncio-eventloop asyncio-event-loops6951846
Ref: 25126951846
Ref: library/asyncio-eventloop event-loop-implementations6951846
Ref: 24de6951846
Ref: library/asyncio-eventloop asyncio SelectorEventLoop6952174
Ref: 24b66952174
Ref: library/asyncio-eventloop asyncio ProactorEventLoop6952650
Ref: 1a96952650
Ref: library/asyncio-eventloop asyncio AbstractEventLoop6952889
Ref: 25136952889
Ref: Event Loop Implementations-Footnote-16953184
Node: Examples<14>6953270
Ref: library/asyncio-eventloop examples6953364
Ref: 24df6953364
Node: Hello World with call_soon6953963
Ref: library/asyncio-eventloop asyncio-example-lowlevel-helloworld6954087
Ref: 25146954087
Ref: library/asyncio-eventloop hello-world-with-call-soon6954087
Ref: 25156954087
Node: Display the current date with call_later6954801
Ref: library/asyncio-eventloop asyncio-example-call-later6954973
Ref: 25166954973
Ref: library/asyncio-eventloop display-the-current-date-with-call-later6954973
Ref: 25176954973
Node: Watch a file descriptor for read events6955885
Ref: library/asyncio-eventloop asyncio-example-watch-fd6956073
Ref: 247e6956073
Ref: library/asyncio-eventloop watch-a-file-descriptor-for-read-events6956073
Ref: 25186956073
Node: Set signal handlers for SIGINT and SIGTERM6957278
Ref: library/asyncio-eventloop asyncio-example-unix-signals6957417
Ref: 25196957417
Ref: library/asyncio-eventloop set-signal-handlers-for-sigint-and-sigterm6957417
Ref: 251a6957417
Node: Futures6958252
Ref: library/asyncio-future doc6958376
Ref: 251b6958376
Ref: library/asyncio-future asyncio-futures6958376
Ref: 24336958376
Ref: library/asyncio-future futures6958376
Ref: 251c6958376
Ref: Futures-Footnote-16958743
Ref: Futures-Footnote-26958817
Node: Future Functions6958897
Ref: library/asyncio-future future-functions6958979
Ref: 251d6958979
Ref: library/asyncio-future asyncio isfuture6959034
Ref: 251e6959034
Ref: library/asyncio-future asyncio ensure_future6959340
Ref: 50c6959340
Ref: library/asyncio-future asyncio wrap_future6960281
Ref: 251f6960281
Node: Future Object6960442
Ref: library/asyncio-future future-object6960524
Ref: 25206960524
Ref: library/asyncio-future asyncio Future6960573
Ref: 4386960573
Ref: library/asyncio-future asyncio Future result6961495
Ref: 25216961495
Ref: library/asyncio-future asyncio Future set_result6962110
Ref: 244d6962110
Ref: library/asyncio-future asyncio Future set_exception6962305
Ref: 244e6962305
Ref: library/asyncio-future asyncio Future done6962508
Ref: 25226962508
Ref: library/asyncio-future asyncio Future cancelled6962772
Ref: 25236962772
Ref: library/asyncio-future asyncio Future add_done_callback6963062
Ref: 3426963062
Ref: library/asyncio-future asyncio Future remove_done_callback6964021
Ref: 24576964021
Ref: library/asyncio-future asyncio Future cancel6964253
Ref: 244f6964253
Ref: library/asyncio-future asyncio Future exception6964536
Ref: 25246964536
Ref: library/asyncio-future asyncio Future get_loop6964980
Ref: 34f6964980
Ref: library/asyncio-future asyncio-example-future6965105
Ref: 25256965105
Ref: Future Object-Footnote-16967047
Node: Transports and Protocols6967096
Ref: library/asyncio-protocol doc6967218
Ref: 25266967218
Ref: library/asyncio-protocol asyncio-transports-protocols6967218
Ref: 24326967218
Ref: library/asyncio-protocol transports-and-protocols6967218
Ref: 25276967218
Node: Transports6969586
Ref: library/asyncio-protocol asyncio-transport6969675
Ref: 24ee6969675
Ref: library/asyncio-protocol transports6969675
Ref: 25286969675
Ref: Transports-Footnote-16970417
Node: Transports Hierarchy6970495
Ref: library/asyncio-protocol transports-hierarchy6970585
Ref: 25316970585
Ref: library/asyncio-protocol asyncio BaseTransport6970648
Ref: 252a6970648
Ref: library/asyncio-protocol asyncio WriteTransport6970777
Ref: 25036970777
Ref: library/asyncio-protocol asyncio ReadTransport6971108
Ref: 25026971108
Ref: library/asyncio-protocol asyncio Transport6971435
Ref: 252b6971435
Ref: library/asyncio-protocol asyncio DatagramTransport6972038
Ref: 252c6972038
Ref: library/asyncio-protocol asyncio SubprocessTransport6972281
Ref: 250e6972281
Node: Base Transport6972607
Ref: library/asyncio-protocol base-transport6972726
Ref: 25326972726
Ref: library/asyncio-protocol asyncio BaseTransport close6972777
Ref: 25336972777
Ref: library/asyncio-protocol asyncio BaseTransport is_closing6973148
Ref: 5106973148
Ref: library/asyncio-protocol asyncio BaseTransport get_extra_info6973255
Ref: 2c66973255
Ref: library/asyncio-protocol asyncio BaseTransport set_protocol6975392
Ref: 25386975392
Ref: library/asyncio-protocol asyncio BaseTransport get_protocol6975577
Ref: 25396975577
Node: Read-only Transports6975655
Ref: library/asyncio-protocol read-only-transports6975775
Ref: 253a6975775
Ref: library/asyncio-protocol asyncio ReadTransport is_reading6975838
Ref: 35c6975838
Ref: library/asyncio-protocol asyncio ReadTransport pause_reading6975969
Ref: 35e6975969
Ref: library/asyncio-protocol asyncio ReadTransport resume_reading6976338
Ref: 35d6976338
Node: Write-only Transports6976676
Ref: library/asyncio-protocol write-only-transports6976801
Ref: 253c6976801
Ref: library/asyncio-protocol asyncio WriteTransport abort6976866
Ref: 253d6976866
Ref: library/asyncio-protocol asyncio WriteTransport can_write_eof6977205
Ref: 253e6977205
Ref: library/asyncio-protocol asyncio WriteTransport get_write_buffer_size6977362
Ref: 25406977362
Ref: library/asyncio-protocol asyncio WriteTransport get_write_buffer_limits6977489
Ref: 6906977489
Ref: library/asyncio-protocol asyncio WriteTransport set_write_buffer_limits6977803
Ref: 25416977803
Ref: library/asyncio-protocol asyncio WriteTransport write6979215
Ref: 25446979215
Ref: library/asyncio-protocol asyncio WriteTransport writelines6979414
Ref: 25456979414
Ref: library/asyncio-protocol asyncio WriteTransport write_eof6979698
Ref: 253f6979698
Node: Datagram Transports6979987
Ref: library/asyncio-protocol datagram-transports6980113
Ref: 25466980113
Ref: library/asyncio-protocol asyncio DatagramTransport sendto6980174
Ref: 25476980174
Ref: library/asyncio-protocol asyncio DatagramTransport abort6980552
Ref: 25486980552
Node: Subprocess Transports6980894
Ref: library/asyncio-protocol asyncio-subprocess-transports6980990
Ref: 24a36980990
Ref: library/asyncio-protocol subprocess-transports6980990
Ref: 25496980990
Ref: library/asyncio-protocol asyncio SubprocessTransport get_pid6981055
Ref: 254a6981055
Ref: library/asyncio-protocol asyncio SubprocessTransport get_pipe_transport6981153
Ref: 254b6981153
Ref: library/asyncio-protocol asyncio SubprocessTransport get_returncode6981899
Ref: 254c6981899
Ref: library/asyncio-protocol asyncio SubprocessTransport kill6982135
Ref: 254d6982135
Ref: library/asyncio-protocol asyncio SubprocessTransport send_signal6982396
Ref: 254f6982396
Ref: library/asyncio-protocol asyncio SubprocessTransport terminate6982555
Ref: 254e6982555
Ref: library/asyncio-protocol asyncio SubprocessTransport close6982855
Ref: 25506982855
Node: Protocols6983081
Ref: library/asyncio-protocol asyncio-protocol6983191
Ref: 24ed6983191
Ref: library/asyncio-protocol protocols6983191
Ref: 25296983191
Ref: Protocols-Footnote-16983984
Node: Base Protocols6984061
Ref: library/asyncio-protocol base-protocols6984143
Ref: 25516984143
Ref: library/asyncio-protocol asyncio BaseProtocol6984194
Ref: 252d6984194
Ref: library/asyncio-protocol asyncio Protocol6984286
Ref: 252e6984286
Ref: library/asyncio-protocol asyncio BufferedProtocol6984419
Ref: 2c76984419
Ref: library/asyncio-protocol asyncio DatagramProtocol6984575
Ref: 252f6984575
Ref: library/asyncio-protocol asyncio SubprocessProtocol6984691
Ref: 250d6984691
Node: Base Protocol6984857
Ref: library/asyncio-protocol base-protocol6984967
Ref: 25526984967
Ref: library/asyncio-protocol asyncio BaseProtocol connection_made6985290
Ref: 24ef6985290
Ref: library/asyncio-protocol asyncio BaseProtocol connection_lost6985544
Ref: 25346985544
Ref: library/asyncio-protocol asyncio BaseProtocol pause_writing6986087
Ref: 25426986087
Ref: library/asyncio-protocol asyncio BaseProtocol resume_writing6986203
Ref: 25436986203
Node: Streaming Protocols6986667
Ref: library/asyncio-protocol streaming-protocols6986791
Ref: 25536986791
Ref: library/asyncio-protocol asyncio Protocol data_received6987201
Ref: 253b6987201
Ref: library/asyncio-protocol asyncio Protocol eof_received6987882
Ref: 25546987882
Node: Buffered Streaming Protocols6988731
Ref: library/asyncio-protocol buffered-streaming-protocols6988860
Ref: 25556988860
Ref: library/asyncio-protocol asyncio BufferedProtocol get_buffer6989726
Ref: 25566989726
Ref: library/asyncio-protocol asyncio BufferedProtocol buffer_updated6990200
Ref: 25576990200
Ref: library/asyncio-protocol asyncio BufferedProtocol eof_received6990401
Ref: 25586990401
Node: Datagram Protocols6990948
Ref: library/asyncio-protocol datagram-protocols6991078
Ref: 25596991078
Ref: library/asyncio-protocol asyncio DatagramProtocol datagram_received6991276
Ref: 255a6991276
Ref: library/asyncio-protocol asyncio DatagramProtocol error_received6991541
Ref: 255b6991541
Node: Subprocess Protocols6992476
Ref: library/asyncio-protocol asyncio-subprocess-protocols6992569
Ref: 24a46992569
Ref: library/asyncio-protocol subprocess-protocols6992569
Ref: 255c6992569
Ref: library/asyncio-protocol asyncio SubprocessProtocol pipe_data_received6992805
Ref: 255d6992805
Ref: library/asyncio-protocol asyncio SubprocessProtocol pipe_connection_lost6993078
Ref: 255e6993078
Ref: library/asyncio-protocol asyncio SubprocessProtocol process_exited6993288
Ref: 255f6993288
Node: Examples<15>6993386
Ref: library/asyncio-protocol examples6993477
Ref: 25306993477
Node: TCP Echo Server6993732
Ref: library/asyncio-protocol asyncio-example-tcp-echo-server-protocol6993820
Ref: 24796993820
Ref: library/asyncio-protocol tcp-echo-server6993820
Ref: 25606993820
Node: TCP Echo Client6994994
Ref: library/asyncio-protocol asyncio-example-tcp-echo-client-protocol6995106
Ref: 24766995106
Ref: library/asyncio-protocol tcp-echo-client6995106
Ref: 25616995106
Node: UDP Echo Server6996524
Ref: library/asyncio-protocol asyncio-udp-echo-server-protocol6996636
Ref: 24f36996636
Ref: library/asyncio-protocol udp-echo-server6996636
Ref: 25626996636
Node: UDP Echo Client6997667
Ref: library/asyncio-protocol asyncio-udp-echo-client-protocol6997791
Ref: 24f26997791
Ref: library/asyncio-protocol udp-echo-client6997791
Ref: 25636997791
Node: Connecting Existing Sockets6999163
Ref: library/asyncio-protocol asyncio-example-create-connection6999315
Ref: 247d6999315
Ref: library/asyncio-protocol connecting-existing-sockets6999315
Ref: 25646999315
Node: loop subprocess_exec and SubprocessProtocol7001062
Ref: library/asyncio-protocol asyncio-example-subprocess-proto7001190
Ref: 24ba7001190
Ref: library/asyncio-protocol loop-subprocess-exec-and-subprocessprotocol7001190
Ref: 25657001190
Node: Policies7002830
Ref: library/asyncio-policy doc7002961
Ref: 25667002961
Ref: library/asyncio-policy asyncio-policies7002961
Ref: 24d97002961
Ref: library/asyncio-policy policies7002961
Ref: 25677002961
Node: Getting and Setting the Policy7003747
Ref: library/asyncio-policy getting-and-setting-the-policy7003845
Ref: 25697003845
Ref: library/asyncio-policy asyncio get_event_loop_policy7004016
Ref: 256a7004016
Ref: library/asyncio-policy asyncio set_event_loop_policy7004110
Ref: 256b7004110
Node: Policy Objects7004291
Ref: library/asyncio-policy policy-objects7004414
Ref: 256c7004414
Ref: library/asyncio-policy asyncio AbstractEventLoopPolicy7004531
Ref: 25687004531
Ref: library/asyncio-policy asyncio AbstractEventLoopPolicy get_event_loop7004626
Ref: 256d7004626
Ref: library/asyncio-policy asyncio AbstractEventLoopPolicy set_event_loop7004915
Ref: 256e7004915
Ref: library/asyncio-policy asyncio AbstractEventLoopPolicy new_event_loop7005020
Ref: 256f7005020
Ref: library/asyncio-policy asyncio AbstractEventLoopPolicy get_child_watcher7005165
Ref: 25707005165
Ref: library/asyncio-policy asyncio AbstractEventLoopPolicy set_child_watcher7005401
Ref: 25727005401
Ref: library/asyncio-policy asyncio DefaultEventLoopPolicy7005606
Ref: 25737005606
Ref: library/asyncio-policy asyncio WindowsSelectorEventLoopPolicy7006012
Ref: 25747006012
Ref: library/asyncio-policy asyncio WindowsProactorEventLoopPolicy7006221
Ref: 25757006221
Node: Process Watchers7006429
Ref: library/asyncio-policy asyncio-watchers7006537
Ref: 24b77006537
Ref: library/asyncio-policy process-watchers7006537
Ref: 25767006537
Ref: library/asyncio-policy asyncio get_child_watcher7007408
Ref: 257a7007408
Ref: library/asyncio-policy asyncio set_child_watcher7007515
Ref: 257b7007515
Ref: library/asyncio-policy asyncio AbstractChildWatcher7007947
Ref: 25717007947
Ref: library/asyncio-policy asyncio AbstractChildWatcher add_child_handler7007988
Ref: 257c7007988
Ref: library/asyncio-policy asyncio AbstractChildWatcher remove_child_handler7008381
Ref: 257d7008381
Ref: library/asyncio-policy asyncio AbstractChildWatcher attach_loop7008632
Ref: 257e7008632
Ref: library/asyncio-policy asyncio AbstractChildWatcher is_active7008896
Ref: 257f7008896
Ref: library/asyncio-policy asyncio AbstractChildWatcher close7009132
Ref: 25807009132
Ref: library/asyncio-policy asyncio ThreadedChildWatcher7009291
Ref: 24b87009291
Ref: library/asyncio-policy asyncio MultiLoopChildWatcher7009760
Ref: 25777009760
Ref: library/asyncio-policy asyncio SafeChildWatcher7010421
Ref: 25787010421
Ref: library/asyncio-policy asyncio FastChildWatcher7011010
Ref: 25797011010
Node: Custom Policies7011478
Ref: library/asyncio-policy custom-policies7011563
Ref: 25817011563
Node: Platform Support7012130
Ref: library/asyncio-platforms doc7012257
Ref: 25827012257
Ref: library/asyncio-platforms asyncio-platform-support7012257
Ref: 24fc7012257
Ref: library/asyncio-platforms platform-support7012257
Ref: 25837012257
Node: All Platforms7012567
Ref: library/asyncio-platforms all-platforms7012653
Ref: 25847012653
Node: Windows<43>7012817
Ref: library/asyncio-platforms windows7012921
Ref: 25857012921
Ref: Windows<43>-Footnote-17014751
Ref: Windows<43>-Footnote-27014834
Ref: Windows<43>-Footnote-37014916
Ref: Windows<43>-Footnote-47014997
Node: Subprocess Support on Windows7015062
Ref: library/asyncio-platforms asyncio-windows-subprocess7015139
Ref: 24a07015139
Ref: library/asyncio-platforms subprocess-support-on-windows7015139
Ref: 25877015139
Node: macOS<18>7015522
Ref: library/asyncio-platforms macos7015604
Ref: 25887015604
Node: High-level API Index7016216
Ref: library/asyncio-api-index doc7016354
Ref: 258a7016354
Ref: library/asyncio-api-index high-level-api-index7016354
Ref: 258b7016354
Node: Tasks7016632
Ref: library/asyncio-api-index tasks7016712
Ref: 258c7016712
Node: Queues<2>7019485
Ref: library/asyncio-api-index queues7019589
Ref: 258d7019589
Node: Subprocesses<2>7020408
Ref: library/asyncio-api-index subprocesses7020517
Ref: 258e7020517
Node: Streams<2>7021079
Ref: library/asyncio-api-index streams7021194
Ref: 258f7021194
Node: Synchronization7022629
Ref: library/asyncio-api-index synchronization7022743
Ref: 25907022743
Node: Exceptions<10>7023880
Ref: library/asyncio-api-index exceptions7023975
Ref: 25917023975
Node: Low-level API Index7024937
Ref: library/asyncio-llapi-index doc7025082
Ref: 25927025082
Ref: library/asyncio-llapi-index low-level-api-index7025082
Ref: 25937025082
Node: Obtaining the Event Loop7025354
Ref: library/asyncio-llapi-index obtaining-the-event-loop7025464
Ref: 25947025464
Node: Event Loop Methods<2>7026577
Ref: library/asyncio-llapi-index event-loop-methods7026709
Ref: 25957026709
Node: Transports<2>7038240
Ref: library/asyncio-llapi-index transports7038360
Ref: 25967038360
Node: Protocols<2>7044192
Ref: library/asyncio-llapi-index protocols7044310
Ref: 25977044310
Node: Event Loop Policies7047833
Ref: library/asyncio-llapi-index event-loop-policies7047929
Ref: 25987047929
Node: Developing with asyncio7048758
Ref: library/asyncio-dev doc7048874
Ref: 25997048874
Ref: library/asyncio-dev asyncio-dev7048874
Ref: 259a7048874
Ref: library/asyncio-dev developing-with-asyncio7048874
Ref: 259b7048874
Node: Debug Mode7049285
Ref: library/asyncio-dev asyncio-debug-mode7049394
Ref: 128b7049394
Ref: library/asyncio-dev debug-mode7049394
Ref: 259c7049394
Node: Concurrency and Multithreading7051021
Ref: library/asyncio-dev asyncio-multithreading7051160
Ref: 24497051160
Ref: library/asyncio-dev concurrency-and-multithreading7051160
Ref: 259f7051160
Node: Running Blocking Code7052827
Ref: library/asyncio-dev asyncio-handle-blocking7052966
Ref: 25a07052966
Ref: library/asyncio-dev running-blocking-code7052966
Ref: 25a17052966
Node: Logging<3>7053461
Ref: library/asyncio-dev asyncio-logger7053601
Ref: 259d7053601
Ref: library/asyncio-dev logging7053601
Ref: 25a27053601
Node: Detect never-awaited coroutines7053882
Ref: library/asyncio-dev asyncio-coroutine-not-scheduled7054034
Ref: 259e7054034
Ref: library/asyncio-dev detect-never-awaited-coroutines7054034
Ref: 25a37054034
Node: Detect never-retrieved exceptions7054973
Ref: library/asyncio-dev detect-never-retrieved-exceptions7055106
Ref: 25a47055106
Ref: Detect never-retrieved exceptions-Footnote-17056611
Node: socket — Low-level networking interface7056675
Ref: library/socket doc7056882
Ref: 25a57056882
Ref: library/socket module-socket7056882
Ref: ef7056882
Ref: library/socket socket-low-level-networking-interface7056882
Ref: 25a67056882
Ref: socket — Low-level networking interface-Footnote-17058197
Node: Socket families7058262
Ref: library/socket socket-families7058379
Ref: 25a77058379
Ref: library/socket host-port7059595
Ref: 25a87059595
Ref: Socket families-Footnote-17067550
Node: Module contents7067599
Ref: library/socket module-contents7067739
Ref: 25ae7067739
Node: Exceptions<11>7067946
Ref: library/socket exceptions7068033
Ref: 25af7068033
Ref: library/socket socket error7068074
Ref: 9897068074
Ref: library/socket socket herror7068261
Ref: 25b07068261
Ref: library/socket socket gaierror7068886
Ref: 25b37068886
Ref: library/socket socket timeout7069491
Ref: c017069491
Ref: Exceptions<11>-Footnote-17069986
Node: Constants<8>7070035
Ref: library/socket constants7070143
Ref: 25b57070143
Ref: library/socket socket AF_UNIX7070331
Ref: 24f17070331
Ref: library/socket socket AF_INET7070356
Ref: 24eb7070356
Ref: library/socket socket AF_INET67070381
Ref: 24ec7070381
Ref: library/socket socket SOCK_STREAM7070695
Ref: c7d7070695
Ref: library/socket socket SOCK_DGRAM7070724
Ref: c7c7070724
Ref: library/socket socket SOCK_RAW7070752
Ref: 25b67070752
Ref: library/socket socket SOCK_RDM7070778
Ref: 25b77070778
Ref: library/socket socket SOCK_SEQPACKET7070804
Ref: 25b87070804
Ref: library/socket socket SOCK_CLOEXEC7071103
Ref: 48d7071103
Ref: library/socket socket SOCK_NONBLOCK7071133
Ref: 48c7071133
Ref: library/socket socket SOMAXCONN7071563
Ref: 7407071563
Ref: library/socket socket AF_CAN7072681
Ref: 25a97072681
Ref: library/socket socket PF_CAN7072705
Ref: 25b97072705
Ref: library/socket socket CAN_BCM7072964
Ref: 8ad7072964
Ref: library/socket socket CAN_RAW_FD_FRAMES7073387
Ref: 7b97073387
Ref: library/socket socket CAN_ISOTP7073801
Ref: 25aa7073801
Ref: library/socket socket AF_PACKET7074051
Ref: 25ab7074051
Ref: library/socket socket PF_PACKET7074078
Ref: 25ba7074078
Ref: library/socket socket AF_RDS7074293
Ref: 25bb7074293
Ref: library/socket socket PF_RDS7074317
Ref: 25bc7074317
Ref: library/socket socket SOL_RDS7074341
Ref: 25bd7074341
Ref: library/socket socket SIO_RCVALL7074580
Ref: 25be7074580
Ref: library/socket socket SIO_KEEPALIVE_VALS7074608
Ref: 25bf7074608
Ref: library/socket socket SIO_LOOPBACK_FAST_PATH7074644
Ref: 5767074644
Ref: library/socket socket AF_ALG7075063
Ref: 5797075063
Ref: library/socket socket SOL_ALG7075087
Ref: 25c07075087
Ref: library/socket socket AF_VSOCK7075253
Ref: 3c87075253
Ref: library/socket socket IOCTL_VM_SOCKETS_GET_LOCAL_CID7075279
Ref: 25c17075279
Ref: library/socket socket AF_LINK7075490
Ref: 8ae7075490
Ref: library/socket socket has_ipv67075585
Ref: 25c27075585
Ref: library/socket socket BDADDR_ANY7075717
Ref: 25c37075717
Ref: library/socket socket BDADDR_LOCAL7075745
Ref: 25c47075745
Ref: library/socket socket HCI_FILTER7076014
Ref: 25c57076014
Ref: library/socket socket HCI_TIME_STAMP7076042
Ref: 25c67076042
Ref: library/socket socket HCI_DATA_DIR7076074
Ref: 25c77076074
Ref: library/socket socket AF_QIPCRTR7076342
Ref: 25ac7076342
Ref: Constants<8>-Footnote-17076574
Node: Functions<5>7076625
Ref: library/socket functions7076710
Ref: 25c87076710
Node: Creating sockets7076819
Ref: library/socket creating-sockets7076911
Ref: 25c97076911
Ref: library/socket socket socket7077028
Ref: 6687077028
Ref: library/socket socket socketpair7079456
Ref: 4767079456
Ref: library/socket socket create_connection7080193
Ref: b917080193
Ref: library/socket socket create_server7081352
Ref: 21c7081352
Ref: library/socket socket has_dualstack_ipv67083078
Ref: 21d7083078
Ref: library/socket socket fromfd7083273
Ref: 25cb7083273
Ref: library/socket socket fromshare7084155
Ref: 4897084155
Ref: library/socket socket SocketType7084409
Ref: 25cd7084409
Node: Other functions<2>7084562
Ref: library/socket other-functions7084654
Ref: 25ce7084654
Ref: library/socket socket close7084781
Ref: 3c67084781
Ref: library/socket socket getaddrinfo7085053
Ref: 24ff7085053
Ref: library/socket socket getfqdn7087762
Ref: 25cf7087762
Ref: library/socket socket gethostbyname7088279
Ref: 25d07088279
Ref: library/socket socket gethostbyname_ex7088880
Ref: 25b17088880
Ref: library/socket socket gethostname7089655
Ref: 1e417089655
Ref: library/socket socket gethostbyaddr7090042
Ref: 25b27090042
Ref: library/socket socket getnameinfo7090739
Ref: 25007090739
Ref: library/socket socket getprotobyname7091461
Ref: 25d17091461
Ref: library/socket socket getservbyname7091915
Ref: 25d27091915
Ref: library/socket socket getservbyport7092327
Ref: 25d37092327
Ref: library/socket socket ntohl7092725
Ref: 25d47092725
Ref: library/socket socket ntohs7092982
Ref: 4627092982
Ref: library/socket socket htonl7093540
Ref: 25d57093540
Ref: library/socket socket htons7093797
Ref: 4617093797
Ref: library/socket socket inet_aton7094355
Ref: 25d67094355
Ref: library/socket socket inet_ntoa7095292
Ref: 25d77095292
Ref: library/socket socket inet_pton7096121
Ref: 8af7096121
Ref: library/socket socket inet_ntop7096956
Ref: 8b07096956
Ref: library/socket socket CMSG_LEN7097980
Ref: f597097980
Ref: library/socket socket CMSG_SPACE7098654
Ref: f587098654
Ref: library/socket socket getdefaulttimeout7099547
Ref: 25cc7099547
Ref: library/socket socket setdefaulttimeout7099825
Ref: 25b47099825
Ref: library/socket socket sethostname7100113
Ref: a7c7100113
Ref: library/socket socket if_nameindex7100445
Ref: 21e7100445
Ref: library/socket socket if_nametoindex7100752
Ref: 21f7100752
Ref: library/socket socket if_indextoname7101087
Ref: 2207101087
Ref: Other functions<2>-Footnote-17101460
Node: Socket Objects7101509
Ref: library/socket id17101658
Ref: 25d87101658
Ref: library/socket socket-objects7101658
Ref: 25ca7101658
Ref: library/socket socket socket accept7102010
Ref: 6697102010
Ref: library/socket socket socket bind7102776
Ref: 25d97102776
Ref: library/socket socket socket close7103077
Ref: 5f57103077
Ref: library/socket socket socket connect7104072
Ref: 66a7104072
Ref: library/socket socket socket connect_ex7105145
Ref: 25db7105145
Ref: library/socket socket socket detach7105725
Ref: b907105725
Ref: library/socket socket socket dup7105966
Ref: 25dc7105966
Ref: library/socket socket socket fileno7106148
Ref: 25dd7106148
Ref: library/socket socket socket get_inheritable7106509
Ref: 7f37106509
Ref: library/socket socket socket getpeername7106771
Ref: 25357106771
Ref: library/socket socket socket getsockname7107110
Ref: 25367107110
Ref: library/socket socket socket getsockopt7107359
Ref: 5777107359
Ref: library/socket socket socket getblocking7108055
Ref: 3c57108055
Ref: library/socket socket socket gettimeout7108277
Ref: 25de7108277
Ref: library/socket socket socket ioctl7108524
Ref: 5757108524
Ref: library/socket socket socket listen7109161
Ref: 73f7109161
Ref: library/socket socket socket makefile7109587
Ref: b0c7109587
Ref: library/socket socket socket recv7110702
Ref: 66b7110702
Ref: library/socket socket socket recvfrom7111498
Ref: 66c7111498
Ref: library/socket socket socket recvmsg7112434
Ref: 66d7112434
Ref: library/socket socket socket recvmsg_into7116284
Ref: a7b7116284
Ref: library/socket socket socket recvfrom_into7117827
Ref: ca67117827
Ref: library/socket socket socket recv_into7118361
Ref: ca57118361
Ref: library/socket socket socket send7118808
Ref: 66e7118808
Ref: library/socket socket socket sendall7119621
Ref: 66f7119621
Ref: library/socket socket socket sendto7120595
Ref: 6717120595
Ref: library/socket socket socket sendmsg7121426
Ref: 6707121426
Ref: library/socket socket socket sendmsg_afalg7123572
Ref: 57a7123572
Ref: library/socket socket socket sendfile7123910
Ref: 73e7123910
Ref: library/socket socket socket set_inheritable7124814
Ref: 7f47124814
Ref: library/socket socket socket setblocking7124994
Ref: 1e4d7124994
Ref: library/socket socket socket settimeout7125566
Ref: 25ad7125566
Ref: library/socket socket socket setsockopt7126302
Ref: 5787126302
Ref: library/socket socket socket shutdown7127380
Ref: 25da7127380
Ref: library/socket socket socket share7127676
Ref: 48a7127676
Ref: library/socket socket socket family7128542
Ref: 25e27128542
Ref: library/socket socket socket type7128597
Ref: 48e7128597
Ref: library/socket socket socket proto7128648
Ref: 25e37128648
Ref: Socket Objects-Footnote-17128740
Ref: Socket Objects-Footnote-27128789
Ref: Socket Objects-Footnote-37128838
Ref: Socket Objects-Footnote-47128912
Ref: Socket Objects-Footnote-57128961
Ref: Socket Objects-Footnote-67129010
Ref: Socket Objects-Footnote-77129059
Ref: Socket Objects-Footnote-87129108
Ref: Socket Objects-Footnote-97129157
Ref: Socket Objects-Footnote-107129206
Node: Notes on socket timeouts7129256
Ref: library/socket notes-on-socket-timeouts7129400
Ref: 25e47129400
Ref: library/socket socket-timeouts7129400
Ref: 25e17129400
Node: Timeouts and the connect method7130757
Ref: library/socket timeouts-and-the-connect-method7130888
Ref: 25e57130888
Node: Timeouts and the accept method7131363
Ref: library/socket timeouts-and-the-accept-method7131494
Ref: 25e67131494
Node: Example<8>7132235
Ref: library/socket example7132356
Ref: 25e77132356
Ref: library/socket socket-example7132356
Ref: 25e87132356
Ref: Example<8>-Footnote-17139507
Node: ssl — TLS/SSL wrapper for socket objects7139556
Ref: library/ssl doc7139772
Ref: 25e97139772
Ref: library/ssl module-ssl7139772
Ref: f37139772
Ref: library/ssl ssl-tls-ssl-wrapper-for-socket-objects7139772
Ref: 25ea7139772
Ref: ssl — TLS/SSL wrapper for socket objects-Footnote-17142378
Node: Functions Constants and Exceptions7142440
Ref: library/ssl functions-constants-and-exceptions7142573
Ref: 25eb7142573
Node: Socket creation7142821
Ref: library/ssl socket-creation7142932
Ref: 25ec7142932
Node: Context creation7144604
Ref: library/ssl context-creation7144738
Ref: 25ed7144738
Ref: library/ssl ssl create_default_context7144880
Ref: 8b57144880
Ref: Context creation-Footnote-17147723
Node: Exceptions<12>7147768
Ref: library/ssl exceptions7147904
Ref: 25f37147904
Ref: library/ssl ssl SSLError7147945
Ref: c027147945
Ref: library/ssl ssl SSLError library7148517
Ref: a8d7148517
Ref: library/ssl ssl SSLError reason7148795
Ref: a8e7148795
Ref: library/ssl ssl SSLZeroReturnError7149054
Ref: 25f47149054
Ref: library/ssl ssl SSLWantReadError7149348
Ref: 74a7149348
Ref: library/ssl ssl SSLWantWriteError7149655
Ref: 74b7149655
Ref: library/ssl ssl SSLSyscallError7149959
Ref: 25f67149959
Ref: library/ssl ssl SSLEOFError7150248
Ref: 25f77150248
Ref: library/ssl ssl SSLCertVerificationError7150516
Ref: 3d27150516
Ref: library/ssl ssl SSLCertVerificationError verify_code7150680
Ref: 25f87150680
Ref: library/ssl ssl SSLCertVerificationError verify_message7150784
Ref: 25f97150784
Ref: library/ssl ssl CertificateError7150882
Ref: 25fa7150882
Node: Random generation7151081
Ref: library/ssl random-generation7151221
Ref: 25fb7151221
Ref: library/ssl ssl RAND_bytes7151276
Ref: a847151276
Ref: library/ssl ssl RAND_pseudo_bytes7151948
Ref: a857151948
Ref: library/ssl ssl RAND_status7152798
Ref: 25fc7152798
Ref: library/ssl ssl RAND_egd7153125
Ref: 25fe7153125
Ref: library/ssl ssl RAND_add7153782
Ref: 25fd7153782
Ref: Random generation-Footnote-17154224
Ref: Random generation-Footnote-27154318
Node: Certificate handling7154367
Ref: library/ssl certificate-handling7154505
Ref: 25ff7154505
Ref: library/ssl ssl match_hostname7154566
Ref: 3d17154566
Ref: library/ssl ssl cert_time_to_seconds7156447
Ref: 74c7156447
Ref: library/ssl ssl get_server_certificate7157301
Ref: a8f7157301
Ref: library/ssl ssl DER_cert_to_PEM_cert7158312
Ref: 26017158312
Ref: library/ssl ssl PEM_cert_to_DER_cert7158494
Ref: 26027158494
Ref: library/ssl ssl get_default_verify_paths7158674
Ref: 8b67158674
Ref: library/ssl ssl enum_certificates7159680
Ref: 8c27159680
Ref: library/ssl ssl enum_crls7160537
Ref: 8c37160537
Ref: library/ssl ssl wrap_socket7161068
Ref: 4647161068
Ref: Certificate handling-Footnote-17162561
Ref: Certificate handling-Footnote-27162610
Ref: Certificate handling-Footnote-37162659
Ref: Certificate handling-Footnote-47162708
Ref: Certificate handling-Footnote-57162757
Node: Constants<9>7162806
Ref: library/ssl constants7162918
Ref: 26057162918
Ref: library/ssl ssl CERT_NONE7163083
Ref: 26067163083
Ref: library/ssl ssl CERT_OPTIONAL7163700
Ref: 26087163700
Ref: library/ssl ssl CERT_REQUIRED7164605
Ref: 25f17164605
Ref: library/ssl ssl VerifyMode7165730
Ref: 260a7165730
Ref: library/ssl ssl VERIFY_DEFAULT7165846
Ref: 8bb7165846
Ref: library/ssl ssl VERIFY_CRL_CHECK_LEAF7166099
Ref: 8bc7166099
Ref: library/ssl ssl VERIFY_CRL_CHECK_CHAIN7166548
Ref: 8bd7166548
Ref: library/ssl ssl VERIFY_X509_STRICT7166754
Ref: 8be7166754
Ref: library/ssl ssl VERIFY_X509_TRUSTED_FIRST7166934
Ref: 260b7166934
Ref: library/ssl ssl VerifyFlags7167223
Ref: 260c7167223
Ref: library/ssl ssl PROTOCOL_TLS7167343
Ref: 25ee7167343
Ref: library/ssl ssl PROTOCOL_TLS_CLIENT7167573
Ref: 26077167573
Ref: library/ssl ssl PROTOCOL_TLS_SERVER7167887
Ref: 260d7167887
Ref: library/ssl ssl PROTOCOL_SSLv237168103
Ref: 260e7168103
Ref: library/ssl ssl PROTOCOL_SSLv27168256
Ref: 260f7168256
Ref: library/ssl ssl PROTOCOL_SSLv37168621
Ref: 26007168621
Ref: library/ssl ssl PROTOCOL_TLSv17169113
Ref: 26107169113
Ref: library/ssl ssl PROTOCOL_TLSv1_17169412
Ref: 8b37169412
Ref: library/ssl ssl PROTOCOL_TLSv1_27169788
Ref: 8b47169788
Ref: library/ssl ssl OP_ALL7170290
Ref: 26117170290
Ref: library/ssl ssl OP_NO_SSLv27170547
Ref: b937170547
Ref: library/ssl ssl OP_NO_SSLv37170848
Ref: 25ef7170848
Ref: library/ssl ssl OP_NO_TLSv17171149
Ref: 26127171149
Ref: library/ssl ssl OP_NO_TLSv1_17171588
Ref: 26137171588
Ref: library/ssl ssl OP_NO_TLSv1_27171975
Ref: 26147171975
Ref: library/ssl ssl OP_NO_TLSv1_37172362
Ref: 26157172362
Ref: library/ssl ssl OP_NO_RENEGOTIATION7172953
Ref: 26167172953
Ref: library/ssl ssl OP_CIPHER_SERVER_PREFERENCE7173234
Ref: a907173234
Ref: library/ssl ssl OP_SINGLE_DH_USE7173465
Ref: 26177173465
Ref: library/ssl ssl OP_SINGLE_ECDH_USE7173719
Ref: 26187173719
Ref: library/ssl ssl OP_ENABLE_MIDDLEBOX_COMPAT7173977
Ref: 26197173977
Ref: library/ssl ssl OP_NO_COMPRESSION7174254
Ref: a8b7174254
Ref: library/ssl ssl Options7174511
Ref: 261a7174511
Ref: library/ssl ssl OP_NO_TICKET7174597
Ref: 261b7174597
Ref: library/ssl ssl HAS_ALPN7174711
Ref: 7477174711
Ref: library/ssl ssl HAS_NEVER_CHECK_COMMON_NAME7174918
Ref: 261c7174918
Ref: library/ssl ssl HAS_ECDH7175154
Ref: 261d7175154
Ref: library/ssl ssl HAS_SNI7175411
Ref: 261e7175411
Ref: library/ssl ssl HAS_NPN7175592
Ref: 261f7175592
Ref: library/ssl ssl HAS_SSLv27175943
Ref: 26207175943
Ref: library/ssl ssl HAS_SSLv37176080
Ref: 26217176080
Ref: library/ssl ssl HAS_TLSv17176217
Ref: 26227176217
Ref: library/ssl ssl HAS_TLSv1_17176354
Ref: 3de7176354
Ref: library/ssl ssl HAS_TLSv1_27176493
Ref: 26237176493
Ref: library/ssl ssl HAS_TLSv1_37176632
Ref: 26247176632
Ref: library/ssl ssl CHANNEL_BINDING_TYPES7176771
Ref: 26257176771
Ref: library/ssl ssl OPENSSL_VERSION7176989
Ref: b947176989
Ref: library/ssl ssl OPENSSL_VERSION_INFO7177191
Ref: b957177191
Ref: library/ssl ssl OPENSSL_VERSION_NUMBER7177407
Ref: b967177407
Ref: library/ssl ssl ALERT_DESCRIPTION_HANDSHAKE_FAILURE7177646
Ref: 26267177646
Ref: library/ssl ssl ALERT_DESCRIPTION_INTERNAL_ERROR7177696
Ref: 26277177696
Ref: library/ssl ssl AlertDescription7178088
Ref: 26287178088
Ref: library/ssl ssl Purpose SERVER_AUTH7178228
Ref: 8c07178228
Ref: library/ssl ssl Purpose CLIENT_AUTH7178541
Ref: 8c17178541
Ref: library/ssl ssl SSLErrorNumber7178854
Ref: 26297178854
Ref: library/ssl ssl TLSVersion7178979
Ref: 262a7178979
Ref: library/ssl ssl TLSVersion MINIMUM_SUPPORTED7179194
Ref: 262b7179194
Ref: library/ssl ssl TLSVersion MAXIMUM_SUPPORTED7179239
Ref: 262c7179239
Ref: library/ssl ssl TLSVersion SSLv37179462
Ref: 262d7179462
Ref: library/ssl ssl TLSVersion TLSv17179495
Ref: 262e7179495
Ref: library/ssl ssl TLSVersion TLSv1_17179528
Ref: 262f7179528
Ref: library/ssl ssl TLSVersion TLSv1_27179563
Ref: 26307179563
Ref: library/ssl ssl TLSVersion TLSv1_37179598
Ref: 26317179598
Ref: Constants<9>-Footnote-17179695
Ref: Constants<9>-Footnote-27179744
Ref: Constants<9>-Footnote-37179793
Ref: Constants<9>-Footnote-47179871
Ref: Constants<9>-Footnote-57179920
Node: SSL Sockets7180013
Ref: library/ssl ssl-sockets7180167
Ref: 26327180167
Ref: library/ssl ssl SSLSocket7180210
Ref: 3d77180210
Ref: library/ssl ssl SSLSocket read7182386
Ref: 74f7182386
Ref: library/ssl ssl SSLSocket write7183206
Ref: 7507183206
Ref: library/ssl ssl SSLSocket do_handshake7184436
Ref: 74e7184436
Ref: library/ssl ssl SSLSocket getpeercert7185200
Ref: 8c57185200
Ref: library/ssl ssl SSLSocket cipher7188643
Ref: 25377188643
Ref: library/ssl ssl SSLSocket shared_ciphers7188927
Ref: 74d7188927
Ref: library/ssl ssl SSLSocket compression7189408
Ref: a8a7189408
Ref: library/ssl ssl SSLSocket get_channel_binding7189753
Ref: a897189753
Ref: library/ssl ssl SSLSocket selected_alpn_protocol7190386
Ref: 7467190386
Ref: library/ssl ssl SSLSocket selected_npn_protocol7190797
Ref: 26357190797
Ref: library/ssl ssl SSLSocket unwrap7191151
Ref: 26337191151
Ref: library/ssl ssl SSLSocket verify_client_post_handshake7191574
Ref: 2237191574
Ref: library/ssl ssl SSLSocket version7192452
Ref: 7497192452
Ref: library/ssl ssl SSLSocket pending7192863
Ref: 26367192863
Ref: library/ssl ssl SSLSocket context7193001
Ref: 26347193001
Ref: library/ssl ssl SSLSocket server_side7193349
Ref: 26377193349
Ref: library/ssl ssl SSLSocket server_hostname7193519
Ref: 3d57193519
Ref: library/ssl ssl SSLSocket session7194022
Ref: 26387194022
Ref: library/ssl ssl SSLSocket session_reused7194378
Ref: 26397194378
Ref: SSL Sockets-Footnote-17194481
Ref: SSL Sockets-Footnote-27194530
Node: SSL Contexts7194579
Ref: library/ssl ssl-contexts7194711
Ref: 263a7194711
Ref: library/ssl ssl SSLContext7195055
Ref: 3d97195055
Ref: library/ssl ssl SSLContext cert_store_stats7199042
Ref: 8b87199042
Ref: library/ssl ssl SSLContext load_cert_chain7199436
Ref: a867199436
Ref: library/ssl ssl SSLContext load_default_certs7201062
Ref: 8bf7201062
Ref: library/ssl ssl SSLContext load_verify_locations7201886
Ref: 7df7201886
Ref: library/ssl ssl SSLContext get_ca_certs7203216
Ref: 8b97203216
Ref: library/ssl ssl SSLContext get_ciphers7203851
Ref: 5817203851
Ref: library/ssl ssl SSLContext set_default_verify_paths7205593
Ref: 8b77205593
Ref: library/ssl ssl SSLContext set_ciphers7206062
Ref: 26047206062
Ref: library/ssl ssl SSLContext set_alpn_protocols7206710
Ref: 7457206710
Ref: library/ssl ssl SSLContext set_npn_protocols7207598
Ref: a8c7207598
Ref: library/ssl ssl SSLContext sni_callback7208267
Ref: 263c7208267
Ref: library/ssl ssl SSLContext set_servername_callback7210835
Ref: 8c47210835
Ref: library/ssl ssl SSLContext load_dh_params7211516
Ref: a877211516
Ref: library/ssl ssl SSLContext set_ecdh_curve7212059
Ref: a887212059
Ref: library/ssl ssl SSLContext wrap_socket7212786
Ref: 3da7212786
Ref: library/ssl ssl SSLContext sslsocket_class7215573
Ref: 263d7215573
Ref: library/ssl ssl SSLContext wrap_bio7215869
Ref: 3db7215869
Ref: library/ssl ssl SSLContext sslobject_class7216608
Ref: 263e7216608
Ref: library/ssl ssl SSLContext session_stats7216901
Ref: 263f7216901
Ref: library/ssl ssl SSLContext check_hostname7217346
Ref: 26097217346
Ref: library/ssl ssl SSLContext keylog_filename7218906
Ref: 25f27218906
Ref: library/ssl ssl SSLContext maximum_version7219414
Ref: 3dd7219414
Ref: library/ssl ssl SSLContext minimum_version7220397
Ref: 3dc7220397
Ref: library/ssl ssl SSLContext num_tickets7220731
Ref: 26407220731
Ref: library/ssl ssl SSLContext options7221078
Ref: 26037221078
Ref: library/ssl ssl SSLContext post_handshake_auth7221833
Ref: 2227221833
Ref: library/ssl ssl SSLContext protocol7222816
Ref: 26417222816
Ref: library/ssl ssl SSLContext hostname_checks_common_name7222952
Ref: 3d37222952
Ref: library/ssl ssl SSLContext verify_flags7223273
Ref: 8ba7223273
Ref: library/ssl ssl SSLContext verify_mode7223865
Ref: 25f07223865
Ref: SSL Contexts-Footnote-17224361
Ref: SSL Contexts-Footnote-27224519
Ref: SSL Contexts-Footnote-37224610
Ref: SSL Contexts-Footnote-47224702
Ref: SSL Contexts-Footnote-57224860
Ref: SSL Contexts-Footnote-67224951
Ref: SSL Contexts-Footnote-77225043
Ref: SSL Contexts-Footnote-87225131
Ref: SSL Contexts-Footnote-97225196
Ref: SSL Contexts-Footnote-107225245
Ref: SSL Contexts-Footnote-117225324
Ref: SSL Contexts-Footnote-127225374
Ref: SSL Contexts-Footnote-137225451
Node: Certificates7225528
Ref: library/ssl certificates7225661
Ref: 26427225661
Ref: library/ssl ssl-certificates7225661
Ref: 263b7225661
Ref: Certificates-Footnote-17228000
Node: Certificate chains7228049
Ref: library/ssl certificate-chains7228140
Ref: 26437228140
Node: CA certificates7229371
Ref: library/ssl ca-certificates7229499
Ref: 26447229499
Node: Combined key and certificate7230089
Ref: library/ssl combined-key-and-certificate7230223
Ref: 26457230223
Node: Self-signed certificates7230844
Ref: library/ssl self-signed-certificates7230954
Ref: 26467230954
Node: Examples<16>7232552
Ref: library/ssl examples7232702
Ref: 26477232702
Node: Testing for SSL support7232831
Ref: library/ssl testing-for-ssl-support7232933
Ref: 26487232933
Node: Client-side operation7233222
Ref: library/ssl client-side-operation7233354
Ref: 26497233354
Node: Server-side operation7237802
Ref: library/ssl server-side-operation7237902
Ref: 264a7237902
Node: Notes on non-blocking sockets7239807
Ref: library/ssl notes-on-non-blocking-sockets7239966
Ref: 264b7239966
Ref: library/ssl ssl-nonblocking7239966
Ref: 25f57239966
Node: Memory BIO Support<2>7242784
Ref: library/ssl memory-bio-support7242942
Ref: 264d7242942
Ref: library/ssl ssl SSLObject7244058
Ref: 3d87244058
Ref: library/ssl ssl MemoryBIO7247686
Ref: 7437247686
Ref: library/ssl ssl MemoryBIO pending7247814
Ref: 264e7247814
Ref: library/ssl ssl MemoryBIO eof7247913
Ref: 264f7247913
Ref: library/ssl ssl MemoryBIO read7248043
Ref: 26507248043
Ref: library/ssl ssl MemoryBIO write7248201
Ref: 26517248201
Ref: library/ssl ssl MemoryBIO write_eof7248483
Ref: 26527248483
Node: SSL session7248775
Ref: library/ssl ssl-session7248927
Ref: 26537248927
Ref: library/ssl ssl SSLSession7248993
Ref: 5807248993
Ref: library/ssl ssl SSLSession id7249070
Ref: 26547249070
Ref: library/ssl ssl SSLSession time7249094
Ref: 26557249094
Ref: library/ssl ssl SSLSession timeout7249120
Ref: 26567249120
Ref: library/ssl ssl SSLSession ticket_lifetime_hint7249149
Ref: 26577249149
Ref: library/ssl ssl SSLSession has_ticket7249191
Ref: 26587249191
Node: Security considerations7249223
Ref: library/ssl security-considerations7249361
Ref: 26597249361
Ref: library/ssl ssl-security7249361
Ref: 24f07249361
Node: Best defaults7249499
Ref: library/ssl best-defaults7249596
Ref: 265a7249596
Node: Manual settings7250737
Ref: library/ssl manual-settings7250859
Ref: 265b7250859
Node: Verifying certificates7250992
Ref: library/ssl verifying-certificates7251092
Ref: 265c7251092
Node: Protocol versions7252355
Ref: library/ssl protocol-versions7252480
Ref: 265d7252480
Node: Cipher selection7253271
Ref: library/ssl cipher-selection7253365
Ref: 265e7253365
Ref: Cipher selection-Footnote-17254021
Node: Multi-processing7254106
Ref: library/ssl multi-processing7254206
Ref: 265f7254206
Node: TLS 1 37254761
Ref: library/ssl ssl-tlsv1-37254904
Ref: 3d67254904
Ref: library/ssl tls-1-37254904
Ref: 26607254904
Node: LibreSSL support7256075
Ref: library/ssl libressl-support7256186
Ref: 26617256186
Ref: library/ssl ssl-libressl7256186
Ref: 26627256186
Ref: LibreSSL support-Footnote-17257810
Ref: LibreSSL support-Footnote-27257876
Ref: LibreSSL support-Footnote-37257925
Ref: LibreSSL support-Footnote-47257974
Ref: LibreSSL support-Footnote-57258023
Ref: LibreSSL support-Footnote-67258072
Ref: LibreSSL support-Footnote-77258121
Ref: LibreSSL support-Footnote-87258197
Ref: LibreSSL support-Footnote-97258246
Node: select — Waiting for I/O completion7258304
Ref: library/select doc7258520
Ref: 26637258520
Ref: library/select module-select7258520
Ref: e57258520
Ref: library/select select-waiting-for-i-o-completion7258520
Ref: 26647258520
Ref: library/select select error7259528
Ref: 98a7259528
Ref: library/select select devpoll7259715
Ref: 89f7259715
Ref: library/select select epoll7260435
Ref: 89d7260435
Ref: library/select select poll7261921
Ref: 264c7261921
Ref: library/select select kqueue7262240
Ref: 26687262240
Ref: library/select select kevent7262579
Ref: 266a7262579
Ref: library/select select select7262856
Ref: 6677262856
Ref: library/select select PIPE_BUF7265125
Ref: b797265125
Ref: select — Waiting for I/O completion-Footnote-17265821
Ref: select — Waiting for I/O completion-Footnote-27265870
Node: /dev/poll Polling Objects7265919
Ref: library/select dev-poll-polling-objects7266071
Ref: 266c7266071
Ref: library/select devpoll-objects7266071
Ref: 26657266071
Ref: library/select select devpoll close7266425
Ref: 8a17266425
Ref: library/select select devpoll closed7266536
Ref: 8a27266536
Ref: library/select select devpoll fileno7266643
Ref: 8a07266643
Ref: library/select select devpoll register7266763
Ref: 266d7266763
Ref: library/select select devpoll modify7267747
Ref: 266e7267747
Ref: library/select select devpoll unregister7267955
Ref: 266f7267955
Ref: library/select select devpoll poll7268312
Ref: 6637268312
Ref: /dev/poll Polling Objects-Footnote-17269455
Node: Edge and Level Trigger Polling epoll Objects7269504
Ref: library/select edge-and-level-trigger-polling-epoll-objects7269680
Ref: 26707269680
Ref: library/select epoll-objects7269680
Ref: 26667269680
Ref: library/select select epoll close7272548
Ref: 89e7272548
Ref: library/select select epoll closed7272637
Ref: 26717272637
Ref: library/select select epoll fileno7272714
Ref: 26727272714
Ref: library/select select epoll fromfd7272802
Ref: 26737272802
Ref: library/select select epoll register7272892
Ref: 26747272892
Ref: library/select select epoll modify7272992
Ref: 26757272992
Ref: library/select select epoll unregister7273077
Ref: 26767273077
Ref: library/select select epoll poll7273177
Ref: 6647273177
Ref: Edge and Level Trigger Polling epoll Objects-Footnote-17273579
Node: Polling Objects7273628
Ref: library/select poll-objects7273793
Ref: 26677273793
Ref: library/select polling-objects7273793
Ref: 26777273793
Ref: library/select select poll register7274360
Ref: 26787274360
Ref: library/select select poll modify7276337
Ref: 26797276337
Ref: library/select select poll unregister7276638
Ref: 267a7276638
Ref: library/select select poll poll7277027
Ref: 6667277027
Ref: Polling Objects-Footnote-17278173
Node: Kqueue Objects7278222
Ref: library/select id17278357
Ref: 267b7278357
Ref: library/select kqueue-objects7278357
Ref: 26697278357
Ref: library/select select kqueue close7278406
Ref: 267c7278406
Ref: library/select select kqueue closed7278497
Ref: 267d7278497
Ref: library/select select kqueue fileno7278576
Ref: 267e7278576
Ref: library/select select kqueue fromfd7278665
Ref: 267f7278665
Ref: library/select select kqueue control7278756
Ref: 6657278756
Ref: Kqueue Objects-Footnote-17279407
Node: Kevent Objects7279456
Ref: library/select id27279567
Ref: 26807279567
Ref: library/select kevent-objects7279567
Ref: 266b7279567
Ref: library/select select kevent ident7279682
Ref: 26817279682
Ref: library/select select kevent filter7279984
Ref: 26827279984
Ref: library/select select kevent flags7281766
Ref: 26837281766
Ref: library/select select kevent fflags7283427
Ref: 26847283427
Ref: library/select select kevent data7287172
Ref: 26857287172
Ref: library/select select kevent udata7287228
Ref: 26867287228
Node: selectors — High-level I/O multiplexing7287283
Ref: library/selectors doc7287497
Ref: 26877287497
Ref: library/selectors module-selectors7287497
Ref: e67287497
Ref: library/selectors selectors-high-level-i-o-multiplexing7287497
Ref: 26887287497
Ref: selectors — High-level I/O multiplexing-Footnote-17287855
Node: Introduction<9>7287923
Ref: library/selectors introduction7288035
Ref: 26897288035
Node: Classes<3>7289202
Ref: library/selectors classes7289335
Ref: 268c7289335
Ref: library/selectors selectors SelectorKey7290089
Ref: 268d7290089
Ref: library/selectors selectors SelectorKey fileobj7290367
Ref: 268e7290367
Ref: library/selectors selectors SelectorKey fd7290431
Ref: 268f7290431
Ref: library/selectors selectors SelectorKey events7290494
Ref: 26907290494
Ref: library/selectors selectors SelectorKey data7290585
Ref: 26917290585
Ref: library/selectors selectors BaseSelector7290751
Ref: 268a7290751
Ref: library/selectors selectors BaseSelector register7291427
Ref: 26927291427
Ref: library/selectors selectors BaseSelector unregister7292081
Ref: 26937292081
Ref: library/selectors selectors BaseSelector modify7292701
Ref: 4407292701
Ref: library/selectors selectors BaseSelector select7293301
Ref: 26947293301
Ref: library/selectors selectors BaseSelector close7294600
Ref: 26957294600
Ref: library/selectors selectors BaseSelector get_key7294818
Ref: 26967294818
Ref: library/selectors selectors BaseSelector get_map7295105
Ref: 26977295105
Ref: library/selectors selectors DefaultSelector7295374
Ref: 268b7295374
Ref: library/selectors selectors SelectSelector7295582
Ref: 25867295582
Ref: library/selectors selectors PollSelector7295669
Ref: 4427295669
Ref: library/selectors selectors EpollSelector7295753
Ref: 4417295753
Ref: library/selectors selectors EpollSelector fileno7295838
Ref: 26987295838
Ref: library/selectors selectors DevpollSelector7295978
Ref: 4437295978
Ref: library/selectors selectors DevpollSelector fileno7296067
Ref: 26997296067
Ref: library/selectors selectors KqueueSelector7296235
Ref: 25897296235
Ref: library/selectors selectors KqueueSelector fileno7296323
Ref: 269a7296323
Ref: Classes<3>-Footnote-17296501
Node: Examples<17>7296550
Ref: library/selectors examples7296659
Ref: 269b7296659
Node: asyncore — Asynchronous socket handler7297556
Ref: library/asyncore doc7297790
Ref: 269c7297790
Ref: library/asyncore asyncore-asynchronous-socket-handler7297790
Ref: 269d7297790
Ref: library/asyncore module-asyncore7297790
Ref: b7297790
Ref: library/asyncore asyncore loop7300090
Ref: 269e7300090
Ref: library/asyncore asyncore dispatcher7301120
Ref: bb67301120
Ref: library/asyncore asyncore dispatcher handle_read7303039
Ref: 26a17303039
Ref: library/asyncore asyncore dispatcher handle_write7303200
Ref: 26a27303200
Ref: library/asyncore asyncore dispatcher handle_expt7303546
Ref: 26a37303546
Ref: library/asyncore asyncore dispatcher handle_connect7303758
Ref: 26a47303758
Ref: library/asyncore asyncore dispatcher handle_close7304005
Ref: 26a57304005
Ref: library/asyncore asyncore dispatcher handle_error7304084
Ref: 26a67304084
Ref: library/asyncore asyncore dispatcher handle_accept7304251
Ref: bb87304251
Ref: library/asyncore asyncore dispatcher handle_accepted7304630
Ref: bb77304630
Ref: library/asyncore asyncore dispatcher readable7305118
Ref: 269f7305118
Ref: library/asyncore asyncore dispatcher writable7305470
Ref: 26a07305470
Ref: library/asyncore asyncore dispatcher create_socket7305977
Ref: 26a87305977
Ref: library/asyncore asyncore dispatcher connect7306376
Ref: 26a77306376
Ref: library/asyncore asyncore dispatcher send7306577
Ref: 26a97306577
Ref: library/asyncore asyncore dispatcher recv7306669
Ref: 26aa7306669
Ref: library/asyncore asyncore dispatcher listen7307116
Ref: 26ab7307116
Ref: library/asyncore asyncore dispatcher bind7307387
Ref: 26ac7307387
Ref: library/asyncore asyncore dispatcher accept7307826
Ref: bb97307826
Ref: library/asyncore asyncore dispatcher close7308468
Ref: 26ad7308468
Ref: library/asyncore asyncore dispatcher_with_send7308756
Ref: 26ae7308756
Ref: library/asyncore asyncore file_dispatcher7308987
Ref: 26af7308987
Ref: library/asyncore asyncore file_wrapper7309417
Ref: 26b07309417
Ref: asyncore — Asynchronous socket handler-Footnote-17309933
Node: asyncore Example basic HTTP client7310000
Ref: library/asyncore asyncore-example-17310154
Ref: 26b17310154
Ref: library/asyncore asyncore-example-basic-http-client7310154
Ref: 26b27310154
Node: asyncore Example basic echo server7311064
Ref: library/asyncore asyncore-example-27311218
Ref: 26b37311218
Ref: library/asyncore asyncore-example-basic-echo-server7311218
Ref: 26b47311218
Node: asynchat — Asynchronous socket command/response handler7312060
Ref: library/asynchat doc7312300
Ref: 26b57312300
Ref: library/asynchat asynchat-asynchronous-socket-command-response-handler7312300
Ref: 26b67312300
Ref: library/asynchat module-asynchat7312300
Ref: 97312300
Ref: library/asynchat asynchat async_chat7313511
Ref: 8a97313511
Ref: library/asynchat asynchat async_chat ac_in_buffer_size7314426
Ref: 26b97314426
Ref: library/asynchat asynchat async_chat ac_out_buffer_size7314528
Ref: 26ba7314528
Ref: library/asynchat asynchat async_chat close_when_done7315723
Ref: 26bc7315723
Ref: library/asynchat asynchat async_chat collect_incoming_data7315903
Ref: 26b77315903
Ref: library/asynchat asynchat async_chat discard_buffers7316135
Ref: 26bd7316135
Ref: library/asynchat asynchat async_chat found_terminator7316302
Ref: 26b87316302
Ref: library/asynchat asynchat async_chat get_terminator7316651
Ref: 26be7316651
Ref: library/asynchat asynchat async_chat push7316747
Ref: 26bf7316747
Ref: library/asynchat asynchat async_chat push_with_producer7317084
Ref: 26c07317084
Ref: library/asynchat asynchat async_chat set_terminator7317433
Ref: 26bb7317433
Ref: asynchat — Asynchronous socket command/response handler-Footnote-17318523
Node: asynchat Example7318590
Ref: library/asynchat asynchat-example7318700
Ref: 26c17318700
Ref: library/asynchat id17318700
Ref: 26c27318700
Node: signal — Set handlers for asynchronous events7320884
Ref: library/signal doc7321119
Ref: 26c37321119
Ref: library/signal module-signal7321119
Ref: ea7321119
Ref: library/signal signal-set-handlers-for-asynchronous-events7321119
Ref: 26c47321119
Node: General rules7321481
Ref: library/signal general-rules7321605
Ref: 26c57321605
Node: Execution of Python signal handlers7322401
Ref: library/signal execution-of-python-signal-handlers7322514
Ref: 26c67322514
Node: Signals and threads7323658
Ref: library/signal id17323771
Ref: 26c87323771
Ref: library/signal signals-and-threads7323771
Ref: 26c97323771
Node: Module contents<2>7324197
Ref: library/signal module-contents7324340
Ref: 26ca7324340
Ref: library/signal signal SIG_DFL7324853
Ref: 24017324853
Ref: library/signal signal SIG_IGN7325173
Ref: 24027325173
Ref: library/signal signal CTRL_C_EVENT7325850
Ref: 1ee07325850
Ref: library/signal signal CTRL_BREAK_EVENT7326079
Ref: 1ee17326079
Ref: library/signal signal NSIG7326316
Ref: 26cf7326316
Ref: library/signal signal ITIMER_REAL7326400
Ref: 26d07326400
Ref: library/signal signal ITIMER_VIRTUAL7326525
Ref: 26d17326525
Ref: library/signal signal ITIMER_PROF7326671
Ref: 26d27326671
Ref: library/signal signal SIG_BLOCK7327010
Ref: 26cb7327010
Ref: library/signal signal SIG_UNBLOCK7327192
Ref: 26cc7327192
Ref: library/signal signal SIG_SETMASK7327383
Ref: 26cd7327383
Ref: library/signal signal ItimerError7327633
Ref: 26d37327633
Ref: library/signal signal alarm7328156
Ref: 26d67328156
Ref: library/signal signal getsignal7328788
Ref: 26ce7328788
Ref: library/signal signal strsignal7329360
Ref: f677329360
Ref: library/signal signal valid_signals7329618
Ref: 26d77329618
Ref: library/signal signal pause7329861
Ref: 26d87329861
Ref: library/signal signal raise_signal7330248
Ref: 26d97330248
Ref: library/signal signal pthread_kill7330381
Ref: a6f7330381
Ref: library/signal signal pthread_sigmask7331458
Ref: a6e7331458
Ref: library/signal signal setitimer7332801
Ref: 26d47332801
Ref: library/signal signal getitimer7333814
Ref: 26d57333814
Ref: library/signal signal set_wakeup_fd7333974
Ref: 3c37333974
Ref: library/signal signal siginterrupt7336131
Ref: a737336131
Ref: library/signal signal signal7336735
Ref: a727336735
Ref: library/signal signal sigpending7338149
Ref: a707338149
Ref: library/signal signal sigwait7338608
Ref: a717338608
Ref: library/signal signal sigwaitinfo7339186
Ref: 6737339186
Ref: library/signal signal sigtimedwait7340450
Ref: 6727340450
Ref: Module contents<2>-Footnote-17341219
Ref: Module contents<2>-Footnote-27341268
Node: Example<9>7341317
Ref: library/signal example7341462
Ref: 26da7341462
Ref: library/signal signal-example7341462
Ref: 26db7341462
Node: Note on SIGPIPE7342316
Ref: library/signal note-on-sigpipe7342434
Ref: 26dc7342434
Node: mmap — Memory-mapped file support7343749
Ref: library/mmap doc7343918
Ref: 26dd7343918
Ref: library/mmap mmap-memory-mapped-file-support7343918
Ref: 26de7343918
Ref: library/mmap module-mmap7343918
Ref: b37343918
Ref: library/mmap mmap mmap7346354
Ref: 1ea7346354
Ref: library/mmap mmap mmap close7351091
Ref: 26df7351091
Ref: library/mmap mmap mmap closed7351302
Ref: 26e07351302
Ref: library/mmap mmap mmap find7351406
Ref: 26e17351406
Ref: library/mmap mmap mmap flush7351836
Ref: 2c17351836
Ref: library/mmap mmap mmap madvise7352724
Ref: 1eb7352724
Ref: library/mmap mmap mmap move7353290
Ref: 26e37353290
Ref: library/mmap mmap mmap read7353568
Ref: a177353568
Ref: library/mmap mmap mmap read_byte7354020
Ref: 26e47354020
Ref: library/mmap mmap mmap readline7354168
Ref: 26e57354168
Ref: library/mmap mmap mmap resize7354308
Ref: 26e67354308
Ref: library/mmap mmap mmap rfind7354556
Ref: 26e77354556
Ref: library/mmap mmap mmap seek7354988
Ref: 26e87354988
Ref: library/mmap mmap mmap size7355374
Ref: 26e97355374
Ref: library/mmap mmap mmap tell7355513
Ref: 26ea7355513
Ref: library/mmap mmap mmap write7355600
Ref: 26eb7355600
Ref: library/mmap mmap mmap write_byte7356307
Ref: 26ec7356307
Node: MADV_* Constants7356653
Ref: library/mmap madv-constants7356741
Ref: 26ed7356741
Ref: library/mmap madvise-constants7356741
Ref: 26e27356741
Ref: library/mmap mmap MADV_NORMAL7356794
Ref: 26ee7356794
Ref: library/mmap mmap MADV_RANDOM7356821
Ref: 26ef7356821
Ref: library/mmap mmap MADV_SEQUENTIAL7356848
Ref: 26f07356848
Ref: library/mmap mmap MADV_WILLNEED7356879
Ref: 26f17356879
Ref: library/mmap mmap MADV_DONTNEED7356908
Ref: 26f27356908
Ref: library/mmap mmap MADV_REMOVE7356937
Ref: 26f37356937
Ref: library/mmap mmap MADV_DONTFORK7356964
Ref: 26f47356964
Ref: library/mmap mmap MADV_DOFORK7356993
Ref: 26f57356993
Ref: library/mmap mmap MADV_HWPOISON7357020
Ref: 26f67357020
Ref: library/mmap mmap MADV_MERGEABLE7357049
Ref: 26f77357049
Ref: library/mmap mmap MADV_UNMERGEABLE7357079
Ref: 26f87357079
Ref: library/mmap mmap MADV_SOFT_OFFLINE7357111
Ref: 26f97357111
Ref: library/mmap mmap MADV_HUGEPAGE7357144
Ref: 26fa7357144
Ref: library/mmap mmap MADV_NOHUGEPAGE7357173
Ref: 26fb7357173
Ref: library/mmap mmap MADV_DONTDUMP7357204
Ref: 26fc7357204
Ref: library/mmap mmap MADV_DODUMP7357233
Ref: 26fd7357233
Ref: library/mmap mmap MADV_FREE7357260
Ref: 26fe7357260
Ref: library/mmap mmap MADV_NOSYNC7357285
Ref: 26ff7357285
Ref: library/mmap mmap MADV_AUTOSYNC7357312
Ref: 27007357312
Ref: library/mmap mmap MADV_NOCORE7357341
Ref: 27017357341
Ref: library/mmap mmap MADV_CORE7357368
Ref: 27027357368
Ref: library/mmap mmap MADV_PROTECT7357393
Ref: 27037357393
Node: Internet Data Handling7357628
Ref: library/netdata doc7357807
Ref: 27047357807
Ref: library/netdata internet-data-handling7357807
Ref: 27057357807
Ref: library/netdata netdata7357807
Ref: 27067357807
Node: email — An email and MIME handling package7358516
Ref: library/email doc7358661
Ref: 27077358661
Ref: library/email email-an-email-and-mime-handling-package7358661
Ref: 27087358661
Ref: library/email module-email7358661
Ref: 697358661
Ref: email — An email and MIME handling package-Footnote-17365421
Ref: email — An email and MIME handling package-Footnote-27365494
Ref: email — An email and MIME handling package-Footnote-37365543
Ref: email — An email and MIME handling package-Footnote-47365592
Ref: email — An email and MIME handling package-Footnote-57365641
Ref: email — An email and MIME handling package-Footnote-67365690
Ref: email — An email and MIME handling package-Footnote-77365739
Ref: email — An email and MIME handling package-Footnote-87365788
Ref: email — An email and MIME handling package-Footnote-97365837
Node: email message Representing an email message7365886
Ref: library/email message doc7366054
Ref: 27097366054
Ref: library/email message email-message-representing-an-email-message7366054
Ref: 270a7366054
Ref: library/email message module-email message7366054
Ref: 727366054
Ref: library/email message email message EmailMessage7368542
Ref: 5377368542
Ref: library/email message email message EmailMessage as_string7369023
Ref: 270d7369023
Ref: library/email message email message EmailMessage __str__7370867
Ref: 270e7370867
Ref: library/email message email message EmailMessage as_bytes7371336
Ref: 270f7371336
Ref: library/email message email message EmailMessage __bytes__7372498
Ref: 27107372498
Ref: library/email message email message EmailMessage is_multipart7372674
Ref: 27117372674
Ref: library/email message email message EmailMessage set_unixfrom7373359
Ref: 27127373359
Ref: library/email message email message EmailMessage get_unixfrom7373581
Ref: 27147373581
Ref: library/email message email message EmailMessage __len__7374713
Ref: 27167374713
Ref: library/email message email message EmailMessage __contains__7374811
Ref: 27177374811
Ref: library/email message email message EmailMessage __getitem__7375186
Ref: 27187375186
Ref: library/email message email message EmailMessage __setitem__7375903
Ref: 271b7375903
Ref: library/email message email message EmailMessage __delitem__7376921
Ref: 271c7376921
Ref: library/email message email message EmailMessage keys7377147
Ref: 27157377147
Ref: library/email message email message EmailMessage values7377241
Ref: 271d7377241
Ref: library/email message email message EmailMessage items7377331
Ref: 271e7377331
Ref: library/email message email message EmailMessage get7377462
Ref: 271f7377462
Ref: library/email message email message EmailMessage get_all7377811
Ref: 27197377811
Ref: library/email message email message EmailMessage add_header7378048
Ref: 27207378048
Ref: library/email message email message EmailMessage replace_header7379997
Ref: 27217379997
Ref: library/email message email message EmailMessage get_content_type7380303
Ref: 27227380303
Ref: library/email message email message EmailMessage get_content_maintype7381187
Ref: 27247381187
Ref: library/email message email message EmailMessage get_content_subtype7381393
Ref: 27257381393
Ref: library/email message email message EmailMessage get_default_type7381586
Ref: 27237381586
Ref: library/email message email message EmailMessage set_default_type7381906
Ref: 27267381906
Ref: library/email message email message EmailMessage set_param7382348
Ref: 27277382348
Ref: library/email message email message EmailMessage del_param7383962
Ref: 27287383962
Ref: library/email message email message EmailMessage get_filename7384398
Ref: 27297384398
Ref: library/email message email message EmailMessage get_boundary7384937
Ref: 272b7384937
Ref: library/email message email message EmailMessage set_boundary7385301
Ref: 272c7385301
Ref: library/email message email message EmailMessage get_content_charset7385969
Ref: 272e7385969
Ref: library/email message email message EmailMessage get_charsets7386271
Ref: 272f7386271
Ref: library/email message email message EmailMessage is_attachment7386964
Ref: 27307386964
Ref: library/email message email message EmailMessage get_content_disposition7387331
Ref: 27327387331
Ref: library/email message email message EmailMessage walk7387806
Ref: 27337387806
Ref: library/email message email message EmailMessage get_body7389429
Ref: 27347389429
Ref: library/email message email message EmailMessage iter_attachments7391548
Ref: 27357391548
Ref: library/email message email message EmailMessage iter_parts7392522
Ref: 27367392522
Ref: library/email message email message EmailMessage get_content7392735
Ref: 27377392735
Ref: library/email message email message EmailMessage set_content7393145
Ref: 27397393145
Ref: library/email message email message EmailMessage make_related7393555
Ref: 273b7393555
Ref: library/email message email message EmailMessage make_alternative7394043
Ref: 273c7394043
Ref: library/email message email message EmailMessage make_mixed7394562
Ref: 273d7394562
Ref: library/email message email message EmailMessage add_related7395101
Ref: 273e7395101
Ref: library/email message email message EmailMessage add_alternative7395858
Ref: 27407395858
Ref: library/email message email message EmailMessage add_attachment7396548
Ref: 27417396548
Ref: library/email message email message EmailMessage clear7397533
Ref: 27427397533
Ref: library/email message email message EmailMessage clear_content7397614
Ref: 27437397614
Ref: library/email message email message EmailMessage preamble7397874
Ref: 27447397874
Ref: library/email message email message EmailMessage epilogue7399136
Ref: 27457399136
Ref: library/email message email message EmailMessage defects7399482
Ref: 27467399482
Ref: library/email message email message MIMEPart7399724
Ref: 8377399724
Ref: email message Representing an email message-Footnote-17400090
Ref: email message Representing an email message-Footnote-27400162
Ref: email message Representing an email message-Footnote-37400362
Ref: email message Representing an email message-Footnote-47400411
Ref: email message Representing an email message-Footnote-57400460
Ref: email message Representing an email message-Footnote-67400509
Ref: email message Representing an email message-Footnote-77400558
Ref: email message Representing an email message-Footnote-87400607
Ref: email message Representing an email message-Footnote-97400656
Ref: email message Representing an email message-Footnote-107400705
Ref: email message Representing an email message-Footnote-117400755
Ref: email message Representing an email message-Footnote-127400805
Ref: email message Representing an email message-Footnote-137400855
Node: email parser Parsing email messages7400905
Ref: library/email parser doc7401123
Ref: 27477401123
Ref: library/email parser email-parser-parsing-email-messages7401123
Ref: 27487401123
Ref: library/email parser module-email parser7401123
Ref: 747401123
Ref: email parser Parsing email messages-Footnote-17403508
Node: FeedParser API7403579
Ref: library/email parser feedparser-api7403684
Ref: 274a7403684
Ref: library/email parser email parser BytesFeedParser7404977
Ref: b3c7404977
Ref: library/email parser email parser BytesFeedParser feed7406176
Ref: 274b7406176
Ref: library/email parser email parser BytesFeedParser close7406611
Ref: 274c7406611
Ref: library/email parser email parser FeedParser7406851
Ref: 27497406851
Node: Parser API7407309
Ref: library/email parser parser-api7407439
Ref: 274d7407439
Ref: library/email parser email parser BytesParser7408167
Ref: b3d7408167
Ref: library/email parser email parser BytesParser parse7408834
Ref: 274e7408834
Ref: library/email parser email parser BytesParser parsebytes7409874
Ref: 274f7409874
Ref: library/email parser email parser BytesHeaderParser7410380
Ref: 9f07410380
Ref: library/email parser email parser Parser7410598
Ref: b0b7410598
Ref: library/email parser email parser Parser parse7410943
Ref: 27507410943
Ref: library/email parser email parser Parser parsestr7411381
Ref: 27517411381
Ref: library/email parser email parser HeaderParser7411810
Ref: 9f17411810
Ref: library/email parser email message_from_bytes7412207
Ref: b3a7412207
Ref: library/email parser email message_from_binary_file7412674
Ref: b3b7412674
Ref: library/email parser email message_from_string7413147
Ref: 27527413147
Ref: library/email parser email message_from_file7413542
Ref: 27537413542
Ref: Parser API-Footnote-17414267
Ref: Parser API-Footnote-27414316
Node: Additional notes7414365
Ref: library/email parser additional-notes7414472
Ref: 27547414472
Node: email generator Generating MIME documents7416014
Ref: library/email generator doc7416216
Ref: 27557416216
Ref: library/email generator email-generator-generating-mime-documents7416216
Ref: 27567416216
Ref: library/email generator module-email generator7416216
Ref: 6e7416216
Ref: library/email generator email generator BytesGenerator7418339
Ref: b407418339
Ref: library/email generator email generator BytesGenerator flatten7420245
Ref: 27577420245
Ref: library/email generator email generator BytesGenerator clone7422067
Ref: 275a7422067
Ref: library/email generator email generator BytesGenerator write7422265
Ref: 27587422265
Ref: library/email generator email generator Generator7423316
Ref: b3f7423316
Ref: library/email generator email generator Generator flatten7425162
Ref: 275b7425162
Ref: library/email generator email generator Generator clone7426922
Ref: 275d7426922
Ref: library/email generator email generator Generator write7427107
Ref: 275c7427107
Ref: library/email generator email generator DecodedGenerator7428016
Ref: 5337428016
Ref: email generator Generating MIME documents-Footnote-17429433
Ref: email generator Generating MIME documents-Footnote-27429507
Ref: email generator Generating MIME documents-Footnote-37430000
Ref: email generator Generating MIME documents-Footnote-47430052
Ref: email generator Generating MIME documents-Footnote-57430101
Ref: email generator Generating MIME documents-Footnote-67430153
Node: email policy Policy Objects7430202
Ref: library/email policy doc7430410
Ref: 275e7430410
Ref: library/email policy email-policy-policy-objects7430410
Ref: 275f7430410
Ref: library/email policy module-email policy7430410
Ref: 757430410
Ref: library/email policy email policy Policy7436255
Ref: 9e87436255
Ref: library/email policy email policy Policy max_line_length7437075
Ref: 27607437075
Ref: library/email policy email policy Policy linesep7437381
Ref: 27617437381
Ref: library/email policy email policy Policy cte_type7437650
Ref: 27597437650
Ref: library/email policy email policy Policy raise_on_defect7438761
Ref: 27637438761
Ref: library/email policy email policy Policy mangle_from_7439005
Ref: 6c47439005
Ref: library/email policy email policy Policy message_factory7439362
Ref: 5347439362
Ref: library/email policy email policy Policy clone7439799
Ref: 9ea7439799
Ref: library/email policy email policy Policy handle_defect7440273
Ref: 27657440273
Ref: library/email policy email policy Policy register_defect7440752
Ref: 27647440752
Ref: library/email policy email policy Policy header_max_count7441445
Ref: 27667441445
Ref: library/email policy email policy Policy header_source_parse7442507
Ref: 27677442507
Ref: library/email policy email policy Policy header_store_parse7443520
Ref: 27687443520
Ref: library/email policy email policy Policy header_fetch_parse7444281
Ref: 27697444281
Ref: library/email policy email policy Policy fold7445104
Ref: 276a7445104
Ref: library/email policy email policy Policy fold_binary7445820
Ref: 27627445820
Ref: library/email policy email policy EmailPolicy7446154
Ref: 9ec7446154
Ref: library/email policy email policy EmailPolicy utf87446984
Ref: 6c67446984
Ref: library/email policy email policy EmailPolicy refold_source7447380
Ref: 276b7447380
Ref: library/email policy email policy EmailPolicy header_factory7448175
Ref: 276c7448175
Ref: library/email policy email policy EmailPolicy content_manager7448786
Ref: 8387448786
Ref: library/email policy email policy EmailPolicy header_max_count7449495
Ref: 276e7449495
Ref: library/email policy email policy EmailPolicy header_source_parse7449701
Ref: 27707449701
Ref: library/email policy email policy EmailPolicy header_store_parse7450086
Ref: 27717450086
Ref: library/email policy email policy EmailPolicy header_fetch_parse7450567
Ref: 27727450567
Ref: library/email policy email policy EmailPolicy fold7450993
Ref: 27737450993
Ref: library/email policy email policy EmailPolicy fold_binary7452156
Ref: 27747452156
Ref: library/email policy email policy default7452975
Ref: 270c7452975
Ref: library/email policy email policy SMTP7453185
Ref: 27757453185
Ref: library/email policy email policy SMTPUTF87453387
Ref: 27767453387
Ref: library/email policy email policy HTTP7453801
Ref: 27777453801
Ref: library/email policy email policy strict7453993
Ref: 27787453993
Ref: library/email policy email policy Compat327455420
Ref: 9e97455420
Ref: library/email policy email policy Compat32 mangle_from_7455951
Ref: 27797455951
Ref: library/email policy email policy Compat32 header_source_parse7456139
Ref: 277a7456139
Ref: library/email policy email policy Compat32 header_store_parse7456524
Ref: 277b7456524
Ref: library/email policy email policy Compat32 header_fetch_parse7456630
Ref: 277c7456630
Ref: library/email policy email policy Compat32 fold7456872
Ref: 277e7456872
Ref: library/email policy email policy Compat32 fold_binary7457215
Ref: 277f7457215
Ref: library/email policy email policy compat327457745
Ref: 5357457745
Ref: email policy Policy Objects-Footnote-17457948
Ref: email policy Policy Objects-Footnote-27458019
Ref: email policy Policy Objects-Footnote-37458068
Ref: email policy Policy Objects-Footnote-47458117
Ref: email policy Policy Objects-Footnote-57458166
Ref: email policy Policy Objects-Footnote-67458215
Ref: email policy Policy Objects-Footnote-77458264
Ref: email policy Policy Objects-Footnote-87458313
Ref: email policy Policy Objects-Footnote-97458386
Ref: email policy Policy Objects-Footnote-107458435
Ref: email policy Policy Objects-Footnote-117458485
Ref: email policy Policy Objects-Footnote-127458535
Node: email errors Exception and Defect classes7458585
Ref: library/email errors doc7458794
Ref: 27807458794
Ref: library/email errors email-errors-exception-and-defect-classes7458794
Ref: 27817458794
Ref: library/email errors module-email errors7458794
Ref: 6d7458794
Ref: library/email errors email errors MessageError7459098
Ref: 27827459098
Ref: library/email errors email errors MessageParseError7459339
Ref: 27837459339
Ref: library/email errors email errors HeaderParseError7459615
Ref: 272d7459615
Ref: library/email errors email errors BoundaryError7460258
Ref: 27847460258
Ref: library/email errors email errors MultipartConversionError7460338
Ref: 27857460338
Ref: email errors Exception and Defect classes-Footnote-17463665
Ref: email errors Exception and Defect classes-Footnote-27463736
Node: email headerregistry Custom Header Objects7463785
Ref: library/email headerregistry doc7464009
Ref: 27887464009
Ref: library/email headerregistry email-headerregistry-custom-header-objects7464009
Ref: 27897464009
Ref: library/email headerregistry module-email headerregistry7464009
Ref: 707464009
Ref: library/email headerregistry email headerregistry BaseHeader7465775
Ref: 271a7465775
Ref: library/email headerregistry email headerregistry BaseHeader name7466088
Ref: 278c7466088
Ref: library/email headerregistry email headerregistry BaseHeader defects7466339
Ref: 278d7466339
Ref: library/email headerregistry email headerregistry BaseHeader max_count7466691
Ref: 276f7466691
Ref: library/email headerregistry email headerregistry BaseHeader fold7467208
Ref: 278e7467208
Ref: library/email headerregistry email headerregistry UnstructuredHeader7469379
Ref: 278b7469379
Ref: library/email headerregistry email headerregistry DateHeader7470458
Ref: 278f7470458
Ref: library/email headerregistry email headerregistry DateHeader datetime7470821
Ref: 27907470821
Ref: library/email headerregistry email headerregistry AddressHeader7472389
Ref: 27917472389
Ref: library/email headerregistry email headerregistry AddressHeader groups7472673
Ref: 27927472673
Ref: library/email headerregistry email headerregistry AddressHeader addresses7472988
Ref: 27957472988
Ref: library/email headerregistry email headerregistry SingleAddressHeader7474150
Ref: 27977474150
Ref: library/email headerregistry email headerregistry SingleAddressHeader address7474291
Ref: 27987474291
Ref: library/email headerregistry email headerregistry MIMEVersionHeader7474823
Ref: 27997474823
Ref: library/email headerregistry email headerregistry MIMEVersionHeader version7475215
Ref: 279a7475215
Ref: library/email headerregistry email headerregistry MIMEVersionHeader major7475342
Ref: 279b7475342
Ref: library/email headerregistry email headerregistry MIMEVersionHeader minor7475419
Ref: 279c7475419
Ref: library/email headerregistry email headerregistry ParameterizedMIMEHeader7475496
Ref: 279d7475496
Ref: library/email headerregistry email headerregistry ParameterizedMIMEHeader params7475879
Ref: 279e7475879
Ref: library/email headerregistry email headerregistry ContentTypeHeader7475976
Ref: 279f7475976
Ref: library/email headerregistry email headerregistry ContentTypeHeader content_type7476127
Ref: 27a07476127
Ref: library/email headerregistry email headerregistry ContentTypeHeader maintype7476233
Ref: 27a17476233
Ref: library/email headerregistry email headerregistry ContentTypeHeader subtype7476263
Ref: 27a27476263
Ref: library/email headerregistry email headerregistry ContentDispositionHeader7476292
Ref: 27a37476292
Ref: library/email headerregistry email headerregistry ContentTransferEncoding7476594
Ref: 27a47476594
Ref: library/email headerregistry email headerregistry ContentTransferEncoding cte7476709
Ref: 27a57476709
Ref: library/email headerregistry email headerregistry HeaderRegistry7476878
Ref: 278a7476878
Ref: library/email headerregistry email headerregistry HeaderRegistry map_to_type7478598
Ref: 27a67478598
Ref: library/email headerregistry email headerregistry HeaderRegistry __getitem__7478933
Ref: 27a77478933
Ref: library/email headerregistry email headerregistry HeaderRegistry __call__7479056
Ref: 27a87479056
Ref: library/email headerregistry email headerregistry Address7479698
Ref: 27967479698
Ref: library/email headerregistry email headerregistry Address display_name7480537
Ref: 27a97480537
Ref: library/email headerregistry email headerregistry Address username7480763
Ref: 27aa7480763
Ref: library/email headerregistry email headerregistry Address domain7480883
Ref: 27ab7480883
Ref: library/email headerregistry email headerregistry Address addr_spec7480963
Ref: 27ac7480963
Ref: library/email headerregistry email headerregistry Address __str__7481181
Ref: 27ad7481181
Ref: library/email headerregistry email headerregistry Group7481620
Ref: 27937481620
Ref: library/email headerregistry email headerregistry Group display_name7482169
Ref: 27947482169
Ref: library/email headerregistry email headerregistry Group addresses7482424
Ref: 27ae7482424
Ref: library/email headerregistry email headerregistry Group __str__7482572
Ref: 27af7482572
Ref: email headerregistry Custom Header Objects-Footnote-17483012
Ref: email headerregistry Custom Header Objects-Footnote-27483092
Ref: email headerregistry Custom Header Objects-Footnote-37483164
Ref: email headerregistry Custom Header Objects-Footnote-47483213
Ref: email headerregistry Custom Header Objects-Footnote-57483262
Ref: email headerregistry Custom Header Objects-Footnote-67483311
Ref: email headerregistry Custom Header Objects-Footnote-77483360
Ref: email headerregistry Custom Header Objects-Footnote-87483409
Ref: email headerregistry Custom Header Objects-Footnote-97483458
Ref: email headerregistry Custom Header Objects-Footnote-107483507
Ref: email headerregistry Custom Header Objects-Footnote-117483557
Ref: email headerregistry Custom Header Objects-Footnote-127483607
Ref: email headerregistry Custom Header Objects-Footnote-137483657
Ref: email headerregistry Custom Header Objects-Footnote-147483707
Ref: email headerregistry Custom Header Objects-Footnote-157483757
Ref: email headerregistry Custom Header Objects-Footnote-167483807
Ref: email headerregistry Custom Header Objects-Footnote-177483857
Node: email contentmanager Managing MIME Content7483907
Ref: library/email contentmanager doc7484104
Ref: 27b07484104
Ref: library/email contentmanager email-contentmanager-managing-mime-content7484104
Ref: 27b17484104
Ref: library/email contentmanager module-email contentmanager7484104
Ref: 6b7484104
Ref: library/email contentmanager email contentmanager ContentManager7484361
Ref: 27b27484361
Ref: library/email contentmanager email contentmanager ContentManager get_content7484650
Ref: 27387484650
Ref: library/email contentmanager email contentmanager ContentManager set_content7485504
Ref: 273a7485504
Ref: library/email contentmanager email contentmanager ContentManager add_get_handler7487127
Ref: 27b47487127
Ref: library/email contentmanager email contentmanager ContentManager add_set_handler7487319
Ref: 27b67487319
Ref: email contentmanager Managing MIME Content-Footnote-17487684
Ref: email contentmanager Managing MIME Content-Footnote-27487764
Node: Content Manager Instances7487836
Ref: library/email contentmanager content-manager-instances7487940
Ref: 27b87487940
Ref: library/email contentmanager email contentmanager raw_data_manager7488280
Ref: 276d7488280
Ref: library/email contentmanager email contentmanager get_content7489010
Ref: 27b57489010
Ref: library/email contentmanager email contentmanager set_content7489609
Ref: 27b77489609
Ref: Content Manager Instances-Footnote-17494027
Node: email Examples7494076
Ref: library/email examples doc7494305
Ref: 27b97494305
Ref: library/email examples email-examples7494305
Ref: 8397494305
Ref: library/email examples id17494305
Ref: 27ba7494305
Ref: email Examples-Footnote-17507560
Ref: email Examples-Footnote-27507608
Node: email message Message Representing an email message using the compat32 API7507694
Ref: library/email compat32-message doc7507936
Ref: 27bb7507936
Ref: library/email compat32-message compat32-message7507936
Ref: 270b7507936
Ref: library/email compat32-message email-message-message-representing-an-email-message-using-the-compat32-api7507936
Ref: 27bc7507936
Ref: library/email compat32-message email message Message7510493
Ref: 5367510493
Ref: library/email compat32-message email message Message as_string7511026
Ref: 8337511026
Ref: library/email compat32-message email message Message __str__7513099
Ref: 27bd7513099
Ref: library/email compat32-message email message Message as_bytes7513264
Ref: 8347513264
Ref: library/email compat32-message email message Message __bytes__7514745
Ref: 8357514745
Ref: library/email compat32-message email message Message is_multipart7514950
Ref: 27317514950
Ref: library/email compat32-message email message Message set_unixfrom7515626
Ref: 27be7515626
Ref: library/email compat32-message email message Message get_unixfrom7515766
Ref: 27bf7515766
Ref: library/email compat32-message email message Message attach7515923
Ref: 273f7515923
Ref: library/email compat32-message email message Message get_payload7516541
Ref: b3e7516541
Ref: library/email compat32-message email message Message set_payload7519192
Ref: 27c07519192
Ref: library/email compat32-message email message Message set_charset7519660
Ref: 27c17519660
Ref: library/email compat32-message email message Message get_charset7521419
Ref: 27c27521419
Ref: library/email compat32-message email message Message __len__7522871
Ref: 27c47522871
Ref: library/email compat32-message email message Message __contains__7522969
Ref: 27c57522969
Ref: library/email compat32-message email message Message __getitem__7523324
Ref: 27c67523324
Ref: library/email compat32-message email message Message __setitem__7523859
Ref: 27c87523859
Ref: library/email compat32-message email message Message __delitem__7524401
Ref: 27c97524401
Ref: library/email compat32-message email message Message keys7524627
Ref: 27c37524627
Ref: library/email compat32-message email message Message values7524721
Ref: 27ca7524721
Ref: library/email compat32-message email message Message items7524811
Ref: 27cb7524811
Ref: library/email compat32-message email message Message get7524942
Ref: 27cc7524942
Ref: library/email compat32-message email message Message get_all7525266
Ref: 27c77525266
Ref: library/email compat32-message email message Message add_header7525503
Ref: 27cd7525503
Ref: library/email compat32-message email message Message replace_header7527454
Ref: 27ce7527454
Ref: library/email compat32-message email message Message get_content_type7527743
Ref: 27cf7527743
Ref: library/email compat32-message email message Message get_content_maintype7528601
Ref: 27d17528601
Ref: library/email compat32-message email message Message get_content_subtype7528807
Ref: 27d27528807
Ref: library/email compat32-message email message Message get_default_type7529000
Ref: 27d07529000
Ref: library/email compat32-message email message Message set_default_type7529320
Ref: 27d37529320
Ref: library/email compat32-message email message Message get_params7529607
Ref: 27d47529607
Ref: library/email compat32-message email message Message get_param7530663
Ref: 27d57530663
Ref: library/email compat32-message email message Message set_param7532650
Ref: 8367532650
Ref: library/email compat32-message email message Message del_param7533917
Ref: 27d77533917
Ref: library/email compat32-message email message Message set_type7534358
Ref: 27d87534358
Ref: library/email compat32-message email message Message get_filename7535231
Ref: 27d97535231
Ref: library/email compat32-message email message Message get_boundary7535770
Ref: 27da7535770
Ref: library/email compat32-message email message Message set_boundary7536134
Ref: 27db7536134
Ref: library/email compat32-message email message Message get_content_charset7536949
Ref: 27dc7536949
Ref: library/email compat32-message email message Message get_charsets7537437
Ref: 27dd7537437
Ref: library/email compat32-message email message Message get_content_disposition7538139
Ref: 6c57538139
Ref: library/email compat32-message email message Message walk7538502
Ref: 27de7538502
Ref: library/email compat32-message email message Message preamble7540247
Ref: 27df7540247
Ref: library/email compat32-message email message Message epilogue7541509
Ref: 27e07541509
Ref: library/email compat32-message email message Message defects7541907
Ref: 27e17541907
Ref: email message Message Representing an email message using the compat32 API-Footnote-17542185
Ref: email message Message Representing an email message using the compat32 API-Footnote-27542234
Ref: email message Message Representing an email message using the compat32 API-Footnote-37542283
Ref: email message Message Representing an email message using the compat32 API-Footnote-47542332
Ref: email message Message Representing an email message using the compat32 API-Footnote-57542381
Ref: email message Message Representing an email message using the compat32 API-Footnote-67542430
Ref: email message Message Representing an email message using the compat32 API-Footnote-77542479
Ref: email message Message Representing an email message using the compat32 API-Footnote-87542528
Ref: email message Message Representing an email message using the compat32 API-Footnote-97542577
Ref: email message Message Representing an email message using the compat32 API-Footnote-107542626
Ref: email message Message Representing an email message using the compat32 API-Footnote-117542676
Ref: email message Message Representing an email message using the compat32 API-Footnote-127542726
Node: email mime Creating email and MIME objects from scratch7542776
Ref: library/email mime doc7543042
Ref: 27e27543042
Ref: library/email mime email-mime-creating-email-and-mime-objects-from-scratch7543042
Ref: 27e37543042
Ref: library/email mime module-email mime7543042
Ref: 737543042
Ref: library/email mime email mime base MIMEBase7544278
Ref: 27e47544278
Ref: library/email mime email mime nonmultipart MIMENonMultipart7545421
Ref: 27867545421
Ref: library/email mime email mime multipart MIMEMultipart7545913
Ref: 27e57545913
Ref: library/email mime email mime application MIMEApplication7547226
Ref: 27e67547226
Ref: library/email mime email mime audio MIMEAudio7548568
Ref: 27e77548568
Ref: library/email mime email mime image MIMEImage7550155
Ref: 27877550155
Ref: library/email mime email mime message MIMEMessage7551753
Ref: 27e87551753
Ref: library/email mime email mime text MIMEText7552437
Ref: 6c77552437
Ref: email mime Creating email and MIME objects from scratch-Footnote-17554075
Node: email header Internationalized headers7554142
Ref: library/email header doc7554375
Ref: 27e97554375
Ref: library/email header email-header-internationalized-headers7554375
Ref: 27ea7554375
Ref: library/email header module-email header7554375
Ref: 6f7554375
Ref: library/email header email header Header7557042
Ref: 277d7557042
Ref: library/email header email header Header append7558914
Ref: 27eb7558914
Ref: library/email header email header Header encode7560248
Ref: 27ec7560248
Ref: library/email header email header Header __str__7561889
Ref: 27ed7561889
Ref: library/email header email header Header __eq__7562388
Ref: 27ee7562388
Ref: library/email header email header Header __ne__7562524
Ref: 27ef7562524
Ref: library/email header email header decode_header7562748
Ref: 9ed7562748
Ref: library/email header email header make_header7563384
Ref: 9ee7563384
Ref: email header Internationalized headers-Footnote-17564081
Ref: email header Internationalized headers-Footnote-27564152
Ref: email header Internationalized headers-Footnote-37564201
Ref: email header Internationalized headers-Footnote-47564249
Ref: email header Internationalized headers-Footnote-57564298
Ref: email header Internationalized headers-Footnote-67564347
Ref: email header Internationalized headers-Footnote-77564396
Ref: email header Internationalized headers-Footnote-87564445
Ref: email header Internationalized headers-Footnote-97564494
Ref: email header Internationalized headers-Footnote-107564543
Ref: email header Internationalized headers-Footnote-117564593
Ref: email header Internationalized headers-Footnote-127564643
Ref: email header Internationalized headers-Footnote-137564693
Ref: email header Internationalized headers-Footnote-147564743
Ref: email header Internationalized headers-Footnote-157564793
Node: email charset Representing character sets7564843
Ref: library/email charset doc7565044
Ref: 27f07565044
Ref: library/email charset email-charset-representing-character-sets7565044
Ref: 27f17565044
Ref: library/email charset module-email charset7565044
Ref: 6a7565044
Ref: library/email charset email charset Charset7565855
Ref: 6c87565855
Ref: library/email charset email charset Charset input_charset7567380
Ref: 27f27567380
Ref: library/email charset email charset Charset header_encoding7567636
Ref: 27f37567636
Ref: library/email charset email charset Charset body_encoding7568022
Ref: 27f47568022
Ref: library/email charset email charset Charset output_charset7568299
Ref: 27f57568299
Ref: library/email charset email charset Charset input_codec7568638
Ref: 27f67568638
Ref: library/email charset email charset Charset output_codec7568852
Ref: 27f77568852
Ref: library/email charset email charset Charset get_body_encoding7569164
Ref: 27f87569164
Ref: library/email charset email charset Charset get_output_charset7569881
Ref: 27f97569881
Ref: library/email charset email charset Charset header_encode7570085
Ref: 27fa7570085
Ref: library/email charset email charset Charset header_encode_lines7570293
Ref: 27fb7570293
Ref: library/email charset email charset Charset body_encode7570726
Ref: 27fc7570726
Ref: library/email charset email charset Charset __str__7571058
Ref: 27fd7571058
Ref: library/email charset email charset Charset __eq__7571229
Ref: 27fe7571229
Ref: library/email charset email charset Charset __ne__7571365
Ref: 27ff7571365
Ref: library/email charset email charset add_charset7571659
Ref: 28007571659
Ref: library/email charset email charset add_alias7572984
Ref: 28027572984
Ref: library/email charset email charset add_codec7573310
Ref: 28017573310
Ref: email charset Representing character sets-Footnote-17573704
Node: email encoders Encoders7573776
Ref: library/email encoders doc7573974
Ref: 28037573974
Ref: library/email encoders email-encoders-encoders7573974
Ref: 28047573974
Ref: library/email encoders module-email encoders7573974
Ref: 6c7573974
Ref: library/email encoders email encoders encode_quopri7575660
Ref: 28057575660
Ref: library/email encoders email encoders encode_base647575988
Ref: 28067575988
Ref: library/email encoders email encoders encode_7or8bit7576384
Ref: 28077576384
Ref: library/email encoders email encoders encode_noop7576644
Ref: 28087576644
Ref: email encoders Encoders-Footnote-17576824
Ref: email encoders Encoders-Footnote-27576897
Node: email utils Miscellaneous utilities7577018
Ref: library/email utils doc7577200
Ref: 28097577200
Ref: library/email utils email-utils-miscellaneous-utilities7577200
Ref: 280a7577200
Ref: library/email utils module-email utils7577200
Ref: 767577200
Ref: library/email utils email utils localtime7577496
Ref: 9f47577496
Ref: library/email utils email utils make_msgid7578319
Ref: 280b7578319
Ref: library/email utils email utils quote7579216
Ref: 280c7579216
Ref: library/email utils email utils unquote7579395
Ref: 272a7579395
Ref: library/email utils email utils parseaddr7579665
Ref: 280d7579665
Ref: library/email utils email utils formataddr7580024
Ref: b087580024
Ref: library/email utils email utils getaddresses7580705
Ref: 280e7580705
Ref: library/email utils email utils parsedate7581293
Ref: 280f7581293
Ref: library/email utils email utils parsedate_tz7581922
Ref: 28107581922
Ref: library/email utils email utils parsedate_to_datetime7582501
Ref: 9f37582501
Ref: library/email utils email utils mktime_tz7583212
Ref: 28117583212
Ref: library/email utils email utils formatdate7583449
Ref: 28127583449
Ref: library/email utils email utils format_datetime7584395
Ref: 9f27584395
Ref: library/email utils email utils decode_rfc22317585083
Ref: 28137585083
Ref: library/email utils email utils encode_rfc22317585183
Ref: 28147585183
Ref: library/email utils email utils collapse_rfc2231_value7585591
Ref: 27d67585591
Ref: library/email utils email utils decode_params7586445
Ref: 28157586445
Ref: email utils Miscellaneous utilities-Footnote-17586701
Ref: email utils Miscellaneous utilities-Footnote-27586771
Ref: email utils Miscellaneous utilities-Footnote-37586820
Ref: email utils Miscellaneous utilities-Footnote-47586869
Ref: email utils Miscellaneous utilities-Footnote-57586918
Ref: email utils Miscellaneous utilities-Footnote-67586967
Ref: email utils Miscellaneous utilities-Footnote-77587234
Ref: email utils Miscellaneous utilities-Footnote-87587283
Ref: email utils Miscellaneous utilities-Footnote-97587332
Ref: email utils Miscellaneous utilities-Footnote-107587381
Ref: email utils Miscellaneous utilities-Footnote-117587431
Ref: email utils Miscellaneous utilities-Footnote-127587481
Node: email iterators Iterators7587531
Ref: library/email iterators doc7587681
Ref: 28167587681
Ref: library/email iterators email-iterators-iterators7587681
Ref: 28177587681
Ref: library/email iterators module-email iterators7587681
Ref: 717587681
Ref: library/email iterators email iterators body_line_iterator7588081
Ref: 28187588081
Ref: library/email iterators email iterators typed_subpart_iterator7588658
Ref: 28197588658
Ref: library/email iterators email iterators _structure7589376
Ref: 281a7589376
Ref: email iterators Iterators-Footnote-17590796
Node: json — JSON encoder and decoder7590870
Ref: library/json doc7591057
Ref: 281b7591057
Ref: library/json json-json-encoder-and-decoder7591057
Ref: 281c7591057
Ref: library/json module-json7591057
Ref: a47591057
Ref: json — JSON encoder and decoder-Footnote-17594965
Ref: json — JSON encoder and decoder-Footnote-27595037
Ref: json — JSON encoder and decoder-Footnote-37595061
Ref: json — JSON encoder and decoder-Footnote-47595110
Ref: json — JSON encoder and decoder-Footnote-57595159
Ref: json — JSON encoder and decoder-Footnote-67595238
Ref: json — JSON encoder and decoder-Footnote-77595287
Ref: json — JSON encoder and decoder-Footnote-87595553
Node: Basic Usage7595578
Ref: library/json basic-usage7595689
Ref: 281e7595689
Ref: library/json json dump7595732
Ref: 5f97595732
Ref: library/json json dumps7599265
Ref: 5fa7599265
Ref: library/json json load7600090
Ref: 5547600090
Ref: library/json json loads7602703
Ref: 5557602703
Ref: Basic Usage-Footnote-17603623
Node: Encoders and Decoders7603654
Ref: library/json encoders-and-decoders7603788
Ref: 28217603788
Ref: library/json json JSONDecoder7603851
Ref: 5fc7603851
Ref: library/json json-to-py-table7604105
Ref: 28207604105
Ref: library/json json JSONDecoder decode7607005
Ref: 28227607005
Ref: library/json json JSONDecoder raw_decode7607257
Ref: 28237607257
Ref: library/json json JSONEncoder7607621
Ref: 5fb7607621
Ref: library/json py-to-json-table7607922
Ref: 281f7607922
Ref: library/json json JSONEncoder default7612230
Ref: 28247612230
Ref: library/json json JSONEncoder encode7612799
Ref: 28257612799
Ref: library/json json JSONEncoder iterencode7613029
Ref: 28267613029
Node: Exceptions<13>7613275
Ref: library/json exceptions7613438
Ref: 28277613438
Ref: library/json json JSONDecodeError7613479
Ref: 6fa7613479
Ref: library/json json JSONDecodeError msg7613620
Ref: 28287613620
Ref: library/json json JSONDecodeError doc7613687
Ref: 28297613687
Ref: library/json json JSONDecodeError pos7613755
Ref: 282a7613755
Ref: library/json json JSONDecodeError lineno7613838
Ref: 282b7613838
Ref: library/json json JSONDecodeError colno7613910
Ref: 282c7613910
Node: Standard Compliance and Interoperability7614009
Ref: library/json standard-compliance-and-interoperability7614176
Ref: 282d7614176
Ref: Standard Compliance and Interoperability-Footnote-17615326
Ref: Standard Compliance and Interoperability-Footnote-27615375
Node: Character Encodings7615454
Ref: library/json character-encodings7615589
Ref: 282e7615589
Node: Infinite and NaN Number Values7616920
Ref: library/json infinite-and-nan-number-values7617095
Ref: 282f7617095
Node: Repeated Names Within an Object7617838
Ref: library/json repeated-names-within-an-object7618031
Ref: 28307618031
Node: Top-level Non-Object Non-Array Values7618544
Ref: library/json top-level-non-object-non-array-values7618733
Ref: 28317618733
Ref: Top-level Non-Object Non-Array Values-Footnote-17619387
Ref: Top-level Non-Object Non-Array Values-Footnote-27619436
Node: Implementation Limitations7619485
Ref: library/json implementation-limitations7619634
Ref: 28327619634
Node: Command Line Interface<2>7620584
Ref: library/json command-line-interface7620728
Ref: 28337620728
Ref: library/json json-commandline7620728
Ref: 281d7620728
Ref: library/json module-json tool7620728
Ref: a57620728
Ref: Command Line Interface<2>-Footnote-17621631
Node: Command line options<2>7621699
Ref: library/json command-line-options7621784
Ref: 28357621784
Ref: library/json cmdoption-json-tool-arg-infile7621847
Ref: 28367621847
Ref: library/json cmdoption-json-tool-arg-outfile7622231
Ref: 28377622231
Ref: library/json cmdoption-json-tool-sort-keys7622374
Ref: 28347622374
Ref: library/json cmdoption-json-tool-json-lines7622494
Ref: 28387622494
Ref: library/json cmdoption-json-tool-h7622608
Ref: 28397622608
Node: mailcap — Mailcap file handling7622669
Ref: library/mailcap doc7622863
Ref: 283a7622863
Ref: library/mailcap mailcap-mailcap-file-handling7622863
Ref: 283b7622863
Ref: library/mailcap module-mailcap7622863
Ref: af7622863
Ref: library/mailcap mailcap findmatch7623842
Ref: 283c7623842
Ref: library/mailcap mailcap getcaps7625931
Ref: 283d7625931
Ref: mailcap — Mailcap file handling-Footnote-17626756
Ref: mailcap — Mailcap file handling-Footnote-27626822
Ref: mailcap — Mailcap file handling-Footnote-37626871
Node: mailbox — Manipulate mailboxes in various formats7626920
Ref: library/mailbox doc7627122
Ref: 283e7627122
Ref: library/mailbox mailbox-manipulate-mailboxes-in-various-formats7627122
Ref: 283f7627122
Ref: library/mailbox module-mailbox7627122
Ref: ae7627122
Ref: mailbox — Manipulate mailboxes in various formats-Footnote-17628014
Node: Mailbox objects7628080
Ref: library/mailbox id17628207
Ref: 28407628207
Ref: library/mailbox mailbox-objects7628207
Ref: 28417628207
Ref: library/mailbox mailbox Mailbox7628266
Ref: bd67628266
Ref: library/mailbox mailbox Mailbox add7631068
Ref: bd57631068
Ref: library/mailbox mailbox Mailbox remove7631858
Ref: 28427631858
Ref: library/mailbox mailbox Mailbox __delitem__7631888
Ref: 28477631888
Ref: library/mailbox mailbox Mailbox discard7631923
Ref: 28437631923
Ref: library/mailbox mailbox Mailbox __setitem__7632468
Ref: 28487632468
Ref: library/mailbox mailbox Mailbox iterkeys7633351
Ref: 28497633351
Ref: library/mailbox mailbox Mailbox keys7633380
Ref: 284a7633380
Ref: library/mailbox mailbox Mailbox itervalues7633565
Ref: 284b7633565
Ref: library/mailbox mailbox Mailbox __iter__7633596
Ref: 284c7633596
Ref: library/mailbox mailbox Mailbox values7633625
Ref: 284d7633625
Ref: library/mailbox mailbox Mailbox iteritems7634264
Ref: 284e7634264
Ref: library/mailbox mailbox Mailbox items7634294
Ref: 284f7634294
Ref: library/mailbox mailbox Mailbox get7634817
Ref: 28507634817
Ref: library/mailbox mailbox Mailbox __getitem__7634858
Ref: 28517634858
Ref: library/mailbox mailbox Mailbox get_message7635444
Ref: 28527635444
Ref: library/mailbox mailbox Mailbox get_bytes7635732
Ref: bd87635732
Ref: library/mailbox mailbox Mailbox get_string7635965
Ref: bd97635965
Ref: library/mailbox mailbox Mailbox get_file7636304
Ref: bd77636304
Ref: library/mailbox mailbox Mailbox __contains__7637279
Ref: 28537637279
Ref: library/mailbox mailbox Mailbox __len__7637413
Ref: 28547637413
Ref: library/mailbox mailbox Mailbox clear7637496
Ref: 28557637496
Ref: library/mailbox mailbox Mailbox pop7637572
Ref: 28567637572
Ref: library/mailbox mailbox Mailbox popitem7638015
Ref: 28577638015
Ref: library/mailbox mailbox Mailbox update7638536
Ref: 28587638536
Ref: library/mailbox mailbox Mailbox flush7639254
Ref: 28597639254
Ref: library/mailbox mailbox Mailbox lock7639545
Ref: 28447639545
Ref: library/mailbox mailbox Mailbox unlock7639964
Ref: 28457639964
Ref: library/mailbox mailbox Mailbox close7640044
Ref: 285b7640044
Node: Maildir7640296
Ref: library/mailbox mailbox-maildir7640368
Ref: 285c7640368
Ref: library/mailbox maildir7640368
Ref: 285d7640368
Ref: library/mailbox mailbox Maildir7640411
Ref: c9b7640411
Ref: library/mailbox mailbox Maildir list_folders7643245
Ref: 285f7643245
Ref: library/mailbox mailbox Maildir get_folder7643333
Ref: 28607643333
Ref: library/mailbox mailbox Maildir add_folder7643573
Ref: 28627643573
Ref: library/mailbox mailbox Maildir remove_folder7643730
Ref: 28637643730
Ref: library/mailbox mailbox Maildir clean7643972
Ref: 28657643972
Ref: library/mailbox mailbox Maildir add7644312
Ref: 28667644312
Ref: library/mailbox mailbox Maildir __setitem__7644343
Ref: 28677644343
Ref: library/mailbox mailbox Maildir update7644387
Ref: 28687644387
Ref: library/mailbox mailbox Maildir flush7644800
Ref: 28697644800
Ref: library/mailbox mailbox Maildir lock7644935
Ref: 286a7644935
Ref: library/mailbox mailbox Maildir unlock7644960
Ref: 286b7644960
Ref: library/mailbox mailbox Maildir close7645093
Ref: 286c7645093
Ref: library/mailbox mailbox Maildir get_file7645290
Ref: 286d7645290
Ref: Maildir-Footnote-17645912
Ref: Maildir-Footnote-27645963
Ref: Maildir-Footnote-37646007
Node: mbox7646055
Ref: library/mailbox mailbox-mbox7646138
Ref: 286e7646138
Ref: library/mailbox mbox7646138
Ref: 286f7646138
Ref: library/mailbox mailbox mbox7646175
Ref: 28467646175
Ref: library/mailbox mailbox mbox get_file7647611
Ref: 28707647611
Ref: library/mailbox mailbox mbox lock7647824
Ref: 28717647824
Ref: library/mailbox mailbox mbox unlock7647849
Ref: 28727647849
Ref: mbox-Footnote-17648517
Ref: mbox-Footnote-27648565
Ref: mbox-Footnote-37648625
Ref: mbox-Footnote-47648677
Node: MH7648755
Ref: library/mailbox mailbox-mh7648836
Ref: 28737648836
Ref: library/mailbox mh7648836
Ref: 28747648836
Ref: library/mailbox mailbox MH7648869
Ref: 28757648869
Ref: library/mailbox mailbox MH list_folders7650315
Ref: 28777650315
Ref: library/mailbox mailbox MH get_folder7650403
Ref: 28787650403
Ref: library/mailbox mailbox MH add_folder7650640
Ref: 28797650640
Ref: library/mailbox mailbox MH remove_folder7650794
Ref: 287a7650794
Ref: library/mailbox mailbox MH get_sequences7651036
Ref: 287b7651036
Ref: library/mailbox mailbox MH set_sequences7651213
Ref: 287c7651213
Ref: library/mailbox mailbox MH pack7651451
Ref: 287d7651451
Ref: library/mailbox mailbox MH remove7651872
Ref: 287e7651872
Ref: library/mailbox mailbox MH __delitem__7651902
Ref: 287f7651902
Ref: library/mailbox mailbox MH discard7651937
Ref: 28807651937
Ref: library/mailbox mailbox MH lock7652146
Ref: 28817652146
Ref: library/mailbox mailbox MH unlock7652171
Ref: 28827652171
Ref: library/mailbox mailbox MH get_file7652546
Ref: 28837652546
Ref: library/mailbox mailbox MH flush7652738
Ref: 28847652738
Ref: library/mailbox mailbox MH close7652868
Ref: 28857652868
Ref: MH-Footnote-17653335
Ref: MH-Footnote-27653370
Node: Babyl7653415
Ref: library/mailbox babyl7653496
Ref: 28867653496
Ref: library/mailbox mailbox-babyl7653496
Ref: 28877653496
Ref: library/mailbox mailbox Babyl7653535
Ref: 28887653535
Ref: library/mailbox mailbox Babyl get_labels7655104
Ref: 288a7655104
Ref: library/mailbox mailbox Babyl get_file7655637
Ref: 288b7655637
Ref: library/mailbox mailbox Babyl lock7656157
Ref: 288c7656157
Ref: library/mailbox mailbox Babyl unlock7656182
Ref: 288d7656182
Ref: Babyl-Footnote-17656576
Ref: Babyl-Footnote-27656620
Node: MMDF7656698
Ref: library/mailbox mailbox-mmdf7656768
Ref: 288e7656768
Ref: library/mailbox mmdf7656768
Ref: 288f7656768
Ref: library/mailbox mailbox MMDF7656805
Ref: 28907656805
Ref: library/mailbox mailbox MMDF get_file7658068
Ref: 28927658068
Ref: library/mailbox mailbox MMDF lock7658281
Ref: 28937658281
Ref: library/mailbox mailbox MMDF unlock7658306
Ref: 28947658306
Ref: MMDF-Footnote-17658743
Ref: MMDF-Footnote-27658803
Node: Message objects7658846
Ref: library/mailbox mailbox-message-objects7658996
Ref: 28957658996
Ref: library/mailbox message-objects7658996
Ref: 28967658996
Ref: library/mailbox mailbox Message7659055
Ref: bda7659055
Ref: Message objects-Footnote-17661101
Node: MaildirMessage7661150
Ref: library/mailbox mailbox-maildirmessage7661236
Ref: 28977661236
Ref: library/mailbox maildirmessage7661236
Ref: 28987661236
Ref: library/mailbox mailbox MaildirMessage7661293
Ref: 285e7661293
Ref: library/mailbox mailbox MaildirMessage get_subdir7663149
Ref: 28997663149
Ref: library/mailbox mailbox MaildirMessage set_subdir7663666
Ref: 289a7663666
Ref: library/mailbox mailbox MaildirMessage get_flags7663837
Ref: 289b7663837
Ref: library/mailbox mailbox MaildirMessage set_flags7664309
Ref: 289c7664309
Ref: library/mailbox mailbox MaildirMessage add_flag7664413
Ref: 289d7664413
Ref: library/mailbox mailbox MaildirMessage remove_flag7664763
Ref: 289e7664763
Ref: library/mailbox mailbox MaildirMessage get_date7665118
Ref: 289f7665118
Ref: library/mailbox mailbox MaildirMessage set_date7665274
Ref: 28a07665274
Ref: library/mailbox mailbox MaildirMessage get_info7665439
Ref: 28a17665439
Ref: library/mailbox mailbox MaildirMessage set_info7665662
Ref: 28a27665662
Node: mboxMessage7668480
Ref: library/mailbox mailbox-mboxmessage7668584
Ref: 28a37668584
Ref: library/mailbox mboxmessage7668584
Ref: 28a47668584
Ref: library/mailbox mailbox mboxMessage7668635
Ref: 27137668635
Ref: library/mailbox mailbox mboxMessage get_from7670437
Ref: 28a57670437
Ref: library/mailbox mailbox mboxMessage set_from7670668
Ref: 28a67670668
Ref: library/mailbox mailbox mboxMessage get_flags7671204
Ref: 28a77671204
Ref: library/mailbox mailbox mboxMessage set_flags7671552
Ref: 28a87671552
Ref: library/mailbox mailbox mboxMessage add_flag7671843
Ref: 28a97671843
Ref: library/mailbox mailbox mboxMessage remove_flag7672063
Ref: 28aa7672063
Node: MHMessage7675064
Ref: library/mailbox mailbox-mhmessage7675166
Ref: 28ab7675166
Ref: library/mailbox mhmessage7675166
Ref: 28ac7675166
Ref: library/mailbox mailbox MHMessage7675215
Ref: 28767675215
Ref: library/mailbox mailbox MHMessage get_sequences7676181
Ref: 28ad7676181
Ref: library/mailbox mailbox MHMessage set_sequences7676304
Ref: 28ae7676304
Ref: library/mailbox mailbox MHMessage add_sequence7676412
Ref: 28af7676412
Ref: library/mailbox mailbox MHMessage remove_sequence7676542
Ref: 28b07676542
Node: BabylMessage7678428
Ref: library/mailbox babylmessage7678530
Ref: 28b17678530
Ref: library/mailbox mailbox-babylmessage7678530
Ref: 28b27678530
Ref: library/mailbox mailbox BabylMessage7678585
Ref: 28897678585
Ref: library/mailbox mailbox BabylMessage get_labels7679953
Ref: 28b37679953
Ref: library/mailbox mailbox BabylMessage set_labels7680036
Ref: 28b47680036
Ref: library/mailbox mailbox BabylMessage add_label7680136
Ref: 28b57680136
Ref: library/mailbox mailbox BabylMessage remove_label7680233
Ref: 28b67680233
Ref: library/mailbox mailbox BabylMessage get_visible7680338
Ref: 28b77680338
Ref: library/mailbox mailbox BabylMessage set_visible7680506
Ref: 28b87680506
Ref: library/mailbox mailbox BabylMessage update_visible7680856
Ref: 28b97680856
Node: MMDFMessage7683324
Ref: library/mailbox mailbox-mmdfmessage7683408
Ref: 28ba7683408
Ref: library/mailbox mmdfmessage7683408
Ref: 28bb7683408
Ref: library/mailbox mailbox MMDFMessage7683461
Ref: 28917683461
Ref: library/mailbox mailbox MMDFMessage get_from7685147
Ref: 28bc7685147
Ref: library/mailbox mailbox MMDFMessage set_from7685378
Ref: 28bd7685378
Ref: library/mailbox mailbox MMDFMessage get_flags7685914
Ref: 28be7685914
Ref: library/mailbox mailbox MMDFMessage set_flags7686262
Ref: 28bf7686262
Ref: library/mailbox mailbox MMDFMessage add_flag7686553
Ref: 28c07686553
Ref: library/mailbox mailbox MMDFMessage remove_flag7686773
Ref: 28c17686773
Node: Exceptions<14>7689780
Ref: library/mailbox exceptions7689927
Ref: 28c27689927
Ref: library/mailbox mailbox Error7690049
Ref: 28c37690049
Ref: library/mailbox mailbox NoSuchMailboxError7690143
Ref: 28617690143
Ref: library/mailbox mailbox NotEmptyError7690449
Ref: 28647690449
Ref: library/mailbox mailbox ExternalClashError7690611
Ref: 285a7690611
Ref: library/mailbox mailbox FormatError7690924
Ref: 28c47690924
Node: Examples<18>7691121
Ref: library/mailbox examples7691244
Ref: 28c57691244
Ref: library/mailbox mailbox-examples7691244
Ref: 28c67691244
Node: mimetypes — Map filenames to MIME types7693327
Ref: library/mimetypes doc7693549
Ref: 28c77693549
Ref: library/mimetypes mimetypes-map-filenames-to-mime-types7693549
Ref: 28c87693549
Ref: library/mimetypes module-mimetypes7693549
Ref: b27693549
Ref: library/mimetypes mimetypes guess_type7694436
Ref: e9a7694436
Ref: library/mimetypes mimetypes guess_all_extensions7695763
Ref: 28ca7695763
Ref: library/mimetypes mimetypes guess_extension7696326
Ref: 28cb7696326
Ref: library/mimetypes mimetypes init7697028
Ref: 28c97697028
Ref: library/mimetypes mimetypes read_mime_types7698004
Ref: 28cd7698004
Ref: library/mimetypes mimetypes add_type7698381
Ref: 28ce7698381
Ref: library/mimetypes mimetypes inited7698838
Ref: 28cf7698838
Ref: library/mimetypes mimetypes knownfiles7699008
Ref: 28cc7699008
Ref: library/mimetypes mimetypes suffix_map7699218
Ref: 28d07699218
Ref: library/mimetypes mimetypes encodings_map7699568
Ref: 28d17699568
Ref: library/mimetypes mimetypes types_map7699667
Ref: 28d27699667
Ref: library/mimetypes mimetypes common_types7699758
Ref: 28d37699758
Ref: mimetypes — Map filenames to MIME types-Footnote-17700255
Ref: mimetypes — Map filenames to MIME types-Footnote-27700323
Node: MimeTypes Objects7700394
Ref: library/mimetypes id17700489
Ref: 28d47700489
Ref: library/mimetypes mimetypes-objects7700489
Ref: 28d57700489
Ref: library/mimetypes mimetypes MimeTypes7700738
Ref: 28d67700738
Ref: library/mimetypes mimetypes MimeTypes suffix_map7701424
Ref: 28d97701424
Ref: library/mimetypes mimetypes MimeTypes encodings_map7701906
Ref: 28da7701906
Ref: library/mimetypes mimetypes MimeTypes types_map7702119
Ref: 28db7702119
Ref: library/mimetypes mimetypes MimeTypes types_map_inv7702455
Ref: 28dc7702455
Ref: library/mimetypes mimetypes MimeTypes guess_extension7702805
Ref: 28dd7702805
Ref: library/mimetypes mimetypes MimeTypes guess_type7702983
Ref: f5c7702983
Ref: library/mimetypes mimetypes MimeTypes guess_all_extensions7703149
Ref: 28de7703149
Ref: library/mimetypes mimetypes MimeTypes read7703337
Ref: 28d77703337
Ref: library/mimetypes mimetypes MimeTypes readfp7703650
Ref: 28d87703650
Ref: library/mimetypes mimetypes MimeTypes read_windows_registry7703981
Ref: 28df7703981
Node: base64 — Base16 Base32 Base64 Base85 Data Encodings7704323
Ref: library/base64 doc7704536
Ref: 28e07704536
Ref: library/base64 base64-base16-base32-base64-base85-data-encodings7704536
Ref: 28e17704536
Ref: library/base64 module-base647704536
Ref: e7704536
Ref: library/base64 base64 b64encode7706403
Ref: 28e27706403
Ref: library/base64 base64 b64decode7706953
Ref: 28e37706953
Ref: library/base64 base64 standard_b64encode7707797
Ref: 28e47707797
Ref: library/base64 base64 standard_b64decode7707970
Ref: 28e57707970
Ref: library/base64 base64 urlsafe_b64encode7708159
Ref: 28e67708159
Ref: library/base64 base64 urlsafe_b64decode7708499
Ref: 28e77708499
Ref: library/base64 base64 b32encode7708816
Ref: 28e87708816
Ref: library/base64 base64 b32decode7708962
Ref: 9517708962
Ref: library/base64 base64 b16encode7709952
Ref: 28e97709952
Ref: library/base64 base64 b16decode7710098
Ref: 28ea7710098
Ref: library/base64 base64 a85encode7710581
Ref: 8187710581
Ref: library/base64 base64 a85decode7711544
Ref: 8197711544
Ref: library/base64 base64 b85encode7712407
Ref: 81a7712407
Ref: library/base64 base64 b85decode7712759
Ref: 81b7712759
Ref: library/base64 base64 decode7713023
Ref: 28eb7713023
Ref: library/base64 base64 decodebytes7713331
Ref: 17ad7713331
Ref: library/base64 base64 decodestring7713559
Ref: 28ec7713559
Ref: library/base64 base64 encode7713687
Ref: 28ed7713687
Ref: library/base64 base64 encodebytes7714206
Ref: 17ac7714206
Ref: library/base64 base64 encodestring7714591
Ref: 28ee7714591
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-17715369
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-27715434
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-37715483
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-47715532
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-57715581
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-67715630
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-77715679
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-87715728
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-97715777
Ref: base64 — Base16 Base32 Base64 Base85 Data Encodings-Footnote-107715826
Node: binhex — Encode and decode binhex4 files7715876
Ref: library/binhex doc7716093
Ref: 28ef7716093
Ref: library/binhex binhex-encode-and-decode-binhex4-files7716093
Ref: 28f07716093
Ref: library/binhex module-binhex7716093
Ref: 117716093
Ref: library/binhex binhex binhex7716515
Ref: 28f17716515
Ref: library/binhex binhex hexbin7716787
Ref: 28f27716787
Ref: library/binhex binhex Error7717185
Ref: 28f37717185
Ref: binhex — Encode and decode binhex4 files-Footnote-17717622
Node: Notes<2>7717687
Ref: library/binhex binhex-notes7717774
Ref: 28f47717774
Ref: library/binhex notes7717774
Ref: 28f57717774
Node: binascii — Convert between binary and ASCII7718060
Ref: library/binascii doc7718279
Ref: 28f67718279
Ref: library/binascii binascii-convert-between-binary-and-ascii7718279
Ref: 28f77718279
Ref: library/binascii module-binascii7718279
Ref: 107718279
Ref: library/binascii binascii a2b_uu7719317
Ref: 28f87719317
Ref: library/binascii binascii b2a_uu7719567
Ref: 3627719567
Ref: library/binascii binascii a2b_base647719946
Ref: 28f97719946
Ref: library/binascii binascii b2a_base647720120
Ref: 5187720120
Ref: library/binascii binascii a2b_qp7720470
Ref: 28fa7720470
Ref: library/binascii binascii b2a_qp7720767
Ref: 28fb7720767
Ref: library/binascii binascii a2b_hqx7721535
Ref: 28fc7721535
Ref: library/binascii binascii rledecode_hqx7721823
Ref: 28fd7721823
Ref: library/binascii binascii rlecode_hqx7722369
Ref: 28ff7722369
Ref: library/binascii binascii b2a_hqx7722494
Ref: 29007722494
Ref: library/binascii binascii crc_hqx7722739
Ref: 29017722739
Ref: library/binascii binascii crc327723044
Ref: 29027723044
Ref: library/binascii binascii b2a_hex7723795
Ref: 17af7723795
Ref: library/binascii binascii hexlify7723859
Ref: eef7723859
Ref: library/binascii binascii a2b_hex7724976
Ref: 17b07724976
Ref: library/binascii binascii unhexlify7725016
Ref: f767725016
Ref: library/binascii binascii Error7725544
Ref: 9527725544
Ref: library/binascii binascii Incomplete7725648
Ref: 28fe7725648
Ref: binascii — Convert between binary and ASCII-Footnote-17726265
Ref: binascii — Convert between binary and ASCII-Footnote-27726314
Node: quopri — Encode and decode MIME quoted-printable data7726363
Ref: library/quopri doc7726579
Ref: 29037726579
Ref: library/quopri module-quopri7726579
Ref: db7726579
Ref: library/quopri quopri-encode-and-decode-mime-quoted-printable-data7726579
Ref: 29047726579
Ref: library/quopri quopri decode7727314
Ref: 17b27727314
Ref: library/quopri quopri encode7727853
Ref: 17b17727853
Ref: library/quopri quopri decodestring7728509
Ref: 29057728509
Ref: library/quopri quopri encodestring7728706
Ref: 29067728706
Ref: quopri — Encode and decode MIME quoted-printable data-Footnote-17729156
Ref: quopri — Encode and decode MIME quoted-printable data-Footnote-27729221
Ref: quopri — Encode and decode MIME quoted-printable data-Footnote-37729270
Ref: quopri — Encode and decode MIME quoted-printable data-Footnote-47729319
Ref: quopri — Encode and decode MIME quoted-printable data-Footnote-57729368
Node: uu — Encode and decode uuencode files7729417
Ref: library/uu doc7729579
Ref: 29077729579
Ref: library/uu module-uu7729579
Ref: 1237729579
Ref: library/uu uu-encode-and-decode-uuencode-files7729579
Ref: 29087729579
Ref: library/uu uu encode7730528
Ref: 4047730528
Ref: library/uu uu decode7731056
Ref: 17b37731056
Ref: library/uu uu Error7731744
Ref: 29097731744
Ref: uu — Encode and decode uuencode files-Footnote-17732161
Node: Structured Markup Processing Tools7732222
Ref: library/markup doc7732390
Ref: 290a7732390
Ref: library/markup markup7732390
Ref: 290b7732390
Ref: library/markup structured-markup-processing-tools7732390
Ref: 290c7732390
Node: html — HyperText Markup Language support7733933
Ref: library/html doc7734099
Ref: 290d7734099
Ref: library/html html-hypertext-markup-language-support7734099
Ref: 290e7734099
Ref: library/html module-html7734099
Ref: 907734099
Ref: library/html html escape7734365
Ref: 9287734365
Ref: library/html html unescape7734836
Ref: 84e7734836
Ref: html — HyperText Markup Language support-Footnote-17735537
Node: html parser — Simple HTML and XHTML parser7735609
Ref: library/html parser doc7735838
Ref: 290f7735838
Ref: library/html parser html-parser-simple-html-and-xhtml-parser7735838
Ref: 29107735838
Ref: library/html parser module-html parser7735838
Ref: 927735838
Ref: library/html parser html parser HTMLParser7736214
Ref: 7b37736214
Ref: html parser — Simple HTML and XHTML parser-Footnote-17737332
Node: Example HTML Parser Application7737402
Ref: library/html parser example-html-parser-application7737541
Ref: 29117737541
Node: HTMLParser Methods7738642
Ref: library/html parser htmlparser-methods7738802
Ref: 29127738802
Ref: library/html parser html parser HTMLParser feed7738929
Ref: 29137738929
Ref: library/html parser html parser HTMLParser close7739196
Ref: 29147739196
Ref: library/html parser html parser HTMLParser reset7739557
Ref: 29157739557
Ref: library/html parser html parser HTMLParser getpos7739700
Ref: 29167739700
Ref: library/html parser html parser HTMLParser get_starttag_text7739779
Ref: 29177739779
Ref: library/html parser html parser HTMLParser handle_starttag7740350
Ref: 29197740350
Ref: library/html parser html parser HTMLParser handle_endtag7741146
Ref: 291a7741146
Ref: library/html parser html parser HTMLParser handle_startendtag7741353
Ref: 29187741353
Ref: library/html parser html parser HTMLParser handle_data7741766
Ref: 291b7741766
Ref: library/html parser html parser HTMLParser handle_entityref7741968
Ref: 291c7741968
Ref: library/html parser html parser HTMLParser handle_charref7742272
Ref: 291d7742272
Ref: library/html parser html parser HTMLParser handle_comment7742718
Ref: 291e7742718
Ref: library/html parser html parser HTMLParser handle_decl7743244
Ref: 291f7743244
Ref: library/html parser html parser HTMLParser handle_pi7743528
Ref: 29207743528
Ref: library/html parser html parser HTMLParser unknown_decl7744218
Ref: 29217744218
Node: Examples<19>7744580
Ref: library/html parser examples7744700
Ref: 29227744700
Ref: library/html parser htmlparser-examples7744700
Ref: 29237744700
Node: html entities — Definitions of HTML general entities7747789
Ref: library/html entities doc7747998
Ref: 29247747998
Ref: library/html entities html-entities-definitions-of-html-general-entities7747998
Ref: 29257747998
Ref: library/html entities module-html entities7747998
Ref: 917747998
Ref: library/html entities html entities html57748379
Ref: a0a7748379
Ref: library/html entities html entities entitydefs7748864
Ref: 29287748864
Ref: library/html entities html entities name2codepoint7749003
Ref: 29267749003
Ref: library/html entities html entities codepoint2name7749123
Ref: 29277749123
Ref: html entities — Definitions of HTML general entities-Footnote-17749270
Ref: html entities — Definitions of HTML general entities-Footnote-27749342
Node: XML Processing Modules7749431
Ref: library/xml doc7749645
Ref: 29297749645
Ref: library/xml module-xml7749645
Ref: 1337749645
Ref: library/xml xml7749645
Ref: 292a7749645
Ref: library/xml xml-processing-modules7749645
Ref: 292b7749645
Ref: XML Processing Modules-Footnote-17751141
Node: XML vulnerabilities7751201
Ref: library/xml id17751328
Ref: 292e7751328
Ref: library/xml xml-vulnerabilities7751328
Ref: 292c7751328
Ref: XML vulnerabilities-Footnote-17755990
Ref: XML vulnerabilities-Footnote-27756053
Ref: XML vulnerabilities-Footnote-37756106
Ref: XML vulnerabilities-Footnote-47756159
Ref: XML vulnerabilities-Footnote-57756222
Ref: XML vulnerabilities-Footnote-67756269
Node: The defusedxml and defusedexpat Packages7756314
Ref: library/xml defused-packages7756441
Ref: 292d7756441
Ref: library/xml the-defusedxml-and-defusedexpat-packages7756441
Ref: 292f7756441
Ref: The defusedxml and defusedexpat Packages-Footnote-17757352
Ref: The defusedxml and defusedexpat Packages-Footnote-27757397
Node: xml etree ElementTree — The ElementTree XML API7757444
Ref: library/xml etree elementtree doc7757645
Ref: 29307757645
Ref: library/xml etree elementtree dtd7757645
Ref: 29317757645
Ref: library/xml etree elementtree module-xml etree ElementTree7757645
Ref: 1377757645
Ref: library/xml etree elementtree xml-etree-elementtree-the-elementtree-xml-api7757645
Ref: 29327757645
Ref: xml etree ElementTree — The ElementTree XML API-Footnote-17758517
Node: Tutorial7758598
Ref: library/xml etree elementtree tutorial7758714
Ref: 29337758714
Node: XML tree and elements7759165
Ref: library/xml etree elementtree xml-tree-and-elements7759251
Ref: 29347759251
Node: Parsing XML7759829
Ref: library/xml etree elementtree elementtree-parsing-xml7759957
Ref: 29357759957
Ref: library/xml etree elementtree parsing-xml7759957
Ref: 29367759957
Node: Pull API for non-blocking parsing7762248
Ref: library/xml etree elementtree elementtree-pull-parsing7762383
Ref: 9087762383
Ref: library/xml etree elementtree pull-api-for-non-blocking-parsing7762383
Ref: 29387762383
Node: Finding interesting elements7764235
Ref: library/xml etree elementtree finding-interesting-elements7764380
Ref: 293b7764380
Node: Modifying an XML File7765551
Ref: library/xml etree elementtree modifying-an-xml-file7765685
Ref: 29407765685
Node: Building XML documents7768053
Ref: library/xml etree elementtree building-xml-documents7768186
Ref: 29447768186
Node: Parsing XML with Namespaces7768530
Ref: library/xml etree elementtree parsing-xml-with-namespaces7768662
Ref: 29467768662
Ref: Parsing XML with Namespaces-Footnote-17770822
Ref: Parsing XML with Namespaces-Footnote-27770874
Node: Additional resources7770926
Ref: library/xml etree elementtree additional-resources7771027
Ref: 29477771027
Node: XPath support7771179
Ref: library/xml etree elementtree elementtree-xpath7771316
Ref: 40f7771316
Ref: library/xml etree elementtree xpath-support7771316
Ref: 29487771316
Ref: XPath support-Footnote-17771680
Node: Example<10>7771716
Ref: library/xml etree elementtree example7771808
Ref: 29497771808
Node: Supported XPath syntax7772762
Ref: library/xml etree elementtree supported-xpath-syntax7772854
Ref: 294a7772854
Node: Reference<2>7776815
Ref: library/xml etree elementtree reference7776960
Ref: 294b7776960
Node: Functions<6>7777038
Ref: library/xml etree elementtree elementtree-functions7777099
Ref: 294c7777099
Ref: library/xml etree elementtree functions7777099
Ref: 294d7777099
Ref: library/xml etree elementtree xml etree ElementTree canonicalize7777140
Ref: 294e7777140
Ref: library/xml etree elementtree xml etree ElementTree Comment7779472
Ref: 294f7779472
Ref: library/xml etree elementtree xml etree ElementTree dump7780157
Ref: 29507780157
Ref: library/xml etree elementtree xml etree ElementTree fromstring7780631
Ref: 29377780631
Ref: library/xml etree elementtree xml etree ElementTree fromstringlist7780990
Ref: b427780990
Ref: library/xml etree elementtree xml etree ElementTree iselement7781408
Ref: 29527781408
Ref: library/xml etree elementtree xml etree ElementTree iterparse7781622
Ref: 93c7781622
Ref: library/xml etree elementtree xml etree ElementTree parse7783481
Ref: 29537783481
Ref: library/xml etree elementtree xml etree ElementTree ProcessingInstruction7783825
Ref: 29547783825
Ref: library/xml etree elementtree xml etree ElementTree register_namespace7784558
Ref: b437784558
Ref: library/xml etree elementtree xml etree ElementTree SubElement7784987
Ref: 29457784987
Ref: library/xml etree elementtree xml etree ElementTree tostring7785557
Ref: 9097785557
Ref: library/xml etree elementtree xml etree ElementTree tostringlist7786636
Ref: 90a7786636
Ref: library/xml etree elementtree xml etree ElementTree XML7787885
Ref: 29517787885
Ref: library/xml etree elementtree xml etree ElementTree XMLID7788279
Ref: 29557788279
Ref: Functions<6>-Footnote-17788754
Ref: Functions<6>-Footnote-27788795
Ref: Functions<6>-Footnote-37789108
Node: XInclude support7789421
Ref: library/xml etree elementtree elementtree-xinclude7789565
Ref: 29567789565
Ref: library/xml etree elementtree xinclude-support7789565
Ref: 29577789565
Ref: XInclude support-Footnote-17789925
Node: Example<11>7789965
Ref: library/xml etree elementtree id37790029
Ref: 29587790029
Node: Reference<3>7791778
Ref: library/xml etree elementtree id47791901
Ref: 29597791901
Node: Functions<7>7792143
Ref: library/xml etree elementtree elementinclude-functions7792228
Ref: 295a7792228
Ref: library/xml etree elementtree id57792228
Ref: 295b7792228
Ref: library/xml etree elementtree xml etree ElementTree xml etree ElementInclude default_loader7792269
Ref: 295c7792269
Ref: library/xml etree elementtree xml etree ElementTree xml etree ElementInclude include7792856
Ref: 295d7792856
Node: Element Objects7793464
Ref: library/xml etree elementtree element-objects7793577
Ref: 295e7793577
Ref: library/xml etree elementtree elementtree-element-objects7793577
Ref: 295f7793577
Ref: library/xml etree elementtree xml etree ElementTree Element7793630
Ref: ab97793630
Ref: library/xml etree elementtree xml etree ElementTree Element tag7794112
Ref: 29607794112
Ref: library/xml etree elementtree xml etree ElementTree Element text7794257
Ref: 293e7794257
Ref: library/xml etree elementtree xml etree ElementTree Element tail7794282
Ref: 29617794282
Ref: library/xml etree elementtree xml etree ElementTree Element attrib7795397
Ref: 29627795397
Ref: library/xml etree elementtree xml etree ElementTree Element clear7795941
Ref: 29637795941
Ref: library/xml etree elementtree xml etree ElementTree Element get7796134
Ref: 293f7796134
Ref: library/xml etree elementtree xml etree ElementTree Element items7796322
Ref: 29647796322
Ref: library/xml etree elementtree xml etree ElementTree Element keys7796491
Ref: 29657796491
Ref: library/xml etree elementtree xml etree ElementTree Element set7796633
Ref: 29417796633
Ref: library/xml etree elementtree xml etree ElementTree Element append7796806
Ref: 29427796806
Ref: library/xml etree elementtree xml etree ElementTree Element extend7797042
Ref: b447797042
Ref: library/xml etree elementtree xml etree ElementTree Element find7797292
Ref: 293d7797292
Ref: library/xml etree elementtree xml etree ElementTree Element findall7797714
Ref: 293c7797714
Ref: library/xml etree elementtree xml etree ElementTree Element findtext7798133
Ref: 29667798133
Ref: library/xml etree elementtree xml etree ElementTree Element getchildren7798737
Ref: 29677798737
Ref: library/xml etree elementtree xml etree ElementTree Element getiterator7798888
Ref: 29687798888
Ref: library/xml etree elementtree xml etree ElementTree Element insert7799059
Ref: 29697799059
Ref: library/xml etree elementtree xml etree ElementTree Element iter7799270
Ref: cda7799270
Ref: library/xml etree elementtree xml etree ElementTree Element iterfind7799760
Ref: b457799760
Ref: library/xml etree elementtree xml etree ElementTree Element itertext7800092
Ref: b467800092
Ref: library/xml etree elementtree xml etree ElementTree Element makeelement7800315
Ref: 296a7800315
Ref: library/xml etree elementtree xml etree ElementTree Element remove7800538
Ref: 29437800538
Ref: Element Objects-Footnote-17802988
Node: ElementTree Objects7803031
Ref: library/xml etree elementtree elementtree-elementtree-objects7803145
Ref: 296b7803145
Ref: library/xml etree elementtree elementtree-objects7803145
Ref: 296c7803145
Ref: library/xml etree elementtree xml etree ElementTree ElementTree7803206
Ref: 90b7803206
Ref: library/xml etree elementtree xml etree ElementTree ElementTree _setroot7803558
Ref: 296d7803558
Ref: library/xml etree elementtree xml etree ElementTree ElementTree find7803807
Ref: 296e7803807
Ref: library/xml etree elementtree xml etree ElementTree ElementTree findall7803946
Ref: 296f7803946
Ref: library/xml etree elementtree xml etree ElementTree ElementTree findtext7804091
Ref: 29707804091
Ref: library/xml etree elementtree xml etree ElementTree ElementTree getiterator7804252
Ref: 29717804252
Ref: library/xml etree elementtree xml etree ElementTree ElementTree getroot7804428
Ref: 29737804428
Ref: library/xml etree elementtree xml etree ElementTree ElementTree iter7804508
Ref: 29727804508
Ref: library/xml etree elementtree xml etree ElementTree ElementTree iterfind7804778
Ref: 29747804778
Ref: library/xml etree elementtree xml etree ElementTree ElementTree parse7804955
Ref: 29757804955
Ref: library/xml etree elementtree xml etree ElementTree ElementTree write7805300
Ref: 90c7805300
Ref: ElementTree Objects-Footnote-17807969
Node: QName Objects7808282
Ref: library/xml etree elementtree elementtree-qname-objects7808400
Ref: 29767808400
Ref: library/xml etree elementtree qname-objects7808400
Ref: 29777808400
Ref: library/xml etree elementtree xml etree ElementTree QName7808449
Ref: 29787808449
Node: TreeBuilder Objects7808962
Ref: library/xml etree elementtree elementtree-treebuilder-objects7809078
Ref: 29797809078
Ref: library/xml etree elementtree treebuilder-objects7809078
Ref: 297a7809078
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder7809139
Ref: 2517809139
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder close7810257
Ref: 297b7810257
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder data7810419
Ref: 297c7810419
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder end7810583
Ref: b477810583
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder start7810716
Ref: 297d7810716
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder comment7810918
Ref: 297e7810918
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder pi7811114
Ref: 297f7811114
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder doctype7811425
Ref: 2bf7811425
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder start_ns7811749
Ref: 29807811749
Ref: library/xml etree elementtree xml etree ElementTree TreeBuilder end_ns7812143
Ref: 29817812143
Ref: library/xml etree elementtree xml etree ElementTree C14NWriterTarget7812390
Ref: 29827812390
Ref: TreeBuilder Objects-Footnote-17812938
Node: XMLParser Objects7812979
Ref: library/xml etree elementtree elementtree-xmlparser-objects7813103
Ref: 29837813103
Ref: library/xml etree elementtree xmlparser-objects7813103
Ref: 29847813103
Ref: library/xml etree elementtree xml etree ElementTree XMLParser7813160
Ref: 2507813160
Ref: library/xml etree elementtree xml etree ElementTree XMLParser close7813872
Ref: 29867813872
Ref: library/xml etree elementtree xml etree ElementTree XMLParser feed7814128
Ref: 29857814128
Ref: XMLParser Objects-Footnote-17815705
Node: XMLPullParser Objects7816018
Ref: library/xml etree elementtree elementtree-xmlpullparser-objects7816137
Ref: 29877816137
Ref: library/xml etree elementtree xmlpullparser-objects7816137
Ref: 29887816137
Ref: library/xml etree elementtree xml etree ElementTree XMLPullParser7816202
Ref: 9077816202
Ref: library/xml etree elementtree xml etree ElementTree XMLPullParser feed7816894
Ref: 29397816894
Ref: library/xml etree elementtree xml etree ElementTree XMLPullParser close7816976
Ref: 29897816976
Ref: library/xml etree elementtree xml etree ElementTree XMLPullParser read_events7817287
Ref: 293a7817287
Node: Exceptions<15>7819021
Ref: library/xml etree elementtree exceptions7819114
Ref: 298a7819114
Ref: library/xml etree elementtree xml etree ElementTree ParseError7819157
Ref: bff7819157
Ref: library/xml etree elementtree xml etree ElementTree ParseError code7819485
Ref: 298b7819485
Ref: library/xml etree elementtree xml etree ElementTree ParseError position7819690
Ref: 298c7819690
Node: xml dom — The Document Object Model API7819815
Ref: library/xml dom doc7820040
Ref: 298d7820040
Ref: library/xml dom module-xml dom7820040
Ref: 1347820040
Ref: library/xml dom xml-dom-the-document-object-model-api7820040
Ref: 298e7820040
Ref: xml dom — The Document Object Model API-Footnote-17823514
Ref: xml dom — The Document Object Model API-Footnote-27823590
Ref: xml dom — The Document Object Model API-Footnote-37823656
Ref: xml dom — The Document Object Model API-Footnote-47823703
Node: Module Contents<4>7823762
Ref: library/xml dom module-contents7823885
Ref: 29917823885
Ref: library/xml dom xml dom registerDOMImplementation7823995
Ref: 29927823995
Ref: library/xml dom xml dom getDOMImplementation7824443
Ref: 298f7824443
Ref: library/xml dom xml dom EMPTY_NAMESPACE7825352
Ref: 29937825352
Ref: library/xml dom xml dom XML_NAMESPACE7825625
Ref: 29947825625
Ref: library/xml dom xml dom XMLNS_NAMESPACE7825782
Ref: 29957825782
Ref: library/xml dom xml dom XHTML_NAMESPACE7825968
Ref: 29967825968
Ref: Module Contents<4>-Footnote-17826703
Ref: Module Contents<4>-Footnote-27826748
Ref: Module Contents<4>-Footnote-37826805
Node: Objects in the DOM7826843
Ref: library/xml dom dom-objects7826986
Ref: 29977826986
Ref: library/xml dom objects-in-the-dom7826986
Ref: 29987826986
Node: DOMImplementation Objects7831521
Ref: library/xml dom dom-implementation-objects7831622
Ref: 29997831622
Ref: library/xml dom domimplementation-objects7831622
Ref: 29a37831622
Ref: library/xml dom xml dom DOMImplementation hasFeature7831978
Ref: 29a47831978
Ref: library/xml dom xml dom DOMImplementation createDocument7832157
Ref: 29a57832157
Ref: library/xml dom xml dom DOMImplementation createDocumentType7832677
Ref: 29a67832677
Node: Node Objects7832985
Ref: library/xml dom dom-node-objects7833111
Ref: 299a7833111
Ref: library/xml dom node-objects7833111
Ref: 29a77833111
Ref: library/xml dom xml dom Node nodeType7833228
Ref: 29a87833228
Ref: library/xml dom xml dom Node parentNode7833651
Ref: 29a97833651
Ref: library/xml dom xml dom Node attributes7834060
Ref: 29aa7834060
Ref: library/xml dom xml dom Node previousSibling7834273
Ref: 29ab7834273
Ref: library/xml dom xml dom Node nextSibling7834759
Ref: 29ac7834759
Ref: library/xml dom xml dom Node childNodes7835025
Ref: 29ad7835025
Ref: library/xml dom xml dom Node firstChild7835144
Ref: 29ae7835144
Ref: library/xml dom xml dom Node lastChild7835281
Ref: 29af7835281
Ref: library/xml dom xml dom Node localName7835416
Ref: 29b07835416
Ref: library/xml dom xml dom Node prefix7835580
Ref: 29b17835580
Ref: library/xml dom xml dom Node namespaceURI7835748
Ref: 29b27835748
Ref: library/xml dom xml dom Node nodeName7835911
Ref: 29b37835911
Ref: library/xml dom xml dom Node nodeValue7836348
Ref: 29b47836348
Ref: library/xml dom xml dom Node hasAttributes7836582
Ref: 29b57836582
Ref: library/xml dom xml dom Node hasChildNodes7836673
Ref: 29b67836673
Ref: library/xml dom xml dom Node isSameNode7836765
Ref: 29b77836765
Ref: library/xml dom xml dom Node appendChild7837394
Ref: 29b87837394
Ref: library/xml dom xml dom Node insertBefore7837602
Ref: 29b97837602
Ref: library/xml dom xml dom Node removeChild7837943
Ref: 29ba7837943
Ref: library/xml dom xml dom Node replaceChild7838231
Ref: 29bb7838231
Ref: library/xml dom xml dom Node normalize7838445
Ref: 29bc7838445
Ref: library/xml dom xml dom Node cloneNode7838662
Ref: 29bd7838662
Node: NodeList Objects7838806
Ref: library/xml dom dom-nodelist-objects7838927
Ref: 299b7838927
Ref: library/xml dom nodelist-objects7838927
Ref: 29be7838927
Ref: library/xml dom xml dom NodeList item7839408
Ref: 29bf7839408
Ref: library/xml dom xml dom NodeList length7839638
Ref: 29c07839638
Node: DocumentType Objects7840305
Ref: library/xml dom documenttype-objects7840430
Ref: 29c17840430
Ref: library/xml dom dom-documenttype-objects7840430
Ref: 299c7840430
Ref: library/xml dom xml dom DocumentType publicId7841063
Ref: 29c27841063
Ref: library/xml dom xml dom DocumentType systemId7841229
Ref: 29c37841229
Ref: library/xml dom xml dom DocumentType internalSubset7841405
Ref: 29c47841405
Ref: library/xml dom xml dom DocumentType name7841658
Ref: 29c57841658
Ref: library/xml dom xml dom DocumentType entities7841787
Ref: 29c67841787
Ref: library/xml dom xml dom DocumentType notations7842170
Ref: 29c77842170
Node: Document Objects7842549
Ref: library/xml dom document-objects7842676
Ref: 29c87842676
Ref: library/xml dom dom-document-objects7842676
Ref: 299d7842676
Ref: library/xml dom xml dom Document documentElement7842923
Ref: 29c97842923
Ref: library/xml dom xml dom Document createElement7843017
Ref: 29ca7843017
Ref: library/xml dom xml dom Document createElementNS7843306
Ref: 29cb7843306
Ref: library/xml dom xml dom Document createTextNode7843657
Ref: 29cc7843657
Ref: library/xml dom xml dom Document createComment7843876
Ref: 29cd7843876
Ref: library/xml dom xml dom Document createProcessingInstruction7844097
Ref: 29ce7844097
Ref: library/xml dom xml dom Document createAttribute7844369
Ref: 29cf7844369
Ref: library/xml dom xml dom Document createAttributeNS7844676
Ref: 29d07844676
Ref: library/xml dom xml dom Document getElementsByTagName7845064
Ref: 29d17845064
Ref: library/xml dom xml dom Document getElementsByTagNameNS7845240
Ref: 29d27845240
Node: Element Objects<2>7845511
Ref: library/xml dom dom-element-objects7845630
Ref: 299e7845630
Ref: library/xml dom element-objects7845630
Ref: 29d37845630
Ref: library/xml dom xml dom Element tagName7845771
Ref: 29d47845771
Ref: library/xml dom xml dom Element getElementsByTagName7845918
Ref: 29d57845918
Ref: library/xml dom xml dom Element getElementsByTagNameNS7846031
Ref: 29d67846031
Ref: library/xml dom xml dom Element hasAttribute7846162
Ref: 29d77846162
Ref: library/xml dom xml dom Element hasAttributeNS7846276
Ref: 29d87846276
Ref: library/xml dom xml dom Element getAttribute7846440
Ref: 29d97846440
Ref: library/xml dom xml dom Element getAttributeNode7846653
Ref: 29da7846653
Ref: library/xml dom xml dom Element getAttributeNS7846774
Ref: 29db7846774
Ref: library/xml dom xml dom Element getAttributeNodeNS7847032
Ref: 29dc7847032
Ref: library/xml dom xml dom Element removeAttribute7847186
Ref: 29dd7847186
Ref: library/xml dom xml dom Element removeAttributeNode7847344
Ref: 29df7847344
Ref: library/xml dom xml dom Element removeAttributeNS7847536
Ref: 29e07847536
Ref: library/xml dom xml dom Element setAttribute7847745
Ref: 29e17847745
Ref: library/xml dom xml dom Element setAttributeNode7847837
Ref: 29e27847837
Ref: library/xml dom xml dom Element setAttributeNodeNS7848181
Ref: 29e47848181
Ref: library/xml dom xml dom Element setAttributeNS7848554
Ref: 29e57848554
Node: Attr Objects7848790
Ref: library/xml dom attr-objects7848913
Ref: 29e67848913
Ref: library/xml dom dom-attr-objects7848913
Ref: 299f7848913
Ref: library/xml dom xml dom Attr name7849028
Ref: 29e77849028
Ref: library/xml dom xml dom Attr localName7849140
Ref: 29e87849140
Ref: library/xml dom xml dom Attr prefix7849294
Ref: 29e97849294
Ref: library/xml dom xml dom Attr value7849414
Ref: 29ea7849414
Node: NamedNodeMap Objects7849539
Ref: library/xml dom dom-attributelist-objects7849659
Ref: 29eb7849659
Ref: library/xml dom namednodemap-objects7849659
Ref: 29ec7849659
Ref: library/xml dom xml dom NamedNodeMap length7849778
Ref: 29ed7849778
Ref: library/xml dom xml dom NamedNodeMap item7849854
Ref: 29ee7849854
Node: Comment Objects7850335
Ref: library/xml dom comment-objects7850472
Ref: 29ef7850472
Ref: library/xml dom dom-comment-objects7850472
Ref: 29a07850472
Ref: library/xml dom xml dom Comment data7850644
Ref: 29f07850644
Node: Text and CDATASection Objects7850862
Ref: library/xml dom dom-text-objects7851008
Ref: 29a17851008
Ref: library/xml dom text-and-cdatasection-objects7851008
Ref: 29f17851008
Ref: library/xml dom xml dom Text data7851504
Ref: 29f27851504
Node: ProcessingInstruction Objects7851997
Ref: library/xml dom dom-pi-objects7852142
Ref: 29a27852142
Ref: library/xml dom processinginstruction-objects7852142
Ref: 29f37852142
Ref: library/xml dom xml dom ProcessingInstruction target7852354
Ref: 29f47852354
Ref: library/xml dom xml dom ProcessingInstruction data7852522
Ref: 29f57852522
Node: Exceptions<16>7852660
Ref: library/xml dom dom-exceptions7852767
Ref: 29f67852767
Ref: library/xml dom exceptions7852767
Ref: 29f77852767
Ref: library/xml dom xml dom DOMException7853446
Ref: 29f87853446
Ref: library/xml dom xml dom DomstringSizeErr7853608
Ref: 29f97853608
Ref: library/xml dom xml dom HierarchyRequestErr7853863
Ref: 29fa7853863
Ref: library/xml dom xml dom IndexSizeErr7854002
Ref: 29fb7854002
Ref: library/xml dom xml dom InuseAttributeErr7854144
Ref: 29e37854144
Ref: library/xml dom xml dom InvalidAccessErr7854308
Ref: 29fc7854308
Ref: library/xml dom xml dom InvalidCharacterErr7854441
Ref: 29fd7854441
Ref: library/xml dom xml dom InvalidModificationErr7854801
Ref: 29fe7854801
Ref: library/xml dom xml dom InvalidStateErr7854915
Ref: 29ff7854915
Ref: library/xml dom xml dom NamespaceErr7855058
Ref: 2a007855058
Ref: library/xml dom xml dom NotFoundErr7855267
Ref: 29de7855267
Ref: library/xml dom xml dom NotSupportedErr7855498
Ref: 2a017855498
Ref: library/xml dom xml dom NoDataAllowedErr7855640
Ref: 2a027855640
Ref: library/xml dom xml dom NoModificationAllowedErr7855768
Ref: 2a037855768
Ref: library/xml dom xml dom SyntaxErr7855934
Ref: 2a047855934
Ref: library/xml dom xml dom WrongDocumentErr7856029
Ref: 2a057856029
Ref: Exceptions<16>-Footnote-17859070
Node: Conformance7859115
Ref: library/xml dom conformance7859231
Ref: 2a067859231
Ref: library/xml dom dom-conformance7859231
Ref: 29907859231
Node: Type Mapping7859488
Ref: library/xml dom dom-type-mapping7859573
Ref: 2a077859573
Ref: library/xml dom type-mapping7859573
Ref: 2a087859573
Node: Accessor Methods7860398
Ref: library/xml dom accessor-methods7860483
Ref: 2a097860483
Ref: library/xml dom dom-accessor-methods7860483
Ref: 2a0a7860483
Node: xml dom minidom — Minimal DOM implementation7862354
Ref: library/xml dom minidom doc7862588
Ref: 2a0b7862588
Ref: library/xml dom minidom module-xml dom minidom7862588
Ref: 1357862588
Ref: library/xml dom minidom xml-dom-minidom-minimal-dom-implementation7862588
Ref: 2a0c7862588
Ref: library/xml dom minidom xml dom minidom parse7863911
Ref: 2a0d7863911
Ref: library/xml dom minidom xml dom minidom parseString7864480
Ref: 2a0e7864480
Ref: xml dom minidom — Minimal DOM implementation-Footnote-17867028
Ref: xml dom minidom — Minimal DOM implementation-Footnote-27867102
Node: DOM Objects7867149
Ref: library/xml dom minidom dom-objects7867263
Ref: 2a0f7867263
Ref: library/xml dom minidom minidom-objects7867263
Ref: 2a107867263
Ref: library/xml dom minidom xml dom minidom Node unlink7867498
Ref: 2a117867498
Ref: library/xml dom minidom xml dom minidom Node writexml7868264
Ref: 2a127868264
Ref: library/xml dom minidom xml dom minidom Node toxml7869044
Ref: 2a137869044
Ref: library/xml dom minidom xml dom minidom Node toprettyxml7869685
Ref: 2a147869685
Ref: DOM Objects-Footnote-17870248
Node: DOM Example7870655
Ref: library/xml dom minidom dom-example7870806
Ref: 2a157870806
Ref: library/xml dom minidom id27870806
Ref: 2a167870806
Node: minidom and the DOM standard7872596
Ref: library/xml dom minidom minidom-and-dom7872727
Ref: 2a177872727
Ref: library/xml dom minidom minidom-and-the-dom-standard7872727
Ref: 2a187872727
Node: xml dom pulldom — Support for building partial DOM trees7875368
Ref: library/xml dom pulldom doc7875597
Ref: 2a197875597
Ref: library/xml dom pulldom module-xml dom pulldom7875597
Ref: 1367875597
Ref: library/xml dom pulldom xml-dom-pulldom-support-for-building-partial-dom-trees7875597
Ref: 2a1a7875597
Ref: library/xml dom pulldom xml dom pulldom PullDom7878297
Ref: 2a1c7878297
Ref: library/xml dom pulldom xml dom pulldom SAX2DOM7878418
Ref: 2a1e7878418
Ref: library/xml dom pulldom xml dom pulldom parse7878539
Ref: 2a1f7878539
Ref: library/xml dom pulldom xml dom pulldom parseString7879131
Ref: 2a217879131
Ref: library/xml dom pulldom xml dom pulldom default_bufsize7879283
Ref: 2a227879283
Ref: xml dom pulldom — Support for building partial DOM trees-Footnote-17879596
Node: DOMEventStream Objects7879670
Ref: library/xml dom pulldom domeventstream-objects7879787
Ref: 2a237879787
Ref: library/xml dom pulldom id17879787
Ref: 2a247879787
Ref: library/xml dom pulldom xml dom pulldom DOMEventStream7879852
Ref: 27b7879852
Ref: library/xml dom pulldom xml dom pulldom DOMEventStream getEvent7880019
Ref: 2a257880019
Ref: library/xml dom pulldom xml dom pulldom DOMEventStream expandNode7880511
Ref: 2a1b7880511
Ref: library/xml dom pulldom xml dom pulldom DOMEventStream reset7881090
Ref: 2a267881090
Node: xml sax — Support for SAX2 parsers7881117
Ref: library/xml sax doc7881349
Ref: 2a277881349
Ref: library/xml sax module-xml sax7881349
Ref: 13b7881349
Ref: library/xml sax xml-sax-support-for-sax2-parsers7881349
Ref: 2a287881349
Ref: library/xml sax xml sax make_parser7882440
Ref: f607882440
Ref: library/xml sax xml sax parse7882938
Ref: f157882938
Ref: library/xml sax xml sax parseString7883533
Ref: 7877883533
Ref: library/xml sax xml sax SAXException7885457
Ref: 2a2e7885457
Ref: library/xml sax xml sax SAXParseException7886329
Ref: 2a2c7886329
Ref: library/xml sax xml sax SAXNotRecognizedException7886740
Ref: 2a2f7886740
Ref: library/xml sax xml sax SAXNotSupportedException7887042
Ref: 2a307887042
Ref: xml sax — Support for SAX2 parsers-Footnote-17888056
Ref: xml sax — Support for SAX2 parsers-Footnote-27888132
Node: SAXException Objects7888167
Ref: library/xml sax sax-exception-objects7888260
Ref: 2a317888260
Ref: library/xml sax saxexception-objects7888260
Ref: 2a327888260
Ref: library/xml sax xml sax SAXException getMessage7888400
Ref: 2a337888400
Ref: library/xml sax xml sax SAXException getException7888510
Ref: 2a347888510
Node: xml sax handler — Base classes for SAX handlers7888614
Ref: library/xml sax handler doc7888822
Ref: 2a357888822
Ref: library/xml sax handler module-xml sax handler7888822
Ref: 13c7888822
Ref: library/xml sax handler xml-sax-handler-base-classes-for-sax-handlers7888822
Ref: 2a367888822
Ref: library/xml sax handler xml sax handler ContentHandler7889509
Ref: 2a1d7889509
Ref: library/xml sax handler xml sax handler DTDHandler7889749
Ref: 2a377889749
Ref: library/xml sax handler xml sax handler EntityResolver7889934
Ref: 2a387889934
Ref: library/xml sax handler xml sax handler ErrorHandler7890216
Ref: 2a2b7890216
Ref: library/xml sax handler xml sax handler feature_namespaces7890613
Ref: 2a397890613
Ref: library/xml sax handler xml sax handler feature_namespace_prefixes7890941
Ref: 2a3a7890941
Ref: library/xml sax handler xml sax handler feature_string_interning7891374
Ref: 2a3b7891374
Ref: library/xml sax handler xml sax handler feature_validation7891793
Ref: 2a3c7891793
Ref: library/xml sax handler xml sax handler feature_external_ges7892136
Ref: 2a2a7892136
Ref: library/xml sax handler xml sax handler feature_external_pes7892453
Ref: 2a3d7892453
Ref: library/xml sax handler xml sax handler all_features7892838
Ref: 2a3e7892838
Ref: library/xml sax handler xml sax handler property_lexical_handler7892906
Ref: 2a3f7892906
Ref: library/xml sax handler xml sax handler property_declaration_handler7893230
Ref: 2a407893230
Ref: library/xml sax handler xml sax handler property_dom_node7893592
Ref: 2a417893592
Ref: library/xml sax handler xml sax handler property_xml_string7893986
Ref: 2a427893986
Ref: library/xml sax handler xml sax handler all_properties7894259
Ref: 2a437894259
Ref: xml sax handler — Base classes for SAX handlers-Footnote-17894489
Node: ContentHandler Objects7894563
Ref: library/xml sax handler content-handler-objects7894698
Ref: 2a447894698
Ref: library/xml sax handler contenthandler-objects7894698
Ref: 2a457894698
Ref: library/xml sax handler xml sax handler ContentHandler setDocumentLocator7894952
Ref: 2a467894952
Ref: library/xml sax handler xml sax handler ContentHandler startDocument7896027
Ref: 2a477896027
Ref: library/xml sax handler xml sax handler ContentHandler endDocument7896305
Ref: 2a487896305
Ref: library/xml sax handler xml sax handler ContentHandler startPrefixMapping7896673
Ref: 2a497896673
Ref: library/xml sax handler xml sax handler ContentHandler endPrefixMapping7897875
Ref: 2a4a7897875
Ref: library/xml sax handler xml sax handler ContentHandler startElement7898218
Ref: 2a4b7898218
Ref: library/xml sax handler xml sax handler ContentHandler endElement7898859
Ref: 2a4c7898859
Ref: library/xml sax handler xml sax handler ContentHandler startElementNS7899087
Ref: 2a4e7899087
Ref: library/xml sax handler xml sax handler ContentHandler endElementNS7900075
Ref: 2a507900075
Ref: library/xml sax handler xml sax handler ContentHandler characters7900348
Ref: 2a517900348
Ref: library/xml sax handler xml sax handler ContentHandler ignorableWhitespace7901375
Ref: 2a527901375
Ref: library/xml sax handler xml sax handler ContentHandler processingInstruction7902042
Ref: 2a537902042
Ref: library/xml sax handler xml sax handler ContentHandler skippedEntity7902502
Ref: 2a547902502
Node: DTDHandler Objects7903002
Ref: library/xml sax handler dtd-handler-objects7903168
Ref: 2a557903168
Ref: library/xml sax handler dtdhandler-objects7903168
Ref: 2a567903168
Ref: library/xml sax handler xml sax handler DTDHandler notationDecl7903293
Ref: 2a577903293
Ref: library/xml sax handler xml sax handler DTDHandler unparsedEntityDecl7903400
Ref: 2a587903400
Node: EntityResolver Objects7903538
Ref: library/xml sax handler entity-resolver-objects7903702
Ref: 2a597903702
Ref: library/xml sax handler entityresolver-objects7903702
Ref: 2a5a7903702
Ref: library/xml sax handler xml sax handler EntityResolver resolveEntity7903769
Ref: 2a5b7903769
Node: ErrorHandler Objects7904037
Ref: library/xml sax handler errorhandler-objects7904174
Ref: 2a5c7904174
Ref: library/xml sax handler sax-error-handler7904174
Ref: 2a5d7904174
Ref: library/xml sax handler xml sax handler ErrorHandler error7904821
Ref: 2a5e7904821
Ref: library/xml sax handler xml sax handler ErrorHandler fatalError7905190
Ref: 2a5f7905190
Ref: library/xml sax handler xml sax handler ErrorHandler warning7905376
Ref: 2a607905376
Node: xml sax saxutils — SAX Utilities7905721
Ref: library/xml sax utils doc7905940
Ref: 2a617905940
Ref: library/xml sax utils module-xml sax saxutils7905940
Ref: 13d7905940
Ref: library/xml sax utils xml-sax-saxutils-sax-utilities7905940
Ref: 2a627905940
Ref: library/xml sax utils xml sax saxutils escape7906327
Ref: 2a637906327
Ref: library/xml sax utils xml sax saxutils unescape7906781
Ref: 2a647906781
Ref: library/xml sax utils xml sax saxutils quoteattr7907248
Ref: 2a657907248
Ref: library/xml sax utils xml sax saxutils XMLGenerator7908147
Ref: 2a667908147
Ref: library/xml sax utils xml sax saxutils XMLFilterBase7909000
Ref: 2a677909000
Ref: library/xml sax utils xml sax saxutils prepare_input_source7909422
Ref: 2a687909422
Ref: xml sax saxutils — SAX Utilities-Footnote-17909911
Node: xml sax xmlreader — Interface for XML parsers7909987
Ref: library/xml sax reader doc7910207
Ref: 2a697910207
Ref: library/xml sax reader module-xml sax xmlreader7910207
Ref: 13e7910207
Ref: library/xml sax reader xml-sax-xmlreader-interface-for-xml-parsers7910207
Ref: 2a6a7910207
Ref: library/xml sax reader xml sax xmlreader XMLReader7910706
Ref: 2a207910706
Ref: library/xml sax reader xml sax xmlreader IncrementalParser7910802
Ref: 2a6b7910802
Ref: library/xml sax reader xml sax xmlreader Locator7911929
Ref: 2a2d7911929
Ref: library/xml sax reader xml sax xmlreader InputSource7912262
Ref: 7867912262
Ref: library/xml sax reader xml sax xmlreader AttributesImpl7913030
Ref: 2a6d7913030
Ref: library/xml sax reader xml sax xmlreader AttributesNSImpl7913629
Ref: 2a6e7913629
Ref: xml sax xmlreader — Interface for XML parsers-Footnote-17914386
Node: XMLReader Objects7914463
Ref: library/xml sax reader id17914598
Ref: 2a6f7914598
Ref: library/xml sax reader xmlreader-objects7914598
Ref: 2a707914598
Ref: library/xml sax reader xml sax xmlreader XMLReader parse7914725
Ref: 2a6c7914725
Ref: library/xml sax reader xml sax xmlreader XMLReader getContentHandler7915314
Ref: 2a717915314
Ref: library/xml sax reader xml sax xmlreader XMLReader setContentHandler7915411
Ref: 2a727915411
Ref: library/xml sax reader xml sax xmlreader XMLReader getDTDHandler7915594
Ref: 2a737915594
Ref: library/xml sax reader xml sax xmlreader XMLReader setDTDHandler7915683
Ref: 2a747915683
Ref: library/xml sax reader xml sax xmlreader XMLReader getEntityResolver7915850
Ref: 2a757915850
Ref: library/xml sax reader xml sax xmlreader XMLReader setEntityResolver7915947
Ref: 2a767915947
Ref: library/xml sax reader xml sax xmlreader XMLReader getErrorHandler7916239
Ref: 2a777916239
Ref: library/xml sax reader xml sax xmlreader XMLReader setErrorHandler7916332
Ref: 2a787916332
Ref: library/xml sax reader xml sax xmlreader XMLReader setLocale7916536
Ref: 2a797916536
Ref: library/xml sax reader xml sax xmlreader XMLReader getFeature7916902
Ref: 2a7a7916902
Ref: library/xml sax reader xml sax xmlreader XMLReader setFeature7917184
Ref: 2a297917184
Ref: library/xml sax reader xml sax xmlreader XMLReader getProperty7917473
Ref: 2a7b7917473
Ref: library/xml sax reader xml sax xmlreader XMLReader setProperty7917764
Ref: 2a7c7917764
Node: IncrementalParser Objects7918058
Ref: library/xml sax reader incremental-parser-objects7918217
Ref: 2a7d7918217
Ref: library/xml sax reader incrementalparser-objects7918217
Ref: 2a7e7918217
Ref: library/xml sax reader xml sax xmlreader IncrementalParser feed7918375
Ref: 2a7f7918375
Ref: library/xml sax reader xml sax xmlreader IncrementalParser close7918451
Ref: 2a807918451
Ref: library/xml sax reader xml sax xmlreader IncrementalParser reset7918690
Ref: 2a817918690
Node: Locator Objects7918952
Ref: library/xml sax reader id27919113
Ref: 2a827919113
Ref: library/xml sax reader locator-objects7919113
Ref: 2a837919113
Ref: library/xml sax reader xml sax xmlreader Locator getColumnNumber7919224
Ref: 2a847919224
Ref: library/xml sax reader xml sax xmlreader Locator getLineNumber7919327
Ref: 2a857919327
Ref: library/xml sax reader xml sax xmlreader Locator getPublicId7919426
Ref: 2a867919426
Ref: library/xml sax reader xml sax xmlreader Locator getSystemId7919520
Ref: 2a877919520
Node: InputSource Objects7919614
Ref: library/xml sax reader input-source-objects7919774
Ref: 2a887919774
Ref: library/xml sax reader inputsource-objects7919774
Ref: 2a897919774
Ref: library/xml sax reader xml sax xmlreader InputSource setPublicId7919835
Ref: 2a8a7919835
Ref: library/xml sax reader xml sax xmlreader InputSource getPublicId7919942
Ref: 2a8b7919942
Ref: library/xml sax reader xml sax xmlreader InputSource setSystemId7920050
Ref: 2a8c7920050
Ref: library/xml sax reader xml sax xmlreader InputSource getSystemId7920157
Ref: 2a8d7920157
Ref: library/xml sax reader xml sax xmlreader InputSource setEncoding7920265
Ref: 2a8e7920265
Ref: library/xml sax reader xml sax xmlreader InputSource getEncoding7920651
Ref: 2a8f7920651
Ref: library/xml sax reader xml sax xmlreader InputSource setByteStream7920745
Ref: 2a907920745
Ref: library/xml sax reader xml sax xmlreader InputSource getByteStream7921178
Ref: 2a917921178
Ref: library/xml sax reader xml sax xmlreader InputSource setCharacterStream7921386
Ref: 2a927921386
Ref: library/xml sax reader xml sax xmlreader InputSource getCharacterStream7921700
Ref: 2a937921700
Node: The Attributes Interface7921801
Ref: library/xml sax reader attributes-objects7921972
Ref: 2a4d7921972
Ref: library/xml sax reader the-attributes-interface7921972
Ref: 2a947921972
Ref: library/xml sax reader xml sax xmlreader Attributes getLength7922300
Ref: 2a957922300
Ref: library/xml sax reader xml sax xmlreader Attributes getNames7922376
Ref: 2a967922376
Ref: library/xml sax reader xml sax xmlreader Attributes getType7922454
Ref: 2a977922454
Ref: library/xml sax reader xml sax xmlreader Attributes getValue7922579
Ref: 2a987922579
Node: The AttributesNS Interface7922663
Ref: library/xml sax reader attributes-ns-objects7922806
Ref: 2a4f7922806
Ref: library/xml sax reader the-attributesns-interface7922806
Ref: 2a997922806
Ref: library/xml sax reader xml sax xmlreader AttributesNS getValueByQName7923139
Ref: 2a9a7923139
Ref: library/xml sax reader xml sax xmlreader AttributesNS getNameByQName7923233
Ref: 2a9b7923233
Ref: library/xml sax reader xml sax xmlreader AttributesNS getQNameByName7923356
Ref: 2a9c7923356
Ref: library/xml sax reader xml sax xmlreader AttributesNS getQNames7923477
Ref: 2a9d7923477
Node: xml parsers expat — Fast XML parsing using Expat7923568
Ref: library/pyexpat doc7923745
Ref: 2a9e7923745
Ref: library/pyexpat module-xml parsers expat7923745
Ref: 1387923745
Ref: library/pyexpat xml-parsers-expat-fast-xml-parsing-using-expat7923745
Ref: 2a9f7923745
Ref: library/pyexpat xml parsers expat ExpatError7924799
Ref: c007924799
Ref: library/pyexpat xml parsers expat error7925009
Ref: 2aa17925009
Ref: library/pyexpat xml parsers expat XMLParserType7925088
Ref: 2aa27925088
Ref: library/pyexpat xml parsers expat ErrorString7925285
Ref: 2aa47925285
Ref: library/pyexpat xml parsers expat ParserCreate7925408
Ref: 2aa37925408
Ref: xml parsers expat — Fast XML parsing using Expat-Footnote-17927774
Ref: xml parsers expat — Fast XML parsing using Expat-Footnote-27928087
Node: XMLParser Objects<2>7928120
Ref: library/pyexpat id27928257
Ref: 2aa57928257
Ref: library/pyexpat xmlparser-objects7928257
Ref: 2aa67928257
Ref: library/pyexpat xml parsers expat xmlparser Parse7928367
Ref: 2aa77928367
Ref: library/pyexpat xml parsers expat xmlparser ParseFile7928745
Ref: 2aa87928745
Ref: library/pyexpat xml parsers expat xmlparser SetBase7928965
Ref: 2aa97928965
Ref: library/pyexpat xml parsers expat xmlparser GetBase7929381
Ref: 2aad7929381
Ref: library/pyexpat xml parsers expat xmlparser GetInputContext7929579
Ref: 2aae7929579
Ref: library/pyexpat xml parsers expat xmlparser ExternalEntityParserCreate7929862
Ref: 2aaf7929862
Ref: library/pyexpat xml parsers expat xmlparser SetParamEntityParsing7930379
Ref: 2ab27930379
Ref: library/pyexpat xml parsers expat xmlparser UseForeignDTD7930744
Ref: 2ab37930744
Ref: library/pyexpat xml parsers expat xmlparser buffer_size7931786
Ref: 2ab67931786
Ref: library/pyexpat xml parsers expat xmlparser buffer_text7932048
Ref: 2ab77932048
Ref: library/pyexpat xml parsers expat xmlparser buffer_used7932500
Ref: 2ab97932500
Ref: library/pyexpat xml parsers expat xmlparser ordered_attributes7932773
Ref: 2ab07932773
Ref: library/pyexpat xml parsers expat xmlparser specified_attributes7933265
Ref: 2ab17933265
Ref: library/pyexpat xml parsers expat xmlparser ErrorByteIndex7934071
Ref: 2aba7934071
Ref: library/pyexpat xml parsers expat xmlparser ErrorCode7934157
Ref: 2abb7934157
Ref: library/pyexpat xml parsers expat xmlparser ErrorColumnNumber7934388
Ref: 2abc7934388
Ref: library/pyexpat xml parsers expat xmlparser ErrorLineNumber7934480
Ref: 2abd7934480
Ref: library/pyexpat xml parsers expat xmlparser CurrentByteIndex7934973
Ref: 2abe7934973
Ref: library/pyexpat xml parsers expat xmlparser CurrentColumnNumber7935062
Ref: 2abf7935062
Ref: library/pyexpat xml parsers expat xmlparser CurrentLineNumber7935157
Ref: 2ac07935157
Ref: library/pyexpat xml parsers expat xmlparser XmlDeclHandler7935570
Ref: 2ac17935570
Ref: library/pyexpat xml parsers expat xmlparser StartDoctypeDeclHandler7936183
Ref: 2ab47936183
Ref: library/pyexpat xml parsers expat xmlparser EndDoctypeDeclHandler7936736
Ref: 2ab57936736
Ref: library/pyexpat xml parsers expat xmlparser ElementDeclHandler7936902
Ref: 2ac27936902
Ref: library/pyexpat xml parsers expat xmlparser AttlistDeclHandler7937116
Ref: 2ac37937116
Ref: library/pyexpat xml parsers expat xmlparser StartElementHandler7938019
Ref: 2ac47938019
Ref: library/pyexpat xml parsers expat xmlparser EndElementHandler7938416
Ref: 2ac57938416
Ref: library/pyexpat xml parsers expat xmlparser ProcessingInstructionHandler7938507
Ref: 2ac67938507
Ref: library/pyexpat xml parsers expat xmlparser CharacterDataHandler7938621
Ref: 2ab87938621
Ref: library/pyexpat xml parsers expat xmlparser UnparsedEntityDeclHandler7939043
Ref: 2aac7939043
Ref: library/pyexpat xml parsers expat xmlparser EntityDeclHandler7939436
Ref: 2ac97939436
Ref: library/pyexpat xml parsers expat xmlparser NotationDeclHandler7940181
Ref: 2aab7940181
Ref: library/pyexpat xml parsers expat xmlparser StartNamespaceDeclHandler7940472
Ref: 2aca7940472
Ref: library/pyexpat xml parsers expat xmlparser EndNamespaceDeclHandler7940750
Ref: 2acb7940750
Ref: library/pyexpat xml parsers expat xmlparser CommentHandler7941273
Ref: 2acc7941273
Ref: library/pyexpat xml parsers expat xmlparser StartCdataSectionHandler7941459
Ref: 2ac77941459
Ref: library/pyexpat xml parsers expat xmlparser EndCdataSectionHandler7941696
Ref: 2ac87941696
Ref: library/pyexpat xml parsers expat xmlparser DefaultHandler7941789
Ref: 2acd7941789
Ref: library/pyexpat xml parsers expat xmlparser DefaultHandlerExpand7942074
Ref: 2ace7942074
Ref: library/pyexpat xml parsers expat xmlparser NotStandaloneHandler7942314
Ref: 2acf7942314
Ref: library/pyexpat xml parsers expat xmlparser ExternalEntityRefHandler7942836
Ref: 2aaa7942836
Node: ExpatError Exceptions7943892
Ref: library/pyexpat expaterror-exceptions7944049
Ref: 2ad07944049
Ref: library/pyexpat expaterror-objects7944049
Ref: 2aa07944049
Ref: library/pyexpat xml parsers expat ExpatError code7944190
Ref: 2ad17944190
Ref: library/pyexpat xml parsers expat ExpatError lineno7944789
Ref: 2ad47944789
Ref: library/pyexpat xml parsers expat ExpatError offset7944916
Ref: 2ad57944916
Node: Example<12>7945057
Ref: library/pyexpat example7945220
Ref: 2ad67945220
Ref: library/pyexpat expat-example7945220
Ref: 2ad77945220
Node: Content Model Descriptions7946198
Ref: library/pyexpat content-model-descriptions7946361
Ref: 2ad87946361
Ref: library/pyexpat expat-content-models7946361
Ref: 2ad97946361
Ref: library/pyexpat module-xml parsers expat model7946361
Ref: 13a7946361
Node: Expat error constants7948204
Ref: library/pyexpat expat-error-constants7948347
Ref: 2ada7948347
Ref: library/pyexpat expat-errors7948347
Ref: 2adb7948347
Ref: library/pyexpat module-xml parsers expat errors7948347
Ref: 1397948347
Ref: library/pyexpat xml parsers expat errors codes7948939
Ref: 2ad37948939
Ref: library/pyexpat xml parsers expat errors messages7949089
Ref: 2ad27949089
Ref: library/pyexpat xml parsers expat errors XML_ERROR_ASYNC_ENTITY7949229
Ref: 2adc7949229
Ref: library/pyexpat xml parsers expat errors XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF7949288
Ref: 2add7949288
Ref: library/pyexpat xml parsers expat errors XML_ERROR_BAD_CHAR_REF7949489
Ref: 2ade7949489
Ref: library/pyexpat xml parsers expat errors XML_ERROR_BINARY_ENTITY_REF7949684
Ref: 2adf7949684
Ref: library/pyexpat xml parsers expat errors XML_ERROR_DUPLICATE_ATTRIBUTE7949858
Ref: 2ae07949858
Ref: library/pyexpat xml parsers expat errors XML_ERROR_INCORRECT_ENCODING7949983
Ref: 2ae17949983
Ref: library/pyexpat xml parsers expat errors XML_ERROR_INVALID_TOKEN7950048
Ref: 2ae27950048
Ref: library/pyexpat xml parsers expat errors XML_ERROR_JUNK_AFTER_DOC_ELEMENT7950262
Ref: 2ae37950262
Ref: library/pyexpat xml parsers expat errors XML_ERROR_MISPLACED_XML_PI7950411
Ref: 2ae47950411
Ref: library/pyexpat xml parsers expat errors XML_ERROR_NO_ELEMENTS7950564
Ref: 2ae57950564
Ref: library/pyexpat xml parsers expat errors XML_ERROR_NO_MEMORY7950739
Ref: 2ae67950739
Ref: library/pyexpat xml parsers expat errors XML_ERROR_PARAM_ENTITY_REF7950851
Ref: 2ae77950851
Ref: library/pyexpat xml parsers expat errors XML_ERROR_PARTIAL_CHAR7950985
Ref: 2ae87950985
Ref: library/pyexpat xml parsers expat errors XML_ERROR_RECURSIVE_ENTITY_REF7951098
Ref: 2ae97951098
Ref: library/pyexpat xml parsers expat errors XML_ERROR_SYNTAX7951300
Ref: 2aea7951300
Ref: library/pyexpat xml parsers expat errors XML_ERROR_TAG_MISMATCH7951406
Ref: 2aeb7951406
Ref: library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_TOKEN7951526
Ref: 2aec7951526
Ref: library/pyexpat xml parsers expat errors XML_ERROR_UNDEFINED_ENTITY7951710
Ref: 2aed7951710
Ref: library/pyexpat xml parsers expat errors XML_ERROR_UNKNOWN_ENCODING7951836
Ref: 2aee7951836
Ref: library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_CDATA_SECTION7951954
Ref: 2aef7951954
Ref: library/pyexpat xml parsers expat errors XML_ERROR_EXTERNAL_ENTITY_HANDLING7952068
Ref: 2af07952068
Ref: library/pyexpat xml parsers expat errors XML_ERROR_NOT_STANDALONE7952139
Ref: 2af17952139
Ref: library/pyexpat xml parsers expat errors XML_ERROR_UNEXPECTED_STATE7952402
Ref: 2af27952402
Ref: library/pyexpat xml parsers expat errors XML_ERROR_ENTITY_DECLARED_IN_PE7952465
Ref: 2af37952465
Ref: library/pyexpat xml parsers expat errors XML_ERROR_FEATURE_REQUIRES_XML_DTD7952533
Ref: 2af47952533
Ref: library/pyexpat xml parsers expat errors XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING7952839
Ref: 2af57952839
Ref: library/pyexpat xml parsers expat errors XML_ERROR_UNBOUND_PREFIX7953112
Ref: 2af67953112
Ref: library/pyexpat xml parsers expat errors XML_ERROR_UNDECLARING_PREFIX7953254
Ref: 2af77953254
Ref: library/pyexpat xml parsers expat errors XML_ERROR_INCOMPLETE_PE7953415
Ref: 2af87953415
Ref: library/pyexpat xml parsers expat errors XML_ERROR_XML_DECL7953529
Ref: 2af97953529
Ref: library/pyexpat xml parsers expat errors XML_ERROR_TEXT_DECL7953641
Ref: 2afa7953641
Ref: library/pyexpat xml parsers expat errors XML_ERROR_PUBLICID7953777
Ref: 2afb7953777
Ref: library/pyexpat xml parsers expat errors XML_ERROR_SUSPENDED7953899
Ref: 2afc7953899
Ref: library/pyexpat xml parsers expat errors XML_ERROR_NOT_SUSPENDED7954123
Ref: 2afd7954123
Ref: library/pyexpat xml parsers expat errors XML_ERROR_ABORTED7954275
Ref: 2afe7954275
Ref: library/pyexpat xml parsers expat errors XML_ERROR_FINISHED7954387
Ref: 2aff7954387
Ref: library/pyexpat xml parsers expat errors XML_ERROR_SUSPEND_PE7954633
Ref: 2b007954633
Node: Internet Protocols and Support7954690
Ref: library/internet doc7954855
Ref: 2b017954855
Ref: library/internet internet7954855
Ref: 2b027954855
Ref: library/internet internet-protocols-and-support7954855
Ref: 2b037954855
Node: webbrowser — Convenient Web-browser controller7956986
Ref: library/webbrowser doc7957150
Ref: 2b047957150
Ref: library/webbrowser module-webbrowser7957150
Ref: 1297957150
Ref: library/webbrowser webbrowser-convenient-web-browser-controller7957150
Ref: 2b057957150
Ref: library/webbrowser webbrowser Error7959099
Ref: 2b077959099
Ref: library/webbrowser webbrowser open7959230
Ref: 2b067959230
Ref: library/webbrowser webbrowser open_new7960038
Ref: 2b087960038
Ref: library/webbrowser webbrowser open_new_tab7960204
Ref: 2b097960204
Ref: library/webbrowser webbrowser get7960382
Ref: 2b0a7960382
Ref: library/webbrowser webbrowser register7960610
Ref: 2b0b7960610
Ref: webbrowser — Convenient Web-browser controller-Footnote-17967128
Ref: webbrowser — Convenient Web-browser controller-Footnote-27967197
Node: Browser Controller Objects7967334
Ref: library/webbrowser browser-controller-objects7967445
Ref: 2b0c7967445
Ref: library/webbrowser browser-controllers7967445
Ref: 2b0d7967445
Ref: library/webbrowser webbrowser controller open7967625
Ref: 2b0e7967625
Ref: library/webbrowser webbrowser controller open_new7967889
Ref: 2b0f7967889
Ref: library/webbrowser webbrowser controller open_new_tab7968108
Ref: 2b107968108
Node: cgi — Common Gateway Interface support7968308
Ref: library/cgi doc7968524
Ref: 2b117968524
Ref: library/cgi cgi-common-gateway-interface-support7968524
Ref: 2b127968524
Ref: library/cgi module-cgi7968524
Ref: 167968524
Ref: cgi — Common Gateway Interface support-Footnote-17969191
Node: Introduction<10>7969253
Ref: library/cgi introduction7969375
Ref: 2b137969375
Ref: library/cgi cgi-intro7969420
Ref: 2b147969420
Node: Using the cgi module7971074
Ref: library/cgi id17971227
Ref: 2b157971227
Ref: library/cgi using-the-cgi-module7971227
Ref: 2b167971227
Node: Higher Level Interface7977050
Ref: library/cgi higher-level-interface7977199
Ref: 2b187977199
Ref: library/cgi cgi FieldStorage getfirst7979488
Ref: 2b197979488
Ref: library/cgi cgi FieldStorage getlist7980062
Ref: 2b177980062
Ref: Higher Level Interface-Footnote-17980616
Node: Functions<8>7980874
Ref: library/cgi functions7981024
Ref: 2b1a7981024
Ref: library/cgi functions-in-cgi-module7981024
Ref: 2b1b7981024
Ref: library/cgi cgi parse7981206
Ref: 2b1c7981206
Ref: library/cgi cgi parse_multipart7981546
Ref: 4887981546
Ref: library/cgi cgi parse_header7982445
Ref: 2b1e7982445
Ref: library/cgi cgi test7982596
Ref: 2b1f7982596
Ref: library/cgi cgi print_environ7982781
Ref: 2b207982781
Ref: library/cgi cgi print_form7982861
Ref: 2b217982861
Ref: library/cgi cgi print_directory7982927
Ref: 2b227982927
Ref: library/cgi cgi print_environ_usage7983009
Ref: 2b237983009
Node: Caring about security7983125
Ref: library/cgi caring-about-security7983296
Ref: 2b247983296
Ref: library/cgi cgi-security7983296
Ref: 2b257983296
Node: Installing your CGI script on a Unix system7984081
Ref: library/cgi installing-your-cgi-script-on-a-unix-system7984263
Ref: 2b267984263
Node: Testing your CGI script7986283
Ref: library/cgi testing-your-cgi-script7986465
Ref: 2b277986465
Node: Debugging CGI scripts7987079
Ref: library/cgi debugging-cgi-scripts7987247
Ref: 2b287987247
Node: Common problems and solutions7990371
Ref: library/cgi common-problems-and-solutions7990507
Ref: 2b297990507
Node: cgitb — Traceback manager for CGI scripts7991849
Ref: library/cgitb doc7992072
Ref: 2b2a7992072
Ref: library/cgitb cgitb-traceback-manager-for-cgi-scripts7992072
Ref: 2b2b7992072
Ref: library/cgitb module-cgitb7992072
Ref: 177992072
Ref: library/cgitb cgitb enable7993257
Ref: 2b2c7993257
Ref: library/cgitb cgitb text7994191
Ref: 2b2d7994191
Ref: library/cgitb cgitb html7994619
Ref: 2b2e7994619
Ref: library/cgitb cgitb handler7995047
Ref: 2b2f7995047
Ref: cgitb — Traceback manager for CGI scripts-Footnote-17995680
Node: wsgiref — WSGI Utilities and Reference Implementation7995744
Ref: library/wsgiref doc7995958
Ref: 2b307995958
Ref: library/wsgiref module-wsgiref7995958
Ref: 12c7995958
Ref: library/wsgiref wsgiref-wsgi-utilities-and-reference-implementation7995958
Ref: 2b317995958
Ref: wsgiref — WSGI Utilities and Reference Implementation-Footnote-17997803
Ref: wsgiref — WSGI Utilities and Reference Implementation-Footnote-27997852
Node: wsgiref util – WSGI environment utilities7997889
Ref: library/wsgiref module-wsgiref util7998079
Ref: 1307998079
Ref: library/wsgiref wsgiref-util-wsgi-environment-utilities7998079
Ref: 2b327998079
Ref: library/wsgiref wsgiref util guess_scheme7998536
Ref: 2b337998536
Ref: library/wsgiref wsgiref util request_uri7999188
Ref: 2b347999188
Ref: library/wsgiref wsgiref util application_uri7999514
Ref: 2b357999514
Ref: library/wsgiref wsgiref util shift_path_info7999780
Ref: 2b367999780
Ref: library/wsgiref wsgiref util setup_testing_defaults8001448
Ref: 2b378001448
Ref: library/wsgiref wsgiref util is_hop_by_hop8002992
Ref: 2b388002992
Ref: library/wsgiref wsgiref util FileWrapper8003165
Ref: 27c8003165
Ref: wsgiref util – WSGI environment utilities-Footnote-18004377
Ref: wsgiref util – WSGI environment utilities-Footnote-28004426
Ref: wsgiref util – WSGI environment utilities-Footnote-38004475
Ref: wsgiref util – WSGI environment utilities-Footnote-48004524
Ref: wsgiref util – WSGI environment utilities-Footnote-58004573
Node: wsgiref headers – WSGI response header tools8004622
Ref: library/wsgiref module-wsgiref headers8004872
Ref: 12e8004872
Ref: library/wsgiref wsgiref-headers-wsgi-response-header-tools8004872
Ref: 2b398004872
Ref: library/wsgiref wsgiref headers Headers8005134
Ref: 7838005134
Ref: library/wsgiref wsgiref headers Headers get_all8007399
Ref: 2b3a8007399
Ref: library/wsgiref wsgiref headers Headers add_header8007836
Ref: 2b3b8007836
Ref: wsgiref headers – WSGI response header tools-Footnote-18008973
Node: wsgiref simple_server – a simple WSGI HTTP server8009022
Ref: library/wsgiref module-wsgiref simple_server8009274
Ref: 12f8009274
Ref: library/wsgiref wsgiref-simple-server-a-simple-wsgi-http-server8009274
Ref: 2b3c8009274
Ref: library/wsgiref wsgiref simple_server make_server8009868
Ref: 2b3d8009868
Ref: library/wsgiref wsgiref simple_server demo_app8010648
Ref: 2b3e8010648
Ref: library/wsgiref wsgiref simple_server WSGIServer8011088
Ref: 2b3f8011088
Ref: library/wsgiref wsgiref simple_server WSGIServer set_app8011841
Ref: 2b418011841
Ref: library/wsgiref wsgiref simple_server WSGIServer get_app8011986
Ref: 2b428011986
Ref: library/wsgiref wsgiref simple_server WSGIRequestHandler8012329
Ref: 2b438012329
Ref: library/wsgiref wsgiref simple_server WSGIRequestHandler get_environ8012945
Ref: 2b448012945
Ref: library/wsgiref wsgiref simple_server WSGIRequestHandler get_stderr8013451
Ref: 2b458013451
Ref: library/wsgiref wsgiref simple_server WSGIRequestHandler handle8013634
Ref: 2b468013634
Ref: wsgiref simple_server – a simple WSGI HTTP server-Footnote-18013905
Ref: wsgiref simple_server – a simple WSGI HTTP server-Footnote-28013954
Node: wsgiref validate — WSGI conformance checker8014003
Ref: library/wsgiref module-wsgiref validate8014257
Ref: 1318014257
Ref: library/wsgiref wsgiref-validate-wsgi-conformance-checker8014257
Ref: 2b478014257
Ref: library/wsgiref wsgiref validate validator8015164
Ref: 2b488015164
Ref: wsgiref validate — WSGI conformance checker-Footnote-18017227
Ref: wsgiref validate — WSGI conformance checker-Footnote-28017276
Ref: wsgiref validate — WSGI conformance checker-Footnote-38017325
Node: wsgiref handlers – server/gateway base classes8017374
Ref: library/wsgiref module-wsgiref handlers8017589
Ref: 12d8017589
Ref: library/wsgiref wsgiref-handlers-server-gateway-base-classes8017589
Ref: 2b498017589
Ref: library/wsgiref wsgiref handlers CGIHandler8017980
Ref: 2b4a8017980
Ref: library/wsgiref wsgiref handlers IISCGIHandler8018629
Ref: 2b4c8018629
Ref: library/wsgiref wsgiref handlers BaseCGIHandler8020005
Ref: 2b4b8020005
Ref: library/wsgiref wsgiref handlers SimpleHandler8020872
Ref: 2b4d8020872
Ref: library/wsgiref wsgiref handlers BaseHandler8021788
Ref: efe8021788
Ref: library/wsgiref wsgiref handlers BaseHandler run8022146
Ref: 2b4e8022146
Ref: library/wsgiref wsgiref handlers BaseHandler _write8022484
Ref: 2b4f8022484
Ref: library/wsgiref wsgiref handlers BaseHandler _flush8022829
Ref: 2b508022829
Ref: library/wsgiref wsgiref handlers BaseHandler get_stdin8023038
Ref: 2b518023038
Ref: library/wsgiref wsgiref handlers BaseHandler get_stderr8023203
Ref: 2b528023203
Ref: library/wsgiref wsgiref handlers BaseHandler add_cgi_vars8023371
Ref: 2b538023371
Ref: library/wsgiref wsgiref handlers BaseHandler wsgi_multithread8023917
Ref: 2b548023917
Ref: library/wsgiref wsgiref handlers BaseHandler wsgi_multiprocess8024207
Ref: 2b558024207
Ref: library/wsgiref wsgiref handlers BaseHandler wsgi_run_once8024499
Ref: 2b568024499
Ref: library/wsgiref wsgiref handlers BaseHandler os_environ8024741
Ref: 2b578024741
Ref: library/wsgiref wsgiref handlers BaseHandler server_software8025247
Ref: 2b588025247
Ref: library/wsgiref wsgiref handlers BaseHandler get_scheme8025843
Ref: 2b5a8025843
Ref: library/wsgiref wsgiref handlers BaseHandler setup_environ8026204
Ref: 2b5b8026204
Ref: library/wsgiref wsgiref handlers BaseHandler log_exception8026864
Ref: 2b5d8026864
Ref: library/wsgiref wsgiref handlers BaseHandler traceback_limit8027364
Ref: 2b5e8027364
Ref: library/wsgiref wsgiref handlers BaseHandler error_output8027586
Ref: 2b5f8027586
Ref: library/wsgiref wsgiref handlers BaseHandler error_status8028658
Ref: 2b608028658
Ref: library/wsgiref wsgiref handlers BaseHandler error_headers8028863
Ref: 2b618028863
Ref: library/wsgiref wsgiref handlers BaseHandler error_body8029155
Ref: 2b628029155
Ref: library/wsgiref wsgiref handlers BaseHandler wsgi_file_wrapper8029501
Ref: 2b5c8029501
Ref: library/wsgiref wsgiref handlers BaseHandler sendfile8029709
Ref: 2b638029709
Ref: library/wsgiref wsgiref handlers BaseHandler origin_server8030285
Ref: 2b598030285
Ref: library/wsgiref wsgiref handlers BaseHandler http_version8030811
Ref: 2b648030811
Ref: library/wsgiref wsgiref handlers read_environ8031033
Ref: b298031033
Ref: wsgiref handlers – server/gateway base classes-Footnote-18031947
Ref: wsgiref handlers – server/gateway base classes-Footnote-28031996
Ref: wsgiref handlers – server/gateway base classes-Footnote-38032045
Ref: wsgiref handlers – server/gateway base classes-Footnote-48032094
Ref: wsgiref handlers – server/gateway base classes-Footnote-58032143
Node: Examples<20>8032192
Ref: library/wsgiref examples8032353
Ref: 2b658032353
Node: urllib — URL handling modules8034690
Ref: library/urllib doc8034915
Ref: 2b668034915
Ref: library/urllib module-urllib8034915
Ref: 11d8034915
Ref: library/urllib urllib-url-handling-modules8034915
Ref: 2b678034915
Ref: urllib — URL handling modules-Footnote-18035496
Node: urllib request — Extensible library for opening URLs8035559
Ref: library/urllib request doc8035780
Ref: 2b688035780
Ref: library/urllib request module-urllib request8035780
Ref: 1208035780
Ref: library/urllib request urllib-request-extensible-library-for-opening-urls8035780
Ref: 2b698035780
Ref: library/urllib request urllib request urlopen8036391
Ref: 7808036391
Ref: library/urllib request urllib request install_opener8040702
Ref: 2b708040702
Ref: library/urllib request urllib request build_opener8041155
Ref: 2b718041155
Ref: library/urllib request urllib request pathname2url8042272
Ref: 2b798042272
Ref: library/urllib request urllib request url2pathname8042571
Ref: 2b7a8042571
Ref: library/urllib request urllib request getproxies8042828
Ref: 2b7c8042828
Ref: library/urllib request urllib request Request8043987
Ref: 8ea8043987
Ref: library/urllib request urllib request OpenerDirector8048418
Ref: 2b6e8048418
Ref: library/urllib request urllib request BaseHandler8048637
Ref: 2b728048637
Ref: library/urllib request urllib request HTTPDefaultErrorHandler8048797
Ref: 2b748048797
Ref: library/urllib request urllib request HTTPRedirectHandler8048989
Ref: 2b758048989
Ref: library/urllib request urllib request HTTPCookieProcessor8049074
Ref: 2b7e8049074
Ref: library/urllib request urllib request ProxyHandler8049176
Ref: eac8049176
Ref: library/urllib request urllib request HTTPPasswordMgr8050288
Ref: 2b7f8050288
Ref: library/urllib request urllib request HTTPPasswordMgrWithDefaultRealm8050405
Ref: 2b808050405
Ref: library/urllib request urllib request HTTPPasswordMgrWithPriorAuth8050646
Ref: 77e8050646
Ref: library/urllib request urllib request AbstractBasicAuthHandler8051032
Ref: 2b818051032
Ref: library/urllib request urllib request HTTPBasicAuthHandler8052374
Ref: 2b848052374
Ref: library/urllib request urllib request ProxyBasicAuthHandler8052838
Ref: 2b858052838
Ref: library/urllib request urllib request AbstractDigestAuthHandler8053178
Ref: e8d8053178
Ref: library/urllib request urllib request HTTPDigestAuthHandler8053588
Ref: 2b868053588
Ref: library/urllib request urllib request ProxyDigestAuthHandler8054450
Ref: 2b878054450
Ref: library/urllib request urllib request HTTPHandler8054791
Ref: 2b738054791
Ref: library/urllib request urllib request HTTPSHandler8054876
Ref: b9b8054876
Ref: library/urllib request urllib request FileHandler8055206
Ref: 2b778055206
Ref: library/urllib request urllib request DataHandler8055269
Ref: 8e98055269
Ref: library/urllib request urllib request FTPHandler8055356
Ref: 2b768055356
Ref: library/urllib request urllib request CacheFTPHandler8055415
Ref: 2b888055415
Ref: library/urllib request urllib request UnknownHandler8055544
Ref: 2b6f8055544
Ref: library/urllib request urllib request HTTPErrorProcessor8055634
Ref: 2b788055634
Ref: urllib request — Extensible library for opening URLs-Footnote-18056515
Ref: urllib request — Extensible library for opening URLs-Footnote-28056588
Ref: urllib request — Extensible library for opening URLs-Footnote-38056639
Ref: urllib request — Extensible library for opening URLs-Footnote-48056676
Ref: urllib request — Extensible library for opening URLs-Footnote-58056725
Ref: urllib request — Extensible library for opening URLs-Footnote-68056774
Node: Request Objects8056823
Ref: library/urllib request id18056960
Ref: 2b898056960
Ref: library/urllib request request-objects8056960
Ref: 2b8a8056960
Ref: library/urllib request urllib request Request full_url8057231
Ref: 8ec8057231
Ref: library/urllib request urllib request Request type8057526
Ref: 2b8b8057526
Ref: library/urllib request urllib request Request host8057577
Ref: 2b8c8057577
Ref: library/urllib request urllib request Request origin_req_host8057704
Ref: 2b8d8057704
Ref: library/urllib request urllib request Request selector8057799
Ref: 2b8e8057799
Ref: library/urllib request urllib request Request data8057963
Ref: 8ed8057963
Ref: library/urllib request urllib request Request unverifiable8058226
Ref: 2b8f8058226
Ref: library/urllib request urllib request Request method8058356
Ref: 8eb8058356
Ref: library/urllib request urllib request Request get_method8059062
Ref: ab68059062
Ref: library/urllib request urllib request Request add_header8059484
Ref: 2b7d8059484
Ref: library/urllib request urllib request Request add_unredirected_header8060077
Ref: 2b908060077
Ref: library/urllib request urllib request Request has_header8060203
Ref: 2b918060203
Ref: library/urllib request urllib request Request remove_header8060344
Ref: 8ef8060344
Ref: library/urllib request urllib request Request get_full_url8060517
Ref: 2b928060517
Ref: library/urllib request urllib request Request set_proxy8060674
Ref: 2b938060674
Ref: library/urllib request urllib request Request get_header8060927
Ref: 2b948060927
Ref: library/urllib request urllib request Request header_items8061093
Ref: 2b958061093
Ref: Request Objects-Footnote-18061452
Node: OpenerDirector Objects8061501
Ref: library/urllib request opener-director-objects8061666
Ref: 2b968061666
Ref: library/urllib request openerdirector-objects8061666
Ref: 2b978061666
Ref: library/urllib request urllib request OpenerDirector add_handler8061798
Ref: 2b988061798
Ref: library/urllib request urllib request OpenerDirector open8063356
Ref: 8ee8063356
Ref: library/urllib request urllib request OpenerDirector error8064040
Ref: 2b9d8064040
Node: BaseHandler Objects8065816
Ref: library/urllib request base-handler-objects8065993
Ref: 2b9e8065993
Ref: library/urllib request basehandler-objects8065993
Ref: 2b9f8065993
Ref: library/urllib request urllib request BaseHandler add_parent8066233
Ref: 2ba08066233
Ref: library/urllib request urllib request BaseHandler close8066312
Ref: 2ba18066312
Ref: library/urllib request urllib request BaseHandler parent8066688
Ref: 2ba28066688
Ref: library/urllib request urllib request BaseHandler default_open8066842
Ref: 2ba38066842
Ref: library/urllib request protocol-open8067515
Ref: 2b998067515
Ref: library/urllib request urllib request BaseHandler unknown_open8067881
Ref: 2ba48067881
Ref: library/urllib request urllib request BaseHandler http_error_default8068293
Ref: 2ba58068293
Ref: library/urllib request http-error-nnn8069100
Ref: 2b9a8069100
Ref: library/urllib request protocol-request8069598
Ref: 2b9b8069598
Ref: library/urllib request protocol-response8070012
Ref: 2b9c8070012
Node: HTTPRedirectHandler Objects8070603
Ref: library/urllib request http-redirect-handler8070785
Ref: 2ba68070785
Ref: library/urllib request httpredirecthandler-objects8070785
Ref: 2ba78070785
Ref: library/urllib request urllib request HTTPRedirectHandler redirect_request8071282
Ref: 2ba88071282
Ref: library/urllib request urllib request HTTPRedirectHandler http_error_3018072366
Ref: 2ba98072366
Ref: library/urllib request urllib request HTTPRedirectHandler http_error_3028072637
Ref: 2baa8072637
Ref: library/urllib request urllib request HTTPRedirectHandler http_error_3038072816
Ref: 2bab8072816
Ref: library/urllib request urllib request HTTPRedirectHandler http_error_3078072999
Ref: 2bac8072999
Ref: HTTPRedirectHandler Objects-Footnote-18073227
Ref: HTTPRedirectHandler Objects-Footnote-28073276
Node: HTTPCookieProcessor Objects8073325
Ref: library/urllib request http-cookie-processor8073508
Ref: 2bad8073508
Ref: library/urllib request httpcookieprocessor-objects8073508
Ref: 2bae8073508
Ref: library/urllib request urllib request HTTPCookieProcessor cookiejar8073647
Ref: 2baf8073647
Node: ProxyHandler Objects8073775
Ref: library/urllib request proxy-handler8073954
Ref: 2bb18073954
Ref: library/urllib request proxyhandler-objects8073954
Ref: 2bb28073954
Node: HTTPPasswordMgr Objects8074426
Ref: library/urllib request http-password-mgr8074614
Ref: 2b828074614
Ref: library/urllib request httppasswordmgr-objects8074614
Ref: 2bb38074614
Ref: library/urllib request urllib request HTTPPasswordMgr add_password8074800
Ref: 2bb48074800
Ref: library/urllib request urllib request HTTPPasswordMgr find_user_password8075147
Ref: 2bb58075147
Node: HTTPPasswordMgrWithPriorAuth Objects8075521
Ref: library/urllib request http-password-mgr-with-prior-auth8075721
Ref: 2b838075721
Ref: library/urllib request httppasswordmgrwithpriorauth-objects8075721
Ref: 2bb68075721
Ref: library/urllib request urllib request HTTPPasswordMgrWithPriorAuth add_password8075975
Ref: 2bb78075975
Ref: library/urllib request urllib request HTTPPasswordMgrWithPriorAuth update_authenticated8076525
Ref: 2bb88076525
Ref: library/urllib request urllib request HTTPPasswordMgrWithPriorAuth is_authenticated8076721
Ref: 2bb98076721
Node: AbstractBasicAuthHandler Objects8076897
Ref: library/urllib request abstract-basic-auth-handler8077102
Ref: 2bba8077102
Ref: library/urllib request abstractbasicauthhandler-objects8077102
Ref: 2bbb8077102
Ref: library/urllib request urllib request AbstractBasicAuthHandler http_error_auth_reqed8077187
Ref: 2bbc8077187
Node: HTTPBasicAuthHandler Objects8078007
Ref: library/urllib request http-basic-auth-handler8078205
Ref: 2bbd8078205
Ref: library/urllib request httpbasicauthhandler-objects8078205
Ref: 2bbe8078205
Ref: library/urllib request urllib request HTTPBasicAuthHandler http_error_4018078284
Ref: 2bbf8078284
Node: ProxyBasicAuthHandler Objects8078441
Ref: library/urllib request proxy-basic-auth-handler8078640
Ref: 2bc08078640
Ref: library/urllib request proxybasicauthhandler-objects8078640
Ref: 2bc18078640
Ref: library/urllib request urllib request ProxyBasicAuthHandler http_error_4078078721
Ref: 2bc28078721
Node: AbstractDigestAuthHandler Objects8078879
Ref: library/urllib request abstract-digest-auth-handler8079079
Ref: 2bc38079079
Ref: library/urllib request abstractdigestauthhandler-objects8079079
Ref: 2bc48079079
Ref: library/urllib request urllib request AbstractDigestAuthHandler http_error_auth_reqed8079168
Ref: 2bc58079168
Node: HTTPDigestAuthHandler Objects8079545
Ref: library/urllib request http-digest-auth-handler8079746
Ref: 2bc68079746
Ref: library/urllib request httpdigestauthhandler-objects8079746
Ref: 2bc78079746
Ref: library/urllib request urllib request HTTPDigestAuthHandler http_error_4018079827
Ref: 2bc88079827
Node: ProxyDigestAuthHandler Objects8079985
Ref: library/urllib request proxy-digest-auth-handler8080172
Ref: 2bc98080172
Ref: library/urllib request proxydigestauthhandler-objects8080172
Ref: 2bca8080172
Ref: library/urllib request urllib request ProxyDigestAuthHandler http_error_4078080255
Ref: 2bcb8080255
Node: HTTPHandler Objects8080414
Ref: library/urllib request http-handler-objects8080592
Ref: 2bcc8080592
Ref: library/urllib request httphandler-objects8080592
Ref: 2bcd8080592
Ref: library/urllib request urllib request HTTPHandler http_open8080653
Ref: 2bce8080653
Node: HTTPSHandler Objects8080795
Ref: library/urllib request https-handler-objects8080962
Ref: 2bcf8080962
Ref: library/urllib request httpshandler-objects8080962
Ref: 2bd08080962
Ref: library/urllib request urllib request HTTPSHandler https_open8081025
Ref: 2bd18081025
Node: FileHandler Objects8081170
Ref: library/urllib request file-handler-objects8081337
Ref: 2bd28081337
Ref: library/urllib request filehandler-objects8081337
Ref: 2bd38081337
Ref: library/urllib request urllib request FileHandler file_open8081398
Ref: 2bd48081398
Node: DataHandler Objects8081700
Ref: library/urllib request data-handler-objects8081865
Ref: 2bd58081865
Ref: library/urllib request datahandler-objects8081865
Ref: 2bd68081865
Ref: library/urllib request urllib request DataHandler data_open8081926
Ref: 2bd78081926
Ref: DataHandler Objects-Footnote-18082485
Node: FTPHandler Objects8082534
Ref: library/urllib request ftp-handler-objects8082703
Ref: 2bd88082703
Ref: library/urllib request ftphandler-objects8082703
Ref: 2bd98082703
Ref: library/urllib request urllib request FTPHandler ftp_open8082762
Ref: 2bda8082762
Node: CacheFTPHandler Objects8082910
Ref: library/urllib request cacheftp-handler-objects8083082
Ref: 2bdb8083082
Ref: library/urllib request cacheftphandler-objects8083082
Ref: 2bdc8083082
Ref: library/urllib request urllib request CacheFTPHandler setTimeout8083264
Ref: 2bdd8083264
Ref: library/urllib request urllib request CacheFTPHandler setMaxConns8083357
Ref: 2bde8083357
Node: UnknownHandler Objects8083457
Ref: library/urllib request unknown-handler-objects8083637
Ref: 2bdf8083637
Ref: library/urllib request unknownhandler-objects8083637
Ref: 2be08083637
Ref: library/urllib request urllib request UnknownHandler unknown_open8083704
Ref: 2be18083704
Node: HTTPErrorProcessor Objects8083795
Ref: library/urllib request http-error-processor-objects8083964
Ref: 2be28083964
Ref: library/urllib request httperrorprocessor-objects8083964
Ref: 2be38083964
Ref: library/urllib request urllib request HTTPErrorProcessor http_response8084039
Ref: 2be48084039
Ref: library/urllib request urllib request HTTPErrorProcessor https_response8084509
Ref: 2be58084509
Node: Examples<21>8084672
Ref: library/urllib request examples8084835
Ref: 2be68084835
Ref: library/urllib request urllib-request-examples8084835
Ref: 2be78084835
Ref: library/urllib request urllib-examples8090130
Ref: 2be98090130
Node: Legacy interface8091518
Ref: library/urllib request legacy-interface8091682
Ref: 2bea8091682
Ref: library/urllib request urllib request urlretrieve8091913
Ref: 2beb8091913
Ref: library/urllib request urllib request urlcleanup8094545
Ref: 2bec8094545
Ref: library/urllib request urllib request URLopener8094705
Ref: 2b6b8094705
Ref: library/urllib request urllib request URLopener open8096214
Ref: 2bee8096214
Ref: library/urllib request urllib request URLopener open_unknown8096717
Ref: 2bef8096717
Ref: library/urllib request urllib request URLopener retrieve8096829
Ref: efa8096829
Ref: library/urllib request urllib request URLopener version8098378
Ref: 2bed8098378
Ref: library/urllib request urllib request FancyURLopener8098699
Ref: 2b6c8098699
Ref: library/urllib request urllib request FancyURLopener prompt_user_passwd8100436
Ref: 2bf08100436
Ref: Legacy interface-Footnote-18100976
Node: urllib request Restrictions8101025
Ref: library/urllib request urllib-request-restrictions8101168
Ref: 2bf18101168
Node: urllib response — Response classes used by urllib8103736
Ref: library/urllib request module-urllib response8103969
Ref: 1218103969
Ref: library/urllib request urllib-response-response-classes-used-by-urllib8103969
Ref: 2bf28103969
Node: urllib parse — Parse URLs into components8104517
Ref: library/urllib parse doc8104755
Ref: 2bf38104755
Ref: library/urllib parse module-urllib parse8104755
Ref: 11f8104755
Ref: library/urllib parse urllib-parse-parse-urls-into-components8104755
Ref: 2bf48104755
Ref: urllib parse — Parse URLs into components-Footnote-18106030
Node: URL Parsing8106101
Ref: library/urllib parse url-parsing8106228
Ref: 2bf58106228
Ref: library/urllib parse urllib parse urlparse8106401
Ref: 5ef8106401
Ref: library/urllib parse urllib parse parse_qs8113491
Ref: 2b1d8113491
Ref: library/urllib parse urllib parse parse_qsl8115205
Ref: 2bf78115205
Ref: library/urllib parse urllib parse urlunparse8116769
Ref: 2bf88116769
Ref: library/urllib parse urllib parse urlsplit8117171
Ref: 5ee8117171
Ref: library/urllib parse urllib parse urlunsplit8121203
Ref: 2bf98121203
Ref: library/urllib parse urllib parse urljoin8121647
Ref: 7818121647
Ref: library/urllib parse urllib parse urldefrag8122917
Ref: bd18122917
Ref: library/urllib parse urllib parse unwrap8124262
Ref: 2bfa8124262
Ref: URL Parsing-Footnote-18124610
Ref: URL Parsing-Footnote-28124659
Ref: URL Parsing-Footnote-38124708
Ref: URL Parsing-Footnote-48124757
Node: Parsing ASCII Encoded Bytes8124806
Ref: library/urllib parse id18124966
Ref: 2bfb8124966
Ref: library/urllib parse parsing-ascii-encoded-bytes8124966
Ref: bd38124966
Node: Structured Parse Results8127092
Ref: library/urllib parse structured-parse-results8127252
Ref: 2bfc8127252
Ref: library/urllib parse urlparse-result-object8127252
Ref: 2bf68127252
Ref: library/urllib parse urllib parse urllib parse SplitResult geturl8127668
Ref: 2bfd8127668
Ref: library/urllib parse urllib parse DefragResult8128721
Ref: 2bfe8128721
Ref: library/urllib parse urllib parse ParseResult8128979
Ref: 2c008128979
Ref: library/urllib parse urllib parse SplitResult8129250
Ref: 2c028129250
Ref: library/urllib parse urllib parse DefragResultBytes8129655
Ref: 2bff8129655
Ref: library/urllib parse urllib parse ParseResultBytes8129915
Ref: 2c018129915
Ref: library/urllib parse urllib parse SplitResultBytes8130214
Ref: 2c038130214
Node: URL Quoting8130505
Ref: library/urllib parse url-quoting8130629
Ref: 2c048130629
Ref: library/urllib parse urllib parse quote8131032
Ref: 4028131032
Ref: library/urllib parse urllib parse quote_plus8132392
Ref: bd28132392
Ref: library/urllib parse urllib parse quote_from_bytes8132883
Ref: 2c058132883
Ref: library/urllib parse urllib parse unquote8133176
Ref: 2b7b8133176
Ref: library/urllib parse urllib parse unquote_plus8133805
Ref: 2c068133805
Ref: library/urllib parse urllib parse unquote_to_bytes8134143
Ref: 2c078134143
Ref: library/urllib parse urllib parse urlencode8134561
Ref: 77f8134561
Ref: URL Quoting-Footnote-18138196
Ref: URL Quoting-Footnote-28138245
Ref: URL Quoting-Footnote-38138294
Ref: URL Quoting-Footnote-48138343
Ref: URL Quoting-Footnote-58138392
Ref: URL Quoting-Footnote-68138441
Ref: URL Quoting-Footnote-78138490
Ref: URL Quoting-Footnote-88138539
Node: urllib error — Exception classes raised by urllib request8138588
Ref: library/urllib error doc8138819
Ref: 2c088138819
Ref: library/urllib error module-urllib error8138819
Ref: 11e8138819
Ref: library/urllib error urllib-error-exception-classes-raised-by-urllib-request8138819
Ref: 2c098138819
Ref: library/urllib error urllib error URLError8139318
Ref: 2b6d8139318
Ref: library/urllib error urllib error URLError reason8139496
Ref: 2c0a8139496
Ref: library/urllib error urllib error HTTPError8139767
Ref: 8f08139767
Ref: library/urllib error urllib error HTTPError code8140124
Ref: 2c0b8140124
Ref: library/urllib error urllib error HTTPError reason8140384
Ref: 2c0d8140384
Ref: library/urllib error urllib error HTTPError headers8140486
Ref: 8f18140486
Ref: library/urllib error urllib error ContentTooShortError8140652
Ref: 2c0e8140652
Ref: urllib error — Exception classes raised by urllib request-Footnote-18141052
Ref: urllib error — Exception classes raised by urllib request-Footnote-28141123
Node: urllib robotparser — Parser for robots txt8141172
Ref: library/urllib robotparser doc8141381
Ref: 2c0f8141381
Ref: library/urllib robotparser module-urllib robotparser8141381
Ref: 1228141381
Ref: library/urllib robotparser urllib-robotparser-parser-for-robots-txt8141381
Ref: 2c108141381
Ref: library/urllib robotparser urllib robotparser RobotFileParser8141924
Ref: 5a28141924
Ref: library/urllib robotparser urllib robotparser RobotFileParser set_url8142097
Ref: 2c118142097
Ref: library/urllib robotparser urllib robotparser RobotFileParser read8142191
Ref: 2c128142191
Ref: library/urllib robotparser urllib robotparser RobotFileParser parse8142287
Ref: fd98142287
Ref: library/urllib robotparser urllib robotparser RobotFileParser can_fetch8142357
Ref: 2c138142357
Ref: library/urllib robotparser urllib robotparser RobotFileParser mtime8142571
Ref: 2c148142571
Ref: library/urllib robotparser urllib robotparser RobotFileParser modified8142799
Ref: 2c158142799
Ref: library/urllib robotparser urllib robotparser RobotFileParser crawl_delay8142928
Ref: 2c168142928
Ref: library/urllib robotparser urllib robotparser RobotFileParser request_rate8143330
Ref: 2c178143330
Ref: library/urllib robotparser urllib robotparser RobotFileParser site_maps8143781
Ref: f6e8143781
Ref: urllib robotparser — Parser for robots txt-Footnote-18144631
Node: http — HTTP modules8144709
Ref: library/http doc8144895
Ref: 2c188144895
Ref: library/http http-http-modules8144895
Ref: 2c198144895
Ref: library/http module-http8144895
Ref: 938144895
Ref: library/http http HTTPStatus8145718
Ref: 6d68145718
Ref: http — HTTP modules-Footnote-18146338
Node: HTTP status codes8146410
Ref: library/http http-status-codes8146485
Ref: 2c1a8146485
Ref: library/http id18146485
Ref: 2c1b8146485
Ref: HTTP status codes-Footnote-18159543
Ref: HTTP status codes-Footnote-28159627
Ref: HTTP status codes-Footnote-38159676
Ref: HTTP status codes-Footnote-48159725
Ref: HTTP status codes-Footnote-58159774
Ref: HTTP status codes-Footnote-68159823
Ref: HTTP status codes-Footnote-78159872
Ref: HTTP status codes-Footnote-88159921
Ref: HTTP status codes-Footnote-98159970
Ref: HTTP status codes-Footnote-108160019
Ref: HTTP status codes-Footnote-118160069
Ref: HTTP status codes-Footnote-128160119
Ref: HTTP status codes-Footnote-138160169
Ref: HTTP status codes-Footnote-148160219
Ref: HTTP status codes-Footnote-158160269
Ref: HTTP status codes-Footnote-168160319
Ref: HTTP status codes-Footnote-178160369
Ref: HTTP status codes-Footnote-188160419
Ref: HTTP status codes-Footnote-198160469
Ref: HTTP status codes-Footnote-208160519
Ref: HTTP status codes-Footnote-218160569
Ref: HTTP status codes-Footnote-228160619
Ref: HTTP status codes-Footnote-238160669
Ref: HTTP status codes-Footnote-248160719
Ref: HTTP status codes-Footnote-258160769
Ref: HTTP status codes-Footnote-268160819
Ref: HTTP status codes-Footnote-278160869
Ref: HTTP status codes-Footnote-288160919
Ref: HTTP status codes-Footnote-298160969
Ref: HTTP status codes-Footnote-308161019
Ref: HTTP status codes-Footnote-318161069
Ref: HTTP status codes-Footnote-328161119
Ref: HTTP status codes-Footnote-338161169
Ref: HTTP status codes-Footnote-348161219
Ref: HTTP status codes-Footnote-358161269
Ref: HTTP status codes-Footnote-368161319
Ref: HTTP status codes-Footnote-378161369
Ref: HTTP status codes-Footnote-388161419
Ref: HTTP status codes-Footnote-398161469
Ref: HTTP status codes-Footnote-408161519
Ref: HTTP status codes-Footnote-418161569
Ref: HTTP status codes-Footnote-428161619
Ref: HTTP status codes-Footnote-438161669
Ref: HTTP status codes-Footnote-448161719
Ref: HTTP status codes-Footnote-458161769
Ref: HTTP status codes-Footnote-468161819
Ref: HTTP status codes-Footnote-478161869
Ref: HTTP status codes-Footnote-488161919
Ref: HTTP status codes-Footnote-498161969
Ref: HTTP status codes-Footnote-508162019
Ref: HTTP status codes-Footnote-518162069
Ref: HTTP status codes-Footnote-528162119
Ref: HTTP status codes-Footnote-538162169
Ref: HTTP status codes-Footnote-548162219
Ref: HTTP status codes-Footnote-558162269
Ref: HTTP status codes-Footnote-568162319
Ref: HTTP status codes-Footnote-578162369
Ref: HTTP status codes-Footnote-588162419
Ref: HTTP status codes-Footnote-598162469
Ref: HTTP status codes-Footnote-608162519
Node: http client — HTTP protocol client8162569
Ref: library/http client doc8162741
Ref: 2c1c8162741
Ref: library/http client http-client-http-protocol-client8162741
Ref: 2c1d8162741
Ref: library/http client module-http client8162741
Ref: 948162741
Ref: library/http client http client HTTPConnection8163433
Ref: 3878163433
Ref: library/http client http client HTTPSConnection8164981
Ref: 3888164981
Ref: library/http client http client HTTPResponse8166815
Ref: a068166815
Ref: library/http client http client parse_headers8167197
Ref: f788167197
Ref: library/http client http client HTTPException8168131
Ref: 2c208168131
Ref: library/http client http client NotConnected8168282
Ref: 2c218168282
Ref: library/http client http client InvalidURL8168370
Ref: 2c228168370
Ref: library/http client http client UnknownProtocol8168523
Ref: 2c238168523
Ref: library/http client http client UnknownTransferEncoding8168614
Ref: 2c248168614
Ref: library/http client http client UnimplementedFileMode8168713
Ref: 2c258168713
Ref: library/http client http client IncompleteRead8168810
Ref: 2c268168810
Ref: library/http client http client ImproperConnectionState8168900
Ref: 2c278168900
Ref: library/http client http client CannotSendRequest8168999
Ref: 2c288168999
Ref: library/http client http client CannotSendHeader8169102
Ref: 2c298169102
Ref: library/http client http client ResponseNotReady8169204
Ref: 2c2a8169204
Ref: library/http client http client BadStatusLine8169306
Ref: 2c2b8169306
Ref: library/http client http client LineTooLong8169481
Ref: 2c2c8169481
Ref: library/http client http client RemoteDisconnected8169659
Ref: 6d98169659
Ref: library/http client http client HTTP_PORT8170138
Ref: 2c2d8170138
Ref: library/http client http client HTTPS_PORT8170235
Ref: 2c2e8170235
Ref: library/http client http client responses8170335
Ref: 2c2f8170335
Ref: http client — HTTP protocol client-Footnote-18170796
Ref: http client — HTTP protocol client-Footnote-28170866
Ref: http client — HTTP protocol client-Footnote-38170917
Node: HTTPConnection Objects8170966
Ref: library/http client httpconnection-objects8171090
Ref: 2c308171090
Ref: library/http client id18171090
Ref: 2c318171090
Ref: library/http client http client HTTPConnection request8171223
Ref: 5448171223
Ref: library/http client http client HTTPConnection getresponse8174005
Ref: 6d88174005
Ref: library/http client http client HTTPConnection set_debuglevel8174497
Ref: 2c328174497
Ref: library/http client http client HTTPConnection set_tunnel8174898
Ref: ba08174898
Ref: library/http client http client HTTPConnection connect8175873
Ref: 2c338175873
Ref: library/http client http client HTTPConnection close8176103
Ref: 2c348176103
Ref: library/http client http client HTTPConnection blocksize8176182
Ref: 2c358176182
Ref: library/http client http client HTTPConnection putrequest8176466
Ref: 2c368176466
Ref: library/http client http client HTTPConnection putheader8177015
Ref: 2c378177015
Ref: library/http client http client HTTPConnection endheaders8177350
Ref: 5458177350
Ref: library/http client http client HTTPConnection send8178719
Ref: 2c388178719
Ref: HTTPConnection Objects-Footnote-18178977
Ref: HTTPConnection Objects-Footnote-28179025
Node: HTTPResponse Objects8179074
Ref: library/http client httpresponse-objects8179219
Ref: 2c398179219
Ref: library/http client id28179219
Ref: 2c3a8179219
Ref: library/http client http client HTTPResponse read8179633
Ref: 2c3b8179633
Ref: library/http client http client HTTPResponse readinto8179746
Ref: a078179746
Ref: library/http client http client HTTPResponse getheader8179933
Ref: 2c3c8179933
Ref: library/http client http client HTTPResponse getheaders8180324
Ref: 2c3d8180324
Ref: library/http client http client HTTPResponse fileno8180411
Ref: 2c3e8180411
Ref: library/http client http client HTTPResponse msg8180503
Ref: 2c1e8180503
Ref: library/http client http client HTTPResponse version8180708
Ref: 2c3f8180708
Ref: library/http client http client HTTPResponse status8180829
Ref: 2c408180829
Ref: library/http client http client HTTPResponse reason8180903
Ref: 2b6a8180903
Ref: library/http client http client HTTPResponse debuglevel8180979
Ref: 2c418180979
Ref: library/http client http client HTTPResponse closed8181174
Ref: 2c428181174
Node: Examples<22>8181255
Ref: library/http client examples8181397
Ref: 2c438181397
Node: HTTPMessage Objects8184044
Ref: library/http client httpmessage-objects8184157
Ref: 2c448184157
Ref: library/http client id38184157
Ref: 2c458184157
Node: ftplib — FTP protocol client8184372
Ref: library/ftplib doc8184554
Ref: 2c468184554
Ref: library/ftplib ftplib-ftp-protocol-client8184554
Ref: 2c478184554
Ref: library/ftplib module-ftplib8184554
Ref: 848184554
Ref: library/ftplib ftplib FTP8186014
Ref: 9f78186014
Ref: library/ftplib ftplib FTP_TLS8187427
Ref: 9f88187427
Ref: library/ftplib ftplib error_reply8189656
Ref: 2c498189656
Ref: library/ftplib ftplib error_temp8189773
Ref: 2c4a8189773
Ref: library/ftplib ftplib error_perm8189936
Ref: 2c4b8189936
Ref: library/ftplib ftplib error_proto8190099
Ref: 2c4c8190099
Ref: library/ftplib ftplib all_errors8190330
Ref: 2c4d8190330
Ref: ftplib — FTP protocol client-Footnote-18190992
Ref: ftplib — FTP protocol client-Footnote-28191057
Ref: ftplib — FTP protocol client-Footnote-38191105
Node: FTP Objects8191154
Ref: library/ftplib ftp-objects8191256
Ref: 2c4e8191256
Ref: library/ftplib id18191256
Ref: 2c4f8191256
Ref: library/ftplib ftplib FTP set_debuglevel8191593
Ref: 2c508191593
Ref: library/ftplib ftplib FTP connect8192057
Ref: 2c518192057
Ref: library/ftplib ftplib FTP getwelcome8193069
Ref: 2c528193069
Ref: library/ftplib ftplib FTP login8193299
Ref: 2c538193299
Ref: library/ftplib ftplib FTP abort8194012
Ref: 2c548194012
Ref: library/ftplib ftplib FTP sendcmd8194150
Ref: 2c558194150
Ref: library/ftplib ftplib FTP voidcmd8194375
Ref: 2c568194375
Ref: library/ftplib ftplib FTP retrbinary8194749
Ref: 2c578194749
Ref: library/ftplib ftplib FTP retrlines8195429
Ref: 2c598195429
Ref: library/ftplib ftplib FTP set_pasv8196051
Ref: 2c5a8196051
Ref: library/ftplib ftplib FTP storbinary8196202
Ref: c928196202
Ref: library/ftplib ftplib FTP storlines8196902
Ref: 2c5b8196902
Ref: library/ftplib ftplib FTP transfercmd8197367
Ref: 2c588197367
Ref: library/ftplib ftplib FTP ntransfercmd8198617
Ref: 2c5c8198617
Ref: library/ftplib ftplib FTP mlsd8198967
Ref: 9fa8198967
Ref: library/ftplib ftplib FTP nlst8199659
Ref: 9fb8199659
Ref: library/ftplib ftplib FTP dir8200070
Ref: 9fc8200070
Ref: library/ftplib ftplib FTP rename8200705
Ref: 2c5d8200705
Ref: library/ftplib ftplib FTP delete8200804
Ref: 2c5e8200804
Ref: library/ftplib ftplib FTP cwd8201067
Ref: 2c5f8201067
Ref: library/ftplib ftplib FTP mkd8201146
Ref: 2c608201146
Ref: library/ftplib ftplib FTP pwd8201222
Ref: 2c618201222
Ref: library/ftplib ftplib FTP rmd8201312
Ref: 2c628201312
Ref: library/ftplib ftplib FTP size8201401
Ref: 2c638201401
Ref: library/ftplib ftplib FTP quit8201727
Ref: 2c648201727
Ref: library/ftplib ftplib FTP close8202137
Ref: 2c658202137
Ref: FTP Objects-Footnote-18202597
Ref: FTP Objects-Footnote-28202645
Node: FTP_TLS Objects8202694
Ref: library/ftplib ftp-tls-objects8202796
Ref: 2c668202796
Ref: library/ftplib ftplib FTP_TLS ssl_version8202941
Ref: 2c678202941
Ref: library/ftplib ftplib FTP_TLS auth8203059
Ref: 2c688203059
Ref: library/ftplib ftplib FTP_TLS ccc8203417
Ref: 9f98203417
Ref: library/ftplib ftplib FTP_TLS prot_p8203657
Ref: 2c488203657
Ref: library/ftplib ftplib FTP_TLS prot_c8203725
Ref: 2c698203725
Node: poplib — POP3 protocol client8203797
Ref: library/poplib doc8203976
Ref: 2c6a8203976
Ref: library/poplib module-poplib8203976
Ref: d08203976
Ref: library/poplib poplib-pop3-protocol-client8203976
Ref: 2c6b8203976
Ref: library/poplib poplib POP38205091
Ref: 2c6c8205091
Ref: library/poplib poplib POP3_SSL8205833
Ref: bb48205833
Ref: library/poplib poplib error_proto8207607
Ref: b0a8207607
Ref: poplib — POP3 protocol client-Footnote-18208260
Ref: poplib — POP3 protocol client-Footnote-28208325
Ref: poplib — POP3 protocol client-Footnote-38208374
Ref: poplib — POP3 protocol client-Footnote-48208423
Ref: poplib — POP3 protocol client-Footnote-58208472
Node: POP3 Objects8208534
Ref: library/poplib id18208635
Ref: 2c6d8208635
Ref: library/poplib pop3-objects8208635
Ref: 2c6e8208635
Ref: library/poplib poplib POP3 set_debuglevel8208869
Ref: 2c6f8208869
Ref: library/poplib poplib POP3 getwelcome8209334
Ref: 2c708209334
Ref: library/poplib poplib POP3 capa8209425
Ref: 8868209425
Ref: library/poplib poplib POP3 user8209614
Ref: 2c718209614
Ref: library/poplib poplib POP3 pass_8209732
Ref: 2c728209732
Ref: library/poplib poplib POP3 apop8209915
Ref: 2c738209915
Ref: library/poplib poplib POP3 rpop8210033
Ref: 2c748210033
Ref: library/poplib poplib POP3 stat8210152
Ref: 2c758210152
Ref: library/poplib poplib POP3 list8210284
Ref: 2c768210284
Ref: library/poplib poplib POP3 retr8210476
Ref: 2c778210476
Ref: library/poplib poplib POP3 dele8210639
Ref: 2c788210639
Ref: library/poplib poplib POP3 rset8210917
Ref: 2c798210917
Ref: library/poplib poplib POP3 noop8210992
Ref: 2c7a8210992
Ref: library/poplib poplib POP3 quit8211068
Ref: b098211068
Ref: library/poplib poplib POP3 top8211158
Ref: 2c7b8211158
Ref: library/poplib poplib POP3 uidl8211695
Ref: 2c7c8211695
Ref: library/poplib poplib POP3 utf88211979
Ref: 7268211979
Ref: library/poplib poplib POP3 stls8212186
Ref: 8878212186
Ref: POP3 Objects-Footnote-18212985
Ref: POP3 Objects-Footnote-28213034
Ref: POP3 Objects-Footnote-38213083
Node: POP3 Example8213132
Ref: library/poplib id28213233
Ref: 2c7d8213233
Ref: library/poplib pop3-example8213233
Ref: 2c7e8213233
Node: imaplib — IMAP4 protocol client8213710
Ref: library/imaplib doc8213891
Ref: 2c7f8213891
Ref: library/imaplib imaplib-imap4-protocol-client8213891
Ref: 2c808213891
Ref: library/imaplib module-imaplib8213891
Ref: 988213891
Ref: library/imaplib imaplib IMAP48214556
Ref: 6008214556
Ref: library/imaplib imaplib IMAP4 error8215449
Ref: 2c828215449
Ref: library/imaplib imaplib IMAP4 abort8215592
Ref: 2c838215592
Ref: library/imaplib imaplib IMAP4 readonly8215854
Ref: 2c848215854
Ref: library/imaplib imaplib IMAP4_SSL8216211
Ref: a0c8216211
Ref: library/imaplib imaplib IMAP4_stream8217932
Ref: 2c818217932
Ref: library/imaplib imaplib Internaldate2tuple8218202
Ref: 2c858218202
Ref: library/imaplib imaplib Int2AP8218452
Ref: 2c868218452
Ref: library/imaplib imaplib ParseFlags8218601
Ref: 2c878218601
Ref: library/imaplib imaplib Time2Internaldate8218722
Ref: 2c888218722
Ref: imaplib — IMAP4 protocol client-Footnote-18220049
Ref: imaplib — IMAP4 protocol client-Footnote-28220115
Ref: imaplib — IMAP4 protocol client-Footnote-38220164
Node: IMAP4 Objects8220213
Ref: library/imaplib id18220318
Ref: 2c898220318
Ref: library/imaplib imap4-objects8220318
Ref: 2c8a8220318
Ref: library/imaplib imaplib IMAP4 append8221817
Ref: 2c8b8221817
Ref: library/imaplib imaplib IMAP4 authenticate8221921
Ref: 2c8c8221921
Ref: library/imaplib imaplib IMAP4 check8222757
Ref: 2c8d8222757
Ref: library/imaplib imaplib IMAP4 close8222821
Ref: 2c8e8222821
Ref: library/imaplib imaplib IMAP4 copy8223006
Ref: 2c8f8223006
Ref: library/imaplib imaplib IMAP4 create8223118
Ref: 2c908223118
Ref: library/imaplib imaplib IMAP4 delete8223196
Ref: 2c918223196
Ref: library/imaplib imaplib IMAP4 deleteacl8223274
Ref: 2c928223274
Ref: library/imaplib imaplib IMAP4 enable8223384
Ref: 6de8223384
Ref: library/imaplib imaplib IMAP4 expunge8223701
Ref: 2c938223701
Ref: library/imaplib imaplib IMAP4 fetch8223949
Ref: 2c948223949
Ref: library/imaplib imaplib IMAP4 getacl8224229
Ref: 2c958224229
Ref: library/imaplib imaplib IMAP4 getannotation8224383
Ref: 2c968224383
Ref: library/imaplib imaplib IMAP4 getquota8224584
Ref: 2c978224584
Ref: library/imaplib imaplib IMAP4 getquotaroot8224758
Ref: 2c988224758
Ref: library/imaplib imaplib IMAP4 list8224946
Ref: 2c998224946
Ref: library/imaplib imaplib IMAP4 login8225215
Ref: 2c9a8225215
Ref: library/imaplib imaplib IMAP4 login_cram_md58225348
Ref: 2c9b8225348
Ref: library/imaplib imaplib IMAP4 logout8225608
Ref: 2c9c8225608
Ref: library/imaplib imaplib IMAP4 lsub8225805
Ref: 2c9d8225805
Ref: library/imaplib imaplib IMAP4 myrights8226095
Ref: 2c9e8226095
Ref: library/imaplib imaplib IMAP4 namespace8226214
Ref: 2c9f8226214
Ref: library/imaplib imaplib IMAP4 noop8226303
Ref: 2ca08226303
Ref: library/imaplib imaplib IMAP4 open8226363
Ref: 2ca18226363
Ref: library/imaplib imaplib IMAP4 partial8226883
Ref: 2ca68226883
Ref: library/imaplib imaplib IMAP4 proxyauth8227060
Ref: 2ca78227060
Ref: library/imaplib imaplib IMAP4 read8227212
Ref: 2ca28227212
Ref: library/imaplib imaplib IMAP4 readline8227328
Ref: 2ca38227328
Ref: library/imaplib imaplib IMAP4 recent8227440
Ref: 2ca88227440
Ref: library/imaplib imaplib IMAP4 rename8227595
Ref: 2ca98227595
Ref: library/imaplib imaplib IMAP4 response8227703
Ref: 2caa8227703
Ref: library/imaplib imaplib IMAP4 search8227861
Ref: 2cab8227861
Ref: library/imaplib imaplib IMAP4 select8228506
Ref: 2cac8228506
Ref: library/imaplib imaplib IMAP4 send8228801
Ref: 2ca48228801
Ref: library/imaplib imaplib IMAP4 setacl8229015
Ref: 2cad8229015
Ref: library/imaplib imaplib IMAP4 setannotation8229178
Ref: 2cae8229178
Ref: library/imaplib imaplib IMAP4 setquota8229367
Ref: 2caf8229367
Ref: library/imaplib imaplib IMAP4 shutdown8229541
Ref: 2ca58229541
Ref: library/imaplib imaplib IMAP4 socket8229728
Ref: 2cb08229728
Ref: library/imaplib imaplib IMAP4 sort8229814
Ref: 2cb18229814
Ref: library/imaplib imaplib IMAP4 starttls8230758
Ref: b9d8230758
Ref: library/imaplib imaplib IMAP4 status8231285
Ref: 2cb28231285
Ref: library/imaplib imaplib IMAP4 store8231381
Ref: 2cb38231381
Ref: library/imaplib imaplib IMAP4 subscribe8232558
Ref: 2cb48232558
Ref: library/imaplib imaplib IMAP4 thread8232629
Ref: 2cb58232629
Ref: library/imaplib imaplib IMAP4 uid8233756
Ref: 2cb68233756
Ref: library/imaplib imaplib IMAP4 unsubscribe8234074
Ref: 2cb78234074
Ref: library/imaplib imaplib IMAP4 xatom8234151
Ref: 2cb88234151
Ref: library/imaplib imaplib IMAP4 PROTOCOL_VERSION8234355
Ref: 2cb98234355
Ref: library/imaplib imaplib IMAP4 debug8234490
Ref: 2cba8234490
Ref: library/imaplib imaplib IMAP4 utf8_enabled8234693
Ref: 6df8234693
Ref: IMAP4 Objects-Footnote-18234971
Ref: IMAP4 Objects-Footnote-28235020
Ref: IMAP4 Objects-Footnote-38235069
Ref: IMAP4 Objects-Footnote-48235118
Ref: IMAP4 Objects-Footnote-58235167
Ref: IMAP4 Objects-Footnote-68235216
Node: IMAP4 Example8235265
Ref: library/imaplib id28235370
Ref: 2cbb8235370
Ref: library/imaplib imap4-example8235370
Ref: 2cbc8235370
Node: nntplib — NNTP protocol client8235813
Ref: library/nntplib doc8235995
Ref: 2cbd8235995
Ref: library/nntplib module-nntplib8235995
Ref: c08235995
Ref: library/nntplib nntplib-nntp-protocol-client8235995
Ref: 2cbe8235995
Ref: library/nntplib nntplib NNTP8237729
Ref: a218237729
Ref: library/nntplib nntplib NNTP_SSL8239685
Ref: b988239685
Ref: library/nntplib nntplib NNTPError8241048
Ref: 2cc08241048
Ref: library/nntplib nntplib NNTPError response8241294
Ref: 2cc18241294
Ref: library/nntplib nntplib NNTPReplyError8241415
Ref: 2cc28241415
Ref: library/nntplib nntplib NNTPTemporaryError8241536
Ref: 2cc38241536
Ref: library/nntplib nntplib NNTPPermanentError8241664
Ref: 2cbf8241664
Ref: library/nntplib nntplib NNTPProtocolError8241792
Ref: 2cc48241792
Ref: library/nntplib nntplib NNTPDataError8241956
Ref: 2cc58241956
Ref: nntplib — NNTP protocol client-Footnote-18242170
Ref: nntplib — NNTP protocol client-Footnote-28242236
Ref: nntplib — NNTP protocol client-Footnote-38242285
Ref: nntplib — NNTP protocol client-Footnote-48242333
Ref: nntplib — NNTP protocol client-Footnote-58242382
Node: NNTP Objects8242431
Ref: library/nntplib id18242541
Ref: 2cc68242541
Ref: library/nntplib nntp-objects8242541
Ref: 2cc78242541
Node: Attributes8242749
Ref: library/nntplib attributes8242827
Ref: 2cc88242827
Ref: library/nntplib nntplib NNTP nntp_version8242870
Ref: 2cc98242870
Ref: library/nntplib nntplib NNTP nntp_implementation8243136
Ref: 2cca8243136
Ref: Attributes-Footnote-18243373
Node: Methods<3>8243422
Ref: library/nntplib methods8243500
Ref: 2ccb8243500
Ref: library/nntplib nntplib NNTP quit8244391
Ref: 2ccc8244391
Ref: library/nntplib nntplib NNTP getwelcome8244574
Ref: 2ccd8244574
Ref: library/nntplib nntplib NNTP getcapabilities8244805
Ref: 2cce8244805
Ref: library/nntplib nntplib NNTP login8245247
Ref: 2ccf8245247
Ref: library/nntplib nntplib NNTP starttls8245865
Ref: b998245865
Ref: library/nntplib nntplib NNTP newgroups8246665
Ref: 2cd08246665
Ref: library/nntplib nntplib NNTP newnews8247316
Ref: 2cd18247316
Ref: library/nntplib nntplib NNTP list8247687
Ref: 2cd28247687
Ref: library/nntplib nntplib NNTP descriptions8249023
Ref: 2cd38249023
Ref: library/nntplib nntplib NNTP description8249615
Ref: 2cd48249615
Ref: library/nntplib nntplib NNTP group8249983
Ref: 2cd58249983
Ref: library/nntplib nntplib NNTP over8250417
Ref: 2cd68250417
Ref: library/nntplib nntplib NNTP help8252479
Ref: 2cd88252479
Ref: library/nntplib nntplib NNTP stat8252633
Ref: 2cd98252633
Ref: library/nntplib nntplib NNTP next8253272
Ref: 2cda8253272
Ref: library/nntplib nntplib NNTP last8253366
Ref: 2cdb8253366
Ref: library/nntplib nntplib NNTP article8253460
Ref: 2cdc8253460
Ref: library/nntplib nntplib NNTP head8254448
Ref: 2cdd8254448
Ref: library/nntplib nntplib NNTP body8254682
Ref: 2cde8254682
Ref: library/nntplib nntplib NNTP post8254916
Ref: 2cdf8254916
Ref: library/nntplib nntplib NNTP ihave8255542
Ref: 2ce08255542
Ref: library/nntplib nntplib NNTP date8255818
Ref: 2ce18255818
Ref: library/nntplib nntplib NNTP slave8255986
Ref: 2ce28255986
Ref: library/nntplib nntplib NNTP set_debuglevel8256082
Ref: 2ce38256082
Ref: library/nntplib nntplib NNTP xhdr8256718
Ref: 2ce48256718
Ref: library/nntplib nntplib NNTP xover8257656
Ref: 2ce58257656
Ref: library/nntplib nntplib NNTP xpath8258032
Ref: 2ce68258032
Ref: Methods<3>-Footnote-18258382
Ref: Methods<3>-Footnote-28258431
Ref: Methods<3>-Footnote-38258480
Ref: Methods<3>-Footnote-48258529
Node: Utility functions<2>8258578
Ref: library/nntplib utility-functions8258688
Ref: 2ce78258688
Ref: library/nntplib nntplib decode_header8258802
Ref: 2cd78258802
Node: smtplib — SMTP protocol client8259343
Ref: library/smtplib doc8259513
Ref: 2ce88259513
Ref: library/smtplib module-smtplib8259513
Ref: ed8259513
Ref: library/smtplib smtplib-smtp-protocol-client8259513
Ref: 2ce98259513
Ref: library/smtplib smtplib SMTP8260002
Ref: a768260002
Ref: library/smtplib smtplib SMTP_SSL8262355
Ref: a778262355
Ref: library/smtplib smtplib LMTP8264046
Ref: a788264046
Ref: library/smtplib smtplib SMTPException8264878
Ref: 8ab8264878
Ref: library/smtplib smtplib SMTPServerDisconnected8265134
Ref: 2ced8265134
Ref: library/smtplib smtplib SMTPResponseException8265362
Ref: 2cee8265362
Ref: library/smtplib smtplib SMTPSenderRefused8265727
Ref: 2cef8265727
Ref: library/smtplib smtplib SMTPRecipientsRefused8265968
Ref: 2cf08265968
Ref: library/smtplib smtplib SMTPDataError8266241
Ref: 2cf18266241
Ref: library/smtplib smtplib SMTPConnectError8266337
Ref: 2ceb8266337
Ref: library/smtplib smtplib SMTPHeloError8266458
Ref: 2cf28266458
Ref: library/smtplib smtplib SMTPNotSupportedError8266545
Ref: e9e8266545
Ref: library/smtplib smtplib SMTPAuthenticationError8266687
Ref: 2cf38266687
Ref: smtplib — SMTP protocol client-Footnote-18267410
Ref: smtplib — SMTP protocol client-Footnote-28267476
Ref: smtplib — SMTP protocol client-Footnote-38267524
Ref: smtplib — SMTP protocol client-Footnote-48267573
Ref: smtplib — SMTP protocol client-Footnote-58267622
Ref: smtplib — SMTP protocol client-Footnote-68267670
Node: SMTP Objects8267719
Ref: library/smtplib id18267821
Ref: 2cf48267821
Ref: library/smtplib smtp-objects8267821
Ref: 2cf58267821
Ref: library/smtplib smtplib SMTP set_debuglevel8267925
Ref: 7378267925
Ref: library/smtplib smtplib SMTP docmd8268276
Ref: 2cf68268276
Ref: library/smtplib smtplib SMTP connect8268926
Ref: 2cea8268926
Ref: library/smtplib smtplib SMTP helo8269612
Ref: 2cf78269612
Ref: library/smtplib smtplib SMTP ehlo8270072
Ref: 2cf88270072
Ref: library/smtplib smtplib SMTP ehlo_or_helo_if_needed8270965
Ref: 2cfa8270965
Ref: library/smtplib smtplib SMTP has_extn8271307
Ref: 2cf98271307
Ref: library/smtplib smtplib SMTP verify8271502
Ref: 2cfb8271502
Ref: library/smtplib smtplib SMTP login8271921
Ref: 2cfc8271921
Ref: library/smtplib smtplib SMTP auth8273504
Ref: 7368273504
Ref: library/smtplib smtplib SMTP starttls8275747
Ref: a798275747
Ref: library/smtplib smtplib SMTP sendmail8277455
Ref: 7388277455
Ref: library/smtplib smtplib SMTP send_message8280934
Ref: 7398280934
Ref: library/smtplib smtplib SMTP quit8283002
Ref: 2cec8283002
Ref: SMTP Objects-Footnote-18283465
Ref: SMTP Objects-Footnote-28283513
Ref: SMTP Objects-Footnote-38283562
Ref: SMTP Objects-Footnote-48283611
Ref: SMTP Objects-Footnote-58283659
Ref: SMTP Objects-Footnote-68283707
Node: SMTP Example8283756
Ref: library/smtplib id28283858
Ref: 2cfd8283858
Ref: library/smtplib smtp-example8283858
Ref: 2cfe8283858
Ref: SMTP Example-Footnote-18285186
Node: smtpd — SMTP Server8285234
Ref: library/smtpd doc8285399
Ref: 2cff8285399
Ref: library/smtpd module-smtpd8285399
Ref: ec8285399
Ref: library/smtpd smtpd-smtp-server8285399
Ref: 2d008285399
Ref: smtpd — SMTP Server-Footnote-18286402
Ref: smtpd — SMTP Server-Footnote-28286466
Ref: smtpd — SMTP Server-Footnote-38286506
Ref: smtpd — SMTP Server-Footnote-48286555
Ref: smtpd — SMTP Server-Footnote-58286604
Node: SMTPServer Objects8286653
Ref: library/smtpd smtpserver-objects8286761
Ref: 2d018286761
Ref: library/smtpd smtpd SMTPServer8286820
Ref: 5f78286820
Ref: library/smtpd smtpd SMTPServer process_message8288677
Ref: 5f88288677
Ref: library/smtpd smtpd SMTPServer channel_class8290553
Ref: 2d028290553
Ref: SMTPServer Objects-Footnote-18291164
Ref: SMTPServer Objects-Footnote-28291213
Ref: SMTPServer Objects-Footnote-38291262
Ref: SMTPServer Objects-Footnote-48291311
Node: DebuggingServer Objects8291360
Ref: library/smtpd debuggingserver-objects8291494
Ref: 2d038291494
Ref: library/smtpd smtpd DebuggingServer8291563
Ref: 2d048291563
Node: PureProxy Objects8291765
Ref: library/smtpd pureproxy-objects8291901
Ref: 2d058291901
Ref: library/smtpd smtpd PureProxy8291958
Ref: 2d068291958
Node: MailmanProxy Objects8292249
Ref: library/smtpd mailmanproxy-objects8292381
Ref: 2d078292381
Ref: library/smtpd smtpd MailmanProxy8292444
Ref: 2d088292444
Node: SMTPChannel Objects8292854
Ref: library/smtpd smtpchannel-objects8292960
Ref: 2d098292960
Ref: library/smtpd smtpd SMTPChannel8293021
Ref: 5f68293021
Ref: library/smtpd smtpd SMTPChannel smtp_server8294516
Ref: 2d0a8294516
Ref: library/smtpd smtpd SMTPChannel conn8294620
Ref: 2d0b8294620
Ref: library/smtpd smtpd SMTPChannel addr8294707
Ref: 2d0c8294707
Ref: library/smtpd smtpd SMTPChannel received_lines8294842
Ref: 2d0d8294842
Ref: library/smtpd smtpd SMTPChannel smtp_state8295063
Ref: 2d0e8295063
Ref: library/smtpd smtpd SMTPChannel seen_greeting8295273
Ref: 2d0f8295273
Ref: library/smtpd smtpd SMTPChannel mailfrom8295406
Ref: 2d108295406
Ref: library/smtpd smtpd SMTPChannel rcpttos8295552
Ref: 2d118295552
Ref: library/smtpd smtpd SMTPChannel received_data8295707
Ref: 2d128295707
Ref: library/smtpd smtpd SMTPChannel fqdn8295916
Ref: 2d138295916
Ref: library/smtpd smtpd SMTPChannel peer8296060
Ref: 2d148296060
Ref: SMTPChannel Objects-Footnote-18298516
Ref: SMTPChannel Objects-Footnote-28298565
Node: telnetlib — Telnet client8298614
Ref: library/telnetlib doc8298790
Ref: 2d158298790
Ref: library/telnetlib module-telnetlib8298790
Ref: 1028298790
Ref: library/telnetlib telnetlib-telnet-client8298790
Ref: 2d168298790
Ref: library/telnetlib telnetlib Telnet8299792
Ref: 58c8299792
Ref: telnetlib — Telnet client-Footnote-18301312
Ref: telnetlib — Telnet client-Footnote-28301380
Ref: telnetlib — Telnet client-Footnote-38301428
Node: Telnet Objects8301476
Ref: library/telnetlib id18301577
Ref: 2d198301577
Ref: library/telnetlib telnet-objects8301577
Ref: 2d1a8301577
Ref: library/telnetlib telnetlib Telnet read_until8301686
Ref: 2d1b8301686
Ref: library/telnetlib telnetlib Telnet read_all8302041
Ref: 2d1c8302041
Ref: library/telnetlib telnetlib Telnet read_some8302144
Ref: 2d1d8302144
Ref: library/telnetlib telnetlib Telnet read_very_eager8302322
Ref: 2d1e8302322
Ref: library/telnetlib telnetlib Telnet read_eager8302633
Ref: 2d1f8302633
Ref: library/telnetlib telnetlib Telnet read_lazy8302907
Ref: 2d208302907
Ref: library/telnetlib telnetlib Telnet read_very_lazy8303198
Ref: 2d218303198
Ref: library/telnetlib telnetlib Telnet read_sb_data8303471
Ref: 2d228303471
Ref: library/telnetlib telnetlib Telnet open8303704
Ref: 2d178303704
Ref: library/telnetlib telnetlib Telnet msg8304271
Ref: 2d238304271
Ref: library/telnetlib telnetlib Telnet set_debuglevel8304497
Ref: 2d248304497
Ref: library/telnetlib telnetlib Telnet close8304669
Ref: 2d188304669
Ref: library/telnetlib telnetlib Telnet get_socket8304726
Ref: 2d258304726
Ref: library/telnetlib telnetlib Telnet fileno8304808
Ref: 2d268304808
Ref: library/telnetlib telnetlib Telnet write8304909
Ref: 2d278304909
Ref: library/telnetlib telnetlib Telnet interact8305379
Ref: 2d288305379
Ref: library/telnetlib telnetlib Telnet mt_interact8305475
Ref: 2d298305475
Ref: library/telnetlib telnetlib Telnet expect8305565
Ref: 2d2a8305565
Ref: library/telnetlib telnetlib Telnet set_option_negotiation_callback8306571
Ref: 2d2b8306571
Node: Telnet Example8306886
Ref: library/telnetlib id28306987
Ref: 2d2c8306987
Ref: library/telnetlib telnet-example8306987
Ref: 2d2d8306987
Node: uuid — UUID objects according to RFC 41228307478
Ref: library/uuid doc8307681
Ref: 2d2e8307681
Ref: library/uuid module-uuid8307681
Ref: 1248307681
Ref: library/uuid uuid-uuid-objects-according-to-rfc-41228307681
Ref: 2d2f8307681
Ref: library/uuid uuid SafeUUID8308797
Ref: 2d338308797
Ref: library/uuid uuid SafeUUID safe8308849
Ref: 2d348308849
Ref: library/uuid uuid SafeUUID unsafe8308966
Ref: 2d358308966
Ref: library/uuid uuid SafeUUID unknown8309063
Ref: 2d368309063
Ref: library/uuid uuid UUID8309204
Ref: 25e8309204
Ref: library/uuid uuid UUID bytes8311095
Ref: 2d388311095
Ref: library/uuid uuid UUID bytes_le8311224
Ref: 2d398311224
Ref: library/uuid uuid UUID fields8311376
Ref: 2d3a8311376
Ref: library/uuid uuid UUID hex8312936
Ref: 2d3b8312936
Ref: library/uuid uuid UUID int8313014
Ref: 2d378313014
Ref: library/uuid uuid UUID urn8313076
Ref: 2d3c8313076
Ref: library/uuid uuid UUID variant8313154
Ref: 2d3d8313154
Ref: library/uuid uuid UUID version8313418
Ref: 2d428313418
Ref: library/uuid uuid UUID is_safe8313556
Ref: 4068313556
Ref: library/uuid uuid getnode8313811
Ref: 4078313811
Ref: library/uuid uuid uuid18314781
Ref: 4088314781
Ref: library/uuid uuid uuid38315133
Ref: 2d308315133
Ref: library/uuid uuid uuid48315302
Ref: 2d318315302
Ref: library/uuid uuid uuid58315361
Ref: 2d328315361
Ref: library/uuid uuid NAMESPACE_DNS8315663
Ref: 2d438315663
Ref: library/uuid uuid NAMESPACE_URL8315790
Ref: 2d448315790
Ref: library/uuid uuid NAMESPACE_OID8315888
Ref: 2d458315888
Ref: library/uuid uuid NAMESPACE_X5008315991
Ref: 2d468315991
Ref: library/uuid uuid RESERVED_NCS8316249
Ref: 2d3e8316249
Ref: library/uuid uuid RFC_41228316316
Ref: 2d3f8316316
Ref: library/uuid uuid RESERVED_MICROSOFT8316395
Ref: 2d408316395
Ref: library/uuid uuid RESERVED_FUTURE8316474
Ref: 2d418316474
Ref: uuid — UUID objects according to RFC 4122-Footnote-18316852
Ref: uuid — UUID objects according to RFC 4122-Footnote-28316915
Ref: uuid — UUID objects according to RFC 4122-Footnote-38316964
Ref: uuid — UUID objects according to RFC 4122-Footnote-48317013
Ref: uuid — UUID objects according to RFC 4122-Footnote-58317062
Ref: uuid — UUID objects according to RFC 4122-Footnote-68317111
Ref: uuid — UUID objects according to RFC 4122-Footnote-78317160
Node: Example<13>8317209
Ref: library/uuid example8317300
Ref: 2d478317300
Ref: library/uuid uuid-example8317300
Ref: 2d488317300
Node: socketserver — A framework for network servers8318444
Ref: library/socketserver doc8318648
Ref: 2d498318648
Ref: library/socketserver module-socketserver8318648
Ref: f08318648
Ref: library/socketserver socketserver-a-framework-for-network-servers8318648
Ref: 2d4a8318648
Ref: library/socketserver socketserver TCPServer8319007
Ref: 2d4b8319007
Ref: library/socketserver socketserver UDPServer8319478
Ref: 2d4e8319478
Ref: library/socketserver socketserver UnixStreamServer8319781
Ref: 2d4f8319781
Ref: library/socketserver socketserver UnixDatagramServer8319894
Ref: 2d508319894
Ref: socketserver — A framework for network servers-Footnote-18322247
Node: Server Creation Notes8322318
Ref: library/socketserver server-creation-notes8322450
Ref: 2d558322450
Ref: library/socketserver socketserver ForkingMixIn8323224
Ref: 3ca8323224
Ref: library/socketserver socketserver ThreadingMixIn8323261
Ref: 3cb8323261
Ref: library/socketserver socketserver ForkingTCPServer8324741
Ref: 2d578324741
Ref: library/socketserver socketserver ForkingUDPServer8324782
Ref: 2d588324782
Ref: library/socketserver socketserver ThreadingTCPServer8324823
Ref: 2d598324823
Ref: library/socketserver socketserver ThreadingUDPServer8324866
Ref: 2d568324866
Node: Server Objects<2>8327157
Ref: library/socketserver server-objects8327321
Ref: 2d5b8327321
Ref: library/socketserver socketserver BaseServer8327372
Ref: a7e8327372
Ref: library/socketserver socketserver BaseServer fileno8327771
Ref: 2d5e8327771
Ref: library/socketserver socketserver BaseServer handle_request8328044
Ref: 2d538328044
Ref: library/socketserver socketserver BaseServer serve_forever8328646
Ref: a808328646
Ref: library/socketserver socketserver BaseServer service_actions8329296
Ref: a7f8329296
Ref: library/socketserver socketserver BaseServer shutdown8329596
Ref: f558329596
Ref: library/socketserver socketserver BaseServer server_close8329721
Ref: 2d548329721
Ref: library/socketserver socketserver BaseServer address_family8329807
Ref: 2d648329807
Ref: library/socketserver socketserver BaseServer RequestHandlerClass8330018
Ref: 2d5d8330018
Ref: library/socketserver socketserver BaseServer server_address8330176
Ref: 2d5c8330176
Ref: library/socketserver socketserver BaseServer socket8330599
Ref: 2d658330599
Ref: library/socketserver socketserver BaseServer allow_reuse_address8330785
Ref: 2d668330785
Ref: library/socketserver socketserver BaseServer request_queue_size8330999
Ref: 2d678330999
Ref: library/socketserver socketserver BaseServer socket_type8331490
Ref: 2d688331490
Ref: library/socketserver socketserver BaseServer timeout8331681
Ref: 2d628331681
Ref: library/socketserver socketserver BaseServer finish_request8332187
Ref: 2d698332187
Ref: library/socketserver socketserver BaseServer get_request8332404
Ref: 2d5f8332404
Ref: library/socketserver socketserver BaseServer handle_error8332634
Ref: 5f28332634
Ref: library/socketserver socketserver BaseServer handle_timeout8333086
Ref: 2d638333086
Ref: library/socketserver socketserver BaseServer process_request8333525
Ref: 2d618333525
Ref: library/socketserver socketserver BaseServer server_activate8333896
Ref: 2d4d8333896
Ref: library/socketserver socketserver BaseServer server_bind8334143
Ref: 2d4c8334143
Ref: library/socketserver socketserver BaseServer verify_request8334297
Ref: 2d608334297
Node: Request Handler Objects8334882
Ref: library/socketserver request-handler-objects8335037
Ref: 2d6a8335037
Ref: library/socketserver socketserver BaseRequestHandler8335106
Ref: 2d518335106
Ref: library/socketserver socketserver BaseRequestHandler setup8335460
Ref: 2d6b8335460
Ref: library/socketserver socketserver BaseRequestHandler handle8335655
Ref: 2d528335655
Ref: library/socketserver socketserver BaseRequestHandler finish8336359
Ref: 2d6c8336359
Ref: library/socketserver socketserver StreamRequestHandler8336638
Ref: 57c8336638
Ref: library/socketserver socketserver DatagramRequestHandler8336683
Ref: 2d5a8336683
Node: Examples<23>8337447
Ref: library/socketserver examples8337576
Ref: 2d6d8337576
Node: socketserver TCPServer Example8337781
Ref: library/socketserver socketserver-tcpserver-example8337899
Ref: 2d6e8337899
Node: socketserver UDPServer Example8340800
Ref: library/socketserver socketserver-udpserver-example8340946
Ref: 2d6f8340946
Node: Asynchronous Mixins8342423
Ref: library/socketserver asynchronous-mixins8342530
Ref: 2d708342530
Node: http server — HTTP servers8344691
Ref: library/http server doc8344890
Ref: 2d718344890
Ref: library/http server http-server-http-servers8344890
Ref: 2d728344890
Ref: library/http server module-http server8344890
Ref: 978344890
Ref: library/http server http server HTTPServer8345685
Ref: 2b408345685
Ref: library/http server http server ThreadingHTTPServer8346040
Ref: 38b8346040
Ref: library/http server http server BaseHTTPRequestHandler8346588
Ref: a038346588
Ref: library/http server http server BaseHTTPRequestHandler client_address8347578
Ref: 2d738347578
Ref: library/http server http server BaseHTTPRequestHandler server8347720
Ref: 2d748347720
Ref: library/http server http server BaseHTTPRequestHandler close_connection8347789
Ref: 2d758347789
Ref: library/http server http server BaseHTTPRequestHandler requestline8348024
Ref: 2d778348024
Ref: library/http server http server BaseHTTPRequestHandler command8348339
Ref: 2d788348339
Ref: library/http server http server BaseHTTPRequestHandler path8348443
Ref: 2d798348443
Ref: library/http server http server BaseHTTPRequestHandler request_version8348507
Ref: 2d7a8348507
Ref: library/http server http server BaseHTTPRequestHandler headers8348643
Ref: 2c1f8348643
Ref: library/http server http server BaseHTTPRequestHandler rfile8349069
Ref: 2d7c8349069
Ref: library/http server http server BaseHTTPRequestHandler wfile8349221
Ref: 2d7d8349221
Ref: library/http server http server BaseHTTPRequestHandler server_version8349669
Ref: 2d7e8349669
Ref: library/http server http server BaseHTTPRequestHandler sys_version8349956
Ref: 2d7f8349956
Ref: library/http server http server BaseHTTPRequestHandler error_message_format8350211
Ref: 2d818350211
Ref: library/http server http server BaseHTTPRequestHandler error_content_type8350572
Ref: 2d828350572
Ref: library/http server http server BaseHTTPRequestHandler protocol_version8350752
Ref: 2d838350752
Ref: library/http server http server BaseHTTPRequestHandler MessageClass8351215
Ref: 2d7b8351215
Ref: library/http server http server BaseHTTPRequestHandler responses8351447
Ref: 2c0c8351447
Ref: library/http server http server BaseHTTPRequestHandler handle8352012
Ref: 2d868352012
Ref: library/http server http server BaseHTTPRequestHandler handle_one_request8352312
Ref: 2d768352312
Ref: library/http server http server BaseHTTPRequestHandler handle_expect_1008352510
Ref: 2d878352510
Ref: library/http server http server BaseHTTPRequestHandler send_error8353016
Ref: 8508353016
Ref: library/http server http server BaseHTTPRequestHandler send_response8354144
Ref: 2d888354144
Ref: library/http server http server BaseHTTPRequestHandler send_header8354960
Ref: 2d848354960
Ref: library/http server http server BaseHTTPRequestHandler send_response_only8355540
Ref: 2d858355540
Ref: library/http server http server BaseHTTPRequestHandler end_headers8355960
Ref: a048355960
Ref: library/http server http server BaseHTTPRequestHandler flush_headers8356259
Ref: a058356259
Ref: library/http server http server BaseHTTPRequestHandler log_request8356431
Ref: 2d8a8356431
Ref: library/http server http server BaseHTTPRequestHandler log_error8356728
Ref: 2d8b8356728
Ref: library/http server http server BaseHTTPRequestHandler log_message8356973
Ref: 2d8c8356973
Ref: library/http server http server BaseHTTPRequestHandler version_string8357462
Ref: 2d808357462
Ref: library/http server http server BaseHTTPRequestHandler date_time_string8357676
Ref: 2d898357676
Ref: library/http server http server BaseHTTPRequestHandler log_date_time_string8358064
Ref: 2d8d8358064
Ref: library/http server http server BaseHTTPRequestHandler address_string8358175
Ref: 2d8e8358175
Ref: library/http server http server SimpleHTTPRequestHandler8358418
Ref: 38a8358418
Ref: library/http server http server SimpleHTTPRequestHandler server_version8358975
Ref: 2d918358975
Ref: library/http server http server SimpleHTTPRequestHandler extensions_map8359136
Ref: 2d928359136
Ref: library/http server http server SimpleHTTPRequestHandler directory8359458
Ref: 2d938359458
Ref: library/http server http server SimpleHTTPRequestHandler do_HEAD8359674
Ref: 2d908359674
Ref: library/http server http server SimpleHTTPRequestHandler do_GET8359962
Ref: 2d8f8359962
Ref: library/http server http-server-cli8362359
Ref: 8518362359
Ref: library/http server http server CGIHTTPRequestHandler8363370
Ref: 2d948363370
Ref: library/http server http server CGIHTTPRequestHandler cgi_directories8364561
Ref: 2d958364561
Ref: library/http server http server CGIHTTPRequestHandler do_POST8364807
Ref: 2d968364807
Ref: http server — HTTP servers-Footnote-18365384
Ref: http server — HTTP servers-Footnote-28365454
Node: http cookies — HTTP state management8365503
Ref: library/http cookies doc8365705
Ref: 2d978365705
Ref: library/http cookies http-cookies-http-state-management8365705
Ref: 2d988365705
Ref: library/http cookies module-http cookies8365705
Ref: 968365705
Ref: library/http cookies http cookies CookieError8367067
Ref: 2d998367067
Ref: library/http cookies http cookies BaseCookie8367234
Ref: 2d9a8367234
Ref: library/http cookies http cookies SimpleCookie8367623
Ref: f708367623
Ref: http cookies — HTTP state management-Footnote-18368453
Ref: http cookies — HTTP state management-Footnote-28368524
Ref: http cookies — HTTP state management-Footnote-38368573
Ref: http cookies — HTTP state management-Footnote-48368622
Ref: http cookies — HTTP state management-Footnote-58368671
Node: Cookie Objects8368720
Ref: library/http cookies cookie-objects8368832
Ref: 2d9c8368832
Ref: library/http cookies id18368832
Ref: 2d9d8368832
Ref: library/http cookies http cookies BaseCookie value_decode8368883
Ref: 2d9e8368883
Ref: library/http cookies http cookies BaseCookie value_encode8369155
Ref: 2d9f8369155
Ref: library/http cookies http cookies BaseCookie output8369607
Ref: 2da08369607
Ref: library/http cookies http cookies BaseCookie js_output8369975
Ref: 2da18369975
Ref: library/http cookies http cookies BaseCookie load8370254
Ref: 2d9b8370254
Node: Morsel Objects8370526
Ref: library/http cookies id28370658
Ref: 2da28370658
Ref: library/http cookies morsel-objects8370658
Ref: 2da38370658
Ref: library/http cookies http cookies Morsel8370709
Ref: 4858370709
Ref: library/http cookies http cookies Morsel value8372061
Ref: 4838372061
Ref: library/http cookies http cookies Morsel coded_value8372121
Ref: 4848372121
Ref: library/http cookies http cookies Morsel key8372227
Ref: 4828372227
Ref: library/http cookies http cookies Morsel set8372284
Ref: 4868372284
Ref: library/http cookies http cookies Morsel isReservedKey8372393
Ref: 2da48372393
Ref: library/http cookies http cookies Morsel output8372504
Ref: 2da58372504
Ref: library/http cookies http cookies Morsel js_output8372844
Ref: 2da68372844
Ref: library/http cookies http cookies Morsel OutputString8373118
Ref: 2da78373118
Ref: library/http cookies http cookies Morsel update8373330
Ref: 7b88373330
Ref: library/http cookies http cookies Morsel copy8373630
Ref: 7b78373630
Ref: library/http cookies http cookies Morsel setdefault8373785
Ref: 2da88373785
Ref: Morsel Objects-Footnote-18374000
Ref: Morsel Objects-Footnote-28374049
Ref: Morsel Objects-Footnote-38374098
Ref: Morsel Objects-Footnote-48374147
Node: Example<14>8374196
Ref: library/http cookies cookie-example8374305
Ref: 2da98374305
Ref: library/http cookies example8374305
Ref: 2daa8374305
Node: http cookiejar — Cookie handling for HTTP clients8375737
Ref: library/http cookiejar doc8375954
Ref: 2dab8375954
Ref: library/http cookiejar http-cookiejar-cookie-handling-for-http-clients8375954
Ref: 2dac8375954
Ref: library/http cookiejar module-http cookiejar8375954
Ref: 958375954
Ref: library/http cookiejar http cookiejar LoadError8377522
Ref: 2dad8377522
Ref: library/http cookiejar http cookiejar CookieJar8377897
Ref: 2bb08377897
Ref: library/http cookiejar http cookiejar FileCookieJar8378373
Ref: 2dae8378373
Ref: library/http cookiejar http cookiejar CookiePolicy8379117
Ref: 2daf8379117
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy8379277
Ref: f228379277
Ref: library/http cookiejar http cookiejar Cookie8381098
Ref: 2db48381098
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-18382798
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-28382871
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-38382920
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-48382969
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-58383018
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-68383067
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-78383116
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-88383165
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-98383214
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-108383263
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-118383313
Ref: http cookiejar — Cookie handling for HTTP clients-Footnote-128383363
Node: CookieJar and FileCookieJar Objects8383413
Ref: library/http cookiejar cookie-jar-objects8383604
Ref: 2db58383604
Ref: library/http cookiejar cookiejar-and-filecookiejar-objects8383604
Ref: 2db68383604
Ref: library/http cookiejar http cookiejar CookieJar add_cookie_header8383880
Ref: 2db78383880
Ref: library/http cookiejar http cookiejar CookieJar extract_cookies8384798
Ref: 2db88384798
Ref: library/http cookiejar http cookiejar CookieJar set_policy8386033
Ref: 2dba8386033
Ref: library/http cookiejar http cookiejar CookieJar make_cookies8386137
Ref: 2dbb8386137
Ref: library/http cookiejar http cookiejar CookieJar set_cookie_if_ok8386424
Ref: 2dbc8386424
Ref: library/http cookiejar http cookiejar CookieJar set_cookie8386549
Ref: 2dbd8386549
Ref: library/http cookiejar http cookiejar CookieJar clear8386698
Ref: 2dbe8386698
Ref: library/http cookiejar http cookiejar CookieJar clear_session_cookies8387203
Ref: 2dbf8387203
Ref: library/http cookiejar http cookiejar FileCookieJar save8387846
Ref: 2dc08387846
Ref: library/http cookiejar http cookiejar FileCookieJar load8388699
Ref: 2db08388699
Ref: library/http cookiejar http cookiejar FileCookieJar revert8389266
Ref: 2db18389266
Ref: library/http cookiejar http cookiejar FileCookieJar filename8389665
Ref: 2dc18389665
Ref: library/http cookiejar http cookiejar FileCookieJar delayload8389802
Ref: 2dc28389802
Node: FileCookieJar subclasses and co-operation with web browsers8390223
Ref: library/http cookiejar file-cookie-jar-classes8390443
Ref: 2db28390443
Ref: library/http cookiejar filecookiejar-subclasses-and-co-operation-with-web-browsers8390443
Ref: 2dc38390443
Ref: library/http cookiejar http cookiejar MozillaCookieJar8390671
Ref: 2dc48390671
Ref: library/http cookiejar http cookiejar LWPCookieJar8391468
Ref: 2dc58391468
Ref: FileCookieJar subclasses and co-operation with web browsers-Footnote-18391946
Node: CookiePolicy Objects8391995
Ref: library/http cookiejar cookie-policy-objects8392207
Ref: 2dc68392207
Ref: library/http cookiejar cookiepolicy-objects8392207
Ref: 2dc78392207
Ref: library/http cookiejar http cookiejar CookiePolicy set_ok8392360
Ref: 2db98392360
Ref: library/http cookiejar http cookiejar CookiePolicy return_ok8392686
Ref: 2dc88392686
Ref: library/http cookiejar http cookiejar CookiePolicy domain_return_ok8393015
Ref: 2dc98393015
Ref: library/http cookiejar http cookiejar CookiePolicy path_return_ok8394393
Ref: 2dca8394393
Ref: library/http cookiejar http cookiejar CookiePolicy netscape8394845
Ref: 2dcb8394845
Ref: library/http cookiejar http cookiejar CookiePolicy rfc29658394918
Ref: 2dcc8394918
Ref: library/http cookiejar http cookiejar CookiePolicy hide_cookie28394993
Ref: 2dcd8394993
Ref: CookiePolicy Objects-Footnote-18395543
Ref: CookiePolicy Objects-Footnote-28395592
Node: DefaultCookiePolicy Objects8395641
Ref: library/http cookiejar default-cookie-policy-objects8395811
Ref: 2dce8395811
Ref: library/http cookiejar defaultcookiepolicy-objects8395811
Ref: 2dcf8395811
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy blocked_domains8398093
Ref: 2dd08398093
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy set_blocked_domains8398204
Ref: 2dd18398204
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy is_blocked8398318
Ref: 2dd28398318
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy allowed_domains8398460
Ref: 2dd38398460
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy set_allowed_domains8398596
Ref: 2dd48398596
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy is_not_allowed8398730
Ref: 2dd58398730
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy rfc2109_as_netscape8399063
Ref: 2db38399063
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy strict_domain8399650
Ref: 2dd68399650
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy strict_rfc2965_unverifiable8399954
Ref: 2dd78399954
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_unverifiable8400332
Ref: 2dd88400332
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_domain8400481
Ref: 2dd98400481
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_initial_dollar8400662
Ref: 2dda8400662
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_path8400817
Ref: 2ddb8400817
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNoDots8401141
Ref: 2ddc8401141
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNonDomain8401386
Ref: 2ddd8401386
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy DomainRFC2965Match8401734
Ref: 2dde8401734
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy DomainLiberal8401971
Ref: 2ddf8401971
Ref: library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrict8402119
Ref: 2de08402119
Ref: DefaultCookiePolicy Objects-Footnote-18402272
Ref: DefaultCookiePolicy Objects-Footnote-28402321
Ref: DefaultCookiePolicy Objects-Footnote-38402370
Ref: DefaultCookiePolicy Objects-Footnote-48402419
Ref: DefaultCookiePolicy Objects-Footnote-58402468
Ref: DefaultCookiePolicy Objects-Footnote-68402517
Ref: DefaultCookiePolicy Objects-Footnote-78402566
Node: Cookie Objects<2>8402615
Ref: library/http cookiejar cookie-objects8402777
Ref: 2de18402777
Ref: library/http cookiejar http cookiejar Cookie version8403546
Ref: 2de28403546
Ref: library/http cookiejar http cookiejar Cookie name8403904
Ref: 2de38403904
Ref: library/http cookiejar http cookiejar Cookie value8403962
Ref: 2de48403962
Ref: library/http cookiejar http cookiejar Cookie port8404042
Ref: 2de58404042
Ref: library/http cookiejar http cookiejar Cookie path8404181
Ref: 2de68404181
Ref: library/http cookiejar http cookiejar Cookie secure8404276
Ref: 2de78404276
Ref: library/http cookiejar http cookiejar Cookie expires8404383
Ref: 2de88404383
Ref: library/http cookiejar http cookiejar Cookie discard8404536
Ref: 2dea8404536
Ref: library/http cookiejar http cookiejar Cookie comment8404613
Ref: 2deb8404613
Ref: library/http cookiejar http cookiejar Cookie comment_url8404746
Ref: 2dec8404746
Ref: library/http cookiejar http cookiejar Cookie rfc21098404893
Ref: 2ded8404893
Ref: library/http cookiejar http cookiejar Cookie port_specified8405303
Ref: 2dee8405303
Ref: library/http cookiejar http cookiejar Cookie domain_specified8405482
Ref: 2def8405482
Ref: library/http cookiejar http cookiejar Cookie domain_initial_dot8405591
Ref: 2df08405591
Ref: library/http cookiejar http cookiejar Cookie has_nonstandard_attr8405847
Ref: 2df18405847
Ref: library/http cookiejar http cookiejar Cookie get_nonstandard_attr8405961
Ref: 2df28405961
Ref: library/http cookiejar http cookiejar Cookie set_nonstandard_attr8406123
Ref: 2df38406123
Ref: library/http cookiejar http cookiejar Cookie is_expired8406295
Ref: 2de98406295
Ref: Cookie Objects<2>-Footnote-18406588
Ref: Cookie Objects<2>-Footnote-28406637
Ref: Cookie Objects<2>-Footnote-38406686
Ref: Cookie Objects<2>-Footnote-48406735
Node: Examples<24>8406784
Ref: library/http cookiejar examples8406910
Ref: 2df48406910
Ref: Examples<24>-Footnote-18408292
Node: xmlrpc — XMLRPC server and client modules8408341
Ref: library/xmlrpc doc8408559
Ref: 2df58408559
Ref: library/xmlrpc xmlrpc-xmlrpc-server-and-client-modules8408559
Ref: 2df68408559
Node: xmlrpc client — XML-RPC client access8409061
Ref: library/xmlrpc client doc8409267
Ref: 2df78409267
Ref: library/xmlrpc client module-xmlrpc client8409267
Ref: 13f8409267
Ref: library/xmlrpc client xmlrpc-client-xml-rpc-client-access8409267
Ref: 2df88409267
Ref: library/xmlrpc client xmlrpc client ServerProxy8410200
Ref: 2538410200
Ref: xmlrpc client — XML-RPC client access-Footnote-18418019
Ref: xmlrpc client — XML-RPC client access-Footnote-28418091
Ref: xmlrpc client — XML-RPC client access-Footnote-38418185
Ref: xmlrpc client — XML-RPC client access-Footnote-48418244
Ref: xmlrpc client — XML-RPC client access-Footnote-58418303
Ref: xmlrpc client — XML-RPC client access-Footnote-68418349
Node: ServerProxy Objects8418398
Ref: library/xmlrpc client id18418518
Ref: 2dfd8418518
Ref: library/xmlrpc client serverproxy-objects8418518
Ref: 2dfe8418518
Ref: library/xmlrpc client xmlrpc client ServerProxy system listMethods8419174
Ref: 2dff8419174
Ref: library/xmlrpc client xmlrpc client ServerProxy system methodSignature8419337
Ref: 2e008419337
Ref: library/xmlrpc client xmlrpc client ServerProxy system methodHelp8420361
Ref: 2e018420361
Node: DateTime Objects8421391
Ref: library/xmlrpc client datetime-objects8421534
Ref: 2e028421534
Ref: library/xmlrpc client id28421534
Ref: 2e038421534
Ref: library/xmlrpc client xmlrpc client DateTime8421589
Ref: 2df98421589
Ref: library/xmlrpc client xmlrpc client DateTime decode8421898
Ref: 2e048421898
Ref: library/xmlrpc client xmlrpc client DateTime encode8421995
Ref: 2e058421995
Node: Binary Objects8422992
Ref: library/xmlrpc client binary-objects8423129
Ref: 2e068423129
Ref: library/xmlrpc client id38423129
Ref: 2e078423129
Ref: library/xmlrpc client xmlrpc client Binary8423180
Ref: 2dfa8423180
Ref: library/xmlrpc client xmlrpc client Binary data8423397
Ref: 2e088423397
Ref: library/xmlrpc client xmlrpc client Binary decode8423703
Ref: 2e098423703
Ref: library/xmlrpc client xmlrpc client Binary encode8423842
Ref: 2e0a8423842
Ref: Binary Objects-Footnote-18425030
Node: Fault Objects8425091
Ref: library/xmlrpc client fault-objects8425233
Ref: 2e0b8425233
Ref: library/xmlrpc client id48425233
Ref: 2e0c8425233
Ref: library/xmlrpc client xmlrpc client Fault8425282
Ref: 2dfb8425282
Ref: library/xmlrpc client xmlrpc client Fault faultCode8425449
Ref: 2e0d8425449
Ref: library/xmlrpc client xmlrpc client Fault faultString8425527
Ref: 2e0e8425527
Node: ProtocolError Objects8426414
Ref: library/xmlrpc client protocol-error-objects8426559
Ref: 2e0f8426559
Ref: library/xmlrpc client protocolerror-objects8426559
Ref: 2e108426559
Ref: library/xmlrpc client xmlrpc client ProtocolError8426624
Ref: 2dfc8426624
Ref: library/xmlrpc client xmlrpc client ProtocolError url8426901
Ref: 2e118426901
Ref: library/xmlrpc client xmlrpc client ProtocolError errcode8426978
Ref: 2e128426978
Ref: library/xmlrpc client xmlrpc client ProtocolError errmsg8427034
Ref: 2e138427034
Ref: library/xmlrpc client xmlrpc client ProtocolError headers8427113
Ref: 2e148427113
Node: MultiCall Objects8427803
Ref: library/xmlrpc client multicall-objects8427956
Ref: 2e158427956
Ref: library/xmlrpc client xmlrpc client MultiCall8428139
Ref: 2e168428139
Ref: MultiCall Objects-Footnote-18429719
Node: Convenience Functions8429902
Ref: library/xmlrpc client convenience-functions8430057
Ref: 2e178430057
Ref: library/xmlrpc client xmlrpc client dumps8430122
Ref: 2e188430122
Ref: library/xmlrpc client xmlrpc client loads8430835
Ref: 2e198430835
Node: Example of Client Usage8431703
Ref: library/xmlrpc client example-of-client-usage8431875
Ref: 2e1a8431875
Ref: library/xmlrpc client xmlrpc-client-example8431875
Ref: 2e1b8431875
Node: Example of Client and Server Usage8433072
Ref: library/xmlrpc client example-of-client-and-server-usage8433214
Ref: 2e1c8433214
Node: xmlrpc server — Basic XML-RPC servers8433350
Ref: library/xmlrpc server doc8433557
Ref: 2e1e8433557
Ref: library/xmlrpc server module-xmlrpc server8433557
Ref: 1408433557
Ref: library/xmlrpc server xmlrpc-server-basic-xml-rpc-servers8433557
Ref: 2e1f8433557
Ref: library/xmlrpc server xmlrpc server SimpleXMLRPCServer8434239
Ref: 2e208434239
Ref: library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler8435763
Ref: 2e218435763
Ref: library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler8436414
Ref: 2e228436414
Ref: xmlrpc server — Basic XML-RPC servers-Footnote-18436902
Node: SimpleXMLRPCServer Objects8436974
Ref: library/xmlrpc server simple-xmlrpc-servers8437108
Ref: 2e238437108
Ref: library/xmlrpc server simplexmlrpcserver-objects8437108
Ref: 2e248437108
Ref: library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_function8437344
Ref: 2e258437344
Ref: library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_instance8438087
Ref: 2e268438087
Ref: library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_introspection_functions8439703
Ref: 2e278439703
Ref: library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_multicall_functions8439912
Ref: 2e288439912
Ref: library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler rpc_paths8440041
Ref: 2e298440041
Node: SimpleXMLRPCServer Example8440461
Ref: library/xmlrpc server id18440550
Ref: 2e2a8440550
Ref: library/xmlrpc server simplexmlrpcserver-example8440550
Ref: 2e1d8440550
Node: CGIXMLRPCRequestHandler8444667
Ref: library/xmlrpc server cgixmlrpcrequesthandler8444835
Ref: 2e2b8444835
Ref: library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_function8445019
Ref: 2e2c8445019
Ref: library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_instance8445767
Ref: 2e2d8445767
Ref: library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_introspection_functions8446652
Ref: 2e2e8446652
Ref: library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_multicall_functions8446865
Ref: 2e2f8446865
Ref: library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler handle_request8447004
Ref: 2e308447004
Node: Documenting XMLRPC server8447551
Ref: library/xmlrpc server documenting-xmlrpc-server8447716
Ref: 2e318447716
Ref: library/xmlrpc server xmlrpc server DocXMLRPCServer8448043
Ref: ea88448043
Ref: library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler8448521
Ref: 2e328448521
Ref: library/xmlrpc server xmlrpc server DocXMLRPCRequestHandler8448656
Ref: 2e338448656
Node: DocXMLRPCServer Objects8448974
Ref: library/xmlrpc server doc-xmlrpc-servers8449142
Ref: 2e348449142
Ref: library/xmlrpc server docxmlrpcserver-objects8449142
Ref: 2e358449142
Ref: library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_title8449578
Ref: 2e368449578
Ref: library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_name8449768
Ref: 2e378449768
Ref: library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_documentation8449990
Ref: 2e388449990
Node: DocCGIXMLRPCRequestHandler8450246
Ref: library/xmlrpc server doccgixmlrpcrequesthandler8450380
Ref: 2e398450380
Ref: library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_title8450831
Ref: 2e3a8450831
Ref: library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_name8451032
Ref: 2e3b8451032
Ref: library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_documentation8451265
Ref: 2e3c8451265
Node: ipaddress — IPv4/IPv6 manipulation library8451532
Ref: library/ipaddress doc8451691
Ref: 2e3d8451691
Ref: library/ipaddress ipaddress-ipv4-ipv6-manipulation-library8451691
Ref: 2e3e8451691
Ref: library/ipaddress module-ipaddress8451691
Ref: a28451691
Ref: ipaddress — IPv4/IPv6 manipulation library-Footnote-18452714
Node: Convenience factory functions8452782
Ref: library/ipaddress convenience-factory-functions8452913
Ref: 2e408452913
Ref: library/ipaddress ipaddress ip_address8453116
Ref: 2e418453116
Ref: library/ipaddress ipaddress ip_network8453667
Ref: 2e448453667
Ref: library/ipaddress ipaddress ip_interface8454366
Ref: 2e458454366
Node: IP Addresses8455219
Ref: library/ipaddress ip-addresses8455381
Ref: 2e488455381
Node: Address objects8455524
Ref: library/ipaddress address-objects8455631
Ref: 2e498455631
Ref: library/ipaddress ipaddress IPv4Address8456074
Ref: 2e428456074
Ref: library/ipaddress ipaddress IPv4Address version8457088
Ref: 2e4b8457088
Ref: library/ipaddress ipaddress IPv4Address max_prefixlen8457196
Ref: 2e4c8457196
Ref: library/ipaddress ipaddress IPv4Address compressed8457534
Ref: 2e4d8457534
Ref: library/ipaddress ipaddress IPv4Address exploded8457566
Ref: 2e4e8457566
Ref: library/ipaddress ipaddress IPv4Address packed8458055
Ref: 2e4f8458055
Ref: library/ipaddress ipaddress IPv4Address reverse_pointer8458292
Ref: 2e508458292
Ref: library/ipaddress ipaddress IPv4Address is_multicast8458792
Ref: 2e518458792
Ref: library/ipaddress ipaddress IPv4Address is_private8458959
Ref: 2e528458959
Ref: library/ipaddress ipaddress IPv4Address is_global8459174
Ref: 8608459174
Ref: library/ipaddress ipaddress IPv4Address is_unspecified8459418
Ref: 2e538459418
Ref: library/ipaddress ipaddress IPv4Address is_reserved8459572
Ref: 2e548459572
Ref: library/ipaddress ipaddress IPv4Address is_loopback8459670
Ref: 2e558459670
Ref: library/ipaddress ipaddress IPv4Address is_link_local8459822
Ref: 2e568459822
Ref: library/ipaddress ipaddress IPv6Address8459957
Ref: 2e438459957
Ref: library/ipaddress ipaddress IPv6Address compressed8460875
Ref: 2e578460875
Ref: library/ipaddress ipaddress IPv6Address exploded8461184
Ref: 2e588461184
Ref: library/ipaddress ipaddress IPv6Address packed8461461
Ref: 2e598461461
Ref: library/ipaddress ipaddress IPv6Address reverse_pointer8461489
Ref: 2e5a8461489
Ref: library/ipaddress ipaddress IPv6Address version8461526
Ref: 2e5b8461526
Ref: library/ipaddress ipaddress IPv6Address max_prefixlen8461555
Ref: 2e5c8461555
Ref: library/ipaddress ipaddress IPv6Address is_multicast8461590
Ref: 2e5d8461590
Ref: library/ipaddress ipaddress IPv6Address is_private8461624
Ref: 2e5e8461624
Ref: library/ipaddress ipaddress IPv6Address is_global8461656
Ref: 2e5f8461656
Ref: library/ipaddress ipaddress IPv6Address is_unspecified8461687
Ref: 2e608461687
Ref: library/ipaddress ipaddress IPv6Address is_reserved8461723
Ref: 2e618461723
Ref: library/ipaddress ipaddress IPv6Address is_loopback8461756
Ref: 2e628461756
Ref: library/ipaddress ipaddress IPv6Address is_link_local8461789
Ref: 2e638461789
Ref: library/ipaddress ipaddress IPv6Address is_site_local8461865
Ref: 2e648461865
Ref: library/ipaddress ipaddress IPv6Address ipv4_mapped8462211
Ref: 2e658462211
Ref: library/ipaddress ipaddress IPv6Address sixtofour8462483
Ref: 2e668462483
Ref: library/ipaddress ipaddress IPv6Address teredo8462773
Ref: 2e678462773
Ref: Address objects-Footnote-18463123
Ref: Address objects-Footnote-28463172
Ref: Address objects-Footnote-38463221
Ref: Address objects-Footnote-48463323
Ref: Address objects-Footnote-58463425
Ref: Address objects-Footnote-68463527
Ref: Address objects-Footnote-78463629
Ref: Address objects-Footnote-88463678
Ref: Address objects-Footnote-98463727
Ref: Address objects-Footnote-108463776
Ref: Address objects-Footnote-118463826
Ref: Address objects-Footnote-128463876
Ref: Address objects-Footnote-138463926
Ref: Address objects-Footnote-148463976
Ref: Address objects-Footnote-158464026
Ref: Address objects-Footnote-168464076
Node: Conversion to Strings and Integers8464126
Ref: library/ipaddress conversion-to-strings-and-integers8464254
Ref: 2e688464254
Node: Operators<3>8464761
Ref: library/ipaddress operators8464865
Ref: 2e698464865
Node: Comparison operators8465130
Ref: library/ipaddress comparison-operators8465228
Ref: 2e6a8465228
Node: Arithmetic operators8465576
Ref: library/ipaddress arithmetic-operators8465674
Ref: 2e6b8465674
Node: IP Network definitions8466142
Ref: library/ipaddress ip-network-definitions8466292
Ref: 2e6c8466292
Node: Prefix net mask and host mask8467002
Ref: library/ipaddress prefix-net-mask-and-host-mask8467114
Ref: 2e6d8467114
Node: Network objects8467784
Ref: library/ipaddress network-objects8467917
Ref: 2e6e8467917
Ref: library/ipaddress ipaddress IPv4Network8468376
Ref: 3958468376
Ref: library/ipaddress ipaddress IPv4Network version8470799
Ref: 2e708470799
Ref: library/ipaddress ipaddress IPv4Network max_prefixlen8470828
Ref: 2e718470828
Ref: library/ipaddress ipaddress IPv4Network is_multicast8470963
Ref: 2e728470963
Ref: library/ipaddress ipaddress IPv4Network is_private8470997
Ref: 2e738470997
Ref: library/ipaddress ipaddress IPv4Network is_unspecified8471029
Ref: 2e748471029
Ref: library/ipaddress ipaddress IPv4Network is_reserved8471065
Ref: 2e758471065
Ref: library/ipaddress ipaddress IPv4Network is_loopback8471098
Ref: 2e768471098
Ref: library/ipaddress ipaddress IPv4Network is_link_local8471131
Ref: 2e778471131
Ref: library/ipaddress ipaddress IPv4Network network_address8471323
Ref: 2e788471323
Ref: library/ipaddress ipaddress IPv4Network broadcast_address8471497
Ref: 2e798471497
Ref: library/ipaddress ipaddress IPv4Network hostmask8471694
Ref: 2e7a8471694
Ref: library/ipaddress ipaddress IPv4Network netmask8471789
Ref: 2e7b8471789
Ref: library/ipaddress ipaddress IPv4Network with_prefixlen8471882
Ref: 2e7c8471882
Ref: library/ipaddress ipaddress IPv4Network compressed8471918
Ref: 2e7d8471918
Ref: library/ipaddress ipaddress IPv4Network exploded8471950
Ref: 2e7e8471950
Ref: library/ipaddress ipaddress IPv4Network with_netmask8472251
Ref: 2e7f8472251
Ref: library/ipaddress ipaddress IPv4Network with_hostmask8472382
Ref: 2e808472382
Ref: library/ipaddress ipaddress IPv4Network num_addresses8472515
Ref: 2e818472515
Ref: library/ipaddress ipaddress IPv4Network prefixlen8472607
Ref: 2e828472607
Ref: library/ipaddress ipaddress IPv4Network hosts8472688
Ref: 2e838472688
Ref: library/ipaddress ipaddress IPv4Network overlaps8473448
Ref: 2e848473448
Ref: library/ipaddress ipaddress IPv4Network address_exclude8473620
Ref: 2e858473620
Ref: library/ipaddress ipaddress IPv4Network subnets8474199
Ref: 78b8474199
Ref: library/ipaddress ipaddress IPv4Network supernet8475603
Ref: 78c8475603
Ref: library/ipaddress ipaddress IPv4Network subnet_of8476334
Ref: 2e868476334
Ref: library/ipaddress ipaddress IPv4Network supernet_of8476586
Ref: 2e878476586
Ref: library/ipaddress ipaddress IPv4Network compare_networks8476844
Ref: 2e888476844
Ref: library/ipaddress ipaddress IPv6Network8477467
Ref: 3948477467
Ref: library/ipaddress ipaddress IPv6Network version8479271
Ref: 2e898479271
Ref: library/ipaddress ipaddress IPv6Network max_prefixlen8479300
Ref: 2e8a8479300
Ref: library/ipaddress ipaddress IPv6Network is_multicast8479335
Ref: 2e8b8479335
Ref: library/ipaddress ipaddress IPv6Network is_private8479369
Ref: 2e8c8479369
Ref: library/ipaddress ipaddress IPv6Network is_unspecified8479401
Ref: 2e8d8479401
Ref: library/ipaddress ipaddress IPv6Network is_reserved8479437
Ref: 2e8e8479437
Ref: library/ipaddress ipaddress IPv6Network is_loopback8479470
Ref: 2e8f8479470
Ref: library/ipaddress ipaddress IPv6Network is_link_local8479503
Ref: 2e908479503
Ref: library/ipaddress ipaddress IPv6Network network_address8479538
Ref: 2e918479538
Ref: library/ipaddress ipaddress IPv6Network broadcast_address8479575
Ref: 2e928479575
Ref: library/ipaddress ipaddress IPv6Network hostmask8479614
Ref: 2e938479614
Ref: library/ipaddress ipaddress IPv6Network netmask8479644
Ref: 2e948479644
Ref: library/ipaddress ipaddress IPv6Network with_prefixlen8479673
Ref: 2e958479673
Ref: library/ipaddress ipaddress IPv6Network compressed8479709
Ref: 2e968479709
Ref: library/ipaddress ipaddress IPv6Network exploded8479741
Ref: 2e978479741
Ref: library/ipaddress ipaddress IPv6Network with_netmask8479771
Ref: 2e988479771
Ref: library/ipaddress ipaddress IPv6Network with_hostmask8479805
Ref: 2e998479805
Ref: library/ipaddress ipaddress IPv6Network num_addresses8479840
Ref: 2e9a8479840
Ref: library/ipaddress ipaddress IPv6Network prefixlen8479875
Ref: 2e9b8479875
Ref: library/ipaddress ipaddress IPv6Network hosts8479906
Ref: 2e9c8479906
Ref: library/ipaddress ipaddress IPv6Network overlaps8480262
Ref: 2e9d8480262
Ref: library/ipaddress ipaddress IPv6Network address_exclude8480297
Ref: 2e9e8480297
Ref: library/ipaddress ipaddress IPv6Network subnets8480341
Ref: 2e9f8480341
Ref: library/ipaddress ipaddress IPv6Network supernet8480403
Ref: 2ea08480403
Ref: library/ipaddress ipaddress IPv6Network subnet_of8480466
Ref: 2ea18480466
Ref: library/ipaddress ipaddress IPv6Network supernet_of8480502
Ref: 2ea28480502
Ref: library/ipaddress ipaddress IPv6Network compare_networks8480540
Ref: 2ea38480540
Ref: library/ipaddress ipaddress IPv6Network is_site_local8480682
Ref: 2ea48480682
Node: Operators<4>8480859
Ref: library/ipaddress id18480954
Ref: 2ea58480954
Node: Logical operators8481260
Ref: library/ipaddress logical-operators8481347
Ref: 2ea68481347
Node: Iteration<2>8481552
Ref: library/ipaddress iteration8481683
Ref: 2ea78481683
Node: Networks as containers of addresses8482421
Ref: library/ipaddress networks-as-containers-of-addresses8482526
Ref: 2ea88482526
Node: Interface objects8482949
Ref: library/ipaddress interface-objects8483115
Ref: 2ea98483115
Ref: library/ipaddress ipaddress IPv4Interface8483264
Ref: 2e468483264
Ref: library/ipaddress ipaddress IPv4Interface ip8483681
Ref: 2eaa8483681
Ref: library/ipaddress ipaddress IPv4Interface network8483898
Ref: 2eab8483898
Ref: library/ipaddress ipaddress IPv4Interface with_prefixlen8484125
Ref: 2eac8484125
Ref: library/ipaddress ipaddress IPv4Interface with_netmask8484363
Ref: 2ead8484363
Ref: library/ipaddress ipaddress IPv4Interface with_hostmask8484606
Ref: 2eae8484606
Ref: library/ipaddress ipaddress IPv6Interface8484848
Ref: 2e478484848
Ref: library/ipaddress ipaddress IPv6Interface ip8485265
Ref: 2eaf8485265
Ref: library/ipaddress ipaddress IPv6Interface network8485289
Ref: 2eb08485289
Ref: library/ipaddress ipaddress IPv6Interface with_prefixlen8485318
Ref: 2eb18485318
Ref: library/ipaddress ipaddress IPv6Interface with_netmask8485354
Ref: 2eb28485354
Ref: library/ipaddress ipaddress IPv6Interface with_hostmask8485388
Ref: 2eb38485388
Node: Operators<5>8485562
Ref: library/ipaddress id28485628
Ref: 2eb48485628
Node: Logical operators<2>8485890
Ref: library/ipaddress id38485959
Ref: 2eb58485959
Node: Other Module Level Functions8486616
Ref: library/ipaddress other-module-level-functions8486777
Ref: 2eb68486777
Ref: library/ipaddress ipaddress v4_int_to_packed8486922
Ref: 2eb78486922
Ref: library/ipaddress ipaddress v6_int_to_packed8487366
Ref: 2eb88487366
Ref: library/ipaddress ipaddress summarize_address_range8487675
Ref: 78d8487675
Ref: library/ipaddress ipaddress collapse_addresses8488528
Ref: 78e8488528
Ref: library/ipaddress ipaddress get_mixed_type_key8489066
Ref: 2eb98489066
Node: Custom Exceptions8489665
Ref: library/ipaddress custom-exceptions8489800
Ref: 2eba8489800
Ref: library/ipaddress ipaddress AddressValueError8489971
Ref: 2e4a8489971
Ref: library/ipaddress ipaddress NetmaskValueError8490074
Ref: 2e6f8490074
Node: Multimedia Services8490178
Ref: library/mm doc8490329
Ref: 2ebb8490329
Ref: library/mm mmedia8490329
Ref: 2ebc8490329
Ref: library/mm multimedia-services8490329
Ref: 2ebd8490329
Node: audioop — Manipulate raw audio data8491012
Ref: library/audioop doc8491157
Ref: 2ebe8491157
Ref: library/audioop audioop-manipulate-raw-audio-data8491157
Ref: 2ebf8491157
Ref: library/audioop module-audioop8491157
Ref: d8491157
Ref: library/audioop audioop error8492055
Ref: 2ec08492055
Ref: library/audioop audioop add8492185
Ref: 2ec18492185
Ref: library/audioop audioop adpcm2lin8492516
Ref: 2ec28492516
Ref: library/audioop audioop alaw2lin8492835
Ref: 2ec48492835
Ref: library/audioop audioop avg8493096
Ref: 2ec58493096
Ref: library/audioop audioop avgpp8493200
Ref: 2ec68493200
Ref: library/audioop audioop bias8493406
Ref: 2ec78493406
Ref: library/audioop audioop byteswap8493593
Ref: 8168493593
Ref: library/audioop audioop cross8493823
Ref: 2ec88493823
Ref: library/audioop audioop findfactor8493956
Ref: 2ec98493956
Ref: library/audioop audioop findfit8494367
Ref: 2eca8494367
Ref: library/audioop audioop findmax8494977
Ref: 2ecb8494977
Ref: library/audioop audioop getsample8495334
Ref: 2ecc8495334
Ref: library/audioop audioop lin2adpcm8495452
Ref: 2ec38495452
Ref: library/audioop audioop lin2alaw8496191
Ref: 2ecd8496191
Ref: library/audioop audioop lin2lin8496515
Ref: 2ece8496515
Ref: library/audioop audioop lin2ulaw8497128
Ref: 2ecf8497128
Ref: library/audioop audioop max8497452
Ref: 2ed08497452
Ref: library/audioop audioop maxpp8497581
Ref: 2ed18497581
Ref: library/audioop audioop minmax8497692
Ref: 2ed28497692
Ref: library/audioop audioop mul8497849
Ref: 2ed38497849
Ref: library/audioop audioop ratecv8498075
Ref: 2ed48498075
Ref: library/audioop audioop reverse8498653
Ref: 2ed58498653
Ref: library/audioop audioop rms8498782
Ref: 2ed68498782
Ref: library/audioop audioop tomono8498971
Ref: 2ed78498971
Ref: library/audioop audioop tostereo8499233
Ref: 2ed88499233
Ref: library/audioop audioop ulaw2lin8499548
Ref: 2ed98499548
Node: aifc — Read and write AIFF and AIFC files8502193
Ref: library/aifc doc8502384
Ref: 2eda8502384
Ref: library/aifc aifc-read-and-write-aiff-and-aifc-files8502384
Ref: 2edb8502384
Ref: library/aifc module-aifc8502384
Ref: 58502384
Ref: library/aifc aifc open8503655
Ref: 4508503655
Ref: library/aifc aifc aifc getnchannels8504714
Ref: 2edc8504714
Ref: library/aifc aifc aifc getsampwidth8504818
Ref: 2edd8504818
Ref: library/aifc aifc aifc getframerate8504906
Ref: 2ede8504906
Ref: library/aifc aifc aifc getnframes8505008
Ref: 2edf8505008
Ref: library/aifc aifc aifc getcomptype8505093
Ref: 2ee08505093
Ref: library/aifc aifc aifc getcompname8505288
Ref: 2ee18505288
Ref: library/aifc aifc aifc getparams8505517
Ref: 80f8505517
Ref: library/aifc aifc aifc getmarkers8505719
Ref: 2ee28505719
Ref: library/aifc aifc aifc getmark8506038
Ref: 2ee38506038
Ref: library/aifc aifc aifc readframes8506173
Ref: 2ee48506173
Ref: library/aifc aifc aifc rewind8506390
Ref: 2ee58506390
Ref: library/aifc aifc aifc setpos8506521
Ref: 2ee68506521
Ref: library/aifc aifc aifc tell8506594
Ref: 2ee78506594
Ref: library/aifc aifc aifc close8506659
Ref: 8108506659
Ref: library/aifc aifc aifc aiff8507211
Ref: 2ee88507211
Ref: library/aifc aifc aifc aifc8507415
Ref: 2ee98507415
Ref: library/aifc aifc aifc setnchannels8507621
Ref: 2eea8507621
Ref: library/aifc aifc aifc setsampwidth8507720
Ref: 2eeb8507720
Ref: library/aifc aifc aifc setframerate8507809
Ref: 2eec8507809
Ref: library/aifc aifc aifc setnframes8507906
Ref: 2eed8507906
Ref: library/aifc aifc aifc setcomptype8508120
Ref: 2eee8508120
Ref: library/aifc aifc aifc setparams8508607
Ref: 2eef8508607
Ref: library/aifc aifc aifc setmark8508945
Ref: 2ef08508945
Ref: library/aifc aifc aifc writeframes8509299
Ref: 8128509299
Ref: library/aifc aifc aifc writeframesraw8509543
Ref: 8118509543
Ref: aifc — Read and write AIFF and AIFC files-Footnote-18510011
Node: sunau — Read and write Sun AU files8510074
Ref: library/sunau doc8510261
Ref: 2ef18510261
Ref: library/sunau module-sunau8510261
Ref: fa8510261
Ref: library/sunau sunau-read-and-write-sun-au-files8510261
Ref: 2ef28510261
Ref: library/sunau sunau open8511807
Ref: 4678511807
Ref: library/sunau sunau openfp8512262
Ref: 4668512262
Ref: library/sunau sunau Error8512517
Ref: 2ef38512517
Ref: library/sunau sunau AUDIO_FILE_MAGIC8512718
Ref: 2ef48512718
Ref: library/sunau sunau AUDIO_FILE_ENCODING_MULAW_88512901
Ref: 2ef58512901
Ref: library/sunau sunau AUDIO_FILE_ENCODING_LINEAR_88512945
Ref: 2ef68512945
Ref: library/sunau sunau AUDIO_FILE_ENCODING_LINEAR_168512990
Ref: 2ef78512990
Ref: library/sunau sunau AUDIO_FILE_ENCODING_LINEAR_248513036
Ref: 2ef88513036
Ref: library/sunau sunau AUDIO_FILE_ENCODING_LINEAR_328513082
Ref: 2ef98513082
Ref: library/sunau sunau AUDIO_FILE_ENCODING_ALAW_88513128
Ref: 2efa8513128
Ref: library/sunau sunau AUDIO_FILE_ENCODING_FLOAT8513267
Ref: 2efb8513267
Ref: library/sunau sunau AUDIO_FILE_ENCODING_DOUBLE8513309
Ref: 2efc8513309
Ref: library/sunau sunau AUDIO_FILE_ENCODING_ADPCM_G7218513352
Ref: 2efd8513352
Ref: library/sunau sunau AUDIO_FILE_ENCODING_ADPCM_G7228513399
Ref: 2efe8513399
Ref: library/sunau sunau AUDIO_FILE_ENCODING_ADPCM_G723_38513446
Ref: 2eff8513446
Ref: library/sunau sunau AUDIO_FILE_ENCODING_ADPCM_G723_58513495
Ref: 2f008513495
Ref: sunau — Read and write Sun AU files-Footnote-18513753
Node: AU_read Objects8513817
Ref: library/sunau au-read-objects8513931
Ref: 2f018513931
Ref: library/sunau id18513931
Ref: 2f028513931
Ref: library/sunau sunau AU_read close8514069
Ref: 2f038514069
Ref: library/sunau sunau AU_read getnchannels8514205
Ref: 2f048514205
Ref: library/sunau sunau AU_read getsampwidth8514309
Ref: 2f058514309
Ref: library/sunau sunau AU_read getframerate8514383
Ref: 2f068514383
Ref: library/sunau sunau AU_read getnframes8514454
Ref: 2f078514454
Ref: library/sunau sunau AU_read getcomptype8514527
Ref: 2f088514527
Ref: library/sunau sunau AU_read getcompname8514678
Ref: 2f098514678
Ref: library/sunau sunau AU_read getparams8514911
Ref: 2f0a8514911
Ref: library/sunau sunau AU_read readframes8515116
Ref: 2f0b8515116
Ref: library/sunau sunau AU_read rewind8515355
Ref: 2f0c8515355
Ref: library/sunau sunau AU_read setpos8515587
Ref: 2f0d8515587
Ref: library/sunau sunau AU_read tell8515753
Ref: 2f0e8515753
Ref: library/sunau sunau AU_read getmarkers8516037
Ref: 2f0f8516037
Ref: library/sunau sunau AU_read getmark8516098
Ref: 2f108516098
Node: AU_write Objects8516154
Ref: library/sunau au-write-objects8516268
Ref: 2f118516268
Ref: library/sunau id28516268
Ref: 2f128516268
Ref: library/sunau sunau AU_write setnchannels8516409
Ref: 2f138516409
Ref: library/sunau sunau AU_write setsampwidth8516482
Ref: 8d28516482
Ref: library/sunau sunau AU_write setframerate8516624
Ref: 2f148516624
Ref: library/sunau sunau AU_write setnframes8516689
Ref: 2f158516689
Ref: library/sunau sunau AU_write setcomptype8516828
Ref: 2f168516828
Ref: library/sunau sunau AU_write setparams8516989
Ref: 2f178516989
Ref: library/sunau sunau AU_write tell8517205
Ref: 2f188517205
Ref: library/sunau sunau AU_write writeframesraw8517392
Ref: 8d38517392
Ref: library/sunau sunau AU_write writeframes8517578
Ref: 8d48517578
Ref: library/sunau sunau AU_write close8517766
Ref: 2f198517766
Node: wave — Read and write WAV files8518006
Ref: library/wave doc8518181
Ref: 2f1a8518181
Ref: library/wave module-wave8518181
Ref: 1278518181
Ref: library/wave wave-read-and-write-wav-files8518181
Ref: 2f1b8518181
Ref: library/wave wave open8518611
Ref: 46b8518611
Ref: library/wave wave openfp8519662
Ref: 46a8519662
Ref: library/wave wave Error8519854
Ref: 2f1e8519854
Ref: wave — Read and write WAV files-Footnote-18520108
Node: Wave_read Objects8520171
Ref: library/wave id18520285
Ref: 2f1f8520285
Ref: library/wave wave-read-objects8520285
Ref: 2f208520285
Ref: library/wave wave Wave_read close8520422
Ref: 2f1c8520422
Ref: library/wave wave Wave_read getnchannels8520608
Ref: 2f218520608
Ref: library/wave wave Wave_read getsampwidth8520726
Ref: 2f228520726
Ref: library/wave wave Wave_read getframerate8520802
Ref: 2f238520802
Ref: library/wave wave Wave_read getnframes8520875
Ref: 2f248520875
Ref: library/wave wave Wave_read getcomptype8520950
Ref: 2f258520950
Ref: library/wave wave Wave_read getcompname8521062
Ref: 2f268521062
Ref: library/wave wave Wave_read getparams8521220
Ref: 2f278521220
Ref: library/wave wave Wave_read readframes8521427
Ref: 2f288521427
Ref: library/wave wave Wave_read rewind8521554
Ref: 2f298521554
Ref: library/wave wave Wave_read getmarkers8521781
Ref: 2f2a8521781
Ref: library/wave wave Wave_read getmark8521844
Ref: 2f2b8521844
Ref: library/wave wave Wave_read setpos8522035
Ref: 2f2c8522035
Ref: library/wave wave Wave_read tell8522125
Ref: 2f2d8522125
Node: Wave_write Objects8522200
Ref: library/wave id28522314
Ref: 2f2e8522314
Ref: library/wave wave-write-objects8522314
Ref: 8ff8522314
Ref: library/wave wave Wave_write close8523255
Ref: 2f1d8523255
Ref: library/wave wave Wave_write setnchannels8523576
Ref: 2f318523576
Ref: library/wave wave Wave_write setsampwidth8523651
Ref: 2f328523651
Ref: library/wave wave Wave_write setframerate8523733
Ref: 2f338523733
Ref: library/wave wave Wave_write setnframes8523913
Ref: 2f2f8523913
Ref: library/wave wave Wave_write setcomptype8524163
Ref: 2f348524163
Ref: library/wave wave Wave_write setparams8524352
Ref: 2f308524352
Ref: library/wave wave Wave_write tell8524571
Ref: 2f358524571
Ref: library/wave wave Wave_write writeframesraw8524764
Ref: 9008524764
Ref: library/wave wave Wave_write writeframes8524952
Ref: 9018524952
Node: chunk — Read IFF chunked data8525525
Ref: library/chunk doc8525709
Ref: 2f368525709
Ref: library/chunk chunk-read-iff-chunked-data8525709
Ref: 2f378525709
Ref: library/chunk module-chunk8525709
Ref: 188525709
Ref: library/chunk chunk Chunk8527539
Ref: 2f388527539
Ref: library/chunk chunk Chunk getname8528671
Ref: 2f398528671
Ref: library/chunk chunk Chunk getsize8528798
Ref: 2f3a8528798
Ref: library/chunk chunk Chunk close8528869
Ref: 2f3b8528869
Ref: library/chunk chunk Chunk isatty8529233
Ref: 2f3c8529233
Ref: library/chunk chunk Chunk seek8529293
Ref: 2f3d8529293
Ref: library/chunk chunk Chunk tell8529735
Ref: 2f3e8529735
Ref: library/chunk chunk Chunk read8529816
Ref: 2f3f8529816
Ref: library/chunk chunk Chunk skip8530196
Ref: 2f408530196
Ref: chunk — Read IFF chunked data-Footnote-18530550
Ref: chunk — Read IFF chunked data-Footnote-28530614
Node: colorsys — Conversions between color systems8530728
Ref: library/colorsys doc8530920
Ref: 2f418530920
Ref: library/colorsys colorsys-conversions-between-color-systems8530920
Ref: 2f428530920
Ref: library/colorsys module-colorsys8530920
Ref: 208530920
Ref: library/colorsys colorsys rgb_to_yiq8531906
Ref: 2f438531906
Ref: library/colorsys colorsys yiq_to_rgb8532016
Ref: 2f448532016
Ref: library/colorsys colorsys rgb_to_hls8532126
Ref: 2f458532126
Ref: library/colorsys colorsys hls_to_rgb8532236
Ref: 2f468532236
Ref: library/colorsys colorsys rgb_to_hsv8532346
Ref: 2f478532346
Ref: library/colorsys colorsys hsv_to_rgb8532456
Ref: 2f488532456
Ref: colorsys — Conversions between color systems-Footnote-18532748
Node: imghdr — Determine the type of an image8532815
Ref: library/imghdr doc8533015
Ref: 2f498533015
Ref: library/imghdr imghdr-determine-the-type-of-an-image8533015
Ref: 2f4a8533015
Ref: library/imghdr module-imghdr8533015
Ref: 998533015
Ref: library/imghdr imghdr what8533378
Ref: 6e18533378
Ref: library/imghdr imghdr tests8535099
Ref: 2f4b8535099
Ref: imghdr — Determine the type of an image-Footnote-18535607
Node: sndhdr — Determine type of sound file8535672
Ref: library/sndhdr doc8535880
Ref: 2f4c8535880
Ref: library/sndhdr module-sndhdr8535880
Ref: ee8535880
Ref: library/sndhdr sndhdr-determine-type-of-sound-file8535880
Ref: 2f4d8535880
Ref: library/sndhdr sndhdr what8537124
Ref: 73b8537124
Ref: library/sndhdr sndhdr whathdr8537442
Ref: 73c8537442
Ref: sndhdr — Determine type of sound file-Footnote-18537825
Node: ossaudiodev — Access to OSS-compatible audio devices8537890
Ref: library/ossaudiodev doc8538048
Ref: 2f4e8538048
Ref: library/ossaudiodev module-ossaudiodev8538048
Ref: c68538048
Ref: library/ossaudiodev ossaudiodev-access-to-oss-compatible-audio-devices8538048
Ref: 2f4f8538048
Ref: library/ossaudiodev ossaudiodev OSSAudioError8538933
Ref: 2f508538933
Ref: library/ossaudiodev ossaudiodev open8539452
Ref: 2f518539452
Ref: library/ossaudiodev ossaudiodev openmixer8540851
Ref: 2f528540851
Ref: ossaudiodev — Access to OSS-compatible audio devices-Footnote-18541289
Node: Audio Device Objects8541337
Ref: library/ossaudiodev audio-device-objects8541477
Ref: 2f538541477
Ref: library/ossaudiodev ossaudio-device-objects8541477
Ref: 2f548541477
Ref: library/ossaudiodev ossaudiodev oss_audio_device close8542069
Ref: 2f558542069
Ref: library/ossaudiodev ossaudiodev oss_audio_device fileno8542293
Ref: 2f568542293
Ref: library/ossaudiodev ossaudiodev oss_audio_device read8542394
Ref: 2f578542394
Ref: library/ossaudiodev ossaudiodev oss_audio_device write8542702
Ref: 2f588542702
Ref: library/ossaudiodev ossaudiodev oss_audio_device writeall8543222
Ref: 2f598543222
Ref: library/ossaudiodev ossaudiodev oss_audio_device nonblock8544384
Ref: 2f5a8544384
Ref: library/ossaudiodev ossaudiodev oss_audio_device getfmts8544551
Ref: 2f5b8544551
Ref: library/ossaudiodev ossaudiodev oss_audio_device setfmt8546721
Ref: 2f5c8546721
Ref: library/ossaudiodev ossaudiodev oss_audio_device channels8547092
Ref: 2f5d8547092
Ref: library/ossaudiodev ossaudiodev oss_audio_device speed8547420
Ref: 2f5e8547420
Ref: library/ossaudiodev ossaudiodev oss_audio_device sync8548165
Ref: 2f5f8548165
Ref: library/ossaudiodev ossaudiodev oss_audio_device reset8548448
Ref: 2f608548448
Ref: library/ossaudiodev ossaudiodev oss_audio_device post8548712
Ref: 2f618548712
Ref: library/ossaudiodev ossaudiodev oss_audio_device setparameters8549125
Ref: 2f628549125
Ref: library/ossaudiodev ossaudiodev oss_audio_device bufsize8550168
Ref: 2f638550168
Ref: library/ossaudiodev ossaudiodev oss_audio_device obufcount8550268
Ref: 2f648550268
Ref: library/ossaudiodev ossaudiodev oss_audio_device obuffree8550402
Ref: 2f658550402
Ref: library/ossaudiodev ossaudiodev oss_audio_device closed8550627
Ref: 2f668550627
Ref: library/ossaudiodev ossaudiodev oss_audio_device name8550728
Ref: 2f678550728
Ref: library/ossaudiodev ossaudiodev oss_audio_device mode8550819
Ref: 2f688550819
Node: Mixer Device Objects8550934
Ref: library/ossaudiodev id18551074
Ref: 2f698551074
Ref: library/ossaudiodev mixer-device-objects8551074
Ref: 2f6a8551074
Ref: library/ossaudiodev ossaudiodev oss_mixer_device close8551185
Ref: 2f6b8551185
Ref: library/ossaudiodev ossaudiodev oss_mixer_device fileno8551386
Ref: 2f6c8551386
Ref: library/ossaudiodev ossaudiodev oss_mixer_device controls8551632
Ref: 2f6d8551632
Ref: library/ossaudiodev ossaudiodev oss_mixer_device stereocontrols8552580
Ref: 2f6e8552580
Ref: library/ossaudiodev ossaudiodev oss_mixer_device reccontrols8553025
Ref: 2f6f8553025
Ref: library/ossaudiodev ossaudiodev oss_mixer_device get8553254
Ref: 2f708553254
Ref: library/ossaudiodev ossaudiodev oss_mixer_device set8553749
Ref: 2f718553749
Ref: library/ossaudiodev ossaudiodev oss_mixer_device get_recsrc8554312
Ref: 2f728554312
Ref: library/ossaudiodev ossaudiodev oss_mixer_device set_recsrc8554473
Ref: 2f738554473
Node: Internationalization8554870
Ref: library/i18n doc8555009
Ref: 2f748555009
Ref: library/i18n i18n8555009
Ref: 2f758555009
Ref: library/i18n internationalization8555009
Ref: 2f768555009
Node: gettext — Multilingual internationalization services8555464
Ref: library/gettext doc8555624
Ref: 2f778555624
Ref: library/gettext gettext-multilingual-internationalization-services8555624
Ref: 2f788555624
Ref: library/gettext module-gettext8555624
Ref: 898555624
Ref: gettext — Multilingual internationalization services-Footnote-18556601
Node: GNU gettext API8556667
Ref: library/gettext gnu-gettext-api8556797
Ref: 2f798556797
Ref: library/gettext gettext bindtextdomain8557341
Ref: 2f7a8557341
Ref: library/gettext gettext bind_textdomain_codeset8557913
Ref: 2958557913
Ref: library/gettext gettext textdomain8558339
Ref: 2f7c8558339
Ref: library/gettext gettext gettext8558585
Ref: dc08558585
Ref: library/gettext gettext dgettext8558854
Ref: 2f7d8558854
Ref: library/gettext gettext ngettext8558993
Ref: 2f7e8558993
Ref: library/gettext gettext dngettext8559703
Ref: 2f7f8559703
Ref: library/gettext gettext pgettext8559857
Ref: 1cd8559857
Ref: library/gettext gettext dpgettext8559908
Ref: 2f808559908
Ref: library/gettext gettext npgettext8559968
Ref: 2f818559968
Ref: library/gettext gettext dnpgettext8560032
Ref: 2f828560032
Ref: library/gettext gettext lgettext8560397
Ref: 2918560397
Ref: library/gettext gettext ldgettext8560439
Ref: 2928560439
Ref: library/gettext gettext lngettext8560490
Ref: 2938560490
Ref: library/gettext gettext ldngettext8560545
Ref: 2948560545
Ref: GNU gettext API-Footnote-18561965
Ref: GNU gettext API-Footnote-28562444
Node: Class-based API8562509
Ref: library/gettext class-based-api8562692
Ref: 2f838562692
Ref: library/gettext gettext find8563222
Ref: 2f858563222
Ref: library/gettext gettext translation8564670
Ref: 2988564670
Ref: library/gettext gettext install8566106
Ref: 2998566106
Ref: Class-based API-Footnote-18567201
Node: The NullTranslations class8567271
Ref: library/gettext the-nulltranslations-class8567383
Ref: 2f8a8567383
Ref: library/gettext gettext NullTranslations8567828
Ref: 2f888567828
Ref: library/gettext gettext NullTranslations _parse8568227
Ref: 2f8c8568227
Ref: library/gettext gettext NullTranslations add_fallback8568538
Ref: 2f8b8568538
Ref: library/gettext gettext NullTranslations gettext8568801
Ref: 2f8d8568801
Ref: library/gettext gettext NullTranslations ngettext8568999
Ref: 2f8e8568999
Ref: library/gettext gettext NullTranslations pgettext8569251
Ref: 2f8f8569251
Ref: library/gettext gettext NullTranslations npgettext8569509
Ref: 2f908569509
Ref: library/gettext gettext NullTranslations lgettext8569782
Ref: 2f868569782
Ref: library/gettext gettext NullTranslations lngettext8569819
Ref: 2f878569819
Ref: library/gettext gettext NullTranslations info8570395
Ref: 2f918570395
Ref: library/gettext gettext NullTranslations charset8570563
Ref: 2f928570563
Ref: library/gettext gettext NullTranslations output_charset8570652
Ref: 2968570652
Ref: library/gettext gettext NullTranslations set_output_charset8570894
Ref: 2978570894
Ref: library/gettext gettext NullTranslations install8571082
Ref: 2f898571082
Node: The GNUTranslations class8572291
Ref: library/gettext the-gnutranslations-class8572443
Ref: 2f938572443
Ref: library/gettext gettext GNUTranslations8573953
Ref: 2f848573953
Ref: library/gettext gettext GNUTranslations gettext8574073
Ref: 2f948574073
Ref: library/gettext gettext GNUTranslations ngettext8574482
Ref: 2f958574482
Ref: library/gettext gettext GNUTranslations pgettext8575331
Ref: 2f968575331
Ref: library/gettext gettext GNUTranslations npgettext8575807
Ref: 2f978575807
Ref: library/gettext gettext GNUTranslations lgettext8576418
Ref: 2f988576418
Ref: library/gettext gettext GNUTranslations lngettext8576455
Ref: 2f998576455
Ref: The GNUTranslations class-Footnote-18577025
Node: Solaris message catalog support8577073
Ref: library/gettext solaris-message-catalog-support8577222
Ref: 2f9a8577222
Node: The Catalog constructor8577471
Ref: library/gettext the-catalog-constructor8577586
Ref: 2f9b8577586
Node: Internationalizing your programs and modules8578229
Ref: library/gettext internationalizing-your-programs-and-modules8578416
Ref: 2f9c8578416
Ref: Internationalizing your programs and modules-Footnote-18581979
Ref: Internationalizing your programs and modules-Footnote-28582011
Node: Localizing your module8582054
Ref: library/gettext localizing-your-module8582193
Ref: 2f9d8582193
Node: Localizing your application8582778
Ref: library/gettext localizing-your-application8582955
Ref: 2f9e8582955
Node: Changing languages on the fly8583673
Ref: library/gettext changing-languages-on-the-fly8583849
Ref: 2f9f8583849
Node: Deferred translations8584483
Ref: library/gettext deferred-translations8584623
Ref: 2fa08584623
Node: Acknowledgements<9>8586743
Ref: library/gettext acknowledgements8586906
Ref: 2fa18586906
Node: locale — Internationalization services8587302
Ref: library/locale doc8587462
Ref: 2fa28587462
Ref: library/locale locale-internationalization-services8587462
Ref: 2fa38587462
Ref: library/locale module-locale8587462
Ref: a98587462
Ref: library/locale locale Error8588190
Ref: 2fa48588190
Ref: library/locale locale setlocale8588317
Ref: 1f488588317
Ref: library/locale locale localeconv8589494
Ref: 47f8589494
Ref: library/locale locale nl_langinfo8597795
Ref: 2fa88597795
Ref: library/locale locale CODESET8598316
Ref: 2fa98598316
Ref: library/locale locale D_T_FMT8598450
Ref: 2faa8598450
Ref: library/locale locale D_FMT8598646
Ref: 2fab8598646
Ref: library/locale locale T_FMT8598833
Ref: 2fac8598833
Ref: library/locale locale T_FMT_AMPM8599020
Ref: 2fad8599020
Ref: library/locale locale RADIXCHAR8599718
Ref: 2fae8599718
Ref: library/locale locale THOUSEP8599822
Ref: 2faf8599822
Ref: library/locale locale YESEXPR8599942
Ref: 2fb08599942
Ref: library/locale locale NOEXPR8600326
Ref: 2fb18600326
Ref: library/locale locale CRNCYSTR8600511
Ref: 2fb28600511
Ref: library/locale locale ERA8600789
Ref: 2fb38600789
Ref: library/locale locale ERA_D_T_FMT8601563
Ref: 2fb48601563
Ref: library/locale locale ERA_D_FMT8601734
Ref: 2fb58601734
Ref: library/locale locale ERA_T_FMT8601896
Ref: 2fb68601896
Ref: library/locale locale ALT_DIGITS8602058
Ref: 2fb78602058
Ref: library/locale locale getdefaultlocale8602192
Ref: 129b8602192
Ref: library/locale locale getlocale8603399
Ref: 182d8603399
Ref: library/locale locale getpreferredencoding8603876
Ref: 39a8603876
Ref: library/locale locale normalize8604744
Ref: 2fba8604744
Ref: library/locale locale resetlocale8605166
Ref: 2fbb8605166
Ref: library/locale locale strcoll8605416
Ref: 2fbc8605416
Ref: library/locale locale strxfrm8605735
Ref: 2fbe8605735
Ref: library/locale locale format_string8606079
Ref: 3998606079
Ref: library/locale locale format8606775
Ref: 45d8606775
Ref: library/locale locale currency8607251
Ref: 2fbf8607251
Ref: library/locale locale str8607881
Ref: 2fc08607881
Ref: library/locale locale delocalize8608070
Ref: 6ff8608070
Ref: library/locale locale atof8608248
Ref: 2fc18608248
Ref: library/locale locale atoi8608389
Ref: 2fc28608389
Ref: library/locale locale LC_CTYPE8608520
Ref: 2fb98608520
Ref: library/locale locale LC_COLLATE8608742
Ref: 2fbd8608742
Ref: library/locale locale LC_TIME8608935
Ref: 2fc38608935
Ref: library/locale locale LC_MONETARY8609085
Ref: 2fa78609085
Ref: library/locale locale LC_MESSAGES8609258
Ref: 2fc48609258
Ref: library/locale locale LC_NUMERIC8609556
Ref: 2fa58609556
Ref: library/locale locale LC_ALL8609872
Ref: 2fb88609872
Ref: library/locale locale CHAR_MAX8610297
Ref: 2fa68610297
Ref: locale — Internationalization services-Footnote-18611113
Ref: locale — Internationalization services-Footnote-28611178
Ref: locale — Internationalization services-Footnote-38611227
Node: Background details hints tips and caveats8611276
Ref: library/locale background-details-hints-tips-and-caveats8611455
Ref: 2fc58611455
Node: For extension writers and programs that embed Python8613653
Ref: library/locale embedding-locale8613867
Ref: 2fc68613867
Ref: library/locale for-extension-writers-and-programs-that-embed-python8613867
Ref: 2fc78613867
Node: Access to message catalogs8614665
Ref: library/locale access-to-message-catalogs8614829
Ref: 2fc88614829
Ref: library/locale locale-gettext8614829
Ref: 2fc98614829
Ref: library/locale locale gettext8614902
Ref: 2fca8614902
Ref: library/locale locale dgettext8614938
Ref: 2fcb8614938
Ref: library/locale locale dcgettext8614983
Ref: 2fcc8614983
Ref: library/locale locale textdomain8615039
Ref: 2fcd8615039
Ref: library/locale locale bindtextdomain8615081
Ref: 2fce8615081
Node: Program Frameworks8616013
Ref: library/frameworks doc8616166
Ref: 2fcf8616166
Ref: library/frameworks frameworks8616166
Ref: 2fd08616166
Ref: library/frameworks program-frameworks8616166
Ref: 2fd18616166
Node: turtle — Turtle graphics8616615
Ref: library/turtle doc8616759
Ref: 2fd28616759
Ref: library/turtle module-turtle8616759
Ref: 1168616759
Ref: library/turtle turtle-turtle-graphics8616759
Ref: 2fd38616759
Ref: turtle — Turtle graphics-Footnote-18617376
Node: Introduction<11>8617441
Ref: library/turtle introduction8617576
Ref: 2fd48617576
Node: Overview of available Turtle and Screen methods8621262
Ref: library/turtle overview-of-available-turtle-and-screen-methods8621461
Ref: 2fdb8621461
Node: Turtle methods8621640
Ref: library/turtle turtle-methods8621777
Ref: 2fdc8621777
Node: Methods of TurtleScreen/Screen8624855
Ref: library/turtle methods-of-turtlescreen-screen8624992
Ref: 302c8624992
Node: Methods of RawTurtle/Turtle and corresponding functions8626387
Ref: library/turtle methods-of-rawturtle-turtle-and-corresponding-functions8626628
Ref: 304d8626628
Node: Turtle motion8627025
Ref: library/turtle turtle-motion8627160
Ref: 304e8627160
Ref: library/turtle turtle forward8627207
Ref: 2fdd8627207
Ref: library/turtle turtle fd8627247
Ref: 2fde8627247
Ref: library/turtle turtle back8627615
Ref: 2fe18627615
Ref: library/turtle turtle bk8627652
Ref: 2fe08627652
Ref: library/turtle turtle backward8627687
Ref: 2fdf8627687
Ref: library/turtle turtle right8628019
Ref: 2fe28628019
Ref: library/turtle turtle rt8628054
Ref: 2fe38628054
Ref: library/turtle turtle left8628480
Ref: 2fe48628480
Ref: library/turtle turtle lt8628514
Ref: 2fe58628514
Ref: library/turtle turtle goto8628937
Ref: 2fe68628937
Ref: library/turtle turtle setpos8628975
Ref: 2fe78628975
Ref: library/turtle turtle setposition8629015
Ref: 2fe88629015
Ref: library/turtle turtle setx8629672
Ref: 2fe98629672
Ref: library/turtle turtle sety8629956
Ref: 2fea8629956
Ref: library/turtle turtle setheading8630239
Ref: 2feb8630239
Ref: library/turtle turtle seth8630282
Ref: 2fec8630282
Ref: library/turtle turtle home8631078
Ref: 2fed8631078
Ref: library/turtle turtle circle8631425
Ref: 2fee8631425
Ref: library/turtle turtle dot8632670
Ref: 2fef8632670
Ref: library/turtle turtle stamp8633160
Ref: 2ff08633160
Ref: library/turtle turtle clearstamp8633469
Ref: 2ff18633469
Ref: library/turtle turtle clearstamps8633889
Ref: 2ff28633889
Ref: library/turtle turtle undo8634349
Ref: 2ff38634349
Ref: library/turtle turtle speed8634634
Ref: 2ff48634634
Node: Tell Turtle’s state8635563
Ref: library/turtle tell-turtle-s-state8635731
Ref: 30508635731
Ref: library/turtle turtle position8635792
Ref: 2ff58635792
Ref: library/turtle turtle pos8635825
Ref: 2ff68635825
Ref: library/turtle turtle towards8635987
Ref: 2ff78635987
Ref: library/turtle turtle xcor8636533
Ref: 2ff88636533
Ref: library/turtle turtle ycor8636753
Ref: 2ff98636753
Ref: library/turtle turtle heading8636980
Ref: 2ffa8636980
Ref: library/turtle turtle distance8637198
Ref: 2ffb8637198
Node: Settings for measurement8637707
Ref: library/turtle settings-for-measurement8637873
Ref: 30518637873
Ref: library/turtle turtle degrees8637942
Ref: 2ffc8637942
Ref: library/turtle turtle radians8638460
Ref: 2ffd8638460
Node: Pen control8638725
Ref: library/turtle pen-control8638882
Ref: 30528638882
Node: Drawing state8639008
Ref: library/turtle drawing-state8639091
Ref: 30538639091
Ref: library/turtle turtle pendown8639140
Ref: 2ffe8639140
Ref: library/turtle turtle pd8639172
Ref: 2fff8639172
Ref: library/turtle turtle down8639199
Ref: 30008639199
Ref: library/turtle turtle penup8639278
Ref: 30018639278
Ref: library/turtle turtle pu8639308
Ref: 30028639308
Ref: library/turtle turtle up8639335
Ref: 30038639335
Ref: library/turtle turtle pensize8639413
Ref: 30048639413
Ref: library/turtle turtle width8639455
Ref: 30058639455
Ref: library/turtle turtle pen8639897
Ref: 30068639897
Ref: library/turtle turtle isdown8641677
Ref: 30078641677
Node: Color control8641877
Ref: library/turtle color-control8641976
Ref: 30548641976
Ref: library/turtle turtle pencolor8642025
Ref: 30098642025
Ref: library/turtle turtle fillcolor8643511
Ref: 300a8643511
Ref: library/turtle turtle color8644955
Ref: 30088644955
Node: Filling8646134
Ref: library/turtle filling8646240
Ref: 30558646240
Ref: library/turtle turtle filling8646277
Ref: 300b8646277
Ref: library/turtle turtle begin_fill8646501
Ref: 300c8646501
Ref: library/turtle turtle end_fill8646598
Ref: 300d8646598
Node: More drawing control8646825
Ref: library/turtle more-drawing-control8646909
Ref: 30568646909
Ref: library/turtle turtle reset8646972
Ref: 300e8646972
Ref: library/turtle turtle clear8647320
Ref: 300f8647320
Ref: library/turtle turtle write8647524
Ref: 30108647524
Node: Turtle state8648290
Ref: library/turtle turtle-state8648435
Ref: 30578648435
Node: Visibility8648522
Ref: library/turtle visibility8648600
Ref: 30588648600
Ref: library/turtle turtle hideturtle8648643
Ref: 30138648643
Ref: library/turtle turtle ht8648678
Ref: 30148648678
Ref: library/turtle turtle showturtle8648935
Ref: 30118648935
Ref: library/turtle turtle st8648970
Ref: 30128648970
Ref: library/turtle turtle isvisible8649064
Ref: 30158649064
Node: Appearance8649293
Ref: library/turtle appearance8649371
Ref: 30598649371
Ref: library/turtle turtle shape8649414
Ref: 30168649414
Ref: library/turtle turtle resizemode8650047
Ref: 30178650047
Ref: library/turtle turtle shapesize8650976
Ref: 30188650976
Ref: library/turtle turtle turtlesize8651068
Ref: 30198651068
Ref: library/turtle turtle shearfactor8651979
Ref: 301a8651979
Ref: library/turtle turtle tilt8652608
Ref: 301d8652608
Ref: library/turtle turtle settiltangle8652988
Ref: 301b8652988
Ref: library/turtle turtle tiltangle8653477
Ref: 301c8653477
Ref: library/turtle turtle shapetransform8654149
Ref: 301e8654149
Ref: library/turtle turtle get_shapepoly8655130
Ref: 301f8655130
Node: Using events8655471
Ref: library/turtle using-events8655627
Ref: 305a8655627
Ref: library/turtle turtle onclick8655674
Ref: 30208655674
Ref: library/turtle turtle onrelease8656487
Ref: 30218656487
Ref: library/turtle turtle ondrag8657418
Ref: 30228657418
Node: Special Turtle methods8658293
Ref: library/turtle special-turtle-methods8658452
Ref: 305b8658452
Ref: library/turtle turtle begin_poly8658519
Ref: 30238658519
Ref: library/turtle turtle end_poly8658662
Ref: 30248658662
Ref: library/turtle turtle get_poly8658853
Ref: 30258658853
Ref: library/turtle turtle clone8659165
Ref: 30268659165
Ref: library/turtle turtle getturtle8659352
Ref: 30278659352
Ref: library/turtle turtle getpen8659386
Ref: 30288659386
Ref: library/turtle turtle getscreen8659624
Ref: 30298659624
Ref: library/turtle turtle setundobuffer8659900
Ref: 302a8659900
Ref: library/turtle turtle undobufferentries8660336
Ref: 302b8660336
Node: Compound shapes8660486
Ref: library/turtle compound-shapes8660624
Ref: 305c8660624
Ref: library/turtle compoundshapes8660624
Ref: 305d8660624
Node: Methods of TurtleScreen/Screen and corresponding functions8661601
Ref: library/turtle methods-of-turtlescreen-screen-and-corresponding-functions8661809
Ref: 305f8661809
Node: Window control8662289
Ref: library/turtle window-control8662424
Ref: 30608662424
Ref: library/turtle turtle bgcolor8662475
Ref: 302d8662475
Ref: library/turtle turtle bgpic8662838
Ref: 302e8662838
Ref: library/turtle turtle clearscreen8663432
Ref: 302f8663432
Ref: library/turtle turtle resetscreen8663944
Ref: 30308663944
Ref: library/turtle turtle screensize8664280
Ref: 30318664280
Ref: library/turtle turtle setworldcoordinates8665149
Ref: 30328665149
Node: Animation control8666071
Ref: library/turtle animation-control8666234
Ref: 30618666234
Ref: library/turtle turtle delay8666291
Ref: 30338666291
Ref: library/turtle turtle tracer8666690
Ref: 30348666690
Ref: library/turtle turtle update8667341
Ref: 30358667341
Node: Using screen events8667513
Ref: library/turtle using-screen-events8667675
Ref: 30628667675
Ref: library/turtle turtle listen8667736
Ref: 30368667736
Ref: library/turtle turtle onkey8667971
Ref: 30378667971
Ref: library/turtle turtle onkeyrelease8668009
Ref: 30388668009
Ref: library/turtle turtle onkeypress8668581
Ref: 30398668581
Ref: library/turtle turtle onscreenclick8669196
Ref: 303a8669196
Ref: library/turtle turtle ontimer8670358
Ref: 303b8670358
Ref: library/turtle turtle mainloop8670772
Ref: 303c8670772
Ref: library/turtle turtle done8670805
Ref: 303d8670805
Node: Input methods8671131
Ref: library/turtle input-methods8671304
Ref: 30638671304
Ref: library/turtle turtle textinput8671353
Ref: 30478671353
Ref: library/turtle turtle numinput8671807
Ref: 30488671807
Node: Settings and special methods8672727
Ref: library/turtle settings-and-special-methods8672939
Ref: 30648672939
Ref: library/turtle turtle mode8673018
Ref: 303e8673018
Ref: library/turtle turtle colormode8674227
Ref: 303f8674227
Ref: library/turtle turtle getcanvas8674767
Ref: 30408674767
Ref: library/turtle turtle getshapes8674998
Ref: 30418674998
Ref: library/turtle turtle register_shape8675182
Ref: 30428675182
Ref: library/turtle turtle addshape8675237
Ref: 30438675237
Ref: library/turtle turtle turtles8676186
Ref: 30448676186
Ref: library/turtle turtle window_height8676342
Ref: 30458676342
Ref: library/turtle turtle window_width8676469
Ref: 30468676469
Node: Methods specific to Screen not inherited from TurtleScreen8676593
Ref: library/turtle methods-specific-to-screen-not-inherited-from-turtlescreen8676783
Ref: 30658676783
Ref: library/turtle screenspecific8676783
Ref: 30668676783
Ref: library/turtle turtle bye8676924
Ref: 30498676924
Ref: library/turtle turtle exitonclick8676991
Ref: 304a8676991
Ref: library/turtle turtle setup8677425
Ref: 304b8677425
Ref: library/turtle turtle title8678715
Ref: 304c8678715
Node: Public classes8678981
Ref: library/turtle public-classes8679156
Ref: 30678679156
Ref: library/turtle turtle RawTurtle8679207
Ref: 2fd88679207
Ref: library/turtle turtle RawPen8679244
Ref: 2fd98679244
Ref: library/turtle turtle Turtle8679515
Ref: 2fda8679515
Ref: library/turtle turtle TurtleScreen8679707
Ref: 2fd58679707
Ref: library/turtle turtle Screen8679894
Ref: 2fd78679894
Ref: library/turtle turtle ScrolledCanvas8679989
Ref: 2fd68679989
Ref: library/turtle turtle Shape8680284
Ref: 305e8680284
Ref: library/turtle turtle Shape addcomponent8681092
Ref: 30688681092
Ref: library/turtle turtle Vec2D8681647
Ref: 304f8681647
Node: Help and configuration8682199
Ref: library/turtle help-and-configuration8682343
Ref: 30698682343
Node: How to use help8682535
Ref: library/turtle how-to-use-help8682668
Ref: 306a8682668
Node: Translation of docstrings into different languages8684618
Ref: library/turtle translation-of-docstrings-into-different-languages8684795
Ref: 306b8684795
Ref: library/turtle turtle write_docstringdict8685099
Ref: 306c8685099
Node: How to configure Screen and Turtles8686138
Ref: library/turtle how-to-configure-screen-and-turtles8686291
Ref: 306d8686291
Node: turtledemo — Demo scripts8688979
Ref: library/turtle module-turtledemo8689133
Ref: 1178689133
Ref: library/turtle turtledemo-demo-scripts8689133
Ref: 306e8689133
Node: Changes since Python 2 68694776
Ref: library/turtle changes-since-python-2-68694932
Ref: 306f8694932
Node: Changes since Python 3 08695907
Ref: library/turtle changes-since-python-3-08696027
Ref: 30708696027
Node: cmd — Support for line-oriented command interpreters8697234
Ref: library/cmd doc8697420
Ref: 30718697420
Ref: library/cmd cmd-support-for-line-oriented-command-interpreters8697420
Ref: 30728697420
Ref: library/cmd module-cmd8697420
Ref: 1a8697420
Ref: library/cmd cmd Cmd8697896
Ref: 30738697896
Ref: cmd — Support for line-oriented command interpreters-Footnote-18699089
Node: Cmd Objects8699151
Ref: library/cmd cmd-objects8699273
Ref: 30758699273
Ref: library/cmd id18699273
Ref: 30768699273
Ref: library/cmd cmd Cmd cmdloop8699372
Ref: 30778699372
Ref: library/cmd cmd Cmd onecmd8701935
Ref: 307a8701935
Ref: library/cmd cmd Cmd emptyline8702526
Ref: 307d8702526
Ref: library/cmd cmd Cmd default8702724
Ref: 307c8702724
Ref: library/cmd cmd Cmd completedefault8702921
Ref: 307e8702921
Ref: library/cmd cmd Cmd precmd8703143
Ref: 307b8703143
Ref: library/cmd cmd Cmd postcmd8703622
Ref: 30798703622
Ref: library/cmd cmd Cmd preloop8704255
Ref: 307f8704255
Ref: library/cmd cmd Cmd postloop8704449
Ref: 30808704449
Ref: library/cmd cmd Cmd prompt8704733
Ref: 30818704733
Ref: library/cmd cmd Cmd identchars8704802
Ref: 30828704802
Ref: library/cmd cmd Cmd lastcmd8704897
Ref: 30838704897
Ref: library/cmd cmd Cmd cmdqueue8704970
Ref: 30848704970
Ref: library/cmd cmd Cmd intro8705221
Ref: 30788705221
Ref: library/cmd cmd Cmd doc_header8705375
Ref: 30858705375
Ref: library/cmd cmd Cmd misc_header8705495
Ref: 30868705495
Ref: library/cmd cmd Cmd undoc_header8705714
Ref: 30878705714
Ref: library/cmd cmd Cmd ruler8705930
Ref: 30888705930
Ref: library/cmd cmd Cmd use_rawinput8706104
Ref: 30748706104
Node: Cmd Example8706561
Ref: library/cmd cmd-example8706683
Ref: 30898706683
Ref: library/cmd id28706683
Ref: 308a8706683
Node: shlex — Simple lexical analysis8711456
Ref: library/shlex doc8711607
Ref: 308b8711607
Ref: library/shlex module-shlex8711607
Ref: e88711607
Ref: library/shlex shlex-simple-lexical-analysis8711607
Ref: 308c8711607
Ref: library/shlex shlex split8712128
Ref: 2168712128
Ref: library/shlex shlex join8712783
Ref: 2158712783
Ref: library/shlex shlex quote8713219
Ref: a688713219
Ref: library/shlex shlex shlex8714371
Ref: 56f8714371
Ref: shlex — Simple lexical analysis-Footnote-18716617
Node: shlex Objects8716681
Ref: library/shlex id18716786
Ref: 30908716786
Ref: library/shlex shlex-objects8716786
Ref: 30918716786
Ref: library/shlex shlex shlex get_token8716890
Ref: 30928716890
Ref: library/shlex shlex shlex push_token8717253
Ref: 30938717253
Ref: library/shlex shlex shlex read_token8717335
Ref: 30958717335
Ref: library/shlex shlex shlex sourcehook8717574
Ref: 30968717574
Ref: library/shlex shlex shlex push_source8719113
Ref: 30988719113
Ref: library/shlex shlex shlex pop_source8719416
Ref: 30998719416
Ref: library/shlex shlex shlex error_leader8719615
Ref: 309a8719615
Ref: library/shlex shlex shlex commenters8720344
Ref: 308d8720344
Ref: library/shlex shlex shlex wordchars8720566
Ref: 308f8720566
Ref: library/shlex shlex shlex whitespace8721261
Ref: 309c8721261
Ref: library/shlex shlex shlex escape8721459
Ref: 309d8721459
Ref: library/shlex shlex shlex quotes8721624
Ref: 309e8721624
Ref: library/shlex shlex shlex escapedquotes8721909
Ref: 309f8721909
Ref: library/shlex shlex shlex whitespace_split8722138
Ref: 309b8722138
Ref: library/shlex shlex shlex infile8722674
Ref: 308e8722674
Ref: library/shlex shlex shlex instream8722905
Ref: 30a08722905
Ref: library/shlex shlex shlex source8723030
Ref: 30978723030
Ref: library/shlex shlex shlex debug8723619
Ref: 30a18723619
Ref: library/shlex shlex shlex lineno8723883
Ref: 30a28723883
Ref: library/shlex shlex shlex token8723979
Ref: 30a38723979
Ref: library/shlex shlex shlex eof8724096
Ref: 30948724096
Ref: library/shlex shlex shlex punctuation_chars8724272
Ref: ead8724272
Node: Parsing Rules8724681
Ref: library/shlex parsing-rules8724829
Ref: 30a48724829
Ref: library/shlex shlex-parsing-rules8724829
Ref: 30a58724829
Node: Improved Compatibility with Shells8726848
Ref: library/shlex improved-compatibility-with-shells8726974
Ref: 30a68726974
Ref: library/shlex improved-shell-compatibility8726974
Ref: 5708726974
Node: Graphical User Interfaces with Tk8729712
Ref: library/tk doc8729862
Ref: 30a78729862
Ref: library/tk graphical-user-interfaces-with-tk8729862
Ref: 30a88729862
Ref: library/tk tkinter8729862
Ref: 30a98729862
Node: tkinter — Python interface to Tcl/Tk8731594
Ref: library/tkinter doc8731744
Ref: 30ab8731744
Ref: library/tkinter module-tkinter8731744
Ref: 10c8731744
Ref: library/tkinter tkinter-python-interface-to-tcl-tk8731744
Ref: 30ac8731744
Ref: tkinter — Python interface to Tcl/Tk-Footnote-18734179
Ref: tkinter — Python interface to Tcl/Tk-Footnote-28734255
Ref: tkinter — Python interface to Tcl/Tk-Footnote-38734300
Ref: tkinter — Python interface to Tcl/Tk-Footnote-48734331
Ref: tkinter — Python interface to Tcl/Tk-Footnote-58734445
Ref: tkinter — Python interface to Tcl/Tk-Footnote-68734484
Ref: tkinter — Python interface to Tcl/Tk-Footnote-78734535
Ref: tkinter — Python interface to Tcl/Tk-Footnote-88734621
Ref: tkinter — Python interface to Tcl/Tk-Footnote-98734690
Ref: tkinter — Python interface to Tcl/Tk-Footnote-108734747
Ref: tkinter — Python interface to Tcl/Tk-Footnote-118734780
Ref: tkinter — Python interface to Tcl/Tk-Footnote-128734804
Ref: tkinter — Python interface to Tcl/Tk-Footnote-138734864
Node: Tkinter Modules8734901
Ref: library/tkinter tkinter-modules8735022
Ref: 30ad8735022
Ref: library/tkinter tkinter Tk8735869
Ref: 30ae8735869
Ref: library/tkinter tkinter Tcl8736187
Ref: 30af8736187
Node: Tkinter Life Preserver8737727
Ref: library/tkinter tkinter-life-preserver8737884
Ref: 30b08737884
Node: How To Use This Section8738778
Ref: library/tkinter how-to-use-this-section8738897
Ref: 30b18738897
Node: A Simple Hello World Program8740337
Ref: library/tkinter a-simple-hello-world-program8740456
Ref: 30b28740456
Node: A Very Quick Look at Tcl/Tk8741233
Ref: library/tkinter a-very-quick-look-at-tcl-tk8741404
Ref: 30b38741404
Node: Mapping Basic Tk into Tkinter8744737
Ref: library/tkinter mapping-basic-tk-into-tkinter8744916
Ref: 30b58744916
Ref: library/tkinter tkinter-basic-mapping8744916
Ref: 30b48744916
Node: How Tk and Tkinter are Related8746728
Ref: library/tkinter how-tk-and-tkinter-are-related8746895
Ref: 30b78746895
Node: Handy Reference8748167
Ref: library/tkinter handy-reference8748318
Ref: 30b88748318
Node: Setting Options8748570
Ref: library/tkinter setting-options8748656
Ref: 30b98748656
Ref: library/tkinter tkinter-setting-options8748656
Ref: 30b68748656
Node: The Packer8751848
Ref: library/tkinter the-packer8751957
Ref: 30ba8751957
Node: Packer Options8753616
Ref: library/tkinter packer-options8753735
Ref: 30bb8753735
Node: Coupling Widget Variables8754435
Ref: library/tkinter coupling-widget-variables8754562
Ref: 30bc8754562
Node: The Window Manager8756646
Ref: library/tkinter the-window-manager8756779
Ref: 30bd8756779
Node: Tk Option Data Types8758108
Ref: library/tkinter tk-option-data-types8758235
Ref: 30be8758235
Node: Bindings and Events8761279
Ref: library/tkinter bindings-and-events8761407
Ref: 30bf8761407
Node: The index Parameter8764128
Ref: library/tkinter the-index-parameter8764242
Ref: 30c08764242
Node: Images8766177
Ref: library/tkinter images8766263
Ref: 30c18766263
Ref: Images-Footnote-18767197
Node: File Handlers8767231
Ref: library/tkinter file-handlers8767343
Ref: 30c28767343
Ref: library/tkinter tkinter-file-handlers8767343
Ref: 30c38767343
Ref: library/tkinter tkinter Widget tk createfilehandler8768260
Ref: 30c48768260
Ref: library/tkinter tkinter Widget tk deletefilehandler8768695
Ref: 30c58768695
Ref: library/tkinter tkinter READABLE8768777
Ref: 30c68768777
Ref: library/tkinter tkinter WRITABLE8768804
Ref: 30c78768804
Ref: library/tkinter tkinter EXCEPTION8768831
Ref: 30c88768831
Node: tkinter ttk — Tk themed widgets8768906
Ref: library/tkinter ttk doc8769105
Ref: 30c98769105
Ref: library/tkinter ttk module-tkinter ttk8769105
Ref: 10f8769105
Ref: library/tkinter ttk tkinter-ttk-tk-themed-widgets8769105
Ref: 30ca8769105
Ref: tkinter ttk — Tk themed widgets-Footnote-18770167
Ref: tkinter ttk — Tk themed widgets-Footnote-28770237
Node: Using Ttk8770290
Ref: library/tkinter ttk using-ttk8770389
Ref: 30cb8770389
Ref: Using Ttk-Footnote-18771541
Node: Ttk Widgets8771604
Ref: library/tkinter ttk ttk-widgets8771718
Ref: 30cc8771718
Node: Widget8772807
Ref: library/tkinter ttk widget8772920
Ref: 30d38772920
Node: Standard Options8773237
Ref: library/tkinter ttk standard-options8773330
Ref: 30d48773330
Node: Scrollable Widget Options8775007
Ref: library/tkinter ttk scrollable-widget-options8775122
Ref: 30d58775122
Node: Label Options8776245
Ref: library/tkinter ttk label-options8776365
Ref: 30d68776365
Node: Compatibility Options8778924
Ref: library/tkinter ttk compatibility-options8779032
Ref: 30d88779032
Node: Widget States8779568
Ref: library/tkinter ttk widget-states8779673
Ref: 30da8779673
Node: ttk Widget8781352
Ref: library/tkinter ttk ttk-widget8781427
Ref: 30db8781427
Ref: library/tkinter ttk tkinter ttk Widget8781614
Ref: 30d08781614
Ref: library/tkinter ttk tkinter ttk Widget identify8781645
Ref: 30dc8781645
Ref: library/tkinter ttk tkinter ttk Widget instate8781888
Ref: 30dd8781888
Ref: library/tkinter ttk tkinter ttk Widget state8782232
Ref: 30d98782232
Node: Combobox8782620
Ref: library/tkinter ttk combobox8782729
Ref: 30de8782729
Node: Options8783424
Ref: library/tkinter ttk options8783499
Ref: 30df8783499
Node: Virtual events8786005
Ref: library/tkinter ttk virtual-events8786101
Ref: 30e08786101
Node: ttk Combobox8786281
Ref: library/tkinter ttk ttk-combobox8786361
Ref: 30e18786361
Ref: library/tkinter ttk tkinter ttk Combobox8786408
Ref: 30cd8786408
Ref: library/tkinter ttk tkinter ttk Combobox current8786441
Ref: 30e28786441
Ref: library/tkinter ttk tkinter ttk Combobox get8786717
Ref: 30e38786717
Ref: library/tkinter ttk tkinter ttk Combobox set8786796
Ref: 30e48786796
Node: Spinbox8786880
Ref: library/tkinter ttk spinbox8786991
Ref: 30e58786991
Node: Options<2>8787751
Ref: library/tkinter ttk id18787831
Ref: 30e68787831
Node: Virtual events<2>8790217
Ref: library/tkinter ttk id28790317
Ref: 30e78790317
Node: ttk Spinbox8790525
Ref: library/tkinter ttk ttk-spinbox8790606
Ref: 30e88790606
Ref: library/tkinter ttk tkinter ttk Spinbox8790651
Ref: 3f28790651
Ref: library/tkinter ttk tkinter ttk Spinbox get8790683
Ref: 30e98790683
Ref: library/tkinter ttk tkinter ttk Spinbox set8790761
Ref: 30ea8790761
Node: Notebook8790844
Ref: library/tkinter ttk notebook8790958
Ref: 30eb8790958
Node: Options<3>8791318
Ref: library/tkinter ttk id38791393
Ref: 30ec8791393
Node: Tab Options8792568
Ref: library/tkinter ttk tab-options8792667
Ref: 30ed8792667
Node: Tab Identifiers8794742
Ref: library/tkinter ttk tab-identifiers8794845
Ref: 30ef8794845
Node: Virtual Events8795379
Ref: library/tkinter ttk id48795483
Ref: 30f18795483
Node: ttk Notebook8795627
Ref: library/tkinter ttk ttk-notebook8795707
Ref: 30f28795707
Ref: library/tkinter ttk tkinter ttk Notebook8795754
Ref: 30ce8795754
Ref: library/tkinter ttk tkinter ttk Notebook add8795787
Ref: 30f38795787
Ref: library/tkinter ttk tkinter ttk Notebook forget8796072
Ref: 30f48796072
Ref: library/tkinter ttk tkinter ttk Notebook hide8796210
Ref: 30f58796210
Ref: library/tkinter ttk tkinter ttk Notebook identify8796520
Ref: 30f68796520
Ref: library/tkinter ttk tkinter ttk Notebook index8796662
Ref: 30f08796662
Ref: library/tkinter ttk tkinter ttk Notebook insert8796841
Ref: 30f78796841
Ref: library/tkinter ttk tkinter ttk Notebook select8797226
Ref: 30f88797226
Ref: library/tkinter ttk tkinter ttk Notebook tab8797540
Ref: 30f98797540
Ref: library/tkinter ttk tkinter ttk Notebook tabs8797886
Ref: 30fa8797886
Ref: library/tkinter ttk tkinter ttk Notebook enable_traversal8797974
Ref: 30ee8797974
Node: Progressbar8798801
Ref: library/tkinter ttk progressbar8798917
Ref: 30fb8798917
Node: Options<4>8799358
Ref: library/tkinter ttk id58799440
Ref: 30fc8799440
Node: ttk Progressbar8801315
Ref: library/tkinter ttk ttk-progressbar8801397
Ref: 30fd8801397
Ref: library/tkinter ttk tkinter ttk Progressbar8801450
Ref: 30cf8801450
Ref: library/tkinter ttk tkinter ttk Progressbar start8801486
Ref: 30fe8801486
Ref: library/tkinter ttk tkinter ttk Progressbar step8801754
Ref: 30ff8801754
Ref: library/tkinter ttk tkinter ttk Progressbar stop8801901
Ref: 31008801901
Node: Separator8802086
Ref: library/tkinter ttk separator8802202
Ref: 31018802202
Node: Options<5>8802432
Ref: library/tkinter ttk id68802488
Ref: 31028802488
Node: Sizegrip8802877
Ref: library/tkinter ttk sizegrip8802990
Ref: 31038802990
Node: Platform-specific notes8803340
Ref: library/tkinter ttk platform-specific-notes8803421
Ref: 31048803421
Node: Bugs8803679
Ref: library/tkinter ttk bugs8803760
Ref: 31058803760
Node: Treeview8804033
Ref: library/tkinter ttk treeview8804148
Ref: 31068804148
Node: Options<6>8805506
Ref: library/tkinter ttk id78805582
Ref: 310a8805582
Node: Item Options8808228
Ref: library/tkinter ttk item-options8808324
Ref: 310b8808324
Node: Tag Options8809500
Ref: library/tkinter ttk tag-options8809604
Ref: 310c8809604
Node: Column Identifiers8810334
Ref: library/tkinter ttk column-identifiers8810443
Ref: 31078810443
Node: Virtual Events<2>8811315
Ref: library/tkinter ttk id88811425
Ref: 310d8811425
Node: ttk Treeview8812327
Ref: library/tkinter ttk ttk-treeview8812410
Ref: 310f8812410
Ref: library/tkinter ttk tkinter ttk Treeview8812457
Ref: 2bb8812457
Ref: library/tkinter ttk tkinter ttk Treeview bbox8812490
Ref: 31108812490
Ref: library/tkinter ttk tkinter ttk Treeview get_children8812927
Ref: 31118812927
Ref: library/tkinter ttk tkinter ttk Treeview set_children8813093
Ref: 31128813093
Ref: library/tkinter ttk tkinter ttk Treeview column8813485
Ref: 31138813485
Ref: library/tkinter ttk tkinter ttk Treeview delete8814895
Ref: 31148814895
Ref: library/tkinter ttk tkinter ttk Treeview detach8815041
Ref: 31158815041
Ref: library/tkinter ttk tkinter ttk Treeview exists8815352
Ref: 31168815352
Ref: library/tkinter ttk tkinter ttk Treeview focus8815462
Ref: 310e8815462
Ref: library/tkinter ttk tkinter ttk Treeview heading8815655
Ref: 31178815655
Ref: library/tkinter ttk tkinter ttk Treeview identify8816756
Ref: 31188816756
Ref: library/tkinter ttk tkinter ttk Treeview identify_row8816993
Ref: 31198816993
Ref: library/tkinter ttk tkinter ttk Treeview identify_column8817088
Ref: 311a8817088
Ref: library/tkinter ttk tkinter ttk Treeview identify_region8817249
Ref: 311b8817249
Ref: library/tkinter ttk tkinter ttk Treeview identify_element8817885
Ref: 311c8817885
Ref: library/tkinter ttk tkinter ttk Treeview index8818013
Ref: 311d8818013
Ref: library/tkinter ttk tkinter ttk Treeview insert8818141
Ref: 311e8818141
Ref: library/tkinter ttk tkinter ttk Treeview item8819038
Ref: 311f8819038
Ref: library/tkinter ttk tkinter ttk Treeview move8819416
Ref: 31208819416
Ref: library/tkinter ttk tkinter ttk Treeview next8819854
Ref: 31218819854
Ref: library/tkinter ttk tkinter ttk Treeview parent8820009
Ref: 31228820009
Ref: library/tkinter ttk tkinter ttk Treeview prev8820160
Ref: 31238820160
Ref: library/tkinter ttk tkinter ttk Treeview reattach8820320
Ref: 31248820320
Ref: library/tkinter ttk tkinter ttk Treeview see8820422
Ref: 31258820422
Ref: library/tkinter ttk tkinter ttk Treeview selection8820678
Ref: 2ba8820678
Ref: library/tkinter ttk tkinter ttk Treeview selection_set8820926
Ref: 2bc8820926
Ref: library/tkinter ttk tkinter ttk Treeview selection_add8821131
Ref: 31268821131
Ref: library/tkinter ttk tkinter ttk Treeview selection_remove8821331
Ref: 31278821331
Ref: library/tkinter ttk tkinter ttk Treeview selection_toggle8821539
Ref: 31288821539
Ref: library/tkinter ttk tkinter ttk Treeview set8821764
Ref: 31298821764
Ref: library/tkinter ttk tkinter ttk Treeview tag_bind8822129
Ref: 312a8822129
Ref: library/tkinter ttk tkinter ttk Treeview tag_configure8822399
Ref: 312b8822399
Ref: library/tkinter ttk tkinter ttk Treeview tag_has8822828
Ref: 312c8822828
Ref: library/tkinter ttk tkinter ttk Treeview xview8823113
Ref: 31088823113
Ref: library/tkinter ttk tkinter ttk Treeview yview8823209
Ref: 31098823209
Node: Ttk Styling8823303
Ref: library/tkinter ttk ttk-styling8823401
Ref: 312d8823401
Ref: library/tkinter ttk ttkstyling8823401
Ref: 30d18823401
Ref: library/tkinter ttk tkinter ttk Style8823995
Ref: 30d28823995
Ref: library/tkinter ttk tkinter ttk Style configure8824084
Ref: 312e8824084
Ref: library/tkinter ttk tkinter ttk Style map8824706
Ref: 30d78824706
Ref: library/tkinter ttk tkinter ttk Style lookup8825836
Ref: 312f8825836
Ref: library/tkinter ttk tkinter ttk Style layout8826342
Ref: 31308826342
Ref: library/tkinter ttk tkinter ttk Style element_create8827414
Ref: 31328827414
Ref: library/tkinter ttk tkinter ttk Style element_names8829536
Ref: 31338829536
Ref: library/tkinter ttk tkinter ttk Style element_options8829641
Ref: 31348829641
Ref: library/tkinter ttk tkinter ttk Style theme_create8829747
Ref: 31358829747
Ref: library/tkinter ttk tkinter ttk Style theme_settings8830160
Ref: 31368830160
Ref: library/tkinter ttk tkinter ttk Style theme_names8831382
Ref: 31378831382
Ref: library/tkinter ttk tkinter ttk Style theme_use8831462
Ref: 31388831462
Ref: Ttk Styling-Footnote-18831759
Node: Layouts8831820
Ref: library/tkinter ttk layouts8831875
Ref: 31318831875
Node: tkinter tix — Extension widgets for Tk8833159
Ref: library/tkinter tix doc8833365
Ref: 31398833365
Ref: library/tkinter tix layout8833365
Ref: 313a8833365
Ref: library/tkinter tix layouts8833365
Ref: 313b8833365
Ref: library/tkinter tix module-tkinter tix8833365
Ref: 10e8833365
Ref: library/tkinter tix tkinter-tix-extension-widgets-for-tk8833365
Ref: 313c8833365
Ref: tkinter tix — Extension widgets for Tk-Footnote-18835309
Ref: tkinter tix — Extension widgets for Tk-Footnote-28835379
Ref: tkinter tix — Extension widgets for Tk-Footnote-38835415
Ref: tkinter tix — Extension widgets for Tk-Footnote-48835468
Ref: tkinter tix — Extension widgets for Tk-Footnote-58835545
Node: Using Tix8835602
Ref: library/tkinter tix using-tix8835708
Ref: 31438835708
Ref: library/tkinter tix tkinter tix Tk8835747
Ref: 31448835747
Node: Tix Widgets8836690
Ref: library/tkinter tix tix-widgets8836817
Ref: 31458836817
Ref: Tix Widgets-Footnote-18837157
Node: Basic Widgets8837235
Ref: library/tkinter tix basic-widgets8837319
Ref: 31468837319
Ref: library/tkinter tix tkinter tix Balloon8837366
Ref: 31478837366
Ref: library/tkinter tix tkinter tix ButtonBox8837644
Ref: 31488837644
Ref: library/tkinter tix tkinter tix ComboBox8837785
Ref: 313e8837785
Ref: library/tkinter tix tkinter tix Control8838019
Ref: 313f8838019
Ref: library/tkinter tix tkinter tix LabelEntry8838332
Ref: 31498838332
Ref: library/tkinter tix tkinter tix LabelFrame8838547
Ref: 314a8838547
Ref: library/tkinter tix tkinter tix Meter8838849
Ref: 314b8838849
Ref: library/tkinter tix tkinter tix OptionMenu8839002
Ref: 314c8839002
Ref: library/tkinter tix tkinter tix PopupMenu8839095
Ref: 314d8839095
Ref: library/tkinter tix tkinter tix Select8839343
Ref: 314e8839343
Ref: library/tkinter tix tkinter tix StdButtonBox8839540
Ref: 314f8839540
Ref: Basic Widgets-Footnote-18839712
Ref: Basic Widgets-Footnote-28839792
Ref: Basic Widgets-Footnote-38839874
Ref: Basic Widgets-Footnote-48839955
Ref: Basic Widgets-Footnote-58840035
Ref: Basic Widgets-Footnote-68840118
Ref: Basic Widgets-Footnote-78840201
Ref: Basic Widgets-Footnote-88840279
Ref: Basic Widgets-Footnote-98840362
Ref: Basic Widgets-Footnote-108840444
Ref: Basic Widgets-Footnote-118840524
Node: File Selectors8840610
Ref: library/tkinter tix file-selectors8840723
Ref: 31508840723
Ref: library/tkinter tix tkinter tix DirList8840772
Ref: 31518840772
Ref: library/tkinter tix tkinter tix DirTree8841032
Ref: 31528841032
Ref: library/tkinter tix tkinter tix DirSelectDialog8841292
Ref: 31538841292
Ref: library/tkinter tix tkinter tix DirSelectBox8841548
Ref: 31548841548
Ref: library/tkinter tix tkinter tix ExFileSelectBox8841890
Ref: 31558841890
Ref: library/tkinter tix tkinter tix FileSelectBox8842221
Ref: 31568842221
Ref: library/tkinter tix tkinter tix FileEntry8842553
Ref: 31418842553
Ref: File Selectors-Footnote-18842873
Ref: File Selectors-Footnote-28842953
Ref: File Selectors-Footnote-38843033
Ref: File Selectors-Footnote-48843121
Ref: File Selectors-Footnote-58843209
Ref: File Selectors-Footnote-68843295
Node: Hierarchical ListBox8843377
Ref: library/tkinter tix hierarchical-listbox8843492
Ref: 31578843492
Ref: library/tkinter tix tkinter tix HList8843553
Ref: 313d8843553
Ref: library/tkinter tix tkinter tix CheckList8843838
Ref: 31588843838
Ref: library/tkinter tix tkinter tix Tree8844126
Ref: 31598844126
Ref: Hierarchical ListBox-Footnote-18844366
Ref: Hierarchical ListBox-Footnote-28844444
Ref: Hierarchical ListBox-Footnote-38844526
Node: Tabular ListBox8844603
Ref: library/tkinter tix tabular-listbox8844719
Ref: 315a8844719
Ref: library/tkinter tix tkinter tix TList8844770
Ref: 315b8844770
Ref: Tabular ListBox-Footnote-18845256
Node: Manager Widgets8845334
Ref: library/tkinter tix manager-widgets8845441
Ref: 315c8845441
Ref: library/tkinter tix tkinter tix PanedWindow8845492
Ref: 31428845492
Ref: library/tkinter tix tkinter tix ListNoteBook8845799
Ref: 315d8845799
Ref: library/tkinter tix tkinter tix NoteBook8846250
Ref: 31408846250
Ref: Manager Widgets-Footnote-18846661
Ref: Manager Widgets-Footnote-28846745
Ref: Manager Widgets-Footnote-38846830
Node: Image Types8846911
Ref: library/tkinter tix image-types8847024
Ref: 315e8847024
Ref: Image Types-Footnote-18847636
Ref: Image Types-Footnote-28847712
Node: Miscellaneous Widgets8847790
Ref: library/tkinter tix miscellaneous-widgets8847909
Ref: 315f8847909
Ref: library/tkinter tix tkinter tix InputOnly8847972
Ref: 31608847972
Ref: Miscellaneous Widgets-Footnote-18848173
Node: Form Geometry Manager8848255
Ref: library/tkinter tix form-geometry-manager8848354
Ref: 31618848354
Ref: library/tkinter tix tkinter tix Form8848500
Ref: 31628848500
Ref: Form Geometry Manager-Footnote-18848651
Node: Tix Commands8848728
Ref: library/tkinter tix tix-commands8848837
Ref: 31638848837
Ref: library/tkinter tix tkinter tix tixCommand8848884
Ref: 31648848884
Ref: library/tkinter tix tkinter tix tixCommand tix_configure8849370
Ref: 31658849370
Ref: library/tkinter tix tkinter tix tixCommand tix_cget8850055
Ref: 31668850055
Ref: library/tkinter tix tkinter tix tixCommand tix_getbitmap8850230
Ref: 31678850230
Ref: library/tkinter tix tkinter tix tixCommand tix_addbitmapdir8850781
Ref: 31688850781
Ref: library/tkinter tix tkinter tix tixCommand tix_filedialog8851315
Ref: 316a8851315
Ref: library/tkinter tix tkinter tix tixCommand tix_getimage8851895
Ref: 31698851895
Ref: library/tkinter tix tkinter tix tixCommand tix_option_get8852685
Ref: 316b8852685
Ref: library/tkinter tix tkinter tix tixCommand tix_resetoptions8852794
Ref: 316c8852794
Ref: Tix Commands-Footnote-18853627
Node: tkinter scrolledtext — Scrolled Text Widget8853699
Ref: library/tkinter scrolledtext doc8853880
Ref: 316d8853880
Ref: library/tkinter scrolledtext module-tkinter scrolledtext8853880
Ref: 10d8853880
Ref: library/tkinter scrolledtext tkinter-scrolledtext-scrolled-text-widget8853880
Ref: 316e8853880
Ref: library/tkinter scrolledtext tkinter scrolledtext ScrolledText frame8854849
Ref: 316f8854849
Ref: library/tkinter scrolledtext tkinter scrolledtext ScrolledText vbar8854949
Ref: 31708854949
Ref: tkinter scrolledtext — Scrolled Text Widget-Footnote-18855048
Node: IDLE<41>8855128
Ref: library/idle doc8855308
Ref: 31718855308
Ref: library/idle id18855308
Ref: 31728855308
Ref: library/idle idle8855308
Ref: 93e8855308
Ref: IDLE<41>-Footnote-18856338
Node: Menus8856402
Ref: library/idle menus8856483
Ref: 31738856483
Node: File menu Shell and Editor8857765
Ref: library/idle file-menu-shell-and-editor8857868
Ref: 31748857868
Node: Edit menu Shell and Editor8859155
Ref: library/idle edit-menu-shell-and-editor8859297
Ref: 31758859297
Node: Format menu Editor window only8860915
Ref: library/idle format-menu8861058
Ref: 31788861058
Ref: library/idle format-menu-editor-window-only8861058
Ref: 31798861058
Node: Run menu Editor window only8862427
Ref: library/idle run-menu-editor-window-only8862572
Ref: 317a8862572
Ref: library/idle run-module8862651
Ref: 317b8862651
Ref: library/idle run-custom8863143
Ref: 317d8863143
Ref: library/idle check-module8863402
Ref: 317c8863402
Ref: library/idle python-shell8863746
Ref: 317e8863746
Node: Shell menu Shell window only8863808
Ref: library/idle shell-menu-shell-window-only8863951
Ref: 317f8863951
Node: Debug menu Shell window only8864422
Ref: library/idle debug-menu-shell-window-only8864567
Ref: 31808864567
Node: Options menu Shell and Editor8865523
Ref: library/idle options-menu-shell-and-editor8865668
Ref: 31818865668
Node: Window menu Shell and Editor8867285
Ref: library/idle window-menu-shell-and-editor8867428
Ref: 31848867428
Node: Help menu Shell and Editor8867620
Ref: library/idle help-menu-shell-and-editor8867747
Ref: 31858867747
Node: Context Menus8868467
Ref: library/idle context-menus8868557
Ref: 31878868557
Node: Editing and navigation8869725
Ref: library/idle editing-and-navigation8869841
Ref: 31888869841
Ref: library/idle id28869841
Ref: 31898869841
Node: Editor windows8870066
Ref: library/idle editor-windows8870160
Ref: 318a8870160
Node: Key bindings8870782
Ref: library/idle key-bindings8870906
Ref: 318b8870906
Node: Automatic indentation8872294
Ref: library/idle automatic-indentation8872415
Ref: 318c8872415
Node: Completions8872995
Ref: library/idle completions8873112
Ref: 31768873112
Ref: library/idle id38873112
Ref: 318d8873112
Node: Calltips8875312
Ref: library/idle calltips8875420
Ref: 31778875420
Ref: library/idle id48875420
Ref: 318e8875420
Node: Code Context8876806
Ref: library/idle code-context8876922
Ref: 31838876922
Ref: library/idle id58876922
Ref: 318f8876922
Node: Python Shell window8877810
Ref: library/idle python-shell-window8877929
Ref: 31908877929
Node: Text colors8879055
Ref: library/idle text-colors8879153
Ref: 31918879153
Node: Startup and code execution8879916
Ref: library/idle startup-and-code-execution8880047
Ref: 31928880047
Node: Command line usage8881178
Ref: library/idle command-line-usage8881283
Ref: 31938881283
Node: Startup failure8882278
Ref: library/idle startup-failure8882409
Ref: 31948882409
Node: Running user code8884687
Ref: library/idle running-user-code8884820
Ref: 31958884820
Node: User output in Shell8886972
Ref: library/idle user-output-in-shell8887121
Ref: 31968887121
Node: Developing tkinter applications8890177
Ref: library/idle developing-tkinter-applications8890337
Ref: 31978890337
Node: Running without a subprocess8891586
Ref: library/idle running-without-a-subprocess8891717
Ref: 31988891717
Node: Help and preferences8893099
Ref: library/idle help-and-preferences8893199
Ref: 31998893199
Node: Help sources8893346
Ref: library/idle help-sources8893443
Ref: 31868893443
Ref: library/idle id68893443
Ref: 319a8893443
Node: Setting preferences8894308
Ref: library/idle preferences8894427
Ref: 31828894427
Ref: library/idle setting-preferences8894427
Ref: 319b8894427
Node: IDLE on macOS8895423
Ref: library/idle idle-on-macos8895540
Ref: 319c8895540
Node: Extensions8895807
Ref: library/idle extensions8895896
Ref: 319d8895896
Node: Other Graphical User Interface Packages8896247
Ref: library/othergui doc8896373
Ref: 319e8896373
Ref: library/othergui other-graphical-user-interface-packages8896373
Ref: 319f8896373
Ref: library/othergui other-gui-packages8896373
Ref: 30aa8896373
Ref: Other Graphical User Interface Packages-Footnote-18898713
Ref: Other Graphical User Interface Packages-Footnote-28898763
Ref: Other Graphical User Interface Packages-Footnote-38898815
Ref: Other Graphical User Interface Packages-Footnote-48898844
Ref: Other Graphical User Interface Packages-Footnote-58898898
Ref: Other Graphical User Interface Packages-Footnote-68898928
Ref: Other Graphical User Interface Packages-Footnote-78898959
Ref: Other Graphical User Interface Packages-Footnote-88899014
Ref: Other Graphical User Interface Packages-Footnote-98899073
Ref: Other Graphical User Interface Packages-Footnote-108899107
Ref: Other Graphical User Interface Packages-Footnote-118899141
Ref: Other Graphical User Interface Packages-Footnote-128899177
Node: Development Tools8899230
Ref: library/development doc8899385
Ref: 31a08899385
Ref: library/development development8899385
Ref: 31a18899385
Ref: library/development development-tools8899385
Ref: 31a28899385
Node: typing — Support for type hints8900634
Ref: library/typing doc8900786
Ref: 31a38900786
Ref: library/typing module-typing8900786
Ref: 1198900786
Ref: library/typing typing-support-for-type-hints8900786
Ref: 31a48900786
Ref: typing — Support for type hints-Footnote-18902172
Ref: typing — Support for type hints-Footnote-28902237
Ref: typing — Support for type hints-Footnote-38902286
Ref: typing — Support for type hints-Footnote-48902335
Ref: typing — Support for type hints-Footnote-58902384
Ref: typing — Support for type hints-Footnote-68902433
Ref: typing — Support for type hints-Footnote-78902482
Ref: typing — Support for type hints-Footnote-88902531
Ref: typing — Support for type hints-Footnote-98902580
Node: Type aliases8902629
Ref: library/typing type-aliases8902727
Ref: 31a98902727
Node: NewType8903819
Ref: library/typing distinct8903934
Ref: 31aa8903934
Ref: library/typing newtype8903934
Ref: 31ab8903934
Ref: NewType-Footnote-18906745
Node: Callable8906794
Ref: library/typing callable8906905
Ref: 31ac8906905
Node: Generics8907536
Ref: library/typing generics8907666
Ref: 31ad8907666
Ref: library/typing id18907666
Ref: 31ae8907666
Node: User-defined generic types8908342
Ref: library/typing user-defined-generic-types8908476
Ref: 31af8908476
Node: The Any type8911531
Ref: library/typing the-any-type8911688
Ref: 31b08911688
Node: Nominal vs structural subtyping8914129
Ref: library/typing nominal-vs-structural-subtyping8914292
Ref: 31b18914292
Ref: Nominal vs structural subtyping-Footnote-18915898
Ref: Nominal vs structural subtyping-Footnote-28915947
Ref: Nominal vs structural subtyping-Footnote-38915996
Node: Classes functions and decorators8916045
Ref: library/typing classes-functions-and-decorators8916187
Ref: 31b38916187
Ref: library/typing typing TypeVar8916345
Ref: 31a78916345
Ref: library/typing typing Generic8917947
Ref: 31a88917947
Ref: library/typing typing Protocol8918564
Ref: 23d8918564
Ref: library/typing typing Type8919459
Ref: 31b48919459
Ref: library/typing typing Iterable8921086
Ref: 31b28921086
Ref: library/typing typing Iterator8921195
Ref: 31b58921195
Ref: library/typing typing Reversible8921305
Ref: 31b68921305
Ref: library/typing typing SupportsInt8921418
Ref: 23f8921418
Ref: library/typing typing SupportsFloat8921502
Ref: 31b78921502
Ref: library/typing typing SupportsComplex8921590
Ref: 31b88921590
Ref: library/typing typing SupportsBytes8921682
Ref: 31b98921682
Ref: library/typing typing SupportsIndex8921770
Ref: 2408921770
Ref: library/typing typing SupportsAbs8921884
Ref: 31ba8921884
Ref: library/typing typing SupportsRound8922010
Ref: 31bb8922010
Ref: library/typing typing Container8922140
Ref: 31bc8922140
Ref: library/typing typing Hashable8922251
Ref: 31bd8922251
Ref: library/typing typing Sized8922335
Ref: 31be8922335
Ref: library/typing typing Collection8922413
Ref: 5978922413
Ref: library/typing typing AbstractSet8922578
Ref: 31bf8922578
Ref: library/typing typing MutableSet8922695
Ref: 31c08922695
Ref: library/typing typing Mapping8922809
Ref: 31c18922809
Ref: library/typing typing MutableMapping8923093
Ref: 31c28923093
Ref: library/typing typing Sequence8923215
Ref: 31c38923215
Ref: library/typing typing MutableSequence8923345
Ref: 31c48923345
Ref: library/typing typing ByteString8923465
Ref: 31c58923465
Ref: library/typing typing Deque8923817
Ref: 31c68923817
Ref: library/typing typing List8923983
Ref: 31c78923983
Ref: library/typing typing Set8924491
Ref: 31c88924491
Ref: library/typing typing FrozenSet8924741
Ref: 31c98924741
Ref: library/typing typing MappingView8924859
Ref: 31ca8924859
Ref: library/typing typing KeysView8924982
Ref: 31cb8924982
Ref: library/typing typing ItemsView8925116
Ref: 31cc8925116
Ref: library/typing typing ValuesView8925248
Ref: 31cd8925248
Ref: library/typing typing Awaitable8925366
Ref: 31ce8925366
Ref: library/typing typing Coroutine8925504
Ref: 31cf8925504
Ref: library/typing typing AsyncIterable8925981
Ref: 31d18925981
Ref: library/typing typing AsyncIterator8926127
Ref: 31d28926127
Ref: library/typing typing ContextManager8926279
Ref: 52a8926279
Ref: library/typing typing AsyncContextManager8926458
Ref: 31d38926458
Ref: library/typing typing Dict8926652
Ref: 31d48926652
Ref: library/typing typing DefaultDict8927006
Ref: 31d58927006
Ref: library/typing typing OrderedDict8927188
Ref: 31d68927188
Ref: library/typing typing Counter8927370
Ref: 31d78927370
Ref: library/typing typing ChainMap8927548
Ref: 31d88927548
Ref: library/typing typing Generator8927749
Ref: 31d08927749
Ref: library/typing typing AsyncGenerator8928784
Ref: 31d98928784
Ref: library/typing typing Text8929947
Ref: 31da8929947
Ref: library/typing typing IO8930411
Ref: 31db8930411
Ref: library/typing typing TextIO8930432
Ref: 31dc8930432
Ref: library/typing typing BinaryIO8930457
Ref: 31dd8930457
Ref: library/typing typing Pattern8930676
Ref: 31de8930676
Ref: library/typing typing Match8930702
Ref: 31df8930702
Ref: library/typing typing NamedTuple8931054
Ref: 27e8931054
Ref: library/typing typing TypedDict8932841
Ref: 2398932841
Ref: library/typing typing ForwardRef8934091
Ref: 31e08934091
Ref: library/typing typing NewType8934421
Ref: 59a8934421
Ref: library/typing typing cast8934726
Ref: 31e18934726
Ref: library/typing typing get_type_hints8935027
Ref: 2ff8935027
Ref: library/typing typing get_origin8935678
Ref: 2418935678
Ref: library/typing typing get_args8935716
Ref: 2428935716
Ref: library/typing typing overload8936387
Ref: 31e28936387
Ref: library/typing typing final8937555
Ref: 23c8937555
Ref: library/typing typing no_type_check8938125
Ref: 31e38938125
Ref: library/typing typing no_type_check_decorator8938481
Ref: 31e48938481
Ref: library/typing typing type_check_only8938733
Ref: 31e58938733
Ref: library/typing typing runtime_checkable8939368
Ref: 23e8939368
Ref: library/typing typing Any8940070
Ref: 6468940070
Ref: library/typing typing NoReturn8940260
Ref: 31e68940260
Ref: library/typing typing Union8940520
Ref: f6c8940520
Ref: library/typing typing Optional8941494
Ref: 31e78941494
Ref: library/typing typing Tuple8942164
Ref: 31a58942164
Ref: library/typing typing Callable8942802
Ref: 31a68942802
Ref: library/typing typing Literal8943566
Ref: 23a8943566
Ref: library/typing typing ClassVar8944372
Ref: 5988944372
Ref: library/typing typing Final8945419
Ref: 23b8945419
Ref: library/typing typing AnyStr8945923
Ref: 31e88945923
Ref: library/typing typing TYPE_CHECKING8946447
Ref: 5998946447
Ref: Classes functions and decorators-Footnote-18947159
Ref: Classes functions and decorators-Footnote-28947208
Ref: Classes functions and decorators-Footnote-38947257
Ref: Classes functions and decorators-Footnote-48947306
Ref: Classes functions and decorators-Footnote-58947355
Ref: Classes functions and decorators-Footnote-68947404
Ref: Classes functions and decorators-Footnote-78947453
Ref: Classes functions and decorators-Footnote-88947502
Ref: Classes functions and decorators-Footnote-98947551
Ref: Classes functions and decorators-Footnote-108947600
Ref: Classes functions and decorators-Footnote-118947650
Ref: Classes functions and decorators-Footnote-128947700
Node: pydoc — Documentation generator and online help system8947750
Ref: library/pydoc doc8947955
Ref: 31e98947955
Ref: library/pydoc module-pydoc8947955
Ref: d98947955
Ref: library/pydoc pydoc-documentation-generator-and-online-help-system8947955
Ref: 31ea8947955
Ref: pydoc — Documentation generator and online help system-Footnote-18952849
Node: doctest — Test interactive Python examples8952913
Ref: library/doctest doc8953120
Ref: 31ec8953120
Ref: library/doctest doctest-test-interactive-python-examples8953120
Ref: 31ed8953120
Ref: library/doctest module-doctest8953120
Ref: 678953120
Ref: doctest — Test interactive Python examples-Footnote-18956896
Node: Simple Usage Checking Examples in Docstrings8956962
Ref: library/doctest doctest-simple-testmod8957141
Ref: 31ee8957141
Ref: library/doctest simple-usage-checking-examples-in-docstrings8957141
Ref: 31ef8957141
Node: Simple Usage Checking Examples in a Text File8958907
Ref: library/doctest doctest-simple-testfile8959107
Ref: 31f18959107
Ref: library/doctest simple-usage-checking-examples-in-a-text-file8959107
Ref: 31f28959107
Node: How It Works8961373
Ref: library/doctest doctest-how-it-works8961538
Ref: 31f48961538
Ref: library/doctest how-it-works8961538
Ref: 31f58961538
Node: Which Docstrings Are Examined?8962193
Ref: library/doctest doctest-which-docstrings8962319
Ref: 31f68962319
Ref: library/doctest which-docstrings-are-examined8962319
Ref: 31f78962319
Node: How are Docstring Examples Recognized?8963166
Ref: library/doctest doctest-finding-examples8963332
Ref: 31f88963332
Ref: library/doctest how-are-docstring-examples-recognized8963332
Ref: 31f98963332
Node: What’s the Execution Context?8966260
Ref: library/doctest doctest-execution-context8966418
Ref: 31fd8966418
Ref: library/doctest what-s-the-execution-context8966418
Ref: 31fe8966418
Node: What About Exceptions?8967135
Ref: library/doctest doctest-exceptions8967267
Ref: 31ff8967267
Ref: library/doctest what-about-exceptions8967267
Ref: 32008967267
Ref: library/doctest option-flags-and-directives8971615
Ref: 32028971615
Ref: What About Exceptions?-Footnote-18971652
Node: Option Flags8971856
Ref: library/doctest doctest-options8971967
Ref: 8308971967
Ref: library/doctest option-flags8971967
Ref: 32038971967
Ref: library/doctest doctest DONT_ACCEPT_TRUE_FOR_18972585
Ref: 32048972585
Ref: library/doctest doctest DONT_ACCEPT_BLANKLINE8973213
Ref: 32058973213
Ref: library/doctest doctest NORMALIZE_WHITESPACE8973666
Ref: 31fa8973666
Ref: library/doctest doctest ELLIPSIS8974156
Ref: dc48974156
Ref: library/doctest doctest IGNORE_EXCEPTION_DETAIL8974592
Ref: 32018974592
Ref: library/doctest doctest SKIP8976556
Ref: 32068976556
Ref: library/doctest doctest COMPARISON_FLAGS8977070
Ref: 32078977070
Ref: library/doctest doctest REPORT_UDIFF8977242
Ref: dc58977242
Ref: library/doctest doctest REPORT_CDIFF8977398
Ref: dc68977398
Ref: library/doctest doctest REPORT_NDIFF8977558
Ref: dc78977558
Ref: library/doctest doctest REPORT_ONLY_FIRST_FAILURE8978022
Ref: 32088978022
Ref: library/doctest doctest FAIL_FAST8978601
Ref: 8318978601
Ref: library/doctest doctest REPORTING_FLAGS8979068
Ref: 32098979068
Ref: library/doctest doctest register_optionflag8979325
Ref: 320a8979325
Node: Directives8979815
Ref: library/doctest directives8979915
Ref: 320d8979915
Ref: library/doctest doctest-directives8979915
Ref: 31fb8979915
Ref: library/doctest grammar-token-directive8980140
Ref: 320e8980140
Ref: library/doctest grammar-token-directive-options8980204
Ref: 320f8980204
Ref: library/doctest grammar-token-directive-option8980277
Ref: 32108980277
Ref: library/doctest grammar-token-on-or-off8980340
Ref: 32118980340
Ref: library/doctest grammar-token-directive-option-name8980382
Ref: 32128980382
Node: Warnings<2>8982273
Ref: library/doctest doctest-warnings8982352
Ref: 32138982352
Ref: library/doctest warnings8982352
Ref: 32148982352
Node: Basic API8984167
Ref: library/doctest basic-api8984299
Ref: 32158984299
Ref: library/doctest doctest-basic-api8984299
Ref: 31f08984299
Ref: library/doctest doctest testfile8984682
Ref: 31f38984682
Ref: library/doctest doctest testmod8988614
Ref: dc38988614
Ref: library/doctest doctest run_docstring_examples8990360
Ref: 32178990360
Node: Unittest API8991338
Ref: library/doctest doctest-unittest-api8991470
Ref: 32188991470
Ref: library/doctest unittest-api8991470
Ref: 32198991470
Ref: library/doctest doctest DocFileSuite8992215
Ref: 321a8992215
Ref: library/doctest doctest DocTestSuite8995939
Ref: 6c18995939
Ref: library/doctest doctest set_unittest_reportflags8999089
Ref: 321c8999089
Node: Advanced API9000285
Ref: library/doctest advanced-api9000417
Ref: 321d9000417
Ref: library/doctest doctest-advanced-api9000417
Ref: 321e9000417
Node: DocTest Objects9002523
Ref: library/doctest doctest-doctest9002611
Ref: 32209002611
Ref: library/doctest doctest-objects9002611
Ref: 32219002611
Ref: library/doctest doctest DocTest9002664
Ref: 321b9002664
Ref: library/doctest doctest DocTest examples9003080
Ref: 32229003080
Ref: library/doctest doctest DocTest globs9003255
Ref: 32239003255
Ref: library/doctest doctest DocTest name9003590
Ref: 32249003590
Ref: library/doctest doctest DocTest filename9003783
Ref: 32259003783
Ref: library/doctest doctest DocTest lineno9004020
Ref: 32269004020
Ref: library/doctest doctest DocTest docstring9004298
Ref: 32279004298
Node: Example Objects9004497
Ref: library/doctest doctest-example9004615
Ref: 32289004615
Ref: library/doctest example-objects9004615
Ref: 32299004615
Ref: library/doctest doctest Example9004668
Ref: 321f9004668
Ref: library/doctest doctest Example source9005107
Ref: 322a9005107
Ref: library/doctest doctest Example want9005351
Ref: 322b9005351
Ref: library/doctest doctest Example exc_msg9005702
Ref: 322c9005702
Ref: library/doctest doctest Example lineno9006187
Ref: 322e9006187
Ref: library/doctest doctest Example indent9006418
Ref: 322f9006418
Ref: library/doctest doctest Example options9006611
Ref: 32309006611
Node: DocTestFinder objects9007007
Ref: library/doctest doctest-doctestfinder9007131
Ref: 32319007131
Ref: library/doctest doctestfinder-objects9007131
Ref: 32329007131
Ref: library/doctest doctest DocTestFinder9007196
Ref: 32169007196
Ref: library/doctest doctest DocTestFinder find9008335
Ref: 32339008335
Node: DocTestParser objects9010454
Ref: library/doctest doctest-doctestparser9010584
Ref: 32349010584
Ref: library/doctest doctestparser-objects9010584
Ref: 32359010584
Ref: library/doctest doctest DocTestParser9010649
Ref: 31fc9010649
Ref: library/doctest doctest DocTestParser get_doctest9010883
Ref: 32369010883
Ref: library/doctest doctest DocTestParser get_examples9011278
Ref: 32379011278
Ref: library/doctest doctest DocTestParser parse9011616
Ref: 32389011616
Node: DocTestRunner objects9012012
Ref: library/doctest doctest-doctestrunner9012142
Ref: 32399012142
Ref: library/doctest doctestrunner-objects9012142
Ref: 323a9012142
Ref: library/doctest doctest DocTestRunner9012207
Ref: 320c9012207
Ref: library/doctest doctest DocTestRunner report_start9014315
Ref: 323b9014315
Ref: library/doctest doctest DocTestRunner report_success9014814
Ref: 323c9014814
Ref: library/doctest doctest DocTestRunner report_failure9015347
Ref: 323e9015347
Ref: library/doctest doctest DocTestRunner report_unexpected_exception9015870
Ref: 323d9015870
Ref: library/doctest doctest DocTestRunner run9016545
Ref: 323f9016545
Ref: library/doctest doctest DocTestRunner summarize9017561
Ref: 32409017561
Node: OutputChecker objects9017986
Ref: library/doctest doctest-outputchecker9018086
Ref: 32419018086
Ref: library/doctest outputchecker-objects9018086
Ref: 32429018086
Ref: library/doctest doctest OutputChecker9018151
Ref: 320b9018151
Ref: library/doctest doctest OutputChecker check_output9018647
Ref: 32439018647
Ref: library/doctest doctest OutputChecker output_difference9019134
Ref: 32449019134
Node: Debugging9019449
Ref: library/doctest debugging9019576
Ref: 32459019576
Ref: library/doctest doctest-debugging9019576
Ref: 32469019576
Ref: library/doctest doctest script_from_examples9021315
Ref: 32499021315
Ref: library/doctest doctest testsource9022172
Ref: 324a9022172
Ref: library/doctest doctest debug9022959
Ref: 32489022959
Ref: library/doctest doctest debug_src9024049
Ref: 324c9024049
Ref: library/doctest doctest DebugRunner9024923
Ref: 32479024923
Ref: library/doctest doctest DocTestFailure9025700
Ref: 324e9025700
Ref: library/doctest doctest DocTestFailure test9026063
Ref: 324f9026063
Ref: library/doctest doctest DocTestFailure example9026186
Ref: 32509026186
Ref: library/doctest doctest DocTestFailure got9026269
Ref: 32519026269
Ref: library/doctest doctest UnexpectedException9026341
Ref: 324d9026341
Ref: library/doctest doctest UnexpectedException test9026694
Ref: 32529026694
Ref: library/doctest doctest UnexpectedException example9026822
Ref: 32539026822
Ref: library/doctest doctest UnexpectedException exc_info9026910
Ref: 32549026910
Node: Soapbox9027071
Ref: library/doctest doctest-soapbox9027177
Ref: 32559027177
Ref: library/doctest soapbox9027177
Ref: 32569027177
Node: unittest — Unit testing framework9030956
Ref: library/unittest doc9031144
Ref: 32579031144
Ref: library/unittest module-unittest9031144
Ref: 11b9031144
Ref: library/unittest unittest-unit-testing-framework9031144
Ref: 32589031144
Ref: unittest — Unit testing framework-Footnote-19034282
Ref: unittest — Unit testing framework-Footnote-29034359
Ref: unittest — Unit testing framework-Footnote-39034452
Ref: unittest — Unit testing framework-Footnote-49034485
Ref: unittest — Unit testing framework-Footnote-59034549
Ref: unittest — Unit testing framework-Footnote-69034607
Ref: unittest — Unit testing framework-Footnote-79034637
Ref: unittest — Unit testing framework-Footnote-89034665
Node: Basic example9034695
Ref: library/unittest basic-example9034814
Ref: 325a9034814
Ref: library/unittest unittest-minimal-example9034814
Ref: 325b9034814
Node: Command-Line Interface<3>9037508
Ref: library/unittest command-line-interface9037650
Ref: 325d9037650
Ref: library/unittest unittest-command-line-interface9037650
Ref: 325e9037650
Node: Command-line options<3>9039036
Ref: library/unittest command-line-options9039121
Ref: 32609039121
Ref: library/unittest cmdoption-unittest-b9039235
Ref: cb69039235
Ref: library/unittest cmdoption-unittest-c9039502
Ref: cb79039502
Ref: library/unittest cmdoption-unittest-f9039842
Ref: cb99039842
Ref: library/unittest cmdoption-unittest-k9039933
Ref: 32629039933
Ref: library/unittest cmdoption-unittest-locals9040649
Ref: 32639040649
Node: Test Discovery9041042
Ref: library/unittest test-discovery9041191
Ref: 32649041191
Ref: library/unittest unittest-test-discovery9041191
Ref: 325f9041191
Ref: library/unittest cmdoption-unittest-discover-v9042083
Ref: 32659042083
Ref: library/unittest cmdoption-unittest-discover-s9042139
Ref: 32669042139
Ref: library/unittest cmdoption-unittest-discover-p9042245
Ref: 32679042245
Ref: library/unittest cmdoption-unittest-discover-t9042347
Ref: 32689042347
Node: Organizing test code9043972
Ref: library/unittest organizing-test-code9044118
Ref: 326a9044118
Ref: library/unittest organizing-tests9044118
Ref: 325c9044118
Node: Re-using old test code9048742
Ref: library/unittest legacy-unit-tests9048910
Ref: 326c9048910
Ref: library/unittest re-using-old-test-code9048910
Ref: 326d9048910
Node: Skipping tests and expected failures9050425
Ref: library/unittest skipping-tests-and-expected-failures9050618
Ref: 326e9050618
Ref: library/unittest unittest-skipping9050618
Ref: 326f9050618
Ref: library/unittest unittest skip9053544
Ref: eb19053544
Ref: library/unittest unittest skipIf9053692
Ref: 32729053692
Ref: library/unittest unittest skipUnless9053798
Ref: 32739053798
Ref: library/unittest unittest expectedFailure9053912
Ref: 32719053912
Ref: library/unittest unittest SkipTest9054113
Ref: 8f79054113
Node: Distinguishing test iterations using subtests9054601
Ref: library/unittest distinguishing-test-iterations-using-subtests9054793
Ref: 32749054793
Ref: library/unittest subtests9054793
Ref: 8f59054793
Node: Classes and functions9056922
Ref: library/unittest classes-and-functions9057103
Ref: 32759057103
Ref: library/unittest unittest-contents9057103
Ref: 32769057103
Node: Test cases9057305
Ref: library/unittest test-cases9057396
Ref: 32779057396
Ref: library/unittest testcase-objects9057396
Ref: 32789057396
Ref: library/unittest unittest TestCase9057439
Ref: 8f39057439
Ref: library/unittest unittest TestCase setUp9058761
Ref: cbe9058761
Ref: library/unittest unittest TestCase tearDown9059138
Ref: cbf9059138
Ref: library/unittest unittest TestCase setUpClass9059911
Ref: 24a9059911
Ref: library/unittest unittest TestCase tearDownClass9060320
Ref: cbc9060320
Ref: library/unittest unittest TestCase run9060738
Ref: ab39060738
Ref: library/unittest unittest TestCase skipTest9061365
Ref: 32709061365
Ref: library/unittest unittest TestCase subTest9061621
Ref: 8f49061621
Ref: library/unittest unittest TestCase debug9062176
Ref: f5f9062176
Ref: library/unittest assert-methods9062411
Ref: 32599062411
Ref: library/unittest unittest TestCase assertEqual9066258
Ref: ba89066258
Ref: library/unittest unittest TestCase assertNotEqual9067128
Ref: ba99067128
Ref: library/unittest unittest TestCase assertTrue9067307
Ref: ba79067307
Ref: library/unittest unittest TestCase assertFalse9067352
Ref: cba9067352
Ref: library/unittest unittest TestCase assertIs9067853
Ref: cc29067853
Ref: library/unittest unittest TestCase assertIsNot9067905
Ref: cc39067905
Ref: library/unittest unittest TestCase assertIsNone9068095
Ref: cc09068095
Ref: library/unittest unittest TestCase assertIsNotNone9068142
Ref: cc19068142
Ref: library/unittest unittest TestCase assertIn9068279
Ref: ccb9068279
Ref: library/unittest unittest TestCase assertNotIn9068331
Ref: ccc9068331
Ref: library/unittest unittest TestCase assertIsInstance9068475
Ref: cc49068475
Ref: library/unittest unittest TestCase assertNotIsInstance9068530
Ref: cc59068530
Ref: library/unittest unittest TestCase assertRaises9071203
Ref: aaf9071203
Ref: library/unittest unittest TestCase assertRaisesRegex9072870
Ref: ab09072870
Ref: library/unittest unittest TestCase assertWarns9073837
Ref: ab19073837
Ref: library/unittest unittest TestCase assertWarnsRegex9075488
Ref: ab29075488
Ref: library/unittest unittest TestCase assertLogs9076378
Ref: 8f99076378
Ref: library/unittest unittest TestCase records9077360
Ref: 327c9077360
Ref: library/unittest unittest TestCase output9077503
Ref: 327d9077503
Ref: library/unittest unittest TestCase assertAlmostEqual9080768
Ref: baa9080768
Ref: library/unittest unittest TestCase assertNotAlmostEqual9080866
Ref: bab9080866
Ref: library/unittest unittest TestCase assertGreater9081937
Ref: cc69081937
Ref: library/unittest unittest TestCase assertGreaterEqual9081994
Ref: cc79081994
Ref: library/unittest unittest TestCase assertLess9082056
Ref: cc89082056
Ref: library/unittest unittest TestCase assertLessEqual9082110
Ref: cc99082110
Ref: library/unittest unittest TestCase assertRegex9082460
Ref: ba49082460
Ref: library/unittest unittest TestCase assertNotRegex9082513
Ref: 327e9082513
Ref: library/unittest unittest TestCase assertCountEqual9083386
Ref: ba29083386
Ref: library/unittest type-specific-methods9084047
Ref: 327b9084047
Ref: library/unittest unittest TestCase addTypeEqualityFunc9084365
Ref: cd49084365
Ref: library/unittest unittest TestCase assertMultiLineEqual9087109
Ref: cca9087109
Ref: library/unittest unittest TestCase assertSequenceEqual9087524
Ref: cd09087524
Ref: library/unittest unittest TestCase assertListEqual9088149
Ref: cce9088149
Ref: library/unittest unittest TestCase assertTupleEqual9088208
Ref: ccf9088208
Ref: library/unittest unittest TestCase assertSetEqual9088656
Ref: ccd9088656
Ref: library/unittest unittest TestCase assertDictEqual9089108
Ref: cd19089108
Ref: library/unittest other-methods-and-attrs9089466
Ref: 32809089466
Ref: library/unittest unittest TestCase fail9089557
Ref: 32819089557
Ref: library/unittest unittest TestCase failureException9089700
Ref: 327f9089700
Ref: library/unittest unittest TestCase longMessage9090115
Ref: cbb9090115
Ref: library/unittest unittest TestCase maxDiff9090853
Ref: ba39090853
Ref: library/unittest unittest TestCase countTestCases9091534
Ref: 32829091534
Ref: library/unittest unittest TestCase defaultTestResult9091716
Ref: 327a9091716
Ref: library/unittest unittest TestCase id9092146
Ref: 32839092146
Ref: library/unittest unittest TestCase shortDescription9092341
Ref: 32849092341
Ref: library/unittest unittest TestCase addCleanup9092961
Ref: 2a09092961
Ref: library/unittest unittest TestCase doCleanups9093561
Ref: cbd9093561
Ref: library/unittest unittest TestCase addClassCleanup9094199
Ref: 2499094199
Ref: library/unittest unittest TestCase doClassCleanups9094850
Ref: 32869094850
Ref: library/unittest unittest IsolatedAsyncioTestCase9095517
Ref: 24b9095517
Ref: library/unittest unittest IsolatedAsyncioTestCase asyncSetUp9095728
Ref: 32879095728
Ref: library/unittest unittest IsolatedAsyncioTestCase asyncTearDown9096167
Ref: 32889096167
Ref: library/unittest unittest IsolatedAsyncioTestCase addAsyncCleanup9097012
Ref: 32899097012
Ref: library/unittest unittest IsolatedAsyncioTestCase run9097170
Ref: 328a9097170
Ref: library/unittest unittest FunctionTestCase9098697
Ref: 326b9098697
Node: Deprecated aliases9099208
Ref: library/unittest deprecated-aliases9099273
Ref: bac9099273
Ref: library/unittest id19099273
Ref: 328b9099273
Node: Grouping tests9102402
Ref: library/unittest grouping-tests9102527
Ref: 328c9102527
Ref: library/unittest testsuite-objects9102527
Ref: 328d9102527
Ref: library/unittest unittest TestSuite9102578
Ref: 6c29102578
Ref: library/unittest unittest TestSuite addTest9103525
Ref: 328e9103525
Ref: library/unittest unittest TestSuite addTests9103645
Ref: 328f9103645
Ref: library/unittest unittest TestSuite run9104021
Ref: 32909104021
Ref: library/unittest unittest TestSuite debug9104323
Ref: 32919104323
Ref: library/unittest unittest TestSuite countTestCases9104596
Ref: 32929104596
Ref: library/unittest unittest TestSuite __iter__9104760
Ref: 9569104760
Node: Loading and running tests9106216
Ref: library/unittest loading-and-running-tests9106322
Ref: 32939106322
Ref: library/unittest unittest TestLoader9106395
Ref: 7769106395
Ref: library/unittest unittest TestLoader errors9106889
Ref: 7759106889
Ref: library/unittest unittest TestLoader loadTestsFromTestCase9107358
Ref: 32959107358
Ref: library/unittest unittest TestLoader loadTestsFromModule9107909
Ref: 7749107909
Ref: library/unittest unittest TestLoader loadTestsFromName9109414
Ref: cd29109414
Ref: library/unittest unittest TestLoader loadTestsFromNames9111214
Ref: 32979111214
Ref: library/unittest unittest TestLoader getTestCaseNames9111499
Ref: 32969111499
Ref: library/unittest unittest TestLoader discover9111702
Ref: 8f89111702
Ref: library/unittest unittest TestLoader testMethodPrefix9114509
Ref: 32989114509
Ref: library/unittest unittest TestLoader sortTestMethodsUsing9114798
Ref: 32999114798
Ref: library/unittest unittest TestLoader suiteClass9115012
Ref: cd39115012
Ref: library/unittest unittest TestLoader testNamePatterns9115309
Ref: 329a9115309
Ref: library/unittest unittest TestResult9116023
Ref: ab49116023
Ref: library/unittest unittest TestResult errors9116885
Ref: 329b9116885
Ref: library/unittest unittest TestResult failures9117115
Ref: 329c9117115
Ref: library/unittest unittest TestResult skipped9117404
Ref: 329d9117404
Ref: library/unittest unittest TestResult expectedFailures9117600
Ref: 329e9117600
Ref: library/unittest unittest TestResult unexpectedSuccesses9117833
Ref: 329f9117833
Ref: library/unittest unittest TestResult shouldStop9117998
Ref: 32a09117998
Ref: library/unittest unittest TestResult testsRun9118132
Ref: 32a29118132
Ref: library/unittest unittest TestResult buffer9118211
Ref: 32a39118211
Ref: library/unittest unittest TestResult failfast9118660
Ref: 32a69118660
Ref: library/unittest unittest TestResult tb_locals9118845
Ref: 32a79118845
Ref: library/unittest unittest TestResult wasSuccessful9118993
Ref: 32a89118993
Ref: library/unittest unittest TestResult stop9119330
Ref: 32a19119330
Ref: library/unittest unittest TestResult startTest9120289
Ref: 32a49120289
Ref: library/unittest unittest TestResult stopTest9120388
Ref: 32a59120388
Ref: library/unittest unittest TestResult startTestRun9120523
Ref: cd69120523
Ref: library/unittest unittest TestResult stopTestRun9120642
Ref: cd79120642
Ref: library/unittest unittest TestResult addError9120759
Ref: 32aa9120759
Ref: library/unittest unittest TestResult addFailure9121226
Ref: 32ab9121226
Ref: library/unittest unittest TestResult addSuccess9121684
Ref: 32ac9121684
Ref: library/unittest unittest TestResult addSkip9121826
Ref: 32ad9121826
Ref: library/unittest unittest TestResult addExpectedFailure9122122
Ref: 32ae9122122
Ref: library/unittest unittest TestResult addUnexpectedSuccess9122538
Ref: 32af9122538
Ref: library/unittest unittest TestResult addSubTest9122844
Ref: 32b09122844
Ref: library/unittest unittest TextTestResult9123516
Ref: 32859123516
Ref: library/unittest unittest defaultTestLoader9123838
Ref: 32949123838
Ref: library/unittest unittest TextTestRunner9124093
Ref: 32a99124093
Ref: library/unittest unittest TextTestRunner _makeResult9125695
Ref: 32b29125695
Ref: library/unittest unittest TextTestRunner run9126347
Ref: 32b39126347
Ref: library/unittest unittest main9126708
Ref: 8f69126708
Node: load_tests Protocol9129548
Ref: library/unittest load-tests-protocol9129629
Ref: 32699129629
Node: Class and Module Fixtures9132246
Ref: library/unittest class-and-module-fixtures9132397
Ref: 32799132397
Node: setUpClass and tearDownClass9134285
Ref: library/unittest setupclass-and-teardownclass9134414
Ref: 32b49134414
Node: setUpModule and tearDownModule9135293
Ref: library/unittest setupmodule-and-teardownmodule9135422
Ref: 32b59135422
Ref: library/unittest unittest addModuleCleanup9136020
Ref: 2489136020
Ref: library/unittest unittest doModuleCleanups9136598
Ref: 32b69136598
Node: Signal Handling9137211
Ref: library/unittest signal-handling9137332
Ref: 32619137332
Ref: library/unittest unittest installHandler9138553
Ref: 32b79138553
Ref: library/unittest unittest registerResult9138791
Ref: 32b89138791
Ref: library/unittest unittest removeResult9139285
Ref: 32b99139285
Ref: library/unittest unittest removeHandler9139507
Ref: cb89139507
Node: unittest mock — mock object library9139877
Ref: library/unittest mock doc9140054
Ref: 32ba9140054
Ref: library/unittest mock module-unittest mock9140054
Ref: 11c9140054
Ref: library/unittest mock unittest-mock-mock-object-library9140054
Ref: 32bb9140054
Ref: unittest mock — mock object library-Footnote-19141616
Ref: unittest mock — mock object library-Footnote-29141688
Node: Quick Guide9141726
Ref: library/unittest mock quick-guide9141834
Ref: 32bc9141834
Node: The Mock Class9146926
Ref: library/unittest mock the-mock-class9147055
Ref: 32c09147055
Ref: library/unittest mock unittest mock Mock9148083
Ref: 2479148083
Ref: library/unittest mock unittest mock Mock assert_called9151507
Ref: 59d9151507
Ref: library/unittest mock unittest mock Mock assert_called_once9151752
Ref: 59e9151752
Ref: library/unittest mock unittest mock Mock assert_called_with9152213
Ref: f339152213
Ref: library/unittest mock unittest mock Mock assert_called_once_with9152552
Ref: 32c79152552
Ref: library/unittest mock unittest mock Mock assert_any_call9153056
Ref: 32c89153056
Ref: library/unittest mock unittest mock Mock assert_has_calls9153676
Ref: 32c99153676
Ref: library/unittest mock unittest mock Mock assert_not_called9154401
Ref: 7789154401
Ref: library/unittest mock unittest mock Mock reset_mock9154746
Ref: 59f9154746
Ref: library/unittest mock unittest mock Mock mock_add_spec9155792
Ref: 32cb9155792
Ref: library/unittest mock unittest mock Mock attach_mock9156117
Ref: 32cc9156117
Ref: library/unittest mock unittest mock Mock configure_mock9156410
Ref: 32c69156410
Ref: library/unittest mock unittest mock Mock __dir__9157389
Ref: 32ce9157389
Ref: library/unittest mock unittest mock Mock _get_child_mock9157722
Ref: 32d09157722
Ref: library/unittest mock unittest mock Mock called9158122
Ref: 32d19158122
Ref: library/unittest mock unittest mock Mock call_count9158347
Ref: 32d29158347
Ref: library/unittest mock unittest mock Mock return_value9158588
Ref: 32c59158588
Ref: library/unittest mock unittest mock Mock side_effect9159229
Ref: 32c39159229
Ref: library/unittest mock unittest mock Mock call_args9161309
Ref: 32d39161309
Ref: library/unittest mock unittest mock Mock call_args_list9162709
Ref: 32d49162709
Ref: library/unittest mock unittest mock Mock method_calls9163630
Ref: 32cd9163630
Ref: library/unittest mock unittest mock Mock mock_calls9164277
Ref: 32ca9164277
Ref: library/unittest mock unittest mock Mock __class__9165499
Ref: 32d69165499
Ref: library/unittest mock unittest mock NonCallableMock9166197
Ref: 32c19166197
Ref: library/unittest mock unittest mock PropertyMock9168604
Ref: 32d79168604
Ref: library/unittest mock unittest mock AsyncMock9169793
Ref: 2469169793
Ref: library/unittest mock unittest mock AsyncMock assert_awaited9172409
Ref: 32d89172409
Ref: library/unittest mock unittest mock AsyncMock assert_awaited_once9172964
Ref: 32d99172964
Ref: library/unittest mock unittest mock AsyncMock assert_awaited_with9173379
Ref: 32da9173379
Ref: library/unittest mock unittest mock AsyncMock assert_awaited_once_with9173883
Ref: 32db9173883
Ref: library/unittest mock unittest mock AsyncMock assert_any_await9174458
Ref: 32dc9174458
Ref: library/unittest mock unittest mock AsyncMock assert_has_awaits9174951
Ref: 32dd9174951
Ref: library/unittest mock unittest mock AsyncMock assert_not_awaited9175851
Ref: 32df9175851
Ref: library/unittest mock unittest mock AsyncMock reset_mock9176011
Ref: 32e09176011
Ref: library/unittest mock unittest mock AsyncMock await_count9176242
Ref: 32e19176242
Ref: library/unittest mock unittest mock AsyncMock await_args9176553
Ref: 32e29176553
Ref: library/unittest mock unittest mock AsyncMock await_args_list9177022
Ref: 32de9177022
Ref: The Mock Class-Footnote-19177723
Node: Calling9178149
Ref: library/unittest mock calling9178235
Ref: 32e39178235
Node: Deleting Attributes9181162
Ref: library/unittest mock deleting-attributes9181290
Ref: 32e49181290
Ref: library/unittest mock id29181290
Ref: 32e59181290
Node: Mock names and the name attribute9182017
Ref: library/unittest mock mock-names-and-the-name-attribute9182167
Ref: 32e69182167
Node: Attaching Mocks as Attributes9182737
Ref: library/unittest mock attaching-mocks-as-attributes9182859
Ref: 32e79182859
Node: The patchers9184598
Ref: library/unittest mock the-patchers9184750
Ref: 32e89184750
Node: patch9185365
Ref: library/unittest mock patch9185440
Ref: 32e99185440
Ref: library/unittest mock unittest mock patch9185640
Ref: 77c9185640
Node: patch object9194186
Ref: library/unittest mock patch-object9194280
Ref: 32eb9194280
Ref: library/unittest mock unittest mock patch object9194325
Ref: e909194325
Node: patch dict9195774
Ref: library/unittest mock patch-dict9195877
Ref: 32ec9195877
Ref: library/unittest mock unittest mock patch dict9195920
Ref: f019195920
Node: patch multiple9199788
Ref: library/unittest mock patch-multiple9199907
Ref: 32ee9199907
Ref: library/unittest mock unittest mock patch multiple9199958
Ref: 32ef9199958
Node: patch methods start and stop9202561
Ref: library/unittest mock patch-methods-start-and-stop9202684
Ref: 32f09202684
Ref: library/unittest mock start-and-stop9202684
Ref: 32f19202684
Ref: library/unittest mock unittest mock patch stopall9205224
Ref: 32f29205224
Node: patch builtins9205333
Ref: library/unittest mock id49205453
Ref: 32f39205453
Ref: library/unittest mock patch-builtins9205453
Ref: 32f49205453
Node: TEST_PREFIX9205744
Ref: library/unittest mock id59205860
Ref: 32f59205860
Ref: library/unittest mock test-prefix9205860
Ref: 32ed9205860
Node: Nesting Patch Decorators9206663
Ref: library/unittest mock nesting-patch-decorators9206779
Ref: 32f69206779
Node: Where to patch9207641
Ref: library/unittest mock id69207784
Ref: 32ea9207784
Ref: library/unittest mock where-to-patch9207784
Ref: 32bd9207784
Node: Patching Descriptors and Proxy Objects9209530
Ref: library/unittest mock patching-descriptors-and-proxy-objects9209640
Ref: 32f79209640
Ref: Patching Descriptors and Proxy Objects-Footnote-19210081
Node: MagicMock and magic method support9210163
Ref: library/unittest mock magicmock-and-magic-method-support9210308
Ref: 32f89210308
Node: Mocking Magic Methods9210450
Ref: library/unittest mock magic-methods9210561
Ref: 32be9210561
Ref: library/unittest mock mocking-magic-methods9210561
Ref: 32f99210561
Ref: Mocking Magic Methods-Footnote-19214359
Ref: Mocking Magic Methods-Footnote-29214602
Node: Magic Mock9214727
Ref: library/unittest mock magic-mock9214838
Ref: 32fa9214838
Ref: library/unittest mock unittest mock MagicMock9214982
Ref: 7799214982
Ref: library/unittest mock unittest mock NonCallableMagicMock9215449
Ref: 32c29215449
Node: Helpers9218674
Ref: library/unittest mock helpers9218798
Ref: 32fb9218798
Node: sentinel9218971
Ref: library/unittest mock sentinel9219039
Ref: 32fc9219039
Ref: library/unittest mock unittest mock sentinel9219078
Ref: 3ff9219078
Node: DEFAULT9220223
Ref: library/unittest mock default9220304
Ref: 32fd9220304
Ref: library/unittest mock unittest mock DEFAULT9220341
Ref: 32c49220341
Node: call9220594
Ref: library/unittest mock call9220682
Ref: 32fe9220682
Ref: library/unittest mock unittest mock call9220713
Ref: eab9220713
Ref: library/unittest mock unittest mock call call_list9221212
Ref: 32ff9221212
Ref: library/unittest mock calls-as-tuples9222114
Ref: 32d59222114
Node: create_autospec9223630
Ref: library/unittest mock create-autospec9223714
Ref: 33009223714
Ref: library/unittest mock unittest mock create_autospec9223767
Ref: f149223767
Node: ANY9225064
Ref: library/unittest mock any9225154
Ref: 33019225154
Ref: library/unittest mock unittest mock ANY9225183
Ref: 33029225183
Node: FILTER_DIR9226029
Ref: library/unittest mock filter-dir9226113
Ref: 33039226113
Ref: library/unittest mock unittest mock FILTER_DIR9226156
Ref: 32cf9226156
Node: mock_open9228079
Ref: library/unittest mock mock-open9228172
Ref: 33049228172
Ref: library/unittest mock unittest mock mock_open9228213
Ref: ef99228213
Ref: mock_open-Footnote-19230945
Node: Autospeccing9230970
Ref: library/unittest mock auto-speccing9231066
Ref: 32bf9231066
Ref: library/unittest mock autospeccing9231066
Ref: 33059231066
Ref: Autospeccing-Footnote-19240217
Node: Sealing mocks9240462
Ref: library/unittest mock sealing-mocks9240540
Ref: 33069240540
Ref: library/unittest mock unittest mock seal9240589
Ref: 4009240589
Node: unittest mock — getting started9241341
Ref: library/unittest mock-examples doc9241530
Ref: 33079241530
Ref: library/unittest mock-examples unittest-mock-getting-started9241530
Ref: 33089241530
Ref: library/unittest mock-examples getting-started9241640
Ref: 33099241640
Node: Using Mock9241707
Ref: library/unittest mock-examples using-mock9241812
Ref: 330a9241812
Node: Mock Patching Methods9242228
Ref: library/unittest mock-examples mock-patching-methods9242339
Ref: 330b9242339
Node: Mock for Method Calls on an Object9243828
Ref: library/unittest mock-examples mock-for-method-calls-on-an-object9243963
Ref: 330c9243963
Node: Mocking Classes9245033
Ref: library/unittest mock-examples mocking-classes9245164
Ref: 330d9245164
Node: Naming your mocks9246121
Ref: library/unittest mock-examples naming-your-mocks9246236
Ref: 330e9246236
Node: Tracking all Calls9246648
Ref: library/unittest mock-examples tracking-all-calls9246784
Ref: 330f9246784
Node: Setting Return Values and Attributes9248130
Ref: library/unittest mock-examples setting-return-values-and-attributes9248278
Ref: 33109248278
Node: Raising exceptions with mocks9249688
Ref: library/unittest mock-examples raising-exceptions-with-mocks9249853
Ref: 33119249853
Node: Side effect functions and iterables9250213
Ref: library/unittest mock-examples side-effect-functions-and-iterables9250372
Ref: 33129250372
Node: Mocking asynchronous iterators9251342
Ref: library/unittest mock-examples mocking-asynchronous-iterators9251508
Ref: 33139251508
Node: Mocking asynchronous context manager9252051
Ref: library/unittest mock-examples mocking-asynchronous-context-manager9252221
Ref: 33149252221
Node: Creating a Mock from an Existing Object9253058
Ref: library/unittest mock-examples creating-a-mock-from-an-existing-object9253189
Ref: 33159253189
Node: Patch Decorators9254954
Ref: library/unittest mock-examples patch-decorators9255084
Ref: 33169255084
Node: Further Examples9260072
Ref: library/unittest mock-examples further-examples9260183
Ref: 33179260183
Ref: library/unittest mock-examples id19260183
Ref: 33189260183
Node: Mocking chained calls9260811
Ref: library/unittest mock-examples mocking-chained-calls9260909
Ref: 33199260909
Node: Partial mocking9263949
Ref: library/unittest mock-examples partial-mocking9264082
Ref: 331a9264082
Ref: Partial mocking-Footnote-19266060
Node: Mocking a Generator Method9266161
Ref: library/unittest mock-examples mocking-a-generator-method9266317
Ref: 331b9266317
Ref: Mocking a Generator Method-Footnote-19267401
Node: Applying the same patch to every test method9267725
Ref: library/unittest mock-examples applying-the-same-patch-to-every-test-method9267889
Ref: 331c9267889
Node: Mocking Unbound Methods9270032
Ref: library/unittest mock-examples mocking-unbound-methods9270203
Ref: 331d9270203
Node: Checking multiple calls with mock9271921
Ref: library/unittest mock-examples checking-multiple-calls-with-mock9272077
Ref: 331e9272077
Node: Coping with mutable arguments9273545
Ref: library/unittest mock-examples coping-with-mutable-arguments9273693
Ref: 331f9273693
Node: Nesting Patches9277528
Ref: library/unittest mock-examples nesting-patches9277678
Ref: 33209277678
Node: Mocking a dictionary with MagicMock9279330
Ref: library/unittest mock-examples mocking-a-dictionary-with-magicmock9279487
Ref: 33219279487
Node: Mock subclasses and their attributes9281958
Ref: library/unittest mock-examples mock-subclasses-and-their-attributes9282131
Ref: 33229282131
Ref: Mock subclasses and their attributes-Footnote-19284132
Ref: Mock subclasses and their attributes-Footnote-29284305
Ref: Mock subclasses and their attributes-Footnote-39284363
Node: Mocking imports with patch dict9284450
Ref: library/unittest mock-examples mocking-imports-with-patch-dict9284644
Ref: 33239284644
Node: Tracking order of calls and less verbose call assertions9287186
Ref: library/unittest mock-examples tracking-order-of-calls-and-less-verbose-call-assertions9287374
Ref: 33249287374
Node: More complex argument matching9290557
Ref: library/unittest mock-examples more-complex-argument-matching9290705
Ref: 33259290705
Ref: More complex argument matching-Footnote-19293601
Ref: More complex argument matching-Footnote-29293644
Node: 2to3 - Automated Python 2 to 3 code translation9293766
Ref: library/2to3 doc9293962
Ref: 33269293962
Ref: library/2to3 to3-automated-python-2-to-3-code-translation9293962
Ref: 33279293962
Ref: library/2to3 to3-reference9293962
Ref: c699293962
Node: Using 2to39294625
Ref: library/2to3 to3-using9294734
Ref: 33289294734
Ref: library/2to3 using-2to39294734
Ref: 33299294734
Node: Fixers9298947
Ref: library/2to3 fixers9299091
Ref: 332b9299091
Ref: library/2to3 to3-fixers9299091
Ref: 332a9299091
Ref: library/2to3 2to3fixer-apply9299342
Ref: 332c9299342
Ref: library/2to3 2to3fixer-asserts9299508
Ref: 332d9299508
Ref: library/2to3 2to3fixer-basestring9301773
Ref: 332e9301773
Ref: library/2to3 2to3fixer-buffer9301851
Ref: 332f9301851
Ref: library/2to3 2to3fixer-dict9302062
Ref: 33309302062
Ref: library/2to3 2to3fixer-except9302674
Ref: 33319302674
Ref: library/2to3 2to3fixer-exec9302754
Ref: 33329302754
Ref: library/2to3 2to3fixer-execfile9302851
Ref: f5b9302851
Ref: library/2to3 2to3fixer-exitfunc9303048
Ref: 33339303048
Ref: library/2to3 2to3fixer-filter9303164
Ref: 33349303164
Ref: library/2to3 2to3fixer-funcattrs9303254
Ref: 33359303254
Ref: library/2to3 2to3fixer-future9303438
Ref: 33369303438
Ref: library/2to3 2to3fixer-getcwdu9303528
Ref: 33379303528
Ref: library/2to3 2to3fixer-has_key9303612
Ref: 33389303612
Ref: library/2to3 2to3fixer-idioms9303696
Ref: 33399303696
Ref: library/2to3 2to3fixer-import9304220
Ref: 333a9304220
Ref: library/2to3 2to3fixer-imports9304312
Ref: 333b9304312
Ref: library/2to3 2to3fixer-imports29304390
Ref: 333c9304390
Ref: library/2to3 2to3fixer-input9304577
Ref: 333d9304577
Ref: library/2to3 2to3fixer-intern9304664
Ref: 333e9304664
Ref: library/2to3 2to3fixer-isinstance9304745
Ref: 333f9304745
Ref: library/2to3 2to3fixer-itertools_imports9305047
Ref: 33409305047
Ref: library/2to3 2to3fixer-itertools9305295
Ref: 33419305295
Ref: library/2to3 2to3fixer-long9305550
Ref: 33429305550
Ref: library/2to3 2to3fixer-map9305615
Ref: 33439305615
Ref: library/2to3 2to3fixer-metaclass9305823
Ref: 33449305823
Ref: library/2to3 2to3fixer-methodattrs9305985
Ref: 33459305985
Ref: library/2to3 2to3fixer-ne9306128
Ref: 33469306128
Ref: library/2to3 2to3fixer-next9306211
Ref: 33479306211
Ref: library/2to3 2to3fixer-nonzero9306408
Ref: 33489306408
Ref: library/2to3 2to3fixer-numliterals9306492
Ref: 33499306492
Ref: library/2to3 2to3fixer-operator9306571
Ref: 334a9306571
Ref: library/2to3 2to3fixer-paren9308254
Ref: 334b9308254
Ref: library/2to3 2to3fixer-print9308435
Ref: 334c9308435
Ref: library/2to3 2to3fixer-raise9308535
Ref: 334d9308535
Ref: library/2to3 2to3fixer-raw_input9308814
Ref: 334e9308814
Ref: library/2to3 2to3fixer-reduce9308896
Ref: 334f9308896
Ref: library/2to3 2to3fixer-reload9308994
Ref: f6b9308994
Ref: library/2to3 2to3fixer-renames9309081
Ref: 33509309081
Ref: library/2to3 2to3fixer-repr9309163
Ref: 33519309163
Ref: library/2to3 2to3fixer-set_literal9309251
Ref: 33529309251
Ref: library/2to3 2to3fixer-standarderror9309381
Ref: 33539309381
Ref: library/2to3 2to3fixer-sys_exc9309470
Ref: 33549309470
Ref: library/2to3 2to3fixer-throw9309627
Ref: 33559309627
Ref: library/2to3 2to3fixer-tuple_params9309715
Ref: 33569309715
Ref: library/2to3 2to3fixer-types9309840
Ref: 33579309840
Ref: library/2to3 2to3fixer-unicode9309957
Ref: 33589309957
Ref: library/2to3 2to3fixer-urllib9310028
Ref: 33599310028
Ref: library/2to3 2to3fixer-ws_comma9310156
Ref: 335a9310156
Ref: library/2to3 2to3fixer-xrange9310271
Ref: 335b9310271
Ref: library/2to3 2to3fixer-xreadlines9310418
Ref: 335c9310418
Ref: library/2to3 2to3fixer-zip9310516
Ref: 335d9310516
Node: lib2to3 - 2to3’s library9310675
Ref: library/2to3 lib2to3-2to3-s-library9310800
Ref: 335e9310800
Ref: library/2to3 module-lib2to39310800
Ref: a79310800
Ref: lib2to3 - 2to3’s library-Footnote-19311131
Node: test — Regression tests package for Python9311195
Ref: library/test doc9311410
Ref: 335f9311410
Ref: library/test module-test9311410
Ref: 1059311410
Ref: library/test test-regression-tests-package-for-python9311410
Ref: 33609311410
Node: Writing Unit Tests for the test package9312840
Ref: library/test writing-tests9313015
Ref: 33619313015
Ref: library/test writing-unit-tests-for-the-test-package9313015
Ref: 33629313015
Node: Running tests using the command-line interface9317375
Ref: library/test regrtest9317550
Ref: 9219317550
Ref: library/test running-tests-using-the-command-line-interface9317550
Ref: 33639317550
Node: test support — Utilities for the Python test suite9319488
Ref: library/test module-test support9319727
Ref: 1069319727
Ref: library/test test-support-utilities-for-the-python-test-suite9319727
Ref: 33649319727
Ref: library/test test support TestFailed9320235
Ref: 33659320235
Ref: library/test test support ResourceDenied9320455
Ref: 33669320455
Ref: library/test test support verbose9320749
Ref: 33689320749
Ref: library/test test support is_jython9320965
Ref: 33699320965
Ref: library/test test support is_android9321054
Ref: 336a9321054
Ref: library/test test support unix_shell9321132
Ref: 336b9321132
Ref: library/test test support FS_NONASCII9321229
Ref: 336c9321229
Ref: library/test test support TESTFN9321332
Ref: 336d9321332
Ref: library/test test support TESTFN_UNICODE9321522
Ref: 336e9321522
Ref: library/test test support TESTFN_ENCODING9321613
Ref: 336f9321613
Ref: library/test test support TESTFN_UNENCODABLE9321706
Ref: 33709321706
Ref: library/test test support TESTFN_UNDECODABLE9321946
Ref: 33719321946
Ref: library/test test support TESTFN_NONASCII9322188
Ref: 33729322188
Ref: library/test test support IPV6_ENABLED9322308
Ref: 33739322308
Ref: library/test test support SAVEDCWD9322425
Ref: 33749322425
Ref: library/test test support PGO9322495
Ref: 33759322495
Ref: library/test test support PIPE_MAX_SIZE9322593
Ref: 33769322593
Ref: library/test test support SOCK_MAX_SIZE9322741
Ref: 33779322741
Ref: library/test test support TEST_SUPPORT_DIR9322891
Ref: 33789322891
Ref: library/test test support TEST_HOME_DIR9323013
Ref: 33799323013
Ref: library/test test support TEST_DATA_DIR9323110
Ref: 337a9323110
Ref: library/test test support MAX_Py_ssize_t9323211
Ref: 337b9323211
Ref: library/test test support max_memuse9323309
Ref: 337c9323309
Ref: library/test test support real_max_memuse9323472
Ref: 337e9323472
Ref: library/test test support MISSING_C_DOCSTRINGS9323644
Ref: 337f9323644
Ref: library/test test support HAVE_DOCSTRINGS9323812
Ref: 33809323812
Ref: library/test test support TEST_HTTP_URL9323892
Ref: 33819323892
Ref: library/test test support ALWAYS_EQ9324001
Ref: 33829324001
Ref: library/test test support LARGEST9324117
Ref: 33839324117
Ref: library/test test support SMALLEST9324251
Ref: 33849324251
Ref: library/test test support forget9324453
Ref: 33859324453
Ref: library/test test support unload9324624
Ref: 33869324624
Ref: library/test test support unlink9324710
Ref: 33879324710
Ref: library/test test support rmdir9324915
Ref: 33889324915
Ref: library/test test support rmtree9325118
Ref: 33899325118
Ref: library/test test support make_legacy_pyc9325417
Ref: 338a9325417
Ref: library/test test support is_resource_enabled9325752
Ref: 338b9325752
Ref: library/test test support python_is_optimized9325979
Ref: 338c9325979
Ref: library/test test support with_pymalloc9326107
Ref: 338d9326107
Ref: library/test test support requires9326196
Ref: 33679326196
Ref: library/test test support system_must_validate_cert9326563
Ref: 338e9326563
Ref: library/test test support sortdict9326710
Ref: 338f9326710
Ref: library/test test support findfile9326802
Ref: 33909326802
Ref: library/test test support create_empty_file9327174
Ref: 33919327174
Ref: library/test test support fd_count9327316
Ref: 33929327316
Ref: library/test test support match_test9327405
Ref: 33939327405
Ref: library/test test support set_match_tests9327520
Ref: 33949327520
Ref: library/test test support run_unittest9327635
Ref: f7b9327635
Ref: library/test test support run_doctest9328287
Ref: 33959328287
Ref: library/test test support setswitchinterval9328754
Ref: 33969328754
Ref: library/test test support check_impl_detail9328980
Ref: 33979328980
Ref: library/test test support check_warnings9329372
Ref: 33989329372
Ref: library/test test support check_no_resource_warning9332308
Ref: 339b9332308
Ref: library/test test support set_memlimit9332572
Ref: 337d9332572
Ref: library/test test support record_original_stdout9332730
Ref: 339c9332730
Ref: library/test test support get_original_stdout9332896
Ref: 339d9332896
Ref: library/test test support strip_python_strerr9333069
Ref: 339e9333069
Ref: library/test test support args_from_interpreter_flags9333326
Ref: 339f9333326
Ref: library/test test support optim_args_from_interpreter_flags9333515
Ref: 33a09333515
Ref: library/test test support captured_stdin9333697
Ref: 33a19333697
Ref: library/test test support captured_stdout9333742
Ref: 33a29333742
Ref: library/test test support captured_stderr9333788
Ref: f049333788
Ref: library/test test support temp_dir9334423
Ref: 33a39334423
Ref: library/test test support change_cwd9334866
Ref: 33a49334866
Ref: library/test test support temp_cwd9335225
Ref: 33a59335225
Ref: library/test test support temp_umask9335863
Ref: 33a69335863
Ref: library/test test support transient_internet9335975
Ref: 33a79335975
Ref: library/test test support disable_faulthandler9336234
Ref: 33a89336234
Ref: library/test test support gc_collect9336368
Ref: 33a99336368
Ref: library/test test support disable_gc9336704
Ref: 33aa9336704
Ref: library/test test support swap_attr9336850
Ref: 33ab9336850
Ref: library/test test support swap_item9337426
Ref: 33ac9337426
Ref: library/test test support wait_threads_exit9338000
Ref: 33ad9338000
Ref: library/test test support start_threads9338156
Ref: 33ae9338156
Ref: library/test test support calcobjsize9338312
Ref: 33af9338312
Ref: library/test test support calcvobjsize9338484
Ref: 33b09338484
Ref: library/test test support checksizeof9338659
Ref: 33b19338659
Ref: library/test test support can_symlink9338830
Ref: 33b29338830
Ref: library/test test support can_xattr9338955
Ref: 33b39338955
Ref: library/test test support skip_unless_symlink9339069
Ref: 33b49339069
Ref: library/test test support skip_unless_xattr9339200
Ref: 33b59339200
Ref: library/test test support skip_unless_bind_unix_socket9339315
Ref: 33b69339315
Ref: library/test test support anticipate_failure9339465
Ref: 33b79339465
Ref: library/test test support run_with_locale9339727
Ref: 33b89339727
Ref: library/test test support run_with_tz9340087
Ref: 33b99340087
Ref: library/test test support requires_freebsd_version9340249
Ref: 33ba9340249
Ref: library/test test support requires_linux_version9340483
Ref: 33bb9340483
Ref: library/test test support requires_mac_version9340712
Ref: 33bc9340712
Ref: library/test test support requires_IEEE_7549340944
Ref: 33bd9340944
Ref: library/test test support requires_zlib9341053
Ref: 33be9341053
Ref: library/test test support requires_gzip9341168
Ref: 33bf9341168
Ref: library/test test support requires_bz29341282
Ref: 33c09341282
Ref: library/test test support requires_lzma9341394
Ref: 33c19341394
Ref: library/test test support requires_resource9341508
Ref: 33c29341508
Ref: library/test test support requires_docstrings9341633
Ref: 33c39341633
Ref: library/test test support cpython_only9341756
Ref: 33c49341756
Ref: library/test test support impl_detail9341859
Ref: 33c59341859
Ref: library/test test support no_tracing9342089
Ref: 33c69342089
Ref: library/test test support refcount_test9342219
Ref: 33c79342219
Ref: library/test test support reap_threads9342530
Ref: 33c89342530
Ref: library/test test support bigmemtest9342661
Ref: 33c99342661
Ref: library/test test support bigaddrspacetest9343408
Ref: 33ca9343408
Ref: library/test test support make_bad_fd9343548
Ref: 33cb9343548
Ref: library/test test support check_syntax_error9343707
Ref: 33cc9343707
Ref: library/test test support check_syntax_warning9344261
Ref: f379344261
Ref: library/test test support open_urlresource9345062
Ref: 33cd9345062
Ref: library/test test support import_module9345191
Ref: 33ce9345191
Ref: library/test test support import_fresh_module9345795
Ref: 33cf9345795
Ref: library/test test support modules_setup9347346
Ref: 33d09347346
Ref: library/test test support modules_cleanup9347439
Ref: 33d19347439
Ref: library/test test support threading_setup9347603
Ref: 33d29347603
Ref: library/test test support threading_cleanup9347714
Ref: 33d39347714
Ref: library/test test support join_thread9347925
Ref: 33d49347925
Ref: library/test test support reap_children9348120
Ref: 33d59348120
Ref: library/test test support get_attribute9348394
Ref: 33d69348394
Ref: library/test test support bind_port9348556
Ref: 33d79348556
Ref: library/test test support bind_unix_socket9349486
Ref: 33d89349486
Ref: library/test test support catch_threading_exception9349655
Ref: ed49349655
Ref: library/test test support catch_unraisable_exception9350509
Ref: ee39350509
Ref: library/test test support find_unused_port9351335
Ref: 33d99351335
Ref: library/test test support load_package_tests9352643
Ref: 33da9352643
Ref: library/test test support fs_is_case_insensitive9353243
Ref: 33db9353243
Ref: library/test test support detect_api_mismatch9353391
Ref: 33dc9353391
Ref: library/test test support patch9353860
Ref: 33dd9353860
Ref: library/test test support run_in_subinterp9354196
Ref: 33de9354196
Ref: library/test test support check_free_after_iterating9354365
Ref: 33df9354365
Ref: library/test test support missing_compiler_executable9354514
Ref: 33e09354514
Ref: library/test test support check__all__9354836
Ref: 33e19354836
Ref: library/test test support TransientResource9356570
Ref: 33e29356570
Ref: library/test test support EnvironmentVarGuard9357026
Ref: 33e39357026
Ref: library/test test support EnvironmentVarGuard set9357484
Ref: 33e49357484
Ref: library/test test support EnvironmentVarGuard unset9357631
Ref: 33e59357631
Ref: library/test test support SuppressCrashReport9357742
Ref: 33e69357742
Ref: library/test test support CleanImport9358244
Ref: 33e99358244
Ref: library/test test support DirsOnSysPath9358593
Ref: 33ea9358593
Ref: library/test test support SaveSignals9359084
Ref: 33eb9359084
Ref: library/test test support Matcher9359215
Ref: 33ec9359215
Ref: library/test test support Matcher matches9359248
Ref: 33ed9359248
Ref: library/test test support Matcher match_value9359361
Ref: 33ee9359361
Ref: library/test test support WarningsRecorder9359500
Ref: 33ef9359500
Ref: library/test test support BasicTestRunner9359675
Ref: 33f09359675
Ref: library/test test support BasicTestRunner run9359716
Ref: 33f19359716
Ref: library/test test support TestHandler9359790
Ref: 33f29359790
Ref: library/test test support FakePath9359896
Ref: 33f39359896
Ref: test support — Utilities for the Python test suite-Footnote-19360179
Ref: test support — Utilities for the Python test suite-Footnote-29360228
Ref: test support — Utilities for the Python test suite-Footnote-39360277
Node: test support script_helper — Utilities for the Python execution tests9360357
Ref: library/test module-test support script_helper9360543
Ref: 1079360543
Ref: library/test test-support-script-helper-utilities-for-the-python-execution-tests9360543
Ref: 33f49360543
Ref: library/test test support script_helper interpreter_requires_environment9360817
Ref: 33f59360817
Ref: library/test test support script_helper run_python_until_end9361792
Ref: 33f69361792
Ref: library/test test support script_helper assert_python_ok9362078
Ref: 33f79362078
Ref: library/test test support script_helper assert_python_failure9362592
Ref: 33f89362592
Ref: library/test test support script_helper spawn_python9362934
Ref: 33f99362934
Ref: library/test test support script_helper kill_python9363247
Ref: 33fa9363247
Ref: library/test test support script_helper make_script9363403
Ref: 33fb9363403
Ref: library/test test support script_helper make_zip_script9363712
Ref: 33fc9363712
Ref: library/test test support script_helper make_pkg9364081
Ref: 33fd9364081
Ref: library/test test support script_helper make_zip_pkg9364284
Ref: 33fe9364284
Node: Debugging and Profiling9364941
Ref: library/debug doc9365098
Ref: 33ff9365098
Ref: library/debug debugging-and-profiling9365098
Ref: 34009365098
Ref: library/audit_events audit-events9365556
Ref: 34019365556
Node: Audit events table9365888
Ref: library/audit_events doc9366001
Ref: 34029366001
Ref: library/audit_events audit-events-table9366001
Ref: 34039366001
Node: bdb — Debugger framework9399706
Ref: library/bdb doc9399870
Ref: 34259399870
Ref: library/bdb bdb-debugger-framework9399870
Ref: 34269399870
Ref: library/bdb module-bdb9399870
Ref: f9399870
Ref: library/bdb bdb BdbQuit9400205
Ref: 34279400205
Ref: library/bdb bdb Breakpoint9400369
Ref: 34289400369
Ref: library/bdb bdb Breakpoint deleteMe9401237
Ref: 34299401237
Ref: library/bdb bdb Breakpoint enable9401453
Ref: 342a9401453
Ref: library/bdb bdb Breakpoint disable9401524
Ref: 342b9401524
Ref: library/bdb bdb Breakpoint bpformat9401597
Ref: 342c9401597
Ref: library/bdb bdb Breakpoint bpprint9402031
Ref: 342d9402031
Ref: library/bdb bdb Bdb9402196
Ref: c8b9402196
Ref: library/bdb bdb Bdb canonic9402981
Ref: 342e9402981
Ref: library/bdb bdb Bdb reset9403239
Ref: 342f9403239
Ref: library/bdb bdb Bdb trace_dispatch9403414
Ref: 34309403414
Ref: library/bdb bdb Bdb dispatch_line9404832
Ref: 34319404832
Ref: library/bdb bdb Bdb dispatch_call9405306
Ref: 34339405306
Ref: library/bdb bdb Bdb dispatch_return9405787
Ref: 34359405787
Ref: library/bdb bdb Bdb dispatch_exception9406276
Ref: 34379406276
Ref: library/bdb bdb Bdb stop_here9406932
Ref: 34399406932
Ref: library/bdb bdb Bdb break_here9407143
Ref: 343a9407143
Ref: library/bdb bdb Bdb break_anywhere9407413
Ref: 343b9407413
Ref: library/bdb bdb Bdb user_call9407655
Ref: 34349407655
Ref: library/bdb bdb Bdb user_line9407892
Ref: 34329407892
Ref: library/bdb bdb Bdb user_return9408100
Ref: 34369408100
Ref: library/bdb bdb Bdb user_exception9408280
Ref: 34389408280
Ref: library/bdb bdb Bdb do_clear9408462
Ref: 343c9408462
Ref: library/bdb bdb Bdb set_step9408747
Ref: 343d9408747
Ref: library/bdb bdb Bdb set_next9408817
Ref: 343e9408817
Ref: library/bdb bdb Bdb set_return9408914
Ref: 343f9408914
Ref: library/bdb bdb Bdb set_until9409004
Ref: 34409409004
Ref: library/bdb bdb Bdb set_trace9409175
Ref: 34419409175
Ref: library/bdb bdb Bdb set_continue9409334
Ref: 34429409334
Ref: library/bdb bdb Bdb set_quit9409507
Ref: 34439409507
Ref: library/bdb bdb Bdb set_break9409925
Ref: 34449409925
Ref: library/bdb bdb Bdb clear_break9410276
Ref: 34459410276
Ref: library/bdb bdb Bdb clear_bpbynumber9410446
Ref: 34469410446
Ref: library/bdb bdb Bdb clear_all_file_breaks9410669
Ref: 34479410669
Ref: library/bdb bdb Bdb clear_all_breaks9410828
Ref: 34489410828
Ref: library/bdb bdb Bdb get_bpbynumber9410910
Ref: 34499410910
Ref: library/bdb bdb Bdb get_break9411259
Ref: 344a9411259
Ref: library/bdb bdb Bdb get_breaks9411376
Ref: 344b9411376
Ref: library/bdb bdb Bdb get_file_breaks9411530
Ref: 344c9411530
Ref: library/bdb bdb Bdb get_all_breaks9411668
Ref: 344d9411668
Ref: library/bdb bdb Bdb get_stack9411874
Ref: 344e9411874
Ref: library/bdb bdb Bdb format_stack_entry9412040
Ref: 344f9412040
Ref: library/bdb bdb Bdb run9412627
Ref: 34509412627
Ref: library/bdb bdb Bdb runeval9412857
Ref: 34519412857
Ref: library/bdb bdb Bdb runctx9413085
Ref: 34529413085
Ref: library/bdb bdb Bdb runcall9413221
Ref: 29d9413221
Ref: library/bdb bdb checkfuncname9413387
Ref: 34539413387
Ref: library/bdb bdb effective9413825
Ref: 34549413825
Ref: library/bdb bdb set_trace9414144
Ref: 34559414144
Ref: bdb — Debugger framework-Footnote-19414294
Node: faulthandler — Dump the Python traceback9414356
Ref: library/faulthandler doc9414529
Ref: 34569414529
Ref: library/faulthandler faulthandler-dump-the-python-traceback9414529
Ref: 34579414529
Ref: library/faulthandler module-faulthandler9414529
Ref: 7d9414529
Node: Dumping the traceback9416571
Ref: library/faulthandler dumping-the-traceback9416699
Ref: 34589416699
Ref: library/faulthandler faulthandler dump_traceback9416762
Ref: 6cc9416762
Node: Fault handler state9417069
Ref: library/faulthandler fault-handler-state9417244
Ref: 34599417244
Ref: library/faulthandler faulthandler enable9417303
Ref: 53d9417303
Ref: library/faulthandler faulthandler disable9417993
Ref: 345b9417993
Ref: library/faulthandler faulthandler is_enabled9418134
Ref: 345c9418134
Node: Dumping the tracebacks after a timeout9418221
Ref: library/faulthandler dumping-the-tracebacks-after-a-timeout9418413
Ref: 345d9418413
Ref: library/faulthandler faulthandler dump_traceback_later9418510
Ref: 6cd9418510
Ref: library/faulthandler faulthandler cancel_dump_traceback_later9419542
Ref: 345e9419542
Node: Dumping the traceback on a user signal9419666
Ref: library/faulthandler dumping-the-traceback-on-a-user-signal9419866
Ref: 345f9419866
Ref: library/faulthandler faulthandler register9419963
Ref: 6cb9419963
Ref: library/faulthandler faulthandler unregister9420594
Ref: 34609420594
Node: Issue with file descriptors9420869
Ref: library/faulthandler faulthandler-fd9421042
Ref: 345a9421042
Ref: library/faulthandler issue-with-file-descriptors9421042
Ref: 34619421042
Node: Example<15>9421510
Ref: library/faulthandler example9421636
Ref: 34629421636
Node: pdb — The Python Debugger9422137
Ref: library/pdb doc9422304
Ref: 34639422304
Ref: library/pdb debugger9422304
Ref: 34649422304
Ref: library/pdb module-pdb9422304
Ref: c99422304
Ref: library/pdb pdb-the-python-debugger9422304
Ref: 34659422304
Ref: library/pdb pdb run9425404
Ref: 324b9425404
Ref: library/pdb pdb runeval9426096
Ref: 346a9426096
Ref: library/pdb pdb runcall9426407
Ref: 346b9426407
Ref: library/pdb pdb set_trace9426722
Ref: 3b79426722
Ref: library/pdb pdb post_mortem9427138
Ref: d389427138
Ref: library/pdb pdb pm9427429
Ref: 346c9427429
Ref: library/pdb pdb Pdb9427773
Ref: 5619427773
Ref: library/pdb pdb Pdb run9429140
Ref: 346e9429140
Ref: library/pdb pdb Pdb runeval9429200
Ref: 346f9429200
Ref: library/pdb pdb Pdb runcall9429265
Ref: 34709429265
Ref: library/pdb pdb Pdb set_trace9429316
Ref: 34719429316
Ref: pdb — The Python Debugger-Footnote-19429483
Ref: pdb — The Python Debugger-Footnote-29429545
Node: Debugger Commands9429678
Ref: library/pdb debugger-commands9429759
Ref: 34669429759
Ref: library/pdb id29429759
Ref: 34729429759
Ref: library/pdb pdbcommand-help9432033
Ref: 34759432033
Ref: library/pdb pdbcommand-where9432426
Ref: 34769432426
Ref: library/pdb pdbcommand-down9432616
Ref: 34779432616
Ref: library/pdb pdbcommand-up9432755
Ref: 34789432755
Ref: library/pdb pdbcommand-break9432891
Ref: 34799432891
Ref: library/pdb pdbcommand-tbreak9433773
Ref: 347a9433773
Ref: library/pdb pdbcommand-clear9433984
Ref: 347b9433984
Ref: library/pdb pdbcommand-disable9434292
Ref: 347c9434292
Ref: library/pdb pdbcommand-enable9434617
Ref: 347d9434617
Ref: library/pdb pdbcommand-ignore9434707
Ref: 347e9434707
Ref: library/pdb pdbcommand-condition9435100
Ref: 347f9435100
Ref: library/pdb pdbcommand-commands9435393
Ref: 34809435393
Ref: library/pdb pdbcommand-step9436998
Ref: 34689436998
Ref: library/pdb pdbcommand-next9437183
Ref: 34699437183
Ref: library/pdb pdbcommand-until9437581
Ref: 34849437581
Ref: library/pdb pdbcommand-return9437978
Ref: 34819437978
Ref: library/pdb pdbcommand-continue9438065
Ref: 34679438065
Ref: library/pdb pdbcommand-jump9438165
Ref: 34829438165
Ref: library/pdb pdbcommand-list9438595
Ref: 34739438595
Ref: library/pdb pdbcommand-ll9439333
Ref: 34859439333
Ref: library/pdb pdbcommand-args9439511
Ref: 34869439511
Ref: library/pdb pdbcommand-p9439590
Ref: 87b9439590
Ref: library/pdb pdbcommand-pp9439859
Ref: 34879439859
Ref: library/pdb pdbcommand-whatis9440022
Ref: 34889440022
Ref: library/pdb pdbcommand-source9440099
Ref: 34899440099
Ref: library/pdb pdbcommand-display9440226
Ref: 348a9440226
Ref: library/pdb pdbcommand-undisplay9440483
Ref: 348b9440483
Ref: library/pdb pdbcommand-interact9440699
Ref: 348c9440699
Ref: library/pdb debugger-aliases9440928
Ref: 34749440928
Ref: library/pdb pdbcommand-alias9440928
Ref: 348d9440928
Ref: library/pdb pdbcommand-unalias9441995
Ref: 348e9441995
Ref: library/pdb pdbcommand-!9442059
Ref: 348f9442059
Ref: library/pdb pdbcommand-run9442491
Ref: 34909442491
Ref: library/pdb pdbcommand-restart9442522
Ref: 34919442522
Ref: library/pdb pdbcommand-quit9442861
Ref: 34839442861
Ref: library/pdb pdbcommand-debug9442955
Ref: 34929442955
Ref: library/pdb pdbcommand-retval9443154
Ref: 34939443154
Node: The Python Profilers9443263
Ref: library/profile doc9443444
Ref: 34949443444
Ref: library/profile profile9443444
Ref: 34959443444
Ref: library/profile the-python-profilers9443444
Ref: 34969443444
Ref: The Python Profilers-Footnote-19443888
Ref: The Python Profilers-Footnote-29443954
Node: Introduction to the profilers9444019
Ref: library/profile introduction-to-the-profilers9444137
Ref: 34979444137
Ref: library/profile profiler-introduction9444137
Ref: 34989444137
Node: Instant User’s Manual9445623
Ref: library/profile instant-user-s-manual9445787
Ref: 34999445787
Ref: library/profile profile-instant9445787
Ref: 349a9445787
Node: profile and cProfile Module Reference9451872
Ref: library/profile module-cProfile9452022
Ref: 289452022
Ref: library/profile profile-and-cprofile-module-reference9452022
Ref: 349f9452022
Ref: library/profile module-profile9452133
Ref: d39452133
Ref: library/profile profile run9452227
Ref: 34a09452227
Ref: library/profile profile runctx9452862
Ref: 34a19452862
Ref: library/profile profile Profile9453264
Ref: 1b99453264
Ref: library/profile profile Profile enable9454702
Ref: 34a29454702
Ref: library/profile profile Profile disable9454803
Ref: 34a39454803
Ref: library/profile profile Profile create_stats9454904
Ref: 34a49454904
Ref: library/profile profile Profile print_stats9455048
Ref: 34a59455048
Ref: library/profile profile Profile dump_stats9455206
Ref: 34a69455206
Ref: library/profile profile Profile run9455313
Ref: 34a79455313
Ref: library/profile profile Profile runctx9455391
Ref: 34a89455391
Ref: library/profile profile Profile runcall9455548
Ref: 29c9455548
Node: The Stats Class9455889
Ref: library/profile profile-stats9456048
Ref: 34a99456048
Ref: library/profile the-stats-class9456048
Ref: 34aa9456048
Ref: library/profile module-pstats9456180
Ref: d49456180
Ref: library/profile pstats Stats9456182
Ref: 349b9456182
Ref: library/profile pstats Stats strip_dirs9457445
Ref: 349d9457445
Ref: library/profile pstats Stats add9458267
Ref: 34ab9458267
Ref: library/profile pstats Stats dump_stats9458760
Ref: 34ac9458760
Ref: library/profile pstats Stats sort_stats9459141
Ref: 349c9459141
Ref: library/profile pstats Stats reverse_order9464498
Ref: 34ad9464498
Ref: library/profile pstats Stats print_stats9464784
Ref: 349e9464784
Ref: library/profile pstats Stats print_callers9466228
Ref: 34ae9466228
Ref: library/profile pstats Stats print_callees9467344
Ref: 34af9467344
Node: What Is Deterministic Profiling?9467725
Ref: library/profile deterministic-profiling9467858
Ref: 34b09467858
Ref: library/profile what-is-deterministic-profiling9467858
Ref: 34b19467858
Node: Limitations9469656
Ref: library/profile limitations9469785
Ref: 34b29469785
Ref: library/profile profile-limitations9469785
Ref: 34b39469785
Node: Calibration9471668
Ref: library/profile calibration9471785
Ref: 34b49471785
Ref: library/profile profile-calibration9471785
Ref: 34b59471785
Node: Using a custom timer9473430
Ref: library/profile profile-timers9473527
Ref: 34b69473527
Ref: library/profile using-a-custom-timer9473527
Ref: 34b79473527
Node: timeit — Measure execution time of small code snippets9475977
Ref: library/timeit doc9476182
Ref: 34b89476182
Ref: library/timeit module-timeit9476182
Ref: 10b9476182
Ref: library/timeit timeit-measure-execution-time-of-small-code-snippets9476182
Ref: 34b99476182
Ref: timeit — Measure execution time of small code snippets-Footnote-19476949
Node: Basic Examples<2>9477014
Ref: library/timeit basic-examples9477149
Ref: 34bc9477149
Node: Python Interface9478377
Ref: library/timeit id19478546
Ref: 34be9478546
Ref: library/timeit python-interface9478546
Ref: 34bb9478546
Ref: library/timeit timeit timeit9478667
Ref: 7659478667
Ref: library/timeit timeit repeat9479130
Ref: 34c09479130
Ref: library/timeit timeit default_timer9479720
Ref: 34c29479720
Ref: library/timeit timeit Timer9479925
Ref: 34bf9479925
Ref: library/timeit timeit Timer timeit9481372
Ref: 5919481372
Ref: library/timeit timeit Timer autorange9482482
Ref: 5909482482
Ref: library/timeit timeit Timer repeat9483209
Ref: 34c19483209
Ref: library/timeit timeit Timer print_exc9484484
Ref: 34c39484484
Node: Command-Line Interface<4>9485004
Ref: library/timeit command-line-interface9485168
Ref: 34c49485168
Ref: library/timeit timeit-command-line-interface9485168
Ref: 34ba9485168
Ref: library/timeit cmdoption-timeit-n9485427
Ref: 34c59485427
Ref: library/timeit cmdoption-timeit-r9485513
Ref: 34c69485513
Ref: library/timeit cmdoption-timeit-s9485604
Ref: 34c79485604
Ref: library/timeit cmdoption-timeit-p9485708
Ref: 34c89485708
Ref: library/timeit cmdoption-timeit-u9485929
Ref: 34c99485929
Ref: library/timeit cmdoption-timeit-v9486084
Ref: 34ca9486084
Ref: library/timeit cmdoption-timeit-h9486184
Ref: 34cb9486184
Node: Examples<25>9487365
Ref: library/timeit examples9487504
Ref: 34cc9487504
Ref: library/timeit timeit-examples9487504
Ref: 34bd9487504
Node: trace — Trace or track Python statement execution9490441
Ref: library/trace doc9490666
Ref: 34cd9490666
Ref: library/trace module-trace9490666
Ref: 1129490666
Ref: library/trace trace-trace-or-track-python-statement-execution9490666
Ref: 34ce9490666
Ref: trace — Trace or track Python statement execution-Footnote-19491411
Ref: trace — Trace or track Python statement execution-Footnote-29491475
Node: Command-Line Usage9491516
Ref: library/trace command-line-usage9491653
Ref: 34cf9491653
Ref: library/trace trace-cli9491653
Ref: 34d09491653
Ref: library/trace cmdoption-trace-help9492007
Ref: 34d19492007
Ref: library/trace cmdoption-trace-version9492065
Ref: 34d29492065
Node: Main options9492289
Ref: library/trace main-options9492374
Ref: 34d39492374
Ref: library/trace cmdoption-trace-c9492764
Ref: 34d69492764
Ref: library/trace cmdoption-trace-t9493031
Ref: 34d59493031
Ref: library/trace cmdoption-trace-l9493106
Ref: 34d49493106
Ref: library/trace cmdoption-trace-r9493204
Ref: 34da9493204
Ref: library/trace cmdoption-trace-trackcalls9493410
Ref: 34db9493410
Node: Modifiers9493520
Ref: library/trace modifiers9493621
Ref: 34dc9493621
Ref: library/trace cmdoption-trace-f9493660
Ref: 34d89493660
Ref: library/trace cmdoption-trace-coverdir9493827
Ref: 34d79493827
Ref: library/trace cmdoption-trace-m9494025
Ref: 34dd9494025
Ref: library/trace cmdoption-trace-s9494161
Ref: 34de9494161
Ref: library/trace cmdoption-trace-no-report9494323
Ref: 34d99494323
Ref: library/trace cmdoption-trace-g9494554
Ref: 34df9494554
Node: Filters9494683
Ref: library/trace filters9494763
Ref: 34e09494763
Ref: library/trace cmdoption-trace-ignore-module9494845
Ref: 34e19494845
Ref: library/trace cmdoption-trace-ignore-dir9495042
Ref: 34e29495042
Node: Programmatic Interface9495253
Ref: library/trace programmatic-interface9495390
Ref: 34e39495390
Ref: library/trace trace-api9495390
Ref: 34e49495390
Ref: library/trace trace Trace9495455
Ref: 34e59495455
Ref: library/trace trace Trace run9496366
Ref: 34e69496366
Ref: library/trace trace Trace runctx9496643
Ref: 34e79496643
Ref: library/trace trace Trace runfunc9496982
Ref: 29e9496982
Ref: library/trace trace Trace results9497202
Ref: 34e89497202
Ref: library/trace trace CoverageResults9497551
Ref: 34e99497551
Ref: library/trace trace CoverageResults update9497715
Ref: 34ea9497715
Ref: library/trace trace CoverageResults write_results9497848
Ref: 34eb9497848
Node: tracemalloc — Trace memory allocations9498859
Ref: library/tracemalloc doc9499019
Ref: 34ec9499019
Ref: library/tracemalloc module-tracemalloc9499019
Ref: 1149499019
Ref: library/tracemalloc tracemalloc-trace-memory-allocations9499019
Ref: 34ed9499019
Ref: tracemalloc — Trace memory allocations-Footnote-19500359
Node: Examples<26>9500429
Ref: library/tracemalloc examples9500530
Ref: 34ee9500530
Node: Display the top 109500679
Ref: library/tracemalloc display-the-top-109500774
Ref: 34ef9500774
Node: Compute differences9502173
Ref: library/tracemalloc compute-differences9502312
Ref: 34f19502312
Node: Get the traceback of a memory block9504407
Ref: library/tracemalloc get-the-traceback-of-a-memory-block9504538
Ref: 34f49504538
Node: Pretty top9506955
Ref: library/tracemalloc pretty-top9507058
Ref: 34f59507058
Node: API9509336
Ref: library/tracemalloc api9509437
Ref: 34f69509437
Node: Functions<9>9509608
Ref: library/tracemalloc functions9509681
Ref: 34f79509681
Ref: library/tracemalloc tracemalloc clear_traces9509720
Ref: 34f89509720
Ref: library/tracemalloc tracemalloc get_object_traceback9509855
Ref: 109f9509855
Ref: library/tracemalloc tracemalloc get_traceback_limit9510263
Ref: 34fc9510263
Ref: library/tracemalloc tracemalloc get_traced_memory9510587
Ref: 34fd9510587
Ref: library/tracemalloc tracemalloc get_tracemalloc_memory9510793
Ref: 34fe9510793
Ref: library/tracemalloc tracemalloc is_tracing9510991
Ref: 34ff9510991
Ref: library/tracemalloc tracemalloc start9511224
Ref: 128a9511224
Ref: library/tracemalloc tracemalloc stop9512424
Ref: 34f99512424
Ref: library/tracemalloc tracemalloc take_snapshot9512858
Ref: 35019512858
Node: DomainFilter9513558
Ref: library/tracemalloc domainfilter9513646
Ref: 35039513646
Ref: library/tracemalloc tracemalloc DomainFilter9513691
Ref: 5959513691
Ref: library/tracemalloc tracemalloc DomainFilter inclusive9513855
Ref: 35049513855
Ref: library/tracemalloc tracemalloc DomainFilter domain9514155
Ref: 35059514155
Node: Filter9514260
Ref: library/tracemalloc filter9514341
Ref: 35069514341
Ref: library/tracemalloc tracemalloc Filter9514374
Ref: 35079514374
Ref: library/tracemalloc tracemalloc Filter domain9515221
Ref: 35089515221
Ref: library/tracemalloc tracemalloc Filter inclusive9515492
Ref: 35099515492
Ref: library/tracemalloc tracemalloc Filter lineno9515924
Ref: 350b9515924
Ref: library/tracemalloc tracemalloc Filter filename_pattern9516076
Ref: 350a9516076
Ref: library/tracemalloc tracemalloc Filter all_frames9516190
Ref: 350c9516190
Node: Frame9516597
Ref: library/tracemalloc frame9516674
Ref: 350e9516674
Ref: library/tracemalloc tracemalloc Frame9516707
Ref: 350f9516707
Ref: library/tracemalloc tracemalloc Frame filename9516855
Ref: 35109516855
Ref: library/tracemalloc tracemalloc Frame lineno9516918
Ref: 35119516918
Node: Snapshot9516982
Ref: library/tracemalloc snapshot9517062
Ref: 35129517062
Ref: library/tracemalloc tracemalloc Snapshot9517101
Ref: 35029517101
Ref: library/tracemalloc tracemalloc Snapshot compare_to9517279
Ref: 35009517279
Ref: library/tracemalloc tracemalloc Snapshot dump9518005
Ref: 34f29518005
Ref: library/tracemalloc tracemalloc Snapshot filter_traces9518141
Ref: 35199518141
Ref: library/tracemalloc tracemalloc Snapshot load9518818
Ref: 34f39518818
Ref: library/tracemalloc tracemalloc Snapshot statistics9518938
Ref: 34f09518938
Ref: library/tracemalloc tracemalloc Snapshot traceback_limit9520137
Ref: 350d9520137
Ref: library/tracemalloc tracemalloc Snapshot traces9520356
Ref: 351a9520356
Node: Statistic9520651
Ref: library/tracemalloc statistic9520739
Ref: 351f9520739
Ref: library/tracemalloc tracemalloc Statistic9520780
Ref: 351b9520780
Ref: library/tracemalloc tracemalloc Statistic count9521004
Ref: 35179521004
Ref: library/tracemalloc tracemalloc Statistic size9521079
Ref: 351c9521079
Ref: library/tracemalloc tracemalloc Statistic traceback9521166
Ref: 351d9521166
Node: StatisticDiff9521298
Ref: library/tracemalloc statisticdiff9521383
Ref: 35209521383
Ref: library/tracemalloc tracemalloc StatisticDiff9521432
Ref: 35139521432
Ref: library/tracemalloc tracemalloc StatisticDiff count9521732
Ref: 35219521732
Ref: library/tracemalloc tracemalloc StatisticDiff count_diff9521906
Ref: 35169521906
Ref: library/tracemalloc tracemalloc StatisticDiff size9522128
Ref: 35159522128
Ref: library/tracemalloc tracemalloc StatisticDiff size_diff9522324
Ref: 35149522324
Ref: library/tracemalloc tracemalloc StatisticDiff traceback9522558
Ref: 35189522558
Node: Trace9522692
Ref: library/tracemalloc trace9522777
Ref: 35229522777
Ref: library/tracemalloc tracemalloc Trace9522810
Ref: 351e9522810
Ref: library/tracemalloc tracemalloc Trace domain9523043
Ref: 35239523043
Ref: library/tracemalloc tracemalloc Trace size9523321
Ref: 35249523321
Ref: library/tracemalloc tracemalloc Trace traceback9523405
Ref: 35259523405
Node: Traceback9523537
Ref: library/tracemalloc traceback9523600
Ref: 35269523600
Ref: library/tracemalloc tracemalloc Traceback9523641
Ref: 3f49523641
Ref: library/tracemalloc tracemalloc Traceback format9524362
Ref: 3f59524362
Node: Software Packaging and Distribution9525355
Ref: library/distribution doc9525518
Ref: 35289525518
Ref: library/distribution software-packaging-and-distribution9525518
Ref: 35299525518
Ref: Software Packaging and Distribution-Footnote-19526102
Node: distutils — Building and installing Python modules9526127
Ref: library/distutils doc9526305
Ref: 352a9526305
Ref: library/distutils distutils-building-and-installing-python-modules9526305
Ref: 352b9526305
Ref: library/distutils module-distutils9526305
Ref: 399526305
Ref: distutils — Building and installing Python modules-Footnote-19528212
Ref: distutils — Building and installing Python modules-Footnote-29528265
Ref: distutils — Building and installing Python modules-Footnote-39528294
Node: ensurepip — Bootstrapping the pip installer9528331
Ref: library/ensurepip doc9528559
Ref: 352c9528559
Ref: library/ensurepip ensurepip-bootstrapping-the-pip-installer9528559
Ref: 352d9528559
Ref: library/ensurepip module-ensurepip9528559
Ref: 7a9528559
Ref: ensurepip — Bootstrapping the pip installer-Footnote-19529964
Node: Command line interface9530013
Ref: library/ensurepip command-line-interface9530136
Ref: 352e9530136
Node: Module API9531934
Ref: library/ensurepip module-api9532057
Ref: 352f9532057
Ref: library/ensurepip ensurepip version9532164
Ref: 35309532164
Ref: library/ensurepip ensurepip bootstrap9532324
Ref: 340e9532324
Node: venv — Creation of virtual environments9534100
Ref: library/venv doc9534324
Ref: 35319534324
Ref: library/venv module-venv9534324
Ref: 1259534324
Ref: library/venv venv-creation-of-virtual-environments9534324
Ref: 35329534324
Ref: venv — Creation of virtual environments-Footnote-19535252
Ref: venv — Creation of virtual environments-Footnote-29535313
Ref: venv — Creation of virtual environments-Footnote-39535362
Node: Creating virtual environments9535442
Ref: library/venv creating-virtual-environments9535564
Ref: 35339535564
Ref: library/venv venv-def9541889
Ref: 35349541889
Ref: Creating virtual environments-Footnote-19544864
Ref: Creating virtual environments-Footnote-29544938
Ref: Creating virtual environments-Footnote-39544983
Ref: Creating virtual environments-Footnote-49545021
Node: API<2>9545070
Ref: library/venv api9545235
Ref: 35389545235
Ref: library/venv venv-api9545235
Ref: 7e69545235
Ref: library/venv venv EnvBuilder9545492
Ref: 8fc9545492
Ref: library/venv venv EnvBuilder create9547195
Ref: 35399547195
Ref: library/venv venv EnvBuilder ensure_directories9548340
Ref: 353a9548340
Ref: library/venv venv EnvBuilder create_configuration9548794
Ref: 353b9548794
Ref: library/venv venv EnvBuilder setup_python9548932
Ref: 353c9548932
Ref: library/venv venv EnvBuilder setup_scripts9549298
Ref: 353d9549298
Ref: library/venv venv EnvBuilder post_setup9549447
Ref: 353e9549447
Ref: library/venv venv EnvBuilder install_scripts9550444
Ref: 353f9550444
Ref: library/venv venv create9551726
Ref: 8fd9551726
Node: An example of extending EnvBuilder9552167
Ref: library/venv an-example-of-extending-envbuilder9552294
Ref: 35409552294
Ref: An example of extending EnvBuilder-Footnote-19562060
Node: zipapp — Manage executable Python zip archives9562107
Ref: library/zipapp doc9562277
Ref: 35419562277
Ref: library/zipapp module-zipapp9562277
Ref: 1419562277
Ref: library/zipapp pip9562277
Ref: 35429562277
Ref: library/zipapp zipapp-manage-executable-python-zip-archives9562277
Ref: 35439562277
Ref: zipapp — Manage executable Python zip archives-Footnote-19563054
Node: Basic Example9563119
Ref: library/zipapp basic-example9563251
Ref: 35469563251
Node: Command-Line Interface<5>9563646
Ref: library/zipapp command-line-interface9563797
Ref: 35479563797
Ref: library/zipapp zipapp-command-line-interface9563797
Ref: 35449563797
Ref: library/zipapp cmdoption-zipapp-o9564293
Ref: 35489564293
Ref: library/zipapp cmdoption-zipapp-p9564798
Ref: 35499564798
Ref: library/zipapp cmdoption-zipapp-m9565082
Ref: 354a9565082
Ref: library/zipapp cmdoption-zipapp-c9565521
Ref: 354b9565521
Ref: library/zipapp cmdoption-zipapp-info9565806
Ref: 354c9565806
Ref: library/zipapp cmdoption-zipapp-h9566017
Ref: 354d9566017
Node: Python API9566093
Ref: library/zipapp python-api9566243
Ref: 354e9566243
Ref: library/zipapp zipapp-python-api9566243
Ref: 35459566243
Ref: library/zipapp zipapp create_archive9566331
Ref: 4129566331
Ref: library/zipapp zipapp get_interpreter9570114
Ref: 354f9570114
Node: Examples<27>9570471
Ref: library/zipapp examples9570622
Ref: 35509570622
Ref: library/zipapp zipapp-examples9570622
Ref: 35519570622
Node: Specifying the Interpreter9571932
Ref: library/zipapp specifying-the-interpreter9572117
Ref: 35529572117
Ref: library/zipapp zipapp-specifying-the-interpreter9572117
Ref: 35539572117
Node: Creating Standalone Applications with zipapp9573356
Ref: library/zipapp creating-standalone-applications-with-zipapp9573570
Ref: 35549573570
Node: Making a Windows executable9575612
Ref: library/zipapp making-a-windows-executable9575736
Ref: 35559575736
Node: Caveats9578673
Ref: library/zipapp caveats9578797
Ref: 35569578797
Node: The Python Zip Application Archive Format9580587
Ref: library/zipapp the-python-zip-application-archive-format9580766
Ref: 35579580766
Node: Python Runtime Services9582669
Ref: library/python doc9582835
Ref: 35589582835
Ref: library/python python9582835
Ref: 35599582835
Ref: library/python python-runtime-services9582835
Ref: 355a9582835
Node: sys — System-specific parameters and functions9583691
Ref: library/sys doc9583876
Ref: 355b9583876
Ref: library/sys module-sys9583876
Ref: fd9583876
Ref: library/sys sys-system-specific-parameters-and-functions9583876
Ref: 355c9583876
Ref: library/sys sys abiflags9584235
Ref: 2629584235
Ref: library/sys sys addaudithook9584558
Ref: 34059584558
Ref: library/sys sys argv9585803
Ref: bee9585803
Ref: library/sys auditing9586690
Ref: 12759586690
Ref: library/sys sys audit9586690
Ref: 34049586690
Ref: library/sys sys base_exec_prefix9587581
Ref: 35379587581
Ref: library/sys sys base_prefix9588227
Ref: 35369588227
Ref: library/sys sys byteorder9588863
Ref: 155c9588863
Ref: library/sys sys builtin_module_names9589119
Ref: 355d9589119
Ref: library/sys sys call_tracing9589387
Ref: 355e9589387
Ref: library/sys sys copyright9589656
Ref: 355f9589656
Ref: library/sys sys _clear_type_cache9589764
Ref: 35609589764
Ref: library/sys sys _current_frames9590090
Ref: d8e9590090
Ref: library/sys sys breakpointhook9590960
Ref: 3089590960
Ref: library/sys sys _debugmallocstats9592858
Ref: 35619592858
Ref: library/sys sys dllhandle9593284
Ref: 35629593284
Ref: library/sys sys displayhook9593406
Ref: e539593406
Ref: library/sys sys dont_write_bytecode9594773
Ref: 35649594773
Ref: library/sys sys pycache_prefix9595170
Ref: 1569595170
Ref: library/sys sys excepthook9596141
Ref: e579596141
Ref: library/sys sys __breakpointhook__9597466
Ref: 35659597466
Ref: library/sys sys __displayhook__9597499
Ref: 35669597499
Ref: library/sys sys __excepthook__9597529
Ref: 35679597529
Ref: library/sys sys __unraisablehook__9597558
Ref: 35689597558
Ref: library/sys sys exc_info9598021
Ref: c529598021
Ref: library/sys sys exec_prefix9599243
Ref: 35359599243
Ref: library/sys sys executable9600163
Ref: 2729600163
Ref: library/sys sys exit9600464
Ref: cd59600464
Ref: library/sys sys flags9602136
Ref: b2f9602136
Ref: library/sys sys float_info9605123
Ref: ef39605123
Ref: library/sys sys float_repr_style9609969
Ref: c839609969
Ref: library/sys sys getallocatedblocks9610508
Ref: 8d69610508
Ref: library/sys sys getandroidapilevel9611145
Ref: 3e69611145
Ref: library/sys sys getcheckinterval9611320
Ref: dfb9611320
Ref: library/sys sys getdefaultencoding9611542
Ref: 356c9611542
Ref: library/sys sys getdlopenflags9611685
Ref: e419611685
Ref: library/sys sys getfilesystemencoding9611997
Ref: 4eb9611997
Ref: library/sys sys getfilesystemencodeerrors9613405
Ref: 5899613405
Ref: library/sys sys getrefcount9613808
Ref: 356d9613808
Ref: library/sys sys getrecursionlimit9614066
Ref: e6e9614066
Ref: library/sys sys getsizeof9614378
Ref: 34fb9614378
Ref: library/sys sys getswitchinterval9615330
Ref: 356b9615330
Ref: library/sys sys _getframe9615500
Ref: e589615500
Ref: library/sys sys getprofile9616148
Ref: d3a9616148
Ref: library/sys sys gettrace9616248
Ref: d3b9616248
Ref: library/sys sys getwindowsversion9616686
Ref: 58a9616686
Ref: library/sys sys get_asyncgen_hooks9618990
Ref: 356e9618990
Ref: library/sys sys get_coroutine_origin_tracking_depth9619597
Ref: 3e79619597
Ref: library/sys sys hash_info9619947
Ref: 9159619947
Ref: library/sys sys hexversion9621648
Ref: 35709621648
Ref: library/sys sys implementation9622491
Ref: 99e9622491
Ref: library/sys sys int_info9624692
Ref: c149624692
Ref: library/sys sys __interactivehook__9625554
Ref: 8d89625554
Ref: library/sys sys intern9626100
Ref: c619626100
Ref: library/sys sys is_finalizing9626868
Ref: 7569626868
Ref: library/sys sys last_type9627049
Ref: c4d9627049
Ref: library/sys sys last_value9627073
Ref: 35729627073
Ref: library/sys sys last_traceback9627098
Ref: 346d9627098
Ref: library/sys sys maxsize9627752
Ref: b369627752
Ref: library/sys sys maxunicode9627968
Ref: 97f9627968
Ref: library/sys sys meta_path9628366
Ref: 5db9628366
Ref: library/sys sys modules9629608
Ref: 13eb9629608
Ref: library/sys sys path9629965
Ref: 47d9629965
Ref: library/sys sys path_hooks9631057
Ref: 9509631057
Ref: library/sys sys path_importer_cache9631348
Ref: 4939631348
Ref: library/sys sys platform9631874
Ref: 2af9631874
Ref: library/sys sys prefix9634243
Ref: 2f7b9634243
Ref: library/sys sys ps19635140
Ref: 12919635140
Ref: library/sys sys ps29635158
Ref: 12929635158
Ref: library/sys sys setcheckinterval9635634
Ref: 356a9635634
Ref: library/sys sys setdlopenflags9636423
Ref: a5b9636423
Ref: library/sys sys setprofile9637023
Ref: e309637023
Ref: library/sys sys setrecursionlimit9639163
Ref: e6f9639163
Ref: library/sys sys setswitchinterval9639955
Ref: bde9639955
Ref: library/sys sys settrace9640532
Ref: e319640532
Ref: library/sys sys set_asyncgen_hooks9645067
Ref: 144a9645067
Ref: library/sys sys set_coroutine_origin_tracking_depth9646171
Ref: 3e89646171
Ref: library/sys sys _enablelegacywindowsfsencoding9646986
Ref: 4ed9646986
Ref: library/sys sys stdin9647452
Ref: 3029647452
Ref: library/sys sys stdout9647472
Ref: 3039647472
Ref: library/sys sys stderr9647493
Ref: 3049647493
Ref: library/sys sys __stdin__9650384
Ref: 35749650384
Ref: library/sys sys __stdout__9650408
Ref: 1bd39650408
Ref: library/sys sys __stderr__9650433
Ref: 35759650433
Ref: library/sys sys thread_info9651398
Ref: a979651398
Ref: library/sys sys tracebacklimit9652849
Ref: 35769652849
Ref: library/sys sys unraisablehook9653213
Ref: 22b9653213
Ref: library/sys sys version9654947
Ref: 5c89654947
Ref: library/sys sys api_version9655349
Ref: 35779655349
Ref: library/sys sys version_info9655537
Ref: b0d9655537
Ref: library/sys sys warnoptions9656158
Ref: 40b9656158
Ref: library/sys sys winver9656377
Ref: 35789656377
Ref: library/sys sys _xoptions9656815
Ref: 128c9656815
Ref: library/sys c999657554
Ref: 35699657554
Ref: sys — System-specific parameters and functions-Footnote-19657765
Ref: sys — System-specific parameters and functions-Footnote-29657814
Ref: sys — System-specific parameters and functions-Footnote-39657863
Ref: sys — System-specific parameters and functions-Footnote-49657915
Ref: sys — System-specific parameters and functions-Footnote-59657964
Ref: sys — System-specific parameters and functions-Footnote-69658013
Ref: sys — System-specific parameters and functions-Footnote-79658062
Ref: sys — System-specific parameters and functions-Footnote-89658111
Ref: sys — System-specific parameters and functions-Footnote-99658160
Ref: sys — System-specific parameters and functions-Footnote-109658209
Ref: sys — System-specific parameters and functions-Footnote-119658259
Ref: sys — System-specific parameters and functions-Footnote-129658309
Ref: sys — System-specific parameters and functions-Footnote-139658359
Ref: sys — System-specific parameters and functions-Footnote-149658409
Ref: sys — System-specific parameters and functions-Footnote-159658489
Ref: sys — System-specific parameters and functions-Footnote-169658539
Ref: sys — System-specific parameters and functions-Footnote-179658589
Node: sysconfig — Provide access to Python’s configuration information9658639
Ref: library/sysconfig doc9658862
Ref: 35799658862
Ref: library/sysconfig module-sysconfig9658862
Ref: fe9658862
Ref: library/sysconfig sysconfig-provide-access-to-python-s-configuration-information9658862
Ref: 357a9658862
Ref: sysconfig — Provide access to Python’s configuration information-Footnote-19659504
Node: Configuration variables9659572
Ref: library/sysconfig configuration-variables9659727
Ref: 357b9659727
Ref: library/sysconfig sysconfig get_config_vars9660220
Ref: 9599660220
Ref: library/sysconfig sysconfig get_config_var9660591
Ref: 9589660591
Node: Installation paths9661004
Ref: library/sysconfig installation-paths9661186
Ref: 357c9661186
Ref: library/sysconfig sysconfig get_scheme_names9663161
Ref: 357d9663161
Ref: library/sysconfig sysconfig get_path_names9663299
Ref: 357e9663299
Ref: library/sysconfig sysconfig get_path9663438
Ref: cb19663438
Ref: library/sysconfig sysconfig get_paths9664647
Ref: bcc9664647
Node: Other functions<3>9665270
Ref: library/sysconfig other-functions9665456
Ref: 357f9665456
Ref: library/sysconfig sysconfig get_python_version9665507
Ref: bcb9665507
Ref: library/sysconfig sysconfig get_platform9665678
Ref: bca9665678
Ref: library/sysconfig sysconfig is_python_build9666684
Ref: cb29666684
Ref: library/sysconfig sysconfig parse_config_h9666975
Ref: 35809666975
Ref: library/sysconfig sysconfig get_config_h_filename9667369
Ref: 35819667369
Ref: library/sysconfig sysconfig get_makefile_filename9667462
Ref: 35829667462
Node: Using sysconfig as a script9667553
Ref: library/sysconfig using-sysconfig-as-a-script9667712
Ref: 35839667712
Node: builtins — Built-in objects9668695
Ref: library/builtins doc9668911
Ref: 35849668911
Ref: library/builtins builtins-built-in-objects9668911
Ref: 35859668911
Ref: library/builtins module-builtins9668911
Ref: 139668911
Node: __main__ — Top-level script environment9670362
Ref: library/__main__ doc9670538
Ref: 35869670538
Ref: library/__main__ main-top-level-script-environment9670538
Ref: 35879670538
Ref: library/__main__ module-__main__9670538
Ref: 19670538
Node: warnings — Warning control9671422
Ref: library/warnings doc9671597
Ref: 35889671597
Ref: library/warnings module-warnings9671597
Ref: 1269671597
Ref: library/warnings warnings-warning-control9671597
Ref: 35899671597
Ref: warnings — Warning control-Footnote-19673908
Node: Warning Categories9673975
Ref: library/warnings id19674086
Ref: 358d9674086
Ref: library/warnings warning-categories9674086
Ref: 16519674086
Node: The Warnings Filter9678068
Ref: library/warnings the-warnings-filter9678220
Ref: 358e9678220
Ref: library/warnings warning-filter9678220
Ref: 12879678220
Node: Describing Warning Filters9680955
Ref: library/warnings describing-warning-filters9681068
Ref: 12889681068
Ref: library/warnings id29681068
Ref: 358f9681068
Node: Default Warning Filter9682829
Ref: library/warnings default-warning-filter9682980
Ref: 35909682980
Ref: library/warnings id39682980
Ref: 35919682980
Node: Overriding the default filter9684047
Ref: library/warnings overriding-the-default-filter9684163
Ref: 35929684163
Ref: library/warnings warning-disable9684163
Ref: 35939684163
Node: Temporarily Suppressing Warnings9685553
Ref: library/warnings temporarily-suppressing-warnings9685703
Ref: 35949685703
Ref: library/warnings warning-suppress9685703
Ref: 35959685703
Node: Testing Warnings9686696
Ref: library/warnings testing-warnings9686873
Ref: 35969686873
Ref: library/warnings warning-testing9686873
Ref: 35979686873
Node: Updating Code For New Versions of Dependencies9688882
Ref: library/warnings updating-code-for-new-versions-of-dependencies9689046
Ref: 35989689046
Ref: library/warnings warning-ignored9689046
Ref: 32b19689046
Node: Available Functions9690436
Ref: library/warnings available-functions9690610
Ref: 35999690610
Ref: library/warnings warning-functions9690610
Ref: 359a9690610
Ref: library/warnings warnings warn9690669
Ref: e4b9690669
Ref: library/warnings warnings warn_explicit9691879
Ref: 5a59691879
Ref: library/warnings warnings showwarning9693067
Ref: 358c9693067
Ref: library/warnings warnings formatwarning9693705
Ref: f269693705
Ref: library/warnings warnings filterwarnings9694136
Ref: dfa9694136
Ref: library/warnings warnings simplefilter9694813
Ref: 339a9694813
Ref: library/warnings warnings resetwarnings9695249
Ref: 358b9695249
Node: Available Context Managers9695517
Ref: library/warnings available-context-managers9695636
Ref: 359b9695636
Ref: library/warnings warnings catch_warnings9695711
Ref: 33999695711
Node: dataclasses — Data Classes9696960
Ref: library/dataclasses doc9697146
Ref: 359c9697146
Ref: library/dataclasses dataclasses-data-classes9697146
Ref: 359d9697146
Ref: library/dataclasses module-dataclasses9697146
Ref: 309697146
Ref: dataclasses — Data Classes-Footnote-19698717
Ref: dataclasses — Data Classes-Footnote-29698787
Ref: dataclasses — Data Classes-Footnote-39698836
Node: Module-level decorators classes and functions9698885
Ref: library/dataclasses module-level-decorators-classes-and-functions9699024
Ref: 359f9699024
Ref: library/dataclasses dataclasses dataclass9699139
Ref: 3329699139
Ref: library/dataclasses dataclasses field9705979
Ref: f329705979
Ref: library/dataclasses dataclasses Field9710151
Ref: 35a09710151
Ref: library/dataclasses dataclasses fields9710928
Ref: 35a19710928
Ref: library/dataclasses dataclasses asdict9711307
Ref: 35a29711307
Ref: library/dataclasses dataclasses astuple9712005
Ref: 35a39712005
Ref: library/dataclasses dataclasses make_dataclass9712531
Ref: 35a49712531
Ref: library/dataclasses dataclasses replace9713956
Ref: edf9713956
Ref: library/dataclasses dataclasses is_dataclass9715371
Ref: 35a59715371
Node: Post-init processing9715816
Ref: library/dataclasses post-init-processing9715979
Ref: 35a69715979
Node: Class variables9716949
Ref: library/dataclasses class-variables9717086
Ref: 35a79717086
Ref: Class variables-Footnote-19717636
Node: Init-only variables9717685
Ref: library/dataclasses init-only-variables9717818
Ref: 35a89717818
Node: Frozen instances9718989
Ref: library/dataclasses frozen-instances9719121
Ref: 35a99719121
Node: Inheritance<2>9719722
Ref: library/dataclasses inheritance9719860
Ref: 35ab9719860
Node: Default factory functions9720877
Ref: library/dataclasses default-factory-functions9721021
Ref: 35ac9721021
Node: Mutable default values9721698
Ref: library/dataclasses mutable-default-values9721842
Ref: 35ad9721842
Node: Exceptions<17>9723516
Ref: library/dataclasses exceptions9723626
Ref: 35ae9723626
Ref: library/dataclasses dataclasses FrozenInstanceError9723667
Ref: 35aa9723667
Node: contextlib — Utilities for with-statement contexts9723888
Ref: library/contextlib doc9724075
Ref: 35af9724075
Ref: library/contextlib contextlib-utilities-for-with-statement-contexts9724075
Ref: 35b09724075
Ref: library/contextlib module-contextlib9724075
Ref: 249724075
Ref: contextlib — Utilities for with-statement contexts-Footnote-19724737
Node: Utilities9724806
Ref: library/contextlib utilities9724936
Ref: 35b19724936
Ref: library/contextlib contextlib AbstractContextManager9725008
Ref: 5299725008
Ref: library/contextlib contextlib AbstractAsyncContextManager9725494
Ref: 36d9725494
Ref: library/contextlib contextlib contextmanager9726001
Ref: b719726001
Ref: library/contextlib contextlib asynccontextmanager9728849
Ref: 36c9728849
Ref: library/contextlib contextlib closing9729759
Ref: 35b29729759
Ref: library/contextlib simplifying-support-for-single-optional-context-managers9730454
Ref: 35b39730454
Ref: library/contextlib contextlib nullcontext9730454
Ref: 36a9730454
Ref: library/contextlib contextlib suppress9731406
Ref: 8209731406
Ref: library/contextlib contextlib redirect_stdout9732401
Ref: 6b69732401
Ref: library/contextlib contextlib redirect_stderr9733677
Ref: 6b59733677
Ref: library/contextlib contextlib ContextDecorator9733939
Ref: b709733939
Ref: library/contextlib contextlib ExitStack9736033
Ref: 36b9736033
Ref: library/contextlib contextlib ExitStack enter_context9737859
Ref: 35b59737859
Ref: library/contextlib contextlib ExitStack push9738291
Ref: 35b69738291
Ref: library/contextlib contextlib ExitStack callback9739179
Ref: 2a39739179
Ref: library/contextlib contextlib ExitStack pop_all9739632
Ref: 35b79739632
Ref: library/contextlib contextlib ExitStack close9740579
Ref: 35b89740579
Ref: library/contextlib contextlib AsyncExitStack9740867
Ref: 36e9740867
Ref: library/contextlib contextlib AsyncExitStack enter_async_context9741228
Ref: 35ba9741228
Ref: library/contextlib contextlib AsyncExitStack push_async_exit9741370
Ref: 35bb9741370
Ref: library/contextlib contextlib AsyncExitStack push_async_callback9741532
Ref: 2a49741532
Ref: library/contextlib contextlib AsyncExitStack aclose9741669
Ref: 35b99741669
Node: Examples and Recipes<2>9742193
Ref: library/contextlib examples-and-recipes9742382
Ref: 35bc9742382
Node: Supporting a variable number of context managers9742830
Ref: library/contextlib supporting-a-variable-number-of-context-managers9742989
Ref: 35bd9742989
Node: Catching exceptions from __enter__ methods9744001
Ref: library/contextlib catching-exceptions-from-enter-methods9744211
Ref: 35be9744211
Node: Cleaning up in an __enter__ implementation9745324
Ref: library/contextlib cleaning-up-in-an-enter-implementation9745537
Ref: 35bf9745537
Node: Replacing any use of try-finally and flag variables9747305
Ref: library/contextlib replacing-any-use-of-try-finally-and-flag-variables9747523
Ref: 35c09747523
Node: Using a context manager as a function decorator9749907
Ref: library/contextlib using-a-context-manager-as-a-function-decorator9750074
Ref: 35c19750074
Ref: Using a context manager as a function decorator-Footnote-19751838
Node: Single use reusable and reentrant context managers9751887
Ref: library/contextlib single-use-reusable-and-reentrant-cms9752058
Ref: 8229752058
Ref: library/contextlib single-use-reusable-and-reentrant-context-managers9752058
Ref: 35c29752058
Node: Reentrant context managers9753505
Ref: library/contextlib reentrant-cms9753652
Ref: 35b49753652
Ref: library/contextlib reentrant-context-managers9753652
Ref: 35c39753652
Node: Reusable context managers9755103
Ref: library/contextlib reusable-cms9755250
Ref: 35c49755250
Ref: library/contextlib reusable-context-managers9755250
Ref: 35c59755250
Node: abc — Abstract Base Classes9757753
Ref: library/abc doc9757936
Ref: 35c69757936
Ref: library/abc abc-abstract-base-classes9757936
Ref: 35c79757936
Ref: library/abc module-abc9757936
Ref: 49757936
Ref: library/abc abc ABC9758901
Ref: 80c9758901
Ref: library/abc abc ABCMeta9759706
Ref: 80d9759706
Ref: library/abc abc ABCMeta register9760486
Ref: 9c59760486
Ref: library/abc abc ABCMeta __subclasshook__9761093
Ref: 35c89761093
Ref: library/abc abc abstractmethod9763790
Ref: 9c29763790
Ref: library/abc abc abstractclassmethod9766580
Ref: 9c39766580
Ref: library/abc abc abstractstaticmethod9767256
Ref: 9c49767256
Ref: library/abc abc abstractproperty9767934
Ref: 9c19767934
Ref: library/abc abc get_cache_token9769181
Ref: 80b9769181
Ref: abc — Abstract Base Classes-Footnote-19769594
Ref: abc — Abstract Base Classes-Footnote-29769656
Ref: abc — Abstract Base Classes-Footnote-39769705
Ref: abc — Abstract Base Classes-Footnote-49769754
Node: atexit — Exit handlers9769865
Ref: library/atexit doc9770045
Ref: 35c99770045
Ref: library/atexit atexit-exit-handlers9770045
Ref: 35ca9770045
Ref: library/atexit module-atexit9770045
Ref: c9770045
Ref: library/atexit atexit register9770953
Ref: e799770953
Ref: library/atexit atexit unregister9772004
Ref: 35cb9772004
Node: atexit Example9772565
Ref: library/atexit atexit-example9772640
Ref: 35cc9772640
Ref: library/atexit id19772640
Ref: 35cd9772640
Node: traceback — Print or retrieve a stack traceback9773901
Ref: library/traceback doc9774095
Ref: 35ce9774095
Ref: library/traceback module-traceback9774095
Ref: 1139774095
Ref: library/traceback traceback-print-or-retrieve-a-stack-traceback9774095
Ref: 35cf9774095
Ref: library/traceback traceback print_tb9774875
Ref: 76d9774875
Ref: library/traceback traceback print_exception9775426
Ref: 1fee9775426
Ref: library/traceback traceback print_exc9776575
Ref: 35d09776575
Ref: library/traceback traceback print_last9776741
Ref: 35d19776741
Ref: library/traceback traceback print_stack9777068
Ref: 76e9777068
Ref: library/traceback traceback extract_tb9777613
Ref: 35d29777613
Ref: library/traceback traceback extract_stack9778354
Ref: 35d39778354
Ref: library/traceback traceback format_list9778657
Ref: 35d49778657
Ref: library/traceback traceback format_exception_only9779166
Ref: 322d9779166
Ref: library/traceback traceback format_exception9779785
Ref: 35d59779785
Ref: library/traceback traceback format_exc9780394
Ref: 35d69780394
Ref: library/traceback traceback format_tb9780554
Ref: 35279780554
Ref: library/traceback traceback format_stack9780670
Ref: 35d79780670
Ref: library/traceback traceback clear_frames9780795
Ref: 8e59780795
Ref: library/traceback traceback walk_stack9781004
Ref: 7689781004
Ref: library/traceback traceback walk_tb9781314
Ref: 7699781314
Ref: traceback — Print or retrieve a stack traceback-Footnote-19781746
Node: TracebackException Objects9781814
Ref: library/traceback tracebackexception-objects9781955
Ref: 35d99781955
Ref: library/traceback traceback TracebackException9782195
Ref: 76a9782195
Ref: library/traceback traceback TracebackException __cause__9782580
Ref: 35da9782580
Ref: library/traceback traceback TracebackException __context__9782688
Ref: 35db9782688
Ref: library/traceback traceback TracebackException __suppress_context__9782810
Ref: 35dc9782810
Ref: library/traceback traceback TracebackException stack9782929
Ref: 35dd9782929
Ref: library/traceback traceback TracebackException exc_type9783022
Ref: 35de9783022
Ref: library/traceback traceback TracebackException filename9783100
Ref: 35df9783100
Ref: library/traceback traceback TracebackException lineno9783201
Ref: 35e09783201
Ref: library/traceback traceback TracebackException text9783302
Ref: 35e19783302
Ref: library/traceback traceback TracebackException offset9783394
Ref: 35e29783394
Ref: library/traceback traceback TracebackException msg9783514
Ref: 35e39783514
Ref: library/traceback traceback TracebackException from_exception9783598
Ref: 35e49783598
Ref: library/traceback traceback TracebackException format9783975
Ref: 35e59783975
Ref: library/traceback traceback TracebackException format_exception_only9784523
Ref: 35e69784523
Node: StackSummary Objects9785070
Ref: library/traceback stacksummary-objects9785240
Ref: 35e79785240
Ref: library/traceback traceback StackSummary9785411
Ref: 76b9785411
Ref: library/traceback traceback StackSummary extract9785446
Ref: 35d89785446
Ref: library/traceback traceback StackSummary from_list9786265
Ref: 35e89786265
Ref: library/traceback traceback StackSummary format9786562
Ref: 35e99786562
Node: FrameSummary Objects9787182
Ref: library/traceback framesummary-objects9787344
Ref: 35ea9787344
Ref: library/traceback traceback FrameSummary9787511
Ref: 76c9787511
Node: Traceback Examples9788256
Ref: library/traceback traceback-example9788389
Ref: 35eb9788389
Ref: library/traceback traceback-examples9788389
Ref: 35ec9788389
Node: __future__ — Future statement definitions9793270
Ref: library/__future__ doc9793474
Ref: 35ed9793474
Ref: library/__future__ future-future-statement-definitions9793474
Ref: 35ee9793474
Ref: library/__future__ module-__future__9793474
Ref: 09793474
Ref: __future__ — Future statement definitions-Footnote-19798649
Ref: __future__ — Future statement definitions-Footnote-29798718
Ref: __future__ — Future statement definitions-Footnote-39798767
Ref: __future__ — Future statement definitions-Footnote-49798816
Ref: __future__ — Future statement definitions-Footnote-59798865
Ref: __future__ — Future statement definitions-Footnote-69798914
Ref: __future__ — Future statement definitions-Footnote-79798963
Ref: __future__ — Future statement definitions-Footnote-89799012
Ref: __future__ — Future statement definitions-Footnote-99799061
Ref: __future__ — Future statement definitions-Footnote-109799110
Node: gc — Garbage Collector interface9799160
Ref: library/gc doc9799347
Ref: 35ef9799347
Ref: library/gc gc-garbage-collector-interface9799347
Ref: 35f09799347
Ref: library/gc module-gc9799347
Ref: 869799347
Ref: library/gc gc enable9800274
Ref: 35f19800274
Ref: library/gc gc disable9800345
Ref: 35f29800345
Ref: library/gc gc isenabled9800418
Ref: 35f39800418
Ref: library/gc gc collect9800509
Ref: 22c9800509
Ref: library/gc gc set_debug9801144
Ref: 35f49801144
Ref: library/gc gc get_debug9801411
Ref: 35f59801411
Ref: library/gc gc get_objects9801490
Ref: 1cb9801490
Ref: library/gc gc get_stats9801805
Ref: 8429801805
Ref: library/gc gc set_threshold9802499
Ref: 35f69802499
Ref: library/gc gc get_count9803715
Ref: 35f79803715
Ref: library/gc gc get_threshold9803840
Ref: 35f89803840
Ref: library/gc gc get_referrers9803985
Ref: 34fa9803985
Ref: library/gc gc get_referents9804890
Ref: 35f99804890
Ref: library/gc gc is_tracked9805527
Ref: c969805527
Ref: library/gc gc freeze9806242
Ref: 3819806242
Ref: library/gc gc unfreeze9806776
Ref: 3829806776
Ref: library/gc gc get_freeze_count9806935
Ref: 3839806935
Ref: library/gc gc garbage9807178
Ref: b339807178
Ref: library/gc gc callbacks9808044
Ref: 9ff9808044
Ref: library/gc gc DEBUG_STATS9809375
Ref: 35fc9809375
Ref: library/gc gc DEBUG_COLLECTABLE9809518
Ref: 35fd9809518
Ref: library/gc gc DEBUG_UNCOLLECTABLE9809604
Ref: b349809604
Ref: library/gc gc DEBUG_SAVEALL9809984
Ref: 35fb9809984
Ref: library/gc gc DEBUG_LEAK9810176
Ref: 35fe9810176
Ref: gc — Garbage Collector interface-Footnote-19810420
Node: inspect — Inspect live objects9810469
Ref: library/inspect doc9810654
Ref: 35ff9810654
Ref: library/inspect inspect-inspect-live-objects9810654
Ref: 36009810654
Ref: library/inspect module-inspect9810654
Ref: a09810654
Ref: inspect — Inspect live objects-Footnote-19811826
Node: Types and members9811892
Ref: library/inspect inspect-types9812009
Ref: 36019812009
Ref: library/inspect types-and-members9812009
Ref: 36029812009
Ref: library/inspect inspect getmembers9825249
Ref: 36039825249
Ref: library/inspect inspect getmodulename9825861
Ref: 5e79825861
Ref: library/inspect inspect ismodule9826538
Ref: 36069826538
Ref: library/inspect inspect isclass9826630
Ref: 36079826630
Ref: library/inspect inspect ismethod9826769
Ref: 36089826769
Ref: library/inspect inspect isfunction9826885
Ref: 36099826885
Ref: library/inspect inspect isgeneratorfunction9827063
Ref: f569827063
Ref: library/inspect inspect isgenerator9827356
Ref: 360b9827356
Ref: library/inspect inspect iscoroutinefunction9827454
Ref: 6ec9827454
Ref: library/inspect inspect iscoroutine9827845
Ref: 6eb9827845
Ref: library/inspect inspect isawaitable9828031
Ref: 6ed9828031
Ref: library/inspect inspect isasyncgenfunction9828421
Ref: f579828421
Ref: library/inspect inspect isasyncgen9828891
Ref: 360c9828891
Ref: library/inspect inspect istraceback9829119
Ref: 360d9829119
Ref: library/inspect inspect isframe9829217
Ref: 360e9829217
Ref: library/inspect inspect iscode9829307
Ref: 360f9829307
Ref: library/inspect inspect isbuiltin9829395
Ref: 36109829395
Ref: library/inspect inspect isroutine9829531
Ref: 36119829531
Ref: library/inspect inspect isabstract9829666
Ref: 36129829666
Ref: library/inspect inspect ismethoddescriptor9829774
Ref: 36139829774
Ref: library/inspect inspect isdatadescriptor9830657
Ref: 36149830657
Ref: library/inspect inspect isgetsetdescriptor9831286
Ref: 36159831286
Ref: library/inspect inspect ismemberdescriptor9831637
Ref: 36169831637
Node: Retrieving source code9831999
Ref: library/inspect inspect-source9832174
Ref: 36179832174
Ref: library/inspect retrieving-source-code9832174
Ref: 36189832174
Ref: library/inspect inspect getdoc9832241
Ref: 1d49832241
Ref: library/inspect inspect getcomments9832674
Ref: 31eb9832674
Ref: library/inspect inspect getfile9833098
Ref: fdc9833098
Ref: library/inspect inspect getmodule9833332
Ref: 361a9833332
Ref: library/inspect inspect getsourcefile9833432
Ref: 361b9833432
Ref: library/inspect inspect getsourcelines9833669
Ref: 361c9833669
Ref: library/inspect inspect getsource9834288
Ref: 11039834288
Ref: library/inspect inspect cleandoc9834738
Ref: 36199834738
Node: Introspecting callables with the Signature object9835149
Ref: library/inspect inspect-signature-object9835331
Ref: 361d9835331
Ref: library/inspect introspecting-callables-with-the-signature-object9835331
Ref: 361e9835331
Ref: library/inspect inspect signature9835648
Ref: 5509835648
Ref: library/inspect inspect Signature9836950
Ref: 6e79836950
Ref: library/inspect inspect Signature empty9837981
Ref: 36219837981
Ref: library/inspect inspect Signature parameters9838101
Ref: 361f9838101
Ref: library/inspect inspect Signature return_annotation9838596
Ref: 36229838596
Ref: library/inspect inspect Signature bind9838815
Ref: 36239838815
Ref: library/inspect inspect Signature bind_partial9839092
Ref: 36249839092
Ref: library/inspect inspect Signature replace9839468
Ref: 36209839468
Ref: library/inspect inspect Signature from_callable9840096
Ref: 6ea9840096
Ref: library/inspect inspect Parameter9840627
Ref: 6e89840627
Ref: library/inspect inspect Parameter empty9840982
Ref: 36269840982
Ref: library/inspect inspect Parameter name9841113
Ref: 36279841113
Ref: library/inspect inspect Parameter default9841577
Ref: 36289841577
Ref: library/inspect inspect Parameter annotation9841768
Ref: 36299841768
Ref: library/inspect inspect Parameter kind9841956
Ref: 362a9841956
Ref: library/inspect inspect Parameter kind description9844675
Ref: 362b9844675
Ref: library/inspect inspect Parameter replace9845090
Ref: 36259845090
Ref: library/inspect inspect BoundArguments9846018
Ref: 99c9846018
Ref: library/inspect inspect BoundArguments arguments9846222
Ref: 362c9846222
Ref: library/inspect inspect BoundArguments args9846960
Ref: 362d9846960
Ref: library/inspect inspect BoundArguments kwargs9847112
Ref: 362e9847112
Ref: library/inspect inspect BoundArguments signature9847262
Ref: 362f9847262
Ref: library/inspect inspect BoundArguments apply_defaults9847360
Ref: 6e99847360
Ref: Introspecting callables with the Signature object-Footnote-19848256
Node: Classes and functions<2>9848305
Ref: library/inspect classes-and-functions9848486
Ref: 36309848486
Ref: library/inspect inspect-classes-functions9848486
Ref: 36319848486
Ref: library/inspect inspect getclasstree9848551
Ref: 36329848551
Ref: library/inspect inspect getargspec9849130
Ref: 5519849130
Ref: library/inspect inspect getfullargspec9850067
Ref: 5529850067
Ref: library/inspect inspect getargvalues9852441
Ref: 7ac9852441
Ref: library/inspect inspect formatargspec9852946
Ref: 7ab9852946
Ref: library/inspect inspect formatargvalues9854021
Ref: 7ad9854021
Ref: library/inspect inspect getmro9854491
Ref: 36339854491
Ref: library/inspect inspect getcallargs9854855
Ref: 7aa9854855
Ref: library/inspect inspect getclosurevars9856104
Ref: a0e9856104
Ref: library/inspect inspect unwrap9856820
Ref: 85d9856820
Node: The interpreter stack9857554
Ref: library/inspect inspect-stack9857716
Ref: 36349857716
Ref: library/inspect the-interpreter-stack9857716
Ref: 36359857716
Ref: library/inspect inspect getframeinfo9859666
Ref: 36369859666
Ref: library/inspect inspect getouterframes9859893
Ref: 6f29859893
Ref: library/inspect inspect getinnerframes9860389
Ref: 6f39860389
Ref: library/inspect inspect currentframe9860882
Ref: 36379860882
Ref: library/inspect inspect stack9861283
Ref: 6f09861283
Ref: library/inspect inspect trace9861677
Ref: 6f19861677
Node: Fetching attributes statically9862155
Ref: library/inspect fetching-attributes-statically9862335
Ref: 36389862335
Ref: library/inspect inspect getattr_static9862917
Ref: bbe9862917
Node: Current State of Generators and Coroutines9864642
Ref: library/inspect current-state-of-generators-and-coroutines9864823
Ref: 36399864823
Ref: library/inspect inspect getgeneratorstate9865252
Ref: bbd9865252
Ref: library/inspect inspect getcoroutinestate9865665
Ref: 6ef9865665
Ref: library/inspect inspect getgeneratorlocals9866500
Ref: a0f9866500
Ref: library/inspect inspect getcoroutinelocals9867374
Ref: 6ee9867374
Node: Code Objects Bit Flags9867609
Ref: library/inspect code-objects-bit-flags9867785
Ref: 363a9867785
Ref: library/inspect inspect-module-co-flags9867785
Ref: 36049867785
Ref: library/inspect inspect CO_OPTIMIZED9867948
Ref: 363b9867948
Ref: library/inspect inspect CO_NEWLOCALS9868035
Ref: 363c9868035
Ref: library/inspect inspect CO_VARARGS9868180
Ref: 363d9868180
Ref: library/inspect inspect CO_VARKEYWORDS9868288
Ref: 363e9868288
Ref: library/inspect inspect CO_NESTED9868400
Ref: 363f9868400
Ref: library/inspect inspect CO_GENERATOR9868494
Ref: 36409868494
Ref: library/inspect inspect CO_NOFREE9868669
Ref: 36419868669
Ref: library/inspect inspect CO_COROUTINE9868760
Ref: 36429868760
Ref: library/inspect inspect CO_ITERABLE_COROUTINE9868995
Ref: 36439868995
Ref: library/inspect inspect CO_ASYNC_GENERATOR9869308
Ref: 36449869308
Ref: Code Objects Bit Flags-Footnote-19869953
Ref: Code Objects Bit Flags-Footnote-29870002
Ref: Code Objects Bit Flags-Footnote-39870051
Node: Command Line Interface<3>9870100
Ref: library/inspect command-line-interface9870225
Ref: 36459870225
Ref: library/inspect inspect-module-cli9870225
Ref: 85c9870225
Ref: library/inspect cmdoption-inspect-details9870600
Ref: 36469870600
Node: site — Site-specific configuration hook9870715
Ref: library/site doc9870857
Ref: 36479870857
Ref: library/site module-site9870857
Ref: eb9870857
Ref: library/site site-site-specific-configuration-hook9870857
Ref: 36489870857
Ref: site — Site-specific configuration hook-Footnote-19876548
Node: Readline configuration9876611
Ref: library/site readline-configuration9876738
Ref: 364a9876738
Ref: library/site rlcompleter-config9876738
Ref: 8da9876738
Node: Module contents<3>9877396
Ref: library/site module-contents9877523
Ref: 364b9877523
Ref: library/site site PREFIXES9877576
Ref: 364c9877576
Ref: library/site site ENABLE_USER_SITE9877657
Ref: 36499877657
Ref: library/site site USER_SITE9878093
Ref: 12819878093
Ref: library/site site USER_BASE9878645
Ref: 12939878645
Ref: library/site site main9879216
Ref: 12829879216
Ref: library/site site addsitedir9879565
Ref: 364d9879565
Ref: library/site site getsitepackages9879771
Ref: bc69879771
Ref: library/site site getuserbase9879905
Ref: bc79879905
Ref: library/site site getusersitepackages9880149
Ref: bc89880149
Ref: library/site cmdoption-site-user-base9880930
Ref: 364e9880930
Ref: library/site cmdoption-site-user-site9881012
Ref: 364f9881012
Ref: Module contents<3>-Footnote-19881624
Node: Custom Python Interpreters9881673
Ref: library/custominterp doc9881821
Ref: 36509881821
Ref: library/custominterp custom-python-interpreters9881821
Ref: 36519881821
Ref: library/custominterp custominterp9881821
Ref: 36529881821
Node: code — Interpreter base classes9882406
Ref: library/code doc9882541
Ref: 36539882541
Ref: library/code code-interpreter-base-classes9882541
Ref: 36549882541
Ref: library/code module-code9882541
Ref: 1b9882541
Ref: library/code code InteractiveInterpreter9882959
Ref: 36559882959
Ref: library/code code InteractiveConsole9883472
Ref: 17399883472
Ref: library/code code interact9883782
Ref: 36569883782
Ref: library/code code compile_command9884541
Ref: 36589884541
Ref: code — Interpreter base classes-Footnote-19885820
Node: Interactive Interpreter Objects9885883
Ref: library/code interactive-interpreter-objects9886020
Ref: 36599886020
Ref: library/code interpreter-objects9886020
Ref: 365a9886020
Ref: library/code code InteractiveInterpreter runsource9886103
Ref: 365b9886103
Ref: library/code code InteractiveInterpreter runcode9887387
Ref: 365d9887387
Ref: library/code code InteractiveInterpreter showsyntaxerror9887846
Ref: 365c9887846
Ref: library/code code InteractiveInterpreter showtraceback9888320
Ref: 69b9888320
Ref: library/code code InteractiveInterpreter write9888701
Ref: 365e9888701
Node: Interactive Console Objects9888921
Ref: library/code console-objects9889058
Ref: 365f9889058
Ref: library/code interactive-console-objects9889058
Ref: 36609889058
Ref: library/code code InteractiveConsole interact9889322
Ref: 36619889322
Ref: library/code code InteractiveConsole push9890175
Ref: 36629890175
Ref: library/code code InteractiveConsole resetbuffer9890870
Ref: 36639890870
Ref: library/code code InteractiveConsole raw_input9890979
Ref: 36579890979
Node: codeop — Compile Python code9891339
Ref: library/codeop doc9891474
Ref: 36649891474
Ref: library/codeop codeop-compile-python-code9891474
Ref: 36659891474
Ref: library/codeop module-codeop9891474
Ref: 1d9891474
Ref: library/codeop codeop compile_command9892435
Ref: 36669892435
Ref: library/codeop codeop Compile9893793
Ref: 36679893793
Ref: library/codeop codeop CommandCompiler9894194
Ref: 36689894194
Ref: codeop — Compile Python code-Footnote-19894612
Node: Importing Modules9894677
Ref: library/modules doc9894826
Ref: 36699894826
Ref: library/modules importing-modules9894826
Ref: 366a9894826
Ref: library/modules modules9894826
Ref: 366b9894826
Node: zipimport — Import modules from Zip archives9895369
Ref: library/zipimport doc9895515
Ref: 366c9895515
Ref: library/zipimport module-zipimport9895515
Ref: 1439895515
Ref: library/zipimport zipimport-import-modules-from-zip-archives9895515
Ref: 366d9895515
Ref: library/zipimport zipimport ZipImportError9897618
Ref: 366e9897618
Ref: zipimport — Import modules from Zip archives-Footnote-19897910
Ref: zipimport — Import modules from Zip archives-Footnote-29897978
Ref: zipimport — Import modules from Zip archives-Footnote-39898046
Ref: zipimport — Import modules from Zip archives-Footnote-49898095
Ref: zipimport — Import modules from Zip archives-Footnote-59898144
Ref: zipimport — Import modules from Zip archives-Footnote-69898193
Node: zipimporter Objects9898242
Ref: library/zipimport id19898365
Ref: 366f9898365
Ref: library/zipimport zipimporter-objects9898365
Ref: 36709898365
Ref: library/zipimport zipimport zipimporter9898488
Ref: 36719898488
Ref: library/zipimport zipimport zipimporter find_module9898959
Ref: 36729898959
Ref: library/zipimport zipimport zipimporter get_code9899383
Ref: 36739899383
Ref: library/zipimport zipimport zipimporter get_data9899561
Ref: ff39899561
Ref: library/zipimport zipimport zipimporter get_filename9899833
Ref: 36749899833
Ref: library/zipimport zipimport zipimporter get_source9900093
Ref: 36759900093
Ref: library/zipimport zipimport zipimporter is_package9900383
Ref: 36769900383
Ref: library/zipimport zipimport zipimporter load_module9900594
Ref: 36779900594
Ref: library/zipimport zipimport zipimporter archive9900872
Ref: 36789900872
Ref: library/zipimport zipimport zipimporter prefix9901005
Ref: 36799901005
Node: Examples<28>9901412
Ref: library/zipimport examples9901535
Ref: 367a9901535
Ref: library/zipimport zipimport-examples9901535
Ref: 367b9901535
Node: pkgutil — Package extension utility9902150
Ref: library/pkgutil doc9902351
Ref: 367c9902351
Ref: library/pkgutil module-pkgutil9902351
Ref: cd9902351
Ref: library/pkgutil pkgutil-package-extension-utility9902351
Ref: 367d9902351
Ref: library/pkgutil pkgutil ModuleInfo9902636
Ref: 6029902636
Ref: library/pkgutil pkgutil extend_path9902790
Ref: 367e9902790
Ref: library/pkgutil pkgutil ImpImporter9904452
Ref: 367f9904452
Ref: library/pkgutil pkgutil ImpLoader9905151
Ref: 36809905151
Ref: library/pkgutil pkgutil find_loader9905480
Ref: 36819905480
Ref: library/pkgutil pkgutil get_importer9906057
Ref: 36829906057
Ref: library/pkgutil pkgutil get_loader9906572
Ref: 36839906572
Ref: library/pkgutil pkgutil iter_importers9907289
Ref: b079907289
Ref: library/pkgutil pkgutil iter_modules9907988
Ref: 6019907988
Ref: library/pkgutil pkgutil walk_packages9908834
Ref: 4809908834
Ref: library/pkgutil pkgutil get_data9910382
Ref: 36849910382
Ref: pkgutil — Package extension utility-Footnote-19911542
Ref: pkgutil — Package extension utility-Footnote-29911608
Ref: pkgutil — Package extension utility-Footnote-39911657
Ref: pkgutil — Package extension utility-Footnote-49911706
Ref: pkgutil — Package extension utility-Footnote-59911755
Ref: pkgutil — Package extension utility-Footnote-69911804
Ref: pkgutil — Package extension utility-Footnote-79911853
Ref: pkgutil — Package extension utility-Footnote-89911902
Ref: pkgutil — Package extension utility-Footnote-99911951
Ref: pkgutil — Package extension utility-Footnote-109912000
Ref: pkgutil — Package extension utility-Footnote-119912050
Ref: pkgutil — Package extension utility-Footnote-129912100
Ref: pkgutil — Package extension utility-Footnote-139912150
Ref: pkgutil — Package extension utility-Footnote-149912200
Node: modulefinder — Find modules used by a script9912250
Ref: library/modulefinder doc9912452
Ref: 36869912452
Ref: library/modulefinder module-modulefinder9912452
Ref: b49912452
Ref: library/modulefinder modulefinder-find-modules-used-by-a-script9912452
Ref: 36879912452
Ref: library/modulefinder modulefinder AddPackagePath9912970
Ref: 36889912970
Ref: library/modulefinder modulefinder ReplacePackage9913120
Ref: 36899913120
Ref: library/modulefinder modulefinder ModuleFinder9913283
Ref: f139913283
Ref: library/modulefinder modulefinder ModuleFinder report9913942
Ref: 368b9913942
Ref: library/modulefinder modulefinder ModuleFinder run_script9914157
Ref: 368a9914157
Ref: library/modulefinder modulefinder ModuleFinder modules9914295
Ref: 368c9914295
Ref: modulefinder — Find modules used by a script-Footnote-19914519
Node: Example usage of ModuleFinder9914590
Ref: library/modulefinder example-usage-of-modulefinder9914702
Ref: 368e9914702
Ref: library/modulefinder modulefinder-example9914702
Ref: 368d9914702
Node: runpy — Locating and executing Python modules9915908
Ref: library/runpy doc9916115
Ref: 368f9916115
Ref: library/runpy module-runpy9916115
Ref: e29916115
Ref: library/runpy runpy-locating-and-executing-python-modules9916115
Ref: 36909916115
Ref: library/runpy runpy run_module9917150
Ref: 12769917150
Ref: library/runpy runpy run_path9920413
Ref: ca49920413
Ref: runpy — Locating and executing Python modules-Footnote-19924700
Ref: runpy — Locating and executing Python modules-Footnote-29924764
Ref: runpy — Locating and executing Python modules-Footnote-39924813
Ref: runpy — Locating and executing Python modules-Footnote-49924862
Ref: runpy — Locating and executing Python modules-Footnote-59924911
Ref: runpy — Locating and executing Python modules-Footnote-69924960
Ref: runpy — Locating and executing Python modules-Footnote-79925009
Ref: runpy — Locating and executing Python modules-Footnote-89925058
Node: importlib — The implementation of import9925107
Ref: library/importlib doc9925292
Ref: 36919925292
Ref: library/importlib importlib-the-implementation-of-import9925292
Ref: 36929925292
Ref: library/importlib module-importlib9925292
Ref: 9b9925292
Ref: importlib — The implementation of import-Footnote-19926065
Node: Introduction<12>9926143
Ref: library/importlib introduction9926260
Ref: 36939926260
Ref: Introduction<12>-Footnote-19928095
Ref: Introduction<12>-Footnote-29928147
Ref: Introduction<12>-Footnote-39928196
Ref: Introduction<12>-Footnote-49928245
Ref: Introduction<12>-Footnote-59928294
Ref: Introduction<12>-Footnote-69928343
Ref: Introduction<12>-Footnote-79928392
Ref: Introduction<12>-Footnote-89928441
Ref: Introduction<12>-Footnote-99928490
Ref: Introduction<12>-Footnote-109928539
Ref: Introduction<12>-Footnote-119928589
Ref: Introduction<12>-Footnote-129928639
Ref: Introduction<12>-Footnote-139928689
Node: Functions<10>9928739
Ref: library/importlib functions9928922
Ref: 36949928922
Ref: library/importlib importlib __import__9928961
Ref: 9a29928961
Ref: library/importlib importlib import_module9929269
Ref: b069929269
Ref: library/importlib importlib find_loader9930597
Ref: 92b9930597
Ref: library/importlib importlib invalidate_caches9931601
Ref: 4929931601
Ref: library/importlib importlib reload9932050
Ref: 38e9932050
Node: importlib abc – Abstract base classes related to import9935252
Ref: library/importlib importlib-abc-abstract-base-classes-related-to-import9935452
Ref: 36959935452
Ref: library/importlib module-importlib abc9935452
Ref: 9c9935452
Ref: library/importlib importlib abc Finder9936240
Ref: 9a99936240
Ref: library/importlib importlib abc Finder find_module9936449
Ref: 36969936449
Ref: library/importlib importlib abc MetaPathFinder9936899
Ref: 9a79936899
Ref: library/importlib importlib abc MetaPathFinder find_spec9937104
Ref: 4589937104
Ref: library/importlib importlib abc MetaPathFinder find_module9937858
Ref: 4579937858
Ref: library/importlib importlib abc MetaPathFinder invalidate_caches9938682
Ref: 36989938682
Ref: library/importlib importlib abc PathEntryFinder9939091
Ref: 9a89939091
Ref: library/importlib importlib abc PathEntryFinder find_spec9939508
Ref: 45a9939508
Ref: library/importlib importlib abc PathEntryFinder find_loader9940146
Ref: 4599940146
Ref: library/importlib importlib abc PathEntryFinder find_module9941349
Ref: 92f9941349
Ref: library/importlib importlib abc PathEntryFinder invalidate_caches9941622
Ref: 36999941622
Ref: library/importlib importlib abc Loader9941896
Ref: 7b69941896
Ref: library/importlib importlib abc Loader create_module9942320
Ref: 5499942320
Ref: library/importlib importlib abc Loader exec_module9942753
Ref: 5d99942753
Ref: library/importlib importlib abc Loader load_module9943221
Ref: 5d89943221
Ref: library/importlib importlib abc Loader module_repr9946299
Ref: 9359946299
Ref: library/importlib importlib abc ResourceReader9946798
Ref: 3379946798
Ref: library/importlib importlib abc ResourceReader open_resource9948456
Ref: 369a9948456
Ref: library/importlib importlib abc ResourceReader resource_path9948717
Ref: 369b9948717
Ref: library/importlib importlib abc ResourceReader is_resource9948953
Ref: 369c9948953
Ref: library/importlib importlib abc ResourceReader contents9949167
Ref: f729949167
Ref: library/importlib importlib abc ResourceLoader9950035
Ref: 45b9950035
Ref: library/importlib importlib abc ResourceLoader get_data9950409
Ref: 36859950409
Ref: library/importlib importlib abc InspectLoader9951097
Ref: 8549951097
Ref: library/importlib importlib abc InspectLoader get_code9951281
Ref: 8559951281
Ref: library/importlib importlib abc InspectLoader get_source9951864
Ref: 8599951864
Ref: library/importlib importlib abc InspectLoader is_package9952446
Ref: 369d9952446
Ref: library/importlib importlib abc InspectLoader source_to_code9952817
Ref: 6e39952817
Ref: library/importlib importlib abc InspectLoader exec_module9953461
Ref: 9339953461
Ref: library/importlib importlib abc InspectLoader load_module9953593
Ref: 9309953593
Ref: library/importlib importlib abc ExecutionLoader9953786
Ref: 369e9953786
Ref: library/importlib importlib abc ExecutionLoader get_filename9954033
Ref: 369f9954033
Ref: library/importlib importlib abc FileLoader9954580
Ref: 9ab9954580
Ref: library/importlib importlib abc FileLoader name9955074
Ref: 36a09955074
Ref: library/importlib importlib abc FileLoader path9955157
Ref: 36a19955157
Ref: library/importlib importlib abc FileLoader load_module9955226
Ref: 9319955226
Ref: library/importlib importlib abc FileLoader get_filename9955412
Ref: 36a29955412
Ref: library/importlib importlib abc FileLoader get_data9955506
Ref: 36a39955506
Ref: library/importlib importlib abc SourceLoader9955627
Ref: 36a49955627
Ref: library/importlib importlib abc SourceLoader path_stats9956724
Ref: ae19956724
Ref: library/importlib importlib abc SourceLoader path_mtime9957502
Ref: ae09957502
Ref: library/importlib importlib abc SourceLoader set_data9958050
Ref: 36a59958050
Ref: library/importlib importlib abc SourceLoader get_code9958565
Ref: 36a69958565
Ref: library/importlib importlib abc SourceLoader exec_module9958688
Ref: 9349958688
Ref: library/importlib importlib abc SourceLoader load_module9958829
Ref: 9329958829
Ref: library/importlib importlib abc SourceLoader get_source9959031
Ref: 94d9959031
Ref: library/importlib importlib abc SourceLoader is_package9959158
Ref: 36a79959158
Ref: importlib abc – Abstract base classes related to import-Footnote-19959597
Ref: importlib abc – Abstract base classes related to import-Footnote-29959669
Ref: importlib abc – Abstract base classes related to import-Footnote-39959718
Ref: importlib abc – Abstract base classes related to import-Footnote-49959767
Ref: importlib abc – Abstract base classes related to import-Footnote-59959816
Ref: importlib abc – Abstract base classes related to import-Footnote-69959865
Node: importlib resources – Resources9959914
Ref: library/importlib importlib-resources-resources9960149
Ref: 36a89960149
Ref: library/importlib module-importlib resources9960149
Ref: 9e9960149
Ref: library/importlib importlib resources Package9961486
Ref: 36a99961486
Ref: library/importlib importlib resources Resource9961841
Ref: 36aa9961841
Ref: library/importlib importlib resources open_binary9962078
Ref: 36ab9962078
Ref: library/importlib importlib resources open_text9962599
Ref: 36ac9962599
Ref: library/importlib importlib resources read_binary9963312
Ref: 36ad9963312
Ref: library/importlib importlib resources read_text9963834
Ref: 36ae9963834
Ref: library/importlib importlib resources path9964537
Ref: 36af9964537
Ref: library/importlib importlib resources is_resource9965254
Ref: 36b09965254
Ref: library/importlib importlib resources contents9965575
Ref: f719965575
Ref: importlib resources – Resources-Footnote-19966006
Ref: importlib resources – Resources-Footnote-29966085
Ref: importlib resources – Resources-Footnote-39966156
Ref: importlib resources – Resources-Footnote-49966249
Ref: importlib resources – Resources-Footnote-59966320
Node: importlib machinery – Importers and path hooks9966396
Ref: library/importlib importlib-machinery-importers-and-path-hooks9966619
Ref: 36b19966619
Ref: library/importlib module-importlib machinery9966619
Ref: 9d9966619
Ref: library/importlib importlib machinery SOURCE_SUFFIXES9966950
Ref: 36b29966950
Ref: library/importlib importlib machinery DEBUG_BYTECODE_SUFFIXES9967119
Ref: 36b39967119
Ref: library/importlib importlib machinery OPTIMIZED_BYTECODE_SUFFIXES9967386
Ref: 36b59967386
Ref: library/importlib importlib machinery BYTECODE_SUFFIXES9967653
Ref: 36b49967653
Ref: library/importlib importlib machinery EXTENSION_SUFFIXES9967942
Ref: 36b69967942
Ref: library/importlib importlib machinery all_suffixes9968117
Ref: 36059968117
Ref: library/importlib importlib machinery BuiltinImporter9968551
Ref: 54a9968551
Ref: library/importlib importlib machinery FrozenImporter9969116
Ref: 94b9969116
Ref: library/importlib importlib machinery WindowsRegistryFinder9969439
Ref: 5da9969439
Ref: library/importlib importlib machinery PathFinder9969925
Ref: 94f9969925
Ref: library/importlib importlib machinery PathFinder find_spec9970240
Ref: 92e9970240
Ref: library/importlib importlib machinery PathFinder find_module9971396
Ref: 92d9971396
Ref: library/importlib importlib machinery PathFinder invalidate_caches9971601
Ref: 4919971601
Ref: library/importlib importlib machinery FileFinder9972207
Ref: 9aa9972207
Ref: library/importlib importlib machinery FileFinder path9973512
Ref: 36b79973512
Ref: library/importlib importlib machinery FileFinder find_spec9973585
Ref: 7b59973585
Ref: library/importlib importlib machinery FileFinder find_loader9973760
Ref: 36b89973760
Ref: library/importlib importlib machinery FileFinder invalidate_caches9973895
Ref: 36b99973895
Ref: library/importlib importlib machinery FileFinder path_hook9973975
Ref: 36ba9973975
Ref: library/importlib importlib machinery SourceFileLoader9974415
Ref: 9ac9974415
Ref: library/importlib importlib machinery SourceFileLoader name9974706
Ref: 36bb9974706
Ref: library/importlib importlib machinery SourceFileLoader path9974796
Ref: 36bc9974796
Ref: library/importlib importlib machinery SourceFileLoader is_package9974862
Ref: 36bd9974862
Ref: library/importlib importlib machinery SourceFileLoader path_stats9974991
Ref: 36be9974991
Ref: library/importlib importlib machinery SourceFileLoader set_data9975127
Ref: 36bf9975127
Ref: library/importlib importlib machinery SourceFileLoader load_module9975266
Ref: 5d69975266
Ref: library/importlib importlib machinery SourcelessFileLoader9975585
Ref: 9ad9975585
Ref: library/importlib importlib machinery SourcelessFileLoader name9976056
Ref: 36c09976056
Ref: library/importlib importlib machinery SourcelessFileLoader path9976140
Ref: 36c19976140
Ref: library/importlib importlib machinery SourcelessFileLoader is_package9976208
Ref: 36c29976208
Ref: library/importlib importlib machinery SourcelessFileLoader get_code9976334
Ref: 36c39976334
Ref: library/importlib importlib machinery SourcelessFileLoader get_source9976470
Ref: 36c49976470
Ref: library/importlib importlib machinery SourcelessFileLoader load_module9976609
Ref: 5d79976609
Ref: library/importlib importlib machinery ExtensionFileLoader9976903
Ref: 54b9976903
Ref: library/importlib importlib machinery ExtensionFileLoader name9977270
Ref: 36c59977270
Ref: library/importlib importlib machinery ExtensionFileLoader path9977347
Ref: 36c69977347
Ref: library/importlib importlib machinery ExtensionFileLoader create_module9977414
Ref: 36c79977414
Ref: library/importlib importlib machinery ExtensionFileLoader exec_module9977591
Ref: 36c89977591
Ref: library/importlib importlib machinery ExtensionFileLoader is_package9977749
Ref: 36c99977749
Ref: library/importlib importlib machinery ExtensionFileLoader get_code9977933
Ref: 36ca9977933
Ref: library/importlib importlib machinery ExtensionFileLoader get_source9978042
Ref: 36cb9978042
Ref: library/importlib importlib machinery ExtensionFileLoader get_filename9978158
Ref: 85a9978158
Ref: library/importlib importlib machinery ModuleSpec9978268
Ref: 14039978268
Ref: library/importlib importlib machinery ModuleSpec name9979081
Ref: 36cc9979081
Ref: library/importlib importlib machinery ModuleSpec loader9979189
Ref: 36cd9979189
Ref: library/importlib importlib machinery ModuleSpec origin9979342
Ref: 36ce9979342
Ref: library/importlib importlib machinery ModuleSpec submodule_search_locations9979703
Ref: 36cf9979703
Ref: library/importlib importlib machinery ModuleSpec loader_state9979868
Ref: 36d09979868
Ref: library/importlib importlib machinery ModuleSpec cached9979993
Ref: 36d19979993
Ref: library/importlib importlib machinery ModuleSpec parent9980123
Ref: 36d29980123
Ref: library/importlib importlib machinery ModuleSpec has_location9980296
Ref: 36d39980296
Ref: importlib machinery – Importers and path hooks-Footnote-19980480
Ref: importlib machinery – Importers and path hooks-Footnote-29980559
Ref: importlib machinery – Importers and path hooks-Footnote-39980608
Ref: importlib machinery – Importers and path hooks-Footnote-49980657
Node: importlib util – Utility code for importers9980706
Ref: library/importlib importlib-util-utility-code-for-importers9980908
Ref: 36d49980908
Ref: library/importlib module-importlib util9980908
Ref: 9f9980908
Ref: library/importlib importlib util MAGIC_NUMBER9981234
Ref: 8569981234
Ref: library/importlib importlib util cache_from_source9981477
Ref: 54c9981477
Ref: library/importlib importlib util source_from_cache9983386
Ref: 54d9983386
Ref: library/importlib importlib util decode_source9984011
Ref: 8589984011
Ref: library/importlib importlib util resolve_name9984281
Ref: 36d59984281
Ref: library/importlib importlib util find_spec9984981
Ref: 92c9984981
Ref: library/importlib importlib util module_from_spec9985874
Ref: 6e49985874
Ref: library/importlib importlib util module_for_loader9986507
Ref: 9369986507
Ref: library/importlib importlib util set_loader9988284
Ref: 9379988284
Ref: library/importlib importlib util set_package9988910
Ref: 9389988910
Ref: library/importlib importlib util spec_from_loader9989316
Ref: 36979989316
Ref: library/importlib importlib util spec_from_file_location9989762
Ref: 54e9989762
Ref: library/importlib importlib util source_hash9990236
Ref: 36d69990236
Ref: library/importlib importlib util LazyLoader9990508
Ref: 5489990508
Ref: library/importlib importlib util LazyLoader factory9991991
Ref: 36d89991991
Ref: importlib util – Utility code for importers-Footnote-19992504
Ref: importlib util – Utility code for importers-Footnote-29992577
Ref: importlib util – Utility code for importers-Footnote-39992626
Ref: importlib util – Utility code for importers-Footnote-49992675
Ref: importlib util – Utility code for importers-Footnote-59992724
Ref: importlib util – Utility code for importers-Footnote-69992773
Node: Examples<29>9992822
Ref: library/importlib examples9992967
Ref: 36d99992967
Ref: library/importlib importlib-examples9992967
Ref: 36da9992967
Node: Importing programmatically9993232
Ref: library/importlib importing-programmatically9993352
Ref: 36db9993352
Node: Checking if a module can be imported9993578
Ref: library/importlib checking-if-a-module-can-be-imported9993739
Ref: 36dc9993739
Node: Importing a source file directly9994459
Ref: library/importlib importing-a-source-file-directly9994616
Ref: 36dd9994616
Node: Setting up an importer9995130
Ref: library/importlib setting-up-an-importer9995288
Ref: 36de9995288
Node: Approximating importlib import_module9996792
Ref: library/importlib approximating-importlib-import-module9996909
Ref: 36df9996909
Node: Using importlib metadata9998376
Ref: library/importlib metadata doc9998505
Ref: 36e09998505
Ref: library/importlib metadata using9998505
Ref: 36e19998505
Ref: library/importlib metadata using-importlib-metadata9998505
Ref: 36e29998505
Ref: Using importlib metadata-Footnote-19999833
Ref: Using importlib metadata-Footnote-29999918
Ref: Using importlib metadata-Footnote-310000003
Ref: Using importlib metadata-Footnote-410000088
Ref: Using importlib metadata-Footnote-510000160
Ref: Using importlib metadata-Footnote-610000198
Node: Overview<2>10000248
Ref: library/importlib metadata overview10000346
Ref: 36e310000346
Node: Functional API<2>10001744
Ref: library/importlib metadata functional-api10001864
Ref: 36e910001864
Node: Entry points10002116
Ref: library/importlib metadata entry-points10002212
Ref: 36e410002212
Ref: library/importlib metadata id110002212
Ref: 36ea10002212
Ref: Entry points-Footnote-110003373
Node: Distribution metadata10003484
Ref: library/importlib metadata distribution-metadata10003610
Ref: 36eb10003610
Ref: library/importlib metadata metadata10003610
Ref: 36e510003610
Ref: Distribution metadata-Footnote-110004091
Node: Distribution versions10004436
Ref: library/importlib metadata distribution-versions10004568
Ref: 36ec10004568
Ref: library/importlib metadata version10004568
Ref: 36e610004568
Node: Distribution files10004774
Ref: library/importlib metadata distribution-files10004910
Ref: 36ed10004910
Ref: library/importlib metadata files10004910
Ref: 36e710004910
Ref: Distribution files-Footnote-110006228
Ref: Distribution files-Footnote-210006296
Node: Distribution requirements10006393
Ref: library/importlib metadata distribution-requirements10006499
Ref: 36ee10006499
Ref: library/importlib metadata requirements10006499
Ref: 36e810006499
Node: Distributions10006763
Ref: library/importlib metadata distributions10006902
Ref: 36ef10006902
Ref: Distributions-Footnote-110007786
Node: Extending the search algorithm10007836
Ref: library/importlib metadata extending-the-search-algorithm10007949
Ref: 36f010007949
Ref: Extending the search algorithm-Footnote-110009694
Ref: Extending the search algorithm-Footnote-210009771
Ref: Extending the search algorithm-Footnote-310009841
Node: Python Language Services10009906
Ref: library/language doc10010051
Ref: 36f110010051
Ref: library/language language10010051
Ref: 36f210010051
Ref: library/language python-language-services10010051
Ref: 36f310010051
Node: parser — Access Python parse trees10010957
Ref: library/parser doc10011092
Ref: 36f410011092
Ref: library/parser module-parser10011092
Ref: c710011092
Ref: library/parser parser-access-python-parse-trees10011092
Ref: 36f510011092
Node: Creating ST Objects10016302
Ref: library/parser creating-st-objects10016424
Ref: 36fb10016424
Ref: library/parser creating-sts10016424
Ref: 36fc10016424
Ref: library/parser parser expr10016670
Ref: 36f610016670
Ref: library/parser parser suite10017005
Ref: 36f710017005
Ref: library/parser parser sequence2st10017342
Ref: 36f810017342
Ref: library/parser parser tuple2st10018756
Ref: 36ff10018756
Node: Converting ST Objects10018925
Ref: library/parser converting-st-objects10019077
Ref: 370010019077
Ref: library/parser converting-sts10019077
Ref: 370110019077
Ref: library/parser parser st2list10019391
Ref: 36f910019391
Ref: library/parser parser st2tuple10020465
Ref: 36fa10020465
Ref: library/parser parser compilest10021009
Ref: 36fe10021009
Node: Queries on ST Objects10022172
Ref: library/parser queries-on-st-objects10022334
Ref: 370210022334
Ref: library/parser querying-sts10022334
Ref: 370310022334
Ref: library/parser parser isexpr10022706
Ref: 370410022706
Ref: library/parser parser issuite10023189
Ref: 370510023189
Node: Exceptions and Error Handling10023549
Ref: library/parser exceptions-and-error-handling10023700
Ref: 370610023700
Ref: library/parser st-errors10023700
Ref: 370710023700
Ref: library/parser parser ParserError10023995
Ref: 36fd10023995
Node: ST Objects10025156
Ref: library/parser id110025314
Ref: 370810025314
Ref: library/parser st-objects10025314
Ref: 370910025314
Ref: library/parser parser STType10025502
Ref: 370a10025502
Ref: library/parser parser ST compile10025686
Ref: 370b10025686
Ref: library/parser parser ST isexpr10025782
Ref: 370c10025782
Ref: library/parser parser ST issuite10025840
Ref: 370d10025840
Ref: library/parser parser ST tolist10025900
Ref: 370e10025900
Ref: library/parser parser ST totuple10026011
Ref: 370f10026011
Node: Example Emulation of compile10026124
Ref: library/parser example-emulation-of-compile10026244
Ref: 371010026244
Node: ast — Abstract Syntax Trees10027268
Ref: library/ast doc10027465
Ref: 371110027465
Ref: library/ast ast-abstract-syntax-trees10027465
Ref: 371210027465
Ref: library/ast module-ast10027465
Ref: 810027465
Ref: ast — Abstract Syntax Trees-Footnote-110028410
Node: Node classes10028472
Ref: library/ast node-classes10028575
Ref: 371410028575
Ref: library/ast ast AST10028620
Ref: 371310028620
Ref: library/ast ast AST _fields10029443
Ref: 371610029443
Ref: library/ast ast AST lineno10030245
Ref: 371710030245
Ref: library/ast ast AST col_offset10030272
Ref: 371810030272
Ref: library/ast ast AST end_lineno10030303
Ref: 371910030303
Ref: library/ast ast AST end_col_offset10030334
Ref: 371a10030334
Node: Abstract Grammar10032417
Ref: library/ast abstract-grammar10032540
Ref: 371510032540
Ref: library/ast id110032540
Ref: 371b10032540
Node: ast Helpers10038090
Ref: library/ast ast-helpers10038192
Ref: 371c10038192
Ref: library/ast ast parse10038380
Ref: 1a010038380
Ref: library/ast ast literal_eval10040181
Ref: 49b10040181
Ref: library/ast ast get_docstring10041042
Ref: f8d10041042
Ref: library/ast ast get_source_segment10041461
Ref: 19f10041461
Ref: library/ast ast fix_missing_locations10041911
Ref: 371d10041911
Ref: library/ast ast increment_lineno10042367
Ref: 371e10042367
Ref: library/ast ast copy_location10042599
Ref: 371f10042599
Ref: library/ast ast iter_fields10042833
Ref: 372010042833
Ref: library/ast ast iter_child_nodes10042988
Ref: 372110042988
Ref: library/ast ast walk10043166
Ref: 372210043166
Ref: library/ast ast NodeVisitor10043432
Ref: 27f10043432
Ref: library/ast ast NodeVisitor visit10043774
Ref: 372310043774
Ref: library/ast ast NodeVisitor generic_visit10044054
Ref: 372410044054
Ref: library/ast ast NodeTransformer10044889
Ref: 372510044889
Ref: library/ast ast dump10046303
Ref: ec010046303
Ref: ast Helpers-Footnote-110047040
Ref: ast Helpers-Footnote-210047089
Ref: ast Helpers-Footnote-310047138
Ref: ast Helpers-Footnote-410047187
Node: symtable — Access to the compiler’s symbol tables10047235
Ref: library/symtable doc10047445
Ref: 372610047445
Ref: library/symtable module-symtable10047445
Ref: fc10047445
Ref: library/symtable symtable-access-to-the-compiler-s-symbol-tables10047445
Ref: 372710047445
Ref: symtable — Access to the compiler’s symbol tables-Footnote-110048027
Node: Generating Symbol Tables10048094
Ref: library/symtable generating-symbol-tables10048240
Ref: 372810048240
Ref: library/symtable symtable symtable10048309
Ref: ef810048309
Node: Examining Symbol Tables10048589
Ref: library/symtable examining-symbol-tables10048735
Ref: 372a10048735
Ref: library/symtable symtable SymbolTable10048802
Ref: 372910048802
Ref: library/symtable symtable SymbolTable get_type10048904
Ref: 372b10048904
Ref: library/symtable symtable SymbolTable get_id10049066
Ref: 372c10049066
Ref: library/symtable symtable SymbolTable get_name10049138
Ref: 372d10049138
Ref: library/symtable symtable SymbolTable get_lineno10049441
Ref: 372e10049441
Ref: library/symtable symtable SymbolTable is_optimized10049566
Ref: 372f10049566
Ref: library/symtable symtable SymbolTable is_nested10049675
Ref: 373010049675
Ref: library/symtable symtable SymbolTable has_children10049779
Ref: 373110049779
Ref: library/symtable symtable SymbolTable has_exec10049953
Ref: 373310049953
Ref: library/symtable symtable SymbolTable get_identifiers10050042
Ref: 373410050042
Ref: library/symtable symtable SymbolTable lookup10050139
Ref: 373510050139
Ref: library/symtable symtable SymbolTable get_symbols10050262
Ref: 373710050262
Ref: library/symtable symtable SymbolTable get_children10050387
Ref: 373210050387
Ref: library/symtable symtable Function10050475
Ref: 373810050475
Ref: library/symtable symtable Function get_parameters10050600
Ref: 373910050600
Ref: library/symtable symtable Function get_locals10050721
Ref: 373a10050721
Ref: library/symtable symtable Function get_globals10050824
Ref: 373b10050824
Ref: library/symtable symtable Function get_nonlocals10050929
Ref: 373c10050929
Ref: library/symtable symtable Function get_frees10051038
Ref: 373d10051038
Ref: library/symtable symtable Class10051158
Ref: 373e10051158
Ref: library/symtable symtable Class get_methods10051266
Ref: 373f10051266
Ref: library/symtable symtable Symbol10051390
Ref: 373610051390
Ref: library/symtable symtable Symbol get_name10051546
Ref: 374010051546
Ref: library/symtable symtable Symbol is_referenced10051615
Ref: 374110051615
Ref: library/symtable symtable Symbol is_imported10051715
Ref: 374210051715
Ref: library/symtable symtable Symbol is_parameter10051838
Ref: 374310051838
Ref: library/symtable symtable Symbol is_global10051931
Ref: 374410051931
Ref: library/symtable symtable Symbol is_nonlocal10052016
Ref: f4110052016
Ref: library/symtable symtable Symbol is_declared_global10052105
Ref: ca910052105
Ref: library/symtable symtable Symbol is_local10052242
Ref: 374510052242
Ref: library/symtable symtable Symbol is_free10052338
Ref: 374610052338
Ref: library/symtable symtable Symbol is_assigned10052469
Ref: 374710052469
Ref: library/symtable symtable Symbol is_namespace10052574
Ref: 374810052574
Ref: library/symtable symtable Symbol get_namespaces10053186
Ref: 374910053186
Ref: library/symtable symtable Symbol get_namespace10053281
Ref: 374a10053281
Node: symbol — Constants used with Python parse trees10053450
Ref: library/symbol doc10053679
Ref: 374b10053679
Ref: library/symbol module-symbol10053679
Ref: fb10053679
Ref: library/symbol symbol-constants-used-with-python-parse-trees10053679
Ref: 374c10053679
Ref: library/symbol symbol sym_name10054348
Ref: 374d10054348
Ref: symbol — Constants used with Python parse trees-Footnote-110054603
Node: token — Constants used with Python parse trees10054668
Ref: library/token doc10054883
Ref: 374e10054883
Ref: library/token module-token10054883
Ref: 11010054883
Ref: library/token token-constants-used-with-python-parse-trees10054883
Ref: 374f10054883
Ref: library/token token tok_name10055597
Ref: 375010055597
Ref: library/token token ISTERMINAL10055815
Ref: 375110055815
Ref: library/token token ISNONTERMINAL10055902
Ref: 375210055902
Ref: library/token token ISEOF10055996
Ref: 375310055996
Ref: library/token token ENDMARKER10056127
Ref: 375410056127
Ref: library/token token NAME10056154
Ref: 375510056154
Ref: library/token token NUMBER10056176
Ref: 375610056176
Ref: library/token token STRING10056200
Ref: 375710056200
Ref: library/token token NEWLINE10056224
Ref: 375810056224
Ref: library/token token INDENT10056249
Ref: 375910056249
Ref: library/token token DEDENT10056273
Ref: 375a10056273
Ref: library/token token LPAR10056297
Ref: 375b10056297
Ref: library/token token RPAR10056352
Ref: 375c10056352
Ref: library/token token LSQB10056407
Ref: 375d10056407
Ref: library/token token RSQB10056462
Ref: 375e10056462
Ref: library/token token COLON10056517
Ref: 375f10056517
Ref: library/token token COMMA10056573
Ref: 376010056573
Ref: library/token token SEMI10056629
Ref: 376110056629
Ref: library/token token PLUS10056684
Ref: 376210056684
Ref: library/token token MINUS10056739
Ref: 376310056739
Ref: library/token token STAR10056795
Ref: 376410056795
Ref: library/token token SLASH10056850
Ref: 376510056850
Ref: library/token token VBAR10056906
Ref: 376610056906
Ref: library/token token AMPER10056961
Ref: 376710056961
Ref: library/token token LESS10057017
Ref: 376810057017
Ref: library/token token GREATER10057072
Ref: 376910057072
Ref: library/token token EQUAL10057130
Ref: 376a10057130
Ref: library/token token DOT10057186
Ref: 376b10057186
Ref: library/token token PERCENT10057240
Ref: 376c10057240
Ref: library/token token LBRACE10057298
Ref: 376d10057298
Ref: library/token token RBRACE10057355
Ref: 376e10057355
Ref: library/token token EQEQUAL10057412
Ref: 376f10057412
Ref: library/token token NOTEQUAL10057471
Ref: 377010057471
Ref: library/token token LESSEQUAL10057531
Ref: 377110057531
Ref: library/token token GREATEREQUAL10057592
Ref: 377210057592
Ref: library/token token TILDE10057656
Ref: 377310057656
Ref: library/token token CIRCUMFLEX10057712
Ref: 377410057712
Ref: library/token token LEFTSHIFT10057773
Ref: 377510057773
Ref: library/token token RIGHTSHIFT10057834
Ref: 377610057834
Ref: library/token token DOUBLESTAR10057896
Ref: 377710057896
Ref: library/token token PLUSEQUAL10057958
Ref: 377810057958
Ref: library/token token MINEQUAL10058019
Ref: 377910058019
Ref: library/token token STAREQUAL10058079
Ref: 377a10058079
Ref: library/token token SLASHEQUAL10058140
Ref: 377b10058140
Ref: library/token token PERCENTEQUAL10058202
Ref: 377c10058202
Ref: library/token token AMPEREQUAL10058266
Ref: 377d10058266
Ref: library/token token VBAREQUAL10058328
Ref: 377e10058328
Ref: library/token token CIRCUMFLEXEQUAL10058389
Ref: 377f10058389
Ref: library/token token LEFTSHIFTEQUAL10058456
Ref: 378010058456
Ref: library/token token RIGHTSHIFTEQUAL10058523
Ref: 378110058523
Ref: library/token token DOUBLESTAREQUAL10058591
Ref: 378210058591
Ref: library/token token DOUBLESLASH10058659
Ref: 378310058659
Ref: library/token token DOUBLESLASHEQUAL10058722
Ref: 378410058722
Ref: library/token token AT10058791
Ref: 378510058791
Ref: library/token token ATEQUAL10058844
Ref: 378610058844
Ref: library/token token RARROW10058903
Ref: 378710058903
Ref: library/token token ELLIPSIS10058961
Ref: 378810058961
Ref: library/token token COLONEQUAL10059022
Ref: 378910059022
Ref: library/token token OP10059084
Ref: 378a10059084
Ref: library/token token AWAIT10059104
Ref: 378b10059104
Ref: library/token token ASYNC10059127
Ref: 378c10059127
Ref: library/token token TYPE_IGNORE10059150
Ref: 378d10059150
Ref: library/token token TYPE_COMMENT10059179
Ref: 378e10059179
Ref: library/token token ERRORTOKEN10059209
Ref: 378f10059209
Ref: library/token token N_TOKENS10059237
Ref: 379010059237
Ref: library/token token NT_OFFSET10059263
Ref: 379110059263
Ref: library/token token COMMENT10059408
Ref: 379210059408
Ref: library/token token NL10059479
Ref: 379310059479
Ref: library/token token ENCODING10059761
Ref: 379410059761
Ref: token — Constants used with Python parse trees-Footnote-110060824
Node: keyword — Testing for Python keywords10060888
Ref: library/keyword doc10061094
Ref: 379510061094
Ref: library/keyword keyword-testing-for-python-keywords10061094
Ref: 379610061094
Ref: library/keyword module-keyword10061094
Ref: a610061094
Ref: library/keyword keyword iskeyword10061373
Ref: 158810061373
Ref: library/keyword keyword kwlist10061462
Ref: 379710061462
Ref: keyword — Testing for Python keywords-Footnote-110061752
Node: tokenize — Tokenizer for Python source10061818
Ref: library/tokenize doc10062023
Ref: 379810062023
Ref: library/tokenize module-tokenize10062023
Ref: 11110062023
Ref: library/tokenize tokenize-tokenizer-for-python-source10062023
Ref: 379910062023
Ref: tokenize — Tokenizer for Python source-Footnote-110062974
Node: Tokenizing Input10063041
Ref: library/tokenize tokenizing-input10063164
Ref: 379a10063164
Ref: library/tokenize tokenize tokenize10063270
Ref: c4e10063270
Ref: library/tokenize tokenize generate_tokens10064704
Ref: f6d10064704
Ref: library/tokenize tokenize untokenize10065470
Ref: 379b10065470
Ref: library/tokenize tokenize detect_encoding10066414
Ref: 1bb910066414
Ref: library/tokenize tokenize open10067410
Ref: 1bb810067410
Ref: library/tokenize tokenize TokenError10067579
Ref: 379c10067579
Ref: Tokenizing Input-Footnote-110068038
Ref: Tokenizing Input-Footnote-210068087
Node: Command-Line Usage<2>10068136
Ref: library/tokenize command-line-usage10068280
Ref: 379d10068280
Ref: library/tokenize tokenize-cli10068280
Ref: 379e10068280
Ref: library/tokenize cmdoption-tokenize-h10068544
Ref: 379f10068544
Ref: library/tokenize cmdoption-tokenize-e10068614
Ref: 37a010068614
Node: Examples<30>10068814
Ref: library/tokenize examples10068933
Ref: 37a110068933
Node: tabnanny — Detection of ambiguous indentation10072538
Ref: library/tabnanny doc10072743
Ref: 37a210072743
Ref: library/tabnanny module-tabnanny10072743
Ref: 10010072743
Ref: library/tabnanny tabnanny-detection-of-ambiguous-indentation10072743
Ref: 37a310072743
Ref: library/tabnanny tabnanny check10073274
Ref: 37a410073274
Ref: library/tabnanny tabnanny verbose10073714
Ref: 37a510073714
Ref: library/tabnanny tabnanny filename_only10073871
Ref: 37a610073871
Ref: library/tabnanny tabnanny NannyNag10074089
Ref: 37a710074089
Ref: library/tabnanny tabnanny process_tokens10074254
Ref: 37a810074254
Ref: tabnanny — Detection of ambiguous indentation-Footnote-110074553
Node: pyclbr — Python class browser support10074620
Ref: library/pyclbr doc10074827
Ref: 37a910074827
Ref: library/pyclbr module-pyclbr10074827
Ref: d810074827
Ref: library/pyclbr pyclbr-python-class-browser-support10074827
Ref: 37aa10074827
Ref: library/pyclbr pyclbr readmodule10075523
Ref: 10a210075523
Ref: library/pyclbr pyclbr readmodule_ex10075993
Ref: 10a310075993
Ref: pyclbr — Python class browser support-Footnote-110077069
Node: Function Objects10077134
Ref: library/pyclbr function-objects10077251
Ref: 37ab10077251
Ref: library/pyclbr pyclbr-function-objects10077251
Ref: 37ac10077251
Ref: library/pyclbr pyclbr Function file10077418
Ref: 37ad10077418
Ref: library/pyclbr pyclbr Function module10077505
Ref: 37ae10077505
Ref: library/pyclbr pyclbr Function name10077599
Ref: 37af10077599
Ref: library/pyclbr pyclbr Function lineno10077661
Ref: 37b010077661
Ref: library/pyclbr pyclbr Function parent10077756
Ref: 37b110077756
Ref: library/pyclbr pyclbr Function children10077886
Ref: 37b210077886
Node: Class Objects<2>10078033
Ref: library/pyclbr class-objects10078150
Ref: 37b310078150
Ref: library/pyclbr pyclbr-class-objects10078150
Ref: 37b410078150
Ref: library/pyclbr pyclbr Class file10078329
Ref: 37b510078329
Ref: library/pyclbr pyclbr Class module10078410
Ref: 37b610078410
Ref: library/pyclbr pyclbr Class name10078498
Ref: 37b710078498
Ref: library/pyclbr pyclbr Class lineno10078554
Ref: 37b810078554
Ref: library/pyclbr pyclbr Class parent10078646
Ref: 37b910078646
Ref: library/pyclbr pyclbr Class children10078769
Ref: 37ba10078769
Ref: library/pyclbr pyclbr Class super10078913
Ref: 37bb10078913
Ref: library/pyclbr pyclbr Class methods10079251
Ref: 37bc10079251
Node: py_compile — Compile Python source files10079441
Ref: library/py_compile doc10079645
Ref: 37bd10079645
Ref: library/py_compile module-py_compile10079645
Ref: d710079645
Ref: library/py_compile py-compile-compile-python-source-files10079645
Ref: 37be10079645
Ref: library/py_compile py_compile PyCompileError10080270
Ref: 37bf10080270
Ref: library/py_compile py_compile compile10080399
Ref: 21310080399
Ref: library/py_compile py_compile PycInvalidationMode10084086
Ref: 37c010084086
Ref: library/py_compile py_compile PycInvalidationMode TIMESTAMP10084507
Ref: 37c210084507
Ref: library/py_compile py_compile PycInvalidationMode CHECKED_HASH10084789
Ref: 37c110084789
Ref: library/py_compile py_compile PycInvalidationMode UNCHECKED_HASH10085035
Ref: 37c310085035
Ref: library/py_compile py_compile main10085484
Ref: 37c410085484
Ref: py_compile — Compile Python source files-Footnote-110086358
Ref: py_compile — Compile Python source files-Footnote-210086427
Ref: py_compile — Compile Python source files-Footnote-310086476
Ref: py_compile — Compile Python source files-Footnote-410086525
Ref: py_compile — Compile Python source files-Footnote-510086574
Node: compileall — Byte-compile Python libraries10086623
Ref: library/compileall doc10086828
Ref: 37c510086828
Ref: library/compileall compileall-byte-compile-python-libraries10086828
Ref: 37c610086828
Ref: library/compileall module-compileall10086828
Ref: 2110086828
Ref: compileall — Byte-compile Python libraries-Footnote-110087488
Node: Command-line use10087557
Ref: library/compileall command-line-use10087679
Ref: 37c710087679
Ref: library/compileall cmdoption-compileall-arg-directory10087830
Ref: 37c810087830
Ref: library/compileall cmdoption-compileall-arg-file10087864
Ref: 37c910087864
Ref: library/compileall cmdoption-compileall-l10088120
Ref: 37ca10088120
Ref: library/compileall cmdoption-compileall-f10088278
Ref: 37cb10088278
Ref: library/compileall cmdoption-compileall-q10088357
Ref: 37cc10088357
Ref: library/compileall cmdoption-compileall-d10088549
Ref: 37cd10088549
Ref: library/compileall cmdoption-compileall-x10088910
Ref: 37ce10088910
Ref: library/compileall cmdoption-compileall-i10089091
Ref: 37cf10089091
Ref: library/compileall cmdoption-compileall-b10089301
Ref: 37d010089301
Ref: library/compileall cmdoption-compileall-r10089635
Ref: 37d110089635
Ref: library/compileall cmdoption-compileall-j10089913
Ref: 37d210089913
Ref: library/compileall cmdoption-compileall-invalidation-mode10090100
Ref: 37d310090100
Ref: Command-line use-Footnote-110091790
Node: Public functions10091839
Ref: library/compileall public-functions10091961
Ref: 37d410091961
Ref: library/compileall compileall compile_dir10092016
Ref: 36710092016
Ref: library/compileall compileall compile_file10095170
Ref: 6af10095170
Ref: library/compileall compileall compile_path10097320
Ref: 6b010097320
Ref: Public functions-Footnote-110099013
Ref: Public functions-Footnote-210099062
Node: dis — Disassembler for Python bytecode10099111
Ref: library/dis doc10099317
Ref: 37d510099317
Ref: library/dis dis-disassembler-for-python-bytecode10099317
Ref: 37d610099317
Ref: library/dis module-dis10099317
Ref: 3810099317
Ref: dis — Disassembler for Python bytecode-Footnote-110100732
Node: Bytecode analysis10100794
Ref: library/dis bytecode-analysis10100915
Ref: 37d710100915
Ref: library/dis dis Bytecode10101155
Ref: 82b10101155
Ref: library/dis dis Bytecode from_traceback10102182
Ref: 82d10102182
Ref: library/dis dis Bytecode codeobj10102400
Ref: 37d810102400
Ref: library/dis dis Bytecode first_line10102461
Ref: 37d910102461
Ref: library/dis dis Bytecode dis10102555
Ref: 82c10102555
Ref: library/dis dis Bytecode info10102746
Ref: 37da10102746
Node: Analysis functions10103169
Ref: library/dis analysis-functions10103327
Ref: 37db10103327
Ref: library/dis dis code_info10103633
Ref: bc110103633
Ref: library/dis dis show_code10104172
Ref: 82610104172
Ref: library/dis dis dis10104636
Ref: 37910104636
Ref: library/dis dis distb10106072
Ref: 82710106072
Ref: library/dis dis disassemble10106468
Ref: 82810106468
Ref: library/dis dis disco10106529
Ref: 37dc10106529
Ref: library/dis dis get_instructions10107416
Ref: 82a10107416
Ref: library/dis dis findlinestarts10108028
Ref: 37dd10108028
Ref: library/dis dis findlabels10108516
Ref: 37de10108516
Ref: library/dis dis stack_effect10108669
Ref: 82e10108669
Ref: Analysis functions-Footnote-110109237
Node: Python Bytecode Instructions10109314
Ref: library/dis bytecodes10109473
Ref: 37df10109473
Ref: library/dis python-bytecode-instructions10109473
Ref: 37e010109473
Ref: library/dis dis Instruction10109707
Ref: 82910109707
Ref: library/dis dis Instruction opcode10109774
Ref: 37e110109774
Ref: library/dis dis Instruction opname10109967
Ref: 37e310109967
Ref: library/dis dis Instruction arg10110035
Ref: 37e410110035
Ref: library/dis dis Instruction argval10110127
Ref: 37e510110127
Ref: library/dis dis Instruction argrepr10110214
Ref: 37e610110214
Ref: library/dis dis Instruction offset10110298
Ref: 37e710110298
Ref: library/dis dis Instruction starts_line10110382
Ref: 37e810110382
Ref: library/dis dis Instruction is_jump_target10110480
Ref: 37e910110480
Ref: library/dis opcode-NOP10110712
Ref: 37ea10110712
Ref: library/dis opcode-POP_TOP10110802
Ref: 37eb10110802
Ref: library/dis opcode-ROT_TWO10110866
Ref: 37ec10110866
Ref: library/dis opcode-ROT_THREE10110929
Ref: 37ed10110929
Ref: library/dis opcode-ROT_FOUR10111048
Ref: 2da10111048
Ref: library/dis opcode-DUP_TOP10111199
Ref: 37ee10111199
Ref: library/dis opcode-DUP_TOP_TWO10111298
Ref: 37ef10111298
Ref: library/dis opcode-UNARY_POSITIVE10111568
Ref: 37f010111568
Ref: library/dis opcode-UNARY_NEGATIVE10111631
Ref: 37f110111631
Ref: library/dis opcode-UNARY_NOT10111694
Ref: 37f210111694
Ref: library/dis opcode-UNARY_INVERT10111755
Ref: 37f310111755
Ref: library/dis opcode-GET_ITER10111816
Ref: 37f410111816
Ref: library/dis opcode-GET_YIELD_FROM_ITER10111878
Ref: 37f510111878
Ref: library/dis opcode-BINARY_POWER10112297
Ref: 37f610112297
Ref: library/dis opcode-BINARY_MULTIPLY10112365
Ref: 37f710112365
Ref: library/dis opcode-BINARY_MATRIX_MULTIPLY10112435
Ref: 37f810112435
Ref: library/dis opcode-BINARY_FLOOR_DIVIDE10112538
Ref: 37f910112538
Ref: library/dis opcode-BINARY_TRUE_DIVIDE10112613
Ref: 37fa10112613
Ref: library/dis opcode-BINARY_MODULO10112686
Ref: 37fb10112686
Ref: library/dis opcode-BINARY_ADD10112754
Ref: 37fc10112754
Ref: library/dis opcode-BINARY_SUBTRACT10112819
Ref: 37fd10112819
Ref: library/dis opcode-BINARY_SUBSCR10112889
Ref: 37fe10112889
Ref: library/dis opcode-BINARY_LSHIFT10112956
Ref: 37ff10112956
Ref: library/dis opcode-BINARY_RSHIFT10113025
Ref: 380010113025
Ref: library/dis opcode-BINARY_AND10113094
Ref: 380110113094
Ref: library/dis opcode-BINARY_XOR10113159
Ref: 380210113159
Ref: library/dis opcode-BINARY_OR10113224
Ref: 380310113224
Ref: library/dis opcode-INPLACE_POWER10113565
Ref: 380410113565
Ref: library/dis opcode-INPLACE_MULTIPLY10113643
Ref: 380510113643
Ref: library/dis opcode-INPLACE_MATRIX_MULTIPLY10113723
Ref: 380610113723
Ref: library/dis opcode-INPLACE_FLOOR_DIVIDE10113836
Ref: 380710113836
Ref: library/dis opcode-INPLACE_TRUE_DIVIDE10113921
Ref: 380810113921
Ref: library/dis opcode-INPLACE_MODULO10114004
Ref: 380910114004
Ref: library/dis opcode-INPLACE_ADD10114082
Ref: 380a10114082
Ref: library/dis opcode-INPLACE_SUBTRACT10114157
Ref: 380b10114157
Ref: library/dis opcode-INPLACE_LSHIFT10114237
Ref: 380c10114237
Ref: library/dis opcode-INPLACE_RSHIFT10114316
Ref: 380d10114316
Ref: library/dis opcode-INPLACE_AND10114395
Ref: 380e10114395
Ref: library/dis opcode-INPLACE_XOR10114470
Ref: 380f10114470
Ref: library/dis opcode-INPLACE_OR10114545
Ref: 381010114545
Ref: library/dis opcode-STORE_SUBSCR10114619
Ref: 381110114619
Ref: library/dis opcode-DELETE_SUBSCR10114686
Ref: 381210114686
Ref: library/dis opcode-GET_AWAITABLE10114772
Ref: 381310114772
Ref: library/dis opcode-GET_AITER10115052
Ref: 381410115052
Ref: library/dis opcode-GET_ANEXT10115255
Ref: 381510115255
Ref: library/dis opcode-END_ASYNC_FOR10115433
Ref: 2e010115433
Ref: library/dis opcode-BEFORE_ASYNC_WITH10115883
Ref: 381610115883
Ref: library/dis opcode-SETUP_ASYNC_WITH10116110
Ref: 381710116110
Ref: library/dis opcode-PRINT_EXPR10116225
Ref: 381810116225
Ref: library/dis opcode-SET_ADD10116461
Ref: 381910116461
Ref: library/dis opcode-LIST_APPEND10116572
Ref: 381a10116572
Ref: library/dis opcode-MAP_ADD10116691
Ref: 2e210116691
Ref: library/dis opcode-RETURN_VALUE10117203
Ref: 381b10117203
Ref: library/dis opcode-YIELD_VALUE10117283
Ref: 381c10117283
Ref: library/dis opcode-YIELD_FROM10117366
Ref: 381d10117366
Ref: library/dis opcode-SETUP_ANNOTATIONS10117502
Ref: 61310117502
Ref: library/dis opcode-IMPORT_STAR10117800
Ref: 381e10117800
Ref: library/dis opcode-POP_BLOCK10118039
Ref: 381f10118039
Ref: library/dis opcode-POP_EXCEPT10118200
Ref: 382010118200
Ref: library/dis opcode-POP_FINALLY10118533
Ref: 2dd10118533
Ref: library/dis opcode-BEGIN_FINALLY10119473
Ref: 2db10119473
Ref: library/dis opcode-END_FINALLY10119751
Ref: 2de10119751
Ref: library/dis opcode-LOAD_BUILD_CLASS10120582
Ref: 382210120582
Ref: library/dis opcode-SETUP_WITH10120750
Ref: 382310120750
Ref: library/dis opcode-WITH_CLEANUP_START10121420
Ref: 2df10121420
Ref: library/dis opcode-WITH_CLEANUP_FINISH10122178
Ref: 382110122178
Ref: library/dis opcode-STORE_NAME10122768
Ref: 382510122768
Ref: library/dis opcode-DELETE_NAME10123022
Ref: 382810123022
Ref: library/dis opcode-UNPACK_SEQUENCE10123170
Ref: 382610123170
Ref: library/dis opcode-UNPACK_EX10123306
Ref: 382910123306
Ref: library/dis opcode-STORE_ATTR10123809
Ref: 382a10123809
Ref: library/dis opcode-DELETE_ATTR10123940
Ref: 382b10123940
Ref: library/dis opcode-STORE_GLOBAL10124054
Ref: 382710124054
Ref: library/dis opcode-DELETE_GLOBAL10124160
Ref: 382c10124160
Ref: library/dis opcode-LOAD_CONST10124262
Ref: 382d10124262
Ref: library/dis opcode-LOAD_NAME10124348
Ref: 382e10124348
Ref: library/dis opcode-BUILD_TUPLE10124456
Ref: 382f10124456
Ref: library/dis opcode-BUILD_LIST10124603
Ref: 383010124603
Ref: library/dis opcode-BUILD_SET10124695
Ref: 383110124695
Ref: library/dis opcode-BUILD_MAP10124785
Ref: 383210124785
Ref: library/dis opcode-BUILD_CONST_KEY_MAP10125145
Ref: 60c10125145
Ref: library/dis opcode-BUILD_STRING10125398
Ref: 60b10125398
Ref: library/dis opcode-BUILD_TUPLE_UNPACK10125561
Ref: 383310125561
Ref: library/dis opcode-BUILD_TUPLE_UNPACK_WITH_CALL10125804
Ref: 61210125804
Ref: library/dis opcode-BUILD_LIST_UNPACK10126086
Ref: 383410126086
Ref: library/dis opcode-BUILD_SET_UNPACK10126322
Ref: 383510126322
Ref: library/dis opcode-BUILD_MAP_UNPACK10126555
Ref: 383610126555
Ref: library/dis opcode-BUILD_MAP_UNPACK_WITH_CALL10126813
Ref: 61010126813
Ref: library/dis opcode-LOAD_ATTR10127271
Ref: 383710127271
Ref: library/dis opcode-COMPARE_OP10127363
Ref: 383810127363
Ref: library/dis opcode-IMPORT_NAME10127495
Ref: 383910127495
Ref: library/dis opcode-IMPORT_FROM10127892
Ref: 383a10127892
Ref: library/dis opcode-JUMP_FORWARD10128128
Ref: 383b10128128
Ref: library/dis opcode-POP_JUMP_IF_TRUE10128208
Ref: 383c10128208
Ref: library/dis opcode-POP_JUMP_IF_FALSE10128355
Ref: 383d10128355
Ref: library/dis opcode-JUMP_IF_TRUE_OR_POP10128504
Ref: 383e10128504
Ref: library/dis opcode-JUMP_IF_FALSE_OR_POP10128708
Ref: 383f10128708
Ref: library/dis opcode-JUMP_ABSOLUTE10128913
Ref: 384010128913
Ref: library/dis opcode-FOR_ITER10128989
Ref: 384110128989
Ref: library/dis opcode-LOAD_GLOBAL10129306
Ref: 384210129306
Ref: library/dis opcode-SETUP_FINALLY10129406
Ref: 384310129406
Ref: library/dis opcode-CALL_FINALLY10129602
Ref: 2dc10129602
Ref: library/dis opcode-LOAD_FAST10129839
Ref: 384410129839
Ref: library/dis opcode-STORE_FAST10129958
Ref: 382410129958
Ref: library/dis opcode-DELETE_FAST10130052
Ref: 384510130052
Ref: library/dis opcode-LOAD_CLOSURE10130135
Ref: 384610130135
Ref: library/dis opcode-LOAD_DEREF10130434
Ref: 384710130434
Ref: library/dis opcode-LOAD_CLASSDEREF10130620
Ref: 92210130620
Ref: library/dis opcode-STORE_DEREF10130854
Ref: 384810130854
Ref: library/dis opcode-DELETE_DEREF10130980
Ref: 384910130980
Ref: library/dis opcode-RAISE_VARARGS10131166
Ref: 384a10131166
Ref: library/dis opcode-CALL_FUNCTION10131591
Ref: 60e10131591
Ref: library/dis opcode-CALL_FUNCTION_KW10132191
Ref: 60f10132191
Ref: library/dis opcode-CALL_FUNCTION_EX10133043
Ref: 61110133043
Ref: library/dis opcode-LOAD_METHOD10134015
Ref: 4a310134015
Ref: library/dis opcode-CALL_METHOD10134424
Ref: 4a410134424
Ref: library/dis opcode-MAKE_FUNCTION10134848
Ref: 60d10134848
Ref: library/dis opcode-BUILD_SLICE10135534
Ref: 384b10135534
Ref: library/dis opcode-EXTENDED_ARG10135815
Ref: 384c10135815
Ref: library/dis opcode-FORMAT_VALUE10136152
Ref: 60a10136152
Ref: library/dis opcode-HAVE_ARGUMENT10137012
Ref: 384d10137012
Node: Opcode collections10137437
Ref: library/dis id110137569
Ref: 384e10137569
Ref: library/dis opcode-collections10137569
Ref: 37e210137569
Ref: library/dis dis opname10137714
Ref: 384f10137714
Ref: library/dis dis opmap10137801
Ref: 385010137801
Ref: library/dis dis cmp_op10137877
Ref: 385110137877
Ref: library/dis dis hasconst10137946
Ref: 385210137946
Ref: library/dis dis hasfree10138022
Ref: 385310138022
Ref: library/dis dis hasname10138358
Ref: 385410138358
Ref: library/dis dis hasjrel10138443
Ref: 385510138443
Ref: library/dis dis hasjabs10138528
Ref: 385610138528
Ref: library/dis dis haslocal10138614
Ref: 385710138614
Ref: library/dis dis hascompare10138696
Ref: 385810138696
Node: pickletools — Tools for pickle developers10138773
Ref: library/pickletools doc10138926
Ref: 385910138926
Ref: library/pickletools module-pickletools10138926
Ref: cb10138926
Ref: library/pickletools pickletools-tools-for-pickle-developers10138926
Ref: 385a10138926
Ref: pickletools — Tools for pickle developers-Footnote-110139717
Node: Command line usage<2>10139787
Ref: library/pickletools command-line-usage10139922
Ref: 385b10139922
Node: Command line options<3>10140830
Ref: library/pickletools command-line-options10140911
Ref: 385c10140911
Ref: library/pickletools cmdoption-pickletools-a10140974
Ref: 385d10140974
Ref: library/pickletools cmdoption-pickletools-o10141068
Ref: 385e10141068
Ref: library/pickletools cmdoption-pickletools-l10141166
Ref: 385f10141166
Ref: library/pickletools cmdoption-pickletools-m10141275
Ref: 386010141275
Ref: library/pickletools cmdoption-pickletools-p10141395
Ref: 386110141395
Node: Programmatic Interface<2>10141545
Ref: library/pickletools programmatic-interface10141680
Ref: 386210141680
Ref: library/pickletools pickletools dis10141747
Ref: 56510141747
Ref: library/pickletools pickletools genops10142576
Ref: 386310142576
Ref: library/pickletools pickletools optimize10143012
Ref: 1bf510143012
Node: Miscellaneous Services10143292
Ref: library/misc doc10143448
Ref: 386410143448
Ref: library/misc misc10143448
Ref: 386510143448
Ref: library/misc miscellaneous-services10143448
Ref: 386610143448
Node: formatter — Generic output formatting10143695
Ref: library/formatter doc10143793
Ref: 386710143793
Ref: library/formatter formatter-generic-output-formatting10143793
Ref: 386810143793
Ref: library/formatter module-formatter10143793
Ref: 8210143793
Node: The Formatter Interface10145376
Ref: library/formatter formatter-interface10145509
Ref: 386910145509
Ref: library/formatter the-formatter-interface10145509
Ref: 386a10145509
Ref: library/formatter formatter AS_IS10145837
Ref: 386b10145837
Ref: library/formatter formatter formatter writer10146284
Ref: 386c10146284
Ref: library/formatter formatter formatter end_paragraph10146379
Ref: 386d10146379
Ref: library/formatter formatter formatter add_line_break10146526
Ref: 386e10146526
Ref: library/formatter formatter formatter add_hor_rule10146675
Ref: 386f10146675
Ref: library/formatter formatter formatter add_flowing_data10146988
Ref: 387010146988
Ref: library/formatter formatter formatter add_literal_data10147508
Ref: 387110147508
Ref: library/formatter formatter formatter add_label_data10147727
Ref: 387210147727
Ref: library/formatter formatter formatter flush_softspace10149154
Ref: 387310149154
Ref: library/formatter formatter formatter push_alignment10149419
Ref: 387410149419
Ref: library/formatter formatter formatter pop_alignment10149738
Ref: 387510149738
Ref: library/formatter formatter formatter push_font10149816
Ref: 387610149816
Ref: library/formatter formatter formatter pop_font10150197
Ref: 387710150197
Ref: library/formatter formatter formatter push_margin10150265
Ref: 387810150265
Ref: library/formatter formatter formatter pop_margin10150632
Ref: 387910150632
Ref: library/formatter formatter formatter push_style10150704
Ref: 387a10150704
Ref: library/formatter formatter formatter pop_style10151007
Ref: 387b10151007
Ref: library/formatter formatter formatter set_spacing10151274
Ref: 387c10151274
Ref: library/formatter formatter formatter assert_line_data10151363
Ref: 387d10151363
Node: Formatter Implementations10151721
Ref: library/formatter formatter-implementations10151883
Ref: 387e10151883
Ref: library/formatter formatter-impls10151883
Ref: 387f10151883
Ref: library/formatter formatter NullFormatter10152109
Ref: 388010152109
Ref: library/formatter formatter AbstractFormatter10152497
Ref: 388210152497
Node: The Writer Interface10152784
Ref: library/formatter the-writer-interface10152945
Ref: 388310152945
Ref: library/formatter writer-interface10152945
Ref: 388410152945
Ref: library/formatter formatter writer flush10153366
Ref: 388510153366
Ref: library/formatter formatter writer new_alignment10153453
Ref: 388610153453
Ref: library/formatter formatter writer new_font10153817
Ref: 388710153817
Ref: library/formatter formatter writer new_margin10154343
Ref: 388810154343
Ref: library/formatter formatter writer new_spacing10154673
Ref: 388910154673
Ref: library/formatter formatter writer new_styles10154757
Ref: 388a10154757
Ref: library/formatter formatter writer send_line_break10155091
Ref: 388b10155091
Ref: library/formatter formatter writer send_paragraph10155160
Ref: 388c10155160
Ref: library/formatter formatter writer send_hor_rule10155636
Ref: 388d10155636
Ref: library/formatter formatter writer send_flowing_data10155987
Ref: 388e10155987
Ref: library/formatter formatter writer send_literal_data10156287
Ref: 388f10156287
Ref: library/formatter formatter writer send_label_data10156717
Ref: 389010156717
Node: Writer Implementations10157023
Ref: library/formatter writer-implementations10157150
Ref: 389110157150
Ref: library/formatter writer-impls10157150
Ref: 389210157150
Ref: library/formatter formatter NullWriter10157408
Ref: 388110157408
Ref: library/formatter formatter AbstractWriter10157653
Ref: 389310157653
Ref: library/formatter formatter DumbWriter10157869
Ref: 389410157869
Node: MS Windows Specific Services10158235
Ref: library/windows doc10158389
Ref: 389510158389
Ref: library/windows ms-windows-specific-services10158389
Ref: 389610158389
Ref: library/windows mswin-specific-services10158389
Ref: 12cf10158389
Node: msilib — Read and write Microsoft Installer files10158753
Ref: library/msilib doc10158929
Ref: 389710158929
Ref: library/msilib module-msilib10158929
Ref: b510158929
Ref: library/msilib msilib-read-and-write-microsoft-installer-files10158929
Ref: 389810158929
Ref: library/msilib msilib FCICreate10160003
Ref: 389910160003
Ref: library/msilib msilib UuidCreate10160504
Ref: 389a10160504
Ref: library/msilib msilib OpenDatabase10160700
Ref: fda10160700
Ref: library/msilib msilib CreateRecord10161252
Ref: 389b10161252
Ref: library/msilib msilib init_database10161417
Ref: 389c10161417
Ref: library/msilib msilib add_data10161988
Ref: 389e10161988
Ref: library/msilib msilib Binary10162562
Ref: 389f10162562
Ref: library/msilib msilib add_tables10162758
Ref: 38a010162758
Ref: library/msilib msilib add_stream10163099
Ref: 38a110163099
Ref: library/msilib msilib gen_uuid10163259
Ref: 38a210163259
Ref: msilib — Read and write Microsoft Installer files-Footnote-110163738
Ref: msilib — Read and write Microsoft Installer files-Footnote-210163812
Ref: msilib — Read and write Microsoft Installer files-Footnote-310163875
Ref: msilib — Read and write Microsoft Installer files-Footnote-410163955
Node: Database Objects10164035
Ref: library/msilib database-objects10164160
Ref: 38a310164160
Ref: library/msilib id110164160
Ref: 38a410164160
Ref: library/msilib msilib Database OpenView10164213
Ref: 38a510164213
Ref: library/msilib msilib Database Commit10164363
Ref: 38a610164363
Ref: library/msilib msilib Database GetSummaryInformation10164499
Ref: 38a710164499
Ref: library/msilib msilib Database Close10164703
Ref: 3a310164703
Ref: Database Objects-Footnote-110164971
Ref: Database Objects-Footnote-210165051
Ref: Database Objects-Footnote-310165131
Ref: Database Objects-Footnote-410165211
Node: View Objects10165291
Ref: library/msilib id210165452
Ref: 38a810165452
Ref: library/msilib view-objects10165452
Ref: 38a910165452
Ref: library/msilib msilib View Execute10165497
Ref: 38aa10165497
Ref: library/msilib msilib View GetColumnInfo10165725
Ref: 38ab10165725
Ref: library/msilib msilib View Fetch10165950
Ref: 38ac10165950
Ref: library/msilib msilib View Modify10166063
Ref: 38ad10166063
Ref: library/msilib msilib View Close10166614
Ref: 38ae10166614
Ref: View Objects-Footnote-110166840
Ref: View Objects-Footnote-210166920
Ref: View Objects-Footnote-310167000
Ref: View Objects-Footnote-410167080
Ref: View Objects-Footnote-510167160
Node: Summary Information Objects10167240
Ref: library/msilib summary-information-objects10167399
Ref: 38af10167399
Ref: library/msilib summary-objects10167399
Ref: 38b010167399
Ref: library/msilib msilib SummaryInformation GetProperty10167474
Ref: ef510167474
Ref: library/msilib msilib SummaryInformation GetPropertyCount10168065
Ref: 38b110168065
Ref: library/msilib msilib SummaryInformation SetProperty10168217
Ref: 38b210168217
Ref: library/msilib msilib SummaryInformation Persist10168509
Ref: 38b310168509
Ref: Summary Information Objects-Footnote-110168838
Ref: Summary Information Objects-Footnote-210168918
Ref: Summary Information Objects-Footnote-310168998
Ref: Summary Information Objects-Footnote-410169078
Node: Record Objects10169158
Ref: library/msilib id310169311
Ref: 38b410169311
Ref: library/msilib record-objects10169311
Ref: 38b510169311
Ref: library/msilib msilib Record GetFieldCount10169360
Ref: 38b610169360
Ref: library/msilib msilib Record GetInteger10169491
Ref: 38b710169491
Ref: library/msilib msilib Record GetString10169628
Ref: 38b810169628
Ref: library/msilib msilib Record SetString10169762
Ref: 38b910169762
Ref: library/msilib msilib Record SetStream10169924
Ref: 38ba10169924
Ref: library/msilib msilib Record SetInteger10170123
Ref: 38bb10170123
Ref: library/msilib msilib Record ClearData10170286
Ref: 38bc10170286
Ref: Record Objects-Footnote-110170567
Ref: Record Objects-Footnote-210170647
Ref: Record Objects-Footnote-310170727
Ref: Record Objects-Footnote-410170807
Ref: Record Objects-Footnote-510170887
Node: Errors10170967
Ref: library/msilib errors10171104
Ref: 38bd10171104
Ref: library/msilib msi-errors10171104
Ref: 38be10171104
Node: CAB Objects10171252
Ref: library/msilib cab10171392
Ref: 38bf10171392
Ref: library/msilib cab-objects10171392
Ref: 38c010171392
Ref: library/msilib msilib CAB10171435
Ref: 38c110171435
Ref: library/msilib msilib CAB append10171796
Ref: 38c210171796
Ref: library/msilib msilib CAB commit10172145
Ref: 38c310172145
Node: Directory Objects10172349
Ref: library/msilib directory-objects10172494
Ref: 38c410172494
Ref: library/msilib msi-directory10172494
Ref: 38c510172494
Ref: library/msilib msilib Directory10172549
Ref: 38c610172549
Ref: library/msilib msilib Directory start_component10173317
Ref: ef610173317
Ref: library/msilib msilib Directory add_file10173858
Ref: 38c710173858
Ref: library/msilib msilib Directory glob10174355
Ref: 38c810174355
Ref: library/msilib msilib Directory remove_pyc10174569
Ref: 38c910174569
Ref: Directory Objects-Footnote-110174785
Ref: Directory Objects-Footnote-210174865
Ref: Directory Objects-Footnote-310174945
Ref: Directory Objects-Footnote-410175025
Node: Features<3>10175105
Ref: library/msilib features10175250
Ref: 38ca10175250
Ref: library/msilib id410175250
Ref: 38cb10175250
Ref: library/msilib msilib Feature10175287
Ref: 38cc10175287
Ref: library/msilib msilib Feature set_current10175685
Ref: 38cd10175685
Ref: Features<3>-Footnote-110175986
Node: GUI classes10176066
Ref: library/msilib gui-classes10176212
Ref: 38ce10176212
Ref: library/msilib msi-gui10176212
Ref: 38cf10176212
Ref: library/msilib msilib Control10176493
Ref: 38d010176493
Ref: library/msilib msilib Control event10176666
Ref: 38d110176666
Ref: library/msilib msilib Control mapping10176813
Ref: 38d210176813
Ref: library/msilib msilib Control condition10176935
Ref: 38d310176935
Ref: library/msilib msilib RadioButtonGroup10177074
Ref: 38d410177074
Ref: library/msilib msilib RadioButtonGroup add10177272
Ref: 38d510177272
Ref: library/msilib msilib Dialog10177542
Ref: 38d610177542
Ref: library/msilib msilib Dialog control10177847
Ref: 38d710177847
Ref: library/msilib msilib Dialog text10178210
Ref: 38d810178210
Ref: library/msilib msilib Dialog bitmap10178327
Ref: 38d910178327
Ref: library/msilib msilib Dialog line10178436
Ref: 38da10178436
Ref: library/msilib msilib Dialog pushbutton10178535
Ref: 38db10178535
Ref: library/msilib msilib Dialog radiogroup10178693
Ref: 38dc10178693
Ref: library/msilib msilib Dialog checkbox10178867
Ref: 38dd10178867
Ref: GUI classes-Footnote-110179228
Ref: GUI classes-Footnote-210179308
Ref: GUI classes-Footnote-310179388
Ref: GUI classes-Footnote-410179468
Ref: GUI classes-Footnote-510179548
Ref: GUI classes-Footnote-610179628
Ref: GUI classes-Footnote-710179708
Node: Precomputed tables10179788
Ref: library/msilib msi-tables10179914
Ref: 38de10179914
Ref: library/msilib precomputed-tables10179914
Ref: 38df10179914
Ref: library/msilib msilib schema10180127
Ref: 389d10180127
Ref: library/msilib msilib sequence10180344
Ref: 38e010180344
Ref: library/msilib msilib text10180579
Ref: 38e110180579
Node: msvcrt — Useful routines from the MS VC++ runtime10180720
Ref: library/msvcrt doc10180939
Ref: 38e210180939
Ref: library/msvcrt module-msvcrt10180939
Ref: b610180939
Ref: library/msvcrt msvcrt-useful-routines-from-the-ms-vc-runtime10180939
Ref: 38e310180939
Node: File Operations10181954
Ref: library/msvcrt file-operations10182077
Ref: 38e410182077
Ref: library/msvcrt msvcrt-files10182077
Ref: 38e510182077
Ref: library/msvcrt msvcrt locking10182128
Ref: 38e610182128
Ref: library/msvcrt msvcrt LK_LOCK10182671
Ref: 38e710182671
Ref: library/msvcrt msvcrt LK_RLCK10182696
Ref: 38e810182696
Ref: library/msvcrt msvcrt LK_NBLCK10182937
Ref: 38e910182937
Ref: library/msvcrt msvcrt LK_NBRLCK10182963
Ref: 38ea10182963
Ref: library/msvcrt msvcrt LK_UNLCK10183092
Ref: 38eb10183092
Ref: library/msvcrt msvcrt setmode10183199
Ref: 38ec10183199
Ref: library/msvcrt msvcrt open_osfhandle10183438
Ref: 38ed10183438
Ref: library/msvcrt msvcrt get_osfhandle10183818
Ref: 38ee10183818
Node: Console I/O10183978
Ref: library/msvcrt console-i-o10184125
Ref: 38ef10184125
Ref: library/msvcrt msvcrt-console10184125
Ref: 38f010184125
Ref: library/msvcrt msvcrt kbhit10184168
Ref: 38f110184168
Ref: library/msvcrt msvcrt getch10184260
Ref: 38f210184260
Ref: library/msvcrt msvcrt getwch10184741
Ref: 38f310184741
Ref: library/msvcrt msvcrt getche10184853
Ref: 38f410184853
Ref: library/msvcrt msvcrt getwche10185000
Ref: 38f510185000
Ref: library/msvcrt msvcrt putch10185114
Ref: 38f610185114
Ref: library/msvcrt msvcrt putwch10185218
Ref: 38f710185218
Ref: library/msvcrt msvcrt ungetch10185342
Ref: 38f810185342
Ref: library/msvcrt msvcrt ungetwch10185557
Ref: 38f910185557
Node: Other Functions10185685
Ref: library/msvcrt msvcrt-other10185808
Ref: 38fa10185808
Ref: library/msvcrt other-functions10185808
Ref: 38fb10185808
Ref: library/msvcrt msvcrt heapmin10185859
Ref: 38fc10185859
Node: winreg — Windows registry access10186052
Ref: library/winreg doc10186268
Ref: 38fd10186268
Ref: library/winreg module-winreg10186268
Ref: 12a10186268
Ref: library/winreg winreg-windows-registry-access10186268
Ref: 38fe10186268
Ref: library/winreg exception-changed10186682
Ref: 390010186682
Node: Functions<11>10186922
Ref: library/winreg functions10187028
Ref: 390110187028
Ref: library/winreg id110187028
Ref: 390210187028
Ref: library/winreg winreg CloseKey10187112
Ref: 390310187112
Ref: library/winreg winreg ConnectRegistry10187433
Ref: 341010187433
Ref: library/winreg winreg CreateKey10188125
Ref: 341110188125
Ref: library/winreg winreg CreateKeyEx10189087
Ref: 341210189087
Ref: library/winreg winreg DeleteKey10190425
Ref: 341310190425
Ref: library/winreg winreg DeleteKeyEx10191174
Ref: 341410191174
Ref: library/winreg winreg DeleteValue10192637
Ref: 341510192637
Ref: library/winreg winreg EnumKey10193005
Ref: 341810193005
Ref: library/winreg winreg EnumValue10193672
Ref: 341910193672
Ref: library/winreg winreg ExpandEnvironmentStrings10194938
Ref: 341a10194938
Ref: library/winreg winreg FlushKey10195279
Ref: 390a10195279
Ref: library/winreg winreg LoadKey10196099
Ref: 341b10196099
Ref: library/winreg winreg OpenKey10197292
Ref: 341c10197292
Ref: library/winreg winreg OpenKeyEx10197365
Ref: 390d10197365
Ref: library/winreg winreg QueryInfoKey10198448
Ref: 341e10198448
Ref: library/winreg winreg QueryValue10199344
Ref: 342010199344
Ref: library/winreg winreg QueryValueEx10200221
Ref: 342110200221
Ref: library/winreg winreg SaveKey10201097
Ref: 342210201097
Ref: library/winreg winreg SetValue10202143
Ref: 342310202143
Ref: library/winreg winreg SetValueEx10203322
Ref: 342410203322
Ref: library/winreg winreg DisableReflectionKey10204570
Ref: 341610204570
Ref: library/winreg winreg EnableReflectionKey10205202
Ref: 341710205202
Ref: library/winreg winreg QueryReflectionKey10205711
Ref: 341f10205711
Ref: Functions<11>-Footnote-110206215
Ref: Functions<11>-Footnote-210206289
Ref: Functions<11>-Footnote-310206366
Node: Constants<10>10206443
Ref: library/winreg constants10206581
Ref: 391210206581
Ref: library/winreg id210206581
Ref: 391310206581
Node: HKEY_* Constants10206763
Ref: library/winreg hkey-constants10206851
Ref: 390510206851
Ref: library/winreg id310206851
Ref: 391410206851
Ref: library/winreg winreg HKEY_CLASSES_ROOT10206904
Ref: 391510206904
Ref: library/winreg winreg HKEY_CURRENT_USER10207155
Ref: 391610207155
Ref: library/winreg winreg HKEY_LOCAL_MACHINE10207458
Ref: 390c10207458
Ref: library/winreg winreg HKEY_USERS10207682
Ref: 390b10207682
Ref: library/winreg winreg HKEY_PERFORMANCE_DATA10207891
Ref: 391710207891
Ref: library/winreg winreg HKEY_CURRENT_CONFIG10208158
Ref: 391810208158
Ref: library/winreg winreg HKEY_DYN_DATA10208293
Ref: 391910208293
Node: Access Rights10208385
Ref: library/winreg access-rights10208493
Ref: 390710208493
Ref: library/winreg id410208493
Ref: 391a10208493
Ref: library/winreg winreg KEY_ALL_ACCESS10208604
Ref: 391b10208604
Ref: library/winreg winreg KEY_WRITE10208893
Ref: 390610208893
Ref: library/winreg winreg KEY_READ10209046
Ref: 390e10209046
Ref: library/winreg winreg KEY_EXECUTE10209225
Ref: 392110209225
Ref: library/winreg winreg KEY_QUERY_VALUE10209297
Ref: 391c10209297
Ref: library/winreg winreg KEY_SET_VALUE10209385
Ref: 391010209385
Ref: library/winreg winreg KEY_CREATE_SUB_KEY10209476
Ref: 391d10209476
Ref: library/winreg winreg KEY_ENUMERATE_SUB_KEYS10209566
Ref: 391e10209566
Ref: library/winreg winreg KEY_NOTIFY10209666
Ref: 391f10209666
Ref: library/winreg winreg KEY_CREATE_LINK10209800
Ref: 392010209800
Ref: Access Rights-Footnote-110209931
Node: 64-bit Specific10210008
Ref: library/winreg bit-access-rights10210073
Ref: 392210210073
Ref: library/winreg bit-specific10210073
Ref: 392310210073
Ref: library/winreg winreg KEY_WOW64_64KEY10210192
Ref: 390810210192
Ref: library/winreg winreg KEY_WOW64_32KEY10210329
Ref: 392410210329
Ref: 64-bit Specific-Footnote-110210502
Node: Value Types10210574
Ref: library/winreg id510210657
Ref: 392510210657
Ref: library/winreg value-types10210657
Ref: 391110210657
Ref: library/winreg winreg REG_BINARY10210752
Ref: 392610210752
Ref: library/winreg winreg REG_DWORD10210812
Ref: 392710210812
Ref: library/winreg winreg REG_DWORD_LITTLE_ENDIAN10210861
Ref: 392810210861
Ref: library/winreg winreg REG_DWORD_BIG_ENDIAN10210993
Ref: 392910210993
Ref: library/winreg winreg REG_EXPAND_SZ10211076
Ref: 390910211076
Ref: library/winreg winreg REG_LINK10211205
Ref: 392a10211205
Ref: library/winreg winreg REG_MULTI_SZ10211263
Ref: eb410211263
Ref: library/winreg winreg REG_NONE10211429
Ref: 392b10211429
Ref: library/winreg winreg REG_QWORD10211485
Ref: 5a710211485
Ref: library/winreg winreg REG_QWORD_LITTLE_ENDIAN10211562
Ref: 392c10211562
Ref: library/winreg winreg REG_RESOURCE_LIST10211719
Ref: 392d10211719
Ref: library/winreg winreg REG_FULL_RESOURCE_DESCRIPTOR10211792
Ref: 392e10211792
Ref: library/winreg winreg REG_RESOURCE_REQUIREMENTS_LIST10211865
Ref: 392f10211865
Ref: library/winreg winreg REG_SZ10211946
Ref: 390f10211946
Ref: Value Types-Footnote-110212039
Node: Registry Handle Objects10212116
Ref: library/winreg handle-object10212232
Ref: 38ff10212232
Ref: library/winreg registry-handle-objects10212232
Ref: 393010212232
Ref: library/winreg winreg PyHKEY Close10213387
Ref: 390410213387
Ref: library/winreg winreg PyHKEY Detach10213519
Ref: 341d10213519
Ref: library/winreg winreg PyHKEY __enter__10214118
Ref: 393110214118
Ref: library/winreg winreg PyHKEY __exit__10214150
Ref: 393210214150
Node: winsound — Sound-playing interface for Windows10214534
Ref: library/winsound doc10214690
Ref: 393310214690
Ref: library/winsound module-winsound10214690
Ref: 12b10214690
Ref: library/winsound winsound-sound-playing-interface-for-windows10214690
Ref: 393410214690
Ref: library/winsound winsound Beep10215040
Ref: 5a910215040
Ref: library/winsound winsound PlaySound10215428
Ref: 5ab10215428
Ref: library/winsound winsound MessageBeep10216000
Ref: 5aa10216000
Ref: library/winsound winsound SND_FILENAME10216609
Ref: 393510216609
Ref: library/winsound winsound SND_ALIAS10216742
Ref: 393610216742
Ref: library/winsound winsound SND_LOOP10218310
Ref: 393810218310
Ref: library/winsound winsound SND_MEMORY10218497
Ref: 393a10218497
Ref: library/winsound winsound SND_PURGE10218859
Ref: 393b10218859
Ref: library/winsound winsound SND_ASYNC10219019
Ref: 393910219019
Ref: library/winsound winsound SND_NODEFAULT10219115
Ref: 393710219115
Ref: library/winsound winsound SND_NOSTOP10219238
Ref: 393c10219238
Ref: library/winsound winsound SND_NOWAIT10219318
Ref: 393d10219318
Ref: library/winsound winsound MB_ICONASTERISK10219476
Ref: 393e10219476
Ref: library/winsound winsound MB_ICONEXCLAMATION10219554
Ref: 393f10219554
Ref: library/winsound winsound MB_ICONHAND10219639
Ref: 394010219639
Ref: library/winsound winsound MB_ICONQUESTION10219710
Ref: 394110219710
Ref: library/winsound winsound MB_OK10219789
Ref: 394210219789
Node: Unix Specific Services10219857
Ref: library/unix doc10220007
Ref: 394310220007
Ref: library/unix unix10220007
Ref: 394410220007
Ref: library/unix unix-specific-services10220007
Ref: 394510220007
Node: posix — The most common POSIX system calls10220858
Ref: library/posix doc10220999
Ref: 394610220999
Ref: library/posix module-posix10220999
Ref: d110220999
Ref: library/posix posix-the-most-common-posix-system-calls10220999
Ref: 394710220999
Node: Large File Support10222199
Ref: library/posix large-file-support10222330
Ref: 394810222330
Ref: library/posix posix-large-files10222330
Ref: 394910222330
Node: Notable Module Contents10223371
Ref: library/posix notable-module-contents10223502
Ref: 394a10223502
Ref: library/posix posix-contents10223502
Ref: 394b10223502
Ref: library/posix posix environ10223703
Ref: 394c10223703
Node: pwd — The password database10224889
Ref: library/pwd doc10225076
Ref: 394d10225076
Ref: library/pwd module-pwd10225076
Ref: d610225076
Ref: library/pwd pwd-the-password-database10225076
Ref: 394e10225076
Ref: library/pwd pwd getpwuid10227351
Ref: f4f10227351
Ref: library/pwd pwd getpwnam10227457
Ref: f6210227457
Ref: library/pwd pwd getpwall10227558
Ref: 394f10227558
Node: spwd — The shadow password database10227872
Ref: library/spwd doc10228041
Ref: 395010228041
Ref: library/spwd module-spwd10228041
Ref: f110228041
Ref: library/spwd spwd-the-shadow-password-database10228041
Ref: 395110228041
Ref: library/spwd spwd getspnam10230335
Ref: 5f310230335
Ref: library/spwd spwd getspall10230592
Ref: 395210230592
Node: grp — The group database10230913
Ref: library/grp doc10231095
Ref: 395310231095
Ref: library/grp grp-the-group-database10231095
Ref: 395410231095
Ref: library/grp module-grp10231095
Ref: 8b10231095
Ref: library/grp grp getgrgid10232638
Ref: 5d410232638
Ref: library/grp grp getgrnam10232987
Ref: f6310232987
Ref: library/grp grp getgrall10233163
Ref: 395510233163
Node: crypt — Function to check Unix passwords10233459
Ref: library/crypt doc10233639
Ref: 395610233639
Ref: library/crypt crypt-function-to-check-unix-passwords10233639
Ref: 395710233639
Ref: library/crypt module-crypt10233639
Ref: 2910233639
Ref: crypt — Function to check Unix passwords-Footnote-110234648
Node: Hashing Methods10234712
Ref: library/crypt hashing-methods10234832
Ref: 395810234832
Ref: library/crypt crypt METHOD_SHA51210235019
Ref: 395910235019
Ref: library/crypt crypt METHOD_SHA25610235208
Ref: 395a10235208
Ref: library/crypt crypt METHOD_BLOWFISH10235367
Ref: 395b10235367
Ref: library/crypt crypt METHOD_MD510235548
Ref: 395c10235548
Ref: library/crypt crypt METHOD_CRYPT10235699
Ref: 5fe10235699
Node: Module Attributes10235843
Ref: library/crypt module-attributes10235991
Ref: 395d10235991
Ref: library/crypt crypt methods10236067
Ref: 395e10236067
Node: Module Functions<2>10236243
Ref: library/crypt module-functions10236388
Ref: 395f10236388
Ref: library/crypt crypt crypt10236503
Ref: 396010236503
Ref: library/crypt crypt mksalt10238007
Ref: 37110238007
Node: Examples<31>10238860
Ref: library/crypt examples10238979
Ref: 396110238979
Node: termios — POSIX style tty control10240035
Ref: library/termios doc10240223
Ref: 396210240223
Ref: library/termios module-termios10240223
Ref: 10410240223
Ref: library/termios termios-posix-style-tty-control10240223
Ref: 396310240223
Ref: library/termios termios tcgetattr10241200
Ref: 396410241200
Ref: library/termios termios tcsetattr10241779
Ref: 396510241779
Ref: library/termios termios tcsendbreak10242273
Ref: 396610242273
Ref: library/termios termios tcdrain10242487
Ref: 396710242487
Ref: library/termios termios tcflush10242610
Ref: 396810242610
Ref: library/termios termios tcflow10242868
Ref: 396910242868
Node: Example<16>10243293
Ref: library/termios example10243376
Ref: 396a10243376
Ref: library/termios termios-example10243376
Ref: 396b10243376
Node: tty — Terminal control functions10244079
Ref: library/tty doc10244258
Ref: 396c10244258
Ref: library/tty module-tty10244258
Ref: 11510244258
Ref: library/tty tty-terminal-control-functions10244258
Ref: 396d10244258
Ref: library/tty tty setraw10244681
Ref: 396e10244681
Ref: library/tty tty setcbreak10244917
Ref: 396f10244917
Ref: tty — Terminal control functions-Footnote-110245282
Node: pty — Pseudo-terminal utilities10245344
Ref: library/pty doc10245530
Ref: 397010245530
Ref: library/pty module-pty10245530
Ref: d510245530
Ref: library/pty pty-pseudo-terminal-utilities10245530
Ref: 397110245530
Ref: library/pty pty fork10246165
Ref: 397210246165
Ref: library/pty pty openpty10246580
Ref: 397310246580
Ref: library/pty pty spawn10246859
Ref: 88c10246859
Ref: pty — Pseudo-terminal utilities-Footnote-110248803
Ref: pty — Pseudo-terminal utilities-Footnote-210248865
Node: Example<17>10248908
Ref: library/pty example10248989
Ref: 397410248989
Node: fcntl — The fcntl and ioctl system calls10250061
Ref: library/fcntl doc10250251
Ref: 397510250251
Ref: library/fcntl fcntl-the-fcntl-and-ioctl-system-calls10250251
Ref: 397610250251
Ref: library/fcntl module-fcntl10250251
Ref: 7e10250251
Ref: library/fcntl fcntl fcntl10251367
Ref: 25df10251367
Ref: library/fcntl fcntl ioctl10252698
Ref: dd110252698
Ref: library/fcntl fcntl flock10254821
Ref: 397710254821
Ref: library/fcntl fcntl lockf10255220
Ref: d4510255220
Node: pipes — Interface to shell pipelines10257782
Ref: library/pipes doc10257978
Ref: 397810257978
Ref: library/pipes module-pipes10257978
Ref: cc10257978
Ref: library/pipes pipes-interface-to-shell-pipelines10257978
Ref: 397910257978
Ref: library/pipes pipes Template10258527
Ref: 397a10258527
Ref: pipes — Interface to shell pipelines-Footnote-110258863
Node: Template Objects10258927
Ref: library/pipes id110259018
Ref: 397b10259018
Ref: library/pipes template-objects10259018
Ref: 397c10259018
Ref: library/pipes pipes Template reset10259110
Ref: 397d10259110
Ref: library/pipes pipes Template clone10259197
Ref: 397e10259197
Ref: library/pipes pipes Template debug10259279
Ref: 397f10259279
Ref: library/pipes pipes Template append10259524
Ref: 398010259524
Ref: library/pipes pipes Template prepend10260274
Ref: 398110260274
Ref: library/pipes pipes Template open10260424
Ref: 398210260424
Ref: library/pipes pipes Template copy10260626
Ref: 398310260626
Node: resource — Resource usage information10260722
Ref: library/resource doc10260921
Ref: 398410260921
Ref: library/resource module-resource10260921
Ref: e010260921
Ref: library/resource resource-resource-usage-information10260921
Ref: 398510260921
Ref: library/resource resource error10261406
Ref: 398610261406
Ref: resource — Resource usage information-Footnote-110261680
Node: Resource Limits10261729
Ref: library/resource resource-limits10261843
Ref: 398710261843
Ref: library/resource resource RLIM_INFINITY10262722
Ref: 398810262722
Ref: library/resource resource getrlimit10262826
Ref: 398910262826
Ref: library/resource resource setrlimit10263120
Ref: 33e710263120
Ref: library/resource resource prlimit10264160
Ref: 89310264160
Ref: library/resource resource RLIMIT_CORE10265639
Ref: 33e810265639
Ref: library/resource resource RLIMIT_CPU10265900
Ref: 398b10265900
Ref: library/resource resource RLIMIT_FSIZE10266260
Ref: 398c10266260
Ref: library/resource resource RLIMIT_DATA10266356
Ref: 398d10266356
Ref: library/resource resource RLIMIT_STACK10266447
Ref: 398e10266447
Ref: library/resource resource RLIMIT_RSS10266644
Ref: 398f10266644
Ref: library/resource resource RLIMIT_NPROC10266762
Ref: 399010266762
Ref: library/resource resource RLIMIT_NOFILE10266865
Ref: 398a10266865
Ref: library/resource resource RLIMIT_OFILE10266979
Ref: 399110266979
Ref: library/resource resource RLIMIT_MEMLOCK10267062
Ref: 399210267062
Ref: library/resource resource RLIMIT_VMEM10267160
Ref: 399310267160
Ref: library/resource resource RLIMIT_AS10267262
Ref: 399410267262
Ref: library/resource resource RLIMIT_MSGQUEUE10267383
Ref: 89410267383
Ref: library/resource resource RLIMIT_NICE10267574
Ref: 89510267574
Ref: library/resource resource RLIMIT_RTPRIO10267773
Ref: 89610267773
Ref: library/resource resource RLIMIT_RTTIME10267934
Ref: 89710267934
Ref: library/resource resource RLIMIT_SIGPENDING10268193
Ref: 89810268193
Ref: library/resource resource RLIMIT_SBSIZE10268369
Ref: 89910268369
Ref: library/resource resource RLIMIT_SWAP10268674
Ref: 89a10268674
Ref: library/resource resource RLIMIT_NPTS10269064
Ref: 89b10269064
Node: Resource Usage10269245
Ref: library/resource resource-usage10269359
Ref: 399510269359
Ref: library/resource resource getrusage10269476
Ref: d8c10269476
Ref: library/resource resource getpagesize10273889
Ref: 399610273889
Ref: library/resource resource RUSAGE_SELF10274193
Ref: 399710274193
Ref: library/resource resource RUSAGE_CHILDREN10274393
Ref: 399810274393
Ref: library/resource resource RUSAGE_BOTH10274592
Ref: 399910274592
Ref: library/resource resource RUSAGE_THREAD10274789
Ref: 399a10274789
Node: nis — Interface to Sun’s NIS Yellow Pages10274983
Ref: library/nis doc10275183
Ref: 399b10275183
Ref: library/nis module-nis10275183
Ref: bf10275183
Ref: library/nis nis-interface-to-sun-s-nis-yellow-pages10275183
Ref: 399c10275183
Ref: library/nis nis match10275634
Ref: d8510275634
Ref: library/nis nis cat10276181
Ref: 399e10276181
Ref: library/nis nis maps10276647
Ref: d8610276647
Ref: library/nis nis get_default_domain10276875
Ref: 399f10276875
Ref: library/nis nis error10277020
Ref: 399d10277020
Node: syslog — Unix syslog library routines10277111
Ref: library/syslog doc10277263
Ref: 39a010277263
Ref: library/syslog module-syslog10277263
Ref: ff10277263
Ref: library/syslog syslog-unix-syslog-library-routines10277263
Ref: 39a110277263
Ref: library/syslog syslog syslog10277844
Ref: 39a210277844
Ref: library/syslog syslog openlog10278541
Ref: 39a310278541
Ref: library/syslog syslog closelog10279575
Ref: 39a410279575
Ref: library/syslog syslog setlogmask10280019
Ref: 39a510280019
Node: Examples<32>10281197
Ref: library/syslog examples10281285
Ref: 39a610281285
Node: Simple example10281353
Ref: library/syslog simple-example10281416
Ref: 39a710281416
Node: Superseded Modules10281908
Ref: library/superseded doc10282050
Ref: 39a810282050
Ref: library/superseded superseded10282050
Ref: 39a910282050
Ref: library/superseded superseded-modules10282050
Ref: 39aa10282050
Node: optparse — Parser for command line options10282340
Ref: library/optparse doc10282483
Ref: 39ab10282483
Ref: library/optparse module-optparse10282483
Ref: c310282483
Ref: library/optparse optparse-parser-for-command-line-options10282483
Ref: 39ac10282483
Ref: optparse — Parser for command line options-Footnote-110285290
Node: Background10285357
Ref: library/optparse background10285468
Ref: 39ae10285468
Ref: library/optparse optparse-background10285468
Ref: 39af10285468
Node: Terminology10285953
Ref: library/optparse optparse-terminology10286041
Ref: 39b010286041
Ref: library/optparse terminology10286041
Ref: 39b110286041
Node: What are options for?10289849
Ref: library/optparse optparse-what-options-for10289980
Ref: 39b210289980
Ref: library/optparse what-are-options-for10289980
Ref: 39b310289980
Node: What are positional arguments for?10291660
Ref: library/optparse optparse-what-positional-arguments-for10291771
Ref: 39b410291771
Ref: library/optparse what-are-positional-arguments-for10291771
Ref: 39b510291771
Node: Tutorial<2>10293106
Ref: library/optparse optparse-tutorial10293241
Ref: 39b610293241
Ref: library/optparse tutorial10293241
Ref: 39b710293241
Node: Understanding option actions10295832
Ref: library/optparse optparse-understanding-option-actions10295933
Ref: 39bc10295933
Ref: library/optparse understanding-option-actions10295933
Ref: 39bd10295933
Node: The store action10296524
Ref: library/optparse optparse-store-action10296663
Ref: 39bf10296663
Ref: library/optparse the-store-action10296663
Ref: 39c010296663
Node: Handling boolean flag options10298838
Ref: library/optparse handling-boolean-flag-options10298962
Ref: 39c110298962
Ref: library/optparse optparse-handling-boolean-options10298962
Ref: 39c210298962
Node: Other actions10299840
Ref: library/optparse optparse-other-actions10299962
Ref: 39c310299962
Ref: library/optparse other-actions10299962
Ref: 39c410299962
Node: Default values10300380
Ref: library/optparse default-values10300488
Ref: 39c710300488
Ref: library/optparse optparse-default-values10300488
Ref: 39c810300488
Node: Generating help10302351
Ref: library/optparse generating-help10302471
Ref: 39c910302471
Ref: library/optparse optparse-generating-help10302471
Ref: 39ca10302471
Node: Grouping Options10306540
Ref: library/optparse grouping-options10306608
Ref: 39cb10306608
Ref: library/optparse optparse OptionGroup10306939
Ref: 39cc10306939
Ref: library/optparse optparse OptionParser get_option_group10310222
Ref: 39cd10310222
Node: Printing a version string10310492
Ref: library/optparse optparse-printing-version-string10310625
Ref: 39ce10310625
Ref: library/optparse printing-a-version-string10310625
Ref: 39cf10310625
Ref: library/optparse optparse OptionParser print_version10311504
Ref: 39d010311504
Ref: library/optparse optparse OptionParser get_version10311878
Ref: 39d210311878
Node: How optparse handles errors10312022
Ref: library/optparse how-optparse-handles-errors10312163
Ref: 39d310312163
Ref: library/optparse optparse-how-optparse-handles-errors10312163
Ref: 39d410312163
Node: Putting it all together10314211
Ref: library/optparse optparse-putting-it-all-together10314318
Ref: 39d510314318
Ref: library/optparse putting-it-all-together10314318
Ref: 39d610314318
Node: Reference Guide10315141
Ref: library/optparse optparse-reference-guide10315282
Ref: 39c510315282
Ref: library/optparse reference-guide10315282
Ref: 39d710315282
Node: Creating the parser10315655
Ref: library/optparse creating-the-parser10315756
Ref: 39d810315756
Ref: library/optparse optparse-creating-parser10315756
Ref: 39d910315756
Ref: library/optparse optparse OptionParser10315901
Ref: 39ad10315901
Node: Populating the parser10318907
Ref: library/optparse optparse-populating-parser10319033
Ref: 39db10319033
Ref: library/optparse populating-the-parser10319033
Ref: 39dc10319033
Node: Defining options10320289
Ref: library/optparse defining-options10320413
Ref: 39dd10320413
Ref: library/optparse optparse-defining-options10320413
Ref: 39de10320413
Ref: library/optparse optparse OptionParser add_option10320822
Ref: 1fb210320822
Node: Option attributes10323680
Ref: library/optparse option-attributes10323806
Ref: 39e010323806
Ref: library/optparse optparse-option-attributes10323806
Ref: 39e110323806
Ref: library/optparse optparse Option action10324142
Ref: 39b810324142
Ref: library/optparse optparse Option type10324365
Ref: 39b910324365
Ref: library/optparse optparse Option dest10324582
Ref: 39ba10324582
Ref: library/optparse optparse Option default10324927
Ref: 39e310324927
Ref: library/optparse optparse Option nargs10325121
Ref: 39e510325121
Ref: library/optparse optparse Option const10325354
Ref: 39e610325354
Ref: library/optparse optparse Option choices10325464
Ref: 39e710325464
Ref: library/optparse optparse Option callback10325588
Ref: 39e810325588
Ref: library/optparse optparse Option callback_args10325820
Ref: 39e910325820
Ref: library/optparse optparse Option callback_kwargs10325856
Ref: 39ea10325856
Ref: library/optparse optparse Option help10326020
Ref: 39bb10326020
Ref: library/optparse optparse Option metavar10326368
Ref: 39eb10326368
Node: Standard option actions10326573
Ref: library/optparse optparse-standard-option-actions10326704
Ref: 39df10326704
Ref: library/optparse standard-option-actions10326704
Ref: 39ec10326704
Node: Standard option types10334521
Ref: library/optparse optparse-standard-option-types10334655
Ref: 39e210334655
Ref: library/optparse standard-option-types10334655
Ref: 39ed10334655
Node: Parsing arguments<2>10336126
Ref: library/optparse optparse-parsing-arguments10336281
Ref: 39ee10336281
Ref: library/optparse parsing-arguments10336281
Ref: 39ef10336281
Node: Querying and manipulating your option parser10337651
Ref: library/optparse optparse-querying-manipulating-option-parser10337810
Ref: 39f010337810
Ref: library/optparse querying-and-manipulating-your-option-parser10337810
Ref: 39f110337810
Ref: library/optparse optparse OptionParser disable_interspersed_args10338119
Ref: 1fb310338119
Ref: library/optparse optparse OptionParser enable_interspersed_args10338909
Ref: 39f210338909
Ref: library/optparse optparse OptionParser get_option10339115
Ref: 39f310339115
Ref: library/optparse optparse OptionParser has_option10339288
Ref: 39f410339288
Ref: library/optparse optparse OptionParser remove_option10339464
Ref: 39f510339464
Node: Conflicts between options10339850
Ref: library/optparse conflicts-between-options10339999
Ref: 39f610339999
Ref: library/optparse optparse-conflicts-between-options10339999
Ref: 39da10339999
Node: Cleanup<2>10342413
Ref: library/optparse cleanup10342531
Ref: 39f710342531
Ref: library/optparse optparse-cleanup10342531
Ref: 39f810342531
Node: Other methods10342944
Ref: library/optparse optparse-other-methods10343028
Ref: 39f910343028
Ref: library/optparse other-methods10343028
Ref: 39fa10343028
Ref: library/optparse optparse OptionParser set_usage10343130
Ref: 39fb10343130
Ref: library/optparse optparse OptionParser print_usage10343419
Ref: 39d110343419
Ref: library/optparse optparse OptionParser get_usage10343755
Ref: 39fc10343755
Ref: library/optparse optparse OptionParser set_defaults10343893
Ref: 39e410343893
Node: Option Callbacks10344971
Ref: library/optparse option-callbacks10345119
Ref: 39fd10345119
Ref: library/optparse optparse-option-callbacks10345119
Ref: 39c610345119
Node: Defining a callback option10346336
Ref: library/optparse defining-a-callback-option10346448
Ref: 39fe10346448
Ref: library/optparse optparse-defining-callback-option10346448
Ref: 39ff10346448
Node: How callbacks are called10348673
Ref: library/optparse how-callbacks-are-called10348822
Ref: 3a0010348822
Ref: library/optparse optparse-how-callbacks-called10348822
Ref: 3a0110348822
Node: Raising errors in a callback10351432
Ref: library/optparse optparse-raising-errors-in-callback10351590
Ref: 3a0210351590
Ref: library/optparse raising-errors-in-a-callback10351590
Ref: 3a0310351590
Node: Callback example 1 trivial callback10352061
Ref: library/optparse callback-example-1-trivial-callback10352232
Ref: 3a0410352232
Ref: library/optparse optparse-callback-example-110352232
Ref: 3a0510352232
Node: Callback example 2 check option order10352670
Ref: library/optparse callback-example-2-check-option-order10352862
Ref: 3a0610352862
Ref: library/optparse optparse-callback-example-210352862
Ref: 3a0710352862
Node: Callback example 3 check option order generalized10353390
Ref: library/optparse callback-example-3-check-option-order-generalized10353591
Ref: 3a0810353591
Ref: library/optparse optparse-callback-example-310353591
Ref: 3a0910353591
Node: Callback example 4 check arbitrary condition10354330
Ref: library/optparse callback-example-4-check-arbitrary-condition10354528
Ref: 3a0a10354528
Ref: library/optparse optparse-callback-example-410354528
Ref: 3a0b10354528
Node: Callback example 5 fixed arguments10355288
Ref: library/optparse callback-example-5-fixed-arguments10355474
Ref: 3a0c10355474
Ref: library/optparse optparse-callback-example-510355474
Ref: 3a0d10355474
Node: Callback example 6 variable arguments10356523
Ref: library/optparse callback-example-6-variable-arguments10356656
Ref: 3a0e10356656
Ref: library/optparse optparse-callback-example-610356656
Ref: 3a0f10356656
Node: Extending optparse10358656
Ref: library/optparse extending-optparse10358780
Ref: 3a1010358780
Ref: library/optparse optparse-extending-optparse10358780
Ref: 39be10358780
Node: Adding new types10359117
Ref: library/optparse adding-new-types10359215
Ref: 3a1110359215
Ref: library/optparse optparse-adding-new-types10359215
Ref: 3a1210359215
Ref: library/optparse optparse Option TYPES10359504
Ref: 3a1310359504
Ref: library/optparse optparse Option TYPE_CHECKER10359663
Ref: 3a1410359663
Node: Adding new actions10362619
Ref: library/optparse adding-new-actions10362717
Ref: 3a1510362717
Ref: library/optparse optparse-adding-new-actions10362717
Ref: 3a1610362717
Ref: library/optparse optparse Option ACTIONS10363820
Ref: 3a1710363820
Ref: library/optparse optparse Option STORE_ACTIONS10363896
Ref: 3a1810363896
Ref: library/optparse optparse Option TYPED_ACTIONS10363989
Ref: 3a1910363989
Ref: library/optparse optparse Option ALWAYS_TYPED_ACTIONS10364082
Ref: 3a1a10364082
Node: imp — Access the import internals10367329
Ref: library/imp doc10367472
Ref: 3a1b10367472
Ref: library/imp imp-access-the-import-internals10367472
Ref: 3a1c10367472
Ref: library/imp module-imp10367472
Ref: 9a10367472
Ref: library/imp imp get_magic10367933
Ref: 85710367933
Ref: library/imp imp get_suffixes10368224
Ref: 3a1d10368224
Ref: library/imp imp find_module10368962
Ref: 3a2110368962
Ref: library/imp imp load_module10371475
Ref: 3a2510371475
Ref: library/imp imp new_module10373346
Ref: 3a2610373346
Ref: library/imp imp reload10373595
Ref: c6310373595
Ref: library/imp imp cache_from_source10376825
Ref: 3a2710376825
Ref: library/imp imp source_from_cache10377881
Ref: 3a2910377881
Ref: library/imp imp get_tag10378616
Ref: 3a2810378616
Ref: library/imp imp lock_held10379167
Ref: 3a2a10379167
Ref: library/imp imp acquire_lock10380101
Ref: 3a2b10380101
Ref: library/imp imp release_lock10380802
Ref: 3a2c10380802
Ref: library/imp imp PY_SOURCE10381338
Ref: 3a1e10381338
Ref: library/imp imp PY_COMPILED10381444
Ref: 3a1f10381444
Ref: library/imp imp C_EXTENSION10381566
Ref: 3a2010381566
Ref: library/imp imp PKG_DIRECTORY10381696
Ref: 3a2410381696
Ref: library/imp imp C_BUILTIN10381812
Ref: 3a2210381812
Ref: library/imp imp PY_FROZEN10381922
Ref: 3a2310381922
Ref: library/imp imp NullImporter10382030
Ref: 9af10382030
Ref: library/imp imp NullImporter find_module10382424
Ref: 3a2d10382424
Ref: imp — Access the import internals-Footnote-110382914
Ref: imp — Access the import internals-Footnote-210382976
Ref: imp — Access the import internals-Footnote-310383025
Ref: imp — Access the import internals-Footnote-410383074
Ref: imp — Access the import internals-Footnote-510383123
Ref: imp — Access the import internals-Footnote-610383172
Ref: imp — Access the import internals-Footnote-710383221
Node: Examples<33>10383270
Ref: library/imp examples10383354
Ref: 3a2e10383354
Ref: library/imp examples-imp10383354
Ref: 3a2f10383354
Node: Undocumented Modules10384280
Ref: library/undoc doc10384391
Ref: 3a3010384391
Ref: library/undoc undoc10384391
Ref: 3a3110384391
Ref: library/undoc undocumented-modules10384391
Ref: 3a3210384391
Node: Platform specific modules10384838
Ref: library/undoc platform-specific-modules10384920
Ref: 3a3310384920
Node: Extending and Embedding the Python Interpreter10385311
Ref: extending/index doc10385471
Ref: 3a3410385471
Ref: extending/index extending-and-embedding-the-python-interpreter10385471
Ref: 3a3510385471
Ref: extending/index extending-index10385471
Ref: 113710385471
Node: Recommended third party tools10386775
Ref: extending/index recommended-third-party-tools10386941
Ref: 3a3610386941
Ref: Recommended third party tools-Footnote-110387639
Ref: Recommended third party tools-Footnote-210387666
Ref: Recommended third party tools-Footnote-310387702
Ref: Recommended third party tools-Footnote-410387730
Ref: Recommended third party tools-Footnote-510387764
Node: Creating extensions without third party tools10387837
Ref: extending/index creating-extensions-without-third-party-tools10388065
Ref: 3a3710388065
Node: Extending Python with C or C++10388681
Ref: extending/extending doc10388835
Ref: 3a3810388835
Ref: extending/extending extending-intro10388835
Ref: 3a3910388835
Ref: extending/extending extending-python-with-c-or-c10388835
Ref: 3a3a10388835
Ref: Extending Python with C or C++-Footnote-110390766
Node: A Simple Example10390803
Ref: extending/extending a-simple-example10390927
Ref: 3a3b10390927
Ref: extending/extending extending-simpleexample10390927
Ref: 3a3c10390927
Ref: A Simple Example-Footnote-110394607
Node: Intermezzo Errors and Exceptions10394761
Ref: extending/extending extending-errors10394913
Ref: 3a3e10394913
Ref: extending/extending intermezzo-errors-and-exceptions10394913
Ref: 3a3f10394913
Node: Back to the Example10401894
Ref: extending/extending back-to-the-example10402085
Ref: 3a4610402085
Ref: extending/extending backtoexample10402085
Ref: 3a4710402085
Node: The Module’s Method Table and Initialization Function10403737
Ref: extending/extending methodtable10403919
Ref: 3a4910403919
Ref: extending/extending the-module-s-method-table-and-initialization-function10403919
Ref: 3a4a10403919
Ref: The Module’s Method Table and Initialization Function-Footnote-110408804
Node: Compilation and Linkage10408853
Ref: extending/extending compilation10409047
Ref: 3a4d10409047
Ref: extending/extending compilation-and-linkage10409047
Ref: 3a4e10409047
Node: Calling Python Functions from C10410521
Ref: extending/extending calling-python-functions-from-c10410704
Ref: 3a5010410704
Ref: extending/extending callingpython10410704
Ref: 3a5110410704
Node: Extracting Parameters in Extension Functions10417153
Ref: extending/extending extracting-parameters-in-extension-functions10417355
Ref: 3a5510417355
Ref: extending/extending parsetuple10417355
Ref: 3a3d10417355
Node: Keyword Parameters for Extension Functions10419872
Ref: extending/extending keyword-parameters-for-extension-functions10420068
Ref: 3a5610420068
Ref: extending/extending parsetupleandkeywords10420068
Ref: 3a5710420068
Node: Building Arbitrary Values10422588
Ref: extending/extending building-arbitrary-values10422756
Ref: 3a5810422756
Ref: extending/extending buildvalue10422756
Ref: 3a5910422756
Node: Reference Counts10424762
Ref: extending/extending refcounts10424913
Ref: 3a5210424913
Ref: extending/extending reference-counts10424913
Ref: 3a5a10424913
Node: Reference Counting in Python10429690
Ref: extending/extending refcountsinpython10429795
Ref: 3a5b10429795
Ref: extending/extending reference-counting-in-python10429795
Ref: 3a5c10429795
Ref: Reference Counting in Python-Footnote-110432172
Ref: Reference Counting in Python-Footnote-210432300
Node: Ownership Rules10432475
Ref: extending/extending ownership-rules10432597
Ref: 3a5d10432597
Ref: extending/extending ownershiprules10432597
Ref: 3a5e10432597
Node: Thin Ice10435066
Ref: extending/extending thin-ice10435173
Ref: 3a6810435173
Ref: extending/extending thinice10435173
Ref: 3a6910435173
Node: NULL Pointers10438345
Ref: extending/extending null-pointers10438428
Ref: 3a6b10438428
Ref: extending/extending nullpointers10438428
Ref: 3a6c10438428
Ref: NULL Pointers-Footnote-110440053
Node: Writing Extensions in C++10440194
Ref: extending/extending cplusplus10440361
Ref: 3a6d10440361
Ref: extending/extending writing-extensions-in-c10440361
Ref: 3a6e10440361
Node: Providing a C API for an Extension Module10441081
Ref: extending/extending providing-a-c-api-for-an-extension-module10441223
Ref: 3a6f10441223
Ref: extending/extending using-capsules10441223
Ref: ce410441223
Node: Defining Extension Types Tutorial10449689
Ref: extending/newtypes_tutorial doc10449892
Ref: 3a7310449892
Ref: extending/newtypes_tutorial defining-extension-types-tutorial10449892
Ref: 3a7410449892
Ref: extending/newtypes_tutorial defining-new-types10449892
Ref: 3a7510449892
Node: The Basics10450536
Ref: extending/newtypes_tutorial dnt-basics10450669
Ref: 3a7610450669
Ref: extending/newtypes_tutorial the-basics10450669
Ref: 3a7710450669
Ref: The Basics-Footnote-110459669
Node: Adding data and methods to the Basic example10459739
Ref: extending/newtypes_tutorial adding-data-and-methods-to-the-basic-example10459925
Ref: 3a8210459925
Ref: Adding data and methods to the Basic example-Footnote-110475134
Ref: Adding data and methods to the Basic example-Footnote-210475231
Node: Providing finer control over data attributes10475372
Ref: extending/newtypes_tutorial providing-finer-control-over-data-attributes10475584
Ref: 3a8d10475584
Ref: Providing finer control over data attributes-Footnote-110484375
Node: Supporting cyclic garbage collection10484759
Ref: extending/newtypes_tutorial supporting-cyclic-garbage-collection10484950
Ref: 3a8f10484950
Ref: Supporting cyclic garbage collection-Footnote-110494464
Node: Subclassing other types10494642
Ref: extending/newtypes_tutorial subclassing-other-types10494780
Ref: 3a9310494780
Node: Defining Extension Types Assorted Topics10499558
Ref: extending/newtypes doc10499760
Ref: 3a9610499760
Ref: extending/newtypes defining-extension-types-assorted-topics10499760
Ref: 3a9710499760
Ref: extending/newtypes new-types-topics10499760
Ref: 3a9810499760
Ref: extending/newtypes dnt-type-methods10499857
Ref: 3a9910499857
Node: Finalization and De-allocation10503985
Ref: extending/newtypes finalization-and-de-allocation10504120
Ref: 3a9a10504120
Ref: Finalization and De-allocation-Footnote-110507141
Node: Object Presentation10507190
Ref: extending/newtypes object-presentation10507354
Ref: 3a9d10507354
Node: Attribute Management10508953
Ref: extending/newtypes attribute-management10509104
Ref: 3aa110509104
Node: Generic Attribute Management10510638
Ref: extending/newtypes generic-attribute-management10510766
Ref: 3a8910510766
Ref: extending/newtypes id110510766
Ref: 3aa210510766
Node: Type-specific Attribute Management10514959
Ref: extending/newtypes type-specific-attribute-management10515087
Ref: 3aa510515087
Node: Object Comparison10516775
Ref: extending/newtypes object-comparison10516932
Ref: 3aa810516932
Node: Abstract Protocol Support10518602
Ref: extending/newtypes abstract-protocol-support10518761
Ref: 3aac10518761
Node: Weak Reference Support10524303
Ref: extending/newtypes weak-reference-support10524461
Ref: 3ab210524461
Ref: extending/newtypes weakref-support10524461
Ref: 18c910524461
Node: More Suggestions10526302
Ref: extending/newtypes more-suggestions10526426
Ref: 3ab410526426
Node: Building C and C++ Extensions10527381
Ref: extending/building doc10527590
Ref: 3ab610527590
Ref: extending/building building10527590
Ref: 3a4f10527590
Ref: extending/building building-c-and-c-extensions10527590
Ref: 3ab710527590
Ref: extending/building c PyInit_modulename10528086
Ref: 3ab810528086
Ref: Building C and C++ Extensions-Footnote-110529422
Node: Building C and C++ Extensions with distutils10529471
Ref: extending/building building-c-and-c-extensions-with-distutils10529625
Ref: 3abb10529625
Node: Distributing your extension modules10533482
Ref: extending/building distributing10533636
Ref: 3abd10533636
Ref: extending/building distributing-your-extension-modules10533636
Ref: 3abe10533636
Node: Building C and C++ Extensions on Windows10534477
Ref: extending/windows doc10534637
Ref: 3ac010534637
Ref: extending/windows building-c-and-c-extensions-on-windows10534637
Ref: 3ac110534637
Ref: extending/windows building-on-windows10534637
Ref: 12d510534637
Node: A Cookbook Approach10535906
Ref: extending/windows a-cookbook-approach10536047
Ref: 3ac210536047
Ref: extending/windows win-cookbook10536047
Ref: 3ac310536047
Ref: A Cookbook Approach-Footnote-110536682
Node: Differences Between Unix and Windows10536759
Ref: extending/windows differences-between-unix-and-windows10536931
Ref: 3ac410536931
Ref: extending/windows dynamic-linking10536931
Ref: 3ac510536931
Node: Using DLLs in Practice10539854
Ref: extending/windows using-dlls-in-practice10539998
Ref: 3ac610539998
Ref: extending/windows win-dlls10539998
Ref: 3ac710539998
Node: Embedding the CPython runtime in a larger application10541548
Ref: extending/index embedding-the-cpython-runtime-in-a-larger-application10541738
Ref: 3ac810541738
Node: Embedding Python in Another Application10542180
Ref: extending/embedding doc10542309
Ref: 3ac910542309
Ref: extending/embedding embedding10542309
Ref: 3aca10542309
Ref: extending/embedding embedding-python-in-another-application10542309
Ref: 3acb10542309
Node: Very High Level Embedding10544653
Ref: extending/embedding high-level-embedding10544807
Ref: 3ace10544807
Ref: extending/embedding very-high-level-embedding10544807
Ref: 3acf10544807
Node: Beyond Very High Level Embedding An overview10546475
Ref: extending/embedding beyond-very-high-level-embedding-an-overview10546652
Ref: 3ad010546652
Ref: extending/embedding lower-level-embedding10546652
Ref: 3ad110546652
Node: Pure Embedding10548371
Ref: extending/embedding id110548548
Ref: 3ad210548548
Ref: extending/embedding pure-embedding10548548
Ref: 3ad310548548
Node: Extending Embedded Python10552774
Ref: extending/embedding extending-embedded-python10552930
Ref: 3ad610552930
Ref: extending/embedding extending-with-embedding10552930
Ref: 3ad710552930
Node: Embedding Python in C++10554790
Ref: extending/embedding embedding-python-in-c10554977
Ref: 3ad810554977
Ref: extending/embedding embeddingincplusplus10554977
Ref: 3ad910554977
Node: Compiling and Linking under Unix-like systems10555349
Ref: extending/embedding compiling10555502
Ref: 3ad410555502
Ref: extending/embedding compiling-and-linking-under-unix-like-systems10555502
Ref: 3ada10555502
Node: Python/C API Reference Manual10557640
Ref: c-api/index doc10557800
Ref: 3adc10557800
Ref: c-api/index c-api-index10557800
Ref: 113810557800
Ref: c-api/index python-c-api-reference-manual10557800
Ref: 3add10557800
Node: Introduction<13>10558622
Ref: c-api/intro doc10558748
Ref: 3ade10558748
Ref: c-api/intro api-intro10558748
Ref: 3adf10558748
Ref: c-api/intro introduction10558748
Ref: 3ae010558748
Node: Coding standards10560322
Ref: c-api/intro coding-standards10560413
Ref: 3ae110560413
Ref: Coding standards-Footnote-110560852
Node: Include Files10560901
Ref: c-api/intro api-includes10561014
Ref: 3ae210561014
Ref: c-api/intro include-files10561014
Ref: 3ae310561014
Node: Useful macros10563530
Ref: c-api/intro useful-macros10563661
Ref: 3ae410563661
Ref: c-api/intro c Py_UNREACHABLE10563948
Ref: 41810563948
Ref: c-api/intro c Py_ABS10564340
Ref: 3ae510564340
Ref: c-api/intro c Py_MIN10564435
Ref: 3ae610564435
Ref: c-api/intro c Py_MAX10564549
Ref: 3ae710564549
Ref: c-api/intro c Py_STRINGIFY10564663
Ref: 3ae810564663
Ref: c-api/intro c Py_MEMBER_SIZE10564814
Ref: 3ae910564814
Ref: c-api/intro c Py_CHARMASK10564957
Ref: 3aea10564957
Ref: c-api/intro c Py_GETENV10565139
Ref: 3aeb10565139
Ref: c-api/intro c Py_UNUSED10565322
Ref: 3aec10565322
Ref: c-api/intro c Py_DEPRECATED10565544
Ref: 3aed10565544
Node: Objects Types and Reference Counts10565818
Ref: c-api/intro api-objects10565950
Ref: 3aee10565950
Ref: c-api/intro objects-types-and-reference-counts10565950
Ref: 3aef10565950
Node: Reference Counts<2>10567331
Ref: c-api/intro api-refcounts10567435
Ref: 3af010567435
Ref: c-api/intro reference-counts10567435
Ref: 3af110567435
Node: Reference Count Details10571143
Ref: c-api/intro api-refcountdetails10571222
Ref: 3af210571222
Ref: c-api/intro reference-count-details10571222
Ref: 3af310571222
Node: Types10578081
Ref: c-api/intro api-types10578185
Ref: 3af710578185
Ref: c-api/intro types10578185
Ref: 3af810578185
Node: Exceptions<18>10578663
Ref: c-api/intro api-exceptions10578801
Ref: 3af910578801
Ref: c-api/intro exceptions10578801
Ref: 3afa10578801
Node: Embedding Python<2>10584744
Ref: c-api/intro api-embedding10584864
Ref: 3afc10584864
Ref: c-api/intro embedding-python10584864
Ref: 3afd10584864
Node: Debugging Builds10588063
Ref: c-api/intro api-debugging10588160
Ref: 3b0210588160
Ref: c-api/intro debugging-builds10588160
Ref: 3b0310588160
Node: Stable Application Binary Interface10590628
Ref: c-api/stable doc10590788
Ref: 3b0410590788
Ref: c-api/stable stable10590788
Ref: 3b0510590788
Ref: c-api/stable stable-application-binary-interface10590788
Ref: 3b0610590788
Ref: Stable Application Binary Interface-Footnote-110592765
Node: The Very High Level Layer10592814
Ref: c-api/veryhigh doc10592976
Ref: 3b0710592976
Ref: c-api/veryhigh the-very-high-level-layer10592976
Ref: 3b0810592976
Ref: c-api/veryhigh veryhigh10592976
Ref: 3b0910592976
Ref: c-api/veryhigh c Py_Main10593997
Ref: 4ad10593997
Ref: c-api/veryhigh c Py_BytesMain10594956
Ref: 17610594956
Ref: c-api/veryhigh c PyRun_AnyFile10595125
Ref: 3b0a10595125
Ref: c-api/veryhigh c PyRun_AnyFileFlags10595350
Ref: 3b0c10595350
Ref: c-api/veryhigh c PyRun_AnyFileEx10595592
Ref: 3b0d10595592
Ref: c-api/veryhigh c PyRun_AnyFileExFlags10595821
Ref: 3b0b10595821
Ref: c-api/veryhigh c PyRun_SimpleString10596388
Ref: 3acc10596388
Ref: c-api/veryhigh c PyRun_SimpleStringFlags10596615
Ref: 3b0f10596615
Ref: c-api/veryhigh c PyRun_SimpleFile10597298
Ref: 3acd10597298
Ref: c-api/veryhigh c PyRun_SimpleFileEx10597523
Ref: 3b1010597523
Ref: c-api/veryhigh c PyRun_SimpleFileExFlags10597744
Ref: f4510597744
Ref: c-api/veryhigh c PyRun_InteractiveOne10598436
Ref: 3b1110598436
Ref: c-api/veryhigh c PyRun_InteractiveOneFlags10598654
Ref: 3b1210598654
Ref: c-api/veryhigh c PyRun_InteractiveLoop10599416
Ref: 3b0e10599416
Ref: c-api/veryhigh c PyRun_InteractiveLoopFlags10599636
Ref: 3b1310599636
Ref: c-api/veryhigh c PyOS_InputHook10600096
Ref: 3b1410600096
Ref: c-api/veryhigh c PyOS_ReadlineFunctionPointer10600579
Ref: 96010600579
Ref: c-api/veryhigh c PyParser_SimpleParseString10601609
Ref: 3b1510601609
Ref: c-api/veryhigh c PyParser_SimpleParseStringFlags10601883
Ref: 3b1710601883
Ref: c-api/veryhigh c PyParser_SimpleParseStringFlagsFilename10602146
Ref: 3b1610602146
Ref: c-api/veryhigh c PyParser_SimpleParseFile10602665
Ref: 3b1810602665
Ref: c-api/veryhigh c PyParser_SimpleParseFileFlags10602909
Ref: 3b1910602909
Ref: c-api/veryhigh c PyRun_String10603194
Ref: ee510603194
Ref: c-api/veryhigh c PyRun_StringFlags10603466
Ref: 3b1a10603466
Ref: c-api/veryhigh c PyRun_File10604127
Ref: 3b1b10604127
Ref: c-api/veryhigh c PyRun_FileEx10604441
Ref: 3b1d10604441
Ref: c-api/veryhigh c PyRun_FileFlags10604741
Ref: 3b1e10604741
Ref: c-api/veryhigh c PyRun_FileExFlags10605064
Ref: 3b1c10605064
Ref: c-api/veryhigh c Py_CompileString10605651
Ref: 3b1f10605651
Ref: c-api/veryhigh c Py_CompileStringFlags10605916
Ref: 3b2010605916
Ref: c-api/veryhigh c Py_CompileStringObject10606210
Ref: 3b2210606210
Ref: c-api/veryhigh c Py_CompileStringExFlags10607327
Ref: 3b2110607327
Ref: c-api/veryhigh c PyEval_EvalCode10607701
Ref: 3b2310607701
Ref: c-api/veryhigh c PyEval_EvalCodeEx10608023
Ref: 3b2410608023
Ref: c-api/veryhigh c PyFrameObject10608700
Ref: 96510608700
Ref: c-api/veryhigh c PyEval_EvalFrame10608861
Ref: 3b2510608861
Ref: c-api/veryhigh c PyEval_EvalFrameEx10609096
Ref: 95b10609096
Ref: c-api/veryhigh c PyEval_MergeCompilerFlags10609793
Ref: 3b2610609793
Ref: c-api/veryhigh c Py_eval_input10609985
Ref: 3b2710609985
Ref: c-api/veryhigh c Py_file_input10610143
Ref: 3b2810610143
Ref: c-api/veryhigh c Py_single_input10610429
Ref: 3b2910610429
Ref: c-api/veryhigh c PyCompilerFlags10610655
Ref: 2ca10610655
Ref: c-api/veryhigh c PyCompilerFlags cf_flags10611186
Ref: 3b2a10611186
Ref: c-api/veryhigh c PyCompilerFlags cf_feature_version10611246
Ref: 3b2b10611246
Ref: c-api/veryhigh c CO_FUTURE_DIVISION10611604
Ref: 3b2c10611604
Ref: The Very High Level Layer-Footnote-110611823
Node: Reference Counting10611872
Ref: c-api/refcounting doc10612017
Ref: 3b2d10612017
Ref: c-api/refcounting countingrefs10612017
Ref: 3b2e10612017
Ref: c-api/refcounting reference-counting10612017
Ref: 3b2f10612017
Ref: c-api/refcounting c Py_INCREF10612150
Ref: 26310612150
Ref: c-api/refcounting c Py_XINCREF10612372
Ref: 26510612372
Ref: c-api/refcounting c Py_DECREF10612546
Ref: 26410612546
Ref: c-api/refcounting c Py_XDECREF10613659
Ref: 26610613659
Ref: c-api/refcounting c Py_CLEAR10613937
Ref: 3a9110613937
Node: Exception Handling10615082
Ref: c-api/exceptions doc10615214
Ref: 3b3010615214
Ref: c-api/exceptions exception-handling10615214
Ref: 3b3110615214
Ref: c-api/exceptions exceptionhandling10615214
Ref: 358a10615214
Node: Printing and clearing10617528
Ref: c-api/exceptions printing-and-clearing10617631
Ref: 3b3210617631
Ref: c-api/exceptions c PyErr_Clear10617688
Ref: 95f10617688
Ref: c-api/exceptions c PyErr_PrintEx10617819
Ref: 3b3310617819
Ref: c-api/exceptions c PyErr_Print10618509
Ref: f4610618509
Ref: c-api/exceptions c PyErr_WriteUnraisable10618586
Ref: ef010618586
Node: Raising exceptions10619294
Ref: c-api/exceptions raising-exceptions10619422
Ref: 3b3410619422
Ref: c-api/exceptions c PyErr_SetString10619662
Ref: 3a4010619662
Ref: c-api/exceptions c PyErr_SetObject10620082
Ref: 3a4210620082
Ref: c-api/exceptions c PyErr_Format10620315
Ref: 79e10620315
Ref: c-api/exceptions c PyErr_FormatV10620766
Ref: 79d10620766
Ref: c-api/exceptions c PyErr_SetNone10621059
Ref: 3b3510621059
Ref: c-api/exceptions c PyErr_BadArgument10621180
Ref: 3b3610621180
Ref: c-api/exceptions c PyErr_NoMemory10621433
Ref: 3a4410621433
Ref: c-api/exceptions c PyErr_SetFromErrno10621715
Ref: 3a4110621715
Ref: c-api/exceptions c PyErr_SetFromErrnoWithFilenameObject10622595
Ref: 3b3810622595
Ref: c-api/exceptions c PyErr_SetFromErrnoWithFilenameObjects10623074
Ref: 3b3910623074
Ref: c-api/exceptions c PyErr_SetFromErrnoWithFilename10623470
Ref: 3b3a10623470
Ref: c-api/exceptions c PyErr_SetFromWindowsErr10623811
Ref: 3b3b10623811
Ref: c-api/exceptions c PyErr_SetExcFromWindowsErr10624583
Ref: 3b3c10624583
Ref: c-api/exceptions c PyErr_SetFromWindowsErrWithFilename10624883
Ref: 3b3d10624883
Ref: c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObject10625264
Ref: 3b3e10625264
Ref: c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObjects10625614
Ref: 3b3f10625614
Ref: c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilename10625996
Ref: 3b4010625996
Ref: c-api/exceptions c PyErr_SetImportError10626342
Ref: 5ed10626342
Ref: c-api/exceptions c PyErr_SyntaxLocationObject10626797
Ref: 3b4110626797
Ref: c-api/exceptions c PyErr_SyntaxLocationEx10627205
Ref: 3b4210627205
Ref: c-api/exceptions c PyErr_SyntaxLocation10627498
Ref: 3b4310627498
Ref: c-api/exceptions c PyErr_BadInternalCall10627681
Ref: 3b4410627681
Node: Issuing warnings10627979
Ref: c-api/exceptions issuing-warnings10628114
Ref: 3b4510628114
Ref: c-api/exceptions c PyErr_WarnEx10629010
Ref: da410629010
Ref: c-api/exceptions c PyErr_SetImportErrorSubclass10630157
Ref: 5c010630157
Ref: c-api/exceptions c PyErr_WarnExplicitObject10630505
Ref: 3b4710630505
Ref: c-api/exceptions c PyErr_WarnExplicit10631046
Ref: 3b4810631046
Ref: c-api/exceptions c PyErr_WarnFormat10631435
Ref: 3b4910631435
Ref: c-api/exceptions c PyErr_ResourceWarning10631753
Ref: 5c110631753
Node: Querying the error indicator10632068
Ref: c-api/exceptions querying-the-error-indicator10632203
Ref: 3b4a10632203
Ref: c-api/exceptions c PyErr_Occurred10632274
Ref: 3a4310632274
Ref: c-api/exceptions c PyErr_ExceptionMatches10633070
Ref: 3afb10633070
Ref: c-api/exceptions c PyErr_GivenExceptionMatches10633350
Ref: 3b4b10633350
Ref: c-api/exceptions c PyErr_Fetch10633749
Ref: 95e10633749
Ref: c-api/exceptions c PyErr_Restore10634594
Ref: 3a9b10634594
Ref: c-api/exceptions c PyErr_NormalizeException10635587
Ref: ef110635587
Ref: c-api/exceptions c PyErr_GetExcInfo10636428
Ref: 3b4c10636428
Ref: c-api/exceptions c PyErr_SetExcInfo10637182
Ref: 3b4d10637182
Node: Signal Handling<2>10637992
Ref: c-api/exceptions signal-handling10638128
Ref: 3b4e10638128
Ref: c-api/exceptions c PyErr_CheckSignals10638173
Ref: 3b3710638173
Ref: c-api/exceptions c PyErr_SetInterrupt10638839
Ref: 3b4f10638839
Ref: c-api/exceptions c PySignal_SetWakeupFd10639235
Ref: d3910639235
Node: Exception Classes10639905
Ref: c-api/exceptions exception-classes10640030
Ref: 3b5010640030
Ref: c-api/exceptions c PyErr_NewException10640079
Ref: bf310640079
Ref: c-api/exceptions c PyErr_NewExceptionWithDoc10641017
Ref: bf210641017
Node: Exception Objects10641422
Ref: c-api/exceptions exception-objects10641554
Ref: 3b5110641554
Ref: c-api/exceptions c PyException_GetTraceback10641603
Ref: 3b5210641603
Ref: c-api/exceptions c PyException_SetTraceback10641911
Ref: ef210641911
Ref: c-api/exceptions c PyException_GetContext10642096
Ref: 3b5310642096
Ref: c-api/exceptions c PyException_SetContext10642468
Ref: 3b5410642468
Ref: c-api/exceptions c PyException_GetCause10642763
Ref: 3b5510642763
Ref: c-api/exceptions c PyException_SetCause10643080
Ref: 3b5610643080
Node: Unicode Exception Objects10643498
Ref: c-api/exceptions unicode-exception-objects10643630
Ref: 3b5710643630
Ref: c-api/exceptions unicodeexceptions10643630
Ref: 3b5810643630
Ref: c-api/exceptions c PyUnicodeDecodeError_Create10643777
Ref: 3b5910643777
Ref: c-api/exceptions c PyUnicodeEncodeError_Create10644200
Ref: 3b5a10644200
Ref: c-api/exceptions c PyUnicodeTranslateError_Create10644629
Ref: 3b5b10644629
Ref: c-api/exceptions c PyUnicodeDecodeError_GetEncoding10645016
Ref: 3b5c10645016
Ref: c-api/exceptions c PyUnicodeEncodeError_GetEncoding10645101
Ref: 3b5d10645101
Ref: c-api/exceptions c PyUnicodeDecodeError_GetObject10645292
Ref: 3b5e10645292
Ref: c-api/exceptions c PyUnicodeEncodeError_GetObject10645365
Ref: 3b5f10645365
Ref: c-api/exceptions c PyUnicodeTranslateError_GetObject10645438
Ref: 3b6010645438
Ref: c-api/exceptions c PyUnicodeDecodeError_GetStart10645628
Ref: 3b6110645628
Ref: c-api/exceptions c PyUnicodeEncodeError_GetStart10645723
Ref: 3b6210645723
Ref: c-api/exceptions c PyUnicodeTranslateError_GetStart10645818
Ref: 3b6310645818
Ref: c-api/exceptions c PyUnicodeDecodeError_SetStart10646099
Ref: 3b6410646099
Ref: c-api/exceptions c PyUnicodeEncodeError_SetStart10646193
Ref: 3b6510646193
Ref: c-api/exceptions c PyUnicodeTranslateError_SetStart10646287
Ref: 3b6610646287
Ref: c-api/exceptions c PyUnicodeDecodeError_GetEnd10646512
Ref: 3b6710646512
Ref: c-api/exceptions c PyUnicodeEncodeError_GetEnd10646603
Ref: 3b6810646603
Ref: c-api/exceptions c PyUnicodeTranslateError_GetEnd10646694
Ref: 3b6910646694
Ref: c-api/exceptions c PyUnicodeDecodeError_SetEnd10646965
Ref: 3b6a10646965
Ref: c-api/exceptions c PyUnicodeEncodeError_SetEnd10647055
Ref: 3b6b10647055
Ref: c-api/exceptions c PyUnicodeTranslateError_SetEnd10647145
Ref: 3b6c10647145
Ref: c-api/exceptions c PyUnicodeDecodeError_GetReason10647362
Ref: 3b6d10647362
Ref: c-api/exceptions c PyUnicodeEncodeError_GetReason10647435
Ref: 3b6e10647435
Ref: c-api/exceptions c PyUnicodeTranslateError_GetReason10647508
Ref: 3b6f10647508
Ref: c-api/exceptions c PyUnicodeDecodeError_SetReason10647698
Ref: 3b7010647698
Ref: c-api/exceptions c PyUnicodeEncodeError_SetReason10647795
Ref: 3b7110647795
Ref: c-api/exceptions c PyUnicodeTranslateError_SetReason10647892
Ref: 3b7210647892
Node: Recursion Control10648123
Ref: c-api/exceptions recursion-control10648257
Ref: 3b7310648257
Ref: c-api/exceptions c Py_EnterRecursiveCall10648561
Ref: 3b7410648561
Ref: c-api/exceptions c Py_LeaveRecursiveCall10649306
Ref: 3b7610649306
Ref: c-api/exceptions c Py_ReprEnter10649855
Ref: 3b7710649855
Ref: c-api/exceptions c Py_ReprLeave10650623
Ref: 3b7810650623
Node: Standard Exceptions10650814
Ref: c-api/exceptions standard-exceptions10650950
Ref: 3b7910650950
Ref: c-api/exceptions standardexceptions10650950
Ref: 3b7a10650950
Ref: Standard Exceptions-Footnote-110664388
Node: Standard Warning Categories10664437
Ref: c-api/exceptions standard-warning-categories10664547
Ref: 3b7b10664547
Ref: c-api/exceptions standardwarningcategories10664547
Ref: 3b4610664547
Node: Utilities<2>10667676
Ref: c-api/utilities doc10667812
Ref: 3b7c10667812
Ref: c-api/utilities id110667812
Ref: 3b7d10667812
Ref: c-api/utilities utilities10667812
Ref: 3b7e10667812
Node: Operating System Utilities10668361
Ref: c-api/sys doc10668461
Ref: 3b7f10668461
Ref: c-api/sys operating-system-utilities10668461
Ref: 3b8010668461
Ref: c-api/sys os10668461
Ref: 3b8110668461
Ref: c-api/sys c PyOS_FSPath10668528
Ref: 5c210668528
Ref: c-api/sys c Py_FdIsInteractive10669074
Ref: 3b8210669074
Ref: c-api/sys c PyOS_BeforeFork10669557
Ref: 42710669557
Ref: c-api/sys c PyOS_AfterFork_Parent10670090
Ref: 42810670090
Ref: c-api/sys c PyOS_AfterFork_Child10670716
Ref: 2cb10670716
Ref: c-api/sys c PyOS_AfterFork10671617
Ref: 42610671617
Ref: c-api/sys c PyOS_CheckStack10672034
Ref: 3b7510672034
Ref: c-api/sys c PyOS_getsig10672418
Ref: 3b8610672418
Ref: c-api/sys c PyOS_setsig10672727
Ref: 3b8710672727
Ref: c-api/sys c Py_DecodeLocale10673096
Ref: 43110673096
Ref: c-api/sys c Py_EncodeLocale10675145
Ref: 43210675145
Node: System Functions10676944
Ref: c-api/sys system-functions10677068
Ref: 3b8b10677068
Ref: c-api/sys systemfunctions10677068
Ref: 3b8c10677068
Ref: c-api/sys c PySys_GetObject10677367
Ref: 3b8d10677367
Ref: c-api/sys c PySys_SetObject10677603
Ref: 3b8e10677603
Ref: c-api/sys c PySys_ResetWarnOptions10677861
Ref: 3b8f10677861
Ref: c-api/sys c PySys_AddWarnOption10678038
Ref: 4a910678038
Ref: c-api/sys c PySys_AddWarnOptionUnicode10678269
Ref: 4a810678269
Ref: c-api/sys c PySys_SetPath10678739
Ref: 3b9010678739
Ref: c-api/sys c PySys_WriteStdout10679005
Ref: 3b9110679005
Ref: c-api/sys c PySys_WriteStderr10679881
Ref: 3b9210679881
Ref: c-api/sys c PySys_FormatStdout10680051
Ref: 3b9310680051
Ref: c-api/sys c PySys_FormatStderr10680323
Ref: 3b9510680323
Ref: c-api/sys c PySys_AddXOption10680521
Ref: 3b9610680521
Ref: c-api/sys c PySys_GetXOptions10680829
Ref: 3b9710680829
Ref: c-api/sys c PySys_Audit10681110
Ref: e8110681110
Ref: c-api/sys c PySys_AddAuditHook10682239
Ref: 340610682239
Ref: System Functions-Footnote-110684090
Node: Process Control10684139
Ref: c-api/sys process-control10684257
Ref: 3b9910684257
Ref: c-api/sys processcontrol10684257
Ref: 3b9a10684257
Ref: c-api/sys c Py_FatalError10684302
Ref: ebb10684302
Ref: c-api/sys c Py_Exit10684782
Ref: 60710684782
Ref: c-api/sys c Py_AtExit10685136
Ref: 3b9b10685136
Node: Importing Modules<2>10685786
Ref: c-api/import doc10685912
Ref: 3b9c10685912
Ref: c-api/import importing10685912
Ref: 3b9d10685912
Ref: c-api/import importing-modules10685912
Ref: 3b9e10685912
Ref: c-api/import c PyImport_ImportModule10685961
Ref: c6610685961
Ref: c-api/import c PyImport_ImportModuleNoBlock10686992
Ref: 9b510686992
Ref: c-api/import c PyImport_ImportModuleEx10687480
Ref: b1410687480
Ref: c-api/import c PyImport_ImportModuleLevelObject10688208
Ref: 3b9f10688208
Ref: c-api/import c PyImport_ImportModuleLevel10688968
Ref: b1310688968
Ref: c-api/import c PyImport_Import10689390
Ref: d5210689390
Ref: c-api/import c PyImport_ReloadModule10689911
Ref: 3ba010689911
Ref: c-api/import c PyImport_AddModuleObject10690173
Ref: 3ba110690173
Ref: c-api/import c PyImport_AddModule10691000
Ref: 3a6410691000
Ref: c-api/import c PyImport_ExecCodeModule10691236
Ref: 3ba210691236
Ref: c-api/import c PyImport_ExecCodeModuleEx10693017
Ref: 3ba310693017
Ref: c-api/import c PyImport_ExecCodeModuleObject10693405
Ref: 3ba510693405
Ref: c-api/import c PyImport_ExecCodeModuleWithPathnames10693841
Ref: 3ba410693841
Ref: c-api/import c PyImport_GetMagicNumber10694485
Ref: b1210694485
Ref: c-api/import c PyImport_GetMagicTag10694840
Ref: 3ba610694840
Ref: c-api/import c PyImport_GetModuleDict10695149
Ref: 3ba710695149
Ref: c-api/import c PyImport_GetModule10695387
Ref: 41610695387
Ref: c-api/import c PyImport_GetImporter10695736
Ref: 3ba810695736
Ref: c-api/import c _PyImport_Init10696398
Ref: 3ba910696398
Ref: c-api/import c PyImport_Cleanup10696501
Ref: 3baa10696501
Ref: c-api/import c _PyImport_Fini10696597
Ref: 3bab10696597
Ref: c-api/import c PyImport_ImportFrozenModuleObject10696698
Ref: 3bac10696698
Ref: c-api/import c PyImport_ImportFrozenModule10697302
Ref: 3bad10697302
Ref: c-api/import c _frozen10697509
Ref: 3bae10697509
Ref: c-api/import c PyImport_FrozenModules10697881
Ref: 223a10697881
Ref: c-api/import c PyImport_AppendInittab10698285
Ref: 3a4c10698285
Ref: c-api/import c _inittab10698828
Ref: 3bb010698828
Ref: c-api/import c PyImport_ExtendInittab10699453
Ref: 3baf10699453
Ref: Importing Modules<2>-Footnote-110700073
Node: Data marshalling support10700122
Ref: c-api/marshal doc10700270
Ref: 3bb110700270
Ref: c-api/marshal data-marshalling-support10700270
Ref: 3bb210700270
Ref: c-api/marshal marshalling-utils10700270
Ref: 3bb310700270
Ref: c-api/marshal c PyMarshal_WriteLongToFile10701017
Ref: 3bb410701017
Ref: c-api/marshal c PyMarshal_WriteObjectToFile10701335
Ref: 3bb510701335
Ref: c-api/marshal c PyMarshal_WriteObjectToString10701532
Ref: 3bb610701532
Ref: c-api/marshal c PyMarshal_ReadLongFromFile10701859
Ref: 3bb710701859
Ref: c-api/marshal c PyMarshal_ReadShortFromFile10702216
Ref: 3bb810702216
Ref: c-api/marshal c PyMarshal_ReadObjectFromFile10702575
Ref: 3bb910702575
Ref: c-api/marshal c PyMarshal_ReadLastObjectFromFile10702919
Ref: 3bba10702919
Ref: c-api/marshal c PyMarshal_ReadObjectFromString10703696
Ref: 3bbb10703696
Node: Parsing arguments and building values10704104
Ref: c-api/arg doc10704264
Ref: 3bbc10704264
Ref: c-api/arg arg-parsing10704264
Ref: 2ce10704264
Ref: c-api/arg parsing-arguments-and-building-values10704264
Ref: 3bbd10704264
Node: Parsing arguments<3>10704935
Ref: c-api/arg parsing-arguments10705053
Ref: 3bbe10705053
Node: Strings and buffers10705783
Ref: c-api/arg strings-and-buffers10705878
Ref: 3bbf10705878
Node: Numbers<2>10717942
Ref: c-api/arg numbers10718059
Ref: 3bc110718059
Node: Other objects10720177
Ref: c-api/arg other-objects10720288
Ref: 3bc310720288
Ref: c-api/arg o-ampersand10721040
Ref: 3bc410721040
Node: API Functions10725578
Ref: c-api/arg api-functions10725670
Ref: 3bc510725670
Ref: c-api/arg c PyArg_ParseTuple10725715
Ref: 26810725715
Ref: c-api/arg c PyArg_VaParse10726009
Ref: 3bc610726009
Ref: c-api/arg c PyArg_ParseTupleAndKeywords10726238
Ref: 5bf10726238
Ref: c-api/arg c PyArg_VaParseTupleAndKeywords10726839
Ref: dcd10726839
Ref: c-api/arg c PyArg_ValidateKeywordArguments10727137
Ref: 3bc710727137
Ref: c-api/arg c PyArg_Parse10727440
Ref: e9610727440
Ref: c-api/arg c PyArg_UnpackTuple10728044
Ref: e3910728044
Node: Building values10729875
Ref: c-api/arg building-values10729993
Ref: 3bc810729993
Ref: c-api/arg c Py_BuildValue10730042
Ref: 2cc10730042
Ref: c-api/arg c Py_VaBuildValue10737494
Ref: 3bc910737494
Node: String conversion and formatting10737748
Ref: c-api/conversion doc10737894
Ref: 3bca10737894
Ref: c-api/conversion string-conversion10737894
Ref: 3bcb10737894
Ref: c-api/conversion string-conversion-and-formatting10737894
Ref: 3bcc10737894
Ref: c-api/conversion c PyOS_snprintf10738035
Ref: e3c10738035
Ref: c-api/conversion c PyOS_vsnprintf10738296
Ref: e3d10738296
Ref: c-api/conversion c PyOS_string_to_double10739999
Ref: c1610739999
Ref: c-api/conversion c PyOS_double_to_string10741719
Ref: 3bcd10741719
Ref: c-api/conversion c PyOS_stricmp10743311
Ref: 3bce10743311
Ref: c-api/conversion c PyOS_strnicmp10743519
Ref: 3bcf10743519
Node: Reflection10743757
Ref: c-api/reflection doc10743902
Ref: 3bd010743902
Ref: c-api/reflection id110743902
Ref: 3bd110743902
Ref: c-api/reflection reflection10743902
Ref: 3bd210743902
Ref: c-api/reflection c PyEval_GetBuiltins10743937
Ref: 3bd310743937
Ref: c-api/reflection c PyEval_GetLocals10744181
Ref: 3bd410744181
Ref: c-api/reflection c PyEval_GetGlobals10744405
Ref: 3bd510744405
Ref: c-api/reflection c PyEval_GetFrame10744631
Ref: 3bd610744631
Ref: c-api/reflection c PyFrame_GetLineNumber10744828
Ref: cde10744828
Ref: c-api/reflection c PyEval_GetFuncName10744960
Ref: 3bd710744960
Ref: c-api/reflection c PyEval_GetFuncDesc10745140
Ref: 3bd810745140
Node: Codec registry and support functions10745518
Ref: c-api/codec doc10745622
Ref: 3bd910745622
Ref: c-api/codec codec-registry10745622
Ref: 5e310745622
Ref: c-api/codec codec-registry-and-support-functions10745622
Ref: 3bda10745622
Ref: c-api/codec c PyCodec_Register10745709
Ref: 3bdb10745709
Ref: c-api/codec c PyCodec_KnownEncoding10745986
Ref: 3bdc10745986
Ref: c-api/codec c PyCodec_Encode10746196
Ref: 3bdd10746196
Ref: c-api/codec c PyCodec_Decode10746677
Ref: 3bde10746677
Node: Codec lookup API10747242
Ref: c-api/codec codec-lookup-api10747388
Ref: 3bdf10747388
Ref: c-api/codec c PyCodec_Encoder10747706
Ref: 3be010747706
Ref: c-api/codec c PyCodec_Decoder10747864
Ref: 3be110747864
Ref: c-api/codec c PyCodec_IncrementalEncoder10748021
Ref: 3be210748021
Ref: c-api/codec c PyCodec_IncrementalDecoder10748242
Ref: 3be310748242
Ref: c-api/codec c PyCodec_StreamReader10748463
Ref: 3be410748463
Ref: c-api/codec c PyCodec_StreamWriter10748699
Ref: 3be510748699
Node: Registry API for Unicode encoding error handlers10748935
Ref: c-api/codec registry-api-for-unicode-encoding-error-handlers10749081
Ref: 3be610749081
Ref: c-api/codec c PyCodec_RegisterError10749196
Ref: 3be710749196
Ref: c-api/codec c PyCodec_LookupError10750288
Ref: 3be810750288
Ref: c-api/codec c PyCodec_StrictErrors10750597
Ref: 3be910750597
Ref: c-api/codec c PyCodec_IgnoreErrors10750724
Ref: 3bea10750724
Ref: c-api/codec c PyCodec_ReplaceErrors10750883
Ref: 3beb10750883
Ref: c-api/codec c PyCodec_XMLCharRefReplaceErrors10751053
Ref: 3bec10751053
Ref: c-api/codec c PyCodec_BackslashReplaceErrors10751244
Ref: 3bed10751244
Ref: c-api/codec c PyCodec_NameReplaceErrors10751451
Ref: 79c10751451
Node: Abstract Objects Layer10751649
Ref: c-api/abstract doc10751789
Ref: 3bee10751789
Ref: c-api/abstract abstract10751789
Ref: 3aad10751789
Ref: c-api/abstract abstract-objects-layer10751789
Ref: 3bef10751789
Node: Object Protocol10752500
Ref: c-api/object doc10752598
Ref: 3bf010752598
Ref: c-api/object object10752598
Ref: 3bf110752598
Ref: c-api/object object-protocol10752598
Ref: 3bf210752598
Ref: c-api/object c Py_NotImplemented10752643
Ref: 3bf310752643
Ref: c-api/object c Py_RETURN_NOTIMPLEMENTED10752819
Ref: 3bf410752819
Ref: c-api/object c PyObject_Print10753030
Ref: f8410753030
Ref: c-api/object c PyObject_HasAttr10753405
Ref: 3bf510753405
Ref: c-api/object c PyObject_HasAttrString10753904
Ref: 3bf710753904
Ref: c-api/object c PyObject_GetAttr10754466
Ref: 3bf610754466
Ref: c-api/object c PyObject_GetAttrString10754799
Ref: 3a5f10754799
Ref: c-api/object c PyObject_GenericGetAttr10755140
Ref: 3bf810755140
Ref: c-api/object c PyObject_SetAttr10755763
Ref: 3bf910755763
Ref: c-api/object c PyObject_SetAttrString10756259
Ref: 3bfb10756259
Ref: c-api/object c PyObject_GenericSetAttr10756769
Ref: 3bfd10756769
Ref: c-api/object c PyObject_DelAttr10757426
Ref: 3bfa10757426
Ref: c-api/object c PyObject_DelAttrString10757668
Ref: 3bfc10757668
Ref: c-api/object c PyObject_GenericGetDict10757928
Ref: 3bfe10757928
Ref: c-api/object c PyObject_GenericSetDict10758204
Ref: 3bff10758204
Ref: c-api/object c PyObject_RichCompare10758452
Ref: 3aaa10758452
Ref: c-api/object c PyObject_RichCompareBool10759081
Ref: 3aab10759081
Ref: c-api/object c PyObject_Repr10759854
Ref: 95c10759854
Ref: c-api/object c PyObject_ASCII10760355
Ref: 3c0010760355
Ref: c-api/object c PyObject_Str10760839
Ref: 95d10760839
Ref: c-api/object c PyObject_Bytes10761389
Ref: 3c0110761389
Ref: c-api/object c PyObject_IsSubclass10761820
Ref: 79210761820
Ref: c-api/object c PyObject_IsInstance10762796
Ref: 79110762796
Ref: c-api/object c PyCallable_Check10763767
Ref: 3c0210763767
Ref: c-api/object c PyObject_Call10763968
Ref: 3a5410763968
Ref: c-api/object c PyObject_CallObject10764613
Ref: 3a5310764613
Ref: c-api/object c PyObject_CallFunction10765085
Ref: 2cd10765085
Ref: c-api/object c PyObject_CallMethod10765900
Ref: 3c0410765900
Ref: c-api/object c PyObject_CallFunctionObjArgs10766778
Ref: 3c0310766778
Ref: c-api/object c PyObject_CallMethodObjArgs10767318
Ref: f0b10767318
Ref: c-api/object c _PyObject_Vectorcall10767869
Ref: 3c0510767869
Ref: c-api/object c PY_VECTORCALL_ARGUMENTS_OFFSET10769291
Ref: 3c0810769291
Ref: c-api/object c PyVectorcall_NARGS10769923
Ref: 3c0710769923
Ref: c-api/object c _PyObject_FastCallDict10770178
Ref: 3c0910770178
Ref: c-api/object c PyObject_Hash10771095
Ref: 3c0a10771095
Ref: c-api/object c PyObject_HashNotImplemented10771436
Ref: d2410771436
Ref: c-api/object c PyObject_IsTrue10771783
Ref: 3c0b10771783
Ref: c-api/object c PyObject_Not10772025
Ref: 3c0c10772025
Ref: c-api/object c PyObject_Type10772259
Ref: 3c0d10772259
Ref: c-api/object c PyObject_TypeCheck10772897
Ref: 3ab510772897
Ref: c-api/object c PyObject_Size10773095
Ref: 3c0e10773095
Ref: c-api/object c PyObject_Length10773150
Ref: 3c0f10773150
Ref: c-api/object c PyObject_LengthHint10773462
Ref: 91c10773462
Ref: c-api/object c PyObject_GetItem10773899
Ref: 3af610773899
Ref: c-api/object c PyObject_SetItem10774164
Ref: 3af410774164
Ref: c-api/object c PyObject_DelItem10774454
Ref: 3c1010774454
Ref: c-api/object c PyObject_Dir10774688
Ref: 3c1110774688
Ref: c-api/object c PyObject_GetIter10775225
Ref: 3c1210775225
Ref: Object Protocol-Footnote-110775633
Ref: Object Protocol-Footnote-210775682
Node: Number Protocol10775731
Ref: c-api/number doc10775855
Ref: 3c1310775855
Ref: c-api/number number10775855
Ref: 3c1410775855
Ref: c-api/number number-protocol10775855
Ref: 3c1510775855
Ref: c-api/number c PyNumber_Check10775900
Ref: 26910775900
Ref: c-api/number c PyNumber_Add10776150
Ref: 3c1610776150
Ref: c-api/number c PyNumber_Subtract10776400
Ref: 3c1710776400
Ref: c-api/number c PyNumber_Multiply10776661
Ref: 3c1810776661
Ref: c-api/number c PyNumber_MatrixMultiply10776921
Ref: 7a210776921
Ref: c-api/number c PyNumber_FloorDivide10777236
Ref: 3c1910777236
Ref: c-api/number c PyNumber_TrueDivide10777501
Ref: 3c1a10777501
Ref: c-api/number c PyNumber_Remainder10777992
Ref: 3c1b10777992
Ref: c-api/number c PyNumber_Divmod10778262
Ref: 3c1c10778262
Ref: c-api/number c PyNumber_Power10778536
Ref: 3c1d10778536
Ref: c-api/number c PyNumber_Negative10778999
Ref: 3c1e10778999
Ref: c-api/number c PyNumber_Positive10779230
Ref: 3c1f10779230
Ref: c-api/number c PyNumber_Absolute10779440
Ref: 3c2010779440
Ref: c-api/number c PyNumber_Invert10779670
Ref: 3c2110779670
Ref: c-api/number c PyNumber_Lshift10779907
Ref: 3c2210779907
Ref: c-api/number c PyNumber_Rshift10780178
Ref: 3c2310780178
Ref: c-api/number c PyNumber_And10780450
Ref: 3c2410780450
Ref: c-api/number c PyNumber_Xor10780715
Ref: 3c2510780715
Ref: c-api/number c PyNumber_Or10780988
Ref: 3c2610780988
Ref: c-api/number c PyNumber_InPlaceAdd10781251
Ref: 3c2710781251
Ref: c-api/number c PyNumber_InPlaceSubtract10781580
Ref: 3c2810781580
Ref: c-api/number c PyNumber_InPlaceMultiply10781920
Ref: 3c2910781920
Ref: c-api/number c PyNumber_InPlaceMatrixMultiply10782259
Ref: 7a310782259
Ref: c-api/number c PyNumber_InPlaceFloorDivide10782643
Ref: 3c2a10782643
Ref: c-api/number c PyNumber_InPlaceTrueDivide10782994
Ref: 3c2b10782994
Ref: c-api/number c PyNumber_InPlaceRemainder10783554
Ref: 3c2c10783554
Ref: c-api/number c PyNumber_InPlacePower10783893
Ref: 3c2d10783893
Ref: c-api/number c PyNumber_InPlaceLshift10784488
Ref: 3c2e10784488
Ref: c-api/number c PyNumber_InPlaceRshift10784838
Ref: 3c2f10784838
Ref: c-api/number c PyNumber_InPlaceAnd10785189
Ref: 3c3010785189
Ref: c-api/number c PyNumber_InPlaceXor10785533
Ref: 3c3110785533
Ref: c-api/number c PyNumber_InPlaceOr10785885
Ref: 3c3210785885
Ref: c-api/number c PyNumber_Long10786227
Ref: 26a10786227
Ref: c-api/number c PyNumber_Float10786482
Ref: 26b10786482
Ref: c-api/number c PyNumber_Index10786737
Ref: 3c3310786737
Ref: c-api/number c PyNumber_ToBase10786965
Ref: 3c3410786965
Ref: c-api/number c PyNumber_AsSsize_t10787426
Ref: 3c3510787426
Ref: c-api/number c PyIndex_Check10788155
Ref: f4810788155
Node: Sequence Protocol10788383
Ref: c-api/sequence doc10788508
Ref: 3c3610788508
Ref: c-api/sequence sequence10788508
Ref: 3c3710788508
Ref: c-api/sequence sequence-protocol10788508
Ref: 3c3810788508
Ref: c-api/sequence c PySequence_Check10788557
Ref: 3c3910788557
Ref: c-api/sequence c PySequence_Size10788967
Ref: f8510788967
Ref: c-api/sequence c PySequence_Length10789024
Ref: 3c3a10789024
Ref: c-api/sequence c PySequence_Concat10789237
Ref: 3c3b10789237
Ref: c-api/sequence c PySequence_Repeat10789503
Ref: 3c3c10789503
Ref: c-api/sequence c PySequence_InPlaceConcat10789795
Ref: 3c3d10789795
Ref: c-api/sequence c PySequence_InPlaceRepeat10790141
Ref: 3c3e10790141
Ref: c-api/sequence c PySequence_GetItem10790502
Ref: f8610790502
Ref: c-api/sequence c PySequence_GetSlice10790743
Ref: 3c3f10790743
Ref: c-api/sequence c PySequence_SetItem10791045
Ref: f8710791045
Ref: c-api/sequence c PySequence_DelItem10791543
Ref: f8810791543
Ref: c-api/sequence c PySequence_SetSlice10791755
Ref: 3c4010791755
Ref: c-api/sequence c PySequence_DelSlice10792033
Ref: 3c4110792033
Ref: c-api/sequence c PySequence_Count10792301
Ref: 3c4210792301
Ref: c-api/sequence c PySequence_Contains10792625
Ref: 3c4310792625
Ref: c-api/sequence c PySequence_Index10792920
Ref: 3c4410792920
Ref: c-api/sequence c PySequence_List10793175
Ref: 3c4510793175
Ref: c-api/sequence c PySequence_Tuple10793490
Ref: 3c4610793490
Ref: c-api/sequence c PySequence_Fast10793898
Ref: 3c4710793898
Ref: c-api/sequence c PySequence_Fast_GET_SIZE10794582
Ref: 3c4910794582
Ref: c-api/sequence c PySequence_Fast_GET_ITEM10794977
Ref: 3c4a10794977
Ref: c-api/sequence c PySequence_Fast_ITEMS10795271
Ref: 3c4b10795271
Ref: c-api/sequence c PySequence_ITEM10795675
Ref: 3c4c10795675
Node: Mapping Protocol10796023
Ref: c-api/mapping doc10796150
Ref: 3c4d10796150
Ref: c-api/mapping mapping10796150
Ref: 3c4e10796150
Ref: c-api/mapping mapping-protocol10796150
Ref: 3c4f10796150
Ref: c-api/mapping c PyMapping_Check10796307
Ref: 3c5010796307
Ref: c-api/mapping c PyMapping_Size10796686
Ref: f8910796686
Ref: c-api/mapping c PyMapping_Length10796742
Ref: 3c5110796742
Ref: c-api/mapping c PyMapping_GetItemString10796949
Ref: 3c5210796949
Ref: c-api/mapping c PyMapping_SetItemString10797280
Ref: 3c5310797280
Ref: c-api/mapping c PyMapping_DelItem10797586
Ref: 3c5410797586
Ref: c-api/mapping c PyMapping_DelItemString10797874
Ref: 3c5510797874
Ref: c-api/mapping c PyMapping_HasKey10798127
Ref: 3c5610798127
Ref: c-api/mapping c PyMapping_HasKeyString10798570
Ref: 3c5710798570
Ref: c-api/mapping c PyMapping_Keys10799082
Ref: 42110799082
Ref: c-api/mapping c PyMapping_Values10799353
Ref: 42210799353
Ref: c-api/mapping c PyMapping_Items10799628
Ref: 42310799628
Node: Iterator Protocol10799962
Ref: c-api/iter doc10800087
Ref: 3c5810800087
Ref: c-api/iter iterator10800087
Ref: 3c5910800087
Ref: c-api/iter iterator-protocol10800087
Ref: 3c5a10800087
Ref: c-api/iter c PyIter_Check10800202
Ref: f4710800202
Ref: c-api/iter c PyIter_Next10800318
Ref: 3c5b10800318
Node: Buffer Protocol10801197
Ref: c-api/buffer doc10801325
Ref: 3c5c10801325
Ref: c-api/buffer buffer-protocol10801325
Ref: 3c5d10801325
Ref: c-api/buffer bufferobjects10801325
Ref: 157910801325
Node: Buffer structure10803847
Ref: c-api/buffer buffer-structure10803944
Ref: 3c5f10803944
Ref: c-api/buffer id110803944
Ref: 3c6010803944
Ref: c-api/buffer c Py_buffer10805019
Ref: b0e10805019
Ref: c-api/buffer c Py_buffer buf10805042
Ref: 3c6210805042
Ref: c-api/buffer c Py_buffer obj10805503
Ref: 3c6410805503
Ref: c-api/buffer c Py_buffer len10806084
Ref: 3c6710806084
Ref: c-api/buffer c Py_buffer readonly10806684
Ref: 3c6a10806684
Ref: c-api/buffer c Py_buffer itemsize10806854
Ref: 3c6b10806854
Ref: c-api/buffer c Py_buffer format10807771
Ref: 3c6c10807771
Ref: c-api/buffer c Py_buffer ndim10808098
Ref: 3c6f10808098
Ref: c-api/buffer c Py_buffer shape10808696
Ref: 3c6e10808696
Ref: c-api/buffer c Py_buffer strides10809243
Ref: 3c6310809243
Ref: c-api/buffer c Py_buffer suboffsets10809763
Ref: 3c7010809763
Ref: c-api/buffer c Py_buffer internal10810650
Ref: 3c7210810650
Node: Buffer request types10811025
Ref: c-api/buffer buffer-request-types10811145
Ref: 3c7310811145
Ref: c-api/buffer id210811145
Ref: 3c7410811145
Node: request-independent fields10811753
Ref: c-api/buffer request-independent-fields10811860
Ref: 3c7510811860
Node: readonly format10812128
Ref: c-api/buffer readonly-format10812268
Ref: 3c7610812268
Ref: c-api/buffer c PyBUF_WRITABLE10812319
Ref: 3c6910812319
Ref: c-api/buffer c PyBUF_FORMAT10812652
Ref: 3c6d10812652
Node: shape strides suboffsets10813233
Ref: c-api/buffer shape-strides-suboffsets10813366
Ref: 3c7710813366
Ref: c-api/buffer c PyBUF_INDIRECT10813903
Ref: 3c7810813903
Ref: c-api/buffer c PyBUF_STRIDES10814094
Ref: 3c7910814094
Ref: c-api/buffer c PyBUF_ND10814276
Ref: 3c7a10814276
Ref: c-api/buffer c PyBUF_SIMPLE10814467
Ref: 3c6810814467
Node: contiguity requests10814569
Ref: c-api/buffer contiguity-requests10814704
Ref: 3c7b10814704
Ref: c-api/buffer c PyBUF_C_CONTIGUOUS10815313
Ref: 3c7c10815313
Ref: c-api/buffer c PyBUF_F_CONTIGUOUS10815566
Ref: 3c7d10815566
Ref: c-api/buffer c PyBUF_ANY_CONTIGUOUS10815821
Ref: 3c7e10815821
Node: compound requests10816216
Ref: c-api/buffer compound-requests10816318
Ref: 3c7f10816318
Ref: c-api/buffer c PyBUF_FULL10817193
Ref: 3c8110817193
Ref: c-api/buffer c PyBUF_FULL_RO10817523
Ref: 3c8210817523
Ref: c-api/buffer c PyBUF_RECORDS10817850
Ref: 3c8310817850
Ref: c-api/buffer c PyBUF_RECORDS_RO10818180
Ref: 3c8410818180
Ref: c-api/buffer c PyBUF_STRIDED10818504
Ref: 3c8510818504
Ref: c-api/buffer c PyBUF_STRIDED_RO10818835
Ref: 3c8610818835
Ref: c-api/buffer c PyBUF_CONTIG10819159
Ref: 3c8710819159
Ref: c-api/buffer c PyBUF_CONTIG_RO10819490
Ref: 3c8810819490
Node: Complex arrays10819683
Ref: c-api/buffer complex-arrays10819811
Ref: 3c7110819811
Node: NumPy-style shape and strides10820017
Ref: c-api/buffer numpy-style-shape-and-strides10820144
Ref: 3c8910820144
Node: PIL-style shape strides and suboffsets10821914
Ref: c-api/buffer pil-style-shape-strides-and-suboffsets10822041
Ref: 3c8a10822041
Node: Buffer-related functions10823212
Ref: c-api/buffer buffer-related-functions10823311
Ref: 3c8b10823311
Ref: c-api/buffer c PyObject_CheckBuffer10823380
Ref: 3c8c10823380
Ref: c-api/buffer c PyObject_GetBuffer10823665
Ref: d1810823665
Ref: c-api/buffer c PyBuffer_Release10824613
Ref: d4710824613
Ref: c-api/buffer c PyBuffer_SizeFromFormat10824994
Ref: 3c8d10824994
Ref: c-api/buffer c PyBuffer_IsContiguous10825176
Ref: 3c8010825176
Ref: c-api/buffer c PyBuffer_GetPointer10825515
Ref: 3c8e10825515
Ref: c-api/buffer c PyBuffer_FromContiguous10825754
Ref: 3c8f10825754
Ref: c-api/buffer c PyBuffer_ToContiguous10826062
Ref: 3c9010826062
Ref: c-api/buffer c PyBuffer_FillContiguousStrides10826472
Ref: 3c9110826472
Ref: c-api/buffer c PyBuffer_FillInfo10826860
Ref: 3c6610826860
Node: Old Buffer Protocol10827837
Ref: c-api/objbuffer doc10827939
Ref: 3c9210827939
Ref: c-api/objbuffer old-buffer-protocol10827939
Ref: 3c9310827939
Ref: c-api/objbuffer c PyObject_AsCharBuffer10828701
Ref: 3c9410828701
Ref: c-api/objbuffer c PyObject_AsReadBuffer10829175
Ref: 3c9510829175
Ref: c-api/objbuffer c PyObject_CheckReadBuffer10829636
Ref: 3c9610829636
Ref: c-api/objbuffer c PyObject_AsWriteBuffer10830081
Ref: 3c9710830081
Node: Concrete Objects Layer10830513
Ref: c-api/concrete doc10830680
Ref: 3c9810830680
Ref: c-api/concrete concrete10830680
Ref: 3c9910830680
Ref: c-api/concrete concrete-objects-layer10830680
Ref: 3c9a10830680
Node: Fundamental Objects10831665
Ref: c-api/concrete fundamental10831767
Ref: 3c9c10831767
Ref: c-api/concrete fundamental-objects10831767
Ref: 3c9d10831767
Node: Type Objects<2>10831964
Ref: c-api/type doc10832059
Ref: 3c9e10832059
Ref: c-api/type type-objects10832059
Ref: 3c9f10832059
Ref: c-api/type typeobjects10832059
Ref: 3ca010832059
Ref: c-api/type c PyTypeObject10832102
Ref: 2d410832102
Ref: c-api/type c PyType_Type10832198
Ref: 3ca110832198
Ref: c-api/type c PyType_Check10832353
Ref: 3ca210832353
Ref: c-api/type c PyType_CheckExact10832567
Ref: 3ca310832567
Ref: c-api/type c PyType_ClearCache10832760
Ref: 3ca410832760
Ref: c-api/type c PyType_GetFlags10832883
Ref: 3ca510832883
Ref: c-api/type c PyType_Modified10833377
Ref: 3ca710833377
Ref: c-api/type c PyType_HasFeature10833634
Ref: 3ca810833634
Ref: c-api/type c PyType_IS_GC10833825
Ref: 3ca910833825
Ref: c-api/type c PyType_IsSubtype10834017
Ref: 3caa10834017
Ref: c-api/type c PyType_GenericAlloc10834377
Ref: 26e10834377
Ref: c-api/type c PyType_GenericNew10834721
Ref: 3a8110834721
Ref: c-api/type c PyType_Ready10835013
Ref: 3a8610835013
Ref: c-api/type c PyType_GetSlot10835352
Ref: 91810835352
Node: Creating Heap-Allocated Types10835929
Ref: c-api/type creating-heap-allocated-types10836010
Ref: 3cab10836010
Ref: c-api/type c PyType_FromSpecWithBases10836167
Ref: 3cad10836167
Ref: c-api/type c PyType_FromSpec10836752
Ref: 2cf10836752
Ref: c-api/type c PyType_Spec10836915
Ref: 3caf10836915
Ref: c-api/type c PyType_Spec PyType_Spec name10836986
Ref: 3cb010836986
Ref: c-api/type c PyType_Spec PyType_Spec basicsize10837120
Ref: 3cb110837120
Ref: c-api/type c PyType_Spec PyType_Spec itemsize10837166
Ref: 3cb210837166
Ref: c-api/type c PyType_Spec PyType_Spec flags10837366
Ref: 3cb310837366
Ref: c-api/type c PyType_Spec PyType_Spec slots10837612
Ref: 3cb410837612
Ref: c-api/type c PyType_Slot10837785
Ref: 3cb510837785
Ref: c-api/type c PyType_Slot PyType_Slot slot10837916
Ref: 3cb610837916
Ref: c-api/type c PyType_Slot PyType_Slot pfunc10839256
Ref: 3cc110839256
Node: The None Object10839435
Ref: c-api/none doc10839530
Ref: 3cc210839530
Ref: c-api/none noneobject10839530
Ref: 3cc310839530
Ref: c-api/none the-none-object10839530
Ref: 3cc410839530
Ref: c-api/none c Py_None10839849
Ref: 3a4810839849
Ref: c-api/none c Py_RETURN_NONE10840068
Ref: dc910840068
Node: Numeric Objects10840255
Ref: c-api/concrete numeric-objects10840382
Ref: 3cc510840382
Ref: c-api/concrete numericobjects10840382
Ref: 3cc610840382
Node: Integer Objects10840531
Ref: c-api/long doc10840622
Ref: 3cc710840622
Ref: c-api/long integer-objects10840622
Ref: 3cc810840622
Ref: c-api/long longobjects10840622
Ref: 3cc910840622
Ref: c-api/long c PyLongObject10840914
Ref: 3cca10840914
Ref: c-api/long c PyLong_Type10841024
Ref: 3ccb10841024
Ref: c-api/long c PyLong_Check10841225
Ref: 3ccc10841225
Ref: c-api/long c PyLong_CheckExact10841385
Ref: 3ccd10841385
Ref: c-api/long c PyLong_FromLong10841555
Ref: 3a4510841555
Ref: c-api/long c PyLong_FromUnsignedLong10842092
Ref: 3cce10842092
Ref: c-api/long c PyLong_FromSsize_t10842305
Ref: 3ccf10842305
Ref: c-api/long c PyLong_FromSize_t10842507
Ref: 3cd010842507
Ref: c-api/long c PyLong_FromLongLong10842700
Ref: 3cd110842700
Ref: c-api/long c PyLong_FromUnsignedLongLong10842901
Ref: 3cd210842901
Ref: c-api/long c PyLong_FromDouble10843138
Ref: 3cd310843138
Ref: c-api/long c PyLong_FromString10843338
Ref: 3cd410843338
Ref: c-api/long c PyLong_FromUnicode10844202
Ref: 3cd510844202
Ref: c-api/long c PyLong_FromUnicodeObject10844761
Ref: 3cd610844761
Ref: c-api/long c PyLong_FromVoidPtr10845162
Ref: 3cd710845162
Ref: c-api/long c PyLong_AsLong10845410
Ref: 26710845410
Ref: c-api/long c PyLong_AsLongAndOverflow10846062
Ref: bf010846062
Ref: c-api/long c PyLong_AsLongLong10846956
Ref: 3cd910846956
Ref: c-api/long c PyLong_AsLongLongAndOverflow10847622
Ref: bef10847622
Ref: c-api/long c PyLong_AsSsize_t10848564
Ref: 3cda10848564
Ref: c-api/long c PyLong_AsUnsignedLong10848952
Ref: 3cdb10848952
Ref: c-api/long c PyLong_AsSize_t10849369
Ref: 3cdc10849369
Ref: c-api/long c PyLong_AsUnsignedLongLong10849752
Ref: c1510849752
Ref: c-api/long c PyLong_AsUnsignedLongMask10850321
Ref: 3cdd10850321
Ref: c-api/long c PyLong_AsUnsignedLongLongMask10851059
Ref: eeb10851059
Ref: c-api/long c PyLong_AsDouble10851835
Ref: 3cde10851835
Ref: c-api/long c PyLong_AsVoidPtr10852212
Ref: 3cd810852212
Node: Boolean Objects10852643
Ref: c-api/bool doc10852765
Ref: 3cdf10852765
Ref: c-api/bool boolean-objects10852765
Ref: 3ce010852765
Ref: c-api/bool boolobjects10852765
Ref: 3ce110852765
Ref: c-api/bool c PyBool_Check10853067
Ref: 3ce210853067
Ref: c-api/bool c Py_False10853170
Ref: 3ce310853170
Ref: c-api/bool c Py_True10853367
Ref: 3ce410853367
Ref: c-api/bool c Py_RETURN_FALSE10853562
Ref: dcb10853562
Ref: c-api/bool c Py_RETURN_TRUE10853685
Ref: dca10853685
Ref: c-api/bool c PyBool_FromLong10853806
Ref: 3ce510853806
Node: Floating Point Objects10853995
Ref: c-api/float doc10854124
Ref: 3ce610854124
Ref: c-api/float floating-point-objects10854124
Ref: 3ce710854124
Ref: c-api/float floatobjects10854124
Ref: 3ce810854124
Ref: c-api/float c PyFloatObject10854187
Ref: 3ce910854187
Ref: c-api/float c PyFloat_Type10854305
Ref: 3cea10854305
Ref: c-api/float c PyFloat_Check10854516
Ref: 3ceb10854516
Ref: c-api/float c PyFloat_CheckExact10854679
Ref: 3cec10854679
Ref: c-api/float c PyFloat_FromString10854852
Ref: 3ced10854852
Ref: c-api/float c PyFloat_FromDouble10855061
Ref: 3cee10855061
Ref: c-api/float c PyFloat_AsDouble10855239
Ref: 26c10855239
Ref: c-api/float c PyFloat_AS_DOUBLE10855837
Ref: 3cef10855837
Ref: c-api/float c PyFloat_GetInfo10856007
Ref: d4a10856007
Ref: c-api/float c PyFloat_GetMax10856285
Ref: d4810856285
Ref: c-api/float c PyFloat_GetMin10856413
Ref: d4910856413
Ref: c-api/float c PyFloat_ClearFreeList10856540
Ref: 3cf010856540
Node: Complex Number Objects10856677
Ref: c-api/complex doc10856782
Ref: 3cf110856782
Ref: c-api/complex complex-number-objects10856782
Ref: 3cf210856782
Ref: c-api/complex complexobjects10856782
Ref: 3cf310856782
Node: Complex Numbers as C Structures10857215
Ref: c-api/complex complex-numbers-as-c-structures10857347
Ref: 3cf410857347
Ref: c-api/complex c Py_complex10857630
Ref: 3bc210857630
Ref: c-api/complex c _Py_c_sum10857992
Ref: 3cf510857992
Ref: c-api/complex c _Py_c_diff10858168
Ref: 3cf610858168
Ref: c-api/complex c _Py_c_neg10858367
Ref: 3cf710858367
Ref: c-api/complex c _Py_c_prod10858542
Ref: 3cf810858542
Ref: c-api/complex c _Py_c_quot10858733
Ref: 3cf910858733
Ref: c-api/complex c _Py_c_pow10859025
Ref: 3cfa10859025
Node: Complex Numbers as Python Objects10859334
Ref: c-api/complex complex-numbers-as-python-objects10859466
Ref: 3cfb10859466
Ref: c-api/complex c PyComplexObject10859551
Ref: 3cfc10859551
Ref: c-api/complex c PyComplex_Type10859671
Ref: 3cfd10859671
Ref: c-api/complex c PyComplex_Check10859884
Ref: 3cfe10859884
Ref: c-api/complex c PyComplex_CheckExact10860053
Ref: 3cff10860053
Ref: c-api/complex c PyComplex_FromCComplex10860232
Ref: 3d0010860232
Ref: c-api/complex c PyComplex_FromDoubles10860421
Ref: 3d0110860421
Ref: c-api/complex c PyComplex_RealAsDouble10860622
Ref: 3d0210860622
Ref: c-api/complex c PyComplex_ImagAsDouble10860740
Ref: 3d0310860740
Ref: c-api/complex c PyComplex_AsCComplex10860863
Ref: d4b10860863
Node: Sequence Objects10861520
Ref: c-api/concrete sequence-objects10861645
Ref: 3d0410861645
Ref: c-api/concrete sequenceobjects10861645
Ref: 3d0510861645
Node: Bytes Objects<2>10862040
Ref: c-api/bytes doc10862136
Ref: 3d0610862136
Ref: c-api/bytes bytes-objects10862136
Ref: 3d0710862136
Ref: c-api/bytes bytesobjects10862136
Ref: 3d0810862136
Ref: c-api/bytes c PyBytesObject10862302
Ref: d1110862302
Ref: c-api/bytes c PyBytes_Type10862411
Ref: 3d0910862411
Ref: c-api/bytes c PyBytes_Check10862610
Ref: d1210862610
Ref: c-api/bytes c PyBytes_CheckExact10862765
Ref: 3d0a10862765
Ref: c-api/bytes c PyBytes_FromString10862931
Ref: 3d0b10862931
Ref: c-api/bytes c PyBytes_FromStringAndSize10863210
Ref: d1310863210
Ref: c-api/bytes c PyBytes_FromFormat10863553
Ref: f3f10863553
Ref: c-api/bytes c PyBytes_FromFormatV10867399
Ref: 3d0c10867399
Ref: c-api/bytes c PyBytes_FromObject10867629
Ref: 3d0d10867629
Ref: c-api/bytes c PyBytes_Size10867814
Ref: 3d0e10867814
Ref: c-api/bytes c PyBytes_GET_SIZE10867927
Ref: 3d0f10867927
Ref: c-api/bytes c PyBytes_AsString10868067
Ref: 3d1010868067
Ref: c-api/bytes c PyBytes_AS_STRING10868680
Ref: 3d1110868680
Ref: c-api/bytes c PyBytes_AsStringAndSize10868825
Ref: 3d1210868825
Ref: c-api/bytes c PyBytes_Concat10869827
Ref: 3d1310869827
Ref: c-api/bytes c PyBytes_ConcatAndDel10870320
Ref: 3d1410870320
Ref: c-api/bytes c _PyBytes_Resize10870582
Ref: f8210870582
Ref: Bytes Objects<2>-Footnote-110871466
Ref: Bytes Objects<2>-Footnote-210871596
Ref: Bytes Objects<2>-Footnote-310871726
Ref: Bytes Objects<2>-Footnote-410871856
Ref: Bytes Objects<2>-Footnote-510871986
Ref: Bytes Objects<2>-Footnote-610872116
Ref: Bytes Objects<2>-Footnote-710872246
Ref: Bytes Objects<2>-Footnote-810872376
Node: Byte Array Objects10872506
Ref: c-api/bytearray doc10872637
Ref: 3d1510872637
Ref: c-api/bytearray byte-array-objects10872637
Ref: 3d1610872637
Ref: c-api/bytearray bytearrayobjects10872637
Ref: 3d1710872637
Ref: c-api/bytearray c PyByteArrayObject10872692
Ref: 3d1810872692
Ref: c-api/bytearray c PyByteArray_Type10872809
Ref: 3d1910872809
Node: Type check macros10873088
Ref: c-api/bytearray type-check-macros10873189
Ref: 3d1a10873189
Ref: c-api/bytearray c PyByteArray_Check10873242
Ref: 3d1b10873242
Ref: c-api/bytearray c PyByteArray_CheckExact10873409
Ref: 3d1c10873409
Node: Direct API functions10873587
Ref: c-api/bytearray direct-api-functions10873703
Ref: 3d1d10873703
Ref: c-api/bytearray c PyByteArray_FromObject10873762
Ref: d1410873762
Ref: c-api/bytearray c PyByteArray_FromStringAndSize10873969
Ref: d1510873969
Ref: c-api/bytearray c PyByteArray_Concat10874219
Ref: 3d1e10874219
Ref: c-api/bytearray c PyByteArray_Size10874408
Ref: 3d1f10874408
Ref: c-api/bytearray c PyByteArray_AsString10874553
Ref: 3d2010874553
Ref: c-api/bytearray c PyByteArray_Resize10874787
Ref: 3d2110874787
Node: Macros10874933
Ref: c-api/bytearray macros10875023
Ref: 3d2210875023
Ref: c-api/bytearray c PyByteArray_AS_STRING10875124
Ref: 3d2310875124
Ref: c-api/bytearray c PyByteArray_GET_SIZE10875250
Ref: 3d2410875250
Node: Unicode Objects and Codecs10875376
Ref: c-api/unicode doc10875504
Ref: b0f10875504
Ref: c-api/unicode unicode-objects-and-codecs10875504
Ref: 3d2510875504
Ref: c-api/unicode unicodeobjects10875504
Ref: 3d2610875504
Node: Unicode Objects10875656
Ref: c-api/unicode unicode-objects10875758
Ref: 3d2710875758
Ref: Unicode Objects-Footnote-110877306
Node: Unicode Type10877355
Ref: c-api/unicode unicode-type10877456
Ref: 3d2810877456
Ref: c-api/unicode c Py_UCS410877588
Ref: ac810877588
Ref: c-api/unicode c Py_UCS210877608
Ref: ac710877608
Ref: c-api/unicode c Py_UCS110877628
Ref: ac610877628
Ref: c-api/unicode c Py_UNICODE10877897
Ref: ae310877897
Ref: c-api/unicode c PyASCIIObject10878239
Ref: ac910878239
Ref: c-api/unicode c PyCompactUnicodeObject10878265
Ref: aca10878265
Ref: c-api/unicode c PyUnicodeObject10878300
Ref: 3d2910878300
Ref: c-api/unicode c PyUnicode_Type10878609
Ref: 3d2a10878609
Ref: c-api/unicode c PyUnicode_Check10878919
Ref: 3d2b10878919
Ref: c-api/unicode c PyUnicode_CheckExact10879068
Ref: 3d2c10879068
Ref: c-api/unicode c PyUnicode_READY10879220
Ref: acb10879220
Ref: c-api/unicode c PyUnicode_GET_LENGTH10879597
Ref: ac110879597
Ref: c-api/unicode c PyUnicode_1BYTE_DATA10879844
Ref: ad010879844
Ref: c-api/unicode c PyUnicode_2BYTE_DATA10879904
Ref: ad110879904
Ref: c-api/unicode c PyUnicode_4BYTE_DATA10879964
Ref: ad210879964
Ref: c-api/unicode c PyUnicode_WCHAR_KIND10880429
Ref: ad410880429
Ref: c-api/unicode c PyUnicode_1BYTE_KIND10880463
Ref: ad510880463
Ref: c-api/unicode c PyUnicode_2BYTE_KIND10880497
Ref: ad610880497
Ref: c-api/unicode c PyUnicode_4BYTE_KIND10880531
Ref: ad710880531
Ref: c-api/unicode c PyUnicode_KIND10880655
Ref: ad310880655
Ref: c-api/unicode c PyUnicode_DATA10880979
Ref: acf10880979
Ref: c-api/unicode c PyUnicode_WRITE10881202
Ref: ada10881202
Ref: c-api/unicode c PyUnicode_READ10881769
Ref: ad810881769
Ref: c-api/unicode c PyUnicode_READ_CHAR10882049
Ref: ad910882049
Ref: c-api/unicode c PyUnicode_MAX_CHAR_VALUE10882371
Ref: adb10882371
Ref: c-api/unicode c PyUnicode_ClearFreeList10882700
Ref: 3d2d10882700
Ref: c-api/unicode c PyUnicode_GET_SIZE10882816
Ref: aea10882816
Ref: c-api/unicode c PyUnicode_GET_DATA_SIZE10883243
Ref: aec10883243
Ref: c-api/unicode c PyUnicode_AS_UNICODE10883626
Ref: ae610883626
Ref: c-api/unicode c PyUnicode_AS_DATA10883689
Ref: ae910883689
Node: Unicode Character Properties10884759
Ref: c-api/unicode unicode-character-properties10884907
Ref: 3d2e10884907
Ref: c-api/unicode c Py_UNICODE_ISSPACE10885171
Ref: 3d2f10885171
Ref: c-api/unicode c Py_UNICODE_ISLOWER10885317
Ref: 3d3010885317
Ref: c-api/unicode c Py_UNICODE_ISUPPER10885462
Ref: 3d3110885462
Ref: c-api/unicode c Py_UNICODE_ISTITLE10885608
Ref: 3d3210885608
Ref: c-api/unicode c Py_UNICODE_ISLINEBREAK10885753
Ref: 3d3310885753
Ref: c-api/unicode c Py_UNICODE_ISDECIMAL10885902
Ref: 3d3410885902
Ref: c-api/unicode c Py_UNICODE_ISDIGIT10886042
Ref: 3d3510886042
Ref: c-api/unicode c Py_UNICODE_ISNUMERIC10886178
Ref: 3d3610886178
Ref: c-api/unicode c Py_UNICODE_ISALPHA10886318
Ref: 3d3710886318
Ref: c-api/unicode c Py_UNICODE_ISALNUM10886465
Ref: 3d3810886465
Ref: c-api/unicode c Py_UNICODE_ISPRINTABLE10886614
Ref: 3d3910886614
Ref: c-api/unicode c Py_UNICODE_TOLOWER10887285
Ref: 3d3a10887285
Ref: c-api/unicode c Py_UNICODE_TOUPPER10887487
Ref: 3d3b10887487
Ref: c-api/unicode c Py_UNICODE_TOTITLE10887689
Ref: 3d3c10887689
Ref: c-api/unicode c Py_UNICODE_TODECIMAL10887891
Ref: 3d3d10887891
Ref: c-api/unicode c Py_UNICODE_TODIGIT10888112
Ref: 3d3e10888112
Ref: c-api/unicode c Py_UNICODE_TONUMERIC10888327
Ref: 3d3f10888327
Ref: c-api/unicode c Py_UNICODE_IS_SURROGATE10888580
Ref: 3d4010888580
Ref: c-api/unicode c Py_UNICODE_IS_HIGH_SURROGATE10888690
Ref: 3d4110888690
Ref: c-api/unicode c Py_UNICODE_IS_LOW_SURROGATE10888810
Ref: 3d4210888810
Ref: c-api/unicode c Py_UNICODE_JOIN_SURROGATES10888928
Ref: 3d4310888928
Node: Creating and accessing Unicode strings10889153
Ref: c-api/unicode creating-and-accessing-unicode-strings10889315
Ref: 3d4410889315
Ref: c-api/unicode c PyUnicode_New10889499
Ref: ac210889499
Ref: c-api/unicode c PyUnicode_FromKindAndData10890002
Ref: acc10890002
Ref: c-api/unicode c PyUnicode_FromStringAndSize10890461
Ref: 3d4510890461
Ref: c-api/unicode c PyUnicode_FromString10891089
Ref: 3ad510891089
Ref: c-api/unicode c PyUnicode_FromFormat10891273
Ref: 7bf10891273
Ref: c-api/unicode c PyUnicode_FromFormatV10898527
Ref: 3b9410898527
Ref: c-api/unicode c PyUnicode_FromEncodedObject10898761
Ref: 3d4610898761
Ref: c-api/unicode c PyUnicode_GetLength10899523
Ref: ac010899523
Ref: c-api/unicode c PyUnicode_CopyCharacters10899680
Ref: abf10899680
Ref: c-api/unicode c PyUnicode_Fill10900157
Ref: af010900157
Ref: c-api/unicode c PyUnicode_WriteChar10900636
Ref: ac510900636
Ref: c-api/unicode c PyUnicode_ReadChar10901199
Ref: ac410901199
Ref: c-api/unicode c PyUnicode_Substring10901525
Ref: ac310901525
Ref: c-api/unicode c PyUnicode_AsUCS410901848
Ref: acd10901848
Ref: c-api/unicode c PyUnicode_AsUCS4Copy10902279
Ref: ace10902279
Ref: Creating and accessing Unicode strings-Footnote-110902659
Ref: Creating and accessing Unicode strings-Footnote-210902812
Ref: Creating and accessing Unicode strings-Footnote-310902965
Ref: Creating and accessing Unicode strings-Footnote-410903118
Ref: Creating and accessing Unicode strings-Footnote-510903271
Ref: Creating and accessing Unicode strings-Footnote-610903424
Ref: Creating and accessing Unicode strings-Footnote-710903577
Ref: Creating and accessing Unicode strings-Footnote-810903730
Ref: Creating and accessing Unicode strings-Footnote-910903883
Ref: Creating and accessing Unicode strings-Footnote-1010904036
Ref: Creating and accessing Unicode strings-Footnote-1110904190
Ref: Creating and accessing Unicode strings-Footnote-1210904344
Ref: Creating and accessing Unicode strings-Footnote-1310904498
Node: Deprecated Py_UNICODE APIs10904652
Ref: c-api/unicode deprecated-py-unicode-apis10904801
Ref: 3d4810904801
Ref: c-api/unicode c PyUnicode_FromUnicode10905178
Ref: ae410905178
Ref: c-api/unicode c PyUnicode_AsUnicode10906116
Ref: ae710906116
Ref: c-api/unicode c PyUnicode_TransformDecimalToASCII10906840
Ref: b0210906840
Ref: c-api/unicode c PyUnicode_AsUnicodeAndSize10907204
Ref: ae810907204
Ref: c-api/unicode c PyUnicode_AsUnicodeCopy10907676
Ref: aed10907676
Ref: c-api/unicode c PyUnicode_GetSize10908323
Ref: aeb10908323
Ref: c-api/unicode c PyUnicode_FromObject10908600
Ref: 3d4910908600
Ref: Deprecated Py_UNICODE APIs-Footnote-110909030
Node: Locale Encoding10909079
Ref: c-api/unicode locale-encoding10909210
Ref: 3d4a10909210
Ref: c-api/unicode c PyUnicode_DecodeLocaleAndSize10909344
Ref: 43310909344
Ref: c-api/unicode c PyUnicode_DecodeLocale10910523
Ref: 3d4b10910523
Ref: c-api/unicode c PyUnicode_EncodeLocale10910801
Ref: 43410910801
Ref: Locale Encoding-Footnote-110911994
Ref: Locale Encoding-Footnote-210912043
Node: File System Encoding10912092
Ref: c-api/unicode file-system-encoding10912212
Ref: 3d4c10912212
Ref: c-api/unicode c PyUnicode_FSConverter10912694
Ref: 5c310912694
Ref: c-api/unicode c PyUnicode_FSDecoder10913407
Ref: 5c410913407
Ref: c-api/unicode c PyUnicode_DecodeFSDefaultAndSize10913968
Ref: 3b8a10913968
Ref: c-api/unicode c PyUnicode_DecodeFSDefault10914755
Ref: 3d4d10914755
Ref: c-api/unicode c PyUnicode_EncodeFSDefault10915288
Ref: f8310915288
Ref: File System Encoding-Footnote-110916217
Ref: File System Encoding-Footnote-210916266
Node: wchar_t Support10916315
Ref: c-api/unicode wchar-t-support10916411
Ref: 3d4e10916411
Ref: c-api/unicode c PyUnicode_FromWideChar10916517
Ref: ae510916517
Ref: c-api/unicode c PyUnicode_AsWideChar10916881
Ref: f8a10916881
Ref: c-api/unicode c PyUnicode_AsWideCharString10917688
Ref: 42d10917688
Node: Built-in Codecs10918762
Ref: c-api/unicode built-in-codecs10918899
Ref: 3d4f10918899
Ref: c-api/unicode builtincodecs10918899
Ref: 3d4710918899
Node: Generic Codecs10920327
Ref: c-api/unicode generic-codecs10920414
Ref: 3d5010920414
Ref: c-api/unicode c PyUnicode_Decode10920498
Ref: ea410920498
Ref: c-api/unicode c PyUnicode_AsEncodedString10921019
Ref: 3d5110921019
Ref: c-api/unicode c PyUnicode_Encode10921530
Ref: af110921530
Node: UTF-8 Codecs10922271
Ref: c-api/unicode utf-8-codecs10922380
Ref: 3d5210922380
Ref: c-api/unicode c PyUnicode_DecodeUTF810922458
Ref: 3d5310922458
Ref: c-api/unicode c PyUnicode_DecodeUTF8Stateful10922758
Ref: 3d5410922758
Ref: c-api/unicode c PyUnicode_AsUTF8String10923256
Ref: af410923256
Ref: c-api/unicode c PyUnicode_AsUTF8AndSize10923548
Ref: 41f10923548
Ref: c-api/unicode c PyUnicode_AsUTF810924481
Ref: 42010924481
Ref: c-api/unicode c PyUnicode_EncodeUTF810924755
Ref: af310924755
Node: UTF-32 Codecs10925376
Ref: c-api/unicode utf-32-codecs10925484
Ref: 3d5510925484
Ref: c-api/unicode c PyUnicode_DecodeUTF3210925565
Ref: 3d5610925565
Ref: c-api/unicode c PyUnicode_DecodeUTF32Stateful10926695
Ref: 3d5710926695
Ref: c-api/unicode c PyUnicode_AsUTF32String10927317
Ref: 3d5810927317
Ref: c-api/unicode c PyUnicode_EncodeUTF3210927652
Ref: af510927652
Node: UTF-16 Codecs10928679
Ref: c-api/unicode utf-16-codecs10928787
Ref: 3d5910928787
Ref: c-api/unicode c PyUnicode_DecodeUTF1610928868
Ref: 3d5a10928868
Ref: c-api/unicode c PyUnicode_DecodeUTF16Stateful10930078
Ref: 3d5b10930078
Ref: c-api/unicode c PyUnicode_AsUTF16String10930709
Ref: 3d5c10930709
Ref: c-api/unicode c PyUnicode_EncodeUTF1610931044
Ref: af610931044
Node: UTF-7 Codecs10932196
Ref: c-api/unicode utf-7-codecs10932312
Ref: 3d5d10932312
Ref: c-api/unicode c PyUnicode_DecodeUTF710932390
Ref: 3d5e10932390
Ref: c-api/unicode c PyUnicode_DecodeUTF7Stateful10932690
Ref: 3d5f10932690
Ref: c-api/unicode c PyUnicode_EncodeUTF710933190
Ref: af210933190
Node: Unicode-Escape Codecs10934031
Ref: c-api/unicode unicode-escape-codecs10934159
Ref: 3d6010934159
Ref: c-api/unicode c PyUnicode_DecodeUnicodeEscape10934270
Ref: 3d6110934270
Ref: c-api/unicode c PyUnicode_AsUnicodeEscapeString10934588
Ref: af710934588
Ref: c-api/unicode c PyUnicode_EncodeUnicodeEscape10934908
Ref: 3d6210934908
Node: Raw-Unicode-Escape Codecs10935428
Ref: c-api/unicode raw-unicode-escape-codecs10935558
Ref: 3d6310935558
Ref: c-api/unicode c PyUnicode_DecodeRawUnicodeEscape10935681
Ref: 3d6410935681
Ref: c-api/unicode c PyUnicode_AsRawUnicodeEscapeString10936006
Ref: af810936006
Ref: c-api/unicode c PyUnicode_EncodeRawUnicodeEscape10936333
Ref: 3d6510936333
Node: Latin-1 Codecs10936917
Ref: c-api/unicode latin-1-codecs10937038
Ref: 3d6610937038
Ref: c-api/unicode c PyUnicode_DecodeLatin110937235
Ref: 3d6710937235
Ref: c-api/unicode c PyUnicode_AsLatin1String10937539
Ref: afa10937539
Ref: c-api/unicode c PyUnicode_EncodeLatin110937840
Ref: af910937840
Node: ASCII Codecs10938415
Ref: c-api/unicode ascii-codecs10938531
Ref: 3d6810938531
Ref: c-api/unicode c PyUnicode_DecodeASCII10938679
Ref: 3d6910938679
Ref: c-api/unicode c PyUnicode_AsASCIIString10938980
Ref: afc10938980
Ref: c-api/unicode c PyUnicode_EncodeASCII10939273
Ref: afb10939273
Node: Character Map Codecs10939844
Ref: c-api/unicode character-map-codecs10939969
Ref: 3d6a10939969
Ref: c-api/unicode c PyUnicode_DecodeCharmap10940448
Ref: 3d6b10940448
Ref: c-api/unicode c PyUnicode_AsCharmapString10941272
Ref: 3d6c10941272
Ref: c-api/unicode c PyUnicode_EncodeCharmap10941932
Ref: afd10941932
Ref: c-api/unicode c PyUnicode_Translate10942629
Ref: 3d6d10942629
Ref: c-api/unicode c PyUnicode_TranslateCharmap10943278
Ref: afe10943278
Node: MBCS codecs for Windows10943925
Ref: c-api/unicode mbcs-codecs-for-windows10944053
Ref: 3d6e10944053
Ref: c-api/unicode c PyUnicode_DecodeMBCS10944413
Ref: 3d6f10944413
Ref: c-api/unicode c PyUnicode_DecodeMBCSStateful10944712
Ref: 3d7010944712
Ref: c-api/unicode c PyUnicode_AsMBCSString10945177
Ref: b0010945177
Ref: c-api/unicode c PyUnicode_EncodeCodePage10945468
Ref: b0110945468
Ref: c-api/unicode c PyUnicode_EncodeMBCS10945866
Ref: aff10945866
Node: Methods & Slots10946478
Ref: c-api/unicode methods-slots10946577
Ref: 3d7110946577
Node: Methods and Slot Functions10946628
Ref: c-api/unicode methods-and-slot-functions10946741
Ref: 3d7210946741
Ref: c-api/unicode unicodemethodsandslots10946741
Ref: 3d7310946741
Ref: c-api/unicode c PyUnicode_Concat10947064
Ref: b1010947064
Ref: c-api/unicode c PyUnicode_Split10947242
Ref: 3d7410947242
Ref: c-api/unicode c PyUnicode_Splitlines10947707
Ref: 3d7510947707
Ref: c-api/unicode c PyUnicode_Join10948800
Ref: b1110948800
Ref: c-api/unicode c PyUnicode_Tailmatch10949027
Ref: aef10949027
Ref: c-api/unicode c PyUnicode_Find10949428
Ref: 3d7610949428
Ref: c-api/unicode c PyUnicode_FindChar10949976
Ref: 43510949976
Ref: c-api/unicode c PyUnicode_Count10950655
Ref: 3d7710950655
Ref: c-api/unicode c PyUnicode_Replace10950913
Ref: 3d7810950913
Ref: c-api/unicode c PyUnicode_Compare10951265
Ref: aee10951265
Ref: c-api/unicode c PyUnicode_CompareWithASCIIString10951587
Ref: bf110951587
Ref: c-api/unicode c PyUnicode_RichCompare10952043
Ref: 3d7910952043
Ref: c-api/unicode c PyUnicode_Format10952573
Ref: 3d7a10952573
Ref: c-api/unicode c PyUnicode_Contains10952799
Ref: 3d7b10952799
Ref: c-api/unicode c PyUnicode_InternInPlace10953104
Ref: 3d7c10953104
Ref: c-api/unicode c PyUnicode_InternFromString10953879
Ref: 3d7d10953879
Node: Tuple Objects10954262
Ref: c-api/tuple doc10954395
Ref: 3d7e10954395
Ref: c-api/tuple tuple-objects10954395
Ref: 3d7f10954395
Ref: c-api/tuple tupleobjects10954395
Ref: 3d8010954395
Ref: c-api/tuple c PyTupleObject10954442
Ref: 3b9810954442
Ref: c-api/tuple c PyTuple_Type10954551
Ref: 3d8110954551
Ref: c-api/tuple c PyTuple_Check10954750
Ref: 3d8210954750
Ref: c-api/tuple c PyTuple_CheckExact10954894
Ref: 3d8310954894
Ref: c-api/tuple c PyTuple_New10955049
Ref: 3d8410955049
Ref: c-api/tuple c PyTuple_Pack10955214
Ref: 3d8510955214
Ref: c-api/tuple c PyTuple_Size10955572
Ref: 3d8610955572
Ref: c-api/tuple c PyTuple_GET_SIZE10955707
Ref: 3d8710955707
Ref: c-api/tuple c PyTuple_GetItem10955894
Ref: 3a6010955894
Ref: c-api/tuple c PyTuple_GET_ITEM10956178
Ref: 3d8810956178
Ref: c-api/tuple c PyTuple_GetSlice10956374
Ref: 3d8910956374
Ref: c-api/tuple c PyTuple_SetItem10956746
Ref: 3a6510956746
Ref: c-api/tuple c PyTuple_SET_ITEM10957218
Ref: 3d8a10957218
Ref: c-api/tuple c _PyTuple_Resize10957702
Ref: e3e10957702
Ref: c-api/tuple c PyTuple_ClearFreeList10958617
Ref: 3d8b10958617
Node: Struct Sequence Objects10958731
Ref: c-api/tuple struct-sequence-objects10958850
Ref: 3d8c10958850
Ref: c-api/tuple c PyStructSequence_NewType10959158
Ref: 3d8d10959158
Ref: c-api/tuple c PyStructSequence_InitType10959471
Ref: 91b10959471
Ref: c-api/tuple c PyStructSequence_InitType210959649
Ref: 91a10959649
Ref: c-api/tuple c PyStructSequence_Desc10959895
Ref: 41e10959895
Ref: c-api/tuple c PyStructSequence_Field10961473
Ref: 41d10961473
Ref: c-api/tuple c PyStructSequence_UnnamedField10962574
Ref: 3d8f10962574
Ref: c-api/tuple c PyStructSequence_New10962685
Ref: 3d8e10962685
Ref: c-api/tuple c PyStructSequence_GetItem10962906
Ref: 3d9010962906
Ref: c-api/tuple c PyStructSequence_GET_ITEM10963162
Ref: 3d9110963162
Ref: c-api/tuple c PyStructSequence_SetItem10963362
Ref: 3d9210963362
Ref: c-api/tuple c PyStructSequence_SET_ITEM10963708
Ref: 3d9310963708
Node: List Objects10963940
Ref: c-api/list doc10964037
Ref: 3d9410964037
Ref: c-api/list list-objects10964037
Ref: 3d9510964037
Ref: c-api/list listobjects10964037
Ref: 3d9610964037
Ref: c-api/list c PyListObject10964082
Ref: 3c4810964082
Ref: c-api/list c PyList_Type10964189
Ref: 3a9510964189
Ref: c-api/list c PyList_Check10964388
Ref: 3d9710964388
Ref: c-api/list c PyList_CheckExact10964529
Ref: 3d9810964529
Ref: c-api/list c PyList_New10964681
Ref: 3af510964681
Ref: c-api/list c PyList_Size10965194
Ref: d7110965194
Ref: c-api/list c PyList_GET_SIZE10965366
Ref: 3d9910965366
Ref: c-api/list c PyList_GetItem10965497
Ref: 3a6110965497
Ref: c-api/list c PyList_GET_ITEM10965918
Ref: 3d9a10965918
Ref: c-api/list c PyList_SetItem10966107
Ref: 3a6610966107
Ref: c-api/list c PyList_SET_ITEM10966556
Ref: 3d9b10966556
Ref: c-api/list c PyList_Insert10967075
Ref: 3d9c10967075
Ref: c-api/list c PyList_Append10967384
Ref: 3d9d10967384
Ref: c-api/list c PyList_GetSlice10967643
Ref: 3d9e10967643
Ref: c-api/list c PyList_SetSlice10968039
Ref: 3d9f10968039
Ref: c-api/list c PyList_Sort10968506
Ref: 3da010968506
Ref: c-api/list c PyList_Reverse10968693
Ref: 3da110968693
Ref: c-api/list c PyList_AsTuple10968893
Ref: 3da210968893
Ref: c-api/list c PyList_ClearFreeList10969093
Ref: 3da310969093
Node: Container Objects10969232
Ref: c-api/concrete container-objects10969361
Ref: 3da410969361
Ref: c-api/concrete mapobjects10969361
Ref: 3da510969361
Node: Dictionary Objects10969459
Ref: c-api/dict doc10969551
Ref: 3da610969551
Ref: c-api/dict dictionary-objects10969551
Ref: 3da710969551
Ref: c-api/dict dictobjects10969551
Ref: 3da810969551
Ref: c-api/dict c PyDictObject10969606
Ref: 3da910969606
Ref: c-api/dict c PyDict_Type10969719
Ref: 3daa10969719
Ref: c-api/dict c PyDict_Check10969924
Ref: 3c9b10969924
Ref: c-api/dict c PyDict_CheckExact10970065
Ref: 3dab10970065
Ref: c-api/dict c PyDict_New10970217
Ref: 3dac10970217
Ref: c-api/dict c PyDictProxy_New10970357
Ref: 3dad10970357
Ref: c-api/dict c PyDict_Clear10970683
Ref: 3dae10970683
Ref: c-api/dict c PyDict_Contains10970791
Ref: 3daf10970791
Ref: c-api/dict c PyDict_Copy10971085
Ref: 3db010971085
Ref: c-api/dict c PyDict_SetItem10971251
Ref: 3a6710971251
Ref: c-api/dict c PyDict_SetItemString10971559
Ref: 3db110971559
Ref: c-api/dict c PyDict_DelItem10971894
Ref: 3db210971894
Ref: c-api/dict c PyDict_DelItemString10972150
Ref: 3db310972150
Ref: c-api/dict c PyDict_GetItem10972367
Ref: 3a6210972367
Ref: c-api/dict c PyDict_GetItemWithError10972855
Ref: 3db410972855
Ref: c-api/dict c PyDict_GetItemString10973222
Ref: 3a6310973222
Ref: c-api/dict c PyDict_SetDefault10973756
Ref: 3db510973756
Ref: c-api/dict c PyDict_Items10974346
Ref: 3db610974346
Ref: c-api/dict c PyDict_Keys10974523
Ref: 3db710974523
Ref: c-api/dict c PyDict_Values10974698
Ref: 3db810974698
Ref: c-api/dict c PyDict_Size10974881
Ref: 3db910974881
Ref: c-api/dict c PyDict_Next10975045
Ref: 3dba10975045
Ref: c-api/dict c PyDict_Merge10976750
Ref: 3dbb10976750
Ref: c-api/dict c PyDict_Update10977299
Ref: 3dbc10977299
Ref: c-api/dict c PyDict_MergeFromSeq210977719
Ref: 3dbd10977719
Ref: c-api/dict c PyDict_ClearFreeList10978371
Ref: 3dbe10978371
Node: Set Objects10978510
Ref: c-api/set doc10978602
Ref: 3dbf10978602
Ref: c-api/set set-objects10978602
Ref: 3dc010978602
Ref: c-api/set setobjects10978602
Ref: 3dc110978602
Ref: c-api/set c PySetObject10979383
Ref: 3dc210979383
Ref: c-api/set c PySet_Type10980014
Ref: 3dc310980014
Ref: c-api/set c PyFrozenSet_Type10980160
Ref: 3dc410980160
Ref: c-api/set c PySet_Check10980464
Ref: 3dc510980464
Ref: c-api/set c PyFrozenSet_Check10980598
Ref: 3dc610980598
Ref: c-api/set c PyAnySet_Check10980744
Ref: 3dc710980744
Ref: c-api/set c PyAnySet_CheckExact10980914
Ref: 3dc810980914
Ref: c-api/set c PyFrozenSet_CheckExact10981095
Ref: 3dc910981095
Ref: c-api/set c PySet_New10981251
Ref: d9e10981251
Ref: c-api/set c PyFrozenSet_New10981702
Ref: d9f10981702
Ref: c-api/set c PySet_Size10982238
Ref: da310982238
Ref: c-api/set c PySet_GET_SIZE10982545
Ref: 3dca10982545
Ref: c-api/set c PySet_Contains10982676
Ref: da210982676
Ref: c-api/set c PySet_Add10983185
Ref: da010983185
Ref: c-api/set c PySet_Discard10983935
Ref: da110983935
Ref: c-api/set c PySet_Pop10984494
Ref: 3dcb10984494
Ref: c-api/set c PySet_Clear10984879
Ref: 3dcc10984879
Ref: c-api/set c PySet_ClearFreeList10984973
Ref: 3dcd10984973
Node: Function Objects<2>10985111
Ref: c-api/concrete function-objects10985237
Ref: 3dce10985237
Ref: c-api/concrete otherobjects10985237
Ref: 3dcf10985237
Node: Function Objects<3>10985450
Ref: c-api/function doc10985557
Ref: 3dd010985557
Ref: c-api/function function-objects10985557
Ref: 3dd110985557
Ref: c-api/function id110985557
Ref: 3dd210985557
Ref: c-api/function c PyFunctionObject10985665
Ref: 3dd310985665
Ref: c-api/function c PyFunction_Type10985737
Ref: 3dd410985737
Ref: c-api/function c PyFunction_Check10985954
Ref: 3dd510985954
Ref: c-api/function c PyFunction_New10986137
Ref: 3dd610986137
Ref: c-api/function c PyFunction_NewWithQualName10986700
Ref: 3dd710986700
Ref: c-api/function c PyFunction_GetCode10987174
Ref: 3dd810987174
Ref: c-api/function c PyFunction_GetGlobals10987347
Ref: 3dd910987347
Ref: c-api/function c PyFunction_GetModule10987530
Ref: 3dda10987530
Ref: c-api/function c PyFunction_GetDefaults10987819
Ref: 3ddb10987819
Ref: c-api/function c PyFunction_SetDefaults10988049
Ref: 3ddc10988049
Ref: c-api/function c PyFunction_GetClosure10988326
Ref: 3ddd10988326
Ref: c-api/function c PyFunction_SetClosure10988555
Ref: 3dde10988555
Ref: c-api/function c PyFunction_GetAnnotations10988841
Ref: 3ddf10988841
Ref: c-api/function c PyFunction_SetAnnotations10989057
Ref: 3de010989057
Node: Instance Method Objects10989337
Ref: c-api/method doc10989470
Ref: 3de110989470
Ref: c-api/method instance-method-objects10989470
Ref: 3de210989470
Ref: c-api/method instancemethod-objects10989470
Ref: 3de310989470
Ref: c-api/method c PyInstanceMethod_Type10989735
Ref: 3de410989735
Ref: c-api/method c PyInstanceMethod_Check10989923
Ref: 3de510989923
Ref: c-api/method c PyInstanceMethod_New10990126
Ref: 3de610990126
Ref: c-api/method c PyInstanceMethod_Function10990392
Ref: 3de710990392
Ref: c-api/method c PyInstanceMethod_GET_FUNCTION10990576
Ref: 3de810990576
Node: Method Objects<2>10990782
Ref: c-api/method id110990908
Ref: 3de910990908
Ref: c-api/method method-objects10990908
Ref: 3dea10990908
Ref: c-api/method c PyMethod_Type10991134
Ref: 3deb10991134
Ref: c-api/method c PyMethod_Check10991334
Ref: 3dec10991334
Ref: c-api/method c PyMethod_New10991511
Ref: 3ded10991511
Ref: c-api/method c PyMethod_Function10991857
Ref: 3dee10991857
Ref: c-api/method c PyMethod_GET_FUNCTION10992028
Ref: 3def10992028
Ref: c-api/method c PyMethod_Self10992220
Ref: 3df010992220
Ref: c-api/method c PyMethod_GET_SELF10992380
Ref: 3df110992380
Ref: c-api/method c PyMethod_ClearFreeList10992564
Ref: 3df210992564
Node: Cell Objects10992679
Ref: c-api/cell doc10992797
Ref: 3df310992797
Ref: c-api/cell cell-objects10992797
Ref: 3df410992797
Ref: c-api/cell id110992797
Ref: 3df510992797
Ref: c-api/cell c PyCellObject10993442
Ref: 3df610993442
Ref: c-api/cell c PyCell_Type10993513
Ref: 3df710993513
Ref: c-api/cell c PyCell_Check10993608
Ref: 3df810993608
Ref: c-api/cell c PyCell_New10993720
Ref: 3df910993720
Ref: c-api/cell c PyCell_Get10993912
Ref: 3dfa10993912
Ref: c-api/cell c PyCell_GET10994049
Ref: 3dfb10994049
Ref: c-api/cell c PyCell_Set10994266
Ref: 3dfc10994266
Ref: c-api/cell c PyCell_SET10994627
Ref: 3dfd10994627
Ref: c-api/code codeobjects10994889
Ref: 3dfe10994889
Node: Code Objects<2>10994890
Ref: c-api/code doc10994982
Ref: 3dff10994982
Ref: c-api/code code-objects10994982
Ref: 3e0010994982
Ref: c-api/code c PyCodeObject10995187
Ref: 3e0110995187
Ref: c-api/code c PyCode_Type10995346
Ref: 3e0210995346
Ref: c-api/code c PyCode_Check10995493
Ref: 3e0310995493
Ref: c-api/code c PyCode_GetNumFree10995597
Ref: 3e0410995597
Ref: c-api/code c PyCode_New10995706
Ref: 27010995706
Ref: c-api/code c PyCode_NewWithPosOnlyArgs10996368
Ref: 26f10996368
Ref: c-api/code c PyCode_NewEmpty10996926
Ref: cdd10996926
Node: Other Objects10997281
Ref: c-api/concrete other-objects10997381
Ref: 3e0510997381
Node: File Objects10997787
Ref: c-api/file doc10997872
Ref: 3e0610997872
Ref: c-api/file file-objects10997872
Ref: 3e0710997872
Ref: c-api/file fileobjects10997872
Ref: 3e0810997872
Ref: c-api/file c PyFile_FromFd10998459
Ref: 3e0910998459
Ref: c-api/file c PyObject_AsFileDescriptor10999405
Ref: 3e0a10999405
Ref: c-api/file c PyFile_GetLine10999821
Ref: 3e0b10999821
Ref: c-api/file c PyFile_SetOpenCodeHook11000588
Ref: 1f2411000588
Ref: c-api/file c PyFile_WriteObject11001685
Ref: 3e0c11001685
Ref: c-api/file c PyFile_WriteString11002076
Ref: 3e0d11002076
Node: Module Objects11002283
Ref: c-api/module doc11002393
Ref: 3e0e11002393
Ref: c-api/module module-objects11002393
Ref: 3e0f11002393
Ref: c-api/module moduleobjects11002393
Ref: 3e1011002393
Ref: c-api/module c PyModule_Type11002440
Ref: 3e1111002440
Ref: c-api/module c PyModule_Check11002640
Ref: 3e1211002640
Ref: c-api/module c PyModule_CheckExact11002773
Ref: 3e1311002773
Ref: c-api/module c PyModule_NewObject11002926
Ref: 3e1411002926
Ref: c-api/module c PyModule_New11003525
Ref: 3e1511003525
Ref: c-api/module c PyModule_GetDict11003744
Ref: 3e1611003744
Ref: c-api/module c PyModule_GetNameObject11004333
Ref: 3e1711004333
Ref: c-api/module c PyModule_GetName11004653
Ref: 3e1811004653
Ref: c-api/module c PyModule_GetState11004824
Ref: 3e1911004824
Ref: c-api/module c PyModule_GetDef11005067
Ref: 3e1b11005067
Ref: c-api/module c PyModule_GetFilenameObject11005303
Ref: 3e1c11005303
Ref: c-api/module c PyModule_GetFilename11005737
Ref: 3e1d11005737
Node: Initializing C modules11006168
Ref: c-api/module initializing-c-modules11006263
Ref: 3e1e11006263
Ref: c-api/module initializing-modules11006263
Ref: 3ab911006263
Ref: c-api/module c PyModuleDef11006897
Ref: 3a8c11006897
Ref: c-api/module c PyModuleDef m_base11007119
Ref: 3e1f11007119
Ref: c-api/module c PyModuleDef m_name11007236
Ref: 3e2011007236
Ref: c-api/module c PyModuleDef m_doc11007311
Ref: 3e2111007311
Ref: c-api/module c PyModuleDef m_size11007468
Ref: 3e1a11007468
Ref: c-api/module c PyModuleDef m_methods11008412
Ref: 3e2211008412
Ref: c-api/module c PyModuleDef m_slots11008627
Ref: 3e2311008627
Ref: c-api/module c PyModuleDef m_reload11009004
Ref: 3e2411009004
Ref: c-api/module c PyModuleDef m_traverse11009051
Ref: 3e2511009051
Ref: c-api/module c PyModuleDef m_clear11009428
Ref: 3e2711009428
Ref: c-api/module c PyModuleDef m_free11009792
Ref: 3e2811009792
Ref: Initializing C modules-Footnote-111010322
Node: Single-phase initialization11010371
Ref: c-api/module single-phase-initialization11010492
Ref: 3e2911010492
Ref: c-api/module c PyModule_Create11010771
Ref: 3a4b11010771
Ref: c-api/module c PyModule_Create211011054
Ref: 3e2a11011054
Node: Multi-phase initialization11011755
Ref: c-api/module id111011920
Ref: 3e2b11011920
Ref: c-api/module multi-phase-initialization11011920
Ref: 3aba11011920
Ref: c-api/module c PyModuleDef_Init11013511
Ref: 3e2c11013511
Ref: c-api/module c PyModuleDef_Slot11013962
Ref: 3e2d11013962
Ref: c-api/module c PyModuleDef_Slot slot11013992
Ref: 3e2e11013992
Ref: c-api/module c PyModuleDef_Slot value11014093
Ref: 3e2f11014093
Ref: c-api/module c Py_mod_create11014311
Ref: 3e3011014311
Ref: c-api/module c create_module11014507
Ref: 3e3111014507
Ref: c-api/module c Py_mod_exec11015926
Ref: 3e2611015926
Ref: c-api/module c exec_module11016201
Ref: 3e3211016201
Ref: Multi-phase initialization-Footnote-111016488
Ref: Multi-phase initialization-Footnote-211016537
Node: Low-level module creation functions11016586
Ref: c-api/module low-level-module-creation-functions11016741
Ref: 3e3311016741
Ref: c-api/module c PyModule_FromDefAndSpec11017120
Ref: 79f11017120
Ref: c-api/module c PyModule_FromDefAndSpec211017500
Ref: 7a011017500
Ref: c-api/module c PyModule_ExecDef11018123
Ref: 7a111018123
Ref: c-api/module c PyModule_SetDocString11018316
Ref: 3e3411018316
Ref: c-api/module c PyModule_AddFunctions11018655
Ref: 3e3511018655
Node: Support functions11019347
Ref: c-api/module support-functions11019467
Ref: 3e3611019467
Ref: c-api/module c PyModule_AddObject11019753
Ref: eaf11019753
Ref: c-api/module c PyModule_AddIntConstant11020593
Ref: 3e3711020593
Ref: c-api/module c PyModule_AddStringConstant11020890
Ref: 3e3811020890
Ref: c-api/module c PyModule_AddIntMacro11021251
Ref: 3e3911021251
Ref: c-api/module c PyModule_AddStringMacro11021598
Ref: d4c11021598
Node: Module lookup11021710
Ref: c-api/module module-lookup11021805
Ref: 3e3a11021805
Ref: c-api/module c PyState_FindModule11022224
Ref: 3e3b11022224
Ref: c-api/module c PyState_AddModule11022708
Ref: 3e3c11022708
Ref: c-api/module c PyState_RemoveModule11023618
Ref: 3e3d11023618
Node: Iterator Objects11023828
Ref: c-api/iterator doc11023944
Ref: 3e3e11023944
Ref: c-api/iterator id111023944
Ref: 3e3f11023944
Ref: c-api/iterator iterator-objects11023944
Ref: 3e4011023944
Ref: c-api/iterator c PySeqIter_Type11024342
Ref: 3e4111024342
Ref: c-api/iterator c PySeqIter_Check11024576
Ref: 3e4311024576
Ref: c-api/iterator c PySeqIter_New11024687
Ref: 3e4211024687
Ref: c-api/iterator c PyCallIter_Type11024965
Ref: 3e4411024965
Ref: c-api/iterator c PyCallIter_Check11025173
Ref: 3e4611025173
Ref: c-api/iterator c PyCallIter_New11025286
Ref: 3e4511025286
Node: Descriptor Objects11025716
Ref: c-api/descriptor doc11025831
Ref: 3e4711025831
Ref: c-api/descriptor descriptor-objects11025831
Ref: 3e4811025831
Ref: c-api/descriptor id111025831
Ref: 3e4911025831
Ref: c-api/descriptor c PyProperty_Type11026012
Ref: 3e4a11026012
Ref: c-api/descriptor c PyDescr_NewGetSet11026115
Ref: 3e4b11026115
Ref: c-api/descriptor c PyDescr_NewMember11026255
Ref: 3e4c11026255
Ref: c-api/descriptor c PyDescr_NewMethod11026393
Ref: 3e4d11026393
Ref: c-api/descriptor c PyDescr_NewWrapper11026531
Ref: 3e4e11026531
Ref: c-api/descriptor c PyDescr_NewClassMethod11026688
Ref: 3e4f11026688
Ref: c-api/descriptor c PyDescr_IsData11026826
Ref: 3e5011026826
Ref: c-api/descriptor c PyWrapper_New11027071
Ref: 3e5111027071
Node: Slice Objects11027173
Ref: c-api/slice doc11027287
Ref: 3e5211027287
Ref: c-api/slice id111027287
Ref: 3e5311027287
Ref: c-api/slice slice-objects11027287
Ref: 3e5411027287
Ref: c-api/slice c PySlice_Type11027334
Ref: 3e5511027334
Ref: c-api/slice c PySlice_Check11027483
Ref: 3e5611027483
Ref: c-api/slice c PySlice_New11027607
Ref: 3e5711027607
Ref: c-api/slice c PySlice_GetIndices11028107
Ref: 3e5811028107
Ref: c-api/slice c PySlice_GetIndicesEx11028848
Ref: 46d11028848
Ref: c-api/slice c PySlice_Unpack11030732
Ref: 42411030732
Ref: c-api/slice c PySlice_AdjustIndices11031310
Ref: 42511031310
Node: Ellipsis Object11031750
Ref: c-api/slice ellipsis-object11031864
Ref: 3e5911031864
Ref: c-api/slice c Py_Ellipsis11031915
Ref: 3e5a11031915
Ref: c-api/memoryview memoryview-objects11032175
Ref: 3c6111032175
Node: MemoryView objects11032176
Ref: c-api/memoryview doc11032302
Ref: 3e5b11032302
Ref: c-api/memoryview id111032302
Ref: 3e5c11032302
Ref: c-api/memoryview c PyMemoryView_FromObject11032516
Ref: 3e5d11032516
Ref: c-api/memoryview c PyMemoryView_FromMemory11032890
Ref: abe11032890
Ref: c-api/memoryview c PyMemoryView_FromBuffer11033191
Ref: 3c6511033191
Ref: c-api/memoryview c PyMemoryView_GetContiguous11033469
Ref: 3e5e11033469
Ref: c-api/memoryview c PyMemoryView_Check11033961
Ref: 3e5f11033961
Ref: c-api/memoryview c PyMemoryView_GET_BUFFER11034160
Ref: 3e6011034160
Ref: c-api/memoryview c PyMemoryView_GET_BASE11034460
Ref: 3e6111034460
Node: Weak Reference Objects<2>11034829
Ref: c-api/weakref doc11034951
Ref: 3e6211034951
Ref: c-api/weakref weak-reference-objects11034951
Ref: 3e6311034951
Ref: c-api/weakref weakrefobjects11034951
Ref: 3e6411034951
Ref: c-api/weakref c PyWeakref_Check11035269
Ref: 3e6511035269
Ref: c-api/weakref c PyWeakref_CheckRef11035376
Ref: 3e6611035376
Ref: c-api/weakref c PyWeakref_CheckProxy11035470
Ref: 3e6711035470
Ref: c-api/weakref c PyWeakref_NewRef11035562
Ref: 3e6811035562
Ref: c-api/weakref c PyWeakref_NewProxy11036340
Ref: 3e6911036340
Ref: c-api/weakref c PyWeakref_GetObject11037126
Ref: 3e6a11037126
Ref: c-api/weakref c PyWeakref_GET_OBJECT11037632
Ref: 3e6b11037632
Node: Capsules<2>11037850
Ref: c-api/capsule doc11037971
Ref: 3e6c11037971
Ref: c-api/capsule capsules11037971
Ref: 3a7211037971
Ref: c-api/capsule id111037971
Ref: 3e6d11037971
Ref: c-api/capsule c PyCapsule11038138
Ref: bfa11038138
Ref: c-api/capsule c PyCapsule_Destructor11038582
Ref: 3e6e11038582
Ref: c-api/capsule c PyCapsule_CheckExact11038842
Ref: 3e6f11038842
Ref: c-api/capsule c PyCapsule_New11038959
Ref: 3a7011038959
Ref: c-api/capsule c PyCapsule_GetPointer11039872
Ref: 3e7011039872
Ref: c-api/capsule c PyCapsule_GetDestructor11040337
Ref: 3e7111040337
Ref: c-api/capsule c PyCapsule_GetContext11040769
Ref: 3e7211040769
Ref: c-api/capsule c PyCapsule_GetName11041167
Ref: 3e7311041167
Ref: c-api/capsule c PyCapsule_Import11041562
Ref: 3a7111041562
Ref: c-api/capsule c PyCapsule_IsValid11042242
Ref: ce311042242
Ref: c-api/capsule c PyCapsule_SetContext11043022
Ref: 3e7411043022
Ref: c-api/capsule c PyCapsule_SetDestructor11043257
Ref: 3e7511043257
Ref: c-api/capsule c PyCapsule_SetName11043511
Ref: 3e7611043511
Ref: c-api/capsule c PyCapsule_SetPointer11043894
Ref: 3e7711043894
Node: Generator Objects11044167
Ref: c-api/gen doc11044283
Ref: 3e7811044283
Ref: c-api/gen gen-objects11044283
Ref: 3e7911044283
Ref: c-api/gen generator-objects11044283
Ref: 3e7a11044283
Ref: c-api/gen c PyGenObject11044583
Ref: 3e7d11044583
Ref: c-api/gen c PyGen_Type11044658
Ref: 3e7e11044658
Ref: c-api/gen c PyGen_Check11044757
Ref: 3e7f11044757
Ref: c-api/gen c PyGen_CheckExact11044883
Ref: 3e8011044883
Ref: c-api/gen c PyGen_New11045033
Ref: 3e7b11045033
Ref: c-api/gen c PyGen_NewWithQualName11045300
Ref: 3e7c11045300
Node: Coroutine Objects<2>11045716
Ref: c-api/coro doc11045846
Ref: 3e8111045846
Ref: c-api/coro coro-objects11045846
Ref: 7c111045846
Ref: c-api/coro coroutine-objects11045846
Ref: 3e8211045846
Ref: c-api/coro c PyCoroObject11046005
Ref: 3e8311046005
Ref: c-api/coro c PyCoro_Type11046081
Ref: 3e8411046081
Ref: c-api/coro c PyCoro_CheckExact11046181
Ref: 3e8511046181
Ref: c-api/coro c PyCoro_New11046333
Ref: 3e8611046333
Node: Context Variables Objects11046738
Ref: c-api/contextvars doc11046870
Ref: 3e8711046870
Ref: c-api/contextvars context-variables-objects11046870
Ref: 3e8811046870
Ref: c-api/contextvars contextvarsobjects11046870
Ref: 33011046870
Ref: c-api/contextvars contextvarsobjects-pointertype-change11046941
Ref: 4af11046941
Ref: c-api/contextvars c PyContext11047449
Ref: 3e8911047449
Ref: c-api/contextvars c PyContextVar11047560
Ref: 3e8a11047560
Ref: c-api/contextvars c PyContextToken11047677
Ref: 3e8b11047677
Ref: c-api/contextvars c PyContext_Type11047779
Ref: 3e8c11047779
Ref: c-api/contextvars c PyContextVar_Type11047879
Ref: 3e8d11047879
Ref: c-api/contextvars c PyContextToken_Type11047991
Ref: 3e8e11047991
Ref: c-api/contextvars c PyContext_CheckExact11048131
Ref: 3e8f11048131
Ref: c-api/contextvars c PyContextVar_CheckExact11048317
Ref: 3e9011048317
Ref: c-api/contextvars c PyContextToken_CheckExact11048509
Ref: 3e9111048509
Ref: c-api/contextvars c PyContext_New11048743
Ref: 3e9211048743
Ref: c-api/contextvars c PyContext_Copy11048913
Ref: 3e9311048913
Ref: c-api/contextvars c PyContext_CopyCurrent11049117
Ref: 3e9411049117
Ref: c-api/contextvars c PyContext_Enter11049314
Ref: 3e9511049314
Ref: c-api/contextvars c PyContext_Exit11049487
Ref: 3e9611049487
Ref: c-api/contextvars c PyContext_ClearFreeList11049716
Ref: 3e9711049716
Ref: c-api/contextvars c PyContextVar_New11049915
Ref: 3e9811049915
Ref: c-api/contextvars c PyContextVar_Get11050313
Ref: 3e9911050313
Ref: c-api/contextvars c PyContextVar_Set11050952
Ref: 3e9a11050952
Ref: c-api/contextvars c PyContextVar_Reset11051237
Ref: 3e9b11051237
Ref: Context Variables Objects-Footnote-111051573
Node: DateTime Objects<2>11051616
Ref: c-api/datetime doc11051719
Ref: 3e9c11051719
Ref: c-api/datetime datetime-objects11051719
Ref: 3e9d11051719
Ref: c-api/datetime datetimeobjects11051719
Ref: 3e9e11051719
Ref: c-api/datetime c PyDateTime_TimeZone_UTC11052282
Ref: 42b11052282
Ref: c-api/datetime c PyDate_Check11052494
Ref: 3e9f11052494
Ref: c-api/datetime c PyDate_CheckExact11052684
Ref: 3ea011052684
Ref: c-api/datetime c PyDateTime_Check11052837
Ref: 3ea111052837
Ref: c-api/datetime c PyDateTime_CheckExact11053039
Ref: 3ea211053039
Ref: c-api/datetime c PyTime_Check11053200
Ref: 3ea311053200
Ref: c-api/datetime c PyTime_CheckExact11053390
Ref: 3ea411053390
Ref: c-api/datetime c PyDelta_Check11053543
Ref: 3ea511053543
Ref: c-api/datetime c PyDelta_CheckExact11053736
Ref: 3ea611053736
Ref: c-api/datetime c PyTZInfo_Check11053891
Ref: 3ea711053891
Ref: c-api/datetime c PyTZInfo_CheckExact11054087
Ref: 3ea811054087
Ref: c-api/datetime c PyDate_FromDate11054271
Ref: 3ea911054271
Ref: c-api/datetime c PyDateTime_FromDateAndTime11054469
Ref: 3eaa11054469
Ref: c-api/datetime c PyDateTime_FromDateAndTimeAndFold11054789
Ref: 3eab11054789
Ref: c-api/datetime c PyTime_FromTime11055158
Ref: 3eac11055158
Ref: c-api/datetime c PyTime_FromTimeAndFold11055400
Ref: 3ead11055400
Ref: c-api/datetime c PyDelta_FromDSU11055696
Ref: 3eae11055696
Ref: c-api/datetime c PyTimeZone_FromOffset11056114
Ref: 42911056114
Ref: c-api/datetime c PyTimeZone_FromOffsetAndName11056390
Ref: 42a11056390
Ref: c-api/datetime c PyDateTime_GET_YEAR11056934
Ref: 3eaf11056934
Ref: c-api/datetime c PyDateTime_GET_MONTH11057038
Ref: 3eb011057038
Ref: c-api/datetime c PyDateTime_GET_DAY11057154
Ref: 3eb111057154
Ref: c-api/datetime c PyDateTime_DATE_GET_HOUR11057468
Ref: 3eb211057468
Ref: c-api/datetime c PyDateTime_DATE_GET_MINUTE11057591
Ref: 3eb311057591
Ref: c-api/datetime c PyDateTime_DATE_GET_SECOND11057718
Ref: 3eb411057718
Ref: c-api/datetime c PyDateTime_DATE_GET_MICROSECOND11057845
Ref: 3eb511057845
Ref: c-api/datetime c PyDateTime_TIME_GET_HOUR11058190
Ref: 3eb611058190
Ref: c-api/datetime c PyDateTime_TIME_GET_MINUTE11058309
Ref: 3eb711058309
Ref: c-api/datetime c PyDateTime_TIME_GET_SECOND11058432
Ref: 3eb811058432
Ref: c-api/datetime c PyDateTime_TIME_GET_MICROSECOND11058555
Ref: 3eb911058555
Ref: c-api/datetime c PyDateTime_DELTA_GET_DAYS11058893
Ref: 3eba11058893
Ref: c-api/datetime c PyDateTime_DELTA_GET_SECONDS11059061
Ref: 3ebb11059061
Ref: c-api/datetime c PyDateTime_DELTA_GET_MICROSECONDS11059227
Ref: 3ebc11059227
Ref: c-api/datetime c PyDateTime_FromTimestamp11059478
Ref: 3ebd11059478
Ref: c-api/datetime c PyDate_FromTimestamp11059749
Ref: f1f11059749
Node: Initialization Finalization and Threads11060009
Ref: c-api/init doc11060189
Ref: 3ebe11060189
Ref: c-api/init initialization11060189
Ref: 3ebf11060189
Ref: c-api/init initialization-finalization-and-threads11060189
Ref: 3ec011060189
Node: Before Python Initialization11060691
Ref: c-api/init before-python-initialization11060834
Ref: 3ec111060834
Ref: c-api/init pre-init-safe11060834
Ref: 42f11060834
Node: Global configuration variables11062834
Ref: c-api/init global-conf-vars11063029
Ref: 3ec211063029
Ref: c-api/init global-configuration-variables11063029
Ref: 3ecc11063029
Ref: c-api/init c Py_BytesWarningFlag11063501
Ref: 4aa11063501
Ref: c-api/init c Py_DebugFlag11063779
Ref: 3ecd11063779
Ref: c-api/init c Py_DontWriteBytecodeFlag11064005
Ref: 3ece11064005
Ref: c-api/init c Py_FrozenFlag11064266
Ref: 3ecf11064266
Ref: c-api/init c Py_HashRandomizationFlag11064483
Ref: 3ed011064483
Ref: c-api/init c Py_IgnoreEnvironmentFlag11064765
Ref: 4ae11064765
Ref: c-api/init c Py_InspectFlag11065001
Ref: 3ed111065001
Ref: c-api/init c Py_InteractiveFlag11065367
Ref: 3b8311065367
Ref: c-api/init c Py_IsolatedFlag11065443
Ref: 3ed211065443
Ref: c-api/init c Py_LegacyWindowsFSEncodingFlag11065710
Ref: 3b8811065710
Ref: c-api/init c Py_LegacyWindowsStdioFlag11066088
Ref: 3ed311066088
Ref: c-api/init c Py_NoSiteFlag11066466
Ref: 3ed411066466
Ref: c-api/init c Py_NoUserSiteDirectory11066838
Ref: 3ed511066838
Ref: c-api/init c Py_OptimizeFlag11067095
Ref: 223911067095
Ref: c-api/init c Py_QuietFlag11067230
Ref: 3ed611067230
Ref: c-api/init c Py_UnbufferedStdioFlag11067415
Ref: 3ed711067415
Ref: c-api/init c Py_VerboseFlag11067620
Ref: 3ed811067620
Ref: Global configuration variables-Footnote-111068105
Ref: Global configuration variables-Footnote-211068154
Node: Initializing and finalizing the interpreter11068203
Ref: c-api/init initializing-and-finalizing-the-interpreter11068393
Ref: 3ed911068393
Ref: c-api/init c Py_Initialize11068494
Ref: 42e11068494
Ref: c-api/init c Py_InitializeEx11069465
Ref: 3eda11069465
Ref: c-api/init c Py_IsInitialized11069744
Ref: 3b0111069744
Ref: c-api/init c Py_FinalizeEx11070015
Ref: 5be11070015
Ref: c-api/init c Py_Finalize11072151
Ref: ce011072151
Node: Process-wide parameters11072303
Ref: c-api/init process-wide-parameters11072507
Ref: 3edc11072507
Ref: c-api/init c Py_SetStandardStreamEncoding11072568
Ref: 91911072568
Ref: c-api/init c Py_SetProgramName11073689
Ref: eba11073689
Ref: c-api/init c Py_GetProgramName11074603
Ref: 27411074603
Ref: c-api/init c Py_GetPrefix11074834
Ref: 3aff11074834
Ref: c-api/init c Py_GetExecPrefix11075607
Ref: 3b0011075607
Ref: c-api/init c Py_GetProgramFullPath11077776
Ref: 27311077776
Ref: c-api/init c Py_GetPath11078213
Ref: 3afe11078213
Ref: c-api/init c Py_SetPath11078923
Ref: 27111078923
Ref: c-api/init c Py_GetVersion11080143
Ref: 3eca11080143
Ref: c-api/init c Py_GetPlatform11080705
Ref: 3ec911080705
Ref: c-api/init c Py_GetCopyright11081298
Ref: 3ec811081298
Ref: c-api/init c Py_GetCompiler11081681
Ref: 3ec711081681
Ref: c-api/init c Py_GetBuildInfo11082064
Ref: d8d11082064
Ref: c-api/init c PySys_SetArgvEx11082474
Ref: bed11082474
Ref: c-api/init c PySys_SetArgv11084450
Ref: cdf11084450
Ref: c-api/init c Py_SetPythonHome11084874
Ref: eb911084874
Ref: c-api/init c Py_GetPythonHome11085472
Ref: 3ecb11085472
Ref: Process-wide parameters-Footnote-111085754
Node: Thread State and the Global Interpreter Lock11085823
Ref: c-api/init thread-state-and-the-global-interpreter-lock11086007
Ref: 3edd11086007
Ref: c-api/init threads11086007
Ref: 3ede11086007
Node: Releasing the GIL from extension code11087550
Ref: c-api/init releasing-the-gil-from-extension-code11087703
Ref: 3ee111087703
Node: Non-Python created threads11089533
Ref: c-api/init gilstate11089714
Ref: 3ee211089714
Ref: c-api/init non-python-created-threads11089714
Ref: 3ee311089714
Node: Cautions about fork11091442
Ref: c-api/init cautions-about-fork11091600
Ref: 3ee511091600
Ref: c-api/init fork-and-threads11091600
Ref: 3b8411091600
Node: High-level API11093539
Ref: c-api/init high-level-api11093684
Ref: 3ee611093684
Ref: c-api/init c PyInterpreterState11093858
Ref: 2c011093858
Ref: c-api/init c PyThreadState11094425
Ref: 3edf11094425
Ref: c-api/init c PyEval_InitThreads11094658
Ref: c0511094658
Ref: c-api/init c PyEval_ThreadsInitialized11095358
Ref: dcc11095358
Ref: c-api/init c PyEval_SaveThread11095756
Ref: c0411095756
Ref: c-api/init c PyEval_RestoreThread11096069
Ref: 2b211096069
Ref: c-api/init c PyThreadState_Get11096791
Ref: 3ee011096791
Ref: c-api/init c PyThreadState_Swap11097061
Ref: 3ee711097061
Ref: c-api/init c PyGILState_Ensure11097431
Ref: 2b411097431
Ref: c-api/init c PyGILState_Release11099160
Ref: 3ee411099160
Ref: c-api/init c PyGILState_GetThisThreadState11099648
Ref: 3ee811099648
Ref: c-api/init c PyGILState_Check11100037
Ref: 3ee911100037
Ref: c-api/init c Py_BEGIN_ALLOW_THREADS11100770
Ref: 3a6a11100770
Ref: c-api/init c Py_END_ALLOW_THREADS11101076
Ref: 2b311101076
Ref: c-api/init c Py_BLOCK_THREADS11101359
Ref: 3eea11101359
Ref: c-api/init c Py_UNBLOCK_THREADS11101544
Ref: 3eeb11101544
Node: Low-level API11101759
Ref: c-api/init low-level-api11101876
Ref: 3eec11101876
Ref: c-api/init c PyInterpreterState_New11102091
Ref: 340911102091
Ref: c-api/init c PyInterpreterState_Clear11102433
Ref: 340811102433
Ref: c-api/init c PyInterpreterState_Delete11102734
Ref: 3eed11102734
Ref: c-api/init c PyThreadState_New11103029
Ref: 3eee11103029
Ref: c-api/init c PyThreadState_Clear11103329
Ref: 3eef11103329
Ref: c-api/init c PyThreadState_Delete11103497
Ref: 3ef011103497
Ref: c-api/init c PyInterpreterState_GetID11103756
Ref: 43011103756
Ref: c-api/init c PyInterpreterState_GetDict11104005
Ref: 3ef111104005
Ref: c-api/init c PyThreadState_GetDict11104514
Ref: 3ef211104514
Ref: c-api/init c PyThreadState_SetAsyncExc11105015
Ref: 42c11105015
Ref: c-api/init c PyEval_AcquireThread11105810
Ref: 2b111105810
Ref: c-api/init c PyEval_ReleaseThread11106917
Ref: 3ef311106917
Ref: c-api/init c PyEval_AcquireLock11107486
Ref: 2b011107486
Ref: c-api/init c PyEval_ReleaseLock11108540
Ref: c0311108540
Node: Sub-interpreter support11108868
Ref: c-api/init id111109055
Ref: 3ef411109055
Ref: c-api/init sub-interpreter-support11109055
Ref: 3b8511109055
Ref: c-api/init c Py_NewInterpreter11109985
Ref: 3edb11109985
Ref: c-api/init c Py_EndInterpreter11112203
Ref: 3ef611112203
Node: Bugs and caveats11112872
Ref: c-api/init bugs-and-caveats11112948
Ref: 3ef711112948
Node: Asynchronous Notifications11114515
Ref: c-api/init asynchronous-notifications11114679
Ref: 3ef811114679
Ref: c-api/init c Py_AddPendingCall11114924
Ref: cdc11114924
Node: Profiling and Tracing11116583
Ref: c-api/init profiling11116749
Ref: 3ef911116749
Ref: c-api/init profiling-and-tracing11116749
Ref: 3efa11116749
Ref: c-api/init c Py_tracefunc11117428
Ref: 3efb11117428
Ref: c-api/init c PyTrace_CALL11119673
Ref: 3efc11119673
Ref: c-api/init c PyTrace_EXCEPTION11120063
Ref: 3efd11120063
Ref: c-api/init c PyTrace_LINE11120673
Ref: 3efe11120673
Ref: c-api/init c PyTrace_RETURN11120969
Ref: 3eff11120969
Ref: c-api/init c PyTrace_C_CALL11121122
Ref: 3f0011121122
Ref: c-api/init c PyTrace_C_EXCEPTION11121284
Ref: 3f0111121284
Ref: c-api/init c PyTrace_C_RETURN11121453
Ref: 3f0211121453
Ref: c-api/init c PyTrace_OPCODE11121608
Ref: 3f0311121608
Ref: c-api/init c PyEval_SetProfile11121942
Ref: e2e11121942
Ref: c-api/init c PyEval_SetTrace11122506
Ref: e2f11122506
Node: Advanced Debugger Support11123056
Ref: c-api/init advanced-debugger-support11123224
Ref: 3f0411123224
Ref: c-api/init advanced-debugging11123224
Ref: 3f0511123224
Ref: c-api/init c PyInterpreterState_Head11123364
Ref: e3211123364
Ref: c-api/init c PyInterpreterState_Main11123520
Ref: 3ef511123520
Ref: c-api/init c PyInterpreterState_Next11123632
Ref: e3311123632
Ref: c-api/init c PyInterpreterState_ThreadHead11123834
Ref: e3411123834
Ref: c-api/init c PyThreadState_Next11124078
Ref: e3511124078
Node: Thread Local Storage Support11124325
Ref: c-api/init thread-local-storage11124463
Ref: 3f0611124463
Ref: c-api/init thread-local-storage-support11124463
Ref: 3f0711124463
Node: Thread Specific Storage TSS API11125589
Ref: c-api/init thread-specific-storage-api11125722
Ref: 30c11125722
Ref: c-api/init thread-specific-storage-tss-api11125722
Ref: 3f0811125722
Ref: c-api/init c Py_tss_t11126112
Ref: 30d11126112
Ref: c-api/init c Py_tss_NEEDS_INIT11126552
Ref: 3f0911126552
Ref: Thread Specific Storage TSS API-Footnote-111126840
Node: Dynamic Allocation11126889
Ref: c-api/init dynamic-allocation11126994
Ref: 3f0a11126994
Ref: c-api/init c PyThread_tss_alloc11127275
Ref: 3f0b11127275
Ref: c-api/init c PyThread_tss_free11127495
Ref: 3f0c11127495
Node: Methods<4>11127917
Ref: c-api/init methods11128022
Ref: 3f0e11128022
Ref: c-api/init c PyThread_tss_is_created11128328
Ref: 3f1211128328
Ref: c-api/init c PyThread_tss_create11128517
Ref: 3f1111128517
Ref: c-api/init c PyThread_tss_delete11128934
Ref: 3f0d11128934
Ref: c-api/init c PyThread_tss_set11129366
Ref: 3f0f11129366
Ref: c-api/init c PyThread_tss_get11129635
Ref: 3f1011129635
Node: Thread Local Storage TLS API11129872
Ref: c-api/init thread-local-storage-api11130005
Ref: 30b11130005
Ref: c-api/init thread-local-storage-tls-api11130005
Ref: 3f1311130005
Ref: c-api/init c PyThread_create_key11130629
Ref: 3f1411130629
Ref: c-api/init c PyThread_delete_key11130673
Ref: 3f1511130673
Ref: c-api/init c PyThread_set_key_value11130725
Ref: 96411130725
Ref: c-api/init c PyThread_get_key_value11130792
Ref: 3f1611130792
Ref: c-api/init c PyThread_delete_key_value11130848
Ref: 3f1711130848
Ref: c-api/init c PyThread_ReInitTLS11130906
Ref: 3f1811130906
Node: Python Initialization Configuration11130950
Ref: c-api/init_config doc11131125
Ref: 3f1911131125
Ref: c-api/init_config init-config11131125
Ref: 17d11131125
Ref: c-api/init_config python-initialization-configuration11131125
Ref: 3f1a11131125
Ref: Python Initialization Configuration-Footnote-111133090
Node: PyWideStringList11133139
Ref: c-api/init_config pywidestringlist11133244
Ref: 3f1c11133244
Ref: c-api/init_config c PyWideStringList11133293
Ref: 16211133293
Ref: c-api/init_config c PyWideStringList_Append11133483
Ref: 17411133483
Ref: c-api/init_config c PyWideStringList_Insert11133699
Ref: 17511133699
Ref: c-api/init_config c PyWideStringList length11134140
Ref: 3f1d11134140
Ref: c-api/init_config c PyWideStringList items11134202
Ref: 3f1e11134202
Node: PyStatus11134261
Ref: c-api/init_config pystatus11134386
Ref: 3f1f11134386
Ref: c-api/init_config c PyStatus11134419
Ref: 16111134419
Ref: c-api/init_config c PyStatus exitcode11134637
Ref: 3f2011134637
Ref: c-api/init_config c PyStatus err_msg11134726
Ref: 3f2111134726
Ref: c-api/init_config c PyStatus func11134792
Ref: 3f2211134792
Ref: c-api/init_config c PyStatus_Ok11134940
Ref: 17311134940
Ref: c-api/init_config c PyStatus_Error11135010
Ref: 16d11135010
Ref: c-api/init_config c PyStatus_NoMemory11135126
Ref: 17211135126
Ref: c-api/init_config c PyStatus_Exit11135236
Ref: 16f11135236
Ref: c-api/init_config c PyStatus_Exception11135385
Ref: 16e11135385
Ref: c-api/init_config c PyStatus_IsError11135616
Ref: 17011135616
Ref: c-api/init_config c PyStatus_IsExit11135712
Ref: 17111135712
Ref: c-api/init_config c Py_ExitStatusException11135806
Ref: 17711135806
Node: PyPreConfig11136662
Ref: c-api/init_config pypreconfig11136805
Ref: 3f2311136805
Ref: c-api/init_config c PyPreConfig11136844
Ref: 16011136844
Ref: c-api/init_config c PyPreConfig_InitIsolatedConfig11137078
Ref: 16b11137078
Ref: c-api/init_config c PyPreConfig_InitPythonConfig11137268
Ref: 16c11137268
Ref: c-api/init_config c PyPreConfig allocator11137482
Ref: 3f2611137482
Ref: c-api/init_config c PyPreConfig configure_locale11138579
Ref: 3f2811138579
Ref: c-api/init_config c PyPreConfig coerce_c_locale11138785
Ref: 3f2911138785
Ref: c-api/init_config c PyPreConfig coerce_c_locale_warn11138959
Ref: 3f2a11138959
Ref: c-api/init_config c PyPreConfig dev_mode11139071
Ref: 3f2b11139071
Ref: c-api/init_config c PyPreConfig isolated11139150
Ref: 3f2d11139150
Ref: c-api/init_config c PyPreConfig legacy_windows_fs_encoding11139229
Ref: 3f2f11139229
Ref: c-api/init_config c PyPreConfig parse_argv11139578
Ref: 3f3011139578
Ref: c-api/init_config c PyPreConfig use_environment11139888
Ref: 3f3111139888
Ref: c-api/init_config c PyPreConfig utf8_mode11139981
Ref: 3f3311139981
Node: Preinitialization with PyPreConfig11140062
Ref: c-api/init_config preinitialization-with-pypreconfig11140205
Ref: 3f3411140205
Ref: c-api/init_config c Py_PreInitialize11140326
Ref: 17911140326
Ref: c-api/init_config c Py_PreInitializeFromBytesArgs11140462
Ref: 17b11140462
Ref: c-api/init_config c Py_PreInitializeFromArgs11140699
Ref: 17a11140699
Node: PyConfig11142415
Ref: c-api/init_config pyconfig11142575
Ref: 3f3511142575
Ref: c-api/init_config c PyConfig11142608
Ref: 15f11142608
Ref: c-api/init_config c PyConfig_InitPythonConfig11142719
Ref: 16511142719
Ref: c-api/init_config c PyConfig_InitIsolatedConfig11142876
Ref: 16411142876
Ref: c-api/init_config c PyConfig_SetString11143037
Ref: 16a11143037
Ref: c-api/init_config c PyConfig_SetBytesString11143285
Ref: 16911143285
Ref: c-api/init_config c PyConfig_SetArgv11143570
Ref: 16711143570
Ref: c-api/init_config c PyConfig_SetBytesArgv11143795
Ref: 16811143795
Ref: c-api/init_config c PyConfig_SetWideStringList11144053
Ref: 3f1b11144053
Ref: c-api/init_config c PyConfig_Read11144335
Ref: 16611144335
Ref: c-api/init_config c PyConfig_Clear11144552
Ref: 16311144552
Ref: c-api/init_config c PyConfig argv11145598
Ref: 3f3711145598
Ref: c-api/init_config c PyConfig base_exec_prefix11145989
Ref: 3f3811145989
Ref: c-api/init_config c PyConfig base_executable11146080
Ref: 3f3911146080
Ref: c-api/init_config c PyConfig base_prefix11146272
Ref: 3f3b11146272
Ref: c-api/init_config c PyConfig buffered_stdio11146353
Ref: 3f3c11146353
Ref: c-api/init_config c PyConfig bytes_warning11146554
Ref: 3f3d11146554
Ref: c-api/init_config c PyConfig check_hash_pycs_mode11146867
Ref: 3f3e11146867
Ref: c-api/init_config c PyConfig configure_c_stdio11147212
Ref: 3f3f11147212
Ref: c-api/init_config c PyConfig dev_mode11147429
Ref: 3f2c11147429
Ref: c-api/init_config c PyConfig dump_refs11147514
Ref: 3f4011147514
Ref: c-api/init_config c PyConfig exec_prefix11147717
Ref: 3f4111147717
Ref: c-api/init_config c PyConfig executable11147798
Ref: 3f3a11147798
Ref: c-api/init_config c PyConfig faulthandler11147876
Ref: 3f4211147876
Ref: c-api/init_config c PyConfig filesystem_encoding11147998
Ref: 3f4311147998
Ref: c-api/init_config c PyConfig filesystem_errors11148119
Ref: 3f4411148119
Ref: c-api/init_config c PyConfig hash_seed11148259
Ref: 3f4511148259
Ref: c-api/init_config c PyConfig use_hash_seed11148303
Ref: 3f4611148303
Ref: c-api/init_config c PyConfig home11148536
Ref: 3f4711148536
Ref: c-api/init_config c PyConfig import_time11148704
Ref: 3f4811148704
Ref: c-api/init_config c PyConfig inspect11148785
Ref: 3f4911148785
Ref: c-api/init_config c PyConfig install_signal_handlers11148890
Ref: 3f4a11148890
Ref: c-api/init_config c PyConfig interactive11148974
Ref: 3f4b11148974
Ref: c-api/init_config c PyConfig isolated11149039
Ref: 3f2e11149039
Ref: c-api/init_config c PyConfig legacy_windows_stdio11149583
Ref: 3f4d11149583
Ref: c-api/init_config c PyConfig malloc_stats11149929
Ref: 3f4e11149929
Ref: c-api/init_config c PyConfig pythonpath_env11150167
Ref: 3f4f11150167
Ref: c-api/init_config c PyConfig module_search_paths11150414
Ref: 3f5011150414
Ref: c-api/init_config c PyConfig module_search_paths_set11150471
Ref: 3f5111150471
Ref: c-api/init_config c PyConfig optimization_level11150752
Ref: 3f5311150752
Ref: c-api/init_config c PyConfig parse_argv11151028
Ref: 3f3611151028
Ref: c-api/init_config c PyConfig parser_debug11151277
Ref: 3f5411151277
Ref: c-api/init_config c PyConfig pathconfig_warnings11151433
Ref: 3f5511151433
Ref: c-api/init_config c PyConfig prefix11151693
Ref: 3f5611151693
Ref: c-api/init_config c PyConfig program_name11151764
Ref: 3f5711151764
Ref: c-api/init_config c PyConfig pycache_prefix11151914
Ref: 3f5811151914
Ref: c-api/init_config c PyConfig quiet11152105
Ref: 3f5911152105
Ref: c-api/init_config c PyConfig run_command11152254
Ref: 3f5a11152254
Ref: c-api/init_config c PyConfig run_filename11152385
Ref: 3f5b11152385
Ref: c-api/init_config c PyConfig run_module11152505
Ref: 3f5c11152505
Ref: c-api/init_config c PyConfig show_alloc_count11152634
Ref: 3f5d11152634
Ref: c-api/init_config c PyConfig show_ref_count11152870
Ref: 3f5e11152870
Ref: c-api/init_config c PyConfig site_import11153122
Ref: 3f5f11153122
Ref: c-api/init_config c PyConfig skip_source_first_line11153215
Ref: 3f6011153215
Ref: c-api/init_config c PyConfig stdio_encoding11153308
Ref: 3f6111153308
Ref: c-api/init_config c PyConfig stdio_errors11153352
Ref: 3f6211153352
Ref: c-api/init_config c PyConfig tracemalloc11153519
Ref: 3f6311153519
Ref: c-api/init_config c PyConfig use_environment11153629
Ref: 3f3211153629
Ref: c-api/init_config c PyConfig user_site_directory11153738
Ref: 3f4c11153738
Ref: c-api/init_config c PyConfig verbose11153854
Ref: 3f6411153854
Ref: c-api/init_config c PyConfig warnoptions11153931
Ref: 3f6511153931
Ref: c-api/init_config c PyConfig write_bytecode11154406
Ref: 3f6611154406
Ref: c-api/init_config c PyConfig xoptions11154619
Ref: 3f6711154619
Ref: PyConfig-Footnote-111155046
Node: Initialization with PyConfig11155095
Ref: c-api/init_config initialization-with-pyconfig11155243
Ref: 3f6811155243
Ref: c-api/init_config c Py_InitializeFromConfig11155348
Ref: 17811155348
Node: Isolated Configuration11157791
Ref: c-api/init_config init-isolated-conf11157951
Ref: 3f2511157951
Ref: c-api/init_config isolated-configuration11157951
Ref: 3f6911157951
Node: Python Configuration11158746
Ref: c-api/init_config init-python-config11158896
Ref: 3f2411158896
Ref: c-api/init_config python-configuration11158896
Ref: 3f6a11158896
Ref: Python Configuration-Footnote-111160342
Ref: Python Configuration-Footnote-211160391
Node: Path Configuration11160440
Ref: c-api/init_config init-path-config11160578
Ref: 3f5211160578
Ref: c-api/init_config path-configuration11160578
Ref: 3f6b11160578
Node: Py_RunMain11164010
Ref: c-api/init_config py-runmain11164178
Ref: 3f6c11164178
Ref: c-api/init_config c Py_RunMain11164221
Ref: 17c11164221
Node: Multi-Phase Initialization Private Provisional API11164815
Ref: c-api/init_config multi-phase-initialization-private-provisional-api11164956
Ref: 3f6d11164956
Ref: c-api/init_config c _Py_InitializeMain11166153
Ref: 3f6e11166153
Ref: Multi-Phase Initialization Private Provisional API-Footnote-111168042
Ref: Multi-Phase Initialization Private Provisional API-Footnote-211168091
Node: Memory Management11168140
Ref: c-api/memory doc11168305
Ref: 3f6f11168305
Ref: c-api/memory memory11168305
Ref: 3f2711168305
Ref: c-api/memory memory-management11168305
Ref: 3f7011168305
Node: Overview<3>11168592
Ref: c-api/memory memoryoverview11168686
Ref: 3f7111168686
Ref: c-api/memory overview11168686
Ref: 3f7211168686
Node: Raw Memory Interface11172567
Ref: c-api/memory raw-memory-interface11172686
Ref: 3f7311172686
Ref: c-api/memory c PyMem_RawMalloc11173127
Ref: 96111173127
Ref: c-api/memory c PyMem_RawCalloc11173515
Ref: 79911173515
Ref: c-api/memory c PyMem_RawRealloc11174016
Ref: 96211174016
Ref: c-api/memory c PyMem_RawFree11174765
Ref: 3b8911174765
Node: Memory Interface11175171
Ref: c-api/memory memory-interface11175296
Ref: 3f7411175296
Ref: c-api/memory memoryinterface11175296
Ref: 3f7511175296
Ref: c-api/memory c PyMem_Malloc11175802
Ref: 4fa11175802
Ref: c-api/memory c PyMem_Calloc11176184
Ref: 79a11176184
Ref: c-api/memory c PyMem_Realloc11176679
Ref: 96311176679
Ref: c-api/memory c PyMem_Free11177410
Ref: d9c11177410
Ref: c-api/memory c PyMem_New11177908
Ref: 3f7611177908
Ref: c-api/memory c PyMem_Resize11178159
Ref: 3f7711178159
Ref: c-api/memory c PyMem_Del11178627
Ref: 3f7811178627
Node: Object allocators11179203
Ref: c-api/memory object-allocators11179333
Ref: 3f7911179333
Ref: c-api/memory c PyObject_Malloc11179744
Ref: 4fd11179744
Ref: c-api/memory c PyObject_Calloc11180132
Ref: 79b11180132
Ref: c-api/memory c PyObject_Realloc11180633
Ref: d9d11180633
Ref: c-api/memory c PyObject_Free11181382
Ref: 4f911181382
Node: Default Memory Allocators11181788
Ref: c-api/memory default-memory-allocators11181929
Ref: 129811181929
Ref: c-api/memory id111181929
Ref: 3f7a11181929
Node: Customize Memory Allocators11184225
Ref: c-api/memory customize-memory-allocators11184371
Ref: 3f7b11184371
Ref: c-api/memory c PyMemAllocatorEx11184463
Ref: 7be11184463
Ref: c-api/memory c PyMemAllocatorDomain11186283
Ref: 3f7c11186283
Ref: c-api/memory c PYMEM_DOMAIN_RAW11186376
Ref: 129911186376
Ref: c-api/memory c PYMEM_DOMAIN_MEM11186621
Ref: 4fe11186621
Ref: c-api/memory c PYMEM_DOMAIN_OBJ11186853
Ref: 4fc11186853
Ref: c-api/memory c PyMem_GetAllocator11187097
Ref: 3ec511187097
Ref: c-api/memory c PyMem_SetAllocator11187269
Ref: 3ec311187269
Ref: c-api/memory c PyMem_SetupDebugHooks11187916
Ref: 4ff11187916
Node: The pymalloc allocator11190052
Ref: c-api/memory pymalloc11190190
Ref: 5b611190190
Ref: c-api/memory the-pymalloc-allocator11190190
Ref: 3f7d11190190
Node: Customize pymalloc Arena Allocator11191026
Ref: c-api/memory customize-pymalloc-arena-allocator11191119
Ref: 3f7e11191119
Ref: c-api/memory c PyObjectArenaAllocator11191229
Ref: 3f7f11191229
Ref: c-api/memory c PyObject_GetArenaAllocator11192233
Ref: 3ec611192233
Ref: c-api/memory c PyObject_SetArenaAllocator11192354
Ref: 3ec411192354
Node: tracemalloc C API11192475
Ref: c-api/memory tracemalloc-c-api11192598
Ref: 3f8011192598
Node: Examples<34>11192670
Ref: c-api/memory examples11192762
Ref: 3f8111192762
Ref: c-api/memory memoryexamples11192762
Ref: 3f8211192762
Node: Object Implementation Support11194575
Ref: c-api/objimpl doc11194727
Ref: 3f8311194727
Ref: c-api/objimpl newtypes11194727
Ref: 3f8411194727
Ref: c-api/objimpl object-implementation-support11194727
Ref: 3f8511194727
Node: Allocating Objects on the Heap11195236
Ref: c-api/allocation doc11195365
Ref: 3f8611195365
Ref: c-api/allocation allocating-objects11195365
Ref: 3f8711195365
Ref: c-api/allocation allocating-objects-on-the-heap11195365
Ref: 3f8811195365
Ref: c-api/allocation c _PyObject_New11195442
Ref: 3f8911195442
Ref: c-api/allocation c _PyObject_NewVar11195540
Ref: 3f8a11195540
Ref: c-api/allocation c PyObject_Init11195671
Ref: 26d11195671
Ref: c-api/allocation c PyObject_InitVar11196120
Ref: 3f8b11196120
Ref: c-api/allocation c PyObject_New11196411
Ref: 2d011196411
Ref: c-api/allocation c PyObject_NewVar11196856
Ref: 2d111196856
Ref: c-api/allocation c PyObject_Del11197583
Ref: e0911197583
Ref: c-api/allocation c _Py_NoneStruct11197974
Ref: 3f8c11197974
Node: Common Object Structures11198292
Ref: c-api/structures doc11198445
Ref: 3f8d11198445
Ref: c-api/structures common-object-structures11198445
Ref: 3f8e11198445
Ref: c-api/structures common-structs11198445
Ref: 3f8f11198445
Ref: c-api/structures c PyObject11199036
Ref: 4b011199036
Ref: c-api/structures c PyVarObject11199620
Ref: 3f9011199620
Ref: c-api/structures c PyObject_HEAD11200000
Ref: c6511200000
Ref: c-api/structures c PyObject_VAR_HEAD11200261
Ref: 3f9211200261
Ref: c-api/structures c Py_TYPE11200564
Ref: 3a7a11200564
Ref: c-api/structures c Py_REFCNT11200730
Ref: 3a7911200730
Ref: c-api/structures c Py_SIZE11200902
Ref: 3f9111200902
Ref: c-api/structures c PyObject_HEAD_INIT11201071
Ref: 3f9311201071
Ref: c-api/structures c PyVarObject_HEAD_INIT11201279
Ref: 3f9411201279
Ref: c-api/structures c PyCFunction11201546
Ref: dce11201546
Ref: c-api/structures c PyCFunctionWithKeywords11201985
Ref: 3f9511201985
Ref: c-api/structures c _PyCFunctionFast11202146
Ref: 3f9611202146
Ref: c-api/structures c _PyCFunctionFastWithKeywords11202290
Ref: 3f9711202290
Ref: c-api/structures c PyMethodDef11202457
Ref: e0e11202457
Ref: c-api/structures METH_VARARGS11204409
Ref: e3b11204409
Ref: c-api/structures METH_FASTCALL11205338
Ref: eea11205338
Ref: c-api/structures METH_NOARGS11206441
Ref: e0b11206441
Ref: c-api/structures METH_O11206840
Ref: e3a11206840
Ref: c-api/structures METH_CLASS11207429
Ref: e0c11207429
Ref: c-api/structures METH_STATIC11207702
Ref: e0d11207702
Ref: c-api/structures METH_COEXIST11208087
Ref: 3f9811208087
Ref: c-api/structures c PyMemberDef11208753
Ref: 41b11208753
Ref: c-api/structures c PyGetSetDef11212878
Ref: 41c11212878
Node: Type Objects<3>11215012
Ref: c-api/typeobj doc11215159
Ref: 3f9911215159
Ref: c-api/typeobj type-objects11215159
Ref: 3f9a11215159
Ref: c-api/typeobj type-structs11215159
Ref: 3a7b11215159
Node: Quick Reference11216388
Ref: c-api/typeobj quick-reference11216487
Ref: 3f9c11216487
Node: “tp slots”11216599
Ref: c-api/typeobj tp-slots11216683
Ref: 3f9d11216683
Ref: c-api/typeobj tp-slots-table11216683
Ref: 3f9e11216683
Ref: “tp slots”-Footnote-111229879
Ref: “tp slots”-Footnote-211230148
Node: sub-slots11230907
Ref: c-api/typeobj id311231013
Ref: 3fc511231013
Ref: c-api/typeobj sub-slots11231013
Ref: 3fa411231013
Node: slot typedefs11241198
Ref: c-api/typeobj slot-typedefs11241281
Ref: 3fff11241281
Ref: c-api/typeobj slot-typedefs-table11241281
Ref: 3f9f11241281
Node: PyTypeObject Definition11249081
Ref: c-api/typeobj pytypeobject-definition11249203
Ref: 400211249203
Node: PyObject Slots11251723
Ref: c-api/typeobj pyobject-slots11251847
Ref: 400311251847
Ref: c-api/typeobj c PyObject _ob_next11252269
Ref: 400411252269
Ref: c-api/typeobj c PyObject _ob_prev11252311
Ref: 400511252311
Ref: c-api/typeobj c PyObject ob_refcnt11253061
Ref: 400611253061
Ref: c-api/typeobj c PyObject ob_type11253554
Ref: 400711253554
Node: PyVarObject Slots11254641
Ref: c-api/typeobj pyvarobject-slots11254760
Ref: 400811254760
Ref: c-api/typeobj c PyVarObject ob_size11254815
Ref: 400911254815
Node: PyTypeObject Slots11255104
Ref: c-api/typeobj pytypeobject-slots11255219
Ref: 400a11255219
Ref: c-api/typeobj c PyTypeObject tp_name11255572
Ref: 3a9f11255572
Ref: c-api/typeobj c PyTypeObject tp_basicsize11257277
Ref: 3a7d11257277
Ref: c-api/typeobj c PyTypeObject tp_itemsize11257328
Ref: 3a7c11257328
Ref: c-api/typeobj c PyTypeObject tp_dealloc11259981
Ref: 3a8311259981
Ref: c-api/typeobj c PyTypeObject tp_vectorcall_offset11261983
Ref: 3c0611261983
Ref: c-api/typeobj c PyVectorcall_Call11263117
Ref: 400d11263117
Ref: c-api/typeobj c PyTypeObject tp_getattr11264744
Ref: 3aa611264744
Ref: c-api/typeobj c PyTypeObject tp_setattr11265465
Ref: 3aa711265465
Ref: c-api/typeobj c PyTypeObject tp_as_async11266206
Ref: 3fa311266206
Ref: c-api/typeobj c PyTypeObject tp_repr11266748
Ref: 3a9e11266748
Ref: c-api/typeobj c PyTypeObject tp_as_number11267697
Ref: 3fa611267697
Ref: c-api/typeobj c PyTypeObject tp_as_sequence11268098
Ref: 3fa711268098
Ref: c-api/typeobj c PyTypeObject tp_as_mapping11268509
Ref: 3fa811268509
Ref: c-api/typeobj c PyTypeObject tp_hash11268915
Ref: 3ab011268915
Ref: c-api/typeobj c PyTypeObject tp_call11270503
Ref: 3ab111270503
Ref: c-api/typeobj c PyTypeObject tp_str11270903
Ref: 3aa011270903
Ref: c-api/typeobj c PyTypeObject tp_getattro11271850
Ref: 3aa311271850
Ref: c-api/typeobj c PyTypeObject tp_setattro11272713
Ref: 3aa411272713
Ref: c-api/typeobj c PyTypeObject tp_as_buffer11273707
Ref: 3fad11273707
Ref: c-api/typeobj c PyTypeObject tp_flags11274107
Ref: 3ca611274107
Ref: c-api/typeobj Py_TPFLAGS_HEAPTYPE11275999
Ref: 3cae11275999
Ref: c-api/typeobj Py_TPFLAGS_BASETYPE11276644
Ref: 3a8b11276644
Ref: c-api/typeobj Py_TPFLAGS_READY11276921
Ref: 401311276921
Ref: c-api/typeobj Py_TPFLAGS_READYING11277111
Ref: 401411277111
Ref: c-api/typeobj Py_TPFLAGS_HAVE_GC11277310
Ref: 3a9211277310
Ref: c-api/typeobj Py_TPFLAGS_DEFAULT11278291
Ref: 3a7e11278291
Ref: c-api/typeobj Py_TPFLAGS_METHOD_DESCRIPTOR11278671
Ref: 401611278671
Ref: c-api/typeobj Py_TPFLAGS_LONG_SUBCLASS11279536
Ref: 401711279536
Ref: c-api/typeobj Py_TPFLAGS_LIST_SUBCLASS11279577
Ref: 401811279577
Ref: c-api/typeobj Py_TPFLAGS_TUPLE_SUBCLASS11279618
Ref: 401911279618
Ref: c-api/typeobj Py_TPFLAGS_BYTES_SUBCLASS11279660
Ref: 401a11279660
Ref: c-api/typeobj Py_TPFLAGS_UNICODE_SUBCLASS11279702
Ref: 401b11279702
Ref: c-api/typeobj Py_TPFLAGS_DICT_SUBCLASS11279746
Ref: 401c11279746
Ref: c-api/typeobj Py_TPFLAGS_BASE_EXC_SUBCLASS11279787
Ref: 401d11279787
Ref: c-api/typeobj Py_TPFLAGS_TYPE_SUBCLASS11279832
Ref: 401e11279832
Ref: c-api/typeobj Py_TPFLAGS_HAVE_FINALIZE11280390
Ref: 2d611280390
Ref: c-api/typeobj _Py_TPFLAGS_HAVE_VECTORCALL11280770
Ref: 400b11280770
Ref: c-api/typeobj c PyTypeObject tp_doc11281668
Ref: 3a7f11281668
Ref: c-api/typeobj c PyTypeObject tp_traverse11281980
Ref: 35fa11281980
Ref: c-api/typeobj c PyTypeObject tp_clear11284076
Ref: 3a9c11284076
Ref: c-api/typeobj c PyTypeObject tp_richcompare11287323
Ref: 3aa911287323
Ref: c-api/typeobj c Py_RETURN_RICHCOMPARE11288848
Ref: 41711288848
Ref: c-api/typeobj c PyTypeObject tp_weaklistoffset11290115
Ref: 3ab311290115
Ref: c-api/typeobj c PyTypeObject tp_iter11291886
Ref: e2311291886
Ref: c-api/typeobj c PyTypeObject tp_iternext11292360
Ref: e2411292360
Ref: c-api/typeobj c PyTypeObject tp_methods11293152
Ref: 3a8a11293152
Ref: c-api/typeobj c PyTypeObject tp_members11293648
Ref: 3a8811293648
Ref: c-api/typeobj c PyTypeObject tp_getset11294180
Ref: 3a8e11294180
Ref: c-api/typeobj c PyTypeObject tp_base11294704
Ref: 3a9411294704
Ref: c-api/typeobj c PyTypeObject tp_dict11295998
Ref: 3cba11295998
Ref: c-api/typeobj c PyTypeObject tp_descr_get11296976
Ref: 3fb411296976
Ref: c-api/typeobj c PyTypeObject tp_descr_set11297272
Ref: 3fb611297272
Ref: c-api/typeobj c PyTypeObject tp_dictoffset11297663
Ref: 3cbf11297663
Ref: c-api/typeobj c PyTypeObject tp_init11300883
Ref: 3a8711300883
Ref: c-api/typeobj c PyTypeObject tp_alloc11302339
Ref: 3a8511302339
Ref: c-api/typeobj c PyTypeObject tp_new11303024
Ref: 3a8011303024
Ref: c-api/typeobj c PyTypeObject tp_free11304588
Ref: 3a8411304588
Ref: c-api/typeobj c PyTypeObject tp_is_gc11305272
Ref: 3fbc11305272
Ref: c-api/typeobj c PyTypeObject tp_bases11306423
Ref: 3fbd11306423
Ref: c-api/typeobj c PyTypeObject tp_mro11306671
Ref: 3cbb11306671
Ref: c-api/typeobj c PyTypeObject tp_cache11306989
Ref: 3cbc11306989
Ref: c-api/typeobj c PyTypeObject tp_subclasses11307126
Ref: 3cbd11307126
Ref: c-api/typeobj c PyTypeObject tp_weaklist11307299
Ref: 3cbe11307299
Ref: c-api/typeobj c PyTypeObject tp_del11307518
Ref: 3fbe11307518
Ref: c-api/typeobj c PyTypeObject tp_version_tag11307634
Ref: 3fbf11307634
Ref: c-api/typeobj c PyTypeObject tp_finalize11307809
Ref: 2d511307809
Ref: c-api/typeobj c PyTypeObject tp_allocs11309443
Ref: 3fc011309443
Ref: c-api/typeobj c PyTypeObject tp_frees11309521
Ref: 3fc111309521
Ref: c-api/typeobj c PyTypeObject tp_maxalloc11309592
Ref: 3fc211309592
Ref: c-api/typeobj c PyTypeObject tp_prev11309691
Ref: 3fc311309691
Ref: c-api/typeobj c PyTypeObject tp_next11309834
Ref: 3fc411309834
Ref: PyTypeObject Slots-Footnote-111310666
Node: Heap Types11310715
Ref: c-api/typeobj heap-types11310804
Ref: 3cac11310804
Ref: c-api/typeobj id411310804
Ref: 400e11310804
Node: Number Object Structures11311968
Ref: c-api/typeobj number-object-structures11312116
Ref: 401f11312116
Ref: c-api/typeobj number-structs11312116
Ref: 401011312116
Ref: c-api/typeobj c PyNumberMethods11312181
Ref: d7411312181
Ref: c-api/typeobj c PyNumberMethods nb_add11314237
Ref: 3cb811314237
Ref: c-api/typeobj c PyNumberMethods nb_subtract11314286
Ref: 3fcc11314286
Ref: c-api/typeobj c PyNumberMethods nb_multiply11314340
Ref: 3fce11314340
Ref: c-api/typeobj c PyNumberMethods nb_remainder11314394
Ref: 3fd011314394
Ref: c-api/typeobj c PyNumberMethods nb_divmod11314449
Ref: 3fd211314449
Ref: c-api/typeobj c PyNumberMethods nb_power11314501
Ref: 3fd311314501
Ref: c-api/typeobj c PyNumberMethods nb_negative11314553
Ref: 3fd511314553
Ref: c-api/typeobj c PyNumberMethods nb_positive11314606
Ref: 3fd611314606
Ref: c-api/typeobj c PyNumberMethods nb_absolute11314659
Ref: 3fd711314659
Ref: c-api/typeobj c PyNumberMethods nb_bool11314712
Ref: 3fd811314712
Ref: c-api/typeobj c PyNumberMethods nb_invert11314759
Ref: 3fd911314759
Ref: c-api/typeobj c PyNumberMethods nb_lshift11314810
Ref: 3fda11314810
Ref: c-api/typeobj c PyNumberMethods nb_rshift11314862
Ref: 3fdc11314862
Ref: c-api/typeobj c PyNumberMethods nb_and11314914
Ref: 3fde11314914
Ref: c-api/typeobj c PyNumberMethods nb_xor11314963
Ref: 3fe011314963
Ref: c-api/typeobj c PyNumberMethods nb_or11315012
Ref: 3fe211315012
Ref: c-api/typeobj c PyNumberMethods nb_int11315060
Ref: 3fe411315060
Ref: c-api/typeobj c PyNumberMethods nb_reserved11315108
Ref: 3fe511315108
Ref: c-api/typeobj c PyNumberMethods nb_float11315157
Ref: 3fe611315157
Ref: c-api/typeobj c PyNumberMethods nb_inplace_add11315207
Ref: 3fcb11315207
Ref: c-api/typeobj c PyNumberMethods nb_inplace_subtract11315264
Ref: 3fcd11315264
Ref: c-api/typeobj c PyNumberMethods nb_inplace_multiply11315326
Ref: 3fcf11315326
Ref: c-api/typeobj c PyNumberMethods nb_inplace_remainder11315388
Ref: 3fd111315388
Ref: c-api/typeobj c PyNumberMethods nb_inplace_power11315451
Ref: 3fd411315451
Ref: c-api/typeobj c PyNumberMethods nb_inplace_lshift11315511
Ref: 3fdb11315511
Ref: c-api/typeobj c PyNumberMethods nb_inplace_rshift11315571
Ref: 3fdd11315571
Ref: c-api/typeobj c PyNumberMethods nb_inplace_and11315631
Ref: 3fdf11315631
Ref: c-api/typeobj c PyNumberMethods nb_inplace_xor11315688
Ref: 3fe111315688
Ref: c-api/typeobj c PyNumberMethods nb_inplace_or11315745
Ref: 3fe311315745
Ref: c-api/typeobj c PyNumberMethods nb_floor_divide11315801
Ref: 3fe711315801
Ref: c-api/typeobj c PyNumberMethods nb_true_divide11315859
Ref: 3fe911315859
Ref: c-api/typeobj c PyNumberMethods nb_inplace_floor_divide11315916
Ref: 3fe811315916
Ref: c-api/typeobj c PyNumberMethods nb_inplace_true_divide11315982
Ref: 3fea11315982
Ref: c-api/typeobj c PyNumberMethods nb_index11316047
Ref: 3feb11316047
Ref: c-api/typeobj c PyNumberMethods nb_matrix_multiply11316097
Ref: 3fec11316097
Ref: c-api/typeobj c PyNumberMethods nb_inplace_matrix_multiply11316158
Ref: 3fed11316158
Node: Mapping Object Structures11316227
Ref: c-api/typeobj mapping-object-structures11316386
Ref: 402011316386
Ref: c-api/typeobj mapping-structs11316386
Ref: 401211316386
Ref: c-api/typeobj c PyMappingMethods11316453
Ref: 3aaf11316453
Ref: c-api/typeobj c PyMappingMethods mp_length11316620
Ref: 3fee11316620
Ref: c-api/typeobj c PyMappingMethods mp_subscript11316874
Ref: 3ff011316874
Ref: c-api/typeobj c PyMappingMethods mp_ass_subscript11317233
Ref: 3ff111317233
Node: Sequence Object Structures11317673
Ref: c-api/typeobj sequence-object-structures11317832
Ref: 402111317832
Ref: c-api/typeobj sequence-structs11317832
Ref: 401111317832
Ref: c-api/typeobj c PySequenceMethods11317901
Ref: 3aae11317901
Ref: c-api/typeobj c PySequenceMethods sq_length11318047
Ref: 3cb911318047
Ref: c-api/typeobj c PySequenceMethods sq_concat11318351
Ref: 3ff311318351
Ref: c-api/typeobj c PySequenceMethods sq_repeat11318617
Ref: 3ff411318617
Ref: c-api/typeobj c PySequenceMethods sq_item11318897
Ref: 3ff611318897
Ref: c-api/typeobj c PySequenceMethods sq_ass_item11319602
Ref: 3ff711319602
Ref: c-api/typeobj c PySequenceMethods sq_contains11320055
Ref: 3ff911320055
Ref: c-api/typeobj c PySequenceMethods sq_inplace_concat11320357
Ref: 3ffb11320357
Ref: c-api/typeobj c PySequenceMethods sq_inplace_repeat11320871
Ref: 3ffc11320871
Node: Buffer Object Structures11321398
Ref: c-api/typeobj buffer-object-structures11321555
Ref: 402211321555
Ref: c-api/typeobj buffer-structs11321555
Ref: 3c5e11321555
Ref: c-api/typeobj c PyBufferProcs11321620
Ref: 3fae11321620
Ref: c-api/typeobj c PyBufferProcs bf_getbuffer11321850
Ref: 3cc011321850
Ref: c-api/typeobj c PyBufferProcs bf_releasebuffer11323742
Ref: 3bc011323742
Node: Async Object Structures11324854
Ref: c-api/typeobj async-object-structures11325003
Ref: 402311325003
Ref: c-api/typeobj async-structs11325003
Ref: 400f11325003
Ref: c-api/typeobj c PyAsyncMethods11325087
Ref: 3cb711325087
Ref: c-api/typeobj c PyAsyncMethods am_await11325427
Ref: 3fc611325427
Ref: c-api/typeobj c PyAsyncMethods am_aiter11325768
Ref: 3fc811325768
Ref: c-api/typeobj c PyAsyncMethods am_anext11326115
Ref: 3fc911326115
Node: Slot Type typedefs11326388
Ref: c-api/typeobj id511326525
Ref: 400111326525
Ref: c-api/typeobj slot-type-typedefs11326525
Ref: 402411326525
Ref: c-api/typeobj c allocfunc11326578
Ref: 3fb911326578
Ref: c-api/typeobj c destructor11327545
Ref: 3fa011327545
Ref: c-api/typeobj c vectorcallfunc11327590
Ref: 400c11327590
Ref: c-api/typeobj c freefunc11327890
Ref: 3fbb11327890
Ref: c-api/typeobj c newfunc11327960
Ref: 3fba11327960
Ref: c-api/typeobj c initproc11328061
Ref: 3fb811328061
Ref: c-api/typeobj c reprfunc11328158
Ref: 3fa511328158
Ref: c-api/typeobj c getattrfunc11328237
Ref: 3fa111328237
Ref: c-api/typeobj c setattrfunc11328366
Ref: 3fa211328366
Ref: c-api/typeobj c getattrofunc11328584
Ref: 3fab11328584
Ref: c-api/typeobj c setattrofunc11328753
Ref: 3fac11328753
Ref: c-api/typeobj c descrgetfunc11329011
Ref: 3fb511329011
Ref: c-api/typeobj c descrsetfunc11329126
Ref: 3fb711329126
Ref: c-api/typeobj c hashfunc11329225
Ref: 3fa911329225
Ref: c-api/typeobj c richcmpfunc11329304
Ref: 3fb111329304
Ref: c-api/typeobj c getiterfunc11329410
Ref: 3fb211329410
Ref: c-api/typeobj c iternextfunc11329491
Ref: 3fb311329491
Ref: c-api/typeobj c lenfunc11329577
Ref: 3fef11329577
Ref: c-api/typeobj c getbufferproc11329625
Ref: 3ffd11329625
Ref: c-api/typeobj c releasebufferproc11329690
Ref: 3ffe11329690
Ref: c-api/typeobj c unaryfunc11329755
Ref: 3fc711329755
Ref: c-api/typeobj c binaryfunc11329804
Ref: 3fca11329804
Ref: c-api/typeobj c ternaryfunc11329866
Ref: 3faa11329866
Ref: c-api/typeobj c ssizeargfunc11329951
Ref: 3ff511329951
Ref: c-api/typeobj c ssizeobjargproc11330015
Ref: 3ff811330015
Ref: c-api/typeobj c objobjproc11330076
Ref: 3ffa11330076
Ref: c-api/typeobj c objobjargproc11330132
Ref: 3ff211330132
Node: Examples<35>11330203
Ref: c-api/typeobj examples11330353
Ref: 402511330353
Ref: c-api/typeobj typedef-examples11330353
Ref: 3f9b11330353
Node: Supporting Cyclic Garbage Collection11335185
Ref: c-api/gcsupport doc11335308
Ref: 402611335308
Ref: c-api/gcsupport supporting-cycle-detection11335308
Ref: 401511335308
Ref: c-api/gcsupport supporting-cyclic-garbage-collection11335308
Ref: 402711335308
Ref: c-api/gcsupport c PyObject_GC_New11336640
Ref: 2d211336640
Ref: c-api/gcsupport c PyObject_GC_NewVar11336834
Ref: 2d311336834
Ref: c-api/gcsupport c PyObject_GC_Resize11337061
Ref: 402811337061
Ref: c-api/gcsupport c PyObject_GC_Track11337334
Ref: e3711337334
Ref: c-api/gcsupport c PyObject_GC_Del11338027
Ref: e3611338027
Ref: c-api/gcsupport c PyObject_GC_UnTrack11338198
Ref: e3811338198
Ref: c-api/gcsupport c visitproc11338876
Ref: 400011338876
Ref: c-api/gcsupport c traverseproc11339422
Ref: 3faf11339422
Ref: c-api/gcsupport c Py_VISIT11340160
Ref: 3a9011340160
Ref: c-api/gcsupport c inquiry11340683
Ref: 3fb011340683
Node: API and ABI Versioning11341158
Ref: c-api/apiabiversion doc11341284
Ref: 402911341284
Ref: c-api/apiabiversion api-and-abi-versioning11341284
Ref: 402a11341284
Ref: c-api/apiabiversion apiabiversion11341284
Ref: 357111341284
Ref: API and ABI Versioning-Footnote-111343235
Node: Distributing Python Modules11343307
Ref: distributing/index doc11343446
Ref: 402b11343446
Ref: distributing/index distributing-index11343446
Ref: 7ea11343446
Ref: distributing/index distributing-python-modules11343446
Ref: 402c11343446
Node: Key terms11344627
Ref: distributing/index key-terms11344748
Ref: 402d11344748
Ref: Key terms-Footnote-111346688
Ref: Key terms-Footnote-211346713
Ref: Key terms-Footnote-311346742
Ref: Key terms-Footnote-411346774
Ref: Key terms-Footnote-511346810
Ref: Key terms-Footnote-611346863
Ref: Key terms-Footnote-711346901
Ref: Key terms-Footnote-811346954
Node: Open source licensing and collaboration11347003
Ref: distributing/index open-source-licensing-and-collaboration11347153
Ref: 402e11347153
Ref: distributing/index wheel11347153
Ref: 402f11347153
Node: Installing the tools11348171
Ref: distributing/index installing-the-tools11348351
Ref: 403011348351
Ref: Installing the tools-Footnote-111349254
Node: Reading the Python Packaging User Guide11349352
Ref: distributing/index publishing-python-packages11349505
Ref: 403111349505
Ref: distributing/index reading-the-python-packaging-user-guide11349505
Ref: 403211349505
Ref: Reading the Python Packaging User Guide-Footnote-111349884
Ref: Reading the Python Packaging User Guide-Footnote-211349954
Ref: Reading the Python Packaging User Guide-Footnote-311350048
Node: How do I…?11350150
Ref: distributing/index how-do-i11350274
Ref: 403311350274
Ref: distributing/index uploading-the-project-to-the-python-packaging-index11350274
Ref: 403411350274
Node: … choose a name for my project?11350461
Ref: distributing/index choose-a-name-for-my-project11350596
Ref: 403511350596
Node: … create and distribute binary extensions?11351178
Ref: distributing/index create-and-distribute-binary-extensions11351313
Ref: 403611351313
Ref: … create and distribute binary extensions?-Footnote-111351735
Node: Installing Python Modules11351808
Ref: installing/index doc11351931
Ref: 403711351931
Ref: installing/index installing-index11351931
Ref: 7e911351931
Ref: installing/index installing-python-modules11351931
Ref: 403811351931
Node: Key terms<2>11353069
Ref: installing/index key-terms11353163
Ref: 403911353163
Ref: Key terms<2>-Footnote-111355289
Ref: Key terms<2>-Footnote-211355314
Ref: Key terms<2>-Footnote-311355343
Ref: Key terms<2>-Footnote-411355375
Ref: Key terms<2>-Footnote-511355411
Node: Basic usage11355491
Ref: installing/index basic-usage11355607
Ref: 403a11355607
Ref: Basic usage-Footnote-111357258
Ref: Basic usage-Footnote-211357295
Node: How do I …?11357344
Ref: installing/index how-do-i11357474
Ref: 403b11357474
Node: … install pip in versions of Python prior to Python 3 4?11357863
Ref: installing/index install-pip-in-versions-of-python-prior-to-python-3-411358027
Ref: 403c11358027
Ref: … install pip in versions of Python prior to Python 3 4?-Footnote-111358459
Node: … install packages just for the current user?11358546
Ref: installing/index install-packages-just-for-the-current-user11358758
Ref: 403d11358758
Node: … install scientific Python packages?11359020
Ref: installing/index install-scientific-python-packages11359238
Ref: 403e11359238
Ref: … install scientific Python packages?-Footnote-111359744
Ref: … install scientific Python packages?-Footnote-211359790
Node: … work with multiple versions of Python installed in parallel?11359836
Ref: installing/index work-with-multiple-versions-of-python-installed-in-parallel11359998
Ref: 403f11359998
Node: Common installation issues11360943
Ref: installing/index common-installation-issues11361053
Ref: 404011361053
Node: Installing into the system Python on Linux11361228
Ref: installing/index installing-into-the-system-python-on-linux11361359
Ref: 404111361359
Node: Pip not installed11361926
Ref: installing/index pip-not-installed11362094
Ref: 404211362094
Ref: Pip not installed-Footnote-111362368
Node: Installing binary extensions11362470
Ref: installing/index installing-binary-extensions11362587
Ref: 404311362587
Ref: Installing binary extensions-Footnote-111363482
Ref: Installing binary extensions-Footnote-211363528
Node: Python HOWTOs11363577
Ref: howto/index doc11363706
Ref: 404411363706
Ref: howto/index python-howtos11363706
Ref: 404511363706
Node: Porting Python 2 Code to Python 311364580
Ref: howto/pyporting doc11364709
Ref: 404611364709
Ref: howto/pyporting porting-python-2-code-to-python-311364709
Ref: 404711364709
Ref: howto/pyporting pyporting-howto11364709
Ref: c7011364709
Ref: Porting Python 2 Code to Python 3-Footnote-111365588
Ref: Porting Python 2 Code to Python 3-Footnote-211365692
Ref: Porting Python 2 Code to Python 3-Footnote-311365738
Node: The Short Explanation11365802
Ref: howto/pyporting the-short-explanation11365909
Ref: 404811365909
Ref: The Short Explanation-Footnote-111367060
Ref: The Short Explanation-Footnote-211367102
Ref: The Short Explanation-Footnote-311367161
Ref: The Short Explanation-Footnote-411367210
Ref: The Short Explanation-Footnote-511367250
Ref: The Short Explanation-Footnote-611367298
Ref: The Short Explanation-Footnote-711367335
Node: Details11367365
Ref: howto/pyporting details11367472
Ref: 404911367472
Node: Drop support for Python 2 6 and older11368948
Ref: howto/pyporting drop-support-for-python-2-6-and-older11369108
Ref: 404a11369108
Ref: Drop support for Python 2 6 and older-Footnote-111370433
Ref: Drop support for Python 2 6 and older-Footnote-211370470
Node: Make sure you specify the proper version support in your setup py file11370510
Ref: howto/pyporting make-sure-you-specify-the-proper-version-support-in-your-setup-py-file11370702
Ref: 404b11370702
Ref: Make sure you specify the proper version support in your setup py file-Footnote-111371304
Node: Have good test coverage11371341
Ref: howto/pyporting have-good-test-coverage11371538
Ref: 404c11371538
Ref: Have good test coverage-Footnote-111372224
Node: Learn the differences between Python 2 & 311372266
Ref: howto/pyporting learn-the-differences-between-python-2-311372409
Ref: 404d11372409
Ref: Learn the differences between Python 2 & 3-Footnote-111373061
Ref: Learn the differences between Python 2 & 3-Footnote-211373115
Ref: Learn the differences between Python 2 & 3-Footnote-311373150
Node: Update your code11373206
Ref: howto/pyporting update-your-code11373359
Ref: 404e11373359
Ref: Update your code-Footnote-111375635
Ref: Update your code-Footnote-211375694
Ref: Update your code-Footnote-311375743
Ref: Update your code-Footnote-411375802
Ref: Update your code-Footnote-511375851
Node: Division11375888
Ref: howto/pyporting division11375981
Ref: 404f11375981
Node: Text versus binary data11377037
Ref: howto/pyporting text-versus-binary-data11377189
Ref: 405011377189
Ref: Text versus binary data-Footnote-111383705
Node: Use feature detection instead of version detection11383742
Ref: howto/pyporting use-feature-detection-instead-of-version-detection11383877
Ref: 405111383877
Ref: Use feature detection instead of version detection-Footnote-111385512
Ref: Use feature detection instead of version detection-Footnote-211385586
Node: Prevent compatibility regressions11385630
Ref: howto/pyporting prevent-compatibility-regressions11385787
Ref: 405211385787
Ref: Prevent compatibility regressions-Footnote-111387119
Ref: Prevent compatibility regressions-Footnote-211387159
Ref: Prevent compatibility regressions-Footnote-311387208
Node: Check which dependencies block your transition11387267
Ref: howto/pyporting check-which-dependencies-block-your-transition11387466
Ref: 405311387466
Ref: Check which dependencies block your transition-Footnote-111388328
Node: Update your setup py file to denote Python 3 compatibility11388376
Ref: howto/pyporting update-your-setup-py-file-to-denote-python-3-compatibility11388587
Ref: 405411388587
Node: Use continuous integration to stay compatible11389101
Ref: howto/pyporting use-continuous-integration-to-stay-compatible11389310
Ref: 405511389310
Ref: Use continuous integration to stay compatible-Footnote-111390622
Node: Consider using optional static type checking11390659
Ref: howto/pyporting consider-using-optional-static-type-checking11390801
Ref: 405611390801
Ref: Consider using optional static type checking-Footnote-111391582
Ref: Consider using optional static type checking-Footnote-211391612
Node: Porting Extension Modules to Python 311391653
Ref: howto/cporting doc11391821
Ref: 405711391821
Ref: howto/cporting cporting-howto11391821
Ref: c6a11391821
Ref: howto/cporting porting-extension-modules-to-python-311391821
Ref: 405811391821
Ref: howto/cporting why-python-3-exists11391821
Ref: 405911391821
Ref: Porting Extension Modules to Python 3-Footnote-111392603
Ref: Porting Extension Modules to Python 3-Footnote-211392654
Ref: Porting Extension Modules to Python 3-Footnote-311392711
Ref: Porting Extension Modules to Python 3-Footnote-411392738
Node: Curses Programming with Python11392785
Ref: howto/curses doc11392942
Ref: 405a11392942
Ref: howto/curses cffi11392942
Ref: 405b11392942
Ref: howto/curses curses-howto11392942
Ref: 209011392942
Ref: howto/curses curses-programming-with-python11392942
Ref: 405c11392942
Node: What is curses?11393353
Ref: howto/curses what-is-curses11393484
Ref: 405d11393484
Ref: What is curses?-Footnote-111396044
Ref: What is curses?-Footnote-211396084
Ref: What is curses?-Footnote-311396127
Node: The Python curses module11396176
Ref: howto/curses the-python-curses-module11396252
Ref: 405e11396252
Node: Starting and ending a curses application11397081
Ref: howto/curses starting-and-ending-a-curses-application11397237
Ref: 405f11397237
Node: Windows and Pads11400436
Ref: howto/curses windows-and-pads11400592
Ref: 406011400592
Node: Displaying Text11405068
Ref: howto/curses displaying-text11405194
Ref: 406111405194
Node: Attributes and Color11408980
Ref: howto/curses attributes-and-color11409052
Ref: 406211409052
Node: User Input11413597
Ref: howto/curses user-input11413727
Ref: 406311413727
Ref: User Input-Footnote-111417431
Node: For More Information11417471
Ref: howto/curses for-more-information11417577
Ref: 406411417577
Ref: For More Information-Footnote-111419076
Ref: For More Information-Footnote-211419113
Ref: For More Information-Footnote-311419176
Ref: For More Information-Footnote-411419220
Ref: For More Information-Footnote-511419281
Ref: For More Information-Footnote-611419333
Node: Descriptor HowTo Guide11419407
Ref: howto/descriptor doc11419555
Ref: 406511419555
Ref: howto/descriptor descriptor-howto-guide11419555
Ref: 406611419555
Node: Abstract11419904
Ref: howto/descriptor abstract11420007
Ref: 406711420007
Node: Definition and Introduction11420526
Ref: howto/descriptor definition-and-introduction11420657
Ref: 406811420657
Node: Descriptor Protocol11422012
Ref: howto/descriptor descriptor-protocol11422158
Ref: 406911422158
Node: Invoking Descriptors<2>11423469
Ref: howto/descriptor invoking-descriptors11423606
Ref: 406a11423606
Ref: Invoking Descriptors<2>-Footnote-111426577
Ref: Invoking Descriptors<2>-Footnote-211426645
Ref: Invoking Descriptors<2>-Footnote-311426717
Node: Descriptor Example11426797
Ref: howto/descriptor descriptor-example11426925
Ref: 406b11426925
Node: Properties11428192
Ref: howto/descriptor properties11428318
Ref: 406c11428318
Node: Functions and Methods11430855
Ref: howto/descriptor functions-and-methods11430995
Ref: 406d11430995
Node: Static Methods and Class Methods11433108
Ref: howto/descriptor static-methods-and-class-methods11433229
Ref: 406e11433229
Node: Functional Programming HOWTO11437628
Ref: howto/functional doc11437759
Ref: 406f11437759
Ref: howto/functional functional-programming-howto11437759
Ref: 407011437759
Node: Introduction<14>11438569
Ref: howto/functional introduction11438671
Ref: 407111438671
Node: Formal provability11443385
Ref: howto/functional formal-provability11443475
Ref: 407311443475
Node: Modularity11445391
Ref: howto/functional modularity11445519
Ref: 407411445519
Node: Ease of debugging and testing11445926
Ref: howto/functional ease-of-debugging-and-testing11446049
Ref: 407511446049
Node: Composability11446786
Ref: howto/functional composability11446890
Ref: 407611446890
Node: Iterators<2>11447615
Ref: howto/functional functional-howto-iterators11447771
Ref: 407211447771
Ref: howto/functional iterators11447771
Ref: 407711447771
Node: Data Types That Support Iterators11451030
Ref: howto/functional data-types-that-support-iterators11451112
Ref: 407811451112
Node: Generator expressions and list comprehensions11452917
Ref: howto/functional generator-expressions-and-list-comprehensions11453070
Ref: 407911453070
Node: Generators<2>11457455
Ref: howto/functional generators11457614
Ref: 407a11457614
Ref: Generators<2>-Footnote-111461385
Node: Passing values into a generator11461465
Ref: howto/functional passing-values-into-a-generator11461546
Ref: 407b11461546
Ref: Passing values into a generator-Footnote-111465538
Node: Built-in functions11465587
Ref: howto/functional built-in-functions11465721
Ref: 407c11465721
Ref: Built-in functions-Footnote-111469570
Node: The itertools module11469624
Ref: howto/functional the-itertools-module11469765
Ref: 407d11469765
Node: Creating new iterators11470510
Ref: howto/functional creating-new-iterators11470627
Ref: 407e11470627
Node: Calling functions on elements11473211
Ref: howto/functional calling-functions-on-elements11473355
Ref: 407f11473355
Node: Selecting elements11474152
Ref: howto/functional selecting-elements11474296
Ref: 408011474296
Node: Combinatoric functions11475738
Ref: howto/functional combinatoric-functions11475870
Ref: 408111475870
Node: Grouping elements11478083
Ref: howto/functional grouping-elements11478188
Ref: 408211478188
Node: The functools module11479655
Ref: howto/functional the-functools-module11479819
Ref: 408311479819
Node: The operator module11483281
Ref: howto/functional the-operator-module11483357
Ref: 408411483357
Node: Small functions and the lambda expression11484171
Ref: howto/functional small-functions-and-the-lambda-expression11484352
Ref: 408511484352
Node: Revision History and Acknowledgements11487156
Ref: howto/functional revision-history-and-acknowledgements11487330
Ref: 408611487330
Node: References<2>11488109
Ref: howto/functional references11488233
Ref: 408711488233
Node: General11488339
Ref: howto/functional general11488420
Ref: 408811488420
Node: Python-specific11489361
Ref: howto/functional python-specific11489471
Ref: 408911489471
Ref: Python-specific-Footnote-111489946
Ref: Python-specific-Footnote-211490022
Ref: Python-specific-Footnote-311490099
Node: Python documentation11490176
Ref: howto/functional python-documentation11490270
Ref: 408a11490270
Ref: Python documentation-Footnote-111490671
Ref: Python documentation-Footnote-211490720
Node: Logging HOWTO11490769
Ref: howto/logging doc11490894
Ref: 408b11490894
Ref: howto/logging logging-howto11490894
Ref: 408c11490894
Node: Basic Logging Tutorial11491207
Ref: howto/logging basic-logging-tutorial11491313
Ref: 408d11491313
Ref: howto/logging logging-basic-tutorial11491313
Ref: b6511491313
Node: When to use logging11492099
Ref: howto/logging when-to-use-logging11492202
Ref: 408e11492202
Node: A simple example11496093
Ref: howto/logging a-simple-example11496222
Ref: 408f11496222
Ref: howto/logging howto-minimal-example11496222
Ref: 409011496222
Node: Logging to a file11496999
Ref: howto/logging logging-to-a-file11497138
Ref: 409111497138
Node: Logging from multiple modules11499591
Ref: howto/logging logging-from-multiple-modules11499735
Ref: 409211499735
Node: Logging variable data11500871
Ref: howto/logging logging-variable-data11501039
Ref: 409311501039
Node: Changing the format of displayed messages11501853
Ref: howto/logging changing-the-format-of-displayed-messages11502028
Ref: 409411502028
Node: Displaying the date/time in messages11502994
Ref: howto/logging displaying-the-date-time-in-messages11503158
Ref: 409511503158
Ref: Displaying the date/time in messages-Footnote-111504190
Node: Next Steps11504239
Ref: howto/logging next-steps11504353
Ref: 409611504353
Node: Advanced Logging Tutorial11505311
Ref: howto/logging advanced-logging-tutorial11505443
Ref: 409711505443
Ref: howto/logging logging-advanced-tutorial11505443
Ref: b6611505443
Node: Logging Flow11508834
Ref: howto/logging logging-flow11508924
Ref: 409811508924
Node: Loggers11509099
Ref: howto/logging loggers11509206
Ref: 409911509206
Node: Handlers11513487
Ref: howto/logging handler-basic11513592
Ref: 409a11513592
Ref: howto/logging handlers11513592
Ref: 409b11513592
Node: Formatters11515660
Ref: howto/logging formatters11515777
Ref: 409d11515777
Ref: howto/logging logging logging Formatter __init__11516227
Ref: 409e11516227
Node: Configuring Logging11517920
Ref: howto/logging configuring-logging11518073
Ref: 409f11518073
Node: What happens if no configuration is provided11524257
Ref: howto/logging what-happens-if-no-configuration-is-provided11524433
Ref: 40a011524433
Node: Configuring Logging for a Library11525860
Ref: howto/logging configuring-logging-for-a-library11526008
Ref: 40a111526008
Ref: howto/logging library-config11526008
Ref: 203811526008
Node: Logging Levels<2>11528433
Ref: howto/logging logging-levels11528558
Ref: 40a211528558
Node: Custom Levels11531419
Ref: howto/logging custom-levels11531486
Ref: 200b11531486
Ref: howto/logging id111531486
Ref: 40a311531486
Node: Useful Handlers11532201
Ref: howto/logging id211532333
Ref: 40a411532333
Ref: howto/logging useful-handlers11532333
Ref: 409c11532333
Node: Exceptions raised during logging11536341
Ref: howto/logging exceptions-raised-during-logging11536491
Ref: 40a511536491
Ref: howto/logging logging-exceptions11536491
Ref: 40a611536491
Node: Using arbitrary objects as messages11537647
Ref: howto/logging arbitrary-object-messages11537794
Ref: 1ffb11537794
Ref: howto/logging using-arbitrary-objects-as-messages11537794
Ref: 40a711537794
Node: Optimization11538408
Ref: howto/logging optimization11538514
Ref: 40a811538514
Node: Logging Cookbook11542058
Ref: howto/logging-cookbook doc11542179
Ref: 40a911542179
Ref: howto/logging-cookbook id111542179
Ref: 40aa11542179
Ref: howto/logging-cookbook logging-cookbook11542179
Ref: b6711542179
Node: Using logging in multiple modules11543790
Ref: howto/logging-cookbook using-logging-in-multiple-modules11543914
Ref: 40ab11543914
Node: Logging from multiple threads11547203
Ref: howto/logging-cookbook logging-from-multiple-threads11547368
Ref: 40ac11547368
Node: Multiple handlers and formatters11548930
Ref: howto/logging-cookbook multiple-handlers-and-formatters11549094
Ref: 40ad11549094
Node: Logging to multiple destinations11551152
Ref: howto/logging-cookbook logging-to-multiple-destinations11551315
Ref: 40ae11551315
Ref: howto/logging-cookbook multiple-destinations11551315
Ref: 40af11551315
Node: Configuration server example11554006
Ref: howto/logging-cookbook configuration-server-example11554169
Ref: 40b011554169
Node: Dealing with handlers that block11555551
Ref: howto/logging-cookbook dealing-with-handlers-that-block11555735
Ref: 40b111555735
Node: Sending and receiving logging events across a network11559322
Ref: howto/logging-cookbook network-logging11559530
Ref: 40b211559530
Ref: howto/logging-cookbook sending-and-receiving-logging-events-across-a-network11559530
Ref: 40b311559530
Node: Adding contextual information to your logging output11564533
Ref: howto/logging-cookbook adding-contextual-information-to-your-logging-output11564757
Ref: 40b411564757
Ref: howto/logging-cookbook context-info11564757
Ref: 1ffe11564757
Node: Using LoggerAdapters to impart contextual information11565839
Ref: howto/logging-cookbook using-loggeradapters-to-impart-contextual-information11566036
Ref: 40b511566036
Node: Using objects other than dicts to pass contextual information11569119
Ref: howto/logging-cookbook using-objects-other-than-dicts-to-pass-contextual-information11569270
Ref: 40b611569270
Node: Using Filters to impart contextual information11569729
Ref: howto/logging-cookbook filters-contextual11569926
Ref: 1ff311569926
Ref: howto/logging-cookbook using-filters-to-impart-contextual-information11569926
Ref: 40b711569926
Node: Logging to a single file from multiple processes11573536
Ref: howto/logging-cookbook logging-to-a-single-file-from-multiple-processes11573726
Ref: 40b811573726
Ref: howto/logging-cookbook multiple-processes11573726
Ref: 40b911573726
Node: Using concurrent futures ProcessPoolExecutor11583266
Ref: howto/logging-cookbook using-concurrent-futures-processpoolexecutor11583395
Ref: 40ba11583395
Node: Using file rotation11584356
Ref: howto/logging-cookbook using-file-rotation11584530
Ref: 40bb11584530
Node: Use of alternative formatting styles11586318
Ref: howto/logging-cookbook format-styles11586465
Ref: 40bc11586465
Ref: howto/logging-cookbook use-of-alternative-formatting-styles11586465
Ref: 40bd11586465
Node: Customizing LogRecord11593311
Ref: howto/logging-cookbook custom-logrecord11593482
Ref: 40be11593482
Ref: howto/logging-cookbook customizing-logrecord11593482
Ref: 40bf11593482
Node: Subclassing QueueHandler - a ZeroMQ example11597370
Ref: howto/logging-cookbook subclassing-queuehandler-a-zeromq-example11597549
Ref: 40c011597549
Ref: howto/logging-cookbook zeromq-handlers11597549
Ref: 40c111597549
Node: Subclassing QueueListener - a ZeroMQ example11598800
Ref: howto/logging-cookbook subclassing-queuelistener-a-zeromq-example11598999
Ref: 40c211598999
Node: An example dictionary-based configuration11600075
Ref: howto/logging-cookbook an-example-dictionary-based-configuration11600293
Ref: 40c311600293
Ref: An example dictionary-based configuration-Footnote-111602080
Ref: An example dictionary-based configuration-Footnote-211602163
Node: Using a rotator and namer to customize log rotation processing11602246
Ref: howto/logging-cookbook cookbook-rotator-namer11602460
Ref: 204411602460
Ref: howto/logging-cookbook using-a-rotator-and-namer-to-customize-log-rotation-processing11602460
Ref: 40c411602460
Node: A more elaborate multiprocessing example11603290
Ref: howto/logging-cookbook a-more-elaborate-multiprocessing-example11603516
Ref: 40c511603516
Node: Inserting a BOM into messages sent to a SysLogHandler11612169
Ref: howto/logging-cookbook inserting-a-bom-into-messages-sent-to-a-sysloghandler11612364
Ref: 40c611612364
Ref: Inserting a BOM into messages sent to a SysLogHandler-Footnote-111614531
Ref: Inserting a BOM into messages sent to a SysLogHandler-Footnote-211614580
Ref: Inserting a BOM into messages sent to a SysLogHandler-Footnote-311614639
Ref: Inserting a BOM into messages sent to a SysLogHandler-Footnote-411614688
Node: Implementing structured logging11614737
Ref: howto/logging-cookbook implementing-structured-logging11614928
Ref: 40c711614928
Node: Customizing handlers with dictConfig11617490
Ref: howto/logging-cookbook custom-handlers11617690
Ref: 40c811617690
Ref: howto/logging-cookbook customizing-handlers-with-dictconfig11617690
Ref: 40c911617690
Node: Using particular formatting styles throughout your application11622508
Ref: howto/logging-cookbook formatting-styles11622712
Ref: 1fea11622712
Ref: howto/logging-cookbook using-particular-formatting-styles-throughout-your-application11622712
Ref: 40ca11622712
Node: Using LogRecord factories11624713
Ref: howto/logging-cookbook using-logrecord-factories11624874
Ref: 40cb11624874
Node: Using custom message objects11625850
Ref: howto/logging-cookbook using-custom-message-objects11626011
Ref: 40cc11626011
Node: Configuring filters with dictConfig11628596
Ref: howto/logging-cookbook configuring-filters-with-dictconfig11628795
Ref: 40cd11628795
Ref: howto/logging-cookbook filters-dictconfig11628795
Ref: 40ce11628795
Node: Customized exception formatting11631580
Ref: howto/logging-cookbook custom-format-exception11631742
Ref: 40cf11631742
Ref: howto/logging-cookbook customized-exception-formatting11631742
Ref: 40d011631742
Node: Speaking logging messages11633722
Ref: howto/logging-cookbook speaking-logging-messages11633909
Ref: 40d111633909
Ref: howto/logging-cookbook spoken-messages11633909
Ref: 40d211633909
Node: Buffering logging messages and outputting them conditionally11635962
Ref: howto/logging-cookbook buffered-logging11636166
Ref: 40d311636166
Ref: howto/logging-cookbook buffering-logging-messages-and-outputting-them-conditionally11636166
Ref: 40d411636166
Node: Formatting times using UTC GMT via configuration11641358
Ref: howto/logging-cookbook formatting-times-using-utc-gmt-via-configuration11641582
Ref: 40d511641582
Ref: howto/logging-cookbook utc-formatting11641582
Ref: 40d611641582
Node: Using a context manager for selective logging11643299
Ref: howto/logging-cookbook context-manager11643497
Ref: 40d711643497
Ref: howto/logging-cookbook using-a-context-manager-for-selective-logging11643497
Ref: 40d811643497
Node: A CLI application starter template11647859
Ref: howto/logging-cookbook a-cli-application-starter-template11648029
Ref: 40d911648029
Ref: howto/logging-cookbook starter-template11648029
Ref: 40da11648029
Node: A Qt GUI for logging11653572
Ref: howto/logging-cookbook a-qt-gui-for-logging11653688
Ref: 40db11653688
Ref: howto/logging-cookbook qt-gui11653688
Ref: 40dc11653688
Ref: A Qt GUI for logging-Footnote-111662192
Ref: A Qt GUI for logging-Footnote-211662219
Ref: A Qt GUI for logging-Footnote-311662261
Node: Regular Expression HOWTO11662301
Ref: howto/regex doc11662433
Ref: 40dd11662433
Ref: howto/regex regex-howto11662433
Ref: 168811662433
Ref: howto/regex regular-expression-howto11662433
Ref: 40de11662433
Node: Introduction<15>11662930
Ref: howto/regex introduction11663031
Ref: 40df11663031
Node: Simple Patterns11664636
Ref: howto/regex simple-patterns11664771
Ref: 40e011664771
Node: Matching Characters11665266
Ref: howto/regex matching-characters11665362
Ref: 40e111665362
Node: Repeating Things11669997
Ref: howto/regex repeating-things11670093
Ref: 40e211670093
Node: Using Regular Expressions11675031
Ref: howto/regex using-regular-expressions11675168
Ref: 40e311675168
Node: Compiling Regular Expressions11675661
Ref: howto/regex compiling-regular-expressions11675781
Ref: 40e411675781
Node: The Backslash Plague11676983
Ref: howto/regex id111677130
Ref: 40e511677130
Ref: howto/regex the-backslash-plague11677130
Ref: 40e611677130
Node: Performing Matches11680016
Ref: howto/regex performing-matches11680159
Ref: 40e711680159
Ref: Performing Matches-Footnote-111685894
Node: Module-Level Functions<2>11685966
Ref: howto/regex module-level-functions11686106
Ref: 40e811686106
Node: Compilation Flags11687293
Ref: howto/regex compilation-flags11687406
Ref: 40e911687406
Node: More Pattern Power11694490
Ref: howto/regex more-pattern-power11694629
Ref: 40eb11694629
Node: More Metacharacters11694994
Ref: howto/regex id211695085
Ref: 40ec11695085
Ref: howto/regex more-metacharacters11695085
Ref: 40ea11695085
Node: Grouping11699564
Ref: howto/regex grouping11699694
Ref: 40ed11699694
Node: Non-capturing and Named Groups11703074
Ref: howto/regex non-capturing-and-named-groups11703205
Ref: 40ee11703205
Node: Lookahead Assertions11708246
Ref: howto/regex lookahead-assertions11708360
Ref: 40ef11708360
Node: Modifying Strings11712027
Ref: howto/regex modifying-strings11712156
Ref: 40f011712156
Node: Splitting Strings11713126
Ref: howto/regex splitting-strings11713224
Ref: 40f111713224
Node: Search and Replace11715472
Ref: howto/regex search-and-replace11715570
Ref: 40f211715570
Node: Common Problems11719933
Ref: howto/regex common-problems11720052
Ref: 40f311720052
Node: Use String Methods11720490
Ref: howto/regex use-string-methods11720588
Ref: 40f411720588
Node: match versus search11722305
Ref: howto/regex match-versus-search11722436
Ref: 40f511722436
Node: Greedy versus Non-Greedy11724034
Ref: howto/regex greedy-versus-non-greedy11724163
Ref: 40f611724163
Node: Using re VERBOSE11726051
Ref: howto/regex using-re-verbose11726152
Ref: 40f711726152
Node: Feedback11727644
Ref: howto/regex feedback11727737
Ref: 40f811727737
Node: Socket Programming HOWTO11728520
Ref: howto/sockets doc11728650
Ref: 40f911728650
Ref: howto/sockets socket-howto11728650
Ref: 25e011728650
Ref: howto/sockets socket-programming-howto11728650
Ref: 40fa11728650
Node: Sockets11729248
Ref: howto/sockets sockets11729342
Ref: 40fb11729342
Node: History11730502
Ref: howto/sockets history11730553
Ref: 40fc11730553
Node: Creating a Socket11731128
Ref: howto/sockets creating-a-socket11731245
Ref: 40fd11731245
Node: IPC11734431
Ref: howto/sockets ipc11734488
Ref: 40fe11734488
Node: Using a Socket11734934
Ref: howto/sockets using-a-socket11735057
Ref: 40ff11735057
Node: Binary Data11741056
Ref: howto/sockets binary-data11741118
Ref: 410011741118
Node: Disconnecting11742194
Ref: howto/sockets disconnecting11742320
Ref: 410111742320
Node: When Sockets Die11743796
Ref: howto/sockets when-sockets-die11743862
Ref: 410211743862
Node: Non-blocking Sockets11744741
Ref: howto/sockets non-blocking-sockets11744844
Ref: 410311744844
Node: Sorting HOW TO11748637
Ref: howto/sorting doc11748756
Ref: 410411748756
Ref: howto/sorting sorting-how-to11748756
Ref: 410511748756
Ref: howto/sorting sortinghowto11748756
Ref: 153c11748756
Node: Sorting Basics11749388
Ref: howto/sorting sorting-basics11749475
Ref: 410611749475
Node: Key Functions11750252
Ref: howto/sorting key-functions11750373
Ref: 410711750373
Node: Operator Module Functions11751948
Ref: howto/sorting operator-module-functions11752079
Ref: 410811752079
Node: Ascending and Descending11753118
Ref: howto/sorting ascending-and-descending11753268
Ref: 410911753268
Node: Sort Stability and Complex Sorts11753795
Ref: howto/sorting sort-stability-and-complex-sorts11753962
Ref: 410a11753962
Ref: Sort Stability and Complex Sorts-Footnote-111755557
Ref: Sort Stability and Complex Sorts-Footnote-211755623
Node: The Old Way Using Decorate-Sort-Undecorate11755669
Ref: howto/sorting the-old-way-using-decorate-sort-undecorate11755847
Ref: 410b11755847
Ref: The Old Way Using Decorate-Sort-Undecorate-Footnote-111757521
Node: The Old Way Using the cmp Parameter11757581
Ref: howto/sorting the-old-way-using-the-cmp-parameter11757739
Ref: 410c11757739
Node: Odd and Ends11760129
Ref: howto/sorting odd-and-ends11760236
Ref: 410d11760236
Node: Unicode HOWTO11761856
Ref: howto/unicode doc11762006
Ref: 410e11762006
Ref: howto/unicode id111762006
Ref: 410f11762006
Ref: howto/unicode unicode-howto11762006
Ref: c2f11762006
Node: Introduction to Unicode11762408
Ref: howto/unicode introduction-to-unicode11762516
Ref: 411011762516
Node: Definitions11762650
Ref: howto/unicode definitions11762739
Ref: 411111762739
Node: Encodings11765690
Ref: howto/unicode encodings11765801
Ref: 411211765801
Node: References<3>11769474
Ref: howto/unicode references11769565
Ref: 411311769565
Ref: References<3>-Footnote-111770442
Ref: References<3>-Footnote-211770473
Ref: References<3>-Footnote-311770513
Ref: References<3>-Footnote-411770565
Ref: References<3>-Footnote-511770611
Ref: References<3>-Footnote-611770785
Ref: References<3>-Footnote-711770842
Node: Python’s Unicode Support11770886
Ref: howto/unicode python-s-unicode-support11771035
Ref: 411411771035
Node: The String Type11771404
Ref: howto/unicode the-string-type11771510
Ref: 411511771510
Node: Converting to Bytes11774499
Ref: howto/unicode converting-to-bytes11774652
Ref: 411611774652
Node: Unicode Literals in Python Source Code11776415
Ref: howto/unicode unicode-literals-in-python-source-code11776571
Ref: 411711776571
Ref: Unicode Literals in Python Source Code-Footnote-111778638
Node: Unicode Properties11778687
Ref: howto/unicode unicode-properties11778841
Ref: 411811778841
Ref: Unicode Properties-Footnote-111780553
Node: Comparing Strings11780622
Ref: howto/unicode comparing-strings11780765
Ref: 411911780765
Node: Unicode Regular Expressions11783500
Ref: howto/unicode unicode-regular-expressions11783638
Ref: 411a11783638
Node: References<4>11784759
Ref: howto/unicode id211784871
Ref: 411b11784871
Ref: References<4>-Footnote-111785659
Ref: References<4>-Footnote-211785754
Ref: References<4>-Footnote-311785806
Node: Reading and Writing Unicode Data11785875
Ref: howto/unicode reading-and-writing-unicode-data11786021
Ref: 411c11786021
Node: Unicode filenames11789707
Ref: howto/unicode unicode-filenames11789841
Ref: 411d11789841
Node: Tips for Writing Unicode-aware Programs11792234
Ref: howto/unicode tips-for-writing-unicode-aware-programs11792390
Ref: 411e11792390
Node: Converting Between File Encodings11793755
Ref: howto/unicode converting-between-file-encodings11793901
Ref: 411f11793901
Node: Files in an Unknown Encoding11794645
Ref: howto/unicode files-in-an-unknown-encoding11794791
Ref: 412011794791
Node: References<5>11795669
Ref: howto/unicode id311795799
Ref: 412111795799
Ref: References<5>-Footnote-111796409
Ref: References<5>-Footnote-211796482
Ref: References<5>-Footnote-311796587
Node: Acknowledgements<10>11796655
Ref: howto/unicode acknowledgements11796766
Ref: 412211796766
Node: HOWTO Fetch Internet Resources Using The urllib Package11797292
Ref: howto/urllib2 doc11797445
Ref: 412311797445
Ref: howto/urllib2 howto-fetch-internet-resources-using-the-urllib-package11797445
Ref: 412411797445
Ref: howto/urllib2 urllib-howto11797445
Ref: 2be811797445
Ref: HOWTO Fetch Internet Resources Using The urllib Package-Footnote-111797992
Ref: HOWTO Fetch Internet Resources Using The urllib Package-Footnote-211798047
Node: Introduction<16>11798123
Ref: howto/urllib2 introduction11798253
Ref: 412511798253
Ref: Introduction<16>-Footnote-111799849
Ref: Introduction<16>-Footnote-211799922
Node: Fetching URLs11799971
Ref: howto/urllib2 fetching-urls11800132
Ref: 412611800132
Node: Data11802320
Ref: howto/urllib2 data11802390
Ref: 412711802390
Ref: Data-Footnote-111804940
Node: Headers11805009
Ref: howto/urllib2 headers11805079
Ref: 412811805079
Ref: Headers-Footnote-111806533
Ref: Headers-Footnote-211806565
Ref: Headers-Footnote-311806779
Ref: Headers-Footnote-411806903
Node: Handling Exceptions<2>11807025
Ref: howto/urllib2 handling-exceptions11807185
Ref: 412a11807185
Node: URLError11807670
Ref: howto/urllib2 urlerror11807755
Ref: 412b11807755
Node: HTTPError11808290
Ref: howto/urllib2 httperror11808398
Ref: 412c11808398
Ref: HTTPError-Footnote-111809280
Node: Error Codes11809329
Ref: howto/urllib2 error-codes11809386
Ref: 412d11809386
Ref: Error Codes-Footnote-111813771
Node: Wrapping it Up11813820
Ref: howto/urllib2 wrapping-it-up11813911
Ref: 412e11813911
Node: Number 111814132
Ref: howto/urllib2 number-111814208
Ref: 412f11814208
Node: Number 211814770
Ref: howto/urllib2 number-211814846
Ref: 413011814846
Node: info and geturl11815315
Ref: howto/urllib2 info-and-geturl11815482
Ref: 412911815482
Ref: info and geturl-Footnote-111816368
Node: Openers and Handlers11816405
Ref: howto/urllib2 openers-and-handlers11816570
Ref: 413111816570
Node: Basic Authentication11818220
Ref: howto/urllib2 id511818377
Ref: 413211818377
Ref: Basic Authentication-Footnote-111821727
Node: Proxies11821800
Ref: howto/urllib2 proxies11821955
Ref: 413311821955
Ref: Proxies-Footnote-111822969
Ref: Proxies-Footnote-211823276
Ref: Proxies-Footnote-311823349
Node: Sockets and Layers11823476
Ref: howto/urllib2 sockets-and-layers11823620
Ref: 413411823620
Node: Footnotes11824601
Ref: howto/urllib2 footnotes11824729
Ref: 413511824729
Node: Argparse Tutorial11824819
Ref: howto/argparse doc11824998
Ref: 413611824998
Ref: howto/argparse argparse-tutorial11824998
Ref: 413711824998
Ref: howto/argparse id111825078
Ref: 1f6811825078
Node: Concepts11825759
Ref: howto/argparse concepts11825840
Ref: 413811825840
Node: The basics11827855
Ref: howto/argparse the-basics11827977
Ref: 413911827977
Node: Introducing Positional arguments11829093
Ref: howto/argparse introducing-positional-arguments11829237
Ref: 413a11829237
Node: Introducing Optional arguments11832329
Ref: howto/argparse introducing-optional-arguments11832506
Ref: 413b11832506
Node: Short options11835360
Ref: howto/argparse short-options11835440
Ref: 413c11835440
Node: Combining Positional and Optional arguments11836186
Ref: howto/argparse combining-positional-and-optional-arguments11836361
Ref: 413d11836361
Node: Getting a little more advanced11843945
Ref: howto/argparse getting-a-little-more-advanced11844100
Ref: 413e11844100
Node: Conflicting options11845921
Ref: howto/argparse conflicting-options11846007
Ref: 413f11846007
Node: Conclusion11848927
Ref: howto/argparse conclusion11849030
Ref: 414011849030
Node: An introduction to the ipaddress module11849295
Ref: howto/ipaddress doc11849441
Ref: 414111849441
Ref: howto/ipaddress an-introduction-to-the-ipaddress-module11849441
Ref: 414211849441
Ref: howto/ipaddress ipaddress-howto11849441
Ref: 2e3f11849441
Node: Creating Address/Network/Interface objects11850184
Ref: howto/ipaddress creating-address-network-interface-objects11850355
Ref: 414311850355
Node: A Note on IP Versions11850782
Ref: howto/ipaddress a-note-on-ip-versions11850908
Ref: 414411850908
Node: IP Host Addresses11851691
Ref: howto/ipaddress ip-host-addresses11851843
Ref: 414511851843
Node: Defining Networks11852975
Ref: howto/ipaddress defining-networks11853121
Ref: 414611853121
Node: Host Interfaces11855424
Ref: howto/ipaddress host-interfaces11855544
Ref: 414711855544
Node: Inspecting Address/Network/Interface Objects11856534
Ref: howto/ipaddress inspecting-address-network-interface-objects11856744
Ref: 414811856744
Node: Networks as lists of Addresses11858891
Ref: howto/ipaddress networks-as-lists-of-addresses11859073
Ref: 414911859073
Node: Comparisons<4>11859812
Ref: howto/ipaddress comparisons11859987
Ref: 414a11859987
Node: Using IP Addresses with other modules11860341
Ref: howto/ipaddress using-ip-addresses-with-other-modules11860534
Ref: 414b11860534
Node: Getting more detail when instance creation fails11860945
Ref: howto/ipaddress getting-more-detail-when-instance-creation-fails11861115
Ref: 414c11861115
Node: Argument Clinic How-To11863083
Ref: howto/clinic doc11863259
Ref: 414d11863259
Ref: howto/clinic argument-clinic-how-to11863259
Ref: 414e11863259
Node: The Goals Of Argument Clinic11864296
Ref: howto/clinic the-goals-of-argument-clinic11864416
Ref: 414f11864416
Node: Basic Concepts And Usage11866782
Ref: howto/clinic basic-concepts-and-usage11866941
Ref: 415011866941
Node: Converting Your First Function11869356
Ref: howto/clinic converting-your-first-function11869502
Ref: 415111869502
Node: Advanced Topics11884710
Ref: howto/clinic advanced-topics11884823
Ref: 415311884823
Node: Symbolic default values11885803
Ref: howto/clinic symbolic-default-values11885954
Ref: 415411885954
Node: Renaming the C functions and variables generated by Argument Clinic11886584
Ref: howto/clinic renaming-the-c-functions-and-variables-generated-by-argument-clinic11886788
Ref: 415511886788
Node: Converting functions using PyArg_UnpackTuple11888411
Ref: howto/clinic converting-functions-using-pyarg-unpacktuple11888607
Ref: 415611888607
Node: Optional Groups11889152
Ref: howto/clinic optional-groups11889353
Ref: 415711889353
Node: Using real Argument Clinic converters instead of “legacy converters”11893327
Ref: howto/clinic using-real-argument-clinic-converters-instead-of-legacy-converters11893493
Ref: 415811893493
Ref: Using real Argument Clinic converters instead of “legacy converters”-Footnote-111902401
Node: Py_buffer11902450
Ref: howto/clinic py-buffer11902620
Ref: 415911902620
Node: Advanced converters11902936
Ref: howto/clinic advanced-converters11903058
Ref: 415a11903058
Node: Parameter default values11904763
Ref: howto/clinic default-values11904898
Ref: 415211904898
Ref: howto/clinic parameter-default-values11904898
Ref: 415b11904898
Node: The NULL default value11905407
Ref: howto/clinic the-null-default-value11905562
Ref: 415c11905562
Node: Expressions specified as default values11906036
Ref: howto/clinic expressions-specified-as-default-values11906191
Ref: 415d11906191
Node: Using a return converter11908586
Ref: howto/clinic using-a-return-converter11908745
Ref: 415e11908745
Node: Cloning existing functions11911345
Ref: howto/clinic cloning-existing-functions11911484
Ref: 415f11911484
Node: Calling Python code11912793
Ref: howto/clinic calling-python-code11912936
Ref: 416011912936
Node: Using a “self converter”11913825
Ref: howto/clinic using-a-self-converter11913968
Ref: 416111913968
Node: Writing a custom converter11915634
Ref: howto/clinic writing-a-custom-converter11915791
Ref: 416211915791
Node: Writing a custom return converter11919470
Ref: howto/clinic writing-a-custom-return-converter11919621
Ref: 416311919621
Node: METH_O and METH_NOARGS11920200
Ref: howto/clinic meth-o-and-meth-noargs11920353
Ref: 416411920353
Node: tp_new and tp_init functions11920904
Ref: howto/clinic tp-new-and-tp-init-functions11921066
Ref: 416511921066
Node: Changing and redirecting Clinic’s output11922011
Ref: howto/clinic changing-and-redirecting-clinic-s-output11922167
Ref: 416611922167
Node: The #ifdef trick11933372
Ref: howto/clinic the-ifdef-trick11933537
Ref: 416711933537
Node: Using Argument Clinic in Python files11936224
Ref: howto/clinic using-argument-clinic-in-python-files11936338
Ref: 416811936338
Node: Instrumenting CPython with DTrace and SystemTap11937014
Ref: howto/instrumentation doc11937142
Ref: 416911937142
Ref: howto/instrumentation instrumentation11937142
Ref: 50111937142
Ref: howto/instrumentation instrumenting-cpython-with-dtrace-and-systemtap11937142
Ref: 416a11937142
Node: Enabling the static markers11938340
Ref: howto/instrumentation enabling-the-static-markers11938480
Ref: 416b11938480
Node: Static DTrace probes11942417
Ref: howto/instrumentation static-dtrace-probes11942590
Ref: 416c11942590
Node: Static SystemTap markers11944816
Ref: howto/instrumentation static-systemtap-markers11944986
Ref: 416d11944986
Node: Available static markers11946931
Ref: howto/instrumentation available-static-markers11947098
Ref: 416e11947098
Ref: howto/instrumentation c function__entry11947165
Ref: 416f11947165
Ref: howto/instrumentation c function__return11947866
Ref: 417011947866
Ref: howto/instrumentation c line11948273
Ref: 417111948273
Ref: howto/instrumentation c gc__start11948595
Ref: 417211948595
Ref: howto/instrumentation c gc__done11948793
Ref: 417311948793
Ref: howto/instrumentation c import__find__load__start11948966
Ref: 41911948966
Ref: howto/instrumentation c import__find__load__done11949167
Ref: 41a11949167
Ref: howto/instrumentation c audit11949438
Ref: 417411949438
Node: SystemTap Tapsets11949711
Ref: howto/instrumentation systemtap-tapsets11949866
Ref: 417511949866
Ref: howto/instrumentation c python function entry11950810
Ref: 417611950810
Ref: howto/instrumentation c python function return11951055
Ref: 417711951055
Node: Examples<36>11951419
Ref: howto/instrumentation examples11951541
Ref: 417811951541
Node: Python Frequently Asked Questions11952744
Ref: faq/index doc11952856
Ref: 417911952856
Ref: faq/index faq-index11952856
Ref: 125211952856
Ref: faq/index python-frequently-asked-questions11952856
Ref: 417a11952856
Node: General Python FAQ11953180
Ref: faq/general doc11953292
Ref: 417b11953292
Ref: faq/general general-python-faq11953292
Ref: 417c11953292
Node: General Information11953404
Ref: faq/general general-information11953511
Ref: 417d11953511
Node: What is Python?11954500
Ref: faq/general what-is-python11954619
Ref: 417e11954619
Ref: What is Python?-Footnote-111955443
Node: What is the Python Software Foundation?11955495
Ref: faq/general what-is-the-python-software-foundation11955677
Ref: 417f11955677
Ref: What is the Python Software Foundation?-Footnote-111956281
Node: Are there copyright restrictions on the use of Python?11956327
Ref: faq/general are-there-copyright-restrictions-on-the-use-of-python11956536
Ref: 418011956536
Ref: Are there copyright restrictions on the use of Python?-Footnote-111957408
Ref: Are there copyright restrictions on the use of Python?-Footnote-211957452
Node: Why was Python created in the first place?11957499
Ref: faq/general why-was-python-created-in-the-first-place11957693
Ref: 418111957693
Node: What is Python good for?11960025
Ref: faq/general what-is-python-good-for11960215
Ref: 418211960215
Ref: What is Python good for?-Footnote-111961085
Node: How does the Python version numbering scheme work?11961110
Ref: faq/general how-does-the-python-version-numbering-scheme-work11961302
Ref: 418311961302
Ref: How does the Python version numbering scheme work?-Footnote-111963175
Node: How do I obtain a copy of the Python source?11963224
Ref: faq/general how-do-i-obtain-a-copy-of-the-python-source11963429
Ref: 418411963429
Ref: How do I obtain a copy of the Python source?-Footnote-111964213
Node: How do I get documentation on Python?11964256
Ref: faq/general how-do-i-get-documentation-on-python11964469
Ref: 418511964469
Ref: How do I get documentation on Python?-Footnote-111965032
Node: I’ve never programmed before Is there a Python tutorial?11965063
Ref: faq/general i-ve-never-programmed-before-is-there-a-python-tutorial11965287
Ref: 418611965287
Ref: I’ve never programmed before Is there a Python tutorial?-Footnote-111965700
Node: Is there a newsgroup or mailing list devoted to Python?11965752
Ref: faq/general is-there-a-newsgroup-or-mailing-list-devoted-to-python11965982
Ref: 418711965982
Ref: Is there a newsgroup or mailing list devoted to Python?-Footnote-111966861
Ref: Is there a newsgroup or mailing list devoted to Python?-Footnote-211966922
Node: How do I get a beta test version of Python?11966992
Ref: faq/general how-do-i-get-a-beta-test-version-of-python11967215
Ref: 418811967215
Ref: How do I get a beta test version of Python?-Footnote-111967754
Node: How do I submit bug reports and patches for Python?11967791
Ref: faq/general how-do-i-submit-bug-reports-and-patches-for-python11968026
Ref: 418911968026
Ref: How do I submit bug reports and patches for Python?-Footnote-111968737
Ref: How do I submit bug reports and patches for Python?-Footnote-211968794
Node: Are there any published articles about Python that I can reference?11968831
Ref: faq/general are-there-any-published-articles-about-python-that-i-can-reference11969053
Ref: 418a11969053
Node: Are there any books on Python?11969566
Ref: faq/general are-there-any-books-on-python11969782
Ref: 418b11969782
Node: Where in the world is www python org located?11970159
Ref: faq/general where-in-the-world-is-www-python-org-located11970332
Ref: 418c11970332
Ref: Where in the world is www python org located?-Footnote-111970618
Node: Why is it called Python?11970646
Ref: faq/general why-is-it-called-python11970844
Ref: 418d11970844
Ref: Why is it called Python?-Footnote-111971250
Node: Do I have to like “Monty Python’s Flying Circus”?11971301
Ref: faq/general do-i-have-to-like-monty-python-s-flying-circus11971445
Ref: 418e11971445
Node: Python in the real world11971595
Ref: faq/general python-in-the-real-world11971702
Ref: 418f11971702
Node: How stable is Python?11972082
Ref: faq/general how-stable-is-python11972206
Ref: 419011972206
Ref: How stable is Python?-Footnote-111973228
Ref: How stable is Python?-Footnote-211973270
Node: How many people are using Python?11973320
Ref: faq/general how-many-people-are-using-python11973503
Ref: 419111973503
Node: Have any significant projects been done in Python?11974018
Ref: faq/general have-any-significant-projects-been-done-in-python11974240
Ref: 419211974240
Ref: Have any significant projects been done in Python?-Footnote-111974954
Ref: Have any significant projects been done in Python?-Footnote-211975006
Ref: Have any significant projects been done in Python?-Footnote-311975034
Ref: Have any significant projects been done in Python?-Footnote-411975062
Node: What new developments are expected for Python in the future?11975093
Ref: faq/general what-new-developments-are-expected-for-python-in-the-future11975341
Ref: 419311975341
Ref: What new developments are expected for Python in the future?-Footnote-111975930
Node: Is it reasonable to propose incompatible changes to Python?11975991
Ref: faq/general is-it-reasonable-to-propose-incompatible-changes-to-python11976241
Ref: 419411976241
Ref: Is it reasonable to propose incompatible changes to Python?-Footnote-111977045
Node: Is Python a good language for beginning programmers?11977094
Ref: faq/general is-python-a-good-language-for-beginning-programmers11977275
Ref: 419511977275
Ref: Is Python a good language for beginning programmers?-Footnote-111981040
Ref: Is Python a good language for beginning programmers?-Footnote-211981091
Node: Programming FAQ11981153
Ref: faq/programming doc11981296
Ref: 419611981296
Ref: faq/programming programming-faq11981296
Ref: 419711981296
Node: General Questions11981531
Ref: faq/programming general-questions11981622
Ref: 419811981622
Node: Is there a source code level debugger with breakpoints single-stepping etc ?11982042
Ref: faq/programming is-there-a-source-code-level-debugger-with-breakpoints-single-stepping-etc11982242
Ref: 419911982242
Ref: Is there a source code level debugger with breakpoints single-stepping etc ?-Footnote-111984299
Ref: Is there a source code level debugger with breakpoints single-stepping etc ?-Footnote-211984349
Ref: Is there a source code level debugger with breakpoints single-stepping etc ?-Footnote-311984397
Node: Is there a tool to help find bugs or perform static analysis?11984442
Ref: faq/programming is-there-a-tool-to-help-find-bugs-or-perform-static-analysis11984710
Ref: 419a11984710
Ref: Is there a tool to help find bugs or perform static analysis?-Footnote-111985676
Ref: Is there a tool to help find bugs or perform static analysis?-Footnote-211985708
Ref: Is there a tool to help find bugs or perform static analysis?-Footnote-311985738
Ref: Is there a tool to help find bugs or perform static analysis?-Footnote-411985770
Node: How can I create a stand-alone binary from a Python script?11985811
Ref: faq/programming how-can-i-create-a-stand-alone-binary-from-a-python-script11986067
Ref: 419b11986067
Ref: How can I create a stand-alone binary from a Python script?-Footnote-111987724
Node: Are there coding standards or a style guide for Python programs?11987778
Ref: faq/programming are-there-coding-standards-or-a-style-guide-for-python-programs11987964
Ref: 419c11987964
Ref: Are there coding standards or a style guide for Python programs?-Footnote-111988238
Node: Core Language11988287
Ref: faq/programming core-language11988406
Ref: 419d11988406
Node: Why am I getting an UnboundLocalError when the variable has a value?11989776
Ref: faq/programming why-am-i-getting-an-unboundlocalerror-when-the-variable-has-a-value11989963
Ref: 419e11989963
Node: What are the rules for local and global variables in Python?11991687
Ref: faq/programming what-are-the-rules-for-local-and-global-variables-in-python11991965
Ref: 419f11991965
Node: Why do lambdas defined in a loop with different values all return the same result?11992866
Ref: faq/programming why-do-lambdas-defined-in-a-loop-with-different-values-all-return-the-same-result11993123
Ref: 41a011993123
Node: How do I share global variables across modules?11994972
Ref: faq/programming how-do-i-share-global-variables-across-modules11995232
Ref: 41a111995232
Node: What are the “best practices” for using import in a module?11996020
Ref: faq/programming what-are-the-best-practices-for-using-import-in-a-module11996244
Ref: 41a211996244
Node: Why are default values shared between objects?11999000
Ref: faq/programming why-are-default-values-shared-between-objects11999252
Ref: 41a311999252
Node: How can I pass optional or keyword parameters from one function to another?12001575
Ref: faq/programming how-can-i-pass-optional-or-keyword-parameters-from-one-function-to-another12001820
Ref: 41a412001820
Node: What is the difference between arguments and parameters?12002387
Ref: faq/programming faq-argument-vs-parameter12002641
Ref: 41a512002641
Ref: faq/programming what-is-the-difference-between-arguments-and-parameters12002641
Ref: 41a612002641
Node: Why did changing list ‘y’ also change list ‘x’?12003326
Ref: faq/programming why-did-changing-list-y-also-change-list-x12003573
Ref: 41a712003573
Node: How do I write a function with output parameters call by reference ?12006916
Ref: faq/programming how-do-i-write-a-function-with-output-parameters-call-by-reference12007157
Ref: 41a812007157
Node: How do you make a higher order function in Python?12009147
Ref: faq/programming how-do-you-make-a-higher-order-function-in-python12009367
Ref: 41a912009367
Node: How do I copy an object in Python?12010846
Ref: faq/programming how-do-i-copy-an-object-in-python12011052
Ref: 41aa12011052
Node: How can I find the methods or attributes of an object?12011459
Ref: faq/programming how-can-i-find-the-methods-or-attributes-of-an-object12011662
Ref: 41ab12011662
Node: How can my code discover the name of an object?12011976
Ref: faq/programming how-can-my-code-discover-the-name-of-an-object12012196
Ref: 41ac12012196
Node: What’s up with the comma operator’s precedence?12013771
Ref: faq/programming what-s-up-with-the-comma-operator-s-precedence12013995
Ref: 41ad12013995
Node: Is there an equivalent of C’s “? ” ternary operator?12014548
Ref: faq/programming is-there-an-equivalent-of-c-s-ternary-operator12014781
Ref: 41ae12014781
Node: Is it possible to write obfuscated one-liners in Python?12015366
Ref: faq/programming is-it-possible-to-write-obfuscated-one-liners-in-python12015611
Ref: 41af12015611
Node: What does the slash / in the parameter list of a function mean?12016995
Ref: faq/programming faq-positional-only-arguments12017173
Ref: 152e12017173
Ref: faq/programming what-does-the-slash-in-the-parameter-list-of-a-function-mean12017173
Ref: 41b012017173
Node: Numbers and strings12018243
Ref: faq/programming numbers-and-strings12018359
Ref: 41b112018359
Node: How do I specify hexadecimal and octal integers?12019031
Ref: faq/programming how-do-i-specify-hexadecimal-and-octal-integers12019173
Ref: 41b212019173
Node: Why does -22 // 10 return -3?12019787
Ref: faq/programming why-does-22-10-return-312019976
Ref: 41b312019976
Node: How do I convert a string to a number?12020737
Ref: faq/programming how-do-i-convert-a-string-to-a-number12020916
Ref: 41b412020916
Node: How do I convert a number to a string?12022228
Ref: faq/programming how-do-i-convert-a-number-to-a-string12022412
Ref: 41b512022412
Node: How do I modify a string in place?12022963
Ref: faq/programming how-do-i-modify-a-string-in-place12023156
Ref: 41b612023156
Node: How do I use strings to call functions/methods?12023917
Ref: faq/programming how-do-i-use-strings-to-call-functions-methods12024157
Ref: 41b712024157
Node: Is there an equivalent to Perl’s chomp for removing trailing newlines from strings?12025602
Ref: faq/programming is-there-an-equivalent-to-perl-s-chomp-for-removing-trailing-newlines-from-strings12025846
Ref: 41b812025846
Node: Is there a scanf or sscanf equivalent?12026585
Ref: faq/programming is-there-a-scanf-or-sscanf-equivalent12026856
Ref: 41b912026856
Node: What does ‘UnicodeDecodeError’ or ‘UnicodeEncodeError’ error mean?12027507
Ref: faq/programming what-does-unicodedecodeerror-or-unicodeencodeerror-error-mean12027684
Ref: 41ba12027684
Node: Performance<4>12027880
Ref: faq/programming performance12028005
Ref: 41bb12028005
Node: My program is too slow How do I speed it up?12028222
Ref: faq/programming my-program-is-too-slow-how-do-i-speed-it-up12028394
Ref: 41bc12028394
Ref: My program is too slow How do I speed it up?-Footnote-112031275
Ref: My program is too slow How do I speed it up?-Footnote-212031301
Node: What is the most efficient way to concatenate many strings together?12031366
Ref: faq/programming efficient-string-concatenation12031538
Ref: 41bd12031538
Ref: faq/programming what-is-the-most-efficient-way-to-concatenate-many-strings-together12031538
Ref: 41be12031538
Node: Sequences Tuples/Lists12032483
Ref: faq/programming sequences-tuples-lists12032596
Ref: 41bf12032596
Node: How do I convert between tuples and lists?12033291
Ref: faq/programming how-do-i-convert-between-tuples-and-lists12033427
Ref: 41c012033427
Node: What’s a negative index?12034274
Ref: faq/programming what-s-a-negative-index12034469
Ref: 41c112034469
Node: How do I iterate over a sequence in reverse order?12035049
Ref: faq/programming how-do-i-iterate-over-a-sequence-in-reverse-order12035243
Ref: 41c212035243
Node: How do you remove duplicates from a list?12035737
Ref: faq/programming how-do-you-remove-duplicates-from-a-list12035940
Ref: 41c312035940
Node: How do you make an array in Python?12036733
Ref: faq/programming how-do-you-make-an-array-in-python12036926
Ref: 41c412036926
Node: How do I create a multidimensional list?12037910
Ref: faq/programming faq-multidimensional-list12038111
Ref: 156c12038111
Ref: faq/programming how-do-i-create-a-multidimensional-list12038111
Ref: 41c512038111
Ref: How do I create a multidimensional list?-Footnote-112039303
Node: How do I apply a method to a sequence of objects?12039333
Ref: faq/programming how-do-i-apply-a-method-to-a-sequence-of-objects12039578
Ref: 41c612039578
Node: Why does a_tuple[i] += [‘item’] raise an exception when the addition works?12039772
Ref: faq/programming faq-augmented-assignment-tuple-error12040054
Ref: 13b812040054
Ref: faq/programming why-does-a-tuple-i-item-raise-an-exception-when-the-addition-works12040054
Ref: 41c712040054
Node: I want to do a complicated sort can you do a Schwartzian Transform in Python?12043173
Ref: faq/programming i-want-to-do-a-complicated-sort-can-you-do-a-schwartzian-transform-in-python12043458
Ref: 41c812043458
Node: How can I sort one list by values from another list?12043936
Ref: faq/programming how-can-i-sort-one-list-by-values-from-another-list12044133
Ref: 41c912044133
Node: Objects12045302
Ref: faq/programming objects12045411
Ref: 41ca12045411
Node: What is a class?12046420
Ref: faq/programming what-is-a-class12046506
Ref: 41cb12046506
Node: What is a method?12047232
Ref: faq/programming what-is-a-method12047340
Ref: 41cc12047340
Node: What is self?12047639
Ref: faq/programming what-is-self12047814
Ref: 41cd12047814
Node: How do I check if an object is an instance of a given class or of a subclass of it?12048256
Ref: faq/programming how-do-i-check-if-an-object-is-an-instance-of-a-given-class-or-of-a-subclass-of-it12048433
Ref: 41cf12048433
Node: What is delegation?12049869
Ref: faq/programming what-is-delegation12050119
Ref: 41d012050119
Node: How do I call a method defined in a base class from a derived class that overrides it?12051921
Ref: faq/programming how-do-i-call-a-method-defined-in-a-base-class-from-a-derived-class-that-overrides-it12052158
Ref: 41d112052158
Node: How can I organize my code to make it easier to change the base class?12052833
Ref: faq/programming how-can-i-organize-my-code-to-make-it-easier-to-change-the-base-class12053110
Ref: 41d212053110
Node: How do I create static class data and static class methods?12053765
Ref: faq/programming how-do-i-create-static-class-data-and-static-class-methods12054009
Ref: 41d312054009
Node: How can I overload constructors or methods in Python?12055528
Ref: faq/programming how-can-i-overload-constructors-or-methods-in-python12055767
Ref: 41d412055767
Node: I try to use __spam and I get an error about _SomeClassName__spam12056629
Ref: faq/programming i-try-to-use-spam-and-i-get-an-error-about-someclassname-spam12056879
Ref: 41d512056879
Node: My class defines __del__ but it is not called when I delete the object12057680
Ref: faq/programming my-class-defines-del-but-it-is-not-called-when-i-delete-the-object12057931
Ref: 41d612057931
Node: How do I get a list of all instances of a given class?12059905
Ref: faq/programming how-do-i-get-a-list-of-all-instances-of-a-given-class12060141
Ref: 41d712060141
Node: Why does the result of id appear to be not unique?12060482
Ref: faq/programming why-does-the-result-of-id-appear-to-be-not-unique12060639
Ref: 41d812060639
Node: Modules<3>12061564
Ref: faq/programming modules12061642
Ref: 41d912061642
Node: How do I create a pyc file?12062182
Ref: faq/programming how-do-i-create-a-pyc-file12062303
Ref: 41da12062303
Ref: How do I create a pyc file?-Footnote-112064879
Node: How do I find the current module name?12064928
Ref: faq/programming how-do-i-find-the-current-module-name12065113
Ref: 41db12065113
Node: How can I have modules that mutually import each other?12065651
Ref: faq/programming how-can-i-have-modules-that-mutually-import-each-other12065873
Ref: 41dc12065873
Node: __import__ ‘x y z’ returns <module ‘x’>; how do I get z?12067749
Ref: faq/programming import-x-y-z-returns-module-x-how-do-i-get-z12068029
Ref: 41dd12068029
Node: When I edit an imported module and reimport it the changes don’t show up Why does this happen?12068319
Ref: faq/programming when-i-edit-an-imported-module-and-reimport-it-the-changes-don-t-show-up-why-does-this-happen12068535
Ref: 41de12068535
Node: Design and History FAQ12069927
Ref: faq/design doc12070077
Ref: 41df12070077
Ref: faq/design design-and-history-faq12070077
Ref: 41e012070077
Node: Why does Python use indentation for grouping of statements?12072121
Ref: faq/design why-does-python-use-indentation-for-grouping-of-statements12072315
Ref: 41e112072315
Node: Why am I getting strange results with simple arithmetic operations?12074002
Ref: faq/design why-am-i-getting-strange-results-with-simple-arithmetic-operations12074255
Ref: 41e212074255
Node: Why are floating-point calculations so inaccurate?12074430
Ref: faq/design why-are-floating-point-calculations-so-inaccurate12074657
Ref: 41e312074657
Node: Why are Python strings immutable?12076191
Ref: faq/design why-are-python-strings-immutable12076422
Ref: 41e412076422
Node: Why must ‘self’ be used explicitly in method definitions and calls?12077025
Ref: faq/design why-must-self-be-used-explicitly-in-method-definitions-and-calls12077255
Ref: 41e512077255
Ref: faq/design why-self12077255
Ref: 41ce12077255
Node: Why can’t I use an assignment in an expression?12079745
Ref: faq/design why-can-t-i-use-an-assignment-in-an-expression12080046
Ref: 41e612080046
Ref: Why can’t I use an assignment in an expression?-Footnote-112080413
Node: Why does Python use methods for some functionality e g list index but functions for other e g len list ?12080462
Ref: faq/design why-does-python-use-methods-for-some-functionality-e-g-list-index-but-functions-for-other-e-g-len-list12080754
Ref: 41e712080754
Node: Why is join a string method instead of a list or tuple method?12082093
Ref: faq/design why-is-join-a-string-method-instead-of-a-list-or-tuple-method12082360
Ref: 41e812082360
Node: How fast are exceptions?12084171
Ref: faq/design how-fast-are-exceptions12084389
Ref: 41e912084389
Node: Why isn’t there a switch or case statement in Python?12085167
Ref: faq/design why-isn-t-there-a-switch-or-case-statement-in-python12085429
Ref: 41ea12085429
Ref: Why isn’t there a switch or case statement in Python?-Footnote-112086742
Node: Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?12086791
Ref: faq/design can-t-you-emulate-threads-in-the-interpreter-instead-of-relying-on-an-os-specific-thread-implementation12087079
Ref: 41eb12087079
Ref: Can’t you emulate threads in the interpreter instead of relying on an OS-specific thread implementation?-Footnote-112087726
Node: Why can’t lambda expressions contain statements?12087782
Ref: faq/design why-can-t-lambda-expressions-contain-statements12088079
Ref: 41ec12088079
Node: Can Python be compiled to machine code C or some other language?12088944
Ref: faq/design can-python-be-compiled-to-machine-code-c-or-some-other-language12089165
Ref: 41ed12089165
Ref: Can Python be compiled to machine code C or some other language?-Footnote-112089600
Ref: Can Python be compiled to machine code C or some other language?-Footnote-212089627
Ref: Can Python be compiled to machine code C or some other language?-Footnote-312089658
Node: How does Python manage memory?12089693
Ref: faq/design how-does-python-manage-memory12089935
Ref: 41ee12089935
Ref: How does Python manage memory?-Footnote-112091584
Ref: How does Python manage memory?-Footnote-212091614
Node: Why doesn’t CPython use a more traditional garbage collection scheme?12091642
Ref: faq/design why-doesn-t-cpython-use-a-more-traditional-garbage-collection-scheme12091868
Ref: 41ef12091868
Node: Why isn’t all memory freed when CPython exits?12092784
Ref: faq/design why-isn-t-all-memory-freed-when-cpython-exits12093029
Ref: 41f012093029
Node: Why are there separate tuple and list data types?12093724
Ref: faq/design why-are-there-separate-tuple-and-list-data-types12093935
Ref: 41f112093935
Node: How are lists implemented in CPython?12095169
Ref: faq/design how-are-lists-implemented-in-cpython12095376
Ref: 41f212095376
Node: How are dictionaries implemented in CPython?12096117
Ref: faq/design how-are-dictionaries-implemented-in-cpython12096313
Ref: 41f312096313
Node: Why must dictionary keys be immutable?12097264
Ref: faq/design why-must-dictionary-keys-be-immutable12097470
Ref: 41f412097470
Node: Why doesn’t list sort return the sorted list?12101598
Ref: faq/design why-doesn-t-list-sort-return-the-sorted-list12101819
Ref: 41f512101819
Node: How do you specify and enforce an interface spec in Python?12102658
Ref: faq/design how-do-you-specify-and-enforce-an-interface-spec-in-python12102862
Ref: 41f612102862
Node: Why is there no goto?12105284
Ref: faq/design why-is-there-no-goto12105496
Ref: 41f712105496
Node: Why can’t raw strings r-strings end with a backslash?12106118
Ref: faq/design why-can-t-raw-strings-r-strings-end-with-a-backslash12106346
Ref: 41f812106346
Node: Why doesn’t Python have a “with” statement for attribute assignments?12107437
Ref: faq/design why-doesn-t-python-have-a-with-statement-for-attribute-assignments12107706
Ref: 41f912107706
Node: Why are colons required for the if/while/def/class statements?12109862
Ref: faq/design why-are-colons-required-for-the-if-while-def-class-statements12110136
Ref: 41fa12110136
Node: Why does Python allow commas at the end of lists and tuples?12110871
Ref: faq/design why-does-python-allow-commas-at-the-end-of-lists-and-tuples12111061
Ref: 41fb12111061
Node: Library and Extension FAQ12112112
Ref: faq/library doc12112270
Ref: 41fc12112270
Ref: faq/library library-and-extension-faq12112270
Ref: 41fd12112270
Node: General Library Questions12112519
Ref: faq/library general-library-questions12112627
Ref: 41fe12112627
Node: How do I find a module or application to perform task X?12113139
Ref: faq/library how-do-i-find-a-module-or-application-to-perform-task-x12113322
Ref: 41ff12113322
Ref: How do I find a module or application to perform task X?-Footnote-112113910
Ref: How do I find a module or application to perform task X?-Footnote-212113935
Node: Where is the math py socket py regex py etc source file?12113966
Ref: faq/library where-is-the-math-py-socket-py-regex-py-etc-source-file12114207
Ref: 420012114207
Node: How do I make a Python script executable on Unix?12114981
Ref: faq/library how-do-i-make-a-python-script-executable-on-unix12115211
Ref: 420112115211
Node: Is there a curses/termcap package for Python?12116673
Ref: faq/library is-there-a-curses-termcap-package-for-python12116896
Ref: 420212116896
Ref: Is there a curses/termcap package for Python?-Footnote-112117735
Ref: Is there a curses/termcap package for Python?-Footnote-212117794
Node: Is there an equivalent to C’s onexit in Python?12117843
Ref: faq/library is-there-an-equivalent-to-c-s-onexit-in-python12118053
Ref: 420312118053
Node: Why don’t my signal handlers work?12118273
Ref: faq/library why-don-t-my-signal-handlers-work12118429
Ref: 420412118429
Node: Common tasks12118748
Ref: faq/library common-tasks12118872
Ref: 420512118872
Node: How do I test a Python program or component?12119070
Ref: faq/library how-do-i-test-a-python-program-or-component12119219
Ref: 420612119219
Node: How do I create documentation from doc strings?12121160
Ref: faq/library how-do-i-create-documentation-from-doc-strings12121359
Ref: 420712121359
Ref: How do I create documentation from doc strings?-Footnote-112121735
Ref: How do I create documentation from doc strings?-Footnote-212121774
Node: How do I get a single keypress at a time?12121804
Ref: faq/library how-do-i-get-a-single-keypress-at-a-time12121950
Ref: 420812121950
Node: Threads12122196
Ref: faq/library threads12122314
Ref: 420912122314
Node: How do I program using threads?12122642
Ref: faq/library how-do-i-program-using-threads12122761
Ref: 420a12122761
Node: None of my threads seem to run why?12123194
Ref: faq/library none-of-my-threads-seem-to-run-why12123379
Ref: 420b12123379
Node: How do I parcel out work among a bunch of worker threads?12124858
Ref: faq/library how-do-i-parcel-out-work-among-a-bunch-of-worker-threads12125064
Ref: 420c12125064
Node: What kinds of global value mutation are thread-safe?12127459
Ref: faq/library what-kinds-of-global-value-mutation-are-thread-safe12127680
Ref: 420d12127680
Node: Can’t we get rid of the Global Interpreter Lock?12129121
Ref: faq/library can-t-we-get-rid-of-the-global-interpreter-lock12129276
Ref: 420e12129276
Ref: Can’t we get rid of the Global Interpreter Lock?-Footnote-112131967
Node: Input and Output<2>12132027
Ref: faq/library input-and-output12132161
Ref: 420f12132161
Node: How do I delete a file? And other file questions…12132796
Ref: faq/library how-do-i-delete-a-file-and-other-file-questions12132933
Ref: 421012132933
Node: How do I copy a file?12134183
Ref: faq/library how-do-i-copy-a-file12134364
Ref: 421112134364
Node: How do I read or write binary data?12134575
Ref: faq/library how-do-i-read-or-write-binary-data12134773
Ref: 421212134773
Node: I can’t seem to use os read on a pipe created with os popen ; why?12135955
Ref: faq/library i-can-t-seem-to-use-os-read-on-a-pipe-created-with-os-popen-why12136170
Ref: 421312136170
Node: How do I access the serial RS232 port?12136691
Ref: faq/library how-do-i-access-the-serial-rs232-port12136933
Ref: 421412136933
Node: Why doesn’t closing sys stdout stdin stderr really close it?12137245
Ref: faq/library why-doesn-t-closing-sys-stdout-stdin-stderr-really-close-it12137410
Ref: 421512137410
Node: Network/Internet Programming12138627
Ref: faq/library network-internet-programming12138763
Ref: 421612138763
Node: What WWW tools are there for Python?12139220
Ref: faq/library what-www-tools-are-there-for-python12139379
Ref: 421712139379
Node: How can I mimic CGI form submission METHOD=POST ?12139963
Ref: faq/library how-can-i-mimic-cgi-form-submission-method-post12140185
Ref: 421812140185
Node: What module should I use to help with generating HTML?12141239
Ref: faq/library what-module-should-i-use-to-help-with-generating-html12141465
Ref: 421912141465
Ref: What module should I use to help with generating HTML?-Footnote-112141710
Node: How do I send mail from a Python script?12141762
Ref: faq/library how-do-i-send-mail-from-a-python-script12141997
Ref: 421a12141997
Node: How do I avoid blocking in the connect method of a socket?12143223
Ref: faq/library how-do-i-avoid-blocking-in-the-connect-method-of-a-socket12143395
Ref: 421b12143395
Ref: How do I avoid blocking in the connect method of a socket?-Footnote-112144647
Node: Databases12144687
Ref: faq/library databases12144828
Ref: 421c12144828
Node: Are there any interfaces to database packages in Python?12144989
Ref: faq/library are-there-any-interfaces-to-database-packages-in-python12145150
Ref: 421d12145150
Ref: Are there any interfaces to database packages in Python?-Footnote-112145656
Node: How do you implement persistent objects in Python?12145713
Ref: faq/library how-do-you-implement-persistent-objects-in-python12145874
Ref: 421e12145874
Node: Mathematics and Numerics12146275
Ref: faq/library mathematics-and-numerics12146379
Ref: 421f12146379
Node: How do I generate random numbers in Python?12146502
Ref: faq/library how-do-i-generate-random-numbers-in-python12146606
Ref: 422012146606
Node: Extending/Embedding FAQ12147550
Ref: faq/extending doc12147707
Ref: 422112147707
Ref: faq/extending extending-embedding-faq12147707
Ref: 422212147707
Node: Can I create my own functions in C?12149195
Ref: faq/extending can-i-create-my-own-functions-in-c12149336
Ref: 422312149336
Node: Can I create my own functions in C++?12149696
Ref: faq/extending id112149892
Ref: 422412149892
Node: Writing C is hard; are there any alternatives?12150279
Ref: faq/extending c-wrapper-software12150493
Ref: 422512150493
Ref: faq/extending writing-c-is-hard-are-there-any-alternatives12150493
Ref: 422612150493
Ref: Writing C is hard; are there any alternatives?-Footnote-112151262
Ref: Writing C is hard; are there any alternatives?-Footnote-212151288
Ref: Writing C is hard; are there any alternatives?-Footnote-312151355
Ref: Writing C is hard; are there any alternatives?-Footnote-412151383
Ref: Writing C is hard; are there any alternatives?-Footnote-512151441
Ref: Writing C is hard; are there any alternatives?-Footnote-612151477
Ref: Writing C is hard; are there any alternatives?-Footnote-712151533
Node: How can I execute arbitrary Python statements from C?12151572
Ref: faq/extending how-can-i-execute-arbitrary-python-statements-from-c12151806
Ref: 422712151806
Node: How can I evaluate an arbitrary Python expression from C?12152351
Ref: faq/extending how-can-i-evaluate-an-arbitrary-python-expression-from-c12152586
Ref: 422812152586
Node: How do I extract C values from a Python object?12152901
Ref: faq/extending how-do-i-extract-c-values-from-a-python-object12153148
Ref: 422912153148
Node: How do I use Py_BuildValue to create a tuple of arbitrary length?12154386
Ref: faq/extending how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length12154618
Ref: 422a12154618
Node: How do I call an object’s method from C?12154825
Ref: faq/extending how-do-i-call-an-object-s-method-from-c12155095
Ref: 422b12155095
Node: How do I catch the output from PyErr_Print or anything that prints to stdout/stderr ?12156280
Ref: faq/extending how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr12156535
Ref: 422c12156535
Node: How do I access a module written in Python from C?12157653
Ref: faq/extending how-do-i-access-a-module-written-in-python-from-c12157912
Ref: 422d12157912
Node: How do I interface to C++ objects from Python?12158746
Ref: faq/extending how-do-i-interface-to-c-objects-from-python12158982
Ref: 422e12158982
Node: I added a module using the Setup file and the make fails; why?12159554
Ref: faq/extending i-added-a-module-using-the-setup-file-and-the-make-fails-why12159768
Ref: 422f12159768
Node: How do I debug an extension?12160118
Ref: faq/extending how-do-i-debug-an-extension12160370
Ref: 423012160370
Node: I want to compile a Python module on my Linux system but some files are missing Why?12160896
Ref: faq/extending i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why12161148
Ref: 423112161148
Node: How do I tell “incomplete input” from “invalid input”?12161632
Ref: faq/extending how-do-i-tell-incomplete-input-from-invalid-input12161924
Ref: 423212161924
Node: How do I find undefined g++ symbols __builtin_new or __pure_virtual?12167456
Ref: faq/extending how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual12167774
Ref: 423312167774
Node: Can I create an object class with some methods implemented in C and others in Python e g through inheritance ?12168162
Ref: faq/extending can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance12168409
Ref: 423412168409
Node: Python on Windows FAQ12168962
Ref: faq/windows doc12169120
Ref: 423512169120
Ref: faq/windows python-on-windows-faq12169120
Ref: 423612169120
Ref: faq/windows windows-faq12169120
Ref: 423712169120
Node: How do I run a Python program under Windows?12169636
Ref: faq/windows faq-run-program-under-windows12169787
Ref: 423812169787
Ref: faq/windows how-do-i-run-a-python-program-under-windows12169787
Ref: 423912169787
Node: How do I make Python scripts executable?12173349
Ref: faq/windows how-do-i-make-python-scripts-executable12173557
Ref: 423a12173557
Node: Why does Python sometimes take so long to start?12174119
Ref: faq/windows why-does-python-sometimes-take-so-long-to-start12174332
Ref: 423b12174332
Node: How do I make an executable from a Python script?12175211
Ref: faq/windows how-do-i-make-an-executable-from-a-python-script12175418
Ref: 423c12175418
Ref: How do I make an executable from a Python script?-Footnote-112175840
Ref: How do I make an executable from a Python script?-Footnote-212175894
Node: Is a * pyd file the same as a DLL?12175925
Ref: faq/windows is-a-pyd-file-the-same-as-a-dll12176134
Ref: 423d12176134
Node: How can I embed Python into a Windows application?12177131
Ref: faq/windows how-can-i-embed-python-into-a-windows-application12177355
Ref: 423e12177355
Node: How do I keep editors from inserting tabs into my Python source?12181833
Ref: faq/windows how-do-i-keep-editors-from-inserting-tabs-into-my-python-source12182070
Ref: 423f12182070
Ref: How do I keep editors from inserting tabs into my Python source?-Footnote-112182947
Node: How do I check for a keypress without blocking?12182996
Ref: faq/windows how-do-i-check-for-a-keypress-without-blocking12183174
Ref: 424012183174
Node: Graphic User Interface FAQ12183512
Ref: faq/gui doc12183696
Ref: 424112183696
Ref: faq/gui graphic-user-interface-faq12183696
Ref: 424212183696
Node: General GUI Questions12183938
Ref: faq/gui general-gui-questions12184087
Ref: 424312184087
Node: What platform-independent GUI toolkits exist for Python?12184146
Ref: faq/gui what-platform-independent-gui-toolkits-exist-for-python12184357
Ref: 424412184357
Node: Tkinter12184776
Ref: faq/gui tkinter12184894
Ref: 424512184894
Ref: Tkinter-Footnote-112185363
Ref: Tkinter-Footnote-212185405
Node: wxWidgets12185432
Ref: faq/gui wxwidgets12185561
Ref: 424712185561
Ref: wxWidgets-Footnote-112186423
Node: Qt12186456
Ref: faq/gui qt12186582
Ref: 424612186582
Ref: Qt-Footnote-112187058
Ref: Qt-Footnote-212187117
Ref: Qt-Footnote-312187151
Ref: Qt-Footnote-412187215
Ref: Qt-Footnote-512187281
Node: Gtk+12187318
Ref: faq/gui gtk12187439
Ref: 424812187439
Ref: Gtk+-Footnote-112187767
Ref: Gtk+-Footnote-212187817
Ref: Gtk+-Footnote-312187870
Node: Kivy12187898
Ref: faq/gui kivy12188021
Ref: 424912188021
Ref: Kivy-Footnote-112188381
Node: FLTK12188407
Ref: faq/gui fltk12188532
Ref: 424a12188532
Ref: FLTK-Footnote-112188747
Ref: FLTK-Footnote-212188775
Node: OpenGL12188813
Ref: faq/gui opengl12188925
Ref: 424b12188925
Ref: OpenGL-Footnote-112189033
Node: What platform-specific GUI toolkits exist for Python?12189073
Ref: faq/gui what-platform-specific-gui-toolkits-exist-for-python12189280
Ref: 424c12189280
Ref: What platform-specific GUI toolkits exist for Python?-Footnote-112189734
Node: Tkinter questions12189775
Ref: faq/gui tkinter-questions12189917
Ref: 424d12189917
Node: How do I freeze Tkinter applications?12190183
Ref: faq/gui how-do-i-freeze-tkinter-applications12190334
Ref: 424e12190334
Node: Can I have Tk events handled while waiting for I/O?12191281
Ref: faq/gui can-i-have-tk-events-handled-while-waiting-for-i-o12191491
Ref: 424f12191491
Node: I can’t get key bindings to work in Tkinter why?12191966
Ref: faq/gui i-can-t-get-key-bindings-to-work-in-tkinter-why12192130
Ref: 425012192130
Node: “Why is Python Installed on my Computer?” FAQ12192682
Ref: faq/installed doc12192836
Ref: 425112192836
Ref: faq/installed why-is-python-installed-on-my-computer-faq12192836
Ref: 425212192836
Node: What is Python?<2>12193060
Ref: faq/installed what-is-python12193211
Ref: 425312193211
Ref: What is Python?<2>-Footnote-112193692
Node: Why is Python installed on my machine?12193744
Ref: faq/installed why-is-python-installed-on-my-machine12193924
Ref: 425412193924
Node: Can I delete Python?12195012
Ref: faq/installed can-i-delete-python12195165
Ref: 425512195165
Node: Glossary12195893
Ref: glossary doc12196013
Ref: 425612196013
Ref: glossary glossary12196013
Ref: 113912196013
Ref: glossary id112196013
Ref: 425712196013
Ref: glossary term12196038
Ref: 115212196038
Ref: glossary term-112196201
Ref: 115312196201
Ref: glossary term-2to312196595
Ref: f5a12196595
Ref: glossary term-abstract-base-class12197009
Ref: b2612197009
Ref: glossary term-annotation12197846
Ref: 425912197846
Ref: glossary term-argument12198419
Ref: 146212198419
Ref: glossary term-asynchronous-context-manager12199821
Ref: 63512199821
Ref: glossary term-asynchronous-generator12200055
Ref: 144112200055
Ref: glossary term-asynchronous-generator-iterator12200780
Ref: 356f12200780
Ref: glossary term-asynchronous-iterable12201530
Ref: 63412201530
Ref: glossary term-asynchronous-iterator12201753
Ref: 63912201753
Ref: glossary term-attribute12202168
Ref: 425c12202168
Ref: glossary term-awaitable12202368
Ref: 50e12202368
Ref: glossary term-bdfl12202565
Ref: 425d12202565
Ref: glossary term-binary-file12202662
Ref: 1bdb12202662
Ref: glossary term-bytes-like-object12203108
Ref: 5dd12203108
Ref: glossary term-bytecode12204093
Ref: 60912204093
Ref: glossary term-class12204823
Ref: 153d12204823
Ref: glossary term-class-variable12204988
Ref: 425e12204988
Ref: glossary term-coercion12205134
Ref: 425f12205134
Ref: glossary term-complex-number12205773
Ref: 426012205773
Ref: glossary term-context-manager12206544
Ref: 55d12206544
Ref: glossary term-context-variable12206745
Ref: 426112206745
Ref: glossary term-contiguous12207203
Ref: 15f112207203
Ref: glossary term-coroutine12207746
Ref: 1a512207746
Ref: glossary term-coroutine-function12208069
Ref: 63312208069
Ref: glossary term-cpython12208383
Ref: 137212208383
Ref: glossary term-decorator12208636
Ref: 28112208636
Ref: glossary term-descriptor12209299
Ref: 154112209299
Ref: glossary term-dictionary12210098
Ref: 426212210098
Ref: glossary term-dictionary-view12210304
Ref: 187e12210304
Ref: glossary term-docstring12210750
Ref: 14f112210750
Ref: glossary term-duck-typing12211141
Ref: 425812211141
Ref: glossary term-eafp12211845
Ref: 1e8812211845
Ref: glossary term-expression12212291
Ref: 356312212291
Ref: glossary term-extension-module12212805
Ref: 426412212805
Ref: glossary term-f-string12212933
Ref: 15b12212933
Ref: glossary term-file-object12213128
Ref: b3512213128
Ref: glossary term-file-like-object12213905
Ref: 1ba212213905
Ref: glossary term-finder12213967
Ref: 13f712213967
Ref: glossary term-floor-division12214358
Ref: 115812214358
Ref: glossary term-function12214734
Ref: 146112214734
Ref: glossary term-function-annotation12215042
Ref: 119712215042
Ref: glossary term-future12215630
Ref: 67712215630
Ref: glossary term-garbage-collection12216088
Ref: 124312216088
Ref: glossary term-generator12216408
Ref: 99612216408
Ref: glossary term-generator-iterator12216924
Ref: 44c12216924
Ref: glossary term-generator-expression12217322
Ref: 426512217322
Ref: glossary term-generic-function12217693
Ref: 1c812217693
Ref: glossary term-gil12218052
Ref: bdd12218052
Ref: glossary term-global-interpreter-lock12218103
Ref: 4fb12218103
Ref: glossary term-hash-based-pyc12219280
Ref: 426612219280
Ref: glossary term-hashable12219494
Ref: 136412219494
Ref: glossary term-idle12220409
Ref: 426712220409
Ref: glossary term-immutable12220587
Ref: 115c12220587
Ref: glossary term-import-path12220931
Ref: 13fa12220931
Ref: glossary term-importing12221270
Ref: 13ea12221270
Ref: glossary term-importer12221391
Ref: 13f912221391
Ref: glossary term-interactive12221517
Ref: 426812221517
Ref: glossary term-interpreted12221939
Ref: 426912221939
Ref: glossary term-interpreter-shutdown12222432
Ref: 75712222432
Ref: glossary term-iterable12223167
Ref: b9f12223167
Ref: glossary term-iterator12224363
Ref: f7312224363
Ref: glossary term-key-function12225585
Ref: 6d412225585
Ref: glossary term-keyword-argument12226756
Ref: 5b912226756
Ref: glossary term-lambda12226806
Ref: 360a12226806
Ref: glossary term-lbyl12227039
Ref: 426312227039
Ref: glossary term-list12227706
Ref: 426a12227706
Ref: glossary term-list-comprehension12227889
Ref: 426b12227889
Ref: glossary term-loader12228307
Ref: 13f812228307
Ref: glossary term-magic-method12228581
Ref: 426c12228581
Ref: glossary term-mapping12228653
Ref: b2c12228653
Ref: glossary term-meta-path-finder12229020
Ref: 9a512229020
Ref: glossary term-metaclass12229317
Ref: 226d12229317
Ref: glossary term-method12230057
Ref: 425b12230057
Ref: glossary term-method-resolution-order12230367
Ref: 153f12230367
Ref: glossary term-module12230644
Ref: 13e912230644
Ref: glossary term-module-spec12230907
Ref: 357312230907
Ref: glossary term-mro12231073
Ref: 27b312231073
Ref: glossary term-mutable12231125
Ref: 116412231125
Ref: glossary term-named-tuple12231249
Ref: a9812231249
Ref: glossary term-namespace12232365
Ref: 426d12232365
Ref: glossary term-namespace-package12233120
Ref: 13f112233120
Ref: glossary term-nested-scope12233443
Ref: 152612233443
Ref: glossary term-new-style-class12233931
Ref: 1be312233931
Ref: glossary term-object12234257
Ref: 426e12234257
Ref: glossary term-package12234421
Ref: 13ee12234421
Ref: glossary term-parameter12234694
Ref: 146912234694
Ref: glossary positional-only-parameter12235237
Ref: 2a512235237
Ref: glossary keyword-only-parameter12235515
Ref: 2aa12235515
Ref: glossary term-path-entry12237027
Ref: 140d12237027
Ref: glossary term-path-entry-finder12237181
Ref: 9a612237181
Ref: glossary term-path-entry-hook12237504
Ref: 140f12237504
Ref: glossary term-path-based-finder12237696
Ref: 13fd12237696
Ref: glossary term-path-like-object12237831
Ref: 35f12237831
Ref: glossary term-pep12238464
Ref: 426f12238464
Ref: glossary term-portion12239118
Ref: 13f312239118
Ref: glossary term-positional-argument12239279
Ref: 5ba12239279
Ref: glossary term-provisional-api12239332
Ref: 33d12239332
Ref: glossary term-provisional-package12240336
Ref: 97412240336
Ref: glossary term-python-300012240395
Ref: 427012240395
Ref: glossary term-pythonic12240588
Ref: 427112240588
Ref: glossary term-qualified-name12241208
Ref: 136612241208
Ref: glossary term-reference-count12241933
Ref: 3a7812241933
Ref: glossary term-regular-package12242375
Ref: 13f012242375
Ref: glossary term-slots12242542
Ref: 36d712242542
Ref: glossary term-sequence12242888
Ref: 116212242888
Ref: glossary term-single-dispatch12243891
Ref: 1c912243891
Ref: glossary term-slice12244042
Ref: 153b12244042
Ref: glossary term-special-method12244367
Ref: 359e12244367
Ref: glossary term-statement12244647
Ref: 1aca12244647
Ref: glossary term-text-encoding12244891
Ref: 153612244891
Ref: glossary term-text-file12244960
Ref: 11de12244960
Ref: glossary term-triple-quoted-string12245482
Ref: 427212245482
Ref: glossary term-type12245982
Ref: 427312245982
Ref: glossary term-type-alias12246215
Ref: 427412246215
Ref: glossary term-type-hint12246820
Ref: 425a12246820
Ref: glossary term-universal-newlines12247406
Ref: 5e912247406
Ref: glossary term-variable-annotation12247780
Ref: 61412247780
Ref: glossary term-virtual-environment12248396
Ref: 124c12248396
Ref: glossary term-virtual-machine12248705
Ref: 26c712248705
Ref: glossary term-zen-of-python12248871
Ref: 427512248871
Ref: Glossary-Footnote-112249137
Ref: Glossary-Footnote-212249186
Ref: Glossary-Footnote-312249235
Ref: Glossary-Footnote-412249284
Ref: Glossary-Footnote-512249333
Ref: Glossary-Footnote-612249382
Ref: Glossary-Footnote-712249431
Ref: Glossary-Footnote-812249480
Ref: Glossary-Footnote-912249529
Ref: Glossary-Footnote-1012249578
Ref: Glossary-Footnote-1112249617
Ref: Glossary-Footnote-1212249667
Ref: Glossary-Footnote-1312249717
Ref: Glossary-Footnote-1412249767
Ref: Glossary-Footnote-1512249799
Ref: Glossary-Footnote-1612249849
Ref: Glossary-Footnote-1712249899
Ref: Glossary-Footnote-1812249949
Ref: Glossary-Footnote-1912249999
Ref: Glossary-Footnote-2012250049
Ref: Glossary-Footnote-2112250099
Ref: Glossary-Footnote-2212250149
Ref: Glossary-Footnote-2312250199
Ref: Glossary-Footnote-2412250258
Ref: Glossary-Footnote-2512250308
Ref: Glossary-Footnote-2612250358
Ref: Glossary-Footnote-2712250408
Ref: Glossary-Footnote-2812250458
Ref: Glossary-Footnote-2912250508
Ref: Glossary-Footnote-3012250558
Ref: Glossary-Footnote-3112250608
Ref: Glossary-Footnote-3212250658
Ref: Glossary-Footnote-3312250708
Ref: Glossary-Footnote-3412250758
Ref: Glossary-Footnote-3512250808
Ref: Glossary-Footnote-3612250858
Node: About these documents12250908
Ref: about doc12251012
Ref: 427612251012
Ref: about about-these-documents12251012
Ref: 427712251012
Ref: About these documents-Footnote-112251917
Ref: About these documents-Footnote-212251966
Ref: About these documents-Footnote-312251997
Ref: About these documents-Footnote-412252038
Node: Contributors to the Python Documentation12252079
Ref: about contributors-to-the-python-documentation12252177
Ref: 427812252177
Ref: Contributors to the Python Documentation-Footnote-112252636
Node: Dealing with Bugs12252697
Ref: bugs doc12252802
Ref: 427912252802
Ref: bugs dealing-with-bugs12252802
Ref: 427a12252802
Ref: bugs reporting-bugs12252802
Ref: 3adb12252802
Node: Documentation bugs12253345
Ref: bugs documentation-bugs12253456
Ref: 427c12253456
Ref: Documentation bugs-Footnote-112254403
Ref: Documentation bugs-Footnote-212254548
Ref: Documentation bugs-Footnote-312254593
Node: Using the Python issue tracker12254669
Ref: bugs using-the-python-issue-tracker12254836
Ref: 427e12254836
Ref: bugs using-the-tracker12254836
Ref: 427d12254836
Ref: Using the Python issue tracker-Footnote-112257242
Ref: Using the Python issue tracker-Footnote-212257305
Node: Getting started contributing to Python yourself12257389
Ref: bugs contributing-to-python12257529
Ref: 427b12257529
Ref: bugs getting-started-contributing-to-python-yourself12257529
Ref: 427f12257529
Ref: Getting started contributing to Python yourself-Footnote-112258048
Ref: Getting started contributing to Python yourself-Footnote-212258085
Node: Copyright12258161
Ref: copyright doc12258264
Ref: 428012258264
Ref: copyright copyright12258264
Ref: 428112258264
Ref: copyright core-mentorship-mailing-list12258264
Ref: 428212258264
Node: History and License12258779
Ref: license doc12258907
Ref: 428412258907
Ref: license history-and-license12258907
Ref: 428312258907
Ref: license id112258907
Ref: 428512258907
Node: History of the software12259117
Ref: license history-of-the-software12259265
Ref: 428612259265
Node: Terms and conditions for accessing or otherwise using Python12263802
Ref: license terms-and-conditions-for-accessing-or-otherwise-using-python12264014
Ref: 428712264014
Node: PSF LICENSE AGREEMENT FOR PYTHON 3 8 112264521
Ref: license psf-license-agreement-for-python-release12264708
Ref: 428812264708
Node: BEOPEN COM LICENSE AGREEMENT FOR PYTHON 2 012267212
Ref: license beopen-com-license-agreement-for-python-2-012267447
Ref: 428912267447
Node: CNRI LICENSE AGREEMENT FOR PYTHON 1 6 112270000
Ref: license cnri-license-agreement-for-python-1-6-112270247
Ref: 428a12270247
Node: CWI LICENSE AGREEMENT FOR PYTHON 0 9 0 THROUGH 1 212274175
Ref: license cwi-license-agreement-for-python-0-9-0-through-1-212274370
Ref: 428b12274370
Node: Licenses and Acknowledgements for Incorporated Software12275565
Ref: license licenses-and-acknowledgements-for-incorporated-software12275745
Ref: 428c12275745
Node: Mersenne Twister12276380
Ref: license mersenne-twister12276507
Ref: 428d12276507
Node: Sockets<2>12278631
Ref: license sockets12278795
Ref: 428e12278795
Node: Asynchronous socket services12280514
Ref: license asynchronous-socket-services12280679
Ref: 428f12280679
Node: Cookie management12281819
Ref: license cookie-management12281991
Ref: 429012281991
Node: Execution tracing12283123
Ref: license execution-tracing12283298
Ref: 429112283298
Node: UUencode and UUdecode functions12284463
Ref: license uuencode-and-uudecode-functions12284647
Ref: 429212284647
Node: XML Remote Procedure Calls12286124
Ref: license xml-remote-procedure-calls12286301
Ref: 429312286301
Node: test_epoll12287721
Ref: license test-epoll12287880
Ref: 429412287880
Node: Select kqueue12289060
Ref: license select-kqueue12289202
Ref: 429512289202
Node: SipHash2412290656
Ref: license siphash2412290803
Ref: 429612290803
Node: strtod and dtoa12291906
Ref: license strtod-and-dtoa12292047
Ref: 429712292047
Node: OpenSSL12293311
Ref: license openssl12293448
Ref: 429812293448
Node: expat12300400
Ref: license expat12300528
Ref: 429912300528
Node: libffi12301843
Ref: license libffi12301971
Ref: 429a12301971
Node: zlib<3>12303229
Ref: license zlib12303359
Ref: 429b12303359
Node: cfuhash12304517
Ref: license cfuhash12304649
Ref: 429c12304649
Node: libmpdec12306336
Ref: license libmpdec12306480
Ref: 429d12306480
Node: W3C C14N test suite12307949
Ref: license w3c-c14n-test-suite12308077
Ref: 429e12308077
Node: Distributing Python Modules Legacy version12310025
Ref: distutils/index doc12310184
Ref: 429f12310184
Ref: distutils/index distributing-python-modules-legacy-version12310184
Ref: 42a012310184
Ref: distutils/index distutils-index12310184
Ref: 7ec12310184
Ref: Distributing Python Modules Legacy version-Footnote-112311668
Node: An Introduction to Distutils12311734
Ref: distutils/introduction doc12311874
Ref: 42a112311874
Ref: distutils/introduction an-introduction-to-distutils12311874
Ref: 42a212311874
Ref: distutils/introduction distutils-intro12311874
Ref: 42a312311874
Node: Concepts & Terminology12312629
Ref: distutils/introduction concepts-terminology12312744
Ref: 42a412312744
Ref: distutils/introduction distutils-concepts12312744
Ref: 42a512312744
Node: A Simple Example<2>12313948
Ref: distutils/introduction a-simple-example12314098
Ref: 42a612314098
Ref: distutils/introduction distutils-simple-example12314098
Ref: 42a712314098
Node: General Python terminology12317929
Ref: distutils/introduction general-python-terminology12318087
Ref: 42a912318087
Ref: distutils/introduction python-terms12318087
Ref: 42aa12318087
Node: Distutils-specific terminology12320082
Ref: distutils/introduction distutils-specific-terminology12320212
Ref: 42ab12320212
Ref: distutils/introduction distutils-term12320212
Ref: 42ac12320212
Node: Writing the Setup Script12321369
Ref: distutils/setupscript doc12321554
Ref: 42ad12321554
Ref: distutils/setupscript setup-script12321554
Ref: 42a812321554
Ref: distutils/setupscript writing-the-setup-script12321554
Ref: 42ae12321554
Node: Listing whole packages12324899
Ref: distutils/setupscript listing-packages12325017
Ref: 42b012325017
Ref: distutils/setupscript listing-whole-packages12325017
Ref: 42b112325017
Node: Listing individual modules12327477
Ref: distutils/setupscript listing-individual-modules12327632
Ref: 42b212327632
Ref: distutils/setupscript listing-modules12327632
Ref: 42b312327632
Node: Describing extension modules12328441
Ref: distutils/setupscript describing-extension-modules12328622
Ref: 42b412328622
Ref: distutils/setupscript describing-extensions12328622
Ref: 42b512328622
Node: Extension names and packages12330341
Ref: distutils/setupscript extension-names-and-packages12330465
Ref: 42b712330465
Node: Extension source files12331544
Ref: distutils/setupscript extension-source-files12331697
Ref: 42b812331697
Node: Preprocessor options12333073
Ref: distutils/setupscript preprocessor-options12333213
Ref: 42b912333213
Node: Library options12336181
Ref: distutils/setupscript library-options12336312
Ref: 42ba12336312
Node: Other options12337275
Ref: distutils/setupscript other-options12337377
Ref: 42bb12337377
Node: Relationships between Distributions and Packages12338532
Ref: distutils/setupscript relationships-between-distributions-and-packages12338705
Ref: 42bc12338705
Node: Installing Scripts12342078
Ref: distutils/setupscript distutils-installing-scripts12342246
Ref: 42bd12342246
Ref: distutils/setupscript installing-scripts12342246
Ref: 42be12342246
Node: Installing Package Data12343343
Ref: distutils/setupscript distutils-installing-package-data12343490
Ref: 42bf12343490
Ref: distutils/setupscript installing-package-data12343490
Ref: 42c012343490
Node: Installing Additional Files12345137
Ref: distutils/setupscript distutils-additional-files12345286
Ref: 42c112345286
Ref: distutils/setupscript installing-additional-files12345286
Ref: 42c212345286
Node: Additional meta-data12347160
Ref: distutils/setupscript additional-meta-data12347312
Ref: 42c312347312
Ref: distutils/setupscript meta-data12347312
Ref: 42af12347312
Ref: Additional meta-data-Footnote-112354552
Node: Debugging the setup script12354589
Ref: distutils/setupscript debug-setup-script12354705
Ref: 42c412354705
Ref: distutils/setupscript debugging-the-setup-script12354705
Ref: 42c512354705
Node: Writing the Setup Configuration File12355780
Ref: distutils/configfile doc12355967
Ref: 42c612355967
Ref: distutils/configfile setup-config12355967
Ref: 42c712355967
Ref: distutils/configfile writing-the-setup-configuration-file12355967
Ref: 42c812355967
Ref: distutils/configfile distutils-build-ext-inplace12359111
Ref: 42c912359111
Ref: Writing the Setup Configuration File-Footnote-112361530
Node: Creating a Source Distribution12361644
Ref: distutils/sourcedist doc12361835
Ref: 42cb12361835
Ref: distutils/sourcedist creating-a-source-distribution12361835
Ref: 42cc12361835
Ref: distutils/sourcedist source-dist12361835
Ref: 42cd12361835
Node: Specifying the files to distribute12364675
Ref: distutils/sourcedist manifest12364809
Ref: 3abf12364809
Ref: distutils/sourcedist specifying-the-files-to-distribute12364809
Ref: 42ce12364809
Node: Manifest-related options12370774
Ref: distutils/sourcedist manifest-options12370908
Ref: 42d012370908
Ref: distutils/sourcedist manifest-related-options12370908
Ref: 42d112370908
Node: Creating Built Distributions12372011
Ref: distutils/builtdist doc12372184
Ref: 42d212372184
Ref: distutils/builtdist built-dist12372184
Ref: 42d312372184
Ref: distutils/builtdist creating-built-distributions12372184
Ref: 42d412372184
Node: Creating RPM packages12379792
Ref: distutils/builtdist creating-rpm-packages12379914
Ref: 42d512379914
Ref: distutils/builtdist creating-rpms12379914
Ref: 42d612379914
Node: Creating Windows Installers12387499
Ref: distutils/builtdist creating-windows-installers12387656
Ref: 42d712387656
Ref: distutils/builtdist creating-wininst12387656
Ref: 42d812387656
Node: Cross-compiling on Windows12389888
Ref: distutils/builtdist cross-compile-windows12390053
Ref: 42d912390053
Ref: distutils/builtdist cross-compiling-on-windows12390053
Ref: 42da12390053
Node: The Postinstallation script12391739
Ref: distutils/builtdist postinstallation-script12391829
Ref: 42db12391829
Ref: distutils/builtdist the-postinstallation-script12391829
Ref: 42dc12391829
Ref: distutils/builtdist directory_created12392734
Ref: 42dd12392734
Ref: distutils/builtdist file_created12392773
Ref: 42de12392773
Ref: distutils/builtdist get_special_folder_path12393124
Ref: 42df12393124
Ref: distutils/builtdist create_shortcut12393924
Ref: 42e012393924
Node: Vista User Access Control UAC12394641
Ref: distutils/builtdist vista-user-access-control-uac12394770
Ref: 42e112394770
Node: Distutils Examples12395223
Ref: distutils/examples doc12395385
Ref: 42e212395385
Ref: distutils/examples distutils-examples12395385
Ref: 42e312395385
Ref: distutils/examples id112395385
Ref: 42e412395385
Ref: Distutils Examples-Footnote-112396268
Node: Pure Python distribution by module12396324
Ref: distutils/examples pure-mod12396457
Ref: 42e512396457
Ref: distutils/examples pure-python-distribution-by-module12396457
Ref: 42e612396457
Node: Pure Python distribution by package12398176
Ref: distutils/examples pure-pkg12398341
Ref: 42e712398341
Ref: distutils/examples pure-python-distribution-by-package12398341
Ref: 42e812398341
Node: Single extension module12401850
Ref: distutils/examples single-ext12401999
Ref: 42e912401999
Ref: distutils/examples single-extension-module12401999
Ref: 42ea12401999
Node: Checking a package12403054
Ref: distutils/examples checking-a-package12403188
Ref: 42eb12403188
Ref: Checking a package-Footnote-112404755
Node: Reading the metadata12404795
Ref: distutils/examples reading-the-metadata12404897
Ref: 42ec12404897
Node: Extending Distutils12406481
Ref: distutils/extending doc12406632
Ref: 42ed12406632
Ref: distutils/extending docutils12406632
Ref: 42ee12406632
Ref: distutils/extending extending-distutils12406632
Ref: 12d212406632
Ref: distutils/extending id112406632
Ref: 42ef12406632
Node: Integrating new commands12407915
Ref: distutils/extending integrating-new-commands12408033
Ref: 42f112408033
Node: Adding new distribution types12410903
Ref: distutils/extending adding-new-distribution-types12411021
Ref: 42f212411021
Node: Command Reference12411475
Ref: distutils/commandref doc12411621
Ref: 42f312411621
Ref: distutils/commandref command-reference12411621
Ref: 42f412411621
Ref: distutils/commandref reference12411621
Ref: 42f512411621
Node: Installing modules the install command family12412137
Ref: distutils/commandref install-cmd12412293
Ref: 42f612412293
Ref: distutils/commandref installing-modules-the-install-command-family12412293
Ref: 42f712412293
Node: install_data12412619
Ref: distutils/commandref install-data12412737
Ref: 42f812412737
Ref: distutils/commandref install-data-cmd12412737
Ref: 42f912412737
Node: install_scripts12412860
Ref: distutils/commandref install-scripts12412978
Ref: 42fa12412978
Ref: distutils/commandref install-scripts-cmd12412978
Ref: 42fb12412978
Node: Creating a source distribution the sdist command12413102
Ref: distutils/commandref creating-a-source-distribution-the-sdist-command12413258
Ref: 42fc12413258
Ref: distutils/commandref sdist-cmd12413258
Ref: 42cf12413258
Node: API Reference12416030
Ref: distutils/apiref doc12416148
Ref: 42fd12416148
Ref: distutils/apiref api-reference12416148
Ref: 42fe12416148
Ref: distutils/apiref id112416148
Ref: 42ff12416148
Ref: API Reference-Footnote-112422071
Node: distutils core — Core Distutils functionality12422171
Ref: distutils/apiref distutils-core-core-distutils-functionality12422321
Ref: 430012422321
Ref: distutils/apiref module-distutils core12422321
Ref: 5412422321
Ref: distutils/apiref distutils core setup12422728
Ref: 3abc12422728
Ref: distutils/apiref distutils core run_setup12429639
Ref: 430312429639
Ref: distutils/apiref distutils core Extension12432059
Ref: 42b612432059
Ref: distutils/apiref distutils core Distribution12439483
Ref: 430112439483
Ref: distutils/apiref distutils core Command12440000
Ref: 430212440000
Ref: distutils core — Core Distutils functionality-Footnote-112440199
Ref: distutils core — Core Distutils functionality-Footnote-212440236
Node: distutils ccompiler — CCompiler base class12440285
Ref: distutils/apiref distutils-ccompiler-ccompiler-base-class12440487
Ref: 430412440487
Ref: distutils/apiref module-distutils ccompiler12440487
Ref: 3c12440487
Ref: distutils/apiref distutils ccompiler gen_lib_options12440980
Ref: 430612440980
Ref: distutils/apiref distutils ccompiler gen_preprocess_options12441466
Ref: 430712441466
Ref: distutils/apiref distutils ccompiler get_default_compiler12442132
Ref: 430812442132
Ref: distutils/apiref distutils ccompiler new_compiler12442601
Ref: 430912442601
Ref: distutils/apiref distutils ccompiler show_compilers12443401
Ref: 430a12443401
Ref: distutils/apiref distutils ccompiler CCompiler12443594
Ref: 430512443594
Ref: distutils/apiref distutils ccompiler CCompiler add_include_dir12445031
Ref: 430b12445031
Ref: distutils/apiref distutils ccompiler CCompiler set_include_dirs12445333
Ref: 430c12445333
Ref: distutils/apiref distutils ccompiler CCompiler add_library12445806
Ref: 430d12445806
Ref: distutils/apiref distutils ccompiler CCompiler set_libraries12446593
Ref: 430e12446593
Ref: distutils/apiref distutils ccompiler CCompiler add_library_dir12446888
Ref: 430f12446888
Ref: distutils/apiref distutils ccompiler CCompiler set_library_dirs12447294
Ref: 431012447294
Ref: distutils/apiref distutils ccompiler CCompiler add_runtime_library_dir12447535
Ref: 431112447535
Ref: distutils/apiref distutils ccompiler CCompiler set_runtime_library_dirs12447696
Ref: 431212447696
Ref: distutils/apiref distutils ccompiler CCompiler define_macro12447982
Ref: 431312447982
Ref: distutils/apiref distutils ccompiler CCompiler undefine_macro12448350
Ref: 431412448350
Ref: distutils/apiref distutils ccompiler CCompiler add_link_object12448873
Ref: 431512448873
Ref: distutils/apiref distutils ccompiler CCompiler set_link_objects12449156
Ref: 431612449156
Ref: distutils/apiref distutils ccompiler CCompiler detect_language12449599
Ref: 431712449599
Ref: distutils/apiref distutils ccompiler CCompiler find_library_file12449843
Ref: 431812449843
Ref: distutils/apiref distutils ccompiler CCompiler has_function12450252
Ref: 431912450252
Ref: distutils/apiref distutils ccompiler CCompiler library_dir_option12450654
Ref: 431a12450654
Ref: distutils/apiref distutils ccompiler CCompiler library_option12450809
Ref: 431b12450809
Ref: distutils/apiref distutils ccompiler CCompiler runtime_library_dir_option12450980
Ref: 431c12450980
Ref: distutils/apiref distutils ccompiler CCompiler set_executables12451151
Ref: 431d12451151
Ref: distutils/apiref distutils ccompiler CCompiler compile12452648
Ref: 431f12452648
Ref: distutils/apiref distutils ccompiler CCompiler create_static_lib12455430
Ref: 432012455430
Ref: distutils/apiref distutils ccompiler CCompiler link12456714
Ref: 432112456714
Ref: distutils/apiref distutils ccompiler CCompiler link_executable12459374
Ref: 432212459374
Ref: distutils/apiref distutils ccompiler CCompiler link_shared_lib12459864
Ref: 432312459864
Ref: distutils/apiref distutils ccompiler CCompiler link_shared_object12460406
Ref: 432412460406
Ref: distutils/apiref distutils ccompiler CCompiler preprocess12460972
Ref: 432512460972
Ref: distutils/apiref distutils ccompiler CCompiler executable_filename12461859
Ref: 432612461859
Ref: distutils/apiref distutils ccompiler CCompiler library_filename12462163
Ref: 432712462163
Ref: distutils/apiref distutils ccompiler CCompiler object_filenames12462568
Ref: 432812462568
Ref: distutils/apiref distutils ccompiler CCompiler shared_object_filename12462804
Ref: 432912462804
Ref: distutils/apiref distutils ccompiler CCompiler execute12462999
Ref: 432a12462999
Ref: distutils/apiref distutils ccompiler CCompiler spawn12463283
Ref: 432c12463283
Ref: distutils/apiref distutils ccompiler CCompiler mkpath12463432
Ref: 432d12463432
Ref: distutils/apiref distutils ccompiler CCompiler move_file12463610
Ref: 432f12463610
Ref: distutils/apiref distutils ccompiler CCompiler announce12463748
Ref: 433112463748
Ref: distutils/apiref distutils ccompiler CCompiler warn12463854
Ref: 433212463854
Ref: distutils/apiref distutils ccompiler CCompiler debug_print12463943
Ref: 433312463943
Node: distutils unixccompiler — Unix C Compiler12464132
Ref: distutils/apiref distutils-unixccompiler-unix-c-compiler12464332
Ref: 433412464332
Ref: distutils/apiref module-distutils unixccompiler12464332
Ref: 6412464332
Node: distutils msvccompiler — Microsoft Compiler12465099
Ref: distutils/apiref distutils-msvccompiler-microsoft-compiler12465298
Ref: 433512465298
Ref: distutils/apiref module-distutils msvccompiler12465298
Ref: 6012465298
Node: distutils bcppcompiler — Borland Compiler12466286
Ref: distutils/apiref distutils-bcppcompiler-borland-compiler12466486
Ref: 433612466486
Ref: distutils/apiref module-distutils bcppcompiler12466486
Ref: 3b12466486
Node: distutils cygwincompiler — Cygwin Compiler12466720
Ref: distutils/apiref distutils-cygwincompiler-cygwin-compiler12466921
Ref: 433712466921
Ref: distutils/apiref module-distutils cygwinccompiler12466921
Ref: 5512466921
Node: distutils archive_util — Archiving utilities12467303
Ref: distutils/apiref distutils-archive-util-archiving-utilities12467503
Ref: 433812467503
Ref: distutils/apiref module-distutils archive_util12467503
Ref: 3a12467503
Ref: distutils/apiref distutils archive_util make_archive12467714
Ref: 433912467714
Ref: distutils/apiref distutils archive_util make_tarball12468626
Ref: 433a12468626
Ref: distutils/apiref distutils archive_util make_zipfile12469414
Ref: 433b12469414
Node: distutils dep_util — Dependency checking12469928
Ref: distutils/apiref distutils-dep-util-dependency-checking12470132
Ref: 433c12470132
Ref: distutils/apiref module-distutils dep_util12470132
Ref: 5712470132
Ref: distutils/apiref distutils dep_util newer12470421
Ref: 433d12470421
Ref: distutils/apiref distutils dep_util newer_pairwise12470761
Ref: 433e12470761
Ref: distutils/apiref distutils dep_util newer_group12471083
Ref: 433f12471083
Node: distutils dir_util — Directory tree operations12471984
Ref: distutils/apiref distutils-dir-util-directory-tree-operations12472188
Ref: 434012472188
Ref: distutils/apiref module-distutils dir_util12472188
Ref: 5812472188
Ref: distutils/apiref distutils dir_util mkpath12472394
Ref: 432e12472394
Ref: distutils/apiref distutils dir_util create_tree12473003
Ref: 434112473003
Ref: distutils/apiref distutils dir_util copy_tree12473564
Ref: 434212473564
Ref: distutils/apiref distutils dir_util remove_tree12475043
Ref: 434412475043
Ref: distutils dir_util — Directory tree operations-Footnote-112475357
Node: distutils file_util — Single file operations12475403
Ref: distutils/apiref distutils-file-util-single-file-operations12475621
Ref: 434512475621
Ref: distutils/apiref module-distutils file_util12475621
Ref: 5d12475621
Ref: distutils/apiref distutils file_util copy_file12475818
Ref: 434312475818
Ref: distutils/apiref distutils file_util move_file12477238
Ref: 433012477238
Ref: distutils/apiref distutils file_util write_file12477649
Ref: 434612477649
Node: distutils util — Miscellaneous other utility functions12477836
Ref: distutils/apiref distutils-util-miscellaneous-other-utility-functions12478047
Ref: 434712478047
Ref: distutils/apiref module-distutils util12478047
Ref: 6512478047
Ref: distutils/apiref distutils util get_platform12478285
Ref: 434812478285
Ref: distutils/apiref distutils util convert_path12479993
Ref: 434912479993
Ref: distutils/apiref distutils util change_root12480538
Ref: 434a12480538
Ref: distutils/apiref distutils util check_environ12480863
Ref: 434b12480863
Ref: distutils/apiref distutils util subst_vars12481282
Ref: 434c12481282
Ref: distutils/apiref distutils util split_quoted12482098
Ref: 431e12482098
Ref: distutils/apiref distutils util execute12482673
Ref: 432b12482673
Ref: distutils/apiref distutils util strtobool12483193
Ref: 434d12483193
Ref: distutils/apiref distutils util byte_compile12483546
Ref: 434e12483546
Ref: distutils/apiref distutils util rfc822_escape12485574
Ref: 434f12485574
Ref: distutils util — Miscellaneous other utility functions-Footnote-112485867
Ref: distutils util — Miscellaneous other utility functions-Footnote-212485916
Ref: distutils util — Miscellaneous other utility functions-Footnote-312485965
Ref: distutils util — Miscellaneous other utility functions-Footnote-412486014
Node: distutils dist — The Distribution class12486062
Ref: distutils/apiref distutils-dist-the-distribution-class12486270
Ref: 435012486270
Ref: distutils/apiref module-distutils dist12486270
Ref: 5912486270
Node: distutils extension — The Extension class12486512
Ref: distutils/apiref distutils-extension-the-extension-class12486704
Ref: 435112486704
Ref: distutils/apiref module-distutils extension12486704
Ref: 5b12486704
Node: distutils debug — Distutils debug mode12486923
Ref: distutils/apiref distutils-debug-distutils-debug-mode12487115
Ref: 435212487115
Ref: distutils/apiref module-distutils debug12487115
Ref: 5612487115
Node: distutils errors — Distutils exceptions12487258
Ref: distutils/apiref distutils-errors-distutils-exceptions12487475
Ref: 435312487475
Ref: distutils/apiref module-distutils errors12487475
Ref: 5a12487475
Node: distutils fancy_getopt — Wrapper around the standard getopt module12487975
Ref: distutils/apiref distutils-fancy-getopt-wrapper-around-the-standard-getopt-module12488193
Ref: 435412488193
Ref: distutils/apiref module-distutils fancy_getopt12488193
Ref: 5c12488193
Ref: distutils/apiref distutils fancy_getopt fancy_getopt12488899
Ref: 435512488899
Ref: distutils/apiref distutils fancy_getopt wrap_text12489557
Ref: 435712489557
Ref: distutils/apiref distutils fancy_getopt FancyGetopt12489665
Ref: 435612489665
Ref: distutils/apiref distutils fancy_getopt FancyGetopt getopt12490230
Ref: 435812490230
Ref: distutils/apiref distutils fancy_getopt FancyGetopt get_option_order12490832
Ref: 435912490832
Ref: distutils/apiref distutils fancy_getopt FancyGetopt generate_help12491076
Ref: 435a12491076
Node: distutils filelist — The FileList class12491356
Ref: distutils/apiref distutils-filelist-the-filelist-class12491579
Ref: 435b12491579
Ref: distutils/apiref module-distutils filelist12491579
Ref: 5e12491579
Node: distutils log — Simple PEP 282-style logging12491800
Ref: distutils/apiref distutils-log-simple-pep-282-style-logging12491994
Ref: 435c12491994
Ref: distutils/apiref module-distutils log12491994
Ref: 5f12491994
Node: distutils spawn — Spawn a sub-process12492092
Ref: distutils/apiref distutils-spawn-spawn-a-sub-process12492301
Ref: 435d12492301
Ref: distutils/apiref module-distutils spawn12492301
Ref: 6112492301
Node: distutils sysconfig — System configuration information12492640
Ref: distutils/apiref distutils-sysconfig-system-configuration-information12492845
Ref: 435e12492845
Ref: distutils/apiref module-distutils sysconfig12492845
Ref: 6212492845
Ref: distutils/apiref distutils sysconfig PREFIX12493688
Ref: 435f12493688
Ref: distutils/apiref distutils sysconfig EXEC_PREFIX12493782
Ref: 436012493782
Ref: distutils/apiref distutils sysconfig get_config_var12493886
Ref: 436112493886
Ref: distutils/apiref distutils sysconfig get_config_vars12494051
Ref: 436212494051
Ref: distutils/apiref distutils sysconfig get_config_h_filename12494505
Ref: 436312494505
Ref: distutils/apiref distutils sysconfig get_makefile_filename12494865
Ref: 436412494865
Ref: distutils/apiref distutils sysconfig get_python_inc12495243
Ref: 436512495243
Ref: distutils/apiref distutils sysconfig get_python_lib12495774
Ref: 436612495774
Ref: distutils/apiref distutils sysconfig customize_compiler12496579
Ref: 436712496579
Ref: distutils/apiref distutils sysconfig set_python_build12497249
Ref: 436812497249
Node: distutils text_file — The TextFile class12497572
Ref: distutils/apiref distutils-text-file-the-textfile-class12497782
Ref: 436912497782
Ref: distutils/apiref module-distutils text_file12497782
Ref: 6312497782
Ref: distutils/apiref distutils text_file TextFile12498095
Ref: 436a12498095
Ref: distutils/apiref distutils text_file TextFile open12502613
Ref: 436e12502613
Ref: distutils/apiref distutils text_file TextFile close12502760
Ref: 436d12502760
Ref: distutils/apiref distutils text_file TextFile warn12502924
Ref: 436b12502924
Ref: distutils/apiref distutils text_file TextFile readline12503434
Ref: 436f12503434
Ref: distutils/apiref distutils text_file TextFile readlines12504116
Ref: 437012504116
Ref: distutils/apiref distutils text_file TextFile unreadline12504323
Ref: 436c12504323
Node: distutils version — Version number classes12504952
Ref: distutils/apiref distutils-version-version-number-classes12505166
Ref: 437112505166
Ref: distutils/apiref module-distutils version12505166
Ref: 6612505166
Node: distutils cmd — Abstract base class for Distutils commands12505279
Ref: distutils/apiref distutils-cmd-abstract-base-class-for-distutils-commands12505483
Ref: 437212505483
Ref: distutils/apiref module-distutils cmd12505483
Ref: 3d12505483
Ref: distutils/apiref distutils cmd Command12505695
Ref: 42f012505695
Node: Creating a new Distutils command12506773
Ref: distutils/apiref creating-a-new-distutils-command12506984
Ref: 437612506984
Ref: distutils/apiref distutils cmd Command initialize_options12507853
Ref: 437312507853
Ref: distutils/apiref distutils cmd Command finalize_options12508301
Ref: 437412508301
Ref: distutils/apiref distutils cmd Command run12508797
Ref: 437512508797
Ref: distutils/apiref distutils cmd Command sub_commands12509223
Ref: 437712509223
Node: distutils command — Individual Distutils commands12510214
Ref: distutils/apiref distutils-command-individual-distutils-commands12510417
Ref: 437812510417
Ref: distutils/apiref module-distutils command12510417
Ref: 3e12510417
Node: distutils command bdist — Build a binary installer12510544
Ref: distutils/apiref distutils-command-bdist-build-a-binary-installer12510785
Ref: 437912510785
Ref: distutils/apiref module-distutils command bdist12510785
Ref: 3f12510785
Node: distutils command bdist_packager — Abstract base class for packagers12510914
Ref: distutils/apiref distutils-command-bdist-packager-abstract-base-class-for-packagers12511165
Ref: 437a12511165
Ref: distutils/apiref module-distutils command bdist_packager12511165
Ref: 4212511165
Node: distutils command bdist_dumb — Build a “dumb” installer12511330
Ref: distutils/apiref distutils-command-bdist-dumb-build-a-dumb-installer12511603
Ref: 437b12511603
Ref: distutils/apiref module-distutils command bdist_dumb12511603
Ref: 4012511603
Node: distutils command bdist_msi — Build a Microsoft Installer binary package12511746
Ref: distutils/apiref distutils-command-bdist-msi-build-a-microsoft-installer-binary-package12512033
Ref: 437c12512033
Ref: distutils/apiref module-distutils command bdist_msi12512033
Ref: 4112512033
Ref: distutils/apiref distutils command bdist_msi bdist_msi12512206
Ref: 437d12512206
Ref: distutils command bdist_msi — Build a Microsoft Installer binary package-Footnote-112512649
Node: distutils command bdist_rpm — Build a binary distribution as a Redhat RPM and SRPM12512719
Ref: distutils/apiref distutils-command-bdist-rpm-build-a-binary-distribution-as-a-redhat-rpm-and-srpm12513006
Ref: 437e12513006
Ref: distutils/apiref module-distutils command bdist_rpm12513006
Ref: 4312513006
Node: distutils command bdist_wininst — Build a Windows installer12513199
Ref: distutils/apiref distutils-command-bdist-wininst-build-a-windows-installer12513467
Ref: 437f12513467
Ref: distutils/apiref module-distutils command bdist_wininst12513467
Ref: 4412513467
Node: distutils command sdist — Build a source distribution12513687
Ref: distutils/apiref distutils-command-sdist-build-a-source-distribution12513927
Ref: 438012513927
Ref: distutils/apiref module-distutils command sdist12513927
Ref: 5312513927
Node: distutils command build — Build all files of a package12514062
Ref: distutils/apiref distutils-command-build-build-all-files-of-a-package12514308
Ref: 438112514308
Ref: distutils/apiref module-distutils command build12514308
Ref: 4512514308
Node: distutils command build_clib — Build any C libraries in a package12514445
Ref: distutils/apiref distutils-command-build-clib-build-any-c-libraries-in-a-package12514701
Ref: 438212514701
Ref: distutils/apiref module-distutils command build_clib12514701
Ref: 4612514701
Node: distutils command build_ext — Build any extensions in a package12514860
Ref: distutils/apiref distutils-command-build-ext-build-any-extensions-in-a-package12515127
Ref: 438312515127
Ref: distutils/apiref module-distutils command build_ext12515127
Ref: 4712515127
Node: distutils command build_py — Build the py/ pyc files of a package12515282
Ref: distutils/apiref distutils-command-build-py-build-the-py-pyc-files-of-a-package12515548
Ref: 438412515548
Ref: distutils/apiref module-distutils command build_py12515548
Ref: 4812515548
Ref: distutils/apiref distutils command build_py build_py12515709
Ref: 438512515709
Ref: distutils/apiref distutils command build_py build_py_2to312515757
Ref: 438612515757
Node: distutils command build_scripts — Build the scripts of a package12516344
Ref: distutils/apiref distutils-command-build-scripts-build-the-scripts-of-a-package12516599
Ref: 438712516599
Ref: distutils/apiref module-distutils command build_scripts12516599
Ref: 4912516599
Node: distutils command clean — Clean a package build area12516756
Ref: distutils/apiref distutils-command-clean-clean-a-package-build-area12517002
Ref: 438812517002
Ref: distutils/apiref module-distutils command clean12517002
Ref: 4b12517002
Node: distutils command config — Perform package configuration12517446
Ref: distutils/apiref distutils-command-config-perform-package-configuration12517673
Ref: 438912517673
Ref: distutils/apiref module-distutils command config12517673
Ref: 4c12517673
Node: distutils command install — Install a package12517814
Ref: distutils/apiref distutils-command-install-install-a-package12518055
Ref: 438a12518055
Ref: distutils/apiref module-distutils command install12518055
Ref: 4d12518055
Node: distutils command install_data — Install data files from a package12518174
Ref: distutils/apiref distutils-command-install-data-install-data-files-from-a-package12518436
Ref: 438b12518436
Ref: distutils/apiref module-distutils command install_data12518436
Ref: 4e12518436
Node: distutils command install_headers — Install C/C++ header files from a package12518597
Ref: distutils/apiref distutils-command-install-headers-install-c-c-header-files-from-a-package12518882
Ref: 438c12518882
Ref: distutils/apiref module-distutils command install_headers12518882
Ref: 4f12518882
Node: distutils command install_lib — Install library files from a package12519065
Ref: distutils/apiref distutils-command-install-lib-install-library-files-from-a-package12519355
Ref: 438d12519355
Ref: distutils/apiref module-distutils command install_lib12519355
Ref: 5012519355
Node: distutils command install_scripts — Install script files from a package12519520
Ref: distutils/apiref distutils-command-install-scripts-install-script-files-from-a-package12519809
Ref: 438e12519809
Ref: distutils/apiref module-distutils command install_scripts12519809
Ref: 5112519809
Node: distutils command register — Register a module with the Python Package Index12519980
Ref: distutils/apiref distutils-command-register-register-a-module-with-the-python-package-index12520259
Ref: 438f12520259
Ref: distutils/apiref module-distutils command register12520259
Ref: 5212520259
Ref: distutils command register — Register a module with the Python Package Index-Footnote-112520606
Node: distutils command check — Check the meta-data of a package12520655
Ref: distutils/apiref distutils-command-check-check-the-meta-data-of-a-package12520852
Ref: 439012520852
Ref: distutils/apiref module-distutils command check12520852
Ref: 4a12520852
Node: Installing Python Modules Legacy version12521194
Ref: install/index doc12521353
Ref: 439112521353
Ref: install/index install-index12521353
Ref: 7eb12521353
Ref: install/index installing-python-modules-legacy-version12521353
Ref: 439212521353
Ref: Installing Python Modules Legacy version-Footnote-112522549
Node: Introduction<17>12522615
Ref: install/index inst-intro12522743
Ref: 439312522743
Ref: install/index introduction12522743
Ref: 439412522743
Node: Distutils based source distributions12523707
Ref: install/index distutils-based-source-distributions12523796
Ref: 439512523796
Ref: install/index inst-new-standard12523796
Ref: 439612523796
Node: Standard Build and Install12525083
Ref: install/index inst-standard-install12525242
Ref: 439712525242
Ref: install/index standard-build-and-install12525242
Ref: 439812525242
Node: Platform variations12525641
Ref: install/index inst-platform-variations12525752
Ref: 439912525752
Ref: install/index platform-variations12525752
Ref: 439a12525752
Node: Splitting the job up12526652
Ref: install/index inst-splitting-up12526790
Ref: 439b12526790
Ref: install/index splitting-the-job-up12526790
Ref: 439c12526790
Node: How building works12528089
Ref: install/index how-building-works12528230
Ref: 439d12528230
Ref: install/index inst-how-build-works12528230
Ref: 439e12528230
Node: How installation works12529944
Ref: install/index how-installation-works12530056
Ref: 43a012530056
Ref: install/index inst-how-install-works12530056
Ref: 43a112530056
Node: Alternate Installation12534824
Ref: install/index alternate-installation12534986
Ref: 43a412534986
Ref: install/index inst-alt-install12534986
Ref: 43a212534986
Node: Alternate installation the user scheme12536674
Ref: install/index alternate-installation-the-user-scheme12536818
Ref: 43a512536818
Ref: install/index inst-alt-install-user12536818
Ref: 129412536818
Node: Alternate installation the home scheme12539217
Ref: install/index alternate-installation-the-home-scheme12539415
Ref: 43a612539415
Ref: install/index inst-alt-install-home12539415
Ref: 43a712539415
Node: Alternate installation Unix the prefix scheme12541216
Ref: install/index alternate-installation-unix-the-prefix-scheme12541424
Ref: 43a912541424
Ref: install/index inst-alt-install-prefix-unix12541424
Ref: 43aa12541424
Node: Alternate installation Windows the prefix scheme12545459
Ref: install/index alternate-installation-windows-the-prefix-scheme12545620
Ref: 43ab12545620
Ref: install/index inst-alt-install-prefix-windows12545620
Ref: 43ac12545620
Node: Custom Installation12546887
Ref: install/index custom-installation12547052
Ref: 43ad12547052
Ref: install/index inst-custom-install12547052
Ref: 43a312547052
Node: Modifying Python’s Search Path12553951
Ref: install/index inst-search-path12554039
Ref: 43a812554039
Ref: install/index modifying-python-s-search-path12554039
Ref: 43ae12554039
Node: Distutils Configuration Files12557711
Ref: install/index distutils-configuration-files12557889
Ref: 43af12557889
Ref: install/index inst-config-files12557889
Ref: 439f12557889
Node: Location and names of config files12558600
Ref: install/index inst-config-filenames12558731
Ref: 43b012558731
Ref: install/index location-and-names-of-config-files12558731
Ref: 43b112558731
Node: Syntax of config files12562659
Ref: install/index inst-config-syntax12562790
Ref: 42ca12562790
Ref: install/index syntax-of-config-files12562790
Ref: 43b212562790
Node: Building Extensions Tips and Tricks12564701
Ref: install/index building-extensions-tips-and-tricks12564851
Ref: 43b312564851
Ref: install/index inst-building-ext12564851
Ref: 43b412564851
Node: Tweaking compiler/linker flags12565457
Ref: install/index inst-tweak-flags12565608
Ref: 43b512565608
Ref: install/index tweaking-compiler-linker-flags12565608
Ref: 43b612565608
Node: Using non-Microsoft compilers on Windows12568677
Ref: install/index inst-non-ms-compilers12568828
Ref: 43b712568828
Ref: install/index using-non-microsoft-compilers-on-windows12568828
Ref: 43b812568828
Node: Borland/CodeGear C++12568987
Ref: install/index borland-codegear-c12569115
Ref: 43b912569115
Ref: Borland/CodeGear C++-Footnote-112571071
Ref: Borland/CodeGear C++-Footnote-212571182
Ref: Borland/CodeGear C++-Footnote-312571227
Node: GNU C / Cygwin / MinGW12571281
Ref: install/index gnu-c-cygwin-mingw12571409
Ref: 43ba12571409
Ref: GNU C / Cygwin / MinGW-Footnote-112572417
Ref: GNU C / Cygwin / MinGW-Footnote-212572529
Node: Older Versions of Python and MinGW12572630
Ref: install/index older-versions-of-python-and-mingw12572723
Ref: 43bb12572723
Ref: Older Versions of Python and MinGW-Footnote-112574378
Node: Python Module Index12574443
Node: Index12596962
Ref: 340b14347833
Ref: library/types CodeType14347863
Ref: 340714347894
Ref: using/cmdline audit_event_cpython_run_file_014347925
Ref: 340d14347956
Ref: 340f14347987
Ref: library/poplib popplib POP3_SSL14348018
Ref: 340c14348049
Ref: 340a14348080
Ref: using/cmdline PYTHONSTARTUP14348111
Ref: using/cmdline audit_event_cpython_run_stdin_014348142
Ref: library/ctypes ctype-foreign-functions14348173

End Tag Table


Local Variables:
coding: utf-8
End:
